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