]> git.ipfire.org Git - thirdparty/glibc.git/blame - manual/install.texi
Merge branch release/2.28/master into ibm/2.28/master
[thirdparty/glibc.git] / manual / install.texi
CommitLineData
1f77f049 1@include macros.texi
8b748aed 2@include pkgvers.texi
3c20b9b6 3
d136c6dc 4@ifclear plain
3d2abe79 5@node Installation, Maintenance, Library Summary, Top
d136c6dc
SP
6@end ifclear
7
1f77f049
JM
8@c %MENU% How to install the GNU C Library
9@appendix Installing @theglibc{}
3c20b9b6 10
7ac30cc5 11Before you do anything else, you should read the FAQ at
a306c790 12@url{https://sourceware.org/glibc/wiki/FAQ}. It answers common
7ac30cc5
AJ
13questions and describes problems you may experience with compilation
14and installation.
3c20b9b6 15
00c1176b 16You will need recent versions of several GNU tools: definitely GCC and
fe959e1e 17GNU Make, and possibly others. @xref{Tools for Compilation}, below.
00c1176b 18
ee0a148a 19@ifclear plain
00c1176b
UD
20@menu
21* Configuring and compiling:: How to compile and test GNU libc.
a4d62195
UD
22* Running make install:: How to install it once you've got it
23 compiled.
00c1176b 24* Tools for Compilation:: You'll need these first.
90d1d40b 25* Linux:: Specific advice for GNU/Linux systems.
00c1176b
UD
26* Reporting Bugs:: So they'll get fixed.
27@end menu
ee0a148a 28@end ifclear
00c1176b
UD
29
30@node Configuring and compiling
1f77f049 31@appendixsec Configuring and compiling @theglibc{}
1792d4db
UD
32@cindex configuring
33@cindex compiling
00c1176b 34
1f77f049 35@Theglibc{} cannot be compiled in the source directory. You must build
3858bf28 36it in a separate build directory. For example, if you have unpacked
1f77f049
JM
37the @glibcadj{} sources in @file{/src/gnu/glibc-@var{version}},
38create a directory
e8b1163e 39@file{/src/gnu/glibc-build} to put the object files in. This allows
3858bf28
RM
40removing the whole build directory in case an error occurs, which is
41the safest way to get a fresh start and should always be done.
00c1176b 42
a4d62195 43From your object directory, run the shell script @file{configure} located
00c1176b
UD
44at the top level of the source tree. In the scenario above, you'd type
45
46@smallexample
f1e86fca 47$ ../glibc-@var{version}/configure @var{args@dots{}}
00c1176b
UD
48@end smallexample
49
3858bf28 50Please note that even though you're building in a separate build
e6bdb741
AJ
51directory, the compilation may need to create or modify files and
52directories in the source directory.
f76d7052 53
00c1176b 54@noindent
3858bf28
RM
55@code{configure} takes many options, but the only one that is usually
56mandatory is @samp{--prefix}. This option tells @code{configure}
1f77f049 57where you want @theglibc{} installed. This defaults to @file{/usr/local},
3858bf28 58but the normal setting to install as the standard system library is
a7a93d50
JM
59@samp{--prefix=/usr} for @gnulinuxsystems{} and @samp{--prefix=} (an
60empty prefix) for @gnuhurdsystems{}.
00c1176b 61
db9881ec
JM
62It may also be useful to pass @samp{CC=@var{compiler}} and
63@code{CFLAGS=@var{flags}} arguments to @code{configure}. @code{CC}
64selects the C compiler that will be used, and @code{CFLAGS} sets
65optimization options for the compiler. Any compiler options required
66for all compilations, such as options selecting an ABI or a processor
67for which to generate code, should be included in @code{CC}. Options
68that may be overridden by the @glibcadj{} build system for particular
69files, such as for optimization and debugging, should go in
70@code{CFLAGS}. The default value of @code{CFLAGS} is @samp{-g -O2},
71and @theglibc{} cannot be compiled without optimization, so if
72@code{CFLAGS} is specified it must enable optimization. For example:
73
74@smallexample
75$ ../glibc-@var{version}/configure CC="gcc -m32" CFLAGS="-O3"
76@end smallexample
00c1176b 77
a4d62195
UD
78The following list describes all of the available options for
79 @code{configure}:
3c20b9b6
UD
80
81@table @samp
00c1176b
UD
82@item --prefix=@var{directory}
83Install machine-independent data files in subdirectories of
84@file{@var{directory}}. The default is to install in @file{/usr/local}.
85
86@item --exec-prefix=@var{directory}
87Install the library and other machine-dependent files in subdirectories
88of @file{@var{directory}}. The default is to the @samp{--prefix}
04b9968b 89directory if that option is specified, or @file{/usr/local} otherwise.
00c1176b
UD
90
91@item --with-headers=@var{directory}
92Look for kernel header files in @var{directory}, not
1f77f049
JM
93@file{/usr/include}. @Theglibc{} needs information from the kernel's header
94files describing the interface to the kernel. @Theglibc{} will normally
abd923db 95look in @file{/usr/include} for them,
04b9968b 96but if you specify this option, it will look in @var{DIRECTORY} instead.
00c1176b
UD
97
98This option is primarily of use on a system where the headers in
1f77f049 99@file{/usr/include} come from an older version of @theglibc{}. Conflicts can
02c4bbad 100occasionally happen in this case. You can also use this option if you want to
1f77f049 101compile @theglibc{} with a newer set of kernel headers than the ones found in
00c1176b
UD
102@file{/usr/include}.
103
d2830ba4 104@item --enable-kernel=@var{version}
a7a93d50 105This option is currently only useful on @gnulinuxsystems{}. The
d2830ba4
UD
106@var{version} parameter should have the form X.Y.Z and describes the
107smallest version of the Linux kernel the generated library is expected
108to support. The higher the @var{version} number is, the less
109compatibility code is added, and the faster the code gets.
110
3c20b9b6
UD
111@item --with-binutils=@var{directory}
112Use the binutils (assembler and linker) in @file{@var{directory}}, not
a4d62195 113the ones the C compiler would default to. You can use this option if
3c20b9b6 114the default binutils on your system cannot deal with all the constructs
1f77f049 115in @theglibc{}. In that case, @code{configure} will detect the
a4d62195
UD
116problem and suppress these constructs, so that the library will still be
117usable, but functionality may be lost---for example, you can't build a
118shared libc with old binutils.
3c20b9b6 119
b5ca0fb0
UD
120@c disable static doesn't work currently
121@c @item --disable-static
fb06851d 122@c Don't build static libraries. Static libraries aren't that useful these
b5ca0fb0 123@c days, but we recommend you build them in case you need them.
3c20b9b6 124
00c1176b 125@item --disable-shared
a4d62195
UD
126Don't build shared libraries even if it is possible. Not all systems
127support shared libraries; you need ELF support and (currently) the GNU
128linker.
3c20b9b6 129
9d7a3741
L
130@item --enable-static-pie
131Enable static position independent executable (static PIE) support.
132Static PIE is similar to static executable, but can be loaded at any
133address without help from a dynamic linker. All static programs as
134well as static tests are built as static PIE, except for those marked
135with no-pie. The resulting glibc can be used with the GCC option,
136-static-pie, which is available with GCC 8 or above, to create static
126adc89
L
137PIE. This option also implies that glibc programs and tests are created
138as dynamic position independent executables (PIE) by default.
9d7a3741 139
e6c69509
L
140@item --enable-cet
141Enable Intel Control-flow Enforcement Technology (CET) support. When
142@theglibc{} is built with @option{--enable-cet}, the resulting library
143is protected with indirect branch tracking (IBT) and shadow stack
144(SHSTK)@. When CET is enabled, @theglibc{} is compatible with all
145existing executables and shared libraries. This feature is currently
146supported on i386, x86_64 and x32 with GCC 8 and binutils 2.29 or later.
147Note that when CET is enabled, @theglibc{} requires CPUs capable of
148multi-byte NOPs, like x86-64 processors as well as Intel Pentium Pro or
149newer.
150
e84bd851
L
151NOTE: @option{--enable-cet} has been tested for i686, x86_64 and x32
152on non-CET processors. @option{--enable-cet} has been tested for
153x86_64 and x32 on CET SDVs, but Intel CET support hasn't been validated
154for i686.
155
00c1176b
UD
156@item --disable-profile
157Don't build libraries with profiling information. You may want to use
158this option if you don't plan to do profiling.
f12944ec 159
00c1176b
UD
160@item --enable-static-nss
161Compile static versions of the NSS (Name Service Switch) libraries.
162This is not recommended because it defeats the purpose of NSS; a program
163linked statically with the NSS libraries cannot be dynamically
164reconfigured to use a different name database.
165
740b3dbe
L
166@item --enable-hardcoded-path-in-tests
167By default, dynamic tests are linked to run with the installed C library.
168This option hardcodes the newly built C library path in dynamic tests
169so that they can be invoked directly.
170
1cba4036
MF
171@item --disable-timezone-tools
172By default, timezone related utilities (@command{zic}, @command{zdump},
44f826e3 173and @command{tzselect}) are installed with @theglibc{}. If you are building
1cba4036 174these independently (e.g. by using the @samp{tzcode} package), then this
44f826e3 175option will allow disabling the install of these.
1cba4036
MF
176
177Note that you need to make sure the external tools are kept in sync with
178the versions that @theglibc{} expects as the data formats may change over
179time. Consult the @file{timezone} subdirectory for more details.
180
03baef1c
NA
181@item --enable-stack-protector
182@itemx --enable-stack-protector=strong
183@itemx --enable-stack-protector=all
184Compile the C library and all other parts of the glibc package
185(including the threading and math libraries, NSS modules, and
186transliteration modules) using the GCC @option{-fstack-protector},
187@option{-fstack-protector-strong} or @option{-fstack-protector-all}
188options to detect stack overruns. Only the dynamic linker and a small
189number of routines called directly from assembler are excluded from this
190protection.
191
2d6ab5df
FW
192@item --enable-bind-now
193Disable lazy binding for installed shared objects. This provides
194additional security hardening because it enables full RELRO and a
195read-only global offset table (GOT), at the cost of slightly increased
196program load times.
197
e4608715
CD
198@pindex pt_chown
199@findex grantpt
200@item --enable-pt_chown
201The file @file{pt_chown} is a helper binary for @code{grantpt}
202(@pxref{Allocation, Pseudo-Terminals}) that is installed setuid root to
203fix up pseudo-terminal ownership. It is not built by default because
204systems using the Linux kernel are commonly built with the @code{devpts}
205filesystem enabled and mounted at @file{/dev/pts}, which manages
206pseudo-terminal ownership automatically. By using
207@samp{--enable-pt_chown}, you may build @file{pt_chown} and install it
208setuid and owned by @code{root}. The use of @file{pt_chown} introduces
209additional security risks to the system and you should enable it only if
210you understand and accept those risks.
211
a4ecc9eb
JM
212@item --disable-werror
213By default, @theglibc{} is built with @option{-Werror}. If you wish
214to build without this option (for example, if building with a newer
215version of GCC than this version of @theglibc{} was tested with, so
216new warnings cause the build with @option{-Werror} to fail), you can
217configure with @option{--disable-werror}.
218
21933112 219@item --disable-mathvec
b55a155f
RJ
220By default for x86_64, @theglibc{} is built with the vector math library.
221Use this option to disable the vector math library.
21933112 222
67e58f39
SP
223@item --enable-tunables
224Tunables support allows additional library parameters to be customized at
2c0b90ab
SP
225runtime. This feature is enabled by default. This option can take the
226following values:
6765d5d3
SP
227
228@table @code
6765d5d3 229@item yes
2c0b90ab 230This is the default if no option is passed to configure. This enables tunables
6765d5d3
SP
231and selects the default frontend (currently @samp{valstring}).
232
2c0b90ab
SP
233@item no
234This option disables tunables.
235
6765d5d3
SP
236@item valstring
237This enables tunables and selects the @samp{valstring} frontend for tunables.
238This frontend allows users to specify tunables as a colon-separated list in a
239single environment variable @env{GLIBC_TUNABLES}.
240@end table
67e58f39 241
1e4d83f6
TK
242@item --enable-obsolete-nsl
243By default, libnsl is only built as shared library for backward
244compatibility and the NSS modules libnss_compat, libnss_nis and
245libnss_nisplus are not built at all.
246Use this option to enable libnsl with all depending NSS modules and
247header files.
248
e69d994a
ZW
249@item --disable-crypt
250Do not install the passphrase-hashing library @file{libcrypt} or the
251header file @file{crypt.h}. @file{unistd.h} will still declare the
252function @code{crypt}. Using this option does not change the set of
253programs that may need to be linked with @option{-lcrypt}; it only
254means that @theglibc{} will not provide that library.
255
256This option is for hackers and distributions experimenting with
257independently-maintained implementations of libcrypt. It may become
258the default in a future release.
259
d5c3fafc
DD
260@item --disable-experimental-malloc
261By default, a per-thread cache is enabled in @code{malloc}. While
262this cache can be disabled on a per-application basis using tunables
263(set glibc.malloc.tcache_count to zero), this option can be used to
264remove it from the build completely.
265
00c1176b
UD
266@item --build=@var{build-system}
267@itemx --host=@var{host-system}
04b9968b 268These options are for cross-compiling. If you specify both options and
00c1176b 269@var{build-system} is different from @var{host-system}, @code{configure}
1f77f049 270will prepare to cross-compile @theglibc{} from @var{build-system} to be used
00c1176b
UD
271on @var{host-system}. You'll probably need the @samp{--with-headers}
272option too, and you may have to override @var{configure}'s selection of
273the compiler and/or binutils.
274
a4d62195
UD
275If you only specify @samp{--host}, @code{configure} will prepare for a
276native compile but use what you specify instead of guessing what your
cf822e3c 277system is. This is most useful to change the CPU submodel. For example,
e98cdb38
CD
278if @code{configure} guesses your machine as @code{i686-pc-linux-gnu} but
279you want to compile a library for 586es, give
280@samp{--host=i586-pc-linux-gnu} or just @samp{--host=i586-linux} and add
281the appropriate compiler flags (@samp{-mcpu=i586} will do the trick) to
db9881ec 282@code{CC}.
1792d4db 283
a4d62195 284If you specify just @samp{--build}, @code{configure} will get confused.
8b748aed
JM
285
286@item --with-pkgversion=@var{version}
287Specify a description, possibly including a build number or build
288date, of the binaries being built, to be included in
289@option{--version} output from programs installed with @theglibc{}.
290For example, @option{--with-pkgversion='FooBar GNU/Linux glibc build
291123'}. The default value is @samp{GNU libc}.
292
293@item --with-bugurl=@var{url}
294Specify the URL that users should visit if they wish to report a bug,
295to be included in @option{--help} output from programs installed with
296@theglibc{}. The default value refers to the main bug-reporting
297information for @theglibc{}.
3c20b9b6
UD
298@end table
299
00c1176b
UD
300To build the library and related programs, type @code{make}. This will
301produce a lot of output, some of which may look like errors from
b55a155f 302@code{make} but aren't. Look for error messages from @code{make}
a4d62195 303containing @samp{***}. Those indicate that something is seriously wrong.
00c1176b 304
3858bf28
RM
305The compilation process can take a long time, depending on the
306configuration and the speed of your machine. Some complex modules may
307take a very long time to compile, as much as several minutes on slower
308machines. Do not panic if the compiler appears to hang.
3c20b9b6 309
8eadd4f3
UD
310If you want to run a parallel make, simply pass the @samp{-j} option
311with an appropriate numeric parameter to @code{make}. You need a recent
312GNU @code{make} version, though.
f12944ec 313
04b9968b
UD
314To build and run test programs which exercise some of the library
315facilities, type @code{make check}. If it does not complete
316successfully, do not use the built library, and report a bug after
317verifying that the problem is not already known. @xref{Reporting Bugs},
318for instructions on reporting bugs. Note that some of the tests assume
319they are not being run by @code{root}. We recommend you compile and
1f77f049 320test @theglibc{} as an unprivileged user.
3c20b9b6 321
8eadd4f3 322Before reporting bugs make sure there is no problem with your system.
a4d62195 323The tests (and later installation) use some pre-existing files of the
8eadd4f3
UD
324system such as @file{/etc/passwd}, @file{/etc/nsswitch.conf} and others.
325These files must all contain correct and sensible content.
326
d6fe5e58
JM
327Normally, @code{make check} will run all the tests before reporting
328all problems found and exiting with error status if any problems
329occurred. You can specify @samp{stop-on-test-failure=y} when running
330@code{make check} to make the test run stop and exit with an error
331status immediately when a failure occurs.
332
23b5cae1
MG
333The @glibcadj{} pretty printers come with their own set of scripts for testing,
334which run together with the rest of the testsuite through @code{make check}.
335These scripts require the following tools to run successfully:
336
337@itemize @bullet
338@item
f650932b 339Python 2.7/3.4 or later
23b5cae1 340
f650932b
CD
341Python is required for running the printers' test scripts. As of release time,
342Python 3.6 is the newest verified to work to test the pretty printers.
23b5cae1
MG
343
344@item PExpect 4.0
345
346The printer tests drive GDB through test programs and compare its output
347to the printers'. PExpect is used to capture the output of GDB, and should be
f650932b
CD
348compatible with the Python version in your system. As of release time
349PExpect 4.3 is the newest verified to work to test the pretty printers.
23b5cae1
MG
350
351@item
f650932b 352GDB 7.8 or later with support for Python 2.7/3.4 or later
23b5cae1
MG
353
354GDB itself needs to be configured with Python support in order to use the
355pretty printers. Notice that your system having Python available doesn't imply
356that GDB supports it, nor that your system's Python and GDB's have the same
f650932b
CD
357version. As of release time GNU @code{debugger} 8.0.1 is the newest verified
358to work to test the pretty printers.
23b5cae1
MG
359@end itemize
360
361@noindent
362If these tools are absent, the printer tests will report themselves as
363@code{UNSUPPORTED}. Notice that some of the printer tests require @theglibc{}
364to be compiled with debugging symbols.
365
3c20b9b6 366To format the @cite{GNU C Library Reference Manual} for printing, type
6a4888ff
AJ
367@w{@code{make dvi}}. You need a working @TeX{} installation to do
368this. The distribution builds the on-line formatted version of the
369manual, as Info files, as part of the build process. You can build
370them manually with @w{@code{make info}}.
1792d4db 371
2e8048e5
UD
372The library has a number of special-purpose configuration parameters
373which you can find in @file{Makeconfig}. These can be overwritten with
374the file @file{configparms}. To change them, create a
375@file{configparms} in your build directory and add values as appropriate
376for your system. The file is included and parsed by @code{make} and has
377to follow the conventions for makefiles.
378
1f77f049 379It is easy to configure @theglibc{} for cross-compilation by
2e8048e5
UD
380setting a few variables in @file{configparms}. Set @code{CC} to the
381cross-compiler for the target you configured the library for; it is
382important to use this same @code{CC} value when running
db9881ec
JM
383@code{configure}, like this: @samp{configure @var{target}
384CC=@var{target}-gcc}. Set @code{BUILD_CC} to the compiler to use for programs
a4d62195 385run on the build system as part of compiling the library. You may need to
e9433893
UD
386set @code{AR} to cross-compiling versions of @code{ar}
387if the native tools are not configured to work with
df381762
JM
388object files for the target you configured for. When cross-compiling
389@theglibc{}, it may be tested using @samp{make check
390test-wrapper="@var{srcdir}/scripts/cross-test-ssh.sh @var{hostname}"},
391where @var{srcdir} is the absolute directory name for the main source
392directory and @var{hostname} is the host name of a system that can run
393the newly built binaries of @theglibc{}. The source and build
394directories must be visible at the same locations on both the build
395system and @var{hostname}.
2e8048e5 396
0eb69512
JM
397In general, when testing @theglibc{}, @samp{test-wrapper} may be set
398to the name and arguments of any program to run newly built binaries.
399This program must preserve the arguments to the binary being run, its
8540f6d2 400working directory and the standard input, output and error file
4acc27ed
RM
401descriptors. If @samp{@var{test-wrapper} env} will not work to run a
402program with environment variables set, then @samp{test-wrapper-env}
403must be set to a program that runs a newly built program with
404environment variable assignments in effect, those assignments being
405specified as @samp{@var{var}=@var{value}} before the name of the
406program to be run. If multiple assignments to the same variable are
407specified, the last assignment specified must take precedence.
408Similarly, if @samp{@var{test-wrapper} env -i} will not work to run a
409program with an environment completely empty of variables except those
410directly assigned, then @samp{test-wrapper-env-only} must be set; its
411use has the same syntax as @samp{test-wrapper-env}, the only
412difference in its semantics being starting with an empty set of
413environment variables rather than the ambient set.
0eb69512 414
2e8048e5 415
085320f5 416@node Running make install
1792d4db
UD
417@appendixsec Installing the C Library
418@cindex installing
3c20b9b6
UD
419
420To install the library and its header files, and the Info files of the
686554bf 421manual, type @code{make install}. This will
a4d62195 422build things, if necessary, before installing them; however, you should
1f77f049 423still compile everything first. If you are installing @theglibc{} as your
920e11e9
UD
424primary C library, we recommend that you shut the system down to
425single-user mode first, and reboot afterward. This minimizes the risk
426of breaking things when the library changes out from underneath.
1792d4db 427
02c4bbad 428@samp{make install} will do the entire job of upgrading from a
1f77f049
JM
429previous installation of @theglibc{} version 2.x. There may sometimes
430be headers
02c4bbad
JM
431left behind from the previous installation, but those are generally
432harmless. If you want to avoid leaving headers behind you can do
433things in the following order.
c559a3ca
UD
434
435You must first build the library (@samp{make}), optionally check it
436(@samp{make check}), switch the include directories and then install
437(@samp{make install}). The steps must be done in this order. Not moving
438the directory before install will result in an unusable mixture of header
439files from both libraries, but configuring, building, and checking the
440library requires the ability to compile and run programs against the old
02c4bbad
JM
441library. The new @file{/usr/include}, after switching the include
442directories and before installing the library should contain the Linux
443headers, but nothing else. If you do this, you will need to restore
1f77f049 444any headers from libraries other than @theglibc{} yourself after installing the
62075f0f 445library.
c559a3ca 446
a82a3db9
MS
447You can install @theglibc{} somewhere other than where you configured
448it to go by setting the @code{DESTDIR} GNU standard make variable on
449the command line for @samp{make install}. The value of this variable
450is prepended to all the paths for installation. This is useful when
451setting up a chroot environment or preparing a binary distribution.
452The directory should be specified with an absolute file name. Installing
453with the @code{prefix} and @code{exec_prefix} GNU standard make variables
454set is not supported.
1792d4db 455
1f77f049 456@Theglibc{} includes a daemon called @code{nscd}, which you
1792d4db
UD
457may or may not want to run. @code{nscd} caches name service lookups; it
458can dramatically improve performance with NIS+, and may help with DNS as
a0edd63e 459well.
1792d4db
UD
460
461One auxiliary program, @file{/usr/libexec/pt_chown}, is installed setuid
cdfc721b
AM
462@code{root} if the @samp{--enable-pt_chown} configuration option is used.
463This program is invoked by the @code{grantpt} function; it sets the
464permissions on a pseudoterminal so it can be used by the calling process.
465If you are using a Linux kernel with the @code{devpts} filesystem enabled
466and mounted at @file{/dev/pts}, you don't need this program.
3c20b9b6 467
d01d6319 468After installation you might want to configure the timezone and locale
1f77f049 469installation of your system. @Theglibc{} comes with a locale
d01d6319
UD
470database which gets configured with @code{localedef}. For example, to
471set up a German locale with name @code{de_DE}, simply issue the command
8fc1e2ca 472@samp{localedef -i de_DE -f ISO-8859-1 de_DE}. To configure all locales
1f77f049 473that are supported by @theglibc{}, you can issue from your build directory the
d01d6319
UD
474command @samp{make localedata/install-locales}.
475
a4d62195
UD
476To configure the locally used timezone, set the @code{TZ} environment
477variable. The script @code{tzselect} helps you to select the right value.
478As an example, for Germany, @code{tzselect} would tell you to use
479@samp{TZ='Europe/Berlin'}. For a system wide installation (the given
480paths are for an installation with @samp{--prefix=/usr}), link the
d01d6319
UD
481timezone file which is in @file{/usr/share/zoneinfo} to the file
482@file{/etc/localtime}. For Germany, you might execute @samp{ln -s
483/usr/share/zoneinfo/Europe/Berlin /etc/localtime}.
484
00c1176b
UD
485@node Tools for Compilation
486@appendixsec Recommended Tools for Compilation
3c20b9b6
UD
487@cindex installation tools
488@cindex tools, for installing library
489
490We recommend installing the following GNU tools before attempting to
1f77f049 491build @theglibc{}:
3c20b9b6
UD
492
493@itemize @bullet
494@item
f2873d2d 495GNU @code{make} 4.0 or newer
3c20b9b6 496
f650932b
CD
497As of relase time, GNU @code{make} 4.2.1 is the newest verified to work
498to build @theglibc{}.
499
3c20b9b6 500@item
4add8674 501GCC 4.9 or newer
0e7727f7 502
4add8674 503GCC 4.9 or higher is required. In general it is recommended to use
4863355a
JM
504the newest version of the compiler that is known to work for building
505@theglibc{}, as newer compilers usually produce better code. As of
f650932b 506release time, GCC 8.1.1 is the newest compiler verified to work to build
4863355a 507@theglibc{}.
91ea72b7 508
4efe3ce4
GG
509For PowerPC 64-bits little-endian (powerpc64le), GCC 6.2 or higher is
510required. This compiler version is the first to provide the features
511required for building @theglibc{} with support for @code{_Float128}.
512
022dfdce
SL
513For multi-arch support it is recommended to use a GCC which has been built with
514support for GNU indirect functions. This ensures that correct debugging
515information is generated for functions selected by IFUNC resolvers. This
516support can either be enabled by configuring GCC with
517@samp{--enable-gnu-indirect-function}, or by enabling it by default by setting
518@samp{default_gnu_indirect_function} variable for a particular architecture in
519the GCC source file @file{gcc/config.gcc}.
520
1f77f049
JM
521You can use whatever compiler you like to compile programs that use
522@theglibc{}.
3c20b9b6 523
90d1d40b 524Check the FAQ for any special compiler issues on particular platforms.
5713a71e 525
3c20b9b6 526@item
073e8fa7 527GNU @code{binutils} 2.25 or later
00c1176b 528
1f77f049 529You must use GNU @code{binutils} (as and ld) to build @theglibc{}.
0c02c85f 530No other assembler or linker has the necessary functionality at the
f650932b 531moment. As of release time, GNU @code{binutils} 2.31.1 is the newest
04cb913d 532verified to work to build @theglibc{}.
3c20b9b6
UD
533
534@item
3a12c70f 535GNU @code{texinfo} 4.7 or later
3c20b9b6
UD
536
537To correctly translate and install the Texinfo documentation you need
538this version of the @code{texinfo} package. Earlier versions do not
539understand all the tags used in the document, and the installation
1792d4db 540mechanism for the info files is not present or works differently.
93493119 541As of release time, @code{texinfo} 6.5 is the newest verified to work
04cb913d 542to build @theglibc{}.
3c20b9b6
UD
543
544@item
12086fb4 545GNU @code{awk} 3.1.2, or higher
00c1176b 546
12086fb4
RM
547@code{awk} is used in several places to generate files.
548Some @code{gawk} extensions are used, including the @code{asorti}
549function, which was introduced in version 3.1.2 of @code{gawk}.
f650932b 550As of release time, @code{gawk} version 4.2.1 is the newest verified
2c8f75f7 551to work to build @theglibc{}.
00c1176b 552
1faaf703
JB
553@item
554GNU @code{bison} 2.7 or later
555
556@code{bison} is used to generate the @code{yacc} parser code in the @file{intl}
93493119
DL
557subdirectory. As of release time, @code{bison} version 3.0.4 is the newest
558verified to work to build @theglibc{}.
1faaf703 559
00c1176b
UD
560@item
561Perl 5
562
563Perl is not required, but it is used if present to test the
f650932b
CD
564installation. We may decide to use it elsewhere in the future. As of release
565time @code{perl} version 5.28.0 is the newest verified to work to build
566@theglibc{}.
3c20b9b6 567
d66732e0
UD
568@item
569GNU @code{sed} 3.02 or newer
570
a4d62195 571@code{Sed} is used in several places to generate files. Most scripts work
2c8f75f7 572with any version of @code{sed}. As of release time, @code{sed} version
f650932b 5734.5 is the newest verified to work to build @theglibc{}.
d66732e0 574
3c20b9b6
UD
575@end itemize
576
577@noindent
cb8a6dbd 578If you change any of the @file{configure.ac} files you will also need
3c20b9b6
UD
579
580@itemize @bullet
581@item
f3f5d895 582GNU @code{autoconf} 2.69 (exactly)
3c20b9b6
UD
583@end itemize
584
585@noindent
586and if you change any of the message translation files you will need
587
588@itemize @bullet
589@item
c26b4f64 590GNU @code{gettext} 0.10.36 or later
f650932b
CD
591
592As of release time, GNU @code{gettext} version 0.19.8.1 is the newest
593version verified to work to build @theglibc{}.
3c20b9b6
UD
594@end itemize
595
cc8623f1 596
3c20b9b6
UD
597@noindent
598You may also need these packages if you upgrade your source tree using
599patches, although we try to avoid this.
600
1792d4db 601@node Linux
a7a93d50 602@appendixsec Specific advice for @gnulinuxsystems{}
1792d4db
UD
603@cindex kernel header files
604
a7a93d50 605If you are installing @theglibc{} on @gnulinuxsystems{}, you need to have
5b4ecd3f 606the header files from a 3.2 or newer kernel around for reference.
e9203023
FW
607(For the ia64 architecture, you need version 3.2.18 or newer because this
608is the first version with support for the @code{accept4} system call.)
abd923db
JM
609These headers must be installed using @samp{make headers_install}; the
610headers present in the kernel source directory are not suitable for
1f77f049
JM
611direct use by @theglibc{}. You do not need to use that kernel, just have
612its headers installed where @theglibc{} can access them, referred to here as
abd923db
JM
613@var{install-directory}. The easiest way to do this is to unpack it
614in a directory such as @file{/usr/src/linux-@var{version}}. In that
615directory, run @samp{make headers_install
1f77f049 616INSTALL_HDR_PATH=@var{install-directory}}. Finally, configure @theglibc{}
abd923db
JM
617with the option @samp{--with-headers=@var{install-directory}/include}.
618Use the most recent kernel you can get your hands on. (If you are
1f77f049 619cross-compiling @theglibc{}, you need to specify
abd923db
JM
620@samp{ARCH=@var{architecture}} in the @samp{make headers_install}
621command, where @var{architecture} is the architecture name used by the
622Linux kernel, such as @samp{x86} or @samp{powerpc}.)
a8d87c92 623
1f77f049 624After installing @theglibc{}, you may need to remove or rename
abd923db
JM
625directories such as @file{/usr/include/linux} and
626@file{/usr/include/asm}, and replace them with copies of directories
627such as @file{linux} and @file{asm} from
628@file{@var{install-directory}/include}. All directories present in
629@file{@var{install-directory}/include} should be copied, except that
1f77f049 630@theglibc{} provides its own version of @file{/usr/include/scsi}; the
abd923db 631files provided by the kernel should be copied without replacing those
1f77f049 632provided by @theglibc{}. The @file{linux}, @file{asm} and
abd923db 633@file{asm-generic} directories are required to compile programs using
1f77f049 634@theglibc{}; the other directories describe interfaces to the kernel but
abd923db
JM
635are not required if not compiling programs using those interfaces.
636You do not need to copy kernel headers if you did not specify an
637alternate kernel header source using @samp{--with-headers}.
1792d4db 638
a7a93d50
JM
639The Filesystem Hierarchy Standard for @gnulinuxsystems{} expects some
640components of the @glibcadj{} installation to be in
1792d4db 641@file{/lib} and some in @file{/usr/lib}. This is handled automatically
1f77f049 642if you configure @theglibc{} with @samp{--prefix=/usr}. If you set some other
1792d4db
UD
643prefix or allow it to default to @file{/usr/local}, then all the
644components are installed there.
645
3c20b9b6
UD
646@node Reporting Bugs
647@appendixsec Reporting Bugs
648@cindex reporting bugs
649@cindex bugs, reporting
650
1f77f049 651There are probably bugs in @theglibc{}. There are certainly
3c20b9b6
UD
652errors and omissions in this manual. If you report them, they will get
653fixed. If you don't, no one will ever know about them and they will
654remain unfixed for all eternity, if not longer.
655
04b9968b
UD
656It is a good idea to verify that the problem has not already been
657reported. Bugs are documented in two places: The file @file{BUGS}
8b748aed
JM
658describes a number of well known bugs and the central @glibcadj{}
659bug tracking system has a
612fdf25 660WWW interface at
a306c790 661@url{https://sourceware.org/bugzilla/}. The WWW
a4d62195
UD
662interface gives you access to open and closed reports. A closed report
663normally includes a patch or a hint on solving the problem.
612fdf25 664
a4d62195 665To report a bug, first you must find it. With any luck, this will be the
3c20b9b6 666hard part. Once you've found a bug, make sure it's really a bug. A
1f77f049 667good way to do this is to see if @theglibc{} behaves the same way
3c20b9b6
UD
668some other C library does. If so, probably you are wrong and the
669libraries are right (but not necessarily). If not, one of the libraries
1f77f049 670is probably wrong. It might not be @theglibc{}. Many historical
1792d4db
UD
671Unix C libraries permit things that we don't, such as closing a file
672twice.
673
1f77f049 674If you think you have found some way in which @theglibc{} does not
1792d4db
UD
675conform to the ISO and POSIX standards (@pxref{Standards and
676Portability}), that is definitely a bug. Report it!
3c20b9b6
UD
677
678Once you're sure you've found a bug, try to narrow it down to the
679smallest test case that reproduces the problem. In the case of a C
680library, you really only need to narrow it down to one library
681function call, if possible. This should not be too difficult.
682
683The final step when you have a simple test case is to report the bug.
8b748aed 684Do this at @value{REPORT_BUGS_TO}.
3c20b9b6
UD
685
686If you are not sure how a function should behave, and this manual
687doesn't tell you, that's a bug in the manual. Report that too! If the
688function's behavior disagrees with the manual, then either the library
689or the manual has a bug, so report the disagreement. If you find any
d40eb37a
UD
690errors or omissions in this manual, please report them to the
691bug database. If you refer to specific
04b9968b
UD
692sections of the manual, please include the section names for easier
693identification.