home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 2 / goldfish_vol2_cd1.bin / gnu / info / gcc.info-12 (.txt) < prev    next >
GNU Info File  |  1994-11-17  |  51KB  |  900 lines

  1. This is Info file gcc.info, produced by Makeinfo-1.55 from the input
  2. file gcc.texi.
  3.    This file documents the use and the internals of the GNU compiler.
  4.    Published by the Free Software Foundation 675 Massachusetts Avenue
  5. Cambridge, MA 02139 USA
  6.    Copyright (C) 1988, 1989, 1992, 1993, 1994 Free Software Foundation,
  7.    Permission is granted to make and distribute verbatim copies of this
  8. manual provided the copyright notice and this permission notice are
  9. preserved on all copies.
  10.    Permission is granted to copy and distribute modified versions of
  11. this manual under the conditions for verbatim copying, provided also
  12. that the sections entitled "GNU General Public License," "Funding for
  13. Free Software," and "Protect Your Freedom--Fight `Look And Feel'" are
  14. included exactly as in the original, and provided that the entire
  15. resulting derived work is distributed under the terms of a permission
  16. notice identical to this one.
  17.    Permission is granted to copy and distribute translations of this
  18. manual into another language, under the above conditions for modified
  19. versions, except that the sections entitled "GNU General Public
  20. License," "Funding for Free Software," and "Protect Your Freedom--Fight
  21. `Look And Feel'", and this permission notice, may be included in
  22. translations approved by the Free Software Foundation instead of in the
  23. original English.
  24. File: gcc.info,  Node: Passes,  Next: RTL,  Prev: Interface,  Up: Top
  25. Passes and Files of the Compiler
  26. ********************************
  27.    The overall control structure of the compiler is in `toplev.c'.  This
  28. file is responsible for initialization, decoding arguments, opening and
  29. closing files, and sequencing the passes.
  30.    The parsing pass is invoked only once, to parse the entire input.
  31. The RTL intermediate code for a function is generated as the function
  32. is parsed, a statement at a time.  Each statement is read in as a
  33. syntax tree and then converted to RTL; then the storage for the tree
  34. for the statement is reclaimed.  Storage for types (and the expressions
  35. for their sizes), declarations, and a representation of the binding
  36. contours and how they nest, remain until the function is finished being
  37. compiled; these are all needed to output the debugging information.
  38.    Each time the parsing pass reads a complete function definition or
  39. top-level declaration, it calls either the function
  40. `rest_of_compilation', or the function `rest_of_decl_compilation' in
  41. `toplev.c', which are responsible for all further processing necessary,
  42. ending with output of the assembler language.  All other compiler
  43. passes run, in sequence, within `rest_of_compilation'.  When that
  44. function returns from compiling a function definition, the storage used
  45. for that function definition's compilation is entirely freed, unless it
  46. is an inline function (*note An Inline Function is As Fast As a Macro:
  47. Inline.).
  48.    Here is a list of all the passes of the compiler and their source
  49. files.  Also included is a description of where debugging dumps can be
  50. requested with `-d' options.
  51.    * Parsing.  This pass reads the entire text of a function definition,
  52.      constructing partial syntax trees.  This and RTL generation are no
  53.      longer truly separate passes (formerly they were), but it is
  54.      easier to think of them as separate.
  55.      The tree representation does not entirely follow C syntax, because
  56.      it is intended to support other languages as well.
  57.      Language-specific data type analysis is also done in this pass,
  58.      and every tree node that represents an expression has a data type
  59.      attached.  Variables are represented as declaration nodes.
  60.      Constant folding and some arithmetic simplifications are also done
  61.      during this pass.
  62.      The language-independent source files for parsing are
  63.      `stor-layout.c', `fold-const.c', and `tree.c'.  There are also
  64.      header files `tree.h' and `tree.def' which define the format of
  65.      the tree representation.
  66.      The source files to parse C are `c-parse.in', `c-decl.c',
  67.      `c-typeck.c', `c-aux-info.c', `c-convert.c', and `c-lang.c' along
  68.      with header files `c-lex.h', and `c-tree.h'.
  69.      The source files for parsing C++ are `cp-parse.y', `cp-class.c',
  70.      `cp-cvt.c', `cp-decl.c', `cp-decl2.c', `cp-dem.c', `cp-except.c',
  71.      `cp-expr.c', `cp-init.c', `cp-lex.c', `cp-method.c', `cp-ptree.c',
  72.      `cp-search.c', `cp-tree.c', `cp-type2.c', and `cp-typeck.c', along
  73.      with header files `cp-tree.def', `cp-tree.h', and `cp-decl.h'.
  74.      The special source files for parsing Objective C are
  75.      `objc-parse.y', `objc-actions.c', `objc-tree.def', and
  76.      `objc-actions.h'.  Certain C-specific files are used for this as
  77.      well.
  78.      The file `c-common.c' is also used for all of the above languages.
  79.    * RTL generation.  This is the conversion of syntax tree into RTL
  80.      code.  It is actually done statement-by-statement during parsing,
  81.      but for most purposes it can be thought of as a separate pass.
  82.      This is where the bulk of target-parameter-dependent code is found,
  83.      since often it is necessary for strategies to apply only when
  84.      certain standard kinds of instructions are available.  The purpose
  85.      of named instruction patterns is to provide this information to
  86.      the RTL generation pass.
  87.      Optimization is done in this pass for `if'-conditions that are
  88.      comparisons, boolean operations or conditional expressions.  Tail
  89.      recursion is detected at this time also.  Decisions are made about
  90.      how best to arrange loops and how to output `switch' statements.
  91.      The source files for RTL generation include `stmt.c', `calls.c',
  92.      `expr.c', `explow.c', `expmed.c', `function.c', `optabs.c' and
  93.      `emit-rtl.c'.  Also, the file `insn-emit.c', generated from the
  94.      machine description by the program `genemit', is used in this
  95.      pass.  The header file `expr.h' is used for communication within
  96.      this pass.
  97.      The header files `insn-flags.h' and `insn-codes.h', generated from
  98.      the machine description by the programs `genflags' and `gencodes',
  99.      tell this pass which standard names are available for use and
  100.      which patterns correspond to them.
  101.      Aside from debugging information output, none of the following
  102.      passes refers to the tree structure representation of the function
  103.      (only part of which is saved).
  104.      The decision of whether the function can and should be expanded
  105.      inline in its subsequent callers is made at the end of rtl
  106.      generation.  The function must meet certain criteria, currently
  107.      related to the size of the function and the types and number of
  108.      parameters it has.  Note that this function may contain loops,
  109.      recursive calls to itself (tail-recursive functions can be
  110.      inlined!), gotos, in short, all constructs supported by GNU CC.
  111.      The file `integrate.c' contains the code to save a function's rtl
  112.      for later inlining and to inline that rtl when the function is
  113.      called.  The header file `integrate.h' is also used for this
  114.      purpose.
  115.      The option `-dr' causes a debugging dump of the RTL code after
  116.      this pass.  This dump file's name is made by appending `.rtl' to
  117.      the input file name.
  118.    * Jump optimization.  This pass simplifies jumps to the following
  119.      instruction, jumps across jumps, and jumps to jumps.  It deletes
  120.      unreferenced labels and unreachable code, except that unreachable
  121.      code that contains a loop is not recognized as unreachable in this
  122.      pass.  (Such loops are deleted later in the basic block analysis.)
  123.      It also converts some code originally written with jumps into
  124.      sequences of instructions that directly set values from the
  125.      results of comparisons, if the machine has such instructions.
  126.      Jump optimization is performed two or three times.  The first time
  127.      is immediately following RTL generation.  The second time is after
  128.      CSE, but only if CSE says repeated jump optimization is needed.
  129.      The last time is right before the final pass.  That time,
  130.      cross-jumping and deletion of no-op move instructions are done
  131.      together with the optimizations described above.
  132.      The source file of this pass is `jump.c'.
  133.      The option `-dj' causes a debugging dump of the RTL code after
  134.      this pass is run for the first time.  This dump file's name is
  135.      made by appending `.jump' to the input file name.
  136.    * Register scan.  This pass finds the first and last use of each
  137.      register, as a guide for common subexpression elimination.  Its
  138.      source is in `regclass.c'.
  139.    * Jump threading.  This pass detects a condition jump that branches
  140.      to an identical or inverse test.  Such jumps can be `threaded'
  141.      through the second conditional test.  The source code for this
  142.      pass is in `jump.c'.  This optimization is only performed if
  143.      `-fthread-jumps' is enabled.
  144.    * Common subexpression elimination.  This pass also does constant
  145.      propagation.  Its source file is `cse.c'.  If constant propagation
  146.      causes conditional jumps to become unconditional or to become
  147.      no-ops, jump optimization is run again when CSE is finished.
  148.      The option `-ds' causes a debugging dump of the RTL code after
  149.      this pass.  This dump file's name is made by appending `.cse' to
  150.      the input file name.
  151.    * Loop optimization.  This pass moves constant expressions out of
  152.      loops, and optionally does strength-reduction and loop unrolling
  153.      as well.  Its source files are `loop.c' and `unroll.c', plus the
  154.      header `loop.h' used for communication between them.  Loop
  155.      unrolling uses some functions in `integrate.c' and the header
  156.      `integrate.h'.
  157.      The option `-dL' causes a debugging dump of the RTL code after
  158.      this pass.  This dump file's name is made by appending `.loop' to
  159.      the input file name.
  160.    * If `-frerun-cse-after-loop' was enabled, a second common
  161.      subexpression elimination pass is performed after the loop
  162.      optimization pass.  Jump threading is also done again at this time
  163.      if it was specified.
  164.      The option `-dt' causes a debugging dump of the RTL code after
  165.      this pass.  This dump file's name is made by appending `.cse2' to
  166.      the input file name.
  167.    * Stupid register allocation is performed at this point in a
  168.      nonoptimizing compilation.  It does a little data flow analysis as
  169.      well.  When stupid register allocation is in use, the next pass
  170.      executed is the reloading pass; the others in between are skipped.
  171.      The source file is `stupid.c'.
  172.    * Data flow analysis (`flow.c').  This pass divides the program into
  173.      basic blocks (and in the process deletes unreachable loops); then
  174.      it computes which pseudo-registers are live at each point in the
  175.      program, and makes the first instruction that uses a value point at
  176.      the instruction that computed the value.
  177.      This pass also deletes computations whose results are never used,
  178.      and combines memory references with add or subtract instructions
  179.      to make autoincrement or autodecrement addressing.
  180.      The option `-df' causes a debugging dump of the RTL code after
  181.      this pass.  This dump file's name is made by appending `.flow' to
  182.      the input file name.  If stupid register allocation is in use, this
  183.      dump file reflects the full results of such allocation.
  184.    * Instruction combination (`combine.c').  This pass attempts to
  185.      combine groups of two or three instructions that are related by
  186.      data flow into single instructions.  It combines the RTL
  187.      expressions for the instructions by substitution, simplifies the
  188.      result using algebra, and then attempts to match the result
  189.      against the machine description.
  190.      The option `-dc' causes a debugging dump of the RTL code after
  191.      this pass.  This dump file's name is made by appending `.combine'
  192.      to the input file name.
  193.    * Instruction scheduling (`sched.c').  This pass looks for
  194.      instructions whose output will not be available by the time that
  195.      it is used in subsequent instructions.  (Memory loads and floating
  196.      point instructions often have this behavior on RISC machines).  It
  197.      re-orders instructions within a basic block to try to separate the
  198.      definition and use of items that otherwise would cause pipeline
  199.      stalls.
  200.      Instruction scheduling is performed twice.  The first time is
  201.      immediately after instruction combination and the second is
  202.      immediately after reload.
  203.      The option `-dS' causes a debugging dump of the RTL code after this
  204.      pass is run for the first time.  The dump file's name is made by
  205.      appending `.sched' to the input file name.
  206.    * Register class preferencing.  The RTL code is scanned to find out
  207.      which register class is best for each pseudo register.  The source
  208.      file is `regclass.c'.
  209.    * Local register allocation (`local-alloc.c').  This pass allocates
  210.      hard registers to pseudo registers that are used only within one
  211.      basic block.  Because the basic block is linear, it can use fast
  212.      and powerful techniques to do a very good job.
  213.      The option `-dl' causes a debugging dump of the RTL code after
  214.      this pass.  This dump file's name is made by appending `.lreg' to
  215.      the input file name.
  216.    * Global register allocation (`global.c').  This pass allocates hard
  217.      registers for the remaining pseudo registers (those whose life
  218.      spans are not contained in one basic block).
  219.    * Reloading.  This pass renumbers pseudo registers with the hardware
  220.      registers numbers they were allocated.  Pseudo registers that did
  221.      not get hard registers are replaced with stack slots.  Then it
  222.      finds instructions that are invalid because a value has failed to
  223.      end up in a register, or has ended up in a register of the wrong
  224.      kind.  It fixes up these instructions by reloading the
  225.      problematical values temporarily into registers.  Additional
  226.      instructions are generated to do the copying.
  227.      The reload pass also optionally eliminates the frame pointer and
  228.      inserts instructions to save and restore call-clobbered registers
  229.      around calls.
  230.      Source files are `reload.c' and `reload1.c', plus the header
  231.      `reload.h' used for communication between them.
  232.      The option `-dg' causes a debugging dump of the RTL code after
  233.      this pass.  This dump file's name is made by appending `.greg' to
  234.      the input file name.
  235.    * Instruction scheduling is repeated here to try to avoid pipeline
  236.      stalls due to memory loads generated for spilled pseudo registers.
  237.      The option `-dR' causes a debugging dump of the RTL code after
  238.      this pass.  This dump file's name is made by appending `.sched2'
  239.      to the input file name.
  240.    * Jump optimization is repeated, this time including cross-jumping
  241.      and deletion of no-op move instructions.
  242.      The option `-dJ' causes a debugging dump of the RTL code after
  243.      this pass.  This dump file's name is made by appending `.jump2' to
  244.      the input file name.
  245.    * Delayed branch scheduling.  This optional pass attempts to find
  246.      instructions that can go into the delay slots of other
  247.      instructions, usually jumps and calls.  The source file name is
  248.      `reorg.c'.
  249.      The option `-dd' causes a debugging dump of the RTL code after
  250.      this pass.  This dump file's name is made by appending `.dbr' to
  251.      the input file name.
  252.    * Conversion from usage of some hard registers to usage of a register
  253.      stack may be done at this point.  Currently, this is supported only
  254.      for the floating-point registers of the Intel 80387 coprocessor.
  255.      The source file name is `reg-stack.c'.
  256.      The options `-dk' causes a debugging dump of the RTL code after
  257.      this pass.  This dump file's name is made by appending `.stack' to
  258.      the input file name.
  259.    * Final.  This pass outputs the assembler code for the function.  It
  260.      is also responsible for identifying spurious test and compare
  261.      instructions.  Machine-specific peephole optimizations are
  262.      performed at the same time.  The function entry and exit sequences
  263.      are generated directly as assembler code in this pass; they never
  264.      exist as RTL.
  265.      The source files are `final.c' plus `insn-output.c'; the latter is
  266.      generated automatically from the machine description by the tool
  267.      `genoutput'.  The header file `conditions.h' is used for
  268.      communication between these files.
  269.    * Debugging information output.  This is run after final because it
  270.      must output the stack slot offsets for pseudo registers that did
  271.      not get hard registers.  Source files are `dbxout.c' for DBX
  272.      symbol table format, `sdbout.c' for SDB symbol table format, and
  273.      `dwarfout.c' for DWARF symbol table format.
  274.    Some additional files are used by all or many passes:
  275.    * Every pass uses `machmode.def' and `machmode.h' which define the
  276.      machine modes.
  277.    * Several passes use `real.h', which defines the default
  278.      representation of floating point constants and how to operate on
  279.      them.
  280.    * All the passes that work with RTL use the header files `rtl.h' and
  281.      `rtl.def', and subroutines in file `rtl.c'.  The tools `gen*' also
  282.      use these files to read and work with the machine description RTL.
  283.    * Several passes refer to the header file `insn-config.h' which
  284.      contains a few parameters (C macro definitions) generated
  285.      automatically from the machine description RTL by the tool
  286.      `genconfig'.
  287.    * Several passes use the instruction recognizer, which consists of
  288.      `recog.c' and `recog.h', plus the files `insn-recog.c' and
  289.      `insn-extract.c' that are generated automatically from the machine
  290.      description by the tools `genrecog' and `genextract'.
  291.    * Several passes use the header files `regs.h' which defines the
  292.      information recorded about pseudo register usage, and
  293.      `basic-block.h' which defines the information recorded about basic
  294.      blocks.
  295.    * `hard-reg-set.h' defines the type `HARD_REG_SET', a bit-vector
  296.      with a bit for each hard register, and some macros to manipulate
  297.      it.  This type is just `int' if the machine has few enough hard
  298.      registers; otherwise it is an array of `int' and some of the
  299.      macros expand into loops.
  300.    * Several passes use instruction attributes.  A definition of the
  301.      attributes defined for a particular machine is in file
  302.      `insn-attr.h', which is generated from the machine description by
  303.      the program `genattr'.  The file `insn-attrtab.c' contains
  304.      subroutines to obtain the attribute values for insns.  It is
  305.      generated from the machine description by the program `genattrtab'.
  306. File: gcc.info,  Node: RTL,  Next: Machine Desc,  Prev: Passes,  Up: Top
  307. RTL Representation
  308. ******************
  309.    Most of the work of the compiler is done on an intermediate
  310. representation called register transfer language.  In this language,
  311. the instructions to be output are described, pretty much one by one, in
  312. an algebraic form that describes what the instruction does.
  313.    RTL is inspired by Lisp lists.  It has both an internal form, made
  314. up of structures that point at other structures, and a textual form
  315. that is used in the machine description and in printed debugging dumps.
  316. The textual form uses nested parentheses to indicate the pointers in
  317. the internal form.
  318. * Menu:
  319. * RTL Objects::       Expressions vs vectors vs strings vs integers.
  320. * Accessors::         Macros to access expression operands or vector elts.
  321. * Flags::             Other flags in an RTL expression.
  322. * Machine Modes::     Describing the size and format of a datum.
  323. * Constants::         Expressions with constant values.
  324. * Regs and Memory::   Expressions representing register contents or memory.
  325. * Arithmetic::        Expressions representing arithmetic on other expressions.
  326. * Comparisons::       Expressions representing comparison of expressions.
  327. * Bit Fields::        Expressions representing bitfields in memory or reg.
  328. * Conversions::       Extending, truncating, floating or fixing.
  329. * RTL Declarations::  Declaring volatility, constancy, etc.
  330. * Side Effects::      Expressions for storing in registers, etc.
  331. * Incdec::            Embedded side-effects for autoincrement addressing.
  332. * Assembler::         Representing `asm' with operands.
  333. * Insns::             Expression types for entire insns.
  334. * Calls::             RTL representation of function call insns.
  335. * Sharing::           Some expressions are unique; others *must* be copied.
  336. * Reading RTL::       Reading textual RTL from a file.
  337. File: gcc.info,  Node: RTL Objects,  Next: Accessors,  Prev: RTL,  Up: RTL
  338. RTL Object Types
  339. ================
  340.    RTL uses five kinds of objects: expressions, integers, wide integers,
  341. strings and vectors.  Expressions are the most important ones.  An RTL
  342. expression ("RTX", for short) is a C structure, but it is usually
  343. referred to with a pointer; a type that is given the typedef name `rtx'.
  344.    An integer is simply an `int'; their written form uses decimal
  345. digits.  A wide integer is an integral object whose type is
  346. `HOST_WIDE_INT' (*note Config::.); their written form uses decimal
  347. digits.
  348.    A string is a sequence of characters.  In core it is represented as a
  349. `char *' in usual C fashion, and it is written in C syntax as well.
  350. However, strings in RTL may never be null.  If you write an empty
  351. string in a machine description, it is represented in core as a null
  352. pointer rather than as a pointer to a null character.  In certain
  353. contexts, these null pointers instead of strings are valid.  Within RTL
  354. code, strings are most commonly found inside `symbol_ref' expressions,
  355. but they appear in other contexts in the RTL expressions that make up
  356. machine descriptions.
  357.    A vector contains an arbitrary number of pointers to expressions.
  358. The number of elements in the vector is explicitly present in the
  359. vector.  The written form of a vector consists of square brackets
  360. (`[...]') surrounding the elements, in sequence and with whitespace
  361. separating them.  Vectors of length zero are not created; null pointers
  362. are used instead.
  363.    Expressions are classified by "expression codes" (also called RTX
  364. codes).  The expression code is a name defined in `rtl.def', which is
  365. also (in upper case) a C enumeration constant.  The possible expression
  366. codes and their meanings are machine-independent.  The code of an RTX
  367. can be extracted with the macro `GET_CODE (X)' and altered with
  368. `PUT_CODE (X, NEWCODE)'.
  369.    The expression code determines how many operands the expression
  370. contains, and what kinds of objects they are.  In RTL, unlike Lisp, you
  371. cannot tell by looking at an operand what kind of object it is.
  372. Instead, you must know from its context--from the expression code of
  373. the containing expression.  For example, in an expression of code
  374. `subreg', the first operand is to be regarded as an expression and the
  375. second operand as an integer.  In an expression of code `plus', there
  376. are two operands, both of which are to be regarded as expressions.  In
  377. a `symbol_ref' expression, there is one operand, which is to be
  378. regarded as a string.
  379.    Expressions are written as parentheses containing the name of the
  380. expression type, its flags and machine mode if any, and then the
  381. operands of the expression (separated by spaces).
  382.    Expression code names in the `md' file are written in lower case,
  383. but when they appear in C code they are written in upper case.  In this
  384. manual, they are shown as follows: `const_int'.
  385.    In a few contexts a null pointer is valid where an expression is
  386. normally wanted.  The written form of this is `(nil)'.
  387. File: gcc.info,  Node: Accessors,  Next: Flags,  Prev: RTL Objects,  Up: RTL
  388. Access to Operands
  389. ==================
  390.    For each expression type `rtl.def' specifies the number of contained
  391. objects and their kinds, with four possibilities: `e' for expression
  392. (actually a pointer to an expression), `i' for integer, `w' for wide
  393. integer, `s' for string, and `E' for vector of expressions.  The
  394. sequence of letters for an expression code is called its "format".
  395. Thus, the format of `subreg' is `ei'.
  396.    A few other format characters are used occasionally:
  397.      `u' is equivalent to `e' except that it is printed differently in
  398.      debugging dumps.  It is used for pointers to insns.
  399.      `n' is equivalent to `i' except that it is printed differently in
  400.      debugging dumps.  It is used for the line number or code number of
  401.      a `note' insn.
  402.      `S' indicates a string which is optional.  In the RTL objects in
  403.      core, `S' is equivalent to `s', but when the object is read, from
  404.      an `md' file, the string value of this operand may be omitted.  An
  405.      omitted string is taken to be the null string.
  406.      `V' indicates a vector which is optional.  In the RTL objects in
  407.      core, `V' is equivalent to `E', but when the object is read from
  408.      an `md' file, the vector value of this operand may be omitted.  An
  409.      omitted vector is effectively the same as a vector of no elements.
  410.      `0' means a slot whose contents do not fit any normal category.
  411.      `0' slots are not printed at all in dumps, and are often used in
  412.      special ways by small parts of the compiler.
  413.    There are macros to get the number of operands, the format, and the
  414. class of an expression code:
  415. `GET_RTX_LENGTH (CODE)'
  416.      Number of operands of an RTX of code CODE.
  417. `GET_RTX_FORMAT (CODE)'
  418.      The format of an RTX of code CODE, as a C string.
  419. `GET_RTX_CLASS (CODE)'
  420.      A single character representing the type of RTX operation that code
  421.      CODE performs.
  422.      The following classes are defined:
  423.     `o'
  424.           An RTX code that represents an actual object, such as `reg' or
  425.           `mem'.  `subreg' is not in this class.
  426.     `<'
  427.           An RTX code for a comparison.  The codes in this class are
  428.           `NE', `EQ', `LE', `LT', `GE', `GT', `LEU', `LTU', `GEU',
  429.           `GTU'.
  430.     `1'
  431.           An RTX code for a unary arithmetic operation, such as `neg'.
  432.     `c'
  433.           An RTX code for a commutative binary operation, other than
  434.           `NE' and `EQ' (which have class `<').
  435.     `2'
  436.           An RTX code for a noncommutative binary operation, such as
  437.           `MINUS'.
  438.     `b'
  439.           An RTX code for a bitfield operation, either `ZERO_EXTRACT' or
  440.           `SIGN_EXTRACT'.
  441.     `3'
  442.           An RTX code for other three input operations, such as
  443.           `IF_THEN_ELSE'.
  444.     `i'
  445.           An RTX code for a machine insn (`INSN', `JUMP_INSN', and
  446.           `CALL_INSN').
  447.     `m'
  448.           An RTX code for something that matches in insns, such as
  449.           `MATCH_DUP'.
  450.     `x'
  451.           All other RTX codes.
  452.    Operands of expressions are accessed using the macros `XEXP',
  453. `XINT', `XWINT' and `XSTR'.  Each of these macros takes two arguments:
  454. an expression-pointer (RTX) and an operand number (counting from zero).
  455. Thus,
  456.      XEXP (X, 2)
  457. accesses operand 2 of expression X, as an expression.
  458.      XINT (X, 2)
  459. accesses the same operand as an integer.  `XSTR', used in the same
  460. fashion, would access it as a string.
  461.    Any operand can be accessed as an integer, as an expression or as a
  462. string.  You must choose the correct method of access for the kind of
  463. value actually stored in the operand.  You would do this based on the
  464. expression code of the containing expression.  That is also how you
  465. would know how many operands there are.
  466.    For example, if X is a `subreg' expression, you know that it has two
  467. operands which can be correctly accessed as `XEXP (X, 0)' and `XINT (X,
  468. 1)'.  If you did `XINT (X, 0)', you would get the address of the
  469. expression operand but cast as an integer; that might occasionally be
  470. useful, but it would be cleaner to write `(int) XEXP (X, 0)'.  `XEXP
  471. (X, 1)' would also compile without error, and would return the second,
  472. integer operand cast as an expression pointer, which would probably
  473. result in a crash when accessed.  Nothing stops you from writing `XEXP
  474. (X, 28)' either, but this will access memory past the end of the
  475. expression with unpredictable results.
  476.    Access to operands which are vectors is more complicated.  You can
  477. use the macro `XVEC' to get the vector-pointer itself, or the macros
  478. `XVECEXP' and `XVECLEN' to access the elements and length of a vector.
  479. `XVEC (EXP, IDX)'
  480.      Access the vector-pointer which is operand number IDX in EXP.
  481. `XVECLEN (EXP, IDX)'
  482.      Access the length (number of elements) in the vector which is in
  483.      operand number IDX in EXP.  This value is an `int'.
  484. `XVECEXP (EXP, IDX, ELTNUM)'
  485.      Access element number ELTNUM in the vector which is in operand
  486.      number IDX in EXP.  This value is an RTX.
  487.      It is up to you to make sure that ELTNUM is not negative and is
  488.      less than `XVECLEN (EXP, IDX)'.
  489.    All the macros defined in this section expand into lvalues and
  490. therefore can be used to assign the operands, lengths and vector
  491. elements as well as to access them.
  492. File: gcc.info,  Node: Flags,  Next: Machine Modes,  Prev: Accessors,  Up: RTL
  493. Flags in an RTL Expression
  494. ==========================
  495.    RTL expressions contain several flags (one-bit bitfields) that are
  496. used in certain types of expression.  Most often they are accessed with
  497. the following macros:
  498. `MEM_VOLATILE_P (X)'
  499.      In `mem' expressions, nonzero for volatile memory references.
  500.      Stored in the `volatil' field and printed as `/v'.
  501. `MEM_IN_STRUCT_P (X)'
  502.      In `mem' expressions, nonzero for reference to an entire
  503.      structure, union or array, or to a component of one.  Zero for
  504.      references to a scalar variable or through a pointer to a scalar.
  505.      Stored in the `in_struct' field and printed as `/s'.
  506. `REG_LOOP_TEST_P'
  507.      In `reg' expressions, nonzero if this register's entire life is
  508.      contained in the exit test code for some loop.  Stored in the
  509.      `in_struct' field and printed as `/s'.
  510. `REG_USERVAR_P (X)'
  511.      In a `reg', nonzero if it corresponds to a variable present in the
  512.      user's source code.  Zero for temporaries generated internally by
  513.      the compiler.  Stored in the `volatil' field and printed as `/v'.
  514. `REG_FUNCTION_VALUE_P (X)'
  515.      Nonzero in a `reg' if it is the place in which this function's
  516.      value is going to be returned.  (This happens only in a hard
  517.      register.)  Stored in the `integrated' field and printed as `/i'.
  518.      The same hard register may be used also for collecting the values
  519.      of functions called by this one, but `REG_FUNCTION_VALUE_P' is zero
  520.      in this kind of use.
  521. `SUBREG_PROMOTED_VAR_P'
  522.      Nonzero in a `subreg' if it was made when accessing an object that
  523.      was promoted to a wider mode in accord with the `PROMOTED_MODE'
  524.      machine description macro (*note Storage Layout::.).  In this
  525.      case, the mode of the `subreg' is the declared mode of the object
  526.      and the mode of `SUBREG_REG' is the mode of the register that
  527.      holds the object.  Promoted variables are always either sign- or
  528.      zero-extended to the wider mode on every assignment.  Stored in
  529.      the `in_struct' field and printed as `/s'.
  530. `SUBREG_PROMOTED_UNSIGNED_P'
  531.      Nonzero in a `subreg' that has `SUBREG_PROMOTED_VAR_P' nonzero if
  532.      the object being referenced is kept zero-extended and zero if it
  533.      is kept sign-extended.  Stored in the `unchanging' field and
  534.      printed as `/u'.
  535. `RTX_UNCHANGING_P (X)'
  536.      Nonzero in a `reg' or `mem' if the value is not changed.  (This
  537.      flag is not set for memory references via pointers to constants.
  538.      Such pointers only guarantee that the object will not be changed
  539.      explicitly by the current function.  The object might be changed by
  540.      other functions or by aliasing.)  Stored in the `unchanging' field
  541.      and printed as `/u'.
  542. `RTX_INTEGRATED_P (INSN)'
  543.      Nonzero in an insn if it resulted from an in-line function call.
  544.      Stored in the `integrated' field and printed as `/i'.  This may be
  545.      deleted; nothing currently depends on it.
  546. `SYMBOL_REF_USED (X)'
  547.      In a `symbol_ref', indicates that X has been used.  This is
  548.      normally only used to ensure that X is only declared external
  549.      once.  Stored in the `used' field.
  550. `SYMBOL_REF_FLAG (X)'
  551.      In a `symbol_ref', this is used as a flag for machine-specific
  552.      purposes.  Stored in the `volatil' field and printed as `/v'.
  553. `LABEL_OUTSIDE_LOOP_P'
  554.      In `label_ref' expressions, nonzero if this is a reference to a
  555.      label that is outside the innermost loop containing the reference
  556.      to the label.  Stored in the `in_struct' field and printed as `/s'.
  557. `INSN_DELETED_P (INSN)'
  558.      In an insn, nonzero if the insn has been deleted.  Stored in the
  559.      `volatil' field and printed as `/v'.
  560. `INSN_ANNULLED_BRANCH_P (INSN)'
  561.      In an `insn' in the delay slot of a branch insn, indicates that an
  562.      annulling branch should be used.  See the discussion under
  563.      `sequence' below.  Stored in the `unchanging' field and printed as
  564.      `/u'.
  565. `INSN_FROM_TARGET_P (INSN)'
  566.      In an `insn' in a delay slot of a branch, indicates that the insn
  567.      is from the target of the branch.  If the branch insn has
  568.      `INSN_ANNULLED_BRANCH_P' set, this insn should only be executed if
  569.      the branch is taken.  For annulled branches with this bit clear,
  570.      the insn should be executed only if the branch is not taken.
  571.      Stored in the `in_struct' field and printed as `/s'.
  572. `CONSTANT_POOL_ADDRESS_P (X)'
  573.      Nonzero in a `symbol_ref' if it refers to part of the current
  574.      function's "constants pool".  These are addresses close to the
  575.      beginning of the function, and GNU CC assumes they can be addressed
  576.      directly (perhaps with the help of base registers).  Stored in the
  577.      `unchanging' field and printed as `/u'.
  578. `CONST_CALL_P (X)'
  579.      In a `call_insn', indicates that the insn represents a call to a
  580.      const function.  Stored in the `unchanging' field and printed as
  581.      `/u'.
  582. `LABEL_PRESERVE_P (X)'
  583.      In a `code_label', indicates that the label can never be deleted.
  584.      Labels referenced by a non-local goto will have this bit set.
  585.      Stored in the `in_struct' field and printed as `/s'.
  586. `SCHED_GROUP_P (INSN)'
  587.      During instruction scheduling, in an insn, indicates that the
  588.      previous insn must be scheduled together with this insn.  This is
  589.      used to ensure that certain groups of instructions will not be
  590.      split up by the instruction scheduling pass, for example, `use'
  591.      insns before a `call_insn' may not be separated from the
  592.      `call_insn'.  Stored in the `in_struct' field and printed as `/s'.
  593.    These are the fields which the above macros refer to:
  594. `used'
  595.      Normally, this flag is used only momentarily, at the end of RTL
  596.      generation for a function, to count the number of times an
  597.      expression appears in insns.  Expressions that appear more than
  598.      once are copied, according to the rules for shared structure
  599.      (*note Sharing::.).
  600.      In a `symbol_ref', it indicates that an external declaration for
  601.      the symbol has already been written.
  602.      In a `reg', it is used by the leaf register renumbering code to
  603.      ensure that each register is only renumbered once.
  604. `volatil'
  605.      This flag is used in `mem', `symbol_ref' and `reg' expressions and
  606.      in insns.  In RTL dump files, it is printed as `/v'.
  607.      In a `mem' expression, it is 1 if the memory reference is volatile.
  608.      Volatile memory references may not be deleted, reordered or
  609.      combined.
  610.      In a `symbol_ref' expression, it is used for machine-specific
  611.      purposes.
  612.      In a `reg' expression, it is 1 if the value is a user-level
  613.      variable.  0 indicates an internal compiler temporary.
  614.      In an insn, 1 means the insn has been deleted.
  615. `in_struct'
  616.      In `mem' expressions, it is 1 if the memory datum referred to is
  617.      all or part of a structure or array; 0 if it is (or might be) a
  618.      scalar variable.  A reference through a C pointer has 0 because
  619.      the pointer might point to a scalar variable.  This information
  620.      allows the compiler to determine something about possible cases of
  621.      aliasing.
  622.      In an insn in the delay slot of a branch, 1 means that this insn
  623.      is from the target of the branch.
  624.      During instruction scheduling, in an insn, 1 means that this insn
  625.      must be scheduled as part of a group together with the previous
  626.      insn.
  627.      In `reg' expressions, it is 1 if the register has its entire life
  628.      contained within the test expression of some loop.
  629.      In `subreg' expressions, 1 means that the `subreg' is accessing an
  630.      object that has had its mode promoted from a wider mode.
  631.      In `label_ref' expressions, 1 means that the referenced label is
  632.      outside the innermost loop containing the insn in which the
  633.      `label_ref' was found.
  634.      In `code_label' expressions, it is 1 if the label may never be
  635.      deleted.  This is used for labels which are the target of
  636.      non-local gotos.
  637.      In an RTL dump, this flag is represented as `/s'.
  638. `unchanging'
  639.      In `reg' and `mem' expressions, 1 means that the value of the
  640.      expression never changes.
  641.      In `subreg' expressions, it is 1 if the `subreg' references an
  642.      unsigned object whose mode has been promoted to a wider mode.
  643.      In an insn, 1 means that this is an annulling branch.
  644.      In a `symbol_ref' expression, 1 means that this symbol addresses
  645.      something in the per-function constants pool.
  646.      In a `call_insn', 1 means that this instruction is a call to a
  647.      const function.
  648.      In an RTL dump, this flag is represented as `/u'.
  649. `integrated'
  650.      In some kinds of expressions, including insns, this flag means the
  651.      rtl was produced by procedure integration.
  652.      In a `reg' expression, this flag indicates the register containing
  653.      the value to be returned by the current function.  On machines
  654.      that pass parameters in registers, the same register number may be
  655.      used for parameters as well, but this flag is not set on such uses.
  656. File: gcc.info,  Node: Machine Modes,  Next: Constants,  Prev: Flags,  Up: RTL
  657. Machine Modes
  658. =============
  659.    A machine mode describes a size of data object and the
  660. representation used for it.  In the C code, machine modes are
  661. represented by an enumeration type, `enum machine_mode', defined in
  662. `machmode.def'.  Each RTL expression has room for a machine mode and so
  663. do certain kinds of tree expressions (declarations and types, to be
  664. precise).
  665.    In debugging dumps and machine descriptions, the machine mode of an
  666. RTL expression is written after the expression code with a colon to
  667. separate them.  The letters `mode' which appear at the end of each
  668. machine mode name are omitted.  For example, `(reg:SI 38)' is a `reg'
  669. expression with machine mode `SImode'.  If the mode is `VOIDmode', it
  670. is not written at all.
  671.    Here is a table of machine modes.  The term "byte" below refers to an
  672. object of `BITS_PER_UNIT' bits (*note Storage Layout::.).
  673. `QImode'
  674.      "Quarter-Integer" mode represents a single byte treated as an
  675.      integer.
  676. `HImode'
  677.      "Half-Integer" mode represents a two-byte integer.
  678. `PSImode'
  679.      "Partial Single Integer" mode represents an integer which occupies
  680.      four bytes but which doesn't really use all four.  On some
  681.      machines, this is the right mode to use for pointers.
  682. `SImode'
  683.      "Single Integer" mode represents a four-byte integer.
  684. `PDImode'
  685.      "Partial Double Integer" mode represents an integer which occupies
  686.      eight bytes but which doesn't really use all eight.  On some
  687.      machines, this is the right mode to use for certain pointers.
  688. `DImode'
  689.      "Double Integer" mode represents an eight-byte integer.
  690. `TImode'
  691.      "Tetra Integer" (?) mode represents a sixteen-byte integer.
  692. `SFmode'
  693.      "Single Floating" mode represents a single-precision (four byte)
  694.      floating point number.
  695. `DFmode'
  696.      "Double Floating" mode represents a double-precision (eight byte)
  697.      floating point number.
  698. `XFmode'
  699.      "Extended Floating" mode represents a triple-precision (twelve
  700.      byte) floating point number.  This mode is used for IEEE extended
  701.      floating point.
  702. `TFmode'
  703.      "Tetra Floating" mode represents a quadruple-precision (sixteen
  704.      byte) floating point number.
  705. `CCmode'
  706.      "Condition Code" mode represents the value of a condition code,
  707.      which is a machine-specific set of bits used to represent the
  708.      result of a comparison operation.  Other machine-specific modes
  709.      may also be used for the condition code.  These modes are not used
  710.      on machines that use `cc0' (see *note Condition Code::.).
  711. `BLKmode'
  712.      "Block" mode represents values that are aggregates to which none of
  713.      the other modes apply.  In RTL, only memory references can have
  714.      this mode, and only if they appear in string-move or vector
  715.      instructions.  On machines which have no such instructions,
  716.      `BLKmode' will not appear in RTL.
  717. `VOIDmode'
  718.      Void mode means the absence of a mode or an unspecified mode.  For
  719.      example, RTL expressions of code `const_int' have mode `VOIDmode'
  720.      because they can be taken to have whatever mode the context
  721.      requires.  In debugging dumps of RTL, `VOIDmode' is expressed by
  722.      the absence of any mode.
  723. `SCmode, DCmode, XCmode, TCmode'
  724.      These modes stand for a complex number represented as a pair of
  725.      floating point values.  The floating point values are in `SFmode',
  726.      `DFmode', `XFmode', and `TFmode', respectively.
  727. `CQImode, CHImode, CSImode, CDImode, CTImode, COImode'
  728.      These modes stand for a complex number represented as a pair of
  729.      integer values.  The integer values are in `QImode', `HImode',
  730.      `SImode', `DImode', `TImode', and `OImode', respectively.
  731.    The machine description defines `Pmode' as a C macro which expands
  732. into the machine mode used for addresses.  Normally this is the mode
  733. whose size is `BITS_PER_WORD', `SImode' on 32-bit machines.
  734.    The only modes which a machine description must support are
  735. `QImode', and the modes corresponding to `BITS_PER_WORD',
  736. `FLOAT_TYPE_SIZE' and `DOUBLE_TYPE_SIZE'.  The compiler will attempt to
  737. use `DImode' for 8-byte structures and unions, but this can be
  738. prevented by overriding the definition of `MAX_FIXED_MODE_SIZE'.
  739. Alternatively, you can have the compiler use `TImode' for 16-byte
  740. structures and unions.  Likewise, you can arrange for the C type `short
  741. int' to avoid using `HImode'.
  742.    Very few explicit references to machine modes remain in the compiler
  743. and these few references will soon be removed.  Instead, the machine
  744. modes are divided into mode classes.  These are represented by the
  745. enumeration type `enum mode_class' defined in `machmode.h'.  The
  746. possible mode classes are:
  747. `MODE_INT'
  748.      Integer modes.  By default these are `QImode', `HImode', `SImode',
  749.      `DImode', and `TImode'.
  750. `MODE_PARTIAL_INT'
  751.      The "partial integer" modes, `PSImode' and `PDImode'.
  752. `MODE_FLOAT'
  753.      floating point modes.  By default these are `SFmode', `DFmode',
  754.      `XFmode' and `TFmode'.
  755. `MODE_COMPLEX_INT'
  756.      Complex integer modes.  (These are not currently implemented).
  757. `MODE_COMPLEX_FLOAT'
  758.      Complex floating point modes.  By default these are `SCmode',
  759.      `DCmode', `XCmode', and `TCmode'.
  760. `MODE_FUNCTION'
  761.      Algol or Pascal function variables including a static chain.
  762.      (These are not currently implemented).
  763. `MODE_CC'
  764.      Modes representing condition code values.  These are `CCmode' plus
  765.      any modes listed in the `EXTRA_CC_MODES' macro.  *Note Jump
  766.      Patterns::, also see *Note Condition Code::.
  767. `MODE_RANDOM'
  768.      This is a catchall mode class for modes which don't fit into the
  769.      above classes.  Currently `VOIDmode' and `BLKmode' are in
  770.      `MODE_RANDOM'.
  771.    Here are some C macros that relate to machine modes:
  772. `GET_MODE (X)'
  773.      Returns the machine mode of the RTX X.
  774. `PUT_MODE (X, NEWMODE)'
  775.      Alters the machine mode of the RTX X to be NEWMODE.
  776. `NUM_MACHINE_MODES'
  777.      Stands for the number of machine modes available on the target
  778.      machine.  This is one greater than the largest numeric value of any
  779.      machine mode.
  780. `GET_MODE_NAME (M)'
  781.      Returns the name of mode M as a string.
  782. `GET_MODE_CLASS (M)'
  783.      Returns the mode class of mode M.
  784. `GET_MODE_WIDER_MODE (M)'
  785.      Returns the next wider natural mode.  For example, the expression
  786.      `GET_MODE_WIDER_MODE (QImode)' returns `HImode'.
  787. `GET_MODE_SIZE (M)'
  788.      Returns the size in bytes of a datum of mode M.
  789. `GET_MODE_BITSIZE (M)'
  790.      Returns the size in bits of a datum of mode M.
  791. `GET_MODE_MASK (M)'
  792.      Returns a bitmask containing 1 for all bits in a word that fit
  793.      within mode M.  This macro can only be used for modes whose
  794.      bitsize is less than or equal to `HOST_BITS_PER_INT'.
  795. `GET_MODE_ALIGNMENT (M))'
  796.      Return the required alignment, in bits, for an object of mode M.
  797. `GET_MODE_UNIT_SIZE (M)'
  798.      Returns the size in bytes of the subunits of a datum of mode M.
  799.      This is the same as `GET_MODE_SIZE' except in the case of complex
  800.      modes.  For them, the unit size is the size of the real or
  801.      imaginary part.
  802. `GET_MODE_NUNITS (M)'
  803.      Returns the number of units contained in a mode, i.e.,
  804.      `GET_MODE_SIZE' divided by `GET_MODE_UNIT_SIZE'.
  805. `GET_CLASS_NARROWEST_MODE (C)'
  806.      Returns the narrowest mode in mode class C.
  807.    The global variables `byte_mode' and `word_mode' contain modes whose
  808. classes are `MODE_INT' and whose bitsizes are either `BITS_PER_UNIT' or
  809. `BITS_PER_WORD', respectively.  On 32-bit machines, these are `QImode'
  810. and `SImode', respectively.
  811. File: gcc.info,  Node: Constants,  Next: Regs and Memory,  Prev: Machine Modes,  Up: RTL
  812. Constant Expression Types
  813. =========================
  814.    The simplest RTL expressions are those that represent constant
  815. values.
  816. `(const_int I)'
  817.      This type of expression represents the integer value I.  I is
  818.      customarily accessed with the macro `INTVAL' as in `INTVAL (EXP)',
  819.      which is equivalent to `XWINT (EXP, 0)'.
  820.      There is only one expression object for the integer value zero; it
  821.      is the value of the variable `const0_rtx'.  Likewise, the only
  822.      expression for integer value one is found in `const1_rtx', the only
  823.      expression for integer value two is found in `const2_rtx', and the
  824.      only expression for integer value negative one is found in
  825.      `constm1_rtx'.  Any attempt to create an expression of code
  826.      `const_int' and value zero, one, two or negative one will return
  827.      `const0_rtx', `const1_rtx', `const2_rtx' or `constm1_rtx' as
  828.      appropriate.
  829.      Similarly, there is only one object for the integer whose value is
  830.      `STORE_FLAG_VALUE'.  It is found in `const_true_rtx'.  If
  831.      `STORE_FLAG_VALUE' is one, `const_true_rtx' and `const1_rtx' will
  832.      point to the same object.  If `STORE_FLAG_VALUE' is -1,
  833.      `const_true_rtx' and `constm1_rtx' will point to the same object.
  834. `(const_double:M ADDR I0 I1 ...)'
  835.      Represents either a floating-point constant of mode M or an
  836.      integer constant too large to fit into `HOST_BITS_PER_WIDE_INT'
  837.      bits but small enough to fit within twice that number of bits (GNU
  838.      CC does not provide a mechanism to represent even larger
  839.      constants).  In the latter case, M will be `VOIDmode'.
  840.      ADDR is used to contain the `mem' expression that corresponds to
  841.      the location in memory that at which the constant can be found.  If
  842.      it has not been allocated a memory location, but is on the chain
  843.      of all `const_double' expressions in this compilation (maintained
  844.      using an undisplayed field), ADDR contains `const0_rtx'.  If it is
  845.      not on the chain, ADDR contains `cc0_rtx'.  ADDR is customarily
  846.      accessed with the macro `CONST_DOUBLE_MEM' and the chain field via
  847.      `CONST_DOUBLE_CHAIN'.
  848.      If M is `VOIDmode', the bits of the value are stored in I0 and I1.
  849.      I0 is customarily accessed with the macro `CONST_DOUBLE_LOW' and
  850.      I1 with `CONST_DOUBLE_HIGH'.
  851.      If the constant is floating point (regardless of its precision),
  852.      then the number of integers used to store the value depends on the
  853.      size of `REAL_VALUE_TYPE' (*note Cross-compilation::.).  The
  854.      integers represent a floating point number, but not precisely in
  855.      the target machine's or host machine's floating point format.  To
  856.      convert them to the precise bit pattern used by the target
  857.      machine, use the macro `REAL_VALUE_TO_TARGET_DOUBLE' and friends
  858.      (*note Data Output::.).
  859.      The macro `CONST0_RTX (MODE)' refers to an expression with value 0
  860.      in mode MODE.  If mode MODE is of mode class `MODE_INT', it
  861.      returns `const0_rtx'.  Otherwise, it returns a `CONST_DOUBLE'
  862.      expression in mode MODE.  Similarly, the macro `CONST1_RTX (MODE)'
  863.      refers to an expression with value 1 in mode MODE and similarly
  864.      for `CONST2_RTX'.
  865. `(const_string STR)'
  866.      Represents a constant string with value STR.  Currently this is
  867.      used only for insn attributes (*note Insn Attributes::.) since
  868.      constant strings in C are placed in memory.
  869. `(symbol_ref:MODE SYMBOL)'
  870.      Represents the value of an assembler label for data.  SYMBOL is a
  871.      string that describes the name of the assembler label.  If it
  872.      starts with a `*', the label is the rest of SYMBOL not including
  873.      the `*'.  Otherwise, the label is SYMBOL, usually prefixed with
  874.      `_'.
  875.      The `symbol_ref' contains a mode, which is usually `Pmode'.
  876.      Usually that is the only mode for which a symbol is directly valid.
  877. `(label_ref LABEL)'
  878.      Represents the value of an assembler label for code.  It contains
  879.      one operand, an expression, which must be a `code_label' that
  880.      appears in the instruction sequence to identify the place where
  881.      the label should go.
  882.      The reason for using a distinct expression type for code label
  883.      references is so that jump optimization can distinguish them.
  884. `(const:M EXP)'
  885.      Represents a constant that is the result of an assembly-time
  886.      arithmetic computation.  The operand, EXP, is an expression that
  887.      contains only constants (`const_int', `symbol_ref' and `label_ref'
  888.      expressions) combined with `plus' and `minus'.  However, not all
  889.      combinations are valid, since the assembler cannot do arbitrary
  890.      arithmetic on relocatable symbols.
  891.      M should be `Pmode'.
  892. `(high:M EXP)'
  893.      Represents the high-order bits of EXP, usually a `symbol_ref'.
  894.      The number of bits is machine-dependent and is normally the number
  895.      of bits specified in an instruction that initializes the high
  896.      order bits of a register.  It is used with `lo_sum' to represent
  897.      the typical two-instruction sequence used in RISC machines to
  898.      reference a global memory location.
  899.      M should be `Pmode'.
  900.