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