gcc.xml 20 KB

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