prerequisites.html revision 1.16
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-2022 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++11 compiler</dt> 92<dd><p>Necessary to bootstrap GCC. GCC 4.8.3 or newer has sufficient 93support for used C++11 features, with earlier GCC versions you 94might run into implementation bugs. 95</p> 96<p>Versions of GCC prior to 11 also allow bootstrapping with an ISO C++98 97compiler, versions of GCC prior to 4.8 also allow bootstrapping with a 98ISO C89 compiler, and versions of GCC prior to 3.4 also allow 99bootstrapping with a traditional (K&R) C compiler. 100</p> 101<p>To build all languages in a cross-compiler or other configuration where 1023-stage bootstrap is not performed, you need to start with an existing 103GCC binary (version 4.8.3 or later) because source code for language 104frontends other than C might use GCC extensions. 105</p> 106</dd> 107<dt>C standard library and headers</dt> 108<dd> 109<p>In order to build GCC, the C standard library and headers must be present 110for all target variants for which target libraries will be built (and not 111only the variant of the host C++ compiler). 112</p> 113<p>This affects the popular ‘<samp>x86_64-pc-linux-gnu</samp>’ platform (among 114other multilib targets), for which 64-bit (‘<samp>x86_64</samp>’) and 32-bit 115(‘<samp>i386</samp>’) libc headers are usually packaged separately. If you do a 116build of a native compiler on ‘<samp>x86_64-pc-linux-gnu</samp>’, make sure you 117either have the 32-bit libc developer package properly installed (the exact 118name of the package depends on your distro) or you must build GCC as a 11964-bit only compiler by configuring with the option 120<samp>--disable-multilib</samp>. Otherwise, you may encounter an error such as 121‘<samp>fatal error: gnu/stubs-32.h: No such file</samp>’ 122</p> 123</dd> 124<dt><a name="GNAT-prerequisite"></a>GNAT</dt> 125<dd> 126<p>In order to build GNAT, the Ada compiler, you need a working GNAT 127compiler (GCC version 5.1 or later). 128</p> 129<p>This includes GNAT tools such as <code>gnatmake</code> and 130<code>gnatlink</code>, since the Ada front end is written in Ada and 131uses some GNAT-specific extensions. 132</p> 133<p>In order to build a cross compiler, it is strongly recommended to install 134the new compiler as native first, and then use it to build the cross 135compiler. Other native compiler versions may work but this is not guaranteed and 136will typically fail with hard to understand compilation errors during the 137build. 138</p> 139<p>Similarly, it is strongly recommended to use an older version of GNAT to build 140GNAT. More recent versions of GNAT than the version built are not guaranteed 141to work and will often fail during the build with compilation errors. 142</p> 143<p>Note that <code>configure</code> does not test whether the GNAT installation works 144and has a sufficiently recent version; if too old a GNAT version is 145installed and <samp>--enable-languages=ada</samp> is used, the build will fail. 146</p> 147<p><code>ADA_INCLUDE_PATH</code> and <code>ADA_OBJECT_PATH</code> environment variables 148must not be set when building the Ada compiler, the Ada tools, or the 149Ada runtime libraries. You can check that your build environment is clean 150by verifying that ‘<samp>gnatls -v</samp>’ lists only one explicit path in each 151section. 152</p> 153</dd> 154<dt><a name="GDC-prerequisite"></a>GDC</dt> 155<dd> 156<p>In order to build GDC, the D compiler, you need a working GDC 157compiler (GCC version 9.4 or later) and D runtime library, 158‘<samp>libphobos</samp>’, as the D front end is written in D. 159</p> 160<p>Versions of GDC prior to 12 can be built with an ISO C++11 compiler, which can 161then be installed and used to bootstrap newer versions of the D front end. 162</p> 163<p>It is strongly recommended to use an older version of GDC to build GDC. More 164recent versions of GDC than the version built are not guaranteed to work and 165will often fail during the build with compilation errors relating to 166deprecations or removed features. 167</p> 168<p>Note that <code>configure</code> does not test whether the GDC installation works 169and has a sufficiently recent version. Though the implementation of the D 170front end does not make use of any GDC-specific extensions, or novel features 171of the D language, if too old a GDC version is installed and 172<samp>--enable-languages=d</samp> is used, the build will fail. 173</p> 174<p>On some targets, ‘<samp>libphobos</samp>’ isn’t enabled by default, but compiles 175and works if <samp>--enable-libphobos</samp> is used. Specifics are 176documented for affected targets. 177</p> 178</dd> 179<dt>A “working” POSIX compatible shell, or GNU bash</dt> 180<dd> 181<p>Necessary when running <code>configure</code> because some 182<code>/bin/sh</code> shells have bugs and may crash when configuring the 183target libraries. In other cases, <code>/bin/sh</code> or <code>ksh</code> 184have disastrous corner-case performance problems. This 185can cause target <code>configure</code> runs to literally take days to 186complete in some cases. 187</p> 188<p>So on some platforms <code>/bin/ksh</code> is sufficient, on others it 189isn’t. See the host/target specific instructions for your platform, or 190use <code>bash</code> to be sure. Then set <code>CONFIG_SHELL</code> in your 191environment to your “good” shell prior to running 192<code>configure</code>/<code>make</code>. 193</p> 194<p><code>zsh</code> is not a fully compliant POSIX shell and will not 195work when configuring GCC. 196</p> 197</dd> 198<dt>A POSIX or SVR4 awk</dt> 199<dd> 200<p>Necessary for creating some of the generated source files for GCC. 201If in doubt, use a recent GNU awk version, as some of the older ones 202are broken. GNU awk version 3.1.5 is known to work. 203</p> 204</dd> 205<dt>GNU binutils</dt> 206<dd> 207<p>Necessary in some circumstances, optional in others. See the 208host/target specific instructions for your platform for the exact 209requirements. 210</p> 211<p>Note binutils 2.35 or newer is required for LTO to work correctly 212with GNU libtool that includes doing a bootstrap with LTO enabled. 213</p> 214</dd> 215<dt>gzip version 1.2.4 (or later) or</dt> 216<dt>bzip2 version 1.0.2 (or later)</dt> 217<dd> 218<p>Necessary to uncompress GCC <code>tar</code> files when source code is 219obtained via HTTPS mirror sites. 220</p> 221</dd> 222<dt>GNU make version 3.80 (or later)</dt> 223<dd> 224<p>You must have GNU make installed to build GCC. 225</p> 226</dd> 227<dt>GNU tar version 1.14 (or later)</dt> 228<dd> 229<p>Necessary (only on some platforms) to untar the source code. Many 230systems’ <code>tar</code> programs will also work, only try GNU 231<code>tar</code> if you have problems. 232</p> 233</dd> 234<dt>Perl version between 5.6.1 and 5.6.24</dt> 235<dd> 236<p>Necessary when targeting Darwin, building ‘<samp>libstdc++</samp>’, 237and not using <samp>--disable-symvers</samp>. 238Necessary when targeting Solaris 2 with Solaris <code>ld</code> and not using 239<samp>--disable-symvers</samp>. 240</p> 241<p>Necessary when regenerating <samp>Makefile</samp> dependencies in libiberty. 242Necessary when regenerating <samp>libiberty/functions.texi</samp>. 243Necessary when generating manpages from Texinfo manuals. 244Used by various scripts to generate some files included in the source 245repository (mainly Unicode-related and rarely changing) from source 246tables. 247</p> 248<p>Used by <code>automake</code>. 249</p> 250</dd> 251</dl> 252 253<p>Several support libraries are necessary to build GCC, some are required, 254others optional. While any sufficiently new version of required tools 255usually work, library requirements are generally stricter. Newer 256versions may work in some cases, but it’s safer to use the exact 257versions documented. We appreciate bug reports about problems with 258newer versions, though. If your OS vendor provides packages for the 259support libraries then using those packages may be the simplest way to 260install the libraries. 261</p> 262<dl compact="compact"> 263<dt>GNU Multiple Precision Library (GMP) version 4.3.2 (or later)</dt> 264<dd> 265<p>Necessary to build GCC. If a GMP source distribution is found in a 266subdirectory of your GCC sources named <samp>gmp</samp>, it will be built 267together with GCC. Alternatively, if GMP is already installed but it 268is not in your library search path, you will have to configure with the 269<samp>--with-gmp</samp> configure option. See also <samp>--with-gmp-lib</samp> 270and <samp>--with-gmp-include</samp>. 271The in-tree build is only supported with the GMP version that 272download_prerequisites installs. 273</p> 274</dd> 275<dt>MPFR Library version 3.1.0 (or later)</dt> 276<dd> 277<p>Necessary to build GCC. It can be downloaded from 278<a href="https://www.mpfr.org">https://www.mpfr.org</a>. If an MPFR source distribution is found 279in a subdirectory of your GCC sources named <samp>mpfr</samp>, it will be 280built together with GCC. Alternatively, if MPFR is already installed 281but it is not in your default library search path, the 282<samp>--with-mpfr</samp> configure option should be used. See also 283<samp>--with-mpfr-lib</samp> and <samp>--with-mpfr-include</samp>. 284The in-tree build is only supported with the MPFR version that 285download_prerequisites installs. 286</p> 287</dd> 288<dt>MPC Library version 1.0.1 (or later)</dt> 289<dd> 290<p>Necessary to build GCC. It can be downloaded from 291<a href="https://www.multiprecision.org/mpc/">https://www.multiprecision.org/mpc/</a>. If an MPC source distribution 292is found in a subdirectory of your GCC sources named <samp>mpc</samp>, it 293will be built together with GCC. Alternatively, if MPC is already 294installed but it is not in your default library search path, the 295<samp>--with-mpc</samp> configure option should be used. See also 296<samp>--with-mpc-lib</samp> and <samp>--with-mpc-include</samp>. 297The in-tree build is only supported with the MPC version that 298download_prerequisites installs. 299</p> 300</dd> 301<dt>isl Library version 0.15 or later.</dt> 302<dd> 303<p>Necessary to build GCC with the Graphite loop optimizations. 304It can be downloaded from <a href="https://gcc.gnu.org/pub/gcc/infrastructure/">https://gcc.gnu.org/pub/gcc/infrastructure/</a>. 305If an isl source distribution is found 306in a subdirectory of your GCC sources named <samp>isl</samp>, it will be 307built together with GCC. Alternatively, the <samp>--with-isl</samp> configure 308option should be used if isl is not installed in your default library 309search path. 310</p> 311</dd> 312<dt>zstd Library.</dt> 313<dd> 314<p>Necessary to build GCC with zstd compression used for LTO bytecode. 315The library is searched in your default library patch search. 316Alternatively, the <samp>--with-zstd</samp> configure option should be used. 317</p> 318</dd> 319</dl> 320 321<a name="Tools_002fpackages-necessary-for-modifying-GCC"></a> 322<h3 class="heading">Tools/packages necessary for modifying GCC</h3> 323<dl compact="compact"> 324<dt>autoconf version 2.69</dt> 325<dt>GNU m4 version 1.4.6 (or later)</dt> 326<dd> 327<p>Necessary when modifying <samp>configure.ac</samp>, <samp>aclocal.m4</samp>, etc. 328to regenerate <samp>configure</samp> and <samp>config.in</samp> files. 329</p> 330</dd> 331<dt>automake version 1.15.1</dt> 332<dd> 333<p>Necessary when modifying a <samp>Makefile.am</samp> file to regenerate its 334associated <samp>Makefile.in</samp>. 335</p> 336<p>Much of GCC does not use automake, so directly edit the <samp>Makefile.in</samp> 337file. Specifically this applies to the <samp>gcc</samp>, <samp>intl</samp>, 338<samp>libcpp</samp>, <samp>libiberty</samp>, <samp>libobjc</samp> directories as well 339as any of their subdirectories. 340</p> 341<p>For directories that use automake, GCC requires the latest release in 342the 1.15 series, which is currently 1.15.1. When regenerating a directory 343to a newer version, please update all the directories using an older 1.15 344to the latest released version. 345</p> 346</dd> 347<dt>gettext version 0.14.5 (or later)</dt> 348<dd> 349<p>Needed to regenerate <samp>gcc.pot</samp>. 350</p> 351</dd> 352<dt>gperf version 2.7.2 (or later)</dt> 353<dd> 354<p>Necessary when modifying <code>gperf</code> input files, e.g. 355<samp>gcc/cp/cfns.gperf</samp> to regenerate its associated header file, e.g. 356<samp>gcc/cp/cfns.h</samp>. 357</p> 358</dd> 359<dt>DejaGnu version 1.5.3 (or later)</dt> 360<dt>Expect</dt> 361<dt>Tcl</dt> 362<dd> 363<p>Necessary to run the GCC testsuite; see the section on testing for 364details. 365</p> 366</dd> 367<dt>autogen version 5.5.4 (or later) and</dt> 368<dt>guile version 1.4.1 (or later)</dt> 369<dd> 370<p>Necessary to regenerate <samp>fixinc/fixincl.x</samp> from 371<samp>fixinc/inclhack.def</samp> and <samp>fixinc/*.tpl</samp>. 372</p> 373<p>Necessary to run ‘<samp>make check</samp>’ for <samp>fixinc</samp>. 374</p> 375<p>Necessary to regenerate the top level <samp>Makefile.in</samp> file from 376<samp>Makefile.tpl</samp> and <samp>Makefile.def</samp>. 377</p> 378</dd> 379<dt>Flex version 2.5.4 (or later)</dt> 380<dd> 381<p>Necessary when modifying <samp>*.l</samp> files. 382</p> 383<p>Necessary to build GCC during development because the generated output 384files are not included in the version-controlled source repository. 385They are included in releases. 386</p> 387</dd> 388<dt>Texinfo version 4.7 (or later)</dt> 389<dd> 390<p>Necessary for running <code>makeinfo</code> when modifying <samp>*.texi</samp> 391files to test your changes. 392</p> 393<p>Necessary for running <code>make dvi</code> or <code>make pdf</code> to 394create printable documentation in DVI or PDF format. Texinfo version 3954.8 or later is required for <code>make pdf</code>. 396</p> 397<p>Necessary to build GCC documentation during development because the 398generated output files are not included in the repository. They are 399included in releases. 400</p> 401</dd> 402<dt>TeX (any working version)</dt> 403<dd> 404<p>Necessary for running <code>texi2dvi</code> and <code>texi2pdf</code>, which 405are used when running <code>make dvi</code> or <code>make pdf</code> to create 406DVI or PDF files, respectively. 407</p> 408</dd> 409<dt>Sphinx version 1.0 (or later)</dt> 410<dd> 411<p>Necessary to regenerate <samp>jit/docs/_build/texinfo</samp> from the <samp>.rst</samp> 412files in the directories below <samp>jit/docs</samp>. 413</p> 414</dd> 415<dt>git (any version)</dt> 416<dt>SSH (any version)</dt> 417<dd> 418<p>Necessary to access the source repository. Public releases and weekly 419snapshots of the development sources are also available via HTTPS. 420</p> 421</dd> 422<dt>GNU diffutils version 2.7 (or later)</dt> 423<dd> 424<p>Useful when submitting patches for the GCC source code. 425</p> 426</dd> 427<dt>patch version 2.5.4 (or later)</dt> 428<dd> 429<p>Necessary when applying patches, created with <code>diff</code>, to one’s 430own sources. 431</p> 432</dd> 433</dl> 434 435<hr /> 436<p> 437<p><a href="./index.html">Return to the GCC Installation page</a> 438</p> 439 440 441 442 443 444 445 446 447 448 449 450 451</body> 452</html> 453