install.texi 35 KB

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