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