source: chapter08/gcc.xml@ 8e9d4bf

arm
Last change on this file since 8e9d4bf was 0567d85, checked in by William Harrington <kb0iic@…>, 2 years ago

gcc-12: update test status

The analyzer tests fixed at https://gcc.gnu.org/r12-7119.

The PR100400 status is discussed in the thread started with
https://gcc.gnu.org/pipermail/gcc-patches/2022-May/593931.html.

  • Property mode set to 100644
File size: 22.7 KB
Line 
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">
5 %general-entities;
6]>
7
8<sect1 id="ch-system-gcc" role="wrap">
9 <?dbhtml filename="gcc.html"?>
10
11 <sect1info condition="script">
12 <productname>gcc</productname>
13 <productnumber>&gcc-version;</productnumber>
14 <address>&gcc-url;</address>
15 </sect1info>
16
17 <title>GCC-&gcc-version;</title>
18
19 <indexterm zone="ch-system-gcc">
20 <primary sortas="a-GCC">GCC</primary>
21 </indexterm>
22
23 <sect2 role="package">
24 <title/>
25
26 <para>The GCC package contains the GNU compiler collection, which includes
27 the C and C++ compilers.</para>
28
29 <segmentedlist>
30 <segtitle>&buildtime;</segtitle>
31 <segtitle>&diskspace;</segtitle>
32
33 <seglistitem>
34 <seg>&gcc-fin-sbu;</seg>
35 <seg>&gcc-fin-du;</seg>
36 </seglistitem>
37 </segmentedlist>
38
39 </sect2>
40
41 <sect2 role="installation">
42 <title>Installation of GCC</title>
43<!--
44 <para>At first, fix an issue breaking
45 <filename class="libraryfile">libasan.a</filename> building this package
46 with Glibc-2.34 or later:</para>
47
48<screen><userinput remap="pre">sed -e '/static.*SIGSTKSZ/d' \
49 -e 's/return kAltStackSize/return SIGSTKSZ * 4/' \
50 -i libsanitizer/sanitizer_common/sanitizer_posix_libcdep.cpp</userinput></screen>
51-->
52 <para>If building on aarch64, change the default directory name for 64-bit
53 libraries to <quote>lib</quote>:</para>
54
55<screen><userinput remap="pre">case $(uname -m) in
56 aarch64)
57 sed -e '/mabi.lp64=/s/lib64/lib/' \
58 -i.orig gcc/config/aarch64/t-aarch64-linux
59 ;;
60esac</userinput></screen>
61
62 <para>The GCC documentation recommends building GCC in a dedicated build directory:</para>
63
64<screen><userinput remap="pre">mkdir -v build
65cd build</userinput></screen>
66
67 <para>Prepare GCC for compilation:</para>
68
69<screen><userinput remap="configure">../configure --prefix=/usr \
70 LD=ld \
71 --enable-languages=c,c++ \
72 --disable-multilib \
73 --disable-bootstrap \
74 --with-system-zlib</userinput></screen>
75
76 <para>Note that for other programming languages there are some prerequisites that
77 are not yet available. See the
78 <ulink url="&blfs-book;general/gcc.html">BLFS Book GCC page</ulink>
79 for instructions on how to build all of GCC's supported languages.</para>
80
81 <variablelist>
82 <title>The meaning of the new configure parameters:</title>
83
84 <varlistentry>
85 <term><parameter>LD=ld</parameter></term>
86 <listitem>
87 <para>This parameter makes the configure script use the ld installed
88 by the binutils built earlier in this chapter, rather than
89 the cross-built version which would otherwise be used.</para>
90 </listitem>
91 </varlistentry>
92
93 <varlistentry>
94 <term><parameter>--with-system-zlib</parameter></term>
95 <listitem>
96 <para>This switch tells GCC to link to the system installed copy of
97 the zlib library, rather than its own internal copy.</para>
98 </listitem>
99 </varlistentry>
100 </variablelist>
101
102 <para>Compile the package:</para>
103
104<screen><userinput remap="make">make</userinput></screen>
105
106 <important>
107 <para>In this section, the test suite for GCC is considered
108 important, but it takes a long time. First time builders are
109 encouraged to not skip it. The time to run the tests can be
110 reduced significantly by adding -jx to the make command below
111 where x is the number of cores on your system.</para>
112 </important>
113
114 <para>One set of tests in the GCC test suite is known to exhaust the default
115 stack, so increase the stack size prior to running the tests:</para>
116
117<screen><userinput remap="test">ulimit -s 32768</userinput></screen>
118
119 <para>Test the results as a non-privileged user, but do not stop at errors:</para>
120
121<screen><userinput remap="test">chown -Rv tester .
122su tester -c "PATH=$PATH make -k check"</userinput></screen>
123
124 <para>To receive a summary of the test suite results, run:</para>
125
126<screen><userinput remap="test">../contrib/test_summary</userinput></screen>
127
128 <para>For only the summaries, pipe the output through
129 <userinput>grep -A7 Summ</userinput>.</para>
130
131 <para>Results can be compared with those located at <ulink
132 url="&test-results;"/> and
133 <ulink url="https://gcc.gnu.org/ml/gcc-testresults/"/>.</para>
134
135 <para>In g++, four tests related to PR100400 are known to be reported
136 as both XPASS and FAIL. It's because the test file for this known issue
137 is not well written.</para>
138
139 <para>A few unexpected failures cannot always be avoided. The GCC developers
140 are usually aware of these issues, but have not resolved them yet.
141 Unless the test results are vastly different from those at the above URL,
142 it is safe to continue.</para>
143
144 <!--note><para>
145 On some combinations of kernel configuration and AMD processors
146 there may be more than 1100 failures in the gcc.target/i386/mpx
147 tests (which are designed to test the MPX option on recent
148 Intel processors). These can safely be ignored on AMD
149 processors. These tests will also fail on Intel processors if MPX support
150 is not enabled in the kernel even though it is present on the CPU.
151 </para></note-->
152
153 <para>Install the package:</para>
154
155<screen><userinput remap="install">make install</userinput></screen>
156
157 <para>The GCC build directory is owned by <systemitem class="username">
158 tester</systemitem> now and the ownership of the installed header
159 directory (and its content) will be incorrect. Change the ownership to
160 <systemitem class="username">root</systemitem> user and group:</para>
161
162<screen><userinput remap="install">chown -v -R root:root \
163 /usr/lib/gcc/$(gcc -dumpmachine)/&gcc-version;/include{,-fixed}</userinput></screen>
164
165 <para>Create a symlink required by the <ulink
166 url="https://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch03s09.html">FHS</ulink>
167 for "historical" reasons.</para>
168
169<screen><userinput remap="install">ln -svr /usr/bin/cpp /usr/lib</userinput></screen>
170 <!-- already done earlier
171 <para>Many packages use the name <command>cc</command> to call the C
172 compiler. To satisfy those packages, create a symlink:</para>
173
174<screen><userinput remap="install">ln -sv gcc /usr/bin/cc</userinput></screen>
175 -->
176 <para>Add a compatibility symlink to enable building programs with
177 Link Time Optimization (LTO):</para>
178
179<screen><userinput remap="install">ln -sfv ../../libexec/gcc/$(gcc -dumpmachine)/&gcc-version;/liblto_plugin.so \
180 /usr/lib/bfd-plugins/</userinput></screen>
181
182 <para>Now that our final toolchain is in place, it is important to again ensure
183 that compiling and linking will work as expected. We do this by performing
184 some sanity checks:</para>
185
186<screen><userinput>echo 'int main(){}' &gt; dummy.c
187cc dummy.c -v -Wl,--verbose &amp;&gt; dummy.log
188readelf -l a.out | grep ': /lib'</userinput></screen>
189
190 <para>There should be no errors,
191 and the output of the last command will be (allowing for
192 platform-specific differences in the dynamic linker name):</para>
193
194<screen><computeroutput>[Requesting program interpreter: /lib64/ld-linux-aarch64.so.1]</computeroutput></screen>
195
196 <para>Now make sure that we're setup to use the correct start files:</para>
197
198<screen><userinput>grep -o '/usr/lib.*/crt[1in].*succeeded' dummy.log</userinput></screen>
199
200 <para>The output of the last command should be:</para>
201
202<screen><computeroutput>/usr/lib/gcc/aarch64-unknown-linux-gnu/&gcc-version;/../../../../lib/crt1.o succeeded
203/usr/lib/gcc/aarch64-unknown-linux-gnu/&gcc-version;/../../../../lib/crti.o succeeded
204/usr/lib/gcc/aarch64-unknown-linux-gnu/&gcc-version;/../../../../lib/crtn.o succeeded</computeroutput></screen>
205
206 <para>Depending on your machine architecture, the above may differ slightly.
207 The difference will be the name of the directory
208 after <filename class="directory">/usr/lib/gcc</filename>. The important
209 thing to look for here is that <command>gcc</command> has found all three
210 <filename>crt*.o</filename> files under the
211 <filename class="directory">/usr/lib</filename> directory.</para>
212
213 <para>Verify that the compiler is searching for the correct header
214 files:</para>
215
216<screen><userinput>grep -B4 '^ /usr/include' dummy.log</userinput></screen>
217
218 <para>This command should return the following output:</para>
219
220<screen><computeroutput>#include &lt;...&gt; search starts here:
221 /usr/lib/gcc/aarch64-unknown-linux-gnu/&gcc-version;/include
222 /usr/local/include
223 /usr/lib/gcc/aarch64-unknown-linux-gnu/&gcc-version;/include-fixed
224 /usr/include</computeroutput></screen>
225
226 <para>Again, the directory named after your target triplet may be
227 different than the above, depending on your system architecture.</para>
228
229 <para>Next, verify that the new linker is being used with the correct search paths:</para>
230
231<screen><userinput>grep 'SEARCH.*/usr/lib' dummy.log |sed 's|; |\n|g'</userinput></screen>
232
233 <para>References to paths that have components with '-linux-gnu' should
234 be ignored, but otherwise the output of the last command should be:</para>
235
236<screen><computeroutput>SEARCH_DIR("/usr/aarch64-unknown-linux-gnu/lib64")
237SEARCH_DIR("/usr/local/lib64")
238SEARCH_DIR("/lib64")
239SEARCH_DIR("/usr/lib64")
240SEARCH_DIR("/usr/aarch64-unknown-linux-gnu/lib")
241SEARCH_DIR("/usr/local/lib")
242SEARCH_DIR("/lib")
243SEARCH_DIR("/usr/lib");</computeroutput></screen>
244
245 <para>A 32-bit system may see a few different directories. For example, here
246 is the output from a 32bit ARM machine:</para>
247
248<screen><computeroutput>SEARCH_DIR("/usr/armv6l-unknown-linux-gnueabihf/lib")
249SEARCH_DIR("/usr/local/lib")
250SEARCH_DIR("/lib")
251SEARCH_DIR("/usr/lib");</computeroutput></screen>
252
253 <para>Next make sure that we're using the correct libc:</para>
254
255<screen><userinput>grep "/lib.*/libc.so.6 " dummy.log</userinput></screen>
256
257 <para>The output of the last command should be:</para>
258
259<screen><computeroutput>attempt to open /usr/lib/libc.so.6 succeeded</computeroutput></screen>
260
261 <para>Make sure GCC is using the correct dynamic linker:</para>
262
263<screen><userinput>grep found dummy.log</userinput></screen>
264
265 <para>The output of the last command should be (allowing for
266 platform-specific differences in dynamic linker name):</para>
267
268<screen><computeroutput>found ld-linux-aarch64.so.1 at /usr/lib/ld-linux-aarch64.so.1</computeroutput></screen>
269
270 <para>If the output does not appear as shown above or is not received
271 at all, then something is seriously wrong. Investigate and retrace the
272 steps to find out where the problem is and correct it. <!--The most likely
273 reason is that something went wrong with the specs file adjustment.--> Any
274 issues will need to be resolved before continuing with the process.</para>
275
276 <para>Once everything is working correctly, clean up the test files:</para>
277
278<screen><userinput>rm -v dummy.c a.out dummy.log</userinput></screen>
279
280 <para>Finally, move a misplaced file:</para>
281
282<screen><userinput remap="install">mkdir -pv /usr/share/gdb/auto-load/usr/lib
283mv -v /usr/lib/*gdb.py /usr/share/gdb/auto-load/usr/lib</userinput></screen>
284
285 </sect2>
286
287 <sect2 id="contents-gcc" role="content">
288 <title>Contents of GCC</title>
289
290 <segmentedlist>
291 <segtitle>Installed programs</segtitle>
292 <segtitle>Installed libraries</segtitle>
293 <segtitle>Installed directories</segtitle>
294
295 <seglistitem>
296 <seg>c++, cc (link to gcc), cpp, g++, gcc,
297 gcc-ar, gcc-nm, gcc-ranlib, gcov, gcov-dump, gcov-tool,
298 and lto-dump</seg>
299
300 <seg>libasan.{a,so}, libatomic.{a,so}, libcc1.so, libgcc.a, libgcc_eh.a,
301 libgcc_s.so, libgcov.a, libgomp.{a,so}, libitm.{a,so},
302 liblsan.{a,so}, liblto_plugin.so,
303 libssp.{a,so}, libssp_nonshared.a,
304 libstdc++.{a,so}, libstdc++fs.a, libsupc++.a, libtsan.{a,so},
305 and libubsan.{a,so}</seg>
306
307 <seg>/usr/include/c++, /usr/lib/gcc, /usr/libexec/gcc, and
308 /usr/share/gcc-&gcc-version;</seg>
309 </seglistitem>
310 </segmentedlist>
311
312 <variablelist>
313 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
314 <?dbfo list-presentation="list"?>
315 <?dbhtml list-presentation="table"?>
316
317 <varlistentry id="c">
318 <term><command>c++</command></term>
319 <listitem>
320 <para>The C++ compiler</para>
321 <indexterm zone="ch-system-gcc c">
322 <primary sortas="b-c++">c++</primary>
323 </indexterm>
324 </listitem>
325 </varlistentry>
326
327 <varlistentry id="cc">
328 <term><command>cc</command></term>
329 <listitem>
330 <para>The C compiler</para>
331 <indexterm zone="ch-system-gcc cc">
332 <primary sortas="b-cc">cc</primary>
333 </indexterm>
334 </listitem>
335 </varlistentry>
336
337 <varlistentry id="cpp">
338 <term><command>cpp</command></term>
339 <listitem>
340 <para>The C preprocessor; it is used by the compiler to expand the
341 #include, #define, and similar statements in the source files</para>
342 <indexterm zone="ch-system-gcc cpp">
343 <primary sortas="b-cpp">cpp</primary>
344 </indexterm>
345 </listitem>
346 </varlistentry>
347
348 <varlistentry id="g">
349 <term><command>g++</command></term>
350 <listitem>
351 <para>The C++ compiler</para>
352 <indexterm zone="ch-system-gcc g">
353 <primary sortas="b-g++">g++</primary>
354 </indexterm>
355 </listitem>
356 </varlistentry>
357
358 <varlistentry id="gcc">
359 <term><command>gcc</command></term>
360 <listitem>
361 <para>The C compiler</para>
362 <indexterm zone="ch-system-gcc gcc">
363 <primary sortas="b-gcc">gcc</primary>
364 </indexterm>
365 </listitem>
366 </varlistentry>
367
368 <varlistentry id="gcc-ar">
369 <term><command>gcc-ar</command></term>
370 <listitem>
371 <para>A wrapper around <command>ar</command> that adds a
372 plugin to the command line. This program is only used
373 to add "link time optimization" and is not useful with the
374 default build options</para>
375 <indexterm zone="ch-system-gcc gcc-ar">
376 <primary sortas="b-gcc-ar">gc-ar</primary>
377 </indexterm>
378 </listitem>
379 </varlistentry>
380
381 <varlistentry id="gcc-nm">
382 <term><command>gcc-nm</command></term>
383 <listitem>
384 <para>A wrapper around <command>nm</command> that adds a
385 plugin to the command line. This program is only used
386 to add "link time optimization" and is not useful with the
387 default build options</para>
388 <indexterm zone="ch-system-gcc gcc-nm">
389 <primary sortas="b-gcc-nm">gc-nm</primary>
390 </indexterm>
391 </listitem>
392 </varlistentry>
393
394 <varlistentry id="gcc-ranlib">
395 <term><command>gcc-ranlib</command></term>
396 <listitem>
397 <para>A wrapper around <command>ranlib</command> that adds a
398 plugin to the command line. This program is only used
399 to add "link time optimization" and is not useful with the
400 default build options</para>
401 <indexterm zone="ch-system-gcc gcc-ranlib">
402 <primary sortas="b-gcc-ranlib">gc-ranlib</primary>
403 </indexterm>
404 </listitem>
405 </varlistentry>
406
407 <varlistentry id="gcov">
408 <term><command>gcov</command></term>
409 <listitem>
410 <para>A coverage testing tool; it is used to analyze programs to
411 determine where optimizations will have the most effect</para>
412 <indexterm zone="ch-system-gcc gcov">
413 <primary sortas="b-gcov">gcov</primary>
414 </indexterm>
415 </listitem>
416 </varlistentry>
417
418 <varlistentry id="gcov-dump">
419 <term><command>gcov-dump</command></term>
420 <listitem>
421 <para>Offline gcda and gcno profile dump tool</para>
422 <indexterm zone="ch-system-gcc gcov-dump">
423 <primary sortas="b-gcov-dump">gcov-dump</primary>
424 </indexterm>
425 </listitem>
426 </varlistentry>
427
428 <varlistentry id="gcov-tool">
429 <term><command>gcov-tool</command></term>
430 <listitem>
431 <para>Offline gcda profile processing tool</para>
432 <indexterm zone="ch-system-gcc gcov-tool">
433 <primary sortas="b-gcov-tool">gcov-tool</primary>
434 </indexterm>
435 </listitem>
436 </varlistentry>
437
438 <varlistentry id="lto-dump">
439 <term><command>lto-dump</command></term>
440 <listitem>
441 <para>Tool for dumping object files produced by GCC with LTO
442 enabled</para>
443 <indexterm zone="ch-system-gcc lto-dump">
444 <primary sortas="b-lto-dump">lto-dump</primary>
445 </indexterm>
446 </listitem>
447 </varlistentry>
448
449 <varlistentry id="libasan">
450 <term><filename class="libraryfile">libasan</filename></term>
451 <listitem>
452 <para>The Address Sanitizer runtime library</para>
453 <indexterm zone="ch-system-gcc libasan">
454 <primary sortas="b-libasan">libasan</primary>
455 </indexterm>
456 </listitem>
457 </varlistentry>
458
459 <varlistentry id="libatomic">
460 <term><filename class="libraryfile">libatomic</filename></term>
461 <listitem>
462 <para>GCC atomic built-in runtime library</para>
463 <indexterm zone="ch-system-gcc libatomic">
464 <primary sortas="b-libatomic">libatomic</primary>
465 </indexterm>
466 </listitem>
467 </varlistentry>
468
469 <varlistentry id="libcc1">
470 <term><filename class="libraryfile">libcc1</filename></term>
471 <listitem>
472 <para>The C preprocessing library</para>
473 <indexterm zone="ch-system-gcc libcc1">
474 <primary sortas="b-libcc1">libcc1</primary>
475 </indexterm>
476 </listitem>
477 </varlistentry>
478
479 <varlistentry id="libgcc">
480 <term><filename class="libraryfile">libgcc</filename></term>
481 <listitem>
482 <para>Contains run-time support for <command>gcc</command></para>
483 <indexterm zone="ch-system-gcc libgcc">
484 <primary sortas="c-libgcc">libgcc</primary>
485 </indexterm>
486 </listitem>
487 </varlistentry>
488
489 <varlistentry id="libgcov">
490 <term><filename class="libraryfile">libgcov</filename></term>
491 <listitem>
492 <para>This library is linked in to a program when GCC is instructed
493 to enable profiling</para>
494 <indexterm zone="ch-system-gcc libgcov">
495 <primary sortas="c-libgcov">libgcov</primary>
496 </indexterm>
497 </listitem>
498 </varlistentry>
499
500 <varlistentry id="libgomp">
501 <term><filename class="libraryfile">libgomp</filename></term>
502 <listitem>
503 <para>GNU implementation of the OpenMP API for multi-platform
504 shared-memory parallel programming in C/C++ and Fortran</para>
505 <indexterm zone="ch-system-gcc libgomp">
506 <primary sortas="c-libgomp">libgomp</primary>
507 </indexterm>
508 </listitem>
509 </varlistentry>
510
511 <varlistentry id="libitm">
512 <term><filename class="libraryfile">libitm</filename></term>
513 <listitem>
514 <para>The GNU transactional memory library</para>
515 <indexterm zone="ch-system-gcc libitm">
516 <primary sortas="c-libitm">libitm</primary>
517 </indexterm>
518 </listitem>
519 </varlistentry>
520
521 <varlistentry id="liblsan">
522 <term><filename class="libraryfile">liblsan</filename></term>
523 <listitem>
524 <para>The Leak Sanitizer runtime library</para>
525 <indexterm zone="ch-system-gcc liblsan">
526 <primary sortas="c-liblsan">liblsan</primary>
527 </indexterm>
528 </listitem>
529 </varlistentry>
530
531 <varlistentry id="liblto_plugin">
532 <term><filename class="libraryfile">liblto_plugin</filename></term>
533 <listitem>
534 <para>GCC's LTO plugin allows binutils to process object files
535 produced by GCC with LTO enabled</para>
536 <indexterm zone="ch-system-gcc liblto_plugin">
537 <primary sortas="c-liblto_plugin">liblto_plugin</primary>
538 </indexterm>
539 </listitem>
540 </varlistentry>
541
542 <varlistentry id="libquadmath">
543 <term><filename class="libraryfile">libquadmath</filename></term>
544 <listitem>
545 <para>GCC Quad Precision Math Library API</para>
546 <indexterm zone="ch-system-gcc libquadmath">
547 <primary sortas="c-libquadmath">libquadmath</primary>
548 </indexterm>
549 </listitem>
550 </varlistentry>
551
552 <varlistentry id="libssp">
553 <term><filename class="libraryfile">libssp</filename></term>
554 <listitem>
555 <para>Contains routines supporting GCC's stack-smashing protection
556 functionality</para>
557 <indexterm zone="ch-system-gcc libssp">
558 <primary sortas="c-libssp">libssp</primary>
559 </indexterm>
560 </listitem>
561 </varlistentry>
562
563 <varlistentry id="libstdc">
564 <term><filename class="libraryfile">libstdc++</filename></term>
565 <listitem>
566 <para>The standard C++ library</para>
567 <indexterm zone="ch-system-gcc libstdc">
568 <primary sortas="c-libstdc++">libstdc++</primary>
569 </indexterm>
570 </listitem>
571 </varlistentry>
572
573 <varlistentry id="libstdcfs">
574 <term><filename class="libraryfile">libstdc++fs</filename></term>
575 <listitem>
576 <para>ISO/IEC TS 18822:2015 Filesystem library</para>
577 <indexterm zone="ch-system-gcc libstdcfs">
578 <primary sortas="c-libstdc++fs">libstdc++fs</primary>
579 </indexterm>
580 </listitem>
581 </varlistentry>
582
583 <varlistentry id="libsupc">
584 <term><filename class="libraryfile">libsupc++</filename></term>
585 <listitem>
586 <para>Provides supporting routines for the C++ programming
587 language</para>
588 <indexterm zone="ch-system-gcc libsupc">
589 <primary sortas="c-libsupc++">libsupc++</primary>
590 </indexterm>
591 </listitem>
592 </varlistentry>
593
594 <varlistentry id="libtsan">
595 <term><filename class="libraryfile">libtsan</filename></term>
596 <listitem>
597 <para>The Thread Sanitizer runtime library</para>
598 <indexterm zone="ch-system-gcc libtsan">
599 <primary sortas="c-libtsan">libtsan</primary>
600 </indexterm>
601 </listitem>
602 </varlistentry>
603
604 <varlistentry id="libubsan">
605 <term><filename class="libraryfile">libubsan</filename></term>
606 <listitem>
607 <para>The Undefined Behavior Sanitizer runtime library</para>
608 <indexterm zone="ch-system-gcc libubsan">
609 <primary sortas="c-libubsan">libubsan</primary>
610 </indexterm>
611 </listitem>
612 </varlistentry>
613
614 </variablelist>
615
616 </sect2>
617
618</sect1>
Note: See TracBrowser for help on using the repository browser.