gcc/rtl.h

   1 /* Register Transfer Language (RTL) definitions for GNU C-Compiler
   2    Copyright (C) 1987, 91-99, 2000 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_RTL_CHECKING && (GCC_VERSION >= 2007)
 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 PARAMS ((rtx, int,
 278                                            const char *, int, const char *))
 279     ATTRIBUTE_NORETURN;
 280 extern void rtl_check_failed_type1 PARAMS ((rtx, int, int,
 281                                           const char *, int, const char *))
 282     ATTRIBUTE_NORETURN;
 283 extern void rtl_check_failed_type2 PARAMS ((rtx, int, int, int,
 284                                           const char *, int, const char *))
 285     ATTRIBUTE_NORETURN;
 286 extern void rtl_check_failed_code1 PARAMS ((rtx, enum rtx_code,
 287                                           const char *, int, const char *))
 288     ATTRIBUTE_NORETURN;
 289 extern void rtl_check_failed_code2 PARAMS ((rtx, enum rtx_code, enum rtx_code,
 290                                           const char *, int, const char *))
 291     ATTRIBUTE_NORETURN;
 292 extern void rtvec_check_failed_bounds PARAMS ((rtvec, int,
 293                                              const char *, int, const char *))
 294     ATTRIBUTE_NORETURN;
 295
 296 #else   /* not ENABLE_RTL_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 /* Associate a name with a CODE_LABEL.  */
 601 #define LABEL_ALTERNATE_NAME(RTX) XCSTR(RTX, 7, CODE_LABEL)
 602
 603 /* The original regno this ADDRESSOF was built for.  */
 604 #define ADDRESSOF_REGNO(RTX) XCINT(RTX, 1, ADDRESSOF)
 605
 606 /* The variable in the register we took the address of.  */
 607 #define ADDRESSOF_DECL(RTX) XCTREE(RTX, 2, ADDRESSOF)
 608
 609 /* In jump.c, each JUMP_INSN can point to a label that it can jump to,
 610    so that if the JUMP_INSN is deleted, the label's LABEL_NUSES can
 611    be decremented and possibly the label can be deleted.  */
 612 #define JUMP_LABEL(INSN)   XCEXP(INSN, 7, JUMP_INSN)
 613
 614 /* Once basic blocks are found in flow.c,
 615    each CODE_LABEL starts a chain that goes through
 616    all the LABEL_REFs that jump to that label.
 617    The chain eventually winds up at the CODE_LABEL; it is circular.  */
 618 #define LABEL_REFS(LABEL) XCEXP(LABEL, 6, CODE_LABEL)
 619 \f
 620 /* This is the field in the LABEL_REF through which the circular chain
 621    of references to a particular label is linked.
 622    This chain is set up in flow.c.  */
 623
 624 #define LABEL_NEXTREF(REF) XCEXP(REF, 1, LABEL_REF)
 625
 626 /* Once basic blocks are found in flow.c,
 627    Each LABEL_REF points to its containing instruction with this field.  */
 628
 629 #define CONTAINING_INSN(RTX) XCEXP(RTX, 2, LABEL_REF)
 630
 631 /* For a REG rtx, REGNO extracts the register number.  */
 632
 633 #define REGNO(RTX) XCINT(RTX, 0, REG)
 634
 635 /* For a REG rtx, REG_FUNCTION_VALUE_P is nonzero if the reg
 636    is the current function's return value.  */
 637
 638 #define REG_FUNCTION_VALUE_P(RTX) ((RTX)->integrated)
 639
 640 /* 1 in a REG rtx if it corresponds to a variable declared by the user.  */
 641 #define REG_USERVAR_P(RTX) ((RTX)->volatil)
 642
 643 /* For a CONST_INT rtx, INTVAL extracts the integer.  */
 644
 645 #define INTVAL(RTX) XCWINT(RTX, 0, CONST_INT)
 646
 647 /* For a SUBREG rtx, SUBREG_REG extracts the value we want a subreg of.
 648    SUBREG_WORD extracts the word-number.  */
 649
 650 #define SUBREG_REG(RTX) XCEXP(RTX, 0, SUBREG)
 651 #define SUBREG_WORD(RTX) XCINT(RTX, 1, SUBREG)
 652
 653 /* 1 if the REG contained in SUBREG_REG is already known to be
 654    sign- or zero-extended from the mode of the SUBREG to the mode of
 655    the reg.  SUBREG_PROMOTED_UNSIGNED_P gives the signedness of the
 656    extension.
 657
 658    When used as a LHS, is means that this extension must be done
 659    when assigning to SUBREG_REG.  */
 660
 661 #define SUBREG_PROMOTED_VAR_P(RTX) ((RTX)->in_struct)
 662 #define SUBREG_PROMOTED_UNSIGNED_P(RTX) ((RTX)->unchanging)
 663
 664 /* Access various components of an ASM_OPERANDS rtx.  */
 665
 666 #define ASM_OPERANDS_TEMPLATE(RTX) XCSTR ((RTX), 0, ASM_OPERANDS)
 667 #define ASM_OPERANDS_OUTPUT_CONSTRAINT(RTX) XCSTR ((RTX), 1, ASM_OPERANDS)
 668 #define ASM_OPERANDS_OUTPUT_IDX(RTX) XCINT ((RTX), 2, ASM_OPERANDS)
 669 #define ASM_OPERANDS_INPUT_VEC(RTX) XCVEC ((RTX), 3, ASM_OPERANDS)
 670 #define ASM_OPERANDS_INPUT_CONSTRAINT_VEC(RTX) XCVEC ((RTX), 4, ASM_OPERANDS)
 671 #define ASM_OPERANDS_INPUT(RTX, N) XCVECEXP ((RTX), 3, (N), ASM_OPERANDS)
 672 #define ASM_OPERANDS_INPUT_LENGTH(RTX) XCVECLEN ((RTX), 3, ASM_OPERANDS)
 673 #define ASM_OPERANDS_INPUT_CONSTRAINT(RTX, N) XSTR (XCVECEXP ((RTX), 4, (N), ASM_OPERANDS), 0)
 674 #define ASM_OPERANDS_INPUT_MODE(RTX, N) GET_MODE (XCVECEXP ((RTX), 4, (N), ASM_OPERANDS))
 675 #define ASM_OPERANDS_SOURCE_FILE(RTX) XCSTR ((RTX), 5, ASM_OPERANDS)
 676 #define ASM_OPERANDS_SOURCE_LINE(RTX) XCINT ((RTX), 6, ASM_OPERANDS)
 677
 678 /* For a MEM rtx, 1 if it's a volatile reference.
 679    Also in an ASM_OPERANDS rtx.  */
 680 #define MEM_VOLATILE_P(RTX) ((RTX)->volatil)
 681
 682 /* For a MEM rtx, 1 if it refers to a field of an aggregate.  If zero,
 683    RTX may or may not refer to a field of an aggregate.  */
 684 #define MEM_IN_STRUCT_P(RTX) ((RTX)->in_struct)
 685
 686 /* For a MEM rtx, 1 if it refers to a scalar.  If zero, RTX may or may
 687    not refer to a scalar.*/
 688 #define MEM_SCALAR_P(RTX) ((RTX)->frame_related)
 689
 690 /* Copy the MEM_VOLATILE_P, MEM_IN_STRUCT_P, and MEM_SCALAR_P
 691    attributes from RHS to LHS.  */
 692 #define MEM_COPY_ATTRIBUTES(LHS, RHS)                   \
 693   (MEM_VOLATILE_P (LHS) = MEM_VOLATILE_P (RHS),         \
 694    MEM_IN_STRUCT_P (LHS) = MEM_IN_STRUCT_P (RHS),       \
 695    MEM_SCALAR_P (LHS) = MEM_SCALAR_P (RHS))
 696
 697 /* If VAL is non-zero, set MEM_IN_STRUCT_P and clear MEM_SCALAR_P in
 698    RTX.  Otherwise, vice versa.  Use this macro only when you are
 699    *sure* that you know that the MEM is in a structure, or is a
 700    scalar.  VAL is evaluated only once.  */
 701 #define MEM_SET_IN_STRUCT_P(RTX, VAL)                           \
 702   ((VAL) ? (MEM_IN_STRUCT_P (RTX) = 1, MEM_SCALAR_P (RTX) = 0)  \
 703    : (MEM_IN_STRUCT_P (RTX) = 0, MEM_SCALAR_P (RTX) = 1))
 704
 705 /* For a MEM rtx, the alias set.  If 0, this MEM is not in any alias
 706    set, and may alias anything.  Otherwise, the MEM can only alias
 707    MEMs in the same alias set.  This value is set in a
 708    language-dependent manner in the front-end, and should not be
 709    altered in the back-end.  These set numbers are tested for zero,
 710    and compared for equality; they have no other significance.  In
 711    some front-ends, these numbers may correspond in some way to types,
 712    or other language-level entities, but they need not, and the
 713    back-end makes no such assumptions.  */
 714 #define MEM_ALIAS_SET(RTX) XCINT(RTX, 1, MEM)
 715
 716 /* For a LABEL_REF, 1 means that this reference is to a label outside the
 717    loop containing the reference.  */
 718 #define LABEL_OUTSIDE_LOOP_P(RTX) ((RTX)->in_struct)
 719
 720 /* For a LABEL_REF, 1 means it is for a nonlocal label.  */
 721 /* Likewise in an EXPR_LIST for a REG_LABEL note.  */
 722 #define LABEL_REF_NONLOCAL_P(RTX) ((RTX)->volatil)
 723
 724 /* For a CODE_LABEL, 1 means always consider this label to be needed.  */
 725 #define LABEL_PRESERVE_P(RTX) ((RTX)->in_struct)
 726
 727 /* For a REG, 1 means the register is used only in an exit test of a loop.  */
 728 #define REG_LOOP_TEST_P(RTX) ((RTX)->in_struct)
 729
 730 /* During sched, for an insn, 1 means that the insn must be scheduled together
 731    with the preceding insn.  */
 732 #define SCHED_GROUP_P(INSN) ((INSN)->in_struct)
 733
 734 /* During sched, for the LOG_LINKS of an insn, these cache the adjusted
 735    cost of the dependence link.  The cost of executing an instruction
 736    may vary based on how the results are used.  LINK_COST_ZERO is 1 when
 737    the cost through the link varies and is unchanged (i.e., the link has
 738    zero additional cost).  LINK_COST_FREE is 1 when the cost through the
 739    link is zero (i.e., the link makes the cost free).  In other cases,
 740    the adjustment to the cost is recomputed each time it is needed.  */
 741 #define LINK_COST_ZERO(X) ((X)->jump)
 742 #define LINK_COST_FREE(X) ((X)->call)
 743
 744 /* For a SET rtx, SET_DEST is the place that is set
 745    and SET_SRC is the value it is set to.  */
 746 #define SET_DEST(RTX) XC2EXP(RTX, 0, SET, CLOBBER)
 747 #define SET_SRC(RTX) XCEXP(RTX, 1, SET)
 748
 749 /* For a TRAP_IF rtx, TRAP_CONDITION is an expression.  */
 750 #define TRAP_CONDITION(RTX) XCEXP(RTX, 0, TRAP_IF)
 751 #define TRAP_CODE(RTX) XCEXP(RTX, 1, TRAP_IF)
 752
 753 /* 1 in a SYMBOL_REF if it addresses this function's constants pool.  */
 754 #define CONSTANT_POOL_ADDRESS_P(RTX) ((RTX)->unchanging)
 755
 756 /* Flag in a SYMBOL_REF for machine-specific purposes.  */
 757 #define SYMBOL_REF_FLAG(RTX) ((RTX)->volatil)
 758
 759 /* 1 in a SYMBOL_REF if it represents a symbol which might have to change
 760    if its inlined or unrolled. */
 761 #define SYMBOL_REF_NEED_ADJUST(RTX)  ((RTX)->in_struct)
 762
 763 /* 1 means a SYMBOL_REF has been the library function in emit_library_call.  */
 764 #define SYMBOL_REF_USED(RTX) ((RTX)->used)
 765
 766 /* Define a macro to look for REG_INC notes,
 767    but save time on machines where they never exist.  */
 768
 769 /* Don't continue this line--convex cc version 4.1 would lose.  */
 770 #if (defined (HAVE_PRE_INCREMENT) || defined (HAVE_PRE_DECREMENT) || defined (HAVE_POST_INCREMENT) || defined (HAVE_POST_DECREMENT))
 771 #define FIND_REG_INC_NOTE(insn, reg) (find_reg_note ((insn), REG_INC, (reg)))
 772 #else
 773 #define FIND_REG_INC_NOTE(insn, reg) 0
 774 #endif
 775
 776 /* Indicate whether the machine has any sort of auto increment addressing.
 777    If not, we can avoid checking for REG_INC notes.  */
 778
 779 /* Don't continue this line--convex cc version 4.1 would lose.  */
 780 #if (defined (HAVE_PRE_INCREMENT) || defined (HAVE_PRE_DECREMENT) || defined (HAVE_POST_INCREMENT) || defined (HAVE_POST_DECREMENT))
 781 #define AUTO_INC_DEC
 782 #endif
 783
 784 #ifndef HAVE_PRE_INCREMENT
 785 #define HAVE_PRE_INCREMENT 0
 786 #endif
 787
 788 #ifndef HAVE_PRE_DECREMENT
 789 #define HAVE_PRE_DECREMENT 0
 790 #endif
 791
 792 #ifndef HAVE_POST_INCREMENT
 793 #define HAVE_POST_INCREMENT 0
 794 #endif
 795
 796 #ifndef HAVE_POST_DECREMENT
 797 #define HAVE_POST_DECREMENT 0
 798 #endif
 799
 800
 801 /* Some architectures do not have complete pre/post increment/decrement
 802    instruction sets, or only move some modes efficiently.  These macros
 803    allow us to tune autoincrement generation.  */
 804
 805 #ifndef USE_LOAD_POST_INCREMENT
 806 #define USE_LOAD_POST_INCREMENT(MODE)   HAVE_POST_INCREMENT
 807 #endif
 808
 809 #ifndef USE_LOAD_POST_DECREMENT
 810 #define USE_LOAD_POST_DECREMENT(MODE)   HAVE_POST_DECREMENT
 811 #endif
 812
 813 #ifndef USE_LOAD_PRE_INCREMENT
 814 #define USE_LOAD_PRE_INCREMENT(MODE)    HAVE_PRE_INCREMENT
 815 #endif
 816
 817 #ifndef USE_LOAD_PRE_DECREMENT
 818 #define USE_LOAD_PRE_DECREMENT(MODE)    HAVE_PRE_DECREMENT
 819 #endif
 820
 821 #ifndef USE_STORE_POST_INCREMENT
 822 #define USE_STORE_POST_INCREMENT(MODE)  HAVE_POST_INCREMENT
 823 #endif
 824
 825 #ifndef USE_STORE_POST_DECREMENT
 826 #define USE_STORE_POST_DECREMENT(MODE)  HAVE_POST_DECREMENT
 827 #endif
 828
 829 #ifndef USE_STORE_PRE_INCREMENT
 830 #define USE_STORE_PRE_INCREMENT(MODE)   HAVE_PRE_INCREMENT
 831 #endif
 832
 833 #ifndef USE_STORE_PRE_DECREMENT
 834 #define USE_STORE_PRE_DECREMENT(MODE)   HAVE_PRE_DECREMENT
 835 #endif
 836
 837
 838 /* Accessors for RANGE_INFO.  */
 839 /* For RANGE_{START,END} notes return the RANGE_START note.  */
 840 #define RANGE_INFO_NOTE_START(INSN) XCEXP (INSN, 0, RANGE_INFO)
 841
 842 /* For RANGE_{START,END} notes return the RANGE_START note.  */
 843 #define RANGE_INFO_NOTE_END(INSN) XCEXP (INSN, 1, RANGE_INFO)
 844
 845 /* For RANGE_{START,END} notes, return the vector containing the registers used
 846    in the range.  */
 847 #define RANGE_INFO_REGS(INSN) XCVEC (INSN, 2, RANGE_INFO)
 848 #define RANGE_INFO_REGS_REG(INSN, N) XCVECEXP (INSN, 2, N, RANGE_INFO)
 849 #define RANGE_INFO_NUM_REGS(INSN) XCVECLEN (INSN, 2, RANGE_INFO)
 850
 851 /* For RANGE_{START,END} notes, the number of calls within the range.  */
 852 #define RANGE_INFO_NCALLS(INSN) XCINT (INSN, 3, RANGE_INFO)
 853
 854 /* For RANGE_{START,END} notes, the number of insns within the range.  */
 855 #define RANGE_INFO_NINSNS(INSN) XCINT (INSN, 4, RANGE_INFO)
 856
 857 /* For RANGE_{START,END} notes, a unique # to identify this range.  */
 858 #define RANGE_INFO_UNIQUE(INSN) XCINT (INSN, 5, RANGE_INFO)
 859
 860 /* For RANGE_{START,END} notes, the basic block # the range starts with. */
 861 #define RANGE_INFO_BB_START(INSN) XCINT (INSN, 6, RANGE_INFO)
 862
 863 /* For RANGE_{START,END} notes, the basic block # the range ends with. */
 864 #define RANGE_INFO_BB_END(INSN) XCINT (INSN, 7, RANGE_INFO)
 865
 866 /* For RANGE_{START,END} notes, the loop depth the range is in.  */
 867 #define RANGE_INFO_LOOP_DEPTH(INSN) XCINT (INSN, 8, RANGE_INFO)
 868
 869 /* For RANGE_{START,END} notes, the bitmap of live registers at the start
 870    of the range.  */
 871 #define RANGE_INFO_LIVE_START(INSN) XCBITMAP (INSN, 9, RANGE_INFO)
 872
 873 /* For RANGE_{START,END} notes, the bitmap of live registers at the end
 874    of the range.  */
 875 #define RANGE_INFO_LIVE_END(INSN) XCBITMAP (INSN, 10, RANGE_INFO)
 876
 877 /* For RANGE_START notes, the marker # of the start of the range.  */
 878 #define RANGE_INFO_MARKER_START(INSN) XCINT (INSN, 11, RANGE_INFO)
 879
 880 /* For RANGE_START notes, the marker # of the end of the range.  */
 881 #define RANGE_INFO_MARKER_END(INSN) XCINT (INSN, 12, RANGE_INFO)
 882
 883 /* Original pseudo register # for a live range note.  */
 884 #define RANGE_REG_PSEUDO(INSN,N) XCINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 0, REG)
 885
 886 /* Pseudo register # original register is copied into or -1.  */
 887 #define RANGE_REG_COPY(INSN,N) XCINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 1, REG)
 888
 889 /* How many times a register in a live range note was referenced.  */
 890 #define RANGE_REG_REFS(INSN,N) XINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 2)
 891
 892 /* How many times a register in a live range note was set.  */
 893 #define RANGE_REG_SETS(INSN,N) XINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 3)
 894
 895 /* How many times a register in a live range note died.  */
 896 #define RANGE_REG_DEATHS(INSN,N) XINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 4)
 897
 898 /* Whether the original value is needed to be copied into the range register at
 899    the start of the range. */
 900 #define RANGE_REG_COPY_FLAGS(INSN,N) XINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 5)
 901
 902 /* # of insns the register copy is live over.  */
 903 #define RANGE_REG_LIVE_LENGTH(INSN,N) XINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 6)
 904
 905 /* # of calls the register copy is live over.  */
 906 #define RANGE_REG_N_CALLS(INSN,N) XINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 7)
 907
 908 /* DECL_NODE pointer of the declaration if the register is a user defined
 909    variable.  */
 910 #define RANGE_REG_SYMBOL_NODE(INSN,N) XTREE (XCVECEXP (INSN, 2, N, RANGE_INFO), 8)
 911
 912 /* BLOCK_NODE pointer to the block the variable is declared in if the
 913    register is a user defined variable.  */
 914 #define RANGE_REG_BLOCK_NODE(INSN,N) XTREE (XCVECEXP (INSN, 2, N, RANGE_INFO), 9)
 915
 916 /* EXPR_LIST of the distinct ranges a variable is in.  */
 917 #define RANGE_VAR_LIST(INSN) (XEXP (INSN, 0))
 918
 919 /* Block a variable is declared in.  */
 920 #define RANGE_VAR_BLOCK(INSN) (XTREE (INSN, 1))
 921
 922 /* # of distinct ranges a variable is in.  */
 923 #define RANGE_VAR_NUM(INSN) (XINT (INSN, 2))
 924
 925 /* For a NOTE_INSN_LIVE note, the registers which are currently live.  */
 926 #define RANGE_LIVE_BITMAP(INSN) (XBITMAP (INSN, 0))
 927
 928 /* For a NOTE_INSN_LIVE note, the original basic block number.  */
 929 #define RANGE_LIVE_ORIG_BLOCK(INSN) (XINT (INSN, 1))
 930 \f
 931 /* Nonzero if we need to distinguish between the return value of this function
 932    and the return value of a function called by this function.  This helps
 933    integrate.c.
 934    This is 1 until after the rtl generation pass.  */
 935 extern int rtx_equal_function_value_matters;
 936
 937 /* Generally useful functions.  */
 938
 939 /* The following functions accept a wide integer argument.  Rather than
 940    having to cast on every function call, we use a macro instead, that is
 941    defined here and in tree.h.  */
 942
 943 #ifndef exact_log2
 944 #define exact_log2(N) exact_log2_wide ((unsigned HOST_WIDE_INT) (N))
 945 #define floor_log2(N) floor_log2_wide ((unsigned HOST_WIDE_INT) (N))
 946 #endif
 947 extern int exact_log2_wide              PARAMS ((unsigned HOST_WIDE_INT));
 948 extern int floor_log2_wide              PARAMS ((unsigned HOST_WIDE_INT));
 949
 950 /* In expmed.c */
 951 extern int ceil_log2                    PARAMS ((unsigned HOST_WIDE_INT));
 952
 953 #define plus_constant(X,C) plus_constant_wide (X, (HOST_WIDE_INT) (C))
 954
 955 #define plus_constant_for_output(X,C)  \
 956   plus_constant_for_output_wide (X, (HOST_WIDE_INT) (C))
 957
 958 /* In explow.c */
 959 extern void set_stack_check_libfunc PARAMS ((rtx));
 960 extern HOST_WIDE_INT trunc_int_for_mode PARAMS ((HOST_WIDE_INT,
 961                                                enum machine_mode));
 962 extern rtx plus_constant_wide            PARAMS ((rtx, HOST_WIDE_INT));
 963 extern rtx plus_constant_for_output_wide PARAMS ((rtx, HOST_WIDE_INT));
 964 extern void optimize_save_area_alloca   PARAMS ((rtx));
 965
 966 extern rtx gen_rtx                      PARAMS ((enum rtx_code,
 967                                                  enum machine_mode, ...));
 968 extern rtvec gen_rtvec                  PARAMS ((int, ...));
 969
 970 extern char *oballoc                    PARAMS ((int));
 971 extern char *permalloc                  PARAMS ((int));
 972 extern rtx rtx_alloc                    PARAMS ((RTX_CODE));
 973 extern rtvec rtvec_alloc                PARAMS ((int));
 974 extern rtx copy_insn_1                  PARAMS ((rtx));
 975 extern rtx copy_insn                    PARAMS ((rtx));
 976 extern rtx copy_rtx                     PARAMS ((rtx));
 977 extern rtx copy_rtx_if_shared           PARAMS ((rtx));
 978 extern rtx copy_most_rtx                PARAMS ((rtx, rtx));
 979 extern rtx shallow_copy_rtx             PARAMS ((rtx));
 980 extern int rtx_equal_p                  PARAMS ((rtx, rtx));
 981 extern rtvec gen_rtvec_v                PARAMS ((int, rtx *));
 982 extern rtx gen_reg_rtx                  PARAMS ((enum machine_mode));
 983 extern rtx gen_label_rtx                PARAMS ((void));
 984 extern rtx gen_lowpart_common           PARAMS ((enum machine_mode, rtx));
 985 extern rtx gen_lowpart                  PARAMS ((enum machine_mode, rtx));
 986 extern rtx gen_lowpart_if_possible      PARAMS ((enum machine_mode, rtx));
 987 extern rtx gen_highpart                 PARAMS ((enum machine_mode, rtx));
 988 extern rtx gen_realpart                 PARAMS ((enum machine_mode, rtx));
 989 extern rtx gen_imagpart                 PARAMS ((enum machine_mode, rtx));
 990 extern rtx operand_subword              PARAMS ((rtx, int, int, enum machine_mode));
 991 extern rtx operand_subword_force        PARAMS ((rtx, int, enum machine_mode));
 992 extern int subreg_lowpart_p             PARAMS ((rtx));
 993 extern rtx make_safe_from               PARAMS ((rtx, rtx));
 994 extern rtx convert_memory_address       PARAMS ((enum machine_mode, rtx));
 995 extern rtx memory_address               PARAMS ((enum machine_mode, rtx));
 996 extern rtx get_insns                    PARAMS ((void));
 997 extern const char *get_insn_name        PARAMS ((int));
 998 extern rtx get_last_insn                PARAMS ((void));
 999 extern rtx get_last_insn_anywhere       PARAMS ((void));
