home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / programm / language / gcc222.lha / info / gcc.info-3 (.txt) < prev    next >
GNU Info File  |  1992-07-19  |  50KB  |  914 lines

  1. This is Info file gcc.info, produced by Makeinfo-1.47 from the input
  2. file gcc.texi.
  3.    This file documents the use and the internals of the GNU compiler.
  4.    Copyright (C) 1988, 1989, 1992 Free Software Foundation, Inc.
  5.    Permission is granted to make and distribute verbatim copies of this
  6. manual provided the copyright notice and this permission notice are
  7. preserved on all copies.
  8.    Permission is granted to copy and distribute modified versions of
  9. this manual under the conditions for verbatim copying, provided also
  10. that the sections entitled "GNU General Public License" and "Boycott"
  11. are included exactly as in the original, and provided that the entire
  12. resulting derived work is distributed under the terms of a permission
  13. notice identical to this one.
  14.    Permission is granted to copy and distribute translations of this
  15. manual into another language, under the above conditions for modified
  16. versions, except that the sections entitled "GNU General Public
  17. License" and "Boycott", and this permission notice, may be included in
  18. translations approved by the Free Software Foundation instead of in the
  19. original English.
  20. File: gcc.info,  Node: M88K Options,  Next: RS/6000 Options,  Prev: AMD29K Options,  Up: Submodel Options
  21. M88K Options
  22. ------------
  23.    These `-m' options are defined for Motorola 88K architectures:
  24. `-m88000'
  25.      Generate code that works well on both the m88100 and the m88110.
  26. `-m88100'
  27.      Generate code tha Generate code that works best for the m88100,
  28.      but that also runs on the m88110.
  29. `-m88110'
  30.      Generate code that works best for the m88110, and may not run on
  31.      the m88100.
  32. `-midentify-revision'
  33.      Include an `ident' directive in the assembler output recording the
  34.      source file name, compiler name and version, timestamp, and
  35.      compilation flags used.
  36. `-mno-underscores'
  37.      In assembler output, emit symbol names without adding an underscore
  38.      character at the beginning of each name.  The default is to use an
  39.      underscore as prefix on each name.
  40. `-mocs-debug-info'
  41. `-mno-ocs-debug-info'
  42.      Include (or omit) additional debugging information (about
  43.      registers used in each stack frame) as specified in the 88open
  44.      Object Compatibility Standard, "OCS".  This extra information
  45.      allows debugging of code that has had the frame pointer
  46.      eliminated.  The default for DG/UX, SVr4, and Delta 88 SVr3.2 is
  47.      to include this information; other 88k configurations omit this
  48.      information by default.
  49. `-mocs-frame-position'
  50.      When emitting COFF debugging information for automatic variables
  51.      and parameters stored on the stack, use the offset from the
  52.      canonical frame address, which is the stack pointer (register 31)
  53.      on entry to the function.  The DG/UX, SVr4, Delta88 SVr3.2, and
  54.      BCS configurations use `-mocs-frame-position'; other 88k
  55.      configurations have the default `-mno-ocs-frame-position'.
  56. `-mno-ocs-frame-position'
  57.      When emitting COFF debugging information for automatic variables
  58.      and parameters stored on the stack, use the offset from the frame
  59.      pointer register (register 30).  When this option is in effect,
  60.      the frame pointer is not eliminated when debugging information is
  61.      selected by the -g switch.
  62. `-moptimize-arg-area'
  63. `-mno-optimize-arg-area'
  64.      Control how to store function arguments in stack frames.
  65.      `-moptimize-arg-area' saves space, but was ruled illegal by 88open.
  66.      `-mno-optimize-arg-area' conforms to the 88open standards.  By
  67.      default GNU CC does not optimize the argument area.
  68. `-mshort-data-NUM'
  69.      Generate smaller data references by making them relative to `r0',
  70.      which allows loading a value using a single instruction (rather
  71.      than the usual two).  You control which data references are
  72.      affected by specifying NUM with this option.  For example, if you
  73.      specify `-mshort-data-512', then the data references affected are
  74.      those involving displacements of less than 512 bytes.
  75.      `-mshort-data-NUM' is not effective for NUM greater than 64K.
  76. `-msvr4'
  77. `-msvr3'
  78.      Turn on (`-msvr4') or off (`-msvr3') compiler extensions related
  79.      to System V release 4 (SVr4).  This controls the following:
  80.        1. Which variant of the assembler syntax to emit (which you can
  81.           select independently using `-mversion-03.00').
  82.        2. `-msvr4' makes the C preprocessor recognize `#pragma weak'
  83.           that is used on System V release 4.
  84.        3. `-msvr4' makes GNU CC issue additional declaration directives
  85.           used in SVr4.
  86.      `-msvr3' is the default for all m88K configurations except the
  87.      SVr4 configuration.
  88. `-mversion-03.00'
  89.      In the DG/UX configuration, there are two flavors of SVr4.  This
  90.      option modifies `-msvr4' to select whether the hybrid-COFF or
  91.      real-ELF flavor is used.  All other configurations ignore this
  92.      option.
  93. `-mno-check-zero-division'
  94. `-mcheck-zero-division'
  95.      Early models of the 88K architecture had problems with division by
  96.      zero; in particular, many of them didn't trap.  Use these options
  97.      to avoid including (or to include explicitly) additional code to
  98.      detect division by zero and signal an exception.  All GNU CC
  99.      configurations for the 88K use `-mcheck-zero-division' by default.
  100. `-muse-div-instruction'
  101.      Do not emit code to check both the divisor and dividend when doing
  102.      signed integer division to see if either is negative, and adjust
  103.      the signs so the divide is done using non-negative numbers. 
  104.      Instead, rely on the operating system to calculate the correct
  105.      value when the `div' instruction traps.  This results in different
  106.      behavior when the most negative number is divided by -1, but is
  107.      useful when most or all signed integer divisions are done with
  108.      positive numbers.
  109. `-mtrap-large-shift'
  110. `-mhandle-large-shift'
  111.      Include code to detect bit-shifts of more than 31 bits;
  112.      respectively, trap such shifts or emit code to handle them
  113.      properly.  By default GNU CC makes no special provision for large
  114.      bit shifts.
  115. `-mwarn-passed-structs'
  116.      Warn when a function passes a struct as an argument or result.
  117.      Structure-passing conventions have changed during the evolution of
  118.      the C language, and are often the source of portability problems. 
  119.      By default, GNU CC issues no such warning.
  120. File: gcc.info,  Node: RS/6000 Options,  Next: RT Options,  Prev: M88K Options,  Up: Submodel Options
  121. IBM RS/6000 Options
  122. -------------------
  123.    Only one pair of `-m' options is defined for the IBM RS/6000:
  124. `-mfp-in-toc'
  125. `-mno-fp-in-toc'
  126.      Control whether or not floating-point constants go in the Table of
  127.      Contents (TOC), a table of all global variable and function
  128.      addresses.  By default GNU CC puts floating-point constants there;
  129.      if the TOC overflows, `-mno-fp-in-toc' will reduce the size of the
  130.      TOC, which may avoid the overflow.
  131. File: gcc.info,  Node: RT Options,  Next: MIPS Options,  Prev: RS/6000 Options,  Up: Submodel Options
  132. IBM RT Options
  133. --------------
  134.    These `-m' options are defined for the IBM RT PC:
  135. `-min-line-mul'
  136.      Use an in-line code sequence for integer multiplies.  This is the
  137.      default.
  138. `-mcall-lib-mul'
  139.      Call `lmul$$' for integer multiples.
  140. `-mfull-fp-blocks'
  141.      Generate full-size floating point data blocks, including the
  142.      minimum amount of scratch space recommended by IBM.  This is the
  143.      default.
  144. `-mminimum-fp-blocks'
  145.      Do not include extra scratch space in floating point data blocks. 
  146.      This results in smaller code, but slower execution, since scratch
  147.      space must be allocated dynamically.
  148. `-mfp-arg-in-fpregs'
  149.      Use a calling sequence incompatible with the IBM calling
  150.      convention in which floating point arguments are passed in
  151.      floating point registers. Note that `varargs.h' and `stdargs.h'
  152.      will not work with floating point operands if this option is
  153.      specified.
  154. `-mfp-arg-in-gregs'
  155.      Use the normal calling convention for floating point arguments. 
  156.      This is the default.
  157. `-mhc-struct-return'
  158.      Return structures of more than one word in memory, rather than in a
  159.      register.  This provides compatibility with the MetaWare HighC (hc)
  160.      compiler.  Use `-fpcc-struct-return' for compatibility with the
  161.      Portable C Compiler (pcc).
  162. `-mnohc-struct-return'
  163.      Return some structures of more than one word in registers, when
  164.      convenient.  This is the default.  For compatibility with the
  165.      IBM-supplied compilers, use either `-fpcc-struct-return' or
  166.      `-mhc-struct-return'.
  167. File: gcc.info,  Node: MIPS Options,  Next: i386 Options,  Prev: RT Options,  Up: Submodel Options
  168. MIPS Options
  169. ------------
  170.    These `-m' options are defined for the MIPS family of computers:
  171. `-mcpu=CPU TYPE'
  172.      Assume the defaults for the machine type CPU TYPE when scheduling
  173.      instructions.  The default CPU TYPE is `default', which picks the
  174.      longest cycles times for any of the machines, in order that the
  175.      code run at reasonable rates on all MIPS cpu's.  Other choices for
  176.      CPU TYPE are `r2000', `r3000', `r4000', and `r6000'.  While
  177.      picking a specific CPU TYPE will schedule things appropriately for
  178.      that particular chip, the compiler will not generate any code that
  179.      does not meet level 1 of the MIPS ISA (instruction set
  180.      architecture) without the `-mips2' or `-mips3' switches being used.
  181. `-mips2'
  182.      Issue instructions from level 2 of the MIPS ISA (branch likely,
  183.      square root instructions).  The `-mcpu=r4000' or `-mcpu=r6000'
  184.      switch must be used in conjunction with `-mips2'.
  185. `-mips3'
  186.      Issue instructions from level 3 of the MIPS ISA (64 bit
  187.      instructions). You must use the `-mcpu=r4000' switch along with
  188.      `-mips3'.
  189. `-mint64'
  190. `-mlong64'
  191. `-mlonglong128'
  192.      These options don't work at present.
  193. `-mmips-as'
  194.      Generate code for the MIPS assembler, and invoke `mips-tfile' to
  195.      add normal debug information.  This is the default for all
  196.      platforms except for the OSF/1 reference platform, using the
  197.      OSF/rose object format.  If the either of the `-gstabs' or
  198.      `-gstabs+' switches are used, the `mips-tfile' program will
  199.      encapsulate the stabs within MIPS ECOFF.
  200. `-mgas'
  201.      Generate code for the GNU assembler.  This is the default on the
  202.      OSF/1 reference platform, using the OSF/rose object format.
  203. `-mrnames'
  204. `-mno-rnames'
  205.      The `-mrnames' switch says to output code using the MIPS software
  206.      names for the registers, instead of the hardware names (ie, A0
  207.      instead of $4).  The GNU assembler does not support the `-mrnames'
  208.      switch, and the MIPS assembler will be instructed to run the MIPS
  209.      C preprocessor over the source file.  The `-mno-rnames' switch is
  210.      default.
  211. `-mgpopt'
  212. `-mno-gpopt'
  213.      The `-mgpopt' switch says to write all of the data declarations
  214.      before the instructions in the text section, this allows the MIPS
  215.      assembler to generate one word memory references instead of using
  216.      two words for short global or static data items.  This is on by
  217.      default if optimization is selected.
  218. `-mstats'
  219. `-mno-stats'
  220.      For each non-inline function processed, the `-mstats' switch
  221.      causes the compiler to emit one line to the standard error file to
  222.      print statistics about the program (number of registers saved,
  223.      stack size, etc.).
  224. `-mmemcpy'
  225. `-mno-memcpy'
  226.      The `-mmemcpy' switch makes all block moves call the appropriate
  227.      string function (`memcpy' or `bcopy') instead of possibly
  228.      generating inline code.
  229. `-mmips-tfile'
  230. `-mno-mips-tfile'
  231.      The `-mno-mips-tfile' switch causes the compiler not postprocess
  232.      the object file with the `mips-tfile' program, after the MIPS
  233.      assembler has generated it to add debug support.  If `mips-tfile'
  234.      is not run, then no local variables will be available to the
  235.      debugger.  In addition, `stage2' and `stage3' objects will have
  236.      the temporary file names passed to the assembler embedded in the
  237.      object file, which means the objects will not compare the same. 
  238.      The `-mno-mips-tfile' switch should only be used when there are
  239.      bugs in the `mips-tfile' program that prevents compilation.
  240. `-msoft-float'
  241.      Generate output containing library calls for floating point.
  242.      *Warning:* the requisite libraries are not part of GNU CC.
  243.      Normally the facilities of the machine's usual C compiler are
  244.      used, but this can't be done directly in cross-compilation.  You
  245.      must make your own arrangements to provide suitable library
  246.      functions for cross-compilation.
  247. `-mhard-float'
  248.      Generate output containing floating point instructions.  This is
  249.      the default if you use the unmodified sources.
  250. `-mfp64'
  251.      Assume that the FR bit in the status word is on, and that there
  252.      are 32 64-bit floating point registers, instead of 32 32-bit
  253.      floating point registers.  You must also specify the `-mcpu=r4000'
  254.      and `-mips3' switches.
  255. `-mfp32'
  256.      Assume that there are 32 32-bit floating point registers.  This is
  257.      the default.
  258. `-mabicalls'
  259. `-mno-abicalls'
  260.      Emit the `.abicalls', `.cpload', and `.cprestore' pseudo
  261.      operations that some System V.4 ports use for position independent
  262.      code.
  263. `-mhalf-pic'
  264. `-mno-half-pic'
  265.      Put pointers to extern references into the data section and load
  266.      them up, rather than put the references in the text section. 
  267.      These options do not work at present.
  268. `-G NUM'
  269.      Put global and static items less than or equal to NUM bytes into
  270.      the small data or bss sections instead of the normal data or bss
  271.      section.  This allows the assembler to emit one word memory
  272.      reference instructions based on the global pointer (GP or $28),
  273.      instead of the normal two words used.  By default, NUM is 8 when
  274.      the MIPS assembler is used, and 0 when the GNU assembler is used. 
  275.      The `-G NUM' switch is also passed to the assembler and linker.
  276.      All modules should be compiled with the same `-G NUM' value.
  277. `-nocpp'
  278.      Tell the MIPS assembler to not run it's preprocessor over user
  279.      assembler files (with a `.s' suffix) when assembling them.
  280.    These options are defined by the macro `TARGET_SWITCHES' in the
  281. machine description.  The default for the options is also defined by
  282. that macro, which enables you to change the defaults.
  283. File: gcc.info,  Node: i386 Options,  Prev: MIPS Options,  Up: Submodel Options
  284. Intel 386 Options
  285. -----------------
  286.    These `-m' options are defined for the i386 family of computers:
  287. `-m486'
  288. `-mno486'
  289.      Control whether or not code is optimized for a 486 instead of an
  290.      386.  Code generated for an 486 will run on a 386 and vice versa.
  291. `-msoft-float'
  292.      Generate output containing library calls for floating point.
  293.      *Warning:* the requisite libraries are not part of GNU CC.
  294.      Normally the facilities of the machine's usual C compiler are
  295.      used, but this can't be done directly in cross-compilation.  You
  296.      must make your own arrangements to provide suitable library
  297.      functions for cross-compilation.
  298.      On machines where a function returnings float point results in the
  299.      80387 register stack, some floating point opcodes may be emitted
  300.      even if `-msoft-float' is used.
  301. File: gcc.info,  Node: Code Gen Options,  Next: Environment Variables,  Prev: Submodel Options,  Up: Invoking GCC
  302. Options for Code Generation Conventions
  303. =======================================
  304.    These machine-independent options control the interface conventions
  305. used in code generation.
  306.    Most of them have both positive and negative forms; the negative form
  307. of `-ffoo' would be `-fno-foo'.  In the table below, only one of the
  308. forms is listed--the one which is not the default.  You can figure out
  309. the other form by either removing `no-' or adding it.
  310. `-fpcc-struct-return'
  311.      Use the same convention for returning `struct' and `union' values
  312.      that is used by the usual C compiler on your system.  This
  313.      convention is less efficient for small structures, and on many
  314.      machines it fails to be reentrant; but it has the advantage of
  315.      allowing intercallability between GNU CC-compiled code and
  316.      PCC-compiled code.
  317. `-fshort-enums'
  318.      Allocate to an `enum' type only as many bytes as it needs for the
  319.      declared range of possible values.  Specifically, the `enum' type
  320.      will be equivalent to the smallest integer type which has enough
  321.      room.
  322. `-fshort-double'
  323.      Use the same size for `double' as for `float'.
  324. `-fshared-data'
  325.      Requests that the data and non-`const' variables of this
  326.      compilation be shared data rather than private data.  The
  327.      distinction makes sense only on certain operating systems, where
  328.      shared data is shared between processes running the same program,
  329.      while private data exists in one copy per process.
  330. `-fno-common'
  331.      Allocate even uninitialized global variables in the bss section of
  332.      the object file, rather than generating them as common blocks. 
  333.      This has the effect that if the same variable is declared (without
  334.      `extern') in two different compilations, you will get an error
  335.      when you link them. The only reason this might be useful is if you
  336.      wish to verify that the program will work on other systems which
  337.      always work this way.
  338. `-fno-ident'
  339.      Ignore the `#ident' directive.
  340. `-fno-gnu-linker'
  341.      Don't output global initializations such as C++ constructors and
  342.      destructors in the form used by the GNU linker (on systems where
  343.      the GNU linker is the standard method of handling them).  Use this
  344.      option when you want to use a "collect" program and a non-GNU
  345.      linker.
  346. `-finhibit-size-directive'
  347.      Don't output a `.size' assembler directive, or anything else that
  348.      would cause trouble if the function is split in the middle, and the
  349.      two halves are placed at locations far apart in memory.  This
  350.      option is used when compiling `crtstuff.c'; you should not need to
  351.      use it for anything else.
  352. `-fverbose-asm'
  353.      Put extra commentary information in the generated assembly code to
  354.      make it more readable.  This option is generally only of use to
  355.      those who actually need to read the generated assembly code
  356.      (perhaps while debugging the compiler itself).
  357. `-fvolatile'
  358.      Consider all memory references through pointers to be volatile.
  359. `-fpic'
  360.      If supported for the target machines, generate position-independent
  361.      code, suitable for use in a shared library.  All addresses will be
  362.      accessed through a global offset table (GOT).  If the GOT size for
  363.      the linked executable exceeds a machine-specific maximum size, you
  364.      will get an error message from the linker indicating that `-fpic'
  365.      does not work; recompile with `-fPIC' instead.  (These maximums
  366.      are 16k on the m88k, 8k on the Sparc, and 32k on the m68k and
  367.      RS/6000.  The 386 has no such limit.)
  368.      Position-independent code requires special support, and therefore
  369.      works only on certain machines.  Code generated for the IBM
  370.      RS/6000 is always position-independent.
  371.      The GNU assembler does not fully support PIC.  Currently, you must
  372.      use some other assembler in order for PIC to work.  We would
  373.      welcome volunteers to upgrade GAS to handle this; the first part
  374.      of the job is to figure out what the assembler must do differently.
  375. `-fPIC'
  376.      If supported for the target machine, emit position-independent
  377.      code, suitable for dynamic linking and avoiding any limit on the
  378.      size of the global offset table.  This option makes a difference
  379.      on the m68k, m88k and the Sparc.
  380.      Position-independent code requires special support, and therefore
  381.      works only on certain machines.
  382. `-ffixed-REG'
  383.      Treat the register named REG as a fixed register; generated code
  384.      should never refer to it (except perhaps as a stack pointer, frame
  385.      pointer or in some other fixed role).
  386.      REG must be the name of a register.  The register names accepted
  387.      are machine-specific and are defined in the `REGISTER_NAMES' macro
  388.      in the machine description macro file.
  389.      This flag does not have a negative form, because it specifies a
  390.      three-way choice.
  391. `-fcall-used-REG'
  392.      Treat the register named REG as an allocatable register that is
  393.      clobbered by function calls.  It may be allocated for temporaries
  394.      or variables that do not live across a call.  Functions compiled
  395.      this way will not save and restore the register REG.
  396.      Use of this flag for a register that has a fixed pervasive role in
  397.      the machine's execution model, such as the stack pointer or frame
  398.      pointer, will produce disastrous results.
  399.      This flag does not have a negative form, because it specifies a
  400.      three-way choice.
  401. `-fcall-saved-REG'
  402.      Treat the register named REG as an allocatable register saved by
  403.      functions.  It may be allocated even for temporaries or variables
  404.      that live across a call.  Functions compiled this way will save
  405.      and restore the register REG if they use it.
  406.      Use of this flag for a register that has a fixed pervasive role in
  407.      the machine's execution model, such as the stack pointer or frame
  408.      pointer, will produce disastrous results.
  409.      A different sort of disaster will result from the use of this flag
  410.      for a register in which function values may be returned.
  411.      This flag does not have a negative form, because it specifies a
  412.      three-way choice.
  413. File: gcc.info,  Node: Environment Variables,  Prev: Code Gen Options,  Up: Invoking GCC
  414. Environment Variables Affecting GNU CC
  415. ======================================
  416.    This section describes several environment variables that affect how
  417. GNU CC operates.  They work by specifying directories or prefixes to use
  418. when searching for various kinds of files.
  419.    Note that you can also specify places to search using options such as
  420. `-B', `-I' and `-L' (*note Directory Options::.).  These take
  421. precedence over places specified using environment variables, which in
  422. turn take precedence over those specified by the configuration of GNU
  423. CC.  *Note Driver::.
  424. `TMPDIR'
  425.      If `TMPDIR' is set, it specifies the directory to use for temporary
  426.      files.  GNU CC uses temporary files to hold the output of one
  427.      stage of compilation which is to be used as input to the next
  428.      stage: for example, the output of the preprocessor, which is the
  429.      input to the compiler proper.
  430. `GCC_EXEC_PREFIX'
  431.      If `GCC_EXEC_PREFIX' is set, it specifies a prefix to use in the
  432.      names of the subprograms executed by the compiler.  No slash is
  433.      added when this prefix is combined with the name of a subprogram,
  434.      but you can specify a prefix that ends with a slash if you wish.
  435.      If GNU CC cannot find the subprogram using the specified prefix, it
  436.      tries looking in the usual places for the subprogram.
  437.      Other prefixes specified with `-B' take precedence over this
  438.      prefix.
  439.      This prefix is also used for finding files such as `crt0.o' that
  440.      are used for linking.
  441.      In addition, the prefix is used in an unusual way in finding the
  442.      directories to search for header files.  For each of the standard
  443.      directories whose name normally begins with
  444.      `/usr/local/lib/gcc-lib' (more precisely, with the value of
  445.      `GCC_INCLUDE_DIR'), GNU CC tries replacing that beginning with the
  446.      specified prefix to produce an alternate directory name.  Thus,
  447.      with `-Bfoo/', GNU CC will search `foo/bar' where it would
  448.      normally search `/usr/local/lib/bar'. These alternate directories
  449.      are searched first; the standard directories come next.
  450. `COMPILER_PATH'
  451.      The value of `COMPILER_PATH' is a colon-separated list of
  452.      directories, much like `PATH'.  GNU CC tries the directories thus
  453.      specified when searching for subprograms, if it can't find the
  454.      subprograms using `GCC_EXEC_PREFIX'.
  455. `LIBRARY_PATH'
  456.      The value of `LIBRARY_PATH' is a colon-separated list of
  457.      directories, much like `PATH'.  GNU CC tries the directories thus
  458.      specified when searching for special linker files, if it can't
  459.      find them using `GCC_EXEC_PREFIX'.  Linking using GNU CC also uses
  460.      these directories when searching for ordinary libraries for the
  461.      `-l' option (but directories specified with `-L' come first).
  462. `C_INCLUDE_PATH'
  463. `CPLUS_INCLUDE_PATH'
  464. `OBJC_INCLUDE_PATH'
  465.      These environment variables pertain to particular languages.  Each
  466.      variable's value is a colon-separated list of directories, much
  467.      like `PATH'.  When GNU CC searches for header files, it tries the
  468.      directories listed in the variable for the language you are using,
  469.      after the directories specified with `-I' but before the standard
  470.      header file directories.
  471. `DEPENDENCIES_OUTPUT'
  472.      If this variable is set, its value specifies how to output
  473.      dependencies for Make based on the header files processed by the
  474.      compiler.  This output looks much like the output from the `-M'
  475.      option (*note Preprocessor Options::.), but it goes to a separate
  476.      file, and is in addition to the usual results of compilation.
  477.      The value of `DEPENDENCIES_OUTPUT' can be just a file name, in
  478.      which case the Make rules are written to that file, guessing the
  479.      target name from the source file name.  Or the value can have the
  480.      form `FILE TARGET', in which case the rules are written to file
  481.      FILE using TARGET as the target name.
  482. File: gcc.info,  Node: Installation,  Next: Extensions,  Prev: Invoking GCC,  Up: Top
  483. Installing GNU CC
  484. *****************
  485.    Here is the procedure for installing GNU CC on a Unix system.
  486. * Menu:
  487. * Other Dir::     Compiling in a separate directory (not where the source is).
  488. * Cross-Compiler::   Building and installing a cross-compiler.
  489. * PA Install::    See below for installation on the HP Precision Architecture.
  490. * Sun Install::   See below for installation on the Sun.
  491. * 3b1 Install::   See below for installation on the 3b1.
  492. * Unos Install::  See below for installation on Unos (from CRDS).
  493. * VMS Install::   See below for installation on VMS.
  494.   1. If you have built GNU CC previously in the same directory for a
  495.      different target machine, do `make distclean' to delete all files
  496.      that might be invalid.
  497.   2. On a System V release 4 system, make sure `/usr/bin' precedes
  498.      `/usr/ucb' in `PATH'.  The `cc' command in `/usr/ucb' uses
  499.      libraries which have bugs.
  500.   3. Specify the host and target machine configurations.  You do this by
  501.      running the file `configure' with appropriate arguments.
  502.      If you are building a compiler to produce code for the machine it
  503.      runs on, specify just one machine type.  Use the `--target'
  504.      option; the host type will default to be the same as the target. 
  505.      (For information on building a cross-compiler, see *Note
  506.      Cross-Compiler::.)  The command looks like this:
  507.           configure --target=sparc-sun-sunos4.1
  508.      A configuration name may be canonical or it may be more or less
  509.      abbreviated.
  510.      A canonical configuration name has three parts, separated by
  511.      dashes. It looks like this: `CPU-COMPANY-SYSTEM'. (The three parts
  512.      may themselves contain dashes; `configure' can figure out which
  513.      dashes serve which purpose.)  For example, `m68k-sun-sunos4.1'
  514.      specifies a Sun 3.
  515.      You can also replace parts of the configuration by nicknames or
  516.      aliases. For example, `sun3' stands for `m68k-sun', so
  517.      `sun3-sunos4.1' is another way to specify a Sun 3.  You can also
  518.      use simply `sun3-sunos', since the version of SunOS is assumed by
  519.      default to be version 4.  `sun3-bsd' also works, since `configure'
  520.      knows that the only BSD variant on a Sun 3 is SunOS.
  521.      You can specify a version number after any of the system types,
  522.      and some of the CPU types.  In most cases, the version is
  523.      irrelevant, and will be ignored.  So you might as well specify the
  524.      version if you know it.
  525.      Here are the possible CPU types:
  526.           a29k, arm, cN, hppa1.0, hppa1.1, i386, i860, i960, m68000,
  527.           m68k, m88k, mips, ns32k, romp, rs6000, sparc, vax, we32k.
  528.      Here are the recognized company names.  As you can see, customary
  529.      abbreviations are used rather than the longer official names.
  530.           alliant, altos, apollo, att, convergent, convex, crds, dec,
  531.           dg, encore, harris, hp, ibm, mips, motorola, ncr, next, ns,
  532.           omron, sequent, sgi, sony, sun, tti, unicom.
  533.      The company name is meaningful only to disambiguate when the rest
  534.      of the information supplied is insufficient.  You can omit it,
  535.      writing just `CPU-SYSTEM', if it is not needed.  For example,
  536.      `vax-ultrix4.2' is equivalent to `vax-dec-ultrix4.2'.
  537.      Here is a list of system types:
  538.           bsd, sysv, mach, minix, genix, ultrix, vms, sco, isc, aix,
  539.           sunos, hpux, unos, luna, dgux, newsos, osfrose, osf, dynix,
  540.           aos, ctix.
  541.      You can omit the system type; then `configure' guesses the
  542.      operating system from the CPU and company.
  543.      You can add a version number to the system type; this may or may
  544.      not make a difference.  For example, you can write `bsd4.3' or
  545.      `bsd4.4' to distinguish versions of BSD.  In practice, the version
  546.      number is most needed for `sysv3' and `sysv4', which are often
  547.      treated differently.
  548.      If you specify an impossible combination such as `i860-dg-vms',
  549.      then you may get an error message from `configure', or it may
  550.      ignore part of the information and do the best it can with the
  551.      rest. `configure' always prints the canonical name for the
  552.      alternative that it used.
  553.      Often a particular model of machine has a name.  Many machine
  554.      names are recognized as aliases for CPU/company combinations. 
  555.      Thus, the machine name `sun3', mentioned above, is an alias for
  556.      `m68k-sun'. Sometimes we accept a company name as a machine name,
  557.      when the name is popularly used for a particular machine.  Here is
  558.      a table of the known machine names:
  559.           3300, 3b1, 3bN, 7300, altos3068, altos, apollo68, att-7300,
  560.           balance, convex-cN, crds, decstation-3100, decstation, delta,
  561.           encore, fx2800, gmicro, hp7NN, hp8NN, hp9k2NN, hp9k3NN,
  562.           hp9k7NN, hp9k8NN, iris4d, iris, isi68, m3230, magnum, merlin,
  563.           miniframe, mmax, news-3600, news800, news, next, pbd, pc532,
  564.           pmax, ps2, risc-news, rtpc, sun2, sun386i, sun386, sun3,
  565.           sun4, symmetry, tower-32, tower.
  566.      Remember that a machine name specifies both the cpu type and the
  567.      company name.
  568.      There are three additional options you can specify independently to
  569.      describe variant hardware and software configurations.  These are
  570.      `--with-gnu-as', `--with-gnu-ld', and `--nfp'.
  571.     `--with-gnu-as'
  572.           On certain systems, you must specify whether you want GNU CC
  573.           to work with the usual compilation tools or with the GNU
  574.           compilation tools (including GAS).  Use the `--with-gnu-as'
  575.           argument when you run `configure', if you want to use the GNU
  576.           tools.  (Specify `--with-gnu-ld' as well, since on these
  577.           systems GAS works only with the GNU linker.)  The systems
  578.           were this makes a difference are `i386-ANYTHING-sysv',
  579.           `i860-ANYTHING-bsd', `m68k-hp-hpux', `m68k-sony-bsd',
  580.           `m68k-altos-sysv', `m68000-hp-hpux', and `m68000-att-sysv'. 
  581.           On any other system, `--with-gnu-as' has no effect.
  582.     `--with-gnu-ld'
  583.           Specify the option `--with-gnu-ld' if you plan to use the GNU
  584.           linker.  This inhibits the installation of `collect2', a
  585.           program which otherwise serves as a front-end for the
  586.           system's linker on most configurations.
  587.     `--nfp'
  588.           On certain systems, you must specify whether the machine has
  589.           a floating point unit.  These systems are `m68k-sun-sunosN'
  590.           and `m68k-isi-bsd'.  On any other system, `--nfp' currently
  591.           has no effect, though perhaps there are other systems where
  592.           it could usefully make a difference.
  593.      If you want to install your own homemade configuration files, you
  594.      can use `local' as the company name to access them.  If you use
  595.      configuration `CPU-local', the entire configuration name is used
  596.      to form the configuration file names.
  597.      Thus, if you specify `m68k-local', then the files used are
  598.      `m68k-local.md', `m68k-local.h', `m68k-local.c',
  599.      `xm-m68k-local.h', `t-m68k-local', and `x-m68k-local'.
  600.      Here is a list of configurations that have special treatment or
  601.      special things you must know:
  602.     `i386-*-sco'
  603.           Compilation with RCC is recommended, but it produces lots of
  604.           spurious warnings.  They do not necessarily indicate that
  605.           anything is wrong.
  606.     `i386-sequent'
  607.           Go to the Berkeley universe before compiling.  In addition,
  608.           you probably need to create a file named `string.h'
  609.           containing just one line: `#include <strings.h>'.
  610.     `m68000-att'
  611.           AT&T 3b1, a.k.a. 7300 PC.  Special procedures are needed to
  612.           compile GNU CC with this machine's standard C compiler, due
  613.           to bugs in that compiler.  *Note 3b1 Install::.  You can
  614.           bootstrap it more easily with previous versions of GNU CC if
  615.           you have them.
  616.     `m68000-hp-bsd'
  617.           HP 9000 series 200 running BSD.  Note that the C compiler
  618.           that comes with this system cannot compile GNU CC; contact
  619.           `law@cs.utah.edu' to get binaries of GNU CC for bootstrapping.
  620.     `m68k-altos'
  621.           Altos 3068.  You must use the GNU assembler, linker and
  622.           debugger, with COFF-encapsulation.  Also, you must fix a
  623.           kernel bug.  Details in the file `README.ALTOS'.
  624.     `m68k-hp-hpux'
  625.           HP 9000 series 300 or 400 running HP-UX.  HP-UX version 8.0
  626.           has a bug in the assembler that prevents compilation of GNU
  627.           CC.  To fix it, get patch PHCO_0800 from HP.
  628.           In addition, `--gas' does not currently work with this
  629.           configuration.  Changes in HP-UX have broken the library
  630.           conversion tool and the linker.
  631.     `m68k-sun'
  632.           Sun 3.  We do not provide a configuration file to use the Sun
  633.           FPA by default, because programs that establish signal
  634.           handlers for floating point traps inherently cannot work with
  635.           the FPA.
  636.     `m88k-svr3'
  637.           Motorola m88k running the AT&T/Unisoft/Motorla V.3 reference
  638.           port. These systems tend to use the Green Hills C, revision
  639.           1.8.5, as the standard C compiler.  There are apparently bugs
  640.           in this compiler that result in object files differences
  641.           between stage 2 and stage 3.  If this happens, make the stage
  642.           4 compiler and compare it to the stage 3 compiler.  If the
  643.           stage 3 and stage 4 object files are identical, this suggests
  644.           a problem with the standard C compiler.  It is best, however,
  645.           to use an older version of GNU CC for bootstrapping.
  646.     `m88k-dgux'
  647.           Motorola m88k running DG/UX.  To build native or cross
  648.           compilers on DG/UX, you must first change to the 88open BCS
  649.           software development environment.  This is done by issuing
  650.           this command:
  651.                eval `sde-target m88kbcs`
  652.     `mips-mips-bsd'
  653.           MIPS machines running the MIPS operating system in BSD mode. 
  654.           It's possible that some old versions of the system lack the
  655.           functions `memcpy', `memcmp', and `memset'.  If your system
  656.           lacks these, you must remove or undo the definition of
  657.           `TARGET_MEM_FUNCTIONS' in `mips-bsd.h'.
  658.     `mips-sony-sysv'
  659.           Sony MIPS NEWS.  This works in NEWSOS 5.0.1, but not in 5.0.2
  660.           (which uses ELF instead of COFF).  Support for 5.0.2 will
  661.           probably be provided soon by volunteers.
  662.     `ns32k-encore'
  663.           Encore ns32000 system.  Encore systems are supported only
  664.           under BSD.
  665.     `ns32k-*-genix'
  666.           National Semiconductor ns32000 system.  Genix has bugs in
  667.           `alloca' and `malloc'; you must get the compiled versions of
  668.           these from GNU Emacs.
  669.     `ns32k-sequent'
  670.           Go to the Berkeley universe before compiling.  In addition,
  671.           you probably need to create a file named `string.h'
  672.           containing just one line: `#include <strings.h>'.
  673.     `ns32k-utek'
  674.           UTEK ns32000 system ("merlin").  The C compiler that comes
  675.           with this system cannot compile GNU CC; contact
  676.           `tektronix!reed!mason' to get binaries of GNU CC for
  677.           bootstrapping.
  678.     `romp-*-aos'
  679.     `romp-*-mach'
  680.           The only operating systems supported for the IBM RT PC are
  681.           AOS and MACH.  GNU CC does not support AIX running on the RT.
  682.     `rs6000-*-aix'
  683.           Read the file `README.RS6000' for information on how to get a
  684.           fix for a problem in the IBM assembler that prevents use of
  685.           GNU CC.
  686.     `vax-dec-ultrix'
  687.           Don't try compiling with Vax C (`vcc').  It produces
  688.           incorrect code in some cases (for example, when `alloca' is
  689.           used).
  690.           Meanwhile, compiling `cp-parse.c' with pcc does not work
  691.           because of an internal table size limitation in that
  692.           compiler.  To avoid this problem, compile just the GNU C
  693.           compiler first, and use it to recompile building all the
  694.           languages that you want to run.
  695.     `we32k-att-sysv'
  696.           Don't use `-g' when compiling GNU CC.  The system's linker
  697.           seems to be unable to handle such a large program with
  698.           debugging information.
  699.      Here we spell out what files will be set up by `configure'. 
  700.      Normally you need not be concerned with these files.
  701.         * A symbolic link named `config.h' is made to the top-level
  702.           config file for the machine you will run the compiler on
  703.           (*note Config::.). This file is responsible for defining
  704.           information about the host machine.  It includes `tm.h'.
  705.           The top-level config file is located in the subdirectory
  706.           `config'. Its name is always `xm-SOMETHING.h'; usually
  707.           `xm-MACHINE.h', but there are some exceptions.
  708.           If your system does not support symbolic links, you might
  709.           want to set up `config.h' to contain a `#include' command
  710.           which refers to the appropriate file.
  711.         * A symbolic link named `tconfig.h' is made to the top-level
  712.           config file for your target machine.  This is used for
  713.           compiling certain programs to run on that machine.
  714.         * A symbolic link named `tm.h' is made to the
  715.           machine-description macro file for your target machine.  It
  716.           should be in the subdirectory `config' and its name is often
  717.           `MACHINE.h'.
  718.         * A symbolic link named `md' will be made to the machine
  719.           description pattern file.  It should be in the `config'
  720.           subdirectory and its name should be `MACHINE.md'; but MACHINE
  721.           is often not the same as the name used in the `tm.h' file
  722.           because the `md' files are more general.
  723.         * A symbolic link named `aux-output.c' will be made to the
  724.           output subroutine file for your machine.  It should be in the
  725.           `config' subdirectory and its name should be `MACHINE.c'.
  726.         * The command file `configure' also constructs `Makefile' by
  727.           adding some text to the template file `Makefile.in'.  The
  728.           additional text comes from files in the `config' directory,
  729.           named `t-TARGET' and `h-HOST'.  If these files do not exist,
  730.           it means nothing needs to be added for a given target or host.
  731.   4. Make sure the Bison parser generator is installed.  (This is
  732.      unnecessary if the Bison output files `c-parse.c' and `cexp.c' are
  733.      more recent than `c-parse.y' and `cexp.y' and you do not plan to
  734.      change the `.y' files.)
  735.      Bison versions older than Sept 8, 1988 will produce incorrect
  736.      output for `c-parse.c'.
  737.   5. Build the compiler.  Just type `make LANGUAGES=c' in the compiler
  738.      directory.
  739.      `LANGUAGES=c' specifies that only the C compiler should be
  740.      compiled.  The makefile normally builds compilers for all the
  741.      supported languages; currently, C, C++ and Objective C.  However,
  742.      C is the only language that is sure to work when you build with
  743.      other non-GNU C compilers.  In addition, building anything but C
  744.      at this stage is a waste of time.
  745.      In general, you can specify the languages to build by typing the
  746.      argument `LANGUAGES="LIST"', where LIST is one or more words from
  747.      the list `c', `c++', and `objective-c'.
  748.      Ignore any warnings you may see about "statement not reached" in
  749.      `insn-emit.c'; they are normal.  Any other compilation errors may
  750.      represent bugs in the port to your machine or operating system, and
  751.      should be investigated and reported (*note Bugs::.).
  752.      Some commercial compilers fail to compile GNU CC because they have
  753.      bugs or limitations.  For example, the Microsoft compiler is said
  754.      to run out of macro space.  Some Ultrix compilers run out of
  755.      expression space; then you need to break up the statement where
  756.      the problem happens.
  757.      If you are building with a previous GNU C compiler, do not use
  758.      `CC=gcc' on the make command or by editing the Makefile. Instead,
  759.      use a full pathname to specify the compiler, such as
  760.      `CC=/usr/local/bin/gcc'.  This is because make might execute the
  761.      `gcc' in the current directory before all of the compiler
  762.      components have been built.
  763.   6. If you are using COFF-encapsulation, you must convert `libgcc.a' to
  764.      a GNU-format library at this point.  See the file `README.ENCAP'
  765.      in the directory containing the GNU binary file utilities, for
  766.      directions.
  767.   7. If you are building a cross-compiler, stop here.  *Note
  768.      Cross-Compiler::.
  769.   8. Move the first-stage object files and executables into a
  770.      subdirectory with this command:
  771.           make stage1
  772.      The files are moved into a subdirectory named `stage1'. Once
  773.      installation is complete, you may wish to delete these files with
  774.      `rm -r stage1'.
  775.   9. Recompile the compiler with itself, with this command:
  776.           make CC="stage1/gcc -Bstage1/" CFLAGS="-g -O"
  777.      This is called making the stage 2 compiler.
  778.      The command shown above builds compilers for all the supported
  779.      languages.  If you don't want them all, you can specify the
  780.      languages to build by typing the argument `LANGUAGES="LIST"'.  LIST
  781.      should contain one or more words from the list `c', `c++',
  782.      `objective-c', and `proto'.  Separate the words with spaces.
  783.      `proto' stands for the programs `protoize' and `unprotoize'; they
  784.      are not a separate language, but you use `LANGUAGES' to enable or
  785.      disable their installation.
  786.      If you are going to build the stage 3 compiler, then you might
  787.      want to build only the C language in stage 2.
  788.      Once you have built the stage 2 compiler, if you are short of disk
  789.      space, you can delete the subdirectory `stage1'.
  790.      On a 68000 or 68020 system lacking floating point hardware, unless
  791.      you have selected a `tm.h' file that expects by default that there
  792.      is no such hardware, do this instead:
  793.           make CC="stage1/gcc -Bstage1/" CFLAGS="-g -O -msoft-float"
  794.  10. If you wish to test the compiler by compiling it with itself one
  795.      more time, do this:
  796.           make stage2
  797.           make CC="stage2/gcc -Bstage2/" CFLAGS="-g -O"
  798.      This is called making the stage 3 compiler.  Aside from the `-B'
  799.      option, the options should be the same as when you made the stage 2
  800.      compiler.
  801.      The command shown above builds compilers for all the supported
  802.      languages.  If you don't want them all, you can specify the
  803.      languages to build by typing the argument `LANGUAGES="LIST"', as
  804.      described above.
  805.      Then compare the latest object files with the stage 2 object
  806.      files--they ought to be identical, unless they contain time stamps.
  807.      You can compare the files, disregarding the time stamps if any,
  808.      like this:
  809.           make compare
  810.      This will mention any object files that differ between stage 2 and
  811.      stage 3.  Any difference, no matter how innocuous, indicates that
  812.      the stage 2 compiler has compiled GNU CC incorrectly, and is
  813.      therefore a potentially serious bug which you should investigate
  814.      and report (*note Bugs::.).
  815.      If your system does not put time stamps in the object files, then
  816.      this is a faster way to compare them (using the Bourne shell):
  817.           for file in *.o; do
  818.           cmp $file stage2/$file
  819.           done
  820.      If you have built the compiler with the `-mno-mips-tfile' option on
  821.      MIPS machines, you will not be able to compare the files.
  822.  11. Install the compiler driver, the compiler's passes and run-time
  823.      support. You can use the following command:
  824.           make CC="stage2/gcc -Bstage2/" CFLAGS="-g -O" install LANGUAGES="LIST"
  825.      (Use the same value for `CC', `CFLAGS' and `LANGUAGES' that you
  826.      used when compiling the files that are being installed.  One
  827.      reason this is necessary is that some versions of Make have bugs
  828.      and recompile files gratuitously when you do this step.  If you
  829.      use the same variable values, those files will be recompiled
  830.      properly.
  831.      This copies the files `cc1', `cpp' and `libgcc.a' to files `cc1',
  832.      `cpp' and `libgcc.a' in directory
  833.      `/usr/local/lib/gcc-lib/TARGET/VERSION', which is where the
  834.      compiler driver program looks for them.  Here TARGET is the target
  835.      machine type specified when you ran `configure', and VERSION is
  836.      the version number of GNU CC.  This naming scheme permits various
  837.      versions and/or cross-compilers to coexist.
  838.      It also copies the driver program `gcc' into the directory
  839.      `/usr/local/bin', so that it appears in typical execution search
  840.      paths.
  841.      On some systems, this command will cause recompilation of some
  842.      files. This is usually due to bugs in `make'.  You should either
  843.      ignore this problem, or use GNU Make.
  844.      *Warning: there is a bug in `alloca' in the Sun library.  To avoid
  845.      this bug, be sure to install the executables of GNU CC that were
  846.      compiled by GNU CC.  (That is, the executables from stage 2 or 3,
  847.      not stage 1.)  They use `alloca' as a built-in function and never
  848.      the one in the library.*
  849.      (It is usually better to install GNU CC executables from stage 2
  850.      or 3, since they usually run faster than the ones compiled with
  851.      some other compiler.)
  852.  12. Correct errors in the header files on your machine.
  853.      Various system header files often contain constructs which are
  854.      incompatible with ANSI C, and they will not work when you compile
  855.      programs with GNU CC.  This behavior consists of substituting for
  856.      macro argument names when they appear inside of character
  857.      constants.  The most common offender is `ioctl.h'.
  858.      You can overcome this problem when you compile by specifying the
  859.      `-traditional' option.
  860.      Alternatively, on Sun systems and 4.3BSD at least, you can correct
  861.      the include files by running the shell script `fixincludes'.  This
  862.      installs modified, corrected copies of the files `ioctl.h',
  863.      `ttychars.h' and many others, in a special directory where only
  864.      GNU CC will normally look for them.  This script will work on
  865.      various systems because it chooses the files by searching all the
  866.      system headers for the problem cases that we know about.
  867.      Use the following command to do this:
  868.           make install-fixincludes
  869.      If you selected a different directory for GNU CC installation when
  870.      you installed it, by specifying the Make variable `prefix' or
  871.      `libdir', specify it the same way in this command.
  872.      Note that some systems are starting to come with ANSI C system
  873.      header files.  On these systems, don't run `fixincludes'; it may
  874.      not work, and is certainly not necessary.
  875.    If you cannot install the compiler's passes and run-time support in
  876. `/usr/local/lib', you can alternatively use the `-B' option to specify
  877. a prefix by which they may be found.  The compiler concatenates the
  878. prefix with the names  `cpp', `cc1' and `libgcc.a'. Thus, you can put
  879. the files in a directory `/usr/foo/gcc' and specify `-B/usr/foo/gcc/'
  880. when you run GNU CC.
  881.    Also, you can specify an alternative default directory for these
  882. files by setting the Make variable `libdir' when you make GNU CC.
  883. File: gcc.info,  Node: Other Dir,  Next: Cross-Compiler,  Up: Installation
  884. Compilation in a Separate Directory
  885. ===================================
  886.    If you wish to build the object files and executables in a directory
  887. other than the one containing the source files, here is what you must
  888. do differently:
  889.   1. Make sure you have a version of Make that supports the `VPATH'
  890.      feature.  (GNU Make supports it, as do Make versions on most BSD
  891.      systems.)
  892.   2. If you have ever run `configure' in the source directory, you must
  893.      undo the configuration.  Do this by running:
  894.           make distclean
  895.   3. Go to the directory in which you want to build the compiler before
  896.      running `configure':
  897.           mkdir gcc-sun3
  898.           cd gcc-sun3
  899.      On systems that do not support symbolic links, this directory must
  900.      be on the same file system as the source code directory.
  901.   4. Specify where to find `configure' when you run it:
  902.           ../gcc/configure ...
  903.      This also tells `configure' where to find the compiler sources;
  904.      `configure' takes the directory from the file name that was used to
  905.      invoke it.  But if you want to be sure, you can specify the source
  906.      directory with the `--srcdir' option, like this:
  907.           ../gcc/configure --srcdir=../gcc sun3
  908.      The directory you specify with `--srcdir' need not be the same as
  909.      the one that `configure' is found in.
  910.    Now, you can run `make' in that directory.  You need not repeat the
  911. configuration steps shown above, when ordinary source files change.  You
  912. must, however, run `configure' again when the configuration files
  913. change, if your system does not support symbolic links.
  914.