gcc/rtl.h

   1 /* Register Transfer Language (RTL) definitions for GCC
   2    Copyright (C) 1987, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
   3    1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 2, or (at your option) any later
  10 version.
  11
  12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GCC; see the file COPYING.  If not, write to the Free
  19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  20 02111-1307, USA.  */
  21
  22 #ifndef GCC_RTL_H
  23 #define GCC_RTL_H
  24
  25 struct function;
  26
  27 #include "machmode.h"
  28 #include "input.h"
  29
  30 #undef FFS  /* Some systems predefine this symbol; don't let it interfere.  */
  31 #undef FLOAT /* Likewise.  */
  32 #undef ABS /* Likewise.  */
  33 #undef PC /* Likewise.  */
  34
  35 /* Value used by some passes to "recognize" noop moves as valid
  36  instructions.  */
  37 #define NOOP_MOVE_INSN_CODE     INT_MAX
  38
  39 /* Register Transfer Language EXPRESSIONS CODES */
  40
  41 #define RTX_CODE        enum rtx_code
  42 enum rtx_code  {
  43
  44 #define DEF_RTL_EXPR(ENUM, NAME, FORMAT, CLASS)   ENUM ,
  45 #include "rtl.def"              /* rtl expressions are documented here */
  46 #undef DEF_RTL_EXPR
  47
  48   LAST_AND_UNUSED_RTX_CODE};    /* A convenient way to get a value for
  49                                    NUM_RTX_CODE.
  50                                    Assumes default enum value assignment.  */
  51
  52 #define NUM_RTX_CODE ((int) LAST_AND_UNUSED_RTX_CODE)
  53                                 /* The cast here, saves many elsewhere.  */
  54
  55 extern const unsigned char rtx_length[NUM_RTX_CODE];
  56 #define GET_RTX_LENGTH(CODE)            (rtx_length[(int) (CODE)])
  57
  58 extern const char * const rtx_name[NUM_RTX_CODE];
  59 #define GET_RTX_NAME(CODE)              (rtx_name[(int) (CODE)])
  60
  61 extern const char * const rtx_format[NUM_RTX_CODE];
  62 #define GET_RTX_FORMAT(CODE)            (rtx_format[(int) (CODE)])
  63
  64 extern const char rtx_class[NUM_RTX_CODE];
  65 #define GET_RTX_CLASS(CODE)             (rtx_class[(int) (CODE)])
  66
  67 extern const unsigned char rtx_next[NUM_RTX_CODE];
  68 \f
  69 /* The flags and bitfields of an ADDR_DIFF_VEC.  BASE is the base label
  70    relative to which the offsets are calculated, as explained in rtl.def.  */
  71 typedef struct
  72 {
  73   /* Set at the start of shorten_branches - ONLY WHEN OPTIMIZING - : */
  74   unsigned min_align: 8;
  75   /* Flags: */
  76   unsigned base_after_vec: 1; /* BASE is after the ADDR_DIFF_VEC.  */
  77   unsigned min_after_vec: 1;  /* minimum address target label is
  78                                  after the ADDR_DIFF_VEC.  */
  79   unsigned max_after_vec: 1;  /* maximum address target label is
  80                                  after the ADDR_DIFF_VEC.  */
  81   unsigned min_after_base: 1; /* minimum address target label is
  82                                  after BASE.  */
  83   unsigned max_after_base: 1; /* maximum address target label is
  84                                  after BASE.  */
  85   /* Set by the actual branch shortening process - ONLY WHEN OPTIMIZING - : */
  86   unsigned offset_unsigned: 1; /* offsets have to be treated as unsigned.  */
  87   unsigned : 2;
  88   unsigned scale : 8;
  89 } addr_diff_vec_flags;
  90
  91 /* Structure used to describe the attributes of a MEM.  These are hashed
  92    so MEMs that the same attributes share a data structure.  This means
  93    they cannot be modified in place.  If any element is nonzero, it means
  94    the value of the corresponding attribute is unknown.  */
  95 /* ALIGN and SIZE are the alignment and size of the MEM itself,
  96    while EXPR can describe a larger underlying object, which might have a
  97    stricter alignment; OFFSET is the offset of the MEM within that object.  */
  98 typedef struct mem_attrs GTY(())
  99 {
 100   HOST_WIDE_INT alias;          /* Memory alias set.  */
 101   tree expr;                    /* expr corresponding to MEM.  */
 102   rtx offset;                   /* Offset from start of DECL, as CONST_INT.  */
 103   rtx size;                     /* Size in bytes, as a CONST_INT.  */
 104   unsigned int align;           /* Alignment of MEM in bits.  */
 105 } mem_attrs;
 106
 107 /* Structure used to describe the attributes of a REG in similar way as
 108    mem_attrs does for MEM above.  */
 109
 110 typedef struct reg_attrs GTY(())
 111 {
 112   tree decl;                    /* decl corresponding to REG.  */
 113   HOST_WIDE_INT offset;         /* Offset from start of DECL.  */
 114 } reg_attrs;
 115
 116 /* Common union for an element of an rtx.  */
 117
 118 union rtunion_def
 119 {
 120   HOST_WIDE_INT rtwint;
 121   int rtint;
 122   unsigned int rtuint;
 123   const char *rtstr;
 124   rtx rtx;
 125   rtvec rtvec;
 126   enum machine_mode rttype;
 127   addr_diff_vec_flags rt_addr_diff_vec_flags;
 128   struct cselib_val_struct *rt_cselib;
 129   struct bitmap_head_def *rtbit;
 130   tree rttree;
 131   struct basic_block_def *bb;
 132   mem_attrs *rtmem;
 133   reg_attrs *rtreg;
 134 };
 135 typedef union rtunion_def rtunion;
 136
 137 /* RTL expression ("rtx").  */
 138
 139 struct rtx_def GTY((chain_next ("RTX_NEXT (&%h)"),
 140                     chain_prev ("RTX_PREV (&%h)")))
 141 {
 142   /* The kind of expression this is.  */
 143   ENUM_BITFIELD(rtx_code) code: 16;
 144
 145   /* The kind of value the expression has.  */
 146   ENUM_BITFIELD(machine_mode) mode : 8;
 147
 148   /* 1 in a MEM if we should keep the alias set for this mem unchanged
 149      when we access a component.
 150      1 in a CALL_INSN if it is a sibling call.
 151      1 in a SET that is for a return.
 152      In a CODE_LABEL, part of the two-bit alternate entry field.  */
 153   unsigned int jump : 1;
 154   /* In a CODE_LABEL, part of the two-bit alternate entry field.
 155      1 in a MEM if it cannot trap.  */
 156   unsigned int call : 1;
 157   /* 1 in a REG, MEM, or CONCAT if the value is set at most once, anywhere.
 158      1 in a SUBREG if it references an unsigned object whose mode has been
 159      from a promoted to a wider mode.
 160      1 in a SYMBOL_REF if it addresses something in the per-function
 161      constants pool.
 162      1 in a CALL_INSN, NOTE, or EXPR_LIST for a const or pure call.
 163      1 in a JUMP_INSN, CALL_INSN, or INSN of an annulling branch.  */
 164   unsigned int unchanging : 1;
 165   /* 1 in a MEM or ASM_OPERANDS expression if the memory reference is volatile.
 166      1 in an INSN, CALL_INSN, JUMP_INSN, CODE_LABEL, BARRIER, or NOTE
 167      if it has been deleted.
 168      1 in a REG expression if corresponds to a variable declared by the user,
 169      0 for an internally generated temporary.
 170      1 in a SUBREG with a negative value.
 171      1 in a LABEL_REF or in a REG_LABEL note for a non-local label.
 172      In a SYMBOL_REF, this flag is used for machine-specific purposes.  */
 173   unsigned int volatil : 1;
 174   /* 1 in a MEM referring to a field of an aggregate.
 175      0 if the MEM was a variable or the result of a * operator in C;
 176      1 if it was the result of a . or -> operator (on a struct) in C.
 177      1 in a REG if the register is used only in exit code a loop.
 178      1 in a SUBREG expression if was generated from a variable with a
 179      promoted mode.
 180      1 in a CODE_LABEL if the label is used for nonlocal gotos
 181      and must not be deleted even if its count is zero.
 182      1 in a LABEL_REF if this is a reference to a label outside the
 183      current loop.
 184      1 in an INSN, JUMP_INSN or CALL_INSN if this insn must be scheduled
 185      together with the preceding insn.  Valid only within sched.
 186      1 in an INSN, JUMP_INSN, or CALL_INSN if insn is in a delay slot and
 187      from the target of a branch.  Valid from reorg until end of compilation;
 188      cleared before used.
 189      1 in an INSN, JUMP_INSN or CALL_INSN or related rtx if this insn is
 190      dead code.  Valid only during dead-code elimination phase; cleared
 191      before use.  */
 192   unsigned int in_struct : 1;
 193   /* At the end of RTL generation, 1 if this rtx is used.  This is used for
 194      copying shared structure.  See `unshare_all_rtl'.
 195      In a REG, this is not needed for that purpose, and used instead
 196      in `leaf_renumber_regs_insn'.
 197      1 in a SYMBOL_REF, means that emit_library_call
 198      has used it as the function.  */
 199   unsigned int used : 1;
 200   /* Nonzero if this rtx came from procedure integration.
 201      1 in a REG or PARALLEL means this rtx refers to the return value
 202      of the current function.
 203      1 in a SYMBOL_REF if the symbol is weak.  */
 204   unsigned integrated : 1;
 205   /* 1 in an INSN or a SET if this rtx is related to the call frame,
 206      either changing how we compute the frame address or saving and
 207      restoring registers in the prologue and epilogue.
 208      1 in a MEM if the MEM refers to a scalar, rather than a member of
 209      an aggregate.
 210      1 in a REG if the register is a pointer.
 211      1 in a SYMBOL_REF if it addresses something in the per-function
 212      constant string pool.  */
 213   unsigned frame_related : 1;
 214
 215   /* The first element of the operands of this rtx.
 216      The number of operands and their types are controlled
 217      by the `code' field, according to rtl.def.  */
 218   rtunion GTY ((special ("rtx_def"),
 219                 desc ("GET_CODE (&%0)"))) fld[1];
 220 };
 221
 222 #define NULL_RTX (rtx) 0
 223
 224 /* The "next" and "previous" RTX, relative to this one.  */
 225
 226 #define RTX_NEXT(X) (rtx_next[GET_CODE (X)] == 0 ? NULL                 \
 227                      : *(rtx *)(((char *)X) + rtx_next[GET_CODE (X)]))
 228
 229 /* FIXME: the "NEXT_INSN (PREV_INSN (X)) == X" condition shouldn't be needed.
 230  */
 231 #define RTX_PREV(X) ((GET_CODE (X) == INSN              \
 232                       || GET_CODE (X) == CALL_INSN      \
 233                       || GET_CODE (X) == JUMP_INSN      \
 234                       || GET_CODE (X) == NOTE           \
 235                       || GET_CODE (X) == BARRIER        \
 236                       || GET_CODE (X) == CODE_LABEL)    \
 237                      && PREV_INSN (X) != NULL           \
 238                      && NEXT_INSN (PREV_INSN (X)) == X  \
 239                      ? PREV_INSN (X) : NULL)
 240
 241 /* Define macros to access the `code' field of the rtx.  */
 242
 243 #define GET_CODE(RTX)       ((enum rtx_code) (RTX)->code)
 244 #define PUT_CODE(RTX, CODE) ((RTX)->code = (ENUM_BITFIELD(rtx_code)) (CODE))
 245
 246 #define GET_MODE(RTX)       ((enum machine_mode) (RTX)->mode)
 247 #define PUT_MODE(RTX, MODE) ((RTX)->mode = (ENUM_BITFIELD(machine_mode)) (MODE))
 248
 249 /* RTL vector.  These appear inside RTX's when there is a need
 250    for a variable number of things.  The principle use is inside
 251    PARALLEL expressions.  */
 252
 253 struct rtvec_def GTY(()) {
 254   int num_elem;         /* number of elements */
 255   rtx GTY ((length ("%h.num_elem"))) elem[1];
 256 };
 257
 258 #define NULL_RTVEC (rtvec) 0
 259
 260 #define GET_NUM_ELEM(RTVEC)             ((RTVEC)->num_elem)
 261 #define PUT_NUM_ELEM(RTVEC, NUM)        ((RTVEC)->num_elem = (NUM))
 262
 263 /* Predicate yielding nonzero iff X is an rtl for a register.  */
 264 #define REG_P(X) (GET_CODE (X) == REG)
 265
 266 /* Predicate yielding nonzero iff X is a label insn.  */
 267 #define LABEL_P(X) (GET_CODE (X) == CODE_LABEL)
 268
 269 /* Predicate yielding nonzero iff X is a jump insn.  */
 270 #define JUMP_P(X) (GET_CODE (X) == JUMP_INSN)
 271
 272 /* Predicate yielding nonzero iff X is a note insn.  */
 273 #define NOTE_P(X) (GET_CODE (X) == NOTE)
 274
 275 /* Predicate yielding nonzero iff X is a barrier insn.  */
 276 #define BARRIER_P(X) (GET_CODE (X) == BARRIER)
 277
 278 /* Predicate yielding nonzero iff X is a data for a jump table.  */
 279 #define JUMP_TABLE_DATA_P(INSN) \
 280   (JUMP_P (INSN) && (GET_CODE (PATTERN (INSN)) == ADDR_VEC || \
 281                      GET_CODE (PATTERN (INSN)) == ADDR_DIFF_VEC))
 282
 283 /* 1 if X is a constant value that is an integer.  */
 284
 285 #define CONSTANT_P(X)   \
 286   (GET_CODE (X) == LABEL_REF || GET_CODE (X) == SYMBOL_REF              \
 287    || GET_CODE (X) == CONST_INT || GET_CODE (X) == CONST_DOUBLE         \
 288    || GET_CODE (X) == CONST || GET_CODE (X) == HIGH                     \
 289    || GET_CODE (X) == CONST_VECTOR                                      \
 290    || GET_CODE (X) == CONSTANT_P_RTX)
 291
 292 /* General accessor macros for accessing the fields of an rtx.  */
 293
 294 #if defined ENABLE_RTL_CHECKING && (GCC_VERSION >= 2007)
 295 /* The bit with a star outside the statement expr and an & inside is
 296    so that N can be evaluated only once.  */
 297 #define RTL_CHECK1(RTX, N, C1) __extension__                            \
 298 (*({ rtx const _rtx = (RTX); const int _n = (N);                        \
 299      const enum rtx_code _code = GET_CODE (_rtx);                       \
 300      if (_n < 0 || _n >= GET_RTX_LENGTH (_code))                        \
 301        rtl_check_failed_bounds (_rtx, _n, __FILE__, __LINE__,           \
 302                                 __FUNCTION__);                          \
 303      if (GET_RTX_FORMAT(_code)[_n] != C1)                               \
 304        rtl_check_failed_type1 (_rtx, _n, C1, __FILE__, __LINE__,        \
 305                                __FUNCTION__);                           \
 306      &_rtx->fld[_n]; }))
 307
 308 #define RTL_CHECK2(RTX, N, C1, C2) __extension__                        \
 309 (*({ rtx const _rtx = (RTX); const int _n = (N);                        \
 310      const enum rtx_code _code = GET_CODE (_rtx);                       \
 311      if (_n < 0 || _n >= GET_RTX_LENGTH (_code))                        \
 312        rtl_check_failed_bounds (_rtx, _n, __FILE__, __LINE__,           \
 313                                 __FUNCTION__);                          \
 314      if (GET_RTX_FORMAT(_code)[_n] != C1                                \
 315          && GET_RTX_FORMAT(_code)[_n] != C2)                            \
 316        rtl_check_failed_type2 (_rtx, _n, C1, C2, __FILE__, __LINE__,    \
 317                                __FUNCTION__);                           \
 318      &_rtx->fld[_n]; }))
 319
 320 #define RTL_CHECKC1(RTX, N, C) __extension__                            \
 321 (*({ rtx const _rtx = (RTX); const int _n = (N);                        \
 322      if (GET_CODE (_rtx) != (C))                                        \
 323        rtl_check_failed_code1 (_rtx, (C), __FILE__, __LINE__,           \
 324                                __FUNCTION__);                           \
 325      &_rtx->fld[_n]; }))
 326
 327 #define RTL_CHECKC2(RTX, N, C1, C2) __extension__                       \
 328 (*({ rtx const _rtx = (RTX); const int _n = (N);                        \
 329      const enum rtx_code _code = GET_CODE (_rtx);                       \
 330      if (_code != (C1) && _code != (C2))                                \
 331        rtl_check_failed_code2 (_rtx, (C1), (C2), __FILE__, __LINE__,    \
 332                                __FUNCTION__); \
 333      &_rtx->fld[_n]; }))
 334
 335 #define RTVEC_ELT(RTVEC, I) __extension__                               \
 336 (*({ rtvec const _rtvec = (RTVEC); const int _i = (I);                  \
 337      if (_i < 0 || _i >= GET_NUM_ELEM (_rtvec))                         \
 338        rtvec_check_failed_bounds (_rtvec, _i, __FILE__, __LINE__,       \
 339                                   __FUNCTION__);                        \
 340      &_rtvec->elem[_i]; }))
 341
 342 extern void rtl_check_failed_bounds (rtx, int, const char *, int,
 343                                      const char *)
 344     ATTRIBUTE_NORETURN;
 345 extern void rtl_check_failed_type1 (rtx, int, int, const char *, int,
 346                                     const char *)
 347     ATTRIBUTE_NORETURN;
 348 extern void rtl_check_failed_type2 (rtx, int, int, int, const char *,
 349                                     int, const char *)
 350     ATTRIBUTE_NORETURN;
 351 extern void rtl_check_failed_code1 (rtx, enum rtx_code, const char *,
 352                                     int, const char *)
 353     ATTRIBUTE_NORETURN;
 354 extern void rtl_check_failed_code2 (rtx, enum rtx_code, enum rtx_code,
 355                                     const char *, int, const char *)
 356     ATTRIBUTE_NORETURN;
 357 extern void rtvec_check_failed_bounds (rtvec, int, const char *, int,
 358                                        const char *)
 359     ATTRIBUTE_NORETURN;
 360
 361 #else   /* not ENABLE_RTL_CHECKING */
 362
 363 #define RTL_CHECK1(RTX, N, C1)      ((RTX)->fld[N])
 364 #define RTL_CHECK2(RTX, N, C1, C2)  ((RTX)->fld[N])
 365 #define RTL_CHECKC1(RTX, N, C)      ((RTX)->fld[N])
 366 #define RTL_CHECKC2(RTX, N, C1, C2) ((RTX)->fld[N])
 367 #define RTVEC_ELT(RTVEC, I)         ((RTVEC)->elem[I])
 368
 369 #endif
 370
 371 /* General accessor macros for accessing the flags of an rtx.  */
 372
 373 /* Access an individual rtx flag, with no checking of any kind.  */
 374 #define RTX_FLAG(RTX, FLAG)     ((RTX)->FLAG)
 375
 376 #if defined ENABLE_RTL_FLAG_CHECKING && (GCC_VERSION >= 2007)
 377 #define RTL_FLAG_CHECK1(NAME, RTX, C1) __extension__                    \
 378 ({ rtx const _rtx = (RTX);                                              \
 379    if (GET_CODE(_rtx) != C1)                                            \
 380      rtl_check_failed_flag  (NAME, _rtx, __FILE__, __LINE__,            \
 381                              __FUNCTION__);                             \
 382    _rtx; })
 383
 384 #define RTL_FLAG_CHECK2(NAME, RTX, C1, C2) __extension__                \
 385 ({ rtx const _rtx = (RTX);                                              \
 386    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2)                    \
 387      rtl_check_failed_flag  (NAME,_rtx, __FILE__, __LINE__,             \
 388                               __FUNCTION__);                            \
 389    _rtx; })
 390
 391 #define RTL_FLAG_CHECK3(NAME, RTX, C1, C2, C3) __extension__            \
 392 ({ rtx const _rtx = (RTX);                                              \
 393    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2                     \
 394        && GET_CODE(_rtx) != C3)                                         \
 395      rtl_check_failed_flag  (NAME, _rtx, __FILE__, __LINE__,            \
 396                              __FUNCTION__);                             \
 397    _rtx; })
 398
 399 #define RTL_FLAG_CHECK4(NAME, RTX, C1, C2, C3, C4) __extension__        \
 400 ({ rtx const _rtx = (RTX);                                              \
 401    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2                     \
 402        && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4)                 \
 403      rtl_check_failed_flag  (NAME, _rtx, __FILE__, __LINE__,            \
 404                               __FUNCTION__);                            \
 405    _rtx; })
 406
 407 #define RTL_FLAG_CHECK5(NAME, RTX, C1, C2, C3, C4, C5) __extension__    \
 408 ({ rtx const _rtx = (RTX);                                              \
 409    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2                     \
 410        && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4                  \
 411        && GET_CODE(_rtx) != C5)                                         \
 412      rtl_check_failed_flag  (NAME, _rtx, __FILE__, __LINE__,            \
 413                              __FUNCTION__);                             \
 414    _rtx; })
 415
 416 #define RTL_FLAG_CHECK6(NAME, RTX, C1, C2, C3, C4, C5, C6)              \
 417   __extension__                                                         \
 418 ({ rtx const _rtx = (RTX);                                              \
 419    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2                     \
 420        && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4                  \
 421        && GET_CODE(_rtx) != C5 && GET_CODE(_rtx) != C6)                 \
 422      rtl_check_failed_flag  (NAME,_rtx, __FILE__, __LINE__,             \
 423                              __FUNCTION__);                             \
 424    _rtx; })
 425
 426 #define RTL_FLAG_CHECK7(NAME, RTX, C1, C2, C3, C4, C5, C6, C7)          \
 427   __extension__                                                         \
 428 ({ rtx const _rtx = (RTX);                                              \
 429    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2                     \
 430        && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4                  \
 431        && GET_CODE(_rtx) != C5 && GET_CODE(_rtx) != C6                  \
 432        && GET_CODE(_rtx) != C7)                                         \
 433      rtl_check_failed_flag  (NAME, _rtx, __FILE__, __LINE__,            \
 434                              __FUNCTION__);                             \
 435    _rtx; })
 436
 437 #define RTL_FLAG_CHECK8(NAME, RTX, C1, C2, C3, C4, C5, C6, C7, C8)      \
 438   __extension__                                                         \
 439 ({ rtx const _rtx = (RTX);                                              \
 440    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2                     \
 441        && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4                  \
 442        && GET_CODE(_rtx) != C5 && GET_CODE(_rtx) != C6                  \
 443        && GET_CODE(_rtx) != C7 && GET_CODE(_rtx) != C8)                 \
 444      rtl_check_failed_flag  (NAME, _rtx, __FILE__, __LINE__,            \
 445                              __FUNCTION__);                             \
 446    _rtx; })
 447
 448 extern void rtl_check_failed_flag (const char *, rtx, const char *,
 449                                    int, const char *)
 450     ATTRIBUTE_NORETURN
 451     ;
 452
 453 #else   /* not ENABLE_RTL_FLAG_CHECKING */
 454
 455 #define RTL_FLAG_CHECK1(NAME, RTX, C1)                                  (RTX)
 456 #define RTL_FLAG_CHECK2(NAME, RTX, C1, C2)                              (RTX)
 457 #define RTL_FLAG_CHECK3(NAME, RTX, C1, C2, C3)                          (RTX)
 458 #define RTL_FLAG_CHECK4(NAME, RTX, C1, C2, C3, C4)                      (RTX)
 459 #define RTL_FLAG_CHECK5(NAME, RTX, C1, C2, C3, C4, C5)          (RTX)
 460 #define RTL_FLAG_CHECK6(NAME, RTX, C1, C2, C3, C4, C5, C6)              (RTX)
 461 #define RTL_FLAG_CHECK7(NAME, RTX, C1, C2, C3, C4, C5, C6, C7)          (RTX)
 462 #define RTL_FLAG_CHECK8(NAME, RTX, C1, C2, C3, C4, C5, C6, C7, C8)      (RTX)
 463 #endif
 464
 465 #define CLEAR_RTX_FLAGS(RTX)    \
 466 do {                            \
 467   rtx const _rtx = (RTX);       \
 468   _rtx->call = 0;               \
 469   _rtx->frame_related = 0;      \
 470   _rtx->in_struct = 0;          \
 471   _rtx->integrated = 0;         \
 472   _rtx->jump = 0;               \
 473   _rtx->unchanging = 0;         \
 474   _rtx->used = 0;               \
 475   _rtx->volatil = 0;            \
 476 } while (0)
 477
 478 #define XWINT(RTX, N)   (RTL_CHECK1 (RTX, N, 'w').rtwint)
 479 #define XINT(RTX, N)    (RTL_CHECK2 (RTX, N, 'i', 'n').rtint)
 480 #define XSTR(RTX, N)    (RTL_CHECK2 (RTX, N, 's', 'S').rtstr)
 481 #define XEXP(RTX, N)    (RTL_CHECK2 (RTX, N, 'e', 'u').rtx)
 482 #define XVEC(RTX, N)    (RTL_CHECK2 (RTX, N, 'E', 'V').rtvec)
 483 #define XMODE(RTX, N)   (RTL_CHECK1 (RTX, N, 'M').rttype)
 484 #define XBITMAP(RTX, N) (RTL_CHECK1 (RTX, N, 'b').rtbit)
 485 #define XTREE(RTX, N)   (RTL_CHECK1 (RTX, N, 't').rttree)
 486 #define XBBDEF(RTX, N)  (RTL_CHECK1 (RTX, N, 'B').bb)
 487 #define XTMPL(RTX, N)   (RTL_CHECK1 (RTX, N, 'T').rtstr)
 488
 489 #define XVECEXP(RTX, N, M)      RTVEC_ELT (XVEC (RTX, N), M)
 490 #define XVECLEN(RTX, N)         GET_NUM_ELEM (XVEC (RTX, N))
 491
 492 /* These are like XWINT, etc. except that they expect a '0' field instead
 493    of the normal type code.  */
 494
 495 #define X0WINT(RTX, N)     (RTL_CHECK1 (RTX, N, '0').rtwint)
 496 #define X0INT(RTX, N)      (RTL_CHECK1 (RTX, N, '0').rtint)
 497 #define X0UINT(RTX, N)     (RTL_CHECK1 (RTX, N, '0').rtuint)
 498 #define X0STR(RTX, N)      (RTL_CHECK1 (RTX, N, '0').rtstr)
 499 #define X0EXP(RTX, N)      (RTL_CHECK1 (RTX, N, '0').rtx)
 500 #define X0VEC(RTX, N)      (RTL_CHECK1 (RTX, N, '0').rtvec)
 501 #define X0MODE(RTX, N)     (RTL_CHECK1 (RTX, N, '0').rttype)
 502 #define X0BITMAP(RTX, N)   (RTL_CHECK1 (RTX, N, '0').rtbit)
 503 #define X0TREE(RTX, N)     (RTL_CHECK1 (RTX, N, '0').rttree)
 504 #define X0BBDEF(RTX, N)    (RTL_CHECK1 (RTX, N, '0').bb)
 505 #define X0ADVFLAGS(RTX, N) (RTL_CHECK1 (RTX, N, '0').rt_addr_diff_vec_flags)
 506 #define X0CSELIB(RTX, N)   (RTL_CHECK1 (RTX, N, '0').rt_cselib)
 507 #define X0MEMATTR(RTX, N)  (RTL_CHECKC1 (RTX, N, MEM).rtmem)
 508 #define X0REGATTR(RTX, N)  (RTL_CHECKC1 (RTX, N, REG).rtreg)
 509
 510 #define XCWINT(RTX, N, C)     (RTL_CHECKC1 (RTX, N, C).rtwint)
 511 #define XCINT(RTX, N, C)      (RTL_CHECKC1 (RTX, N, C).rtint)
 512 #define XCUINT(RTX, N, C)     (RTL_CHECKC1 (RTX, N, C).rtuint)
 513 #define XCSTR(RTX, N, C)      (RTL_CHECKC1 (RTX, N, C).rtstr)
 514 #define XCEXP(RTX, N, C)      (RTL_CHECKC1 (RTX, N, C).rtx)
 515 #define XCVEC(RTX, N, C)      (RTL_CHECKC1 (RTX, N, C).rtvec)
 516 #define XCMODE(RTX, N, C)     (RTL_CHECKC1 (RTX, N, C).rttype)
 517 #define XCBITMAP(RTX, N, C)   (RTL_CHECKC1 (RTX, N, C).rtbit)
 518 #define XCTREE(RTX, N, C)     (RTL_CHECKC1 (RTX, N, C).rttree)
 519 #define XCBBDEF(RTX, N, C)    (RTL_CHECKC1 (RTX, N, C).bb)
 520 #define XCADVFLAGS(RTX, N, C) (RTL_CHECKC1 (RTX, N, C).rt_addr_diff_vec_flags)
 521 #define XCCSELIB(RTX, N, C)   (RTL_CHECKC1 (RTX, N, C).rt_cselib)
 522
 523 #define XCVECEXP(RTX, N, M, C)  RTVEC_ELT (XCVEC (RTX, N, C), M)
 524 #define XCVECLEN(RTX, N, C)     GET_NUM_ELEM (XCVEC (RTX, N, C))
 525
 526 #define XC2EXP(RTX, N, C1, C2)      (RTL_CHECKC2 (RTX, N, C1, C2).rtx)
 527 \f
 528 /* ACCESS MACROS for particular fields of insns.  */
 529
 530 /* Determines whether X is an insn.  */
 531 #define INSN_P(X)       (GET_RTX_CLASS (GET_CODE(X)) == 'i')
 532
 533 /* Holds a unique number for each insn.
 534    These are not necessarily sequentially increasing.  */
 535 #define INSN_UID(INSN)  XINT (INSN, 0)
 536
 537 /* Chain insns together in sequence.  */
 538 #define PREV_INSN(INSN) XEXP (INSN, 1)
 539 #define NEXT_INSN(INSN) XEXP (INSN, 2)
 540
 541 #define BLOCK_FOR_INSN(INSN) XBBDEF (INSN, 3)
 542 #define INSN_LOCATOR(INSN) XINT (INSN, 4)
 543 /* The body of an insn.  */
 544 #define PATTERN(INSN)   XEXP (INSN, 5)
 545
 546 /* Code number of instruction, from when it was recognized.
 547    -1 means this instruction has not been recognized yet.  */
 548 #define INSN_CODE(INSN) XINT (INSN, 6)
 549
 550 /* Set up in flow.c; empty before then.
 551    Holds a chain of INSN_LIST rtx's whose first operands point at
 552    previous insns with direct data-flow connections to this one.
 553    That means that those insns set variables whose next use is in this insn.
 554    They are always in the same basic block as this insn.  */
 555 #define LOG_LINKS(INSN) XEXP(INSN, 7)
 556
 557 #define RTX_INTEGRATED_P(RTX)                                           \
 558   (RTL_FLAG_CHECK8("RTX_INTEGRATED_P", (RTX), INSN, CALL_INSN,          \
 559                    JUMP_INSN, INSN_LIST, BARRIER, CODE_LABEL, CONST,    \
 560                    NOTE)->integrated)
 561 #define RTX_UNCHANGING_P(RTX)                                           \
 562   (RTL_FLAG_CHECK3("RTX_UNCHANGING_P", (RTX), REG, MEM, CONCAT)->unchanging)
 563 #define RTX_FRAME_RELATED_P(RTX)                                        \
 564   (RTL_FLAG_CHECK5("RTX_FRAME_RELATED_P", (RTX), INSN, CALL_INSN,       \
 565                    JUMP_INSN, BARRIER, SET)->frame_related)
 566
 567 /* 1 if RTX is an insn that has been deleted.  */
 568 #define INSN_DELETED_P(RTX)                                             \
 569   (RTL_FLAG_CHECK6("INSN_DELETED_P", (RTX), INSN, CALL_INSN, JUMP_INSN, \
 570                    CODE_LABEL, BARRIER, NOTE)->volatil)
 571
 572 /* 1 if RTX is a call to a const or pure function.  */
 573 #define CONST_OR_PURE_CALL_P(RTX)                                       \
 574   (RTL_FLAG_CHECK3("CONST_OR_PURE_CALL_P", (RTX), CALL_INSN, NOTE,      \
 575                    EXPR_LIST)->unchanging)
 576
 577 /* 1 if RTX is a call_insn for a sibling call.  */
 578 #define SIBLING_CALL_P(RTX)                                             \
 579   (RTL_FLAG_CHECK1("SIBLING_CALL_P", (RTX), CALL_INSN)->jump)
 580
 581 /* 1 if RTX is a jump_insn, call_insn, or insn that is an annulling branch.  */
 582 #define INSN_ANNULLED_BRANCH_P(RTX)                                     \
 583   (RTL_FLAG_CHECK3("INSN_ANNULLED_BRANCH_P", (RTX), JUMP_INSN, CALL_INSN, INSN)->unchanging)
 584
 585 /* 1 if RTX is an insn that is dead code.  Valid only for dead-code
 586    elimination phase.  */
 587 #define INSN_DEAD_CODE_P(RTX)                                           \
 588   (RTL_FLAG_CHECK3("INSN_DEAD_CODE_P", (RTX), INSN, CALL_INSN, JUMP_INSN)->in_struct)
 589
 590 /* 1 if RTX is an insn in a delay slot and is from the target of the branch.
 591    If the branch insn has INSN_ANNULLED_BRANCH_P set, this insn should only be
 592    executed if the branch is taken.  For annulled branches with this bit
 593    clear, the insn should be executed only if the branch is not taken.  */
 594 #define INSN_FROM_TARGET_P(RTX)                                         \
 595   (RTL_FLAG_CHECK3("INSN_FROM_TARGET_P", (RTX), INSN, JUMP_INSN, CALL_INSN)->in_struct)
 596
 597 #define ADDR_DIFF_VEC_FLAGS(RTX) X0ADVFLAGS(RTX, 4)
 598
 599 #define CSELIB_VAL_PTR(RTX) X0CSELIB(RTX, 0)
 600
 601 /* Holds a list of notes on what this insn does to various REGs.
 602    It is a chain of EXPR_LIST rtx's, where the second operand is the
 603    chain pointer and the first operand is the REG being described.
 604    The mode field of the EXPR_LIST contains not a real machine mode
 605    but a value from enum reg_note.  */
 606
 607 #define REG_NOTES(INSN) XEXP(INSN, 8)
 608
 609 /* Don't forget to change reg_note_name in rtl.c.  */
 610 enum reg_note
 611 {
 612   /* The value in REG dies in this insn (i.e., it is not needed past
 613      this insn).  If REG is set in this insn, the REG_DEAD note may,
 614      but need not, be omitted.  */
 615   REG_DEAD = 1,
 616
 617   /* The REG is autoincremented or autodecremented.  */
 618   REG_INC,
 619
 620   /* Describes the insn as a whole; it says that the insn sets a register
 621      to a constant value or to be equivalent to a memory address.  If the
 622      register is spilled to the stack then the constant value should be
 623      substituted for it.  The contents of the REG_EQUIV is the constant
 624      value or memory address, which may be different from the source of
 625      the SET although it has the same value.  A REG_EQUIV note may also
 626      appear on an insn which copies a register parameter to a pseudo-register,
 627      if there is a memory address which could be used to hold that
 628      pseudo-register throughout the function.  */
 629   REG_EQUIV,
 630
 631   /* Like REG_EQUIV except that the destination is only momentarily equal
 632      to the specified rtx.  Therefore, it cannot be used for substitution;
 633      but it can be used for cse.  */
 634   REG_EQUAL,
 635
 636   /* This insn copies the return-value of a library call out of the hard reg
 637      for return values.  This note is actually an INSN_LIST and it points to
 638      the first insn involved in setting up arguments for the call.  flow.c
 639      uses this to delete the entire library call when its result is dead.  */
 640   REG_RETVAL,
 641
 642   /* The inverse of REG_RETVAL: it goes on the first insn of the library call
 643      and points at the one that has the REG_RETVAL.  This note is also an
 644      INSN_LIST.  */
 645   REG_LIBCALL,
 646
 647   /* The register is always nonnegative during the containing loop.  This is
 648      used in branches so that decrement and branch instructions terminating
 649      on zero can be matched.  There must be an insn pattern in the md file
 650      named `decrement_and_branch_until_zero' or else this will never be added
 651      to any instructions.  */
 652   REG_NONNEG,
 653
 654   /* There is no conflict *after this insn* between the register in the note
 655      and the destination of this insn.  */
 656   REG_NO_CONFLICT,
 657
 658   /* Identifies a register set in this insn and never used.  */
 659   REG_UNUSED,
 660
 661   /* REG_CC_SETTER and REG_CC_USER link a pair of insns that set and use CC0,
 662      respectively.  Normally, these are required to be consecutive insns, but
 663      we permit putting a cc0-setting insn in the delay slot of a branch as
 664      long as only one copy of the insn exists.  In that case, these notes
 665      point from one to the other to allow code generation to determine what
 666      any require information and to properly update CC_STATUS.  These notes
 667      are INSN_LISTs.  */
 668   REG_CC_SETTER, REG_CC_USER,
 669
 670   /* Points to a CODE_LABEL.  Used by non-JUMP_INSNs to say that the
 671      CODE_LABEL contained in the REG_LABEL note is used by the insn.
 672      This note is an INSN_LIST.  */
 673   REG_LABEL,
 674
 675   /* REG_DEP_ANTI and REG_DEP_OUTPUT are used in LOG_LINKS to represent
 676      write-after-read and write-after-write dependencies respectively.
 677      Data dependencies, which are the only type of LOG_LINK created by
 678      flow, are represented by a 0 reg note kind.  */
 679   REG_DEP_ANTI, REG_DEP_OUTPUT,
 680
 681   /* REG_BR_PROB is attached to JUMP_INSNs and CALL_INSNs.
 682      It has an integer value.  For jumps, it is the probability that this is a
 683      taken branch.  For calls, it is the probability that this call won't
 684      return.  */
 685   REG_BR_PROB,
 686
 687   /* REG_VALUE_PROFILE is attached when the profile is read in to an insn
 688      before that the code to profile the value is inserted.  It contains
 689      the results of profiling.  */
 690   REG_VALUE_PROFILE,
 691
 692   /* Attached to a call insn; indicates that the call is malloc-like and
 693      that the pointer returned cannot alias anything else.  */
 694   REG_NOALIAS,
 695
 696   /* Used to optimize rtl generated by dynamic stack allocations for targets
 697      where SETJMP_VIA_SAVE_AREA is true.  */
 698   REG_SAVE_AREA,
 699
 700   /* REG_BR_PRED is attached to JUMP_INSNs and CALL_INSNSs.  It contains
 701      CONCAT of two integer value.  First specifies the branch predictor
 702      that added the note, second specifies the predicted hitrate of branch
 703      in the same format as REG_BR_PROB note uses.  */
 704   REG_BR_PRED,
 705
 706   /* Attached to insns that are RTX_FRAME_RELATED_P, but are too complex
 707      for DWARF to interpret what they imply.  The attached rtx is used
 708      instead of intuition.  */
 709   REG_FRAME_RELATED_EXPR,
 710
 711   /* Indicates that REG holds the exception context for the function.
 712      This context is shared by inline functions, so the code to acquire
 713      the real exception context is delayed until after inlining.  */
 714   REG_EH_CONTEXT,
 715
 716   /* Indicates what exception region an INSN belongs in.  This is used to
 717      indicate what region to which a call may throw.  REGION 0 indicates
 718      that a call cannot throw at all.  REGION -1 indicates that it cannot
 719      throw, nor will it execute a non-local goto.  */
 720   REG_EH_REGION,
 721
 722   /* Used by haifa-sched to save NOTE_INSN notes across scheduling.  */
 723   REG_SAVE_NOTE,
 724
 725   /* Indicates that this insn (which is part of the prologue) computes
 726      a value which might not be used later, and if so it's OK to delete
 727      the insn.  Normally, deleting any insn in the prologue is an error.
 728      At present the parameter is unused and set to (const_int 0).  */
 729   REG_MAYBE_DEAD,
 730
 731   /* Indicates that a call does not return.  */
 732   REG_NORETURN,
 733
 734   /* Indicates that an indirect jump is a non-local goto instead of a
 735      computed goto.  */
 736   REG_NON_LOCAL_GOTO,
 737
 738   /* This kind of note is generated at each to `setjmp',
 739      and similar functions that can return twice.  */
 740   REG_SETJMP,
 741
 742   /* Indicate calls that always returns.  */
 743   REG_ALWAYS_RETURN,
 744
 745   /* Indicate that the memory load references a vtable.  The expression
 746      is of the form (plus (symbol_ref vtable_sym) (const_int offset)).  */
 747   REG_VTABLE_REF
 748 };
 749
 750 /* The base value for branch probability notes.  */
 751 #define REG_BR_PROB_BASE  10000
 752
 753 /* Define macros to extract and insert the reg-note kind in an EXPR_LIST.  */
 754 #define REG_NOTE_KIND(LINK) ((enum reg_note) GET_MODE (LINK))
 755 #define PUT_REG_NOTE_KIND(LINK, KIND) \
 756   PUT_MODE (LINK, (enum machine_mode) (KIND))
 757
 758 /* Names for REG_NOTE's in EXPR_LIST insn's.  */
 759
 760 extern const char * const reg_note_name[];
 761 #define GET_REG_NOTE_NAME(MODE) (reg_note_name[(int) (MODE)])
 762
 763 /* This field is only present on CALL_INSNs.  It holds a chain of EXPR_LIST of
 764    USE and CLOBBER expressions.
 765      USE expressions list the registers filled with arguments that
 766    are passed to the function.
 767      CLOBBER expressions document the registers explicitly clobbered
 768    by this CALL_INSN.
 769      Pseudo registers can not be mentioned in this list.  */
 770 #define CALL_INSN_FUNCTION_USAGE(INSN)  XEXP(INSN, 9)
 771
 772 /* The label-number of a code-label.  The assembler label
 773    is made from `L' and the label-number printed in decimal.
 774    Label numbers are unique in a compilation.  */
 775 #define CODE_LABEL_NUMBER(INSN) XINT (INSN, 6)
 776
 777 #define LINE_NUMBER NOTE
 778
 779 /* In a NOTE that is a line number, this is a string for the file name that the
 780    line is in.  We use the same field to record block numbers temporarily in
 781    NOTE_INSN_BLOCK_BEG and NOTE_INSN_BLOCK_END notes.  (We avoid lots of casts
 782    between ints and pointers if we use a different macro for the block number.)
 783    */
 784
 785 /* Opaque data.  */
 786 #define NOTE_DATA(INSN)         RTL_CHECKC1 (INSN, 4, NOTE)
 787 #define NOTE_SOURCE_FILE(INSN)  XCSTR (INSN, 4, NOTE)
 788 #define NOTE_BLOCK(INSN)        XCTREE (INSN, 4, NOTE)
 789 #define NOTE_EH_HANDLER(INSN)   XCINT (INSN, 4, NOTE)
 790 #define NOTE_BASIC_BLOCK(INSN)  XCBBDEF (INSN, 4, NOTE)
 791 #define NOTE_EXPECTED_VALUE(INSN) XCEXP (INSN, 4, NOTE)
 792 #define NOTE_PREDICTION(INSN)   XCINT (INSN, 4, NOTE)
 793 #define NOTE_PRECONDITIONED(INSN)   XCINT (INSN, 4, NOTE)
 794
 795 /* In a NOTE that is a line number, this is the line number.
 796    Other kinds of NOTEs are identified by negative numbers here.  */
 797 #define NOTE_LINE_NUMBER(INSN) XCINT (INSN, 5, NOTE)
 798
 799 /* Nonzero if INSN is a note marking the beginning of a basic block.  */
 800 #define NOTE_INSN_BASIC_BLOCK_P(INSN)                   \
 801   (GET_CODE (INSN) == NOTE                              \
 802    && NOTE_LINE_NUMBER (INSN) == NOTE_INSN_BASIC_BLOCK)
 803
 804 /* Algorithm and flags for prediction.  */
 805 #define NOTE_PREDICTION_ALG(INSN)   (XCINT(INSN, 4, NOTE)>>8)
 806 #define NOTE_PREDICTION_FLAGS(INSN) (XCINT(INSN, 4, NOTE)&0xff)
 807 #define NOTE_PREDICT(ALG,FLAGS)     ((ALG<<8)+(FLAGS))
 808
 809 /* Codes that appear in the NOTE_LINE_NUMBER field
 810    for kinds of notes that are not line numbers.
 811
 812    Notice that we do not try to use zero here for any of
 813    the special note codes because sometimes the source line
 814    actually can be zero!  This happens (for example) when we
 815    are generating code for the per-translation-unit constructor
 816    and destructor routines for some C++ translation unit.
 817
 818    If you should change any of the following values, or if you
 819    should add a new value here, don't forget to change the
 820    note_insn_name array in rtl.c.  */
 821
 822 enum insn_note
 823 {
 824   /* Keep all of these numbers negative.  Adjust as needed.  */
 825   NOTE_INSN_BIAS = -100,
 826
 827   /* This note is used to get rid of an insn
 828      when it isn't safe to patch the insn out of the chain.  */
 829   NOTE_INSN_DELETED,
 830
 831   /* These are used to mark the beginning and end of a lexical block.
 832      See NOTE_BLOCK, identify_blocks and reorder_blocks.  */
 833   NOTE_INSN_BLOCK_BEG,
 834   NOTE_INSN_BLOCK_END,
 835
 836   /* These mark the extremes of a loop.  */
 837   NOTE_INSN_LOOP_BEG,
 838   NOTE_INSN_LOOP_END,
 839
 840   /* Generated at the place in a loop that `continue' jumps to.  */
 841   NOTE_INSN_LOOP_CONT,
 842   /* Generated at the start of a duplicated exit test.  */
 843   NOTE_INSN_LOOP_VTOP,
 844
 845   /* Generated at the end of a conditional at the top of the loop.
 846      This is used to perform a lame form of loop rotation in lieu
 847      of actually understanding the loop structure.  The note is
 848      discarded after rotation is complete.  */
 849   NOTE_INSN_LOOP_END_TOP_COND,
 850
 851   /* This kind of note is generated at the end of the function body,
 852      just before the return insn or return label.  In an optimizing
 853      compilation it is deleted by the first jump optimization, after
 854      enabling that optimizer to determine whether control can fall
 855      off the end of the function body without a return statement.  */
 856   NOTE_INSN_FUNCTION_END,
 857
 858   /* This marks the point immediately after the last prologue insn.  */
 859   NOTE_INSN_PROLOGUE_END,
 860
 861   /* This marks the point immediately prior to the first epilogue insn.  */
 862   NOTE_INSN_EPILOGUE_BEG,
 863
 864   /* Generated in place of user-declared labels when they are deleted.  */
 865   NOTE_INSN_DELETED_LABEL,
 866
 867   /* This note indicates the start of the real body of the function,
 868      i.e. the point just after all of the parms have been moved into
 869      their homes, etc.  */
 870   NOTE_INSN_FUNCTION_BEG,
 871
 872   /* These note where exception handling regions begin and end.
 873      Uses NOTE_EH_HANDLER to identify the region in question.  */
 874   NOTE_INSN_EH_REGION_BEG,
 875   NOTE_INSN_EH_REGION_END,
 876
 877   /* Generated whenever a duplicate line number note is output.  For example,
 878      one is output after the end of an inline function, in order to prevent
 879      the line containing the inline call from being counted twice in gcov.  */
 880   NOTE_INSN_REPEATED_LINE_NUMBER,
 881
 882   /* Record the struct for the following basic block.  Uses NOTE_BASIC_BLOCK.  */
 883   NOTE_INSN_BASIC_BLOCK,
 884
 885   /* Record the expected value of a register at a location.  Uses
 886      NOTE_EXPECTED_VALUE; stored as (eq (reg) (const_int)).  */
 887   NOTE_INSN_EXPECTED_VALUE,
 888
 889   /* Record a prediction.  Uses NOTE_PREDICTION.  */
 890   NOTE_INSN_PREDICTION,
 891
 892   NOTE_INSN_MAX
 893 };
 894
 895 /* Names for NOTE insn's other than line numbers.  */
 896
 897 extern const char * const note_insn_name[NOTE_INSN_MAX - NOTE_INSN_BIAS];
 898 #define GET_NOTE_INSN_NAME(NOTE_CODE) \
 899   (note_insn_name[(NOTE_CODE) - (int) NOTE_INSN_BIAS])
 900
 901 /* The name of a label, in case it corresponds to an explicit label
 902    in the input source code.  */
 903 #define LABEL_NAME(RTX) XCSTR (RTX, 7, CODE_LABEL)
 904
 905 /* In jump.c, each label contains a count of the number
 906    of LABEL_REFs that point at it, so unused labels can be deleted.  */
 907 #define LABEL_NUSES(RTX) XCINT (RTX, 4, CODE_LABEL)
 908
 909 /* Labels carry a two-bit field composed of the ->jump and ->call
 910    bits.  This field indicates whether the label is an alternate
 911    entry point, and if so, what kind.  */
 912 enum label_kind
 913 {
 914   LABEL_NORMAL = 0,     /* ordinary label */
 915   LABEL_STATIC_ENTRY,   /* alternate entry point, not exported */
 916   LABEL_GLOBAL_ENTRY,   /* alternate entry point, exported */
 917   LABEL_WEAK_ENTRY      /* alternate entry point, exported as weak symbol */
 918 };
 919
 920 #if defined ENABLE_RTL_FLAG_CHECKING && (GCC_VERSION > 2007)
 921
 922 /* Retrieve the kind of LABEL.  */
 923 #define LABEL_KIND(LABEL) __extension__                                 \
 924 ({ rtx const _label = (LABEL);                                          \
 925    if (GET_CODE (_label) != CODE_LABEL)                                 \
 926      rtl_check_failed_flag ("LABEL_KIND", _label, __FILE__, __LINE__,   \
 927                             __FUNCTION__);                              \
 928    (enum label_kind) ((_label->jump << 1) | _label->call); })
 929
 930 /* Set the kind of LABEL.  */
 931 #define SET_LABEL_KIND(LABEL, KIND) do {                                \
 932    rtx _label = (LABEL);                                                \
 933    unsigned int _kind = (KIND);                                         \
 934    if (GET_CODE (_label) != CODE_LABEL)                                 \
 935      rtl_check_failed_flag ("SET_LABEL_KIND", _label, __FILE__, __LINE__, \
 936                             __FUNCTION__);                              \
 937    _label->jump = ((_kind >> 1) & 1);                                   \
 938    _label->call = (_kind & 1);                                          \
 939 } while (0)
 940
 941 #else
 942
 943 /* Retrieve the kind of LABEL.  */
 944 #define LABEL_KIND(LABEL) \
 945    ((enum label_kind) (((LABEL)->jump << 1) | (LABEL)->call))
 946
 947 /* Set the kind of LABEL.  */
 948 #define SET_LABEL_KIND(LABEL, KIND) do {                                \
 949    rtx _label = (LABEL);                                                \
 950    unsigned int _kind = (KIND);                                         \
 951    _label->jump = ((_kind >> 1) & 1);                                   \
 952    _label->call = (_kind & 1);                                          \
 953 } while (0)
 954
 955 #endif /* rtl flag checking */
 956
 957 #define LABEL_ALT_ENTRY_P(LABEL) (LABEL_KIND (LABEL) != LABEL_NORMAL)
 958
 959 /* The original regno this ADDRESSOF was built for.  */
 960 #define ADDRESSOF_REGNO(RTX) XCUINT (RTX, 1, ADDRESSOF)
 961
 962 /* The variable in the register we took the address of.  */
 963 #define ADDRESSOF_DECL(RTX) XCTREE (RTX, 2, ADDRESSOF)
 964
 965 /* In jump.c, each JUMP_INSN can point to a label that it can jump to,
 966    so that if the JUMP_INSN is deleted, the label's LABEL_NUSES can
 967    be decremented and possibly the label can be deleted.  */
 968 #define JUMP_LABEL(INSN)   XCEXP (INSN, 9, JUMP_INSN)
 969
 970 /* Once basic blocks are found in flow.c,
 971    each CODE_LABEL starts a chain that goes through
 972    all the LABEL_REFs that jump to that label.
 973    The chain eventually winds up at the CODE_LABEL: it is circular.  */
 974 #define LABEL_REFS(LABEL) XCEXP (LABEL, 5, CODE_LABEL)
 975 \f
 976 /* This is the field in the LABEL_REF through which the circular chain
 977    of references to a particular label is linked.
 978    This chain is set up in flow.c.  */
 979
 980 #define LABEL_NEXTREF(REF) XCEXP (REF, 1, LABEL_REF)
 981
 982 /* Once basic blocks are found in flow.c,
 983    Each LABEL_REF points to its containing instruction with this field.  */
 984
 985 #define CONTAINING_INSN(RTX) XCEXP (RTX, 2, LABEL_REF)
 986
 987 /* For a REG rtx, REGNO extracts the register number.  ORIGINAL_REGNO holds
 988    the number the register originally had; for a pseudo register turned into
 989    a hard reg this will hold the old pseudo register number.  */
 990
 991 #define REGNO(RTX) XCUINT (RTX, 0, REG)
 992 #define ORIGINAL_REGNO(RTX) X0UINT (RTX, 1)
 993
 994 /* 1 if RTX is a reg or parallel that is the current function's return
 995    value.  */
 996 #define REG_FUNCTION_VALUE_P(RTX)                                       \
 997   (RTL_FLAG_CHECK2("REG_FUNCTION_VALUE_P", (RTX), REG, PARALLEL)->integrated)
 998
 999 /* 1 if RTX is a reg that corresponds to a variable declared by the user.  */
