gcc/rtl.h

   1 /* Register Transfer Language (RTL) definitions for GNU C-Compiler
   2    Copyright (C) 1987, 91-98, 1999 Free Software Foundation, Inc.
   3
   4 This file is part of GNU CC.
   5
   6 GNU CC is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU CC is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU CC; see the file COPYING.  If not, write to
  18 the Free Software Foundation, 59 Temple Place - Suite 330,
  19 Boston, MA 02111-1307, USA.  */
  20
  21 #ifndef _RTL_H
  22 #define _RTL_H
  23
  24 struct function;
  25
  26 #include "machmode.h"
  27
  28 #undef FFS  /* Some systems predefine this symbol; don't let it interfere.  */
  29 #undef FLOAT /* Likewise.  */
  30 #undef ABS /* Likewise.  */
  31 #undef PC /* Likewise.  */
  32
  33 #ifndef TREE_CODE
  34 union tree_node;
  35 #endif
  36
  37 /* Register Transfer Language EXPRESSIONS CODES */
  38
  39 #define RTX_CODE        enum rtx_code
  40 enum rtx_code  {
  41
  42 #define DEF_RTL_EXPR(ENUM, NAME, FORMAT, CLASS)   ENUM ,
  43 #include "rtl.def"              /* rtl expressions are documented here */
  44 #undef DEF_RTL_EXPR
  45
  46   LAST_AND_UNUSED_RTX_CODE};    /* A convenient way to get a value for
  47                                    NUM_RTX_CODE.
  48                                    Assumes default enum value assignment.  */
  49
  50 #define NUM_RTX_CODE ((int)LAST_AND_UNUSED_RTX_CODE)
  51                                 /* The cast here, saves many elsewhere.  */
  52
  53 extern const int rtx_length[];
  54 #define GET_RTX_LENGTH(CODE)            (rtx_length[(int) (CODE)])
  55
  56 extern const char * const rtx_name[];
  57 #define GET_RTX_NAME(CODE)              (rtx_name[(int) (CODE)])
  58
  59 extern const char * const rtx_format[];
  60 #define GET_RTX_FORMAT(CODE)            (rtx_format[(int) (CODE)])
  61
  62 extern const char rtx_class[];
  63 #define GET_RTX_CLASS(CODE)             (rtx_class[(int) (CODE)])
  64 \f
  65 /* The flags and bitfields of an ADDR_DIFF_VEC.  BASE is the base label
  66    relative to which the offsets are calculated, as explained in rtl.def.  */
  67 typedef struct
  68 {
  69   /* Set at the start of shorten_branches - ONLY WHEN OPTIMIZING - : */
  70   unsigned min_align: 8;
  71   /* Flags: */
  72   unsigned base_after_vec: 1; /* BASE is after the ADDR_DIFF_VEC.  */
  73   unsigned min_after_vec: 1;  /* minimum address target label is after the ADDR_DIFF_VEC.  */
  74   unsigned max_after_vec: 1;  /* maximum address target label is after the ADDR_DIFF_VEC.  */
  75   unsigned min_after_base: 1; /* minimum address target label is after BASE.  */
  76   unsigned max_after_base: 1; /* maximum address target label is after BASE.  */
  77   /* Set by the actual branch shortening process - ONLY WHEN OPTIMIZING - : */
  78   unsigned offset_unsigned: 1; /* offsets have to be treated as unsigned.  */
  79   unsigned : 2;
  80   unsigned scale : 8;
  81 } addr_diff_vec_flags;
  82
  83 /* Common union for an element of an rtx.  */
  84
  85 typedef union rtunion_def
  86 {
  87   HOST_WIDE_INT rtwint;
  88   int rtint;
  89   char *rtstr;
  90   struct rtx_def *rtx;
  91   struct rtvec_def *rtvec;
  92   enum machine_mode rttype;
  93   addr_diff_vec_flags rt_addr_diff_vec_flags;
  94   struct bitmap_head_def *rtbit;
  95   union tree_node *rttree;
  96   struct basic_block_def *bb;
  97 } rtunion;
  98
  99 /* RTL expression ("rtx").  */
 100
 101 typedef struct rtx_def
 102 {
 103 #ifdef ONLY_INT_FIELDS
 104 #ifdef CODE_FIELD_BUG
 105   unsigned int code : 15;
 106 #else
 107   unsigned short code;
 108 #endif
 109 #else
 110   /* The kind of expression this is.  */
 111   enum rtx_code code : 15;
 112 #endif
 113
 114   /* Used by the garbage collector.  */
 115   unsigned gc_mark : 1;
 116
 117   /* The kind of value the expression has.  */
 118 #ifdef ONLY_INT_FIELDS
 119   int mode : 8;
 120 #else
 121   enum machine_mode mode : 8;
 122 #endif
 123   /* LINK_COST_ZERO in an INSN_LIST.  */
 124   unsigned int jump : 1;
 125   /* LINK_COST_FREE in an INSN_LIST.  */
 126   unsigned int call : 1;
 127   /* 1 in a MEM or REG if value of this expression will never change
 128      during the current function, even though it is not
 129      manifestly constant.
 130      1 in a SUBREG if it is from a promoted variable that is unsigned.
 131      1 in a SYMBOL_REF if it addresses something in the per-function
 132      constants pool.
 133      1 in a CALL_INSN if it is a const call.
 134      1 in a JUMP_INSN if it is a branch that should be annulled.  Valid from
 135      reorg until end of compilation; cleared before used.  */
 136   unsigned int unchanging : 1;
 137   /* 1 in a MEM expression if contents of memory are volatile.
 138      1 in an INSN, CALL_INSN, JUMP_INSN, CODE_LABEL or BARRIER
 139      if it is deleted.
 140      1 in a REG expression if corresponds to a variable declared by the user.
 141      0 for an internally generated temporary.
 142      In a SYMBOL_REF, this flag is used for machine-specific purposes.
 143      In a LABEL_REF or in a REG_LABEL note, this is LABEL_REF_NONLOCAL_P.  */
 144   unsigned int volatil : 1;
 145   /* 1 in a MEM referring to a field of an aggregate.
 146      0 if the MEM was a variable or the result of a * operator in C;
 147      1 if it was the result of a . or -> operator (on a struct) in C.
 148      1 in a REG if the register is used only in exit code a loop.
 149      1 in a SUBREG expression if was generated from a variable with a
 150      promoted mode.
 151      1 in a CODE_LABEL if the label is used for nonlocal gotos
 152      and must not be deleted even if its count is zero.
 153      1 in a LABEL_REF if this is a reference to a label outside the
 154      current loop.
 155      1 in an INSN, JUMP_INSN, or CALL_INSN if this insn must be scheduled
 156      together with the preceding insn.  Valid only within sched.
 157      1 in an INSN, JUMP_INSN, or CALL_INSN if insn is in a delay slot and
 158      from the target of a branch.  Valid from reorg until end of compilation;
 159      cleared before used.  */
 160   unsigned int in_struct : 1;
 161   /* 1 if this rtx is used.  This is used for copying shared structure.
 162      See `unshare_all_rtl'.
 163      In a REG, this is not needed for that purpose, and used instead
 164      in `leaf_renumber_regs_insn'.
 165      In a SYMBOL_REF, means that emit_library_call
 166      has used it as the function.  */
 167   unsigned int used : 1;
 168   /* Nonzero if this rtx came from procedure integration.
 169      In a REG, nonzero means this reg refers to the return value
 170      of the current function.  */
 171   unsigned integrated : 1;
 172   /* 1 in an INSN or a SET if this rtx is related to the call frame,
 173      either changing how we compute the frame address or saving and
 174      restoring registers in the prologue and epilogue.
 175      1 in a MEM if the MEM refers to a scalar, rather than a member of
 176      an aggregate.  */
 177   unsigned frame_related : 1;
 178
 179   /* The first element of the operands of this rtx.
 180      The number of operands and their types are controlled
 181      by the `code' field, according to rtl.def.  */
 182   rtunion fld[1];
 183 } *rtx;
 184
 185 #define NULL_RTX (rtx) 0
 186
 187 /* Define macros to access the `code' field of the rtx.  */
 188
 189 #ifdef SHORT_ENUM_BUG
 190 #define GET_CODE(RTX)           ((enum rtx_code) ((RTX)->code))
 191 #define PUT_CODE(RTX, CODE)     ((RTX)->code = ((short) (CODE)))
 192 #else
 193 #define GET_CODE(RTX)           ((RTX)->code)
 194 #define PUT_CODE(RTX, CODE)     ((RTX)->code = (CODE))
 195 #endif
 196
 197 #define GET_MODE(RTX)           ((RTX)->mode)
 198 #define PUT_MODE(RTX, MODE)     ((RTX)->mode = (MODE))
 199
 200 #define RTX_INTEGRATED_P(RTX) ((RTX)->integrated)
 201 #define RTX_UNCHANGING_P(RTX) ((RTX)->unchanging)
 202 #define RTX_FRAME_RELATED_P(RTX) ((RTX)->frame_related)
 203
 204 /* RTL vector.  These appear inside RTX's when there is a need
 205    for a variable number of things.  The principle use is inside
 206    PARALLEL expressions.  */
 207
 208 typedef struct rtvec_def{
 209   int num_elem;         /* number of elements */
 210   int gc_mark;
 211   struct rtx_def *elem[1];
 212 } *rtvec;
 213
 214 #define NULL_RTVEC (rtvec) 0
 215
 216 #define GET_NUM_ELEM(RTVEC)             ((RTVEC)->num_elem)
 217 #define PUT_NUM_ELEM(RTVEC, NUM)        ((RTVEC)->num_elem = (NUM))
 218
 219 /* 1 if X is a REG.  */
 220
 221 #define REG_P(X) (GET_CODE (X) == REG)
 222
 223 /* 1 if X is a constant value that is an integer.  */
 224
 225 #define CONSTANT_P(X)   \
 226   (GET_CODE (X) == LABEL_REF || GET_CODE (X) == SYMBOL_REF              \
 227    || GET_CODE (X) == CONST_INT || GET_CODE (X) == CONST_DOUBLE         \
 228    || GET_CODE (X) == CONST || GET_CODE (X) == HIGH                     \
 229    || GET_CODE (X) == CONSTANT_P_RTX)
 230
 231 /* General accessor macros for accessing the fields of an rtx.  */
 232
 233 #if defined ENABLE_CHECKING  && (__GNUC__ > 2 || __GNUC_MINOR__ > 6)
 234 /* The bit with a star outside the statement expr and an & inside is
 235    so that N can be evaluated only once.  */
 236 #define RTL_CHECK1(RTX, N, C1)                                          \
 237 (*({ rtx _rtx = (RTX); int _n = (N);                                    \
 238      enum rtx_code _code = GET_CODE (_rtx);                             \
 239      if (_n < 0 || _n >= GET_RTX_LENGTH (_code))                        \
 240        rtl_check_failed_bounds (_rtx, _n, __FILE__, __LINE__,           \
 241                                 __PRETTY_FUNCTION__);                   \
 242      if (GET_RTX_FORMAT(_code)[_n] != C1)                               \
 243        rtl_check_failed_type1 (_rtx, _n, C1, __FILE__, __LINE__,        \
 244                                __PRETTY_FUNCTION__);                    \
 245      &_rtx->fld[_n]; }))
 246
 247 #define RTL_CHECK2(RTX, N, C1, C2)                                      \
 248 (*({ rtx _rtx = (RTX); int _n = (N);                                    \
 249      enum rtx_code _code = GET_CODE (_rtx);                             \
 250      if (_n < 0 || _n >= GET_RTX_LENGTH (_code))                        \
 251        rtl_check_failed_bounds (_rtx, _n, __FILE__, __LINE__,           \
 252                                 __PRETTY_FUNCTION__);                   \
 253      if (GET_RTX_FORMAT(_code)[_n] != C1                                \
 254          && GET_RTX_FORMAT(_code)[_n] != C2)                            \
 255        rtl_check_failed_type2 (_rtx, _n, C1, C2, __FILE__, __LINE__,    \
 256                                __PRETTY_FUNCTION__);                    \
 257      &_rtx->fld[_n]; }))
 258
 259 #define RTL_CHECKC1(RTX, N, C)                                          \
 260 (*({ rtx _rtx = (RTX); int _n = (N);                                    \
 261      if (GET_CODE (_rtx) != C)                                          \
 262        rtl_check_failed_code1 (_rtx, C, __FILE__, __LINE__,             \
 263                                __PRETTY_FUNCTION__);                    \
 264      &_rtx->fld[_n]; }))
 265
 266 #define RTL_CHECKC2(RTX, N, C1, C2)                                     \
 267 (*({ rtx _rtx = (RTX); int _n = (N);                                    \
 268      enum rtx_code _code = GET_CODE (_rtx);                             \
 269      if (_code != C1 && _code != C2)                                    \
 270        rtl_check_failed_code2 (_rtx, C1, C2, __FILE__, __LINE__,        \
 271                                __PRETTY_FUNCTION__);                    \
 272      &_rtx->fld[_n]; }))
 273
 274 #define RTVEC_ELT(RTVEC, I)                                             \
 275 (*({ rtvec _rtvec = (RTVEC); int _i = (I);                              \
 276      if (_i < 0 || _i >= GET_NUM_ELEM (_rtvec))                         \
 277        rtvec_check_failed_bounds (_rtvec, _i, __FILE__, __LINE__,       \
 278                                   __PRETTY_FUNCTION__);                 \
 279      &_rtvec->elem[_i]; }))
 280
 281 extern void rtl_check_failed_bounds PROTO((rtx, int,
 282                                            const char *, int, const char *))
 283     ATTRIBUTE_NORETURN;
 284 extern void rtl_check_failed_type1 PROTO((rtx, int, int,
 285                                           const char *, int, const char *))
 286     ATTRIBUTE_NORETURN;
 287 extern void rtl_check_failed_type2 PROTO((rtx, int, int, int,
 288                                           const char *, int, const char *))
 289     ATTRIBUTE_NORETURN;
 290 extern void rtl_check_failed_code1 PROTO((rtx, enum rtx_code,
 291                                           const char *, int, const char *))
 292     ATTRIBUTE_NORETURN;
 293 extern void rtl_check_failed_code2 PROTO((rtx, enum rtx_code, enum rtx_code,
 294                                           const char *, int, const char *))
 295     ATTRIBUTE_NORETURN;
 296 extern void rtvec_check_failed_bounds PROTO((rtvec, int,
 297                                              const char *, int, const char *))
 298     ATTRIBUTE_NORETURN;
 299
 300 #else   /* not ENABLE_CHECKING */
 301
 302 #define RTL_CHECK1(RTX, N, C1)      ((RTX)->fld[N])
 303 #define RTL_CHECK2(RTX, N, C1, C2)  ((RTX)->fld[N])
 304 #define RTL_CHECKC1(RTX, N, C)      ((RTX)->fld[N])
 305 #define RTL_CHECKC2(RTX, N, C1, C2) ((RTX)->fld[N])
 306 #define RTVEC_ELT(RTVEC, I)         ((RTVEC)->elem[I])
 307
 308 #endif
 309
 310 #define XWINT(RTX, N)   (RTL_CHECK1(RTX, N, 'w').rtwint)
 311 #define XINT(RTX, N)    (RTL_CHECK2(RTX, N, 'i', 'n').rtint)
 312 #define XSTR(RTX, N)    (RTL_CHECK2(RTX, N, 's', 'S').rtstr)
 313 #define XEXP(RTX, N)    (RTL_CHECK2(RTX, N, 'e', 'u').rtx)
 314 #define XVEC(RTX, N)    (RTL_CHECK2(RTX, N, 'E', 'V').rtvec)
 315 #define XMODE(RTX, N)   (RTL_CHECK1(RTX, N, 'M').rttype)
 316 #define XBITMAP(RTX, N) (RTL_CHECK1(RTX, N, 'b').rtbit)
 317 #define XTREE(RTX, N)   (RTL_CHECK1(RTX, N, 't').rttree)
 318 #define XBBDEF(RTX, N)  (RTL_CHECK1(RTX, N, 'B').bb)
 319
 320 #define XVECEXP(RTX, N, M)      RTVEC_ELT (XVEC (RTX, N), M)
 321 #define XVECLEN(RTX, N)         GET_NUM_ELEM (XVEC (RTX, N))
 322
 323 /* These are like XWINT, etc. except that they expect a '0' field instead
 324    of the normal type code.  */
 325
 326 #define X0WINT(RTX, N)     (RTL_CHECK1(RTX, N, '0').rtwint)
 327 #define X0INT(RTX, N)      (RTL_CHECK1(RTX, N, '0').rtint)
 328 #define X0STR(RTX, N)      (RTL_CHECK1(RTX, N, '0').rtstr)
 329 #define X0EXP(RTX, N)      (RTL_CHECK1(RTX, N, '0').rtx)
 330 #define X0VEC(RTX, N)      (RTL_CHECK1(RTX, N, '0').rtvec)
 331 #define X0MODE(RTX, N)     (RTL_CHECK1(RTX, N, '0').rttype)
 332 #define X0BITMAP(RTX, N)   (RTL_CHECK1(RTX, N, '0').rtbit)
 333 #define X0TREE(RTX, N)     (RTL_CHECK1(RTX, N, '0').rttree)
 334 #define X0BBDEF(RTX, N)    (RTL_CHECK1(RTX, N, '0').bb)
 335 #define X0ADVFLAGS(RTX, N) (RTL_CHECK1(RTX, N, '0').rt_addr_diff_vec_flags)
 336
 337 #define XCWINT(RTX, N, C)     (RTL_CHECKC1(RTX, N, C).rtwint)
 338 #define XCINT(RTX, N, C)      (RTL_CHECKC1(RTX, N, C).rtint)
 339 #define XCSTR(RTX, N, C)      (RTL_CHECKC1(RTX, N, C).rtstr)
 340 #define XCEXP(RTX, N, C)      (RTL_CHECKC1(RTX, N, C).rtx)
 341 #define XCVEC(RTX, N, C)      (RTL_CHECKC1(RTX, N, C).rtvec)
 342 #define XCMODE(RTX, N, C)     (RTL_CHECKC1(RTX, N, C).rttype)
 343 #define XCBITMAP(RTX, N, C)   (RTL_CHECKC1(RTX, N, C).rtbit)
 344 #define XCTREE(RTX, N, C)     (RTL_CHECKC1(RTX, N, C).rttree)
 345 #define XCBBDEF(RTX, N, C)    (RTL_CHECKC1(RTX, N, C).bb)
 346 #define XCADVFLAGS(RTX, N, C) (RTL_CHECKC1(RTX, N, C).rt_addr_diff_vec_flags)
 347
 348 #define XCVECEXP(RTX, N, M, C)  RTVEC_ELT (XCVEC (RTX, N, C), M)
 349 #define XCVECLEN(RTX, N, C)     GET_NUM_ELEM (XCVEC (RTX, N, C))
 350
 351 #define XC2EXP(RTX, N, C1, C2)      (RTL_CHECKC2(RTX, N, C1, C2).rtx)
 352 \f
 353 /* ACCESS MACROS for particular fields of insns.  */
 354
 355 /* Holds a unique number for each insn.
 356    These are not necessarily sequentially increasing.  */
 357 #define INSN_UID(INSN)  XINT(INSN, 0)
 358
 359 /* Chain insns together in sequence.  */
 360 #define PREV_INSN(INSN) XEXP(INSN, 1)
 361 #define NEXT_INSN(INSN) XEXP(INSN, 2)
 362
 363 /* The body of an insn.  */
 364 #define PATTERN(INSN)   XEXP(INSN, 3)
 365
 366 /* Code number of instruction, from when it was recognized.
 367    -1 means this instruction has not been recognized yet.  */
 368 #define INSN_CODE(INSN) XINT(INSN, 4)
 369
 370 /* Set up in flow.c; empty before then.
 371    Holds a chain of INSN_LIST rtx's whose first operands point at
 372    previous insns with direct data-flow connections to this one.
 373    That means that those insns set variables whose next use is in this insn.
 374    They are always in the same basic block as this insn.  */
 375 #define LOG_LINKS(INSN) XEXP(INSN, 5)
 376
 377 /* 1 if insn has been deleted.  */
 378 #define INSN_DELETED_P(INSN) ((INSN)->volatil)
 379
 380 /* 1 if insn is a call to a const function.  */
 381 #define CONST_CALL_P(INSN) ((INSN)->unchanging)
 382
 383 /* 1 if insn is a branch that should not unconditionally execute its
 384    delay slots, i.e., it is an annulled branch.   */
 385 #define INSN_ANNULLED_BRANCH_P(INSN) ((INSN)->unchanging)
 386
 387 /* 1 if insn is in a delay slot and is from the target of the branch.  If
 388    the branch insn has INSN_ANNULLED_BRANCH_P set, this insn should only be
 389    executed if the branch is taken.  For annulled branches with this bit
 390    clear, the insn should be executed only if the branch is not taken.  */
 391 #define INSN_FROM_TARGET_P(INSN) ((INSN)->in_struct)
 392
 393 /* Holds a list of notes on what this insn does to various REGs.
 394    It is a chain of EXPR_LIST rtx's, where the second operand
 395    is the chain pointer and the first operand is the REG being described.
 396    The mode field of the EXPR_LIST contains not a real machine mode
 397    but a value that says what this note says about the REG:
 398      REG_DEAD means that the value in REG dies in this insn (i.e., it is
 399    not needed past this insn).  If REG is set in this insn, the REG_DEAD
 400    note may, but need not, be omitted.
 401      REG_INC means that the REG is autoincremented or autodecremented.
 402      REG_EQUIV describes the insn as a whole; it says that the insn
 403    sets a register to a constant value or to be equivalent to a memory
 404    address.  If the register is spilled to the stack then the constant
 405    value should be substituted for it.  The contents of the REG_EQUIV
 406    is the constant value or memory address, which may be different
 407    from the source of the SET although it has the same value.  A
 408    REG_EQUIV note may also appear on an insn which copies a register
 409    parameter to a pseudo-register, if there is a memory address which
 410    could be used to hold that pseudo-register throughout the function.
 411      REG_EQUAL is like REG_EQUIV except that the destination
 412    is only momentarily equal to the specified rtx.  Therefore, it
 413    cannot be used for substitution; but it can be used for cse.
 414      REG_RETVAL means that this insn copies the return-value of
 415    a library call out of the hard reg for return values.  This note
 416    is actually an INSN_LIST and it points to the first insn involved
 417    in setting up arguments for the call.  flow.c uses this to delete
 418    the entire library call when its result is dead.
 419      REG_LIBCALL is the inverse of REG_RETVAL: it goes on the first insn
 420    of the library call and points at the one that has the REG_RETVAL.
 421      REG_WAS_0 says that the register set in this insn held 0 before the insn.
 422    The contents of the note is the insn that stored the 0.
 423    If that insn is deleted or patched to a NOTE, the REG_WAS_0 is inoperative.
 424    The REG_WAS_0 note is actually an INSN_LIST, not an EXPR_LIST.
 425      REG_NONNEG means that the register is always nonnegative during
 426    the containing loop.  This is used in branches so that decrement and
 427    branch instructions terminating on zero can be matched.  There must be
 428    an insn pattern in the md file named `decrement_and_branch_until_zero'
 429    or else this will never be added to any instructions.
 430      REG_NO_CONFLICT means there is no conflict *after this insn*
 431    between the register in the note and the destination of this insn.
 432      REG_UNUSED identifies a register set in this insn and never used.
 433      REG_CC_SETTER and REG_CC_USER link a pair of insns that set and use
 434    CC0, respectively.  Normally, these are required to be consecutive insns,
 435    but we permit putting a cc0-setting insn in the delay slot of a branch
 436    as long as only one copy of the insn exists.  In that case, these notes
 437    point from one to the other to allow code generation to determine what
 438    any require information and to properly update CC_STATUS.
 439      REG_LABEL points to a CODE_LABEL.  Used by non-JUMP_INSNs to
 440    say that the CODE_LABEL contained in the REG_LABEL note is used
 441    by the insn.
 442      REG_DEP_ANTI is used in LOG_LINKS which represent anti (write after read)
 443    dependencies.  REG_DEP_OUTPUT is used in LOG_LINKS which represent output
 444    (write after write) dependencies.  Data dependencies, which are the only
 445    type of LOG_LINK created by flow, are represented by a 0 reg note kind.  */
 446 /*   REG_BR_PROB is attached to JUMP_INSNs and CALL_INSNs when the flag
 447    -fbranch-probabilities is given.  It has an integer value.  For jumps,
 448    it is the probability that this is a taken branch.  For calls, it is the
 449    probability that this call won't return.
 450      REG_EXEC_COUNT is attached to the first insn of each basic block, and
 451    the first insn after each CALL_INSN.  It indicates how many times this
 452    block was executed.
 453      REG_SAVE_AREA is used to optimize rtl generated by dynamic stack
 454    allocations for targets where SETJMP_VIA_SAVE_AREA is true.
 455      REG_BR_PRED is attached to JUMP_INSNs only, it holds the branch prediction
 456    flags computed by get_jump_flags() after dbr scheduling is complete.
 457      REG_FRAME_RELATED_EXPR is attached to insns that are RTX_FRAME_RELATED_P,
 458    but are too complex for DWARF to interpret what they imply.  The attached
 459    rtx is used instead of intuition.  */
 460 /*   REG_EH_REGION is used to indicate what exception region an INSN
 461    belongs in.  This can be used to indicate what region a call may throw
 462    to. a REGION of 0 indicates that a call cannot throw at all.
 463    a REGION  of -1 indicates that it cannot throw, nor will it execute
 464    a non-local goto.
 465      REG_EH_RETHROW is used to indicate that a call is actually a
 466    call to rethrow, and specifies the rethrow symbol for the region
 467    the rethrow is targetting.  This provides a way to generate the
 468    non standard flow edges required for a rethrow. */
 469
 470
 471 #define REG_NOTES(INSN) XEXP(INSN, 6)
 472
 473 #define ADDR_DIFF_VEC_FLAGS(RTX) X0ADVFLAGS(RTX, 4)
 474
 475 /* Don't forget to change reg_note_name in rtl.c.  */
 476 enum reg_note { REG_DEAD = 1, REG_INC = 2, REG_EQUIV = 3, REG_WAS_0 = 4,
 477                 REG_EQUAL = 5, REG_RETVAL = 6, REG_LIBCALL = 7,
 478                 REG_NONNEG = 8, REG_NO_CONFLICT = 9, REG_UNUSED = 10,
 479                 REG_CC_SETTER = 11, REG_CC_USER = 12, REG_LABEL = 13,
 480                 REG_DEP_ANTI = 14, REG_DEP_OUTPUT = 15, REG_BR_PROB = 16,
 481                 REG_EXEC_COUNT = 17, REG_NOALIAS = 18, REG_SAVE_AREA = 19,
 482                 REG_BR_PRED = 20, REG_EH_CONTEXT = 21,
 483                 REG_FRAME_RELATED_EXPR = 22, REG_EH_REGION = 23,
 484                 REG_EH_RETHROW = 24 };
 485 /* The base value for branch probability notes.  */
 486 #define REG_BR_PROB_BASE  10000
 487
 488 /* Define macros to extract and insert the reg-note kind in an EXPR_LIST.  */
 489 #define REG_NOTE_KIND(LINK) ((enum reg_note) GET_MODE (LINK))
 490 #define PUT_REG_NOTE_KIND(LINK,KIND) PUT_MODE(LINK, (enum machine_mode) (KIND))
 491
 492 /* Names for REG_NOTE's in EXPR_LIST insn's.  */
 493
 494 extern const char * const reg_note_name[];
 495 #define GET_REG_NOTE_NAME(MODE) (reg_note_name[(int) (MODE)])
 496
 497 /* This field is only present on CALL_INSNs.  It holds a chain of EXPR_LIST of
 498    USE and CLOBBER expressions.
 499      USE expressions list the registers filled with arguments that
 500    are passed to the function.
 501      CLOBBER expressions document the registers explicitly clobbered
 502    by this CALL_INSN.
 503      Pseudo registers can not be mentioned in this list.  */
 504 #define CALL_INSN_FUNCTION_USAGE(INSN)  XEXP(INSN, 7)
 505
 506 /* The label-number of a code-label.  The assembler label
 507    is made from `L' and the label-number printed in decimal.
 508    Label numbers are unique in a compilation.  */
 509 #define CODE_LABEL_NUMBER(INSN) XINT(INSN, 3)
 510
 511 #define LINE_NUMBER NOTE
 512
 513 /* In a NOTE that is a line number, this is a string for the file name that the
 514    line is in.  We use the same field to record block numbers temporarily in
 515    NOTE_INSN_BLOCK_BEG and NOTE_INSN_BLOCK_END notes.  (We avoid lots of casts
 516    between ints and pointers if we use a different macro for the block number.)
 517    The NOTE_INSN_RANGE_{START,END} and NOTE_INSN_LIVE notes record their
 518    information as a rtx in the field.  */
 519
 520 #define NOTE_SOURCE_FILE(INSN)  XCSTR(INSN, 3, NOTE)
 521 #define NOTE_BLOCK(INSN)        XCTREE(INSN, 3, NOTE)
 522 #define NOTE_EH_HANDLER(INSN)   XCINT(INSN, 3, NOTE)
 523 #define NOTE_RANGE_INFO(INSN)   XCEXP(INSN, 3, NOTE)
 524 #define NOTE_LIVE_INFO(INSN)    XCEXP(INSN, 3, NOTE)
 525 #define NOTE_BASIC_BLOCK(INSN)  XCBBDEF(INSN, 3, NOTE)
 526
 527 /* In a NOTE that is a line number, this is the line number.
 528    Other kinds of NOTEs are identified by negative numbers here.  */
 529 #define NOTE_LINE_NUMBER(INSN) XCINT(INSN, 4, NOTE)
 530
 531 /* Codes that appear in the NOTE_LINE_NUMBER field
 532    for kinds of notes that are not line numbers.
 533
 534    Notice that we do not try to use zero here for any of
 535    the special note codes because sometimes the source line
 536    actually can be zero!  This happens (for example) when we
 537    are generating code for the per-translation-unit constructor
 538    and destructor routines for some C++ translation unit.
 539
 540    If you should change any of the following values, or if you
 541    should add a new value here, don't forget to change the
 542    note_insn_name array in rtl.c.  */
 543
 544 /* This note is used to get rid of an insn
 545    when it isn't safe to patch the insn out of the chain.  */
 546 #define NOTE_INSN_DELETED -1
 547 #define NOTE_INSN_BLOCK_BEG -2
 548 #define NOTE_INSN_BLOCK_END -3
 549 #define NOTE_INSN_LOOP_BEG -4
 550 #define NOTE_INSN_LOOP_END -5
 551 /* This kind of note is generated at the end of the function body,
 552    just before the return insn or return label.
 553    In an optimizing compilation it is deleted by the first jump optimization,
 554    after enabling that optimizer to determine whether control can fall
 555    off the end of the function body without a return statement.  */
 556 #define NOTE_INSN_FUNCTION_END -6
 557 /* This kind of note is generated just after each call to `setjmp', et al.  */
 558 #define NOTE_INSN_SETJMP -7
 559 /* Generated at the place in a loop that `continue' jumps to.  */
 560 #define NOTE_INSN_LOOP_CONT -8
 561 /* Generated at the start of a duplicated exit test.  */
 562 #define NOTE_INSN_LOOP_VTOP -9
 563 /* This marks the point immediately after the last prologue insn.  */
 564 #define NOTE_INSN_PROLOGUE_END -10
 565 /* This marks the point immediately prior to the first epilogue insn.  */
 566 #define NOTE_INSN_EPILOGUE_BEG -11
 567 /* Generated in place of user-declared labels when they are deleted.  */
 568 #define NOTE_INSN_DELETED_LABEL -12
 569 /* This note indicates the start of the real body of the function,
 570    i.e. the point just after all of the parms have been moved into
 571    their homes, etc.  */
 572 #define NOTE_INSN_FUNCTION_BEG -13
 573 /* These note where exception handling regions begin and end.  */
 574 #define NOTE_INSN_EH_REGION_BEG -14
 575 #define NOTE_INSN_EH_REGION_END -15
 576 /* Generated whenever a duplicate line number note is output.  For example,
 577    one is output after the end of an inline function, in order to prevent
 578    the line containing the inline call from being counted twice in gcov. */
 579 #define NOTE_REPEATED_LINE_NUMBER -16
 580
 581 /* Start/end of a live range region, where pseudos allocated on the stack can
 582    be allocated to temporary registers.  */
 583 #define NOTE_INSN_RANGE_START -17
 584 #define NOTE_INSN_RANGE_END -18
 585 /* Record which registers are currently live.  */
 586 #define NOTE_INSN_LIVE -19
 587 /* Record the struct for the following basic block.  */
 588 #define NOTE_INSN_BASIC_BLOCK -20
 589
 590 /* Names for NOTE insn's other than line numbers.  */
 591
 592 extern const char * const note_insn_name[];
 593 #define GET_NOTE_INSN_NAME(NOTE_CODE) (note_insn_name[-(NOTE_CODE)])
 594
 595 /* The name of a label, in case it corresponds to an explicit label
 596    in the input source code.  */
 597 #define LABEL_NAME(RTX) XCSTR(RTX, 4, CODE_LABEL)
 598
 599 /* In jump.c, each label contains a count of the number
 600    of LABEL_REFs that point at it, so unused labels can be deleted.  */
 601 #define LABEL_NUSES(RTX) XCINT(RTX, 5, CODE_LABEL)
 602
 603 /* The original regno this ADDRESSOF was built for.  */
 604 #define ADDRESSOF_REGNO(RTX) XCINT(RTX, 1, ADDRESSOF)
 605
 606 /* The variable in the register we took the address of.  */
 607 #define ADDRESSOF_DECL(RTX) XCTREE(RTX, 2, ADDRESSOF)
 608
 609 /* In jump.c, each JUMP_INSN can point to a label that it can jump to,
 610    so that if the JUMP_INSN is deleted, the label's LABEL_NUSES can
 611    be decremented and possibly the label can be deleted.  */
 612 #define JUMP_LABEL(INSN)   XCEXP(INSN, 7, JUMP_INSN)
 613
 614 /* Once basic blocks are found in flow.c,
 615    each CODE_LABEL starts a chain that goes through
 616    all the LABEL_REFs that jump to that label.
 617    The chain eventually winds up at the CODE_LABEL; it is circular.  */
 618 #define LABEL_REFS(LABEL) XCEXP(LABEL, 6, CODE_LABEL)
 619 \f
 620 /* This is the field in the LABEL_REF through which the circular chain
 621    of references to a particular label is linked.
 622    This chain is set up in flow.c.  */
 623
 624 #define LABEL_NEXTREF(REF) XCEXP(REF, 1, LABEL_REF)
 625
 626 /* Once basic blocks are found in flow.c,
 627    Each LABEL_REF points to its containing instruction with this field.  */
 628
 629 #define CONTAINING_INSN(RTX) XCEXP(RTX, 2, LABEL_REF)
 630
 631 /* For a REG rtx, REGNO extracts the register number.  */
 632
 633 #define REGNO(RTX) XCINT(RTX, 0, REG)
 634
 635 /* For a REG rtx, REG_FUNCTION_VALUE_P is nonzero if the reg
 636    is the current function's return value.  */
 637
 638 #define REG_FUNCTION_VALUE_P(RTX) ((RTX)->integrated)
 639
 640 /* 1 in a REG rtx if it corresponds to a variable declared by the user.  */
 641 #define REG_USERVAR_P(RTX) ((RTX)->volatil)
 642
 643 /* For a CONST_INT rtx, INTVAL extracts the integer.  */
 644
 645 #define INTVAL(RTX) XCWINT(RTX, 0, CONST_INT)
 646
 647 /* For a SUBREG rtx, SUBREG_REG extracts the value we want a subreg of.
 648    SUBREG_WORD extracts the word-number.  */
 649
 650 #define SUBREG_REG(RTX) XCEXP(RTX, 0, SUBREG)
 651 #define SUBREG_WORD(RTX) XCINT(RTX, 1, SUBREG)
 652
 653 /* 1 if the REG contained in SUBREG_REG is already known to be
 654    sign- or zero-extended from the mode of the SUBREG to the mode of
 655    the reg.  SUBREG_PROMOTED_UNSIGNED_P gives the signedness of the
 656    extension.
 657
 658    When used as a LHS, is means that this extension must be done
 659    when assigning to SUBREG_REG.  */
 660
 661 #define SUBREG_PROMOTED_VAR_P(RTX) ((RTX)->in_struct)
 662 #define SUBREG_PROMOTED_UNSIGNED_P(RTX) ((RTX)->unchanging)
 663
 664 /* Access various components of an ASM_OPERANDS rtx.  */
 665
 666 #define ASM_OPERANDS_TEMPLATE(RTX) XCSTR ((RTX), 0, ASM_OPERANDS)
 667 #define ASM_OPERANDS_OUTPUT_CONSTRAINT(RTX) XCSTR ((RTX), 1, ASM_OPERANDS)
 668 #define ASM_OPERANDS_OUTPUT_IDX(RTX) XCINT ((RTX), 2, ASM_OPERANDS)
 669 #define ASM_OPERANDS_INPUT_VEC(RTX) XCVEC ((RTX), 3, ASM_OPERANDS)
 670 #define ASM_OPERANDS_INPUT_CONSTRAINT_VEC(RTX) XCVEC ((RTX), 4, ASM_OPERANDS)
 671 #define ASM_OPERANDS_INPUT(RTX, N) XCVECEXP ((RTX), 3, (N), ASM_OPERANDS)
 672 #define ASM_OPERANDS_INPUT_LENGTH(RTX) XCVECLEN ((RTX), 3, ASM_OPERANDS)
 673 #define ASM_OPERANDS_INPUT_CONSTRAINT(RTX, N) XSTR (XCVECEXP ((RTX), 4, (N), ASM_OPERANDS), 0)
 674 #define ASM_OPERANDS_INPUT_MODE(RTX, N) GET_MODE (XCVECEXP ((RTX), 4, (N), ASM_OPERANDS))
 675 #define ASM_OPERANDS_SOURCE_FILE(RTX) XCSTR ((RTX), 5, ASM_OPERANDS)
 676 #define ASM_OPERANDS_SOURCE_LINE(RTX) XCINT ((RTX), 6, ASM_OPERANDS)
 677
 678 /* For a MEM rtx, 1 if it's a volatile reference.
 679    Also in an ASM_OPERANDS rtx.  */
 680 #define MEM_VOLATILE_P(RTX) ((RTX)->volatil)
 681
 682 /* For a MEM rtx, 1 if it refers to a field of an aggregate.  If zero,
 683    RTX may or may not refer to a field of an aggregate.  */
 684 #define MEM_IN_STRUCT_P(RTX) ((RTX)->in_struct)
 685
 686 /* For a MEM rtx, 1 if it refers to a scalar.  If zero, RTX may or may
 687    not refer to a scalar.*/
 688 #define MEM_SCALAR_P(RTX) ((RTX)->frame_related)
 689
 690 /* Copy the MEM_VOLATILE_P, MEM_IN_STRUCT_P, and MEM_SCALAR_P
 691    attributes from RHS to LHS.  */
 692 #define MEM_COPY_ATTRIBUTES(LHS, RHS)                   \
 693   (MEM_VOLATILE_P (LHS) = MEM_VOLATILE_P (RHS),         \
 694    MEM_IN_STRUCT_P (LHS) = MEM_IN_STRUCT_P (RHS),       \
 695    MEM_SCALAR_P (LHS) = MEM_SCALAR_P (RHS))
 696
 697 /* If VAL is non-zero, set MEM_IN_STRUCT_P and clear MEM_SCALAR_P in
 698    RTX.  Otherwise, vice versa.  Use this macro only when you are
 699    *sure* that you know that the MEM is in a structure, or is a
 700    scalar.  VAL is evaluated only once.  */
 701 #define MEM_SET_IN_STRUCT_P(RTX, VAL)                           \
 702   ((VAL) ? (MEM_IN_STRUCT_P (RTX) = 1, MEM_SCALAR_P (RTX) = 0)  \
 703    : (MEM_IN_STRUCT_P (RTX) = 0, MEM_SCALAR_P (RTX) = 1))
 704
 705 /* For a MEM rtx, the alias set.  If 0, this MEM is not in any alias
 706    set, and may alias anything.  Otherwise, the MEM can only alias
 707    MEMs in the same alias set.  This value is set in a
 708    language-dependent manner in the front-end, and should not be
 709    altered in the back-end.  These set numbers are tested for zero,
 710    and compared for equality; they have no other significance.  In
 711    some front-ends, these numbers may correspond in some way to types,
 712    or other language-level entities, but they need not, and the
 713    back-end makes no such assumptions.  */
 714 #define MEM_ALIAS_SET(RTX) XCINT(RTX, 1, MEM)
 715
 716 /* For a LABEL_REF, 1 means that this reference is to a label outside the
 717    loop containing the reference.  */
 718 #define LABEL_OUTSIDE_LOOP_P(RTX) ((RTX)->in_struct)
 719
 720 /* For a LABEL_REF, 1 means it is for a nonlocal label.  */
 721 /* Likewise in an EXPR_LIST for a REG_LABEL note.  */
 722 #define LABEL_REF_NONLOCAL_P(RTX) ((RTX)->volatil)
 723
 724 /* For a CODE_LABEL, 1 means always consider this label to be needed.  */
 725 #define LABEL_PRESERVE_P(RTX) ((RTX)->in_struct)
 726
 727 /* For a REG, 1 means the register is used only in an exit test of a loop.  */
 728 #define REG_LOOP_TEST_P(RTX) ((RTX)->in_struct)
 729
 730 /* During sched, for an insn, 1 means that the insn must be scheduled together
 731    with the preceding insn.  */
 732 #define SCHED_GROUP_P(INSN) ((INSN)->in_struct)
 733
 734 /* During sched, for the LOG_LINKS of an insn, these cache the adjusted
 735    cost of the dependence link.  The cost of executing an instruction
 736    may vary based on how the results are used.  LINK_COST_ZERO is 1 when
 737    the cost through the link varies and is unchanged (i.e., the link has
 738    zero additional cost).  LINK_COST_FREE is 1 when the cost through the
 739    link is zero (i.e., the link makes the cost free).  In other cases,
 740    the adjustment to the cost is recomputed each time it is needed.  */
 741 #define LINK_COST_ZERO(X) ((X)->jump)
 742 #define LINK_COST_FREE(X) ((X)->call)
 743
 744 /* For a SET rtx, SET_DEST is the place that is set
 745    and SET_SRC is the value it is set to.  */
 746 #define SET_DEST(RTX) XC2EXP(RTX, 0, SET, CLOBBER)
 747 #define SET_SRC(RTX) XCEXP(RTX, 1, SET)
 748
 749 /* For a TRAP_IF rtx, TRAP_CONDITION is an expression.  */
 750 #define TRAP_CONDITION(RTX) XCEXP(RTX, 0, TRAP_IF)
 751 #define TRAP_CODE(RTX) XCEXP(RTX, 1, TRAP_IF)
 752
 753 /* 1 in a SYMBOL_REF if it addresses this function's constants pool.  */
 754 #define CONSTANT_POOL_ADDRESS_P(RTX) ((RTX)->unchanging)
 755
 756 /* Flag in a SYMBOL_REF for machine-specific purposes.  */
 757 #define SYMBOL_REF_FLAG(RTX) ((RTX)->volatil)
 758
 759 /* 1 in a SYMBOL_REF if it represents a symbol which might have to change
 760    if its inlined or unrolled. */
 761 #define SYMBOL_REF_NEED_ADJUST(RTX)  ((RTX)->in_struct)
 762
 763 /* 1 means a SYMBOL_REF has been the library function in emit_library_call.  */
 764 #define SYMBOL_REF_USED(RTX) ((RTX)->used)
 765
 766 /* Define a macro to look for REG_INC notes,
 767    but save time on machines where they never exist.  */
 768
 769 /* Don't continue this line--convex cc version 4.1 would lose.  */
 770 #if (defined (HAVE_PRE_INCREMENT) || defined (HAVE_PRE_DECREMENT) || defined (HAVE_POST_INCREMENT) || defined (HAVE_POST_DECREMENT))
 771 #define FIND_REG_INC_NOTE(insn, reg) (find_reg_note ((insn), REG_INC, (reg)))
 772 #else
 773 #define FIND_REG_INC_NOTE(insn, reg) 0
 774 #endif
 775
 776 /* Indicate whether the machine has any sort of auto increment addressing.
 777    If not, we can avoid checking for REG_INC notes.  */
 778
 779 /* Don't continue this line--convex cc version 4.1 would lose.  */
 780 #if (defined (HAVE_PRE_INCREMENT) || defined (HAVE_PRE_DECREMENT) || defined (HAVE_POST_INCREMENT) || defined (HAVE_POST_DECREMENT))
 781 #define AUTO_INC_DEC
 782 #endif
 783
 784 #ifndef HAVE_PRE_INCREMENT
 785 #define HAVE_PRE_INCREMENT 0
 786 #endif
 787
 788 #ifndef HAVE_PRE_DECREMENT
 789 #define HAVE_PRE_DECREMENT 0
 790 #endif
 791
 792 #ifndef HAVE_POST_INCREMENT
 793 #define HAVE_POST_INCREMENT 0
 794 #endif
 795
 796 #ifndef HAVE_POST_DECREMENT
 797 #define HAVE_POST_DECREMENT 0
 798 #endif
 799
 800
 801 /* Some architectures do not have complete pre/post increment/decrement
 802    instruction sets, or only move some modes efficiently.  These macros
 803    allow us to tune autoincrement generation.  */
 804
 805 #ifndef USE_LOAD_POST_INCREMENT
 806 #define USE_LOAD_POST_INCREMENT(MODE)   HAVE_POST_INCREMENT
 807 #endif
 808
 809 #ifndef USE_LOAD_POST_DECREMENT
 810 #define USE_LOAD_POST_DECREMENT(MODE)   HAVE_POST_DECREMENT
 811 #endif
 812
 813 #ifndef USE_LOAD_PRE_INCREMENT
 814 #define USE_LOAD_PRE_INCREMENT(MODE)    HAVE_PRE_INCREMENT
 815 #endif
 816
 817 #ifndef USE_LOAD_PRE_DECREMENT
 818 #define USE_LOAD_PRE_DECREMENT(MODE)    HAVE_PRE_DECREMENT
 819 #endif
 820
 821 #ifndef USE_STORE_POST_INCREMENT
 822 #define USE_STORE_POST_INCREMENT(MODE)  HAVE_POST_INCREMENT
 823 #endif
 824
 825 #ifndef USE_STORE_POST_DECREMENT
 826 #define USE_STORE_POST_DECREMENT(MODE)  HAVE_POST_DECREMENT
 827 #endif
 828
 829 #ifndef USE_STORE_PRE_INCREMENT
 830 #define USE_STORE_PRE_INCREMENT(MODE)   HAVE_PRE_INCREMENT
 831 #endif
 832
 833 #ifndef USE_STORE_PRE_DECREMENT
 834 #define USE_STORE_PRE_DECREMENT(MODE)   HAVE_PRE_DECREMENT
 835 #endif
 836
 837
 838 /* Accessors for RANGE_INFO.  */
 839 /* For RANGE_{START,END} notes return the RANGE_START note.  */
 840 #define RANGE_INFO_NOTE_START(INSN) XCEXP (INSN, 0, RANGE_INFO)
 841
 842 /* For RANGE_{START,END} notes return the RANGE_START note.  */
 843 #define RANGE_INFO_NOTE_END(INSN) XCEXP (INSN, 1, RANGE_INFO)
 844
 845 /* For RANGE_{START,END} notes, return the vector containing the registers used
 846    in the range.  */
 847 #define RANGE_INFO_REGS(INSN) XCVEC (INSN, 2, RANGE_INFO)
 848 #define RANGE_INFO_REGS_REG(INSN, N) XCVECEXP (INSN, 2, N, RANGE_INFO)
 849 #define RANGE_INFO_NUM_REGS(INSN) XCVECLEN (INSN, 2, RANGE_INFO)
 850
 851 /* For RANGE_{START,END} notes, the number of calls within the range.  */
 852 #define RANGE_INFO_NCALLS(INSN) XCINT (INSN, 3, RANGE_INFO)
 853
 854 /* For RANGE_{START,END} notes, the number of insns within the range.  */
 855 #define RANGE_INFO_NINSNS(INSN) XCINT (INSN, 4, RANGE_INFO)
 856
 857 /* For RANGE_{START,END} notes, a unique # to identify this range.  */
 858 #define RANGE_INFO_UNIQUE(INSN) XCINT (INSN, 5, RANGE_INFO)
 859
 860 /* For RANGE_{START,END} notes, the basic block # the range starts with. */
 861 #define RANGE_INFO_BB_START(INSN) XCINT (INSN, 6, RANGE_INFO)
 862
 863 /* For RANGE_{START,END} notes, the basic block # the range ends with. */
 864 #define RANGE_INFO_BB_END(INSN) XCINT (INSN, 7, RANGE_INFO)
 865
 866 /* For RANGE_{START,END} notes, the loop depth the range is in.  */
 867 #define RANGE_INFO_LOOP_DEPTH(INSN) XCINT (INSN, 8, RANGE_INFO)
 868
 869 /* For RANGE_{START,END} notes, the bitmap of live registers at the start
 870    of the range.  */
 871 #define RANGE_INFO_LIVE_START(INSN) XCBITMAP (INSN, 9, RANGE_INFO)
 872
 873 /* For RANGE_{START,END} notes, the bitmap of live registers at the end
 874    of the range.  */
 875 #define RANGE_INFO_LIVE_END(INSN) XCBITMAP (INSN, 10, RANGE_INFO)
 876
 877 /* For RANGE_START notes, the marker # of the start of the range.  */
 878 #define RANGE_INFO_MARKER_START(INSN) XCINT (INSN, 11, RANGE_INFO)
 879
 880 /* For RANGE_START notes, the marker # of the end of the range.  */
 881 #define RANGE_INFO_MARKER_END(INSN) XCINT (INSN, 12, RANGE_INFO)
 882
 883 /* Original pseudo register # for a live range note.  */
 884 #define RANGE_REG_PSEUDO(INSN,N) XCINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 0, REG)
 885
 886 /* Pseudo register # original register is copied into or -1.  */
 887 #define RANGE_REG_COPY(INSN,N) XCINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 1, REG)
 888
 889 /* How many times a register in a live range note was referenced.  */
 890 #define RANGE_REG_REFS(INSN,N) XINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 2)
 891
 892 /* How many times a register in a live range note was set.  */
 893 #define RANGE_REG_SETS(INSN,N) XINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 3)
 894
 895 /* How many times a register in a live range note died.  */
 896 #define RANGE_REG_DEATHS(INSN,N) XINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 4)
 897
 898 /* Whether the original value is needed to be copied into the range register at
 899    the start of the range. */
 900 #define RANGE_REG_COPY_FLAGS(INSN,N) XINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 5)
 901
 902 /* # of insns the register copy is live over.  */
 903 #define RANGE_REG_LIVE_LENGTH(INSN,N) XINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 6)
 904
 905 /* # of calls the register copy is live over.  */
 906 #define RANGE_REG_N_CALLS(INSN,N) XINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 7)
 907
 908 /* DECL_NODE pointer of the declaration if the register is a user defined
 909    variable.  */
 910 #define RANGE_REG_SYMBOL_NODE(INSN,N) XTREE (XCVECEXP (INSN, 2, N, RANGE_INFO), 8)
 911
 912 /* BLOCK_NODE pointer to the block the variable is declared in if the
 913    register is a user defined variable.  */
 914 #define RANGE_REG_BLOCK_NODE(INSN,N) XTREE (XCVECEXP (INSN, 2, N, RANGE_INFO), 9)
 915
 916 /* EXPR_LIST of the distinct ranges a variable is in.  */
 917 #define RANGE_VAR_LIST(INSN) (XEXP (INSN, 0))
 918
 919 /* Block a variable is declared in.  */
 920 #define RANGE_VAR_BLOCK(INSN) (XTREE (INSN, 1))
 921
 922 /* # of distinct ranges a variable is in.  */
 923 #define RANGE_VAR_NUM(INSN) (XINT (INSN, 2))
 924
 925 /* For a NOTE_INSN_LIVE note, the registers which are currently live.  */
 926 #define RANGE_LIVE_BITMAP(INSN) (XBITMAP (INSN, 0))
 927
 928 /* For a NOTE_INSN_LIVE note, the original basic block number.  */
 929 #define RANGE_LIVE_ORIG_BLOCK(INSN) (XINT (INSN, 1))
 930 \f
 931 /* Nonzero if we need to distinguish between the return value of this function
 932    and the return value of a function called by this function.  This helps
 933    integrate.c.
 934    This is 1 until after the rtl generation pass.  */
 935 extern int rtx_equal_function_value_matters;
 936
 937 /* Generally useful functions.  */
 938
 939 /* The following functions accept a wide integer argument.  Rather than
 940    having to cast on every function call, we use a macro instead, that is
 941    defined here and in tree.h.  */
 942
 943 #ifndef exact_log2
 944 #define exact_log2(N) exact_log2_wide ((unsigned HOST_WIDE_INT) (N))
 945 #define floor_log2(N) floor_log2_wide ((unsigned HOST_WIDE_INT) (N))
 946 #endif
 947 extern int exact_log2_wide              PROTO((unsigned HOST_WIDE_INT));
 948 extern int floor_log2_wide              PROTO((unsigned HOST_WIDE_INT));
 949
 950 /* In expmed.c */
 951 extern int ceil_log2                    PROTO((unsigned HOST_WIDE_INT));
 952
 953 #define plus_constant(X,C) plus_constant_wide (X, (HOST_WIDE_INT) (C))
 954
 955 #define plus_constant_for_output(X,C)  \
 956   plus_constant_for_output_wide (X, (HOST_WIDE_INT) (C))
 957
 958 /* In explow.c */
 959 extern HOST_WIDE_INT trunc_int_for_mode PROTO((HOST_WIDE_INT,
 960                                                enum machine_mode));
 961 extern rtx plus_constant_wide            PROTO((rtx, HOST_WIDE_INT));
 962 extern rtx plus_constant_for_output_wide PROTO((rtx, HOST_WIDE_INT));
 963 extern void optimize_save_area_alloca   PROTO((rtx));
 964
 965 extern rtx gen_rtx                      PVPROTO((enum rtx_code,
 966                                                  enum machine_mode, ...));
 967 extern rtvec gen_rtvec                  PVPROTO((int, ...));
 968
 969 #ifdef BUFSIZ
 970 extern rtx read_rtx                     PROTO((FILE *));
 971 #endif
 972
 973 extern char *oballoc                    PROTO((int));
 974 extern char *permalloc                  PROTO((int));
 975 extern rtx rtx_alloc                    PROTO((RTX_CODE));
 976 extern rtvec rtvec_alloc                PROTO((int));
 977 extern rtx copy_rtx                     PROTO((rtx));
 978 extern rtx copy_rtx_if_shared           PROTO((rtx));
 979 extern rtx copy_most_rtx                PROTO((rtx, rtx));
 980 extern rtx shallow_copy_rtx             PROTO((rtx));
 981 extern rtvec gen_rtvec_v                PROTO((int, rtx *));
 982 extern rtx gen_reg_rtx                  PROTO((enum machine_mode));
 983 extern rtx gen_label_rtx                PROTO((void));
 984 extern rtx gen_lowpart_common           PROTO((enum machine_mode, rtx));
 985 extern rtx gen_lowpart                  PROTO((enum machine_mode, rtx));
 986 extern rtx gen_lowpart_if_possible      PROTO((enum machine_mode, rtx));
 987 extern rtx gen_highpart                 PROTO((enum machine_mode, rtx));
 988 extern rtx gen_realpart                 PROTO((enum machine_mode, rtx));
 989 extern rtx gen_imagpart                 PROTO((enum machine_mode, rtx));
 990 extern rtx operand_subword              PROTO((rtx, int, int, enum machine_mode));
 991 extern rtx operand_subword_force        PROTO((rtx, int, enum machine_mode));
 992 extern int subreg_lowpart_p             PROTO((rtx));
 993 extern rtx make_safe_from               PROTO((rtx, rtx));
 994 extern rtx convert_memory_address       PROTO((enum machine_mode, rtx));
 995 extern rtx memory_address               PROTO((enum machine_mode, rtx));
 996 extern rtx get_insns                    PROTO((void));
 997 extern const char *get_insn_name        PROTO((int));
 998 extern rtx get_last_insn                PROTO((void));
 999 extern rtx get_last_insn_anywhere       PROTO((void));
