INSTALL 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702
  1. Installing the GNU C Library
  2. ****************************
  3. Before you do anything else, you should read the FAQ at
  4. <https://sourceware.org/glibc/wiki/FAQ>. It answers common questions
  5. and describes problems you may experience with compilation and
  6. installation.
  7. You will need recent versions of several GNU tools: definitely GCC
  8. and GNU Make, and possibly others. See Tools for Compilation, below.
  9. Configuring and compiling the GNU C Library
  10. ===========================================
  11. The GNU C Library cannot be compiled in the source directory. You must
  12. build it in a separate build directory. For example, if you have
  13. unpacked the GNU C Library sources in '/src/gnu/glibc-VERSION', create a
  14. directory '/src/gnu/glibc-build' to put the object files in. This
  15. allows removing the whole build directory in case an error occurs, which
  16. is the safest way to get a fresh start and should always be done.
  17. From your object directory, run the shell script 'configure' located
  18. at the top level of the source tree. In the scenario above, you'd type
  19. $ ../glibc-VERSION/configure ARGS...
  20. Please note that even though you're building in a separate build
  21. directory, the compilation may need to create or modify files and
  22. directories in the source directory.
  23. 'configure' takes many options, but the only one that is usually
  24. mandatory is '--prefix'. This option tells 'configure' where you want
  25. the GNU C Library installed. This defaults to '/usr/local', but the
  26. normal setting to install as the standard system library is
  27. '--prefix=/usr' for GNU/Linux systems and '--prefix=' (an empty prefix)
  28. for GNU/Hurd systems.
  29. It may also be useful to pass 'CC=COMPILER' and 'CFLAGS=FLAGS'
  30. arguments to 'configure'. 'CC' selects the C compiler that will be
  31. used, and 'CFLAGS' sets optimization options for the compiler. Any
  32. compiler options required for all compilations, such as options
  33. selecting an ABI or a processor for which to generate code, should be
  34. included in 'CC'. Options that may be overridden by the GNU C Library
  35. build system for particular files, such as for optimization and
  36. debugging, should go in 'CFLAGS'. The default value of 'CFLAGS' is '-g
  37. -O2', and the GNU C Library cannot be compiled without optimization, so
  38. if 'CFLAGS' is specified it must enable optimization. For example:
  39. $ ../glibc-VERSION/configure CC="gcc -m32" CFLAGS="-O3"
  40. To test the GNU C Library with a different set of C and C++
  41. compilers, 'TEST_CC=COMPILER' and 'TEST_CXX=COMPILER' arguments can be
  42. passed to 'configure'. For example:
  43. $ ../glibc-VERSION/configure TEST_CC="gcc-6.4.1" TEST_CXX="g++-6.4.1"
  44. The following list describes all of the available options for
  45. 'configure':
  46. '--prefix=DIRECTORY'
  47. Install machine-independent data files in subdirectories of
  48. 'DIRECTORY'. The default is to install in '/usr/local'.
  49. '--exec-prefix=DIRECTORY'
  50. Install the library and other machine-dependent files in
  51. subdirectories of 'DIRECTORY'. The default is to the '--prefix'
  52. directory if that option is specified, or '/usr/local' otherwise.
  53. '--with-headers=DIRECTORY'
  54. Look for kernel header files in DIRECTORY, not '/usr/include'. The
  55. GNU C Library needs information from the kernel's header files
  56. describing the interface to the kernel. The GNU C Library will
  57. normally look in '/usr/include' for them, but if you specify this
  58. option, it will look in DIRECTORY instead.
  59. This option is primarily of use on a system where the headers in
  60. '/usr/include' come from an older version of the GNU C Library.
  61. Conflicts can occasionally happen in this case. You can also use
  62. this option if you want to compile the GNU C Library with a newer
  63. set of kernel headers than the ones found in '/usr/include'.
  64. '--enable-kernel=VERSION'
  65. This option is currently only useful on GNU/Linux systems. The
  66. VERSION parameter should have the form X.Y.Z and describes the
  67. smallest version of the Linux kernel the generated library is
  68. expected to support. The higher the VERSION number is, the less
  69. compatibility code is added, and the faster the code gets.
  70. '--with-binutils=DIRECTORY'
  71. Use the binutils (assembler and linker) in 'DIRECTORY', not the
  72. ones the C compiler would default to. You can use this option if
  73. the default binutils on your system cannot deal with all the
  74. constructs in the GNU C Library. In that case, 'configure' will
  75. detect the problem and suppress these constructs, so that the
  76. library will still be usable, but functionality may be lost--for
  77. example, you can't build a shared libc with old binutils.
  78. '--with-nonshared-cflags=CFLAGS'
  79. Use additional compiler flags CFLAGS to build the parts of the
  80. library which are always statically linked into applications and
  81. libraries even with shared linking (that is, the object files
  82. contained in 'lib*_nonshared.a' libraries). The build process will
  83. automatically use the appropriate flags, but this option can be
  84. used to set additional flags required for building applications and
  85. libraries, to match local policy. For example, if such a policy
  86. requires that all code linked into applications must be built with
  87. source fortification,
  88. '--with-nonshared-cflags=-Wp,-D_FORTIFY_SOURCE=2' will make sure
  89. that the objects in 'libc_nonshared.a' are compiled with this flag
  90. (although this will not affect the generated code in this
  91. particular case and potentially change debugging information and
  92. metadata only).
  93. '--with-rtld-early-cflags=CFLAGS'
  94. Use additional compiler flags CFLAGS to build the early startup
  95. code of the dynamic linker. These flags can be used to enable
  96. early dynamic linker diagnostics to run on CPUs which are not
  97. compatible with the rest of the GNU C Library, for example, due to
  98. compiler flags which target a later instruction set architecture
  99. (ISA).
  100. '--with-timeoutfactor=NUM'
  101. Specify an integer NUM to scale the timeout of test programs. This
  102. factor can be changed at run time using 'TIMEOUTFACTOR' environment
  103. variable.
  104. '--disable-shared'
  105. Don't build shared libraries even if it is possible. Not all
  106. systems support shared libraries; you need ELF support and
  107. (currently) the GNU linker.
  108. '--disable-default-pie'
  109. Don't build glibc programs and the testsuite as position
  110. independent executables (PIE). By default, glibc programs and tests
  111. are created as position independent executables on targets that
  112. support it. If the toolchain and architecture support it, static
  113. executables are built as static PIE and the resulting glibc can be
  114. used with the GCC option, -static-pie, which is available with GCC
  115. 8 or above, to create static PIE.
  116. '--enable-cet'
  117. '--enable-cet=permissive'
  118. Enable Intel Control-flow Enforcement Technology (CET) support.
  119. When the GNU C Library is built with '--enable-cet' or
  120. '--enable-cet=permissive', the resulting library is protected with
  121. indirect branch tracking (IBT) and shadow stack (SHSTK). When CET
  122. is enabled, the GNU C Library is compatible with all existing
  123. executables and shared libraries. This feature is currently
  124. supported on x86_64 and x32 with GCC 8 and binutils 2.29 or later.
  125. With '--enable-cet', it is an error to dlopen a non CET enabled
  126. shared library in CET enabled application. With
  127. '--enable-cet=permissive', CET is disabled when dlopening a non CET
  128. enabled shared library in CET enabled application.
  129. NOTE: '--enable-cet' is only supported on x86_64 and x32.
  130. '--enable-memory-tagging'
  131. Enable memory tagging support if the architecture supports it.
  132. When the GNU C Library is built with this option then the resulting
  133. library will be able to control the use of tagged memory when
  134. hardware support is present by use of the tunable
  135. 'glibc.mem.tagging'. This includes the generation of tagged memory
  136. when using the 'malloc' APIs.
  137. At present only AArch64 platforms with MTE provide this
  138. functionality, although the library will still operate (without
  139. memory tagging) on older versions of the architecture.
  140. The default is to disable support for memory tagging.
  141. '--disable-profile'
  142. Don't build libraries with profiling information. You may want to
  143. use this option if you don't plan to do profiling.
  144. '--enable-static-nss'
  145. Compile static versions of the NSS (Name Service Switch) libraries.
  146. This is not recommended because it defeats the purpose of NSS; a
  147. program linked statically with the NSS libraries cannot be
  148. dynamically reconfigured to use a different name database.
  149. '--enable-hardcoded-path-in-tests'
  150. By default, dynamic tests are linked to run with the installed C
  151. library. This option hardcodes the newly built C library path in
  152. dynamic tests so that they can be invoked directly.
  153. '--disable-timezone-tools'
  154. By default, time zone related utilities ('zic', 'zdump', and
  155. 'tzselect') are installed with the GNU C Library. If you are
  156. building these independently (e.g. by using the 'tzcode' package),
  157. then this option will allow disabling the install of these.
  158. Note that you need to make sure the external tools are kept in sync
  159. with the versions that the GNU C Library expects as the data
  160. formats may change over time. Consult the 'timezone' subdirectory
  161. for more details.
  162. '--enable-stack-protector'
  163. '--enable-stack-protector=strong'
  164. '--enable-stack-protector=all'
  165. Compile the C library and all other parts of the glibc package
  166. (including the threading and math libraries, NSS modules, and
  167. transliteration modules) using the GCC '-fstack-protector',
  168. '-fstack-protector-strong' or '-fstack-protector-all' options to
  169. detect stack overruns. Only the dynamic linker and a small number
  170. of routines called directly from assembler are excluded from this
  171. protection.
  172. '--enable-bind-now'
  173. Disable lazy binding for installed shared objects and programs.
  174. This provides additional security hardening because it enables full
  175. RELRO and a read-only global offset table (GOT), at the cost of
  176. slightly increased program load times.
  177. '--enable-pt_chown'
  178. The file 'pt_chown' is a helper binary for 'grantpt' (see
  179. Pseudo-Terminals: Allocation) that is installed setuid root to fix
  180. up pseudo-terminal ownership on GNU/Hurd. It is not required on
  181. GNU/Linux, and the GNU C Library will not use the installed
  182. 'pt_chown' program when configured with '--enable-pt_chown'.
  183. '--disable-werror'
  184. By default, the GNU C Library is built with '-Werror'. If you wish
  185. to build without this option (for example, if building with a newer
  186. version of GCC than this version of the GNU C Library was tested
  187. with, so new warnings cause the build with '-Werror' to fail), you
  188. can configure with '--disable-werror'.
  189. '--disable-mathvec'
  190. By default for x86_64, the GNU C Library is built with the vector
  191. math library. Use this option to disable the vector math library.
  192. '--disable-static-c++-tests'
  193. By default, if the C++ toolchain lacks support for static linking,
  194. configure fails to find the C++ header files and the glibc build
  195. fails. '--disable-static-c++-link-check' allows the glibc build to
  196. finish, but static C++ tests will fail if the C++ toolchain doesn't
  197. have the necessary static C++ libraries. Use this option to skip
  198. the static C++ tests. This option implies
  199. '--disable-static-c++-link-check'.
  200. '--disable-static-c++-link-check'
  201. By default, if the C++ toolchain lacks support for static linking,
  202. configure fails to find the C++ header files and the glibc build
  203. fails. Use this option to disable the static C++ link check so
  204. that the C++ header files can be located. The newly built libc.a
  205. can be used to create static C++ tests if the C++ toolchain has the
  206. necessary static C++ libraries.
  207. '--disable-scv'
  208. Disable using 'scv' instruction for syscalls. All syscalls will
  209. use 'sc' instead, even if the kernel supports 'scv'. PowerPC only.
  210. '--build=BUILD-SYSTEM'
  211. '--host=HOST-SYSTEM'
  212. These options are for cross-compiling. If you specify both options
  213. and BUILD-SYSTEM is different from HOST-SYSTEM, 'configure' will
  214. prepare to cross-compile the GNU C Library from BUILD-SYSTEM to be
  215. used on HOST-SYSTEM. You'll probably need the '--with-headers'
  216. option too, and you may have to override CONFIGURE's selection of
  217. the compiler and/or binutils.
  218. If you only specify '--host', 'configure' will prepare for a native
  219. compile but use what you specify instead of guessing what your
  220. system is. This is most useful to change the CPU submodel. For
  221. example, if 'configure' guesses your machine as 'i686-pc-linux-gnu'
  222. but you want to compile a library for 586es, give
  223. '--host=i586-pc-linux-gnu' or just '--host=i586-linux' and add the
  224. appropriate compiler flags ('-mcpu=i586' will do the trick) to
  225. 'CC'.
  226. If you specify just '--build', 'configure' will get confused.
  227. '--with-pkgversion=VERSION'
  228. Specify a description, possibly including a build number or build
  229. date, of the binaries being built, to be included in '--version'
  230. output from programs installed with the GNU C Library. For
  231. example, '--with-pkgversion='FooBar GNU/Linux glibc build 123''.
  232. The default value is 'GNU libc'.
  233. '--with-bugurl=URL'
  234. Specify the URL that users should visit if they wish to report a
  235. bug, to be included in '--help' output from programs installed with
  236. the GNU C Library. The default value refers to the main
  237. bug-reporting information for the GNU C Library.
  238. '--enable-fortify-source'
  239. '--enable-fortify-source=LEVEL'
  240. Use -D_FORTIFY_SOURCE='LEVEL' to control hardening in the GNU C
  241. Library. If not provided, 'LEVEL' defaults to highest possible
  242. value supported by the build compiler.
  243. Default is to disable fortification.
  244. '--enable-sframe'
  245. Experimental option supported by some architectures, where the GNU
  246. C Library is built with '-Wa,--gsframe' if 'binutils' supports it.
  247. Currently this is only supported on x86_64 and aarch64. The option
  248. enables SFrame support on 'backtrace'.
  249. Default is to disable SFrame support.
  250. To build the library and related programs, type 'make'. This will
  251. produce a lot of output, some of which may look like errors from 'make'
  252. but aren't. Look for error messages from 'make' containing '***'.
  253. Those indicate that something is seriously wrong.
  254. The compilation process can take a long time, depending on the
  255. configuration and the speed of your machine. Some complex modules may
  256. take a very long time to compile, as much as several minutes on slower
  257. machines. Do not panic if the compiler appears to hang.
  258. If you want to run a parallel make, simply pass the '-j' option with
  259. an appropriate numeric parameter to 'make'. You need a recent GNU
  260. 'make' version, though.
  261. To build and run test programs which exercise some of the library
  262. facilities, type 'make check'. If it does not complete successfully, do
  263. not use the built library, and report a bug after verifying that the
  264. problem is not already known. See Reporting Bugs, for instructions on
  265. reporting bugs. Note that some of the tests assume they are not being
  266. run by 'root'. We recommend you compile and test the GNU C Library as
  267. an unprivileged user.
  268. Before reporting bugs make sure there is no problem with your system.
  269. The tests (and later installation) use some pre-existing files of the
  270. system such as '/etc/passwd', '/etc/nsswitch.conf' and others. These
  271. files must all contain correct and sensible content.
  272. Normally, 'make check' will run all the tests before reporting all
  273. problems found and exiting with error status if any problems occurred.
  274. You can specify 'stop-on-test-failure=y' when running 'make check' to
  275. make the test run stop and exit with an error status immediately when a
  276. failure occurs.
  277. To format the 'GNU C Library Reference Manual' for printing, type
  278. 'make dvi'. You need a working TeX installation to do this. The
  279. distribution builds the on-line formatted version of the manual, as Info
  280. files, as part of the build process. You can build them manually with
  281. 'make info'.
  282. The library has a number of special-purpose configuration parameters
  283. which you can find in 'Makeconfig'. These can be overwritten with the
  284. file 'configparms'. To change them, create a 'configparms' in your
  285. build directory and add values as appropriate for your system. The file
  286. is included and parsed by 'make' and has to follow the conventions for
  287. makefiles.
  288. It is easy to configure the GNU C Library for cross-compilation by
  289. setting a few variables in 'configparms'. Set 'CC' to the
  290. cross-compiler for the target you configured the library for; it is
  291. important to use this same 'CC' value when running 'configure', like
  292. this: 'configure TARGET CC=TARGET-gcc'. Set 'BUILD_CC' to the compiler
  293. to use for programs run on the build system as part of compiling the
  294. library. You may need to set 'AR' to cross-compiling versions of 'ar'
  295. if the native tools are not configured to work with object files for the
  296. target you configured for. When cross-compiling the GNU C Library, it
  297. may be tested using 'make check
  298. test-wrapper="SRCDIR/scripts/cross-test-ssh.sh HOSTNAME"', where SRCDIR
  299. is the absolute directory name for the main source directory and
  300. HOSTNAME is the host name of a system that can run the newly built
  301. binaries of the GNU C Library. The source and build directories must be
  302. visible at the same locations on both the build system and HOSTNAME.
  303. The 'cross-test-ssh.sh' script requires 'flock' from 'util-linux' to
  304. work when GLIBC_TEST_ALLOW_TIME_SETTING environment variable is set.
  305. It is also possible to execute tests, which require setting the date
  306. on the target machine. Following use cases are supported:
  307. * 'GLIBC_TEST_ALLOW_TIME_SETTING' is set in the environment in which
  308. eligible tests are executed and have the privilege to run
  309. 'clock_settime'. In this case, nothing prevents those tests from
  310. running in parallel, so the caller shall assure that those tests
  311. are serialized or provide a proper wrapper script for them.
  312. * The 'cross-test-ssh.sh' script is used and one passes the
  313. '--allow-time-setting' flag. In this case, both sets
  314. 'GLIBC_TEST_ALLOW_TIME_SETTING' and serialization of test execution
  315. are assured automatically.
  316. In general, when testing the GNU C Library, 'test-wrapper' may be set
  317. to the name and arguments of any program to run newly built binaries.
  318. This program must preserve the arguments to the binary being run, its
  319. working directory and the standard input, output and error file
  320. descriptors. If 'TEST-WRAPPER env' will not work to run a program with
  321. environment variables set, then 'test-wrapper-env' must be set to a
  322. program that runs a newly built program with environment variable
  323. assignments in effect, those assignments being specified as 'VAR=VALUE'
  324. before the name of the program to be run. If multiple assignments to
  325. the same variable are specified, the last assignment specified must take
  326. precedence. Similarly, if 'TEST-WRAPPER env -i' will not work to run a
  327. program with an environment completely empty of variables except those
  328. directly assigned, then 'test-wrapper-env-only' must be set; its use has
  329. the same syntax as 'test-wrapper-env', the only difference in its
  330. semantics being starting with an empty set of environment variables
  331. rather than the ambient set.
  332. For AArch64 with SVE, when testing the GNU C Library, 'test-wrapper'
  333. may be set to "SRCDIR/sysdeps/unix/sysv/linux/aarch64/vltest.py
  334. VECTOR-LENGTH" to change Vector Length.
  335. Installing the C Library
  336. ========================
  337. To install the library and its header files, and the Info files of the
  338. manual, type 'make install'. This will build things, if necessary,
  339. before installing them; however, you should still compile everything
  340. first. If you are installing the GNU C Library as your primary C
  341. library, we recommend that you shut the system down to single-user mode
  342. first, and reboot afterward. This minimizes the risk of breaking things
  343. when the library changes out from underneath.
  344. 'make install' will do the entire job of upgrading from a previous
  345. installation of the GNU C Library version 2.x. There may sometimes be
  346. headers left behind from the previous installation, but those are
  347. generally harmless. If you want to avoid leaving headers behind you can
  348. do things in the following order.
  349. You must first build the library ('make'), optionally check it ('make
  350. check'), switch the include directories and then install ('make
  351. install'). The steps must be done in this order. Not moving the
  352. directory before install will result in an unusable mixture of header
  353. files from both libraries, but configuring, building, and checking the
  354. library requires the ability to compile and run programs against the old
  355. library. The new '/usr/include', after switching the include
  356. directories and before installing the library should contain the Linux
  357. headers, but nothing else. If you do this, you will need to restore any
  358. headers from libraries other than the GNU C Library yourself after
  359. installing the library.
  360. You can install the GNU C Library somewhere other than where you
  361. configured it to go by setting the 'DESTDIR' GNU standard make variable
  362. on the command line for 'make install'. The value of this variable is
  363. prepended to all the paths for installation. This is useful when
  364. setting up a chroot environment or preparing a binary distribution. The
  365. directory should be specified with an absolute file name. Installing
  366. with the 'prefix' and 'exec_prefix' GNU standard make variables set is
  367. not supported.
  368. The GNU C Library includes a daemon called 'nscd', which you may or
  369. may not want to run. 'nscd' caches name service lookups; it can
  370. dramatically improve performance with NIS+, and may help with DNS as
  371. well.
  372. One auxiliary program, '/usr/libexec/pt_chown', is installed setuid
  373. 'root' if the '--enable-pt_chown' configuration option is used. This
  374. program is invoked by the 'grantpt' function; it sets the permissions on
  375. a pseudoterminal so it can be used by the calling process. If you are
  376. using a Linux kernel with the 'devpts' filesystem enabled and mounted at
  377. '/dev/pts', you don't need this program.
  378. After installation you should configure the time zone ruleset and
  379. install locales for your system. The time zone ruleset ensures that
  380. timestamps are processed correctly for your location. The locales
  381. ensure that the display of information on your system matches the
  382. expectations of your language and geographic region.
  383. The GNU C Library is able to use two kinds of localization
  384. information sources, the first is a locale database named
  385. 'locale-archive' which is generally installed as
  386. '/usr/lib/locale/locale-archive'. The locale archive has the benefit of
  387. taking up less space and being very fast to load, but only if you plan
  388. to install sixty or more locales. If you plan to install one or two
  389. locales you can instead install individual locales into their self-named
  390. directories e.g. '/usr/lib/locale/en_US.utf8'. For example to install
  391. the German locale using the character set for UTF-8 with name 'de_DE'
  392. into the locale archive issue the command 'localedef -i de_DE -f UTF-8
  393. de_DE', and to install just the one locale issue the command 'localedef
  394. --no-archive -i de_DE -f UTF-8 de_DE'. To configure all locales that
  395. are supported by the GNU C Library, you can issue from your build
  396. directory the command 'make localedata/install-locales' to install all
  397. locales into the locale archive or 'make
  398. localedata/install-locale-files' to install all locales as files in the
  399. default configured locale installation directory (derived from
  400. '--prefix' or '--localedir'). To install into an alternative system
  401. root use 'DESTDIR' e.g. 'make localedata/install-locale-files
  402. DESTDIR=/opt/glibc', but note that this does not change the configured
  403. prefix.
  404. To configure the time zone ruleset, set the 'TZ' environment
  405. variable. The script 'tzselect' helps you to select the right value.
  406. As an example, for Germany, 'tzselect' would tell you to use
  407. 'TZ='Europe/Berlin''. For a system wide installation (the given paths
  408. are for an installation with '--prefix=/usr'), link the time zone file
  409. which is in '/usr/share/zoneinfo' to the file '/etc/localtime'. For
  410. Germany, you might execute 'ln -s /usr/share/zoneinfo/Europe/Berlin
  411. /etc/localtime'.
  412. Recommended Tools for Compilation
  413. =================================
  414. We recommend installing the following GNU tools before attempting to
  415. build the GNU C Library:
  416. * GNU 'make' 4.0 or newer
  417. As of release time, GNU 'make' 4.4.1 is the newest verified to work
  418. to build the GNU C Library.
  419. * GCC 12.1 or newer
  420. GCC 12.1 or higher is required. In general it is recommended to
  421. use the newest version of the compiler that is known to work for
  422. building the GNU C Library, as newer compilers usually produce
  423. better code. As of release time, GCC 15.2.1 is the newest compiler
  424. verified to work to build the GNU C Library.
  425. For multi-arch support it is recommended to use a GCC which has
  426. been built with support for GNU indirect functions. This ensures
  427. that correct debugging information is generated for functions
  428. selected by IFUNC resolvers. This support can either be enabled by
  429. configuring GCC with '--enable-gnu-indirect-function', or by
  430. enabling it by default by setting 'default_gnu_indirect_function'
  431. variable for a particular architecture in the GCC source file
  432. 'gcc/config.gcc'.
  433. You can use whatever compiler you like to compile programs that use
  434. the GNU C Library.
  435. Check the FAQ for any special compiler issues on particular
  436. platforms.
  437. * GNU 'binutils' 2.39 or later
  438. You must use GNU 'binutils' (as and ld) to build the GNU C Library.
  439. No other assembler or linker has the necessary functionality at the
  440. moment. As of release time, GNU 'binutils' 2.45.1 is the newest
  441. verified to work to build the GNU C Library.
  442. * GNU 'texinfo' 4.7 or later
  443. To correctly translate and install the Texinfo documentation you
  444. need this version of the 'texinfo' package. Earlier versions do
  445. not understand all the tags used in the document, and the
  446. installation mechanism for the info files is not present or works
  447. differently. As of release time, 'texinfo' 7.2 is the newest
  448. verified to work to build the GNU C Library.
  449. * GNU 'awk' 3.1.2, or higher
  450. 'awk' is used in several places to generate files. Some 'gawk'
  451. extensions are used, including the 'asorti' function, which was
  452. introduced in version 3.1.2 of 'gawk'. As of release time, 'gawk'
  453. version 5.3.2 is the newest verified to work to build the GNU C
  454. Library.
  455. Testing the GNU C Library requires 'gawk' to be compiled with
  456. support for high precision arithmetic via the 'MPFR'
  457. multiple-precision floating-point computation library.
  458. * GNU 'bison' 2.7 or later
  459. 'bison' is used to generate the 'yacc' parser code in the 'intl'
  460. subdirectory. As of release time, 'bison' version 3.8.2 is the
  461. newest verified to work to build the GNU C Library.
  462. * Perl 5
  463. Perl is not required, but if present it is used in some tests and
  464. the 'mtrace' program, to build the GNU C Library manual. As of
  465. release time 'perl' version 5.42.0 is the newest verified to work
  466. to build the GNU C Library.
  467. * GNU 'sed' 3.02 or newer
  468. 'Sed' is used in several places to generate files. Most scripts
  469. work with any version of 'sed'. As of release time, 'sed' version
  470. 4.9 is the newest verified to work to build the GNU C Library.
  471. * Python 3.4 or later
  472. Python is required to build the GNU C Library. As of release time,
  473. Python 3.14.0 is the newest verified to work for building and
  474. testing the GNU C Library.
  475. * PExpect 4.0
  476. The pretty printer tests drive GDB through test programs and
  477. compare its output to the printers'. PExpect is used to capture
  478. the output of GDB, and should be compatible with the Python version
  479. in your system. As of release time PExpect 4.9.0 is the newest
  480. verified to work to test the pretty printers.
  481. * The Python 'abnf' module.
  482. This module is optional and used to verify some ABNF grammars in
  483. the manual. Version 2.2.0 has been confirmed to work as expected.
  484. A missing 'abnf' module does not reduce the test coverage of the
  485. library itself.
  486. * GDB 7.8 or later with support for Python 3.4 or later
  487. GDB itself needs to be configured with Python support in order to
  488. use the pretty printers. Notice that your system having Python
  489. available doesn't imply that GDB supports it, nor that your
  490. system's Python and GDB's have the same version. As of release
  491. time GNU 'debugger' 14.2 is the newest verified to work to test the
  492. pretty printers.
  493. Unless Python, PExpect and GDB with Python support are present, the
  494. printer tests will report themselves as 'UNSUPPORTED'. Notice that
  495. some of the printer tests require the GNU C Library to be compiled
  496. with debugging symbols.
  497. If you change any of the 'configure.ac' files you will also need
  498. * GNU 'autoconf' 2.72 (exactly)
  499. and if you change any of the message translation files you will need
  500. * GNU 'gettext' 0.10.36 or later
  501. As of release time, GNU 'gettext' version 0.23.2 is the newest
  502. version verified to work to build the GNU C Library.
  503. You may also need these packages if you upgrade your source tree using
  504. patches, although we try to avoid this.
  505. Specific advice for GNU/Linux systems
  506. =====================================
  507. If you are installing the GNU C Library on GNU/Linux systems, you need
  508. to have the header files from a 3.2 or newer kernel around for
  509. reference. These headers must be installed using 'make
  510. headers_install'; the headers present in the kernel source directory are
  511. not suitable for direct use by the GNU C Library. You do not need to
  512. use that kernel, just have its headers installed where the GNU C Library
  513. can access them, referred to here as INSTALL-DIRECTORY. The easiest way
  514. to do this is to unpack it in a directory such as
  515. '/usr/src/linux-VERSION'. In that directory, run 'make headers_install
  516. INSTALL_HDR_PATH=INSTALL-DIRECTORY'. Finally, configure the GNU C
  517. Library with the option '--with-headers=INSTALL-DIRECTORY/include'. Use
  518. the most recent kernel you can get your hands on. (If you are
  519. cross-compiling the GNU C Library, you need to specify
  520. 'ARCH=ARCHITECTURE' in the 'make headers_install' command, where
  521. ARCHITECTURE is the architecture name used by the Linux kernel, such as
  522. 'x86' or 'powerpc'.)
  523. After installing the GNU C Library, you may need to remove or rename
  524. directories such as '/usr/include/linux' and '/usr/include/asm', and
  525. replace them with copies of directories such as 'linux' and 'asm' from
  526. 'INSTALL-DIRECTORY/include'. All directories present in
  527. 'INSTALL-DIRECTORY/include' should be copied, except that the GNU C
  528. Library provides its own version of '/usr/include/scsi'; the files
  529. provided by the kernel should be copied without replacing those provided
  530. by the GNU C Library. The 'linux', 'asm' and 'asm-generic' directories
  531. are required to compile programs using the GNU C Library; the other
  532. directories describe interfaces to the kernel but are not required if
  533. not compiling programs using those interfaces. You do not need to copy
  534. kernel headers if you did not specify an alternate kernel header source
  535. using '--with-headers'.
  536. The Filesystem Hierarchy Standard for GNU/Linux systems expects some
  537. components of the GNU C Library installation to be in '/lib' and some in
  538. '/usr/lib'. This is handled automatically if you configure the GNU C
  539. Library with '--prefix=/usr'. If you set some other prefix or allow it
  540. to default to '/usr/local', then all the components are installed there.
  541. As of release time, Linux version 6.12 is the newest stable version
  542. verified to work to build the GNU C Library.
  543. Reporting Bugs
  544. ==============
  545. There are probably bugs in the GNU C Library. There are certainly
  546. errors and omissions in this manual. If you report them, they will get
  547. fixed. If you don't, no one will ever know about them and they will
  548. remain unfixed for all eternity, if not longer.
  549. It is a good idea to verify that the problem has not already been
  550. reported. Bugs are documented in two places: The file 'BUGS' describes
  551. a number of well known bugs and the central GNU C Library bug tracking
  552. system has a WWW interface at <https://sourceware.org/bugzilla/>. The
  553. WWW interface gives you access to open and closed reports. A closed
  554. report normally includes a patch or a hint on solving the problem.
  555. To report a bug, first you must find it. With any luck, this will be
  556. the hard part. Once you've found a bug, make sure it's really a bug. A
  557. good way to do this is to see if the GNU C Library behaves the same way
  558. some other C library does. If so, probably you are wrong and the
  559. libraries are right (but not necessarily). If not, one of the libraries
  560. is probably wrong. It might not be the GNU C Library. Many historical
  561. Unix C libraries permit things that we don't, such as closing a file
  562. twice.
  563. If you think you have found some way in which the GNU C Library does
  564. not conform to the ISO and POSIX standards (see Standards and
  565. Portability), that is definitely a bug. Report it!
  566. Once you're sure you've found a bug, try to narrow it down to the
  567. smallest test case that reproduces the problem. In the case of a C
  568. library, you really only need to narrow it down to one library function
  569. call, if possible. This should not be too difficult.
  570. The final step when you have a simple test case is to report the bug.
  571. Do this at <https://www.gnu.org/software/libc/bugs.html>.
  572. If you are not sure how a function should behave, and this manual
  573. doesn't tell you, that's a bug in the manual. Report that too! If the
  574. function's behavior disagrees with the manual, then either the library
  575. or the manual has a bug, so report the disagreement. If you find any
  576. errors or omissions in this manual, please report them to the bug
  577. database. If you refer to specific sections of the manual, please
  578. include the section names for easier identification.