home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / programm / language / gcc222.lha / info / gcc.info-12 (.txt) < prev    next >
GNU Info File  |  1992-07-19  |  45KB  |  803 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: Expander Definitions,  Next: Insn Splitting,  Prev: Peephole Definitions,  Up: Machine Desc
  21. Defining RTL Sequences for Code Generation
  22. ==========================================
  23.    On some target machines, some standard pattern names for RTL
  24. generation cannot be handled with single insn, but a sequence of RTL
  25. insns can represent them.  For these target machines, you can write a
  26. `define_expand' to specify how to generate the sequence of RTL.
  27.    A `define_expand' is an RTL expression that looks almost like a
  28. `define_insn'; but, unlike the latter, a `define_expand' is used only
  29. for RTL generation and it can produce more than one RTL insn.
  30.    A `define_expand' RTX has four operands:
  31.    * The name.  Each `define_expand' must have a name, since the only
  32.      use for it is to refer to it by name.
  33.    * The RTL template.  This is just like the RTL template for a
  34.      `define_peephole' in that it is a vector of RTL expressions each
  35.      being one insn.
  36.    * The condition, a string containing a C expression.  This
  37.      expression is used to express how the availability of this pattern
  38.      depends on subclasses of target machine, selected by command-line
  39.      options when GNU CC is run.  This is just like the condition of a
  40.      `define_insn' that has a standard name.
  41.    * The preparation statements, a string containing zero or more C
  42.      statements which are to be executed before RTL code is generated
  43.      from the RTL template.
  44.      Usually these statements prepare temporary registers for use as
  45.      internal operands in the RTL template, but they can also generate
  46.      RTL insns directly by calling routines such as `emit_insn', etc.
  47.      Any such insns precede the ones that come from the RTL template.
  48.    Every RTL insn emitted by a `define_expand' must match some
  49. `define_insn' in the machine description.  Otherwise, the compiler will
  50. crash when trying to generate code for the insn or trying to optimize
  51.    The RTL template, in addition to controlling generation of RTL insns,
  52. also describes the operands that need to be specified when this pattern
  53. is used.  In particular, it gives a predicate for each operand.
  54.    A true operand, which needs to be specified in order to generate RTL
  55. from the pattern, should be described with a `match_operand' in its
  56. first occurrence in the RTL template.  This enters information on the
  57. operand's predicate into the tables that record such things.  GNU CC
  58. uses the information to preload the operand into a register if that is
  59. required for valid RTL code.  If the operand is referred to more than
  60. once, subsequent references should use `match_dup'.
  61.    The RTL template may also refer to internal "operands" which are
  62. temporary registers or labels used only within the sequence made by the
  63. `define_expand'.  Internal operands are substituted into the RTL
  64. template with `match_dup', never with `match_operand'.  The values of
  65. the internal operands are not passed in as arguments by the compiler
  66. when it requests use of this pattern.  Instead, they are computed
  67. within the pattern, in the preparation statements.  These statements
  68. compute the values and store them into the appropriate elements of
  69. `operands' so that `match_dup' can find them.
  70.    There are two special macros defined for use in the preparation
  71. statements: `DONE' and `FAIL'.  Use them with a following semicolon, as
  72. a statement.
  73. `DONE'
  74.      Use the `DONE' macro to end RTL generation for the pattern.  The
  75.      only RTL insns resulting from the pattern on this occasion will be
  76.      those already emitted by explicit calls to `emit_insn' within the
  77.      preparation statements; the RTL template will not be generated.
  78. `FAIL'
  79.      Make the pattern fail on this occasion.  When a pattern fails, it
  80.      means that the pattern was not truly available.  The calling
  81.      routines in the compiler will try other strategies for code
  82.      generation using other patterns.
  83.      Failure is currently supported only for binary (addition,
  84.      multiplication, shifting, etc.) and bitfield (`extv', `extzv', and
  85.      `insv') operations.
  86.    Here is an example, the definition of left-shift for the SPUR chip:
  87.      (define_expand "ashlsi3"
  88.        [(set (match_operand:SI 0 "register_operand" "")
  89.              (ashift:SI
  90.                (match_operand:SI 1 "register_operand" "")
  91.                (match_operand:SI 2 "nonmemory_operand" "")))]
  92.        ""
  93.        "
  94.      {
  95.        if (GET_CODE (operands[2]) != CONST_INT
  96.            || (unsigned) INTVAL (operands[2]) > 3)
  97.          FAIL;
  98.      }")
  99. This example uses `define_expand' so that it can generate an RTL insn
  100. for shifting when the shift-count is in the supported range of 0 to 3
  101. but fail in other cases where machine insns aren't available.  When it
  102. fails, the compiler tries another strategy using different patterns
  103. (such as, a library call).
  104.    If the compiler were able to handle nontrivial condition-strings in
  105. patterns with names, then it would be possible to use a `define_insn'
  106. in that case.  Here is another case (zero-extension on the 68000) which
  107. makes more use of the power of `define_expand':
  108.      (define_expand "zero_extendhisi2"
  109.        [(set (match_operand:SI 0 "general_operand" "")
  110.              (const_int 0))
  111.         (set (strict_low_part
  112.                (subreg:HI
  113.                  (match_dup 0)
  114.                  0))
  115.              (match_operand:HI 1 "general_operand" ""))]
  116.        ""
  117.        "operands[1] = make_safe_from (operands[1], operands[0]);")
  118. Here two RTL insns are generated, one to clear the entire output operand
  119. and the other to copy the input operand into its low half.  This
  120. sequence is incorrect if the input operand refers to [the old value of]
  121. the output operand, so the preparation statement makes sure this isn't
  122. so.  The function `make_safe_from' copies the `operands[1]' into a
  123. temporary register if it refers to `operands[0]'.  It does this by
  124. emitting another RTL insn.
  125.    Finally, a third example shows the use of an internal operand.
  126. Zero-extension on the SPUR chip is done by `and'-ing the result against
  127. a halfword mask.  But this mask cannot be represented by a `const_int'
  128. because the constant value is too large to be legitimate on this
  129. machine.  So it must be copied into a register with `force_reg' and
  130. then the register used in the `and'.
  131.      (define_expand "zero_extendhisi2"
  132.        [(set (match_operand:SI 0 "register_operand" "")
  133.              (and:SI (subreg:SI
  134.                        (match_operand:HI 1 "register_operand" "")
  135.                        0)
  136.                      (match_dup 2)))]
  137.        ""
  138.        "operands[2]
  139.           = force_reg (SImode, gen_rtx (CONST_INT,
  140.                                         VOIDmode, 65535)); ")
  141.    *Note:* If the `define_expand' is used to serve a standard binary or
  142. unary arithmetic operation or a bitfield operation, then the last insn
  143. it generates must not be a `code_label', `barrier' or `note'.  It must
  144. be an `insn', `jump_insn' or `call_insn'.  If you don't need a real insn
  145. at the end, emit an insn to copy the result of the operation into
  146. itself.  Such an insn will generate no code, but it can avoid problems
  147. in the compiler.
  148. File: gcc.info,  Node: Insn Splitting,  Next: Insn Attributes,  Prev: Expander Definitions,  Up: Machine Desc
  149. Splitting Instructions into Multiple Instructions
  150. =================================================
  151.    There are two cases where you should specify how to split a pattern
  152. into multiple insns.  On machines that have instructions requiring delay
  153. slots (*note Delay Slots::.) or that have instructions whose output is
  154. not available for multiple cycles (*note Function Units::.), the
  155. compiler phases that optimize these cases need to be able to move insns
  156. into one-cycle delay slots.  However, some insns may generate more than
  157. one machine instruction.  These insns cannot be placed into a delay
  158. slot.
  159.    Often you can rewrite the single insn as a list of individual insns,
  160. each corresponding to one machine instruction.  The disadvantage of
  161. doing so is that it will cause the compilation to be slower and require
  162. more space.  If the resulting insns are too complex, it may also
  163. suppress some optimizations.  The compiler splits the insn if there is a
  164. reason to believe that it might improve instruction or delay slot
  165. scheduling.
  166.    The insn combiner phase also splits putative insns.  If three insns
  167. are merged into one insn with a complex expression that cannot be
  168. matched by some `define_insn' pattern, the combiner phase attempts to
  169. split the complex pattern into two insns that are recognized.  Usually
  170. it can break the complex pattern into two patterns by splitting out some
  171. subexpression.  However, in some other cases, such as performing an
  172. addition of a large constant in two insns on a RISC machine, the way to
  173. split the addition into two insns is machine-dependent.
  174.    The `define_split' definition tells the compiler how to split a
  175. complex insn into several simpler insns.  It looks like this:
  176.      (define_split
  177.        [INSN-PATTERN]
  178.        "CONDITION"
  179.        [NEW-INSN-PATTERN-1
  180.         NEW-INSN-PATTERN-2
  181.         ...]
  182.        "PREPARATION STATEMENTS")
  183.    INSN-PATTERN is a pattern that needs to be split and CONDITION is
  184. the final condition to be tested, as in a `define_insn'.  When an insn
  185. matching INSN-PATTERN and satisfying CONDITION is found, it is replaced
  186. in the insn list with the insns given by NEW-INSN-PATTERN-1,
  187. NEW-INSN-PATTERN-2, etc.
  188.    The PREPARATION STATEMENTS are similar to those specified for
  189. `define_expand' (*note Expander Definitions::.) and are executed before
  190. the new RTL is generated to prepare for the generated code or emit some
  191. insns whose pattern is not fixed.
  192.    Patterns are matched against INSN-PATTERN in two different
  193. circumstances.  If an insn needs to be split for delay slot scheduling
  194. or insn scheduling, the insn is already known to be valid, which means
  195. that it must have been matched by some `define_insn' and, if
  196. `reload_completed' is non-zero, is known to satisfy the constraints of
  197. that `define_insn'.  In that case, the new insn patterns must also be
  198. insns that are matched by some `define_insn' and, if `reload_completed'
  199. is non-zero, must also satisfy the constraints of those definitions.
  200.    As an example of this usage of `define_split', consider the following
  201. example from `a29k.md', which splits a `sign_extend' from `HImode' to
  202. `SImode' into a pair of shift insns:
  203.      (define_split
  204.        [(set (match_operand:SI 0 "gen_reg_operand" "")
  205.          (sign_extend:SI (match_operand:HI 1 "gen_reg_operand" "")))]
  206.        ""
  207.        [(set (match_dup 0)
  208.          (ashift:SI (match_dup 1)
  209.                 (const_int 16)))
  210.         (set (match_dup 0)
  211.          (ashiftrt:SI (match_dup 0)
  212.                   (const_int 16)))]
  213.        "
  214.      { operands[1] = gen_lowpart (SImode, operands[1]); }")
  215.    When the combiner phase tries to split an insn pattern, it is always
  216. the case that the pattern is *not* matched by any `define_insn'. The
  217. combiner pass first tries to split a single `set' expression and then
  218. the same `set' expression inside a `parallel', but followed by a
  219. `clobber' of a pseudo-reg to use as a scratch register.  In these
  220. cases, the combiner expects exactly two new insn patterns to be
  221. generated.  It will verify that these patterns match some `define_insn'
  222. definitions, so you need not do this test in the `define_split' (of
  223. course, there is no point in writing a `define_split' that will never
  224. produce insns that match).
  225.    Here is an example of this use of `define_split', taken from
  226. `rs6000.md':
  227.      (define_split
  228.        [(set (match_operand:SI 0 "gen_reg_operand" "")
  229.          (plus:SI (match_operand:SI 1 "gen_reg_operand" "")
  230.               (match_operand:SI 2 "non_add_cint_operand" "")))]
  231.        ""
  232.        [(set (match_dup 0) (plus:SI (match_dup 1) (match_dup 3)))
  233.         (set (match_dup 0) (plus:SI (match_dup 0) (match_dup 4)))]
  234.      "
  235.      {
  236.        int low = INTVAL (operands[2]) & 0xffff;
  237.        int high = (unsigned) INTVAL (operands[2]) >> 16;
  238.      
  239.        if (low & 0x8000)
  240.          high++, low |= 0xffff0000;
  241.      
  242.        operands[3] = gen_rtx (CONST_INT, VOIDmode, high << 16);
  243.        operands[4] = gen_rtx (CONST_INT, VOIDmode, low);
  244.      }")
  245.    Here the predicate `non_add_cint_operand' matches any `const_int'
  246. that is *not* a valid operand of a single add insn.  Write the add with
  247. the smaller displacement is written so that it can be substituted into
  248. the address of a subsequent operation.
  249.    An example that uses a scratch register, from the same file,
  250. generates an equality comparison of a register and a large constant:
  251.      (define_split
  252.        [(set (match_operand:CC 0 "cc_reg_operand" "")
  253.          (compare:CC (match_operand:SI 1 "gen_reg_operand" "")
  254.                  (match_operand:SI 2 "non_short_cint_operand" "")))
  255.         (clobber (match_operand:SI 3 "gen_reg_operand" ""))]
  256.        "find_single_use (operands[0], insn, 0)
  257.         && (GET_CODE (*find_single_use (operands[0], insn, 0)) == EQ
  258.             || GET_CODE (*find_single_use (operands[0], insn, 0)) == NE)"
  259.        [(set (match_dup 3) (xor:SI (match_dup 1) (match_dup 4)))
  260.         (set (match_dup 0) (compare:CC (match_dup 3) (match_dup 5)))]
  261.        "
  262.      {
  263.        /* Get the constant we are comparing against, C,  and see what it looks like
  264.           sign-extended to 16 bits.  Then see what constant could be XOR'ed
  265.           with C to get the sign-extended value.  */
  266.      
  267.        int c = INTVAL (operands[2]);
  268.        int sextc = (c << 16) >> 16;
  269.        int xorv = c ^ sextc;
  270.      
  271.        operands[4] = gen_rtx (CONST_INT, VOIDmode, xorv);
  272.        operands[5] = gen_rtx (CONST_INT, VOIDmode, sextc);
  273.      }")
  274.    To avoid confusion, don't write a single `define_split' that accepts
  275. some insns that match some `define_insn' as well as some insns that
  276. don't.  Instead, write two separate `define_split' definitions, one for
  277. the insns that are valid and one for the insns that are not valid.
  278. File: gcc.info,  Node: Insn Attributes,  Prev: Insn Splitting,  Up: Machine Desc
  279. Instruction Attributes
  280. ======================
  281.    In addition to describing the instruction supported by the target
  282. machine, the `md' file also defines a group of "attributes" and a set of
  283. values for each.  Every generated insn is assigned a value for each
  284. attribute. One possible attribute would be the effect that the insn has
  285. on the machine's condition code.  This attribute can then be used by
  286. `NOTICE_UPDATE_CC' to track the condition codes.
  287. * Menu:
  288. * Defining Attributes:: Specifying attributes and their values.
  289. * Expressions::         Valid expressions for attribute values.
  290. * Tagging Insns::       Assigning attribute values to insns.
  291. * Attr Example::        An example of assigning attributes.
  292. * Insn Lengths::        Computing the length of insns.
  293. * Constant Attributes:: Defining attributes that are constant.
  294. * Delay Slots::         Defining delay slots required for a machine.
  295. * Function Units::      Specifying information for insn scheduling.
  296. File: gcc.info,  Node: Defining Attributes,  Next: Expressions,  Prev: Insn Attributes,  Up: Insn Attributes
  297. Defining Attributes and their Values
  298. ------------------------------------
  299.    The `define_attr' expression is used to define each attribute
  300. required by the target machine.  It looks like:
  301.      (define_attr NAME LIST-OF-VALUES DEFAULT)
  302.    NAME is a string specifying the name of the attribute being defined.
  303.    LIST-OF-VALUES is either a string that specifies a comma-separated
  304. list of values that can be assigned to the attribute, or a null string
  305. to indicate that the attribute takes numeric values.
  306.    DEFAULT is an attribute expression that gives the value of this
  307. attribute for insns that match patterns whose definition does not
  308. include an explicit value for this attribute.  *Note Attr Example::,
  309. for more information on the handling of defaults.  *Note Constant
  310. Attributes::, for information on attributes that do not depend on any
  311. particular insn.
  312.    For each defined attribute, a number of definitions are written to
  313. the `insn-attr.h' file.  For cases where an explicit set of values is
  314. specified for an attribute, the following are defined:
  315.    * A `#define' is written for the symbol `HAVE_ATTR_NAME'.
  316.    * An enumeral class is defined for `attr_NAME' with elements of the
  317.      form `UPPER-NAME_UPPER-VALUE' where the attribute name and value
  318.      are first converted to upper case.
  319.    * A function `get_attr_NAME' is defined that is passed an insn and
  320.      returns the attribute value for that insn.
  321.    For example, if the following is present in the `md' file:
  322.      (define_attr "type" "branch,fp,load,store,arith" ...)
  323. the following lines will be written to the file `insn-attr.h'.
  324.      #define HAVE_ATTR_type
  325.      enum attr_type {TYPE_BRANCH, TYPE_FP, TYPE_LOAD,
  326.               TYPE_STORE, TYPE_ARITH};
  327.      extern enum attr_type get_attr_type ();
  328.    If the attribute takes numeric values, no `enum' type will be
  329. defined and the function to obtain the attribute's value will return
  330. `int'.
  331. File: gcc.info,  Node: Expressions,  Next: Tagging Insns,  Prev: Defining Attributes,  Up: Insn Attributes
  332. Attribute Expressions
  333. ---------------------
  334.    RTL expressions used to define attributes use the codes described
  335. above plus a few specific to attribute definitions, to be discussed
  336. below. Attribute value expressions must have one of the following forms:
  337. `(const_int I)'
  338.      The integer I specifies the value of a numeric attribute.  I must
  339.      be non-negative.
  340.      The value of a numeric attribute can be specified either with a
  341.      `const_int' or as an integer represented as a string in
  342.      `const_string', `eq_attr' (see below), and `set_attr' (*note
  343.      Tagging Insns::.) expressions.
  344. `(const_string VALUE)'
  345.      The string VALUE specifies a constant attribute value. If VALUE is
  346.      specified as `"*"', it means that the default value of the
  347.      attribute is to be used for the insn containing this expression.
  348.      `"*"' obviously cannot be used in the DEFAULT expression of a
  349.      `define_attr'.
  350.      If the attribute whose value is being specified is numeric, VALUE
  351.      must be a string containing a non-negative integer (normally
  352.      `const_int' would be used in this case).  Otherwise, it must
  353.      contain one of the valid values for the attribute.
  354. `(if_then_else TEST TRUE-VALUE FALSE-VALUE)'
  355.      TEST specifies an attribute test, whose format is defined below.
  356.      The value of this expression is TRUE-VALUE if TEST is true,
  357.      otherwise it is FALSE-VALUE.
  358. `(cond [TEST1 VALUE1 ...] DEFAULT)'
  359.      The first operand of this expression is a vector containing an even
  360.      number of expressions and consisting of pairs of TEST and VALUE
  361.      expressions.  The value of the `cond' expression is that of the
  362.      VALUE corresponding to the first true TEST expression.  If none of
  363.      the TEST expressions are true, the value of the `cond' expression
  364.      is that of the DEFAULT expression.
  365.    TEST expressions can have one of the following forms:
  366. `(const_int I)'
  367.      This test is true if I is non-zero and false otherwise.
  368. `(not TEST)'
  369. `(ior TEST1 TEST2)'
  370. `(and TEST1 TEST2)'
  371.      These tests are true if the indicated logical function is true.
  372. `(match_operand:M N PRED CONSTRAINTS)'
  373.      This test is true if operand N of the insn whose attribute value
  374.      is being determined has mode M (this part of the test is ignored
  375.      if M is `VOIDmode') and the function specified by the string PRED
  376.      returns a non-zero value when passed operand N and mode M (this
  377.      part of the test is ignored if PRED is the null string).
  378.      The CONSTRAINTS operand is ignored and should be the null string.
  379. `(le ARITH1 ARITH2)'
  380. `(leu ARITH1 ARITH2)'
  381. `(lt ARITH1 ARITH2)'
  382. `(ltu ARITH1 ARITH2)'
  383. `(gt ARITH1 ARITH2)'
  384. `(gtu ARITH1 ARITH2)'
  385. `(ge ARITH1 ARITH2)'
  386. `(geu ARITH1 ARITH2)'
  387. `(ne ARITH1 ARITH2)'
  388. `(eq ARITH1 ARITH2)'
  389.      These tests are true if the indicated comparison of the two
  390.      arithmetic expressions is true.  Arithmetic expressions are formed
  391.      with `plus', `minus', `mult', `div', `mod', `abs', `neg', `and',
  392.      `ior', `xor', `not', `lshift', `ashift', `lshiftrt', and `ashiftrt'
  393.      expressions.
  394.      `const_int' and `symbol_ref' are always valid terms (*note Insn
  395.      Lengths::.,for additional forms).  `symbol_ref' is a string
  396.      denoting a C expression that yields an `int' when evaluated by the
  397.      `get_attr_...' routine.  It should normally be a global variable.
  398. `(eq_attr NAME VALUE)'
  399.      NAME is a string specifying the name of an attribute.
  400.      VALUE is a string that is either a valid value for attribute NAME,
  401.      a comma-separated list of values, or `!' followed by a value or
  402.      list.  If VALUE does not begin with a `!', this test is true if
  403.      the value of the NAME attribute of the current insn is in the list
  404.      specified by VALUE.  If VALUE begins with a `!', this test is true
  405.      if the attribute's value is *not* in the specified list.
  406.      For example,
  407.           (eq_attr "type" "load,store")
  408.      is equivalent to
  409.           (ior (eq_attr "type" "load") (eq_attr "type" "store"))
  410.      If NAME specifies an attribute of `alternative', it refers to the
  411.      value of the compiler variable `which_alternative' (*note Output
  412.      Statement::.) and the values must be small integers.  For example,
  413.           (eq_attr "alternative" "2,3")
  414.      is equivalent to
  415.           (ior (eq (symbol_ref "which_alternative") (const_int 2))
  416.                (eq (symbol_ref "which_alternative") (const_int 3)))
  417.      Note that, for most attributes, an `eq_attr' test is simplified in
  418.      cases where the value of the attribute being tested is known for
  419.      all insns matching a particular pattern.  This is by far the most
  420.      common case.
  421. File: gcc.info,  Node: Tagging Insns,  Next: Attr Example,  Prev: Expressions,  Up: Insn Attributes
  422. Assigning Attribute Values to Insns
  423. -----------------------------------
  424.    The value assigned to an attribute of an insn is primarily
  425. determined by which pattern is matched by that insn (or which
  426. `define_peephole' generated it).  Every `define_insn' and
  427. `define_peephole' can have an optional last argument to specify the
  428. values of attributes for matching insns.  The value of any attribute
  429. not specified in a particular insn is set to the default value for that
  430. attribute, as specified in its `define_attr'.  Extensive use of default
  431. values for attributes permits the specification of the values for only
  432. one or two attributes in the definition of most insn patterns, as seen
  433. in the example in the next section.
  434.    The optional last argument of `define_insn' and `define_peephole' is
  435. a vector of expressions, each of which defines the value for a single
  436. attribute.  The most general way of assigning an attribute's value is
  437. to use a `set' expression whose first operand is an `attr' expression
  438. giving the name of the attribute being set.  The second operand of the
  439. `set' is an attribute expression (*note Expressions::.) giving the
  440. value of the attribute.
  441.    When the attribute value depends on the `alternative' attribute
  442. (i.e., which is the applicable alternative in the constraint of the
  443. insn), the `set_attr_alternative' expression can can be used.  It
  444. allows the specification of a vector of attribute expressions, one for
  445. each alternative.
  446.    When the generality of arbitrary attribute expressions is not
  447. required, the simpler `set_attr' expression can be used, which allows
  448. specifying a string giving either a single attribute value or a list of
  449. attribute values, one for each alternative.
  450.    The form of each of the above specifications is shown below.  In
  451. each case, NAME is a string specifying the attribute to be set.
  452. `(set_attr NAME VALUE-STRING)'
  453.      VALUE-STRING is either a string giving the desired attribute value,
  454.      or a string containing a comma-separated list giving the values for
  455.      succeeding alternatives.  The number of elements must match the
  456.      number of alternatives in the constraint of the insn pattern.
  457.      Note that it may be useful to specify `*' for some alternative, in
  458.      which case the attribute will assume its default value for insns
  459.      matching that alternative.
  460. `(set_attr_alternative NAME [VALUE1 VALUE2 ...])'
  461.      Depending on the alternative of the insn, the value will be one of
  462.      the specified values.  This is a shorthand for using a `cond' with
  463.      tests on the `alternative' attribute.
  464. `(set (attr NAME) VALUE)'
  465.      The first operand of this `set' must be the special RTL expression
  466.      `attr', whose sole operand is a string giving the name of the
  467.      attribute being set.  VALUE is the value of the attribute.
  468.    The following shows three different ways of representing the same
  469. attribute value specification:
  470.      (set_attr "type" "load,store,arith")
  471.      
  472.      (set_attr_alternative "type"
  473.                            [(const_string "load") (const_string "store")
  474.                             (const_string "arith")])
  475.      
  476.      (set (attr "type")
  477.           (cond [(eq_attr "alternative" "1") (const_string "load")
  478.                  (eq_attr "alternative" "2") (const_string "store")]
  479.                 (const_string "arith")))
  480.    The `define_asm_attributes' expression provides a mechanism to
  481. specify the attributes assigned to insns produced from an `asm'
  482. statement. It has the form:
  483.      (define_asm_attributes [ATTR-SETS])
  484. where ATTR-SETS is specified the same as for `define_insn' and
  485. `define_peephole' expressions.
  486.    These values will typically be the "worst case" attribute values. 
  487. For example, they might indicate that the condition code will be
  488. clobbered.
  489.    A specification for a `length' attribute is handled specially.  To
  490. compute the length of an `asm' insn, the length specified in the
  491. `define_asm_attributes' expression is multiplied by the number of
  492. machine instructions specified in the `asm' statement, determined by
  493. counting the number of semicolons and newlines in the string.
  494. Therefore, the value of the `length' attribute specified in a
  495. `define_asm_attributes' should be the maximum possible length of a
  496. single machine instruction.
  497. File: gcc.info,  Node: Attr Example,  Next: Insn Lengths,  Prev: Tagging Insns,  Up: Insn Attributes
  498. Example of Attribute Specifications
  499. -----------------------------------
  500.    The judicious use of defaulting is important in the efficient use of
  501. insn attributes.  Typically, insns are divided into "types" and an
  502. attribute, customarily called `type', is used to represent this value. 
  503. This attribute is normally used only to define the default value for
  504. other attributes.  An example will clarify this usage.
  505.    Assume we have a RISC machine with a condition code and in which only
  506. full-word operations are performed in registers.  Let us assume that we
  507. can divide all insns into loads, stores, (integer) arithmetic
  508. operations, floating point operations, and branches.
  509.    Here we will concern ourselves with determining the effect of an
  510. insn on the condition code and will limit ourselves to the following
  511. possible effects:  The condition code can be set unpredictably
  512. (clobbered), not be changed, be set to agree with the results of the
  513. operation, or only changed if the item previously set into the
  514. condition code has been modified.
  515.    Here is part of a sample `md' file for such a machine:
  516.      (define_attr "type" "load,store,arith,fp,branch" (const_string "arith"))
  517.      
  518.      (define_attr "cc" "clobber,unchanged,set,change0"
  519.                   (cond [(eq_attr "type" "load")
  520.                              (const_string "change0")
  521.                          (eq_attr "type" "store,branch")
  522.                              (const_string "unchanged")
  523.                          (eq_attr "type" "arith")
  524.                              (if_then_else (match_operand:SI 0 "" "")
  525.                                            (const_string "set")
  526.                                            (const_string "clobber"))]
  527.                         (const_string "clobber")))
  528.      
  529.      (define_insn ""
  530.        [(set (match_operand:SI 0 "general_operand" "=r,r,m")
  531.              (match_operand:SI 1 "general_operand" "r,m,r"))]
  532.        ""
  533.        "@
  534.         move %0,%1
  535.         load %0,%1
  536.         store %0,%1"
  537.        [(set_attr "type" "arith,load,store")])
  538.    Note that we assume in the above example that arithmetic operations
  539. performed on quantities smaller than a machine word clobber the
  540. condition code since they will set the condition code to a value
  541. corresponding to the full-word result.
  542. File: gcc.info,  Node: Insn Lengths,  Next: Constant Attributes,  Prev: Attr Example,  Up: Insn Attributes
  543. Computing the Length of an Insn
  544. -------------------------------
  545.    For many machines, multiple types of branch instructions are
  546. provided, each for different length branch displacements.  In most
  547. cases, the assembler will choose the correct instruction to use. 
  548. However, when the assembler cannot do so, GCC can when a special
  549. attribute, the `length' attribute, is defined.  This attribute must be
  550. defined to have numeric values by specifying a null string in its
  551. `define_attr'.
  552.    In the case of the `length' attribute, two additional forms of
  553. arithmetic terms are allowed in test expressions:
  554. `(match_dup N)'
  555.      This refers to the address of operand N of the current insn, which
  556.      must be a `label_ref'.
  557. `(pc)'
  558.      This refers to the address of the *current* insn.  It might have
  559.      been more consistent with other usage to make this the address of
  560.      the *next* insn but this would be confusing because the length of
  561.      the current insn is to be computed.
  562.    For normal insns, the length will be determined by value of the
  563. `length' attribute.  In the case of `addr_vec' and `addr_diff_vec' insn
  564. patterns, the length will be computed as the number of vectors
  565. multiplied by the size of each vector.
  566.    The following macros can be used to refine the length computation:
  567. `FIRST_INSN_ADDRESS'
  568.      When the `length' insn attribute is used, this macro specifies the
  569.      value to be assigned to the address of the first insn in a
  570.      function.  If not specified, 0 is used.
  571. `ADJUST_INSN_LENGTH (INSN, LENGTH)'
  572.      If defined, modifies the length assigned to instruction INSN as a
  573.      function of the context in which it is used.  LENGTH is an lvalue
  574.      that contains the initially computed length of the insn and should
  575.      be updated with the correct length of the insn.  If updating is
  576.      required, INSN must not be a varying-length insn.
  577.      This macro will normally not be required.  A case in which it is
  578.      required is the ROMP.  On this machine, the size of an `addr_vec'
  579.      insn must be increased by two to compensate for the fact that
  580.      alignment may be required.
  581.    The routine that returns the value of the `length' attribute,
  582. `get_attr_length', can be used by the output routine to determine the
  583. form of the branch instruction to be written, as the example below
  584. illustrates.
  585.    As an example of the specification of variable-length branches,
  586. consider the IBM 360.  If we adopt the convention that a register will
  587. be set to the starting address of a function, we can jump to labels
  588. within 4K of the start using a four-byte instruction.  Otherwise, we
  589. need a six-byte sequence to load the address from memory and then
  590. branch to it.
  591.    On such a machine, a pattern for a branch instruction might be
  592. specified as follows:
  593.      (define_insn "jump"
  594.        [(set (pc)
  595.              (label_ref (match_operand 0 "" "")))]
  596.        ""
  597.        "*
  598.      {
  599.         return (get_attr_length (insn) == 4
  600.                 ? \"b %l0\" : \"l r15,=a(%l0); br r15\");
  601.      }"
  602.        [(set (attr "length") (if_then_else (lt (match_dup 0) (const_int 4096))
  603.                                            (const_int 4)
  604.                                            (const_int 6)))])
  605. File: gcc.info,  Node: Constant Attributes,  Next: Delay Slots,  Prev: Insn Lengths,  Up: Insn Attributes
  606. Constant Attributes
  607. -------------------
  608.    A special form of `define_attr', where the expression for the
  609. default value is a `const' expression, indicates an attribute that is
  610. constant for a given run of the compiler.  Constant attributes may be
  611. used to specify which variety of processor is used.  For example,
  612.      (define_attr "cpu" "m88100,m88110,m88000"
  613.       (const
  614.        (cond [(symbol_ref "TARGET_88100") (const_string "m88100")
  615.           (symbol_ref "TARGET_88110") (const_string "m88110")]
  616.          (const_string "m88000"))))
  617.      
  618.      (define_attr "memory" "fast,slow"
  619.       (const
  620.        (if_then_else (symbol_ref "TARGET_FAST_MEM")
  621.              (const_string "fast")
  622.              (const_string "slow"))))
  623.    The routine generated for constant attributes has no parameters as it
  624. does not depend on any particular insn.  RTL expressions used to define
  625. the value of a constant attribute may use the `symbol_ref' form, but
  626. may not use either the `match_operand' form or `eq_attr' forms
  627. involving insn attributes.
  628. File: gcc.info,  Node: Delay Slots,  Next: Function Units,  Prev: Constant Attributes,  Up: Insn Attributes
  629. Delay Slot Scheduling
  630. ---------------------
  631.    The insn attribute mechanism can be used to specify the requirements
  632. for delay slots, if any, on a target machine.  An instruction is said to
  633. require a "delay slot" if some instructions that are physically after
  634. the instruction are executed as if they were located before it. Classic
  635. examples are branch and call instructions, which often execute the
  636. following instruction before the branch or call is performed.
  637.    On some machines, conditional branch instructions can optionally
  638. "annul" instructions in the delay slot.  This means that the
  639. instruction will not be executed for certain branch outcomes.  Both
  640. instructions that annul if the branch is true and instructions that
  641. annul if the branch is false are supported.
  642.    Delay slot scheduling differs from instruction scheduling in that
  643. determining whether an instruction needs a delay slot is dependent only
  644. on the type of instruction being generated, not on data flow between the
  645. instructions.  See the next section for a discussion of data-dependent
  646. instruction scheduling.
  647.    The requirement of an insn needing one or more delay slots is
  648. indicated via the `define_delay' expression.  It has the following form:
  649.      (define_delay TEST
  650.                    [DELAY-1 ANNUL-TRUE-1 ANNUL-FALSE-1
  651.                     DELAY-2 ANNUL-TRUE-2 ANNUL-FALSE-2
  652.                     ...])
  653.    TEST is an attribute test that indicates whether this `define_delay'
  654. applies to a particular insn.  If so, the number of required delay
  655. slots is determined by the length of the vector specified as the second
  656. argument.  An insn placed in delay slot N must satisfy attribute test
  657. DELAY-N.  ANNUL-TRUE-N is an attribute test that specifies which insns
  658. may be annulled if the branch is true.  Similarly, ANNUL-FALSE-N
  659. specifies which insns in the delay slot may be annulled if the branch
  660. is false.  If annulling is not supported for that delay slot, `(nil)'
  661. should be coded.
  662.    For example, in the common case where branch and call insns require
  663. a single delay slot, which may contain any insn other than a branch or
  664. call, the following would be placed in the `md' file:
  665.      (define_delay (eq_attr "type" "branch,call")
  666.                    [(eq_attr "type" "!branch,call") (nil) (nil)])
  667.    Multiple `define_delay' expressions may be specified.  In this case,
  668. each such expression specifies different delay slot requirements and
  669. there must be no insn for which tests in two `define_delay' expressions
  670. are both true.
  671.    For example, if we have a machine that requires one delay slot for
  672. branches but two for calls,  no delay slot can contain a branch or call
  673. insn, and any valid insn in the delay slot for the branch can be
  674. annulled if the branch is true, we might represent this as follows:
  675.      (define_delay (eq_attr "type" "branch")
  676.         [(eq_attr "type" "!branch,call") (eq_attr "type" "!branch,call") (nil)])
  677.      
  678.      (define_delay (eq_attr "type" "call")
  679.                    [(eq_attr "type" "!branch,call") (nil) (nil)
  680.                     (eq_attr "type" "!branch,call") (nil) (nil)])
  681. File: gcc.info,  Node: Function Units,  Prev: Delay Slots,  Up: Insn Attributes
  682. Specifying Function Units
  683. -------------------------
  684.    On most RISC machines, there are instructions whose results are not
  685. available for a specific number of cycles.  Common cases are
  686. instructions that load data from memory.  On many machines, a pipeline
  687. stall will result if the data is referenced too soon after the load
  688. instruction.
  689.    In addition, many newer microprocessors have multiple function
  690. units, usually one for integer and one for floating point, and often
  691. will incur pipeline stalls when a result that is needed is not yet
  692. ready.
  693.    The descriptions in this section allow the specification of how much
  694. time must elapse between the execution of an instruction and the time
  695. when its result is used.  It also allows specification of when the
  696. execution of an instruction will delay execution of similar instructions
  697. due to function unit conflicts.
  698.    For the purposes of the specifications in this section, a machine is
  699. divided into "function units", each of which execute a specific class
  700. of instructions.  Function units that accept one instruction each cycle
  701. and allow a result to be used in the succeeding instruction (usually
  702. via forwarding) need not be specified.  Classic RISC microprocessors
  703. will normally have a single function unit, which we can call `memory'. 
  704. The newer "superscalar" processors will often have function units for
  705. floating point operations, usually at least a floating point adder and
  706. multiplier.
  707.    Each usage of a function units by a class of insns is specified with
  708. a `define_function_unit' expression, which looks like this:
  709.      (define_function_unit NAME MULTIPLICITY SIMULTANEITY
  710.                    TEST READY-DELAY BUSY-DELAY
  711.                   [CONFLICT-LIST])
  712.    NAME is a string giving the name of the function unit.
  713.    MULTIPLICITY is an integer specifying the number of identical units
  714. in the processor.  If more than one unit is specified, they will be
  715. scheduled independently.  Only truly independent units should be
  716. counted; a pipelined unit should be specified as a single unit.  (The
  717. only common example of a machine that has multiple function units for a
  718. single instruction class that are truly independent and not pipelined
  719. are the two multiply and two increment units of the CDC 6600.)
  720.    SIMULTANEITY specifies the maximum number of insns that can be
  721. executing in each instance of the function unit simultaneously or zero
  722. if the unit is pipelined and has no limit.
  723.    All `define_function_unit' definitions referring to function unit
  724. NAME must have the same name and values for MULTIPLICITY and
  725. SIMULTANEITY.
  726.    TEST is an attribute test that selects the insns we are describing
  727. in this definition.  Note that an insn may use more than one function
  728. unit and a function unit may be specified in more than one
  729. `define_function_unit'.
  730.    READY-DELAY is an integer that specifies the number of cycles after
  731. which the result of the instruction can be used without introducing any
  732. stalls.
  733.    BUSY-DELAY is an integer that represents the default cost if an insn
  734. is scheduled for this unit while the unit is active with another insn. 
  735. If SIMULTANEITY is zero, this specification is ignored. Otherwise, a
  736. zero value indicates that these insns execute on NAME in a fully
  737. pipelined fashion, even if SIMULTANEITY is non-zero.  A non-zero value
  738. indicates that scheduling a new insn on this unit while another is
  739. active will incur a cost.  A cost of two indicates a single cycle
  740. delay.  For a normal non-pipelined function unit, BUSY-DELAY will be
  741. twice READY-DELAY.
  742.    CONFLICT-LIST is an optional list giving detailed conflict costs for
  743. this unit.  If specified, it is a list of condition test expressions
  744. which are applied to insns already executing in NAME.  For each insn
  745. that is in the list, BUSY-DELAY will be used for the conflict cost,
  746. while a value of zero will be used for insns not in the list.
  747.    Typical uses of this vector are where a floating point function unit
  748. can pipeline either single- or double-precision operations, but not
  749. both, or where a memory unit can pipeline loads, but not stores, etc.
  750.    As an example, consider a classic RISC machine where the result of a
  751. load instruction is not available for two cycles (a single "delay"
  752. instruction is required) and where only one load instruction can be
  753. executed simultaneously.  This would be specified as:
  754.      (define_function_unit "memory" 1 1 (eq_attr "type" "load") 2 4)
  755.    For the case of a floating point function unit that can pipeline
  756. either single or double precision, but not both, the following could be
  757. specified:
  758.      (define_function_unit
  759.         "fp" 1 1 (eq_attr "type" "sp_fp") 4 8 (eq_attr "type" "dp_fp")]
  760.      (define_function_unit
  761.         "fp" 1 1 (eq_attr "type" "dp_fp") 4 8 (eq_attr "type" "sp_fp")]
  762.    *Note:* No code currently exists to avoid function unit conflicts,
  763. only data conflicts.  Hence MULTIPLICITY, SIMULTANEITY, BUSY-COST, and
  764. CONFLICT-LIST are currently ignored.  When such code is written, it is
  765. possible that the specifications for these values may be changed.  It
  766. has recently come to our attention that these specifications may not
  767. allow modeling of some of the newer "superscalar" processors that have
  768. insns using multiple pipelined units.  These insns will cause a
  769. potential conflict for the second unit used during their execution and
  770. there is no way of representing that conflict.  We welcome any examples
  771. of how function unit conflicts work in such processors and suggestions
  772. for their representation.
  773. File: gcc.info,  Node: Target Macros,  Next: Config,  Prev: Machine Desc,  Up: Top
  774. Target Description Macros
  775. *************************
  776.    In addition to the file `MACHINE.md', a machine description includes
  777. a C header file conventionally given the name `MACHINE.h'.  This header
  778. file defines numerous macros that convey the information about the
  779. target machine that does not fit into the scheme of the `.md' file. 
  780. The file `tm.h' should be a link to `MACHINE.h'.  The header file
  781. `config.h' includes `tm.h' and most compiler source files include
  782. `config.h'.
  783. * Menu:
  784. * Driver::              Controlling how the driver runs the compilation passes.
  785. * Run-time Target::     Defining `-m' options like `-m68000' and `-m68020'.
  786. * Storage Layout::      Defining sizes and alignments of data.
  787. * Type Layout::         Defining sizes and properties of basic user data types.
  788. * Registers::           Naming and describing the hardware registers.
  789. * Register Classes::    Defining the classes of hardware registers.
  790. * Stack and Calling::   Defining which way the stack grows and by how much.
  791. * Varargs::        Defining the varargs macros.
  792. * Trampolines::         Code set up at run time to enter a nested function.
  793. * Library Calls::       Controlling how library routines are implicitly called.
  794. * Addressing Modes::    Defining addressing modes valid for memory operands.
  795. * Condition Code::      Defining how insns update the condition code.
  796. * Costs::               Defining relative costs of different operations.
  797. * Sections::            Dividing storage into text, data, and other sections.
  798. * PIC::            Macros for position independent code.
  799. * Assembler Format::    Defining how to write insns and pseudo-ops to output.
  800. * Debugging Info::      Defining the format of debugging output.
  801. * Cross-compilation::   Handling floating point for cross-compilers.
  802. * Misc::                Everything else.
  803.