gcc.xml 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544
  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. <sect1 id="ch-system-gcc" role="wrap">
  8. <?dbhtml filename="gcc.html"?>
  9. <sect1info condition="script">
  10. <productname>gcc</productname>
  11. <productnumber>&gcc-version;</productnumber>
  12. <address>&gcc-url;</address>
  13. </sect1info>
  14. <title>GCC-&gcc-version;</title>
  15. <indexterm zone="ch-system-gcc">
  16. <primary sortas="a-GCC">GCC</primary>
  17. </indexterm>
  18. <sect2 role="package">
  19. <title/>
  20. <para>The GCC package contains the GNU compiler collection, which includes
  21. the C and C++ compilers.</para>
  22. <segmentedlist>
  23. <segtitle>&buildtime;</segtitle>
  24. <segtitle>&diskspace;</segtitle>
  25. <seglistitem>
  26. <seg>&gcc-ch6-sbu;</seg>
  27. <seg>&gcc-ch6-du;</seg>
  28. </seglistitem>
  29. </segmentedlist>
  30. </sect2>
  31. <sect2 role="installation">
  32. <title>Installation of GCC</title>
  33. <!--
  34. <para>First apply some fixes from the upstream repository:</para>
  35. <screen><userinput remap="pre">patch -Np1 -i ../&gcc-upstream-patch;</userinput></screen>
  36. -->
  37. <para>The GCC documentation recommends building GCC outside of the source
  38. directory in a dedicated build directory:</para>
  39. <screen><userinput remap="pre">mkdir -v ../gcc-build
  40. cd ../gcc-build</userinput></screen>
  41. <para>Prepare GCC for compilation:</para>
  42. <screen><userinput remap="configure">SED=sed \
  43. ../gcc-&gcc-version;/configure \
  44. --prefix=/usr \
  45. --enable-languages=c,c++ \
  46. --disable-multilib \
  47. --disable-bootstrap \
  48. --with-system-zlib</userinput></screen>
  49. <para>Note that for other languages, there are some prerequisites that
  50. are not yet available. See the
  51. <ulink url="&blfs-book;general/gcc.html">BLFS Book</ulink>
  52. for instructions on how to build all of GCC's supported languages.</para>
  53. <variablelist>
  54. <title>The meaning of the new configure option:</title>
  55. <varlistentry>
  56. <term><envar>SED=sed</envar></term>
  57. <listitem>
  58. <para>Setting this environment variable prevents a hard-coded
  59. path to /tools/bin/sed.</para>
  60. </listitem>
  61. </varlistentry>
  62. <varlistentry>
  63. <term><parameter>--with-system-zlib</parameter></term>
  64. <listitem>
  65. <para>This switch tells GCC to link to the system installed copy of
  66. the Zlib library, rather than its own internal copy.</para>
  67. </listitem>
  68. </varlistentry>
  69. </variablelist>
  70. <para>Compile the package:</para>
  71. <screen><userinput remap="make">make</userinput></screen>
  72. <important>
  73. <para>In this section, the test suite for GCC is considered
  74. critical. Do not skip it under any circumstance.</para>
  75. </important>
  76. <para>One set of tests in the GCC test suite is known to exhaust the stack,
  77. so increase the stack size prior to running the tests:</para>
  78. <screen><userinput remap="test">ulimit -s 32768</userinput></screen>
  79. <para>Test the results, but do not stop at errors:</para>
  80. <screen><userinput remap="test">make -k check</userinput></screen>
  81. <para>To receive a summary of the test suite results, run:</para>
  82. <screen><userinput remap="test">../gcc-&gcc-version;/contrib/test_summary</userinput></screen>
  83. <para>For only the summaries, pipe the output through
  84. <userinput>grep -A7 Summ</userinput>.</para>
  85. <para>Results can be compared with those located at <ulink
  86. url="&test-results;"/> and <ulink url="http://gcc.gnu.org/ml/gcc-testresults/"/>.</para>
  87. <para>A few unexpected failures cannot always be avoided. The GCC developers
  88. are usually aware of these issues, but have not resolved them yet.
  89. In particular, one test in the libgomp test suite is known to fail.
  90. Unless the test results are vastly different from those at the above URL,
  91. it is safe to continue.</para>
  92. <para>Install the package:</para>
  93. <screen><userinput remap="install">make install</userinput></screen>
  94. <para>Some packages expect the C preprocessor to be installed in the
  95. <filename class="directory">/lib</filename> directory.
  96. To support those packages, create this symlink:</para>
  97. <screen><userinput remap="install">ln -sv ../usr/bin/cpp /lib</userinput></screen>
  98. <para>Many packages use the name <command>cc</command> to call the C
  99. compiler. To satisfy those packages, create a symlink:</para>
  100. <screen><userinput remap="install">ln -sv gcc /usr/bin/cc</userinput></screen>
  101. <para>Add a compatibility symlink to enable building programs with
  102. Link Time Optimization (LTO):</para>
  103. <screen><userinput remap="install">install -v -dm755 /usr/lib/bfd-plugins
  104. ln -sfv ../../libexec/gcc/$(gcc -dumpmachine)/&gcc-version;/liblto_plugin.so /usr/lib/bfd-plugins/</userinput></screen>
  105. <para>Now that our final toolchain is in place, it is important to again ensure
  106. that compiling and linking will work as expected. We do this by performing
  107. the same sanity checks as we did earlier in the chapter:</para>
  108. <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
  109. href="adjusting.xml"
  110. xpointer="xpointer(//*[@os='a'])"/>
  111. <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
  112. href="adjusting.xml"
  113. xpointer="xpointer(//*[@os='b'])"/>
  114. <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
  115. href="adjusting.xml"
  116. xpointer="xpointer(//*[@os='c'])"/>
  117. <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
  118. href="adjusting.xml"
  119. xpointer="xpointer(//*[@os='d'])"/>
  120. <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
  121. href="adjusting.xml"
  122. xpointer="xpointer(//*[@os='e'])"/>
  123. <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
  124. href="adjusting.xml"
  125. xpointer="xpointer(//*[@os='f'])"/>
  126. <screen><computeroutput>/usr/lib/gcc/i686-pc-linux-gnu/&gcc-version;/../../../crt1.o succeeded
  127. /usr/lib/gcc/i686-pc-linux-gnu/&gcc-version;/../../../crti.o succeeded
  128. /usr/lib/gcc/i686-pc-linux-gnu/&gcc-version;/../../../crtn.o succeeded</computeroutput></screen>
  129. <para>Depending on your machine architecture, the above may differ slightly,
  130. the difference usually being the name of the directory
  131. after <filename class="directory">/usr/lib/gcc</filename>. If your machine is
  132. a 64-bit system, you may also see a directory named <filename class="directory">lib64</filename>
  133. towards the end of the string. The important thing to
  134. look for here is that <command>gcc</command> has found all three
  135. <filename>crt*.o</filename> files under the
  136. <filename class="directory">/usr/lib</filename> directory.</para>
  137. <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
  138. href="adjusting.xml"
  139. xpointer="xpointer(//*[@os='g'])"/>
  140. <screen><userinput>grep -B4 '^ /usr/include' dummy.log</userinput></screen>
  141. <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
  142. href="adjusting.xml"
  143. xpointer="xpointer(//*[@os='h'])"/>
  144. <screen><computeroutput>#include &lt;...&gt; search starts here:
  145. /usr/lib/gcc/i686-pc-linux-gnu/&gcc-version;/include
  146. /usr/local/include
  147. /usr/lib/gcc/i686-pc-linux-gnu/&gcc-version;/include-fixed
  148. /usr/include</computeroutput></screen>
  149. <para>Again, note that the directory named after your target triplet may be
  150. different than the above, depending on your architecture.</para>
  151. <note><para>As of version 4.3.0, GCC now unconditionally installs the
  152. <filename>limits.h</filename> file into the private
  153. <filename class="directory">include-fixed</filename> directory, and that
  154. directory is required to be in place.</para></note>
  155. <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
  156. href="adjusting.xml"
  157. xpointer="xpointer(//*[@os='i'])"/>
  158. <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
  159. href="adjusting.xml"
  160. xpointer="xpointer(//*[@os='j'])"/>
  161. <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
  162. href="adjusting.xml"
  163. xpointer="xpointer(//*[@os='k'])"/>
  164. <screen><computeroutput>SEARCH_DIR("/usr/i686-pc-linux-gnu/lib32")
  165. SEARCH_DIR("/usr/local/lib32")
  166. SEARCH_DIR("/lib32")
  167. SEARCH_DIR("/usr/lib32")
  168. SEARCH_DIR("/usr/i686-pc-linux-gnu/lib")
  169. SEARCH_DIR("/usr/local/lib")
  170. SEARCH_DIR("/lib")
  171. SEARCH_DIR("/usr/lib");</computeroutput></screen>
  172. <para>A 64-bit system may see a few different directories. For example, here
  173. is the output from an x86_64 machine:</para>
  174. <screen><computeroutput>SEARCH_DIR("/usr/x86_64-unknown-linux-gnu/lib64")
  175. SEARCH_DIR("/usr/local/lib64")
  176. SEARCH_DIR("/lib64")
  177. SEARCH_DIR("/usr/lib64")
  178. SEARCH_DIR("/usr/x86_64-unknown-linux-gnu/lib")
  179. SEARCH_DIR("/usr/local/lib")
  180. SEARCH_DIR("/lib")
  181. SEARCH_DIR("/usr/lib");</computeroutput></screen>
  182. <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
  183. href="adjusting.xml"
  184. xpointer="xpointer(//*[@os='l'])"/>
  185. <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
  186. href="adjusting.xml"
  187. xpointer="xpointer(//*[@os='m'])"/>
  188. <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
  189. href="adjusting.xml"
  190. xpointer="xpointer(//*[@os='n'])"/>
  191. <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
  192. href="adjusting.xml"
  193. xpointer="xpointer(//*[@os='o'])"/>
  194. <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
  195. href="adjusting.xml"
  196. xpointer="xpointer(//*[@os='p'])"/>
  197. <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
  198. href="adjusting.xml"
  199. xpointer="xpointer(//*[@os='q'])"/>
  200. <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
  201. href="adjusting.xml"
  202. xpointer="xpointer(//*[@os='r'])"/>
  203. <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
  204. href="adjusting.xml"
  205. xpointer="xpointer(//*[@os='s'])"/>
  206. <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
  207. href="adjusting.xml"
  208. xpointer="xpointer(//*[@os='t'])"/>
  209. <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
  210. href="adjusting.xml"
  211. xpointer="xpointer(//*[@os='u'])"/>
  212. <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
  213. href="adjusting.xml"
  214. xpointer="xpointer(//*[@os='v'])"/>
  215. <para>Finally, move a misplaced file:</para>
  216. <screen><userinput remap="install">mkdir -pv /usr/share/gdb/auto-load/usr/lib
  217. mv -v /usr/lib/*gdb.py /usr/share/gdb/auto-load/usr/lib</userinput></screen>
  218. </sect2>
  219. <sect2 id="contents-gcc" role="content">
  220. <title>Contents of GCC</title>
  221. <segmentedlist>
  222. <segtitle>Installed programs</segtitle>
  223. <segtitle>Installed libraries</segtitle>
  224. <segtitle>Installed directories</segtitle>
  225. <seglistitem>
  226. <seg>c++, cc (link to gcc), cpp, g++, gcc,
  227. gcc-ar, gcc-nm, gcc-ranlib, and gcov</seg>
  228. <seg>libasan.{a,so}, libatomic.{a,so}, libgcc.a, libgcc_eh.a,
  229. libgcc_s.so, libgcov.a, libgomp.{a,so}, libiberty.a, libitm.{a,so},
  230. liblto_plugin.so,
  231. libquadmath.{a,so}, libssp.{a,so},
  232. libssp_nonshared.a, libstdc++.{a,so}, libsupc++.a, and libtsan.{a,so}</seg>
  233. <seg>/usr/include/c++, /usr/lib/gcc, /usr/libexec/gcc, and
  234. /usr/share/gcc-&gcc-version;</seg>
  235. </seglistitem>
  236. </segmentedlist>
  237. <variablelist>
  238. <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  239. <?dbfo list-presentation="list"?>
  240. <?dbhtml list-presentation="table"?>
  241. <varlistentry id="c">
  242. <term><command>c++</command></term>
  243. <listitem>
  244. <para>The C++ compiler</para>
  245. <indexterm zone="ch-system-gcc c">
  246. <primary sortas="b-c++">c++</primary>
  247. </indexterm>
  248. </listitem>
  249. </varlistentry>
  250. <varlistentry id="cc">
  251. <term><command>cc</command></term>
  252. <listitem>
  253. <para>The C compiler</para>
  254. <indexterm zone="ch-system-gcc cc">
  255. <primary sortas="b-cc">cc</primary>
  256. </indexterm>
  257. </listitem>
  258. </varlistentry>
  259. <varlistentry id="cpp">
  260. <term><command>cpp</command></term>
  261. <listitem>
  262. <para>The C preprocessor; it is used by the compiler to expand the
  263. #include, #define, and similar statements in the source files</para>
  264. <indexterm zone="ch-system-gcc cpp">
  265. <primary sortas="b-cpp">cpp</primary>
  266. </indexterm>
  267. </listitem>
  268. </varlistentry>
  269. <varlistentry id="g">
  270. <term><command>g++</command></term>
  271. <listitem>
  272. <para>The C++ compiler</para>
  273. <indexterm zone="ch-system-gcc g">
  274. <primary sortas="b-g++">g++</primary>
  275. </indexterm>
  276. </listitem>
  277. </varlistentry>
  278. <varlistentry id="gcc">
  279. <term><command>gcc</command></term>
  280. <listitem>
  281. <para>The C compiler</para>
  282. <indexterm zone="ch-system-gcc gcc">
  283. <primary sortas="b-gcc">gcc</primary>
  284. </indexterm>
  285. </listitem>
  286. </varlistentry>
  287. <varlistentry id="gcc-ar">
  288. <term><command>gcc-ar</command></term>
  289. <listitem>
  290. <para>A wrapper around <command>ar</command> that adds a
  291. plugin to the command line. This program is only used
  292. to add "link time optization" and is not useful with the
  293. default build options</para>
  294. <indexterm zone="ch-system-gcc gcc-ar">
  295. <primary sortas="b-gcc-ar">gc-ar</primary>
  296. </indexterm>
  297. </listitem>
  298. </varlistentry>
  299. <varlistentry id="gcc-nm">
  300. <term><command>gcc-nm</command></term>
  301. <listitem>
  302. <para>A wrapper around <command>nm</command> that adds a
  303. plugin to the command line. This program is only used
  304. to add "link time optization" and is not useful with the
  305. default build options</para>
  306. <indexterm zone="ch-system-gcc gcc-nm">
  307. <primary sortas="b-gcc-nm">gc-nm</primary>
  308. </indexterm>
  309. </listitem>
  310. </varlistentry>
  311. <varlistentry id="gcc-ranlib">
  312. <term><command>gcc-ranlib</command></term>
  313. <listitem>
  314. <para>A wrapper around <command>ranlib</command> that adds a
  315. plugin to the command line. This program is only used
  316. to add "link time optization" and is not useful with the
  317. default build options</para>
  318. <indexterm zone="ch-system-gcc gcc-ranlib">
  319. <primary sortas="b-gcc-ranlib">gc-ranlib</primary>
  320. </indexterm>
  321. </listitem>
  322. </varlistentry>
  323. <varlistentry id="gcov">
  324. <term><command>gcov</command></term>
  325. <listitem>
  326. <para>A coverage testing tool; it is used to analyze programs to
  327. determine where optimizations will have the most effect</para>
  328. <indexterm zone="ch-system-gcc gcov">
  329. <primary sortas="b-gcov">gcov</primary>
  330. </indexterm>
  331. </listitem>
  332. </varlistentry>
  333. <varlistentry id="libasan">
  334. <term><command>libasan</command></term>
  335. <listitem>
  336. <para>The Address Sanitizer runtime library</para>
  337. <indexterm zone="ch-system-gcc libasan">
  338. <primary sortas="b-libasan">libasan</primary>
  339. </indexterm>
  340. </listitem>
  341. </varlistentry>
  342. <varlistentry id="libgcc">
  343. <term><filename class="libraryfile">libgcc</filename></term>
  344. <listitem>
  345. <para>Contains run-time support for <command>gcc</command></para>
  346. <indexterm zone="ch-system-gcc libgcc">
  347. <primary sortas="c-libgcc">libgcc</primary>
  348. </indexterm>
  349. </listitem>
  350. </varlistentry>
  351. <varlistentry id="libgcov">
  352. <term><filename class="libraryfile">libgcov</filename></term>
  353. <listitem>
  354. <para>This library is linked in to a program when GCC is instructed
  355. to enable profiling</para>
  356. <indexterm zone="ch-system-gcc libgcov">
  357. <primary sortas="c-libgcov">libgcov</primary>
  358. </indexterm>
  359. </listitem>
  360. </varlistentry>
  361. <varlistentry id="libgomp">
  362. <term><filename class="libraryfile">libgomp</filename></term>
  363. <listitem>
  364. <para>GNU implementation of the OpenMP API for multi-platform
  365. shared-memory parallel programming in C/C++ and Fortran</para>
  366. <indexterm zone="ch-system-gcc libgomp">
  367. <primary sortas="c-libgomp">libgomp</primary>
  368. </indexterm>
  369. </listitem>
  370. </varlistentry>
  371. <varlistentry id="libiberty">
  372. <term><filename class="libraryfile">libiberty</filename></term>
  373. <listitem>
  374. <para>Contains routines used by various GNU programs, including
  375. <command>getopt</command>, <command>obstack</command>,
  376. <command>strerror</command>, <command>strtol</command>, and
  377. <command>strtoul</command></para>
  378. <indexterm zone="ch-system-gcc libiberty">
  379. <primary sortas="c-libiberty">libiberty</primary>
  380. </indexterm>
  381. </listitem>
  382. </varlistentry>
  383. <varlistentry id="liblto_plugin">
  384. <term><filename class="libraryfile">liblto_plugin</filename></term>
  385. <listitem>
  386. <para>GCC's Link Time Optimization (LTO) plugin allows GCC to perform
  387. optimizations across compilation units</para>
  388. <indexterm zone="ch-system-gcc liblto_plugin">
  389. <primary sortas="c-liblto_plugin">liblto_plugin</primary>
  390. </indexterm>
  391. </listitem>
  392. </varlistentry>
  393. <varlistentry id="libquadmath">
  394. <term><filename class="libraryfile">libquadmath</filename></term>
  395. <listitem>
  396. <para>GCC Quad Precision Math Library API</para>
  397. <indexterm zone="ch-system-gcc libquadmath">
  398. <primary sortas="c-libquadmath">libquadmath</primary>
  399. </indexterm>
  400. </listitem>
  401. </varlistentry>
  402. <varlistentry id="libssp">
  403. <term><filename class="libraryfile">libssp</filename></term>
  404. <listitem>
  405. <para>Contains routines supporting GCC's stack-smashing protection
  406. functionality</para>
  407. <indexterm zone="ch-system-gcc libssp">
  408. <primary sortas="c-libssp">libssp</primary>
  409. </indexterm>
  410. </listitem>
  411. </varlistentry>
  412. <varlistentry id="libstdc">
  413. <term><filename class="libraryfile">libstdc++</filename></term>
  414. <listitem>
  415. <para>The standard C++ library</para>
  416. <indexterm zone="ch-system-gcc libstdc">
  417. <primary sortas="c-libstdc++">libstdc++</primary>
  418. </indexterm>
  419. </listitem>
  420. </varlistentry>
  421. <varlistentry id="libsupc">
  422. <term><filename class="libraryfile">libsupc++</filename></term>
  423. <listitem>
  424. <para>Provides supporting routines for the C++ programming
  425. language</para>
  426. <indexterm zone="ch-system-gcc libsupc">
  427. <primary sortas="c-libsupc++">libsupc++</primary>
  428. </indexterm>
  429. </listitem>
  430. </varlistentry>
  431. <varlistentry id="libtsan">
  432. <term><filename class="libraryfile">libtsan</filename></term>
  433. <listitem>
  434. <para>The Thread Sanitizer runtime library</para>
  435. <indexterm zone="ch-system-gcc libtsan">
  436. <primary sortas="c-libtsan">libtsan</primary>
  437. </indexterm>
  438. </listitem>
  439. </varlistentry>
  440. </variablelist>
  441. </sect2>
  442. </sect1>