PR other/54324
[official-gcc.git] / gcc / doc / install.texi
blob8273a87a361d54ef47e401ff9f16789260e68361
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
10 @include gcc-common.texi
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
47 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
48 @c 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
49 @c 2010, 2011 Free Software Foundation, Inc.
50 @c *** Converted to texinfo by Dean Wakerley, dean@wakerley.com
52 @c IMPORTANT: whenever you modify this file, run `install.texi2html' to
53 @c test the generation of HTML documents for the gcc.gnu.org web pages.
55 @c Do not use @footnote{} in this file as it breaks install.texi2html!
57 @c Include everything if we're not making html
58 @ifnothtml
59 @set indexhtml
60 @set specifichtml
61 @set prerequisiteshtml
62 @set downloadhtml
63 @set configurehtml
64 @set buildhtml
65 @set testhtml
66 @set finalinstallhtml
67 @set binarieshtml
68 @set oldhtml
69 @set gfdlhtml
70 @end ifnothtml
72 @c Part 2 Summary Description and Copyright
73 @copying
74 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
75 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
76 2010 Free Software Foundation, Inc.
77 @sp 1
78 Permission is granted to copy, distribute and/or modify this document
79 under the terms of the GNU Free Documentation License, Version 1.3 or
80 any later version published by the Free Software Foundation; with no
81 Invariant Sections, the Front-Cover texts being (a) (see below), and
82 with the Back-Cover Texts being (b) (see below).  A copy of the
83 license is included in the section entitled ``@uref{./gfdl.html,,GNU
84 Free Documentation License}''.
86 (a) The FSF's Front-Cover Text is:
88      A GNU Manual
90 (b) The FSF's Back-Cover Text is:
92      You have freedom to copy and modify this GNU Manual, like GNU
93      software.  Copies published by the Free Software Foundation raise
94      funds for GNU development.
95 @end copying
96 @ifinfo
97 @insertcopying
98 @end ifinfo
99 @dircategory Software development
100 @direntry
101 * gccinstall: (gccinstall).    Installing the GNU Compiler Collection.
102 @end direntry
104 @c Part 3 Titlepage and Copyright
105 @titlepage
106 @title Installing GCC
107 @versionsubtitle
109 @c The following two commands start the copyright page.
110 @page
111 @vskip 0pt plus 1filll
112 @insertcopying
113 @end titlepage
115 @c Part 4 Top node, Master Menu, and/or Table of Contents
116 @ifinfo
117 @node    Top, , , (dir)
118 @comment node-name, next,          Previous, up
120 @menu
121 * Installing GCC::  This document describes the generic installation
122                     procedure for GCC as well as detailing some target
123                     specific installation instructions.
125 * Specific::        Host/target specific installation notes for GCC.
126 * Binaries::        Where to get pre-compiled binaries.
128 * Old::             Old installation documentation.
130 * GNU Free Documentation License:: How you can copy and share this manual.
131 * Concept Index::   This index has two entries.
132 @end menu
133 @end ifinfo
135 @iftex
136 @contents
137 @end iftex
139 @c Part 5 The Body of the Document
140 @c ***Installing GCC**********************************************************
141 @ifnothtml
142 @comment node-name,     next,          previous, up
143 @node    Installing GCC, Binaries, , Top
144 @end ifnothtml
145 @ifset indexhtml
146 @ifnothtml
147 @chapter Installing GCC
148 @end ifnothtml
150 The latest version of this document is always available at
151 @uref{http://gcc.gnu.org/install/,,http://gcc.gnu.org/install/}.
152 It refers to the current development sources, instructions for
153 specific released versions are included with the sources.
155 This document describes the generic installation procedure for GCC as well
156 as detailing some target specific installation instructions.
158 GCC includes several components that previously were separate distributions
159 with their own installation instructions.  This document supersedes all
160 package-specific installation instructions.
162 @emph{Before} starting the build/install procedure please check the
163 @ifnothtml
164 @ref{Specific, host/target specific installation notes}.
165 @end ifnothtml
166 @ifhtml
167 @uref{specific.html,,host/target specific installation notes}.
168 @end ifhtml
169 We recommend you browse the entire generic installation instructions before
170 you proceed.
172 Lists of successful builds for released versions of GCC are
173 available at @uref{http://gcc.gnu.org/buildstat.html}.
174 These lists are updated as new information becomes available.
176 The installation procedure itself is broken into five steps.
178 @ifinfo
179 @menu
180 * Prerequisites::
181 * Downloading the source::
182 * Configuration::
183 * Building::
184 * Testing:: (optional)
185 * Final install::
186 @end menu
187 @end ifinfo
188 @ifhtml
189 @enumerate
190 @item
191 @uref{prerequisites.html,,Prerequisites}
192 @item
193 @uref{download.html,,Downloading the source}
194 @item
195 @uref{configure.html,,Configuration}
196 @item
197 @uref{build.html,,Building}
198 @item
199 @uref{test.html,,Testing} (optional)
200 @item
201 @uref{finalinstall.html,,Final install}
202 @end enumerate
203 @end ifhtml
205 Please note that GCC does not support @samp{make uninstall} and probably
206 won't do so in the near future as this would open a can of worms.  Instead,
207 we suggest that you install GCC into a directory of its own and simply
208 remove that directory when you do not need that specific version of GCC
209 any longer, and, if shared libraries are installed there as well, no
210 more binaries exist that use them.
212 @ifhtml
213 There are also some @uref{old.html,,old installation instructions},
214 which are mostly obsolete but still contain some information which has
215 not yet been merged into the main part of this manual.
216 @end ifhtml
218 @html
219 <hr />
221 @end html
222 @ifhtml
223 @uref{./index.html,,Return to the GCC Installation page}
225 @insertcopying
226 @end ifhtml
227 @end ifset
229 @c ***Prerequisites**************************************************
230 @ifnothtml
231 @comment node-name,     next,          previous, up
232 @node    Prerequisites, Downloading the source, , Installing GCC
233 @end ifnothtml
234 @ifset prerequisiteshtml
235 @ifnothtml
236 @chapter Prerequisites
237 @end ifnothtml
238 @cindex Prerequisites
240 GCC requires that various tools and packages be available for use in the
241 build procedure.  Modifying GCC sources requires additional tools
242 described below.
244 @heading Tools/packages necessary for building GCC
245 @table @asis
246 @item ISO C++98 compiler
247 Necessary to bootstrap GCC, although versions of GCC prior
248 to 4.8 also allow bootstrapping with a ISO C89 compiler and versions
249 of GCC prior to 3.4 also allow bootstrapping with a traditional
250 (K&R) C compiler.
252 To build all languages in a cross-compiler or other configuration where
253 3-stage bootstrap is not performed, you need to start with an existing
254 GCC binary (version 3.4 or later) because source code for language
255 frontends other than C might use GCC extensions.
257 Note that to bootstrap GCC with versions of GCC earlier than 3.4, you
258 may need to use @option{--disable-stage1-checking}, though
259 bootstrapping the compiler with such earlier compilers is strongly
260 discouraged.
262 @item GNAT
264 In order to build the Ada compiler (GNAT) you must already have GNAT
265 installed because portions of the Ada frontend are written in Ada (with
266 GNAT extensions.)  Refer to the Ada installation instructions for more
267 specific information.
269 @item A ``working'' POSIX compatible shell, or GNU bash
271 Necessary when running @command{configure} because some
272 @command{/bin/sh} shells have bugs and may crash when configuring the
273 target libraries.  In other cases, @command{/bin/sh} or @command{ksh}
274 have disastrous corner-case performance problems.  This
275 can cause target @command{configure} runs to literally take days to
276 complete in some cases.
278 So on some platforms @command{/bin/ksh} is sufficient, on others it
279 isn't.  See the host/target specific instructions for your platform, or
280 use @command{bash} to be sure.  Then set @env{CONFIG_SHELL} in your
281 environment to your ``good'' shell prior to running
282 @command{configure}/@command{make}.
284 @command{zsh} is not a fully compliant POSIX shell and will not
285 work when configuring GCC@.
287 @item A POSIX or SVR4 awk
289 Necessary for creating some of the generated source files for GCC@.
290 If in doubt, use a recent GNU awk version, as some of the older ones
291 are broken.  GNU awk version 3.1.5 is known to work.
293 @item GNU binutils
295 Necessary in some circumstances, optional in others.  See the
296 host/target specific instructions for your platform for the exact
297 requirements.
299 @item gzip version 1.2.4 (or later) or
300 @itemx bzip2 version 1.0.2 (or later)
302 Necessary to uncompress GCC @command{tar} files when source code is
303 obtained via FTP mirror sites.
305 @item GNU make version 3.80 (or later)
307 You must have GNU make installed to build GCC@.
309 @item GNU tar version 1.14 (or later)
311 Necessary (only on some platforms) to untar the source code.  Many
312 systems' @command{tar} programs will also work, only try GNU
313 @command{tar} if you have problems.
315 @item Perl version 5.6.1 (or later)
317 Necessary when targeting Darwin, building @samp{libstdc++},
318 and not using @option{--disable-symvers}.
319 Necessary when targeting Solaris 2 with Sun @command{ld} and not using
320 @option{--disable-symvers}.  The bundled @command{perl} in Solaris@tie{}8
321 and up works.
323 Necessary when regenerating @file{Makefile} dependencies in libiberty.
324 Necessary when regenerating @file{libiberty/functions.texi}.
325 Necessary when generating manpages from Texinfo manuals.
326 Used by various scripts to generate some files included in SVN (mainly
327 Unicode-related and rarely changing) from source tables.
329 @item @command{jar}, or InfoZIP (@command{zip} and @command{unzip})
331 Necessary to build libgcj, the GCJ runtime.
333 @end table
335 Several support libraries are necessary to build GCC, some are required,
336 others optional.  While any sufficiently new version of required tools
337 usually work, library requirements are generally stricter.  Newer
338 versions may work in some cases, but it's safer to use the exact
339 versions documented.  We appreciate bug reports about problems with
340 newer versions, though.  If your OS vendor provides packages for the
341 support libraries then using those packages may be the simplest way to
342 install the libraries.
344 @table @asis
345 @item GNU Multiple Precision Library (GMP) version 4.3.2 (or later)
347 Necessary to build GCC@.  If a GMP source distribution is found in a
348 subdirectory of your GCC sources named @file{gmp}, it will be built
349 together with GCC.  Alternatively, if GMP is already installed but it
350 is not in your library search path, you will have to configure with the
351 @option{--with-gmp} configure option.  See also @option{--with-gmp-lib}
352 and @option{--with-gmp-include}.
354 @item MPFR Library version 2.4.2 (or later)
356 Necessary to build GCC@.  It can be downloaded from
357 @uref{http://www.mpfr.org/}.  If an MPFR source distribution is found
358 in a subdirectory of your GCC sources named @file{mpfr}, it will be
359 built together with GCC.  Alternatively, if MPFR is already installed
360 but it is not in your default library search path, the
361 @option{--with-mpfr} configure option should be used.  See also
362 @option{--with-mpfr-lib} and @option{--with-mpfr-include}.
364 @item MPC Library version 0.8.1 (or later)
366 Necessary to build GCC@.  It can be downloaded from
367 @uref{http://www.multiprecision.org/}.  If an MPC source distribution
368 is found in a subdirectory of your GCC sources named @file{mpc}, it
369 will be built together with GCC.  Alternatively, if MPC is already
370 installed but it is not in your default library search path, the
371 @option{--with-mpc} configure option should be used.  See also
372 @option{--with-mpc-lib} and @option{--with-mpc-include}.
374 @item ISL Library version 0.10
376 Necessary to build GCC with the Graphite loop optimizations.
377 It can be downloaded from @uref{ftp://gcc.gnu.org/pub/gcc/infrastructure/}.
379 The @option{--with-isl} configure option should be used if ISL is not
380 installed in your default library search path.
382 @item CLooG 0.17.0
384 Necessary to build GCC with the Graphite loop optimizations.  It can be
385 downloaded from @uref{ftp://gcc.gnu.org/pub/gcc/infrastructure/} as
386 @file{cloog-0.17.0.tar.gz}.  The @option{--with-cloog} configure option should
387 be used if CLooG is not installed in your default library search path.
388 CLooG needs to be built against ISL 0.10, not its included copy of ISL
389 which is too old.  Use @option{--with-isl=system} to direct CLooG to pick
390 up an already installed ISL.  CLooG needs to be configured to use GMP
391 internally, use @option{--with-bits=gmp} to direct it to do that.
393 @end table
395 @heading Tools/packages necessary for modifying GCC
396 @table @asis
397 @item autoconf version 2.64
398 @itemx GNU m4 version 1.4.6 (or later)
400 Necessary when modifying @file{configure.ac}, @file{aclocal.m4}, etc.@:
401 to regenerate @file{configure} and @file{config.in} files.
403 @item automake version 1.11.1
405 Necessary when modifying a @file{Makefile.am} file to regenerate its
406 associated @file{Makefile.in}.
408 Much of GCC does not use automake, so directly edit the @file{Makefile.in}
409 file.  Specifically this applies to the @file{gcc}, @file{intl},
410 @file{libcpp}, @file{libiberty}, @file{libobjc} directories as well
411 as any of their subdirectories.
413 For directories that use automake, GCC requires the latest release in
414 the 1.11 series, which is currently 1.11.1.  When regenerating a directory
415 to a newer version, please update all the directories using an older 1.11
416 to the latest released version.
418 @item gettext version 0.14.5 (or later)
420 Needed to regenerate @file{gcc.pot}.
422 @item gperf version 2.7.2 (or later)
424 Necessary when modifying @command{gperf} input files, e.g.@:
425 @file{gcc/cp/cfns.gperf} to regenerate its associated header file, e.g.@:
426 @file{gcc/cp/cfns.h}.
428 @item DejaGnu 1.4.4
429 @itemx Expect
430 @itemx Tcl
432 Necessary to run the GCC testsuite; see the section on testing for details.
434 @item autogen version 5.5.4 (or later) and
435 @itemx guile version 1.4.1 (or later)
437 Necessary to regenerate @file{fixinc/fixincl.x} from
438 @file{fixinc/inclhack.def} and @file{fixinc/*.tpl}.
440 Necessary to run @samp{make check} for @file{fixinc}.
442 Necessary to regenerate the top level @file{Makefile.in} file from
443 @file{Makefile.tpl} and @file{Makefile.def}.
445 @item Flex version 2.5.4 (or later)
447 Necessary when modifying @file{*.l} files.
449 Necessary to build GCC during development because the generated output
450 files are not included in the SVN repository.  They are included in
451 releases.
453 @item Texinfo version 4.7 (or later)
455 Necessary for running @command{makeinfo} when modifying @file{*.texi}
456 files to test your changes.
458 Necessary for running @command{make dvi} or @command{make pdf} to
459 create printable documentation in DVI or PDF format.  Texinfo version
460 4.8 or later is required for @command{make pdf}.
462 Necessary to build GCC documentation during development because the
463 generated output files are not included in the SVN repository.  They are
464 included in releases.
466 @item @TeX{} (any working version)
468 Necessary for running @command{texi2dvi} and @command{texi2pdf}, which
469 are used when running @command{make dvi} or @command{make pdf} to create
470 DVI or PDF files, respectively.
472 @item SVN (any version)
473 @itemx SSH (any version)
475 Necessary to access the SVN repository.  Public releases and weekly
476 snapshots of the development sources are also available via FTP@.
478 @item GNU diffutils version 2.7 (or later)
480 Useful when submitting patches for the GCC source code.
482 @item patch version 2.5.4 (or later)
484 Necessary when applying patches, created with @command{diff}, to one's
485 own sources.
487 @item ecj1
488 @itemx gjavah
490 If you wish to modify @file{.java} files in libjava, you will need to
491 configure with @option{--enable-java-maintainer-mode}, and you will need
492 to have executables named @command{ecj1} and @command{gjavah} in your path.
493 The @command{ecj1} executable should run the Eclipse Java compiler via
494 the GCC-specific entry point.  You can download a suitable jar from
495 @uref{ftp://sourceware.org/pub/java/}, or by running the script
496 @command{contrib/download_ecj}.
498 @item antlr.jar version 2.7.1 (or later)
499 @itemx antlr binary
501 If you wish to build the @command{gjdoc} binary in libjava, you will
502 need to have an @file{antlr.jar} library available. The library is
503 searched for in system locations but can be specified with
504 @option{--with-antlr-jar=} instead.  When configuring with
505 @option{--enable-java-maintainer-mode}, you will need to have one of
506 the executables named @command{cantlr}, @command{runantlr} or
507 @command{antlr} in your path.
509 @end table
511 @html
512 <hr />
514 @end html
515 @ifhtml
516 @uref{./index.html,,Return to the GCC Installation page}
517 @end ifhtml
518 @end ifset
520 @c ***Downloading the source**************************************************
521 @ifnothtml
522 @comment node-name,     next,          previous, up
523 @node    Downloading the source, Configuration, Prerequisites, Installing GCC
524 @end ifnothtml
525 @ifset downloadhtml
526 @ifnothtml
527 @chapter Downloading GCC
528 @end ifnothtml
529 @cindex Downloading GCC
530 @cindex Downloading the Source
532 GCC is distributed via @uref{http://gcc.gnu.org/svn.html,,SVN} and FTP
533 tarballs compressed with @command{gzip} or
534 @command{bzip2}.  It is possible to download a full distribution or specific
535 components.
537 Please refer to the @uref{http://gcc.gnu.org/releases.html,,releases web page}
538 for information on how to obtain GCC@.
540 The full distribution includes the C, C++, Objective-C, Fortran, Java,
541 and Ada (in the case of GCC 3.1 and later) compilers.  The full
542 distribution also includes runtime libraries for C++, Objective-C,
543 Fortran, and Java.  In GCC 3.0 and later versions, the GNU compiler
544 testsuites are also included in the full distribution.
546 If you choose to download specific components, you must download the core
547 GCC distribution plus any language specific distributions you wish to
548 use.  The core distribution includes the C language front end as well as the
549 shared components.  Each language has a tarball which includes the language
550 front end as well as the language runtime (when appropriate).
552 Unpack the core distribution as well as any language specific
553 distributions in the same directory.
555 If you also intend to build binutils (either to upgrade an existing
556 installation or for use in place of the corresponding tools of your
557 OS), unpack the binutils distribution either in the same directory or
558 a separate one.  In the latter case, add symbolic links to any
559 components of the binutils you intend to build alongside the compiler
560 (@file{bfd}, @file{binutils}, @file{gas}, @file{gprof}, @file{ld},
561 @file{opcodes}, @dots{}) to the directory containing the GCC sources.
563 Likewise the GMP, MPFR and MPC libraries can be automatically built
564 together with GCC.  Unpack the GMP, MPFR and/or MPC source
565 distributions in the directory containing the GCC sources and rename
566 their directories to @file{gmp}, @file{mpfr} and @file{mpc},
567 respectively (or use symbolic links with the same name).
569 @html
570 <hr />
572 @end html
573 @ifhtml
574 @uref{./index.html,,Return to the GCC Installation page}
575 @end ifhtml
576 @end ifset
578 @c ***Configuration***********************************************************
579 @ifnothtml
580 @comment node-name,     next,          previous, up
581 @node    Configuration, Building, Downloading the source, Installing GCC
582 @end ifnothtml
583 @ifset configurehtml
584 @ifnothtml
585 @chapter Installing GCC: Configuration
586 @end ifnothtml
587 @cindex Configuration
588 @cindex Installing GCC: Configuration
590 Like most GNU software, GCC must be configured before it can be built.
591 This document describes the recommended configuration procedure
592 for both native and cross targets.
594 We use @var{srcdir} to refer to the toplevel source directory for
595 GCC; we use @var{objdir} to refer to the toplevel build/object directory.
597 If you obtained the sources via SVN, @var{srcdir} must refer to the top
598 @file{gcc} directory, the one where the @file{MAINTAINERS} file can be
599 found, and not its @file{gcc} subdirectory, otherwise the build will fail.
601 If either @var{srcdir} or @var{objdir} is located on an automounted NFS
602 file system, the shell's built-in @command{pwd} command will return
603 temporary pathnames.  Using these can lead to various sorts of build
604 problems.  To avoid this issue, set the @env{PWDCMD} environment
605 variable to an automounter-aware @command{pwd} command, e.g.,
606 @command{pawd} or @samp{amq -w}, during the configuration and build
607 phases.
609 First, we @strong{highly} recommend that GCC be built into a
610 separate directory from the sources which does @strong{not} reside
611 within the source tree.  This is how we generally build GCC; building
612 where @var{srcdir} == @var{objdir} should still work, but doesn't
613 get extensive testing; building where @var{objdir} is a subdirectory
614 of @var{srcdir} is unsupported.
616 If you have previously built GCC in the same directory for a
617 different target machine, do @samp{make distclean} to delete all files
618 that might be invalid.  One of the files this deletes is @file{Makefile};
619 if @samp{make distclean} complains that @file{Makefile} does not exist
620 or issues a message like ``don't know how to make distclean'' it probably
621 means that the directory is already suitably clean.  However, with the
622 recommended method of building in a separate @var{objdir}, you should
623 simply use a different @var{objdir} for each target.
625 Second, when configuring a native system, either @command{cc} or
626 @command{gcc} must be in your path or you must set @env{CC} in
627 your environment before running configure.  Otherwise the configuration
628 scripts may fail.
630 @ignore
631 Note that the bootstrap compiler and the resulting GCC must be link
632 compatible, else the bootstrap will fail with linker errors about
633 incompatible object file formats.  Several multilibed targets are
634 affected by this requirement, see
635 @ifnothtml
636 @ref{Specific, host/target specific installation notes}.
637 @end ifnothtml
638 @ifhtml
639 @uref{specific.html,,host/target specific installation notes}.
640 @end ifhtml
641 @end ignore
643 To configure GCC:
645 @smallexample
646 % mkdir @var{objdir}
647 % cd @var{objdir}
648 % @var{srcdir}/configure [@var{options}] [@var{target}]
649 @end smallexample
651 @heading Distributor options
653 If you will be distributing binary versions of GCC, with modifications
654 to the source code, you should use the options described in this
655 section to make clear that your version contains modifications.
657 @table @code
658 @item --with-pkgversion=@var{version}
659 Specify a string that identifies your package.  You may wish
660 to include a build number or build date.  This version string will be
661 included in the output of @command{gcc --version}.  This suffix does
662 not replace the default version string, only the @samp{GCC} part.
664 The default value is @samp{GCC}.
666 @item --with-bugurl=@var{url}
667 Specify the URL that users should visit if they wish to report a bug.
668 You are of course welcome to forward bugs reported to you to the FSF,
669 if you determine that they are not bugs in your modifications.
671 The default value refers to the FSF's GCC bug tracker.
673 @end table
675 @heading Target specification
676 @itemize @bullet
677 @item
678 GCC has code to correctly determine the correct value for @var{target}
679 for nearly all native systems.  Therefore, we highly recommend you do
680 not provide a configure target when configuring a native compiler.
682 @item
683 @var{target} must be specified as @option{--target=@var{target}}
684 when configuring a cross compiler; examples of valid targets would be
685 m68k-elf, sh-elf, etc.
687 @item
688 Specifying just @var{target} instead of @option{--target=@var{target}}
689 implies that the host defaults to @var{target}.
690 @end itemize
693 @heading Options specification
695 Use @var{options} to override several configure time options for
696 GCC@.  A list of supported @var{options} follows; @samp{configure
697 --help} may list other options, but those not listed below may not
698 work and should not normally be used.
700 Note that each @option{--enable} option has a corresponding
701 @option{--disable} option and that each @option{--with} option has a
702 corresponding @option{--without} option.
704 @table @code
705 @item --prefix=@var{dirname}
706 Specify the toplevel installation
707 directory.  This is the recommended way to install the tools into a directory
708 other than the default.  The toplevel installation directory defaults to
709 @file{/usr/local}.
711 We @strong{highly} recommend against @var{dirname} being the same or a
712 subdirectory of @var{objdir} or vice versa.  If specifying a directory
713 beneath a user's home directory tree, some shells will not expand
714 @var{dirname} correctly if it contains the @samp{~} metacharacter; use
715 @env{$HOME} instead.
717 The following standard @command{autoconf} options are supported.  Normally you
718 should not need to use these options.
719 @table @code
720 @item --exec-prefix=@var{dirname}
721 Specify the toplevel installation directory for architecture-dependent
722 files.  The default is @file{@var{prefix}}.
724 @item --bindir=@var{dirname}
725 Specify the installation directory for the executables called by users
726 (such as @command{gcc} and @command{g++}).  The default is
727 @file{@var{exec-prefix}/bin}.
729 @item --libdir=@var{dirname}
730 Specify the installation directory for object code libraries and
731 internal data files of GCC@.  The default is @file{@var{exec-prefix}/lib}.
733 @item --libexecdir=@var{dirname}
734 Specify the installation directory for internal executables of GCC@.
735 The default is @file{@var{exec-prefix}/libexec}.
737 @item --with-slibdir=@var{dirname}
738 Specify the installation directory for the shared libgcc library.  The
739 default is @file{@var{libdir}}.
741 @item --datarootdir=@var{dirname}
742 Specify the root of the directory tree for read-only architecture-independent
743 data files referenced by GCC@.  The default is @file{@var{prefix}/share}.
745 @item --infodir=@var{dirname}
746 Specify the installation directory for documentation in info format.
747 The default is @file{@var{datarootdir}/info}.
749 @item --datadir=@var{dirname}
750 Specify the installation directory for some architecture-independent
751 data files referenced by GCC@.  The default is @file{@var{datarootdir}}.
753 @item --docdir=@var{dirname}
754 Specify the installation directory for documentation files (other
755 than Info) for GCC@.  The default is @file{@var{datarootdir}/doc}.
757 @item --htmldir=@var{dirname}
758 Specify the installation directory for HTML documentation files.
759 The default is @file{@var{docdir}}.
761 @item --pdfdir=@var{dirname}
762 Specify the installation directory for PDF documentation files.
763 The default is @file{@var{docdir}}.
765 @item --mandir=@var{dirname}
766 Specify the installation directory for manual pages.  The default is
767 @file{@var{datarootdir}/man}.  (Note that the manual pages are only extracts
768 from the full GCC manuals, which are provided in Texinfo format.  The manpages
769 are derived by an automatic conversion process from parts of the full
770 manual.)
772 @item --with-gxx-include-dir=@var{dirname}
773 Specify
774 the installation directory for G++ header files.  The default depends
775 on other configuration options, and differs between cross and native
776 configurations.
778 @item --with-specs=@var{specs}
779 Specify additional command line driver SPECS.
780 This can be useful if you need to turn on a non-standard feature by
781 default without modifying the compiler's source code, for instance
782 @option{--with-specs=%@{!fcommon:%@{!fno-common:-fno-common@}@}}.
783 @ifnothtml
784 @xref{Spec Files,, Specifying subprocesses and the switches to pass to them,
785 gcc, Using the GNU Compiler Collection (GCC)},
786 @end ifnothtml
787 @ifhtml
788 See ``Spec Files'' in the main manual
789 @end ifhtml
791 @end table
793 @item --program-prefix=@var{prefix}
794 GCC supports some transformations of the names of its programs when
795 installing them.  This option prepends @var{prefix} to the names of
796 programs to install in @var{bindir} (see above).  For example, specifying
797 @option{--program-prefix=foo-} would result in @samp{gcc}
798 being installed as @file{/usr/local/bin/foo-gcc}.
800 @item --program-suffix=@var{suffix}
801 Appends @var{suffix} to the names of programs to install in @var{bindir}
802 (see above).  For example, specifying @option{--program-suffix=-3.1}
803 would result in @samp{gcc} being installed as
804 @file{/usr/local/bin/gcc-3.1}.
806 @item --program-transform-name=@var{pattern}
807 Applies the @samp{sed} script @var{pattern} to be applied to the names
808 of programs to install in @var{bindir} (see above).  @var{pattern} has to
809 consist of one or more basic @samp{sed} editing commands, separated by
810 semicolons.  For example, if you want the @samp{gcc} program name to be
811 transformed to the installed program @file{/usr/local/bin/myowngcc} and
812 the @samp{g++} program name to be transformed to
813 @file{/usr/local/bin/gspecial++} without changing other program names,
814 you could use the pattern
815 @option{--program-transform-name='s/^gcc$/myowngcc/; s/^g++$/gspecial++/'}
816 to achieve this effect.
818 All three options can be combined and used together, resulting in more
819 complex conversion patterns.  As a basic rule, @var{prefix} (and
820 @var{suffix}) are prepended (appended) before further transformations
821 can happen with a special transformation script @var{pattern}.
823 As currently implemented, this option only takes effect for native
824 builds; cross compiler binaries' names are not transformed even when a
825 transformation is explicitly asked for by one of these options.
827 For native builds, some of the installed programs are also installed
828 with the target alias in front of their name, as in
829 @samp{i686-pc-linux-gnu-gcc}.  All of the above transformations happen
830 before the target alias is prepended to the name---so, specifying
831 @option{--program-prefix=foo-} and @option{program-suffix=-3.1}, the
832 resulting binary would be installed as
833 @file{/usr/local/bin/i686-pc-linux-gnu-foo-gcc-3.1}.
835 As a last shortcoming, none of the installed Ada programs are
836 transformed yet, which will be fixed in some time.
838 @item --with-local-prefix=@var{dirname}
839 Specify the
840 installation directory for local include files.  The default is
841 @file{/usr/local}.  Specify this option if you want the compiler to
842 search directory @file{@var{dirname}/include} for locally installed
843 header files @emph{instead} of @file{/usr/local/include}.
845 You should specify @option{--with-local-prefix} @strong{only} if your
846 site has a different convention (not @file{/usr/local}) for where to put
847 site-specific files.
849 The default value for @option{--with-local-prefix} is @file{/usr/local}
850 regardless of the value of @option{--prefix}.  Specifying
851 @option{--prefix} has no effect on which directory GCC searches for
852 local header files.  This may seem counterintuitive, but actually it is
853 logical.
855 The purpose of @option{--prefix} is to specify where to @emph{install
856 GCC}.  The local header files in @file{/usr/local/include}---if you put
857 any in that directory---are not part of GCC@.  They are part of other
858 programs---perhaps many others.  (GCC installs its own header files in
859 another directory which is based on the @option{--prefix} value.)
861 Both the local-prefix include directory and the GCC-prefix include
862 directory are part of GCC's ``system include'' directories.  Although these
863 two directories are not fixed, they need to be searched in the proper
864 order for the correct processing of the include_next directive.  The
865 local-prefix include directory is searched before the GCC-prefix
866 include directory.  Another characteristic of system include directories
867 is that pedantic warnings are turned off for headers in these directories.
869 Some autoconf macros add @option{-I @var{directory}} options to the
870 compiler command line, to ensure that directories containing installed
871 packages' headers are searched.  When @var{directory} is one of GCC's
872 system include directories, GCC will ignore the option so that system
873 directories continue to be processed in the correct order.  This
874 may result in a search order different from what was specified but the
875 directory will still be searched.
877 GCC automatically searches for ordinary libraries using
878 @env{GCC_EXEC_PREFIX}.  Thus, when the same installation prefix is
879 used for both GCC and packages, GCC will automatically search for
880 both headers and libraries.  This provides a configuration that is
881 easy to use.  GCC behaves in a manner similar to that when it is
882 installed as a system compiler in @file{/usr}.
884 Sites that need to install multiple versions of GCC may not want to
885 use the above simple configuration.  It is possible to use the
886 @option{--program-prefix}, @option{--program-suffix} and
887 @option{--program-transform-name} options to install multiple versions
888 into a single directory, but it may be simpler to use different prefixes
889 and the @option{--with-local-prefix} option to specify the location of the
890 site-specific files for each version.  It will then be necessary for
891 users to specify explicitly the location of local site libraries
892 (e.g., with @env{LIBRARY_PATH}).
894 The same value can be used for both @option{--with-local-prefix} and
895 @option{--prefix} provided it is not @file{/usr}.  This can be used
896 to avoid the default search of @file{/usr/local/include}.
898 @strong{Do not} specify @file{/usr} as the @option{--with-local-prefix}!
899 The directory you use for @option{--with-local-prefix} @strong{must not}
900 contain any of the system's standard header files.  If it did contain
901 them, certain programs would be miscompiled (including GNU Emacs, on
902 certain targets), because this would override and nullify the header
903 file corrections made by the @command{fixincludes} script.
905 Indications are that people who use this option use it based on mistaken
906 ideas of what it is for.  People use it as if it specified where to
907 install part of GCC@.  Perhaps they make this assumption because
908 installing GCC creates the directory.
910 @item --with-native-system-header-dir=@var{dirname}
911 Specifies that @var{dirname} is the directory that contains native system
912 header files, rather than @file{/usr/include}.  This option is most useful
913 if you are creating a compiler that should be isolated from the system
914 as much as possible.  It is most commonly used with the
915 @option{--with-sysroot} option and will cause GCC to search
916 @var{dirname} inside the system root specified by that option.
918 @item --enable-shared[=@var{package}[,@dots{}]]
919 Build shared versions of libraries, if shared libraries are supported on
920 the target platform.  Unlike GCC 2.95.x and earlier, shared libraries
921 are enabled by default on all platforms that support shared libraries.
923 If a list of packages is given as an argument, build shared libraries
924 only for the listed packages.  For other packages, only static libraries
925 will be built.  Package names currently recognized in the GCC tree are
926 @samp{libgcc} (also known as @samp{gcc}), @samp{libstdc++} (not
927 @samp{libstdc++-v3}), @samp{libffi}, @samp{zlib}, @samp{boehm-gc},
928 @samp{ada}, @samp{libada}, @samp{libjava}, @samp{libgo}, and @samp{libobjc}.
929 Note @samp{libiberty} does not support shared libraries at all.
931 Use @option{--disable-shared} to build only static libraries.  Note that
932 @option{--disable-shared} does not accept a list of package names as
933 argument, only @option{--enable-shared} does.
935 @item @anchor{with-gnu-as}--with-gnu-as
936 Specify that the compiler should assume that the
937 assembler it finds is the GNU assembler.  However, this does not modify
938 the rules to find an assembler and will result in confusion if the
939 assembler found is not actually the GNU assembler.  (Confusion may also
940 result if the compiler finds the GNU assembler but has not been
941 configured with @option{--with-gnu-as}.)  If you have more than one
942 assembler installed on your system, you may want to use this option in
943 connection with @option{--with-as=@var{pathname}} or
944 @option{--with-build-time-tools=@var{pathname}}.
946 The following systems are the only ones where it makes a difference
947 whether you use the GNU assembler.  On any other system,
948 @option{--with-gnu-as} has no effect.
950 @itemize @bullet
951 @item @samp{hppa1.0-@var{any}-@var{any}}
952 @item @samp{hppa1.1-@var{any}-@var{any}}
953 @item @samp{sparc-sun-solaris2.@var{any}}
954 @item @samp{sparc64-@var{any}-solaris2.@var{any}}
955 @end itemize
957 @item @anchor{with-as}--with-as=@var{pathname}
958 Specify that the compiler should use the assembler pointed to by
959 @var{pathname}, rather than the one found by the standard rules to find
960 an assembler, which are:
961 @itemize @bullet
962 @item
963 Unless GCC is being built with a cross compiler, check the
964 @file{@var{libexec}/gcc/@var{target}/@var{version}} directory.
965 @var{libexec} defaults to @file{@var{exec-prefix}/libexec};
966 @var{exec-prefix} defaults to @var{prefix}, which
967 defaults to @file{/usr/local} unless overridden by the
968 @option{--prefix=@var{pathname}} switch described above.  @var{target}
969 is the target system triple, such as @samp{sparc-sun-solaris2.7}, and
970 @var{version} denotes the GCC version, such as 3.0.
972 @item
973 If the target system is the same that you are building on, check
974 operating system specific directories (e.g.@: @file{/usr/ccs/bin} on
975 Sun Solaris 2).
977 @item
978 Check in the @env{PATH} for a tool whose name is prefixed by the
979 target system triple.
981 @item
982 Check in the @env{PATH} for a tool whose name is not prefixed by the
983 target system triple, if the host and target system triple are
984 the same (in other words, we use a host tool if it can be used for
985 the target as well).
986 @end itemize
988 You may want to use @option{--with-as} if no assembler
989 is installed in the directories listed above, or if you have multiple
990 assemblers installed and want to choose one that is not found by the
991 above rules.
993 @item @anchor{with-gnu-ld}--with-gnu-ld
994 Same as @uref{#with-gnu-as,,@option{--with-gnu-as}}
995 but for the linker.
997 @item --with-ld=@var{pathname}
998 Same as @uref{#with-as,,@option{--with-as}}
999 but for the linker.
1001 @item --with-stabs
1002 Specify that stabs debugging
1003 information should be used instead of whatever format the host normally
1004 uses.  Normally GCC uses the same debug format as the host system.
1006 On MIPS based systems and on Alphas, you must specify whether you want
1007 GCC to create the normal ECOFF debugging format, or to use BSD-style
1008 stabs passed through the ECOFF symbol table.  The normal ECOFF debug
1009 format cannot fully handle languages other than C@.  BSD stabs format can
1010 handle other languages, but it only works with the GNU debugger GDB@.
1012 Normally, GCC uses the ECOFF debugging format by default; if you
1013 prefer BSD stabs, specify @option{--with-stabs} when you configure GCC@.
1015 No matter which default you choose when you configure GCC, the user
1016 can use the @option{-gcoff} and @option{-gstabs+} options to specify explicitly
1017 the debug format for a particular compilation.
1019 @option{--with-stabs} is meaningful on the ISC system on the 386, also, if
1020 @option{--with-gas} is used.  It selects use of stabs debugging
1021 information embedded in COFF output.  This kind of debugging information
1022 supports C++ well; ordinary COFF debugging information does not.
1024 @option{--with-stabs} is also meaningful on 386 systems running SVR4.  It
1025 selects use of stabs debugging information embedded in ELF output.  The
1026 C++ compiler currently (2.6.0) does not support the DWARF debugging
1027 information normally used on 386 SVR4 platforms; stabs provide a
1028 workable alternative.  This requires gas and gdb, as the normal SVR4
1029 tools can not generate or interpret stabs.
1031 @item --with-tls=@var{dialect}
1032 Specify the default TLS dialect, for systems were there is a choice.
1033 For ARM targets, possible values for @var{dialect} are @code{gnu} or
1034 @code{gnu2}, which select between the original GNU dialect and the GNU TLS
1035 descriptor-based dialect.
1037 @item --enable-multiarch
1038 Specify whether to enable or disable multiarch support.  The default is
1039 to check for glibc start files in a multiarch location, and enable it
1040 if the files are found.  The auto detection is enabled for native builds,
1041 and for cross builds configured with @option{--with-sysroot}, and without
1042 @option{--with-native-system-header-dir}.
1043 More documentation about multiarch can be found at
1044 @uref{http://wiki.debian.org/Multiarch}.
1046 @item --disable-multilib
1047 Specify that multiple target
1048 libraries to support different target variants, calling
1049 conventions, etc.@: should not be built.  The default is to build a
1050 predefined set of them.
1052 Some targets provide finer-grained control over which multilibs are built
1053 (e.g., @option{--disable-softfloat}):
1054 @table @code
1055 @item arm-*-*
1056 fpu, 26bit, underscore, interwork, biendian, nofmult.
1058 @item m68*-*-*
1059 softfloat, m68881, m68000, m68020.
1061 @item mips*-*-*
1062 single-float, biendian, softfloat.
1064 @item powerpc*-*-*, rs6000*-*-*
1065 aix64, pthread, softfloat, powercpu, powerpccpu, powerpcos, biendian,
1066 sysv, aix.
1068 @end table
1070 @item --with-multilib-list=@var{list}
1071 @itemx --without-multilib-list
1072 Specify what multilibs to build.
1073 Currently only implemented for sh*-*-* and x86-64-*-linux*.
1075 @table @code
1076 @item sh*-*-*
1077 @var{list} is a comma separated list of CPU names.  These must be of the
1078 form @code{sh*} or @code{m*} (in which case they match the compiler option
1079 for that processor).  The list should not contain any endian options -
1080 these are handled by @option{--with-endian}.
1082 If @var{list} is empty, then there will be no multilibs for extra
1083 processors.  The multilib for the secondary endian remains enabled.
1085 As a special case, if an entry in the list starts with a @code{!}
1086 (exclamation point), then it is added to the list of excluded multilibs.
1087 Entries of this sort should be compatible with @samp{MULTILIB_EXCLUDES}
1088 (once the leading @code{!} has been stripped).
1090 If @option{--with-multilib-list} is not given, then a default set of
1091 multilibs is selected based on the value of @option{--target}.  This is
1092 usually the complete set of libraries, but some targets imply a more
1093 specialized subset.
1095 Example 1: to configure a compiler for SH4A only, but supporting both
1096 endians, with little endian being the default:
1097 @smallexample
1098 --with-cpu=sh4a --with-endian=little,big --with-multilib-list=
1099 @end smallexample
1101 Example 2: to configure a compiler for both SH4A and SH4AL-DSP, but with
1102 only little endian SH4AL:
1103 @smallexample
1104 --with-cpu=sh4a --with-endian=little,big \
1105 --with-multilib-list=sh4al,!mb/m4al
1106 @end smallexample
1108 @item x86-64-*-linux*
1109 @var{list} is a comma separated list of @code{m32}, @code{m64} and
1110 @code{mx32} to enable 32-bit, 64-bit and x32 run-time libraries,
1111 respectively.  If @var{list} is empty, then there will be no multilibs
1112 and only the default run-time library will be enabled.
1114 If @option{--with-multilib-list} is not given, then only 32-bit and
1115 64-bit run-time libraries will be enabled.
1116 @end table
1118 @item --with-endian=@var{endians}
1119 Specify what endians to use.
1120 Currently only implemented for sh*-*-*.
1122 @var{endians} may be one of the following:
1123 @table @code
1124 @item big
1125 Use big endian exclusively.
1126 @item little
1127 Use little endian exclusively.
1128 @item big,little
1129 Use big endian by default.  Provide a multilib for little endian.
1130 @item little,big
1131 Use little endian by default.  Provide a multilib for big endian.
1132 @end table
1134 @item --enable-threads
1135 Specify that the target
1136 supports threads.  This affects the Objective-C compiler and runtime
1137 library, and exception handling for other languages like C++ and Java.
1138 On some systems, this is the default.
1140 In general, the best (and, in many cases, the only known) threading
1141 model available will be configured for use.  Beware that on some
1142 systems, GCC has not been taught what threading models are generally
1143 available for the system.  In this case, @option{--enable-threads} is an
1144 alias for @option{--enable-threads=single}.
1146 @item --disable-threads
1147 Specify that threading support should be disabled for the system.
1148 This is an alias for @option{--enable-threads=single}.
1150 @item --enable-threads=@var{lib}
1151 Specify that
1152 @var{lib} is the thread support library.  This affects the Objective-C
1153 compiler and runtime library, and exception handling for other languages
1154 like C++ and Java.  The possibilities for @var{lib} are:
1156 @table @code
1157 @item aix
1158 AIX thread support.
1159 @item dce
1160 DCE thread support.
1161 @item lynx
1162 LynxOS thread support.
1163 @item mipssde
1164 MIPS SDE thread support.
1165 @item no
1166 This is an alias for @samp{single}.
1167 @item posix
1168 Generic POSIX/Unix98 thread support.
1169 @item rtems
1170 RTEMS thread support.
1171 @item single
1172 Disable thread support, should work for all platforms.
1173 @item tpf
1174 TPF thread support.
1175 @item vxworks
1176 VxWorks thread support.
1177 @item win32
1178 Microsoft Win32 API thread support.
1179 @end table
1181 @item --enable-tls
1182 Specify that the target supports TLS (Thread Local Storage).  Usually
1183 configure can correctly determine if TLS is supported.  In cases where
1184 it guesses incorrectly, TLS can be explicitly enabled or disabled with
1185 @option{--enable-tls} or @option{--disable-tls}.  This can happen if
1186 the assembler supports TLS but the C library does not, or if the
1187 assumptions made by the configure test are incorrect.
1189 @item --disable-tls
1190 Specify that the target does not support TLS.
1191 This is an alias for @option{--enable-tls=no}.
1193 @item --with-cpu=@var{cpu}
1194 @itemx --with-cpu-32=@var{cpu}
1195 @itemx --with-cpu-64=@var{cpu}
1196 Specify which cpu variant the compiler should generate code for by default.
1197 @var{cpu} will be used as the default value of the @option{-mcpu=} switch.
1198 This option is only supported on some targets, including ARM, i386, M68k,
1199 PowerPC, and SPARC@.  The @option{--with-cpu-32} and
1200 @option{--with-cpu-64} options specify separate default CPUs for
1201 32-bit and 64-bit modes; these options are only supported for i386,
1202 x86-64 and PowerPC.
1204 @item --with-schedule=@var{cpu}
1205 @itemx --with-arch=@var{cpu}
1206 @itemx --with-arch-32=@var{cpu}
1207 @itemx --with-arch-64=@var{cpu}
1208 @itemx --with-tune=@var{cpu}
1209 @itemx --with-tune-32=@var{cpu}
1210 @itemx --with-tune-64=@var{cpu}
1211 @itemx --with-abi=@var{abi}
1212 @itemx --with-fpu=@var{type}
1213 @itemx --with-float=@var{type}
1214 These configure options provide default values for the @option{-mschedule=},
1215 @option{-march=}, @option{-mtune=}, @option{-mabi=}, and @option{-mfpu=}
1216 options and for @option{-mhard-float} or @option{-msoft-float}.  As with
1217 @option{--with-cpu}, which switches will be accepted and acceptable values
1218 of the arguments depend on the target.
1220 @item --with-mode=@var{mode}
1221 Specify if the compiler should default to @option{-marm} or @option{-mthumb}.
1222 This option is only supported on ARM targets.
1224 @item --with-stack-offset=@var{num}
1225 This option sets the default for the -mstack-offset=@var{num} option,
1226 and will thus generally also control the setting of this option for
1227 libraries.  This option is only supported on Epiphany targets.
1229 @item --with-fpmath=@var{isa}
1230 This options sets @option{-mfpmath=sse} by default and specifies the default
1231 ISA for floating-point arithmetics.  You can select either @samp{sse} which
1232 enables @option{-msse2} or @samp{avx} which enables @option{-mavx} by default.
1233 This option is only supported on i386 and x86-64 targets.
1235 @item --with-divide=@var{type}
1236 Specify how the compiler should generate code for checking for
1237 division by zero.  This option is only supported on the MIPS target.
1238 The possibilities for @var{type} are:
1239 @table @code
1240 @item traps
1241 Division by zero checks use conditional traps (this is the default on
1242 systems that support conditional traps).
1243 @item breaks
1244 Division by zero checks use the break instruction.
1245 @end table
1247 @c If you make --with-llsc the default for additional targets,
1248 @c update the --with-llsc description in the MIPS section below.
1250 @item --with-llsc
1251 On MIPS targets, make @option{-mllsc} the default when no
1252 @option{-mno-llsc} option is passed.  This is the default for
1253 Linux-based targets, as the kernel will emulate them if the ISA does
1254 not provide them.
1256 @item --without-llsc
1257 On MIPS targets, make @option{-mno-llsc} the default when no
1258 @option{-mllsc} option is passed.
1260 @item --with-synci
1261 On MIPS targets, make @option{-msynci} the default when no
1262 @option{-mno-synci} option is passed.
1264 @item --without-synci
1265 On MIPS targets, make @option{-mno-synci} the default when no
1266 @option{-msynci} option is passed.  This is the default.
1268 @item --with-mips-plt
1269 On MIPS targets, make use of copy relocations and PLTs.
1270 These features are extensions to the traditional
1271 SVR4-based MIPS ABIs and require support from GNU binutils
1272 and the runtime C library.
1274 @item --enable-__cxa_atexit
1275 Define if you want to use __cxa_atexit, rather than atexit, to
1276 register C++ destructors for local statics and global objects.
1277 This is essential for fully standards-compliant handling of
1278 destructors, but requires __cxa_atexit in libc.  This option is currently
1279 only available on systems with GNU libc.  When enabled, this will cause
1280 @option{-fuse-cxa-atexit} to be passed by default.
1282 @item --enable-gnu-indirect-function
1283 Define if you want to enable the @code{ifunc} attribute.  This option is
1284 currently only available on systems with GNU libc on certain targets.
1286 @item --enable-target-optspace
1287 Specify that target
1288 libraries should be optimized for code space instead of code speed.
1289 This is the default for the m32r platform.
1291 @item --with-cpp-install-dir=@var{dirname}
1292 Specify that the user visible @command{cpp} program should be installed
1293 in @file{@var{prefix}/@var{dirname}/cpp}, in addition to @var{bindir}.
1295 @item --enable-comdat
1296 Enable COMDAT group support.  This is primarily used to override the
1297 automatically detected value.
1299 @item --enable-initfini-array
1300 Force the use of sections @code{.init_array} and @code{.fini_array}
1301 (instead of @code{.init} and @code{.fini}) for constructors and
1302 destructors.  Option @option{--disable-initfini-array} has the
1303 opposite effect.  If neither option is specified, the configure script
1304 will try to guess whether the @code{.init_array} and
1305 @code{.fini_array} sections are supported and, if they are, use them.
1307 @item --enable-maintainer-mode
1308 The build rules that regenerate the Autoconf and Automake output files as
1309 well as the GCC master message catalog @file{gcc.pot} are normally
1310 disabled.  This is because it can only be rebuilt if the complete source
1311 tree is present.  If you have changed the sources and want to rebuild the
1312 catalog, configuring with @option{--enable-maintainer-mode} will enable
1313 this.  Note that you need a recent version of the @code{gettext} tools
1314 to do so.
1316 @item --disable-bootstrap
1317 For a native build, the default configuration is to perform
1318 a 3-stage bootstrap of the compiler when @samp{make} is invoked,
1319 testing that GCC can compile itself correctly.  If you want to disable
1320 this process, you can configure with @option{--disable-bootstrap}.
1322 @item --enable-bootstrap
1323 In special cases, you may want to perform a 3-stage build
1324 even if the target and host triplets are different.
1325 This is possible when the host can run code compiled for
1326 the target (e.g.@: host is i686-linux, target is i486-linux).
1327 Starting from GCC 4.2, to do this you have to configure explicitly
1328 with @option{--enable-bootstrap}.
1330 @item --enable-generated-files-in-srcdir
1331 Neither the .c and .h files that are generated from Bison and flex nor the
1332 info manuals and man pages that are built from the .texi files are present
1333 in the SVN development tree.  When building GCC from that development tree,
1334 or from one of our snapshots, those generated files are placed in your
1335 build directory, which allows for the source to be in a readonly
1336 directory.
1338 If you configure with @option{--enable-generated-files-in-srcdir} then those
1339 generated files will go into the source directory.  This is mainly intended
1340 for generating release or prerelease tarballs of the GCC sources, since it
1341 is not a requirement that the users of source releases to have flex, Bison,
1342 or makeinfo.
1344 @item --enable-version-specific-runtime-libs
1345 Specify
1346 that runtime libraries should be installed in the compiler specific
1347 subdirectory (@file{@var{libdir}/gcc}) rather than the usual places.  In
1348 addition, @samp{libstdc++}'s include files will be installed into
1349 @file{@var{libdir}} unless you overruled it by using
1350 @option{--with-gxx-include-dir=@var{dirname}}.  Using this option is
1351 particularly useful if you intend to use several versions of GCC in
1352 parallel.  This is currently supported by @samp{libgfortran},
1353 @samp{libjava}, @samp{libmudflap}, @samp{libstdc++}, and @samp{libobjc}.
1355 @item --enable-languages=@var{lang1},@var{lang2},@dots{}
1356 Specify that only a particular subset of compilers and
1357 their runtime libraries should be built.  For a list of valid values for
1358 @var{langN} you can issue the following command in the
1359 @file{gcc} directory of your GCC source tree:@*
1360 @smallexample
1361 grep language= */config-lang.in
1362 @end smallexample
1363 Currently, you can use any of the following:
1364 @code{all}, @code{ada}, @code{c}, @code{c++}, @code{fortran},
1365 @code{go}, @code{java}, @code{objc}, @code{obj-c++}.
1366 Building the Ada compiler has special requirements, see below.
1367 If you do not pass this flag, or specify the option @code{all}, then all
1368 default languages available in the @file{gcc} sub-tree will be configured.
1369 Ada, Go and Objective-C++ are not default languages; the rest are.
1371 @item --enable-stage1-languages=@var{lang1},@var{lang2},@dots{}
1372 Specify that a particular subset of compilers and their runtime
1373 libraries should be built with the system C compiler during stage 1 of
1374 the bootstrap process, rather than only in later stages with the
1375 bootstrapped C compiler.  The list of valid values is the same as for
1376 @option{--enable-languages}, and the option @code{all} will select all
1377 of the languages enabled by @option{--enable-languages}.  This option is
1378 primarily useful for GCC development; for instance, when a development
1379 version of the compiler cannot bootstrap due to compiler bugs, or when
1380 one is debugging front ends other than the C front end.  When this
1381 option is used, one can then build the target libraries for the
1382 specified languages with the stage-1 compiler by using @command{make
1383 stage1-bubble all-target}, or run the testsuite on the stage-1 compiler
1384 for the specified languages using @command{make stage1-start check-gcc}.
1386 @item --disable-libada
1387 Specify that the run-time libraries and tools used by GNAT should not
1388 be built.  This can be useful for debugging, or for compatibility with
1389 previous Ada build procedures, when it was required to explicitly
1390 do a @samp{make -C gcc gnatlib_and_tools}.
1392 @item --disable-libssp
1393 Specify that the run-time libraries for stack smashing protection
1394 should not be built.
1396 @item --disable-libquadmath
1397 Specify that the GCC quad-precision math library should not be built.
1398 On some systems, the library is required to be linkable when building
1399 the Fortran front end, unless @option{--disable-libquadmath-support}
1400 is used.
1402 @item --disable-libquadmath-support
1403 Specify that the Fortran front end and @code{libgfortran} do not add
1404 support for @code{libquadmath} on systems supporting it.
1406 @item --disable-libgomp
1407 Specify that the run-time libraries used by GOMP should not be built.
1409 @item --with-dwarf2
1410 Specify that the compiler should
1411 use DWARF 2 debugging information as the default.
1413 @item --enable-targets=all
1414 @itemx --enable-targets=@var{target_list}
1415 Some GCC targets, e.g.@: powerpc64-linux, build bi-arch compilers.
1416 These are compilers that are able to generate either 64-bit or 32-bit
1417 code.  Typically, the corresponding 32-bit target, e.g.@:
1418 powerpc-linux for powerpc64-linux, only generates 32-bit code.  This
1419 option enables the 32-bit target to be a bi-arch compiler, which is
1420 useful when you want a bi-arch compiler that defaults to 32-bit, and
1421 you are building a bi-arch or multi-arch binutils in a combined tree.
1422 On mips-linux, this will build a tri-arch compiler (ABI o32/n32/64),
1423 defaulted to o32.
1424 Currently, this option only affects sparc-linux, powerpc-linux, x86-linux,
1425 mips-linux and s390-linux.
1427 @item --enable-secureplt
1428 This option enables @option{-msecure-plt} by default for powerpc-linux.
1429 @ifnothtml
1430 @xref{RS/6000 and PowerPC Options,, RS/6000 and PowerPC Options, gcc,
1431 Using the GNU Compiler Collection (GCC)},
1432 @end ifnothtml
1433 @ifhtml
1434 See ``RS/6000 and PowerPC Options'' in the main manual
1435 @end ifhtml
1437 @item --enable-cld
1438 This option enables @option{-mcld} by default for 32-bit x86 targets.
1439 @ifnothtml
1440 @xref{i386 and x86-64 Options,, i386 and x86-64 Options, gcc,
1441 Using the GNU Compiler Collection (GCC)},
1442 @end ifnothtml
1443 @ifhtml
1444 See ``i386 and x86-64 Options'' in the main manual
1445 @end ifhtml
1447 @item --enable-win32-registry
1448 @itemx --enable-win32-registry=@var{key}
1449 @itemx --disable-win32-registry
1450 The @option{--enable-win32-registry} option enables Microsoft Windows-hosted GCC
1451 to look up installations paths in the registry using the following key:
1453 @smallexample
1454 @code{HKEY_LOCAL_MACHINE\SOFTWARE\Free Software Foundation\@var{key}}
1455 @end smallexample
1457 @var{key} defaults to GCC version number, and can be overridden by the
1458 @option{--enable-win32-registry=@var{key}} option.  Vendors and distributors
1459 who use custom installers are encouraged to provide a different key,
1460 perhaps one comprised of vendor name and GCC version number, to
1461 avoid conflict with existing installations.  This feature is enabled
1462 by default, and can be disabled by @option{--disable-win32-registry}
1463 option.  This option has no effect on the other hosts.
1465 @item --nfp
1466 Specify that the machine does not have a floating point unit.  This
1467 option only applies to @samp{m68k-sun-sunos@var{n}}.  On any other
1468 system, @option{--nfp} has no effect.
1470 @item --enable-werror
1471 @itemx --disable-werror
1472 @itemx --enable-werror=yes
1473 @itemx --enable-werror=no
1474 When you specify this option, it controls whether certain files in the
1475 compiler are built with @option{-Werror} in bootstrap stage2 and later.
1476 If you don't specify it, @option{-Werror} is turned on for the main
1477 development trunk.  However it defaults to off for release branches and
1478 final releases.  The specific files which get @option{-Werror} are
1479 controlled by the Makefiles.
1481 @item --enable-checking
1482 @itemx --enable-checking=@var{list}
1483 When you specify this option, the compiler is built to perform internal
1484 consistency checks of the requested complexity.  This does not change the
1485 generated code, but adds error checking within the compiler.  This will
1486 slow down the compiler and may only work properly if you are building
1487 the compiler with GCC@.  This is @samp{yes} by default when building
1488 from SVN or snapshots, but @samp{release} for releases.  The default
1489 for building the stage1 compiler is @samp{yes}.  More control
1490 over the checks may be had by specifying @var{list}.  The categories of
1491 checks available are @samp{yes} (most common checks
1492 @samp{assert,misc,tree,gc,rtlflag,runtime}), @samp{no} (no checks at
1493 all), @samp{all} (all but @samp{valgrind}), @samp{release} (cheapest
1494 checks @samp{assert,runtime}) or @samp{none} (same as @samp{no}).
1495 Individual checks can be enabled with these flags @samp{assert},
1496 @samp{df}, @samp{fold}, @samp{gc}, @samp{gcac} @samp{misc}, @samp{rtl},
1497 @samp{rtlflag}, @samp{runtime}, @samp{tree}, and @samp{valgrind}.
1499 The @samp{valgrind} check requires the external @command{valgrind}
1500 simulator, available from @uref{http://valgrind.org/}.  The
1501 @samp{df}, @samp{rtl}, @samp{gcac} and @samp{valgrind} checks are very expensive.
1502 To disable all checking, @samp{--disable-checking} or
1503 @samp{--enable-checking=none} must be explicitly requested.  Disabling
1504 assertions will make the compiler and runtime slightly faster but
1505 increase the risk of undetected internal errors causing wrong code to be
1506 generated.
1508 @item --disable-stage1-checking
1509 @itemx --enable-stage1-checking
1510 @itemx --enable-stage1-checking=@var{list}
1511 If no @option{--enable-checking} option is specified the stage1
1512 compiler will be built with @samp{yes} checking enabled, otherwise
1513 the stage1 checking flags are the same as specified by
1514 @option{--enable-checking}.  To build the stage1 compiler with
1515 different checking options use @option{--enable-stage1-checking}.
1516 The list of checking options is the same as for @option{--enable-checking}.
1517 If your system is too slow or too small to bootstrap a released compiler
1518 with checking for stage1 enabled, you can use @samp{--disable-stage1-checking}
1519 to disable checking for the stage1 compiler.
1521 @item --enable-coverage
1522 @itemx --enable-coverage=@var{level}
1523 With this option, the compiler is built to collect self coverage
1524 information, every time it is run.  This is for internal development
1525 purposes, and only works when the compiler is being built with gcc.  The
1526 @var{level} argument controls whether the compiler is built optimized or
1527 not, values are @samp{opt} and @samp{noopt}.  For coverage analysis you
1528 want to disable optimization, for performance analysis you want to
1529 enable optimization.  When coverage is enabled, the default level is
1530 without optimization.
1532 @item --enable-gather-detailed-mem-stats
1533 When this option is specified more detailed information on memory
1534 allocation is gathered.  This information is printed when using
1535 @option{-fmem-report}.
1537 @item --with-gc
1538 @itemx --with-gc=@var{choice}
1539 With this option you can specify the garbage collector implementation
1540 used during the compilation process.  @var{choice} can be one of
1541 @samp{page} and @samp{zone}, where @samp{page} is the default.
1543 @item --enable-nls
1544 @itemx --disable-nls
1545 The @option{--enable-nls} option enables Native Language Support (NLS),
1546 which lets GCC output diagnostics in languages other than American
1547 English.  Native Language Support is enabled by default if not doing a
1548 canadian cross build.  The @option{--disable-nls} option disables NLS@.
1550 @item --with-included-gettext
1551 If NLS is enabled, the @option{--with-included-gettext} option causes the build
1552 procedure to prefer its copy of GNU @command{gettext}.
1554 @item --with-catgets
1555 If NLS is enabled, and if the host lacks @code{gettext} but has the
1556 inferior @code{catgets} interface, the GCC build procedure normally
1557 ignores @code{catgets} and instead uses GCC's copy of the GNU
1558 @code{gettext} library.  The @option{--with-catgets} option causes the
1559 build procedure to use the host's @code{catgets} in this situation.
1561 @item --with-libiconv-prefix=@var{dir}
1562 Search for libiconv header files in @file{@var{dir}/include} and
1563 libiconv library files in @file{@var{dir}/lib}.
1565 @item --enable-obsolete
1566 Enable configuration for an obsoleted system.  If you attempt to
1567 configure GCC for a system (build, host, or target) which has been
1568 obsoleted, and you do not specify this flag, configure will halt with an
1569 error message.
1571 All support for systems which have been obsoleted in one release of GCC
1572 is removed entirely in the next major release, unless someone steps
1573 forward to maintain the port.
1575 @item --enable-decimal-float
1576 @itemx --enable-decimal-float=yes
1577 @itemx --enable-decimal-float=no
1578 @itemx --enable-decimal-float=bid
1579 @itemx --enable-decimal-float=dpd
1580 @itemx --disable-decimal-float
1581 Enable (or disable) support for the C decimal floating point extension
1582 that is in the IEEE 754-2008 standard.  This is enabled by default only
1583 on PowerPC, i386, and x86_64 GNU/Linux systems.  Other systems may also
1584 support it, but require the user to specifically enable it.  You can
1585 optionally control which decimal floating point format is used (either
1586 @samp{bid} or @samp{dpd}).  The @samp{bid} (binary integer decimal)
1587 format is default on i386 and x86_64 systems, and the @samp{dpd}
1588 (densely packed decimal) format is default on PowerPC systems.
1590 @item --enable-fixed-point
1591 @itemx --disable-fixed-point
1592 Enable (or disable) support for C fixed-point arithmetic.
1593 This option is enabled by default for some targets (such as MIPS) which
1594 have hardware-support for fixed-point operations.  On other targets, you
1595 may enable this option manually.
1597 @item --with-long-double-128
1598 Specify if @code{long double} type should be 128-bit by default on selected
1599 GNU/Linux architectures.  If using @code{--without-long-double-128},
1600 @code{long double} will be by default 64-bit, the same as @code{double} type.
1601 When neither of these configure options are used, the default will be
1602 128-bit @code{long double} when built against GNU C Library 2.4 and later,
1603 64-bit @code{long double} otherwise.
1605 @item --with-gmp=@var{pathname}
1606 @itemx --with-gmp-include=@var{pathname}
1607 @itemx --with-gmp-lib=@var{pathname}
1608 @itemx --with-mpfr=@var{pathname}
1609 @itemx --with-mpfr-include=@var{pathname}
1610 @itemx --with-mpfr-lib=@var{pathname}
1611 @itemx --with-mpc=@var{pathname}
1612 @itemx --with-mpc-include=@var{pathname}
1613 @itemx --with-mpc-lib=@var{pathname}
1614 If you want to build GCC but do not have the GMP library, the MPFR
1615 library and/or the MPC library installed in a standard location and
1616 do not have their sources present in the GCC source tree then you
1617 can explicitly specify the directory where they are installed
1618 (@samp{--with-gmp=@var{gmpinstalldir}},
1619 @samp{--with-mpfr=@/@var{mpfrinstalldir}},
1620 @samp{--with-mpc=@/@var{mpcinstalldir}}).  The
1621 @option{--with-gmp=@/@var{gmpinstalldir}} option is shorthand for
1622 @option{--with-gmp-lib=@/@var{gmpinstalldir}/lib} and
1623 @option{--with-gmp-include=@/@var{gmpinstalldir}/include}.  Likewise the
1624 @option{--with-mpfr=@/@var{mpfrinstalldir}} option is shorthand for
1625 @option{--with-mpfr-lib=@/@var{mpfrinstalldir}/lib} and
1626 @option{--with-mpfr-include=@/@var{mpfrinstalldir}/include}, also the
1627 @option{--with-mpc=@/@var{mpcinstalldir}} option is shorthand for
1628 @option{--with-mpc-lib=@/@var{mpcinstalldir}/lib} and
1629 @option{--with-mpc-include=@/@var{mpcinstalldir}/include}.  If these
1630 shorthand assumptions are not correct, you can use the explicit
1631 include and lib options directly.  You might also need to ensure the
1632 shared libraries can be found by the dynamic linker when building and
1633 using GCC, for example by setting the runtime shared library path
1634 variable (@env{LD_LIBRARY_PATH} on GNU/Linux and Solaris systems).
1636 These flags are applicable to the host platform only.  When building
1637 a cross compiler, they will not be used to configure target libraries.
1639 @item --with-ppl=@var{pathname}
1640 @itemx --with-ppl-include=@var{pathname}
1641 @itemx --with-ppl-lib=@var{pathname}
1642 @itemx --with-cloog=@var{pathname}
1643 @itemx --with-cloog-include=@var{pathname}
1644 @itemx --with-cloog-lib=@var{pathname}
1645 If you do not have ISL and the CLooG
1646 libraries installed in a standard location and you want to build GCC,
1647 you can explicitly specify the directory where they are installed
1648 (@samp{--with-isl=@/@var{islinstalldir}},
1649 @samp{--with-cloog=@/@var{clooginstalldir}}). The
1650 @option{--with-isl=@/@var{islinstalldir}} option is shorthand for
1651 @option{--with-isl-lib=@/@var{islinstalldir}/lib} and
1652 @option{--with-isl-include=@/@var{islinstalldir}/include}.  Likewise the
1653 @option{--with-cloog=@/@var{clooginstalldir}} option is shorthand for
1654 @option{--with-cloog-lib=@/@var{clooginstalldir}/lib} and
1655 @option{--with-cloog-include=@/@var{clooginstalldir}/include}.  If these
1656 shorthand assumptions are not correct, you can use the explicit
1657 include and lib options directly.
1659 These flags are applicable to the host platform only.  When building
1660 a cross compiler, they will not be used to configure target libraries.
1662 @item --with-host-libstdcxx=@var{linker-args}
1663 If you are linking with a static copy of PPL, you can use this option
1664 to specify how the linker should find the standard C++ library used
1665 internally by PPL.  Typical values of @var{linker-args} might be
1666 @samp{-lstdc++} or @samp{-Wl,-Bstatic,-lstdc++,-Bdynamic -lm}.  If you are
1667 linking with a shared copy of PPL, you probably do not need this
1668 option; shared library dependencies will cause the linker to search
1669 for the standard C++ library automatically.
1671 @item --with-stage1-ldflags=@var{flags}
1672 This option may be used to set linker flags to be used when linking
1673 stage 1 of GCC.  These are also used when linking GCC if configured with
1674 @option{--disable-bootstrap}.  By default no special flags are used.
1676 @item --with-stage1-libs=@var{libs}
1677 This option may be used to set libraries to be used when linking stage 1
1678 of GCC.  These are also used when linking GCC if configured with
1679 @option{--disable-bootstrap}.  The default is the argument to
1680 @option{--with-host-libstdcxx}, if specified.
1682 @item --with-boot-ldflags=@var{flags}
1683 This option may be used to set linker flags to be used when linking
1684 stage 2 and later when bootstrapping GCC.  If neither --with-boot-libs
1685 nor --with-host-libstdcxx is set to a value, then the default is
1686 @samp{-static-libstdc++ -static-libgcc}.
1688 @item --with-boot-libs=@var{libs}
1689 This option may be used to set libraries to be used when linking stage 2
1690 and later when bootstrapping GCC.  The default is the argument to
1691 @option{--with-host-libstdcxx}, if specified.
1693 @item --with-debug-prefix-map=@var{map}
1694 Convert source directory names using @option{-fdebug-prefix-map} when
1695 building runtime libraries.  @samp{@var{map}} is a space-separated
1696 list of maps of the form @samp{@var{old}=@var{new}}.
1698 @item --enable-linker-build-id
1699 Tells GCC to pass @option{--build-id} option to the linker for all final
1700 links (links performed without the @option{-r} or @option{--relocatable}
1701 option), if the linker supports it.  If you specify
1702 @option{--enable-linker-build-id}, but your linker does not
1703 support @option{--build-id} option, a warning is issued and the
1704 @option{--enable-linker-build-id} option is ignored.  The default is off.
1706 @item --with-linker-hash-style=@var{choice}
1707 Tells GCC to pass @option{--hash-style=@var{choice}} option to the
1708 linker for all final links. @var{choice} can be one of
1709 @samp{sysv}, @samp{gnu}, and @samp{both} where @samp{sysv} is the default.
1711 @item --enable-gnu-unique-object
1712 @itemx --disable-gnu-unique-object
1713 Tells GCC to use the gnu_unique_object relocation for C++ template
1714 static data members and inline function local statics.  Enabled by
1715 default for a native toolchain with an assembler that accepts it and
1716 GLIBC 2.11 or above, otherwise disabled.
1718 @item --enable-lto
1719 @itemx --disable-lto
1720 Enable support for link-time optimization (LTO).  This is enabled by
1721 default, and may be disabled using @option{--disable-lto}.
1723 @item --with-plugin-ld=@var{pathname}
1724 Enable an alternate linker to be used at link-time optimization (LTO)
1725 link time when @option{-fuse-linker-plugin} is enabled.
1726 This linker should have plugin support such as gold starting with
1727 version 2.20 or GNU ld starting with version 2.21.
1728 See @option{-fuse-linker-plugin} for details.
1730 @item --enable-canonical-system-headers
1731 @itemx --disable-canonical-system-headers
1732 Enable system header path canonicalization for @file{libcpp}.  This can
1733 produce shorter header file paths in diagnostics and dependency output
1734 files, but these changed header paths may conflict with some compilation
1735 environments.  Enabled by default, and may be disabled using
1736 @option{--disable-canonical-system-headers}.
1737 @end table
1739 @subheading Cross-Compiler-Specific Options
1740 The following options only apply to building cross compilers.
1742 @table @code
1743 @item --with-sysroot
1744 @itemx --with-sysroot=@var{dir}
1745 Tells GCC to consider @var{dir} as the root of a tree that contains
1746 (a subset of) the root filesystem of the target operating system.
1747 Target system headers, libraries and run-time object files will be
1748 searched for in there.  More specifically, this acts as if
1749 @option{--sysroot=@var{dir}} was added to the default options of the built
1750 compiler.  The specified directory is not copied into the
1751 install tree, unlike the options @option{--with-headers} and
1752 @option{--with-libs} that this option obsoletes.  The default value,
1753 in case @option{--with-sysroot} is not given an argument, is
1754 @option{$@{gcc_tooldir@}/sys-root}.  If the specified directory is a
1755 subdirectory of @option{$@{exec_prefix@}}, then it will be found relative to
1756 the GCC binaries if the installation tree is moved.
1758 This option affects the system root for the compiler used to build
1759 target libraries (which runs on the build system) and the compiler newly
1760 installed with @code{make install}; it does not affect the compiler which is
1761 used to build GCC itself.
1763 If you specify the @option{--with-native-system-header-dir=@var{dirname}}
1764 option then the compiler will search that directory within @var{dirname} for
1765 native system headers rather than the default @file{/usr/include}.
1767 @item --with-build-sysroot
1768 @itemx --with-build-sysroot=@var{dir}
1769 Tells GCC to consider @var{dir} as the system root (see
1770 @option{--with-sysroot}) while building target libraries, instead of
1771 the directory specified with @option{--with-sysroot}.  This option is
1772 only useful when you are already using @option{--with-sysroot}.  You
1773 can use @option{--with-build-sysroot} when you are configuring with
1774 @option{--prefix} set to a directory that is different from the one in
1775 which you are installing GCC and your target libraries.
1777 This option affects the system root for the compiler used to build
1778 target libraries (which runs on the build system); it does not affect
1779 the compiler which is used to build GCC itself.
1781 If you specify the @option{--with-native-system-header-dir=@var{dirname}}
1782 option then the compiler will search that directory within @var{dirname} for
1783 native system headers rather than the default @file{/usr/include}.
1785 @item --with-headers
1786 @itemx --with-headers=@var{dir}
1787 Deprecated in favor of @option{--with-sysroot}.
1788 Specifies that target headers are available when building a cross compiler.
1789 The @var{dir} argument specifies a directory which has the target include
1790 files.  These include files will be copied into the @file{gcc} install
1791 directory.  @emph{This option with the @var{dir} argument is required} when
1792 building a cross compiler, if @file{@var{prefix}/@var{target}/sys-include}
1793 doesn't pre-exist.  If @file{@var{prefix}/@var{target}/sys-include} does
1794 pre-exist, the @var{dir} argument may be omitted.  @command{fixincludes}
1795 will be run on these files to make them compatible with GCC@.
1797 @item --without-headers
1798 Tells GCC not use any target headers from a libc when building a cross
1799 compiler.  When crossing to GNU/Linux, you need the headers so GCC
1800 can build the exception handling for libgcc.
1802 @item --with-libs
1803 @itemx --with-libs="@var{dir1} @var{dir2} @dots{} @var{dirN}"
1804 Deprecated in favor of @option{--with-sysroot}.
1805 Specifies a list of directories which contain the target runtime
1806 libraries.  These libraries will be copied into the @file{gcc} install
1807 directory.  If the directory list is omitted, this option has no
1808 effect.
1810 @item --with-newlib
1811 Specifies that @samp{newlib} is
1812 being used as the target C library.  This causes @code{__eprintf} to be
1813 omitted from @file{libgcc.a} on the assumption that it will be provided by
1814 @samp{newlib}.
1816 @item --with-build-time-tools=@var{dir}
1817 Specifies where to find the set of target tools (assembler, linker, etc.)
1818 that will be used while building GCC itself.  This option can be useful
1819 if the directory layouts are different between the system you are building
1820 GCC on, and the system where you will deploy it.
1822 For example, on an @samp{ia64-hp-hpux} system, you may have the GNU
1823 assembler and linker in @file{/usr/bin}, and the native tools in a
1824 different path, and build a toolchain that expects to find the
1825 native tools in @file{/usr/bin}.
1827 When you use this option, you should ensure that @var{dir} includes
1828 @command{ar}, @command{as}, @command{ld}, @command{nm},
1829 @command{ranlib} and @command{strip} if necessary, and possibly
1830 @command{objdump}.  Otherwise, GCC may use an inconsistent set of
1831 tools.
1832 @end table
1834 @subheading Java-Specific Options
1836 The following option applies to the build of the Java front end.
1838 @table @code
1839 @item --disable-libgcj
1840 Specify that the run-time libraries
1841 used by GCJ should not be built.  This is useful in case you intend
1842 to use GCJ with some other run-time, or you're going to install it
1843 separately, or it just happens not to build on your particular
1844 machine.  In general, if the Java front end is enabled, the GCJ
1845 libraries will be enabled too, unless they're known to not work on
1846 the target platform.  If GCJ is enabled but @samp{libgcj} isn't built, you
1847 may need to port it; in this case, before modifying the top-level
1848 @file{configure.in} so that @samp{libgcj} is enabled by default on this platform,
1849 you may use @option{--enable-libgcj} to override the default.
1851 @end table
1853 The following options apply to building @samp{libgcj}.
1855 @subsubheading General Options
1857 @table @code
1858 @item --enable-java-maintainer-mode
1859 By default the @samp{libjava} build will not attempt to compile the
1860 @file{.java} source files to @file{.class}.  Instead, it will use the
1861 @file{.class} files from the source tree.  If you use this option you
1862 must have executables named @command{ecj1} and @command{gjavah} in your path
1863 for use by the build.  You must use this option if you intend to
1864 modify any @file{.java} files in @file{libjava}.
1866 @item --with-java-home=@var{dirname}
1867 This @samp{libjava} option overrides the default value of the
1868 @samp{java.home} system property.  It is also used to set
1869 @samp{sun.boot.class.path} to @file{@var{dirname}/lib/rt.jar}.  By
1870 default @samp{java.home} is set to @file{@var{prefix}} and
1871 @samp{sun.boot.class.path} to
1872 @file{@var{datadir}/java/libgcj-@var{version}.jar}.
1874 @item --with-ecj-jar=@var{filename}
1875 This option can be used to specify the location of an external jar
1876 file containing the Eclipse Java compiler.  A specially modified
1877 version of this compiler is used by @command{gcj} to parse
1878 @file{.java} source files.  If this option is given, the
1879 @samp{libjava} build will create and install an @file{ecj1} executable
1880 which uses this jar file at runtime.
1882 If this option is not given, but an @file{ecj.jar} file is found in
1883 the topmost source tree at configure time, then the @samp{libgcj}
1884 build will create and install @file{ecj1}, and will also install the
1885 discovered @file{ecj.jar} into a suitable place in the install tree.
1887 If @file{ecj1} is not installed, then the user will have to supply one
1888 on his path in order for @command{gcj} to properly parse @file{.java}
1889 source files.  A suitable jar is available from
1890 @uref{ftp://sourceware.org/pub/java/}.
1892 @item --disable-getenv-properties
1893 Don't set system properties from @env{GCJ_PROPERTIES}.
1895 @item --enable-hash-synchronization
1896 Use a global hash table for monitor locks.  Ordinarily,
1897 @samp{libgcj}'s @samp{configure} script automatically makes
1898 the correct choice for this option for your platform.  Only use
1899 this if you know you need the library to be configured differently.
1901 @item --enable-interpreter
1902 Enable the Java interpreter.  The interpreter is automatically
1903 enabled by default on all platforms that support it.  This option
1904 is really only useful if you want to disable the interpreter
1905 (using @option{--disable-interpreter}).
1907 @item --disable-java-net
1908 Disable java.net.  This disables the native part of java.net only,
1909 using non-functional stubs for native method implementations.
1911 @item --disable-jvmpi
1912 Disable JVMPI support.
1914 @item --disable-libgcj-bc
1915 Disable BC ABI compilation of certain parts of libgcj.  By default,
1916 some portions of libgcj are compiled with @option{-findirect-dispatch}
1917 and @option{-fno-indirect-classes}, allowing them to be overridden at
1918 run-time.
1920 If @option{--disable-libgcj-bc} is specified, libgcj is built without
1921 these options.  This allows the compile-time linker to resolve
1922 dependencies when statically linking to libgcj.  However it makes it
1923 impossible to override the affected portions of libgcj at run-time.
1925 @item --enable-reduced-reflection
1926 Build most of libgcj with @option{-freduced-reflection}.  This reduces
1927 the size of libgcj at the expense of not being able to do accurate
1928 reflection on the classes it contains.  This option is safe if you
1929 know that code using libgcj will never use reflection on the standard
1930 runtime classes in libgcj (including using serialization, RMI or CORBA).
1932 @item --with-ecos
1933 Enable runtime eCos target support.
1935 @item --without-libffi
1936 Don't use @samp{libffi}.  This will disable the interpreter and JNI
1937 support as well, as these require @samp{libffi} to work.
1939 @item --enable-libgcj-debug
1940 Enable runtime debugging code.
1942 @item --enable-libgcj-multifile
1943 If specified, causes all @file{.java} source files to be
1944 compiled into @file{.class} files in one invocation of
1945 @samp{gcj}.  This can speed up build time, but is more
1946 resource-intensive.  If this option is unspecified or
1947 disabled, @samp{gcj} is invoked once for each @file{.java}
1948 file to compile into a @file{.class} file.
1950 @item --with-libiconv-prefix=DIR
1951 Search for libiconv in @file{DIR/include} and @file{DIR/lib}.
1953 @item --enable-sjlj-exceptions
1954 Force use of the @code{setjmp}/@code{longjmp}-based scheme for exceptions.
1955 @samp{configure} ordinarily picks the correct value based on the platform.
1956 Only use this option if you are sure you need a different setting.
1958 @item --with-system-zlib
1959 Use installed @samp{zlib} rather than that included with GCC@.
1961 @item --with-win32-nlsapi=ansi, unicows or unicode
1962 Indicates how MinGW @samp{libgcj} translates between UNICODE
1963 characters and the Win32 API@.
1965 @item --enable-java-home
1966 If enabled, this creates a JPackage compatible SDK environment during install.
1967 Note that if --enable-java-home is used, --with-arch-directory=ARCH must also
1968 be specified.
1970 @item --with-arch-directory=ARCH
1971 Specifies the name to use for the @file{jre/lib/ARCH} directory in the SDK
1972 environment created when --enable-java-home is passed. Typical names for this
1973 directory include i386, amd64, ia64, etc.
1975 @item --with-os-directory=DIR
1976 Specifies the OS directory for the SDK include directory. This is set to auto
1977 detect, and is typically 'linux'.
1979 @item --with-origin-name=NAME
1980 Specifies the JPackage origin name. This defaults to the 'gcj' in
1981 java-1.5.0-gcj.
1983 @item --with-arch-suffix=SUFFIX
1984 Specifies the suffix for the sdk directory. Defaults to the empty string.
1985 Examples include '.x86_64' in 'java-1.5.0-gcj-1.5.0.0.x86_64'.
1987 @item --with-jvm-root-dir=DIR
1988 Specifies where to install the SDK. Default is $(prefix)/lib/jvm.
1990 @item --with-jvm-jar-dir=DIR
1991 Specifies where to install jars. Default is $(prefix)/lib/jvm-exports.
1993 @item --with-python-dir=DIR
1994 Specifies where to install the Python modules used for aot-compile. DIR should
1995 not include the prefix used in installation. For example, if the Python modules
1996 are to be installed in /usr/lib/python2.5/site-packages, then
1997 --with-python-dir=/lib/python2.5/site-packages should be passed. If this is
1998 not specified, then the Python modules are installed in $(prefix)/share/python.
2000 @item --enable-aot-compile-rpm
2001 Adds aot-compile-rpm to the list of installed scripts.
2003 @item --enable-browser-plugin
2004 Build the gcjwebplugin web browser plugin.
2006 @item --enable-static-libjava
2007 Build static libraries in libjava. The default is to only build shared
2008 libraries.
2010 @table @code
2011 @item ansi
2012 Use the single-byte @code{char} and the Win32 A functions natively,
2013 translating to and from UNICODE when using these functions.  If
2014 unspecified, this is the default.
2016 @item unicows
2017 Use the @code{WCHAR} and Win32 W functions natively.  Adds
2018 @code{-lunicows} to @file{libgcj.spec} to link with @samp{libunicows}.
2019 @file{unicows.dll} needs to be deployed on Microsoft Windows 9X machines
2020 running built executables.  @file{libunicows.a}, an open-source
2021 import library around Microsoft's @code{unicows.dll}, is obtained from
2022 @uref{http://libunicows.sourceforge.net/}, which also gives details
2023 on getting @file{unicows.dll} from Microsoft.
2025 @item unicode
2026 Use the @code{WCHAR} and Win32 W functions natively.  Does @emph{not}
2027 add @code{-lunicows} to @file{libgcj.spec}.  The built executables will
2028 only run on Microsoft Windows NT and above.
2029 @end table
2030 @end table
2032 @subsubheading AWT-Specific Options
2034 @table @code
2035 @item --with-x
2036 Use the X Window System.
2038 @item --enable-java-awt=PEER(S)
2039 Specifies the AWT peer library or libraries to build alongside
2040 @samp{libgcj}.  If this option is unspecified or disabled, AWT
2041 will be non-functional.  Current valid values are @option{gtk} and
2042 @option{xlib}.  Multiple libraries should be separated by a
2043 comma (i.e.@: @option{--enable-java-awt=gtk,xlib}).
2045 @item --enable-gtk-cairo
2046 Build the cairo Graphics2D implementation on GTK@.
2048 @item --enable-java-gc=TYPE
2049 Choose garbage collector.  Defaults to @option{boehm} if unspecified.
2051 @item --disable-gtktest
2052 Do not try to compile and run a test GTK+ program.
2054 @item --disable-glibtest
2055 Do not try to compile and run a test GLIB program.
2057 @item --with-libart-prefix=PFX
2058 Prefix where libart is installed (optional).
2060 @item --with-libart-exec-prefix=PFX
2061 Exec prefix where libart is installed (optional).
2063 @item --disable-libarttest
2064 Do not try to compile and run a test libart program.
2066 @end table
2068 @subsubheading Overriding @command{configure} test results
2070 Sometimes, it might be necessary to override the result of some
2071 @command{configure} test, for example in order to ease porting to a new
2072 system or work around a bug in a test.  The toplevel @command{configure}
2073 script provides three variables for this:
2075 @table @code
2077 @item build_configargs
2078 @cindex @code{build_configargs}
2079 The contents of this variable is passed to all build @command{configure}
2080 scripts.
2082 @item host_configargs
2083 @cindex @code{host_configargs}
2084 The contents of this variable is passed to all host @command{configure}
2085 scripts.
2087 @item target_configargs
2088 @cindex @code{target_configargs}
2089 The contents of this variable is passed to all target @command{configure}
2090 scripts.
2092 @end table
2094 In order to avoid shell and @command{make} quoting issues for complex
2095 overrides, you can pass a setting for @env{CONFIG_SITE} and set
2096 variables in the site file.
2098 @html
2099 <hr />
2101 @end html
2102 @ifhtml
2103 @uref{./index.html,,Return to the GCC Installation page}
2104 @end ifhtml
2105 @end ifset
2107 @c ***Building****************************************************************
2108 @ifnothtml
2109 @comment node-name,     next,          previous, up
2110 @node    Building, Testing, Configuration, Installing GCC
2111 @end ifnothtml
2112 @ifset buildhtml
2113 @ifnothtml
2114 @chapter Building
2115 @end ifnothtml
2116 @cindex Installing GCC: Building
2118 Now that GCC is configured, you are ready to build the compiler and
2119 runtime libraries.
2121 Some commands executed when making the compiler may fail (return a
2122 nonzero status) and be ignored by @command{make}.  These failures, which
2123 are often due to files that were not found, are expected, and can safely
2124 be ignored.
2126 It is normal to have compiler warnings when compiling certain files.
2127 Unless you are a GCC developer, you can generally ignore these warnings
2128 unless they cause compilation to fail.  Developers should attempt to fix
2129 any warnings encountered, however they can temporarily continue past
2130 warnings-as-errors by specifying the configure flag
2131 @option{--disable-werror}.
2133 On certain old systems, defining certain environment variables such as
2134 @env{CC} can interfere with the functioning of @command{make}.
2136 If you encounter seemingly strange errors when trying to build the
2137 compiler in a directory other than the source directory, it could be
2138 because you have previously configured the compiler in the source
2139 directory.  Make sure you have done all the necessary preparations.
2141 If you build GCC on a BSD system using a directory stored in an old System
2142 V file system, problems may occur in running @command{fixincludes} if the
2143 System V file system doesn't support symbolic links.  These problems
2144 result in a failure to fix the declaration of @code{size_t} in
2145 @file{sys/types.h}.  If you find that @code{size_t} is a signed type and
2146 that type mismatches occur, this could be the cause.
2148 The solution is not to use such a directory for building GCC@.
2150 Similarly, when building from SVN or snapshots, or if you modify
2151 @file{*.l} files, you need the Flex lexical analyzer generator
2152 installed.  If you do not modify @file{*.l} files, releases contain
2153 the Flex-generated files and you do not need Flex installed to build
2154 them.  There is still one Flex-based lexical analyzer (part of the
2155 build machinery, not of GCC itself) that is used even if you only
2156 build the C front end.
2158 When building from SVN or snapshots, or if you modify Texinfo
2159 documentation, you need version 4.7 or later of Texinfo installed if you
2160 want Info documentation to be regenerated.  Releases contain Info
2161 documentation pre-built for the unmodified documentation in the release.
2163 @section Building a native compiler
2165 For a native build, the default configuration is to perform
2166 a 3-stage bootstrap of the compiler when @samp{make} is invoked.
2167 This will build the entire GCC system and ensure that it compiles
2168 itself correctly.  It can be disabled with the @option{--disable-bootstrap}
2169 parameter to @samp{configure}, but bootstrapping is suggested because
2170 the compiler will be tested more completely and could also have
2171 better performance.
2173 The bootstrapping process will complete the following steps:
2175 @itemize @bullet
2176 @item
2177 Build tools necessary to build the compiler.
2179 @item
2180 Perform a 3-stage bootstrap of the compiler.  This includes building
2181 three times the target tools for use by the compiler such as binutils
2182 (bfd, binutils, gas, gprof, ld, and opcodes) if they have been
2183 individually linked or moved into the top level GCC source tree before
2184 configuring.
2186 @item
2187 Perform a comparison test of the stage2 and stage3 compilers.
2189 @item
2190 Build runtime libraries using the stage3 compiler from the previous step.
2192 @end itemize
2194 If you are short on disk space you might consider @samp{make
2195 bootstrap-lean} instead.  The sequence of compilation is the
2196 same described above, but object files from the stage1 and
2197 stage2 of the 3-stage bootstrap of the compiler are deleted as
2198 soon as they are no longer needed.
2200 If you wish to use non-default GCC flags when compiling the stage2
2201 and stage3 compilers, set @code{BOOT_CFLAGS} on the command line when
2202 doing @samp{make}.  For example, if you want to save additional space
2203 during the bootstrap and in the final installation as well, you can
2204 build the compiler binaries without debugging information as in the
2205 following example.  This will save roughly 40% of disk space both for
2206 the bootstrap and the final installation.  (Libraries will still contain
2207 debugging information.)
2209 @smallexample
2210 make BOOT_CFLAGS='-O' bootstrap
2211 @end smallexample
2213 You can place non-default optimization flags into @code{BOOT_CFLAGS}; they
2214 are less well tested here than the default of @samp{-g -O2}, but should
2215 still work.  In a few cases, you may find that you need to specify special
2216 flags such as @option{-msoft-float} here to complete the bootstrap; or,
2217 if the native compiler miscompiles the stage1 compiler, you may need
2218 to work around this, by choosing @code{BOOT_CFLAGS} to avoid the parts
2219 of the stage1 compiler that were miscompiled, or by using @samp{make
2220 bootstrap4} to increase the number of stages of bootstrap.
2222 @code{BOOT_CFLAGS} does not apply to bootstrapped target libraries.
2223 Since these are always compiled with the compiler currently being
2224 bootstrapped, you can use @code{CFLAGS_FOR_TARGET} to modify their
2225 compilation flags, as for non-bootstrapped target libraries.
2226 Again, if the native compiler miscompiles the stage1 compiler, you may
2227 need to work around this by avoiding non-working parts of the stage1
2228 compiler.  Use @code{STAGE1_TFLAGS} to this end.
2230 If you used the flag @option{--enable-languages=@dots{}} to restrict
2231 the compilers to be built, only those you've actually enabled will be
2232 built.  This will of course only build those runtime libraries, for
2233 which the particular compiler has been built.  Please note,
2234 that re-defining @env{LANGUAGES} when calling @samp{make}
2235 @strong{does not} work anymore!
2237 If the comparison of stage2 and stage3 fails, this normally indicates
2238 that the stage2 compiler has compiled GCC incorrectly, and is therefore
2239 a potentially serious bug which you should investigate and report.  (On
2240 a few systems, meaningful comparison of object files is impossible; they
2241 always appear ``different''.  If you encounter this problem, you will
2242 need to disable comparison in the @file{Makefile}.)
2244 If you do not want to bootstrap your compiler, you can configure with
2245 @option{--disable-bootstrap}.  In particular cases, you may want to
2246 bootstrap your compiler even if the target system is not the same as
2247 the one you are building on: for example, you could build a
2248 @code{powerpc-unknown-linux-gnu} toolchain on a
2249 @code{powerpc64-unknown-linux-gnu} host.  In this case, pass
2250 @option{--enable-bootstrap} to the configure script.
2252 @code{BUILD_CONFIG} can be used to bring in additional customization
2253 to the build.  It can be set to a whitespace-separated list of names.
2254 For each such @code{NAME}, top-level @file{config/@code{NAME}.mk} will
2255 be included by the top-level @file{Makefile}, bringing in any settings
2256 it contains.  The default @code{BUILD_CONFIG} can be set using the
2257 configure option @option{--with-build-config=@code{NAME}...}.  Some
2258 examples of supported build configurations are:
2260 @table @asis
2261 @item @samp{bootstrap-O1}
2262 Removes any @option{-O}-started option from @code{BOOT_CFLAGS}, and adds
2263 @option{-O1} to it.  @samp{BUILD_CONFIG=bootstrap-O1} is equivalent to
2264 @samp{BOOT_CFLAGS='-g -O1'}.
2266 @item @samp{bootstrap-O3}
2267 Analogous to @code{bootstrap-O1}.
2269 @item @samp{bootstrap-lto}
2270 Enables Link-Time Optimization for host tools during bootstrapping.
2271 @samp{BUILD_CONFIG=bootstrap-lto} is equivalent to adding
2272 @option{-flto} to @samp{BOOT_CFLAGS}.
2274 @item @samp{bootstrap-debug}
2275 Verifies that the compiler generates the same executable code, whether
2276 or not it is asked to emit debug information.  To this end, this
2277 option builds stage2 host programs without debug information, and uses
2278 @file{contrib/compare-debug} to compare them with the stripped stage3
2279 object files.  If @code{BOOT_CFLAGS} is overridden so as to not enable
2280 debug information, stage2 will have it, and stage3 won't.  This option
2281 is enabled by default when GCC bootstrapping is enabled, if
2282 @code{strip} can turn object files compiled with and without debug
2283 info into identical object files.  In addition to better test
2284 coverage, this option makes default bootstraps faster and leaner.
2286 @item @samp{bootstrap-debug-big}
2287 Rather than comparing stripped object files, as in
2288 @code{bootstrap-debug}, this option saves internal compiler dumps
2289 during stage2 and stage3 and compares them as well, which helps catch
2290 additional potential problems, but at a great cost in terms of disk
2291 space.  It can be specified in addition to @samp{bootstrap-debug}.
2293 @item @samp{bootstrap-debug-lean}
2294 This option saves disk space compared with @code{bootstrap-debug-big},
2295 but at the expense of some recompilation.  Instead of saving the dumps
2296 of stage2 and stage3 until the final compare, it uses
2297 @option{-fcompare-debug} to generate, compare and remove the dumps
2298 during stage3, repeating the compilation that already took place in
2299 stage2, whose dumps were not saved.
2301 @item @samp{bootstrap-debug-lib}
2302 This option tests executable code invariance over debug information
2303 generation on target libraries, just like @code{bootstrap-debug-lean}
2304 tests it on host programs.  It builds stage3 libraries with
2305 @option{-fcompare-debug}, and it can be used along with any of the
2306 @code{bootstrap-debug} options above.
2308 There aren't @code{-lean} or @code{-big} counterparts to this option
2309 because most libraries are only build in stage3, so bootstrap compares
2310 would not get significant coverage.  Moreover, the few libraries built
2311 in stage2 are used in stage3 host programs, so we wouldn't want to
2312 compile stage2 libraries with different options for comparison purposes.
2314 @item @samp{bootstrap-debug-ckovw}
2315 Arranges for error messages to be issued if the compiler built on any
2316 stage is run without the option @option{-fcompare-debug}.  This is
2317 useful to verify the full @option{-fcompare-debug} testing coverage.  It
2318 must be used along with @code{bootstrap-debug-lean} and
2319 @code{bootstrap-debug-lib}.
2321 @item @samp{bootstrap-time}
2322 Arranges for the run time of each program started by the GCC driver,
2323 built in any stage, to be logged to @file{time.log}, in the top level of
2324 the build tree.
2326 @end table
2328 @section Building a cross compiler
2330 When building a cross compiler, it is not generally possible to do a
2331 3-stage bootstrap of the compiler.  This makes for an interesting problem
2332 as parts of GCC can only be built with GCC@.
2334 To build a cross compiler, we recommend first building and installing a
2335 native compiler.  You can then use the native GCC compiler to build the
2336 cross compiler.  The installed native compiler needs to be GCC version
2337 2.95 or later.
2339 If the cross compiler is to be built with support for the Java
2340 programming language and the ability to compile .java source files is
2341 desired, the installed native compiler used to build the cross
2342 compiler needs to be the same GCC version as the cross compiler.  In
2343 addition the cross compiler needs to be configured with
2344 @option{--with-ecj-jar=@dots{}}.
2346 Assuming you have already installed a native copy of GCC and configured
2347 your cross compiler, issue the command @command{make}, which performs the
2348 following steps:
2350 @itemize @bullet
2351 @item
2352 Build host tools necessary to build the compiler.
2354 @item
2355 Build target tools for use by the compiler such as binutils (bfd,
2356 binutils, gas, gprof, ld, and opcodes)
2357 if they have been individually linked or moved into the top level GCC source
2358 tree before configuring.
2360 @item
2361 Build the compiler (single stage only).
2363 @item
2364 Build runtime libraries using the compiler from the previous step.
2365 @end itemize
2367 Note that if an error occurs in any step the make process will exit.
2369 If you are not building GNU binutils in the same source tree as GCC,
2370 you will need a cross-assembler and cross-linker installed before
2371 configuring GCC@.  Put them in the directory
2372 @file{@var{prefix}/@var{target}/bin}.  Here is a table of the tools
2373 you should put in this directory:
2375 @table @file
2376 @item as
2377 This should be the cross-assembler.
2379 @item ld
2380 This should be the cross-linker.
2382 @item ar
2383 This should be the cross-archiver: a program which can manipulate
2384 archive files (linker libraries) in the target machine's format.
2386 @item ranlib
2387 This should be a program to construct a symbol table in an archive file.
2388 @end table
2390 The installation of GCC will find these programs in that directory,
2391 and copy or link them to the proper place to for the cross-compiler to
2392 find them when run later.
2394 The easiest way to provide these files is to build the Binutils package.
2395 Configure it with the same @option{--host} and @option{--target}
2396 options that you use for configuring GCC, then build and install
2397 them.  They install their executables automatically into the proper
2398 directory.  Alas, they do not support all the targets that GCC
2399 supports.
2401 If you are not building a C library in the same source tree as GCC,
2402 you should also provide the target libraries and headers before
2403 configuring GCC, specifying the directories with
2404 @option{--with-sysroot} or @option{--with-headers} and
2405 @option{--with-libs}.  Many targets also require ``start files'' such
2406 as @file{crt0.o} and
2407 @file{crtn.o} which are linked into each executable.  There may be several
2408 alternatives for @file{crt0.o}, for use with profiling or other
2409 compilation options.  Check your target's definition of
2410 @code{STARTFILE_SPEC} to find out what start files it uses.
2412 @section Building in parallel
2414 GNU Make 3.80 and above, which is necessary to build GCC, support
2415 building in parallel.  To activate this, you can use @samp{make -j 2}
2416 instead of @samp{make}.  You can also specify a bigger number, and
2417 in most cases using a value greater than the number of processors in
2418 your machine will result in fewer and shorter I/O latency hits, thus
2419 improving overall throughput; this is especially true for slow drives
2420 and network filesystems.
2422 @section Building the Ada compiler
2424 In order to build GNAT, the Ada compiler, you need a working GNAT
2425 compiler (GCC version 4.0 or later).
2426 This includes GNAT tools such as @command{gnatmake} and
2427 @command{gnatlink}, since the Ada front end is written in Ada and
2428 uses some GNAT-specific extensions.
2430 In order to build a cross compiler, it is suggested to install
2431 the new compiler as native first, and then use it to build the cross
2432 compiler.
2434 @command{configure} does not test whether the GNAT installation works
2435 and has a sufficiently recent version; if too old a GNAT version is
2436 installed, the build will fail unless @option{--enable-languages} is
2437 used to disable building the Ada front end.
2439 @env{ADA_INCLUDE_PATH} and @env{ADA_OBJECT_PATH} environment variables
2440 must not be set when building the Ada compiler, the Ada tools, or the
2441 Ada runtime libraries. You can check that your build environment is clean
2442 by verifying that @samp{gnatls -v} lists only one explicit path in each
2443 section.
2445 @section Building with profile feedback
2447 It is possible to use profile feedback to optimize the compiler itself.  This
2448 should result in a faster compiler binary.  Experiments done on x86 using gcc
2449 3.3 showed approximately 7 percent speedup on compiling C programs.  To
2450 bootstrap the compiler with profile feedback, use @code{make profiledbootstrap}.
2452 When @samp{make profiledbootstrap} is run, it will first build a @code{stage1}
2453 compiler.  This compiler is used to build a @code{stageprofile} compiler
2454 instrumented to collect execution counts of instruction and branch
2455 probabilities.  Then runtime libraries are compiled with profile collected.
2456 Finally a @code{stagefeedback} compiler is built using the information collected.
2458 Unlike standard bootstrap, several additional restrictions apply.  The
2459 compiler used to build @code{stage1} needs to support a 64-bit integral type.
2460 It is recommended to only use GCC for this.  Also parallel make is currently
2461 not supported since collisions in profile collecting may occur.
2463 @html
2464 <hr />
2466 @end html
2467 @ifhtml
2468 @uref{./index.html,,Return to the GCC Installation page}
2469 @end ifhtml
2470 @end ifset
2472 @c ***Testing*****************************************************************
2473 @ifnothtml
2474 @comment node-name,     next,          previous, up
2475 @node    Testing, Final install, Building, Installing GCC
2476 @end ifnothtml
2477 @ifset testhtml
2478 @ifnothtml
2479 @chapter Installing GCC: Testing
2480 @end ifnothtml
2481 @cindex Testing
2482 @cindex Installing GCC: Testing
2483 @cindex Testsuite
2485 Before you install GCC, we encourage you to run the testsuites and to
2486 compare your results with results from a similar configuration that have
2487 been submitted to the
2488 @uref{http://gcc.gnu.org/ml/gcc-testresults/,,gcc-testresults mailing list}.
2489 Some of these archived results are linked from the build status lists
2490 at @uref{http://gcc.gnu.org/buildstat.html}, although not everyone who
2491 reports a successful build runs the testsuites and submits the results.
2492 This step is optional and may require you to download additional software,
2493 but it can give you confidence in your new GCC installation or point out
2494 problems before you install and start using your new GCC@.
2496 First, you must have @uref{download.html,,downloaded the testsuites}.
2497 These are part of the full distribution, but if you downloaded the
2498 ``core'' compiler plus any front ends, you must download the testsuites
2499 separately.
2501 Second, you must have the testing tools installed.  This includes
2502 @uref{http://www.gnu.org/software/dejagnu/,,DejaGnu}, Tcl, and Expect;
2503 the DejaGnu site has links to these.
2505 If the directories where @command{runtest} and @command{expect} were
2506 installed are not in the @env{PATH}, you may need to set the following
2507 environment variables appropriately, as in the following example (which
2508 assumes that DejaGnu has been installed under @file{/usr/local}):
2510 @smallexample
2511 TCL_LIBRARY = /usr/local/share/tcl8.0
2512 DEJAGNULIBS = /usr/local/share/dejagnu
2513 @end smallexample
2515 (On systems such as Cygwin, these paths are required to be actual
2516 paths, not mounts or links; presumably this is due to some lack of
2517 portability in the DejaGnu code.)
2520 Finally, you can run the testsuite (which may take a long time):
2521 @smallexample
2522 cd @var{objdir}; make -k check
2523 @end smallexample
2525 This will test various components of GCC, such as compiler
2526 front ends and runtime libraries.  While running the testsuite, DejaGnu
2527 might emit some harmless messages resembling
2528 @samp{WARNING: Couldn't find the global config file.} or
2529 @samp{WARNING: Couldn't find tool init file} that can be ignored.
2531 If you are testing a cross-compiler, you may want to run the testsuite
2532 on a simulator as described at @uref{http://gcc.gnu.org/simtest-howto.html}.
2534 @section How can you run the testsuite on selected tests?
2536 In order to run sets of tests selectively, there are targets
2537 @samp{make check-gcc} and language specific @samp{make check-c},
2538 @samp{make check-c++}, @samp{make check-fortran}, @samp{make check-java},
2539 @samp{make check-ada}, @samp{make check-objc}, @samp{make check-obj-c++},
2540 @samp{make check-lto}
2541 in the @file{gcc} subdirectory of the object directory.  You can also
2542 just run @samp{make check} in a subdirectory of the object directory.
2545 A more selective way to just run all @command{gcc} execute tests in the
2546 testsuite is to use
2548 @smallexample
2549 make check-gcc RUNTESTFLAGS="execute.exp @var{other-options}"
2550 @end smallexample
2552 Likewise, in order to run only the @command{g++} ``old-deja'' tests in
2553 the testsuite with filenames matching @samp{9805*}, you would use
2555 @smallexample
2556 make check-g++ RUNTESTFLAGS="old-deja.exp=9805* @var{other-options}"
2557 @end smallexample
2559 The @file{*.exp} files are located in the testsuite directories of the GCC
2560 source, the most important ones being @file{compile.exp},
2561 @file{execute.exp}, @file{dg.exp} and @file{old-deja.exp}.
2562 To get a list of the possible @file{*.exp} files, pipe the
2563 output of @samp{make check} into a file and look at the
2564 @samp{Running @dots{}  .exp} lines.
2566 @section Passing options and running multiple testsuites
2568 You can pass multiple options to the testsuite using the
2569 @samp{--target_board} option of DejaGNU, either passed as part of
2570 @samp{RUNTESTFLAGS}, or directly to @command{runtest} if you prefer to
2571 work outside the makefiles.  For example,
2573 @smallexample
2574 make check-g++ RUNTESTFLAGS="--target_board=unix/-O3/-fmerge-constants"
2575 @end smallexample
2577 will run the standard @command{g++} testsuites (``unix'' is the target name
2578 for a standard native testsuite situation), passing
2579 @samp{-O3 -fmerge-constants} to the compiler on every test, i.e.,
2580 slashes separate options.
2582 You can run the testsuites multiple times using combinations of options
2583 with a syntax similar to the brace expansion of popular shells:
2585 @smallexample
2586 @dots{}"--target_board=arm-sim\@{-mhard-float,-msoft-float\@}\@{-O1,-O2,-O3,\@}"
2587 @end smallexample
2589 (Note the empty option caused by the trailing comma in the final group.)
2590 The following will run each testsuite eight times using the @samp{arm-sim}
2591 target, as if you had specified all possible combinations yourself:
2593 @smallexample
2594 --target_board='arm-sim/-mhard-float/-O1 \
2595                 arm-sim/-mhard-float/-O2 \
2596                 arm-sim/-mhard-float/-O3 \
2597                 arm-sim/-mhard-float \
2598                 arm-sim/-msoft-float/-O1 \
2599                 arm-sim/-msoft-float/-O2 \
2600                 arm-sim/-msoft-float/-O3 \
2601                 arm-sim/-msoft-float'
2602 @end smallexample
2604 They can be combined as many times as you wish, in arbitrary ways.  This
2605 list:
2607 @smallexample
2608 @dots{}"--target_board=unix/-Wextra\@{-O3,-fno-strength\@}\@{-fomit-frame,\@}"
2609 @end smallexample
2611 will generate four combinations, all involving @samp{-Wextra}.
2613 The disadvantage to this method is that the testsuites are run in serial,
2614 which is a waste on multiprocessor systems.  For users with GNU Make and
2615 a shell which performs brace expansion, you can run the testsuites in
2616 parallel by having the shell perform the combinations and @command{make}
2617 do the parallel runs.  Instead of using @samp{--target_board}, use a
2618 special makefile target:
2620 @smallexample
2621 make -j@var{N} check-@var{testsuite}//@var{test-target}/@var{option1}/@var{option2}/@dots{}
2622 @end smallexample
2624 For example,
2626 @smallexample
2627 make -j3 check-gcc//sh-hms-sim/@{-m1,-m2,-m3,-m3e,-m4@}/@{,-nofpu@}
2628 @end smallexample
2630 will run three concurrent ``make-gcc'' testsuites, eventually testing all
2631 ten combinations as described above.  Note that this is currently only
2632 supported in the @file{gcc} subdirectory.  (To see how this works, try
2633 typing @command{echo} before the example given here.)
2636 @section Additional testing for Java Class Libraries
2638 The Java runtime tests can be executed via @samp{make check}
2639 in the @file{@var{target}/libjava/testsuite} directory in
2640 the build tree.
2642 The @uref{http://sourceware.org/mauve/,,Mauve Project} provides
2643 a suite of tests for the Java Class Libraries.  This suite can be run
2644 as part of libgcj testing by placing the Mauve tree within the libjava
2645 testsuite at @file{libjava/testsuite/libjava.mauve/mauve}, or by
2646 specifying the location of that tree when invoking @samp{make}, as in
2647 @samp{make MAUVEDIR=~/mauve check}.
2649 @section How to interpret test results
2651 The result of running the testsuite are various @file{*.sum} and @file{*.log}
2652 files in the testsuite subdirectories.  The @file{*.log} files contain a
2653 detailed log of the compiler invocations and the corresponding
2654 results, the @file{*.sum} files summarize the results.  These summaries
2655 contain status codes for all tests:
2657 @itemize @bullet
2658 @item
2659 PASS: the test passed as expected
2660 @item
2661 XPASS: the test unexpectedly passed
2662 @item
2663 FAIL: the test unexpectedly failed
2664 @item
2665 XFAIL: the test failed as expected
2666 @item
2667 UNSUPPORTED: the test is not supported on this platform
2668 @item
2669 ERROR: the testsuite detected an error
2670 @item
2671 WARNING: the testsuite detected a possible problem
2672 @end itemize
2674 It is normal for some tests to report unexpected failures.  At the
2675 current time the testing harness does not allow fine grained control
2676 over whether or not a test is expected to fail.  This problem should
2677 be fixed in future releases.
2680 @section Submitting test results
2682 If you want to report the results to the GCC project, use the
2683 @file{contrib/test_summary} shell script.  Start it in the @var{objdir} with
2685 @smallexample
2686 @var{srcdir}/contrib/test_summary -p your_commentary.txt \
2687     -m gcc-testresults@@gcc.gnu.org |sh
2688 @end smallexample
2690 This script uses the @command{Mail} program to send the results, so
2691 make sure it is in your @env{PATH}.  The file @file{your_commentary.txt} is
2692 prepended to the testsuite summary and should contain any special
2693 remarks you have on your results or your build environment.  Please
2694 do not edit the testsuite result block or the subject line, as these
2695 messages may be automatically processed.
2697 @html
2698 <hr />
2700 @end html
2701 @ifhtml
2702 @uref{./index.html,,Return to the GCC Installation page}
2703 @end ifhtml
2704 @end ifset
2706 @c ***Final install***********************************************************
2707 @ifnothtml
2708 @comment node-name,     next,          previous, up
2709 @node    Final install, , Testing, Installing GCC
2710 @end ifnothtml
2711 @ifset finalinstallhtml
2712 @ifnothtml
2713 @chapter Installing GCC: Final installation
2714 @end ifnothtml
2716 Now that GCC has been built (and optionally tested), you can install it with
2717 @smallexample
2718 cd @var{objdir} && make install
2719 @end smallexample
2721 We strongly recommend to install into a target directory where there is
2722 no previous version of GCC present.  Also, the GNAT runtime should not
2723 be stripped, as this would break certain features of the debugger that
2724 depend on this debugging information (catching Ada exceptions for
2725 instance).
2727 That step completes the installation of GCC; user level binaries can
2728 be found in @file{@var{prefix}/bin} where @var{prefix} is the value
2729 you specified with the @option{--prefix} to configure (or
2730 @file{/usr/local} by default).  (If you specified @option{--bindir},
2731 that directory will be used instead; otherwise, if you specified
2732 @option{--exec-prefix}, @file{@var{exec-prefix}/bin} will be used.)
2733 Headers for the C++ and Java libraries are installed in
2734 @file{@var{prefix}/include}; libraries in @file{@var{libdir}}
2735 (normally @file{@var{prefix}/lib}); internal parts of the compiler in
2736 @file{@var{libdir}/gcc} and @file{@var{libexecdir}/gcc}; documentation
2737 in info format in @file{@var{infodir}} (normally
2738 @file{@var{prefix}/info}).
2740 When installing cross-compilers, GCC's executables
2741 are not only installed into @file{@var{bindir}}, that
2742 is, @file{@var{exec-prefix}/bin}, but additionally into
2743 @file{@var{exec-prefix}/@var{target-alias}/bin}, if that directory
2744 exists.  Typically, such @dfn{tooldirs} hold target-specific
2745 binutils, including assembler and linker.
2747 Installation into a temporary staging area or into a @command{chroot}
2748 jail can be achieved with the command
2750 @smallexample
2751 make DESTDIR=@var{path-to-rootdir} install
2752 @end smallexample
2754 @noindent
2755 where @var{path-to-rootdir} is the absolute path of
2756 a directory relative to which all installation paths will be
2757 interpreted.  Note that the directory specified by @code{DESTDIR}
2758 need not exist yet; it will be created if necessary.
2760 There is a subtle point with tooldirs and @code{DESTDIR}:
2761 If you relocate a cross-compiler installation with
2762 e.g.@: @samp{DESTDIR=@var{rootdir}}, then the directory
2763 @file{@var{rootdir}/@var{exec-prefix}/@var{target-alias}/bin} will
2764 be filled with duplicated GCC executables only if it already exists,
2765 it will not be created otherwise.  This is regarded as a feature,
2766 not as a bug, because it gives slightly more control to the packagers
2767 using the @code{DESTDIR} feature.
2769 You can install stripped programs and libraries with
2771 @smallexample
2772 make install-strip
2773 @end smallexample
2775 If you are bootstrapping a released version of GCC then please
2776 quickly review the build status page for your release, available from
2777 @uref{http://gcc.gnu.org/buildstat.html}.
2778 If your system is not listed for the version of GCC that you built,
2779 send a note to
2780 @email{gcc@@gcc.gnu.org} indicating
2781 that you successfully built and installed GCC@.
2782 Include the following information:
2784 @itemize @bullet
2785 @item
2786 Output from running @file{@var{srcdir}/config.guess}.  Do not send
2787 that file itself, just the one-line output from running it.
2789 @item
2790 The output of @samp{gcc -v} for your newly installed @command{gcc}.
2791 This tells us which version of GCC you built and the options you passed to
2792 configure.
2794 @item
2795 Whether you enabled all languages or a subset of them.  If you used a
2796 full distribution then this information is part of the configure
2797 options in the output of @samp{gcc -v}, but if you downloaded the
2798 ``core'' compiler plus additional front ends then it isn't apparent
2799 which ones you built unless you tell us about it.
2801 @item
2802 If the build was for GNU/Linux, also include:
2803 @itemize @bullet
2804 @item
2805 The distribution name and version (e.g., Red Hat 7.1 or Debian 2.2.3);
2806 this information should be available from @file{/etc/issue}.
2808 @item
2809 The version of the Linux kernel, available from @samp{uname --version}
2810 or @samp{uname -a}.
2812 @item
2813 The version of glibc you used; for RPM-based systems like Red Hat,
2814 Mandrake, and SuSE type @samp{rpm -q glibc} to get the glibc version,
2815 and on systems like Debian and Progeny use @samp{dpkg -l libc6}.
2816 @end itemize
2817 For other systems, you can include similar information if you think it is
2818 relevant.
2820 @item
2821 Any other information that you think would be useful to people building
2822 GCC on the same configuration.  The new entry in the build status list
2823 will include a link to the archived copy of your message.
2824 @end itemize
2826 We'd also like to know if the
2827 @ifnothtml
2828 @ref{Specific, host/target specific installation notes}
2829 @end ifnothtml
2830 @ifhtml
2831 @uref{specific.html,,host/target specific installation notes}
2832 @end ifhtml
2833 didn't include your host/target information or if that information is
2834 incomplete or out of date.  Send a note to
2835 @email{gcc@@gcc.gnu.org} detailing how the information should be changed.
2837 If you find a bug, please report it following the
2838 @uref{../bugs/,,bug reporting guidelines}.
2840 If you want to print the GCC manuals, do @samp{cd @var{objdir}; make
2841 dvi}.  You will need to have @command{texi2dvi} (version at least 4.7)
2842 and @TeX{} installed.  This creates a number of @file{.dvi} files in
2843 subdirectories of @file{@var{objdir}}; these may be converted for
2844 printing with programs such as @command{dvips}.  Alternately, by using
2845 @samp{make pdf} in place of @samp{make dvi}, you can create documentation
2846 in the form of @file{.pdf} files; this requires @command{texi2pdf}, which
2847 is included with Texinfo version 4.8 and later.  You can also
2848 @uref{http://shop.fsf.org/,,buy printed manuals from the
2849 Free Software Foundation}, though such manuals may not be for the most
2850 recent version of GCC@.
2852 If you would like to generate online HTML documentation, do @samp{cd
2853 @var{objdir}; make html} and HTML will be generated for the gcc manuals in
2854 @file{@var{objdir}/gcc/HTML}.
2856 @html
2857 <hr />
2859 @end html
2860 @ifhtml
2861 @uref{./index.html,,Return to the GCC Installation page}
2862 @end ifhtml
2863 @end ifset
2865 @c ***Binaries****************************************************************
2866 @ifnothtml
2867 @comment node-name,     next,          previous, up
2868 @node    Binaries, Specific, Installing GCC, Top
2869 @end ifnothtml
2870 @ifset binarieshtml
2871 @ifnothtml
2872 @chapter Installing GCC: Binaries
2873 @end ifnothtml
2874 @cindex Binaries
2875 @cindex Installing GCC: Binaries
2877 We are often asked about pre-compiled versions of GCC@.  While we cannot
2878 provide these for all platforms, below you'll find links to binaries for
2879 various platforms where creating them by yourself is not easy due to various
2880 reasons.
2882 Please note that we did not create these binaries, nor do we
2883 support them.  If you have any problems installing them, please
2884 contact their makers.
2886 @itemize
2887 @item
2888 AIX:
2889 @itemize
2890 @item
2891 @uref{http://www.bullfreeware.com,,Bull's Freeware and Shareware Archive for AIX};
2893 @item
2894 @uref{http://pware.hvcc.edu,,Hudson Valley Community College Open Source Software for IBM System p};
2896 @item
2897 @uref{http://www.perzl.org/aix/,,AIX 5L and 6 Open Source Packages}.
2898 @end itemize
2900 @item
2901 DOS---@uref{http://www.delorie.com/djgpp/,,DJGPP}.
2903 @item
2904 Renesas H8/300[HS]---@uref{http://h8300-hms.sourceforge.net/,,GNU
2905 Development Tools for the Renesas H8/300[HS] Series}.
2907 @item
2908 HP-UX:
2909 @itemize
2910 @item
2911 @uref{http://hpux.connect.org.uk/,,HP-UX Porting Center};
2913 @item
2914 @uref{ftp://sunsite.informatik.rwth-aachen.de/pub/packages/gcc_hpux/,,Binaries for HP-UX 11.00 at Aachen University of Technology}.
2915 @end itemize
2917 @item
2918 @uref{http://www.sco.com/skunkware/devtools/index.html#gcc,,SCO
2919 OpenServer/Unixware}.
2921 @item
2922 Solaris 2 (SPARC, Intel):
2923 @itemize
2924 @item
2925 @uref{http://www.sunfreeware.com/,,Sunfreeware}
2927 @item
2928 @uref{http://www.blastwave.org/,,Blastwave}
2930 @item
2931 @uref{http://www.opencsw.org/,,OpenCSW}
2933 @item
2934 @uref{http://jupiterrise.com/tgcware/,,TGCware}
2935 @end itemize
2937 @item
2938 Microsoft Windows:
2939 @itemize
2940 @item
2941 The @uref{http://sourceware.org/cygwin/,,Cygwin} project;
2942 @item
2943 The @uref{http://www.mingw.org/,,MinGW} project.
2944 @end itemize
2946 @item
2947 @uref{ftp://ftp.thewrittenword.com/packages/by-name/,,The
2948 Written Word} offers binaries for
2949 AIX 4.3.3, 5.1 and 5.2,
2950 GNU/Linux (i386),
2951 HP-UX 10.20, 11.00, and 11.11, and
2952 Solaris/SPARC 2.5.1, 2.6, 7, 8, 9 and 10.
2954 @item
2955 @uref{http://www.openpkg.org/,,OpenPKG} offers binaries for quite a
2956 number of platforms.
2958 @item
2959 The @uref{http://gcc.gnu.org/wiki/GFortranBinaries,,GFortran Wiki} has
2960 links to GNU Fortran binaries for several platforms.
2961 @end itemize
2963 @html
2964 <hr />
2966 @end html
2967 @ifhtml
2968 @uref{./index.html,,Return to the GCC Installation page}
2969 @end ifhtml
2970 @end ifset
2972 @c ***Specific****************************************************************
2973 @ifnothtml
2974 @comment node-name,     next,          previous, up
2975 @node    Specific, Old, Binaries, Top
2976 @end ifnothtml
2977 @ifset specifichtml
2978 @ifnothtml
2979 @chapter Host/target specific installation notes for GCC
2980 @end ifnothtml
2981 @cindex Specific
2982 @cindex Specific installation notes
2983 @cindex Target specific installation
2984 @cindex Host specific installation
2985 @cindex Target specific installation notes
2987 Please read this document carefully @emph{before} installing the
2988 GNU Compiler Collection on your machine.
2990 Note that this list of install notes is @emph{not} a list of supported
2991 hosts or targets.  Not all supported hosts and targets are listed
2992 here, only the ones that require host-specific or target-specific
2993 information have to. 
2995 @ifhtml
2996 @itemize
2997 @item
2998 @uref{#alpha-x-x,,alpha*-*-*}
2999 @item
3000 @uref{#alpha-dec-osf51,,alpha*-dec-osf5.1}
3001 @item
3002 @uref{#amd64-x-solaris210,,amd64-*-solaris2.10}
3003 @item
3004 @uref{#arm-x-eabi,,arm-*-eabi}
3005 @item
3006 @uref{#avr,,avr}
3007 @item
3008 @uref{#bfin,,Blackfin}
3009 @item
3010 @uref{#dos,,DOS}
3011 @item
3012 @uref{#x-x-freebsd,,*-*-freebsd*}
3013 @item
3014 @uref{#h8300-hms,,h8300-hms}
3015 @item
3016 @uref{#hppa-hp-hpux,,hppa*-hp-hpux*}
3017 @item
3018 @uref{#hppa-hp-hpux10,,hppa*-hp-hpux10}
3019 @item
3020 @uref{#hppa-hp-hpux11,,hppa*-hp-hpux11}
3021 @item
3022 @uref{#x-x-linux-gnu,,*-*-linux-gnu}
3023 @item
3024 @uref{#ix86-x-linux,,i?86-*-linux*}
3025 @item
3026 @uref{#ix86-x-solaris289,,i?86-*-solaris2.9}
3027 @item
3028 @uref{#ix86-x-solaris210,,i?86-*-solaris2.10}
3029 @item
3030 @uref{#ia64-x-linux,,ia64-*-linux}
3031 @item
3032 @uref{#ia64-x-hpux,,ia64-*-hpux*}
3033 @item
3034 @uref{#x-ibm-aix,,*-ibm-aix*}
3035 @item
3036 @uref{#iq2000-x-elf,,iq2000-*-elf}
3037 @item
3038 @uref{#lm32-x-elf,,lm32-*-elf}
3039 @item
3040 @uref{#lm32-x-uclinux,,lm32-*-uclinux}
3041 @item
3042 @uref{#m32c-x-elf,,m32c-*-elf}
3043 @item
3044 @uref{#m32r-x-elf,,m32r-*-elf}
3045 @item
3046 @uref{#m68k-x-x,,m68k-*-*}
3047 @item
3048 @uref{#m68k-uclinux,,m68k-uclinux}
3049 @item
3050 @uref{#mep-x-elf,,mep-*-elf}
3051 @item
3052 @uref{#microblaze-x-elf,,microblaze-*-elf}
3053 @item
3054 @uref{#mips-x-x,,mips-*-*}
3055 @item
3056 @uref{#mips-sgi-irix5,,mips-sgi-irix5}
3057 @item
3058 @uref{#mips-sgi-irix6,,mips-sgi-irix6}
3059 @item
3060 @uref{#powerpc-x-x,,powerpc*-*-*}
3061 @item
3062 @uref{#powerpc-x-darwin,,powerpc-*-darwin*}
3063 @item
3064 @uref{#powerpc-x-elf,,powerpc-*-elf}
3065 @item
3066 @uref{#powerpc-x-linux-gnu,,powerpc*-*-linux-gnu*}
3067 @item
3068 @uref{#powerpc-x-netbsd,,powerpc-*-netbsd*}
3069 @item
3070 @uref{#powerpc-x-eabisim,,powerpc-*-eabisim}
3071 @item
3072 @uref{#powerpc-x-eabi,,powerpc-*-eabi}
3073 @item
3074 @uref{#powerpcle-x-elf,,powerpcle-*-elf}
3075 @item
3076 @uref{#powerpcle-x-eabisim,,powerpcle-*-eabisim}
3077 @item
3078 @uref{#powerpcle-x-eabi,,powerpcle-*-eabi}
3079 @item
3080 @uref{#s390-x-linux,,s390-*-linux*}
3081 @item
3082 @uref{#s390x-x-linux,,s390x-*-linux*}
3083 @item
3084 @uref{#s390x-ibm-tpf,,s390x-ibm-tpf*}
3085 @item
3086 @uref{#x-x-solaris2,,*-*-solaris2*}
3087 @item
3088 @uref{#sparc-x-x,,sparc*-*-*}
3089 @item
3090 @uref{#sparc-sun-solaris2,,sparc-sun-solaris2*}
3091 @item
3092 @uref{#sparc-sun-solaris210,,sparc-sun-solaris2.10}
3093 @item
3094 @uref{#sparc-x-linux,,sparc-*-linux*}
3095 @item
3096 @uref{#sparc64-x-solaris2,,sparc64-*-solaris2*}
3097 @item
3098 @uref{#sparcv9-x-solaris2,,sparcv9-*-solaris2*}
3099 @item
3100 @uref{#c6x-x-x,,c6x-*-*}
3101 @item
3102 @uref{#tilegx-x-linux,,tilegx-*-linux*}
3103 @item
3104 @uref{#tilepro-x-linux,,tilepro-*-linux*}
3105 @item
3106 @uref{#x-x-vxworks,,*-*-vxworks*}
3107 @item
3108 @uref{#x86-64-x-x,,x86_64-*-*, amd64-*-*}
3109 @item
3110 @uref{#x86-64-x-solaris210,,x86_64-*-solaris2.1[0-9]*}
3111 @item
3112 @uref{#xtensa-x-elf,,xtensa*-*-elf}
3113 @item
3114 @uref{#xtensa-x-linux,,xtensa*-*-linux*}
3115 @item
3116 @uref{#windows,,Microsoft Windows}
3117 @item
3118 @uref{#x-x-cygwin,,*-*-cygwin}
3119 @item
3120 @uref{#x-x-interix,,*-*-interix}
3121 @item
3122 @uref{#x-x-mingw32,,*-*-mingw32}
3123 @item
3124 @uref{#os2,,OS/2}
3125 @item
3126 @uref{#older,,Older systems}
3127 @end itemize
3129 @itemize
3130 @item
3131 @uref{#elf,,all ELF targets} (SVR4, Solaris 2, etc.)
3132 @end itemize
3133 @end ifhtml
3136 @html
3137 <!-- -------- host/target specific issues start here ---------------- -->
3138 <hr />
3139 @end html
3140 @heading @anchor{alpha-x-x}alpha*-*-*
3142 This section contains general configuration information for all
3143 alpha-based platforms using ELF (in particular, ignore this section for
3144 DEC OSF/1, Digital UNIX and Tru64 UNIX)@.  In addition to reading this
3145 section, please read all other sections that match your target.
3147 We require binutils 2.11.2 or newer.
3148 Previous binutils releases had a number of problems with DWARF 2
3149 debugging information, not the least of which is incorrect linking of
3150 shared libraries.
3152 @html
3153 <hr />
3154 @end html
3155 @heading @anchor{alpha-dec-osf51}alpha*-dec-osf5.1
3156 Systems using processors that implement the DEC Alpha architecture and
3157 are running the DEC/Compaq/HP Unix (DEC OSF/1, Digital UNIX, or Compaq/HP
3158 Tru64 UNIX) operating system, for example the DEC Alpha AXP systems.
3160 Support for Tru64 UNIX V5.1 has been removed in GCC 4.8.  As of GCC 4.6,
3161 support for Tru64 UNIX V4.0 and V5.0 has been removed.  As of GCC 3.2,
3162 versions before @code{alpha*-dec-osf4} are no longer supported.  (These
3163 are the versions which identify themselves as DEC OSF/1.)
3165 @html
3166 <hr />
3167 @end html
3168 @heading @anchor{amd64-x-solaris210}amd64-*-solaris2.1[0-9]*
3170 This is a synonym for @samp{x86_64-*-solaris2.1[0-9]*}.
3172 @html
3173 <hr />
3174 @end html
3175 @heading @anchor{arm-x-eabi}arm-*-eabi
3176 ARM-family processors.  Subtargets that use the ELF object format
3177 require GNU binutils 2.13 or newer.  Such subtargets include:
3178 @code{arm-*-netbsdelf}, @code{arm-*-*linux-*}
3179 and @code{arm-*-rtemseabi}.
3181 @html
3182 <hr />
3183 @end html
3184 @heading @anchor{avr}avr
3186 ATMEL AVR-family micro controllers.  These are used in embedded
3187 applications.  There are no standard Unix configurations.
3188 @ifnothtml
3189 @xref{AVR Options,, AVR Options, gcc, Using the GNU Compiler
3190 Collection (GCC)},
3191 @end ifnothtml
3192 @ifhtml
3193 See ``AVR Options'' in the main manual
3194 @end ifhtml
3195 for the list of supported MCU types.
3197 Use @samp{configure --target=avr --enable-languages="c"} to configure GCC@.
3199 Further installation notes and other useful information about AVR tools
3200 can also be obtained from:
3202 @itemize @bullet
3203 @item
3204 @uref{http://www.nongnu.org/avr/,,http://www.nongnu.org/avr/}
3205 @item
3206 @uref{http://www.amelek.gda.pl/avr/,,http://www.amelek.gda.pl/avr/}
3207 @end itemize
3209 We @emph{strongly} recommend using binutils 2.13 or newer.
3211 The following error:
3212 @smallexample
3213 Error: register required
3214 @end smallexample
3216 indicates that you should upgrade to a newer version of the binutils.
3218 @html
3219 <hr />
3220 @end html
3221 @heading @anchor{bfin}Blackfin
3223 The Blackfin processor, an Analog Devices DSP.
3224 @ifnothtml
3225 @xref{Blackfin Options,, Blackfin Options, gcc, Using the GNU Compiler
3226 Collection (GCC)},
3227 @end ifnothtml
3228 @ifhtml
3229 See ``Blackfin Options'' in the main manual
3230 @end ifhtml
3232 More information, and a version of binutils with support for this processor,
3233 is available at @uref{http://blackfin.uclinux.org}
3235 @html
3236 <hr />
3237 @end html
3238 @heading @anchor{cr16}CR16
3240 The CR16 CompactRISC architecture is a 16-bit architecture. This architecture is 
3241 used in embedded applications.
3243 @ifnothtml
3244 @xref{CR16 Options,, CR16 Options, gcc, Using and Porting the GNU Compiler
3245 Collection (GCC)},
3246 @end ifnothtml
3248 @ifhtml
3249 See ``CR16 Options'' in the main manual for a list of CR16-specific options.
3250 @end ifhtml
3252 Use @samp{configure --target=cr16-elf --enable-languages=c,c++} to configure
3253 GCC@ for building a CR16 elf cross-compiler.
3255 Use @samp{configure --target=cr16-uclinux --enable-languages=c,c++} to configure
3256 GCC@ for building a CR16 uclinux cross-compiler.
3258 @html
3259 <hr />
3260 @end html
3261 @heading @anchor{cris}CRIS
3263 CRIS is the CPU architecture in Axis Communications ETRAX system-on-a-chip
3264 series.  These are used in embedded applications.
3266 @ifnothtml
3267 @xref{CRIS Options,, CRIS Options, gcc, Using the GNU Compiler
3268 Collection (GCC)},
3269 @end ifnothtml
3270 @ifhtml
3271 See ``CRIS Options'' in the main manual
3272 @end ifhtml
3273 for a list of CRIS-specific options.
3275 There are a few different CRIS targets:
3276 @table @code
3277 @item cris-axis-elf
3278 Mainly for monolithic embedded systems.  Includes a multilib for the
3279 @samp{v10} core used in @samp{ETRAX 100 LX}.
3280 @item cris-axis-linux-gnu
3281 A GNU/Linux port for the CRIS architecture, currently targeting
3282 @samp{ETRAX 100 LX} by default.
3283 @end table
3285 For @code{cris-axis-elf} you need binutils 2.11
3286 or newer.  For @code{cris-axis-linux-gnu} you need binutils 2.12 or newer.
3288 Pre-packaged tools can be obtained from
3289 @uref{ftp://ftp.axis.com/@/pub/@/axis/@/tools/@/cris/@/compiler-kit/}.  More
3290 information about this platform is available at
3291 @uref{http://developer.axis.com/}.
3293 @html
3294 <hr />
3295 @end html
3296 @heading @anchor{dos}DOS
3298 Please have a look at the @uref{binaries.html,,binaries page}.
3300 You cannot install GCC by itself on MSDOS; it will not compile under
3301 any MSDOS compiler except itself.  You need to get the complete
3302 compilation package DJGPP, which includes binaries as well as sources,
3303 and includes all the necessary compilation tools and libraries.
3305 @html
3306 <hr />
3307 @end html
3308 @heading @anchor{epiphany-x-elf}epiphany-*-elf
3309 Adapteva Epiphany.
3310 This configuration is intended for embedded systems.
3312 @html
3313 <hr />
3314 @end html
3315 @heading @anchor{x-x-freebsd}*-*-freebsd*
3317 Support for FreeBSD 1 was discontinued in GCC 3.2.  Support for
3318 FreeBSD 2 (and any mutant a.out variants of FreeBSD 3) was
3319 discontinued in GCC 4.0.
3321 In order to better utilize FreeBSD base system functionality and match
3322 the configuration of the system compiler, GCC 4.5 and above as well as
3323 GCC 4.4 past 2010-06-20 leverage SSP support in libc (which is present
3324 on FreeBSD 7 or later) and the use of @code{__cxa_atexit} by default
3325 (on FreeBSD 6 or later).  The use of @code{dl_iterate_phdr} inside
3326 @file{libgcc_s.so.1} and boehm-gc (on FreeBSD 7 or later) is enabled
3327 by GCC 4.5 and above.
3329 We support FreeBSD using the ELF file format with DWARF 2 debugging
3330 for all CPU architectures.  You may use @option{-gstabs} instead of
3331 @option{-g}, if you really want the old debugging format.  There are
3332 no known issues with mixing object files and libraries with different
3333 debugging formats.  Otherwise, this release of GCC should now match
3334 more of the configuration used in the stock FreeBSD configuration of
3335 GCC@.  In particular, @option{--enable-threads} is now configured by
3336 default.  However, as a general user, do not attempt to replace the
3337 system compiler with this release.  Known to bootstrap and check with
3338 good results on FreeBSD 7.2-STABLE@.  In the past, known to bootstrap
3339 and check with good results on FreeBSD 3.0, 3.4, 4.0, 4.2, 4.3, 4.4,
3340 4.5, 4.8, 4.9 and 5-CURRENT@.
3342 The version of binutils installed in @file{/usr/bin} probably works
3343 with this release of GCC@.  Bootstrapping against the latest GNU
3344 binutils and/or the version found in @file{/usr/ports/devel/binutils} has
3345 been known to enable additional features and improve overall testsuite
3346 results.  However, it is currently known that boehm-gc (which itself
3347 is required for java) may not configure properly on FreeBSD prior to
3348 the FreeBSD 7.0 release with GNU binutils after 2.16.1.
3350 @html
3351 <hr />
3352 @end html
3353 @heading @anchor{h8300-hms}h8300-hms
3354 Renesas H8/300 series of processors.
3356 Please have a look at the @uref{binaries.html,,binaries page}.
3358 The calling convention and structure layout has changed in release 2.6.
3359 All code must be recompiled.  The calling convention now passes the
3360 first three arguments in function calls in registers.  Structures are no
3361 longer a multiple of 2 bytes.
3363 @html
3364 <hr />
3365 @end html
3366 @heading @anchor{hppa-hp-hpux}hppa*-hp-hpux*
3367 Support for HP-UX version 9 and older was discontinued in GCC 3.4.
3369 We require using gas/binutils on all hppa platforms.  Version 2.19 or
3370 later is recommended.
3372 It may be helpful to configure GCC with the
3373 @uref{./configure.html#with-gnu-as,,@option{--with-gnu-as}} and
3374 @option{--with-as=@dots{}} options to ensure that GCC can find GAS@.
3376 The HP assembler should not be used with GCC.  It is rarely tested and may
3377 not work.  It shouldn't be used with any languages other than C due to its
3378 many limitations.
3380 Specifically, @option{-g} does not work (HP-UX uses a peculiar debugging
3381 format which GCC does not know about).  It also inserts timestamps
3382 into each object file it creates, causing the 3-stage comparison test to
3383 fail during a bootstrap.  You should be able to continue by saying
3384 @samp{make all-host all-target} after getting the failure from @samp{make}.
3386 Various GCC features are not supported.  For example, it does not support weak
3387 symbols or alias definitions.  As a result, explicit template instantiations
3388 are required when using C++.  This makes it difficult if not impossible to
3389 build many C++ applications.
3391 There are two default scheduling models for instructions.  These are
3392 PROCESSOR_7100LC and PROCESSOR_8000.  They are selected from the pa-risc
3393 architecture specified for the target machine when configuring.
3394 PROCESSOR_8000 is the default.  PROCESSOR_7100LC is selected when
3395 the target is a @samp{hppa1*} machine.
3397 The PROCESSOR_8000 model is not well suited to older processors.  Thus,
3398 it is important to completely specify the machine architecture when
3399 configuring if you want a model other than PROCESSOR_8000.  The macro
3400 TARGET_SCHED_DEFAULT can be defined in BOOT_CFLAGS if a different
3401 default scheduling model is desired.
3403 As of GCC 4.0, GCC uses the UNIX 95 namespace for HP-UX 10.10
3404 through 11.00, and the UNIX 98 namespace for HP-UX 11.11 and later.
3405 This namespace change might cause problems when bootstrapping with
3406 an earlier version of GCC or the HP compiler as essentially the same
3407 namespace is required for an entire build.  This problem can be avoided
3408 in a number of ways.  With HP cc, @env{UNIX_STD} can be set to @samp{95}
3409 or @samp{98}.  Another way is to add an appropriate set of predefines
3410 to @env{CC}.  The description for the @option{munix=} option contains
3411 a list of the predefines used with each standard.
3413 More specific information to @samp{hppa*-hp-hpux*} targets follows.
3415 @html
3416 <hr />
3417 @end html
3418 @heading @anchor{hppa-hp-hpux10}hppa*-hp-hpux10
3420 For hpux10.20, we @emph{highly} recommend you pick up the latest sed patch
3421 @code{PHCO_19798} from HP@.
3423 The C++ ABI has changed incompatibly in GCC 4.0.  COMDAT subspaces are
3424 used for one-only code and data.  This resolves many of the previous
3425 problems in using C++ on this target.  However, the ABI is not compatible
3426 with the one implemented under HP-UX 11 using secondary definitions.
3428 @html
3429 <hr />
3430 @end html
3431 @heading @anchor{hppa-hp-hpux11}hppa*-hp-hpux11
3433 GCC 3.0 and up support HP-UX 11.  GCC 2.95.x is not supported and cannot
3434 be used to compile GCC 3.0 and up.
3436 The libffi and libjava libraries haven't been ported to 64-bit HP-UX@
3437 and don't build.
3439 Refer to @uref{binaries.html,,binaries} for information about obtaining
3440 precompiled GCC binaries for HP-UX@.  Precompiled binaries must be obtained
3441 to build the Ada language as it can't be bootstrapped using C@.  Ada is
3442 only available for the 32-bit PA-RISC runtime.
3444 Starting with GCC 3.4 an ISO C compiler is required to bootstrap.  The
3445 bundled compiler supports only traditional C; you will need either HP's
3446 unbundled compiler, or a binary distribution of GCC@.
3448 It is possible to build GCC 3.3 starting with the bundled HP compiler,
3449 but the process requires several steps.  GCC 3.3 can then be used to
3450 build later versions.  The fastjar program contains ISO C code and
3451 can't be built with the HP bundled compiler.  This problem can be
3452 avoided by not building the Java language.  For example, use the
3453 @option{--enable-languages="c,c++,f77,objc"} option in your configure
3454 command.
3456 There are several possible approaches to building the distribution.
3457 Binutils can be built first using the HP tools.  Then, the GCC
3458 distribution can be built.  The second approach is to build GCC
3459 first using the HP tools, then build binutils, then rebuild GCC@.
3460 There have been problems with various binary distributions, so it
3461 is best not to start from a binary distribution.
3463 On 64-bit capable systems, there are two distinct targets.  Different
3464 installation prefixes must be used if both are to be installed on
3465 the same system.  The @samp{hppa[1-2]*-hp-hpux11*} target generates code
3466 for the 32-bit PA-RISC runtime architecture and uses the HP linker.
3467 The @samp{hppa64-hp-hpux11*} target generates 64-bit code for the
3468 PA-RISC 2.0 architecture.
3470 The script config.guess now selects the target type based on the compiler
3471 detected during configuration.  You must define @env{PATH} or @env{CC} so
3472 that configure finds an appropriate compiler for the initial bootstrap.
3473 When @env{CC} is used, the definition should contain the options that are
3474 needed whenever @env{CC} is used.
3476 Specifically, options that determine the runtime architecture must be
3477 in @env{CC} to correctly select the target for the build.  It is also
3478 convenient to place many other compiler options in @env{CC}.  For example,
3479 @env{CC="cc -Ac +DA2.0W -Wp,-H16376 -D_CLASSIC_TYPES -D_HPUX_SOURCE"}
3480 can be used to bootstrap the GCC 3.3 branch with the HP compiler in
3481 64-bit K&R/bundled mode.  The @option{+DA2.0W} option will result in
3482 the automatic selection of the @samp{hppa64-hp-hpux11*} target.  The
3483 macro definition table of cpp needs to be increased for a successful
3484 build with the HP compiler.  _CLASSIC_TYPES and _HPUX_SOURCE need to
3485 be defined when building with the bundled compiler, or when using the
3486 @option{-Ac} option.  These defines aren't necessary with @option{-Ae}.
3488 It is best to explicitly configure the @samp{hppa64-hp-hpux11*} target
3489 with the @option{--with-ld=@dots{}} option.  This overrides the standard
3490 search for ld.  The two linkers supported on this target require different
3491 commands.  The default linker is determined during configuration.  As a
3492 result, it's not possible to switch linkers in the middle of a GCC build.
3493 This has been reported to sometimes occur in unified builds of binutils
3494 and GCC@.
3496 A recent linker patch must be installed for the correct operation of
3497 GCC 3.3 and later.  @code{PHSS_26559} and @code{PHSS_24304} are the
3498 oldest linker patches that are known to work.  They are for HP-UX
3499 11.00 and 11.11, respectively.  @code{PHSS_24303}, the companion to
3500 @code{PHSS_24304}, might be usable but it hasn't been tested.  These
3501 patches have been superseded.  Consult the HP patch database to obtain
3502 the currently recommended linker patch for your system.
3504 The patches are necessary for the support of weak symbols on the
3505 32-bit port, and for the running of initializers and finalizers.  Weak
3506 symbols are implemented using SOM secondary definition symbols.  Prior
3507 to HP-UX 11, there are bugs in the linker support for secondary symbols.
3508 The patches correct a problem of linker core dumps creating shared
3509 libraries containing secondary symbols, as well as various other
3510 linking issues involving secondary symbols.
3512 GCC 3.3 uses the ELF DT_INIT_ARRAY and DT_FINI_ARRAY capabilities to
3513 run initializers and finalizers on the 64-bit port.  The 32-bit port
3514 uses the linker @option{+init} and @option{+fini} options for the same
3515 purpose.  The patches correct various problems with the +init/+fini
3516 options, including program core dumps.  Binutils 2.14 corrects a
3517 problem on the 64-bit port resulting from HP's non-standard use of
3518 the .init and .fini sections for array initializers and finalizers.
3520 Although the HP and GNU linkers are both supported for the
3521 @samp{hppa64-hp-hpux11*} target, it is strongly recommended that the
3522 HP linker be used for link editing on this target.
3524 At this time, the GNU linker does not support the creation of long
3525 branch stubs.  As a result, it can't successfully link binaries
3526 containing branch offsets larger than 8 megabytes.  In addition,
3527 there are problems linking shared libraries, linking executables
3528 with @option{-static}, and with dwarf2 unwind and exception support.
3529 It also doesn't provide stubs for internal calls to global functions
3530 in shared libraries, so these calls can't be overloaded.
3532 The HP dynamic loader does not support GNU symbol versioning, so symbol
3533 versioning is not supported.  It may be necessary to disable symbol
3534 versioning with @option{--disable-symvers} when using GNU ld.
3536 POSIX threads are the default.  The optional DCE thread library is not
3537 supported, so @option{--enable-threads=dce} does not work.
3539 @html
3540 <hr />
3541 @end html
3542 @heading @anchor{x-x-linux-gnu}*-*-linux-gnu
3544 Versions of libstdc++-v3 starting with 3.2.1 require bug fixes present
3545 in glibc 2.2.5 and later.  More information is available in the
3546 libstdc++-v3 documentation.
3548 @html
3549 <hr />
3550 @end html
3551 @heading @anchor{ix86-x-linux}i?86-*-linux*
3553 As of GCC 3.3, binutils 2.13.1 or later is required for this platform.
3554 See @uref{http://gcc.gnu.org/PR10877,,bug 10877} for more information.
3556 If you receive Signal 11 errors when building on GNU/Linux, then it is
3557 possible you have a hardware problem.  Further information on this can be
3558 found on @uref{http://www.bitwizard.nl/sig11/,,www.bitwizard.nl}.
3560 @html
3561 <hr />
3562 @end html
3563 @heading @anchor{ix86-x-solaris29}i?86-*-solaris2.9
3564 The Sun assembler in Solaris 9 has several bugs and limitations.
3565 While GCC works around them, several features are missing, so it is
3566 @c FIXME: which ones?
3567 recommended to use the GNU assembler instead.  There is no bundled
3568 version, but the current version, from GNU binutils 2.22, is known to
3569 work.
3571 Solaris@tie{}2/x86 doesn't support the execution of SSE/SSE2 instructions
3572 before Solaris@tie{}9 4/04, even if the CPU supports them.  Programs will
3573 receive @code{SIGILL} if they try.  The fix is available both in
3574 Solaris@tie{}9 Update@tie{}6 and kernel patch 112234-12 or newer.  To
3575 avoid this problem,
3576 @option{-march} defaults to @samp{pentiumpro} on Solaris 9.  If
3577 you have the patch installed, you can configure GCC with an appropriate
3578 @option{--with-arch} option, but need GNU @command{as} for SSE2 support.
3580 @html
3581 <hr />
3582 @end html
3583 @heading @anchor{ix86-x-solaris210}i?86-*-solaris2.10
3584 Use this for Solaris 10 or later on x86 and x86-64 systems.  Starting
3585 with GCC 4.7, there is also a 64-bit @samp{amd64-*-solaris2.1[0-9]*} or
3586 @samp{x86_64-*-solaris2.1[0-9]*} configuration that corresponds to
3587 @samp{sparcv9-sun-solaris2*}.
3589 It is recommended that you configure GCC to use the GNU assembler, in
3590 @file{/usr/sfw/bin/gas}.  The versions included in Solaris 10, from GNU
3591 binutils 2.15, and Solaris 11, from GNU binutils 2.19, work fine,
3592 although the current version, from GNU binutils
3593 2.22, is known to work, too.  Recent versions of the Sun assembler in
3594 @file{/usr/ccs/bin/as} work almost as well, though.
3595 @c FIXME: as patch requirements?
3597 For linking, the Sun linker, is preferred.  If you want to use the GNU
3598 linker instead, which is available in @file{/usr/sfw/bin/gld}, note that
3599 due to a packaging bug the version in Solaris 10, from GNU binutils
3600 2.15, cannot be used, while the version in Solaris 11, from GNU binutils
3601 2.19, works, as does the latest version, from GNU binutils 2.22.
3603 To use GNU @command{as}, configure with the options
3604 @option{--with-gnu-as --with-as=@//usr/@/sfw/@/bin/@/gas}.  It may be necessary
3605 to configure with @option{--without-gnu-ld --with-ld=@//usr/@/ccs/@/bin/@/ld} to
3606 guarantee use of Sun @command{ld}.
3607 @c FIXME: why --without-gnu-ld --with-ld?
3609 @html
3610 <hr />
3611 @end html
3612 @heading @anchor{ia64-x-linux}ia64-*-linux
3613 IA-64 processor (also known as IPF, or Itanium Processor Family)
3614 running GNU/Linux.
3616 If you are using the installed system libunwind library with
3617 @option{--with-system-libunwind}, then you must use libunwind 0.98 or
3618 later.
3620 None of the following versions of GCC has an ABI that is compatible
3621 with any of the other versions in this list, with the exception that
3622 Red Hat 2.96 and Trillian 000171 are compatible with each other:
3623 3.1, 3.0.2, 3.0.1, 3.0, Red Hat 2.96, and Trillian 000717.
3624 This primarily affects C++ programs and programs that create shared libraries.
3625 GCC 3.1 or later is recommended for compiling linux, the kernel.
3626 As of version 3.1 GCC is believed to be fully ABI compliant, and hence no
3627 more major ABI changes are expected.
3629 @html
3630 <hr />
3631 @end html
3632 @heading @anchor{ia64-x-hpux}ia64-*-hpux*
3633 Building GCC on this target requires the GNU Assembler.  The bundled HP
3634 assembler will not work.  To prevent GCC from using the wrong assembler,
3635 the option @option{--with-gnu-as} may be necessary.
3637 The GCC libunwind library has not been ported to HPUX@.  This means that for
3638 GCC versions 3.2.3 and earlier, @option{--enable-libunwind-exceptions}
3639 is required to build GCC@.  For GCC 3.3 and later, this is the default.
3640 For gcc 3.4.3 and later, @option{--enable-libunwind-exceptions} is
3641 removed and the system libunwind library will always be used.
3643 @html
3644 <hr />
3645 <!-- rs6000-ibm-aix*, powerpc-ibm-aix* -->
3646 @end html
3647 @heading @anchor{x-ibm-aix}*-ibm-aix*
3648 Support for AIX version 3 and older was discontinued in GCC 3.4.
3649 Support for AIX version 4.2 and older was discontinued in GCC 4.5.
3651 ``out of memory'' bootstrap failures may indicate a problem with
3652 process resource limits (ulimit).  Hard limits are configured in the
3653 @file{/etc/security/limits} system configuration file.
3655 GCC can bootstrap with recent versions of IBM XLC, but bootstrapping
3656 with an earlier release of GCC is recommended.  Bootstrapping with XLC
3657 requires a larger data segment, which can be enabled through the
3658 @var{LDR_CNTRL} environment variable, e.g.,
3660 @smallexample
3661 % LDR_CNTRL=MAXDATA=0x50000000
3662 % export LDR_CNTRL
3663 @end smallexample
3665 One can start with a pre-compiled version of GCC to build from
3666 sources.  One may delete GCC's ``fixed'' header files when starting
3667 with a version of GCC built for an earlier release of AIX.
3669 To speed up the configuration phases of bootstrapping and installing GCC,
3670 one may use GNU Bash instead of AIX @command{/bin/sh}, e.g.,
3672 @smallexample
3673 % CONFIG_SHELL=/opt/freeware/bin/bash
3674 % export CONFIG_SHELL
3675 @end smallexample
3677 and then proceed as described in @uref{build.html,,the build
3678 instructions}, where we strongly recommend specifying an absolute path
3679 to invoke @var{srcdir}/configure.
3681 Because GCC on AIX is built as a 32-bit executable by default,
3682 (although it can generate 64-bit programs) the GMP and MPFR libraries
3683 required by gfortran must be 32-bit libraries.  Building GMP and MPFR
3684 as static archive libraries works better than shared libraries.
3686 Errors involving @code{alloca} when building GCC generally are due
3687 to an incorrect definition of @code{CC} in the Makefile or mixing files
3688 compiled with the native C compiler and GCC@.  During the stage1 phase of
3689 the build, the native AIX compiler @strong{must} be invoked as @command{cc}
3690 (not @command{xlc}).  Once @command{configure} has been informed of
3691 @command{xlc}, one needs to use @samp{make distclean} to remove the
3692 configure cache files and ensure that @env{CC} environment variable
3693 does not provide a definition that will confuse @command{configure}.
3694 If this error occurs during stage2 or later, then the problem most likely
3695 is the version of Make (see above).
3697 The native @command{as} and @command{ld} are recommended for
3698 bootstrapping on AIX@.  The GNU Assembler, GNU Linker, and GNU
3699 Binutils version 2.20 is the minimum level that supports bootstrap on
3700 AIX 5@.  The GNU Assembler has not been updated to support AIX 6@ or
3701 AIX 7.  The native AIX tools do interoperate with GCC@.
3703 AIX 5.3 TL10, AIX 6.1 TL05 and AIX 7.1 TL00 introduced an AIX
3704 assembler change that sometimes produces corrupt assembly files
3705 causing AIX linker errors.  The bug breaks GCC bootstrap on AIX and
3706 can cause compilation failures with existing GCC installations.  An
3707 AIX iFix for AIX 5.3 is available (APAR IZ98385 for AIX 5.3 TL10, APAR
3708 IZ98477 for AIX 5.3 TL11 and IZ98134 for AIX 5.3 TL12). AIX 5.3 TL11 SP8,
3709 AIX 5.3 TL12 SP5, AIX 6.1 TL04 SP11, AIX 6.1 TL05 SP7, AIX 6.1 TL06 SP6,
3710 AIX 6.1 TL07 and AIX 7.1 TL01 should include the fix.
3712 Building @file{libstdc++.a} requires a fix for an AIX Assembler bug
3713 APAR IY26685 (AIX 4.3) or APAR IY25528 (AIX 5.1).  It also requires a
3714 fix for another AIX Assembler bug and a co-dependent AIX Archiver fix
3715 referenced as APAR IY53606 (AIX 5.2) or as APAR IY54774 (AIX 5.1)
3717 @samp{libstdc++} in GCC 3.4 increments the major version number of the
3718 shared object and GCC installation places the @file{libstdc++.a}
3719 shared library in a common location which will overwrite the and GCC
3720 3.3 version of the shared library.  Applications either need to be
3721 re-linked against the new shared library or the GCC 3.1 and GCC 3.3
3722 versions of the @samp{libstdc++} shared object needs to be available
3723 to the AIX runtime loader.  The GCC 3.1 @samp{libstdc++.so.4}, if
3724 present, and GCC 3.3 @samp{libstdc++.so.5} shared objects can be
3725 installed for runtime dynamic loading using the following steps to set
3726 the @samp{F_LOADONLY} flag in the shared object for @emph{each}
3727 multilib @file{libstdc++.a} installed:
3729 Extract the shared objects from the currently installed
3730 @file{libstdc++.a} archive:
3731 @smallexample
3732 % ar -x libstdc++.a libstdc++.so.4 libstdc++.so.5
3733 @end smallexample
3735 Enable the @samp{F_LOADONLY} flag so that the shared object will be
3736 available for runtime dynamic loading, but not linking:
3737 @smallexample
3738 % strip -e libstdc++.so.4 libstdc++.so.5
3739 @end smallexample
3741 Archive the runtime-only shared object in the GCC 3.4
3742 @file{libstdc++.a} archive:
3743 @smallexample
3744 % ar -q libstdc++.a libstdc++.so.4 libstdc++.so.5
3745 @end smallexample
3747 Linking executables and shared libraries may produce warnings of
3748 duplicate symbols.  The assembly files generated by GCC for AIX always
3749 have included multiple symbol definitions for certain global variable
3750 and function declarations in the original program.  The warnings should
3751 not prevent the linker from producing a correct library or runnable
3752 executable.
3754 AIX 4.3 utilizes a ``large format'' archive to support both 32-bit and
3755 64-bit object modules.  The routines provided in AIX 4.3.0 and AIX 4.3.1
3756 to parse archive libraries did not handle the new format correctly.
3757 These routines are used by GCC and result in error messages during
3758 linking such as ``not a COFF file''.  The version of the routines shipped
3759 with AIX 4.3.1 should work for a 32-bit environment.  The @option{-g}
3760 option of the archive command may be used to create archives of 32-bit
3761 objects using the original ``small format''.  A correct version of the
3762 routines is shipped with AIX 4.3.2 and above.
3764 Some versions of the AIX binder (linker) can fail with a relocation
3765 overflow severe error when the @option{-bbigtoc} option is used to link
3766 GCC-produced object files into an executable that overflows the TOC@.  A fix
3767 for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND -BBIGTOC) is
3768 available from IBM Customer Support and from its
3769 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
3770 website as PTF U455193.
3772 The AIX 4.3.2.1 linker (bos.rte.bind_cmds Level 4.3.2.1) will dump core
3773 with a segmentation fault when invoked by any version of GCC@.  A fix for
3774 APAR IX87327 is available from IBM Customer Support and from its
3775 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
3776 website as PTF U461879.  This fix is incorporated in AIX 4.3.3 and above.
3778 The initial assembler shipped with AIX 4.3.0 generates incorrect object
3779 files.  A fix for APAR IX74254 (64BIT DISASSEMBLED OUTPUT FROM COMPILER FAILS
3780 TO ASSEMBLE/BIND) is available from IBM Customer Support and from its
3781 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
3782 website as PTF U453956.  This fix is incorporated in AIX 4.3.1 and above.
3784 AIX provides National Language Support (NLS)@.  Compilers and assemblers
3785 use NLS to support locale-specific representations of various data
3786 formats including floating-point numbers (e.g., @samp{.}  vs @samp{,} for
3787 separating decimal fractions).  There have been problems reported where
3788 GCC does not produce the same floating-point formats that the assembler
3789 expects.  If one encounters this problem, set the @env{LANG}
3790 environment variable to @samp{C} or @samp{En_US}.
3792 A default can be specified with the @option{-mcpu=@var{cpu_type}}
3793 switch and using the configure option @option{--with-cpu-@var{cpu_type}}.
3795 @html
3796 <hr />
3797 @end html
3798 @heading @anchor{iq2000-x-elf}iq2000-*-elf
3799 Vitesse IQ2000 processors.  These are used in embedded
3800 applications.  There are no standard Unix configurations.
3802 @html
3803 <hr />
3804 @end html
3805 @heading @anchor{lm32-x-elf}lm32-*-elf
3806 Lattice Mico32 processor.
3807 This configuration is intended for embedded systems.
3809 @html
3810 <hr />
3811 @end html
3812 @heading @anchor{lm32-x-uclinux}lm32-*-uclinux
3813 Lattice Mico32 processor.
3814 This configuration is intended for embedded systems running uClinux.
3816 @html
3817 <hr />
3818 @end html
3819 @heading @anchor{m32c-x-elf}m32c-*-elf
3820 Renesas M32C processor.
3821 This configuration is intended for embedded systems.
3823 @html
3824 <hr />
3825 @end html
3826 @heading @anchor{m32r-x-elf}m32r-*-elf
3827 Renesas M32R processor.
3828 This configuration is intended for embedded systems.
3830 @html
3831 <hr />
3832 @end html
3833 @heading @anchor{m68k-x-x}m68k-*-*
3834 By default,
3835 @samp{m68k-*-elf*}, @samp{m68k-*-rtems},  @samp{m68k-*-uclinux} and
3836 @samp{m68k-*-linux}
3837 build libraries for both M680x0 and ColdFire processors.  If you only
3838 need the M680x0 libraries, you can omit the ColdFire ones by passing
3839 @option{--with-arch=m68k} to @command{configure}.  Alternatively, you
3840 can omit the M680x0 libraries by passing @option{--with-arch=cf} to
3841 @command{configure}.  These targets default to 5206 or 5475 code as
3842 appropriate for the target system when
3843 configured with @option{--with-arch=cf} and 68020 code otherwise.
3845 The @samp{m68k-*-netbsd} and
3846 @samp{m68k-*-openbsd} targets also support the @option{--with-arch}
3847 option.  They will generate ColdFire CFV4e code when configured with
3848 @option{--with-arch=cf} and 68020 code otherwise.
3850 You can override the default processors listed above by configuring
3851 with @option{--with-cpu=@var{target}}.  This @var{target} can either
3852 be a @option{-mcpu} argument or one of the following values:
3853 @samp{m68000}, @samp{m68010}, @samp{m68020}, @samp{m68030},
3854 @samp{m68040}, @samp{m68060}, @samp{m68020-40} and @samp{m68020-60}.
3856 GCC requires at least binutils version 2.17 on these targets.
3858 @html
3859 <hr />
3860 @end html
3861 @heading @anchor{m68k-x-uclinux}m68k-*-uclinux
3862 GCC 4.3 changed the uClinux configuration so that it uses the
3863 @samp{m68k-linux-gnu} ABI rather than the @samp{m68k-elf} ABI.
3864 It also added improved support for C++ and flat shared libraries,
3865 both of which were ABI changes.
3868 @html
3869 <hr />
3870 @end html
3871 @heading @anchor{mep-x-elf}mep-*-elf
3872 Toshiba Media embedded Processor.
3873 This configuration is intended for embedded systems.
3875 @html
3876 <hr />
3877 @end html
3878 @heading @anchor{microblaze-x-elf}microblaze-*-elf
3879 Xilinx MicroBlaze processor.
3880 This configuration is intended for embedded systems.
3882 @html
3883 <hr />
3884 @end html
3885 @heading @anchor{mips-x-x}mips-*-*
3886 If on a MIPS system you get an error message saying ``does not have gp
3887 sections for all it's [sic] sectons [sic]'', don't worry about it.  This
3888 happens whenever you use GAS with the MIPS linker, but there is not
3889 really anything wrong, and it is okay to use the output file.  You can
3890 stop such warnings by installing the GNU linker.
3892 It would be nice to extend GAS to produce the gp tables, but they are
3893 optional, and there should not be a warning about their absence.
3895 The libstdc++ atomic locking routines for MIPS targets requires MIPS II
3896 and later.  A patch went in just after the GCC 3.3 release to
3897 make @samp{mips*-*-*} use the generic implementation instead.  You can also
3898 configure for @samp{mipsel-elf} as a workaround.  The
3899 @samp{mips*-*-linux*} target continues to use the MIPS II routines.  More
3900 work on this is expected in future releases.
3902 @c If you make --with-llsc the default for another target, please also
3903 @c update the description of the --with-llsc option.
3905 The built-in @code{__sync_*} functions are available on MIPS II and
3906 later systems and others that support the @samp{ll}, @samp{sc} and
3907 @samp{sync} instructions.  This can be overridden by passing
3908 @option{--with-llsc} or @option{--without-llsc} when configuring GCC.
3909 Since the Linux kernel emulates these instructions if they are
3910 missing, the default for @samp{mips*-*-linux*} targets is
3911 @option{--with-llsc}.  The @option{--with-llsc} and
3912 @option{--without-llsc} configure options may be overridden at compile
3913 time by passing the @option{-mllsc} or @option{-mno-llsc} options to
3914 the compiler.
3916 MIPS systems check for division by zero (unless
3917 @option{-mno-check-zero-division} is passed to the compiler) by
3918 generating either a conditional trap or a break instruction.  Using
3919 trap results in smaller code, but is only supported on MIPS II and
3920 later.  Also, some versions of the Linux kernel have a bug that
3921 prevents trap from generating the proper signal (@code{SIGFPE}).  To enable
3922 the use of break, use the @option{--with-divide=breaks}
3923 @command{configure} option when configuring GCC@.  The default is to
3924 use traps on systems that support them.
3926 The assembler from GNU binutils 2.17 and earlier has a bug in the way
3927 it sorts relocations for REL targets (o32, o64, EABI).  This can cause
3928 bad code to be generated for simple C++ programs.  Also the linker
3929 from GNU binutils versions prior to 2.17 has a bug which causes the
3930 runtime linker stubs in very large programs, like @file{libgcj.so}, to
3931 be incorrectly generated.  GNU Binutils 2.18 and later (and snapshots
3932 made after Nov. 9, 2006) should be free from both of these problems.
3934 @html
3935 <hr />
3936 @end html
3937 @heading @anchor{mips-sgi-irix5}mips-sgi-irix5
3939 Support for IRIX 5 has been removed in GCC 4.6.
3941 @html
3942 <hr />
3943 @end html
3944 @heading @anchor{mips-sgi-irix6}mips-sgi-irix6
3946 Support for IRIX 6.5 has been removed in GCC 4.8.  Support for IRIX 6
3947 releases before 6.5 has been removed in GCC 4.6, as well as support for
3948 the O32 ABI.
3950 @html
3951 <hr />
3952 @end html
3953 @heading @anchor{moxie-x-elf}moxie-*-elf
3954 The moxie processor.
3956 @html
3957 <hr />
3958 @end html
3959 @heading @anchor{powerpc-x-x}powerpc-*-*
3961 You can specify a default version for the @option{-mcpu=@var{cpu_type}}
3962 switch by using the configure option @option{--with-cpu-@var{cpu_type}}.
3964 You will need
3965 @uref{ftp://ftp.kernel.org/pub/linux/devel/binutils,,binutils 2.15}
3966 or newer for a working GCC@.
3968 @html
3969 <hr />
3970 @end html
3971 @heading @anchor{powerpc-x-darwin}powerpc-*-darwin*
3972 PowerPC running Darwin (Mac OS X kernel).
3974 Pre-installed versions of Mac OS X may not include any developer tools,
3975 meaning that you will not be able to build GCC from source.  Tool
3976 binaries are available at
3977 @uref{http://opensource.apple.com/}.
3979 This version of GCC requires at least cctools-590.36.  The
3980 cctools-590.36 package referenced from
3981 @uref{http://gcc.gnu.org/ml/gcc/2006-03/msg00507.html} will not work
3982 on systems older than 10.3.9 (aka darwin7.9.0).
3984 @html
3985 <hr />
3986 @end html
3987 @heading @anchor{powerpc-x-elf}powerpc-*-elf
3988 PowerPC system in big endian mode, running System V.4.
3990 @html
3991 <hr />
3992 @end html
3993 @heading @anchor{powerpc-x-linux-gnu}powerpc*-*-linux-gnu*
3995 PowerPC system in big endian mode running Linux.
3997 @html
3998 <hr />
3999 @end html
4000 @heading @anchor{powerpc-x-netbsd}powerpc-*-netbsd*
4001 PowerPC system in big endian mode running NetBSD@.
4003 @html
4004 <hr />
4005 @end html
4006 @heading @anchor{powerpc-x-eabisim}powerpc-*-eabisim
4007 Embedded PowerPC system in big endian mode for use in running under the
4008 PSIM simulator.
4010 @html
4011 <hr />
4012 @end html
4013 @heading @anchor{powerpc-x-eabi}powerpc-*-eabi
4014 Embedded PowerPC system in big endian mode.
4016 @html
4017 <hr />
4018 @end html
4019 @heading @anchor{powerpcle-x-elf}powerpcle-*-elf
4020 PowerPC system in little endian mode, running System V.4.
4022 @html
4023 <hr />
4024 @end html
4025 @heading @anchor{powerpcle-x-eabisim}powerpcle-*-eabisim
4026 Embedded PowerPC system in little endian mode for use in running under
4027 the PSIM simulator.
4029 @html
4030 <hr />
4031 @end html
4032 @heading @anchor{powerpcle-x-eabi}powerpcle-*-eabi
4033 Embedded PowerPC system in little endian mode.
4035 @html
4036 <hr />
4037 @end html
4038 @heading @anchor{rl78-x-elf}rl78-*-elf
4039 The Renesas RL78 processor.
4040 This configuration is intended for embedded systems.
4042 @html
4043 <hr />
4044 @end html
4045 @heading @anchor{rx-x-elf}rx-*-elf
4046 The Renesas RX processor.  See
4047 @uref{http://eu.renesas.com/fmwk.jsp?cnt=rx600_series_landing.jsp&fp=/products/mpumcu/rx_family/rx600_series}
4048 for more information about this processor.
4050 @html
4051 <hr />
4052 @end html
4053 @heading @anchor{s390-x-linux}s390-*-linux*
4054 S/390 system running GNU/Linux for S/390@.
4056 @html
4057 <hr />
4058 @end html
4059 @heading @anchor{s390x-x-linux}s390x-*-linux*
4060 zSeries system (64-bit) running GNU/Linux for zSeries@.
4062 @html
4063 <hr />
4064 @end html
4065 @heading @anchor{s390x-ibm-tpf}s390x-ibm-tpf*
4066 zSeries system (64-bit) running TPF@.  This platform is
4067 supported as cross-compilation target only.
4069 @html
4070 <hr />
4071 @end html
4072 @c Please use Solaris 2 to refer to all release of Solaris, starting
4073 @c with 2.0 until 2.6, 7, 8, etc.  Solaris 1 was a marketing name for
4074 @c SunOS 4 releases which we don't use to avoid confusion.  Solaris
4075 @c alone is too unspecific and must be avoided.
4076 @heading @anchor{x-x-solaris2}*-*-solaris2*
4078 Support for Solaris 8 has removed in GCC 4.8.  Support for Solaris 7 has
4079 been removed in GCC 4.6.
4081 Sun does not ship a C compiler with Solaris 2 before Solaris 10, though
4082 you can download the Sun Studio compilers for free.  In Solaris 10 and
4083 11, GCC 3.4.3 is available as @command{/usr/sfw/bin/gcc}.  Solaris 11
4084 also provides GCC 4.5.2 as @command{/usr/gcc/4.5/bin/gcc}.  Alternatively,
4085 you can install a pre-built GCC to bootstrap and install GCC.  See the
4086 @uref{binaries.html,,binaries page} for details.
4088 The Solaris 2 @command{/bin/sh} will often fail to configure
4089 @samp{libstdc++-v3}, @samp{boehm-gc} or @samp{libjava}.  We therefore
4090 recommend using the following initial sequence of commands
4092 @smallexample
4093 % CONFIG_SHELL=/bin/ksh
4094 % export CONFIG_SHELL
4095 @end smallexample
4097 @noindent
4098 and proceed as described in @uref{configure.html,,the configure instructions}.
4099 In addition we strongly recommend specifying an absolute path to invoke
4100 @command{@var{srcdir}/configure}.
4102 Solaris 2 comes with a number of optional OS packages.  Some of these
4103 are needed to use GCC fully, namely @code{SUNWarc},
4104 @code{SUNWbtool}, @code{SUNWesu}, @code{SUNWhea}, @code{SUNWlibm},
4105 @code{SUNWsprot}, and @code{SUNWtoo}.  If you did not install all
4106 optional packages when installing Solaris 2, you will need to verify that
4107 the packages that GCC needs are installed.
4109 To check whether an optional package is installed, use
4110 the @command{pkginfo} command.  To add an optional package, use the
4111 @command{pkgadd} command.  For further details, see the Solaris 2
4112 documentation.
4114 Trying to use the linker and other tools in
4115 @file{/usr/ucb} to install GCC has been observed to cause trouble.
4116 For example, the linker may hang indefinitely.  The fix is to remove
4117 @file{/usr/ucb} from your @env{PATH}.
4119 The build process works more smoothly with the legacy Sun tools so, if you
4120 have @file{/usr/xpg4/bin} in your @env{PATH}, we recommend that you place
4121 @file{/usr/bin} before @file{/usr/xpg4/bin} for the duration of the build.
4123 We recommend the use of the Sun assembler or the GNU assembler, in
4124 conjunction with the Sun linker.  The GNU @command{as}
4125 versions included in Solaris 10, from GNU binutils 2.15, and Solaris 11,
4126 from GNU binutils 2.19, are known to work.  They can be found in
4127 @file{/usr/sfw/bin/gas}.  Current versions of GNU binutils (2.22)
4128 are known to work as well.  Note that your mileage may vary
4129 if you use a combination of the GNU tools and the Sun tools: while the
4130 combination GNU @command{as} + Sun @command{ld} should reasonably work,
4131 the reverse combination Sun @command{as} + GNU @command{ld} may fail to
4132 build or cause memory corruption at runtime in some cases for C++ programs.
4133 @c FIXME: still?
4134 GNU @command{ld} usually works as well, although the version included in
4135 Solaris 10 cannot be used due to several bugs.  Again, the current
4136 version (2.22) is known to work, but generally lacks platform specific
4137 features, so better stay with Sun @command{ld}.  To use the LTO linker
4138 plugin (@option{-fuse-linker-plugin}) with GNU @command{ld}, GNU
4139 binutils @emph{must} be configured with @option{--enable-largefile}.
4141 To enable symbol versioning in @samp{libstdc++} with Sun @command{ld},
4142 you need to have any version of GNU @command{c++filt}, which is part of
4143 GNU binutils.  @samp{libstdc++} symbol versioning will be disabled if no
4144 appropriate version is found.  Sun @command{c++filt} from the Sun Studio
4145 compilers does @emph{not} work.
4147 Sun bug 4296832 turns up when compiling X11 headers with GCC 2.95 or
4148 newer: @command{g++} will complain that types are missing.  These headers
4149 assume that omitting the type means @code{int}; this assumption worked for
4150 C90 but is wrong for C++, and is now wrong for C99 also.
4152 Sun bug 4927647 sometimes causes random spurious testsuite failures
4153 related to missing diagnostic output.  This bug doesn't affect GCC
4154 itself, rather it is a kernel bug triggered by the @command{expect}
4155 program which is used only by the GCC testsuite driver.  When the bug
4156 causes the @command{expect} program to miss anticipated output, extra
4157 testsuite failures appear.
4159 There are patches for Solaris 9 (117171-11 or newer for
4160 SPARC, 117172-11 or newer for Intel) that address this problem.
4162 Thread-local storage (TLS) is supported in Solaris@tie{}9, but requires
4163 some patches.  The @samp{libthread} patches provide the
4164 @code{__tls_get_addr} (SPARC, 64-bit x86) resp.@ @code{___tls_get_addr}
4165 (32-bit x86) functions.  On Solaris@tie{}9, the necessary support
4166 on SPARC is present since FCS, while 114432-05 or newer is required on
4167 Intel.  Additionally, on Solaris@tie{}9/x86, patch 113986-02 or newer is
4168 required for the Sun @command{ld} and runtime linker (@command{ld.so.1})
4169 support, while Solaris@tie{}9/SPARC works since FCS.  The linker
4170 patches must be installed even if GNU @command{ld} is used. Sun
4171 @command{as} in Solaris@tie{}9 doesn't support the necessary
4172 relocations, so GNU @command{as} must be used.  The @command{configure}
4173 script checks for those prerequisites and automatically enables TLS
4174 support if they are met.  Although those minimal patch versions should
4175 work, it is recommended to use the latest patch versions which include
4176 additional bug fixes.
4178 @html
4179 <hr />
4180 @end html
4181 @heading @anchor{sparc-x-x}sparc*-*-*
4183 This section contains general configuration information for all
4184 SPARC-based platforms.  In addition to reading this section, please
4185 read all other sections that match your target.
4187 Newer versions of the GNU Multiple Precision Library (GMP), the MPFR
4188 library and the MPC library are known to be miscompiled by earlier
4189 versions of GCC on these platforms.  We therefore recommend the use
4190 of the exact versions of these libraries listed as minimal versions
4191 in @uref{prerequisites.html,,the prerequisites}.
4193 @html
4194 <hr />
4195 @end html
4196 @heading @anchor{sparc-sun-solaris2}sparc-sun-solaris2*
4198 When GCC is configured to use GNU binutils 2.14 or later, the binaries
4199 produced are smaller than the ones produced using Sun's native tools;
4200 this difference is quite significant for binaries containing debugging
4201 information.
4203 Starting with Solaris 7, the operating system is capable of executing
4204 64-bit SPARC V9 binaries.  GCC 3.1 and later properly supports
4205 this; the @option{-m64} option enables 64-bit code generation.
4206 However, if all you want is code tuned for the UltraSPARC CPU, you
4207 should try the @option{-mtune=ultrasparc} option instead, which produces
4208 code that, unlike full 64-bit code, can still run on non-UltraSPARC
4209 machines.
4211 When configuring on a Solaris 7 or later system that is running a kernel
4212 that supports only 32-bit binaries, one must configure with
4213 @option{--disable-multilib}, since we will not be able to build the
4214 64-bit target libraries.
4216 GCC 3.3 and GCC 3.4 trigger code generation bugs in earlier versions of
4217 the GNU compiler (especially GCC 3.0.x versions), which lead to the
4218 miscompilation of the stage1 compiler and the subsequent failure of the
4219 bootstrap process.  A workaround is to use GCC 3.2.3 as an intermediary
4220 stage, i.e.@: to bootstrap that compiler with the base compiler and then
4221 use it to bootstrap the final compiler.
4223 GCC 3.4 triggers a code generation bug in versions 5.4 (Sun ONE Studio 7)
4224 and 5.5 (Sun ONE Studio 8) of the Sun compiler, which causes a bootstrap
4225 failure in form of a miscompilation of the stage1 compiler by the Sun
4226 compiler.  This is Sun bug 4974440.  This is fixed with patch 112760-07.
4228 GCC 3.4 changed the default debugging format from Stabs to DWARF-2 for
4229 32-bit code on Solaris 7 and later.  If you use the Sun assembler, this
4230 change apparently runs afoul of Sun bug 4910101 (which is referenced as
4231 an x86-only problem by Sun, probably because they do not use DWARF-2).
4232 A symptom of the problem is that you cannot compile C++ programs like
4233 @command{groff} 1.19.1 without getting messages similar to the following:
4235 @smallexample
4236 ld: warning: relocation error: R_SPARC_UA32: @dots{}
4237   external symbolic relocation against non-allocatable section
4238   .debug_info cannot be processed at runtime: relocation ignored.
4239 @end smallexample
4241 @noindent
4242 To work around this problem, compile with @option{-gstabs+} instead of
4243 plain @option{-g}.
4245 When configuring the GNU Multiple Precision Library (GMP), the MPFR
4246 library or the MPC library on a Solaris 7 or later system, the canonical
4247 target triplet must be specified as the @command{build} parameter on the
4248 configure line.  This target triplet can be obtained by invoking @command{./config.guess} in the toplevel source directory of GCC (and
4249 not that of GMP or MPFR or MPC).  For example on a Solaris 9 system:
4251 @smallexample
4252 % ./configure --build=sparc-sun-solaris2.9 --prefix=xxx
4253 @end smallexample
4255 @html
4256 <hr />
4257 @end html
4258 @heading @anchor{sparc-sun-solaris210}sparc-sun-solaris2.10
4260 There is a bug in older versions of the Sun assembler which breaks
4261 thread-local storage (TLS).  A typical error message is
4263 @smallexample
4264 ld: fatal: relocation error: R_SPARC_TLS_LE_HIX22: file /var/tmp//ccamPA1v.o:
4265   symbol <unknown>: bad symbol type SECT: symbol type must be TLS
4266 @end smallexample
4268 @noindent
4269 This bug is fixed in Sun patch 118683-03 or later.
4271 @html
4272 <hr />
4273 @end html
4274 @heading @anchor{sparc-x-linux}sparc-*-linux*
4276 GCC versions 3.0 and higher require binutils 2.11.2 and glibc 2.2.4
4277 or newer on this platform.  All earlier binutils and glibc
4278 releases mishandled unaligned relocations on @code{sparc-*-*} targets.
4281 @html
4282 <hr />
4283 @end html
4284 @heading @anchor{sparc64-x-solaris2}sparc64-*-solaris2*
4286 When configuring the GNU Multiple Precision Library (GMP), the MPFR
4287 library or the MPC library, the canonical target triplet must be specified
4288 as the @command{build} parameter on the configure line.  For example
4289 on a Solaris 9 system:
4291 @smallexample
4292 % ./configure --build=sparc64-sun-solaris2.9 --prefix=xxx
4293 @end smallexample
4295 The following compiler flags must be specified in the configure
4296 step in order to bootstrap this target with the Sun compiler:
4298 @smallexample
4299 % CC="cc -xarch=v9 -xildoff" @var{srcdir}/configure [@var{options}] [@var{target}]
4300 @end smallexample
4302 @noindent
4303 @option{-xarch=v9} specifies the SPARC-V9 architecture to the Sun toolchain
4304 and @option{-xildoff} turns off the incremental linker.
4306 @html
4307 <hr />
4308 @end html
4309 @heading @anchor{sparcv9-x-solaris2}sparcv9-*-solaris2*
4311 This is a synonym for @samp{sparc64-*-solaris2*}.
4313 @html
4314 <hr />
4315 @end html
4316 @heading @anchor{c6x-x-x}c6x-*-*
4318 The C6X family of processors. This port requires binutils-2.22 or newer.
4320 @html
4321 <hr />
4322 @end html
4323 @heading @anchor{tilegx-*-linux}tilegx-*-linux*
4325 The TILE-Gx processor running GNU/Linux.  This port requires
4326 binutils-2.22 or newer.
4328 @html
4329 <hr />
4330 @end html
4331 @heading @anchor{tilepro-*-linux}tilepro-*-linux*
4333 The TILEPro processor running GNU/Linux.  This port requires
4334 binutils-2.22 or newer.
4336 @html
4337 <hr />
4338 @end html
4339 @heading @anchor{x-x-vxworks}*-*-vxworks*
4340 Support for VxWorks is in flux.  At present GCC supports @emph{only} the
4341 very recent VxWorks 5.5 (aka Tornado 2.2) release, and only on PowerPC@.
4342 We welcome patches for other architectures supported by VxWorks 5.5.
4343 Support for VxWorks AE would also be welcome; we believe this is merely
4344 a matter of writing an appropriate ``configlette'' (see below).  We are
4345 not interested in supporting older, a.out or COFF-based, versions of
4346 VxWorks in GCC 3.
4348 VxWorks comes with an older version of GCC installed in
4349 @file{@var{$WIND_BASE}/host}; we recommend you do not overwrite it.
4350 Choose an installation @var{prefix} entirely outside @var{$WIND_BASE}.
4351 Before running @command{configure}, create the directories @file{@var{prefix}}
4352 and @file{@var{prefix}/bin}.  Link or copy the appropriate assembler,
4353 linker, etc.@: into @file{@var{prefix}/bin}, and set your @var{PATH} to
4354 include that directory while running both @command{configure} and
4355 @command{make}.
4357 You must give @command{configure} the
4358 @option{--with-headers=@var{$WIND_BASE}/target/h} switch so that it can
4359 find the VxWorks system headers.  Since VxWorks is a cross compilation
4360 target only, you must also specify @option{--target=@var{target}}.
4361 @command{configure} will attempt to create the directory
4362 @file{@var{prefix}/@var{target}/sys-include} and copy files into it;
4363 make sure the user running @command{configure} has sufficient privilege
4364 to do so.
4366 GCC's exception handling runtime requires a special ``configlette''
4367 module, @file{contrib/gthr_supp_vxw_5x.c}.  Follow the instructions in
4368 that file to add the module to your kernel build.  (Future versions of
4369 VxWorks will incorporate this module.)
4371 @html
4372 <hr />
4373 @end html
4374 @heading @anchor{x86-64-x-x}x86_64-*-*, amd64-*-*
4376 GCC supports the x86-64 architecture implemented by the AMD64 processor
4377 (amd64-*-* is an alias for x86_64-*-*) on GNU/Linux, FreeBSD and NetBSD@.
4378 On GNU/Linux the default is a bi-arch compiler which is able to generate
4379 both 64-bit x86-64 and 32-bit x86 code (via the @option{-m32} switch).
4381 @html
4382 <hr />
4383 @end html
4384 @heading @anchor{x86-64-x-solaris210}x86_64-*-solaris2.1[0-9]*
4386 GCC also supports the x86-64 architecture implemented by the AMD64
4387 processor (@samp{amd64-*-*} is an alias for @samp{x86_64-*-*}) on
4388 Solaris 10 or later.  Unlike other systems, without special options a
4389 bi-arch compiler is built which generates 32-bit code by default, but
4390 can generate 64-bit x86-64 code with the @option{-m64} switch.  Since
4391 GCC 4.7, there is also configuration that defaults to 64-bit code, but
4392 can generate 32-bit code with @option{-m32}.  To configure and build
4393 this way, you have to provide all support libraries like @file{libgmp}
4394 as 64-bit code, configure with @option{--target=x86_64-pc-solaris2.1x}
4395 and @samp{CC=gcc -m64}.
4397 @html
4398 <hr />
4399 @end html
4400 @heading @anchor{xtensa-x-elf}xtensa*-*-elf
4402 This target is intended for embedded Xtensa systems using the
4403 @samp{newlib} C library.  It uses ELF but does not support shared
4404 objects.  Designed-defined instructions specified via the
4405 Tensilica Instruction Extension (TIE) language are only supported
4406 through inline assembly.
4408 The Xtensa configuration information must be specified prior to
4409 building GCC@.  The @file{include/xtensa-config.h} header
4410 file contains the configuration information.  If you created your
4411 own Xtensa configuration with the Xtensa Processor Generator, the
4412 downloaded files include a customized copy of this header file,
4413 which you can use to replace the default header file.
4415 @html
4416 <hr />
4417 @end html
4418 @heading @anchor{xtensa-x-linux}xtensa*-*-linux*
4420 This target is for Xtensa systems running GNU/Linux.  It supports ELF
4421 shared objects and the GNU C library (glibc).  It also generates
4422 position-independent code (PIC) regardless of whether the
4423 @option{-fpic} or @option{-fPIC} options are used.  In other
4424 respects, this target is the same as the
4425 @uref{#xtensa*-*-elf,,@samp{xtensa*-*-elf}} target.
4427 @html
4428 <hr />
4429 @end html
4430 @heading @anchor{windows}Microsoft Windows
4432 @subheading Intel 16-bit versions
4433 The 16-bit versions of Microsoft Windows, such as Windows 3.1, are not
4434 supported.
4436 However, the 32-bit port has limited support for Microsoft
4437 Windows 3.11 in the Win32s environment, as a target only.  See below.
4439 @subheading Intel 32-bit versions
4441 The 32-bit versions of Windows, including Windows 95, Windows NT, Windows
4442 XP, and Windows Vista, are supported by several different target
4443 platforms.  These targets differ in which Windows subsystem they target
4444 and which C libraries are used.
4446 @itemize
4447 @item Cygwin @uref{#x-x-cygwin,,*-*-cygwin}: Cygwin provides a user-space
4448 Linux API emulation layer in the Win32 subsystem.
4449 @item Interix @uref{#x-x-interix,,*-*-interix}: The Interix subsystem
4450 provides native support for POSIX.
4451 @item MinGW @uref{#x-x-mingw32,,*-*-mingw32}: MinGW is a native GCC port for
4452 the Win32 subsystem that provides a subset of POSIX.
4453 @item MKS i386-pc-mks: NuTCracker from MKS.  See
4454 @uref{http://www.mkssoftware.com/} for more information.
4455 @end itemize
4457 @subheading Intel 64-bit versions
4459 GCC contains support for x86-64 using the mingw-w64
4460 runtime library, available from @uref{http://mingw-w64.sourceforge.net/}.
4461 This library should be used with the target triple x86_64-pc-mingw32.
4463 Presently Windows for Itanium is not supported.
4465 @subheading Windows CE
4467 Windows CE is supported as a target only on Hitachi
4468 SuperH (sh-wince-pe), and MIPS (mips-wince-pe).
4470 @subheading Other Windows Platforms
4472 GCC no longer supports Windows NT on the Alpha or PowerPC.
4474 GCC no longer supports the Windows POSIX subsystem.  However, it does
4475 support the Interix subsystem.  See above.
4477 Old target names including *-*-winnt and *-*-windowsnt are no longer used.
4479 PW32 (i386-pc-pw32) support was never completed, and the project seems to
4480 be inactive.  See @uref{http://pw32.sourceforge.net/} for more information.
4482 UWIN support has been removed due to a lack of maintenance.
4484 @html
4485 <hr />
4486 @end html
4487 @heading @anchor{x-x-cygwin}*-*-cygwin
4489 Ports of GCC are included with the
4490 @uref{http://www.cygwin.com/,,Cygwin environment}.
4492 GCC will build under Cygwin without modification; it does not build
4493 with Microsoft's C++ compiler and there are no plans to make it do so.
4495 The Cygwin native compiler can be configured to target any 32-bit x86
4496 cpu architecture desired; the default is i686-pc-cygwin.  It should be
4497 used with as up-to-date a version of binutils as possible; use either
4498 the latest official GNU binutils release in the Cygwin distribution,
4499 or version 2.20 or above if building your own.
4501 @html
4502 <hr />
4503 @end html
4504 @heading @anchor{x-x-interix}*-*-interix
4506 The Interix target is used by OpenNT, Interix, Services For UNIX (SFU),
4507 and Subsystem for UNIX-based Applications (SUA).  Applications compiled
4508 with this target run in the Interix subsystem, which is separate from
4509 the Win32 subsystem.  This target was last known to work in GCC 3.3.
4511 @html
4512 <hr />
4513 @end html
4514 @heading @anchor{x-x-mingw32}*-*-mingw32
4516 GCC will build with and support only MinGW runtime 3.12 and later.
4517 Earlier versions of headers are incompatible with the new default semantics
4518 of @code{extern inline} in @code{-std=c99} and @code{-std=gnu99} modes.
4520 @html
4521 <hr />
4522 @end html
4523 @heading @anchor{older}Older systems
4525 GCC contains support files for many older (1980s and early
4526 1990s) Unix variants.  For the most part, support for these systems
4527 has not been deliberately removed, but it has not been maintained for
4528 several years and may suffer from bitrot.
4530 Starting with GCC 3.1, each release has a list of ``obsoleted'' systems.
4531 Support for these systems is still present in that release, but
4532 @command{configure} will fail unless the @option{--enable-obsolete}
4533 option is given.  Unless a maintainer steps forward, support for these
4534 systems will be removed from the next release of GCC@.
4536 Support for old systems as hosts for GCC can cause problems if the
4537 workarounds for compiler, library and operating system bugs affect the
4538 cleanliness or maintainability of the rest of GCC@.  In some cases, to
4539 bring GCC up on such a system, if still possible with current GCC, may
4540 require first installing an old version of GCC which did work on that
4541 system, and using it to compile a more recent GCC, to avoid bugs in the
4542 vendor compiler.  Old releases of GCC 1 and GCC 2 are available in the
4543 @file{old-releases} directory on the @uref{../mirrors.html,,GCC mirror
4544 sites}.  Header bugs may generally be avoided using
4545 @command{fixincludes}, but bugs or deficiencies in libraries and the
4546 operating system may still cause problems.
4548 Support for older systems as targets for cross-compilation is less
4549 problematic than support for them as hosts for GCC; if an enthusiast
4550 wishes to make such a target work again (including resurrecting any of
4551 the targets that never worked with GCC 2, starting from the last
4552 version before they were removed), patches
4553 @uref{../contribute.html,,following the usual requirements} would be
4554 likely to be accepted, since they should not affect the support for more
4555 modern targets.
4557 For some systems, old versions of GNU binutils may also be useful,
4558 and are available from @file{pub/binutils/old-releases} on
4559 @uref{http://sourceware.org/mirrors.html,,sourceware.org mirror sites}.
4561 Some of the information on specific systems above relates to
4562 such older systems, but much of the information
4563 about GCC on such systems (which may no longer be applicable to
4564 current GCC) is to be found in the GCC texinfo manual.
4566 @html
4567 <hr />
4568 @end html
4569 @heading @anchor{elf}all ELF targets (SVR4, Solaris 2, etc.)
4571 C++ support is significantly better on ELF targets if you use the
4572 @uref{./configure.html#with-gnu-ld,,GNU linker}; duplicate copies of
4573 inlines, vtables and template instantiations will be discarded
4574 automatically.
4577 @html
4578 <hr />
4580 @end html
4581 @ifhtml
4582 @uref{./index.html,,Return to the GCC Installation page}
4583 @end ifhtml
4584 @end ifset
4586 @c ***Old documentation******************************************************
4587 @ifset oldhtml
4588 @include install-old.texi
4589 @html
4590 <hr />
4592 @end html
4593 @ifhtml
4594 @uref{./index.html,,Return to the GCC Installation page}
4595 @end ifhtml
4596 @end ifset
4598 @c ***GFDL********************************************************************
4599 @ifset gfdlhtml
4600 @include fdl.texi
4601 @html
4602 <hr />
4604 @end html
4605 @ifhtml
4606 @uref{./index.html,,Return to the GCC Installation page}
4607 @end ifhtml
4608 @end ifset
4610 @c ***************************************************************************
4611 @c Part 6 The End of the Document
4612 @ifinfo
4613 @comment node-name,     next,          previous, up
4614 @node    Concept Index, , GNU Free Documentation License, Top
4615 @end ifinfo
4617 @ifinfo
4618 @unnumbered Concept Index
4620 @printindex cp
4622 @contents
4623 @end ifinfo
4624 @bye