gcc/rtl.h

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