1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<!-- Copyright (C) 1988-2020 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 6.5, http://www.gnu.org/software/texinfo/ --> 23<head> 24<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 25<title>Prerequisites for GCC</title> 26 27<meta name="description" content="Prerequisites for GCC"> 28<meta name="keywords" content="Prerequisites for GCC"> 29<meta name="resource-type" content="document"> 30<meta name="distribution" content="global"> 31<meta name="Generator" content="makeinfo"> 32<style type="text/css"> 33<!-- 34a.summary-letter {text-decoration: none} 35blockquote.indentedblock {margin-right: 0em} 36blockquote.smallindentedblock {margin-right: 0em; font-size: smaller} 37blockquote.smallquotation {font-size: smaller} 38div.display {margin-left: 3.2em} 39div.example {margin-left: 3.2em} 40div.lisp {margin-left: 3.2em} 41div.smalldisplay {margin-left: 3.2em} 42div.smallexample {margin-left: 3.2em} 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.nolinebreak {white-space: nowrap} 54span.roman {font-family: initial; font-weight: normal} 55span.sansserif {font-family: sans-serif; font-weight: normal} 56ul.no-bullet {list-style: none} 57--> 58</style> 59 60 61</head> 62 63<body lang="en"> 64<h1 class="settitle" align="center">Prerequisites for GCC</h1> 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82<a name="index-Prerequisites"></a> 83 84<p>GCC requires that various tools and packages be available for use in the 85build procedure. Modifying GCC sources requires additional tools 86described below. 87</p> 88<a name="Tools_002fpackages-necessary-for-building-GCC"></a> 89<h3 class="heading">Tools/packages necessary for building GCC</h3> 90<dl compact="compact"> 91<dt>ISO C++98 compiler</dt> 92<dd><p>Necessary to bootstrap GCC, although versions of GCC prior 93to 4.8 also allow bootstrapping with a ISO C89 compiler and versions 94of GCC prior to 3.4 also allow bootstrapping with a traditional 95(K&R) C compiler. 96</p> 97<p>To build all languages in a cross-compiler or other configuration where 983-stage bootstrap is not performed, you need to start with an existing 99GCC binary (version 3.4 or later) because source code for language 100frontends other than C might use GCC extensions. 101</p> 102<p>Note that to bootstrap GCC with versions of GCC earlier than 3.4, you 103may need to use <samp>--disable-stage1-checking</samp>, though 104bootstrapping the compiler with such earlier compilers is strongly 105discouraged. 106</p> 107</dd> 108<dt>C standard library and headers</dt> 109<dd> 110<p>In order to build GCC, the C standard library and headers must be present 111for all target variants for which target libraries will be built (and not 112only the variant of the host C++ compiler). 113</p> 114<p>This affects the popular ‘<samp>x86_64-pc-linux-gnu</samp>’ platform (among 115other multilib targets), for which 64-bit (‘<samp>x86_64</samp>’) and 32-bit 116(‘<samp>i386</samp>’) libc headers are usually packaged separately. If you do a 117build of a native compiler on ‘<samp>x86_64-pc-linux-gnu</samp>’, make sure you 118either have the 32-bit libc developer package properly installed (the exact 119name of the package depends on your distro) or you must build GCC as a 12064-bit only compiler by configuring with the option 121<samp>--disable-multilib</samp>. Otherwise, you may encounter an error such as 122‘<samp>fatal error: gnu/stubs-32.h: No such file</samp>’ 123</p> 124</dd> 125<dt><a name="GNAT-prerequisite"></a>GNAT</dt> 126<dd> 127<p>In order to build GNAT, the Ada compiler, you need a working GNAT 128compiler (GCC version 4.7 or later). 129</p> 130<p>This includes GNAT tools such as <code>gnatmake</code> and 131<code>gnatlink</code>, since the Ada front end is written in Ada and 132uses some GNAT-specific extensions. 133</p> 134<p>In order to build a cross compiler, it is strongly recommended to install 135the new compiler as native first, and then use it to build the cross 136compiler. Other native compiler versions may work but this is not guaranteed and 137will typically fail with hard to understand compilation errors during the 138build. 139</p> 140<p>Similarly, it is strongly recommended to use an older version of GNAT to build 141GNAT. More recent versions of GNAT than the version built are not guaranteed 142to work and will often fail during the build with compilation errors. 143</p> 144<p>Note that <code>configure</code> does not test whether the GNAT installation works 145and has a sufficiently recent version; if too old a GNAT version is 146installed and <samp>--enable-languages=ada</samp> is used, the build will fail. 147</p> 148<p><code>ADA_INCLUDE_PATH</code> and <code>ADA_OBJECT_PATH</code> environment variables 149must not be set when building the Ada compiler, the Ada tools, or the 150Ada runtime libraries. You can check that your build environment is clean 151by verifying that ‘<samp>gnatls -v</samp>’ lists only one explicit path in each 152section. 153</p> 154</dd> 155<dt>A “working” POSIX compatible shell, or GNU bash</dt> 156<dd> 157<p>Necessary when running <code>configure</code> because some 158<code>/bin/sh</code> shells have bugs and may crash when configuring the 159target libraries. In other cases, <code>/bin/sh</code> or <code>ksh</code> 160have disastrous corner-case performance problems. This 161can cause target <code>configure</code> runs to literally take days to 162complete in some cases. 163</p> 164<p>So on some platforms <code>/bin/ksh</code> is sufficient, on others it 165isn’t. See the host/target specific instructions for your platform, or 166use <code>bash</code> to be sure. Then set <code>CONFIG_SHELL</code> in your 167environment to your “good” shell prior to running 168<code>configure</code>/<code>make</code>. 169</p> 170<p><code>zsh</code> is not a fully compliant POSIX shell and will not 171work when configuring GCC. 172</p> 173</dd> 174<dt>A POSIX or SVR4 awk</dt> 175<dd> 176<p>Necessary for creating some of the generated source files for GCC. 177If in doubt, use a recent GNU awk version, as some of the older ones 178are broken. GNU awk version 3.1.5 is known to work. 179</p> 180</dd> 181<dt>GNU binutils</dt> 182<dd> 183<p>Necessary in some circumstances, optional in others. See the 184host/target specific instructions for your platform for the exact 185requirements. 186</p> 187</dd> 188<dt>gzip version 1.2.4 (or later) or</dt> 189<dt>bzip2 version 1.0.2 (or later)</dt> 190<dd> 191<p>Necessary to uncompress GCC <code>tar</code> files when source code is 192obtained via HTTPS mirror sites. 193</p> 194</dd> 195<dt>GNU make version 3.80 (or later)</dt> 196<dd> 197<p>You must have GNU make installed to build GCC. 198</p> 199</dd> 200<dt>GNU tar version 1.14 (or later)</dt> 201<dd> 202<p>Necessary (only on some platforms) to untar the source code. Many 203systems’ <code>tar</code> programs will also work, only try GNU 204<code>tar</code> if you have problems. 205</p> 206</dd> 207<dt>Perl version between 5.6.1 and 5.6.24</dt> 208<dd> 209<p>Necessary when targeting Darwin, building ‘<samp>libstdc++</samp>’, 210and not using <samp>--disable-symvers</samp>. 211Necessary when targeting Solaris 2 with Solaris <code>ld</code> and not using 212<samp>--disable-symvers</samp>. 213</p> 214<p>Necessary when regenerating <samp>Makefile</samp> dependencies in libiberty. 215Necessary when regenerating <samp>libiberty/functions.texi</samp>. 216Necessary when generating manpages from Texinfo manuals. 217Used by various scripts to generate some files included in the source 218repository (mainly Unicode-related and rarely changing) from source 219tables. 220</p> 221<p>Used by <code>automake</code>. 222</p> 223</dd> 224</dl> 225 226<p>Several support libraries are necessary to build GCC, some are required, 227others optional. While any sufficiently new version of required tools 228usually work, library requirements are generally stricter. Newer 229versions may work in some cases, but it’s safer to use the exact 230versions documented. We appreciate bug reports about problems with 231newer versions, though. If your OS vendor provides packages for the 232support libraries then using those packages may be the simplest way to 233install the libraries. 234</p> 235<dl compact="compact"> 236<dt>GNU Multiple Precision Library (GMP) version 4.3.2 (or later)</dt> 237<dd> 238<p>Necessary to build GCC. If a GMP source distribution is found in a 239subdirectory of your GCC sources named <samp>gmp</samp>, it will be built 240together with GCC. Alternatively, if GMP is already installed but it 241is not in your library search path, you will have to configure with the 242<samp>--with-gmp</samp> configure option. See also <samp>--with-gmp-lib</samp> 243and <samp>--with-gmp-include</samp>. 244The in-tree build is only supported with the GMP version that 245download_prerequisites installs. 246</p> 247</dd> 248<dt>MPFR Library version 3.1.0 (or later)</dt> 249<dd> 250<p>Necessary to build GCC. It can be downloaded from 251<a href="https://www.mpfr.org">https://www.mpfr.org</a>. If an MPFR source distribution is found 252in a subdirectory of your GCC sources named <samp>mpfr</samp>, it will be 253built together with GCC. Alternatively, if MPFR is already installed 254but it is not in your default library search path, the 255<samp>--with-mpfr</samp> configure option should be used. See also 256<samp>--with-mpfr-lib</samp> and <samp>--with-mpfr-include</samp>. 257The in-tree build is only supported with the MPFR version that 258download_prerequisites installs. 259</p> 260</dd> 261<dt>MPC Library version 1.0.1 (or later)</dt> 262<dd> 263<p>Necessary to build GCC. It can be downloaded from 264<a href="http://www.multiprecision.org/mpc/">http://www.multiprecision.org/mpc/</a>. If an MPC source distribution 265is found in a subdirectory of your GCC sources named <samp>mpc</samp>, it 266will be built together with GCC. Alternatively, if MPC is already 267installed but it is not in your default library search path, the 268<samp>--with-mpc</samp> configure option should be used. See also 269<samp>--with-mpc-lib</samp> and <samp>--with-mpc-include</samp>. 270The in-tree build is only supported with the MPC version that 271download_prerequisites installs. 272</p> 273</dd> 274<dt>isl Library version 0.15 or later.</dt> 275<dd> 276<p>Necessary to build GCC with the Graphite loop optimizations. 277It can be downloaded from <a href="https://gcc.gnu.org/pub/gcc/infrastructure/">https://gcc.gnu.org/pub/gcc/infrastructure/</a>. 278If an isl source distribution is found 279in a subdirectory of your GCC sources named <samp>isl</samp>, it will be 280built together with GCC. Alternatively, the <samp>--with-isl</samp> configure 281option should be used if isl is not installed in your default library 282search path. 283</p> 284</dd> 285<dt>zstd Library.</dt> 286<dd> 287<p>Necessary to build GCC with zstd compression used for LTO bytecode. 288The library is searched in your default library patch search. 289Alternatively, the <samp>--with-zstd</samp> configure option should be used. 290</p> 291</dd> 292</dl> 293 294<a name="Tools_002fpackages-necessary-for-modifying-GCC"></a> 295<h3 class="heading">Tools/packages necessary for modifying GCC</h3> 296<dl compact="compact"> 297<dt>autoconf version 2.69</dt> 298<dt>GNU m4 version 1.4.6 (or later)</dt> 299<dd> 300<p>Necessary when modifying <samp>configure.ac</samp>, <samp>aclocal.m4</samp>, etc. 301to regenerate <samp>configure</samp> and <samp>config.in</samp> files. 302</p> 303</dd> 304<dt>automake version 1.15.1</dt> 305<dd> 306<p>Necessary when modifying a <samp>Makefile.am</samp> file to regenerate its 307associated <samp>Makefile.in</samp>. 308</p> 309<p>Much of GCC does not use automake, so directly edit the <samp>Makefile.in</samp> 310file. Specifically this applies to the <samp>gcc</samp>, <samp>intl</samp>, 311<samp>libcpp</samp>, <samp>libiberty</samp>, <samp>libobjc</samp> directories as well 312as any of their subdirectories. 313</p> 314<p>For directories that use automake, GCC requires the latest release in 315the 1.15 series, which is currently 1.15.1. When regenerating a directory 316to a newer version, please update all the directories using an older 1.15 317to the latest released version. 318</p> 319</dd> 320<dt>gettext version 0.14.5 (or later)</dt> 321<dd> 322<p>Needed to regenerate <samp>gcc.pot</samp>. 323</p> 324</dd> 325<dt>gperf version 2.7.2 (or later)</dt> 326<dd> 327<p>Necessary when modifying <code>gperf</code> input files, e.g. 328<samp>gcc/cp/cfns.gperf</samp> to regenerate its associated header file, e.g. 329<samp>gcc/cp/cfns.h</samp>. 330</p> 331</dd> 332<dt>DejaGnu 1.4.4</dt> 333<dt>Expect</dt> 334<dt>Tcl</dt> 335<dd> 336<p>Necessary to run the GCC testsuite; see the section on testing for 337details. 338</p> 339</dd> 340<dt>autogen version 5.5.4 (or later) and</dt> 341<dt>guile version 1.4.1 (or later)</dt> 342<dd> 343<p>Necessary to regenerate <samp>fixinc/fixincl.x</samp> from 344<samp>fixinc/inclhack.def</samp> and <samp>fixinc/*.tpl</samp>. 345</p> 346<p>Necessary to run ‘<samp>make check</samp>’ for <samp>fixinc</samp>. 347</p> 348<p>Necessary to regenerate the top level <samp>Makefile.in</samp> file from 349<samp>Makefile.tpl</samp> and <samp>Makefile.def</samp>. 350</p> 351</dd> 352<dt>Flex version 2.5.4 (or later)</dt> 353<dd> 354<p>Necessary when modifying <samp>*.l</samp> files. 355</p> 356<p>Necessary to build GCC during development because the generated output 357files are not included in the version-controlled source repository. 358They are included in releases. 359</p> 360</dd> 361<dt>Texinfo version 4.7 (or later)</dt> 362<dd> 363<p>Necessary for running <code>makeinfo</code> when modifying <samp>*.texi</samp> 364files to test your changes. 365</p> 366<p>Necessary for running <code>make dvi</code> or <code>make pdf</code> to 367create printable documentation in DVI or PDF format. Texinfo version 3684.8 or later is required for <code>make pdf</code>. 369</p> 370<p>Necessary to build GCC documentation during development because the 371generated output files are not included in the repository. They are 372included in releases. 373</p> 374</dd> 375<dt>TeX (any working version)</dt> 376<dd> 377<p>Necessary for running <code>texi2dvi</code> and <code>texi2pdf</code>, which 378are used when running <code>make dvi</code> or <code>make pdf</code> to create 379DVI or PDF files, respectively. 380</p> 381</dd> 382<dt>Sphinx version 1.0 (or later)</dt> 383<dd> 384<p>Necessary to regenerate <samp>jit/docs/_build/texinfo</samp> from the <samp>.rst</samp> 385files in the directories below <samp>jit/docs</samp>. 386</p> 387</dd> 388<dt>git (any version)</dt> 389<dt>SSH (any version)</dt> 390<dd> 391<p>Necessary to access the source repository. Public releases and weekly 392snapshots of the development sources are also available via HTTPS. 393</p> 394</dd> 395<dt>GNU diffutils version 2.7 (or later)</dt> 396<dd> 397<p>Useful when submitting patches for the GCC source code. 398</p> 399</dd> 400<dt>patch version 2.5.4 (or later)</dt> 401<dd> 402<p>Necessary when applying patches, created with <code>diff</code>, to one’s 403own sources. 404</p> 405</dd> 406</dl> 407 408<hr /> 409<p> 410<p><a href="./index.html">Return to the GCC Installation page</a> 411</p> 412 413 414 415 416 417 418 419 420 421 422 423 424 425</body> 426</html> 427