PR target/82524
[official-gcc.git] / gcc / doc / install.texi
blobda360da1c5053316887eefd280f3a7f7d4cf4535
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-2017 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-2017 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 5.6.1 (or later)
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 @end table
343 Several support libraries are necessary to build GCC, some are required,
344 others optional.  While any sufficiently new version of required tools
345 usually work, library requirements are generally stricter.  Newer
346 versions may work in some cases, but it's safer to use the exact
347 versions documented.  We appreciate bug reports about problems with
348 newer versions, though.  If your OS vendor provides packages for the
349 support libraries then using those packages may be the simplest way to
350 install the libraries.
352 @table @asis
353 @item GNU Multiple Precision Library (GMP) version 4.3.2 (or later)
355 Necessary to build GCC@.  If a GMP source distribution is found in a
356 subdirectory of your GCC sources named @file{gmp}, it will be built
357 together with GCC.  Alternatively, if GMP is already installed but it
358 is not in your library search path, you will have to configure with the
359 @option{--with-gmp} configure option.  See also @option{--with-gmp-lib}
360 and @option{--with-gmp-include}.
361 The in-tree build is only supported with the GMP version that
362 download_prerequisites installs.
364 @item MPFR Library version 2.4.2 (or later)
366 Necessary to build GCC@.  It can be downloaded from
367 @uref{http://www.mpfr.org/}.  If an MPFR source distribution is found
368 in a subdirectory of your GCC sources named @file{mpfr}, it will be
369 built together with GCC.  Alternatively, if MPFR is already installed
370 but it is not in your default library search path, the
371 @option{--with-mpfr} configure option should be used.  See also
372 @option{--with-mpfr-lib} and @option{--with-mpfr-include}.
373 The in-tree build is only supported with the MPFR version that
374 download_prerequisites installs.
376 @item MPC Library version 0.8.1 (or later)
378 Necessary to build GCC@.  It can be downloaded from
379 @uref{http://www.multiprecision.org/}.  If an MPC source distribution
380 is found in a subdirectory of your GCC sources named @file{mpc}, it
381 will be built together with GCC.  Alternatively, if MPC is already
382 installed but it is not in your default library search path, the
383 @option{--with-mpc} configure option should be used.  See also
384 @option{--with-mpc-lib} and @option{--with-mpc-include}.
385 The in-tree build is only supported with the MPC version that
386 download_prerequisites installs.
388 @item isl Library version 0.15 or later.
390 Necessary to build GCC with the Graphite loop optimizations.
391 It can be downloaded from @uref{ftp://gcc.gnu.org/pub/gcc/infrastructure/}.
392 If an isl source distribution is found
393 in a subdirectory of your GCC sources named @file{isl}, it will be
394 built together with GCC.  Alternatively, the @option{--with-isl} configure
395 option should be used if isl is not installed in your default library
396 search path.
398 @end table
400 @heading Tools/packages necessary for modifying GCC
401 @table @asis
402 @item autoconf version 2.64
403 @itemx GNU m4 version 1.4.6 (or later)
405 Necessary when modifying @file{configure.ac}, @file{aclocal.m4}, etc.@:
406 to regenerate @file{configure} and @file{config.in} files.
408 @item automake version 1.11.6
410 Necessary when modifying a @file{Makefile.am} file to regenerate its
411 associated @file{Makefile.in}.
413 Much of GCC does not use automake, so directly edit the @file{Makefile.in}
414 file.  Specifically this applies to the @file{gcc}, @file{intl},
415 @file{libcpp}, @file{libiberty}, @file{libobjc} directories as well
416 as any of their subdirectories.
418 For directories that use automake, GCC requires the latest release in
419 the 1.11 series, which is currently 1.11.6.  When regenerating a directory
420 to a newer version, please update all the directories using an older 1.11
421 to the latest released version.
423 @item gettext version 0.14.5 (or later)
425 Needed to regenerate @file{gcc.pot}.
427 @item gperf version 2.7.2 (or later)
429 Necessary when modifying @command{gperf} input files, e.g.@:
430 @file{gcc/cp/cfns.gperf} to regenerate its associated header file, e.g.@:
431 @file{gcc/cp/cfns.h}.
433 @item DejaGnu 1.4.4
434 @itemx Expect
435 @itemx Tcl
437 Necessary to run the GCC testsuite; see the section on testing for
438 details.  Tcl 8.6 has a known regression in RE pattern handling that
439 make parts of the testsuite fail.  See
440 @uref{http://core.tcl.tk/tcl/tktview/267b7e2334ee2e9de34c4b00d6e72e2f1997085f}
441 for more information.  This bug has been fixed in 8.6.1.
443 @item autogen version 5.5.4 (or later) and
444 @itemx guile version 1.4.1 (or later)
446 Necessary to regenerate @file{fixinc/fixincl.x} from
447 @file{fixinc/inclhack.def} and @file{fixinc/*.tpl}.
449 Necessary to run @samp{make check} for @file{fixinc}.
451 Necessary to regenerate the top level @file{Makefile.in} file from
452 @file{Makefile.tpl} and @file{Makefile.def}.
454 @item Flex version 2.5.4 (or later)
456 Necessary when modifying @file{*.l} files.
458 Necessary to build GCC during development because the generated output
459 files are not included in the SVN repository.  They are included in
460 releases.
462 @item Texinfo version 4.7 (or later)
464 Necessary for running @command{makeinfo} when modifying @file{*.texi}
465 files to test your changes.
467 Necessary for running @command{make dvi} or @command{make pdf} to
468 create printable documentation in DVI or PDF format.  Texinfo version
469 4.8 or later is required for @command{make pdf}.
471 Necessary to build GCC documentation during development because the
472 generated output files are not included in the SVN repository.  They are
473 included in releases.
475 @item @TeX{} (any working version)
477 Necessary for running @command{texi2dvi} and @command{texi2pdf}, which
478 are used when running @command{make dvi} or @command{make pdf} to create
479 DVI or PDF files, respectively.
481 @item Sphinx version 1.0 (or later)
483 Necessary to regenerate @file{jit/docs/_build/texinfo} from the @file{.rst}
484 files in the directories below @file{jit/docs}.
486 @item SVN (any version)
487 @itemx SSH (any version)
489 Necessary to access the SVN repository.  Public releases and weekly
490 snapshots of the development sources are also available via FTP@.
492 @item GNU diffutils version 2.7 (or later)
494 Useful when submitting patches for the GCC source code.
496 @item patch version 2.5.4 (or later)
498 Necessary when applying patches, created with @command{diff}, to one's
499 own sources.
501 @end table
503 @html
504 <hr />
506 @end html
507 @ifhtml
508 @uref{./index.html,,Return to the GCC Installation page}
509 @end ifhtml
510 @end ifset
512 @c ***Downloading the source**************************************************
513 @ifnothtml
514 @comment node-name,     next,          previous, up
515 @node    Downloading the source, Configuration, Prerequisites, Installing GCC
516 @end ifnothtml
517 @ifset downloadhtml
518 @ifnothtml
519 @chapter Downloading GCC
520 @end ifnothtml
521 @cindex Downloading GCC
522 @cindex Downloading the Source
524 GCC is distributed via @uref{http://gcc.gnu.org/svn.html,,SVN} and FTP
525 tarballs compressed with @command{gzip} or
526 @command{bzip2}.
528 Please refer to the @uref{http://gcc.gnu.org/releases.html,,releases web page}
529 for information on how to obtain GCC@.
531 The source distribution includes the C, C++, Objective-C, Fortran,
532 and Ada (in the case of GCC 3.1 and later) compilers, as well as
533 runtime libraries for C++, Objective-C, and Fortran.
534 For previous versions these were downloadable as separate components such
535 as the core GCC distribution, which included the C language front end and
536 shared components, and language-specific distributions including the
537 language front end and the language runtime (where appropriate).
539 If you also intend to build binutils (either to upgrade an existing
540 installation or for use in place of the corresponding tools of your
541 OS), unpack the binutils distribution either in the same directory or
542 a separate one.  In the latter case, add symbolic links to any
543 components of the binutils you intend to build alongside the compiler
544 (@file{bfd}, @file{binutils}, @file{gas}, @file{gprof}, @file{ld},
545 @file{opcodes}, @dots{}) to the directory containing the GCC sources.
547 Likewise the GMP, MPFR and MPC libraries can be automatically built
548 together with GCC.  You may simply run the
549 @command{contrib/download_prerequisites} script in the GCC source directory
550 to set up everything.
551 Otherwise unpack the GMP, MPFR and/or MPC source
552 distributions in the directory containing the GCC sources and rename
553 their directories to @file{gmp}, @file{mpfr} and @file{mpc},
554 respectively (or use symbolic links with the same name).
556 @html
557 <hr />
559 @end html
560 @ifhtml
561 @uref{./index.html,,Return to the GCC Installation page}
562 @end ifhtml
563 @end ifset
565 @c ***Configuration***********************************************************
566 @ifnothtml
567 @comment node-name,     next,          previous, up
568 @node    Configuration, Building, Downloading the source, Installing GCC
569 @end ifnothtml
570 @ifset configurehtml
571 @ifnothtml
572 @chapter Installing GCC: Configuration
573 @end ifnothtml
574 @cindex Configuration
575 @cindex Installing GCC: Configuration
577 Like most GNU software, GCC must be configured before it can be built.
578 This document describes the recommended configuration procedure
579 for both native and cross targets.
581 We use @var{srcdir} to refer to the toplevel source directory for
582 GCC; we use @var{objdir} to refer to the toplevel build/object directory.
584 If you obtained the sources via SVN, @var{srcdir} must refer to the top
585 @file{gcc} directory, the one where the @file{MAINTAINERS} file can be
586 found, and not its @file{gcc} subdirectory, otherwise the build will fail.
588 If either @var{srcdir} or @var{objdir} is located on an automounted NFS
589 file system, the shell's built-in @command{pwd} command will return
590 temporary pathnames.  Using these can lead to various sorts of build
591 problems.  To avoid this issue, set the @env{PWDCMD} environment
592 variable to an automounter-aware @command{pwd} command, e.g.,
593 @command{pawd} or @samp{amq -w}, during the configuration and build
594 phases.
596 First, we @strong{highly} recommend that GCC be built into a
597 separate directory from the sources which does @strong{not} reside
598 within the source tree.  This is how we generally build GCC; building
599 where @var{srcdir} == @var{objdir} should still work, but doesn't
600 get extensive testing; building where @var{objdir} is a subdirectory
601 of @var{srcdir} is unsupported.
603 If you have previously built GCC in the same directory for a
604 different target machine, do @samp{make distclean} to delete all files
605 that might be invalid.  One of the files this deletes is @file{Makefile};
606 if @samp{make distclean} complains that @file{Makefile} does not exist
607 or issues a message like ``don't know how to make distclean'' it probably
608 means that the directory is already suitably clean.  However, with the
609 recommended method of building in a separate @var{objdir}, you should
610 simply use a different @var{objdir} for each target.
612 Second, when configuring a native system, either @command{cc} or
613 @command{gcc} must be in your path or you must set @env{CC} in
614 your environment before running configure.  Otherwise the configuration
615 scripts may fail.
617 @ignore
618 Note that the bootstrap compiler and the resulting GCC must be link
619 compatible, else the bootstrap will fail with linker errors about
620 incompatible object file formats.  Several multilibed targets are
621 affected by this requirement, see
622 @ifnothtml
623 @ref{Specific, host/target specific installation notes}.
624 @end ifnothtml
625 @ifhtml
626 @uref{specific.html,,host/target specific installation notes}.
627 @end ifhtml
628 @end ignore
630 To configure GCC:
632 @smallexample
633 % mkdir @var{objdir}
634 % cd @var{objdir}
635 % @var{srcdir}/configure [@var{options}] [@var{target}]
636 @end smallexample
638 @heading Distributor options
640 If you will be distributing binary versions of GCC, with modifications
641 to the source code, you should use the options described in this
642 section to make clear that your version contains modifications.
644 @table @code
645 @item --with-pkgversion=@var{version}
646 Specify a string that identifies your package.  You may wish
647 to include a build number or build date.  This version string will be
648 included in the output of @command{gcc --version}.  This suffix does
649 not replace the default version string, only the @samp{GCC} part.
651 The default value is @samp{GCC}.
653 @item --with-bugurl=@var{url}
654 Specify the URL that users should visit if they wish to report a bug.
655 You are of course welcome to forward bugs reported to you to the FSF,
656 if you determine that they are not bugs in your modifications.
658 The default value refers to the FSF's GCC bug tracker.
660 @end table
662 @heading Target specification
663 @itemize @bullet
664 @item
665 GCC has code to correctly determine the correct value for @var{target}
666 for nearly all native systems.  Therefore, we highly recommend you do
667 not provide a configure target when configuring a native compiler.
669 @item
670 @var{target} must be specified as @option{--target=@var{target}}
671 when configuring a cross compiler; examples of valid targets would be
672 m68k-elf, sh-elf, etc.
674 @item
675 Specifying just @var{target} instead of @option{--target=@var{target}}
676 implies that the host defaults to @var{target}.
677 @end itemize
680 @heading Options specification
682 Use @var{options} to override several configure time options for
683 GCC@.  A list of supported @var{options} follows; @samp{configure
684 --help} may list other options, but those not listed below may not
685 work and should not normally be used.
687 Note that each @option{--enable} option has a corresponding
688 @option{--disable} option and that each @option{--with} option has a
689 corresponding @option{--without} option.
691 @table @code
692 @item --prefix=@var{dirname}
693 Specify the toplevel installation
694 directory.  This is the recommended way to install the tools into a directory
695 other than the default.  The toplevel installation directory defaults to
696 @file{/usr/local}.
698 We @strong{highly} recommend against @var{dirname} being the same or a
699 subdirectory of @var{objdir} or vice versa.  If specifying a directory
700 beneath a user's home directory tree, some shells will not expand
701 @var{dirname} correctly if it contains the @samp{~} metacharacter; use
702 @env{$HOME} instead.
704 The following standard @command{autoconf} options are supported.  Normally you
705 should not need to use these options.
706 @table @code
707 @item --exec-prefix=@var{dirname}
708 Specify the toplevel installation directory for architecture-dependent
709 files.  The default is @file{@var{prefix}}.
711 @item --bindir=@var{dirname}
712 Specify the installation directory for the executables called by users
713 (such as @command{gcc} and @command{g++}).  The default is
714 @file{@var{exec-prefix}/bin}.
716 @item --libdir=@var{dirname}
717 Specify the installation directory for object code libraries and
718 internal data files of GCC@.  The default is @file{@var{exec-prefix}/lib}.
720 @item --libexecdir=@var{dirname}
721 Specify the installation directory for internal executables of GCC@.
722 The default is @file{@var{exec-prefix}/libexec}.
724 @item --with-slibdir=@var{dirname}
725 Specify the installation directory for the shared libgcc library.  The
726 default is @file{@var{libdir}}.
728 @item --datarootdir=@var{dirname}
729 Specify the root of the directory tree for read-only architecture-independent
730 data files referenced by GCC@.  The default is @file{@var{prefix}/share}.
732 @item --infodir=@var{dirname}
733 Specify the installation directory for documentation in info format.
734 The default is @file{@var{datarootdir}/info}.
736 @item --datadir=@var{dirname}
737 Specify the installation directory for some architecture-independent
738 data files referenced by GCC@.  The default is @file{@var{datarootdir}}.
740 @item --docdir=@var{dirname}
741 Specify the installation directory for documentation files (other
742 than Info) for GCC@.  The default is @file{@var{datarootdir}/doc}.
744 @item --htmldir=@var{dirname}
745 Specify the installation directory for HTML documentation files.
746 The default is @file{@var{docdir}}.
748 @item --pdfdir=@var{dirname}
749 Specify the installation directory for PDF documentation files.
750 The default is @file{@var{docdir}}.
752 @item --mandir=@var{dirname}
753 Specify the installation directory for manual pages.  The default is
754 @file{@var{datarootdir}/man}.  (Note that the manual pages are only extracts
755 from the full GCC manuals, which are provided in Texinfo format.  The manpages
756 are derived by an automatic conversion process from parts of the full
757 manual.)
759 @item --with-gxx-include-dir=@var{dirname}
760 Specify
761 the installation directory for G++ header files.  The default depends
762 on other configuration options, and differs between cross and native
763 configurations.
765 @item --with-specs=@var{specs}
766 Specify additional command line driver SPECS.
767 This can be useful if you need to turn on a non-standard feature by
768 default without modifying the compiler's source code, for instance
769 @option{--with-specs=%@{!fcommon:%@{!fno-common:-fno-common@}@}}.
770 @ifnothtml
771 @xref{Spec Files,, Specifying subprocesses and the switches to pass to them,
772 gcc, Using the GNU Compiler Collection (GCC)},
773 @end ifnothtml
774 @ifhtml
775 See ``Spec Files'' in the main manual
776 @end ifhtml
778 @end table
780 @item --program-prefix=@var{prefix}
781 GCC supports some transformations of the names of its programs when
782 installing them.  This option prepends @var{prefix} to the names of
783 programs to install in @var{bindir} (see above).  For example, specifying
784 @option{--program-prefix=foo-} would result in @samp{gcc}
785 being installed as @file{/usr/local/bin/foo-gcc}.
787 @item --program-suffix=@var{suffix}
788 Appends @var{suffix} to the names of programs to install in @var{bindir}
789 (see above).  For example, specifying @option{--program-suffix=-3.1}
790 would result in @samp{gcc} being installed as
791 @file{/usr/local/bin/gcc-3.1}.
793 @item --program-transform-name=@var{pattern}
794 Applies the @samp{sed} script @var{pattern} to be applied to the names
795 of programs to install in @var{bindir} (see above).  @var{pattern} has to
796 consist of one or more basic @samp{sed} editing commands, separated by
797 semicolons.  For example, if you want the @samp{gcc} program name to be
798 transformed to the installed program @file{/usr/local/bin/myowngcc} and
799 the @samp{g++} program name to be transformed to
800 @file{/usr/local/bin/gspecial++} without changing other program names,
801 you could use the pattern
802 @option{--program-transform-name='s/^gcc$/myowngcc/; s/^g++$/gspecial++/'}
803 to achieve this effect.
805 All three options can be combined and used together, resulting in more
806 complex conversion patterns.  As a basic rule, @var{prefix} (and
807 @var{suffix}) are prepended (appended) before further transformations
808 can happen with a special transformation script @var{pattern}.
810 As currently implemented, this option only takes effect for native
811 builds; cross compiler binaries' names are not transformed even when a
812 transformation is explicitly asked for by one of these options.
814 For native builds, some of the installed programs are also installed
815 with the target alias in front of their name, as in
816 @samp{i686-pc-linux-gnu-gcc}.  All of the above transformations happen
817 before the target alias is prepended to the name---so, specifying
818 @option{--program-prefix=foo-} and @option{program-suffix=-3.1}, the
819 resulting binary would be installed as
820 @file{/usr/local/bin/i686-pc-linux-gnu-foo-gcc-3.1}.
822 As a last shortcoming, none of the installed Ada programs are
823 transformed yet, which will be fixed in some time.
825 @item --with-local-prefix=@var{dirname}
826 Specify the
827 installation directory for local include files.  The default is
828 @file{/usr/local}.  Specify this option if you want the compiler to
829 search directory @file{@var{dirname}/include} for locally installed
830 header files @emph{instead} of @file{/usr/local/include}.
832 You should specify @option{--with-local-prefix} @strong{only} if your
833 site has a different convention (not @file{/usr/local}) for where to put
834 site-specific files.
836 The default value for @option{--with-local-prefix} is @file{/usr/local}
837 regardless of the value of @option{--prefix}.  Specifying
838 @option{--prefix} has no effect on which directory GCC searches for
839 local header files.  This may seem counterintuitive, but actually it is
840 logical.
842 The purpose of @option{--prefix} is to specify where to @emph{install
843 GCC}.  The local header files in @file{/usr/local/include}---if you put
844 any in that directory---are not part of GCC@.  They are part of other
845 programs---perhaps many others.  (GCC installs its own header files in
846 another directory which is based on the @option{--prefix} value.)
848 Both the local-prefix include directory and the GCC-prefix include
849 directory are part of GCC's ``system include'' directories.  Although these
850 two directories are not fixed, they need to be searched in the proper
851 order for the correct processing of the include_next directive.  The
852 local-prefix include directory is searched before the GCC-prefix
853 include directory.  Another characteristic of system include directories
854 is that pedantic warnings are turned off for headers in these directories.
856 Some autoconf macros add @option{-I @var{directory}} options to the
857 compiler command line, to ensure that directories containing installed
858 packages' headers are searched.  When @var{directory} is one of GCC's
859 system include directories, GCC will ignore the option so that system
860 directories continue to be processed in the correct order.  This
861 may result in a search order different from what was specified but the
862 directory will still be searched.
864 GCC automatically searches for ordinary libraries using
865 @env{GCC_EXEC_PREFIX}.  Thus, when the same installation prefix is
866 used for both GCC and packages, GCC will automatically search for
867 both headers and libraries.  This provides a configuration that is
868 easy to use.  GCC behaves in a manner similar to that when it is
869 installed as a system compiler in @file{/usr}.
871 Sites that need to install multiple versions of GCC may not want to
872 use the above simple configuration.  It is possible to use the
873 @option{--program-prefix}, @option{--program-suffix} and
874 @option{--program-transform-name} options to install multiple versions
875 into a single directory, but it may be simpler to use different prefixes
876 and the @option{--with-local-prefix} option to specify the location of the
877 site-specific files for each version.  It will then be necessary for
878 users to specify explicitly the location of local site libraries
879 (e.g., with @env{LIBRARY_PATH}).
881 The same value can be used for both @option{--with-local-prefix} and
882 @option{--prefix} provided it is not @file{/usr}.  This can be used
883 to avoid the default search of @file{/usr/local/include}.
885 @strong{Do not} specify @file{/usr} as the @option{--with-local-prefix}!
886 The directory you use for @option{--with-local-prefix} @strong{must not}
887 contain any of the system's standard header files.  If it did contain
888 them, certain programs would be miscompiled (including GNU Emacs, on
889 certain targets), because this would override and nullify the header
890 file corrections made by the @command{fixincludes} script.
892 Indications are that people who use this option use it based on mistaken
893 ideas of what it is for.  People use it as if it specified where to
894 install part of GCC@.  Perhaps they make this assumption because
895 installing GCC creates the directory.
897 @item --with-gcc-major-version-only
898 Specifies that GCC should use only the major number rather than
899 @var{major}.@var{minor}.@var{patchlevel} in filesystem paths.
901 @item --with-native-system-header-dir=@var{dirname}
902 Specifies that @var{dirname} is the directory that contains native system
903 header files, rather than @file{/usr/include}.  This option is most useful
904 if you are creating a compiler that should be isolated from the system
905 as much as possible.  It is most commonly used with the
906 @option{--with-sysroot} option and will cause GCC to search
907 @var{dirname} inside the system root specified by that option.
909 @item --enable-shared[=@var{package}[,@dots{}]]
910 Build shared versions of libraries, if shared libraries are supported on
911 the target platform.  Unlike GCC 2.95.x and earlier, shared libraries
912 are enabled by default on all platforms that support shared libraries.
914 If a list of packages is given as an argument, build shared libraries
915 only for the listed packages.  For other packages, only static libraries
916 will be built.  Package names currently recognized in the GCC tree are
917 @samp{libgcc} (also known as @samp{gcc}), @samp{libstdc++} (not
918 @samp{libstdc++-v3}), @samp{libffi}, @samp{zlib}, @samp{boehm-gc},
919 @samp{ada}, @samp{libada}, @samp{libgo}, and @samp{libobjc}.
920 Note @samp{libiberty} does not support shared libraries at all.
922 Use @option{--disable-shared} to build only static libraries.  Note that
923 @option{--disable-shared} does not accept a list of package names as
924 argument, only @option{--enable-shared} does.
926 Contrast with @option{--enable-host-shared}, which affects @emph{host}
927 code.
929 @item --enable-host-shared
930 Specify that the @emph{host} code should be built into position-independent
931 machine code (with -fPIC), allowing it to be used within shared libraries,
932 but yielding a slightly slower compiler.
934 This option is required when building the libgccjit.so library.
936 Contrast with @option{--enable-shared}, which affects @emph{target}
937 libraries.
939 @item @anchor{with-gnu-as}--with-gnu-as
940 Specify that the compiler should assume that the
941 assembler it finds is the GNU assembler.  However, this does not modify
942 the rules to find an assembler and will result in confusion if the
943 assembler found is not actually the GNU assembler.  (Confusion may also
944 result if the compiler finds the GNU assembler but has not been
945 configured with @option{--with-gnu-as}.)  If you have more than one
946 assembler installed on your system, you may want to use this option in
947 connection with @option{--with-as=@var{pathname}} or
948 @option{--with-build-time-tools=@var{pathname}}.
950 The following systems are the only ones where it makes a difference
951 whether you use the GNU assembler.  On any other system,
952 @option{--with-gnu-as} has no effect.
954 @itemize @bullet
955 @item @samp{hppa1.0-@var{any}-@var{any}}
956 @item @samp{hppa1.1-@var{any}-@var{any}}
957 @item @samp{sparc-sun-solaris2.@var{any}}
958 @item @samp{sparc64-@var{any}-solaris2.@var{any}}
959 @end itemize
961 @item @anchor{with-as}--with-as=@var{pathname}
962 Specify that the compiler should use the assembler pointed to by
963 @var{pathname}, rather than the one found by the standard rules to find
964 an assembler, which are:
965 @itemize @bullet
966 @item
967 Unless GCC is being built with a cross compiler, check the
968 @file{@var{libexec}/gcc/@var{target}/@var{version}} directory.
969 @var{libexec} defaults to @file{@var{exec-prefix}/libexec};
970 @var{exec-prefix} defaults to @var{prefix}, which
971 defaults to @file{/usr/local} unless overridden by the
972 @option{--prefix=@var{pathname}} switch described above.  @var{target}
973 is the target system triple, such as @samp{sparc-sun-solaris2.7}, and
974 @var{version} denotes the GCC version, such as 3.0.
976 @item
977 If the target system is the same that you are building on, check
978 operating system specific directories (e.g.@: @file{/usr/ccs/bin} on
979 Sun Solaris 2).
981 @item
982 Check in the @env{PATH} for a tool whose name is prefixed by the
983 target system triple.
985 @item
986 Check in the @env{PATH} for a tool whose name is not prefixed by the
987 target system triple, if the host and target system triple are
988 the same (in other words, we use a host tool if it can be used for
989 the target as well).
990 @end itemize
992 You may want to use @option{--with-as} if no assembler
993 is installed in the directories listed above, or if you have multiple
994 assemblers installed and want to choose one that is not found by the
995 above rules.
997 @item @anchor{with-gnu-ld}--with-gnu-ld
998 Same as @uref{#with-gnu-as,,@option{--with-gnu-as}}
999 but for the linker.
1001 @item --with-ld=@var{pathname}
1002 Same as @uref{#with-as,,@option{--with-as}}
1003 but for the linker.
1005 @item --with-stabs
1006 Specify that stabs debugging
1007 information should be used instead of whatever format the host normally
1008 uses.  Normally GCC uses the same debug format as the host system.
1010 On MIPS based systems and on Alphas, you must specify whether you want
1011 GCC to create the normal ECOFF debugging format, or to use BSD-style
1012 stabs passed through the ECOFF symbol table.  The normal ECOFF debug
1013 format cannot fully handle languages other than C@.  BSD stabs format can
1014 handle other languages, but it only works with the GNU debugger GDB@.
1016 Normally, GCC uses the ECOFF debugging format by default; if you
1017 prefer BSD stabs, specify @option{--with-stabs} when you configure GCC@.
1019 No matter which default you choose when you configure GCC, the user
1020 can use the @option{-gcoff} and @option{-gstabs+} options to specify explicitly
1021 the debug format for a particular compilation.
1023 @option{--with-stabs} is meaningful on the ISC system on the 386, also, if
1024 @option{--with-gas} is used.  It selects use of stabs debugging
1025 information embedded in COFF output.  This kind of debugging information
1026 supports C++ well; ordinary COFF debugging information does not.
1028 @option{--with-stabs} is also meaningful on 386 systems running SVR4.  It
1029 selects use of stabs debugging information embedded in ELF output.  The
1030 C++ compiler currently (2.6.0) does not support the DWARF debugging
1031 information normally used on 386 SVR4 platforms; stabs provide a
1032 workable alternative.  This requires gas and gdb, as the normal SVR4
1033 tools can not generate or interpret stabs.
1035 @item --with-tls=@var{dialect}
1036 Specify the default TLS dialect, for systems were there is a choice.
1037 For ARM targets, possible values for @var{dialect} are @code{gnu} or
1038 @code{gnu2}, which select between the original GNU dialect and the GNU TLS
1039 descriptor-based dialect.
1041 @item --enable-multiarch
1042 Specify whether to enable or disable multiarch support.  The default is
1043 to check for glibc start files in a multiarch location, and enable it
1044 if the files are found.  The auto detection is enabled for native builds,
1045 and for cross builds configured with @option{--with-sysroot}, and without
1046 @option{--with-native-system-header-dir}.
1047 More documentation about multiarch can be found at
1048 @uref{https://wiki.debian.org/Multiarch}.
1050 @item --enable-sjlj-exceptions
1051 Force use of the @code{setjmp}/@code{longjmp}-based scheme for exceptions.
1052 @samp{configure} ordinarily picks the correct value based on the platform.
1053 Only use this option if you are sure you need a different setting.
1055 @item --enable-vtable-verify
1056 Specify whether to enable or disable the vtable verification feature.
1057 Enabling this feature causes libstdc++ to be built with its virtual calls
1058 in verifiable mode.  This means that, when linked with libvtv, every
1059 virtual call in libstdc++ will verify the vtable pointer through which the
1060 call will be made before actually making the call.  If not linked with libvtv,
1061 the verifier will call stub functions (in libstdc++ itself) and do nothing.
1062 If vtable verification is disabled, then libstdc++ is not built with its
1063 virtual calls in verifiable mode at all.  However the libvtv library will
1064 still be built (see @option{--disable-libvtv} to turn off building libvtv).
1065 @option{--disable-vtable-verify} is the default.
1067 @item --disable-multilib
1068 Specify that multiple target
1069 libraries to support different target variants, calling
1070 conventions, etc.@: should not be built.  The default is to build a
1071 predefined set of them.
1073 Some targets provide finer-grained control over which multilibs are built
1074 (e.g., @option{--disable-softfloat}):
1075 @table @code
1076 @item arm-*-*
1077 fpu, 26bit, underscore, interwork, biendian, nofmult.
1079 @item m68*-*-*
1080 softfloat, m68881, m68000, m68020.
1082 @item mips*-*-*
1083 single-float, biendian, softfloat.
1085 @item powerpc*-*-*, rs6000*-*-*
1086 aix64, pthread, softfloat, powercpu, powerpccpu, powerpcos, biendian,
1087 sysv, aix.
1089 @end table
1091 @item --with-multilib-list=@var{list}
1092 @itemx --without-multilib-list
1093 Specify what multilibs to build.  @var{list} is a comma separated list of
1094 values, possibly consisting of a single value.  Currently only implemented
1095 for arm*-*-*, sh*-*-* and x86-64-*-linux*.  The accepted values and meaning
1096 for each target is given below.
1098 @table @code
1099 @item arm*-*-*
1100 @var{list} is a comma separated list of @code{aprofile} and @code{rmprofile}
1101 to build multilibs for A or R and M architecture profiles respectively.  Note
1102 that, due to some limitation of the current multilib framework, using the
1103 combined @code{aprofile,rmprofile} multilibs selects in some cases a less
1104 optimal multilib than when using the multilib profile for the architecture
1105 targetted.  The special value @code{default} is also accepted and is equivalent
1106 to omitting the option, ie. only the default run-time library will be enabled.
1108 The table below gives the combination of ISAs, architectures, FPUs and
1109 floating-point ABIs for which multilibs are built for each accepted value.
1110 The union of these options is considered when specifying both @code{aprofile}
1111 and @code{rmprofile}.
1113 @multitable @columnfractions .15 .28 .30
1114 @item Option @tab aprofile @tab rmprofile
1115 @item ISAs
1116 @tab @code{-marm} and @code{-mthumb}
1117 @tab @code{-mthumb}
1118 @item Architectures@*@*@*@*@*@*
1119 @tab default architecture@*
1120 @code{-march=armv7-a}@*
1121 @code{-march=armv7ve}@*
1122 @code{-march=armv8-a}@*@*@*
1123 @tab default architecture@*
1124 @code{-march=armv6s-m}@*
1125 @code{-march=armv7-m}@*
1126 @code{-march=armv7e-m}@*
1127 @code{-march=armv8-m.base}@*
1128 @code{-march=armv8-m.main}@*
1129 @code{-march=armv7}
1130 @item FPUs@*@*@*@*@*
1131 @tab none@*
1132 @code{-mfpu=vfpv3-d16}@*
1133 @code{-mfpu=neon}@*
1134 @code{-mfpu=vfpv4-d16}@*
1135 @code{-mfpu=neon-vfpv4}@*
1136 @code{-mfpu=neon-fp-armv8}
1137 @tab none@*
1138 @code{-mfpu=vfpv3-d16}@*
1139 @code{-mfpu=fpv4-sp-d16}@*
1140 @code{-mfpu=fpv5-sp-d16}@*
1141 @code{-mfpu=fpv5-d16}@*
1142 @item floating-point@/ ABIs@*@*
1143 @tab @code{-mfloat-abi=soft}@*
1144 @code{-mfloat-abi=softfp}@*
1145 @code{-mfloat-abi=hard}
1146 @tab @code{-mfloat-abi=soft}@*
1147 @code{-mfloat-abi=softfp}@*
1148 @code{-mfloat-abi=hard}
1149 @end multitable
1151 @item sh*-*-*
1152 @var{list} is a comma separated list of CPU names.  These must be of the
1153 form @code{sh*} or @code{m*} (in which case they match the compiler option
1154 for that processor).  The list should not contain any endian options -
1155 these are handled by @option{--with-endian}.
1157 If @var{list} is empty, then there will be no multilibs for extra
1158 processors.  The multilib for the secondary endian remains enabled.
1160 As a special case, if an entry in the list starts with a @code{!}
1161 (exclamation point), then it is added to the list of excluded multilibs.
1162 Entries of this sort should be compatible with @samp{MULTILIB_EXCLUDES}
1163 (once the leading @code{!} has been stripped).
1165 If @option{--with-multilib-list} is not given, then a default set of
1166 multilibs is selected based on the value of @option{--target}.  This is
1167 usually the complete set of libraries, but some targets imply a more
1168 specialized subset.
1170 Example 1: to configure a compiler for SH4A only, but supporting both
1171 endians, with little endian being the default:
1172 @smallexample
1173 --with-cpu=sh4a --with-endian=little,big --with-multilib-list=
1174 @end smallexample
1176 Example 2: to configure a compiler for both SH4A and SH4AL-DSP, but with
1177 only little endian SH4AL:
1178 @smallexample
1179 --with-cpu=sh4a --with-endian=little,big \
1180 --with-multilib-list=sh4al,!mb/m4al
1181 @end smallexample
1183 @item x86-64-*-linux*
1184 @var{list} is a comma separated list of @code{m32}, @code{m64} and
1185 @code{mx32} to enable 32-bit, 64-bit and x32 run-time libraries,
1186 respectively.  If @var{list} is empty, then there will be no multilibs
1187 and only the default run-time library will be enabled.
1189 If @option{--with-multilib-list} is not given, then only 32-bit and
1190 64-bit run-time libraries will be enabled.
1191 @end table
1193 @item --with-endian=@var{endians}
1194 Specify what endians to use.
1195 Currently only implemented for sh*-*-*.
1197 @var{endians} may be one of the following:
1198 @table @code
1199 @item big
1200 Use big endian exclusively.
1201 @item little
1202 Use little endian exclusively.
1203 @item big,little
1204 Use big endian by default.  Provide a multilib for little endian.
1205 @item little,big
1206 Use little endian by default.  Provide a multilib for big endian.
1207 @end table
1209 @item --enable-threads
1210 Specify that the target
1211 supports threads.  This affects the Objective-C compiler and runtime
1212 library, and exception handling for other languages like C++.
1213 On some systems, this is the default.
1215 In general, the best (and, in many cases, the only known) threading
1216 model available will be configured for use.  Beware that on some
1217 systems, GCC has not been taught what threading models are generally
1218 available for the system.  In this case, @option{--enable-threads} is an
1219 alias for @option{--enable-threads=single}.
1221 @item --disable-threads
1222 Specify that threading support should be disabled for the system.
1223 This is an alias for @option{--enable-threads=single}.
1225 @item --enable-threads=@var{lib}
1226 Specify that
1227 @var{lib} is the thread support library.  This affects the Objective-C
1228 compiler and runtime library, and exception handling for other languages
1229 like C++.  The possibilities for @var{lib} are:
1231 @table @code
1232 @item aix
1233 AIX thread support.
1234 @item dce
1235 DCE thread support.
1236 @item lynx
1237 LynxOS thread support.
1238 @item mipssde
1239 MIPS SDE thread support.
1240 @item no
1241 This is an alias for @samp{single}.
1242 @item posix
1243 Generic POSIX/Unix98 thread support.
1244 @item rtems
1245 RTEMS thread support.
1246 @item single
1247 Disable thread support, should work for all platforms.
1248 @item tpf
1249 TPF thread support.
1250 @item vxworks
1251 VxWorks thread support.
1252 @item win32
1253 Microsoft Win32 API thread support.
1254 @end table
1256 @item --enable-tls
1257 Specify that the target supports TLS (Thread Local Storage).  Usually
1258 configure can correctly determine if TLS is supported.  In cases where
1259 it guesses incorrectly, TLS can be explicitly enabled or disabled with
1260 @option{--enable-tls} or @option{--disable-tls}.  This can happen if
1261 the assembler supports TLS but the C library does not, or if the
1262 assumptions made by the configure test are incorrect.
1264 @item --disable-tls
1265 Specify that the target does not support TLS.
1266 This is an alias for @option{--enable-tls=no}.
1268 @item --with-cpu=@var{cpu}
1269 @itemx --with-cpu-32=@var{cpu}
1270 @itemx --with-cpu-64=@var{cpu}
1271 Specify which cpu variant the compiler should generate code for by default.
1272 @var{cpu} will be used as the default value of the @option{-mcpu=} switch.
1273 This option is only supported on some targets, including ARC, ARM, i386, M68k,
1274 PowerPC, and SPARC@.  It is mandatory for ARC@.  The @option{--with-cpu-32} and
1275 @option{--with-cpu-64} options specify separate default CPUs for
1276 32-bit and 64-bit modes; these options are only supported for i386,
1277 x86-64, PowerPC, and SPARC@.
1279 @item --with-schedule=@var{cpu}
1280 @itemx --with-arch=@var{cpu}
1281 @itemx --with-arch-32=@var{cpu}
1282 @itemx --with-arch-64=@var{cpu}
1283 @itemx --with-tune=@var{cpu}
1284 @itemx --with-tune-32=@var{cpu}
1285 @itemx --with-tune-64=@var{cpu}
1286 @itemx --with-abi=@var{abi}
1287 @itemx --with-fpu=@var{type}
1288 @itemx --with-float=@var{type}
1289 These configure options provide default values for the @option{-mschedule=},
1290 @option{-march=}, @option{-mtune=}, @option{-mabi=}, and @option{-mfpu=}
1291 options and for @option{-mhard-float} or @option{-msoft-float}.  As with
1292 @option{--with-cpu}, which switches will be accepted and acceptable values
1293 of the arguments depend on the target.
1295 @item --with-mode=@var{mode}
1296 Specify if the compiler should default to @option{-marm} or @option{-mthumb}.
1297 This option is only supported on ARM targets.
1299 @item --with-stack-offset=@var{num}
1300 This option sets the default for the -mstack-offset=@var{num} option,
1301 and will thus generally also control the setting of this option for
1302 libraries.  This option is only supported on Epiphany targets.
1304 @item --with-fpmath=@var{isa}
1305 This options sets @option{-mfpmath=sse} by default and specifies the default
1306 ISA for floating-point arithmetics.  You can select either @samp{sse} which
1307 enables @option{-msse2} or @samp{avx} which enables @option{-mavx} by default.
1308 This option is only supported on i386 and x86-64 targets.
1310 @item --with-fp-32=@var{mode}
1311 On MIPS targets, set the default value for the @option{-mfp} option when using
1312 the o32 ABI.  The possibilities for @var{mode} are:
1313 @table @code
1314 @item 32
1315 Use the o32 FP32 ABI extension, as with the @option{-mfp32} command-line
1316 option.
1317 @item xx
1318 Use the o32 FPXX ABI extension, as with the @option{-mfpxx} command-line
1319 option.
1320 @item 64
1321 Use the o32 FP64 ABI extension, as with the @option{-mfp64} command-line
1322 option.
1323 @end table
1324 In the absence of this configuration option the default is to use the o32
1325 FP32 ABI extension.
1327 @item --with-odd-spreg-32
1328 On MIPS targets, set the @option{-modd-spreg} option by default when using
1329 the o32 ABI.
1331 @item --without-odd-spreg-32
1332 On MIPS targets, set the @option{-mno-odd-spreg} option by default when using
1333 the o32 ABI.  This is normally used in conjunction with
1334 @option{--with-fp-32=64} in order to target the o32 FP64A ABI extension.
1336 @item --with-nan=@var{encoding}
1337 On MIPS targets, set the default encoding convention to use for the
1338 special not-a-number (NaN) IEEE 754 floating-point data.  The
1339 possibilities for @var{encoding} are:
1340 @table @code
1341 @item legacy
1342 Use the legacy encoding, as with the @option{-mnan=legacy} command-line
1343 option.
1344 @item 2008
1345 Use the 754-2008 encoding, as with the @option{-mnan=2008} command-line
1346 option.
1347 @end table
1348 To use this configuration option you must have an assembler version
1349 installed that supports the @option{-mnan=} command-line option too.
1350 In the absence of this configuration option the default convention is
1351 the legacy encoding, as when neither of the @option{-mnan=2008} and
1352 @option{-mnan=legacy} command-line options has been used.
1354 @item --with-divide=@var{type}
1355 Specify how the compiler should generate code for checking for
1356 division by zero.  This option is only supported on the MIPS target.
1357 The possibilities for @var{type} are:
1358 @table @code
1359 @item traps
1360 Division by zero checks use conditional traps (this is the default on
1361 systems that support conditional traps).
1362 @item breaks
1363 Division by zero checks use the break instruction.
1364 @end table
1366 @c If you make --with-llsc the default for additional targets,
1367 @c update the --with-llsc description in the MIPS section below.
1369 @item --with-llsc
1370 On MIPS targets, make @option{-mllsc} the default when no
1371 @option{-mno-llsc} option is passed.  This is the default for
1372 Linux-based targets, as the kernel will emulate them if the ISA does
1373 not provide them.
1375 @item --without-llsc
1376 On MIPS targets, make @option{-mno-llsc} the default when no
1377 @option{-mllsc} option is passed.
1379 @item --with-synci
1380 On MIPS targets, make @option{-msynci} the default when no
1381 @option{-mno-synci} option is passed.
1383 @item --without-synci
1384 On MIPS targets, make @option{-mno-synci} the default when no
1385 @option{-msynci} option is passed.  This is the default.
1387 @item --with-lxc1-sxc1
1388 On MIPS targets, make @option{-mlxc1-sxc1} the default when no
1389 @option{-mno-lxc1-sxc1} option is passed.  This is the default.
1391 @item --without-lxc1-sxc1
1392 On MIPS targets, make @option{-mno-lxc1-sxc1} the default when no
1393 @option{-mlxc1-sxc1} option is passed.  The indexed load/store
1394 instructions are not directly a problem but can lead to unexpected
1395 behaviour when deployed in an application intended for a 32-bit address
1396 space but run on a 64-bit processor.  The issue is seen because all
1397 known MIPS 64-bit Linux kernels execute o32 and n32 applications
1398 with 64-bit addressing enabled which affects the overflow behaviour
1399 of the indexed addressing mode.  GCC will assume that ordinary
1400 32-bit arithmetic overflow behaviour is the same whether performed
1401 as an @code{addu} instruction or as part of the address calculation
1402 in @code{lwxc1} type instructions.  This assumption holds true in a
1403 pure 32-bit environment and can hold true in a 64-bit environment if
1404 the address space is accurately set to be 32-bit for o32 and n32.
1406 @item --with-madd4
1407 On MIPS targets, make @option{-mmadd4} the default when no
1408 @option{-mno-madd4} option is passed.  This is the default.
1410 @item --without-madd4
1411 On MIPS targets, make @option{-mno-madd4} the default when no
1412 @option{-mmadd4} option is passed.  The @code{madd4} instruction
1413 family can be problematic when targeting a combination of cores that
1414 implement these instructions differently.  There are two known cores
1415 that implement these as fused operations instead of unfused (where
1416 unfused is normally expected).  Disabling these instructions is the
1417 only way to ensure compatible code is generated; this will incur
1418 a performance penalty.
1420 @item --with-mips-plt
1421 On MIPS targets, make use of copy relocations and PLTs.
1422 These features are extensions to the traditional
1423 SVR4-based MIPS ABIs and require support from GNU binutils
1424 and the runtime C library.
1426 @item --enable-__cxa_atexit
1427 Define if you want to use __cxa_atexit, rather than atexit, to
1428 register C++ destructors for local statics and global objects.
1429 This is essential for fully standards-compliant handling of
1430 destructors, but requires __cxa_atexit in libc.  This option is currently
1431 only available on systems with GNU libc.  When enabled, this will cause
1432 @option{-fuse-cxa-atexit} to be passed by default.
1434 @item --enable-gnu-indirect-function
1435 Define if you want to enable the @code{ifunc} attribute.  This option is
1436 currently only available on systems with GNU libc on certain targets.
1438 @item --enable-target-optspace
1439 Specify that target
1440 libraries should be optimized for code space instead of code speed.
1441 This is the default for the m32r platform.
1443 @item --with-cpp-install-dir=@var{dirname}
1444 Specify that the user visible @command{cpp} program should be installed
1445 in @file{@var{prefix}/@var{dirname}/cpp}, in addition to @var{bindir}.
1447 @item --enable-comdat
1448 Enable COMDAT group support.  This is primarily used to override the
1449 automatically detected value.
1451 @item --enable-initfini-array
1452 Force the use of sections @code{.init_array} and @code{.fini_array}
1453 (instead of @code{.init} and @code{.fini}) for constructors and
1454 destructors.  Option @option{--disable-initfini-array} has the
1455 opposite effect.  If neither option is specified, the configure script
1456 will try to guess whether the @code{.init_array} and
1457 @code{.fini_array} sections are supported and, if they are, use them.
1459 @item --enable-link-mutex
1460 When building GCC, use a mutex to avoid linking the compilers for
1461 multiple languages at the same time, to avoid thrashing on build
1462 systems with limited free memory.  The default is not to use such a mutex.
1464 @item --enable-maintainer-mode
1465 The build rules that regenerate the Autoconf and Automake output files as
1466 well as the GCC master message catalog @file{gcc.pot} are normally
1467 disabled.  This is because it can only be rebuilt if the complete source
1468 tree is present.  If you have changed the sources and want to rebuild the
1469 catalog, configuring with @option{--enable-maintainer-mode} will enable
1470 this.  Note that you need a recent version of the @code{gettext} tools
1471 to do so.
1473 @item --disable-bootstrap
1474 For a native build, the default configuration is to perform
1475 a 3-stage bootstrap of the compiler when @samp{make} is invoked,
1476 testing that GCC can compile itself correctly.  If you want to disable
1477 this process, you can configure with @option{--disable-bootstrap}.
1479 @item --enable-bootstrap
1480 In special cases, you may want to perform a 3-stage build
1481 even if the target and host triplets are different.
1482 This is possible when the host can run code compiled for
1483 the target (e.g.@: host is i686-linux, target is i486-linux).
1484 Starting from GCC 4.2, to do this you have to configure explicitly
1485 with @option{--enable-bootstrap}.
1487 @item --enable-generated-files-in-srcdir
1488 Neither the .c and .h files that are generated from Bison and flex nor the
1489 info manuals and man pages that are built from the .texi files are present
1490 in the SVN development tree.  When building GCC from that development tree,
1491 or from one of our snapshots, those generated files are placed in your
1492 build directory, which allows for the source to be in a readonly
1493 directory.
1495 If you configure with @option{--enable-generated-files-in-srcdir} then those
1496 generated files will go into the source directory.  This is mainly intended
1497 for generating release or prerelease tarballs of the GCC sources, since it
1498 is not a requirement that the users of source releases to have flex, Bison,
1499 or makeinfo.
1501 @item --enable-version-specific-runtime-libs
1502 Specify
1503 that runtime libraries should be installed in the compiler specific
1504 subdirectory (@file{@var{libdir}/gcc}) rather than the usual places.  In
1505 addition, @samp{libstdc++}'s include files will be installed into
1506 @file{@var{libdir}} unless you overruled it by using
1507 @option{--with-gxx-include-dir=@var{dirname}}.  Using this option is
1508 particularly useful if you intend to use several versions of GCC in
1509 parallel.  This is currently supported by @samp{libgfortran},
1510 @samp{libstdc++}, and @samp{libobjc}.
1512 @item @anchor{WithAixSoname}--with-aix-soname=@samp{aix}, @samp{svr4} or @samp{both}
1513 Traditional AIX shared library versioning (versioned @code{Shared Object}
1514 files as members of unversioned @code{Archive Library} files named
1515 @samp{lib.a}) causes numerous headaches for package managers. However,
1516 @code{Import Files} as members of @code{Archive Library} files allow for
1517 @strong{filename-based versioning} of shared libraries as seen on Linux/SVR4,
1518 where this is called the "SONAME". But as they prevent static linking,
1519 @code{Import Files} may be used with @code{Runtime Linking} only, where the
1520 linker does search for @samp{libNAME.so} before @samp{libNAME.a} library
1521 filenames with the @samp{-lNAME} linker flag.
1523 @anchor{AixLdCommand}For detailed information please refer to the AIX
1524 @uref{https://www.ibm.com/support/knowledgecenter/search/%22the%20ld%20command%2C%20also%20called%20the%20linkage%20editor%20or%20binder%22,,ld
1525 Command} reference.
1527 As long as shared library creation is enabled, upon:
1528 @table @code
1529 @item --with-aix-soname=aix
1530 @item --with-aix-soname=both
1531  A (traditional AIX) @code{Shared Archive Library} file is created:
1532  @itemize @bullet
1533   @item using the @samp{libNAME.a} filename scheme
1534   @item with the @code{Shared Object} file as archive member named
1535   @samp{libNAME.so.V} (except for @samp{libgcc_s}, where the @code{Shared
1536   Object} file is named @samp{shr.o} for backwards compatibility), which
1537   @itemize @minus
1538    @item is used for runtime loading from inside the @samp{libNAME.a} file
1539    @item is used for dynamic loading via
1540    @code{dlopen("libNAME.a(libNAME.so.V)", RTLD_MEMBER)}
1541    @item is used for shared linking
1542    @item is used for static linking, so no separate @code{Static Archive
1543    Library} file is needed
1544   @end itemize
1545  @end itemize
1546 @item --with-aix-soname=both
1547 @item --with-aix-soname=svr4
1548  A (second) @code{Shared Archive Library} file is created:
1549  @itemize @bullet
1550  @item using the @samp{libNAME.so.V} filename scheme
1551  @item with the @code{Shared Object} file as archive member named
1552  @samp{shr.o}, which
1553   @itemize @minus
1554    @item is created with the @code{-G linker flag}
1555    @item has the @code{F_LOADONLY} flag set
1556    @item is used for runtime loading from inside the @samp{libNAME.so.V} file
1557    @item is used for dynamic loading via @code{dlopen("libNAME.so.V(shr.o)",
1558    RTLD_MEMBER)}
1559   @end itemize
1560  @item with the @code{Import File} as archive member named @samp{shr.imp},
1561  which
1562   @itemize @minus
1563    @item refers to @samp{libNAME.so.V(shr.o)} as the "SONAME", to be recorded
1564    in the @code{Loader Section} of subsequent binaries
1565    @item indicates whether @samp{libNAME.so.V(shr.o)} is 32 or 64 bit
1566    @item lists all the public symbols exported by @samp{lib.so.V(shr.o)},
1567    eventually decorated with the @code{@samp{weak} Keyword}
1568    @item is necessary for shared linking against @samp{lib.so.V(shr.o)}
1569    @end itemize
1570   @end itemize
1571   A symbolic link using the @samp{libNAME.so} filename scheme is created:
1572   @itemize @bullet
1573   @item pointing to the @samp{libNAME.so.V} @code{Shared Archive Library} file
1574   @item to permit the @code{ld Command} to find @samp{lib.so.V(shr.imp)} via
1575   the @samp{-lNAME} argument (requires @code{Runtime Linking} to be enabled)
1576   @item to permit dynamic loading of @samp{lib.so.V(shr.o)} without the need
1577   to specify the version number via @code{dlopen("libNAME.so(shr.o)",
1578   RTLD_MEMBER)}
1579   @end itemize
1580 @end table
1582 As long as static library creation is enabled, upon:
1583 @table @code
1584 @item --with-aix-soname=svr4
1585  A @code{Static Archive Library} is created:
1586  @itemize @bullet
1587  @item using the @samp{libNAME.a} filename scheme
1588  @item with all the @code{Static Object} files as archive members, which
1589   @itemize @minus
1590    @item are used for static linking
1591   @end itemize
1592  @end itemize
1593 @end table
1595 While the aix-soname=@samp{svr4} option does not create @code{Shared Object}
1596 files as members of unversioned @code{Archive Library} files any more, package
1597 managers still are responsible to
1598 @uref{./specific.html#TransferAixShobj,,transfer} @code{Shared Object} files
1599 found as member of a previously installed unversioned @code{Archive Library}
1600 file into the newly installed @code{Archive Library} file with the same
1601 filename.
1603 @emph{WARNING:} Creating @code{Shared Object} files with @code{Runtime Linking}
1604 enabled may bloat the TOC, eventually leading to @code{TOC overflow} errors,
1605 requiring the use of either the @option{-Wl,-bbigtoc} linker flag (seen to
1606 break with the @code{GDB} debugger) or some of the TOC-related compiler flags,
1607 @ifnothtml
1608 @xref{RS/6000 and PowerPC Options,, RS/6000 and PowerPC Options, gcc,
1609 Using the GNU Compiler Collection (GCC)}.
1610 @end ifnothtml
1611 @ifhtml
1612 see ``RS/6000 and PowerPC Options'' in the main manual.
1613 @end ifhtml
1615 @option{--with-aix-soname} is currently supported by @samp{libgcc_s} only, so
1616 this option is still experimental and not for normal use yet.
1618 Default is the traditional behavior @option{--with-aix-soname=@samp{aix}}.
1620 @item --enable-languages=@var{lang1},@var{lang2},@dots{}
1621 Specify that only a particular subset of compilers and
1622 their runtime libraries should be built.  For a list of valid values for
1623 @var{langN} you can issue the following command in the
1624 @file{gcc} directory of your GCC source tree:@*
1625 @smallexample
1626 grep ^language= */config-lang.in
1627 @end smallexample
1628 Currently, you can use any of the following:
1629 @code{all}, @code{default}, @code{ada}, @code{c}, @code{c++}, @code{fortran},
1630 @code{go}, @code{jit}, @code{lto}, @code{objc}, @code{obj-c++}.
1631 Building the Ada compiler has special requirements, see below.
1632 If you do not pass this flag, or specify the option @code{default}, then the
1633 default languages available in the @file{gcc} sub-tree will be configured.
1634 Ada, Go, Jit, and Objective-C++ are not default languages.  LTO is not a
1635 default language, but is built by default because @option{--enable-lto} is
1636 enabled by default.  The other languages are default languages.  If
1637 @code{all} is specified, then all available languages are built.  An
1638 exception is @code{jit} language, which requires
1639 @option{--enable-host-shared} to be included with @code{all}.
1641 @item --enable-stage1-languages=@var{lang1},@var{lang2},@dots{}
1642 Specify that a particular subset of compilers and their runtime
1643 libraries should be built with the system C compiler during stage 1 of
1644 the bootstrap process, rather than only in later stages with the
1645 bootstrapped C compiler.  The list of valid values is the same as for
1646 @option{--enable-languages}, and the option @code{all} will select all
1647 of the languages enabled by @option{--enable-languages}.  This option is
1648 primarily useful for GCC development; for instance, when a development
1649 version of the compiler cannot bootstrap due to compiler bugs, or when
1650 one is debugging front ends other than the C front end.  When this
1651 option is used, one can then build the target libraries for the
1652 specified languages with the stage-1 compiler by using @command{make
1653 stage1-bubble all-target}, or run the testsuite on the stage-1 compiler
1654 for the specified languages using @command{make stage1-start check-gcc}.
1656 @item --disable-libada
1657 Specify that the run-time libraries and tools used by GNAT should not
1658 be built.  This can be useful for debugging, or for compatibility with
1659 previous Ada build procedures, when it was required to explicitly
1660 do a @samp{make -C gcc gnatlib_and_tools}.
1662 @item --disable-libsanitizer
1663 Specify that the run-time libraries for the various sanitizers should
1664 not be built.
1666 @item --disable-libssp
1667 Specify that the run-time libraries for stack smashing protection
1668 should not be built.
1670 @item --disable-libquadmath
1671 Specify that the GCC quad-precision math library should not be built.
1672 On some systems, the library is required to be linkable when building
1673 the Fortran front end, unless @option{--disable-libquadmath-support}
1674 is used.
1676 @item --disable-libquadmath-support
1677 Specify that the Fortran front end and @code{libgfortran} do not add
1678 support for @code{libquadmath} on systems supporting it.
1680 @item --disable-libgomp
1681 Specify that the GNU Offloading and Multi Processing Runtime Library
1682 should not be built.
1684 @item --disable-libvtv
1685 Specify that the run-time libraries used by vtable verification
1686 should not be built.
1688 @item --with-dwarf2
1689 Specify that the compiler should
1690 use DWARF 2 debugging information as the default.
1692 @item --with-advance-toolchain=@var{at}
1693 On 64-bit PowerPC Linux systems, configure the compiler to use the
1694 header files, library files, and the dynamic linker from the Advance
1695 Toolchain release @var{at} instead of the default versions that are
1696 provided by the Linux distribution.  In general, this option is
1697 intended for the developers of GCC, and it is not intended for general
1698 use.
1700 @item --enable-targets=all
1701 @itemx --enable-targets=@var{target_list}
1702 Some GCC targets, e.g.@: powerpc64-linux, build bi-arch compilers.
1703 These are compilers that are able to generate either 64-bit or 32-bit
1704 code.  Typically, the corresponding 32-bit target, e.g.@:
1705 powerpc-linux for powerpc64-linux, only generates 32-bit code.  This
1706 option enables the 32-bit target to be a bi-arch compiler, which is
1707 useful when you want a bi-arch compiler that defaults to 32-bit, and
1708 you are building a bi-arch or multi-arch binutils in a combined tree.
1709 On mips-linux, this will build a tri-arch compiler (ABI o32/n32/64),
1710 defaulted to o32.
1711 Currently, this option only affects sparc-linux, powerpc-linux, x86-linux,
1712 mips-linux and s390-linux.
1714 @item --enable-default-pie
1715 Turn on @option{-fPIE} and @option{-pie} by default.
1717 @item --enable-secureplt
1718 This option enables @option{-msecure-plt} by default for powerpc-linux.
1719 @ifnothtml
1720 @xref{RS/6000 and PowerPC Options,, RS/6000 and PowerPC Options, gcc,
1721 Using the GNU Compiler Collection (GCC)},
1722 @end ifnothtml
1723 @ifhtml
1724 See ``RS/6000 and PowerPC Options'' in the main manual
1725 @end ifhtml
1727 @item --enable-default-ssp
1728 Turn on @option{-fstack-protector-strong} by default.
1730 @item --enable-cld
1731 This option enables @option{-mcld} by default for 32-bit x86 targets.
1732 @ifnothtml
1733 @xref{i386 and x86-64 Options,, i386 and x86-64 Options, gcc,
1734 Using the GNU Compiler Collection (GCC)},
1735 @end ifnothtml
1736 @ifhtml
1737 See ``i386 and x86-64 Options'' in the main manual
1738 @end ifhtml
1740 @item --enable-win32-registry
1741 @itemx --enable-win32-registry=@var{key}
1742 @itemx --disable-win32-registry
1743 The @option{--enable-win32-registry} option enables Microsoft Windows-hosted GCC
1744 to look up installations paths in the registry using the following key:
1746 @smallexample
1747 @code{HKEY_LOCAL_MACHINE\SOFTWARE\Free Software Foundation\@var{key}}
1748 @end smallexample
1750 @var{key} defaults to GCC version number, and can be overridden by the
1751 @option{--enable-win32-registry=@var{key}} option.  Vendors and distributors
1752 who use custom installers are encouraged to provide a different key,
1753 perhaps one comprised of vendor name and GCC version number, to
1754 avoid conflict with existing installations.  This feature is enabled
1755 by default, and can be disabled by @option{--disable-win32-registry}
1756 option.  This option has no effect on the other hosts.
1758 @item --nfp
1759 Specify that the machine does not have a floating point unit.  This
1760 option only applies to @samp{m68k-sun-sunos@var{n}}.  On any other
1761 system, @option{--nfp} has no effect.
1763 @item --enable-werror
1764 @itemx --disable-werror
1765 @itemx --enable-werror=yes
1766 @itemx --enable-werror=no
1767 When you specify this option, it controls whether certain files in the
1768 compiler are built with @option{-Werror} in bootstrap stage2 and later.
1769 If you don't specify it, @option{-Werror} is turned on for the main
1770 development trunk.  However it defaults to off for release branches and
1771 final releases.  The specific files which get @option{-Werror} are
1772 controlled by the Makefiles.
1774 @item --enable-checking
1775 @itemx --enable-checking=@var{list}
1776 When you specify this option, the compiler is built to perform internal
1777 consistency checks of the requested complexity.  This does not change the
1778 generated code, but adds error checking within the compiler.  This will
1779 slow down the compiler and may only work properly if you are building
1780 the compiler with GCC@.  This is @samp{yes,extra} by default when building
1781 from SVN or snapshots, but @samp{release} for releases.  The default
1782 for building the stage1 compiler is @samp{yes}.  More control
1783 over the checks may be had by specifying @var{list}.  The categories of
1784 checks available are @samp{yes} (most common checks
1785 @samp{assert,misc,tree,gc,rtlflag,runtime}), @samp{no} (no checks at
1786 all), @samp{all} (all but @samp{valgrind}), @samp{release} (cheapest
1787 checks @samp{assert,runtime}) or @samp{none} (same as @samp{no}).
1788 Individual checks can be enabled with these flags @samp{assert},
1789 @samp{df}, @samp{fold}, @samp{gc}, @samp{gcac}, @samp{misc}, @samp{rtl},
1790 @samp{rtlflag}, @samp{runtime}, @samp{tree}, @samp{extra} and @samp{valgrind}.
1791 @samp{extra} adds for @samp{misc} checking extra checks that might affect
1792 code generation and should therefore not differ between stage1 and later
1793 stages.
1795 The @samp{valgrind} check requires the external @command{valgrind}
1796 simulator, available from @uref{http://valgrind.org/}.  The
1797 @samp{df}, @samp{rtl}, @samp{gcac} and @samp{valgrind} checks are very expensive.
1798 To disable all checking, @samp{--disable-checking} or
1799 @samp{--enable-checking=none} must be explicitly requested.  Disabling
1800 assertions will make the compiler and runtime slightly faster but
1801 increase the risk of undetected internal errors causing wrong code to be
1802 generated.
1804 @item --disable-stage1-checking
1805 @itemx --enable-stage1-checking
1806 @itemx --enable-stage1-checking=@var{list}
1807 If no @option{--enable-checking} option is specified the stage1
1808 compiler will be built with @samp{yes} checking enabled, otherwise
1809 the stage1 checking flags are the same as specified by
1810 @option{--enable-checking}.  To build the stage1 compiler with
1811 different checking options use @option{--enable-stage1-checking}.
1812 The list of checking options is the same as for @option{--enable-checking}.
1813 If your system is too slow or too small to bootstrap a released compiler
1814 with checking for stage1 enabled, you can use @samp{--disable-stage1-checking}
1815 to disable checking for the stage1 compiler.
1817 @item --enable-coverage
1818 @itemx --enable-coverage=@var{level}
1819 With this option, the compiler is built to collect self coverage
1820 information, every time it is run.  This is for internal development
1821 purposes, and only works when the compiler is being built with gcc.  The
1822 @var{level} argument controls whether the compiler is built optimized or
1823 not, values are @samp{opt} and @samp{noopt}.  For coverage analysis you
1824 want to disable optimization, for performance analysis you want to
1825 enable optimization.  When coverage is enabled, the default level is
1826 without optimization.
1828 @item --enable-gather-detailed-mem-stats
1829 When this option is specified more detailed information on memory
1830 allocation is gathered.  This information is printed when using
1831 @option{-fmem-report}.
1833 @item --enable-valgrind-annotations
1834 Mark selected memory related operations in the compiler when run under
1835 valgrind to suppress false positives.
1837 @item --enable-nls
1838 @itemx --disable-nls
1839 The @option{--enable-nls} option enables Native Language Support (NLS),
1840 which lets GCC output diagnostics in languages other than American
1841 English.  Native Language Support is enabled by default if not doing a
1842 canadian cross build.  The @option{--disable-nls} option disables NLS@.
1844 @item --with-included-gettext
1845 If NLS is enabled, the @option{--with-included-gettext} option causes the build
1846 procedure to prefer its copy of GNU @command{gettext}.
1848 @item --with-catgets
1849 If NLS is enabled, and if the host lacks @code{gettext} but has the
1850 inferior @code{catgets} interface, the GCC build procedure normally
1851 ignores @code{catgets} and instead uses GCC's copy of the GNU
1852 @code{gettext} library.  The @option{--with-catgets} option causes the
1853 build procedure to use the host's @code{catgets} in this situation.
1855 @item --with-libiconv-prefix=@var{dir}
1856 Search for libiconv header files in @file{@var{dir}/include} and
1857 libiconv library files in @file{@var{dir}/lib}.
1859 @item --enable-obsolete
1860 Enable configuration for an obsoleted system.  If you attempt to
1861 configure GCC for a system (build, host, or target) which has been
1862 obsoleted, and you do not specify this flag, configure will halt with an
1863 error message.
1865 All support for systems which have been obsoleted in one release of GCC
1866 is removed entirely in the next major release, unless someone steps
1867 forward to maintain the port.
1869 @item --enable-decimal-float
1870 @itemx --enable-decimal-float=yes
1871 @itemx --enable-decimal-float=no
1872 @itemx --enable-decimal-float=bid
1873 @itemx --enable-decimal-float=dpd
1874 @itemx --disable-decimal-float
1875 Enable (or disable) support for the C decimal floating point extension
1876 that is in the IEEE 754-2008 standard.  This is enabled by default only
1877 on PowerPC, i386, and x86_64 GNU/Linux systems.  Other systems may also
1878 support it, but require the user to specifically enable it.  You can
1879 optionally control which decimal floating point format is used (either
1880 @samp{bid} or @samp{dpd}).  The @samp{bid} (binary integer decimal)
1881 format is default on i386 and x86_64 systems, and the @samp{dpd}
1882 (densely packed decimal) format is default on PowerPC systems.
1884 @item --enable-fixed-point
1885 @itemx --disable-fixed-point
1886 Enable (or disable) support for C fixed-point arithmetic.
1887 This option is enabled by default for some targets (such as MIPS) which
1888 have hardware-support for fixed-point operations.  On other targets, you
1889 may enable this option manually.
1891 @item --with-long-double-128
1892 Specify if @code{long double} type should be 128-bit by default on selected
1893 GNU/Linux architectures.  If using @code{--without-long-double-128},
1894 @code{long double} will be by default 64-bit, the same as @code{double} type.
1895 When neither of these configure options are used, the default will be
1896 128-bit @code{long double} when built against GNU C Library 2.4 and later,
1897 64-bit @code{long double} otherwise.
1899 @item --enable-fdpic
1900 On SH Linux systems, generate ELF FDPIC code.
1902 @item --with-gmp=@var{pathname}
1903 @itemx --with-gmp-include=@var{pathname}
1904 @itemx --with-gmp-lib=@var{pathname}
1905 @itemx --with-mpfr=@var{pathname}
1906 @itemx --with-mpfr-include=@var{pathname}
1907 @itemx --with-mpfr-lib=@var{pathname}
1908 @itemx --with-mpc=@var{pathname}
1909 @itemx --with-mpc-include=@var{pathname}
1910 @itemx --with-mpc-lib=@var{pathname}
1911 If you want to build GCC but do not have the GMP library, the MPFR
1912 library and/or the MPC library installed in a standard location and
1913 do not have their sources present in the GCC source tree then you
1914 can explicitly specify the directory where they are installed
1915 (@samp{--with-gmp=@var{gmpinstalldir}},
1916 @samp{--with-mpfr=@/@var{mpfrinstalldir}},
1917 @samp{--with-mpc=@/@var{mpcinstalldir}}).  The
1918 @option{--with-gmp=@/@var{gmpinstalldir}} option is shorthand for
1919 @option{--with-gmp-lib=@/@var{gmpinstalldir}/lib} and
1920 @option{--with-gmp-include=@/@var{gmpinstalldir}/include}.  Likewise the
1921 @option{--with-mpfr=@/@var{mpfrinstalldir}} option is shorthand for
1922 @option{--with-mpfr-lib=@/@var{mpfrinstalldir}/lib} and
1923 @option{--with-mpfr-include=@/@var{mpfrinstalldir}/include}, also the
1924 @option{--with-mpc=@/@var{mpcinstalldir}} option is shorthand for
1925 @option{--with-mpc-lib=@/@var{mpcinstalldir}/lib} and
1926 @option{--with-mpc-include=@/@var{mpcinstalldir}/include}.  If these
1927 shorthand assumptions are not correct, you can use the explicit
1928 include and lib options directly.  You might also need to ensure the
1929 shared libraries can be found by the dynamic linker when building and
1930 using GCC, for example by setting the runtime shared library path
1931 variable (@env{LD_LIBRARY_PATH} on GNU/Linux and Solaris systems).
1933 These flags are applicable to the host platform only.  When building
1934 a cross compiler, they will not be used to configure target libraries.
1936 @item --with-isl=@var{pathname}
1937 @itemx --with-isl-include=@var{pathname}
1938 @itemx --with-isl-lib=@var{pathname}
1939 If you do not have the isl library installed in a standard location and you
1940 want to build GCC, you can explicitly specify the directory where it is
1941 installed (@samp{--with-isl=@/@var{islinstalldir}}). The
1942 @option{--with-isl=@/@var{islinstalldir}} option is shorthand for
1943 @option{--with-isl-lib=@/@var{islinstalldir}/lib} and
1944 @option{--with-isl-include=@/@var{islinstalldir}/include}. If this
1945 shorthand assumption is not correct, you can use the explicit
1946 include and lib options directly.
1948 These flags are applicable to the host platform only.  When building
1949 a cross compiler, they will not be used to configure target libraries.
1951 @item --with-stage1-ldflags=@var{flags}
1952 This option may be used to set linker flags to be used when linking
1953 stage 1 of GCC.  These are also used when linking GCC if configured with
1954 @option{--disable-bootstrap}.  If @option{--with-stage1-libs} is not set to a
1955 value, then the default is @samp{-static-libstdc++ -static-libgcc}, if
1956 supported.
1958 @item --with-stage1-libs=@var{libs}
1959 This option may be used to set libraries to be used when linking stage 1
1960 of GCC.  These are also used when linking GCC if configured with
1961 @option{--disable-bootstrap}.
1963 @item --with-boot-ldflags=@var{flags}
1964 This option may be used to set linker flags to be used when linking
1965 stage 2 and later when bootstrapping GCC.  If --with-boot-libs
1966 is not is set to a value, then the default is
1967 @samp{-static-libstdc++ -static-libgcc}.
1969 @item --with-boot-libs=@var{libs}
1970 This option may be used to set libraries to be used when linking stage 2
1971 and later when bootstrapping GCC.
1973 @item --with-debug-prefix-map=@var{map}
1974 Convert source directory names using @option{-fdebug-prefix-map} when
1975 building runtime libraries.  @samp{@var{map}} is a space-separated
1976 list of maps of the form @samp{@var{old}=@var{new}}.
1978 @item --enable-linker-build-id
1979 Tells GCC to pass @option{--build-id} option to the linker for all final
1980 links (links performed without the @option{-r} or @option{--relocatable}
1981 option), if the linker supports it.  If you specify
1982 @option{--enable-linker-build-id}, but your linker does not
1983 support @option{--build-id} option, a warning is issued and the
1984 @option{--enable-linker-build-id} option is ignored.  The default is off.
1986 @item --with-linker-hash-style=@var{choice}
1987 Tells GCC to pass @option{--hash-style=@var{choice}} option to the
1988 linker for all final links. @var{choice} can be one of
1989 @samp{sysv}, @samp{gnu}, and @samp{both} where @samp{sysv} is the default.
1991 @item --enable-gnu-unique-object
1992 @itemx --disable-gnu-unique-object
1993 Tells GCC to use the gnu_unique_object relocation for C++ template
1994 static data members and inline function local statics.  Enabled by
1995 default for a toolchain with an assembler that accepts it and
1996 GLIBC 2.11 or above, otherwise disabled.
1998 @item --with-diagnostics-color=@var{choice}
1999 Tells GCC to use @var{choice} as the default for @option{-fdiagnostics-color=}
2000 option (if not used explicitly on the command line).  @var{choice}
2001 can be one of @samp{never}, @samp{auto}, @samp{always}, and @samp{auto-if-env}
2002 where @samp{auto} is the default.  @samp{auto-if-env} means that
2003 @option{-fdiagnostics-color=auto} will be the default if @code{GCC_COLORS}
2004 is present and non-empty in the environment, and
2005 @option{-fdiagnostics-color=never} otherwise.
2007 @item --enable-lto
2008 @itemx --disable-lto
2009 Enable support for link-time optimization (LTO).  This is enabled by
2010 default, and may be disabled using @option{--disable-lto}.
2012 @item --enable-linker-plugin-configure-flags=FLAGS
2013 @itemx --enable-linker-plugin-flags=FLAGS
2014 By default, linker plugins (such as the LTO plugin) are built for the
2015 host system architecture.  For the case that the linker has a
2016 different (but run-time compatible) architecture, these flags can be
2017 specified to build plugins that are compatible to the linker.  For
2018 example, if you are building GCC for a 64-bit x86_64
2019 (@samp{x86_64-unknown-linux-gnu}) host system, but have a 32-bit x86
2020 GNU/Linux (@samp{i686-pc-linux-gnu}) linker executable (which is
2021 executable on the former system), you can configure GCC as follows for
2022 getting compatible linker plugins:
2024 @smallexample
2025 % @var{srcdir}/configure \
2026     --host=x86_64-unknown-linux-gnu \
2027     --enable-linker-plugin-configure-flags=--host=i686-pc-linux-gnu \
2028     --enable-linker-plugin-flags='CC=gcc\ -m32\ -Wl,-rpath,[...]/i686-pc-linux-gnu/lib'
2029 @end smallexample
2031 @item --with-plugin-ld=@var{pathname}
2032 Enable an alternate linker to be used at link-time optimization (LTO)
2033 link time when @option{-fuse-linker-plugin} is enabled.
2034 This linker should have plugin support such as gold starting with
2035 version 2.20 or GNU ld starting with version 2.21.
2036 See @option{-fuse-linker-plugin} for details.
2038 @item --enable-canonical-system-headers
2039 @itemx --disable-canonical-system-headers
2040 Enable system header path canonicalization for @file{libcpp}.  This can
2041 produce shorter header file paths in diagnostics and dependency output
2042 files, but these changed header paths may conflict with some compilation
2043 environments.  Enabled by default, and may be disabled using
2044 @option{--disable-canonical-system-headers}.
2046 @item --with-glibc-version=@var{major}.@var{minor}
2047 Tell GCC that when the GNU C Library (glibc) is used on the target it
2048 will be version @var{major}.@var{minor} or later.  Normally this can
2049 be detected from the C library's header files, but this option may be
2050 needed when bootstrapping a cross toolchain without the header files
2051 available for building the initial bootstrap compiler.
2053 If GCC is configured with some multilibs that use glibc and some that
2054 do not, this option applies only to the multilibs that use glibc.
2055 However, such configurations may not work well as not all the relevant
2056 configuration in GCC is on a per-multilib basis.
2058 @item --enable-as-accelerator-for=@var{target}
2059 Build as offload target compiler. Specify offload host triple by @var{target}.
2061 @item --enable-offload-targets=@var{target1}[=@var{path1}],@dots{},@var{targetN}[=@var{pathN}]
2062 Enable offloading to targets @var{target1}, @dots{}, @var{targetN}.
2063 Offload compilers are expected to be already installed.  Default search
2064 path for them is @file{@var{exec-prefix}}, but it can be changed by
2065 specifying paths @var{path1}, @dots{}, @var{pathN}.
2067 @smallexample
2068 % @var{srcdir}/configure \
2069     --enable-offload-target=i686-unknown-linux-gnu=/path/to/i686/compiler,x86_64-pc-linux-gnu
2070 @end smallexample
2072 If @samp{hsa} is specified as one of the targets, the compiler will be
2073 built with support for HSA GPU accelerators.  Because the same
2074 compiler will emit the accelerator code, no path should be specified.
2076 @item --with-hsa-runtime=@var{pathname}
2077 @itemx --with-hsa-runtime-include=@var{pathname}
2078 @itemx --with-hsa-runtime-lib=@var{pathname}
2080 If you configure GCC with HSA offloading but do not have the HSA
2081 run-time library installed in a standard location then you can
2082 explicitly specify the directory where they are installed.  The
2083 @option{--with-hsa-runtime=@/@var{hsainstalldir}} option is a
2084 shorthand for
2085 @option{--with-hsa-runtime-lib=@/@var{hsainstalldir}/lib} and
2086 @option{--with-hsa-runtime-include=@/@var{hsainstalldir}/include}.
2087 @end table
2089 @subheading Cross-Compiler-Specific Options
2090 The following options only apply to building cross compilers.
2092 @table @code
2093 @item --with-sysroot
2094 @itemx --with-sysroot=@var{dir}
2095 Tells GCC to consider @var{dir} as the root of a tree that contains
2096 (a subset of) the root filesystem of the target operating system.
2097 Target system headers, libraries and run-time object files will be
2098 searched for in there.  More specifically, this acts as if
2099 @option{--sysroot=@var{dir}} was added to the default options of the built
2100 compiler.  The specified directory is not copied into the
2101 install tree, unlike the options @option{--with-headers} and
2102 @option{--with-libs} that this option obsoletes.  The default value,
2103 in case @option{--with-sysroot} is not given an argument, is
2104 @option{$@{gcc_tooldir@}/sys-root}.  If the specified directory is a
2105 subdirectory of @option{$@{exec_prefix@}}, then it will be found relative to
2106 the GCC binaries if the installation tree is moved.
2108 This option affects the system root for the compiler used to build
2109 target libraries (which runs on the build system) and the compiler newly
2110 installed with @code{make install}; it does not affect the compiler which is
2111 used to build GCC itself.
2113 If you specify the @option{--with-native-system-header-dir=@var{dirname}}
2114 option then the compiler will search that directory within @var{dirname} for
2115 native system headers rather than the default @file{/usr/include}.
2117 @item --with-build-sysroot
2118 @itemx --with-build-sysroot=@var{dir}
2119 Tells GCC to consider @var{dir} as the system root (see
2120 @option{--with-sysroot}) while building target libraries, instead of
2121 the directory specified with @option{--with-sysroot}.  This option is
2122 only useful when you are already using @option{--with-sysroot}.  You
2123 can use @option{--with-build-sysroot} when you are configuring with
2124 @option{--prefix} set to a directory that is different from the one in
2125 which you are installing GCC and your target libraries.
2127 This option affects the system root for the compiler used to build
2128 target libraries (which runs on the build system); it does not affect
2129 the compiler which is used to build GCC itself.
2131 If you specify the @option{--with-native-system-header-dir=@var{dirname}}
2132 option then the compiler will search that directory within @var{dirname} for
2133 native system headers rather than the default @file{/usr/include}.
2135 @item --with-headers
2136 @itemx --with-headers=@var{dir}
2137 Deprecated in favor of @option{--with-sysroot}.
2138 Specifies that target headers are available when building a cross compiler.
2139 The @var{dir} argument specifies a directory which has the target include
2140 files.  These include files will be copied into the @file{gcc} install
2141 directory.  @emph{This option with the @var{dir} argument is required} when
2142 building a cross compiler, if @file{@var{prefix}/@var{target}/sys-include}
2143 doesn't pre-exist.  If @file{@var{prefix}/@var{target}/sys-include} does
2144 pre-exist, the @var{dir} argument may be omitted.  @command{fixincludes}
2145 will be run on these files to make them compatible with GCC@.
2147 @item --without-headers
2148 Tells GCC not use any target headers from a libc when building a cross
2149 compiler.  When crossing to GNU/Linux, you need the headers so GCC
2150 can build the exception handling for libgcc.
2152 @item --with-libs
2153 @itemx --with-libs="@var{dir1} @var{dir2} @dots{} @var{dirN}"
2154 Deprecated in favor of @option{--with-sysroot}.
2155 Specifies a list of directories which contain the target runtime
2156 libraries.  These libraries will be copied into the @file{gcc} install
2157 directory.  If the directory list is omitted, this option has no
2158 effect.
2160 @item --with-newlib
2161 Specifies that @samp{newlib} is
2162 being used as the target C library.  This causes @code{__eprintf} to be
2163 omitted from @file{libgcc.a} on the assumption that it will be provided by
2164 @samp{newlib}.
2166 @item --with-avrlibc
2167 Specifies that @samp{AVR-Libc} is
2168 being used as the target C library.  This causes float support
2169 functions like @code{__addsf3} to be omitted from @file{libgcc.a} on
2170 the assumption that it will be provided by @file{libm.a}.  For more
2171 technical details, cf. @uref{http://gcc.gnu.org/PR54461,,PR54461}.
2172 This option is only supported for the AVR target.  It is not supported for
2173 RTEMS configurations, which currently use newlib.  The option is
2174 supported since version 4.7.2 and is the default in 4.8.0 and newer.
2176 @item --with-nds32-lib=@var{library}
2177 Specifies that @var{library} setting is used for building @file{libgcc.a}.
2178 Currently, the valid @var{library} is @samp{newlib} or @samp{mculib}.
2179 This option is only supported for the NDS32 target.
2181 @item --with-build-time-tools=@var{dir}
2182 Specifies where to find the set of target tools (assembler, linker, etc.)
2183 that will be used while building GCC itself.  This option can be useful
2184 if the directory layouts are different between the system you are building
2185 GCC on, and the system where you will deploy it.
2187 For example, on an @samp{ia64-hp-hpux} system, you may have the GNU
2188 assembler and linker in @file{/usr/bin}, and the native tools in a
2189 different path, and build a toolchain that expects to find the
2190 native tools in @file{/usr/bin}.
2192 When you use this option, you should ensure that @var{dir} includes
2193 @command{ar}, @command{as}, @command{ld}, @command{nm},
2194 @command{ranlib} and @command{strip} if necessary, and possibly
2195 @command{objdump}.  Otherwise, GCC may use an inconsistent set of
2196 tools.
2197 @end table
2199 @subsubheading Overriding @command{configure} test results
2201 Sometimes, it might be necessary to override the result of some
2202 @command{configure} test, for example in order to ease porting to a new
2203 system or work around a bug in a test.  The toplevel @command{configure}
2204 script provides three variables for this:
2206 @table @code
2208 @item build_configargs
2209 @cindex @code{build_configargs}
2210 The contents of this variable is passed to all build @command{configure}
2211 scripts.
2213 @item host_configargs
2214 @cindex @code{host_configargs}
2215 The contents of this variable is passed to all host @command{configure}
2216 scripts.
2218 @item target_configargs
2219 @cindex @code{target_configargs}
2220 The contents of this variable is passed to all target @command{configure}
2221 scripts.
2223 @end table
2225 In order to avoid shell and @command{make} quoting issues for complex
2226 overrides, you can pass a setting for @env{CONFIG_SITE} and set
2227 variables in the site file.
2229 @subheading Objective-C-Specific Options
2231 The following options apply to the build of the Objective-C runtime library.
2233 @table @code
2234 @item --enable-objc-gc
2235 Specify that an additional variant of the GNU Objective-C runtime library
2236 is built, using an external build of the Boehm-Demers-Weiser garbage
2237 collector (@uref{http://www.hboehm.info/gc/}).  This library needs to be
2238 available for each multilib variant, unless configured with
2239 @option{--enable-objc-gc=@samp{auto}} in which case the build of the
2240 additional runtime library is skipped when not available and the build
2241 continues.
2243 @item --with-target-bdw-gc=@var{list}
2244 @itemx --with-target-bdw-gc-include=@var{list}
2245 @itemx --with-target-bdw-gc-lib=@var{list}
2246 Specify search directories for the garbage collector header files and
2247 libraries. @var{list} is a comma separated list of key value pairs of the
2248 form @samp{@var{multilibdir}=@var{path}}, where the default multilib key
2249 is named as @samp{.} (dot), or is omitted (e.g.
2250 @samp{--with-target-bdw-gc=/opt/bdw-gc,32=/opt-bdw-gc32}).
2252 The options @option{--with-target-bdw-gc-include} and
2253 @option{--with-target-bdw-gc-lib} must always be specified together
2254 for each multilib variant and they take precedence over
2255 @option{--with-target-bdw-gc}.  If @option{--with-target-bdw-gc-include}
2256 is missing values for a multilib, then the value for the default
2257 multilib is used (e.g. @samp{--with-target-bdw-gc-include=/opt/bdw-gc/include}
2258 @samp{--with-target-bdw-gc-lib=/opt/bdw-gc/lib64,32=/opt-bdw-gc/lib32}).
2259 If none of these options are specified, the library is assumed in
2260 default locations.
2261 @end table
2263 @html
2264 <hr />
2266 @end html
2267 @ifhtml
2268 @uref{./index.html,,Return to the GCC Installation page}
2269 @end ifhtml
2270 @end ifset
2272 @c ***Building****************************************************************
2273 @ifnothtml
2274 @comment node-name,     next,          previous, up
2275 @node    Building, Testing, Configuration, Installing GCC
2276 @end ifnothtml
2277 @ifset buildhtml
2278 @ifnothtml
2279 @chapter Building
2280 @end ifnothtml
2281 @cindex Installing GCC: Building
2283 Now that GCC is configured, you are ready to build the compiler and
2284 runtime libraries.
2286 Some commands executed when making the compiler may fail (return a
2287 nonzero status) and be ignored by @command{make}.  These failures, which
2288 are often due to files that were not found, are expected, and can safely
2289 be ignored.
2291 It is normal to have compiler warnings when compiling certain files.
2292 Unless you are a GCC developer, you can generally ignore these warnings
2293 unless they cause compilation to fail.  Developers should attempt to fix
2294 any warnings encountered, however they can temporarily continue past
2295 warnings-as-errors by specifying the configure flag
2296 @option{--disable-werror}.
2298 On certain old systems, defining certain environment variables such as
2299 @env{CC} can interfere with the functioning of @command{make}.
2301 If you encounter seemingly strange errors when trying to build the
2302 compiler in a directory other than the source directory, it could be
2303 because you have previously configured the compiler in the source
2304 directory.  Make sure you have done all the necessary preparations.
2306 If you build GCC on a BSD system using a directory stored in an old System
2307 V file system, problems may occur in running @command{fixincludes} if the
2308 System V file system doesn't support symbolic links.  These problems
2309 result in a failure to fix the declaration of @code{size_t} in
2310 @file{sys/types.h}.  If you find that @code{size_t} is a signed type and
2311 that type mismatches occur, this could be the cause.
2313 The solution is not to use such a directory for building GCC@.
2315 Similarly, when building from SVN or snapshots, or if you modify
2316 @file{*.l} files, you need the Flex lexical analyzer generator
2317 installed.  If you do not modify @file{*.l} files, releases contain
2318 the Flex-generated files and you do not need Flex installed to build
2319 them.  There is still one Flex-based lexical analyzer (part of the
2320 build machinery, not of GCC itself) that is used even if you only
2321 build the C front end.
2323 When building from SVN or snapshots, or if you modify Texinfo
2324 documentation, you need version 4.7 or later of Texinfo installed if you
2325 want Info documentation to be regenerated.  Releases contain Info
2326 documentation pre-built for the unmodified documentation in the release.
2328 @section Building a native compiler
2330 For a native build, the default configuration is to perform
2331 a 3-stage bootstrap of the compiler when @samp{make} is invoked.
2332 This will build the entire GCC system and ensure that it compiles
2333 itself correctly.  It can be disabled with the @option{--disable-bootstrap}
2334 parameter to @samp{configure}, but bootstrapping is suggested because
2335 the compiler will be tested more completely and could also have
2336 better performance.
2338 The bootstrapping process will complete the following steps:
2340 @itemize @bullet
2341 @item
2342 Build tools necessary to build the compiler.
2344 @item
2345 Perform a 3-stage bootstrap of the compiler.  This includes building
2346 three times the target tools for use by the compiler such as binutils
2347 (bfd, binutils, gas, gprof, ld, and opcodes) if they have been
2348 individually linked or moved into the top level GCC source tree before
2349 configuring.
2351 @item
2352 Perform a comparison test of the stage2 and stage3 compilers.
2354 @item
2355 Build runtime libraries using the stage3 compiler from the previous step.
2357 @end itemize
2359 If you are short on disk space you might consider @samp{make
2360 bootstrap-lean} instead.  The sequence of compilation is the
2361 same described above, but object files from the stage1 and
2362 stage2 of the 3-stage bootstrap of the compiler are deleted as
2363 soon as they are no longer needed.
2365 If you wish to use non-default GCC flags when compiling the stage2
2366 and stage3 compilers, set @code{BOOT_CFLAGS} on the command line when
2367 doing @samp{make}.  For example, if you want to save additional space
2368 during the bootstrap and in the final installation as well, you can
2369 build the compiler binaries without debugging information as in the
2370 following example.  This will save roughly 40% of disk space both for
2371 the bootstrap and the final installation.  (Libraries will still contain
2372 debugging information.)
2374 @smallexample
2375 make BOOT_CFLAGS='-O' bootstrap
2376 @end smallexample
2378 You can place non-default optimization flags into @code{BOOT_CFLAGS}; they
2379 are less well tested here than the default of @samp{-g -O2}, but should
2380 still work.  In a few cases, you may find that you need to specify special
2381 flags such as @option{-msoft-float} here to complete the bootstrap; or,
2382 if the native compiler miscompiles the stage1 compiler, you may need
2383 to work around this, by choosing @code{BOOT_CFLAGS} to avoid the parts
2384 of the stage1 compiler that were miscompiled, or by using @samp{make
2385 bootstrap4} to increase the number of stages of bootstrap.
2387 @code{BOOT_CFLAGS} does not apply to bootstrapped target libraries.
2388 Since these are always compiled with the compiler currently being
2389 bootstrapped, you can use @code{CFLAGS_FOR_TARGET} to modify their
2390 compilation flags, as for non-bootstrapped target libraries.
2391 Again, if the native compiler miscompiles the stage1 compiler, you may
2392 need to work around this by avoiding non-working parts of the stage1
2393 compiler.  Use @code{STAGE1_TFLAGS} to this end.
2395 If you used the flag @option{--enable-languages=@dots{}} to restrict
2396 the compilers to be built, only those you've actually enabled will be
2397 built.  This will of course only build those runtime libraries, for
2398 which the particular compiler has been built.  Please note,
2399 that re-defining @env{LANGUAGES} when calling @samp{make}
2400 @strong{does not} work anymore!
2402 If the comparison of stage2 and stage3 fails, this normally indicates
2403 that the stage2 compiler has compiled GCC incorrectly, and is therefore
2404 a potentially serious bug which you should investigate and report.  (On
2405 a few systems, meaningful comparison of object files is impossible; they
2406 always appear ``different''.  If you encounter this problem, you will
2407 need to disable comparison in the @file{Makefile}.)
2409 If you do not want to bootstrap your compiler, you can configure with
2410 @option{--disable-bootstrap}.  In particular cases, you may want to
2411 bootstrap your compiler even if the target system is not the same as
2412 the one you are building on: for example, you could build a
2413 @code{powerpc-unknown-linux-gnu} toolchain on a
2414 @code{powerpc64-unknown-linux-gnu} host.  In this case, pass
2415 @option{--enable-bootstrap} to the configure script.
2417 @code{BUILD_CONFIG} can be used to bring in additional customization
2418 to the build.  It can be set to a whitespace-separated list of names.
2419 For each such @code{NAME}, top-level @file{config/@code{NAME}.mk} will
2420 be included by the top-level @file{Makefile}, bringing in any settings
2421 it contains.  The default @code{BUILD_CONFIG} can be set using the
2422 configure option @option{--with-build-config=@code{NAME}...}.  Some
2423 examples of supported build configurations are:
2425 @table @asis
2426 @item @samp{bootstrap-O1}
2427 Removes any @option{-O}-started option from @code{BOOT_CFLAGS}, and adds
2428 @option{-O1} to it.  @samp{BUILD_CONFIG=bootstrap-O1} is equivalent to
2429 @samp{BOOT_CFLAGS='-g -O1'}.
2431 @item @samp{bootstrap-O3}
2432 Analogous to @code{bootstrap-O1}.
2434 @item @samp{bootstrap-lto}
2435 Enables Link-Time Optimization for host tools during bootstrapping.
2436 @samp{BUILD_CONFIG=bootstrap-lto} is equivalent to adding
2437 @option{-flto} to @samp{BOOT_CFLAGS}.  This option assumes that the host
2438 supports the linker plugin (e.g. GNU ld version 2.21 or later or GNU gold
2439 version 2.21 or later).
2441 @item @samp{bootstrap-lto-noplugin}
2442 This option is similar to @code{bootstrap-lto}, but is intended for
2443 hosts that do not support the linker plugin.  Without the linker plugin 
2444 static libraries are not compiled with link-time optimizations.  Since 
2445 the GCC middle end and back end are in @file{libbackend.a} this means
2446 that only the front end is actually LTO optimized.
2448 @item @samp{bootstrap-debug}
2449 Verifies that the compiler generates the same executable code, whether
2450 or not it is asked to emit debug information.  To this end, this
2451 option builds stage2 host programs without debug information, and uses
2452 @file{contrib/compare-debug} to compare them with the stripped stage3
2453 object files.  If @code{BOOT_CFLAGS} is overridden so as to not enable
2454 debug information, stage2 will have it, and stage3 won't.  This option
2455 is enabled by default when GCC bootstrapping is enabled, if
2456 @code{strip} can turn object files compiled with and without debug
2457 info into identical object files.  In addition to better test
2458 coverage, this option makes default bootstraps faster and leaner.
2460 @item @samp{bootstrap-debug-big}
2461 Rather than comparing stripped object files, as in
2462 @code{bootstrap-debug}, this option saves internal compiler dumps
2463 during stage2 and stage3 and compares them as well, which helps catch
2464 additional potential problems, but at a great cost in terms of disk
2465 space.  It can be specified in addition to @samp{bootstrap-debug}.
2467 @item @samp{bootstrap-debug-lean}
2468 This option saves disk space compared with @code{bootstrap-debug-big},
2469 but at the expense of some recompilation.  Instead of saving the dumps
2470 of stage2 and stage3 until the final compare, it uses
2471 @option{-fcompare-debug} to generate, compare and remove the dumps
2472 during stage3, repeating the compilation that already took place in
2473 stage2, whose dumps were not saved.
2475 @item @samp{bootstrap-debug-lib}
2476 This option tests executable code invariance over debug information
2477 generation on target libraries, just like @code{bootstrap-debug-lean}
2478 tests it on host programs.  It builds stage3 libraries with
2479 @option{-fcompare-debug}, and it can be used along with any of the
2480 @code{bootstrap-debug} options above.
2482 There aren't @code{-lean} or @code{-big} counterparts to this option
2483 because most libraries are only build in stage3, so bootstrap compares
2484 would not get significant coverage.  Moreover, the few libraries built
2485 in stage2 are used in stage3 host programs, so we wouldn't want to
2486 compile stage2 libraries with different options for comparison purposes.
2488 @item @samp{bootstrap-debug-ckovw}
2489 Arranges for error messages to be issued if the compiler built on any
2490 stage is run without the option @option{-fcompare-debug}.  This is
2491 useful to verify the full @option{-fcompare-debug} testing coverage.  It
2492 must be used along with @code{bootstrap-debug-lean} and
2493 @code{bootstrap-debug-lib}.
2495 @item @samp{bootstrap-time}
2496 Arranges for the run time of each program started by the GCC driver,
2497 built in any stage, to be logged to @file{time.log}, in the top level of
2498 the build tree.
2500 @end table
2502 @section Building a cross compiler
2504 When building a cross compiler, it is not generally possible to do a
2505 3-stage bootstrap of the compiler.  This makes for an interesting problem
2506 as parts of GCC can only be built with GCC@.
2508 To build a cross compiler, we recommend first building and installing a
2509 native compiler.  You can then use the native GCC compiler to build the
2510 cross compiler.  The installed native compiler needs to be GCC version
2511 2.95 or later.
2513 Assuming you have already installed a native copy of GCC and configured
2514 your cross compiler, issue the command @command{make}, which performs the
2515 following steps:
2517 @itemize @bullet
2518 @item
2519 Build host tools necessary to build the compiler.
2521 @item
2522 Build target tools for use by the compiler such as binutils (bfd,
2523 binutils, gas, gprof, ld, and opcodes)
2524 if they have been individually linked or moved into the top level GCC source
2525 tree before configuring.
2527 @item
2528 Build the compiler (single stage only).
2530 @item
2531 Build runtime libraries using the compiler from the previous step.
2532 @end itemize
2534 Note that if an error occurs in any step the make process will exit.
2536 If you are not building GNU binutils in the same source tree as GCC,
2537 you will need a cross-assembler and cross-linker installed before
2538 configuring GCC@.  Put them in the directory
2539 @file{@var{prefix}/@var{target}/bin}.  Here is a table of the tools
2540 you should put in this directory:
2542 @table @file
2543 @item as
2544 This should be the cross-assembler.
2546 @item ld
2547 This should be the cross-linker.
2549 @item ar
2550 This should be the cross-archiver: a program which can manipulate
2551 archive files (linker libraries) in the target machine's format.
2553 @item ranlib
2554 This should be a program to construct a symbol table in an archive file.
2555 @end table
2557 The installation of GCC will find these programs in that directory,
2558 and copy or link them to the proper place to for the cross-compiler to
2559 find them when run later.
2561 The easiest way to provide these files is to build the Binutils package.
2562 Configure it with the same @option{--host} and @option{--target}
2563 options that you use for configuring GCC, then build and install
2564 them.  They install their executables automatically into the proper
2565 directory.  Alas, they do not support all the targets that GCC
2566 supports.
2568 If you are not building a C library in the same source tree as GCC,
2569 you should also provide the target libraries and headers before
2570 configuring GCC, specifying the directories with
2571 @option{--with-sysroot} or @option{--with-headers} and
2572 @option{--with-libs}.  Many targets also require ``start files'' such
2573 as @file{crt0.o} and
2574 @file{crtn.o} which are linked into each executable.  There may be several
2575 alternatives for @file{crt0.o}, for use with profiling or other
2576 compilation options.  Check your target's definition of
2577 @code{STARTFILE_SPEC} to find out what start files it uses.
2579 @section Building in parallel
2581 GNU Make 3.80 and above, which is necessary to build GCC, support
2582 building in parallel.  To activate this, you can use @samp{make -j 2}
2583 instead of @samp{make}.  You can also specify a bigger number, and
2584 in most cases using a value greater than the number of processors in
2585 your machine will result in fewer and shorter I/O latency hits, thus
2586 improving overall throughput; this is especially true for slow drives
2587 and network filesystems.
2589 @section Building the Ada compiler
2591 In order to build GNAT, the Ada compiler, you need a working GNAT
2592 compiler (GCC version 4.0 or later).
2593 This includes GNAT tools such as @command{gnatmake} and
2594 @command{gnatlink}, since the Ada front end is written in Ada and
2595 uses some GNAT-specific extensions.
2597 In order to build a cross compiler, it is suggested to install
2598 the new compiler as native first, and then use it to build the cross
2599 compiler.
2601 @command{configure} does not test whether the GNAT installation works
2602 and has a sufficiently recent version; if too old a GNAT version is
2603 installed, the build will fail unless @option{--enable-languages} is
2604 used to disable building the Ada front end.
2606 @env{ADA_INCLUDE_PATH} and @env{ADA_OBJECT_PATH} environment variables
2607 must not be set when building the Ada compiler, the Ada tools, or the
2608 Ada runtime libraries. You can check that your build environment is clean
2609 by verifying that @samp{gnatls -v} lists only one explicit path in each
2610 section.
2612 @section Building with profile feedback
2614 It is possible to use profile feedback to optimize the compiler itself.  This
2615 should result in a faster compiler binary.  Experiments done on x86 using gcc
2616 3.3 showed approximately 7 percent speedup on compiling C programs.  To
2617 bootstrap the compiler with profile feedback, use @code{make profiledbootstrap}.
2619 When @samp{make profiledbootstrap} is run, it will first build a @code{stage1}
2620 compiler.  This compiler is used to build a @code{stageprofile} compiler
2621 instrumented to collect execution counts of instruction and branch
2622 probabilities.  Training run is done by building @code{stagetrain}
2623 compiler.  Finally a @code{stagefeedback} compiler is built
2624 using the information collected.
2626 Unlike standard bootstrap, several additional restrictions apply.  The
2627 compiler used to build @code{stage1} needs to support a 64-bit integral type.
2628 It is recommended to only use GCC for this.
2630 On Linux/x86_64 hosts with some restrictions (no virtualization) it is
2631 also possible to do autofdo build with @samp{make
2632 autoprofiledback}. This uses Linux perf to sample branches in the
2633 binary and then rebuild it with feedback derived from the profile.
2634 Linux perf and the @code{autofdo} toolkit needs to be installed for
2635 this.
2637 Only the profile from the current build is used, so when an error
2638 occurs it is recommended to clean before restarting. Otherwise
2639 the code quality may be much worse.
2641 @html
2642 <hr />
2644 @end html
2645 @ifhtml
2646 @uref{./index.html,,Return to the GCC Installation page}
2647 @end ifhtml
2648 @end ifset
2650 @c ***Testing*****************************************************************
2651 @ifnothtml
2652 @comment node-name,     next,          previous, up
2653 @node    Testing, Final install, Building, Installing GCC
2654 @end ifnothtml
2655 @ifset testhtml
2656 @ifnothtml
2657 @chapter Installing GCC: Testing
2658 @end ifnothtml
2659 @cindex Testing
2660 @cindex Installing GCC: Testing
2661 @cindex Testsuite
2663 Before you install GCC, we encourage you to run the testsuites and to
2664 compare your results with results from a similar configuration that have
2665 been submitted to the
2666 @uref{http://gcc.gnu.org/ml/gcc-testresults/,,gcc-testresults mailing list}.
2667 Some of these archived results are linked from the build status lists
2668 at @uref{http://gcc.gnu.org/buildstat.html}, although not everyone who
2669 reports a successful build runs the testsuites and submits the results.
2670 This step is optional and may require you to download additional software,
2671 but it can give you confidence in your new GCC installation or point out
2672 problems before you install and start using your new GCC@.
2674 First, you must have @uref{download.html,,downloaded the testsuites}.
2675 These are part of the full distribution, but if you downloaded the
2676 ``core'' compiler plus any front ends, you must download the testsuites
2677 separately.
2679 Second, you must have the testing tools installed.  This includes
2680 @uref{http://www.gnu.org/software/dejagnu/,,DejaGnu}, Tcl, and Expect;
2681 the DejaGnu site has links to these. For running the BRIG frontend
2682 tests, a tool to assemble the binary BRIGs from HSAIL text,
2683 @uref{https://github.com/HSAFoundation/HSAIL-Tools/,,HSAILasm} must
2684 be installed.
2686 If the directories where @command{runtest} and @command{expect} were
2687 installed are not in the @env{PATH}, you may need to set the following
2688 environment variables appropriately, as in the following example (which
2689 assumes that DejaGnu has been installed under @file{/usr/local}):
2691 @smallexample
2692 TCL_LIBRARY = /usr/local/share/tcl8.0
2693 DEJAGNULIBS = /usr/local/share/dejagnu
2694 @end smallexample
2696 (On systems such as Cygwin, these paths are required to be actual
2697 paths, not mounts or links; presumably this is due to some lack of
2698 portability in the DejaGnu code.)
2701 Finally, you can run the testsuite (which may take a long time):
2702 @smallexample
2703 cd @var{objdir}; make -k check
2704 @end smallexample
2706 This will test various components of GCC, such as compiler
2707 front ends and runtime libraries.  While running the testsuite, DejaGnu
2708 might emit some harmless messages resembling
2709 @samp{WARNING: Couldn't find the global config file.} or
2710 @samp{WARNING: Couldn't find tool init file} that can be ignored.
2712 If you are testing a cross-compiler, you may want to run the testsuite
2713 on a simulator as described at @uref{http://gcc.gnu.org/simtest-howto.html}.
2715 @section How can you run the testsuite on selected tests?
2717 In order to run sets of tests selectively, there are targets
2718 @samp{make check-gcc} and language specific @samp{make check-c},
2719 @samp{make check-c++}, @samp{make check-fortran},
2720 @samp{make check-ada}, @samp{make check-objc}, @samp{make check-obj-c++},
2721 @samp{make check-lto}
2722 in the @file{gcc} subdirectory of the object directory.  You can also
2723 just run @samp{make check} in a subdirectory of the object directory.
2726 A more selective way to just run all @command{gcc} execute tests in the
2727 testsuite is to use
2729 @smallexample
2730 make check-gcc RUNTESTFLAGS="execute.exp @var{other-options}"
2731 @end smallexample
2733 Likewise, in order to run only the @command{g++} ``old-deja'' tests in
2734 the testsuite with filenames matching @samp{9805*}, you would use
2736 @smallexample
2737 make check-g++ RUNTESTFLAGS="old-deja.exp=9805* @var{other-options}"
2738 @end smallexample
2740 The file-matching expression following @var{filename}@command{.exp=} is treated
2741 as a series of whitespace-delimited glob expressions so that multiple patterns
2742 may be passed, although any whitespace must either be escaped or surrounded by
2743 single quotes if multiple expressions are desired. For example,
2745 @smallexample
2746 make check-g++ RUNTESTFLAGS="old-deja.exp=9805*\ virtual2.c @var{other-options}"
2747 make check-g++ RUNTESTFLAGS="'old-deja.exp=9805* virtual2.c' @var{other-options}"
2748 @end smallexample
2750 The @file{*.exp} files are located in the testsuite directories of the GCC
2751 source, the most important ones being @file{compile.exp},
2752 @file{execute.exp}, @file{dg.exp} and @file{old-deja.exp}.
2753 To get a list of the possible @file{*.exp} files, pipe the
2754 output of @samp{make check} into a file and look at the
2755 @samp{Running @dots{}  .exp} lines.
2757 @section Passing options and running multiple testsuites
2759 You can pass multiple options to the testsuite using the
2760 @samp{--target_board} option of DejaGNU, either passed as part of
2761 @samp{RUNTESTFLAGS}, or directly to @command{runtest} if you prefer to
2762 work outside the makefiles.  For example,
2764 @smallexample
2765 make check-g++ RUNTESTFLAGS="--target_board=unix/-O3/-fmerge-constants"
2766 @end smallexample
2768 will run the standard @command{g++} testsuites (``unix'' is the target name
2769 for a standard native testsuite situation), passing
2770 @samp{-O3 -fmerge-constants} to the compiler on every test, i.e.,
2771 slashes separate options.
2773 You can run the testsuites multiple times using combinations of options
2774 with a syntax similar to the brace expansion of popular shells:
2776 @smallexample
2777 @dots{}"--target_board=arm-sim\@{-mhard-float,-msoft-float\@}\@{-O1,-O2,-O3,\@}"
2778 @end smallexample
2780 (Note the empty option caused by the trailing comma in the final group.)
2781 The following will run each testsuite eight times using the @samp{arm-sim}
2782 target, as if you had specified all possible combinations yourself:
2784 @smallexample
2785 --target_board='arm-sim/-mhard-float/-O1 \
2786                 arm-sim/-mhard-float/-O2 \
2787                 arm-sim/-mhard-float/-O3 \
2788                 arm-sim/-mhard-float \
2789                 arm-sim/-msoft-float/-O1 \
2790                 arm-sim/-msoft-float/-O2 \
2791                 arm-sim/-msoft-float/-O3 \
2792                 arm-sim/-msoft-float'
2793 @end smallexample
2795 They can be combined as many times as you wish, in arbitrary ways.  This
2796 list:
2798 @smallexample
2799 @dots{}"--target_board=unix/-Wextra\@{-O3,-fno-strength\@}\@{-fomit-frame,\@}"
2800 @end smallexample
2802 will generate four combinations, all involving @samp{-Wextra}.
2804 The disadvantage to this method is that the testsuites are run in serial,
2805 which is a waste on multiprocessor systems.  For users with GNU Make and
2806 a shell which performs brace expansion, you can run the testsuites in
2807 parallel by having the shell perform the combinations and @command{make}
2808 do the parallel runs.  Instead of using @samp{--target_board}, use a
2809 special makefile target:
2811 @smallexample
2812 make -j@var{N} check-@var{testsuite}//@var{test-target}/@var{option1}/@var{option2}/@dots{}
2813 @end smallexample
2815 For example,
2817 @smallexample
2818 make -j3 check-gcc//sh-hms-sim/@{-m1,-m2,-m3,-m3e,-m4@}/@{,-nofpu@}
2819 @end smallexample
2821 will run three concurrent ``make-gcc'' testsuites, eventually testing all
2822 ten combinations as described above.  Note that this is currently only
2823 supported in the @file{gcc} subdirectory.  (To see how this works, try
2824 typing @command{echo} before the example given here.)
2827 @section How to interpret test results
2829 The result of running the testsuite are various @file{*.sum} and @file{*.log}
2830 files in the testsuite subdirectories.  The @file{*.log} files contain a
2831 detailed log of the compiler invocations and the corresponding
2832 results, the @file{*.sum} files summarize the results.  These summaries
2833 contain status codes for all tests:
2835 @itemize @bullet
2836 @item
2837 PASS: the test passed as expected
2838 @item
2839 XPASS: the test unexpectedly passed
2840 @item
2841 FAIL: the test unexpectedly failed
2842 @item
2843 XFAIL: the test failed as expected
2844 @item
2845 UNSUPPORTED: the test is not supported on this platform
2846 @item
2847 ERROR: the testsuite detected an error
2848 @item
2849 WARNING: the testsuite detected a possible problem
2850 @end itemize
2852 It is normal for some tests to report unexpected failures.  At the
2853 current time the testing harness does not allow fine grained control
2854 over whether or not a test is expected to fail.  This problem should
2855 be fixed in future releases.
2858 @section Submitting test results
2860 If you want to report the results to the GCC project, use the
2861 @file{contrib/test_summary} shell script.  Start it in the @var{objdir} with
2863 @smallexample
2864 @var{srcdir}/contrib/test_summary -p your_commentary.txt \
2865     -m gcc-testresults@@gcc.gnu.org |sh
2866 @end smallexample
2868 This script uses the @command{Mail} program to send the results, so
2869 make sure it is in your @env{PATH}.  The file @file{your_commentary.txt} is
2870 prepended to the testsuite summary and should contain any special
2871 remarks you have on your results or your build environment.  Please
2872 do not edit the testsuite result block or the subject line, as these
2873 messages may be automatically processed.
2875 @html
2876 <hr />
2878 @end html
2879 @ifhtml
2880 @uref{./index.html,,Return to the GCC Installation page}
2881 @end ifhtml
2882 @end ifset
2884 @c ***Final install***********************************************************
2885 @ifnothtml
2886 @comment node-name,     next,          previous, up
2887 @node    Final install, , Testing, Installing GCC
2888 @end ifnothtml
2889 @ifset finalinstallhtml
2890 @ifnothtml
2891 @chapter Installing GCC: Final installation
2892 @end ifnothtml
2894 Now that GCC has been built (and optionally tested), you can install it with
2895 @smallexample
2896 cd @var{objdir} && make install
2897 @end smallexample
2899 We strongly recommend to install into a target directory where there is
2900 no previous version of GCC present.  Also, the GNAT runtime should not
2901 be stripped, as this would break certain features of the debugger that
2902 depend on this debugging information (catching Ada exceptions for
2903 instance).
2905 That step completes the installation of GCC; user level binaries can
2906 be found in @file{@var{prefix}/bin} where @var{prefix} is the value
2907 you specified with the @option{--prefix} to configure (or
2908 @file{/usr/local} by default).  (If you specified @option{--bindir},
2909 that directory will be used instead; otherwise, if you specified
2910 @option{--exec-prefix}, @file{@var{exec-prefix}/bin} will be used.)
2911 Headers for the C++ library are installed in
2912 @file{@var{prefix}/include}; libraries in @file{@var{libdir}}
2913 (normally @file{@var{prefix}/lib}); internal parts of the compiler in
2914 @file{@var{libdir}/gcc} and @file{@var{libexecdir}/gcc}; documentation
2915 in info format in @file{@var{infodir}} (normally
2916 @file{@var{prefix}/info}).
2918 When installing cross-compilers, GCC's executables
2919 are not only installed into @file{@var{bindir}}, that
2920 is, @file{@var{exec-prefix}/bin}, but additionally into
2921 @file{@var{exec-prefix}/@var{target-alias}/bin}, if that directory
2922 exists.  Typically, such @dfn{tooldirs} hold target-specific
2923 binutils, including assembler and linker.
2925 Installation into a temporary staging area or into a @command{chroot}
2926 jail can be achieved with the command
2928 @smallexample
2929 make DESTDIR=@var{path-to-rootdir} install
2930 @end smallexample
2932 @noindent
2933 where @var{path-to-rootdir} is the absolute path of
2934 a directory relative to which all installation paths will be
2935 interpreted.  Note that the directory specified by @code{DESTDIR}
2936 need not exist yet; it will be created if necessary.
2938 There is a subtle point with tooldirs and @code{DESTDIR}:
2939 If you relocate a cross-compiler installation with
2940 e.g.@: @samp{DESTDIR=@var{rootdir}}, then the directory
2941 @file{@var{rootdir}/@var{exec-prefix}/@var{target-alias}/bin} will
2942 be filled with duplicated GCC executables only if it already exists,
2943 it will not be created otherwise.  This is regarded as a feature,
2944 not as a bug, because it gives slightly more control to the packagers
2945 using the @code{DESTDIR} feature.
2947 You can install stripped programs and libraries with
2949 @smallexample
2950 make install-strip
2951 @end smallexample
2953 If you are bootstrapping a released version of GCC then please
2954 quickly review the build status page for your release, available from
2955 @uref{http://gcc.gnu.org/buildstat.html}.
2956 If your system is not listed for the version of GCC that you built,
2957 send a note to
2958 @email{gcc@@gcc.gnu.org} indicating
2959 that you successfully built and installed GCC@.
2960 Include the following information:
2962 @itemize @bullet
2963 @item
2964 Output from running @file{@var{srcdir}/config.guess}.  Do not send
2965 that file itself, just the one-line output from running it.
2967 @item
2968 The output of @samp{gcc -v} for your newly installed @command{gcc}.
2969 This tells us which version of GCC you built and the options you passed to
2970 configure.
2972 @item
2973 Whether you enabled all languages or a subset of them.  If you used a
2974 full distribution then this information is part of the configure
2975 options in the output of @samp{gcc -v}, but if you downloaded the
2976 ``core'' compiler plus additional front ends then it isn't apparent
2977 which ones you built unless you tell us about it.
2979 @item
2980 If the build was for GNU/Linux, also include:
2981 @itemize @bullet
2982 @item
2983 The distribution name and version (e.g., Red Hat 7.1 or Debian 2.2.3);
2984 this information should be available from @file{/etc/issue}.
2986 @item
2987 The version of the Linux kernel, available from @samp{uname --version}
2988 or @samp{uname -a}.
2990 @item
2991 The version of glibc you used; for RPM-based systems like Red Hat,
2992 Mandrake, and SuSE type @samp{rpm -q glibc} to get the glibc version,
2993 and on systems like Debian and Progeny use @samp{dpkg -l libc6}.
2994 @end itemize
2995 For other systems, you can include similar information if you think it is
2996 relevant.
2998 @item
2999 Any other information that you think would be useful to people building
3000 GCC on the same configuration.  The new entry in the build status list
3001 will include a link to the archived copy of your message.
3002 @end itemize
3004 We'd also like to know if the
3005 @ifnothtml
3006 @ref{Specific, host/target specific installation notes}
3007 @end ifnothtml
3008 @ifhtml
3009 @uref{specific.html,,host/target specific installation notes}
3010 @end ifhtml
3011 didn't include your host/target information or if that information is
3012 incomplete or out of date.  Send a note to
3013 @email{gcc@@gcc.gnu.org} detailing how the information should be changed.
3015 If you find a bug, please report it following the
3016 @uref{../bugs/,,bug reporting guidelines}.
3018 If you want to print the GCC manuals, do @samp{cd @var{objdir}; make
3019 dvi}.  You will need to have @command{texi2dvi} (version at least 4.7)
3020 and @TeX{} installed.  This creates a number of @file{.dvi} files in
3021 subdirectories of @file{@var{objdir}}; these may be converted for
3022 printing with programs such as @command{dvips}.  Alternately, by using
3023 @samp{make pdf} in place of @samp{make dvi}, you can create documentation
3024 in the form of @file{.pdf} files; this requires @command{texi2pdf}, which
3025 is included with Texinfo version 4.8 and later.  You can also
3026 @uref{https://shop.fsf.org/,,buy printed manuals from the
3027 Free Software Foundation}, though such manuals may not be for the most
3028 recent version of GCC@.
3030 If you would like to generate online HTML documentation, do @samp{cd
3031 @var{objdir}; make html} and HTML will be generated for the gcc manuals in
3032 @file{@var{objdir}/gcc/HTML}.
3034 @html
3035 <hr />
3037 @end html
3038 @ifhtml
3039 @uref{./index.html,,Return to the GCC Installation page}
3040 @end ifhtml
3041 @end ifset
3043 @c ***Binaries****************************************************************
3044 @ifnothtml
3045 @comment node-name,     next,          previous, up
3046 @node    Binaries, Specific, Installing GCC, Top
3047 @end ifnothtml
3048 @ifset binarieshtml
3049 @ifnothtml
3050 @chapter Installing GCC: Binaries
3051 @end ifnothtml
3052 @cindex Binaries
3053 @cindex Installing GCC: Binaries
3055 We are often asked about pre-compiled versions of GCC@.  While we cannot
3056 provide these for all platforms, below you'll find links to binaries for
3057 various platforms where creating them by yourself is not easy due to various
3058 reasons.
3060 Please note that we did not create these binaries, nor do we
3061 support them.  If you have any problems installing them, please
3062 contact their makers.
3064 @itemize
3065 @item
3066 AIX:
3067 @itemize
3068 @item
3069 @uref{http://www.bullfreeware.com,,Bull's Open Source Software Archive for
3070 for AIX 5L and AIX 6};
3072 @item
3073 @uref{http://www.perzl.org/aix/,,AIX Open Source Packages (AIX5L AIX 6.1
3074 AIX 7.1)}.
3075 @end itemize
3077 @item
3078 DOS---@uref{http://www.delorie.com/djgpp/,,DJGPP}.
3080 @item
3081 HP-UX:
3082 @itemize
3083 @item
3084 @uref{http://hpux.connect.org.uk/,,HP-UX Porting Center};
3085 @end itemize
3087 @item
3088 Solaris 2 (SPARC, Intel):
3089 @itemize
3090 @item
3091 @uref{https://www.opencsw.org/,,OpenCSW}
3093 @item
3094 @uref{http://jupiterrise.com/tgcware/,,TGCware}
3095 @end itemize
3097 @item
3098 macOS:
3099 @itemize
3100 @item
3101 The @uref{https://brew.sh,,Homebrew} package manager;
3102 @item
3103 @uref{https://www.macports.org,,MacPorts}.
3104 @end itemize
3106 @item
3107 Microsoft Windows:
3108 @itemize
3109 @item
3110 The @uref{https://sourceware.org/cygwin/,,Cygwin} project;
3111 @item
3112 The @uref{http://www.mingw.org/,,MinGW} and
3113 @uref{http://mingw-w64.org/doku.php,,mingw-w64} projects.
3114 @end itemize
3116 @item
3117 @uref{http://www.openpkg.org/,,OpenPKG} offers binaries for quite a
3118 number of platforms.
3120 @item
3121 The @uref{http://gcc.gnu.org/wiki/GFortranBinaries,,GFortran Wiki} has
3122 links to GNU Fortran binaries for several platforms.
3123 @end itemize
3125 @html
3126 <hr />
3128 @end html
3129 @ifhtml
3130 @uref{./index.html,,Return to the GCC Installation page}
3131 @end ifhtml
3132 @end ifset
3134 @c ***Specific****************************************************************
3135 @ifnothtml
3136 @comment node-name,     next,          previous, up
3137 @node    Specific, Old, Binaries, Top
3138 @end ifnothtml
3139 @ifset specifichtml
3140 @ifnothtml
3141 @chapter Host/target specific installation notes for GCC
3142 @end ifnothtml
3143 @cindex Specific
3144 @cindex Specific installation notes
3145 @cindex Target specific installation
3146 @cindex Host specific installation
3147 @cindex Target specific installation notes
3149 Please read this document carefully @emph{before} installing the
3150 GNU Compiler Collection on your machine.
3152 Note that this list of install notes is @emph{not} a list of supported
3153 hosts or targets.  Not all supported hosts and targets are listed
3154 here, only the ones that require host-specific or target-specific
3155 information have to. 
3157 @ifhtml
3158 @itemize
3159 @item
3160 @uref{#aarch64-x-x,,aarch64*-*-*}
3161 @item
3162 @uref{#alpha-x-x,,alpha*-*-*}
3163 @item
3164 @uref{#alpha-dec-osf51,,alpha*-dec-osf5.1}
3165 @item
3166 @uref{#amd64-x-solaris210,,amd64-*-solaris2.10}
3167 @item
3168 @uref{#arm-x-eabi,,arm-*-eabi}
3169 @item
3170 @uref{#avr,,avr}
3171 @item
3172 @uref{#bfin,,Blackfin}
3173 @item
3174 @uref{#dos,,DOS}
3175 @item
3176 @uref{#x-x-freebsd,,*-*-freebsd*}
3177 @item
3178 @uref{#h8300-hms,,h8300-hms}
3179 @item
3180 @uref{#hppa-hp-hpux,,hppa*-hp-hpux*}
3181 @item
3182 @uref{#hppa-hp-hpux10,,hppa*-hp-hpux10}
3183 @item
3184 @uref{#hppa-hp-hpux11,,hppa*-hp-hpux11}
3185 @item
3186 @uref{#x-x-linux-gnu,,*-*-linux-gnu}
3187 @item
3188 @uref{#ix86-x-linux,,i?86-*-linux*}
3189 @item
3190 @uref{#ix86-x-solaris210,,i?86-*-solaris2.10}
3191 @item
3192 @uref{#ia64-x-linux,,ia64-*-linux}
3193 @item
3194 @uref{#ia64-x-hpux,,ia64-*-hpux*}
3195 @item
3196 @uref{#x-ibm-aix,,*-ibm-aix*}
3197 @item
3198 @uref{#iq2000-x-elf,,iq2000-*-elf}
3199 @item
3200 @uref{#lm32-x-elf,,lm32-*-elf}
3201 @item
3202 @uref{#lm32-x-uclinux,,lm32-*-uclinux}
3203 @item
3204 @uref{#m32c-x-elf,,m32c-*-elf}
3205 @item
3206 @uref{#m32r-x-elf,,m32r-*-elf}
3207 @item
3208 @uref{#m68k-x-x,,m68k-*-*}
3209 @item
3210 @uref{#m68k-uclinux,,m68k-uclinux}
3211 @item
3212 @uref{#microblaze-x-elf,,microblaze-*-elf}
3213 @item
3214 @uref{#mips-x-x,,mips-*-*}
3215 @item
3216 @uref{#mips-sgi-irix5,,mips-sgi-irix5}
3217 @item
3218 @uref{#mips-sgi-irix6,,mips-sgi-irix6}
3219 @item
3220 @uref{#nds32le-x-elf,,nds32le-*-elf}
3221 @item
3222 @uref{#nds32be-x-elf,,nds32be-*-elf}
3223 @item
3224 @uref{#nvptx-x-none,,nvptx-*-none}
3225 @item
3226 @uref{#powerpc-x-x,,powerpc*-*-*}
3227 @item
3228 @uref{#powerpc-x-darwin,,powerpc-*-darwin*}
3229 @item
3230 @uref{#powerpc-x-elf,,powerpc-*-elf}
3231 @item
3232 @uref{#powerpc-x-linux-gnu,,powerpc*-*-linux-gnu*}
3233 @item
3234 @uref{#powerpc-x-netbsd,,powerpc-*-netbsd*}
3235 @item
3236 @uref{#powerpc-x-eabisim,,powerpc-*-eabisim}
3237 @item
3238 @uref{#powerpc-x-eabi,,powerpc-*-eabi}
3239 @item
3240 @uref{#powerpcle-x-elf,,powerpcle-*-elf}
3241 @item
3242 @uref{#powerpcle-x-eabisim,,powerpcle-*-eabisim}
3243 @item
3244 @uref{#powerpcle-x-eabi,,powerpcle-*-eabi}
3245 @item
3246 @uref{#riscv32-x-elf,,riscv32-*-elf}
3247 @item
3248 @uref{#riscv32-x-linux,,riscv32-*-linux}
3249 @item
3250 @uref{#riscv64-x-elf,,riscv64-*-elf}
3251 @item
3252 @uref{#riscv64-x-linux,,riscv64-*-linux}
3253 @item
3254 @uref{#s390-x-linux,,s390-*-linux*}
3255 @item
3256 @uref{#s390x-x-linux,,s390x-*-linux*}
3257 @item
3258 @uref{#s390x-ibm-tpf,,s390x-ibm-tpf*}
3259 @item
3260 @uref{#x-x-solaris2,,*-*-solaris2*}
3261 @item
3262 @uref{#sparc-x-x,,sparc*-*-*}
3263 @item
3264 @uref{#sparc-sun-solaris2,,sparc-sun-solaris2*}
3265 @item
3266 @uref{#sparc-sun-solaris210,,sparc-sun-solaris2.10}
3267 @item
3268 @uref{#sparc-x-linux,,sparc-*-linux*}
3269 @item
3270 @uref{#sparc64-x-solaris2,,sparc64-*-solaris2*}
3271 @item
3272 @uref{#sparcv9-x-solaris2,,sparcv9-*-solaris2*}
3273 @item
3274 @uref{#c6x-x-x,,c6x-*-*}
3275 @item
3276 @uref{#tilegx-x-linux,,tilegx-*-linux*}
3277 @item
3278 @uref{#tilegxbe-x-linux,,tilegxbe-*-linux*}
3279 @item
3280 @uref{#tilepro-x-linux,,tilepro-*-linux*}
3281 @item
3282 @uref{#visium-x-elf, visium-*-elf}
3283 @item
3284 @uref{#x-x-vxworks,,*-*-vxworks*}
3285 @item
3286 @uref{#x86-64-x-x,,x86_64-*-*, amd64-*-*}
3287 @item
3288 @uref{#x86-64-x-solaris210,,x86_64-*-solaris2.1[0-9]*}
3289 @item
3290 @uref{#xtensa-x-elf,,xtensa*-*-elf}
3291 @item
3292 @uref{#xtensa-x-linux,,xtensa*-*-linux*}
3293 @item
3294 @uref{#windows,,Microsoft Windows}
3295 @item
3296 @uref{#x-x-cygwin,,*-*-cygwin}
3297 @item
3298 @uref{#x-x-mingw32,,*-*-mingw32}
3299 @item
3300 @uref{#os2,,OS/2}
3301 @item
3302 @uref{#older,,Older systems}
3303 @end itemize
3305 @itemize
3306 @item
3307 @uref{#elf,,all ELF targets} (SVR4, Solaris 2, etc.)
3308 @end itemize
3309 @end ifhtml
3312 @html
3313 <!-- -------- host/target specific issues start here ---------------- -->
3314 <hr />
3315 @end html
3316 @anchor{aarch64-x-x}
3317 @heading aarch64*-*-*
3318 Binutils pre 2.24 does not have support for selecting @option{-mabi} and
3319 does not support ILP32.  If it is used to build GCC 4.9 or later, GCC will
3320 not support option @option{-mabi=ilp32}.
3322 To enable a workaround for the Cortex-A53 erratum number 835769 by default
3323 (for all CPUs regardless of -mcpu option given) at configure time use the
3324 @option{--enable-fix-cortex-a53-835769} option.  This will enable the fix by
3325 default and can be explicitly disabled during compilation by passing the
3326 @option{-mno-fix-cortex-a53-835769} option.  Conversely,
3327 @option{--disable-fix-cortex-a53-835769} will disable the workaround by
3328 default.  The workaround is disabled by default if neither of
3329 @option{--enable-fix-cortex-a53-835769} or
3330 @option{--disable-fix-cortex-a53-835769} is given at configure time.
3332 To enable a workaround for the Cortex-A53 erratum number 843419 by default
3333 (for all CPUs regardless of -mcpu option given) at configure time use the
3334 @option{--enable-fix-cortex-a53-843419} option.  This workaround is applied at
3335 link time.  Enabling the workaround will cause GCC to pass the relevant option
3336 to the linker.  It can be explicitly disabled during compilation by passing the
3337 @option{-mno-fix-cortex-a53-843419} option.  Conversely,
3338 @option{--disable-fix-cortex-a53-843419} will disable the workaround by default.
3339 The workaround is disabled by default if neither of
3340 @option{--enable-fix-cortex-a53-843419} or
3341 @option{--disable-fix-cortex-a53-843419} is given at configure time.
3343 @html
3344 <hr />
3345 @end html
3346 @anchor{alpha-x-x}
3347 @heading alpha*-*-*
3348 This section contains general configuration information for all
3349 alpha-based platforms using ELF (in particular, ignore this section for
3350 DEC OSF/1, Digital UNIX and Tru64 UNIX)@.  In addition to reading this
3351 section, please read all other sections that match your target.
3353 We require binutils 2.11.2 or newer.
3354 Previous binutils releases had a number of problems with DWARF 2
3355 debugging information, not the least of which is incorrect linking of
3356 shared libraries.
3358 @html
3359 <hr />
3360 @end html
3361 @anchor{alpha-dec-osf51}
3362 @heading alpha*-dec-osf5.1
3363 Systems using processors that implement the DEC Alpha architecture and
3364 are running the DEC/Compaq/HP Unix (DEC OSF/1, Digital UNIX, or Compaq/HP
3365 Tru64 UNIX) operating system, for example the DEC Alpha AXP systems.
3367 Support for Tru64 UNIX V5.1 has been removed in GCC 4.8.  As of GCC 4.6,
3368 support for Tru64 UNIX V4.0 and V5.0 has been removed.  As of GCC 3.2,
3369 versions before @code{alpha*-dec-osf4} are no longer supported.  (These
3370 are the versions which identify themselves as DEC OSF/1.)
3372 @html
3373 <hr />
3374 @end html
3375 @anchor{amd64-x-solaris210}
3376 @heading amd64-*-solaris2.1[0-9]*
3377 This is a synonym for @samp{x86_64-*-solaris2.1[0-9]*}.
3379 @html
3380 <hr />
3381 @end html
3382 @anchor{arc-x-elf32}
3383 @heading arc-*-elf32
3385 Use @samp{configure --target=arc-elf32 --with-cpu=@var{cpu} --enable-languages="c,c++"}
3386 to configure GCC, with @var{cpu} being one of @samp{arc600}, @samp{arc601},
3387 or @samp{arc700}@.
3389 @html
3390 <hr />
3391 @end html
3392 @anchor{arc-linux-uclibc}
3393 @heading arc-linux-uclibc
3395 Use @samp{configure --target=arc-linux-uclibc --with-cpu=arc700 --enable-languages="c,c++"} to configure GCC@.
3397 @html
3398 <hr />
3399 @end html
3400 @anchor{arm-x-eabi}
3401 @heading arm-*-eabi
3402 ARM-family processors.
3404 Building the Ada frontend commonly fails (an infinite loop executing
3405 @code{xsinfo}) if the host compiler is GNAT 4.8.  Host compilers built from the
3406 GNAT 4.6, 4.9 or 5 release branches are known to succeed.
3408 @html
3409 <hr />
3410 @end html
3411 @anchor{avr}
3412 @heading avr
3413 ATMEL AVR-family micro controllers.  These are used in embedded
3414 applications.  There are no standard Unix configurations.
3415 @ifnothtml
3416 @xref{AVR Options,, AVR Options, gcc, Using the GNU Compiler
3417 Collection (GCC)},
3418 @end ifnothtml
3419 @ifhtml
3420 See ``AVR Options'' in the main manual
3421 @end ifhtml
3422 for the list of supported MCU types.
3424 Use @samp{configure --target=avr --enable-languages="c"} to configure GCC@.
3426 Further installation notes and other useful information about AVR tools
3427 can also be obtained from:
3429 @itemize @bullet
3430 @item
3431 @uref{http://www.nongnu.org/avr/,,http://www.nongnu.org/avr/}
3432 @item
3433 @uref{http://www.amelek.gda.pl/avr/,,http://www.amelek.gda.pl/avr/}
3434 @end itemize
3436 The following error:
3437 @smallexample
3438 Error: register required
3439 @end smallexample
3441 indicates that you should upgrade to a newer version of the binutils.
3443 @html
3444 <hr />
3445 @end html
3446 @anchor{bfin}
3447 @heading Blackfin
3448 The Blackfin processor, an Analog Devices DSP.
3449 @ifnothtml
3450 @xref{Blackfin Options,, Blackfin Options, gcc, Using the GNU Compiler
3451 Collection (GCC)},
3452 @end ifnothtml
3453 @ifhtml
3454 See ``Blackfin Options'' in the main manual
3455 @end ifhtml
3457 More information, and a version of binutils with support for this processor,
3458 is available at @uref{https://blackfin.uclinux.org}
3460 @html
3461 <hr />
3462 @end html
3463 @anchor{cr16}
3464 @heading CR16
3465 The CR16 CompactRISC architecture is a 16-bit architecture. This
3466 architecture is used in embedded applications.
3468 @ifnothtml
3469 @xref{CR16 Options,, CR16 Options, gcc, Using and Porting the GNU Compiler
3470 Collection (GCC)},
3471 @end ifnothtml
3473 @ifhtml
3474 See ``CR16 Options'' in the main manual for a list of CR16-specific options.
3475 @end ifhtml
3477 Use @samp{configure --target=cr16-elf --enable-languages=c,c++} to configure
3478 GCC@ for building a CR16 elf cross-compiler.
3480 Use @samp{configure --target=cr16-uclinux --enable-languages=c,c++} to
3481 configure GCC@ for building a CR16 uclinux cross-compiler.
3483 @html
3484 <hr />
3485 @end html
3486 @anchor{cris}
3487 @heading CRIS
3488 CRIS is the CPU architecture in Axis Communications ETRAX system-on-a-chip
3489 series.  These are used in embedded applications.
3491 @ifnothtml
3492 @xref{CRIS Options,, CRIS Options, gcc, Using the GNU Compiler
3493 Collection (GCC)},
3494 @end ifnothtml
3495 @ifhtml
3496 See ``CRIS Options'' in the main manual
3497 @end ifhtml
3498 for a list of CRIS-specific options.
3500 There are a few different CRIS targets:
3501 @table @code
3502 @item cris-axis-elf
3503 Mainly for monolithic embedded systems.  Includes a multilib for the
3504 @samp{v10} core used in @samp{ETRAX 100 LX}.
3505 @item cris-axis-linux-gnu
3506 A GNU/Linux port for the CRIS architecture, currently targeting
3507 @samp{ETRAX 100 LX} by default.
3508 @end table
3510 Pre-packaged tools can be obtained from
3511 @uref{ftp://ftp.axis.com/@/pub/@/axis/@/tools/@/cris/@/compiler-kit/}.  More
3512 information about this platform is available at
3513 @uref{http://developer.axis.com/}.
3515 @html
3516 <hr />
3517 @end html
3518 @anchor{dos}
3519 @heading DOS
3520 Please have a look at the @uref{binaries.html,,binaries page}.
3522 You cannot install GCC by itself on MSDOS; it will not compile under
3523 any MSDOS compiler except itself.  You need to get the complete
3524 compilation package DJGPP, which includes binaries as well as sources,
3525 and includes all the necessary compilation tools and libraries.
3527 @html
3528 <hr />
3529 @end html
3530 @anchor{epiphany-x-elf}
3531 @heading epiphany-*-elf
3532 Adapteva Epiphany.
3533 This configuration is intended for embedded systems.
3535 @html
3536 <hr />
3537 @end html
3538 @anchor{x-x-freebsd}
3539 @heading *-*-freebsd*
3540 Support for FreeBSD 1 was discontinued in GCC 3.2.  Support for
3541 FreeBSD 2 (and any mutant a.out variants of FreeBSD 3) was
3542 discontinued in GCC 4.0.
3544 In order to better utilize FreeBSD base system functionality and match
3545 the configuration of the system compiler, GCC 4.5 and above as well as
3546 GCC 4.4 past 2010-06-20 leverage SSP support in libc (which is present
3547 on FreeBSD 7 or later) and the use of @code{__cxa_atexit} by default
3548 (on FreeBSD 6 or later).  The use of @code{dl_iterate_phdr} inside
3549 @file{libgcc_s.so.1} and boehm-gc (on FreeBSD 7 or later) is enabled
3550 by GCC 4.5 and above.
3552 We support FreeBSD using the ELF file format with DWARF 2 debugging
3553 for all CPU architectures.  You may use @option{-gstabs} instead of
3554 @option{-g}, if you really want the old debugging format.  There are
3555 no known issues with mixing object files and libraries with different
3556 debugging formats.  Otherwise, this release of GCC should now match
3557 more of the configuration used in the stock FreeBSD configuration of
3558 GCC@.  In particular, @option{--enable-threads} is now configured by
3559 default.  However, as a general user, do not attempt to replace the
3560 system compiler with this release.  Known to bootstrap and check with
3561 good results on FreeBSD 7.2-STABLE@.  In the past, known to bootstrap
3562 and check with good results on FreeBSD 3.0, 3.4, 4.0, 4.2, 4.3, 4.4,
3563 4.5, 4.8, 4.9 and 5-CURRENT@.
3565 The version of binutils installed in @file{/usr/bin} probably works
3566 with this release of GCC@.  Bootstrapping against the latest GNU
3567 binutils and/or the version found in @file{/usr/ports/devel/binutils} has
3568 been known to enable additional features and improve overall testsuite
3569 results.  However, it is currently known that boehm-gc may not configure
3570 properly on FreeBSD prior to the FreeBSD 7.0 release with GNU binutils
3571 after 2.16.1.
3573 @html
3574 <hr />
3575 @end html
3576 @anchor{ft32-x-elf}
3577 @heading ft32-*-elf
3578 The FT32 processor.
3579 This configuration is intended for embedded systems.
3581 @html
3582 <hr />
3583 @end html
3584 @anchor{h8300-hms}
3585 @heading h8300-hms
3586 Renesas H8/300 series of processors.
3588 Please have a look at the @uref{binaries.html,,binaries page}.
3590 The calling convention and structure layout has changed in release 2.6.
3591 All code must be recompiled.  The calling convention now passes the
3592 first three arguments in function calls in registers.  Structures are no
3593 longer a multiple of 2 bytes.
3595 @html
3596 <hr />
3597 @end html
3598 @anchor{hppa-hp-hpux}
3599 @heading hppa*-hp-hpux*
3600 Support for HP-UX version 9 and older was discontinued in GCC 3.4.
3602 We require using gas/binutils on all hppa platforms.  Version 2.19 or
3603 later is recommended.
3605 It may be helpful to configure GCC with the
3606 @uref{./configure.html#with-gnu-as,,@option{--with-gnu-as}} and
3607 @option{--with-as=@dots{}} options to ensure that GCC can find GAS@.
3609 The HP assembler should not be used with GCC.  It is rarely tested and may
3610 not work.  It shouldn't be used with any languages other than C due to its
3611 many limitations.
3613 Specifically, @option{-g} does not work (HP-UX uses a peculiar debugging
3614 format which GCC does not know about).  It also inserts timestamps
3615 into each object file it creates, causing the 3-stage comparison test to
3616 fail during a bootstrap.  You should be able to continue by saying
3617 @samp{make all-host all-target} after getting the failure from @samp{make}.
3619 Various GCC features are not supported.  For example, it does not support weak
3620 symbols or alias definitions.  As a result, explicit template instantiations
3621 are required when using C++.  This makes it difficult if not impossible to
3622 build many C++ applications.
3624 There are two default scheduling models for instructions.  These are
3625 PROCESSOR_7100LC and PROCESSOR_8000.  They are selected from the pa-risc
3626 architecture specified for the target machine when configuring.
3627 PROCESSOR_8000 is the default.  PROCESSOR_7100LC is selected when
3628 the target is a @samp{hppa1*} machine.
3630 The PROCESSOR_8000 model is not well suited to older processors.  Thus,
3631 it is important to completely specify the machine architecture when
3632 configuring if you want a model other than PROCESSOR_8000.  The macro
3633 TARGET_SCHED_DEFAULT can be defined in BOOT_CFLAGS if a different
3634 default scheduling model is desired.
3636 As of GCC 4.0, GCC uses the UNIX 95 namespace for HP-UX 10.10
3637 through 11.00, and the UNIX 98 namespace for HP-UX 11.11 and later.
3638 This namespace change might cause problems when bootstrapping with
3639 an earlier version of GCC or the HP compiler as essentially the same
3640 namespace is required for an entire build.  This problem can be avoided
3641 in a number of ways.  With HP cc, @env{UNIX_STD} can be set to @samp{95}
3642 or @samp{98}.  Another way is to add an appropriate set of predefines
3643 to @env{CC}.  The description for the @option{munix=} option contains
3644 a list of the predefines used with each standard.
3646 More specific information to @samp{hppa*-hp-hpux*} targets follows.
3648 @html
3649 <hr />
3650 @end html
3651 @anchor{hppa-hp-hpux10}
3652 @heading hppa*-hp-hpux10
3653 For hpux10.20, we @emph{highly} recommend you pick up the latest sed patch
3654 @code{PHCO_19798} from HP@.
3656 The C++ ABI has changed incompatibly in GCC 4.0.  COMDAT subspaces are
3657 used for one-only code and data.  This resolves many of the previous
3658 problems in using C++ on this target.  However, the ABI is not compatible
3659 with the one implemented under HP-UX 11 using secondary definitions.
3661 @html
3662 <hr />
3663 @end html
3664 @anchor{hppa-hp-hpux11}
3665 @heading hppa*-hp-hpux11
3666 GCC 3.0 and up support HP-UX 11.  GCC 2.95.x is not supported and cannot
3667 be used to compile GCC 3.0 and up.
3669 The libffi library haven't been ported to 64-bit HP-UX@ and doesn't build.
3671 Refer to @uref{binaries.html,,binaries} for information about obtaining
3672 precompiled GCC binaries for HP-UX@.  Precompiled binaries must be obtained
3673 to build the Ada language as it cannot be bootstrapped using C@.  Ada is
3674 only available for the 32-bit PA-RISC runtime.
3676 Starting with GCC 3.4 an ISO C compiler is required to bootstrap.  The
3677 bundled compiler supports only traditional C; you will need either HP's
3678 unbundled compiler, or a binary distribution of GCC@.
3680 It is possible to build GCC 3.3 starting with the bundled HP compiler,
3681 but the process requires several steps.  GCC 3.3 can then be used to
3682 build later versions.
3684 There are several possible approaches to building the distribution.
3685 Binutils can be built first using the HP tools.  Then, the GCC
3686 distribution can be built.  The second approach is to build GCC
3687 first using the HP tools, then build binutils, then rebuild GCC@.
3688 There have been problems with various binary distributions, so it
3689 is best not to start from a binary distribution.
3691 On 64-bit capable systems, there are two distinct targets.  Different
3692 installation prefixes must be used if both are to be installed on
3693 the same system.  The @samp{hppa[1-2]*-hp-hpux11*} target generates code
3694 for the 32-bit PA-RISC runtime architecture and uses the HP linker.
3695 The @samp{hppa64-hp-hpux11*} target generates 64-bit code for the
3696 PA-RISC 2.0 architecture.
3698 The script config.guess now selects the target type based on the compiler
3699 detected during configuration.  You must define @env{PATH} or @env{CC} so
3700 that configure finds an appropriate compiler for the initial bootstrap.
3701 When @env{CC} is used, the definition should contain the options that are
3702 needed whenever @env{CC} is used.
3704 Specifically, options that determine the runtime architecture must be
3705 in @env{CC} to correctly select the target for the build.  It is also
3706 convenient to place many other compiler options in @env{CC}.  For example,
3707 @env{CC="cc -Ac +DA2.0W -Wp,-H16376 -D_CLASSIC_TYPES -D_HPUX_SOURCE"}
3708 can be used to bootstrap the GCC 3.3 branch with the HP compiler in
3709 64-bit K&R/bundled mode.  The @option{+DA2.0W} option will result in
3710 the automatic selection of the @samp{hppa64-hp-hpux11*} target.  The
3711 macro definition table of cpp needs to be increased for a successful
3712 build with the HP compiler.  _CLASSIC_TYPES and _HPUX_SOURCE need to
3713 be defined when building with the bundled compiler, or when using the
3714 @option{-Ac} option.  These defines aren't necessary with @option{-Ae}.
3716 It is best to explicitly configure the @samp{hppa64-hp-hpux11*} target
3717 with the @option{--with-ld=@dots{}} option.  This overrides the standard
3718 search for ld.  The two linkers supported on this target require different
3719 commands.  The default linker is determined during configuration.  As a
3720 result, it's not possible to switch linkers in the middle of a GCC build.
3721 This has been reported to sometimes occur in unified builds of binutils
3722 and GCC@.
3724 A recent linker patch must be installed for the correct operation of
3725 GCC 3.3 and later.  @code{PHSS_26559} and @code{PHSS_24304} are the
3726 oldest linker patches that are known to work.  They are for HP-UX
3727 11.00 and 11.11, respectively.  @code{PHSS_24303}, the companion to
3728 @code{PHSS_24304}, might be usable but it hasn't been tested.  These
3729 patches have been superseded.  Consult the HP patch database to obtain
3730 the currently recommended linker patch for your system.
3732 The patches are necessary for the support of weak symbols on the
3733 32-bit port, and for the running of initializers and finalizers.  Weak
3734 symbols are implemented using SOM secondary definition symbols.  Prior
3735 to HP-UX 11, there are bugs in the linker support for secondary symbols.
3736 The patches correct a problem of linker core dumps creating shared
3737 libraries containing secondary symbols, as well as various other
3738 linking issues involving secondary symbols.
3740 GCC 3.3 uses the ELF DT_INIT_ARRAY and DT_FINI_ARRAY capabilities to
3741 run initializers and finalizers on the 64-bit port.  The 32-bit port
3742 uses the linker @option{+init} and @option{+fini} options for the same
3743 purpose.  The patches correct various problems with the +init/+fini
3744 options, including program core dumps.  Binutils 2.14 corrects a
3745 problem on the 64-bit port resulting from HP's non-standard use of
3746 the .init and .fini sections for array initializers and finalizers.
3748 Although the HP and GNU linkers are both supported for the
3749 @samp{hppa64-hp-hpux11*} target, it is strongly recommended that the
3750 HP linker be used for link editing on this target.
3752 At this time, the GNU linker does not support the creation of long
3753 branch stubs.  As a result, it cannot successfully link binaries
3754 containing branch offsets larger than 8 megabytes.  In addition,
3755 there are problems linking shared libraries, linking executables
3756 with @option{-static}, and with dwarf2 unwind and exception support.
3757 It also doesn't provide stubs for internal calls to global functions
3758 in shared libraries, so these calls cannot be overloaded.
3760 The HP dynamic loader does not support GNU symbol versioning, so symbol
3761 versioning is not supported.  It may be necessary to disable symbol
3762 versioning with @option{--disable-symvers} when using GNU ld.
3764 POSIX threads are the default.  The optional DCE thread library is not
3765 supported, so @option{--enable-threads=dce} does not work.
3767 @html
3768 <hr />
3769 @end html
3770 @anchor{x-x-linux-gnu}
3771 @heading *-*-linux-gnu
3772 Versions of libstdc++-v3 starting with 3.2.1 require bug fixes present
3773 in glibc 2.2.5 and later.  More information is available in the
3774 libstdc++-v3 documentation.
3776 @html
3777 <hr />
3778 @end html
3779 @anchor{ix86-x-linux}
3780 @heading i?86-*-linux*
3781 As of GCC 3.3, binutils 2.13.1 or later is required for this platform.
3782 See @uref{http://gcc.gnu.org/PR10877,,bug 10877} for more information.
3784 If you receive Signal 11 errors when building on GNU/Linux, then it is
3785 possible you have a hardware problem.  Further information on this can be
3786 found on @uref{http://www.bitwizard.nl/sig11/,,www.bitwizard.nl}.
3788 @html
3789 <hr />
3790 @end html
3791 @anchor{ix86-x-solaris210}
3792 @heading i?86-*-solaris2.10
3793 Use this for Solaris 10 or later on x86 and x86-64 systems.  Starting
3794 with GCC 4.7, there is also a 64-bit @samp{amd64-*-solaris2.1[0-9]*} or
3795 @samp{x86_64-*-solaris2.1[0-9]*} configuration that corresponds to
3796 @samp{sparcv9-sun-solaris2*}.
3798 It is recommended that you configure GCC to use the GNU assembler.  The
3799 versions included in Solaris 10, from GNU binutils 2.15 (in
3800 @file{/usr/sfw/bin/gas}), and Solaris 11, from GNU binutils 2.19 or
3801 newer (also available as @file{/usr/bin/gas} and
3802 @file{/usr/gnu/bin/as}), work fine.  Please note that the current
3803 version, from GNU binutils 2.26, only works on Solaris 12 when using the
3804 Solaris linker.  On Solaris 10 and 11, you either have to wait for GNU
3805 binutils 2.26.1 or newer, or stay with GNU binutils 2.25.1.  Recent
3806 versions of the Solaris assembler in @file{/usr/ccs/bin/as} work almost
3807 as well, though.
3808 @c FIXME: as patch requirements?
3810 For linking, the Solaris linker, is preferred.  If you want to use the GNU
3811 linker instead, note that due to a packaging bug the version in Solaris
3812 10, from GNU binutils 2.15 (in @file{/usr/sfw/bin/gld}), cannot be used,
3813 while the version in Solaris 11, from GNU binutils 2.19 or newer (also
3814 in @file{/usr/gnu/bin/ld} and @file{/usr/bin/gld}), works, as does the
3815 latest version, from GNU binutils 2.26.
3817 To use GNU @command{as}, configure with the options
3818 @option{--with-gnu-as --with-as=@//usr/@/sfw/@/bin/@/gas}.  It may be necessary
3819 to configure with @option{--without-gnu-ld --with-ld=@//usr/@/ccs/@/bin/@/ld} to
3820 guarantee use of Sun @command{ld}.
3821 @c FIXME: why --without-gnu-ld --with-ld?
3823 @html
3824 <hr />
3825 @end html
3826 @anchor{ia64-x-linux}
3827 @heading ia64-*-linux
3828 IA-64 processor (also known as IPF, or Itanium Processor Family)
3829 running GNU/Linux.
3831 If you are using the installed system libunwind library with
3832 @option{--with-system-libunwind}, then you must use libunwind 0.98 or
3833 later.
3835 None of the following versions of GCC has an ABI that is compatible
3836 with any of the other versions in this list, with the exception that
3837 Red Hat 2.96 and Trillian 000171 are compatible with each other:
3838 3.1, 3.0.2, 3.0.1, 3.0, Red Hat 2.96, and Trillian 000717.
3839 This primarily affects C++ programs and programs that create shared libraries.
3840 GCC 3.1 or later is recommended for compiling linux, the kernel.
3841 As of version 3.1 GCC is believed to be fully ABI compliant, and hence no
3842 more major ABI changes are expected.
3844 @html
3845 <hr />
3846 @end html
3847 @anchor{ia64-x-hpux}
3848 @heading ia64-*-hpux*
3849 Building GCC on this target requires the GNU Assembler.  The bundled HP
3850 assembler will not work.  To prevent GCC from using the wrong assembler,
3851 the option @option{--with-gnu-as} may be necessary.
3853 The GCC libunwind library has not been ported to HPUX@.  This means that for
3854 GCC versions 3.2.3 and earlier, @option{--enable-libunwind-exceptions}
3855 is required to build GCC@.  For GCC 3.3 and later, this is the default.
3856 For gcc 3.4.3 and later, @option{--enable-libunwind-exceptions} is
3857 removed and the system libunwind library will always be used.
3859 @html
3860 <hr />
3861 <!-- rs6000-ibm-aix*, powerpc-ibm-aix* -->
3862 @end html
3863 @anchor{x-ibm-aix}
3864 @heading *-ibm-aix*
3865 Support for AIX version 3 and older was discontinued in GCC 3.4.
3866 Support for AIX version 4.2 and older was discontinued in GCC 4.5.
3868 ``out of memory'' bootstrap failures may indicate a problem with
3869 process resource limits (ulimit).  Hard limits are configured in the
3870 @file{/etc/security/limits} system configuration file.
3872 GCC 4.9 and above require a C++ compiler for bootstrap.  IBM VAC++ / xlC
3873 cannot bootstrap GCC.  xlc can bootstrap an older version of GCC and
3874 G++ can bootstrap recent releases of GCC.
3876 GCC can bootstrap with recent versions of IBM XLC, but bootstrapping
3877 with an earlier release of GCC is recommended.  Bootstrapping with XLC
3878 requires a larger data segment, which can be enabled through the
3879 @var{LDR_CNTRL} environment variable, e.g.,
3881 @smallexample
3882 % LDR_CNTRL=MAXDATA=0x50000000
3883 % export LDR_CNTRL
3884 @end smallexample
3886 One can start with a pre-compiled version of GCC to build from
3887 sources.  One may delete GCC's ``fixed'' header files when starting
3888 with a version of GCC built for an earlier release of AIX.
3890 To speed up the configuration phases of bootstrapping and installing GCC,
3891 one may use GNU Bash instead of AIX @command{/bin/sh}, e.g.,
3893 @smallexample
3894 % CONFIG_SHELL=/opt/freeware/bin/bash
3895 % export CONFIG_SHELL
3896 @end smallexample
3898 and then proceed as described in @uref{build.html,,the build
3899 instructions}, where we strongly recommend specifying an absolute path
3900 to invoke @var{srcdir}/configure.
3902 Because GCC on AIX is built as a 32-bit executable by default,
3903 (although it can generate 64-bit programs) the GMP and MPFR libraries
3904 required by gfortran must be 32-bit libraries.  Building GMP and MPFR
3905 as static archive libraries works better than shared libraries.
3907 Errors involving @code{alloca} when building GCC generally are due
3908 to an incorrect definition of @code{CC} in the Makefile or mixing files
3909 compiled with the native C compiler and GCC@.  During the stage1 phase of
3910 the build, the native AIX compiler @strong{must} be invoked as @command{cc}
3911 (not @command{xlc}).  Once @command{configure} has been informed of
3912 @command{xlc}, one needs to use @samp{make distclean} to remove the
3913 configure cache files and ensure that @env{CC} environment variable
3914 does not provide a definition that will confuse @command{configure}.
3915 If this error occurs during stage2 or later, then the problem most likely
3916 is the version of Make (see above).
3918 The native @command{as} and @command{ld} are recommended for
3919 bootstrapping on AIX@.  The GNU Assembler, GNU Linker, and GNU
3920 Binutils version 2.20 is the minimum level that supports bootstrap on
3921 AIX 5@.  The GNU Assembler has not been updated to support AIX 6@ or
3922 AIX 7.  The native AIX tools do interoperate with GCC@.
3924 AIX 7.1 added partial support for DWARF debugging, but full support
3925 requires AIX 7.1 TL03 SP7 that supports additional DWARF sections and
3926 fixes a bug in the assembler.  AIX 7.1 TL03 SP5 distributed a version
3927 of libm.a missing important symbols; a fix for IV77796 will be
3928 included in SP6.
3930 AIX 5.3 TL10, AIX 6.1 TL05 and AIX 7.1 TL00 introduced an AIX
3931 assembler change that sometimes produces corrupt assembly files
3932 causing AIX linker errors.  The bug breaks GCC bootstrap on AIX and
3933 can cause compilation failures with existing GCC installations.  An
3934 AIX iFix for AIX 5.3 is available (APAR IZ98385 for AIX 5.3 TL10, APAR
3935 IZ98477 for AIX 5.3 TL11 and IZ98134 for AIX 5.3 TL12). AIX 5.3 TL11 SP8,
3936 AIX 5.3 TL12 SP5, AIX 6.1 TL04 SP11, AIX 6.1 TL05 SP7, AIX 6.1 TL06 SP6,
3937 AIX 6.1 TL07 and AIX 7.1 TL01 should include the fix.
3939 Building @file{libstdc++.a} requires a fix for an AIX Assembler bug
3940 APAR IY26685 (AIX 4.3) or APAR IY25528 (AIX 5.1).  It also requires a
3941 fix for another AIX Assembler bug and a co-dependent AIX Archiver fix
3942 referenced as APAR IY53606 (AIX 5.2) or as APAR IY54774 (AIX 5.1)
3944 @anchor{TransferAixShobj}
3945 @samp{libstdc++} in GCC 3.4 increments the major version number of the
3946 shared object and GCC installation places the @file{libstdc++.a}
3947 shared library in a common location which will overwrite the and GCC
3948 3.3 version of the shared library.  Applications either need to be
3949 re-linked against the new shared library or the GCC 3.1 and GCC 3.3
3950 versions of the @samp{libstdc++} shared object needs to be available
3951 to the AIX runtime loader.  The GCC 3.1 @samp{libstdc++.so.4}, if
3952 present, and GCC 3.3 @samp{libstdc++.so.5} shared objects can be
3953 installed for runtime dynamic loading using the following steps to set
3954 the @samp{F_LOADONLY} flag in the shared object for @emph{each}
3955 multilib @file{libstdc++.a} installed:
3957 Extract the shared objects from the currently installed
3958 @file{libstdc++.a} archive:
3959 @smallexample
3960 % ar -x libstdc++.a libstdc++.so.4 libstdc++.so.5
3961 @end smallexample
3963 Enable the @samp{F_LOADONLY} flag so that the shared object will be
3964 available for runtime dynamic loading, but not linking:
3965 @smallexample
3966 % strip -e libstdc++.so.4 libstdc++.so.5
3967 @end smallexample
3969 Archive the runtime-only shared object in the GCC 3.4
3970 @file{libstdc++.a} archive:
3971 @smallexample
3972 % ar -q libstdc++.a libstdc++.so.4 libstdc++.so.5
3973 @end smallexample
3975 Eventually, the
3976 @uref{./configure.html#WithAixSoname,,@option{--with-aix-soname=svr4}}
3977 configure option may drop the need for this procedure for libraries that
3978 support it.
3980 Linking executables and shared libraries may produce warnings of
3981 duplicate symbols.  The assembly files generated by GCC for AIX always
3982 have included multiple symbol definitions for certain global variable
3983 and function declarations in the original program.  The warnings should
3984 not prevent the linker from producing a correct library or runnable
3985 executable.
3987 AIX 4.3 utilizes a ``large format'' archive to support both 32-bit and
3988 64-bit object modules.  The routines provided in AIX 4.3.0 and AIX 4.3.1
3989 to parse archive libraries did not handle the new format correctly.
3990 These routines are used by GCC and result in error messages during
3991 linking such as ``not a COFF file''.  The version of the routines shipped
3992 with AIX 4.3.1 should work for a 32-bit environment.  The @option{-g}
3993 option of the archive command may be used to create archives of 32-bit
3994 objects using the original ``small format''.  A correct version of the
3995 routines is shipped with AIX 4.3.2 and above.
3997 Some versions of the AIX binder (linker) can fail with a relocation
3998 overflow severe error when the @option{-bbigtoc} option is used to link
3999 GCC-produced object files into an executable that overflows the TOC@.  A fix
4000 for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND -BBIGTOC) is
4001 available from IBM Customer Support and from its
4002 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
4003 website as PTF U455193.
4005 The AIX 4.3.2.1 linker (bos.rte.bind_cmds Level 4.3.2.1) will dump core
4006 with a segmentation fault when invoked by any version of GCC@.  A fix for
4007 APAR IX87327 is available from IBM Customer Support and from its
4008 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
4009 website as PTF U461879.  This fix is incorporated in AIX 4.3.3 and above.
4011 The initial assembler shipped with AIX 4.3.0 generates incorrect object
4012 files.  A fix for APAR IX74254 (64BIT DISASSEMBLED OUTPUT FROM COMPILER FAILS
4013 TO ASSEMBLE/BIND) is available from IBM Customer Support and from its
4014 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
4015 website as PTF U453956.  This fix is incorporated in AIX 4.3.1 and above.
4017 AIX provides National Language Support (NLS)@.  Compilers and assemblers
4018 use NLS to support locale-specific representations of various data
4019 formats including floating-point numbers (e.g., @samp{.}  vs @samp{,} for
4020 separating decimal fractions).  There have been problems reported where
4021 GCC does not produce the same floating-point formats that the assembler
4022 expects.  If one encounters this problem, set the @env{LANG}
4023 environment variable to @samp{C} or @samp{En_US}.
4025 A default can be specified with the @option{-mcpu=@var{cpu_type}}
4026 switch and using the configure option @option{--with-cpu-@var{cpu_type}}.
4028 @html
4029 <hr />
4030 @end html
4031 @anchor{iq2000-x-elf}
4032 @heading iq2000-*-elf
4033 Vitesse IQ2000 processors.  These are used in embedded
4034 applications.  There are no standard Unix configurations.
4036 @html
4037 <hr />
4038 @end html
4039 @anchor{lm32-x-elf}
4040 @heading lm32-*-elf
4041 Lattice Mico32 processor.
4042 This configuration is intended for embedded systems.
4044 @html
4045 <hr />
4046 @end html
4047 @anchor{lm32-x-uclinux}
4048 @heading lm32-*-uclinux
4049 Lattice Mico32 processor.
4050 This configuration is intended for embedded systems running uClinux.
4052 @html
4053 <hr />
4054 @end html
4055 @anchor{m32c-x-elf}
4056 @heading m32c-*-elf
4057 Renesas M32C processor.
4058 This configuration is intended for embedded systems.
4060 @html
4061 <hr />
4062 @end html
4063 @anchor{m32r-x-elf}
4064 @heading m32r-*-elf
4065 Renesas M32R processor.
4066 This configuration is intended for embedded systems.
4068 @html
4069 <hr />
4070 @end html
4071 @anchor{m68k-x-x}
4072 @heading m68k-*-*
4073 By default,
4074 @samp{m68k-*-elf*}, @samp{m68k-*-rtems},  @samp{m68k-*-uclinux} and
4075 @samp{m68k-*-linux}
4076 build libraries for both M680x0 and ColdFire processors.  If you only
4077 need the M680x0 libraries, you can omit the ColdFire ones by passing
4078 @option{--with-arch=m68k} to @command{configure}.  Alternatively, you
4079 can omit the M680x0 libraries by passing @option{--with-arch=cf} to
4080 @command{configure}.  These targets default to 5206 or 5475 code as
4081 appropriate for the target system when
4082 configured with @option{--with-arch=cf} and 68020 code otherwise.
4084 The @samp{m68k-*-netbsd} and
4085 @samp{m68k-*-openbsd} targets also support the @option{--with-arch}
4086 option.  They will generate ColdFire CFV4e code when configured with
4087 @option{--with-arch=cf} and 68020 code otherwise.
4089 You can override the default processors listed above by configuring
4090 with @option{--with-cpu=@var{target}}.  This @var{target} can either
4091 be a @option{-mcpu} argument or one of the following values:
4092 @samp{m68000}, @samp{m68010}, @samp{m68020}, @samp{m68030},
4093 @samp{m68040}, @samp{m68060}, @samp{m68020-40} and @samp{m68020-60}.
4095 GCC requires at least binutils version 2.17 on these targets.
4097 @html
4098 <hr />
4099 @end html
4100 @anchor{m68k-x-uclinux}
4101 @heading m68k-*-uclinux
4102 GCC 4.3 changed the uClinux configuration so that it uses the
4103 @samp{m68k-linux-gnu} ABI rather than the @samp{m68k-elf} ABI.
4104 It also added improved support for C++ and flat shared libraries,
4105 both of which were ABI changes.
4107 @html
4108 <hr />
4109 @end html
4110 @anchor{microblaze-x-elf}
4111 @heading microblaze-*-elf
4112 Xilinx MicroBlaze processor.
4113 This configuration is intended for embedded systems.
4115 @html
4116 <hr />
4117 @end html
4118 @anchor{mips-x-x}
4119 @heading mips-*-*
4120 If on a MIPS system you get an error message saying ``does not have gp
4121 sections for all it's [sic] sectons [sic]'', don't worry about it.  This
4122 happens whenever you use GAS with the MIPS linker, but there is not
4123 really anything wrong, and it is okay to use the output file.  You can
4124 stop such warnings by installing the GNU linker.
4126 It would be nice to extend GAS to produce the gp tables, but they are
4127 optional, and there should not be a warning about their absence.
4129 The libstdc++ atomic locking routines for MIPS targets requires MIPS II
4130 and later.  A patch went in just after the GCC 3.3 release to
4131 make @samp{mips*-*-*} use the generic implementation instead.  You can also
4132 configure for @samp{mipsel-elf} as a workaround.  The
4133 @samp{mips*-*-linux*} target continues to use the MIPS II routines.  More
4134 work on this is expected in future releases.
4136 @c If you make --with-llsc the default for another target, please also
4137 @c update the description of the --with-llsc option.
4139 The built-in @code{__sync_*} functions are available on MIPS II and
4140 later systems and others that support the @samp{ll}, @samp{sc} and
4141 @samp{sync} instructions.  This can be overridden by passing
4142 @option{--with-llsc} or @option{--without-llsc} when configuring GCC.
4143 Since the Linux kernel emulates these instructions if they are
4144 missing, the default for @samp{mips*-*-linux*} targets is
4145 @option{--with-llsc}.  The @option{--with-llsc} and
4146 @option{--without-llsc} configure options may be overridden at compile
4147 time by passing the @option{-mllsc} or @option{-mno-llsc} options to
4148 the compiler.
4150 MIPS systems check for division by zero (unless
4151 @option{-mno-check-zero-division} is passed to the compiler) by
4152 generating either a conditional trap or a break instruction.  Using
4153 trap results in smaller code, but is only supported on MIPS II and
4154 later.  Also, some versions of the Linux kernel have a bug that
4155 prevents trap from generating the proper signal (@code{SIGFPE}).  To enable
4156 the use of break, use the @option{--with-divide=breaks}
4157 @command{configure} option when configuring GCC@.  The default is to
4158 use traps on systems that support them.
4160 @html
4161 <hr />
4162 @end html
4163 @anchor{mips-sgi-irix5}
4164 @heading mips-sgi-irix5
4165 Support for IRIX 5 has been removed in GCC 4.6.
4167 @html
4168 <hr />
4169 @end html
4170 @anchor{mips-sgi-irix6}
4171 @heading mips-sgi-irix6
4172 Support for IRIX 6.5 has been removed in GCC 4.8.  Support for IRIX 6
4173 releases before 6.5 has been removed in GCC 4.6, as well as support for
4174 the O32 ABI.
4176 @html
4177 <hr />
4178 @end html
4179 @anchor{moxie-x-elf}
4180 @heading moxie-*-elf
4181 The moxie processor.
4183 @html
4184 <hr />
4185 @end html
4186 @anchor{msp430-x-elf}
4187 @heading msp430-*-elf
4188 TI MSP430 processor.
4189 This configuration is intended for embedded systems.
4191 @html
4192 <hr />
4193 @end html
4194 @anchor{nds32le-x-elf}
4195 @heading nds32le-*-elf
4196 Andes NDS32 target in little endian mode.
4198 @html
4199 <hr />
4200 @end html
4201 @anchor{nds32be-x-elf}
4202 @heading nds32be-*-elf
4203 Andes NDS32 target in big endian mode.
4205 @html
4206 <hr />
4207 @end html
4208 @anchor{nvptx-x-none}
4209 @heading nvptx-*-none
4210 Nvidia PTX target.
4212 Instead of GNU binutils, you will need to install
4213 @uref{https://github.com/MentorEmbedded/nvptx-tools/,,nvptx-tools}.
4214 Tell GCC where to find it:
4215 @option{--with-build-time-tools=[install-nvptx-tools]/nvptx-none/bin}.
4217 A nvptx port of newlib is available at
4218 @uref{https://github.com/MentorEmbedded/nvptx-newlib/,,nvptx-newlib}.
4219 It can be automatically built together with GCC@.  For this, add a
4220 symbolic link to nvptx-newlib's @file{newlib} directory to the
4221 directory containing the GCC sources.
4223 Use the @option{--disable-sjlj-exceptions} and
4224 @option{--enable-newlib-io-long-long} options when configuring.
4226 @html
4227 <hr />
4228 @end html
4229 @anchor{powerpc-x-x}
4230 @heading powerpc-*-*
4231 You can specify a default version for the @option{-mcpu=@var{cpu_type}}
4232 switch by using the configure option @option{--with-cpu-@var{cpu_type}}.
4234 You will need GNU binutils 2.15 or newer.
4236 @html
4237 <hr />
4238 @end html
4239 @anchor{powerpc-x-darwin}
4240 @heading powerpc-*-darwin*
4241 PowerPC running Darwin (Mac OS X kernel).
4243 Pre-installed versions of Mac OS X may not include any developer tools,
4244 meaning that you will not be able to build GCC from source.  Tool
4245 binaries are available at
4246 @uref{https://opensource.apple.com}.
4248 This version of GCC requires at least cctools-590.36.  The
4249 cctools-590.36 package referenced from
4250 @uref{http://gcc.gnu.org/ml/gcc/2006-03/msg00507.html} will not work
4251 on systems older than 10.3.9 (aka darwin7.9.0).
4253 @html
4254 <hr />
4255 @end html
4256 @anchor{powerpc-x-elf}
4257 @heading powerpc-*-elf
4258 PowerPC system in big endian mode, running System V.4.
4260 @html
4261 <hr />
4262 @end html
4263 @anchor{powerpc-x-linux-gnu}
4264 @heading powerpc*-*-linux-gnu*
4265 PowerPC system in big endian mode running Linux.
4267 @html
4268 <hr />
4269 @end html
4270 @anchor{powerpc-x-netbsd}
4271 @heading powerpc-*-netbsd*
4272 PowerPC system in big endian mode running NetBSD@.
4274 @html
4275 <hr />
4276 @end html
4277 @anchor{powerpc-x-eabisim}
4278 @heading powerpc-*-eabisim
4279 Embedded PowerPC system in big endian mode for use in running under the
4280 PSIM simulator.
4282 @html
4283 <hr />
4284 @end html
4285 @anchor{powerpc-x-eabi}
4286 @heading powerpc-*-eabi
4287 Embedded PowerPC system in big endian mode.
4289 @html
4290 <hr />
4291 @end html
4292 @anchor{powerpcle-x-elf}
4293 @heading powerpcle-*-elf
4294 PowerPC system in little endian mode, running System V.4.
4296 @html
4297 <hr />
4298 @end html
4299 @anchor{powerpcle-x-eabisim}
4300 @heading powerpcle-*-eabisim
4301 Embedded PowerPC system in little endian mode for use in running under
4302 the PSIM simulator.
4304 @html
4305 <hr />
4306 @end html
4307 @anchor{powerpcle-x-eabi}
4308 @heading powerpcle-*-eabi
4309 Embedded PowerPC system in little endian mode.
4311 @html
4312 <hr />
4313 @end html
4314 @anchor{rl78-x-elf}
4315 @heading rl78-*-elf
4316 The Renesas RL78 processor.
4317 This configuration is intended for embedded systems.
4319 @html
4320 <hr />
4321 @end html
4322 @anchor{riscv32-x-elf}
4323 @heading riscv32-*-elf
4324 The RISC-V RV32 instruction set.
4325 This configuration is intended for embedded systems.
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{riscv32-x-linux}
4333 @heading riscv32-*-linux
4334 The RISC-V RV32 instruction set running GNU/Linux.
4335 This (and all other RISC-V) targets are supported upstream as of the
4336 binutils 2.28 release.
4338 @html
4339 <hr />
4340 @end html
4341 @anchor{riscv64-x-elf}
4342 @heading riscv64-*-elf
4343 The RISC-V RV64 instruction set.
4344 This configuration is intended for embedded systems.
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{riscv64-x-linux}
4352 @heading riscv64-*-linux
4353 The RISC-V RV64 instruction set running GNU/Linux.
4354 This (and all other RISC-V) targets are supported upstream as of the
4355 binutils 2.28 release.
4357 @html
4358 <hr />
4359 @end html
4360 @anchor{rx-x-elf}
4361 @heading rx-*-elf
4362 The Renesas RX processor.
4364 @html
4365 <hr />
4366 @end html
4367 @anchor{s390-x-linux}
4368 @heading s390-*-linux*
4369 S/390 system running GNU/Linux for S/390@.
4371 @html
4372 <hr />
4373 @end html
4374 @anchor{s390x-x-linux}
4375 @heading s390x-*-linux*
4376 zSeries system (64-bit) running GNU/Linux for zSeries@.
4378 @html
4379 <hr />
4380 @end html
4381 @anchor{s390x-ibm-tpf}
4382 @heading s390x-ibm-tpf*
4383 zSeries system (64-bit) running TPF@.  This platform is
4384 supported as cross-compilation target only.
4386 @html
4387 <hr />
4388 @end html
4389 @c Please use Solaris 2 to refer to all release of Solaris, starting
4390 @c with 2.0 until 2.6, 7, 8, etc.  Solaris 1 was a marketing name for
4391 @c SunOS 4 releases which we don't use to avoid confusion.  Solaris
4392 @c alone is too unspecific and must be avoided.
4393 @anchor{x-x-solaris2}
4394 @heading *-*-solaris2*
4395 Support for Solaris 9 has been removed in GCC 5.  Support for Solaris
4396 8 has been removed in GCC 4.8.  Support for Solaris 7 has been removed
4397 in GCC 4.6.
4399 Sun does not ship a C compiler with Solaris 2 before Solaris 10, though
4400 you can download the Sun Studio compilers for free.  In Solaris 10 and
4401 11, GCC 3.4.3 is available as @command{/usr/sfw/bin/gcc}.  Solaris 11
4402 also provides GCC 4.5.2, 4.7.3, and 4.8.2 as
4403 @command{/usr/gcc/4.5/bin/gcc} or similar.  Alternatively,
4404 you can install a pre-built GCC to bootstrap and install GCC.  See the
4405 @uref{binaries.html,,binaries page} for details.
4407 The Solaris 2 @command{/bin/sh} will often fail to configure
4408 @samp{libstdc++-v3}or @samp{boehm-gc}.  We therefore recommend using the
4409 following initial sequence of commands
4411 @smallexample
4412 % CONFIG_SHELL=/bin/ksh
4413 % export CONFIG_SHELL
4414 @end smallexample
4416 @noindent
4417 and proceed as described in @uref{configure.html,,the configure instructions}.
4418 In addition we strongly recommend specifying an absolute path to invoke
4419 @command{@var{srcdir}/configure}.
4421 Solaris 10 comes with a number of optional OS packages.  Some of these
4422 are needed to use GCC fully, namely @code{SUNWarc},
4423 @code{SUNWbtool}, @code{SUNWesu}, @code{SUNWhea}, @code{SUNWlibm},
4424 @code{SUNWsprot}, and @code{SUNWtoo}.  If you did not install all
4425 optional packages when installing Solaris 10, you will need to verify that
4426 the packages that GCC needs are installed.
4427 To check whether an optional package is installed, use
4428 the @command{pkginfo} command.  To add an optional package, use the
4429 @command{pkgadd} command.  For further details, see the Solaris 10
4430 documentation.
4432 Starting with Solaris 11, the package management has changed, so you
4433 need to check for @code{system/header}, @code{system/linker}, and
4434 @code{developer/assembler} packages.  Checking for and installing
4435 packages is done with the @command{pkg} command now.
4437 Trying to use the linker and other tools in
4438 @file{/usr/ucb} to install GCC has been observed to cause trouble.
4439 For example, the linker may hang indefinitely.  The fix is to remove
4440 @file{/usr/ucb} from your @env{PATH}.
4442 The build process works more smoothly with the legacy Sun tools so, if you
4443 have @file{/usr/xpg4/bin} in your @env{PATH}, we recommend that you place
4444 @file{/usr/bin} before @file{/usr/xpg4/bin} for the duration of the build.
4446 We recommend the use of the Solaris assembler or the GNU assembler, in
4447 conjunction with the Solaris linker.  The GNU @command{as}
4448 versions included in Solaris 10, from GNU binutils 2.15 (in
4449 @file{/usr/sfw/bin/gas}), and Solaris 11,
4450 from GNU binutils 2.19 or newer (also in @file{/usr/bin/gas} and
4451 @file{/usr/gnu/bin/as}), are known to work.
4452 Current versions of GNU binutils (2.26)
4453 are known to work as well, with the caveat mentioned in
4454 @uref{#ix86-x-solaris210,,i?86-*-solaris2.10} .  Note that your mileage may vary
4455 if you use a combination of the GNU tools and the Solaris tools: while the
4456 combination GNU @command{as} + Sun @command{ld} should reasonably work,
4457 the reverse combination Sun @command{as} + GNU @command{ld} may fail to
4458 build or cause memory corruption at runtime in some cases for C++ programs.
4459 @c FIXME: still?
4460 GNU @command{ld} usually works as well, although the version included in
4461 Solaris 10 cannot be used due to several bugs.  Again, the current
4462 version (2.26) is known to work, but generally lacks platform specific
4463 features, so better stay with Solaris @command{ld}.  To use the LTO linker
4464 plugin (@option{-fuse-linker-plugin}) with GNU @command{ld}, GNU
4465 binutils @emph{must} be configured with @option{--enable-largefile}.
4467 To enable symbol versioning in @samp{libstdc++} with the Solaris linker,
4468 you need to have any version of GNU @command{c++filt}, which is part of
4469 GNU binutils.  @samp{libstdc++} symbol versioning will be disabled if no
4470 appropriate version is found.  Solaris @command{c++filt} from the Solaris
4471 Studio compilers does @emph{not} work.
4473 Sun bug 4927647 sometimes causes random spurious testsuite failures
4474 related to missing diagnostic output.  This bug doesn't affect GCC
4475 itself, rather it is a kernel bug triggered by the @command{expect}
4476 program which is used only by the GCC testsuite driver.  When the bug
4477 causes the @command{expect} program to miss anticipated output, extra
4478 testsuite failures appear.
4480 @html
4481 <hr />
4482 @end html
4483 @anchor{sparc-x-x}
4484 @heading sparc*-*-*
4485 This section contains general configuration information for all
4486 SPARC-based platforms.  In addition to reading this section, please
4487 read all other sections that match your target.
4489 Newer versions of the GNU Multiple Precision Library (GMP), the MPFR
4490 library and the MPC library are known to be miscompiled by earlier
4491 versions of GCC on these platforms.  We therefore recommend the use
4492 of the exact versions of these libraries listed as minimal versions
4493 in @uref{prerequisites.html,,the prerequisites}.
4495 @html
4496 <hr />
4497 @end html
4498 @anchor{sparc-sun-solaris2}
4499 @heading sparc-sun-solaris2*
4500 When GCC is configured to use GNU binutils 2.14 or later, the binaries
4501 produced are smaller than the ones produced using Sun's native tools;
4502 this difference is quite significant for binaries containing debugging
4503 information.
4505 Starting with Solaris 7, the operating system is capable of executing
4506 64-bit SPARC V9 binaries.  GCC 3.1 and later properly supports
4507 this; the @option{-m64} option enables 64-bit code generation.
4508 However, if all you want is code tuned for the UltraSPARC CPU, you
4509 should try the @option{-mtune=ultrasparc} option instead, which produces
4510 code that, unlike full 64-bit code, can still run on non-UltraSPARC
4511 machines.
4513 When configuring the GNU Multiple Precision Library (GMP), the MPFR
4514 library or the MPC library on a Solaris 7 or later system, the canonical
4515 target triplet must be specified as the @command{build} parameter on the
4516 configure line.  This target triplet can be obtained by invoking @command{./config.guess} in the toplevel source directory of GCC (and
4517 not that of GMP or MPFR or MPC).  For example on a Solaris 9 system:
4519 @smallexample
4520 % ./configure --build=sparc-sun-solaris2.9 --prefix=xxx
4521 @end smallexample
4523 @html
4524 <hr />
4525 @end html
4526 @anchor{sparc-sun-solaris210}
4527 @heading sparc-sun-solaris2.10
4528 There is a bug in older versions of the Sun assembler which breaks
4529 thread-local storage (TLS).  A typical error message is
4531 @smallexample
4532 ld: fatal: relocation error: R_SPARC_TLS_LE_HIX22: file /var/tmp//ccamPA1v.o:
4533   symbol <unknown>: bad symbol type SECT: symbol type must be TLS
4534 @end smallexample
4536 @noindent
4537 This bug is fixed in Sun patch 118683-03 or later.
4539 @html
4540 <hr />
4541 @end html
4542 @anchor{sparc-x-linux}
4543 @heading sparc-*-linux*
4545 @html
4546 <hr />
4547 @end html
4548 @anchor{sparc64-x-solaris2}
4549 @heading sparc64-*-solaris2*
4550 When configuring the GNU Multiple Precision Library (GMP), the MPFR
4551 library or the MPC library, the canonical target triplet must be specified
4552 as the @command{build} parameter on the configure line.  For example
4553 on a Solaris 9 system:
4555 @smallexample
4556 % ./configure --build=sparc64-sun-solaris2.9 --prefix=xxx
4557 @end smallexample
4559 @html
4560 <hr />
4561 @end html
4562 @anchor{sparcv9-x-solaris2}
4563 @heading sparcv9-*-solaris2*
4564 This is a synonym for @samp{sparc64-*-solaris2*}.
4566 @html
4567 <hr />
4568 @end html
4569 @anchor{c6x-x-x}
4570 @heading c6x-*-*
4571 The C6X family of processors. This port requires binutils-2.22 or newer.
4573 @html
4574 <hr />
4575 @end html
4576 @anchor{tilegx-*-linux}
4577 @heading tilegx-*-linux*
4578 The TILE-Gx processor in little endian mode, running GNU/Linux.  This
4579 port requires binutils-2.22 or newer.
4581 @html
4582 <hr />
4583 @end html
4584 @anchor{tilegxbe-*-linux}
4585 @heading tilegxbe-*-linux*
4586 The TILE-Gx processor in big endian mode, running GNU/Linux.  This
4587 port requires binutils-2.23 or newer.
4589 @html
4590 <hr />
4591 @end html
4592 @anchor{tilepro-*-linux}
4593 @heading tilepro-*-linux*
4594 The TILEPro processor running GNU/Linux.  This port requires
4595 binutils-2.22 or newer.
4597 @html
4598 <hr />
4599 @end html
4600 @anchor{visium-x-elf}
4601 @heading visium-*-elf
4602 CDS VISIUMcore processor.
4603 This configuration is intended for embedded systems.
4605 @html
4606 <hr />
4607 @end html
4608 @anchor{x-x-vxworks}
4609 @heading *-*-vxworks*
4610 Support for VxWorks is in flux.  At present GCC supports @emph{only} the
4611 very recent VxWorks 5.5 (aka Tornado 2.2) release, and only on PowerPC@.
4612 We welcome patches for other architectures supported by VxWorks 5.5.
4613 Support for VxWorks AE would also be welcome; we believe this is merely
4614 a matter of writing an appropriate ``configlette'' (see below).  We are
4615 not interested in supporting older, a.out or COFF-based, versions of
4616 VxWorks in GCC 3.
4618 VxWorks comes with an older version of GCC installed in
4619 @file{@var{$WIND_BASE}/host}; we recommend you do not overwrite it.
4620 Choose an installation @var{prefix} entirely outside @var{$WIND_BASE}.
4621 Before running @command{configure}, create the directories @file{@var{prefix}}
4622 and @file{@var{prefix}/bin}.  Link or copy the appropriate assembler,
4623 linker, etc.@: into @file{@var{prefix}/bin}, and set your @var{PATH} to
4624 include that directory while running both @command{configure} and
4625 @command{make}.
4627 You must give @command{configure} the
4628 @option{--with-headers=@var{$WIND_BASE}/target/h} switch so that it can
4629 find the VxWorks system headers.  Since VxWorks is a cross compilation
4630 target only, you must also specify @option{--target=@var{target}}.
4631 @command{configure} will attempt to create the directory
4632 @file{@var{prefix}/@var{target}/sys-include} and copy files into it;
4633 make sure the user running @command{configure} has sufficient privilege
4634 to do so.
4636 GCC's exception handling runtime requires a special ``configlette''
4637 module, @file{contrib/gthr_supp_vxw_5x.c}.  Follow the instructions in
4638 that file to add the module to your kernel build.  (Future versions of
4639 VxWorks will incorporate this module.)
4641 @html
4642 <hr />
4643 @end html
4644 @anchor{x86-64-x-x}
4645 @heading x86_64-*-*, amd64-*-*
4646 GCC supports the x86-64 architecture implemented by the AMD64 processor
4647 (amd64-*-* is an alias for x86_64-*-*) on GNU/Linux, FreeBSD and NetBSD@.
4648 On GNU/Linux the default is a bi-arch compiler which is able to generate
4649 both 64-bit x86-64 and 32-bit x86 code (via the @option{-m32} switch).
4651 @html
4652 <hr />
4653 @end html
4654 @anchor{x86-64-x-solaris210}
4655 @heading x86_64-*-solaris2.1[0-9]*
4656 GCC also supports the x86-64 architecture implemented by the AMD64
4657 processor (@samp{amd64-*-*} is an alias for @samp{x86_64-*-*}) on
4658 Solaris 10 or later.  Unlike other systems, without special options a
4659 bi-arch compiler is built which generates 32-bit code by default, but
4660 can generate 64-bit x86-64 code with the @option{-m64} switch.  Since
4661 GCC 4.7, there is also a configuration that defaults to 64-bit code, but
4662 can generate 32-bit code with @option{-m32}.  To configure and build
4663 this way, you have to provide all support libraries like @file{libgmp}
4664 as 64-bit code, configure with @option{--target=x86_64-pc-solaris2.1x}
4665 and @samp{CC=gcc -m64}.
4667 @html
4668 <hr />
4669 @end html
4670 @anchor{xtensa-x-elf}
4671 @heading xtensa*-*-elf
4672 This target is intended for embedded Xtensa systems using the
4673 @samp{newlib} C library.  It uses ELF but does not support shared
4674 objects.  Designed-defined instructions specified via the
4675 Tensilica Instruction Extension (TIE) language are only supported
4676 through inline assembly.
4678 The Xtensa configuration information must be specified prior to
4679 building GCC@.  The @file{include/xtensa-config.h} header
4680 file contains the configuration information.  If you created your
4681 own Xtensa configuration with the Xtensa Processor Generator, the
4682 downloaded files include a customized copy of this header file,
4683 which you can use to replace the default header file.
4685 @html
4686 <hr />
4687 @end html
4688 @anchor{xtensa-x-linux}
4689 @heading xtensa*-*-linux*
4690 This target is for Xtensa systems running GNU/Linux.  It supports ELF
4691 shared objects and the GNU C library (glibc).  It also generates
4692 position-independent code (PIC) regardless of whether the
4693 @option{-fpic} or @option{-fPIC} options are used.  In other
4694 respects, this target is the same as the
4695 @uref{#xtensa*-*-elf,,@samp{xtensa*-*-elf}} target.
4697 @html
4698 <hr />
4699 @end html
4700 @anchor{windows}
4701 @heading Microsoft Windows
4703 @subheading Intel 16-bit versions
4704 The 16-bit versions of Microsoft Windows, such as Windows 3.1, are not
4705 supported.
4707 However, the 32-bit port has limited support for Microsoft
4708 Windows 3.11 in the Win32s environment, as a target only.  See below.
4710 @subheading Intel 32-bit versions
4711 The 32-bit versions of Windows, including Windows 95, Windows NT, Windows
4712 XP, and Windows Vista, are supported by several different target
4713 platforms.  These targets differ in which Windows subsystem they target
4714 and which C libraries are used.
4716 @itemize
4717 @item Cygwin @uref{#x-x-cygwin,,*-*-cygwin}: Cygwin provides a user-space
4718 Linux API emulation layer in the Win32 subsystem.
4719 @item MinGW @uref{#x-x-mingw32,,*-*-mingw32}: MinGW is a native GCC port for
4720 the Win32 subsystem that provides a subset of POSIX.
4721 @item MKS i386-pc-mks: NuTCracker from MKS.  See
4722 @uref{http://www.mkssoftware.com/} for more information.
4723 @end itemize
4725 @subheading Intel 64-bit versions
4726 GCC contains support for x86-64 using the mingw-w64
4727 runtime library, available from @uref{http://mingw-w64.org/doku.php}.
4728 This library should be used with the target triple x86_64-pc-mingw32.
4730 Presently Windows for Itanium is not supported.
4732 @subheading Windows CE
4733 Windows CE is supported as a target only on Hitachi
4734 SuperH (sh-wince-pe), and MIPS (mips-wince-pe).
4736 @subheading Other Windows Platforms
4737 GCC no longer supports Windows NT on the Alpha or PowerPC.
4739 GCC no longer supports the Windows POSIX subsystem.  However, it does
4740 support the Interix subsystem.  See above.
4742 Old target names including *-*-winnt and *-*-windowsnt are no longer used.
4744 PW32 (i386-pc-pw32) support was never completed, and the project seems to
4745 be inactive.  See @uref{http://pw32.sourceforge.net/} for more information.
4747 UWIN support has been removed due to a lack of maintenance.
4749 @html
4750 <hr />
4751 @end html
4752 @anchor{x-x-cygwin}
4753 @heading *-*-cygwin
4754 Ports of GCC are included with the
4755 @uref{http://www.cygwin.com/,,Cygwin environment}.
4757 GCC will build under Cygwin without modification; it does not build
4758 with Microsoft's C++ compiler and there are no plans to make it do so.
4760 The Cygwin native compiler can be configured to target any 32-bit x86
4761 cpu architecture desired; the default is i686-pc-cygwin.  It should be
4762 used with as up-to-date a version of binutils as possible; use either
4763 the latest official GNU binutils release in the Cygwin distribution,
4764 or version 2.20 or above if building your own.
4766 @html
4767 <hr />
4768 @end html
4769 @anchor{x-x-mingw32}
4770 @heading *-*-mingw32
4771 GCC will build with and support only MinGW runtime 3.12 and later.
4772 Earlier versions of headers are incompatible with the new default semantics
4773 of @code{extern inline} in @code{-std=c99} and @code{-std=gnu99} modes.
4775 @html
4776 <hr />
4777 @end html
4778 @anchor{older}
4779 @heading Older systems
4780 GCC contains support files for many older (1980s and early
4781 1990s) Unix variants.  For the most part, support for these systems
4782 has not been deliberately removed, but it has not been maintained for
4783 several years and may suffer from bitrot.
4785 Starting with GCC 3.1, each release has a list of ``obsoleted'' systems.
4786 Support for these systems is still present in that release, but
4787 @command{configure} will fail unless the @option{--enable-obsolete}
4788 option is given.  Unless a maintainer steps forward, support for these
4789 systems will be removed from the next release of GCC@.
4791 Support for old systems as hosts for GCC can cause problems if the
4792 workarounds for compiler, library and operating system bugs affect the
4793 cleanliness or maintainability of the rest of GCC@.  In some cases, to
4794 bring GCC up on such a system, if still possible with current GCC, may
4795 require first installing an old version of GCC which did work on that
4796 system, and using it to compile a more recent GCC, to avoid bugs in the
4797 vendor compiler.  Old releases of GCC 1 and GCC 2 are available in the
4798 @file{old-releases} directory on the @uref{../mirrors.html,,GCC mirror
4799 sites}.  Header bugs may generally be avoided using
4800 @command{fixincludes}, but bugs or deficiencies in libraries and the
4801 operating system may still cause problems.
4803 Support for older systems as targets for cross-compilation is less
4804 problematic than support for them as hosts for GCC; if an enthusiast
4805 wishes to make such a target work again (including resurrecting any of
4806 the targets that never worked with GCC 2, starting from the last
4807 version before they were removed), patches
4808 @uref{../contribute.html,,following the usual requirements} would be
4809 likely to be accepted, since they should not affect the support for more
4810 modern targets.
4812 For some systems, old versions of GNU binutils may also be useful,
4813 and are available from @file{pub/binutils/old-releases} on
4814 @uref{https://sourceware.org/mirrors.html,,sourceware.org mirror sites}.
4816 Some of the information on specific systems above relates to
4817 such older systems, but much of the information
4818 about GCC on such systems (which may no longer be applicable to
4819 current GCC) is to be found in the GCC texinfo manual.
4821 @html
4822 <hr />
4823 @end html
4824 @anchor{elf}
4825 @heading all ELF targets (SVR4, Solaris 2, etc.)
4826 C++ support is significantly better on ELF targets if you use the
4827 @uref{./configure.html#with-gnu-ld,,GNU linker}; duplicate copies of
4828 inlines, vtables and template instantiations will be discarded
4829 automatically.
4832 @html
4833 <hr />
4835 @end html
4836 @ifhtml
4837 @uref{./index.html,,Return to the GCC Installation page}
4838 @end ifhtml
4839 @end ifset
4841 @c ***Old documentation******************************************************
4842 @ifset oldhtml
4843 @include install-old.texi
4844 @html
4845 <hr />
4847 @end html
4848 @ifhtml
4849 @uref{./index.html,,Return to the GCC Installation page}
4850 @end ifhtml
4851 @end ifset
4853 @c ***GFDL********************************************************************
4854 @ifset gfdlhtml
4855 @include fdl.texi
4856 @html
4857 <hr />
4859 @end html
4860 @ifhtml
4861 @uref{./index.html,,Return to the GCC Installation page}
4862 @end ifhtml
4863 @end ifset
4865 @c ***************************************************************************
4866 @c Part 6 The End of the Document
4867 @ifinfo
4868 @comment node-name,     next,          previous, up
4869 @node    Concept Index, , GNU Free Documentation License, Top
4870 @end ifinfo
4872 @ifinfo
4873 @unnumbered Concept Index
4875 @printindex cp
4877 @contents
4878 @end ifinfo
4879 @bye