@end html @ifhtml @uref{./index.html,,Return to the GCC Installation page} @insertcopying @end ifhtml @end ifset @c ***Prerequisites************************************************** @ifnothtml @comment node-name, next, previous, up @node Prerequisites, Downloading the source, , Installing GCC @end ifnothtml @ifset prerequisiteshtml @ifnothtml @chapter Prerequisites @end ifnothtml @cindex Prerequisites GCC requires that various tools and packages be available for use in the build procedure. Modifying GCC sources requires additional tools described below. @heading Tools/packages necessary for building GCC @table @asis @item ISO C90 compiler Necessary to bootstrap the GCC package, although versions of GCC prior to 3.4 also allow bootstrapping with a traditional (K&R) C compiler. To make all languages in a cross-compiler or other configuration where 3-stage bootstrap is not performed, you need to start with an existing GCC binary (version 2.95 or later) because source code for language frontends other than C might use GCC extensions. @item GNAT In order to build the Ada compiler (GNAT) you must already have GNAT installed because portions of the Ada frontend are written in Ada (with GNAT extensions.) Refer to the Ada installation instructions for more specific information. @item A ``working'' POSIX compatible shell, or GNU bash Necessary when running @command{configure} because some @command{/bin/sh} shells have bugs and may crash when configuring the target libraries. In other cases, @command{/bin/sh} or even some @command{ksh} have disastrous corner-case performance problems. This can cause target @command{configure} runs to literally take days to complete in some cases. So on some platforms @command{/bin/ksh} is sufficient, on others it isn't. See the host/target specific instructions for your platform, or use @command{bash} to be sure. Then set @env{CONFIG_SHELL} in your environment to your ``good'' shell prior to running @command{configure}/@command{make}. @command{zsh} is not a fully compliant POSIX shell and will not work when configuring GCC@. @item GNU binutils Necessary in some circumstances, optional in others. See the host/target specific instructions for your platform for the exact requirements. @item gzip version 1.2.4 (or later) or @itemx bzip2 version 1.0.2 (or later) Necessary to uncompress GCC @command{tar} files when source code is obtained via FTP mirror sites. @item GNU make version 3.79.1 (or later) You must have GNU make installed to build GCC@. @item GNU tar version 1.12 (or later) Necessary (only on some platforms) to untar the source code. Many systems' @command{tar} programs will also work, only try GNU @command{tar} if you have problems. @item GNU Multiple Precision Library (GMP) version 4.0 (or later) Necessary to build the Fortran frontend. If you don't have it installed in your library search path, you will have to configure with the @option{--with-gmp} or @option{--with-gmp-dir} configure option. @item MPFR Library Necessary to build the Fortran frontend. It can be downloaded from @uref{http://www.mpfr.org/}. It is also included in the current GMP release (4.1.3) when configured with @option{--enable-mpfr}. The @option{--with-mpfr} or @option{--with-mpfr-dir} configure option should be used if your MPFR Library is not installed in your library search path. @end table @heading Tools/packages necessary for modifying GCC @table @asis @item autoconf versions 2.13 and 2.59 @itemx GNU m4 version 1.4 (or later) Necessary when modifying @file{configure.ac}, @file{aclocal.m4}, etc.@: to regenerate @file{configure} and @file{config.in} files. Most directories require autoconf 2.59 (exactly), but the toplevel still requires autoconf 2.13 (exactly). @item automake versions 1.9.3 Necessary when modifying a @file{Makefile.am} file to regenerate its associated @file{Makefile.in}. Much of GCC does not use automake, so directly edit the @file{Makefile.in} file. Specifically this applies to the @file{gcc}, @file{intl}, @file{libcpp}, @file{libiberty}, @file{libobjc} directories as well as any of their subdirectories. For directories that use automake, GCC requires the latest release in the 1.9.x series, which is currently 1.9.3. When regenerating a directory to a newer version, please update all the directories using an older 1.9.x to the latest released version. @item gettext version 0.14.5 (or later) Needed to regenerate @file{gcc.pot}. @item gperf version 2.7.2 (or later) Necessary when modifying @command{gperf} input files, e.g.@: @file{gcc/cp/cfns.gperf} to regenerate its associated header file, e.g.@: @file{gcc/cp/cfns.h}. @item expect version ??? @itemx tcl version ??? @itemx dejagnu version 1.4.4 (or later) Necessary to run the GCC testsuite. @item autogen version 5.5.4 (or later) and @itemx guile version 1.4.1 (or later) Necessary to regenerate @file{fixinc/fixincl.x} from @file{fixinc/inclhack.def} and @file{fixinc/*.tpl}. Necessary to run the @file{fixinc} @command{make check}. Necessary to regenerate the top level @file{Makefile.in} file from @file{Makefile.tpl} and @file{Makefile.def}. @item GNU Bison version 1.28 (or later) Berkeley @command{yacc} (@command{byacc}) is also reported to work other than for java. Necessary when modifying @file{*.y} files. Necessary to build GCC during development because the generated output files are not included in the CVS repository. They are included in releases. @item Flex version 2.5.4 (or later) Necessary when modifying @file{*.l} files. Necessary to build GCC during development because the generated output files are not included in the CVS repository. They are included in releases. @item Texinfo version 4.2 (or later) Necessary for running @command{makeinfo} when modifying @file{*.texi} files to test your changes. Necessary to build GCC documentation during development because the generated output files are not included in the CVS repository. They are included in releases. @item @TeX{} (any working version) Necessary for running @command{texi2dvi}, used when running @command{make dvi} to create DVI files. @item cvs version 1.10 (or later) @itemx ssh (any version) Necessary to access the CVS repository. Public releases and weekly snapshots of the development sources are also available via FTP@. @item perl version 5.6.1 (or later) Necessary when regenerating @file{Makefile} dependencies in libiberty. Necessary when regenerating @file{libiberty/functions.texi}. Necessary when generating manpages from Texinfo manuals. Necessary when targetting Darwin, building libstdc++, and not using @option{--disable-symvers}. Used by various scripts to generate some files included in CVS (mainly Unicode-related and rarely changing) from source tables. @item GNU diffutils version 2.7 (or later) Necessary when creating changes to GCC source code to submit for review. @item patch version 2.5.4 (or later) Necessary when applying patches, created with @command{diff}, to one's own sources. @end table @html
@end html @ifhtml @uref{./index.html,,Return to the GCC Installation page} @end ifhtml @end ifset @c ***Downloading the source************************************************** @ifnothtml @comment node-name, next, previous, up @node Downloading the source, Configuration, Prerequisites, Installing GCC @end ifnothtml @ifset downloadhtml @ifnothtml @chapter Downloading GCC @end ifnothtml @cindex Downloading GCC @cindex Downloading the Source GCC is distributed via @uref{http://gcc.gnu.org/cvs.html,,CVS} and FTP tarballs compressed with @command{gzip} or @command{bzip2}. It is possible to download a full distribution or specific components. Please refer to the @uref{http://gcc.gnu.org/releases.html,,releases web page} for information on how to obtain GCC@. The full distribution includes the C, C++, Objective-C, Fortran 77, Fortran (in case of GCC 4.0 and later), Java, and Ada (in case of GCC 3.1 and later) compilers. The full distribution also includes runtime libraries for C++, Objective-C, Fortran 77, Fortran, and Java. In GCC 3.0 and later versions, GNU compiler testsuites are also included in the full distribution. If you choose to download specific components, you must download the core GCC distribution plus any language specific distributions you wish to use. The core distribution includes the C language front end as well as the shared components. Each language has a tarball which includes the language front end as well as the language runtime (when appropriate). Unpack the core distribution as well as any language specific distributions in the same directory. If you also intend to build binutils (either to upgrade an existing installation or for use in place of the corresponding tools of your OS), unpack the binutils distribution either in the same directory or a separate one. In the latter case, add symbolic links to any components of the binutils you intend to build alongside the compiler (@file{bfd}, @file{binutils}, @file{gas}, @file{gprof}, @file{ld}, @file{opcodes}, @dots{}) to the directory containing the GCC sources. @html
@end html @ifhtml @uref{./index.html,,Return to the GCC Installation page} @end ifhtml @end ifset @c ***Configuration*********************************************************** @ifnothtml @comment node-name, next, previous, up @node Configuration, Building, Downloading the source, Installing GCC @end ifnothtml @ifset configurehtml @ifnothtml @chapter Installing GCC: Configuration @end ifnothtml @cindex Configuration @cindex Installing GCC: Configuration Like most GNU software, GCC must be configured before it can be built. This document describes the recommended configuration procedure for both native and cross targets. We use @var{srcdir} to refer to the toplevel source directory for GCC; we use @var{objdir} to refer to the toplevel build/object directory. If you obtained the sources via CVS, @var{srcdir} must refer to the top @file{gcc} directory, the one where the @file{MAINTAINERS} can be found, and not its @file{gcc} subdirectory, otherwise the build will fail. If either @var{srcdir} or @var{objdir} is located on an automounted NFS file system, the shell's built-in @command{pwd} command will return temporary pathnames. Using these can lead to various sorts of build problems. To avoid this issue, set the @env{PWDCMD} environment variable to an automounter-aware @command{pwd} command, e.g., @command{pawd} or @samp{amq -w}, during the configuration and build phases. First, we @strong{highly} recommend that GCC be built into a separate directory than the sources which does @strong{not} reside within the source tree. This is how we generally build GCC; building where @var{srcdir} == @var{objdir} should still work, but doesn't get extensive testing; building where @var{objdir} is a subdirectory of @var{srcdir} is unsupported. If you have previously built GCC in the same directory for a different target machine, do @samp{make distclean} to delete all files that might be invalid. One of the files this deletes is @file{Makefile}; if @samp{make distclean} complains that @file{Makefile} does not exist or issues a message like ``don't know how to make distclean'' it probably means that the directory is already suitably clean. However, with the recommended method of building in a separate @var{objdir}, you should simply use a different @var{objdir} for each target. Second, when configuring a native system, either @command{cc} or @command{gcc} must be in your path or you must set @env{CC} in your environment before running configure. Otherwise the configuration scripts may fail. Note that the bootstrap compiler and the resulting GCC must be link compatible, else the bootstrap will fail with linker errors about incompatible object file formats. Several multilibed targets are affected by this requirement, see @ifnothtml @ref{Specific, host/target specific installation notes}. @end ifnothtml @ifhtml @uref{specific.html,,host/target specific installation notes}. @end ifhtml To configure GCC: @smallexample % mkdir @var{objdir} % cd @var{objdir} % @var{srcdir}/configure [@var{options}] [@var{target}] @end smallexample @heading Target specification @itemize @bullet @item GCC has code to correctly determine the correct value for @var{target} for nearly all native systems. Therefore, we highly recommend you not provide a configure target when configuring a native compiler. @item @var{target} must be specified as @option{--target=@var{target}} when configuring a cross compiler; examples of valid targets would be m68k-coff, sh-elf, etc. @item Specifying just @var{target} instead of @option{--target=@var{target}} implies that the host defaults to @var{target}. @end itemize @heading Options specification Use @var{options} to override several configure time options for GCC@. A list of supported @var{options} follows; @samp{configure --help} may list other options, but those not listed below may not work and should not normally be used. Note that each @option{--enable} option has a corresponding @option{--disable} option and that each @option{--with} option has a corresponding @option{--without} option. @table @code @item --prefix=@var{dirname} Specify the toplevel installation directory. This is the recommended way to install the tools into a directory other than the default. The toplevel installation directory defaults to @file{/usr/local}. We @strong{highly} recommend against @var{dirname} being the same or a subdirectory of @var{objdir} or vice versa. If specifying a directory beneath a user's home directory tree, some shells will not expand @var{dirname} correctly if it contains the @samp{~} metacharacter; use @env{$HOME} instead. The following standard @command{autoconf} options are supported. Normally you should not need to use these options. @table @code @item --exec-prefix=@var{dirname} Specify the toplevel installation directory for architecture-dependent files. The default is @file{@var{prefix}}. @item --bindir=@var{dirname} Specify the installation directory for the executables called by users (such as @command{gcc} and @command{g++}). The default is @file{@var{exec-prefix}/bin}. @item --libdir=@var{dirname} Specify the installation directory for object code libraries and internal data files of GCC@. The default is @file{@var{exec-prefix}/lib}. @item --libexecdir=@var{dirname} Specify the installation directory for internal executables of GCC@. The default is @file{@var{exec-prefix}/libexec}. @item --with-slibdir=@var{dirname} Specify the installation directory for the shared libgcc library. The default is @file{@var{libdir}}. @item --infodir=@var{dirname} Specify the installation directory for documentation in info format. The default is @file{@var{prefix}/info}. @item --datadir=@var{dirname} Specify the installation directory for some architecture-independent data files referenced by GCC@. The default is @file{@var{prefix}/share}. @item --mandir=@var{dirname} Specify the installation directory for manual pages. The default is @file{@var{prefix}/man}. (Note that the manual pages are only extracts from the full GCC manuals, which are provided in Texinfo format. The manpages are derived by an automatic conversion process from parts of the full manual.) @item --with-gxx-include-dir=@var{dirname} Specify the installation directory for G++ header files. The default is @file{@var{prefix}/include/c++/@var{version}}. @end table @item --program-prefix=@var{prefix} GCC supports some transformations of the names of its programs when installing them. This option prepends @var{prefix} to the names of programs to install in @var{bindir} (see above). For example, specifying @option{--program-prefix=foo-} would result in @samp{gcc} being installed as @file{/usr/local/bin/foo-gcc}. @item --program-suffix=@var{suffix} Appends @var{suffix} to the names of programs to install in @var{bindir} (see above). For example, specifying @option{--program-suffix=-3.1} would result in @samp{gcc} being installed as @file{/usr/local/bin/gcc-3.1}. @item --program-transform-name=@var{pattern} Applies the @samp{sed} script @var{pattern} to be applied to the names of programs to install in @var{bindir} (see above). @var{pattern} has to consist of one or more basic @samp{sed} editing commands, separated by semicolons. For example, if you want the @samp{gcc} program name to be transformed to the installed program @file{/usr/local/bin/myowngcc} and the @samp{g++} program name to be transformed to @file{/usr/local/bin/gspecial++} without changing other program names, you could use the pattern @option{--program-transform-name='s/^gcc$/myowngcc/; s/^g++$/gspecial++/'} to achieve this effect. All three options can be combined and used together, resulting in more complex conversion patterns. As a basic rule, @var{prefix} (and @var{suffix}) are prepended (appended) before further transformations can happen with a special transformation script @var{pattern}. As currently implemented, this option only takes effect for native builds; cross compiler binaries' names are not transformed even when a transformation is explicitly asked for by one of these options. For native builds, some of the installed programs are also installed with the target alias in front of their name, as in @samp{i686-pc-linux-gnu-gcc}. All of the above transformations happen before the target alias is prepended to the name---so, specifying @option{--program-prefix=foo-} and @option{program-suffix=-3.1}, the resulting binary would be installed as @file{/usr/local/bin/i686-pc-linux-gnu-foo-gcc-3.1}. As a last shortcoming, none of the installed Ada programs are transformed yet, which will be fixed in some time. @item --with-local-prefix=@var{dirname} Specify the installation directory for local include files. The default is @file{/usr/local}. Specify this option if you want the compiler to search directory @file{@var{dirname}/include} for locally installed header files @emph{instead} of @file{/usr/local/include}. You should specify @option{--with-local-prefix} @strong{only} if your site has a different convention (not @file{/usr/local}) for where to put site-specific files. The default value for @option{--with-local-prefix} is @file{/usr/local} regardless of the value of @option{--prefix}. Specifying @option{--prefix} has no effect on which directory GCC searches for local header files. This may seem counterintuitive, but actually it is logical. The purpose of @option{--prefix} is to specify where to @emph{install GCC}. The local header files in @file{/usr/local/include}---if you put any in that directory---are not part of GCC@. They are part of other programs---perhaps many others. (GCC installs its own header files in another directory which is based on the @option{--prefix} value.) Both the local-prefix include directory and the GCC-prefix include directory are part of GCC's ``system include'' directories. Although these two directories are not fixed, they need to be searched in the proper order for the correct processing of the include_next directive. The local-prefix include directory is searched before the GCC-prefix include directory. Another characteristic of system include directories is that pedantic warnings are turned off for headers in these directories. Some autoconf macros add @option{-I @var{directory}} options to the compiler command line, to ensure that directories containing installed packages' headers are searched. When @var{directory} is one of GCC's system include directories, GCC will ignore the option so that system directories continue to be processed in the correct order. This may result in a search order different from what was specified but the directory will still be searched. GCC automatically searches for ordinary libraries using @env{GCC_EXEC_PREFIX}. Thus, when the same installation prefix is used for both GCC and packages, GCC will automatically search for both headers and libraries. This provides a configuration that is easy to use. GCC behaves in a manner similar to that when it is installed as a system compiler in @file{/usr}. Sites that need to install multiple versions of GCC may not want to use the above simple configuration. It is possible to use the @option{--program-prefix}, @option{--program-suffix} and @option{--program-transform-name} options to install multiple versions into a single directory, but it may be simpler to use different prefixes and the @option{--with-local-prefix} option to specify the location of the site-specific files for each version. It will then be necessary for users to specify explicitly the location of local site libraries (e.g., with @env{LIBRARY_PATH}). The same value can be used for both @option{--with-local-prefix} and @option{--prefix} provided it is not @file{/usr}. This can be used to avoid the default search of @file{/usr/local/include}. @strong{Do not} specify @file{/usr} as the @option{--with-local-prefix}! The directory you use for @option{--with-local-prefix} @strong{must not} contain any of the system's standard header files. If it did contain them, certain programs would be miscompiled (including GNU Emacs, on certain targets), because this would override and nullify the header file corrections made by the @command{fixincludes} script. Indications are that people who use this option use it based on mistaken ideas of what it is for. People use it as if it specified where to install part of GCC@. Perhaps they make this assumption because installing GCC creates the directory. @item --enable-shared[=@var{package}[,@dots{}]] Build shared versions of libraries, if shared libraries are supported on the target platform. Unlike GCC 2.95.x and earlier, shared libraries are enabled by default on all platforms that support shared libraries. If a list of packages is given as an argument, build shared libraries only for the listed packages. For other packages, only static libraries will be built. Package names currently recognized in the GCC tree are @samp{libgcc} (also known as @samp{gcc}), @samp{libstdc++} (not @samp{libstdc++-v3}), @samp{libffi}, @samp{zlib}, @samp{boehm-gc}, @samp{ada}, @samp{libada}, @samp{libjava} and @samp{libobjc}. Note @samp{libiberty} does not support shared libraries at all. Use @option{--disable-shared} to build only static libraries. Note that @option{--disable-shared} does not accept a list of package names as argument, only @option{--enable-shared} does. @item @anchor{with-gnu-as}--with-gnu-as Specify that the compiler should assume that the assembler it finds is the GNU assembler. However, this does not modify the rules to find an assembler and will result in confusion if the assembler found is not actually the GNU assembler. (Confusion may also result if the compiler finds the GNU assembler but has not been configured with @option{--with-gnu-as}.) If you have more than one assembler installed on your system, you may want to use this option in connection with @option{--with-as=@var{pathname}}. The following systems are the only ones where it makes a difference whether you use the GNU assembler. On any other system, @option{--with-gnu-as} has no effect. @itemize @bullet @item @samp{hppa1.0-@var{any}-@var{any}} @item @samp{hppa1.1-@var{any}-@var{any}} @item @samp{i386-@var{any}-sysv} @item @samp{m68k-bull-sysv} @item @samp{m68k-hp-hpux} @item @samp{m68000-hp-hpux} @item @samp{m68000-att-sysv} @item @samp{sparc-sun-solaris2.@var{any}} @item @samp{sparc64-@var{any}-solaris2.@var{any}} @end itemize On the systems listed above (except for the HP-PA, the SPARC, for ISC on the 386, if you use the GNU assembler, you should also use the GNU linker (and specify @option{--with-gnu-ld}). @item @anchor{with-as}--with-as=@var{pathname} Specify that the compiler should use the assembler pointed to by @var{pathname}, rather than the one found by the standard rules to find an assembler, which are: @itemize @bullet @item Check the @file{@var{libexec}/gcc/@var{target}/@var{version}} directory, where @var{libexec} defaults to @file{@var{exec-prefix}/libexec} and @var{exec-prefix} defaults to @var{prefix} which defaults to @file{/usr/local} unless overridden by the @option{--prefix=@var{pathname}} switch described above. @var{target} is the target system triple, such as @samp{sparc-sun-solaris2.7}, and @var{version} denotes the GCC version, such as 3.0. @item Check operating system specific directories (e.g.@: @file{/usr/ccs/bin} on Sun Solaris 2). @end itemize Note that these rules do not check for the value of @env{PATH}. You may want to use @option{--with-as} if no assembler is installed in the directories listed above, or if you have multiple assemblers installed and want to choose one that is not found by the above rules. @item @anchor{with-gnu-ld}--with-gnu-ld Same as @uref{#with-gnu-as,,@option{--with-gnu-as}} but for the linker. @item --with-ld=@var{pathname} Same as @uref{#with-as,,@option{--with-as}} but for the linker. @item --with-stabs Specify that stabs debugging information should be used instead of whatever format the host normally uses. Normally GCC uses the same debug format as the host system. On MIPS based systems and on Alphas, you must specify whether you want GCC to create the normal ECOFF debugging format, or to use BSD-style stabs passed through the ECOFF symbol table. The normal ECOFF debug format cannot fully handle languages other than C@. BSD stabs format can handle other languages, but it only works with the GNU debugger GDB@. Normally, GCC uses the ECOFF debugging format by default; if you prefer BSD stabs, specify @option{--with-stabs} when you configure GCC@. No matter which default you choose when you configure GCC, the user can use the @option{-gcoff} and @option{-gstabs+} options to specify explicitly the debug format for a particular compilation. @option{--with-stabs} is meaningful on the ISC system on the 386, also, if @option{--with-gas} is used. It selects use of stabs debugging information embedded in COFF output. This kind of debugging information supports C++ well; ordinary COFF debugging information does not. @option{--with-stabs} is also meaningful on 386 systems running SVR4. It selects use of stabs debugging information embedded in ELF output. The C++ compiler currently (2.6.0) does not support the DWARF debugging information normally used on 386 SVR4 platforms; stabs provide a workable alternative. This requires gas and gdb, as the normal SVR4 tools can not generate or interpret stabs. @item --disable-multilib Specify that multiple target libraries to support different target variants, calling conventions, etc should not be built. The default is to build a predefined set of them. Some targets provide finer-grained control over which multilibs are built (e.g., @option{--disable-softfloat}): @table @code @item arc-*-elf* biendian. @item arm-*-* fpu, 26bit, underscore, interwork, biendian, nofmult. @item m68*-*-* softfloat, m68881, m68000, m68020. @item mips*-*-* single-float, biendian, softfloat. @item powerpc*-*-*, rs6000*-*-* aix64, pthread, softfloat, powercpu, powerpccpu, powerpcos, biendian, sysv, aix. @end table @item --enable-threads Specify that the target supports threads. This affects the Objective-C compiler and runtime library, and exception handling for other languages like C++ and Java. On some systems, this is the default. In general, the best (and, in many cases, the only known) threading model available will be configured for use. Beware that on some systems, GCC has not been taught what threading models are generally available for the system. In this case, @option{--enable-threads} is an alias for @option{--enable-threads=single}. @item --disable-threads Specify that threading support should be disabled for the system. This is an alias for @option{--enable-threads=single}. @item --enable-threads=@var{lib} Specify that @var{lib} is the thread support library. This affects the Objective-C compiler and runtime library, and exception handling for other languages like C++ and Java. The possibilities for @var{lib} are: @table @code @item aix AIX thread support. @item dce DCE thread support. @item gnat Ada tasking support. For non-Ada programs, this setting is equivalent to @samp{single}. When used in conjunction with the Ada run time, it causes GCC to use the same thread primitives as Ada uses. This option is necessary when using both Ada and the back end exception handling, which is the default for most Ada targets. @item mach Generic MACH thread support, known to work on NeXTSTEP@. (Please note that the file needed to support this configuration, @file{gthr-mach.h}, is missing and thus this setting will cause a known bootstrap failure.) @item no This is an alias for @samp{single}. @item posix Generic POSIX/Unix98 thread support. @item posix95 Generic POSIX/Unix95 thread support. @item rtems RTEMS thread support. @item single Disable thread support, should work for all platforms. @item solaris Sun Solaris 2 thread support. @item vxworks VxWorks thread support. @item win32 Microsoft Win32 API thread support. @item nks Novell Kernel Services thread support. @end table @item --with-cpu=@var{cpu} Specify which cpu variant the compiler should generate code for by default. @var{cpu} will be used as the default value of the @option{-mcpu=} switch. This option is only supported on some targets, including ARM, i386, PowerPC, and SPARC@. @item --with-schedule=@var{cpu} @itemx --with-arch=@var{cpu} @itemx --with-tune=@var{cpu} @itemx --with-abi=@var{abi} @itemx --with-fpu=@var{type} @itemx --with-float=@var{type} These configure options provide default values for the @option{-mschedule=}, @option{-march=}, @option{-mtune=}, @option{-mabi=}, and @option{-mfpu=} options and for @option{-mhard-float} or @option{-msoft-float}. As with @option{--with-cpu}, which switches will be accepted and acceptable values of the arguments depend on the target. @item --with-divide=@var{type} Specify how the compiler should generate code for checking for division by zero. This option is only supported on the MIPS target. The possibilities for @var{type} are: @table @code @item traps Division by zero checks use conditional traps (this is the default on systems that support conditional traps). @item breaks Division by zero checks use the break instruction. @end table @item --enable-__cxa_atexit Define if you want to use __cxa_atexit, rather than atexit, to register C++ destructors for local statics and global objects. This is essential for fully standards-compliant handling of destructors, but requires __cxa_atexit in libc. This option is currently only available on systems with GNU libc. When enabled, this will cause @option{-fuse-cxa-exit} to be passed by default. @item --enable-target-optspace Specify that target libraries should be optimized for code space instead of code speed. This is the default for the m32r platform. @item --disable-cpp Specify that a user visible @command{cpp} program should not be installed. @item --with-cpp-install-dir=@var{dirname} Specify that the user visible @command{cpp} program should be installed in @file{@var{prefix}/@var{dirname}/cpp}, in addition to @var{bindir}. @item --enable-initfini-array Force the use of sections @code{.init_array} and @code{.fini_array} (instead of @code{.init} and @code{.fini}) for constructors and destructors. Option @option{--disable-initfini-array} has the opposite effect. If neither option is specified, the configure script will try to guess whether the @code{.init_array} and @code{.fini_array} sections are supported and, if they are, use them. @item --enable-maintainer-mode The build rules that regenerate the GCC master message catalog @file{gcc.pot} are normally disabled. This is because it can only be rebuilt if the complete source tree is present. If you have changed the sources and want to rebuild the catalog, configuring with @option{--enable-maintainer-mode} will enable this. Note that you need a recent version of the @code{gettext} tools to do so. @item --enable-generated-files-in-srcdir Neither the .c and .h files that are generated from bison and flex nor the info manuals and man pages that are built from the .texi files are present in the CVS development tree. When building GCC from that development tree, or from a snapshot which are created from CVS, then those generated files are placed in your build directory, which allows for the source to be in a readonly directory. If you configure with @option{--enable-generated-files-in-srcdir} then those generated files will go into the source directory. This is mainly intended for generating release or prerelease tarballs of the GCC sources, since it is not a requirement that the users of source releases to have flex, bison, or makeinfo. @item --enable-version-specific-runtime-libs Specify that runtime libraries should be installed in the compiler specific subdirectory (@file{@var{libdir}/gcc}) rather than the usual places. In addition, @samp{libstdc++}'s include files will be installed into @file{@var{libdir}} unless you overruled it by using @option{--with-gxx-include-dir=@var{dirname}}. Using this option is particularly useful if you intend to use several versions of GCC in parallel. This is currently supported by @samp{libgfortran}, @samp{libjava}, @samp{libmudflap}, @samp{libstdc++}, and @samp{libobjc}. @item --with-java-home=@var{dirname} This @samp{libjava} option overrides the default value of the @samp{java.home} system property. It is also used to set @samp{sun.boot.class.path} to @file{@var{dirname}/lib/rt.jar}. By default @samp{java.home} is set to @file{@var{prefix}} and @samp{sun.boot.class.path} to @file{@var{datadir}/java/libgcj-@var{version}.jar}. @item --enable-languages=@var{lang1},@var{lang2},@dots{} Specify that only a particular subset of compilers and their runtime libraries should be built. For a list of valid values for @var{langN} you can issue the following command in the @file{gcc} directory of your GCC source tree:@* @smallexample grep language= */config-lang.in @end smallexample Currently, you can use any of the following: @code{all}, @code{ada}, @code{c}, @code{c++}, @code{f95}, @code{java}, @code{objc}, @code{obj-c++}, @code{treelang}. Building the Ada compiler has special requirements, see below. If you do not pass this flag, or specify the option @code{all}, then all default languages available in the @file{gcc} sub-tree will be configured. Ada, Objective-C++, and treelang are not default languages; the rest are. Re-defining @code{LANGUAGES} when calling @samp{make bootstrap} @strong{does not} work anymore, as those language sub-directories might not have been configured! @item --disable-libada Specify that the run-time libraries and tools used by GNAT should not be built. This can be useful for debugging, or for compatibility with previous Ada build procedures, when it was required to explicitly do a @samp{make -C gcc gnatlib_and_tools}. @item --disable-libssp Specify that the run-time libraries for stack smashing protection should not be built. @item --with-dwarf2 Specify that the compiler should use DWARF 2 debugging information as the default. @item --enable-targets=all @itemx --enable-targets=@var{target_list} Some GCC targets, e.g.@: powerpc64-linux, build bi-arch compilers. These are compilers that are able to generate either 64-bit or 32-bit code. Typically, the corresponding 32-bit target, e.g.@: powerpc-linux for powerpc64-linux, only generates 32-bit code. This option enables the 32-bit target to be a bi-arch compiler, which is useful when you want a bi-arch compiler that defaults to 32-bit, and you are building a bi-arch or multi-arch binutils in a combined tree. Currently, this option only affects powerpc-linux. @item --enable-secureplt This option enables @option{-msecure-plt} by default for powerpc-linux. @ifnothtml @xref{RS/6000 and PowerPC Options,, RS/6000 and PowerPC Options, gcc, Using the GNU Compiler Collection (GCC)}, @end ifnothtml @ifhtml See ``RS/6000 and PowerPC Options'' in the main manual @end ifhtml @item --enable-win32-registry @itemx --enable-win32-registry=@var{key} @itemx --disable-win32-registry The @option{--enable-win32-registry} option enables Microsoft Windows-hosted GCC to look up installations paths in the registry using the following key: @smallexample @code{HKEY_LOCAL_MACHINE\SOFTWARE\Free Software Foundation\@var{key}} @end smallexample @var{key} defaults to GCC version number, and can be overridden by the @option{--enable-win32-registry=@var{key}} option. Vendors and distributors who use custom installers are encouraged to provide a different key, perhaps one comprised of vendor name and GCC version number, to avoid conflict with existing installations. This feature is enabled by default, and can be disabled by @option{--disable-win32-registry} option. This option has no effect on the other hosts. @item --nfp Specify that the machine does not have a floating point unit. This option only applies to @samp{m68k-sun-sunos@var{n}}. On any other system, @option{--nfp} has no effect. @item --enable-werror @itemx --disable-werror @itemx --enable-werror=yes @itemx --enable-werror=no When you specify this option, it controls whether certain files in the compiler are built with @option{-Werror} in bootstrap stage2 and later. If you don't specify it, @option{-Werror} is turned on for the main development trunk. However it defaults to off for release branches and final releases. The specific files which get @option{-Werror} are controlled by the Makefiles. @item --enable-checking @itemx --enable-checking=@var{list} When you specify this option, the compiler is built to perform internal consistency checks of the requested complexity. This does not change the generated code, but adds error checking within the compiler. This will slow down the compiler and may only work properly if you are building the compiler with GCC@. This is @samp{yes} by default when building from CVS or snapshots, but @samp{release} for releases. More control over the checks may be had by specifying @var{list}. The categories of checks available are @samp{yes} (most common checks @samp{assert,misc,tree,gc,rtlflag,runtime}), @samp{no} (no checks at all), @samp{all} (all but @samp{valgrind}), @samp{release} (cheapest checks @samp{assert,runtime}) or @samp{none} (same as @samp{no}). Individual checks can be enabled with these flags @samp{assert}, @samp{fold}, @samp{gc}, @samp{gcac} @samp{misc}, @samp{rtl}, @samp{rtlflag}, @samp{runtime}, @samp{tree}, and @samp{valgrind}. The @samp{valgrind} check requires the external @command{valgrind} simulator, available from @uref{http://valgrind.org/}. The @samp{rtl}, @samp{gcac} and @samp{valgrind} checks are very expensive. To disable all checking, @samp{--disable-checking} or @samp{--enable-checking=none} must be explicitly requested. Disabling assertions will make the compiler and runtime slightly faster but increase the risk of undetected internal errors causing wrong code to be generated. @item --enable-coverage @itemx --enable-coverage=@var{level} With this option, the compiler is built to collect self coverage information, every time it is run. This is for internal development purposes, and only works when the compiler is being built with gcc. The @var{level} argument controls whether the compiler is built optimized or not, values are @samp{opt} and @samp{noopt}. For coverage analysis you want to disable optimization, for performance analysis you want to enable optimization. When coverage is enabled, the default level is without optimization. @item --enable-gather-detailed-mem-stats When this option is specified more detailed information on memory allocation is gathered. This information is printed when using @option{-fmem-report}. @item --with-gc @itemx --with-gc=@var{choice} With this option you can specify the garbage collector implementation used during the compilation process. @var{choice} can be one of @samp{page} and @samp{zone}, where @samp{page} is the default. @item --enable-nls @itemx --disable-nls The @option{--enable-nls} option enables Native Language Support (NLS), which lets GCC output diagnostics in languages other than American English. Native Language Support is enabled by default if not doing a canadian cross build. The @option{--disable-nls} option disables NLS@. @item --with-included-gettext If NLS is enabled, the @option{--with-included-gettext} option causes the build procedure to prefer its copy of GNU @command{gettext}. @item --with-catgets If NLS is enabled, and if the host lacks @code{gettext} but has the inferior @code{catgets} interface, the GCC build procedure normally ignores @code{catgets} and instead uses GCC's copy of the GNU @code{gettext} library. The @option{--with-catgets} option causes the build procedure to use the host's @code{catgets} in this situation. @item --with-libiconv-prefix=@var{dir} Search for libiconv header files in @file{@var{dir}/include} and libiconv library files in @file{@var{dir}/lib}. @item --enable-obsolete Enable configuration for an obsoleted system. If you attempt to configure GCC for a system (build, host, or target) which has been obsoleted, and you do not specify this flag, configure will halt with an error message. All support for systems which have been obsoleted in one release of GCC is removed entirely in the next major release, unless someone steps forward to maintain the port. @end table @subheading Cross-Compiler-Specific Options The following options only apply to building cross compilers. @table @code @item --with-sysroot @itemx --with-sysroot=@var{dir} Tells GCC to consider @var{dir} as the root of a tree that contains a (subset of) the root filesystem of the target operating system. Target system headers, libraries and run-time object files will be searched in there. The specified directory is not copied into the install tree, unlike the options @option{--with-headers} and @option{--with-libs} that this option obsoletes. The default value, in case @option{--with-sysroot} is not given an argument, is @option{$@{gcc_tooldir@}/sys-root}. If the specified directory is a subdirectory of @option{$@{exec_prefix@}}, then it will be found relative to the GCC binaries if the installation tree is moved. @item --with-build-sysroot @itemx --with-build-sysroot=@var{dir} Tells GCC to consider @var{dir} as the system root (see @option{--with-sysroot}) while building target libraries, instead of the directory specified with @option{--with-sysroot}. This option is only useful when you are already using @option{--with-sysroot}. You can use @option{--with-build-sysroot} when you are configuring with @option{--prefix} set to a directory that is different from the one in which you are installing GCC and your target libraries. This option affects the system root for the compiler used to build target libraries (which runs on the build system); it does not affect the compiler which is used to build GCC itself. @item --with-headers @itemx --with-headers=@var{dir} Deprecated in favor of @option{--with-sysroot}. Specifies that target headers are available when building a cross compiler. The @var{dir} argument specifies a directory which has the target include files. These include files will be copied into the @file{gcc} install directory. @emph{This option with the @var{dir} argument is required} when building a cross compiler, if @file{@var{prefix}/@var{target}/sys-include} doesn't pre-exist. If @file{@var{prefix}/@var{target}/sys-include} does pre-exist, the @var{dir} argument may be omitted. @command{fixincludes} will be run on these files to make them compatible with GCC@. @item --without-headers Tells GCC not use any target headers from a libc when building a cross compiler. When crossing to GNU/Linux, you need the headers so GCC can build the exception handling for libgcc. See @uref{http://www.objsw.com/CrossGCC/,,CrossGCC} for more information on this option. @item --with-libs @itemx --with-libs=``@var{dir1} @var{dir2} @dots{} @var{dirN}'' Deprecated in favor of @option{--with-sysroot}. Specifies a list of directories which contain the target runtime libraries. These libraries will be copied into the @file{gcc} install directory. If the directory list is omitted, this option has no effect. @item --with-newlib Specifies that @samp{newlib} is being used as the target C library. This causes @code{__eprintf} to be omitted from @file{libgcc.a} on the assumption that it will be provided by @samp{newlib}. @end table @subheading Fortran-specific Option The following options apply to the build of the Fortran front end. @table @code @item --with-gmp=@var{pathname} @itemx --with-mpfr=@var{pathname} @itemx --with-gmp-dir=@var{pathname} @itemx --with-mpfr-dir=@var{pathname} If you don't have GMP (the GNU Multiple Precision library) and the MPFR Libraries installed in a standard location and you want to build the Fortran front-end, you can explicitly specify the directory where they are installed (@samp{--with-gmp=gmpinstalldir}, @samp{--with-mpfr=mpfrinstalldir}) or where you built them without installing (@samp{--with-gmp-dir=gmpbuilddir}, @samp{--with-mpfr-dir=gmpbuilddir}). @end table @subheading Java-Specific Options The following option applies to the build of the Java front end. @table @code @item --disable-libgcj Specify that the run-time libraries used by GCJ should not be built. This is useful in case you intend to use GCJ with some other run-time, or you're going to install it separately, or it just happens not to build on your particular machine. In general, if the Java front end is enabled, the GCJ libraries will be enabled too, unless they're known to not work on the target platform. If GCJ is enabled but @samp{libgcj} isn't built, you may need to port it; in this case, before modifying the top-level @file{configure.in} so that @samp{libgcj} is enabled by default on this platform, you may use @option{--enable-libgcj} to override the default. @end table The following options apply to building @samp{libgcj}. @subsubheading General Options @table @code @item --disable-getenv-properties Don't set system properties from @env{GCJ_PROPERTIES}. @item --enable-hash-synchronization Use a global hash table for monitor locks. Ordinarily, @samp{libgcj}'s @samp{configure} script automatically makes the correct choice for this option for your platform. Only use this if you know you need the library to be configured differently. @item --enable-interpreter Enable the Java interpreter. The interpreter is automatically enabled by default on all platforms that support it. This option is really only useful if you want to disable the interpreter (using @option{--disable-interpreter}). @item --disable-java-net Disable java.net. This disables the native part of java.net only, using non-functional stubs for native method implementations. @item --disable-jvmpi Disable JVMPI support. @item --with-ecos Enable runtime eCos target support. @item --without-libffi Don't use @samp{libffi}. This will disable the interpreter and JNI support as well, as these require @samp{libffi} to work. @item --enable-libgcj-debug Enable runtime debugging code. @item --enable-libgcj-multifile If specified, causes all @file{.java} source files to be compiled into @file{.class} files in one invocation of @samp{gcj}. This can speed up build time, but is more resource-intensive. If this option is unspecified or disabled, @samp{gcj} is invoked once for each @file{.java} file to compile into a @file{.class} file. @item --with-libiconv-prefix=DIR Search for libiconv in @file{DIR/include} and @file{DIR/lib}. @item --enable-sjlj-exceptions Force use of @code{builtin_setjmp} for exceptions. @samp{configure} ordinarily picks the correct value based on the platform. Only use this option if you are sure you need a different setting. @item --with-system-zlib Use installed @samp{zlib} rather than that included with GCC@. @item --with-win32-nlsapi=ansi, unicows or unicode Indicates how MinGW @samp{libgcj} translates between UNICODE characters and the Win32 API@. @table @code @item ansi Use the single-byte @code{char} and the Win32 A functions natively, translating to and from UNICODE when using these functions. If unspecified, this is the default. @item unicows Use the @code{WCHAR} and Win32 W functions natively. Adds @code{-lunicows} to @file{libgcj.spec} to link with @samp{libunicows}. @file{unicows.dll} needs to be deployed on Microsoft Windows 9X machines running built executables. @file{libunicows.a}, an open-source import library around Microsoft's @code{unicows.dll}, is obtained from @uref{http://libunicows.sourceforge.net/}, which also gives details on getting @file{unicows.dll} from Microsoft. @item unicode Use the @code{WCHAR} and Win32 W functions natively. Does @emph{not} add @code{-lunicows} to @file{libgcj.spec}. The built executables will only run on Microsoft Windows NT and above. @end table @end table @subsubheading AWT-Specific Options @table @code @item --with-x Use the X Window System. @item --enable-java-awt=PEER(S) Specifies the AWT peer library or libraries to build alongside @samp{libgcj}. If this option is unspecified or disabled, AWT will be non-functional. Current valid values are @option{gtk} and @option{xlib}. Multiple libraries should be separated by a comma (i.e.@: @option{--enable-java-awt=gtk,xlib}). @item --enable-gtk-cairo Build the cairo Graphics2D implementation on GTK@. @item --enable-java-gc=TYPE Choose garbage collector. Defaults to @option{boehm} if unspecified. @item --disable-gtktest Do not try to compile and run a test GTK+ program. @item --disable-glibtest Do not try to compile and run a test GLIB program. @item --with-libart-prefix=PFX Prefix where libart is installed (optional). @item --with-libart-exec-prefix=PFX Exec prefix where libart is installed (optional). @item --disable-libarttest Do not try to compile and run a test libart program. @end table @html
@end html @ifhtml @uref{./index.html,,Return to the GCC Installation page} @end ifhtml @end ifset @c ***Building**************************************************************** @ifnothtml @comment node-name, next, previous, up @node Building, Testing, Configuration, Installing GCC @end ifnothtml @ifset buildhtml @ifnothtml @chapter Building @end ifnothtml @cindex Installing GCC: Building Now that GCC is configured, you are ready to build the compiler and runtime libraries. Some commands executed when making the compiler may fail (return a nonzero status) and be ignored by @command{make}. These failures, which are often due to files that were not found, are expected, and can safely be ignored. It is normal to have compiler warnings when compiling certain files. Unless you are a GCC developer, you can generally ignore these warnings unless they cause compilation to fail. Developers should attempt to fix any warnings encountered, however they can temporarily continue past warnings-as-errors by specifying the configure flag @option{--disable-werror}. On certain old systems, defining certain environment variables such as @env{CC} can interfere with the functioning of @command{make}. If you encounter seemingly strange errors when trying to build the compiler in a directory other than the source directory, it could be because you have previously configured the compiler in the source directory. Make sure you have done all the necessary preparations. If you build GCC on a BSD system using a directory stored in an old System V file system, problems may occur in running @command{fixincludes} if the System V file system doesn't support symbolic links. These problems result in a failure to fix the declaration of @code{size_t} in @file{sys/types.h}. If you find that @code{size_t} is a signed type and that type mismatches occur, this could be the cause. The solution is not to use such a directory for building GCC@. When building from CVS or snapshots, or if you modify parser sources, you need the Bison parser generator installed. Any version 1.25 or later should work; older versions may also work. If you do not modify parser sources, releases contain the Bison-generated files and you do not need Bison installed to build them. When building from CVS or snapshots, or if you modify Texinfo documentation, you need version 4.2 or later of Texinfo installed if you want Info documentation to be regenerated. Releases contain Info documentation pre-built for the unmodified documentation in the release. @section Building a native compiler For a native build issue the command @samp{make bootstrap}. This will build the entire GCC system, which includes the following steps: @itemize @bullet @item Build host tools necessary to build the compiler such as texinfo, bison, gperf. @item Build target tools for use by the compiler such as binutils (bfd, binutils, gas, gprof, ld, and opcodes) if they have been individually linked or moved into the top level GCC source tree before configuring. @item Perform a 3-stage bootstrap of the compiler. @item Perform a comparison test of the stage2 and stage3 compilers. @item Build runtime libraries using the stage3 compiler from the previous step. @end itemize If you are short on disk space you might consider @samp{make bootstrap-lean} instead. This is identical to @samp{make bootstrap} except that object files from the stage1 and stage2 of the 3-stage bootstrap of the compiler are deleted as soon as they are no longer needed. If you want to save additional space during the bootstrap and in the final installation as well, you can build the compiler binaries without debugging information as in the following example. This will save roughly 40% of disk space both for the bootstrap and the final installation. (Libraries will still contain debugging information.) @smallexample make CFLAGS='-O' LIBCFLAGS='-g -O2' \ LIBCXXFLAGS='-g -O2 -fno-implicit-templates' bootstrap @end smallexample If you wish to use non-default GCC flags when compiling the stage2 and stage3 compilers, set @code{BOOT_CFLAGS} on the command line when doing @samp{make bootstrap}. Non-default optimization flags are less well tested here than the default of @samp{-g -O2}, but should still work. In a few cases, you may find that you need to specify special flags such as @option{-msoft-float} here to complete the bootstrap; or, if the native compiler miscompiles the stage1 compiler, you may need to work around this, by choosing @code{BOOT_CFLAGS} to avoid the parts of the stage1 compiler that were miscompiled, or by using @samp{make bootstrap4} to increase the number of stages of bootstrap. Note that using non-standard @code{CFLAGS} can cause bootstrap to fail in @file{libiberty}, if these trigger a warning with the new compiler. For example using @samp{-O2 -g -mcpu=i686} on @code{i686-pc-linux-gnu} will cause bootstrap failure as @option{-mcpu=} is deprecated in 3.4.0 and above. If you used the flag @option{--enable-languages=@dots{}} to restrict the compilers to be built, only those you've actually enabled will be built. This will of course only build those runtime libraries, for which the particular compiler has been built. Please note, that re-defining @env{LANGUAGES} when calling @samp{make bootstrap} @strong{does not} work anymore! If the comparison of stage2 and stage3 fails, this normally indicates that the stage2 compiler has compiled GCC incorrectly, and is therefore a potentially serious bug which you should investigate and report. (On a few systems, meaningful comparison of object files is impossible; they always appear ``different''. If you encounter this problem, you will need to disable comparison in the @file{Makefile}.) @section Building a cross compiler We recommend reading the @uref{http://www.objsw.com/CrossGCC/,,crossgcc FAQ} for information about building cross compilers. When building a cross compiler, it is not generally possible to do a 3-stage bootstrap of the compiler. This makes for an interesting problem as parts of GCC can only be built with GCC@. To build a cross compiler, we first recommend building and installing a native compiler. You can then use the native GCC compiler to build the cross compiler. The installed native compiler needs to be GCC version 2.95 or later. Assuming you have already installed a native copy of GCC and configured your cross compiler, issue the command @command{make}, which performs the following steps: @itemize @bullet @item Build host tools necessary to build the compiler such as texinfo, bison, gperf. @item Build target tools for use by the compiler such as binutils (bfd, binutils, gas, gprof, ld, and opcodes) if they have been individually linked or moved into the top level GCC source tree before configuring. @item Build the compiler (single stage only). @item Build runtime libraries using the compiler from the previous step. @end itemize Note that if an error occurs in any step the make process will exit. If you are not building GNU binutils in the same source tree as GCC, you will need a cross-assembler and cross-linker installed before configuring GCC@. Put them in the directory @file{@var{prefix}/@var{target}/bin}. Here is a table of the tools you should put in this directory: @table @file @item as This should be the cross-assembler. @item ld This should be the cross-linker. @item ar This should be the cross-archiver: a program which can manipulate archive files (linker libraries) in the target machine's format. @item ranlib This should be a program to construct a symbol table in an archive file. @end table The installation of GCC will find these programs in that directory, and copy or link them to the proper place to for the cross-compiler to find them when run later. The easiest way to provide these files is to build the Binutils package. Configure it with the same @option{--host} and @option{--target} options that you use for configuring GCC, then build and install them. They install their executables automatically into the proper directory. Alas, they do not support all the targets that GCC supports. If you are not building a C library in the same source tree as GCC, you should also provide the target libraries and headers before configuring GCC, specifying the directories with @option{--with-sysroot} or @option{--with-headers} and @option{--with-libs}. Many targets also require ``start files'' such as @file{crt0.o} and @file{crtn.o} which are linked into each executable. There may be several alternatives for @file{crt0.o}, for use with profiling or other compilation options. Check your target's definition of @code{STARTFILE_SPEC} to find out what start files it uses. @section Building in parallel You can use @samp{make bootstrap MAKE="make -j 2" -j 2}, or just @samp{make -j 2 bootstrap} for GNU Make 3.79 and above, instead of @samp{make bootstrap} to build GCC in parallel. You can also specify a bigger number, and in most cases using a value greater than the number of processors in your machine will result in fewer and shorter I/O latency hits, thus improving overall throughput; this is especially true for slow drives and network filesystems. @section Building the Ada compiler In order to build GNAT, the Ada compiler, you need a working GNAT compiler (GNAT version 3.14 or later, or GCC version 3.1 or later), including GNAT tools such as @command{gnatmake} and @command{gnatlink}, since the Ada front end is written in Ada (with some GNAT-specific extensions), and GNU make. @command{configure} does not test whether the GNAT installation works and has a sufficiently recent version; if too old a GNAT version is installed, the build will fail unless @option{--enable-languages} is used to disable building the Ada front end. @section Building with profile feedback It is possible to use profile feedback to optimize the compiler itself. This should result in a faster compiler binary. Experiments done on x86 using gcc 3.3 showed approximately 7 percent speedup on compiling C programs. To bootstrap compiler with profile feedback, use @code{make profiledbootstrap}. When @samp{make profiledbootstrap} is run, it will first build a @code{stage1} compiler. This compiler is used to build a @code{stageprofile} compiler instrumented to collect execution counts of instruction and branch probabilities. Then runtime libraries are compiled with profile collected. Finally a @code{stagefeedback} compiler is built using the information collected. Unlike @samp{make bootstrap} several additional restrictions apply. The compiler used to build @code{stage1} needs to support a 64-bit integral type. It is recommended to only use GCC for this. Also parallel make is currently not supported since collisions in profile collecting may occur. @html
@end html @ifhtml @uref{./index.html,,Return to the GCC Installation page} @end ifhtml @end ifset @c ***Testing***************************************************************** @ifnothtml @comment node-name, next, previous, up @node Testing, Final install, Building, Installing GCC @end ifnothtml @ifset testhtml @ifnothtml @chapter Installing GCC: Testing @end ifnothtml @cindex Testing @cindex Installing GCC: Testing @cindex Testsuite Before you install GCC, we encourage you to run the testsuites and to compare your results with results from a similar configuration that have been submitted to the @uref{http://gcc.gnu.org/ml/gcc-testresults/,,gcc-testresults mailing list}. Some of these archived results are linked from the build status lists at @uref{http://gcc.gnu.org/buildstat.html}, although not everyone who reports a successful build runs the testsuites and submits the results. This step is optional and may require you to download additional software, but it can give you confidence in your new GCC installation or point out problems before you install and start using your new GCC@. First, you must have @uref{download.html,,downloaded the testsuites}. These are part of the full distribution, but if you downloaded the ``core'' compiler plus any front ends, you must download the testsuites separately. Second, you must have the testing tools installed. This includes @uref{http://www.gnu.org/software/dejagnu/,,DejaGnu} 1.4.4 and later, Tcl, and Expect; the DejaGnu site has links to these. If the directories where @command{runtest} and @command{expect} were installed are not in the @env{PATH}, you may need to set the following environment variables appropriately, as in the following example (which assumes that DejaGnu has been installed under @file{/usr/local}): @smallexample TCL_LIBRARY = /usr/local/share/tcl8.0 DEJAGNULIBS = /usr/local/share/dejagnu @end smallexample (On systems such as Cygwin, these paths are required to be actual paths, not mounts or links; presumably this is due to some lack of portability in the DejaGnu code.) Finally, you can run the testsuite (which may take a long time): @smallexample cd @var{objdir}; make -k check @end smallexample This will test various components of GCC, such as compiler front ends and runtime libraries. While running the testsuite, DejaGnu might emit some harmless messages resembling @samp{WARNING: Couldn't find the global config file.} or @samp{WARNING: Couldn't find tool init file} that can be ignored. @section How can you run the testsuite on selected tests? In order to run sets of tests selectively, there are targets @samp{make check-gcc} and @samp{make check-g++} in the @file{gcc} subdirectory of the object directory. You can also just run @samp{make check} in a subdirectory of the object directory. A more selective way to just run all @command{gcc} execute tests in the testsuite is to use @smallexample make check-gcc RUNTESTFLAGS="execute.exp @var{other-options}" @end smallexample Likewise, in order to run only the @command{g++} ``old-deja'' tests in the testsuite with filenames matching @samp{9805*}, you would use @smallexample make check-g++ RUNTESTFLAGS="old-deja.exp=9805* @var{other-options}" @end smallexample The @file{*.exp} files are located in the testsuite directories of the GCC source, the most important ones being @file{compile.exp}, @file{execute.exp}, @file{dg.exp} and @file{old-deja.exp}. To get a list of the possible @file{*.exp} files, pipe the output of @samp{make check} into a file and look at the @samp{Running @dots{} .exp} lines. @section Passing options and running multiple testsuites You can pass multiple options to the testsuite using the @samp{--target_board} option of DejaGNU, either passed as part of @samp{RUNTESTFLAGS}, or directly to @command{runtest} if you prefer to work outside the makefiles. For example, @smallexample make check-g++ RUNTESTFLAGS="--target_board=unix/-O3/-fno-strength-reduce" @end smallexample will run the standard @command{g++} testsuites (``unix'' is the target name for a standard native testsuite situation), passing @samp{-O3 -fno-strength-reduce} to the compiler on every test, i.e., slashes separate options. You can run the testsuites multiple times using combinations of options with a syntax similar to the brace expansion of popular shells: @smallexample @dots{}"--target_board=arm-sim/@{-mhard-float,-msoft-float@}@{-O1,-O2,-O3,@}" @end smallexample (Note the empty option caused by the trailing comma in the final group.) The following will run each testsuite eight times using the @samp{arm-sim} target, as if you had specified all possible combinations yourself: @smallexample --target_board=arm-sim/-mhard-float/-O1 --target_board=arm-sim/-mhard-float/-O2 --target_board=arm-sim/-mhard-float/-O3 --target_board=arm-sim/-mhard-float --target_board=arm-sim/-msoft-float/-O1 --target_board=arm-sim/-msoft-float/-O2 --target_board=arm-sim/-msoft-float/-O3 --target_board=arm-sim/-msoft-float @end smallexample They can be combined as many times as you wish, in arbitrary ways. This list: @smallexample @dots{}"--target_board=unix/-Wextra@{-O3,-fno-strength-reduce@}@{-fomit-frame-pointer,@}" @end smallexample will generate four combinations, all involving @samp{-Wextra}. The disadvantage to this method is that the testsuites are run in serial, which is a waste on multiprocessor systems. For users with GNU Make and a shell which performs brace expansion, you can run the testsuites in parallel by having the shell perform the combinations and @command{make} do the parallel runs. Instead of using @samp{--target_board}, use a special makefile target: @smallexample make -j@var{N} check-@var{testsuite}//@var{test-target}/@var{option1}/@var{option2}/@dots{} @end smallexample For example, @smallexample make -j3 check-gcc//sh-hms-sim/@{-m1,-m2,-m3,-m3e,-m4@}/@{,-nofpu@} @end smallexample will run three concurrent ``make-gcc'' testsuites, eventually testing all ten combinations as described above. Note that this is currently only supported in the @file{gcc} subdirectory. (To see how this works, try typing @command{echo} before the example given here.) @section Additional testing for Java Class Libraries The Java runtime tests can be executed via @samp{make check} in the @file{@var{target}/libjava/testsuite} directory in the build tree. The @uref{http://sources.redhat.com/mauve/,,Mauve Project} provides a suite of tests for the Java Class Libraries. This suite can be run as part of libgcj testing by placing the Mauve tree within the libjava testsuite at @file{libjava/testsuite/libjava.mauve/mauve}, or by specifying the location of that tree when invoking @samp{make}, as in @samp{make MAUVEDIR=~/mauve check}. @uref{http://sources.redhat.com/mauve/,,Jacks} is a free testsuite that tests Java compiler front ends. This suite can be run as part of libgcj testing by placing the Jacks tree within the libjava testsuite at @file{libjava/testsuite/libjava.jacks/jacks}. @section How to interpret test results The result of running the testsuite are various @file{*.sum} and @file{*.log} files in the testsuite subdirectories. The @file{*.log} files contain a detailed log of the compiler invocations and the corresponding results, the @file{*.sum} files summarize the results. These summaries contain status codes for all tests: @itemize @bullet @item PASS: the test passed as expected @item XPASS: the test unexpectedly passed @item FAIL: the test unexpectedly failed @item XFAIL: the test failed as expected @item UNSUPPORTED: the test is not supported on this platform @item ERROR: the testsuite detected an error @item WARNING: the testsuite detected a possible problem @end itemize It is normal for some tests to report unexpected failures. At the current time the testing harness does not allow fine grained control over whether or not a test is expected to fail. This problem should be fixed in future releases. @section Submitting test results If you want to report the results to the GCC project, use the @file{contrib/test_summary} shell script. Start it in the @var{objdir} with @smallexample @var{srcdir}/contrib/test_summary -p your_commentary.txt \ -m gcc-testresults@@gcc.gnu.org |sh @end smallexample This script uses the @command{Mail} program to send the results, so make sure it is in your @env{PATH}. The file @file{your_commentary.txt} is prepended to the testsuite summary and should contain any special remarks you have on your results or your build environment. Please do not edit the testsuite result block or the subject line, as these messages may be automatically processed. @html
@end html @ifhtml @uref{./index.html,,Return to the GCC Installation page} @end ifhtml @end ifset @c ***Final install*********************************************************** @ifnothtml @comment node-name, next, previous, up @node Final install, , Testing, Installing GCC @end ifnothtml @ifset finalinstallhtml @ifnothtml @chapter Installing GCC: Final installation @end ifnothtml Now that GCC has been built (and optionally tested), you can install it with @smallexample cd @var{objdir}; make install @end smallexample We strongly recommend to install into a target directory where there is no previous version of GCC present. That step completes the installation of GCC; user level binaries can be found in @file{@var{prefix}/bin} where @var{prefix} is the value you specified with the @option{--prefix} to configure (or @file{/usr/local} by default). (If you specified @option{--bindir}, that directory will be used instead; otherwise, if you specified @option{--exec-prefix}, @file{@var{exec-prefix}/bin} will be used.) Headers for the C++ and Java libraries are installed in @file{@var{prefix}/include}; libraries in @file{@var{libdir}} (normally @file{@var{prefix}/lib}); internal parts of the compiler in @file{@var{libdir}/gcc} and @file{@var{libexecdir}/gcc}; documentation in info format in @file{@var{infodir}} (normally @file{@var{prefix}/info}). When installing cross-compilers, GCC's executables are not only installed into @file{@var{bindir}}, that is, @file{@var{exec-prefix}/bin}, but additionally into @file{@var{exec-prefix}/@var{target-alias}/bin}, if that directory exists. Typically, such @dfn{tooldirs} hold target-specific binutils, including assembler and linker. Installation into a temporary staging area or into a @command{chroot} jail can be achieved with the command @smallexample make DESTDIR=@var{path-to-rootdir} install @end smallexample @noindent where @var{path-to-rootdir} is the absolute path of a directory relative to which all installation paths will be interpreted. Note that the directory specified by @code{DESTDIR} need not exist yet; it will be created if necessary. There is a subtle point with tooldirs and @code{DESTDIR}: If you relocate a cross-compiler installation with e.g.@: @samp{DESTDIR=@var{rootdir}}, then the directory @file{@var{rootdir}/@var{exec-prefix}/@var{target-alias}/bin} will be filled with duplicated GCC executables only if it already exists, it will not be created otherwise. This is regarded as a feature, not as a bug, because it gives slightly more control to the packagers using the @code{DESTDIR} feature. If you built a released version of GCC using @samp{make bootstrap} then please quickly review the build status page for your release, available from @uref{http://gcc.gnu.org/buildstat.html}. If your system is not listed for the version of GCC that you built, send a note to @email{gcc@@gcc.gnu.org} indicating that you successfully built and installed GCC@. Include the following information: @itemize @bullet @item Output from running @file{@var{srcdir}/config.guess}. Do not send that file itself, just the one-line output from running it. @item The output of @samp{gcc -v} for your newly installed @command{gcc}. This tells us which version of GCC you built and the options you passed to configure. @item Whether you enabled all languages or a subset of them. If you used a full distribution then this information is part of the configure options in the output of @samp{gcc -v}, but if you downloaded the ``core'' compiler plus additional front ends then it isn't apparent which ones you built unless you tell us about it. @item If the build was for GNU/Linux, also include: @itemize @bullet @item The distribution name and version (e.g., Red Hat 7.1 or Debian 2.2.3); this information should be available from @file{/etc/issue}. @item The version of the Linux kernel, available from @samp{uname --version} or @samp{uname -a}. @item The version of glibc you used; for RPM-based systems like Red Hat, Mandrake, and SuSE type @samp{rpm -q glibc} to get the glibc version, and on systems like Debian and Progeny use @samp{dpkg -l libc6}. @end itemize For other systems, you can include similar information if you think it is relevant. @item Any other information that you think would be useful to people building GCC on the same configuration. The new entry in the build status list will include a link to the archived copy of your message. @end itemize We'd also like to know if the @ifnothtml @ref{Specific, host/target specific installation notes} @end ifnothtml @ifhtml @uref{specific.html,,host/target specific installation notes} @end ifhtml didn't include your host/target information or if that information is incomplete or out of date. Send a note to @email{gcc@@gcc.gnu.org} detailing how the information should be changed. If you find a bug, please report it following the @uref{../bugs.html,,bug reporting guidelines}. If you want to print the GCC manuals, do @samp{cd @var{objdir}; make dvi}. You will need to have @command{texi2dvi} (version at least 4.2) and @TeX{} installed. This creates a number of @file{.dvi} files in subdirectories of @file{@var{objdir}}; these may be converted for printing with programs such as @command{dvips}. You can also @uref{http://www.gnu.org/order/order.html,,buy printed manuals from the Free Software Foundation}, though such manuals may not be for the most recent version of GCC@. If you would like to generate online HTML documentation, do @samp{cd @var{objdir}; make html} and HTML will be generated for the gcc manuals in @file{@var{objdir}/gcc/HTML}. @html
@end html @ifhtml @uref{./index.html,,Return to the GCC Installation page} @end ifhtml @end ifset @c ***Binaries**************************************************************** @ifnothtml @comment node-name, next, previous, up @node Binaries, Specific, Installing GCC, Top @end ifnothtml @ifset binarieshtml @ifnothtml @chapter Installing GCC: Binaries @end ifnothtml @cindex Binaries @cindex Installing GCC: Binaries We are often asked about pre-compiled versions of GCC@. While we cannot provide these for all platforms, below you'll find links to binaries for various platforms where creating them by yourself is not easy due to various reasons. Please note that we did not create these binaries, nor do we support them. If you have any problems installing them, please contact their makers. @itemize @item AIX: @itemize @item @uref{http://www.bullfreeware.com,,Bull's Freeware and Shareware Archive for AIX}; @item @uref{http://aixpdslib.seas.ucla.edu,,UCLA Software Library for AIX}. @end itemize @item DOS---@uref{http://www.delorie.com/djgpp/,,DJGPP}. @item Renesas H8/300[HS]---@uref{http://h8300-hms.sourceforge.net/,,GNU Development Tools for the Renesas H8/300[HS] Series}. @item HP-UX: @itemize @item @uref{http://hpux.cs.utah.edu/,,HP-UX Porting Center}; @item @uref{ftp://sunsite.informatik.rwth-aachen.de/pub/packages/gcc_hpux/,,Binaries for HP-UX 11.00 at Aachen University of Technology}. @end itemize @item Motorola 68HC11/68HC12---@uref{http://www.gnu-m68hc11.org,,GNU Development Tools for the Motorola 68HC11/68HC12}. @item @uref{http://www.sco.com/skunkware/devtools/index.html#gcc,,SCO OpenServer/Unixware}. @item Solaris 2 (SPARC, Intel)---@uref{http://www.sunfreeware.com/,,Sunfreeware}. @item SGI---@uref{http://freeware.sgi.com/,,SGI Freeware}. @item Microsoft Windows: @itemize @item The @uref{http://sources.redhat.com/cygwin/,,Cygwin} project; @item The @uref{http://www.mingw.org/,,MinGW} project. @end itemize @item @uref{ftp://ftp.thewrittenword.com/packages/by-name/,,The Written Word} offers binaries for AIX 4.3.2. IRIX 6.5, Digital UNIX 4.0D and 5.1, GNU/Linux (i386), HP-UX 10.20, 11.00, and 11.11, and Solaris/SPARC 2.5.1, 2.6, 7, 8, and 9. @item @uref{http://www.openpkg.org/,,OpenPKG} offers binaries for quite a number of platforms. @item The @uref{http://gcc.gnu.org/wiki/GFortranBinaries,,GFortran Wiki} has links to gfortran binaries for several platforms. @end itemize In addition to those specific offerings, you can get a binary distribution CD-ROM from the @uref{http://www.gnu.org/order/order.html,,Free Software Foundation}. It contains binaries for a number of platforms, and includes not only GCC, but other stuff as well. The current CD does not contain the latest version of GCC, but it should allow bootstrapping the compiler. An updated version of that disk is in the works. @html
@end html @ifhtml @uref{./index.html,,Return to the GCC Installation page} @end ifhtml @end ifset @c ***Specific**************************************************************** @ifnothtml @comment node-name, next, previous, up @node Specific, Old, Binaries, Top @end ifnothtml @ifset specifichtml @ifnothtml @chapter Host/target specific installation notes for GCC @end ifnothtml @cindex Specific @cindex Specific installation notes @cindex Target specific installation @cindex Host specific installation @cindex Target specific installation notes Please read this document carefully @emph{before} installing the GNU Compiler Collection on your machine. @ifhtml @itemize @item @uref{#alpha-x-x,,alpha*-*-*} @item @uref{#alpha-dec-osf,,alpha*-dec-osf*} @item @uref{#alphaev5-cray-unicosmk,,alphaev5-cray-unicosmk*} @item @uref{#arc-x-elf,,arc-*-elf} @item @uref{#arm-x-elf,,arm-*-elf} @uref{#arm-x-coff,,arm-*-coff} @uref{#arm-x-aout,,arm-*-aout} @item @uref{#xscale-x-x,,xscale-*-*} @item @uref{#avr,,avr} @item @uref{#bfin,,Blackfin} @item @uref{#c4x,,c4x} @item @uref{#dos,,DOS} @item @uref{#x-x-freebsd,,*-*-freebsd*} @item @uref{#h8300-hms,,h8300-hms} @item @uref{#hppa-hp-hpux,,hppa*-hp-hpux*} @item @uref{#hppa-hp-hpux10,,hppa*-hp-hpux10} @item @uref{#hppa-hp-hpux11,,hppa*-hp-hpux11} @item @uref{#x-x-linux-gnu,,*-*-linux-gnu} @item @uref{#ix86-x-linuxaout,,i?86-*-linux*aout} @item @uref{#ix86-x-linux,,i?86-*-linux*} @item @uref{#ix86-x-sco32v5,,i?86-*-sco3.2v5*} @item @uref{#ix86-x-solaris210,,i?86-*-solaris2.10} @item @uref{#ix86-x-udk,,i?86-*-udk} @item @uref{#ia64-x-linux,,ia64-*-linux} @item @uref{#ia64-x-hpux,,ia64-*-hpux*} @item @uref{#x-ibm-aix,,*-ibm-aix*} @item @uref{#iq2000-x-elf,,iq2000-*-elf} @item @uref{#m32c-x-elf,,m32c-*-elf} @item @uref{#m32r-x-elf,,m32r-*-elf} @item @uref{#m6811-elf,,m6811-elf} @item @uref{#m6812-elf,,m6812-elf} @item @uref{#m68k-hp-hpux,,m68k-hp-hpux} @item @uref{#mips-x-x,,mips-*-*} @item @uref{#mips-sgi-irix5,,mips-sgi-irix5} @item @uref{#mips-sgi-irix6,,mips-sgi-irix6} @item @uref{#powerpc-x-x,,powerpc*-*-*, powerpc-*-sysv4} @item @uref{#powerpc-x-darwin,,powerpc-*-darwin*} @item @uref{#powerpc-x-elf,,powerpc-*-elf, powerpc-*-sysv4} @item @uref{#powerpc-x-linux-gnu,,powerpc*-*-linux-gnu*} @item @uref{#powerpc-x-netbsd,,powerpc-*-netbsd*} @item @uref{#powerpc-x-eabisim,,powerpc-*-eabisim} @item @uref{#powerpc-x-eabi,,powerpc-*-eabi} @item @uref{#powerpcle-x-elf,,powerpcle-*-elf, powerpcle-*-sysv4} @item @uref{#powerpcle-x-eabisim,,powerpcle-*-eabisim} @item @uref{#powerpcle-x-eabi,,powerpcle-*-eabi} @item @uref{#s390-x-linux,,s390-*-linux*} @item @uref{#s390x-x-linux,,s390x-*-linux*} @item @uref{#s390x-ibm-tpf,,s390x-ibm-tpf*} @item @uref{#x-x-solaris2,,*-*-solaris2*} @item @uref{#sparc-sun-solaris2,,sparc-sun-solaris2*} @item @uref{#sparc-sun-solaris27,,sparc-sun-solaris2.7} @item @uref{#sparc-x-linux,,sparc-*-linux*} @item @uref{#sparc64-x-solaris2,,sparc64-*-solaris2*} @item @uref{#sparcv9-x-solaris2,,sparcv9-*-solaris2*} @item @uref{#x-x-sysv,,*-*-sysv*} @item @uref{#vax-dec-ultrix,,vax-dec-ultrix} @item @uref{#x-x-vxworks,,*-*-vxworks*} @item @uref{#x86-64-x-x,,x86_64-*-*, amd64-*-*} @item @uref{#xtensa-x-elf,,xtensa-*-elf} @item @uref{#xtensa-x-linux,,xtensa-*-linux*} @item @uref{#windows,,Microsoft Windows} @item @uref{#os2,,OS/2} @item @uref{#older,,Older systems} @end itemize @itemize @item @uref{#elf,,all ELF targets} (SVR4, Solaris 2, etc.) @end itemize @end ifhtml @html
@end html @ifhtml @uref{./index.html,,Return to the GCC Installation page} @end ifhtml @end ifset @c ***Old documentation****************************************************** @ifset oldhtml @include install-old.texi @html
@end html @ifhtml @uref{./index.html,,Return to the GCC Installation page} @end ifhtml @end ifset @c ***GFDL******************************************************************** @ifset gfdlhtml @include fdl.texi @html
@end html @ifhtml @uref{./index.html,,Return to the GCC Installation page} @end ifhtml @end ifset @c *************************************************************************** @c Part 6 The End of the Document @ifinfo @comment node-name, next, previous, up @node Concept Index, , GNU Free Documentation License, Top @end ifinfo @ifinfo @unnumbered Concept Index @printindex cp @contents @end ifinfo @bye