1000 extern void start_sequence              PROTO((void));
1001 extern void push_to_sequence            PROTO((rtx));
1002 extern void end_sequence                PROTO((void));
1003 extern rtx gen_sequence                 PROTO((void));
1004 extern rtx immed_double_const           PROTO((HOST_WIDE_INT, HOST_WIDE_INT, enum machine_mode));
1005 extern rtx force_const_mem              PROTO((enum machine_mode, rtx));
1006 extern rtx force_reg                    PROTO((enum machine_mode, rtx));
1007 extern rtx get_pool_constant            PROTO((rtx));
1008 extern enum machine_mode get_pool_mode  PROTO((rtx));
1009 extern rtx get_pool_constant_for_function       PROTO((struct function *, rtx));
1010 extern enum machine_mode get_pool_mode_for_function     PROTO((struct function *, rtx));
1011 extern int get_pool_offset              PROTO((rtx));
1012 extern rtx simplify_subtraction         PROTO((rtx));
1013 extern rtx assign_stack_local           PROTO((enum machine_mode,
1014                                                HOST_WIDE_INT, int));
1015 extern rtx assign_stack_temp            PROTO((enum machine_mode,
1016                                                HOST_WIDE_INT, int));
1017 extern rtx assign_temp                  PROTO((union tree_node *,
1018                                                int, int, int));
1019 extern rtx protect_from_queue           PROTO((rtx, int));
1020 extern void emit_queue                  PROTO((void));
1021 extern rtx emit_move_insn               PROTO((rtx, rtx));
1022 extern rtx emit_insn_before             PROTO((rtx, rtx));
1023 extern rtx emit_jump_insn_before        PROTO((rtx, rtx));
1024 extern rtx emit_call_insn_before        PROTO((rtx, rtx));
1025 extern rtx emit_barrier_before          PROTO((rtx));
1026 extern rtx emit_label_before            PROTO((rtx, rtx));
1027 extern rtx emit_note_before             PROTO((int, rtx));
1028 extern rtx emit_insn_after              PROTO((rtx, rtx));
1029 extern rtx emit_jump_insn_after         PROTO((rtx, rtx));
1030 extern rtx emit_barrier_after           PROTO((rtx));
1031 extern rtx emit_label_after             PROTO((rtx, rtx));
1032 extern rtx emit_note_after              PROTO((int, rtx));
1033 extern rtx emit_line_note_after         PROTO((char *, int, rtx));
1034 extern rtx emit_insn                    PROTO((rtx));
1035 extern rtx emit_insns                   PROTO((rtx));
1036 extern rtx emit_insns_before            PROTO((rtx, rtx));
1037 extern rtx emit_insns_after             PROTO((rtx, rtx));
1038 extern rtx emit_jump_insn               PROTO((rtx));
1039 extern rtx emit_call_insn               PROTO((rtx));
1040 extern rtx emit_label                   PROTO((rtx));
1041 extern rtx emit_barrier                 PROTO((void));
1042 extern rtx emit_line_note               PROTO((char *, int));
1043 extern rtx emit_note                    PROTO((char *, int));
1044 extern rtx emit_line_note_force         PROTO((char *, int));
1045 extern rtx make_insn_raw                PROTO((rtx));
1046 extern rtx previous_insn                PROTO((rtx));
1047 extern rtx next_insn                    PROTO((rtx));
1048 extern rtx prev_nonnote_insn            PROTO((rtx));
1049 extern rtx next_nonnote_insn            PROTO((rtx));
1050 extern rtx prev_real_insn               PROTO((rtx));
1051 extern rtx next_real_insn               PROTO((rtx));
1052 extern rtx prev_active_insn             PROTO((rtx));
1053 extern rtx next_active_insn             PROTO((rtx));
1054 extern rtx prev_label                   PROTO((rtx));
1055 extern rtx next_label                   PROTO((rtx));
1056 extern rtx next_cc0_user                PROTO((rtx));
1057 extern rtx prev_cc0_setter              PROTO((rtx));
1058 extern rtx next_nondeleted_insn         PROTO((rtx));
1059 extern enum rtx_code reverse_condition  PROTO((enum rtx_code));
1060 extern enum rtx_code swap_condition     PROTO((enum rtx_code));
1061 extern enum rtx_code unsigned_condition PROTO((enum rtx_code));
1062 extern enum rtx_code signed_condition   PROTO((enum rtx_code));
1063 extern rtx find_equiv_reg               PROTO((rtx, rtx, enum reg_class, int, short *, int, enum machine_mode));
1064 extern rtx squeeze_notes                PROTO((rtx, rtx));
1065 extern rtx delete_insn                  PROTO((rtx));
1066 extern void delete_jump                 PROTO((rtx));
1067 extern rtx get_label_before             PROTO((rtx));
1068 extern rtx get_label_after              PROTO((rtx));
1069 extern rtx follow_jumps                 PROTO((rtx));
1070 extern rtx adj_offsettable_operand      PROTO((rtx, int));
1071 extern rtx try_split                    PROTO((rtx, rtx, int));
1072 extern rtx split_insns                  PROTO((rtx, rtx));
1073 extern rtx simplify_unary_operation     PROTO((enum rtx_code, enum machine_mode, rtx, enum machine_mode));
1074 extern rtx simplify_binary_operation    PROTO((enum rtx_code, enum machine_mode, rtx, rtx));
1075 extern rtx simplify_ternary_operation   PROTO((enum rtx_code, enum machine_mode, enum machine_mode, rtx, rtx, rtx));
1076 extern rtx simplify_relational_operation PROTO((enum rtx_code, enum machine_mode, rtx, rtx));
1077 extern rtx gen_move_insn                PROTO((rtx, rtx));
1078 extern rtx gen_jump                     PROTO((rtx));
1079 extern rtx gen_beq                      PROTO((rtx));
1080 extern rtx gen_bge                      PROTO((rtx));
1081 extern rtx gen_ble                      PROTO((rtx));
1082 extern rtx gen_mem_addressof            PROTO((rtx, union tree_node *));
1083 extern rtx eliminate_constant_term      PROTO((rtx, rtx *));
1084 extern rtx expand_complex_abs           PROTO((enum machine_mode, rtx, rtx, int));
1085 extern enum machine_mode choose_hard_reg_mode PROTO((int, int));
1086 extern void set_unique_reg_note         PROTO((rtx, enum reg_note, rtx));
1087
1088 /* Functions in rtlanal.c */
1089
1090 extern int rtx_unstable_p               PROTO((rtx));
1091 extern int rtx_varies_p                 PROTO((rtx));
1092 extern int rtx_addr_varies_p            PROTO((rtx));
1093 extern HOST_WIDE_INT get_integer_term   PROTO((rtx));
1094 extern rtx get_related_value            PROTO((rtx));
1095 extern int reg_mentioned_p              PROTO((rtx, rtx));
1096 extern int reg_referenced_p             PROTO((rtx, rtx));
1097 extern int reg_used_between_p           PROTO((rtx, rtx, rtx));
1098 extern int reg_referenced_between_p     PROTO((rtx, rtx, rtx));
1099 extern int reg_set_between_p            PROTO((rtx, rtx, rtx));
1100 extern int regs_set_between_p           PROTO((rtx, rtx, rtx));
1101 extern int modified_between_p           PROTO((rtx, rtx, rtx));
1102 extern int no_labels_between_p          PROTO((rtx, rtx));
1103 extern int no_jumps_between_p           PROTO((rtx, rtx));
1104 extern int modified_in_p                PROTO((rtx, rtx));
1105 extern int reg_set_p                    PROTO((rtx, rtx));
1106 extern rtx single_set                   PROTO((rtx));
1107 extern int multiple_sets                PROTO((rtx));
1108 extern rtx find_last_value              PROTO((rtx, rtx *, rtx, int));
1109 extern int refers_to_regno_p            PROTO((int, int, rtx, rtx *));
1110 extern int reg_overlap_mentioned_p      PROTO((rtx, rtx));
1111 extern void note_stores                 PROTO((rtx, void (*)(rtx, rtx)));
1112 extern rtx reg_set_last                 PROTO((rtx, rtx));
1113 extern int rtx_equal_p                  PROTO((rtx, rtx));
1114 extern int dead_or_set_p                PROTO((rtx, rtx));
1115 extern int dead_or_set_regno_p          PROTO((rtx, int));
1116 extern rtx find_reg_note                PROTO((rtx, enum reg_note, rtx));
1117 extern rtx find_regno_note              PROTO((rtx, enum reg_note, int));
1118 extern int find_reg_fusage              PROTO((rtx, enum rtx_code, rtx));
1119 extern int find_regno_fusage            PROTO((rtx, enum rtx_code, int));
1120 extern void remove_note                 PROTO((rtx, rtx));
1121 extern int side_effects_p               PROTO((rtx));
1122 extern int volatile_refs_p              PROTO((rtx));
1123 extern int volatile_insn_p              PROTO((rtx));
1124 extern int may_trap_p                   PROTO((rtx));
1125 extern int inequality_comparisons_p     PROTO ((rtx));
1126 extern rtx replace_rtx                  PROTO((rtx, rtx, rtx));
1127 extern rtx replace_regs                 PROTO((rtx, rtx *, int, int));
1128 extern int computed_jump_p              PROTO((rtx));
1129 typedef int (*rtx_function)             PROTO((rtx *, void *));
1130 extern int for_each_rtx                 PROTO((rtx *, rtx_function, void *));
1131 extern rtx regno_use_in                 PROTO((int, rtx));
1132 extern int auto_inc_p                   PROTO((rtx));
1133 extern void remove_node_from_expr_list  PROTO((rtx, rtx *));
1134 extern int insns_safe_to_move_p         PROTO((rtx, rtx, rtx *));
1135
1136 /* flow.c */
1137
1138 extern rtx find_use_as_address          PROTO((rtx, rtx, HOST_WIDE_INT));
1139 void init_EXPR_INSN_LIST_cache          PROTO((void));
1140 void free_EXPR_LIST_list                PROTO((rtx *));
1141 void free_INSN_LIST_list                PROTO((rtx *));
1142 void free_EXPR_LIST_node                PROTO((rtx));
1143 void free_INSN_LIST_node                PROTO((rtx));
1144 rtx alloc_INSN_LIST                     PROTO((rtx, rtx));
1145 rtx alloc_EXPR_LIST                     PROTO((int, rtx, rtx));
1146
1147 /* regclass.c */
1148
1149 /* Maximum number of parallel sets and clobbers in any insn in this fn.
1150    Always at least 3, since the combiner could put that many togetherm
1151    and we want this to remain correct for all the remaining passes.  */
1152
1153 extern int max_parallel;
1154
1155 /* Free up register info memory.  */
1156 extern void free_reg_info               PROTO((void));
1157
1158 /* recog.c */
1159 extern int asm_noperands                PROTO((rtx));
1160 extern char *decode_asm_operands        PROTO((rtx, rtx *, rtx **,
1161                                                const char **,
1162                                                enum machine_mode *));
1163
1164 extern enum reg_class reg_preferred_class PROTO((int));
1165 extern enum reg_class reg_alternate_class PROTO((int));
1166
1167 extern rtx get_first_nonparm_insn       PROTO((void));
1168
1169 extern void split_block_insns           PROTO((int, int));
1170 extern void update_flow_info            PROTO((rtx, rtx, rtx, rtx));
1171
1172 #define MAX_SAVED_CONST_INT 64
1173 extern rtx const_int_rtx[MAX_SAVED_CONST_INT * 2 + 1];
1174
1175 #define const0_rtx      (const_int_rtx[MAX_SAVED_CONST_INT])
1176 #define const1_rtx      (const_int_rtx[MAX_SAVED_CONST_INT+1])
1177 #define const2_rtx      (const_int_rtx[MAX_SAVED_CONST_INT+2])
1178 #define constm1_rtx     (const_int_rtx[MAX_SAVED_CONST_INT-1])
1179 extern rtx const_true_rtx;
1180
1181 extern rtx const_tiny_rtx[3][(int) MAX_MACHINE_MODE];
1182
1183 /* Returns a constant 0 rtx in mode MODE.  Integer modes are treated the
1184    same as VOIDmode.  */
1185
1186 #define CONST0_RTX(MODE) (const_tiny_rtx[0][(int) (MODE)])
1187
1188 /* Likewise, for the constants 1 and 2.  */
1189
1190 #define CONST1_RTX(MODE) (const_tiny_rtx[1][(int) (MODE)])
1191 #define CONST2_RTX(MODE) (const_tiny_rtx[2][(int) (MODE)])
1192
1193 /* If HARD_FRAME_POINTER_REGNUM is defined, then a special dummy reg
1194    is used to represent the frame pointer.  This is because the
1195    hard frame pointer and the automatic variables are separated by an amount
1196    that cannot be determined until after register allocation.  We can assume
1197    that in this case ELIMINABLE_REGS will be defined, one action of which
1198    will be to eliminate FRAME_POINTER_REGNUM into HARD_FRAME_POINTER_REGNUM. */
1199 #ifndef HARD_FRAME_POINTER_REGNUM
1200 #define HARD_FRAME_POINTER_REGNUM FRAME_POINTER_REGNUM
1201 #endif
1202
1203 /* Index labels for global_rtl.  */
1204 enum global_rtl_index
1205 {
1206   GR_PC,
1207   GR_CC0,
1208   GR_STACK_POINTER,
1209   GR_FRAME_POINTER,
1210 /* For register elimination to work properly these hard_frame_pointer_rtx,
1211    frame_pointer_rtx, and arg_pointer_rtx must be the same if they refer to
1212    the same register.  */
1213 #if FRAME_POINTER_REGNUM == ARG_POINTER_REGNUM
1214   GR_ARG_POINTER = GR_FRAME_POINTER,
1215 #endif
1216 #if HARD_FRAME_POINTER_REGNUM == FRAME_POINTER_REGNUM
1217   GR_HARD_FRAME_POINTER = GR_FRAME_POINTER,
1218 #else
1219   GR_HARD_FRAME_POINTER,
1220 #endif
1221 #if FRAME_POINTER_REGNUM != ARG_POINTER_REGNUM
1222 #if HARD_FRAME_POINTER_REGNUM == ARG_POINTER_REGNUM
1223   GR_ARG_POINTER = GR_HARD_FRAME_POINTER,
1224 #else
1225   GR_ARG_POINTER,
1226 #endif
1227 #endif
1228   GR_VIRTUAL_INCOMING_ARGS,
1229   GR_VIRTUAL_STACK_ARGS,
1230   GR_VIRTUAL_STACK_DYNAMIC,
1231   GR_VIRTUAL_OUTGOING_ARGS,
1232   GR_VIRTUAL_CFA,
1233
1234   GR_MAX
1235 };
1236
1237 /* Pointers to standard pieces of rtx are stored here.  */
1238 extern rtx global_rtl[GR_MAX];
1239
1240 /* Standard pieces of rtx, to be substituted directly into things.  */
1241 #define pc_rtx                  (global_rtl[GR_PC])
1242 #define cc0_rtx                 (global_rtl[GR_CC0])
1243
1244 /* All references to certain hard regs, except those created
1245    by allocating pseudo regs into them (when that's possible),
1246    go through these unique rtx objects.  */
1247 #define stack_pointer_rtx       (global_rtl[GR_STACK_POINTER])
1248 #define frame_pointer_rtx       (global_rtl[GR_FRAME_POINTER])
1249 #define hard_frame_pointer_rtx  (global_rtl[GR_HARD_FRAME_POINTER])
1250 #define arg_pointer_rtx         (global_rtl[GR_ARG_POINTER])
1251
1252 extern rtx pic_offset_table_rtx;
1253 extern rtx struct_value_rtx;
1254 extern rtx struct_value_incoming_rtx;
1255 extern rtx static_chain_rtx;
1256 extern rtx static_chain_incoming_rtx;
1257 extern rtx return_address_pointer_rtx;
1258
1259 /* Include the RTL generation functions.  */
1260
1261 #ifndef NO_GENRTL_H
1262 #include "genrtl.h"
1263 #endif
1264
1265 /* There are some RTL codes that require special attention; the
1266    generation functions included above do the raw handling.  If you
1267    add to this list, modify special_rtx in gengenrtl.c as well.  You
1268    should also modify gen_rtx to use the special function.  */
1269
1270 extern rtx gen_rtx_CONST_DOUBLE PROTO((enum machine_mode, rtx,
1271                                        HOST_WIDE_INT, HOST_WIDE_INT));
1272 extern rtx gen_rtx_CONST_INT PROTO((enum machine_mode, HOST_WIDE_INT));
1273 extern rtx gen_rtx_REG PROTO((enum machine_mode, int));
1274 extern rtx gen_rtx_MEM PROTO((enum machine_mode, rtx));
1275
1276 /* We need the cast here to ensure that we get the same result both with
1277    and without prototypes.  */
1278 #define GEN_INT(N)  gen_rtx_CONST_INT (VOIDmode, (HOST_WIDE_INT) (N))
1279
1280 /* Virtual registers are used during RTL generation to refer to locations into
1281    the stack frame when the actual location isn't known until RTL generation
1282    is complete.  The routine instantiate_virtual_regs replaces these with
1283    the proper value, which is normally {frame,arg,stack}_pointer_rtx plus
1284    a constant.  */
1285
1286 #define FIRST_VIRTUAL_REGISTER  (FIRST_PSEUDO_REGISTER)
1287
1288 /* This points to the first word of the incoming arguments passed on the stack,
1289    either by the caller or by the callee when pretending it was passed by the
1290    caller.  */
1291
1292 #define virtual_incoming_args_rtx       (global_rtl[GR_VIRTUAL_INCOMING_ARGS])
1293
1294 #define VIRTUAL_INCOMING_ARGS_REGNUM    (FIRST_VIRTUAL_REGISTER)
1295
1296 /* If FRAME_GROWS_DOWNWARD, this points to immediately above the first
1297    variable on the stack.  Otherwise, it points to the first variable on
1298    the stack.  */
1299
1300 #define virtual_stack_vars_rtx          (global_rtl[GR_VIRTUAL_STACK_ARGS])
1301
1302 #define VIRTUAL_STACK_VARS_REGNUM       ((FIRST_VIRTUAL_REGISTER) + 1)
1303
1304 /* This points to the location of dynamically-allocated memory on the stack
1305    immediately after the stack pointer has been adjusted by the amount
1306    desired.  */
1307
1308 #define virtual_stack_dynamic_rtx       (global_rtl[GR_VIRTUAL_STACK_DYNAMIC])
1309
1310 #define VIRTUAL_STACK_DYNAMIC_REGNUM    ((FIRST_VIRTUAL_REGISTER) + 2)
1311
1312 /* This points to the location in the stack at which outgoing arguments should
1313    be written when the stack is pre-pushed (arguments pushed using push
1314    insns always use sp).  */
1315
1316 #define virtual_outgoing_args_rtx       (global_rtl[GR_VIRTUAL_OUTGOING_ARGS])
1317
1318 #define VIRTUAL_OUTGOING_ARGS_REGNUM    ((FIRST_VIRTUAL_REGISTER) + 3)
1319
1320 /* This points to the Canonical Frame Address of the function.  This
1321    should corrospond to the CFA produced by INCOMING_FRAME_SP_OFFSET,
1322    but is calculated relative to the arg pointer for simplicity; the
1323    frame pointer nor stack pointer are necessarily fixed relative to
1324    the CFA until after reload.  */
1325
1326 #define virtual_cfa_rtx                 (global_rtl[GR_VIRTUAL_CFA])
1327
1328 #define VIRTUAL_CFA_REGNUM              ((FIRST_VIRTUAL_REGISTER) + 4)
1329
1330 #define LAST_VIRTUAL_REGISTER           ((FIRST_VIRTUAL_REGISTER) + 4)
1331
1332 extern rtx find_next_ref                PROTO((rtx, rtx));
1333 extern rtx *find_single_use             PROTO((rtx, rtx, rtx *));
1334
1335 extern rtx output_constant_def          PROTO((union tree_node *));
1336 extern rtx immed_real_const             PROTO((union tree_node *));
1337 extern union tree_node *make_tree       PROTO((union tree_node *, rtx));
1338
1339 /* Define a default value for STORE_FLAG_VALUE.  */
1340
1341 #ifndef STORE_FLAG_VALUE
1342 #define STORE_FLAG_VALUE 1
1343 #endif
1344
1345 /* Nonzero after the second flow pass has completed.
1346    Set to 1 or 0 by toplev.c  */
1347 extern int flow2_completed;
1348
1349 /* Nonzero after end of reload pass.
1350    Set to 1 or 0 by reload1.c.  */
1351
1352 extern int reload_completed;
1353
1354 /* Set to 1 while reload_as_needed is operating.
1355    Required by some machines to handle any generated moves differently.  */
1356
1357 extern int reload_in_progress;
1358
1359 /* If this is nonzero, we do not bother generating VOLATILE
1360    around volatile memory references, and we are willing to
1361    output indirect addresses.  If cse is to follow, we reject
1362    indirect addresses so a useful potential cse is generated;
1363    if it is used only once, instruction combination will produce
1364    the same indirect address eventually.  */
1365 extern int cse_not_expected;
1366
1367 /* Set to nonzero before life analysis to indicate that it is unsafe to
1368    generate any new pseudo registers.  */
1369 extern int no_new_pseudos;
1370
1371 /* Translates rtx code to tree code, for those codes needed by
1372    REAL_ARITHMETIC.  The function returns an int because the caller may not
1373    know what `enum tree_code' means.  */
1374
1375 extern int rtx_to_tree_code     PROTO((enum rtx_code));
1376
1377 /* In tree.c */
1378 extern void obfree                      PROTO ((char *));
1379 struct obstack;
1380 extern void gcc_obstack_init            PROTO ((struct obstack *));
1381 extern void pop_obstacks                PROTO ((void));
1382 extern void push_obstacks               PROTO ((struct obstack *,
1383                                                 struct obstack *));
1384 #ifdef BUFSIZ
1385 extern int read_skip_spaces             PROTO ((FILE *));
1386 #endif
1387
1388 /* In cse.c */
1389 struct cse_basic_block_data;
1390 extern int rtx_cost                     PROTO ((rtx, enum rtx_code));
1391 extern void delete_trivially_dead_insns PROTO ((rtx, int));
1392 #ifdef BUFSIZ
1393 extern int cse_main                     PROTO ((rtx, int, int, FILE *));
1394 #endif
1395 extern void cse_end_of_basic_block      PROTO ((rtx,
1396                                                 struct cse_basic_block_data *,
1397                                                 int, int, int));
1398
1399 /* In jump.c */
1400 extern int comparison_dominates_p       PROTO ((enum rtx_code, enum rtx_code));
1401 extern int condjump_p                   PROTO ((rtx));
1402 extern rtx condjump_label               PROTO ((rtx));
1403 extern int simplejump_p                 PROTO ((rtx));
1404 extern int returnjump_p                 PROTO ((rtx));
1405 extern int onlyjump_p                   PROTO ((rtx));
1406 extern int sets_cc0_p                   PROTO ((rtx));
1407 extern int invert_jump                  PROTO ((rtx, rtx));
1408 extern int rtx_renumbered_equal_p       PROTO ((rtx, rtx));
1409 extern int true_regnum                  PROTO ((rtx));
1410 extern int redirect_jump                PROTO ((rtx, rtx));
1411 extern void jump_optimize               PROTO ((rtx, int, int, int));
1412 extern void rebuild_jump_labels         PROTO ((rtx));
1413 extern void thread_jumps                PROTO ((rtx, int, int));
1414 extern int redirect_exp                 PROTO ((rtx *, rtx, rtx, rtx));
1415 extern int rtx_equal_for_thread_p       PROTO ((rtx, rtx, rtx));
1416 extern int invert_exp                   PROTO ((rtx, rtx));
1417 extern int can_reverse_comparison_p     PROTO ((rtx, rtx));
1418 extern void delete_for_peephole         PROTO ((rtx, rtx));
1419 extern int condjump_in_parallel_p       PROTO ((rtx));
1420 extern void never_reached_warning       PROTO ((rtx));
1421
1422 /* Flags for jump_optimize() */
1423 #define JUMP_CROSS_JUMP         1
1424 #define JUMP_NOOP_MOVES         1
1425 #define JUMP_AFTER_REGSCAN      1
1426
1427 /* In emit-rtl.c. */
1428 extern int max_reg_num                          PROTO ((void));
1429 extern int max_label_num                        PROTO ((void));
1430 extern int get_first_label_num                  PROTO ((void));
1431 extern void delete_insns_since                  PROTO ((rtx));
1432 extern void mark_reg_pointer                    PROTO ((rtx, int));
1433 extern void mark_user_reg                       PROTO ((rtx));
1434 extern void reset_used_flags                    PROTO ((rtx));
1435 extern void reorder_insns                       PROTO ((rtx, rtx, rtx));
1436 extern int get_max_uid                          PROTO ((void));
1437 extern int in_sequence_p                        PROTO ((void));
1438 extern void force_next_line_note                PROTO ((void));
1439 extern void clear_emit_caches                   PROTO ((void));
1440 extern void init_emit                           PROTO ((void));
1441 extern void init_emit_once                      PROTO ((int));
1442 extern void push_topmost_sequence               PROTO ((void));
1443 extern void pop_topmost_sequence                PROTO ((void));
1444 extern int subreg_realpart_p                    PROTO ((rtx));
1445 extern void reverse_comparison                  PROTO ((rtx));
1446 extern void set_new_first_and_last_insn         PROTO ((rtx, rtx));
1447 extern void set_new_first_and_last_label_num    PROTO ((int, int));
1448 extern void set_new_last_label_num              PROTO ((int));
1449 extern void unshare_all_rtl                     PROTO ((rtx));
1450 extern void set_last_insn                       PROTO ((rtx));
1451 extern void link_cc0_insns                      PROTO ((rtx));
1452 extern void add_insn                            PROTO ((rtx));
1453 extern void add_insn_before                     PROTO ((rtx, rtx));
1454 extern void add_insn_after                      PROTO ((rtx, rtx));
1455 extern void remove_insn                         PROTO ((rtx));
1456 extern void reorder_insns_with_line_notes       PROTO ((rtx, rtx, rtx));
1457 extern void emit_insn_after_with_line_notes     PROTO ((rtx, rtx, rtx));
1458 extern enum rtx_code classify_insn              PROTO ((rtx));
1459 extern rtx emit                                 PROTO ((rtx));
1460 /* Query and clear/ restore no_line_numbers.  This is used by the
1461    switch / case handling in stmt.c to give proper line numbers in
1462    warnings about unreachable code.  */
1463 int force_line_numbers PROTO((void));
1464 void restore_line_number_status PROTO((int old_value));
1465
1466 /* In insn-emit.c */
1467 extern void add_clobbers                PROTO ((rtx, int));
1468
1469 /* In combine.c */
1470 extern void combine_instructions        PROTO ((rtx, int));
1471 extern int extended_count               PROTO ((rtx, enum machine_mode, int));
1472 extern rtx remove_death                 PROTO ((int, rtx));
1473 #ifdef BUFSIZ
1474 extern void dump_combine_stats          PROTO ((FILE *));
1475 extern void dump_combine_total_stats    PROTO ((FILE *));
1476 #endif
1477
1478 /* In sched.c. */
1479 #ifdef BUFSIZ
1480 extern void schedule_insns              PROTO ((FILE *));
1481 #endif
1482 extern void fix_sched_param             PROTO ((const char *, const char *));
1483
1484 /* In print-rtl.c */
1485 extern void debug_rtx                   PROTO ((rtx));
1486 extern void debug_rtx_list              PROTO ((rtx, int));
1487 extern rtx debug_rtx_find               PROTO ((rtx, int));
1488 #ifdef BUFSIZ
1489 extern void print_rtl                   PROTO ((FILE *, rtx));
1490 extern int print_rtl_single             PROTO ((FILE *, rtx));
1491 extern void print_inline_rtx            PROTO ((FILE *, rtx, int));
1492 #endif
1493
1494 /* In loop.c */
1495 extern void init_loop                   PROTO ((void));
1496 extern rtx libcall_other_reg            PROTO ((rtx, rtx));
1497 #ifdef BUFSIZ
1498 extern void loop_optimize               PROTO ((rtx, FILE *, int, int));
1499 #endif
1500 extern void record_excess_regs          PROTO ((rtx, rtx, rtx *));
1501
1502 /* In function.c */
1503 extern void reposition_prologue_and_epilogue_notes      PROTO ((rtx));
1504 extern void thread_prologue_and_epilogue_insns          PROTO ((rtx));
1505 extern int prologue_epilogue_contains                   PROTO ((rtx));
1506 extern void use_variable                                PROTO ((rtx));
1507 extern HOST_WIDE_INT get_frame_size                     PROTO ((void));
1508 extern void preserve_rtl_expr_result                    PROTO ((rtx));
1509 extern void mark_temp_addr_taken                        PROTO ((rtx));
1510 extern void update_temp_slot_address                    PROTO ((rtx, rtx));
1511 extern void use_variable_after                          PROTO ((rtx, rtx));
1512 extern void purge_addressof                             PROTO ((rtx));
1513
1514 /* In reload.c */
1515 extern int operands_match_p             PROTO ((rtx, rtx));
1516 extern int safe_from_earlyclobber       PROTO ((rtx, rtx));
1517
1518 /* In stmt.c */
1519 extern void set_file_and_line_for_stmt  PROTO ((char *, int));
1520 extern void expand_null_return          PROTO((void));
1521 extern void emit_jump                   PROTO ((rtx));
1522 extern int preserve_subexpressions_p    PROTO ((void));
1523
1524 /* In expr.c */
1525 extern void init_expr_once              PROTO ((void));
1526 extern void move_by_pieces              PROTO ((rtx, rtx, int, int));
1527
1528
1529 /* In stupid.c */
1530 #ifdef BUFSIZ
1531 extern void stupid_life_analysis        PROTO ((rtx, int, FILE *));
1532 #endif
1533
1534 /* In flow.c */
1535 extern void allocate_bb_life_data       PROTO ((void));
1536 extern void allocate_reg_life_data      PROTO ((void));
1537 extern void recompute_reg_usage         PROTO ((rtx, int));
1538 #ifdef BUFSIZ
1539 extern void print_rtl_with_bb           PROTO ((FILE *, rtx));
1540 extern void dump_flow_info              PROTO ((FILE *));
1541 #endif
1542 extern void free_bb_mem                 PROTO ((void));
1543 extern void replace_insns               PROTO ((rtx, rtx, rtx, rtx));
1544
1545 /* In expmed.c */
1546 extern void init_expmed                 PROTO ((void));
1547 extern void expand_inc                  PROTO ((rtx, rtx));
1548 extern void expand_dec                  PROTO ((rtx, rtx));
1549 extern rtx expand_mult_highpart         PROTO ((enum machine_mode, rtx,
1550                                                 unsigned HOST_WIDE_INT, rtx,
1551                                                 int, int));
1552
1553 /* In gcse.c */
1554 #ifdef BUFSIZ
1555 extern int gcse_main                    PROTO ((rtx, FILE *));
1556 #endif
1557
1558 /* In global.c */
1559 extern void mark_elimination            PROTO ((int, int));
1560 #ifdef BUFSIZ
1561 extern int global_alloc                 PROTO ((FILE *));
1562 extern void dump_global_regs            PROTO ((FILE *));
1563 #endif
1564 #ifdef HARD_CONST
1565 extern void retry_global_alloc          PROTO ((int, HARD_REG_SET));
1566 #endif
1567
1568 /* In regclass.c */
1569 extern int reg_classes_intersect_p      PROTO ((enum reg_class, enum reg_class));
1570 extern int reg_class_subset_p           PROTO ((enum reg_class, enum reg_class));
1571 extern void globalize_reg               PROTO ((int));
1572 extern void init_regs                   PROTO ((void));
1573 extern void init_reg_sets               PROTO ((void));
1574 extern void regset_release_memory       PROTO ((void));
1575 extern void regclass_init               PROTO ((void));
1576 extern void regclass                    PROTO ((rtx, int));
1577 extern void reg_scan                    PROTO ((rtx, int, int));
1578 extern void reg_scan_update             PROTO ((rtx, rtx, int));
1579 extern void fix_register                PROTO ((char *, int, int));
1580
1581 /* In regmove.c */
1582 #ifdef BUFSIZ
1583 extern void regmove_optimize            PROTO ((rtx, int, FILE *));
1584 #endif
1585
1586 /* In reorg.c */
1587 #ifdef BUFSIZ
1588 extern void dbr_schedule                PROTO ((rtx, FILE *));
1589 #endif
1590
1591 /* In optabs.c */
1592 extern void init_optabs                 PROTO ((void));
1593
1594 /* In local-alloc.c */
1595 #ifdef BUFSIZ
1596 extern void dump_local_alloc            PROTO ((FILE *));
1597 #endif
1598 extern int local_alloc                  PROTO ((void));
1599 extern int function_invariant_p         PROTO ((rtx));
1600
1601 /* In reload1.c */
1602 extern void reload_cse_regs             PROTO ((rtx));
1603 extern void init_reload                 PROTO ((void));
1604 extern void mark_home_live              PROTO ((int));
1605 #ifdef BUFSIZ
1606 extern int reload                       PROTO ((rtx, int, FILE *));
1607 #endif
1608
1609 /* In caller-save.c */
1610 extern void init_caller_save            PROTO ((void));
1611
1612 /* In profile.c */
1613 extern void init_branch_prob            PROTO ((const char *));
1614 #ifdef BUFSIZ
1615 extern void branch_prob                 PROTO ((rtx, FILE *));
1616 extern void end_branch_prob             PROTO ((FILE *));
1617 #endif
1618 extern void output_func_start_profiler  PROTO ((void));
1619
1620 /* In reg-stack.c */
1621 #ifdef BUFSIZ
1622 extern void reg_to_stack                PROTO ((rtx, FILE *));
1623 #endif
1624
1625 /* In fold-const.c */
1626 extern int add_double           PROTO ((HOST_WIDE_INT, HOST_WIDE_INT,
1627                                         HOST_WIDE_INT, HOST_WIDE_INT,
1628                                         HOST_WIDE_INT *, HOST_WIDE_INT *));
1629 extern int neg_double           PROTO ((HOST_WIDE_INT, HOST_WIDE_INT,
1630                                         HOST_WIDE_INT *, HOST_WIDE_INT *));
1631 extern int mul_double           PROTO ((HOST_WIDE_INT, HOST_WIDE_INT,
1632                                         HOST_WIDE_INT, HOST_WIDE_INT,
1633                                         HOST_WIDE_INT *, HOST_WIDE_INT *));
1634 extern void lshift_double       PROTO ((HOST_WIDE_INT, HOST_WIDE_INT,
1635                                         HOST_WIDE_INT, int, HOST_WIDE_INT *,
1636                                         HOST_WIDE_INT *, int));
1637 extern void rshift_double       PROTO ((HOST_WIDE_INT, HOST_WIDE_INT,
1638                                         HOST_WIDE_INT, int,
1639                                         HOST_WIDE_INT *, HOST_WIDE_INT *, int));
1640 extern void lrotate_double      PROTO ((HOST_WIDE_INT, HOST_WIDE_INT,
1641                                         HOST_WIDE_INT, int, HOST_WIDE_INT *,
1642                                         HOST_WIDE_INT *));
1643 extern void rrotate_double      PROTO ((HOST_WIDE_INT, HOST_WIDE_INT,
1644                                         HOST_WIDE_INT, int, HOST_WIDE_INT *,
1645                                         HOST_WIDE_INT *));
1646
1647 /* In calls.c */
1648 /* Emit library call.  */
1649 extern void emit_library_call           PVPROTO ((rtx, int, enum machine_mode,
1650                                                   int, ...));
1651 extern rtx emit_library_call_value      PVPROTO((rtx, rtx, int,
1652                                                  enum machine_mode,
1653                                                  int, ...));
1654
1655 /* In unroll.c */
1656 extern int set_dominates_use            PROTO ((int, int, int, rtx, rtx));
1657
1658 /* In varasm.c */
1659 extern void bss_section                 PROTO ((void));
1660 extern int in_data_section              PROTO ((void));
1661 extern int supports_one_only            PROTO ((void));
1662 extern void init_varasm_once            PROTO ((void));
1663
1664 /* In rtl.c */
1665 extern void init_rtl                    PROTO ((void));
1666 extern void rtx_free                    PROTO ((rtx));
1667
1668 /* Redefine abort to report an internal error w/o coredump, and
1669    reporting the location of the error in the source file.  This logic
1670    is duplicated in rtl.h and tree.h because every file that needs the
1671    special abort includes one or both.  toplev.h gets too few files,
1672    system.h gets too many.  */
1673
1674 extern void fancy_abort PROTO((const char *, int, const char *))
1675     ATTRIBUTE_NORETURN;
1676 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7)
1677 #define abort() fancy_abort (__FILE__, __LINE__, 0)
1678 #else
1679 #define abort() fancy_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
1680 #endif
1681
1682 /* In alias.c */
1683 extern int true_dependence              PROTO ((rtx, enum machine_mode, rtx,
1684                                                 int (*)(rtx)));
1685 extern int read_dependence              PROTO ((rtx, rtx));
1686 extern int anti_dependence              PROTO ((rtx, rtx));
1687 extern int output_dependence            PROTO ((rtx, rtx));
1688 extern void mark_constant_function      PROTO ((void));
1689 extern void init_alias_once             PROTO ((void));
1690 extern void init_alias_analysis         PROTO ((void));
1691 extern void end_alias_analysis          PROTO ((void));
1692
1693 extern void record_base_value           PROTO ((int, rtx, int));
1694 extern void record_alias_subset         PROTO ((int, int));
1695 extern rtx addr_side_effect_eval        PROTO ((rtx, int, int));
1696
1697 #ifdef STACK_REGS
1698 extern int stack_regs_mentioned         PROTO((rtx insn));
1699 #endif
1700
1701
1702 extern void delete_null_pointer_checks  PROTO ((rtx));
1703 #endif /* _RTL_H */