build.html 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386
  1. <html lang="en">
  2. <head>
  3. <title>Installing GCC: Building</title>
  4. <meta http-equiv="Content-Type" content="text/html">
  5. <meta name="description" content="Installing GCC: Building">
  6. <meta name="generator" content="makeinfo 4.12">
  7. <link title="Top" rel="top" href="#Top">
  8. <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
  9. <!--
  10. Copyright (C) 1988-2015 Free Software Foundation, Inc.
  11. Permission is granted to copy, distribute and/or modify this document
  12. under the terms of the GNU Free Documentation License, Version 1.3 or
  13. any later version published by the Free Software Foundation; with no
  14. Invariant Sections, the Front-Cover texts being (a) (see below), and
  15. with the Back-Cover Texts being (b) (see below). A copy of the
  16. license is included in the section entitled "GNU Free Documentation License".
  17. (a) The FSF's Front-Cover Text is:
  18. A GNU Manual
  19. (b) The FSF's Back-Cover Text is:
  20. You have freedom to copy and modify this GNU Manual, like GNU
  21. software. Copies published by the Free Software Foundation raise
  22. funds for GNU development.-->
  23. <meta http-equiv="Content-Style-Type" content="text/css">
  24. <style type="text/css"><!--
  25. pre.display { font-family:inherit }
  26. pre.format { font-family:inherit }
  27. pre.smalldisplay { font-family:inherit; font-size:smaller }
  28. pre.smallformat { font-family:inherit; font-size:smaller }
  29. pre.smallexample { font-size:smaller }
  30. pre.smalllisp { font-size:smaller }
  31. span.sc { font-variant:small-caps }
  32. span.roman { font-family:serif; font-weight:normal; }
  33. span.sansserif { font-family:sans-serif; font-weight:normal; }
  34. --></style>
  35. </head>
  36. <body>
  37. <h1 class="settitle">Installing GCC: Building</h1>
  38. <a name="index-Installing-GCC_003a-Building-1"></a>
  39. Now that GCC is configured, you are ready to build the compiler and
  40. runtime libraries.
  41. <p>Some commands executed when making the compiler may fail (return a
  42. nonzero status) and be ignored by <samp><span class="command">make</span></samp>. These failures, which
  43. are often due to files that were not found, are expected, and can safely
  44. be ignored.
  45. <p>It is normal to have compiler warnings when compiling certain files.
  46. Unless you are a GCC developer, you can generally ignore these warnings
  47. unless they cause compilation to fail. Developers should attempt to fix
  48. any warnings encountered, however they can temporarily continue past
  49. warnings-as-errors by specifying the configure flag
  50. <samp><span class="option">--disable-werror</span></samp>.
  51. <p>On certain old systems, defining certain environment variables such as
  52. <samp><span class="env">CC</span></samp> can interfere with the functioning of <samp><span class="command">make</span></samp>.
  53. <p>If you encounter seemingly strange errors when trying to build the
  54. compiler in a directory other than the source directory, it could be
  55. because you have previously configured the compiler in the source
  56. directory. Make sure you have done all the necessary preparations.
  57. <p>If you build GCC on a BSD system using a directory stored in an old System
  58. V file system, problems may occur in running <samp><span class="command">fixincludes</span></samp> if the
  59. System V file system doesn't support symbolic links. These problems
  60. result in a failure to fix the declaration of <code>size_t</code> in
  61. <samp><span class="file">sys/types.h</span></samp>. If you find that <code>size_t</code> is a signed type and
  62. that type mismatches occur, this could be the cause.
  63. <p>The solution is not to use such a directory for building GCC.
  64. <p>Similarly, when building from SVN or snapshots, or if you modify
  65. <samp><span class="file">*.l</span></samp> files, you need the Flex lexical analyzer generator
  66. installed. If you do not modify <samp><span class="file">*.l</span></samp> files, releases contain
  67. the Flex-generated files and you do not need Flex installed to build
  68. them. There is still one Flex-based lexical analyzer (part of the
  69. build machinery, not of GCC itself) that is used even if you only
  70. build the C front end.
  71. <p>When building from SVN or snapshots, or if you modify Texinfo
  72. documentation, you need version 4.7 or later of Texinfo installed if you
  73. want Info documentation to be regenerated. Releases contain Info
  74. documentation pre-built for the unmodified documentation in the release.
  75. <h3 class="section"><a name="TOC0"></a>Building a native compiler</h3>
  76. <p>For a native build, the default configuration is to perform
  77. a 3-stage bootstrap of the compiler when &lsquo;<samp><span class="samp">make</span></samp>&rsquo; is invoked.
  78. This will build the entire GCC system and ensure that it compiles
  79. itself correctly. It can be disabled with the <samp><span class="option">--disable-bootstrap</span></samp>
  80. parameter to &lsquo;<samp><span class="samp">configure</span></samp>&rsquo;, but bootstrapping is suggested because
  81. the compiler will be tested more completely and could also have
  82. better performance.
  83. <p>The bootstrapping process will complete the following steps:
  84. <ul>
  85. <li>Build tools necessary to build the compiler.
  86. <li>Perform a 3-stage bootstrap of the compiler. This includes building
  87. three times the target tools for use by the compiler such as binutils
  88. (bfd, binutils, gas, gprof, ld, and opcodes) if they have been
  89. individually linked or moved into the top level GCC source tree before
  90. configuring.
  91. <li>Perform a comparison test of the stage2 and stage3 compilers.
  92. <li>Build runtime libraries using the stage3 compiler from the previous step.
  93. </ul>
  94. <p>If you are short on disk space you might consider &lsquo;<samp><span class="samp">make
  95. bootstrap-lean</span></samp>&rsquo; instead. The sequence of compilation is the
  96. same described above, but object files from the stage1 and
  97. stage2 of the 3-stage bootstrap of the compiler are deleted as
  98. soon as they are no longer needed.
  99. <p>If you wish to use non-default GCC flags when compiling the stage2
  100. and stage3 compilers, set <code>BOOT_CFLAGS</code> on the command line when
  101. doing &lsquo;<samp><span class="samp">make</span></samp>&rsquo;. For example, if you want to save additional space
  102. during the bootstrap and in the final installation as well, you can
  103. build the compiler binaries without debugging information as in the
  104. following example. This will save roughly 40% of disk space both for
  105. the bootstrap and the final installation. (Libraries will still contain
  106. debugging information.)
  107. <pre class="smallexample"> make BOOT_CFLAGS='-O' bootstrap
  108. </pre>
  109. <p>You can place non-default optimization flags into <code>BOOT_CFLAGS</code>; they
  110. are less well tested here than the default of &lsquo;<samp><span class="samp">-g -O2</span></samp>&rsquo;, but should
  111. still work. In a few cases, you may find that you need to specify special
  112. flags such as <samp><span class="option">-msoft-float</span></samp> here to complete the bootstrap; or,
  113. if the native compiler miscompiles the stage1 compiler, you may need
  114. to work around this, by choosing <code>BOOT_CFLAGS</code> to avoid the parts
  115. of the stage1 compiler that were miscompiled, or by using &lsquo;<samp><span class="samp">make
  116. bootstrap4</span></samp>&rsquo; to increase the number of stages of bootstrap.
  117. <p><code>BOOT_CFLAGS</code> does not apply to bootstrapped target libraries.
  118. Since these are always compiled with the compiler currently being
  119. bootstrapped, you can use <code>CFLAGS_FOR_TARGET</code> to modify their
  120. compilation flags, as for non-bootstrapped target libraries.
  121. Again, if the native compiler miscompiles the stage1 compiler, you may
  122. need to work around this by avoiding non-working parts of the stage1
  123. compiler. Use <code>STAGE1_TFLAGS</code> to this end.
  124. <p>If you used the flag <samp><span class="option">--enable-languages=...</span></samp> to restrict
  125. the compilers to be built, only those you've actually enabled will be
  126. built. This will of course only build those runtime libraries, for
  127. which the particular compiler has been built. Please note,
  128. that re-defining <samp><span class="env">LANGUAGES</span></samp> when calling &lsquo;<samp><span class="samp">make</span></samp>&rsquo;
  129. <strong>does not</strong> work anymore!
  130. <p>If the comparison of stage2 and stage3 fails, this normally indicates
  131. that the stage2 compiler has compiled GCC incorrectly, and is therefore
  132. a potentially serious bug which you should investigate and report. (On
  133. a few systems, meaningful comparison of object files is impossible; they
  134. always appear &ldquo;different&rdquo;. If you encounter this problem, you will
  135. need to disable comparison in the <samp><span class="file">Makefile</span></samp>.)
  136. <p>If you do not want to bootstrap your compiler, you can configure with
  137. <samp><span class="option">--disable-bootstrap</span></samp>. In particular cases, you may want to
  138. bootstrap your compiler even if the target system is not the same as
  139. the one you are building on: for example, you could build a
  140. <code>powerpc-unknown-linux-gnu</code> toolchain on a
  141. <code>powerpc64-unknown-linux-gnu</code> host. In this case, pass
  142. <samp><span class="option">--enable-bootstrap</span></samp> to the configure script.
  143. <p><code>BUILD_CONFIG</code> can be used to bring in additional customization
  144. to the build. It can be set to a whitespace-separated list of names.
  145. For each such <code>NAME</code>, top-level <samp><span class="file">config/</span><code>NAME</code><span class="file">.mk</span></samp> will
  146. be included by the top-level <samp><span class="file">Makefile</span></samp>, bringing in any settings
  147. it contains. The default <code>BUILD_CONFIG</code> can be set using the
  148. configure option <samp><span class="option">--with-build-config=</span><code>NAME</code><span class="option">...</span></samp>. Some
  149. examples of supported build configurations are:
  150. <dl>
  151. <dt>&lsquo;<samp><span class="samp">bootstrap-O1</span></samp>&rsquo;<dd>Removes any <samp><span class="option">-O</span></samp>-started option from <code>BOOT_CFLAGS</code>, and adds
  152. <samp><span class="option">-O1</span></samp> to it. &lsquo;<samp><span class="samp">BUILD_CONFIG=bootstrap-O1</span></samp>&rsquo; is equivalent to
  153. &lsquo;<samp><span class="samp">BOOT_CFLAGS='-g -O1'</span></samp>&rsquo;.
  154. <br><dt>&lsquo;<samp><span class="samp">bootstrap-O3</span></samp>&rsquo;<dd>Analogous to <code>bootstrap-O1</code>.
  155. <br><dt>&lsquo;<samp><span class="samp">bootstrap-lto</span></samp>&rsquo;<dd>Enables Link-Time Optimization for host tools during bootstrapping.
  156. &lsquo;<samp><span class="samp">BUILD_CONFIG=bootstrap-lto</span></samp>&rsquo; is equivalent to adding
  157. <samp><span class="option">-flto</span></samp> to &lsquo;<samp><span class="samp">BOOT_CFLAGS</span></samp>&rsquo;. This option assumes that the host
  158. supports the linker plugin (e.g. GNU ld version 2.21 or later or GNU gold
  159. version 2.21 or later).
  160. <br><dt>&lsquo;<samp><span class="samp">bootstrap-lto-noplugin</span></samp>&rsquo;<dd>This option is similar to <code>bootstrap-lto</code>, but is intended for
  161. hosts that do not support the linker plugin. Without the linker plugin
  162. static libraries are not compiled with link-time optimizations. Since
  163. the GCC middle end and back end are in <samp><span class="file">libbackend.a</span></samp> this means
  164. that only the front end is actually LTO optimized.
  165. <br><dt>&lsquo;<samp><span class="samp">bootstrap-debug</span></samp>&rsquo;<dd>Verifies that the compiler generates the same executable code, whether
  166. or not it is asked to emit debug information. To this end, this
  167. option builds stage2 host programs without debug information, and uses
  168. <samp><span class="file">contrib/compare-debug</span></samp> to compare them with the stripped stage3
  169. object files. If <code>BOOT_CFLAGS</code> is overridden so as to not enable
  170. debug information, stage2 will have it, and stage3 won't. This option
  171. is enabled by default when GCC bootstrapping is enabled, if
  172. <code>strip</code> can turn object files compiled with and without debug
  173. info into identical object files. In addition to better test
  174. coverage, this option makes default bootstraps faster and leaner.
  175. <br><dt>&lsquo;<samp><span class="samp">bootstrap-debug-big</span></samp>&rsquo;<dd>Rather than comparing stripped object files, as in
  176. <code>bootstrap-debug</code>, this option saves internal compiler dumps
  177. during stage2 and stage3 and compares them as well, which helps catch
  178. additional potential problems, but at a great cost in terms of disk
  179. space. It can be specified in addition to &lsquo;<samp><span class="samp">bootstrap-debug</span></samp>&rsquo;.
  180. <br><dt>&lsquo;<samp><span class="samp">bootstrap-debug-lean</span></samp>&rsquo;<dd>This option saves disk space compared with <code>bootstrap-debug-big</code>,
  181. but at the expense of some recompilation. Instead of saving the dumps
  182. of stage2 and stage3 until the final compare, it uses
  183. <samp><span class="option">-fcompare-debug</span></samp> to generate, compare and remove the dumps
  184. during stage3, repeating the compilation that already took place in
  185. stage2, whose dumps were not saved.
  186. <br><dt>&lsquo;<samp><span class="samp">bootstrap-debug-lib</span></samp>&rsquo;<dd>This option tests executable code invariance over debug information
  187. generation on target libraries, just like <code>bootstrap-debug-lean</code>
  188. tests it on host programs. It builds stage3 libraries with
  189. <samp><span class="option">-fcompare-debug</span></samp>, and it can be used along with any of the
  190. <code>bootstrap-debug</code> options above.
  191. <p>There aren't <code>-lean</code> or <code>-big</code> counterparts to this option
  192. because most libraries are only build in stage3, so bootstrap compares
  193. would not get significant coverage. Moreover, the few libraries built
  194. in stage2 are used in stage3 host programs, so we wouldn't want to
  195. compile stage2 libraries with different options for comparison purposes.
  196. <br><dt>&lsquo;<samp><span class="samp">bootstrap-debug-ckovw</span></samp>&rsquo;<dd>Arranges for error messages to be issued if the compiler built on any
  197. stage is run without the option <samp><span class="option">-fcompare-debug</span></samp>. This is
  198. useful to verify the full <samp><span class="option">-fcompare-debug</span></samp> testing coverage. It
  199. must be used along with <code>bootstrap-debug-lean</code> and
  200. <code>bootstrap-debug-lib</code>.
  201. <br><dt>&lsquo;<samp><span class="samp">bootstrap-time</span></samp>&rsquo;<dd>Arranges for the run time of each program started by the GCC driver,
  202. built in any stage, to be logged to <samp><span class="file">time.log</span></samp>, in the top level of
  203. the build tree.
  204. </dl>
  205. <h3 class="section"><a name="TOC1"></a>Building a cross compiler</h3>
  206. <p>When building a cross compiler, it is not generally possible to do a
  207. 3-stage bootstrap of the compiler. This makes for an interesting problem
  208. as parts of GCC can only be built with GCC.
  209. <p>To build a cross compiler, we recommend first building and installing a
  210. native compiler. You can then use the native GCC compiler to build the
  211. cross compiler. The installed native compiler needs to be GCC version
  212. 2.95 or later.
  213. <p>If the cross compiler is to be built with support for the Java
  214. programming language and the ability to compile .java source files is
  215. desired, the installed native compiler used to build the cross
  216. compiler needs to be the same GCC version as the cross compiler. In
  217. addition the cross compiler needs to be configured with
  218. <samp><span class="option">--with-ecj-jar=...</span></samp>.
  219. <p>Assuming you have already installed a native copy of GCC and configured
  220. your cross compiler, issue the command <samp><span class="command">make</span></samp>, which performs the
  221. following steps:
  222. <ul>
  223. <li>Build host tools necessary to build the compiler.
  224. <li>Build target tools for use by the compiler such as binutils (bfd,
  225. binutils, gas, gprof, ld, and opcodes)
  226. if they have been individually linked or moved into the top level GCC source
  227. tree before configuring.
  228. <li>Build the compiler (single stage only).
  229. <li>Build runtime libraries using the compiler from the previous step.
  230. </ul>
  231. <p>Note that if an error occurs in any step the make process will exit.
  232. <p>If you are not building GNU binutils in the same source tree as GCC,
  233. you will need a cross-assembler and cross-linker installed before
  234. configuring GCC. Put them in the directory
  235. <samp><var>prefix</var><span class="file">/</span><var>target</var><span class="file">/bin</span></samp>. Here is a table of the tools
  236. you should put in this directory:
  237. <dl>
  238. <dt><samp><span class="file">as</span></samp><dd>This should be the cross-assembler.
  239. <br><dt><samp><span class="file">ld</span></samp><dd>This should be the cross-linker.
  240. <br><dt><samp><span class="file">ar</span></samp><dd>This should be the cross-archiver: a program which can manipulate
  241. archive files (linker libraries) in the target machine's format.
  242. <br><dt><samp><span class="file">ranlib</span></samp><dd>This should be a program to construct a symbol table in an archive file.
  243. </dl>
  244. <p>The installation of GCC will find these programs in that directory,
  245. and copy or link them to the proper place to for the cross-compiler to
  246. find them when run later.
  247. <p>The easiest way to provide these files is to build the Binutils package.
  248. Configure it with the same <samp><span class="option">--host</span></samp> and <samp><span class="option">--target</span></samp>
  249. options that you use for configuring GCC, then build and install
  250. them. They install their executables automatically into the proper
  251. directory. Alas, they do not support all the targets that GCC
  252. supports.
  253. <p>If you are not building a C library in the same source tree as GCC,
  254. you should also provide the target libraries and headers before
  255. configuring GCC, specifying the directories with
  256. <samp><span class="option">--with-sysroot</span></samp> or <samp><span class="option">--with-headers</span></samp> and
  257. <samp><span class="option">--with-libs</span></samp>. Many targets also require &ldquo;start files&rdquo; such
  258. as <samp><span class="file">crt0.o</span></samp> and
  259. <samp><span class="file">crtn.o</span></samp> which are linked into each executable. There may be several
  260. alternatives for <samp><span class="file">crt0.o</span></samp>, for use with profiling or other
  261. compilation options. Check your target's definition of
  262. <code>STARTFILE_SPEC</code> to find out what start files it uses.
  263. <h3 class="section"><a name="TOC2"></a>Building in parallel</h3>
  264. <p>GNU Make 3.80 and above, which is necessary to build GCC, support
  265. building in parallel. To activate this, you can use &lsquo;<samp><span class="samp">make -j 2</span></samp>&rsquo;
  266. instead of &lsquo;<samp><span class="samp">make</span></samp>&rsquo;. You can also specify a bigger number, and
  267. in most cases using a value greater than the number of processors in
  268. your machine will result in fewer and shorter I/O latency hits, thus
  269. improving overall throughput; this is especially true for slow drives
  270. and network filesystems.
  271. <h3 class="section"><a name="TOC3"></a>Building the Ada compiler</h3>
  272. <p>In order to build GNAT, the Ada compiler, you need a working GNAT
  273. compiler (GCC version 4.0 or later).
  274. This includes GNAT tools such as <samp><span class="command">gnatmake</span></samp> and
  275. <samp><span class="command">gnatlink</span></samp>, since the Ada front end is written in Ada and
  276. uses some GNAT-specific extensions.
  277. <p>In order to build a cross compiler, it is suggested to install
  278. the new compiler as native first, and then use it to build the cross
  279. compiler.
  280. <p><samp><span class="command">configure</span></samp> does not test whether the GNAT installation works
  281. and has a sufficiently recent version; if too old a GNAT version is
  282. installed, the build will fail unless <samp><span class="option">--enable-languages</span></samp> is
  283. used to disable building the Ada front end.
  284. <p><samp><span class="env">ADA_INCLUDE_PATH</span></samp> and <samp><span class="env">ADA_OBJECT_PATH</span></samp> environment variables
  285. must not be set when building the Ada compiler, the Ada tools, or the
  286. Ada runtime libraries. You can check that your build environment is clean
  287. by verifying that &lsquo;<samp><span class="samp">gnatls -v</span></samp>&rsquo; lists only one explicit path in each
  288. section.
  289. <h3 class="section"><a name="TOC4"></a>Building with profile feedback</h3>
  290. <p>It is possible to use profile feedback to optimize the compiler itself. This
  291. should result in a faster compiler binary. Experiments done on x86 using gcc
  292. 3.3 showed approximately 7 percent speedup on compiling C programs. To
  293. bootstrap the compiler with profile feedback, use <code>make profiledbootstrap</code>.
  294. <p>When &lsquo;<samp><span class="samp">make profiledbootstrap</span></samp>&rsquo; is run, it will first build a <code>stage1</code>
  295. compiler. This compiler is used to build a <code>stageprofile</code> compiler
  296. instrumented to collect execution counts of instruction and branch
  297. probabilities. Then runtime libraries are compiled with profile collected.
  298. Finally a <code>stagefeedback</code> compiler is built using the information collected.
  299. <p>Unlike standard bootstrap, several additional restrictions apply. The
  300. compiler used to build <code>stage1</code> needs to support a 64-bit integral type.
  301. It is recommended to only use GCC for this.
  302. <p><hr />
  303. <p><a href="./index.html">Return to the GCC Installation page</a>
  304. <!-- ***Testing***************************************************************** -->
  305. <!-- ***Final install*********************************************************** -->
  306. <!-- ***Binaries**************************************************************** -->
  307. <!-- ***Specific**************************************************************** -->
  308. <!-- ***Old documentation****************************************************** -->
  309. <!-- ***GFDL******************************************************************** -->
  310. <!-- *************************************************************************** -->
  311. <!-- Part 6 The End of the Document -->
  312. </body></html>