PR inline-asm/84742
[official-gcc.git] / gcc / doc / install.texi
blob64ad2445a335f270200e359812bc9d2213bd2405
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*-*-*, sh*-*-* and x86-64-*-linux*.  The accepted values and meaning
1076 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 sh*-*-*
1132 @var{list} is a comma separated list of CPU names.  These must be of the
1133 form @code{sh*} or @code{m*} (in which case they match the compiler option
1134 for that processor).  The list should not contain any endian options -
1135 these are handled by @option{--with-endian}.
1137 If @var{list} is empty, then there will be no multilibs for extra
1138 processors.  The multilib for the secondary endian remains enabled.
1140 As a special case, if an entry in the list starts with a @code{!}
1141 (exclamation point), then it is added to the list of excluded multilibs.
1142 Entries of this sort should be compatible with @samp{MULTILIB_EXCLUDES}
1143 (once the leading @code{!} has been stripped).
1145 If @option{--with-multilib-list} is not given, then a default set of
1146 multilibs is selected based on the value of @option{--target}.  This is
1147 usually the complete set of libraries, but some targets imply a more
1148 specialized subset.
1150 Example 1: to configure a compiler for SH4A only, but supporting both
1151 endians, with little endian being the default:
1152 @smallexample
1153 --with-cpu=sh4a --with-endian=little,big --with-multilib-list=
1154 @end smallexample
1156 Example 2: to configure a compiler for both SH4A and SH4AL-DSP, but with
1157 only little endian SH4AL:
1158 @smallexample
1159 --with-cpu=sh4a --with-endian=little,big \
1160 --with-multilib-list=sh4al,!mb/m4al
1161 @end smallexample
1163 @item x86-64-*-linux*
1164 @var{list} is a comma separated list of @code{m32}, @code{m64} and
1165 @code{mx32} to enable 32-bit, 64-bit and x32 run-time libraries,
1166 respectively.  If @var{list} is empty, then there will be no multilibs
1167 and only the default run-time library will be enabled.
1169 If @option{--with-multilib-list} is not given, then only 32-bit and
1170 64-bit run-time libraries will be enabled.
1171 @end table
1173 @item --with-endian=@var{endians}
1174 Specify what endians to use.
1175 Currently only implemented for sh*-*-*.
1177 @var{endians} may be one of the following:
1178 @table @code
1179 @item big
1180 Use big endian exclusively.
1181 @item little
1182 Use little endian exclusively.
1183 @item big,little
1184 Use big endian by default.  Provide a multilib for little endian.
1185 @item little,big
1186 Use little endian by default.  Provide a multilib for big endian.
1187 @end table
1189 @item --enable-threads
1190 Specify that the target
1191 supports threads.  This affects the Objective-C compiler and runtime
1192 library, and exception handling for other languages like C++.
1193 On some systems, this is the default.
1195 In general, the best (and, in many cases, the only known) threading
1196 model available will be configured for use.  Beware that on some
1197 systems, GCC has not been taught what threading models are generally
1198 available for the system.  In this case, @option{--enable-threads} is an
1199 alias for @option{--enable-threads=single}.
1201 @item --disable-threads
1202 Specify that threading support should be disabled for the system.
1203 This is an alias for @option{--enable-threads=single}.
1205 @item --enable-threads=@var{lib}
1206 Specify that
1207 @var{lib} is the thread support library.  This affects the Objective-C
1208 compiler and runtime library, and exception handling for other languages
1209 like C++.  The possibilities for @var{lib} are:
1211 @table @code
1212 @item aix
1213 AIX thread support.
1214 @item dce
1215 DCE thread support.
1216 @item lynx
1217 LynxOS thread support.
1218 @item mipssde
1219 MIPS SDE thread support.
1220 @item no
1221 This is an alias for @samp{single}.
1222 @item posix
1223 Generic POSIX/Unix98 thread support.
1224 @item rtems
1225 RTEMS thread support.
1226 @item single
1227 Disable thread support, should work for all platforms.
1228 @item tpf
1229 TPF thread support.
1230 @item vxworks
1231 VxWorks thread support.
1232 @item win32
1233 Microsoft Win32 API thread support.
1234 @end table
1236 @item --enable-tls
1237 Specify that the target supports TLS (Thread Local Storage).  Usually
1238 configure can correctly determine if TLS is supported.  In cases where
1239 it guesses incorrectly, TLS can be explicitly enabled or disabled with
1240 @option{--enable-tls} or @option{--disable-tls}.  This can happen if
1241 the assembler supports TLS but the C library does not, or if the
1242 assumptions made by the configure test are incorrect.
1244 @item --disable-tls
1245 Specify that the target does not support TLS.
1246 This is an alias for @option{--enable-tls=no}.
1248 @item --with-cpu=@var{cpu}
1249 @itemx --with-cpu-32=@var{cpu}
1250 @itemx --with-cpu-64=@var{cpu}
1251 Specify which cpu variant the compiler should generate code for by default.
1252 @var{cpu} will be used as the default value of the @option{-mcpu=} switch.
1253 This option is only supported on some targets, including ARC, ARM, i386, M68k,
1254 PowerPC, and SPARC@.  It is mandatory for ARC@.  The @option{--with-cpu-32} and
1255 @option{--with-cpu-64} options specify separate default CPUs for
1256 32-bit and 64-bit modes; these options are only supported for i386,
1257 x86-64, PowerPC, and SPARC@.
1259 @item --with-schedule=@var{cpu}
1260 @itemx --with-arch=@var{cpu}
1261 @itemx --with-arch-32=@var{cpu}
1262 @itemx --with-arch-64=@var{cpu}
1263 @itemx --with-tune=@var{cpu}
1264 @itemx --with-tune-32=@var{cpu}
1265 @itemx --with-tune-64=@var{cpu}
1266 @itemx --with-abi=@var{abi}
1267 @itemx --with-fpu=@var{type}
1268 @itemx --with-float=@var{type}
1269 These configure options provide default values for the @option{-mschedule=},
1270 @option{-march=}, @option{-mtune=}, @option{-mabi=}, and @option{-mfpu=}
1271 options and for @option{-mhard-float} or @option{-msoft-float}.  As with
1272 @option{--with-cpu}, which switches will be accepted and acceptable values
1273 of the arguments depend on the target.
1275 @item --with-mode=@var{mode}
1276 Specify if the compiler should default to @option{-marm} or @option{-mthumb}.
1277 This option is only supported on ARM targets.
1279 @item --with-stack-offset=@var{num}
1280 This option sets the default for the -mstack-offset=@var{num} option,
1281 and will thus generally also control the setting of this option for
1282 libraries.  This option is only supported on Epiphany targets.
1284 @item --with-fpmath=@var{isa}
1285 This options sets @option{-mfpmath=sse} by default and specifies the default
1286 ISA for floating-point arithmetics.  You can select either @samp{sse} which
1287 enables @option{-msse2} or @samp{avx} which enables @option{-mavx} by default.
1288 This option is only supported on i386 and x86-64 targets.
1290 @item --with-fp-32=@var{mode}
1291 On MIPS targets, set the default value for the @option{-mfp} option when using
1292 the o32 ABI.  The possibilities for @var{mode} are:
1293 @table @code
1294 @item 32
1295 Use the o32 FP32 ABI extension, as with the @option{-mfp32} command-line
1296 option.
1297 @item xx
1298 Use the o32 FPXX ABI extension, as with the @option{-mfpxx} command-line
1299 option.
1300 @item 64
1301 Use the o32 FP64 ABI extension, as with the @option{-mfp64} command-line
1302 option.
1303 @end table
1304 In the absence of this configuration option the default is to use the o32
1305 FP32 ABI extension.
1307 @item --with-odd-spreg-32
1308 On MIPS targets, set the @option{-modd-spreg} option by default when using
1309 the o32 ABI.
1311 @item --without-odd-spreg-32
1312 On MIPS targets, set the @option{-mno-odd-spreg} option by default when using
1313 the o32 ABI.  This is normally used in conjunction with
1314 @option{--with-fp-32=64} in order to target the o32 FP64A ABI extension.
1316 @item --with-nan=@var{encoding}
1317 On MIPS targets, set the default encoding convention to use for the
1318 special not-a-number (NaN) IEEE 754 floating-point data.  The
1319 possibilities for @var{encoding} are:
1320 @table @code
1321 @item legacy
1322 Use the legacy encoding, as with the @option{-mnan=legacy} command-line
1323 option.
1324 @item 2008
1325 Use the 754-2008 encoding, as with the @option{-mnan=2008} command-line
1326 option.
1327 @end table
1328 To use this configuration option you must have an assembler version
1329 installed that supports the @option{-mnan=} command-line option too.
1330 In the absence of this configuration option the default convention is
1331 the legacy encoding, as when neither of the @option{-mnan=2008} and
1332 @option{-mnan=legacy} command-line options has been used.
1334 @item --with-divide=@var{type}
1335 Specify how the compiler should generate code for checking for
1336 division by zero.  This option is only supported on the MIPS target.
1337 The possibilities for @var{type} are:
1338 @table @code
1339 @item traps
1340 Division by zero checks use conditional traps (this is the default on
1341 systems that support conditional traps).
1342 @item breaks
1343 Division by zero checks use the break instruction.
1344 @end table
1346 @c If you make --with-llsc the default for additional targets,
1347 @c update the --with-llsc description in the MIPS section below.
1349 @item --with-llsc
1350 On MIPS targets, make @option{-mllsc} the default when no
1351 @option{-mno-llsc} option is passed.  This is the default for
1352 Linux-based targets, as the kernel will emulate them if the ISA does
1353 not provide them.
1355 @item --without-llsc
1356 On MIPS targets, make @option{-mno-llsc} the default when no
1357 @option{-mllsc} option is passed.
1359 @item --with-synci
1360 On MIPS targets, make @option{-msynci} the default when no
1361 @option{-mno-synci} option is passed.
1363 @item --without-synci
1364 On MIPS targets, make @option{-mno-synci} the default when no
1365 @option{-msynci} option is passed.  This is the default.
1367 @item --with-lxc1-sxc1
1368 On MIPS targets, make @option{-mlxc1-sxc1} the default when no
1369 @option{-mno-lxc1-sxc1} option is passed.  This is the default.
1371 @item --without-lxc1-sxc1
1372 On MIPS targets, make @option{-mno-lxc1-sxc1} the default when no
1373 @option{-mlxc1-sxc1} option is passed.  The indexed load/store
1374 instructions are not directly a problem but can lead to unexpected
1375 behaviour when deployed in an application intended for a 32-bit address
1376 space but run on a 64-bit processor.  The issue is seen because all
1377 known MIPS 64-bit Linux kernels execute o32 and n32 applications
1378 with 64-bit addressing enabled which affects the overflow behaviour
1379 of the indexed addressing mode.  GCC will assume that ordinary
1380 32-bit arithmetic overflow behaviour is the same whether performed
1381 as an @code{addu} instruction or as part of the address calculation
1382 in @code{lwxc1} type instructions.  This assumption holds true in a
1383 pure 32-bit environment and can hold true in a 64-bit environment if
1384 the address space is accurately set to be 32-bit for o32 and n32.
1386 @item --with-madd4
1387 On MIPS targets, make @option{-mmadd4} the default when no
1388 @option{-mno-madd4} option is passed.  This is the default.
1390 @item --without-madd4
1391 On MIPS targets, make @option{-mno-madd4} the default when no
1392 @option{-mmadd4} option is passed.  The @code{madd4} instruction
1393 family can be problematic when targeting a combination of cores that
1394 implement these instructions differently.  There are two known cores
1395 that implement these as fused operations instead of unfused (where
1396 unfused is normally expected).  Disabling these instructions is the
1397 only way to ensure compatible code is generated; this will incur
1398 a performance penalty.
1400 @item --with-mips-plt
1401 On MIPS targets, make use of copy relocations and PLTs.
1402 These features are extensions to the traditional
1403 SVR4-based MIPS ABIs and require support from GNU binutils
1404 and the runtime C library.
1406 @item --enable-__cxa_atexit
1407 Define if you want to use __cxa_atexit, rather than atexit, to
1408 register C++ destructors for local statics and global objects.
1409 This is essential for fully standards-compliant handling of
1410 destructors, but requires __cxa_atexit in libc.  This option is currently
1411 only available on systems with GNU libc.  When enabled, this will cause
1412 @option{-fuse-cxa-atexit} to be passed by default.
1414 @item --enable-gnu-indirect-function
1415 Define if you want to enable the @code{ifunc} attribute.  This option is
1416 currently only available on systems with GNU libc on certain targets.
1418 @item --enable-target-optspace
1419 Specify that target
1420 libraries should be optimized for code space instead of code speed.
1421 This is the default for the m32r platform.
1423 @item --with-cpp-install-dir=@var{dirname}
1424 Specify that the user visible @command{cpp} program should be installed
1425 in @file{@var{prefix}/@var{dirname}/cpp}, in addition to @var{bindir}.
1427 @item --enable-comdat
1428 Enable COMDAT group support.  This is primarily used to override the
1429 automatically detected value.
1431 @item --enable-initfini-array
1432 Force the use of sections @code{.init_array} and @code{.fini_array}
1433 (instead of @code{.init} and @code{.fini}) for constructors and
1434 destructors.  Option @option{--disable-initfini-array} has the
1435 opposite effect.  If neither option is specified, the configure script
1436 will try to guess whether the @code{.init_array} and
1437 @code{.fini_array} sections are supported and, if they are, use them.
1439 @item --enable-link-mutex
1440 When building GCC, use a mutex to avoid linking the compilers for
1441 multiple languages at the same time, to avoid thrashing on build
1442 systems with limited free memory.  The default is not to use such a mutex.
1444 @item --enable-maintainer-mode
1445 The build rules that regenerate the Autoconf and Automake output files as
1446 well as the GCC master message catalog @file{gcc.pot} are normally
1447 disabled.  This is because it can only be rebuilt if the complete source
1448 tree is present.  If you have changed the sources and want to rebuild the
1449 catalog, configuring with @option{--enable-maintainer-mode} will enable
1450 this.  Note that you need a recent version of the @code{gettext} tools
1451 to do so.
1453 @item --disable-bootstrap
1454 For a native build, the default configuration is to perform
1455 a 3-stage bootstrap of the compiler when @samp{make} is invoked,
1456 testing that GCC can compile itself correctly.  If you want to disable
1457 this process, you can configure with @option{--disable-bootstrap}.
1459 @item --enable-bootstrap
1460 In special cases, you may want to perform a 3-stage build
1461 even if the target and host triplets are different.
1462 This is possible when the host can run code compiled for
1463 the target (e.g.@: host is i686-linux, target is i486-linux).
1464 Starting from GCC 4.2, to do this you have to configure explicitly
1465 with @option{--enable-bootstrap}.
1467 @item --enable-generated-files-in-srcdir
1468 Neither the .c and .h files that are generated from Bison and flex nor the
1469 info manuals and man pages that are built from the .texi files are present
1470 in the SVN development tree.  When building GCC from that development tree,
1471 or from one of our snapshots, those generated files are placed in your
1472 build directory, which allows for the source to be in a readonly
1473 directory.
1475 If you configure with @option{--enable-generated-files-in-srcdir} then those
1476 generated files will go into the source directory.  This is mainly intended
1477 for generating release or prerelease tarballs of the GCC sources, since it
1478 is not a requirement that the users of source releases to have flex, Bison,
1479 or makeinfo.
1481 @item --enable-version-specific-runtime-libs
1482 Specify
1483 that runtime libraries should be installed in the compiler specific
1484 subdirectory (@file{@var{libdir}/gcc}) rather than the usual places.  In
1485 addition, @samp{libstdc++}'s include files will be installed into
1486 @file{@var{libdir}} unless you overruled it by using
1487 @option{--with-gxx-include-dir=@var{dirname}}.  Using this option is
1488 particularly useful if you intend to use several versions of GCC in
1489 parallel.  This is currently supported by @samp{libgfortran},
1490 @samp{libstdc++}, and @samp{libobjc}.
1492 @item @anchor{WithAixSoname}--with-aix-soname=@samp{aix}, @samp{svr4} or @samp{both}
1493 Traditional AIX shared library versioning (versioned @code{Shared Object}
1494 files as members of unversioned @code{Archive Library} files named
1495 @samp{lib.a}) causes numerous headaches for package managers. However,
1496 @code{Import Files} as members of @code{Archive Library} files allow for
1497 @strong{filename-based versioning} of shared libraries as seen on Linux/SVR4,
1498 where this is called the "SONAME". But as they prevent static linking,
1499 @code{Import Files} may be used with @code{Runtime Linking} only, where the
1500 linker does search for @samp{libNAME.so} before @samp{libNAME.a} library
1501 filenames with the @samp{-lNAME} linker flag.
1503 @anchor{AixLdCommand}For detailed information please refer to the AIX
1504 @uref{https://www.ibm.com/support/knowledgecenter/search/%22the%20ld%20command%2C%20also%20called%20the%20linkage%20editor%20or%20binder%22,,ld
1505 Command} reference.
1507 As long as shared library creation is enabled, upon:
1508 @table @code
1509 @item --with-aix-soname=aix
1510 @item --with-aix-soname=both
1511  A (traditional AIX) @code{Shared Archive Library} file is created:
1512  @itemize @bullet
1513   @item using the @samp{libNAME.a} filename scheme
1514   @item with the @code{Shared Object} file as archive member named
1515   @samp{libNAME.so.V} (except for @samp{libgcc_s}, where the @code{Shared
1516   Object} file is named @samp{shr.o} for backwards compatibility), which
1517   @itemize @minus
1518    @item is used for runtime loading from inside the @samp{libNAME.a} file
1519    @item is used for dynamic loading via
1520    @code{dlopen("libNAME.a(libNAME.so.V)", RTLD_MEMBER)}
1521    @item is used for shared linking
1522    @item is used for static linking, so no separate @code{Static Archive
1523    Library} file is needed
1524   @end itemize
1525  @end itemize
1526 @item --with-aix-soname=both
1527 @item --with-aix-soname=svr4
1528  A (second) @code{Shared Archive Library} file is created:
1529  @itemize @bullet
1530  @item using the @samp{libNAME.so.V} filename scheme
1531  @item with the @code{Shared Object} file as archive member named
1532  @samp{shr.o}, which
1533   @itemize @minus
1534    @item is created with the @code{-G linker flag}
1535    @item has the @code{F_LOADONLY} flag set
1536    @item is used for runtime loading from inside the @samp{libNAME.so.V} file
1537    @item is used for dynamic loading via @code{dlopen("libNAME.so.V(shr.o)",
1538    RTLD_MEMBER)}
1539   @end itemize
1540  @item with the @code{Import File} as archive member named @samp{shr.imp},
1541  which
1542   @itemize @minus
1543    @item refers to @samp{libNAME.so.V(shr.o)} as the "SONAME", to be recorded
1544    in the @code{Loader Section} of subsequent binaries
1545    @item indicates whether @samp{libNAME.so.V(shr.o)} is 32 or 64 bit
1546    @item lists all the public symbols exported by @samp{lib.so.V(shr.o)},
1547    eventually decorated with the @code{@samp{weak} Keyword}
1548    @item is necessary for shared linking against @samp{lib.so.V(shr.o)}
1549    @end itemize
1550   @end itemize
1551   A symbolic link using the @samp{libNAME.so} filename scheme is created:
1552   @itemize @bullet
1553   @item pointing to the @samp{libNAME.so.V} @code{Shared Archive Library} file
1554   @item to permit the @code{ld Command} to find @samp{lib.so.V(shr.imp)} via
1555   the @samp{-lNAME} argument (requires @code{Runtime Linking} to be enabled)
1556   @item to permit dynamic loading of @samp{lib.so.V(shr.o)} without the need
1557   to specify the version number via @code{dlopen("libNAME.so(shr.o)",
1558   RTLD_MEMBER)}
1559   @end itemize
1560 @end table
1562 As long as static library creation is enabled, upon:
1563 @table @code
1564 @item --with-aix-soname=svr4
1565  A @code{Static Archive Library} is created:
1566  @itemize @bullet
1567  @item using the @samp{libNAME.a} filename scheme
1568  @item with all the @code{Static Object} files as archive members, which
1569   @itemize @minus
1570    @item are used for static linking
1571   @end itemize
1572  @end itemize
1573 @end table
1575 While the aix-soname=@samp{svr4} option does not create @code{Shared Object}
1576 files as members of unversioned @code{Archive Library} files any more, package
1577 managers still are responsible to
1578 @uref{./specific.html#TransferAixShobj,,transfer} @code{Shared Object} files
1579 found as member of a previously installed unversioned @code{Archive Library}
1580 file into the newly installed @code{Archive Library} file with the same
1581 filename.
1583 @emph{WARNING:} Creating @code{Shared Object} files with @code{Runtime Linking}
1584 enabled may bloat the TOC, eventually leading to @code{TOC overflow} errors,
1585 requiring the use of either the @option{-Wl,-bbigtoc} linker flag (seen to
1586 break with the @code{GDB} debugger) or some of the TOC-related compiler flags,
1587 @ifnothtml
1588 @xref{RS/6000 and PowerPC Options,, RS/6000 and PowerPC Options, gcc,
1589 Using the GNU Compiler Collection (GCC)}.
1590 @end ifnothtml
1591 @ifhtml
1592 see ``RS/6000 and PowerPC Options'' in the main manual.
1593 @end ifhtml
1595 @option{--with-aix-soname} is currently supported by @samp{libgcc_s} only, so
1596 this option is still experimental and not for normal use yet.
1598 Default is the traditional behavior @option{--with-aix-soname=@samp{aix}}.
1600 @item --enable-languages=@var{lang1},@var{lang2},@dots{}
1601 Specify that only a particular subset of compilers and
1602 their runtime libraries should be built.  For a list of valid values for
1603 @var{langN} you can issue the following command in the
1604 @file{gcc} directory of your GCC source tree:@*
1605 @smallexample
1606 grep ^language= */config-lang.in
1607 @end smallexample
1608 Currently, you can use any of the following:
1609 @code{all}, @code{default}, @code{ada}, @code{c}, @code{c++}, @code{fortran},
1610 @code{go}, @code{jit}, @code{lto}, @code{objc}, @code{obj-c++}.
1611 Building the Ada compiler has special requirements, see below.
1612 If you do not pass this flag, or specify the option @code{default}, then the
1613 default languages available in the @file{gcc} sub-tree will be configured.
1614 Ada, Go, Jit, and Objective-C++ are not default languages.  LTO is not a
1615 default language, but is built by default because @option{--enable-lto} is
1616 enabled by default.  The other languages are default languages.  If
1617 @code{all} is specified, then all available languages are built.  An
1618 exception is @code{jit} language, which requires
1619 @option{--enable-host-shared} to be included with @code{all}.
1621 @item --enable-stage1-languages=@var{lang1},@var{lang2},@dots{}
1622 Specify that a particular subset of compilers and their runtime
1623 libraries should be built with the system C compiler during stage 1 of
1624 the bootstrap process, rather than only in later stages with the
1625 bootstrapped C compiler.  The list of valid values is the same as for
1626 @option{--enable-languages}, and the option @code{all} will select all
1627 of the languages enabled by @option{--enable-languages}.  This option is
1628 primarily useful for GCC development; for instance, when a development
1629 version of the compiler cannot bootstrap due to compiler bugs, or when
1630 one is debugging front ends other than the C front end.  When this
1631 option is used, one can then build the target libraries for the
1632 specified languages with the stage-1 compiler by using @command{make
1633 stage1-bubble all-target}, or run the testsuite on the stage-1 compiler
1634 for the specified languages using @command{make stage1-start check-gcc}.
1636 @item --disable-libada
1637 Specify that the run-time libraries and tools used by GNAT should not
1638 be built.  This can be useful for debugging, or for compatibility with
1639 previous Ada build procedures, when it was required to explicitly
1640 do a @samp{make -C gcc gnatlib_and_tools}.
1642 @item --disable-libsanitizer
1643 Specify that the run-time libraries for the various sanitizers should
1644 not be built.
1646 @item --disable-libssp
1647 Specify that the run-time libraries for stack smashing protection
1648 should not be built or linked against.  On many targets library support
1649 is provided by the C library instead.
1651 @item --disable-libquadmath
1652 Specify that the GCC quad-precision math library should not be built.
1653 On some systems, the library is required to be linkable when building
1654 the Fortran front end, unless @option{--disable-libquadmath-support}
1655 is used.
1657 @item --disable-libquadmath-support
1658 Specify that the Fortran front end and @code{libgfortran} do not add
1659 support for @code{libquadmath} on systems supporting it.
1661 @item --disable-libgomp
1662 Specify that the GNU Offloading and Multi Processing Runtime Library
1663 should not be built.
1665 @item --disable-libvtv
1666 Specify that the run-time libraries used by vtable verification
1667 should not be built.
1669 @item --with-dwarf2
1670 Specify that the compiler should
1671 use DWARF 2 debugging information as the default.
1673 @item --with-advance-toolchain=@var{at}
1674 On 64-bit PowerPC Linux systems, configure the compiler to use the
1675 header files, library files, and the dynamic linker from the Advance
1676 Toolchain release @var{at} instead of the default versions that are
1677 provided by the Linux distribution.  In general, this option is
1678 intended for the developers of GCC, and it is not intended for general
1679 use.
1681 @item --enable-targets=all
1682 @itemx --enable-targets=@var{target_list}
1683 Some GCC targets, e.g.@: powerpc64-linux, build bi-arch compilers.
1684 These are compilers that are able to generate either 64-bit or 32-bit
1685 code.  Typically, the corresponding 32-bit target, e.g.@:
1686 powerpc-linux for powerpc64-linux, only generates 32-bit code.  This
1687 option enables the 32-bit target to be a bi-arch compiler, which is
1688 useful when you want a bi-arch compiler that defaults to 32-bit, and
1689 you are building a bi-arch or multi-arch binutils in a combined tree.
1690 On mips-linux, this will build a tri-arch compiler (ABI o32/n32/64),
1691 defaulted to o32.
1692 Currently, this option only affects sparc-linux, powerpc-linux, x86-linux,
1693 mips-linux and s390-linux.
1695 @item --enable-default-pie
1696 Turn on @option{-fPIE} and @option{-pie} by default.
1698 @item --enable-secureplt
1699 This option enables @option{-msecure-plt} by default for powerpc-linux.
1700 @ifnothtml
1701 @xref{RS/6000 and PowerPC Options,, RS/6000 and PowerPC Options, gcc,
1702 Using the GNU Compiler Collection (GCC)},
1703 @end ifnothtml
1704 @ifhtml
1705 See ``RS/6000 and PowerPC Options'' in the main manual
1706 @end ifhtml
1708 @item --enable-default-ssp
1709 Turn on @option{-fstack-protector-strong} by default.
1711 @item --enable-cld
1712 This option enables @option{-mcld} by default for 32-bit x86 targets.
1713 @ifnothtml
1714 @xref{i386 and x86-64 Options,, i386 and x86-64 Options, gcc,
1715 Using the GNU Compiler Collection (GCC)},
1716 @end ifnothtml
1717 @ifhtml
1718 See ``i386 and x86-64 Options'' in the main manual
1719 @end ifhtml
1721 @item --enable-win32-registry
1722 @itemx --enable-win32-registry=@var{key}
1723 @itemx --disable-win32-registry
1724 The @option{--enable-win32-registry} option enables Microsoft Windows-hosted GCC
1725 to look up installations paths in the registry using the following key:
1727 @smallexample
1728 @code{HKEY_LOCAL_MACHINE\SOFTWARE\Free Software Foundation\@var{key}}
1729 @end smallexample
1731 @var{key} defaults to GCC version number, and can be overridden by the
1732 @option{--enable-win32-registry=@var{key}} option.  Vendors and distributors
1733 who use custom installers are encouraged to provide a different key,
1734 perhaps one comprised of vendor name and GCC version number, to
1735 avoid conflict with existing installations.  This feature is enabled
1736 by default, and can be disabled by @option{--disable-win32-registry}
1737 option.  This option has no effect on the other hosts.
1739 @item --nfp
1740 Specify that the machine does not have a floating point unit.  This
1741 option only applies to @samp{m68k-sun-sunos@var{n}}.  On any other
1742 system, @option{--nfp} has no effect.
1744 @item --enable-werror
1745 @itemx --disable-werror
1746 @itemx --enable-werror=yes
1747 @itemx --enable-werror=no
1748 When you specify this option, it controls whether certain files in the
1749 compiler are built with @option{-Werror} in bootstrap stage2 and later.
1750 If you don't specify it, @option{-Werror} is turned on for the main
1751 development trunk.  However it defaults to off for release branches and
1752 final releases.  The specific files which get @option{-Werror} are
1753 controlled by the Makefiles.
1755 @item --enable-checking
1756 @itemx --enable-checking=@var{list}
1757 When you specify this option, the compiler is built to perform internal
1758 consistency checks of the requested complexity.  This does not change the
1759 generated code, but adds error checking within the compiler.  This will
1760 slow down the compiler and may only work properly if you are building
1761 the compiler with GCC@.  This is @samp{yes,extra} by default when building
1762 from SVN or snapshots, but @samp{release} for releases.  The default
1763 for building the stage1 compiler is @samp{yes}.  More control
1764 over the checks may be had by specifying @var{list}.  The categories of
1765 checks available are @samp{yes} (most common checks
1766 @samp{assert,misc,tree,gc,rtlflag,runtime}), @samp{no} (no checks at
1767 all), @samp{all} (all but @samp{valgrind}), @samp{release} (cheapest
1768 checks @samp{assert,runtime}) or @samp{none} (same as @samp{no}).
1769 Individual checks can be enabled with these flags @samp{assert},
1770 @samp{df}, @samp{fold}, @samp{gc}, @samp{gcac}, @samp{misc}, @samp{rtl},
1771 @samp{rtlflag}, @samp{runtime}, @samp{tree}, @samp{extra} and @samp{valgrind}.
1772 @samp{extra} adds for @samp{misc} checking extra checks that might affect
1773 code generation and should therefore not differ between stage1 and later
1774 stages.
1776 The @samp{valgrind} check requires the external @command{valgrind}
1777 simulator, available from @uref{http://valgrind.org/}.  The
1778 @samp{df}, @samp{rtl}, @samp{gcac} and @samp{valgrind} checks are very expensive.
1779 To disable all checking, @samp{--disable-checking} or
1780 @samp{--enable-checking=none} must be explicitly requested.  Disabling
1781 assertions will make the compiler and runtime slightly faster but
1782 increase the risk of undetected internal errors causing wrong code to be
1783 generated.
1785 @item --disable-stage1-checking
1786 @itemx --enable-stage1-checking
1787 @itemx --enable-stage1-checking=@var{list}
1788 If no @option{--enable-checking} option is specified the stage1
1789 compiler will be built with @samp{yes} checking enabled, otherwise
1790 the stage1 checking flags are the same as specified by
1791 @option{--enable-checking}.  To build the stage1 compiler with
1792 different checking options use @option{--enable-stage1-checking}.
1793 The list of checking options is the same as for @option{--enable-checking}.
1794 If your system is too slow or too small to bootstrap a released compiler
1795 with checking for stage1 enabled, you can use @samp{--disable-stage1-checking}
1796 to disable checking for the stage1 compiler.
1798 @item --enable-coverage
1799 @itemx --enable-coverage=@var{level}
1800 With this option, the compiler is built to collect self coverage
1801 information, every time it is run.  This is for internal development
1802 purposes, and only works when the compiler is being built with gcc.  The
1803 @var{level} argument controls whether the compiler is built optimized or
1804 not, values are @samp{opt} and @samp{noopt}.  For coverage analysis you
1805 want to disable optimization, for performance analysis you want to
1806 enable optimization.  When coverage is enabled, the default level is
1807 without optimization.
1809 @item --enable-gather-detailed-mem-stats
1810 When this option is specified more detailed information on memory
1811 allocation is gathered.  This information is printed when using
1812 @option{-fmem-report}.
1814 @item --enable-valgrind-annotations
1815 Mark selected memory related operations in the compiler when run under
1816 valgrind to suppress false positives.
1818 @item --enable-nls
1819 @itemx --disable-nls
1820 The @option{--enable-nls} option enables Native Language Support (NLS),
1821 which lets GCC output diagnostics in languages other than American
1822 English.  Native Language Support is enabled by default if not doing a
1823 canadian cross build.  The @option{--disable-nls} option disables NLS@.
1825 @item --with-included-gettext
1826 If NLS is enabled, the @option{--with-included-gettext} option causes the build
1827 procedure to prefer its copy of GNU @command{gettext}.
1829 @item --with-catgets
1830 If NLS is enabled, and if the host lacks @code{gettext} but has the
1831 inferior @code{catgets} interface, the GCC build procedure normally
1832 ignores @code{catgets} and instead uses GCC's copy of the GNU
1833 @code{gettext} library.  The @option{--with-catgets} option causes the
1834 build procedure to use the host's @code{catgets} in this situation.
1836 @item --with-libiconv-prefix=@var{dir}
1837 Search for libiconv header files in @file{@var{dir}/include} and
1838 libiconv library files in @file{@var{dir}/lib}.
1840 @item --enable-obsolete
1841 Enable configuration for an obsoleted system.  If you attempt to
1842 configure GCC for a system (build, host, or target) which has been
1843 obsoleted, and you do not specify this flag, configure will halt with an
1844 error message.
1846 All support for systems which have been obsoleted in one release of GCC
1847 is removed entirely in the next major release, unless someone steps
1848 forward to maintain the port.
1850 @item --enable-decimal-float
1851 @itemx --enable-decimal-float=yes
1852 @itemx --enable-decimal-float=no
1853 @itemx --enable-decimal-float=bid
1854 @itemx --enable-decimal-float=dpd
1855 @itemx --disable-decimal-float
1856 Enable (or disable) support for the C decimal floating point extension
1857 that is in the IEEE 754-2008 standard.  This is enabled by default only
1858 on PowerPC, i386, and x86_64 GNU/Linux systems.  Other systems may also
1859 support it, but require the user to specifically enable it.  You can
1860 optionally control which decimal floating point format is used (either
1861 @samp{bid} or @samp{dpd}).  The @samp{bid} (binary integer decimal)
1862 format is default on i386 and x86_64 systems, and the @samp{dpd}
1863 (densely packed decimal) format is default on PowerPC systems.
1865 @item --enable-fixed-point
1866 @itemx --disable-fixed-point
1867 Enable (or disable) support for C fixed-point arithmetic.
1868 This option is enabled by default for some targets (such as MIPS) which
1869 have hardware-support for fixed-point operations.  On other targets, you
1870 may enable this option manually.
1872 @item --with-long-double-128
1873 Specify if @code{long double} type should be 128-bit by default on selected
1874 GNU/Linux architectures.  If using @code{--without-long-double-128},
1875 @code{long double} will be by default 64-bit, the same as @code{double} type.
1876 When neither of these configure options are used, the default will be
1877 128-bit @code{long double} when built against GNU C Library 2.4 and later,
1878 64-bit @code{long double} otherwise.
1880 @item --with-long-double-format=ibm
1881 @itemx --with-long-double-format=ieee
1882 Specify whether @code{long double} uses the IBM extended double format
1883 or the IEEE 128-bit floating point format on PowerPC Linux systems.
1884 This configuration switch will only work on little endian PowerPC
1885 Linux systems and on big endian 64-bit systems where the default cpu
1886 is at least power7 (i.e. @option{--with-cpu=power7},
1887 @option{--with-cpu=power8}, or @option{--with-cpu=power9} is used).
1889 If you use the @option{--with-long-double-64} configuration option,
1890 the @option{--with-long-double-format=ibm} and
1891 @option{--with-long-double-format=ieee} options are ignored.
1893 The default @code{long double} format is to use IBM extended double.
1894 Until all of the libraries are converted to use IEEE 128-bit floating
1895 point, it is not recommended to use
1896 @option{--with-long-double-format=ieee}.
1898 On little endian PowerPC Linux systems, if you explicitly set the
1899 @code{long double} type, it will build multilibs to allow you to
1900 select either @code{long double} format, unless you disable multilibs
1901 with the @code{--disable-multilib} option.  At present,
1902 @code{long double} multilibs are not built on big endian PowerPC Linux
1903 systems.  If you are building multilibs, you will need to configure
1904 the compiler using the @option{--with-system-zlib} option.
1906 If you do not set the @code{long double} type explicitly, no multilibs
1907 will be generated.
1909 @item --enable-fdpic
1910 On SH Linux systems, generate ELF FDPIC code.
1912 @item --with-gmp=@var{pathname}
1913 @itemx --with-gmp-include=@var{pathname}
1914 @itemx --with-gmp-lib=@var{pathname}
1915 @itemx --with-mpfr=@var{pathname}
1916 @itemx --with-mpfr-include=@var{pathname}
1917 @itemx --with-mpfr-lib=@var{pathname}
1918 @itemx --with-mpc=@var{pathname}
1919 @itemx --with-mpc-include=@var{pathname}
1920 @itemx --with-mpc-lib=@var{pathname}
1921 If you want to build GCC but do not have the GMP library, the MPFR
1922 library and/or the MPC library installed in a standard location and
1923 do not have their sources present in the GCC source tree then you
1924 can explicitly specify the directory where they are installed
1925 (@samp{--with-gmp=@var{gmpinstalldir}},
1926 @samp{--with-mpfr=@/@var{mpfrinstalldir}},
1927 @samp{--with-mpc=@/@var{mpcinstalldir}}).  The
1928 @option{--with-gmp=@/@var{gmpinstalldir}} option is shorthand for
1929 @option{--with-gmp-lib=@/@var{gmpinstalldir}/lib} and
1930 @option{--with-gmp-include=@/@var{gmpinstalldir}/include}.  Likewise the
1931 @option{--with-mpfr=@/@var{mpfrinstalldir}} option is shorthand for
1932 @option{--with-mpfr-lib=@/@var{mpfrinstalldir}/lib} and
1933 @option{--with-mpfr-include=@/@var{mpfrinstalldir}/include}, also the
1934 @option{--with-mpc=@/@var{mpcinstalldir}} option is shorthand for
1935 @option{--with-mpc-lib=@/@var{mpcinstalldir}/lib} and
1936 @option{--with-mpc-include=@/@var{mpcinstalldir}/include}.  If these
1937 shorthand assumptions are not correct, you can use the explicit
1938 include and lib options directly.  You might also need to ensure the
1939 shared libraries can be found by the dynamic linker when building and
1940 using GCC, for example by setting the runtime shared library path
1941 variable (@env{LD_LIBRARY_PATH} on GNU/Linux and Solaris systems).
1943 These flags are applicable to the host platform only.  When building
1944 a cross compiler, they will not be used to configure target libraries.
1946 @item --with-isl=@var{pathname}
1947 @itemx --with-isl-include=@var{pathname}
1948 @itemx --with-isl-lib=@var{pathname}
1949 If you do not have the isl library installed in a standard location and you
1950 want to build GCC, you can explicitly specify the directory where it is
1951 installed (@samp{--with-isl=@/@var{islinstalldir}}). The
1952 @option{--with-isl=@/@var{islinstalldir}} option is shorthand for
1953 @option{--with-isl-lib=@/@var{islinstalldir}/lib} and
1954 @option{--with-isl-include=@/@var{islinstalldir}/include}. If this
1955 shorthand assumption is not correct, you can use the explicit
1956 include and lib options directly.
1958 These flags are applicable to the host platform only.  When building
1959 a cross compiler, they will not be used to configure target libraries.
1961 @item --with-stage1-ldflags=@var{flags}
1962 This option may be used to set linker flags to be used when linking
1963 stage 1 of GCC.  These are also used when linking GCC if configured with
1964 @option{--disable-bootstrap}.  If @option{--with-stage1-libs} is not set to a
1965 value, then the default is @samp{-static-libstdc++ -static-libgcc}, if
1966 supported.
1968 @item --with-stage1-libs=@var{libs}
1969 This option may be used to set libraries to be used when linking stage 1
1970 of GCC.  These are also used when linking GCC if configured with
1971 @option{--disable-bootstrap}.
1973 @item --with-boot-ldflags=@var{flags}
1974 This option may be used to set linker flags to be used when linking
1975 stage 2 and later when bootstrapping GCC.  If --with-boot-libs
1976 is not is set to a value, then the default is
1977 @samp{-static-libstdc++ -static-libgcc}.
1979 @item --with-boot-libs=@var{libs}
1980 This option may be used to set libraries to be used when linking stage 2
1981 and later when bootstrapping GCC.
1983 @item --with-debug-prefix-map=@var{map}
1984 Convert source directory names using @option{-fdebug-prefix-map} when
1985 building runtime libraries.  @samp{@var{map}} is a space-separated
1986 list of maps of the form @samp{@var{old}=@var{new}}.
1988 @item --enable-linker-build-id
1989 Tells GCC to pass @option{--build-id} option to the linker for all final
1990 links (links performed without the @option{-r} or @option{--relocatable}
1991 option), if the linker supports it.  If you specify
1992 @option{--enable-linker-build-id}, but your linker does not
1993 support @option{--build-id} option, a warning is issued and the
1994 @option{--enable-linker-build-id} option is ignored.  The default is off.
1996 @item --with-linker-hash-style=@var{choice}
1997 Tells GCC to pass @option{--hash-style=@var{choice}} option to the
1998 linker for all final links. @var{choice} can be one of
1999 @samp{sysv}, @samp{gnu}, and @samp{both} where @samp{sysv} is the default.
2001 @item --enable-gnu-unique-object
2002 @itemx --disable-gnu-unique-object
2003 Tells GCC to use the gnu_unique_object relocation for C++ template
2004 static data members and inline function local statics.  Enabled by
2005 default for a toolchain with an assembler that accepts it and
2006 GLIBC 2.11 or above, otherwise disabled.
2008 @item --with-diagnostics-color=@var{choice}
2009 Tells GCC to use @var{choice} as the default for @option{-fdiagnostics-color=}
2010 option (if not used explicitly on the command line).  @var{choice}
2011 can be one of @samp{never}, @samp{auto}, @samp{always}, and @samp{auto-if-env}
2012 where @samp{auto} is the default.  @samp{auto-if-env} means that
2013 @option{-fdiagnostics-color=auto} will be the default if @code{GCC_COLORS}
2014 is present and non-empty in the environment, and
2015 @option{-fdiagnostics-color=never} otherwise.
2017 @item --enable-lto
2018 @itemx --disable-lto
2019 Enable support for link-time optimization (LTO).  This is enabled by
2020 default, and may be disabled using @option{--disable-lto}.
2022 @item --enable-linker-plugin-configure-flags=FLAGS
2023 @itemx --enable-linker-plugin-flags=FLAGS
2024 By default, linker plugins (such as the LTO plugin) are built for the
2025 host system architecture.  For the case that the linker has a
2026 different (but run-time compatible) architecture, these flags can be
2027 specified to build plugins that are compatible to the linker.  For
2028 example, if you are building GCC for a 64-bit x86_64
2029 (@samp{x86_64-unknown-linux-gnu}) host system, but have a 32-bit x86
2030 GNU/Linux (@samp{i686-pc-linux-gnu}) linker executable (which is
2031 executable on the former system), you can configure GCC as follows for
2032 getting compatible linker plugins:
2034 @smallexample
2035 % @var{srcdir}/configure \
2036     --host=x86_64-unknown-linux-gnu \
2037     --enable-linker-plugin-configure-flags=--host=i686-pc-linux-gnu \
2038     --enable-linker-plugin-flags='CC=gcc\ -m32\ -Wl,-rpath,[...]/i686-pc-linux-gnu/lib'
2039 @end smallexample
2041 @item --with-plugin-ld=@var{pathname}
2042 Enable an alternate linker to be used at link-time optimization (LTO)
2043 link time when @option{-fuse-linker-plugin} is enabled.
2044 This linker should have plugin support such as gold starting with
2045 version 2.20 or GNU ld starting with version 2.21.
2046 See @option{-fuse-linker-plugin} for details.
2048 @item --enable-canonical-system-headers
2049 @itemx --disable-canonical-system-headers
2050 Enable system header path canonicalization for @file{libcpp}.  This can
2051 produce shorter header file paths in diagnostics and dependency output
2052 files, but these changed header paths may conflict with some compilation
2053 environments.  Enabled by default, and may be disabled using
2054 @option{--disable-canonical-system-headers}.
2056 @item --with-glibc-version=@var{major}.@var{minor}
2057 Tell GCC that when the GNU C Library (glibc) is used on the target it
2058 will be version @var{major}.@var{minor} or later.  Normally this can
2059 be detected from the C library's header files, but this option may be
2060 needed when bootstrapping a cross toolchain without the header files
2061 available for building the initial bootstrap compiler.
2063 If GCC is configured with some multilibs that use glibc and some that
2064 do not, this option applies only to the multilibs that use glibc.
2065 However, such configurations may not work well as not all the relevant
2066 configuration in GCC is on a per-multilib basis.
2068 @item --enable-as-accelerator-for=@var{target}
2069 Build as offload target compiler. Specify offload host triple by @var{target}.
2071 @item --enable-offload-targets=@var{target1}[=@var{path1}],@dots{},@var{targetN}[=@var{pathN}]
2072 Enable offloading to targets @var{target1}, @dots{}, @var{targetN}.
2073 Offload compilers are expected to be already installed.  Default search
2074 path for them is @file{@var{exec-prefix}}, but it can be changed by
2075 specifying paths @var{path1}, @dots{}, @var{pathN}.
2077 @smallexample
2078 % @var{srcdir}/configure \
2079     --enable-offload-target=i686-unknown-linux-gnu=/path/to/i686/compiler,x86_64-pc-linux-gnu
2080 @end smallexample
2082 If @samp{hsa} is specified as one of the targets, the compiler will be
2083 built with support for HSA GPU accelerators.  Because the same
2084 compiler will emit the accelerator code, no path should be specified.
2086 @item --with-hsa-runtime=@var{pathname}
2087 @itemx --with-hsa-runtime-include=@var{pathname}
2088 @itemx --with-hsa-runtime-lib=@var{pathname}
2090 If you configure GCC with HSA offloading but do not have the HSA
2091 run-time library installed in a standard location then you can
2092 explicitly specify the directory where they are installed.  The
2093 @option{--with-hsa-runtime=@/@var{hsainstalldir}} option is a
2094 shorthand for
2095 @option{--with-hsa-runtime-lib=@/@var{hsainstalldir}/lib} and
2096 @option{--with-hsa-runtime-include=@/@var{hsainstalldir}/include}.
2098 @item --enable-cet
2099 @itemx --disable-cet
2100 Enable building target run-time libraries with control-flow
2101 instrumentation, see @option{-fcf-protection} option.  When
2102 @code{--enable-cet} is specified target libraries are configured
2103 to add @option{-fcf-protection} and, if needed, other target
2104 specific options to a set of building options.
2106 The option is enabled by default on Linux/x86 if target binutils
2107 supports @code{Intel CET} instructions.  In this case the target
2108 libraries are configured to get additional @option{-fcf-protection}
2109 and @option{-mcet} options.
2110 @end table
2112 @subheading Cross-Compiler-Specific Options
2113 The following options only apply to building cross compilers.
2115 @table @code
2116 @item --with-sysroot
2117 @itemx --with-sysroot=@var{dir}
2118 Tells GCC to consider @var{dir} as the root of a tree that contains
2119 (a subset of) the root filesystem of the target operating system.
2120 Target system headers, libraries and run-time object files will be
2121 searched for in there.  More specifically, this acts as if
2122 @option{--sysroot=@var{dir}} was added to the default options of the built
2123 compiler.  The specified directory is not copied into the
2124 install tree, unlike the options @option{--with-headers} and
2125 @option{--with-libs} that this option obsoletes.  The default value,
2126 in case @option{--with-sysroot} is not given an argument, is
2127 @option{$@{gcc_tooldir@}/sys-root}.  If the specified directory is a
2128 subdirectory of @option{$@{exec_prefix@}}, then it will be found relative to
2129 the GCC binaries if the installation tree is moved.
2131 This option affects the system root for the compiler used to build
2132 target libraries (which runs on the build system) and the compiler newly
2133 installed with @code{make install}; it does not affect the compiler which is
2134 used to build GCC itself.
2136 If you specify the @option{--with-native-system-header-dir=@var{dirname}}
2137 option then the compiler will search that directory within @var{dirname} for
2138 native system headers rather than the default @file{/usr/include}.
2140 @item --with-build-sysroot
2141 @itemx --with-build-sysroot=@var{dir}
2142 Tells GCC to consider @var{dir} as the system root (see
2143 @option{--with-sysroot}) while building target libraries, instead of
2144 the directory specified with @option{--with-sysroot}.  This option is
2145 only useful when you are already using @option{--with-sysroot}.  You
2146 can use @option{--with-build-sysroot} when you are configuring with
2147 @option{--prefix} set to a directory that is different from the one in
2148 which you are installing GCC and your target libraries.
2150 This option affects the system root for the compiler used to build
2151 target libraries (which runs on the build system); it does not affect
2152 the compiler which is used to build GCC itself.
2154 If you specify the @option{--with-native-system-header-dir=@var{dirname}}
2155 option then the compiler will search that directory within @var{dirname} for
2156 native system headers rather than the default @file{/usr/include}.
2158 @item --with-headers
2159 @itemx --with-headers=@var{dir}
2160 Deprecated in favor of @option{--with-sysroot}.
2161 Specifies that target headers are available when building a cross compiler.
2162 The @var{dir} argument specifies a directory which has the target include
2163 files.  These include files will be copied into the @file{gcc} install
2164 directory.  @emph{This option with the @var{dir} argument is required} when
2165 building a cross compiler, if @file{@var{prefix}/@var{target}/sys-include}
2166 doesn't pre-exist.  If @file{@var{prefix}/@var{target}/sys-include} does
2167 pre-exist, the @var{dir} argument may be omitted.  @command{fixincludes}
2168 will be run on these files to make them compatible with GCC@.
2170 @item --without-headers
2171 Tells GCC not use any target headers from a libc when building a cross
2172 compiler.  When crossing to GNU/Linux, you need the headers so GCC
2173 can build the exception handling for libgcc.
2175 @item --with-libs
2176 @itemx --with-libs="@var{dir1} @var{dir2} @dots{} @var{dirN}"
2177 Deprecated in favor of @option{--with-sysroot}.
2178 Specifies a list of directories which contain the target runtime
2179 libraries.  These libraries will be copied into the @file{gcc} install
2180 directory.  If the directory list is omitted, this option has no
2181 effect.
2183 @item --with-newlib
2184 Specifies that @samp{newlib} is
2185 being used as the target C library.  This causes @code{__eprintf} to be
2186 omitted from @file{libgcc.a} on the assumption that it will be provided by
2187 @samp{newlib}.
2189 @item --with-avrlibc
2190 Specifies that @samp{AVR-Libc} is
2191 being used as the target C library.  This causes float support
2192 functions like @code{__addsf3} to be omitted from @file{libgcc.a} on
2193 the assumption that it will be provided by @file{libm.a}.  For more
2194 technical details, cf. @uref{http://gcc.gnu.org/PR54461,,PR54461}.
2195 This option is only supported for the AVR target.  It is not supported for
2196 RTEMS configurations, which currently use newlib.  The option is
2197 supported since version 4.7.2 and is the default in 4.8.0 and newer.
2199 @item --with-nds32-lib=@var{library}
2200 Specifies that @var{library} setting is used for building @file{libgcc.a}.
2201 Currently, the valid @var{library} is @samp{newlib} or @samp{mculib}.
2202 This option is only supported for the NDS32 target.
2204 @item --with-build-time-tools=@var{dir}
2205 Specifies where to find the set of target tools (assembler, linker, etc.)
2206 that will be used while building GCC itself.  This option can be useful
2207 if the directory layouts are different between the system you are building
2208 GCC on, and the system where you will deploy it.
2210 For example, on an @samp{ia64-hp-hpux} system, you may have the GNU
2211 assembler and linker in @file{/usr/bin}, and the native tools in a
2212 different path, and build a toolchain that expects to find the
2213 native tools in @file{/usr/bin}.
2215 When you use this option, you should ensure that @var{dir} includes
2216 @command{ar}, @command{as}, @command{ld}, @command{nm},
2217 @command{ranlib} and @command{strip} if necessary, and possibly
2218 @command{objdump}.  Otherwise, GCC may use an inconsistent set of
2219 tools.
2220 @end table
2222 @subsubheading Overriding @command{configure} test results
2224 Sometimes, it might be necessary to override the result of some
2225 @command{configure} test, for example in order to ease porting to a new
2226 system or work around a bug in a test.  The toplevel @command{configure}
2227 script provides three variables for this:
2229 @table @code
2231 @item build_configargs
2232 @cindex @code{build_configargs}
2233 The contents of this variable is passed to all build @command{configure}
2234 scripts.
2236 @item host_configargs
2237 @cindex @code{host_configargs}
2238 The contents of this variable is passed to all host @command{configure}
2239 scripts.
2241 @item target_configargs
2242 @cindex @code{target_configargs}
2243 The contents of this variable is passed to all target @command{configure}
2244 scripts.
2246 @end table
2248 In order to avoid shell and @command{make} quoting issues for complex
2249 overrides, you can pass a setting for @env{CONFIG_SITE} and set
2250 variables in the site file.
2252 @subheading Objective-C-Specific Options
2254 The following options apply to the build of the Objective-C runtime library.
2256 @table @code
2257 @item --enable-objc-gc
2258 Specify that an additional variant of the GNU Objective-C runtime library
2259 is built, using an external build of the Boehm-Demers-Weiser garbage
2260 collector (@uref{http://www.hboehm.info/gc/}).  This library needs to be
2261 available for each multilib variant, unless configured with
2262 @option{--enable-objc-gc=@samp{auto}} in which case the build of the
2263 additional runtime library is skipped when not available and the build
2264 continues.
2266 @item --with-target-bdw-gc=@var{list}
2267 @itemx --with-target-bdw-gc-include=@var{list}
2268 @itemx --with-target-bdw-gc-lib=@var{list}
2269 Specify search directories for the garbage collector header files and
2270 libraries. @var{list} is a comma separated list of key value pairs of the
2271 form @samp{@var{multilibdir}=@var{path}}, where the default multilib key
2272 is named as @samp{.} (dot), or is omitted (e.g.
2273 @samp{--with-target-bdw-gc=/opt/bdw-gc,32=/opt-bdw-gc32}).
2275 The options @option{--with-target-bdw-gc-include} and
2276 @option{--with-target-bdw-gc-lib} must always be specified together
2277 for each multilib variant and they take precedence over
2278 @option{--with-target-bdw-gc}.  If @option{--with-target-bdw-gc-include}
2279 is missing values for a multilib, then the value for the default
2280 multilib is used (e.g. @samp{--with-target-bdw-gc-include=/opt/bdw-gc/include}
2281 @samp{--with-target-bdw-gc-lib=/opt/bdw-gc/lib64,32=/opt-bdw-gc/lib32}).
2282 If none of these options are specified, the library is assumed in
2283 default locations.
2284 @end table
2286 @html
2287 <hr />
2289 @end html
2290 @ifhtml
2291 @uref{./index.html,,Return to the GCC Installation page}
2292 @end ifhtml
2293 @end ifset
2295 @c ***Building****************************************************************
2296 @ifnothtml
2297 @comment node-name,     next,          previous, up
2298 @node    Building, Testing, Configuration, Installing GCC
2299 @end ifnothtml
2300 @ifset buildhtml
2301 @ifnothtml
2302 @chapter Building
2303 @end ifnothtml
2304 @cindex Installing GCC: Building
2306 Now that GCC is configured, you are ready to build the compiler and
2307 runtime libraries.
2309 Some commands executed when making the compiler may fail (return a
2310 nonzero status) and be ignored by @command{make}.  These failures, which
2311 are often due to files that were not found, are expected, and can safely
2312 be ignored.
2314 It is normal to have compiler warnings when compiling certain files.
2315 Unless you are a GCC developer, you can generally ignore these warnings
2316 unless they cause compilation to fail.  Developers should attempt to fix
2317 any warnings encountered, however they can temporarily continue past
2318 warnings-as-errors by specifying the configure flag
2319 @option{--disable-werror}.
2321 On certain old systems, defining certain environment variables such as
2322 @env{CC} can interfere with the functioning of @command{make}.
2324 If you encounter seemingly strange errors when trying to build the
2325 compiler in a directory other than the source directory, it could be
2326 because you have previously configured the compiler in the source
2327 directory.  Make sure you have done all the necessary preparations.
2329 If you build GCC on a BSD system using a directory stored in an old System
2330 V file system, problems may occur in running @command{fixincludes} if the
2331 System V file system doesn't support symbolic links.  These problems
2332 result in a failure to fix the declaration of @code{size_t} in
2333 @file{sys/types.h}.  If you find that @code{size_t} is a signed type and
2334 that type mismatches occur, this could be the cause.
2336 The solution is not to use such a directory for building GCC@.
2338 Similarly, when building from SVN or snapshots, or if you modify
2339 @file{*.l} files, you need the Flex lexical analyzer generator
2340 installed.  If you do not modify @file{*.l} files, releases contain
2341 the Flex-generated files and you do not need Flex installed to build
2342 them.  There is still one Flex-based lexical analyzer (part of the
2343 build machinery, not of GCC itself) that is used even if you only
2344 build the C front end.
2346 When building from SVN or snapshots, or if you modify Texinfo
2347 documentation, you need version 4.7 or later of Texinfo installed if you
2348 want Info documentation to be regenerated.  Releases contain Info
2349 documentation pre-built for the unmodified documentation in the release.
2351 @section Building a native compiler
2353 For a native build, the default configuration is to perform
2354 a 3-stage bootstrap of the compiler when @samp{make} is invoked.
2355 This will build the entire GCC system and ensure that it compiles
2356 itself correctly.  It can be disabled with the @option{--disable-bootstrap}
2357 parameter to @samp{configure}, but bootstrapping is suggested because
2358 the compiler will be tested more completely and could also have
2359 better performance.
2361 The bootstrapping process will complete the following steps:
2363 @itemize @bullet
2364 @item
2365 Build tools necessary to build the compiler.
2367 @item
2368 Perform a 3-stage bootstrap of the compiler.  This includes building
2369 three times the target tools for use by the compiler such as binutils
2370 (bfd, binutils, gas, gprof, ld, and opcodes) if they have been
2371 individually linked or moved into the top level GCC source tree before
2372 configuring.
2374 @item
2375 Perform a comparison test of the stage2 and stage3 compilers.
2377 @item
2378 Build runtime libraries using the stage3 compiler from the previous step.
2380 @end itemize
2382 If you are short on disk space you might consider @samp{make
2383 bootstrap-lean} instead.  The sequence of compilation is the
2384 same described above, but object files from the stage1 and
2385 stage2 of the 3-stage bootstrap of the compiler are deleted as
2386 soon as they are no longer needed.
2388 If you wish to use non-default GCC flags when compiling the stage2
2389 and stage3 compilers, set @code{BOOT_CFLAGS} on the command line when
2390 doing @samp{make}.  For example, if you want to save additional space
2391 during the bootstrap and in the final installation as well, you can
2392 build the compiler binaries without debugging information as in the
2393 following example.  This will save roughly 40% of disk space both for
2394 the bootstrap and the final installation.  (Libraries will still contain
2395 debugging information.)
2397 @smallexample
2398 make BOOT_CFLAGS='-O' bootstrap
2399 @end smallexample
2401 You can place non-default optimization flags into @code{BOOT_CFLAGS}; they
2402 are less well tested here than the default of @samp{-g -O2}, but should
2403 still work.  In a few cases, you may find that you need to specify special
2404 flags such as @option{-msoft-float} here to complete the bootstrap; or,
2405 if the native compiler miscompiles the stage1 compiler, you may need
2406 to work around this, by choosing @code{BOOT_CFLAGS} to avoid the parts
2407 of the stage1 compiler that were miscompiled, or by using @samp{make
2408 bootstrap4} to increase the number of stages of bootstrap.
2410 @code{BOOT_CFLAGS} does not apply to bootstrapped target libraries.
2411 Since these are always compiled with the compiler currently being
2412 bootstrapped, you can use @code{CFLAGS_FOR_TARGET} to modify their
2413 compilation flags, as for non-bootstrapped target libraries.
2414 Again, if the native compiler miscompiles the stage1 compiler, you may
2415 need to work around this by avoiding non-working parts of the stage1
2416 compiler.  Use @code{STAGE1_TFLAGS} to this end.
2418 If you used the flag @option{--enable-languages=@dots{}} to restrict
2419 the compilers to be built, only those you've actually enabled will be
2420 built.  This will of course only build those runtime libraries, for
2421 which the particular compiler has been built.  Please note,
2422 that re-defining @env{LANGUAGES} when calling @samp{make}
2423 @strong{does not} work anymore!
2425 If the comparison of stage2 and stage3 fails, this normally indicates
2426 that the stage2 compiler has compiled GCC incorrectly, and is therefore
2427 a potentially serious bug which you should investigate and report.  (On
2428 a few systems, meaningful comparison of object files is impossible; they
2429 always appear ``different''.  If you encounter this problem, you will
2430 need to disable comparison in the @file{Makefile}.)
2432 If you do not want to bootstrap your compiler, you can configure with
2433 @option{--disable-bootstrap}.  In particular cases, you may want to
2434 bootstrap your compiler even if the target system is not the same as
2435 the one you are building on: for example, you could build a
2436 @code{powerpc-unknown-linux-gnu} toolchain on a
2437 @code{powerpc64-unknown-linux-gnu} host.  In this case, pass
2438 @option{--enable-bootstrap} to the configure script.
2440 @code{BUILD_CONFIG} can be used to bring in additional customization
2441 to the build.  It can be set to a whitespace-separated list of names.
2442 For each such @code{NAME}, top-level @file{config/@code{NAME}.mk} will
2443 be included by the top-level @file{Makefile}, bringing in any settings
2444 it contains.  The default @code{BUILD_CONFIG} can be set using the
2445 configure option @option{--with-build-config=@code{NAME}...}.  Some
2446 examples of supported build configurations are:
2448 @table @asis
2449 @item @samp{bootstrap-O1}
2450 Removes any @option{-O}-started option from @code{BOOT_CFLAGS}, and adds
2451 @option{-O1} to it.  @samp{BUILD_CONFIG=bootstrap-O1} is equivalent to
2452 @samp{BOOT_CFLAGS='-g -O1'}.
2454 @item @samp{bootstrap-O3}
2455 Analogous to @code{bootstrap-O1}.
2457 @item @samp{bootstrap-lto}
2458 Enables Link-Time Optimization for host tools during bootstrapping.
2459 @samp{BUILD_CONFIG=bootstrap-lto} is equivalent to adding
2460 @option{-flto} to @samp{BOOT_CFLAGS}.  This option assumes that the host
2461 supports the linker plugin (e.g. GNU ld version 2.21 or later or GNU gold
2462 version 2.21 or later).
2464 @item @samp{bootstrap-lto-noplugin}
2465 This option is similar to @code{bootstrap-lto}, but is intended for
2466 hosts that do not support the linker plugin.  Without the linker plugin 
2467 static libraries are not compiled with link-time optimizations.  Since 
2468 the GCC middle end and back end are in @file{libbackend.a} this means
2469 that only the front end is actually LTO optimized.
2471 @item @samp{bootstrap-debug}
2472 Verifies that the compiler generates the same executable code, whether
2473 or not it is asked to emit debug information.  To this end, this
2474 option builds stage2 host programs without debug information, and uses
2475 @file{contrib/compare-debug} to compare them with the stripped stage3
2476 object files.  If @code{BOOT_CFLAGS} is overridden so as to not enable
2477 debug information, stage2 will have it, and stage3 won't.  This option
2478 is enabled by default when GCC bootstrapping is enabled, if
2479 @code{strip} can turn object files compiled with and without debug
2480 info into identical object files.  In addition to better test
2481 coverage, this option makes default bootstraps faster and leaner.
2483 @item @samp{bootstrap-debug-big}
2484 Rather than comparing stripped object files, as in
2485 @code{bootstrap-debug}, this option saves internal compiler dumps
2486 during stage2 and stage3 and compares them as well, which helps catch
2487 additional potential problems, but at a great cost in terms of disk
2488 space.  It can be specified in addition to @samp{bootstrap-debug}.
2490 @item @samp{bootstrap-debug-lean}
2491 This option saves disk space compared with @code{bootstrap-debug-big},
2492 but at the expense of some recompilation.  Instead of saving the dumps
2493 of stage2 and stage3 until the final compare, it uses
2494 @option{-fcompare-debug} to generate, compare and remove the dumps
2495 during stage3, repeating the compilation that already took place in
2496 stage2, whose dumps were not saved.
2498 @item @samp{bootstrap-debug-lib}
2499 This option tests executable code invariance over debug information
2500 generation on target libraries, just like @code{bootstrap-debug-lean}
2501 tests it on host programs.  It builds stage3 libraries with
2502 @option{-fcompare-debug}, and it can be used along with any of the
2503 @code{bootstrap-debug} options above.
2505 There aren't @code{-lean} or @code{-big} counterparts to this option
2506 because most libraries are only build in stage3, so bootstrap compares
2507 would not get significant coverage.  Moreover, the few libraries built
2508 in stage2 are used in stage3 host programs, so we wouldn't want to
2509 compile stage2 libraries with different options for comparison purposes.
2511 @item @samp{bootstrap-debug-ckovw}
2512 Arranges for error messages to be issued if the compiler built on any
2513 stage is run without the option @option{-fcompare-debug}.  This is
2514 useful to verify the full @option{-fcompare-debug} testing coverage.  It
2515 must be used along with @code{bootstrap-debug-lean} and
2516 @code{bootstrap-debug-lib}.
2518 @item @samp{bootstrap-cet}
2519 This option enables Intel CET for host tools during bootstrapping.
2520 @samp{BUILD_CONFIG=bootstrap-cet} is equivalent to adding
2521 @option{-fcf-protection -mcet} to @samp{BOOT_CFLAGS}.  This option
2522 assumes that the host supports Intel CET (e.g. GNU assembler version
2523 2.30 or later).
2525 @item @samp{bootstrap-time}
2526 Arranges for the run time of each program started by the GCC driver,
2527 built in any stage, to be logged to @file{time.log}, in the top level of
2528 the build tree.
2530 @end table
2532 @section Building a cross compiler
2534 When building a cross compiler, it is not generally possible to do a
2535 3-stage bootstrap of the compiler.  This makes for an interesting problem
2536 as parts of GCC can only be built with GCC@.
2538 To build a cross compiler, we recommend first building and installing a
2539 native compiler.  You can then use the native GCC compiler to build the
2540 cross compiler.  The installed native compiler needs to be GCC version
2541 2.95 or later.
2543 Assuming you have already installed a native copy of GCC and configured
2544 your cross compiler, issue the command @command{make}, which performs the
2545 following steps:
2547 @itemize @bullet
2548 @item
2549 Build host tools necessary to build the compiler.
2551 @item
2552 Build target tools for use by the compiler such as binutils (bfd,
2553 binutils, gas, gprof, ld, and opcodes)
2554 if they have been individually linked or moved into the top level GCC source
2555 tree before configuring.
2557 @item
2558 Build the compiler (single stage only).
2560 @item
2561 Build runtime libraries using the compiler from the previous step.
2562 @end itemize
2564 Note that if an error occurs in any step the make process will exit.
2566 If you are not building GNU binutils in the same source tree as GCC,
2567 you will need a cross-assembler and cross-linker installed before
2568 configuring GCC@.  Put them in the directory
2569 @file{@var{prefix}/@var{target}/bin}.  Here is a table of the tools
2570 you should put in this directory:
2572 @table @file
2573 @item as
2574 This should be the cross-assembler.
2576 @item ld
2577 This should be the cross-linker.
2579 @item ar
2580 This should be the cross-archiver: a program which can manipulate
2581 archive files (linker libraries) in the target machine's format.
2583 @item ranlib
2584 This should be a program to construct a symbol table in an archive file.
2585 @end table
2587 The installation of GCC will find these programs in that directory,
2588 and copy or link them to the proper place to for the cross-compiler to
2589 find them when run later.
2591 The easiest way to provide these files is to build the Binutils package.
2592 Configure it with the same @option{--host} and @option{--target}
2593 options that you use for configuring GCC, then build and install
2594 them.  They install their executables automatically into the proper
2595 directory.  Alas, they do not support all the targets that GCC
2596 supports.
2598 If you are not building a C library in the same source tree as GCC,
2599 you should also provide the target libraries and headers before
2600 configuring GCC, specifying the directories with
2601 @option{--with-sysroot} or @option{--with-headers} and
2602 @option{--with-libs}.  Many targets also require ``start files'' such
2603 as @file{crt0.o} and
2604 @file{crtn.o} which are linked into each executable.  There may be several
2605 alternatives for @file{crt0.o}, for use with profiling or other
2606 compilation options.  Check your target's definition of
2607 @code{STARTFILE_SPEC} to find out what start files it uses.
2609 @section Building in parallel
2611 GNU Make 3.80 and above, which is necessary to build GCC, support
2612 building in parallel.  To activate this, you can use @samp{make -j 2}
2613 instead of @samp{make}.  You can also specify a bigger number, and
2614 in most cases using a value greater than the number of processors in
2615 your machine will result in fewer and shorter I/O latency hits, thus
2616 improving overall throughput; this is especially true for slow drives
2617 and network filesystems.
2619 @section Building the Ada compiler
2621 In order to build GNAT, the Ada compiler, you need a working GNAT
2622 compiler (GCC version 4.0 or later).
2623 This includes GNAT tools such as @command{gnatmake} and
2624 @command{gnatlink}, since the Ada front end is written in Ada and
2625 uses some GNAT-specific extensions.
2627 In order to build a cross compiler, it is suggested to install
2628 the new compiler as native first, and then use it to build the cross
2629 compiler.
2631 @command{configure} does not test whether the GNAT installation works
2632 and has a sufficiently recent version; if too old a GNAT version is
2633 installed, the build will fail unless @option{--enable-languages} is
2634 used to disable building the Ada front end.
2636 @env{ADA_INCLUDE_PATH} and @env{ADA_OBJECT_PATH} environment variables
2637 must not be set when building the Ada compiler, the Ada tools, or the
2638 Ada runtime libraries. You can check that your build environment is clean
2639 by verifying that @samp{gnatls -v} lists only one explicit path in each
2640 section.
2642 @section Building with profile feedback
2644 It is possible to use profile feedback to optimize the compiler itself.  This
2645 should result in a faster compiler binary.  Experiments done on x86 using gcc
2646 3.3 showed approximately 7 percent speedup on compiling C programs.  To
2647 bootstrap the compiler with profile feedback, use @code{make profiledbootstrap}.
2649 When @samp{make profiledbootstrap} is run, it will first build a @code{stage1}
2650 compiler.  This compiler is used to build a @code{stageprofile} compiler
2651 instrumented to collect execution counts of instruction and branch
2652 probabilities.  Training run is done by building @code{stagetrain}
2653 compiler.  Finally a @code{stagefeedback} compiler is built
2654 using the information collected.
2656 Unlike standard bootstrap, several additional restrictions apply.  The
2657 compiler used to build @code{stage1} needs to support a 64-bit integral type.
2658 It is recommended to only use GCC for this.
2660 On Linux/x86_64 hosts with some restrictions (no virtualization) it is
2661 also possible to do autofdo build with @samp{make
2662 autoprofiledback}. This uses Linux perf to sample branches in the
2663 binary and then rebuild it with feedback derived from the profile.
2664 Linux perf and the @code{autofdo} toolkit needs to be installed for
2665 this.
2667 Only the profile from the current build is used, so when an error
2668 occurs it is recommended to clean before restarting. Otherwise
2669 the code quality may be much worse.
2671 @html
2672 <hr />
2674 @end html
2675 @ifhtml
2676 @uref{./index.html,,Return to the GCC Installation page}
2677 @end ifhtml
2678 @end ifset
2680 @c ***Testing*****************************************************************
2681 @ifnothtml
2682 @comment node-name,     next,          previous, up
2683 @node    Testing, Final install, Building, Installing GCC
2684 @end ifnothtml
2685 @ifset testhtml
2686 @ifnothtml
2687 @chapter Installing GCC: Testing
2688 @end ifnothtml
2689 @cindex Testing
2690 @cindex Installing GCC: Testing
2691 @cindex Testsuite
2693 Before you install GCC, we encourage you to run the testsuites and to
2694 compare your results with results from a similar configuration that have
2695 been submitted to the
2696 @uref{http://gcc.gnu.org/ml/gcc-testresults/,,gcc-testresults mailing list}.
2697 Some of these archived results are linked from the build status lists
2698 at @uref{http://gcc.gnu.org/buildstat.html}, although not everyone who
2699 reports a successful build runs the testsuites and submits the results.
2700 This step is optional and may require you to download additional software,
2701 but it can give you confidence in your new GCC installation or point out
2702 problems before you install and start using your new GCC@.
2704 First, you must have @uref{download.html,,downloaded the testsuites}.
2705 These are part of the full distribution, but if you downloaded the
2706 ``core'' compiler plus any front ends, you must download the testsuites
2707 separately.
2709 Second, you must have the testing tools installed.  This includes
2710 @uref{http://www.gnu.org/software/dejagnu/,,DejaGnu}, Tcl, and Expect;
2711 the DejaGnu site has links to these. For running the BRIG frontend
2712 tests, a tool to assemble the binary BRIGs from HSAIL text,
2713 @uref{https://github.com/HSAFoundation/HSAIL-Tools/,,HSAILasm} must
2714 be installed.
2716 If the directories where @command{runtest} and @command{expect} were
2717 installed are not in the @env{PATH}, you may need to set the following
2718 environment variables appropriately, as in the following example (which
2719 assumes that DejaGnu has been installed under @file{/usr/local}):
2721 @smallexample
2722 TCL_LIBRARY = /usr/local/share/tcl8.0
2723 DEJAGNULIBS = /usr/local/share/dejagnu
2724 @end smallexample
2726 (On systems such as Cygwin, these paths are required to be actual
2727 paths, not mounts or links; presumably this is due to some lack of
2728 portability in the DejaGnu code.)
2731 Finally, you can run the testsuite (which may take a long time):
2732 @smallexample
2733 cd @var{objdir}; make -k check
2734 @end smallexample
2736 This will test various components of GCC, such as compiler
2737 front ends and runtime libraries.  While running the testsuite, DejaGnu
2738 might emit some harmless messages resembling
2739 @samp{WARNING: Couldn't find the global config file.} or
2740 @samp{WARNING: Couldn't find tool init file} that can be ignored.
2742 If you are testing a cross-compiler, you may want to run the testsuite
2743 on a simulator as described at @uref{http://gcc.gnu.org/simtest-howto.html}.
2745 @section How can you run the testsuite on selected tests?
2747 In order to run sets of tests selectively, there are targets
2748 @samp{make check-gcc} and language specific @samp{make check-c},
2749 @samp{make check-c++}, @samp{make check-fortran},
2750 @samp{make check-ada}, @samp{make check-objc}, @samp{make check-obj-c++},
2751 @samp{make check-lto}
2752 in the @file{gcc} subdirectory of the object directory.  You can also
2753 just run @samp{make check} in a subdirectory of the object directory.
2756 A more selective way to just run all @command{gcc} execute tests in the
2757 testsuite is to use
2759 @smallexample
2760 make check-gcc RUNTESTFLAGS="execute.exp @var{other-options}"
2761 @end smallexample
2763 Likewise, in order to run only the @command{g++} ``old-deja'' tests in
2764 the testsuite with filenames matching @samp{9805*}, you would use
2766 @smallexample
2767 make check-g++ RUNTESTFLAGS="old-deja.exp=9805* @var{other-options}"
2768 @end smallexample
2770 The file-matching expression following @var{filename}@command{.exp=} is treated
2771 as a series of whitespace-delimited glob expressions so that multiple patterns
2772 may be passed, although any whitespace must either be escaped or surrounded by
2773 single quotes if multiple expressions are desired. For example,
2775 @smallexample
2776 make check-g++ RUNTESTFLAGS="old-deja.exp=9805*\ virtual2.c @var{other-options}"
2777 make check-g++ RUNTESTFLAGS="'old-deja.exp=9805* virtual2.c' @var{other-options}"
2778 @end smallexample
2780 The @file{*.exp} files are located in the testsuite directories of the GCC
2781 source, the most important ones being @file{compile.exp},
2782 @file{execute.exp}, @file{dg.exp} and @file{old-deja.exp}.
2783 To get a list of the possible @file{*.exp} files, pipe the
2784 output of @samp{make check} into a file and look at the
2785 @samp{Running @dots{}  .exp} lines.
2787 @section Passing options and running multiple testsuites
2789 You can pass multiple options to the testsuite using the
2790 @samp{--target_board} option of DejaGNU, either passed as part of
2791 @samp{RUNTESTFLAGS}, or directly to @command{runtest} if you prefer to
2792 work outside the makefiles.  For example,
2794 @smallexample
2795 make check-g++ RUNTESTFLAGS="--target_board=unix/-O3/-fmerge-constants"
2796 @end smallexample
2798 will run the standard @command{g++} testsuites (``unix'' is the target name
2799 for a standard native testsuite situation), passing
2800 @samp{-O3 -fmerge-constants} to the compiler on every test, i.e.,
2801 slashes separate options.
2803 You can run the testsuites multiple times using combinations of options
2804 with a syntax similar to the brace expansion of popular shells:
2806 @smallexample
2807 @dots{}"--target_board=arm-sim\@{-mhard-float,-msoft-float\@}\@{-O1,-O2,-O3,\@}"
2808 @end smallexample
2810 (Note the empty option caused by the trailing comma in the final group.)
2811 The following will run each testsuite eight times using the @samp{arm-sim}
2812 target, as if you had specified all possible combinations yourself:
2814 @smallexample
2815 --target_board='arm-sim/-mhard-float/-O1 \
2816                 arm-sim/-mhard-float/-O2 \
2817                 arm-sim/-mhard-float/-O3 \
2818                 arm-sim/-mhard-float \
2819                 arm-sim/-msoft-float/-O1 \
2820                 arm-sim/-msoft-float/-O2 \
2821                 arm-sim/-msoft-float/-O3 \
2822                 arm-sim/-msoft-float'
2823 @end smallexample
2825 They can be combined as many times as you wish, in arbitrary ways.  This
2826 list:
2828 @smallexample
2829 @dots{}"--target_board=unix/-Wextra\@{-O3,-fno-strength\@}\@{-fomit-frame,\@}"
2830 @end smallexample
2832 will generate four combinations, all involving @samp{-Wextra}.
2834 The disadvantage to this method is that the testsuites are run in serial,
2835 which is a waste on multiprocessor systems.  For users with GNU Make and
2836 a shell which performs brace expansion, you can run the testsuites in
2837 parallel by having the shell perform the combinations and @command{make}
2838 do the parallel runs.  Instead of using @samp{--target_board}, use a
2839 special makefile target:
2841 @smallexample
2842 make -j@var{N} check-@var{testsuite}//@var{test-target}/@var{option1}/@var{option2}/@dots{}
2843 @end smallexample
2845 For example,
2847 @smallexample
2848 make -j3 check-gcc//sh-hms-sim/@{-m1,-m2,-m3,-m3e,-m4@}/@{,-nofpu@}
2849 @end smallexample
2851 will run three concurrent ``make-gcc'' testsuites, eventually testing all
2852 ten combinations as described above.  Note that this is currently only
2853 supported in the @file{gcc} subdirectory.  (To see how this works, try
2854 typing @command{echo} before the example given here.)
2857 @section How to interpret test results
2859 The result of running the testsuite are various @file{*.sum} and @file{*.log}
2860 files in the testsuite subdirectories.  The @file{*.log} files contain a
2861 detailed log of the compiler invocations and the corresponding
2862 results, the @file{*.sum} files summarize the results.  These summaries
2863 contain status codes for all tests:
2865 @itemize @bullet
2866 @item
2867 PASS: the test passed as expected
2868 @item
2869 XPASS: the test unexpectedly passed
2870 @item
2871 FAIL: the test unexpectedly failed
2872 @item
2873 XFAIL: the test failed as expected
2874 @item
2875 UNSUPPORTED: the test is not supported on this platform
2876 @item
2877 ERROR: the testsuite detected an error
2878 @item
2879 WARNING: the testsuite detected a possible problem
2880 @end itemize
2882 It is normal for some tests to report unexpected failures.  At the
2883 current time the testing harness does not allow fine grained control
2884 over whether or not a test is expected to fail.  This problem should
2885 be fixed in future releases.
2888 @section Submitting test results
2890 If you want to report the results to the GCC project, use the
2891 @file{contrib/test_summary} shell script.  Start it in the @var{objdir} with
2893 @smallexample
2894 @var{srcdir}/contrib/test_summary -p your_commentary.txt \
2895     -m gcc-testresults@@gcc.gnu.org |sh
2896 @end smallexample
2898 This script uses the @command{Mail} program to send the results, so
2899 make sure it is in your @env{PATH}.  The file @file{your_commentary.txt} is
2900 prepended to the testsuite summary and should contain any special
2901 remarks you have on your results or your build environment.  Please
2902 do not edit the testsuite result block or the subject line, as these
2903 messages may be automatically processed.
2905 @html
2906 <hr />
2908 @end html
2909 @ifhtml
2910 @uref{./index.html,,Return to the GCC Installation page}
2911 @end ifhtml
2912 @end ifset
2914 @c ***Final install***********************************************************
2915 @ifnothtml
2916 @comment node-name,     next,          previous, up
2917 @node    Final install, , Testing, Installing GCC
2918 @end ifnothtml
2919 @ifset finalinstallhtml
2920 @ifnothtml
2921 @chapter Installing GCC: Final installation
2922 @end ifnothtml
2924 Now that GCC has been built (and optionally tested), you can install it with
2925 @smallexample
2926 cd @var{objdir} && make install
2927 @end smallexample
2929 We strongly recommend to install into a target directory where there is
2930 no previous version of GCC present.  Also, the GNAT runtime should not
2931 be stripped, as this would break certain features of the debugger that
2932 depend on this debugging information (catching Ada exceptions for
2933 instance).
2935 That step completes the installation of GCC; user level binaries can
2936 be found in @file{@var{prefix}/bin} where @var{prefix} is the value
2937 you specified with the @option{--prefix} to configure (or
2938 @file{/usr/local} by default).  (If you specified @option{--bindir},
2939 that directory will be used instead; otherwise, if you specified
2940 @option{--exec-prefix}, @file{@var{exec-prefix}/bin} will be used.)
2941 Headers for the C++ library are installed in
2942 @file{@var{prefix}/include}; libraries in @file{@var{libdir}}
2943 (normally @file{@var{prefix}/lib}); internal parts of the compiler in
2944 @file{@var{libdir}/gcc} and @file{@var{libexecdir}/gcc}; documentation
2945 in info format in @file{@var{infodir}} (normally
2946 @file{@var{prefix}/info}).
2948 When installing cross-compilers, GCC's executables
2949 are not only installed into @file{@var{bindir}}, that
2950 is, @file{@var{exec-prefix}/bin}, but additionally into
2951 @file{@var{exec-prefix}/@var{target-alias}/bin}, if that directory
2952 exists.  Typically, such @dfn{tooldirs} hold target-specific
2953 binutils, including assembler and linker.
2955 Installation into a temporary staging area or into a @command{chroot}
2956 jail can be achieved with the command
2958 @smallexample
2959 make DESTDIR=@var{path-to-rootdir} install
2960 @end smallexample
2962 @noindent
2963 where @var{path-to-rootdir} is the absolute path of
2964 a directory relative to which all installation paths will be
2965 interpreted.  Note that the directory specified by @code{DESTDIR}
2966 need not exist yet; it will be created if necessary.
2968 There is a subtle point with tooldirs and @code{DESTDIR}:
2969 If you relocate a cross-compiler installation with
2970 e.g.@: @samp{DESTDIR=@var{rootdir}}, then the directory
2971 @file{@var{rootdir}/@var{exec-prefix}/@var{target-alias}/bin} will
2972 be filled with duplicated GCC executables only if it already exists,
2973 it will not be created otherwise.  This is regarded as a feature,
2974 not as a bug, because it gives slightly more control to the packagers
2975 using the @code{DESTDIR} feature.
2977 You can install stripped programs and libraries with
2979 @smallexample
2980 make install-strip
2981 @end smallexample
2983 If you are bootstrapping a released version of GCC then please
2984 quickly review the build status page for your release, available from
2985 @uref{http://gcc.gnu.org/buildstat.html}.
2986 If your system is not listed for the version of GCC that you built,
2987 send a note to
2988 @email{gcc@@gcc.gnu.org} indicating
2989 that you successfully built and installed GCC@.
2990 Include the following information:
2992 @itemize @bullet
2993 @item
2994 Output from running @file{@var{srcdir}/config.guess}.  Do not send
2995 that file itself, just the one-line output from running it.
2997 @item
2998 The output of @samp{gcc -v} for your newly installed @command{gcc}.
2999 This tells us which version of GCC you built and the options you passed to
3000 configure.
3002 @item
3003 Whether you enabled all languages or a subset of them.  If you used a
3004 full distribution then this information is part of the configure
3005 options in the output of @samp{gcc -v}, but if you downloaded the
3006 ``core'' compiler plus additional front ends then it isn't apparent
3007 which ones you built unless you tell us about it.
3009 @item
3010 If the build was for GNU/Linux, also include:
3011 @itemize @bullet
3012 @item
3013 The distribution name and version (e.g., Red Hat 7.1 or Debian 2.2.3);
3014 this information should be available from @file{/etc/issue}.
3016 @item
3017 The version of the Linux kernel, available from @samp{uname --version}
3018 or @samp{uname -a}.
3020 @item
3021 The version of glibc you used; for RPM-based systems like Red Hat,
3022 Mandrake, and SuSE type @samp{rpm -q glibc} to get the glibc version,
3023 and on systems like Debian and Progeny use @samp{dpkg -l libc6}.
3024 @end itemize
3025 For other systems, you can include similar information if you think it is
3026 relevant.
3028 @item
3029 Any other information that you think would be useful to people building
3030 GCC on the same configuration.  The new entry in the build status list
3031 will include a link to the archived copy of your message.
3032 @end itemize
3034 We'd also like to know if the
3035 @ifnothtml
3036 @ref{Specific, host/target specific installation notes}
3037 @end ifnothtml
3038 @ifhtml
3039 @uref{specific.html,,host/target specific installation notes}
3040 @end ifhtml
3041 didn't include your host/target information or if that information is
3042 incomplete or out of date.  Send a note to
3043 @email{gcc@@gcc.gnu.org} detailing how the information should be changed.
3045 If you find a bug, please report it following the
3046 @uref{../bugs/,,bug reporting guidelines}.
3048 If you want to print the GCC manuals, do @samp{cd @var{objdir}; make
3049 dvi}.  You will need to have @command{texi2dvi} (version at least 4.7)
3050 and @TeX{} installed.  This creates a number of @file{.dvi} files in
3051 subdirectories of @file{@var{objdir}}; these may be converted for
3052 printing with programs such as @command{dvips}.  Alternately, by using
3053 @samp{make pdf} in place of @samp{make dvi}, you can create documentation
3054 in the form of @file{.pdf} files; this requires @command{texi2pdf}, which
3055 is included with Texinfo version 4.8 and later.  You can also
3056 @uref{https://shop.fsf.org/,,buy printed manuals from the
3057 Free Software Foundation}, though such manuals may not be for the most
3058 recent version of GCC@.
3060 If you would like to generate online HTML documentation, do @samp{cd
3061 @var{objdir}; make html} and HTML will be generated for the gcc manuals in
3062 @file{@var{objdir}/gcc/HTML}.
3064 @html
3065 <hr />
3067 @end html
3068 @ifhtml
3069 @uref{./index.html,,Return to the GCC Installation page}
3070 @end ifhtml
3071 @end ifset
3073 @c ***Binaries****************************************************************
3074 @ifnothtml
3075 @comment node-name,     next,          previous, up
3076 @node    Binaries, Specific, Installing GCC, Top
3077 @end ifnothtml
3078 @ifset binarieshtml
3079 @ifnothtml
3080 @chapter Installing GCC: Binaries
3081 @end ifnothtml
3082 @cindex Binaries
3083 @cindex Installing GCC: Binaries
3085 We are often asked about pre-compiled versions of GCC@.  While we cannot
3086 provide these for all platforms, below you'll find links to binaries for
3087 various platforms where creating them by yourself is not easy due to various
3088 reasons.
3090 Please note that we did not create these binaries, nor do we
3091 support them.  If you have any problems installing them, please
3092 contact their makers.
3094 @itemize
3095 @item
3096 AIX:
3097 @itemize
3098 @item
3099 @uref{http://www.bullfreeware.com,,Bull's Open Source Software Archive for
3100 for AIX 5L and AIX 6};
3102 @item
3103 @uref{http://www.perzl.org/aix/,,AIX Open Source Packages (AIX5L AIX 6.1
3104 AIX 7.1)}.
3105 @end itemize
3107 @item
3108 DOS---@uref{http://www.delorie.com/djgpp/,,DJGPP}.
3110 @item
3111 HP-UX:
3112 @itemize
3113 @item
3114 @uref{http://hpux.connect.org.uk/,,HP-UX Porting Center};
3115 @end itemize
3117 @item
3118 Solaris 2 (SPARC, Intel):
3119 @itemize
3120 @item
3121 @uref{https://www.opencsw.org/,,OpenCSW}
3123 @item
3124 @uref{http://jupiterrise.com/tgcware/,,TGCware}
3125 @end itemize
3127 @item
3128 macOS:
3129 @itemize
3130 @item
3131 The @uref{https://brew.sh,,Homebrew} package manager;
3132 @item
3133 @uref{https://www.macports.org,,MacPorts}.
3134 @end itemize
3136 @item
3137 Microsoft Windows:
3138 @itemize
3139 @item
3140 The @uref{https://sourceware.org/cygwin/,,Cygwin} project;
3141 @item
3142 The @uref{http://www.mingw.org/,,MinGW} and
3143 @uref{http://mingw-w64.org/doku.php,,mingw-w64} projects.
3144 @end itemize
3146 @item
3147 @uref{http://www.openpkg.org/,,OpenPKG} offers binaries for quite a
3148 number of platforms.
3150 @item
3151 The @uref{http://gcc.gnu.org/wiki/GFortranBinaries,,GFortran Wiki} has
3152 links to GNU Fortran binaries for several platforms.
3153 @end itemize
3155 @html
3156 <hr />
3158 @end html
3159 @ifhtml
3160 @uref{./index.html,,Return to the GCC Installation page}
3161 @end ifhtml
3162 @end ifset
3164 @c ***Specific****************************************************************
3165 @ifnothtml
3166 @comment node-name,     next,          previous, up
3167 @node    Specific, Old, Binaries, Top
3168 @end ifnothtml
3169 @ifset specifichtml
3170 @ifnothtml
3171 @chapter Host/target specific installation notes for GCC
3172 @end ifnothtml
3173 @cindex Specific
3174 @cindex Specific installation notes
3175 @cindex Target specific installation
3176 @cindex Host specific installation
3177 @cindex Target specific installation notes
3179 Please read this document carefully @emph{before} installing the
3180 GNU Compiler Collection on your machine.
3182 Note that this list of install notes is @emph{not} a list of supported
3183 hosts or targets.  Not all supported hosts and targets are listed
3184 here, only the ones that require host-specific or target-specific
3185 information have to. 
3187 @ifhtml
3188 @itemize
3189 @item
3190 @uref{#aarch64-x-x,,aarch64*-*-*}
3191 @item
3192 @uref{#alpha-x-x,,alpha*-*-*}
3193 @item
3194 @uref{#amd64-x-solaris210,,amd64-*-solaris2.10}
3195 @item
3196 @uref{#arm-x-eabi,,arm-*-eabi}
3197 @item
3198 @uref{#avr,,avr}
3199 @item
3200 @uref{#bfin,,Blackfin}
3201 @item
3202 @uref{#dos,,DOS}
3203 @item
3204 @uref{#x-x-freebsd,,*-*-freebsd*}
3205 @item
3206 @uref{#h8300-hms,,h8300-hms}
3207 @item
3208 @uref{#hppa-hp-hpux,,hppa*-hp-hpux*}
3209 @item
3210 @uref{#hppa-hp-hpux10,,hppa*-hp-hpux10}
3211 @item
3212 @uref{#hppa-hp-hpux11,,hppa*-hp-hpux11}
3213 @item
3214 @uref{#x-x-linux-gnu,,*-*-linux-gnu}
3215 @item
3216 @uref{#ix86-x-linux,,i?86-*-linux*}
3217 @item
3218 @uref{#ix86-x-solaris210,,i?86-*-solaris2.10}
3219 @item
3220 @uref{#ia64-x-linux,,ia64-*-linux}
3221 @item
3222 @uref{#ia64-x-hpux,,ia64-*-hpux*}
3223 @item
3224 @uref{#x-ibm-aix,,*-ibm-aix*}
3225 @item
3226 @uref{#iq2000-x-elf,,iq2000-*-elf}
3227 @item
3228 @uref{#lm32-x-elf,,lm32-*-elf}
3229 @item
3230 @uref{#lm32-x-uclinux,,lm32-*-uclinux}
3231 @item
3232 @uref{#m32c-x-elf,,m32c-*-elf}
3233 @item
3234 @uref{#m32r-x-elf,,m32r-*-elf}
3235 @item
3236 @uref{#m68k-x-x,,m68k-*-*}
3237 @item
3238 @uref{#m68k-uclinux,,m68k-uclinux}
3239 @item
3240 @uref{#microblaze-x-elf,,microblaze-*-elf}
3241 @item
3242 @uref{#mips-x-x,,mips-*-*}
3243 @item
3244 @uref{#nds32le-x-elf,,nds32le-*-elf}
3245 @item
3246 @uref{#nds32be-x-elf,,nds32be-*-elf}
3247 @item
3248 @uref{#nvptx-x-none,,nvptx-*-none}
3249 @item
3250 @uref{#powerpc-x-x,,powerpc*-*-*}
3251 @item
3252 @uref{#powerpc-x-darwin,,powerpc-*-darwin*}
3253 @item
3254 @uref{#powerpc-x-elf,,powerpc-*-elf}
3255 @item
3256 @uref{#powerpc-x-linux-gnu,,powerpc*-*-linux-gnu*}
3257 @item
3258 @uref{#powerpc-x-netbsd,,powerpc-*-netbsd*}
3259 @item
3260 @uref{#powerpc-x-eabisim,,powerpc-*-eabisim}
3261 @item
3262 @uref{#powerpc-x-eabi,,powerpc-*-eabi}
3263 @item
3264 @uref{#powerpcle-x-elf,,powerpcle-*-elf}
3265 @item
3266 @uref{#powerpcle-x-eabisim,,powerpcle-*-eabisim}
3267 @item
3268 @uref{#powerpcle-x-eabi,,powerpcle-*-eabi}
3269 @item
3270 @uref{#riscv32-x-elf,,riscv32-*-elf}
3271 @item
3272 @uref{#riscv32-x-linux,,riscv32-*-linux}
3273 @item
3274 @uref{#riscv64-x-elf,,riscv64-*-elf}
3275 @item
3276 @uref{#riscv64-x-linux,,riscv64-*-linux}
3277 @item
3278 @uref{#s390-x-linux,,s390-*-linux*}
3279 @item
3280 @uref{#s390x-x-linux,,s390x-*-linux*}
3281 @item
3282 @uref{#s390x-ibm-tpf,,s390x-ibm-tpf*}
3283 @item
3284 @uref{#x-x-solaris2,,*-*-solaris2*}
3285 @item
3286 @uref{#sparc-x-x,,sparc*-*-*}
3287 @item
3288 @uref{#sparc-sun-solaris2,,sparc-sun-solaris2*}
3289 @item
3290 @uref{#sparc-sun-solaris210,,sparc-sun-solaris2.10}
3291 @item
3292 @uref{#sparc-x-linux,,sparc-*-linux*}
3293 @item
3294 @uref{#sparc64-x-solaris2,,sparc64-*-solaris2*}
3295 @item
3296 @uref{#sparcv9-x-solaris2,,sparcv9-*-solaris2*}
3297 @item
3298 @uref{#c6x-x-x,,c6x-*-*}
3299 @item
3300 @uref{#tilegx-x-linux,,tilegx-*-linux*}
3301 @item
3302 @uref{#tilegxbe-x-linux,,tilegxbe-*-linux*}
3303 @item
3304 @uref{#tilepro-x-linux,,tilepro-*-linux*}
3305 @item
3306 @uref{#visium-x-elf, visium-*-elf}
3307 @item
3308 @uref{#x-x-vxworks,,*-*-vxworks*}
3309 @item
3310 @uref{#x86-64-x-x,,x86_64-*-*, amd64-*-*}
3311 @item
3312 @uref{#x86-64-x-solaris210,,x86_64-*-solaris2.1[0-9]*}
3313 @item
3314 @uref{#xtensa-x-elf,,xtensa*-*-elf}
3315 @item
3316 @uref{#xtensa-x-linux,,xtensa*-*-linux*}
3317 @item
3318 @uref{#windows,,Microsoft Windows}
3319 @item
3320 @uref{#x-x-cygwin,,*-*-cygwin}
3321 @item
3322 @uref{#x-x-mingw32,,*-*-mingw32}
3323 @item
3324 @uref{#os2,,OS/2}
3325 @item
3326 @uref{#older,,Older systems}
3327 @end itemize
3329 @itemize
3330 @item
3331 @uref{#elf,,all ELF targets} (SVR4, Solaris 2, etc.)
3332 @end itemize
3333 @end ifhtml
3336 @html
3337 <!-- -------- host/target specific issues start here ---------------- -->
3338 <hr />
3339 @end html
3340 @anchor{aarch64-x-x}
3341 @heading aarch64*-*-*
3342 Binutils pre 2.24 does not have support for selecting @option{-mabi} and
3343 does not support ILP32.  If it is used to build GCC 4.9 or later, GCC will
3344 not support option @option{-mabi=ilp32}.
3346 To enable a workaround for the Cortex-A53 erratum number 835769 by default
3347 (for all CPUs regardless of -mcpu option given) at configure time use the
3348 @option{--enable-fix-cortex-a53-835769} option.  This will enable the fix by
3349 default and can be explicitly disabled during compilation by passing the
3350 @option{-mno-fix-cortex-a53-835769} option.  Conversely,
3351 @option{--disable-fix-cortex-a53-835769} will disable the workaround by
3352 default.  The workaround is disabled by default if neither of
3353 @option{--enable-fix-cortex-a53-835769} or
3354 @option{--disable-fix-cortex-a53-835769} is given at configure time.
3356 To enable a workaround for the Cortex-A53 erratum number 843419 by default
3357 (for all CPUs regardless of -mcpu option given) at configure time use the
3358 @option{--enable-fix-cortex-a53-843419} option.  This workaround is applied at
3359 link time.  Enabling the workaround will cause GCC to pass the relevant option
3360 to the linker.  It can be explicitly disabled during compilation by passing the
3361 @option{-mno-fix-cortex-a53-843419} option.  Conversely,
3362 @option{--disable-fix-cortex-a53-843419} will disable the workaround by default.
3363 The workaround is disabled by default if neither of
3364 @option{--enable-fix-cortex-a53-843419} or
3365 @option{--disable-fix-cortex-a53-843419} is given at configure time.
3367 @html
3368 <hr />
3369 @end html
3370 @anchor{alpha-x-x}
3371 @heading alpha*-*-*
3372 This section contains general configuration information for all
3373 Alpha-based platforms using ELF@.  In addition to reading this
3374 section, please read all other sections that match your target.
3376 We require binutils 2.11.2 or newer.
3377 Previous binutils releases had a number of problems with DWARF 2
3378 debugging information, not the least of which is incorrect linking of
3379 shared libraries.
3381 @html
3382 <hr />
3383 @end html
3384 @anchor{amd64-x-solaris210}
3385 @heading amd64-*-solaris2.1[0-9]*
3386 This is a synonym for @samp{x86_64-*-solaris2.1[0-9]*}.
3388 @html
3389 <hr />
3390 @end html
3391 @anchor{arc-x-elf32}
3392 @heading arc-*-elf32
3394 Use @samp{configure --target=arc-elf32 --with-cpu=@var{cpu} --enable-languages="c,c++"}
3395 to configure GCC, with @var{cpu} being one of @samp{arc600}, @samp{arc601},
3396 or @samp{arc700}@.
3398 @html
3399 <hr />
3400 @end html
3401 @anchor{arc-linux-uclibc}
3402 @heading arc-linux-uclibc
3404 Use @samp{configure --target=arc-linux-uclibc --with-cpu=arc700 --enable-languages="c,c++"} to configure GCC@.
3406 @html
3407 <hr />
3408 @end html
3409 @anchor{arm-x-eabi}
3410 @heading arm-*-eabi
3411 ARM-family processors.
3413 Building the Ada frontend commonly fails (an infinite loop executing
3414 @code{xsinfo}) if the host compiler is GNAT 4.8.  Host compilers built from the
3415 GNAT 4.6, 4.9 or 5 release branches are known to succeed.
3417 @html
3418 <hr />
3419 @end html
3420 @anchor{avr}
3421 @heading avr
3422 ATMEL AVR-family micro controllers.  These are used in embedded
3423 applications.  There are no standard Unix configurations.
3424 @ifnothtml
3425 @xref{AVR Options,, AVR Options, gcc, Using the GNU Compiler
3426 Collection (GCC)},
3427 @end ifnothtml
3428 @ifhtml
3429 See ``AVR Options'' in the main manual
3430 @end ifhtml
3431 for the list of supported MCU types.
3433 Use @samp{configure --target=avr --enable-languages="c"} to configure GCC@.
3435 Further installation notes and other useful information about AVR tools
3436 can also be obtained from:
3438 @itemize @bullet
3439 @item
3440 @uref{http://www.nongnu.org/avr/,,http://www.nongnu.org/avr/}
3441 @item
3442 @uref{http://www.amelek.gda.pl/avr/,,http://www.amelek.gda.pl/avr/}
3443 @end itemize
3445 The following error:
3446 @smallexample
3447 Error: register required
3448 @end smallexample
3450 indicates that you should upgrade to a newer version of the binutils.
3452 @html
3453 <hr />
3454 @end html
3455 @anchor{bfin}
3456 @heading Blackfin
3457 The Blackfin processor, an Analog Devices DSP.
3458 @ifnothtml
3459 @xref{Blackfin Options,, Blackfin Options, gcc, Using the GNU Compiler
3460 Collection (GCC)},
3461 @end ifnothtml
3462 @ifhtml
3463 See ``Blackfin Options'' in the main manual
3464 @end ifhtml
3466 More information, and a version of binutils with support for this processor,
3467 is available at @uref{https://blackfin.uclinux.org}
3469 @html
3470 <hr />
3471 @end html
3472 @anchor{cr16}
3473 @heading CR16
3474 The CR16 CompactRISC architecture is a 16-bit architecture. This
3475 architecture is used in embedded applications.
3477 @ifnothtml
3478 @xref{CR16 Options,, CR16 Options, gcc, Using and Porting the GNU Compiler
3479 Collection (GCC)},
3480 @end ifnothtml
3482 @ifhtml
3483 See ``CR16 Options'' in the main manual for a list of CR16-specific options.
3484 @end ifhtml
3486 Use @samp{configure --target=cr16-elf --enable-languages=c,c++} to configure
3487 GCC@ for building a CR16 elf cross-compiler.
3489 Use @samp{configure --target=cr16-uclinux --enable-languages=c,c++} to
3490 configure GCC@ for building a CR16 uclinux cross-compiler.
3492 @html
3493 <hr />
3494 @end html
3495 @anchor{cris}
3496 @heading CRIS
3497 CRIS is the CPU architecture in Axis Communications ETRAX system-on-a-chip
3498 series.  These are used in embedded applications.
3500 @ifnothtml
3501 @xref{CRIS Options,, CRIS Options, gcc, Using the GNU Compiler
3502 Collection (GCC)},
3503 @end ifnothtml
3504 @ifhtml
3505 See ``CRIS Options'' in the main manual
3506 @end ifhtml
3507 for a list of CRIS-specific options.
3509 There are a few different CRIS targets:
3510 @table @code
3511 @item cris-axis-elf
3512 Mainly for monolithic embedded systems.  Includes a multilib for the
3513 @samp{v10} core used in @samp{ETRAX 100 LX}.
3514 @item cris-axis-linux-gnu
3515 A GNU/Linux port for the CRIS architecture, currently targeting
3516 @samp{ETRAX 100 LX} by default.
3517 @end table
3519 Pre-packaged tools can be obtained from
3520 @uref{ftp://ftp.axis.com/@/pub/@/axis/@/tools/@/cris/@/compiler-kit/}.  More
3521 information about this platform is available at
3522 @uref{http://developer.axis.com/}.
3524 @html
3525 <hr />
3526 @end html
3527 @anchor{dos}
3528 @heading DOS
3529 Please have a look at the @uref{binaries.html,,binaries page}.
3531 You cannot install GCC by itself on MSDOS; it will not compile under
3532 any MSDOS compiler except itself.  You need to get the complete
3533 compilation package DJGPP, which includes binaries as well as sources,
3534 and includes all the necessary compilation tools and libraries.
3536 @html
3537 <hr />
3538 @end html
3539 @anchor{epiphany-x-elf}
3540 @heading epiphany-*-elf
3541 Adapteva Epiphany.
3542 This configuration is intended for embedded systems.
3544 @html
3545 <hr />
3546 @end html
3547 @anchor{x-x-freebsd}
3548 @heading *-*-freebsd*
3549 Support for FreeBSD 1 was discontinued in GCC 3.2.  Support for
3550 FreeBSD 2 (and any mutant a.out variants of FreeBSD 3) was
3551 discontinued in GCC 4.0.
3553 In order to better utilize FreeBSD base system functionality and match
3554 the configuration of the system compiler, GCC 4.5 and above as well as
3555 GCC 4.4 past 2010-06-20 leverage SSP support in libc (which is present
3556 on FreeBSD 7 or later) and the use of @code{__cxa_atexit} by default
3557 (on FreeBSD 6 or later).  The use of @code{dl_iterate_phdr} inside
3558 @file{libgcc_s.so.1} and boehm-gc (on FreeBSD 7 or later) is enabled
3559 by GCC 4.5 and above.
3561 We support FreeBSD using the ELF file format with DWARF 2 debugging
3562 for all CPU architectures.  You may use @option{-gstabs} instead of
3563 @option{-g}, if you really want the old debugging format.  There are
3564 no known issues with mixing object files and libraries with different
3565 debugging formats.  Otherwise, this release of GCC should now match
3566 more of the configuration used in the stock FreeBSD configuration of
3567 GCC@.  In particular, @option{--enable-threads} is now configured by
3568 default.  However, as a general user, do not attempt to replace the
3569 system compiler with this release.  Known to bootstrap and check with
3570 good results on FreeBSD 7.2-STABLE@.  In the past, known to bootstrap
3571 and check with good results on FreeBSD 3.0, 3.4, 4.0, 4.2, 4.3, 4.4,
3572 4.5, 4.8, 4.9 and 5-CURRENT@.
3574 The version of binutils installed in @file{/usr/bin} probably works
3575 with this release of GCC@.  Bootstrapping against the latest GNU
3576 binutils and/or the version found in @file{/usr/ports/devel/binutils} has
3577 been known to enable additional features and improve overall testsuite
3578 results.  However, it is currently known that boehm-gc may not configure
3579 properly on FreeBSD prior to the FreeBSD 7.0 release with GNU binutils
3580 after 2.16.1.
3582 @html
3583 <hr />
3584 @end html
3585 @anchor{ft32-x-elf}
3586 @heading ft32-*-elf
3587 The FT32 processor.
3588 This configuration is intended for embedded systems.
3590 @html
3591 <hr />
3592 @end html
3593 @anchor{h8300-hms}
3594 @heading h8300-hms
3595 Renesas H8/300 series of processors.
3597 Please have a look at the @uref{binaries.html,,binaries page}.
3599 The calling convention and structure layout has changed in release 2.6.
3600 All code must be recompiled.  The calling convention now passes the
3601 first three arguments in function calls in registers.  Structures are no
3602 longer a multiple of 2 bytes.
3604 @html
3605 <hr />
3606 @end html
3607 @anchor{hppa-hp-hpux}
3608 @heading hppa*-hp-hpux*
3609 Support for HP-UX version 9 and older was discontinued in GCC 3.4.
3611 We require using gas/binutils on all hppa platforms.  Version 2.19 or
3612 later is recommended.
3614 It may be helpful to configure GCC with the
3615 @uref{./configure.html#with-gnu-as,,@option{--with-gnu-as}} and
3616 @option{--with-as=@dots{}} options to ensure that GCC can find GAS@.
3618 The HP assembler should not be used with GCC.  It is rarely tested and may
3619 not work.  It shouldn't be used with any languages other than C due to its
3620 many limitations.
3622 Specifically, @option{-g} does not work (HP-UX uses a peculiar debugging
3623 format which GCC does not know about).  It also inserts timestamps
3624 into each object file it creates, causing the 3-stage comparison test to
3625 fail during a bootstrap.  You should be able to continue by saying
3626 @samp{make all-host all-target} after getting the failure from @samp{make}.
3628 Various GCC features are not supported.  For example, it does not support weak
3629 symbols or alias definitions.  As a result, explicit template instantiations
3630 are required when using C++.  This makes it difficult if not impossible to
3631 build many C++ applications.
3633 There are two default scheduling models for instructions.  These are
3634 PROCESSOR_7100LC and PROCESSOR_8000.  They are selected from the pa-risc
3635 architecture specified for the target machine when configuring.
3636 PROCESSOR_8000 is the default.  PROCESSOR_7100LC is selected when
3637 the target is a @samp{hppa1*} machine.
3639 The PROCESSOR_8000 model is not well suited to older processors.  Thus,
3640 it is important to completely specify the machine architecture when
3641 configuring if you want a model other than PROCESSOR_8000.  The macro
3642 TARGET_SCHED_DEFAULT can be defined in BOOT_CFLAGS if a different
3643 default scheduling model is desired.
3645 As of GCC 4.0, GCC uses the UNIX 95 namespace for HP-UX 10.10
3646 through 11.00, and the UNIX 98 namespace for HP-UX 11.11 and later.
3647 This namespace change might cause problems when bootstrapping with
3648 an earlier version of GCC or the HP compiler as essentially the same
3649 namespace is required for an entire build.  This problem can be avoided
3650 in a number of ways.  With HP cc, @env{UNIX_STD} can be set to @samp{95}
3651 or @samp{98}.  Another way is to add an appropriate set of predefines
3652 to @env{CC}.  The description for the @option{munix=} option contains
3653 a list of the predefines used with each standard.
3655 More specific information to @samp{hppa*-hp-hpux*} targets follows.
3657 @html
3658 <hr />
3659 @end html
3660 @anchor{hppa-hp-hpux10}
3661 @heading hppa*-hp-hpux10
3662 For hpux10.20, we @emph{highly} recommend you pick up the latest sed patch
3663 @code{PHCO_19798} from HP@.
3665 The C++ ABI has changed incompatibly in GCC 4.0.  COMDAT subspaces are
3666 used for one-only code and data.  This resolves many of the previous
3667 problems in using C++ on this target.  However, the ABI is not compatible
3668 with the one implemented under HP-UX 11 using secondary definitions.
3670 @html
3671 <hr />
3672 @end html
3673 @anchor{hppa-hp-hpux11}
3674 @heading hppa*-hp-hpux11
3675 GCC 3.0 and up support HP-UX 11.  GCC 2.95.x is not supported and cannot
3676 be used to compile GCC 3.0 and up.
3678 The libffi library haven't been ported to 64-bit HP-UX@ and doesn't build.
3680 Refer to @uref{binaries.html,,binaries} for information about obtaining
3681 precompiled GCC binaries for HP-UX@.  Precompiled binaries must be obtained
3682 to build the Ada language as it cannot be bootstrapped using C@.  Ada is
3683 only available for the 32-bit PA-RISC runtime.
3685 Starting with GCC 3.4 an ISO C compiler is required to bootstrap.  The
3686 bundled compiler supports only traditional C; you will need either HP's
3687 unbundled compiler, or a binary distribution of GCC@.
3689 It is possible to build GCC 3.3 starting with the bundled HP compiler,
3690 but the process requires several steps.  GCC 3.3 can then be used to
3691 build later versions.
3693 There are several possible approaches to building the distribution.
3694 Binutils can be built first using the HP tools.  Then, the GCC
3695 distribution can be built.  The second approach is to build GCC
3696 first using the HP tools, then build binutils, then rebuild GCC@.
3697 There have been problems with various binary distributions, so it
3698 is best not to start from a binary distribution.
3700 On 64-bit capable systems, there are two distinct targets.  Different
3701 installation prefixes must be used if both are to be installed on
3702 the same system.  The @samp{hppa[1-2]*-hp-hpux11*} target generates code
3703 for the 32-bit PA-RISC runtime architecture and uses the HP linker.
3704 The @samp{hppa64-hp-hpux11*} target generates 64-bit code for the
3705 PA-RISC 2.0 architecture.
3707 The script config.guess now selects the target type based on the compiler
3708 detected during configuration.  You must define @env{PATH} or @env{CC} so
3709 that configure finds an appropriate compiler for the initial bootstrap.
3710 When @env{CC} is used, the definition should contain the options that are
3711 needed whenever @env{CC} is used.
3713 Specifically, options that determine the runtime architecture must be
3714 in @env{CC} to correctly select the target for the build.  It is also
3715 convenient to place many other compiler options in @env{CC}.  For example,
3716 @env{CC="cc -Ac +DA2.0W -Wp,-H16376 -D_CLASSIC_TYPES -D_HPUX_SOURCE"}
3717 can be used to bootstrap the GCC 3.3 branch with the HP compiler in
3718 64-bit K&R/bundled mode.  The @option{+DA2.0W} option will result in
3719 the automatic selection of the @samp{hppa64-hp-hpux11*} target.  The
3720 macro definition table of cpp needs to be increased for a successful
3721 build with the HP compiler.  _CLASSIC_TYPES and _HPUX_SOURCE need to
3722 be defined when building with the bundled compiler, or when using the
3723 @option{-Ac} option.  These defines aren't necessary with @option{-Ae}.
3725 It is best to explicitly configure the @samp{hppa64-hp-hpux11*} target
3726 with the @option{--with-ld=@dots{}} option.  This overrides the standard
3727 search for ld.  The two linkers supported on this target require different
3728 commands.  The default linker is determined during configuration.  As a
3729 result, it's not possible to switch linkers in the middle of a GCC build.
3730 This has been reported to sometimes occur in unified builds of binutils
3731 and GCC@.
3733 A recent linker patch must be installed for the correct operation of
3734 GCC 3.3 and later.  @code{PHSS_26559} and @code{PHSS_24304} are the
3735 oldest linker patches that are known to work.  They are for HP-UX
3736 11.00 and 11.11, respectively.  @code{PHSS_24303}, the companion to
3737 @code{PHSS_24304}, might be usable but it hasn't been tested.  These
3738 patches have been superseded.  Consult the HP patch database to obtain
3739 the currently recommended linker patch for your system.
3741 The patches are necessary for the support of weak symbols on the
3742 32-bit port, and for the running of initializers and finalizers.  Weak
3743 symbols are implemented using SOM secondary definition symbols.  Prior
3744 to HP-UX 11, there are bugs in the linker support for secondary symbols.
3745 The patches correct a problem of linker core dumps creating shared
3746 libraries containing secondary symbols, as well as various other
3747 linking issues involving secondary symbols.
3749 GCC 3.3 uses the ELF DT_INIT_ARRAY and DT_FINI_ARRAY capabilities to
3750 run initializers and finalizers on the 64-bit port.  The 32-bit port
3751 uses the linker @option{+init} and @option{+fini} options for the same
3752 purpose.  The patches correct various problems with the +init/+fini
3753 options, including program core dumps.  Binutils 2.14 corrects a
3754 problem on the 64-bit port resulting from HP's non-standard use of
3755 the .init and .fini sections for array initializers and finalizers.
3757 Although the HP and GNU linkers are both supported for the
3758 @samp{hppa64-hp-hpux11*} target, it is strongly recommended that the
3759 HP linker be used for link editing on this target.
3761 At this time, the GNU linker does not support the creation of long
3762 branch stubs.  As a result, it cannot successfully link binaries
3763 containing branch offsets larger than 8 megabytes.  In addition,
3764 there are problems linking shared libraries, linking executables
3765 with @option{-static}, and with dwarf2 unwind and exception support.
3766 It also doesn't provide stubs for internal calls to global functions
3767 in shared libraries, so these calls cannot be overloaded.
3769 The HP dynamic loader does not support GNU symbol versioning, so symbol
3770 versioning is not supported.  It may be necessary to disable symbol
3771 versioning with @option{--disable-symvers} when using GNU ld.
3773 POSIX threads are the default.  The optional DCE thread library is not
3774 supported, so @option{--enable-threads=dce} does not work.
3776 @html
3777 <hr />
3778 @end html
3779 @anchor{x-x-linux-gnu}
3780 @heading *-*-linux-gnu
3781 Versions of libstdc++-v3 starting with 3.2.1 require bug fixes present
3782 in glibc 2.2.5 and later.  More information is available in the
3783 libstdc++-v3 documentation.
3785 @html
3786 <hr />
3787 @end html
3788 @anchor{ix86-x-linux}
3789 @heading i?86-*-linux*
3790 As of GCC 3.3, binutils 2.13.1 or later is required for this platform.
3791 See @uref{http://gcc.gnu.org/PR10877,,bug 10877} for more information.
3793 If you receive Signal 11 errors when building on GNU/Linux, then it is
3794 possible you have a hardware problem.  Further information on this can be
3795 found on @uref{http://www.bitwizard.nl/sig11/,,www.bitwizard.nl}.
3797 @html
3798 <hr />
3799 @end html
3800 @anchor{ix86-x-solaris210}
3801 @heading i?86-*-solaris2.10
3802 Use this for Solaris 10 or later on x86 and x86-64 systems.  Starting
3803 with GCC 4.7, there is also a 64-bit @samp{amd64-*-solaris2.1[0-9]*} or
3804 @samp{x86_64-*-solaris2.1[0-9]*} configuration that corresponds to
3805 @samp{sparcv9-sun-solaris2*}.
3807 It is recommended that you configure GCC to use the GNU assembler.  The
3808 versions included in Solaris 10, from GNU binutils 2.15 (in
3809 @file{/usr/sfw/bin/gas}), and Solaris 11, from GNU binutils 2.19 or
3810 newer (also available as @file{/usr/bin/gas} and
3811 @file{/usr/gnu/bin/as}), work fine.  The current version, from GNU
3812 binutils 2.29, is known to work, but the version from GNU binutils 2.26
3813 must be avoided.  Recent versions of the Solaris assembler in
3814 @file{/usr/ccs/bin/as} work almost as well, though.
3815 @c FIXME: as patch requirements?
3817 For linking, the Solaris linker, is preferred.  If you want to use the GNU
3818 linker instead, note that due to a packaging bug the version in Solaris
3819 10, from GNU binutils 2.15 (in @file{/usr/sfw/bin/gld}), cannot be used,
3820 while the version in Solaris 11, from GNU binutils 2.19 or newer (also
3821 in @file{/usr/gnu/bin/ld} and @file{/usr/bin/gld}), works, as does the
3822 latest version, from GNU binutils 2.29.
3824 To use GNU @command{as}, configure with the options
3825 @option{--with-gnu-as --with-as=@//usr/@/sfw/@/bin/@/gas}.  It may be necessary
3826 to configure with @option{--without-gnu-ld --with-ld=@//usr/@/ccs/@/bin/@/ld} to
3827 guarantee use of Sun @command{ld}.
3828 @c FIXME: why --without-gnu-ld --with-ld?
3830 @html
3831 <hr />
3832 @end html
3833 @anchor{ia64-x-linux}
3834 @heading ia64-*-linux
3835 IA-64 processor (also known as IPF, or Itanium Processor Family)
3836 running GNU/Linux.
3838 If you are using the installed system libunwind library with
3839 @option{--with-system-libunwind}, then you must use libunwind 0.98 or
3840 later.
3842 None of the following versions of GCC has an ABI that is compatible
3843 with any of the other versions in this list, with the exception that
3844 Red Hat 2.96 and Trillian 000171 are compatible with each other:
3845 3.1, 3.0.2, 3.0.1, 3.0, Red Hat 2.96, and Trillian 000717.
3846 This primarily affects C++ programs and programs that create shared libraries.
3847 GCC 3.1 or later is recommended for compiling linux, the kernel.
3848 As of version 3.1 GCC is believed to be fully ABI compliant, and hence no
3849 more major ABI changes are expected.
3851 @html
3852 <hr />
3853 @end html
3854 @anchor{ia64-x-hpux}
3855 @heading ia64-*-hpux*
3856 Building GCC on this target requires the GNU Assembler.  The bundled HP
3857 assembler will not work.  To prevent GCC from using the wrong assembler,
3858 the option @option{--with-gnu-as} may be necessary.
3860 The GCC libunwind library has not been ported to HPUX@.  This means that for
3861 GCC versions 3.2.3 and earlier, @option{--enable-libunwind-exceptions}
3862 is required to build GCC@.  For GCC 3.3 and later, this is the default.
3863 For gcc 3.4.3 and later, @option{--enable-libunwind-exceptions} is
3864 removed and the system libunwind library will always be used.
3866 @html
3867 <hr />
3868 <!-- rs6000-ibm-aix*, powerpc-ibm-aix* -->
3869 @end html
3870 @anchor{x-ibm-aix}
3871 @heading *-ibm-aix*
3872 Support for AIX version 3 and older was discontinued in GCC 3.4.
3873 Support for AIX version 4.2 and older was discontinued in GCC 4.5.
3875 ``out of memory'' bootstrap failures may indicate a problem with
3876 process resource limits (ulimit).  Hard limits are configured in the
3877 @file{/etc/security/limits} system configuration file.
3879 GCC 4.9 and above require a C++ compiler for bootstrap.  IBM VAC++ / xlC
3880 cannot bootstrap GCC.  xlc can bootstrap an older version of GCC and
3881 G++ can bootstrap recent releases of GCC.
3883 GCC can bootstrap with recent versions of IBM XLC, but bootstrapping
3884 with an earlier release of GCC is recommended.  Bootstrapping with XLC
3885 requires a larger data segment, which can be enabled through the
3886 @var{LDR_CNTRL} environment variable, e.g.,
3888 @smallexample
3889 % LDR_CNTRL=MAXDATA=0x50000000
3890 % export LDR_CNTRL
3891 @end smallexample
3893 One can start with a pre-compiled version of GCC to build from
3894 sources.  One may delete GCC's ``fixed'' header files when starting
3895 with a version of GCC built for an earlier release of AIX.
3897 To speed up the configuration phases of bootstrapping and installing GCC,
3898 one may use GNU Bash instead of AIX @command{/bin/sh}, e.g.,
3900 @smallexample
3901 % CONFIG_SHELL=/opt/freeware/bin/bash
3902 % export CONFIG_SHELL
3903 @end smallexample
3905 and then proceed as described in @uref{build.html,,the build
3906 instructions}, where we strongly recommend specifying an absolute path
3907 to invoke @var{srcdir}/configure.
3909 Because GCC on AIX is built as a 32-bit executable by default,
3910 (although it can generate 64-bit programs) the GMP and MPFR libraries
3911 required by gfortran must be 32-bit libraries.  Building GMP and MPFR
3912 as static archive libraries works better than shared libraries.
3914 Errors involving @code{alloca} when building GCC generally are due
3915 to an incorrect definition of @code{CC} in the Makefile or mixing files
3916 compiled with the native C compiler and GCC@.  During the stage1 phase of
3917 the build, the native AIX compiler @strong{must} be invoked as @command{cc}
3918 (not @command{xlc}).  Once @command{configure} has been informed of
3919 @command{xlc}, one needs to use @samp{make distclean} to remove the
3920 configure cache files and ensure that @env{CC} environment variable
3921 does not provide a definition that will confuse @command{configure}.
3922 If this error occurs during stage2 or later, then the problem most likely
3923 is the version of Make (see above).
3925 The native @command{as} and @command{ld} are recommended for
3926 bootstrapping on AIX@.  The GNU Assembler, GNU Linker, and GNU
3927 Binutils version 2.20 is the minimum level that supports bootstrap on
3928 AIX 5@.  The GNU Assembler has not been updated to support AIX 6@ or
3929 AIX 7.  The native AIX tools do interoperate with GCC@.
3931 AIX 7.1 added partial support for DWARF debugging, but full support
3932 requires AIX 7.1 TL03 SP7 that supports additional DWARF sections and
3933 fixes a bug in the assembler.  AIX 7.1 TL03 SP5 distributed a version
3934 of libm.a missing important symbols; a fix for IV77796 will be
3935 included in SP6.
3937 AIX 5.3 TL10, AIX 6.1 TL05 and AIX 7.1 TL00 introduced an AIX
3938 assembler change that sometimes produces corrupt assembly files
3939 causing AIX linker errors.  The bug breaks GCC bootstrap on AIX and
3940 can cause compilation failures with existing GCC installations.  An
3941 AIX iFix for AIX 5.3 is available (APAR IZ98385 for AIX 5.3 TL10, APAR
3942 IZ98477 for AIX 5.3 TL11 and IZ98134 for AIX 5.3 TL12). AIX 5.3 TL11 SP8,
3943 AIX 5.3 TL12 SP5, AIX 6.1 TL04 SP11, AIX 6.1 TL05 SP7, AIX 6.1 TL06 SP6,
3944 AIX 6.1 TL07 and AIX 7.1 TL01 should include the fix.
3946 Building @file{libstdc++.a} requires a fix for an AIX Assembler bug
3947 APAR IY26685 (AIX 4.3) or APAR IY25528 (AIX 5.1).  It also requires a
3948 fix for another AIX Assembler bug and a co-dependent AIX Archiver fix
3949 referenced as APAR IY53606 (AIX 5.2) or as APAR IY54774 (AIX 5.1)
3951 @anchor{TransferAixShobj}
3952 @samp{libstdc++} in GCC 3.4 increments the major version number of the
3953 shared object and GCC installation places the @file{libstdc++.a}
3954 shared library in a common location which will overwrite the and GCC
3955 3.3 version of the shared library.  Applications either need to be
3956 re-linked against the new shared library or the GCC 3.1 and GCC 3.3
3957 versions of the @samp{libstdc++} shared object needs to be available
3958 to the AIX runtime loader.  The GCC 3.1 @samp{libstdc++.so.4}, if
3959 present, and GCC 3.3 @samp{libstdc++.so.5} shared objects can be
3960 installed for runtime dynamic loading using the following steps to set
3961 the @samp{F_LOADONLY} flag in the shared object for @emph{each}
3962 multilib @file{libstdc++.a} installed:
3964 Extract the shared objects from the currently installed
3965 @file{libstdc++.a} archive:
3966 @smallexample
3967 % ar -x libstdc++.a libstdc++.so.4 libstdc++.so.5
3968 @end smallexample
3970 Enable the @samp{F_LOADONLY} flag so that the shared object will be
3971 available for runtime dynamic loading, but not linking:
3972 @smallexample
3973 % strip -e libstdc++.so.4 libstdc++.so.5
3974 @end smallexample
3976 Archive the runtime-only shared object in the GCC 3.4
3977 @file{libstdc++.a} archive:
3978 @smallexample
3979 % ar -q libstdc++.a libstdc++.so.4 libstdc++.so.5
3980 @end smallexample
3982 Eventually, the
3983 @uref{./configure.html#WithAixSoname,,@option{--with-aix-soname=svr4}}
3984 configure option may drop the need for this procedure for libraries that
3985 support it.
3987 Linking executables and shared libraries may produce warnings of
3988 duplicate symbols.  The assembly files generated by GCC for AIX always
3989 have included multiple symbol definitions for certain global variable
3990 and function declarations in the original program.  The warnings should
3991 not prevent the linker from producing a correct library or runnable
3992 executable.
3994 AIX 4.3 utilizes a ``large format'' archive to support both 32-bit and
3995 64-bit object modules.  The routines provided in AIX 4.3.0 and AIX 4.3.1
3996 to parse archive libraries did not handle the new format correctly.
3997 These routines are used by GCC and result in error messages during
3998 linking such as ``not a COFF file''.  The version of the routines shipped
3999 with AIX 4.3.1 should work for a 32-bit environment.  The @option{-g}
4000 option of the archive command may be used to create archives of 32-bit
4001 objects using the original ``small format''.  A correct version of the
4002 routines is shipped with AIX 4.3.2 and above.
4004 Some versions of the AIX binder (linker) can fail with a relocation
4005 overflow severe error when the @option{-bbigtoc} option is used to link
4006 GCC-produced object files into an executable that overflows the TOC@.  A fix
4007 for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND -BBIGTOC) is
4008 available from IBM Customer Support and from its
4009 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
4010 website as PTF U455193.
4012 The AIX 4.3.2.1 linker (bos.rte.bind_cmds Level 4.3.2.1) will dump core
4013 with a segmentation fault when invoked by any version of GCC@.  A fix for
4014 APAR IX87327 is available from IBM Customer Support and from its
4015 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
4016 website as PTF U461879.  This fix is incorporated in AIX 4.3.3 and above.
4018 The initial assembler shipped with AIX 4.3.0 generates incorrect object
4019 files.  A fix for APAR IX74254 (64BIT DISASSEMBLED OUTPUT FROM COMPILER FAILS
4020 TO ASSEMBLE/BIND) is available from IBM Customer Support and from its
4021 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
4022 website as PTF U453956.  This fix is incorporated in AIX 4.3.1 and above.
4024 AIX provides National Language Support (NLS)@.  Compilers and assemblers
4025 use NLS to support locale-specific representations of various data
4026 formats including floating-point numbers (e.g., @samp{.}  vs @samp{,} for
4027 separating decimal fractions).  There have been problems reported where
4028 GCC does not produce the same floating-point formats that the assembler
4029 expects.  If one encounters this problem, set the @env{LANG}
4030 environment variable to @samp{C} or @samp{En_US}.
4032 A default can be specified with the @option{-mcpu=@var{cpu_type}}
4033 switch and using the configure option @option{--with-cpu-@var{cpu_type}}.
4035 @html
4036 <hr />
4037 @end html
4038 @anchor{iq2000-x-elf}
4039 @heading iq2000-*-elf
4040 Vitesse IQ2000 processors.  These are used in embedded
4041 applications.  There are no standard Unix configurations.
4043 @html
4044 <hr />
4045 @end html
4046 @anchor{lm32-x-elf}
4047 @heading lm32-*-elf
4048 Lattice Mico32 processor.
4049 This configuration is intended for embedded systems.
4051 @html
4052 <hr />
4053 @end html
4054 @anchor{lm32-x-uclinux}
4055 @heading lm32-*-uclinux
4056 Lattice Mico32 processor.
4057 This configuration is intended for embedded systems running uClinux.
4059 @html
4060 <hr />
4061 @end html
4062 @anchor{m32c-x-elf}
4063 @heading m32c-*-elf
4064 Renesas M32C processor.
4065 This configuration is intended for embedded systems.
4067 @html
4068 <hr />
4069 @end html
4070 @anchor{m32r-x-elf}
4071 @heading m32r-*-elf
4072 Renesas M32R processor.
4073 This configuration is intended for embedded systems.
4075 @html
4076 <hr />
4077 @end html
4078 @anchor{m68k-x-x}
4079 @heading m68k-*-*
4080 By default,
4081 @samp{m68k-*-elf*}, @samp{m68k-*-rtems},  @samp{m68k-*-uclinux} and
4082 @samp{m68k-*-linux}
4083 build libraries for both M680x0 and ColdFire processors.  If you only
4084 need the M680x0 libraries, you can omit the ColdFire ones by passing
4085 @option{--with-arch=m68k} to @command{configure}.  Alternatively, you
4086 can omit the M680x0 libraries by passing @option{--with-arch=cf} to
4087 @command{configure}.  These targets default to 5206 or 5475 code as
4088 appropriate for the target system when
4089 configured with @option{--with-arch=cf} and 68020 code otherwise.
4091 The @samp{m68k-*-netbsd} and
4092 @samp{m68k-*-openbsd} targets also support the @option{--with-arch}
4093 option.  They will generate ColdFire CFV4e code when configured with
4094 @option{--with-arch=cf} and 68020 code otherwise.
4096 You can override the default processors listed above by configuring
4097 with @option{--with-cpu=@var{target}}.  This @var{target} can either
4098 be a @option{-mcpu} argument or one of the following values:
4099 @samp{m68000}, @samp{m68010}, @samp{m68020}, @samp{m68030},
4100 @samp{m68040}, @samp{m68060}, @samp{m68020-40} and @samp{m68020-60}.
4102 GCC requires at least binutils version 2.17 on these targets.
4104 @html
4105 <hr />
4106 @end html
4107 @anchor{m68k-x-uclinux}
4108 @heading m68k-*-uclinux
4109 GCC 4.3 changed the uClinux configuration so that it uses the
4110 @samp{m68k-linux-gnu} ABI rather than the @samp{m68k-elf} ABI.
4111 It also added improved support for C++ and flat shared libraries,
4112 both of which were ABI changes.
4114 @html
4115 <hr />
4116 @end html
4117 @anchor{microblaze-x-elf}
4118 @heading microblaze-*-elf
4119 Xilinx MicroBlaze processor.
4120 This configuration is intended for embedded systems.
4122 @html
4123 <hr />
4124 @end html
4125 @anchor{mips-x-x}
4126 @heading mips-*-*
4127 If on a MIPS system you get an error message saying ``does not have gp
4128 sections for all it's [sic] sectons [sic]'', don't worry about it.  This
4129 happens whenever you use GAS with the MIPS linker, but there is not
4130 really anything wrong, and it is okay to use the output file.  You can
4131 stop such warnings by installing the GNU linker.
4133 It would be nice to extend GAS to produce the gp tables, but they are
4134 optional, and there should not be a warning about their absence.
4136 The libstdc++ atomic locking routines for MIPS targets requires MIPS II
4137 and later.  A patch went in just after the GCC 3.3 release to
4138 make @samp{mips*-*-*} use the generic implementation instead.  You can also
4139 configure for @samp{mipsel-elf} as a workaround.  The
4140 @samp{mips*-*-linux*} target continues to use the MIPS II routines.  More
4141 work on this is expected in future releases.
4143 @c If you make --with-llsc the default for another target, please also
4144 @c update the description of the --with-llsc option.
4146 The built-in @code{__sync_*} functions are available on MIPS II and
4147 later systems and others that support the @samp{ll}, @samp{sc} and
4148 @samp{sync} instructions.  This can be overridden by passing
4149 @option{--with-llsc} or @option{--without-llsc} when configuring GCC.
4150 Since the Linux kernel emulates these instructions if they are
4151 missing, the default for @samp{mips*-*-linux*} targets is
4152 @option{--with-llsc}.  The @option{--with-llsc} and
4153 @option{--without-llsc} configure options may be overridden at compile
4154 time by passing the @option{-mllsc} or @option{-mno-llsc} options to
4155 the compiler.
4157 MIPS systems check for division by zero (unless
4158 @option{-mno-check-zero-division} is passed to the compiler) by
4159 generating either a conditional trap or a break instruction.  Using
4160 trap results in smaller code, but is only supported on MIPS II and
4161 later.  Also, some versions of the Linux kernel have a bug that
4162 prevents trap from generating the proper signal (@code{SIGFPE}).  To enable
4163 the use of break, use the @option{--with-divide=breaks}
4164 @command{configure} option when configuring GCC@.  The default is to
4165 use traps on systems that support them.
4167 @html
4168 <hr />
4169 @end html
4170 @anchor{moxie-x-elf}
4171 @heading moxie-*-elf
4172 The moxie processor.
4174 @html
4175 <hr />
4176 @end html
4177 @anchor{msp430-x-elf}
4178 @heading msp430-*-elf
4179 TI MSP430 processor.
4180 This configuration is intended for embedded systems.
4182 @html
4183 <hr />
4184 @end html
4185 @anchor{nds32le-x-elf}
4186 @heading nds32le-*-elf
4187 Andes NDS32 target in little endian mode.
4189 @html
4190 <hr />
4191 @end html
4192 @anchor{nds32be-x-elf}
4193 @heading nds32be-*-elf
4194 Andes NDS32 target in big endian mode.
4196 @html
4197 <hr />
4198 @end html
4199 @anchor{nvptx-x-none}
4200 @heading nvptx-*-none
4201 Nvidia PTX target.
4203 Instead of GNU binutils, you will need to install
4204 @uref{https://github.com/MentorEmbedded/nvptx-tools/,,nvptx-tools}.
4205 Tell GCC where to find it:
4206 @option{--with-build-time-tools=[install-nvptx-tools]/nvptx-none/bin}.
4208 A nvptx port of newlib is available at
4209 @uref{https://github.com/MentorEmbedded/nvptx-newlib/,,nvptx-newlib}.
4210 It can be automatically built together with GCC@.  For this, add a
4211 symbolic link to nvptx-newlib's @file{newlib} directory to the
4212 directory containing the GCC sources.
4214 Use the @option{--disable-sjlj-exceptions} and
4215 @option{--enable-newlib-io-long-long} options when configuring.
4217 @html
4218 <hr />
4219 @end html
4220 @anchor{powerpc-x-x}
4221 @heading powerpc-*-*
4222 You can specify a default version for the @option{-mcpu=@var{cpu_type}}
4223 switch by using the configure option @option{--with-cpu-@var{cpu_type}}.
4225 You will need GNU binutils 2.15 or newer.
4227 @html
4228 <hr />
4229 @end html
4230 @anchor{powerpc-x-darwin}
4231 @heading powerpc-*-darwin*
4232 PowerPC running Darwin (Mac OS X kernel).
4234 Pre-installed versions of Mac OS X may not include any developer tools,
4235 meaning that you will not be able to build GCC from source.  Tool
4236 binaries are available at
4237 @uref{https://opensource.apple.com}.
4239 This version of GCC requires at least cctools-590.36.  The
4240 cctools-590.36 package referenced from
4241 @uref{http://gcc.gnu.org/ml/gcc/2006-03/msg00507.html} will not work
4242 on systems older than 10.3.9 (aka darwin7.9.0).
4244 @html
4245 <hr />
4246 @end html
4247 @anchor{powerpc-x-elf}
4248 @heading powerpc-*-elf
4249 PowerPC system in big endian mode, running System V.4.
4251 @html
4252 <hr />
4253 @end html
4254 @anchor{powerpc-x-linux-gnu}
4255 @heading powerpc*-*-linux-gnu*
4256 PowerPC system in big endian mode running Linux.
4258 @html
4259 <hr />
4260 @end html
4261 @anchor{powerpc-x-netbsd}
4262 @heading powerpc-*-netbsd*
4263 PowerPC system in big endian mode running NetBSD@.
4265 @html
4266 <hr />
4267 @end html
4268 @anchor{powerpc-x-eabisim}
4269 @heading powerpc-*-eabisim
4270 Embedded PowerPC system in big endian mode for use in running under the
4271 PSIM simulator.
4273 @html
4274 <hr />
4275 @end html
4276 @anchor{powerpc-x-eabi}
4277 @heading powerpc-*-eabi
4278 Embedded PowerPC system in big endian mode.
4280 @html
4281 <hr />
4282 @end html
4283 @anchor{powerpcle-x-elf}
4284 @heading powerpcle-*-elf
4285 PowerPC system in little endian mode, running System V.4.
4287 @html
4288 <hr />
4289 @end html
4290 @anchor{powerpcle-x-eabisim}
4291 @heading powerpcle-*-eabisim
4292 Embedded PowerPC system in little endian mode for use in running under
4293 the PSIM simulator.
4295 @html
4296 <hr />
4297 @end html
4298 @anchor{powerpcle-x-eabi}
4299 @heading powerpcle-*-eabi
4300 Embedded PowerPC system in little endian mode.
4302 @html
4303 <hr />
4304 @end html
4305 @anchor{rl78-x-elf}
4306 @heading rl78-*-elf
4307 The Renesas RL78 processor.
4308 This configuration is intended for embedded systems.
4310 @html
4311 <hr />
4312 @end html
4313 @anchor{riscv32-x-elf}
4314 @heading riscv32-*-elf
4315 The RISC-V RV32 instruction set.
4316 This configuration is intended for embedded systems.
4317 This (and all other RISC-V) targets are supported upstream as of the
4318 binutils 2.28 release.
4320 @html
4321 <hr />
4322 @end html
4323 @anchor{riscv32-x-linux}
4324 @heading riscv32-*-linux
4325 The RISC-V RV32 instruction set running GNU/Linux.
4326 This (and all other RISC-V) targets are supported upstream as of the
4327 binutils 2.28 release.
4329 @html
4330 <hr />
4331 @end html
4332 @anchor{riscv64-x-elf}
4333 @heading riscv64-*-elf
4334 The RISC-V RV64 instruction set.
4335 This configuration is intended for embedded systems.
4336 This (and all other RISC-V) targets are supported upstream as of the
4337 binutils 2.28 release.
4339 @html
4340 <hr />
4341 @end html
4342 @anchor{riscv64-x-linux}
4343 @heading riscv64-*-linux
4344 The RISC-V RV64 instruction set running GNU/Linux.
4345 This (and all other RISC-V) targets are supported upstream as of the
4346 binutils 2.28 release.
4348 @html
4349 <hr />
4350 @end html
4351 @anchor{rx-x-elf}
4352 @heading rx-*-elf
4353 The Renesas RX processor.
4355 @html
4356 <hr />
4357 @end html
4358 @anchor{s390-x-linux}
4359 @heading s390-*-linux*
4360 S/390 system running GNU/Linux for S/390@.
4362 @html
4363 <hr />
4364 @end html
4365 @anchor{s390x-x-linux}
4366 @heading s390x-*-linux*
4367 zSeries system (64-bit) running GNU/Linux for zSeries@.
4369 @html
4370 <hr />
4371 @end html
4372 @anchor{s390x-ibm-tpf}
4373 @heading s390x-ibm-tpf*
4374 zSeries system (64-bit) running TPF@.  This platform is
4375 supported as cross-compilation target only.
4377 @html
4378 <hr />
4379 @end html
4380 @c Please use Solaris 2 to refer to all release of Solaris, starting
4381 @c with 2.0 until 2.6, 7, 8, etc.  Solaris 1 was a marketing name for
4382 @c SunOS 4 releases which we don't use to avoid confusion.  Solaris
4383 @c alone is too unspecific and must be avoided.
4384 @anchor{x-x-solaris2}
4385 @heading *-*-solaris2*
4386 Support for Solaris 9 has been removed in GCC 5.  Support for Solaris
4387 8 has been removed in GCC 4.8.  Support for Solaris 7 has been removed
4388 in GCC 4.6.
4390 Sun does not ship a C compiler with Solaris 2 before Solaris 10, though
4391 you can download the Sun Studio compilers for free.  In Solaris 10 and
4392 11, GCC 3.4.3 is available as @command{/usr/sfw/bin/gcc}.  Solaris 11
4393 also provides GCC 4.5.2, 4.7.3, and 4.8.2 as
4394 @command{/usr/gcc/4.5/bin/gcc} or similar.  Alternatively,
4395 you can install a pre-built GCC to bootstrap and install GCC.  See the
4396 @uref{binaries.html,,binaries page} for details.
4398 The Solaris 2 @command{/bin/sh} will often fail to configure
4399 @samp{libstdc++-v3}or @samp{boehm-gc}.  We therefore recommend using the
4400 following initial sequence of commands
4402 @smallexample
4403 % CONFIG_SHELL=/bin/ksh
4404 % export CONFIG_SHELL
4405 @end smallexample
4407 @noindent
4408 and proceed as described in @uref{configure.html,,the configure instructions}.
4409 In addition we strongly recommend specifying an absolute path to invoke
4410 @command{@var{srcdir}/configure}.
4412 Solaris 10 comes with a number of optional OS packages.  Some of these
4413 are needed to use GCC fully, namely @code{SUNWarc},
4414 @code{SUNWbtool}, @code{SUNWesu}, @code{SUNWhea}, @code{SUNWlibm},
4415 @code{SUNWsprot}, and @code{SUNWtoo}.  If you did not install all
4416 optional packages when installing Solaris 10, you will need to verify that
4417 the packages that GCC needs are installed.
4418 To check whether an optional package is installed, use
4419 the @command{pkginfo} command.  To add an optional package, use the
4420 @command{pkgadd} command.  For further details, see the Solaris 10
4421 documentation.
4423 Starting with Solaris 11, the package management has changed, so you
4424 need to check for @code{system/header}, @code{system/linker}, and
4425 @code{developer/assembler} packages.  Checking for and installing
4426 packages is done with the @command{pkg} command now.
4428 Trying to use the linker and other tools in
4429 @file{/usr/ucb} to install GCC has been observed to cause trouble.
4430 For example, the linker may hang indefinitely.  The fix is to remove
4431 @file{/usr/ucb} from your @env{PATH}.
4433 The build process works more smoothly with the legacy Sun tools so, if you
4434 have @file{/usr/xpg4/bin} in your @env{PATH}, we recommend that you place
4435 @file{/usr/bin} before @file{/usr/xpg4/bin} for the duration of the build.
4437 We recommend the use of the Solaris assembler or the GNU assembler, in
4438 conjunction with the Solaris linker.  The GNU @command{as}
4439 versions included in Solaris 10, from GNU binutils 2.15 (in
4440 @file{/usr/sfw/bin/gas}), and Solaris 11,
4441 from GNU binutils 2.19 or newer (also in @file{/usr/bin/gas} and
4442 @file{/usr/gnu/bin/as}), are known to work.
4443 The current version, from GNU binutils 2.29,
4444 is known to work as well.  Note that your mileage may vary
4445 if you use a combination of the GNU tools and the Solaris tools: while the
4446 combination GNU @command{as} + Sun @command{ld} should reasonably work,
4447 the reverse combination Sun @command{as} + GNU @command{ld} may fail to
4448 build or cause memory corruption at runtime in some cases for C++ programs.
4449 @c FIXME: still?
4450 GNU @command{ld} usually works as well, although the version included in
4451 Solaris 10 cannot be used due to several bugs.  Again, the current
4452 version (2.29) is known to work, but generally lacks platform specific
4453 features, so better stay with Solaris @command{ld}.  To use the LTO linker
4454 plugin (@option{-fuse-linker-plugin}) with GNU @command{ld}, GNU
4455 binutils @emph{must} be configured with @option{--enable-largefile}.
4457 To enable symbol versioning in @samp{libstdc++} with the Solaris linker,
4458 you need to have any version of GNU @command{c++filt}, which is part of
4459 GNU binutils.  @samp{libstdc++} symbol versioning will be disabled if no
4460 appropriate version is found.  Solaris @command{c++filt} from the Solaris
4461 Studio compilers does @emph{not} work.
4463 Sun bug 4927647 sometimes causes random spurious testsuite failures
4464 related to missing diagnostic output.  This bug doesn't affect GCC
4465 itself, rather it is a kernel bug triggered by the @command{expect}
4466 program which is used only by the GCC testsuite driver.  When the bug
4467 causes the @command{expect} program to miss anticipated output, extra
4468 testsuite failures appear.
4470 @html
4471 <hr />
4472 @end html
4473 @anchor{sparc-x-x}
4474 @heading sparc*-*-*
4475 This section contains general configuration information for all
4476 SPARC-based platforms.  In addition to reading this section, please
4477 read all other sections that match your target.
4479 Newer versions of the GNU Multiple Precision Library (GMP), the MPFR
4480 library and the MPC library are known to be miscompiled by earlier
4481 versions of GCC on these platforms.  We therefore recommend the use
4482 of the exact versions of these libraries listed as minimal versions
4483 in @uref{prerequisites.html,,the prerequisites}.
4485 @html
4486 <hr />
4487 @end html
4488 @anchor{sparc-sun-solaris2}
4489 @heading sparc-sun-solaris2*
4490 When GCC is configured to use GNU binutils 2.14 or later, the binaries
4491 produced are smaller than the ones produced using Sun's native tools;
4492 this difference is quite significant for binaries containing debugging
4493 information.
4495 Starting with Solaris 7, the operating system is capable of executing
4496 64-bit SPARC V9 binaries.  GCC 3.1 and later properly supports
4497 this; the @option{-m64} option enables 64-bit code generation.
4498 However, if all you want is code tuned for the UltraSPARC CPU, you
4499 should try the @option{-mtune=ultrasparc} option instead, which produces
4500 code that, unlike full 64-bit code, can still run on non-UltraSPARC
4501 machines.
4503 When configuring the GNU Multiple Precision Library (GMP), the MPFR
4504 library or the MPC library on a Solaris 7 or later system, the canonical
4505 target triplet must be specified as the @command{build} parameter on the
4506 configure line.  This target triplet can be obtained by invoking @command{./config.guess} in the toplevel source directory of GCC (and
4507 not that of GMP or MPFR or MPC).  For example on a Solaris 9 system:
4509 @smallexample
4510 % ./configure --build=sparc-sun-solaris2.9 --prefix=xxx
4511 @end smallexample
4513 @html
4514 <hr />
4515 @end html
4516 @anchor{sparc-sun-solaris210}
4517 @heading sparc-sun-solaris2.10
4518 There is a bug in older versions of the Sun assembler which breaks
4519 thread-local storage (TLS).  A typical error message is
4521 @smallexample
4522 ld: fatal: relocation error: R_SPARC_TLS_LE_HIX22: file /var/tmp//ccamPA1v.o:
4523   symbol <unknown>: bad symbol type SECT: symbol type must be TLS
4524 @end smallexample
4526 @noindent
4527 This bug is fixed in Sun patch 118683-03 or later.
4529 @html
4530 <hr />
4531 @end html
4532 @anchor{sparc-x-linux}
4533 @heading sparc-*-linux*
4535 @html
4536 <hr />
4537 @end html
4538 @anchor{sparc64-x-solaris2}
4539 @heading sparc64-*-solaris2*
4540 When configuring the GNU Multiple Precision Library (GMP), the MPFR
4541 library or the MPC library, the canonical target triplet must be specified
4542 as the @command{build} parameter on the configure line.  For example
4543 on a Solaris 9 system:
4545 @smallexample
4546 % ./configure --build=sparc64-sun-solaris2.9 --prefix=xxx
4547 @end smallexample
4549 @html
4550 <hr />
4551 @end html
4552 @anchor{sparcv9-x-solaris2}
4553 @heading sparcv9-*-solaris2*
4554 This is a synonym for @samp{sparc64-*-solaris2*}.
4556 @html
4557 <hr />
4558 @end html
4559 @anchor{c6x-x-x}
4560 @heading c6x-*-*
4561 The C6X family of processors. This port requires binutils-2.22 or newer.
4563 @html
4564 <hr />
4565 @end html
4566 @anchor{tilegx-*-linux}
4567 @heading tilegx-*-linux*
4568 The TILE-Gx processor in little endian mode, running GNU/Linux.  This
4569 port requires binutils-2.22 or newer.
4571 @html
4572 <hr />
4573 @end html
4574 @anchor{tilegxbe-*-linux}
4575 @heading tilegxbe-*-linux*
4576 The TILE-Gx processor in big endian mode, running GNU/Linux.  This
4577 port requires binutils-2.23 or newer.
4579 @html
4580 <hr />
4581 @end html
4582 @anchor{tilepro-*-linux}
4583 @heading tilepro-*-linux*
4584 The TILEPro processor running GNU/Linux.  This port requires
4585 binutils-2.22 or newer.
4587 @html
4588 <hr />
4589 @end html
4590 @anchor{visium-x-elf}
4591 @heading visium-*-elf
4592 CDS VISIUMcore processor.
4593 This configuration is intended for embedded systems.
4595 @html
4596 <hr />
4597 @end html
4598 @anchor{x-x-vxworks}
4599 @heading *-*-vxworks*
4600 Support for VxWorks is in flux.  At present GCC supports @emph{only} the
4601 very recent VxWorks 5.5 (aka Tornado 2.2) release, and only on PowerPC@.
4602 We welcome patches for other architectures supported by VxWorks 5.5.
4603 Support for VxWorks AE would also be welcome; we believe this is merely
4604 a matter of writing an appropriate ``configlette'' (see below).  We are
4605 not interested in supporting older, a.out or COFF-based, versions of
4606 VxWorks in GCC 3.
4608 VxWorks comes with an older version of GCC installed in
4609 @file{@var{$WIND_BASE}/host}; we recommend you do not overwrite it.
4610 Choose an installation @var{prefix} entirely outside @var{$WIND_BASE}.
4611 Before running @command{configure}, create the directories @file{@var{prefix}}
4612 and @file{@var{prefix}/bin}.  Link or copy the appropriate assembler,
4613 linker, etc.@: into @file{@var{prefix}/bin}, and set your @var{PATH} to
4614 include that directory while running both @command{configure} and
4615 @command{make}.
4617 You must give @command{configure} the
4618 @option{--with-headers=@var{$WIND_BASE}/target/h} switch so that it can
4619 find the VxWorks system headers.  Since VxWorks is a cross compilation
4620 target only, you must also specify @option{--target=@var{target}}.
4621 @command{configure} will attempt to create the directory
4622 @file{@var{prefix}/@var{target}/sys-include} and copy files into it;
4623 make sure the user running @command{configure} has sufficient privilege
4624 to do so.
4626 GCC's exception handling runtime requires a special ``configlette''
4627 module, @file{contrib/gthr_supp_vxw_5x.c}.  Follow the instructions in
4628 that file to add the module to your kernel build.  (Future versions of
4629 VxWorks will incorporate this module.)
4631 @html
4632 <hr />
4633 @end html
4634 @anchor{x86-64-x-x}
4635 @heading x86_64-*-*, amd64-*-*
4636 GCC supports the x86-64 architecture implemented by the AMD64 processor
4637 (amd64-*-* is an alias for x86_64-*-*) on GNU/Linux, FreeBSD and NetBSD@.
4638 On GNU/Linux the default is a bi-arch compiler which is able to generate
4639 both 64-bit x86-64 and 32-bit x86 code (via the @option{-m32} switch).
4641 @html
4642 <hr />
4643 @end html
4644 @anchor{x86-64-x-solaris210}
4645 @heading x86_64-*-solaris2.1[0-9]*
4646 GCC also supports the x86-64 architecture implemented by the AMD64
4647 processor (@samp{amd64-*-*} is an alias for @samp{x86_64-*-*}) on
4648 Solaris 10 or later.  Unlike other systems, without special options a
4649 bi-arch compiler is built which generates 32-bit code by default, but
4650 can generate 64-bit x86-64 code with the @option{-m64} switch.  Since
4651 GCC 4.7, there is also a configuration that defaults to 64-bit code, but
4652 can generate 32-bit code with @option{-m32}.  To configure and build
4653 this way, you have to provide all support libraries like @file{libgmp}
4654 as 64-bit code, configure with @option{--target=x86_64-pc-solaris2.1x}
4655 and @samp{CC=gcc -m64}.
4657 @html
4658 <hr />
4659 @end html
4660 @anchor{xtensa-x-elf}
4661 @heading xtensa*-*-elf
4662 This target is intended for embedded Xtensa systems using the
4663 @samp{newlib} C library.  It uses ELF but does not support shared
4664 objects.  Designed-defined instructions specified via the
4665 Tensilica Instruction Extension (TIE) language are only supported
4666 through inline assembly.
4668 The Xtensa configuration information must be specified prior to
4669 building GCC@.  The @file{include/xtensa-config.h} header
4670 file contains the configuration information.  If you created your
4671 own Xtensa configuration with the Xtensa Processor Generator, the
4672 downloaded files include a customized copy of this header file,
4673 which you can use to replace the default header file.
4675 @html
4676 <hr />
4677 @end html
4678 @anchor{xtensa-x-linux}
4679 @heading xtensa*-*-linux*
4680 This target is for Xtensa systems running GNU/Linux.  It supports ELF
4681 shared objects and the GNU C library (glibc).  It also generates
4682 position-independent code (PIC) regardless of whether the
4683 @option{-fpic} or @option{-fPIC} options are used.  In other
4684 respects, this target is the same as the
4685 @uref{#xtensa*-*-elf,,@samp{xtensa*-*-elf}} target.
4687 @html
4688 <hr />
4689 @end html
4690 @anchor{windows}
4691 @heading Microsoft Windows
4693 @subheading Intel 16-bit versions
4694 The 16-bit versions of Microsoft Windows, such as Windows 3.1, are not
4695 supported.
4697 However, the 32-bit port has limited support for Microsoft
4698 Windows 3.11 in the Win32s environment, as a target only.  See below.
4700 @subheading Intel 32-bit versions
4701 The 32-bit versions of Windows, including Windows 95, Windows NT, Windows
4702 XP, and Windows Vista, are supported by several different target
4703 platforms.  These targets differ in which Windows subsystem they target
4704 and which C libraries are used.
4706 @itemize
4707 @item Cygwin @uref{#x-x-cygwin,,*-*-cygwin}: Cygwin provides a user-space
4708 Linux API emulation layer in the Win32 subsystem.
4709 @item MinGW @uref{#x-x-mingw32,,*-*-mingw32}: MinGW is a native GCC port for
4710 the Win32 subsystem that provides a subset of POSIX.
4711 @item MKS i386-pc-mks: NuTCracker from MKS.  See
4712 @uref{https://www.mkssoftware.com} for more information.
4713 @end itemize
4715 @subheading Intel 64-bit versions
4716 GCC contains support for x86-64 using the mingw-w64
4717 runtime library, available from @uref{http://mingw-w64.org/doku.php}.
4718 This library should be used with the target triple x86_64-pc-mingw32.
4720 Presently Windows for Itanium is not supported.
4722 @subheading Windows CE
4723 Windows CE is supported as a target only on Hitachi
4724 SuperH (sh-wince-pe), and MIPS (mips-wince-pe).
4726 @subheading Other Windows Platforms
4727 GCC no longer supports Windows NT on the Alpha or PowerPC.
4729 GCC no longer supports the Windows POSIX subsystem.  However, it does
4730 support the Interix subsystem.  See above.
4732 Old target names including *-*-winnt and *-*-windowsnt are no longer used.
4734 PW32 (i386-pc-pw32) support was never completed, and the project seems to
4735 be inactive.  See @uref{http://pw32.sourceforge.net/} for more information.
4737 UWIN support has been removed due to a lack of maintenance.
4739 @html
4740 <hr />
4741 @end html
4742 @anchor{x-x-cygwin}
4743 @heading *-*-cygwin
4744 Ports of GCC are included with the
4745 @uref{http://www.cygwin.com/,,Cygwin environment}.
4747 GCC will build under Cygwin without modification; it does not build
4748 with Microsoft's C++ compiler and there are no plans to make it do so.
4750 The Cygwin native compiler can be configured to target any 32-bit x86
4751 cpu architecture desired; the default is i686-pc-cygwin.  It should be
4752 used with as up-to-date a version of binutils as possible; use either
4753 the latest official GNU binutils release in the Cygwin distribution,
4754 or version 2.20 or above if building your own.
4756 @html
4757 <hr />
4758 @end html
4759 @anchor{x-x-mingw32}
4760 @heading *-*-mingw32
4761 GCC will build with and support only MinGW runtime 3.12 and later.
4762 Earlier versions of headers are incompatible with the new default semantics
4763 of @code{extern inline} in @code{-std=c99} and @code{-std=gnu99} modes.
4765 @html
4766 <hr />
4767 @end html
4768 @anchor{older}
4769 @heading Older systems
4770 GCC contains support files for many older (1980s and early
4771 1990s) Unix variants.  For the most part, support for these systems
4772 has not been deliberately removed, but it has not been maintained for
4773 several years and may suffer from bitrot.
4775 Starting with GCC 3.1, each release has a list of ``obsoleted'' systems.
4776 Support for these systems is still present in that release, but
4777 @command{configure} will fail unless the @option{--enable-obsolete}
4778 option is given.  Unless a maintainer steps forward, support for these
4779 systems will be removed from the next release of GCC@.
4781 Support for old systems as hosts for GCC can cause problems if the
4782 workarounds for compiler, library and operating system bugs affect the
4783 cleanliness or maintainability of the rest of GCC@.  In some cases, to
4784 bring GCC up on such a system, if still possible with current GCC, may
4785 require first installing an old version of GCC which did work on that
4786 system, and using it to compile a more recent GCC, to avoid bugs in the
4787 vendor compiler.  Old releases of GCC 1 and GCC 2 are available in the
4788 @file{old-releases} directory on the @uref{../mirrors.html,,GCC mirror
4789 sites}.  Header bugs may generally be avoided using
4790 @command{fixincludes}, but bugs or deficiencies in libraries and the
4791 operating system may still cause problems.
4793 Support for older systems as targets for cross-compilation is less
4794 problematic than support for them as hosts for GCC; if an enthusiast
4795 wishes to make such a target work again (including resurrecting any of
4796 the targets that never worked with GCC 2, starting from the last
4797 version before they were removed), patches
4798 @uref{../contribute.html,,following the usual requirements} would be
4799 likely to be accepted, since they should not affect the support for more
4800 modern targets.
4802 For some systems, old versions of GNU binutils may also be useful,
4803 and are available from @file{pub/binutils/old-releases} on
4804 @uref{https://sourceware.org/mirrors.html,,sourceware.org mirror sites}.
4806 Some of the information on specific systems above relates to
4807 such older systems, but much of the information
4808 about GCC on such systems (which may no longer be applicable to
4809 current GCC) is to be found in the GCC texinfo manual.
4811 @html
4812 <hr />
4813 @end html
4814 @anchor{elf}
4815 @heading all ELF targets (SVR4, Solaris 2, etc.)
4816 C++ support is significantly better on ELF targets if you use the
4817 @uref{./configure.html#with-gnu-ld,,GNU linker}; duplicate copies of
4818 inlines, vtables and template instantiations will be discarded
4819 automatically.
4822 @html
4823 <hr />
4825 @end html
4826 @ifhtml
4827 @uref{./index.html,,Return to the GCC Installation page}
4828 @end ifhtml
4829 @end ifset
4831 @c ***Old documentation******************************************************
4832 @ifset oldhtml
4833 @include install-old.texi
4834 @html
4835 <hr />
4837 @end html
4838 @ifhtml
4839 @uref{./index.html,,Return to the GCC Installation page}
4840 @end ifhtml
4841 @end ifset
4843 @c ***GFDL********************************************************************
4844 @ifset gfdlhtml
4845 @include fdl.texi
4846 @html
4847 <hr />
4849 @end html
4850 @ifhtml
4851 @uref{./index.html,,Return to the GCC Installation page}
4852 @end ifhtml
4853 @end ifset
4855 @c ***************************************************************************
4856 @c Part 6 The End of the Document
4857 @ifinfo
4858 @comment node-name,     next,          previous, up
4859 @node    Concept Index, , GNU Free Documentation License, Top
4860 @end ifinfo
4862 @ifinfo
4863 @unnumbered Concept Index
4865 @printindex cp
4867 @contents
4868 @end ifinfo
4869 @bye