]>
Commit | Line | Data |
---|---|---|
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 | 11 | Before you do anything else, you should read the FAQ at |
a306c790 | 12 | @url{https://sourceware.org/glibc/wiki/FAQ}. It answers common |
7ac30cc5 AJ |
13 | questions and describes problems you may experience with compilation |
14 | and installation. | |
3c20b9b6 | 15 | |
00c1176b | 16 | You will need recent versions of several GNU tools: definitely GCC and |
fe959e1e | 17 | GNU 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 | 36 | it in a separate build directory. For example, if you have unpacked |
1f77f049 JM |
37 | the @glibcadj{} sources in @file{/src/gnu/glibc-@var{version}}, |
38 | create a directory | |
e8b1163e | 39 | @file{/src/gnu/glibc-build} to put the object files in. This allows |
3858bf28 RM |
40 | removing the whole build directory in case an error occurs, which is |
41 | the safest way to get a fresh start and should always be done. | |
00c1176b | 42 | |
a4d62195 | 43 | From your object directory, run the shell script @file{configure} located |
00c1176b UD |
44 | at 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 | 50 | Please note that even though you're building in a separate build |
e6bdb741 AJ |
51 | directory, the compilation may need to create or modify files and |
52 | directories in the source directory. | |
f76d7052 | 53 | |
00c1176b | 54 | @noindent |
3858bf28 RM |
55 | @code{configure} takes many options, but the only one that is usually |
56 | mandatory is @samp{--prefix}. This option tells @code{configure} | |
1f77f049 | 57 | where you want @theglibc{} installed. This defaults to @file{/usr/local}, |
3858bf28 | 58 | but the normal setting to install as the standard system library is |
a7a93d50 JM |
59 | @samp{--prefix=/usr} for @gnulinuxsystems{} and @samp{--prefix=} (an |
60 | empty prefix) for @gnuhurdsystems{}. | |
00c1176b | 61 | |
db9881ec JM |
62 | It may also be useful to pass @samp{CC=@var{compiler}} and |
63 | @code{CFLAGS=@var{flags}} arguments to @code{configure}. @code{CC} | |
64 | selects the C compiler that will be used, and @code{CFLAGS} sets | |
65 | optimization options for the compiler. Any compiler options required | |
66 | for all compilations, such as options selecting an ABI or a processor | |
67 | for which to generate code, should be included in @code{CC}. Options | |
68 | that may be overridden by the @glibcadj{} build system for particular | |
69 | files, such as for optimization and debugging, should go in | |
70 | @code{CFLAGS}. The default value of @code{CFLAGS} is @samp{-g -O2}, | |
71 | and @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 |
78 | The 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} |
83 | Install 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} | |
87 | Install the library and other machine-dependent files in subdirectories | |
88 | of @file{@var{directory}}. The default is to the @samp{--prefix} | |
04b9968b | 89 | directory if that option is specified, or @file{/usr/local} otherwise. |
00c1176b UD |
90 | |
91 | @item --with-headers=@var{directory} | |
92 | Look for kernel header files in @var{directory}, not | |
1f77f049 JM |
93 | @file{/usr/include}. @Theglibc{} needs information from the kernel's header |
94 | files describing the interface to the kernel. @Theglibc{} will normally | |
abd923db | 95 | look in @file{/usr/include} for them, |
04b9968b | 96 | but if you specify this option, it will look in @var{DIRECTORY} instead. |
00c1176b UD |
97 | |
98 | This 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 | 100 | occasionally happen in this case. You can also use this option if you want to |
1f77f049 | 101 | compile @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 | 105 | This option is currently only useful on @gnulinuxsystems{}. The |
d2830ba4 UD |
106 | @var{version} parameter should have the form X.Y.Z and describes the |
107 | smallest version of the Linux kernel the generated library is expected | |
108 | to support. The higher the @var{version} number is, the less | |
109 | compatibility code is added, and the faster the code gets. | |
110 | ||
3c20b9b6 UD |
111 | @item --with-binutils=@var{directory} |
112 | Use the binutils (assembler and linker) in @file{@var{directory}}, not | |
a4d62195 | 113 | the ones the C compiler would default to. You can use this option if |
3c20b9b6 | 114 | the default binutils on your system cannot deal with all the constructs |
1f77f049 | 115 | in @theglibc{}. In that case, @code{configure} will detect the |
a4d62195 UD |
116 | problem and suppress these constructs, so that the library will still be |
117 | usable, but functionality may be lost---for example, you can't build a | |
118 | shared libc with old binutils. | |
3c20b9b6 | 119 | |
6413fcde FW |
120 | @item --with-nonshared-cflags=@var{cflags} |
121 | Use additional compiler flags @var{cflags} to build the parts of the | |
122 | library which are always statically linked into applications and | |
123 | libraries even with shared linking (that is, the object files contained | |
124 | in @file{lib*_nonshared.a} libraries). The build process will | |
125 | automatically use the appropriate flags, but this option can be used to | |
126 | set additional flags required for building applications and libraries, | |
127 | to match local policy. For example, if such a policy requires that all | |
128 | code linked into applications must be built with source fortification, | |
129 | @samp{--with-nonshared-cflags=-Wp,-D_FORTIFY_SOURCE=2} will make sure | |
130 | that the objects in @file{libc_nonshared.a} are compiled with this flag | |
131 | (although this will not affect the generated code in this particular | |
132 | case and potentially change debugging information and metadata only). | |
133 | ||
9ba202c7 FW |
134 | @item --with-rtld-early-cflags=@var{cflags} |
135 | Use additional compiler flags @var{cflags} to build the early startup | |
136 | code of the dynamic linker. These flags can be used to enable early | |
137 | dynamic linker diagnostics to run on CPUs which are not compatible with | |
138 | the rest of @theglibc{}, for example, due to compiler flags which target | |
139 | a later instruction set architecture (ISA). | |
140 | ||
bada2e31 L |
141 | @item --with-timeoutfactor=@var{NUM} |
142 | Specify an integer @var{NUM} to scale the timeout of test programs. | |
143 | This factor can be changed at run time using @env{TIMEOUTFACTOR} | |
144 | environment variable. | |
145 | ||
b5ca0fb0 UD |
146 | @c disable static doesn't work currently |
147 | @c @item --disable-static | |
fb06851d | 148 | @c Don't build static libraries. Static libraries aren't that useful these |
b5ca0fb0 | 149 | @c days, but we recommend you build them in case you need them. |
3c20b9b6 | 150 | |
00c1176b | 151 | @item --disable-shared |
a4d62195 UD |
152 | Don't build shared libraries even if it is possible. Not all systems |
153 | support shared libraries; you need ELF support and (currently) the GNU | |
154 | linker. | |
3c20b9b6 | 155 | |
23645707 SP |
156 | @item --disable-default-pie |
157 | Don't build glibc programs and the testsuite as position independent | |
158 | executables (PIE). By default, glibc programs and tests are created as | |
159 | position independent executables on targets that support it. If the toolchain | |
160 | and architecture support it, static executables are built as static PIE and the | |
161 | resulting glibc can be used with the GCC option, -static-pie, which is | |
162 | available with GCC 8 or above, to create static PIE. | |
9d7a3741 | 163 | |
e6c69509 | 164 | @item --enable-cet |
9e38f455 | 165 | @itemx --enable-cet=permissive |
e6c69509 | 166 | Enable Intel Control-flow Enforcement Technology (CET) support. When |
9e38f455 L |
167 | @theglibc{} is built with @option{--enable-cet} or |
168 | @option{--enable-cet=permissive}, the resulting library | |
e6c69509 L |
169 | is protected with indirect branch tracking (IBT) and shadow stack |
170 | (SHSTK)@. When CET is enabled, @theglibc{} is compatible with all | |
171 | existing executables and shared libraries. This feature is currently | |
bbfb5493 L |
172 | supported on x86_64 and x32 with GCC 8 and binutils 2.29 or later. |
173 | With @option{--enable-cet}, it is an error to dlopen a non CET | |
9e38f455 L |
174 | enabled shared library in CET enabled application. With |
175 | @option{--enable-cet=permissive}, CET is disabled when dlopening a | |
176 | non CET enabled shared library in CET enabled application. | |
e6c69509 | 177 | |
a0cfc48e | 178 | NOTE: @option{--enable-cet} is only supported on x86_64 and x32. |
e84bd851 | 179 | |
33784089 RE |
180 | @item --enable-memory-tagging |
181 | Enable memory tagging support if the architecture supports it. When | |
182 | @theglibc{} is built with this option then the resulting library will | |
183 | be able to control the use of tagged memory when hardware support is | |
184 | present by use of the tunable @samp{glibc.mem.tagging}. This includes | |
185 | the generation of tagged memory when using the @code{malloc} APIs. | |
186 | ||
187 | At present only AArch64 platforms with MTE provide this functionality, | |
188 | although the library will still operate (without memory tagging) on | |
189 | older versions of the architecture. | |
190 | ||
191 | The default is to disable support for memory tagging. | |
192 | ||
00c1176b UD |
193 | @item --disable-profile |
194 | Don't build libraries with profiling information. You may want to use | |
195 | this option if you don't plan to do profiling. | |
f12944ec | 196 | |
00c1176b UD |
197 | @item --enable-static-nss |
198 | Compile static versions of the NSS (Name Service Switch) libraries. | |
199 | This is not recommended because it defeats the purpose of NSS; a program | |
200 | linked statically with the NSS libraries cannot be dynamically | |
201 | reconfigured to use a different name database. | |
202 | ||
740b3dbe L |
203 | @item --enable-hardcoded-path-in-tests |
204 | By default, dynamic tests are linked to run with the installed C library. | |
205 | This option hardcodes the newly built C library path in dynamic tests | |
206 | so that they can be invoked directly. | |
207 | ||
1cba4036 | 208 | @item --disable-timezone-tools |
ee768a30 | 209 | By default, time zone related utilities (@command{zic}, @command{zdump}, |
44f826e3 | 210 | and @command{tzselect}) are installed with @theglibc{}. If you are building |
1cba4036 | 211 | these independently (e.g. by using the @samp{tzcode} package), then this |
44f826e3 | 212 | option will allow disabling the install of these. |
1cba4036 MF |
213 | |
214 | Note that you need to make sure the external tools are kept in sync with | |
215 | the versions that @theglibc{} expects as the data formats may change over | |
216 | time. Consult the @file{timezone} subdirectory for more details. | |
217 | ||
03baef1c NA |
218 | @item --enable-stack-protector |
219 | @itemx --enable-stack-protector=strong | |
220 | @itemx --enable-stack-protector=all | |
221 | Compile the C library and all other parts of the glibc package | |
222 | (including the threading and math libraries, NSS modules, and | |
223 | transliteration modules) using the GCC @option{-fstack-protector}, | |
224 | @option{-fstack-protector-strong} or @option{-fstack-protector-all} | |
225 | options to detect stack overruns. Only the dynamic linker and a small | |
226 | number of routines called directly from assembler are excluded from this | |
227 | protection. | |
228 | ||
2d6ab5df | 229 | @item --enable-bind-now |
94a4e9e4 FW |
230 | Disable lazy binding for installed shared objects and programs. This |
231 | provides additional security hardening because it enables full RELRO | |
232 | and a read-only global offset table (GOT), at the cost of slightly | |
233 | increased program load times. | |
2d6ab5df | 234 | |
e4608715 CD |
235 | @pindex pt_chown |
236 | @findex grantpt | |
237 | @item --enable-pt_chown | |
238 | The file @file{pt_chown} is a helper binary for @code{grantpt} | |
239 | (@pxref{Allocation, Pseudo-Terminals}) that is installed setuid root to | |
27fe5f2e FW |
240 | fix up pseudo-terminal ownership on GNU/Hurd. It is not required on |
241 | GNU/Linux, and @theglibc{} will not use the installed @file{pt_chown} | |
242 | program when configured with @option{--enable-pt_chown}. | |
e4608715 | 243 | |
a4ecc9eb JM |
244 | @item --disable-werror |
245 | By default, @theglibc{} is built with @option{-Werror}. If you wish | |
246 | to build without this option (for example, if building with a newer | |
247 | version of GCC than this version of @theglibc{} was tested with, so | |
248 | new warnings cause the build with @option{-Werror} to fail), you can | |
249 | configure with @option{--disable-werror}. | |
250 | ||
21933112 | 251 | @item --disable-mathvec |
b55a155f RJ |
252 | By default for x86_64, @theglibc{} is built with the vector math library. |
253 | Use this option to disable the vector math library. | |
21933112 | 254 | |
ba144c17 L |
255 | @item --disable-static-c++-tests |
256 | By default, if the C++ toolchain lacks support for static linking, | |
257 | configure fails to find the C++ header files and the glibc build fails. | |
258 | @option{--disable-static-c++-link-check} allows the glibc build to finish, | |
259 | but static C++ tests will fail if the C++ toolchain doesn't have the | |
260 | necessary static C++ libraries. Use this option to skip the static C++ | |
261 | tests. This option implies @option{--disable-static-c++-link-check}. | |
262 | ||
23f12e6e L |
263 | @item --disable-static-c++-link-check |
264 | By default, if the C++ toolchain lacks support for static linking, | |
265 | configure fails to find the C++ header files and the glibc build fails. | |
266 | Use this option to disable the static C++ link check so that the C++ | |
267 | header files can be located. The newly built libc.a can be used to | |
268 | create static C++ tests if the C++ toolchain has the necessary static | |
269 | C++ libraries. | |
270 | ||
ebae2f5a MC |
271 | @item --disable-scv |
272 | Disable using @code{scv} instruction for syscalls. All syscalls will use | |
273 | @code{sc} instead, even if the kernel supports @code{scv}. PowerPC only. | |
274 | ||
00c1176b UD |
275 | @item --build=@var{build-system} |
276 | @itemx --host=@var{host-system} | |
04b9968b | 277 | These options are for cross-compiling. If you specify both options and |
00c1176b | 278 | @var{build-system} is different from @var{host-system}, @code{configure} |
1f77f049 | 279 | will prepare to cross-compile @theglibc{} from @var{build-system} to be used |
00c1176b UD |
280 | on @var{host-system}. You'll probably need the @samp{--with-headers} |
281 | option too, and you may have to override @var{configure}'s selection of | |
282 | the compiler and/or binutils. | |
283 | ||
a4d62195 UD |
284 | If you only specify @samp{--host}, @code{configure} will prepare for a |
285 | native compile but use what you specify instead of guessing what your | |
cf822e3c | 286 | system is. This is most useful to change the CPU submodel. For example, |
e98cdb38 CD |
287 | if @code{configure} guesses your machine as @code{i686-pc-linux-gnu} but |
288 | you want to compile a library for 586es, give | |
289 | @samp{--host=i586-pc-linux-gnu} or just @samp{--host=i586-linux} and add | |
290 | the appropriate compiler flags (@samp{-mcpu=i586} will do the trick) to | |
db9881ec | 291 | @code{CC}. |
1792d4db | 292 | |
a4d62195 | 293 | If you specify just @samp{--build}, @code{configure} will get confused. |
8b748aed JM |
294 | |
295 | @item --with-pkgversion=@var{version} | |
296 | Specify a description, possibly including a build number or build | |
297 | date, of the binaries being built, to be included in | |
298 | @option{--version} output from programs installed with @theglibc{}. | |
299 | For example, @option{--with-pkgversion='FooBar GNU/Linux glibc build | |
300 | 123'}. The default value is @samp{GNU libc}. | |
301 | ||
302 | @item --with-bugurl=@var{url} | |
303 | Specify the URL that users should visit if they wish to report a bug, | |
304 | to be included in @option{--help} output from programs installed with | |
305 | @theglibc{}. The default value refers to the main bug-reporting | |
306 | information for @theglibc{}. | |
64d9580c FB |
307 | |
308 | @item --enable-fortify-source | |
309 | @itemx --enable-fortify-source=@var{LEVEL} | |
310 | Use -D_FORTIFY_SOURCE=@option{LEVEL} to control hardening in the GNU C Library. | |
311 | If not provided, @option{LEVEL} defaults to highest possible value supported by | |
312 | the build compiler. | |
313 | ||
314 | Default is to disable fortification. | |
3c20b9b6 UD |
315 | @end table |
316 | ||
00c1176b UD |
317 | To build the library and related programs, type @code{make}. This will |
318 | produce a lot of output, some of which may look like errors from | |
b55a155f | 319 | @code{make} but aren't. Look for error messages from @code{make} |
a4d62195 | 320 | containing @samp{***}. Those indicate that something is seriously wrong. |
00c1176b | 321 | |
3858bf28 RM |
322 | The compilation process can take a long time, depending on the |
323 | configuration and the speed of your machine. Some complex modules may | |
324 | take a very long time to compile, as much as several minutes on slower | |
325 | machines. Do not panic if the compiler appears to hang. | |
3c20b9b6 | 326 | |
8eadd4f3 UD |
327 | If you want to run a parallel make, simply pass the @samp{-j} option |
328 | with an appropriate numeric parameter to @code{make}. You need a recent | |
329 | GNU @code{make} version, though. | |
f12944ec | 330 | |
04b9968b UD |
331 | To build and run test programs which exercise some of the library |
332 | facilities, type @code{make check}. If it does not complete | |
333 | successfully, do not use the built library, and report a bug after | |
334 | verifying that the problem is not already known. @xref{Reporting Bugs}, | |
335 | for instructions on reporting bugs. Note that some of the tests assume | |
336 | they are not being run by @code{root}. We recommend you compile and | |
1f77f049 | 337 | test @theglibc{} as an unprivileged user. |
3c20b9b6 | 338 | |
8eadd4f3 | 339 | Before reporting bugs make sure there is no problem with your system. |
a4d62195 | 340 | The tests (and later installation) use some pre-existing files of the |
8eadd4f3 UD |
341 | system such as @file{/etc/passwd}, @file{/etc/nsswitch.conf} and others. |
342 | These files must all contain correct and sensible content. | |
343 | ||
d6fe5e58 JM |
344 | Normally, @code{make check} will run all the tests before reporting |
345 | all problems found and exiting with error status if any problems | |
346 | occurred. You can specify @samp{stop-on-test-failure=y} when running | |
347 | @code{make check} to make the test run stop and exit with an error | |
348 | status immediately when a failure occurs. | |
349 | ||
3c20b9b6 | 350 | To format the @cite{GNU C Library Reference Manual} for printing, type |
6a4888ff AJ |
351 | @w{@code{make dvi}}. You need a working @TeX{} installation to do |
352 | this. The distribution builds the on-line formatted version of the | |
353 | manual, as Info files, as part of the build process. You can build | |
354 | them manually with @w{@code{make info}}. | |
1792d4db | 355 | |
2e8048e5 UD |
356 | The library has a number of special-purpose configuration parameters |
357 | which you can find in @file{Makeconfig}. These can be overwritten with | |
358 | the file @file{configparms}. To change them, create a | |
359 | @file{configparms} in your build directory and add values as appropriate | |
360 | for your system. The file is included and parsed by @code{make} and has | |
361 | to follow the conventions for makefiles. | |
362 | ||
1f77f049 | 363 | It is easy to configure @theglibc{} for cross-compilation by |
2e8048e5 UD |
364 | setting a few variables in @file{configparms}. Set @code{CC} to the |
365 | cross-compiler for the target you configured the library for; it is | |
366 | important to use this same @code{CC} value when running | |
db9881ec JM |
367 | @code{configure}, like this: @samp{configure @var{target} |
368 | CC=@var{target}-gcc}. Set @code{BUILD_CC} to the compiler to use for programs | |
a4d62195 | 369 | run on the build system as part of compiling the library. You may need to |
e9433893 UD |
370 | set @code{AR} to cross-compiling versions of @code{ar} |
371 | if the native tools are not configured to work with | |
df381762 JM |
372 | object files for the target you configured for. When cross-compiling |
373 | @theglibc{}, it may be tested using @samp{make check | |
374 | test-wrapper="@var{srcdir}/scripts/cross-test-ssh.sh @var{hostname}"}, | |
375 | where @var{srcdir} is the absolute directory name for the main source | |
376 | directory and @var{hostname} is the host name of a system that can run | |
377 | the newly built binaries of @theglibc{}. The source and build | |
378 | directories must be visible at the same locations on both the build | |
379 | system and @var{hostname}. | |
496e36f2 LM |
380 | The @samp{cross-test-ssh.sh} script requires @samp{flock} from |
381 | @samp{util-linux} to work when @var{glibc_test_allow_time_setting} | |
382 | environment variable is set. | |
383 | ||
384 | It is also possible to execute tests, which require setting the date on | |
385 | the target machine. Following use cases are supported: | |
386 | @itemize @bullet | |
387 | @item | |
388 | @code{GLIBC_TEST_ALLOW_TIME_SETTING} is set in the environment in | |
389 | which eligible tests are executed and have the privilege to run | |
390 | @code{clock_settime}. In this case, nothing prevents those tests from | |
391 | running in parallel, so the caller shall assure that those tests | |
392 | are serialized or provide a proper wrapper script for them. | |
393 | ||
394 | @item | |
395 | The @code{cross-test-ssh.sh} script is used and one passes the | |
396 | @option{--allow-time-setting} flag. In this case, both sets | |
397 | @code{GLIBC_TEST_ALLOW_TIME_SETTING} and serialization of test | |
398 | execution are assured automatically. | |
399 | @end itemize | |
2e8048e5 | 400 | |
0eb69512 JM |
401 | In general, when testing @theglibc{}, @samp{test-wrapper} may be set |
402 | to the name and arguments of any program to run newly built binaries. | |
403 | This program must preserve the arguments to the binary being run, its | |
8540f6d2 | 404 | working directory and the standard input, output and error file |
4acc27ed RM |
405 | descriptors. If @samp{@var{test-wrapper} env} will not work to run a |
406 | program with environment variables set, then @samp{test-wrapper-env} | |
407 | must be set to a program that runs a newly built program with | |
408 | environment variable assignments in effect, those assignments being | |
409 | specified as @samp{@var{var}=@var{value}} before the name of the | |
410 | program to be run. If multiple assignments to the same variable are | |
411 | specified, the last assignment specified must take precedence. | |
412 | Similarly, if @samp{@var{test-wrapper} env -i} will not work to run a | |
413 | program with an environment completely empty of variables except those | |
414 | directly assigned, then @samp{test-wrapper-env-only} must be set; its | |
415 | use has the same syntax as @samp{test-wrapper-env}, the only | |
416 | difference in its semantics being starting with an empty set of | |
417 | environment variables rather than the ambient set. | |
0eb69512 | 418 | |
38560563 NT |
419 | For AArch64 with SVE, when testing @theglibc{}, @samp{test-wrapper} |
420 | may be set to "@var{srcdir}/sysdeps/unix/sysv/linux/aarch64/vltest.py | |
421 | @var{vector-length}" to change Vector Length. | |
2e8048e5 | 422 | |
085320f5 | 423 | @node Running make install |
1792d4db UD |
424 | @appendixsec Installing the C Library |
425 | @cindex installing | |
3c20b9b6 UD |
426 | |
427 | To install the library and its header files, and the Info files of the | |
686554bf | 428 | manual, type @code{make install}. This will |
a4d62195 | 429 | build things, if necessary, before installing them; however, you should |
1f77f049 | 430 | still compile everything first. If you are installing @theglibc{} as your |
920e11e9 UD |
431 | primary C library, we recommend that you shut the system down to |
432 | single-user mode first, and reboot afterward. This minimizes the risk | |
433 | of breaking things when the library changes out from underneath. | |
1792d4db | 434 | |
02c4bbad | 435 | @samp{make install} will do the entire job of upgrading from a |
1f77f049 JM |
436 | previous installation of @theglibc{} version 2.x. There may sometimes |
437 | be headers | |
02c4bbad JM |
438 | left behind from the previous installation, but those are generally |
439 | harmless. If you want to avoid leaving headers behind you can do | |
440 | things in the following order. | |
c559a3ca UD |
441 | |
442 | You must first build the library (@samp{make}), optionally check it | |
443 | (@samp{make check}), switch the include directories and then install | |
444 | (@samp{make install}). The steps must be done in this order. Not moving | |
445 | the directory before install will result in an unusable mixture of header | |
446 | files from both libraries, but configuring, building, and checking the | |
447 | library requires the ability to compile and run programs against the old | |
02c4bbad JM |
448 | library. The new @file{/usr/include}, after switching the include |
449 | directories and before installing the library should contain the Linux | |
450 | headers, but nothing else. If you do this, you will need to restore | |
1f77f049 | 451 | any headers from libraries other than @theglibc{} yourself after installing the |
62075f0f | 452 | library. |
c559a3ca | 453 | |
a82a3db9 MS |
454 | You can install @theglibc{} somewhere other than where you configured |
455 | it to go by setting the @code{DESTDIR} GNU standard make variable on | |
456 | the command line for @samp{make install}. The value of this variable | |
457 | is prepended to all the paths for installation. This is useful when | |
458 | setting up a chroot environment or preparing a binary distribution. | |
459 | The directory should be specified with an absolute file name. Installing | |
460 | with the @code{prefix} and @code{exec_prefix} GNU standard make variables | |
461 | set is not supported. | |
1792d4db | 462 | |
1f77f049 | 463 | @Theglibc{} includes a daemon called @code{nscd}, which you |
1792d4db UD |
464 | may or may not want to run. @code{nscd} caches name service lookups; it |
465 | can dramatically improve performance with NIS+, and may help with DNS as | |
a0edd63e | 466 | well. |
1792d4db UD |
467 | |
468 | One auxiliary program, @file{/usr/libexec/pt_chown}, is installed setuid | |
cdfc721b AM |
469 | @code{root} if the @samp{--enable-pt_chown} configuration option is used. |
470 | This program is invoked by the @code{grantpt} function; it sets the | |
471 | permissions on a pseudoterminal so it can be used by the calling process. | |
472 | If you are using a Linux kernel with the @code{devpts} filesystem enabled | |
473 | and mounted at @file{/dev/pts}, you don't need this program. | |
3c20b9b6 | 474 | |
ee768a30 PE |
475 | After installation you should configure the time zone ruleset and install |
476 | locales for your system. The time zone ruleset ensures that timestamps | |
477 | are processed correctly for your location. The locales ensure that | |
08a5ee14 CD |
478 | the display of information on your system matches the expectations of |
479 | your language and geographic region. | |
480 | ||
481 | @Theglibc{} is able to use two kinds of localization information sources, the | |
482 | first is a locale database named @file{locale-archive} which is generally | |
483 | installed as @file{/usr/lib/locale/locale-archive}. The locale archive has the | |
484 | benefit of taking up less space and being very fast to load, but only if you | |
485 | plan to install sixty or more locales. If you plan to install one or two | |
486 | locales you can instead install individual locales into their self-named | |
487 | directories e.g.@: @file{/usr/lib/locale/en_US.utf8}. For example to install | |
488 | the German locale using the character set for UTF-8 with name @code{de_DE} into | |
489 | the locale archive issue the command @samp{localedef -i de_DE -f UTF-8 de_DE}, | |
490 | and to install just the one locale issue the command @samp{localedef | |
491 | --no-archive -i de_DE -f UTF-8 de_DE}. To configure all locales that are | |
492 | supported by @theglibc{}, you can issue from your build directory the command | |
493 | @samp{make localedata/install-locales} to install all locales into the locale | |
494 | archive or @samp{make localedata/install-locale-files} to install all locales | |
495 | as files in the default configured locale installation directory (derived from | |
496 | @samp{--prefix} or @code{--localedir}). To install into an alternative system | |
497 | root use @samp{DESTDIR} e.g.@: @samp{make localedata/install-locale-files | |
498 | DESTDIR=/opt/glibc}, but note that this does not change the configured prefix. | |
d01d6319 | 499 | |
ee768a30 | 500 | To configure the time zone ruleset, set the @code{TZ} environment |
a4d62195 UD |
501 | variable. The script @code{tzselect} helps you to select the right value. |
502 | As an example, for Germany, @code{tzselect} would tell you to use | |
503 | @samp{TZ='Europe/Berlin'}. For a system wide installation (the given | |
504 | paths are for an installation with @samp{--prefix=/usr}), link the | |
ee768a30 | 505 | time zone file which is in @file{/usr/share/zoneinfo} to the file |
d01d6319 UD |
506 | @file{/etc/localtime}. For Germany, you might execute @samp{ln -s |
507 | /usr/share/zoneinfo/Europe/Berlin /etc/localtime}. | |
508 | ||
00c1176b UD |
509 | @node Tools for Compilation |
510 | @appendixsec Recommended Tools for Compilation | |
3c20b9b6 UD |
511 | @cindex installation tools |
512 | @cindex tools, for installing library | |
513 | ||
514 | We recommend installing the following GNU tools before attempting to | |
1f77f049 | 515 | build @theglibc{}: |
3c20b9b6 UD |
516 | |
517 | @itemize @bullet | |
518 | @item | |
f2873d2d | 519 | GNU @code{make} 4.0 or newer |
3c20b9b6 | 520 | |
068b04ea | 521 | As of release time, GNU @code{make} 4.4.1 is the newest verified to work |
f650932b CD |
522 | to build @theglibc{}. |
523 | ||
3c20b9b6 | 524 | @item |
4dcbbc3b | 525 | GCC 6.2 or newer |
0e7727f7 | 526 | |
4dcbbc3b | 527 | GCC 6.2 or higher is required. In general it is recommended to use |
4863355a JM |
528 | the newest version of the compiler that is known to work for building |
529 | @theglibc{}, as newer compilers usually produce better code. As of | |
14126ff0 | 530 | release time, GCC 13.2 is the newest compiler verified to work to build |
4863355a | 531 | @theglibc{}. |
91ea72b7 | 532 | |
50545f5a PM |
533 | For PowerPC 64-bits little-endian (powerpc64le), a GCC version with support |
534 | for @option{-mno-gnu-attribute}, @option{-mabi=ieeelongdouble}, and | |
5d1007a8 | 535 | @option{-mabi=ibmlongdouble} is required. Likewise, the compiler must also |
5c7ccc29 PM |
536 | support passing @option{-mlong-double-128} with the preceding options. As |
537 | of release, this implies GCC 7.4 and newer (excepting GCC 7.5.0, see GCC | |
538 | PR94200). These additional features are required for building the GNU C | |
539 | Library with support for IEEE long double. | |
540 | ||
541 | @c powerpc64le performs an autoconf test to verify the compiler compiles with | |
542 | @c commands like "$CC -c foo.c -mabi=ibmlongdouble -mlong-double-128". | |
50545f5a | 543 | |
758caf37 VG |
544 | For ARC architecture builds, GCC 8.3 or higher is needed. |
545 | ||
844b4d8b SL |
546 | For s390x architecture builds, GCC 7.1 or higher is needed (See gcc Bug 98269). |
547 | ||
cd94326a JR |
548 | For AArch64 architecture builds with mathvec enabled, GCC 10 or higher is needed |
549 | due to dependency on arm_sve.h. | |
550 | ||
022dfdce SL |
551 | For multi-arch support it is recommended to use a GCC which has been built with |
552 | support for GNU indirect functions. This ensures that correct debugging | |
553 | information is generated for functions selected by IFUNC resolvers. This | |
554 | support can either be enabled by configuring GCC with | |
555 | @samp{--enable-gnu-indirect-function}, or by enabling it by default by setting | |
556 | @samp{default_gnu_indirect_function} variable for a particular architecture in | |
557 | the GCC source file @file{gcc/config.gcc}. | |
558 | ||
1f77f049 JM |
559 | You can use whatever compiler you like to compile programs that use |
560 | @theglibc{}. | |
3c20b9b6 | 561 | |
90d1d40b | 562 | Check the FAQ for any special compiler issues on particular platforms. |
5713a71e | 563 | |
3c20b9b6 | 564 | @item |
073e8fa7 | 565 | GNU @code{binutils} 2.25 or later |
00c1176b | 566 | |
1f77f049 | 567 | You must use GNU @code{binutils} (as and ld) to build @theglibc{}. |
0c02c85f | 568 | No other assembler or linker has the necessary functionality at the |
068b04ea | 569 | moment. As of release time, GNU @code{binutils} 2.42 is the newest |
04cb913d | 570 | verified to work to build @theglibc{}. |
3c20b9b6 | 571 | |
3a0acbdc PM |
572 | For PowerPC 64-bits little-endian (powerpc64le), @command{objcopy} is required |
573 | to support @option{--update-section}. This option requires binutils 2.26 or | |
574 | newer. | |
575 | ||
758caf37 VG |
576 | ARC architecture needs @code{binutils} 2.32 or higher for TLS related fixes. |
577 | ||
3c20b9b6 | 578 | @item |
3a12c70f | 579 | GNU @code{texinfo} 4.7 or later |
3c20b9b6 UD |
580 | |
581 | To correctly translate and install the Texinfo documentation you need | |
582 | this version of the @code{texinfo} package. Earlier versions do not | |
583 | understand all the tags used in the document, and the installation | |
1792d4db | 584 | mechanism for the info files is not present or works differently. |
14126ff0 | 585 | As of release time, @code{texinfo} 7.0.3 is the newest verified to work |
04cb913d | 586 | to build @theglibc{}. |
3c20b9b6 UD |
587 | |
588 | @item | |
12086fb4 | 589 | GNU @code{awk} 3.1.2, or higher |
00c1176b | 590 | |
12086fb4 RM |
591 | @code{awk} is used in several places to generate files. |
592 | Some @code{gawk} extensions are used, including the @code{asorti} | |
593 | function, which was introduced in version 3.1.2 of @code{gawk}. | |
14126ff0 | 594 | As of release time, @code{gawk} version 5.2.2 is the newest verified |
2c8f75f7 | 595 | to work to build @theglibc{}. |
00c1176b | 596 | |
1faaf703 JB |
597 | @item |
598 | GNU @code{bison} 2.7 or later | |
599 | ||
600 | @code{bison} is used to generate the @code{yacc} parser code in the @file{intl} | |
6415fd2d | 601 | subdirectory. As of release time, @code{bison} version 3.8.2 is the newest |
93493119 | 602 | verified to work to build @theglibc{}. |
1faaf703 | 603 | |
00c1176b UD |
604 | @item |
605 | Perl 5 | |
606 | ||
3c1622eb | 607 | Perl is not required, but if present it is used in some tests and the |
053c52b1 | 608 | @code{mtrace} program, to build the @glibcadj{} manual. As of release |
068b04ea | 609 | time @code{perl} version 5.38.2 is the newest verified to work to |
053c52b1 | 610 | build @theglibc{}. |
3c20b9b6 | 611 | |
d66732e0 UD |
612 | @item |
613 | GNU @code{sed} 3.02 or newer | |
614 | ||
a4d62195 | 615 | @code{Sed} is used in several places to generate files. Most scripts work |
2c8f75f7 | 616 | with any version of @code{sed}. As of release time, @code{sed} version |
14126ff0 | 617 | 4.9 is the newest verified to work to build @theglibc{}. |
d66732e0 | 618 | |
3c1622eb | 619 | @item |
c6982f7e | 620 | Python 3.4 or later |
3c1622eb | 621 | |
c6982f7e | 622 | Python is required to build @theglibc{}. As of release time, Python |
51990242 | 623 | 3.11 is the newest verified to work for building and testing |
c6982f7e | 624 | @theglibc{}. |
3c1622eb JM |
625 | |
626 | @item PExpect 4.0 | |
627 | ||
628 | The pretty printer tests drive GDB through test programs and compare | |
629 | its output to the printers'. PExpect is used to capture the output of | |
630 | GDB, and should be compatible with the Python version in your system. | |
6415fd2d | 631 | As of release time PExpect 4.8.0 is the newest verified to work to test |
3c1622eb JM |
632 | the pretty printers. |
633 | ||
634 | @item | |
3d926546 FW |
635 | The Python @code{abnf} module. |
636 | ||
637 | This module is optional and used to verify some ABNF grammars in the | |
638 | manual. Version 2.2.0 has been confirmed to work as expected. A | |
639 | missing @code{abnf} module does not reduce the test coverage of the | |
640 | library itself. | |
641 | ||
642 | @item | |
3c1622eb JM |
643 | GDB 7.8 or later with support for Python 2.7/3.4 or later |
644 | ||
645 | GDB itself needs to be configured with Python support in order to use | |
646 | the pretty printers. Notice that your system having Python available | |
647 | doesn't imply that GDB supports it, nor that your system's Python and | |
648 | GDB's have the same version. As of release time GNU @code{debugger} | |
14126ff0 | 649 | 13.2 is the newest verified to work to test the pretty printers. |
3c1622eb JM |
650 | |
651 | Unless Python, PExpect and GDB with Python support are present, the | |
652 | printer tests will report themselves as @code{UNSUPPORTED}. Notice | |
653 | that some of the printer tests require @theglibc{} to be compiled with | |
654 | debugging symbols. | |
3c20b9b6 UD |
655 | @end itemize |
656 | ||
657 | @noindent | |
cb8a6dbd | 658 | If you change any of the @file{configure.ac} files you will also need |
3c20b9b6 UD |
659 | |
660 | @itemize @bullet | |
661 | @item | |
98ffc1bf | 662 | GNU @code{autoconf} 2.72 (exactly) |
3c20b9b6 UD |
663 | @end itemize |
664 | ||
665 | @noindent | |
666 | and if you change any of the message translation files you will need | |
667 | ||
668 | @itemize @bullet | |
669 | @item | |
c26b4f64 | 670 | GNU @code{gettext} 0.10.36 or later |
f650932b | 671 | |
51990242 | 672 | As of release time, GNU @code{gettext} version 0.21.1 is the newest |
f650932b | 673 | version verified to work to build @theglibc{}. |
3c20b9b6 UD |
674 | @end itemize |
675 | ||
cc8623f1 | 676 | |
3c20b9b6 UD |
677 | @noindent |
678 | You may also need these packages if you upgrade your source tree using | |
679 | patches, although we try to avoid this. | |
680 | ||
1792d4db | 681 | @node Linux |
a7a93d50 | 682 | @appendixsec Specific advice for @gnulinuxsystems{} |
1792d4db UD |
683 | @cindex kernel header files |
684 | ||
a7a93d50 | 685 | If you are installing @theglibc{} on @gnulinuxsystems{}, you need to have |
5b4ecd3f | 686 | the header files from a 3.2 or newer kernel around for reference. |
abd923db JM |
687 | These headers must be installed using @samp{make headers_install}; the |
688 | headers present in the kernel source directory are not suitable for | |
1f77f049 JM |
689 | direct use by @theglibc{}. You do not need to use that kernel, just have |
690 | its headers installed where @theglibc{} can access them, referred to here as | |
abd923db JM |
691 | @var{install-directory}. The easiest way to do this is to unpack it |
692 | in a directory such as @file{/usr/src/linux-@var{version}}. In that | |
693 | directory, run @samp{make headers_install | |
1f77f049 | 694 | INSTALL_HDR_PATH=@var{install-directory}}. Finally, configure @theglibc{} |
abd923db JM |
695 | with the option @samp{--with-headers=@var{install-directory}/include}. |
696 | Use the most recent kernel you can get your hands on. (If you are | |
1f77f049 | 697 | cross-compiling @theglibc{}, you need to specify |
abd923db JM |
698 | @samp{ARCH=@var{architecture}} in the @samp{make headers_install} |
699 | command, where @var{architecture} is the architecture name used by the | |
700 | Linux kernel, such as @samp{x86} or @samp{powerpc}.) | |
a8d87c92 | 701 | |
1f77f049 | 702 | After installing @theglibc{}, you may need to remove or rename |
abd923db JM |
703 | directories such as @file{/usr/include/linux} and |
704 | @file{/usr/include/asm}, and replace them with copies of directories | |
705 | such as @file{linux} and @file{asm} from | |
706 | @file{@var{install-directory}/include}. All directories present in | |
707 | @file{@var{install-directory}/include} should be copied, except that | |
1f77f049 | 708 | @theglibc{} provides its own version of @file{/usr/include/scsi}; the |
abd923db | 709 | files provided by the kernel should be copied without replacing those |
1f77f049 | 710 | provided by @theglibc{}. The @file{linux}, @file{asm} and |
abd923db | 711 | @file{asm-generic} directories are required to compile programs using |
1f77f049 | 712 | @theglibc{}; the other directories describe interfaces to the kernel but |
abd923db JM |
713 | are not required if not compiling programs using those interfaces. |
714 | You do not need to copy kernel headers if you did not specify an | |
715 | alternate kernel header source using @samp{--with-headers}. | |
1792d4db | 716 | |
a7a93d50 JM |
717 | The Filesystem Hierarchy Standard for @gnulinuxsystems{} expects some |
718 | components of the @glibcadj{} installation to be in | |
1792d4db | 719 | @file{/lib} and some in @file{/usr/lib}. This is handled automatically |
1f77f049 | 720 | if you configure @theglibc{} with @samp{--prefix=/usr}. If you set some other |
1792d4db UD |
721 | prefix or allow it to default to @file{/usr/local}, then all the |
722 | components are installed there. | |
723 | ||
51990242 | 724 | As of release time, Linux version 6.1.5 is the newest stable version verified |
6415fd2d CD |
725 | to work to build @theglibc{}. |
726 | ||
3c20b9b6 UD |
727 | @node Reporting Bugs |
728 | @appendixsec Reporting Bugs | |
729 | @cindex reporting bugs | |
730 | @cindex bugs, reporting | |
731 | ||
1f77f049 | 732 | There are probably bugs in @theglibc{}. There are certainly |
3c20b9b6 UD |
733 | errors and omissions in this manual. If you report them, they will get |
734 | fixed. If you don't, no one will ever know about them and they will | |
735 | remain unfixed for all eternity, if not longer. | |
736 | ||
04b9968b UD |
737 | It is a good idea to verify that the problem has not already been |
738 | reported. Bugs are documented in two places: The file @file{BUGS} | |
8b748aed JM |
739 | describes a number of well known bugs and the central @glibcadj{} |
740 | bug tracking system has a | |
612fdf25 | 741 | WWW interface at |
a306c790 | 742 | @url{https://sourceware.org/bugzilla/}. The WWW |
a4d62195 UD |
743 | interface gives you access to open and closed reports. A closed report |
744 | normally includes a patch or a hint on solving the problem. | |
612fdf25 | 745 | |
a4d62195 | 746 | To report a bug, first you must find it. With any luck, this will be the |
3c20b9b6 | 747 | hard part. Once you've found a bug, make sure it's really a bug. A |
1f77f049 | 748 | good way to do this is to see if @theglibc{} behaves the same way |
3c20b9b6 UD |
749 | some other C library does. If so, probably you are wrong and the |
750 | libraries are right (but not necessarily). If not, one of the libraries | |
1f77f049 | 751 | is probably wrong. It might not be @theglibc{}. Many historical |
1792d4db UD |
752 | Unix C libraries permit things that we don't, such as closing a file |
753 | twice. | |
754 | ||
1f77f049 | 755 | If you think you have found some way in which @theglibc{} does not |
1792d4db UD |
756 | conform to the ISO and POSIX standards (@pxref{Standards and |
757 | Portability}), that is definitely a bug. Report it! | |
3c20b9b6 UD |
758 | |
759 | Once you're sure you've found a bug, try to narrow it down to the | |
760 | smallest test case that reproduces the problem. In the case of a C | |
761 | library, you really only need to narrow it down to one library | |
762 | function call, if possible. This should not be too difficult. | |
763 | ||
764 | The final step when you have a simple test case is to report the bug. | |
8b748aed | 765 | Do this at @value{REPORT_BUGS_TO}. |
3c20b9b6 UD |
766 | |
767 | If you are not sure how a function should behave, and this manual | |
768 | doesn't tell you, that's a bug in the manual. Report that too! If the | |
769 | function's behavior disagrees with the manual, then either the library | |
770 | or the manual has a bug, so report the disagreement. If you find any | |
d40eb37a UD |
771 | errors or omissions in this manual, please report them to the |
772 | bug database. If you refer to specific | |
04b9968b UD |
773 | sections of the manual, please include the section names for easier |
774 | identification. |