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