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