gcc/rtl.h

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