hppa: Revise REG+D address support to allow long displacements before reload
[official-gcc.git] / gcc / doc / install.texi
blobf995b775f836b2ce10ec6b3891ebba955e5ffbe3
1 \input texinfo.tex    @c -*-texinfo-*-
2 @c @ifnothtml
3 @c %**start of header
4 @setfilename gccinstall.info
5 @setchapternewpage odd
6 @c %**end of header
7 @c @end ifnothtml
9 @include gcc-common.texi
11 @c Specify title for specific html page
12 @ifset indexhtml
13 @settitle Installing GCC
14 @end ifset
15 @ifset specifichtml
16 @settitle Host/Target specific installation notes for GCC
17 @end ifset
18 @ifset prerequisiteshtml
19 @settitle Prerequisites for GCC
20 @end ifset
21 @ifset downloadhtml
22 @settitle Downloading GCC
23 @end ifset
24 @ifset configurehtml
25 @settitle Installing GCC: Configuration
26 @end ifset
27 @ifset buildhtml
28 @settitle Installing GCC: Building
29 @end ifset
30 @ifset testhtml
31 @settitle Installing GCC: Testing
32 @end ifset
33 @ifset finalinstallhtml
34 @settitle Installing GCC: Final installation
35 @end ifset
36 @ifset binarieshtml
37 @settitle Installing GCC: Binaries
38 @end ifset
39 @ifset gfdlhtml
40 @settitle Installing GCC: GNU Free Documentation License
41 @end ifset
43 @c Copyright (C) 1988-2023 Free Software Foundation, Inc.
44 @c *** Converted to texinfo by Dean Wakerley, dean@wakerley.com
46 @c IMPORTANT: whenever you modify this file, run `install.texi2html' to
47 @c test the generation of HTML documents for the gcc.gnu.org web pages.
49 @c Do not use @footnote{} in this file as it breaks install.texi2html!
51 @c Include everything if we're not making html
52 @ifnothtml
53 @set indexhtml
54 @set specifichtml
55 @set prerequisiteshtml
56 @set downloadhtml
57 @set configurehtml
58 @set buildhtml
59 @set testhtml
60 @set finalinstallhtml
61 @set binarieshtml
62 @set gfdlhtml
63 @end ifnothtml
65 @c Part 2 Summary Description and Copyright
66 @copying
67 Copyright @copyright{} 1988-2023 Free Software Foundation, Inc.
68 @sp 1
69 Permission is granted to copy, distribute and/or modify this document
70 under the terms of the GNU Free Documentation License, Version 1.3 or
71 any later version published by the Free Software Foundation; with no
72 Invariant Sections, the Front-Cover texts being (a) (see below), and
73 with the Back-Cover Texts being (b) (see below).  A copy of the
74 license is included in the section entitled ``@uref{./gfdl.html,,GNU
75 Free Documentation License}''.
77 (a) The FSF's Front-Cover Text is:
79      A GNU Manual
81 (b) The FSF's Back-Cover Text is:
83      You have freedom to copy and modify this GNU Manual, like GNU
84      software.  Copies published by the Free Software Foundation raise
85      funds for GNU development.
86 @end copying
87 @ifinfo
88 @insertcopying
89 @end ifinfo
90 @dircategory Software development
91 @direntry
92 * gccinstall: (gccinstall).    Installing the GNU Compiler Collection.
93 @end direntry
95 @c Part 3 Titlepage and Copyright
96 @titlepage
97 @title Installing GCC
98 @versionsubtitle
100 @c The following two commands start the copyright page.
101 @page
102 @vskip 0pt plus 1filll
103 @insertcopying
104 @end titlepage
106 @c Part 4 Top node, Master Menu, and/or Table of Contents
107 @ifinfo
108 @node    Top, , , (dir)
109 @comment node-name, next,          Previous, up
111 @menu
112 * Installing GCC::  This document describes the generic installation
113                     procedure for GCC as well as detailing some target
114                     specific installation instructions.
116 * Specific::        Host/target specific installation notes for GCC.
117 * Binaries::        Where to get pre-compiled binaries.
119 * GNU Free Documentation License:: How you can copy and share this manual.
120 * Concept Index::   This index has two entries.
121 @end menu
122 @end ifinfo
124 @iftex
125 @contents
126 @end iftex
128 @c Part 5 The Body of the Document
129 @c ***Installing GCC**********************************************************
130 @ifnothtml
131 @comment node-name,     next,          previous, up
132 @node    Installing GCC, Binaries, , Top
133 @end ifnothtml
134 @ifset indexhtml
135 @ifnothtml
136 @chapter Installing GCC
137 @end ifnothtml
139 The latest version of this document is always available at
140 @uref{https://gcc.gnu.org/install/,,https://gcc.gnu.org/install/}.
141 It refers to the current development sources, instructions for
142 specific released versions are included with the sources.
144 This document describes the generic installation procedure for GCC as well
145 as detailing some target specific installation instructions.
147 GCC includes several components that previously were separate distributions
148 with their own installation instructions.  This document supersedes all
149 package-specific installation instructions.
151 @emph{Before} starting the build/install procedure please check the
152 @ifnothtml
153 @ref{Specific, host/target specific installation notes}.
154 @end ifnothtml
155 @ifhtml
156 @uref{specific.html,,host/target specific installation notes}.
157 @end ifhtml
158 We recommend you browse the entire generic installation instructions before
159 you proceed.
161 Lists of successful builds for released versions of GCC are
162 available at @uref{https://gcc.gnu.org/buildstat.html}.
163 These lists are updated as new information becomes available.
165 The installation procedure itself is broken into five steps.
167 @ifinfo
168 @menu
169 * Prerequisites::
170 * Downloading the source::
171 * Configuration::
172 * Building::
173 * Testing:: (optional)
174 * Final install::
175 @end menu
176 @end ifinfo
177 @ifhtml
178 @enumerate
179 @item
180 @uref{prerequisites.html,,Prerequisites}
181 @item
182 @uref{download.html,,Downloading the source}
183 @item
184 @uref{configure.html,,Configuration}
185 @item
186 @uref{build.html,,Building}
187 @item
188 @uref{test.html,,Testing} (optional)
189 @item
190 @uref{finalinstall.html,,Final install}
191 @end enumerate
192 @end ifhtml
194 Please note that GCC does not support @samp{make uninstall} and probably
195 won't do so in the near future as this would open a can of worms.  Instead,
196 we suggest that you install GCC into a directory of its own and simply
197 remove that directory when you do not need that specific version of GCC
198 any longer, and, if shared libraries are installed there as well, no
199 more binaries exist that use them.
201 @html
202 <hr />
204 @end html
205 @ifhtml
206 @uref{./index.html,,Return to the GCC Installation page}
208 @insertcopying
209 @end ifhtml
210 @end ifset
212 @c ***Prerequisites**************************************************
213 @ifnothtml
214 @comment node-name,     next,          previous, up
215 @node    Prerequisites, Downloading the source, , Installing GCC
216 @end ifnothtml
217 @ifset prerequisiteshtml
218 @ifnothtml
219 @chapter Prerequisites
220 @end ifnothtml
221 @cindex Prerequisites
223 GCC requires that various tools and packages be available for use in the
224 build procedure.  Modifying GCC sources requires additional tools
225 described below.
227 @heading Tools/packages necessary for building GCC
228 @table @asis
229 @item ISO C++11 compiler
230 Necessary to bootstrap GCC.  GCC 4.8.3 or newer has sufficient
231 support for used C++11 features, with earlier GCC versions you
232 might run into implementation bugs.
234 Versions of GCC prior to 11 also allow bootstrapping with an ISO C++98
235 compiler, versions of GCC prior to 4.8 also allow bootstrapping with a
236 ISO C89 compiler, and versions of GCC prior to 3.4 also allow
237 bootstrapping with a traditional (K&R) C compiler.
239 To build all languages in a cross-compiler or other configuration where
240 3-stage bootstrap is not performed, you need to start with an existing
241 GCC binary (version 4.8.3 or later) because source code for language
242 frontends other than C might use GCC extensions.
244 @item C standard library and headers
246 In order to build GCC, the C standard library and headers must be present
247 for all target variants for which target libraries will be built (and not
248 only the variant of the host C++ compiler).
250 This affects the popular @samp{x86_64-pc-linux-gnu} platform (among
251 other multilib targets), for which 64-bit (@samp{x86_64}) and 32-bit
252 (@samp{i386}) libc headers are usually packaged separately. If you do a
253 build of a native compiler on @samp{x86_64-pc-linux-gnu}, make sure you
254 either have the 32-bit libc developer package properly installed (the exact
255 name of the package depends on your distro) or you must build GCC as a
256 64-bit only compiler by configuring with the option
257 @option{--disable-multilib}.  Otherwise, you may encounter an error such as
258 @samp{fatal error: gnu/stubs-32.h: No such file}
260 @item @anchor{GNAT-prerequisite}GNAT
262 In order to build GNAT, the Ada compiler, you need a working GNAT
263 compiler (GCC version 5.1 or later).
265 This includes GNAT tools such as @command{gnatmake} and
266 @command{gnatlink}, since the Ada front end is written in Ada and
267 uses some GNAT-specific extensions.
269 In order to build a cross compiler, it is strongly recommended to install
270 the new compiler as native first, and then use it to build the cross
271 compiler. Other native compiler versions may work but this is not guaranteed and
272 will typically fail with hard to understand compilation errors during the
273 build.
275 Similarly, it is strongly recommended to use an older version of GNAT to build
276 GNAT. More recent versions of GNAT than the version built are not guaranteed
277 to work and will often fail during the build with compilation errors.
279 Note that @command{configure} does not test whether the GNAT installation works
280 and has a sufficiently recent version; if too old a GNAT version is
281 installed and @option{--enable-languages=ada} is used, the build will fail.
283 @env{ADA_INCLUDE_PATH} and @env{ADA_OBJECT_PATH} environment variables
284 must not be set when building the Ada compiler, the Ada tools, or the
285 Ada runtime libraries. You can check that your build environment is clean
286 by verifying that @samp{gnatls -v} lists only one explicit path in each
287 section.
289 @item @anchor{GDC-prerequisite}GDC
291 In order to build GDC, the D compiler, you need a working GDC
292 compiler (GCC version 9.4 or later) and D runtime library,
293 @samp{libphobos}, as the D front end is written in D.
295 Versions of GDC prior to 12 can be built with an ISO C++11 compiler, which can
296 then be installed and used to bootstrap newer versions of the D front end.
298 It is strongly recommended to use an older version of GDC to build GDC. More
299 recent versions of GDC than the version built are not guaranteed to work and
300 will often fail during the build with compilation errors relating to
301 deprecations or removed features.
303 Note that @command{configure} does not test whether the GDC installation works
304 and has a sufficiently recent version.  Though the implementation of the D
305 front end does not make use of any GDC-specific extensions, or novel features
306 of the D language, if too old a GDC version is installed and
307 @option{--enable-languages=d} is used, the build will fail.
309 On some targets, @samp{libphobos} isn't enabled by default, but compiles
310 and works if @option{--enable-libphobos} is used.  Specifics are
311 documented for affected targets.
313 @item @anchor{GM2-prerequisite}GM2
315 Python3 is required if you want to build the complete Modula-2
316 documentation including the target @code{SYSTEM} definition module.
317 If Python3 is unavailable Modula-2 documentation will include a target
318 independent version of the SYSTEM modules.
320 @item A ``working'' POSIX compatible shell, or GNU bash
322 Necessary when running @command{configure} because some
323 @command{/bin/sh} shells have bugs and may crash when configuring the
324 target libraries.  In other cases, @command{/bin/sh} or @command{ksh}
325 have disastrous corner-case performance problems.  This
326 can cause target @command{configure} runs to literally take days to
327 complete in some cases.
329 So on some platforms @command{/bin/ksh} is sufficient, on others it
330 isn't.  See the host/target specific instructions for your platform, or
331 use @command{bash} to be sure.  Then set @env{CONFIG_SHELL} in your
332 environment to your ``good'' shell prior to running
333 @command{configure}/@command{make}.
335 @command{zsh} is not a fully compliant POSIX shell and will not
336 work when configuring GCC@.
338 @item A POSIX or SVR4 awk
340 Necessary for creating some of the generated source files for GCC@.
341 If in doubt, use a recent GNU awk version, as some of the older ones
342 are broken.  GNU awk version 3.1.5 is known to work.
344 @item GNU binutils
346 Necessary in some circumstances, optional in others.  See the
347 host/target specific instructions for your platform for the exact
348 requirements.
350 Note binutils 2.35 or newer is required for LTO to work correctly
351 with GNU libtool that includes doing a bootstrap with LTO enabled.
353 @item gzip version 1.2.4 (or later) or
354 @itemx bzip2 version 1.0.2 (or later)
356 Necessary to uncompress GCC @command{tar} files when source code is
357 obtained via HTTPS mirror sites.
359 @item GNU make version 3.80 (or later)
361 You must have GNU make installed to build GCC@.
363 @item GNU tar version 1.14 (or later)
365 Necessary (only on some platforms) to untar the source code.  Many
366 systems' @command{tar} programs will also work, only try GNU
367 @command{tar} if you have problems.
369 @item Perl version 5.6.1 (or later)
371 Necessary when targeting Darwin, building @samp{libstdc++},
372 and not using @option{--disable-symvers}.
373 Necessary when targeting Solaris with Solaris @command{ld} and not using
374 @option{--disable-symvers}.
376 Necessary when regenerating @file{Makefile} dependencies in libiberty.
377 Necessary when regenerating @file{libiberty/functions.texi}.
378 Necessary when generating manpages from Texinfo manuals.
379 Used by various scripts to generate some files included in the source
380 repository (mainly Unicode-related and rarely changing) from source
381 tables.
383 Used by @command{automake}.
385 If available, enables parallel testing of @samp{libgomp} in case that
386 @command{flock} is not available.
388 @end table
390 Several support libraries are necessary to build GCC, some are required,
391 others optional.  While any sufficiently new version of required tools
392 usually work, library requirements are generally stricter.  Newer
393 versions may work in some cases, but it's safer to use the exact
394 versions documented.  We appreciate bug reports about problems with
395 newer versions, though.  If your OS vendor provides packages for the
396 support libraries then using those packages may be the simplest way to
397 install the libraries.
399 @table @asis
400 @item GNU Multiple Precision Library (GMP) version 4.3.2 (or later)
402 Necessary to build GCC@.  It can be downloaded from
403 @uref{https://gmplib.org/}.  If a GMP source distribution is found in a
404 subdirectory of your GCC sources named @file{gmp}, it will be built
405 together with GCC.  Alternatively, if GMP is already installed but it
406 is not in your library search path, you will have to configure with the
407 @option{--with-gmp} configure option.  See also @option{--with-gmp-lib}
408 and @option{--with-gmp-include}.
409 The in-tree build is only supported with the GMP version that
410 download_prerequisites installs.
412 @item MPFR Library version 3.1.0 (or later)
414 Necessary to build GCC@.  It can be downloaded from
415 @uref{https://www.mpfr.org}.  If an MPFR source distribution is found
416 in a subdirectory of your GCC sources named @file{mpfr}, it will be
417 built together with GCC.  Alternatively, if MPFR is already installed
418 but it is not in your default library search path, the
419 @option{--with-mpfr} configure option should be used.  See also
420 @option{--with-mpfr-lib} and @option{--with-mpfr-include}.
421 The in-tree build is only supported with the MPFR version that
422 download_prerequisites installs.
424 @item MPC Library version 1.0.1 (or later)
426 Necessary to build GCC@.  It can be downloaded from
427 @uref{https://www.multiprecision.org/mpc/}.  If an MPC source distribution
428 is found in a subdirectory of your GCC sources named @file{mpc}, it
429 will be built together with GCC.  Alternatively, if MPC is already
430 installed but it is not in your default library search path, the
431 @option{--with-mpc} configure option should be used.  See also
432 @option{--with-mpc-lib} and @option{--with-mpc-include}.
433 The in-tree build is only supported with the MPC version that
434 download_prerequisites installs.
436 @item isl Library version 0.15 or later.
438 Necessary to build GCC with the Graphite loop optimizations.
439 It can be downloaded from @uref{https://gcc.gnu.org/pub/gcc/infrastructure/}.
440 If an isl source distribution is found
441 in a subdirectory of your GCC sources named @file{isl}, it will be
442 built together with GCC.  Alternatively, the @option{--with-isl} configure
443 option should be used if isl is not installed in your default library
444 search path.
446 @item zstd Library.
448 Necessary to build GCC with zstd compression used for LTO bytecode.
449 The library is searched in your default library patch search.
450 Alternatively, the @option{--with-zstd} configure option should be used.
452 @item Python3 modules
454 The complete list of Python3 modules broken down by GCC subcomponent
455 is shown below:
457 @table @asis
458 @item internal debugging in gdbhooks
459 @code{gdb}, @code{gdb.printing}, @code{gdb.types},
460 @code{os.path}, @code{re}, @code{sys} and @code{tempfile},
462 @item g++ testsuite
463 @code{gcov}, @code{gzip}, @code{json}, @code{os} and @code{pytest}.
465 @item c++ cxx api generation
466 @code{csv}, @code{os}, @code{sys} and @code{time}.
468 @item modula-2 documentation
469 @code{argparse}, @code{os}, @code{pathlib}, @code{shutil} and
470 @code{sys}.
472 @item git developer tools
473 @code{os} and @code{sys}.
475 @item ada documentation
476 @code{latex_elements}, @code{os}, @code{pygments}, @code{re},
477 @code{sys} and @code{time}.
478 @end table
480 @item GNU gettext
482 Necessary to build GCC with internationalization support via
483 @option{--enable-nls}.  It can be downloaded from
484 @uref{https://gnu.org/s/gettext/}.  If a GNU gettext distribution is
485 found in a subdirectory of your GCC sources named @file{gettext}, it
486 will be built together with GCC, unless present in the system (either in
487 libc or as a stand-alone library).
489 The in-tree configuration requires GNU gettext version 0.22 or later.
491 @end table
493 @heading Tools/packages necessary for modifying GCC
494 @table @asis
495 @item autoconf version 2.69
496 @itemx GNU m4 version 1.4.6 (or later)
498 Necessary when modifying @file{configure.ac}, @file{aclocal.m4}, etc.@:
499 to regenerate @file{configure} and @file{config.in} files.
501 @item automake version 1.15.1
503 Necessary when modifying a @file{Makefile.am} file to regenerate its
504 associated @file{Makefile.in}.
506 Much of GCC does not use automake, so directly edit the @file{Makefile.in}
507 file.  Specifically this applies to the @file{gcc}, @file{intl},
508 @file{libcpp}, @file{libiberty}, @file{libobjc} directories as well
509 as any of their subdirectories.
511 For directories that use automake, GCC requires the latest release in
512 the 1.15 series, which is currently 1.15.1.  When regenerating a directory
513 to a newer version, please update all the directories using an older 1.15
514 to the latest released version.
516 @item gettext version 0.14.5 (or later)
518 Needed to regenerate @file{gcc.pot}.
520 @item gperf version 2.7.2 (or later)
522 Necessary when modifying @command{gperf} input files, e.g.@:
523 @file{gcc/cp/cfns.gperf} to regenerate its associated header file, e.g.@:
524 @file{gcc/cp/cfns.h}.
526 @item DejaGnu version 1.5.3 (or later)
527 @itemx Expect
528 @itemx Tcl
529 @c Once Tcl 8.5 or higher is required, remove any obsolete
530 @c compatibility workarounds:
531 @c     git grep 'compatibility with earlier Tcl releases'
533 Necessary to run the GCC testsuite; see the section on testing for
534 details.
536 @item autogen version 5.5.4 (or later) and
537 @itemx guile version 1.4.1 (or later)
539 Necessary to regenerate @file{fixinc/fixincl.x} from
540 @file{fixinc/inclhack.def} and @file{fixinc/*.tpl}.
542 Necessary to run @samp{make check} for @file{fixinc}.
544 Necessary to regenerate the top level @file{Makefile.in} file from
545 @file{Makefile.tpl} and @file{Makefile.def}.
547 @item Flex version 2.5.4 (or later)
549 Necessary when modifying @file{*.l} files.
551 Necessary to build GCC during development because the generated output
552 files are not included in the version-controlled source repository.
553 They are included in releases.
555 @item Texinfo version 4.7 (or later)
557 Necessary for running @command{makeinfo} when modifying @file{*.texi}
558 files to test your changes.
560 Necessary for running @command{make dvi}, @command{make pdf},
561 or @command{make html} to create formatted documentation.  Texinfo version
562 4.8 or later is required for @command{make pdf}.
564 Necessary to build GCC documentation in info format during development
565 because the generated output files are not included in the repository.
566 (They are included in release tarballs.)
568 Note that the minimum requirement is for a very old version of
569 Texinfo, but recent versions of Texinfo produce better-quality output,
570 especially for HTML format.  The version of Texinfo packaged with any
571 current operating system distribution is likely to be adequate for
572 building the documentation without error, but you may still want to
573 install a newer release to get the best appearance and usability of
574 the generated manuals.
576 @item @TeX{} (any working version)
578 Necessary for running @command{texi2dvi} and @command{texi2pdf}, which
579 are used when running @command{make dvi} or @command{make pdf} to create
580 DVI or PDF files, respectively.
582 @item Sphinx version 1.0 (or later)
584 Necessary to regenerate @file{jit/docs/_build/texinfo} from the @file{.rst}
585 files in the directories below @file{jit/docs}.
587 @item git (any version)
588 @itemx SSH (any version)
590 Necessary to access the source repository.  Public releases and weekly
591 snapshots of the development sources are also available via HTTPS@.
593 @item GNU diffutils version 2.7 (or later)
595 Useful when submitting patches for the GCC source code.
597 @item patch version 2.5.4 (or later)
599 Necessary when applying patches, created with @command{diff}, to one's
600 own sources.
602 @end table
604 @html
605 <hr />
607 @end html
608 @ifhtml
609 @uref{./index.html,,Return to the GCC Installation page}
610 @end ifhtml
611 @end ifset
613 @c ***Downloading the source**************************************************
614 @ifnothtml
615 @comment node-name,     next,          previous, up
616 @node    Downloading the source, Configuration, Prerequisites, Installing GCC
617 @end ifnothtml
618 @ifset downloadhtml
619 @ifnothtml
620 @chapter Downloading GCC
621 @end ifnothtml
622 @cindex Downloading GCC
623 @cindex Downloading the Source
625 GCC is distributed via @uref{https://gcc.gnu.org/git.html,,git} and via
626 HTTPS as tarballs compressed with @command{gzip} or @command{bzip2}.
628 Please refer to the @uref{https://gcc.gnu.org/releases.html,,releases web page}
629 for information on how to obtain GCC@.
631 The source distribution includes the C, C++, Objective-C, Fortran,
632 and Ada (in the case of GCC 3.1 and later) compilers, as well as
633 runtime libraries for C++, Objective-C, and Fortran.
634 For previous versions these were downloadable as separate components such
635 as the core GCC distribution, which included the C language front end and
636 shared components, and language-specific distributions including the
637 language front end and the language runtime (where appropriate).
639 If you also intend to build binutils (either to upgrade an existing
640 installation or for use in place of the corresponding tools of your
641 OS), unpack the binutils distribution either in the same directory or
642 a separate one.  In the latter case, add symbolic links to any
643 components of the binutils you intend to build alongside the compiler
644 (@file{bfd}, @file{binutils}, @file{gas}, @file{gprof}, @file{ld},
645 @file{opcodes}, @dots{}) to the directory containing the GCC sources.
647 Likewise the GMP, MPFR, MPC and Gettext libraries can be automatically
648 built together with GCC.  You may simply run the
649 @command{contrib/download_prerequisites} script in the GCC source directory
650 to set up everything.
651 Otherwise unpack the GMP, MPFR, MPC and/or Gettext source
652 distributions in the directory containing the GCC sources and rename
653 their directories to @file{gmp}, @file{mpfr}, @file{mpc} and
654 @file{gettext}, respectively (or use symbolic links with the same name).
656 @html
657 <hr />
659 @end html
660 @ifhtml
661 @uref{./index.html,,Return to the GCC Installation page}
662 @end ifhtml
663 @end ifset
665 @c ***Configuration***********************************************************
666 @ifnothtml
667 @comment node-name,     next,          previous, up
668 @node    Configuration, Building, Downloading the source, Installing GCC
669 @end ifnothtml
670 @ifset configurehtml
671 @ifnothtml
672 @chapter Installing GCC: Configuration
673 @end ifnothtml
674 @cindex Configuration
675 @cindex Installing GCC: Configuration
677 Like most GNU software, GCC must be configured before it can be built.
678 This document describes the recommended configuration procedure
679 for both native and cross targets.
681 We use @var{srcdir} to refer to the toplevel source directory for
682 GCC; we use @var{objdir} to refer to the toplevel build/object directory.
684 If you obtained the sources by cloning the repository, @var{srcdir}
685 must refer to the top @file{gcc} directory, the one where the
686 @file{MAINTAINERS} file can be found, and not its @file{gcc}
687 subdirectory, otherwise the build will fail.
689 If either @var{srcdir} or @var{objdir} is located on an automounted NFS
690 file system, the shell's built-in @command{pwd} command will return
691 temporary pathnames.  Using these can lead to various sorts of build
692 problems.  To avoid this issue, set the @env{PWDCMD} environment
693 variable to an automounter-aware @command{pwd} command, e.g.,
694 @command{pawd} or @samp{amq -w}, during the configuration and build
695 phases.
697 First, we @strong{highly} recommend that GCC be built into a
698 separate directory from the sources which does @strong{not} reside
699 within the source tree.  This is how we generally build GCC; building
700 where @var{srcdir} == @var{objdir} should still work, but doesn't
701 get extensive testing; building where @var{objdir} is a subdirectory
702 of @var{srcdir} is unsupported.
704 If you have previously built GCC in the same directory for a
705 different target machine, do @samp{make distclean} to delete all files
706 that might be invalid.  One of the files this deletes is @file{Makefile};
707 if @samp{make distclean} complains that @file{Makefile} does not exist
708 or issues a message like ``don't know how to make distclean'' it probably
709 means that the directory is already suitably clean.  However, with the
710 recommended method of building in a separate @var{objdir}, you should
711 simply use a different @var{objdir} for each target.
713 Second, when configuring a native system, either @command{cc} or
714 @command{gcc} must be in your path or you must set @env{CC} in
715 your environment before running configure.  Otherwise the configuration
716 scripts may fail.
718 @ignore
719 Note that the bootstrap compiler and the resulting GCC must be link
720 compatible, else the bootstrap will fail with linker errors about
721 incompatible object file formats.  Several multilibed targets are
722 affected by this requirement, see
723 @ifnothtml
724 @ref{Specific, host/target specific installation notes}.
725 @end ifnothtml
726 @ifhtml
727 @uref{specific.html,,host/target specific installation notes}.
728 @end ifhtml
729 @end ignore
731 To configure GCC:
733 @smallexample
734 % mkdir @var{objdir}
735 % cd @var{objdir}
736 % @var{srcdir}/configure [@var{options}] [@var{target}]
737 @end smallexample
739 @heading Distributor options
741 If you will be distributing binary versions of GCC, with modifications
742 to the source code, you should use the options described in this
743 section to make clear that your version contains modifications.
745 @table @code
746 @item --with-pkgversion=@var{version}
747 Specify a string that identifies your package.  You may wish
748 to include a build number or build date.  This version string will be
749 included in the output of @command{gcc --version}.  This suffix does
750 not replace the default version string, only the @samp{GCC} part.
752 The default value is @samp{GCC}.
754 @item --with-bugurl=@var{url}
755 Specify the URL that users should visit if they wish to report a bug.
756 You are of course welcome to forward bugs reported to you to the FSF,
757 if you determine that they are not bugs in your modifications.
759 The default value refers to the FSF's GCC bug tracker.
761 @item --with-documentation-root-url=@var{url}
762 Specify the URL root that contains GCC option documentation.  The @var{url}
763 should end with a @code{/} character.
765 The default value is @uref{https://gcc.gnu.org/onlinedocs/,,https://gcc.gnu.org/onlinedocs/}.
767 @item --with-changes-root-url=@var{url}
768 Specify the URL root that contains information about changes in GCC
769 releases like @code{gcc-@var{version}/changes.html}.
770 The @var{url} should end with a @code{/} character.
772 The default value is @uref{https://gcc.gnu.org/,,https://gcc.gnu.org/}.
774 @end table
776 @heading Host, Build and Target specification
778 Specify the host, build and target machine configurations.  You do this
779 when you run the @file{configure} script.
781 The @dfn{build} machine is the system which you are using, the
782 @dfn{host} machine is the system where you want to run the resulting
783 compiler (normally the build machine), and the @dfn{target} machine is
784 the system for which you want the compiler to generate code.
786 If you are building a compiler to produce code for the machine it runs
787 on (a native compiler), you normally do not need to specify any operands
788 to @file{configure}; it will try to guess the type of machine you are on
789 and use that as the build, host and target machines.  So you don't need
790 to specify a configuration when building a native compiler unless
791 @file{configure} cannot figure out what your configuration is or guesses
792 wrong.
794 In those cases, specify the build machine's @dfn{configuration name}
795 with the @option{--host} option; the host and target will default to be
796 the same as the host machine.
798 Here is an example:
800 @smallexample
801 ./configure --host=x86_64-pc-linux-gnu
802 @end smallexample
804 A configuration name may be canonical or it may be more or less
805 abbreviated (@file{config.sub} script produces canonical versions).
807 A canonical configuration name has three parts, separated by dashes.
808 It looks like this: @samp{@var{cpu}-@var{company}-@var{system}}.
810 Here are the possible CPU types:
812 @quotation
813 aarch64, aarch64_be, alpha, alpha64, amdgcn, arc, arceb, arm, armeb, avr, bfin,
814 bpf, cris, csky, epiphany, fido, fr30, frv, ft32, h8300, hppa, hppa2.0,
815 hppa64, i486, i686, ia64, iq2000, lm32, loongarch64, m32c, m32r, m32rle, m68k,
816 mcore, microblaze, microblazeel, mips, mips64, mips64el, mips64octeon,
817 mips64orion, mips64vr, mipsel, mipsisa32, mipsisa32r2, mipsisa64, mipsisa64r2,
818 mipsisa64r2el, mipsisa64sb1, mipsisa64sr71k, mipstx39, mmix, mn10300, moxie,
819 msp430, nds32be, nds32le, nios2, nvptx, or1k, pdp11, powerpc, powerpc64,
820 powerpc64le, powerpcle, pru, riscv32, riscv32be, riscv64, riscv64be, rl78, rx,
821 s390, s390x, sh, shle, sparc, sparc64, tic6x, v850,
822 v850e, v850e1, vax, visium, x86_64, xstormy16, xtensa
823 @end quotation
825 Here is a list of system types:
827 @quotation
828 aix@var{version}, amdhsa, aout, cygwin, darwin@var{version},
829 eabi, eabialtivec, eabisim, eabisimaltivec, elf, elf32,
830 elfbare, elfoabi, freebsd@var{version}, gnu, hpux, hpux@var{version},
831 kfreebsd-gnu, kopensolaris-gnu, linux-androideabi, linux-gnu,
832 linux-gnu_altivec, linux-musl, linux-uclibc, lynxos, mingw32, mingw32crt,
833 mmixware, msdosdjgpp, netbsd, netbsdelf@var{version}, nto-qnx, openbsd,
834 rtems, solaris@var{version}, symbianelf, tpf, uclinux, uclinux_eabi, vms,
835 vxworks, vxworksae, vxworksmils
836 @end quotation
838 @heading Options specification
840 Use @var{options} to override several configure time options for
841 GCC@.  A list of supported @var{options} follows; @samp{configure
842 --help} may list other options, but those not listed below may not
843 work and should not normally be used.
845 Note that each @option{--enable} option has a corresponding
846 @option{--disable} option and that each @option{--with} option has a
847 corresponding @option{--without} option.
849 @table @code
850 @item --prefix=@var{dirname}
851 Specify the toplevel installation
852 directory.  This is the recommended way to install the tools into a directory
853 other than the default.  The toplevel installation directory defaults to
854 @file{/usr/local}.
856 We @strong{highly} recommend against @var{dirname} being the same or a
857 subdirectory of @var{objdir} or vice versa.  If specifying a directory
858 beneath a user's home directory tree, some shells will not expand
859 @var{dirname} correctly if it contains the @samp{~} metacharacter; use
860 @env{$HOME} instead.
862 The following standard @command{autoconf} options are supported.  Normally you
863 should not need to use these options.
864 @table @code
865 @item --exec-prefix=@var{dirname}
866 Specify the toplevel installation directory for architecture-dependent
867 files.  The default is @file{@var{prefix}}.
869 @item --bindir=@var{dirname}
870 Specify the installation directory for the executables called by users
871 (such as @command{gcc} and @command{g++}).  The default is
872 @file{@var{exec-prefix}/bin}.
874 @item --libdir=@var{dirname}
875 Specify the installation directory for object code libraries and
876 internal data files of GCC@.  The default is @file{@var{exec-prefix}/lib}.
878 @item --libexecdir=@var{dirname}
879 Specify the installation directory for internal executables of GCC@.
880 The default is @file{@var{exec-prefix}/libexec}.
882 @item --with-slibdir=@var{dirname}
883 Specify the installation directory for the shared libgcc library.  The
884 default is @file{@var{libdir}}.
886 @item --datarootdir=@var{dirname}
887 Specify the root of the directory tree for read-only architecture-independent
888 data files referenced by GCC@.  The default is @file{@var{prefix}/share}.
890 @item --infodir=@var{dirname}
891 Specify the installation directory for documentation in info format.
892 The default is @file{@var{datarootdir}/info}.
894 @item --datadir=@var{dirname}
895 Specify the installation directory for some architecture-independent
896 data files referenced by GCC@.  The default is @file{@var{datarootdir}}.
898 @item --docdir=@var{dirname}
899 Specify the installation directory for documentation files (other
900 than Info) for GCC@.  The default is @file{@var{datarootdir}/doc}.
902 @item --htmldir=@var{dirname}
903 Specify the installation directory for HTML documentation files.
904 The default is @file{@var{docdir}}.
906 @item --pdfdir=@var{dirname}
907 Specify the installation directory for PDF documentation files.
908 The default is @file{@var{docdir}}.
910 @item --mandir=@var{dirname}
911 Specify the installation directory for manual pages.  The default is
912 @file{@var{datarootdir}/man}.  (Note that the manual pages are only extracts
913 from the full GCC manuals, which are provided in Texinfo format.  The manpages
914 are derived by an automatic conversion process from parts of the full
915 manual.)
917 @item --with-gxx-include-dir=@var{dirname}
918 Specify
919 the installation directory for G++ header files.  The default depends
920 on other configuration options, and differs between cross and native
921 configurations.
923 @item --with-specs=@var{specs}
924 Specify additional command line driver SPECS.
925 This can be useful if you need to turn on a non-standard feature by
926 default without modifying the compiler's source code, for instance
927 @option{--with-specs=%@{!fcommon:%@{!fno-common:-fno-common@}@}}.
928 @ifnothtml
929 @xref{Spec Files,, Specifying subprocesses and the switches to pass to them,
930 gcc, Using the GNU Compiler Collection (GCC)},
931 @end ifnothtml
932 @ifhtml
933 See ``Spec Files'' in the main manual
934 @end ifhtml
936 @end table
938 @item --program-prefix=@var{prefix}
939 GCC supports some transformations of the names of its programs when
940 installing them.  This option prepends @var{prefix} to the names of
941 programs to install in @var{bindir} (see above).  For example, specifying
942 @option{--program-prefix=foo-} would result in @samp{gcc}
943 being installed as @file{/usr/local/bin/foo-gcc}.
945 @item --program-suffix=@var{suffix}
946 Appends @var{suffix} to the names of programs to install in @var{bindir}
947 (see above).  For example, specifying @option{--program-suffix=-3.1}
948 would result in @samp{gcc} being installed as
949 @file{/usr/local/bin/gcc-3.1}.
951 @item --program-transform-name=@var{pattern}
952 Applies the @samp{sed} script @var{pattern} to be applied to the names
953 of programs to install in @var{bindir} (see above).  @var{pattern} has to
954 consist of one or more basic @samp{sed} editing commands, separated by
955 semicolons.  For example, if you want the @samp{gcc} program name to be
956 transformed to the installed program @file{/usr/local/bin/myowngcc} and
957 the @samp{g++} program name to be transformed to
958 @file{/usr/local/bin/gspecial++} without changing other program names,
959 you could use the pattern
960 @option{--program-transform-name='s/^gcc$/myowngcc/; s/^g++$/gspecial++/'}
961 to achieve this effect.
963 All three options can be combined and used together, resulting in more
964 complex conversion patterns.  As a basic rule, @var{prefix} (and
965 @var{suffix}) are prepended (appended) before further transformations
966 can happen with a special transformation script @var{pattern}.
968 As currently implemented, this option only takes effect for native
969 builds; cross compiler binaries' names are not transformed even when a
970 transformation is explicitly asked for by one of these options.
972 For native builds, some of the installed programs are also installed
973 with the target alias in front of their name, as in
974 @samp{i686-pc-linux-gnu-gcc}.  All of the above transformations happen
975 before the target alias is prepended to the name---so, specifying
976 @option{--program-prefix=foo-} and @option{program-suffix=-3.1}, the
977 resulting binary would be installed as
978 @file{/usr/local/bin/i686-pc-linux-gnu-foo-gcc-3.1}.
980 As a last shortcoming, none of the installed Ada programs are
981 transformed yet, which will be fixed in some time.
983 @item --with-local-prefix=@var{dirname}
984 Specify the
985 installation directory for local include files.  The default is
986 @file{/usr/local}.  Specify this option if you want the compiler to
987 search directory @file{@var{dirname}/include} for locally installed
988 header files @emph{instead} of @file{/usr/local/include}.
990 You should specify @option{--with-local-prefix} @strong{only} if your
991 site has a different convention (not @file{/usr/local}) for where to put
992 site-specific files.
994 The default value for @option{--with-local-prefix} is @file{/usr/local}
995 regardless of the value of @option{--prefix}.  Specifying
996 @option{--prefix} has no effect on which directory GCC searches for
997 local header files.  This may seem counterintuitive, but actually it is
998 logical.
1000 The purpose of @option{--prefix} is to specify where to @emph{install
1001 GCC}.  The local header files in @file{/usr/local/include}---if you put
1002 any in that directory---are not part of GCC@.  They are part of other
1003 programs---perhaps many others.  (GCC installs its own header files in
1004 another directory which is based on the @option{--prefix} value.)
1006 Both the local-prefix include directory and the GCC-prefix include
1007 directory are part of GCC's ``system include'' directories.  Although these
1008 two directories are not fixed, they need to be searched in the proper
1009 order for the correct processing of the include_next directive.  The
1010 local-prefix include directory is searched before the GCC-prefix
1011 include directory.  Another characteristic of system include directories
1012 is that pedantic warnings are turned off for headers in these directories.
1014 Some autoconf macros add @option{-I @var{directory}} options to the
1015 compiler command line, to ensure that directories containing installed
1016 packages' headers are searched.  When @var{directory} is one of GCC's
1017 system include directories, GCC will ignore the option so that system
1018 directories continue to be processed in the correct order.  This
1019 may result in a search order different from what was specified but the
1020 directory will still be searched.
1022 GCC automatically searches for ordinary libraries using
1023 @env{GCC_EXEC_PREFIX}.  Thus, when the same installation prefix is
1024 used for both GCC and packages, GCC will automatically search for
1025 both headers and libraries.  This provides a configuration that is
1026 easy to use.  GCC behaves in a manner similar to that when it is
1027 installed as a system compiler in @file{/usr}.
1029 Sites that need to install multiple versions of GCC may not want to
1030 use the above simple configuration.  It is possible to use the
1031 @option{--program-prefix}, @option{--program-suffix} and
1032 @option{--program-transform-name} options to install multiple versions
1033 into a single directory, but it may be simpler to use different prefixes
1034 and the @option{--with-local-prefix} option to specify the location of the
1035 site-specific files for each version.  It will then be necessary for
1036 users to specify explicitly the location of local site libraries
1037 (e.g., with @env{LIBRARY_PATH}).
1039 The same value can be used for both @option{--with-local-prefix} and
1040 @option{--prefix} provided it is not @file{/usr}.  This can be used
1041 to avoid the default search of @file{/usr/local/include}.
1043 @strong{Do not} specify @file{/usr} as the @option{--with-local-prefix}!
1044 The directory you use for @option{--with-local-prefix} @strong{must not}
1045 contain any of the system's standard header files.  If it did contain
1046 them, certain programs would be miscompiled (including GNU Emacs, on
1047 certain targets), because this would override and nullify the header
1048 file corrections made by the @command{fixincludes} script.
1050 Indications are that people who use this option use it based on mistaken
1051 ideas of what it is for.  People use it as if it specified where to
1052 install part of GCC@.  Perhaps they make this assumption because
1053 installing GCC creates the directory.
1055 @item --with-gcc-major-version-only
1056 Specifies that GCC should use only the major number rather than
1057 @var{major}.@var{minor}.@var{patchlevel} in filesystem paths.
1059 @item --with-native-system-header-dir=@var{dirname}
1060 Specifies that @var{dirname} is the directory that contains native system
1061 header files, rather than @file{/usr/include}.  This option is most useful
1062 if you are creating a compiler that should be isolated from the system
1063 as much as possible.  It is most commonly used with the
1064 @option{--with-sysroot} option and will cause GCC to search
1065 @var{dirname} inside the system root specified by that option.
1067 @item --enable-shared[=@var{package}[,@dots{}]]
1068 Build shared versions of libraries, if shared libraries are supported on
1069 the target platform.  Unlike GCC 2.95.x and earlier, shared libraries
1070 are enabled by default on all platforms that support shared libraries.
1072 If a list of packages is given as an argument, build shared libraries
1073 only for the listed packages.  For other packages, only static libraries
1074 will be built.  Package names currently recognized in the GCC tree are
1075 @samp{libgcc} (also known as @samp{gcc}), @samp{libstdc++} (not
1076 @samp{libstdc++-v3}), @samp{libffi}, @samp{zlib}, @samp{boehm-gc},
1077 @samp{ada}, @samp{libada}, @samp{libgo}, @samp{libobjc}, and @samp{libphobos}.
1078 Note @samp{libiberty} does not support shared libraries at all.
1080 Use @option{--disable-shared} to build only static libraries.  Note that
1081 @option{--disable-shared} does not accept a list of package names as
1082 argument, only @option{--enable-shared} does.
1084 Contrast with @option{--enable-host-shared}, which affects @emph{host}
1085 code.
1087 @item --enable-host-shared
1088 Specify that the @emph{host} code should be built into position-independent
1089 machine code (with @option{-fPIC}), allowing it to be used within shared
1090 libraries, but yielding a slightly slower compiler.
1092 This option is required when building the libgccjit.so library.
1094 Contrast with @option{--enable-shared}, which affects @emph{target}
1095 libraries.
1097 @item --enable-host-pie
1098 Specify that the @emph{host} executables should be built into
1099 position-independent executables (with @option{-fPIE} and @option{-pie}),
1100 yielding a slightly slower compiler (but faster than
1101 @option{--enable-host-shared}).  Position-independent executables are loaded
1102 at random addresses each time they are executed, therefore provide additional
1103 protection against Return Oriented Programming (ROP) attacks.
1105 @option{--enable-host-pie}) may be used with @option{--enable-host-shared}),
1106 in which case @option{-fPIC} is used when compiling, and @option{-pie} when
1107 linking.
1109 @item --enable-host-bind-now
1110 Specify that the @emph{host} executables should be linked with the option
1111 @option{-Wl,-z,now}, which means that the dynamic linker will resolve all
1112 symbols when the executables are started, and that in turn allows RELRO to
1113 mark the GOT read-only, resulting in better security.
1115 @item @anchor{with-gnu-as}--with-gnu-as
1116 Specify that the compiler should assume that the
1117 assembler it finds is the GNU assembler.  However, this does not modify
1118 the rules to find an assembler and will result in confusion if the
1119 assembler found is not actually the GNU assembler.  (Confusion may also
1120 result if the compiler finds the GNU assembler but has not been
1121 configured with @option{--with-gnu-as}.)  If you have more than one
1122 assembler installed on your system, you may want to use this option in
1123 connection with @option{--with-as=@var{pathname}} or
1124 @option{--with-build-time-tools=@var{pathname}}.
1126 The following systems are the only ones where it makes a difference
1127 whether you use the GNU assembler.  On any other system,
1128 @option{--with-gnu-as} has no effect.
1130 @itemize @bullet
1131 @item @samp{hppa1.0-@var{any}-@var{any}}
1132 @item @samp{hppa1.1-@var{any}-@var{any}}
1133 @item @samp{*-*-solaris2.11}
1134 @end itemize
1136 @item @anchor{with-as}--with-as=@var{pathname}
1137 Specify that the compiler should use the assembler pointed to by
1138 @var{pathname}, rather than the one found by the standard rules to find
1139 an assembler, which are:
1140 @itemize @bullet
1141 @item
1142 Unless GCC is being built with a cross compiler, check the
1143 @file{@var{libexec}/gcc/@var{target}/@var{version}} directory.
1144 @var{libexec} defaults to @file{@var{exec-prefix}/libexec};
1145 @var{exec-prefix} defaults to @var{prefix}, which
1146 defaults to @file{/usr/local} unless overridden by the
1147 @option{--prefix=@var{pathname}} switch described above.  @var{target}
1148 is the target system triple, such as @samp{sparc-sun-solaris2.11}, and
1149 @var{version} denotes the GCC version, such as 3.0.
1151 @item
1152 If the target system is the same that you are building on, check
1153 operating system specific directories.
1155 @item
1156 Check in the @env{PATH} for a tool whose name is prefixed by the
1157 target system triple.
1159 @item
1160 Check in the @env{PATH} for a tool whose name is not prefixed by the
1161 target system triple, if the host and target system triple are
1162 the same (in other words, we use a host tool if it can be used for
1163 the target as well).
1164 @end itemize
1166 You may want to use @option{--with-as} if no assembler
1167 is installed in the directories listed above, or if you have multiple
1168 assemblers installed and want to choose one that is not found by the
1169 above rules.
1171 @item @anchor{with-gnu-ld}--with-gnu-ld
1172 Same as @uref{#with-gnu-as,,@option{--with-gnu-as}}
1173 but for the linker.
1175 @item --with-ld=@var{pathname}
1176 Same as @uref{#with-as,,@option{--with-as}}
1177 but for the linker.
1179 @item --with-dsymutil=@var{pathname}
1180 Same as @uref{#with-as,,@option{--with-as}}
1181 but for the debug linker (only used on Darwin platforms so far).
1183 @item --with-tls=@var{dialect}
1184 Specify the default TLS dialect, for systems were there is a choice.
1185 For ARM targets, possible values for @var{dialect} are @code{gnu} or
1186 @code{gnu2}, which select between the original GNU dialect and the GNU TLS
1187 descriptor-based dialect.
1189 @item --enable-multiarch
1190 Specify whether to enable or disable multiarch support.  The default is
1191 to check for glibc start files in a multiarch location, and enable it
1192 if the files are found.  The auto detection is enabled for native builds,
1193 and for cross builds configured with @option{--with-sysroot}, and without
1194 @option{--with-native-system-header-dir}.
1195 More documentation about multiarch can be found at
1196 @uref{https://wiki.debian.org/Multiarch}.
1198 @item --enable-sjlj-exceptions
1199 Force use of the @code{setjmp}/@code{longjmp}-based scheme for exceptions.
1200 @samp{configure} ordinarily picks the correct value based on the platform.
1201 Only use this option if you are sure you need a different setting.
1203 @item --enable-vtable-verify
1204 Specify whether to enable or disable the vtable verification feature.
1205 Enabling this feature causes libstdc++ to be built with its virtual calls
1206 in verifiable mode.  This means that, when linked with libvtv, every
1207 virtual call in libstdc++ will verify the vtable pointer through which the
1208 call will be made before actually making the call.  If not linked with libvtv,
1209 the verifier will call stub functions (in libstdc++ itself) and do nothing.
1210 If vtable verification is disabled, then libstdc++ is not built with its
1211 virtual calls in verifiable mode at all.  However the libvtv library will
1212 still be built (see @option{--disable-libvtv} to turn off building libvtv).
1213 @option{--disable-vtable-verify} is the default.
1215 @item --disable-gcov
1216 Specify that the run-time library used for coverage analysis
1217 and associated host tools should not be built.
1219 @item --disable-multilib
1220 Specify that multiple target
1221 libraries to support different target variants, calling
1222 conventions, etc.@: should not be built.  The default is to build a
1223 predefined set of them.
1225 Some targets provide finer-grained control over which multilibs are built
1226 (e.g., @option{--disable-softfloat}):
1227 @table @code
1228 @item arm-*-*
1229 fpu, 26bit, underscore, interwork, biendian, nofmult.
1231 @item m68*-*-*
1232 softfloat, m68881, m68000, m68020.
1234 @item mips*-*-*
1235 single-float, biendian, softfloat.
1237 @item msp430-*-*
1238 no-exceptions
1240 @item powerpc*-*-*, rs6000*-*-*
1241 aix64, pthread, softfloat, powercpu, powerpccpu, powerpcos, biendian,
1242 sysv, aix.
1244 @end table
1246 @item --with-multilib-list=@var{list}
1247 @itemx --without-multilib-list
1248 Specify what multilibs to build.  @var{list} is a comma separated list of
1249 values, possibly consisting of a single value.  Currently only implemented
1250 for aarch64*-*-*, amdgcn*-*-*, arm*-*-*, loongarch*-*-*, riscv*-*-*, sh*-*-*
1251 and x86-64-*-linux*.  The accepted values and meaning for each target is given
1252 below.
1254 @table @code
1255 @item aarch64*-*-*
1256 @var{list} is a comma separated list of @code{ilp32}, and @code{lp64}
1257 to enable ILP32 and LP64 run-time libraries, respectively.  If
1258 @var{list} is empty, then there will be no multilibs and only the
1259 default run-time library will be built.  If @var{list} is
1260 @code{default} or --with-multilib-list= is not specified, then the
1261 default set of libraries is selected based on the value of
1262 @option{--target}.
1264 @item amdgcn*-*-*
1265 @var{list} is a comma separated list of ISA names (allowed values: @code{fiji},
1266 @code{gfx900}, @code{gfx906}, @code{gfx908}, @code{gfx90a}). It ought not
1267 include the name of the default ISA, specified via @option{--with-arch}.  If
1268 @var{list} is empty, then there will be no multilibs and only the default
1269 run-time library will be built.  If @var{list} is @code{default} or
1270 @option{--with-multilib-list=} is not specified, then the default set of
1271 libraries is selected.
1273 @item arm*-*-*
1274 @var{list} is a comma separated list of @code{aprofile} and
1275 @code{rmprofile} to build multilibs for A or R and M architecture
1276 profiles respectively.  Note that, due to some limitation of the current
1277 multilib framework, using the combined @code{aprofile,rmprofile}
1278 multilibs selects in some cases a less optimal multilib than when using
1279 the multilib profile for the architecture targetted.  The special value
1280 @code{default} is also accepted and is equivalent to omitting the
1281 option, i.e., only the default run-time library will be enabled.
1283 @var{list} may instead contain @code{@@name}, to use the multilib
1284 configuration Makefile fragment @file{name} in @file{gcc/config/arm} in
1285 the source tree (it is part of the corresponding sources, after all).
1286 It is recommended, but not required, that files used for this purpose to
1287 be named starting with @file{t-ml-}, to make their intended purpose
1288 self-evident, in line with GCC conventions.  Such files enable custom,
1289 user-chosen multilib lists to be configured.  Whether multiple such
1290 files can be used together depends on the contents of the supplied
1291 files.  See @file{gcc/config/arm/t-multilib} and its supplementary
1292 @file{gcc/config/arm/t-*profile} files for an example of what such
1293 Makefile fragments might look like for this version of GCC.  The macros
1294 expected to be defined in these fragments are not stable across GCC
1295 releases, so make sure they define the @code{MULTILIB}-related macros
1296 expected by the version of GCC you are building.
1297 @ifnothtml
1298 @xref{Target Fragment,, Target Makefile Fragments, gccint, GNU Compiler
1299 Collection (GCC) Internals}.
1300 @end ifnothtml
1301 @ifhtml
1302 See ``Target Makefile Fragments'' in the internals manual.
1303 @end ifhtml
1305 The table below gives the combination of ISAs, architectures, FPUs and
1306 floating-point ABIs for which multilibs are built for each predefined
1307 profile.  The union of these options is considered when specifying both
1308 @code{aprofile} and @code{rmprofile}.
1310 @multitable @columnfractions .15 .28 .30
1311 @item Option @tab aprofile @tab rmprofile
1312 @item ISAs
1313 @tab @code{-marm} and @code{-mthumb}
1314 @tab @code{-mthumb}
1315 @item Architectures@*@*@*@*@*@*
1316 @tab default architecture@*
1317 @code{-march=armv7-a}@*
1318 @code{-march=armv7ve}@*
1319 @code{-march=armv8-a}@*@*@*
1320 @tab default architecture@*
1321 @code{-march=armv6s-m}@*
1322 @code{-march=armv7-m}@*
1323 @code{-march=armv7e-m}@*
1324 @code{-march=armv8-m.base}@*
1325 @code{-march=armv8-m.main}@*
1326 @code{-march=armv7}
1327 @item FPUs@*@*@*@*@*
1328 @tab none@*
1329 @code{-mfpu=vfpv3-d16}@*
1330 @code{-mfpu=neon}@*
1331 @code{-mfpu=vfpv4-d16}@*
1332 @code{-mfpu=neon-vfpv4}@*
1333 @code{-mfpu=neon-fp-armv8}
1334 @tab none@*
1335 @code{-mfpu=vfpv3-d16}@*
1336 @code{-mfpu=fpv4-sp-d16}@*
1337 @code{-mfpu=fpv5-sp-d16}@*
1338 @code{-mfpu=fpv5-d16}@*
1339 @item floating-point@/ ABIs@*@*
1340 @tab @code{-mfloat-abi=soft}@*
1341 @code{-mfloat-abi=softfp}@*
1342 @code{-mfloat-abi=hard}
1343 @tab @code{-mfloat-abi=soft}@*
1344 @code{-mfloat-abi=softfp}@*
1345 @code{-mfloat-abi=hard}
1346 @end multitable
1348 @item loongarch*-*-*
1349 @var{list} is a comma-separated list, with each of the element starting with
1350 the following ABI identifiers: @code{lp64d[/base]} @code{lp64f[/base]}
1351 @code{lp64d[/base]} (the @code{/base} suffix may be omitted)
1352 to enable their respective run-time libraries.
1354 A suffix @code{[/@var{arch}][/@var{option}/@dots{}]} may follow immediately
1355 after the ABI identifier to customize the compiler options for building the
1356 given set of libraries.  @var{arch} denotes the architecture name recognized
1357 by the @option{-march=@var{arch}} compiler option, which acts as a basic target
1358 ISA configuration that can be adjusted using the subsequent @var{option}
1359 suffixes, where each @var{option} is a compiler option without a leading dash
1360 ('-').
1362 If no such suffix is present for a given multilib variant, the
1363 configured value of @option{--with-multilib-default} is appended as a default
1364 suffix.  If @option{--with-multilib-default} is not given, the default build
1365 option @option{-march=abi-default} is applied when building the variants
1366 without a suffix.
1368 As a special case, @code{fixed} may be used in the position of @var{arch},
1369 which means using the architecture configured with
1370 @option{--with-arch=@var{arch}}, or its default value (e.g. @code{loongarch64}
1371 for @code{loongarch64-*} targets).
1373 If @var{list} is empty or @code{default}, or if @option{--with-multilib-list}
1374 is not specified, then only the default variant of the libraries are built,
1375 where the default ABI is implied by the configured target triplet.
1377 @item riscv*-*-*
1378 @var{list} is a single ABI name.  The target architecture must be either
1379 @code{rv32gc} or @code{rv64gc}.  This will build a single multilib for the
1380 specified architecture and ABI pair.  If @code{--with-multilib-list} is not
1381 given, then a default set of multilibs is selected based on the value of
1382 @option{--target}.  This is usually a large set of multilibs.
1384 @item sh*-*-*
1385 @var{list} is a comma separated list of CPU names.  These must be of the
1386 form @code{sh*} or @code{m*} (in which case they match the compiler option
1387 for that processor).  The list should not contain any endian options -
1388 these are handled by @option{--with-endian}.
1390 If @var{list} is empty, then there will be no multilibs for extra
1391 processors.  The multilib for the secondary endian remains enabled.
1393 As a special case, if an entry in the list starts with a @code{!}
1394 (exclamation point), then it is added to the list of excluded multilibs.
1395 Entries of this sort should be compatible with @samp{MULTILIB_EXCLUDES}
1396 (once the leading @code{!} has been stripped).
1398 If @option{--with-multilib-list} is not given, then a default set of
1399 multilibs is selected based on the value of @option{--target}.  This is
1400 usually the complete set of libraries, but some targets imply a more
1401 specialized subset.
1403 Example 1: to configure a compiler for SH4A only, but supporting both
1404 endians, with little endian being the default:
1405 @smallexample
1406 --with-cpu=sh4a --with-endian=little,big --with-multilib-list=
1407 @end smallexample
1409 Example 2: to configure a compiler for both SH4A and SH4AL-DSP, but with
1410 only little endian SH4AL:
1411 @smallexample
1412 --with-cpu=sh4a --with-endian=little,big \
1413 --with-multilib-list=sh4al,!mb/m4al
1414 @end smallexample
1416 @item x86-64-*-linux*
1417 @var{list} is a comma separated list of @code{m32}, @code{m64} and
1418 @code{mx32} to enable 32-bit, 64-bit and x32 run-time libraries,
1419 respectively.  If @var{list} is empty, then there will be no multilibs
1420 and only the default run-time library will be enabled.
1422 If @option{--with-multilib-list} is not given, then only 32-bit and
1423 64-bit run-time libraries will be enabled.
1424 @end table
1426 @item --with-multilib-default
1427 On LoongArch targets, set the default build options for enabled multilibs
1428 without build options appended to their corresponding
1429 @option{--with-multilib-list} items.  The format of this value is
1430 @code{[/@var{arch}][/@var{option}/@dots{}]}, where @var{arch} is an
1431 architecture name recognized by @option{-march=@var{arch}} compiler option,
1432 and subsequent @var{option} suffixes are compiler options minus a leading
1433 dash ('-').
1435 Multiple @var{option}s may appear consecutively while @var{arch} may only
1436 appear in the beginning or be omitted (which means @option{-march=abi-default}
1437 is applied when building the libraries).
1439 @item --with-strict-align-lib
1440 On LoongArch targets, build all enabled multilibs with @option{-mstrict-align}
1441 (Not enabled by default).
1443 @item --with-multilib-generator=@var{config}
1444 Specify what multilibs to build.  @var{config} is a semicolon separated list of
1445 values, possibly consisting of a single value.  Currently only implemented
1446 for riscv*-*-elf*.  The accepted values and meanings are given below.
1449 Every config is constructed with four components: architecture string, ABI,
1450 reuse rule with architecture string and reuse rule with sub-extension.
1452 Example 1: Add multi-lib suppport for rv32i with ilp32.
1453 @smallexample
1454 rv32i-ilp32--
1455 @end smallexample
1457 Example 2: Add multi-lib suppport for rv32i with ilp32 and rv32imafd with ilp32.
1458 @smallexample
1459 rv32i-ilp32--;rv32imafd-ilp32--
1460 @end smallexample
1462 Example 3: Add multi-lib suppport for rv32i with ilp32; rv32im with ilp32 and
1463 rv32ic with ilp32 will reuse this multi-lib set.
1464 @smallexample
1465 rv32i-ilp32-rv32im-c
1466 @end smallexample
1468 Example 4: Add multi-lib suppport for rv64ima with lp64; rv64imaf with lp64,
1469 rv64imac with lp64 and rv64imafc with lp64 will reuse this multi-lib set.
1470 @smallexample
1471 rv64ima-lp64--f,c,fc
1472 @end smallexample
1474 @option{--with-multilib-generator} have an optional configuration argument
1475 @option{--cmodel=val} for code model, this option will expand with other
1476 config options, @var{val} is a comma separated list of possible code model,
1477 currently we support medlow and medany.
1479 Example 5: Add multi-lib suppport for rv64ima with lp64; rv64ima with lp64 and
1480 medlow code model
1481 @smallexample
1482 rv64ima-lp64--;--cmodel=medlow
1483 @end smallexample
1485 Example 6: Add multi-lib suppport for rv64ima with lp64; rv64ima with lp64 and
1486 medlow code model; rv64ima with lp64 and medany code model
1487 @smallexample
1488 rv64ima-lp64--;--cmodel=medlow,medany
1489 @end smallexample
1491 @item --with-endian=@var{endians}
1492 Specify what endians to use.
1493 Currently only implemented for sh*-*-*.
1495 @var{endians} may be one of the following:
1496 @table @code
1497 @item big
1498 Use big endian exclusively.
1499 @item little
1500 Use little endian exclusively.
1501 @item big,little
1502 Use big endian by default.  Provide a multilib for little endian.
1503 @item little,big
1504 Use little endian by default.  Provide a multilib for big endian.
1505 @end table
1507 @item --enable-threads
1508 Specify that the target
1509 supports threads.  This affects the Objective-C compiler and runtime
1510 library, and exception handling for other languages like C++.
1511 On some systems, this is the default.
1513 In general, the best (and, in many cases, the only known) threading
1514 model available will be configured for use.  Beware that on some
1515 systems, GCC has not been taught what threading models are generally
1516 available for the system.  In this case, @option{--enable-threads} is an
1517 alias for @option{--enable-threads=single}.
1519 @item --disable-threads
1520 Specify that threading support should be disabled for the system.
1521 This is an alias for @option{--enable-threads=single}.
1523 @item --enable-threads=@var{lib}
1524 Specify that
1525 @var{lib} is the thread support library.  This affects the Objective-C
1526 compiler and runtime library, and exception handling for other languages
1527 like C++.  The possibilities for @var{lib} are:
1529 @table @code
1530 @item aix
1531 AIX thread support.
1532 @item dce
1533 DCE thread support.
1534 @item lynx
1535 LynxOS thread support.
1536 @item mipssde
1537 MIPS SDE thread support.
1538 @item no
1539 This is an alias for @samp{single}.
1540 @item posix
1541 Generic POSIX/Unix98 thread support.
1542 @item rtems
1543 RTEMS thread support.
1544 @item single
1545 Disable thread support, should work for all platforms.
1546 @item tpf
1547 TPF thread support.
1548 @item vxworks
1549 VxWorks thread support.
1550 @item win32
1551 Microsoft Win32 API thread support.
1552 @end table
1554 @item --enable-tls
1555 Specify that the target supports TLS (Thread Local Storage).  Usually
1556 configure can correctly determine if TLS is supported.  In cases where
1557 it guesses incorrectly, TLS can be explicitly enabled or disabled with
1558 @option{--enable-tls} or @option{--disable-tls}.  This can happen if
1559 the assembler supports TLS but the C library does not, or if the
1560 assumptions made by the configure test are incorrect.
1562 @item --disable-tls
1563 Specify that the target does not support TLS.
1564 This is an alias for @option{--enable-tls=no}.
1566 @item --disable-tm-clone-registry
1567 Disable TM clone registry in libgcc. It is enabled in libgcc by default.
1568 This option helps to reduce code size for embedded targets which do
1569 not use transactional memory.
1571 @item --with-cpu=@var{cpu}
1572 @itemx --with-cpu-32=@var{cpu}
1573 @itemx --with-cpu-64=@var{cpu}
1574 Specify which cpu variant the compiler should generate code for by default.
1575 @var{cpu} will be used as the default value of the @option{-mcpu=} switch.
1576 This option is only supported on some targets, including ARC, ARM, i386, M68k,
1577 PowerPC, and SPARC@.  It is mandatory for ARC@.  The @option{--with-cpu-32} and
1578 @option{--with-cpu-64} options specify separate default CPUs for
1579 32-bit and 64-bit modes; these options are only supported for aarch64, i386,
1580 x86-64, PowerPC, and SPARC@.
1582 @item --with-schedule=@var{cpu}
1583 @itemx --with-arch=@var{cpu}
1584 @itemx --with-arch-32=@var{cpu}
1585 @itemx --with-arch-64=@var{cpu}
1586 @itemx --with-tune=@var{cpu}
1587 @itemx --with-tune-32=@var{cpu}
1588 @itemx --with-tune-64=@var{cpu}
1589 @itemx --with-abi=@var{abi}
1590 @itemx --with-fpu=@var{type}
1591 @itemx --with-float=@var{type}
1592 @itemx --with-simd=@var{type}
1593 These configure options provide default values for the @option{-mschedule=},
1594 @option{-march=}, @option{-mtune=}, @option{-mabi=}, and @option{-mfpu=}
1595 options and for @option{-mhard-float} or @option{-msoft-float}.  As with
1596 @option{--with-cpu}, which switches will be accepted and acceptable values
1597 of the arguments depend on the target.
1599 @item --with-mode=@var{mode}
1600 Specify if the compiler should default to @option{-marm} or @option{-mthumb}.
1601 This option is only supported on ARM targets.
1603 @item --with-stack-offset=@var{num}
1604 This option sets the default for the -mstack-offset=@var{num} option,
1605 and will thus generally also control the setting of this option for
1606 libraries.  This option is only supported on Epiphany targets.
1608 @item --with-fpmath=@var{isa}
1609 This options sets @option{-mfpmath=sse} by default and specifies the default
1610 ISA for floating-point arithmetics.  You can select either @samp{sse} which
1611 enables @option{-msse2} or @samp{avx} which enables @option{-mavx} by default.
1612 This option is only supported on i386 and x86-64 targets.
1614 @item --with-fp-32=@var{mode}
1615 On MIPS targets, set the default value for the @option{-mfp} option when using
1616 the o32 ABI.  The possibilities for @var{mode} are:
1617 @table @code
1618 @item 32
1619 Use the o32 FP32 ABI extension, as with the @option{-mfp32} command-line
1620 option.
1621 @item xx
1622 Use the o32 FPXX ABI extension, as with the @option{-mfpxx} command-line
1623 option.
1624 @item 64
1625 Use the o32 FP64 ABI extension, as with the @option{-mfp64} command-line
1626 option.
1627 @end table
1628 In the absence of this configuration option the default is to use the o32
1629 FP32 ABI extension.
1631 @item --with-odd-spreg-32
1632 On MIPS targets, set the @option{-modd-spreg} option by default when using
1633 the o32 ABI.
1635 @item --without-odd-spreg-32
1636 On MIPS targets, set the @option{-mno-odd-spreg} option by default when using
1637 the o32 ABI.  This is normally used in conjunction with
1638 @option{--with-fp-32=64} in order to target the o32 FP64A ABI extension.
1640 @item --with-nan=@var{encoding}
1641 On MIPS targets, set the default encoding convention to use for the
1642 special not-a-number (NaN) IEEE 754 floating-point data.  The
1643 possibilities for @var{encoding} are:
1644 @table @code
1645 @item legacy
1646 Use the legacy encoding, as with the @option{-mnan=legacy} command-line
1647 option.
1648 @item 2008
1649 Use the 754-2008 encoding, as with the @option{-mnan=2008} command-line
1650 option.
1651 @end table
1652 To use this configuration option you must have an assembler version
1653 installed that supports the @option{-mnan=} command-line option too.
1654 In the absence of this configuration option the default convention is
1655 the legacy encoding, as when neither of the @option{-mnan=2008} and
1656 @option{-mnan=legacy} command-line options has been used.
1658 @item --with-divide=@var{type}
1659 Specify how the compiler should generate code for checking for
1660 division by zero.  This option is only supported on the MIPS target.
1661 The possibilities for @var{type} are:
1662 @table @code
1663 @item traps
1664 Division by zero checks use conditional traps (this is the default on
1665 systems that support conditional traps).
1666 @item breaks
1667 Division by zero checks use the break instruction.
1668 @end table
1670 @item --with-compact-branches=@var{policy}
1671 Specify how the compiler should generate branch instructions.
1672 This option is only supported on the MIPS target.
1673 The possibilities for @var{type} are:
1674 @table @code
1675 @item optimal
1676 Cause a delay slot branch to be used if one is available in the
1677 current ISA and the delay slot is successfully filled. If the delay slot
1678 is not filled, a compact branch will be chosen if one is available.
1679 @item never
1680 Ensures that compact branch instructions will never be generated.
1681 @item always
1682 Ensures that a compact branch instruction will be generated if available.
1683 If a compact branch instruction is not available,
1684 a delay slot form of the branch will be used instead.
1685 This option is supported from MIPS Release 6 onwards.
1686 For pre-R6/microMIPS/MIPS16, this option is just same as never/optimal.
1687 @end table
1689 @c If you make --with-llsc the default for additional targets,
1690 @c update the --with-llsc description in the MIPS section below.
1692 @item --with-llsc
1693 On MIPS targets, make @option{-mllsc} the default when no
1694 @option{-mno-llsc} option is passed.  This is the default for
1695 Linux-based targets, as the kernel will emulate them if the ISA does
1696 not provide them.
1698 @item --without-llsc
1699 On MIPS targets, make @option{-mno-llsc} the default when no
1700 @option{-mllsc} option is passed.
1702 @item --with-synci
1703 On MIPS targets, make @option{-msynci} the default when no
1704 @option{-mno-synci} option is passed.
1706 @item --without-synci
1707 On MIPS targets, make @option{-mno-synci} the default when no
1708 @option{-msynci} option is passed.  This is the default.
1710 @item --with-lxc1-sxc1
1711 On MIPS targets, make @option{-mlxc1-sxc1} the default when no
1712 @option{-mno-lxc1-sxc1} option is passed.  This is the default.
1714 @item --without-lxc1-sxc1
1715 On MIPS targets, make @option{-mno-lxc1-sxc1} the default when no
1716 @option{-mlxc1-sxc1} option is passed.  The indexed load/store
1717 instructions are not directly a problem but can lead to unexpected
1718 behaviour when deployed in an application intended for a 32-bit address
1719 space but run on a 64-bit processor.  The issue is seen because all
1720 known MIPS 64-bit Linux kernels execute o32 and n32 applications
1721 with 64-bit addressing enabled which affects the overflow behaviour
1722 of the indexed addressing mode.  GCC will assume that ordinary
1723 32-bit arithmetic overflow behaviour is the same whether performed
1724 as an @code{addu} instruction or as part of the address calculation
1725 in @code{lwxc1} type instructions.  This assumption holds true in a
1726 pure 32-bit environment and can hold true in a 64-bit environment if
1727 the address space is accurately set to be 32-bit for o32 and n32.
1729 @item --with-madd4
1730 On MIPS targets, make @option{-mmadd4} the default when no
1731 @option{-mno-madd4} option is passed.  This is the default.
1733 @item --without-madd4
1734 On MIPS targets, make @option{-mno-madd4} the default when no
1735 @option{-mmadd4} option is passed.  The @code{madd4} instruction
1736 family can be problematic when targeting a combination of cores that
1737 implement these instructions differently.  There are two known cores
1738 that implement these as fused operations instead of unfused (where
1739 unfused is normally expected).  Disabling these instructions is the
1740 only way to ensure compatible code is generated; this will incur
1741 a performance penalty.
1743 @item --with-msa
1744 On MIPS targets, make @option{-mmsa} the default when no
1745 @option{-mno-msa} option is passed.
1747 @item --without-msa
1748 On MIPS targets, make @option{-mno-msa} the default when no
1749 @option{-mmsa} option is passed. This is the default.
1751 @item --with-mips-plt
1752 On MIPS targets, make use of copy relocations and PLTs.
1753 These features are extensions to the traditional
1754 SVR4-based MIPS ABIs and require support from GNU binutils
1755 and the runtime C library.
1757 @item --with-stack-clash-protection-guard-size=@var{size}
1758 On certain targets this option sets the default stack clash protection guard
1759 size as a power of two in bytes.  On AArch64 @var{size} is required to be either
1760 12 (4KB) or 16 (64KB).
1762 @item --with-isa-spec=@var{ISA-spec-string}
1763 On RISC-V targets specify the default version of the RISC-V Unprivileged
1764 (formerly User-Level) ISA specification to produce code conforming to.
1765 The possibilities for @var{ISA-spec-string} are:
1766 @table @code
1767 @item 2.2
1768 Produce code conforming to version 2.2.
1769 @item 20190608
1770 Produce code conforming to version 20190608.
1771 @item 20191213
1772 Produce code conforming to version 20191213.
1773 @end table
1774 In the absence of this configuration option the default version is 20191213.
1776 @item --enable-__cxa_atexit
1777 Define if you want to use __cxa_atexit, rather than atexit, to
1778 register C++ destructors for local statics and global objects.
1779 This is essential for fully standards-compliant handling of
1780 destructors, but requires __cxa_atexit in libc.  This option is currently
1781 only available on systems with GNU libc.  When enabled, this will cause
1782 @option{-fuse-cxa-atexit} to be passed by default.
1784 @item --enable-gnu-indirect-function
1785 Define if you want to enable the @code{ifunc} attribute.  This option is
1786 currently only available on systems with GNU libc on certain targets.
1788 @item --enable-target-optspace
1789 Specify that target
1790 libraries should be optimized for code space instead of code speed.
1791 This is the default for the m32r platform.
1793 @item --with-cpp-install-dir=@var{dirname}
1794 Specify that the user visible @command{cpp} program should be installed
1795 in @file{@var{prefix}/@var{dirname}/cpp}, in addition to @var{bindir}.
1797 @item --enable-comdat
1798 Enable COMDAT group support.  This is primarily used to override the
1799 automatically detected value.
1801 @item --enable-initfini-array
1802 Force the use of sections @code{.init_array} and @code{.fini_array}
1803 (instead of @code{.init} and @code{.fini}) for constructors and
1804 destructors.  Option @option{--disable-initfini-array} has the
1805 opposite effect.  If neither option is specified, the configure script
1806 will try to guess whether the @code{.init_array} and
1807 @code{.fini_array} sections are supported and, if they are, use them.
1809 @item --enable-link-mutex
1810 When building GCC, use a mutex to avoid linking the compilers for
1811 multiple languages at the same time, to avoid thrashing on build
1812 systems with limited free memory.  The default is not to use such a mutex.
1814 @item --enable-link-serialization
1815 When building GCC, use make dependencies to serialize linking the compilers for
1816 multiple languages, to avoid thrashing on build
1817 systems with limited free memory.  The default is not to add such
1818 dependencies and thus with parallel make potentially link different
1819 compilers concurrently.  If the argument is a positive integer, allow
1820 that number of concurrent link processes for the large binaries.
1822 @item --enable-maintainer-mode
1823 The build rules that regenerate the Autoconf and Automake output files as
1824 well as the GCC master message catalog @file{gcc.pot} are normally
1825 disabled.  This is because it can only be rebuilt if the complete source
1826 tree is present.  If you have changed the sources and want to rebuild the
1827 catalog, configuring with @option{--enable-maintainer-mode} will enable
1828 this.  Note that you need a recent version of the @code{gettext} tools
1829 to do so.
1831 @item --disable-bootstrap
1832 For a native build, the default configuration is to perform
1833 a 3-stage bootstrap of the compiler when @samp{make} is invoked,
1834 testing that GCC can compile itself correctly.  If you want to disable
1835 this process, you can configure with @option{--disable-bootstrap}.
1837 @item --enable-bootstrap
1838 In special cases, you may want to perform a 3-stage build
1839 even if the target and host triplets are different.
1840 This is possible when the host can run code compiled for
1841 the target (e.g.@: host is i686-linux, target is i486-linux).
1842 Starting from GCC 4.2, to do this you have to configure explicitly
1843 with @option{--enable-bootstrap}.
1845 @item --enable-generated-files-in-srcdir
1846 Neither the .c and .h files that are generated from Bison and flex nor the
1847 info manuals and man pages that are built from the .texi files are present
1848 in the repository development tree.  When building GCC from that development tree,
1849 or from one of our snapshots, those generated files are placed in your
1850 build directory, which allows for the source to be in a readonly
1851 directory.
1853 If you configure with @option{--enable-generated-files-in-srcdir} then those
1854 generated files will go into the source directory.  This is mainly intended
1855 for generating release or prerelease tarballs of the GCC sources, since it
1856 is not a requirement that the users of source releases to have flex, Bison,
1857 or makeinfo.
1859 @item --enable-version-specific-runtime-libs
1860 Specify
1861 that runtime libraries should be installed in the compiler specific
1862 subdirectory (@file{@var{libdir}/gcc}) rather than the usual places.  In
1863 addition, @samp{libstdc++}'s include files will be installed into
1864 @file{@var{libdir}} unless you overruled it by using
1865 @option{--with-gxx-include-dir=@var{dirname}}.  Using this option is
1866 particularly useful if you intend to use several versions of GCC in
1867 parallel.  The default is @samp{yes} for @samp{libada}, and @samp{no} for
1868 the remaining libraries.
1870 @item --with-darwin-extra-rpath
1871 This is provided to allow distributions to add a single additional
1872 runpath on Darwin / macOS systems. This allows for cases where the
1873 installed GCC library directories are then symlinked to a common
1874 directory outside of the GCC installation.
1876 @item @anchor{WithAixSoname}--with-aix-soname=@samp{aix}, @samp{svr4} or @samp{both}
1877 Traditional AIX shared library versioning (versioned @code{Shared Object}
1878 files as members of unversioned @code{Archive Library} files named
1879 @samp{lib.a}) causes numerous headaches for package managers. However,
1880 @code{Import Files} as members of @code{Archive Library} files allow for
1881 @strong{filename-based versioning} of shared libraries as seen on Linux/SVR4,
1882 where this is called the "SONAME". But as they prevent static linking,
1883 @code{Import Files} may be used with @code{Runtime Linking} only, where the
1884 linker does search for @samp{libNAME.so} before @samp{libNAME.a} library
1885 filenames with the @samp{-lNAME} linker flag.
1887 @anchor{AixLdCommand}For detailed information please refer to the AIX
1888 @uref{https://www.ibm.com/support/knowledgecenter/search/%22the%20ld%20command%2C%20also%20called%20the%20linkage%20editor%20or%20binder%22,,ld
1889 Command} reference.
1891 As long as shared library creation is enabled, upon:
1892 @table @code
1893 @item --with-aix-soname=aix
1894 @item --with-aix-soname=both
1895  A (traditional AIX) @code{Shared Archive Library} file is created:
1896  @itemize @bullet
1897   @item using the @samp{libNAME.a} filename scheme
1898   @item with the @code{Shared Object} file as archive member named
1899   @samp{libNAME.so.V} (except for @samp{libgcc_s}, where the @code{Shared
1900   Object} file is named @samp{shr.o} for backwards compatibility), which
1901   @itemize @minus
1902    @item is used for runtime loading from inside the @samp{libNAME.a} file
1903    @item is used for dynamic loading via
1904    @code{dlopen("libNAME.a(libNAME.so.V)", RTLD_MEMBER)}
1905    @item is used for shared linking
1906    @item is used for static linking, so no separate @code{Static Archive
1907    Library} file is needed
1908   @end itemize
1909  @end itemize
1910 @item --with-aix-soname=both
1911 @item --with-aix-soname=svr4
1912  A (second) @code{Shared Archive Library} file is created:
1913  @itemize @bullet
1914  @item using the @samp{libNAME.so.V} filename scheme
1915  @item with the @code{Shared Object} file as archive member named
1916  @samp{shr.o}, which
1917   @itemize @minus
1918    @item is created with the @code{-G linker flag}
1919    @item has the @code{F_LOADONLY} flag set
1920    @item is used for runtime loading from inside the @samp{libNAME.so.V} file
1921    @item is used for dynamic loading via @code{dlopen("libNAME.so.V(shr.o)",
1922    RTLD_MEMBER)}
1923   @end itemize
1924  @item with the @code{Import File} as archive member named @samp{shr.imp},
1925  which
1926   @itemize @minus
1927    @item refers to @samp{libNAME.so.V(shr.o)} as the "SONAME", to be recorded
1928    in the @code{Loader Section} of subsequent binaries
1929    @item indicates whether @samp{libNAME.so.V(shr.o)} is 32 or 64 bit
1930    @item lists all the public symbols exported by @samp{lib.so.V(shr.o)},
1931    eventually decorated with the @code{@samp{weak} Keyword}
1932    @item is necessary for shared linking against @samp{lib.so.V(shr.o)}
1933    @end itemize
1934   @end itemize
1935   A symbolic link using the @samp{libNAME.so} filename scheme is created:
1936   @itemize @bullet
1937   @item pointing to the @samp{libNAME.so.V} @code{Shared Archive Library} file
1938   @item to permit the @code{ld Command} to find @samp{lib.so.V(shr.imp)} via
1939   the @samp{-lNAME} argument (requires @code{Runtime Linking} to be enabled)
1940   @item to permit dynamic loading of @samp{lib.so.V(shr.o)} without the need
1941   to specify the version number via @code{dlopen("libNAME.so(shr.o)",
1942   RTLD_MEMBER)}
1943   @end itemize
1944 @end table
1946 As long as static library creation is enabled, upon:
1947 @table @code
1948 @item --with-aix-soname=svr4
1949  A @code{Static Archive Library} is created:
1950  @itemize @bullet
1951  @item using the @samp{libNAME.a} filename scheme
1952  @item with all the @code{Static Object} files as archive members, which
1953   @itemize @minus
1954    @item are used for static linking
1955   @end itemize
1956  @end itemize
1957 @end table
1959 While the aix-soname=@samp{svr4} option does not create @code{Shared Object}
1960 files as members of unversioned @code{Archive Library} files any more, package
1961 managers still are responsible to
1962 @uref{./specific.html#TransferAixShobj,,transfer} @code{Shared Object} files
1963 found as member of a previously installed unversioned @code{Archive Library}
1964 file into the newly installed @code{Archive Library} file with the same
1965 filename.
1967 @emph{WARNING:} Creating @code{Shared Object} files with @code{Runtime Linking}
1968 enabled may bloat the TOC, eventually leading to @code{TOC overflow} errors,
1969 requiring the use of either the @option{-Wl,-bbigtoc} linker flag (seen to
1970 break with the @code{GDB} debugger) or some of the TOC-related compiler flags,
1971 @ifnothtml
1972 @xref{RS/6000 and PowerPC Options,, RS/6000 and PowerPC Options, gcc,
1973 Using the GNU Compiler Collection (GCC)}.
1974 @end ifnothtml
1975 @ifhtml
1976 see ``RS/6000 and PowerPC Options'' in the main manual.
1977 @end ifhtml
1979 @option{--with-aix-soname} is currently supported by @samp{libgcc_s} only, so
1980 this option is still experimental and not for normal use yet.
1982 Default is the traditional behavior @option{--with-aix-soname=@samp{aix}}.
1984 @item --enable-languages=@var{lang1},@var{lang2},@dots{}
1985 Specify that only a particular subset of compilers and
1986 their runtime libraries should be built.  For a list of valid values for
1987 @var{langN} you can issue the following command in the
1988 @file{gcc} directory of your GCC source tree:@*
1989 @smallexample
1990 grep ^language= */config-lang.in
1991 @end smallexample
1992 Currently, you can use any of the following:
1993 @code{all}, @code{default}, @code{ada}, @code{c}, @code{c++}, @code{d},
1994 @code{fortran}, @code{go}, @code{jit}, @code{lto}, @code{m2},
1995 @code{objc}, @code{obj-c++}.
1996 Building the Ada compiler has special requirements, see below.
1997 If you do not pass this flag, or specify the option @code{default}, then the
1998 default languages available in the @file{gcc} sub-tree will be configured.
1999 Ada, D, Go, Jit, Objective-C++ and Modula-2 are not default languages.
2000 LTO is not a
2001 default language, but is built by default because @option{--enable-lto} is
2002 enabled by default.  The other languages are default languages.  If
2003 @code{all} is specified, then all available languages are built.  An
2004 exception is @code{jit} language, which requires
2005 @option{--enable-host-shared} to be included with @code{all}.
2007 @item --enable-stage1-languages=@var{lang1},@var{lang2},@dots{}
2008 Specify that a particular subset of compilers and their runtime
2009 libraries should be built with the system C compiler during stage 1 of
2010 the bootstrap process, rather than only in later stages with the
2011 bootstrapped C compiler.  The list of valid values is the same as for
2012 @option{--enable-languages}, and the option @code{all} will select all
2013 of the languages enabled by @option{--enable-languages}.  This option is
2014 primarily useful for GCC development; for instance, when a development
2015 version of the compiler cannot bootstrap due to compiler bugs, or when
2016 one is debugging front ends other than the C front end.  When this
2017 option is used, one can then build the target libraries for the
2018 specified languages with the stage-1 compiler by using @command{make
2019 stage1-bubble all-target}, or run the testsuite on the stage-1 compiler
2020 for the specified languages using @command{make stage1-start check-gcc}.
2022 @item --disable-libada
2023 Specify that the run-time libraries and tools used by GNAT should not
2024 be built.  This can be useful for debugging, or for compatibility with
2025 previous Ada build procedures, when it was required to explicitly
2026 do a @samp{make -C gcc gnatlib_and_tools}.
2028 @item --disable-libgm2
2029 Specify that the run-time libraries and tools used by Modula-2 should not
2030 be built.  This can be useful for debugging.
2032 @item --disable-libsanitizer
2033 Specify that the run-time libraries for the various sanitizers should
2034 not be built.
2036 @item --disable-libssp
2037 Specify that the run-time libraries for stack smashing protection
2038 should not be built or linked against.  On many targets library support
2039 is provided by the C library instead.
2041 @item --disable-libquadmath
2042 Specify that the GCC quad-precision math library should not be built.
2043 On some systems, the library is required to be linkable when building
2044 the Fortran front end, unless @option{--disable-libquadmath-support}
2045 is used.
2047 @item --disable-libquadmath-support
2048 Specify that the Fortran front end and @code{libgfortran} do not add
2049 support for @code{libquadmath} on systems supporting it.
2051 @item --disable-libgomp
2052 Specify that the GNU Offloading and Multi Processing Runtime Library
2053 should not be built.
2055 @item --disable-libvtv
2056 Specify that the run-time libraries used by vtable verification
2057 should not be built.
2059 @item --with-dwarf2
2060 Specify that the compiler should
2061 use DWARF debugging information as the default; the exact
2062 DWARF version that is the default is target-specific.
2064 @item --with-advance-toolchain=@var{at}
2065 On 64-bit PowerPC Linux systems, configure the compiler to use the
2066 header files, library files, and the dynamic linker from the Advance
2067 Toolchain release @var{at} instead of the default versions that are
2068 provided by the Linux distribution.  In general, this option is
2069 intended for the developers of GCC, and it is not intended for general
2070 use.
2072 @item --enable-targets=all
2073 @itemx --enable-targets=@var{target_list}
2074 Some GCC targets, e.g.@: powerpc64-linux, build bi-arch compilers.
2075 These are compilers that are able to generate either 64-bit or 32-bit
2076 code.  Typically, the corresponding 32-bit target, e.g.@:
2077 powerpc-linux for powerpc64-linux, only generates 32-bit code.  This
2078 option enables the 32-bit target to be a bi-arch compiler, which is
2079 useful when you want a bi-arch compiler that defaults to 32-bit, and
2080 you are building a bi-arch or multi-arch binutils in a combined tree.
2081 On mips-linux, this will build a tri-arch compiler (ABI o32/n32/64),
2082 defaulted to o32.
2083 Currently, this option only affects sparc-linux, powerpc-linux, x86-linux,
2084 mips-linux and s390-linux.
2086 @item --enable-default-pie
2087 Turn on @option{-fPIE} and @option{-pie} by default.
2089 @item --enable-secureplt
2090 This option enables @option{-msecure-plt} by default for powerpc-linux.
2091 @ifnothtml
2092 @xref{RS/6000 and PowerPC Options,, RS/6000 and PowerPC Options, gcc,
2093 Using the GNU Compiler Collection (GCC)},
2094 @end ifnothtml
2095 @ifhtml
2096 See ``RS/6000 and PowerPC Options'' in the main manual
2097 @end ifhtml
2099 @item --enable-default-ssp
2100 Turn on @option{-fstack-protector-strong} by default.
2102 @item --enable-cld
2103 This option enables @option{-mcld} by default for 32-bit x86 targets.
2104 @ifnothtml
2105 @xref{i386 and x86-64 Options,, i386 and x86-64 Options, gcc,
2106 Using the GNU Compiler Collection (GCC)},
2107 @end ifnothtml
2108 @ifhtml
2109 See ``i386 and x86-64 Options'' in the main manual
2110 @end ifhtml
2112 @item --enable-large-address-aware
2113 The @option{--enable-large-address-aware} option arranges for MinGW
2114 executables to be linked using the @option{--large-address-aware}
2115 option, that enables the use of more than 2GB of memory.  If GCC is
2116 configured with this option, its effects can be reversed by passing the
2117 @option{-Wl,--disable-large-address-aware} option to the so-configured
2118 compiler driver.
2120 @item --enable-win32-registry
2121 @itemx --enable-win32-registry=@var{key}
2122 @itemx --disable-win32-registry
2123 The @option{--enable-win32-registry} option enables Microsoft Windows-hosted GCC
2124 to look up installations paths in the registry using the following key:
2126 @smallexample
2127 @code{HKEY_LOCAL_MACHINE\SOFTWARE\Free Software Foundation\@var{key}}
2128 @end smallexample
2130 @var{key} defaults to GCC version number, and can be overridden by the
2131 @option{--enable-win32-registry=@var{key}} option.  Vendors and distributors
2132 who use custom installers are encouraged to provide a different key,
2133 perhaps one comprised of vendor name and GCC version number, to
2134 avoid conflict with existing installations.  This feature is enabled
2135 by default, and can be disabled by @option{--disable-win32-registry}
2136 option.  This option has no effect on the other hosts.
2138 @item --nfp
2139 Specify that the machine does not have a floating point unit.  This
2140 option only applies to @samp{m68k-sun-sunos@var{n}}.  On any other
2141 system, @option{--nfp} has no effect.
2143 @item --enable-werror
2144 @itemx --disable-werror
2145 @itemx --enable-werror=yes
2146 @itemx --enable-werror=no
2147 When you specify this option, it controls whether certain files in the
2148 compiler are built with @option{-Werror} in bootstrap stage2 and later.
2149 If you don't specify it, @option{-Werror} is turned on for the main
2150 development trunk.  However it defaults to off for release branches and
2151 final releases.  The specific files which get @option{-Werror} are
2152 controlled by the Makefiles.
2154 @item --enable-checking
2155 @itemx --disable-checking
2156 @itemx --enable-checking=@var{list}
2157 This option controls performing internal consistency checks in the compiler.
2158 It does not change the generated code, but adds error checking of the
2159 requested complexity.  This slows down the compiler and may only work
2160 properly if you are building the compiler with GCC@.
2162 When the option is not specified, the active set of checks depends on context.
2163 Namely, bootstrap stage 1 defaults to @samp{--enable-checking=yes}, builds
2164 from release branches or release archives default to
2165 @samp{--enable-checking=release}, and otherwise
2166 @samp{--enable-checking=yes,extra} is used.  When the option is
2167 specified without a @var{list}, the result is the same as
2168 @samp{--enable-checking=yes}.  Likewise, @samp{--disable-checking} is
2169 equivalent to @samp{--enable-checking=no}.
2171 The categories of checks available in @var{list} are @samp{yes} (most common
2172 checks @samp{assert,misc,gc,gimple,rtlflag,runtime,tree,types}), @samp{no}
2173 (no checks at all), @samp{all} (all but @samp{valgrind}), @samp{release}
2174 (cheapest checks @samp{assert,runtime}) or @samp{none} (same as @samp{no}).
2175 @samp{release} checks are always on and to disable them
2176 @samp{--disable-checking} or @samp{--enable-checking=no[,<other checks>]}
2177 must be explicitly requested.  Disabling assertions makes the compiler and
2178 runtime slightly faster but increases the risk of undetected internal errors
2179 causing wrong code to be generated.
2181 Individual checks can be enabled with these flags: @samp{assert}, @samp{df},
2182 @samp{extra}, @samp{fold}, @samp{gc}, @samp{gcac}, @samp{gimple},
2183 @samp{misc}, @samp{rtl}, @samp{rtlflag}, @samp{runtime}, @samp{tree},
2184 @samp{types} and @samp{valgrind}.  @samp{extra} extends @samp{misc}
2185 checking with extra checks that might affect code generation and should
2186 therefore not differ between stage1 and later stages in bootstrap.
2188 The @samp{valgrind} check requires the external @command{valgrind} simulator,
2189 available from @uref{https://valgrind.org}.  The @samp{rtl} checks are
2190 expensive and the @samp{df}, @samp{gcac} and @samp{valgrind} checks are very
2191 expensive.
2193 @item --disable-stage1-checking
2194 @itemx --enable-stage1-checking
2195 @itemx --enable-stage1-checking=@var{list}
2196 This option affects only bootstrap build.  If no @option{--enable-checking}
2197 option is specified the stage1 compiler is built with @samp{yes} checking
2198 enabled, otherwise the stage1 checking flags are the same as specified by
2199 @option{--enable-checking}.  To build the stage1 compiler with
2200 different checking options use @option{--enable-stage1-checking}.
2201 The list of checking options is the same as for @option{--enable-checking}.
2202 If your system is too slow or too small to bootstrap a released compiler
2203 with checking for stage1 enabled, you can use @samp{--disable-stage1-checking}
2204 to disable checking for the stage1 compiler.
2206 @item --enable-coverage
2207 @itemx --enable-coverage=@var{level}
2208 With this option, the compiler is built to collect self coverage
2209 information, every time it is run.  This is for internal development
2210 purposes, and only works when the compiler is being built with gcc.  The
2211 @var{level} argument controls whether the compiler is built optimized or
2212 not, values are @samp{opt} and @samp{noopt}.  For coverage analysis you
2213 want to disable optimization, for performance analysis you want to
2214 enable optimization.  When coverage is enabled, the default level is
2215 without optimization.
2217 @item --enable-gather-detailed-mem-stats
2218 When this option is specified more detailed information on memory
2219 allocation is gathered.  This information is printed when using
2220 @option{-fmem-report}.
2222 @item --enable-valgrind-annotations
2223 Mark selected memory related operations in the compiler when run under
2224 valgrind to suppress false positives.
2226 @item --enable-nls
2227 @itemx --disable-nls
2228 The @option{--enable-nls} option enables Native Language Support (NLS),
2229 which lets GCC output diagnostics in languages other than American
2230 English.  Native Language Support is enabled by default if not doing a
2231 canadian cross build.  The @option{--disable-nls} option disables NLS@.
2233 Note that this functionality requires either libintl (provided by GNU
2234 gettext) or C standard library that contains support for gettext (such
2235 as the GNU C Library).
2236 @xref{with-included-gettext,,--with-included-gettext} for more
2237 information on the conditions required to get gettext support.
2239 @item --with-libintl-prefix=@var{dir}
2240 @itemx --without-libintl-prefix
2241 Searches for libintl in @file{@var{dir}/include} and
2242 @file{@var{dir}/lib}, or disables manual searching for it, letting the
2243 linker handle it.
2245 @item --with-libintl-type=@var{type}
2246 Specifies the type of library to search for when looking for libintl.
2247 @var{type} can be one of @code{auto}, @code{static} or @code{shared}.
2249 @anchor{with-included-gettext}
2250 @item --with-included-gettext
2251 Only available if @file{gettext} is present in the source tree.
2253 Forces the gettext tree to be configured to build and use a new static
2254 libintl, overriding the system libintl.  Results in GCC being built
2255 against the newly built libintl rather than the system libintl.
2257 The build system makes a somewhat complicated choice when picking where
2258 to get gettext routines from.  The following table is a summary of the
2259 possible options:
2261 @c Thanks for summary, Bruno!
2262 @multitable @columnfractions .12 .12 .12 .2 .44
2263 @headitem GNU gettext present in sources
2264 @tab libintl installed on the system
2265 @tab @code{gettext} present in libc
2266 @tab @code{--with-included-gettext}
2267 @tab Effects on localization
2269 @item No @tab No  @tab No  @tab (ignored) @tab No localization
2270 @item No @tab No  @tab Yes @tab (ignored) @tab Localized, libc gettext
2271 @item No @tab Yes @tab No  @tab (ignored) @tab Localized, libintl
2272 @item No @tab Yes @tab Yes @tab (ignored) @tab Localized, libintl
2274 @item Yes @tab No  @tab No  @tab No  @tab Localized, new, static libintl
2275 @item Yes @tab No  @tab No  @tab Yes @tab Localized, new, static libintl
2276 @item Yes @tab No  @tab Yes @tab No  @tab Localized, libc gettext
2277 @item Yes @tab No  @tab Yes @tab Yes @tab Localized, new, static libintl
2278 @item Yes @tab Yes @tab No  @tab No  @tab Localized, libintl
2279 @item Yes @tab Yes @tab No  @tab Yes @tab Localized, new, static libintl
2280 @item Yes @tab Yes @tab Yes @tab No  @tab Localized, libintl
2281 @item Yes @tab Yes @tab Yes @tab Yes @tab Localized, new, static libintl
2282 @end multitable
2284 @item --with-catgets
2285 If NLS is enabled, and if the host lacks @code{gettext} but has the
2286 inferior @code{catgets} interface, the GCC build procedure normally
2287 ignores @code{catgets} and instead uses GCC's copy of the GNU
2288 @code{gettext} library.  The @option{--with-catgets} option causes the
2289 build procedure to use the host's @code{catgets} in this situation.
2291 @item --with-libiconv-prefix=@var{dir}
2292 Search for libiconv header files in @file{@var{dir}/include} and
2293 libiconv library files in @file{@var{dir}/lib}.
2295 @item --enable-obsolete
2296 Enable configuration for an obsoleted system.  If you attempt to
2297 configure GCC for a system (build, host, or target) which has been
2298 obsoleted, and you do not specify this flag, configure will halt with an
2299 error message.
2301 All support for systems which have been obsoleted in one release of GCC
2302 is removed entirely in the next major release, unless someone steps
2303 forward to maintain the port.
2305 @item --enable-decimal-float
2306 @itemx --enable-decimal-float=yes
2307 @itemx --enable-decimal-float=no
2308 @itemx --enable-decimal-float=bid
2309 @itemx --enable-decimal-float=dpd
2310 @itemx --disable-decimal-float
2311 Enable (or disable) support for the C decimal floating point extension
2312 that is in the IEEE 754-2008 standard.  This is enabled by default
2313 only on AArch64, PowerPC, i386, and x86_64 GNU/Linux systems.  Other
2314 systems may also support it, but require the user to specifically
2315 enable it.  You can optionally control which decimal floating point
2316 format is used (either @samp{bid} or @samp{dpd}).  The @samp{bid}
2317 (binary integer decimal) format is default on AArch64, i386 and x86_64
2318 systems, and the @samp{dpd} (densely packed decimal) format is default
2319 on PowerPC systems.
2321 @item --enable-fixed-point
2322 @itemx --disable-fixed-point
2323 Enable (or disable) support for C fixed-point arithmetic.
2324 This option is enabled by default for some targets (such as MIPS) which
2325 have hardware-support for fixed-point operations.  On other targets, you
2326 may enable this option manually.
2328 @item --with-long-double-128
2329 Specify if @code{long double} type should be 128-bit by default on selected
2330 GNU/Linux architectures.  If using @code{--without-long-double-128},
2331 @code{long double} will be by default 64-bit, the same as @code{double} type.
2332 When neither of these configure options are used, the default will be
2333 128-bit @code{long double} when built against GNU C Library 2.4 and later,
2334 64-bit @code{long double} otherwise.
2336 @item --with-long-double-format=ibm
2337 @itemx --with-long-double-format=ieee
2338 Specify whether @code{long double} uses the IBM extended double format
2339 or the IEEE 128-bit floating point format on PowerPC Linux systems.
2340 This configuration switch will only work on little endian PowerPC
2341 Linux systems and on big endian 64-bit systems where the default cpu
2342 is at least power7 (i.e.@: @option{--with-cpu=power7},
2343 @option{--with-cpu=power8}, or @option{--with-cpu=power9} is used).
2345 If you use the @option{--with-long-double-64} configuration option,
2346 the @option{--with-long-double-format=ibm} and
2347 @option{--with-long-double-format=ieee} options are ignored.
2349 The default @code{long double} format is to use IBM extended double.
2350 Until all of the libraries are converted to use IEEE 128-bit floating
2351 point, it is not recommended to use
2352 @option{--with-long-double-format=ieee}.
2354 @item --enable-fdpic
2355 On SH Linux systems, generate ELF FDPIC code.
2357 @item --with-gmp=@var{pathname}
2358 @itemx --with-gmp-include=@var{pathname}
2359 @itemx --with-gmp-lib=@var{pathname}
2360 @itemx --with-mpfr=@var{pathname}
2361 @itemx --with-mpfr-include=@var{pathname}
2362 @itemx --with-mpfr-lib=@var{pathname}
2363 @itemx --with-mpc=@var{pathname}
2364 @itemx --with-mpc-include=@var{pathname}
2365 @itemx --with-mpc-lib=@var{pathname}
2366 If you want to build GCC but do not have the GMP library, the MPFR
2367 library and/or the MPC library installed in a standard location and
2368 do not have their sources present in the GCC source tree then you
2369 can explicitly specify the directory where they are installed
2370 (@samp{--with-gmp=@var{gmpinstalldir}},
2371 @samp{--with-mpfr=@/@var{mpfrinstalldir}},
2372 @samp{--with-mpc=@/@var{mpcinstalldir}}).  The
2373 @option{--with-gmp=@/@var{gmpinstalldir}} option is shorthand for
2374 @option{--with-gmp-lib=@/@var{gmpinstalldir}/lib} and
2375 @option{--with-gmp-include=@/@var{gmpinstalldir}/include}.  Likewise the
2376 @option{--with-mpfr=@/@var{mpfrinstalldir}} option is shorthand for
2377 @option{--with-mpfr-lib=@/@var{mpfrinstalldir}/lib} and
2378 @option{--with-mpfr-include=@/@var{mpfrinstalldir}/include}, also the
2379 @option{--with-mpc=@/@var{mpcinstalldir}} option is shorthand for
2380 @option{--with-mpc-lib=@/@var{mpcinstalldir}/lib} and
2381 @option{--with-mpc-include=@/@var{mpcinstalldir}/include}.  If these
2382 shorthand assumptions are not correct, you can use the explicit
2383 include and lib options directly.  You might also need to ensure the
2384 shared libraries can be found by the dynamic linker when building and
2385 using GCC, for example by setting the runtime shared library path
2386 variable (@env{LD_LIBRARY_PATH} on GNU/Linux and Solaris systems).
2388 These flags are applicable to the host platform only.  When building
2389 a cross compiler, they will not be used to configure target libraries.
2391 @item --with-isl=@var{pathname}
2392 @itemx --with-isl-include=@var{pathname}
2393 @itemx --with-isl-lib=@var{pathname}
2394 If you do not have the isl library installed in a standard location and you
2395 want to build GCC, you can explicitly specify the directory where it is
2396 installed (@samp{--with-isl=@/@var{islinstalldir}}). The
2397 @option{--with-isl=@/@var{islinstalldir}} option is shorthand for
2398 @option{--with-isl-lib=@/@var{islinstalldir}/lib} and
2399 @option{--with-isl-include=@/@var{islinstalldir}/include}. If this
2400 shorthand assumption is not correct, you can use the explicit
2401 include and lib options directly.
2403 These flags are applicable to the host platform only.  When building
2404 a cross compiler, they will not be used to configure target libraries.
2406 @item --with-stage1-ldflags=@var{flags}
2407 This option may be used to set linker flags to be used when linking
2408 stage 1 of GCC.  These are also used when linking GCC if configured with
2409 @option{--disable-bootstrap}.  If @option{--with-stage1-libs} is not set to a
2410 value, then the default is @samp{-static-libstdc++ -static-libgcc}, if
2411 supported.
2413 @item --with-stage1-libs=@var{libs}
2414 This option may be used to set libraries to be used when linking stage 1
2415 of GCC.  These are also used when linking GCC if configured with
2416 @option{--disable-bootstrap}.
2418 @item --with-boot-ldflags=@var{flags}
2419 This option may be used to set linker flags to be used when linking
2420 stage 2 and later when bootstrapping GCC.  If --with-boot-libs
2421 is not is set to a value, then the default is
2422 @samp{-static-libstdc++ -static-libgcc}.
2424 @item --with-boot-libs=@var{libs}
2425 This option may be used to set libraries to be used when linking stage 2
2426 and later when bootstrapping GCC.
2428 @item --with-debug-prefix-map=@var{map}
2429 Convert source directory names using @option{-fdebug-prefix-map} when
2430 building runtime libraries.  @samp{@var{map}} is a space-separated
2431 list of maps of the form @samp{@var{old}=@var{new}}.
2433 @item --enable-linker-build-id
2434 Tells GCC to pass @option{--build-id} option to the linker for all final
2435 links (links performed without the @option{-r} or @option{--relocatable}
2436 option), if the linker supports it.  If you specify
2437 @option{--enable-linker-build-id}, but your linker does not
2438 support @option{--build-id} option, a warning is issued and the
2439 @option{--enable-linker-build-id} option is ignored.  The default is off.
2441 @item --with-linker-hash-style=@var{choice}
2442 Tells GCC to pass @option{--hash-style=@var{choice}} option to the
2443 linker for all final links. @var{choice} can be one of
2444 @samp{sysv}, @samp{gnu}, and @samp{both} where @samp{sysv} is the default.
2446 @item --enable-gnu-unique-object
2447 @itemx --disable-gnu-unique-object
2448 Tells GCC to use the gnu_unique_object relocation for C++ template
2449 static data members and inline function local statics.  Enabled by
2450 default for a toolchain with an assembler that accepts it and
2451 GLIBC 2.11 or above, otherwise disabled.
2453 @item --with-diagnostics-color=@var{choice}
2454 Tells GCC to use @var{choice} as the default for @option{-fdiagnostics-color=}
2455 option (if not used explicitly on the command line).  @var{choice}
2456 can be one of @samp{never}, @samp{auto}, @samp{always}, and @samp{auto-if-env}
2457 where @samp{auto} is the default.  @samp{auto-if-env} makes
2458 @option{-fdiagnostics-color=auto} the default if @env{GCC_COLORS}
2459 is present and non-empty in the environment of the compiler, and
2460 @option{-fdiagnostics-color=never} otherwise.
2462 @item --with-diagnostics-urls=@var{choice}
2463 Tells GCC to use @var{choice} as the default for @option{-fdiagnostics-urls=}
2464 option (if not used explicitly on the command line).  @var{choice}
2465 can be one of @samp{never}, @samp{auto}, @samp{always}, and @samp{auto-if-env}
2466 where @samp{auto} is the default.  @samp{auto-if-env} makes
2467 @option{-fdiagnostics-urls=auto} the default if @env{GCC_URLS}
2468 or @env{TERM_URLS} is present and non-empty in the environment of the
2469 compiler, and @option{-fdiagnostics-urls=never} otherwise.
2471 @item --enable-lto
2472 @itemx --disable-lto
2473 Enable support for link-time optimization (LTO).  This is enabled by
2474 default, and may be disabled using @option{--disable-lto}.
2476 @item --enable-linker-plugin-configure-flags=FLAGS
2477 @itemx --enable-linker-plugin-flags=FLAGS
2478 By default, linker plugins (such as the LTO plugin) are built for the
2479 host system architecture.  For the case that the linker has a
2480 different (but run-time compatible) architecture, these flags can be
2481 specified to build plugins that are compatible to the linker.  For
2482 example, if you are building GCC for a 64-bit x86_64
2483 (@samp{x86_64-pc-linux-gnu}) host system, but have a 32-bit x86
2484 GNU/Linux (@samp{i686-pc-linux-gnu}) linker executable (which is
2485 executable on the former system), you can configure GCC as follows for
2486 getting compatible linker plugins:
2488 @smallexample
2489 % @var{srcdir}/configure \
2490     --host=x86_64-pc-linux-gnu \
2491     --enable-linker-plugin-configure-flags=--host=i686-pc-linux-gnu \
2492     --enable-linker-plugin-flags='CC=gcc\ -m32\ -Wl,-rpath,[...]/i686-pc-linux-gnu/lib'
2493 @end smallexample
2495 @item --with-plugin-ld=@var{pathname}
2496 Enable an alternate linker to be used at link-time optimization (LTO)
2497 link time when @option{-fuse-linker-plugin} is enabled.
2498 This linker should have plugin support such as gold starting with
2499 version 2.20 or GNU ld starting with version 2.21.
2500 See @option{-fuse-linker-plugin} for details.
2502 @item --enable-canonical-system-headers
2503 @itemx --disable-canonical-system-headers
2504 Enable system header path canonicalization for @file{libcpp}.  This can
2505 produce shorter header file paths in diagnostics and dependency output
2506 files, but these changed header paths may conflict with some compilation
2507 environments.  Enabled by default, and may be disabled using
2508 @option{--disable-canonical-system-headers}.
2510 @item --with-glibc-version=@var{major}.@var{minor}
2511 Tell GCC that when the GNU C Library (glibc) is used on the target it
2512 will be version @var{major}.@var{minor} or later.  Normally this can
2513 be detected from the C library's header files, but this option may be
2514 needed when bootstrapping a cross toolchain without the header files
2515 available for building the initial bootstrap compiler.
2517 If GCC is configured with some multilibs that use glibc and some that
2518 do not, this option applies only to the multilibs that use glibc.
2519 However, such configurations may not work well as not all the relevant
2520 configuration in GCC is on a per-multilib basis.
2522 @item --enable-as-accelerator-for=@var{target}
2523 Build as offload target compiler. Specify offload host triple by @var{target}.
2525 @item --enable-offload-targets=@var{target1}[=@var{path1}],@dots{},@var{targetN}[=@var{pathN}]
2526 Enable offloading to targets @var{target1}, @dots{}, @var{targetN}.
2527 Offload compilers are expected to be already installed.  Default search
2528 path for them is @file{@var{exec-prefix}}, but it can be changed by
2529 specifying paths @var{path1}, @dots{}, @var{pathN}.
2531 @smallexample
2532 % @var{srcdir}/configure \
2533     --enable-offload-targets=amdgcn-amdhsa,nvptx-none
2534 @end smallexample
2536 @item --enable-offload-defaulted
2538 Tell GCC that configured but not installed offload compilers and libgomp
2539 plugins are silently ignored.  Useful for distribution compilers where
2540 those are in separate optional packages and where the presence or absence
2541 of those optional packages should determine the actual supported offloading
2542 target set rather than the GCC configure-time selection.
2544 @item --enable-cet
2545 @itemx --disable-cet
2546 Enable building target run-time libraries with control-flow
2547 instrumentation, see @option{-fcf-protection} option.  When
2548 @code{--enable-cet} is specified target libraries are configured
2549 to add @option{-fcf-protection} and, if needed, other target
2550 specific options to a set of building options.
2552 @code{--enable-cet=auto} is default.  CET is enabled on Linux/x86 if
2553 target binutils supports @code{Intel CET} instructions and disabled
2554 otherwise.  In this case, the target libraries are configured to get
2555 additional @option{-fcf-protection} option.
2557 @item --with-riscv-attribute=@samp{yes}, @samp{no} or @samp{default}
2558 Generate RISC-V attribute by default, in order to record extra build
2559 information in object.
2561 The option is disabled by default. It is enabled on RISC-V/ELF (bare-metal)
2562 target if target binutils supported.
2564 @item --enable-s390-excess-float-precision
2565 @itemx --disable-s390-excess-float-precision
2566 On s390(x) targets, enable treatment of float expressions with double precision
2567 when in standards-compliant mode (e.g., when @code{--std=c99} or
2568 @code{-fexcess-precision=standard} are given).
2570 For a native build and cross compiles that have target headers, the option's
2571 default is derived from glibc's behavior. When glibc clamps float_t to double,
2572 GCC follows and enables the option. For other cross compiles, the default is
2573 disabled.
2575 @item --with-zstd=@var{pathname}
2576 @itemx --with-zstd-include=@var{pathname}
2577 @itemx --with-zstd-lib=@var{pathname}
2578 If you do not have the @code{zstd} library installed in a standard
2579 location and you want to build GCC, you can explicitly specify the
2580 directory where it is installed (@samp{--with-zstd=@/@var{zstdinstalldir}}).
2581 The @option{--with-zstd=@/@var{zstdinstalldir}} option is shorthand for
2582 @option{--with-zstd-lib=@/@var{zstdinstalldir}/lib} and
2583 @option{--with-zstd-include=@/@var{zstdinstalldir}/include}. If this
2584 shorthand assumption is not correct, you can use the explicit
2585 include and lib options directly.
2587 These flags are applicable to the host platform only.  When building
2588 a cross compiler, they will not be used to configure target libraries.
2589 @end table
2591 @subheading Cross-Compiler-Specific Options
2592 The following options only apply to building cross compilers.
2594 @table @code
2595 @item --with-toolexeclibdir=@var{dir}
2596 Specify the installation directory for libraries built with a cross compiler.
2597 The default is @option{$@{gcc_tooldir@}/lib}.
2599 @item --with-sysroot
2600 @itemx --with-sysroot=@var{dir}
2601 Tells GCC to consider @var{dir} as the root of a tree that contains
2602 (a subset of) the root filesystem of the target operating system.
2603 Target system headers, libraries and run-time object files will be
2604 searched for in there.  More specifically, this acts as if
2605 @option{--sysroot=@var{dir}} was added to the default options of the built
2606 compiler.  The specified directory is not copied into the
2607 install tree, unlike the options @option{--with-headers} and
2608 @option{--with-libs} that this option obsoletes.  The default value,
2609 in case @option{--with-sysroot} is not given an argument, is
2610 @option{$@{gcc_tooldir@}/sys-root}.  If the specified directory is a
2611 subdirectory of @option{$@{exec_prefix@}}, then it will be found relative to
2612 the GCC binaries if the installation tree is moved.
2614 This option affects the system root for the compiler used to build
2615 target libraries (which runs on the build system) and the compiler newly
2616 installed with @code{make install}; it does not affect the compiler which is
2617 used to build GCC itself.
2619 If you specify the @option{--with-native-system-header-dir=@var{dirname}}
2620 option then the compiler will search that directory within @var{dirname} for
2621 native system headers rather than the default @file{/usr/include}.
2623 @item --with-build-sysroot
2624 @itemx --with-build-sysroot=@var{dir}
2625 Tells GCC to consider @var{dir} as the system root (see
2626 @option{--with-sysroot}) while building target libraries, instead of
2627 the directory specified with @option{--with-sysroot}.  This option is
2628 only useful when you are already using @option{--with-sysroot}.  You
2629 can use @option{--with-build-sysroot} when you are configuring with
2630 @option{--prefix} set to a directory that is different from the one in
2631 which you are installing GCC and your target libraries.
2633 This option affects the system root for the compiler used to build
2634 target libraries (which runs on the build system); it does not affect
2635 the compiler which is used to build GCC itself.
2637 If you specify the @option{--with-native-system-header-dir=@var{dirname}}
2638 option then the compiler will search that directory within @var{dirname} for
2639 native system headers rather than the default @file{/usr/include}.
2641 @item --with-headers
2642 @itemx --with-headers=@var{dir}
2643 Deprecated in favor of @option{--with-sysroot}.
2644 Specifies that target headers are available when building a cross compiler.
2645 The @var{dir} argument specifies a directory which has the target include
2646 files.  These include files will be copied into the @file{gcc} install
2647 directory.  @emph{This option with the @var{dir} argument is required} when
2648 building a cross compiler, if @file{@var{prefix}/@var{target}/sys-include}
2649 doesn't pre-exist.  If @file{@var{prefix}/@var{target}/sys-include} does
2650 pre-exist, the @var{dir} argument may be omitted.  @command{fixincludes}
2651 will be run on these files to make them compatible with GCC@.
2653 @item --without-headers
2654 Tells GCC not use any target headers from a libc when building a cross
2655 compiler.  When crossing to GNU/Linux, you need the headers so GCC
2656 can build the exception handling for libgcc.
2658 @item --with-libs
2659 @itemx --with-libs="@var{dir1} @var{dir2} @dots{} @var{dirN}"
2660 Deprecated in favor of @option{--with-sysroot}.
2661 Specifies a list of directories which contain the target runtime
2662 libraries.  These libraries will be copied into the @file{gcc} install
2663 directory.  If the directory list is omitted, this option has no
2664 effect.
2666 @item --with-newlib
2667 Specifies that @samp{newlib} is
2668 being used as the target C library.  This causes @code{__eprintf} to be
2669 omitted from @file{libgcc.a} on the assumption that it will be provided by
2670 @samp{newlib}.
2672 @html
2673 <a name="avr"></a>
2674 @end html
2675 @item --with-avrlibc
2676 Only supported for the AVR target. Specifies that @samp{AVR-Libc} is
2677 being used as the target C@tie{} library.  This causes float support
2678 functions like @code{__addsf3} to be omitted from @file{libgcc.a} on
2679 the assumption that it will be provided by @file{libm.a}.  For more
2680 technical details, cf. @uref{https://gcc.gnu.org/PR54461,,PR54461}.
2681 It is not supported for
2682 RTEMS configurations, which currently use newlib.  The option is
2683 supported since version 4.7.2 and is the default in 4.8.0 and newer.
2685 @item --with-double=@{32|64|32,64|64,32@}
2686 @itemx --with-long-double=@{32|64|32,64|64,32|double@}
2687 Only supported for the AVR target since version@tie{}10.
2688 Specify the default layout available for the C/C++ @samp{double}
2689 and @samp{long double} type, respectively. The following rules apply:
2690 @itemize
2691 @item
2692 The first value after the @samp{=} specifies the default layout (in bits)
2693 of the type and also the default for the @option{-mdouble=} resp.
2694 @option{-mlong-double=} compiler option.
2695 @item
2696 If more than one value is specified, respective multilib variants are
2697 available, and  @option{-mdouble=} resp. @option{-mlong-double=} acts
2698 as a multilib option.
2699 @item
2700 If @option{--with-long-double=double} is specified, @samp{double} and
2701 @samp{long double} will have the same layout.
2702 @item
2703 The defaults are @option{--with-long-double=64,32} and
2704 @option{--with-double=32,64}.  The default @samp{double} layout imposed by
2705 the latter is compatible with older versions of the compiler that implement
2706 @samp{double} as a 32-bit type, which does not comply to the language standard.
2707 @end itemize
2708 Not all combinations of @option{--with-double=} and
2709 @option{--with-long-double=} are valid.  For example, the combination
2710 @option{--with-double=32,64} @option{--with-long-double=32} will be
2711 rejected because the first option specifies the availability of
2712 multilibs for @samp{double}, whereas the second option implies
2713 that @samp{long double} --- and hence also @samp{double} --- is always
2714 32@tie{}bits wide.
2716 @item --with-double-comparison=@{tristate|bool|libf7@}
2717 Only supported for the AVR target since version@tie{}10.
2718 Specify what result format is returned by library functions that
2719 compare 64-bit floating point values (@code{DFmode}).
2720 The GCC default is @samp{tristate}.  If the floating point
2721 implementation returns a boolean instead, set it to @samp{bool}.
2723 @item --with-libf7=@{libgcc|math|math-symbols|no@}
2724 Only supported for the AVR target since version@tie{}10.
2725 Specify to which degree code from LibF7 is included in libgcc.
2726 LibF7 is an ad-hoc, AVR-specific, 64-bit floating point emulation
2727 written in C and (inline) assembly. @samp{libgcc} adds support
2728 for functions that one would usually expect in libgcc like double addition,
2729 double comparisons and double conversions. @samp{math} also adds routines
2730 that one would expect in @file{libm.a}, but with @code{__} (two underscores)
2731 prepended to the symbol names as specified by @file{math.h}.
2732 @samp{math-symbols} also defines weak aliases for the functions
2733 declared in @file{math.h}.  However, @code{--with-libf7} won't
2734 install no @file{math.h} header file whatsoever, this file must come
2735 from elsewhere.  This option sets @option{--with-double-comparison}
2736 to @samp{bool}.
2738 @item --with-nds32-lib=@var{library}
2739 Specifies that @var{library} setting is used for building @file{libgcc.a}.
2740 Currently, the valid @var{library} is @samp{newlib} or @samp{mculib}.
2741 This option is only supported for the NDS32 target.
2743 @item --with-build-time-tools=@var{dir}
2744 Specifies where to find the set of target tools (assembler, linker, etc.)
2745 that will be used while building GCC itself.  This option can be useful
2746 if the directory layouts are different between the system you are building
2747 GCC on, and the system where you will deploy it.
2749 For example, on an @samp{ia64-hp-hpux} system, you may have the GNU
2750 assembler and linker in @file{/usr/bin}, and the native tools in a
2751 different path, and build a toolchain that expects to find the
2752 native tools in @file{/usr/bin}.
2754 When you use this option, you should ensure that @var{dir} includes
2755 @command{ar}, @command{as}, @command{ld}, @command{nm},
2756 @command{ranlib} and @command{strip} if necessary, and possibly
2757 @command{objdump}.  Otherwise, GCC may use an inconsistent set of
2758 tools.
2759 @end table
2761 @subsubheading Overriding @command{configure} test results
2763 Sometimes, it might be necessary to override the result of some
2764 @command{configure} test, for example in order to ease porting to a new
2765 system or work around a bug in a test.  The toplevel @command{configure}
2766 script provides three variables for this:
2768 @table @code
2770 @cindex @code{build_configargs}
2771 @item build_configargs
2772 The contents of this variable is passed to all build @command{configure}
2773 scripts.
2775 @cindex @code{host_configargs}
2776 @item host_configargs
2777 The contents of this variable is passed to all host @command{configure}
2778 scripts.
2780 @cindex @code{target_configargs}
2781 @item target_configargs
2782 The contents of this variable is passed to all target @command{configure}
2783 scripts.
2785 @end table
2787 In order to avoid shell and @command{make} quoting issues for complex
2788 overrides, you can pass a setting for @env{CONFIG_SITE} and set
2789 variables in the site file.
2791 @subheading Objective-C-Specific Options
2793 The following options apply to the build of the Objective-C runtime library.
2795 @table @code
2796 @item --enable-objc-gc
2797 Specify that an additional variant of the GNU Objective-C runtime library
2798 is built, using an external build of the Boehm-Demers-Weiser garbage
2799 collector (@uref{https://www.hboehm.info/gc/}).  This library needs to be
2800 available for each multilib variant, unless configured with
2801 @option{--enable-objc-gc=@samp{auto}} in which case the build of the
2802 additional runtime library is skipped when not available and the build
2803 continues.
2805 @item --with-target-bdw-gc=@var{list}
2806 @itemx --with-target-bdw-gc-include=@var{list}
2807 @itemx --with-target-bdw-gc-lib=@var{list}
2808 Specify search directories for the garbage collector header files and
2809 libraries. @var{list} is a comma separated list of key value pairs of the
2810 form @samp{@var{multilibdir}=@var{path}}, where the default multilib key
2811 is named as @samp{.} (dot), or is omitted (e.g.@:
2812 @samp{--with-target-bdw-gc=/opt/bdw-gc,32=/opt-bdw-gc32}).
2814 The options @option{--with-target-bdw-gc-include} and
2815 @option{--with-target-bdw-gc-lib} must always be specified together
2816 for each multilib variant and they take precedence over
2817 @option{--with-target-bdw-gc}.  If @option{--with-target-bdw-gc-include}
2818 is missing values for a multilib, then the value for the default
2819 multilib is used (e.g.@: @samp{--with-target-bdw-gc-include=/opt/bdw-gc/include}
2820 @samp{--with-target-bdw-gc-lib=/opt/bdw-gc/lib64,32=/opt-bdw-gc/lib32}).
2821 If none of these options are specified, the library is assumed in
2822 default locations.
2823 @end table
2825 @subheading D-Specific Options
2827 The following options apply to the build of the D runtime library.
2829 @table @code
2830 @item --enable-libphobos-checking
2831 @itemx --disable-libphobos-checking
2832 @itemx --enable-libphobos-checking=@var{list}
2833 This option controls whether run-time checks and contracts are compiled into
2834 the D runtime library.  When the option is not specified, the library is built
2835 with @samp{release} checking.  When the option is specified without a
2836 @var{list}, the result is the same as @samp{--enable-libphobos-checking=yes}.
2837 Likewise, @samp{--disable-libphobos-checking} is equivalent to
2838 @samp{--enable-libphobos-checking=no}.
2840 The categories of checks available in @var{list} are @samp{yes} (compiles
2841 libphobos with @option{-fno-release}), @samp{no} (compiles libphobos with
2842 @option{-frelease}), @samp{all} (same as @samp{yes}), @samp{none} or
2843 @samp{release} (same as @samp{no}).
2845 Individual checks available in @var{list} are @samp{assert} (compiles libphobos
2846 with an extra option @option{-fassert}).
2848 @item --with-libphobos-druntime-only
2849 @itemx --with-libphobos-druntime-only=@var{choice}
2850 Specify whether to build only the core D runtime library (druntime), or both
2851 the core and standard library (phobos) into libphobos.  This is useful for
2852 targets that have full support in druntime, but no or incomplete support
2853 in phobos.  @var{choice} can be one of @samp{auto}, @samp{yes}, and @samp{no}
2854 where @samp{auto} is the default.
2856 When the option is not specified, the default choice @samp{auto} means that it
2857 is inferred whether the target has support for the phobos standard library.
2858 When the option is specified without a @var{choice},  the result is the same as
2859 @samp{--with-libphobos-druntime-only=yes}.
2861 @item --with-target-system-zlib
2862 Use installed @samp{zlib} rather than that included with GCC@.  This needs
2863 to be available for each multilib variant, unless configured with
2864 @option{--with-target-system-zlib=@samp{auto}} in which case the GCC@ included
2865 @samp{zlib} is only used when the system installed library is not available.
2866 @end table
2868 @html
2869 <hr />
2871 @end html
2872 @ifhtml
2873 @uref{./index.html,,Return to the GCC Installation page}
2874 @end ifhtml
2875 @end ifset
2877 @c ***Building****************************************************************
2878 @ifnothtml
2879 @comment node-name,     next,          previous, up
2880 @node    Building, Testing, Configuration, Installing GCC
2881 @end ifnothtml
2882 @ifset buildhtml
2883 @ifnothtml
2884 @chapter Building
2885 @end ifnothtml
2886 @cindex Installing GCC: Building
2888 Now that GCC is configured, you are ready to build the compiler and
2889 runtime libraries.
2891 Some commands executed when making the compiler may fail (return a
2892 nonzero status) and be ignored by @command{make}.  These failures, which
2893 are often due to files that were not found, are expected, and can safely
2894 be ignored.
2896 It is normal to have compiler warnings when compiling certain files.
2897 Unless you are a GCC developer, you can generally ignore these warnings
2898 unless they cause compilation to fail.  Developers should attempt to fix
2899 any warnings encountered, however they can temporarily continue past
2900 warnings-as-errors by specifying the configure flag
2901 @option{--disable-werror}.
2903 On certain old systems, defining certain environment variables such as
2904 @env{CC} can interfere with the functioning of @command{make}.
2906 If you encounter seemingly strange errors when trying to build the
2907 compiler in a directory other than the source directory, it could be
2908 because you have previously configured the compiler in the source
2909 directory.  Make sure you have done all the necessary preparations.
2911 If you build GCC on a BSD system using a directory stored in an old System
2912 V file system, problems may occur in running @command{fixincludes} if the
2913 System V file system doesn't support symbolic links.  These problems
2914 result in a failure to fix the declaration of @code{size_t} in
2915 @file{sys/types.h}.  If you find that @code{size_t} is a signed type and
2916 that type mismatches occur, this could be the cause.
2918 The solution is not to use such a directory for building GCC@.
2920 Similarly, when building from the source repository or snapshots, or if you modify
2921 @file{*.l} files, you need the Flex lexical analyzer generator
2922 installed.  If you do not modify @file{*.l} files, releases contain
2923 the Flex-generated files and you do not need Flex installed to build
2924 them.  There is still one Flex-based lexical analyzer (part of the
2925 build machinery, not of GCC itself) that is used even if you only
2926 build the C front end.
2928 When building from the source repository or snapshots, or if you modify Texinfo
2929 documentation, you need version 4.7 or later of Texinfo installed if you
2930 want Info documentation to be regenerated.  Releases contain Info
2931 documentation pre-built for the unmodified documentation in the release.
2933 @section Building a native compiler
2935 For a native build, the default configuration is to perform
2936 a 3-stage bootstrap of the compiler when @samp{make} is invoked.
2937 This will build the entire GCC system and ensure that it compiles
2938 itself correctly.  It can be disabled with the @option{--disable-bootstrap}
2939 parameter to @samp{configure}, but bootstrapping is suggested because
2940 the compiler will be tested more completely and could also have
2941 better performance.
2943 The bootstrapping process will complete the following steps:
2945 @itemize @bullet
2946 @item
2947 Build tools necessary to build the compiler.
2949 @item
2950 Perform a 3-stage bootstrap of the compiler.  This includes building
2951 three times the target tools for use by the compiler such as binutils
2952 (bfd, binutils, gas, gprof, ld, and opcodes) if they have been
2953 individually linked or moved into the top level GCC source tree before
2954 configuring.
2956 @item
2957 Perform a comparison test of the stage2 and stage3 compilers.
2959 @item
2960 Build runtime libraries using the stage3 compiler from the previous step.
2962 @end itemize
2964 If you are short on disk space you might consider @samp{make
2965 bootstrap-lean} instead.  The sequence of compilation is the
2966 same described above, but object files from the stage1 and
2967 stage2 of the 3-stage bootstrap of the compiler are deleted as
2968 soon as they are no longer needed.
2970 If you wish to use non-default GCC flags when compiling the stage2
2971 and stage3 compilers, set @code{BOOT_CFLAGS} on the command line when
2972 doing @samp{make}.  For example, if you want to save additional space
2973 during the bootstrap and in the final installation as well, you can
2974 build the compiler binaries without debugging information as in the
2975 following example.  This will save roughly 40% of disk space both for
2976 the bootstrap and the final installation.  (Libraries will still contain
2977 debugging information.)
2979 @smallexample
2980 make BOOT_CFLAGS='-O' bootstrap
2981 @end smallexample
2983 You can place non-default optimization flags into @code{BOOT_CFLAGS}; they
2984 are less well tested here than the default of @samp{-g -O2}, but should
2985 still work.  In a few cases, you may find that you need to specify special
2986 flags such as @option{-msoft-float} here to complete the bootstrap; or,
2987 if the native compiler miscompiles the stage1 compiler, you may need
2988 to work around this, by choosing @code{BOOT_CFLAGS} to avoid the parts
2989 of the stage1 compiler that were miscompiled, or by using @samp{make
2990 bootstrap4} to increase the number of stages of bootstrap.
2992 @code{BOOT_CFLAGS} does not apply to bootstrapped target libraries.
2993 Since these are always compiled with the compiler currently being
2994 bootstrapped, you can use @code{CFLAGS_FOR_TARGET} to modify their
2995 compilation flags, as for non-bootstrapped target libraries.
2996 Again, if the native compiler miscompiles the stage1 compiler, you may
2997 need to work around this by avoiding non-working parts of the stage1
2998 compiler.  Use @code{STAGE1_TFLAGS} to this end.
3000 If you used the flag @option{--enable-languages=@dots{}} to restrict
3001 the compilers to be built, only those you've actually enabled will be
3002 built.  This will of course only build those runtime libraries, for
3003 which the particular compiler has been built.  Please note,
3004 that re-defining @env{LANGUAGES} when calling @samp{make}
3005 @strong{does not} work anymore!
3007 If the comparison of stage2 and stage3 fails, this normally indicates
3008 that the stage2 compiler has compiled GCC incorrectly, and is therefore
3009 a potentially serious bug which you should investigate and report.  (On
3010 a few systems, meaningful comparison of object files is impossible; they
3011 always appear ``different''.  If you encounter this problem, you will
3012 need to disable comparison in the @file{Makefile}.)
3014 If you do not want to bootstrap your compiler, you can configure with
3015 @option{--disable-bootstrap}.  In particular cases, you may want to
3016 bootstrap your compiler even if the target system is not the same as
3017 the one you are building on: for example, you could build a
3018 @code{powerpc-unknown-linux-gnu} toolchain on a
3019 @code{powerpc64-unknown-linux-gnu} host.  In this case, pass
3020 @option{--enable-bootstrap} to the configure script.
3022 @code{BUILD_CONFIG} can be used to bring in additional customization
3023 to the build.  It can be set to a whitespace-separated list of names.
3024 For each such @code{NAME}, top-level @file{config/@code{NAME}.mk} will
3025 be included by the top-level @file{Makefile}, bringing in any settings
3026 it contains.  The default @code{BUILD_CONFIG} can be set using the
3027 configure option @option{--with-build-config=@code{NAME}...}.  Some
3028 examples of supported build configurations are:
3030 @table @asis
3031 @item @samp{bootstrap-O1}
3032 Removes any @option{-O}-started option from @code{BOOT_CFLAGS}, and adds
3033 @option{-O1} to it.  @samp{BUILD_CONFIG=bootstrap-O1} is equivalent to
3034 @samp{BOOT_CFLAGS='-g -O1'}.
3036 @item @samp{bootstrap-O3}
3037 @itemx @samp{bootstrap-Og}
3038 Analogous to @code{bootstrap-O1}.
3040 @item @samp{bootstrap-lto}
3041 Enables Link-Time Optimization for host tools during bootstrapping.
3042 @samp{BUILD_CONFIG=bootstrap-lto} is equivalent to adding
3043 @option{-flto} to @samp{BOOT_CFLAGS}.  This option assumes that the host
3044 supports the linker plugin (e.g.@: GNU ld version 2.21 or later or GNU gold
3045 version 2.21 or later).
3047 @item @samp{bootstrap-lto-noplugin}
3048 This option is similar to @code{bootstrap-lto}, but is intended for
3049 hosts that do not support the linker plugin.  Without the linker plugin 
3050 static libraries are not compiled with link-time optimizations.  Since 
3051 the GCC middle end and back end are in @file{libbackend.a} this means
3052 that only the front end is actually LTO optimized.
3054 @item @samp{bootstrap-lto-lean}
3055 This option is similar to @code{bootstrap-lto}, but is intended for
3056 faster build by only using LTO in the final bootstrap stage.
3057 With @samp{make profiledbootstrap} the LTO frontend
3058 is trained only on generator files.
3060 @item @samp{bootstrap-debug}
3061 Verifies that the compiler generates the same executable code, whether
3062 or not it is asked to emit debug information.  To this end, this
3063 option builds stage2 host programs without debug information, and uses
3064 @file{contrib/compare-debug} to compare them with the stripped stage3
3065 object files.  If @code{BOOT_CFLAGS} is overridden so as to not enable
3066 debug information, stage2 will have it, and stage3 won't.  This option
3067 is enabled by default when GCC bootstrapping is enabled, if
3068 @code{strip} can turn object files compiled with and without debug
3069 info into identical object files.  In addition to better test
3070 coverage, this option makes default bootstraps faster and leaner.
3072 @item @samp{bootstrap-debug-big}
3073 Rather than comparing stripped object files, as in
3074 @code{bootstrap-debug}, this option saves internal compiler dumps
3075 during stage2 and stage3 and compares them as well, which helps catch
3076 additional potential problems, but at a great cost in terms of disk
3077 space.  It can be specified in addition to @samp{bootstrap-debug}.
3079 @item @samp{bootstrap-debug-lean}
3080 This option saves disk space compared with @code{bootstrap-debug-big},
3081 but at the expense of some recompilation.  Instead of saving the dumps
3082 of stage2 and stage3 until the final compare, it uses
3083 @option{-fcompare-debug} to generate, compare and remove the dumps
3084 during stage3, repeating the compilation that already took place in
3085 stage2, whose dumps were not saved.
3087 @item @samp{bootstrap-debug-lib}
3088 This option tests executable code invariance over debug information
3089 generation on target libraries, just like @code{bootstrap-debug-lean}
3090 tests it on host programs.  It builds stage3 libraries with
3091 @option{-fcompare-debug}, and it can be used along with any of the
3092 @code{bootstrap-debug} options above.
3094 There aren't @code{-lean} or @code{-big} counterparts to this option
3095 because most libraries are only build in stage3, so bootstrap compares
3096 would not get significant coverage.  Moreover, the few libraries built
3097 in stage2 are used in stage3 host programs, so we wouldn't want to
3098 compile stage2 libraries with different options for comparison purposes.
3100 @item @samp{bootstrap-debug-ckovw}
3101 Arranges for error messages to be issued if the compiler built on any
3102 stage is run without the option @option{-fcompare-debug}.  This is
3103 useful to verify the full @option{-fcompare-debug} testing coverage.  It
3104 must be used along with @code{bootstrap-debug-lean} and
3105 @code{bootstrap-debug-lib}.
3107 @item @samp{bootstrap-cet}
3108 This option enables Intel CET for host tools during bootstrapping.
3109 @samp{BUILD_CONFIG=bootstrap-cet} is equivalent to adding
3110 @option{-fcf-protection} to @samp{BOOT_CFLAGS}.  This option
3111 assumes that the host supports Intel CET (e.g.@: GNU assembler version
3112 2.30 or later).
3114 @item @samp{bootstrap-time}
3115 Arranges for the run time of each program started by the GCC driver,
3116 built in any stage, to be logged to @file{time.log}, in the top level of
3117 the build tree.
3119 @item @samp{bootstrap-asan}
3120 Compiles GCC itself using Address Sanitization in order to catch invalid memory
3121 accesses within the GCC code.
3123 @item @samp{bootstrap-hwasan}
3124 Compiles GCC itself using HWAddress Sanitization in order to catch invalid
3125 memory accesses within the GCC code.  This option is only available on AArch64
3126 systems that are running Linux kernel version 5.4 or later.
3128 @end table
3130 @section Building a cross compiler
3132 When building a cross compiler, it is not generally possible to do a
3133 3-stage bootstrap of the compiler.  This makes for an interesting problem
3134 as parts of GCC can only be built with GCC@.
3136 To build a cross compiler, we recommend first building and installing a
3137 native compiler.  You can then use the native GCC compiler to build the
3138 cross compiler.  The installed native compiler needs to be GCC version
3139 2.95 or later.
3141 Assuming you have already installed a native copy of GCC and configured
3142 your cross compiler, issue the command @command{make}, which performs the
3143 following steps:
3145 @itemize @bullet
3146 @item
3147 Build host tools necessary to build the compiler.
3149 @item
3150 Build target tools for use by the compiler such as binutils (bfd,
3151 binutils, gas, gprof, ld, and opcodes)
3152 if they have been individually linked or moved into the top level GCC source
3153 tree before configuring.
3155 @item
3156 Build the compiler (single stage only).
3158 @item
3159 Build runtime libraries using the compiler from the previous step.
3160 @end itemize
3162 Note that if an error occurs in any step the make process will exit.
3164 If you are not building GNU binutils in the same source tree as GCC,
3165 you will need a cross-assembler and cross-linker installed before
3166 configuring GCC@.  Put them in the directory
3167 @file{@var{prefix}/@var{target}/bin}.  Here is a table of the tools
3168 you should put in this directory:
3170 @table @file
3171 @item as
3172 This should be the cross-assembler.
3174 @item ld
3175 This should be the cross-linker.
3177 @item ar
3178 This should be the cross-archiver: a program which can manipulate
3179 archive files (linker libraries) in the target machine's format.
3181 @item ranlib
3182 This should be a program to construct a symbol table in an archive file.
3183 @end table
3185 The installation of GCC will find these programs in that directory,
3186 and copy or link them to the proper place to for the cross-compiler to
3187 find them when run later.
3189 The easiest way to provide these files is to build the Binutils package.
3190 Configure it with the same @option{--host} and @option{--target}
3191 options that you use for configuring GCC, then build and install
3192 them.  They install their executables automatically into the proper
3193 directory.  Alas, they do not support all the targets that GCC
3194 supports.
3196 If you are not building a C library in the same source tree as GCC,
3197 you should also provide the target libraries and headers before
3198 configuring GCC, specifying the directories with
3199 @option{--with-sysroot} or @option{--with-headers} and
3200 @option{--with-libs}.  Many targets also require ``start files'' such
3201 as @file{crt0.o} and
3202 @file{crtn.o} which are linked into each executable.  There may be several
3203 alternatives for @file{crt0.o}, for use with profiling or other
3204 compilation options.  Check your target's definition of
3205 @code{STARTFILE_SPEC} to find out what start files it uses.
3207 @section Building in parallel
3209 GNU Make 3.80 and above, which is necessary to build GCC, support
3210 building in parallel.  To activate this, you can use @samp{make -j 2}
3211 instead of @samp{make}.  You can also specify a bigger number, and
3212 in most cases using a value greater than the number of processors in
3213 your machine will result in fewer and shorter I/O latency hits, thus
3214 improving overall throughput; this is especially true for slow drives
3215 and network filesystems.
3217 @section Building the Ada compiler
3219 @ifnothtml
3220 @ref{GNAT-prerequisite}.
3221 @end ifnothtml
3222 @ifhtml
3223 @uref{prerequisites.html#GNAT-prerequisite,,GNAT prerequisites}.
3224 @end ifhtml
3226 @section Building the D compiler
3228 @ifnothtml
3229 @ref{GDC-prerequisite}.
3230 @end ifnothtml
3231 @ifhtml
3232 @uref{prerequisites.html#GDC-prerequisite,,GDC prerequisites}.
3233 @end ifhtml
3235 @section Building with profile feedback
3237 It is possible to use profile feedback to optimize the compiler itself.  This
3238 should result in a faster compiler binary.  Experiments done on x86 using gcc
3239 3.3 showed approximately 7 percent speedup on compiling C programs.  To
3240 bootstrap the compiler with profile feedback, use @code{make profiledbootstrap}.
3242 When @samp{make profiledbootstrap} is run, it will first build a @code{stage1}
3243 compiler.  This compiler is used to build a @code{stageprofile} compiler
3244 instrumented to collect execution counts of instruction and branch
3245 probabilities.  Training run is done by building @code{stagetrain}
3246 compiler.  Finally a @code{stagefeedback} compiler is built
3247 using the information collected.
3249 Unlike standard bootstrap, several additional restrictions apply.  The
3250 compiler used to build @code{stage1} needs to support a 64-bit integral type.
3251 It is recommended to only use GCC for this.
3253 On Linux/x86_64 hosts with some restrictions (no virtualization) it is
3254 also possible to do autofdo build with @samp{make
3255 autoprofiledbootstrap}. This uses Linux perf to sample branches in the
3256 binary and then rebuild it with feedback derived from the profile.
3257 Linux perf and the @code{autofdo} toolkit needs to be installed for
3258 this.
3260 Only the profile from the current build is used, so when an error
3261 occurs it is recommended to clean before restarting. Otherwise
3262 the code quality may be much worse.
3264 @html
3265 <hr />
3267 @end html
3268 @ifhtml
3269 @uref{./index.html,,Return to the GCC Installation page}
3270 @end ifhtml
3271 @end ifset
3273 @c ***Testing*****************************************************************
3274 @ifnothtml
3275 @comment node-name,     next,          previous, up
3276 @node    Testing, Final install, Building, Installing GCC
3277 @end ifnothtml
3278 @ifset testhtml
3279 @ifnothtml
3280 @chapter Installing GCC: Testing
3281 @end ifnothtml
3282 @cindex Testing
3283 @cindex Installing GCC: Testing
3284 @cindex Testsuite
3286 Before you install GCC, we encourage you to run the testsuites and to
3287 compare your results with results from a similar configuration that have
3288 been submitted to the
3289 @uref{https://gcc.gnu.org/ml/gcc-testresults/,,gcc-testresults mailing list}.
3290 Some of these archived results are linked from the build status lists
3291 at @uref{https://gcc.gnu.org/buildstat.html}, although not everyone who
3292 reports a successful build runs the testsuites and submits the results.
3293 This step is optional and may require you to download additional software,
3294 but it can give you confidence in your new GCC installation or point out
3295 problems before you install and start using your new GCC@.
3297 First, you must have @uref{download.html,,downloaded the testsuites}.
3298 These are included in the source tarball.
3300 Second, you must have the testing tools installed.  This includes
3301 @uref{https://www.gnu.org/software/dejagnu/,,DejaGnu}, Tcl, and Expect;
3302 the DejaGnu site has links to these.
3303 Some optional tests also require Python3 and pytest module.
3305 If the directories where @command{runtest} and @command{expect} were
3306 installed are not in the @env{PATH}, you may need to set the following
3307 environment variables appropriately, as in the following example (which
3308 assumes that DejaGnu has been installed under @file{/usr/local}):
3310 @smallexample
3311 TCL_LIBRARY = /usr/local/share/tcl8.0
3312 DEJAGNULIBS = /usr/local/share/dejagnu
3313 @end smallexample
3315 (On systems such as Cygwin, these paths are required to be actual
3316 paths, not mounts or links; presumably this is due to some lack of
3317 portability in the DejaGnu code.)
3320 Finally, you can run the testsuite (which may take a long time):
3321 @smallexample
3322 cd @var{objdir}; make -k check
3323 @end smallexample
3325 This will test various components of GCC, such as compiler
3326 front ends and runtime libraries.  While running the testsuite, DejaGnu
3327 might emit some harmless messages resembling
3328 @samp{WARNING: Couldn't find the global config file.} or
3329 @samp{WARNING: Couldn't find tool init file} that can be ignored.
3331 If you are testing a cross-compiler, you may want to run the testsuite
3332 on a simulator as described at @uref{https://gcc.gnu.org/simtest-howto.html}.
3334 @section How can you run the testsuite on selected tests?
3336 In order to run sets of tests selectively, there are targets
3337 @samp{make check-gcc} and language specific @samp{make check-c},
3338 @samp{make check-c++}, @samp{make check-d} @samp{make check-fortran},
3339 @samp{make check-ada}, @samp{make check-m2}, @samp{make check-objc},
3340 @samp{make check-obj-c++}, @samp{make check-lto} in the @file{gcc}
3341 subdirectory of the object directory.  You can also just run
3342 @samp{make check} in a subdirectory of the object directory.
3345 A more selective way to just run all @command{gcc} execute tests in the
3346 testsuite is to use
3348 @smallexample
3349 make check-gcc RUNTESTFLAGS="execute.exp @var{other-options}"
3350 @end smallexample
3352 Likewise, in order to run only the @command{g++} ``old-deja'' tests in
3353 the testsuite with filenames matching @samp{9805*}, you would use
3355 @smallexample
3356 make check-g++ RUNTESTFLAGS="old-deja.exp=9805* @var{other-options}"
3357 @end smallexample
3359 The file-matching expression following @var{filename}@command{.exp=} is treated
3360 as a series of whitespace-delimited glob expressions so that multiple patterns
3361 may be passed, although any whitespace must either be escaped or surrounded by
3362 single quotes if multiple expressions are desired. For example,
3364 @smallexample
3365 make check-g++ RUNTESTFLAGS="old-deja.exp=9805*\ virtual2.c @var{other-options}"
3366 make check-g++ RUNTESTFLAGS="'old-deja.exp=9805* virtual2.c' @var{other-options}"
3367 @end smallexample
3369 The @file{*.exp} files are located in the testsuite directories of the GCC
3370 source, the most important ones being @file{compile.exp},
3371 @file{execute.exp}, @file{dg.exp} and @file{old-deja.exp}.
3372 To get a list of the possible @file{*.exp} files, pipe the
3373 output of @samp{make check} into a file and look at the
3374 @samp{Running @dots{}  .exp} lines.
3376 @section Passing options and running multiple testsuites
3378 You can pass multiple options to the testsuite using the
3379 @samp{--target_board} option of DejaGNU, either passed as part of
3380 @samp{RUNTESTFLAGS}, or directly to @command{runtest} if you prefer to
3381 work outside the makefiles.  For example,
3383 @smallexample
3384 make check-g++ RUNTESTFLAGS="--target_board=unix/-O3/-fmerge-constants"
3385 @end smallexample
3387 will run the standard @command{g++} testsuites (``unix'' is the target name
3388 for a standard native testsuite situation), passing
3389 @samp{-O3 -fmerge-constants} to the compiler on every test, i.e.,
3390 slashes separate options.
3392 You can run the testsuites multiple times using combinations of options
3393 with a syntax similar to the brace expansion of popular shells:
3395 @smallexample
3396 @dots{}"--target_board=arm-sim\@{-mhard-float,-msoft-float\@}\@{-O1,-O2,-O3,\@}"
3397 @end smallexample
3399 (Note the empty option caused by the trailing comma in the final group.)
3400 The following will run each testsuite eight times using the @samp{arm-sim}
3401 target, as if you had specified all possible combinations yourself:
3403 @smallexample
3404 --target_board='arm-sim/-mhard-float/-O1 \
3405                 arm-sim/-mhard-float/-O2 \
3406                 arm-sim/-mhard-float/-O3 \
3407                 arm-sim/-mhard-float \
3408                 arm-sim/-msoft-float/-O1 \
3409                 arm-sim/-msoft-float/-O2 \
3410                 arm-sim/-msoft-float/-O3 \
3411                 arm-sim/-msoft-float'
3412 @end smallexample
3414 They can be combined as many times as you wish, in arbitrary ways.  This
3415 list:
3417 @smallexample
3418 @dots{}"--target_board=unix/-Wextra\@{-O3,-fno-strength\@}\@{-fomit-frame,\@}"
3419 @end smallexample
3421 will generate four combinations, all involving @samp{-Wextra}.
3423 The disadvantage to this method is that the testsuites are run in serial,
3424 which is a waste on multiprocessor systems.  For users with GNU Make and
3425 a shell which performs brace expansion, you can run the testsuites in
3426 parallel by having the shell perform the combinations and @command{make}
3427 do the parallel runs.  Instead of using @samp{--target_board}, use a
3428 special makefile target:
3430 @smallexample
3431 make -j@var{N} check-@var{testsuite}//@var{test-target}/@var{option1}/@var{option2}/@dots{}
3432 @end smallexample
3434 For example,
3436 @smallexample
3437 make -j3 check-gcc//sh-hms-sim/@{-m1,-m2,-m3,-m3e,-m4@}/@{,-nofpu@}
3438 @end smallexample
3440 will run three concurrent ``make-gcc'' testsuites, eventually testing all
3441 ten combinations as described above.  Note that this is currently only
3442 supported in the @file{gcc} subdirectory.  (To see how this works, try
3443 typing @command{echo} before the example given here.)
3446 @section How to interpret test results
3448 The result of running the testsuite are various @file{*.sum} and @file{*.log}
3449 files in the testsuite subdirectories.  The @file{*.log} files contain a
3450 detailed log of the compiler invocations and the corresponding
3451 results, the @file{*.sum} files summarize the results.  These summaries
3452 contain status codes for all tests:
3454 @itemize @bullet
3455 @item
3456 PASS: the test passed as expected
3457 @item
3458 XPASS: the test unexpectedly passed
3459 @item
3460 FAIL: the test unexpectedly failed
3461 @item
3462 XFAIL: the test failed as expected
3463 @item
3464 UNSUPPORTED: the test is not supported on this platform
3465 @item
3466 ERROR: the testsuite detected an error
3467 @item
3468 WARNING: the testsuite detected a possible problem
3469 @end itemize
3471 It is normal for some tests to report unexpected failures.  At the
3472 current time the testing harness does not allow fine grained control
3473 over whether or not a test is expected to fail.  This problem should
3474 be fixed in future releases.
3477 @section Submitting test results
3479 If you want to report the results to the GCC project, use the
3480 @file{contrib/test_summary} shell script.  Start it in the @var{objdir} with
3482 @smallexample
3483 @var{srcdir}/contrib/test_summary -p your_commentary.txt \
3484     -m gcc-testresults@@gcc.gnu.org |sh
3485 @end smallexample
3487 This script uses the @command{Mail} program to send the results, so
3488 make sure it is in your @env{PATH}.  The file @file{your_commentary.txt} is
3489 prepended to the testsuite summary and should contain any special
3490 remarks you have on your results or your build environment.  Please
3491 do not edit the testsuite result block or the subject line, as these
3492 messages may be automatically processed.
3494 @html
3495 <hr />
3497 @end html
3498 @ifhtml
3499 @uref{./index.html,,Return to the GCC Installation page}
3500 @end ifhtml
3501 @end ifset
3503 @c ***Final install***********************************************************
3504 @ifnothtml
3505 @comment node-name,     next,          previous, up
3506 @node    Final install, , Testing, Installing GCC
3507 @end ifnothtml
3508 @ifset finalinstallhtml
3509 @ifnothtml
3510 @chapter Installing GCC: Final installation
3511 @end ifnothtml
3513 Now that GCC has been built (and optionally tested), you can install it with
3514 @smallexample
3515 cd @var{objdir} && make install
3516 @end smallexample
3518 We strongly recommend to install into a target directory where there is
3519 no previous version of GCC present.  Also, the GNAT runtime should not
3520 be stripped, as this would break certain features of the debugger that
3521 depend on this debugging information (catching Ada exceptions for
3522 instance).
3524 That step completes the installation of GCC; user level binaries can
3525 be found in @file{@var{prefix}/bin} where @var{prefix} is the value
3526 you specified with the @option{--prefix} to configure (or
3527 @file{/usr/local} by default).  (If you specified @option{--bindir},
3528 that directory will be used instead; otherwise, if you specified
3529 @option{--exec-prefix}, @file{@var{exec-prefix}/bin} will be used.)
3530 Headers for the C++ library are installed in
3531 @file{@var{prefix}/include}; libraries in @file{@var{libdir}}
3532 (normally @file{@var{prefix}/lib}); internal parts of the compiler in
3533 @file{@var{libdir}/gcc} and @file{@var{libexecdir}/gcc}; documentation
3534 in info format in @file{@var{infodir}} (normally
3535 @file{@var{prefix}/info}).
3537 When installing cross-compilers, GCC's executables
3538 are not only installed into @file{@var{bindir}}, that
3539 is, @file{@var{exec-prefix}/bin}, but additionally into
3540 @file{@var{exec-prefix}/@var{target-alias}/bin}, if that directory
3541 exists.  Typically, such @dfn{tooldirs} hold target-specific
3542 binutils, including assembler and linker.
3544 Installation into a temporary staging area or into a @command{chroot}
3545 jail can be achieved with the command
3547 @smallexample
3548 make DESTDIR=@var{path-to-rootdir} install
3549 @end smallexample
3551 @noindent
3552 where @var{path-to-rootdir} is the absolute path of
3553 a directory relative to which all installation paths will be
3554 interpreted.  Note that the directory specified by @code{DESTDIR}
3555 need not exist yet; it will be created if necessary.
3557 There is a subtle point with tooldirs and @code{DESTDIR}:
3558 If you relocate a cross-compiler installation with
3559 e.g.@: @samp{DESTDIR=@var{rootdir}}, then the directory
3560 @file{@var{rootdir}/@var{exec-prefix}/@var{target-alias}/bin} will
3561 be filled with duplicated GCC executables only if it already exists,
3562 it will not be created otherwise.  This is regarded as a feature,
3563 not as a bug, because it gives slightly more control to the packagers
3564 using the @code{DESTDIR} feature.
3566 You can install stripped programs and libraries with
3568 @smallexample
3569 make install-strip
3570 @end smallexample
3572 By default, only the man pages and info-format GCC documentation
3573 are built and installed.  If you want to generate the GCC manuals in
3574 other formats, use commands like
3576 @smallexample
3577 make dvi
3578 make pdf
3579 make html
3580 @end smallexample
3582 @noindent
3583 to build the manuals in the corresponding formats, and
3585 @smallexample
3586 make install-dvi
3587 make install-pdf
3588 make install-html
3589 @end smallexample
3591 @noindent
3592 to install them.
3593 Alternatively, there are prebuilt online versions of the manuals for
3594 released versions of GCC on
3595 @uref{https://gcc.gnu.org/onlinedocs/,,the GCC web site}.
3597 If you are bootstrapping a released version of GCC then please
3598 quickly review the build status page for your release, available from
3599 @uref{https://gcc.gnu.org/buildstat.html}.
3600 If your system is not listed for the version of GCC that you built,
3601 send a note to
3602 @email{gcc@@gcc.gnu.org} indicating
3603 that you successfully built and installed GCC@.
3604 Include the following information:
3606 @itemize @bullet
3607 @item
3608 Output from running @file{@var{srcdir}/config.guess}.  Do not send
3609 that file itself, just the one-line output from running it.
3611 @item
3612 The output of @samp{gcc -v} for your newly installed @command{gcc}.
3613 This tells us which version of GCC you built and the options you passed to
3614 configure.
3616 @item
3617 If the build was for GNU/Linux, also include:
3618 @itemize @bullet
3619 @item
3620 The distribution name and version (e.g., Red Hat 7.1 or Debian 2.2.3);
3621 this information should be available from @file{/etc/issue}.
3623 @item
3624 The version of the Linux kernel, available from @samp{uname --version}
3625 or @samp{uname -a}.
3627 @item
3628 The version of glibc you used; for RPM-based systems like Red Hat,
3629 Mandrake, and SuSE type @samp{rpm -q glibc} to get the glibc version,
3630 and on systems like Debian and Progeny use @samp{dpkg -l libc6}.
3631 @end itemize
3632 For other systems, you can include similar information if you think it is
3633 relevant.
3635 @item
3636 Any other information that you think would be useful to people building
3637 GCC on the same configuration.  The new entry in the build status list
3638 will include a link to the archived copy of your message.
3639 @end itemize
3641 We'd also like to know if the
3642 @ifnothtml
3643 @ref{Specific, host/target specific installation notes}
3644 @end ifnothtml
3645 @ifhtml
3646 @uref{specific.html,,host/target specific installation notes}
3647 @end ifhtml
3648 didn't include your host/target information or if that information is
3649 incomplete or out of date.  Send a note to
3650 @email{gcc@@gcc.gnu.org} detailing how the information should be changed.
3652 If you find a bug, please report it following the
3653 @uref{../bugs/,,bug reporting guidelines}.
3655 @html
3656 <hr />
3658 @end html
3659 @ifhtml
3660 @uref{./index.html,,Return to the GCC Installation page}
3661 @end ifhtml
3662 @end ifset
3664 @c ***Binaries****************************************************************
3665 @ifnothtml
3666 @comment node-name,     next,          previous, up
3667 @node    Binaries, Specific, Installing GCC, Top
3668 @end ifnothtml
3669 @ifset binarieshtml
3670 @ifnothtml
3671 @chapter Installing GCC: Binaries
3672 @end ifnothtml
3673 @cindex Binaries
3674 @cindex Installing GCC: Binaries
3676 We are often asked about pre-compiled versions of GCC@.  While we cannot
3677 provide these for all platforms, below you'll find links to binaries for
3678 various platforms where creating them by yourself is not easy due to various
3679 reasons.
3681 Please note that we did not create these binaries, nor do we
3682 support them.  If you have any problems installing them, please
3683 contact their makers.
3685 @itemize
3686 @item
3687 AIX:
3688 @itemize
3689 @item
3690 @uref{http://www.perzl.org/aix/,,AIX Open Source Packages (AIX5L AIX 6.1
3691 AIX 7.1)}.
3692 @end itemize
3694 @item
3695 DOS---@uref{http://www.delorie.com/djgpp/,,DJGPP}.
3697 @item
3698 HP-UX:
3699 @itemize
3700 @item
3701 @uref{http://hpux.connect.org.uk/,,HP-UX Porting Center};
3702 @end itemize
3704 @item
3705 macOS:
3706 @itemize
3707 @item
3708 The @uref{https://brew.sh,,Homebrew} package manager;
3709 @item
3710 @uref{https://www.macports.org,,MacPorts}.
3711 @end itemize
3713 @item
3714 Microsoft Windows:
3715 @itemize
3716 @item
3717 The @uref{https://sourceware.org/cygwin/,,Cygwin} project;
3718 @item
3719 The @uref{https://osdn.net/projects/mingw/,,MinGW} and
3720 @uref{https://www.mingw-w64.org/,,mingw-w64} projects.
3721 @end itemize
3723 @item
3724 @uref{http://www.openpkg.org/,,OpenPKG} offers binaries for quite a
3725 number of platforms.
3727 @item
3728 The @uref{https://gcc.gnu.org/wiki/GFortranBinaries,,GFortran Wiki} has
3729 links to GNU Fortran binaries for several platforms.
3730 @end itemize
3732 @html
3733 <hr />
3735 @end html
3736 @ifhtml
3737 @uref{./index.html,,Return to the GCC Installation page}
3738 @end ifhtml
3739 @end ifset
3741 @c ***Specific****************************************************************
3742 @ifnothtml
3743 @comment node-name,     next,          previous, up
3744 @node    Specific, GNU Free Documentation License, Binaries, Top
3745 @end ifnothtml
3746 @ifset specifichtml
3747 @ifnothtml
3748 @chapter Host/target specific installation notes for GCC
3749 @end ifnothtml
3750 @cindex Specific
3751 @cindex Specific installation notes
3752 @cindex Target specific installation
3753 @cindex Host specific installation
3754 @cindex Target specific installation notes
3756 Please read this document carefully @emph{before} installing the
3757 GNU Compiler Collection on your machine.
3759 Note that this list of install notes is @emph{not} a list of supported
3760 hosts or targets.  Not all supported hosts and targets are listed
3761 here, only the ones that require host-specific or target-specific
3762 information have to. 
3764 @ifhtml
3765 @itemize
3766 @item
3767 @uref{#aarch64-x-x,,aarch64*-*-*}
3768 @item
3769 @uref{#amdgcn-x-amdhsa,,amdgcn-*-amdhsa}
3770 @item
3771 @uref{#amd64-x-solaris2,,amd64-*-solaris2*}
3772 @item
3773 @uref{#arc-x-elf32,,arc-*-elf32}
3774 @item
3775 @uref{#arc-linux-uclibc,,arc-linux-uclibc}
3776 @item
3777 @uref{#arm-x-eabi,,arm-*-eabi}
3778 @item
3779 @uref{#avr,,avr}
3780 @item
3781 @uref{#bfin,,Blackfin}
3782 @item
3783 @uref{#cris,,cris}
3784 @item
3785 @uref{#dos,,DOS}
3786 @item
3787 @uref{#epiphany-x-elf,,epiphany-*-elf}
3788 @item
3789 @uref{#ft32-x-elf,,ft32-*-elf}
3790 @item
3791 @uref{#x-x-freebsd,,*-*-freebsd*}
3792 @item
3793 @uref{#h8300-hms,,h8300-hms}
3794 @item
3795 @uref{#hppa-hp-hpux,,hppa*-hp-hpux*}
3796 @item
3797 @uref{#hppa-hp-hpux10,,hppa*-hp-hpux10}
3798 @item
3799 @uref{#hppa-hp-hpux11,,hppa*-hp-hpux11}
3800 @item
3801 @uref{#x-x-linux-gnu,,*-*-linux-gnu}
3802 @item
3803 @uref{#ix86-x-linux,,i?86-*-linux*}
3804 @item
3805 @uref{#ix86-x-solaris2,,i?86-*-solaris2*}
3806 @item
3807 @uref{#ia64-x-linux,,ia64-*-linux}
3808 @item
3809 @uref{#ia64-x-hpux,,ia64-*-hpux*}
3810 @item
3811 @uref{#x-ibm-aix,,*-ibm-aix*}
3812 @item
3813 @uref{#iq2000-x-elf,,iq2000-*-elf}
3814 @item
3815 @uref{#loongarch,,loongarch}
3816 @item
3817 @uref{#lm32-x-elf,,lm32-*-elf}
3818 @item
3819 @uref{#lm32-x-uclinux,,lm32-*-uclinux}
3820 @item
3821 @uref{#m32c-x-elf,,m32c-*-elf}
3822 @item
3823 @uref{#m32r-x-elf,,m32r-*-elf}
3824 @item
3825 @uref{#m68k-x-x,,m68k-*-*}
3826 @item
3827 @uref{#m68k-x-uclinux,,m68k-*-uclinux}
3828 @item
3829 @uref{#microblaze-x-elf,,microblaze-*-elf}
3830 @item
3831 @uref{#mips-x-x,,mips-*-*}
3832 @item
3833 @uref{#moxie-x-elf,,moxie-*-elf}
3834 @item
3835 @uref{#msp430-x-elf,,msp430-*-elf}
3836 @item
3837 @uref{#nds32le-x-elf,,nds32le-*-elf}
3838 @item
3839 @uref{#nds32be-x-elf,,nds32be-*-elf}
3840 @item
3841 @uref{#nvptx-x-none,,nvptx-*-none}
3842 @item
3843 @uref{#or1k-x-elf,,or1k-*-elf}
3844 @item
3845 @uref{#or1k-x-linux,,or1k-*-linux}
3846 @item
3847 @uref{#powerpc-x-x,,powerpc*-*-*}
3848 @item
3849 @uref{#powerpc-x-darwin,,powerpc-*-darwin*}
3850 @item
3851 @uref{#powerpc-x-elf,,powerpc-*-elf}
3852 @item
3853 @uref{#powerpc-x-linux-gnu,,powerpc*-*-linux-gnu*}
3854 @item
3855 @uref{#powerpc-x-netbsd,,powerpc-*-netbsd*}
3856 @item
3857 @uref{#powerpc-x-eabisim,,powerpc-*-eabisim}
3858 @item
3859 @uref{#powerpc-x-eabi,,powerpc-*-eabi}
3860 @item
3861 @uref{#powerpcle-x-elf,,powerpcle-*-elf}
3862 @item
3863 @uref{#powerpcle-x-eabisim,,powerpcle-*-eabisim}
3864 @item
3865 @uref{#powerpcle-x-eabi,,powerpcle-*-eabi}
3866 @item
3867 @uref{#riscv32-x-elf,,riscv32-*-elf}
3868 @item
3869 @uref{#riscv32-x-linux,,riscv32-*-linux}
3870 @item
3871 @uref{#riscv64-x-elf,,riscv64-*-elf}
3872 @item
3873 @uref{#riscv64-x-linux,,riscv64-*-linux}
3874 @item
3875 @uref{#rl78-x-elf,,rl78-*-elf}
3876 @item
3877 @uref{#rx-x-elf,,rx-*-elf}
3878 @item
3879 @uref{#s390-x-linux,,s390-*-linux*}
3880 @item
3881 @uref{#s390x-x-linux,,s390x-*-linux*}
3882 @item
3883 @uref{#s390x-ibm-tpf,,s390x-ibm-tpf*}
3884 @item
3885 @uref{#x-x-solaris2,,*-*-solaris2*}
3886 @item
3887 @uref{#sparc-x-x,,sparc*-*-*}
3888 @item
3889 @uref{#sparc-sun-solaris2,,sparc-sun-solaris2*}
3890 @item
3891 @uref{#sparc-x-linux,,sparc-*-linux*}
3892 @item
3893 @uref{#sparc64-x-solaris2,,sparc64-*-solaris2*}
3894 @item
3895 @uref{#sparcv9-x-solaris2,,sparcv9-*-solaris2*}
3896 @item
3897 @uref{#c6x-x-x,,c6x-*-*}
3898 @item
3899 @uref{#visium-x-elf, visium-*-elf}
3900 @item
3901 @uref{#x-x-vxworks,,*-*-vxworks*}
3902 @item
3903 @uref{#x86-64-x-x,,x86_64-*-*, amd64-*-*}
3904 @item
3905 @uref{#x86-64-x-solaris2,,x86_64-*-solaris2*}
3906 @item
3907 @uref{#xtensa-x-elf,,xtensa*-*-elf}
3908 @item
3909 @uref{#xtensa-x-linux,,xtensa*-*-linux*}
3910 @item
3911 @uref{#windows,,Microsoft Windows}
3912 @item
3913 @uref{#x-x-cygwin,,*-*-cygwin}
3914 @item
3915 @uref{#x-x-mingw32,,*-*-mingw32}
3916 @item
3917 @uref{#os2,,OS/2}
3918 @item
3919 @uref{#older,,Older systems}
3920 @end itemize
3922 @itemize
3923 @item
3924 @uref{#elf,,all ELF targets} (SVR4, Solaris, etc.)
3925 @end itemize
3926 @end ifhtml
3929 @html
3930 <!-- -------- host/target specific issues start here ---------------- -->
3931 <hr />
3932 @end html
3933 @anchor{aarch64-x-x}
3934 @heading aarch64*-*-*
3935 Binutils pre 2.24 does not have support for selecting @option{-mabi} and
3936 does not support ILP32.  If it is used to build GCC 4.9 or later, GCC will
3937 not support option @option{-mabi=ilp32}.
3939 To enable a workaround for the Cortex-A53 erratum number 835769 by default
3940 (for all CPUs regardless of -mcpu option given) at configure time use the
3941 @option{--enable-fix-cortex-a53-835769} option.  This will enable the fix by
3942 default and can be explicitly disabled during compilation by passing the
3943 @option{-mno-fix-cortex-a53-835769} option.  Conversely,
3944 @option{--disable-fix-cortex-a53-835769} will disable the workaround by
3945 default.  The workaround is disabled by default if neither of
3946 @option{--enable-fix-cortex-a53-835769} or
3947 @option{--disable-fix-cortex-a53-835769} is given at configure time.
3949 To enable a workaround for the Cortex-A53 erratum number 843419 by default
3950 (for all CPUs regardless of -mcpu option given) at configure time use the
3951 @option{--enable-fix-cortex-a53-843419} option.  This workaround is applied at
3952 link time.  Enabling the workaround will cause GCC to pass the relevant option
3953 to the linker.  It can be explicitly disabled during compilation by passing the
3954 @option{-mno-fix-cortex-a53-843419} option.  Conversely,
3955 @option{--disable-fix-cortex-a53-843419} will disable the workaround by default.
3956 The workaround is disabled by default if neither of
3957 @option{--enable-fix-cortex-a53-843419} or
3958 @option{--disable-fix-cortex-a53-843419} is given at configure time.
3960 To enable Branch Target Identification Mechanism and Return Address Signing by
3961 default at configure time use the @option{--enable-standard-branch-protection}
3962 option.  This is equivalent to having @option{-mbranch-protection=standard}
3963 during compilation.  This can be explicitly disabled during compilation by
3964 passing the @option{-mbranch-protection=none} option which turns off all
3965 types of branch protections.  Conversely,
3966 @option{--disable-standard-branch-protection} will disable both the
3967 protections by default.  This mechanism is turned off by default if neither
3968 of the options are given at configure time.
3970 @html
3971 <hr />
3972 @end html
3973 @anchor{amd64-x-solaris2}
3974 @heading amd64-*-solaris2*
3975 This is a synonym for @samp{x86_64-*-solaris2*}.
3977 @html
3978 <hr />
3979 @end html
3980 @anchor{amdgcn-x-amdhsa}
3981 @heading amdgcn-*-amdhsa
3982 AMD GCN GPU target.
3984 Instead of GNU Binutils, you will need to install LLVM 13.0.1, or later, and copy
3985 @file{bin/llvm-mc} to @file{amdgcn-amdhsa/bin/as},
3986 @file{bin/lld} to @file{amdgcn-amdhsa/bin/ld},
3987 @file{bin/llvm-nm} to @file{amdgcn-amdhsa/bin/nm}, and
3988 @file{bin/llvm-ar} to both @file{bin/amdgcn-amdhsa-ar} and
3989 @file{bin/amdgcn-amdhsa-ranlib}.
3991 Use Newlib (4.3.0 or newer).
3993 To run the binaries, install the HSA Runtime from the
3994 @uref{https://rocm.github.io,,ROCm Platform}, and use
3995 @file{libexec/gcc/amdhsa-amdhsa/@var{version}/gcn-run} to launch them
3996 on the GPU.
3998 To enable support for GCN3 Fiji devices (gfx803), GCC has to be configured with
3999 @option{--with-arch=@code{fiji}} or
4000 @option{--with-multilib-list=@code{fiji},...}.  Note that support for Fiji
4001 devices has been removed in ROCm 4.0 and support in LLVM is deprecated and will
4002 be removed in the future.
4004 @html
4005 <hr />
4006 @end html
4007 @anchor{arc-x-elf32}
4008 @heading arc-*-elf32
4010 Use @samp{configure --target=arc-elf32 --with-cpu=@var{cpu} --enable-languages="c,c++"}
4011 to configure GCC, with @var{cpu} being one of @samp{arc600}, @samp{arc601},
4012 or @samp{arc700}@.
4014 @html
4015 <hr />
4016 @end html
4017 @anchor{arc-linux-uclibc}
4018 @heading arc-linux-uclibc
4020 Use @samp{configure --target=arc-linux-uclibc --with-cpu=arc700 --enable-languages="c,c++"} to configure GCC@.
4022 @html
4023 <hr />
4024 @end html
4025 @anchor{arm-x-eabi}
4026 @heading arm-*-eabi
4027 ARM-family processors.
4029 Building the Ada frontend commonly fails (an infinite loop executing
4030 @code{xsinfo}) if the host compiler is GNAT 4.8.  Host compilers built from the
4031 GNAT 4.6, 4.9 or 5 release branches are known to succeed.
4033 @html
4034 <hr />
4035 @end html
4036 @anchor{avr}
4037 @heading avr
4038 ATMEL AVR-family micro controllers.  These are used in embedded
4039 applications.  There are no standard Unix configurations.
4040 @ifnothtml
4041 @xref{AVR Options,, AVR Options, gcc, Using the GNU Compiler
4042 Collection (GCC)},
4043 @end ifnothtml
4044 @ifhtml
4045 See ``AVR Options'' in the main manual
4046 @end ifhtml
4047 for the list of supported MCU types.
4049 Use @samp{configure --target=avr --enable-languages="c"} to configure GCC@.
4051 Further installation notes and other useful information about AVR tools
4052 can also be obtained from:
4054 @itemize @bullet
4055 @item
4056 @uref{http://www.nongnu.org/avr/,,http://www.nongnu.org/avr/}
4057 @item
4058 @uref{http://www.amelek.gda.pl/avr/,,http://www.amelek.gda.pl/avr/}
4059 @end itemize
4061 The following error:
4062 @smallexample
4063 Error: register required
4064 @end smallexample
4066 indicates that you should upgrade to a newer version of the binutils.
4068 @html
4069 <hr />
4070 @end html
4071 @anchor{bfin}
4072 @heading Blackfin
4073 The Blackfin processor, an Analog Devices DSP.
4074 @ifnothtml
4075 @xref{Blackfin Options,, Blackfin Options, gcc, Using the GNU Compiler
4076 Collection (GCC)},
4077 @end ifnothtml
4078 @ifhtml
4079 See ``Blackfin Options'' in the main manual
4080 @end ifhtml
4082 More information, and a version of binutils with support for this processor,
4083 are available at @uref{https://sourceforge.net/projects/adi-toolchain/}.
4085 @html
4086 <hr />
4087 @end html
4088 @anchor{cris}
4089 @heading CRIS
4090 CRIS is a CPU architecture in Axis Communications systems-on-a-chip, for
4091 example the ETRAX series.  These are used in embedded applications.
4093 @ifnothtml
4094 @xref{CRIS Options,, CRIS Options, gcc, Using the GNU Compiler
4095 Collection (GCC)},
4096 @end ifnothtml
4097 @ifhtml
4098 See ``CRIS Options'' in the main manual
4099 @end ifhtml
4100 for a list of CRIS-specific options.
4102 Use @samp{configure --target=cris-elf} to configure GCC@ for building
4103 a cross-compiler for CRIS.
4104 @html
4105 <hr />
4106 @end html
4107 @anchor{dos}
4108 @heading DOS
4109 Please have a look at the @uref{binaries.html,,binaries page}.
4111 You cannot install GCC by itself on MSDOS; it will not compile under
4112 any MSDOS compiler except itself.  You need to get the complete
4113 compilation package DJGPP, which includes binaries as well as sources,
4114 and includes all the necessary compilation tools and libraries.
4116 @html
4117 <hr />
4118 @end html
4119 @anchor{epiphany-x-elf}
4120 @heading epiphany-*-elf
4121 Adapteva Epiphany.
4122 This configuration is intended for embedded systems.
4124 @html
4125 <hr />
4126 @end html
4127 @anchor{x-x-freebsd}
4128 @heading *-*-freebsd*
4129 In order to better utilize FreeBSD base system functionality and match
4130 the configuration of the system compiler, GCC 4.5 and above as well as
4131 GCC 4.4 past 2010-06-20 leverage SSP support in libc (which is present
4132 on FreeBSD 7 or later) and the use of @code{__cxa_atexit} by default
4133 (on FreeBSD 6 or later).  The use of @code{dl_iterate_phdr} inside
4134 @file{libgcc_s.so.1} and boehm-gc (on FreeBSD 7 or later) is enabled
4135 by GCC 4.5 and above.
4137 We support FreeBSD using the ELF file format with DWARF 2 debugging
4138 for all CPU architectures.  There are
4139 no known issues with mixing object files and libraries with different
4140 debugging formats.  Otherwise, this release of GCC should now match
4141 more of the configuration used in the stock FreeBSD configuration of
4142 GCC@.  In particular, @option{--enable-threads} is now configured by
4143 default.  However, as a general user, do not attempt to replace the
4144 system compiler with this release.  Known to bootstrap and check with
4145 good results on FreeBSD 7.2-STABLE@.  In the past, known to bootstrap
4146 and check with good results on FreeBSD 3.0, 3.4, 4.0, 4.2, 4.3, 4.4,
4147 4.5, 4.8, 4.9 and 5-CURRENT@.
4149 The version of binutils installed in @file{/usr/bin} probably works
4150 with this release of GCC@.  Bootstrapping against the latest GNU
4151 binutils and/or the version found in @file{/usr/ports/devel/binutils} has
4152 been known to enable additional features and improve overall testsuite
4153 results.  However, it is currently known that boehm-gc may not configure
4154 properly on FreeBSD prior to the FreeBSD 7.0 release with GNU binutils
4155 after 2.16.1.
4157 @html
4158 <hr />
4159 @end html
4160 @anchor{ft32-x-elf}
4161 @heading ft32-*-elf
4162 The FT32 processor.
4163 This configuration is intended for embedded systems.
4165 @html
4166 <hr />
4167 @end html
4168 @anchor{h8300-hms}
4169 @heading h8300-hms
4170 Renesas H8/300 series of processors.
4172 Please have a look at the @uref{binaries.html,,binaries page}.
4174 The calling convention and structure layout has changed in release 2.6.
4175 All code must be recompiled.  The calling convention now passes the
4176 first three arguments in function calls in registers.  Structures are no
4177 longer a multiple of 2 bytes.
4179 @html
4180 <hr />
4181 @end html
4182 @anchor{hppa-hp-hpux}
4183 @heading hppa*-hp-hpux*
4184 Support for HP-UX version 9 and older was discontinued in GCC 3.4.
4186 We require using gas/binutils on all hppa platforms.  Version 2.19 or
4187 later is recommended.
4189 It may be helpful to configure GCC with the
4190 @uref{./configure.html#with-gnu-as,,@option{--with-gnu-as}} and
4191 @option{--with-as=@dots{}} options to ensure that GCC can find GAS@.
4193 The HP assembler should not be used with GCC.  It is rarely tested and may
4194 not work.  It shouldn't be used with any languages other than C due to its
4195 many limitations.
4197 Specifically, @option{-g} does not work (HP-UX uses a peculiar debugging
4198 format which GCC does not know about).  It also inserts timestamps
4199 into each object file it creates, causing the 3-stage comparison test to
4200 fail during a bootstrap.  You should be able to continue by saying
4201 @samp{make all-host all-target} after getting the failure from @samp{make}.
4203 Various GCC features are not supported.  For example, it does not support weak
4204 symbols or alias definitions.  As a result, explicit template instantiations
4205 are required when using C++.  This makes it difficult if not impossible to
4206 build many C++ applications.
4208 There are two default scheduling models for instructions.  These are
4209 PROCESSOR_7100LC and PROCESSOR_8000.  They are selected from the pa-risc
4210 architecture specified for the target machine when configuring.
4211 PROCESSOR_8000 is the default.  PROCESSOR_7100LC is selected when
4212 the target is a @samp{hppa1*} machine.
4214 The PROCESSOR_8000 model is not well suited to older processors.  Thus,
4215 it is important to completely specify the machine architecture when
4216 configuring if you want a model other than PROCESSOR_8000.  The macro
4217 TARGET_SCHED_DEFAULT can be defined in BOOT_CFLAGS if a different
4218 default scheduling model is desired.
4220 As of GCC 4.0, GCC uses the UNIX 95 namespace for HP-UX 10.10
4221 through 11.00, and the UNIX 98 namespace for HP-UX 11.11 and later.
4222 This namespace change might cause problems when bootstrapping with
4223 an earlier version of GCC or the HP compiler as essentially the same
4224 namespace is required for an entire build.  This problem can be avoided
4225 in a number of ways.  With HP cc, @env{UNIX_STD} can be set to @samp{95}
4226 or @samp{98}.  Another way is to add an appropriate set of predefines
4227 to @env{CC}.  The description for the @option{munix=} option contains
4228 a list of the predefines used with each standard.
4230 More specific information to @samp{hppa*-hp-hpux*} targets follows.
4232 @html
4233 <hr />
4234 @end html
4235 @anchor{hppa-hp-hpux10}
4236 @heading hppa*-hp-hpux10
4237 For hpux10.20, we @emph{highly} recommend you pick up the latest sed patch
4238 @code{PHCO_19798} from HP@.
4240 The C++ ABI has changed incompatibly in GCC 4.0.  COMDAT subspaces are
4241 used for one-only code and data.  This resolves many of the previous
4242 problems in using C++ on this target.  However, the ABI is not compatible
4243 with the one implemented under HP-UX 11 using secondary definitions.
4245 @html
4246 <hr />
4247 @end html
4248 @anchor{hppa-hp-hpux11}
4249 @heading hppa*-hp-hpux11
4250 GCC 3.0 and up support HP-UX 11.  GCC 2.95.x is not supported and cannot
4251 be used to compile GCC 3.0 and up.
4253 The libffi library haven't been ported to 64-bit HP-UX@ and doesn't build.
4255 Refer to @uref{binaries.html,,binaries} for information about obtaining
4256 precompiled GCC binaries for HP-UX@.  Precompiled binaries must be obtained
4257 to build the Ada language as it cannot be bootstrapped using C@.  Ada is
4258 only available for the 32-bit PA-RISC runtime.
4260 Starting with GCC 3.4 an ISO C compiler is required to bootstrap.  The
4261 bundled compiler supports only traditional C; you will need either HP's
4262 unbundled compiler, or a binary distribution of GCC@.
4264 It is possible to build GCC 3.3 starting with the bundled HP compiler,
4265 but the process requires several steps.  GCC 3.3 can then be used to
4266 build later versions.
4268 There are several possible approaches to building the distribution.
4269 Binutils can be built first using the HP tools.  Then, the GCC
4270 distribution can be built.  The second approach is to build GCC
4271 first using the HP tools, then build binutils, then rebuild GCC@.
4272 There have been problems with various binary distributions, so it
4273 is best not to start from a binary distribution.
4275 On 64-bit capable systems, there are two distinct targets.  Different
4276 installation prefixes must be used if both are to be installed on
4277 the same system.  The @samp{hppa[1-2]*-hp-hpux11*} target generates code
4278 for the 32-bit PA-RISC runtime architecture and uses the HP linker.
4279 The @samp{hppa64-hp-hpux11*} target generates 64-bit code for the
4280 PA-RISC 2.0 architecture.
4282 The script config.guess now selects the target type based on the compiler
4283 detected during configuration.  You must define @env{PATH} or @env{CC} so
4284 that configure finds an appropriate compiler for the initial bootstrap.
4285 When @env{CC} is used, the definition should contain the options that are
4286 needed whenever @env{CC} is used.
4288 Specifically, options that determine the runtime architecture must be
4289 in @env{CC} to correctly select the target for the build.  It is also
4290 convenient to place many other compiler options in @env{CC}.  For example,
4291 @env{CC="cc -Ac +DA2.0W -Wp,-H16376 -D_CLASSIC_TYPES -D_HPUX_SOURCE"}
4292 can be used to bootstrap the GCC 3.3 branch with the HP compiler in
4293 64-bit K&R/bundled mode.  The @option{+DA2.0W} option will result in
4294 the automatic selection of the @samp{hppa64-hp-hpux11*} target.  The
4295 macro definition table of cpp needs to be increased for a successful
4296 build with the HP compiler.  _CLASSIC_TYPES and _HPUX_SOURCE need to
4297 be defined when building with the bundled compiler, or when using the
4298 @option{-Ac} option.  These defines aren't necessary with @option{-Ae}.
4300 It is best to explicitly configure the @samp{hppa64-hp-hpux11*} target
4301 with the @option{--with-ld=@dots{}} option.  This overrides the standard
4302 search for ld.  The two linkers supported on this target require different
4303 commands.  The default linker is determined during configuration.  As a
4304 result, it's not possible to switch linkers in the middle of a GCC build.
4305 This has been reported to sometimes occur in unified builds of binutils
4306 and GCC@.
4308 A recent linker patch must be installed for the correct operation of
4309 GCC 3.3 and later.  @code{PHSS_26559} and @code{PHSS_24304} are the
4310 oldest linker patches that are known to work.  They are for HP-UX
4311 11.00 and 11.11, respectively.  @code{PHSS_24303}, the companion to
4312 @code{PHSS_24304}, might be usable but it hasn't been tested.  These
4313 patches have been superseded.  Consult the HP patch database to obtain
4314 the currently recommended linker patch for your system.
4316 The patches are necessary for the support of weak symbols on the
4317 32-bit port, and for the running of initializers and finalizers.  Weak
4318 symbols are implemented using SOM secondary definition symbols.  Prior
4319 to HP-UX 11, there are bugs in the linker support for secondary symbols.
4320 The patches correct a problem of linker core dumps creating shared
4321 libraries containing secondary symbols, as well as various other
4322 linking issues involving secondary symbols.
4324 GCC 3.3 uses the ELF DT_INIT_ARRAY and DT_FINI_ARRAY capabilities to
4325 run initializers and finalizers on the 64-bit port.  The 32-bit port
4326 uses the linker @option{+init} and @option{+fini} options for the same
4327 purpose.  The patches correct various problems with the +init/+fini
4328 options, including program core dumps.  Binutils 2.14 corrects a
4329 problem on the 64-bit port resulting from HP's non-standard use of
4330 the .init and .fini sections for array initializers and finalizers.
4332 Although the HP and GNU linkers are both supported for the
4333 @samp{hppa64-hp-hpux11*} target, it is strongly recommended that the
4334 HP linker be used for link editing on this target.
4336 At this time, the GNU linker does not support the creation of long
4337 branch stubs.  As a result, it cannot successfully link binaries
4338 containing branch offsets larger than 8 megabytes.  In addition,
4339 there are problems linking shared libraries, linking executables
4340 with @option{-static}, and with dwarf2 unwind and exception support.
4341 It also doesn't provide stubs for internal calls to global functions
4342 in shared libraries, so these calls cannot be overloaded.
4344 The HP dynamic loader does not support GNU symbol versioning, so symbol
4345 versioning is not supported.  It may be necessary to disable symbol
4346 versioning with @option{--disable-symvers} when using GNU ld.
4348 POSIX threads are the default.  The optional DCE thread library is not
4349 supported, so @option{--enable-threads=dce} does not work.
4351 @html
4352 <hr />
4353 @end html
4354 @anchor{x-x-linux-gnu}
4355 @heading *-*-linux-gnu
4356 The @code{.init_array} and @code{.fini_array} sections are enabled
4357 unconditionally which requires at least glibc 2.1 and binutils 2.12.
4359 Versions of libstdc++-v3 starting with 3.2.1 require bug fixes present
4360 in glibc 2.2.5 and later.  More information is available in the
4361 libstdc++-v3 documentation.
4363 @html
4364 <hr />
4365 @end html
4366 @anchor{ix86-x-linux}
4367 @heading i?86-*-linux*
4368 As of GCC 3.3, binutils 2.13.1 or later is required for this platform.
4369 See @uref{https://gcc.gnu.org/PR10877,,bug 10877} for more information.
4371 If you receive Signal 11 errors when building on GNU/Linux, then it is
4372 possible you have a hardware problem.  Further information on this can be
4373 found on @uref{https://www.bitwizard.nl/sig11/,,www.bitwizard.nl}.
4375 @html
4376 <hr />
4377 @end html
4378 @anchor{ix86-x-solaris2}
4379 @heading i?86-*-solaris2*
4380 Use this for Solaris 11.3 or later on x86 and x86-64 systems.  Starting
4381 with GCC 4.7, there is also a 64-bit @samp{amd64-*-solaris2*} or
4382 @samp{x86_64-*-solaris2*} configuration that corresponds to
4383 @samp{sparcv9-sun-solaris2*}.
4385 @html
4386 <hr />
4387 @end html
4388 @anchor{ia64-x-linux}
4389 @heading ia64-*-linux
4390 IA-64 processor (also known as IPF, or Itanium Processor Family)
4391 running GNU/Linux.
4393 If you are using the installed system libunwind library with
4394 @option{--with-system-libunwind}, then you must use libunwind 0.98 or
4395 later.
4397 @html
4398 <hr />
4399 @end html
4400 @anchor{ia64-x-hpux}
4401 @heading ia64-*-hpux*
4402 Building GCC on this target requires the GNU Assembler.  The bundled HP
4403 assembler will not work.  To prevent GCC from using the wrong assembler,
4404 the option @option{--with-gnu-as} may be necessary.
4406 The GCC libunwind library has not been ported to HPUX@.  This means that for
4407 GCC versions 3.2.3 and earlier, @option{--enable-libunwind-exceptions}
4408 is required to build GCC@.  For GCC 3.3 and later, this is the default.
4409 For gcc 3.4.3 and later, @option{--enable-libunwind-exceptions} is
4410 removed and the system libunwind library will always be used.
4412 @html
4413 <hr />
4414 <!-- rs6000-ibm-aix*, powerpc-ibm-aix* -->
4415 @end html
4416 @anchor{x-ibm-aix}
4417 @heading *-ibm-aix*
4418 Support for AIX version 3 and older was discontinued in GCC 3.4.
4419 Support for AIX version 4.2 and older was discontinued in GCC 4.5.
4421 ``out of memory'' bootstrap failures may indicate a problem with
4422 process resource limits (ulimit).  Hard limits are configured in the
4423 @file{/etc/security/limits} system configuration file.
4425 GCC 4.9 and above require a C++ compiler for bootstrap.  IBM VAC++ / xlC
4426 cannot bootstrap GCC.  xlc can bootstrap an older version of GCC and
4427 G++ can bootstrap recent releases of GCC.
4429 GCC can bootstrap with recent versions of IBM XLC, but bootstrapping
4430 with an earlier release of GCC is recommended.  Bootstrapping with XLC
4431 requires a larger data segment, which can be enabled through the
4432 @var{LDR_CNTRL} environment variable, e.g.,
4434 @smallexample
4435 % LDR_CNTRL=MAXDATA=0x50000000
4436 % export LDR_CNTRL
4437 @end smallexample
4439 One can start with a pre-compiled version of GCC to build from
4440 sources.  One may delete GCC's ``fixed'' header files when starting
4441 with a version of GCC built for an earlier release of AIX.
4443 To speed up the configuration phases of bootstrapping and installing GCC,
4444 one may use GNU Bash instead of AIX @command{/bin/sh}, e.g.,
4446 @smallexample
4447 % CONFIG_SHELL=/opt/freeware/bin/bash
4448 % export CONFIG_SHELL
4449 @end smallexample
4451 and then proceed as described in @uref{build.html,,the build
4452 instructions}, where we strongly recommend specifying an absolute path
4453 to invoke @var{srcdir}/configure.
4455 Because GCC on AIX is built as a 32-bit executable by default,
4456 (although it can generate 64-bit programs) the GMP and MPFR libraries
4457 required by gfortran must be 32-bit libraries.  Building GMP and MPFR
4458 as static archive libraries works better than shared libraries.
4460 Errors involving @code{alloca} when building GCC generally are due
4461 to an incorrect definition of @code{CC} in the Makefile or mixing files
4462 compiled with the native C compiler and GCC@.  During the stage1 phase of
4463 the build, the native AIX compiler @strong{must} be invoked as @command{cc}
4464 (not @command{xlc}).  Once @command{configure} has been informed of
4465 @command{xlc}, one needs to use @samp{make distclean} to remove the
4466 configure cache files and ensure that @env{CC} environment variable
4467 does not provide a definition that will confuse @command{configure}.
4468 If this error occurs during stage2 or later, then the problem most likely
4469 is the version of Make (see above).
4471 The native @command{as} and @command{ld} are recommended for
4472 bootstrapping on AIX@.  The GNU Assembler, GNU Linker, and GNU
4473 Binutils version 2.20 is the minimum level that supports bootstrap on
4474 AIX 5@.  The GNU Assembler has not been updated to support AIX 6@ or
4475 AIX 7.  The native AIX tools do interoperate with GCC@.
4477 AIX 7.1 added partial support for DWARF debugging, but full support
4478 requires AIX 7.1 TL03 SP7 that supports additional DWARF sections and
4479 fixes a bug in the assembler.  AIX 7.1 TL03 SP5 distributed a version
4480 of libm.a missing important symbols; a fix for IV77796 will be
4481 included in SP6.
4483 AIX 5.3 TL10, AIX 6.1 TL05 and AIX 7.1 TL00 introduced an AIX
4484 assembler change that sometimes produces corrupt assembly files
4485 causing AIX linker errors.  The bug breaks GCC bootstrap on AIX and
4486 can cause compilation failures with existing GCC installations.  An
4487 AIX iFix for AIX 5.3 is available (APAR IZ98385 for AIX 5.3 TL10, APAR
4488 IZ98477 for AIX 5.3 TL11 and IZ98134 for AIX 5.3 TL12). AIX 5.3 TL11 SP8,
4489 AIX 5.3 TL12 SP5, AIX 6.1 TL04 SP11, AIX 6.1 TL05 SP7, AIX 6.1 TL06 SP6,
4490 AIX 6.1 TL07 and AIX 7.1 TL01 should include the fix.
4492 Building @file{libstdc++.a} requires a fix for an AIX Assembler bug
4493 APAR IY26685 (AIX 4.3) or APAR IY25528 (AIX 5.1).  It also requires a
4494 fix for another AIX Assembler bug and a co-dependent AIX Archiver fix
4495 referenced as APAR IY53606 (AIX 5.2) or as APAR IY54774 (AIX 5.1)
4497 @anchor{TransferAixShobj}
4498 @samp{libstdc++} in GCC 3.4 increments the major version number of the
4499 shared object and GCC installation places the @file{libstdc++.a}
4500 shared library in a common location which will overwrite the and GCC
4501 3.3 version of the shared library.  Applications either need to be
4502 re-linked against the new shared library or the GCC 3.1 and GCC 3.3
4503 versions of the @samp{libstdc++} shared object needs to be available
4504 to the AIX runtime loader.  The GCC 3.1 @samp{libstdc++.so.4}, if
4505 present, and GCC 3.3 @samp{libstdc++.so.5} shared objects can be
4506 installed for runtime dynamic loading using the following steps to set
4507 the @samp{F_LOADONLY} flag in the shared object for @emph{each}
4508 multilib @file{libstdc++.a} installed:
4510 Extract the shared objects from the currently installed
4511 @file{libstdc++.a} archive:
4512 @smallexample
4513 % ar -x libstdc++.a libstdc++.so.4 libstdc++.so.5
4514 @end smallexample
4516 Enable the @samp{F_LOADONLY} flag so that the shared object will be
4517 available for runtime dynamic loading, but not linking:
4518 @smallexample
4519 % strip -e libstdc++.so.4 libstdc++.so.5
4520 @end smallexample
4522 Archive the runtime-only shared object in the GCC 3.4
4523 @file{libstdc++.a} archive:
4524 @smallexample
4525 % ar -q libstdc++.a libstdc++.so.4 libstdc++.so.5
4526 @end smallexample
4528 Eventually, the
4529 @uref{./configure.html#WithAixSoname,,@option{--with-aix-soname=svr4}}
4530 configure option may drop the need for this procedure for libraries that
4531 support it.
4533 Linking executables and shared libraries may produce warnings of
4534 duplicate symbols.  The assembly files generated by GCC for AIX always
4535 have included multiple symbol definitions for certain global variable
4536 and function declarations in the original program.  The warnings should
4537 not prevent the linker from producing a correct library or runnable
4538 executable.
4540 AIX 4.3 utilizes a ``large format'' archive to support both 32-bit and
4541 64-bit object modules.  The routines provided in AIX 4.3.0 and AIX 4.3.1
4542 to parse archive libraries did not handle the new format correctly.
4543 These routines are used by GCC and result in error messages during
4544 linking such as ``not a COFF file''.  The version of the routines shipped
4545 with AIX 4.3.1 should work for a 32-bit environment.  The @option{-g}
4546 option of the archive command may be used to create archives of 32-bit
4547 objects using the original ``small format''.  A correct version of the
4548 routines is shipped with AIX 4.3.2 and above.
4550 Some versions of the AIX binder (linker) can fail with a relocation
4551 overflow severe error when the @option{-bbigtoc} option is used to link
4552 GCC-produced object files into an executable that overflows the TOC@.  A fix
4553 for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND -BBIGTOC) is
4554 available from IBM Customer Support and from its
4555 @uref{https://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
4556 website as PTF U455193.
4558 The AIX 4.3.2.1 linker (bos.rte.bind_cmds Level 4.3.2.1) will dump core
4559 with a segmentation fault when invoked by any version of GCC@.  A fix for
4560 APAR IX87327 is available from IBM Customer Support and from its
4561 @uref{https://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
4562 website as PTF U461879.  This fix is incorporated in AIX 4.3.3 and above.
4564 The initial assembler shipped with AIX 4.3.0 generates incorrect object
4565 files.  A fix for APAR IX74254 (64BIT DISASSEMBLED OUTPUT FROM COMPILER FAILS
4566 TO ASSEMBLE/BIND) is available from IBM Customer Support and from its
4567 @uref{https://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
4568 website as PTF U453956.  This fix is incorporated in AIX 4.3.1 and above.
4570 AIX provides National Language Support (NLS)@.  Compilers and assemblers
4571 use NLS to support locale-specific representations of various data
4572 formats including floating-point numbers (e.g., @samp{.}  vs @samp{,} for
4573 separating decimal fractions).  There have been problems reported where
4574 GCC does not produce the same floating-point formats that the assembler
4575 expects.  If one encounters this problem, set the @env{LANG}
4576 environment variable to @samp{C} or @samp{En_US}.
4578 A default can be specified with the @option{-mcpu=@var{cpu_type}}
4579 switch and using the configure option @option{--with-cpu-@var{cpu_type}}.
4581 @html
4582 <hr />
4583 @end html
4584 @anchor{iq2000-x-elf}
4585 @heading iq2000-*-elf
4586 Vitesse IQ2000 processors.  These are used in embedded
4587 applications.  There are no standard Unix configurations.
4589 @html
4590 <hr />
4591 @end html
4592 @anchor{lm32-x-elf}
4593 @heading lm32-*-elf
4594 Lattice Mico32 processor.
4595 This configuration is intended for embedded systems.
4597 @html
4598 <hr />
4599 @end html
4600 @anchor{lm32-x-uclinux}
4601 @heading lm32-*-uclinux
4602 Lattice Mico32 processor.
4603 This configuration is intended for embedded systems running uClinux.
4605 @html
4606 <hr />
4607 @end html
4608 @anchor{loongarch}
4609 @heading LoongArch
4610 LoongArch processor.
4611 The following LoongArch targets are available:
4612 @table @code
4613 @item loongarch64-linux-gnu*
4614 LoongArch processor running GNU/Linux.  This target triplet may be coupled
4615 with a small set of possible suffixes to identify their default ABI type:
4616 @table @code
4617 @item f64
4618 Uses @code{lp64d/base} ABI by default.
4619 @item f32
4620 Uses @code{lp64f/base} ABI by default.
4621 @item sf
4622 Uses @code{lp64s/base} ABI by default.
4623 @end table
4625 @item loongarch64-linux-gnu
4626 Same as @code{loongarch64-linux-gnuf64} for legacy support.
4627 @end table
4629 More information about LoongArch can be found at
4630 @uref{https://github.com/loongson/LoongArch-Documentation}.
4632 @html
4633 <hr />
4634 @end html
4635 @anchor{m32c-x-elf}
4636 @heading m32c-*-elf
4637 Renesas M32C processor.
4638 This configuration is intended for embedded systems.
4640 @html
4641 <hr />
4642 @end html
4643 @anchor{m32r-x-elf}
4644 @heading m32r-*-elf
4645 Renesas M32R processor.
4646 This configuration is intended for embedded systems.
4648 @html
4649 <hr />
4650 @end html
4651 @anchor{m68k-x-x}
4652 @heading m68k-*-*
4653 By default,
4654 @samp{m68k-*-elf*}, @samp{m68k-*-rtems},  @samp{m68k-*-uclinux} and
4655 @samp{m68k-*-linux}
4656 build libraries for both M680x0 and ColdFire processors.  If you only
4657 need the M680x0 libraries, you can omit the ColdFire ones by passing
4658 @option{--with-arch=m68k} to @command{configure}.  Alternatively, you
4659 can omit the M680x0 libraries by passing @option{--with-arch=cf} to
4660 @command{configure}.  These targets default to 5206 or 5475 code as
4661 appropriate for the target system when
4662 configured with @option{--with-arch=cf} and 68020 code otherwise.
4664 The @samp{m68k-*-netbsd} and
4665 @samp{m68k-*-openbsd} targets also support the @option{--with-arch}
4666 option.  They will generate ColdFire CFV4e code when configured with
4667 @option{--with-arch=cf} and 68020 code otherwise.
4669 You can override the default processors listed above by configuring
4670 with @option{--with-cpu=@var{target}}.  This @var{target} can either
4671 be a @option{-mcpu} argument or one of the following values:
4672 @samp{m68000}, @samp{m68010}, @samp{m68020}, @samp{m68030},
4673 @samp{m68040}, @samp{m68060}, @samp{m68020-40} and @samp{m68020-60}.
4675 GCC requires at least binutils version 2.17 on these targets.
4677 @html
4678 <hr />
4679 @end html
4680 @anchor{m68k-x-uclinux}
4681 @heading m68k-*-uclinux
4682 GCC 4.3 changed the uClinux configuration so that it uses the
4683 @samp{m68k-linux-gnu} ABI rather than the @samp{m68k-elf} ABI.
4684 It also added improved support for C++ and flat shared libraries,
4685 both of which were ABI changes.
4687 @html
4688 <hr />
4689 @end html
4690 @anchor{microblaze-x-elf}
4691 @heading microblaze-*-elf
4692 Xilinx MicroBlaze processor.
4693 This configuration is intended for embedded systems.
4695 @html
4696 <hr />
4697 @end html
4698 @anchor{mips-x-x}
4699 @heading mips-*-*
4700 If on a MIPS system you get an error message saying ``does not have gp
4701 sections for all it's [sic] sectons [sic]'', don't worry about it.  This
4702 happens whenever you use GAS with the MIPS linker, but there is not
4703 really anything wrong, and it is okay to use the output file.  You can
4704 stop such warnings by installing the GNU linker.
4706 It would be nice to extend GAS to produce the gp tables, but they are
4707 optional, and there should not be a warning about their absence.
4709 The libstdc++ atomic locking routines for MIPS targets requires MIPS II
4710 and later.  A patch went in just after the GCC 3.3 release to
4711 make @samp{mips*-*-*} use the generic implementation instead.  You can also
4712 configure for @samp{mipsel-elf} as a workaround.  The
4713 @samp{mips*-*-linux*} target continues to use the MIPS II routines.  More
4714 work on this is expected in future releases.
4716 @c If you make --with-llsc the default for another target, please also
4717 @c update the description of the --with-llsc option.
4719 The built-in @code{__sync_*} functions are available on MIPS II and
4720 later systems and others that support the @samp{ll}, @samp{sc} and
4721 @samp{sync} instructions.  This can be overridden by passing
4722 @option{--with-llsc} or @option{--without-llsc} when configuring GCC.
4723 Since the Linux kernel emulates these instructions if they are
4724 missing, the default for @samp{mips*-*-linux*} targets is
4725 @option{--with-llsc}.  The @option{--with-llsc} and
4726 @option{--without-llsc} configure options may be overridden at compile
4727 time by passing the @option{-mllsc} or @option{-mno-llsc} options to
4728 the compiler.
4730 MIPS systems check for division by zero (unless
4731 @option{-mno-check-zero-division} is passed to the compiler) by
4732 generating either a conditional trap or a break instruction.  Using
4733 trap results in smaller code, but is only supported on MIPS II and
4734 later.  Also, some versions of the Linux kernel have a bug that
4735 prevents trap from generating the proper signal (@code{SIGFPE}).  To enable
4736 the use of break, use the @option{--with-divide=breaks}
4737 @command{configure} option when configuring GCC@.  The default is to
4738 use traps on systems that support them.
4740 @html
4741 <hr />
4742 @end html
4743 @anchor{moxie-x-elf}
4744 @heading moxie-*-elf
4745 The moxie processor.
4747 @html
4748 <hr />
4749 @end html
4750 @anchor{msp430-x-elf}
4751 @heading msp430-*-elf*
4752 TI MSP430 processor.
4753 This configuration is intended for embedded systems.
4755 @samp{msp430-*-elf} is the standard configuration with most GCC
4756 features enabled by default.
4758 @samp{msp430-*-elfbare} is tuned for a bare-metal environment, and disables
4759 features related to shared libraries and other functionality not used for
4760 this device.  This reduces code and data usage of the GCC libraries, resulting
4761 in a minimal run-time environment by default.
4763 Features disabled by default include:
4764 @itemize
4765 @item transactional memory
4766 @item __cxa_atexit
4767 @end itemize
4769 @html
4770 <hr />
4771 @end html
4772 @anchor{nds32le-x-elf}
4773 @heading nds32le-*-elf
4774 Andes NDS32 target in little endian mode.
4776 @html
4777 <hr />
4778 @end html
4779 @anchor{nds32be-x-elf}
4780 @heading nds32be-*-elf
4781 Andes NDS32 target in big endian mode.
4783 @html
4784 <hr />
4785 @end html
4786 @anchor{nvptx-x-none}
4787 @heading nvptx-*-none
4788 Nvidia PTX target.
4790 Instead of GNU binutils, you will need to install
4791 @uref{https://github.com/MentorEmbedded/nvptx-tools/,,nvptx-tools}.
4792 Tell GCC where to find it:
4793 @option{--with-build-time-tools=[install-nvptx-tools]/nvptx-none/bin}.
4795 You will need newlib 4.3.0 or later.  It can be
4796 automatically built together with GCC@.  For this, add a symbolic link
4797 to nvptx-newlib's @file{newlib} directory to the directory containing
4798 the GCC sources.
4800 Use the @option{--disable-sjlj-exceptions} and
4801 @option{--enable-newlib-io-long-long} options when configuring.
4803 The @option{--with-arch} option may be specified to override the
4804 default value for the @option{-march} option, and to also build
4805 corresponding target libraries.
4806 The default is @option{--with-arch=sm_30}.
4808 For example, if @option{--with-arch=sm_70} is specified,
4809 @option{-march=sm_30} and @option{-march=sm_70} target libraries are
4810 built, and code generation defaults to @option{-march=sm_70}.
4812 @html
4813 <hr />
4814 @end html
4815 @anchor{or1k-x-elf}
4816 @heading or1k-*-elf
4817 The OpenRISC 1000 32-bit processor with delay slots.
4818 This configuration is intended for embedded systems.
4820 @html
4821 <hr />
4822 @end html
4823 @anchor{or1k-x-linux}
4824 @heading or1k-*-linux
4825 The OpenRISC 1000 32-bit processor with delay slots.
4827 @html
4828 <hr />
4829 @end html
4830 @anchor{powerpc-x-x}
4831 @heading powerpc-*-*
4832 You can specify a default version for the @option{-mcpu=@var{cpu_type}}
4833 switch by using the configure option @option{--with-cpu-@var{cpu_type}}.
4835 You will need GNU binutils 2.20 or newer.
4837 @html
4838 <hr />
4839 @end html
4840 @anchor{powerpc-x-darwin}
4841 @heading powerpc-*-darwin*
4842 PowerPC running Darwin (Mac OS X kernel).
4844 Pre-installed versions of Mac OS X may not include any developer tools,
4845 meaning that you will not be able to build GCC from source.  Tool
4846 binaries are available at
4847 @uref{https://opensource.apple.com}.
4849 This version of GCC requires at least cctools-590.36.  The
4850 cctools-590.36 package referenced from
4851 @uref{https://gcc.gnu.org/ml/gcc/2006-03/msg00507.html} will not work
4852 on systems older than 10.3.9 (aka darwin7.9.0).
4854 @html
4855 <hr />
4856 @end html
4857 @anchor{powerpc-x-elf}
4858 @heading powerpc-*-elf
4859 PowerPC system in big endian mode, running System V.4.
4861 @html
4862 <hr />
4863 @end html
4864 @anchor{powerpc-x-linux-gnu}
4865 @heading powerpc*-*-linux-gnu*
4866 PowerPC system in big endian mode running Linux.
4868 @html
4869 <hr />
4870 @end html
4871 @anchor{powerpc-x-netbsd}
4872 @heading powerpc-*-netbsd*
4873 PowerPC system in big endian mode running NetBSD@.
4875 @html
4876 <hr />
4877 @end html
4878 @anchor{powerpc-x-eabisim}
4879 @heading powerpc-*-eabisim
4880 Embedded PowerPC system in big endian mode for use in running under the
4881 PSIM simulator.
4883 @html
4884 <hr />
4885 @end html
4886 @anchor{powerpc-x-eabi}
4887 @heading powerpc-*-eabi
4888 Embedded PowerPC system in big endian mode.
4890 @html
4891 <hr />
4892 @end html
4893 @anchor{powerpcle-x-elf}
4894 @heading powerpcle-*-elf
4895 PowerPC system in little endian mode, running System V.4.
4897 @html
4898 <hr />
4899 @end html
4900 @anchor{powerpcle-x-eabisim}
4901 @heading powerpcle-*-eabisim
4902 Embedded PowerPC system in little endian mode for use in running under
4903 the PSIM simulator.
4905 @html
4906 <hr />
4907 @end html
4908 @anchor{powerpcle-x-eabi}
4909 @heading powerpcle-*-eabi
4910 Embedded PowerPC system in little endian mode.
4912 @html
4913 <hr />
4914 @end html
4915 @anchor{rl78-x-elf}
4916 @heading rl78-*-elf
4917 The Renesas RL78 processor.
4918 This configuration is intended for embedded systems.
4920 @html
4921 <hr />
4922 @end html
4923 @anchor{riscv32-x-elf}
4924 @heading riscv32-*-elf
4925 The RISC-V RV32 instruction set.
4926 This configuration is intended for embedded systems.
4927 This (and all other RISC-V) targets require the binutils 2.30 release.
4929 @html
4930 <hr />
4931 @end html
4932 @anchor{riscv32-x-linux}
4933 @heading riscv32-*-linux
4934 The RISC-V RV32 instruction set running GNU/Linux.
4935 This (and all other RISC-V) targets require the binutils 2.30 release.
4937 @html
4938 <hr />
4939 @end html
4940 @anchor{riscv64-x-elf}
4941 @heading riscv64-*-elf
4942 The RISC-V RV64 instruction set.
4943 This configuration is intended for embedded systems.
4944 This (and all other RISC-V) targets require the binutils 2.30 release.
4946 @html
4947 <hr />
4948 @end html
4949 @anchor{riscv64-x-linux}
4950 @heading riscv64-*-linux
4951 The RISC-V RV64 instruction set running GNU/Linux.
4952 This (and all other RISC-V) targets require the binutils 2.30 release.
4954 @html
4955 <hr />
4956 @end html
4957 @anchor{rx-x-elf}
4958 @heading rx-*-elf
4959 The Renesas RX processor.
4961 @html
4962 <hr />
4963 @end html
4964 @anchor{s390-x-linux}
4965 @heading s390-*-linux*
4966 S/390 system running GNU/Linux for S/390@.
4968 @html
4969 <hr />
4970 @end html
4971 @anchor{s390x-x-linux}
4972 @heading s390x-*-linux*
4973 zSeries system (64-bit) running GNU/Linux for zSeries@.
4975 @html
4976 <hr />
4977 @end html
4978 @anchor{s390x-ibm-tpf}
4979 @heading s390x-ibm-tpf*
4980 zSeries system (64-bit) running TPF@.  This platform is
4981 supported as cross-compilation target only.
4983 @html
4984 <hr />
4985 @end html
4986 @anchor{x-x-solaris2}
4987 @heading *-*-solaris2*
4988 Support for Solaris 11.3 and earlier has been obsoleted in GCC 13, but
4989 can still be enabled by configuring with @option{--enable-obsolete}.
4990 Support for Solaris 10 has been removed in GCC 10.  Support for Solaris
4991 9 has been removed in GCC 5.  Support for Solaris 8 has been removed in
4992 GCC 4.8.  Support for Solaris 7 has been removed in GCC 4.6.
4994 Solaris 11.3 provides GCC 4.5.2, 4.7.3, and 4.8.2 as
4995 @command{/usr/gcc/4.5/bin/gcc} or similar.  Solaris 11.4
4996 provides one or more of GCC 5, 7, 9, 10, 11, and 12.
4998 You need to install the @code{system/header}, @code{system/linker}, and
4999 @code{developer/assembler} packages.
5001 Trying to use the compatibility tools in @file{/usr/ucb}, from the
5002 @code{compatibility/ucb} package, to install GCC has been observed to
5003 cause trouble.  The fix is to remove @file{/usr/ucb} from your
5004 @env{PATH}.
5006 @c FIXME: Still?  Prefer /usr/gnu/bin instead?
5007 The build process works more smoothly with the legacy Solaris tools so,
5008 if you have @file{/usr/xpg4/bin} in your @env{PATH}, we recommend that
5009 you place @file{/usr/bin} before @file{/usr/xpg4/bin} for the duration
5010 of the build.
5012 We recommend the use of the Solaris assembler or the GNU assembler, in
5013 conjunction with the Solaris linker.
5015 The GNU @command{as} versions included in Solaris 11.3, from GNU
5016 binutils 2.23.1 or newer (in @file{/usr/bin/gas} and
5017 @file{/usr/gnu/bin/as}), are known to work.  The version from GNU
5018 binutils 2.40 is known to work as well.  Recent versions of the Solaris
5019 assembler in @file{/usr/bin/as} work almost as well, though.  To use GNU
5020 @command{as}, configure with the options @option{--with-gnu-as
5021 --with-as=@//usr/@/gnu/@/bin/@/as}.
5023 For linking, the Solaris linker is preferred.  If you want to use the
5024 GNU linker instead, the version in Solaris 11.3, from GNU binutils
5025 2.23.1 or newer (in @file{/usr/gnu/bin/ld} and @file{/usr/bin/gld}),
5026 works, as does the version from GNU binutils 2.40.  However, it
5027 generally lacks platform specific features, so better stay with Solaris
5028 @command{ld}.  To use the LTO linker plugin
5029 (@option{-fuse-linker-plugin}) with GNU @command{ld}, GNU binutils
5030 @emph{must} be configured with @option{--enable-largefile}.  To use
5031 Solaris @command{ld}, we recommend to configure with
5032 @option{--without-gnu-ld --with-ld=@//usr/@/bin/@/ld} to guarantee the
5033 right linker is found irrespective of the user's @env{PATH}.
5035 Note that your mileage may vary if you use a combination of the GNU
5036 tools and the Solaris tools: while the combination GNU @command{as} and
5037 Solaris @command{ld} works well, the reverse combination Solaris
5038 @command{as} with GNU @command{ld} may fail to build or cause memory
5039 corruption at runtime in some cases for C++ programs.
5040 @c FIXME: still?
5042 To enable symbol versioning in @samp{libstdc++} and other runtime
5043 libraries with the Solaris linker, you need to have any version of GNU
5044 @command{c++filt}, which is part of GNU binutils.  Symbol versioning
5045 will be disabled if no appropriate version is found.  Solaris
5046 @command{c++filt} from the Solaris Studio compilers does @emph{not}
5047 work.
5049 In order to build the GNU Ada compiler, GNAT, a working GNAT is needed.
5050 Since Solaris 11.4 SRU 39, GNAT 11 or 12 is bundled in the
5051 @code{developer/gcc/gcc-gnat} package.
5053 In order to build the GNU D compiler, GDC, a working @samp{libphobos} is
5054 needed.  That library wasn't built by default in GCC 9--11 on SPARC, or
5055 on x86 when the Solaris assembler is used, but can be enabled by
5056 configuring with @option{--enable-libphobos}.  Also, GDC 9.4.0 is
5057 required on x86, while GDC 9.3.0 is known to work on SPARC.
5059 The versions of the GNU Multiple Precision Library (GMP), the MPFR
5060 library and the MPC library bundled with Solaris 11.3 and later are
5061 usually recent enough to match GCC's requirements.  There are two
5062 caveats:
5064 @itemize @bullet
5065 @item
5066 While the version of the GMP library in Solaris 11.3 works with GCC, you
5067 need to configure with @option{--with-gmp-include=/usr/include/gmp}.
5069 @item
5070 The version of the MPFR libary included in Solaris 11.3 is too old; you
5071 need to provide a more recent one.
5073 @end itemize
5075 @html
5076 <hr />
5077 @end html
5078 @anchor{sparc-x-x}
5079 @heading sparc*-*-*
5080 This section contains general configuration information for all
5081 SPARC-based platforms.  In addition to reading this section, please
5082 read all other sections that match your target.
5084 Newer versions of the GNU Multiple Precision Library (GMP), the MPFR
5085 library and the MPC library are known to be miscompiled by earlier
5086 versions of GCC on these platforms.  We therefore recommend the use
5087 of the exact versions of these libraries listed as minimal versions
5088 in @uref{prerequisites.html,,the prerequisites}.
5090 @html
5091 <hr />
5092 @end html
5093 @anchor{sparc-sun-solaris2}
5094 @heading sparc-sun-solaris2*
5095 When GCC is configured to use GNU binutils 2.14 or later, the binaries
5096 produced are smaller than the ones produced using Solaris native tools;
5097 this difference is quite significant for binaries containing debugging
5098 information.
5100 Starting with Solaris 7, the operating system is capable of executing
5101 64-bit SPARC V9 binaries.  GCC 3.1 and later properly supports
5102 this; the @option{-m64} option enables 64-bit code generation.
5104 When configuring the GNU Multiple Precision Library (GMP), the MPFR
5105 library or the MPC library on Solaris, the canonical target triplet must
5106 be specified as the @command{build} parameter on the @command{configure}
5107 line.  This target triplet can be obtained by invoking
5108 @command{./config.guess} in the toplevel source directory of GCC (and
5109 not that of GMP or MPFR or MPC).  For example:
5111 @smallexample
5112 % @var{srcdir}/configure --build=sparc-sun-solaris2.11 --prefix=@var{dirname}
5113 @end smallexample
5115 @html
5116 <hr />
5117 @end html
5118 @anchor{sparc-x-linux}
5119 @heading sparc-*-linux*
5121 @html
5122 <hr />
5123 @end html
5124 @anchor{sparc64-x-solaris2}
5125 @heading sparc64-*-solaris2*
5126 This is a synonym for @samp{sparcv9-*-solaris2*}.
5128 @html
5129 <hr />
5130 @end html
5131 @anchor{sparcv9-x-solaris2}
5132 @heading sparcv9-*-solaris2*
5134 When configuring a 64-bit-default GCC on Solaris/SPARC, you must use a
5135 build compiler that generates 64-bit code, either by default or by
5136 specifying @samp{CC='gcc -m64' CXX='g++ -m64' GDC='gdc -m64'} to @command{configure}.
5137 Additionally, you @emph{must} pass @option{--build=sparcv9-sun-solaris2.11}
5138 or @option{--build=sparc64-sun-solaris2.11} because @file{config.guess}
5139 misdetects this situation, which can cause build failures.
5141 When configuring the GNU Multiple Precision Library (GMP), the MPFR
5142 library or the MPC library, the canonical target triplet must be specified
5143 as the @command{build} parameter on the @command{configure} line.  For example:
5145 @smallexample
5146 % @var{srcdir}/configure --build=sparcv9-sun-solaris2.11 --prefix=@var{dirname}
5147 @end smallexample
5149 @html
5150 <hr />
5151 @end html
5152 @anchor{c6x-x-x}
5153 @heading c6x-*-*
5154 The C6X family of processors. This port requires binutils-2.22 or newer.
5156 @html
5157 <hr />
5158 @end html
5159 @anchor{visium-x-elf}
5160 @heading visium-*-elf
5161 CDS VISIUMcore processor.
5162 This configuration is intended for embedded systems.
5164 @html
5165 <hr />
5166 @end html
5167 @anchor{x-x-vxworks}
5168 @heading *-*-vxworks*
5169 Support for VxWorks is in flux.  At present GCC supports @emph{only} the
5170 very recent VxWorks 5.5 (aka Tornado 2.2) release, and only on PowerPC@.
5171 We welcome patches for other architectures supported by VxWorks 5.5.
5172 Support for VxWorks AE would also be welcome; we believe this is merely
5173 a matter of writing an appropriate ``configlette'' (see below).  We are
5174 not interested in supporting older, a.out or COFF-based, versions of
5175 VxWorks in GCC 3.
5177 VxWorks comes with an older version of GCC installed in
5178 @file{@var{$WIND_BASE}/host}; we recommend you do not overwrite it.
5179 Choose an installation @var{prefix} entirely outside @var{$WIND_BASE}.
5180 Before running @command{configure}, create the directories @file{@var{prefix}}
5181 and @file{@var{prefix}/bin}.  Link or copy the appropriate assembler,
5182 linker, etc.@: into @file{@var{prefix}/bin}, and set your @var{PATH} to
5183 include that directory while running both @command{configure} and
5184 @command{make}.
5186 You must give @command{configure} the
5187 @option{--with-headers=@var{$WIND_BASE}/target/h} switch so that it can
5188 find the VxWorks system headers.  Since VxWorks is a cross compilation
5189 target only, you must also specify @option{--target=@var{target}}.
5190 @command{configure} will attempt to create the directory
5191 @file{@var{prefix}/@var{target}/sys-include} and copy files into it;
5192 make sure the user running @command{configure} has sufficient privilege
5193 to do so.
5195 GCC's exception handling runtime requires a special ``configlette''
5196 module, @file{contrib/gthr_supp_vxw_5x.c}.  Follow the instructions in
5197 that file to add the module to your kernel build.  (Future versions of
5198 VxWorks will incorporate this module.)
5200 @html
5201 <hr />
5202 @end html
5203 @anchor{x86-64-x-x}
5204 @heading x86_64-*-*, amd64-*-*
5205 GCC supports the x86-64 architecture implemented by the AMD64 processor
5206 (amd64-*-* is an alias for x86_64-*-*) on GNU/Linux, FreeBSD and NetBSD@.
5207 On GNU/Linux the default is a bi-arch compiler which is able to generate
5208 both 64-bit x86-64 and 32-bit x86 code (via the @option{-m32} switch).
5210 @html
5211 <hr />
5212 @end html
5213 @anchor{x86-64-x-solaris2}
5214 @heading x86_64-*-solaris2*
5215 GCC also supports the x86-64 architecture implemented by the AMD64
5216 processor (@samp{amd64-*-*} is an alias for @samp{x86_64-*-*}).
5217 Unlike other systems, without special options a
5218 bi-arch compiler is built which generates 32-bit code by default, but
5219 can generate 64-bit x86-64 code with the @option{-m64} switch.  Since
5220 GCC 4.7, there is also a configuration that defaults to 64-bit code, but
5221 can generate 32-bit code with @option{-m32}.  To configure and build
5222 this way, you have to provide all support libraries like @file{libgmp}
5223 as 64-bit code, configure with @option{--target=x86_64-pc-solaris2.11}
5224 and @samp{CC=gcc -m64}.
5226 @html
5227 <hr />
5228 @end html
5229 @anchor{xtensa-x-elf}
5230 @heading xtensa*-*-elf
5231 This target is intended for embedded Xtensa systems using the
5232 @samp{newlib} C library.  It uses ELF but does not support shared
5233 objects.  Designed-defined instructions specified via the
5234 Tensilica Instruction Extension (TIE) language are only supported
5235 through inline assembly.
5237 The Xtensa configuration information must be specified prior to
5238 building GCC@.  The @file{include/xtensa-config.h} header
5239 file contains the configuration information.  If you created your
5240 own Xtensa configuration with the Xtensa Processor Generator, the
5241 downloaded files include a customized copy of this header file,
5242 which you can use to replace the default header file.
5244 @html
5245 <hr />
5246 @end html
5247 @anchor{xtensa-x-linux}
5248 @heading xtensa*-*-linux*
5249 This target is for Xtensa systems running GNU/Linux.  It supports ELF
5250 shared objects and the GNU C library (glibc).  It also generates
5251 position-independent code (PIC) regardless of whether the
5252 @option{-fpic} or @option{-fPIC} options are used.  In other
5253 respects, this target is the same as the
5254 @uref{#xtensa*-*-elf,,@samp{xtensa*-*-elf}} target.
5256 @html
5257 <hr />
5258 @end html
5259 @anchor{windows}
5260 @heading Microsoft Windows
5262 @subheading Intel 16-bit versions
5263 The 16-bit versions of Microsoft Windows, such as Windows 3.1, are not
5264 supported.
5266 However, the 32-bit port has limited support for Microsoft
5267 Windows 3.11 in the Win32s environment, as a target only.  See below.
5269 @subheading Intel 32-bit versions
5270 The 32-bit versions of Windows, including Windows 95, Windows NT, Windows
5271 XP, and Windows Vista, are supported by several different target
5272 platforms.  These targets differ in which Windows subsystem they target
5273 and which C libraries are used.
5275 @itemize
5276 @item Cygwin @uref{#x-x-cygwin,,*-*-cygwin}: Cygwin provides a user-space
5277 Linux API emulation layer in the Win32 subsystem.
5278 @item MinGW @uref{#x-x-mingw32,,*-*-mingw32}: MinGW is a native GCC port for
5279 the Win32 subsystem that provides a subset of POSIX.
5280 @item MKS i386-pc-mks: NuTCracker from MKS.  See
5281 @uref{https://www.mkssoftware.com} for more information.
5282 @end itemize
5284 @subheading Intel 64-bit versions
5285 GCC contains support for x86-64 using the mingw-w64
5286 runtime library, available from @uref{https://www.mingw-w64.org/downloads/}.
5287 This library should be used with the target triple x86_64-pc-mingw32.
5289 @subheading Windows CE
5290 Windows CE is supported as a target only on Hitachi
5291 SuperH (sh-wince-pe), and MIPS (mips-wince-pe).
5293 @subheading Other Windows Platforms
5294 GCC no longer supports Windows NT on the Alpha or PowerPC.
5296 GCC no longer supports the Windows POSIX subsystem.  However, it does
5297 support the Interix subsystem.  See above.
5299 Old target names including *-*-winnt and *-*-windowsnt are no longer used.
5301 UWIN support has been removed due to a lack of maintenance.
5303 @html
5304 <hr />
5305 @end html
5306 @anchor{x-x-cygwin}
5307 @heading *-*-cygwin
5308 Ports of GCC are included with the
5309 @uref{http://www.cygwin.com/,,Cygwin environment}.
5311 GCC will build under Cygwin without modification; it does not build
5312 with Microsoft's C++ compiler and there are no plans to make it do so.
5314 The Cygwin native compiler can be configured to target any 32-bit x86
5315 cpu architecture desired; the default is i686-pc-cygwin.  It should be
5316 used with as up-to-date a version of binutils as possible; use either
5317 the latest official GNU binutils release in the Cygwin distribution,
5318 or version 2.20 or above if building your own.
5320 @html
5321 <hr />
5322 @end html
5323 @anchor{x-x-mingw32}
5324 @heading *-*-mingw32
5325 GCC will build with and support only MinGW runtime 3.12 and later.
5326 Earlier versions of headers are incompatible with the new default semantics
5327 of @code{extern inline} in @code{-std=c99} and @code{-std=gnu99} modes.
5329 To support emitting DWARF debugging info you need to use GNU binutils
5330 version 2.16 or above containing support for the @code{.secrel32}
5331 assembler pseudo-op.
5333 @html
5334 <hr />
5335 @end html
5336 @anchor{older}
5337 @heading Older systems
5338 GCC contains support files for many older (1980s and early
5339 1990s) Unix variants.  For the most part, support for these systems
5340 has not been deliberately removed, but it has not been maintained for
5341 several years and may suffer from bitrot.
5343 Starting with GCC 3.1, each release has a list of ``obsoleted'' systems.
5344 Support for these systems is still present in that release, but
5345 @command{configure} will fail unless the @option{--enable-obsolete}
5346 option is given.  Unless a maintainer steps forward, support for these
5347 systems will be removed from the next release of GCC@.
5349 Support for old systems as hosts for GCC can cause problems if the
5350 workarounds for compiler, library and operating system bugs affect the
5351 cleanliness or maintainability of the rest of GCC@.  In some cases, to
5352 bring GCC up on such a system, if still possible with current GCC, may
5353 require first installing an old version of GCC which did work on that
5354 system, and using it to compile a more recent GCC, to avoid bugs in the
5355 vendor compiler.  Old releases of GCC 1 and GCC 2 are available in the
5356 @file{old-releases} directory on the @uref{../mirrors.html,,GCC mirror
5357 sites}.  Header bugs may generally be avoided using
5358 @command{fixincludes}, but bugs or deficiencies in libraries and the
5359 operating system may still cause problems.
5361 Support for older systems as targets for cross-compilation is less
5362 problematic than support for them as hosts for GCC; if an enthusiast
5363 wishes to make such a target work again (including resurrecting any of
5364 the targets that never worked with GCC 2, starting from the last
5365 version before they were removed), patches
5366 @uref{../contribute.html,,following the usual requirements} would be
5367 likely to be accepted, since they should not affect the support for more
5368 modern targets.
5370 For some systems, old versions of GNU binutils may also be useful,
5371 and are available from @file{pub/binutils/old-releases} on
5372 @uref{https://sourceware.org/mirrors.html,,sourceware.org mirror sites}.
5374 Some of the information on specific systems above relates to
5375 such older systems, but much of the information
5376 about GCC on such systems (which may no longer be applicable to
5377 current GCC) is to be found in the GCC texinfo manual.
5379 @html
5380 <hr />
5381 @end html
5382 @anchor{elf}
5383 @heading all ELF targets (SVR4, Solaris, etc.)
5384 C++ support is significantly better on ELF targets if you use the
5385 @uref{./configure.html#with-gnu-ld,,GNU linker}; duplicate copies of
5386 inlines, vtables and template instantiations will be discarded
5387 automatically.
5390 @html
5391 <hr />
5393 @end html
5394 @ifhtml
5395 @uref{./index.html,,Return to the GCC Installation page}
5396 @end ifhtml
5397 @end ifset
5399 @c ***GFDL********************************************************************
5400 @ifset gfdlhtml
5401 @include fdl.texi
5402 @html
5403 <hr />
5405 @end html
5406 @ifhtml
5407 @uref{./index.html,,Return to the GCC Installation page}
5408 @end ifhtml
5409 @end ifset
5411 @c ***************************************************************************
5412 @c Part 6 The End of the Document
5413 @ifinfo
5414 @comment node-name,     next,          previous, up
5415 @node    Concept Index, , GNU Free Documentation License, Top
5416 @end ifinfo
5418 @ifinfo
5419 @unnumbered Concept Index
5421 @printindex cp
5423 @contents
5424 @end ifinfo
5425 @bye