S390: Optimize atomic macros.
[glibc.git] / INSTALL
blobe77cb2d4e2948891cd910a8ad17ac33d3c164e5c
1 Installing the GNU C Library
2 ****************************
4 Before you do anything else, you should read the FAQ at
5 <http://sourceware.org/glibc/wiki/FAQ>.  It answers common questions and
6 describes problems you may experience with compilation and installation.
8    Features can be added to the GNU C Library via "add-on" bundles.
9 These are separate tar files, which you unpack into the top level of the
10 source tree.  Then you give 'configure' the '--enable-add-ons' option to
11 activate them, and they will be compiled into the library.
13    You will need recent versions of several GNU tools: definitely GCC
14 and GNU Make, and possibly others.  *Note Tools for Compilation::,
15 below.
17 Configuring and compiling the GNU C Library
18 ===========================================
20 The GNU C Library cannot be compiled in the source directory.  You must
21 build it in a separate build directory.  For example, if you have
22 unpacked the GNU C Library sources in '/src/gnu/glibc-VERSION', create a
23 directory '/src/gnu/glibc-build' to put the object files in.  This
24 allows removing the whole build directory in case an error occurs, which
25 is the safest way to get a fresh start and should always be done.
27    From your object directory, run the shell script 'configure' located
28 at the top level of the source tree.  In the scenario above, you'd type
30      $ ../glibc-VERSION/configure ARGS...
32    Please note that even though you're building in a separate build
33 directory, the compilation may need to create or modify files and
34 directories in the source directory.
36 'configure' takes many options, but the only one that is usually
37 mandatory is '--prefix'.  This option tells 'configure' where you want
38 the GNU C Library installed.  This defaults to '/usr/local', but the
39 normal setting to install as the standard system library is
40 '--prefix=/usr' for GNU/Linux systems and '--prefix=' (an empty prefix)
41 for GNU/Hurd systems.
43    It may also be useful to set the CC and CFLAGS variables in the
44 environment when running 'configure'.  CC selects the C compiler that
45 will be used, and CFLAGS sets optimization options for the compiler.
47    The following list describes all of the available options for
48 'configure':
50 '--prefix=DIRECTORY'
51      Install machine-independent data files in subdirectories of
52      'DIRECTORY'.  The default is to install in '/usr/local'.
54 '--exec-prefix=DIRECTORY'
55      Install the library and other machine-dependent files in
56      subdirectories of 'DIRECTORY'.  The default is to the '--prefix'
57      directory if that option is specified, or '/usr/local' otherwise.
59 '--with-headers=DIRECTORY'
60      Look for kernel header files in DIRECTORY, not '/usr/include'.  The
61      GNU C Library needs information from the kernel's header files
62      describing the interface to the kernel.  The GNU C Library will
63      normally look in '/usr/include' for them, but if you specify this
64      option, it will look in DIRECTORY instead.
66      This option is primarily of use on a system where the headers in
67      '/usr/include' come from an older version of the GNU C Library.
68      Conflicts can occasionally happen in this case.  You can also use
69      this option if you want to compile the GNU C Library with a newer
70      set of kernel headers than the ones found in '/usr/include'.
72 '--enable-add-ons[=LIST]'
73      Specify add-on packages to include in the build.  If this option is
74      specified with no list, it enables all the add-on packages it finds
75      in the main source directory; this is the default behavior.  You
76      may specify an explicit list of add-ons to use in LIST, separated
77      by spaces or commas (if you use spaces, remember to quote them from
78      the shell).  Each add-on in LIST can be an absolute directory name
79      or can be a directory name relative to the main source directory,
80      or relative to the build directory (that is, the current working
81      directory).  For example,
82      '--enable-add-ons=nptl,../glibc-libidn-VERSION'.
84 '--enable-kernel=VERSION'
85      This option is currently only useful on GNU/Linux systems.  The
86      VERSION parameter should have the form X.Y.Z and describes the
87      smallest version of the Linux kernel the generated library is
88      expected to support.  The higher the VERSION number is, the less
89      compatibility code is added, and the faster the code gets.
91 '--with-binutils=DIRECTORY'
92      Use the binutils (assembler and linker) in 'DIRECTORY', not the
93      ones the C compiler would default to.  You can use this option if
94      the default binutils on your system cannot deal with all the
95      constructs in the GNU C Library.  In that case, 'configure' will
96      detect the problem and suppress these constructs, so that the
97      library will still be usable, but functionality may be lost--for
98      example, you can't build a shared libc with old binutils.
100 '--without-fp'
101      Use this option if your computer lacks hardware floating-point
102      support and your operating system does not emulate an FPU.
104 '--disable-shared'
105      Don't build shared libraries even if it is possible.  Not all
106      systems support shared libraries; you need ELF support and
107      (currently) the GNU linker.
109 '--disable-profile'
110      Don't build libraries with profiling information.  You may want to
111      use this option if you don't plan to do profiling.
113 '--enable-static-nss'
114      Compile static versions of the NSS (Name Service Switch) libraries.
115      This is not recommended because it defeats the purpose of NSS; a
116      program linked statically with the NSS libraries cannot be
117      dynamically reconfigured to use a different name database.
119 '--enable-hardcoded-path-in-tests'
120      By default, dynamic tests are linked to run with the installed C
121      library.  This option hardcodes the newly built C library path in
122      dynamic tests so that they can be invoked directly.
124 '--disable-timezone-tools'
125      By default, timezone related utilities ('zic', 'zdump', and
126      'tzselect') are installed with the GNU C Library.  If you are
127      building these independently (e.g.  by using the 'tzcode' package),
128      then this option will allow disabling the install of these.
130      Note that you need to make sure the external tools are kept in sync
131      with the versions that the GNU C Library expects as the data
132      formats may change over time.  Consult the 'timezone' subdirectory
133      for more details.
135 '--enable-lock-elision=yes'
136      Enable lock elision for pthread mutexes by default.
138 '--enable-stack-protector'
139 '--enable-stack-protector=strong'
140 '--enable-stack-protector=all'
141      Compile the C library and all other parts of the glibc package
142      (including the threading and math libraries, NSS modules, and
143      transliteration modules) using the GCC '-fstack-protector',
144      '-fstack-protector-strong' or '-fstack-protector-all' options to
145      detect stack overruns.  Only the dynamic linker and a small number
146      of routines called directly from assembler are excluded from this
147      protection.
149 '--enable-bind-now'
150      Disable lazy binding for installed shared objects.  This provides
151      additional security hardening because it enables full RELRO and a
152      read-only global offset table (GOT), at the cost of slightly
153      increased program load times.
155 '--enable-pt_chown'
156      The file 'pt_chown' is a helper binary for 'grantpt' (*note
157      Pseudo-Terminals: Allocation.) that is installed setuid root to fix
158      up pseudo-terminal ownership.  It is not built by default because
159      systems using the Linux kernel are commonly built with the 'devpts'
160      filesystem enabled and mounted at '/dev/pts', which manages
161      pseudo-terminal ownership automatically.  By using
162      '--enable-pt_chown', you may build 'pt_chown' and install it setuid
163      and owned by 'root'.  The use of 'pt_chown' introduces additional
164      security risks to the system and you should enable it only if you
165      understand and accept those risks.
167 '--disable-werror'
168      By default, the GNU C Library is built with '-Werror'.  If you wish
169      to build without this option (for example, if building with a newer
170      version of GCC than this version of the GNU C Library was tested
171      with, so new warnings cause the build with '-Werror' to fail), you
172      can configure with '--disable-werror'.
174 '--disable-mathvec'
175      By default for x86_64, the GNU C Library is built with the vector
176      math library.  Use this option to disable the vector math library.
178 '--enable-tunables'
179      Tunables support allows additional library parameters to be
180      customized at runtime.  This is an experimental feature and affects
181      startup time and is thus disabled by default.  This option can take
182      the following values:
184      'no'
185           This is the default if the option is not passed to configure.
186           This disables tunables.
188      'yes'
189           This is the default if the option is passed to configure.
190           This enables tunables and selects the default frontend
191           (currently 'valstring').
193      'valstring'
194           This enables tunables and selects the 'valstring' frontend for
195           tunables.  This frontend allows users to specify tunables as a
196           colon-separated list in a single environment variable
197           'GLIBC_TUNABLES'.
199 '--build=BUILD-SYSTEM'
200 '--host=HOST-SYSTEM'
201      These options are for cross-compiling.  If you specify both options
202      and BUILD-SYSTEM is different from HOST-SYSTEM, 'configure' will
203      prepare to cross-compile the GNU C Library from BUILD-SYSTEM to be
204      used on HOST-SYSTEM.  You'll probably need the '--with-headers'
205      option too, and you may have to override CONFIGURE's selection of
206      the compiler and/or binutils.
208      If you only specify '--host', 'configure' will prepare for a native
209      compile but use what you specify instead of guessing what your
210      system is.  This is most useful to change the CPU submodel.  For
211      example, if 'configure' guesses your machine as 'i686-pc-linux-gnu'
212      but you want to compile a library for 586es, give
213      '--host=i586-pc-linux-gnu' or just '--host=i586-linux' and add the
214      appropriate compiler flags ('-mcpu=i586' will do the trick) to
215      CFLAGS.
217      If you specify just '--build', 'configure' will get confused.
219 '--with-pkgversion=VERSION'
220      Specify a description, possibly including a build number or build
221      date, of the binaries being built, to be included in '--version'
222      output from programs installed with the GNU C Library.  For
223      example, '--with-pkgversion='FooBar GNU/Linux glibc build 123''.
224      The default value is 'GNU libc'.
226 '--with-bugurl=URL'
227      Specify the URL that users should visit if they wish to report a
228      bug, to be included in '--help' output from programs installed with
229      the GNU C Library.  The default value refers to the main
230      bug-reporting information for the GNU C Library.
232    To build the library and related programs, type 'make'.  This will
233 produce a lot of output, some of which may look like errors from 'make'
234 but aren't.  Look for error messages from 'make' containing '***'.
235 Those indicate that something is seriously wrong.
237    The compilation process can take a long time, depending on the
238 configuration and the speed of your machine.  Some complex modules may
239 take a very long time to compile, as much as several minutes on slower
240 machines.  Do not panic if the compiler appears to hang.
242    If you want to run a parallel make, simply pass the '-j' option with
243 an appropriate numeric parameter to 'make'.  You need a recent GNU
244 'make' version, though.
246    To build and run test programs which exercise some of the library
247 facilities, type 'make check'.  If it does not complete successfully, do
248 not use the built library, and report a bug after verifying that the
249 problem is not already known.  *Note Reporting Bugs::, for instructions
250 on reporting bugs.  Note that some of the tests assume they are not
251 being run by 'root'.  We recommend you compile and test the GNU C
252 Library as an unprivileged user.
254    Before reporting bugs make sure there is no problem with your system.
255 The tests (and later installation) use some pre-existing files of the
256 system such as '/etc/passwd', '/etc/nsswitch.conf' and others.  These
257 files must all contain correct and sensible content.
259    Normally, 'make check' will run all the tests before reporting all
260 problems found and exiting with error status if any problems occurred.
261 You can specify 'stop-on-test-failure=y' when running 'make check' to
262 make the test run stop and exit with an error status immediately when a
263 failure occurs.
265    The GNU C Library pretty printers come with their own set of scripts
266 for testing, which run together with the rest of the testsuite through
267 'make check'.  These scripts require the following tools to run
268 successfully:
270    * Python 2.7.6/3.4.3 or later
272      Python is required for running the printers' test scripts.
274    * PExpect 4.0
276      The printer tests drive GDB through test programs and compare its
277      output to the printers'.  PExpect is used to capture the output of
278      GDB, and should be compatible with the Python version in your
279      system.
281    * GDB 7.8 or later with support for Python 2.7.6/3.4.3 or later
283      GDB itself needs to be configured with Python support in order to
284      use the pretty printers.  Notice that your system having Python
285      available doesn't imply that GDB supports it, nor that your
286      system's Python and GDB's have the same version.
288 If these tools are absent, the printer tests will report themselves as
289 'UNSUPPORTED'.  Notice that some of the printer tests require the GNU C
290 Library to be compiled with debugging symbols.
292    To format the 'GNU C Library Reference Manual' for printing, type
293 'make dvi'.  You need a working TeX installation to do this.  The
294 distribution builds the on-line formatted version of the manual, as Info
295 files, as part of the build process.  You can build them manually with
296 'make info'.
298    The library has a number of special-purpose configuration parameters
299 which you can find in 'Makeconfig'.  These can be overwritten with the
300 file 'configparms'.  To change them, create a 'configparms' in your
301 build directory and add values as appropriate for your system.  The file
302 is included and parsed by 'make' and has to follow the conventions for
303 makefiles.
305    It is easy to configure the GNU C Library for cross-compilation by
306 setting a few variables in 'configparms'.  Set 'CC' to the
307 cross-compiler for the target you configured the library for; it is
308 important to use this same 'CC' value when running 'configure', like
309 this: 'CC=TARGET-gcc configure TARGET'.  Set 'BUILD_CC' to the compiler
310 to use for programs run on the build system as part of compiling the
311 library.  You may need to set 'AR' to cross-compiling versions of 'ar'
312 if the native tools are not configured to work with object files for the
313 target you configured for.  When cross-compiling the GNU C Library, it
314 may be tested using 'make check
315 test-wrapper="SRCDIR/scripts/cross-test-ssh.sh HOSTNAME"', where SRCDIR
316 is the absolute directory name for the main source directory and
317 HOSTNAME is the host name of a system that can run the newly built
318 binaries of the GNU C Library.  The source and build directories must be
319 visible at the same locations on both the build system and HOSTNAME.
321    In general, when testing the GNU C Library, 'test-wrapper' may be set
322 to the name and arguments of any program to run newly built binaries.
323 This program must preserve the arguments to the binary being run, its
324 working directory and the standard input, output and error file
325 descriptors.  If 'TEST-WRAPPER env' will not work to run a program with
326 environment variables set, then 'test-wrapper-env' must be set to a
327 program that runs a newly built program with environment variable
328 assignments in effect, those assignments being specified as 'VAR=VALUE'
329 before the name of the program to be run.  If multiple assignments to
330 the same variable are specified, the last assignment specified must take
331 precedence.  Similarly, if 'TEST-WRAPPER env -i' will not work to run a
332 program with an environment completely empty of variables except those
333 directly assigned, then 'test-wrapper-env-only' must be set; its use has
334 the same syntax as 'test-wrapper-env', the only difference in its
335 semantics being starting with an empty set of environment variables
336 rather than the ambient set.
338 Installing the C Library
339 ========================
341 To install the library and its header files, and the Info files of the
342 manual, type 'make install'.  This will build things, if necessary,
343 before installing them; however, you should still compile everything
344 first.  If you are installing the GNU C Library as your primary C
345 library, we recommend that you shut the system down to single-user mode
346 first, and reboot afterward.  This minimizes the risk of breaking things
347 when the library changes out from underneath.
349    'make install' will do the entire job of upgrading from a previous
350 installation of the GNU C Library version 2.x.  There may sometimes be
351 headers left behind from the previous installation, but those are
352 generally harmless.  If you want to avoid leaving headers behind you can
353 do things in the following order.
355    You must first build the library ('make'), optionally check it ('make
356 check'), switch the include directories and then install ('make
357 install').  The steps must be done in this order.  Not moving the
358 directory before install will result in an unusable mixture of header
359 files from both libraries, but configuring, building, and checking the
360 library requires the ability to compile and run programs against the old
361 library.  The new '/usr/include', after switching the include
362 directories and before installing the library should contain the Linux
363 headers, but nothing else.  If you do this, you will need to restore any
364 headers from libraries other than the GNU C Library yourself after
365 installing the library.
367    You can install the GNU C Library somewhere other than where you
368 configured it to go by setting the 'DESTDIR' GNU standard make variable
369 on the command line for 'make install'.  The value of this variable is
370 prepended to all the paths for installation.  This is useful when
371 setting up a chroot environment or preparing a binary distribution.  The
372 directory should be specified with an absolute file name.  Installing
373 with the 'prefix' and 'exec_prefix' GNU standard make variables set is
374 not supported.
376    The GNU C Library includes a daemon called 'nscd', which you may or
377 may not want to run.  'nscd' caches name service lookups; it can
378 dramatically improve performance with NIS+, and may help with DNS as
379 well.
381    One auxiliary program, '/usr/libexec/pt_chown', is installed setuid
382 'root' if the '--enable-pt_chown' configuration option is used.  This
383 program is invoked by the 'grantpt' function; it sets the permissions on
384 a pseudoterminal so it can be used by the calling process.  If you are
385 using a Linux kernel with the 'devpts' filesystem enabled and mounted at
386 '/dev/pts', you don't need this program.
388    After installation you might want to configure the timezone and
389 locale installation of your system.  The GNU C Library comes with a
390 locale database which gets configured with 'localedef'.  For example, to
391 set up a German locale with name 'de_DE', simply issue the command
392 'localedef -i de_DE -f ISO-8859-1 de_DE'.  To configure all locales that
393 are supported by the GNU C Library, you can issue from your build
394 directory the command 'make localedata/install-locales'.
396    To configure the locally used timezone, set the 'TZ' environment
397 variable.  The script 'tzselect' helps you to select the right value.
398 As an example, for Germany, 'tzselect' would tell you to use
399 'TZ='Europe/Berlin''.  For a system wide installation (the given paths
400 are for an installation with '--prefix=/usr'), link the timezone file
401 which is in '/usr/share/zoneinfo' to the file '/etc/localtime'.  For
402 Germany, you might execute 'ln -s /usr/share/zoneinfo/Europe/Berlin
403 /etc/localtime'.
405 Recommended Tools for Compilation
406 =================================
408 We recommend installing the following GNU tools before attempting to
409 build the GNU C Library:
411    * GNU 'make' 3.79 or newer
413      You need the latest version of GNU 'make'.  Modifying the GNU C
414      Library to work with other 'make' programs would be so difficult
415      that we recommend you port GNU 'make' instead.  *Really.*  We
416      recommend GNU 'make' version 3.79.  All earlier versions have
417      severe bugs or lack features.
419    * GCC 4.7 or newer
421      GCC 4.7 or higher is required.  In general it is recommended to use
422      the newest version of the compiler that is known to work for
423      building the GNU C Library, as newer compilers usually produce
424      better code.  As of release time, GCC 6.3 is the newest compiler
425      verified to work to build the GNU C Library.
427      For multi-arch support it is recommended to use a GCC which has
428      been built with support for GNU indirect functions.  This ensures
429      that correct debugging information is generated for functions
430      selected by IFUNC resolvers.  This support can either be enabled by
431      configuring GCC with '--enable-gnu-indirect-function', or by
432      enabling it by default by setting 'default_gnu_indirect_function'
433      variable for a particular architecture in the GCC source file
434      'gcc/config.gcc'.
436      You can use whatever compiler you like to compile programs that use
437      the GNU C Library.
439      Check the FAQ for any special compiler issues on particular
440      platforms.
442    * GNU 'binutils' 2.22 or later
444      You must use GNU 'binutils' (as and ld) to build the GNU C Library.
445      No other assembler or linker has the necessary functionality at the
446      moment.  As of release time, GNU 'binutils' 2.25 is the newest
447      verified to work to build the GNU C Library.
449    * GNU 'texinfo' 4.7 or later
451      To correctly translate and install the Texinfo documentation you
452      need this version of the 'texinfo' package.  Earlier versions do
453      not understand all the tags used in the document, and the
454      installation mechanism for the info files is not present or works
455      differently.  As of release time, 'texinfo' 6.0 is the newest
456      verified to work to build the GNU C Library.
458    * GNU 'awk' 3.1.2, or higher
460      'awk' is used in several places to generate files.  Some 'gawk'
461      extensions are used, including the 'asorti' function, which was
462      introduced in version 3.1.2 of 'gawk'.  As of release time, 'gawk'
463      version 4.1.3 is the newest verified to work to build the GNU C
464      Library.
466    * Perl 5
468      Perl is not required, but it is used if present to test the
469      installation.  We may decide to use it elsewhere in the future.
471    * GNU 'sed' 3.02 or newer
473      'Sed' is used in several places to generate files.  Most scripts
474      work with any version of 'sed'.  As of release time, 'sed' version
475      4.2.2 is the newest verified to work to build the GNU C Library.
477 If you change any of the 'configure.ac' files you will also need
479    * GNU 'autoconf' 2.69 (exactly)
481 and if you change any of the message translation files you will need
483    * GNU 'gettext' 0.10.36 or later
485 If you wish to regenerate the 'yacc' parser code in the 'intl'
486 subdirectory you will need
488    * GNU 'bison' 2.7 or later
490 You may also need these packages if you upgrade your source tree using
491 patches, although we try to avoid this.
493 Specific advice for GNU/Linux systems
494 =====================================
496 If you are installing the GNU C Library on GNU/Linux systems, you need
497 to have the header files from a 3.2 or newer kernel around for
498 reference.  These headers must be installed using 'make
499 headers_install'; the headers present in the kernel source directory are
500 not suitable for direct use by the GNU C Library.  You do not need to
501 use that kernel, just have its headers installed where the GNU C Library
502 can access them, referred to here as INSTALL-DIRECTORY.  The easiest way
503 to do this is to unpack it in a directory such as
504 '/usr/src/linux-VERSION'.  In that directory, run 'make headers_install
505 INSTALL_HDR_PATH=INSTALL-DIRECTORY'.  Finally, configure the GNU C
506 Library with the option '--with-headers=INSTALL-DIRECTORY/include'.  Use
507 the most recent kernel you can get your hands on.  (If you are
508 cross-compiling the GNU C Library, you need to specify
509 'ARCH=ARCHITECTURE' in the 'make headers_install' command, where
510 ARCHITECTURE is the architecture name used by the Linux kernel, such as
511 'x86' or 'powerpc'.)
513    After installing the GNU C Library, you may need to remove or rename
514 directories such as '/usr/include/linux' and '/usr/include/asm', and
515 replace them with copies of directories such as 'linux' and 'asm' from
516 'INSTALL-DIRECTORY/include'.  All directories present in
517 'INSTALL-DIRECTORY/include' should be copied, except that the GNU C
518 Library provides its own version of '/usr/include/scsi'; the files
519 provided by the kernel should be copied without replacing those provided
520 by the GNU C Library.  The 'linux', 'asm' and 'asm-generic' directories
521 are required to compile programs using the GNU C Library; the other
522 directories describe interfaces to the kernel but are not required if
523 not compiling programs using those interfaces.  You do not need to copy
524 kernel headers if you did not specify an alternate kernel header source
525 using '--with-headers'.
527    The Filesystem Hierarchy Standard for GNU/Linux systems expects some
528 components of the GNU C Library installation to be in '/lib' and some in
529 '/usr/lib'.  This is handled automatically if you configure the GNU C
530 Library with '--prefix=/usr'.  If you set some other prefix or allow it
531 to default to '/usr/local', then all the components are installed there.
533 Reporting Bugs
534 ==============
536 There are probably bugs in the GNU C Library.  There are certainly
537 errors and omissions in this manual.  If you report them, they will get
538 fixed.  If you don't, no one will ever know about them and they will
539 remain unfixed for all eternity, if not longer.
541    It is a good idea to verify that the problem has not already been
542 reported.  Bugs are documented in two places: The file 'BUGS' describes
543 a number of well known bugs and the central GNU C Library bug tracking
544 system has a WWW interface at <http://sourceware.org/bugzilla/>.  The
545 WWW interface gives you access to open and closed reports.  A closed
546 report normally includes a patch or a hint on solving the problem.
548    To report a bug, first you must find it.  With any luck, this will be
549 the hard part.  Once you've found a bug, make sure it's really a bug.  A
550 good way to do this is to see if the GNU C Library behaves the same way
551 some other C library does.  If so, probably you are wrong and the
552 libraries are right (but not necessarily).  If not, one of the libraries
553 is probably wrong.  It might not be the GNU C Library.  Many historical
554 Unix C libraries permit things that we don't, such as closing a file
555 twice.
557    If you think you have found some way in which the GNU C Library does
558 not conform to the ISO and POSIX standards (*note Standards and
559 Portability::), that is definitely a bug.  Report it!
561    Once you're sure you've found a bug, try to narrow it down to the
562 smallest test case that reproduces the problem.  In the case of a C
563 library, you really only need to narrow it down to one library function
564 call, if possible.  This should not be too difficult.
566    The final step when you have a simple test case is to report the bug.
567 Do this at <http://www.gnu.org/software/libc/bugs.html>.
569    If you are not sure how a function should behave, and this manual
570 doesn't tell you, that's a bug in the manual.  Report that too!  If the
571 function's behavior disagrees with the manual, then either the library
572 or the manual has a bug, so report the disagreement.  If you find any
573 errors or omissions in this manual, please report them to the bug
574 database.  If you refer to specific sections of the manual, please
575 include the section names for easier identification.