2018-06-22 Paul Thomas <pault@gcc.gnu.org>
[official-gcc.git] / gcc / doc / install.texi
blob7c5cdc762d3ecca2b37c1ebc8caf99d22ff351b9
1 \input texinfo.tex    @c -*-texinfo-*-
2 @c @ifnothtml
3 @c %**start of header
4 @setfilename gccinstall.info
5 @settitle Installing GCC
6 @setchapternewpage odd
7 @c %**end of header
8 @c @end ifnothtml
10 @include gcc-common.texi
12 @c Specify title for specific html page
13 @ifset indexhtml
14 @settitle Installing GCC
15 @end ifset
16 @ifset specifichtml
17 @settitle Host/Target specific installation notes for GCC
18 @end ifset
19 @ifset prerequisiteshtml
20 @settitle Prerequisites for GCC
21 @end ifset
22 @ifset downloadhtml
23 @settitle Downloading GCC
24 @end ifset
25 @ifset configurehtml
26 @settitle Installing GCC: Configuration
27 @end ifset
28 @ifset buildhtml
29 @settitle Installing GCC: Building
30 @end ifset
31 @ifset testhtml
32 @settitle Installing GCC: Testing
33 @end ifset
34 @ifset finalinstallhtml
35 @settitle Installing GCC: Final installation
36 @end ifset
37 @ifset binarieshtml
38 @settitle Installing GCC: Binaries
39 @end ifset
40 @ifset oldhtml
41 @settitle Installing GCC: Old documentation
42 @end ifset
43 @ifset gfdlhtml
44 @settitle Installing GCC: GNU Free Documentation License
45 @end ifset
47 @c Copyright (C) 1988-2018 Free Software Foundation, Inc.
48 @c *** Converted to texinfo by Dean Wakerley, dean@wakerley.com
50 @c IMPORTANT: whenever you modify this file, run `install.texi2html' to
51 @c test the generation of HTML documents for the gcc.gnu.org web pages.
53 @c Do not use @footnote{} in this file as it breaks install.texi2html!
55 @c Include everything if we're not making html
56 @ifnothtml
57 @set indexhtml
58 @set specifichtml
59 @set prerequisiteshtml
60 @set downloadhtml
61 @set configurehtml
62 @set buildhtml
63 @set testhtml
64 @set finalinstallhtml
65 @set binarieshtml
66 @set oldhtml
67 @set gfdlhtml
68 @end ifnothtml
70 @c Part 2 Summary Description and Copyright
71 @copying
72 Copyright @copyright{} 1988-2018 Free Software Foundation, Inc.
73 @sp 1
74 Permission is granted to copy, distribute and/or modify this document
75 under the terms of the GNU Free Documentation License, Version 1.3 or
76 any later version published by the Free Software Foundation; with no
77 Invariant Sections, the Front-Cover texts being (a) (see below), and
78 with the Back-Cover Texts being (b) (see below).  A copy of the
79 license is included in the section entitled ``@uref{./gfdl.html,,GNU
80 Free Documentation License}''.
82 (a) The FSF's Front-Cover Text is:
84      A GNU Manual
86 (b) The FSF's Back-Cover Text is:
88      You have freedom to copy and modify this GNU Manual, like GNU
89      software.  Copies published by the Free Software Foundation raise
90      funds for GNU development.
91 @end copying
92 @ifinfo
93 @insertcopying
94 @end ifinfo
95 @dircategory Software development
96 @direntry
97 * gccinstall: (gccinstall).    Installing the GNU Compiler Collection.
98 @end direntry
100 @c Part 3 Titlepage and Copyright
101 @titlepage
102 @title Installing GCC
103 @versionsubtitle
105 @c The following two commands start the copyright page.
106 @page
107 @vskip 0pt plus 1filll
108 @insertcopying
109 @end titlepage
111 @c Part 4 Top node, Master Menu, and/or Table of Contents
112 @ifinfo
113 @node    Top, , , (dir)
114 @comment node-name, next,          Previous, up
116 @menu
117 * Installing GCC::  This document describes the generic installation
118                     procedure for GCC as well as detailing some target
119                     specific installation instructions.
121 * Specific::        Host/target specific installation notes for GCC.
122 * Binaries::        Where to get pre-compiled binaries.
124 * Old::             Old installation documentation.
126 * GNU Free Documentation License:: How you can copy and share this manual.
127 * Concept Index::   This index has two entries.
128 @end menu
129 @end ifinfo
131 @iftex
132 @contents
133 @end iftex
135 @c Part 5 The Body of the Document
136 @c ***Installing GCC**********************************************************
137 @ifnothtml
138 @comment node-name,     next,          previous, up
139 @node    Installing GCC, Binaries, , Top
140 @end ifnothtml
141 @ifset indexhtml
142 @ifnothtml
143 @chapter Installing GCC
144 @end ifnothtml
146 The latest version of this document is always available at
147 @uref{http://gcc.gnu.org/install/,,http://gcc.gnu.org/install/}.
148 It refers to the current development sources, instructions for
149 specific released versions are included with the sources.
151 This document describes the generic installation procedure for GCC as well
152 as detailing some target specific installation instructions.
154 GCC includes several components that previously were separate distributions
155 with their own installation instructions.  This document supersedes all
156 package-specific installation instructions.
158 @emph{Before} starting the build/install procedure please check the
159 @ifnothtml
160 @ref{Specific, host/target specific installation notes}.
161 @end ifnothtml
162 @ifhtml
163 @uref{specific.html,,host/target specific installation notes}.
164 @end ifhtml
165 We recommend you browse the entire generic installation instructions before
166 you proceed.
168 Lists of successful builds for released versions of GCC are
169 available at @uref{http://gcc.gnu.org/buildstat.html}.
170 These lists are updated as new information becomes available.
172 The installation procedure itself is broken into five steps.
174 @ifinfo
175 @menu
176 * Prerequisites::
177 * Downloading the source::
178 * Configuration::
179 * Building::
180 * Testing:: (optional)
181 * Final install::
182 @end menu
183 @end ifinfo
184 @ifhtml
185 @enumerate
186 @item
187 @uref{prerequisites.html,,Prerequisites}
188 @item
189 @uref{download.html,,Downloading the source}
190 @item
191 @uref{configure.html,,Configuration}
192 @item
193 @uref{build.html,,Building}
194 @item
195 @uref{test.html,,Testing} (optional)
196 @item
197 @uref{finalinstall.html,,Final install}
198 @end enumerate
199 @end ifhtml
201 Please note that GCC does not support @samp{make uninstall} and probably
202 won't do so in the near future as this would open a can of worms.  Instead,
203 we suggest that you install GCC into a directory of its own and simply
204 remove that directory when you do not need that specific version of GCC
205 any longer, and, if shared libraries are installed there as well, no
206 more binaries exist that use them.
208 @ifhtml
209 There are also some @uref{old.html,,old installation instructions},
210 which are mostly obsolete but still contain some information which has
211 not yet been merged into the main part of this manual.
212 @end ifhtml
214 @html
215 <hr />
217 @end html
218 @ifhtml
219 @uref{./index.html,,Return to the GCC Installation page}
221 @insertcopying
222 @end ifhtml
223 @end ifset
225 @c ***Prerequisites**************************************************
226 @ifnothtml
227 @comment node-name,     next,          previous, up
228 @node    Prerequisites, Downloading the source, , Installing GCC
229 @end ifnothtml
230 @ifset prerequisiteshtml
231 @ifnothtml
232 @chapter Prerequisites
233 @end ifnothtml
234 @cindex Prerequisites
236 GCC requires that various tools and packages be available for use in the
237 build procedure.  Modifying GCC sources requires additional tools
238 described below.
240 @heading Tools/packages necessary for building GCC
241 @table @asis
242 @item ISO C++98 compiler
243 Necessary to bootstrap GCC, although versions of GCC prior
244 to 4.8 also allow bootstrapping with a ISO C89 compiler and versions
245 of GCC prior to 3.4 also allow bootstrapping with a traditional
246 (K&R) C compiler.
248 To build all languages in a cross-compiler or other configuration where
249 3-stage bootstrap is not performed, you need to start with an existing
250 GCC binary (version 3.4 or later) because source code for language
251 frontends other than C might use GCC extensions.
253 Note that to bootstrap GCC with versions of GCC earlier than 3.4, you
254 may need to use @option{--disable-stage1-checking}, though
255 bootstrapping the compiler with such earlier compilers is strongly
256 discouraged.
258 @item C standard library and headers
260 In order to build GCC, the C standard library and headers must be present
261 for all target variants for which target libraries will be built (and not
262 only the variant of the host C++ compiler).
264 This affects the popular @samp{x86_64-unknown-linux-gnu} platform (among
265 other multilib targets), for which 64-bit (@samp{x86_64}) and 32-bit
266 (@samp{i386}) libc headers are usually packaged separately. If you do a
267 build of a native compiler on @samp{x86_64-unknown-linux-gnu}, make sure you
268 either have the 32-bit libc developer package properly installed (the exact
269 name of the package depends on your distro) or you must build GCC as a
270 64-bit only compiler by configuring with the option
271 @option{--disable-multilib}.  Otherwise, you may encounter an error such as
272 @samp{fatal error: gnu/stubs-32.h: No such file}
274 @item GNAT
276 In order to build the Ada compiler (GNAT) you must already have GNAT
277 installed because portions of the Ada frontend are written in Ada (with
278 GNAT extensions.)  Refer to the Ada installation instructions for more
279 specific information.
281 @item A ``working'' POSIX compatible shell, or GNU bash
283 Necessary when running @command{configure} because some
284 @command{/bin/sh} shells have bugs and may crash when configuring the
285 target libraries.  In other cases, @command{/bin/sh} or @command{ksh}
286 have disastrous corner-case performance problems.  This
287 can cause target @command{configure} runs to literally take days to
288 complete in some cases.
290 So on some platforms @command{/bin/ksh} is sufficient, on others it
291 isn't.  See the host/target specific instructions for your platform, or
292 use @command{bash} to be sure.  Then set @env{CONFIG_SHELL} in your
293 environment to your ``good'' shell prior to running
294 @command{configure}/@command{make}.
296 @command{zsh} is not a fully compliant POSIX shell and will not
297 work when configuring GCC@.
299 @item A POSIX or SVR4 awk
301 Necessary for creating some of the generated source files for GCC@.
302 If in doubt, use a recent GNU awk version, as some of the older ones
303 are broken.  GNU awk version 3.1.5 is known to work.
305 @item GNU binutils
307 Necessary in some circumstances, optional in others.  See the
308 host/target specific instructions for your platform for the exact
309 requirements.
311 @item gzip version 1.2.4 (or later) or
312 @itemx bzip2 version 1.0.2 (or later)
314 Necessary to uncompress GCC @command{tar} files when source code is
315 obtained via FTP mirror sites.
317 @item GNU make version 3.80 (or later)
319 You must have GNU make installed to build GCC@.
321 @item GNU tar version 1.14 (or later)
323 Necessary (only on some platforms) to untar the source code.  Many
324 systems' @command{tar} programs will also work, only try GNU
325 @command{tar} if you have problems.
327 @item Perl version between 5.6.1 and 5.6.24
329 Necessary when targeting Darwin, building @samp{libstdc++},
330 and not using @option{--disable-symvers}.
331 Necessary when targeting Solaris 2 with Sun @command{ld} and not using
332 @option{--disable-symvers}.  The bundled @command{perl} in Solaris@tie{}8
333 and up works.
335 Necessary when regenerating @file{Makefile} dependencies in libiberty.
336 Necessary when regenerating @file{libiberty/functions.texi}.
337 Necessary when generating manpages from Texinfo manuals.
338 Used by various scripts to generate some files included in SVN (mainly
339 Unicode-related and rarely changing) from source tables.
341 Used by @command{automake}.
343 @end table
345 Several support libraries are necessary to build GCC, some are required,
346 others optional.  While any sufficiently new version of required tools
347 usually work, library requirements are generally stricter.  Newer
348 versions may work in some cases, but it's safer to use the exact
349 versions documented.  We appreciate bug reports about problems with
350 newer versions, though.  If your OS vendor provides packages for the
351 support libraries then using those packages may be the simplest way to
352 install the libraries.
354 @table @asis
355 @item GNU Multiple Precision Library (GMP) version 4.3.2 (or later)
357 Necessary to build GCC@.  If a GMP source distribution is found in a
358 subdirectory of your GCC sources named @file{gmp}, it will be built
359 together with GCC.  Alternatively, if GMP is already installed but it
360 is not in your library search path, you will have to configure with the
361 @option{--with-gmp} configure option.  See also @option{--with-gmp-lib}
362 and @option{--with-gmp-include}.
363 The in-tree build is only supported with the GMP version that
364 download_prerequisites installs.
366 @item MPFR Library version 2.4.2 (or later)
368 Necessary to build GCC@.  It can be downloaded from
369 @uref{http://www.mpfr.org/}.  If an MPFR source distribution is found
370 in a subdirectory of your GCC sources named @file{mpfr}, it will be
371 built together with GCC.  Alternatively, if MPFR is already installed
372 but it is not in your default library search path, the
373 @option{--with-mpfr} configure option should be used.  See also
374 @option{--with-mpfr-lib} and @option{--with-mpfr-include}.
375 The in-tree build is only supported with the MPFR version that
376 download_prerequisites installs.
378 @item MPC Library version 0.8.1 (or later)
380 Necessary to build GCC@.  It can be downloaded from
381 @uref{http://www.multiprecision.org/}.  If an MPC source distribution
382 is found in a subdirectory of your GCC sources named @file{mpc}, it
383 will be built together with GCC.  Alternatively, if MPC is already
384 installed but it is not in your default library search path, the
385 @option{--with-mpc} configure option should be used.  See also
386 @option{--with-mpc-lib} and @option{--with-mpc-include}.
387 The in-tree build is only supported with the MPC version that
388 download_prerequisites installs.
390 @item isl Library version 0.15 or later.
392 Necessary to build GCC with the Graphite loop optimizations.
393 It can be downloaded from @uref{ftp://gcc.gnu.org/pub/gcc/infrastructure/}.
394 If an isl source distribution is found
395 in a subdirectory of your GCC sources named @file{isl}, it will be
396 built together with GCC.  Alternatively, the @option{--with-isl} configure
397 option should be used if isl is not installed in your default library
398 search path.
400 @end table
402 @heading Tools/packages necessary for modifying GCC
403 @table @asis
404 @item autoconf version 2.64
405 @itemx GNU m4 version 1.4.6 (or later)
407 Necessary when modifying @file{configure.ac}, @file{aclocal.m4}, etc.@:
408 to regenerate @file{configure} and @file{config.in} files.
410 @item automake version 1.11.6
412 Necessary when modifying a @file{Makefile.am} file to regenerate its
413 associated @file{Makefile.in}.
415 Much of GCC does not use automake, so directly edit the @file{Makefile.in}
416 file.  Specifically this applies to the @file{gcc}, @file{intl},
417 @file{libcpp}, @file{libiberty}, @file{libobjc} directories as well
418 as any of their subdirectories.
420 For directories that use automake, GCC requires the latest release in
421 the 1.11 series, which is currently 1.11.6.  When regenerating a directory
422 to a newer version, please update all the directories using an older 1.11
423 to the latest released version.
425 Note that @command{automake} 1.11.6 is incompatible with
426 @command{perl} version 5.6.26.
428 @item gettext version 0.14.5 (or later)
430 Needed to regenerate @file{gcc.pot}.
432 @item gperf version 2.7.2 (or later)
434 Necessary when modifying @command{gperf} input files, e.g.@:
435 @file{gcc/cp/cfns.gperf} to regenerate its associated header file, e.g.@:
436 @file{gcc/cp/cfns.h}.
438 @item DejaGnu 1.4.4
439 @itemx Expect
440 @itemx Tcl
442 Necessary to run the GCC testsuite; see the section on testing for
443 details.  Tcl 8.6 has a known regression in RE pattern handling that
444 make parts of the testsuite fail.  See
445 @uref{http://core.tcl.tk/tcl/tktview/267b7e2334ee2e9de34c4b00d6e72e2f1997085f}
446 for more information.  This bug has been fixed in 8.6.1.
448 @item autogen version 5.5.4 (or later) and
449 @itemx guile version 1.4.1 (or later)
451 Necessary to regenerate @file{fixinc/fixincl.x} from
452 @file{fixinc/inclhack.def} and @file{fixinc/*.tpl}.
454 Necessary to run @samp{make check} for @file{fixinc}.
456 Necessary to regenerate the top level @file{Makefile.in} file from
457 @file{Makefile.tpl} and @file{Makefile.def}.
459 @item Flex version 2.5.4 (or later)
461 Necessary when modifying @file{*.l} files.
463 Necessary to build GCC during development because the generated output
464 files are not included in the SVN repository.  They are included in
465 releases.
467 @item Texinfo version 4.7 (or later)
469 Necessary for running @command{makeinfo} when modifying @file{*.texi}
470 files to test your changes.
472 Necessary for running @command{make dvi} or @command{make pdf} to
473 create printable documentation in DVI or PDF format.  Texinfo version
474 4.8 or later is required for @command{make pdf}.
476 Necessary to build GCC documentation during development because the
477 generated output files are not included in the SVN repository.  They are
478 included in releases.
480 @item @TeX{} (any working version)
482 Necessary for running @command{texi2dvi} and @command{texi2pdf}, which
483 are used when running @command{make dvi} or @command{make pdf} to create
484 DVI or PDF files, respectively.
486 @item Sphinx version 1.0 (or later)
488 Necessary to regenerate @file{jit/docs/_build/texinfo} from the @file{.rst}
489 files in the directories below @file{jit/docs}.
491 @item SVN (any version)
492 @itemx SSH (any version)
494 Necessary to access the SVN repository.  Public releases and weekly
495 snapshots of the development sources are also available via FTP@.
497 @item GNU diffutils version 2.7 (or later)
499 Useful when submitting patches for the GCC source code.
501 @item patch version 2.5.4 (or later)
503 Necessary when applying patches, created with @command{diff}, to one's
504 own sources.
506 @end table
508 @html
509 <hr />
511 @end html
512 @ifhtml
513 @uref{./index.html,,Return to the GCC Installation page}
514 @end ifhtml
515 @end ifset
517 @c ***Downloading the source**************************************************
518 @ifnothtml
519 @comment node-name,     next,          previous, up
520 @node    Downloading the source, Configuration, Prerequisites, Installing GCC
521 @end ifnothtml
522 @ifset downloadhtml
523 @ifnothtml
524 @chapter Downloading GCC
525 @end ifnothtml
526 @cindex Downloading GCC
527 @cindex Downloading the Source
529 GCC is distributed via @uref{http://gcc.gnu.org/svn.html,,SVN} and FTP
530 tarballs compressed with @command{gzip} or
531 @command{bzip2}.
533 Please refer to the @uref{http://gcc.gnu.org/releases.html,,releases web page}
534 for information on how to obtain GCC@.
536 The source distribution includes the C, C++, Objective-C, Fortran,
537 and Ada (in the case of GCC 3.1 and later) compilers, as well as
538 runtime libraries for C++, Objective-C, and Fortran.
539 For previous versions these were downloadable as separate components such
540 as the core GCC distribution, which included the C language front end and
541 shared components, and language-specific distributions including the
542 language front end and the language runtime (where appropriate).
544 If you also intend to build binutils (either to upgrade an existing
545 installation or for use in place of the corresponding tools of your
546 OS), unpack the binutils distribution either in the same directory or
547 a separate one.  In the latter case, add symbolic links to any
548 components of the binutils you intend to build alongside the compiler
549 (@file{bfd}, @file{binutils}, @file{gas}, @file{gprof}, @file{ld},
550 @file{opcodes}, @dots{}) to the directory containing the GCC sources.
552 Likewise the GMP, MPFR and MPC libraries can be automatically built
553 together with GCC.  You may simply run the
554 @command{contrib/download_prerequisites} script in the GCC source directory
555 to set up everything.
556 Otherwise unpack the GMP, MPFR and/or MPC source
557 distributions in the directory containing the GCC sources and rename
558 their directories to @file{gmp}, @file{mpfr} and @file{mpc},
559 respectively (or use symbolic links with the same name).
561 @html
562 <hr />
564 @end html
565 @ifhtml
566 @uref{./index.html,,Return to the GCC Installation page}
567 @end ifhtml
568 @end ifset
570 @c ***Configuration***********************************************************
571 @ifnothtml
572 @comment node-name,     next,          previous, up
573 @node    Configuration, Building, Downloading the source, Installing GCC
574 @end ifnothtml
575 @ifset configurehtml
576 @ifnothtml
577 @chapter Installing GCC: Configuration
578 @end ifnothtml
579 @cindex Configuration
580 @cindex Installing GCC: Configuration
582 Like most GNU software, GCC must be configured before it can be built.
583 This document describes the recommended configuration procedure
584 for both native and cross targets.
586 We use @var{srcdir} to refer to the toplevel source directory for
587 GCC; we use @var{objdir} to refer to the toplevel build/object directory.
589 If you obtained the sources via SVN, @var{srcdir} must refer to the top
590 @file{gcc} directory, the one where the @file{MAINTAINERS} file can be
591 found, and not its @file{gcc} subdirectory, otherwise the build will fail.
593 If either @var{srcdir} or @var{objdir} is located on an automounted NFS
594 file system, the shell's built-in @command{pwd} command will return
595 temporary pathnames.  Using these can lead to various sorts of build
596 problems.  To avoid this issue, set the @env{PWDCMD} environment
597 variable to an automounter-aware @command{pwd} command, e.g.,
598 @command{pawd} or @samp{amq -w}, during the configuration and build
599 phases.
601 First, we @strong{highly} recommend that GCC be built into a
602 separate directory from the sources which does @strong{not} reside
603 within the source tree.  This is how we generally build GCC; building
604 where @var{srcdir} == @var{objdir} should still work, but doesn't
605 get extensive testing; building where @var{objdir} is a subdirectory
606 of @var{srcdir} is unsupported.
608 If you have previously built GCC in the same directory for a
609 different target machine, do @samp{make distclean} to delete all files
610 that might be invalid.  One of the files this deletes is @file{Makefile};
611 if @samp{make distclean} complains that @file{Makefile} does not exist
612 or issues a message like ``don't know how to make distclean'' it probably
613 means that the directory is already suitably clean.  However, with the
614 recommended method of building in a separate @var{objdir}, you should
615 simply use a different @var{objdir} for each target.
617 Second, when configuring a native system, either @command{cc} or
618 @command{gcc} must be in your path or you must set @env{CC} in
619 your environment before running configure.  Otherwise the configuration
620 scripts may fail.
622 @ignore
623 Note that the bootstrap compiler and the resulting GCC must be link
624 compatible, else the bootstrap will fail with linker errors about
625 incompatible object file formats.  Several multilibed targets are
626 affected by this requirement, see
627 @ifnothtml
628 @ref{Specific, host/target specific installation notes}.
629 @end ifnothtml
630 @ifhtml
631 @uref{specific.html,,host/target specific installation notes}.
632 @end ifhtml
633 @end ignore
635 To configure GCC:
637 @smallexample
638 % mkdir @var{objdir}
639 % cd @var{objdir}
640 % @var{srcdir}/configure [@var{options}] [@var{target}]
641 @end smallexample
643 @heading Distributor options
645 If you will be distributing binary versions of GCC, with modifications
646 to the source code, you should use the options described in this
647 section to make clear that your version contains modifications.
649 @table @code
650 @item --with-pkgversion=@var{version}
651 Specify a string that identifies your package.  You may wish
652 to include a build number or build date.  This version string will be
653 included in the output of @command{gcc --version}.  This suffix does
654 not replace the default version string, only the @samp{GCC} part.
656 The default value is @samp{GCC}.
658 @item --with-bugurl=@var{url}
659 Specify the URL that users should visit if they wish to report a bug.
660 You are of course welcome to forward bugs reported to you to the FSF,
661 if you determine that they are not bugs in your modifications.
663 The default value refers to the FSF's GCC bug tracker.
665 @end table
667 @heading Target specification
668 @itemize @bullet
669 @item
670 GCC has code to correctly determine the correct value for @var{target}
671 for nearly all native systems.  Therefore, we highly recommend you do
672 not provide a configure target when configuring a native compiler.
674 @item
675 @var{target} must be specified as @option{--target=@var{target}}
676 when configuring a cross compiler; examples of valid targets would be
677 m68k-elf, sh-elf, etc.
679 @item
680 Specifying just @var{target} instead of @option{--target=@var{target}}
681 implies that the host defaults to @var{target}.
682 @end itemize
685 @heading Options specification
687 Use @var{options} to override several configure time options for
688 GCC@.  A list of supported @var{options} follows; @samp{configure
689 --help} may list other options, but those not listed below may not
690 work and should not normally be used.
692 Note that each @option{--enable} option has a corresponding
693 @option{--disable} option and that each @option{--with} option has a
694 corresponding @option{--without} option.
696 @table @code
697 @item --prefix=@var{dirname}
698 Specify the toplevel installation
699 directory.  This is the recommended way to install the tools into a directory
700 other than the default.  The toplevel installation directory defaults to
701 @file{/usr/local}.
703 We @strong{highly} recommend against @var{dirname} being the same or a
704 subdirectory of @var{objdir} or vice versa.  If specifying a directory
705 beneath a user's home directory tree, some shells will not expand
706 @var{dirname} correctly if it contains the @samp{~} metacharacter; use
707 @env{$HOME} instead.
709 The following standard @command{autoconf} options are supported.  Normally you
710 should not need to use these options.
711 @table @code
712 @item --exec-prefix=@var{dirname}
713 Specify the toplevel installation directory for architecture-dependent
714 files.  The default is @file{@var{prefix}}.
716 @item --bindir=@var{dirname}
717 Specify the installation directory for the executables called by users
718 (such as @command{gcc} and @command{g++}).  The default is
719 @file{@var{exec-prefix}/bin}.
721 @item --libdir=@var{dirname}
722 Specify the installation directory for object code libraries and
723 internal data files of GCC@.  The default is @file{@var{exec-prefix}/lib}.
725 @item --libexecdir=@var{dirname}
726 Specify the installation directory for internal executables of GCC@.
727 The default is @file{@var{exec-prefix}/libexec}.
729 @item --with-slibdir=@var{dirname}
730 Specify the installation directory for the shared libgcc library.  The
731 default is @file{@var{libdir}}.
733 @item --datarootdir=@var{dirname}
734 Specify the root of the directory tree for read-only architecture-independent
735 data files referenced by GCC@.  The default is @file{@var{prefix}/share}.
737 @item --infodir=@var{dirname}
738 Specify the installation directory for documentation in info format.
739 The default is @file{@var{datarootdir}/info}.
741 @item --datadir=@var{dirname}
742 Specify the installation directory for some architecture-independent
743 data files referenced by GCC@.  The default is @file{@var{datarootdir}}.
745 @item --docdir=@var{dirname}
746 Specify the installation directory for documentation files (other
747 than Info) for GCC@.  The default is @file{@var{datarootdir}/doc}.
749 @item --htmldir=@var{dirname}
750 Specify the installation directory for HTML documentation files.
751 The default is @file{@var{docdir}}.
753 @item --pdfdir=@var{dirname}
754 Specify the installation directory for PDF documentation files.
755 The default is @file{@var{docdir}}.
757 @item --mandir=@var{dirname}
758 Specify the installation directory for manual pages.  The default is
759 @file{@var{datarootdir}/man}.  (Note that the manual pages are only extracts
760 from the full GCC manuals, which are provided in Texinfo format.  The manpages
761 are derived by an automatic conversion process from parts of the full
762 manual.)
764 @item --with-gxx-include-dir=@var{dirname}
765 Specify
766 the installation directory for G++ header files.  The default depends
767 on other configuration options, and differs between cross and native
768 configurations.
770 @item --with-specs=@var{specs}
771 Specify additional command line driver SPECS.
772 This can be useful if you need to turn on a non-standard feature by
773 default without modifying the compiler's source code, for instance
774 @option{--with-specs=%@{!fcommon:%@{!fno-common:-fno-common@}@}}.
775 @ifnothtml
776 @xref{Spec Files,, Specifying subprocesses and the switches to pass to them,
777 gcc, Using the GNU Compiler Collection (GCC)},
778 @end ifnothtml
779 @ifhtml
780 See ``Spec Files'' in the main manual
781 @end ifhtml
783 @end table
785 @item --program-prefix=@var{prefix}
786 GCC supports some transformations of the names of its programs when
787 installing them.  This option prepends @var{prefix} to the names of
788 programs to install in @var{bindir} (see above).  For example, specifying
789 @option{--program-prefix=foo-} would result in @samp{gcc}
790 being installed as @file{/usr/local/bin/foo-gcc}.
792 @item --program-suffix=@var{suffix}
793 Appends @var{suffix} to the names of programs to install in @var{bindir}
794 (see above).  For example, specifying @option{--program-suffix=-3.1}
795 would result in @samp{gcc} being installed as
796 @file{/usr/local/bin/gcc-3.1}.
798 @item --program-transform-name=@var{pattern}
799 Applies the @samp{sed} script @var{pattern} to be applied to the names
800 of programs to install in @var{bindir} (see above).  @var{pattern} has to
801 consist of one or more basic @samp{sed} editing commands, separated by
802 semicolons.  For example, if you want the @samp{gcc} program name to be
803 transformed to the installed program @file{/usr/local/bin/myowngcc} and
804 the @samp{g++} program name to be transformed to
805 @file{/usr/local/bin/gspecial++} without changing other program names,
806 you could use the pattern
807 @option{--program-transform-name='s/^gcc$/myowngcc/; s/^g++$/gspecial++/'}
808 to achieve this effect.
810 All three options can be combined and used together, resulting in more
811 complex conversion patterns.  As a basic rule, @var{prefix} (and
812 @var{suffix}) are prepended (appended) before further transformations
813 can happen with a special transformation script @var{pattern}.
815 As currently implemented, this option only takes effect for native
816 builds; cross compiler binaries' names are not transformed even when a
817 transformation is explicitly asked for by one of these options.
819 For native builds, some of the installed programs are also installed
820 with the target alias in front of their name, as in
821 @samp{i686-pc-linux-gnu-gcc}.  All of the above transformations happen
822 before the target alias is prepended to the name---so, specifying
823 @option{--program-prefix=foo-} and @option{program-suffix=-3.1}, the
824 resulting binary would be installed as
825 @file{/usr/local/bin/i686-pc-linux-gnu-foo-gcc-3.1}.
827 As a last shortcoming, none of the installed Ada programs are
828 transformed yet, which will be fixed in some time.
830 @item --with-local-prefix=@var{dirname}
831 Specify the
832 installation directory for local include files.  The default is
833 @file{/usr/local}.  Specify this option if you want the compiler to
834 search directory @file{@var{dirname}/include} for locally installed
835 header files @emph{instead} of @file{/usr/local/include}.
837 You should specify @option{--with-local-prefix} @strong{only} if your
838 site has a different convention (not @file{/usr/local}) for where to put
839 site-specific files.
841 The default value for @option{--with-local-prefix} is @file{/usr/local}
842 regardless of the value of @option{--prefix}.  Specifying
843 @option{--prefix} has no effect on which directory GCC searches for
844 local header files.  This may seem counterintuitive, but actually it is
845 logical.
847 The purpose of @option{--prefix} is to specify where to @emph{install
848 GCC}.  The local header files in @file{/usr/local/include}---if you put
849 any in that directory---are not part of GCC@.  They are part of other
850 programs---perhaps many others.  (GCC installs its own header files in
851 another directory which is based on the @option{--prefix} value.)
853 Both the local-prefix include directory and the GCC-prefix include
854 directory are part of GCC's ``system include'' directories.  Although these
855 two directories are not fixed, they need to be searched in the proper
856 order for the correct processing of the include_next directive.  The
857 local-prefix include directory is searched before the GCC-prefix
858 include directory.  Another characteristic of system include directories
859 is that pedantic warnings are turned off for headers in these directories.
861 Some autoconf macros add @option{-I @var{directory}} options to the
862 compiler command line, to ensure that directories containing installed
863 packages' headers are searched.  When @var{directory} is one of GCC's
864 system include directories, GCC will ignore the option so that system
865 directories continue to be processed in the correct order.  This
866 may result in a search order different from what was specified but the
867 directory will still be searched.
869 GCC automatically searches for ordinary libraries using
870 @env{GCC_EXEC_PREFIX}.  Thus, when the same installation prefix is
871 used for both GCC and packages, GCC will automatically search for
872 both headers and libraries.  This provides a configuration that is
873 easy to use.  GCC behaves in a manner similar to that when it is
874 installed as a system compiler in @file{/usr}.
876 Sites that need to install multiple versions of GCC may not want to
877 use the above simple configuration.  It is possible to use the
878 @option{--program-prefix}, @option{--program-suffix} and
879 @option{--program-transform-name} options to install multiple versions
880 into a single directory, but it may be simpler to use different prefixes
881 and the @option{--with-local-prefix} option to specify the location of the
882 site-specific files for each version.  It will then be necessary for
883 users to specify explicitly the location of local site libraries
884 (e.g., with @env{LIBRARY_PATH}).
886 The same value can be used for both @option{--with-local-prefix} and
887 @option{--prefix} provided it is not @file{/usr}.  This can be used
888 to avoid the default search of @file{/usr/local/include}.
890 @strong{Do not} specify @file{/usr} as the @option{--with-local-prefix}!
891 The directory you use for @option{--with-local-prefix} @strong{must not}
892 contain any of the system's standard header files.  If it did contain
893 them, certain programs would be miscompiled (including GNU Emacs, on
894 certain targets), because this would override and nullify the header
895 file corrections made by the @command{fixincludes} script.
897 Indications are that people who use this option use it based on mistaken
898 ideas of what it is for.  People use it as if it specified where to
899 install part of GCC@.  Perhaps they make this assumption because
900 installing GCC creates the directory.
902 @item --with-gcc-major-version-only
903 Specifies that GCC should use only the major number rather than
904 @var{major}.@var{minor}.@var{patchlevel} in filesystem paths.
906 @item --with-native-system-header-dir=@var{dirname}
907 Specifies that @var{dirname} is the directory that contains native system
908 header files, rather than @file{/usr/include}.  This option is most useful
909 if you are creating a compiler that should be isolated from the system
910 as much as possible.  It is most commonly used with the
911 @option{--with-sysroot} option and will cause GCC to search
912 @var{dirname} inside the system root specified by that option.
914 @item --enable-shared[=@var{package}[,@dots{}]]
915 Build shared versions of libraries, if shared libraries are supported on
916 the target platform.  Unlike GCC 2.95.x and earlier, shared libraries
917 are enabled by default on all platforms that support shared libraries.
919 If a list of packages is given as an argument, build shared libraries
920 only for the listed packages.  For other packages, only static libraries
921 will be built.  Package names currently recognized in the GCC tree are
922 @samp{libgcc} (also known as @samp{gcc}), @samp{libstdc++} (not
923 @samp{libstdc++-v3}), @samp{libffi}, @samp{zlib}, @samp{boehm-gc},
924 @samp{ada}, @samp{libada}, @samp{libgo}, and @samp{libobjc}.
925 Note @samp{libiberty} does not support shared libraries at all.
927 Use @option{--disable-shared} to build only static libraries.  Note that
928 @option{--disable-shared} does not accept a list of package names as
929 argument, only @option{--enable-shared} does.
931 Contrast with @option{--enable-host-shared}, which affects @emph{host}
932 code.
934 @item --enable-host-shared
935 Specify that the @emph{host} code should be built into position-independent
936 machine code (with -fPIC), allowing it to be used within shared libraries,
937 but yielding a slightly slower compiler.
939 This option is required when building the libgccjit.so library.
941 Contrast with @option{--enable-shared}, which affects @emph{target}
942 libraries.
944 @item @anchor{with-gnu-as}--with-gnu-as
945 Specify that the compiler should assume that the
946 assembler it finds is the GNU assembler.  However, this does not modify
947 the rules to find an assembler and will result in confusion if the
948 assembler found is not actually the GNU assembler.  (Confusion may also
949 result if the compiler finds the GNU assembler but has not been
950 configured with @option{--with-gnu-as}.)  If you have more than one
951 assembler installed on your system, you may want to use this option in
952 connection with @option{--with-as=@var{pathname}} or
953 @option{--with-build-time-tools=@var{pathname}}.
955 The following systems are the only ones where it makes a difference
956 whether you use the GNU assembler.  On any other system,
957 @option{--with-gnu-as} has no effect.
959 @itemize @bullet
960 @item @samp{hppa1.0-@var{any}-@var{any}}
961 @item @samp{hppa1.1-@var{any}-@var{any}}
962 @item @samp{sparc-sun-solaris2.@var{any}}
963 @item @samp{sparc64-@var{any}-solaris2.@var{any}}
964 @end itemize
966 @item @anchor{with-as}--with-as=@var{pathname}
967 Specify that the compiler should use the assembler pointed to by
968 @var{pathname}, rather than the one found by the standard rules to find
969 an assembler, which are:
970 @itemize @bullet
971 @item
972 Unless GCC is being built with a cross compiler, check the
973 @file{@var{libexec}/gcc/@var{target}/@var{version}} directory.
974 @var{libexec} defaults to @file{@var{exec-prefix}/libexec};
975 @var{exec-prefix} defaults to @var{prefix}, which
976 defaults to @file{/usr/local} unless overridden by the
977 @option{--prefix=@var{pathname}} switch described above.  @var{target}
978 is the target system triple, such as @samp{sparc-sun-solaris2.7}, and
979 @var{version} denotes the GCC version, such as 3.0.
981 @item
982 If the target system is the same that you are building on, check
983 operating system specific directories (e.g.@: @file{/usr/ccs/bin} on
984 Sun Solaris 2).
986 @item
987 Check in the @env{PATH} for a tool whose name is prefixed by the
988 target system triple.
990 @item
991 Check in the @env{PATH} for a tool whose name is not prefixed by the
992 target system triple, if the host and target system triple are
993 the same (in other words, we use a host tool if it can be used for
994 the target as well).
995 @end itemize
997 You may want to use @option{--with-as} if no assembler
998 is installed in the directories listed above, or if you have multiple
999 assemblers installed and want to choose one that is not found by the
1000 above rules.
1002 @item @anchor{with-gnu-ld}--with-gnu-ld
1003 Same as @uref{#with-gnu-as,,@option{--with-gnu-as}}
1004 but for the linker.
1006 @item --with-ld=@var{pathname}
1007 Same as @uref{#with-as,,@option{--with-as}}
1008 but for the linker.
1010 @item --with-stabs
1011 Specify that stabs debugging
1012 information should be used instead of whatever format the host normally
1013 uses.  Normally GCC uses the same debug format as the host system.
1015 @item --with-tls=@var{dialect}
1016 Specify the default TLS dialect, for systems were there is a choice.
1017 For ARM targets, possible values for @var{dialect} are @code{gnu} or
1018 @code{gnu2}, which select between the original GNU dialect and the GNU TLS
1019 descriptor-based dialect.
1021 @item --enable-multiarch
1022 Specify whether to enable or disable multiarch support.  The default is
1023 to check for glibc start files in a multiarch location, and enable it
1024 if the files are found.  The auto detection is enabled for native builds,
1025 and for cross builds configured with @option{--with-sysroot}, and without
1026 @option{--with-native-system-header-dir}.
1027 More documentation about multiarch can be found at
1028 @uref{https://wiki.debian.org/Multiarch}.
1030 @item --enable-sjlj-exceptions
1031 Force use of the @code{setjmp}/@code{longjmp}-based scheme for exceptions.
1032 @samp{configure} ordinarily picks the correct value based on the platform.
1033 Only use this option if you are sure you need a different setting.
1035 @item --enable-vtable-verify
1036 Specify whether to enable or disable the vtable verification feature.
1037 Enabling this feature causes libstdc++ to be built with its virtual calls
1038 in verifiable mode.  This means that, when linked with libvtv, every
1039 virtual call in libstdc++ will verify the vtable pointer through which the
1040 call will be made before actually making the call.  If not linked with libvtv,
1041 the verifier will call stub functions (in libstdc++ itself) and do nothing.
1042 If vtable verification is disabled, then libstdc++ is not built with its
1043 virtual calls in verifiable mode at all.  However the libvtv library will
1044 still be built (see @option{--disable-libvtv} to turn off building libvtv).
1045 @option{--disable-vtable-verify} is the default.
1047 @item --disable-multilib
1048 Specify that multiple target
1049 libraries to support different target variants, calling
1050 conventions, etc.@: should not be built.  The default is to build a
1051 predefined set of them.
1053 Some targets provide finer-grained control over which multilibs are built
1054 (e.g., @option{--disable-softfloat}):
1055 @table @code
1056 @item arm-*-*
1057 fpu, 26bit, underscore, interwork, biendian, nofmult.
1059 @item m68*-*-*
1060 softfloat, m68881, m68000, m68020.
1062 @item mips*-*-*
1063 single-float, biendian, softfloat.
1065 @item powerpc*-*-*, rs6000*-*-*
1066 aix64, pthread, softfloat, powercpu, powerpccpu, powerpcos, biendian,
1067 sysv, aix.
1069 @end table
1071 @item --with-multilib-list=@var{list}
1072 @itemx --without-multilib-list
1073 Specify what multilibs to build.  @var{list} is a comma separated list of
1074 values, possibly consisting of a single value.  Currently only implemented
1075 for arm*-*-*, riscv*-*-*, sh*-*-* and x86-64-*-linux*.  The accepted
1076 values and meaning for each target is given below.
1078 @table @code
1079 @item arm*-*-*
1080 @var{list} is a comma separated list of @code{aprofile} and @code{rmprofile}
1081 to build multilibs for A or R and M architecture profiles respectively.  Note
1082 that, due to some limitation of the current multilib framework, using the
1083 combined @code{aprofile,rmprofile} multilibs selects in some cases a less
1084 optimal multilib than when using the multilib profile for the architecture
1085 targetted.  The special value @code{default} is also accepted and is equivalent
1086 to omitting the option, ie. only the default run-time library will be enabled.
1088 The table below gives the combination of ISAs, architectures, FPUs and
1089 floating-point ABIs for which multilibs are built for each accepted value.
1090 The union of these options is considered when specifying both @code{aprofile}
1091 and @code{rmprofile}.
1093 @multitable @columnfractions .15 .28 .30
1094 @item Option @tab aprofile @tab rmprofile
1095 @item ISAs
1096 @tab @code{-marm} and @code{-mthumb}
1097 @tab @code{-mthumb}
1098 @item Architectures@*@*@*@*@*@*
1099 @tab default architecture@*
1100 @code{-march=armv7-a}@*
1101 @code{-march=armv7ve}@*
1102 @code{-march=armv8-a}@*@*@*
1103 @tab default architecture@*
1104 @code{-march=armv6s-m}@*
1105 @code{-march=armv7-m}@*
1106 @code{-march=armv7e-m}@*
1107 @code{-march=armv8-m.base}@*
1108 @code{-march=armv8-m.main}@*
1109 @code{-march=armv7}
1110 @item FPUs@*@*@*@*@*
1111 @tab none@*
1112 @code{-mfpu=vfpv3-d16}@*
1113 @code{-mfpu=neon}@*
1114 @code{-mfpu=vfpv4-d16}@*
1115 @code{-mfpu=neon-vfpv4}@*
1116 @code{-mfpu=neon-fp-armv8}
1117 @tab none@*
1118 @code{-mfpu=vfpv3-d16}@*
1119 @code{-mfpu=fpv4-sp-d16}@*
1120 @code{-mfpu=fpv5-sp-d16}@*
1121 @code{-mfpu=fpv5-d16}@*
1122 @item floating-point@/ ABIs@*@*
1123 @tab @code{-mfloat-abi=soft}@*
1124 @code{-mfloat-abi=softfp}@*
1125 @code{-mfloat-abi=hard}
1126 @tab @code{-mfloat-abi=soft}@*
1127 @code{-mfloat-abi=softfp}@*
1128 @code{-mfloat-abi=hard}
1129 @end multitable
1131 @item riscv*-*-*
1132 @var{list} is a single ABI name.  The target architecture must be either
1133 @code{rv32gc} or @code{rv64gc}.  This will build a single multilib for the
1134 specified architecture and ABI pair.  If @code{--with-multilib-list} is not
1135 given, then a default set of multilibs is selected based on the value of
1136 @option{--target}.  This is usually a large set of multilibs.
1138 @item sh*-*-*
1139 @var{list} is a comma separated list of CPU names.  These must be of the
1140 form @code{sh*} or @code{m*} (in which case they match the compiler option
1141 for that processor).  The list should not contain any endian options -
1142 these are handled by @option{--with-endian}.
1144 If @var{list} is empty, then there will be no multilibs for extra
1145 processors.  The multilib for the secondary endian remains enabled.
1147 As a special case, if an entry in the list starts with a @code{!}
1148 (exclamation point), then it is added to the list of excluded multilibs.
1149 Entries of this sort should be compatible with @samp{MULTILIB_EXCLUDES}
1150 (once the leading @code{!} has been stripped).
1152 If @option{--with-multilib-list} is not given, then a default set of
1153 multilibs is selected based on the value of @option{--target}.  This is
1154 usually the complete set of libraries, but some targets imply a more
1155 specialized subset.
1157 Example 1: to configure a compiler for SH4A only, but supporting both
1158 endians, with little endian being the default:
1159 @smallexample
1160 --with-cpu=sh4a --with-endian=little,big --with-multilib-list=
1161 @end smallexample
1163 Example 2: to configure a compiler for both SH4A and SH4AL-DSP, but with
1164 only little endian SH4AL:
1165 @smallexample
1166 --with-cpu=sh4a --with-endian=little,big \
1167 --with-multilib-list=sh4al,!mb/m4al
1168 @end smallexample
1170 @item x86-64-*-linux*
1171 @var{list} is a comma separated list of @code{m32}, @code{m64} and
1172 @code{mx32} to enable 32-bit, 64-bit and x32 run-time libraries,
1173 respectively.  If @var{list} is empty, then there will be no multilibs
1174 and only the default run-time library will be enabled.
1176 If @option{--with-multilib-list} is not given, then only 32-bit and
1177 64-bit run-time libraries will be enabled.
1178 @end table
1180 @item --with-endian=@var{endians}
1181 Specify what endians to use.
1182 Currently only implemented for sh*-*-*.
1184 @var{endians} may be one of the following:
1185 @table @code
1186 @item big
1187 Use big endian exclusively.
1188 @item little
1189 Use little endian exclusively.
1190 @item big,little
1191 Use big endian by default.  Provide a multilib for little endian.
1192 @item little,big
1193 Use little endian by default.  Provide a multilib for big endian.
1194 @end table
1196 @item --enable-threads
1197 Specify that the target
1198 supports threads.  This affects the Objective-C compiler and runtime
1199 library, and exception handling for other languages like C++.
1200 On some systems, this is the default.
1202 In general, the best (and, in many cases, the only known) threading
1203 model available will be configured for use.  Beware that on some
1204 systems, GCC has not been taught what threading models are generally
1205 available for the system.  In this case, @option{--enable-threads} is an
1206 alias for @option{--enable-threads=single}.
1208 @item --disable-threads
1209 Specify that threading support should be disabled for the system.
1210 This is an alias for @option{--enable-threads=single}.
1212 @item --enable-threads=@var{lib}
1213 Specify that
1214 @var{lib} is the thread support library.  This affects the Objective-C
1215 compiler and runtime library, and exception handling for other languages
1216 like C++.  The possibilities for @var{lib} are:
1218 @table @code
1219 @item aix
1220 AIX thread support.
1221 @item dce
1222 DCE thread support.
1223 @item lynx
1224 LynxOS thread support.
1225 @item mipssde
1226 MIPS SDE thread support.
1227 @item no
1228 This is an alias for @samp{single}.
1229 @item posix
1230 Generic POSIX/Unix98 thread support.
1231 @item rtems
1232 RTEMS thread support.
1233 @item single
1234 Disable thread support, should work for all platforms.
1235 @item tpf
1236 TPF thread support.
1237 @item vxworks
1238 VxWorks thread support.
1239 @item win32
1240 Microsoft Win32 API thread support.
1241 @end table
1243 @item --enable-tls
1244 Specify that the target supports TLS (Thread Local Storage).  Usually
1245 configure can correctly determine if TLS is supported.  In cases where
1246 it guesses incorrectly, TLS can be explicitly enabled or disabled with
1247 @option{--enable-tls} or @option{--disable-tls}.  This can happen if
1248 the assembler supports TLS but the C library does not, or if the
1249 assumptions made by the configure test are incorrect.
1251 @item --disable-tls
1252 Specify that the target does not support TLS.
1253 This is an alias for @option{--enable-tls=no}.
1255 @item --with-cpu=@var{cpu}
1256 @itemx --with-cpu-32=@var{cpu}
1257 @itemx --with-cpu-64=@var{cpu}
1258 Specify which cpu variant the compiler should generate code for by default.
1259 @var{cpu} will be used as the default value of the @option{-mcpu=} switch.
1260 This option is only supported on some targets, including ARC, ARM, i386, M68k,
1261 PowerPC, and SPARC@.  It is mandatory for ARC@.  The @option{--with-cpu-32} and
1262 @option{--with-cpu-64} options specify separate default CPUs for
1263 32-bit and 64-bit modes; these options are only supported for i386,
1264 x86-64, PowerPC, and SPARC@.
1266 @item --with-schedule=@var{cpu}
1267 @itemx --with-arch=@var{cpu}
1268 @itemx --with-arch-32=@var{cpu}
1269 @itemx --with-arch-64=@var{cpu}
1270 @itemx --with-tune=@var{cpu}
1271 @itemx --with-tune-32=@var{cpu}
1272 @itemx --with-tune-64=@var{cpu}
1273 @itemx --with-abi=@var{abi}
1274 @itemx --with-fpu=@var{type}
1275 @itemx --with-float=@var{type}
1276 These configure options provide default values for the @option{-mschedule=},
1277 @option{-march=}, @option{-mtune=}, @option{-mabi=}, and @option{-mfpu=}
1278 options and for @option{-mhard-float} or @option{-msoft-float}.  As with
1279 @option{--with-cpu}, which switches will be accepted and acceptable values
1280 of the arguments depend on the target.
1282 @item --with-mode=@var{mode}
1283 Specify if the compiler should default to @option{-marm} or @option{-mthumb}.
1284 This option is only supported on ARM targets.
1286 @item --with-stack-offset=@var{num}
1287 This option sets the default for the -mstack-offset=@var{num} option,
1288 and will thus generally also control the setting of this option for
1289 libraries.  This option is only supported on Epiphany targets.
1291 @item --with-fpmath=@var{isa}
1292 This options sets @option{-mfpmath=sse} by default and specifies the default
1293 ISA for floating-point arithmetics.  You can select either @samp{sse} which
1294 enables @option{-msse2} or @samp{avx} which enables @option{-mavx} by default.
1295 This option is only supported on i386 and x86-64 targets.
1297 @item --with-fp-32=@var{mode}
1298 On MIPS targets, set the default value for the @option{-mfp} option when using
1299 the o32 ABI.  The possibilities for @var{mode} are:
1300 @table @code
1301 @item 32
1302 Use the o32 FP32 ABI extension, as with the @option{-mfp32} command-line
1303 option.
1304 @item xx
1305 Use the o32 FPXX ABI extension, as with the @option{-mfpxx} command-line
1306 option.
1307 @item 64
1308 Use the o32 FP64 ABI extension, as with the @option{-mfp64} command-line
1309 option.
1310 @end table
1311 In the absence of this configuration option the default is to use the o32
1312 FP32 ABI extension.
1314 @item --with-odd-spreg-32
1315 On MIPS targets, set the @option{-modd-spreg} option by default when using
1316 the o32 ABI.
1318 @item --without-odd-spreg-32
1319 On MIPS targets, set the @option{-mno-odd-spreg} option by default when using
1320 the o32 ABI.  This is normally used in conjunction with
1321 @option{--with-fp-32=64} in order to target the o32 FP64A ABI extension.
1323 @item --with-nan=@var{encoding}
1324 On MIPS targets, set the default encoding convention to use for the
1325 special not-a-number (NaN) IEEE 754 floating-point data.  The
1326 possibilities for @var{encoding} are:
1327 @table @code
1328 @item legacy
1329 Use the legacy encoding, as with the @option{-mnan=legacy} command-line
1330 option.
1331 @item 2008
1332 Use the 754-2008 encoding, as with the @option{-mnan=2008} command-line
1333 option.
1334 @end table
1335 To use this configuration option you must have an assembler version
1336 installed that supports the @option{-mnan=} command-line option too.
1337 In the absence of this configuration option the default convention is
1338 the legacy encoding, as when neither of the @option{-mnan=2008} and
1339 @option{-mnan=legacy} command-line options has been used.
1341 @item --with-divide=@var{type}
1342 Specify how the compiler should generate code for checking for
1343 division by zero.  This option is only supported on the MIPS target.
1344 The possibilities for @var{type} are:
1345 @table @code
1346 @item traps
1347 Division by zero checks use conditional traps (this is the default on
1348 systems that support conditional traps).
1349 @item breaks
1350 Division by zero checks use the break instruction.
1351 @end table
1353 @c If you make --with-llsc the default for additional targets,
1354 @c update the --with-llsc description in the MIPS section below.
1356 @item --with-llsc
1357 On MIPS targets, make @option{-mllsc} the default when no
1358 @option{-mno-llsc} option is passed.  This is the default for
1359 Linux-based targets, as the kernel will emulate them if the ISA does
1360 not provide them.
1362 @item --without-llsc
1363 On MIPS targets, make @option{-mno-llsc} the default when no
1364 @option{-mllsc} option is passed.
1366 @item --with-synci
1367 On MIPS targets, make @option{-msynci} the default when no
1368 @option{-mno-synci} option is passed.
1370 @item --without-synci
1371 On MIPS targets, make @option{-mno-synci} the default when no
1372 @option{-msynci} option is passed.  This is the default.
1374 @item --with-lxc1-sxc1
1375 On MIPS targets, make @option{-mlxc1-sxc1} the default when no
1376 @option{-mno-lxc1-sxc1} option is passed.  This is the default.
1378 @item --without-lxc1-sxc1
1379 On MIPS targets, make @option{-mno-lxc1-sxc1} the default when no
1380 @option{-mlxc1-sxc1} option is passed.  The indexed load/store
1381 instructions are not directly a problem but can lead to unexpected
1382 behaviour when deployed in an application intended for a 32-bit address
1383 space but run on a 64-bit processor.  The issue is seen because all
1384 known MIPS 64-bit Linux kernels execute o32 and n32 applications
1385 with 64-bit addressing enabled which affects the overflow behaviour
1386 of the indexed addressing mode.  GCC will assume that ordinary
1387 32-bit arithmetic overflow behaviour is the same whether performed
1388 as an @code{addu} instruction or as part of the address calculation
1389 in @code{lwxc1} type instructions.  This assumption holds true in a
1390 pure 32-bit environment and can hold true in a 64-bit environment if
1391 the address space is accurately set to be 32-bit for o32 and n32.
1393 @item --with-madd4
1394 On MIPS targets, make @option{-mmadd4} the default when no
1395 @option{-mno-madd4} option is passed.  This is the default.
1397 @item --without-madd4
1398 On MIPS targets, make @option{-mno-madd4} the default when no
1399 @option{-mmadd4} option is passed.  The @code{madd4} instruction
1400 family can be problematic when targeting a combination of cores that
1401 implement these instructions differently.  There are two known cores
1402 that implement these as fused operations instead of unfused (where
1403 unfused is normally expected).  Disabling these instructions is the
1404 only way to ensure compatible code is generated; this will incur
1405 a performance penalty.
1407 @item --with-mips-plt
1408 On MIPS targets, make use of copy relocations and PLTs.
1409 These features are extensions to the traditional
1410 SVR4-based MIPS ABIs and require support from GNU binutils
1411 and the runtime C library.
1413 @item --enable-__cxa_atexit
1414 Define if you want to use __cxa_atexit, rather than atexit, to
1415 register C++ destructors for local statics and global objects.
1416 This is essential for fully standards-compliant handling of
1417 destructors, but requires __cxa_atexit in libc.  This option is currently
1418 only available on systems with GNU libc.  When enabled, this will cause
1419 @option{-fuse-cxa-atexit} to be passed by default.
1421 @item --enable-gnu-indirect-function
1422 Define if you want to enable the @code{ifunc} attribute.  This option is
1423 currently only available on systems with GNU libc on certain targets.
1425 @item --enable-target-optspace
1426 Specify that target
1427 libraries should be optimized for code space instead of code speed.
1428 This is the default for the m32r platform.
1430 @item --with-cpp-install-dir=@var{dirname}
1431 Specify that the user visible @command{cpp} program should be installed
1432 in @file{@var{prefix}/@var{dirname}/cpp}, in addition to @var{bindir}.
1434 @item --enable-comdat
1435 Enable COMDAT group support.  This is primarily used to override the
1436 automatically detected value.
1438 @item --enable-initfini-array
1439 Force the use of sections @code{.init_array} and @code{.fini_array}
1440 (instead of @code{.init} and @code{.fini}) for constructors and
1441 destructors.  Option @option{--disable-initfini-array} has the
1442 opposite effect.  If neither option is specified, the configure script
1443 will try to guess whether the @code{.init_array} and
1444 @code{.fini_array} sections are supported and, if they are, use them.
1446 @item --enable-link-mutex
1447 When building GCC, use a mutex to avoid linking the compilers for
1448 multiple languages at the same time, to avoid thrashing on build
1449 systems with limited free memory.  The default is not to use such a mutex.
1451 @item --enable-maintainer-mode
1452 The build rules that regenerate the Autoconf and Automake output files as
1453 well as the GCC master message catalog @file{gcc.pot} are normally
1454 disabled.  This is because it can only be rebuilt if the complete source
1455 tree is present.  If you have changed the sources and want to rebuild the
1456 catalog, configuring with @option{--enable-maintainer-mode} will enable
1457 this.  Note that you need a recent version of the @code{gettext} tools
1458 to do so.
1460 @item --disable-bootstrap
1461 For a native build, the default configuration is to perform
1462 a 3-stage bootstrap of the compiler when @samp{make} is invoked,
1463 testing that GCC can compile itself correctly.  If you want to disable
1464 this process, you can configure with @option{--disable-bootstrap}.
1466 @item --enable-bootstrap
1467 In special cases, you may want to perform a 3-stage build
1468 even if the target and host triplets are different.
1469 This is possible when the host can run code compiled for
1470 the target (e.g.@: host is i686-linux, target is i486-linux).
1471 Starting from GCC 4.2, to do this you have to configure explicitly
1472 with @option{--enable-bootstrap}.
1474 @item --enable-generated-files-in-srcdir
1475 Neither the .c and .h files that are generated from Bison and flex nor the
1476 info manuals and man pages that are built from the .texi files are present
1477 in the SVN development tree.  When building GCC from that development tree,
1478 or from one of our snapshots, those generated files are placed in your
1479 build directory, which allows for the source to be in a readonly
1480 directory.
1482 If you configure with @option{--enable-generated-files-in-srcdir} then those
1483 generated files will go into the source directory.  This is mainly intended
1484 for generating release or prerelease tarballs of the GCC sources, since it
1485 is not a requirement that the users of source releases to have flex, Bison,
1486 or makeinfo.
1488 @item --enable-version-specific-runtime-libs
1489 Specify
1490 that runtime libraries should be installed in the compiler specific
1491 subdirectory (@file{@var{libdir}/gcc}) rather than the usual places.  In
1492 addition, @samp{libstdc++}'s include files will be installed into
1493 @file{@var{libdir}} unless you overruled it by using
1494 @option{--with-gxx-include-dir=@var{dirname}}.  Using this option is
1495 particularly useful if you intend to use several versions of GCC in
1496 parallel.  This is currently supported by @samp{libgfortran},
1497 @samp{libstdc++}, and @samp{libobjc}.
1499 @item @anchor{WithAixSoname}--with-aix-soname=@samp{aix}, @samp{svr4} or @samp{both}
1500 Traditional AIX shared library versioning (versioned @code{Shared Object}
1501 files as members of unversioned @code{Archive Library} files named
1502 @samp{lib.a}) causes numerous headaches for package managers. However,
1503 @code{Import Files} as members of @code{Archive Library} files allow for
1504 @strong{filename-based versioning} of shared libraries as seen on Linux/SVR4,
1505 where this is called the "SONAME". But as they prevent static linking,
1506 @code{Import Files} may be used with @code{Runtime Linking} only, where the
1507 linker does search for @samp{libNAME.so} before @samp{libNAME.a} library
1508 filenames with the @samp{-lNAME} linker flag.
1510 @anchor{AixLdCommand}For detailed information please refer to the AIX
1511 @uref{https://www.ibm.com/support/knowledgecenter/search/%22the%20ld%20command%2C%20also%20called%20the%20linkage%20editor%20or%20binder%22,,ld
1512 Command} reference.
1514 As long as shared library creation is enabled, upon:
1515 @table @code
1516 @item --with-aix-soname=aix
1517 @item --with-aix-soname=both
1518  A (traditional AIX) @code{Shared Archive Library} file is created:
1519  @itemize @bullet
1520   @item using the @samp{libNAME.a} filename scheme
1521   @item with the @code{Shared Object} file as archive member named
1522   @samp{libNAME.so.V} (except for @samp{libgcc_s}, where the @code{Shared
1523   Object} file is named @samp{shr.o} for backwards compatibility), which
1524   @itemize @minus
1525    @item is used for runtime loading from inside the @samp{libNAME.a} file
1526    @item is used for dynamic loading via
1527    @code{dlopen("libNAME.a(libNAME.so.V)", RTLD_MEMBER)}
1528    @item is used for shared linking
1529    @item is used for static linking, so no separate @code{Static Archive
1530    Library} file is needed
1531   @end itemize
1532  @end itemize
1533 @item --with-aix-soname=both
1534 @item --with-aix-soname=svr4
1535  A (second) @code{Shared Archive Library} file is created:
1536  @itemize @bullet
1537  @item using the @samp{libNAME.so.V} filename scheme
1538  @item with the @code{Shared Object} file as archive member named
1539  @samp{shr.o}, which
1540   @itemize @minus
1541    @item is created with the @code{-G linker flag}
1542    @item has the @code{F_LOADONLY} flag set
1543    @item is used for runtime loading from inside the @samp{libNAME.so.V} file
1544    @item is used for dynamic loading via @code{dlopen("libNAME.so.V(shr.o)",
1545    RTLD_MEMBER)}
1546   @end itemize
1547  @item with the @code{Import File} as archive member named @samp{shr.imp},
1548  which
1549   @itemize @minus
1550    @item refers to @samp{libNAME.so.V(shr.o)} as the "SONAME", to be recorded
1551    in the @code{Loader Section} of subsequent binaries
1552    @item indicates whether @samp{libNAME.so.V(shr.o)} is 32 or 64 bit
1553    @item lists all the public symbols exported by @samp{lib.so.V(shr.o)},
1554    eventually decorated with the @code{@samp{weak} Keyword}
1555    @item is necessary for shared linking against @samp{lib.so.V(shr.o)}
1556    @end itemize
1557   @end itemize
1558   A symbolic link using the @samp{libNAME.so} filename scheme is created:
1559   @itemize @bullet
1560   @item pointing to the @samp{libNAME.so.V} @code{Shared Archive Library} file
1561   @item to permit the @code{ld Command} to find @samp{lib.so.V(shr.imp)} via
1562   the @samp{-lNAME} argument (requires @code{Runtime Linking} to be enabled)
1563   @item to permit dynamic loading of @samp{lib.so.V(shr.o)} without the need
1564   to specify the version number via @code{dlopen("libNAME.so(shr.o)",
1565   RTLD_MEMBER)}
1566   @end itemize
1567 @end table
1569 As long as static library creation is enabled, upon:
1570 @table @code
1571 @item --with-aix-soname=svr4
1572  A @code{Static Archive Library} is created:
1573  @itemize @bullet
1574  @item using the @samp{libNAME.a} filename scheme
1575  @item with all the @code{Static Object} files as archive members, which
1576   @itemize @minus
1577    @item are used for static linking
1578   @end itemize
1579  @end itemize
1580 @end table
1582 While the aix-soname=@samp{svr4} option does not create @code{Shared Object}
1583 files as members of unversioned @code{Archive Library} files any more, package
1584 managers still are responsible to
1585 @uref{./specific.html#TransferAixShobj,,transfer} @code{Shared Object} files
1586 found as member of a previously installed unversioned @code{Archive Library}
1587 file into the newly installed @code{Archive Library} file with the same
1588 filename.
1590 @emph{WARNING:} Creating @code{Shared Object} files with @code{Runtime Linking}
1591 enabled may bloat the TOC, eventually leading to @code{TOC overflow} errors,
1592 requiring the use of either the @option{-Wl,-bbigtoc} linker flag (seen to
1593 break with the @code{GDB} debugger) or some of the TOC-related compiler flags,
1594 @ifnothtml
1595 @xref{RS/6000 and PowerPC Options,, RS/6000 and PowerPC Options, gcc,
1596 Using the GNU Compiler Collection (GCC)}.
1597 @end ifnothtml
1598 @ifhtml
1599 see ``RS/6000 and PowerPC Options'' in the main manual.
1600 @end ifhtml
1602 @option{--with-aix-soname} is currently supported by @samp{libgcc_s} only, so
1603 this option is still experimental and not for normal use yet.
1605 Default is the traditional behavior @option{--with-aix-soname=@samp{aix}}.
1607 @item --enable-languages=@var{lang1},@var{lang2},@dots{}
1608 Specify that only a particular subset of compilers and
1609 their runtime libraries should be built.  For a list of valid values for
1610 @var{langN} you can issue the following command in the
1611 @file{gcc} directory of your GCC source tree:@*
1612 @smallexample
1613 grep ^language= */config-lang.in
1614 @end smallexample
1615 Currently, you can use any of the following:
1616 @code{all}, @code{default}, @code{ada}, @code{c}, @code{c++}, @code{fortran},
1617 @code{go}, @code{jit}, @code{lto}, @code{objc}, @code{obj-c++}.
1618 Building the Ada compiler has special requirements, see below.
1619 If you do not pass this flag, or specify the option @code{default}, then the
1620 default languages available in the @file{gcc} sub-tree will be configured.
1621 Ada, Go, Jit, and Objective-C++ are not default languages.  LTO is not a
1622 default language, but is built by default because @option{--enable-lto} is
1623 enabled by default.  The other languages are default languages.  If
1624 @code{all} is specified, then all available languages are built.  An
1625 exception is @code{jit} language, which requires
1626 @option{--enable-host-shared} to be included with @code{all}.
1628 @item --enable-stage1-languages=@var{lang1},@var{lang2},@dots{}
1629 Specify that a particular subset of compilers and their runtime
1630 libraries should be built with the system C compiler during stage 1 of
1631 the bootstrap process, rather than only in later stages with the
1632 bootstrapped C compiler.  The list of valid values is the same as for
1633 @option{--enable-languages}, and the option @code{all} will select all
1634 of the languages enabled by @option{--enable-languages}.  This option is
1635 primarily useful for GCC development; for instance, when a development
1636 version of the compiler cannot bootstrap due to compiler bugs, or when
1637 one is debugging front ends other than the C front end.  When this
1638 option is used, one can then build the target libraries for the
1639 specified languages with the stage-1 compiler by using @command{make
1640 stage1-bubble all-target}, or run the testsuite on the stage-1 compiler
1641 for the specified languages using @command{make stage1-start check-gcc}.
1643 @item --disable-libada
1644 Specify that the run-time libraries and tools used by GNAT should not
1645 be built.  This can be useful for debugging, or for compatibility with
1646 previous Ada build procedures, when it was required to explicitly
1647 do a @samp{make -C gcc gnatlib_and_tools}.
1649 @item --disable-libsanitizer
1650 Specify that the run-time libraries for the various sanitizers should
1651 not be built.
1653 @item --disable-libssp
1654 Specify that the run-time libraries for stack smashing protection
1655 should not be built or linked against.  On many targets library support
1656 is provided by the C library instead.
1658 @item --disable-libquadmath
1659 Specify that the GCC quad-precision math library should not be built.
1660 On some systems, the library is required to be linkable when building
1661 the Fortran front end, unless @option{--disable-libquadmath-support}
1662 is used.
1664 @item --disable-libquadmath-support
1665 Specify that the Fortran front end and @code{libgfortran} do not add
1666 support for @code{libquadmath} on systems supporting it.
1668 @item --disable-libgomp
1669 Specify that the GNU Offloading and Multi Processing Runtime Library
1670 should not be built.
1672 @item --disable-libvtv
1673 Specify that the run-time libraries used by vtable verification
1674 should not be built.
1676 @item --with-dwarf2
1677 Specify that the compiler should
1678 use DWARF 2 debugging information as the default.
1680 @item --with-advance-toolchain=@var{at}
1681 On 64-bit PowerPC Linux systems, configure the compiler to use the
1682 header files, library files, and the dynamic linker from the Advance
1683 Toolchain release @var{at} instead of the default versions that are
1684 provided by the Linux distribution.  In general, this option is
1685 intended for the developers of GCC, and it is not intended for general
1686 use.
1688 @item --enable-targets=all
1689 @itemx --enable-targets=@var{target_list}
1690 Some GCC targets, e.g.@: powerpc64-linux, build bi-arch compilers.
1691 These are compilers that are able to generate either 64-bit or 32-bit
1692 code.  Typically, the corresponding 32-bit target, e.g.@:
1693 powerpc-linux for powerpc64-linux, only generates 32-bit code.  This
1694 option enables the 32-bit target to be a bi-arch compiler, which is
1695 useful when you want a bi-arch compiler that defaults to 32-bit, and
1696 you are building a bi-arch or multi-arch binutils in a combined tree.
1697 On mips-linux, this will build a tri-arch compiler (ABI o32/n32/64),
1698 defaulted to o32.
1699 Currently, this option only affects sparc-linux, powerpc-linux, x86-linux,
1700 mips-linux and s390-linux.
1702 @item --enable-default-pie
1703 Turn on @option{-fPIE} and @option{-pie} by default.
1705 @item --enable-secureplt
1706 This option enables @option{-msecure-plt} by default for powerpc-linux.
1707 @ifnothtml
1708 @xref{RS/6000 and PowerPC Options,, RS/6000 and PowerPC Options, gcc,
1709 Using the GNU Compiler Collection (GCC)},
1710 @end ifnothtml
1711 @ifhtml
1712 See ``RS/6000 and PowerPC Options'' in the main manual
1713 @end ifhtml
1715 @item --enable-default-ssp
1716 Turn on @option{-fstack-protector-strong} by default.
1718 @item --enable-cld
1719 This option enables @option{-mcld} by default for 32-bit x86 targets.
1720 @ifnothtml
1721 @xref{i386 and x86-64 Options,, i386 and x86-64 Options, gcc,
1722 Using the GNU Compiler Collection (GCC)},
1723 @end ifnothtml
1724 @ifhtml
1725 See ``i386 and x86-64 Options'' in the main manual
1726 @end ifhtml
1728 @item --enable-win32-registry
1729 @itemx --enable-win32-registry=@var{key}
1730 @itemx --disable-win32-registry
1731 The @option{--enable-win32-registry} option enables Microsoft Windows-hosted GCC
1732 to look up installations paths in the registry using the following key:
1734 @smallexample
1735 @code{HKEY_LOCAL_MACHINE\SOFTWARE\Free Software Foundation\@var{key}}
1736 @end smallexample
1738 @var{key} defaults to GCC version number, and can be overridden by the
1739 @option{--enable-win32-registry=@var{key}} option.  Vendors and distributors
1740 who use custom installers are encouraged to provide a different key,
1741 perhaps one comprised of vendor name and GCC version number, to
1742 avoid conflict with existing installations.  This feature is enabled
1743 by default, and can be disabled by @option{--disable-win32-registry}
1744 option.  This option has no effect on the other hosts.
1746 @item --nfp
1747 Specify that the machine does not have a floating point unit.  This
1748 option only applies to @samp{m68k-sun-sunos@var{n}}.  On any other
1749 system, @option{--nfp} has no effect.
1751 @item --enable-werror
1752 @itemx --disable-werror
1753 @itemx --enable-werror=yes
1754 @itemx --enable-werror=no
1755 When you specify this option, it controls whether certain files in the
1756 compiler are built with @option{-Werror} in bootstrap stage2 and later.
1757 If you don't specify it, @option{-Werror} is turned on for the main
1758 development trunk.  However it defaults to off for release branches and
1759 final releases.  The specific files which get @option{-Werror} are
1760 controlled by the Makefiles.
1762 @item --enable-checking
1763 @itemx --enable-checking=@var{list}
1764 When you specify this option, the compiler is built to perform internal
1765 consistency checks of the requested complexity.  This does not change the
1766 generated code, but adds error checking within the compiler.  This will
1767 slow down the compiler and may only work properly if you are building
1768 the compiler with GCC@.  This is @samp{yes,extra} by default when building
1769 from SVN or snapshots, but @samp{release} for releases.  The default
1770 for building the stage1 compiler is @samp{yes}.  More control
1771 over the checks may be had by specifying @var{list}.  The categories of
1772 checks available are @samp{yes} (most common checks
1773 @samp{assert,misc,tree,gc,rtlflag,runtime}), @samp{no} (no checks at
1774 all), @samp{all} (all but @samp{valgrind}), @samp{release} (cheapest
1775 checks @samp{assert,runtime}) or @samp{none} (same as @samp{no}).
1776 Individual checks can be enabled with these flags @samp{assert},
1777 @samp{df}, @samp{fold}, @samp{gc}, @samp{gcac}, @samp{misc}, @samp{rtl},
1778 @samp{rtlflag}, @samp{runtime}, @samp{tree}, @samp{extra} and @samp{valgrind}.
1779 @samp{extra} adds for @samp{misc} checking extra checks that might affect
1780 code generation and should therefore not differ between stage1 and later
1781 stages.
1783 The @samp{valgrind} check requires the external @command{valgrind}
1784 simulator, available from @uref{http://valgrind.org/}.  The
1785 @samp{df}, @samp{rtl}, @samp{gcac} and @samp{valgrind} checks are very expensive.
1786 To disable all checking, @samp{--disable-checking} or
1787 @samp{--enable-checking=none} must be explicitly requested.  Disabling
1788 assertions will make the compiler and runtime slightly faster but
1789 increase the risk of undetected internal errors causing wrong code to be
1790 generated.
1792 @item --disable-stage1-checking
1793 @itemx --enable-stage1-checking
1794 @itemx --enable-stage1-checking=@var{list}
1795 If no @option{--enable-checking} option is specified the stage1
1796 compiler will be built with @samp{yes} checking enabled, otherwise
1797 the stage1 checking flags are the same as specified by
1798 @option{--enable-checking}.  To build the stage1 compiler with
1799 different checking options use @option{--enable-stage1-checking}.
1800 The list of checking options is the same as for @option{--enable-checking}.
1801 If your system is too slow or too small to bootstrap a released compiler
1802 with checking for stage1 enabled, you can use @samp{--disable-stage1-checking}
1803 to disable checking for the stage1 compiler.
1805 @item --enable-coverage
1806 @itemx --enable-coverage=@var{level}
1807 With this option, the compiler is built to collect self coverage
1808 information, every time it is run.  This is for internal development
1809 purposes, and only works when the compiler is being built with gcc.  The
1810 @var{level} argument controls whether the compiler is built optimized or
1811 not, values are @samp{opt} and @samp{noopt}.  For coverage analysis you
1812 want to disable optimization, for performance analysis you want to
1813 enable optimization.  When coverage is enabled, the default level is
1814 without optimization.
1816 @item --enable-gather-detailed-mem-stats
1817 When this option is specified more detailed information on memory
1818 allocation is gathered.  This information is printed when using
1819 @option{-fmem-report}.
1821 @item --enable-valgrind-annotations
1822 Mark selected memory related operations in the compiler when run under
1823 valgrind to suppress false positives.
1825 @item --enable-nls
1826 @itemx --disable-nls
1827 The @option{--enable-nls} option enables Native Language Support (NLS),
1828 which lets GCC output diagnostics in languages other than American
1829 English.  Native Language Support is enabled by default if not doing a
1830 canadian cross build.  The @option{--disable-nls} option disables NLS@.
1832 @item --with-included-gettext
1833 If NLS is enabled, the @option{--with-included-gettext} option causes the build
1834 procedure to prefer its copy of GNU @command{gettext}.
1836 @item --with-catgets
1837 If NLS is enabled, and if the host lacks @code{gettext} but has the
1838 inferior @code{catgets} interface, the GCC build procedure normally
1839 ignores @code{catgets} and instead uses GCC's copy of the GNU
1840 @code{gettext} library.  The @option{--with-catgets} option causes the
1841 build procedure to use the host's @code{catgets} in this situation.
1843 @item --with-libiconv-prefix=@var{dir}
1844 Search for libiconv header files in @file{@var{dir}/include} and
1845 libiconv library files in @file{@var{dir}/lib}.
1847 @item --enable-obsolete
1848 Enable configuration for an obsoleted system.  If you attempt to
1849 configure GCC for a system (build, host, or target) which has been
1850 obsoleted, and you do not specify this flag, configure will halt with an
1851 error message.
1853 All support for systems which have been obsoleted in one release of GCC
1854 is removed entirely in the next major release, unless someone steps
1855 forward to maintain the port.
1857 @item --enable-decimal-float
1858 @itemx --enable-decimal-float=yes
1859 @itemx --enable-decimal-float=no
1860 @itemx --enable-decimal-float=bid
1861 @itemx --enable-decimal-float=dpd
1862 @itemx --disable-decimal-float
1863 Enable (or disable) support for the C decimal floating point extension
1864 that is in the IEEE 754-2008 standard.  This is enabled by default only
1865 on PowerPC, i386, and x86_64 GNU/Linux systems.  Other systems may also
1866 support it, but require the user to specifically enable it.  You can
1867 optionally control which decimal floating point format is used (either
1868 @samp{bid} or @samp{dpd}).  The @samp{bid} (binary integer decimal)
1869 format is default on i386 and x86_64 systems, and the @samp{dpd}
1870 (densely packed decimal) format is default on PowerPC systems.
1872 @item --enable-fixed-point
1873 @itemx --disable-fixed-point
1874 Enable (or disable) support for C fixed-point arithmetic.
1875 This option is enabled by default for some targets (such as MIPS) which
1876 have hardware-support for fixed-point operations.  On other targets, you
1877 may enable this option manually.
1879 @item --with-long-double-128
1880 Specify if @code{long double} type should be 128-bit by default on selected
1881 GNU/Linux architectures.  If using @code{--without-long-double-128},
1882 @code{long double} will be by default 64-bit, the same as @code{double} type.
1883 When neither of these configure options are used, the default will be
1884 128-bit @code{long double} when built against GNU C Library 2.4 and later,
1885 64-bit @code{long double} otherwise.
1887 @item --with-long-double-format=ibm
1888 @itemx --with-long-double-format=ieee
1889 Specify whether @code{long double} uses the IBM extended double format
1890 or the IEEE 128-bit floating point format on PowerPC Linux systems.
1891 This configuration switch will only work on little endian PowerPC
1892 Linux systems and on big endian 64-bit systems where the default cpu
1893 is at least power7 (i.e. @option{--with-cpu=power7},
1894 @option{--with-cpu=power8}, or @option{--with-cpu=power9} is used).
1896 If you use the @option{--with-long-double-64} configuration option,
1897 the @option{--with-long-double-format=ibm} and
1898 @option{--with-long-double-format=ieee} options are ignored.
1900 The default @code{long double} format is to use IBM extended double.
1901 Until all of the libraries are converted to use IEEE 128-bit floating
1902 point, it is not recommended to use
1903 @option{--with-long-double-format=ieee}.
1905 On little endian PowerPC Linux systems, if you explicitly set the
1906 @code{long double} type, it will build multilibs to allow you to
1907 select either @code{long double} format, unless you disable multilibs
1908 with the @code{--disable-multilib} option.  At present,
1909 @code{long double} multilibs are not built on big endian PowerPC Linux
1910 systems.  If you are building multilibs, you will need to configure
1911 the compiler using the @option{--with-system-zlib} option.
1913 If you do not set the @code{long double} type explicitly, no multilibs
1914 will be generated.
1916 @item --enable-fdpic
1917 On SH Linux systems, generate ELF FDPIC code.
1919 @item --with-gmp=@var{pathname}
1920 @itemx --with-gmp-include=@var{pathname}
1921 @itemx --with-gmp-lib=@var{pathname}
1922 @itemx --with-mpfr=@var{pathname}
1923 @itemx --with-mpfr-include=@var{pathname}
1924 @itemx --with-mpfr-lib=@var{pathname}
1925 @itemx --with-mpc=@var{pathname}
1926 @itemx --with-mpc-include=@var{pathname}
1927 @itemx --with-mpc-lib=@var{pathname}
1928 If you want to build GCC but do not have the GMP library, the MPFR
1929 library and/or the MPC library installed in a standard location and
1930 do not have their sources present in the GCC source tree then you
1931 can explicitly specify the directory where they are installed
1932 (@samp{--with-gmp=@var{gmpinstalldir}},
1933 @samp{--with-mpfr=@/@var{mpfrinstalldir}},
1934 @samp{--with-mpc=@/@var{mpcinstalldir}}).  The
1935 @option{--with-gmp=@/@var{gmpinstalldir}} option is shorthand for
1936 @option{--with-gmp-lib=@/@var{gmpinstalldir}/lib} and
1937 @option{--with-gmp-include=@/@var{gmpinstalldir}/include}.  Likewise the
1938 @option{--with-mpfr=@/@var{mpfrinstalldir}} option is shorthand for
1939 @option{--with-mpfr-lib=@/@var{mpfrinstalldir}/lib} and
1940 @option{--with-mpfr-include=@/@var{mpfrinstalldir}/include}, also the
1941 @option{--with-mpc=@/@var{mpcinstalldir}} option is shorthand for
1942 @option{--with-mpc-lib=@/@var{mpcinstalldir}/lib} and
1943 @option{--with-mpc-include=@/@var{mpcinstalldir}/include}.  If these
1944 shorthand assumptions are not correct, you can use the explicit
1945 include and lib options directly.  You might also need to ensure the
1946 shared libraries can be found by the dynamic linker when building and
1947 using GCC, for example by setting the runtime shared library path
1948 variable (@env{LD_LIBRARY_PATH} on GNU/Linux and Solaris systems).
1950 These flags are applicable to the host platform only.  When building
1951 a cross compiler, they will not be used to configure target libraries.
1953 @item --with-isl=@var{pathname}
1954 @itemx --with-isl-include=@var{pathname}
1955 @itemx --with-isl-lib=@var{pathname}
1956 If you do not have the isl library installed in a standard location and you
1957 want to build GCC, you can explicitly specify the directory where it is
1958 installed (@samp{--with-isl=@/@var{islinstalldir}}). The
1959 @option{--with-isl=@/@var{islinstalldir}} option is shorthand for
1960 @option{--with-isl-lib=@/@var{islinstalldir}/lib} and
1961 @option{--with-isl-include=@/@var{islinstalldir}/include}. If this
1962 shorthand assumption is not correct, you can use the explicit
1963 include and lib options directly.
1965 These flags are applicable to the host platform only.  When building
1966 a cross compiler, they will not be used to configure target libraries.
1968 @item --with-stage1-ldflags=@var{flags}
1969 This option may be used to set linker flags to be used when linking
1970 stage 1 of GCC.  These are also used when linking GCC if configured with
1971 @option{--disable-bootstrap}.  If @option{--with-stage1-libs} is not set to a
1972 value, then the default is @samp{-static-libstdc++ -static-libgcc}, if
1973 supported.
1975 @item --with-stage1-libs=@var{libs}
1976 This option may be used to set libraries to be used when linking stage 1
1977 of GCC.  These are also used when linking GCC if configured with
1978 @option{--disable-bootstrap}.
1980 @item --with-boot-ldflags=@var{flags}
1981 This option may be used to set linker flags to be used when linking
1982 stage 2 and later when bootstrapping GCC.  If --with-boot-libs
1983 is not is set to a value, then the default is
1984 @samp{-static-libstdc++ -static-libgcc}.
1986 @item --with-boot-libs=@var{libs}
1987 This option may be used to set libraries to be used when linking stage 2
1988 and later when bootstrapping GCC.
1990 @item --with-debug-prefix-map=@var{map}
1991 Convert source directory names using @option{-fdebug-prefix-map} when
1992 building runtime libraries.  @samp{@var{map}} is a space-separated
1993 list of maps of the form @samp{@var{old}=@var{new}}.
1995 @item --enable-linker-build-id
1996 Tells GCC to pass @option{--build-id} option to the linker for all final
1997 links (links performed without the @option{-r} or @option{--relocatable}
1998 option), if the linker supports it.  If you specify
1999 @option{--enable-linker-build-id}, but your linker does not
2000 support @option{--build-id} option, a warning is issued and the
2001 @option{--enable-linker-build-id} option is ignored.  The default is off.
2003 @item --with-linker-hash-style=@var{choice}
2004 Tells GCC to pass @option{--hash-style=@var{choice}} option to the
2005 linker for all final links. @var{choice} can be one of
2006 @samp{sysv}, @samp{gnu}, and @samp{both} where @samp{sysv} is the default.
2008 @item --enable-gnu-unique-object
2009 @itemx --disable-gnu-unique-object
2010 Tells GCC to use the gnu_unique_object relocation for C++ template
2011 static data members and inline function local statics.  Enabled by
2012 default for a toolchain with an assembler that accepts it and
2013 GLIBC 2.11 or above, otherwise disabled.
2015 @item --with-diagnostics-color=@var{choice}
2016 Tells GCC to use @var{choice} as the default for @option{-fdiagnostics-color=}
2017 option (if not used explicitly on the command line).  @var{choice}
2018 can be one of @samp{never}, @samp{auto}, @samp{always}, and @samp{auto-if-env}
2019 where @samp{auto} is the default.  @samp{auto-if-env} means that
2020 @option{-fdiagnostics-color=auto} will be the default if @code{GCC_COLORS}
2021 is present and non-empty in the environment, and
2022 @option{-fdiagnostics-color=never} otherwise.
2024 @item --enable-lto
2025 @itemx --disable-lto
2026 Enable support for link-time optimization (LTO).  This is enabled by
2027 default, and may be disabled using @option{--disable-lto}.
2029 @item --enable-linker-plugin-configure-flags=FLAGS
2030 @itemx --enable-linker-plugin-flags=FLAGS
2031 By default, linker plugins (such as the LTO plugin) are built for the
2032 host system architecture.  For the case that the linker has a
2033 different (but run-time compatible) architecture, these flags can be
2034 specified to build plugins that are compatible to the linker.  For
2035 example, if you are building GCC for a 64-bit x86_64
2036 (@samp{x86_64-unknown-linux-gnu}) host system, but have a 32-bit x86
2037 GNU/Linux (@samp{i686-pc-linux-gnu}) linker executable (which is
2038 executable on the former system), you can configure GCC as follows for
2039 getting compatible linker plugins:
2041 @smallexample
2042 % @var{srcdir}/configure \
2043     --host=x86_64-unknown-linux-gnu \
2044     --enable-linker-plugin-configure-flags=--host=i686-pc-linux-gnu \
2045     --enable-linker-plugin-flags='CC=gcc\ -m32\ -Wl,-rpath,[...]/i686-pc-linux-gnu/lib'
2046 @end smallexample
2048 @item --with-plugin-ld=@var{pathname}
2049 Enable an alternate linker to be used at link-time optimization (LTO)
2050 link time when @option{-fuse-linker-plugin} is enabled.
2051 This linker should have plugin support such as gold starting with
2052 version 2.20 or GNU ld starting with version 2.21.
2053 See @option{-fuse-linker-plugin} for details.
2055 @item --enable-canonical-system-headers
2056 @itemx --disable-canonical-system-headers
2057 Enable system header path canonicalization for @file{libcpp}.  This can
2058 produce shorter header file paths in diagnostics and dependency output
2059 files, but these changed header paths may conflict with some compilation
2060 environments.  Enabled by default, and may be disabled using
2061 @option{--disable-canonical-system-headers}.
2063 @item --with-glibc-version=@var{major}.@var{minor}
2064 Tell GCC that when the GNU C Library (glibc) is used on the target it
2065 will be version @var{major}.@var{minor} or later.  Normally this can
2066 be detected from the C library's header files, but this option may be
2067 needed when bootstrapping a cross toolchain without the header files
2068 available for building the initial bootstrap compiler.
2070 If GCC is configured with some multilibs that use glibc and some that
2071 do not, this option applies only to the multilibs that use glibc.
2072 However, such configurations may not work well as not all the relevant
2073 configuration in GCC is on a per-multilib basis.
2075 @item --enable-as-accelerator-for=@var{target}
2076 Build as offload target compiler. Specify offload host triple by @var{target}.
2078 @item --enable-offload-targets=@var{target1}[=@var{path1}],@dots{},@var{targetN}[=@var{pathN}]
2079 Enable offloading to targets @var{target1}, @dots{}, @var{targetN}.
2080 Offload compilers are expected to be already installed.  Default search
2081 path for them is @file{@var{exec-prefix}}, but it can be changed by
2082 specifying paths @var{path1}, @dots{}, @var{pathN}.
2084 @smallexample
2085 % @var{srcdir}/configure \
2086     --enable-offload-target=i686-unknown-linux-gnu=/path/to/i686/compiler,x86_64-pc-linux-gnu
2087 @end smallexample
2089 If @samp{hsa} is specified as one of the targets, the compiler will be
2090 built with support for HSA GPU accelerators.  Because the same
2091 compiler will emit the accelerator code, no path should be specified.
2093 @item --with-hsa-runtime=@var{pathname}
2094 @itemx --with-hsa-runtime-include=@var{pathname}
2095 @itemx --with-hsa-runtime-lib=@var{pathname}
2097 If you configure GCC with HSA offloading but do not have the HSA
2098 run-time library installed in a standard location then you can
2099 explicitly specify the directory where they are installed.  The
2100 @option{--with-hsa-runtime=@/@var{hsainstalldir}} option is a
2101 shorthand for
2102 @option{--with-hsa-runtime-lib=@/@var{hsainstalldir}/lib} and
2103 @option{--with-hsa-runtime-include=@/@var{hsainstalldir}/include}.
2105 @item --enable-cet
2106 @itemx --disable-cet
2107 Enable building target run-time libraries with control-flow
2108 instrumentation, see @option{-fcf-protection} option.  When
2109 @code{--enable-cet} is specified target libraries are configured
2110 to add @option{-fcf-protection} and, if needed, other target
2111 specific options to a set of building options.
2113 The option is disabled by default.  When @code{--enable-cet=auto}
2114 is used, it is enabled on Linux/x86 if target binutils
2115 supports @code{Intel CET} instructions and disabled otherwise.
2116 In this case the target libraries are configured to get additional
2117 @option{-fcf-protection} option.
2118 @end table
2120 @subheading Cross-Compiler-Specific Options
2121 The following options only apply to building cross compilers.
2123 @table @code
2124 @item --with-sysroot
2125 @itemx --with-sysroot=@var{dir}
2126 Tells GCC to consider @var{dir} as the root of a tree that contains
2127 (a subset of) the root filesystem of the target operating system.
2128 Target system headers, libraries and run-time object files will be
2129 searched for in there.  More specifically, this acts as if
2130 @option{--sysroot=@var{dir}} was added to the default options of the built
2131 compiler.  The specified directory is not copied into the
2132 install tree, unlike the options @option{--with-headers} and
2133 @option{--with-libs} that this option obsoletes.  The default value,
2134 in case @option{--with-sysroot} is not given an argument, is
2135 @option{$@{gcc_tooldir@}/sys-root}.  If the specified directory is a
2136 subdirectory of @option{$@{exec_prefix@}}, then it will be found relative to
2137 the GCC binaries if the installation tree is moved.
2139 This option affects the system root for the compiler used to build
2140 target libraries (which runs on the build system) and the compiler newly
2141 installed with @code{make install}; it does not affect the compiler which is
2142 used to build GCC itself.
2144 If you specify the @option{--with-native-system-header-dir=@var{dirname}}
2145 option then the compiler will search that directory within @var{dirname} for
2146 native system headers rather than the default @file{/usr/include}.
2148 @item --with-build-sysroot
2149 @itemx --with-build-sysroot=@var{dir}
2150 Tells GCC to consider @var{dir} as the system root (see
2151 @option{--with-sysroot}) while building target libraries, instead of
2152 the directory specified with @option{--with-sysroot}.  This option is
2153 only useful when you are already using @option{--with-sysroot}.  You
2154 can use @option{--with-build-sysroot} when you are configuring with
2155 @option{--prefix} set to a directory that is different from the one in
2156 which you are installing GCC and your target libraries.
2158 This option affects the system root for the compiler used to build
2159 target libraries (which runs on the build system); it does not affect
2160 the compiler which is used to build GCC itself.
2162 If you specify the @option{--with-native-system-header-dir=@var{dirname}}
2163 option then the compiler will search that directory within @var{dirname} for
2164 native system headers rather than the default @file{/usr/include}.
2166 @item --with-headers
2167 @itemx --with-headers=@var{dir}
2168 Deprecated in favor of @option{--with-sysroot}.
2169 Specifies that target headers are available when building a cross compiler.
2170 The @var{dir} argument specifies a directory which has the target include
2171 files.  These include files will be copied into the @file{gcc} install
2172 directory.  @emph{This option with the @var{dir} argument is required} when
2173 building a cross compiler, if @file{@var{prefix}/@var{target}/sys-include}
2174 doesn't pre-exist.  If @file{@var{prefix}/@var{target}/sys-include} does
2175 pre-exist, the @var{dir} argument may be omitted.  @command{fixincludes}
2176 will be run on these files to make them compatible with GCC@.
2178 @item --without-headers
2179 Tells GCC not use any target headers from a libc when building a cross
2180 compiler.  When crossing to GNU/Linux, you need the headers so GCC
2181 can build the exception handling for libgcc.
2183 @item --with-libs
2184 @itemx --with-libs="@var{dir1} @var{dir2} @dots{} @var{dirN}"
2185 Deprecated in favor of @option{--with-sysroot}.
2186 Specifies a list of directories which contain the target runtime
2187 libraries.  These libraries will be copied into the @file{gcc} install
2188 directory.  If the directory list is omitted, this option has no
2189 effect.
2191 @item --with-newlib
2192 Specifies that @samp{newlib} is
2193 being used as the target C library.  This causes @code{__eprintf} to be
2194 omitted from @file{libgcc.a} on the assumption that it will be provided by
2195 @samp{newlib}.
2197 @item --with-avrlibc
2198 Specifies that @samp{AVR-Libc} is
2199 being used as the target C library.  This causes float support
2200 functions like @code{__addsf3} to be omitted from @file{libgcc.a} on
2201 the assumption that it will be provided by @file{libm.a}.  For more
2202 technical details, cf. @uref{http://gcc.gnu.org/PR54461,,PR54461}.
2203 This option is only supported for the AVR target.  It is not supported for
2204 RTEMS configurations, which currently use newlib.  The option is
2205 supported since version 4.7.2 and is the default in 4.8.0 and newer.
2207 @item --with-nds32-lib=@var{library}
2208 Specifies that @var{library} setting is used for building @file{libgcc.a}.
2209 Currently, the valid @var{library} is @samp{newlib} or @samp{mculib}.
2210 This option is only supported for the NDS32 target.
2212 @item --with-build-time-tools=@var{dir}
2213 Specifies where to find the set of target tools (assembler, linker, etc.)
2214 that will be used while building GCC itself.  This option can be useful
2215 if the directory layouts are different between the system you are building
2216 GCC on, and the system where you will deploy it.
2218 For example, on an @samp{ia64-hp-hpux} system, you may have the GNU
2219 assembler and linker in @file{/usr/bin}, and the native tools in a
2220 different path, and build a toolchain that expects to find the
2221 native tools in @file{/usr/bin}.
2223 When you use this option, you should ensure that @var{dir} includes
2224 @command{ar}, @command{as}, @command{ld}, @command{nm},
2225 @command{ranlib} and @command{strip} if necessary, and possibly
2226 @command{objdump}.  Otherwise, GCC may use an inconsistent set of
2227 tools.
2228 @end table
2230 @subsubheading Overriding @command{configure} test results
2232 Sometimes, it might be necessary to override the result of some
2233 @command{configure} test, for example in order to ease porting to a new
2234 system or work around a bug in a test.  The toplevel @command{configure}
2235 script provides three variables for this:
2237 @table @code
2239 @item build_configargs
2240 @cindex @code{build_configargs}
2241 The contents of this variable is passed to all build @command{configure}
2242 scripts.
2244 @item host_configargs
2245 @cindex @code{host_configargs}
2246 The contents of this variable is passed to all host @command{configure}
2247 scripts.
2249 @item target_configargs
2250 @cindex @code{target_configargs}
2251 The contents of this variable is passed to all target @command{configure}
2252 scripts.
2254 @end table
2256 In order to avoid shell and @command{make} quoting issues for complex
2257 overrides, you can pass a setting for @env{CONFIG_SITE} and set
2258 variables in the site file.
2260 @subheading Objective-C-Specific Options
2262 The following options apply to the build of the Objective-C runtime library.
2264 @table @code
2265 @item --enable-objc-gc
2266 Specify that an additional variant of the GNU Objective-C runtime library
2267 is built, using an external build of the Boehm-Demers-Weiser garbage
2268 collector (@uref{http://www.hboehm.info/gc/}).  This library needs to be
2269 available for each multilib variant, unless configured with
2270 @option{--enable-objc-gc=@samp{auto}} in which case the build of the
2271 additional runtime library is skipped when not available and the build
2272 continues.
2274 @item --with-target-bdw-gc=@var{list}
2275 @itemx --with-target-bdw-gc-include=@var{list}
2276 @itemx --with-target-bdw-gc-lib=@var{list}
2277 Specify search directories for the garbage collector header files and
2278 libraries. @var{list} is a comma separated list of key value pairs of the
2279 form @samp{@var{multilibdir}=@var{path}}, where the default multilib key
2280 is named as @samp{.} (dot), or is omitted (e.g.
2281 @samp{--with-target-bdw-gc=/opt/bdw-gc,32=/opt-bdw-gc32}).
2283 The options @option{--with-target-bdw-gc-include} and
2284 @option{--with-target-bdw-gc-lib} must always be specified together
2285 for each multilib variant and they take precedence over
2286 @option{--with-target-bdw-gc}.  If @option{--with-target-bdw-gc-include}
2287 is missing values for a multilib, then the value for the default
2288 multilib is used (e.g. @samp{--with-target-bdw-gc-include=/opt/bdw-gc/include}
2289 @samp{--with-target-bdw-gc-lib=/opt/bdw-gc/lib64,32=/opt-bdw-gc/lib32}).
2290 If none of these options are specified, the library is assumed in
2291 default locations.
2292 @end table
2294 @html
2295 <hr />
2297 @end html
2298 @ifhtml
2299 @uref{./index.html,,Return to the GCC Installation page}
2300 @end ifhtml
2301 @end ifset
2303 @c ***Building****************************************************************
2304 @ifnothtml
2305 @comment node-name,     next,          previous, up
2306 @node    Building, Testing, Configuration, Installing GCC
2307 @end ifnothtml
2308 @ifset buildhtml
2309 @ifnothtml
2310 @chapter Building
2311 @end ifnothtml
2312 @cindex Installing GCC: Building
2314 Now that GCC is configured, you are ready to build the compiler and
2315 runtime libraries.
2317 Some commands executed when making the compiler may fail (return a
2318 nonzero status) and be ignored by @command{make}.  These failures, which
2319 are often due to files that were not found, are expected, and can safely
2320 be ignored.
2322 It is normal to have compiler warnings when compiling certain files.
2323 Unless you are a GCC developer, you can generally ignore these warnings
2324 unless they cause compilation to fail.  Developers should attempt to fix
2325 any warnings encountered, however they can temporarily continue past
2326 warnings-as-errors by specifying the configure flag
2327 @option{--disable-werror}.
2329 On certain old systems, defining certain environment variables such as
2330 @env{CC} can interfere with the functioning of @command{make}.
2332 If you encounter seemingly strange errors when trying to build the
2333 compiler in a directory other than the source directory, it could be
2334 because you have previously configured the compiler in the source
2335 directory.  Make sure you have done all the necessary preparations.
2337 If you build GCC on a BSD system using a directory stored in an old System
2338 V file system, problems may occur in running @command{fixincludes} if the
2339 System V file system doesn't support symbolic links.  These problems
2340 result in a failure to fix the declaration of @code{size_t} in
2341 @file{sys/types.h}.  If you find that @code{size_t} is a signed type and
2342 that type mismatches occur, this could be the cause.
2344 The solution is not to use such a directory for building GCC@.
2346 Similarly, when building from SVN or snapshots, or if you modify
2347 @file{*.l} files, you need the Flex lexical analyzer generator
2348 installed.  If you do not modify @file{*.l} files, releases contain
2349 the Flex-generated files and you do not need Flex installed to build
2350 them.  There is still one Flex-based lexical analyzer (part of the
2351 build machinery, not of GCC itself) that is used even if you only
2352 build the C front end.
2354 When building from SVN or snapshots, or if you modify Texinfo
2355 documentation, you need version 4.7 or later of Texinfo installed if you
2356 want Info documentation to be regenerated.  Releases contain Info
2357 documentation pre-built for the unmodified documentation in the release.
2359 @section Building a native compiler
2361 For a native build, the default configuration is to perform
2362 a 3-stage bootstrap of the compiler when @samp{make} is invoked.
2363 This will build the entire GCC system and ensure that it compiles
2364 itself correctly.  It can be disabled with the @option{--disable-bootstrap}
2365 parameter to @samp{configure}, but bootstrapping is suggested because
2366 the compiler will be tested more completely and could also have
2367 better performance.
2369 The bootstrapping process will complete the following steps:
2371 @itemize @bullet
2372 @item
2373 Build tools necessary to build the compiler.
2375 @item
2376 Perform a 3-stage bootstrap of the compiler.  This includes building
2377 three times the target tools for use by the compiler such as binutils
2378 (bfd, binutils, gas, gprof, ld, and opcodes) if they have been
2379 individually linked or moved into the top level GCC source tree before
2380 configuring.
2382 @item
2383 Perform a comparison test of the stage2 and stage3 compilers.
2385 @item
2386 Build runtime libraries using the stage3 compiler from the previous step.
2388 @end itemize
2390 If you are short on disk space you might consider @samp{make
2391 bootstrap-lean} instead.  The sequence of compilation is the
2392 same described above, but object files from the stage1 and
2393 stage2 of the 3-stage bootstrap of the compiler are deleted as
2394 soon as they are no longer needed.
2396 If you wish to use non-default GCC flags when compiling the stage2
2397 and stage3 compilers, set @code{BOOT_CFLAGS} on the command line when
2398 doing @samp{make}.  For example, if you want to save additional space
2399 during the bootstrap and in the final installation as well, you can
2400 build the compiler binaries without debugging information as in the
2401 following example.  This will save roughly 40% of disk space both for
2402 the bootstrap and the final installation.  (Libraries will still contain
2403 debugging information.)
2405 @smallexample
2406 make BOOT_CFLAGS='-O' bootstrap
2407 @end smallexample
2409 You can place non-default optimization flags into @code{BOOT_CFLAGS}; they
2410 are less well tested here than the default of @samp{-g -O2}, but should
2411 still work.  In a few cases, you may find that you need to specify special
2412 flags such as @option{-msoft-float} here to complete the bootstrap; or,
2413 if the native compiler miscompiles the stage1 compiler, you may need
2414 to work around this, by choosing @code{BOOT_CFLAGS} to avoid the parts
2415 of the stage1 compiler that were miscompiled, or by using @samp{make
2416 bootstrap4} to increase the number of stages of bootstrap.
2418 @code{BOOT_CFLAGS} does not apply to bootstrapped target libraries.
2419 Since these are always compiled with the compiler currently being
2420 bootstrapped, you can use @code{CFLAGS_FOR_TARGET} to modify their
2421 compilation flags, as for non-bootstrapped target libraries.
2422 Again, if the native compiler miscompiles the stage1 compiler, you may
2423 need to work around this by avoiding non-working parts of the stage1
2424 compiler.  Use @code{STAGE1_TFLAGS} to this end.
2426 If you used the flag @option{--enable-languages=@dots{}} to restrict
2427 the compilers to be built, only those you've actually enabled will be
2428 built.  This will of course only build those runtime libraries, for
2429 which the particular compiler has been built.  Please note,
2430 that re-defining @env{LANGUAGES} when calling @samp{make}
2431 @strong{does not} work anymore!
2433 If the comparison of stage2 and stage3 fails, this normally indicates
2434 that the stage2 compiler has compiled GCC incorrectly, and is therefore
2435 a potentially serious bug which you should investigate and report.  (On
2436 a few systems, meaningful comparison of object files is impossible; they
2437 always appear ``different''.  If you encounter this problem, you will
2438 need to disable comparison in the @file{Makefile}.)
2440 If you do not want to bootstrap your compiler, you can configure with
2441 @option{--disable-bootstrap}.  In particular cases, you may want to
2442 bootstrap your compiler even if the target system is not the same as
2443 the one you are building on: for example, you could build a
2444 @code{powerpc-unknown-linux-gnu} toolchain on a
2445 @code{powerpc64-unknown-linux-gnu} host.  In this case, pass
2446 @option{--enable-bootstrap} to the configure script.
2448 @code{BUILD_CONFIG} can be used to bring in additional customization
2449 to the build.  It can be set to a whitespace-separated list of names.
2450 For each such @code{NAME}, top-level @file{config/@code{NAME}.mk} will
2451 be included by the top-level @file{Makefile}, bringing in any settings
2452 it contains.  The default @code{BUILD_CONFIG} can be set using the
2453 configure option @option{--with-build-config=@code{NAME}...}.  Some
2454 examples of supported build configurations are:
2456 @table @asis
2457 @item @samp{bootstrap-O1}
2458 Removes any @option{-O}-started option from @code{BOOT_CFLAGS}, and adds
2459 @option{-O1} to it.  @samp{BUILD_CONFIG=bootstrap-O1} is equivalent to
2460 @samp{BOOT_CFLAGS='-g -O1'}.
2462 @item @samp{bootstrap-O3}
2463 Analogous to @code{bootstrap-O1}.
2465 @item @samp{bootstrap-lto}
2466 Enables Link-Time Optimization for host tools during bootstrapping.
2467 @samp{BUILD_CONFIG=bootstrap-lto} is equivalent to adding
2468 @option{-flto} to @samp{BOOT_CFLAGS}.  This option assumes that the host
2469 supports the linker plugin (e.g. GNU ld version 2.21 or later or GNU gold
2470 version 2.21 or later).
2472 @item @samp{bootstrap-lto-noplugin}
2473 This option is similar to @code{bootstrap-lto}, but is intended for
2474 hosts that do not support the linker plugin.  Without the linker plugin 
2475 static libraries are not compiled with link-time optimizations.  Since 
2476 the GCC middle end and back end are in @file{libbackend.a} this means
2477 that only the front end is actually LTO optimized.
2479 @item @samp{bootstrap-debug}
2480 Verifies that the compiler generates the same executable code, whether
2481 or not it is asked to emit debug information.  To this end, this
2482 option builds stage2 host programs without debug information, and uses
2483 @file{contrib/compare-debug} to compare them with the stripped stage3
2484 object files.  If @code{BOOT_CFLAGS} is overridden so as to not enable
2485 debug information, stage2 will have it, and stage3 won't.  This option
2486 is enabled by default when GCC bootstrapping is enabled, if
2487 @code{strip} can turn object files compiled with and without debug
2488 info into identical object files.  In addition to better test
2489 coverage, this option makes default bootstraps faster and leaner.
2491 @item @samp{bootstrap-debug-big}
2492 Rather than comparing stripped object files, as in
2493 @code{bootstrap-debug}, this option saves internal compiler dumps
2494 during stage2 and stage3 and compares them as well, which helps catch
2495 additional potential problems, but at a great cost in terms of disk
2496 space.  It can be specified in addition to @samp{bootstrap-debug}.
2498 @item @samp{bootstrap-debug-lean}
2499 This option saves disk space compared with @code{bootstrap-debug-big},
2500 but at the expense of some recompilation.  Instead of saving the dumps
2501 of stage2 and stage3 until the final compare, it uses
2502 @option{-fcompare-debug} to generate, compare and remove the dumps
2503 during stage3, repeating the compilation that already took place in
2504 stage2, whose dumps were not saved.
2506 @item @samp{bootstrap-debug-lib}
2507 This option tests executable code invariance over debug information
2508 generation on target libraries, just like @code{bootstrap-debug-lean}
2509 tests it on host programs.  It builds stage3 libraries with
2510 @option{-fcompare-debug}, and it can be used along with any of the
2511 @code{bootstrap-debug} options above.
2513 There aren't @code{-lean} or @code{-big} counterparts to this option
2514 because most libraries are only build in stage3, so bootstrap compares
2515 would not get significant coverage.  Moreover, the few libraries built
2516 in stage2 are used in stage3 host programs, so we wouldn't want to
2517 compile stage2 libraries with different options for comparison purposes.
2519 @item @samp{bootstrap-debug-ckovw}
2520 Arranges for error messages to be issued if the compiler built on any
2521 stage is run without the option @option{-fcompare-debug}.  This is
2522 useful to verify the full @option{-fcompare-debug} testing coverage.  It
2523 must be used along with @code{bootstrap-debug-lean} and
2524 @code{bootstrap-debug-lib}.
2526 @item @samp{bootstrap-cet}
2527 This option enables Intel CET for host tools during bootstrapping.
2528 @samp{BUILD_CONFIG=bootstrap-cet} is equivalent to adding
2529 @option{-fcf-protection} to @samp{BOOT_CFLAGS}.  This option
2530 assumes that the host supports Intel CET (e.g. GNU assembler version
2531 2.30 or later).
2533 @item @samp{bootstrap-time}
2534 Arranges for the run time of each program started by the GCC driver,
2535 built in any stage, to be logged to @file{time.log}, in the top level of
2536 the build tree.
2538 @end table
2540 @section Building a cross compiler
2542 When building a cross compiler, it is not generally possible to do a
2543 3-stage bootstrap of the compiler.  This makes for an interesting problem
2544 as parts of GCC can only be built with GCC@.
2546 To build a cross compiler, we recommend first building and installing a
2547 native compiler.  You can then use the native GCC compiler to build the
2548 cross compiler.  The installed native compiler needs to be GCC version
2549 2.95 or later.
2551 Assuming you have already installed a native copy of GCC and configured
2552 your cross compiler, issue the command @command{make}, which performs the
2553 following steps:
2555 @itemize @bullet
2556 @item
2557 Build host tools necessary to build the compiler.
2559 @item
2560 Build target tools for use by the compiler such as binutils (bfd,
2561 binutils, gas, gprof, ld, and opcodes)
2562 if they have been individually linked or moved into the top level GCC source
2563 tree before configuring.
2565 @item
2566 Build the compiler (single stage only).
2568 @item
2569 Build runtime libraries using the compiler from the previous step.
2570 @end itemize
2572 Note that if an error occurs in any step the make process will exit.
2574 If you are not building GNU binutils in the same source tree as GCC,
2575 you will need a cross-assembler and cross-linker installed before
2576 configuring GCC@.  Put them in the directory
2577 @file{@var{prefix}/@var{target}/bin}.  Here is a table of the tools
2578 you should put in this directory:
2580 @table @file
2581 @item as
2582 This should be the cross-assembler.
2584 @item ld
2585 This should be the cross-linker.
2587 @item ar
2588 This should be the cross-archiver: a program which can manipulate
2589 archive files (linker libraries) in the target machine's format.
2591 @item ranlib
2592 This should be a program to construct a symbol table in an archive file.
2593 @end table
2595 The installation of GCC will find these programs in that directory,
2596 and copy or link them to the proper place to for the cross-compiler to
2597 find them when run later.
2599 The easiest way to provide these files is to build the Binutils package.
2600 Configure it with the same @option{--host} and @option{--target}
2601 options that you use for configuring GCC, then build and install
2602 them.  They install their executables automatically into the proper
2603 directory.  Alas, they do not support all the targets that GCC
2604 supports.
2606 If you are not building a C library in the same source tree as GCC,
2607 you should also provide the target libraries and headers before
2608 configuring GCC, specifying the directories with
2609 @option{--with-sysroot} or @option{--with-headers} and
2610 @option{--with-libs}.  Many targets also require ``start files'' such
2611 as @file{crt0.o} and
2612 @file{crtn.o} which are linked into each executable.  There may be several
2613 alternatives for @file{crt0.o}, for use with profiling or other
2614 compilation options.  Check your target's definition of
2615 @code{STARTFILE_SPEC} to find out what start files it uses.
2617 @section Building in parallel
2619 GNU Make 3.80 and above, which is necessary to build GCC, support
2620 building in parallel.  To activate this, you can use @samp{make -j 2}
2621 instead of @samp{make}.  You can also specify a bigger number, and
2622 in most cases using a value greater than the number of processors in
2623 your machine will result in fewer and shorter I/O latency hits, thus
2624 improving overall throughput; this is especially true for slow drives
2625 and network filesystems.
2627 @section Building the Ada compiler
2629 In order to build GNAT, the Ada compiler, you need a working GNAT
2630 compiler (GCC version 4.0 or later).
2631 This includes GNAT tools such as @command{gnatmake} and
2632 @command{gnatlink}, since the Ada front end is written in Ada and
2633 uses some GNAT-specific extensions.
2635 In order to build a cross compiler, it is suggested to install
2636 the new compiler as native first, and then use it to build the cross
2637 compiler.
2639 @command{configure} does not test whether the GNAT installation works
2640 and has a sufficiently recent version; if too old a GNAT version is
2641 installed, the build will fail unless @option{--enable-languages} is
2642 used to disable building the Ada front end.
2644 @env{ADA_INCLUDE_PATH} and @env{ADA_OBJECT_PATH} environment variables
2645 must not be set when building the Ada compiler, the Ada tools, or the
2646 Ada runtime libraries. You can check that your build environment is clean
2647 by verifying that @samp{gnatls -v} lists only one explicit path in each
2648 section.
2650 @section Building with profile feedback
2652 It is possible to use profile feedback to optimize the compiler itself.  This
2653 should result in a faster compiler binary.  Experiments done on x86 using gcc
2654 3.3 showed approximately 7 percent speedup on compiling C programs.  To
2655 bootstrap the compiler with profile feedback, use @code{make profiledbootstrap}.
2657 When @samp{make profiledbootstrap} is run, it will first build a @code{stage1}
2658 compiler.  This compiler is used to build a @code{stageprofile} compiler
2659 instrumented to collect execution counts of instruction and branch
2660 probabilities.  Training run is done by building @code{stagetrain}
2661 compiler.  Finally a @code{stagefeedback} compiler is built
2662 using the information collected.
2664 Unlike standard bootstrap, several additional restrictions apply.  The
2665 compiler used to build @code{stage1} needs to support a 64-bit integral type.
2666 It is recommended to only use GCC for this.
2668 On Linux/x86_64 hosts with some restrictions (no virtualization) it is
2669 also possible to do autofdo build with @samp{make
2670 autoprofiledback}. This uses Linux perf to sample branches in the
2671 binary and then rebuild it with feedback derived from the profile.
2672 Linux perf and the @code{autofdo} toolkit needs to be installed for
2673 this.
2675 Only the profile from the current build is used, so when an error
2676 occurs it is recommended to clean before restarting. Otherwise
2677 the code quality may be much worse.
2679 @html
2680 <hr />
2682 @end html
2683 @ifhtml
2684 @uref{./index.html,,Return to the GCC Installation page}
2685 @end ifhtml
2686 @end ifset
2688 @c ***Testing*****************************************************************
2689 @ifnothtml
2690 @comment node-name,     next,          previous, up
2691 @node    Testing, Final install, Building, Installing GCC
2692 @end ifnothtml
2693 @ifset testhtml
2694 @ifnothtml
2695 @chapter Installing GCC: Testing
2696 @end ifnothtml
2697 @cindex Testing
2698 @cindex Installing GCC: Testing
2699 @cindex Testsuite
2701 Before you install GCC, we encourage you to run the testsuites and to
2702 compare your results with results from a similar configuration that have
2703 been submitted to the
2704 @uref{http://gcc.gnu.org/ml/gcc-testresults/,,gcc-testresults mailing list}.
2705 Some of these archived results are linked from the build status lists
2706 at @uref{http://gcc.gnu.org/buildstat.html}, although not everyone who
2707 reports a successful build runs the testsuites and submits the results.
2708 This step is optional and may require you to download additional software,
2709 but it can give you confidence in your new GCC installation or point out
2710 problems before you install and start using your new GCC@.
2712 First, you must have @uref{download.html,,downloaded the testsuites}.
2713 These are part of the full distribution, but if you downloaded the
2714 ``core'' compiler plus any front ends, you must download the testsuites
2715 separately.
2717 Second, you must have the testing tools installed.  This includes
2718 @uref{http://www.gnu.org/software/dejagnu/,,DejaGnu}, Tcl, and Expect;
2719 the DejaGnu site has links to these. For running the BRIG frontend
2720 tests, a tool to assemble the binary BRIGs from HSAIL text,
2721 @uref{https://github.com/HSAFoundation/HSAIL-Tools/,,HSAILasm} must
2722 be installed.
2724 If the directories where @command{runtest} and @command{expect} were
2725 installed are not in the @env{PATH}, you may need to set the following
2726 environment variables appropriately, as in the following example (which
2727 assumes that DejaGnu has been installed under @file{/usr/local}):
2729 @smallexample
2730 TCL_LIBRARY = /usr/local/share/tcl8.0
2731 DEJAGNULIBS = /usr/local/share/dejagnu
2732 @end smallexample
2734 (On systems such as Cygwin, these paths are required to be actual
2735 paths, not mounts or links; presumably this is due to some lack of
2736 portability in the DejaGnu code.)
2739 Finally, you can run the testsuite (which may take a long time):
2740 @smallexample
2741 cd @var{objdir}; make -k check
2742 @end smallexample
2744 This will test various components of GCC, such as compiler
2745 front ends and runtime libraries.  While running the testsuite, DejaGnu
2746 might emit some harmless messages resembling
2747 @samp{WARNING: Couldn't find the global config file.} or
2748 @samp{WARNING: Couldn't find tool init file} that can be ignored.
2750 If you are testing a cross-compiler, you may want to run the testsuite
2751 on a simulator as described at @uref{http://gcc.gnu.org/simtest-howto.html}.
2753 @section How can you run the testsuite on selected tests?
2755 In order to run sets of tests selectively, there are targets
2756 @samp{make check-gcc} and language specific @samp{make check-c},
2757 @samp{make check-c++}, @samp{make check-fortran},
2758 @samp{make check-ada}, @samp{make check-objc}, @samp{make check-obj-c++},
2759 @samp{make check-lto}
2760 in the @file{gcc} subdirectory of the object directory.  You can also
2761 just run @samp{make check} in a subdirectory of the object directory.
2764 A more selective way to just run all @command{gcc} execute tests in the
2765 testsuite is to use
2767 @smallexample
2768 make check-gcc RUNTESTFLAGS="execute.exp @var{other-options}"
2769 @end smallexample
2771 Likewise, in order to run only the @command{g++} ``old-deja'' tests in
2772 the testsuite with filenames matching @samp{9805*}, you would use
2774 @smallexample
2775 make check-g++ RUNTESTFLAGS="old-deja.exp=9805* @var{other-options}"
2776 @end smallexample
2778 The file-matching expression following @var{filename}@command{.exp=} is treated
2779 as a series of whitespace-delimited glob expressions so that multiple patterns
2780 may be passed, although any whitespace must either be escaped or surrounded by
2781 single quotes if multiple expressions are desired. For example,
2783 @smallexample
2784 make check-g++ RUNTESTFLAGS="old-deja.exp=9805*\ virtual2.c @var{other-options}"
2785 make check-g++ RUNTESTFLAGS="'old-deja.exp=9805* virtual2.c' @var{other-options}"
2786 @end smallexample
2788 The @file{*.exp} files are located in the testsuite directories of the GCC
2789 source, the most important ones being @file{compile.exp},
2790 @file{execute.exp}, @file{dg.exp} and @file{old-deja.exp}.
2791 To get a list of the possible @file{*.exp} files, pipe the
2792 output of @samp{make check} into a file and look at the
2793 @samp{Running @dots{}  .exp} lines.
2795 @section Passing options and running multiple testsuites
2797 You can pass multiple options to the testsuite using the
2798 @samp{--target_board} option of DejaGNU, either passed as part of
2799 @samp{RUNTESTFLAGS}, or directly to @command{runtest} if you prefer to
2800 work outside the makefiles.  For example,
2802 @smallexample
2803 make check-g++ RUNTESTFLAGS="--target_board=unix/-O3/-fmerge-constants"
2804 @end smallexample
2806 will run the standard @command{g++} testsuites (``unix'' is the target name
2807 for a standard native testsuite situation), passing
2808 @samp{-O3 -fmerge-constants} to the compiler on every test, i.e.,
2809 slashes separate options.
2811 You can run the testsuites multiple times using combinations of options
2812 with a syntax similar to the brace expansion of popular shells:
2814 @smallexample
2815 @dots{}"--target_board=arm-sim\@{-mhard-float,-msoft-float\@}\@{-O1,-O2,-O3,\@}"
2816 @end smallexample
2818 (Note the empty option caused by the trailing comma in the final group.)
2819 The following will run each testsuite eight times using the @samp{arm-sim}
2820 target, as if you had specified all possible combinations yourself:
2822 @smallexample
2823 --target_board='arm-sim/-mhard-float/-O1 \
2824                 arm-sim/-mhard-float/-O2 \
2825                 arm-sim/-mhard-float/-O3 \
2826                 arm-sim/-mhard-float \
2827                 arm-sim/-msoft-float/-O1 \
2828                 arm-sim/-msoft-float/-O2 \
2829                 arm-sim/-msoft-float/-O3 \
2830                 arm-sim/-msoft-float'
2831 @end smallexample
2833 They can be combined as many times as you wish, in arbitrary ways.  This
2834 list:
2836 @smallexample
2837 @dots{}"--target_board=unix/-Wextra\@{-O3,-fno-strength\@}\@{-fomit-frame,\@}"
2838 @end smallexample
2840 will generate four combinations, all involving @samp{-Wextra}.
2842 The disadvantage to this method is that the testsuites are run in serial,
2843 which is a waste on multiprocessor systems.  For users with GNU Make and
2844 a shell which performs brace expansion, you can run the testsuites in
2845 parallel by having the shell perform the combinations and @command{make}
2846 do the parallel runs.  Instead of using @samp{--target_board}, use a
2847 special makefile target:
2849 @smallexample
2850 make -j@var{N} check-@var{testsuite}//@var{test-target}/@var{option1}/@var{option2}/@dots{}
2851 @end smallexample
2853 For example,
2855 @smallexample
2856 make -j3 check-gcc//sh-hms-sim/@{-m1,-m2,-m3,-m3e,-m4@}/@{,-nofpu@}
2857 @end smallexample
2859 will run three concurrent ``make-gcc'' testsuites, eventually testing all
2860 ten combinations as described above.  Note that this is currently only
2861 supported in the @file{gcc} subdirectory.  (To see how this works, try
2862 typing @command{echo} before the example given here.)
2865 @section How to interpret test results
2867 The result of running the testsuite are various @file{*.sum} and @file{*.log}
2868 files in the testsuite subdirectories.  The @file{*.log} files contain a
2869 detailed log of the compiler invocations and the corresponding
2870 results, the @file{*.sum} files summarize the results.  These summaries
2871 contain status codes for all tests:
2873 @itemize @bullet
2874 @item
2875 PASS: the test passed as expected
2876 @item
2877 XPASS: the test unexpectedly passed
2878 @item
2879 FAIL: the test unexpectedly failed
2880 @item
2881 XFAIL: the test failed as expected
2882 @item
2883 UNSUPPORTED: the test is not supported on this platform
2884 @item
2885 ERROR: the testsuite detected an error
2886 @item
2887 WARNING: the testsuite detected a possible problem
2888 @end itemize
2890 It is normal for some tests to report unexpected failures.  At the
2891 current time the testing harness does not allow fine grained control
2892 over whether or not a test is expected to fail.  This problem should
2893 be fixed in future releases.
2896 @section Submitting test results
2898 If you want to report the results to the GCC project, use the
2899 @file{contrib/test_summary} shell script.  Start it in the @var{objdir} with
2901 @smallexample
2902 @var{srcdir}/contrib/test_summary -p your_commentary.txt \
2903     -m gcc-testresults@@gcc.gnu.org |sh
2904 @end smallexample
2906 This script uses the @command{Mail} program to send the results, so
2907 make sure it is in your @env{PATH}.  The file @file{your_commentary.txt} is
2908 prepended to the testsuite summary and should contain any special
2909 remarks you have on your results or your build environment.  Please
2910 do not edit the testsuite result block or the subject line, as these
2911 messages may be automatically processed.
2913 @html
2914 <hr />
2916 @end html
2917 @ifhtml
2918 @uref{./index.html,,Return to the GCC Installation page}
2919 @end ifhtml
2920 @end ifset
2922 @c ***Final install***********************************************************
2923 @ifnothtml
2924 @comment node-name,     next,          previous, up
2925 @node    Final install, , Testing, Installing GCC
2926 @end ifnothtml
2927 @ifset finalinstallhtml
2928 @ifnothtml
2929 @chapter Installing GCC: Final installation
2930 @end ifnothtml
2932 Now that GCC has been built (and optionally tested), you can install it with
2933 @smallexample
2934 cd @var{objdir} && make install
2935 @end smallexample
2937 We strongly recommend to install into a target directory where there is
2938 no previous version of GCC present.  Also, the GNAT runtime should not
2939 be stripped, as this would break certain features of the debugger that
2940 depend on this debugging information (catching Ada exceptions for
2941 instance).
2943 That step completes the installation of GCC; user level binaries can
2944 be found in @file{@var{prefix}/bin} where @var{prefix} is the value
2945 you specified with the @option{--prefix} to configure (or
2946 @file{/usr/local} by default).  (If you specified @option{--bindir},
2947 that directory will be used instead; otherwise, if you specified
2948 @option{--exec-prefix}, @file{@var{exec-prefix}/bin} will be used.)
2949 Headers for the C++ library are installed in
2950 @file{@var{prefix}/include}; libraries in @file{@var{libdir}}
2951 (normally @file{@var{prefix}/lib}); internal parts of the compiler in
2952 @file{@var{libdir}/gcc} and @file{@var{libexecdir}/gcc}; documentation
2953 in info format in @file{@var{infodir}} (normally
2954 @file{@var{prefix}/info}).
2956 When installing cross-compilers, GCC's executables
2957 are not only installed into @file{@var{bindir}}, that
2958 is, @file{@var{exec-prefix}/bin}, but additionally into
2959 @file{@var{exec-prefix}/@var{target-alias}/bin}, if that directory
2960 exists.  Typically, such @dfn{tooldirs} hold target-specific
2961 binutils, including assembler and linker.
2963 Installation into a temporary staging area or into a @command{chroot}
2964 jail can be achieved with the command
2966 @smallexample
2967 make DESTDIR=@var{path-to-rootdir} install
2968 @end smallexample
2970 @noindent
2971 where @var{path-to-rootdir} is the absolute path of
2972 a directory relative to which all installation paths will be
2973 interpreted.  Note that the directory specified by @code{DESTDIR}
2974 need not exist yet; it will be created if necessary.
2976 There is a subtle point with tooldirs and @code{DESTDIR}:
2977 If you relocate a cross-compiler installation with
2978 e.g.@: @samp{DESTDIR=@var{rootdir}}, then the directory
2979 @file{@var{rootdir}/@var{exec-prefix}/@var{target-alias}/bin} will
2980 be filled with duplicated GCC executables only if it already exists,
2981 it will not be created otherwise.  This is regarded as a feature,
2982 not as a bug, because it gives slightly more control to the packagers
2983 using the @code{DESTDIR} feature.
2985 You can install stripped programs and libraries with
2987 @smallexample
2988 make install-strip
2989 @end smallexample
2991 If you are bootstrapping a released version of GCC then please
2992 quickly review the build status page for your release, available from
2993 @uref{http://gcc.gnu.org/buildstat.html}.
2994 If your system is not listed for the version of GCC that you built,
2995 send a note to
2996 @email{gcc@@gcc.gnu.org} indicating
2997 that you successfully built and installed GCC@.
2998 Include the following information:
3000 @itemize @bullet
3001 @item
3002 Output from running @file{@var{srcdir}/config.guess}.  Do not send
3003 that file itself, just the one-line output from running it.
3005 @item
3006 The output of @samp{gcc -v} for your newly installed @command{gcc}.
3007 This tells us which version of GCC you built and the options you passed to
3008 configure.
3010 @item
3011 Whether you enabled all languages or a subset of them.  If you used a
3012 full distribution then this information is part of the configure
3013 options in the output of @samp{gcc -v}, but if you downloaded the
3014 ``core'' compiler plus additional front ends then it isn't apparent
3015 which ones you built unless you tell us about it.
3017 @item
3018 If the build was for GNU/Linux, also include:
3019 @itemize @bullet
3020 @item
3021 The distribution name and version (e.g., Red Hat 7.1 or Debian 2.2.3);
3022 this information should be available from @file{/etc/issue}.
3024 @item
3025 The version of the Linux kernel, available from @samp{uname --version}
3026 or @samp{uname -a}.
3028 @item
3029 The version of glibc you used; for RPM-based systems like Red Hat,
3030 Mandrake, and SuSE type @samp{rpm -q glibc} to get the glibc version,
3031 and on systems like Debian and Progeny use @samp{dpkg -l libc6}.
3032 @end itemize
3033 For other systems, you can include similar information if you think it is
3034 relevant.
3036 @item
3037 Any other information that you think would be useful to people building
3038 GCC on the same configuration.  The new entry in the build status list
3039 will include a link to the archived copy of your message.
3040 @end itemize
3042 We'd also like to know if the
3043 @ifnothtml
3044 @ref{Specific, host/target specific installation notes}
3045 @end ifnothtml
3046 @ifhtml
3047 @uref{specific.html,,host/target specific installation notes}
3048 @end ifhtml
3049 didn't include your host/target information or if that information is
3050 incomplete or out of date.  Send a note to
3051 @email{gcc@@gcc.gnu.org} detailing how the information should be changed.
3053 If you find a bug, please report it following the
3054 @uref{../bugs/,,bug reporting guidelines}.
3056 If you want to print the GCC manuals, do @samp{cd @var{objdir}; make
3057 dvi}.  You will need to have @command{texi2dvi} (version at least 4.7)
3058 and @TeX{} installed.  This creates a number of @file{.dvi} files in
3059 subdirectories of @file{@var{objdir}}; these may be converted for
3060 printing with programs such as @command{dvips}.  Alternately, by using
3061 @samp{make pdf} in place of @samp{make dvi}, you can create documentation
3062 in the form of @file{.pdf} files; this requires @command{texi2pdf}, which
3063 is included with Texinfo version 4.8 and later.  You can also
3064 @uref{https://shop.fsf.org/,,buy printed manuals from the
3065 Free Software Foundation}, though such manuals may not be for the most
3066 recent version of GCC@.
3068 If you would like to generate online HTML documentation, do @samp{cd
3069 @var{objdir}; make html} and HTML will be generated for the gcc manuals in
3070 @file{@var{objdir}/gcc/HTML}.
3072 @html
3073 <hr />
3075 @end html
3076 @ifhtml
3077 @uref{./index.html,,Return to the GCC Installation page}
3078 @end ifhtml
3079 @end ifset
3081 @c ***Binaries****************************************************************
3082 @ifnothtml
3083 @comment node-name,     next,          previous, up
3084 @node    Binaries, Specific, Installing GCC, Top
3085 @end ifnothtml
3086 @ifset binarieshtml
3087 @ifnothtml
3088 @chapter Installing GCC: Binaries
3089 @end ifnothtml
3090 @cindex Binaries
3091 @cindex Installing GCC: Binaries
3093 We are often asked about pre-compiled versions of GCC@.  While we cannot
3094 provide these for all platforms, below you'll find links to binaries for
3095 various platforms where creating them by yourself is not easy due to various
3096 reasons.
3098 Please note that we did not create these binaries, nor do we
3099 support them.  If you have any problems installing them, please
3100 contact their makers.
3102 @itemize
3103 @item
3104 AIX:
3105 @itemize
3106 @item
3107 @uref{http://www.bullfreeware.com,,Bull's Open Source Software Archive for
3108 for AIX 5L and AIX 6};
3110 @item
3111 @uref{http://www.perzl.org/aix/,,AIX Open Source Packages (AIX5L AIX 6.1
3112 AIX 7.1)}.
3113 @end itemize
3115 @item
3116 DOS---@uref{http://www.delorie.com/djgpp/,,DJGPP}.
3118 @item
3119 HP-UX:
3120 @itemize
3121 @item
3122 @uref{http://hpux.connect.org.uk/,,HP-UX Porting Center};
3123 @end itemize
3125 @item
3126 Solaris 2 (SPARC, Intel):
3127 @itemize
3128 @item
3129 @uref{https://www.opencsw.org/,,OpenCSW}
3131 @item
3132 @uref{http://jupiterrise.com/tgcware/,,TGCware}
3133 @end itemize
3135 @item
3136 macOS:
3137 @itemize
3138 @item
3139 The @uref{https://brew.sh,,Homebrew} package manager;
3140 @item
3141 @uref{https://www.macports.org,,MacPorts}.
3142 @end itemize
3144 @item
3145 Microsoft Windows:
3146 @itemize
3147 @item
3148 The @uref{https://sourceware.org/cygwin/,,Cygwin} project;
3149 @item
3150 The @uref{http://www.mingw.org/,,MinGW} and
3151 @uref{http://mingw-w64.org/doku.php,,mingw-w64} projects.
3152 @end itemize
3154 @item
3155 @uref{http://www.openpkg.org/,,OpenPKG} offers binaries for quite a
3156 number of platforms.
3158 @item
3159 The @uref{http://gcc.gnu.org/wiki/GFortranBinaries,,GFortran Wiki} has
3160 links to GNU Fortran binaries for several platforms.
3161 @end itemize
3163 @html
3164 <hr />
3166 @end html
3167 @ifhtml
3168 @uref{./index.html,,Return to the GCC Installation page}
3169 @end ifhtml
3170 @end ifset
3172 @c ***Specific****************************************************************
3173 @ifnothtml
3174 @comment node-name,     next,          previous, up
3175 @node    Specific, Old, Binaries, Top
3176 @end ifnothtml
3177 @ifset specifichtml
3178 @ifnothtml
3179 @chapter Host/target specific installation notes for GCC
3180 @end ifnothtml
3181 @cindex Specific
3182 @cindex Specific installation notes
3183 @cindex Target specific installation
3184 @cindex Host specific installation
3185 @cindex Target specific installation notes
3187 Please read this document carefully @emph{before} installing the
3188 GNU Compiler Collection on your machine.
3190 Note that this list of install notes is @emph{not} a list of supported
3191 hosts or targets.  Not all supported hosts and targets are listed
3192 here, only the ones that require host-specific or target-specific
3193 information have to. 
3195 @ifhtml
3196 @itemize
3197 @item
3198 @uref{#aarch64-x-x,,aarch64*-*-*}
3199 @item
3200 @uref{#alpha-x-x,,alpha*-*-*}
3201 @item
3202 @uref{#amd64-x-solaris210,,amd64-*-solaris2.10}
3203 @item
3204 @uref{#arm-x-eabi,,arm-*-eabi}
3205 @item
3206 @uref{#avr,,avr}
3207 @item
3208 @uref{#bfin,,Blackfin}
3209 @item
3210 @uref{#dos,,DOS}
3211 @item
3212 @uref{#x-x-freebsd,,*-*-freebsd*}
3213 @item
3214 @uref{#h8300-hms,,h8300-hms}
3215 @item
3216 @uref{#hppa-hp-hpux,,hppa*-hp-hpux*}
3217 @item
3218 @uref{#hppa-hp-hpux10,,hppa*-hp-hpux10}
3219 @item
3220 @uref{#hppa-hp-hpux11,,hppa*-hp-hpux11}
3221 @item
3222 @uref{#x-x-linux-gnu,,*-*-linux-gnu}
3223 @item
3224 @uref{#ix86-x-linux,,i?86-*-linux*}
3225 @item
3226 @uref{#ix86-x-solaris210,,i?86-*-solaris2.10}
3227 @item
3228 @uref{#ia64-x-linux,,ia64-*-linux}
3229 @item
3230 @uref{#ia64-x-hpux,,ia64-*-hpux*}
3231 @item
3232 @uref{#x-ibm-aix,,*-ibm-aix*}
3233 @item
3234 @uref{#iq2000-x-elf,,iq2000-*-elf}
3235 @item
3236 @uref{#lm32-x-elf,,lm32-*-elf}
3237 @item
3238 @uref{#lm32-x-uclinux,,lm32-*-uclinux}
3239 @item
3240 @uref{#m32c-x-elf,,m32c-*-elf}
3241 @item
3242 @uref{#m32r-x-elf,,m32r-*-elf}
3243 @item
3244 @uref{#m68k-x-x,,m68k-*-*}
3245 @item
3246 @uref{#m68k-uclinux,,m68k-uclinux}
3247 @item
3248 @uref{#microblaze-x-elf,,microblaze-*-elf}
3249 @item
3250 @uref{#mips-x-x,,mips-*-*}
3251 @item
3252 @uref{#nds32le-x-elf,,nds32le-*-elf}
3253 @item
3254 @uref{#nds32be-x-elf,,nds32be-*-elf}
3255 @item
3256 @uref{#nvptx-x-none,,nvptx-*-none}
3257 @item
3258 @uref{#powerpc-x-x,,powerpc*-*-*}
3259 @item
3260 @uref{#powerpc-x-darwin,,powerpc-*-darwin*}
3261 @item
3262 @uref{#powerpc-x-elf,,powerpc-*-elf}
3263 @item
3264 @uref{#powerpc-x-linux-gnu,,powerpc*-*-linux-gnu*}
3265 @item
3266 @uref{#powerpc-x-netbsd,,powerpc-*-netbsd*}
3267 @item
3268 @uref{#powerpc-x-eabisim,,powerpc-*-eabisim}
3269 @item
3270 @uref{#powerpc-x-eabi,,powerpc-*-eabi}
3271 @item
3272 @uref{#powerpcle-x-elf,,powerpcle-*-elf}
3273 @item
3274 @uref{#powerpcle-x-eabisim,,powerpcle-*-eabisim}
3275 @item
3276 @uref{#powerpcle-x-eabi,,powerpcle-*-eabi}
3277 @item
3278 @uref{#riscv32-x-elf,,riscv32-*-elf}
3279 @item
3280 @uref{#riscv32-x-linux,,riscv32-*-linux}
3281 @item
3282 @uref{#riscv64-x-elf,,riscv64-*-elf}
3283 @item
3284 @uref{#riscv64-x-linux,,riscv64-*-linux}
3285 @item
3286 @uref{#s390-x-linux,,s390-*-linux*}
3287 @item
3288 @uref{#s390x-x-linux,,s390x-*-linux*}
3289 @item
3290 @uref{#s390x-ibm-tpf,,s390x-ibm-tpf*}
3291 @item
3292 @uref{#x-x-solaris2,,*-*-solaris2*}
3293 @item
3294 @uref{#sparc-x-x,,sparc*-*-*}
3295 @item
3296 @uref{#sparc-sun-solaris2,,sparc-sun-solaris2*}
3297 @item
3298 @uref{#sparc-sun-solaris210,,sparc-sun-solaris2.10}
3299 @item
3300 @uref{#sparc-x-linux,,sparc-*-linux*}
3301 @item
3302 @uref{#sparc64-x-solaris2,,sparc64-*-solaris2*}
3303 @item
3304 @uref{#sparcv9-x-solaris2,,sparcv9-*-solaris2*}
3305 @item
3306 @uref{#c6x-x-x,,c6x-*-*}
3307 @item
3308 @uref{#tilegx-x-linux,,tilegx-*-linux*}
3309 @item
3310 @uref{#tilegxbe-x-linux,,tilegxbe-*-linux*}
3311 @item
3312 @uref{#tilepro-x-linux,,tilepro-*-linux*}
3313 @item
3314 @uref{#visium-x-elf, visium-*-elf}
3315 @item
3316 @uref{#x-x-vxworks,,*-*-vxworks*}
3317 @item
3318 @uref{#x86-64-x-x,,x86_64-*-*, amd64-*-*}
3319 @item
3320 @uref{#x86-64-x-solaris210,,x86_64-*-solaris2.1[0-9]*}
3321 @item
3322 @uref{#xtensa-x-elf,,xtensa*-*-elf}
3323 @item
3324 @uref{#xtensa-x-linux,,xtensa*-*-linux*}
3325 @item
3326 @uref{#windows,,Microsoft Windows}
3327 @item
3328 @uref{#x-x-cygwin,,*-*-cygwin}
3329 @item
3330 @uref{#x-x-mingw32,,*-*-mingw32}
3331 @item
3332 @uref{#os2,,OS/2}
3333 @item
3334 @uref{#older,,Older systems}
3335 @end itemize
3337 @itemize
3338 @item
3339 @uref{#elf,,all ELF targets} (SVR4, Solaris 2, etc.)
3340 @end itemize
3341 @end ifhtml
3344 @html
3345 <!-- -------- host/target specific issues start here ---------------- -->
3346 <hr />
3347 @end html
3348 @anchor{aarch64-x-x}
3349 @heading aarch64*-*-*
3350 Binutils pre 2.24 does not have support for selecting @option{-mabi} and
3351 does not support ILP32.  If it is used to build GCC 4.9 or later, GCC will
3352 not support option @option{-mabi=ilp32}.
3354 To enable a workaround for the Cortex-A53 erratum number 835769 by default
3355 (for all CPUs regardless of -mcpu option given) at configure time use the
3356 @option{--enable-fix-cortex-a53-835769} option.  This will enable the fix by
3357 default and can be explicitly disabled during compilation by passing the
3358 @option{-mno-fix-cortex-a53-835769} option.  Conversely,
3359 @option{--disable-fix-cortex-a53-835769} will disable the workaround by
3360 default.  The workaround is disabled by default if neither of
3361 @option{--enable-fix-cortex-a53-835769} or
3362 @option{--disable-fix-cortex-a53-835769} is given at configure time.
3364 To enable a workaround for the Cortex-A53 erratum number 843419 by default
3365 (for all CPUs regardless of -mcpu option given) at configure time use the
3366 @option{--enable-fix-cortex-a53-843419} option.  This workaround is applied at
3367 link time.  Enabling the workaround will cause GCC to pass the relevant option
3368 to the linker.  It can be explicitly disabled during compilation by passing the
3369 @option{-mno-fix-cortex-a53-843419} option.  Conversely,
3370 @option{--disable-fix-cortex-a53-843419} will disable the workaround by default.
3371 The workaround is disabled by default if neither of
3372 @option{--enable-fix-cortex-a53-843419} or
3373 @option{--disable-fix-cortex-a53-843419} is given at configure time.
3375 @html
3376 <hr />
3377 @end html
3378 @anchor{alpha-x-x}
3379 @heading alpha*-*-*
3380 This section contains general configuration information for all
3381 Alpha-based platforms using ELF@.  In addition to reading this
3382 section, please read all other sections that match your target.
3384 We require binutils 2.11.2 or newer.
3385 Previous binutils releases had a number of problems with DWARF 2
3386 debugging information, not the least of which is incorrect linking of
3387 shared libraries.
3389 @html
3390 <hr />
3391 @end html
3392 @anchor{amd64-x-solaris210}
3393 @heading amd64-*-solaris2.1[0-9]*
3394 This is a synonym for @samp{x86_64-*-solaris2.1[0-9]*}.
3396 @html
3397 <hr />
3398 @end html
3399 @anchor{arc-x-elf32}
3400 @heading arc-*-elf32
3402 Use @samp{configure --target=arc-elf32 --with-cpu=@var{cpu} --enable-languages="c,c++"}
3403 to configure GCC, with @var{cpu} being one of @samp{arc600}, @samp{arc601},
3404 or @samp{arc700}@.
3406 @html
3407 <hr />
3408 @end html
3409 @anchor{arc-linux-uclibc}
3410 @heading arc-linux-uclibc
3412 Use @samp{configure --target=arc-linux-uclibc --with-cpu=arc700 --enable-languages="c,c++"} to configure GCC@.
3414 @html
3415 <hr />
3416 @end html
3417 @anchor{arm-x-eabi}
3418 @heading arm-*-eabi
3419 ARM-family processors.
3421 Building the Ada frontend commonly fails (an infinite loop executing
3422 @code{xsinfo}) if the host compiler is GNAT 4.8.  Host compilers built from the
3423 GNAT 4.6, 4.9 or 5 release branches are known to succeed.
3425 @html
3426 <hr />
3427 @end html
3428 @anchor{avr}
3429 @heading avr
3430 ATMEL AVR-family micro controllers.  These are used in embedded
3431 applications.  There are no standard Unix configurations.
3432 @ifnothtml
3433 @xref{AVR Options,, AVR Options, gcc, Using the GNU Compiler
3434 Collection (GCC)},
3435 @end ifnothtml
3436 @ifhtml
3437 See ``AVR Options'' in the main manual
3438 @end ifhtml
3439 for the list of supported MCU types.
3441 Use @samp{configure --target=avr --enable-languages="c"} to configure GCC@.
3443 Further installation notes and other useful information about AVR tools
3444 can also be obtained from:
3446 @itemize @bullet
3447 @item
3448 @uref{http://www.nongnu.org/avr/,,http://www.nongnu.org/avr/}
3449 @item
3450 @uref{http://www.amelek.gda.pl/avr/,,http://www.amelek.gda.pl/avr/}
3451 @end itemize
3453 The following error:
3454 @smallexample
3455 Error: register required
3456 @end smallexample
3458 indicates that you should upgrade to a newer version of the binutils.
3460 @html
3461 <hr />
3462 @end html
3463 @anchor{bfin}
3464 @heading Blackfin
3465 The Blackfin processor, an Analog Devices DSP.
3466 @ifnothtml
3467 @xref{Blackfin Options,, Blackfin Options, gcc, Using the GNU Compiler
3468 Collection (GCC)},
3469 @end ifnothtml
3470 @ifhtml
3471 See ``Blackfin Options'' in the main manual
3472 @end ifhtml
3474 More information, and a version of binutils with support for this processor,
3475 is available at @uref{https://blackfin.uclinux.org}
3477 @html
3478 <hr />
3479 @end html
3480 @anchor{cr16}
3481 @heading CR16
3482 The CR16 CompactRISC architecture is a 16-bit architecture. This
3483 architecture is used in embedded applications.
3485 @ifnothtml
3486 @xref{CR16 Options,, CR16 Options, gcc, Using and Porting the GNU Compiler
3487 Collection (GCC)},
3488 @end ifnothtml
3490 @ifhtml
3491 See ``CR16 Options'' in the main manual for a list of CR16-specific options.
3492 @end ifhtml
3494 Use @samp{configure --target=cr16-elf --enable-languages=c,c++} to configure
3495 GCC@ for building a CR16 elf cross-compiler.
3497 Use @samp{configure --target=cr16-uclinux --enable-languages=c,c++} to
3498 configure GCC@ for building a CR16 uclinux cross-compiler.
3500 @html
3501 <hr />
3502 @end html
3503 @anchor{cris}
3504 @heading CRIS
3505 CRIS is the CPU architecture in Axis Communications ETRAX system-on-a-chip
3506 series.  These are used in embedded applications.
3508 @ifnothtml
3509 @xref{CRIS Options,, CRIS Options, gcc, Using the GNU Compiler
3510 Collection (GCC)},
3511 @end ifnothtml
3512 @ifhtml
3513 See ``CRIS Options'' in the main manual
3514 @end ifhtml
3515 for a list of CRIS-specific options.
3517 There are a few different CRIS targets:
3518 @table @code
3519 @item cris-axis-elf
3520 Mainly for monolithic embedded systems.  Includes a multilib for the
3521 @samp{v10} core used in @samp{ETRAX 100 LX}.
3522 @item cris-axis-linux-gnu
3523 A GNU/Linux port for the CRIS architecture, currently targeting
3524 @samp{ETRAX 100 LX} by default.
3525 @end table
3527 Pre-packaged tools can be obtained from
3528 @uref{ftp://ftp.axis.com/@/pub/@/axis/@/tools/@/cris/@/compiler-kit/}.  More
3529 information about this platform is available at
3530 @uref{http://developer.axis.com/}.
3532 @html
3533 <hr />
3534 @end html
3535 @anchor{dos}
3536 @heading DOS
3537 Please have a look at the @uref{binaries.html,,binaries page}.
3539 You cannot install GCC by itself on MSDOS; it will not compile under
3540 any MSDOS compiler except itself.  You need to get the complete
3541 compilation package DJGPP, which includes binaries as well as sources,
3542 and includes all the necessary compilation tools and libraries.
3544 @html
3545 <hr />
3546 @end html
3547 @anchor{epiphany-x-elf}
3548 @heading epiphany-*-elf
3549 Adapteva Epiphany.
3550 This configuration is intended for embedded systems.
3552 @html
3553 <hr />
3554 @end html
3555 @anchor{x-x-freebsd}
3556 @heading *-*-freebsd*
3557 Support for FreeBSD 1 was discontinued in GCC 3.2.  Support for
3558 FreeBSD 2 (and any mutant a.out variants of FreeBSD 3) was
3559 discontinued in GCC 4.0.
3561 In order to better utilize FreeBSD base system functionality and match
3562 the configuration of the system compiler, GCC 4.5 and above as well as
3563 GCC 4.4 past 2010-06-20 leverage SSP support in libc (which is present
3564 on FreeBSD 7 or later) and the use of @code{__cxa_atexit} by default
3565 (on FreeBSD 6 or later).  The use of @code{dl_iterate_phdr} inside
3566 @file{libgcc_s.so.1} and boehm-gc (on FreeBSD 7 or later) is enabled
3567 by GCC 4.5 and above.
3569 We support FreeBSD using the ELF file format with DWARF 2 debugging
3570 for all CPU architectures.  You may use @option{-gstabs} instead of
3571 @option{-g}, if you really want the old debugging format.  There are
3572 no known issues with mixing object files and libraries with different
3573 debugging formats.  Otherwise, this release of GCC should now match
3574 more of the configuration used in the stock FreeBSD configuration of
3575 GCC@.  In particular, @option{--enable-threads} is now configured by
3576 default.  However, as a general user, do not attempt to replace the
3577 system compiler with this release.  Known to bootstrap and check with
3578 good results on FreeBSD 7.2-STABLE@.  In the past, known to bootstrap
3579 and check with good results on FreeBSD 3.0, 3.4, 4.0, 4.2, 4.3, 4.4,
3580 4.5, 4.8, 4.9 and 5-CURRENT@.
3582 The version of binutils installed in @file{/usr/bin} probably works
3583 with this release of GCC@.  Bootstrapping against the latest GNU
3584 binutils and/or the version found in @file{/usr/ports/devel/binutils} has
3585 been known to enable additional features and improve overall testsuite
3586 results.  However, it is currently known that boehm-gc may not configure
3587 properly on FreeBSD prior to the FreeBSD 7.0 release with GNU binutils
3588 after 2.16.1.
3590 @html
3591 <hr />
3592 @end html
3593 @anchor{ft32-x-elf}
3594 @heading ft32-*-elf
3595 The FT32 processor.
3596 This configuration is intended for embedded systems.
3598 @html
3599 <hr />
3600 @end html
3601 @anchor{h8300-hms}
3602 @heading h8300-hms
3603 Renesas H8/300 series of processors.
3605 Please have a look at the @uref{binaries.html,,binaries page}.
3607 The calling convention and structure layout has changed in release 2.6.
3608 All code must be recompiled.  The calling convention now passes the
3609 first three arguments in function calls in registers.  Structures are no
3610 longer a multiple of 2 bytes.
3612 @html
3613 <hr />
3614 @end html
3615 @anchor{hppa-hp-hpux}
3616 @heading hppa*-hp-hpux*
3617 Support for HP-UX version 9 and older was discontinued in GCC 3.4.
3619 We require using gas/binutils on all hppa platforms.  Version 2.19 or
3620 later is recommended.
3622 It may be helpful to configure GCC with the
3623 @uref{./configure.html#with-gnu-as,,@option{--with-gnu-as}} and
3624 @option{--with-as=@dots{}} options to ensure that GCC can find GAS@.
3626 The HP assembler should not be used with GCC.  It is rarely tested and may
3627 not work.  It shouldn't be used with any languages other than C due to its
3628 many limitations.
3630 Specifically, @option{-g} does not work (HP-UX uses a peculiar debugging
3631 format which GCC does not know about).  It also inserts timestamps
3632 into each object file it creates, causing the 3-stage comparison test to
3633 fail during a bootstrap.  You should be able to continue by saying
3634 @samp{make all-host all-target} after getting the failure from @samp{make}.
3636 Various GCC features are not supported.  For example, it does not support weak
3637 symbols or alias definitions.  As a result, explicit template instantiations
3638 are required when using C++.  This makes it difficult if not impossible to
3639 build many C++ applications.
3641 There are two default scheduling models for instructions.  These are
3642 PROCESSOR_7100LC and PROCESSOR_8000.  They are selected from the pa-risc
3643 architecture specified for the target machine when configuring.
3644 PROCESSOR_8000 is the default.  PROCESSOR_7100LC is selected when
3645 the target is a @samp{hppa1*} machine.
3647 The PROCESSOR_8000 model is not well suited to older processors.  Thus,
3648 it is important to completely specify the machine architecture when
3649 configuring if you want a model other than PROCESSOR_8000.  The macro
3650 TARGET_SCHED_DEFAULT can be defined in BOOT_CFLAGS if a different
3651 default scheduling model is desired.
3653 As of GCC 4.0, GCC uses the UNIX 95 namespace for HP-UX 10.10
3654 through 11.00, and the UNIX 98 namespace for HP-UX 11.11 and later.
3655 This namespace change might cause problems when bootstrapping with
3656 an earlier version of GCC or the HP compiler as essentially the same
3657 namespace is required for an entire build.  This problem can be avoided
3658 in a number of ways.  With HP cc, @env{UNIX_STD} can be set to @samp{95}
3659 or @samp{98}.  Another way is to add an appropriate set of predefines
3660 to @env{CC}.  The description for the @option{munix=} option contains
3661 a list of the predefines used with each standard.
3663 More specific information to @samp{hppa*-hp-hpux*} targets follows.
3665 @html
3666 <hr />
3667 @end html
3668 @anchor{hppa-hp-hpux10}
3669 @heading hppa*-hp-hpux10
3670 For hpux10.20, we @emph{highly} recommend you pick up the latest sed patch
3671 @code{PHCO_19798} from HP@.
3673 The C++ ABI has changed incompatibly in GCC 4.0.  COMDAT subspaces are
3674 used for one-only code and data.  This resolves many of the previous
3675 problems in using C++ on this target.  However, the ABI is not compatible
3676 with the one implemented under HP-UX 11 using secondary definitions.
3678 @html
3679 <hr />
3680 @end html
3681 @anchor{hppa-hp-hpux11}
3682 @heading hppa*-hp-hpux11
3683 GCC 3.0 and up support HP-UX 11.  GCC 2.95.x is not supported and cannot
3684 be used to compile GCC 3.0 and up.
3686 The libffi library haven't been ported to 64-bit HP-UX@ and doesn't build.
3688 Refer to @uref{binaries.html,,binaries} for information about obtaining
3689 precompiled GCC binaries for HP-UX@.  Precompiled binaries must be obtained
3690 to build the Ada language as it cannot be bootstrapped using C@.  Ada is
3691 only available for the 32-bit PA-RISC runtime.
3693 Starting with GCC 3.4 an ISO C compiler is required to bootstrap.  The
3694 bundled compiler supports only traditional C; you will need either HP's
3695 unbundled compiler, or a binary distribution of GCC@.
3697 It is possible to build GCC 3.3 starting with the bundled HP compiler,
3698 but the process requires several steps.  GCC 3.3 can then be used to
3699 build later versions.
3701 There are several possible approaches to building the distribution.
3702 Binutils can be built first using the HP tools.  Then, the GCC
3703 distribution can be built.  The second approach is to build GCC
3704 first using the HP tools, then build binutils, then rebuild GCC@.
3705 There have been problems with various binary distributions, so it
3706 is best not to start from a binary distribution.
3708 On 64-bit capable systems, there are two distinct targets.  Different
3709 installation prefixes must be used if both are to be installed on
3710 the same system.  The @samp{hppa[1-2]*-hp-hpux11*} target generates code
3711 for the 32-bit PA-RISC runtime architecture and uses the HP linker.
3712 The @samp{hppa64-hp-hpux11*} target generates 64-bit code for the
3713 PA-RISC 2.0 architecture.
3715 The script config.guess now selects the target type based on the compiler
3716 detected during configuration.  You must define @env{PATH} or @env{CC} so
3717 that configure finds an appropriate compiler for the initial bootstrap.
3718 When @env{CC} is used, the definition should contain the options that are
3719 needed whenever @env{CC} is used.
3721 Specifically, options that determine the runtime architecture must be
3722 in @env{CC} to correctly select the target for the build.  It is also
3723 convenient to place many other compiler options in @env{CC}.  For example,
3724 @env{CC="cc -Ac +DA2.0W -Wp,-H16376 -D_CLASSIC_TYPES -D_HPUX_SOURCE"}
3725 can be used to bootstrap the GCC 3.3 branch with the HP compiler in
3726 64-bit K&R/bundled mode.  The @option{+DA2.0W} option will result in
3727 the automatic selection of the @samp{hppa64-hp-hpux11*} target.  The
3728 macro definition table of cpp needs to be increased for a successful
3729 build with the HP compiler.  _CLASSIC_TYPES and _HPUX_SOURCE need to
3730 be defined when building with the bundled compiler, or when using the
3731 @option{-Ac} option.  These defines aren't necessary with @option{-Ae}.
3733 It is best to explicitly configure the @samp{hppa64-hp-hpux11*} target
3734 with the @option{--with-ld=@dots{}} option.  This overrides the standard
3735 search for ld.  The two linkers supported on this target require different
3736 commands.  The default linker is determined during configuration.  As a
3737 result, it's not possible to switch linkers in the middle of a GCC build.
3738 This has been reported to sometimes occur in unified builds of binutils
3739 and GCC@.
3741 A recent linker patch must be installed for the correct operation of
3742 GCC 3.3 and later.  @code{PHSS_26559} and @code{PHSS_24304} are the
3743 oldest linker patches that are known to work.  They are for HP-UX
3744 11.00 and 11.11, respectively.  @code{PHSS_24303}, the companion to
3745 @code{PHSS_24304}, might be usable but it hasn't been tested.  These
3746 patches have been superseded.  Consult the HP patch database to obtain
3747 the currently recommended linker patch for your system.
3749 The patches are necessary for the support of weak symbols on the
3750 32-bit port, and for the running of initializers and finalizers.  Weak
3751 symbols are implemented using SOM secondary definition symbols.  Prior
3752 to HP-UX 11, there are bugs in the linker support for secondary symbols.
3753 The patches correct a problem of linker core dumps creating shared
3754 libraries containing secondary symbols, as well as various other
3755 linking issues involving secondary symbols.
3757 GCC 3.3 uses the ELF DT_INIT_ARRAY and DT_FINI_ARRAY capabilities to
3758 run initializers and finalizers on the 64-bit port.  The 32-bit port
3759 uses the linker @option{+init} and @option{+fini} options for the same
3760 purpose.  The patches correct various problems with the +init/+fini
3761 options, including program core dumps.  Binutils 2.14 corrects a
3762 problem on the 64-bit port resulting from HP's non-standard use of
3763 the .init and .fini sections for array initializers and finalizers.
3765 Although the HP and GNU linkers are both supported for the
3766 @samp{hppa64-hp-hpux11*} target, it is strongly recommended that the
3767 HP linker be used for link editing on this target.
3769 At this time, the GNU linker does not support the creation of long
3770 branch stubs.  As a result, it cannot successfully link binaries
3771 containing branch offsets larger than 8 megabytes.  In addition,
3772 there are problems linking shared libraries, linking executables
3773 with @option{-static}, and with dwarf2 unwind and exception support.
3774 It also doesn't provide stubs for internal calls to global functions
3775 in shared libraries, so these calls cannot be overloaded.
3777 The HP dynamic loader does not support GNU symbol versioning, so symbol
3778 versioning is not supported.  It may be necessary to disable symbol
3779 versioning with @option{--disable-symvers} when using GNU ld.
3781 POSIX threads are the default.  The optional DCE thread library is not
3782 supported, so @option{--enable-threads=dce} does not work.
3784 @html
3785 <hr />
3786 @end html
3787 @anchor{x-x-linux-gnu}
3788 @heading *-*-linux-gnu
3789 Versions of libstdc++-v3 starting with 3.2.1 require bug fixes present
3790 in glibc 2.2.5 and later.  More information is available in the
3791 libstdc++-v3 documentation.
3793 @html
3794 <hr />
3795 @end html
3796 @anchor{ix86-x-linux}
3797 @heading i?86-*-linux*
3798 As of GCC 3.3, binutils 2.13.1 or later is required for this platform.
3799 See @uref{http://gcc.gnu.org/PR10877,,bug 10877} for more information.
3801 If you receive Signal 11 errors when building on GNU/Linux, then it is
3802 possible you have a hardware problem.  Further information on this can be
3803 found on @uref{http://www.bitwizard.nl/sig11/,,www.bitwizard.nl}.
3805 @html
3806 <hr />
3807 @end html
3808 @anchor{ix86-x-solaris210}
3809 @heading i?86-*-solaris2.10
3810 Use this for Solaris 10 or later on x86 and x86-64 systems.  Starting
3811 with GCC 4.7, there is also a 64-bit @samp{amd64-*-solaris2.1[0-9]*} or
3812 @samp{x86_64-*-solaris2.1[0-9]*} configuration that corresponds to
3813 @samp{sparcv9-sun-solaris2*}.
3815 It is recommended that you configure GCC to use the GNU assembler.  The
3816 versions included in Solaris 10, from GNU binutils 2.15 (in
3817 @file{/usr/sfw/bin/gas}), and Solaris 11, from GNU binutils 2.19 or
3818 newer (also available as @file{/usr/bin/gas} and
3819 @file{/usr/gnu/bin/as}), work fine.  The current version, from GNU
3820 binutils 2.29, is known to work, but the version from GNU binutils 2.26
3821 must be avoided.  Recent versions of the Solaris assembler in
3822 @file{/usr/ccs/bin/as} work almost as well, though.
3823 @c FIXME: as patch requirements?
3825 For linking, the Solaris linker, is preferred.  If you want to use the GNU
3826 linker instead, note that due to a packaging bug the version in Solaris
3827 10, from GNU binutils 2.15 (in @file{/usr/sfw/bin/gld}), cannot be used,
3828 while the version in Solaris 11, from GNU binutils 2.19 or newer (also
3829 in @file{/usr/gnu/bin/ld} and @file{/usr/bin/gld}), works, as does the
3830 latest version, from GNU binutils 2.29.
3832 To use GNU @command{as}, configure with the options
3833 @option{--with-gnu-as --with-as=@//usr/@/sfw/@/bin/@/gas}.  It may be necessary
3834 to configure with @option{--without-gnu-ld --with-ld=@//usr/@/ccs/@/bin/@/ld} to
3835 guarantee use of Sun @command{ld}.
3836 @c FIXME: why --without-gnu-ld --with-ld?
3838 @html
3839 <hr />
3840 @end html
3841 @anchor{ia64-x-linux}
3842 @heading ia64-*-linux
3843 IA-64 processor (also known as IPF, or Itanium Processor Family)
3844 running GNU/Linux.
3846 If you are using the installed system libunwind library with
3847 @option{--with-system-libunwind}, then you must use libunwind 0.98 or
3848 later.
3850 None of the following versions of GCC has an ABI that is compatible
3851 with any of the other versions in this list, with the exception that
3852 Red Hat 2.96 and Trillian 000171 are compatible with each other:
3853 3.1, 3.0.2, 3.0.1, 3.0, Red Hat 2.96, and Trillian 000717.
3854 This primarily affects C++ programs and programs that create shared libraries.
3855 GCC 3.1 or later is recommended for compiling linux, the kernel.
3856 As of version 3.1 GCC is believed to be fully ABI compliant, and hence no
3857 more major ABI changes are expected.
3859 @html
3860 <hr />
3861 @end html
3862 @anchor{ia64-x-hpux}
3863 @heading ia64-*-hpux*
3864 Building GCC on this target requires the GNU Assembler.  The bundled HP
3865 assembler will not work.  To prevent GCC from using the wrong assembler,
3866 the option @option{--with-gnu-as} may be necessary.
3868 The GCC libunwind library has not been ported to HPUX@.  This means that for
3869 GCC versions 3.2.3 and earlier, @option{--enable-libunwind-exceptions}
3870 is required to build GCC@.  For GCC 3.3 and later, this is the default.
3871 For gcc 3.4.3 and later, @option{--enable-libunwind-exceptions} is
3872 removed and the system libunwind library will always be used.
3874 @html
3875 <hr />
3876 <!-- rs6000-ibm-aix*, powerpc-ibm-aix* -->
3877 @end html
3878 @anchor{x-ibm-aix}
3879 @heading *-ibm-aix*
3880 Support for AIX version 3 and older was discontinued in GCC 3.4.
3881 Support for AIX version 4.2 and older was discontinued in GCC 4.5.
3883 ``out of memory'' bootstrap failures may indicate a problem with
3884 process resource limits (ulimit).  Hard limits are configured in the
3885 @file{/etc/security/limits} system configuration file.
3887 GCC 4.9 and above require a C++ compiler for bootstrap.  IBM VAC++ / xlC
3888 cannot bootstrap GCC.  xlc can bootstrap an older version of GCC and
3889 G++ can bootstrap recent releases of GCC.
3891 GCC can bootstrap with recent versions of IBM XLC, but bootstrapping
3892 with an earlier release of GCC is recommended.  Bootstrapping with XLC
3893 requires a larger data segment, which can be enabled through the
3894 @var{LDR_CNTRL} environment variable, e.g.,
3896 @smallexample
3897 % LDR_CNTRL=MAXDATA=0x50000000
3898 % export LDR_CNTRL
3899 @end smallexample
3901 One can start with a pre-compiled version of GCC to build from
3902 sources.  One may delete GCC's ``fixed'' header files when starting
3903 with a version of GCC built for an earlier release of AIX.
3905 To speed up the configuration phases of bootstrapping and installing GCC,
3906 one may use GNU Bash instead of AIX @command{/bin/sh}, e.g.,
3908 @smallexample
3909 % CONFIG_SHELL=/opt/freeware/bin/bash
3910 % export CONFIG_SHELL
3911 @end smallexample
3913 and then proceed as described in @uref{build.html,,the build
3914 instructions}, where we strongly recommend specifying an absolute path
3915 to invoke @var{srcdir}/configure.
3917 Because GCC on AIX is built as a 32-bit executable by default,
3918 (although it can generate 64-bit programs) the GMP and MPFR libraries
3919 required by gfortran must be 32-bit libraries.  Building GMP and MPFR
3920 as static archive libraries works better than shared libraries.
3922 Errors involving @code{alloca} when building GCC generally are due
3923 to an incorrect definition of @code{CC} in the Makefile or mixing files
3924 compiled with the native C compiler and GCC@.  During the stage1 phase of
3925 the build, the native AIX compiler @strong{must} be invoked as @command{cc}
3926 (not @command{xlc}).  Once @command{configure} has been informed of
3927 @command{xlc}, one needs to use @samp{make distclean} to remove the
3928 configure cache files and ensure that @env{CC} environment variable
3929 does not provide a definition that will confuse @command{configure}.
3930 If this error occurs during stage2 or later, then the problem most likely
3931 is the version of Make (see above).
3933 The native @command{as} and @command{ld} are recommended for
3934 bootstrapping on AIX@.  The GNU Assembler, GNU Linker, and GNU
3935 Binutils version 2.20 is the minimum level that supports bootstrap on
3936 AIX 5@.  The GNU Assembler has not been updated to support AIX 6@ or
3937 AIX 7.  The native AIX tools do interoperate with GCC@.
3939 AIX 7.1 added partial support for DWARF debugging, but full support
3940 requires AIX 7.1 TL03 SP7 that supports additional DWARF sections and
3941 fixes a bug in the assembler.  AIX 7.1 TL03 SP5 distributed a version
3942 of libm.a missing important symbols; a fix for IV77796 will be
3943 included in SP6.
3945 AIX 5.3 TL10, AIX 6.1 TL05 and AIX 7.1 TL00 introduced an AIX
3946 assembler change that sometimes produces corrupt assembly files
3947 causing AIX linker errors.  The bug breaks GCC bootstrap on AIX and
3948 can cause compilation failures with existing GCC installations.  An
3949 AIX iFix for AIX 5.3 is available (APAR IZ98385 for AIX 5.3 TL10, APAR
3950 IZ98477 for AIX 5.3 TL11 and IZ98134 for AIX 5.3 TL12). AIX 5.3 TL11 SP8,
3951 AIX 5.3 TL12 SP5, AIX 6.1 TL04 SP11, AIX 6.1 TL05 SP7, AIX 6.1 TL06 SP6,
3952 AIX 6.1 TL07 and AIX 7.1 TL01 should include the fix.
3954 Building @file{libstdc++.a} requires a fix for an AIX Assembler bug
3955 APAR IY26685 (AIX 4.3) or APAR IY25528 (AIX 5.1).  It also requires a
3956 fix for another AIX Assembler bug and a co-dependent AIX Archiver fix
3957 referenced as APAR IY53606 (AIX 5.2) or as APAR IY54774 (AIX 5.1)
3959 @anchor{TransferAixShobj}
3960 @samp{libstdc++} in GCC 3.4 increments the major version number of the
3961 shared object and GCC installation places the @file{libstdc++.a}
3962 shared library in a common location which will overwrite the and GCC
3963 3.3 version of the shared library.  Applications either need to be
3964 re-linked against the new shared library or the GCC 3.1 and GCC 3.3
3965 versions of the @samp{libstdc++} shared object needs to be available
3966 to the AIX runtime loader.  The GCC 3.1 @samp{libstdc++.so.4}, if
3967 present, and GCC 3.3 @samp{libstdc++.so.5} shared objects can be
3968 installed for runtime dynamic loading using the following steps to set
3969 the @samp{F_LOADONLY} flag in the shared object for @emph{each}
3970 multilib @file{libstdc++.a} installed:
3972 Extract the shared objects from the currently installed
3973 @file{libstdc++.a} archive:
3974 @smallexample
3975 % ar -x libstdc++.a libstdc++.so.4 libstdc++.so.5
3976 @end smallexample
3978 Enable the @samp{F_LOADONLY} flag so that the shared object will be
3979 available for runtime dynamic loading, but not linking:
3980 @smallexample
3981 % strip -e libstdc++.so.4 libstdc++.so.5
3982 @end smallexample
3984 Archive the runtime-only shared object in the GCC 3.4
3985 @file{libstdc++.a} archive:
3986 @smallexample
3987 % ar -q libstdc++.a libstdc++.so.4 libstdc++.so.5
3988 @end smallexample
3990 Eventually, the
3991 @uref{./configure.html#WithAixSoname,,@option{--with-aix-soname=svr4}}
3992 configure option may drop the need for this procedure for libraries that
3993 support it.
3995 Linking executables and shared libraries may produce warnings of
3996 duplicate symbols.  The assembly files generated by GCC for AIX always
3997 have included multiple symbol definitions for certain global variable
3998 and function declarations in the original program.  The warnings should
3999 not prevent the linker from producing a correct library or runnable
4000 executable.
4002 AIX 4.3 utilizes a ``large format'' archive to support both 32-bit and
4003 64-bit object modules.  The routines provided in AIX 4.3.0 and AIX 4.3.1
4004 to parse archive libraries did not handle the new format correctly.
4005 These routines are used by GCC and result in error messages during
4006 linking such as ``not a COFF file''.  The version of the routines shipped
4007 with AIX 4.3.1 should work for a 32-bit environment.  The @option{-g}
4008 option of the archive command may be used to create archives of 32-bit
4009 objects using the original ``small format''.  A correct version of the
4010 routines is shipped with AIX 4.3.2 and above.
4012 Some versions of the AIX binder (linker) can fail with a relocation
4013 overflow severe error when the @option{-bbigtoc} option is used to link
4014 GCC-produced object files into an executable that overflows the TOC@.  A fix
4015 for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND -BBIGTOC) is
4016 available from IBM Customer Support and from its
4017 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
4018 website as PTF U455193.
4020 The AIX 4.3.2.1 linker (bos.rte.bind_cmds Level 4.3.2.1) will dump core
4021 with a segmentation fault when invoked by any version of GCC@.  A fix for
4022 APAR IX87327 is available from IBM Customer Support and from its
4023 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
4024 website as PTF U461879.  This fix is incorporated in AIX 4.3.3 and above.
4026 The initial assembler shipped with AIX 4.3.0 generates incorrect object
4027 files.  A fix for APAR IX74254 (64BIT DISASSEMBLED OUTPUT FROM COMPILER FAILS
4028 TO ASSEMBLE/BIND) is available from IBM Customer Support and from its
4029 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
4030 website as PTF U453956.  This fix is incorporated in AIX 4.3.1 and above.
4032 AIX provides National Language Support (NLS)@.  Compilers and assemblers
4033 use NLS to support locale-specific representations of various data
4034 formats including floating-point numbers (e.g., @samp{.}  vs @samp{,} for
4035 separating decimal fractions).  There have been problems reported where
4036 GCC does not produce the same floating-point formats that the assembler
4037 expects.  If one encounters this problem, set the @env{LANG}
4038 environment variable to @samp{C} or @samp{En_US}.
4040 A default can be specified with the @option{-mcpu=@var{cpu_type}}
4041 switch and using the configure option @option{--with-cpu-@var{cpu_type}}.
4043 @html
4044 <hr />
4045 @end html
4046 @anchor{iq2000-x-elf}
4047 @heading iq2000-*-elf
4048 Vitesse IQ2000 processors.  These are used in embedded
4049 applications.  There are no standard Unix configurations.
4051 @html
4052 <hr />
4053 @end html
4054 @anchor{lm32-x-elf}
4055 @heading lm32-*-elf
4056 Lattice Mico32 processor.
4057 This configuration is intended for embedded systems.
4059 @html
4060 <hr />
4061 @end html
4062 @anchor{lm32-x-uclinux}
4063 @heading lm32-*-uclinux
4064 Lattice Mico32 processor.
4065 This configuration is intended for embedded systems running uClinux.
4067 @html
4068 <hr />
4069 @end html
4070 @anchor{m32c-x-elf}
4071 @heading m32c-*-elf
4072 Renesas M32C processor.
4073 This configuration is intended for embedded systems.
4075 @html
4076 <hr />
4077 @end html
4078 @anchor{m32r-x-elf}
4079 @heading m32r-*-elf
4080 Renesas M32R processor.
4081 This configuration is intended for embedded systems.
4083 @html
4084 <hr />
4085 @end html
4086 @anchor{m68k-x-x}
4087 @heading m68k-*-*
4088 By default,
4089 @samp{m68k-*-elf*}, @samp{m68k-*-rtems},  @samp{m68k-*-uclinux} and
4090 @samp{m68k-*-linux}
4091 build libraries for both M680x0 and ColdFire processors.  If you only
4092 need the M680x0 libraries, you can omit the ColdFire ones by passing
4093 @option{--with-arch=m68k} to @command{configure}.  Alternatively, you
4094 can omit the M680x0 libraries by passing @option{--with-arch=cf} to
4095 @command{configure}.  These targets default to 5206 or 5475 code as
4096 appropriate for the target system when
4097 configured with @option{--with-arch=cf} and 68020 code otherwise.
4099 The @samp{m68k-*-netbsd} and
4100 @samp{m68k-*-openbsd} targets also support the @option{--with-arch}
4101 option.  They will generate ColdFire CFV4e code when configured with
4102 @option{--with-arch=cf} and 68020 code otherwise.
4104 You can override the default processors listed above by configuring
4105 with @option{--with-cpu=@var{target}}.  This @var{target} can either
4106 be a @option{-mcpu} argument or one of the following values:
4107 @samp{m68000}, @samp{m68010}, @samp{m68020}, @samp{m68030},
4108 @samp{m68040}, @samp{m68060}, @samp{m68020-40} and @samp{m68020-60}.
4110 GCC requires at least binutils version 2.17 on these targets.
4112 @html
4113 <hr />
4114 @end html
4115 @anchor{m68k-x-uclinux}
4116 @heading m68k-*-uclinux
4117 GCC 4.3 changed the uClinux configuration so that it uses the
4118 @samp{m68k-linux-gnu} ABI rather than the @samp{m68k-elf} ABI.
4119 It also added improved support for C++ and flat shared libraries,
4120 both of which were ABI changes.
4122 @html
4123 <hr />
4124 @end html
4125 @anchor{microblaze-x-elf}
4126 @heading microblaze-*-elf
4127 Xilinx MicroBlaze processor.
4128 This configuration is intended for embedded systems.
4130 @html
4131 <hr />
4132 @end html
4133 @anchor{mips-x-x}
4134 @heading mips-*-*
4135 If on a MIPS system you get an error message saying ``does not have gp
4136 sections for all it's [sic] sectons [sic]'', don't worry about it.  This
4137 happens whenever you use GAS with the MIPS linker, but there is not
4138 really anything wrong, and it is okay to use the output file.  You can
4139 stop such warnings by installing the GNU linker.
4141 It would be nice to extend GAS to produce the gp tables, but they are
4142 optional, and there should not be a warning about their absence.
4144 The libstdc++ atomic locking routines for MIPS targets requires MIPS II
4145 and later.  A patch went in just after the GCC 3.3 release to
4146 make @samp{mips*-*-*} use the generic implementation instead.  You can also
4147 configure for @samp{mipsel-elf} as a workaround.  The
4148 @samp{mips*-*-linux*} target continues to use the MIPS II routines.  More
4149 work on this is expected in future releases.
4151 @c If you make --with-llsc the default for another target, please also
4152 @c update the description of the --with-llsc option.
4154 The built-in @code{__sync_*} functions are available on MIPS II and
4155 later systems and others that support the @samp{ll}, @samp{sc} and
4156 @samp{sync} instructions.  This can be overridden by passing
4157 @option{--with-llsc} or @option{--without-llsc} when configuring GCC.
4158 Since the Linux kernel emulates these instructions if they are
4159 missing, the default for @samp{mips*-*-linux*} targets is
4160 @option{--with-llsc}.  The @option{--with-llsc} and
4161 @option{--without-llsc} configure options may be overridden at compile
4162 time by passing the @option{-mllsc} or @option{-mno-llsc} options to
4163 the compiler.
4165 MIPS systems check for division by zero (unless
4166 @option{-mno-check-zero-division} is passed to the compiler) by
4167 generating either a conditional trap or a break instruction.  Using
4168 trap results in smaller code, but is only supported on MIPS II and
4169 later.  Also, some versions of the Linux kernel have a bug that
4170 prevents trap from generating the proper signal (@code{SIGFPE}).  To enable
4171 the use of break, use the @option{--with-divide=breaks}
4172 @command{configure} option when configuring GCC@.  The default is to
4173 use traps on systems that support them.
4175 @html
4176 <hr />
4177 @end html
4178 @anchor{moxie-x-elf}
4179 @heading moxie-*-elf
4180 The moxie processor.
4182 @html
4183 <hr />
4184 @end html
4185 @anchor{msp430-x-elf}
4186 @heading msp430-*-elf
4187 TI MSP430 processor.
4188 This configuration is intended for embedded systems.
4190 @html
4191 <hr />
4192 @end html
4193 @anchor{nds32le-x-elf}
4194 @heading nds32le-*-elf
4195 Andes NDS32 target in little endian mode.
4197 @html
4198 <hr />
4199 @end html
4200 @anchor{nds32be-x-elf}
4201 @heading nds32be-*-elf
4202 Andes NDS32 target in big endian mode.
4204 @html
4205 <hr />
4206 @end html
4207 @anchor{nvptx-x-none}
4208 @heading nvptx-*-none
4209 Nvidia PTX target.
4211 Instead of GNU binutils, you will need to install
4212 @uref{https://github.com/MentorEmbedded/nvptx-tools/,,nvptx-tools}.
4213 Tell GCC where to find it:
4214 @option{--with-build-time-tools=[install-nvptx-tools]/nvptx-none/bin}.
4216 You will need newlib 3.0 git revision
4217 cd31fbb2aea25f94d7ecedc9db16dfc87ab0c316 or later.  It can be
4218 automatically built together with GCC@.  For this, add a symbolic link
4219 to nvptx-newlib's @file{newlib} directory to the directory containing
4220 the GCC sources.
4222 Use the @option{--disable-sjlj-exceptions} and
4223 @option{--enable-newlib-io-long-long} options when configuring.
4225 @html
4226 <hr />
4227 @end html
4228 @anchor{powerpc-x-x}
4229 @heading powerpc-*-*
4230 You can specify a default version for the @option{-mcpu=@var{cpu_type}}
4231 switch by using the configure option @option{--with-cpu-@var{cpu_type}}.
4233 You will need GNU binutils 2.15 or newer.
4235 @html
4236 <hr />
4237 @end html
4238 @anchor{powerpc-x-darwin}
4239 @heading powerpc-*-darwin*
4240 PowerPC running Darwin (Mac OS X kernel).
4242 Pre-installed versions of Mac OS X may not include any developer tools,
4243 meaning that you will not be able to build GCC from source.  Tool
4244 binaries are available at
4245 @uref{https://opensource.apple.com}.
4247 This version of GCC requires at least cctools-590.36.  The
4248 cctools-590.36 package referenced from
4249 @uref{http://gcc.gnu.org/ml/gcc/2006-03/msg00507.html} will not work
4250 on systems older than 10.3.9 (aka darwin7.9.0).
4252 @html
4253 <hr />
4254 @end html
4255 @anchor{powerpc-x-elf}
4256 @heading powerpc-*-elf
4257 PowerPC system in big endian mode, running System V.4.
4259 @html
4260 <hr />
4261 @end html
4262 @anchor{powerpc-x-linux-gnu}
4263 @heading powerpc*-*-linux-gnu*
4264 PowerPC system in big endian mode running Linux.
4266 @html
4267 <hr />
4268 @end html
4269 @anchor{powerpc-x-netbsd}
4270 @heading powerpc-*-netbsd*
4271 PowerPC system in big endian mode running NetBSD@.
4273 @html
4274 <hr />
4275 @end html
4276 @anchor{powerpc-x-eabisim}
4277 @heading powerpc-*-eabisim
4278 Embedded PowerPC system in big endian mode for use in running under the
4279 PSIM simulator.
4281 @html
4282 <hr />
4283 @end html
4284 @anchor{powerpc-x-eabi}
4285 @heading powerpc-*-eabi
4286 Embedded PowerPC system in big endian mode.
4288 @html
4289 <hr />
4290 @end html
4291 @anchor{powerpcle-x-elf}
4292 @heading powerpcle-*-elf
4293 PowerPC system in little endian mode, running System V.4.
4295 @html
4296 <hr />
4297 @end html
4298 @anchor{powerpcle-x-eabisim}
4299 @heading powerpcle-*-eabisim
4300 Embedded PowerPC system in little endian mode for use in running under
4301 the PSIM simulator.
4303 @html
4304 <hr />
4305 @end html
4306 @anchor{powerpcle-x-eabi}
4307 @heading powerpcle-*-eabi
4308 Embedded PowerPC system in little endian mode.
4310 @html
4311 <hr />
4312 @end html
4313 @anchor{rl78-x-elf}
4314 @heading rl78-*-elf
4315 The Renesas RL78 processor.
4316 This configuration is intended for embedded systems.
4318 @html
4319 <hr />
4320 @end html
4321 @anchor{riscv32-x-elf}
4322 @heading riscv32-*-elf
4323 The RISC-V RV32 instruction set.
4324 This configuration is intended for embedded systems.
4325 This (and all other RISC-V) targets are supported upstream as of the
4326 binutils 2.28 release.
4328 @html
4329 <hr />
4330 @end html
4331 @anchor{riscv32-x-linux}
4332 @heading riscv32-*-linux
4333 The RISC-V RV32 instruction set running GNU/Linux.
4334 This (and all other RISC-V) targets are supported upstream as of the
4335 binutils 2.28 release.
4337 @html
4338 <hr />
4339 @end html
4340 @anchor{riscv64-x-elf}
4341 @heading riscv64-*-elf
4342 The RISC-V RV64 instruction set.
4343 This configuration is intended for embedded systems.
4344 This (and all other RISC-V) targets are supported upstream as of the
4345 binutils 2.28 release.
4347 @html
4348 <hr />
4349 @end html
4350 @anchor{riscv64-x-linux}
4351 @heading riscv64-*-linux
4352 The RISC-V RV64 instruction set running GNU/Linux.
4353 This (and all other RISC-V) targets are supported upstream as of the
4354 binutils 2.28 release.
4356 @html
4357 <hr />
4358 @end html
4359 @anchor{rx-x-elf}
4360 @heading rx-*-elf
4361 The Renesas RX processor.
4363 @html
4364 <hr />
4365 @end html
4366 @anchor{s390-x-linux}
4367 @heading s390-*-linux*
4368 S/390 system running GNU/Linux for S/390@.
4370 @html
4371 <hr />
4372 @end html
4373 @anchor{s390x-x-linux}
4374 @heading s390x-*-linux*
4375 zSeries system (64-bit) running GNU/Linux for zSeries@.
4377 @html
4378 <hr />
4379 @end html
4380 @anchor{s390x-ibm-tpf}
4381 @heading s390x-ibm-tpf*
4382 zSeries system (64-bit) running TPF@.  This platform is
4383 supported as cross-compilation target only.
4385 @html
4386 <hr />
4387 @end html
4388 @c Please use Solaris 2 to refer to all release of Solaris, starting
4389 @c with 2.0 until 2.6, 7, 8, etc.  Solaris 1 was a marketing name for
4390 @c SunOS 4 releases which we don't use to avoid confusion.  Solaris
4391 @c alone is too unspecific and must be avoided.
4392 @anchor{x-x-solaris2}
4393 @heading *-*-solaris2*
4394 Support for Solaris 9 has been removed in GCC 5.  Support for Solaris
4395 8 has been removed in GCC 4.8.  Support for Solaris 7 has been removed
4396 in GCC 4.6.
4398 Sun does not ship a C compiler with Solaris 2 before Solaris 10, though
4399 you can download the Sun Studio compilers for free.  In Solaris 10 and
4400 11, GCC 3.4.3 is available as @command{/usr/sfw/bin/gcc}.  Solaris 11
4401 also provides GCC 4.5.2, 4.7.3, and 4.8.2 as
4402 @command{/usr/gcc/4.5/bin/gcc} or similar.  Alternatively,
4403 you can install a pre-built GCC to bootstrap and install GCC.  See the
4404 @uref{binaries.html,,binaries page} for details.
4406 The Solaris 2 @command{/bin/sh} will often fail to configure
4407 @samp{libstdc++-v3}or @samp{boehm-gc}.  We therefore recommend using the
4408 following initial sequence of commands
4410 @smallexample
4411 % CONFIG_SHELL=/bin/ksh
4412 % export CONFIG_SHELL
4413 @end smallexample
4415 @noindent
4416 and proceed as described in @uref{configure.html,,the configure instructions}.
4417 In addition we strongly recommend specifying an absolute path to invoke
4418 @command{@var{srcdir}/configure}.
4420 Solaris 10 comes with a number of optional OS packages.  Some of these
4421 are needed to use GCC fully, namely @code{SUNWarc},
4422 @code{SUNWbtool}, @code{SUNWesu}, @code{SUNWhea}, @code{SUNWlibm},
4423 @code{SUNWsprot}, and @code{SUNWtoo}.  If you did not install all
4424 optional packages when installing Solaris 10, you will need to verify that
4425 the packages that GCC needs are installed.
4426 To check whether an optional package is installed, use
4427 the @command{pkginfo} command.  To add an optional package, use the
4428 @command{pkgadd} command.  For further details, see the Solaris 10
4429 documentation.
4431 Starting with Solaris 11, the package management has changed, so you
4432 need to check for @code{system/header}, @code{system/linker}, and
4433 @code{developer/assembler} packages.  Checking for and installing
4434 packages is done with the @command{pkg} command now.
4436 Trying to use the linker and other tools in
4437 @file{/usr/ucb} to install GCC has been observed to cause trouble.
4438 For example, the linker may hang indefinitely.  The fix is to remove
4439 @file{/usr/ucb} from your @env{PATH}.
4441 The build process works more smoothly with the legacy Sun tools so, if you
4442 have @file{/usr/xpg4/bin} in your @env{PATH}, we recommend that you place
4443 @file{/usr/bin} before @file{/usr/xpg4/bin} for the duration of the build.
4445 We recommend the use of the Solaris assembler or the GNU assembler, in
4446 conjunction with the Solaris linker.  The GNU @command{as}
4447 versions included in Solaris 10, from GNU binutils 2.15 (in
4448 @file{/usr/sfw/bin/gas}), and Solaris 11,
4449 from GNU binutils 2.19 or newer (also in @file{/usr/bin/gas} and
4450 @file{/usr/gnu/bin/as}), are known to work.
4451 The current version, from GNU binutils 2.29,
4452 is known to work as well.  Note that your mileage may vary
4453 if you use a combination of the GNU tools and the Solaris tools: while the
4454 combination GNU @command{as} + Sun @command{ld} should reasonably work,
4455 the reverse combination Sun @command{as} + GNU @command{ld} may fail to
4456 build or cause memory corruption at runtime in some cases for C++ programs.
4457 @c FIXME: still?
4458 GNU @command{ld} usually works as well, although the version included in
4459 Solaris 10 cannot be used due to several bugs.  Again, the current
4460 version (2.29) is known to work, but generally lacks platform specific
4461 features, so better stay with Solaris @command{ld}.  To use the LTO linker
4462 plugin (@option{-fuse-linker-plugin}) with GNU @command{ld}, GNU
4463 binutils @emph{must} be configured with @option{--enable-largefile}.
4465 To enable symbol versioning in @samp{libstdc++} with the Solaris linker,
4466 you need to have any version of GNU @command{c++filt}, which is part of
4467 GNU binutils.  @samp{libstdc++} symbol versioning will be disabled if no
4468 appropriate version is found.  Solaris @command{c++filt} from the Solaris
4469 Studio compilers does @emph{not} work.
4471 Sun bug 4927647 sometimes causes random spurious testsuite failures
4472 related to missing diagnostic output.  This bug doesn't affect GCC
4473 itself, rather it is a kernel bug triggered by the @command{expect}
4474 program which is used only by the GCC testsuite driver.  When the bug
4475 causes the @command{expect} program to miss anticipated output, extra
4476 testsuite failures appear.
4478 @html
4479 <hr />
4480 @end html
4481 @anchor{sparc-x-x}
4482 @heading sparc*-*-*
4483 This section contains general configuration information for all
4484 SPARC-based platforms.  In addition to reading this section, please
4485 read all other sections that match your target.
4487 Newer versions of the GNU Multiple Precision Library (GMP), the MPFR
4488 library and the MPC library are known to be miscompiled by earlier
4489 versions of GCC on these platforms.  We therefore recommend the use
4490 of the exact versions of these libraries listed as minimal versions
4491 in @uref{prerequisites.html,,the prerequisites}.
4493 @html
4494 <hr />
4495 @end html
4496 @anchor{sparc-sun-solaris2}
4497 @heading sparc-sun-solaris2*
4498 When GCC is configured to use GNU binutils 2.14 or later, the binaries
4499 produced are smaller than the ones produced using Sun's native tools;
4500 this difference is quite significant for binaries containing debugging
4501 information.
4503 Starting with Solaris 7, the operating system is capable of executing
4504 64-bit SPARC V9 binaries.  GCC 3.1 and later properly supports
4505 this; the @option{-m64} option enables 64-bit code generation.
4506 However, if all you want is code tuned for the UltraSPARC CPU, you
4507 should try the @option{-mtune=ultrasparc} option instead, which produces
4508 code that, unlike full 64-bit code, can still run on non-UltraSPARC
4509 machines.
4511 When configuring the GNU Multiple Precision Library (GMP), the MPFR
4512 library or the MPC library on a Solaris 7 or later system, the canonical
4513 target triplet must be specified as the @command{build} parameter on the
4514 configure line.  This target triplet can be obtained by invoking @command{./config.guess} in the toplevel source directory of GCC (and
4515 not that of GMP or MPFR or MPC).  For example on a Solaris 9 system:
4517 @smallexample
4518 % ./configure --build=sparc-sun-solaris2.9 --prefix=xxx
4519 @end smallexample
4521 @html
4522 <hr />
4523 @end html
4524 @anchor{sparc-sun-solaris210}
4525 @heading sparc-sun-solaris2.10
4526 There is a bug in older versions of the Sun assembler which breaks
4527 thread-local storage (TLS).  A typical error message is
4529 @smallexample
4530 ld: fatal: relocation error: R_SPARC_TLS_LE_HIX22: file /var/tmp//ccamPA1v.o:
4531   symbol <unknown>: bad symbol type SECT: symbol type must be TLS
4532 @end smallexample
4534 @noindent
4535 This bug is fixed in Sun patch 118683-03 or later.
4537 @html
4538 <hr />
4539 @end html
4540 @anchor{sparc-x-linux}
4541 @heading sparc-*-linux*
4543 @html
4544 <hr />
4545 @end html
4546 @anchor{sparc64-x-solaris2}
4547 @heading sparc64-*-solaris2*
4548 When configuring the GNU Multiple Precision Library (GMP), the MPFR
4549 library or the MPC library, the canonical target triplet must be specified
4550 as the @command{build} parameter on the configure line.  For example
4551 on a Solaris 9 system:
4553 @smallexample
4554 % ./configure --build=sparc64-sun-solaris2.9 --prefix=xxx
4555 @end smallexample
4557 @html
4558 <hr />
4559 @end html
4560 @anchor{sparcv9-x-solaris2}
4561 @heading sparcv9-*-solaris2*
4562 This is a synonym for @samp{sparc64-*-solaris2*}.
4564 @html
4565 <hr />
4566 @end html
4567 @anchor{c6x-x-x}
4568 @heading c6x-*-*
4569 The C6X family of processors. This port requires binutils-2.22 or newer.
4571 @html
4572 <hr />
4573 @end html
4574 @anchor{tilegx-*-linux}
4575 @heading tilegx-*-linux*
4576 The TILE-Gx processor in little endian mode, running GNU/Linux.  This
4577 port requires binutils-2.22 or newer.
4579 @html
4580 <hr />
4581 @end html
4582 @anchor{tilegxbe-*-linux}
4583 @heading tilegxbe-*-linux*
4584 The TILE-Gx processor in big endian mode, running GNU/Linux.  This
4585 port requires binutils-2.23 or newer.
4587 @html
4588 <hr />
4589 @end html
4590 @anchor{tilepro-*-linux}
4591 @heading tilepro-*-linux*
4592 The TILEPro processor running GNU/Linux.  This port requires
4593 binutils-2.22 or newer.
4595 @html
4596 <hr />
4597 @end html
4598 @anchor{visium-x-elf}
4599 @heading visium-*-elf
4600 CDS VISIUMcore processor.
4601 This configuration is intended for embedded systems.
4603 @html
4604 <hr />
4605 @end html
4606 @anchor{x-x-vxworks}
4607 @heading *-*-vxworks*
4608 Support for VxWorks is in flux.  At present GCC supports @emph{only} the
4609 very recent VxWorks 5.5 (aka Tornado 2.2) release, and only on PowerPC@.
4610 We welcome patches for other architectures supported by VxWorks 5.5.
4611 Support for VxWorks AE would also be welcome; we believe this is merely
4612 a matter of writing an appropriate ``configlette'' (see below).  We are
4613 not interested in supporting older, a.out or COFF-based, versions of
4614 VxWorks in GCC 3.
4616 VxWorks comes with an older version of GCC installed in
4617 @file{@var{$WIND_BASE}/host}; we recommend you do not overwrite it.
4618 Choose an installation @var{prefix} entirely outside @var{$WIND_BASE}.
4619 Before running @command{configure}, create the directories @file{@var{prefix}}
4620 and @file{@var{prefix}/bin}.  Link or copy the appropriate assembler,
4621 linker, etc.@: into @file{@var{prefix}/bin}, and set your @var{PATH} to
4622 include that directory while running both @command{configure} and
4623 @command{make}.
4625 You must give @command{configure} the
4626 @option{--with-headers=@var{$WIND_BASE}/target/h} switch so that it can
4627 find the VxWorks system headers.  Since VxWorks is a cross compilation
4628 target only, you must also specify @option{--target=@var{target}}.
4629 @command{configure} will attempt to create the directory
4630 @file{@var{prefix}/@var{target}/sys-include} and copy files into it;
4631 make sure the user running @command{configure} has sufficient privilege
4632 to do so.
4634 GCC's exception handling runtime requires a special ``configlette''
4635 module, @file{contrib/gthr_supp_vxw_5x.c}.  Follow the instructions in
4636 that file to add the module to your kernel build.  (Future versions of
4637 VxWorks will incorporate this module.)
4639 @html
4640 <hr />
4641 @end html
4642 @anchor{x86-64-x-x}
4643 @heading x86_64-*-*, amd64-*-*
4644 GCC supports the x86-64 architecture implemented by the AMD64 processor
4645 (amd64-*-* is an alias for x86_64-*-*) on GNU/Linux, FreeBSD and NetBSD@.
4646 On GNU/Linux the default is a bi-arch compiler which is able to generate
4647 both 64-bit x86-64 and 32-bit x86 code (via the @option{-m32} switch).
4649 @html
4650 <hr />
4651 @end html
4652 @anchor{x86-64-x-solaris210}
4653 @heading x86_64-*-solaris2.1[0-9]*
4654 GCC also supports the x86-64 architecture implemented by the AMD64
4655 processor (@samp{amd64-*-*} is an alias for @samp{x86_64-*-*}) on
4656 Solaris 10 or later.  Unlike other systems, without special options a
4657 bi-arch compiler is built which generates 32-bit code by default, but
4658 can generate 64-bit x86-64 code with the @option{-m64} switch.  Since
4659 GCC 4.7, there is also a configuration that defaults to 64-bit code, but
4660 can generate 32-bit code with @option{-m32}.  To configure and build
4661 this way, you have to provide all support libraries like @file{libgmp}
4662 as 64-bit code, configure with @option{--target=x86_64-pc-solaris2.1x}
4663 and @samp{CC=gcc -m64}.
4665 @html
4666 <hr />
4667 @end html
4668 @anchor{xtensa-x-elf}
4669 @heading xtensa*-*-elf
4670 This target is intended for embedded Xtensa systems using the
4671 @samp{newlib} C library.  It uses ELF but does not support shared
4672 objects.  Designed-defined instructions specified via the
4673 Tensilica Instruction Extension (TIE) language are only supported
4674 through inline assembly.
4676 The Xtensa configuration information must be specified prior to
4677 building GCC@.  The @file{include/xtensa-config.h} header
4678 file contains the configuration information.  If you created your
4679 own Xtensa configuration with the Xtensa Processor Generator, the
4680 downloaded files include a customized copy of this header file,
4681 which you can use to replace the default header file.
4683 @html
4684 <hr />
4685 @end html
4686 @anchor{xtensa-x-linux}
4687 @heading xtensa*-*-linux*
4688 This target is for Xtensa systems running GNU/Linux.  It supports ELF
4689 shared objects and the GNU C library (glibc).  It also generates
4690 position-independent code (PIC) regardless of whether the
4691 @option{-fpic} or @option{-fPIC} options are used.  In other
4692 respects, this target is the same as the
4693 @uref{#xtensa*-*-elf,,@samp{xtensa*-*-elf}} target.
4695 @html
4696 <hr />
4697 @end html
4698 @anchor{windows}
4699 @heading Microsoft Windows
4701 @subheading Intel 16-bit versions
4702 The 16-bit versions of Microsoft Windows, such as Windows 3.1, are not
4703 supported.
4705 However, the 32-bit port has limited support for Microsoft
4706 Windows 3.11 in the Win32s environment, as a target only.  See below.
4708 @subheading Intel 32-bit versions
4709 The 32-bit versions of Windows, including Windows 95, Windows NT, Windows
4710 XP, and Windows Vista, are supported by several different target
4711 platforms.  These targets differ in which Windows subsystem they target
4712 and which C libraries are used.
4714 @itemize
4715 @item Cygwin @uref{#x-x-cygwin,,*-*-cygwin}: Cygwin provides a user-space
4716 Linux API emulation layer in the Win32 subsystem.
4717 @item MinGW @uref{#x-x-mingw32,,*-*-mingw32}: MinGW is a native GCC port for
4718 the Win32 subsystem that provides a subset of POSIX.
4719 @item MKS i386-pc-mks: NuTCracker from MKS.  See
4720 @uref{https://www.mkssoftware.com} for more information.
4721 @end itemize
4723 @subheading Intel 64-bit versions
4724 GCC contains support for x86-64 using the mingw-w64
4725 runtime library, available from @uref{http://mingw-w64.org/doku.php}.
4726 This library should be used with the target triple x86_64-pc-mingw32.
4728 Presently Windows for Itanium is not supported.
4730 @subheading Windows CE
4731 Windows CE is supported as a target only on Hitachi
4732 SuperH (sh-wince-pe), and MIPS (mips-wince-pe).
4734 @subheading Other Windows Platforms
4735 GCC no longer supports Windows NT on the Alpha or PowerPC.
4737 GCC no longer supports the Windows POSIX subsystem.  However, it does
4738 support the Interix subsystem.  See above.
4740 Old target names including *-*-winnt and *-*-windowsnt are no longer used.
4742 PW32 (i386-pc-pw32) support was never completed, and the project seems to
4743 be inactive.  See @uref{http://pw32.sourceforge.net/} for more information.
4745 UWIN support has been removed due to a lack of maintenance.
4747 @html
4748 <hr />
4749 @end html
4750 @anchor{x-x-cygwin}
4751 @heading *-*-cygwin
4752 Ports of GCC are included with the
4753 @uref{http://www.cygwin.com/,,Cygwin environment}.
4755 GCC will build under Cygwin without modification; it does not build
4756 with Microsoft's C++ compiler and there are no plans to make it do so.
4758 The Cygwin native compiler can be configured to target any 32-bit x86
4759 cpu architecture desired; the default is i686-pc-cygwin.  It should be
4760 used with as up-to-date a version of binutils as possible; use either
4761 the latest official GNU binutils release in the Cygwin distribution,
4762 or version 2.20 or above if building your own.
4764 @html
4765 <hr />
4766 @end html
4767 @anchor{x-x-mingw32}
4768 @heading *-*-mingw32
4769 GCC will build with and support only MinGW runtime 3.12 and later.
4770 Earlier versions of headers are incompatible with the new default semantics
4771 of @code{extern inline} in @code{-std=c99} and @code{-std=gnu99} modes.
4773 @html
4774 <hr />
4775 @end html
4776 @anchor{older}
4777 @heading Older systems
4778 GCC contains support files for many older (1980s and early
4779 1990s) Unix variants.  For the most part, support for these systems
4780 has not been deliberately removed, but it has not been maintained for
4781 several years and may suffer from bitrot.
4783 Starting with GCC 3.1, each release has a list of ``obsoleted'' systems.
4784 Support for these systems is still present in that release, but
4785 @command{configure} will fail unless the @option{--enable-obsolete}
4786 option is given.  Unless a maintainer steps forward, support for these
4787 systems will be removed from the next release of GCC@.
4789 Support for old systems as hosts for GCC can cause problems if the
4790 workarounds for compiler, library and operating system bugs affect the
4791 cleanliness or maintainability of the rest of GCC@.  In some cases, to
4792 bring GCC up on such a system, if still possible with current GCC, may
4793 require first installing an old version of GCC which did work on that
4794 system, and using it to compile a more recent GCC, to avoid bugs in the
4795 vendor compiler.  Old releases of GCC 1 and GCC 2 are available in the
4796 @file{old-releases} directory on the @uref{../mirrors.html,,GCC mirror
4797 sites}.  Header bugs may generally be avoided using
4798 @command{fixincludes}, but bugs or deficiencies in libraries and the
4799 operating system may still cause problems.
4801 Support for older systems as targets for cross-compilation is less
4802 problematic than support for them as hosts for GCC; if an enthusiast
4803 wishes to make such a target work again (including resurrecting any of
4804 the targets that never worked with GCC 2, starting from the last
4805 version before they were removed), patches
4806 @uref{../contribute.html,,following the usual requirements} would be
4807 likely to be accepted, since they should not affect the support for more
4808 modern targets.
4810 For some systems, old versions of GNU binutils may also be useful,
4811 and are available from @file{pub/binutils/old-releases} on
4812 @uref{https://sourceware.org/mirrors.html,,sourceware.org mirror sites}.
4814 Some of the information on specific systems above relates to
4815 such older systems, but much of the information
4816 about GCC on such systems (which may no longer be applicable to
4817 current GCC) is to be found in the GCC texinfo manual.
4819 @html
4820 <hr />
4821 @end html
4822 @anchor{elf}
4823 @heading all ELF targets (SVR4, Solaris 2, etc.)
4824 C++ support is significantly better on ELF targets if you use the
4825 @uref{./configure.html#with-gnu-ld,,GNU linker}; duplicate copies of
4826 inlines, vtables and template instantiations will be discarded
4827 automatically.
4830 @html
4831 <hr />
4833 @end html
4834 @ifhtml
4835 @uref{./index.html,,Return to the GCC Installation page}
4836 @end ifhtml
4837 @end ifset
4839 @c ***Old documentation******************************************************
4840 @ifset oldhtml
4841 @include install-old.texi
4842 @html
4843 <hr />
4845 @end html
4846 @ifhtml
4847 @uref{./index.html,,Return to the GCC Installation page}
4848 @end ifhtml
4849 @end ifset
4851 @c ***GFDL********************************************************************
4852 @ifset gfdlhtml
4853 @include fdl.texi
4854 @html
4855 <hr />
4857 @end html
4858 @ifhtml
4859 @uref{./index.html,,Return to the GCC Installation page}
4860 @end ifhtml
4861 @end ifset
4863 @c ***************************************************************************
4864 @c Part 6 The End of the Document
4865 @ifinfo
4866 @comment node-name,     next,          previous, up
4867 @node    Concept Index, , GNU Free Documentation License, Top
4868 @end ifinfo
4870 @ifinfo
4871 @unnumbered Concept Index
4873 @printindex cp
4875 @contents
4876 @end ifinfo
4877 @bye