summaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL253
1 files changed, 185 insertions, 68 deletions
diff --git a/INSTALL b/INSTALL
index a0d0c058cd..781cb8415b 100644
--- a/INSTALL
+++ b/INSTALL
@@ -2,13 +2,9 @@ Installing the GNU C Library
****************************
Before you do anything else, you should read the FAQ at
-<http://sourceware.org/glibc/wiki/FAQ>. It answers common questions and
-describes problems you may experience with compilation and installation.
-
- Features can be added to the GNU C Library via "add-on" bundles.
-These are separate tar files, which you unpack into the top level of the
-source tree. Then you give 'configure' the '--enable-add-ons' option to
-activate them, and they will be compiled into the library.
+<https://sourceware.org/glibc/wiki/FAQ>. It answers common questions
+and describes problems you may experience with compilation and
+installation.
You will need recent versions of several GNU tools: definitely GCC
and GNU Make, and possibly others. *Note Tools for Compilation::,
@@ -40,9 +36,18 @@ normal setting to install as the standard system library is
'--prefix=/usr' for GNU/Linux systems and '--prefix=' (an empty prefix)
for GNU/Hurd systems.
- It may also be useful to set the CC and CFLAGS variables in the
-environment when running 'configure'. CC selects the C compiler that
-will be used, and CFLAGS sets optimization options for the compiler.
+ It may also be useful to pass 'CC=COMPILER' and 'CFLAGS=FLAGS'
+arguments to 'configure'. 'CC' selects the C compiler that will be
+used, and 'CFLAGS' sets optimization options for the compiler. Any
+compiler options required for all compilations, such as options
+selecting an ABI or a processor for which to generate code, should be
+included in 'CC'. Options that may be overridden by the GNU C Library
+build system for particular files, such as for optimization and
+debugging, should go in 'CFLAGS'. The default value of 'CFLAGS' is '-g
+-O2', and the GNU C Library cannot be compiled without optimization, so
+if 'CFLAGS' is specified it must enable optimization. For example:
+
+ $ ../glibc-VERSION/configure CC="gcc -m32" CFLAGS="-O3"
The following list describes all of the available options for
'configure':
@@ -69,18 +74,6 @@ will be used, and CFLAGS sets optimization options for the compiler.
this option if you want to compile the GNU C Library with a newer
set of kernel headers than the ones found in '/usr/include'.
-'--enable-add-ons[=LIST]'
- Specify add-on packages to include in the build. If this option is
- specified with no list, it enables all the add-on packages it finds
- in the main source directory; this is the default behavior. You
- may specify an explicit list of add-ons to use in LIST, separated
- by spaces or commas (if you use spaces, remember to quote them from
- the shell). Each add-on in LIST can be an absolute directory name
- or can be a directory name relative to the main source directory,
- or relative to the build directory (that is, the current working
- directory). For example,
- '--enable-add-ons=nptl,../glibc-libidn-VERSION'.
-
'--enable-kernel=VERSION'
This option is currently only useful on GNU/Linux systems. The
VERSION parameter should have the form X.Y.Z and describes the
@@ -97,15 +90,38 @@ will be used, and CFLAGS sets optimization options for the compiler.
library will still be usable, but functionality may be lost--for
example, you can't build a shared libc with old binutils.
-'--without-fp'
- Use this option if your computer lacks hardware floating-point
- support and your operating system does not emulate an FPU.
-
'--disable-shared'
Don't build shared libraries even if it is possible. Not all
systems support shared libraries; you need ELF support and
(currently) the GNU linker.
+'--enable-static-pie'
+ Enable static position independent executable (static PIE) support.
+ Static PIE is similar to static executable, but can be loaded at
+ any address without help from a dynamic linker. All static
+ programs as well as static tests are built as static PIE, except
+ for those marked with no-pie. The resulting glibc can be used with
+ the GCC option, -static-pie, which is available with GCC 8 or
+ above, to create static PIE. This option also implies that glibc
+ programs and tests are created as dynamic position independent
+ executables (PIE) by default.
+
+'--enable-cet'
+ Enable Intel Control-flow Enforcement Technology (CET) support.
+ When the GNU C Library is built with '--enable-cet', the resulting
+ library is protected with indirect branch tracking (IBT) and shadow
+ stack (SHSTK). When CET is enabled, the GNU C Library is
+ compatible with all existing executables and shared libraries.
+ This feature is currently supported on i386, x86_64 and x32 with
+ GCC 8 and binutils 2.29 or later. Note that when CET is enabled,
+ the GNU C Library requires CPUs capable of multi-byte NOPs, like
+ x86-64 processors as well as Intel Pentium Pro or newer.
+
+ NOTE: '--enable-cet' has been tested for i686, x86_64 and x32 on
+ non-CET processors. '--enable-cet' has been tested for x86_64 and
+ x32 on CET SDVs, but Intel CET support hasn't been validated for
+ i686.
+
'--disable-profile'
Don't build libraries with profiling information. You may want to
use this option if you don't plan to do profiling.
@@ -116,12 +132,6 @@ will be used, and CFLAGS sets optimization options for the compiler.
program linked statically with the NSS libraries cannot be
dynamically reconfigured to use a different name database.
-'--without-tls'
- By default the C library is built with support for thread-local
- storage if the used tools support it. By using '--without-tls'
- this can be prevented though there generally is no reason since it
- creates compatibility problems.
-
'--enable-hardcoded-path-in-tests'
By default, dynamic tests are linked to run with the installed C
library. This option hardcodes the newly built C library path in
@@ -138,8 +148,22 @@ will be used, and CFLAGS sets optimization options for the compiler.
formats may change over time. Consult the 'timezone' subdirectory
for more details.
-'--enable-lock-elision=yes'
- Enable lock elision for pthread mutexes by default.
+'--enable-stack-protector'
+'--enable-stack-protector=strong'
+'--enable-stack-protector=all'
+ Compile the C library and all other parts of the glibc package
+ (including the threading and math libraries, NSS modules, and
+ transliteration modules) using the GCC '-fstack-protector',
+ '-fstack-protector-strong' or '-fstack-protector-all' options to
+ detect stack overruns. Only the dynamic linker and a small number
+ of routines called directly from assembler are excluded from this
+ protection.
+
+'--enable-bind-now'
+ Disable lazy binding for installed shared objects. This provides
+ additional security hardening because it enables full RELRO and a
+ read-only global offset table (GOT), at the cost of slightly
+ increased program load times.
'--enable-pt_chown'
The file 'pt_chown' is a helper binary for 'grantpt' (*note
@@ -161,8 +185,50 @@ will be used, and CFLAGS sets optimization options for the compiler.
can configure with '--disable-werror'.
'--disable-mathvec'
- By default for x86_64, the GNU C Library is built with vector math
- library. Use this option to disable vector math library.
+ By default for x86_64, the GNU C Library is built with the vector
+ math library. Use this option to disable the vector math library.
+
+'--enable-tunables'
+ Tunables support allows additional library parameters to be
+ customized at runtime. This feature is enabled by default. This
+ option can take the following values:
+
+ 'yes'
+ This is the default if no option is passed to configure. This
+ enables tunables and selects the default frontend (currently
+ 'valstring').
+
+ 'no'
+ This option disables tunables.
+
+ 'valstring'
+ This enables tunables and selects the 'valstring' frontend for
+ tunables. This frontend allows users to specify tunables as a
+ colon-separated list in a single environment variable
+ 'GLIBC_TUNABLES'.
+
+'--enable-obsolete-nsl'
+ By default, libnsl is only built as shared library for backward
+ compatibility and the NSS modules libnss_compat, libnss_nis and
+ libnss_nisplus are not built at all. Use this option to enable
+ libnsl with all depending NSS modules and header files.
+
+'--disable-crypt'
+ Do not install the passphrase-hashing library 'libcrypt' or the
+ header file 'crypt.h'. 'unistd.h' will still declare the function
+ 'crypt'. Using this option does not change the set of programs
+ that may need to be linked with '-lcrypt'; it only means that the
+ GNU C Library will not provide that library.
+
+ This option is for hackers and distributions experimenting with
+ independently-maintained implementations of libcrypt. It may
+ become the default in a future release.
+
+'--disable-experimental-malloc'
+ By default, a per-thread cache is enabled in 'malloc'. While this
+ cache can be disabled on a per-application basis using tunables
+ (set glibc.malloc.tcache_count to zero), this option can be used to
+ remove it from the build completely.
'--build=BUILD-SYSTEM'
'--host=HOST-SYSTEM'
@@ -180,7 +246,7 @@ will be used, and CFLAGS sets optimization options for the compiler.
but you want to compile a library for 586es, give
'--host=i586-pc-linux-gnu' or just '--host=i586-linux' and add the
appropriate compiler flags ('-mcpu=i586' will do the trick) to
- CFLAGS.
+ 'CC'.
If you specify just '--build', 'configure' will get confused.
@@ -199,8 +265,8 @@ will be used, and CFLAGS sets optimization options for the compiler.
To build the library and related programs, type 'make'. This will
produce a lot of output, some of which may look like errors from 'make'
-but isn't. Look for error messages from 'make' containing '***'. Those
-indicate that something is seriously wrong.
+but aren't. Look for error messages from 'make' containing '***'.
+Those indicate that something is seriously wrong.
The compilation process can take a long time, depending on the
configuration and the speed of your machine. Some complex modules may
@@ -230,6 +296,38 @@ You can specify 'stop-on-test-failure=y' when running 'make check' to
make the test run stop and exit with an error status immediately when a
failure occurs.
+ The GNU C Library pretty printers come with their own set of scripts
+for testing, which run together with the rest of the testsuite through
+'make check'. These scripts require the following tools to run
+successfully:
+
+ * Python 2.7/3.4 or later
+
+ Python is required for running the printers' test scripts. As of
+ release time, Python 3.6 is the newest verified to work to test the
+ pretty printers.
+
+ * PExpect 4.0
+
+ The printer tests drive GDB through test programs and compare its
+ output to the printers'. PExpect is used to capture the output of
+ GDB, and should be compatible with the Python version in your
+ system. As of release time PExpect 4.3 is the newest verified to
+ work to test the pretty printers.
+
+ * GDB 7.8 or later with support for Python 2.7/3.4 or later
+
+ GDB itself needs to be configured with Python support in order to
+ use the pretty printers. Notice that your system having Python
+ available doesn't imply that GDB supports it, nor that your
+ system's Python and GDB's have the same version. As of release
+ time GNU 'debugger' 8.0.1 is the newest verified to work to test
+ the pretty printers.
+
+If these tools are absent, the printer tests will report themselves as
+'UNSUPPORTED'. Notice that some of the printer tests require the GNU C
+Library to be compiled with debugging symbols.
+
To format the 'GNU C Library Reference Manual' for printing, type
'make dvi'. You need a working TeX installation to do this. The
distribution builds the on-line formatted version of the manual, as Info
@@ -247,7 +345,7 @@ makefiles.
setting a few variables in 'configparms'. Set 'CC' to the
cross-compiler for the target you configured the library for; it is
important to use this same 'CC' value when running 'configure', like
-this: 'CC=TARGET-gcc configure TARGET'. Set 'BUILD_CC' to the compiler
+this: 'configure TARGET CC=TARGET-gcc'. Set 'BUILD_CC' to the compiler
to use for programs run on the build system as part of compiling the
library. You may need to set 'AR' to cross-compiling versions of 'ar'
if the native tools are not configured to work with object files for the
@@ -349,33 +447,44 @@ Recommended Tools for Compilation
We recommend installing the following GNU tools before attempting to
build the GNU C Library:
- * GNU 'make' 3.79 or newer
+ * GNU 'make' 4.0 or newer
- You need the latest version of GNU 'make'. Modifying the GNU C
- Library to work with other 'make' programs would be so difficult
- that we recommend you port GNU 'make' instead. *Really.* We
- recommend GNU 'make' version 3.79. All earlier versions have
- severe bugs or lack features.
+ As of relase time, GNU 'make' 4.2.1 is the newest verified to work
+ to build the GNU C Library.
- * GCC 4.7 or newer
+ * GCC 4.9 or newer
- GCC 4.7 or higher is required. In general it is recommended to use
+ GCC 4.9 or higher is required. In general it is recommended to use
the newest version of the compiler that is known to work for
building the GNU C Library, as newer compilers usually produce
- better code. As of release time, GCC 5.3 is the newest compiler
+ better code. As of release time, GCC 8.1.1 is the newest compiler
verified to work to build the GNU C Library.
+ For PowerPC 64-bits little-endian (powerpc64le), GCC 6.2 or higher
+ is required. This compiler version is the first to provide the
+ features required for building the GNU C Library with support for
+ '_Float128'.
+
+ For multi-arch support it is recommended to use a GCC which has
+ been built with support for GNU indirect functions. This ensures
+ that correct debugging information is generated for functions
+ selected by IFUNC resolvers. This support can either be enabled by
+ configuring GCC with '--enable-gnu-indirect-function', or by
+ enabling it by default by setting 'default_gnu_indirect_function'
+ variable for a particular architecture in the GCC source file
+ 'gcc/config.gcc'.
+
You can use whatever compiler you like to compile programs that use
the GNU C Library.
Check the FAQ for any special compiler issues on particular
platforms.
- * GNU 'binutils' 2.22 or later
+ * GNU 'binutils' 2.25 or later
You must use GNU 'binutils' (as and ld) to build the GNU C Library.
No other assembler or linker has the necessary functionality at the
- moment. As of release time, GNU 'binutils' 2.25 is the newest
+ moment. As of release time, GNU 'binutils' 2.31.1 is the newest
verified to work to build the GNU C Library.
* GNU 'texinfo' 4.7 or later
@@ -384,7 +493,7 @@ build the GNU C Library:
need this version of the 'texinfo' package. Earlier versions do
not understand all the tags used in the document, and the
installation mechanism for the info files is not present or works
- differently. As of release time, 'texinfo' 6.0 is the newest
+ differently. As of release time, 'texinfo' 6.5 is the newest
verified to work to build the GNU C Library.
* GNU 'awk' 3.1.2, or higher
@@ -392,19 +501,27 @@ build the GNU C Library:
'awk' is used in several places to generate files. Some 'gawk'
extensions are used, including the 'asorti' function, which was
introduced in version 3.1.2 of 'gawk'. As of release time, 'gawk'
- version 4.1.3 is the newest verified to work to build the GNU C
+ version 4.2.1 is the newest verified to work to build the GNU C
Library.
+ * GNU 'bison' 2.7 or later
+
+ 'bison' is used to generate the 'yacc' parser code in the 'intl'
+ subdirectory. As of release time, 'bison' version 3.0.4 is the
+ newest verified to work to build the GNU C Library.
+
* Perl 5
Perl is not required, but it is used if present to test the
- installation. We may decide to use it elsewhere in the future.
+ installation. We may decide to use it elsewhere in the future. As
+ of release time 'perl' version 5.28.0 is the newest verified to
+ work to build the GNU C Library.
* GNU 'sed' 3.02 or newer
'Sed' is used in several places to generate files. Most scripts
work with any version of 'sed'. As of release time, 'sed' version
- 4.2.2 is the newest verified to work to build the GNU C Library.
+ 4.5 is the newest verified to work to build the GNU C Library.
If you change any of the 'configure.ac' files you will also need
@@ -414,10 +531,8 @@ and if you change any of the message translation files you will need
* GNU 'gettext' 0.10.36 or later
-If you wish to regenerate the 'yacc' parser code in the 'intl'
-subdirectory you will need
-
- * GNU 'bison' 2.7 or later
+ As of release time, GNU 'gettext' version 0.19.8.1 is the newest
+ version verified to work to build the GNU C Library.
You may also need these packages if you upgrade your source tree using
patches, although we try to avoid this.
@@ -426,14 +541,16 @@ Specific advice for GNU/Linux systems
=====================================
If you are installing the GNU C Library on GNU/Linux systems, you need
-to have the header files from a 2.6.32 or newer kernel around for
-reference. These headers must be installed using 'make
-headers_install'; the headers present in the kernel source directory are
-not suitable for direct use by the GNU C Library. You do not need to
-use that kernel, just have its headers installed where the GNU C Library
-can access them, referred to here as INSTALL-DIRECTORY. The easiest way
-to do this is to unpack it in a directory such as
-'/usr/src/linux-VERSION'. In that directory, run 'make headers_install
+to have the header files from a 3.2 or newer kernel around for
+reference. (For the ia64 architecture, you need version 3.2.18 or newer
+because this is the first version with support for the 'accept4' system
+call.) These headers must be installed using 'make headers_install';
+the headers present in the kernel source directory are not suitable for
+direct use by the GNU C Library. You do not need to use that kernel,
+just have its headers installed where the GNU C Library can access them,
+referred to here as INSTALL-DIRECTORY. The easiest way to do this is to
+unpack it in a directory such as '/usr/src/linux-VERSION'. In that
+directory, run 'make headers_install
INSTALL_HDR_PATH=INSTALL-DIRECTORY'. Finally, configure the GNU C
Library with the option '--with-headers=INSTALL-DIRECTORY/include'. Use
the most recent kernel you can get your hands on. (If you are
@@ -473,7 +590,7 @@ remain unfixed for all eternity, if not longer.
It is a good idea to verify that the problem has not already been
reported. Bugs are documented in two places: The file 'BUGS' describes
a number of well known bugs and the central GNU C Library bug tracking
-system has a WWW interface at <http://sourceware.org/bugzilla/>. The
+system has a WWW interface at <https://sourceware.org/bugzilla/>. The
WWW interface gives you access to open and closed reports. A closed
report normally includes a patch or a hint on solving the problem.