home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / programm / language / gcc222.lha / info / gcc.info-13 (.txt) < prev    next >
GNU Info File  |  1992-07-19  |  47KB  |  851 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: Driver,  Next: Run-time Target,  Up: Target Macros
  21. Controlling the Compilation Driver, `gcc'
  22. =========================================
  23. `SWITCH_TAKES_ARG (CHAR)'
  24.      A C expression which determines whether the option `-CHAR' takes
  25.      arguments.  The value should be the number of arguments that
  26.      option takes--zero, for many options.
  27.      By default, this macro is defined to handle the standard options
  28.      properly.  You need not define it unless you wish to add additional
  29.      options which take arguments.
  30. `WORD_SWITCH_TAKES_ARG (NAME)'
  31.      A C expression which determines whether the option `-NAME' takes
  32.      arguments.  The value should be the number of arguments that
  33.      option takes--zero, for many options.  This macro rather than
  34.      `SWITCH_TAKES_ARG' is used for multi-character option names.
  35.      By default, this macro is defined to handle the standard options
  36.      properly.  You need not define it unless you wish to add additional
  37.      options which take arguments.
  38. `SWITCHES_NEED_SPACES'
  39.      A string-valued C expression which is nonempty if the linker needs
  40.      a space between the `-L' or `-o' option and its argument.
  41.      If this macro is not defined, the default value is 0.
  42. `CPP_SPEC'
  43.      A C string constant that tells the GNU CC driver program options to
  44.      pass to CPP.  It can also specify how to translate options you
  45.      give to GNU CC into options for GNU CC to pass to the CPP.
  46.      Do not define this macro if it does not need to do anything.
  47. `SIGNED_CHAR_SPEC'
  48.      A C string constant that tells the GNU CC driver program options to
  49.      pass to CPP.  By default, this macro is defined to pass the option
  50.      `-D__CHAR_UNSIGNED__' to CPP if `char' will be treated as
  51.      `unsigned char' by `cc1'.
  52.      Do not define this macro unless you need to override the default
  53.      definition.
  54. `CC1_SPEC'
  55.      A C string constant that tells the GNU CC driver program options to
  56.      pass to `cc1'.  It can also specify how to translate options you
  57.      give to GNU CC into options for GNU CC to pass to the `cc1'.
  58.      Do not define this macro if it does not need to do anything.
  59. `CC1PLUS_SPEC'
  60.      A C string constant that tells the GNU CC driver program options to
  61.      pass to `cc1plus'.  It can also specify how to translate options
  62.      you give to GNU CC into options for GNU CC to pass to the
  63.      `cc1plus'.
  64.      Do not define this macro if it does not need to do anything.
  65. `ASM_SPEC'
  66.      A C string constant that tells the GNU CC driver program options to
  67.      pass to the assembler.  It can also specify how to translate
  68.      options you give to GNU CC into options for GNU CC to pass to the
  69.      assembler. See the file `sun3.h' for an example of this.
  70.      Do not define this macro if it does not need to do anything.
  71. `ASM_FINAL_SPEC'
  72.      A C string constant that tells the GNU CC driver program how to
  73.      run any programs which cleanup after the normal assembler.
  74.      Normally, this is not needed.  See the file `mips.h' for an
  75.      example of this.
  76.      Do not define this macro if it does not need to do anything.
  77. `LINK_SPEC'
  78.      A C string constant that tells the GNU CC driver program options to
  79.      pass to the linker.  It can also specify how to translate options
  80.      you give to GNU CC into options for GNU CC to pass to the linker.
  81.      Do not define this macro if it does not need to do anything.
  82. `LIB_SPEC'
  83.      Another C string constant used much like `LINK_SPEC'.  The
  84.      difference between the two is that `LIB_SPEC' is used at the end
  85.      of the command given to the linker.
  86.      If this macro is not defined, a default is provided that loads the
  87.      standard C library from the usual place.  See `gcc.c'.
  88. `STARTFILE_SPEC'
  89.      Another C string constant used much like `LINK_SPEC'.  The
  90.      difference between the two is that `STARTFILE_SPEC' is used at the
  91.      very beginning of the command given to the linker.
  92.      If this macro is not defined, a default is provided that loads the
  93.      standard C startup file from the usual place.  See `gcc.c'.
  94. `ENDFILE_SPEC'
  95.      Another C string constant used much like `LINK_SPEC'.  The
  96.      difference between the two is that `ENDFILE_SPEC' is used at the
  97.      very end of the command given to the linker.
  98.      Do not define this macro if it does not need to do anything.
  99. `LINK_LIBGCC_SPECIAL'
  100.      Define this macro meaning that `gcc' should find the library
  101.      `libgcc.a' by hand, rather than passing the argument `-lgcc' to
  102.      tell the linker to do the search.
  103. `RELATIVE_PREFIX_NOT_LINKDIR'
  104.      Define this macro to tell `gcc' that it should only translate a
  105.      `-B' prefix into a `-L' linker option if the prefix indicates an
  106.      absolute file name.
  107. `STANDARD_EXEC_PREFIX'
  108.      Define this macro as a C string constant if you wish to override
  109.      the standard choice of `/usr/local/lib/gcc-lib/' as the default
  110.      prefix to try when searching for the executable files of the
  111.      compiler.
  112. `MD_EXEC_PREFIX'
  113.      If defined, this macro is an additional prefix to try after
  114.      `STANDARD_EXEC_PREFIX'.  `MD_EXEC_PREFIX' is not searched when the
  115.      `-b' option is used, or the compiler is built as a cross compiler.
  116. `STANDARD_STARTFILE_PREFIX'
  117.      Define this macro as a C string constant if you wish to override
  118.      the standard choice of `/usr/local/lib/' as the default prefix to
  119.      try when searching for startup files such as `crt0.o'.
  120. `MD_STARTFILE_PREFIX'
  121.      If defined, this macro supplies an additional prefix to try after
  122.      the standard prefixes.  `MD_EXEC_PREFIX' is not searched when the
  123.      `-b' option is used, or when the compiler is built as a cross
  124.      compiler.
  125. `MD_STARTFILE_PREFIX_1'
  126.      If defined, this macro supplies yet another prefix to try after the
  127.      standard prefixes.  It is not searched when the `-b' option is
  128.      used, or when the compiler is built as a cross compiler.
  129. `LOCAL_INCLUDE_DIR'
  130.      Define this macro as a C string constant if you wish to override
  131.      the standard choice of `/usr/local/include' as the default prefix
  132.      to try when searching for local header files.  `LOCAL_INCLUDE_DIR'
  133.      comes before `SYSTEM_INCLUDE_DIR' in the search order.
  134.      Cross compilers do not use this macro and do not search either
  135.      `/usr/local/include' or its replacement.
  136. `SYSTEM_INCLUDE_DIR'
  137.      Define this macro as a C string constant if you wish to specify a
  138.      system-specific directory to search for header files before the
  139.      standard directory.  `SYSTEM_INCLUDE_DIR' comes before
  140.      `STANDARD_INCLUDE_DIR' in the search order.
  141.      Cross compilers do not use this macro and do not search the
  142.      directory specified.
  143. `STANDARD_INCLUDE_DIR'
  144.      Define this macro as a C string constant if you wish to override
  145.      the standard choice of `/usr/include' as the default prefix to try
  146.      when searching for header files.
  147.      Cross compilers do not use this macro and do not search either
  148.      `/usr/include' or its replacement.
  149. `INCLUDE_DEFAULTS'
  150.      Define this macro if you wish to override the entire default
  151.      search path for include files.  The default search path includes
  152.      `GPLUSPLUS_INCLUDE_DIR', `GCC_INCLUDE_DIR', `LOCAL_INCLUDE_DIR',
  153.      `SYSTEM_INCLUDE_DIR', and `STANDARD_INCLUDE_DIR'.  In addition,
  154.      the macros `GPLUSPLUS_INCLUDE_DIR' and `GCC_INCLUDE_DIR' are
  155.      defined automatically by `Makefile', and specify private search
  156.      areas for GCC.  The directory `GPLUSPLUS_INCLUDE_DIR' is used only
  157.      for C++ programs.
  158.      The definition should be an initializer for an array of structures.
  159.      Each array element should have two elements: the directory name (a
  160.      string constant) and a flag for C++-only directories.  Mark the
  161.      end of the array with a null element.  For example, here is the
  162.      definition used for VMS:
  163.           #define INCLUDE_DEFAULTS \
  164.           {                                       \
  165.             { "GNU_GXX_INCLUDE:", 1},             \
  166.             { "GNU_CC_INCLUDE:", 0},              \
  167.             { "SYS$SYSROOT:[SYSLIB.]", 0},        \
  168.             { ".", 0},                            \
  169.             { 0, 0}                               \
  170.           }
  171.    Here is the order of prefixes tried for exec files:
  172.   1. Any prefixes specified by the user with `-B'.
  173.   2. The environment variable `GCC_EXEC_PREFIX', if any.
  174.   3. The directories specified by the environment variable
  175.      `COMPILER_PATH'.
  176.   4. The macro `STANDARD_EXEC_PREFIX'.
  177.   5. `/usr/lib/gcc/'.
  178.   6. The macro `MD_EXEC_PREFIX', if any.
  179.    Here is the order of prefixes tried for startfiles:
  180.   1. Any prefixes specified by the user with `-B'.
  181.   2. The environment variable `GCC_EXEC_PREFIX', if any.
  182.   3. The directories specified by the environment variable
  183.      `LIBRARY_PATH'.
  184.   4. The macro `STANDARD_EXEC_PREFIX'.
  185.   5. `/usr/lib/gcc/'.
  186.   6. The macro `MD_EXEC_PREFIX', if any.
  187.   7. The macro `MD_STARTFILE_PREFIX', if any.
  188.   8. The macro `STANDARD_STARTFILE_PREFIX'.
  189.   9. `/lib/'.
  190.  10. `/usr/lib/'.
  191. File: gcc.info,  Node: Run-time Target,  Next: Storage Layout,  Prev: Driver,  Up: Target Macros
  192. Run-time Target Specification
  193. =============================
  194. `CPP_PREDEFINES'
  195.      Define this to be a string constant containing `-D' options to
  196.      define the predefined macros that identify this machine and system.
  197.      These macros will be predefined unless the `-ansi' option is
  198.      specified.
  199.      In addition, a parallel set of macros are predefined, whose names
  200.      are made by appending `__' at the beginning and at the end.  These
  201.      `__' macros are permitted by the ANSI standard, so they are
  202.      predefined regardless of whether `-ansi' is specified.
  203.      For example, on the Sun, one can use the following value:
  204.           "-Dmc68000 -Dsun -Dunix"
  205.      The result is to define the macros `__mc68000__', `__sun__' and
  206.      `__unix__' unconditionally, and the macros `mc68000', `sun' and
  207.      `unix' provided `-ansi' is not specified.
  208. `STDC_VALUE'
  209.      Define the value to be assigned to the built-in macro `__STDC__'.
  210.      The default is the value `1'.
  211. `extern int target_flags;'
  212.      This declaration should be present.
  213. `TARGET_...'
  214.      This series of macros is to allow compiler command arguments to
  215.      enable or disable the use of optional features of the target
  216.      machine. For example, one machine description serves both the
  217.      68000 and the 68020; a command argument tells the compiler whether
  218.      it should use 68020-only instructions or not.  This command
  219.      argument works by means of a macro `TARGET_68020' that tests a bit
  220.      in `target_flags'.
  221.      Define a macro `TARGET_FEATURENAME' for each such option. Its
  222.      definition should test a bit in `target_flags'; for example:
  223.           #define TARGET_68020 (target_flags & 1)
  224.      One place where these macros are used is in the
  225.      condition-expressions of instruction patterns.  Note how
  226.      `TARGET_68020' appears frequently in the 68000 machine description
  227.      file, `m68k.md'. Another place they are used is in the definitions
  228.      of the other macros in the `MACHINE.h' file.
  229. `TARGET_SWITCHES'
  230.      This macro defines names of command options to set and clear bits
  231.      in `target_flags'.  Its definition is an initializer with a
  232.      subgrouping for each command option.
  233.      Each subgrouping contains a string constant, that defines the
  234.      option name, and a number, which contains the bits to set in
  235.      `target_flags'.  A negative number says to clear bits instead; the
  236.      negative of the number is which bits to clear.  The actual option
  237.      name is made by appending `-m' to the specified name.
  238.      One of the subgroupings should have a null string.  The number in
  239.      this grouping is the default value for `target_flags'.  Any target
  240.      options act starting with that value.
  241.      Here is an example which defines `-m68000' and `-m68020' with
  242.      opposite meanings, and picks the latter as the default:
  243.           #define TARGET_SWITCHES \
  244.             { { "68020", 1},      \
  245.               { "68000", -1},     \
  246.               { "", 1}}
  247. `TARGET_OPTIONS'
  248.      This macro is similar to `TARGET_SWITCHES' but defines names of
  249.      command options that have values.  Its definition is an
  250.      initializer with a subgrouping for each command option.
  251.      Each subgrouping contains a string constant, that defines the
  252.      fixed part of the option name, and the address of a variable.  The
  253.      variable, type `char *', is set to the variable part of the given
  254.      option if the fixed part matches.  The actual option name is made
  255.      by appending `-m' to the specified name.
  256.      Here is an example which defines `-mshort-data-NUMBER'.  If the
  257.      given option is `-mshort-data-512', the variable `m88k_short_data'
  258.      will be set to the string `"512"'.
  259.           extern char *m88k_short_data;
  260.           #define TARGET_OPTIONS { { "short-data-", &m88k_short_data } }
  261. `TARGET_VERSION'
  262.      This macro is a C statement to print on `stderr' a string
  263.      describing the particular machine description choice.  Every
  264.      machine description should define `TARGET_VERSION'.  For example:
  265.           #ifdef MOTOROLA
  266.           #define TARGET_VERSION fprintf (stderr, " (68k, Motorola syntax)");
  267.           #else
  268.           #define TARGET_VERSION fprintf (stderr, " (68k, MIT syntax)");
  269.           #endif
  270. `OVERRIDE_OPTIONS'
  271.      Sometimes certain combinations of command options do not make
  272.      sense on a particular target machine.  You can define a macro
  273.      `OVERRIDE_OPTIONS' to take account of this.  This macro, if
  274.      defined, is executed once just after all the command options have
  275.      been parsed.
  276.      Don't use this macro to turn on various extra optimizations for
  277.      `-O'.  That is what `OPTIMIZATION_OPTIONS' is for.
  278. `OPTIMIZATION_OPTIONS (LEVEL)'
  279.      Some machines may desire to change what optimizations are
  280.      performed for various optimization levels.   This macro, if
  281.      defined, is executed once just after the optimization level is
  282.      determined and before the remainder of the command options have
  283.      been parsed.  Values set in this macro are used as the default
  284.      values for the other command line options.
  285.      LEVEL is the optimization level specified; 2 if -O2 is specified,
  286.      1 if -O is specified, and 0 if neither is specified.
  287.      *Do not examine `write_symbols' in this macro!* The debugging
  288.      options are not supposed to alter the generated code.
  289. File: gcc.info,  Node: Storage Layout,  Next: Type Layout,  Prev: Run-time Target,  Up: Target Macros
  290. Storage Layout
  291. ==============
  292.    Note that the definitions of the macros in this table which are
  293. sizes or alignments measured in bits do not need to be constant.  They
  294. can be C expressions that refer to static variables, such as the
  295. `target_flags'. *Note Run-time Target::.
  296. `BITS_BIG_ENDIAN'
  297.      Define this macro to be the value 1 if the most significant bit in
  298.      a byte has the lowest number; otherwise define it to be the value
  299.      zero. This means that bit-field instructions count from the most
  300.      significant bit.  If the machine has no bit-field instructions,
  301.      this macro is irrelevant.
  302.      This macro does not affect the way structure fields are packed into
  303.      bytes or words; that is controlled by `BYTES_BIG_ENDIAN'.
  304. `BYTES_BIG_ENDIAN'
  305.      Define this macro to be 1 if the most significant byte in a word
  306.      has the lowest number.
  307. `WORDS_BIG_ENDIAN'
  308.      Define this macro to be 1 if, in a multiword object, the most
  309.      significant word has the lowest number.
  310. `BITS_PER_UNIT'
  311.      Number of bits in an addressable storage unit (byte); normally 8.
  312. `BITS_PER_WORD'
  313.      Number of bits in a word; normally 32.
  314. `MAX_BITS_PER_WORD'
  315.      Maximum number of bits in a word.  If this is undefined, the
  316.      default is `BITS_PER_WORD'.  Otherwise, it is the constant value
  317.      that is the largest value that `BITS_PER_WORD' can have at
  318.      run-time.
  319. `UNITS_PER_WORD'
  320.      Number of storage units in a word; normally 4.
  321. `POINTER_SIZE'
  322.      Width of a pointer, in bits.
  323. `PARM_BOUNDARY'
  324.      Normal alignment required for function parameters on the stack, in
  325.      bits.  All stack parameters receive least this much alignment
  326.      regardless of data type.  On most machines, this is the same as the
  327.      size of an integer.
  328. `STACK_BOUNDARY'
  329.      Define this macro if you wish to preserve a certain alignment for
  330.      the stack pointer.  The definition is a C expression for the
  331.      desired alignment (measured in bits).
  332.      If `PUSH_ROUNDING' is not defined, the stack will always be aligned
  333.      to the specified boundary.  If `PUSH_ROUNDING' is defined and
  334.      specifies a less strict alignment than `STACK_BOUNDARY', the stack
  335.      may be momentarily unaligned while pushing arguments.
  336. `FUNCTION_BOUNDARY'
  337.      Alignment required for a function entry point, in bits.
  338. `BIGGEST_ALIGNMENT'
  339.      Biggest alignment that any data type can require on this machine,
  340.      in bits.
  341. `BIGGEST_FIELD_ALIGNMENT'
  342.      Biggest alignment that any structure field can require on this
  343.      machine, in bits.  If defined, this overrides `BIGGEST_ALIGNMENT'
  344.      for structure fields only.
  345. `MAX_OFILE_ALIGNMENT'
  346.      Biggest alignment supported by the object file format of this
  347.      machine. Use this macro to limit the alignment which can be
  348.      specified using the `__attribute__ ((aligned (N)))' construct.  If
  349.      not defined, the default value is `BIGGEST_ALIGNMENT'.
  350. `DATA_ALIGNMENT (TYPE, BASIC-ALIGN)'
  351.      If defined, a C expression to compute the alignment for a static
  352.      variable.  TYPE is the data type, and BASIC-ALIGN is the alignment
  353.      that the object would ordinarily have.  The value of this macro is
  354.      used instead of that alignment to align the object.
  355.      If this macro is not defined, then BASIC-ALIGN is used.
  356.      One use of this macro is to increase alignment of medium-size data
  357.      to make it all fit in fewer cache lines.  Another is to cause
  358.      character arrays to be word-aligned so that `strcpy' calls that
  359.      copy constants to character arrays can be done inline.
  360. `CONSTANT_ALIGNMENT (CONSTANT, BASIC-ALIGN)'
  361.      If defined, a C expression to compute the alignment given to a
  362.      constant that is being placed in memory.  CONSTANT is the constant
  363.      and BASIC-ALIGN is the alignment that the object would ordinarily
  364.      have.  The value of this macro is used instead of that alignment to
  365.      align the object.
  366.      If this macro is not defined, then BASIC-ALIGN is used.
  367.      The typical use of this macro is to increase alignment for string
  368.      constants to be word aligned so that `strcpy' calls that copy
  369.      constants can be done inline.
  370. `EMPTY_FIELD_BOUNDARY'
  371.      Alignment in bits to be given to a structure bit field that
  372.      follows an empty field such as `int : 0;'.
  373.      Note that `PCC_BITFIELD_TYPE_MATTERS' also affects the alignment
  374.      that results from an empty field.
  375. `STRUCTURE_SIZE_BOUNDARY'
  376.      Number of bits which any structure or union's size must be a
  377.      multiple of. Each structure or union's size is rounded up to a
  378.      multiple of this.
  379.      If you do not define this macro, the default is the same as
  380.      `BITS_PER_UNIT'.
  381. `STRICT_ALIGNMENT'
  382.      Define this macro to be the value 1 if instructions will fail to
  383.      work if given data not on the nominal alignment.  If instructions
  384.      will merely go slower in that case, define this macro as 0.
  385. `PCC_BITFIELD_TYPE_MATTERS'
  386.      Define this if you wish to imitate the way many other C compilers
  387.      handle alignment of bitfields and the structures that contain them.
  388.      The behavior is that the type written for a bitfield (`int',
  389.      `short', or other integer type) imposes an alignment for the
  390.      entire structure, as if the structure really did contain an
  391.      ordinary field of that type.  In addition, the bitfield is placed
  392.      within the structure so that it would fit within such a field, not
  393.      crossing a boundary for it.
  394.      Thus, on most machines, a bitfield whose type is written as `int'
  395.      would not cross a four-byte boundary, and would force four-byte
  396.      alignment for the whole structure.  (The alignment used may not be
  397.      four bytes; it is controlled by the other alignment parameters.)
  398.      If the macro is defined, its definition should be a C expression;
  399.      a nonzero value for the expression enables this behavior.
  400.      Note that if this macro is not defined, or its value is zero, some
  401.      bitfields may cross more than one alignment boundary.  The
  402.      compiler can support such references if there are `insv', `extv',
  403.      and `extzv' insns that can directly reference memory.
  404.      The other known way of making bitfields work is to define
  405.      `STRUCTURE_SIZE_BOUNDARY' as large as `BIGGEST_ALIGNMENT'. Then
  406.      every structure can be accessed with fullwords.
  407.      Unless the machine has bitfield instructions or you define
  408.      `STRUCTURE_SIZE_BOUNDARY' that way, you must define
  409.      `PCC_BITFIELD_TYPE_MATTERS' to have a nonzero value.
  410. `BITFIELD_NBYTES_LIMITED'
  411.      Like PCC_BITFIELD_TYPE_MATTERS except that its effect is limited to
  412.      aligning a bitfield within the structure.
  413. `ROUND_TYPE_SIZE (STRUCT, SIZE, ALIGN)'
  414.      Define this macro as an expression for the overall size of a
  415.      structure (given by STRUCT as a tree node) when the size computed
  416.      from the fields is SIZE and the alignment is ALIGN.
  417.      The default is to round SIZE up to a multiple of ALIGN.
  418. `ROUND_TYPE_ALIGN (STRUCT, COMPUTED, SPECIFIED)'
  419.      Define this macro as an expression for the alignment of a structure
  420.      (given by STRUCT as a tree node) if the alignment computed in the
  421.      usual way is COMPUTED and the alignment explicitly specified was
  422.      SPECIFIED.
  423.      The default is to use SPECIFIED if it is larger; otherwise, use
  424.      the smaller of COMPUTED and `BIGGEST_ALIGNMENT'
  425. `MAX_FIXED_MODE_SIZE'
  426.      An integer expression for the size in bits of the largest integer
  427.      machine mode that should actually be used.  All integer machine
  428.      modes of this size or smaller can be used for structures and
  429.      unions with the appropriate sizes.  If this macro is undefined,
  430.      `GET_MODE_BITSIZE (DImode)' is assumed.
  431. `CHECK_FLOAT_VALUE (MODE, VALUE)'
  432.      A C statement to validate the value VALUE (of type `double') for
  433.      mode MODE.  This means that you check whether VALUE fits within
  434.      the possible range of values for mode MODE on this target machine.
  435.       The mode MODE is always `SFmode' or `DFmode'.
  436.      If VALUE is not valid, you should call `error' to print an error
  437.      message and then assign some valid value to VALUE. Allowing an
  438.      invalid value to go through the compiler can produce incorrect
  439.      assembler code which may even cause Unix assemblers to crash.
  440.      This macro need not be defined if there is no work for it to do.
  441. `TARGET_FLOAT_FORMAT'
  442.      A code distinguishing the floating point format of the target
  443.      machine. There are three defined values:
  444.     `IEEE_FLOAT_FORMAT'
  445.           This code indicates IEEE floating point.  It is the default;
  446.           there is no need to define this macro when the format is IEEE.
  447.     `VAX_FLOAT_FORMAT'
  448.           This code indicates the peculiar format used on the Vax.
  449.     `UNKNOWN_FLOAT_FORMAT'
  450.           This code indicates any other format.
  451.      The value of this macro is compared with `HOST_FLOAT_FORMAT'
  452.      (*note Config::.) to determine whether the target machine has the
  453.      same format as the host machine.  If any other formats are
  454.      actually in use on supported machines, new codes should be defined
  455.      for them.
  456. File: gcc.info,  Node: Type Layout,  Next: Registers,  Prev: Storage Layout,  Up: Target Macros
  457. Layout of Source Language Data Types
  458. ====================================
  459.    These macros define the sizes and other characteristics of the
  460. standard basic data types used in programs being compiled.  Unlike the
  461. macros in the previous section, these apply to specific features of C
  462. and related languages, rather than to fundamental aspects of storage
  463. layout.
  464. `INT_TYPE_SIZE'
  465.      A C expression for the size in bits of the type `int' on the
  466.      target machine.  If you don't define this, the default is one word.
  467. `SHORT_TYPE_SIZE'
  468.      A C expression for the size in bits of the type `short' on the
  469.      target machine.  If you don't define this, the default is half a
  470.      word. (If this would be less than one storage unit, it is rounded
  471.      up to one unit.)
  472. `LONG_TYPE_SIZE'
  473.      A C expression for the size in bits of the type `long' on the
  474.      target machine.  If you don't define this, the default is one word.
  475. `LONG_LONG_TYPE_SIZE'
  476.      A C expression for the size in bits of the type `long long' on the
  477.      target machine.  If you don't define this, the default is two
  478.      words.
  479. `CHAR_TYPE_SIZE'
  480.      A C expression for the size in bits of the type `char' on the
  481.      target machine.  If you don't define this, the default is one
  482.      quarter of a word.  (If this would be less than one storage unit,
  483.      it is rounded up to one unit.)
  484. `FLOAT_TYPE_SIZE'
  485.      A C expression for the size in bits of the type `float' on the
  486.      target machine.  If you don't define this, the default is one word.
  487. `DOUBLE_TYPE_SIZE'
  488.      A C expression for the size in bits of the type `double' on the
  489.      target machine.  If you don't define this, the default is two
  490.      words.
  491. `LONG_DOUBLE_TYPE_SIZE'
  492.      A C expression for the size in bits of the type `long double' on
  493.      the target machine.  If you don't define this, the default is two
  494.      words.
  495. `DEFAULT_SIGNED_CHAR'
  496.      An expression whose value is 1 or 0, according to whether the type
  497.      `char' should be signed or unsigned by default.  The user can
  498.      always override this default with the options `-fsigned-char' and
  499.      `-funsigned-char'.
  500. `DEFAULT_SHORT_ENUMS'
  501.      A C expression to determine whether to give an `enum' type only as
  502.      many bytes as it takes to represent the range of possible values
  503.      of that type.  A nonzero value means to do that; a zero value
  504.      means all `enum' types should be allocated like `int'.
  505.      If you don't define the macro, the default is 0.
  506. `SIZE_TYPE'
  507.      A C expression for a string describing the name of the data type
  508.      to use for size values.  The typedef name `size_t' is defined
  509.      using the contents of the string.
  510.      The string can contain more than one keyword.  If so, separate
  511.      them with spaces, and write first any length keyword, then
  512.      `unsigned' if appropriate, and finally `int'.  The string must
  513.      exactly match one of the data type names defined in the function
  514.      `init_decl_processing' in the file `c-decl.c'.  You may not omit
  515.      `int' or change the order--that would cause the compiler to crash
  516.      on startup.
  517.      If you don't define this macro, the default is `"long unsigned
  518.      int"'.
  519. `PTRDIFF_TYPE'
  520.      A C expression for a string describing the name of the data type
  521.      to use for the result of subtracting two pointers.  The typedef
  522.      name `ptrdiff_t' is defined using the contents of the string.  See
  523.      `SIZE_TYPE' above for more information.
  524.      If you don't define this macro, the default is `"long int"'.
  525. `WCHAR_TYPE'
  526.      A C expression for a string describing the name of the data type
  527.      to use for wide characters.  The typedef name `wchar_t' is defined
  528.      using the contents of the string.  See `SIZE_TYPE' above for more
  529.      information.
  530.      If you don't define this macro, the default is `"int"'.
  531. `WCHAR_TYPE_SIZE'
  532.      A C expression for the size in bits of the data type for wide
  533.      characters.  This is used in `cpp', which cannot make use of
  534.      `WCHAR_TYPE'.
  535. `OBJC_INT_SELECTORS'
  536.      Define this macro if the type of Objective C selectors should be
  537.      `int'.
  538.      If this macro is not defined, then selectors should have the type
  539.      `struct objc_selector *'.
  540. `OBJC_SELECTORS_WITHOUT_LABELS'
  541.      Define this macro if the compiler can group all the selectors
  542.      together into a vector and use just one label at the beginning of
  543.      the vector. Otherwise, the compiler must give each selector its
  544.      own assembler label.
  545.      On certain machines, it is important to have a separate label for
  546.      each selector because this enables the linker to eliminate
  547.      duplicate selectors.
  548. `TARGET_BELL'
  549.      A C constant expression for the integer value for escape sequence
  550.      `\a'.
  551. `TARGET_BS'
  552. `TARGET_TAB'
  553. `TARGET_NEWLINE'
  554.      C constant expressions for the integer values for escape sequences
  555.      `\b', `\t' and `\n'.
  556. `TARGET_VT'
  557. `TARGET_FF'
  558. `TARGET_CR'
  559.      C constant expressions for the integer values for escape sequences
  560.      `\v', `\f' and `\r'.
  561. File: gcc.info,  Node: Registers,  Next: Register Classes,  Prev: Type Layout,  Up: Target Macros
  562. Register Usage
  563. ==============
  564.    This section explains how to describe what registers the target
  565. machine has, and how (in general) they can be used.
  566.    The description of which registers a specific instruction can use is
  567. done with register classes; see *Note Register Classes::.  For
  568. information on using registers to access a stack frame, see *Note Frame
  569. Registers::. For passing values in registers, see *Note Register
  570. Arguments::. For returning values in registers, see *Note Scalar
  571. Return::.
  572. * Menu:
  573. * Register Basics::        Number and kinds of registers.
  574. * Allocation Order::        Order in which registers are allocated.
  575. * Values in Registers::        What kinds of values each reg can hold.
  576. * Leaf Functions::        Renumbering registers for leaf functions.
  577. * Stack Registers::        Handling a register stack such as 80387.
  578. * Obsolete Register Macros::    Macros formerly used for the 80387.
  579. File: gcc.info,  Node: Register Basics,  Next: Allocation Order,  Up: Registers
  580. Basic Characteristics of Registers
  581. ----------------------------------
  582. `FIRST_PSEUDO_REGISTER'
  583.      Number of hardware registers known to the compiler.  They receive
  584.      numbers 0 through `FIRST_PSEUDO_REGISTER-1'; thus, the first
  585.      pseudo register's number really is assigned the number
  586.      `FIRST_PSEUDO_REGISTER'.
  587. `FIXED_REGISTERS'
  588.      An initializer that says which registers are used for fixed
  589.      purposes all throughout the compiled code and are therefore not
  590.      available for general allocation.  These would include the stack
  591.      pointer, the frame pointer (except on machines where that can be
  592.      used as a general register when no frame pointer is needed), the
  593.      program counter on machines where that is considered one of the
  594.      addressable registers, and any other numbered register with a
  595.      standard use.
  596.      This information is expressed as a sequence of numbers, separated
  597.      by commas and surrounded by braces.  The Nth number is 1 if
  598.      register N is fixed, 0 otherwise.
  599.      The table initialized from this macro, and the table initialized by
  600.      the following one, may be overridden at run time either
  601.      automatically, by the actions of the macro
  602.      `CONDITIONAL_REGISTER_USAGE', or by the user with the command
  603.      options `-ffixed-REG', `-fcall-used-REG' and `-fcall-saved-REG'.
  604. `CALL_USED_REGISTERS'
  605.      Like `FIXED_REGISTERS' but has 1 for each register that is
  606.      clobbered (in general) by function calls as well as for fixed
  607.      registers.  This macro therefore identifies the registers that are
  608.      not available for general allocation of values that must live
  609.      across function calls.
  610.      If a register has 0 in `CALL_USED_REGISTERS', the compiler
  611.      automatically saves it on function entry and restores it on
  612.      function exit, if the register is used within the function.
  613. `CONDITIONAL_REGISTER_USAGE'
  614.      Zero or more C statements that may conditionally modify two
  615.      variables `fixed_regs' and `call_used_regs' (both of type `char
  616.      []') after they have been initialized from the two preceding
  617.      macros.
  618.      This is necessary in case the fixed or call-clobbered registers
  619.      depend on target flags.
  620.      You need not define this macro if it has no work to do.
  621.      If the usage of an entire class of registers depends on the target
  622.      flags, you may indicate this to GCC by using this macro to modify
  623.      `fixed_regs' and `call_used_regs' to 1 for each of the registers
  624.      in the classes which should not be used by GCC.  Also define the
  625.      macro `REG_CLASS_FROM_LETTER' to return `NO_REGS' if it is called
  626.      with a letter for a class that shouldn't be used.
  627.      (However, if this class is not included in `GENERAL_REGS' and all
  628.      of the insn patterns whose constraints permit this class are
  629.      controlled by target switches, then GCC will automatically avoid
  630.      using these registers when the target switches are opposed to
  631.      them.)
  632. `NON_SAVING_SETJMP'
  633.      If this macro is defined and has a nonzero value, it means that
  634.      `setjmp' and related functions fail to save the registers, or that
  635.      `longjmp' fails to restore them.  To compensate, the compiler
  636.      avoids putting variables in registers in functions that use
  637.      `setjmp'.
  638. File: gcc.info,  Node: Allocation Order,  Next: Values in Registers,  Prev: Register Basics,  Up: Registers
  639. Order of Allocation of Registers
  640. --------------------------------
  641. `REG_ALLOC_ORDER'
  642.      If defined, an initializer for a vector of integers, containing the
  643.      numbers of hard registers in the order in which GNU CC should
  644.      prefer to use them (from most preferred to least).
  645.      If this macro is not defined, registers are used lowest numbered
  646.      first (all else being equal).
  647.      One use of this macro is on machines where the highest numbered
  648.      registers must always be saved and the save-multiple-registers
  649.      instruction supports only sequences of consecutive registers.  On
  650.      such machines, define `REG_ALLOC_ORDER' to be an initializer that
  651.      lists the highest numbered allocatable register first.
  652. `ORDER_REGS_FOR_LOCAL_ALLOC'
  653.      A C statement (sans semicolon) to choose the order in which to
  654.      allocate hard registers for pseudo-registers local to a basic
  655.      block.
  656.      Store the desired order of registers in the array
  657.      `reg_alloc_order'.  Element 0 should be the register to allocate
  658.      first; element 1, the next register; and so on.
  659.      The macro body should not assume anything about the contents of
  660.      `reg_alloc_order' before execution of the macro.
  661.      On most machines, it is not necessary to define this macro.
  662. File: gcc.info,  Node: Values in Registers,  Next: Leaf Functions,  Prev: Allocation Order,  Up: Registers
  663. How Values Fit in Registers
  664. ---------------------------
  665.    This section discusses the macros that describe which kinds of values
  666. (specifically, which machine modes) each register can hold, and how many
  667. consecutive registers are needed for a given mode.
  668. `HARD_REGNO_NREGS (REGNO, MODE)'
  669.      A C expression for the number of consecutive hard registers,
  670.      starting at register number REGNO, required to hold a value of mode
  671.      MODE.
  672.      On a machine where all registers are exactly one word, a suitable
  673.      definition of this macro is
  674.           #define HARD_REGNO_NREGS(REGNO, MODE)            \
  675.              ((GET_MODE_SIZE (MODE) + UNITS_PER_WORD - 1)  \
  676.               / UNITS_PER_WORD))
  677. `HARD_REGNO_MODE_OK (REGNO, MODE)'
  678.      A C expression that is nonzero if it is permissible to store a
  679.      value of mode MODE in hard register number REGNO (or in several
  680.      registers starting with that one).  For a machine where all
  681.      registers are equivalent, a suitable definition is
  682.           #define HARD_REGNO_MODE_OK(REGNO, MODE) 1
  683.      It is not necessary for this macro to check for the numbers of
  684.      fixed registers, because the allocation mechanism considers them
  685.      to be always occupied.
  686.      On some machines, double-precision values must be kept in even/odd
  687.      register pairs.  The way to implement that is to define this macro
  688.      to reject odd register numbers for such modes.
  689.      The minimum requirement for a mode to be OK in a register is that
  690.      the `movMODE' instruction pattern support moves between the
  691.      register and any other hard register for which the mode is OK; and
  692.      that moving a value into the register and back out not alter it.
  693.      Since the same instruction used to move `SImode' will work for all
  694.      narrower integer modes, it is not necessary on any machine for
  695.      `HARD_REGNO_MODE_OK' to distinguish between these modes, provided
  696.      you define patterns `movhi', etc., to take advantage of this.  This
  697.      is useful because of the interaction between `HARD_REGNO_MODE_OK'
  698.      and `MODES_TIEABLE_P'; it is very desirable for all integer modes
  699.      to be tieable.
  700.      Many machines have special registers for floating point arithmetic.
  701.      Often people assume that floating point machine modes are allowed
  702.      only in floating point registers.  This is not true.  Any
  703.      registers that can hold integers can safely *hold* a floating
  704.      point machine mode, whether or not floating arithmetic can be done
  705.      on it in those registers.  Integer move instructions can be used
  706.      to move the values.
  707.      On some machines, though, the converse is true: fixed-point machine
  708.      modes may not go in floating registers.  This is true if the
  709.      floating registers normalize any value stored in them, because
  710.      storing a non-floating value there would garble it.  In this case,
  711.      `HARD_REGNO_MODE_OK' should reject fixed-point machine modes in
  712.      floating registers.  But if the floating registers do not
  713.      automatically normalize, if you can store any bit pattern in one
  714.      and retrieve it unchanged without a trap, then any machine mode
  715.      may go in a floating register, so you can define this macro to say
  716.      so.
  717.      On some machines, such as the Sparc and the Mips, we get better
  718.      code by defining `HARD_REGNO_MODE_OK' to forbid integers in
  719.      floating registers, even though the hardware is capable of
  720.      handling them.  This is because transferring values between
  721.      floating registers and general registers is so slow that it is
  722.      better to keep the integer in memory.
  723.      The primary significance of special floating registers is rather
  724.      that they are the registers acceptable in floating point arithmetic
  725.      instructions.  However, this is of no concern to
  726.      `HARD_REGNO_MODE_OK'.  You handle it by writing the proper
  727.      constraints for those instructions.
  728.      On some machines, the floating registers are especially slow to
  729.      access, so that it is better to store a value in a stack frame
  730.      than in such a register if floating point arithmetic is not being
  731.      done.  As long as the floating registers are not in class
  732.      `GENERAL_REGS', they will not be used unless some pattern's
  733.      constraint asks for one.
  734. `MODES_TIEABLE_P (MODE1, MODE2)'
  735.      A C expression that is nonzero if it is desirable to choose
  736.      register allocation so as to avoid move instructions between a
  737.      value of mode MODE1 and a value of mode MODE2.
  738.      If `HARD_REGNO_MODE_OK (R, MODE1)' and `HARD_REGNO_MODE_OK (R,
  739.      MODE2)' are ever different for any R, then `MODES_TIEABLE_P (MODE1,
  740.      MODE2)' must be zero.
  741. File: gcc.info,  Node: Leaf Functions,  Next: Stack Registers,  Prev: Values in Registers,  Up: Registers
  742. Handling Leaf Functions
  743. -----------------------
  744.    On some machines, a leaf function (i.e., one which make no calls)
  745. can run more efficiently if it does not make its own register window. 
  746. Often this means it is required to receive its arguments in the
  747. registers where they are passed by the caller, instead of the registers
  748. where they would normally arrive.
  749.    The special treatment for leaf functions generally applies only when
  750. other conditions are met; for example, often they may use only those
  751. registers for its own variables and temporaries.  We use the term "leaf
  752. function" to mean a function that is suitable for this special
  753. handling, so that functions with no calls are not necessarily "leaf
  754. functions".
  755.    GNU CC assigns register numbers before it knows whether the function
  756. is suitable for leaf function treatment.  So it needs to renumber the
  757. registers in order to output a leaf function.  The following macros
  758. accomplish this.
  759. `LEAF_REGISTERS'
  760.      A C initializer for a vector, indexed by hard register number,
  761.      which contains 1 for a register that is allowable in a candidate
  762.      for leaf function treatment.
  763.      If leaf function treatment involves renumbering the registers,
  764.      then the registers marked here should be the ones before
  765.      renumbering--those that GNU CC would ordinarily allocate.  The
  766.      registers which will actually be used in the assembler code, after
  767.      renumbering, should not be marked with 1 in this vector.
  768.      Define this macro only if the target machine offers a way to
  769.      optimize the treatment of leaf functions.
  770. `LEAF_REG_REMAP (REGNO)'
  771.      A C expression whose value is the register number to which REGNO
  772.      should be renumbered, when a function is treated as a leaf
  773.      function.
  774.      If REGNO is a register number which should not appear in a leaf
  775.      function before renumbering, then the expression should yield -1,
  776.      which will cause the compiler to abort.
  777.      Define this macro only if the target machine offers a way to
  778.      optimize the treatment of leaf functions, and registers need to be
  779.      renumbered to do this.
  780. `REG_LEAF_ALLOC_ORDER'
  781.      If defined, an initializer for a vector of integers, containing the
  782.      numbers of hard registers in the order in which the GNU CC should
  783.      prefer to use them (from most preferred to least) in a leaf
  784.      function.  If this macro is not defined, REG_ALLOC_ORDER is used
  785.      for both non-leaf and leaf-functions.
  786.    Normally, it is necessary for `FUNCTION_PROLOGUE' and
  787. `FUNCTION_EPILOGUE' to treat leaf functions specially.  It can test the
  788. C variable `leaf_function' which is nonzero for leaf functions. (The
  789. variable `leaf_function' is defined only if `LEAF_REGISTERS' is
  790. defined.)
  791. File: gcc.info,  Node: Stack Registers,  Next: Obsolete Register Macros,  Prev: Leaf Functions,  Up: Registers
  792. Registers That Form a Stack
  793. ---------------------------
  794.    There are special features to handle computers where some of the
  795. "registers" form a stack, as in the 80387 coprocessor for the 80386.
  796. Stack registers are normally written by pushing onto the stack, and are
  797. numbered relative to the top of the stack.
  798.    Currently, GNU CC can only handle one group of stack-like registers,
  799. and they must be consecutively numbered.
  800. `STACK_REGS'
  801.      Define this if the machine has any stack-like registers.
  802. `FIRST_STACK_REG'
  803.      The number of the first stack-like register.  This one is the top
  804.      of the stack.
  805. `LAST_STACK_REG'
  806.      The number of the last stack-like register.  This one is the
  807.      bottom of the stack.
  808. File: gcc.info,  Node: Obsolete Register Macros,  Prev: Stack Registers,  Up: Registers
  809. Obsolete Macros for Controlling Register Usage
  810. ----------------------------------------------
  811.    These features do not work very well.  They exist because they used
  812. to be required to generate correct code for the 80387 coprocessor of the
  813. 80386.  They are no longer used by that machine description and may be
  814. removed in a later version of the compiler.  Don't use them!
  815. `OVERLAPPING_REGNO_P (REGNO)'
  816.      If defined, this is a C expression whose value is nonzero if hard
  817.      register number REGNO is an overlapping register.  This means a
  818.      hard register which overlaps a hard register with a different
  819.      number. (Such overlap is undesirable, but occasionally it allows a
  820.      machine to be supported which otherwise could not be.)  This macro
  821.      must return nonzero for *all* the registers which overlap each
  822.      other.  GNU CC can use an overlapping register only in certain
  823.      limited ways.  It can be used for allocation within a basic block,
  824.      and may be spilled for reloading; that is all.
  825.      If this macro is not defined, it means that none of the hard
  826.      registers overlap each other.  This is the usual situation.
  827. `INSN_CLOBBERS_REGNO_P (INSN, REGNO)'
  828.      If defined, this is a C expression whose value should be nonzero if
  829.      the insn INSN has the effect of mysteriously clobbering the
  830.      contents of hard register number REGNO.  By "mysterious" we mean
  831.      that the insn's RTL expression doesn't describe such an effect.
  832.      If this macro is not defined, it means that no insn clobbers
  833.      registers mysteriously.  This is the usual situation; all else
  834.      being equal, it is best for the RTL expression to show all the
  835.      activity.
  836. `PRESERVE_DEATH_INFO_REGNO_P (REGNO)'
  837.      If defined, this is a C expression whose value is nonzero if
  838.      accurate `REG_DEAD' notes are needed for hard register number REGNO
  839.      at the time of outputting the assembler code.  When this is so, a
  840.      few optimizations that take place after register allocation and
  841.      could invalidate the death notes are not done when this register is
  842.      involved.
  843.      You would arrange to preserve death info for a register when some
  844.      of the code in the machine description which is executed to write
  845.      the assembler code looks at the death notes.  This is necessary
  846.      only when the actual hardware feature which GNU CC thinks of as a
  847.      register is not actually a register of the usual sort.  (It might,
  848.      for example, be a hardware stack.)
  849.      If this macro is not defined, it means that no death notes need to
  850.      be preserved.  This is the usual situation.
  851.