1000 extern void start_sequence              PARAMS ((void));
1001 extern void push_to_sequence            PARAMS ((rtx));
1002 extern void end_sequence                PARAMS ((void));
1003 extern rtx gen_sequence                 PARAMS ((void));
1004 extern rtx immed_double_const           PARAMS ((HOST_WIDE_INT, HOST_WIDE_INT, enum machine_mode));
1005 extern rtx force_const_mem              PARAMS ((enum machine_mode, rtx));
1006 extern rtx force_reg                    PARAMS ((enum machine_mode, rtx));
1007 extern rtx get_pool_constant            PARAMS ((rtx));
1008 extern enum machine_mode get_pool_mode  PARAMS ((rtx));
1009 extern rtx get_pool_constant_for_function       PARAMS ((struct function *, rtx));
1010 extern enum machine_mode get_pool_mode_for_function     PARAMS ((struct function *, rtx));
1011 extern int get_pool_offset              PARAMS ((rtx));
1012 extern rtx simplify_subtraction         PARAMS ((rtx));
1013 extern rtx assign_stack_local           PARAMS ((enum machine_mode,
1014                                                HOST_WIDE_INT, int));
1015 extern rtx assign_stack_temp            PARAMS ((enum machine_mode,
1016                                                HOST_WIDE_INT, int));
1017 extern rtx assign_temp                  PARAMS ((union tree_node *,
1018                                                int, int, int));
1019 extern rtx protect_from_queue           PARAMS ((rtx, int));
1020 extern void emit_queue                  PARAMS ((void));
1021 extern rtx emit_move_insn               PARAMS ((rtx, rtx));
1022 extern rtx emit_insn_before             PARAMS ((rtx, rtx));
1023 extern rtx emit_jump_insn_before        PARAMS ((rtx, rtx));
1024 extern rtx emit_call_insn_before        PARAMS ((rtx, rtx));
1025 extern rtx emit_barrier_before          PARAMS ((rtx));
1026 extern rtx emit_label_before            PARAMS ((rtx, rtx));
1027 extern rtx emit_note_before             PARAMS ((int, rtx));
1028 extern rtx emit_insn_after              PARAMS ((rtx, rtx));
1029 extern rtx emit_jump_insn_after         PARAMS ((rtx, rtx));
1030 extern rtx emit_barrier_after           PARAMS ((rtx));
1031 extern rtx emit_label_after             PARAMS ((rtx, rtx));
1032 extern rtx emit_note_after              PARAMS ((int, rtx));
1033 extern rtx emit_line_note_after         PARAMS ((char *, int, rtx));
1034 extern rtx emit_insn                    PARAMS ((rtx));
1035 extern rtx emit_insns                   PARAMS ((rtx));
1036 extern rtx emit_insns_before            PARAMS ((rtx, rtx));
1037 extern rtx emit_insns_after             PARAMS ((rtx, rtx));
1038 extern rtx emit_jump_insn               PARAMS ((rtx));
1039 extern rtx emit_call_insn               PARAMS ((rtx));
1040 extern rtx emit_label                   PARAMS ((rtx));
1041 extern rtx emit_barrier                 PARAMS ((void));
1042 extern rtx emit_line_note               PARAMS ((char *, int));
1043 extern rtx emit_note                    PARAMS ((char *, int));
1044 extern rtx emit_line_note_force         PARAMS ((char *, int));
1045 extern rtx make_insn_raw                PARAMS ((rtx));
1046 extern rtx previous_insn                PARAMS ((rtx));
1047 extern rtx next_insn                    PARAMS ((rtx));
1048 extern rtx prev_nonnote_insn            PARAMS ((rtx));
1049 extern rtx next_nonnote_insn            PARAMS ((rtx));
1050 extern rtx prev_real_insn               PARAMS ((rtx));
1051 extern rtx next_real_insn               PARAMS ((rtx));
1052 extern rtx prev_active_insn             PARAMS ((rtx));
1053 extern rtx next_active_insn             PARAMS ((rtx));
1054 extern int active_insn_p                PARAMS ((rtx));
1055 extern rtx prev_label                   PARAMS ((rtx));
1056 extern rtx next_label                   PARAMS ((rtx));
1057 extern rtx next_cc0_user                PARAMS ((rtx));
1058 extern rtx prev_cc0_setter              PARAMS ((rtx));
1059 extern rtx next_nondeleted_insn         PARAMS ((rtx));
1060 extern enum rtx_code reverse_condition  PARAMS ((enum rtx_code));
1061 extern enum rtx_code reverse_condition_maybe_unordered PARAMS ((enum rtx_code));
1062 extern enum rtx_code swap_condition     PARAMS ((enum rtx_code));
1063 extern enum rtx_code unsigned_condition PARAMS ((enum rtx_code));
1064 extern enum rtx_code signed_condition   PARAMS ((enum rtx_code));
1065 extern rtx find_equiv_reg               PARAMS ((rtx, rtx, enum reg_class, int, short *, int, enum machine_mode));
1066 extern rtx squeeze_notes                PARAMS ((rtx, rtx));
1067 extern rtx delete_insn                  PARAMS ((rtx));
1068 extern void delete_jump                 PARAMS ((rtx));
1069 extern void delete_barrier              PARAMS ((rtx));
1070 extern rtx get_label_before             PARAMS ((rtx));
1071 extern rtx get_label_after              PARAMS ((rtx));
1072 extern rtx follow_jumps                 PARAMS ((rtx));
1073 extern rtx adj_offsettable_operand      PARAMS ((rtx, int));
1074 extern rtx try_split                    PARAMS ((rtx, rtx, int));
1075 extern rtx split_insns                  PARAMS ((rtx, rtx));
1076 extern rtx simplify_unary_operation     PARAMS ((enum rtx_code, enum machine_mode, rtx, enum machine_mode));
1077 extern rtx simplify_binary_operation    PARAMS ((enum rtx_code, enum machine_mode, rtx, rtx));
1078 extern rtx simplify_ternary_operation   PARAMS ((enum rtx_code, enum machine_mode, enum machine_mode, rtx, rtx, rtx));
1079 extern rtx simplify_relational_operation PARAMS ((enum rtx_code, enum machine_mode, rtx, rtx));
1080 extern rtx simplify_gen_binary          PARAMS ((enum rtx_code, enum machine_mode,
1081                                                rtx, rtx));
1082 extern rtx simplify_rtx                 PARAMS ((rtx));
1083 extern rtx gen_move_insn                PARAMS ((rtx, rtx));
1084 extern rtx gen_jump                     PARAMS ((rtx));
1085 extern rtx gen_beq                      PARAMS ((rtx));
1086 extern rtx gen_bge                      PARAMS ((rtx));
1087 extern rtx gen_ble                      PARAMS ((rtx));
1088 extern rtx gen_mem_addressof            PARAMS ((rtx, union tree_node *));
1089 extern rtx eliminate_constant_term      PARAMS ((rtx, rtx *));
1090 extern rtx expand_complex_abs           PARAMS ((enum machine_mode, rtx, rtx, int));
1091 extern enum machine_mode choose_hard_reg_mode PARAMS ((int, int));
1092 extern void set_unique_reg_note         PARAMS ((rtx, enum reg_note, rtx));
1093
1094 /* Functions in rtlanal.c */
1095
1096 extern int rtx_unstable_p               PARAMS ((rtx));
1097 extern int rtx_varies_p                 PARAMS ((rtx));
1098 extern int rtx_addr_varies_p            PARAMS ((rtx));
1099 extern HOST_WIDE_INT get_integer_term   PARAMS ((rtx));
1100 extern rtx get_related_value            PARAMS ((rtx));
1101 extern int reg_mentioned_p              PARAMS ((rtx, rtx));
1102 extern int reg_referenced_p             PARAMS ((rtx, rtx));
1103 extern int reg_used_between_p           PARAMS ((rtx, rtx, rtx));
1104 extern int reg_referenced_between_p     PARAMS ((rtx, rtx, rtx));
1105 extern int reg_set_between_p            PARAMS ((rtx, rtx, rtx));
1106 extern int regs_set_between_p           PARAMS ((rtx, rtx, rtx));
1107 extern int modified_between_p           PARAMS ((rtx, rtx, rtx));
1108 extern int no_labels_between_p          PARAMS ((rtx, rtx));
1109 extern int no_jumps_between_p           PARAMS ((rtx, rtx));
1110 extern int modified_in_p                PARAMS ((rtx, rtx));
1111 extern int reg_set_p                    PARAMS ((rtx, rtx));
1112 extern rtx single_set                   PARAMS ((rtx));
1113 extern int multiple_sets                PARAMS ((rtx));
1114 extern rtx find_last_value              PARAMS ((rtx, rtx *, rtx, int));
1115 extern int refers_to_regno_p            PARAMS ((int, int, rtx, rtx *));
1116 extern int reg_overlap_mentioned_p      PARAMS ((rtx, rtx));
1117 extern void note_stores                 PARAMS ((rtx, void (*)(rtx, rtx, void *), void *));
1118 extern rtx reg_set_last                 PARAMS ((rtx, rtx));
1119 extern int dead_or_set_p                PARAMS ((rtx, rtx));
1120 extern int dead_or_set_regno_p          PARAMS ((rtx, int));
1121 extern rtx find_reg_note                PARAMS ((rtx, enum reg_note, rtx));
1122 extern rtx find_regno_note              PARAMS ((rtx, enum reg_note, int));
1123 extern int find_reg_fusage              PARAMS ((rtx, enum rtx_code, rtx));
1124 extern int find_regno_fusage            PARAMS ((rtx, enum rtx_code, int));
1125 extern void remove_note                 PARAMS ((rtx, rtx));
1126 extern int side_effects_p               PARAMS ((rtx));
1127 extern int volatile_refs_p              PARAMS ((rtx));
1128 extern int volatile_insn_p              PARAMS ((rtx));
1129 extern int may_trap_p                   PARAMS ((rtx));
1130 extern int inequality_comparisons_p     PARAMS ((rtx));
1131 extern rtx replace_rtx                  PARAMS ((rtx, rtx, rtx));
1132 extern rtx replace_regs                 PARAMS ((rtx, rtx *, int, int));
1133 extern int computed_jump_p              PARAMS ((rtx));
1134 typedef int (*rtx_function)             PARAMS ((rtx *, void *));
1135 extern int for_each_rtx                 PARAMS ((rtx *, rtx_function, void *));
1136 extern rtx regno_use_in                 PARAMS ((int, rtx));
1137 extern int auto_inc_p                   PARAMS ((rtx));
1138 extern void remove_node_from_expr_list  PARAMS ((rtx, rtx *));
1139 extern int insns_safe_to_move_p         PARAMS ((rtx, rtx, rtx *));
1140
1141 /* flow.c */
1142
1143 extern rtx find_use_as_address          PARAMS ((rtx, rtx, HOST_WIDE_INT));
1144 void init_EXPR_INSN_LIST_cache          PARAMS ((void));
1145 void free_EXPR_LIST_list                PARAMS ((rtx *));
1146 void free_INSN_LIST_list                PARAMS ((rtx *));
1147 void free_EXPR_LIST_node                PARAMS ((rtx));
1148 void free_INSN_LIST_node                PARAMS ((rtx));
1149 rtx alloc_INSN_LIST                     PARAMS ((rtx, rtx));
1150 rtx alloc_EXPR_LIST                     PARAMS ((int, rtx, rtx));
1151
1152 /* regclass.c */
1153
1154 /* Maximum number of parallel sets and clobbers in any insn in this fn.
1155    Always at least 3, since the combiner could put that many togetherm
1156    and we want this to remain correct for all the remaining passes.  */
1157
1158 extern int max_parallel;
1159
1160 /* Free up register info memory.  */
1161 extern void free_reg_info               PARAMS ((void));
1162
1163 /* recog.c */
1164 extern int asm_noperands                PARAMS ((rtx));
1165 extern char *decode_asm_operands        PARAMS ((rtx, rtx *, rtx **,
1166                                                const char **,
1167                                                enum machine_mode *));
1168
1169 extern enum reg_class reg_preferred_class PARAMS ((int));
1170 extern enum reg_class reg_alternate_class PARAMS ((int));
1171
1172 extern rtx get_first_nonparm_insn       PARAMS ((void));
1173
1174 extern void split_all_insns             PARAMS ((int));
1175
1176 #define MAX_SAVED_CONST_INT 64
1177 extern rtx const_int_rtx[MAX_SAVED_CONST_INT * 2 + 1];
1178
1179 #define const0_rtx      (const_int_rtx[MAX_SAVED_CONST_INT])
1180 #define const1_rtx      (const_int_rtx[MAX_SAVED_CONST_INT+1])
1181 #define const2_rtx      (const_int_rtx[MAX_SAVED_CONST_INT+2])
1182 #define constm1_rtx     (const_int_rtx[MAX_SAVED_CONST_INT-1])
1183 extern rtx const_true_rtx;
1184
1185 extern rtx const_tiny_rtx[3][(int) MAX_MACHINE_MODE];
1186
1187 /* Returns a constant 0 rtx in mode MODE.  Integer modes are treated the
1188    same as VOIDmode.  */
1189
1190 #define CONST0_RTX(MODE) (const_tiny_rtx[0][(int) (MODE)])
1191
1192 /* Likewise, for the constants 1 and 2.  */
1193
1194 #define CONST1_RTX(MODE) (const_tiny_rtx[1][(int) (MODE)])
1195 #define CONST2_RTX(MODE) (const_tiny_rtx[2][(int) (MODE)])
1196
1197 /* If HARD_FRAME_POINTER_REGNUM is defined, then a special dummy reg
1198    is used to represent the frame pointer.  This is because the
1199    hard frame pointer and the automatic variables are separated by an amount
1200    that cannot be determined until after register allocation.  We can assume
1201    that in this case ELIMINABLE_REGS will be defined, one action of which
1202    will be to eliminate FRAME_POINTER_REGNUM into HARD_FRAME_POINTER_REGNUM. */
1203 #ifndef HARD_FRAME_POINTER_REGNUM
1204 #define HARD_FRAME_POINTER_REGNUM FRAME_POINTER_REGNUM
1205 #endif
1206
1207 /* Index labels for global_rtl.  */
1208 enum global_rtl_index
1209 {
1210   GR_PC,
1211   GR_CC0,
1212   GR_STACK_POINTER,
1213   GR_FRAME_POINTER,
1214 /* For register elimination to work properly these hard_frame_pointer_rtx,
1215    frame_pointer_rtx, and arg_pointer_rtx must be the same if they refer to
1216    the same register.  */
1217 #if FRAME_POINTER_REGNUM == ARG_POINTER_REGNUM
1218   GR_ARG_POINTER = GR_FRAME_POINTER,
1219 #endif
1220 #if HARD_FRAME_POINTER_REGNUM == FRAME_POINTER_REGNUM
1221   GR_HARD_FRAME_POINTER = GR_FRAME_POINTER,
1222 #else
1223   GR_HARD_FRAME_POINTER,
1224 #endif
1225 #if FRAME_POINTER_REGNUM != ARG_POINTER_REGNUM
1226 #if HARD_FRAME_POINTER_REGNUM == ARG_POINTER_REGNUM
1227   GR_ARG_POINTER = GR_HARD_FRAME_POINTER,
1228 #else
1229   GR_ARG_POINTER,
1230 #endif
1231 #endif
1232   GR_VIRTUAL_INCOMING_ARGS,
1233   GR_VIRTUAL_STACK_ARGS,
1234   GR_VIRTUAL_STACK_DYNAMIC,
1235   GR_VIRTUAL_OUTGOING_ARGS,
1236   GR_VIRTUAL_CFA,
1237
1238   GR_MAX
1239 };
1240
1241 /* Pointers to standard pieces of rtx are stored here.  */
1242 extern rtx global_rtl[GR_MAX];
1243
1244 /* Standard pieces of rtx, to be substituted directly into things.  */
1245 #define pc_rtx                  (global_rtl[GR_PC])
1246 #define cc0_rtx                 (global_rtl[GR_CC0])
1247
1248 /* All references to certain hard regs, except those created
1249    by allocating pseudo regs into them (when that's possible),
1250    go through these unique rtx objects.  */
1251 #define stack_pointer_rtx       (global_rtl[GR_STACK_POINTER])
1252 #define frame_pointer_rtx       (global_rtl[GR_FRAME_POINTER])
1253 #define hard_frame_pointer_rtx  (global_rtl[GR_HARD_FRAME_POINTER])
1254 #define arg_pointer_rtx         (global_rtl[GR_ARG_POINTER])
1255
1256 extern rtx pic_offset_table_rtx;
1257 extern rtx struct_value_rtx;
1258 extern rtx struct_value_incoming_rtx;
1259 extern rtx static_chain_rtx;
1260 extern rtx static_chain_incoming_rtx;
1261 extern rtx return_address_pointer_rtx;
1262
1263 /* Include the RTL generation functions.  */
1264
1265 #ifndef NO_GENRTL_H
1266 #include "genrtl.h"
1267 #endif
1268
1269 /* There are some RTL codes that require special attention; the
1270    generation functions included above do the raw handling.  If you
1271    add to this list, modify special_rtx in gengenrtl.c as well.  You
1272    should also modify gen_rtx to use the special function.  */
1273
1274 extern rtx gen_rtx_CONST_DOUBLE PARAMS ((enum machine_mode, rtx,
1275                                        HOST_WIDE_INT, HOST_WIDE_INT));
1276 extern rtx gen_rtx_CONST_INT PARAMS ((enum machine_mode, HOST_WIDE_INT));
1277 extern rtx gen_rtx_REG PARAMS ((enum machine_mode, int));
1278 extern rtx gen_rtx_MEM PARAMS ((enum machine_mode, rtx));
1279
1280 /* We need the cast here to ensure that we get the same result both with
1281    and without prototypes.  */
1282 #define GEN_INT(N)  gen_rtx_CONST_INT (VOIDmode, (HOST_WIDE_INT) (N))
1283
1284 /* Virtual registers are used during RTL generation to refer to locations into
1285    the stack frame when the actual location isn't known until RTL generation
1286    is complete.  The routine instantiate_virtual_regs replaces these with
1287    the proper value, which is normally {frame,arg,stack}_pointer_rtx plus
1288    a constant.  */
1289
1290 #define FIRST_VIRTUAL_REGISTER  (FIRST_PSEUDO_REGISTER)
1291
1292 /* This points to the first word of the incoming arguments passed on the stack,
1293    either by the caller or by the callee when pretending it was passed by the
1294    caller.  */
1295
1296 #define virtual_incoming_args_rtx       (global_rtl[GR_VIRTUAL_INCOMING_ARGS])
1297
1298 #define VIRTUAL_INCOMING_ARGS_REGNUM    (FIRST_VIRTUAL_REGISTER)
1299
1300 /* If FRAME_GROWS_DOWNWARD, this points to immediately above the first
1301    variable on the stack.  Otherwise, it points to the first variable on
1302    the stack.  */
1303
1304 #define virtual_stack_vars_rtx          (global_rtl[GR_VIRTUAL_STACK_ARGS])
1305
1306 #define VIRTUAL_STACK_VARS_REGNUM       ((FIRST_VIRTUAL_REGISTER) + 1)
1307
1308 /* This points to the location of dynamically-allocated memory on the stack
1309    immediately after the stack pointer has been adjusted by the amount
1310    desired.  */
1311
1312 #define virtual_stack_dynamic_rtx       (global_rtl[GR_VIRTUAL_STACK_DYNAMIC])
1313
1314 #define VIRTUAL_STACK_DYNAMIC_REGNUM    ((FIRST_VIRTUAL_REGISTER) + 2)
1315
1316 /* This points to the location in the stack at which outgoing arguments should
1317    be written when the stack is pre-pushed (arguments pushed using push
1318    insns always use sp).  */
1319
1320 #define virtual_outgoing_args_rtx       (global_rtl[GR_VIRTUAL_OUTGOING_ARGS])
1321
1322 #define VIRTUAL_OUTGOING_ARGS_REGNUM    ((FIRST_VIRTUAL_REGISTER) + 3)
1323
1324 /* This points to the Canonical Frame Address of the function.  This
1325    should corrospond to the CFA produced by INCOMING_FRAME_SP_OFFSET,
1326    but is calculated relative to the arg pointer for simplicity; the
1327    frame pointer nor stack pointer are necessarily fixed relative to
1328    the CFA until after reload.  */
1329
1330 #define virtual_cfa_rtx                 (global_rtl[GR_VIRTUAL_CFA])
1331
1332 #define VIRTUAL_CFA_REGNUM              ((FIRST_VIRTUAL_REGISTER) + 4)
1333
1334 #define LAST_VIRTUAL_REGISTER           ((FIRST_VIRTUAL_REGISTER) + 4)
1335
1336 extern rtx find_next_ref                PARAMS ((rtx, rtx));
1337 extern rtx *find_single_use             PARAMS ((rtx, rtx, rtx *));
1338
1339 extern rtx output_constant_def          PARAMS ((union tree_node *));
1340 extern rtx immed_real_const             PARAMS ((union tree_node *));
1341 extern union tree_node *make_tree       PARAMS ((union tree_node *, rtx));
1342
1343 /* Define a default value for STORE_FLAG_VALUE.  */
1344
1345 #ifndef STORE_FLAG_VALUE
1346 #define STORE_FLAG_VALUE 1
1347 #endif
1348
1349 /* Nonzero after the second flow pass has completed.
1350    Set to 1 or 0 by toplev.c  */
1351 extern int flow2_completed;
1352
1353 /* Nonzero after end of reload pass.
1354    Set to 1 or 0 by reload1.c.  */
1355
1356 extern int reload_completed;
1357
1358 /* Set to 1 while reload_as_needed is operating.
1359    Required by some machines to handle any generated moves differently.  */
1360
1361 extern int reload_in_progress;
1362
1363 /* If this is nonzero, we do not bother generating VOLATILE
1364    around volatile memory references, and we are willing to
1365    output indirect addresses.  If cse is to follow, we reject
1366    indirect addresses so a useful potential cse is generated;
1367    if it is used only once, instruction combination will produce
1368    the same indirect address eventually.  */
1369 extern int cse_not_expected;
1370
1371 /* Set to nonzero before life analysis to indicate that it is unsafe to
1372    generate any new pseudo registers.  */
1373 extern int no_new_pseudos;
1374
1375 /* Translates rtx code to tree code, for those codes needed by
1376    REAL_ARITHMETIC.  The function returns an int because the caller may not
1377    know what `enum tree_code' means.  */
1378
1379 extern int rtx_to_tree_code     PARAMS ((enum rtx_code));
1380
1381 /* In tree.c */
1382 extern void obfree                      PARAMS ((char *));
1383 struct obstack;
1384 extern void gcc_obstack_init            PARAMS ((struct obstack *));
1385 extern void pop_obstacks                PARAMS ((void));
1386 extern void push_obstacks               PARAMS ((struct obstack *,
1387                                                 struct obstack *));
1388 /* In cse.c */
1389 struct cse_basic_block_data;
1390 extern int rtx_cost                     PARAMS ((rtx, enum rtx_code));
1391 extern void delete_trivially_dead_insns PARAMS ((rtx, int));
1392 #ifdef BUFSIZ
1393 extern int cse_main                     PARAMS ((rtx, int, int, FILE *));
1394 #endif
1395 extern void cse_end_of_basic_block      PARAMS ((rtx,
1396                                                 struct cse_basic_block_data *,
1397                                                 int, int, int));
1398
1399 /* In jump.c */
1400 extern int comparison_dominates_p       PARAMS ((enum rtx_code, enum rtx_code));
1401 extern int condjump_p                   PARAMS ((rtx));
1402 extern rtx condjump_label               PARAMS ((rtx));
1403 extern int simplejump_p                 PARAMS ((rtx));
1404 extern int returnjump_p                 PARAMS ((rtx));
1405 extern int onlyjump_p                   PARAMS ((rtx));
1406 extern int sets_cc0_p                   PARAMS ((rtx));
1407 extern int invert_jump                  PARAMS ((rtx, rtx));
1408 extern int rtx_renumbered_equal_p       PARAMS ((rtx, rtx));
1409 extern int true_regnum                  PARAMS ((rtx));
1410 extern int redirect_jump                PARAMS ((rtx, rtx));
1411 extern void jump_optimize               PARAMS ((rtx, int, int, int));
1412 extern void rebuild_jump_labels         PARAMS ((rtx));
1413 extern void thread_jumps                PARAMS ((rtx, int, int));
1414 extern int redirect_exp                 PARAMS ((rtx *, rtx, rtx, rtx));
1415 extern int rtx_equal_for_thread_p       PARAMS ((rtx, rtx, rtx));
1416 extern int invert_exp                   PARAMS ((rtx, rtx));
1417 extern int can_reverse_comparison_p     PARAMS ((rtx, rtx));
1418 extern void delete_for_peephole         PARAMS ((rtx, rtx));
1419 extern int condjump_in_parallel_p       PARAMS ((rtx));
1420 extern void never_reached_warning       PARAMS ((rtx));
1421
1422 /* Flags for jump_optimize() */
1423 #define JUMP_CROSS_JUMP                 1
1424 #define JUMP_CROSS_JUMP_DEATH_MATTERS   2
1425 #define JUMP_NOOP_MOVES                 1
1426 #define JUMP_AFTER_REGSCAN              1
1427
1428 /* In emit-rtl.c. */
1429 extern int max_reg_num                          PARAMS ((void));
1430 extern int max_label_num                        PARAMS ((void));
1431 extern int get_first_label_num                  PARAMS ((void));
1432 extern void delete_insns_since                  PARAMS ((rtx));
1433 extern void mark_reg_pointer                    PARAMS ((rtx, int));
1434 extern void mark_user_reg                       PARAMS ((rtx));
1435 extern void reset_used_flags                    PARAMS ((rtx));
1436 extern void reorder_insns                       PARAMS ((rtx, rtx, rtx));
1437 extern int get_max_uid                          PARAMS ((void));
1438 extern int in_sequence_p                        PARAMS ((void));
1439 extern void force_next_line_note                PARAMS ((void));
1440 extern void clear_emit_caches                   PARAMS ((void));
1441 extern void init_emit                           PARAMS ((void));
1442 extern void init_emit_once                      PARAMS ((int));
1443 extern void push_topmost_sequence               PARAMS ((void));
1444 extern void pop_topmost_sequence                PARAMS ((void));
1445 extern int subreg_realpart_p                    PARAMS ((rtx));
1446 extern void reverse_comparison                  PARAMS ((rtx));
1447 extern void set_new_first_and_last_insn         PARAMS ((rtx, rtx));
1448 extern void set_new_first_and_last_label_num    PARAMS ((int, int));
1449 extern void set_new_last_label_num              PARAMS ((int));
1450 extern void unshare_all_rtl_again               PARAMS ((rtx));
1451 extern void set_last_insn                       PARAMS ((rtx));
1452 extern void link_cc0_insns                      PARAMS ((rtx));
1453 extern void add_insn                            PARAMS ((rtx));
1454 extern void add_insn_before                     PARAMS ((rtx, rtx));
1455 extern void add_insn_after                      PARAMS ((rtx, rtx));
1456 extern void remove_insn                         PARAMS ((rtx));
1457 extern void reorder_insns_with_line_notes       PARAMS ((rtx, rtx, rtx));
1458 extern void emit_insn_after_with_line_notes     PARAMS ((rtx, rtx, rtx));
1459 extern enum rtx_code classify_insn              PARAMS ((rtx));
1460 extern rtx emit                                 PARAMS ((rtx));
1461 /* Query and clear/ restore no_line_numbers.  This is used by the
1462    switch / case handling in stmt.c to give proper line numbers in
1463    warnings about unreachable code.  */
1464 int force_line_numbers PARAMS ((void));
1465 void restore_line_number_status PARAMS ((int old_value));
1466 extern void renumber_insns                      PARAMS ((FILE *));
1467 extern void remove_unncessary_notes             PARAMS ((void));
1468
1469 /* In insn-emit.c */
1470 extern void add_clobbers                PARAMS ((rtx, int));
1471
1472 /* In combine.c */
1473 extern void combine_instructions        PARAMS ((rtx, int));
1474 extern int extended_count               PARAMS ((rtx, enum machine_mode, int));
1475 extern rtx remove_death                 PARAMS ((int, rtx));
1476 #ifdef BUFSIZ
1477 extern void dump_combine_stats          PARAMS ((FILE *));
1478 extern void dump_combine_total_stats    PARAMS ((FILE *));
1479 #endif
1480
1481 /* In sched.c. */
1482 #ifdef BUFSIZ
1483 extern void schedule_insns              PARAMS ((FILE *));
1484 #endif
1485 extern void fix_sched_param             PARAMS ((const char *, const char *));
1486
1487 /* In print-rtl.c */
1488 extern void debug_rtx                   PARAMS ((rtx));
1489 extern void debug_rtx_list              PARAMS ((rtx, int));
1490 extern rtx debug_rtx_find               PARAMS ((rtx, int));
1491 #ifdef BUFSIZ
1492 extern void print_rtl                   PARAMS ((FILE *, rtx));
1493 extern int print_rtl_single             PARAMS ((FILE *, rtx));
1494 extern void print_inline_rtx            PARAMS ((FILE *, rtx, int));
1495 #endif
1496
1497 /* In loop.c */
1498 extern void init_loop                   PARAMS ((void));
1499 extern rtx libcall_other_reg            PARAMS ((rtx, rtx));
1500 #ifdef BUFSIZ
1501 extern void loop_optimize               PARAMS ((rtx, FILE *, int, int));
1502 #endif
1503 extern void record_excess_regs          PARAMS ((rtx, rtx, rtx *));
1504
1505 /* In function.c */
1506 extern void reposition_prologue_and_epilogue_notes      PARAMS ((rtx));
1507 extern void thread_prologue_and_epilogue_insns          PARAMS ((rtx));
1508 extern int prologue_epilogue_contains                   PARAMS ((rtx));
1509 extern HOST_WIDE_INT get_frame_size                     PARAMS ((void));
1510 extern void preserve_rtl_expr_result                    PARAMS ((rtx));
1511 extern void mark_temp_addr_taken                        PARAMS ((rtx));
1512 extern void update_temp_slot_address                    PARAMS ((rtx, rtx));
1513 extern void purge_addressof                             PARAMS ((rtx));
1514
1515 /* In reload.c */
1516 extern int operands_match_p             PARAMS ((rtx, rtx));
1517 extern int safe_from_earlyclobber       PARAMS ((rtx, rtx));
1518
1519 /* In stmt.c */
1520 extern void set_file_and_line_for_stmt  PARAMS ((char *, int));
1521 extern void expand_null_return          PARAMS ((void));
1522 extern void emit_jump                   PARAMS ((rtx));
1523 extern int preserve_subexpressions_p    PARAMS ((void));
1524
1525 /* In expr.c */
1526 extern void init_expr_once              PARAMS ((void));
1527 extern void move_by_pieces              PARAMS ((rtx, rtx, int, unsigned int));
1528
1529
1530 /* In stupid.c */
1531 #ifdef BUFSIZ
1532 extern void stupid_life_analysis        PARAMS ((rtx, int, FILE *));
1533 #endif
1534
1535 /* In flow.c */
1536 extern void allocate_bb_life_data       PARAMS ((void));
1537 extern void allocate_reg_life_data      PARAMS ((void));
1538 extern void recompute_reg_usage         PARAMS ((rtx, int));
1539 #ifdef BUFSIZ
1540 extern void print_rtl_with_bb           PARAMS ((FILE *, rtx));
1541 extern void dump_flow_info              PARAMS ((FILE *));
1542 #endif
1543
1544 /* In expmed.c */
1545 extern void init_expmed                 PARAMS ((void));
1546 extern void expand_inc                  PARAMS ((rtx, rtx));
1547 extern void expand_dec                  PARAMS ((rtx, rtx));
1548 extern rtx expand_mult_highpart         PARAMS ((enum machine_mode, rtx,
1549                                                 unsigned HOST_WIDE_INT, rtx,
1550                                                 int, int));
1551
1552 /* In gcse.c */
1553 #ifdef BUFSIZ
1554 extern int gcse_main                    PARAMS ((rtx, FILE *));
1555 #endif
1556
1557 /* In global.c */
1558 extern void mark_elimination            PARAMS ((int, int));
1559 #ifdef BUFSIZ
1560 extern int global_alloc                 PARAMS ((FILE *));
1561 extern void dump_global_regs            PARAMS ((FILE *));
1562 #endif
1563 #ifdef HARD_CONST
1564 extern void retry_global_alloc          PARAMS ((int, HARD_REG_SET));
1565 #endif
1566 extern void build_insn_chain            PARAMS ((rtx));
1567
1568 /* In regclass.c */
1569 extern int reg_classes_intersect_p      PARAMS ((enum reg_class, enum reg_class));
1570 extern int reg_class_subset_p           PARAMS ((enum reg_class, enum reg_class));
1571 extern void globalize_reg               PARAMS ((int));
1572 extern void init_regs                   PARAMS ((void));
1573 extern void init_reg_sets               PARAMS ((void));
1574 extern void regset_release_memory       PARAMS ((void));
1575 extern void regclass_init               PARAMS ((void));
1576 extern void regclass                    PARAMS ((rtx, int, FILE *));
1577 extern void reg_scan                    PARAMS ((rtx, int, int));
1578 extern void reg_scan_update             PARAMS ((rtx, rtx, int));
1579 extern void fix_register                PARAMS ((const char *, int, int));
1580
1581 extern void delete_null_pointer_checks  PARAMS ((rtx));
1582
1583 /* In regmove.c */
1584 #ifdef BUFSIZ
1585 extern void regmove_optimize            PARAMS ((rtx, int, FILE *));
1586 #endif
1587
1588 /* In reorg.c */
1589 #ifdef BUFSIZ
1590 extern void dbr_schedule                PARAMS ((rtx, FILE *));
1591 #endif
1592
1593 /* In optabs.c */
1594 extern void init_optabs                 PARAMS ((void));
1595
1596 /* In local-alloc.c */
1597 #ifdef BUFSIZ
1598 extern void dump_local_alloc            PARAMS ((FILE *));
1599 #endif
1600 extern int local_alloc                  PARAMS ((void));
1601 extern int function_invariant_p         PARAMS ((rtx));
1602
1603 /* In reload1.c */
1604 extern void reload_cse_regs             PARAMS ((rtx));
1605 extern void init_reload                 PARAMS ((void));
1606 extern void mark_home_live              PARAMS ((int));
1607 #ifdef BUFSIZ
1608 extern int reload                       PARAMS ((rtx, int, FILE *));
1609 #endif
1610
1611 /* In caller-save.c */
1612 extern void init_caller_save            PARAMS ((void));
1613
1614 /* In profile.c */
1615 extern void init_branch_prob            PARAMS ((const char *));
1616 #ifdef BUFSIZ
1617 extern void branch_prob                 PARAMS ((rtx, FILE *));
1618 extern void end_branch_prob             PARAMS ((FILE *));
1619 #endif
1620 extern void output_func_start_profiler  PARAMS ((void));
1621
1622 /* In reg-stack.c */
1623 #ifdef BUFSIZ
1624 extern void reg_to_stack                PARAMS ((rtx, FILE *));
1625 #endif
1626
1627 /* In fold-const.c */
1628 extern int add_double           PARAMS ((HOST_WIDE_INT, HOST_WIDE_INT,
1629                                         HOST_WIDE_INT, HOST_WIDE_INT,
1630                                         HOST_WIDE_INT *, HOST_WIDE_INT *));
1631 extern int neg_double           PARAMS ((HOST_WIDE_INT, HOST_WIDE_INT,
1632                                         HOST_WIDE_INT *, HOST_WIDE_INT *));
1633 extern int mul_double           PARAMS ((HOST_WIDE_INT, HOST_WIDE_INT,
1634                                         HOST_WIDE_INT, HOST_WIDE_INT,
1635                                         HOST_WIDE_INT *, HOST_WIDE_INT *));
1636 extern void lshift_double       PARAMS ((HOST_WIDE_INT, HOST_WIDE_INT,
1637                                         HOST_WIDE_INT, int, HOST_WIDE_INT *,
1638                                         HOST_WIDE_INT *, int));
1639 extern void rshift_double       PARAMS ((HOST_WIDE_INT, HOST_WIDE_INT,
1640                                         HOST_WIDE_INT, int,
1641                                         HOST_WIDE_INT *, HOST_WIDE_INT *, int));
1642 extern void lrotate_double      PARAMS ((HOST_WIDE_INT, HOST_WIDE_INT,
1643                                         HOST_WIDE_INT, int, HOST_WIDE_INT *,
1644                                         HOST_WIDE_INT *));
1645 extern void rrotate_double      PARAMS ((HOST_WIDE_INT, HOST_WIDE_INT,
1646                                         HOST_WIDE_INT, int, HOST_WIDE_INT *,
1647                                         HOST_WIDE_INT *));
1648
1649 /* In calls.c */
1650 extern void emit_library_call           PARAMS ((rtx, int, enum machine_mode,
1651                                                   int, ...));
1652 extern rtx emit_library_call_value      PARAMS ((rtx, rtx, int,
1653                                                  enum machine_mode,
1654                                                  int, ...));
1655
1656 /* In unroll.c */
1657 extern int set_dominates_use            PARAMS ((int, int, int, rtx, rtx));
1658
1659 /* In varasm.c */
1660 extern void bss_section                 PARAMS ((void));
1661 extern int in_data_section              PARAMS ((void));
1662 extern int supports_one_only            PARAMS ((void));
1663 extern void init_varasm_once            PARAMS ((void));
1664
1665 /* In rtl.c */
1666 extern void init_rtl                    PARAMS ((void));
1667 extern void rtx_free                    PARAMS ((rtx));
1668
1669 #ifdef BUFSIZ
1670 extern int read_skip_spaces             PARAMS ((FILE *));
1671 extern rtx read_rtx                     PARAMS ((FILE *));
1672 #endif
1673
1674 extern const char *read_rtx_filename;
1675 extern int read_rtx_lineno;
1676
1677 /* Redefine abort to report an internal error w/o coredump, and
1678    reporting the location of the error in the source file.  This logic
1679    is duplicated in rtl.h and tree.h because every file that needs the
1680    special abort includes one or both.  toplev.h gets too few files,
1681    system.h gets too many.  */
1682
1683 extern void fancy_abort PARAMS ((const char *, int, const char *))
1684     ATTRIBUTE_NORETURN;
1685 #if (GCC_VERSION >= 2007)
1686 #define abort() fancy_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
1687 #else
1688 #define abort() fancy_abort (__FILE__, __LINE__, 0)
1689 #endif
1690
1691 /* In alias.c */
1692 extern int true_dependence              PARAMS ((rtx, enum machine_mode, rtx,
1693                                                 int (*)(rtx)));
1694 extern int read_dependence              PARAMS ((rtx, rtx));
1695 extern int anti_dependence              PARAMS ((rtx, rtx));
1696 extern int output_dependence            PARAMS ((rtx, rtx));
1697 extern void mark_constant_function      PARAMS ((void));
1698 extern void init_alias_once             PARAMS ((void));
1699 extern void init_alias_analysis         PARAMS ((void));
1700 extern void end_alias_analysis          PARAMS ((void));
1701
1702 extern void record_base_value           PARAMS ((int, rtx, int));
1703 extern void record_alias_subset         PARAMS ((int, int));
1704 extern rtx addr_side_effect_eval        PARAMS ((rtx, int, int));
1705
1706 #ifdef STACK_REGS
1707 extern int stack_regs_mentioned         PARAMS ((rtx insn));
1708 #endif
1709
1710 /* In toplev.c */
1711
1712 extern rtx stack_limit_rtx;
1713
1714 #endif /* _RTL_H */