install.texi 33 KB

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