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