1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../general.ent">
8 <sect1 id="ch-system-gcc" role="wrap">
9 <?dbhtml filename="gcc.html"?>
11 <sect1info condition="script">
12 <productname>gcc</productname>
13 <productnumber>&gcc-version;</productnumber>
14 <address>&gcc-url;</address>
17 <title>GCC-&gcc-version;</title>
19 <indexterm zone="ch-system-gcc">
20 <primary sortas="a-GCC">GCC</primary>
23 <sect2 role="package">
26 <para>The GCC package contains the GNU compiler collection, which includes
27 the C and C++ compilers.</para>
30 <segtitle>&buildtime;</segtitle>
31 <segtitle>&diskspace;</segtitle>
34 <seg>&gcc-ch6-sbu;</seg>
35 <seg>&gcc-ch6-du;</seg>
41 <sect2 role="installation">
42 <title>Installation of GCC</title>
44 <para>If building on x86_64, change the default directory name for 64-bit
45 libraries to <quote>lib</quote>:</para>
47 <screen><userinput remap="pre">case $(uname -m) in
49 sed -e '/m64=/s/lib64/lib/' \
50 -i.orig gcc/config/i386/t-linux64
52 esac</userinput></screen>
55 As in gcc-pass2, fix a problem introduced by Glibc-2.31:
58 <screen><userinput remap="pre">sed -e '1161 s|^|//|' \
59 -i libsanitizer/sanitizer_common/sanitizer_platform_limits_posix.cc</userinput></screen>
61 <para>The GCC documentation recommends building GCC in a dedicated build directory:</para>
63 <screen><userinput remap="pre">mkdir -v build
64 cd build</userinput></screen>
66 <para>Prepare GCC for compilation:</para>
68 <screen><userinput remap="configure">SED=sed \
69 ../configure --prefix=/usr \
70 --enable-languages=c,c++ \
73 --with-system-zlib</userinput></screen>
75 <para>Note that for other languages, there are some prerequisites that
76 are not yet available. See the
77 <ulink url="&blfs-book;general/gcc.html">BLFS Book</ulink>
78 for instructions on how to build all of GCC's supported languages.</para>
81 <title>The meaning of the new configure parameters:</title>
84 <term><envar>SED=sed</envar></term>
86 <para>Setting this environment variable prevents a hard-coded
87 path to /tools/bin/sed.</para>
92 <term><parameter>- -disable-libmpx</parameter></term>
94 <para>This switch tells GCC to not build mpx (Memory Protection
95 Extensions) that can cause problems on some processors. It has
96 been removed from the next version of gcc.</para>
101 <term><parameter>--with-system-zlib</parameter></term>
103 <para>This switch tells GCC to link to the system installed copy of
104 the Zlib library, rather than its own internal copy.</para>
109 <para>Compile the package:</para>
111 <screen><userinput remap="make">make</userinput></screen>
114 <para>In this section, the test suite for GCC is considered
115 critical. Do not skip it under any circumstance.</para>
118 <para>One set of tests in the GCC test suite is known to exhaust the stack,
119 so increase the stack size prior to running the tests:</para>
121 <screen><userinput remap="test">ulimit -s 32768</userinput></screen>
123 <para>Test the results as a non-privileged user, but do not stop at errors:</para>
125 <screen><userinput remap="test">chown -Rv nobody .
126 su nobody -s /bin/bash -c "PATH=$PATH make -k check"</userinput></screen>
128 <para>To receive a summary of the test suite results, run:</para>
130 <screen><userinput remap="test">../contrib/test_summary</userinput></screen>
132 <para>For only the summaries, pipe the output through
133 <userinput>grep -A7 Summ</userinput>.</para>
135 <para>Results can be compared with those located at <ulink
136 url="&test-results;"/> and
137 <ulink url="https://gcc.gnu.org/ml/gcc-testresults/"/>.</para>
139 <para>Six tests related to get_time are known to fail. These are
140 apparently related to the en_HK locale.</para>
142 <para>Two tests named lookup.cc and reverse.cc in experimental/net
143 are known to fail in LFS chroot environment because they require
144 /etc/hosts and iana-etc.</para>
146 <para>Two tests named pr57193.c and pr90178.c are known to fail.</para>
148 <para>A few unexpected failures cannot always be avoided. The GCC developers
149 are usually aware of these issues, but have not resolved them yet.
150 Unless the test results are vastly different from those at the above URL,
151 it is safe to continue.</para>
154 On some combinations of kernel configuration and AMD processors
155 there may be more than 1100 failures in the gcc.target/i386/mpx
156 tests (which are designed to test the MPX option on recent
157 Intel processors). These can safely be ignored on AMD
158 processors. These tests will also fail on Intel processors if MPX support
159 is not enabled in the kernel even though it is present on the CPU.
162 <para>Install the package and remove an unneeded directory:</para>
164 <screen><userinput remap="install">make install
165 rm -rf /usr/lib/gcc/$(gcc -dumpmachine)/&gcc-version;/include-fixed/bits/</userinput></screen>
167 <para>The GCC build directory is owned by <systemitem class="username">
168 nobody</systemitem> now and the ownership of the installed header
169 directory (and its content) will be incorrect. Change the ownership to
170 <systemitem class="username">root</systemitem> user and group:</para>
172 <screen><userinput remap="install">chown -v -R root:root \
173 /usr/lib/gcc/*linux-gnu/&gcc-version;/include{,-fixed}</userinput></screen>
175 <para>Create a symlink required by the <ulink
176 url="https://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch03s09.html">FHS</ulink>
177 for "historical" reasons.</para>
179 <screen><userinput remap="install">ln -sv ../usr/bin/cpp /lib</userinput></screen>
181 <para>Many packages use the name <command>cc</command> to call the C
182 compiler. To satisfy those packages, create a symlink:</para>
184 <screen><userinput remap="install">ln -sv gcc /usr/bin/cc</userinput></screen>
186 <para>Add a compatibility symlink to enable building programs with
187 Link Time Optimization (LTO):</para>
189 <screen><userinput remap="install">install -v -dm755 /usr/lib/bfd-plugins
190 ln -sfv ../../libexec/gcc/$(gcc -dumpmachine)/&gcc-version;/liblto_plugin.so \
191 /usr/lib/bfd-plugins/</userinput></screen>
193 <para>Now that our final toolchain is in place, it is important to again ensure
194 that compiling and linking will work as expected. We do this by performing
195 the same sanity checks as we did earlier in the chapter:</para>
197 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
199 xpointer="xpointer(//*[@os='a'])"/>
201 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
203 xpointer="xpointer(//*[@os='b'])"/>
205 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
207 xpointer="xpointer(//*[@os='c'])"/>
209 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
211 xpointer="xpointer(//*[@os='d'])"/>
213 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
215 xpointer="xpointer(//*[@os='e'])"/>
217 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
219 xpointer="xpointer(//*[@os='f'])"/>
221 <screen><computeroutput>/usr/lib/gcc/x86_64-pc-linux-gnu/&gcc-version;/../../../../lib/crt1.o succeeded
222 /usr/lib/gcc/x86_64-pc-linux-gnu/&gcc-version;/../../../../lib/crti.o succeeded
223 /usr/lib/gcc/x86_64-pc-linux-gnu/&gcc-version;/../../../../lib/crtn.o succeeded</computeroutput></screen>
225 <para>Depending on your machine architecture, the above may differ slightly,
226 the difference usually being the name of the directory
227 after <filename class="directory">/usr/lib/gcc</filename>. The important
228 thing to look for here is that <command>gcc</command> has found all three
229 <filename>crt*.o</filename> files under the
230 <filename class="directory">/usr/lib</filename> directory.</para>
232 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
234 xpointer="xpointer(//*[@os='g'])"/>
236 <screen><userinput>grep -B4 '^ /usr/include' dummy.log</userinput></screen>
238 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
240 xpointer="xpointer(//*[@os='h'])"/>
242 <screen><computeroutput>#include <...> search starts here:
243 /usr/lib/gcc/x86_64-pc-linux-gnu/&gcc-version;/include
245 /usr/lib/gcc/x86_64-pc-linux-gnu/&gcc-version;/include-fixed
246 /usr/include</computeroutput></screen>
248 <para>Again, note that the directory named after your target triplet may be
249 different than the above, depending on your architecture.</para>
251 <!-- This appears to be obsolete
253 <note><para>As of version 4.3.0, GCC now unconditionally installs the
254 <filename>limits.h</filename> file into the private
255 <filename class="directory">include-fixed</filename> directory, and that
256 directory is required to be in place.</para></note>
259 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
261 xpointer="xpointer(//*[@os='i'])"/>
263 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
265 xpointer="xpointer(//*[@os='j'])"/>
267 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
269 xpointer="xpointer(//*[@os='k'])"/>
271 <screen><computeroutput>SEARCH_DIR("/usr/x86_64-pc-linux-gnu/lib64")
272 SEARCH_DIR("/usr/local/lib64")
274 SEARCH_DIR("/usr/lib64")
275 SEARCH_DIR("/usr/x86_64-pc-linux-gnu/lib")
276 SEARCH_DIR("/usr/local/lib")
278 SEARCH_DIR("/usr/lib");</computeroutput></screen>
280 <para>A 32-bit system may see a few different directories. For example, here
281 is the output from an i686 machine:</para>
283 <screen><computeroutput>SEARCH_DIR("/usr/i686-pc-linux-gnu/lib32")
284 SEARCH_DIR("/usr/local/lib32")
286 SEARCH_DIR("/usr/lib32")
287 SEARCH_DIR("/usr/i686-pc-linux-gnu/lib")
288 SEARCH_DIR("/usr/local/lib")
290 SEARCH_DIR("/usr/lib");</computeroutput></screen>
292 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
294 xpointer="xpointer(//*[@os='l'])"/>
296 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
298 xpointer="xpointer(//*[@os='m'])"/>
300 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
302 xpointer="xpointer(//*[@os='n'])"/>
304 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
306 xpointer="xpointer(//*[@os='o'])"/>
308 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
310 xpointer="xpointer(//*[@os='p'])"/>
312 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
314 xpointer="xpointer(//*[@os='q'])"/>
316 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
318 xpointer="xpointer(//*[@os='r'])"/>
320 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
322 xpointer="xpointer(//*[@os='s'])"/>
324 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
326 xpointer="xpointer(//*[@os='t'])"/>
328 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
330 xpointer="xpointer(//*[@os='u'])"/>
332 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
334 xpointer="xpointer(//*[@os='v'])"/>
336 <para>Finally, move a misplaced file:</para>
338 <screen><userinput remap="install">mkdir -pv /usr/share/gdb/auto-load/usr/lib
339 mv -v /usr/lib/*gdb.py /usr/share/gdb/auto-load/usr/lib</userinput></screen>
343 <sect2 id="contents-gcc" role="content">
344 <title>Contents of GCC</title>
347 <segtitle>Installed programs</segtitle>
348 <segtitle>Installed libraries</segtitle>
349 <segtitle>Installed directories</segtitle>
352 <seg>c++, cc (link to gcc), cpp, g++, gcc,
353 gcc-ar, gcc-nm, gcc-ranlib, gcov, gcov-dump, and gcov-tool</seg>
355 <seg>libasan.{a,so}, libatomic.{a,so}, libcc1.so, libgcc.a, libgcc_eh.a,
356 libgcc_s.so, libgcov.a, libgomp.{a,so}, libitm.{a,so},
357 liblsan.{a,so}, liblto_plugin.so,
358 libquadmath.{a,so}, libssp.{a,so}, libssp_nonshared.a,
359 libstdc++.{a,so}, libstdc++fs.a, libsupc++.a, libtsan.{a,so},
360 and libubsan.{a,so}</seg>
362 <seg>/usr/include/c++, /usr/lib/gcc, /usr/libexec/gcc, and
363 /usr/share/gcc-&gcc-version;</seg>
368 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
369 <?dbfo list-presentation="list"?>
370 <?dbhtml list-presentation="table"?>
372 <varlistentry id="c">
373 <term><command>c++</command></term>
375 <para>The C++ compiler</para>
376 <indexterm zone="ch-system-gcc c">
377 <primary sortas="b-c++">c++</primary>
382 <varlistentry id="cc">
383 <term><command>cc</command></term>
385 <para>The C compiler</para>
386 <indexterm zone="ch-system-gcc cc">
387 <primary sortas="b-cc">cc</primary>
392 <varlistentry id="cpp">
393 <term><command>cpp</command></term>
395 <para>The C preprocessor; it is used by the compiler to expand the
396 #include, #define, and similar statements in the source files</para>
397 <indexterm zone="ch-system-gcc cpp">
398 <primary sortas="b-cpp">cpp</primary>
403 <varlistentry id="g">
404 <term><command>g++</command></term>
406 <para>The C++ compiler</para>
407 <indexterm zone="ch-system-gcc g">
408 <primary sortas="b-g++">g++</primary>
413 <varlistentry id="gcc">
414 <term><command>gcc</command></term>
416 <para>The C compiler</para>
417 <indexterm zone="ch-system-gcc gcc">
418 <primary sortas="b-gcc">gcc</primary>
423 <varlistentry id="gcc-ar">
424 <term><command>gcc-ar</command></term>
426 <para>A wrapper around <command>ar</command> that adds a
427 plugin to the command line. This program is only used
428 to add "link time optimization" and is not useful with the
429 default build options</para>
430 <indexterm zone="ch-system-gcc gcc-ar">
431 <primary sortas="b-gcc-ar">gc-ar</primary>
436 <varlistentry id="gcc-nm">
437 <term><command>gcc-nm</command></term>
439 <para>A wrapper around <command>nm</command> that adds a
440 plugin to the command line. This program is only used
441 to add "link time optimization" and is not useful with the
442 default build options</para>
443 <indexterm zone="ch-system-gcc gcc-nm">
444 <primary sortas="b-gcc-nm">gc-nm</primary>
449 <varlistentry id="gcc-ranlib">
450 <term><command>gcc-ranlib</command></term>
452 <para>A wrapper around <command>ranlib</command> that adds a
453 plugin to the command line. This program is only used
454 to add "link time optimization" and is not useful with the
455 default build options</para>
456 <indexterm zone="ch-system-gcc gcc-ranlib">
457 <primary sortas="b-gcc-ranlib">gc-ranlib</primary>
462 <varlistentry id="gcov">
463 <term><command>gcov</command></term>
465 <para>A coverage testing tool; it is used to analyze programs to
466 determine where optimizations will have the most effect</para>
467 <indexterm zone="ch-system-gcc gcov">
468 <primary sortas="b-gcov">gcov</primary>
473 <varlistentry id="gcov-dump">
474 <term><command>gcov-dump</command></term>
476 <para>Offline gcda and gcno profile dump tool</para>
477 <indexterm zone="ch-system-gcc gcov-dump">
478 <primary sortas="b-gcov-dump">gcov-dump</primary>
483 <varlistentry id="gcov-tool">
484 <term><command>gcov-tool</command></term>
486 <para>Offline gcda profile processing tool</para>
487 <indexterm zone="ch-system-gcc gcov-tool">
488 <primary sortas="b-gcov-tool">gcov-tool</primary>
493 <varlistentry id="libasan">
494 <term><filename class="libraryfile">libasan</filename></term>
496 <para>The Address Sanitizer runtime library</para>
497 <indexterm zone="ch-system-gcc libasan">
498 <primary sortas="b-libasan">libasan</primary>
503 <varlistentry id="libatomic">
504 <term><filename class="libraryfile">libatomic</filename></term>
506 <para>GCC atomic built-in runtime library</para>
507 <indexterm zone="ch-system-gcc libatomic">
508 <primary sortas="b-libatomic">libatomic</primary>
513 <varlistentry id="libcc1">
514 <term><filename class="libraryfile">libcc1</filename></term>
516 <para>The C preprocessing library</para>
517 <indexterm zone="ch-system-gcc libcc1">
518 <primary sortas="b-libcc1">libcc1</primary>
523 <varlistentry id="libgcc">
524 <term><filename class="libraryfile">libgcc</filename></term>
526 <para>Contains run-time support for <command>gcc</command></para>
527 <indexterm zone="ch-system-gcc libgcc">
528 <primary sortas="c-libgcc">libgcc</primary>
533 <varlistentry id="libgcov">
534 <term><filename class="libraryfile">libgcov</filename></term>
536 <para>This library is linked in to a program when GCC is instructed
537 to enable profiling</para>
538 <indexterm zone="ch-system-gcc libgcov">
539 <primary sortas="c-libgcov">libgcov</primary>
544 <varlistentry id="libgomp">
545 <term><filename class="libraryfile">libgomp</filename></term>
547 <para>GNU implementation of the OpenMP API for multi-platform
548 shared-memory parallel programming in C/C++ and Fortran</para>
549 <indexterm zone="ch-system-gcc libgomp">
550 <primary sortas="c-libgomp">libgomp</primary>
555 <varlistentry id="liblsan">
556 <term><filename class="libraryfile">liblsan</filename></term>
558 <para>The Leak Sanitizer runtime library</para>
559 <indexterm zone="ch-system-gcc liblsan">
560 <primary sortas="c-liblsan">liblsan</primary>
565 <varlistentry id="liblto_plugin">
566 <term><filename class="libraryfile">liblto_plugin</filename></term>
568 <para>GCC's Link Time Optimization (LTO) plugin allows GCC to perform
569 optimizations across compilation units</para>
570 <indexterm zone="ch-system-gcc liblto_plugin">
571 <primary sortas="c-liblto_plugin">liblto_plugin</primary>
576 <varlistentry id="libquadmath">
577 <term><filename class="libraryfile">libquadmath</filename></term>
579 <para>GCC Quad Precision Math Library API</para>
580 <indexterm zone="ch-system-gcc libquadmath">
581 <primary sortas="c-libquadmath">libquadmath</primary>
586 <varlistentry id="libssp">
587 <term><filename class="libraryfile">libssp</filename></term>
589 <para>Contains routines supporting GCC's stack-smashing protection
591 <indexterm zone="ch-system-gcc libssp">
592 <primary sortas="c-libssp">libssp</primary>
597 <varlistentry id="libstdc">
598 <term><filename class="libraryfile">libstdc++</filename></term>
600 <para>The standard C++ library</para>
601 <indexterm zone="ch-system-gcc libstdc">
602 <primary sortas="c-libstdc++">libstdc++</primary>
607 <varlistentry id="libstdcfs">
608 <term><filename class="libraryfile">libstdc++fs</filename></term>
610 <para>ISO/IEC TS 18822:2015 Filesystem library</para>
611 <indexterm zone="ch-system-gcc libstdcfs">
612 <primary sortas="c-libstdc++fs">libstdc++fs</primary>
617 <varlistentry id="libsupc">
618 <term><filename class="libraryfile">libsupc++</filename></term>
620 <para>Provides supporting routines for the C++ programming
622 <indexterm zone="ch-system-gcc libsupc">
623 <primary sortas="c-libsupc++">libsupc++</primary>
628 <varlistentry id="libtsan">
629 <term><filename class="libraryfile">libtsan</filename></term>
631 <para>The Thread Sanitizer runtime library</para>
632 <indexterm zone="ch-system-gcc libtsan">
633 <primary sortas="c-libtsan">libtsan</primary>
638 <varlistentry id="libubsan">
639 <term><filename class="libraryfile">libubsan</filename></term>
641 <para>The Undefined Behavior Sanitizer runtime library</para>
642 <indexterm zone="ch-system-gcc libubsan">
643 <primary sortas="c-libubsan">libubsan</primary>