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