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