1000 #define REG_USERVAR_P(RTX)                                              \
1001   (RTL_FLAG_CHECK1("REG_USERVAR_P", (RTX), REG)->volatil)
1002
1003 /* 1 if RTX is a reg that holds a pointer value.  */
1004 #define REG_POINTER(RTX)                                                \
1005   (RTL_FLAG_CHECK1("REG_POINTER", (RTX), REG)->frame_related)
1006
1007 /* 1 if the given register REG corresponds to a hard register.  */
1008 #define HARD_REGISTER_P(REG) (HARD_REGISTER_NUM_P (REGNO (REG)))
1009
1010 /* 1 if the given register number REG_NO corresponds to a hard register.  */
1011 #define HARD_REGISTER_NUM_P(REG_NO) ((REG_NO) < FIRST_PSEUDO_REGISTER)
1012
1013 /* For a CONST_INT rtx, INTVAL extracts the integer.  */
1014
1015 #define INTVAL(RTX) XCWINT(RTX, 0, CONST_INT)
1016
1017 /* For a CONST_DOUBLE:
1018    For a DImode, there are two integers CONST_DOUBLE_LOW is the
1019      low-order word and ..._HIGH the high-order.
1020    For a float, there is a REAL_VALUE_TYPE structure, and
1021      CONST_DOUBLE_REAL_VALUE(r) is a pointer to it.  */
1022 #define CONST_DOUBLE_LOW(r) XCWINT (r, 0, CONST_DOUBLE)
1023 #define CONST_DOUBLE_HIGH(r) XCWINT (r, 1, CONST_DOUBLE)
1024 #define CONST_DOUBLE_REAL_VALUE(r) ((struct real_value *)&CONST_DOUBLE_LOW(r))
1025
1026 /* For a CONST_VECTOR, return element #n.  */
1027 #define CONST_VECTOR_ELT(RTX, N) XCVECEXP (RTX, 0, N, CONST_VECTOR)
1028
1029 /* For a CONST_VECTOR, return the number of elements in a vector.  */
1030 #define CONST_VECTOR_NUNITS(RTX) XCVECLEN (RTX, 0, CONST_VECTOR)
1031
1032 /* For a SUBREG rtx, SUBREG_REG extracts the value we want a subreg of.
1033    SUBREG_BYTE extracts the byte-number.  */
1034
1035 #define SUBREG_REG(RTX) XCEXP (RTX, 0, SUBREG)
1036 #define SUBREG_BYTE(RTX) XCUINT (RTX, 1, SUBREG)
1037
1038 /* in rtlanal.c */
1039 extern unsigned int subreg_lsb (rtx);
1040 extern unsigned int subreg_regno_offset (unsigned int, enum machine_mode,
1041                                          unsigned int, enum machine_mode);
1042 extern bool subreg_offset_representable_p (unsigned int, enum machine_mode,
1043                                            unsigned int, enum machine_mode);
1044 extern unsigned int subreg_regno (rtx);
1045
1046 /* 1 if RTX is a subreg containing a reg that is already known to be
1047    sign- or zero-extended from the mode of the subreg to the mode of
1048    the reg.  SUBREG_PROMOTED_UNSIGNED_P gives the signedness of the
1049    extension.
1050
1051    When used as a LHS, is means that this extension must be done
1052    when assigning to SUBREG_REG.  */
1053
1054 #define SUBREG_PROMOTED_VAR_P(RTX)                                      \
1055   (RTL_FLAG_CHECK1("SUBREG_PROMOTED", (RTX), SUBREG)->in_struct)
1056
1057 #define SUBREG_PROMOTED_UNSIGNED_SET(RTX, VAL)                          \
1058 do {                                                                    \
1059   rtx const _rtx = RTL_FLAG_CHECK1("SUBREG_PROMOTED_UNSIGNED_SET", (RTX), SUBREG); \
1060   if ((VAL) < 0)                                                        \
1061     _rtx->volatil = 1;                                                  \
1062   else {                                                                \
1063     _rtx->volatil = 0;                                                  \
1064     _rtx->unchanging = (VAL);                                           \
1065   }                                                                     \
1066 } while (0)
1067 #define SUBREG_PROMOTED_UNSIGNED_P(RTX) \
1068   ((RTL_FLAG_CHECK1("SUBREG_PROMOTED_UNSIGNED_P", (RTX), SUBREG)->volatil) \
1069      ? -1 : (RTX)->unchanging)
1070
1071 /* Access various components of an ASM_OPERANDS rtx.  */
1072
1073 #define ASM_OPERANDS_TEMPLATE(RTX) XCSTR (RTX, 0, ASM_OPERANDS)
1074 #define ASM_OPERANDS_OUTPUT_CONSTRAINT(RTX) XCSTR (RTX, 1, ASM_OPERANDS)
1075 #define ASM_OPERANDS_OUTPUT_IDX(RTX) XCINT (RTX, 2, ASM_OPERANDS)
1076 #define ASM_OPERANDS_INPUT_VEC(RTX) XCVEC (RTX, 3, ASM_OPERANDS)
1077 #define ASM_OPERANDS_INPUT_CONSTRAINT_VEC(RTX) XCVEC (RTX, 4, ASM_OPERANDS)
1078 #define ASM_OPERANDS_INPUT(RTX, N) XCVECEXP (RTX, 3, N, ASM_OPERANDS)
1079 #define ASM_OPERANDS_INPUT_LENGTH(RTX) XCVECLEN (RTX, 3, ASM_OPERANDS)
1080 #define ASM_OPERANDS_INPUT_CONSTRAINT_EXP(RTX, N) \
1081   XCVECEXP (RTX, 4, N, ASM_OPERANDS)
1082 #define ASM_OPERANDS_INPUT_CONSTRAINT(RTX, N) \
1083   XSTR (XCVECEXP (RTX, 4, N, ASM_OPERANDS), 0)
1084 #define ASM_OPERANDS_INPUT_MODE(RTX, N)  \
1085   GET_MODE (XCVECEXP (RTX, 4, N, ASM_OPERANDS))
1086 #define ASM_OPERANDS_SOURCE_FILE(RTX) XCSTR (RTX, 5, ASM_OPERANDS)
1087 #define ASM_OPERANDS_SOURCE_LINE(RTX) XCINT (RTX, 6, ASM_OPERANDS)
1088
1089 /* 1 if RTX is a mem and we should keep the alias set for this mem
1090    unchanged when we access a component.  Set to 1, or example, when we
1091    are already in a non-addressable component of an aggregate.  */
1092 #define MEM_KEEP_ALIAS_SET_P(RTX)                                       \
1093   (RTL_FLAG_CHECK1("MEM_KEEP_ALIAS_SET_P", (RTX), MEM)->jump)
1094
1095 /* 1 if RTX is a mem or asm_operand for a volatile reference.  */
1096 #define MEM_VOLATILE_P(RTX)                                             \
1097   (RTL_FLAG_CHECK3("MEM_VOLATILE_P", (RTX), MEM, ASM_OPERANDS,          \
1098                    ASM_INPUT)->volatil)
1099
1100 /* 1 if RTX is a mem that refers to an aggregate, either to the
1101    aggregate itself of to a field of the aggregate.  If zero, RTX may
1102    or may not be such a reference.  */
1103 #define MEM_IN_STRUCT_P(RTX)                                            \
1104   (RTL_FLAG_CHECK1("MEM_IN_STRUCT_P", (RTX), MEM)->in_struct)
1105
1106 /* 1 if RTX is a mem that refers to a scalar.  If zero, RTX may or may
1107    not refer to a scalar.  */
1108 #define MEM_SCALAR_P(RTX)                                               \
1109   (RTL_FLAG_CHECK1("MEM_SCALAR_P", (RTX), MEM)->frame_related)
1110
1111 /* 1 if RTX is a mem that cannot trap.  */
1112 #define MEM_NOTRAP_P(RTX) \
1113   (RTL_FLAG_CHECK1("MEM_NOTRAP_P", (RTX), MEM)->call)
1114
1115 /* If VAL is nonzero, set MEM_IN_STRUCT_P and clear MEM_SCALAR_P in
1116    RTX.  Otherwise, vice versa.  Use this macro only when you are
1117    *sure* that you know that the MEM is in a structure, or is a
1118    scalar.  VAL is evaluated only once.  */
1119 #define MEM_SET_IN_STRUCT_P(RTX, VAL)           \
1120 do {                                            \
1121   if (VAL)                                      \
1122     {                                           \
1123       MEM_IN_STRUCT_P (RTX) = 1;                \
1124       MEM_SCALAR_P (RTX) = 0;                   \
1125     }                                           \
1126   else                                          \
1127     {                                           \
1128       MEM_IN_STRUCT_P (RTX) = 0;                \
1129       MEM_SCALAR_P (RTX) = 1;                   \
1130     }                                           \
1131 } while (0)
1132
1133 /* The memory attribute block.  We provide access macros for each value
1134    in the block and provide defaults if none specified.  */
1135 #define MEM_ATTRS(RTX) X0MEMATTR (RTX, 1)
1136
1137 /* The register attribute block.  We provide access macros for each value
1138    in the block and provide defaults if none specified.  */
1139 #define REG_ATTRS(RTX) X0REGATTR (RTX, 2)
1140
1141 /* For a MEM rtx, the alias set.  If 0, this MEM is not in any alias
1142    set, and may alias anything.  Otherwise, the MEM can only alias
1143    MEMs in a conflicting alias set.  This value is set in a
1144    language-dependent manner in the front-end, and should not be
1145    altered in the back-end.  These set numbers are tested with
1146    alias_sets_conflict_p.  */
1147 #define MEM_ALIAS_SET(RTX) (MEM_ATTRS (RTX) == 0 ? 0 : MEM_ATTRS (RTX)->alias)
1148
1149 /* For a MEM rtx, the decl it is known to refer to, if it is known to
1150    refer to part of a DECL.  It may also be a COMPONENT_REF.  */
1151 #define MEM_EXPR(RTX) (MEM_ATTRS (RTX) == 0 ? 0 : MEM_ATTRS (RTX)->expr)
1152
1153 /* For a MEM rtx, the offset from the start of MEM_EXPR, if known, as a
1154    RTX that is always a CONST_INT.  */
1155 #define MEM_OFFSET(RTX) (MEM_ATTRS (RTX) == 0 ? 0 : MEM_ATTRS (RTX)->offset)
1156
1157 /* For a MEM rtx, the size in bytes of the MEM, if known, as an RTX that
1158    is always a CONST_INT.  */
1159 #define MEM_SIZE(RTX)                                                   \
1160 (MEM_ATTRS (RTX) != 0 ? MEM_ATTRS (RTX)->size                           \
1161  : GET_MODE (RTX) != BLKmode ? GEN_INT (GET_MODE_SIZE (GET_MODE (RTX))) \
1162  : 0)
1163
1164 /* For a MEM rtx, the alignment in bits.  We can use the alignment of the
1165    mode as a default when STRICT_ALIGNMENT, but not if not.  */
1166 #define MEM_ALIGN(RTX)                                                  \
1167 (MEM_ATTRS (RTX) != 0 ? MEM_ATTRS (RTX)->align                          \
1168  : (STRICT_ALIGNMENT && GET_MODE (RTX) != BLKmode                       \
1169     ? GET_MODE_ALIGNMENT (GET_MODE (RTX)) : BITS_PER_UNIT))
1170
1171 /* For a REG rtx, the decl it is known to refer to, if it is known to
1172    refer to part of a DECL.  */
1173 #define REG_EXPR(RTX) (REG_ATTRS (RTX) == 0 ? 0 : REG_ATTRS (RTX)->decl)
1174
1175 /* For a MEM rtx, the offset from the start of MEM_DECL, if known, as a
1176    RTX that is always a CONST_INT.  */
1177 #define REG_OFFSET(RTX) (REG_ATTRS (RTX) == 0 ? 0 : REG_ATTRS (RTX)->offset)
1178
1179 /* Copy the attributes that apply to memory locations from RHS to LHS.  */
1180 #define MEM_COPY_ATTRIBUTES(LHS, RHS)                           \
1181   (MEM_VOLATILE_P (LHS) = MEM_VOLATILE_P (RHS),                 \
1182    MEM_IN_STRUCT_P (LHS) = MEM_IN_STRUCT_P (RHS),               \
1183    MEM_SCALAR_P (LHS) = MEM_SCALAR_P (RHS),                     \
1184    MEM_NOTRAP_P (LHS) = MEM_NOTRAP_P (RHS),                     \
1185    RTX_UNCHANGING_P (LHS) = RTX_UNCHANGING_P (RHS),             \
1186    MEM_KEEP_ALIAS_SET_P (LHS) = MEM_KEEP_ALIAS_SET_P (RHS),     \
1187    MEM_ATTRS (LHS) = MEM_ATTRS (RHS))
1188
1189 /* 1 if RTX is a label_ref to a label outside the loop containing the
1190    reference.  */
1191 #define LABEL_OUTSIDE_LOOP_P(RTX)                                       \
1192   (RTL_FLAG_CHECK1("LABEL_OUTSIDE_LOOP_P", (RTX), LABEL_REF)->in_struct)
1193
1194 /* 1 if RTX is a label_ref for a nonlocal label.  */
1195 /* Likewise in an expr_list for a reg_label note.  */
1196 #define LABEL_REF_NONLOCAL_P(RTX)                                       \
1197   (RTL_FLAG_CHECK2("LABEL_REF_NONLOCAL_P", (RTX), LABEL_REF,            \
1198                    REG_LABEL)->volatil)
1199
1200 /* 1 if RTX is a code_label that should always be considered to be needed.  */
1201 #define LABEL_PRESERVE_P(RTX)                                           \
1202   (RTL_FLAG_CHECK2("LABEL_PRESERVE_P", (RTX), CODE_LABEL, NOTE)->in_struct)
1203
1204 /* 1 if RTX is a reg that is used only in an exit test of a loop.  */
1205 #define REG_LOOP_TEST_P(RTX)                                            \
1206   (RTL_FLAG_CHECK1("REG_LOOP_TEST_P", (RTX), REG)->in_struct)
1207
1208 /* During sched, 1 if RTX is an insn that must be scheduled together
1209    with the preceding insn.  */
1210 #define SCHED_GROUP_P(RTX)                                              \
1211   (RTL_FLAG_CHECK3("SCHED_GROUP_P", (RTX), INSN, JUMP_INSN, CALL_INSN   \
1212                           )->in_struct)
1213
1214 /* For a SET rtx, SET_DEST is the place that is set
1215    and SET_SRC is the value it is set to.  */
1216 #define SET_DEST(RTX) XC2EXP(RTX, 0, SET, CLOBBER)
1217 #define SET_SRC(RTX) XCEXP(RTX, 1, SET)
1218 #define SET_IS_RETURN_P(RTX)                                            \
1219   (RTL_FLAG_CHECK1("SET_IS_RETURN_P", (RTX), SET)->jump)
1220
1221 /* For a TRAP_IF rtx, TRAP_CONDITION is an expression.  */
1222 #define TRAP_CONDITION(RTX) XCEXP (RTX, 0, TRAP_IF)
1223 #define TRAP_CODE(RTX) XCEXP (RTX, 1, TRAP_IF)
1224
1225 /* For a COND_EXEC rtx, COND_EXEC_TEST is the condition to base
1226    conditionally executing the code on, COND_EXEC_CODE is the code
1227    to execute if the condition is true.  */
1228 #define COND_EXEC_TEST(RTX) XCEXP (RTX, 0, COND_EXEC)
1229 #define COND_EXEC_CODE(RTX) XCEXP (RTX, 1, COND_EXEC)
1230
1231 /* 1 if RTX is a symbol_ref that addresses this function's rtl
1232    constants pool.  */
1233 #define CONSTANT_POOL_ADDRESS_P(RTX)                                    \
1234   (RTL_FLAG_CHECK1("CONSTANT_POOL_ADDRESS_P", (RTX), SYMBOL_REF)->unchanging)
1235
1236 /* 1 if RTX is a symbol_ref that addresses a value in the file's
1237    tree constant pool.  This information is private to varasm.c.  */
1238 #define TREE_CONSTANT_POOL_ADDRESS_P(RTX)                               \
1239   (RTL_FLAG_CHECK1("TREE_CONSTANT_POOL_ADDRESS_P",                      \
1240                    (RTX), SYMBOL_REF)->frame_related)
1241
1242 /* Used if RTX is a symbol_ref, for machine-specific purposes.  */
1243 #define SYMBOL_REF_FLAG(RTX)                                            \
1244   (RTL_FLAG_CHECK1("SYMBOL_REF_FLAG", (RTX), SYMBOL_REF)->volatil)
1245
1246 /* 1 if RTX is a symbol_ref that has been the library function in
1247    emit_library_call.  */
1248 #define SYMBOL_REF_USED(RTX)                                            \
1249   (RTL_FLAG_CHECK1("SYMBOL_REF_USED", (RTX), SYMBOL_REF)->used)
1250
1251 /* 1 if RTX is a symbol_ref for a weak symbol.  */
1252 #define SYMBOL_REF_WEAK(RTX)                                            \
1253   (RTL_FLAG_CHECK1("SYMBOL_REF_WEAK", (RTX), SYMBOL_REF)->integrated)
1254
1255 /* The tree (decl or constant) associated with the symbol, or null.  */
1256 #define SYMBOL_REF_DECL(RTX)    X0TREE ((RTX), 2)
1257
1258 /* A set of flags on a symbol_ref that are, in some respects, redundant with
1259    information derivable from the tree decl associated with this symbol.
1260    Except that we build a *lot* of SYMBOL_REFs that aren't associated with a
1261    decl.  In some cases this is a bug.  But beyond that, it's nice to cache
1262    this information to avoid recomputing it.  Finally, this allows space for
1263    the target to store more than one bit of information, as with
1264    SYMBOL_REF_FLAG.  */
1265 #define SYMBOL_REF_FLAGS(RTX)   X0INT ((RTX), 1)
1266
1267 /* These flags are common enough to be defined for all targets.  They
1268    are computed by the default version of targetm.encode_section_info.  */
1269
1270 /* Set if this symbol is a function.  */
1271 #define SYMBOL_FLAG_FUNCTION    (1 << 0)
1272 #define SYMBOL_REF_FUNCTION_P(RTX) \
1273   ((SYMBOL_REF_FLAGS (RTX) & SYMBOL_FLAG_FUNCTION) != 0)
1274 /* Set if targetm.binds_local_p is true.  */
1275 #define SYMBOL_FLAG_LOCAL       (1 << 1)
1276 #define SYMBOL_REF_LOCAL_P(RTX) \
1277   ((SYMBOL_REF_FLAGS (RTX) & SYMBOL_FLAG_LOCAL) != 0)
1278 /* Set if targetm.in_small_data_p is true.  */
1279 #define SYMBOL_FLAG_SMALL       (1 << 2)
1280 #define SYMBOL_REF_SMALL_P(RTX) \
1281   ((SYMBOL_REF_FLAGS (RTX) & SYMBOL_FLAG_SMALL) != 0)
1282 /* The three-bit field at [5:3] is true for TLS variables; use
1283    SYMBOL_REF_TLS_MODEL to extract the field as an enum tls_model.  */
1284 #define SYMBOL_FLAG_TLS_SHIFT   3
1285 #define SYMBOL_REF_TLS_MODEL(RTX) \
1286   ((enum tls_model) ((SYMBOL_REF_FLAGS (RTX) >> SYMBOL_FLAG_TLS_SHIFT) & 7))
1287 /* Set if this symbol is not defined in this translation unit.  */
1288 #define SYMBOL_FLAG_EXTERNAL    (1 << 6)
1289 #define SYMBOL_REF_EXTERNAL_P(RTX) \
1290   ((SYMBOL_REF_FLAGS (RTX) & SYMBOL_FLAG_EXTERNAL) != 0)
1291
1292 /* Subsequent bits are available for the target to use.  */
1293 #define SYMBOL_FLAG_MACH_DEP_SHIFT      7
1294 #define SYMBOL_FLAG_MACH_DEP            (1 << SYMBOL_FLAG_MACH_DEP_SHIFT)
1295
1296 /* Define a macro to look for REG_INC notes,
1297    but save time on machines where they never exist.  */
1298
1299 #if (defined (HAVE_PRE_INCREMENT) || defined (HAVE_PRE_DECREMENT) || defined (HAVE_POST_INCREMENT) || defined (HAVE_POST_DECREMENT))
1300 #define FIND_REG_INC_NOTE(INSN, REG)                    \
1301   ((REG) != NULL_RTX && REG_P ((REG))                   \
1302    ? find_regno_note ((INSN), REG_INC, REGNO (REG))     \
1303    : find_reg_note ((INSN), REG_INC, (REG)))
1304 #else
1305 #define FIND_REG_INC_NOTE(INSN, REG) 0
1306 #endif
1307
1308 /* Indicate whether the machine has any sort of auto increment addressing.
1309    If not, we can avoid checking for REG_INC notes.  */
1310
1311 #if (defined (HAVE_PRE_INCREMENT) || defined (HAVE_PRE_DECREMENT) || defined (HAVE_POST_INCREMENT) || defined (HAVE_POST_DECREMENT))
1312 #define AUTO_INC_DEC
1313 #endif
1314
1315 #ifndef HAVE_PRE_INCREMENT
1316 #define HAVE_PRE_INCREMENT 0
1317 #endif
1318
1319 #ifndef HAVE_PRE_DECREMENT
1320 #define HAVE_PRE_DECREMENT 0
1321 #endif
1322
1323 #ifndef HAVE_POST_INCREMENT
1324 #define HAVE_POST_INCREMENT 0
1325 #endif
1326
1327 #ifndef HAVE_POST_DECREMENT
1328 #define HAVE_POST_DECREMENT 0
1329 #endif
1330
1331 #ifndef HAVE_POST_MODIFY_DISP
1332 #define HAVE_POST_MODIFY_DISP 0
1333 #endif
1334
1335 #ifndef HAVE_POST_MODIFY_REG
1336 #define HAVE_POST_MODIFY_REG 0
1337 #endif
1338
1339 #ifndef HAVE_PRE_MODIFY_DISP
1340 #define HAVE_PRE_MODIFY_DISP 0
1341 #endif
1342
1343 #ifndef HAVE_PRE_MODIFY_REG
1344 #define HAVE_PRE_MODIFY_REG 0
1345 #endif
1346
1347
1348 /* Some architectures do not have complete pre/post increment/decrement
1349    instruction sets, or only move some modes efficiently.  These macros
1350    allow us to tune autoincrement generation.  */
1351
1352 #ifndef USE_LOAD_POST_INCREMENT
1353 #define USE_LOAD_POST_INCREMENT(MODE)   HAVE_POST_INCREMENT
1354 #endif
1355
1356 #ifndef USE_LOAD_POST_DECREMENT
1357 #define USE_LOAD_POST_DECREMENT(MODE)   HAVE_POST_DECREMENT
1358 #endif
1359
1360 #ifndef USE_LOAD_PRE_INCREMENT
1361 #define USE_LOAD_PRE_INCREMENT(MODE)    HAVE_PRE_INCREMENT
1362 #endif
1363
1364 #ifndef USE_LOAD_PRE_DECREMENT
1365 #define USE_LOAD_PRE_DECREMENT(MODE)    HAVE_PRE_DECREMENT
1366 #endif
1367
1368 #ifndef USE_STORE_POST_INCREMENT
1369 #define USE_STORE_POST_INCREMENT(MODE)  HAVE_POST_INCREMENT
1370 #endif
1371
1372 #ifndef USE_STORE_POST_DECREMENT
1373 #define USE_STORE_POST_DECREMENT(MODE)  HAVE_POST_DECREMENT
1374 #endif
1375
1376 #ifndef USE_STORE_PRE_INCREMENT
1377 #define USE_STORE_PRE_INCREMENT(MODE)   HAVE_PRE_INCREMENT
1378 #endif
1379
1380 #ifndef USE_STORE_PRE_DECREMENT
1381 #define USE_STORE_PRE_DECREMENT(MODE)   HAVE_PRE_DECREMENT
1382 #endif
1383
1384 /* Determine if the insn is a PHI node.  */
1385 #define PHI_NODE_P(X)                           \
1386   ((X) && GET_CODE (X) == INSN                  \
1387    && GET_CODE (PATTERN (X)) == SET             \
1388    && GET_CODE (SET_SRC (PATTERN (X))) == PHI)
1389 \f
1390 /* Nonzero if we need to distinguish between the return value of this function
1391    and the return value of a function called by this function.  This helps
1392    integrate.c.
1393    This is 1 until after the rtl generation pass.  */
1394 extern int rtx_equal_function_value_matters;
1395
1396 /* Nonzero when we are generating CONCATs.  */
1397 extern int generating_concat_p;
1398
1399 /* Generally useful functions.  */
1400
1401 /* In expmed.c */
1402 extern int ceil_log2 (unsigned HOST_WIDE_INT);
1403
1404 #define plus_constant(X, C) plus_constant_wide ((X), (HOST_WIDE_INT) (C))
1405
1406 /* In builtins.c */
1407 extern rtx expand_builtin_expect_jump (tree, rtx, rtx);
1408 extern void purge_builtin_constant_p (void);
1409
1410 /* In explow.c */
1411 extern void set_stack_check_libfunc (rtx);
1412 extern HOST_WIDE_INT trunc_int_for_mode (HOST_WIDE_INT, enum machine_mode);
1413 extern rtx plus_constant_wide (rtx, HOST_WIDE_INT);
1414 extern rtx plus_constant_for_output_wide (rtx, HOST_WIDE_INT);
1415 extern void optimize_save_area_alloca (rtx);
1416
1417 /* In emit-rtl.c */
1418 extern rtx gen_rtx (enum rtx_code, enum machine_mode, ...);
1419 extern rtvec gen_rtvec (int, ...);
1420 extern rtx copy_insn_1 (rtx);
1421 extern rtx copy_insn (rtx);
1422 extern rtx gen_int_mode (HOST_WIDE_INT, enum machine_mode);
1423 extern rtx emit_copy_of_insn_after (rtx, rtx);
1424 extern void set_reg_attrs_from_mem (rtx, rtx);
1425 extern void set_mem_attrs_from_reg (rtx, rtx);
1426 extern void set_reg_attrs_for_parm (rtx, rtx);
1427
1428 /* In rtl.c */
1429 extern rtx rtx_alloc (RTX_CODE);
1430 extern rtvec rtvec_alloc (int);
1431 extern rtx copy_rtx (rtx);
1432
1433 /* In emit-rtl.c */
1434 extern rtx copy_rtx_if_shared (rtx);
1435
1436 /* In rtl.c */
1437 extern rtx copy_most_rtx (rtx, rtx);
1438 extern rtx shallow_copy_rtx (rtx);
1439 extern int rtx_equal_p (rtx, rtx);
1440
1441 /* In emit-rtl.c */
1442 extern rtvec gen_rtvec_v (int, rtx *);
1443 extern rtx gen_reg_rtx (enum machine_mode);
1444 extern rtx gen_rtx_REG_offset (rtx, enum machine_mode, unsigned int, int);
1445 extern rtx gen_label_rtx (void);
1446 extern int subreg_hard_regno (rtx, int);
1447 extern rtx gen_lowpart_common (enum machine_mode, rtx);
1448 extern rtx gen_lowpart (enum machine_mode, rtx);
1449
1450 /* In cse.c */
1451 extern rtx gen_lowpart_if_possible (enum machine_mode, rtx);
1452
1453 /* In emit-rtl.c */
1454 extern rtx gen_highpart (enum machine_mode, rtx);
1455 extern rtx gen_highpart_mode (enum machine_mode, enum machine_mode, rtx);
1456 extern rtx gen_realpart (enum machine_mode, rtx);
1457 extern rtx gen_imagpart (enum machine_mode, rtx);
1458 extern rtx operand_subword (rtx, unsigned int, int, enum machine_mode);
1459 extern rtx constant_subword (rtx, int, enum machine_mode);
1460
1461 /* In emit-rtl.c */
1462 extern rtx operand_subword_force (rtx, unsigned int, enum machine_mode);
1463 extern int subreg_lowpart_p (rtx);
1464 extern unsigned int subreg_lowpart_offset (enum machine_mode,
1465                                            enum machine_mode);
1466 extern unsigned int subreg_highpart_offset (enum machine_mode,
1467                                             enum machine_mode);
1468 extern rtx make_safe_from (rtx, rtx);
1469 extern rtx convert_memory_address (enum machine_mode, rtx);
1470 extern rtx get_insns (void);
1471 extern const char *get_insn_name (int);
1472 extern rtx get_last_insn (void);
1473 extern rtx get_last_insn_anywhere (void);
1474 extern rtx get_first_nonnote_insn (void);
1475 extern rtx get_last_nonnote_insn (void);
1476 extern void start_sequence (void);
1477 extern void push_to_sequence (rtx);
1478 extern void end_sequence (void);
1479 extern void push_to_full_sequence (rtx, rtx);
1480 extern void end_full_sequence (rtx*, rtx*);
1481
1482 /* In varasm.c  */
1483 extern rtx immed_double_const (HOST_WIDE_INT, HOST_WIDE_INT,
1484                                enum machine_mode);
1485 extern rtx force_const_mem (enum machine_mode, rtx);
1486
1487 /* In varasm.c  */
1488 extern rtx get_pool_constant (rtx);
1489 extern rtx get_pool_constant_mark (rtx, bool *);
1490 extern enum machine_mode get_pool_mode (rtx);
1491 extern rtx get_pool_constant_for_function (struct function *, rtx);
1492 extern enum machine_mode get_pool_mode_for_function (struct function *, rtx);
1493 extern int get_pool_offset (rtx);
1494 extern rtx simplify_subtraction (rtx);
1495
1496 /* In function.c  */
1497 extern rtx assign_stack_local (enum machine_mode, HOST_WIDE_INT, int);
1498 extern rtx assign_stack_temp (enum machine_mode, HOST_WIDE_INT, int);
1499 extern rtx assign_stack_temp_for_type (enum machine_mode,
1500                                        HOST_WIDE_INT, int, tree);
1501 extern rtx assign_temp (tree, int, int, int);
1502
1503 /* In emit-rtl.c */
1504 extern rtx emit_insn_before (rtx, rtx);
1505 extern rtx emit_insn_before_setloc (rtx, rtx, int);
1506 extern rtx emit_jump_insn_before (rtx, rtx);
1507 extern rtx emit_jump_insn_before_setloc (rtx, rtx, int);
1508 extern rtx emit_call_insn_before (rtx, rtx);
1509 extern rtx emit_call_insn_before_setloc (rtx, rtx, int);
1510 extern rtx emit_barrier_before (rtx);
1511 extern rtx emit_label_before (rtx, rtx);
1512 extern rtx emit_note_before (int, rtx);
1513 extern rtx emit_insn_after (rtx, rtx);
1514 extern rtx emit_insn_after_setloc (rtx, rtx, int);
1515 extern rtx emit_jump_insn_after (rtx, rtx);
1516 extern rtx emit_jump_insn_after_setloc (rtx, rtx, int);
1517 extern rtx emit_call_insn_after (rtx, rtx);
1518 extern rtx emit_call_insn_after_setloc (rtx, rtx, int);
1519 extern rtx emit_barrier_after (rtx);
1520 extern rtx emit_label_after (rtx, rtx);
1521 extern rtx emit_note_after (int, rtx);
1522 extern rtx emit_note_copy_after (rtx, rtx);
1523 extern rtx emit_insn (rtx);
1524 extern rtx emit_jump_insn (rtx);
1525 extern rtx emit_call_insn (rtx);
1526 extern rtx emit_label (rtx);
1527 extern rtx emit_barrier (void);
1528 extern rtx emit_note (int);
1529 extern rtx emit_note_copy (rtx);
1530 extern rtx emit_line_note (location_t);
1531 extern rtx make_insn_raw (rtx);
1532 extern void add_function_usage_to (rtx, rtx);
1533 extern rtx last_call_insn (void);
1534 extern rtx previous_insn (rtx);
1535 extern rtx next_insn (rtx);
1536 extern rtx prev_nonnote_insn (rtx);
1537 extern rtx next_nonnote_insn (rtx);
1538 extern rtx prev_real_insn (rtx);
1539 extern rtx next_real_insn (rtx);
1540 extern rtx prev_active_insn (rtx);
1541 extern rtx next_active_insn (rtx);
1542 extern int active_insn_p (rtx);
1543 extern rtx prev_label (rtx);
1544 extern rtx next_label (rtx);
1545 extern rtx next_cc0_user (rtx);
1546 extern rtx prev_cc0_setter (rtx);
1547
1548 /* In cfglayout.c  */
1549 extern tree choose_inner_scope (tree, tree);
1550 extern int insn_line (rtx);
1551 extern const char * insn_file (rtx);
1552 extern int locator_line (int);
1553 extern const char * locator_file (int);
1554 extern int prologue_locator, epilogue_locator;
1555
1556 /* In jump.c */
1557 extern enum rtx_code reverse_condition (enum rtx_code);
1558 extern enum rtx_code reverse_condition_maybe_unordered (enum rtx_code);
1559 extern enum rtx_code swap_condition (enum rtx_code);
1560 extern enum rtx_code unsigned_condition (enum rtx_code);
1561 extern enum rtx_code signed_condition (enum rtx_code);
1562 extern void mark_jump_label (rtx, rtx, int);
1563 extern void cleanup_barriers (void);
1564
1565 /* In jump.c */
1566 extern bool squeeze_notes (rtx *, rtx *);
1567 extern rtx delete_related_insns (rtx);
1568 extern void delete_jump (rtx);
1569 extern void delete_barrier (rtx);
1570 extern rtx get_label_before (rtx);
1571 extern rtx get_label_after (rtx);
1572 extern rtx follow_jumps (rtx);
1573
1574 /* In recog.c  */
1575 extern rtx *find_constant_term_loc (rtx *);
1576
1577 /* In emit-rtl.c  */
1578 extern rtx try_split (rtx, rtx, int);
1579 extern int split_branch_probability;
1580
1581 /* In unknown file  */
1582 extern rtx split_insns (rtx, rtx);
1583
1584 /* In simplify-rtx.c  */
1585 extern rtx simplify_unary_operation (enum rtx_code, enum machine_mode, rtx,
1586                                      enum machine_mode);
1587 extern rtx simplify_binary_operation (enum rtx_code, enum machine_mode, rtx,
1588                                       rtx);
1589 extern rtx simplify_ternary_operation (enum rtx_code, enum machine_mode,
1590                                        enum machine_mode, rtx, rtx, rtx);
1591 extern rtx simplify_relational_operation (enum rtx_code, enum machine_mode,
1592                                           rtx, rtx);
1593 extern rtx simplify_gen_binary (enum rtx_code, enum machine_mode, rtx, rtx);
1594 extern rtx simplify_gen_unary (enum rtx_code, enum machine_mode, rtx,
1595                                enum machine_mode);
1596 extern rtx simplify_gen_ternary (enum rtx_code, enum machine_mode,
1597                                  enum machine_mode, rtx, rtx, rtx);
1598 extern rtx simplify_gen_relational (enum rtx_code, enum machine_mode,
1599                                     enum machine_mode, rtx, rtx);
1600 extern rtx simplify_subreg (enum machine_mode, rtx, enum machine_mode,
1601                             unsigned int);
1602 extern rtx simplify_gen_subreg (enum machine_mode, rtx, enum machine_mode,
1603                                 unsigned int);
1604 extern rtx simplify_replace_rtx (rtx, rtx, rtx);
1605 extern rtx simplify_rtx (rtx);
1606 extern rtx avoid_constant_pool_reference (rtx);
1607
1608 /* In function.c  */
1609 extern rtx gen_mem_addressof (rtx, tree, int);
1610
1611 /* In regclass.c  */
1612 extern enum machine_mode choose_hard_reg_mode (unsigned int, unsigned int,
1613                                                bool);
1614
1615 /* In emit-rtl.c  */
1616 extern rtx set_unique_reg_note (rtx, enum reg_note, rtx);
1617
1618 /* Functions in rtlanal.c */
1619
1620 /* Single set is implemented as macro for performance reasons.  */
1621 #define single_set(I) (INSN_P (I) \
1622                        ? (GET_CODE (PATTERN (I)) == SET \
1623                           ? PATTERN (I) : single_set_1 (I)) \
1624                        : NULL_RTX)
1625 #define single_set_1(I) single_set_2 (I, PATTERN (I))
1626
1627 /* Structure used for passing data to REPLACE_LABEL.  */
1628 typedef struct replace_label_data
1629 {
1630   rtx r1;
1631   rtx r2;
1632   bool update_label_nuses;
1633 } replace_label_data;
1634
1635 extern int rtx_addr_can_trap_p (rtx);
1636 extern bool nonzero_address_p (rtx);
1637 extern int rtx_unstable_p (rtx);
1638 extern int rtx_varies_p (rtx, int);
1639 extern int rtx_addr_varies_p (rtx, int);
1640 extern HOST_WIDE_INT get_integer_term (rtx);
1641 extern rtx get_related_value (rtx);
1642 extern rtx get_jump_table_offset (rtx, rtx *);
1643 extern int global_reg_mentioned_p (rtx);
1644 extern int reg_mentioned_p (rtx, rtx);
1645 extern int count_occurrences (rtx, rtx, int);
1646 extern int reg_referenced_p (rtx, rtx);
1647 extern int reg_used_between_p (rtx, rtx, rtx);
1648 extern int reg_referenced_between_p (rtx, rtx, rtx);
1649 extern int reg_set_between_p (rtx, rtx, rtx);
1650 extern int regs_set_between_p (rtx, rtx, rtx);
1651 extern int commutative_operand_precedence (rtx);
1652 extern int swap_commutative_operands_p (rtx, rtx);
1653 extern int modified_between_p (rtx, rtx, rtx);
1654 extern int no_labels_between_p (rtx, rtx);
1655 extern int no_jumps_between_p (rtx, rtx);
1656 extern int modified_in_p (rtx, rtx);
1657 extern int insn_dependent_p (rtx, rtx);
1658 extern int reg_set_p (rtx, rtx);
1659 extern rtx single_set_2 (rtx, rtx);
1660 extern int multiple_sets (rtx);
1661 extern int set_noop_p (rtx);
1662 extern int noop_move_p (rtx);
1663 extern rtx find_last_value (rtx, rtx *, rtx, int);
1664 extern int refers_to_regno_p (unsigned int, unsigned int, rtx, rtx *);
1665 extern int reg_overlap_mentioned_p (rtx, rtx);
1666 extern rtx set_of (rtx, rtx);
1667 extern void note_stores (rtx, void (*) (rtx, rtx, void *), void *);
1668 extern void note_uses (rtx *, void (*) (rtx *, void *), void *);
1669 extern rtx reg_set_last (rtx, rtx);
1670 extern int dead_or_set_p (rtx, rtx);
1671 extern int dead_or_set_regno_p (rtx, unsigned int);
1672 extern rtx find_reg_note (rtx, enum reg_note, rtx);
1673 extern rtx find_regno_note (rtx, enum reg_note, unsigned int);
1674 extern rtx find_reg_equal_equiv_note (rtx);
1675 extern int find_reg_fusage (rtx, enum rtx_code, rtx);
1676 extern int find_regno_fusage (rtx, enum rtx_code, unsigned int);
1677 extern int pure_call_p (rtx);
1678 extern void remove_note (rtx, rtx);
1679 extern int side_effects_p (rtx);
1680 extern int volatile_refs_p (rtx);
1681 extern int volatile_insn_p (rtx);
1682 extern int may_trap_p (rtx);
1683 extern int inequality_comparisons_p (rtx);
1684 extern rtx replace_rtx (rtx, rtx, rtx);
1685 extern rtx replace_regs (rtx, rtx *, unsigned int, int);
1686 extern int replace_label (rtx *, void *);
1687 extern int rtx_referenced_p (rtx, rtx);
1688 extern bool tablejump_p (rtx, rtx *, rtx *);
1689 extern int computed_jump_p (rtx);
1690 typedef int (*rtx_function) (rtx *, void *);
1691 extern int for_each_rtx (rtx *, rtx_function, void *);
1692 extern rtx regno_use_in (unsigned int, rtx);
1693 extern int auto_inc_p (rtx);
1694 extern int in_expr_list_p (rtx, rtx);
1695 extern void remove_node_from_expr_list (rtx, rtx *);
1696 extern int insns_safe_to_move_p (rtx, rtx, rtx *);
1697 extern int loc_mentioned_in_p (rtx *, rtx);
1698 extern rtx find_first_parameter_load (rtx, rtx);
1699 extern bool keep_with_call_p (rtx);
1700
1701 /* flow.c */
1702
1703 extern rtx find_use_as_address (rtx, rtx, HOST_WIDE_INT);
1704
1705 /* lists.c */
1706
1707 void free_EXPR_LIST_list                (rtx *);
1708 void free_INSN_LIST_list                (rtx *);
1709 void free_EXPR_LIST_node                (rtx);
1710 void free_INSN_LIST_node                (rtx);
1711 rtx alloc_INSN_LIST                     (rtx, rtx);
1712 rtx alloc_EXPR_LIST                     (int, rtx, rtx);
1713
1714 /* regclass.c */
1715
1716 /* Maximum number of parallel sets and clobbers in any insn in this fn.
1717    Always at least 3, since the combiner could put that many togetherm
1718    and we want this to remain correct for all the remaining passes.  */
1719
1720 extern int max_parallel;
1721
1722 /* Free up register info memory.  */
1723 extern void free_reg_info (void);
1724
1725 /* recog.c */
1726 extern int asm_noperands (rtx);
1727 extern const char *decode_asm_operands (rtx, rtx *, rtx **, const char **,
1728                                         enum machine_mode *);
1729
1730 extern enum reg_class reg_preferred_class (int);
1731 extern enum reg_class reg_alternate_class (int);
1732
1733 extern rtx get_first_nonparm_insn (void);
1734
1735 extern void split_all_insns (int);
1736 extern void split_all_insns_noflow (void);
1737
1738 #define MAX_SAVED_CONST_INT 64
1739 extern GTY(()) rtx const_int_rtx[MAX_SAVED_CONST_INT * 2 + 1];
1740
1741 #define const0_rtx      (const_int_rtx[MAX_SAVED_CONST_INT])
1742 #define const1_rtx      (const_int_rtx[MAX_SAVED_CONST_INT+1])
1743 #define const2_rtx      (const_int_rtx[MAX_SAVED_CONST_INT+2])
1744 #define constm1_rtx     (const_int_rtx[MAX_SAVED_CONST_INT-1])
1745 extern GTY(()) rtx const_true_rtx;
1746
1747 extern GTY(()) rtx const_tiny_rtx[3][(int) MAX_MACHINE_MODE];
1748
1749 /* Returns a constant 0 rtx in mode MODE.  Integer modes are treated the
1750    same as VOIDmode.  */
1751
1752 #define CONST0_RTX(MODE) (const_tiny_rtx[0][(int) (MODE)])
1753
1754 /* Likewise, for the constants 1 and 2.  */
1755
1756 #define CONST1_RTX(MODE) (const_tiny_rtx[1][(int) (MODE)])
1757 #define CONST2_RTX(MODE) (const_tiny_rtx[2][(int) (MODE)])
1758
1759 /* If HARD_FRAME_POINTER_REGNUM is defined, then a special dummy reg
1760    is used to represent the frame pointer.  This is because the
1761    hard frame pointer and the automatic variables are separated by an amount
1762    that cannot be determined until after register allocation.  We can assume
1763    that in this case ELIMINABLE_REGS will be defined, one action of which
1764    will be to eliminate FRAME_POINTER_REGNUM into HARD_FRAME_POINTER_REGNUM.  */
1765 #ifndef HARD_FRAME_POINTER_REGNUM
1766 #define HARD_FRAME_POINTER_REGNUM FRAME_POINTER_REGNUM
1767 #endif
1768
1769 /* Index labels for global_rtl.  */
1770 enum global_rtl_index
1771 {
1772   GR_PC,
1773   GR_CC0,
1774   GR_STACK_POINTER,
1775   GR_FRAME_POINTER,
1776 /* For register elimination to work properly these hard_frame_pointer_rtx,
1777    frame_pointer_rtx, and arg_pointer_rtx must be the same if they refer to
1778    the same register.  */
1779 #if FRAME_POINTER_REGNUM == ARG_POINTER_REGNUM
1780   GR_ARG_POINTER = GR_FRAME_POINTER,
1781 #endif
1782 #if HARD_FRAME_POINTER_REGNUM == FRAME_POINTER_REGNUM
1783   GR_HARD_FRAME_POINTER = GR_FRAME_POINTER,
1784 #else
1785   GR_HARD_FRAME_POINTER,
1786 #endif
1787 #if FRAME_POINTER_REGNUM != ARG_POINTER_REGNUM
1788 #if HARD_FRAME_POINTER_REGNUM == ARG_POINTER_REGNUM
1789   GR_ARG_POINTER = GR_HARD_FRAME_POINTER,
1790 #else
1791   GR_ARG_POINTER,
1792 #endif
1793 #endif
1794   GR_VIRTUAL_INCOMING_ARGS,
1795   GR_VIRTUAL_STACK_ARGS,
1796   GR_VIRTUAL_STACK_DYNAMIC,
1797   GR_VIRTUAL_OUTGOING_ARGS,
1798   GR_VIRTUAL_CFA,
1799
1800   GR_MAX
1801 };
1802
1803 /* Pointers to standard pieces of rtx are stored here.  */
1804 extern GTY(()) rtx global_rtl[GR_MAX];
1805
1806 /* Standard pieces of rtx, to be substituted directly into things.  */
1807 #define pc_rtx                  (global_rtl[GR_PC])
1808 #define cc0_rtx                 (global_rtl[GR_CC0])
1809
1810 /* All references to certain hard regs, except those created
1811    by allocating pseudo regs into them (when that's possible),
1812    go through these unique rtx objects.  */
1813 #define stack_pointer_rtx       (global_rtl[GR_STACK_POINTER])
1814 #define frame_pointer_rtx       (global_rtl[GR_FRAME_POINTER])
1815 #define hard_frame_pointer_rtx  (global_rtl[GR_HARD_FRAME_POINTER])
1816 #define arg_pointer_rtx         (global_rtl[GR_ARG_POINTER])
1817
1818 extern GTY(()) rtx pic_offset_table_rtx;
1819 extern GTY(()) rtx static_chain_rtx;
1820 extern GTY(()) rtx static_chain_incoming_rtx;
1821 extern GTY(()) rtx return_address_pointer_rtx;
1822
1823 /* Include the RTL generation functions.  */
1824
1825 #ifndef NO_GENRTL_H
1826 #include "genrtl.h"
1827 #endif
1828
1829 /* There are some RTL codes that require special attention; the
1830    generation functions included above do the raw handling.  If you
1831    add to this list, modify special_rtx in gengenrtl.c as well.  You
1832    should also modify gen_rtx to use the special function.  */
1833
1834 extern rtx gen_rtx_CONST_INT (enum machine_mode, HOST_WIDE_INT);
1835 extern rtx gen_rtx_CONST_VECTOR (enum machine_mode, rtvec);
1836 extern rtx gen_raw_REG (enum machine_mode, int);
1837 extern rtx gen_rtx_REG (enum machine_mode, unsigned);
1838 extern rtx gen_rtx_SUBREG (enum machine_mode, rtx, int);
1839 extern rtx gen_rtx_MEM (enum machine_mode, rtx);
1840
1841 extern rtx gen_lowpart_SUBREG (enum machine_mode, rtx);
1842
1843 /* We need the cast here to ensure that we get the same result both with
1844    and without prototypes.  */
1845 #define GEN_INT(N)  gen_rtx_CONST_INT (VOIDmode, (HOST_WIDE_INT) (N))
1846
1847 /* Virtual registers are used during RTL generation to refer to locations into
1848    the stack frame when the actual location isn't known until RTL generation
1849    is complete.  The routine instantiate_virtual_regs replaces these with
1850    the proper value, which is normally {frame,arg,stack}_pointer_rtx plus
1851    a constant.  */
1852
1853 #define FIRST_VIRTUAL_REGISTER  (FIRST_PSEUDO_REGISTER)
1854
1855 /* This points to the first word of the incoming arguments passed on the stack,
1856    either by the caller or by the callee when pretending it was passed by the
1857    caller.  */
1858
1859 #define virtual_incoming_args_rtx       (global_rtl[GR_VIRTUAL_INCOMING_ARGS])
1860
1861 #define VIRTUAL_INCOMING_ARGS_REGNUM    (FIRST_VIRTUAL_REGISTER)
1862
1863 /* If FRAME_GROWS_DOWNWARD, this points to immediately above the first
1864    variable on the stack.  Otherwise, it points to the first variable on
1865    the stack.  */
1866
1867 #define virtual_stack_vars_rtx          (global_rtl[GR_VIRTUAL_STACK_ARGS])
1868
1869 #define VIRTUAL_STACK_VARS_REGNUM       ((FIRST_VIRTUAL_REGISTER) + 1)
1870
1871 /* This points to the location of dynamically-allocated memory on the stack
1872    immediately after the stack pointer has been adjusted by the amount
1873    desired.  */
1874
1875 #define virtual_stack_dynamic_rtx       (global_rtl[GR_VIRTUAL_STACK_DYNAMIC])
1876
1877 #define VIRTUAL_STACK_DYNAMIC_REGNUM    ((FIRST_VIRTUAL_REGISTER) + 2)
1878
1879 /* This points to the location in the stack at which outgoing arguments should
1880    be written when the stack is pre-pushed (arguments pushed using push
1881    insns always use sp).  */
1882
1883 #define virtual_outgoing_args_rtx       (global_rtl[GR_VIRTUAL_OUTGOING_ARGS])
1884
1885 #define VIRTUAL_OUTGOING_ARGS_REGNUM    ((FIRST_VIRTUAL_REGISTER) + 3)
1886
1887 /* This points to the Canonical Frame Address of the function.  This
1888    should correspond to the CFA produced by INCOMING_FRAME_SP_OFFSET,
1889    but is calculated relative to the arg pointer for simplicity; the
1890    frame pointer nor stack pointer are necessarily fixed relative to
1891    the CFA until after reload.  */
1892
1893 #define virtual_cfa_rtx                 (global_rtl[GR_VIRTUAL_CFA])
1894
1895 #define VIRTUAL_CFA_REGNUM              ((FIRST_VIRTUAL_REGISTER) + 4)
1896
1897 #define LAST_VIRTUAL_REGISTER           ((FIRST_VIRTUAL_REGISTER) + 4)
1898
1899 /* Nonzero if REGNUM is a pointer into the stack frame.  */
1900 #define REGNO_PTR_FRAME_P(REGNUM)               \
1901   ((REGNUM) == STACK_POINTER_REGNUM             \
1902    || (REGNUM) == FRAME_POINTER_REGNUM          \
1903    || (REGNUM) == HARD_FRAME_POINTER_REGNUM     \
1904    || (REGNUM) == ARG_POINTER_REGNUM            \
1905    || ((REGNUM) >= FIRST_VIRTUAL_REGISTER       \
1906        && (REGNUM) <= LAST_VIRTUAL_REGISTER))
1907
1908 /* REGNUM never really appearing in the INSN stream.  */
1909 #define INVALID_REGNUM                  (~(unsigned int) 0)
1910
1911 extern rtx output_constant_def (tree, int);
1912 extern rtx lookup_constant_def (tree);
1913
1914 /* Called from integrate.c when a deferred constant is inlined.  */
1915 extern void notice_rtl_inlining_of_deferred_constant (void);
1916
1917 /* Nonzero after the second flow pass has completed.
1918    Set to 1 or 0 by toplev.c  */
1919 extern int flow2_completed;
1920
1921 /* Nonzero after end of reload pass.
1922    Set to 1 or 0 by reload1.c.  */
1923
1924 extern int reload_completed;
1925
1926 /* Nonzero after thread_prologue_and_epilogue_insns has run.  */
1927 extern int epilogue_completed;
1928
1929 /* Set to 1 while reload_as_needed is operating.
1930    Required by some machines to handle any generated moves differently.  */
1931
1932 extern int reload_in_progress;
1933
1934 /* If this is nonzero, we do not bother generating VOLATILE
1935    around volatile memory references, and we are willing to
1936    output indirect addresses.  If cse is to follow, we reject
1937    indirect addresses so a useful potential cse is generated;
1938    if it is used only once, instruction combination will produce
1939    the same indirect address eventually.  */
1940 extern int cse_not_expected;
1941
1942 /* Set to nonzero before life analysis to indicate that it is unsafe to
1943    generate any new pseudo registers.  */
1944 extern int no_new_pseudos;
1945
1946 /* Translates rtx code to tree code, for those codes needed by
1947    REAL_ARITHMETIC.  The function returns an int because the caller may not
1948    know what `enum tree_code' means.  */
1949
1950 extern int rtx_to_tree_code (enum rtx_code);
1951
1952 /* In cse.c */
1953 struct cse_basic_block_data;
1954
1955 /* Return the right cost to give to an operation
1956    to make the cost of the corresponding register-to-register instruction
1957    N times that of a fast register-to-register instruction.  */
1958 #define COSTS_N_INSNS(N) ((N) * 4)
1959
1960 /* Maximum cost of a rtl expression.  This value has the special meaning
1961    not to use an rtx with this cost under any circumstances.  */
1962 #define MAX_COST INT_MAX
1963
1964 extern int rtx_cost (rtx, enum rtx_code);
1965 extern int address_cost (rtx, enum machine_mode);
1966 extern int delete_trivially_dead_insns (rtx, int);
1967 #ifdef BUFSIZ
1968 extern int cse_main (rtx, int, int, FILE *);
1969 #endif
1970 extern void cse_end_of_basic_block (rtx, struct cse_basic_block_data *,
1971                                     int, int, int);
1972
1973 /* In jump.c */
1974 extern int comparison_dominates_p (enum rtx_code, enum rtx_code);
1975 extern int condjump_p (rtx);
1976 extern int any_condjump_p (rtx);
1977 extern int any_uncondjump_p (rtx);
1978 extern int safe_to_remove_jump_p (rtx);
1979 extern rtx pc_set (rtx);
1980 extern rtx condjump_label (rtx);
1981 extern int simplejump_p (rtx);
1982 extern int returnjump_p (rtx);
1983 extern int onlyjump_p (rtx);
1984 extern int only_sets_cc0_p (rtx);
1985 extern int sets_cc0_p (rtx);
1986 extern int invert_jump_1 (rtx, rtx);
1987 extern int invert_jump (rtx, rtx, int);
1988 extern int rtx_renumbered_equal_p (rtx, rtx);
1989 extern int true_regnum (rtx);
1990 extern unsigned int reg_or_subregno (rtx);
1991 extern int redirect_jump_1 (rtx, rtx);
1992 extern int redirect_jump (rtx, rtx, int);
1993 extern void rebuild_jump_labels (rtx);
1994 extern enum rtx_code reversed_comparison_code (rtx, rtx);
1995 extern enum rtx_code reversed_comparison_code_parts (enum rtx_code,
1996                                                      rtx, rtx, rtx);
1997 extern void delete_for_peephole (rtx, rtx);
1998 extern int condjump_in_parallel_p (rtx);
1999 extern void never_reached_warning (rtx, rtx);
2000 extern void purge_line_number_notes (rtx);
2001 extern void copy_loop_headers (rtx);
2002
2003 /* In emit-rtl.c.  */
2004 extern int max_reg_num (void);
2005 extern int max_label_num (void);
2006 extern int get_first_label_num (void);
2007 extern void delete_insns_since (rtx);
2008 extern void mark_reg_pointer (rtx, int);
2009 extern void mark_user_reg (rtx);
2010 extern void reset_used_flags (rtx);
2011 extern void reorder_insns (rtx, rtx, rtx);
2012 extern void reorder_insns_nobb (rtx, rtx, rtx);
2013 extern int get_max_uid (void);
2014 extern int in_sequence_p (void);
2015 extern void force_next_line_note (void);
2016 extern void init_emit (void);
2017 extern void init_emit_once (int);
2018 extern void push_topmost_sequence (void);
2019 extern void pop_topmost_sequence (void);
2020 extern int subreg_realpart_p (rtx);
2021 extern void reverse_comparison (rtx);
2022 extern void set_new_first_and_last_insn (rtx, rtx);
2023 extern void set_new_first_and_last_label_num (int, int);
2024 extern void set_new_last_label_num (int);
2025 extern void unshare_all_rtl_again (rtx);
2026 extern void set_first_insn (rtx);
2027 extern void set_last_insn (rtx);
2028 extern void link_cc0_insns (rtx);
2029 extern void add_insn (rtx);
2030 extern void add_insn_before (rtx, rtx);
2031 extern void add_insn_after (rtx, rtx);
2032 extern void remove_insn (rtx);
2033 extern void reorder_insns_with_line_notes (rtx, rtx, rtx);
2034 extern void emit_insn_after_with_line_notes (rtx, rtx, rtx);
2035 extern enum rtx_code classify_insn (rtx);
2036 extern rtx emit (rtx);
2037 /* Query and clear/ restore no_line_numbers.  This is used by the
2038    switch / case handling in stmt.c to give proper line numbers in
2039    warnings about unreachable code.  */
2040 int force_line_numbers (void);
2041 void restore_line_number_status (int old_value);
2042 extern void renumber_insns (FILE *);
2043 extern void remove_unnecessary_notes (void);
2044 extern rtx delete_insn (rtx);
2045 extern void delete_insn_chain (rtx, rtx);
2046 extern rtx unlink_insn_chain (rtx, rtx);
2047 extern rtx delete_insn_and_edges (rtx);
2048 extern void delete_insn_chain_and_edges (rtx, rtx);
2049
2050 /* In combine.c */
2051 extern int combine_instructions (rtx, unsigned int);
2052 extern unsigned int extended_count (rtx, enum machine_mode, int);
2053 extern rtx remove_death (unsigned int, rtx);
2054 #ifdef BUFSIZ
2055 extern void dump_combine_stats (FILE *);
2056 extern void dump_combine_total_stats (FILE *);
2057 #endif
2058
2059 /* In sched.c.  */
2060 #ifdef BUFSIZ
2061 extern void schedule_insns (FILE *);
2062 extern void schedule_ebbs (FILE *);
2063 #endif
2064 extern void fix_sched_param (const char *, const char *);
2065
2066 /* In print-rtl.c */
2067 extern const char *print_rtx_head;
2068 extern void debug_rtx (rtx);
2069 extern void debug_rtx_list (rtx, int);
2070 extern void debug_rtx_range (rtx, rtx);
2071 extern rtx debug_rtx_find (rtx, int);
2072 #ifdef BUFSIZ
2073 extern void print_mem_expr (FILE *, tree);
2074 extern void print_rtl (FILE *, rtx);
2075 extern void print_simple_rtl (FILE *, rtx);
2076 extern int print_rtl_single (FILE *, rtx);
2077 extern void print_inline_rtx (FILE *, rtx, int);
2078 #endif
2079
2080 /* In loop.c */
2081 extern void init_loop (void);
2082 extern rtx libcall_other_reg (rtx, rtx);
2083 #ifdef BUFSIZ
2084 extern void loop_optimize (rtx, FILE *, int);
2085 #endif
2086 extern void branch_target_load_optimize (rtx, bool);
2087 extern void record_excess_regs (rtx, rtx, rtx *);
2088
2089 /* In function.c */
2090 extern void reposition_prologue_and_epilogue_notes (rtx);
2091 extern void thread_prologue_and_epilogue_insns (rtx);
2092 extern int prologue_epilogue_contains (rtx);
2093 extern int sibcall_epilogue_contains (rtx);
2094 extern void preserve_rtl_expr_result (rtx);
2095 extern void mark_temp_addr_taken (rtx);
2096 extern void update_temp_slot_address (rtx, rtx);
2097 extern void purge_addressof (rtx);
2098 extern void purge_hard_subreg_sets (rtx);
2099
2100 /* In stmt.c */
2101 extern void set_file_and_line_for_stmt (location_t);
2102 extern void expand_null_return (void);
2103 extern void emit_jump (rtx);
2104 extern int preserve_subexpressions_p (void);
2105
2106 /* In expr.c */
2107 extern rtx move_by_pieces (rtx, rtx, unsigned HOST_WIDE_INT,
2108                            unsigned int, int);
2109
2110 /* In flow.c */
2111 extern void recompute_reg_usage (rtx, int);
2112 extern int initialize_uninitialized_subregs (void);
2113 extern void delete_dead_jumptables (void);
2114 #ifdef BUFSIZ
2115 extern void print_rtl_with_bb (FILE *, rtx);
2116 extern void dump_flow_info (FILE *);
2117 #endif
2118
2119 /* In expmed.c */
2120 extern void init_expmed (void);
2121 extern void expand_inc (rtx, rtx);
2122 extern void expand_dec (rtx, rtx);
2123 extern rtx expand_mult_highpart (enum machine_mode, rtx,
2124                                  unsigned HOST_WIDE_INT, rtx, int, int);
2125
2126 /* In gcse.c */
2127 extern bool can_copy_p (enum machine_mode);
2128 extern rtx fis_get_condition (rtx);
2129 #ifdef BUFSIZ
2130 extern int gcse_main (rtx, FILE *);
2131 extern int bypass_jumps (FILE *);
2132 #endif
2133
2134 /* In global.c */
2135 extern void mark_elimination (int, int);
2136 #ifdef BUFSIZ
2137 extern int global_alloc (FILE *);
2138 extern void dump_global_regs (FILE *);
2139 #endif
2140 #ifdef HARD_CONST
2141 /* Yes, this ifdef is silly, but HARD_REG_SET is not always defined.  */
2142 extern void retry_global_alloc (int, HARD_REG_SET);
2143 #endif
2144 extern void build_insn_chain (rtx);
2145
2146 /* In regclass.c */
2147 extern int reg_classes_intersect_p (enum reg_class, enum reg_class);
2148 extern int reg_class_subset_p (enum reg_class, enum reg_class);
2149 extern void globalize_reg (int);
2150 extern void init_reg_modes_once (void);
2151 extern void init_regs (void);
2152 extern void init_fake_stack_mems (void);
2153 extern void init_reg_sets (void);
2154 extern void regset_release_memory (void);
2155 extern void regclass_init (void);
2156 extern void regclass (rtx, int, FILE *);
2157 extern void reg_scan (rtx, unsigned int, int);
2158 extern void reg_scan_update (rtx, rtx, unsigned int);
2159 extern void fix_register (const char *, int, int);
2160 #ifdef HARD_CONST
2161 extern void cannot_change_mode_set_regs (HARD_REG_SET *,
2162                                          enum machine_mode, unsigned int);
2163 #endif
2164 extern bool invalid_mode_change_p (unsigned int, enum reg_class,
2165                                    enum machine_mode);
2166
2167 extern int delete_null_pointer_checks (rtx);
2168
2169 /* In regmove.c */
2170 #ifdef BUFSIZ
2171 extern void regmove_optimize (rtx, int, FILE *);
2172 #endif
2173 extern void combine_stack_adjustments (void);
2174
2175 /* In reorg.c */
2176 #ifdef BUFSIZ
2177 extern void dbr_schedule (rtx, FILE *);
2178 #endif
2179
2180 /* In local-alloc.c */
2181 #ifdef BUFSIZ
2182 extern void dump_local_alloc (FILE *);
2183 #endif
2184 extern int local_alloc (void);
2185 extern int function_invariant_p (rtx);
2186
2187 /* In profile.c */
2188 extern void init_branch_prob (void);
2189 extern void branch_prob (void);
2190 extern void end_branch_prob (void);
2191
2192 /* In reg-stack.c */
2193 #ifdef BUFSIZ
2194 extern bool reg_to_stack (rtx, FILE *);
2195 #endif
2196
2197 /* In calls.c */
2198 enum libcall_type
2199 {
2200   LCT_NORMAL = 0,
2201   LCT_CONST = 1,
2202   LCT_PURE = 2,
2203   LCT_CONST_MAKE_BLOCK = 3,
2204   LCT_PURE_MAKE_BLOCK = 4,
2205   LCT_NORETURN = 5,
2206   LCT_THROW = 6,
2207   LCT_ALWAYS_RETURN = 7,
2208   LCT_RETURNS_TWICE = 8
2209 };
2210
2211 extern void emit_library_call (rtx, enum libcall_type, enum machine_mode, int,
2212                                ...);
2213 extern rtx emit_library_call_value (rtx, rtx, enum libcall_type,
2214                                     enum machine_mode, int, ...);
2215
2216 /* In unroll.c */
2217 extern int set_dominates_use (int, int, int, rtx, rtx);
2218
2219 /* In varasm.c */
2220 extern int in_data_section (void);
2221 extern void init_varasm_once (void);
2222
2223 /* In rtl.c */
2224 extern void init_rtl (void);
2225 extern void traverse_md_constants (int (*) (void **, void *), void *);
2226 struct md_constant { char *name, *value; };
2227
2228 #ifdef BUFSIZ
2229 extern int read_skip_spaces (FILE *);
2230 extern rtx read_rtx (FILE *);
2231 #endif
2232
2233 extern const char *read_rtx_filename;
2234 extern int read_rtx_lineno;
2235
2236 /* Redefine abort to report an internal error w/o coredump, and
2237    reporting the location of the error in the source file.  This logic
2238    is duplicated in rtl.h and tree.h because every file that needs the
2239    special abort includes one or both.  toplev.h gets too few files,
2240    system.h gets too many.  */
2241
2242 extern void fancy_abort (const char *, int, const char *)
2243     ATTRIBUTE_NORETURN;
2244 #define abort() fancy_abort (__FILE__, __LINE__, __FUNCTION__)
2245
2246 /* In alias.c */
2247 extern void clear_reg_alias_info (rtx);
2248 extern rtx canon_rtx (rtx);
2249 extern int true_dependence (rtx, enum machine_mode, rtx, int (*)(rtx, int));
2250 extern rtx get_addr (rtx);
2251 extern int canon_true_dependence (rtx, enum machine_mode, rtx, rtx,
2252                                   int (*)(rtx, int));
2253 extern int read_dependence (rtx, rtx);
2254 extern int anti_dependence (rtx, rtx);
2255 extern int output_dependence (rtx, rtx);
2256 extern int unchanging_anti_dependence (rtx, rtx);
2257 extern void mark_constant_function (void);
2258 extern void init_alias_once (void);
2259 extern void init_alias_analysis (void);
2260 extern void end_alias_analysis (void);
2261 extern rtx addr_side_effect_eval (rtx, int, int);
2262 extern bool memory_modified_in_insn_p (rtx, rtx);
2263 extern rtx find_base_term (rtx);
2264
2265 /* In sibcall.c */
2266 typedef enum {
2267   sibcall_use_normal = 1,
2268   sibcall_use_tail_recursion,
2269   sibcall_use_sibcall
2270 } sibcall_use_t;
2271
2272 extern void optimize_sibling_and_tail_recursive_calls (void);
2273 extern void replace_call_placeholder (rtx, sibcall_use_t);
2274
2275 #ifdef STACK_REGS
2276 extern int stack_regs_mentioned (rtx insn);
2277 #endif
2278
2279 /* In toplev.c */
2280 extern GTY(()) rtx stack_limit_rtx;
2281
2282 /* In regrename.c */
2283 extern void regrename_optimize (void);
2284 extern void copyprop_hardreg_forward (void);
2285
2286 /* In ifcvt.c */
2287 extern void if_convert (int);
2288
2289 /* In predict.c */
2290 extern void invert_br_probabilities (rtx);
2291 extern bool expensive_function_p (int);
2292 /* In tracer.c */
2293 extern void tracer (void);
2294
2295 #endif /* ! GCC_RTL_H */