tree-optimization/112450 - avoid AVX512 style masking for BImode masks
[official-gcc.git] / gcc / doc / install.texi
blob959a0415550b09fb66788804c874823969c0c1ce
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 @end table
482 @heading Tools/packages necessary for modifying GCC
483 @table @asis
484 @item autoconf version 2.69
485 @itemx GNU m4 version 1.4.6 (or later)
487 Necessary when modifying @file{configure.ac}, @file{aclocal.m4}, etc.@:
488 to regenerate @file{configure} and @file{config.in} files.
490 @item automake version 1.15.1
492 Necessary when modifying a @file{Makefile.am} file to regenerate its
493 associated @file{Makefile.in}.
495 Much of GCC does not use automake, so directly edit the @file{Makefile.in}
496 file.  Specifically this applies to the @file{gcc}, @file{intl},
497 @file{libcpp}, @file{libiberty}, @file{libobjc} directories as well
498 as any of their subdirectories.
500 For directories that use automake, GCC requires the latest release in
501 the 1.15 series, which is currently 1.15.1.  When regenerating a directory
502 to a newer version, please update all the directories using an older 1.15
503 to the latest released version.
505 @item gettext version 0.14.5 (or later)
507 Needed to regenerate @file{gcc.pot}.
509 @item gperf version 2.7.2 (or later)
511 Necessary when modifying @command{gperf} input files, e.g.@:
512 @file{gcc/cp/cfns.gperf} to regenerate its associated header file, e.g.@:
513 @file{gcc/cp/cfns.h}.
515 @item DejaGnu version 1.5.3 (or later)
516 @itemx Expect
517 @itemx Tcl
518 @c Once Tcl 8.5 or higher is required, remove any obsolete
519 @c compatibility workarounds:
520 @c     git grep 'compatibility with earlier Tcl releases'
522 Necessary to run the GCC testsuite; see the section on testing for
523 details.
525 @item autogen version 5.5.4 (or later) and
526 @itemx guile version 1.4.1 (or later)
528 Necessary to regenerate @file{fixinc/fixincl.x} from
529 @file{fixinc/inclhack.def} and @file{fixinc/*.tpl}.
531 Necessary to run @samp{make check} for @file{fixinc}.
533 Necessary to regenerate the top level @file{Makefile.in} file from
534 @file{Makefile.tpl} and @file{Makefile.def}.
536 @item Flex version 2.5.4 (or later)
538 Necessary when modifying @file{*.l} files.
540 Necessary to build GCC during development because the generated output
541 files are not included in the version-controlled source repository.
542 They are included in releases.
544 @item Texinfo version 4.7 (or later)
546 Necessary for running @command{makeinfo} when modifying @file{*.texi}
547 files to test your changes.
549 Necessary for running @command{make dvi}, @command{make pdf},
550 or @command{make html} to create formatted documentation.  Texinfo version
551 4.8 or later is required for @command{make pdf}.
553 Necessary to build GCC documentation in info format during development
554 because the generated output files are not included in the repository.
555 (They are included in release tarballs.)
557 Note that the minimum requirement is for a very old version of
558 Texinfo, but recent versions of Texinfo produce better-quality output,
559 especially for HTML format.  The version of Texinfo packaged with any
560 current operating system distribution is likely to be adequate for
561 building the documentation without error, but you may still want to
562 install a newer release to get the best appearance and usability of
563 the generated manuals.
565 @item @TeX{} (any working version)
567 Necessary for running @command{texi2dvi} and @command{texi2pdf}, which
568 are used when running @command{make dvi} or @command{make pdf} to create
569 DVI or PDF files, respectively.
571 @item Sphinx version 1.0 (or later)
573 Necessary to regenerate @file{jit/docs/_build/texinfo} from the @file{.rst}
574 files in the directories below @file{jit/docs}.
576 @item git (any version)
577 @itemx SSH (any version)
579 Necessary to access the source repository.  Public releases and weekly
580 snapshots of the development sources are also available via HTTPS@.
582 @item GNU diffutils version 2.7 (or later)
584 Useful when submitting patches for the GCC source code.
586 @item patch version 2.5.4 (or later)
588 Necessary when applying patches, created with @command{diff}, to one's
589 own sources.
591 @end table
593 @html
594 <hr />
596 @end html
597 @ifhtml
598 @uref{./index.html,,Return to the GCC Installation page}
599 @end ifhtml
600 @end ifset
602 @c ***Downloading the source**************************************************
603 @ifnothtml
604 @comment node-name,     next,          previous, up
605 @node    Downloading the source, Configuration, Prerequisites, Installing GCC
606 @end ifnothtml
607 @ifset downloadhtml
608 @ifnothtml
609 @chapter Downloading GCC
610 @end ifnothtml
611 @cindex Downloading GCC
612 @cindex Downloading the Source
614 GCC is distributed via @uref{https://gcc.gnu.org/git.html,,git} and via
615 HTTPS as tarballs compressed with @command{gzip} or @command{bzip2}.
617 Please refer to the @uref{https://gcc.gnu.org/releases.html,,releases web page}
618 for information on how to obtain GCC@.
620 The source distribution includes the C, C++, Objective-C, Fortran,
621 and Ada (in the case of GCC 3.1 and later) compilers, as well as
622 runtime libraries for C++, Objective-C, and Fortran.
623 For previous versions these were downloadable as separate components such
624 as the core GCC distribution, which included the C language front end and
625 shared components, and language-specific distributions including the
626 language front end and the language runtime (where appropriate).
628 If you also intend to build binutils (either to upgrade an existing
629 installation or for use in place of the corresponding tools of your
630 OS), unpack the binutils distribution either in the same directory or
631 a separate one.  In the latter case, add symbolic links to any
632 components of the binutils you intend to build alongside the compiler
633 (@file{bfd}, @file{binutils}, @file{gas}, @file{gprof}, @file{ld},
634 @file{opcodes}, @dots{}) to the directory containing the GCC sources.
636 Likewise the GMP, MPFR and MPC libraries can be automatically built
637 together with GCC.  You may simply run the
638 @command{contrib/download_prerequisites} script in the GCC source directory
639 to set up everything.
640 Otherwise unpack the GMP, MPFR and/or MPC source
641 distributions in the directory containing the GCC sources and rename
642 their directories to @file{gmp}, @file{mpfr} and @file{mpc},
643 respectively (or use symbolic links with the same name).
645 @html
646 <hr />
648 @end html
649 @ifhtml
650 @uref{./index.html,,Return to the GCC Installation page}
651 @end ifhtml
652 @end ifset
654 @c ***Configuration***********************************************************
655 @ifnothtml
656 @comment node-name,     next,          previous, up
657 @node    Configuration, Building, Downloading the source, Installing GCC
658 @end ifnothtml
659 @ifset configurehtml
660 @ifnothtml
661 @chapter Installing GCC: Configuration
662 @end ifnothtml
663 @cindex Configuration
664 @cindex Installing GCC: Configuration
666 Like most GNU software, GCC must be configured before it can be built.
667 This document describes the recommended configuration procedure
668 for both native and cross targets.
670 We use @var{srcdir} to refer to the toplevel source directory for
671 GCC; we use @var{objdir} to refer to the toplevel build/object directory.
673 If you obtained the sources by cloning the repository, @var{srcdir}
674 must refer to the top @file{gcc} directory, the one where the
675 @file{MAINTAINERS} file can be found, and not its @file{gcc}
676 subdirectory, otherwise the build will fail.
678 If either @var{srcdir} or @var{objdir} is located on an automounted NFS
679 file system, the shell's built-in @command{pwd} command will return
680 temporary pathnames.  Using these can lead to various sorts of build
681 problems.  To avoid this issue, set the @env{PWDCMD} environment
682 variable to an automounter-aware @command{pwd} command, e.g.,
683 @command{pawd} or @samp{amq -w}, during the configuration and build
684 phases.
686 First, we @strong{highly} recommend that GCC be built into a
687 separate directory from the sources which does @strong{not} reside
688 within the source tree.  This is how we generally build GCC; building
689 where @var{srcdir} == @var{objdir} should still work, but doesn't
690 get extensive testing; building where @var{objdir} is a subdirectory
691 of @var{srcdir} is unsupported.
693 If you have previously built GCC in the same directory for a
694 different target machine, do @samp{make distclean} to delete all files
695 that might be invalid.  One of the files this deletes is @file{Makefile};
696 if @samp{make distclean} complains that @file{Makefile} does not exist
697 or issues a message like ``don't know how to make distclean'' it probably
698 means that the directory is already suitably clean.  However, with the
699 recommended method of building in a separate @var{objdir}, you should
700 simply use a different @var{objdir} for each target.
702 Second, when configuring a native system, either @command{cc} or
703 @command{gcc} must be in your path or you must set @env{CC} in
704 your environment before running configure.  Otherwise the configuration
705 scripts may fail.
707 @ignore
708 Note that the bootstrap compiler and the resulting GCC must be link
709 compatible, else the bootstrap will fail with linker errors about
710 incompatible object file formats.  Several multilibed targets are
711 affected by this requirement, see
712 @ifnothtml
713 @ref{Specific, host/target specific installation notes}.
714 @end ifnothtml
715 @ifhtml
716 @uref{specific.html,,host/target specific installation notes}.
717 @end ifhtml
718 @end ignore
720 To configure GCC:
722 @smallexample
723 % mkdir @var{objdir}
724 % cd @var{objdir}
725 % @var{srcdir}/configure [@var{options}] [@var{target}]
726 @end smallexample
728 @heading Distributor options
730 If you will be distributing binary versions of GCC, with modifications
731 to the source code, you should use the options described in this
732 section to make clear that your version contains modifications.
734 @table @code
735 @item --with-pkgversion=@var{version}
736 Specify a string that identifies your package.  You may wish
737 to include a build number or build date.  This version string will be
738 included in the output of @command{gcc --version}.  This suffix does
739 not replace the default version string, only the @samp{GCC} part.
741 The default value is @samp{GCC}.
743 @item --with-bugurl=@var{url}
744 Specify the URL that users should visit if they wish to report a bug.
745 You are of course welcome to forward bugs reported to you to the FSF,
746 if you determine that they are not bugs in your modifications.
748 The default value refers to the FSF's GCC bug tracker.
750 @item --with-documentation-root-url=@var{url}
751 Specify the URL root that contains GCC option documentation.  The @var{url}
752 should end with a @code{/} character.
754 The default value is @uref{https://gcc.gnu.org/onlinedocs/,,https://gcc.gnu.org/onlinedocs/}.
756 @item --with-changes-root-url=@var{url}
757 Specify the URL root that contains information about changes in GCC
758 releases like @code{gcc-@var{version}/changes.html}.
759 The @var{url} should end with a @code{/} character.
761 The default value is @uref{https://gcc.gnu.org/,,https://gcc.gnu.org/}.
763 @end table
765 @heading Host, Build and Target specification
767 Specify the host, build and target machine configurations.  You do this
768 when you run the @file{configure} script.
770 The @dfn{build} machine is the system which you are using, the
771 @dfn{host} machine is the system where you want to run the resulting
772 compiler (normally the build machine), and the @dfn{target} machine is
773 the system for which you want the compiler to generate code.
775 If you are building a compiler to produce code for the machine it runs
776 on (a native compiler), you normally do not need to specify any operands
777 to @file{configure}; it will try to guess the type of machine you are on
778 and use that as the build, host and target machines.  So you don't need
779 to specify a configuration when building a native compiler unless
780 @file{configure} cannot figure out what your configuration is or guesses
781 wrong.
783 In those cases, specify the build machine's @dfn{configuration name}
784 with the @option{--host} option; the host and target will default to be
785 the same as the host machine.
787 Here is an example:
789 @smallexample
790 ./configure --host=x86_64-pc-linux-gnu
791 @end smallexample
793 A configuration name may be canonical or it may be more or less
794 abbreviated (@file{config.sub} script produces canonical versions).
796 A canonical configuration name has three parts, separated by dashes.
797 It looks like this: @samp{@var{cpu}-@var{company}-@var{system}}.
799 Here are the possible CPU types:
801 @quotation
802 aarch64, aarch64_be, alpha, alpha64, amdgcn, arc, arceb, arm, armeb, avr, bfin,
803 bpf, cris, csky, epiphany, fido, fr30, frv, ft32, h8300, hppa, hppa2.0,
804 hppa64, i486, i686, ia64, iq2000, lm32, loongarch64, m32c, m32r, m32rle, m68k,
805 mcore, microblaze, microblazeel, mips, mips64, mips64el, mips64octeon,
806 mips64orion, mips64vr, mipsel, mipsisa32, mipsisa32r2, mipsisa64, mipsisa64r2,
807 mipsisa64r2el, mipsisa64sb1, mipsisa64sr71k, mipstx39, mmix, mn10300, moxie,
808 msp430, nds32be, nds32le, nios2, nvptx, or1k, pdp11, powerpc, powerpc64,
809 powerpc64le, powerpcle, pru, riscv32, riscv32be, riscv64, riscv64be, rl78, rx,
810 s390, s390x, sh, shle, sparc, sparc64, tic6x, v850,
811 v850e, v850e1, vax, visium, x86_64, xstormy16, xtensa
812 @end quotation
814 Here is a list of system types:
816 @quotation
817 aix@var{version}, amdhsa, aout, cygwin, darwin@var{version},
818 eabi, eabialtivec, eabisim, eabisimaltivec, elf, elf32,
819 elfbare, elfoabi, freebsd@var{version}, gnu, hpux, hpux@var{version},
820 kfreebsd-gnu, kopensolaris-gnu, linux-androideabi, linux-gnu,
821 linux-gnu_altivec, linux-musl, linux-uclibc, lynxos, mingw32, mingw32crt,
822 mmixware, msdosdjgpp, netbsd, netbsdelf@var{version}, nto-qnx, openbsd,
823 rtems, solaris@var{version}, symbianelf, tpf, uclinux, uclinux_eabi, vms,
824 vxworks, vxworksae, vxworksmils
825 @end quotation
827 @heading Options specification
829 Use @var{options} to override several configure time options for
830 GCC@.  A list of supported @var{options} follows; @samp{configure
831 --help} may list other options, but those not listed below may not
832 work and should not normally be used.
834 Note that each @option{--enable} option has a corresponding
835 @option{--disable} option and that each @option{--with} option has a
836 corresponding @option{--without} option.
838 @table @code
839 @item --prefix=@var{dirname}
840 Specify the toplevel installation
841 directory.  This is the recommended way to install the tools into a directory
842 other than the default.  The toplevel installation directory defaults to
843 @file{/usr/local}.
845 We @strong{highly} recommend against @var{dirname} being the same or a
846 subdirectory of @var{objdir} or vice versa.  If specifying a directory
847 beneath a user's home directory tree, some shells will not expand
848 @var{dirname} correctly if it contains the @samp{~} metacharacter; use
849 @env{$HOME} instead.
851 The following standard @command{autoconf} options are supported.  Normally you
852 should not need to use these options.
853 @table @code
854 @item --exec-prefix=@var{dirname}
855 Specify the toplevel installation directory for architecture-dependent
856 files.  The default is @file{@var{prefix}}.
858 @item --bindir=@var{dirname}
859 Specify the installation directory for the executables called by users
860 (such as @command{gcc} and @command{g++}).  The default is
861 @file{@var{exec-prefix}/bin}.
863 @item --libdir=@var{dirname}
864 Specify the installation directory for object code libraries and
865 internal data files of GCC@.  The default is @file{@var{exec-prefix}/lib}.
867 @item --libexecdir=@var{dirname}
868 Specify the installation directory for internal executables of GCC@.
869 The default is @file{@var{exec-prefix}/libexec}.
871 @item --with-slibdir=@var{dirname}
872 Specify the installation directory for the shared libgcc library.  The
873 default is @file{@var{libdir}}.
875 @item --datarootdir=@var{dirname}
876 Specify the root of the directory tree for read-only architecture-independent
877 data files referenced by GCC@.  The default is @file{@var{prefix}/share}.
879 @item --infodir=@var{dirname}
880 Specify the installation directory for documentation in info format.
881 The default is @file{@var{datarootdir}/info}.
883 @item --datadir=@var{dirname}
884 Specify the installation directory for some architecture-independent
885 data files referenced by GCC@.  The default is @file{@var{datarootdir}}.
887 @item --docdir=@var{dirname}
888 Specify the installation directory for documentation files (other
889 than Info) for GCC@.  The default is @file{@var{datarootdir}/doc}.
891 @item --htmldir=@var{dirname}
892 Specify the installation directory for HTML documentation files.
893 The default is @file{@var{docdir}}.
895 @item --pdfdir=@var{dirname}
896 Specify the installation directory for PDF documentation files.
897 The default is @file{@var{docdir}}.
899 @item --mandir=@var{dirname}
900 Specify the installation directory for manual pages.  The default is
901 @file{@var{datarootdir}/man}.  (Note that the manual pages are only extracts
902 from the full GCC manuals, which are provided in Texinfo format.  The manpages
903 are derived by an automatic conversion process from parts of the full
904 manual.)
906 @item --with-gxx-include-dir=@var{dirname}
907 Specify
908 the installation directory for G++ header files.  The default depends
909 on other configuration options, and differs between cross and native
910 configurations.
912 @item --with-specs=@var{specs}
913 Specify additional command line driver SPECS.
914 This can be useful if you need to turn on a non-standard feature by
915 default without modifying the compiler's source code, for instance
916 @option{--with-specs=%@{!fcommon:%@{!fno-common:-fno-common@}@}}.
917 @ifnothtml
918 @xref{Spec Files,, Specifying subprocesses and the switches to pass to them,
919 gcc, Using the GNU Compiler Collection (GCC)},
920 @end ifnothtml
921 @ifhtml
922 See ``Spec Files'' in the main manual
923 @end ifhtml
925 @end table
927 @item --program-prefix=@var{prefix}
928 GCC supports some transformations of the names of its programs when
929 installing them.  This option prepends @var{prefix} to the names of
930 programs to install in @var{bindir} (see above).  For example, specifying
931 @option{--program-prefix=foo-} would result in @samp{gcc}
932 being installed as @file{/usr/local/bin/foo-gcc}.
934 @item --program-suffix=@var{suffix}
935 Appends @var{suffix} to the names of programs to install in @var{bindir}
936 (see above).  For example, specifying @option{--program-suffix=-3.1}
937 would result in @samp{gcc} being installed as
938 @file{/usr/local/bin/gcc-3.1}.
940 @item --program-transform-name=@var{pattern}
941 Applies the @samp{sed} script @var{pattern} to be applied to the names
942 of programs to install in @var{bindir} (see above).  @var{pattern} has to
943 consist of one or more basic @samp{sed} editing commands, separated by
944 semicolons.  For example, if you want the @samp{gcc} program name to be
945 transformed to the installed program @file{/usr/local/bin/myowngcc} and
946 the @samp{g++} program name to be transformed to
947 @file{/usr/local/bin/gspecial++} without changing other program names,
948 you could use the pattern
949 @option{--program-transform-name='s/^gcc$/myowngcc/; s/^g++$/gspecial++/'}
950 to achieve this effect.
952 All three options can be combined and used together, resulting in more
953 complex conversion patterns.  As a basic rule, @var{prefix} (and
954 @var{suffix}) are prepended (appended) before further transformations
955 can happen with a special transformation script @var{pattern}.
957 As currently implemented, this option only takes effect for native
958 builds; cross compiler binaries' names are not transformed even when a
959 transformation is explicitly asked for by one of these options.
961 For native builds, some of the installed programs are also installed
962 with the target alias in front of their name, as in
963 @samp{i686-pc-linux-gnu-gcc}.  All of the above transformations happen
964 before the target alias is prepended to the name---so, specifying
965 @option{--program-prefix=foo-} and @option{program-suffix=-3.1}, the
966 resulting binary would be installed as
967 @file{/usr/local/bin/i686-pc-linux-gnu-foo-gcc-3.1}.
969 As a last shortcoming, none of the installed Ada programs are
970 transformed yet, which will be fixed in some time.
972 @item --with-local-prefix=@var{dirname}
973 Specify the
974 installation directory for local include files.  The default is
975 @file{/usr/local}.  Specify this option if you want the compiler to
976 search directory @file{@var{dirname}/include} for locally installed
977 header files @emph{instead} of @file{/usr/local/include}.
979 You should specify @option{--with-local-prefix} @strong{only} if your
980 site has a different convention (not @file{/usr/local}) for where to put
981 site-specific files.
983 The default value for @option{--with-local-prefix} is @file{/usr/local}
984 regardless of the value of @option{--prefix}.  Specifying
985 @option{--prefix} has no effect on which directory GCC searches for
986 local header files.  This may seem counterintuitive, but actually it is
987 logical.
989 The purpose of @option{--prefix} is to specify where to @emph{install
990 GCC}.  The local header files in @file{/usr/local/include}---if you put
991 any in that directory---are not part of GCC@.  They are part of other
992 programs---perhaps many others.  (GCC installs its own header files in
993 another directory which is based on the @option{--prefix} value.)
995 Both the local-prefix include directory and the GCC-prefix include
996 directory are part of GCC's ``system include'' directories.  Although these
997 two directories are not fixed, they need to be searched in the proper
998 order for the correct processing of the include_next directive.  The
999 local-prefix include directory is searched before the GCC-prefix
1000 include directory.  Another characteristic of system include directories
1001 is that pedantic warnings are turned off for headers in these directories.
1003 Some autoconf macros add @option{-I @var{directory}} options to the
1004 compiler command line, to ensure that directories containing installed
1005 packages' headers are searched.  When @var{directory} is one of GCC's
1006 system include directories, GCC will ignore the option so that system
1007 directories continue to be processed in the correct order.  This
1008 may result in a search order different from what was specified but the
1009 directory will still be searched.
1011 GCC automatically searches for ordinary libraries using
1012 @env{GCC_EXEC_PREFIX}.  Thus, when the same installation prefix is
1013 used for both GCC and packages, GCC will automatically search for
1014 both headers and libraries.  This provides a configuration that is
1015 easy to use.  GCC behaves in a manner similar to that when it is
1016 installed as a system compiler in @file{/usr}.
1018 Sites that need to install multiple versions of GCC may not want to
1019 use the above simple configuration.  It is possible to use the
1020 @option{--program-prefix}, @option{--program-suffix} and
1021 @option{--program-transform-name} options to install multiple versions
1022 into a single directory, but it may be simpler to use different prefixes
1023 and the @option{--with-local-prefix} option to specify the location of the
1024 site-specific files for each version.  It will then be necessary for
1025 users to specify explicitly the location of local site libraries
1026 (e.g., with @env{LIBRARY_PATH}).
1028 The same value can be used for both @option{--with-local-prefix} and
1029 @option{--prefix} provided it is not @file{/usr}.  This can be used
1030 to avoid the default search of @file{/usr/local/include}.
1032 @strong{Do not} specify @file{/usr} as the @option{--with-local-prefix}!
1033 The directory you use for @option{--with-local-prefix} @strong{must not}
1034 contain any of the system's standard header files.  If it did contain
1035 them, certain programs would be miscompiled (including GNU Emacs, on
1036 certain targets), because this would override and nullify the header
1037 file corrections made by the @command{fixincludes} script.
1039 Indications are that people who use this option use it based on mistaken
1040 ideas of what it is for.  People use it as if it specified where to
1041 install part of GCC@.  Perhaps they make this assumption because
1042 installing GCC creates the directory.
1044 @item --with-gcc-major-version-only
1045 Specifies that GCC should use only the major number rather than
1046 @var{major}.@var{minor}.@var{patchlevel} in filesystem paths.
1048 @item --with-native-system-header-dir=@var{dirname}
1049 Specifies that @var{dirname} is the directory that contains native system
1050 header files, rather than @file{/usr/include}.  This option is most useful
1051 if you are creating a compiler that should be isolated from the system
1052 as much as possible.  It is most commonly used with the
1053 @option{--with-sysroot} option and will cause GCC to search
1054 @var{dirname} inside the system root specified by that option.
1056 @item --enable-shared[=@var{package}[,@dots{}]]
1057 Build shared versions of libraries, if shared libraries are supported on
1058 the target platform.  Unlike GCC 2.95.x and earlier, shared libraries
1059 are enabled by default on all platforms that support shared libraries.
1061 If a list of packages is given as an argument, build shared libraries
1062 only for the listed packages.  For other packages, only static libraries
1063 will be built.  Package names currently recognized in the GCC tree are
1064 @samp{libgcc} (also known as @samp{gcc}), @samp{libstdc++} (not
1065 @samp{libstdc++-v3}), @samp{libffi}, @samp{zlib}, @samp{boehm-gc},
1066 @samp{ada}, @samp{libada}, @samp{libgo}, @samp{libobjc}, and @samp{libphobos}.
1067 Note @samp{libiberty} does not support shared libraries at all.
1069 Use @option{--disable-shared} to build only static libraries.  Note that
1070 @option{--disable-shared} does not accept a list of package names as
1071 argument, only @option{--enable-shared} does.
1073 Contrast with @option{--enable-host-shared}, which affects @emph{host}
1074 code.
1076 @item --enable-host-shared
1077 Specify that the @emph{host} code should be built into position-independent
1078 machine code (with @option{-fPIC}), allowing it to be used within shared
1079 libraries, but yielding a slightly slower compiler.
1081 This option is required when building the libgccjit.so library.
1083 Contrast with @option{--enable-shared}, which affects @emph{target}
1084 libraries.
1086 @item --enable-host-pie
1087 Specify that the @emph{host} executables should be built into
1088 position-independent executables (with @option{-fPIE} and @option{-pie}),
1089 yielding a slightly slower compiler (but faster than
1090 @option{--enable-host-shared}).  Position-independent executables are loaded
1091 at random addresses each time they are executed, therefore provide additional
1092 protection against Return Oriented Programming (ROP) attacks.
1094 @option{--enable-host-pie}) may be used with @option{--enable-host-shared}),
1095 in which case @option{-fPIC} is used when compiling, and @option{-pie} when
1096 linking.
1098 @item --enable-host-bind-now
1099 Specify that the @emph{host} executables should be linked with the option
1100 @option{-Wl,-z,now}, which means that the dynamic linker will resolve all
1101 symbols when the executables are started, and that in turn allows RELRO to
1102 mark the GOT read-only, resulting in better security.
1104 @item @anchor{with-gnu-as}--with-gnu-as
1105 Specify that the compiler should assume that the
1106 assembler it finds is the GNU assembler.  However, this does not modify
1107 the rules to find an assembler and will result in confusion if the
1108 assembler found is not actually the GNU assembler.  (Confusion may also
1109 result if the compiler finds the GNU assembler but has not been
1110 configured with @option{--with-gnu-as}.)  If you have more than one
1111 assembler installed on your system, you may want to use this option in
1112 connection with @option{--with-as=@var{pathname}} or
1113 @option{--with-build-time-tools=@var{pathname}}.
1115 The following systems are the only ones where it makes a difference
1116 whether you use the GNU assembler.  On any other system,
1117 @option{--with-gnu-as} has no effect.
1119 @itemize @bullet
1120 @item @samp{hppa1.0-@var{any}-@var{any}}
1121 @item @samp{hppa1.1-@var{any}-@var{any}}
1122 @item @samp{*-*-solaris2.11}
1123 @end itemize
1125 @item @anchor{with-as}--with-as=@var{pathname}
1126 Specify that the compiler should use the assembler pointed to by
1127 @var{pathname}, rather than the one found by the standard rules to find
1128 an assembler, which are:
1129 @itemize @bullet
1130 @item
1131 Unless GCC is being built with a cross compiler, check the
1132 @file{@var{libexec}/gcc/@var{target}/@var{version}} directory.
1133 @var{libexec} defaults to @file{@var{exec-prefix}/libexec};
1134 @var{exec-prefix} defaults to @var{prefix}, which
1135 defaults to @file{/usr/local} unless overridden by the
1136 @option{--prefix=@var{pathname}} switch described above.  @var{target}
1137 is the target system triple, such as @samp{sparc-sun-solaris2.11}, and
1138 @var{version} denotes the GCC version, such as 3.0.
1140 @item
1141 If the target system is the same that you are building on, check
1142 operating system specific directories.
1144 @item
1145 Check in the @env{PATH} for a tool whose name is prefixed by the
1146 target system triple.
1148 @item
1149 Check in the @env{PATH} for a tool whose name is not prefixed by the
1150 target system triple, if the host and target system triple are
1151 the same (in other words, we use a host tool if it can be used for
1152 the target as well).
1153 @end itemize
1155 You may want to use @option{--with-as} if no assembler
1156 is installed in the directories listed above, or if you have multiple
1157 assemblers installed and want to choose one that is not found by the
1158 above rules.
1160 @item @anchor{with-gnu-ld}--with-gnu-ld
1161 Same as @uref{#with-gnu-as,,@option{--with-gnu-as}}
1162 but for the linker.
1164 @item --with-ld=@var{pathname}
1165 Same as @uref{#with-as,,@option{--with-as}}
1166 but for the linker.
1168 @item --with-dsymutil=@var{pathname}
1169 Same as @uref{#with-as,,@option{--with-as}}
1170 but for the debug linker (only used on Darwin platforms so far).
1172 @item --with-tls=@var{dialect}
1173 Specify the default TLS dialect, for systems were there is a choice.
1174 For ARM targets, possible values for @var{dialect} are @code{gnu} or
1175 @code{gnu2}, which select between the original GNU dialect and the GNU TLS
1176 descriptor-based dialect.
1178 @item --enable-multiarch
1179 Specify whether to enable or disable multiarch support.  The default is
1180 to check for glibc start files in a multiarch location, and enable it
1181 if the files are found.  The auto detection is enabled for native builds,
1182 and for cross builds configured with @option{--with-sysroot}, and without
1183 @option{--with-native-system-header-dir}.
1184 More documentation about multiarch can be found at
1185 @uref{https://wiki.debian.org/Multiarch}.
1187 @item --enable-sjlj-exceptions
1188 Force use of the @code{setjmp}/@code{longjmp}-based scheme for exceptions.
1189 @samp{configure} ordinarily picks the correct value based on the platform.
1190 Only use this option if you are sure you need a different setting.
1192 @item --enable-vtable-verify
1193 Specify whether to enable or disable the vtable verification feature.
1194 Enabling this feature causes libstdc++ to be built with its virtual calls
1195 in verifiable mode.  This means that, when linked with libvtv, every
1196 virtual call in libstdc++ will verify the vtable pointer through which the
1197 call will be made before actually making the call.  If not linked with libvtv,
1198 the verifier will call stub functions (in libstdc++ itself) and do nothing.
1199 If vtable verification is disabled, then libstdc++ is not built with its
1200 virtual calls in verifiable mode at all.  However the libvtv library will
1201 still be built (see @option{--disable-libvtv} to turn off building libvtv).
1202 @option{--disable-vtable-verify} is the default.
1204 @item --disable-gcov
1205 Specify that the run-time library used for coverage analysis
1206 and associated host tools should not be built.
1208 @item --disable-multilib
1209 Specify that multiple target
1210 libraries to support different target variants, calling
1211 conventions, etc.@: should not be built.  The default is to build a
1212 predefined set of them.
1214 Some targets provide finer-grained control over which multilibs are built
1215 (e.g., @option{--disable-softfloat}):
1216 @table @code
1217 @item arm-*-*
1218 fpu, 26bit, underscore, interwork, biendian, nofmult.
1220 @item m68*-*-*
1221 softfloat, m68881, m68000, m68020.
1223 @item mips*-*-*
1224 single-float, biendian, softfloat.
1226 @item msp430-*-*
1227 no-exceptions
1229 @item powerpc*-*-*, rs6000*-*-*
1230 aix64, pthread, softfloat, powercpu, powerpccpu, powerpcos, biendian,
1231 sysv, aix.
1233 @end table
1235 @item --with-multilib-list=@var{list}
1236 @itemx --without-multilib-list
1237 Specify what multilibs to build.  @var{list} is a comma separated list of
1238 values, possibly consisting of a single value.  Currently only implemented
1239 for aarch64*-*-*, amdgcn*-*-*, arm*-*-*, loongarch*-*-*, riscv*-*-*, sh*-*-*
1240 and x86-64-*-linux*.  The accepted values and meaning for each target is given
1241 below.
1243 @table @code
1244 @item aarch64*-*-*
1245 @var{list} is a comma separated list of @code{ilp32}, and @code{lp64}
1246 to enable ILP32 and LP64 run-time libraries, respectively.  If
1247 @var{list} is empty, then there will be no multilibs and only the
1248 default run-time library will be built.  If @var{list} is
1249 @code{default} or --with-multilib-list= is not specified, then the
1250 default set of libraries is selected based on the value of
1251 @option{--target}.
1253 @item amdgcn*-*-*
1254 @var{list} is a comma separated list of ISA names (allowed values: @code{fiji},
1255 @code{gfx900}, @code{gfx906}, @code{gfx908}, @code{gfx90a}). It ought not
1256 include the name of the default ISA, specified via @option{--with-arch}.  If
1257 @var{list} is empty, then there will be no multilibs and only the default
1258 run-time library will be built.  If @var{list} is @code{default} or
1259 @option{--with-multilib-list=} is not specified, then the default set of
1260 libraries is selected.
1262 @item arm*-*-*
1263 @var{list} is a comma separated list of @code{aprofile} and
1264 @code{rmprofile} to build multilibs for A or R and M architecture
1265 profiles respectively.  Note that, due to some limitation of the current
1266 multilib framework, using the combined @code{aprofile,rmprofile}
1267 multilibs selects in some cases a less optimal multilib than when using
1268 the multilib profile for the architecture targetted.  The special value
1269 @code{default} is also accepted and is equivalent to omitting the
1270 option, i.e., only the default run-time library will be enabled.
1272 @var{list} may instead contain @code{@@name}, to use the multilib
1273 configuration Makefile fragment @file{name} in @file{gcc/config/arm} in
1274 the source tree (it is part of the corresponding sources, after all).
1275 It is recommended, but not required, that files used for this purpose to
1276 be named starting with @file{t-ml-}, to make their intended purpose
1277 self-evident, in line with GCC conventions.  Such files enable custom,
1278 user-chosen multilib lists to be configured.  Whether multiple such
1279 files can be used together depends on the contents of the supplied
1280 files.  See @file{gcc/config/arm/t-multilib} and its supplementary
1281 @file{gcc/config/arm/t-*profile} files for an example of what such
1282 Makefile fragments might look like for this version of GCC.  The macros
1283 expected to be defined in these fragments are not stable across GCC
1284 releases, so make sure they define the @code{MULTILIB}-related macros
1285 expected by the version of GCC you are building.
1286 @ifnothtml
1287 @xref{Target Fragment,, Target Makefile Fragments, gccint, GNU Compiler
1288 Collection (GCC) Internals}.
1289 @end ifnothtml
1290 @ifhtml
1291 See ``Target Makefile Fragments'' in the internals manual.
1292 @end ifhtml
1294 The table below gives the combination of ISAs, architectures, FPUs and
1295 floating-point ABIs for which multilibs are built for each predefined
1296 profile.  The union of these options is considered when specifying both
1297 @code{aprofile} and @code{rmprofile}.
1299 @multitable @columnfractions .15 .28 .30
1300 @item Option @tab aprofile @tab rmprofile
1301 @item ISAs
1302 @tab @code{-marm} and @code{-mthumb}
1303 @tab @code{-mthumb}
1304 @item Architectures@*@*@*@*@*@*
1305 @tab default architecture@*
1306 @code{-march=armv7-a}@*
1307 @code{-march=armv7ve}@*
1308 @code{-march=armv8-a}@*@*@*
1309 @tab default architecture@*
1310 @code{-march=armv6s-m}@*
1311 @code{-march=armv7-m}@*
1312 @code{-march=armv7e-m}@*
1313 @code{-march=armv8-m.base}@*
1314 @code{-march=armv8-m.main}@*
1315 @code{-march=armv7}
1316 @item FPUs@*@*@*@*@*
1317 @tab none@*
1318 @code{-mfpu=vfpv3-d16}@*
1319 @code{-mfpu=neon}@*
1320 @code{-mfpu=vfpv4-d16}@*
1321 @code{-mfpu=neon-vfpv4}@*
1322 @code{-mfpu=neon-fp-armv8}
1323 @tab none@*
1324 @code{-mfpu=vfpv3-d16}@*
1325 @code{-mfpu=fpv4-sp-d16}@*
1326 @code{-mfpu=fpv5-sp-d16}@*
1327 @code{-mfpu=fpv5-d16}@*
1328 @item floating-point@/ ABIs@*@*
1329 @tab @code{-mfloat-abi=soft}@*
1330 @code{-mfloat-abi=softfp}@*
1331 @code{-mfloat-abi=hard}
1332 @tab @code{-mfloat-abi=soft}@*
1333 @code{-mfloat-abi=softfp}@*
1334 @code{-mfloat-abi=hard}
1335 @end multitable
1337 @item loongarch*-*-*
1338 @var{list} is a comma-separated list, with each of the element starting with
1339 the following ABI identifiers: @code{lp64d[/base]} @code{lp64f[/base]}
1340 @code{lp64d[/base]} (the @code{/base} suffix may be omitted)
1341 to enable their respective run-time libraries.
1343 A suffix @code{[/@var{arch}][/@var{option}/@dots{}]} may follow immediately
1344 after the ABI identifier to customize the compiler options for building the
1345 given set of libraries.  @var{arch} denotes the architecture name recognized
1346 by the @option{-march=@var{arch}} compiler option, which acts as a basic target
1347 ISA configuration that can be adjusted using the subsequent @var{option}
1348 suffixes, where each @var{option} is a compiler option without a leading dash
1349 ('-').
1351 If no such suffix is present for a given multilib variant, the
1352 configured value of @option{--with-multilib-default} is appended as a default
1353 suffix.  If @option{--with-multilib-default} is not given, the default build
1354 option @option{-march=abi-default} is applied when building the variants
1355 without a suffix.
1357 As a special case, @code{fixed} may be used in the position of @var{arch},
1358 which means using the architecture configured with
1359 @option{--with-arch=@var{arch}}, or its default value (e.g. @code{loongarch64}
1360 for @code{loongarch64-*} targets).
1362 If @var{list} is empty or @code{default}, or if @option{--with-multilib-list}
1363 is not specified, then only the default variant of the libraries are built,
1364 where the default ABI is implied by the configured target triplet.
1366 @item riscv*-*-*
1367 @var{list} is a single ABI name.  The target architecture must be either
1368 @code{rv32gc} or @code{rv64gc}.  This will build a single multilib for the
1369 specified architecture and ABI pair.  If @code{--with-multilib-list} is not
1370 given, then a default set of multilibs is selected based on the value of
1371 @option{--target}.  This is usually a large set of multilibs.
1373 @item sh*-*-*
1374 @var{list} is a comma separated list of CPU names.  These must be of the
1375 form @code{sh*} or @code{m*} (in which case they match the compiler option
1376 for that processor).  The list should not contain any endian options -
1377 these are handled by @option{--with-endian}.
1379 If @var{list} is empty, then there will be no multilibs for extra
1380 processors.  The multilib for the secondary endian remains enabled.
1382 As a special case, if an entry in the list starts with a @code{!}
1383 (exclamation point), then it is added to the list of excluded multilibs.
1384 Entries of this sort should be compatible with @samp{MULTILIB_EXCLUDES}
1385 (once the leading @code{!} has been stripped).
1387 If @option{--with-multilib-list} is not given, then a default set of
1388 multilibs is selected based on the value of @option{--target}.  This is
1389 usually the complete set of libraries, but some targets imply a more
1390 specialized subset.
1392 Example 1: to configure a compiler for SH4A only, but supporting both
1393 endians, with little endian being the default:
1394 @smallexample
1395 --with-cpu=sh4a --with-endian=little,big --with-multilib-list=
1396 @end smallexample
1398 Example 2: to configure a compiler for both SH4A and SH4AL-DSP, but with
1399 only little endian SH4AL:
1400 @smallexample
1401 --with-cpu=sh4a --with-endian=little,big \
1402 --with-multilib-list=sh4al,!mb/m4al
1403 @end smallexample
1405 @item x86-64-*-linux*
1406 @var{list} is a comma separated list of @code{m32}, @code{m64} and
1407 @code{mx32} to enable 32-bit, 64-bit and x32 run-time libraries,
1408 respectively.  If @var{list} is empty, then there will be no multilibs
1409 and only the default run-time library will be enabled.
1411 If @option{--with-multilib-list} is not given, then only 32-bit and
1412 64-bit run-time libraries will be enabled.
1413 @end table
1415 @item --with-multilib-default
1416 On LoongArch targets, set the default build options for enabled multilibs
1417 without build options appended to their corresponding
1418 @option{--with-multilib-list} items.  The format of this value is
1419 @code{[/@var{arch}][/@var{option}/@dots{}]}, where @var{arch} is an
1420 architecture name recognized by @option{-march=@var{arch}} compiler option,
1421 and subsequent @var{option} suffixes are compiler options minus a leading
1422 dash ('-').
1424 Multiple @var{option}s may appear consecutively while @var{arch} may only
1425 appear in the beginning or be omitted (which means @option{-march=abi-default}
1426 is applied when building the libraries).
1428 @item --with-strict-align-lib
1429 On LoongArch targets, build all enabled multilibs with @option{-mstrict-align}
1430 (Not enabled by default).
1432 @item --with-multilib-generator=@var{config}
1433 Specify what multilibs to build.  @var{config} is a semicolon separated list of
1434 values, possibly consisting of a single value.  Currently only implemented
1435 for riscv*-*-elf*.  The accepted values and meanings are given below.
1438 Every config is constructed with four components: architecture string, ABI,
1439 reuse rule with architecture string and reuse rule with sub-extension.
1441 Example 1: Add multi-lib suppport for rv32i with ilp32.
1442 @smallexample
1443 rv32i-ilp32--
1444 @end smallexample
1446 Example 2: Add multi-lib suppport for rv32i with ilp32 and rv32imafd with ilp32.
1447 @smallexample
1448 rv32i-ilp32--;rv32imafd-ilp32--
1449 @end smallexample
1451 Example 3: Add multi-lib suppport for rv32i with ilp32; rv32im with ilp32 and
1452 rv32ic with ilp32 will reuse this multi-lib set.
1453 @smallexample
1454 rv32i-ilp32-rv32im-c
1455 @end smallexample
1457 Example 4: Add multi-lib suppport for rv64ima with lp64; rv64imaf with lp64,
1458 rv64imac with lp64 and rv64imafc with lp64 will reuse this multi-lib set.
1459 @smallexample
1460 rv64ima-lp64--f,c,fc
1461 @end smallexample
1463 @option{--with-multilib-generator} have an optional configuration argument
1464 @option{--cmodel=val} for code model, this option will expand with other
1465 config options, @var{val} is a comma separated list of possible code model,
1466 currently we support medlow and medany.
1468 Example 5: Add multi-lib suppport for rv64ima with lp64; rv64ima with lp64 and
1469 medlow code model
1470 @smallexample
1471 rv64ima-lp64--;--cmodel=medlow
1472 @end smallexample
1474 Example 6: Add multi-lib suppport for rv64ima with lp64; rv64ima with lp64 and
1475 medlow code model; rv64ima with lp64 and medany code model
1476 @smallexample
1477 rv64ima-lp64--;--cmodel=medlow,medany
1478 @end smallexample
1480 @item --with-endian=@var{endians}
1481 Specify what endians to use.
1482 Currently only implemented for sh*-*-*.
1484 @var{endians} may be one of the following:
1485 @table @code
1486 @item big
1487 Use big endian exclusively.
1488 @item little
1489 Use little endian exclusively.
1490 @item big,little
1491 Use big endian by default.  Provide a multilib for little endian.
1492 @item little,big
1493 Use little endian by default.  Provide a multilib for big endian.
1494 @end table
1496 @item --enable-threads
1497 Specify that the target
1498 supports threads.  This affects the Objective-C compiler and runtime
1499 library, and exception handling for other languages like C++.
1500 On some systems, this is the default.
1502 In general, the best (and, in many cases, the only known) threading
1503 model available will be configured for use.  Beware that on some
1504 systems, GCC has not been taught what threading models are generally
1505 available for the system.  In this case, @option{--enable-threads} is an
1506 alias for @option{--enable-threads=single}.
1508 @item --disable-threads
1509 Specify that threading support should be disabled for the system.
1510 This is an alias for @option{--enable-threads=single}.
1512 @item --enable-threads=@var{lib}
1513 Specify that
1514 @var{lib} is the thread support library.  This affects the Objective-C
1515 compiler and runtime library, and exception handling for other languages
1516 like C++.  The possibilities for @var{lib} are:
1518 @table @code
1519 @item aix
1520 AIX thread support.
1521 @item dce
1522 DCE thread support.
1523 @item lynx
1524 LynxOS thread support.
1525 @item mipssde
1526 MIPS SDE thread support.
1527 @item no
1528 This is an alias for @samp{single}.
1529 @item posix
1530 Generic POSIX/Unix98 thread support.
1531 @item rtems
1532 RTEMS thread support.
1533 @item single
1534 Disable thread support, should work for all platforms.
1535 @item tpf
1536 TPF thread support.
1537 @item vxworks
1538 VxWorks thread support.
1539 @item win32
1540 Microsoft Win32 API thread support.
1541 @end table
1543 @item --enable-tls
1544 Specify that the target supports TLS (Thread Local Storage).  Usually
1545 configure can correctly determine if TLS is supported.  In cases where
1546 it guesses incorrectly, TLS can be explicitly enabled or disabled with
1547 @option{--enable-tls} or @option{--disable-tls}.  This can happen if
1548 the assembler supports TLS but the C library does not, or if the
1549 assumptions made by the configure test are incorrect.
1551 @item --disable-tls
1552 Specify that the target does not support TLS.
1553 This is an alias for @option{--enable-tls=no}.
1555 @item --disable-tm-clone-registry
1556 Disable TM clone registry in libgcc. It is enabled in libgcc by default.
1557 This option helps to reduce code size for embedded targets which do
1558 not use transactional memory.
1560 @item --with-cpu=@var{cpu}
1561 @itemx --with-cpu-32=@var{cpu}
1562 @itemx --with-cpu-64=@var{cpu}
1563 Specify which cpu variant the compiler should generate code for by default.
1564 @var{cpu} will be used as the default value of the @option{-mcpu=} switch.
1565 This option is only supported on some targets, including ARC, ARM, i386, M68k,
1566 PowerPC, and SPARC@.  It is mandatory for ARC@.  The @option{--with-cpu-32} and
1567 @option{--with-cpu-64} options specify separate default CPUs for
1568 32-bit and 64-bit modes; these options are only supported for aarch64, i386,
1569 x86-64, PowerPC, and SPARC@.
1571 @item --with-schedule=@var{cpu}
1572 @itemx --with-arch=@var{cpu}
1573 @itemx --with-arch-32=@var{cpu}
1574 @itemx --with-arch-64=@var{cpu}
1575 @itemx --with-tune=@var{cpu}
1576 @itemx --with-tune-32=@var{cpu}
1577 @itemx --with-tune-64=@var{cpu}
1578 @itemx --with-abi=@var{abi}
1579 @itemx --with-fpu=@var{type}
1580 @itemx --with-float=@var{type}
1581 @itemx --with-simd=@var{type}
1582 These configure options provide default values for the @option{-mschedule=},
1583 @option{-march=}, @option{-mtune=}, @option{-mabi=}, and @option{-mfpu=}
1584 options and for @option{-mhard-float} or @option{-msoft-float}.  As with
1585 @option{--with-cpu}, which switches will be accepted and acceptable values
1586 of the arguments depend on the target.
1588 @item --with-mode=@var{mode}
1589 Specify if the compiler should default to @option{-marm} or @option{-mthumb}.
1590 This option is only supported on ARM targets.
1592 @item --with-stack-offset=@var{num}
1593 This option sets the default for the -mstack-offset=@var{num} option,
1594 and will thus generally also control the setting of this option for
1595 libraries.  This option is only supported on Epiphany targets.
1597 @item --with-fpmath=@var{isa}
1598 This options sets @option{-mfpmath=sse} by default and specifies the default
1599 ISA for floating-point arithmetics.  You can select either @samp{sse} which
1600 enables @option{-msse2} or @samp{avx} which enables @option{-mavx} by default.
1601 This option is only supported on i386 and x86-64 targets.
1603 @item --with-fp-32=@var{mode}
1604 On MIPS targets, set the default value for the @option{-mfp} option when using
1605 the o32 ABI.  The possibilities for @var{mode} are:
1606 @table @code
1607 @item 32
1608 Use the o32 FP32 ABI extension, as with the @option{-mfp32} command-line
1609 option.
1610 @item xx
1611 Use the o32 FPXX ABI extension, as with the @option{-mfpxx} command-line
1612 option.
1613 @item 64
1614 Use the o32 FP64 ABI extension, as with the @option{-mfp64} command-line
1615 option.
1616 @end table
1617 In the absence of this configuration option the default is to use the o32
1618 FP32 ABI extension.
1620 @item --with-odd-spreg-32
1621 On MIPS targets, set the @option{-modd-spreg} option by default when using
1622 the o32 ABI.
1624 @item --without-odd-spreg-32
1625 On MIPS targets, set the @option{-mno-odd-spreg} option by default when using
1626 the o32 ABI.  This is normally used in conjunction with
1627 @option{--with-fp-32=64} in order to target the o32 FP64A ABI extension.
1629 @item --with-nan=@var{encoding}
1630 On MIPS targets, set the default encoding convention to use for the
1631 special not-a-number (NaN) IEEE 754 floating-point data.  The
1632 possibilities for @var{encoding} are:
1633 @table @code
1634 @item legacy
1635 Use the legacy encoding, as with the @option{-mnan=legacy} command-line
1636 option.
1637 @item 2008
1638 Use the 754-2008 encoding, as with the @option{-mnan=2008} command-line
1639 option.
1640 @end table
1641 To use this configuration option you must have an assembler version
1642 installed that supports the @option{-mnan=} command-line option too.
1643 In the absence of this configuration option the default convention is
1644 the legacy encoding, as when neither of the @option{-mnan=2008} and
1645 @option{-mnan=legacy} command-line options has been used.
1647 @item --with-divide=@var{type}
1648 Specify how the compiler should generate code for checking for
1649 division by zero.  This option is only supported on the MIPS target.
1650 The possibilities for @var{type} are:
1651 @table @code
1652 @item traps
1653 Division by zero checks use conditional traps (this is the default on
1654 systems that support conditional traps).
1655 @item breaks
1656 Division by zero checks use the break instruction.
1657 @end table
1659 @item --with-compact-branches=@var{policy}
1660 Specify how the compiler should generate branch instructions.
1661 This option is only supported on the MIPS target.
1662 The possibilities for @var{type} are:
1663 @table @code
1664 @item optimal
1665 Cause a delay slot branch to be used if one is available in the
1666 current ISA and the delay slot is successfully filled. If the delay slot
1667 is not filled, a compact branch will be chosen if one is available.
1668 @item never
1669 Ensures that compact branch instructions will never be generated.
1670 @item always
1671 Ensures that a compact branch instruction will be generated if available.
1672 If a compact branch instruction is not available,
1673 a delay slot form of the branch will be used instead.
1674 This option is supported from MIPS Release 6 onwards.
1675 For pre-R6/microMIPS/MIPS16, this option is just same as never/optimal.
1676 @end table
1678 @c If you make --with-llsc the default for additional targets,
1679 @c update the --with-llsc description in the MIPS section below.
1681 @item --with-llsc
1682 On MIPS targets, make @option{-mllsc} the default when no
1683 @option{-mno-llsc} option is passed.  This is the default for
1684 Linux-based targets, as the kernel will emulate them if the ISA does
1685 not provide them.
1687 @item --without-llsc
1688 On MIPS targets, make @option{-mno-llsc} the default when no
1689 @option{-mllsc} option is passed.
1691 @item --with-synci
1692 On MIPS targets, make @option{-msynci} the default when no
1693 @option{-mno-synci} option is passed.
1695 @item --without-synci
1696 On MIPS targets, make @option{-mno-synci} the default when no
1697 @option{-msynci} option is passed.  This is the default.
1699 @item --with-lxc1-sxc1
1700 On MIPS targets, make @option{-mlxc1-sxc1} the default when no
1701 @option{-mno-lxc1-sxc1} option is passed.  This is the default.
1703 @item --without-lxc1-sxc1
1704 On MIPS targets, make @option{-mno-lxc1-sxc1} the default when no
1705 @option{-mlxc1-sxc1} option is passed.  The indexed load/store
1706 instructions are not directly a problem but can lead to unexpected
1707 behaviour when deployed in an application intended for a 32-bit address
1708 space but run on a 64-bit processor.  The issue is seen because all
1709 known MIPS 64-bit Linux kernels execute o32 and n32 applications
1710 with 64-bit addressing enabled which affects the overflow behaviour
1711 of the indexed addressing mode.  GCC will assume that ordinary
1712 32-bit arithmetic overflow behaviour is the same whether performed
1713 as an @code{addu} instruction or as part of the address calculation
1714 in @code{lwxc1} type instructions.  This assumption holds true in a
1715 pure 32-bit environment and can hold true in a 64-bit environment if
1716 the address space is accurately set to be 32-bit for o32 and n32.
1718 @item --with-madd4
1719 On MIPS targets, make @option{-mmadd4} the default when no
1720 @option{-mno-madd4} option is passed.  This is the default.
1722 @item --without-madd4
1723 On MIPS targets, make @option{-mno-madd4} the default when no
1724 @option{-mmadd4} option is passed.  The @code{madd4} instruction
1725 family can be problematic when targeting a combination of cores that
1726 implement these instructions differently.  There are two known cores
1727 that implement these as fused operations instead of unfused (where
1728 unfused is normally expected).  Disabling these instructions is the
1729 only way to ensure compatible code is generated; this will incur
1730 a performance penalty.
1732 @item --with-msa
1733 On MIPS targets, make @option{-mmsa} the default when no
1734 @option{-mno-msa} option is passed.
1736 @item --without-msa
1737 On MIPS targets, make @option{-mno-msa} the default when no
1738 @option{-mmsa} option is passed. This is the default.
1740 @item --with-mips-plt
1741 On MIPS targets, make use of copy relocations and PLTs.
1742 These features are extensions to the traditional
1743 SVR4-based MIPS ABIs and require support from GNU binutils
1744 and the runtime C library.
1746 @item --with-stack-clash-protection-guard-size=@var{size}
1747 On certain targets this option sets the default stack clash protection guard
1748 size as a power of two in bytes.  On AArch64 @var{size} is required to be either
1749 12 (4KB) or 16 (64KB).
1751 @item --with-isa-spec=@var{ISA-spec-string}
1752 On RISC-V targets specify the default version of the RISC-V Unprivileged
1753 (formerly User-Level) ISA specification to produce code conforming to.
1754 The possibilities for @var{ISA-spec-string} are:
1755 @table @code
1756 @item 2.2
1757 Produce code conforming to version 2.2.
1758 @item 20190608
1759 Produce code conforming to version 20190608.
1760 @item 20191213
1761 Produce code conforming to version 20191213.
1762 @end table
1763 In the absence of this configuration option the default version is 20191213.
1765 @item --enable-__cxa_atexit
1766 Define if you want to use __cxa_atexit, rather than atexit, to
1767 register C++ destructors for local statics and global objects.
1768 This is essential for fully standards-compliant handling of
1769 destructors, but requires __cxa_atexit in libc.  This option is currently
1770 only available on systems with GNU libc.  When enabled, this will cause
1771 @option{-fuse-cxa-atexit} to be passed by default.
1773 @item --enable-gnu-indirect-function
1774 Define if you want to enable the @code{ifunc} attribute.  This option is
1775 currently only available on systems with GNU libc on certain targets.
1777 @item --enable-target-optspace
1778 Specify that target
1779 libraries should be optimized for code space instead of code speed.
1780 This is the default for the m32r platform.
1782 @item --with-cpp-install-dir=@var{dirname}
1783 Specify that the user visible @command{cpp} program should be installed
1784 in @file{@var{prefix}/@var{dirname}/cpp}, in addition to @var{bindir}.
1786 @item --enable-comdat
1787 Enable COMDAT group support.  This is primarily used to override the
1788 automatically detected value.
1790 @item --enable-initfini-array
1791 Force the use of sections @code{.init_array} and @code{.fini_array}
1792 (instead of @code{.init} and @code{.fini}) for constructors and
1793 destructors.  Option @option{--disable-initfini-array} has the
1794 opposite effect.  If neither option is specified, the configure script
1795 will try to guess whether the @code{.init_array} and
1796 @code{.fini_array} sections are supported and, if they are, use them.
1798 @item --enable-link-mutex
1799 When building GCC, use a mutex to avoid linking the compilers for
1800 multiple languages at the same time, to avoid thrashing on build
1801 systems with limited free memory.  The default is not to use such a mutex.
1803 @item --enable-link-serialization
1804 When building GCC, use make dependencies to serialize linking the compilers for
1805 multiple languages, to avoid thrashing on build
1806 systems with limited free memory.  The default is not to add such
1807 dependencies and thus with parallel make potentially link different
1808 compilers concurrently.  If the argument is a positive integer, allow
1809 that number of concurrent link processes for the large binaries.
1811 @item --enable-maintainer-mode
1812 The build rules that regenerate the Autoconf and Automake output files as
1813 well as the GCC master message catalog @file{gcc.pot} are normally
1814 disabled.  This is because it can only be rebuilt if the complete source
1815 tree is present.  If you have changed the sources and want to rebuild the
1816 catalog, configuring with @option{--enable-maintainer-mode} will enable
1817 this.  Note that you need a recent version of the @code{gettext} tools
1818 to do so.
1820 @item --disable-bootstrap
1821 For a native build, the default configuration is to perform
1822 a 3-stage bootstrap of the compiler when @samp{make} is invoked,
1823 testing that GCC can compile itself correctly.  If you want to disable
1824 this process, you can configure with @option{--disable-bootstrap}.
1826 @item --enable-bootstrap
1827 In special cases, you may want to perform a 3-stage build
1828 even if the target and host triplets are different.
1829 This is possible when the host can run code compiled for
1830 the target (e.g.@: host is i686-linux, target is i486-linux).
1831 Starting from GCC 4.2, to do this you have to configure explicitly
1832 with @option{--enable-bootstrap}.
1834 @item --enable-generated-files-in-srcdir
1835 Neither the .c and .h files that are generated from Bison and flex nor the
1836 info manuals and man pages that are built from the .texi files are present
1837 in the repository development tree.  When building GCC from that development tree,
1838 or from one of our snapshots, those generated files are placed in your
1839 build directory, which allows for the source to be in a readonly
1840 directory.
1842 If you configure with @option{--enable-generated-files-in-srcdir} then those
1843 generated files will go into the source directory.  This is mainly intended
1844 for generating release or prerelease tarballs of the GCC sources, since it
1845 is not a requirement that the users of source releases to have flex, Bison,
1846 or makeinfo.
1848 @item --enable-version-specific-runtime-libs
1849 Specify
1850 that runtime libraries should be installed in the compiler specific
1851 subdirectory (@file{@var{libdir}/gcc}) rather than the usual places.  In
1852 addition, @samp{libstdc++}'s include files will be installed into
1853 @file{@var{libdir}} unless you overruled it by using
1854 @option{--with-gxx-include-dir=@var{dirname}}.  Using this option is
1855 particularly useful if you intend to use several versions of GCC in
1856 parallel.  The default is @samp{yes} for @samp{libada}, and @samp{no} for
1857 the remaining libraries.
1859 @item --with-darwin-extra-rpath
1860 This is provided to allow distributions to add a single additional
1861 runpath on Darwin / macOS systems. This allows for cases where the
1862 installed GCC library directories are then symlinked to a common
1863 directory outside of the GCC installation.
1865 @item @anchor{WithAixSoname}--with-aix-soname=@samp{aix}, @samp{svr4} or @samp{both}
1866 Traditional AIX shared library versioning (versioned @code{Shared Object}
1867 files as members of unversioned @code{Archive Library} files named
1868 @samp{lib.a}) causes numerous headaches for package managers. However,
1869 @code{Import Files} as members of @code{Archive Library} files allow for
1870 @strong{filename-based versioning} of shared libraries as seen on Linux/SVR4,
1871 where this is called the "SONAME". But as they prevent static linking,
1872 @code{Import Files} may be used with @code{Runtime Linking} only, where the
1873 linker does search for @samp{libNAME.so} before @samp{libNAME.a} library
1874 filenames with the @samp{-lNAME} linker flag.
1876 @anchor{AixLdCommand}For detailed information please refer to the AIX
1877 @uref{https://www.ibm.com/support/knowledgecenter/search/%22the%20ld%20command%2C%20also%20called%20the%20linkage%20editor%20or%20binder%22,,ld
1878 Command} reference.
1880 As long as shared library creation is enabled, upon:
1881 @table @code
1882 @item --with-aix-soname=aix
1883 @item --with-aix-soname=both
1884  A (traditional AIX) @code{Shared Archive Library} file is created:
1885  @itemize @bullet
1886   @item using the @samp{libNAME.a} filename scheme
1887   @item with the @code{Shared Object} file as archive member named
1888   @samp{libNAME.so.V} (except for @samp{libgcc_s}, where the @code{Shared
1889   Object} file is named @samp{shr.o} for backwards compatibility), which
1890   @itemize @minus
1891    @item is used for runtime loading from inside the @samp{libNAME.a} file
1892    @item is used for dynamic loading via
1893    @code{dlopen("libNAME.a(libNAME.so.V)", RTLD_MEMBER)}
1894    @item is used for shared linking
1895    @item is used for static linking, so no separate @code{Static Archive
1896    Library} file is needed
1897   @end itemize
1898  @end itemize
1899 @item --with-aix-soname=both
1900 @item --with-aix-soname=svr4
1901  A (second) @code{Shared Archive Library} file is created:
1902  @itemize @bullet
1903  @item using the @samp{libNAME.so.V} filename scheme
1904  @item with the @code{Shared Object} file as archive member named
1905  @samp{shr.o}, which
1906   @itemize @minus
1907    @item is created with the @code{-G linker flag}
1908    @item has the @code{F_LOADONLY} flag set
1909    @item is used for runtime loading from inside the @samp{libNAME.so.V} file
1910    @item is used for dynamic loading via @code{dlopen("libNAME.so.V(shr.o)",
1911    RTLD_MEMBER)}
1912   @end itemize
1913  @item with the @code{Import File} as archive member named @samp{shr.imp},
1914  which
1915   @itemize @minus
1916    @item refers to @samp{libNAME.so.V(shr.o)} as the "SONAME", to be recorded
1917    in the @code{Loader Section} of subsequent binaries
1918    @item indicates whether @samp{libNAME.so.V(shr.o)} is 32 or 64 bit
1919    @item lists all the public symbols exported by @samp{lib.so.V(shr.o)},
1920    eventually decorated with the @code{@samp{weak} Keyword}
1921    @item is necessary for shared linking against @samp{lib.so.V(shr.o)}
1922    @end itemize
1923   @end itemize
1924   A symbolic link using the @samp{libNAME.so} filename scheme is created:
1925   @itemize @bullet
1926   @item pointing to the @samp{libNAME.so.V} @code{Shared Archive Library} file
1927   @item to permit the @code{ld Command} to find @samp{lib.so.V(shr.imp)} via
1928   the @samp{-lNAME} argument (requires @code{Runtime Linking} to be enabled)
1929   @item to permit dynamic loading of @samp{lib.so.V(shr.o)} without the need
1930   to specify the version number via @code{dlopen("libNAME.so(shr.o)",
1931   RTLD_MEMBER)}
1932   @end itemize
1933 @end table
1935 As long as static library creation is enabled, upon:
1936 @table @code
1937 @item --with-aix-soname=svr4
1938  A @code{Static Archive Library} is created:
1939  @itemize @bullet
1940  @item using the @samp{libNAME.a} filename scheme
1941  @item with all the @code{Static Object} files as archive members, which
1942   @itemize @minus
1943    @item are used for static linking
1944   @end itemize
1945  @end itemize
1946 @end table
1948 While the aix-soname=@samp{svr4} option does not create @code{Shared Object}
1949 files as members of unversioned @code{Archive Library} files any more, package
1950 managers still are responsible to
1951 @uref{./specific.html#TransferAixShobj,,transfer} @code{Shared Object} files
1952 found as member of a previously installed unversioned @code{Archive Library}
1953 file into the newly installed @code{Archive Library} file with the same
1954 filename.
1956 @emph{WARNING:} Creating @code{Shared Object} files with @code{Runtime Linking}
1957 enabled may bloat the TOC, eventually leading to @code{TOC overflow} errors,
1958 requiring the use of either the @option{-Wl,-bbigtoc} linker flag (seen to
1959 break with the @code{GDB} debugger) or some of the TOC-related compiler flags,
1960 @ifnothtml
1961 @xref{RS/6000 and PowerPC Options,, RS/6000 and PowerPC Options, gcc,
1962 Using the GNU Compiler Collection (GCC)}.
1963 @end ifnothtml
1964 @ifhtml
1965 see ``RS/6000 and PowerPC Options'' in the main manual.
1966 @end ifhtml
1968 @option{--with-aix-soname} is currently supported by @samp{libgcc_s} only, so
1969 this option is still experimental and not for normal use yet.
1971 Default is the traditional behavior @option{--with-aix-soname=@samp{aix}}.
1973 @item --enable-languages=@var{lang1},@var{lang2},@dots{}
1974 Specify that only a particular subset of compilers and
1975 their runtime libraries should be built.  For a list of valid values for
1976 @var{langN} you can issue the following command in the
1977 @file{gcc} directory of your GCC source tree:@*
1978 @smallexample
1979 grep ^language= */config-lang.in
1980 @end smallexample
1981 Currently, you can use any of the following:
1982 @code{all}, @code{default}, @code{ada}, @code{c}, @code{c++}, @code{d},
1983 @code{fortran}, @code{go}, @code{jit}, @code{lto}, @code{m2},
1984 @code{objc}, @code{obj-c++}.
1985 Building the Ada compiler has special requirements, see below.
1986 If you do not pass this flag, or specify the option @code{default}, then the
1987 default languages available in the @file{gcc} sub-tree will be configured.
1988 Ada, D, Go, Jit, Objective-C++ and Modula-2 are not default languages.
1989 LTO is not a
1990 default language, but is built by default because @option{--enable-lto} is
1991 enabled by default.  The other languages are default languages.  If
1992 @code{all} is specified, then all available languages are built.  An
1993 exception is @code{jit} language, which requires
1994 @option{--enable-host-shared} to be included with @code{all}.
1996 @item --enable-stage1-languages=@var{lang1},@var{lang2},@dots{}
1997 Specify that a particular subset of compilers and their runtime
1998 libraries should be built with the system C compiler during stage 1 of
1999 the bootstrap process, rather than only in later stages with the
2000 bootstrapped C compiler.  The list of valid values is the same as for
2001 @option{--enable-languages}, and the option @code{all} will select all
2002 of the languages enabled by @option{--enable-languages}.  This option is
2003 primarily useful for GCC development; for instance, when a development
2004 version of the compiler cannot bootstrap due to compiler bugs, or when
2005 one is debugging front ends other than the C front end.  When this
2006 option is used, one can then build the target libraries for the
2007 specified languages with the stage-1 compiler by using @command{make
2008 stage1-bubble all-target}, or run the testsuite on the stage-1 compiler
2009 for the specified languages using @command{make stage1-start check-gcc}.
2011 @item --disable-libada
2012 Specify that the run-time libraries and tools used by GNAT should not
2013 be built.  This can be useful for debugging, or for compatibility with
2014 previous Ada build procedures, when it was required to explicitly
2015 do a @samp{make -C gcc gnatlib_and_tools}.
2017 @item --disable-libgm2
2018 Specify that the run-time libraries and tools used by Modula-2 should not
2019 be built.  This can be useful for debugging.
2021 @item --disable-libsanitizer
2022 Specify that the run-time libraries for the various sanitizers should
2023 not be built.
2025 @item --disable-libssp
2026 Specify that the run-time libraries for stack smashing protection
2027 should not be built or linked against.  On many targets library support
2028 is provided by the C library instead.
2030 @item --disable-libquadmath
2031 Specify that the GCC quad-precision math library should not be built.
2032 On some systems, the library is required to be linkable when building
2033 the Fortran front end, unless @option{--disable-libquadmath-support}
2034 is used.
2036 @item --disable-libquadmath-support
2037 Specify that the Fortran front end and @code{libgfortran} do not add
2038 support for @code{libquadmath} on systems supporting it.
2040 @item --disable-libgomp
2041 Specify that the GNU Offloading and Multi Processing Runtime Library
2042 should not be built.
2044 @item --disable-libvtv
2045 Specify that the run-time libraries used by vtable verification
2046 should not be built.
2048 @item --with-dwarf2
2049 Specify that the compiler should
2050 use DWARF debugging information as the default; the exact
2051 DWARF version that is the default is target-specific.
2053 @item --with-advance-toolchain=@var{at}
2054 On 64-bit PowerPC Linux systems, configure the compiler to use the
2055 header files, library files, and the dynamic linker from the Advance
2056 Toolchain release @var{at} instead of the default versions that are
2057 provided by the Linux distribution.  In general, this option is
2058 intended for the developers of GCC, and it is not intended for general
2059 use.
2061 @item --enable-targets=all
2062 @itemx --enable-targets=@var{target_list}
2063 Some GCC targets, e.g.@: powerpc64-linux, build bi-arch compilers.
2064 These are compilers that are able to generate either 64-bit or 32-bit
2065 code.  Typically, the corresponding 32-bit target, e.g.@:
2066 powerpc-linux for powerpc64-linux, only generates 32-bit code.  This
2067 option enables the 32-bit target to be a bi-arch compiler, which is
2068 useful when you want a bi-arch compiler that defaults to 32-bit, and
2069 you are building a bi-arch or multi-arch binutils in a combined tree.
2070 On mips-linux, this will build a tri-arch compiler (ABI o32/n32/64),
2071 defaulted to o32.
2072 Currently, this option only affects sparc-linux, powerpc-linux, x86-linux,
2073 mips-linux and s390-linux.
2075 @item --enable-default-pie
2076 Turn on @option{-fPIE} and @option{-pie} by default.
2078 @item --enable-secureplt
2079 This option enables @option{-msecure-plt} by default for powerpc-linux.
2080 @ifnothtml
2081 @xref{RS/6000 and PowerPC Options,, RS/6000 and PowerPC Options, gcc,
2082 Using the GNU Compiler Collection (GCC)},
2083 @end ifnothtml
2084 @ifhtml
2085 See ``RS/6000 and PowerPC Options'' in the main manual
2086 @end ifhtml
2088 @item --enable-default-ssp
2089 Turn on @option{-fstack-protector-strong} by default.
2091 @item --enable-cld
2092 This option enables @option{-mcld} by default for 32-bit x86 targets.
2093 @ifnothtml
2094 @xref{i386 and x86-64 Options,, i386 and x86-64 Options, gcc,
2095 Using the GNU Compiler Collection (GCC)},
2096 @end ifnothtml
2097 @ifhtml
2098 See ``i386 and x86-64 Options'' in the main manual
2099 @end ifhtml
2101 @item --enable-large-address-aware
2102 The @option{--enable-large-address-aware} option arranges for MinGW
2103 executables to be linked using the @option{--large-address-aware}
2104 option, that enables the use of more than 2GB of memory.  If GCC is
2105 configured with this option, its effects can be reversed by passing the
2106 @option{-Wl,--disable-large-address-aware} option to the so-configured
2107 compiler driver.
2109 @item --enable-win32-registry
2110 @itemx --enable-win32-registry=@var{key}
2111 @itemx --disable-win32-registry
2112 The @option{--enable-win32-registry} option enables Microsoft Windows-hosted GCC
2113 to look up installations paths in the registry using the following key:
2115 @smallexample
2116 @code{HKEY_LOCAL_MACHINE\SOFTWARE\Free Software Foundation\@var{key}}
2117 @end smallexample
2119 @var{key} defaults to GCC version number, and can be overridden by the
2120 @option{--enable-win32-registry=@var{key}} option.  Vendors and distributors
2121 who use custom installers are encouraged to provide a different key,
2122 perhaps one comprised of vendor name and GCC version number, to
2123 avoid conflict with existing installations.  This feature is enabled
2124 by default, and can be disabled by @option{--disable-win32-registry}
2125 option.  This option has no effect on the other hosts.
2127 @item --nfp
2128 Specify that the machine does not have a floating point unit.  This
2129 option only applies to @samp{m68k-sun-sunos@var{n}}.  On any other
2130 system, @option{--nfp} has no effect.
2132 @item --enable-werror
2133 @itemx --disable-werror
2134 @itemx --enable-werror=yes
2135 @itemx --enable-werror=no
2136 When you specify this option, it controls whether certain files in the
2137 compiler are built with @option{-Werror} in bootstrap stage2 and later.
2138 If you don't specify it, @option{-Werror} is turned on for the main
2139 development trunk.  However it defaults to off for release branches and
2140 final releases.  The specific files which get @option{-Werror} are
2141 controlled by the Makefiles.
2143 @item --enable-checking
2144 @itemx --disable-checking
2145 @itemx --enable-checking=@var{list}
2146 This option controls performing internal consistency checks in the compiler.
2147 It does not change the generated code, but adds error checking of the
2148 requested complexity.  This slows down the compiler and may only work
2149 properly if you are building the compiler with GCC@.
2151 When the option is not specified, the active set of checks depends on context.
2152 Namely, bootstrap stage 1 defaults to @samp{--enable-checking=yes}, builds
2153 from release branches or release archives default to
2154 @samp{--enable-checking=release}, and otherwise
2155 @samp{--enable-checking=yes,extra} is used.  When the option is
2156 specified without a @var{list}, the result is the same as
2157 @samp{--enable-checking=yes}.  Likewise, @samp{--disable-checking} is
2158 equivalent to @samp{--enable-checking=no}.
2160 The categories of checks available in @var{list} are @samp{yes} (most common
2161 checks @samp{assert,misc,gc,gimple,rtlflag,runtime,tree,types}), @samp{no}
2162 (no checks at all), @samp{all} (all but @samp{valgrind}), @samp{release}
2163 (cheapest checks @samp{assert,runtime}) or @samp{none} (same as @samp{no}).
2164 @samp{release} checks are always on and to disable them
2165 @samp{--disable-checking} or @samp{--enable-checking=no[,<other checks>]}
2166 must be explicitly requested.  Disabling assertions makes the compiler and
2167 runtime slightly faster but increases the risk of undetected internal errors
2168 causing wrong code to be generated.
2170 Individual checks can be enabled with these flags: @samp{assert}, @samp{df},
2171 @samp{extra}, @samp{fold}, @samp{gc}, @samp{gcac}, @samp{gimple},
2172 @samp{misc}, @samp{rtl}, @samp{rtlflag}, @samp{runtime}, @samp{tree},
2173 @samp{types} and @samp{valgrind}.  @samp{extra} extends @samp{misc}
2174 checking with extra checks that might affect code generation and should
2175 therefore not differ between stage1 and later stages in bootstrap.
2177 The @samp{valgrind} check requires the external @command{valgrind} simulator,
2178 available from @uref{https://valgrind.org}.  The @samp{rtl} checks are
2179 expensive and the @samp{df}, @samp{gcac} and @samp{valgrind} checks are very
2180 expensive.
2182 @item --disable-stage1-checking
2183 @itemx --enable-stage1-checking
2184 @itemx --enable-stage1-checking=@var{list}
2185 This option affects only bootstrap build.  If no @option{--enable-checking}
2186 option is specified the stage1 compiler is built with @samp{yes} checking
2187 enabled, otherwise the stage1 checking flags are the same as specified by
2188 @option{--enable-checking}.  To build the stage1 compiler with
2189 different checking options use @option{--enable-stage1-checking}.
2190 The list of checking options is the same as for @option{--enable-checking}.
2191 If your system is too slow or too small to bootstrap a released compiler
2192 with checking for stage1 enabled, you can use @samp{--disable-stage1-checking}
2193 to disable checking for the stage1 compiler.
2195 @item --enable-coverage
2196 @itemx --enable-coverage=@var{level}
2197 With this option, the compiler is built to collect self coverage
2198 information, every time it is run.  This is for internal development
2199 purposes, and only works when the compiler is being built with gcc.  The
2200 @var{level} argument controls whether the compiler is built optimized or
2201 not, values are @samp{opt} and @samp{noopt}.  For coverage analysis you
2202 want to disable optimization, for performance analysis you want to
2203 enable optimization.  When coverage is enabled, the default level is
2204 without optimization.
2206 @item --enable-gather-detailed-mem-stats
2207 When this option is specified more detailed information on memory
2208 allocation is gathered.  This information is printed when using
2209 @option{-fmem-report}.
2211 @item --enable-valgrind-annotations
2212 Mark selected memory related operations in the compiler when run under
2213 valgrind to suppress false positives.
2215 @item --enable-nls
2216 @itemx --disable-nls
2217 The @option{--enable-nls} option enables Native Language Support (NLS),
2218 which lets GCC output diagnostics in languages other than American
2219 English.  Native Language Support is enabled by default if not doing a
2220 canadian cross build.  The @option{--disable-nls} option disables NLS@.
2222 @item --with-included-gettext
2223 If NLS is enabled, the @option{--with-included-gettext} option causes the build
2224 procedure to prefer its copy of GNU @command{gettext}.
2226 @item --with-catgets
2227 If NLS is enabled, and if the host lacks @code{gettext} but has the
2228 inferior @code{catgets} interface, the GCC build procedure normally
2229 ignores @code{catgets} and instead uses GCC's copy of the GNU
2230 @code{gettext} library.  The @option{--with-catgets} option causes the
2231 build procedure to use the host's @code{catgets} in this situation.
2233 @item --with-libiconv-prefix=@var{dir}
2234 Search for libiconv header files in @file{@var{dir}/include} and
2235 libiconv library files in @file{@var{dir}/lib}.
2237 @item --enable-obsolete
2238 Enable configuration for an obsoleted system.  If you attempt to
2239 configure GCC for a system (build, host, or target) which has been
2240 obsoleted, and you do not specify this flag, configure will halt with an
2241 error message.
2243 All support for systems which have been obsoleted in one release of GCC
2244 is removed entirely in the next major release, unless someone steps
2245 forward to maintain the port.
2247 @item --enable-decimal-float
2248 @itemx --enable-decimal-float=yes
2249 @itemx --enable-decimal-float=no
2250 @itemx --enable-decimal-float=bid
2251 @itemx --enable-decimal-float=dpd
2252 @itemx --disable-decimal-float
2253 Enable (or disable) support for the C decimal floating point extension
2254 that is in the IEEE 754-2008 standard.  This is enabled by default
2255 only on AArch64, PowerPC, i386, and x86_64 GNU/Linux systems.  Other
2256 systems may also support it, but require the user to specifically
2257 enable it.  You can optionally control which decimal floating point
2258 format is used (either @samp{bid} or @samp{dpd}).  The @samp{bid}
2259 (binary integer decimal) format is default on AArch64, i386 and x86_64
2260 systems, and the @samp{dpd} (densely packed decimal) format is default
2261 on PowerPC systems.
2263 @item --enable-fixed-point
2264 @itemx --disable-fixed-point
2265 Enable (or disable) support for C fixed-point arithmetic.
2266 This option is enabled by default for some targets (such as MIPS) which
2267 have hardware-support for fixed-point operations.  On other targets, you
2268 may enable this option manually.
2270 @item --with-long-double-128
2271 Specify if @code{long double} type should be 128-bit by default on selected
2272 GNU/Linux architectures.  If using @code{--without-long-double-128},
2273 @code{long double} will be by default 64-bit, the same as @code{double} type.
2274 When neither of these configure options are used, the default will be
2275 128-bit @code{long double} when built against GNU C Library 2.4 and later,
2276 64-bit @code{long double} otherwise.
2278 @item --with-long-double-format=ibm
2279 @itemx --with-long-double-format=ieee
2280 Specify whether @code{long double} uses the IBM extended double format
2281 or the IEEE 128-bit floating point format on PowerPC Linux systems.
2282 This configuration switch will only work on little endian PowerPC
2283 Linux systems and on big endian 64-bit systems where the default cpu
2284 is at least power7 (i.e.@: @option{--with-cpu=power7},
2285 @option{--with-cpu=power8}, or @option{--with-cpu=power9} is used).
2287 If you use the @option{--with-long-double-64} configuration option,
2288 the @option{--with-long-double-format=ibm} and
2289 @option{--with-long-double-format=ieee} options are ignored.
2291 The default @code{long double} format is to use IBM extended double.
2292 Until all of the libraries are converted to use IEEE 128-bit floating
2293 point, it is not recommended to use
2294 @option{--with-long-double-format=ieee}.
2296 @item --enable-fdpic
2297 On SH Linux systems, generate ELF FDPIC code.
2299 @item --with-gmp=@var{pathname}
2300 @itemx --with-gmp-include=@var{pathname}
2301 @itemx --with-gmp-lib=@var{pathname}
2302 @itemx --with-mpfr=@var{pathname}
2303 @itemx --with-mpfr-include=@var{pathname}
2304 @itemx --with-mpfr-lib=@var{pathname}
2305 @itemx --with-mpc=@var{pathname}
2306 @itemx --with-mpc-include=@var{pathname}
2307 @itemx --with-mpc-lib=@var{pathname}
2308 If you want to build GCC but do not have the GMP library, the MPFR
2309 library and/or the MPC library installed in a standard location and
2310 do not have their sources present in the GCC source tree then you
2311 can explicitly specify the directory where they are installed
2312 (@samp{--with-gmp=@var{gmpinstalldir}},
2313 @samp{--with-mpfr=@/@var{mpfrinstalldir}},
2314 @samp{--with-mpc=@/@var{mpcinstalldir}}).  The
2315 @option{--with-gmp=@/@var{gmpinstalldir}} option is shorthand for
2316 @option{--with-gmp-lib=@/@var{gmpinstalldir}/lib} and
2317 @option{--with-gmp-include=@/@var{gmpinstalldir}/include}.  Likewise the
2318 @option{--with-mpfr=@/@var{mpfrinstalldir}} option is shorthand for
2319 @option{--with-mpfr-lib=@/@var{mpfrinstalldir}/lib} and
2320 @option{--with-mpfr-include=@/@var{mpfrinstalldir}/include}, also the
2321 @option{--with-mpc=@/@var{mpcinstalldir}} option is shorthand for
2322 @option{--with-mpc-lib=@/@var{mpcinstalldir}/lib} and
2323 @option{--with-mpc-include=@/@var{mpcinstalldir}/include}.  If these
2324 shorthand assumptions are not correct, you can use the explicit
2325 include and lib options directly.  You might also need to ensure the
2326 shared libraries can be found by the dynamic linker when building and
2327 using GCC, for example by setting the runtime shared library path
2328 variable (@env{LD_LIBRARY_PATH} on GNU/Linux and Solaris systems).
2330 These flags are applicable to the host platform only.  When building
2331 a cross compiler, they will not be used to configure target libraries.
2333 @item --with-isl=@var{pathname}
2334 @itemx --with-isl-include=@var{pathname}
2335 @itemx --with-isl-lib=@var{pathname}
2336 If you do not have the isl library installed in a standard location and you
2337 want to build GCC, you can explicitly specify the directory where it is
2338 installed (@samp{--with-isl=@/@var{islinstalldir}}). The
2339 @option{--with-isl=@/@var{islinstalldir}} option is shorthand for
2340 @option{--with-isl-lib=@/@var{islinstalldir}/lib} and
2341 @option{--with-isl-include=@/@var{islinstalldir}/include}. If this
2342 shorthand assumption is not correct, you can use the explicit
2343 include and lib options directly.
2345 These flags are applicable to the host platform only.  When building
2346 a cross compiler, they will not be used to configure target libraries.
2348 @item --with-stage1-ldflags=@var{flags}
2349 This option may be used to set linker flags to be used when linking
2350 stage 1 of GCC.  These are also used when linking GCC if configured with
2351 @option{--disable-bootstrap}.  If @option{--with-stage1-libs} is not set to a
2352 value, then the default is @samp{-static-libstdc++ -static-libgcc}, if
2353 supported.
2355 @item --with-stage1-libs=@var{libs}
2356 This option may be used to set libraries to be used when linking stage 1
2357 of GCC.  These are also used when linking GCC if configured with
2358 @option{--disable-bootstrap}.
2360 @item --with-boot-ldflags=@var{flags}
2361 This option may be used to set linker flags to be used when linking
2362 stage 2 and later when bootstrapping GCC.  If --with-boot-libs
2363 is not is set to a value, then the default is
2364 @samp{-static-libstdc++ -static-libgcc}.
2366 @item --with-boot-libs=@var{libs}
2367 This option may be used to set libraries to be used when linking stage 2
2368 and later when bootstrapping GCC.
2370 @item --with-debug-prefix-map=@var{map}
2371 Convert source directory names using @option{-fdebug-prefix-map} when
2372 building runtime libraries.  @samp{@var{map}} is a space-separated
2373 list of maps of the form @samp{@var{old}=@var{new}}.
2375 @item --enable-linker-build-id
2376 Tells GCC to pass @option{--build-id} option to the linker for all final
2377 links (links performed without the @option{-r} or @option{--relocatable}
2378 option), if the linker supports it.  If you specify
2379 @option{--enable-linker-build-id}, but your linker does not
2380 support @option{--build-id} option, a warning is issued and the
2381 @option{--enable-linker-build-id} option is ignored.  The default is off.
2383 @item --with-linker-hash-style=@var{choice}
2384 Tells GCC to pass @option{--hash-style=@var{choice}} option to the
2385 linker for all final links. @var{choice} can be one of
2386 @samp{sysv}, @samp{gnu}, and @samp{both} where @samp{sysv} is the default.
2388 @item --enable-gnu-unique-object
2389 @itemx --disable-gnu-unique-object
2390 Tells GCC to use the gnu_unique_object relocation for C++ template
2391 static data members and inline function local statics.  Enabled by
2392 default for a toolchain with an assembler that accepts it and
2393 GLIBC 2.11 or above, otherwise disabled.
2395 @item --with-diagnostics-color=@var{choice}
2396 Tells GCC to use @var{choice} as the default for @option{-fdiagnostics-color=}
2397 option (if not used explicitly on the command line).  @var{choice}
2398 can be one of @samp{never}, @samp{auto}, @samp{always}, and @samp{auto-if-env}
2399 where @samp{auto} is the default.  @samp{auto-if-env} makes
2400 @option{-fdiagnostics-color=auto} the default if @env{GCC_COLORS}
2401 is present and non-empty in the environment of the compiler, and
2402 @option{-fdiagnostics-color=never} otherwise.
2404 @item --with-diagnostics-urls=@var{choice}
2405 Tells GCC to use @var{choice} as the default for @option{-fdiagnostics-urls=}
2406 option (if not used explicitly on the command line).  @var{choice}
2407 can be one of @samp{never}, @samp{auto}, @samp{always}, and @samp{auto-if-env}
2408 where @samp{auto} is the default.  @samp{auto-if-env} makes
2409 @option{-fdiagnostics-urls=auto} the default if @env{GCC_URLS}
2410 or @env{TERM_URLS} is present and non-empty in the environment of the
2411 compiler, and @option{-fdiagnostics-urls=never} otherwise.
2413 @item --enable-lto
2414 @itemx --disable-lto
2415 Enable support for link-time optimization (LTO).  This is enabled by
2416 default, and may be disabled using @option{--disable-lto}.
2418 @item --enable-linker-plugin-configure-flags=FLAGS
2419 @itemx --enable-linker-plugin-flags=FLAGS
2420 By default, linker plugins (such as the LTO plugin) are built for the
2421 host system architecture.  For the case that the linker has a
2422 different (but run-time compatible) architecture, these flags can be
2423 specified to build plugins that are compatible to the linker.  For
2424 example, if you are building GCC for a 64-bit x86_64
2425 (@samp{x86_64-pc-linux-gnu}) host system, but have a 32-bit x86
2426 GNU/Linux (@samp{i686-pc-linux-gnu}) linker executable (which is
2427 executable on the former system), you can configure GCC as follows for
2428 getting compatible linker plugins:
2430 @smallexample
2431 % @var{srcdir}/configure \
2432     --host=x86_64-pc-linux-gnu \
2433     --enable-linker-plugin-configure-flags=--host=i686-pc-linux-gnu \
2434     --enable-linker-plugin-flags='CC=gcc\ -m32\ -Wl,-rpath,[...]/i686-pc-linux-gnu/lib'
2435 @end smallexample
2437 @item --with-plugin-ld=@var{pathname}
2438 Enable an alternate linker to be used at link-time optimization (LTO)
2439 link time when @option{-fuse-linker-plugin} is enabled.
2440 This linker should have plugin support such as gold starting with
2441 version 2.20 or GNU ld starting with version 2.21.
2442 See @option{-fuse-linker-plugin} for details.
2444 @item --enable-canonical-system-headers
2445 @itemx --disable-canonical-system-headers
2446 Enable system header path canonicalization for @file{libcpp}.  This can
2447 produce shorter header file paths in diagnostics and dependency output
2448 files, but these changed header paths may conflict with some compilation
2449 environments.  Enabled by default, and may be disabled using
2450 @option{--disable-canonical-system-headers}.
2452 @item --with-glibc-version=@var{major}.@var{minor}
2453 Tell GCC that when the GNU C Library (glibc) is used on the target it
2454 will be version @var{major}.@var{minor} or later.  Normally this can
2455 be detected from the C library's header files, but this option may be
2456 needed when bootstrapping a cross toolchain without the header files
2457 available for building the initial bootstrap compiler.
2459 If GCC is configured with some multilibs that use glibc and some that
2460 do not, this option applies only to the multilibs that use glibc.
2461 However, such configurations may not work well as not all the relevant
2462 configuration in GCC is on a per-multilib basis.
2464 @item --enable-as-accelerator-for=@var{target}
2465 Build as offload target compiler. Specify offload host triple by @var{target}.
2467 @item --enable-offload-targets=@var{target1}[=@var{path1}],@dots{},@var{targetN}[=@var{pathN}]
2468 Enable offloading to targets @var{target1}, @dots{}, @var{targetN}.
2469 Offload compilers are expected to be already installed.  Default search
2470 path for them is @file{@var{exec-prefix}}, but it can be changed by
2471 specifying paths @var{path1}, @dots{}, @var{pathN}.
2473 @smallexample
2474 % @var{srcdir}/configure \
2475     --enable-offload-targets=amdgcn-amdhsa,nvptx-none
2476 @end smallexample
2478 @item --enable-offload-defaulted
2480 Tell GCC that configured but not installed offload compilers and libgomp
2481 plugins are silently ignored.  Useful for distribution compilers where
2482 those are in separate optional packages and where the presence or absence
2483 of those optional packages should determine the actual supported offloading
2484 target set rather than the GCC configure-time selection.
2486 @item --enable-cet
2487 @itemx --disable-cet
2488 Enable building target run-time libraries with control-flow
2489 instrumentation, see @option{-fcf-protection} option.  When
2490 @code{--enable-cet} is specified target libraries are configured
2491 to add @option{-fcf-protection} and, if needed, other target
2492 specific options to a set of building options.
2494 @code{--enable-cet=auto} is default.  CET is enabled on Linux/x86 if
2495 target binutils supports @code{Intel CET} instructions and disabled
2496 otherwise.  In this case, the target libraries are configured to get
2497 additional @option{-fcf-protection} option.
2499 @item --with-riscv-attribute=@samp{yes}, @samp{no} or @samp{default}
2500 Generate RISC-V attribute by default, in order to record extra build
2501 information in object.
2503 The option is disabled by default. It is enabled on RISC-V/ELF (bare-metal)
2504 target if target binutils supported.
2506 @item --enable-s390-excess-float-precision
2507 @itemx --disable-s390-excess-float-precision
2508 On s390(x) targets, enable treatment of float expressions with double precision
2509 when in standards-compliant mode (e.g., when @code{--std=c99} or
2510 @code{-fexcess-precision=standard} are given).
2512 For a native build and cross compiles that have target headers, the option's
2513 default is derived from glibc's behavior. When glibc clamps float_t to double,
2514 GCC follows and enables the option. For other cross compiles, the default is
2515 disabled.
2517 @item --with-zstd=@var{pathname}
2518 @itemx --with-zstd-include=@var{pathname}
2519 @itemx --with-zstd-lib=@var{pathname}
2520 If you do not have the @code{zstd} library installed in a standard
2521 location and you want to build GCC, you can explicitly specify the
2522 directory where it is installed (@samp{--with-zstd=@/@var{zstdinstalldir}}).
2523 The @option{--with-zstd=@/@var{zstdinstalldir}} option is shorthand for
2524 @option{--with-zstd-lib=@/@var{zstdinstalldir}/lib} and
2525 @option{--with-zstd-include=@/@var{zstdinstalldir}/include}. If this
2526 shorthand assumption is not correct, you can use the explicit
2527 include and lib options directly.
2529 These flags are applicable to the host platform only.  When building
2530 a cross compiler, they will not be used to configure target libraries.
2531 @end table
2533 @subheading Cross-Compiler-Specific Options
2534 The following options only apply to building cross compilers.
2536 @table @code
2537 @item --with-toolexeclibdir=@var{dir}
2538 Specify the installation directory for libraries built with a cross compiler.
2539 The default is @option{$@{gcc_tooldir@}/lib}.
2541 @item --with-sysroot
2542 @itemx --with-sysroot=@var{dir}
2543 Tells GCC to consider @var{dir} as the root of a tree that contains
2544 (a subset of) the root filesystem of the target operating system.
2545 Target system headers, libraries and run-time object files will be
2546 searched for in there.  More specifically, this acts as if
2547 @option{--sysroot=@var{dir}} was added to the default options of the built
2548 compiler.  The specified directory is not copied into the
2549 install tree, unlike the options @option{--with-headers} and
2550 @option{--with-libs} that this option obsoletes.  The default value,
2551 in case @option{--with-sysroot} is not given an argument, is
2552 @option{$@{gcc_tooldir@}/sys-root}.  If the specified directory is a
2553 subdirectory of @option{$@{exec_prefix@}}, then it will be found relative to
2554 the GCC binaries if the installation tree is moved.
2556 This option affects the system root for the compiler used to build
2557 target libraries (which runs on the build system) and the compiler newly
2558 installed with @code{make install}; it does not affect the compiler which is
2559 used to build GCC itself.
2561 If you specify the @option{--with-native-system-header-dir=@var{dirname}}
2562 option then the compiler will search that directory within @var{dirname} for
2563 native system headers rather than the default @file{/usr/include}.
2565 @item --with-build-sysroot
2566 @itemx --with-build-sysroot=@var{dir}
2567 Tells GCC to consider @var{dir} as the system root (see
2568 @option{--with-sysroot}) while building target libraries, instead of
2569 the directory specified with @option{--with-sysroot}.  This option is
2570 only useful when you are already using @option{--with-sysroot}.  You
2571 can use @option{--with-build-sysroot} when you are configuring with
2572 @option{--prefix} set to a directory that is different from the one in
2573 which you are installing GCC and your target libraries.
2575 This option affects the system root for the compiler used to build
2576 target libraries (which runs on the build system); it does not affect
2577 the compiler which is used to build GCC itself.
2579 If you specify the @option{--with-native-system-header-dir=@var{dirname}}
2580 option then the compiler will search that directory within @var{dirname} for
2581 native system headers rather than the default @file{/usr/include}.
2583 @item --with-headers
2584 @itemx --with-headers=@var{dir}
2585 Deprecated in favor of @option{--with-sysroot}.
2586 Specifies that target headers are available when building a cross compiler.
2587 The @var{dir} argument specifies a directory which has the target include
2588 files.  These include files will be copied into the @file{gcc} install
2589 directory.  @emph{This option with the @var{dir} argument is required} when
2590 building a cross compiler, if @file{@var{prefix}/@var{target}/sys-include}
2591 doesn't pre-exist.  If @file{@var{prefix}/@var{target}/sys-include} does
2592 pre-exist, the @var{dir} argument may be omitted.  @command{fixincludes}
2593 will be run on these files to make them compatible with GCC@.
2595 @item --without-headers
2596 Tells GCC not use any target headers from a libc when building a cross
2597 compiler.  When crossing to GNU/Linux, you need the headers so GCC
2598 can build the exception handling for libgcc.
2600 @item --with-libs
2601 @itemx --with-libs="@var{dir1} @var{dir2} @dots{} @var{dirN}"
2602 Deprecated in favor of @option{--with-sysroot}.
2603 Specifies a list of directories which contain the target runtime
2604 libraries.  These libraries will be copied into the @file{gcc} install
2605 directory.  If the directory list is omitted, this option has no
2606 effect.
2608 @item --with-newlib
2609 Specifies that @samp{newlib} is
2610 being used as the target C library.  This causes @code{__eprintf} to be
2611 omitted from @file{libgcc.a} on the assumption that it will be provided by
2612 @samp{newlib}.
2614 @html
2615 <a name="avr"></a>
2616 @end html
2617 @item --with-avrlibc
2618 Only supported for the AVR target. Specifies that @samp{AVR-Libc} is
2619 being used as the target C@tie{} library.  This causes float support
2620 functions like @code{__addsf3} to be omitted from @file{libgcc.a} on
2621 the assumption that it will be provided by @file{libm.a}.  For more
2622 technical details, cf. @uref{https://gcc.gnu.org/PR54461,,PR54461}.
2623 It is not supported for
2624 RTEMS configurations, which currently use newlib.  The option is
2625 supported since version 4.7.2 and is the default in 4.8.0 and newer.
2627 @item --with-double=@{32|64|32,64|64,32@}
2628 @itemx --with-long-double=@{32|64|32,64|64,32|double@}
2629 Only supported for the AVR target since version@tie{}10.
2630 Specify the default layout available for the C/C++ @samp{double}
2631 and @samp{long double} type, respectively. The following rules apply:
2632 @itemize
2633 @item
2634 The first value after the @samp{=} specifies the default layout (in bits)
2635 of the type and also the default for the @option{-mdouble=} resp.
2636 @option{-mlong-double=} compiler option.
2637 @item
2638 If more than one value is specified, respective multilib variants are
2639 available, and  @option{-mdouble=} resp. @option{-mlong-double=} acts
2640 as a multilib option.
2641 @item
2642 If @option{--with-long-double=double} is specified, @samp{double} and
2643 @samp{long double} will have the same layout.
2644 @item
2645 The defaults are @option{--with-long-double=64,32} and
2646 @option{--with-double=32,64}.  The default @samp{double} layout imposed by
2647 the latter is compatible with older versions of the compiler that implement
2648 @samp{double} as a 32-bit type, which does not comply to the language standard.
2649 @end itemize
2650 Not all combinations of @option{--with-double=} and
2651 @option{--with-long-double=} are valid.  For example, the combination
2652 @option{--with-double=32,64} @option{--with-long-double=32} will be
2653 rejected because the first option specifies the availability of
2654 multilibs for @samp{double}, whereas the second option implies
2655 that @samp{long double} --- and hence also @samp{double} --- is always
2656 32@tie{}bits wide.
2658 @item --with-double-comparison=@{tristate|bool|libf7@}
2659 Only supported for the AVR target since version@tie{}10.
2660 Specify what result format is returned by library functions that
2661 compare 64-bit floating point values (@code{DFmode}).
2662 The GCC default is @samp{tristate}.  If the floating point
2663 implementation returns a boolean instead, set it to @samp{bool}.
2665 @item --with-libf7=@{libgcc|math|math-symbols|no@}
2666 Only supported for the AVR target since version@tie{}10.
2667 Specify to which degree code from LibF7 is included in libgcc.
2668 LibF7 is an ad-hoc, AVR-specific, 64-bit floating point emulation
2669 written in C and (inline) assembly. @samp{libgcc} adds support
2670 for functions that one would usually expect in libgcc like double addition,
2671 double comparisons and double conversions. @samp{math} also adds routines
2672 that one would expect in @file{libm.a}, but with @code{__} (two underscores)
2673 prepended to the symbol names as specified by @file{math.h}.
2674 @samp{math-symbols} also defines weak aliases for the functions
2675 declared in @file{math.h}.  However, @code{--with-libf7} won't
2676 install no @file{math.h} header file whatsoever, this file must come
2677 from elsewhere.  This option sets @option{--with-double-comparison}
2678 to @samp{bool}.
2680 @item --with-nds32-lib=@var{library}
2681 Specifies that @var{library} setting is used for building @file{libgcc.a}.
2682 Currently, the valid @var{library} is @samp{newlib} or @samp{mculib}.
2683 This option is only supported for the NDS32 target.
2685 @item --with-build-time-tools=@var{dir}
2686 Specifies where to find the set of target tools (assembler, linker, etc.)
2687 that will be used while building GCC itself.  This option can be useful
2688 if the directory layouts are different between the system you are building
2689 GCC on, and the system where you will deploy it.
2691 For example, on an @samp{ia64-hp-hpux} system, you may have the GNU
2692 assembler and linker in @file{/usr/bin}, and the native tools in a
2693 different path, and build a toolchain that expects to find the
2694 native tools in @file{/usr/bin}.
2696 When you use this option, you should ensure that @var{dir} includes
2697 @command{ar}, @command{as}, @command{ld}, @command{nm},
2698 @command{ranlib} and @command{strip} if necessary, and possibly
2699 @command{objdump}.  Otherwise, GCC may use an inconsistent set of
2700 tools.
2701 @end table
2703 @subsubheading Overriding @command{configure} test results
2705 Sometimes, it might be necessary to override the result of some
2706 @command{configure} test, for example in order to ease porting to a new
2707 system or work around a bug in a test.  The toplevel @command{configure}
2708 script provides three variables for this:
2710 @table @code
2712 @cindex @code{build_configargs}
2713 @item build_configargs
2714 The contents of this variable is passed to all build @command{configure}
2715 scripts.
2717 @cindex @code{host_configargs}
2718 @item host_configargs
2719 The contents of this variable is passed to all host @command{configure}
2720 scripts.
2722 @cindex @code{target_configargs}
2723 @item target_configargs
2724 The contents of this variable is passed to all target @command{configure}
2725 scripts.
2727 @end table
2729 In order to avoid shell and @command{make} quoting issues for complex
2730 overrides, you can pass a setting for @env{CONFIG_SITE} and set
2731 variables in the site file.
2733 @subheading Objective-C-Specific Options
2735 The following options apply to the build of the Objective-C runtime library.
2737 @table @code
2738 @item --enable-objc-gc
2739 Specify that an additional variant of the GNU Objective-C runtime library
2740 is built, using an external build of the Boehm-Demers-Weiser garbage
2741 collector (@uref{https://www.hboehm.info/gc/}).  This library needs to be
2742 available for each multilib variant, unless configured with
2743 @option{--enable-objc-gc=@samp{auto}} in which case the build of the
2744 additional runtime library is skipped when not available and the build
2745 continues.
2747 @item --with-target-bdw-gc=@var{list}
2748 @itemx --with-target-bdw-gc-include=@var{list}
2749 @itemx --with-target-bdw-gc-lib=@var{list}
2750 Specify search directories for the garbage collector header files and
2751 libraries. @var{list} is a comma separated list of key value pairs of the
2752 form @samp{@var{multilibdir}=@var{path}}, where the default multilib key
2753 is named as @samp{.} (dot), or is omitted (e.g.@:
2754 @samp{--with-target-bdw-gc=/opt/bdw-gc,32=/opt-bdw-gc32}).
2756 The options @option{--with-target-bdw-gc-include} and
2757 @option{--with-target-bdw-gc-lib} must always be specified together
2758 for each multilib variant and they take precedence over
2759 @option{--with-target-bdw-gc}.  If @option{--with-target-bdw-gc-include}
2760 is missing values for a multilib, then the value for the default
2761 multilib is used (e.g.@: @samp{--with-target-bdw-gc-include=/opt/bdw-gc/include}
2762 @samp{--with-target-bdw-gc-lib=/opt/bdw-gc/lib64,32=/opt-bdw-gc/lib32}).
2763 If none of these options are specified, the library is assumed in
2764 default locations.
2765 @end table
2767 @subheading D-Specific Options
2769 The following options apply to the build of the D runtime library.
2771 @table @code
2772 @item --enable-libphobos-checking
2773 @itemx --disable-libphobos-checking
2774 @itemx --enable-libphobos-checking=@var{list}
2775 This option controls whether run-time checks and contracts are compiled into
2776 the D runtime library.  When the option is not specified, the library is built
2777 with @samp{release} checking.  When the option is specified without a
2778 @var{list}, the result is the same as @samp{--enable-libphobos-checking=yes}.
2779 Likewise, @samp{--disable-libphobos-checking} is equivalent to
2780 @samp{--enable-libphobos-checking=no}.
2782 The categories of checks available in @var{list} are @samp{yes} (compiles
2783 libphobos with @option{-fno-release}), @samp{no} (compiles libphobos with
2784 @option{-frelease}), @samp{all} (same as @samp{yes}), @samp{none} or
2785 @samp{release} (same as @samp{no}).
2787 Individual checks available in @var{list} are @samp{assert} (compiles libphobos
2788 with an extra option @option{-fassert}).
2790 @item --with-libphobos-druntime-only
2791 @itemx --with-libphobos-druntime-only=@var{choice}
2792 Specify whether to build only the core D runtime library (druntime), or both
2793 the core and standard library (phobos) into libphobos.  This is useful for
2794 targets that have full support in druntime, but no or incomplete support
2795 in phobos.  @var{choice} can be one of @samp{auto}, @samp{yes}, and @samp{no}
2796 where @samp{auto} is the default.
2798 When the option is not specified, the default choice @samp{auto} means that it
2799 is inferred whether the target has support for the phobos standard library.
2800 When the option is specified without a @var{choice},  the result is the same as
2801 @samp{--with-libphobos-druntime-only=yes}.
2803 @item --with-target-system-zlib
2804 Use installed @samp{zlib} rather than that included with GCC@.  This needs
2805 to be available for each multilib variant, unless configured with
2806 @option{--with-target-system-zlib=@samp{auto}} in which case the GCC@ included
2807 @samp{zlib} is only used when the system installed library is not available.
2808 @end table
2810 @html
2811 <hr />
2813 @end html
2814 @ifhtml
2815 @uref{./index.html,,Return to the GCC Installation page}
2816 @end ifhtml
2817 @end ifset
2819 @c ***Building****************************************************************
2820 @ifnothtml
2821 @comment node-name,     next,          previous, up
2822 @node    Building, Testing, Configuration, Installing GCC
2823 @end ifnothtml
2824 @ifset buildhtml
2825 @ifnothtml
2826 @chapter Building
2827 @end ifnothtml
2828 @cindex Installing GCC: Building
2830 Now that GCC is configured, you are ready to build the compiler and
2831 runtime libraries.
2833 Some commands executed when making the compiler may fail (return a
2834 nonzero status) and be ignored by @command{make}.  These failures, which
2835 are often due to files that were not found, are expected, and can safely
2836 be ignored.
2838 It is normal to have compiler warnings when compiling certain files.
2839 Unless you are a GCC developer, you can generally ignore these warnings
2840 unless they cause compilation to fail.  Developers should attempt to fix
2841 any warnings encountered, however they can temporarily continue past
2842 warnings-as-errors by specifying the configure flag
2843 @option{--disable-werror}.
2845 On certain old systems, defining certain environment variables such as
2846 @env{CC} can interfere with the functioning of @command{make}.
2848 If you encounter seemingly strange errors when trying to build the
2849 compiler in a directory other than the source directory, it could be
2850 because you have previously configured the compiler in the source
2851 directory.  Make sure you have done all the necessary preparations.
2853 If you build GCC on a BSD system using a directory stored in an old System
2854 V file system, problems may occur in running @command{fixincludes} if the
2855 System V file system doesn't support symbolic links.  These problems
2856 result in a failure to fix the declaration of @code{size_t} in
2857 @file{sys/types.h}.  If you find that @code{size_t} is a signed type and
2858 that type mismatches occur, this could be the cause.
2860 The solution is not to use such a directory for building GCC@.
2862 Similarly, when building from the source repository or snapshots, or if you modify
2863 @file{*.l} files, you need the Flex lexical analyzer generator
2864 installed.  If you do not modify @file{*.l} files, releases contain
2865 the Flex-generated files and you do not need Flex installed to build
2866 them.  There is still one Flex-based lexical analyzer (part of the
2867 build machinery, not of GCC itself) that is used even if you only
2868 build the C front end.
2870 When building from the source repository or snapshots, or if you modify Texinfo
2871 documentation, you need version 4.7 or later of Texinfo installed if you
2872 want Info documentation to be regenerated.  Releases contain Info
2873 documentation pre-built for the unmodified documentation in the release.
2875 @section Building a native compiler
2877 For a native build, the default configuration is to perform
2878 a 3-stage bootstrap of the compiler when @samp{make} is invoked.
2879 This will build the entire GCC system and ensure that it compiles
2880 itself correctly.  It can be disabled with the @option{--disable-bootstrap}
2881 parameter to @samp{configure}, but bootstrapping is suggested because
2882 the compiler will be tested more completely and could also have
2883 better performance.
2885 The bootstrapping process will complete the following steps:
2887 @itemize @bullet
2888 @item
2889 Build tools necessary to build the compiler.
2891 @item
2892 Perform a 3-stage bootstrap of the compiler.  This includes building
2893 three times the target tools for use by the compiler such as binutils
2894 (bfd, binutils, gas, gprof, ld, and opcodes) if they have been
2895 individually linked or moved into the top level GCC source tree before
2896 configuring.
2898 @item
2899 Perform a comparison test of the stage2 and stage3 compilers.
2901 @item
2902 Build runtime libraries using the stage3 compiler from the previous step.
2904 @end itemize
2906 If you are short on disk space you might consider @samp{make
2907 bootstrap-lean} instead.  The sequence of compilation is the
2908 same described above, but object files from the stage1 and
2909 stage2 of the 3-stage bootstrap of the compiler are deleted as
2910 soon as they are no longer needed.
2912 If you wish to use non-default GCC flags when compiling the stage2
2913 and stage3 compilers, set @code{BOOT_CFLAGS} on the command line when
2914 doing @samp{make}.  For example, if you want to save additional space
2915 during the bootstrap and in the final installation as well, you can
2916 build the compiler binaries without debugging information as in the
2917 following example.  This will save roughly 40% of disk space both for
2918 the bootstrap and the final installation.  (Libraries will still contain
2919 debugging information.)
2921 @smallexample
2922 make BOOT_CFLAGS='-O' bootstrap
2923 @end smallexample
2925 You can place non-default optimization flags into @code{BOOT_CFLAGS}; they
2926 are less well tested here than the default of @samp{-g -O2}, but should
2927 still work.  In a few cases, you may find that you need to specify special
2928 flags such as @option{-msoft-float} here to complete the bootstrap; or,
2929 if the native compiler miscompiles the stage1 compiler, you may need
2930 to work around this, by choosing @code{BOOT_CFLAGS} to avoid the parts
2931 of the stage1 compiler that were miscompiled, or by using @samp{make
2932 bootstrap4} to increase the number of stages of bootstrap.
2934 @code{BOOT_CFLAGS} does not apply to bootstrapped target libraries.
2935 Since these are always compiled with the compiler currently being
2936 bootstrapped, you can use @code{CFLAGS_FOR_TARGET} to modify their
2937 compilation flags, as for non-bootstrapped target libraries.
2938 Again, if the native compiler miscompiles the stage1 compiler, you may
2939 need to work around this by avoiding non-working parts of the stage1
2940 compiler.  Use @code{STAGE1_TFLAGS} to this end.
2942 If you used the flag @option{--enable-languages=@dots{}} to restrict
2943 the compilers to be built, only those you've actually enabled will be
2944 built.  This will of course only build those runtime libraries, for
2945 which the particular compiler has been built.  Please note,
2946 that re-defining @env{LANGUAGES} when calling @samp{make}
2947 @strong{does not} work anymore!
2949 If the comparison of stage2 and stage3 fails, this normally indicates
2950 that the stage2 compiler has compiled GCC incorrectly, and is therefore
2951 a potentially serious bug which you should investigate and report.  (On
2952 a few systems, meaningful comparison of object files is impossible; they
2953 always appear ``different''.  If you encounter this problem, you will
2954 need to disable comparison in the @file{Makefile}.)
2956 If you do not want to bootstrap your compiler, you can configure with
2957 @option{--disable-bootstrap}.  In particular cases, you may want to
2958 bootstrap your compiler even if the target system is not the same as
2959 the one you are building on: for example, you could build a
2960 @code{powerpc-unknown-linux-gnu} toolchain on a
2961 @code{powerpc64-unknown-linux-gnu} host.  In this case, pass
2962 @option{--enable-bootstrap} to the configure script.
2964 @code{BUILD_CONFIG} can be used to bring in additional customization
2965 to the build.  It can be set to a whitespace-separated list of names.
2966 For each such @code{NAME}, top-level @file{config/@code{NAME}.mk} will
2967 be included by the top-level @file{Makefile}, bringing in any settings
2968 it contains.  The default @code{BUILD_CONFIG} can be set using the
2969 configure option @option{--with-build-config=@code{NAME}...}.  Some
2970 examples of supported build configurations are:
2972 @table @asis
2973 @item @samp{bootstrap-O1}
2974 Removes any @option{-O}-started option from @code{BOOT_CFLAGS}, and adds
2975 @option{-O1} to it.  @samp{BUILD_CONFIG=bootstrap-O1} is equivalent to
2976 @samp{BOOT_CFLAGS='-g -O1'}.
2978 @item @samp{bootstrap-O3}
2979 @itemx @samp{bootstrap-Og}
2980 Analogous to @code{bootstrap-O1}.
2982 @item @samp{bootstrap-lto}
2983 Enables Link-Time Optimization for host tools during bootstrapping.
2984 @samp{BUILD_CONFIG=bootstrap-lto} is equivalent to adding
2985 @option{-flto} to @samp{BOOT_CFLAGS}.  This option assumes that the host
2986 supports the linker plugin (e.g.@: GNU ld version 2.21 or later or GNU gold
2987 version 2.21 or later).
2989 @item @samp{bootstrap-lto-noplugin}
2990 This option is similar to @code{bootstrap-lto}, but is intended for
2991 hosts that do not support the linker plugin.  Without the linker plugin 
2992 static libraries are not compiled with link-time optimizations.  Since 
2993 the GCC middle end and back end are in @file{libbackend.a} this means
2994 that only the front end is actually LTO optimized.
2996 @item @samp{bootstrap-lto-lean}
2997 This option is similar to @code{bootstrap-lto}, but is intended for
2998 faster build by only using LTO in the final bootstrap stage.
2999 With @samp{make profiledbootstrap} the LTO frontend
3000 is trained only on generator files.
3002 @item @samp{bootstrap-debug}
3003 Verifies that the compiler generates the same executable code, whether
3004 or not it is asked to emit debug information.  To this end, this
3005 option builds stage2 host programs without debug information, and uses
3006 @file{contrib/compare-debug} to compare them with the stripped stage3
3007 object files.  If @code{BOOT_CFLAGS} is overridden so as to not enable
3008 debug information, stage2 will have it, and stage3 won't.  This option
3009 is enabled by default when GCC bootstrapping is enabled, if
3010 @code{strip} can turn object files compiled with and without debug
3011 info into identical object files.  In addition to better test
3012 coverage, this option makes default bootstraps faster and leaner.
3014 @item @samp{bootstrap-debug-big}
3015 Rather than comparing stripped object files, as in
3016 @code{bootstrap-debug}, this option saves internal compiler dumps
3017 during stage2 and stage3 and compares them as well, which helps catch
3018 additional potential problems, but at a great cost in terms of disk
3019 space.  It can be specified in addition to @samp{bootstrap-debug}.
3021 @item @samp{bootstrap-debug-lean}
3022 This option saves disk space compared with @code{bootstrap-debug-big},
3023 but at the expense of some recompilation.  Instead of saving the dumps
3024 of stage2 and stage3 until the final compare, it uses
3025 @option{-fcompare-debug} to generate, compare and remove the dumps
3026 during stage3, repeating the compilation that already took place in
3027 stage2, whose dumps were not saved.
3029 @item @samp{bootstrap-debug-lib}
3030 This option tests executable code invariance over debug information
3031 generation on target libraries, just like @code{bootstrap-debug-lean}
3032 tests it on host programs.  It builds stage3 libraries with
3033 @option{-fcompare-debug}, and it can be used along with any of the
3034 @code{bootstrap-debug} options above.
3036 There aren't @code{-lean} or @code{-big} counterparts to this option
3037 because most libraries are only build in stage3, so bootstrap compares
3038 would not get significant coverage.  Moreover, the few libraries built
3039 in stage2 are used in stage3 host programs, so we wouldn't want to
3040 compile stage2 libraries with different options for comparison purposes.
3042 @item @samp{bootstrap-debug-ckovw}
3043 Arranges for error messages to be issued if the compiler built on any
3044 stage is run without the option @option{-fcompare-debug}.  This is
3045 useful to verify the full @option{-fcompare-debug} testing coverage.  It
3046 must be used along with @code{bootstrap-debug-lean} and
3047 @code{bootstrap-debug-lib}.
3049 @item @samp{bootstrap-cet}
3050 This option enables Intel CET for host tools during bootstrapping.
3051 @samp{BUILD_CONFIG=bootstrap-cet} is equivalent to adding
3052 @option{-fcf-protection} to @samp{BOOT_CFLAGS}.  This option
3053 assumes that the host supports Intel CET (e.g.@: GNU assembler version
3054 2.30 or later).
3056 @item @samp{bootstrap-time}
3057 Arranges for the run time of each program started by the GCC driver,
3058 built in any stage, to be logged to @file{time.log}, in the top level of
3059 the build tree.
3061 @item @samp{bootstrap-asan}
3062 Compiles GCC itself using Address Sanitization in order to catch invalid memory
3063 accesses within the GCC code.
3065 @item @samp{bootstrap-hwasan}
3066 Compiles GCC itself using HWAddress Sanitization in order to catch invalid
3067 memory accesses within the GCC code.  This option is only available on AArch64
3068 systems that are running Linux kernel version 5.4 or later.
3070 @end table
3072 @section Building a cross compiler
3074 When building a cross compiler, it is not generally possible to do a
3075 3-stage bootstrap of the compiler.  This makes for an interesting problem
3076 as parts of GCC can only be built with GCC@.
3078 To build a cross compiler, we recommend first building and installing a
3079 native compiler.  You can then use the native GCC compiler to build the
3080 cross compiler.  The installed native compiler needs to be GCC version
3081 2.95 or later.
3083 Assuming you have already installed a native copy of GCC and configured
3084 your cross compiler, issue the command @command{make}, which performs the
3085 following steps:
3087 @itemize @bullet
3088 @item
3089 Build host tools necessary to build the compiler.
3091 @item
3092 Build target tools for use by the compiler such as binutils (bfd,
3093 binutils, gas, gprof, ld, and opcodes)
3094 if they have been individually linked or moved into the top level GCC source
3095 tree before configuring.
3097 @item
3098 Build the compiler (single stage only).
3100 @item
3101 Build runtime libraries using the compiler from the previous step.
3102 @end itemize
3104 Note that if an error occurs in any step the make process will exit.
3106 If you are not building GNU binutils in the same source tree as GCC,
3107 you will need a cross-assembler and cross-linker installed before
3108 configuring GCC@.  Put them in the directory
3109 @file{@var{prefix}/@var{target}/bin}.  Here is a table of the tools
3110 you should put in this directory:
3112 @table @file
3113 @item as
3114 This should be the cross-assembler.
3116 @item ld
3117 This should be the cross-linker.
3119 @item ar
3120 This should be the cross-archiver: a program which can manipulate
3121 archive files (linker libraries) in the target machine's format.
3123 @item ranlib
3124 This should be a program to construct a symbol table in an archive file.
3125 @end table
3127 The installation of GCC will find these programs in that directory,
3128 and copy or link them to the proper place to for the cross-compiler to
3129 find them when run later.
3131 The easiest way to provide these files is to build the Binutils package.
3132 Configure it with the same @option{--host} and @option{--target}
3133 options that you use for configuring GCC, then build and install
3134 them.  They install their executables automatically into the proper
3135 directory.  Alas, they do not support all the targets that GCC
3136 supports.
3138 If you are not building a C library in the same source tree as GCC,
3139 you should also provide the target libraries and headers before
3140 configuring GCC, specifying the directories with
3141 @option{--with-sysroot} or @option{--with-headers} and
3142 @option{--with-libs}.  Many targets also require ``start files'' such
3143 as @file{crt0.o} and
3144 @file{crtn.o} which are linked into each executable.  There may be several
3145 alternatives for @file{crt0.o}, for use with profiling or other
3146 compilation options.  Check your target's definition of
3147 @code{STARTFILE_SPEC} to find out what start files it uses.
3149 @section Building in parallel
3151 GNU Make 3.80 and above, which is necessary to build GCC, support
3152 building in parallel.  To activate this, you can use @samp{make -j 2}
3153 instead of @samp{make}.  You can also specify a bigger number, and
3154 in most cases using a value greater than the number of processors in
3155 your machine will result in fewer and shorter I/O latency hits, thus
3156 improving overall throughput; this is especially true for slow drives
3157 and network filesystems.
3159 @section Building the Ada compiler
3161 @ifnothtml
3162 @ref{GNAT-prerequisite}.
3163 @end ifnothtml
3164 @ifhtml
3165 @uref{prerequisites.html#GNAT-prerequisite,,GNAT prerequisites}.
3166 @end ifhtml
3168 @section Building the D compiler
3170 @ifnothtml
3171 @ref{GDC-prerequisite}.
3172 @end ifnothtml
3173 @ifhtml
3174 @uref{prerequisites.html#GDC-prerequisite,,GDC prerequisites}.
3175 @end ifhtml
3177 @section Building with profile feedback
3179 It is possible to use profile feedback to optimize the compiler itself.  This
3180 should result in a faster compiler binary.  Experiments done on x86 using gcc
3181 3.3 showed approximately 7 percent speedup on compiling C programs.  To
3182 bootstrap the compiler with profile feedback, use @code{make profiledbootstrap}.
3184 When @samp{make profiledbootstrap} is run, it will first build a @code{stage1}
3185 compiler.  This compiler is used to build a @code{stageprofile} compiler
3186 instrumented to collect execution counts of instruction and branch
3187 probabilities.  Training run is done by building @code{stagetrain}
3188 compiler.  Finally a @code{stagefeedback} compiler is built
3189 using the information collected.
3191 Unlike standard bootstrap, several additional restrictions apply.  The
3192 compiler used to build @code{stage1} needs to support a 64-bit integral type.
3193 It is recommended to only use GCC for this.
3195 On Linux/x86_64 hosts with some restrictions (no virtualization) it is
3196 also possible to do autofdo build with @samp{make
3197 autoprofiledbootstrap}. This uses Linux perf to sample branches in the
3198 binary and then rebuild it with feedback derived from the profile.
3199 Linux perf and the @code{autofdo} toolkit needs to be installed for
3200 this.
3202 Only the profile from the current build is used, so when an error
3203 occurs it is recommended to clean before restarting. Otherwise
3204 the code quality may be much worse.
3206 @html
3207 <hr />
3209 @end html
3210 @ifhtml
3211 @uref{./index.html,,Return to the GCC Installation page}
3212 @end ifhtml
3213 @end ifset
3215 @c ***Testing*****************************************************************
3216 @ifnothtml
3217 @comment node-name,     next,          previous, up
3218 @node    Testing, Final install, Building, Installing GCC
3219 @end ifnothtml
3220 @ifset testhtml
3221 @ifnothtml
3222 @chapter Installing GCC: Testing
3223 @end ifnothtml
3224 @cindex Testing
3225 @cindex Installing GCC: Testing
3226 @cindex Testsuite
3228 Before you install GCC, we encourage you to run the testsuites and to
3229 compare your results with results from a similar configuration that have
3230 been submitted to the
3231 @uref{https://gcc.gnu.org/ml/gcc-testresults/,,gcc-testresults mailing list}.
3232 Some of these archived results are linked from the build status lists
3233 at @uref{https://gcc.gnu.org/buildstat.html}, although not everyone who
3234 reports a successful build runs the testsuites and submits the results.
3235 This step is optional and may require you to download additional software,
3236 but it can give you confidence in your new GCC installation or point out
3237 problems before you install and start using your new GCC@.
3239 First, you must have @uref{download.html,,downloaded the testsuites}.
3240 These are included in the source tarball.
3242 Second, you must have the testing tools installed.  This includes
3243 @uref{https://www.gnu.org/software/dejagnu/,,DejaGnu}, Tcl, and Expect;
3244 the DejaGnu site has links to these.
3245 Some optional tests also require Python3 and pytest module.
3247 If the directories where @command{runtest} and @command{expect} were
3248 installed are not in the @env{PATH}, you may need to set the following
3249 environment variables appropriately, as in the following example (which
3250 assumes that DejaGnu has been installed under @file{/usr/local}):
3252 @smallexample
3253 TCL_LIBRARY = /usr/local/share/tcl8.0
3254 DEJAGNULIBS = /usr/local/share/dejagnu
3255 @end smallexample
3257 (On systems such as Cygwin, these paths are required to be actual
3258 paths, not mounts or links; presumably this is due to some lack of
3259 portability in the DejaGnu code.)
3262 Finally, you can run the testsuite (which may take a long time):
3263 @smallexample
3264 cd @var{objdir}; make -k check
3265 @end smallexample
3267 This will test various components of GCC, such as compiler
3268 front ends and runtime libraries.  While running the testsuite, DejaGnu
3269 might emit some harmless messages resembling
3270 @samp{WARNING: Couldn't find the global config file.} or
3271 @samp{WARNING: Couldn't find tool init file} that can be ignored.
3273 If you are testing a cross-compiler, you may want to run the testsuite
3274 on a simulator as described at @uref{https://gcc.gnu.org/simtest-howto.html}.
3276 @section How can you run the testsuite on selected tests?
3278 In order to run sets of tests selectively, there are targets
3279 @samp{make check-gcc} and language specific @samp{make check-c},
3280 @samp{make check-c++}, @samp{make check-d} @samp{make check-fortran},
3281 @samp{make check-ada}, @samp{make check-m2}, @samp{make check-objc},
3282 @samp{make check-obj-c++}, @samp{make check-lto} in the @file{gcc}
3283 subdirectory of the object directory.  You can also just run
3284 @samp{make check} in a subdirectory of the object directory.
3287 A more selective way to just run all @command{gcc} execute tests in the
3288 testsuite is to use
3290 @smallexample
3291 make check-gcc RUNTESTFLAGS="execute.exp @var{other-options}"
3292 @end smallexample
3294 Likewise, in order to run only the @command{g++} ``old-deja'' tests in
3295 the testsuite with filenames matching @samp{9805*}, you would use
3297 @smallexample
3298 make check-g++ RUNTESTFLAGS="old-deja.exp=9805* @var{other-options}"
3299 @end smallexample
3301 The file-matching expression following @var{filename}@command{.exp=} is treated
3302 as a series of whitespace-delimited glob expressions so that multiple patterns
3303 may be passed, although any whitespace must either be escaped or surrounded by
3304 single quotes if multiple expressions are desired. For example,
3306 @smallexample
3307 make check-g++ RUNTESTFLAGS="old-deja.exp=9805*\ virtual2.c @var{other-options}"
3308 make check-g++ RUNTESTFLAGS="'old-deja.exp=9805* virtual2.c' @var{other-options}"
3309 @end smallexample
3311 The @file{*.exp} files are located in the testsuite directories of the GCC
3312 source, the most important ones being @file{compile.exp},
3313 @file{execute.exp}, @file{dg.exp} and @file{old-deja.exp}.
3314 To get a list of the possible @file{*.exp} files, pipe the
3315 output of @samp{make check} into a file and look at the
3316 @samp{Running @dots{}  .exp} lines.
3318 @section Passing options and running multiple testsuites
3320 You can pass multiple options to the testsuite using the
3321 @samp{--target_board} option of DejaGNU, either passed as part of
3322 @samp{RUNTESTFLAGS}, or directly to @command{runtest} if you prefer to
3323 work outside the makefiles.  For example,
3325 @smallexample
3326 make check-g++ RUNTESTFLAGS="--target_board=unix/-O3/-fmerge-constants"
3327 @end smallexample
3329 will run the standard @command{g++} testsuites (``unix'' is the target name
3330 for a standard native testsuite situation), passing
3331 @samp{-O3 -fmerge-constants} to the compiler on every test, i.e.,
3332 slashes separate options.
3334 You can run the testsuites multiple times using combinations of options
3335 with a syntax similar to the brace expansion of popular shells:
3337 @smallexample
3338 @dots{}"--target_board=arm-sim\@{-mhard-float,-msoft-float\@}\@{-O1,-O2,-O3,\@}"
3339 @end smallexample
3341 (Note the empty option caused by the trailing comma in the final group.)
3342 The following will run each testsuite eight times using the @samp{arm-sim}
3343 target, as if you had specified all possible combinations yourself:
3345 @smallexample
3346 --target_board='arm-sim/-mhard-float/-O1 \
3347                 arm-sim/-mhard-float/-O2 \
3348                 arm-sim/-mhard-float/-O3 \
3349                 arm-sim/-mhard-float \
3350                 arm-sim/-msoft-float/-O1 \
3351                 arm-sim/-msoft-float/-O2 \
3352                 arm-sim/-msoft-float/-O3 \
3353                 arm-sim/-msoft-float'
3354 @end smallexample
3356 They can be combined as many times as you wish, in arbitrary ways.  This
3357 list:
3359 @smallexample
3360 @dots{}"--target_board=unix/-Wextra\@{-O3,-fno-strength\@}\@{-fomit-frame,\@}"
3361 @end smallexample
3363 will generate four combinations, all involving @samp{-Wextra}.
3365 The disadvantage to this method is that the testsuites are run in serial,
3366 which is a waste on multiprocessor systems.  For users with GNU Make and
3367 a shell which performs brace expansion, you can run the testsuites in
3368 parallel by having the shell perform the combinations and @command{make}
3369 do the parallel runs.  Instead of using @samp{--target_board}, use a
3370 special makefile target:
3372 @smallexample
3373 make -j@var{N} check-@var{testsuite}//@var{test-target}/@var{option1}/@var{option2}/@dots{}
3374 @end smallexample
3376 For example,
3378 @smallexample
3379 make -j3 check-gcc//sh-hms-sim/@{-m1,-m2,-m3,-m3e,-m4@}/@{,-nofpu@}
3380 @end smallexample
3382 will run three concurrent ``make-gcc'' testsuites, eventually testing all
3383 ten combinations as described above.  Note that this is currently only
3384 supported in the @file{gcc} subdirectory.  (To see how this works, try
3385 typing @command{echo} before the example given here.)
3388 @section How to interpret test results
3390 The result of running the testsuite are various @file{*.sum} and @file{*.log}
3391 files in the testsuite subdirectories.  The @file{*.log} files contain a
3392 detailed log of the compiler invocations and the corresponding
3393 results, the @file{*.sum} files summarize the results.  These summaries
3394 contain status codes for all tests:
3396 @itemize @bullet
3397 @item
3398 PASS: the test passed as expected
3399 @item
3400 XPASS: the test unexpectedly passed
3401 @item
3402 FAIL: the test unexpectedly failed
3403 @item
3404 XFAIL: the test failed as expected
3405 @item
3406 UNSUPPORTED: the test is not supported on this platform
3407 @item
3408 ERROR: the testsuite detected an error
3409 @item
3410 WARNING: the testsuite detected a possible problem
3411 @end itemize
3413 It is normal for some tests to report unexpected failures.  At the
3414 current time the testing harness does not allow fine grained control
3415 over whether or not a test is expected to fail.  This problem should
3416 be fixed in future releases.
3419 @section Submitting test results
3421 If you want to report the results to the GCC project, use the
3422 @file{contrib/test_summary} shell script.  Start it in the @var{objdir} with
3424 @smallexample
3425 @var{srcdir}/contrib/test_summary -p your_commentary.txt \
3426     -m gcc-testresults@@gcc.gnu.org |sh
3427 @end smallexample
3429 This script uses the @command{Mail} program to send the results, so
3430 make sure it is in your @env{PATH}.  The file @file{your_commentary.txt} is
3431 prepended to the testsuite summary and should contain any special
3432 remarks you have on your results or your build environment.  Please
3433 do not edit the testsuite result block or the subject line, as these
3434 messages may be automatically processed.
3436 @html
3437 <hr />
3439 @end html
3440 @ifhtml
3441 @uref{./index.html,,Return to the GCC Installation page}
3442 @end ifhtml
3443 @end ifset
3445 @c ***Final install***********************************************************
3446 @ifnothtml
3447 @comment node-name,     next,          previous, up
3448 @node    Final install, , Testing, Installing GCC
3449 @end ifnothtml
3450 @ifset finalinstallhtml
3451 @ifnothtml
3452 @chapter Installing GCC: Final installation
3453 @end ifnothtml
3455 Now that GCC has been built (and optionally tested), you can install it with
3456 @smallexample
3457 cd @var{objdir} && make install
3458 @end smallexample
3460 We strongly recommend to install into a target directory where there is
3461 no previous version of GCC present.  Also, the GNAT runtime should not
3462 be stripped, as this would break certain features of the debugger that
3463 depend on this debugging information (catching Ada exceptions for
3464 instance).
3466 That step completes the installation of GCC; user level binaries can
3467 be found in @file{@var{prefix}/bin} where @var{prefix} is the value
3468 you specified with the @option{--prefix} to configure (or
3469 @file{/usr/local} by default).  (If you specified @option{--bindir},
3470 that directory will be used instead; otherwise, if you specified
3471 @option{--exec-prefix}, @file{@var{exec-prefix}/bin} will be used.)
3472 Headers for the C++ library are installed in
3473 @file{@var{prefix}/include}; libraries in @file{@var{libdir}}
3474 (normally @file{@var{prefix}/lib}); internal parts of the compiler in
3475 @file{@var{libdir}/gcc} and @file{@var{libexecdir}/gcc}; documentation
3476 in info format in @file{@var{infodir}} (normally
3477 @file{@var{prefix}/info}).
3479 When installing cross-compilers, GCC's executables
3480 are not only installed into @file{@var{bindir}}, that
3481 is, @file{@var{exec-prefix}/bin}, but additionally into
3482 @file{@var{exec-prefix}/@var{target-alias}/bin}, if that directory
3483 exists.  Typically, such @dfn{tooldirs} hold target-specific
3484 binutils, including assembler and linker.
3486 Installation into a temporary staging area or into a @command{chroot}
3487 jail can be achieved with the command
3489 @smallexample
3490 make DESTDIR=@var{path-to-rootdir} install
3491 @end smallexample
3493 @noindent
3494 where @var{path-to-rootdir} is the absolute path of
3495 a directory relative to which all installation paths will be
3496 interpreted.  Note that the directory specified by @code{DESTDIR}
3497 need not exist yet; it will be created if necessary.
3499 There is a subtle point with tooldirs and @code{DESTDIR}:
3500 If you relocate a cross-compiler installation with
3501 e.g.@: @samp{DESTDIR=@var{rootdir}}, then the directory
3502 @file{@var{rootdir}/@var{exec-prefix}/@var{target-alias}/bin} will
3503 be filled with duplicated GCC executables only if it already exists,
3504 it will not be created otherwise.  This is regarded as a feature,
3505 not as a bug, because it gives slightly more control to the packagers
3506 using the @code{DESTDIR} feature.
3508 You can install stripped programs and libraries with
3510 @smallexample
3511 make install-strip
3512 @end smallexample
3514 By default, only the man pages and info-format GCC documentation
3515 are built and installed.  If you want to generate the GCC manuals in
3516 other formats, use commands like
3518 @smallexample
3519 make dvi
3520 make pdf
3521 make html
3522 @end smallexample
3524 @noindent
3525 to build the manuals in the corresponding formats, and
3527 @smallexample
3528 make install-dvi
3529 make install-pdf
3530 make install-html
3531 @end smallexample
3533 @noindent
3534 to install them.
3535 Alternatively, there are prebuilt online versions of the manuals for
3536 released versions of GCC on
3537 @uref{https://gcc.gnu.org/onlinedocs/,,the GCC web site}.
3539 If you are bootstrapping a released version of GCC then please
3540 quickly review the build status page for your release, available from
3541 @uref{https://gcc.gnu.org/buildstat.html}.
3542 If your system is not listed for the version of GCC that you built,
3543 send a note to
3544 @email{gcc@@gcc.gnu.org} indicating
3545 that you successfully built and installed GCC@.
3546 Include the following information:
3548 @itemize @bullet
3549 @item
3550 Output from running @file{@var{srcdir}/config.guess}.  Do not send
3551 that file itself, just the one-line output from running it.
3553 @item
3554 The output of @samp{gcc -v} for your newly installed @command{gcc}.
3555 This tells us which version of GCC you built and the options you passed to
3556 configure.
3558 @item
3559 If the build was for GNU/Linux, also include:
3560 @itemize @bullet
3561 @item
3562 The distribution name and version (e.g., Red Hat 7.1 or Debian 2.2.3);
3563 this information should be available from @file{/etc/issue}.
3565 @item
3566 The version of the Linux kernel, available from @samp{uname --version}
3567 or @samp{uname -a}.
3569 @item
3570 The version of glibc you used; for RPM-based systems like Red Hat,
3571 Mandrake, and SuSE type @samp{rpm -q glibc} to get the glibc version,
3572 and on systems like Debian and Progeny use @samp{dpkg -l libc6}.
3573 @end itemize
3574 For other systems, you can include similar information if you think it is
3575 relevant.
3577 @item
3578 Any other information that you think would be useful to people building
3579 GCC on the same configuration.  The new entry in the build status list
3580 will include a link to the archived copy of your message.
3581 @end itemize
3583 We'd also like to know if the
3584 @ifnothtml
3585 @ref{Specific, host/target specific installation notes}
3586 @end ifnothtml
3587 @ifhtml
3588 @uref{specific.html,,host/target specific installation notes}
3589 @end ifhtml
3590 didn't include your host/target information or if that information is
3591 incomplete or out of date.  Send a note to
3592 @email{gcc@@gcc.gnu.org} detailing how the information should be changed.
3594 If you find a bug, please report it following the
3595 @uref{../bugs/,,bug reporting guidelines}.
3597 @html
3598 <hr />
3600 @end html
3601 @ifhtml
3602 @uref{./index.html,,Return to the GCC Installation page}
3603 @end ifhtml
3604 @end ifset
3606 @c ***Binaries****************************************************************
3607 @ifnothtml
3608 @comment node-name,     next,          previous, up
3609 @node    Binaries, Specific, Installing GCC, Top
3610 @end ifnothtml
3611 @ifset binarieshtml
3612 @ifnothtml
3613 @chapter Installing GCC: Binaries
3614 @end ifnothtml
3615 @cindex Binaries
3616 @cindex Installing GCC: Binaries
3618 We are often asked about pre-compiled versions of GCC@.  While we cannot
3619 provide these for all platforms, below you'll find links to binaries for
3620 various platforms where creating them by yourself is not easy due to various
3621 reasons.
3623 Please note that we did not create these binaries, nor do we
3624 support them.  If you have any problems installing them, please
3625 contact their makers.
3627 @itemize
3628 @item
3629 AIX:
3630 @itemize
3631 @item
3632 @uref{http://www.perzl.org/aix/,,AIX Open Source Packages (AIX5L AIX 6.1
3633 AIX 7.1)}.
3634 @end itemize
3636 @item
3637 DOS---@uref{http://www.delorie.com/djgpp/,,DJGPP}.
3639 @item
3640 HP-UX:
3641 @itemize
3642 @item
3643 @uref{http://hpux.connect.org.uk/,,HP-UX Porting Center};
3644 @end itemize
3646 @item
3647 macOS:
3648 @itemize
3649 @item
3650 The @uref{https://brew.sh,,Homebrew} package manager;
3651 @item
3652 @uref{https://www.macports.org,,MacPorts}.
3653 @end itemize
3655 @item
3656 Microsoft Windows:
3657 @itemize
3658 @item
3659 The @uref{https://sourceware.org/cygwin/,,Cygwin} project;
3660 @item
3661 The @uref{https://osdn.net/projects/mingw/,,MinGW} and
3662 @uref{https://www.mingw-w64.org/,,mingw-w64} projects.
3663 @end itemize
3665 @item
3666 @uref{http://www.openpkg.org/,,OpenPKG} offers binaries for quite a
3667 number of platforms.
3669 @item
3670 The @uref{https://gcc.gnu.org/wiki/GFortranBinaries,,GFortran Wiki} has
3671 links to GNU Fortran binaries for several platforms.
3672 @end itemize
3674 @html
3675 <hr />
3677 @end html
3678 @ifhtml
3679 @uref{./index.html,,Return to the GCC Installation page}
3680 @end ifhtml
3681 @end ifset
3683 @c ***Specific****************************************************************
3684 @ifnothtml
3685 @comment node-name,     next,          previous, up
3686 @node    Specific, GNU Free Documentation License, Binaries, Top
3687 @end ifnothtml
3688 @ifset specifichtml
3689 @ifnothtml
3690 @chapter Host/target specific installation notes for GCC
3691 @end ifnothtml
3692 @cindex Specific
3693 @cindex Specific installation notes
3694 @cindex Target specific installation
3695 @cindex Host specific installation
3696 @cindex Target specific installation notes
3698 Please read this document carefully @emph{before} installing the
3699 GNU Compiler Collection on your machine.
3701 Note that this list of install notes is @emph{not} a list of supported
3702 hosts or targets.  Not all supported hosts and targets are listed
3703 here, only the ones that require host-specific or target-specific
3704 information have to. 
3706 @ifhtml
3707 @itemize
3708 @item
3709 @uref{#aarch64-x-x,,aarch64*-*-*}
3710 @item
3711 @uref{#amdgcn-x-amdhsa,,amdgcn-*-amdhsa}
3712 @item
3713 @uref{#amd64-x-solaris2,,amd64-*-solaris2*}
3714 @item
3715 @uref{#arc-x-elf32,,arc-*-elf32}
3716 @item
3717 @uref{#arc-linux-uclibc,,arc-linux-uclibc}
3718 @item
3719 @uref{#arm-x-eabi,,arm-*-eabi}
3720 @item
3721 @uref{#avr,,avr}
3722 @item
3723 @uref{#bfin,,Blackfin}
3724 @item
3725 @uref{#cris,,cris}
3726 @item
3727 @uref{#dos,,DOS}
3728 @item
3729 @uref{#epiphany-x-elf,,epiphany-*-elf}
3730 @item
3731 @uref{#ft32-x-elf,,ft32-*-elf}
3732 @item
3733 @uref{#x-x-freebsd,,*-*-freebsd*}
3734 @item
3735 @uref{#h8300-hms,,h8300-hms}
3736 @item
3737 @uref{#hppa-hp-hpux,,hppa*-hp-hpux*}
3738 @item
3739 @uref{#hppa-hp-hpux10,,hppa*-hp-hpux10}
3740 @item
3741 @uref{#hppa-hp-hpux11,,hppa*-hp-hpux11}
3742 @item
3743 @uref{#x-x-linux-gnu,,*-*-linux-gnu}
3744 @item
3745 @uref{#ix86-x-linux,,i?86-*-linux*}
3746 @item
3747 @uref{#ix86-x-solaris2,,i?86-*-solaris2*}
3748 @item
3749 @uref{#ia64-x-linux,,ia64-*-linux}
3750 @item
3751 @uref{#ia64-x-hpux,,ia64-*-hpux*}
3752 @item
3753 @uref{#x-ibm-aix,,*-ibm-aix*}
3754 @item
3755 @uref{#iq2000-x-elf,,iq2000-*-elf}
3756 @item
3757 @uref{#loongarch,,loongarch}
3758 @item
3759 @uref{#lm32-x-elf,,lm32-*-elf}
3760 @item
3761 @uref{#lm32-x-uclinux,,lm32-*-uclinux}
3762 @item
3763 @uref{#m32c-x-elf,,m32c-*-elf}
3764 @item
3765 @uref{#m32r-x-elf,,m32r-*-elf}
3766 @item
3767 @uref{#m68k-x-x,,m68k-*-*}
3768 @item
3769 @uref{#m68k-x-uclinux,,m68k-*-uclinux}
3770 @item
3771 @uref{#microblaze-x-elf,,microblaze-*-elf}
3772 @item
3773 @uref{#mips-x-x,,mips-*-*}
3774 @item
3775 @uref{#moxie-x-elf,,moxie-*-elf}
3776 @item
3777 @uref{#msp430-x-elf,,msp430-*-elf}
3778 @item
3779 @uref{#nds32le-x-elf,,nds32le-*-elf}
3780 @item
3781 @uref{#nds32be-x-elf,,nds32be-*-elf}
3782 @item
3783 @uref{#nvptx-x-none,,nvptx-*-none}
3784 @item
3785 @uref{#or1k-x-elf,,or1k-*-elf}
3786 @item
3787 @uref{#or1k-x-linux,,or1k-*-linux}
3788 @item
3789 @uref{#powerpc-x-x,,powerpc*-*-*}
3790 @item
3791 @uref{#powerpc-x-darwin,,powerpc-*-darwin*}
3792 @item
3793 @uref{#powerpc-x-elf,,powerpc-*-elf}
3794 @item
3795 @uref{#powerpc-x-linux-gnu,,powerpc*-*-linux-gnu*}
3796 @item
3797 @uref{#powerpc-x-netbsd,,powerpc-*-netbsd*}
3798 @item
3799 @uref{#powerpc-x-eabisim,,powerpc-*-eabisim}
3800 @item
3801 @uref{#powerpc-x-eabi,,powerpc-*-eabi}
3802 @item
3803 @uref{#powerpcle-x-elf,,powerpcle-*-elf}
3804 @item
3805 @uref{#powerpcle-x-eabisim,,powerpcle-*-eabisim}
3806 @item
3807 @uref{#powerpcle-x-eabi,,powerpcle-*-eabi}
3808 @item
3809 @uref{#riscv32-x-elf,,riscv32-*-elf}
3810 @item
3811 @uref{#riscv32-x-linux,,riscv32-*-linux}
3812 @item
3813 @uref{#riscv64-x-elf,,riscv64-*-elf}
3814 @item
3815 @uref{#riscv64-x-linux,,riscv64-*-linux}
3816 @item
3817 @uref{#rl78-x-elf,,rl78-*-elf}
3818 @item
3819 @uref{#rx-x-elf,,rx-*-elf}
3820 @item
3821 @uref{#s390-x-linux,,s390-*-linux*}
3822 @item
3823 @uref{#s390x-x-linux,,s390x-*-linux*}
3824 @item
3825 @uref{#s390x-ibm-tpf,,s390x-ibm-tpf*}
3826 @item
3827 @uref{#x-x-solaris2,,*-*-solaris2*}
3828 @item
3829 @uref{#sparc-x-x,,sparc*-*-*}
3830 @item
3831 @uref{#sparc-sun-solaris2,,sparc-sun-solaris2*}
3832 @item
3833 @uref{#sparc-x-linux,,sparc-*-linux*}
3834 @item
3835 @uref{#sparc64-x-solaris2,,sparc64-*-solaris2*}
3836 @item
3837 @uref{#sparcv9-x-solaris2,,sparcv9-*-solaris2*}
3838 @item
3839 @uref{#c6x-x-x,,c6x-*-*}
3840 @item
3841 @uref{#visium-x-elf, visium-*-elf}
3842 @item
3843 @uref{#x-x-vxworks,,*-*-vxworks*}
3844 @item
3845 @uref{#x86-64-x-x,,x86_64-*-*, amd64-*-*}
3846 @item
3847 @uref{#x86-64-x-solaris2,,x86_64-*-solaris2*}
3848 @item
3849 @uref{#xtensa-x-elf,,xtensa*-*-elf}
3850 @item
3851 @uref{#xtensa-x-linux,,xtensa*-*-linux*}
3852 @item
3853 @uref{#windows,,Microsoft Windows}
3854 @item
3855 @uref{#x-x-cygwin,,*-*-cygwin}
3856 @item
3857 @uref{#x-x-mingw32,,*-*-mingw32}
3858 @item
3859 @uref{#os2,,OS/2}
3860 @item
3861 @uref{#older,,Older systems}
3862 @end itemize
3864 @itemize
3865 @item
3866 @uref{#elf,,all ELF targets} (SVR4, Solaris, etc.)
3867 @end itemize
3868 @end ifhtml
3871 @html
3872 <!-- -------- host/target specific issues start here ---------------- -->
3873 <hr />
3874 @end html
3875 @anchor{aarch64-x-x}
3876 @heading aarch64*-*-*
3877 Binutils pre 2.24 does not have support for selecting @option{-mabi} and
3878 does not support ILP32.  If it is used to build GCC 4.9 or later, GCC will
3879 not support option @option{-mabi=ilp32}.
3881 To enable a workaround for the Cortex-A53 erratum number 835769 by default
3882 (for all CPUs regardless of -mcpu option given) at configure time use the
3883 @option{--enable-fix-cortex-a53-835769} option.  This will enable the fix by
3884 default and can be explicitly disabled during compilation by passing the
3885 @option{-mno-fix-cortex-a53-835769} option.  Conversely,
3886 @option{--disable-fix-cortex-a53-835769} will disable the workaround by
3887 default.  The workaround is disabled by default if neither of
3888 @option{--enable-fix-cortex-a53-835769} or
3889 @option{--disable-fix-cortex-a53-835769} is given at configure time.
3891 To enable a workaround for the Cortex-A53 erratum number 843419 by default
3892 (for all CPUs regardless of -mcpu option given) at configure time use the
3893 @option{--enable-fix-cortex-a53-843419} option.  This workaround is applied at
3894 link time.  Enabling the workaround will cause GCC to pass the relevant option
3895 to the linker.  It can be explicitly disabled during compilation by passing the
3896 @option{-mno-fix-cortex-a53-843419} option.  Conversely,
3897 @option{--disable-fix-cortex-a53-843419} will disable the workaround by default.
3898 The workaround is disabled by default if neither of
3899 @option{--enable-fix-cortex-a53-843419} or
3900 @option{--disable-fix-cortex-a53-843419} is given at configure time.
3902 To enable Branch Target Identification Mechanism and Return Address Signing by
3903 default at configure time use the @option{--enable-standard-branch-protection}
3904 option.  This is equivalent to having @option{-mbranch-protection=standard}
3905 during compilation.  This can be explicitly disabled during compilation by
3906 passing the @option{-mbranch-protection=none} option which turns off all
3907 types of branch protections.  Conversely,
3908 @option{--disable-standard-branch-protection} will disable both the
3909 protections by default.  This mechanism is turned off by default if neither
3910 of the options are given at configure time.
3912 @html
3913 <hr />
3914 @end html
3915 @anchor{amd64-x-solaris2}
3916 @heading amd64-*-solaris2*
3917 This is a synonym for @samp{x86_64-*-solaris2*}.
3919 @html
3920 <hr />
3921 @end html
3922 @anchor{amdgcn-x-amdhsa}
3923 @heading amdgcn-*-amdhsa
3924 AMD GCN GPU target.
3926 Instead of GNU Binutils, you will need to install LLVM 13.0.1, or later, and copy
3927 @file{bin/llvm-mc} to @file{amdgcn-amdhsa/bin/as},
3928 @file{bin/lld} to @file{amdgcn-amdhsa/bin/ld},
3929 @file{bin/llvm-nm} to @file{amdgcn-amdhsa/bin/nm}, and
3930 @file{bin/llvm-ar} to both @file{bin/amdgcn-amdhsa-ar} and
3931 @file{bin/amdgcn-amdhsa-ranlib}.
3933 Use Newlib (4.3.0 or newer).
3935 To run the binaries, install the HSA Runtime from the
3936 @uref{https://rocm.github.io,,ROCm Platform}, and use
3937 @file{libexec/gcc/amdhsa-amdhsa/@var{version}/gcn-run} to launch them
3938 on the GPU.
3940 To enable support for GCN3 Fiji devices (gfx803), GCC has to be configured with
3941 @option{--with-arch=@code{fiji}} or
3942 @option{--with-multilib-list=@code{fiji},...}.  Note that support for Fiji
3943 devices has been removed in ROCm 4.0 and support in LLVM is deprecated and will
3944 be removed in the future.
3946 @html
3947 <hr />
3948 @end html
3949 @anchor{arc-x-elf32}
3950 @heading arc-*-elf32
3952 Use @samp{configure --target=arc-elf32 --with-cpu=@var{cpu} --enable-languages="c,c++"}
3953 to configure GCC, with @var{cpu} being one of @samp{arc600}, @samp{arc601},
3954 or @samp{arc700}@.
3956 @html
3957 <hr />
3958 @end html
3959 @anchor{arc-linux-uclibc}
3960 @heading arc-linux-uclibc
3962 Use @samp{configure --target=arc-linux-uclibc --with-cpu=arc700 --enable-languages="c,c++"} to configure GCC@.
3964 @html
3965 <hr />
3966 @end html
3967 @anchor{arm-x-eabi}
3968 @heading arm-*-eabi
3969 ARM-family processors.
3971 Building the Ada frontend commonly fails (an infinite loop executing
3972 @code{xsinfo}) if the host compiler is GNAT 4.8.  Host compilers built from the
3973 GNAT 4.6, 4.9 or 5 release branches are known to succeed.
3975 @html
3976 <hr />
3977 @end html
3978 @anchor{avr}
3979 @heading avr
3980 ATMEL AVR-family micro controllers.  These are used in embedded
3981 applications.  There are no standard Unix configurations.
3982 @ifnothtml
3983 @xref{AVR Options,, AVR Options, gcc, Using the GNU Compiler
3984 Collection (GCC)},
3985 @end ifnothtml
3986 @ifhtml
3987 See ``AVR Options'' in the main manual
3988 @end ifhtml
3989 for the list of supported MCU types.
3991 Use @samp{configure --target=avr --enable-languages="c"} to configure GCC@.
3993 Further installation notes and other useful information about AVR tools
3994 can also be obtained from:
3996 @itemize @bullet
3997 @item
3998 @uref{http://www.nongnu.org/avr/,,http://www.nongnu.org/avr/}
3999 @item
4000 @uref{http://www.amelek.gda.pl/avr/,,http://www.amelek.gda.pl/avr/}
4001 @end itemize
4003 The following error:
4004 @smallexample
4005 Error: register required
4006 @end smallexample
4008 indicates that you should upgrade to a newer version of the binutils.
4010 @html
4011 <hr />
4012 @end html
4013 @anchor{bfin}
4014 @heading Blackfin
4015 The Blackfin processor, an Analog Devices DSP.
4016 @ifnothtml
4017 @xref{Blackfin Options,, Blackfin Options, gcc, Using the GNU Compiler
4018 Collection (GCC)},
4019 @end ifnothtml
4020 @ifhtml
4021 See ``Blackfin Options'' in the main manual
4022 @end ifhtml
4024 More information, and a version of binutils with support for this processor,
4025 are available at @uref{https://sourceforge.net/projects/adi-toolchain/}.
4027 @html
4028 <hr />
4029 @end html
4030 @anchor{cris}
4031 @heading CRIS
4032 CRIS is a CPU architecture in Axis Communications systems-on-a-chip, for
4033 example the ETRAX series.  These are used in embedded applications.
4035 @ifnothtml
4036 @xref{CRIS Options,, CRIS Options, gcc, Using the GNU Compiler
4037 Collection (GCC)},
4038 @end ifnothtml
4039 @ifhtml
4040 See ``CRIS Options'' in the main manual
4041 @end ifhtml
4042 for a list of CRIS-specific options.
4044 Use @samp{configure --target=cris-elf} to configure GCC@ for building
4045 a cross-compiler for CRIS.
4046 @html
4047 <hr />
4048 @end html
4049 @anchor{dos}
4050 @heading DOS
4051 Please have a look at the @uref{binaries.html,,binaries page}.
4053 You cannot install GCC by itself on MSDOS; it will not compile under
4054 any MSDOS compiler except itself.  You need to get the complete
4055 compilation package DJGPP, which includes binaries as well as sources,
4056 and includes all the necessary compilation tools and libraries.
4058 @html
4059 <hr />
4060 @end html
4061 @anchor{epiphany-x-elf}
4062 @heading epiphany-*-elf
4063 Adapteva Epiphany.
4064 This configuration is intended for embedded systems.
4066 @html
4067 <hr />
4068 @end html
4069 @anchor{x-x-freebsd}
4070 @heading *-*-freebsd*
4071 In order to better utilize FreeBSD base system functionality and match
4072 the configuration of the system compiler, GCC 4.5 and above as well as
4073 GCC 4.4 past 2010-06-20 leverage SSP support in libc (which is present
4074 on FreeBSD 7 or later) and the use of @code{__cxa_atexit} by default
4075 (on FreeBSD 6 or later).  The use of @code{dl_iterate_phdr} inside
4076 @file{libgcc_s.so.1} and boehm-gc (on FreeBSD 7 or later) is enabled
4077 by GCC 4.5 and above.
4079 We support FreeBSD using the ELF file format with DWARF 2 debugging
4080 for all CPU architectures.  There are
4081 no known issues with mixing object files and libraries with different
4082 debugging formats.  Otherwise, this release of GCC should now match
4083 more of the configuration used in the stock FreeBSD configuration of
4084 GCC@.  In particular, @option{--enable-threads} is now configured by
4085 default.  However, as a general user, do not attempt to replace the
4086 system compiler with this release.  Known to bootstrap and check with
4087 good results on FreeBSD 7.2-STABLE@.  In the past, known to bootstrap
4088 and check with good results on FreeBSD 3.0, 3.4, 4.0, 4.2, 4.3, 4.4,
4089 4.5, 4.8, 4.9 and 5-CURRENT@.
4091 The version of binutils installed in @file{/usr/bin} probably works
4092 with this release of GCC@.  Bootstrapping against the latest GNU
4093 binutils and/or the version found in @file{/usr/ports/devel/binutils} has
4094 been known to enable additional features and improve overall testsuite
4095 results.  However, it is currently known that boehm-gc may not configure
4096 properly on FreeBSD prior to the FreeBSD 7.0 release with GNU binutils
4097 after 2.16.1.
4099 @html
4100 <hr />
4101 @end html
4102 @anchor{ft32-x-elf}
4103 @heading ft32-*-elf
4104 The FT32 processor.
4105 This configuration is intended for embedded systems.
4107 @html
4108 <hr />
4109 @end html
4110 @anchor{h8300-hms}
4111 @heading h8300-hms
4112 Renesas H8/300 series of processors.
4114 Please have a look at the @uref{binaries.html,,binaries page}.
4116 The calling convention and structure layout has changed in release 2.6.
4117 All code must be recompiled.  The calling convention now passes the
4118 first three arguments in function calls in registers.  Structures are no
4119 longer a multiple of 2 bytes.
4121 @html
4122 <hr />
4123 @end html
4124 @anchor{hppa-hp-hpux}
4125 @heading hppa*-hp-hpux*
4126 Support for HP-UX version 9 and older was discontinued in GCC 3.4.
4128 We require using gas/binutils on all hppa platforms.  Version 2.19 or
4129 later is recommended.
4131 It may be helpful to configure GCC with the
4132 @uref{./configure.html#with-gnu-as,,@option{--with-gnu-as}} and
4133 @option{--with-as=@dots{}} options to ensure that GCC can find GAS@.
4135 The HP assembler should not be used with GCC.  It is rarely tested and may
4136 not work.  It shouldn't be used with any languages other than C due to its
4137 many limitations.
4139 Specifically, @option{-g} does not work (HP-UX uses a peculiar debugging
4140 format which GCC does not know about).  It also inserts timestamps
4141 into each object file it creates, causing the 3-stage comparison test to
4142 fail during a bootstrap.  You should be able to continue by saying
4143 @samp{make all-host all-target} after getting the failure from @samp{make}.
4145 Various GCC features are not supported.  For example, it does not support weak
4146 symbols or alias definitions.  As a result, explicit template instantiations
4147 are required when using C++.  This makes it difficult if not impossible to
4148 build many C++ applications.
4150 There are two default scheduling models for instructions.  These are
4151 PROCESSOR_7100LC and PROCESSOR_8000.  They are selected from the pa-risc
4152 architecture specified for the target machine when configuring.
4153 PROCESSOR_8000 is the default.  PROCESSOR_7100LC is selected when
4154 the target is a @samp{hppa1*} machine.
4156 The PROCESSOR_8000 model is not well suited to older processors.  Thus,
4157 it is important to completely specify the machine architecture when
4158 configuring if you want a model other than PROCESSOR_8000.  The macro
4159 TARGET_SCHED_DEFAULT can be defined in BOOT_CFLAGS if a different
4160 default scheduling model is desired.
4162 As of GCC 4.0, GCC uses the UNIX 95 namespace for HP-UX 10.10
4163 through 11.00, and the UNIX 98 namespace for HP-UX 11.11 and later.
4164 This namespace change might cause problems when bootstrapping with
4165 an earlier version of GCC or the HP compiler as essentially the same
4166 namespace is required for an entire build.  This problem can be avoided
4167 in a number of ways.  With HP cc, @env{UNIX_STD} can be set to @samp{95}
4168 or @samp{98}.  Another way is to add an appropriate set of predefines
4169 to @env{CC}.  The description for the @option{munix=} option contains
4170 a list of the predefines used with each standard.
4172 More specific information to @samp{hppa*-hp-hpux*} targets follows.
4174 @html
4175 <hr />
4176 @end html
4177 @anchor{hppa-hp-hpux10}
4178 @heading hppa*-hp-hpux10
4179 For hpux10.20, we @emph{highly} recommend you pick up the latest sed patch
4180 @code{PHCO_19798} from HP@.
4182 The C++ ABI has changed incompatibly in GCC 4.0.  COMDAT subspaces are
4183 used for one-only code and data.  This resolves many of the previous
4184 problems in using C++ on this target.  However, the ABI is not compatible
4185 with the one implemented under HP-UX 11 using secondary definitions.
4187 @html
4188 <hr />
4189 @end html
4190 @anchor{hppa-hp-hpux11}
4191 @heading hppa*-hp-hpux11
4192 GCC 3.0 and up support HP-UX 11.  GCC 2.95.x is not supported and cannot
4193 be used to compile GCC 3.0 and up.
4195 The libffi library haven't been ported to 64-bit HP-UX@ and doesn't build.
4197 Refer to @uref{binaries.html,,binaries} for information about obtaining
4198 precompiled GCC binaries for HP-UX@.  Precompiled binaries must be obtained
4199 to build the Ada language as it cannot be bootstrapped using C@.  Ada is
4200 only available for the 32-bit PA-RISC runtime.
4202 Starting with GCC 3.4 an ISO C compiler is required to bootstrap.  The
4203 bundled compiler supports only traditional C; you will need either HP's
4204 unbundled compiler, or a binary distribution of GCC@.
4206 It is possible to build GCC 3.3 starting with the bundled HP compiler,
4207 but the process requires several steps.  GCC 3.3 can then be used to
4208 build later versions.
4210 There are several possible approaches to building the distribution.
4211 Binutils can be built first using the HP tools.  Then, the GCC
4212 distribution can be built.  The second approach is to build GCC
4213 first using the HP tools, then build binutils, then rebuild GCC@.
4214 There have been problems with various binary distributions, so it
4215 is best not to start from a binary distribution.
4217 On 64-bit capable systems, there are two distinct targets.  Different
4218 installation prefixes must be used if both are to be installed on
4219 the same system.  The @samp{hppa[1-2]*-hp-hpux11*} target generates code
4220 for the 32-bit PA-RISC runtime architecture and uses the HP linker.
4221 The @samp{hppa64-hp-hpux11*} target generates 64-bit code for the
4222 PA-RISC 2.0 architecture.
4224 The script config.guess now selects the target type based on the compiler
4225 detected during configuration.  You must define @env{PATH} or @env{CC} so
4226 that configure finds an appropriate compiler for the initial bootstrap.
4227 When @env{CC} is used, the definition should contain the options that are
4228 needed whenever @env{CC} is used.
4230 Specifically, options that determine the runtime architecture must be
4231 in @env{CC} to correctly select the target for the build.  It is also
4232 convenient to place many other compiler options in @env{CC}.  For example,
4233 @env{CC="cc -Ac +DA2.0W -Wp,-H16376 -D_CLASSIC_TYPES -D_HPUX_SOURCE"}
4234 can be used to bootstrap the GCC 3.3 branch with the HP compiler in
4235 64-bit K&R/bundled mode.  The @option{+DA2.0W} option will result in
4236 the automatic selection of the @samp{hppa64-hp-hpux11*} target.  The
4237 macro definition table of cpp needs to be increased for a successful
4238 build with the HP compiler.  _CLASSIC_TYPES and _HPUX_SOURCE need to
4239 be defined when building with the bundled compiler, or when using the
4240 @option{-Ac} option.  These defines aren't necessary with @option{-Ae}.
4242 It is best to explicitly configure the @samp{hppa64-hp-hpux11*} target
4243 with the @option{--with-ld=@dots{}} option.  This overrides the standard
4244 search for ld.  The two linkers supported on this target require different
4245 commands.  The default linker is determined during configuration.  As a
4246 result, it's not possible to switch linkers in the middle of a GCC build.
4247 This has been reported to sometimes occur in unified builds of binutils
4248 and GCC@.
4250 A recent linker patch must be installed for the correct operation of
4251 GCC 3.3 and later.  @code{PHSS_26559} and @code{PHSS_24304} are the
4252 oldest linker patches that are known to work.  They are for HP-UX
4253 11.00 and 11.11, respectively.  @code{PHSS_24303}, the companion to
4254 @code{PHSS_24304}, might be usable but it hasn't been tested.  These
4255 patches have been superseded.  Consult the HP patch database to obtain
4256 the currently recommended linker patch for your system.
4258 The patches are necessary for the support of weak symbols on the
4259 32-bit port, and for the running of initializers and finalizers.  Weak
4260 symbols are implemented using SOM secondary definition symbols.  Prior
4261 to HP-UX 11, there are bugs in the linker support for secondary symbols.
4262 The patches correct a problem of linker core dumps creating shared
4263 libraries containing secondary symbols, as well as various other
4264 linking issues involving secondary symbols.
4266 GCC 3.3 uses the ELF DT_INIT_ARRAY and DT_FINI_ARRAY capabilities to
4267 run initializers and finalizers on the 64-bit port.  The 32-bit port
4268 uses the linker @option{+init} and @option{+fini} options for the same
4269 purpose.  The patches correct various problems with the +init/+fini
4270 options, including program core dumps.  Binutils 2.14 corrects a
4271 problem on the 64-bit port resulting from HP's non-standard use of
4272 the .init and .fini sections for array initializers and finalizers.
4274 Although the HP and GNU linkers are both supported for the
4275 @samp{hppa64-hp-hpux11*} target, it is strongly recommended that the
4276 HP linker be used for link editing on this target.
4278 At this time, the GNU linker does not support the creation of long
4279 branch stubs.  As a result, it cannot successfully link binaries
4280 containing branch offsets larger than 8 megabytes.  In addition,
4281 there are problems linking shared libraries, linking executables
4282 with @option{-static}, and with dwarf2 unwind and exception support.
4283 It also doesn't provide stubs for internal calls to global functions
4284 in shared libraries, so these calls cannot be overloaded.
4286 The HP dynamic loader does not support GNU symbol versioning, so symbol
4287 versioning is not supported.  It may be necessary to disable symbol
4288 versioning with @option{--disable-symvers} when using GNU ld.
4290 POSIX threads are the default.  The optional DCE thread library is not
4291 supported, so @option{--enable-threads=dce} does not work.
4293 @html
4294 <hr />
4295 @end html
4296 @anchor{x-x-linux-gnu}
4297 @heading *-*-linux-gnu
4298 The @code{.init_array} and @code{.fini_array} sections are enabled
4299 unconditionally which requires at least glibc 2.1 and binutils 2.12.
4301 Versions of libstdc++-v3 starting with 3.2.1 require bug fixes present
4302 in glibc 2.2.5 and later.  More information is available in the
4303 libstdc++-v3 documentation.
4305 @html
4306 <hr />
4307 @end html
4308 @anchor{ix86-x-linux}
4309 @heading i?86-*-linux*
4310 As of GCC 3.3, binutils 2.13.1 or later is required for this platform.
4311 See @uref{https://gcc.gnu.org/PR10877,,bug 10877} for more information.
4313 If you receive Signal 11 errors when building on GNU/Linux, then it is
4314 possible you have a hardware problem.  Further information on this can be
4315 found on @uref{https://www.bitwizard.nl/sig11/,,www.bitwizard.nl}.
4317 @html
4318 <hr />
4319 @end html
4320 @anchor{ix86-x-solaris2}
4321 @heading i?86-*-solaris2*
4322 Use this for Solaris 11.3 or later on x86 and x86-64 systems.  Starting
4323 with GCC 4.7, there is also a 64-bit @samp{amd64-*-solaris2*} or
4324 @samp{x86_64-*-solaris2*} configuration that corresponds to
4325 @samp{sparcv9-sun-solaris2*}.
4327 @html
4328 <hr />
4329 @end html
4330 @anchor{ia64-x-linux}
4331 @heading ia64-*-linux
4332 IA-64 processor (also known as IPF, or Itanium Processor Family)
4333 running GNU/Linux.
4335 If you are using the installed system libunwind library with
4336 @option{--with-system-libunwind}, then you must use libunwind 0.98 or
4337 later.
4339 @html
4340 <hr />
4341 @end html
4342 @anchor{ia64-x-hpux}
4343 @heading ia64-*-hpux*
4344 Building GCC on this target requires the GNU Assembler.  The bundled HP
4345 assembler will not work.  To prevent GCC from using the wrong assembler,
4346 the option @option{--with-gnu-as} may be necessary.
4348 The GCC libunwind library has not been ported to HPUX@.  This means that for
4349 GCC versions 3.2.3 and earlier, @option{--enable-libunwind-exceptions}
4350 is required to build GCC@.  For GCC 3.3 and later, this is the default.
4351 For gcc 3.4.3 and later, @option{--enable-libunwind-exceptions} is
4352 removed and the system libunwind library will always be used.
4354 @html
4355 <hr />
4356 <!-- rs6000-ibm-aix*, powerpc-ibm-aix* -->
4357 @end html
4358 @anchor{x-ibm-aix}
4359 @heading *-ibm-aix*
4360 Support for AIX version 3 and older was discontinued in GCC 3.4.
4361 Support for AIX version 4.2 and older was discontinued in GCC 4.5.
4363 ``out of memory'' bootstrap failures may indicate a problem with
4364 process resource limits (ulimit).  Hard limits are configured in the
4365 @file{/etc/security/limits} system configuration file.
4367 GCC 4.9 and above require a C++ compiler for bootstrap.  IBM VAC++ / xlC
4368 cannot bootstrap GCC.  xlc can bootstrap an older version of GCC and
4369 G++ can bootstrap recent releases of GCC.
4371 GCC can bootstrap with recent versions of IBM XLC, but bootstrapping
4372 with an earlier release of GCC is recommended.  Bootstrapping with XLC
4373 requires a larger data segment, which can be enabled through the
4374 @var{LDR_CNTRL} environment variable, e.g.,
4376 @smallexample
4377 % LDR_CNTRL=MAXDATA=0x50000000
4378 % export LDR_CNTRL
4379 @end smallexample
4381 One can start with a pre-compiled version of GCC to build from
4382 sources.  One may delete GCC's ``fixed'' header files when starting
4383 with a version of GCC built for an earlier release of AIX.
4385 To speed up the configuration phases of bootstrapping and installing GCC,
4386 one may use GNU Bash instead of AIX @command{/bin/sh}, e.g.,
4388 @smallexample
4389 % CONFIG_SHELL=/opt/freeware/bin/bash
4390 % export CONFIG_SHELL
4391 @end smallexample
4393 and then proceed as described in @uref{build.html,,the build
4394 instructions}, where we strongly recommend specifying an absolute path
4395 to invoke @var{srcdir}/configure.
4397 Because GCC on AIX is built as a 32-bit executable by default,
4398 (although it can generate 64-bit programs) the GMP and MPFR libraries
4399 required by gfortran must be 32-bit libraries.  Building GMP and MPFR
4400 as static archive libraries works better than shared libraries.
4402 Errors involving @code{alloca} when building GCC generally are due
4403 to an incorrect definition of @code{CC} in the Makefile or mixing files
4404 compiled with the native C compiler and GCC@.  During the stage1 phase of
4405 the build, the native AIX compiler @strong{must} be invoked as @command{cc}
4406 (not @command{xlc}).  Once @command{configure} has been informed of
4407 @command{xlc}, one needs to use @samp{make distclean} to remove the
4408 configure cache files and ensure that @env{CC} environment variable
4409 does not provide a definition that will confuse @command{configure}.
4410 If this error occurs during stage2 or later, then the problem most likely
4411 is the version of Make (see above).
4413 The native @command{as} and @command{ld} are recommended for
4414 bootstrapping on AIX@.  The GNU Assembler, GNU Linker, and GNU
4415 Binutils version 2.20 is the minimum level that supports bootstrap on
4416 AIX 5@.  The GNU Assembler has not been updated to support AIX 6@ or
4417 AIX 7.  The native AIX tools do interoperate with GCC@.
4419 AIX 7.1 added partial support for DWARF debugging, but full support
4420 requires AIX 7.1 TL03 SP7 that supports additional DWARF sections and
4421 fixes a bug in the assembler.  AIX 7.1 TL03 SP5 distributed a version
4422 of libm.a missing important symbols; a fix for IV77796 will be
4423 included in SP6.
4425 AIX 5.3 TL10, AIX 6.1 TL05 and AIX 7.1 TL00 introduced an AIX
4426 assembler change that sometimes produces corrupt assembly files
4427 causing AIX linker errors.  The bug breaks GCC bootstrap on AIX and
4428 can cause compilation failures with existing GCC installations.  An
4429 AIX iFix for AIX 5.3 is available (APAR IZ98385 for AIX 5.3 TL10, APAR
4430 IZ98477 for AIX 5.3 TL11 and IZ98134 for AIX 5.3 TL12). AIX 5.3 TL11 SP8,
4431 AIX 5.3 TL12 SP5, AIX 6.1 TL04 SP11, AIX 6.1 TL05 SP7, AIX 6.1 TL06 SP6,
4432 AIX 6.1 TL07 and AIX 7.1 TL01 should include the fix.
4434 Building @file{libstdc++.a} requires a fix for an AIX Assembler bug
4435 APAR IY26685 (AIX 4.3) or APAR IY25528 (AIX 5.1).  It also requires a
4436 fix for another AIX Assembler bug and a co-dependent AIX Archiver fix
4437 referenced as APAR IY53606 (AIX 5.2) or as APAR IY54774 (AIX 5.1)
4439 @anchor{TransferAixShobj}
4440 @samp{libstdc++} in GCC 3.4 increments the major version number of the
4441 shared object and GCC installation places the @file{libstdc++.a}
4442 shared library in a common location which will overwrite the and GCC
4443 3.3 version of the shared library.  Applications either need to be
4444 re-linked against the new shared library or the GCC 3.1 and GCC 3.3
4445 versions of the @samp{libstdc++} shared object needs to be available
4446 to the AIX runtime loader.  The GCC 3.1 @samp{libstdc++.so.4}, if
4447 present, and GCC 3.3 @samp{libstdc++.so.5} shared objects can be
4448 installed for runtime dynamic loading using the following steps to set
4449 the @samp{F_LOADONLY} flag in the shared object for @emph{each}
4450 multilib @file{libstdc++.a} installed:
4452 Extract the shared objects from the currently installed
4453 @file{libstdc++.a} archive:
4454 @smallexample
4455 % ar -x libstdc++.a libstdc++.so.4 libstdc++.so.5
4456 @end smallexample
4458 Enable the @samp{F_LOADONLY} flag so that the shared object will be
4459 available for runtime dynamic loading, but not linking:
4460 @smallexample
4461 % strip -e libstdc++.so.4 libstdc++.so.5
4462 @end smallexample
4464 Archive the runtime-only shared object in the GCC 3.4
4465 @file{libstdc++.a} archive:
4466 @smallexample
4467 % ar -q libstdc++.a libstdc++.so.4 libstdc++.so.5
4468 @end smallexample
4470 Eventually, the
4471 @uref{./configure.html#WithAixSoname,,@option{--with-aix-soname=svr4}}
4472 configure option may drop the need for this procedure for libraries that
4473 support it.
4475 Linking executables and shared libraries may produce warnings of
4476 duplicate symbols.  The assembly files generated by GCC for AIX always
4477 have included multiple symbol definitions for certain global variable
4478 and function declarations in the original program.  The warnings should
4479 not prevent the linker from producing a correct library or runnable
4480 executable.
4482 AIX 4.3 utilizes a ``large format'' archive to support both 32-bit and
4483 64-bit object modules.  The routines provided in AIX 4.3.0 and AIX 4.3.1
4484 to parse archive libraries did not handle the new format correctly.
4485 These routines are used by GCC and result in error messages during
4486 linking such as ``not a COFF file''.  The version of the routines shipped
4487 with AIX 4.3.1 should work for a 32-bit environment.  The @option{-g}
4488 option of the archive command may be used to create archives of 32-bit
4489 objects using the original ``small format''.  A correct version of the
4490 routines is shipped with AIX 4.3.2 and above.
4492 Some versions of the AIX binder (linker) can fail with a relocation
4493 overflow severe error when the @option{-bbigtoc} option is used to link
4494 GCC-produced object files into an executable that overflows the TOC@.  A fix
4495 for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND -BBIGTOC) is
4496 available from IBM Customer Support and from its
4497 @uref{https://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
4498 website as PTF U455193.
4500 The AIX 4.3.2.1 linker (bos.rte.bind_cmds Level 4.3.2.1) will dump core
4501 with a segmentation fault when invoked by any version of GCC@.  A fix for
4502 APAR IX87327 is available from IBM Customer Support and from its
4503 @uref{https://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
4504 website as PTF U461879.  This fix is incorporated in AIX 4.3.3 and above.
4506 The initial assembler shipped with AIX 4.3.0 generates incorrect object
4507 files.  A fix for APAR IX74254 (64BIT DISASSEMBLED OUTPUT FROM COMPILER FAILS
4508 TO ASSEMBLE/BIND) is available from IBM Customer Support and from its
4509 @uref{https://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
4510 website as PTF U453956.  This fix is incorporated in AIX 4.3.1 and above.
4512 AIX provides National Language Support (NLS)@.  Compilers and assemblers
4513 use NLS to support locale-specific representations of various data
4514 formats including floating-point numbers (e.g., @samp{.}  vs @samp{,} for
4515 separating decimal fractions).  There have been problems reported where
4516 GCC does not produce the same floating-point formats that the assembler
4517 expects.  If one encounters this problem, set the @env{LANG}
4518 environment variable to @samp{C} or @samp{En_US}.
4520 A default can be specified with the @option{-mcpu=@var{cpu_type}}
4521 switch and using the configure option @option{--with-cpu-@var{cpu_type}}.
4523 @html
4524 <hr />
4525 @end html
4526 @anchor{iq2000-x-elf}
4527 @heading iq2000-*-elf
4528 Vitesse IQ2000 processors.  These are used in embedded
4529 applications.  There are no standard Unix configurations.
4531 @html
4532 <hr />
4533 @end html
4534 @anchor{lm32-x-elf}
4535 @heading lm32-*-elf
4536 Lattice Mico32 processor.
4537 This configuration is intended for embedded systems.
4539 @html
4540 <hr />
4541 @end html
4542 @anchor{lm32-x-uclinux}
4543 @heading lm32-*-uclinux
4544 Lattice Mico32 processor.
4545 This configuration is intended for embedded systems running uClinux.
4547 @html
4548 <hr />
4549 @end html
4550 @anchor{loongarch}
4551 @heading LoongArch
4552 LoongArch processor.
4553 The following LoongArch targets are available:
4554 @table @code
4555 @item loongarch64-linux-gnu*
4556 LoongArch processor running GNU/Linux.  This target triplet may be coupled
4557 with a small set of possible suffixes to identify their default ABI type:
4558 @table @code
4559 @item f64
4560 Uses @code{lp64d/base} ABI by default.
4561 @item f32
4562 Uses @code{lp64f/base} ABI by default.
4563 @item sf
4564 Uses @code{lp64s/base} ABI by default.
4565 @end table
4567 @item loongarch64-linux-gnu
4568 Same as @code{loongarch64-linux-gnuf64} for legacy support.
4569 @end table
4571 More information about LoongArch can be found at
4572 @uref{https://github.com/loongson/LoongArch-Documentation}.
4574 @html
4575 <hr />
4576 @end html
4577 @anchor{m32c-x-elf}
4578 @heading m32c-*-elf
4579 Renesas M32C processor.
4580 This configuration is intended for embedded systems.
4582 @html
4583 <hr />
4584 @end html
4585 @anchor{m32r-x-elf}
4586 @heading m32r-*-elf
4587 Renesas M32R processor.
4588 This configuration is intended for embedded systems.
4590 @html
4591 <hr />
4592 @end html
4593 @anchor{m68k-x-x}
4594 @heading m68k-*-*
4595 By default,
4596 @samp{m68k-*-elf*}, @samp{m68k-*-rtems},  @samp{m68k-*-uclinux} and
4597 @samp{m68k-*-linux}
4598 build libraries for both M680x0 and ColdFire processors.  If you only
4599 need the M680x0 libraries, you can omit the ColdFire ones by passing
4600 @option{--with-arch=m68k} to @command{configure}.  Alternatively, you
4601 can omit the M680x0 libraries by passing @option{--with-arch=cf} to
4602 @command{configure}.  These targets default to 5206 or 5475 code as
4603 appropriate for the target system when
4604 configured with @option{--with-arch=cf} and 68020 code otherwise.
4606 The @samp{m68k-*-netbsd} and
4607 @samp{m68k-*-openbsd} targets also support the @option{--with-arch}
4608 option.  They will generate ColdFire CFV4e code when configured with
4609 @option{--with-arch=cf} and 68020 code otherwise.
4611 You can override the default processors listed above by configuring
4612 with @option{--with-cpu=@var{target}}.  This @var{target} can either
4613 be a @option{-mcpu} argument or one of the following values:
4614 @samp{m68000}, @samp{m68010}, @samp{m68020}, @samp{m68030},
4615 @samp{m68040}, @samp{m68060}, @samp{m68020-40} and @samp{m68020-60}.
4617 GCC requires at least binutils version 2.17 on these targets.
4619 @html
4620 <hr />
4621 @end html
4622 @anchor{m68k-x-uclinux}
4623 @heading m68k-*-uclinux
4624 GCC 4.3 changed the uClinux configuration so that it uses the
4625 @samp{m68k-linux-gnu} ABI rather than the @samp{m68k-elf} ABI.
4626 It also added improved support for C++ and flat shared libraries,
4627 both of which were ABI changes.
4629 @html
4630 <hr />
4631 @end html
4632 @anchor{microblaze-x-elf}
4633 @heading microblaze-*-elf
4634 Xilinx MicroBlaze processor.
4635 This configuration is intended for embedded systems.
4637 @html
4638 <hr />
4639 @end html
4640 @anchor{mips-x-x}
4641 @heading mips-*-*
4642 If on a MIPS system you get an error message saying ``does not have gp
4643 sections for all it's [sic] sectons [sic]'', don't worry about it.  This
4644 happens whenever you use GAS with the MIPS linker, but there is not
4645 really anything wrong, and it is okay to use the output file.  You can
4646 stop such warnings by installing the GNU linker.
4648 It would be nice to extend GAS to produce the gp tables, but they are
4649 optional, and there should not be a warning about their absence.
4651 The libstdc++ atomic locking routines for MIPS targets requires MIPS II
4652 and later.  A patch went in just after the GCC 3.3 release to
4653 make @samp{mips*-*-*} use the generic implementation instead.  You can also
4654 configure for @samp{mipsel-elf} as a workaround.  The
4655 @samp{mips*-*-linux*} target continues to use the MIPS II routines.  More
4656 work on this is expected in future releases.
4658 @c If you make --with-llsc the default for another target, please also
4659 @c update the description of the --with-llsc option.
4661 The built-in @code{__sync_*} functions are available on MIPS II and
4662 later systems and others that support the @samp{ll}, @samp{sc} and
4663 @samp{sync} instructions.  This can be overridden by passing
4664 @option{--with-llsc} or @option{--without-llsc} when configuring GCC.
4665 Since the Linux kernel emulates these instructions if they are
4666 missing, the default for @samp{mips*-*-linux*} targets is
4667 @option{--with-llsc}.  The @option{--with-llsc} and
4668 @option{--without-llsc} configure options may be overridden at compile
4669 time by passing the @option{-mllsc} or @option{-mno-llsc} options to
4670 the compiler.
4672 MIPS systems check for division by zero (unless
4673 @option{-mno-check-zero-division} is passed to the compiler) by
4674 generating either a conditional trap or a break instruction.  Using
4675 trap results in smaller code, but is only supported on MIPS II and
4676 later.  Also, some versions of the Linux kernel have a bug that
4677 prevents trap from generating the proper signal (@code{SIGFPE}).  To enable
4678 the use of break, use the @option{--with-divide=breaks}
4679 @command{configure} option when configuring GCC@.  The default is to
4680 use traps on systems that support them.
4682 @html
4683 <hr />
4684 @end html
4685 @anchor{moxie-x-elf}
4686 @heading moxie-*-elf
4687 The moxie processor.
4689 @html
4690 <hr />
4691 @end html
4692 @anchor{msp430-x-elf}
4693 @heading msp430-*-elf*
4694 TI MSP430 processor.
4695 This configuration is intended for embedded systems.
4697 @samp{msp430-*-elf} is the standard configuration with most GCC
4698 features enabled by default.
4700 @samp{msp430-*-elfbare} is tuned for a bare-metal environment, and disables
4701 features related to shared libraries and other functionality not used for
4702 this device.  This reduces code and data usage of the GCC libraries, resulting
4703 in a minimal run-time environment by default.
4705 Features disabled by default include:
4706 @itemize
4707 @item transactional memory
4708 @item __cxa_atexit
4709 @end itemize
4711 @html
4712 <hr />
4713 @end html
4714 @anchor{nds32le-x-elf}
4715 @heading nds32le-*-elf
4716 Andes NDS32 target in little endian mode.
4718 @html
4719 <hr />
4720 @end html
4721 @anchor{nds32be-x-elf}
4722 @heading nds32be-*-elf
4723 Andes NDS32 target in big endian mode.
4725 @html
4726 <hr />
4727 @end html
4728 @anchor{nvptx-x-none}
4729 @heading nvptx-*-none
4730 Nvidia PTX target.
4732 Instead of GNU binutils, you will need to install
4733 @uref{https://github.com/MentorEmbedded/nvptx-tools/,,nvptx-tools}.
4734 Tell GCC where to find it:
4735 @option{--with-build-time-tools=[install-nvptx-tools]/nvptx-none/bin}.
4737 You will need newlib 4.3.0 or later.  It can be
4738 automatically built together with GCC@.  For this, add a symbolic link
4739 to nvptx-newlib's @file{newlib} directory to the directory containing
4740 the GCC sources.
4742 Use the @option{--disable-sjlj-exceptions} and
4743 @option{--enable-newlib-io-long-long} options when configuring.
4745 The @option{--with-arch} option may be specified to override the
4746 default value for the @option{-march} option, and to also build
4747 corresponding target libraries.
4748 The default is @option{--with-arch=sm_30}.
4750 For example, if @option{--with-arch=sm_70} is specified,
4751 @option{-march=sm_30} and @option{-march=sm_70} target libraries are
4752 built, and code generation defaults to @option{-march=sm_70}.
4754 @html
4755 <hr />
4756 @end html
4757 @anchor{or1k-x-elf}
4758 @heading or1k-*-elf
4759 The OpenRISC 1000 32-bit processor with delay slots.
4760 This configuration is intended for embedded systems.
4762 @html
4763 <hr />
4764 @end html
4765 @anchor{or1k-x-linux}
4766 @heading or1k-*-linux
4767 The OpenRISC 1000 32-bit processor with delay slots.
4769 @html
4770 <hr />
4771 @end html
4772 @anchor{powerpc-x-x}
4773 @heading powerpc-*-*
4774 You can specify a default version for the @option{-mcpu=@var{cpu_type}}
4775 switch by using the configure option @option{--with-cpu-@var{cpu_type}}.
4777 You will need GNU binutils 2.20 or newer.
4779 @html
4780 <hr />
4781 @end html
4782 @anchor{powerpc-x-darwin}
4783 @heading powerpc-*-darwin*
4784 PowerPC running Darwin (Mac OS X kernel).
4786 Pre-installed versions of Mac OS X may not include any developer tools,
4787 meaning that you will not be able to build GCC from source.  Tool
4788 binaries are available at
4789 @uref{https://opensource.apple.com}.
4791 This version of GCC requires at least cctools-590.36.  The
4792 cctools-590.36 package referenced from
4793 @uref{https://gcc.gnu.org/ml/gcc/2006-03/msg00507.html} will not work
4794 on systems older than 10.3.9 (aka darwin7.9.0).
4796 @html
4797 <hr />
4798 @end html
4799 @anchor{powerpc-x-elf}
4800 @heading powerpc-*-elf
4801 PowerPC system in big endian mode, running System V.4.
4803 @html
4804 <hr />
4805 @end html
4806 @anchor{powerpc-x-linux-gnu}
4807 @heading powerpc*-*-linux-gnu*
4808 PowerPC system in big endian mode running Linux.
4810 @html
4811 <hr />
4812 @end html
4813 @anchor{powerpc-x-netbsd}
4814 @heading powerpc-*-netbsd*
4815 PowerPC system in big endian mode running NetBSD@.
4817 @html
4818 <hr />
4819 @end html
4820 @anchor{powerpc-x-eabisim}
4821 @heading powerpc-*-eabisim
4822 Embedded PowerPC system in big endian mode for use in running under the
4823 PSIM simulator.
4825 @html
4826 <hr />
4827 @end html
4828 @anchor{powerpc-x-eabi}
4829 @heading powerpc-*-eabi
4830 Embedded PowerPC system in big endian mode.
4832 @html
4833 <hr />
4834 @end html
4835 @anchor{powerpcle-x-elf}
4836 @heading powerpcle-*-elf
4837 PowerPC system in little endian mode, running System V.4.
4839 @html
4840 <hr />
4841 @end html
4842 @anchor{powerpcle-x-eabisim}
4843 @heading powerpcle-*-eabisim
4844 Embedded PowerPC system in little endian mode for use in running under
4845 the PSIM simulator.
4847 @html
4848 <hr />
4849 @end html
4850 @anchor{powerpcle-x-eabi}
4851 @heading powerpcle-*-eabi
4852 Embedded PowerPC system in little endian mode.
4854 @html
4855 <hr />
4856 @end html
4857 @anchor{rl78-x-elf}
4858 @heading rl78-*-elf
4859 The Renesas RL78 processor.
4860 This configuration is intended for embedded systems.
4862 @html
4863 <hr />
4864 @end html
4865 @anchor{riscv32-x-elf}
4866 @heading riscv32-*-elf
4867 The RISC-V RV32 instruction set.
4868 This configuration is intended for embedded systems.
4869 This (and all other RISC-V) targets require the binutils 2.30 release.
4871 @html
4872 <hr />
4873 @end html
4874 @anchor{riscv32-x-linux}
4875 @heading riscv32-*-linux
4876 The RISC-V RV32 instruction set running GNU/Linux.
4877 This (and all other RISC-V) targets require the binutils 2.30 release.
4879 @html
4880 <hr />
4881 @end html
4882 @anchor{riscv64-x-elf}
4883 @heading riscv64-*-elf
4884 The RISC-V RV64 instruction set.
4885 This configuration is intended for embedded systems.
4886 This (and all other RISC-V) targets require the binutils 2.30 release.
4888 @html
4889 <hr />
4890 @end html
4891 @anchor{riscv64-x-linux}
4892 @heading riscv64-*-linux
4893 The RISC-V RV64 instruction set running GNU/Linux.
4894 This (and all other RISC-V) targets require the binutils 2.30 release.
4896 @html
4897 <hr />
4898 @end html
4899 @anchor{rx-x-elf}
4900 @heading rx-*-elf
4901 The Renesas RX processor.
4903 @html
4904 <hr />
4905 @end html
4906 @anchor{s390-x-linux}
4907 @heading s390-*-linux*
4908 S/390 system running GNU/Linux for S/390@.
4910 @html
4911 <hr />
4912 @end html
4913 @anchor{s390x-x-linux}
4914 @heading s390x-*-linux*
4915 zSeries system (64-bit) running GNU/Linux for zSeries@.
4917 @html
4918 <hr />
4919 @end html
4920 @anchor{s390x-ibm-tpf}
4921 @heading s390x-ibm-tpf*
4922 zSeries system (64-bit) running TPF@.  This platform is
4923 supported as cross-compilation target only.
4925 @html
4926 <hr />
4927 @end html
4928 @anchor{x-x-solaris2}
4929 @heading *-*-solaris2*
4930 Support for Solaris 11.3 and earlier has been obsoleted in GCC 13, but
4931 can still be enabled by configuring with @option{--enable-obsolete}.
4932 Support for Solaris 10 has been removed in GCC 10.  Support for Solaris
4933 9 has been removed in GCC 5.  Support for Solaris 8 has been removed in
4934 GCC 4.8.  Support for Solaris 7 has been removed in GCC 4.6.
4936 Solaris 11.3 provides GCC 4.5.2, 4.7.3, and 4.8.2 as
4937 @command{/usr/gcc/4.5/bin/gcc} or similar.  Solaris 11.4
4938 provides one or more of GCC 5, 7, 9, 10, 11, and 12.
4940 You need to install the @code{system/header}, @code{system/linker}, and
4941 @code{developer/assembler} packages.
4943 Trying to use the compatibility tools in @file{/usr/ucb}, from the
4944 @code{compatibility/ucb} package, to install GCC has been observed to
4945 cause trouble.  The fix is to remove @file{/usr/ucb} from your
4946 @env{PATH}.
4948 @c FIXME: Still?  Prefer /usr/gnu/bin instead?
4949 The build process works more smoothly with the legacy Solaris tools so,
4950 if you have @file{/usr/xpg4/bin} in your @env{PATH}, we recommend that
4951 you place @file{/usr/bin} before @file{/usr/xpg4/bin} for the duration
4952 of the build.
4954 We recommend the use of the Solaris assembler or the GNU assembler, in
4955 conjunction with the Solaris linker.
4957 The GNU @command{as} versions included in Solaris 11.3, from GNU
4958 binutils 2.23.1 or newer (in @file{/usr/bin/gas} and
4959 @file{/usr/gnu/bin/as}), are known to work.  The version from GNU
4960 binutils 2.40 is known to work as well.  Recent versions of the Solaris
4961 assembler in @file{/usr/bin/as} work almost as well, though.  To use GNU
4962 @command{as}, configure with the options @option{--with-gnu-as
4963 --with-as=@//usr/@/gnu/@/bin/@/as}.
4965 For linking, the Solaris linker is preferred.  If you want to use the
4966 GNU linker instead, the version in Solaris 11.3, from GNU binutils
4967 2.23.1 or newer (in @file{/usr/gnu/bin/ld} and @file{/usr/bin/gld}),
4968 works, as does the version from GNU binutils 2.40.  However, it
4969 generally lacks platform specific features, so better stay with Solaris
4970 @command{ld}.  To use the LTO linker plugin
4971 (@option{-fuse-linker-plugin}) with GNU @command{ld}, GNU binutils
4972 @emph{must} be configured with @option{--enable-largefile}.  To use
4973 Solaris @command{ld}, we recommend to configure with
4974 @option{--without-gnu-ld --with-ld=@//usr/@/bin/@/ld} to guarantee the
4975 right linker is found irrespective of the user's @env{PATH}.
4977 Note that your mileage may vary if you use a combination of the GNU
4978 tools and the Solaris tools: while the combination GNU @command{as} and
4979 Solaris @command{ld} works well, the reverse combination Solaris
4980 @command{as} with GNU @command{ld} may fail to build or cause memory
4981 corruption at runtime in some cases for C++ programs.
4982 @c FIXME: still?
4984 To enable symbol versioning in @samp{libstdc++} and other runtime
4985 libraries with the Solaris linker, you need to have any version of GNU
4986 @command{c++filt}, which is part of GNU binutils.  Symbol versioning
4987 will be disabled if no appropriate version is found.  Solaris
4988 @command{c++filt} from the Solaris Studio compilers does @emph{not}
4989 work.
4991 In order to build the GNU Ada compiler, GNAT, a working GNAT is needed.
4992 Since Solaris 11.4 SRU 39, GNAT 11 or 12 is bundled in the
4993 @code{developer/gcc/gcc-gnat} package.
4995 In order to build the GNU D compiler, GDC, a working @samp{libphobos} is
4996 needed.  That library wasn't built by default in GCC 9--11 on SPARC, or
4997 on x86 when the Solaris assembler is used, but can be enabled by
4998 configuring with @option{--enable-libphobos}.  Also, GDC 9.4.0 is
4999 required on x86, while GDC 9.3.0 is known to work on SPARC.
5001 The versions of the GNU Multiple Precision Library (GMP), the MPFR
5002 library and the MPC library bundled with Solaris 11.3 and later are
5003 usually recent enough to match GCC's requirements.  There are two
5004 caveats:
5006 @itemize @bullet
5007 @item
5008 While the version of the GMP library in Solaris 11.3 works with GCC, you
5009 need to configure with @option{--with-gmp-include=/usr/include/gmp}.
5011 @item
5012 The version of the MPFR libary included in Solaris 11.3 is too old; you
5013 need to provide a more recent one.
5015 @end itemize
5017 @html
5018 <hr />
5019 @end html
5020 @anchor{sparc-x-x}
5021 @heading sparc*-*-*
5022 This section contains general configuration information for all
5023 SPARC-based platforms.  In addition to reading this section, please
5024 read all other sections that match your target.
5026 Newer versions of the GNU Multiple Precision Library (GMP), the MPFR
5027 library and the MPC library are known to be miscompiled by earlier
5028 versions of GCC on these platforms.  We therefore recommend the use
5029 of the exact versions of these libraries listed as minimal versions
5030 in @uref{prerequisites.html,,the prerequisites}.
5032 @html
5033 <hr />
5034 @end html
5035 @anchor{sparc-sun-solaris2}
5036 @heading sparc-sun-solaris2*
5037 When GCC is configured to use GNU binutils 2.14 or later, the binaries
5038 produced are smaller than the ones produced using Solaris native tools;
5039 this difference is quite significant for binaries containing debugging
5040 information.
5042 Starting with Solaris 7, the operating system is capable of executing
5043 64-bit SPARC V9 binaries.  GCC 3.1 and later properly supports
5044 this; the @option{-m64} option enables 64-bit code generation.
5046 When configuring the GNU Multiple Precision Library (GMP), the MPFR
5047 library or the MPC library on Solaris, the canonical target triplet must
5048 be specified as the @command{build} parameter on the @command{configure}
5049 line.  This target triplet can be obtained by invoking
5050 @command{./config.guess} in the toplevel source directory of GCC (and
5051 not that of GMP or MPFR or MPC).  For example:
5053 @smallexample
5054 % @var{srcdir}/configure --build=sparc-sun-solaris2.11 --prefix=@var{dirname}
5055 @end smallexample
5057 @html
5058 <hr />
5059 @end html
5060 @anchor{sparc-x-linux}
5061 @heading sparc-*-linux*
5063 @html
5064 <hr />
5065 @end html
5066 @anchor{sparc64-x-solaris2}
5067 @heading sparc64-*-solaris2*
5068 This is a synonym for @samp{sparcv9-*-solaris2*}.
5070 @html
5071 <hr />
5072 @end html
5073 @anchor{sparcv9-x-solaris2}
5074 @heading sparcv9-*-solaris2*
5076 When configuring a 64-bit-default GCC on Solaris/SPARC, you must use a
5077 build compiler that generates 64-bit code, either by default or by
5078 specifying @samp{CC='gcc -m64' CXX='g++ -m64' GDC='gdc -m64'} to @command{configure}.
5079 Additionally, you @emph{must} pass @option{--build=sparcv9-sun-solaris2.11}
5080 or @option{--build=sparc64-sun-solaris2.11} because @file{config.guess}
5081 misdetects this situation, which can cause build failures.
5083 When configuring the GNU Multiple Precision Library (GMP), the MPFR
5084 library or the MPC library, the canonical target triplet must be specified
5085 as the @command{build} parameter on the @command{configure} line.  For example:
5087 @smallexample
5088 % @var{srcdir}/configure --build=sparcv9-sun-solaris2.11 --prefix=@var{dirname}
5089 @end smallexample
5091 @html
5092 <hr />
5093 @end html
5094 @anchor{c6x-x-x}
5095 @heading c6x-*-*
5096 The C6X family of processors. This port requires binutils-2.22 or newer.
5098 @html
5099 <hr />
5100 @end html
5101 @anchor{visium-x-elf}
5102 @heading visium-*-elf
5103 CDS VISIUMcore processor.
5104 This configuration is intended for embedded systems.
5106 @html
5107 <hr />
5108 @end html
5109 @anchor{x-x-vxworks}
5110 @heading *-*-vxworks*
5111 Support for VxWorks is in flux.  At present GCC supports @emph{only} the
5112 very recent VxWorks 5.5 (aka Tornado 2.2) release, and only on PowerPC@.
5113 We welcome patches for other architectures supported by VxWorks 5.5.
5114 Support for VxWorks AE would also be welcome; we believe this is merely
5115 a matter of writing an appropriate ``configlette'' (see below).  We are
5116 not interested in supporting older, a.out or COFF-based, versions of
5117 VxWorks in GCC 3.
5119 VxWorks comes with an older version of GCC installed in
5120 @file{@var{$WIND_BASE}/host}; we recommend you do not overwrite it.
5121 Choose an installation @var{prefix} entirely outside @var{$WIND_BASE}.
5122 Before running @command{configure}, create the directories @file{@var{prefix}}
5123 and @file{@var{prefix}/bin}.  Link or copy the appropriate assembler,
5124 linker, etc.@: into @file{@var{prefix}/bin}, and set your @var{PATH} to
5125 include that directory while running both @command{configure} and
5126 @command{make}.
5128 You must give @command{configure} the
5129 @option{--with-headers=@var{$WIND_BASE}/target/h} switch so that it can
5130 find the VxWorks system headers.  Since VxWorks is a cross compilation
5131 target only, you must also specify @option{--target=@var{target}}.
5132 @command{configure} will attempt to create the directory
5133 @file{@var{prefix}/@var{target}/sys-include} and copy files into it;
5134 make sure the user running @command{configure} has sufficient privilege
5135 to do so.
5137 GCC's exception handling runtime requires a special ``configlette''
5138 module, @file{contrib/gthr_supp_vxw_5x.c}.  Follow the instructions in
5139 that file to add the module to your kernel build.  (Future versions of
5140 VxWorks will incorporate this module.)
5142 @html
5143 <hr />
5144 @end html
5145 @anchor{x86-64-x-x}
5146 @heading x86_64-*-*, amd64-*-*
5147 GCC supports the x86-64 architecture implemented by the AMD64 processor
5148 (amd64-*-* is an alias for x86_64-*-*) on GNU/Linux, FreeBSD and NetBSD@.
5149 On GNU/Linux the default is a bi-arch compiler which is able to generate
5150 both 64-bit x86-64 and 32-bit x86 code (via the @option{-m32} switch).
5152 @html
5153 <hr />
5154 @end html
5155 @anchor{x86-64-x-solaris2}
5156 @heading x86_64-*-solaris2*
5157 GCC also supports the x86-64 architecture implemented by the AMD64
5158 processor (@samp{amd64-*-*} is an alias for @samp{x86_64-*-*}).
5159 Unlike other systems, without special options a
5160 bi-arch compiler is built which generates 32-bit code by default, but
5161 can generate 64-bit x86-64 code with the @option{-m64} switch.  Since
5162 GCC 4.7, there is also a configuration that defaults to 64-bit code, but
5163 can generate 32-bit code with @option{-m32}.  To configure and build
5164 this way, you have to provide all support libraries like @file{libgmp}
5165 as 64-bit code, configure with @option{--target=x86_64-pc-solaris2.11}
5166 and @samp{CC=gcc -m64}.
5168 @html
5169 <hr />
5170 @end html
5171 @anchor{xtensa-x-elf}
5172 @heading xtensa*-*-elf
5173 This target is intended for embedded Xtensa systems using the
5174 @samp{newlib} C library.  It uses ELF but does not support shared
5175 objects.  Designed-defined instructions specified via the
5176 Tensilica Instruction Extension (TIE) language are only supported
5177 through inline assembly.
5179 The Xtensa configuration information must be specified prior to
5180 building GCC@.  The @file{include/xtensa-config.h} header
5181 file contains the configuration information.  If you created your
5182 own Xtensa configuration with the Xtensa Processor Generator, the
5183 downloaded files include a customized copy of this header file,
5184 which you can use to replace the default header file.
5186 @html
5187 <hr />
5188 @end html
5189 @anchor{xtensa-x-linux}
5190 @heading xtensa*-*-linux*
5191 This target is for Xtensa systems running GNU/Linux.  It supports ELF
5192 shared objects and the GNU C library (glibc).  It also generates
5193 position-independent code (PIC) regardless of whether the
5194 @option{-fpic} or @option{-fPIC} options are used.  In other
5195 respects, this target is the same as the
5196 @uref{#xtensa*-*-elf,,@samp{xtensa*-*-elf}} target.
5198 @html
5199 <hr />
5200 @end html
5201 @anchor{windows}
5202 @heading Microsoft Windows
5204 @subheading Intel 16-bit versions
5205 The 16-bit versions of Microsoft Windows, such as Windows 3.1, are not
5206 supported.
5208 However, the 32-bit port has limited support for Microsoft
5209 Windows 3.11 in the Win32s environment, as a target only.  See below.
5211 @subheading Intel 32-bit versions
5212 The 32-bit versions of Windows, including Windows 95, Windows NT, Windows
5213 XP, and Windows Vista, are supported by several different target
5214 platforms.  These targets differ in which Windows subsystem they target
5215 and which C libraries are used.
5217 @itemize
5218 @item Cygwin @uref{#x-x-cygwin,,*-*-cygwin}: Cygwin provides a user-space
5219 Linux API emulation layer in the Win32 subsystem.
5220 @item MinGW @uref{#x-x-mingw32,,*-*-mingw32}: MinGW is a native GCC port for
5221 the Win32 subsystem that provides a subset of POSIX.
5222 @item MKS i386-pc-mks: NuTCracker from MKS.  See
5223 @uref{https://www.mkssoftware.com} for more information.
5224 @end itemize
5226 @subheading Intel 64-bit versions
5227 GCC contains support for x86-64 using the mingw-w64
5228 runtime library, available from @uref{https://www.mingw-w64.org/downloads/}.
5229 This library should be used with the target triple x86_64-pc-mingw32.
5231 @subheading Windows CE
5232 Windows CE is supported as a target only on Hitachi
5233 SuperH (sh-wince-pe), and MIPS (mips-wince-pe).
5235 @subheading Other Windows Platforms
5236 GCC no longer supports Windows NT on the Alpha or PowerPC.
5238 GCC no longer supports the Windows POSIX subsystem.  However, it does
5239 support the Interix subsystem.  See above.
5241 Old target names including *-*-winnt and *-*-windowsnt are no longer used.
5243 UWIN support has been removed due to a lack of maintenance.
5245 @html
5246 <hr />
5247 @end html
5248 @anchor{x-x-cygwin}
5249 @heading *-*-cygwin
5250 Ports of GCC are included with the
5251 @uref{http://www.cygwin.com/,,Cygwin environment}.
5253 GCC will build under Cygwin without modification; it does not build
5254 with Microsoft's C++ compiler and there are no plans to make it do so.
5256 The Cygwin native compiler can be configured to target any 32-bit x86
5257 cpu architecture desired; the default is i686-pc-cygwin.  It should be
5258 used with as up-to-date a version of binutils as possible; use either
5259 the latest official GNU binutils release in the Cygwin distribution,
5260 or version 2.20 or above if building your own.
5262 @html
5263 <hr />
5264 @end html
5265 @anchor{x-x-mingw32}
5266 @heading *-*-mingw32
5267 GCC will build with and support only MinGW runtime 3.12 and later.
5268 Earlier versions of headers are incompatible with the new default semantics
5269 of @code{extern inline} in @code{-std=c99} and @code{-std=gnu99} modes.
5271 To support emitting DWARF debugging info you need to use GNU binutils
5272 version 2.16 or above containing support for the @code{.secrel32}
5273 assembler pseudo-op.
5275 @html
5276 <hr />
5277 @end html
5278 @anchor{older}
5279 @heading Older systems
5280 GCC contains support files for many older (1980s and early
5281 1990s) Unix variants.  For the most part, support for these systems
5282 has not been deliberately removed, but it has not been maintained for
5283 several years and may suffer from bitrot.
5285 Starting with GCC 3.1, each release has a list of ``obsoleted'' systems.
5286 Support for these systems is still present in that release, but
5287 @command{configure} will fail unless the @option{--enable-obsolete}
5288 option is given.  Unless a maintainer steps forward, support for these
5289 systems will be removed from the next release of GCC@.
5291 Support for old systems as hosts for GCC can cause problems if the
5292 workarounds for compiler, library and operating system bugs affect the
5293 cleanliness or maintainability of the rest of GCC@.  In some cases, to
5294 bring GCC up on such a system, if still possible with current GCC, may
5295 require first installing an old version of GCC which did work on that
5296 system, and using it to compile a more recent GCC, to avoid bugs in the
5297 vendor compiler.  Old releases of GCC 1 and GCC 2 are available in the
5298 @file{old-releases} directory on the @uref{../mirrors.html,,GCC mirror
5299 sites}.  Header bugs may generally be avoided using
5300 @command{fixincludes}, but bugs or deficiencies in libraries and the
5301 operating system may still cause problems.
5303 Support for older systems as targets for cross-compilation is less
5304 problematic than support for them as hosts for GCC; if an enthusiast
5305 wishes to make such a target work again (including resurrecting any of
5306 the targets that never worked with GCC 2, starting from the last
5307 version before they were removed), patches
5308 @uref{../contribute.html,,following the usual requirements} would be
5309 likely to be accepted, since they should not affect the support for more
5310 modern targets.
5312 For some systems, old versions of GNU binutils may also be useful,
5313 and are available from @file{pub/binutils/old-releases} on
5314 @uref{https://sourceware.org/mirrors.html,,sourceware.org mirror sites}.
5316 Some of the information on specific systems above relates to
5317 such older systems, but much of the information
5318 about GCC on such systems (which may no longer be applicable to
5319 current GCC) is to be found in the GCC texinfo manual.
5321 @html
5322 <hr />
5323 @end html
5324 @anchor{elf}
5325 @heading all ELF targets (SVR4, Solaris, etc.)
5326 C++ support is significantly better on ELF targets if you use the
5327 @uref{./configure.html#with-gnu-ld,,GNU linker}; duplicate copies of
5328 inlines, vtables and template instantiations will be discarded
5329 automatically.
5332 @html
5333 <hr />
5335 @end html
5336 @ifhtml
5337 @uref{./index.html,,Return to the GCC Installation page}
5338 @end ifhtml
5339 @end ifset
5341 @c ***GFDL********************************************************************
5342 @ifset gfdlhtml
5343 @include fdl.texi
5344 @html
5345 <hr />
5347 @end html
5348 @ifhtml
5349 @uref{./index.html,,Return to the GCC Installation page}
5350 @end ifhtml
5351 @end ifset
5353 @c ***************************************************************************
5354 @c Part 6 The End of the Document
5355 @ifinfo
5356 @comment node-name,     next,          previous, up
5357 @node    Concept Index, , GNU Free Documentation License, Top
5358 @end ifinfo
5360 @ifinfo
5361 @unnumbered Concept Index
5363 @printindex cp
5365 @contents
5366 @end ifinfo
5367 @bye