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