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