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