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