1 \input texinfo.tex @c -*-texinfo-*-
4 @setfilename gccinstall.info
9 @include gcc-common.texi
11 @c Specify title for specific html page
13 @settitle Installing GCC
16 @settitle Host/Target specific installation notes for GCC
18 @ifset prerequisiteshtml
19 @settitle Prerequisites for GCC
22 @settitle Downloading GCC
25 @settitle Installing GCC: Configuration
28 @settitle Installing GCC: Building
31 @settitle Installing GCC: Testing
33 @ifset finalinstallhtml
34 @settitle Installing GCC: Final installation
37 @settitle Installing GCC: Binaries
40 @settitle Installing GCC: Old documentation
43 @settitle Installing GCC: GNU Free Documentation License
46 @c Copyright (C) 1988-2020 Free Software Foundation, Inc.
47 @c *** Converted to texinfo by Dean Wakerley, dean@wakerley.com
49 @c IMPORTANT: whenever you modify this file, run `install.texi2html' to
50 @c test the generation of HTML documents for the gcc.gnu.org web pages.
52 @c Do not use @footnote{} in this file as it breaks install.texi2html!
54 @c Include everything if we're not making html
58 @set prerequisiteshtml
69 @c Part 2 Summary Description and Copyright
71 Copyright @copyright{} 1988-2020 Free Software Foundation, Inc.
73 Permission is granted to copy, distribute and/or modify this document
74 under the terms of the GNU Free Documentation License, Version 1.3 or
75 any later version published by the Free Software Foundation; with no
76 Invariant Sections, the Front-Cover texts being (a) (see below), and
77 with the Back-Cover Texts being (b) (see below). A copy of the
78 license is included in the section entitled ``@uref{./gfdl.html,,GNU
79 Free Documentation License}''.
81 (a) The FSF's Front-Cover Text is:
85 (b) The FSF's Back-Cover Text is:
87 You have freedom to copy and modify this GNU Manual, like GNU
88 software. Copies published by the Free Software Foundation raise
89 funds for GNU development.
94 @dircategory Software development
96 * gccinstall: (gccinstall). Installing the GNU Compiler Collection.
99 @c Part 3 Titlepage and Copyright
101 @title Installing GCC
104 @c The following two commands start the copyright page.
106 @vskip 0pt plus 1filll
110 @c Part 4 Top node, Master Menu, and/or Table of Contents
113 @comment node-name, next, Previous, up
116 * Installing GCC:: This document describes the generic installation
117 procedure for GCC as well as detailing some target
118 specific installation instructions.
120 * Specific:: Host/target specific installation notes for GCC.
121 * Binaries:: Where to get pre-compiled binaries.
123 * Old:: Old installation documentation.
125 * GNU Free Documentation License:: How you can copy and share this manual.
126 * Concept Index:: This index has two entries.
134 @c Part 5 The Body of the Document
135 @c ***Installing GCC**********************************************************
137 @comment node-name, next, previous, up
138 @node Installing GCC, Binaries, , Top
142 @chapter Installing GCC
145 The latest version of this document is always available at
146 @uref{http://gcc.gnu.org/install/,,http://gcc.gnu.org/install/}.
147 It refers to the current development sources, instructions for
148 specific released versions are included with the sources.
150 This document describes the generic installation procedure for GCC as well
151 as detailing some target specific installation instructions.
153 GCC includes several components that previously were separate distributions
154 with their own installation instructions. This document supersedes all
155 package-specific installation instructions.
157 @emph{Before} starting the build/install procedure please check the
159 @ref{Specific, host/target specific installation notes}.
162 @uref{specific.html,,host/target specific installation notes}.
164 We recommend you browse the entire generic installation instructions before
167 Lists of successful builds for released versions of GCC are
168 available at @uref{http://gcc.gnu.org/buildstat.html}.
169 These lists are updated as new information becomes available.
171 The installation procedure itself is broken into five steps.
176 * Downloading the source::
179 * Testing:: (optional)
186 @uref{prerequisites.html,,Prerequisites}
188 @uref{download.html,,Downloading the source}
190 @uref{configure.html,,Configuration}
192 @uref{build.html,,Building}
194 @uref{test.html,,Testing} (optional)
196 @uref{finalinstall.html,,Final install}
200 Please note that GCC does not support @samp{make uninstall} and probably
201 won't do so in the near future as this would open a can of worms. Instead,
202 we suggest that you install GCC into a directory of its own and simply
203 remove that directory when you do not need that specific version of GCC
204 any longer, and, if shared libraries are installed there as well, no
205 more binaries exist that use them.
208 There are also some @uref{old.html,,old installation instructions},
209 which are mostly obsolete but still contain some information which has
210 not yet been merged into the main part of this manual.
218 @uref{./index.html,,Return to the GCC Installation page}
224 @c ***Prerequisites**************************************************
226 @comment node-name, next, previous, up
227 @node Prerequisites, Downloading the source, , Installing GCC
229 @ifset prerequisiteshtml
231 @chapter Prerequisites
233 @cindex Prerequisites
235 GCC requires that various tools and packages be available for use in the
236 build procedure. Modifying GCC sources requires additional tools
239 @heading Tools/packages necessary for building GCC
241 @item ISO C++11 compiler
242 Necessary to bootstrap GCC.
244 Versions of GCC prior to 11 also allow bootstrapping with an ISO C++98
245 compiler, versions of GCC prior to 4.8 also allow bootstrapping with a
246 ISO C89 compiler, and versions of GCC prior to 3.4 also allow
247 bootstrapping with a traditional (K&R) C compiler.
249 To build all languages in a cross-compiler or other configuration where
250 3-stage bootstrap is not performed, you need to start with an existing
251 GCC binary (version 4.8 or later) because source code for language
252 frontends other than C might use GCC extensions.
254 Note that to bootstrap GCC with versions of GCC earlier than 4.8, you
255 may need to use @option{--disable-stage1-checking}, though
256 bootstrapping the compiler with such earlier compilers is strongly
259 @item C standard library and headers
261 In order to build GCC, the C standard library and headers must be present
262 for all target variants for which target libraries will be built (and not
263 only the variant of the host C++ compiler).
265 This affects the popular @samp{x86_64-pc-linux-gnu} platform (among
266 other multilib targets), for which 64-bit (@samp{x86_64}) and 32-bit
267 (@samp{i386}) libc headers are usually packaged separately. If you do a
268 build of a native compiler on @samp{x86_64-pc-linux-gnu}, make sure you
269 either have the 32-bit libc developer package properly installed (the exact
270 name of the package depends on your distro) or you must build GCC as a
271 64-bit only compiler by configuring with the option
272 @option{--disable-multilib}. Otherwise, you may encounter an error such as
273 @samp{fatal error: gnu/stubs-32.h: No such file}
275 @item @anchor{GNAT-prerequisite}GNAT
277 In order to build GNAT, the Ada compiler, you need a working GNAT
278 compiler (GCC version 4.7 or later).
280 This includes GNAT tools such as @command{gnatmake} and
281 @command{gnatlink}, since the Ada front end is written in Ada and
282 uses some GNAT-specific extensions.
284 In order to build a cross compiler, it is strongly recommended to install
285 the new compiler as native first, and then use it to build the cross
286 compiler. Other native compiler versions may work but this is not guaranteed and
287 will typically fail with hard to understand compilation errors during the
290 Similarly, it is strongly recommended to use an older version of GNAT to build
291 GNAT. More recent versions of GNAT than the version built are not guaranteed
292 to work and will often fail during the build with compilation errors.
294 Note that @command{configure} does not test whether the GNAT installation works
295 and has a sufficiently recent version; if too old a GNAT version is
296 installed and @option{--enable-languages=ada} is used, the build will fail.
298 @env{ADA_INCLUDE_PATH} and @env{ADA_OBJECT_PATH} environment variables
299 must not be set when building the Ada compiler, the Ada tools, or the
300 Ada runtime libraries. You can check that your build environment is clean
301 by verifying that @samp{gnatls -v} lists only one explicit path in each
304 @item A ``working'' POSIX compatible shell, or GNU bash
306 Necessary when running @command{configure} because some
307 @command{/bin/sh} shells have bugs and may crash when configuring the
308 target libraries. In other cases, @command{/bin/sh} or @command{ksh}
309 have disastrous corner-case performance problems. This
310 can cause target @command{configure} runs to literally take days to
311 complete in some cases.
313 So on some platforms @command{/bin/ksh} is sufficient, on others it
314 isn't. See the host/target specific instructions for your platform, or
315 use @command{bash} to be sure. Then set @env{CONFIG_SHELL} in your
316 environment to your ``good'' shell prior to running
317 @command{configure}/@command{make}.
319 @command{zsh} is not a fully compliant POSIX shell and will not
320 work when configuring GCC@.
322 @item A POSIX or SVR4 awk
324 Necessary for creating some of the generated source files for GCC@.
325 If in doubt, use a recent GNU awk version, as some of the older ones
326 are broken. GNU awk version 3.1.5 is known to work.
330 Necessary in some circumstances, optional in others. See the
331 host/target specific instructions for your platform for the exact
334 @item gzip version 1.2.4 (or later) or
335 @itemx bzip2 version 1.0.2 (or later)
337 Necessary to uncompress GCC @command{tar} files when source code is
338 obtained via HTTPS mirror sites.
340 @item GNU make version 3.80 (or later)
342 You must have GNU make installed to build GCC@.
344 @item GNU tar version 1.14 (or later)
346 Necessary (only on some platforms) to untar the source code. Many
347 systems' @command{tar} programs will also work, only try GNU
348 @command{tar} if you have problems.
350 @item Perl version between 5.6.1 and 5.6.24
352 Necessary when targeting Darwin, building @samp{libstdc++},
353 and not using @option{--disable-symvers}.
354 Necessary when targeting Solaris 2 with Solaris @command{ld} and not using
355 @option{--disable-symvers}.
357 Necessary when regenerating @file{Makefile} dependencies in libiberty.
358 Necessary when regenerating @file{libiberty/functions.texi}.
359 Necessary when generating manpages from Texinfo manuals.
360 Used by various scripts to generate some files included in the source
361 repository (mainly Unicode-related and rarely changing) from source
364 Used by @command{automake}.
368 Several support libraries are necessary to build GCC, some are required,
369 others optional. While any sufficiently new version of required tools
370 usually work, library requirements are generally stricter. Newer
371 versions may work in some cases, but it's safer to use the exact
372 versions documented. We appreciate bug reports about problems with
373 newer versions, though. If your OS vendor provides packages for the
374 support libraries then using those packages may be the simplest way to
375 install the libraries.
378 @item GNU Multiple Precision Library (GMP) version 4.3.2 (or later)
380 Necessary to build GCC@. If a GMP source distribution is found in a
381 subdirectory of your GCC sources named @file{gmp}, it will be built
382 together with GCC. Alternatively, if GMP is already installed but it
383 is not in your library search path, you will have to configure with the
384 @option{--with-gmp} configure option. See also @option{--with-gmp-lib}
385 and @option{--with-gmp-include}.
386 The in-tree build is only supported with the GMP version that
387 download_prerequisites installs.
389 @item MPFR Library version 3.1.0 (or later)
391 Necessary to build GCC@. It can be downloaded from
392 @uref{https://www.mpfr.org}. If an MPFR source distribution is found
393 in a subdirectory of your GCC sources named @file{mpfr}, it will be
394 built together with GCC. Alternatively, if MPFR is already installed
395 but it is not in your default library search path, the
396 @option{--with-mpfr} configure option should be used. See also
397 @option{--with-mpfr-lib} and @option{--with-mpfr-include}.
398 The in-tree build is only supported with the MPFR version that
399 download_prerequisites installs.
401 @item MPC Library version 1.0.1 (or later)
403 Necessary to build GCC@. It can be downloaded from
404 @uref{http://www.multiprecision.org/mpc/}. If an MPC source distribution
405 is found in a subdirectory of your GCC sources named @file{mpc}, it
406 will be built together with GCC. Alternatively, if MPC is already
407 installed but it is not in your default library search path, the
408 @option{--with-mpc} configure option should be used. See also
409 @option{--with-mpc-lib} and @option{--with-mpc-include}.
410 The in-tree build is only supported with the MPC version that
411 download_prerequisites installs.
413 @item isl Library version 0.15 or later.
415 Necessary to build GCC with the Graphite loop optimizations.
416 It can be downloaded from @uref{https://gcc.gnu.org/pub/gcc/infrastructure/}.
417 If an isl source distribution is found
418 in a subdirectory of your GCC sources named @file{isl}, it will be
419 built together with GCC. Alternatively, the @option{--with-isl} configure
420 option should be used if isl is not installed in your default library
425 Necessary to build GCC with zstd compression used for LTO bytecode.
426 The library is searched in your default library patch search.
427 Alternatively, the @option{--with-zstd} configure option should be used.
431 @heading Tools/packages necessary for modifying GCC
433 @item autoconf version 2.69
434 @itemx GNU m4 version 1.4.6 (or later)
436 Necessary when modifying @file{configure.ac}, @file{aclocal.m4}, etc.@:
437 to regenerate @file{configure} and @file{config.in} files.
439 @item automake version 1.15.1
441 Necessary when modifying a @file{Makefile.am} file to regenerate its
442 associated @file{Makefile.in}.
444 Much of GCC does not use automake, so directly edit the @file{Makefile.in}
445 file. Specifically this applies to the @file{gcc}, @file{intl},
446 @file{libcpp}, @file{libiberty}, @file{libobjc} directories as well
447 as any of their subdirectories.
449 For directories that use automake, GCC requires the latest release in
450 the 1.15 series, which is currently 1.15.1. When regenerating a directory
451 to a newer version, please update all the directories using an older 1.15
452 to the latest released version.
454 @item gettext version 0.14.5 (or later)
456 Needed to regenerate @file{gcc.pot}.
458 @item gperf version 2.7.2 (or later)
460 Necessary when modifying @command{gperf} input files, e.g.@:
461 @file{gcc/cp/cfns.gperf} to regenerate its associated header file, e.g.@:
462 @file{gcc/cp/cfns.h}.
468 Necessary to run the GCC testsuite; see the section on testing for
471 @item autogen version 5.5.4 (or later) and
472 @itemx guile version 1.4.1 (or later)
474 Necessary to regenerate @file{fixinc/fixincl.x} from
475 @file{fixinc/inclhack.def} and @file{fixinc/*.tpl}.
477 Necessary to run @samp{make check} for @file{fixinc}.
479 Necessary to regenerate the top level @file{Makefile.in} file from
480 @file{Makefile.tpl} and @file{Makefile.def}.
482 @item Flex version 2.5.4 (or later)
484 Necessary when modifying @file{*.l} files.
486 Necessary to build GCC during development because the generated output
487 files are not included in the version-controlled source repository.
488 They are included in releases.
490 @item Texinfo version 4.7 (or later)
492 Necessary for running @command{makeinfo} when modifying @file{*.texi}
493 files to test your changes.
495 Necessary for running @command{make dvi} or @command{make pdf} to
496 create printable documentation in DVI or PDF format. Texinfo version
497 4.8 or later is required for @command{make pdf}.
499 Necessary to build GCC documentation during development because the
500 generated output files are not included in the repository. They are
501 included in releases.
503 @item @TeX{} (any working version)
505 Necessary for running @command{texi2dvi} and @command{texi2pdf}, which
506 are used when running @command{make dvi} or @command{make pdf} to create
507 DVI or PDF files, respectively.
509 @item Sphinx version 1.0 (or later)
511 Necessary to regenerate @file{jit/docs/_build/texinfo} from the @file{.rst}
512 files in the directories below @file{jit/docs}.
514 @item git (any version)
515 @itemx SSH (any version)
517 Necessary to access the source repository. Public releases and weekly
518 snapshots of the development sources are also available via HTTPS@.
520 @item GNU diffutils version 2.7 (or later)
522 Useful when submitting patches for the GCC source code.
524 @item patch version 2.5.4 (or later)
526 Necessary when applying patches, created with @command{diff}, to one's
536 @uref{./index.html,,Return to the GCC Installation page}
540 @c ***Downloading the source**************************************************
542 @comment node-name, next, previous, up
543 @node Downloading the source, Configuration, Prerequisites, Installing GCC
547 @chapter Downloading GCC
549 @cindex Downloading GCC
550 @cindex Downloading the Source
552 GCC is distributed via @uref{http://gcc.gnu.org/git.html,,git} and via
553 HTTPS as tarballs compressed with @command{gzip} or @command{bzip2}.
555 Please refer to the @uref{http://gcc.gnu.org/releases.html,,releases web page}
556 for information on how to obtain GCC@.
558 The source distribution includes the C, C++, Objective-C, Fortran,
559 and Ada (in the case of GCC 3.1 and later) compilers, as well as
560 runtime libraries for C++, Objective-C, and Fortran.
561 For previous versions these were downloadable as separate components such
562 as the core GCC distribution, which included the C language front end and
563 shared components, and language-specific distributions including the
564 language front end and the language runtime (where appropriate).
566 If you also intend to build binutils (either to upgrade an existing
567 installation or for use in place of the corresponding tools of your
568 OS), unpack the binutils distribution either in the same directory or
569 a separate one. In the latter case, add symbolic links to any
570 components of the binutils you intend to build alongside the compiler
571 (@file{bfd}, @file{binutils}, @file{gas}, @file{gprof}, @file{ld},
572 @file{opcodes}, @dots{}) to the directory containing the GCC sources.
574 Likewise the GMP, MPFR and MPC libraries can be automatically built
575 together with GCC. You may simply run the
576 @command{contrib/download_prerequisites} script in the GCC source directory
577 to set up everything.
578 Otherwise unpack the GMP, MPFR and/or MPC source
579 distributions in the directory containing the GCC sources and rename
580 their directories to @file{gmp}, @file{mpfr} and @file{mpc},
581 respectively (or use symbolic links with the same name).
588 @uref{./index.html,,Return to the GCC Installation page}
592 @c ***Configuration***********************************************************
594 @comment node-name, next, previous, up
595 @node Configuration, Building, Downloading the source, Installing GCC
599 @chapter Installing GCC: Configuration
601 @cindex Configuration
602 @cindex Installing GCC: Configuration
604 Like most GNU software, GCC must be configured before it can be built.
605 This document describes the recommended configuration procedure
606 for both native and cross targets.
608 We use @var{srcdir} to refer to the toplevel source directory for
609 GCC; we use @var{objdir} to refer to the toplevel build/object directory.
611 If you obtained the sources by cloning the repository, @var{srcdir}
612 must refer to the top @file{gcc} directory, the one where the
613 @file{MAINTAINERS} file can be found, and not its @file{gcc}
614 subdirectory, otherwise the build will fail.
616 If either @var{srcdir} or @var{objdir} is located on an automounted NFS
617 file system, the shell's built-in @command{pwd} command will return
618 temporary pathnames. Using these can lead to various sorts of build
619 problems. To avoid this issue, set the @env{PWDCMD} environment
620 variable to an automounter-aware @command{pwd} command, e.g.,
621 @command{pawd} or @samp{amq -w}, during the configuration and build
624 First, we @strong{highly} recommend that GCC be built into a
625 separate directory from the sources which does @strong{not} reside
626 within the source tree. This is how we generally build GCC; building
627 where @var{srcdir} == @var{objdir} should still work, but doesn't
628 get extensive testing; building where @var{objdir} is a subdirectory
629 of @var{srcdir} is unsupported.
631 If you have previously built GCC in the same directory for a
632 different target machine, do @samp{make distclean} to delete all files
633 that might be invalid. One of the files this deletes is @file{Makefile};
634 if @samp{make distclean} complains that @file{Makefile} does not exist
635 or issues a message like ``don't know how to make distclean'' it probably
636 means that the directory is already suitably clean. However, with the
637 recommended method of building in a separate @var{objdir}, you should
638 simply use a different @var{objdir} for each target.
640 Second, when configuring a native system, either @command{cc} or
641 @command{gcc} must be in your path or you must set @env{CC} in
642 your environment before running configure. Otherwise the configuration
646 Note that the bootstrap compiler and the resulting GCC must be link
647 compatible, else the bootstrap will fail with linker errors about
648 incompatible object file formats. Several multilibed targets are
649 affected by this requirement, see
651 @ref{Specific, host/target specific installation notes}.
654 @uref{specific.html,,host/target specific installation notes}.
663 % @var{srcdir}/configure [@var{options}] [@var{target}]
666 @heading Distributor options
668 If you will be distributing binary versions of GCC, with modifications
669 to the source code, you should use the options described in this
670 section to make clear that your version contains modifications.
673 @item --with-pkgversion=@var{version}
674 Specify a string that identifies your package. You may wish
675 to include a build number or build date. This version string will be
676 included in the output of @command{gcc --version}. This suffix does
677 not replace the default version string, only the @samp{GCC} part.
679 The default value is @samp{GCC}.
681 @item --with-bugurl=@var{url}
682 Specify the URL that users should visit if they wish to report a bug.
683 You are of course welcome to forward bugs reported to you to the FSF,
684 if you determine that they are not bugs in your modifications.
686 The default value refers to the FSF's GCC bug tracker.
688 @item --with-documentation-root-url=@var{url}
689 Specify the URL root that contains GCC option documentation. The @var{url}
690 should end with a @code{/} character.
692 The default value is @uref{https://gcc.gnu.org/onlinedocs/,,https://gcc.gnu.org/onlinedocs/}.
694 @item --with-changes-root-url=@var{url}
695 Specify the URL root that contains information about changes in GCC
696 releases like @code{gcc-@var{version}/changes.html}.
697 The @var{url} should end with a @code{/} character.
699 The default value is @uref{https://gcc.gnu.org/,,https://gcc.gnu.org/}.
703 @heading Target specification
706 GCC has code to correctly determine the correct value for @var{target}
707 for nearly all native systems. Therefore, we highly recommend you do
708 not provide a configure target when configuring a native compiler.
711 @var{target} must be specified as @option{--target=@var{target}}
712 when configuring a cross compiler; examples of valid targets would be
713 m68k-elf, sh-elf, etc.
716 Specifying just @var{target} instead of @option{--target=@var{target}}
717 implies that the host defaults to @var{target}.
721 @heading Options specification
723 Use @var{options} to override several configure time options for
724 GCC@. A list of supported @var{options} follows; @samp{configure
725 --help} may list other options, but those not listed below may not
726 work and should not normally be used.
728 Note that each @option{--enable} option has a corresponding
729 @option{--disable} option and that each @option{--with} option has a
730 corresponding @option{--without} option.
733 @item --prefix=@var{dirname}
734 Specify the toplevel installation
735 directory. This is the recommended way to install the tools into a directory
736 other than the default. The toplevel installation directory defaults to
739 We @strong{highly} recommend against @var{dirname} being the same or a
740 subdirectory of @var{objdir} or vice versa. If specifying a directory
741 beneath a user's home directory tree, some shells will not expand
742 @var{dirname} correctly if it contains the @samp{~} metacharacter; use
745 The following standard @command{autoconf} options are supported. Normally you
746 should not need to use these options.
748 @item --exec-prefix=@var{dirname}
749 Specify the toplevel installation directory for architecture-dependent
750 files. The default is @file{@var{prefix}}.
752 @item --bindir=@var{dirname}
753 Specify the installation directory for the executables called by users
754 (such as @command{gcc} and @command{g++}). The default is
755 @file{@var{exec-prefix}/bin}.
757 @item --libdir=@var{dirname}
758 Specify the installation directory for object code libraries and
759 internal data files of GCC@. The default is @file{@var{exec-prefix}/lib}.
761 @item --libexecdir=@var{dirname}
762 Specify the installation directory for internal executables of GCC@.
763 The default is @file{@var{exec-prefix}/libexec}.
765 @item --with-slibdir=@var{dirname}
766 Specify the installation directory for the shared libgcc library. The
767 default is @file{@var{libdir}}.
769 @item --datarootdir=@var{dirname}
770 Specify the root of the directory tree for read-only architecture-independent
771 data files referenced by GCC@. The default is @file{@var{prefix}/share}.
773 @item --infodir=@var{dirname}
774 Specify the installation directory for documentation in info format.
775 The default is @file{@var{datarootdir}/info}.
777 @item --datadir=@var{dirname}
778 Specify the installation directory for some architecture-independent
779 data files referenced by GCC@. The default is @file{@var{datarootdir}}.
781 @item --docdir=@var{dirname}
782 Specify the installation directory for documentation files (other
783 than Info) for GCC@. The default is @file{@var{datarootdir}/doc}.
785 @item --htmldir=@var{dirname}
786 Specify the installation directory for HTML documentation files.
787 The default is @file{@var{docdir}}.
789 @item --pdfdir=@var{dirname}
790 Specify the installation directory for PDF documentation files.
791 The default is @file{@var{docdir}}.
793 @item --mandir=@var{dirname}
794 Specify the installation directory for manual pages. The default is
795 @file{@var{datarootdir}/man}. (Note that the manual pages are only extracts
796 from the full GCC manuals, which are provided in Texinfo format. The manpages
797 are derived by an automatic conversion process from parts of the full
800 @item --with-gxx-include-dir=@var{dirname}
802 the installation directory for G++ header files. The default depends
803 on other configuration options, and differs between cross and native
806 @item --with-specs=@var{specs}
807 Specify additional command line driver SPECS.
808 This can be useful if you need to turn on a non-standard feature by
809 default without modifying the compiler's source code, for instance
810 @option{--with-specs=%@{!fcommon:%@{!fno-common:-fno-common@}@}}.
812 @xref{Spec Files,, Specifying subprocesses and the switches to pass to them,
813 gcc, Using the GNU Compiler Collection (GCC)},
816 See ``Spec Files'' in the main manual
821 @item --program-prefix=@var{prefix}
822 GCC supports some transformations of the names of its programs when
823 installing them. This option prepends @var{prefix} to the names of
824 programs to install in @var{bindir} (see above). For example, specifying
825 @option{--program-prefix=foo-} would result in @samp{gcc}
826 being installed as @file{/usr/local/bin/foo-gcc}.
828 @item --program-suffix=@var{suffix}
829 Appends @var{suffix} to the names of programs to install in @var{bindir}
830 (see above). For example, specifying @option{--program-suffix=-3.1}
831 would result in @samp{gcc} being installed as
832 @file{/usr/local/bin/gcc-3.1}.
834 @item --program-transform-name=@var{pattern}
835 Applies the @samp{sed} script @var{pattern} to be applied to the names
836 of programs to install in @var{bindir} (see above). @var{pattern} has to
837 consist of one or more basic @samp{sed} editing commands, separated by
838 semicolons. For example, if you want the @samp{gcc} program name to be
839 transformed to the installed program @file{/usr/local/bin/myowngcc} and
840 the @samp{g++} program name to be transformed to
841 @file{/usr/local/bin/gspecial++} without changing other program names,
842 you could use the pattern
843 @option{--program-transform-name='s/^gcc$/myowngcc/; s/^g++$/gspecial++/'}
844 to achieve this effect.
846 All three options can be combined and used together, resulting in more
847 complex conversion patterns. As a basic rule, @var{prefix} (and
848 @var{suffix}) are prepended (appended) before further transformations
849 can happen with a special transformation script @var{pattern}.
851 As currently implemented, this option only takes effect for native
852 builds; cross compiler binaries' names are not transformed even when a
853 transformation is explicitly asked for by one of these options.
855 For native builds, some of the installed programs are also installed
856 with the target alias in front of their name, as in
857 @samp{i686-pc-linux-gnu-gcc}. All of the above transformations happen
858 before the target alias is prepended to the name---so, specifying
859 @option{--program-prefix=foo-} and @option{program-suffix=-3.1}, the
860 resulting binary would be installed as
861 @file{/usr/local/bin/i686-pc-linux-gnu-foo-gcc-3.1}.
863 As a last shortcoming, none of the installed Ada programs are
864 transformed yet, which will be fixed in some time.
866 @item --with-local-prefix=@var{dirname}
868 installation directory for local include files. The default is
869 @file{/usr/local}. Specify this option if you want the compiler to
870 search directory @file{@var{dirname}/include} for locally installed
871 header files @emph{instead} of @file{/usr/local/include}.
873 You should specify @option{--with-local-prefix} @strong{only} if your
874 site has a different convention (not @file{/usr/local}) for where to put
877 The default value for @option{--with-local-prefix} is @file{/usr/local}
878 regardless of the value of @option{--prefix}. Specifying
879 @option{--prefix} has no effect on which directory GCC searches for
880 local header files. This may seem counterintuitive, but actually it is
883 The purpose of @option{--prefix} is to specify where to @emph{install
884 GCC}. The local header files in @file{/usr/local/include}---if you put
885 any in that directory---are not part of GCC@. They are part of other
886 programs---perhaps many others. (GCC installs its own header files in
887 another directory which is based on the @option{--prefix} value.)
889 Both the local-prefix include directory and the GCC-prefix include
890 directory are part of GCC's ``system include'' directories. Although these
891 two directories are not fixed, they need to be searched in the proper
892 order for the correct processing of the include_next directive. The
893 local-prefix include directory is searched before the GCC-prefix
894 include directory. Another characteristic of system include directories
895 is that pedantic warnings are turned off for headers in these directories.
897 Some autoconf macros add @option{-I @var{directory}} options to the
898 compiler command line, to ensure that directories containing installed
899 packages' headers are searched. When @var{directory} is one of GCC's
900 system include directories, GCC will ignore the option so that system
901 directories continue to be processed in the correct order. This
902 may result in a search order different from what was specified but the
903 directory will still be searched.
905 GCC automatically searches for ordinary libraries using
906 @env{GCC_EXEC_PREFIX}. Thus, when the same installation prefix is
907 used for both GCC and packages, GCC will automatically search for
908 both headers and libraries. This provides a configuration that is
909 easy to use. GCC behaves in a manner similar to that when it is
910 installed as a system compiler in @file{/usr}.
912 Sites that need to install multiple versions of GCC may not want to
913 use the above simple configuration. It is possible to use the
914 @option{--program-prefix}, @option{--program-suffix} and
915 @option{--program-transform-name} options to install multiple versions
916 into a single directory, but it may be simpler to use different prefixes
917 and the @option{--with-local-prefix} option to specify the location of the
918 site-specific files for each version. It will then be necessary for
919 users to specify explicitly the location of local site libraries
920 (e.g., with @env{LIBRARY_PATH}).
922 The same value can be used for both @option{--with-local-prefix} and
923 @option{--prefix} provided it is not @file{/usr}. This can be used
924 to avoid the default search of @file{/usr/local/include}.
926 @strong{Do not} specify @file{/usr} as the @option{--with-local-prefix}!
927 The directory you use for @option{--with-local-prefix} @strong{must not}
928 contain any of the system's standard header files. If it did contain
929 them, certain programs would be miscompiled (including GNU Emacs, on
930 certain targets), because this would override and nullify the header
931 file corrections made by the @command{fixincludes} script.
933 Indications are that people who use this option use it based on mistaken
934 ideas of what it is for. People use it as if it specified where to
935 install part of GCC@. Perhaps they make this assumption because
936 installing GCC creates the directory.
938 @item --with-gcc-major-version-only
939 Specifies that GCC should use only the major number rather than
940 @var{major}.@var{minor}.@var{patchlevel} in filesystem paths.
942 @item --with-native-system-header-dir=@var{dirname}
943 Specifies that @var{dirname} is the directory that contains native system
944 header files, rather than @file{/usr/include}. This option is most useful
945 if you are creating a compiler that should be isolated from the system
946 as much as possible. It is most commonly used with the
947 @option{--with-sysroot} option and will cause GCC to search
948 @var{dirname} inside the system root specified by that option.
950 @item --enable-shared[=@var{package}[,@dots{}]]
951 Build shared versions of libraries, if shared libraries are supported on
952 the target platform. Unlike GCC 2.95.x and earlier, shared libraries
953 are enabled by default on all platforms that support shared libraries.
955 If a list of packages is given as an argument, build shared libraries
956 only for the listed packages. For other packages, only static libraries
957 will be built. Package names currently recognized in the GCC tree are
958 @samp{libgcc} (also known as @samp{gcc}), @samp{libstdc++} (not
959 @samp{libstdc++-v3}), @samp{libffi}, @samp{zlib}, @samp{boehm-gc},
960 @samp{ada}, @samp{libada}, @samp{libgo}, @samp{libobjc}, and @samp{libphobos}.
961 Note @samp{libiberty} does not support shared libraries at all.
963 Use @option{--disable-shared} to build only static libraries. Note that
964 @option{--disable-shared} does not accept a list of package names as
965 argument, only @option{--enable-shared} does.
967 Contrast with @option{--enable-host-shared}, which affects @emph{host}
970 @item --enable-host-shared
971 Specify that the @emph{host} code should be built into position-independent
972 machine code (with -fPIC), allowing it to be used within shared libraries,
973 but yielding a slightly slower compiler.
975 This option is required when building the libgccjit.so library.
977 Contrast with @option{--enable-shared}, which affects @emph{target}
980 @item @anchor{with-gnu-as}--with-gnu-as
981 Specify that the compiler should assume that the
982 assembler it finds is the GNU assembler. However, this does not modify
983 the rules to find an assembler and will result in confusion if the
984 assembler found is not actually the GNU assembler. (Confusion may also
985 result if the compiler finds the GNU assembler but has not been
986 configured with @option{--with-gnu-as}.) If you have more than one
987 assembler installed on your system, you may want to use this option in
988 connection with @option{--with-as=@var{pathname}} or
989 @option{--with-build-time-tools=@var{pathname}}.
991 The following systems are the only ones where it makes a difference
992 whether you use the GNU assembler. On any other system,
993 @option{--with-gnu-as} has no effect.
996 @item @samp{hppa1.0-@var{any}-@var{any}}
997 @item @samp{hppa1.1-@var{any}-@var{any}}
998 @item @samp{sparc-sun-solaris2.@var{any}}
999 @item @samp{sparc64-@var{any}-solaris2.@var{any}}
1002 @item @anchor{with-as}--with-as=@var{pathname}
1003 Specify that the compiler should use the assembler pointed to by
1004 @var{pathname}, rather than the one found by the standard rules to find
1005 an assembler, which are:
1008 Unless GCC is being built with a cross compiler, check the
1009 @file{@var{libexec}/gcc/@var{target}/@var{version}} directory.
1010 @var{libexec} defaults to @file{@var{exec-prefix}/libexec};
1011 @var{exec-prefix} defaults to @var{prefix}, which
1012 defaults to @file{/usr/local} unless overridden by the
1013 @option{--prefix=@var{pathname}} switch described above. @var{target}
1014 is the target system triple, such as @samp{sparc-sun-solaris2.7}, and
1015 @var{version} denotes the GCC version, such as 3.0.
1018 If the target system is the same that you are building on, check
1019 operating system specific directories (e.g.@: @file{/usr/ccs/bin} on
1023 Check in the @env{PATH} for a tool whose name is prefixed by the
1024 target system triple.
1027 Check in the @env{PATH} for a tool whose name is not prefixed by the
1028 target system triple, if the host and target system triple are
1029 the same (in other words, we use a host tool if it can be used for
1030 the target as well).
1033 You may want to use @option{--with-as} if no assembler
1034 is installed in the directories listed above, or if you have multiple
1035 assemblers installed and want to choose one that is not found by the
1038 @item @anchor{with-gnu-ld}--with-gnu-ld
1039 Same as @uref{#with-gnu-as,,@option{--with-gnu-as}}
1042 @item --with-ld=@var{pathname}
1043 Same as @uref{#with-as,,@option{--with-as}}
1047 Specify that stabs debugging
1048 information should be used instead of whatever format the host normally
1049 uses. Normally GCC uses the same debug format as the host system.
1051 @item --with-tls=@var{dialect}
1052 Specify the default TLS dialect, for systems were there is a choice.
1053 For ARM targets, possible values for @var{dialect} are @code{gnu} or
1054 @code{gnu2}, which select between the original GNU dialect and the GNU TLS
1055 descriptor-based dialect.
1057 @item --enable-multiarch
1058 Specify whether to enable or disable multiarch support. The default is
1059 to check for glibc start files in a multiarch location, and enable it
1060 if the files are found. The auto detection is enabled for native builds,
1061 and for cross builds configured with @option{--with-sysroot}, and without
1062 @option{--with-native-system-header-dir}.
1063 More documentation about multiarch can be found at
1064 @uref{https://wiki.debian.org/Multiarch}.
1066 @item --enable-sjlj-exceptions
1067 Force use of the @code{setjmp}/@code{longjmp}-based scheme for exceptions.
1068 @samp{configure} ordinarily picks the correct value based on the platform.
1069 Only use this option if you are sure you need a different setting.
1071 @item --enable-vtable-verify
1072 Specify whether to enable or disable the vtable verification feature.
1073 Enabling this feature causes libstdc++ to be built with its virtual calls
1074 in verifiable mode. This means that, when linked with libvtv, every
1075 virtual call in libstdc++ will verify the vtable pointer through which the
1076 call will be made before actually making the call. If not linked with libvtv,
1077 the verifier will call stub functions (in libstdc++ itself) and do nothing.
1078 If vtable verification is disabled, then libstdc++ is not built with its
1079 virtual calls in verifiable mode at all. However the libvtv library will
1080 still be built (see @option{--disable-libvtv} to turn off building libvtv).
1081 @option{--disable-vtable-verify} is the default.
1083 @item --disable-gcov
1084 Specify that the run-time library used for coverage analysis
1085 and associated host tools should not be built.
1087 @item --disable-multilib
1088 Specify that multiple target
1089 libraries to support different target variants, calling
1090 conventions, etc.@: should not be built. The default is to build a
1091 predefined set of them.
1093 Some targets provide finer-grained control over which multilibs are built
1094 (e.g., @option{--disable-softfloat}):
1097 fpu, 26bit, underscore, interwork, biendian, nofmult.
1100 softfloat, m68881, m68000, m68020.
1103 single-float, biendian, softfloat.
1108 @item powerpc*-*-*, rs6000*-*-*
1109 aix64, pthread, softfloat, powercpu, powerpccpu, powerpcos, biendian,
1114 @item --with-multilib-list=@var{list}
1115 @itemx --without-multilib-list
1116 Specify what multilibs to build. @var{list} is a comma separated list of
1117 values, possibly consisting of a single value. Currently only implemented
1118 for aarch64*-*-*, arm*-*-*, riscv*-*-*, sh*-*-* and x86-64-*-linux*. The
1119 accepted values and meaning for each target is given below.
1123 @var{list} is a comma separated list of @code{ilp32}, and @code{lp64}
1124 to enable ILP32 and LP64 run-time libraries, respectively. If
1125 @var{list} is empty, then there will be no multilibs and only the
1126 default run-time library will be built. If @var{list} is
1127 @code{default} or --with-multilib-list= is not specified, then the
1128 default set of libraries is selected based on the value of
1132 @var{list} is a comma separated list of @code{aprofile} and
1133 @code{rmprofile} to build multilibs for A or R and M architecture
1134 profiles respectively. Note that, due to some limitation of the current
1135 multilib framework, using the combined @code{aprofile,rmprofile}
1136 multilibs selects in some cases a less optimal multilib than when using
1137 the multilib profile for the architecture targetted. The special value
1138 @code{default} is also accepted and is equivalent to omitting the
1139 option, i.e., only the default run-time library will be enabled.
1141 @var{list} may instead contain @code{@@name}, to use the multilib
1142 configuration Makefile fragment @file{name} in @file{gcc/config/arm} in
1143 the source tree (it is part of the corresponding sources, after all).
1144 It is recommended, but not required, that files used for this purpose to
1145 be named starting with @file{t-ml-}, to make their intended purpose
1146 self-evident, in line with GCC conventions. Such files enable custom,
1147 user-chosen multilib lists to be configured. Whether multiple such
1148 files can be used together depends on the contents of the supplied
1149 files. See @file{gcc/config/arm/t-multilib} and its supplementary
1150 @file{gcc/config/arm/t-*profile} files for an example of what such
1151 Makefile fragments might look like for this version of GCC. The macros
1152 expected to be defined in these fragments are not stable across GCC
1153 releases, so make sure they define the @code{MULTILIB}-related macros
1154 expected by the version of GCC you are building.
1156 @xref{Target Fragment,, Target Makefile Fragments, gccint, GNU Compiler
1157 Collection (GCC) Internals}.
1160 See ``Target Makefile Fragments'' in the internals manual.
1163 The table below gives the combination of ISAs, architectures, FPUs and
1164 floating-point ABIs for which multilibs are built for each predefined
1165 profile. The union of these options is considered when specifying both
1166 @code{aprofile} and @code{rmprofile}.
1168 @multitable @columnfractions .15 .28 .30
1169 @item Option @tab aprofile @tab rmprofile
1171 @tab @code{-marm} and @code{-mthumb}
1173 @item Architectures@*@*@*@*@*@*
1174 @tab default architecture@*
1175 @code{-march=armv7-a}@*
1176 @code{-march=armv7ve}@*
1177 @code{-march=armv8-a}@*@*@*
1178 @tab default architecture@*
1179 @code{-march=armv6s-m}@*
1180 @code{-march=armv7-m}@*
1181 @code{-march=armv7e-m}@*
1182 @code{-march=armv8-m.base}@*
1183 @code{-march=armv8-m.main}@*
1185 @item FPUs@*@*@*@*@*
1187 @code{-mfpu=vfpv3-d16}@*
1189 @code{-mfpu=vfpv4-d16}@*
1190 @code{-mfpu=neon-vfpv4}@*
1191 @code{-mfpu=neon-fp-armv8}
1193 @code{-mfpu=vfpv3-d16}@*
1194 @code{-mfpu=fpv4-sp-d16}@*
1195 @code{-mfpu=fpv5-sp-d16}@*
1196 @code{-mfpu=fpv5-d16}@*
1197 @item floating-point@/ ABIs@*@*
1198 @tab @code{-mfloat-abi=soft}@*
1199 @code{-mfloat-abi=softfp}@*
1200 @code{-mfloat-abi=hard}
1201 @tab @code{-mfloat-abi=soft}@*
1202 @code{-mfloat-abi=softfp}@*
1203 @code{-mfloat-abi=hard}
1207 @var{list} is a single ABI name. The target architecture must be either
1208 @code{rv32gc} or @code{rv64gc}. This will build a single multilib for the
1209 specified architecture and ABI pair. If @code{--with-multilib-list} is not
1210 given, then a default set of multilibs is selected based on the value of
1211 @option{--target}. This is usually a large set of multilibs.
1214 @var{list} is a comma separated list of CPU names. These must be of the
1215 form @code{sh*} or @code{m*} (in which case they match the compiler option
1216 for that processor). The list should not contain any endian options -
1217 these are handled by @option{--with-endian}.
1219 If @var{list} is empty, then there will be no multilibs for extra
1220 processors. The multilib for the secondary endian remains enabled.
1222 As a special case, if an entry in the list starts with a @code{!}
1223 (exclamation point), then it is added to the list of excluded multilibs.
1224 Entries of this sort should be compatible with @samp{MULTILIB_EXCLUDES}
1225 (once the leading @code{!} has been stripped).
1227 If @option{--with-multilib-list} is not given, then a default set of
1228 multilibs is selected based on the value of @option{--target}. This is
1229 usually the complete set of libraries, but some targets imply a more
1232 Example 1: to configure a compiler for SH4A only, but supporting both
1233 endians, with little endian being the default:
1235 --with-cpu=sh4a --with-endian=little,big --with-multilib-list=
1238 Example 2: to configure a compiler for both SH4A and SH4AL-DSP, but with
1239 only little endian SH4AL:
1241 --with-cpu=sh4a --with-endian=little,big \
1242 --with-multilib-list=sh4al,!mb/m4al
1245 @item x86-64-*-linux*
1246 @var{list} is a comma separated list of @code{m32}, @code{m64} and
1247 @code{mx32} to enable 32-bit, 64-bit and x32 run-time libraries,
1248 respectively. If @var{list} is empty, then there will be no multilibs
1249 and only the default run-time library will be enabled.
1251 If @option{--with-multilib-list} is not given, then only 32-bit and
1252 64-bit run-time libraries will be enabled.
1255 @item --with-endian=@var{endians}
1256 Specify what endians to use.
1257 Currently only implemented for sh*-*-*.
1259 @var{endians} may be one of the following:
1262 Use big endian exclusively.
1264 Use little endian exclusively.
1266 Use big endian by default. Provide a multilib for little endian.
1268 Use little endian by default. Provide a multilib for big endian.
1271 @item --enable-threads
1272 Specify that the target
1273 supports threads. This affects the Objective-C compiler and runtime
1274 library, and exception handling for other languages like C++.
1275 On some systems, this is the default.
1277 In general, the best (and, in many cases, the only known) threading
1278 model available will be configured for use. Beware that on some
1279 systems, GCC has not been taught what threading models are generally
1280 available for the system. In this case, @option{--enable-threads} is an
1281 alias for @option{--enable-threads=single}.
1283 @item --disable-threads
1284 Specify that threading support should be disabled for the system.
1285 This is an alias for @option{--enable-threads=single}.
1287 @item --enable-threads=@var{lib}
1289 @var{lib} is the thread support library. This affects the Objective-C
1290 compiler and runtime library, and exception handling for other languages
1291 like C++. The possibilities for @var{lib} are:
1299 LynxOS thread support.
1301 MIPS SDE thread support.
1303 This is an alias for @samp{single}.
1305 Generic POSIX/Unix98 thread support.
1307 RTEMS thread support.
1309 Disable thread support, should work for all platforms.
1313 VxWorks thread support.
1315 Microsoft Win32 API thread support.
1319 Specify that the target supports TLS (Thread Local Storage). Usually
1320 configure can correctly determine if TLS is supported. In cases where
1321 it guesses incorrectly, TLS can be explicitly enabled or disabled with
1322 @option{--enable-tls} or @option{--disable-tls}. This can happen if
1323 the assembler supports TLS but the C library does not, or if the
1324 assumptions made by the configure test are incorrect.
1327 Specify that the target does not support TLS.
1328 This is an alias for @option{--enable-tls=no}.
1330 @item --disable-tm-clone-registry
1331 Disable TM clone registry in libgcc. It is enabled in libgcc by default.
1332 This option helps to reduce code size for embedded targets which do
1333 not use transactional memory.
1335 @item --with-cpu=@var{cpu}
1336 @itemx --with-cpu-32=@var{cpu}
1337 @itemx --with-cpu-64=@var{cpu}
1338 Specify which cpu variant the compiler should generate code for by default.
1339 @var{cpu} will be used as the default value of the @option{-mcpu=} switch.
1340 This option is only supported on some targets, including ARC, ARM, i386, M68k,
1341 PowerPC, and SPARC@. It is mandatory for ARC@. The @option{--with-cpu-32} and
1342 @option{--with-cpu-64} options specify separate default CPUs for
1343 32-bit and 64-bit modes; these options are only supported for i386,
1344 x86-64, PowerPC, and SPARC@.
1346 @item --with-schedule=@var{cpu}
1347 @itemx --with-arch=@var{cpu}
1348 @itemx --with-arch-32=@var{cpu}
1349 @itemx --with-arch-64=@var{cpu}
1350 @itemx --with-tune=@var{cpu}
1351 @itemx --with-tune-32=@var{cpu}
1352 @itemx --with-tune-64=@var{cpu}
1353 @itemx --with-abi=@var{abi}
1354 @itemx --with-fpu=@var{type}
1355 @itemx --with-float=@var{type}
1356 These configure options provide default values for the @option{-mschedule=},
1357 @option{-march=}, @option{-mtune=}, @option{-mabi=}, and @option{-mfpu=}
1358 options and for @option{-mhard-float} or @option{-msoft-float}. As with
1359 @option{--with-cpu}, which switches will be accepted and acceptable values
1360 of the arguments depend on the target.
1362 @item --with-mode=@var{mode}
1363 Specify if the compiler should default to @option{-marm} or @option{-mthumb}.
1364 This option is only supported on ARM targets.
1366 @item --with-stack-offset=@var{num}
1367 This option sets the default for the -mstack-offset=@var{num} option,
1368 and will thus generally also control the setting of this option for
1369 libraries. This option is only supported on Epiphany targets.
1371 @item --with-fpmath=@var{isa}
1372 This options sets @option{-mfpmath=sse} by default and specifies the default
1373 ISA for floating-point arithmetics. You can select either @samp{sse} which
1374 enables @option{-msse2} or @samp{avx} which enables @option{-mavx} by default.
1375 This option is only supported on i386 and x86-64 targets.
1377 @item --with-fp-32=@var{mode}
1378 On MIPS targets, set the default value for the @option{-mfp} option when using
1379 the o32 ABI. The possibilities for @var{mode} are:
1382 Use the o32 FP32 ABI extension, as with the @option{-mfp32} command-line
1385 Use the o32 FPXX ABI extension, as with the @option{-mfpxx} command-line
1388 Use the o32 FP64 ABI extension, as with the @option{-mfp64} command-line
1391 In the absence of this configuration option the default is to use the o32
1394 @item --with-odd-spreg-32
1395 On MIPS targets, set the @option{-modd-spreg} option by default when using
1398 @item --without-odd-spreg-32
1399 On MIPS targets, set the @option{-mno-odd-spreg} option by default when using
1400 the o32 ABI. This is normally used in conjunction with
1401 @option{--with-fp-32=64} in order to target the o32 FP64A ABI extension.
1403 @item --with-nan=@var{encoding}
1404 On MIPS targets, set the default encoding convention to use for the
1405 special not-a-number (NaN) IEEE 754 floating-point data. The
1406 possibilities for @var{encoding} are:
1409 Use the legacy encoding, as with the @option{-mnan=legacy} command-line
1412 Use the 754-2008 encoding, as with the @option{-mnan=2008} command-line
1415 To use this configuration option you must have an assembler version
1416 installed that supports the @option{-mnan=} command-line option too.
1417 In the absence of this configuration option the default convention is
1418 the legacy encoding, as when neither of the @option{-mnan=2008} and
1419 @option{-mnan=legacy} command-line options has been used.
1421 @item --with-divide=@var{type}
1422 Specify how the compiler should generate code for checking for
1423 division by zero. This option is only supported on the MIPS target.
1424 The possibilities for @var{type} are:
1427 Division by zero checks use conditional traps (this is the default on
1428 systems that support conditional traps).
1430 Division by zero checks use the break instruction.
1433 @c If you make --with-llsc the default for additional targets,
1434 @c update the --with-llsc description in the MIPS section below.
1437 On MIPS targets, make @option{-mllsc} the default when no
1438 @option{-mno-llsc} option is passed. This is the default for
1439 Linux-based targets, as the kernel will emulate them if the ISA does
1442 @item --without-llsc
1443 On MIPS targets, make @option{-mno-llsc} the default when no
1444 @option{-mllsc} option is passed.
1447 On MIPS targets, make @option{-msynci} the default when no
1448 @option{-mno-synci} option is passed.
1450 @item --without-synci
1451 On MIPS targets, make @option{-mno-synci} the default when no
1452 @option{-msynci} option is passed. This is the default.
1454 @item --with-lxc1-sxc1
1455 On MIPS targets, make @option{-mlxc1-sxc1} the default when no
1456 @option{-mno-lxc1-sxc1} option is passed. This is the default.
1458 @item --without-lxc1-sxc1
1459 On MIPS targets, make @option{-mno-lxc1-sxc1} the default when no
1460 @option{-mlxc1-sxc1} option is passed. The indexed load/store
1461 instructions are not directly a problem but can lead to unexpected
1462 behaviour when deployed in an application intended for a 32-bit address
1463 space but run on a 64-bit processor. The issue is seen because all
1464 known MIPS 64-bit Linux kernels execute o32 and n32 applications
1465 with 64-bit addressing enabled which affects the overflow behaviour
1466 of the indexed addressing mode. GCC will assume that ordinary
1467 32-bit arithmetic overflow behaviour is the same whether performed
1468 as an @code{addu} instruction or as part of the address calculation
1469 in @code{lwxc1} type instructions. This assumption holds true in a
1470 pure 32-bit environment and can hold true in a 64-bit environment if
1471 the address space is accurately set to be 32-bit for o32 and n32.
1474 On MIPS targets, make @option{-mmadd4} the default when no
1475 @option{-mno-madd4} option is passed. This is the default.
1477 @item --without-madd4
1478 On MIPS targets, make @option{-mno-madd4} the default when no
1479 @option{-mmadd4} option is passed. The @code{madd4} instruction
1480 family can be problematic when targeting a combination of cores that
1481 implement these instructions differently. There are two known cores
1482 that implement these as fused operations instead of unfused (where
1483 unfused is normally expected). Disabling these instructions is the
1484 only way to ensure compatible code is generated; this will incur
1485 a performance penalty.
1487 @item --with-mips-plt
1488 On MIPS targets, make use of copy relocations and PLTs.
1489 These features are extensions to the traditional
1490 SVR4-based MIPS ABIs and require support from GNU binutils
1491 and the runtime C library.
1493 @item --with-stack-clash-protection-guard-size=@var{size}
1494 On certain targets this option sets the default stack clash protection guard
1495 size as a power of two in bytes. On AArch64 @var{size} is required to be either
1496 12 (4KB) or 16 (64KB).
1498 @item --enable-__cxa_atexit
1499 Define if you want to use __cxa_atexit, rather than atexit, to
1500 register C++ destructors for local statics and global objects.
1501 This is essential for fully standards-compliant handling of
1502 destructors, but requires __cxa_atexit in libc. This option is currently
1503 only available on systems with GNU libc. When enabled, this will cause
1504 @option{-fuse-cxa-atexit} to be passed by default.
1506 @item --enable-gnu-indirect-function
1507 Define if you want to enable the @code{ifunc} attribute. This option is
1508 currently only available on systems with GNU libc on certain targets.
1510 @item --enable-target-optspace
1512 libraries should be optimized for code space instead of code speed.
1513 This is the default for the m32r platform.
1515 @item --with-cpp-install-dir=@var{dirname}
1516 Specify that the user visible @command{cpp} program should be installed
1517 in @file{@var{prefix}/@var{dirname}/cpp}, in addition to @var{bindir}.
1519 @item --enable-comdat
1520 Enable COMDAT group support. This is primarily used to override the
1521 automatically detected value.
1523 @item --enable-initfini-array
1524 Force the use of sections @code{.init_array} and @code{.fini_array}
1525 (instead of @code{.init} and @code{.fini}) for constructors and
1526 destructors. Option @option{--disable-initfini-array} has the
1527 opposite effect. If neither option is specified, the configure script
1528 will try to guess whether the @code{.init_array} and
1529 @code{.fini_array} sections are supported and, if they are, use them.
1531 @item --enable-link-mutex
1532 When building GCC, use a mutex to avoid linking the compilers for
1533 multiple languages at the same time, to avoid thrashing on build
1534 systems with limited free memory. The default is not to use such a mutex.
1536 @item --enable-maintainer-mode
1537 The build rules that regenerate the Autoconf and Automake output files as
1538 well as the GCC master message catalog @file{gcc.pot} are normally
1539 disabled. This is because it can only be rebuilt if the complete source
1540 tree is present. If you have changed the sources and want to rebuild the
1541 catalog, configuring with @option{--enable-maintainer-mode} will enable
1542 this. Note that you need a recent version of the @code{gettext} tools
1545 @item --disable-bootstrap
1546 For a native build, the default configuration is to perform
1547 a 3-stage bootstrap of the compiler when @samp{make} is invoked,
1548 testing that GCC can compile itself correctly. If you want to disable
1549 this process, you can configure with @option{--disable-bootstrap}.
1551 @item --enable-bootstrap
1552 In special cases, you may want to perform a 3-stage build
1553 even if the target and host triplets are different.
1554 This is possible when the host can run code compiled for
1555 the target (e.g.@: host is i686-linux, target is i486-linux).
1556 Starting from GCC 4.2, to do this you have to configure explicitly
1557 with @option{--enable-bootstrap}.
1559 @item --enable-generated-files-in-srcdir
1560 Neither the .c and .h files that are generated from Bison and flex nor the
1561 info manuals and man pages that are built from the .texi files are present
1562 in the repository development tree. When building GCC from that development tree,
1563 or from one of our snapshots, those generated files are placed in your
1564 build directory, which allows for the source to be in a readonly
1567 If you configure with @option{--enable-generated-files-in-srcdir} then those
1568 generated files will go into the source directory. This is mainly intended
1569 for generating release or prerelease tarballs of the GCC sources, since it
1570 is not a requirement that the users of source releases to have flex, Bison,
1573 @item --enable-version-specific-runtime-libs
1575 that runtime libraries should be installed in the compiler specific
1576 subdirectory (@file{@var{libdir}/gcc}) rather than the usual places. In
1577 addition, @samp{libstdc++}'s include files will be installed into
1578 @file{@var{libdir}} unless you overruled it by using
1579 @option{--with-gxx-include-dir=@var{dirname}}. Using this option is
1580 particularly useful if you intend to use several versions of GCC in
1581 parallel. The default is @samp{yes} for @samp{libada}, and @samp{no} for
1582 the remaining libraries.
1584 @item @anchor{WithAixSoname}--with-aix-soname=@samp{aix}, @samp{svr4} or @samp{both}
1585 Traditional AIX shared library versioning (versioned @code{Shared Object}
1586 files as members of unversioned @code{Archive Library} files named
1587 @samp{lib.a}) causes numerous headaches for package managers. However,
1588 @code{Import Files} as members of @code{Archive Library} files allow for
1589 @strong{filename-based versioning} of shared libraries as seen on Linux/SVR4,
1590 where this is called the "SONAME". But as they prevent static linking,
1591 @code{Import Files} may be used with @code{Runtime Linking} only, where the
1592 linker does search for @samp{libNAME.so} before @samp{libNAME.a} library
1593 filenames with the @samp{-lNAME} linker flag.
1595 @anchor{AixLdCommand}For detailed information please refer to the AIX
1596 @uref{https://www.ibm.com/support/knowledgecenter/search/%22the%20ld%20command%2C%20also%20called%20the%20linkage%20editor%20or%20binder%22,,ld
1599 As long as shared library creation is enabled, upon:
1601 @item --with-aix-soname=aix
1602 @item --with-aix-soname=both
1603 A (traditional AIX) @code{Shared Archive Library} file is created:
1605 @item using the @samp{libNAME.a} filename scheme
1606 @item with the @code{Shared Object} file as archive member named
1607 @samp{libNAME.so.V} (except for @samp{libgcc_s}, where the @code{Shared
1608 Object} file is named @samp{shr.o} for backwards compatibility), which
1610 @item is used for runtime loading from inside the @samp{libNAME.a} file
1611 @item is used for dynamic loading via
1612 @code{dlopen("libNAME.a(libNAME.so.V)", RTLD_MEMBER)}
1613 @item is used for shared linking
1614 @item is used for static linking, so no separate @code{Static Archive
1615 Library} file is needed
1618 @item --with-aix-soname=both
1619 @item --with-aix-soname=svr4
1620 A (second) @code{Shared Archive Library} file is created:
1622 @item using the @samp{libNAME.so.V} filename scheme
1623 @item with the @code{Shared Object} file as archive member named
1626 @item is created with the @code{-G linker flag}
1627 @item has the @code{F_LOADONLY} flag set
1628 @item is used for runtime loading from inside the @samp{libNAME.so.V} file
1629 @item is used for dynamic loading via @code{dlopen("libNAME.so.V(shr.o)",
1632 @item with the @code{Import File} as archive member named @samp{shr.imp},
1635 @item refers to @samp{libNAME.so.V(shr.o)} as the "SONAME", to be recorded
1636 in the @code{Loader Section} of subsequent binaries
1637 @item indicates whether @samp{libNAME.so.V(shr.o)} is 32 or 64 bit
1638 @item lists all the public symbols exported by @samp{lib.so.V(shr.o)},
1639 eventually decorated with the @code{@samp{weak} Keyword}
1640 @item is necessary for shared linking against @samp{lib.so.V(shr.o)}
1643 A symbolic link using the @samp{libNAME.so} filename scheme is created:
1645 @item pointing to the @samp{libNAME.so.V} @code{Shared Archive Library} file
1646 @item to permit the @code{ld Command} to find @samp{lib.so.V(shr.imp)} via
1647 the @samp{-lNAME} argument (requires @code{Runtime Linking} to be enabled)
1648 @item to permit dynamic loading of @samp{lib.so.V(shr.o)} without the need
1649 to specify the version number via @code{dlopen("libNAME.so(shr.o)",
1654 As long as static library creation is enabled, upon:
1656 @item --with-aix-soname=svr4
1657 A @code{Static Archive Library} is created:
1659 @item using the @samp{libNAME.a} filename scheme
1660 @item with all the @code{Static Object} files as archive members, which
1662 @item are used for static linking
1667 While the aix-soname=@samp{svr4} option does not create @code{Shared Object}
1668 files as members of unversioned @code{Archive Library} files any more, package
1669 managers still are responsible to
1670 @uref{./specific.html#TransferAixShobj,,transfer} @code{Shared Object} files
1671 found as member of a previously installed unversioned @code{Archive Library}
1672 file into the newly installed @code{Archive Library} file with the same
1675 @emph{WARNING:} Creating @code{Shared Object} files with @code{Runtime Linking}
1676 enabled may bloat the TOC, eventually leading to @code{TOC overflow} errors,
1677 requiring the use of either the @option{-Wl,-bbigtoc} linker flag (seen to
1678 break with the @code{GDB} debugger) or some of the TOC-related compiler flags,
1680 @xref{RS/6000 and PowerPC Options,, RS/6000 and PowerPC Options, gcc,
1681 Using the GNU Compiler Collection (GCC)}.
1684 see ``RS/6000 and PowerPC Options'' in the main manual.
1687 @option{--with-aix-soname} is currently supported by @samp{libgcc_s} only, so
1688 this option is still experimental and not for normal use yet.
1690 Default is the traditional behavior @option{--with-aix-soname=@samp{aix}}.
1692 @item --enable-languages=@var{lang1},@var{lang2},@dots{}
1693 Specify that only a particular subset of compilers and
1694 their runtime libraries should be built. For a list of valid values for
1695 @var{langN} you can issue the following command in the
1696 @file{gcc} directory of your GCC source tree:@*
1698 grep ^language= */config-lang.in
1700 Currently, you can use any of the following:
1701 @code{all}, @code{default}, @code{ada}, @code{c}, @code{c++}, @code{d},
1702 @code{fortran}, @code{go}, @code{jit}, @code{lto}, @code{objc}, @code{obj-c++}.
1703 Building the Ada compiler has special requirements, see below.
1704 If you do not pass this flag, or specify the option @code{default}, then the
1705 default languages available in the @file{gcc} sub-tree will be configured.
1706 Ada, D, Go, Jit, and Objective-C++ are not default languages. LTO is not a
1707 default language, but is built by default because @option{--enable-lto} is
1708 enabled by default. The other languages are default languages. If
1709 @code{all} is specified, then all available languages are built. An
1710 exception is @code{jit} language, which requires
1711 @option{--enable-host-shared} to be included with @code{all}.
1713 @item --enable-stage1-languages=@var{lang1},@var{lang2},@dots{}
1714 Specify that a particular subset of compilers and their runtime
1715 libraries should be built with the system C compiler during stage 1 of
1716 the bootstrap process, rather than only in later stages with the
1717 bootstrapped C compiler. The list of valid values is the same as for
1718 @option{--enable-languages}, and the option @code{all} will select all
1719 of the languages enabled by @option{--enable-languages}. This option is
1720 primarily useful for GCC development; for instance, when a development
1721 version of the compiler cannot bootstrap due to compiler bugs, or when
1722 one is debugging front ends other than the C front end. When this
1723 option is used, one can then build the target libraries for the
1724 specified languages with the stage-1 compiler by using @command{make
1725 stage1-bubble all-target}, or run the testsuite on the stage-1 compiler
1726 for the specified languages using @command{make stage1-start check-gcc}.
1728 @item --disable-libada
1729 Specify that the run-time libraries and tools used by GNAT should not
1730 be built. This can be useful for debugging, or for compatibility with
1731 previous Ada build procedures, when it was required to explicitly
1732 do a @samp{make -C gcc gnatlib_and_tools}.
1734 @item --disable-libsanitizer
1735 Specify that the run-time libraries for the various sanitizers should
1738 @item --disable-libssp
1739 Specify that the run-time libraries for stack smashing protection
1740 should not be built or linked against. On many targets library support
1741 is provided by the C library instead.
1743 @item --disable-libquadmath
1744 Specify that the GCC quad-precision math library should not be built.
1745 On some systems, the library is required to be linkable when building
1746 the Fortran front end, unless @option{--disable-libquadmath-support}
1749 @item --disable-libquadmath-support
1750 Specify that the Fortran front end and @code{libgfortran} do not add
1751 support for @code{libquadmath} on systems supporting it.
1753 @item --disable-libgomp
1754 Specify that the GNU Offloading and Multi Processing Runtime Library
1755 should not be built.
1757 @item --disable-libvtv
1758 Specify that the run-time libraries used by vtable verification
1759 should not be built.
1762 Specify that the compiler should
1763 use DWARF 2 debugging information as the default.
1765 @item --with-advance-toolchain=@var{at}
1766 On 64-bit PowerPC Linux systems, configure the compiler to use the
1767 header files, library files, and the dynamic linker from the Advance
1768 Toolchain release @var{at} instead of the default versions that are
1769 provided by the Linux distribution. In general, this option is
1770 intended for the developers of GCC, and it is not intended for general
1773 @item --enable-targets=all
1774 @itemx --enable-targets=@var{target_list}
1775 Some GCC targets, e.g.@: powerpc64-linux, build bi-arch compilers.
1776 These are compilers that are able to generate either 64-bit or 32-bit
1777 code. Typically, the corresponding 32-bit target, e.g.@:
1778 powerpc-linux for powerpc64-linux, only generates 32-bit code. This
1779 option enables the 32-bit target to be a bi-arch compiler, which is
1780 useful when you want a bi-arch compiler that defaults to 32-bit, and
1781 you are building a bi-arch or multi-arch binutils in a combined tree.
1782 On mips-linux, this will build a tri-arch compiler (ABI o32/n32/64),
1784 Currently, this option only affects sparc-linux, powerpc-linux, x86-linux,
1785 mips-linux and s390-linux.
1787 @item --enable-default-pie
1788 Turn on @option{-fPIE} and @option{-pie} by default.
1790 @item --enable-secureplt
1791 This option enables @option{-msecure-plt} by default for powerpc-linux.
1793 @xref{RS/6000 and PowerPC Options,, RS/6000 and PowerPC Options, gcc,
1794 Using the GNU Compiler Collection (GCC)},
1797 See ``RS/6000 and PowerPC Options'' in the main manual
1800 @item --enable-default-ssp
1801 Turn on @option{-fstack-protector-strong} by default.
1804 This option enables @option{-mcld} by default for 32-bit x86 targets.
1806 @xref{i386 and x86-64 Options,, i386 and x86-64 Options, gcc,
1807 Using the GNU Compiler Collection (GCC)},
1810 See ``i386 and x86-64 Options'' in the main manual
1813 @item --enable-large-address-aware
1814 The @option{--enable-large-address-aware} option arranges for MinGW
1815 executables to be linked using the @option{--large-address-aware}
1816 option, that enables the use of more than 2GB of memory. If GCC is
1817 configured with this option, its effects can be reversed by passing the
1818 @option{-Wl,--disable-large-address-aware} option to the so-configured
1821 @item --enable-win32-registry
1822 @itemx --enable-win32-registry=@var{key}
1823 @itemx --disable-win32-registry
1824 The @option{--enable-win32-registry} option enables Microsoft Windows-hosted GCC
1825 to look up installations paths in the registry using the following key:
1828 @code{HKEY_LOCAL_MACHINE\SOFTWARE\Free Software Foundation\@var{key}}
1831 @var{key} defaults to GCC version number, and can be overridden by the
1832 @option{--enable-win32-registry=@var{key}} option. Vendors and distributors
1833 who use custom installers are encouraged to provide a different key,
1834 perhaps one comprised of vendor name and GCC version number, to
1835 avoid conflict with existing installations. This feature is enabled
1836 by default, and can be disabled by @option{--disable-win32-registry}
1837 option. This option has no effect on the other hosts.
1840 Specify that the machine does not have a floating point unit. This
1841 option only applies to @samp{m68k-sun-sunos@var{n}}. On any other
1842 system, @option{--nfp} has no effect.
1844 @item --enable-werror
1845 @itemx --disable-werror
1846 @itemx --enable-werror=yes
1847 @itemx --enable-werror=no
1848 When you specify this option, it controls whether certain files in the
1849 compiler are built with @option{-Werror} in bootstrap stage2 and later.
1850 If you don't specify it, @option{-Werror} is turned on for the main
1851 development trunk. However it defaults to off for release branches and
1852 final releases. The specific files which get @option{-Werror} are
1853 controlled by the Makefiles.
1855 @item --enable-checking
1856 @itemx --disable-checking
1857 @itemx --enable-checking=@var{list}
1858 This option controls performing internal consistency checks in the compiler.
1859 It does not change the generated code, but adds error checking of the
1860 requested complexity. This slows down the compiler and may only work
1861 properly if you are building the compiler with GCC@.
1863 When the option is not specified, the active set of checks depends on context.
1864 Namely, bootstrap stage 1 defaults to @samp{--enable-checking=yes}, builds
1865 from release branches or release archives default to
1866 @samp{--enable-checking=release}, and otherwise
1867 @samp{--enable-checking=yes,extra} is used. When the option is
1868 specified without a @var{list}, the result is the same as
1869 @samp{--enable-checking=yes}. Likewise, @samp{--disable-checking} is
1870 equivalent to @samp{--enable-checking=no}.
1872 The categories of checks available in @var{list} are @samp{yes} (most common
1873 checks @samp{assert,misc,gc,gimple,rtlflag,runtime,tree,types}), @samp{no}
1874 (no checks at all), @samp{all} (all but @samp{valgrind}), @samp{release}
1875 (cheapest checks @samp{assert,runtime}) or @samp{none} (same as @samp{no}).
1876 @samp{release} checks are always on and to disable them
1877 @samp{--disable-checking} or @samp{--enable-checking=no[,<other checks>]}
1878 must be explicitly requested. Disabling assertions makes the compiler and
1879 runtime slightly faster but increases the risk of undetected internal errors
1880 causing wrong code to be generated.
1882 Individual checks can be enabled with these flags: @samp{assert}, @samp{df},
1883 @samp{extra}, @samp{fold}, @samp{gc}, @samp{gcac}, @samp{gimple},
1884 @samp{misc}, @samp{rtl}, @samp{rtlflag}, @samp{runtime}, @samp{tree},
1885 @samp{types} and @samp{valgrind}. @samp{extra} extends @samp{misc}
1886 checking with extra checks that might affect code generation and should
1887 therefore not differ between stage1 and later stages in bootstrap.
1889 The @samp{valgrind} check requires the external @command{valgrind} simulator,
1890 available from @uref{http://valgrind.org/}. The @samp{rtl} checks are
1891 expensive and the @samp{df}, @samp{gcac} and @samp{valgrind} checks are very
1894 @item --disable-stage1-checking
1895 @itemx --enable-stage1-checking
1896 @itemx --enable-stage1-checking=@var{list}
1897 This option affects only bootstrap build. If no @option{--enable-checking}
1898 option is specified the stage1 compiler is built with @samp{yes} checking
1899 enabled, otherwise the stage1 checking flags are the same as specified by
1900 @option{--enable-checking}. To build the stage1 compiler with
1901 different checking options use @option{--enable-stage1-checking}.
1902 The list of checking options is the same as for @option{--enable-checking}.
1903 If your system is too slow or too small to bootstrap a released compiler
1904 with checking for stage1 enabled, you can use @samp{--disable-stage1-checking}
1905 to disable checking for the stage1 compiler.
1907 @item --enable-coverage
1908 @itemx --enable-coverage=@var{level}
1909 With this option, the compiler is built to collect self coverage
1910 information, every time it is run. This is for internal development
1911 purposes, and only works when the compiler is being built with gcc. The
1912 @var{level} argument controls whether the compiler is built optimized or
1913 not, values are @samp{opt} and @samp{noopt}. For coverage analysis you
1914 want to disable optimization, for performance analysis you want to
1915 enable optimization. When coverage is enabled, the default level is
1916 without optimization.
1918 @item --enable-gather-detailed-mem-stats
1919 When this option is specified more detailed information on memory
1920 allocation is gathered. This information is printed when using
1921 @option{-fmem-report}.
1923 @item --enable-valgrind-annotations
1924 Mark selected memory related operations in the compiler when run under
1925 valgrind to suppress false positives.
1928 @itemx --disable-nls
1929 The @option{--enable-nls} option enables Native Language Support (NLS),
1930 which lets GCC output diagnostics in languages other than American
1931 English. Native Language Support is enabled by default if not doing a
1932 canadian cross build. The @option{--disable-nls} option disables NLS@.
1934 @item --with-included-gettext
1935 If NLS is enabled, the @option{--with-included-gettext} option causes the build
1936 procedure to prefer its copy of GNU @command{gettext}.
1938 @item --with-catgets
1939 If NLS is enabled, and if the host lacks @code{gettext} but has the
1940 inferior @code{catgets} interface, the GCC build procedure normally
1941 ignores @code{catgets} and instead uses GCC's copy of the GNU
1942 @code{gettext} library. The @option{--with-catgets} option causes the
1943 build procedure to use the host's @code{catgets} in this situation.
1945 @item --with-libiconv-prefix=@var{dir}
1946 Search for libiconv header files in @file{@var{dir}/include} and
1947 libiconv library files in @file{@var{dir}/lib}.
1949 @item --enable-obsolete
1950 Enable configuration for an obsoleted system. If you attempt to
1951 configure GCC for a system (build, host, or target) which has been
1952 obsoleted, and you do not specify this flag, configure will halt with an
1955 All support for systems which have been obsoleted in one release of GCC
1956 is removed entirely in the next major release, unless someone steps
1957 forward to maintain the port.
1959 @item --enable-decimal-float
1960 @itemx --enable-decimal-float=yes
1961 @itemx --enable-decimal-float=no
1962 @itemx --enable-decimal-float=bid
1963 @itemx --enable-decimal-float=dpd
1964 @itemx --disable-decimal-float
1965 Enable (or disable) support for the C decimal floating point extension
1966 that is in the IEEE 754-2008 standard. This is enabled by default only
1967 on PowerPC, i386, and x86_64 GNU/Linux systems. Other systems may also
1968 support it, but require the user to specifically enable it. You can
1969 optionally control which decimal floating point format is used (either
1970 @samp{bid} or @samp{dpd}). The @samp{bid} (binary integer decimal)
1971 format is default on i386 and x86_64 systems, and the @samp{dpd}
1972 (densely packed decimal) format is default on PowerPC systems.
1974 @item --enable-fixed-point
1975 @itemx --disable-fixed-point
1976 Enable (or disable) support for C fixed-point arithmetic.
1977 This option is enabled by default for some targets (such as MIPS) which
1978 have hardware-support for fixed-point operations. On other targets, you
1979 may enable this option manually.
1981 @item --with-long-double-128
1982 Specify if @code{long double} type should be 128-bit by default on selected
1983 GNU/Linux architectures. If using @code{--without-long-double-128},
1984 @code{long double} will be by default 64-bit, the same as @code{double} type.
1985 When neither of these configure options are used, the default will be
1986 128-bit @code{long double} when built against GNU C Library 2.4 and later,
1987 64-bit @code{long double} otherwise.
1989 @item --with-long-double-format=ibm
1990 @itemx --with-long-double-format=ieee
1991 Specify whether @code{long double} uses the IBM extended double format
1992 or the IEEE 128-bit floating point format on PowerPC Linux systems.
1993 This configuration switch will only work on little endian PowerPC
1994 Linux systems and on big endian 64-bit systems where the default cpu
1995 is at least power7 (i.e.@: @option{--with-cpu=power7},
1996 @option{--with-cpu=power8}, or @option{--with-cpu=power9} is used).
1998 If you use the @option{--with-long-double-64} configuration option,
1999 the @option{--with-long-double-format=ibm} and
2000 @option{--with-long-double-format=ieee} options are ignored.
2002 The default @code{long double} format is to use IBM extended double.
2003 Until all of the libraries are converted to use IEEE 128-bit floating
2004 point, it is not recommended to use
2005 @option{--with-long-double-format=ieee}.
2007 On little endian PowerPC Linux systems, if you explicitly set the
2008 @code{long double} type, it will build multilibs to allow you to
2009 select either @code{long double} format, unless you disable multilibs
2010 with the @code{--disable-multilib} option. At present,
2011 @code{long double} multilibs are not built on big endian PowerPC Linux
2012 systems. If you are building multilibs, you will need to configure
2013 the compiler using the @option{--with-system-zlib} option.
2015 If you do not set the @code{long double} type explicitly, no multilibs
2018 @item --enable-fdpic
2019 On SH Linux systems, generate ELF FDPIC code.
2021 @item --with-gmp=@var{pathname}
2022 @itemx --with-gmp-include=@var{pathname}
2023 @itemx --with-gmp-lib=@var{pathname}
2024 @itemx --with-mpfr=@var{pathname}
2025 @itemx --with-mpfr-include=@var{pathname}
2026 @itemx --with-mpfr-lib=@var{pathname}
2027 @itemx --with-mpc=@var{pathname}
2028 @itemx --with-mpc-include=@var{pathname}
2029 @itemx --with-mpc-lib=@var{pathname}
2030 If you want to build GCC but do not have the GMP library, the MPFR
2031 library and/or the MPC library installed in a standard location and
2032 do not have their sources present in the GCC source tree then you
2033 can explicitly specify the directory where they are installed
2034 (@samp{--with-gmp=@var{gmpinstalldir}},
2035 @samp{--with-mpfr=@/@var{mpfrinstalldir}},
2036 @samp{--with-mpc=@/@var{mpcinstalldir}}). The
2037 @option{--with-gmp=@/@var{gmpinstalldir}} option is shorthand for
2038 @option{--with-gmp-lib=@/@var{gmpinstalldir}/lib} and
2039 @option{--with-gmp-include=@/@var{gmpinstalldir}/include}. Likewise the
2040 @option{--with-mpfr=@/@var{mpfrinstalldir}} option is shorthand for
2041 @option{--with-mpfr-lib=@/@var{mpfrinstalldir}/lib} and
2042 @option{--with-mpfr-include=@/@var{mpfrinstalldir}/include}, also the
2043 @option{--with-mpc=@/@var{mpcinstalldir}} option is shorthand for
2044 @option{--with-mpc-lib=@/@var{mpcinstalldir}/lib} and
2045 @option{--with-mpc-include=@/@var{mpcinstalldir}/include}. If these
2046 shorthand assumptions are not correct, you can use the explicit
2047 include and lib options directly. You might also need to ensure the
2048 shared libraries can be found by the dynamic linker when building and
2049 using GCC, for example by setting the runtime shared library path
2050 variable (@env{LD_LIBRARY_PATH} on GNU/Linux and Solaris systems).
2052 These flags are applicable to the host platform only. When building
2053 a cross compiler, they will not be used to configure target libraries.
2055 @item --with-isl=@var{pathname}
2056 @itemx --with-isl-include=@var{pathname}
2057 @itemx --with-isl-lib=@var{pathname}
2058 If you do not have the isl library installed in a standard location and you
2059 want to build GCC, you can explicitly specify the directory where it is
2060 installed (@samp{--with-isl=@/@var{islinstalldir}}). The
2061 @option{--with-isl=@/@var{islinstalldir}} option is shorthand for
2062 @option{--with-isl-lib=@/@var{islinstalldir}/lib} and
2063 @option{--with-isl-include=@/@var{islinstalldir}/include}. If this
2064 shorthand assumption is not correct, you can use the explicit
2065 include and lib options directly.
2067 These flags are applicable to the host platform only. When building
2068 a cross compiler, they will not be used to configure target libraries.
2070 @item --with-stage1-ldflags=@var{flags}
2071 This option may be used to set linker flags to be used when linking
2072 stage 1 of GCC. These are also used when linking GCC if configured with
2073 @option{--disable-bootstrap}. If @option{--with-stage1-libs} is not set to a
2074 value, then the default is @samp{-static-libstdc++ -static-libgcc}, if
2077 @item --with-stage1-libs=@var{libs}
2078 This option may be used to set libraries to be used when linking stage 1
2079 of GCC. These are also used when linking GCC if configured with
2080 @option{--disable-bootstrap}.
2082 @item --with-boot-ldflags=@var{flags}
2083 This option may be used to set linker flags to be used when linking
2084 stage 2 and later when bootstrapping GCC. If --with-boot-libs
2085 is not is set to a value, then the default is
2086 @samp{-static-libstdc++ -static-libgcc}.
2088 @item --with-boot-libs=@var{libs}
2089 This option may be used to set libraries to be used when linking stage 2
2090 and later when bootstrapping GCC.
2092 @item --with-debug-prefix-map=@var{map}
2093 Convert source directory names using @option{-fdebug-prefix-map} when
2094 building runtime libraries. @samp{@var{map}} is a space-separated
2095 list of maps of the form @samp{@var{old}=@var{new}}.
2097 @item --enable-linker-build-id
2098 Tells GCC to pass @option{--build-id} option to the linker for all final
2099 links (links performed without the @option{-r} or @option{--relocatable}
2100 option), if the linker supports it. If you specify
2101 @option{--enable-linker-build-id}, but your linker does not
2102 support @option{--build-id} option, a warning is issued and the
2103 @option{--enable-linker-build-id} option is ignored. The default is off.
2105 @item --with-linker-hash-style=@var{choice}
2106 Tells GCC to pass @option{--hash-style=@var{choice}} option to the
2107 linker for all final links. @var{choice} can be one of
2108 @samp{sysv}, @samp{gnu}, and @samp{both} where @samp{sysv} is the default.
2110 @item --enable-gnu-unique-object
2111 @itemx --disable-gnu-unique-object
2112 Tells GCC to use the gnu_unique_object relocation for C++ template
2113 static data members and inline function local statics. Enabled by
2114 default for a toolchain with an assembler that accepts it and
2115 GLIBC 2.11 or above, otherwise disabled.
2117 @item --with-diagnostics-color=@var{choice}
2118 Tells GCC to use @var{choice} as the default for @option{-fdiagnostics-color=}
2119 option (if not used explicitly on the command line). @var{choice}
2120 can be one of @samp{never}, @samp{auto}, @samp{always}, and @samp{auto-if-env}
2121 where @samp{auto} is the default. @samp{auto-if-env} makes
2122 @option{-fdiagnostics-color=auto} the default if @env{GCC_COLORS}
2123 is present and non-empty in the environment of the compiler, and
2124 @option{-fdiagnostics-color=never} otherwise.
2126 @item --with-diagnostics-urls=@var{choice}
2127 Tells GCC to use @var{choice} as the default for @option{-fdiagnostics-urls=}
2128 option (if not used explicitly on the command line). @var{choice}
2129 can be one of @samp{never}, @samp{auto}, @samp{always}, and @samp{auto-if-env}
2130 where @samp{auto} is the default. @samp{auto-if-env} makes
2131 @option{-fdiagnostics-urls=auto} the default if @env{GCC_URLS}
2132 or @env{TERM_URLS} is present and non-empty in the environment of the
2133 compiler, and @option{-fdiagnostics-urls=never} otherwise.
2136 @itemx --disable-lto
2137 Enable support for link-time optimization (LTO). This is enabled by
2138 default, and may be disabled using @option{--disable-lto}.
2140 @item --enable-linker-plugin-configure-flags=FLAGS
2141 @itemx --enable-linker-plugin-flags=FLAGS
2142 By default, linker plugins (such as the LTO plugin) are built for the
2143 host system architecture. For the case that the linker has a
2144 different (but run-time compatible) architecture, these flags can be
2145 specified to build plugins that are compatible to the linker. For
2146 example, if you are building GCC for a 64-bit x86_64
2147 (@samp{x86_64-pc-linux-gnu}) host system, but have a 32-bit x86
2148 GNU/Linux (@samp{i686-pc-linux-gnu}) linker executable (which is
2149 executable on the former system), you can configure GCC as follows for
2150 getting compatible linker plugins:
2153 % @var{srcdir}/configure \
2154 --host=x86_64-pc-linux-gnu \
2155 --enable-linker-plugin-configure-flags=--host=i686-pc-linux-gnu \
2156 --enable-linker-plugin-flags='CC=gcc\ -m32\ -Wl,-rpath,[...]/i686-pc-linux-gnu/lib'
2159 @item --with-plugin-ld=@var{pathname}
2160 Enable an alternate linker to be used at link-time optimization (LTO)
2161 link time when @option{-fuse-linker-plugin} is enabled.
2162 This linker should have plugin support such as gold starting with
2163 version 2.20 or GNU ld starting with version 2.21.
2164 See @option{-fuse-linker-plugin} for details.
2166 @item --enable-canonical-system-headers
2167 @itemx --disable-canonical-system-headers
2168 Enable system header path canonicalization for @file{libcpp}. This can
2169 produce shorter header file paths in diagnostics and dependency output
2170 files, but these changed header paths may conflict with some compilation
2171 environments. Enabled by default, and may be disabled using
2172 @option{--disable-canonical-system-headers}.
2174 @item --with-glibc-version=@var{major}.@var{minor}
2175 Tell GCC that when the GNU C Library (glibc) is used on the target it
2176 will be version @var{major}.@var{minor} or later. Normally this can
2177 be detected from the C library's header files, but this option may be
2178 needed when bootstrapping a cross toolchain without the header files
2179 available for building the initial bootstrap compiler.
2181 If GCC is configured with some multilibs that use glibc and some that
2182 do not, this option applies only to the multilibs that use glibc.
2183 However, such configurations may not work well as not all the relevant
2184 configuration in GCC is on a per-multilib basis.
2186 @item --enable-as-accelerator-for=@var{target}
2187 Build as offload target compiler. Specify offload host triple by @var{target}.
2189 @item --enable-offload-targets=@var{target1}[=@var{path1}],@dots{},@var{targetN}[=@var{pathN}]
2190 Enable offloading to targets @var{target1}, @dots{}, @var{targetN}.
2191 Offload compilers are expected to be already installed. Default search
2192 path for them is @file{@var{exec-prefix}}, but it can be changed by
2193 specifying paths @var{path1}, @dots{}, @var{pathN}.
2196 % @var{srcdir}/configure \
2197 --enable-offload-targets=x86_64-intelmicemul-linux-gnu=/path/to/x86_64/compiler,nvptx-none,hsa
2200 If @samp{hsa} is specified as one of the targets, the compiler will be
2201 built with support for HSA GPU accelerators. Because the same
2202 compiler will emit the accelerator code, no path should be specified.
2204 @item --with-hsa-runtime=@var{pathname}
2205 @itemx --with-hsa-runtime-include=@var{pathname}
2206 @itemx --with-hsa-runtime-lib=@var{pathname}
2208 If you configure GCC with HSA offloading but do not have the HSA
2209 run-time library installed in a standard location then you can
2210 explicitly specify the directory where they are installed. The
2211 @option{--with-hsa-runtime=@/@var{hsainstalldir}} option is a
2213 @option{--with-hsa-runtime-lib=@/@var{hsainstalldir}/lib} and
2214 @option{--with-hsa-runtime-include=@/@var{hsainstalldir}/include}.
2217 @itemx --disable-cet
2218 Enable building target run-time libraries with control-flow
2219 instrumentation, see @option{-fcf-protection} option. When
2220 @code{--enable-cet} is specified target libraries are configured
2221 to add @option{-fcf-protection} and, if needed, other target
2222 specific options to a set of building options.
2224 The option is disabled by default. When @code{--enable-cet=auto}
2225 is used, it is enabled on Linux/x86 if target binutils
2226 supports @code{Intel CET} instructions and disabled otherwise.
2227 In this case the target libraries are configured to get additional
2228 @option{-fcf-protection} option.
2230 @item --with-riscv-attribute=@samp{yes}, @samp{no} or @samp{default}
2231 Generate RISC-V attribute by default, in order to record extra build
2232 information in object.
2234 The option is disabled by default. It is enabled on RISC-V/ELF (bare-metal)
2235 target if target binutils supported.
2238 @subheading Cross-Compiler-Specific Options
2239 The following options only apply to building cross compilers.
2242 @item --with-toolexeclibdir=@var{dir}
2243 Specify the installation directory for libraries built with a cross compiler.
2244 The default is @option{$@{gcc_tooldir@}/lib}.
2246 @item --with-sysroot
2247 @itemx --with-sysroot=@var{dir}
2248 Tells GCC to consider @var{dir} as the root of a tree that contains
2249 (a subset of) the root filesystem of the target operating system.
2250 Target system headers, libraries and run-time object files will be
2251 searched for in there. More specifically, this acts as if
2252 @option{--sysroot=@var{dir}} was added to the default options of the built
2253 compiler. The specified directory is not copied into the
2254 install tree, unlike the options @option{--with-headers} and
2255 @option{--with-libs} that this option obsoletes. The default value,
2256 in case @option{--with-sysroot} is not given an argument, is
2257 @option{$@{gcc_tooldir@}/sys-root}. If the specified directory is a
2258 subdirectory of @option{$@{exec_prefix@}}, then it will be found relative to
2259 the GCC binaries if the installation tree is moved.
2261 This option affects the system root for the compiler used to build
2262 target libraries (which runs on the build system) and the compiler newly
2263 installed with @code{make install}; it does not affect the compiler which is
2264 used to build GCC itself.
2266 If you specify the @option{--with-native-system-header-dir=@var{dirname}}
2267 option then the compiler will search that directory within @var{dirname} for
2268 native system headers rather than the default @file{/usr/include}.
2270 @item --with-build-sysroot
2271 @itemx --with-build-sysroot=@var{dir}
2272 Tells GCC to consider @var{dir} as the system root (see
2273 @option{--with-sysroot}) while building target libraries, instead of
2274 the directory specified with @option{--with-sysroot}. This option is
2275 only useful when you are already using @option{--with-sysroot}. You
2276 can use @option{--with-build-sysroot} when you are configuring with
2277 @option{--prefix} set to a directory that is different from the one in
2278 which you are installing GCC and your target libraries.
2280 This option affects the system root for the compiler used to build
2281 target libraries (which runs on the build system); it does not affect
2282 the compiler which is used to build GCC itself.
2284 If you specify the @option{--with-native-system-header-dir=@var{dirname}}
2285 option then the compiler will search that directory within @var{dirname} for
2286 native system headers rather than the default @file{/usr/include}.
2288 @item --with-headers
2289 @itemx --with-headers=@var{dir}
2290 Deprecated in favor of @option{--with-sysroot}.
2291 Specifies that target headers are available when building a cross compiler.
2292 The @var{dir} argument specifies a directory which has the target include
2293 files. These include files will be copied into the @file{gcc} install
2294 directory. @emph{This option with the @var{dir} argument is required} when
2295 building a cross compiler, if @file{@var{prefix}/@var{target}/sys-include}
2296 doesn't pre-exist. If @file{@var{prefix}/@var{target}/sys-include} does
2297 pre-exist, the @var{dir} argument may be omitted. @command{fixincludes}
2298 will be run on these files to make them compatible with GCC@.
2300 @item --without-headers
2301 Tells GCC not use any target headers from a libc when building a cross
2302 compiler. When crossing to GNU/Linux, you need the headers so GCC
2303 can build the exception handling for libgcc.
2306 @itemx --with-libs="@var{dir1} @var{dir2} @dots{} @var{dirN}"
2307 Deprecated in favor of @option{--with-sysroot}.
2308 Specifies a list of directories which contain the target runtime
2309 libraries. These libraries will be copied into the @file{gcc} install
2310 directory. If the directory list is omitted, this option has no
2314 Specifies that @samp{newlib} is
2315 being used as the target C library. This causes @code{__eprintf} to be
2316 omitted from @file{libgcc.a} on the assumption that it will be provided by
2322 @item --with-avrlibc
2323 Only supported for the AVR target. Specifies that @samp{AVR-Libc} is
2324 being used as the target C@tie{} library. This causes float support
2325 functions like @code{__addsf3} to be omitted from @file{libgcc.a} on
2326 the assumption that it will be provided by @file{libm.a}. For more
2327 technical details, cf. @uref{http://gcc.gnu.org/PR54461,,PR54461}.
2328 It is not supported for
2329 RTEMS configurations, which currently use newlib. The option is
2330 supported since version 4.7.2 and is the default in 4.8.0 and newer.
2332 @item --with-double=@{32|64|32,64|64,32@}
2333 @itemx --with-long-double=@{32|64|32,64|64,32|double@}
2334 Only supported for the AVR target since version@tie{}10.
2335 Specify the default layout available for the C/C++ @samp{double}
2336 and @samp{long double} type, respectively. The following rules apply:
2339 The first value after the @samp{=} specifies the default layout (in bits)
2340 of the type and also the default for the @option{-mdouble=} resp.
2341 @option{-mlong-double=} compiler option.
2343 If more than one value is specified, respective multilib variants are
2344 available, and @option{-mdouble=} resp. @option{-mlong-double=} acts
2345 as a multilib option.
2347 If @option{--with-long-double=double} is specified, @samp{double} and
2348 @samp{long double} will have the same layout.
2350 The defaults are @option{--with-long-double=64,32} and
2351 @option{--with-double=32,64}. The default @samp{double} layout imposed by
2352 the latter is compatible with older versions of the compiler that implement
2353 @samp{double} as a 32-bit type, which does not comply to the language standard.
2355 Not all combinations of @option{--with-double=} and
2356 @option{--with-long-double=} are valid. For example, the combination
2357 @option{--with-double=32,64} @option{--with-long-double=32} will be
2358 rejected because the first option specifies the availability of
2359 multilibs for @samp{double}, whereas the second option implies
2360 that @samp{long double} --- and hence also @samp{double} --- is always
2363 @item --with-double-comparison=@{tristate|bool|libf7@}
2364 Only supported for the AVR target since version@tie{}10.
2365 Specify what result format is returned by library functions that
2366 compare 64-bit floating point values (@code{DFmode}).
2367 The GCC default is @samp{tristate}. If the floating point
2368 implementation returns a boolean instead, set it to @samp{bool}.
2370 @item --with-libf7=@{libgcc|math|math-symbols|no@}
2371 Only supported for the AVR target since version@tie{}10.
2372 Specify to which degree code from LibF7 is included in libgcc.
2373 LibF7 is an ad-hoc, AVR-specific, 64-bit floating point emulation
2374 written in C and (inline) assembly. @samp{libgcc} adds support
2375 for functions that one would usually expect in libgcc like double addition,
2376 double comparisons and double conversions. @samp{math} also adds routines
2377 that one would expect in @file{libm.a}, but with @code{__} (two underscores)
2378 prepended to the symbol names as specified by @file{math.h}.
2379 @samp{math-symbols} also defines weak aliases for the functions
2380 declared in @file{math.h}. However, @code{--with-libf7} won't
2381 install no @file{math.h} header file whatsoever, this file must come
2382 from elsewhere. This option sets @option{--with-double-comparison}
2385 @item --with-nds32-lib=@var{library}
2386 Specifies that @var{library} setting is used for building @file{libgcc.a}.
2387 Currently, the valid @var{library} is @samp{newlib} or @samp{mculib}.
2388 This option is only supported for the NDS32 target.
2390 @item --with-build-time-tools=@var{dir}
2391 Specifies where to find the set of target tools (assembler, linker, etc.)
2392 that will be used while building GCC itself. This option can be useful
2393 if the directory layouts are different between the system you are building
2394 GCC on, and the system where you will deploy it.
2396 For example, on an @samp{ia64-hp-hpux} system, you may have the GNU
2397 assembler and linker in @file{/usr/bin}, and the native tools in a
2398 different path, and build a toolchain that expects to find the
2399 native tools in @file{/usr/bin}.
2401 When you use this option, you should ensure that @var{dir} includes
2402 @command{ar}, @command{as}, @command{ld}, @command{nm},
2403 @command{ranlib} and @command{strip} if necessary, and possibly
2404 @command{objdump}. Otherwise, GCC may use an inconsistent set of
2408 @subsubheading Overriding @command{configure} test results
2410 Sometimes, it might be necessary to override the result of some
2411 @command{configure} test, for example in order to ease porting to a new
2412 system or work around a bug in a test. The toplevel @command{configure}
2413 script provides three variables for this:
2417 @item build_configargs
2418 @cindex @code{build_configargs}
2419 The contents of this variable is passed to all build @command{configure}
2422 @item host_configargs
2423 @cindex @code{host_configargs}
2424 The contents of this variable is passed to all host @command{configure}
2427 @item target_configargs
2428 @cindex @code{target_configargs}
2429 The contents of this variable is passed to all target @command{configure}
2434 In order to avoid shell and @command{make} quoting issues for complex
2435 overrides, you can pass a setting for @env{CONFIG_SITE} and set
2436 variables in the site file.
2438 @subheading Objective-C-Specific Options
2440 The following options apply to the build of the Objective-C runtime library.
2443 @item --enable-objc-gc
2444 Specify that an additional variant of the GNU Objective-C runtime library
2445 is built, using an external build of the Boehm-Demers-Weiser garbage
2446 collector (@uref{https://www.hboehm.info/gc/}). This library needs to be
2447 available for each multilib variant, unless configured with
2448 @option{--enable-objc-gc=@samp{auto}} in which case the build of the
2449 additional runtime library is skipped when not available and the build
2452 @item --with-target-bdw-gc=@var{list}
2453 @itemx --with-target-bdw-gc-include=@var{list}
2454 @itemx --with-target-bdw-gc-lib=@var{list}
2455 Specify search directories for the garbage collector header files and
2456 libraries. @var{list} is a comma separated list of key value pairs of the
2457 form @samp{@var{multilibdir}=@var{path}}, where the default multilib key
2458 is named as @samp{.} (dot), or is omitted (e.g.@:
2459 @samp{--with-target-bdw-gc=/opt/bdw-gc,32=/opt-bdw-gc32}).
2461 The options @option{--with-target-bdw-gc-include} and
2462 @option{--with-target-bdw-gc-lib} must always be specified together
2463 for each multilib variant and they take precedence over
2464 @option{--with-target-bdw-gc}. If @option{--with-target-bdw-gc-include}
2465 is missing values for a multilib, then the value for the default
2466 multilib is used (e.g.@: @samp{--with-target-bdw-gc-include=/opt/bdw-gc/include}
2467 @samp{--with-target-bdw-gc-lib=/opt/bdw-gc/lib64,32=/opt-bdw-gc/lib32}).
2468 If none of these options are specified, the library is assumed in
2472 @subheading D-Specific Options
2474 The following options apply to the build of the D runtime library.
2477 @item --enable-libphobos-checking
2478 @itemx --disable-libphobos-checking
2479 @itemx --enable-libphobos-checking=@var{list}
2480 This option controls whether run-time checks and contracts are compiled into
2481 the D runtime library. When the option is not specified, the library is built
2482 with @samp{release} checking. When the option is specified without a
2483 @var{list}, the result is the same as @samp{--enable-libphobos-checking=yes}.
2484 Likewise, @samp{--disable-libphobos-checking} is equivalent to
2485 @samp{--enable-libphobos-checking=no}.
2487 The categories of checks available in @var{list} are @samp{yes} (compiles
2488 libphobos with @option{-fno-release}), @samp{no} (compiles libphobos with
2489 @option{-frelease}), @samp{all} (same as @samp{yes}), @samp{none} or
2490 @samp{release} (same as @samp{no}).
2492 Individual checks available in @var{list} are @samp{assert} (compiles libphobos
2493 with an extra option @option{-fassert}).
2495 @item --with-libphobos-druntime-only
2496 @itemx --with-libphobos-druntime-only=@var{choice}
2497 Specify whether to build only the core D runtime library (druntime), or both
2498 the core and standard library (phobos) into libphobos. This is useful for
2499 targets that have full support in druntime, but no or incomplete support
2500 in phobos. @var{choice} can be one of @samp{auto}, @samp{yes}, and @samp{no}
2501 where @samp{auto} is the default.
2503 When the option is not specified, the default choice @samp{auto} means that it
2504 is inferred whether the target has support for the phobos standard library.
2505 When the option is specified without a @var{choice}, the result is the same as
2506 @samp{--with-libphobos-druntime-only=yes}.
2508 @item --with-target-system-zlib
2509 Use installed @samp{zlib} rather than that included with GCC@. This needs
2510 to be available for each multilib variant, unless configured with
2511 @option{--with-target-system-zlib=@samp{auto}} in which case the GCC@ included
2512 @samp{zlib} is only used when the system installed library is not available.
2520 @uref{./index.html,,Return to the GCC Installation page}
2524 @c ***Building****************************************************************
2526 @comment node-name, next, previous, up
2527 @node Building, Testing, Configuration, Installing GCC
2533 @cindex Installing GCC: Building
2535 Now that GCC is configured, you are ready to build the compiler and
2538 Some commands executed when making the compiler may fail (return a
2539 nonzero status) and be ignored by @command{make}. These failures, which
2540 are often due to files that were not found, are expected, and can safely
2543 It is normal to have compiler warnings when compiling certain files.
2544 Unless you are a GCC developer, you can generally ignore these warnings
2545 unless they cause compilation to fail. Developers should attempt to fix
2546 any warnings encountered, however they can temporarily continue past
2547 warnings-as-errors by specifying the configure flag
2548 @option{--disable-werror}.
2550 On certain old systems, defining certain environment variables such as
2551 @env{CC} can interfere with the functioning of @command{make}.
2553 If you encounter seemingly strange errors when trying to build the
2554 compiler in a directory other than the source directory, it could be
2555 because you have previously configured the compiler in the source
2556 directory. Make sure you have done all the necessary preparations.
2558 If you build GCC on a BSD system using a directory stored in an old System
2559 V file system, problems may occur in running @command{fixincludes} if the
2560 System V file system doesn't support symbolic links. These problems
2561 result in a failure to fix the declaration of @code{size_t} in
2562 @file{sys/types.h}. If you find that @code{size_t} is a signed type and
2563 that type mismatches occur, this could be the cause.
2565 The solution is not to use such a directory for building GCC@.
2567 Similarly, when building from the source repository or snapshots, or if you modify
2568 @file{*.l} files, you need the Flex lexical analyzer generator
2569 installed. If you do not modify @file{*.l} files, releases contain
2570 the Flex-generated files and you do not need Flex installed to build
2571 them. There is still one Flex-based lexical analyzer (part of the
2572 build machinery, not of GCC itself) that is used even if you only
2573 build the C front end.
2575 When building from the source repository or snapshots, or if you modify Texinfo
2576 documentation, you need version 4.7 or later of Texinfo installed if you
2577 want Info documentation to be regenerated. Releases contain Info
2578 documentation pre-built for the unmodified documentation in the release.
2580 @section Building a native compiler
2582 For a native build, the default configuration is to perform
2583 a 3-stage bootstrap of the compiler when @samp{make} is invoked.
2584 This will build the entire GCC system and ensure that it compiles
2585 itself correctly. It can be disabled with the @option{--disable-bootstrap}
2586 parameter to @samp{configure}, but bootstrapping is suggested because
2587 the compiler will be tested more completely and could also have
2590 The bootstrapping process will complete the following steps:
2594 Build tools necessary to build the compiler.
2597 Perform a 3-stage bootstrap of the compiler. This includes building
2598 three times the target tools for use by the compiler such as binutils
2599 (bfd, binutils, gas, gprof, ld, and opcodes) if they have been
2600 individually linked or moved into the top level GCC source tree before
2604 Perform a comparison test of the stage2 and stage3 compilers.
2607 Build runtime libraries using the stage3 compiler from the previous step.
2611 If you are short on disk space you might consider @samp{make
2612 bootstrap-lean} instead. The sequence of compilation is the
2613 same described above, but object files from the stage1 and
2614 stage2 of the 3-stage bootstrap of the compiler are deleted as
2615 soon as they are no longer needed.
2617 If you wish to use non-default GCC flags when compiling the stage2
2618 and stage3 compilers, set @code{BOOT_CFLAGS} on the command line when
2619 doing @samp{make}. For example, if you want to save additional space
2620 during the bootstrap and in the final installation as well, you can
2621 build the compiler binaries without debugging information as in the
2622 following example. This will save roughly 40% of disk space both for
2623 the bootstrap and the final installation. (Libraries will still contain
2624 debugging information.)
2627 make BOOT_CFLAGS='-O' bootstrap
2630 You can place non-default optimization flags into @code{BOOT_CFLAGS}; they
2631 are less well tested here than the default of @samp{-g -O2}, but should
2632 still work. In a few cases, you may find that you need to specify special
2633 flags such as @option{-msoft-float} here to complete the bootstrap; or,
2634 if the native compiler miscompiles the stage1 compiler, you may need
2635 to work around this, by choosing @code{BOOT_CFLAGS} to avoid the parts
2636 of the stage1 compiler that were miscompiled, or by using @samp{make
2637 bootstrap4} to increase the number of stages of bootstrap.
2639 @code{BOOT_CFLAGS} does not apply to bootstrapped target libraries.
2640 Since these are always compiled with the compiler currently being
2641 bootstrapped, you can use @code{CFLAGS_FOR_TARGET} to modify their
2642 compilation flags, as for non-bootstrapped target libraries.
2643 Again, if the native compiler miscompiles the stage1 compiler, you may
2644 need to work around this by avoiding non-working parts of the stage1
2645 compiler. Use @code{STAGE1_TFLAGS} to this end.
2647 If you used the flag @option{--enable-languages=@dots{}} to restrict
2648 the compilers to be built, only those you've actually enabled will be
2649 built. This will of course only build those runtime libraries, for
2650 which the particular compiler has been built. Please note,
2651 that re-defining @env{LANGUAGES} when calling @samp{make}
2652 @strong{does not} work anymore!
2654 If the comparison of stage2 and stage3 fails, this normally indicates
2655 that the stage2 compiler has compiled GCC incorrectly, and is therefore
2656 a potentially serious bug which you should investigate and report. (On
2657 a few systems, meaningful comparison of object files is impossible; they
2658 always appear ``different''. If you encounter this problem, you will
2659 need to disable comparison in the @file{Makefile}.)
2661 If you do not want to bootstrap your compiler, you can configure with
2662 @option{--disable-bootstrap}. In particular cases, you may want to
2663 bootstrap your compiler even if the target system is not the same as
2664 the one you are building on: for example, you could build a
2665 @code{powerpc-unknown-linux-gnu} toolchain on a
2666 @code{powerpc64-unknown-linux-gnu} host. In this case, pass
2667 @option{--enable-bootstrap} to the configure script.
2669 @code{BUILD_CONFIG} can be used to bring in additional customization
2670 to the build. It can be set to a whitespace-separated list of names.
2671 For each such @code{NAME}, top-level @file{config/@code{NAME}.mk} will
2672 be included by the top-level @file{Makefile}, bringing in any settings
2673 it contains. The default @code{BUILD_CONFIG} can be set using the
2674 configure option @option{--with-build-config=@code{NAME}...}. Some
2675 examples of supported build configurations are:
2678 @item @samp{bootstrap-O1}
2679 Removes any @option{-O}-started option from @code{BOOT_CFLAGS}, and adds
2680 @option{-O1} to it. @samp{BUILD_CONFIG=bootstrap-O1} is equivalent to
2681 @samp{BOOT_CFLAGS='-g -O1'}.
2683 @item @samp{bootstrap-O3}
2684 @itemx @samp{bootstrap-Og}
2685 Analogous to @code{bootstrap-O1}.
2687 @item @samp{bootstrap-lto}
2688 Enables Link-Time Optimization for host tools during bootstrapping.
2689 @samp{BUILD_CONFIG=bootstrap-lto} is equivalent to adding
2690 @option{-flto} to @samp{BOOT_CFLAGS}. This option assumes that the host
2691 supports the linker plugin (e.g.@: GNU ld version 2.21 or later or GNU gold
2692 version 2.21 or later).
2694 @item @samp{bootstrap-lto-noplugin}
2695 This option is similar to @code{bootstrap-lto}, but is intended for
2696 hosts that do not support the linker plugin. Without the linker plugin
2697 static libraries are not compiled with link-time optimizations. Since
2698 the GCC middle end and back end are in @file{libbackend.a} this means
2699 that only the front end is actually LTO optimized.
2701 @item @samp{bootstrap-lto-lean}
2702 This option is similar to @code{bootstrap-lto}, but is intended for
2703 faster build by only using LTO in the final bootstrap stage.
2704 With @samp{make profiledbootstrap} the LTO frontend
2705 is trained only on generator files.
2707 @item @samp{bootstrap-debug}
2708 Verifies that the compiler generates the same executable code, whether
2709 or not it is asked to emit debug information. To this end, this
2710 option builds stage2 host programs without debug information, and uses
2711 @file{contrib/compare-debug} to compare them with the stripped stage3
2712 object files. If @code{BOOT_CFLAGS} is overridden so as to not enable
2713 debug information, stage2 will have it, and stage3 won't. This option
2714 is enabled by default when GCC bootstrapping is enabled, if
2715 @code{strip} can turn object files compiled with and without debug
2716 info into identical object files. In addition to better test
2717 coverage, this option makes default bootstraps faster and leaner.
2719 @item @samp{bootstrap-debug-big}
2720 Rather than comparing stripped object files, as in
2721 @code{bootstrap-debug}, this option saves internal compiler dumps
2722 during stage2 and stage3 and compares them as well, which helps catch
2723 additional potential problems, but at a great cost in terms of disk
2724 space. It can be specified in addition to @samp{bootstrap-debug}.
2726 @item @samp{bootstrap-debug-lean}
2727 This option saves disk space compared with @code{bootstrap-debug-big},
2728 but at the expense of some recompilation. Instead of saving the dumps
2729 of stage2 and stage3 until the final compare, it uses
2730 @option{-fcompare-debug} to generate, compare and remove the dumps
2731 during stage3, repeating the compilation that already took place in
2732 stage2, whose dumps were not saved.
2734 @item @samp{bootstrap-debug-lib}
2735 This option tests executable code invariance over debug information
2736 generation on target libraries, just like @code{bootstrap-debug-lean}
2737 tests it on host programs. It builds stage3 libraries with
2738 @option{-fcompare-debug}, and it can be used along with any of the
2739 @code{bootstrap-debug} options above.
2741 There aren't @code{-lean} or @code{-big} counterparts to this option
2742 because most libraries are only build in stage3, so bootstrap compares
2743 would not get significant coverage. Moreover, the few libraries built
2744 in stage2 are used in stage3 host programs, so we wouldn't want to
2745 compile stage2 libraries with different options for comparison purposes.
2747 @item @samp{bootstrap-debug-ckovw}
2748 Arranges for error messages to be issued if the compiler built on any
2749 stage is run without the option @option{-fcompare-debug}. This is
2750 useful to verify the full @option{-fcompare-debug} testing coverage. It
2751 must be used along with @code{bootstrap-debug-lean} and
2752 @code{bootstrap-debug-lib}.
2754 @item @samp{bootstrap-cet}
2755 This option enables Intel CET for host tools during bootstrapping.
2756 @samp{BUILD_CONFIG=bootstrap-cet} is equivalent to adding
2757 @option{-fcf-protection} to @samp{BOOT_CFLAGS}. This option
2758 assumes that the host supports Intel CET (e.g.@: GNU assembler version
2761 @item @samp{bootstrap-time}
2762 Arranges for the run time of each program started by the GCC driver,
2763 built in any stage, to be logged to @file{time.log}, in the top level of
2768 @section Building a cross compiler
2770 When building a cross compiler, it is not generally possible to do a
2771 3-stage bootstrap of the compiler. This makes for an interesting problem
2772 as parts of GCC can only be built with GCC@.
2774 To build a cross compiler, we recommend first building and installing a
2775 native compiler. You can then use the native GCC compiler to build the
2776 cross compiler. The installed native compiler needs to be GCC version
2779 Assuming you have already installed a native copy of GCC and configured
2780 your cross compiler, issue the command @command{make}, which performs the
2785 Build host tools necessary to build the compiler.
2788 Build target tools for use by the compiler such as binutils (bfd,
2789 binutils, gas, gprof, ld, and opcodes)
2790 if they have been individually linked or moved into the top level GCC source
2791 tree before configuring.
2794 Build the compiler (single stage only).
2797 Build runtime libraries using the compiler from the previous step.
2800 Note that if an error occurs in any step the make process will exit.
2802 If you are not building GNU binutils in the same source tree as GCC,
2803 you will need a cross-assembler and cross-linker installed before
2804 configuring GCC@. Put them in the directory
2805 @file{@var{prefix}/@var{target}/bin}. Here is a table of the tools
2806 you should put in this directory:
2810 This should be the cross-assembler.
2813 This should be the cross-linker.
2816 This should be the cross-archiver: a program which can manipulate
2817 archive files (linker libraries) in the target machine's format.
2820 This should be a program to construct a symbol table in an archive file.
2823 The installation of GCC will find these programs in that directory,
2824 and copy or link them to the proper place to for the cross-compiler to
2825 find them when run later.
2827 The easiest way to provide these files is to build the Binutils package.
2828 Configure it with the same @option{--host} and @option{--target}
2829 options that you use for configuring GCC, then build and install
2830 them. They install their executables automatically into the proper
2831 directory. Alas, they do not support all the targets that GCC
2834 If you are not building a C library in the same source tree as GCC,
2835 you should also provide the target libraries and headers before
2836 configuring GCC, specifying the directories with
2837 @option{--with-sysroot} or @option{--with-headers} and
2838 @option{--with-libs}. Many targets also require ``start files'' such
2839 as @file{crt0.o} and
2840 @file{crtn.o} which are linked into each executable. There may be several
2841 alternatives for @file{crt0.o}, for use with profiling or other
2842 compilation options. Check your target's definition of
2843 @code{STARTFILE_SPEC} to find out what start files it uses.
2845 @section Building in parallel
2847 GNU Make 3.80 and above, which is necessary to build GCC, support
2848 building in parallel. To activate this, you can use @samp{make -j 2}
2849 instead of @samp{make}. You can also specify a bigger number, and
2850 in most cases using a value greater than the number of processors in
2851 your machine will result in fewer and shorter I/O latency hits, thus
2852 improving overall throughput; this is especially true for slow drives
2853 and network filesystems.
2855 @section Building the Ada compiler
2858 @ref{GNAT-prerequisite}.
2861 @uref{prerequisites.html#GNAT-prerequisite,,GNAT prerequisites}.
2864 @section Building with profile feedback
2866 It is possible to use profile feedback to optimize the compiler itself. This
2867 should result in a faster compiler binary. Experiments done on x86 using gcc
2868 3.3 showed approximately 7 percent speedup on compiling C programs. To
2869 bootstrap the compiler with profile feedback, use @code{make profiledbootstrap}.
2871 When @samp{make profiledbootstrap} is run, it will first build a @code{stage1}
2872 compiler. This compiler is used to build a @code{stageprofile} compiler
2873 instrumented to collect execution counts of instruction and branch
2874 probabilities. Training run is done by building @code{stagetrain}
2875 compiler. Finally a @code{stagefeedback} compiler is built
2876 using the information collected.
2878 Unlike standard bootstrap, several additional restrictions apply. The
2879 compiler used to build @code{stage1} needs to support a 64-bit integral type.
2880 It is recommended to only use GCC for this.
2882 On Linux/x86_64 hosts with some restrictions (no virtualization) it is
2883 also possible to do autofdo build with @samp{make
2884 autoprofiledback}. This uses Linux perf to sample branches in the
2885 binary and then rebuild it with feedback derived from the profile.
2886 Linux perf and the @code{autofdo} toolkit needs to be installed for
2889 Only the profile from the current build is used, so when an error
2890 occurs it is recommended to clean before restarting. Otherwise
2891 the code quality may be much worse.
2898 @uref{./index.html,,Return to the GCC Installation page}
2902 @c ***Testing*****************************************************************
2904 @comment node-name, next, previous, up
2905 @node Testing, Final install, Building, Installing GCC
2909 @chapter Installing GCC: Testing
2912 @cindex Installing GCC: Testing
2915 Before you install GCC, we encourage you to run the testsuites and to
2916 compare your results with results from a similar configuration that have
2917 been submitted to the
2918 @uref{http://gcc.gnu.org/ml/gcc-testresults/,,gcc-testresults mailing list}.
2919 Some of these archived results are linked from the build status lists
2920 at @uref{http://gcc.gnu.org/buildstat.html}, although not everyone who
2921 reports a successful build runs the testsuites and submits the results.
2922 This step is optional and may require you to download additional software,
2923 but it can give you confidence in your new GCC installation or point out
2924 problems before you install and start using your new GCC@.
2926 First, you must have @uref{download.html,,downloaded the testsuites}.
2927 These are part of the full distribution, but if you downloaded the
2928 ``core'' compiler plus any front ends, you must download the testsuites
2931 Second, you must have the testing tools installed. This includes
2932 @uref{http://www.gnu.org/software/dejagnu/,,DejaGnu}, Tcl, and Expect;
2933 the DejaGnu site has links to these. For running the BRIG frontend
2934 tests, a tool to assemble the binary BRIGs from HSAIL text,
2935 @uref{https://github.com/HSAFoundation/HSAIL-Tools/,,HSAILasm} must
2938 If the directories where @command{runtest} and @command{expect} were
2939 installed are not in the @env{PATH}, you may need to set the following
2940 environment variables appropriately, as in the following example (which
2941 assumes that DejaGnu has been installed under @file{/usr/local}):
2944 TCL_LIBRARY = /usr/local/share/tcl8.0
2945 DEJAGNULIBS = /usr/local/share/dejagnu
2948 (On systems such as Cygwin, these paths are required to be actual
2949 paths, not mounts or links; presumably this is due to some lack of
2950 portability in the DejaGnu code.)
2953 Finally, you can run the testsuite (which may take a long time):
2955 cd @var{objdir}; make -k check
2958 This will test various components of GCC, such as compiler
2959 front ends and runtime libraries. While running the testsuite, DejaGnu
2960 might emit some harmless messages resembling
2961 @samp{WARNING: Couldn't find the global config file.} or
2962 @samp{WARNING: Couldn't find tool init file} that can be ignored.
2964 If you are testing a cross-compiler, you may want to run the testsuite
2965 on a simulator as described at @uref{http://gcc.gnu.org/simtest-howto.html}.
2967 @section How can you run the testsuite on selected tests?
2969 In order to run sets of tests selectively, there are targets
2970 @samp{make check-gcc} and language specific @samp{make check-c},
2971 @samp{make check-c++}, @samp{make check-d} @samp{make check-fortran},
2972 @samp{make check-ada}, @samp{make check-objc}, @samp{make check-obj-c++},
2973 @samp{make check-lto}
2974 in the @file{gcc} subdirectory of the object directory. You can also
2975 just run @samp{make check} in a subdirectory of the object directory.
2978 A more selective way to just run all @command{gcc} execute tests in the
2982 make check-gcc RUNTESTFLAGS="execute.exp @var{other-options}"
2985 Likewise, in order to run only the @command{g++} ``old-deja'' tests in
2986 the testsuite with filenames matching @samp{9805*}, you would use
2989 make check-g++ RUNTESTFLAGS="old-deja.exp=9805* @var{other-options}"
2992 The file-matching expression following @var{filename}@command{.exp=} is treated
2993 as a series of whitespace-delimited glob expressions so that multiple patterns
2994 may be passed, although any whitespace must either be escaped or surrounded by
2995 single quotes if multiple expressions are desired. For example,
2998 make check-g++ RUNTESTFLAGS="old-deja.exp=9805*\ virtual2.c @var{other-options}"
2999 make check-g++ RUNTESTFLAGS="'old-deja.exp=9805* virtual2.c' @var{other-options}"
3002 The @file{*.exp} files are located in the testsuite directories of the GCC
3003 source, the most important ones being @file{compile.exp},
3004 @file{execute.exp}, @file{dg.exp} and @file{old-deja.exp}.
3005 To get a list of the possible @file{*.exp} files, pipe the
3006 output of @samp{make check} into a file and look at the
3007 @samp{Running @dots{} .exp} lines.
3009 @section Passing options and running multiple testsuites
3011 You can pass multiple options to the testsuite using the
3012 @samp{--target_board} option of DejaGNU, either passed as part of
3013 @samp{RUNTESTFLAGS}, or directly to @command{runtest} if you prefer to
3014 work outside the makefiles. For example,
3017 make check-g++ RUNTESTFLAGS="--target_board=unix/-O3/-fmerge-constants"
3020 will run the standard @command{g++} testsuites (``unix'' is the target name
3021 for a standard native testsuite situation), passing
3022 @samp{-O3 -fmerge-constants} to the compiler on every test, i.e.,
3023 slashes separate options.
3025 You can run the testsuites multiple times using combinations of options
3026 with a syntax similar to the brace expansion of popular shells:
3029 @dots{}"--target_board=arm-sim\@{-mhard-float,-msoft-float\@}\@{-O1,-O2,-O3,\@}"
3032 (Note the empty option caused by the trailing comma in the final group.)
3033 The following will run each testsuite eight times using the @samp{arm-sim}
3034 target, as if you had specified all possible combinations yourself:
3037 --target_board='arm-sim/-mhard-float/-O1 \
3038 arm-sim/-mhard-float/-O2 \
3039 arm-sim/-mhard-float/-O3 \
3040 arm-sim/-mhard-float \
3041 arm-sim/-msoft-float/-O1 \
3042 arm-sim/-msoft-float/-O2 \
3043 arm-sim/-msoft-float/-O3 \
3044 arm-sim/-msoft-float'
3047 They can be combined as many times as you wish, in arbitrary ways. This
3051 @dots{}"--target_board=unix/-Wextra\@{-O3,-fno-strength\@}\@{-fomit-frame,\@}"
3054 will generate four combinations, all involving @samp{-Wextra}.
3056 The disadvantage to this method is that the testsuites are run in serial,
3057 which is a waste on multiprocessor systems. For users with GNU Make and
3058 a shell which performs brace expansion, you can run the testsuites in
3059 parallel by having the shell perform the combinations and @command{make}
3060 do the parallel runs. Instead of using @samp{--target_board}, use a
3061 special makefile target:
3064 make -j@var{N} check-@var{testsuite}//@var{test-target}/@var{option1}/@var{option2}/@dots{}
3070 make -j3 check-gcc//sh-hms-sim/@{-m1,-m2,-m3,-m3e,-m4@}/@{,-nofpu@}
3073 will run three concurrent ``make-gcc'' testsuites, eventually testing all
3074 ten combinations as described above. Note that this is currently only
3075 supported in the @file{gcc} subdirectory. (To see how this works, try
3076 typing @command{echo} before the example given here.)
3079 @section How to interpret test results
3081 The result of running the testsuite are various @file{*.sum} and @file{*.log}
3082 files in the testsuite subdirectories. The @file{*.log} files contain a
3083 detailed log of the compiler invocations and the corresponding
3084 results, the @file{*.sum} files summarize the results. These summaries
3085 contain status codes for all tests:
3089 PASS: the test passed as expected
3091 XPASS: the test unexpectedly passed
3093 FAIL: the test unexpectedly failed
3095 XFAIL: the test failed as expected
3097 UNSUPPORTED: the test is not supported on this platform
3099 ERROR: the testsuite detected an error
3101 WARNING: the testsuite detected a possible problem
3104 It is normal for some tests to report unexpected failures. At the
3105 current time the testing harness does not allow fine grained control
3106 over whether or not a test is expected to fail. This problem should
3107 be fixed in future releases.
3110 @section Submitting test results
3112 If you want to report the results to the GCC project, use the
3113 @file{contrib/test_summary} shell script. Start it in the @var{objdir} with
3116 @var{srcdir}/contrib/test_summary -p your_commentary.txt \
3117 -m gcc-testresults@@gcc.gnu.org |sh
3120 This script uses the @command{Mail} program to send the results, so
3121 make sure it is in your @env{PATH}. The file @file{your_commentary.txt} is
3122 prepended to the testsuite summary and should contain any special
3123 remarks you have on your results or your build environment. Please
3124 do not edit the testsuite result block or the subject line, as these
3125 messages may be automatically processed.
3132 @uref{./index.html,,Return to the GCC Installation page}
3136 @c ***Final install***********************************************************
3138 @comment node-name, next, previous, up
3139 @node Final install, , Testing, Installing GCC
3141 @ifset finalinstallhtml
3143 @chapter Installing GCC: Final installation
3146 Now that GCC has been built (and optionally tested), you can install it with
3148 cd @var{objdir} && make install
3151 We strongly recommend to install into a target directory where there is
3152 no previous version of GCC present. Also, the GNAT runtime should not
3153 be stripped, as this would break certain features of the debugger that
3154 depend on this debugging information (catching Ada exceptions for
3157 That step completes the installation of GCC; user level binaries can
3158 be found in @file{@var{prefix}/bin} where @var{prefix} is the value
3159 you specified with the @option{--prefix} to configure (or
3160 @file{/usr/local} by default). (If you specified @option{--bindir},
3161 that directory will be used instead; otherwise, if you specified
3162 @option{--exec-prefix}, @file{@var{exec-prefix}/bin} will be used.)
3163 Headers for the C++ library are installed in
3164 @file{@var{prefix}/include}; libraries in @file{@var{libdir}}
3165 (normally @file{@var{prefix}/lib}); internal parts of the compiler in
3166 @file{@var{libdir}/gcc} and @file{@var{libexecdir}/gcc}; documentation
3167 in info format in @file{@var{infodir}} (normally
3168 @file{@var{prefix}/info}).
3170 When installing cross-compilers, GCC's executables
3171 are not only installed into @file{@var{bindir}}, that
3172 is, @file{@var{exec-prefix}/bin}, but additionally into
3173 @file{@var{exec-prefix}/@var{target-alias}/bin}, if that directory
3174 exists. Typically, such @dfn{tooldirs} hold target-specific
3175 binutils, including assembler and linker.
3177 Installation into a temporary staging area or into a @command{chroot}
3178 jail can be achieved with the command
3181 make DESTDIR=@var{path-to-rootdir} install
3185 where @var{path-to-rootdir} is the absolute path of
3186 a directory relative to which all installation paths will be
3187 interpreted. Note that the directory specified by @code{DESTDIR}
3188 need not exist yet; it will be created if necessary.
3190 There is a subtle point with tooldirs and @code{DESTDIR}:
3191 If you relocate a cross-compiler installation with
3192 e.g.@: @samp{DESTDIR=@var{rootdir}}, then the directory
3193 @file{@var{rootdir}/@var{exec-prefix}/@var{target-alias}/bin} will
3194 be filled with duplicated GCC executables only if it already exists,
3195 it will not be created otherwise. This is regarded as a feature,
3196 not as a bug, because it gives slightly more control to the packagers
3197 using the @code{DESTDIR} feature.
3199 You can install stripped programs and libraries with
3205 If you are bootstrapping a released version of GCC then please
3206 quickly review the build status page for your release, available from
3207 @uref{http://gcc.gnu.org/buildstat.html}.
3208 If your system is not listed for the version of GCC that you built,
3210 @email{gcc@@gcc.gnu.org} indicating
3211 that you successfully built and installed GCC@.
3212 Include the following information:
3216 Output from running @file{@var{srcdir}/config.guess}. Do not send
3217 that file itself, just the one-line output from running it.
3220 The output of @samp{gcc -v} for your newly installed @command{gcc}.
3221 This tells us which version of GCC you built and the options you passed to
3225 Whether you enabled all languages or a subset of them. If you used a
3226 full distribution then this information is part of the configure
3227 options in the output of @samp{gcc -v}, but if you downloaded the
3228 ``core'' compiler plus additional front ends then it isn't apparent
3229 which ones you built unless you tell us about it.
3232 If the build was for GNU/Linux, also include:
3235 The distribution name and version (e.g., Red Hat 7.1 or Debian 2.2.3);
3236 this information should be available from @file{/etc/issue}.
3239 The version of the Linux kernel, available from @samp{uname --version}
3243 The version of glibc you used; for RPM-based systems like Red Hat,
3244 Mandrake, and SuSE type @samp{rpm -q glibc} to get the glibc version,
3245 and on systems like Debian and Progeny use @samp{dpkg -l libc6}.
3247 For other systems, you can include similar information if you think it is
3251 Any other information that you think would be useful to people building
3252 GCC on the same configuration. The new entry in the build status list
3253 will include a link to the archived copy of your message.
3256 We'd also like to know if the
3258 @ref{Specific, host/target specific installation notes}
3261 @uref{specific.html,,host/target specific installation notes}
3263 didn't include your host/target information or if that information is
3264 incomplete or out of date. Send a note to
3265 @email{gcc@@gcc.gnu.org} detailing how the information should be changed.
3267 If you find a bug, please report it following the
3268 @uref{../bugs/,,bug reporting guidelines}.
3270 If you want to print the GCC manuals, do @samp{cd @var{objdir}; make
3271 dvi}. You will need to have @command{texi2dvi} (version at least 4.7)
3272 and @TeX{} installed. This creates a number of @file{.dvi} files in
3273 subdirectories of @file{@var{objdir}}; these may be converted for
3274 printing with programs such as @command{dvips}. Alternately, by using
3275 @samp{make pdf} in place of @samp{make dvi}, you can create documentation
3276 in the form of @file{.pdf} files; this requires @command{texi2pdf}, which
3277 is included with Texinfo version 4.8 and later. You can also
3278 @uref{https://shop.fsf.org/,,buy printed manuals from the
3279 Free Software Foundation}, though such manuals may not be for the most
3280 recent version of GCC@.
3282 If you would like to generate online HTML documentation, do @samp{cd
3283 @var{objdir}; make html} and HTML will be generated for the gcc manuals in
3284 @file{@var{objdir}/gcc/HTML}.
3291 @uref{./index.html,,Return to the GCC Installation page}
3295 @c ***Binaries****************************************************************
3297 @comment node-name, next, previous, up
3298 @node Binaries, Specific, Installing GCC, Top
3302 @chapter Installing GCC: Binaries
3305 @cindex Installing GCC: Binaries
3307 We are often asked about pre-compiled versions of GCC@. While we cannot
3308 provide these for all platforms, below you'll find links to binaries for
3309 various platforms where creating them by yourself is not easy due to various
3312 Please note that we did not create these binaries, nor do we
3313 support them. If you have any problems installing them, please
3314 contact their makers.
3321 @uref{http://www.bullfreeware.com,,Bull's Open Source Software Archive for
3322 for AIX 6 and AIX 7};
3325 @uref{http://www.perzl.org/aix/,,AIX Open Source Packages (AIX5L AIX 6.1
3330 DOS---@uref{http://www.delorie.com/djgpp/,,DJGPP}.
3336 @uref{http://hpux.connect.org.uk/,,HP-UX Porting Center};
3340 Solaris 2 (SPARC, Intel):
3343 @uref{https://www.opencsw.org/,,OpenCSW}
3350 The @uref{https://brew.sh,,Homebrew} package manager;
3352 @uref{https://www.macports.org,,MacPorts}.
3359 The @uref{https://sourceware.org/cygwin/,,Cygwin} project;
3361 The @uref{http://www.mingw.org/,,MinGW} and
3362 @uref{http://mingw-w64.org/doku.php,,mingw-w64} projects.
3366 @uref{http://www.openpkg.org/,,OpenPKG} offers binaries for quite a
3367 number of platforms.
3370 The @uref{http://gcc.gnu.org/wiki/GFortranBinaries,,GFortran Wiki} has
3371 links to GNU Fortran binaries for several platforms.
3379 @uref{./index.html,,Return to the GCC Installation page}
3383 @c ***Specific****************************************************************
3385 @comment node-name, next, previous, up
3386 @node Specific, Old, Binaries, Top
3390 @chapter Host/target specific installation notes for GCC
3393 @cindex Specific installation notes
3394 @cindex Target specific installation
3395 @cindex Host specific installation
3396 @cindex Target specific installation notes
3398 Please read this document carefully @emph{before} installing the
3399 GNU Compiler Collection on your machine.
3401 Note that this list of install notes is @emph{not} a list of supported
3402 hosts or targets. Not all supported hosts and targets are listed
3403 here, only the ones that require host-specific or target-specific
3404 information have to.
3409 @uref{#aarch64-x-x,,aarch64*-*-*}
3411 @uref{#alpha-x-x,,alpha*-*-*}
3413 @uref{#amd64-x-solaris2,,amd64-*-solaris2*}
3415 @uref{#arm-x-eabi,,arm-*-eabi}
3419 @uref{#bfin,,Blackfin}
3423 @uref{#x-x-freebsd,,*-*-freebsd*}
3425 @uref{#h8300-hms,,h8300-hms}
3427 @uref{#hppa-hp-hpux,,hppa*-hp-hpux*}
3429 @uref{#hppa-hp-hpux10,,hppa*-hp-hpux10}
3431 @uref{#hppa-hp-hpux11,,hppa*-hp-hpux11}
3433 @uref{#x-x-linux-gnu,,*-*-linux-gnu}
3435 @uref{#ix86-x-linux,,i?86-*-linux*}
3437 @uref{#ix86-x-solaris2,,i?86-*-solaris2*}
3439 @uref{#ia64-x-linux,,ia64-*-linux}
3441 @uref{#ia64-x-hpux,,ia64-*-hpux*}
3443 @uref{#x-ibm-aix,,*-ibm-aix*}
3445 @uref{#iq2000-x-elf,,iq2000-*-elf}
3447 @uref{#lm32-x-elf,,lm32-*-elf}
3449 @uref{#lm32-x-uclinux,,lm32-*-uclinux}
3451 @uref{#m32c-x-elf,,m32c-*-elf}
3453 @uref{#m32r-x-elf,,m32r-*-elf}
3455 @uref{#m68k-x-x,,m68k-*-*}
3457 @uref{#m68k-uclinux,,m68k-uclinux}
3459 @uref{#microblaze-x-elf,,microblaze-*-elf}
3461 @uref{#mips-x-x,,mips-*-*}
3463 @uref{#nds32le-x-elf,,nds32le-*-elf}
3465 @uref{#nds32be-x-elf,,nds32be-*-elf}
3467 @uref{#nvptx-x-none,,nvptx-*-none}
3469 @uref{#or1k-x-elf,,or1k-*-elf}
3471 @uref{#or1k-x-linux,,or1k-*-linux}
3473 @uref{#powerpc-x-x,,powerpc*-*-*}
3475 @uref{#powerpc-x-darwin,,powerpc-*-darwin*}
3477 @uref{#powerpc-x-elf,,powerpc-*-elf}
3479 @uref{#powerpc-x-linux-gnu,,powerpc*-*-linux-gnu*}
3481 @uref{#powerpc-x-netbsd,,powerpc-*-netbsd*}
3483 @uref{#powerpc-x-eabisim,,powerpc-*-eabisim}
3485 @uref{#powerpc-x-eabi,,powerpc-*-eabi}
3487 @uref{#powerpcle-x-elf,,powerpcle-*-elf}
3489 @uref{#powerpcle-x-eabisim,,powerpcle-*-eabisim}
3491 @uref{#powerpcle-x-eabi,,powerpcle-*-eabi}
3493 @uref{#riscv32-x-elf,,riscv32-*-elf}
3495 @uref{#riscv32-x-linux,,riscv32-*-linux}
3497 @uref{#riscv64-x-elf,,riscv64-*-elf}
3499 @uref{#riscv64-x-linux,,riscv64-*-linux}
3501 @uref{#s390-x-linux,,s390-*-linux*}
3503 @uref{#s390x-x-linux,,s390x-*-linux*}
3505 @uref{#s390x-ibm-tpf,,s390x-ibm-tpf*}
3507 @uref{#x-x-solaris2,,*-*-solaris2*}
3509 @uref{#sparc-x-x,,sparc*-*-*}
3511 @uref{#sparc-sun-solaris2,,sparc-sun-solaris2*}
3513 @uref{#sparc-x-linux,,sparc-*-linux*}
3515 @uref{#sparc64-x-solaris2,,sparc64-*-solaris2*}
3517 @uref{#sparcv9-x-solaris2,,sparcv9-*-solaris2*}
3519 @uref{#c6x-x-x,,c6x-*-*}
3521 @uref{#tilegx-x-linux,,tilegx-*-linux*}
3523 @uref{#tilegxbe-x-linux,,tilegxbe-*-linux*}
3525 @uref{#tilepro-x-linux,,tilepro-*-linux*}
3527 @uref{#visium-x-elf, visium-*-elf}
3529 @uref{#x-x-vxworks,,*-*-vxworks*}
3531 @uref{#x86-64-x-x,,x86_64-*-*, amd64-*-*}
3533 @uref{#x86-64-x-solaris2,,x86_64-*-solaris2*}
3535 @uref{#xtensa-x-elf,,xtensa*-*-elf}
3537 @uref{#xtensa-x-linux,,xtensa*-*-linux*}
3539 @uref{#windows,,Microsoft Windows}
3541 @uref{#x-x-cygwin,,*-*-cygwin}
3543 @uref{#x-x-mingw32,,*-*-mingw32}
3547 @uref{#older,,Older systems}
3552 @uref{#elf,,all ELF targets} (SVR4, Solaris 2, etc.)
3558 <!-- -------- host/target specific issues start here ---------------- -->
3561 @anchor{aarch64-x-x}
3562 @heading aarch64*-*-*
3563 Binutils pre 2.24 does not have support for selecting @option{-mabi} and
3564 does not support ILP32. If it is used to build GCC 4.9 or later, GCC will
3565 not support option @option{-mabi=ilp32}.
3567 To enable a workaround for the Cortex-A53 erratum number 835769 by default
3568 (for all CPUs regardless of -mcpu option given) at configure time use the
3569 @option{--enable-fix-cortex-a53-835769} option. This will enable the fix by
3570 default and can be explicitly disabled during compilation by passing the
3571 @option{-mno-fix-cortex-a53-835769} option. Conversely,
3572 @option{--disable-fix-cortex-a53-835769} will disable the workaround by
3573 default. The workaround is disabled by default if neither of
3574 @option{--enable-fix-cortex-a53-835769} or
3575 @option{--disable-fix-cortex-a53-835769} is given at configure time.
3577 To enable a workaround for the Cortex-A53 erratum number 843419 by default
3578 (for all CPUs regardless of -mcpu option given) at configure time use the
3579 @option{--enable-fix-cortex-a53-843419} option. This workaround is applied at
3580 link time. Enabling the workaround will cause GCC to pass the relevant option
3581 to the linker. It can be explicitly disabled during compilation by passing the
3582 @option{-mno-fix-cortex-a53-843419} option. Conversely,
3583 @option{--disable-fix-cortex-a53-843419} will disable the workaround by default.
3584 The workaround is disabled by default if neither of
3585 @option{--enable-fix-cortex-a53-843419} or
3586 @option{--disable-fix-cortex-a53-843419} is given at configure time.
3588 To enable Branch Target Identification Mechanism and Return Address Signing by
3589 default at configure time use the @option{--enable-standard-branch-protection}
3590 option. This is equivalent to having @option{-mbranch-protection=standard}
3591 during compilation. This can be explicitly disabled during compilation by
3592 passing the @option{-mbranch-protection=none} option which turns off all
3593 types of branch protections. Conversely,
3594 @option{--disable-standard-branch-protection} will disable both the
3595 protections by default. This mechanism is turned off by default if neither
3596 of the options are given at configure time.
3603 This section contains general configuration information for all
3604 Alpha-based platforms using ELF@. In addition to reading this
3605 section, please read all other sections that match your target.
3610 @anchor{amd64-x-solaris2}
3611 @heading amd64-*-solaris2*
3612 This is a synonym for @samp{x86_64-*-solaris2*}.
3617 @anchor{amdgcn-x-amdhsa}
3618 @heading amdgcn-*-amdhsa
3621 Instead of GNU Binutils, you will need to install LLVM 6, or later, and copy
3622 @file{bin/llvm-mc} to @file{amdgcn-amdhsa/bin/as},
3623 @file{bin/lld} to @file{amdgcn-amdhsa/bin/ld},
3624 @file{bin/llvm-nm} to @file{amdgcn-amdhsa/bin/nm}, and
3625 @file{bin/llvm-ar} to both @file{bin/amdgcn-amdhsa-ar} and
3626 @file{bin/amdgcn-amdhsa-ranlib}.
3628 Use Newlib (2019-01-16, or newer).
3630 To run the binaries, install the HSA Runtime from the
3631 @uref{https://rocm.github.io,,ROCm Platform}, and use
3632 @file{libexec/gcc/amdhsa-amdhsa/@var{version}/gcn-run} to launch them
3638 @anchor{arc-x-elf32}
3639 @heading arc-*-elf32
3641 Use @samp{configure --target=arc-elf32 --with-cpu=@var{cpu} --enable-languages="c,c++"}
3642 to configure GCC, with @var{cpu} being one of @samp{arc600}, @samp{arc601},
3648 @anchor{arc-linux-uclibc}
3649 @heading arc-linux-uclibc
3651 Use @samp{configure --target=arc-linux-uclibc --with-cpu=arc700 --enable-languages="c,c++"} to configure GCC@.
3658 ARM-family processors.
3660 Building the Ada frontend commonly fails (an infinite loop executing
3661 @code{xsinfo}) if the host compiler is GNAT 4.8. Host compilers built from the
3662 GNAT 4.6, 4.9 or 5 release branches are known to succeed.
3669 ATMEL AVR-family micro controllers. These are used in embedded
3670 applications. There are no standard Unix configurations.
3672 @xref{AVR Options,, AVR Options, gcc, Using the GNU Compiler
3676 See ``AVR Options'' in the main manual
3678 for the list of supported MCU types.
3680 Use @samp{configure --target=avr --enable-languages="c"} to configure GCC@.
3682 Further installation notes and other useful information about AVR tools
3683 can also be obtained from:
3687 @uref{http://www.nongnu.org/avr/,,http://www.nongnu.org/avr/}
3689 @uref{http://www.amelek.gda.pl/avr/,,http://www.amelek.gda.pl/avr/}
3692 The following error:
3694 Error: register required
3697 indicates that you should upgrade to a newer version of the binutils.
3704 The Blackfin processor, an Analog Devices DSP.
3706 @xref{Blackfin Options,, Blackfin Options, gcc, Using the GNU Compiler
3710 See ``Blackfin Options'' in the main manual
3713 More information, and a version of binutils with support for this processor,
3714 are available at @uref{https://sourceforge.net/projects/adi-toolchain/}.
3721 The CR16 CompactRISC architecture is a 16-bit architecture. This
3722 architecture is used in embedded applications.
3725 @xref{CR16 Options,, CR16 Options, gcc, Using and Porting the GNU Compiler
3730 See ``CR16 Options'' in the main manual for a list of CR16-specific options.
3733 Use @samp{configure --target=cr16-elf --enable-languages=c,c++} to configure
3734 GCC@ for building a CR16 elf cross-compiler.
3736 Use @samp{configure --target=cr16-uclinux --enable-languages=c,c++} to
3737 configure GCC@ for building a CR16 uclinux cross-compiler.
3744 CRIS is the CPU architecture in Axis Communications ETRAX system-on-a-chip
3745 series. These are used in embedded applications.
3748 @xref{CRIS Options,, CRIS Options, gcc, Using the GNU Compiler
3752 See ``CRIS Options'' in the main manual
3754 for a list of CRIS-specific options.
3756 There are a few different CRIS targets:
3759 Mainly for monolithic embedded systems. Includes a multilib for the
3760 @samp{v10} core used in @samp{ETRAX 100 LX}.
3761 @item cris-axis-linux-gnu
3762 A GNU/Linux port for the CRIS architecture, currently targeting
3763 @samp{ETRAX 100 LX} by default.
3766 Pre-packaged tools can be obtained from
3767 @uref{ftp://ftp.axis.com/@/pub/@/axis/@/tools/@/cris/@/compiler-kit/}. More
3768 information about this platform is available at
3769 @uref{http://developer.axis.com/}.
3776 Please have a look at the @uref{binaries.html,,binaries page}.
3778 You cannot install GCC by itself on MSDOS; it will not compile under
3779 any MSDOS compiler except itself. You need to get the complete
3780 compilation package DJGPP, which includes binaries as well as sources,
3781 and includes all the necessary compilation tools and libraries.
3786 @anchor{epiphany-x-elf}
3787 @heading epiphany-*-elf
3789 This configuration is intended for embedded systems.
3794 @anchor{x-x-freebsd}
3795 @heading *-*-freebsd*
3796 Support for FreeBSD 1 was discontinued in GCC 3.2. Support for
3797 FreeBSD 2 (and any mutant a.out variants of FreeBSD 3) was
3798 discontinued in GCC 4.0.
3800 In order to better utilize FreeBSD base system functionality and match
3801 the configuration of the system compiler, GCC 4.5 and above as well as
3802 GCC 4.4 past 2010-06-20 leverage SSP support in libc (which is present
3803 on FreeBSD 7 or later) and the use of @code{__cxa_atexit} by default
3804 (on FreeBSD 6 or later). The use of @code{dl_iterate_phdr} inside
3805 @file{libgcc_s.so.1} and boehm-gc (on FreeBSD 7 or later) is enabled
3806 by GCC 4.5 and above.
3808 We support FreeBSD using the ELF file format with DWARF 2 debugging
3809 for all CPU architectures. You may use @option{-gstabs} instead of
3810 @option{-g}, if you really want the old debugging format. There are
3811 no known issues with mixing object files and libraries with different
3812 debugging formats. Otherwise, this release of GCC should now match
3813 more of the configuration used in the stock FreeBSD configuration of
3814 GCC@. In particular, @option{--enable-threads} is now configured by
3815 default. However, as a general user, do not attempt to replace the
3816 system compiler with this release. Known to bootstrap and check with
3817 good results on FreeBSD 7.2-STABLE@. In the past, known to bootstrap
3818 and check with good results on FreeBSD 3.0, 3.4, 4.0, 4.2, 4.3, 4.4,
3819 4.5, 4.8, 4.9 and 5-CURRENT@.
3821 The version of binutils installed in @file{/usr/bin} probably works
3822 with this release of GCC@. Bootstrapping against the latest GNU
3823 binutils and/or the version found in @file{/usr/ports/devel/binutils} has
3824 been known to enable additional features and improve overall testsuite
3825 results. However, it is currently known that boehm-gc may not configure
3826 properly on FreeBSD prior to the FreeBSD 7.0 release with GNU binutils
3835 This configuration is intended for embedded systems.
3842 Renesas H8/300 series of processors.
3844 Please have a look at the @uref{binaries.html,,binaries page}.
3846 The calling convention and structure layout has changed in release 2.6.
3847 All code must be recompiled. The calling convention now passes the
3848 first three arguments in function calls in registers. Structures are no
3849 longer a multiple of 2 bytes.
3854 @anchor{hppa-hp-hpux}
3855 @heading hppa*-hp-hpux*
3856 Support for HP-UX version 9 and older was discontinued in GCC 3.4.
3858 We require using gas/binutils on all hppa platforms. Version 2.19 or
3859 later is recommended.
3861 It may be helpful to configure GCC with the
3862 @uref{./configure.html#with-gnu-as,,@option{--with-gnu-as}} and
3863 @option{--with-as=@dots{}} options to ensure that GCC can find GAS@.
3865 The HP assembler should not be used with GCC. It is rarely tested and may
3866 not work. It shouldn't be used with any languages other than C due to its
3869 Specifically, @option{-g} does not work (HP-UX uses a peculiar debugging
3870 format which GCC does not know about). It also inserts timestamps
3871 into each object file it creates, causing the 3-stage comparison test to
3872 fail during a bootstrap. You should be able to continue by saying
3873 @samp{make all-host all-target} after getting the failure from @samp{make}.
3875 Various GCC features are not supported. For example, it does not support weak
3876 symbols or alias definitions. As a result, explicit template instantiations
3877 are required when using C++. This makes it difficult if not impossible to
3878 build many C++ applications.
3880 There are two default scheduling models for instructions. These are
3881 PROCESSOR_7100LC and PROCESSOR_8000. They are selected from the pa-risc
3882 architecture specified for the target machine when configuring.
3883 PROCESSOR_8000 is the default. PROCESSOR_7100LC is selected when
3884 the target is a @samp{hppa1*} machine.
3886 The PROCESSOR_8000 model is not well suited to older processors. Thus,
3887 it is important to completely specify the machine architecture when
3888 configuring if you want a model other than PROCESSOR_8000. The macro
3889 TARGET_SCHED_DEFAULT can be defined in BOOT_CFLAGS if a different
3890 default scheduling model is desired.
3892 As of GCC 4.0, GCC uses the UNIX 95 namespace for HP-UX 10.10
3893 through 11.00, and the UNIX 98 namespace for HP-UX 11.11 and later.
3894 This namespace change might cause problems when bootstrapping with
3895 an earlier version of GCC or the HP compiler as essentially the same
3896 namespace is required for an entire build. This problem can be avoided
3897 in a number of ways. With HP cc, @env{UNIX_STD} can be set to @samp{95}
3898 or @samp{98}. Another way is to add an appropriate set of predefines
3899 to @env{CC}. The description for the @option{munix=} option contains
3900 a list of the predefines used with each standard.
3902 More specific information to @samp{hppa*-hp-hpux*} targets follows.
3907 @anchor{hppa-hp-hpux10}
3908 @heading hppa*-hp-hpux10
3909 For hpux10.20, we @emph{highly} recommend you pick up the latest sed patch
3910 @code{PHCO_19798} from HP@.
3912 The C++ ABI has changed incompatibly in GCC 4.0. COMDAT subspaces are
3913 used for one-only code and data. This resolves many of the previous
3914 problems in using C++ on this target. However, the ABI is not compatible
3915 with the one implemented under HP-UX 11 using secondary definitions.
3920 @anchor{hppa-hp-hpux11}
3921 @heading hppa*-hp-hpux11
3922 GCC 3.0 and up support HP-UX 11. GCC 2.95.x is not supported and cannot
3923 be used to compile GCC 3.0 and up.
3925 The libffi library haven't been ported to 64-bit HP-UX@ and doesn't build.
3927 Refer to @uref{binaries.html,,binaries} for information about obtaining
3928 precompiled GCC binaries for HP-UX@. Precompiled binaries must be obtained
3929 to build the Ada language as it cannot be bootstrapped using C@. Ada is
3930 only available for the 32-bit PA-RISC runtime.
3932 Starting with GCC 3.4 an ISO C compiler is required to bootstrap. The
3933 bundled compiler supports only traditional C; you will need either HP's
3934 unbundled compiler, or a binary distribution of GCC@.
3936 It is possible to build GCC 3.3 starting with the bundled HP compiler,
3937 but the process requires several steps. GCC 3.3 can then be used to
3938 build later versions.
3940 There are several possible approaches to building the distribution.
3941 Binutils can be built first using the HP tools. Then, the GCC
3942 distribution can be built. The second approach is to build GCC
3943 first using the HP tools, then build binutils, then rebuild GCC@.
3944 There have been problems with various binary distributions, so it
3945 is best not to start from a binary distribution.
3947 On 64-bit capable systems, there are two distinct targets. Different
3948 installation prefixes must be used if both are to be installed on
3949 the same system. The @samp{hppa[1-2]*-hp-hpux11*} target generates code
3950 for the 32-bit PA-RISC runtime architecture and uses the HP linker.
3951 The @samp{hppa64-hp-hpux11*} target generates 64-bit code for the
3952 PA-RISC 2.0 architecture.
3954 The script config.guess now selects the target type based on the compiler
3955 detected during configuration. You must define @env{PATH} or @env{CC} so
3956 that configure finds an appropriate compiler for the initial bootstrap.
3957 When @env{CC} is used, the definition should contain the options that are
3958 needed whenever @env{CC} is used.
3960 Specifically, options that determine the runtime architecture must be
3961 in @env{CC} to correctly select the target for the build. It is also
3962 convenient to place many other compiler options in @env{CC}. For example,
3963 @env{CC="cc -Ac +DA2.0W -Wp,-H16376 -D_CLASSIC_TYPES -D_HPUX_SOURCE"}
3964 can be used to bootstrap the GCC 3.3 branch with the HP compiler in
3965 64-bit K&R/bundled mode. The @option{+DA2.0W} option will result in
3966 the automatic selection of the @samp{hppa64-hp-hpux11*} target. The
3967 macro definition table of cpp needs to be increased for a successful
3968 build with the HP compiler. _CLASSIC_TYPES and _HPUX_SOURCE need to
3969 be defined when building with the bundled compiler, or when using the
3970 @option{-Ac} option. These defines aren't necessary with @option{-Ae}.
3972 It is best to explicitly configure the @samp{hppa64-hp-hpux11*} target
3973 with the @option{--with-ld=@dots{}} option. This overrides the standard
3974 search for ld. The two linkers supported on this target require different
3975 commands. The default linker is determined during configuration. As a
3976 result, it's not possible to switch linkers in the middle of a GCC build.
3977 This has been reported to sometimes occur in unified builds of binutils
3980 A recent linker patch must be installed for the correct operation of
3981 GCC 3.3 and later. @code{PHSS_26559} and @code{PHSS_24304} are the
3982 oldest linker patches that are known to work. They are for HP-UX
3983 11.00 and 11.11, respectively. @code{PHSS_24303}, the companion to
3984 @code{PHSS_24304}, might be usable but it hasn't been tested. These
3985 patches have been superseded. Consult the HP patch database to obtain
3986 the currently recommended linker patch for your system.
3988 The patches are necessary for the support of weak symbols on the
3989 32-bit port, and for the running of initializers and finalizers. Weak
3990 symbols are implemented using SOM secondary definition symbols. Prior
3991 to HP-UX 11, there are bugs in the linker support for secondary symbols.
3992 The patches correct a problem of linker core dumps creating shared
3993 libraries containing secondary symbols, as well as various other
3994 linking issues involving secondary symbols.
3996 GCC 3.3 uses the ELF DT_INIT_ARRAY and DT_FINI_ARRAY capabilities to
3997 run initializers and finalizers on the 64-bit port. The 32-bit port
3998 uses the linker @option{+init} and @option{+fini} options for the same
3999 purpose. The patches correct various problems with the +init/+fini
4000 options, including program core dumps. Binutils 2.14 corrects a
4001 problem on the 64-bit port resulting from HP's non-standard use of
4002 the .init and .fini sections for array initializers and finalizers.
4004 Although the HP and GNU linkers are both supported for the
4005 @samp{hppa64-hp-hpux11*} target, it is strongly recommended that the
4006 HP linker be used for link editing on this target.
4008 At this time, the GNU linker does not support the creation of long
4009 branch stubs. As a result, it cannot successfully link binaries
4010 containing branch offsets larger than 8 megabytes. In addition,
4011 there are problems linking shared libraries, linking executables
4012 with @option{-static}, and with dwarf2 unwind and exception support.
4013 It also doesn't provide stubs for internal calls to global functions
4014 in shared libraries, so these calls cannot be overloaded.
4016 The HP dynamic loader does not support GNU symbol versioning, so symbol
4017 versioning is not supported. It may be necessary to disable symbol
4018 versioning with @option{--disable-symvers} when using GNU ld.
4020 POSIX threads are the default. The optional DCE thread library is not
4021 supported, so @option{--enable-threads=dce} does not work.
4026 @anchor{x-x-linux-gnu}
4027 @heading *-*-linux-gnu
4028 Versions of libstdc++-v3 starting with 3.2.1 require bug fixes present
4029 in glibc 2.2.5 and later. More information is available in the
4030 libstdc++-v3 documentation.
4035 @anchor{ix86-x-linux}
4036 @heading i?86-*-linux*
4037 As of GCC 3.3, binutils 2.13.1 or later is required for this platform.
4038 See @uref{http://gcc.gnu.org/PR10877,,bug 10877} for more information.
4040 If you receive Signal 11 errors when building on GNU/Linux, then it is
4041 possible you have a hardware problem. Further information on this can be
4042 found on @uref{http://www.bitwizard.nl/sig11/,,www.bitwizard.nl}.
4047 @anchor{ix86-x-solaris2}
4048 @heading i?86-*-solaris2*
4049 Use this for Solaris 11.3 or later on x86 and x86-64 systems. Starting
4050 with GCC 4.7, there is also a 64-bit @samp{amd64-*-solaris2*} or
4051 @samp{x86_64-*-solaris2*} configuration that corresponds to
4052 @samp{sparcv9-sun-solaris2*}.
4054 It is recommended that you configure GCC to use the GNU assembler. The
4055 versions included in Solaris 11.3, from GNU binutils 2.23.1 or
4056 newer (available as @file{/usr/bin/gas} and
4057 @file{/usr/gnu/bin/as}), work fine. The current version, from GNU
4058 binutils 2.34, is known to work. Recent versions of the Solaris assembler in
4059 @file{/usr/bin/as} work almost as well, though.
4061 For linking, the Solaris linker is preferred. If you want to use the GNU
4062 linker instead, the version in Solaris 11.3, from GNU binutils 2.23.1 or
4063 newer (in @file{/usr/gnu/bin/ld} and @file{/usr/bin/gld}), works,
4064 as does the latest version, from GNU binutils 2.34.
4066 To use GNU @command{as}, configure with the options
4067 @option{--with-gnu-as --with-as=@//usr/@/gnu/@/bin/@/as}. It may be necessary
4068 to configure with @option{--without-gnu-ld --with-ld=@//usr/@/ccs/@/bin/@/ld} to
4069 guarantee use of Solaris @command{ld}.
4070 @c FIXME: why --without-gnu-ld --with-ld?
4075 @anchor{ia64-x-linux}
4076 @heading ia64-*-linux
4077 IA-64 processor (also known as IPF, or Itanium Processor Family)
4080 If you are using the installed system libunwind library with
4081 @option{--with-system-libunwind}, then you must use libunwind 0.98 or
4084 None of the following versions of GCC has an ABI that is compatible
4085 with any of the other versions in this list, with the exception that
4086 Red Hat 2.96 and Trillian 000171 are compatible with each other:
4087 3.1, 3.0.2, 3.0.1, 3.0, Red Hat 2.96, and Trillian 000717.
4088 This primarily affects C++ programs and programs that create shared libraries.
4089 GCC 3.1 or later is recommended for compiling linux, the kernel.
4090 As of version 3.1 GCC is believed to be fully ABI compliant, and hence no
4091 more major ABI changes are expected.
4096 @anchor{ia64-x-hpux}
4097 @heading ia64-*-hpux*
4098 Building GCC on this target requires the GNU Assembler. The bundled HP
4099 assembler will not work. To prevent GCC from using the wrong assembler,
4100 the option @option{--with-gnu-as} may be necessary.
4102 The GCC libunwind library has not been ported to HPUX@. This means that for
4103 GCC versions 3.2.3 and earlier, @option{--enable-libunwind-exceptions}
4104 is required to build GCC@. For GCC 3.3 and later, this is the default.
4105 For gcc 3.4.3 and later, @option{--enable-libunwind-exceptions} is
4106 removed and the system libunwind library will always be used.
4110 <!-- rs6000-ibm-aix*, powerpc-ibm-aix* -->
4114 Support for AIX version 3 and older was discontinued in GCC 3.4.
4115 Support for AIX version 4.2 and older was discontinued in GCC 4.5.
4117 ``out of memory'' bootstrap failures may indicate a problem with
4118 process resource limits (ulimit). Hard limits are configured in the
4119 @file{/etc/security/limits} system configuration file.
4121 GCC 4.9 and above require a C++ compiler for bootstrap. IBM VAC++ / xlC
4122 cannot bootstrap GCC. xlc can bootstrap an older version of GCC and
4123 G++ can bootstrap recent releases of GCC.
4125 GCC can bootstrap with recent versions of IBM XLC, but bootstrapping
4126 with an earlier release of GCC is recommended. Bootstrapping with XLC
4127 requires a larger data segment, which can be enabled through the
4128 @var{LDR_CNTRL} environment variable, e.g.,
4131 % LDR_CNTRL=MAXDATA=0x50000000
4135 One can start with a pre-compiled version of GCC to build from
4136 sources. One may delete GCC's ``fixed'' header files when starting
4137 with a version of GCC built for an earlier release of AIX.
4139 To speed up the configuration phases of bootstrapping and installing GCC,
4140 one may use GNU Bash instead of AIX @command{/bin/sh}, e.g.,
4143 % CONFIG_SHELL=/opt/freeware/bin/bash
4144 % export CONFIG_SHELL
4147 and then proceed as described in @uref{build.html,,the build
4148 instructions}, where we strongly recommend specifying an absolute path
4149 to invoke @var{srcdir}/configure.
4151 Because GCC on AIX is built as a 32-bit executable by default,
4152 (although it can generate 64-bit programs) the GMP and MPFR libraries
4153 required by gfortran must be 32-bit libraries. Building GMP and MPFR
4154 as static archive libraries works better than shared libraries.
4156 Errors involving @code{alloca} when building GCC generally are due
4157 to an incorrect definition of @code{CC} in the Makefile or mixing files
4158 compiled with the native C compiler and GCC@. During the stage1 phase of
4159 the build, the native AIX compiler @strong{must} be invoked as @command{cc}
4160 (not @command{xlc}). Once @command{configure} has been informed of
4161 @command{xlc}, one needs to use @samp{make distclean} to remove the
4162 configure cache files and ensure that @env{CC} environment variable
4163 does not provide a definition that will confuse @command{configure}.
4164 If this error occurs during stage2 or later, then the problem most likely
4165 is the version of Make (see above).
4167 The native @command{as} and @command{ld} are recommended for
4168 bootstrapping on AIX@. The GNU Assembler, GNU Linker, and GNU
4169 Binutils version 2.20 is the minimum level that supports bootstrap on
4170 AIX 5@. The GNU Assembler has not been updated to support AIX 6@ or
4171 AIX 7. The native AIX tools do interoperate with GCC@.
4173 AIX 7.1 added partial support for DWARF debugging, but full support
4174 requires AIX 7.1 TL03 SP7 that supports additional DWARF sections and
4175 fixes a bug in the assembler. AIX 7.1 TL03 SP5 distributed a version
4176 of libm.a missing important symbols; a fix for IV77796 will be
4179 AIX 5.3 TL10, AIX 6.1 TL05 and AIX 7.1 TL00 introduced an AIX
4180 assembler change that sometimes produces corrupt assembly files
4181 causing AIX linker errors. The bug breaks GCC bootstrap on AIX and
4182 can cause compilation failures with existing GCC installations. An
4183 AIX iFix for AIX 5.3 is available (APAR IZ98385 for AIX 5.3 TL10, APAR
4184 IZ98477 for AIX 5.3 TL11 and IZ98134 for AIX 5.3 TL12). AIX 5.3 TL11 SP8,
4185 AIX 5.3 TL12 SP5, AIX 6.1 TL04 SP11, AIX 6.1 TL05 SP7, AIX 6.1 TL06 SP6,
4186 AIX 6.1 TL07 and AIX 7.1 TL01 should include the fix.
4188 Building @file{libstdc++.a} requires a fix for an AIX Assembler bug
4189 APAR IY26685 (AIX 4.3) or APAR IY25528 (AIX 5.1). It also requires a
4190 fix for another AIX Assembler bug and a co-dependent AIX Archiver fix
4191 referenced as APAR IY53606 (AIX 5.2) or as APAR IY54774 (AIX 5.1)
4193 @anchor{TransferAixShobj}
4194 @samp{libstdc++} in GCC 3.4 increments the major version number of the
4195 shared object and GCC installation places the @file{libstdc++.a}
4196 shared library in a common location which will overwrite the and GCC
4197 3.3 version of the shared library. Applications either need to be
4198 re-linked against the new shared library or the GCC 3.1 and GCC 3.3
4199 versions of the @samp{libstdc++} shared object needs to be available
4200 to the AIX runtime loader. The GCC 3.1 @samp{libstdc++.so.4}, if
4201 present, and GCC 3.3 @samp{libstdc++.so.5} shared objects can be
4202 installed for runtime dynamic loading using the following steps to set
4203 the @samp{F_LOADONLY} flag in the shared object for @emph{each}
4204 multilib @file{libstdc++.a} installed:
4206 Extract the shared objects from the currently installed
4207 @file{libstdc++.a} archive:
4209 % ar -x libstdc++.a libstdc++.so.4 libstdc++.so.5
4212 Enable the @samp{F_LOADONLY} flag so that the shared object will be
4213 available for runtime dynamic loading, but not linking:
4215 % strip -e libstdc++.so.4 libstdc++.so.5
4218 Archive the runtime-only shared object in the GCC 3.4
4219 @file{libstdc++.a} archive:
4221 % ar -q libstdc++.a libstdc++.so.4 libstdc++.so.5
4225 @uref{./configure.html#WithAixSoname,,@option{--with-aix-soname=svr4}}
4226 configure option may drop the need for this procedure for libraries that
4229 Linking executables and shared libraries may produce warnings of
4230 duplicate symbols. The assembly files generated by GCC for AIX always
4231 have included multiple symbol definitions for certain global variable
4232 and function declarations in the original program. The warnings should
4233 not prevent the linker from producing a correct library or runnable
4236 AIX 4.3 utilizes a ``large format'' archive to support both 32-bit and
4237 64-bit object modules. The routines provided in AIX 4.3.0 and AIX 4.3.1
4238 to parse archive libraries did not handle the new format correctly.
4239 These routines are used by GCC and result in error messages during
4240 linking such as ``not a COFF file''. The version of the routines shipped
4241 with AIX 4.3.1 should work for a 32-bit environment. The @option{-g}
4242 option of the archive command may be used to create archives of 32-bit
4243 objects using the original ``small format''. A correct version of the
4244 routines is shipped with AIX 4.3.2 and above.
4246 Some versions of the AIX binder (linker) can fail with a relocation
4247 overflow severe error when the @option{-bbigtoc} option is used to link
4248 GCC-produced object files into an executable that overflows the TOC@. A fix
4249 for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND -BBIGTOC) is
4250 available from IBM Customer Support and from its
4251 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
4252 website as PTF U455193.
4254 The AIX 4.3.2.1 linker (bos.rte.bind_cmds Level 4.3.2.1) will dump core
4255 with a segmentation fault when invoked by any version of GCC@. A fix for
4256 APAR IX87327 is available from IBM Customer Support and from its
4257 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
4258 website as PTF U461879. This fix is incorporated in AIX 4.3.3 and above.
4260 The initial assembler shipped with AIX 4.3.0 generates incorrect object
4261 files. A fix for APAR IX74254 (64BIT DISASSEMBLED OUTPUT FROM COMPILER FAILS
4262 TO ASSEMBLE/BIND) is available from IBM Customer Support and from its
4263 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
4264 website as PTF U453956. This fix is incorporated in AIX 4.3.1 and above.
4266 AIX provides National Language Support (NLS)@. Compilers and assemblers
4267 use NLS to support locale-specific representations of various data
4268 formats including floating-point numbers (e.g., @samp{.} vs @samp{,} for
4269 separating decimal fractions). There have been problems reported where
4270 GCC does not produce the same floating-point formats that the assembler
4271 expects. If one encounters this problem, set the @env{LANG}
4272 environment variable to @samp{C} or @samp{En_US}.
4274 A default can be specified with the @option{-mcpu=@var{cpu_type}}
4275 switch and using the configure option @option{--with-cpu-@var{cpu_type}}.
4280 @anchor{iq2000-x-elf}
4281 @heading iq2000-*-elf
4282 Vitesse IQ2000 processors. These are used in embedded
4283 applications. There are no standard Unix configurations.
4290 Lattice Mico32 processor.
4291 This configuration is intended for embedded systems.
4296 @anchor{lm32-x-uclinux}
4297 @heading lm32-*-uclinux
4298 Lattice Mico32 processor.
4299 This configuration is intended for embedded systems running uClinux.
4306 Renesas M32C processor.
4307 This configuration is intended for embedded systems.
4314 Renesas M32R processor.
4315 This configuration is intended for embedded systems.
4323 @samp{m68k-*-elf*}, @samp{m68k-*-rtems}, @samp{m68k-*-uclinux} and
4325 build libraries for both M680x0 and ColdFire processors. If you only
4326 need the M680x0 libraries, you can omit the ColdFire ones by passing
4327 @option{--with-arch=m68k} to @command{configure}. Alternatively, you
4328 can omit the M680x0 libraries by passing @option{--with-arch=cf} to
4329 @command{configure}. These targets default to 5206 or 5475 code as
4330 appropriate for the target system when
4331 configured with @option{--with-arch=cf} and 68020 code otherwise.
4333 The @samp{m68k-*-netbsd} and
4334 @samp{m68k-*-openbsd} targets also support the @option{--with-arch}
4335 option. They will generate ColdFire CFV4e code when configured with
4336 @option{--with-arch=cf} and 68020 code otherwise.
4338 You can override the default processors listed above by configuring
4339 with @option{--with-cpu=@var{target}}. This @var{target} can either
4340 be a @option{-mcpu} argument or one of the following values:
4341 @samp{m68000}, @samp{m68010}, @samp{m68020}, @samp{m68030},
4342 @samp{m68040}, @samp{m68060}, @samp{m68020-40} and @samp{m68020-60}.
4344 GCC requires at least binutils version 2.17 on these targets.
4349 @anchor{m68k-x-uclinux}
4350 @heading m68k-*-uclinux
4351 GCC 4.3 changed the uClinux configuration so that it uses the
4352 @samp{m68k-linux-gnu} ABI rather than the @samp{m68k-elf} ABI.
4353 It also added improved support for C++ and flat shared libraries,
4354 both of which were ABI changes.
4359 @anchor{microblaze-x-elf}
4360 @heading microblaze-*-elf
4361 Xilinx MicroBlaze processor.
4362 This configuration is intended for embedded systems.
4369 If on a MIPS system you get an error message saying ``does not have gp
4370 sections for all it's [sic] sectons [sic]'', don't worry about it. This
4371 happens whenever you use GAS with the MIPS linker, but there is not
4372 really anything wrong, and it is okay to use the output file. You can
4373 stop such warnings by installing the GNU linker.
4375 It would be nice to extend GAS to produce the gp tables, but they are
4376 optional, and there should not be a warning about their absence.
4378 The libstdc++ atomic locking routines for MIPS targets requires MIPS II
4379 and later. A patch went in just after the GCC 3.3 release to
4380 make @samp{mips*-*-*} use the generic implementation instead. You can also
4381 configure for @samp{mipsel-elf} as a workaround. The
4382 @samp{mips*-*-linux*} target continues to use the MIPS II routines. More
4383 work on this is expected in future releases.
4385 @c If you make --with-llsc the default for another target, please also
4386 @c update the description of the --with-llsc option.
4388 The built-in @code{__sync_*} functions are available on MIPS II and
4389 later systems and others that support the @samp{ll}, @samp{sc} and
4390 @samp{sync} instructions. This can be overridden by passing
4391 @option{--with-llsc} or @option{--without-llsc} when configuring GCC.
4392 Since the Linux kernel emulates these instructions if they are
4393 missing, the default for @samp{mips*-*-linux*} targets is
4394 @option{--with-llsc}. The @option{--with-llsc} and
4395 @option{--without-llsc} configure options may be overridden at compile
4396 time by passing the @option{-mllsc} or @option{-mno-llsc} options to
4399 MIPS systems check for division by zero (unless
4400 @option{-mno-check-zero-division} is passed to the compiler) by
4401 generating either a conditional trap or a break instruction. Using
4402 trap results in smaller code, but is only supported on MIPS II and
4403 later. Also, some versions of the Linux kernel have a bug that
4404 prevents trap from generating the proper signal (@code{SIGFPE}). To enable
4405 the use of break, use the @option{--with-divide=breaks}
4406 @command{configure} option when configuring GCC@. The default is to
4407 use traps on systems that support them.
4412 @anchor{moxie-x-elf}
4413 @heading moxie-*-elf
4414 The moxie processor.
4419 @anchor{msp430-x-elf}
4420 @heading msp430-*-elf*
4421 TI MSP430 processor.
4422 This configuration is intended for embedded systems.
4424 @samp{msp430-*-elf} is the standard configuration with most GCC
4425 features enabled by default.
4427 @samp{msp430-*-elfbare} is tuned for a bare-metal environment, and disables
4428 features related to shared libraries and other functionality not used for
4429 this device. This reduces code and data usage of the GCC libraries, resulting
4430 in a minimal run-time environment by default.
4432 Features disabled by default include:
4434 @item transactional memory
4441 @anchor{nds32le-x-elf}
4442 @heading nds32le-*-elf
4443 Andes NDS32 target in little endian mode.
4448 @anchor{nds32be-x-elf}
4449 @heading nds32be-*-elf
4450 Andes NDS32 target in big endian mode.
4455 @anchor{nvptx-x-none}
4456 @heading nvptx-*-none
4459 Instead of GNU binutils, you will need to install
4460 @uref{https://github.com/MentorEmbedded/nvptx-tools/,,nvptx-tools}.
4461 Tell GCC where to find it:
4462 @option{--with-build-time-tools=[install-nvptx-tools]/nvptx-none/bin}.
4464 You will need newlib 3.0 git revision
4465 cd31fbb2aea25f94d7ecedc9db16dfc87ab0c316 or later. It can be
4466 automatically built together with GCC@. For this, add a symbolic link
4467 to nvptx-newlib's @file{newlib} directory to the directory containing
4470 Use the @option{--disable-sjlj-exceptions} and
4471 @option{--enable-newlib-io-long-long} options when configuring.
4478 The OpenRISC 1000 32-bit processor with delay slots.
4479 This configuration is intended for embedded systems.
4484 @anchor{or1k-x-linux}
4485 @heading or1k-*-linux
4486 The OpenRISC 1000 32-bit processor with delay slots.
4491 @anchor{powerpc-x-x}
4492 @heading powerpc-*-*
4493 You can specify a default version for the @option{-mcpu=@var{cpu_type}}
4494 switch by using the configure option @option{--with-cpu-@var{cpu_type}}.
4496 You will need GNU binutils 2.20 or newer.
4501 @anchor{powerpc-x-darwin}
4502 @heading powerpc-*-darwin*
4503 PowerPC running Darwin (Mac OS X kernel).
4505 Pre-installed versions of Mac OS X may not include any developer tools,
4506 meaning that you will not be able to build GCC from source. Tool
4507 binaries are available at
4508 @uref{https://opensource.apple.com}.
4510 This version of GCC requires at least cctools-590.36. The
4511 cctools-590.36 package referenced from
4512 @uref{http://gcc.gnu.org/ml/gcc/2006-03/msg00507.html} will not work
4513 on systems older than 10.3.9 (aka darwin7.9.0).
4518 @anchor{powerpc-x-elf}
4519 @heading powerpc-*-elf
4520 PowerPC system in big endian mode, running System V.4.
4525 @anchor{powerpc-x-linux-gnu}
4526 @heading powerpc*-*-linux-gnu*
4527 PowerPC system in big endian mode running Linux.
4532 @anchor{powerpc-x-netbsd}
4533 @heading powerpc-*-netbsd*
4534 PowerPC system in big endian mode running NetBSD@.
4539 @anchor{powerpc-x-eabisim}
4540 @heading powerpc-*-eabisim
4541 Embedded PowerPC system in big endian mode for use in running under the
4547 @anchor{powerpc-x-eabi}
4548 @heading powerpc-*-eabi
4549 Embedded PowerPC system in big endian mode.
4554 @anchor{powerpcle-x-elf}
4555 @heading powerpcle-*-elf
4556 PowerPC system in little endian mode, running System V.4.
4561 @anchor{powerpcle-x-eabisim}
4562 @heading powerpcle-*-eabisim
4563 Embedded PowerPC system in little endian mode for use in running under
4569 @anchor{powerpcle-x-eabi}
4570 @heading powerpcle-*-eabi
4571 Embedded PowerPC system in little endian mode.
4578 The Renesas RL78 processor.
4579 This configuration is intended for embedded systems.
4584 @anchor{riscv32-x-elf}
4585 @heading riscv32-*-elf
4586 The RISC-V RV32 instruction set.
4587 This configuration is intended for embedded systems.
4588 This (and all other RISC-V) targets require the binutils 2.30 release.
4593 @anchor{riscv32-x-linux}
4594 @heading riscv32-*-linux
4595 The RISC-V RV32 instruction set running GNU/Linux.
4596 This (and all other RISC-V) targets require the binutils 2.30 release.
4601 @anchor{riscv64-x-elf}
4602 @heading riscv64-*-elf
4603 The RISC-V RV64 instruction set.
4604 This configuration is intended for embedded systems.
4605 This (and all other RISC-V) targets require the binutils 2.30 release.
4610 @anchor{riscv64-x-linux}
4611 @heading riscv64-*-linux
4612 The RISC-V RV64 instruction set running GNU/Linux.
4613 This (and all other RISC-V) targets require the binutils 2.30 release.
4620 The Renesas RX processor.
4625 @anchor{s390-x-linux}
4626 @heading s390-*-linux*
4627 S/390 system running GNU/Linux for S/390@.
4632 @anchor{s390x-x-linux}
4633 @heading s390x-*-linux*
4634 zSeries system (64-bit) running GNU/Linux for zSeries@.
4639 @anchor{s390x-ibm-tpf}
4640 @heading s390x-ibm-tpf*
4641 zSeries system (64-bit) running TPF@. This platform is
4642 supported as cross-compilation target only.
4647 @c Please use Solaris 2 to refer to all release of Solaris, starting
4648 @c with 2.0 until 2.6, 7, 8, etc. Solaris 1 was a marketing name for
4649 @c SunOS 4 releases which we don't use to avoid confusion. Solaris
4650 @c alone is too unspecific and must be avoided.
4651 @anchor{x-x-solaris2}
4652 @heading *-*-solaris2*
4653 Support for Solaris 10 has been removed in GCC 10. Support for Solaris
4654 9 has been removed in GCC 5. Support for Solaris 8 has been removed in
4655 GCC 4.8. Support for Solaris 7 has been removed in GCC 4.6.
4657 Solaris 11.3 provides GCC 4.5.2, 4.7.3, and 4.8.2 as
4658 @command{/usr/gcc/4.5/bin/gcc} or similar. Newer Solaris versions
4659 provide one or more of GCC 5, 7, and 9. Alternatively,
4660 you can install a pre-built GCC to bootstrap and install GCC. See the
4661 @uref{binaries.html,,binaries page} for details.
4663 The Solaris 2 @command{/bin/sh} will often fail to configure
4664 @samp{libstdc++-v3}. We therefore recommend using the
4665 following initial sequence of commands
4668 % CONFIG_SHELL=/bin/ksh
4669 % export CONFIG_SHELL
4673 and proceed as described in @uref{configure.html,,the configure instructions}.
4674 In addition we strongly recommend specifying an absolute path to invoke
4675 @command{@var{srcdir}/configure}.
4677 In Solaris 11, you need to check for @code{system/header},
4678 @code{system/linker}, and @code{developer/assembler} packages.
4680 Trying to use the linker and other tools in
4681 @file{/usr/ucb} to install GCC has been observed to cause trouble.
4682 For example, the linker may hang indefinitely. The fix is to remove
4683 @file{/usr/ucb} from your @env{PATH}.
4685 The build process works more smoothly with the legacy Solaris tools so, if you
4686 have @file{/usr/xpg4/bin} in your @env{PATH}, we recommend that you place
4687 @file{/usr/bin} before @file{/usr/xpg4/bin} for the duration of the build.
4689 We recommend the use of the Solaris assembler or the GNU assembler, in
4690 conjunction with the Solaris linker. The GNU @command{as}
4691 versions included in Solaris 11.3,
4692 from GNU binutils 2.23.1 or newer (in @file{/usr/bin/gas} and
4693 @file{/usr/gnu/bin/as}), are known to work.
4694 The current version, from GNU binutils 2.34,
4695 is known to work as well. Note that your mileage may vary
4696 if you use a combination of the GNU tools and the Solaris tools: while the
4697 combination GNU @command{as} + Solaris @command{ld} should reasonably work,
4698 the reverse combination Solaris @command{as} + GNU @command{ld} may fail to
4699 build or cause memory corruption at runtime in some cases for C++ programs.
4701 GNU @command{ld} usually works as well. Again, the current
4702 version (2.34) is known to work, but generally lacks platform specific
4703 features, so better stay with Solaris @command{ld}. To use the LTO linker
4704 plugin (@option{-fuse-linker-plugin}) with GNU @command{ld}, GNU
4705 binutils @emph{must} be configured with @option{--enable-largefile}.
4707 To enable symbol versioning in @samp{libstdc++} with the Solaris linker,
4708 you need to have any version of GNU @command{c++filt}, which is part of
4709 GNU binutils. @samp{libstdc++} symbol versioning will be disabled if no
4710 appropriate version is found. Solaris @command{c++filt} from the Solaris
4711 Studio compilers does @emph{not} work.
4713 The versions of the GNU Multiple Precision Library (GMP), the MPFR
4714 library and the MPC library bundled with Solaris 11.3 and later are
4715 usually recent enough to match GCC's requirements. There are two
4720 While the version of the GMP library in Solaris 11.3 works with GCC, you
4721 need to configure with @option{--with-gmp-include=/usr/include/gmp}.
4724 The version of the MPFR libary included in Solaris 11.3 is too old; you
4725 need to provide a more recent one.
4733 This section contains general configuration information for all
4734 SPARC-based platforms. In addition to reading this section, please
4735 read all other sections that match your target.
4737 Newer versions of the GNU Multiple Precision Library (GMP), the MPFR
4738 library and the MPC library are known to be miscompiled by earlier
4739 versions of GCC on these platforms. We therefore recommend the use
4740 of the exact versions of these libraries listed as minimal versions
4741 in @uref{prerequisites.html,,the prerequisites}.
4746 @anchor{sparc-sun-solaris2}
4747 @heading sparc-sun-solaris2*
4748 When GCC is configured to use GNU binutils 2.14 or later, the binaries
4749 produced are smaller than the ones produced using Solaris native tools;
4750 this difference is quite significant for binaries containing debugging
4753 Starting with Solaris 7, the operating system is capable of executing
4754 64-bit SPARC V9 binaries. GCC 3.1 and later properly supports
4755 this; the @option{-m64} option enables 64-bit code generation.
4756 However, if all you want is code tuned for the UltraSPARC CPU, you
4757 should try the @option{-mtune=ultrasparc} option instead, which produces
4758 code that, unlike full 64-bit code, can still run on non-UltraSPARC
4761 When configuring the GNU Multiple Precision Library (GMP), the MPFR
4762 library or the MPC library on a Solaris 7 or later system, the canonical
4763 target triplet must be specified as the @command{build} parameter on the
4764 configure line. This target triplet can be obtained by invoking @command{./config.guess} in the toplevel source directory of GCC (and
4765 not that of GMP or MPFR or MPC). For example on a Solaris 11 system:
4768 % ./configure --build=sparc-sun-solaris2.11 --prefix=xxx
4774 @anchor{sparc-x-linux}
4775 @heading sparc-*-linux*
4780 @anchor{sparc64-x-solaris2}
4781 @heading sparc64-*-solaris2*
4782 When configuring a 64-bit-default GCC on Solaris/SPARC, you must use a
4783 build compiler that generates 64-bit code, either by default or by
4784 specifying @samp{CC='gcc -m64' CXX='gcc-m64'} to @command{configure}.
4785 Additionally, you @emph{must} pass @option{--build=sparc64-sun-solaris2.11}
4786 or @option{--build=sparcv9-sun-solaris2.11} because @file{config.guess}
4787 misdetects this situation, which can cause build failures.
4789 When configuring the GNU Multiple Precision Library (GMP), the MPFR
4790 library or the MPC library, the canonical target triplet must be specified
4791 as the @command{build} parameter on the configure line. For example
4792 on a Solaris 11 system:
4795 % ./configure --build=sparc64-sun-solaris2.11 --prefix=xxx
4801 @anchor{sparcv9-x-solaris2}
4802 @heading sparcv9-*-solaris2*
4803 This is a synonym for @samp{sparc64-*-solaris2*}.
4810 The C6X family of processors. This port requires binutils-2.22 or newer.
4815 @anchor{tilegx-*-linux}
4816 @heading tilegx-*-linux*
4817 The TILE-Gx processor in little endian mode, running GNU/Linux. This
4818 port requires binutils-2.22 or newer.
4823 @anchor{tilegxbe-*-linux}
4824 @heading tilegxbe-*-linux*
4825 The TILE-Gx processor in big endian mode, running GNU/Linux. This
4826 port requires binutils-2.23 or newer.
4831 @anchor{tilepro-*-linux}
4832 @heading tilepro-*-linux*
4833 The TILEPro processor running GNU/Linux. This port requires
4834 binutils-2.22 or newer.
4839 @anchor{visium-x-elf}
4840 @heading visium-*-elf
4841 CDS VISIUMcore processor.
4842 This configuration is intended for embedded systems.
4847 @anchor{x-x-vxworks}
4848 @heading *-*-vxworks*
4849 Support for VxWorks is in flux. At present GCC supports @emph{only} the
4850 very recent VxWorks 5.5 (aka Tornado 2.2) release, and only on PowerPC@.
4851 We welcome patches for other architectures supported by VxWorks 5.5.
4852 Support for VxWorks AE would also be welcome; we believe this is merely
4853 a matter of writing an appropriate ``configlette'' (see below). We are
4854 not interested in supporting older, a.out or COFF-based, versions of
4857 VxWorks comes with an older version of GCC installed in
4858 @file{@var{$WIND_BASE}/host}; we recommend you do not overwrite it.
4859 Choose an installation @var{prefix} entirely outside @var{$WIND_BASE}.
4860 Before running @command{configure}, create the directories @file{@var{prefix}}
4861 and @file{@var{prefix}/bin}. Link or copy the appropriate assembler,
4862 linker, etc.@: into @file{@var{prefix}/bin}, and set your @var{PATH} to
4863 include that directory while running both @command{configure} and
4866 You must give @command{configure} the
4867 @option{--with-headers=@var{$WIND_BASE}/target/h} switch so that it can
4868 find the VxWorks system headers. Since VxWorks is a cross compilation
4869 target only, you must also specify @option{--target=@var{target}}.
4870 @command{configure} will attempt to create the directory
4871 @file{@var{prefix}/@var{target}/sys-include} and copy files into it;
4872 make sure the user running @command{configure} has sufficient privilege
4875 GCC's exception handling runtime requires a special ``configlette''
4876 module, @file{contrib/gthr_supp_vxw_5x.c}. Follow the instructions in
4877 that file to add the module to your kernel build. (Future versions of
4878 VxWorks will incorporate this module.)
4884 @heading x86_64-*-*, amd64-*-*
4885 GCC supports the x86-64 architecture implemented by the AMD64 processor
4886 (amd64-*-* is an alias for x86_64-*-*) on GNU/Linux, FreeBSD and NetBSD@.
4887 On GNU/Linux the default is a bi-arch compiler which is able to generate
4888 both 64-bit x86-64 and 32-bit x86 code (via the @option{-m32} switch).
4893 @anchor{x86-64-x-solaris2}
4894 @heading x86_64-*-solaris2*
4895 GCC also supports the x86-64 architecture implemented by the AMD64
4896 processor (@samp{amd64-*-*} is an alias for @samp{x86_64-*-*}) on
4897 Solaris 10 or later. Unlike other systems, without special options a
4898 bi-arch compiler is built which generates 32-bit code by default, but
4899 can generate 64-bit x86-64 code with the @option{-m64} switch. Since
4900 GCC 4.7, there is also a configuration that defaults to 64-bit code, but
4901 can generate 32-bit code with @option{-m32}. To configure and build
4902 this way, you have to provide all support libraries like @file{libgmp}
4903 as 64-bit code, configure with @option{--target=x86_64-pc-solaris2.11}
4904 and @samp{CC=gcc -m64}.
4909 @anchor{xtensa-x-elf}
4910 @heading xtensa*-*-elf
4911 This target is intended for embedded Xtensa systems using the
4912 @samp{newlib} C library. It uses ELF but does not support shared
4913 objects. Designed-defined instructions specified via the
4914 Tensilica Instruction Extension (TIE) language are only supported
4915 through inline assembly.
4917 The Xtensa configuration information must be specified prior to
4918 building GCC@. The @file{include/xtensa-config.h} header
4919 file contains the configuration information. If you created your
4920 own Xtensa configuration with the Xtensa Processor Generator, the
4921 downloaded files include a customized copy of this header file,
4922 which you can use to replace the default header file.
4927 @anchor{xtensa-x-linux}
4928 @heading xtensa*-*-linux*
4929 This target is for Xtensa systems running GNU/Linux. It supports ELF
4930 shared objects and the GNU C library (glibc). It also generates
4931 position-independent code (PIC) regardless of whether the
4932 @option{-fpic} or @option{-fPIC} options are used. In other
4933 respects, this target is the same as the
4934 @uref{#xtensa*-*-elf,,@samp{xtensa*-*-elf}} target.
4940 @heading Microsoft Windows
4942 @subheading Intel 16-bit versions
4943 The 16-bit versions of Microsoft Windows, such as Windows 3.1, are not
4946 However, the 32-bit port has limited support for Microsoft
4947 Windows 3.11 in the Win32s environment, as a target only. See below.
4949 @subheading Intel 32-bit versions
4950 The 32-bit versions of Windows, including Windows 95, Windows NT, Windows
4951 XP, and Windows Vista, are supported by several different target
4952 platforms. These targets differ in which Windows subsystem they target
4953 and which C libraries are used.
4956 @item Cygwin @uref{#x-x-cygwin,,*-*-cygwin}: Cygwin provides a user-space
4957 Linux API emulation layer in the Win32 subsystem.
4958 @item MinGW @uref{#x-x-mingw32,,*-*-mingw32}: MinGW is a native GCC port for
4959 the Win32 subsystem that provides a subset of POSIX.
4960 @item MKS i386-pc-mks: NuTCracker from MKS. See
4961 @uref{https://www.mkssoftware.com} for more information.
4964 @subheading Intel 64-bit versions
4965 GCC contains support for x86-64 using the mingw-w64
4966 runtime library, available from @uref{http://mingw-w64.org/doku.php}.
4967 This library should be used with the target triple x86_64-pc-mingw32.
4969 Presently Windows for Itanium is not supported.
4971 @subheading Windows CE
4972 Windows CE is supported as a target only on Hitachi
4973 SuperH (sh-wince-pe), and MIPS (mips-wince-pe).
4975 @subheading Other Windows Platforms
4976 GCC no longer supports Windows NT on the Alpha or PowerPC.
4978 GCC no longer supports the Windows POSIX subsystem. However, it does
4979 support the Interix subsystem. See above.
4981 Old target names including *-*-winnt and *-*-windowsnt are no longer used.
4983 PW32 (i386-pc-pw32) support was never completed, and the project seems to
4984 be inactive. See @uref{http://pw32.sourceforge.net/} for more information.
4986 UWIN support has been removed due to a lack of maintenance.
4993 Ports of GCC are included with the
4994 @uref{http://www.cygwin.com/,,Cygwin environment}.
4996 GCC will build under Cygwin without modification; it does not build
4997 with Microsoft's C++ compiler and there are no plans to make it do so.
4999 The Cygwin native compiler can be configured to target any 32-bit x86
5000 cpu architecture desired; the default is i686-pc-cygwin. It should be
5001 used with as up-to-date a version of binutils as possible; use either
5002 the latest official GNU binutils release in the Cygwin distribution,
5003 or version 2.20 or above if building your own.
5008 @anchor{x-x-mingw32}
5009 @heading *-*-mingw32
5010 GCC will build with and support only MinGW runtime 3.12 and later.
5011 Earlier versions of headers are incompatible with the new default semantics
5012 of @code{extern inline} in @code{-std=c99} and @code{-std=gnu99} modes.
5018 @heading Older systems
5019 GCC contains support files for many older (1980s and early
5020 1990s) Unix variants. For the most part, support for these systems
5021 has not been deliberately removed, but it has not been maintained for
5022 several years and may suffer from bitrot.
5024 Starting with GCC 3.1, each release has a list of ``obsoleted'' systems.
5025 Support for these systems is still present in that release, but
5026 @command{configure} will fail unless the @option{--enable-obsolete}
5027 option is given. Unless a maintainer steps forward, support for these
5028 systems will be removed from the next release of GCC@.
5030 Support for old systems as hosts for GCC can cause problems if the
5031 workarounds for compiler, library and operating system bugs affect the
5032 cleanliness or maintainability of the rest of GCC@. In some cases, to
5033 bring GCC up on such a system, if still possible with current GCC, may
5034 require first installing an old version of GCC which did work on that
5035 system, and using it to compile a more recent GCC, to avoid bugs in the
5036 vendor compiler. Old releases of GCC 1 and GCC 2 are available in the
5037 @file{old-releases} directory on the @uref{../mirrors.html,,GCC mirror
5038 sites}. Header bugs may generally be avoided using
5039 @command{fixincludes}, but bugs or deficiencies in libraries and the
5040 operating system may still cause problems.
5042 Support for older systems as targets for cross-compilation is less
5043 problematic than support for them as hosts for GCC; if an enthusiast
5044 wishes to make such a target work again (including resurrecting any of
5045 the targets that never worked with GCC 2, starting from the last
5046 version before they were removed), patches
5047 @uref{../contribute.html,,following the usual requirements} would be
5048 likely to be accepted, since they should not affect the support for more
5051 For some systems, old versions of GNU binutils may also be useful,
5052 and are available from @file{pub/binutils/old-releases} on
5053 @uref{https://sourceware.org/mirrors.html,,sourceware.org mirror sites}.
5055 Some of the information on specific systems above relates to
5056 such older systems, but much of the information
5057 about GCC on such systems (which may no longer be applicable to
5058 current GCC) is to be found in the GCC texinfo manual.
5064 @heading all ELF targets (SVR4, Solaris 2, etc.)
5065 C++ support is significantly better on ELF targets if you use the
5066 @uref{./configure.html#with-gnu-ld,,GNU linker}; duplicate copies of
5067 inlines, vtables and template instantiations will be discarded
5076 @uref{./index.html,,Return to the GCC Installation page}
5080 @c ***Old documentation******************************************************
5082 @include install-old.texi
5088 @uref{./index.html,,Return to the GCC Installation page}
5092 @c ***GFDL********************************************************************
5100 @uref{./index.html,,Return to the GCC Installation page}
5104 @c ***************************************************************************
5105 @c Part 6 The End of the Document
5107 @comment node-name, next, previous, up
5108 @node Concept Index, , GNU Free Documentation License, Top
5112 @unnumbered Concept Index