home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / programm / language / gcc222.lha / info / gcc.info-17 (.txt) < prev    next >
GNU Info File  |  1992-07-19  |  34KB  |  634 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: DBX Options,  Next: DBX Hooks,  Prev: All Debuggers,  Up: Debugging Info
  21. Specific Options for DBX Output
  22. -------------------------------
  23. `DBX_DEBUGGING_INFO'
  24.      Define this macro if GNU CC should produce debugging output for DBX
  25.      in response to the `-g' option.
  26. `XCOFF_DEBUGGING_INFO'
  27.      Define this macro if GNU CC should produce XCOFF format debugging
  28.      output in response to the `-g' option.  This is a variant of DBX
  29.      format.
  30. `DEFAULT_GDB_EXTENSIONS'
  31.      Define this macro to control whether GNU CC should by default
  32.      generate GDB's extended version of DBX debugging information
  33.      (assuming DBX-format debugging information is enabled at all).  If
  34.      you don't define the macro, the default is 1: always generate the
  35.      extended information if there is any occasion to.
  36. `DEBUG_SYMS_TEXT'
  37.      Define this macro if all `.stabs' commands should be output while
  38.      in the text section.
  39. `ASM_STABS_OP'
  40.      A C string constant naming the assembler pseudo op to use instead
  41.      of `.stabs' to define an ordinary debugging symbol.  If you don't
  42.      define this macro, `.stabs' is used.  This macro applies only to
  43.      DBX debugging information format.
  44. `ASM_STABD_OP'
  45.      A C string constant naming the assembler pseudo op to use instead
  46.      of `.stabd' to define a debugging symbol whose value is the current
  47.      location.  If you don't define this macro, `.stabd' is used. This
  48.      macro applies only to DBX debugging information format.
  49. `ASM_STABN_OP'
  50.      A C string constant naming the assembler pseudo op to use instead
  51.      of `.stabn' to define a debugging symbol with no name.  If you
  52.      don't define this macro, `.stabn' is used.  This macro applies
  53.      only to DBX debugging information format.
  54. `DBX_NO_XREFS'
  55.      Define this macro if DBX on your system does not support the
  56.      construct `xsTAGNAME'.  On some systems, this construct is used to
  57.      describe a forward reference to a structure named TAGNAME. On
  58.      other systems, this construct is not supported at all.
  59. `DBX_CONTIN_LENGTH'
  60.      A symbol name in DBX-format debugging information is normally
  61.      continued (split into two separate `.stabs' directives) when it
  62.      exceeds a certain length (by default, 80 characters).  On some
  63.      operating systems, DBX requires this splitting; on others,
  64.      splitting must not be done.  You can inhibit splitting by defining
  65.      this macro with the value zero.  You can override the default
  66.      splitting-length by defining this macro as an expression for the
  67.      length you desire.
  68. `DBX_CONTIN_CHAR'
  69.      Normally continuation is indicated by adding a `\' character to
  70.      the end of a `.stabs' string when a continuation follows.  To use
  71.      a different character instead, define this macro as a character
  72.      constant for the character you want to use.  Do not define this
  73.      macro if backslash is correct for your system.
  74. `DBX_STATIC_STAB_DATA_SECTION'
  75.      Define this macro if it is necessary to go to the data section
  76.      before outputting the `.stabs' pseudo-op for a non-global static
  77.      variable.
  78. `DBX_TYPE_DECL_STABS_CODE'
  79.      The value to use in the "code" field of the `.stabs' directive for
  80.      a typedef.  The default is `N_LSYM'.
  81. `DBX_STATIC_CONST_VAR_CODE'
  82.      The value to use in the "code" field of the `.stabs' directive for
  83.      a static variable located in the text section.  DBX format does not
  84.      provide any "right" way to do this.  The default is `N_FUN'.
  85. `DBX_REGPARM_STABS_CODE'
  86.      The value to use in the "code" field of the `.stabs' directive for
  87.      a parameter passed in registers.  DBX format does not provide any
  88.      "right" way to do this.  The default is `N_RSYM'.
  89. `DBX_REGPARM_STABS_LETTER'
  90.      The letter to use in DBX symbol data to identify a symbol as a
  91.      parameter passed in registers.  DBX format does not customarily
  92.      provide any way to do this.  The default is `'P''.
  93. `DBX_MEMPARM_STABS_LETTER'
  94.      The letter to use in DBX symbol data to identify a symbol as a
  95.      stack parameter.  The default is `'p''.
  96. `DBX_FUNCTION_FIRST'
  97.      Define this macro if the DBX information for a function and its
  98.      arguments should precede the assembler code for the function. 
  99.      Normally, in DBX format, the debugging information entirely
  100.      follows the assembler code.
  101. `DBX_LBRAC_FIRST'
  102.      Define this macro if the `N_LBRAC' symbol for a block should
  103.      precede the debugging information for variables and functions
  104.      defined in that block.  Normally, in DBX format, the `N_LBRAC'
  105.      symbol comes first.
  106. File: gcc.info,  Node: DBX Hooks,  Next: File Names and DBX,  Prev: DBX Options,  Up: Debugging Info
  107. Open-Ended Hooks for DBX Format
  108. -------------------------------
  109. `DBX_OUTPUT_LBRAC (STREAM, NAME)'
  110.      Define this macro to say how to output to STREAM the debugging
  111.      information for the start of a scope level for variable names.  The
  112.      argument NAME is the name of an assembler symbol (for use with
  113.      `assemble_name') whose value is the address where the scope begins.
  114. `DBX_OUTPUT_RBRAC (STREAM, NAME)'
  115.      Like `DBX_OUTPUT_LBRAC', but for the end of a scope level.
  116. `DBX_OUTPUT_ENUM (STREAM, TYPE)'
  117.      Define this macro if the target machine requires special handling
  118.      to output an enumeration type.  The definition should be a C
  119.      statement (sans semicolon) to output the appropriate information
  120.      to STREAM for the type TYPE.
  121. `DBX_OUTPUT_FUNCTION_END (STREAM, FUNCTION)'
  122.      Define this macro if the target machine requires special output at
  123.      the end of the debugging information for a function.  The
  124.      definition should be a C statement (sans semicolon) to output the
  125.      appropriate information to STREAM.  FUNCTION is the
  126.      `FUNCTION_DECL' node for the function.
  127. `DBX_OUTPUT_STANDARD_TYPES (SYMS)'
  128.      Define this macro if you need to control the order of output of the
  129.      standard data types at the beginning of compilation.  The argument
  130.      SYMS is a `tree' which is a chain of all the predefined global
  131.      symbols, including names of data types.
  132.      Normally, DBX output starts with definitions of the types for
  133.      integers and characters, followed by all the other predefined
  134.      types of the particular language in no particular order.
  135.      On some machines, it is necessary to output different particular
  136.      types first.  To do this, define `DBX_OUTPUT_STANDARD_TYPES' to
  137.      output those symbols in the necessary order.  Any predefined types
  138.      that you don't explicitly output will be output afterward in no
  139.      particular order.
  140.      Be careful not to define this macro so that it works only for C. 
  141.      There are no global variables to access most of the built-in
  142.      types, because another language may have another set of types. 
  143.      The way to output a particular type is to look through SYMS to see
  144.      if you can find it. Here is an example:
  145.           {
  146.             tree decl;
  147.             for (decl = syms; decl; decl = TREE_CHAIN (decl))
  148.               if (!strcmp (IDENTIFIER_POINTER (DECL_NAME (decl)), "long int"))
  149.                 dbxout_symbol (decl);
  150.             ...
  151.           }
  152.      This does nothing if the expected type does not exist.
  153.      See the function `init_decl_processing' in source file `c-decl.c'
  154.      to find the names to use for all the built-in C types.
  155.      Here is another way of finding a particular type:
  156.           {
  157.             tree decl;
  158.             for (decl = syms; decl; decl = TREE_CHAIN (decl))
  159.               if (TREE_CODE (decl) == TYPE_DECL
  160.               && TREE_CODE (TREE_TYPE (decl)) == INTEGER_CST
  161.                   && TYPE_PRECISION (TREE_TYPE (decl)) == 16
  162.                   && TYPE_UNSIGNED (TREE_TYPE (decl)))
  163.                 /* This must be `unsigned short'.  */
  164.                 dbxout_symbol (decl);
  165.             ...
  166.           }
  167. File: gcc.info,  Node: File Names and DBX,  Next: SDB and DWARF,  Prev: DBX Hooks,  Up: Debugging Info
  168. File Names in DBX Format
  169. ------------------------
  170. `DBX_WORKING_DIRECTORY'
  171.      Define this if DBX wants to have the current directory recorded in
  172.      each object file.
  173.      Note that the working directory is always recorded if GDB
  174.      extensions are enabled.
  175. `DBX_OUTPUT_MAIN_SOURCE_FILENAME (STREAM, NAME)'
  176.      A C statement to output DBX debugging information to the stdio
  177.      stream STREAM which indicates that file NAME is the main source
  178.      file--the file specified as the input file for compilation. This
  179.      macro is called only once, at the beginning of compilation.
  180.      This macro need not be defined if the standard form of output for
  181.      DBX debugging information is appropriate.
  182. `DBX_OUTPUT_MAIN_SOURCE_DIRECTORY (STREAM, NAME)'
  183.      A C statement to output DBX debugging information to the stdio
  184.      stream STREAM which indicates that the current directory during
  185.      compilation is named NAME.
  186.      This macro need not be defined if the standard form of output for
  187.      DBX debugging information is appropriate.
  188. `DBX_OUTPUT_MAIN_SOURCE_FILE_END (STREAM, NAME)'
  189.      A C statement to output DBX debugging information at the end of
  190.      compilation of the main source file NAME.
  191.      If you don't define this macro, nothing special is output at the
  192.      end of compilation, which is correct for most machines.
  193. `DBX_OUTPUT_SOURCE_FILENAME (STREAM, NAME)'
  194.      A C statement to output DBX debugging information to the stdio
  195.      stream STREAM which indicates that file NAME is the current source
  196.      file.  This output is generated each time input shifts to a
  197.      different source file as a result of `#include', the end of an
  198.      included file, or a `#line' command.
  199.      This macro need not be defined if the standard form of output for
  200.      DBX debugging information is appropriate.
  201. File: gcc.info,  Node: SDB and DWARF,  Prev: File Names and DBX,  Up: Debugging Info
  202. Macros for SDB and DWARF Output
  203. -------------------------------
  204. `SDB_DEBUGGING_INFO'
  205.      Define this macro if GNU CC should produce COFF-style debugging
  206.      output for SDB in response to the `-g' option.
  207. `DWARF_DEBUGGING_INFO'
  208.      Define this macro if GNU CC should produce dwarf format debugging
  209.      output in response to the `-g' option.
  210. `PUT_SDB_...'
  211.      Define these macros to override the assembler syntax for the
  212.      special SDB assembler directives.  See `sdbout.c' for a list of
  213.      these macros and their arguments.  If the standard syntax is used,
  214.      you need not define them yourself.
  215. `SDB_DELIM'
  216.      Some assemblers do not support a semicolon as a delimiter, even
  217.      between SDB assembler directives.  In that case, define this macro
  218.      to be the delimiter to use (usually `\n').  It is not necessary to
  219.      define a new set of `PUT_SDB_OP' macros if this is the only change
  220.      required.
  221. `SDB_GENERATE_FAKE'
  222.      Define this macro to override the usual method of constructing a
  223.      dummy name for anonymous structure and union types.  See
  224.      `sdbout.c' for more information.
  225. `SDB_ALLOW_UNKNOWN_REFERENCES'
  226.      Define this macro to allow references to unknown structure, union,
  227.      or enumeration tags to be emitted.  Standard COFF does not allow
  228.      handling of unknown references, MIPS ECOFF has support for it.
  229. `SDB_ALLOW_FORWARD_REFERENCES'
  230.      Define this macro to allow references to structure, union, or
  231.      enumeration tags that have not yet been seen to be handled.  Some
  232.      assemblers choke if forward tags are used, while some require it.
  233. File: gcc.info,  Node: Cross-compilation,  Next: Misc,  Prev: Debugging Info,  Up: Target Macros
  234. Cross Compilation and Floating Point Format
  235. ===========================================
  236.    While all modern machines use 2's complement representation for
  237. integers, there are a variety of representations for floating point
  238. numbers.  This means that in a cross-compiler the representation of
  239. floating point numbers in the compiled program may be different from
  240. that used in the machine doing the compilation.
  241.    Because different representation systems may offer different amounts
  242. of range and precision, the cross compiler cannot safely use the host
  243. machine's floating point arithmetic.  Therefore, floating point
  244. constants must be represented in the target machine's format.  This
  245. means that the cross compiler cannot use `atof' to parse a floating
  246. point constant; it must have its own special routine to use instead. 
  247. Also, constant folding must emulate the target machine's arithmetic (or
  248. must not be done at all).
  249.    The macros in the following table should be defined only if you are
  250. cross compiling between different floating point formats.
  251.    Otherwise, don't define them. Then default definitions will be set
  252. up which use `double' as the data type, `==' to test for equality, etc.
  253.    You don't need to worry about how many times you use an operand of
  254. any of these macros.  The compiler never uses operands which have side
  255. effects.
  256. `REAL_VALUE_TYPE'
  257.      A macro for the C data type to be used to hold a floating point
  258.      value in the target machine's format.  Typically this would be a
  259.      `struct' containing an array of `int'.
  260. `REAL_VALUES_EQUAL (X, Y)'
  261.      A macro for a C expression which compares for equality the two
  262.      values, X and Y, both of type `REAL_VALUE_TYPE'.
  263. `REAL_VALUES_LESS (X, Y)'
  264.      A macro for a C expression which tests whether X is less than Y,
  265.      both values being of type `REAL_VALUE_TYPE' and interpreted as
  266.      floating point numbers in the target machine's representation.
  267. `REAL_VALUE_LDEXP (X, SCALE)'
  268.      A macro for a C expression which performs the standard library
  269.      function `ldexp', but using the target machine's floating point
  270.      representation.  Both X and the value of the expression have type
  271.      `REAL_VALUE_TYPE'.  The second argument, SCALE, is an integer.
  272. `REAL_VALUE_FIX (X)'
  273.      A macro whose definition is a C expression to convert the
  274.      target-machine floating point value X to a signed integer.  X has
  275.      type `REAL_VALUE_TYPE'.
  276. `REAL_VALUE_UNSIGNED_FIX (X)'
  277.      A macro whose definition is a C expression to convert the
  278.      target-machine floating point value X to an unsigned integer.  X
  279.      has type `REAL_VALUE_TYPE'.
  280. `REAL_VALUE_FIX_TRUNCATE (X)'
  281.      A macro whose definition is a C expression to convert the
  282.      target-machine floating point value X to a signed integer,
  283.      rounding toward 0. X has type `REAL_VALUE_TYPE'.
  284. `REAL_VALUE_UNSIGNED_FIX_TRUNCATE (X)'
  285.      A macro whose definition is a C expression to convert the
  286.      target-machine floating point value X to an unsigned integer,
  287.      rounding toward 0. X has type `REAL_VALUE_TYPE'.
  288. `REAL_VALUE_ATOF (STRING)'
  289.      A macro for a C expression which converts STRING, an expression of
  290.      type `char *', into a floating point number in the target
  291.      machine's representation.  The value has type `REAL_VALUE_TYPE'.
  292. `REAL_INFINITY'
  293.      Define this macro if infinity is a possible floating point value,
  294.      and therefore division by 0 is legitimate.
  295. `REAL_VALUE_ISINF (X)'
  296.      A macro for a C expression which determines whether X, a floating
  297.      point value, is infinity.  The value has type `int'. By default,
  298.      this is defined to call `isinf'.
  299. `REAL_VALUE_ISNAN (X)'
  300.      A macro for a C expression which determines whether X, a floating
  301.      point value, is a "nan" (not-a-number).  The value has type `int'.
  302.       By default, this is defined to call `isnan'.
  303.    Define the following additional macros if you want to make floating
  304. point constant folding work while cross compiling.  If you don't define
  305. them, cross compilation is still possible, but constant folding will
  306. not happen for floating point values.
  307. `REAL_ARITHMETIC (OUTPUT, CODE, X, Y)'
  308.      A macro for a C statement which calculates an arithmetic operation
  309.      of the two floating point values X and Y, both of type
  310.      `REAL_VALUE_TYPE' in the target machine's representation, to
  311.      produce a result of the same type and representation which is
  312.      stored in OUTPUT (which will be a variable).
  313.      The operation to be performed is specified by CODE, a tree code
  314.      which will always be one of the following: `PLUS_EXPR',
  315.      `MINUS_EXPR', `MULT_EXPR', `RDIV_EXPR', `MAX_EXPR', `MIN_EXPR'.
  316.      The expansion of this macro is responsible for checking for
  317.      overflow. If overflow happens, the macro expansion should execute
  318.      the statement `return 0;', which indicates the inability to
  319.      perform the arithmetic operation requested.
  320. `REAL_VALUE_NEGATE (X)'
  321.      A macro for a C expression which returns the negative of the
  322.      floating point value X.  Both X and the value of the expression
  323.      have type `REAL_VALUE_TYPE' and are in the target machine's
  324.      floating point representation.
  325.      There is no way for this macro to report overflow, since overflow
  326.      can't happen in the negation operation.
  327. `REAL_VALUE_TRUNCATE (X)'
  328.      A macro for a C expression which converts the double-precision
  329.      floating point value X to single-precision.
  330.      Both X and the value of the expression have type `REAL_VALUE_TYPE'
  331.      and are in the target machine's floating point representation. 
  332.      However, the value should have an appropriate bit pattern to be
  333.      output properly as a single-precision floating constant.
  334.      There is no way for this macro to report overflow.
  335. `REAL_VALUE_TO_INT (LOW, HIGH, X)'
  336.      A macro for a C expression which converts a floating point value X
  337.      into a double-precision integer which is then stored into LOW and
  338.      HIGH, two variables of type INT.
  339. `REAL_VALUE_FROM_INT (X, LOW, HIGH)'
  340.      A macro for a C expression which converts a double-precision
  341.      integer found in LOW and HIGH, two variables of type INT, into a
  342.      floating point value which is then stored into X.
  343. File: gcc.info,  Node: Misc,  Prev: Cross-compilation,  Up: Target Macros
  344. Miscellaneous Parameters
  345. ========================
  346. `PREDICATE_CODES'
  347.      Optionally define this if you have added predicates to
  348.      `MACHINE.c'.  This macro is called within an initializer of an
  349.      array of structures.  The first field in the structure is the name
  350.      of a predicate and the second field is an array of rtl codes.  For
  351.      each predicate, list all rtl codes that can be in expressions
  352.      matched by the predicate.  The list should have a trailing comma. 
  353.      Here is an example of two entries in the list for a typical RISC
  354.      machine:
  355.           #define PREDICATE_CODES \
  356.             {"gen_reg_rtx_operand", {SUBREG, REG}},  \
  357.             {"reg_or_short_cint_operand", {SUBREG, REG, CONST_INT}},
  358.      Defining this macro does not affect the generated code (however,
  359.      incorrect definitions that omit an rtl code that may be matched by
  360.      the predicate can cause the compiler to malfunction).  Instead, it
  361.      allows the table built by `genrecog' to be more compact and
  362.      efficient, thus speeding up the compiler.  The most important
  363.      predicates to include in the list specified by this macro are
  364.      thoses used in the most insn patterns.
  365. `CASE_VECTOR_MODE'
  366.      An alias for a machine mode name.  This is the machine mode that
  367.      elements of a jump-table should have.
  368. `CASE_VECTOR_PC_RELATIVE'
  369.      Define this macro if jump-tables should contain relative addresses.
  370. `CASE_DROPS_THROUGH'
  371.      Define this if control falls through a `case' insn when the index
  372.      value is out of range.  This means the specified default-label is
  373.      actually ignored by the `case' insn proper.
  374. `BYTE_LOADS_ZERO_EXTEND'
  375.      Define this macro if an instruction to load a value narrower than a
  376.      word from memory into a register also zero-extends the value to
  377.      the whole register.
  378. `IMPLICIT_FIX_EXPR'
  379.      An alias for a tree code that should be used by default for
  380.      conversion of floating point values to fixed point.  Normally,
  381.      `FIX_ROUND_EXPR' is used.
  382. `FIXUNS_TRUNC_LIKE_FIX_TRUNC'
  383.      Define this macro if the same instructions that convert a floating
  384.      point number to a signed fixed point number also convert validly
  385.      to an unsigned one.
  386. `EASY_DIV_EXPR'
  387.      An alias for a tree code that is the easiest kind of division to
  388.      compile code for in the general case.  It may be `TRUNC_DIV_EXPR',
  389.      `FLOOR_DIV_EXPR', `CEIL_DIV_EXPR' or `ROUND_DIV_EXPR'.  These four
  390.      division operators differ in how they round the result to an
  391.      integer.  `EASY_DIV_EXPR' is used when it is permissible to use
  392.      any of those kinds of division and the choice should be made on
  393.      the basis of efficiency.
  394. `MOVE_MAX'
  395.      The maximum number of bytes that a single instruction can move
  396.      quickly from memory to memory.
  397. `SHIFT_COUNT_TRUNCATED'
  398.      Defining this macro causes the compiler to omit a sign-extend,
  399.      zero-extend, or bitwise `and' instruction that truncates the count
  400.      of a shift operation to a width equal to the number of bits needed
  401.      to represent the size of the object being shifted.  On machines
  402.      that have instructions that act on bitfields at variable
  403.      positions, including `bit test' instructions, defining
  404.      `SHIFT_COUNT_TRUNCATED' also causes truncation not to be applied
  405.      to these instructions.
  406.      If both types of instructions truncate the count (for shifts) and
  407.      position (for bitfield operations), or if no variable-position
  408.      bitfield instructions exist, you should define this macro.
  409.      However, on some machines, such as the 80386 and the 680x0,
  410.      truncation only applies to shift operations and not the (real or
  411.      pretended) bitfield operations.  Do not define
  412.      `SHIFT_COUNT_TRUNCATED' on such machines.  Instead, add patterns
  413.      to the `md' file that include the implied truncation of the shift
  414.      instructions.
  415. `TRULY_NOOP_TRUNCATION (OUTPREC, INPREC)'
  416.      A C expression which is nonzero if on this machine it is safe to
  417.      "convert" an integer of INPREC bits to one of OUTPREC bits (where
  418.      OUTPREC is smaller than INPREC) by merely operating on it as if it
  419.      had only OUTPREC bits.
  420.      On many machines, this expression can be 1.
  421.      It is reported that suboptimal code can result when
  422.      `TRULY_NOOP_TRUNCATION' returns 1 for a pair of sizes for modes for
  423.      which `MODES_TIEABLE_P' is 0.  If this is the case, making
  424.      `TRULY_NOOP_TRUNCATION' return 0 in such cases may improve things.
  425. `STORE_FLAG_VALUE'
  426.      A C expression describing the value returned by a comparison
  427.      operator and stored by a store-flag instruction (`sCOND') when the
  428.      condition is true.  This description must apply to *all* the
  429.      `sCOND' patterns and all the comparison operators.
  430.      A value of 1 or -1 means that the instruction implementing the
  431.      comparison operator returns exactly 1 or -1 when the comparison is
  432.      true and 0 when the comparison is false.  Otherwise, the value
  433.      indicates which bits of the result are guaranteed to be 1 when the
  434.      comparison is true.  This value is interpreted in the mode of the
  435.      comparison operation, which is given by the mode of the first
  436.      operand in the `sCOND' pattern.  Either the low bit or the sign
  437.      bit of `STORE_FLAG_VALUE' be on.  Presently, only those bits are
  438.      used by the compiler.
  439.      If `STORE_FLAG_VALUE' is neither 1 or -1, the compiler will
  440.      generate code that depends only on the specified bits.  It can also
  441.      replace comparison operators with equivalent operations if they
  442.      cause the required bits to be set, even if the remaining bits are
  443.      undefined. For example, on a machine whose comparison operators
  444.      return an `SImode' value and where `STORE_FLAG_VALUE' is defined as
  445.      `0x80000000', saying that just the sign bit is relevant, the
  446.      expression
  447.           (ne:SI (and:SI X (const_int POWER-OF-2)) (const_int 0))
  448.      can be converted to
  449.           (ashift:SI X (const_int N))
  450.      where N is the appropriate shift count to move the bit being
  451.      tested into the sign bit.
  452.      There is no way to describe a machine that always sets the
  453.      low-order bit for a true value, but does not guarantee the value
  454.      of any other bits, but we do not know of any machine that has such
  455.      an instruction.  If you are trying to port GNU CC to such a
  456.      machine, include an instruction to perform a logical-and of the
  457.      result with 1 in the pattern for the comparison operators and let
  458.      us know (*note Bug Reporting::.).
  459.      Often, a machine will have multiple instructions that obtain a
  460.      value from a comparison (or the condition codes).  Here are rules
  461.      to guide the choice of value for `STORE_FLAG_VALUE', and hence the
  462.      instructions to be used:
  463.         * Use the shortest sequence that yields a valid definition for
  464.           `STORE_FLAG_VALUE'.  It is more efficient for the compiler to
  465.           "normalize" the value (convert it to, e.g., 1 or 0) than for
  466.           the comparison operators to do so because there may be
  467.           opportunities to combine the normalization with other
  468.           operations.
  469.         * For equal-length sequences, use a value of 1 or -1, with -1
  470.           being slightly preferred on machines with expensive jumps and
  471.           1 preferred on other machines.
  472.         * As a second choice, choose a value of `0x80000001' if
  473.           instructions exist that set both the sign and low-order bits
  474.           but do not define the others.
  475.         * Otherwise, use a value of `0x80000000'.
  476.      You need not define `STORE_FLAG_VALUE' if the machine has no
  477.      store-flag instructions.
  478. `Pmode'
  479.      An alias for the machine mode for pointers.  Normally the
  480.      definition can be
  481.           #define Pmode SImode
  482. `FUNCTION_MODE'
  483.      An alias for the machine mode used for memory references to
  484.      functions being called, in `call' RTL expressions.  On most
  485.      machines this should be `QImode'.
  486. `INTEGRATE_THRESHOLD (DECL)'
  487.      A C expression for the maximum number of instructions above which
  488.      the function DECL should not be inlined.  DECL is a
  489.      `FUNCTION_DECL' node.
  490.      The default definition of this macro is 64 plus 8 times the number
  491.      of arguments that the function accepts.  Some people think a larger
  492.      threshold should be used on RISC machines.
  493. `SCCS_DIRECTIVE'
  494.      Define this if the preprocessor should ignore `#sccs' directives
  495.      and print no error message.
  496. `HANDLE_PRAGMA (STREAM)'
  497.      Define this macro if you want to implement any pragmas.  If
  498.      defined, it should be a C statement to be executed when `#pragma'
  499.      is seen.  The argument STREAM is the stdio input stream from which
  500.      the source text can be read.
  501.      It is generally a bad idea to implement new uses of `#pragma'.  The
  502.      only reason to define this macro is for compatibility with other
  503.      compilers that do support `#pragma' for the sake of any user
  504.      programs which already use it.
  505. `DOLLARS_IN_IDENTIFIERS'
  506.      Define this macro to control use of the character `$' in identifier
  507.      names.  The value should be 0, 1, or 2.  0 means `$' is not allowed
  508.      by default; 1 means it is allowed by default if `-traditional' is
  509.      used; 2 means it is allowed by default provided `-ansi' is not
  510.      used. 1 is the default; there is no need to define this macro in
  511.      that case.
  512. `NO_DOLLAR_IN_LABEL'
  513.      Define this macro if the assembler does not accept the character
  514.      `$' in label names.  By default constructors and destructors in
  515.      G++ have `$' in the identifiers.  If this macro is defined, `.' is
  516.      used instead.
  517. `DEFAULT_MAIN_RETURN'
  518.      Define this macro if the target system expects every program's
  519.      `main' function to return a standard "success" value by default
  520.      (if no other value is explicitly returned).
  521.      The definition should be a C statement (sans semicolon) to
  522.      generate the appropriate rtl instructions.  It is used only when
  523.      compiling the end of `main'.
  524. `HAVE_ATEXIT'
  525.      Define this if the target system supports the function `atexit'
  526.      from the ANSI C standard.  If this is not defined, and
  527.      `INIT_SECTION_ASM_OP' is not defined, a default `exit' function
  528.      will be provided to support C++.
  529. `EXIT_BODY'
  530.      Define this if your `exit' function needs to do something besides
  531.      calling an external function `_cleanup' before terminating with
  532.      `_exit'.  The `EXIT_BODY' macro is only needed if netiher
  533.      `HAVE_ATEXIT' nor `INIT_SECTION_ASM_OP' are defined.
  534. File: gcc.info,  Node: Config,  Next: Index,  Prev: Target Macros,  Up: Top
  535. The Configuration File
  536. **********************
  537.    The configuration file `xm-MACHINE.h' contains macro definitions
  538. that describe the machine and system on which the compiler is running,
  539. unlike the definitions in `MACHINE.h', which describe the machine for
  540. which the compiler is producing output.  Most of the values in
  541. `xm-MACHINE.h' are actually the same on all machines that GNU CC runs
  542. on, so large parts of all configuration files are identical.  But there
  543. are some macros that vary:
  544. `USG'
  545.      Define this macro if the host system is System V.
  546. `VMS'
  547.      Define this macro if the host system is VMS.
  548. `FAILURE_EXIT_CODE'
  549.      A C expression for the status code to be returned when the compiler
  550.      exits after serious errors.
  551. `SUCCESS_EXIT_CODE'
  552.      A C expression for the status code to be returned when the compiler
  553.      exits without serious errors.
  554. `HOST_WORDS_BIG_ENDIAN'
  555.      Defined if the host machine stores words of multi-word values in
  556.      big-endian order.  (GNU CC does not depend on the host byte
  557.      ordering within a word.)
  558. `HOST_FLOAT_FORMAT'
  559.      A numeric code distinguishing the floating point format for the
  560.      host machine.  See `TARGET_FLOAT_FORMAT' in *Note Storage Layout::
  561.      for the alternatives and default.
  562. `HOST_BITS_PER_CHAR'
  563.      A C expression for the number of bits in `char' on the host
  564.      machine.
  565. `HOST_BITS_PER_SHORT'
  566.      A C expression for the number of bits in `short' on the host
  567.      machine.
  568. `HOST_BITS_PER_INT'
  569.      A C expression for the number of bits in `int' on the host machine.
  570. `HOST_BITS_PER_LONG'
  571.      A C expression for the number of bits in `long' on the host
  572.      machine.
  573. `ONLY_INT_FIELDS'
  574.      Define this macro to indicate that the host compiler only supports
  575.      `int' bit fields, rather than other integral types, including
  576.      `enum', as do most C compilers.
  577. `EXECUTABLE_SUFFIX'
  578.      Define this macro if the host system uses a naming convention for
  579.      executable files that involves a common suffix (such as, in some
  580.      systems, `.exe') that must be mentioned explicitly when you run
  581.      the program.
  582. `OBSTACK_CHUNK_SIZE'
  583.      A C expression for the size of ordinary obstack chunks. If you
  584.      don't define this, a usually-reasonable default is used.
  585. `OBSTACK_CHUNK_ALLOC'
  586.      The function used to allocate obstack chunks. If you don't define
  587.      this, `xmalloc' is used.
  588. `OBSTACK_CHUNK_FREE'
  589.      The function used to free obstack chunks. If you don't define
  590.      this, `free' is used.
  591. `USE_C_ALLOCA'
  592.      Define this macro to indicate that the compiler is running with the
  593.      `alloca' implemented in C.  This version of `alloca' can be found
  594.      in the file `alloca.c'; to use it, you must also alter the
  595.      `Makefile' variable `ALLOCA'.  (This is done automatically for the
  596.      systems on which we know it is needed.)
  597.      If you do define this macro, you should probably do it as follows:
  598.           #ifndef __GNUC__
  599.           #define USE_C_ALLOCA
  600.           #else
  601.           #define alloca __builtin_alloca
  602.           #endif
  603.      so that when the compiler is compiled with GNU CC it uses the more
  604.      efficient built-in `alloca' function.
  605. `FUNCTION_CONVERSION_BUG'
  606.      Define this macro to indicate that the host compiler does not
  607.      properly handle converting a function value to a
  608.      pointer-to-function when it is used in an expression.
  609. `HAVE_VPRINTF'
  610.      Define this if the library function `vprintf' is available on your
  611.      system.
  612. `MULTIBYTE_CHARS'
  613.      Define this macro to enable support for multibyte characters in the
  614.      input to GNU CC.  This requires that the host system support the
  615.      ANSI C library functions for converting multibyte characters to
  616.      wide characters.
  617. `HAVE_PUTENV'
  618.      Define this if the library function `putenv' is available on your
  619.      system.
  620. `NO_SYS_SIGLIST'
  621.      Define this if your system *does not* provide the variable
  622.      `sys_siglist'.
  623.      Some systems do provide this variable, but with a different name
  624.      such as `_sys_siglist'.  On these systems, you can define
  625.      `sys_siglist' as a macro which expands into the name actually
  626.      provided.
  627. `NO_STAB_H'
  628.      Define this if your system does not have the include file
  629.      `stab.h'.  If `USG' is defined, `NO_STAB_H' is assumed.
  630.    In addition, configuration files for system V define `bcopy',
  631. `bzero' and `bcmp' as aliases.  Some files define `alloca' as a macro
  632. when compiled with GNU CC, in order to take advantage of the benefit of
  633. GNU CC's built-in `alloca'.
  634.