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