gcc/rtl.h

   1 /* Register Transfer Language (RTL) definitions for GCC
   2    Copyright (C) 1987, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
   3    2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
   4    Free Software Foundation, Inc.
   5
   6 This file is part of GCC.
   7
   8 GCC is free software; you can redistribute it and/or modify it under
   9 the terms of the GNU General Public License as published by the Free
  10 Software Foundation; either version 3, or (at your option) any later
  11 version.
  12
  13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16 for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with GCC; see the file COPYING3.  If not see
  20 <http://www.gnu.org/licenses/>.  */
  21
  22 #ifndef GCC_RTL_H
  23 #define GCC_RTL_H
  24
  25 #include "statistics.h"
  26 #include "machmode.h"
  27 #include "input.h"
  28 #include "real.h"
  29 #include "vec.h"
  30 #include "vecir.h"
  31 #include "fixed-value.h"
  32 #include "alias.h"
  33 #include "hashtab.h"
  34
  35 #undef FFS  /* Some systems predefine this symbol; don't let it interfere.  */
  36 #undef FLOAT /* Likewise.  */
  37 #undef ABS /* Likewise.  */
  38 #undef PC /* Likewise.  */
  39
  40 /* Value used by some passes to "recognize" noop moves as valid
  41  instructions.  */
  42 #define NOOP_MOVE_INSN_CODE     INT_MAX
  43
  44 /* Register Transfer Language EXPRESSIONS CODES */
  45
  46 #define RTX_CODE        enum rtx_code
  47 enum rtx_code  {
  48
  49 #define DEF_RTL_EXPR(ENUM, NAME, FORMAT, CLASS)   ENUM ,
  50 #include "rtl.def"              /* rtl expressions are documented here */
  51 #undef DEF_RTL_EXPR
  52
  53   LAST_AND_UNUSED_RTX_CODE};    /* A convenient way to get a value for
  54                                    NUM_RTX_CODE.
  55                                    Assumes default enum value assignment.  */
  56
  57 #define NUM_RTX_CODE ((int) LAST_AND_UNUSED_RTX_CODE)
  58                                 /* The cast here, saves many elsewhere.  */
  59
  60 /* Register Transfer Language EXPRESSIONS CODE CLASSES */
  61
  62 enum rtx_class  {
  63   /* We check bit 0-1 of some rtx class codes in the predicates below.  */
  64
  65   /* Bit 0 = comparison if 0, arithmetic is 1
  66      Bit 1 = 1 if commutative.  */
  67   RTX_COMPARE,          /* 0 */
  68   RTX_COMM_COMPARE,
  69   RTX_BIN_ARITH,
  70   RTX_COMM_ARITH,
  71
  72   /* Must follow the four preceding values.  */
  73   RTX_UNARY,            /* 4 */
  74
  75   RTX_EXTRA,
  76   RTX_MATCH,
  77   RTX_INSN,
  78
  79   /* Bit 0 = 1 if constant.  */
  80   RTX_OBJ,              /* 8 */
  81   RTX_CONST_OBJ,
  82
  83   RTX_TERNARY,
  84   RTX_BITFIELD_OPS,
  85   RTX_AUTOINC
  86 };
  87
  88 #define RTX_OBJ_MASK (~1)
  89 #define RTX_OBJ_RESULT (RTX_OBJ & RTX_OBJ_MASK)
  90 #define RTX_COMPARE_MASK (~1)
  91 #define RTX_COMPARE_RESULT (RTX_COMPARE & RTX_COMPARE_MASK)
  92 #define RTX_ARITHMETIC_MASK (~1)
  93 #define RTX_ARITHMETIC_RESULT (RTX_COMM_ARITH & RTX_ARITHMETIC_MASK)
  94 #define RTX_BINARY_MASK (~3)
  95 #define RTX_BINARY_RESULT (RTX_COMPARE & RTX_BINARY_MASK)
  96 #define RTX_COMMUTATIVE_MASK (~2)
  97 #define RTX_COMMUTATIVE_RESULT (RTX_COMM_COMPARE & RTX_COMMUTATIVE_MASK)
  98 #define RTX_NON_COMMUTATIVE_RESULT (RTX_COMPARE & RTX_COMMUTATIVE_MASK)
  99
 100 extern const unsigned char rtx_length[NUM_RTX_CODE];
 101 #define GET_RTX_LENGTH(CODE)            (rtx_length[(int) (CODE)])
 102
 103 extern const char * const rtx_name[NUM_RTX_CODE];
 104 #define GET_RTX_NAME(CODE)              (rtx_name[(int) (CODE)])
 105
 106 extern const char * const rtx_format[NUM_RTX_CODE];
 107 #define GET_RTX_FORMAT(CODE)            (rtx_format[(int) (CODE)])
 108
 109 extern const enum rtx_class rtx_class[NUM_RTX_CODE];
 110 #define GET_RTX_CLASS(CODE)             (rtx_class[(int) (CODE)])
 111
 112 extern const unsigned char rtx_code_size[NUM_RTX_CODE];
 113 extern const unsigned char rtx_next[NUM_RTX_CODE];
 114 \f
 115 /* The flags and bitfields of an ADDR_DIFF_VEC.  BASE is the base label
 116    relative to which the offsets are calculated, as explained in rtl.def.  */
 117 typedef struct
 118 {
 119   /* Set at the start of shorten_branches - ONLY WHEN OPTIMIZING - : */
 120   unsigned min_align: 8;
 121   /* Flags: */
 122   unsigned base_after_vec: 1; /* BASE is after the ADDR_DIFF_VEC.  */
 123   unsigned min_after_vec: 1;  /* minimum address target label is
 124                                  after the ADDR_DIFF_VEC.  */
 125   unsigned max_after_vec: 1;  /* maximum address target label is
 126                                  after the ADDR_DIFF_VEC.  */
 127   unsigned min_after_base: 1; /* minimum address target label is
 128                                  after BASE.  */
 129   unsigned max_after_base: 1; /* maximum address target label is
 130                                  after BASE.  */
 131   /* Set by the actual branch shortening process - ONLY WHEN OPTIMIZING - : */
 132   unsigned offset_unsigned: 1; /* offsets have to be treated as unsigned.  */
 133   unsigned : 2;
 134   unsigned scale : 8;
 135 } addr_diff_vec_flags;
 136
 137 /* Structure used to describe the attributes of a MEM.  These are hashed
 138    so MEMs that the same attributes share a data structure.  This means
 139    they cannot be modified in place.  If any element is nonzero, it means
 140    the value of the corresponding attribute is unknown.  */
 141 /* ALIGN and SIZE are the alignment and size of the MEM itself,
 142    while EXPR can describe a larger underlying object, which might have a
 143    stricter alignment; OFFSET is the offset of the MEM within that object.  */
 144 typedef struct GTY(()) mem_attrs
 145 {
 146   tree expr;                    /* expr corresponding to MEM.  */
 147   rtx offset;                   /* Offset from start of DECL, as CONST_INT.  */
 148   rtx size;                     /* Size in bytes, as a CONST_INT.  */
 149   alias_set_type alias;         /* Memory alias set.  */
 150   unsigned int align;           /* Alignment of MEM in bits.  */
 151   unsigned char addrspace;      /* Address space (0 for generic).  */
 152 } mem_attrs;
 153
 154 /* Structure used to describe the attributes of a REG in similar way as
 155    mem_attrs does for MEM above.  Note that the OFFSET field is calculated
 156    in the same way as for mem_attrs, rather than in the same way as a
 157    SUBREG_BYTE.  For example, if a big-endian target stores a byte
 158    object in the low part of a 4-byte register, the OFFSET field
 159    will be -3 rather than 0.  */
 160
 161 typedef struct GTY(()) reg_attrs {
 162   tree decl;                    /* decl corresponding to REG.  */
 163   HOST_WIDE_INT offset;         /* Offset from start of DECL.  */
 164 } reg_attrs;
 165
 166 /* Common union for an element of an rtx.  */
 167
 168 union rtunion_def
 169 {
 170   int rt_int;
 171   unsigned int rt_uint;
 172   const char *rt_str;
 173   rtx rt_rtx;
 174   rtvec rt_rtvec;
 175   enum machine_mode rt_type;
 176   addr_diff_vec_flags rt_addr_diff_vec_flags;
 177   struct cselib_val_struct *rt_cselib;
 178   tree rt_tree;
 179   struct basic_block_def *rt_bb;
 180   mem_attrs *rt_mem;
 181   reg_attrs *rt_reg;
 182   struct constant_descriptor_rtx *rt_constant;
 183   struct dw_cfi_struct *rt_cfi;
 184 };
 185 typedef union rtunion_def rtunion;
 186
 187 /* This structure remembers the position of a SYMBOL_REF within an
 188    object_block structure.  A SYMBOL_REF only provides this information
 189    if SYMBOL_REF_HAS_BLOCK_INFO_P is true.  */
 190 struct GTY(()) block_symbol {
 191   /* The usual SYMBOL_REF fields.  */
 192   rtunion GTY ((skip)) fld[3];
 193
 194   /* The block that contains this object.  */
 195   struct object_block *block;
 196
 197   /* The offset of this object from the start of its block.  It is negative
 198      if the symbol has not yet been assigned an offset.  */
 199   HOST_WIDE_INT offset;
 200 };
 201
 202 /* Describes a group of objects that are to be placed together in such
 203    a way that their relative positions are known.  */
 204 struct GTY(()) object_block {
 205   /* The section in which these objects should be placed.  */
 206   section *sect;
 207
 208   /* The alignment of the first object, measured in bits.  */
 209   unsigned int alignment;
 210
 211   /* The total size of the objects, measured in bytes.  */
 212   HOST_WIDE_INT size;
 213
 214   /* The SYMBOL_REFs for each object.  The vector is sorted in
 215      order of increasing offset and the following conditions will
 216      hold for each element X:
 217
 218          SYMBOL_REF_HAS_BLOCK_INFO_P (X)
 219          !SYMBOL_REF_ANCHOR_P (X)
 220          SYMBOL_REF_BLOCK (X) == [address of this structure]
 221          SYMBOL_REF_BLOCK_OFFSET (X) >= 0.  */
 222   VEC(rtx,gc) *objects;
 223
 224   /* All the anchor SYMBOL_REFs used to address these objects, sorted
 225      in order of increasing offset, and then increasing TLS model.
 226      The following conditions will hold for each element X in this vector:
 227
 228          SYMBOL_REF_HAS_BLOCK_INFO_P (X)
 229          SYMBOL_REF_ANCHOR_P (X)
 230          SYMBOL_REF_BLOCK (X) == [address of this structure]
 231          SYMBOL_REF_BLOCK_OFFSET (X) >= 0.  */
 232   VEC(rtx,gc) *anchors;
 233 };
 234
 235 /* RTL expression ("rtx").  */
 236
 237 struct GTY((chain_next ("RTX_NEXT (&%h)"),
 238             chain_prev ("RTX_PREV (&%h)"), variable_size)) rtx_def {
 239   /* The kind of expression this is.  */
 240   ENUM_BITFIELD(rtx_code) code: 16;
 241
 242   /* The kind of value the expression has.  */
 243   ENUM_BITFIELD(machine_mode) mode : 8;
 244
 245   /* 1 in a MEM if we should keep the alias set for this mem unchanged
 246      when we access a component.
 247      1 in a CALL_INSN if it is a sibling call.
 248      1 in a SET that is for a return.
 249      In a CODE_LABEL, part of the two-bit alternate entry field.  */
 250   unsigned int jump : 1;
 251   /* In a CODE_LABEL, part of the two-bit alternate entry field.
 252      1 in a MEM if it cannot trap.
 253      1 in a CALL_INSN logically equivalent to
 254        ECF_LOOPING_CONST_OR_PURE and DECL_LOOPING_CONST_OR_PURE_P. */
 255   unsigned int call : 1;
 256   /* 1 in a REG, MEM, or CONCAT if the value is set at most once, anywhere.
 257      1 in a SUBREG used for SUBREG_PROMOTED_UNSIGNED_P.
 258      1 in a SYMBOL_REF if it addresses something in the per-function
 259      constants pool.
 260      1 in a CALL_INSN logically equivalent to ECF_CONST and TREE_READONLY.
 261      1 in a NOTE, or EXPR_LIST for a const call.
 262      1 in a JUMP_INSN, CALL_INSN, or INSN of an annulling branch.  */
 263   unsigned int unchanging : 1;
 264   /* 1 in a MEM or ASM_OPERANDS expression if the memory reference is volatile.
 265      1 in an INSN, CALL_INSN, JUMP_INSN, CODE_LABEL, BARRIER, or NOTE
 266      if it has been deleted.
 267      1 in a REG expression if corresponds to a variable declared by the user,
 268      0 for an internally generated temporary.
 269      1 in a SUBREG used for SUBREG_PROMOTED_UNSIGNED_P.
 270      1 in a LABEL_REF, REG_LABEL_TARGET or REG_LABEL_OPERAND note for a
 271      non-local label.
 272      In a SYMBOL_REF, this flag is used for machine-specific purposes.
 273      In a PREFETCH, this flag indicates that it should be considered a scheduling
 274      barrier.  */
 275   unsigned int volatil : 1;
 276   /* 1 in a MEM referring to a field of an aggregate.
 277      0 if the MEM was a variable or the result of a * operator in C;
 278      1 if it was the result of a . or -> operator (on a struct) in C.
 279      1 in a REG if the register is used only in exit code a loop.
 280      1 in a SUBREG expression if was generated from a variable with a
 281      promoted mode.
 282      1 in a CODE_LABEL if the label is used for nonlocal gotos
 283      and must not be deleted even if its count is zero.
 284      1 in an INSN, JUMP_INSN or CALL_INSN if this insn must be scheduled
 285      together with the preceding insn.  Valid only within sched.
 286      1 in an INSN, JUMP_INSN, or CALL_INSN if insn is in a delay slot and
 287      from the target of a branch.  Valid from reorg until end of compilation;
 288      cleared before used.  */
 289   unsigned int in_struct : 1;
 290   /* At the end of RTL generation, 1 if this rtx is used.  This is used for
 291      copying shared structure.  See `unshare_all_rtl'.
 292      In a REG, this is not needed for that purpose, and used instead
 293      in `leaf_renumber_regs_insn'.
 294      1 in a SYMBOL_REF, means that emit_library_call
 295      has used it as the function.  */
 296   unsigned int used : 1;
 297   /* 1 in an INSN or a SET if this rtx is related to the call frame,
 298      either changing how we compute the frame address or saving and
 299      restoring registers in the prologue and epilogue.
 300      1 in a REG or MEM if it is a pointer.
 301      1 in a SYMBOL_REF if it addresses something in the per-function
 302      constant string pool.  */
 303   unsigned frame_related : 1;
 304   /* 1 in a REG or PARALLEL that is the current function's return value.
 305      1 in a MEM if it refers to a scalar.
 306      1 in a SYMBOL_REF for a weak symbol.
 307      1 in a CALL_INSN logically equivalent to ECF_PURE and DECL_PURE_P. */
 308   unsigned return_val : 1;
 309
 310   /* The first element of the operands of this rtx.
 311      The number of operands and their types are controlled
 312      by the `code' field, according to rtl.def.  */
 313   union u {
 314     rtunion fld[1];
 315     HOST_WIDE_INT hwint[1];
 316     struct block_symbol block_sym;
 317     struct real_value rv;
 318     struct fixed_value fv;
 319   } GTY ((special ("rtx_def"), desc ("GET_CODE (&%0)"))) u;
 320 };
 321
 322 /* The size in bytes of an rtx header (code, mode and flags).  */
 323 #define RTX_HDR_SIZE offsetof (struct rtx_def, u)
 324
 325 /* The size in bytes of an rtx with code CODE.  */
 326 #define RTX_CODE_SIZE(CODE) rtx_code_size[CODE]
 327
 328 #define NULL_RTX (rtx) 0
 329
 330 /* The "next" and "previous" RTX, relative to this one.  */
 331
 332 #define RTX_NEXT(X) (rtx_next[GET_CODE (X)] == 0 ? NULL                 \
 333                      : *(rtx *)(((char *)X) + rtx_next[GET_CODE (X)]))
 334
 335 /* FIXME: the "NEXT_INSN (PREV_INSN (X)) == X" condition shouldn't be needed.
 336  */
 337 #define RTX_PREV(X) ((INSN_P (X)                        \
 338                       || NOTE_P (X)                     \
 339                       || BARRIER_P (X)                  \
 340                       || LABEL_P (X))                   \
 341                      && PREV_INSN (X) != NULL           \
 342                      && NEXT_INSN (PREV_INSN (X)) == X  \
 343                      ? PREV_INSN (X) : NULL)
 344
 345 /* Define macros to access the `code' field of the rtx.  */
 346
 347 #define GET_CODE(RTX)       ((enum rtx_code) (RTX)->code)
 348 #define PUT_CODE(RTX, CODE) ((RTX)->code = (CODE))
 349
 350 #define GET_MODE(RTX)       ((enum machine_mode) (RTX)->mode)
 351 #define PUT_MODE(RTX, MODE) ((RTX)->mode = (MODE))
 352
 353 /* RTL vector.  These appear inside RTX's when there is a need
 354    for a variable number of things.  The principle use is inside
 355    PARALLEL expressions.  */
 356
 357 struct GTY((variable_size)) rtvec_def {
 358   int num_elem;         /* number of elements */
 359   rtx GTY ((length ("%h.num_elem"))) elem[1];
 360 };
 361
 362 #define NULL_RTVEC (rtvec) 0
 363
 364 #define GET_NUM_ELEM(RTVEC)             ((RTVEC)->num_elem)
 365 #define PUT_NUM_ELEM(RTVEC, NUM)        ((RTVEC)->num_elem = (NUM))
 366
 367 /* Predicate yielding nonzero iff X is an rtx for a register.  */
 368 #define REG_P(X) (GET_CODE (X) == REG)
 369
 370 /* Predicate yielding nonzero iff X is an rtx for a memory location.  */
 371 #define MEM_P(X) (GET_CODE (X) == MEM)
 372
 373 /* Predicate yielding nonzero iff X is an rtx for a constant integer.  */
 374 #define CONST_INT_P(X) (GET_CODE (X) == CONST_INT)
 375
 376 /* Predicate yielding true iff X is an rtx for a double-int
 377    or floating point constant.  */
 378 #define CONST_DOUBLE_P(X) (GET_CODE (X) == CONST_DOUBLE)
 379
 380 /* Predicate yielding nonzero iff X is a label insn.  */
 381 #define LABEL_P(X) (GET_CODE (X) == CODE_LABEL)
 382
 383 /* Predicate yielding nonzero iff X is a jump insn.  */
 384 #define JUMP_P(X) (GET_CODE (X) == JUMP_INSN)
 385
 386 /* Predicate yielding nonzero iff X is a call insn.  */
 387 #define CALL_P(X) (GET_CODE (X) == CALL_INSN)
 388
 389 /* Predicate yielding nonzero iff X is an insn that cannot jump.  */
 390 #define NONJUMP_INSN_P(X) (GET_CODE (X) == INSN)
 391
 392 /* Predicate yielding nonzero iff X is a debug note/insn.  */
 393 #define DEBUG_INSN_P(X) (GET_CODE (X) == DEBUG_INSN)
 394
 395 /* Predicate yielding nonzero iff X is an insn that is not a debug insn.  */
 396 #define NONDEBUG_INSN_P(X) (INSN_P (X) && !DEBUG_INSN_P (X))
 397
 398 /* Nonzero if DEBUG_INSN_P may possibly hold.  */
 399 #define MAY_HAVE_DEBUG_INSNS MAY_HAVE_DEBUG_STMTS
 400
 401 /* Predicate yielding nonzero iff X is a real insn.  */
 402 #define INSN_P(X) \
 403   (NONJUMP_INSN_P (X) || DEBUG_INSN_P (X) || JUMP_P (X) || CALL_P (X))
 404
 405 /* Predicate yielding nonzero iff X is a note insn.  */
 406 #define NOTE_P(X) (GET_CODE (X) == NOTE)
 407
 408 /* Predicate yielding nonzero iff X is a barrier insn.  */
 409 #define BARRIER_P(X) (GET_CODE (X) == BARRIER)
 410
 411 /* Predicate yielding nonzero iff X is a data for a jump table.  */
 412 #define JUMP_TABLE_DATA_P(INSN) \
 413   (JUMP_P (INSN) && (GET_CODE (PATTERN (INSN)) == ADDR_VEC || \
 414                      GET_CODE (PATTERN (INSN)) == ADDR_DIFF_VEC))
 415
 416 /* 1 if X is a unary operator.  */
 417
 418 #define UNARY_P(X)   \
 419   (GET_RTX_CLASS (GET_CODE (X)) == RTX_UNARY)
 420
 421 /* 1 if X is a binary operator.  */
 422
 423 #define BINARY_P(X)   \
 424   ((GET_RTX_CLASS (GET_CODE (X)) & RTX_BINARY_MASK) == RTX_BINARY_RESULT)
 425
 426 /* 1 if X is an arithmetic operator.  */
 427
 428 #define ARITHMETIC_P(X)   \
 429   ((GET_RTX_CLASS (GET_CODE (X)) & RTX_ARITHMETIC_MASK)                 \
 430     == RTX_ARITHMETIC_RESULT)
 431
 432 /* 1 if X is an arithmetic operator.  */
 433
 434 #define COMMUTATIVE_ARITH_P(X)   \
 435   (GET_RTX_CLASS (GET_CODE (X)) == RTX_COMM_ARITH)
 436
 437 /* 1 if X is a commutative arithmetic operator or a comparison operator.
 438    These two are sometimes selected together because it is possible to
 439    swap the two operands.  */
 440
 441 #define SWAPPABLE_OPERANDS_P(X)   \
 442   ((1 << GET_RTX_CLASS (GET_CODE (X)))                                  \
 443     & ((1 << RTX_COMM_ARITH) | (1 << RTX_COMM_COMPARE)                  \
 444        | (1 << RTX_COMPARE)))
 445
 446 /* 1 if X is a non-commutative operator.  */
 447
 448 #define NON_COMMUTATIVE_P(X)   \
 449   ((GET_RTX_CLASS (GET_CODE (X)) & RTX_COMMUTATIVE_MASK)                \
 450     == RTX_NON_COMMUTATIVE_RESULT)
 451
 452 /* 1 if X is a commutative operator on integers.  */
 453
 454 #define COMMUTATIVE_P(X)   \
 455   ((GET_RTX_CLASS (GET_CODE (X)) & RTX_COMMUTATIVE_MASK)                \
 456     == RTX_COMMUTATIVE_RESULT)
 457
 458 /* 1 if X is a relational operator.  */
 459
 460 #define COMPARISON_P(X)   \
 461   ((GET_RTX_CLASS (GET_CODE (X)) & RTX_COMPARE_MASK) == RTX_COMPARE_RESULT)
 462
 463 /* 1 if X is a constant value that is an integer.  */
 464
 465 #define CONSTANT_P(X)   \
 466   (GET_RTX_CLASS (GET_CODE (X)) == RTX_CONST_OBJ)
 467
 468 /* 1 if X can be used to represent an object.  */
 469 #define OBJECT_P(X)                                                     \
 470   ((GET_RTX_CLASS (GET_CODE (X)) & RTX_OBJ_MASK) == RTX_OBJ_RESULT)
 471
 472 /* General accessor macros for accessing the fields of an rtx.  */
 473
 474 #if defined ENABLE_RTL_CHECKING && (GCC_VERSION >= 2007)
 475 /* The bit with a star outside the statement expr and an & inside is
 476    so that N can be evaluated only once.  */
 477 #define RTL_CHECK1(RTX, N, C1) __extension__                            \
 478 (*({ __typeof (RTX) const _rtx = (RTX); const int _n = (N);             \
 479      const enum rtx_code _code = GET_CODE (_rtx);                       \
 480      if (_n < 0 || _n >= GET_RTX_LENGTH (_code))                        \
 481        rtl_check_failed_bounds (_rtx, _n, __FILE__, __LINE__,           \
 482                                 __FUNCTION__);                          \
 483      if (GET_RTX_FORMAT(_code)[_n] != C1)                               \
 484        rtl_check_failed_type1 (_rtx, _n, C1, __FILE__, __LINE__,        \
 485                                __FUNCTION__);                           \
 486      &_rtx->u.fld[_n]; }))
 487
 488 #define RTL_CHECK2(RTX, N, C1, C2) __extension__                        \
 489 (*({ __typeof (RTX) const _rtx = (RTX); const int _n = (N);             \
 490      const enum rtx_code _code = GET_CODE (_rtx);                       \
 491      if (_n < 0 || _n >= GET_RTX_LENGTH (_code))                        \
 492        rtl_check_failed_bounds (_rtx, _n, __FILE__, __LINE__,           \
 493                                 __FUNCTION__);                          \
 494      if (GET_RTX_FORMAT(_code)[_n] != C1                                \
 495          && GET_RTX_FORMAT(_code)[_n] != C2)                            \
 496        rtl_check_failed_type2 (_rtx, _n, C1, C2, __FILE__, __LINE__,    \
 497                                __FUNCTION__);                           \
 498      &_rtx->u.fld[_n]; }))
 499
 500 #define RTL_CHECKC1(RTX, N, C) __extension__                            \
 501 (*({ __typeof (RTX) const _rtx = (RTX); const int _n = (N);             \
 502      if (GET_CODE (_rtx) != (C))                                        \
 503        rtl_check_failed_code1 (_rtx, (C), __FILE__, __LINE__,           \
 504                                __FUNCTION__);                           \
 505      &_rtx->u.fld[_n]; }))
 506
 507 #define RTL_CHECKC2(RTX, N, C1, C2) __extension__                       \
 508 (*({ __typeof (RTX) const _rtx = (RTX); const int _n = (N);             \
 509      const enum rtx_code _code = GET_CODE (_rtx);                       \
 510      if (_code != (C1) && _code != (C2))                                \
 511        rtl_check_failed_code2 (_rtx, (C1), (C2), __FILE__, __LINE__,    \
 512                                __FUNCTION__); \
 513      &_rtx->u.fld[_n]; }))
 514
 515 #define RTVEC_ELT(RTVEC, I) __extension__                               \
 516 (*({ __typeof (RTVEC) const _rtvec = (RTVEC); const int _i = (I);       \
 517      if (_i < 0 || _i >= GET_NUM_ELEM (_rtvec))                         \
 518        rtvec_check_failed_bounds (_rtvec, _i, __FILE__, __LINE__,       \
 519                                   __FUNCTION__);                        \
 520      &_rtvec->elem[_i]; }))
 521
 522 #define XWINT(RTX, N) __extension__                                     \
 523 (*({ __typeof (RTX) const _rtx = (RTX); const int _n = (N);             \
 524      const enum rtx_code _code = GET_CODE (_rtx);                       \
 525      if (_n < 0 || _n >= GET_RTX_LENGTH (_code))                        \
 526        rtl_check_failed_bounds (_rtx, _n, __FILE__, __LINE__,           \
 527                                 __FUNCTION__);                          \
 528      if (GET_RTX_FORMAT(_code)[_n] != 'w')                              \
 529        rtl_check_failed_type1 (_rtx, _n, 'w', __FILE__, __LINE__,       \
 530                                __FUNCTION__);                           \
 531      &_rtx->u.hwint[_n]; }))
 532
 533 #define XCWINT(RTX, N, C) __extension__                                 \
 534 (*({ __typeof (RTX) const _rtx = (RTX);                                 \
 535      if (GET_CODE (_rtx) != (C))                                        \
 536        rtl_check_failed_code1 (_rtx, (C), __FILE__, __LINE__,           \
 537                                __FUNCTION__);                           \
 538      &_rtx->u.hwint[N]; }))
 539
 540 #define XCMWINT(RTX, N, C, M) __extension__                             \
 541 (*({ __typeof (RTX) const _rtx = (RTX);                                 \
 542      if (GET_CODE (_rtx) != (C) || GET_MODE (_rtx) != (M))              \
 543        rtl_check_failed_code_mode (_rtx, (C), (M), false, __FILE__,     \
 544                                    __LINE__, __FUNCTION__);             \
 545      &_rtx->u.hwint[N]; }))
 546
 547 #define XCNMPRV(RTX, C, M) __extension__                                \
 548 ({ __typeof (RTX) const _rtx = (RTX);                                   \
 549    if (GET_CODE (_rtx) != (C) || GET_MODE (_rtx) == (M))                \
 550      rtl_check_failed_code_mode (_rtx, (C), (M), true, __FILE__,        \
 551                                  __LINE__, __FUNCTION__);               \
 552    &_rtx->u.rv; })
 553
 554 #define XCNMPFV(RTX, C, M) __extension__                                \
 555 ({ __typeof (RTX) const _rtx = (RTX);                                   \
 556    if (GET_CODE (_rtx) != (C) || GET_MODE (_rtx) == (M))                \
 557      rtl_check_failed_code_mode (_rtx, (C), (M), true, __FILE__,        \
 558                                  __LINE__, __FUNCTION__);               \
 559    &_rtx->u.fv; })
 560
 561 #define BLOCK_SYMBOL_CHECK(RTX) __extension__                           \
 562 ({ __typeof (RTX) const _symbol = (RTX);                                \
 563    const unsigned int flags = RTL_CHECKC1 (_symbol, 1, SYMBOL_REF).rt_int; \
 564    if ((flags & SYMBOL_FLAG_HAS_BLOCK_INFO) == 0)                       \
 565      rtl_check_failed_block_symbol (__FILE__, __LINE__,                 \
 566                                     __FUNCTION__);                      \
 567    &_symbol->u.block_sym; })
 568
 569 extern void rtl_check_failed_bounds (const_rtx, int, const char *, int,
 570                                      const char *)
 571     ATTRIBUTE_NORETURN;
 572 extern void rtl_check_failed_type1 (const_rtx, int, int, const char *, int,
 573                                     const char *)
 574     ATTRIBUTE_NORETURN;
 575 extern void rtl_check_failed_type2 (const_rtx, int, int, int, const char *,
 576                                     int, const char *)
 577     ATTRIBUTE_NORETURN;
 578 extern void rtl_check_failed_code1 (const_rtx, enum rtx_code, const char *,
 579                                     int, const char *)
 580     ATTRIBUTE_NORETURN;
 581 extern void rtl_check_failed_code2 (const_rtx, enum rtx_code, enum rtx_code,
 582                                     const char *, int, const char *)
 583     ATTRIBUTE_NORETURN;
 584 extern void rtl_check_failed_code_mode (const_rtx, enum rtx_code, enum machine_mode,
 585                                         bool, const char *, int, const char *)
 586     ATTRIBUTE_NORETURN;
 587 extern void rtl_check_failed_block_symbol (const char *, int, const char *)
 588     ATTRIBUTE_NORETURN;
 589 extern void rtvec_check_failed_bounds (const_rtvec, int, const char *, int,
 590                                        const char *)
 591     ATTRIBUTE_NORETURN;
 592
 593 #else   /* not ENABLE_RTL_CHECKING */
 594
 595 #define RTL_CHECK1(RTX, N, C1)      ((RTX)->u.fld[N])
 596 #define RTL_CHECK2(RTX, N, C1, C2)  ((RTX)->u.fld[N])
 597 #define RTL_CHECKC1(RTX, N, C)      ((RTX)->u.fld[N])
 598 #define RTL_CHECKC2(RTX, N, C1, C2) ((RTX)->u.fld[N])
 599 #define RTVEC_ELT(RTVEC, I)         ((RTVEC)->elem[I])
 600 #define XWINT(RTX, N)               ((RTX)->u.hwint[N])
 601 #define XCWINT(RTX, N, C)           ((RTX)->u.hwint[N])
 602 #define XCMWINT(RTX, N, C, M)       ((RTX)->u.hwint[N])
 603 #define XCNMWINT(RTX, N, C, M)      ((RTX)->u.hwint[N])
 604 #define XCNMPRV(RTX, C, M)          (&(RTX)->u.rv)
 605 #define XCNMPFV(RTX, C, M)          (&(RTX)->u.fv)
 606 #define BLOCK_SYMBOL_CHECK(RTX)     (&(RTX)->u.block_sym)
 607
 608 #endif
 609
 610 /* General accessor macros for accessing the flags of an rtx.  */
 611
 612 /* Access an individual rtx flag, with no checking of any kind.  */
 613 #define RTX_FLAG(RTX, FLAG)     ((RTX)->FLAG)
 614
 615 #if defined ENABLE_RTL_FLAG_CHECKING && (GCC_VERSION >= 2007)
 616 #define RTL_FLAG_CHECK1(NAME, RTX, C1) __extension__                    \
 617 ({ __typeof (RTX) const _rtx = (RTX);                                   \
 618    if (GET_CODE(_rtx) != C1)                                            \
 619      rtl_check_failed_flag  (NAME, _rtx, __FILE__, __LINE__,            \
 620                              __FUNCTION__);                             \
 621    _rtx; })
 622
 623 #define RTL_FLAG_CHECK2(NAME, RTX, C1, C2) __extension__                \
 624 ({ __typeof (RTX) const _rtx = (RTX);                                   \
 625    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2)                    \
 626      rtl_check_failed_flag  (NAME,_rtx, __FILE__, __LINE__,             \
 627                               __FUNCTION__);                            \
 628    _rtx; })
 629
 630 #define RTL_FLAG_CHECK3(NAME, RTX, C1, C2, C3) __extension__            \
 631 ({ __typeof (RTX) const _rtx = (RTX);                                   \
 632    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2                     \
 633        && GET_CODE(_rtx) != C3)                                         \
 634      rtl_check_failed_flag  (NAME, _rtx, __FILE__, __LINE__,            \
 635                              __FUNCTION__);                             \
 636    _rtx; })
 637
 638 #define RTL_FLAG_CHECK4(NAME, RTX, C1, C2, C3, C4) __extension__        \
 639 ({ __typeof (RTX) const _rtx = (RTX);                                   \
 640    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2                     \
 641        && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4)                 \
 642      rtl_check_failed_flag  (NAME, _rtx, __FILE__, __LINE__,            \
 643                               __FUNCTION__);                            \
 644    _rtx; })
 645
 646 #define RTL_FLAG_CHECK5(NAME, RTX, C1, C2, C3, C4, C5) __extension__    \
 647 ({ __typeof (RTX) const _rtx = (RTX);                                   \
 648    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2                     \
 649        && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4                  \
 650        && GET_CODE(_rtx) != C5)                                         \
 651      rtl_check_failed_flag  (NAME, _rtx, __FILE__, __LINE__,            \
 652                              __FUNCTION__);                             \
 653    _rtx; })
 654
 655 #define RTL_FLAG_CHECK6(NAME, RTX, C1, C2, C3, C4, C5, C6)              \
 656   __extension__                                                         \
 657 ({ __typeof (RTX) const _rtx = (RTX);                                   \
 658    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2                     \
 659        && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4                  \
 660        && GET_CODE(_rtx) != C5 && GET_CODE(_rtx) != C6)                 \
 661      rtl_check_failed_flag  (NAME,_rtx, __FILE__, __LINE__,             \
 662                              __FUNCTION__);                             \
 663    _rtx; })
 664
 665 #define RTL_FLAG_CHECK7(NAME, RTX, C1, C2, C3, C4, C5, C6, C7)          \
 666   __extension__                                                         \
 667 ({ __typeof (RTX) const _rtx = (RTX);                                   \
 668    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2                     \
 669        && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4                  \
 670        && GET_CODE(_rtx) != C5 && GET_CODE(_rtx) != C6                  \
 671        && GET_CODE(_rtx) != C7)                                         \
 672      rtl_check_failed_flag  (NAME, _rtx, __FILE__, __LINE__,            \
 673                              __FUNCTION__);                             \
 674    _rtx; })
 675
 676 #define RTL_FLAG_CHECK8(NAME, RTX, C1, C2, C3, C4, C5, C6, C7, C8)      \
 677   __extension__                                                         \
 678 ({ __typeof (RTX) const _rtx = (RTX);                                   \
 679    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2                     \
 680        && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4                  \
 681        && GET_CODE(_rtx) != C5 && GET_CODE(_rtx) != C6                  \
 682        && GET_CODE(_rtx) != C7 && GET_CODE(_rtx) != C8)                 \
 683      rtl_check_failed_flag  (NAME, _rtx, __FILE__, __LINE__,            \
 684                              __FUNCTION__);                             \
 685    _rtx; })
 686
 687 extern void rtl_check_failed_flag (const char *, const_rtx, const char *,
 688                                    int, const char *)
 689     ATTRIBUTE_NORETURN
 690     ;
 691
 692 #else   /* not ENABLE_RTL_FLAG_CHECKING */
 693
 694 #define RTL_FLAG_CHECK1(NAME, RTX, C1)                                  (RTX)
 695 #define RTL_FLAG_CHECK2(NAME, RTX, C1, C2)                              (RTX)
 696 #define RTL_FLAG_CHECK3(NAME, RTX, C1, C2, C3)                          (RTX)
 697 #define RTL_FLAG_CHECK4(NAME, RTX, C1, C2, C3, C4)                      (RTX)
 698 #define RTL_FLAG_CHECK5(NAME, RTX, C1, C2, C3, C4, C5)          (RTX)
 699 #define RTL_FLAG_CHECK6(NAME, RTX, C1, C2, C3, C4, C5, C6)              (RTX)
 700 #define RTL_FLAG_CHECK7(NAME, RTX, C1, C2, C3, C4, C5, C6, C7)          (RTX)
 701 #define RTL_FLAG_CHECK8(NAME, RTX, C1, C2, C3, C4, C5, C6, C7, C8)      (RTX)
 702 #endif
 703
 704 #define XINT(RTX, N)    (RTL_CHECK2 (RTX, N, 'i', 'n').rt_int)
 705 #define XSTR(RTX, N)    (RTL_CHECK2 (RTX, N, 's', 'S').rt_str)
 706 #define XEXP(RTX, N)    (RTL_CHECK2 (RTX, N, 'e', 'u').rt_rtx)
 707 #define XVEC(RTX, N)    (RTL_CHECK2 (RTX, N, 'E', 'V').rt_rtvec)
 708 #define XMODE(RTX, N)   (RTL_CHECK1 (RTX, N, 'M').rt_type)
 709 #define XTREE(RTX, N)   (RTL_CHECK1 (RTX, N, 't').rt_tree)
 710 #define XBBDEF(RTX, N)  (RTL_CHECK1 (RTX, N, 'B').rt_bb)
 711 #define XTMPL(RTX, N)   (RTL_CHECK1 (RTX, N, 'T').rt_str)
 712 #define XCFI(RTX, N)    (RTL_CHECK1 (RTX, N, 'C').rt_cfi)
 713
 714 #define XVECEXP(RTX, N, M)      RTVEC_ELT (XVEC (RTX, N), M)
 715 #define XVECLEN(RTX, N)         GET_NUM_ELEM (XVEC (RTX, N))
 716
 717 /* These are like XINT, etc. except that they expect a '0' field instead
 718    of the normal type code.  */
 719
 720 #define X0INT(RTX, N)      (RTL_CHECK1 (RTX, N, '0').rt_int)
 721 #define X0UINT(RTX, N)     (RTL_CHECK1 (RTX, N, '0').rt_uint)
 722 #define X0STR(RTX, N)      (RTL_CHECK1 (RTX, N, '0').rt_str)
 723 #define X0EXP(RTX, N)      (RTL_CHECK1 (RTX, N, '0').rt_rtx)
 724 #define X0VEC(RTX, N)      (RTL_CHECK1 (RTX, N, '0').rt_rtvec)
 725 #define X0MODE(RTX, N)     (RTL_CHECK1 (RTX, N, '0').rt_type)
 726 #define X0TREE(RTX, N)     (RTL_CHECK1 (RTX, N, '0').rt_tree)
 727 #define X0BBDEF(RTX, N)    (RTL_CHECK1 (RTX, N, '0').rt_bb)
 728 #define X0ADVFLAGS(RTX, N) (RTL_CHECK1 (RTX, N, '0').rt_addr_diff_vec_flags)
 729 #define X0CSELIB(RTX, N)   (RTL_CHECK1 (RTX, N, '0').rt_cselib)
 730 #define X0MEMATTR(RTX, N)  (RTL_CHECKC1 (RTX, N, MEM).rt_mem)
 731 #define X0REGATTR(RTX, N)  (RTL_CHECKC1 (RTX, N, REG).rt_reg)
 732 #define X0CONSTANT(RTX, N) (RTL_CHECK1 (RTX, N, '0').rt_constant)
 733
 734 /* Access a '0' field with any type.  */
 735 #define X0ANY(RTX, N)      RTL_CHECK1 (RTX, N, '0')
 736
 737 #define XCINT(RTX, N, C)      (RTL_CHECKC1 (RTX, N, C).rt_int)
 738 #define XCUINT(RTX, N, C)     (RTL_CHECKC1 (RTX, N, C).rt_uint)
 739 #define XCSTR(RTX, N, C)      (RTL_CHECKC1 (RTX, N, C).rt_str)
 740 #define XCEXP(RTX, N, C)      (RTL_CHECKC1 (RTX, N, C).rt_rtx)
 741 #define XCVEC(RTX, N, C)      (RTL_CHECKC1 (RTX, N, C).rt_rtvec)
 742 #define XCMODE(RTX, N, C)     (RTL_CHECKC1 (RTX, N, C).rt_type)
 743 #define XCTREE(RTX, N, C)     (RTL_CHECKC1 (RTX, N, C).rt_tree)
 744 #define XCBBDEF(RTX, N, C)    (RTL_CHECKC1 (RTX, N, C).rt_bb)
 745 #define XCCFI(RTX, N, C)      (RTL_CHECKC1 (RTX, N, C).rt_cfi)
 746 #define XCCSELIB(RTX, N, C)   (RTL_CHECKC1 (RTX, N, C).rt_cselib)
 747
 748 #define XCVECEXP(RTX, N, M, C)  RTVEC_ELT (XCVEC (RTX, N, C), M)
 749 #define XCVECLEN(RTX, N, C)     GET_NUM_ELEM (XCVEC (RTX, N, C))
 750
 751 #define XC2EXP(RTX, N, C1, C2)      (RTL_CHECKC2 (RTX, N, C1, C2).rt_rtx)
 752 \f
 753 /* ACCESS MACROS for particular fields of insns.  */
 754
 755 /* Holds a unique number for each insn.
 756    These are not necessarily sequentially increasing.  */
 757 #define INSN_UID(INSN)  XINT (INSN, 0)
 758
 759 /* Chain insns together in sequence.  */
 760 #define PREV_INSN(INSN) XEXP (INSN, 1)
 761 #define NEXT_INSN(INSN) XEXP (INSN, 2)
 762
 763 #define BLOCK_FOR_INSN(INSN) XBBDEF (INSN, 3)
 764
 765 /* The body of an insn.  */
 766 #define PATTERN(INSN)   XEXP (INSN, 4)
 767
 768 #define INSN_LOCATOR(INSN) XINT (INSN, 5)
 769 /* LOCATION of an RTX if relevant.  */
 770 #define RTL_LOCATION(X) (INSN_P (X) ? \
 771                          locator_location (INSN_LOCATOR (X)) \
 772                          : UNKNOWN_LOCATION)
 773 /* LOCATION of current INSN.  */
 774 #define CURR_INSN_LOCATION (locator_location (curr_insn_locator ()))
 775
 776 /* Code number of instruction, from when it was recognized.
 777    -1 means this instruction has not been recognized yet.  */
 778 #define INSN_CODE(INSN) XINT (INSN, 6)
 779
 780 #define RTX_FRAME_RELATED_P(RTX)                                        \
 781   (RTL_FLAG_CHECK6("RTX_FRAME_RELATED_P", (RTX), DEBUG_INSN, INSN,      \
 782                    CALL_INSN, JUMP_INSN, BARRIER, SET)->frame_related)
 783
 784 /* 1 if RTX is an insn that has been deleted.  */
 785 #define INSN_DELETED_P(RTX)                                             \
 786   (RTL_FLAG_CHECK7("INSN_DELETED_P", (RTX), DEBUG_INSN, INSN,           \
 787                    CALL_INSN, JUMP_INSN,                                \
 788                    CODE_LABEL, BARRIER, NOTE)->volatil)
 789
 790 /* 1 if RTX is a call to a const function.  Built from ECF_CONST and
 791    TREE_READONLY.  */
 792 #define RTL_CONST_CALL_P(RTX)                                   \
 793   (RTL_FLAG_CHECK1("RTL_CONST_CALL_P", (RTX), CALL_INSN)->unchanging)
 794
 795 /* 1 if RTX is a call to a pure function.  Built from ECF_PURE and
 796    DECL_PURE_P.  */
 797 #define RTL_PURE_CALL_P(RTX)                                    \
 798   (RTL_FLAG_CHECK1("RTL_PURE_CALL_P", (RTX), CALL_INSN)->return_val)
 799
 800 /* 1 if RTX is a call to a const or pure function.  */
 801 #define RTL_CONST_OR_PURE_CALL_P(RTX) \
 802   (RTL_CONST_CALL_P(RTX) || RTL_PURE_CALL_P(RTX))
 803
 804 /* 1 if RTX is a call to a looping const or pure function.  Built from
 805    ECF_LOOPING_CONST_OR_PURE and DECL_LOOPING_CONST_OR_PURE_P.  */
 806 #define RTL_LOOPING_CONST_OR_PURE_CALL_P(RTX)                                   \
 807   (RTL_FLAG_CHECK1("CONST_OR_PURE_CALL_P", (RTX), CALL_INSN)->call)
 808
 809 /* 1 if RTX is a call_insn for a sibling call.  */
 810 #define SIBLING_CALL_P(RTX)                                             \
 811   (RTL_FLAG_CHECK1("SIBLING_CALL_P", (RTX), CALL_INSN)->jump)
 812
 813 /* 1 if RTX is a jump_insn, call_insn, or insn that is an annulling branch.  */
 814 #define INSN_ANNULLED_BRANCH_P(RTX)                                     \
 815   (RTL_FLAG_CHECK3("INSN_ANNULLED_BRANCH_P", (RTX), JUMP_INSN, CALL_INSN, INSN)->unchanging)
 816
 817 /* 1 if RTX is an insn in a delay slot and is from the target of the branch.
 818    If the branch insn has INSN_ANNULLED_BRANCH_P set, this insn should only be
 819    executed if the branch is taken.  For annulled branches with this bit
 820    clear, the insn should be executed only if the branch is not taken.  */
 821 #define INSN_FROM_TARGET_P(RTX)                                         \
 822   (RTL_FLAG_CHECK3("INSN_FROM_TARGET_P", (RTX), INSN, JUMP_INSN, CALL_INSN)->in_struct)
 823
 824 /* In an ADDR_DIFF_VEC, the flags for RTX for use by branch shortening.
 825    See the comments for ADDR_DIFF_VEC in rtl.def.  */
 826 #define ADDR_DIFF_VEC_FLAGS(RTX) X0ADVFLAGS(RTX, 4)
 827
 828 /* In a VALUE, the value cselib has assigned to RTX.
 829    This is a "struct cselib_val_struct", see cselib.h.  */
 830 #define CSELIB_VAL_PTR(RTX) X0CSELIB(RTX, 0)
 831
 832 /* Holds a list of notes on what this insn does to various REGs.
 833    It is a chain of EXPR_LIST rtx's, where the second operand is the
 834    chain pointer and the first operand is the REG being described.
 835    The mode field of the EXPR_LIST contains not a real machine mode
 836    but a value from enum reg_note.  */
 837 #define REG_NOTES(INSN) XEXP(INSN, 7)
 838
 839 /* In an ENTRY_VALUE this is the DECL_INCOMING_RTL of the argument in
 840    question.  */
 841 #define ENTRY_VALUE_EXP(RTX) (RTL_CHECKC1 (RTX, 0, ENTRY_VALUE).rt_rtx)
 842
 843 enum reg_note
 844 {
 845 #define DEF_REG_NOTE(NAME) NAME,
 846 #include "reg-notes.def"
 847 #undef DEF_REG_NOTE
 848   REG_NOTE_MAX
 849 };
 850
 851 /* Define macros to extract and insert the reg-note kind in an EXPR_LIST.  */
 852 #define REG_NOTE_KIND(LINK) ((enum reg_note) GET_MODE (LINK))
 853 #define PUT_REG_NOTE_KIND(LINK, KIND) \
 854   PUT_MODE (LINK, (enum machine_mode) (KIND))
 855
 856 /* Names for REG_NOTE's in EXPR_LIST insn's.  */
 857
 858 extern const char * const reg_note_name[];
 859 #define GET_REG_NOTE_NAME(MODE) (reg_note_name[(int) (MODE)])
 860
 861 /* This field is only present on CALL_INSNs.  It holds a chain of EXPR_LIST of
 862    USE and CLOBBER expressions.
 863      USE expressions list the registers filled with arguments that
 864    are passed to the function.
 865      CLOBBER expressions document the registers explicitly clobbered
 866    by this CALL_INSN.
 867      Pseudo registers can not be mentioned in this list.  */
 868 #define CALL_INSN_FUNCTION_USAGE(INSN)  XEXP(INSN, 8)
 869
 870 /* The label-number of a code-label.  The assembler label
 871    is made from `L' and the label-number printed in decimal.
 872    Label numbers are unique in a compilation.  */
 873 #define CODE_LABEL_NUMBER(INSN) XINT (INSN, 6)
 874
 875 /* In a NOTE that is a line number, this is a string for the file name that the
 876    line is in.  We use the same field to record block numbers temporarily in
 877    NOTE_INSN_BLOCK_BEG and NOTE_INSN_BLOCK_END notes.  (We avoid lots of casts
 878    between ints and pointers if we use a different macro for the block number.)
 879    */
 880
 881 /* Opaque data.  */
 882 #define NOTE_DATA(INSN)         RTL_CHECKC1 (INSN, 4, NOTE)
 883 #define NOTE_DELETED_LABEL_NAME(INSN) XCSTR (INSN, 4, NOTE)
 884 #define SET_INSN_DELETED(INSN) set_insn_deleted (INSN);
 885 #define NOTE_BLOCK(INSN)        XCTREE (INSN, 4, NOTE)
 886 #define NOTE_EH_HANDLER(INSN)   XCINT (INSN, 4, NOTE)
 887 #define NOTE_BASIC_BLOCK(INSN)  XCBBDEF (INSN, 4, NOTE)
 888 #define NOTE_VAR_LOCATION(INSN) XCEXP (INSN, 4, NOTE)
 889 #define NOTE_CFI(INSN)          XCCFI (INSN, 4, NOTE)
 890 #define NOTE_LABEL_NUMBER(INSN) XCINT (INSN, 4, NOTE)
 891
 892 /* In a NOTE that is a line number, this is the line number.
 893    Other kinds of NOTEs are identified by negative numbers here.  */
 894 #define NOTE_KIND(INSN) XCINT (INSN, 5, NOTE)
 895
 896 /* Nonzero if INSN is a note marking the beginning of a basic block.  */
 897 #define NOTE_INSN_BASIC_BLOCK_P(INSN)                   \
 898   (GET_CODE (INSN) == NOTE                              \
 899    && NOTE_KIND (INSN) == NOTE_INSN_BASIC_BLOCK)
 900
 901 /* Variable declaration and the location of a variable.  */
 902 #define PAT_VAR_LOCATION_DECL(PAT) (XCTREE ((PAT), 0, VAR_LOCATION))
 903 #define PAT_VAR_LOCATION_LOC(PAT) (XCEXP ((PAT), 1, VAR_LOCATION))
 904
 905 /* Initialization status of the variable in the location.  Status
 906    can be unknown, uninitialized or initialized.  See enumeration
 907    type below.  */
 908 #define PAT_VAR_LOCATION_STATUS(PAT) \
 909   ((enum var_init_status) (XCINT ((PAT), 2, VAR_LOCATION)))
 910
 911 /* Accessors for a NOTE_INSN_VAR_LOCATION.  */
 912 #define NOTE_VAR_LOCATION_DECL(NOTE) \
 913   PAT_VAR_LOCATION_DECL (NOTE_VAR_LOCATION (NOTE))
 914 #define NOTE_VAR_LOCATION_LOC(NOTE) \
 915   PAT_VAR_LOCATION_LOC (NOTE_VAR_LOCATION (NOTE))
 916 #define NOTE_VAR_LOCATION_STATUS(NOTE) \
 917   PAT_VAR_LOCATION_STATUS (NOTE_VAR_LOCATION (NOTE))
 918
 919 /* The VAR_LOCATION rtx in a DEBUG_INSN.  */
 920 #define INSN_VAR_LOCATION(INSN) PATTERN (INSN)
 921
 922 /* Accessors for a tree-expanded var location debug insn.  */
 923 #define INSN_VAR_LOCATION_DECL(INSN) \
 924   PAT_VAR_LOCATION_DECL (INSN_VAR_LOCATION (INSN))
 925 #define INSN_VAR_LOCATION_LOC(INSN) \
 926   PAT_VAR_LOCATION_LOC (INSN_VAR_LOCATION (INSN))
 927 #define INSN_VAR_LOCATION_STATUS(INSN) \
 928   PAT_VAR_LOCATION_STATUS (INSN_VAR_LOCATION (INSN))
 929
 930 /* Expand to the RTL that denotes an unknown variable location in a
 931    DEBUG_INSN.  */
 932 #define gen_rtx_UNKNOWN_VAR_LOC() (gen_rtx_CLOBBER (VOIDmode, const0_rtx))
 933
 934 /* Determine whether X is such an unknown location.  */
 935 #define VAR_LOC_UNKNOWN_P(X) \
 936   (GET_CODE (X) == CLOBBER && XEXP ((X), 0) == const0_rtx)
 937
 938 /* 1 if RTX is emitted after a call, but it should take effect before
 939    the call returns.  */
 940 #define NOTE_DURING_CALL_P(RTX)                         \
 941   (RTL_FLAG_CHECK1("NOTE_VAR_LOCATION_DURING_CALL_P", (RTX), NOTE)->call)
 942
 943 /* DEBUG_EXPR_DECL corresponding to a DEBUG_EXPR RTX.  */
 944 #define DEBUG_EXPR_TREE_DECL(RTX) XCTREE (RTX, 0, DEBUG_EXPR)
 945
 946 /* VAR_DECL/PARM_DECL DEBUG_IMPLICIT_PTR takes address of.  */
 947 #define DEBUG_IMPLICIT_PTR_DECL(RTX) XCTREE (RTX, 0, DEBUG_IMPLICIT_PTR)
 948
 949 /* PARM_DECL DEBUG_PARAMETER_REF references.  */
 950 #define DEBUG_PARAMETER_REF_DECL(RTX) XCTREE (RTX, 0, DEBUG_PARAMETER_REF)
 951
 952 /* Codes that appear in the NOTE_KIND field for kinds of notes
 953    that are not line numbers.  These codes are all negative.
 954
 955    Notice that we do not try to use zero here for any of
 956    the special note codes because sometimes the source line
 957    actually can be zero!  This happens (for example) when we
 958    are generating code for the per-translation-unit constructor
 959    and destructor routines for some C++ translation unit.  */
 960
 961 enum insn_note
 962 {
 963 #define DEF_INSN_NOTE(NAME) NAME,
 964 #include "insn-notes.def"
 965 #undef DEF_INSN_NOTE
 966
 967   NOTE_INSN_MAX
 968 };
 969
 970 /* Names for NOTE insn's other than line numbers.  */
 971
 972 extern const char * const note_insn_name[NOTE_INSN_MAX];
 973 #define GET_NOTE_INSN_NAME(NOTE_CODE) \
 974   (note_insn_name[(NOTE_CODE)])
 975
 976 /* The name of a label, in case it corresponds to an explicit label
 977    in the input source code.  */
 978 #define LABEL_NAME(RTX) XCSTR (RTX, 7, CODE_LABEL)
 979
 980 /* In jump.c, each label contains a count of the number
 981    of LABEL_REFs that point at it, so unused labels can be deleted.  */
 982 #define LABEL_NUSES(RTX) XCINT (RTX, 5, CODE_LABEL)
 983
 984 /* Labels carry a two-bit field composed of the ->jump and ->call
 985    bits.  This field indicates whether the label is an alternate
 986    entry point, and if so, what kind.  */
 987 enum label_kind
 988 {
 989   LABEL_NORMAL = 0,     /* ordinary label */
 990   LABEL_STATIC_ENTRY,   /* alternate entry point, not exported */
 991   LABEL_GLOBAL_ENTRY,   /* alternate entry point, exported */
 992   LABEL_WEAK_ENTRY      /* alternate entry point, exported as weak symbol */
 993 };
 994
 995 #if defined ENABLE_RTL_FLAG_CHECKING && (GCC_VERSION > 2007)
 996
 997 /* Retrieve the kind of LABEL.  */
 998 #define LABEL_KIND(LABEL) __extension__                                 \
 999 ({ __typeof (LABEL) const _label = (LABEL);                             \
1000    if (GET_CODE (_label) != CODE_LABEL)                                 \
1001      rtl_check_failed_flag ("LABEL_KIND", _label, __FILE__, __LINE__,   \
1002                             __FUNCTION__);                              \
1003    (enum label_kind) ((_label->jump << 1) | _label->call); })
1004
1005 /* Set the kind of LABEL.  */
1006 #define SET_LABEL_KIND(LABEL, KIND) do {                                \
1007    __typeof (LABEL) const _label = (LABEL);                             \
1008    const unsigned int _kind = (KIND);                                   \
1009    if (GET_CODE (_label) != CODE_LABEL)                                 \
1010      rtl_check_failed_flag ("SET_LABEL_KIND", _label, __FILE__, __LINE__, \
1011                             __FUNCTION__);                              \
1012    _label->jump = ((_kind >> 1) & 1);                                   \
1013    _label->call = (_kind & 1);                                          \
1014 } while (0)
1015
1016 #else
1017
1018 /* Retrieve the kind of LABEL.  */
1019 #define LABEL_KIND(LABEL) \
1020    ((enum label_kind) (((LABEL)->jump << 1) | (LABEL)->call))
1021
1022 /* Set the kind of LABEL.  */
1023 #define SET_LABEL_KIND(LABEL, KIND) do {                                \
1024    rtx const _label = (LABEL);                                          \
1025    const unsigned int _kind = (KIND);                                   \
1026    _label->jump = ((_kind >> 1) & 1);                                   \
1027    _label->call = (_kind & 1);                                          \
1028 } while (0)
1029
1030 #endif /* rtl flag checking */
1031
1032 #define LABEL_ALT_ENTRY_P(LABEL) (LABEL_KIND (LABEL) != LABEL_NORMAL)
1033
1034 /* In jump.c, each JUMP_INSN can point to a label that it can jump to,
1035    so that if the JUMP_INSN is deleted, the label's LABEL_NUSES can
1036    be decremented and possibly the label can be deleted.  */
1037 #define JUMP_LABEL(INSN)   XCEXP (INSN, 8, JUMP_INSN)
1038
1039 /* Once basic blocks are found, each CODE_LABEL starts a chain that
1040    goes through all the LABEL_REFs that jump to that label.  The chain
1041    eventually winds up at the CODE_LABEL: it is circular.  */
1042 #define LABEL_REFS(LABEL) XCEXP (LABEL, 4, CODE_LABEL)
1043 \f
1044 /* For a REG rtx, REGNO extracts the register number.  REGNO can only
1045    be used on RHS.  Use SET_REGNO to change the value.  */
1046 #define REGNO(RTX) (rhs_regno(RTX))
1047 #define SET_REGNO(RTX,N) (df_ref_change_reg_with_loc (REGNO(RTX), N, RTX), XCUINT (RTX, 0, REG) = N)
1048 #define SET_REGNO_RAW(RTX,N) (XCUINT (RTX, 0, REG) = N)
1049
1050 /* ORIGINAL_REGNO holds the number the register originally had; for a
1051    pseudo register turned into a hard reg this will hold the old pseudo
1052    register number.  */
1053 #define ORIGINAL_REGNO(RTX) X0UINT (RTX, 1)
1054
1055 /* Force the REGNO macro to only be used on the lhs.  */
1056 static inline unsigned int
1057 rhs_regno (const_rtx x)
1058 {
1059   return XCUINT (x, 0, REG);
1060 }
1061
1062
1063 /* 1 if RTX is a reg or parallel that is the current function's return
1064    value.  */
1065 #define REG_FUNCTION_VALUE_P(RTX)                                       \
1066   (RTL_FLAG_CHECK2("REG_FUNCTION_VALUE_P", (RTX), REG, PARALLEL)->return_val)
1067
1068 /* 1 if RTX is a reg that corresponds to a variable declared by the user.  */
1069 #define REG_USERVAR_P(RTX)                                              \
1070   (RTL_FLAG_CHECK1("REG_USERVAR_P", (RTX), REG)->volatil)
1071
1072 /* 1 if RTX is a reg that holds a pointer value.  */
1073 #define REG_POINTER(RTX)                                                \
1074   (RTL_FLAG_CHECK1("REG_POINTER", (RTX), REG)->frame_related)
1075
1076 /* 1 if RTX is a mem that holds a pointer value.  */
1077 #define MEM_POINTER(RTX)                                                \
1078   (RTL_FLAG_CHECK1("MEM_POINTER", (RTX), MEM)->frame_related)
1079
1080 /* 1 if the given register REG corresponds to a hard register.  */
1081 #define HARD_REGISTER_P(REG) (HARD_REGISTER_NUM_P (REGNO (REG)))
1082
1083 /* 1 if the given register number REG_NO corresponds to a hard register.  */
1084 #define HARD_REGISTER_NUM_P(REG_NO) ((REG_NO) < FIRST_PSEUDO_REGISTER)
1085
1086 /* For a CONST_INT rtx, INTVAL extracts the integer.  */
1087 #define INTVAL(RTX) XCWINT(RTX, 0, CONST_INT)
1088 #define UINTVAL(RTX) ((unsigned HOST_WIDE_INT) INTVAL (RTX))
1089
1090 /* For a CONST_DOUBLE:
1091    For a VOIDmode, there are two integers CONST_DOUBLE_LOW is the
1092      low-order word and ..._HIGH the high-order.
1093    For a float, there is a REAL_VALUE_TYPE structure, and
1094      CONST_DOUBLE_REAL_VALUE(r) is a pointer to it.  */
1095 #define CONST_DOUBLE_LOW(r) XCMWINT (r, 0, CONST_DOUBLE, VOIDmode)
1096 #define CONST_DOUBLE_HIGH(r) XCMWINT (r, 1, CONST_DOUBLE, VOIDmode)
1097 #define CONST_DOUBLE_REAL_VALUE(r) \
1098   ((const struct real_value *) XCNMPRV (r, CONST_DOUBLE, VOIDmode))
1099
1100 #define CONST_FIXED_VALUE(r) \
1101   ((const struct fixed_value *) XCNMPFV (r, CONST_FIXED, VOIDmode))
1102 #define CONST_FIXED_VALUE_HIGH(r) \
1103   ((HOST_WIDE_INT) (CONST_FIXED_VALUE(r)->data.high))
1104 #define CONST_FIXED_VALUE_LOW(r) \
1105   ((HOST_WIDE_INT) (CONST_FIXED_VALUE(r)->data.low))
1106
1107 /* For a CONST_VECTOR, return element #n.  */
1108 #define CONST_VECTOR_ELT(RTX, N) XCVECEXP (RTX, 0, N, CONST_VECTOR)
1109
1110 /* For a CONST_VECTOR, return the number of elements in a vector.  */
1111 #define CONST_VECTOR_NUNITS(RTX) XCVECLEN (RTX, 0, CONST_VECTOR)
1112
1113 /* For a SUBREG rtx, SUBREG_REG extracts the value we want a subreg of.
1114    SUBREG_BYTE extracts the byte-number.  */
1115
1116 #define SUBREG_REG(RTX) XCEXP (RTX, 0, SUBREG)
1117 #define SUBREG_BYTE(RTX) XCUINT (RTX, 1, SUBREG)
1118
1119 /* in rtlanal.c */
1120 /* Return the right cost to give to an operation
1121    to make the cost of the corresponding register-to-register instruction
1122    N times that of a fast register-to-register instruction.  */
1123 #define COSTS_N_INSNS(N) ((N) * 4)
1124
1125 /* Maximum cost of an rtl expression.  This value has the special meaning
1126    not to use an rtx with this cost under any circumstances.  */
1127 #define MAX_COST INT_MAX
1128
1129 /* A structure to hold all available cost information about an rtl
1130    expression.  */
1131 struct full_rtx_costs
1132 {
1133   int speed;
1134   int size;
1135 };
1136
1137 /* Initialize a full_rtx_costs structure C to the maximum cost.  */
1138 static inline void
1139 init_costs_to_max (struct full_rtx_costs *c)
1140 {
1141   c->speed = MAX_COST;
1142   c->size = MAX_COST;
1143 }
1144
1145 /* Initialize a full_rtx_costs structure C to zero cost.  */
1146 static inline void
1147 init_costs_to_zero (struct full_rtx_costs *c)
1148 {
1149   c->speed = 0;
1150   c->size = 0;
1151 }
1152
1153 /* Compare two full_rtx_costs structures A and B, returning true
1154    if A < B when optimizing for speed.  */
1155 static inline bool
1156 costs_lt_p (struct full_rtx_costs *a, struct full_rtx_costs *b,
1157             bool speed)
1158 {
1159   if (speed)
1160     return (a->speed < b->speed
1161             || (a->speed == b->speed && a->size < b->size));
1162   else
1163     return (a->size < b->size
1164             || (a->size == b->size && a->speed < b->speed));
1165 }
1166
1167 /* Increase both members of the full_rtx_costs structure C by the
1168    cost of N insns.  */
1169 static inline void
1170 costs_add_n_insns (struct full_rtx_costs *c, int n)
1171 {
1172   c->speed += COSTS_N_INSNS (n);
1173   c->size += COSTS_N_INSNS (n);
1174 }
1175
1176 extern void init_rtlanal (void);
1177 extern int rtx_cost (rtx, enum rtx_code, bool);
1178 extern int address_cost (rtx, enum machine_mode, addr_space_t, bool);
1179 extern void get_full_rtx_cost (rtx, enum rtx_code, struct full_rtx_costs *);
1180 extern unsigned int subreg_lsb (const_rtx);
1181 extern unsigned int subreg_lsb_1 (enum machine_mode, enum machine_mode,
1182                                   unsigned int);
1183 extern unsigned int subreg_regno_offset (unsigned int, enum machine_mode,
1184                                          unsigned int, enum machine_mode);
1185 extern bool subreg_offset_representable_p (unsigned int, enum machine_mode,
1186                                            unsigned int, enum machine_mode);
1187 extern unsigned int subreg_regno (const_rtx);
1188 extern int simplify_subreg_regno (unsigned int, enum machine_mode,
1189                                   unsigned int, enum machine_mode);
1190 extern unsigned int subreg_nregs (const_rtx);
1191 extern unsigned int subreg_nregs_with_regno (unsigned int, const_rtx);
1192 extern unsigned HOST_WIDE_INT nonzero_bits (const_rtx, enum machine_mode);
1193 extern unsigned int num_sign_bit_copies (const_rtx, enum machine_mode);
1194 extern bool constant_pool_constant_p (rtx);
1195 extern bool truncated_to_mode (enum machine_mode, const_rtx);
1196 extern int low_bitmask_len (enum machine_mode, unsigned HOST_WIDE_INT);
1197
1198
1199 /* 1 if RTX is a subreg containing a reg that is already known to be
1200    sign- or zero-extended from the mode of the subreg to the mode of
1201    the reg.  SUBREG_PROMOTED_UNSIGNED_P gives the signedness of the
1202    extension.
1203
1204    When used as a LHS, is means that this extension must be done
1205    when assigning to SUBREG_REG.  */
1206
1207 #define SUBREG_PROMOTED_VAR_P(RTX)                                      \
1208   (RTL_FLAG_CHECK1("SUBREG_PROMOTED", (RTX), SUBREG)->in_struct)
1209
1210 #define SUBREG_PROMOTED_UNSIGNED_SET(RTX, VAL)                          \
1211 do {                                                                    \
1212   rtx const _rtx = RTL_FLAG_CHECK1("SUBREG_PROMOTED_UNSIGNED_SET", (RTX), SUBREG); \
1213   if ((VAL) < 0)                                                        \
1214     _rtx->volatil = 1;                                                  \
1215   else {                                                                \
1216     _rtx->volatil = 0;                                                  \
1217     _rtx->unchanging = (VAL);                                           \
1218   }                                                                     \
1219 } while (0)
1220
1221 /* Valid for subregs which are SUBREG_PROMOTED_VAR_P().  In that case
1222    this gives the necessary extensions:
1223    0  - signed
1224    1  - normal unsigned
1225    -1 - pointer unsigned, which most often can be handled like unsigned
1226         extension, except for generating instructions where we need to
1227         emit special code (ptr_extend insns) on some architectures.  */
1228
1229 #define SUBREG_PROMOTED_UNSIGNED_P(RTX) \
1230   ((RTL_FLAG_CHECK1("SUBREG_PROMOTED_UNSIGNED_P", (RTX), SUBREG)->volatil) \
1231    ? -1 : (int) (RTX)->unchanging)
1232
1233 /* Access various components of an ASM_OPERANDS rtx.  */
1234
1235 #define ASM_OPERANDS_TEMPLATE(RTX) XCSTR (RTX, 0, ASM_OPERANDS)
1236 #define ASM_OPERANDS_OUTPUT_CONSTRAINT(RTX) XCSTR (RTX, 1, ASM_OPERANDS)
1237 #define ASM_OPERANDS_OUTPUT_IDX(RTX) XCINT (RTX, 2, ASM_OPERANDS)
1238 #define ASM_OPERANDS_INPUT_VEC(RTX) XCVEC (RTX, 3, ASM_OPERANDS)
1239 #define ASM_OPERANDS_INPUT_CONSTRAINT_VEC(RTX) XCVEC (RTX, 4, ASM_OPERANDS)
1240 #define ASM_OPERANDS_INPUT(RTX, N) XCVECEXP (RTX, 3, N, ASM_OPERANDS)
1241 #define ASM_OPERANDS_INPUT_LENGTH(RTX) XCVECLEN (RTX, 3, ASM_OPERANDS)
1242 #define ASM_OPERANDS_INPUT_CONSTRAINT_EXP(RTX, N) \
1243   XCVECEXP (RTX, 4, N, ASM_OPERANDS)
1244 #define ASM_OPERANDS_INPUT_CONSTRAINT(RTX, N) \
1245   XSTR (XCVECEXP (RTX, 4, N, ASM_OPERANDS), 0)
1246 #define ASM_OPERANDS_INPUT_MODE(RTX, N)  \
1247   GET_MODE (XCVECEXP (RTX, 4, N, ASM_OPERANDS))
1248 #define ASM_OPERANDS_LABEL_VEC(RTX) XCVEC (RTX, 5, ASM_OPERANDS)
1249 #define ASM_OPERANDS_LABEL_LENGTH(RTX) XCVECLEN (RTX, 5, ASM_OPERANDS)
1250 #define ASM_OPERANDS_LABEL(RTX, N) XCVECEXP (RTX, 5, N, ASM_OPERANDS)
1251 #define ASM_OPERANDS_SOURCE_LOCATION(RTX) XCUINT (RTX, 6, ASM_OPERANDS)
1252 #define ASM_INPUT_SOURCE_LOCATION(RTX) XCUINT (RTX, 1, ASM_INPUT)
1253
1254 /* 1 if RTX is a mem that is statically allocated in read-only memory.  */
1255 #define MEM_READONLY_P(RTX) \
1256   (RTL_FLAG_CHECK1("MEM_READONLY_P", (RTX), MEM)->unchanging)
1257
1258 /* 1 if RTX is a mem and we should keep the alias set for this mem
1259    unchanged when we access a component.  Set to 1, or example, when we
1260    are already in a non-addressable component of an aggregate.  */
1261 #define MEM_KEEP_ALIAS_SET_P(RTX)                                       \
1262   (RTL_FLAG_CHECK1("MEM_KEEP_ALIAS_SET_P", (RTX), MEM)->jump)
1263
1264 /* 1 if RTX is a mem or asm_operand for a volatile reference.  */
1265 #define MEM_VOLATILE_P(RTX)                                             \
1266   (RTL_FLAG_CHECK3("MEM_VOLATILE_P", (RTX), MEM, ASM_OPERANDS,          \
1267                    ASM_INPUT)->volatil)
1268
1269 /* 1 if RTX is a mem that refers to an aggregate, either to the
1270    aggregate itself or to a field of the aggregate.  If zero, RTX may
1271    or may not be such a reference.  */
1272 #define MEM_IN_STRUCT_P(RTX)                                            \
1273   (RTL_FLAG_CHECK1("MEM_IN_STRUCT_P", (RTX), MEM)->in_struct)
1274
1275 /* 1 if RTX is a MEM that refers to a scalar.  If zero, RTX may or may
1276    not refer to a scalar.  */
1277 #define MEM_SCALAR_P(RTX)                                               \
1278   (RTL_FLAG_CHECK1("MEM_SCALAR_P", (RTX), MEM)->return_val)
1279
1280 /* 1 if RTX is a mem that cannot trap.  */
1281 #define MEM_NOTRAP_P(RTX) \
1282   (RTL_FLAG_CHECK1("MEM_NOTRAP_P", (RTX), MEM)->call)
1283
1284 /* The memory attribute block.  We provide access macros for each value
1285    in the block and provide defaults if none specified.  */
1286 #define MEM_ATTRS(RTX) X0MEMATTR (RTX, 1)
1287
1288 /* The register attribute block.  We provide access macros for each value
1289    in the block and provide defaults if none specified.  */
1290 #define REG_ATTRS(RTX) X0REGATTR (RTX, 2)
1291
1292 /* For a MEM rtx, the alias set.  If 0, this MEM is not in any alias
1293    set, and may alias anything.  Otherwise, the MEM can only alias
1294    MEMs in a conflicting alias set.  This value is set in a
1295    language-dependent manner in the front-end, and should not be
1296    altered in the back-end.  These set numbers are tested with
1297    alias_sets_conflict_p.  */
1298 #define MEM_ALIAS_SET(RTX) (MEM_ATTRS (RTX) == 0 ? 0 : MEM_ATTRS (RTX)->alias)
1299
1300 /* For a MEM rtx, the decl it is known to refer to, if it is known to
1301    refer to part of a DECL.  It may also be a COMPONENT_REF.  */
1302 #define MEM_EXPR(RTX) (MEM_ATTRS (RTX) == 0 ? 0 : MEM_ATTRS (RTX)->expr)
1303
1304 /* For a MEM rtx, the offset from the start of MEM_EXPR, if known, as a
1305    RTX that is always a CONST_INT.  */
1306 #define MEM_OFFSET(RTX) (MEM_ATTRS (RTX) == 0 ? 0 : MEM_ATTRS (RTX)->offset)
1307
1308 /* For a MEM rtx, the address space.  */
1309 #define MEM_ADDR_SPACE(RTX) (MEM_ATTRS (RTX) == 0 ? ADDR_SPACE_GENERIC \
1310                                                   : MEM_ATTRS (RTX)->addrspace)
1311
1312 /* For a MEM rtx, the size in bytes of the MEM, if known, as an RTX that
1313    is always a CONST_INT.  */
1314 #define MEM_SIZE(RTX)                                                   \
1315 (MEM_ATTRS (RTX) != 0 ? MEM_ATTRS (RTX)->size                           \
1316  : GET_MODE (RTX) != BLKmode ? GEN_INT (GET_MODE_SIZE (GET_MODE (RTX))) \
1317  : 0)
1318
1319 /* For a MEM rtx, the alignment in bits.  We can use the alignment of the
1320    mode as a default when STRICT_ALIGNMENT, but not if not.  */
1321 #define MEM_ALIGN(RTX)                                                  \
1322 (MEM_ATTRS (RTX) != 0 ? MEM_ATTRS (RTX)->align                          \
1323  : (STRICT_ALIGNMENT && GET_MODE (RTX) != BLKmode                       \
1324     ? GET_MODE_ALIGNMENT (GET_MODE (RTX)) : BITS_PER_UNIT))
1325
1326 /* For a REG rtx, the decl it is known to refer to, if it is known to
1327    refer to part of a DECL.  */
1328 #define REG_EXPR(RTX) (REG_ATTRS (RTX) == 0 ? 0 : REG_ATTRS (RTX)->decl)
1329
1330 /* For a REG rtx, the offset from the start of REG_EXPR, if known, as an
1331    HOST_WIDE_INT.  */
1332 #define REG_OFFSET(RTX) (REG_ATTRS (RTX) == 0 ? 0 : REG_ATTRS (RTX)->offset)
1333
1334 /* Copy the attributes that apply to memory locations from RHS to LHS.  */
1335 #define MEM_COPY_ATTRIBUTES(LHS, RHS)                           \
1336   (MEM_VOLATILE_P (LHS) = MEM_VOLATILE_P (RHS),                 \
1337    MEM_IN_STRUCT_P (LHS) = MEM_IN_STRUCT_P (RHS),               \
1338    MEM_SCALAR_P (LHS) = MEM_SCALAR_P (RHS),                     \
1339    MEM_NOTRAP_P (LHS) = MEM_NOTRAP_P (RHS),                     \
1340    MEM_READONLY_P (LHS) = MEM_READONLY_P (RHS),                 \
1341    MEM_KEEP_ALIAS_SET_P (LHS) = MEM_KEEP_ALIAS_SET_P (RHS),     \
1342    MEM_POINTER (LHS) = MEM_POINTER (RHS),                       \
1343    MEM_ATTRS (LHS) = MEM_ATTRS (RHS))
1344
1345 /* 1 if RTX is a label_ref for a nonlocal label.  */
1346 /* Likewise in an expr_list for a REG_LABEL_OPERAND or
1347    REG_LABEL_TARGET note.  */
1348 #define LABEL_REF_NONLOCAL_P(RTX)                                       \
1349   (RTL_FLAG_CHECK1("LABEL_REF_NONLOCAL_P", (RTX), LABEL_REF)->volatil)
1350
1351 /* 1 if RTX is a code_label that should always be considered to be needed.  */
1352 #define LABEL_PRESERVE_P(RTX)                                           \
1353   (RTL_FLAG_CHECK2("LABEL_PRESERVE_P", (RTX), CODE_LABEL, NOTE)->in_struct)
1354
1355 /* During sched, 1 if RTX is an insn that must be scheduled together
1356    with the preceding insn.  */
1357 #define SCHED_GROUP_P(RTX)                                              \
1358   (RTL_FLAG_CHECK4("SCHED_GROUP_P", (RTX), DEBUG_INSN, INSN,            \
1359                    JUMP_INSN, CALL_INSN                                 \
1360                    )->in_struct)
1361
1362 /* For a SET rtx, SET_DEST is the place that is set
1363    and SET_SRC is the value it is set to.  */
1364 #define SET_DEST(RTX) XC2EXP(RTX, 0, SET, CLOBBER)
1365 #define SET_SRC(RTX) XCEXP(RTX, 1, SET)
1366 #define SET_IS_RETURN_P(RTX)                                            \
1367   (RTL_FLAG_CHECK1("SET_IS_RETURN_P", (RTX), SET)->jump)
1368
1369 /* For a TRAP_IF rtx, TRAP_CONDITION is an expression.  */
1370 #define TRAP_CONDITION(RTX) XCEXP (RTX, 0, TRAP_IF)
1371 #define TRAP_CODE(RTX) XCEXP (RTX, 1, TRAP_IF)
1372
1373 /* For a COND_EXEC rtx, COND_EXEC_TEST is the condition to base
1374    conditionally executing the code on, COND_EXEC_CODE is the code
1375    to execute if the condition is true.  */
1376 #define COND_EXEC_TEST(RTX) XCEXP (RTX, 0, COND_EXEC)
1377 #define COND_EXEC_CODE(RTX) XCEXP (RTX, 1, COND_EXEC)
1378
1379 /* 1 if RTX is a symbol_ref that addresses this function's rtl
1380    constants pool.  */
1381 #define CONSTANT_POOL_ADDRESS_P(RTX)                                    \
1382   (RTL_FLAG_CHECK1("CONSTANT_POOL_ADDRESS_P", (RTX), SYMBOL_REF)->unchanging)
1383
1384 /* 1 if RTX is a symbol_ref that addresses a value in the file's
1385    tree constant pool.  This information is private to varasm.c.  */
1386 #define TREE_CONSTANT_POOL_ADDRESS_P(RTX)                               \
1387   (RTL_FLAG_CHECK1("TREE_CONSTANT_POOL_ADDRESS_P",                      \
1388                    (RTX), SYMBOL_REF)->frame_related)
1389
1390 /* Used if RTX is a symbol_ref, for machine-specific purposes.  */
1391 #define SYMBOL_REF_FLAG(RTX)                                            \
1392   (RTL_FLAG_CHECK1("SYMBOL_REF_FLAG", (RTX), SYMBOL_REF)->volatil)
1393
1394 /* 1 if RTX is a symbol_ref that has been the library function in
1395    emit_library_call.  */
1396 #define SYMBOL_REF_USED(RTX)                                            \
1397   (RTL_FLAG_CHECK1("SYMBOL_REF_USED", (RTX), SYMBOL_REF)->used)
1398
1399 /* 1 if RTX is a symbol_ref for a weak symbol.  */
1400 #define SYMBOL_REF_WEAK(RTX)                                            \
1401   (RTL_FLAG_CHECK1("SYMBOL_REF_WEAK", (RTX), SYMBOL_REF)->return_val)
1402
1403 /* A pointer attached to the SYMBOL_REF; either SYMBOL_REF_DECL or
1404    SYMBOL_REF_CONSTANT.  */
1405 #define SYMBOL_REF_DATA(RTX) X0ANY ((RTX), 2)
1406
1407 /* Set RTX's SYMBOL_REF_DECL to DECL.  RTX must not be a constant
1408    pool symbol.  */
1409 #define SET_SYMBOL_REF_DECL(RTX, DECL) \
1410   (gcc_assert (!CONSTANT_POOL_ADDRESS_P (RTX)), X0TREE ((RTX), 2) = (DECL))
1411
1412 /* The tree (decl or constant) associated with the symbol, or null.  */
1413 #define SYMBOL_REF_DECL(RTX) \
1414   (CONSTANT_POOL_ADDRESS_P (RTX) ? NULL : X0TREE ((RTX), 2))
1415
1416 /* Set RTX's SYMBOL_REF_CONSTANT to C.  RTX must be a constant pool symbol.  */
1417 #define SET_SYMBOL_REF_CONSTANT(RTX, C) \
1418   (gcc_assert (CONSTANT_POOL_ADDRESS_P (RTX)), X0CONSTANT ((RTX), 2) = (C))
1419
1420 /* The rtx constant pool entry for a symbol, or null.  */
1421 #define SYMBOL_REF_CONSTANT(RTX) \
1422   (CONSTANT_POOL_ADDRESS_P (RTX) ? X0CONSTANT ((RTX), 2) : NULL)
1423
1424 /* A set of flags on a symbol_ref that are, in some respects, redundant with
1425    information derivable from the tree decl associated with this symbol.
1426    Except that we build a *lot* of SYMBOL_REFs that aren't associated with a
1427    decl.  In some cases this is a bug.  But beyond that, it's nice to cache
1428    this information to avoid recomputing it.  Finally, this allows space for
1429    the target to store more than one bit of information, as with
1430    SYMBOL_REF_FLAG.  */
1431 #define SYMBOL_REF_FLAGS(RTX)   X0INT ((RTX), 1)
1432
1433 /* These flags are common enough to be defined for all targets.  They
1434    are computed by the default version of targetm.encode_section_info.  */
1435
1436 /* Set if this symbol is a function.  */
1437 #define SYMBOL_FLAG_FUNCTION    (1 << 0)
1438 #define SYMBOL_REF_FUNCTION_P(RTX) \
1439   ((SYMBOL_REF_FLAGS (RTX) & SYMBOL_FLAG_FUNCTION) != 0)
1440 /* Set if targetm.binds_local_p is true.  */
1441 #define SYMBOL_FLAG_LOCAL       (1 << 1)
1442 #define SYMBOL_REF_LOCAL_P(RTX) \
1443   ((SYMBOL_REF_FLAGS (RTX) & SYMBOL_FLAG_LOCAL) != 0)
1444 /* Set if targetm.in_small_data_p is true.  */
1445 #define SYMBOL_FLAG_SMALL       (1 << 2)
1446 #define SYMBOL_REF_SMALL_P(RTX) \
1447   ((SYMBOL_REF_FLAGS (RTX) & SYMBOL_FLAG_SMALL) != 0)
1448 /* The three-bit field at [5:3] is true for TLS variables; use
1449    SYMBOL_REF_TLS_MODEL to extract the field as an enum tls_model.  */
1450 #define SYMBOL_FLAG_TLS_SHIFT   3
1451 #define SYMBOL_REF_TLS_MODEL(RTX) \
1452   ((enum tls_model) ((SYMBOL_REF_FLAGS (RTX) >> SYMBOL_FLAG_TLS_SHIFT) & 7))
1453 /* Set if this symbol is not defined in this translation unit.  */
1454 #define SYMBOL_FLAG_EXTERNAL    (1 << 6)
1455 #define SYMBOL_REF_EXTERNAL_P(RTX) \
1456   ((SYMBOL_REF_FLAGS (RTX) & SYMBOL_FLAG_EXTERNAL) != 0)
1457 /* Set if this symbol has a block_symbol structure associated with it.  */
1458 #define SYMBOL_FLAG_HAS_BLOCK_INFO (1 << 7)
1459 #define SYMBOL_REF_HAS_BLOCK_INFO_P(RTX) \
1460   ((SYMBOL_REF_FLAGS (RTX) & SYMBOL_FLAG_HAS_BLOCK_INFO) != 0)
1461 /* Set if this symbol is a section anchor.  SYMBOL_REF_ANCHOR_P implies
1462    SYMBOL_REF_HAS_BLOCK_INFO_P.  */
1463 #define SYMBOL_FLAG_ANCHOR      (1 << 8)
1464 #define SYMBOL_REF_ANCHOR_P(RTX) \
1465   ((SYMBOL_REF_FLAGS (RTX) & SYMBOL_FLAG_ANCHOR) != 0)
1466
1467 /* Subsequent bits are available for the target to use.  */
1468 #define SYMBOL_FLAG_MACH_DEP_SHIFT      9
1469 #define SYMBOL_FLAG_MACH_DEP            (1 << SYMBOL_FLAG_MACH_DEP_SHIFT)
1470
1471 /* If SYMBOL_REF_HAS_BLOCK_INFO_P (RTX), this is the object_block
1472    structure to which the symbol belongs, or NULL if it has not been
1473    assigned a block.  */
1474 #define SYMBOL_REF_BLOCK(RTX) (BLOCK_SYMBOL_CHECK (RTX)->block)
1475
1476 /* If SYMBOL_REF_HAS_BLOCK_INFO_P (RTX), this is the offset of RTX from
1477    the first object in SYMBOL_REF_BLOCK (RTX).  The value is negative if
1478    RTX has not yet been assigned to a block, or it has not been given an
1479    offset within that block.  */
1480 #define SYMBOL_REF_BLOCK_OFFSET(RTX) (BLOCK_SYMBOL_CHECK (RTX)->offset)
1481
1482 /* True if RTX is flagged to be a scheduling barrier.  */
1483 #define PREFETCH_SCHEDULE_BARRIER_P(RTX)                                        \
1484   (RTL_FLAG_CHECK1("PREFETCH_SCHEDULE_BARRIER_P", (RTX), PREFETCH)->volatil)
1485
1486 /* Indicate whether the machine has any sort of auto increment addressing.
1487    If not, we can avoid checking for REG_INC notes.  */
1488
1489 #if (defined (HAVE_PRE_INCREMENT) || defined (HAVE_PRE_DECREMENT) \
1490      || defined (HAVE_POST_INCREMENT) || defined (HAVE_POST_DECREMENT) \
1491      || defined (HAVE_PRE_MODIFY_DISP) || defined (HAVE_PRE_MODIFY_DISP) \
1492      || defined (HAVE_PRE_MODIFY_REG) || defined (HAVE_POST_MODIFY_REG))
1493 #define AUTO_INC_DEC
1494 #endif
1495
1496 /* Define a macro to look for REG_INC notes,
1497    but save time on machines where they never exist.  */
1498
1499 #ifdef AUTO_INC_DEC
1500 #define FIND_REG_INC_NOTE(INSN, REG)                    \
1501   ((REG) != NULL_RTX && REG_P ((REG))                   \
1502    ? find_regno_note ((INSN), REG_INC, REGNO (REG))     \
1503    : find_reg_note ((INSN), REG_INC, (REG)))
1504 #else
1505 #define FIND_REG_INC_NOTE(INSN, REG) 0
1506 #endif
1507
1508 #ifndef HAVE_PRE_INCREMENT
1509 #define HAVE_PRE_INCREMENT 0
1510 #endif
1511
1512 #ifndef HAVE_PRE_DECREMENT
1513 #define HAVE_PRE_DECREMENT 0
1514 #endif
1515
1516 #ifndef HAVE_POST_INCREMENT
1517 #define HAVE_POST_INCREMENT 0
1518 #endif
1519
1520 #ifndef HAVE_POST_DECREMENT
1521 #define HAVE_POST_DECREMENT 0
1522 #endif
1523
1524 #ifndef HAVE_POST_MODIFY_DISP
1525 #define HAVE_POST_MODIFY_DISP 0
1526 #endif
1527
1528 #ifndef HAVE_POST_MODIFY_REG
1529 #define HAVE_POST_MODIFY_REG 0
1530 #endif
1531
1532 #ifndef HAVE_PRE_MODIFY_DISP
1533 #define HAVE_PRE_MODIFY_DISP 0
1534 #endif
1535
1536 #ifndef HAVE_PRE_MODIFY_REG
1537 #define HAVE_PRE_MODIFY_REG 0
1538 #endif
1539
1540
1541 /* Some architectures do not have complete pre/post increment/decrement
1542    instruction sets, or only move some modes efficiently.  These macros
1543    allow us to tune autoincrement generation.  */
1544
1545 #ifndef USE_LOAD_POST_INCREMENT
1546 #define USE_LOAD_POST_INCREMENT(MODE)   HAVE_POST_INCREMENT
1547 #endif
1548
1549 #ifndef USE_LOAD_POST_DECREMENT
1550 #define USE_LOAD_POST_DECREMENT(MODE)   HAVE_POST_DECREMENT
1551 #endif
1552
1553 #ifndef USE_LOAD_PRE_INCREMENT
1554 #define USE_LOAD_PRE_INCREMENT(MODE)    HAVE_PRE_INCREMENT
1555 #endif
1556
1557 #ifndef USE_LOAD_PRE_DECREMENT
1558 #define USE_LOAD_PRE_DECREMENT(MODE)    HAVE_PRE_DECREMENT
1559 #endif
1560
1561 #ifndef USE_STORE_POST_INCREMENT
1562 #define USE_STORE_POST_INCREMENT(MODE)  HAVE_POST_INCREMENT
1563 #endif
1564
1565 #ifndef USE_STORE_POST_DECREMENT
1566 #define USE_STORE_POST_DECREMENT(MODE)  HAVE_POST_DECREMENT
1567 #endif
1568
1569 #ifndef USE_STORE_PRE_INCREMENT
1570 #define USE_STORE_PRE_INCREMENT(MODE)   HAVE_PRE_INCREMENT
1571 #endif
1572
1573 #ifndef USE_STORE_PRE_DECREMENT
1574 #define USE_STORE_PRE_DECREMENT(MODE)   HAVE_PRE_DECREMENT
1575 #endif
1576 \f
1577 /* Nonzero when we are generating CONCATs.  */
1578 extern int generating_concat_p;
1579
1580 /* Nonzero when we are expanding trees to RTL.  */
1581 extern int currently_expanding_to_rtl;
1582
1583 /* Generally useful functions.  */
1584
1585 /* In expmed.c */
1586 extern int ceil_log2 (unsigned HOST_WIDE_INT);
1587
1588 /* In explow.c */
1589 extern HOST_WIDE_INT trunc_int_for_mode (HOST_WIDE_INT, enum machine_mode);
1590 extern rtx plus_constant (rtx, HOST_WIDE_INT);
1591
1592 /* In rtl.c */
1593 extern rtx rtx_alloc_stat (RTX_CODE MEM_STAT_DECL);
1594 #define rtx_alloc(c) rtx_alloc_stat (c MEM_STAT_INFO)
1595
1596 extern rtvec rtvec_alloc (int);
1597 extern rtvec shallow_copy_rtvec (rtvec);
1598 extern bool shared_const_p (const_rtx);
1599 extern rtx copy_rtx (rtx);
1600 extern void dump_rtx_statistics (void);
1601
1602 /* In emit-rtl.c */
1603 extern rtx copy_rtx_if_shared (rtx);
1604
1605 /* In rtl.c */
1606 extern unsigned int rtx_size (const_rtx);
1607 extern rtx shallow_copy_rtx_stat (const_rtx MEM_STAT_DECL);
1608 #define shallow_copy_rtx(a) shallow_copy_rtx_stat (a MEM_STAT_INFO)
1609 extern int rtx_equal_p (const_rtx, const_rtx);
1610 extern hashval_t iterative_hash_rtx (const_rtx, hashval_t);
1611
1612 /* In emit-rtl.c */
1613 extern rtvec gen_rtvec_v (int, rtx *);
1614 extern rtx gen_reg_rtx (enum machine_mode);
1615 extern rtx gen_rtx_REG_offset (rtx, enum machine_mode, unsigned int, int);
1616 extern rtx gen_reg_rtx_offset (rtx, enum machine_mode, int);
1617 extern rtx gen_reg_rtx_and_attrs (rtx);
1618 extern rtx gen_label_rtx (void);
1619 extern rtx gen_lowpart_common (enum machine_mode, rtx);
1620
1621 /* In cse.c */
1622 extern rtx gen_lowpart_if_possible (enum machine_mode, rtx);
1623
1624 /* In emit-rtl.c */
1625 extern rtx gen_highpart (enum machine_mode, rtx);
1626 extern rtx gen_highpart_mode (enum machine_mode, enum machine_mode, rtx);
1627 extern rtx operand_subword (rtx, unsigned int, int, enum machine_mode);
1628
1629 /* In emit-rtl.c */
1630 extern rtx operand_subword_force (rtx, unsigned int, enum machine_mode);
1631 extern bool paradoxical_subreg_p (const_rtx);
1632 extern int subreg_lowpart_p (const_rtx);
1633 extern unsigned int subreg_lowpart_offset (enum machine_mode,
1634                                            enum machine_mode);
1635 extern unsigned int subreg_highpart_offset (enum machine_mode,
1636                                             enum machine_mode);
1637 extern int byte_lowpart_offset (enum machine_mode, enum machine_mode);
1638 extern rtx make_safe_from (rtx, rtx);
1639 extern rtx convert_memory_address_addr_space (enum machine_mode, rtx,
1640                                               addr_space_t);
1641 #define convert_memory_address(to_mode,x) \
1642         convert_memory_address_addr_space ((to_mode), (x), ADDR_SPACE_GENERIC)
1643 extern const char *get_insn_name (int);
1644 extern rtx get_last_insn_anywhere (void);
1645 extern rtx get_first_nonnote_insn (void);
1646 extern rtx get_last_nonnote_insn (void);
1647 extern void start_sequence (void);
1648 extern void push_to_sequence (rtx);
1649 extern void push_to_sequence2 (rtx, rtx);
1650 extern void end_sequence (void);
1651 extern double_int rtx_to_double_int (const_rtx);
1652 extern rtx immed_double_int_const (double_int, enum machine_mode);
1653 extern rtx immed_double_const (HOST_WIDE_INT, HOST_WIDE_INT,
1654                                enum machine_mode);
1655
1656 /* In loop-iv.c  */
1657
1658 extern rtx lowpart_subreg (enum machine_mode, rtx, enum machine_mode);
1659
1660 /* In varasm.c  */
1661 extern rtx force_const_mem (enum machine_mode, rtx);
1662
1663 /* In varasm.c  */
1664
1665 struct function;
1666 extern rtx get_pool_constant (rtx);
1667 extern rtx get_pool_constant_mark (rtx, bool *);
1668 extern enum machine_mode get_pool_mode (const_rtx);
1669 extern rtx simplify_subtraction (rtx);
1670 extern void decide_function_section (tree);
1671
1672 /* In function.c  */
1673 extern rtx assign_stack_local (enum machine_mode, HOST_WIDE_INT, int);
1674 #define ASLK_REDUCE_ALIGN 1
1675 #define ASLK_RECORD_PAD 2
1676 extern rtx assign_stack_local_1 (enum machine_mode, HOST_WIDE_INT, int, int);
1677 extern rtx assign_stack_temp (enum machine_mode, HOST_WIDE_INT, int);
1678 extern rtx assign_stack_temp_for_type (enum machine_mode,
1679                                        HOST_WIDE_INT, int, tree);
1680 extern rtx assign_temp (tree, int, int, int);
1681
1682 /* In emit-rtl.c */
1683 extern rtx emit_insn_before (rtx, rtx);
1684 extern rtx emit_insn_before_noloc (rtx, rtx, struct basic_block_def *);
1685 extern rtx emit_insn_before_setloc (rtx, rtx, int);
1686 extern rtx emit_jump_insn_before (rtx, rtx);
1687 extern rtx emit_jump_insn_before_noloc (rtx, rtx);
1688 extern rtx emit_jump_insn_before_setloc (rtx, rtx, int);
1689 extern rtx emit_call_insn_before (rtx, rtx);
1690 extern rtx emit_call_insn_before_noloc (rtx, rtx);
1691 extern rtx emit_call_insn_before_setloc (rtx, rtx, int);
1692 extern rtx emit_debug_insn_before (rtx, rtx);
1693 extern rtx emit_debug_insn_before_noloc (rtx, rtx);
1694 extern rtx emit_debug_insn_before_setloc (rtx, rtx, int);
1695 extern rtx emit_barrier_before (rtx);
1696 extern rtx emit_label_before (rtx, rtx);
1697 extern rtx emit_note_before (enum insn_note, rtx);
1698 extern rtx emit_insn_after (rtx, rtx);
1699 extern rtx emit_insn_after_noloc (rtx, rtx, struct basic_block_def *);
1700 extern rtx emit_insn_after_setloc (rtx, rtx, int);
1701 extern rtx emit_jump_insn_after (rtx, rtx);
1702 extern rtx emit_jump_insn_after_noloc (rtx, rtx);
1703 extern rtx emit_jump_insn_after_setloc (rtx, rtx, int);
1704 extern rtx emit_call_insn_after (rtx, rtx);
1705 extern rtx emit_call_insn_after_noloc (rtx, rtx);
1706 extern rtx emit_call_insn_after_setloc (rtx, rtx, int);
1707 extern rtx emit_debug_insn_after (rtx, rtx);
1708 extern rtx emit_debug_insn_after_noloc (rtx, rtx);
1709 extern rtx emit_debug_insn_after_setloc (rtx, rtx, int);
1710 extern rtx emit_barrier_after (rtx);
1711 extern rtx emit_label_after (rtx, rtx);
1712 extern rtx emit_note_after (enum insn_note, rtx);
1713 extern rtx emit_insn (rtx);
1714 extern rtx emit_debug_insn (rtx);
1715 extern rtx emit_jump_insn (rtx);
1716 extern rtx emit_call_insn (rtx);
1717 extern rtx emit_label (rtx);
1718 extern rtx emit_barrier (void);
1719 extern rtx emit_note (enum insn_note);
1720 extern rtx emit_note_copy (rtx);
1721 extern rtx gen_clobber (rtx);
1722 extern rtx emit_clobber (rtx);
1723 extern rtx gen_use (rtx);
1724 extern rtx emit_use (rtx);
1725 extern rtx make_insn_raw (rtx);
1726 extern rtx make_debug_insn_raw (rtx);
1727 extern rtx make_jump_insn_raw (rtx);
1728 extern void add_function_usage_to (rtx, rtx);
1729 extern rtx last_call_insn (void);
1730 extern rtx previous_insn (rtx);
1731 extern rtx next_insn (rtx);
1732 extern rtx prev_nonnote_insn (rtx);
1733 extern rtx prev_nonnote_insn_bb (rtx);
1734 extern rtx next_nonnote_insn (rtx);
1735 extern rtx next_nonnote_insn_bb (rtx);
1736 extern rtx prev_nondebug_insn (rtx);
1737 extern rtx next_nondebug_insn (rtx);
1738 extern rtx prev_nonnote_nondebug_insn (rtx);
1739 extern rtx next_nonnote_nondebug_insn (rtx);
1740 extern rtx prev_real_insn (rtx);
1741 extern rtx next_real_insn (rtx);
1742 extern rtx prev_active_insn (rtx);
1743 extern rtx next_active_insn (rtx);
1744 extern int active_insn_p (const_rtx);
1745 extern rtx prev_label (rtx);
1746 extern rtx next_label (rtx);
1747 extern rtx skip_consecutive_labels (rtx);
1748 extern rtx next_cc0_user (rtx);
1749 extern rtx prev_cc0_setter (rtx);
1750
1751 /* In cfglayout.c  */
1752 extern int insn_line (const_rtx);
1753 extern const char * insn_file (const_rtx);
1754 extern location_t locator_location (int);
1755 extern int locator_line (int);
1756 extern const char * locator_file (int);
1757 extern bool locator_eq (int, int);
1758 extern int prologue_locator, epilogue_locator;
1759
1760 /* In jump.c */
1761 extern enum rtx_code reverse_condition (enum rtx_code);
1762 extern enum rtx_code reverse_condition_maybe_unordered (enum rtx_code);
1763 extern enum rtx_code swap_condition (enum rtx_code);
1764 extern enum rtx_code unsigned_condition (enum rtx_code);
1765 extern enum rtx_code signed_condition (enum rtx_code);
1766 extern void mark_jump_label (rtx, rtx, int);
1767 extern unsigned int cleanup_barriers (void);
1768
1769 /* In jump.c */
1770 extern rtx delete_related_insns (rtx);
1771
1772 /* In recog.c  */
1773 extern rtx *find_constant_term_loc (rtx *);
1774
1775 /* In emit-rtl.c  */
1776 extern rtx try_split (rtx, rtx, int);
1777 extern int split_branch_probability;
1778
1779 /* In unknown file  */
1780 extern rtx split_insns (rtx, rtx);
1781
1782 /* In simplify-rtx.c  */
1783 extern rtx simplify_const_unary_operation (enum rtx_code, enum machine_mode,
1784                                            rtx, enum machine_mode);
1785 extern rtx simplify_unary_operation (enum rtx_code, enum machine_mode, rtx,
1786                                      enum machine_mode);
1787 extern rtx simplify_const_binary_operation (enum rtx_code, enum machine_mode,
1788                                             rtx, rtx);
1789 extern rtx simplify_binary_operation (enum rtx_code, enum machine_mode, rtx,
1790                                       rtx);
1791 extern rtx simplify_ternary_operation (enum rtx_code, enum machine_mode,
1792                                        enum machine_mode, rtx, rtx, rtx);
1793 extern rtx simplify_const_relational_operation (enum rtx_code,
1794                                                 enum machine_mode, rtx, rtx);
1795 extern rtx simplify_relational_operation (enum rtx_code, enum machine_mode,
1796                                           enum machine_mode, rtx, rtx);
1797 extern rtx simplify_gen_binary (enum rtx_code, enum machine_mode, rtx, rtx);
1798 extern rtx simplify_gen_unary (enum rtx_code, enum machine_mode, rtx,
1799                                enum machine_mode);
1800 extern rtx simplify_gen_ternary (enum rtx_code, enum machine_mode,
1801                                  enum machine_mode, rtx, rtx, rtx);
1802 extern rtx simplify_gen_relational (enum rtx_code, enum machine_mode,
1803                                     enum machine_mode, rtx, rtx);
1804 extern rtx simplify_subreg (enum machine_mode, rtx, enum machine_mode,
1805                             unsigned int);
1806 extern rtx simplify_gen_subreg (enum machine_mode, rtx, enum machine_mode,
1807                                 unsigned int);
1808 extern rtx simplify_replace_fn_rtx (rtx, const_rtx,
1809                                     rtx (*fn) (rtx, const_rtx, void *), void *);
1810 extern rtx simplify_replace_rtx (rtx, const_rtx, rtx);
1811 extern rtx simplify_rtx (const_rtx);
1812 extern rtx avoid_constant_pool_reference (rtx);
1813 extern rtx delegitimize_mem_from_attrs (rtx);
1814 extern bool mode_signbit_p (enum machine_mode, const_rtx);
1815 extern bool val_signbit_p (enum machine_mode, unsigned HOST_WIDE_INT);
1816 extern bool val_signbit_known_set_p (enum machine_mode,
1817                                      unsigned HOST_WIDE_INT);
1818 extern bool val_signbit_known_clear_p (enum machine_mode,
1819                                        unsigned HOST_WIDE_INT);
1820
1821 /* In reginfo.c  */
1822 extern enum machine_mode choose_hard_reg_mode (unsigned int, unsigned int,
1823                                                bool);
1824
1825 /* In emit-rtl.c  */
1826 extern rtx set_unique_reg_note (rtx, enum reg_note, rtx);
1827 extern void set_insn_deleted (rtx);
1828
1829 /* Functions in rtlanal.c */
1830
1831 /* Single set is implemented as macro for performance reasons.  */
1832 #define single_set(I) (INSN_P (I) \
1833                        ? (GET_CODE (PATTERN (I)) == SET \
1834                           ? PATTERN (I) : single_set_1 (I)) \
1835                        : NULL_RTX)
1836 #define single_set_1(I) single_set_2 (I, PATTERN (I))
1837
1838 /* Structure used for passing data to REPLACE_LABEL.  */
1839 typedef struct replace_label_data
1840 {
1841   rtx r1;
1842   rtx r2;
1843   bool update_label_nuses;
1844 } replace_label_data;
1845
1846 extern int rtx_addr_can_trap_p (const_rtx);
1847 extern bool nonzero_address_p (const_rtx);
1848 extern int rtx_unstable_p (const_rtx);
1849 extern bool rtx_varies_p (const_rtx, bool);
1850 extern bool rtx_addr_varies_p (const_rtx, bool);
1851 extern HOST_WIDE_INT get_integer_term (const_rtx);
1852 extern rtx get_related_value (const_rtx);
1853 extern bool offset_within_block_p (const_rtx, HOST_WIDE_INT);
1854 extern void split_const (rtx, rtx *, rtx *);
1855 extern int reg_mentioned_p (const_rtx, const_rtx);
1856 extern int count_occurrences (const_rtx, const_rtx, int);
1857 extern int reg_referenced_p (const_rtx, const_rtx);
1858 extern int reg_used_between_p (const_rtx, const_rtx, const_rtx);
1859 extern int reg_set_between_p (const_rtx, const_rtx, const_rtx);
1860 extern int commutative_operand_precedence (rtx);
1861 extern bool swap_commutative_operands_p (rtx, rtx);
1862 extern int modified_between_p (const_rtx, const_rtx, const_rtx);
1863 extern int no_labels_between_p (const_rtx, const_rtx);
1864 extern int modified_in_p (const_rtx, const_rtx);
1865 extern int reg_set_p (const_rtx, const_rtx);
1866 extern rtx single_set_2 (const_rtx, const_rtx);
1867 extern int multiple_sets (const_rtx);
1868 extern int set_noop_p (const_rtx);
1869 extern int noop_move_p (const_rtx);
1870 extern rtx find_last_value (rtx, rtx *, rtx, int);
1871 extern int refers_to_regno_p (unsigned int, unsigned int, const_rtx, rtx *);
1872 extern int reg_overlap_mentioned_p (const_rtx, const_rtx);
1873 extern const_rtx set_of (const_rtx, const_rtx);
1874 extern void note_stores (const_rtx, void (*) (rtx, const_rtx, void *), void *);
1875 extern void note_uses (rtx *, void (*) (rtx *, void *), void *);
1876 extern int dead_or_set_p (const_rtx, const_rtx);
1877 extern int dead_or_set_regno_p (const_rtx, unsigned int);
1878 extern rtx find_reg_note (const_rtx, enum reg_note, const_rtx);
1879 extern rtx find_regno_note (const_rtx, enum reg_note, unsigned int);
1880 extern rtx find_reg_equal_equiv_note (const_rtx);
1881 extern rtx find_constant_src (const_rtx);
1882 extern int find_reg_fusage (const_rtx, enum rtx_code, const_rtx);
1883 extern int find_regno_fusage (const_rtx, enum rtx_code, unsigned int);
1884 extern rtx alloc_reg_note (enum reg_note, rtx, rtx);
1885 extern void add_reg_note (rtx, enum reg_note, rtx);
1886 extern void remove_note (rtx, const_rtx);
1887 extern void remove_reg_equal_equiv_notes (rtx);
1888 extern void remove_reg_equal_equiv_notes_for_regno (unsigned int);
1889 extern int side_effects_p (const_rtx);
1890 extern int volatile_refs_p (const_rtx);
1891 extern int volatile_insn_p (const_rtx);
1892 extern int may_trap_p_1 (const_rtx, unsigned);
1893 extern int may_trap_p (const_rtx);
1894 extern int may_trap_or_fault_p (const_rtx);
1895 extern bool can_throw_internal (const_rtx);
1896 extern bool can_throw_external (const_rtx);
1897 extern bool insn_could_throw_p (const_rtx);
1898 extern bool insn_nothrow_p (const_rtx);
1899 extern bool can_nonlocal_goto (const_rtx);
1900 extern void copy_reg_eh_region_note_forward (rtx, rtx, rtx);
1901 extern void copy_reg_eh_region_note_backward(rtx, rtx, rtx);
1902 extern int inequality_comparisons_p (const_rtx);
1903 extern rtx replace_rtx (rtx, rtx, rtx);
1904 extern int replace_label (rtx *, void *);
1905 extern int rtx_referenced_p (rtx, rtx);
1906 extern bool tablejump_p (const_rtx, rtx *, rtx *);
1907 extern int computed_jump_p (const_rtx);
1908
1909 typedef int (*rtx_function) (rtx *, void *);
1910 extern int for_each_rtx (rtx *, rtx_function, void *);
1911
1912 /* Callback for for_each_inc_dec, to process the autoinc operation OP
1913    within MEM that sets DEST to SRC + SRCOFF, or SRC if SRCOFF is
1914    NULL.  The callback is passed the same opaque ARG passed to
1915    for_each_inc_dec.  Return zero to continue looking for other
1916    autoinc operations, -1 to skip OP's operands, and any other value
1917    to interrupt the traversal and return that value to the caller of
1918    for_each_inc_dec.  */
1919 typedef int (*for_each_inc_dec_fn) (rtx mem, rtx op, rtx dest, rtx src,
1920                                     rtx srcoff, void *arg);
1921 extern int for_each_inc_dec (rtx *, for_each_inc_dec_fn, void *arg);
1922
1923 typedef int (*rtx_equal_p_callback_function) (const_rtx *, const_rtx *,
1924                                               rtx *, rtx *);
1925 extern int rtx_equal_p_cb (const_rtx, const_rtx,
1926                            rtx_equal_p_callback_function);
1927
1928 typedef int (*hash_rtx_callback_function) (const_rtx, enum machine_mode, rtx *,
1929                                            enum machine_mode *);
1930 extern unsigned hash_rtx_cb (const_rtx, enum machine_mode, int *, int *,
1931                              bool, hash_rtx_callback_function);
1932
1933 extern rtx regno_use_in (unsigned int, rtx);
1934 extern int auto_inc_p (const_rtx);
1935 extern int in_expr_list_p (const_rtx, const_rtx);
1936 extern void remove_node_from_expr_list (const_rtx, rtx *);
1937 extern int loc_mentioned_in_p (rtx *, const_rtx);
1938 extern rtx find_first_parameter_load (rtx, rtx);
1939 extern bool keep_with_call_p (const_rtx);
1940 extern bool label_is_jump_target_p (const_rtx, const_rtx);
1941 extern int insn_rtx_cost (rtx, bool);
1942
1943 /* Given an insn and condition, return a canonical description of
1944    the test being made.  */
1945 extern rtx canonicalize_condition (rtx, rtx, int, rtx *, rtx, int, int);
1946
1947 /* Given a JUMP_INSN, return a canonical description of the test
1948    being made.  */
1949 extern rtx get_condition (rtx, rtx *, int, int);
1950
1951 /* Information about a subreg of a hard register.  */
1952 struct subreg_info
1953 {
1954   /* Offset of first hard register involved in the subreg.  */
1955   int offset;
1956   /* Number of hard registers involved in the subreg.  */
1957   int nregs;
1958   /* Whether this subreg can be represented as a hard reg with the new
1959      mode.  */
1960   bool representable_p;
1961 };
1962
1963 extern void subreg_get_info (unsigned int, enum machine_mode,
1964                              unsigned int, enum machine_mode,
1965                              struct subreg_info *);
1966
1967 /* lists.c */
1968
1969 extern void free_EXPR_LIST_list         (rtx *);
1970 extern void free_INSN_LIST_list         (rtx *);
1971 extern void free_EXPR_LIST_node         (rtx);
1972 extern void free_INSN_LIST_node         (rtx);
1973 extern rtx alloc_INSN_LIST                      (rtx, rtx);
1974 extern rtx alloc_EXPR_LIST                      (int, rtx, rtx);
1975 extern void remove_free_INSN_LIST_elem (rtx, rtx *);
1976 extern rtx remove_list_elem (rtx, rtx *);
1977 extern rtx remove_free_INSN_LIST_node (rtx *);
1978 extern rtx remove_free_EXPR_LIST_node (rtx *);
1979
1980
1981 /* reginfo.c */
1982
1983 /* Initialize may_move_cost and friends for mode M.  */
1984 extern void init_move_cost (enum machine_mode);
1985 /* Resize reg info.  */
1986 extern bool resize_reg_info (void);
1987 /* Free up register info memory.  */
1988 extern void free_reg_info (void);
1989 extern void init_subregs_of_mode (void);
1990 extern void finish_subregs_of_mode (void);
1991
1992 /* recog.c */
1993 extern rtx extract_asm_operands (rtx);
1994 extern int asm_noperands (const_rtx);
1995 extern const char *decode_asm_operands (rtx, rtx *, rtx **, const char **,
1996                                         enum machine_mode *, location_t *);
1997
1998 extern enum reg_class reg_preferred_class (int);
1999 extern enum reg_class reg_alternate_class (int);
2000 extern enum reg_class reg_allocno_class (int);
2001 extern void setup_reg_classes (int, enum reg_class, enum reg_class,
2002                                enum reg_class);
2003
2004 extern void split_all_insns (void);
2005 extern unsigned int split_all_insns_noflow (void);
2006
2007 #define MAX_SAVED_CONST_INT 64
2008 extern GTY(()) rtx const_int_rtx[MAX_SAVED_CONST_INT * 2 + 1];
2009
2010 #define const0_rtx      (const_int_rtx[MAX_SAVED_CONST_INT])
2011 #define const1_rtx      (const_int_rtx[MAX_SAVED_CONST_INT+1])
2012 #define const2_rtx      (const_int_rtx[MAX_SAVED_CONST_INT+2])
2013 #define constm1_rtx     (const_int_rtx[MAX_SAVED_CONST_INT-1])
2014 extern GTY(()) rtx const_true_rtx;
2015
2016 extern GTY(()) rtx const_tiny_rtx[3][(int) MAX_MACHINE_MODE];
2017
2018 /* Returns a constant 0 rtx in mode MODE.  Integer modes are treated the
2019    same as VOIDmode.  */
2020
2021 #define CONST0_RTX(MODE) (const_tiny_rtx[0][(int) (MODE)])
2022
2023 /* Likewise, for the constants 1 and 2.  */
2024
2025 #define CONST1_RTX(MODE) (const_tiny_rtx[1][(int) (MODE)])
2026 #define CONST2_RTX(MODE) (const_tiny_rtx[2][(int) (MODE)])
2027
2028 /* If HARD_FRAME_POINTER_REGNUM is defined, then a special dummy reg
2029    is used to represent the frame pointer.  This is because the
2030    hard frame pointer and the automatic variables are separated by an amount
2031    that cannot be determined until after register allocation.  We can assume
2032    that in this case ELIMINABLE_REGS will be defined, one action of which
2033    will be to eliminate FRAME_POINTER_REGNUM into HARD_FRAME_POINTER_REGNUM.  */
2034 #ifndef HARD_FRAME_POINTER_REGNUM
2035 #define HARD_FRAME_POINTER_REGNUM FRAME_POINTER_REGNUM
2036 #endif
2037
2038 #ifndef HARD_FRAME_POINTER_IS_FRAME_POINTER
2039 #define HARD_FRAME_POINTER_IS_FRAME_POINTER \
2040   (HARD_FRAME_POINTER_REGNUM == FRAME_POINTER_REGNUM)
2041 #endif
2042
2043 #ifndef HARD_FRAME_POINTER_IS_ARG_POINTER
2044 #define HARD_FRAME_POINTER_IS_ARG_POINTER \
2045   (HARD_FRAME_POINTER_REGNUM == ARG_POINTER_REGNUM)
2046 #endif
2047
2048 /* Index labels for global_rtl.  */
2049 enum global_rtl_index
2050 {
2051   GR_PC,
2052   GR_CC0,
2053   GR_RETURN,
2054   GR_STACK_POINTER,
2055   GR_FRAME_POINTER,
2056 /* For register elimination to work properly these hard_frame_pointer_rtx,
2057    frame_pointer_rtx, and arg_pointer_rtx must be the same if they refer to
2058    the same register.  */
2059 #if FRAME_POINTER_REGNUM == ARG_POINTER_REGNUM
2060   GR_ARG_POINTER = GR_FRAME_POINTER,
2061 #endif
2062 #if HARD_FRAME_POINTER_IS_FRAME_POINTER
2063   GR_HARD_FRAME_POINTER = GR_FRAME_POINTER,
2064 #else
2065   GR_HARD_FRAME_POINTER,
2066 #endif
2067 #if FRAME_POINTER_REGNUM != ARG_POINTER_REGNUM
2068 #if HARD_FRAME_POINTER_IS_ARG_POINTER
2069   GR_ARG_POINTER = GR_HARD_FRAME_POINTER,
2070 #else
2071   GR_ARG_POINTER,
2072 #endif
2073 #endif
2074   GR_VIRTUAL_INCOMING_ARGS,
2075   GR_VIRTUAL_STACK_ARGS,
2076   GR_VIRTUAL_STACK_DYNAMIC,
2077   GR_VIRTUAL_OUTGOING_ARGS,
2078   GR_VIRTUAL_CFA,
2079   GR_VIRTUAL_PREFERRED_STACK_BOUNDARY,
2080
2081   GR_MAX
2082 };
2083
2084 /* Target-dependent globals.  */
2085 struct GTY(()) target_rtl {
2086   /* All references to the hard registers in global_rtl_index go through
2087      these unique rtl objects.  On machines where the frame-pointer and
2088      arg-pointer are the same register, they use the same unique object.
2089
2090      After register allocation, other rtl objects which used to be pseudo-regs
2091      may be clobbered to refer to the frame-pointer register.
2092      But references that were originally to the frame-pointer can be
2093      distinguished from the others because they contain frame_pointer_rtx.
2094
2095      When to use frame_pointer_rtx and hard_frame_pointer_rtx is a little
2096      tricky: until register elimination has taken place hard_frame_pointer_rtx
2097      should be used if it is being set, and frame_pointer_rtx otherwise.  After
2098      register elimination hard_frame_pointer_rtx should always be used.
2099      On machines where the two registers are same (most) then these are the
2100      same.  */
2101   rtx x_global_rtl[GR_MAX];
2102
2103   /* A unique representation of (REG:Pmode PIC_OFFSET_TABLE_REGNUM).  */
2104   rtx x_pic_offset_table_rtx;
2105
2106   /* A unique representation of (REG:Pmode RETURN_ADDRESS_POINTER_REGNUM).
2107      This is used to implement __builtin_return_address for some machines;
2108      see for instance the MIPS port.  */
2109   rtx x_return_address_pointer_rtx;
2110
2111   /* Commonly used RTL for hard registers.  These objects are not
2112      necessarily unique, so we allocate them separately from global_rtl.
2113      They are initialized once per compilation unit, then copied into
2114      regno_reg_rtx at the beginning of each function.  */
2115   rtx x_initial_regno_reg_rtx[FIRST_PSEUDO_REGISTER];
2116
2117   /* A sample (mem:M stack_pointer_rtx) rtx for each mode M.  */
2118   rtx x_top_of_stack[MAX_MACHINE_MODE];
2119
2120   /* Static hunks of RTL used by the aliasing code; these are treated
2121      as persistent to avoid unnecessary RTL allocations.  */
2122   rtx x_static_reg_base_value[FIRST_PSEUDO_REGISTER];
2123 };
2124
2125 extern GTY(()) struct target_rtl default_target_rtl;
2126 #if SWITCHABLE_TARGET
2127 extern struct target_rtl *this_target_rtl;
2128 #else
2129 #define this_target_rtl (&default_target_rtl)
2130 #endif
2131
2132 #define global_rtl                              \
2133   (this_target_rtl->x_global_rtl)
2134 #define pic_offset_table_rtx \
2135   (this_target_rtl->x_pic_offset_table_rtx)
2136 #define return_address_pointer_rtx \
2137   (this_target_rtl->x_return_address_pointer_rtx)
2138 #define top_of_stack \
2139   (this_target_rtl->x_top_of_stack)
2140
2141 /* Standard pieces of rtx, to be substituted directly into things.  */
2142 #define pc_rtx                  (global_rtl[GR_PC])
2143 #define ret_rtx                 (global_rtl[GR_RETURN])
2144 #define cc0_rtx                 (global_rtl[GR_CC0])
2145
2146 /* All references to certain hard regs, except those created
2147    by allocating pseudo regs into them (when that's possible),
2148    go through these unique rtx objects.  */
2149 #define stack_pointer_rtx       (global_rtl[GR_STACK_POINTER])
2150 #define frame_pointer_rtx       (global_rtl[GR_FRAME_POINTER])
2151 #define hard_frame_pointer_rtx  (global_rtl[GR_HARD_FRAME_POINTER])
2152 #define arg_pointer_rtx         (global_rtl[GR_ARG_POINTER])
2153
2154 /* Include the RTL generation functions.  */
2155
2156 #ifndef GENERATOR_FILE
2157 #include "genrtl.h"
2158 #undef gen_rtx_ASM_INPUT
2159 #define gen_rtx_ASM_INPUT(MODE, ARG0)                           \
2160   gen_rtx_fmt_si (ASM_INPUT, (MODE), (ARG0), 0)
2161 #define gen_rtx_ASM_INPUT_loc(MODE, ARG0, LOC)                  \
2162   gen_rtx_fmt_si (ASM_INPUT, (MODE), (ARG0), (LOC))
2163 #endif
2164
2165 /* There are some RTL codes that require special attention; the
2166    generation functions included above do the raw handling.  If you
2167    add to this list, modify special_rtx in gengenrtl.c as well.  */
2168
2169 extern rtx gen_rtx_CONST_INT (enum machine_mode, HOST_WIDE_INT);
2170 extern rtx gen_rtx_CONST_VECTOR (enum machine_mode, rtvec);
2171 extern rtx gen_raw_REG (enum machine_mode, int);
2172 extern rtx gen_rtx_REG (enum machine_mode, unsigned);
2173 extern rtx gen_rtx_SUBREG (enum machine_mode, rtx, int);
2174 extern rtx gen_rtx_MEM (enum machine_mode, rtx);
2175
2176 #define GEN_INT(N)  gen_rtx_CONST_INT (VOIDmode, (N))
2177
2178 /* Virtual registers are used during RTL generation to refer to locations into
2179    the stack frame when the actual location isn't known until RTL generation
2180    is complete.  The routine instantiate_virtual_regs replaces these with
2181    the proper value, which is normally {frame,arg,stack}_pointer_rtx plus
2182    a constant.  */
2183
2184 #define FIRST_VIRTUAL_REGISTER  (FIRST_PSEUDO_REGISTER)
2185
2186 /* This points to the first word of the incoming arguments passed on the stack,
2187    either by the caller or by the callee when pretending it was passed by the
2188    caller.  */
2189
2190 #define virtual_incoming_args_rtx       (global_rtl[GR_VIRTUAL_INCOMING_ARGS])
2191
2192 #define VIRTUAL_INCOMING_ARGS_REGNUM    (FIRST_VIRTUAL_REGISTER)
2193
2194 /* If FRAME_GROWS_DOWNWARD, this points to immediately above the first
2195    variable on the stack.  Otherwise, it points to the first variable on
2196    the stack.  */
2197
2198 #define virtual_stack_vars_rtx          (global_rtl[GR_VIRTUAL_STACK_ARGS])
2199
2200 #define VIRTUAL_STACK_VARS_REGNUM       ((FIRST_VIRTUAL_REGISTER) + 1)
2201
2202 /* This points to the location of dynamically-allocated memory on the stack
2203    immediately after the stack pointer has been adjusted by the amount
2204    desired.  */
2205
2206 #define virtual_stack_dynamic_rtx       (global_rtl[GR_VIRTUAL_STACK_DYNAMIC])
2207
2208 #define VIRTUAL_STACK_DYNAMIC_REGNUM    ((FIRST_VIRTUAL_REGISTER) + 2)
2209
2210 /* This points to the location in the stack at which outgoing arguments should
2211    be written when the stack is pre-pushed (arguments pushed using push
2212    insns always use sp).  */
2213
2214 #define virtual_outgoing_args_rtx       (global_rtl[GR_VIRTUAL_OUTGOING_ARGS])
2215
2216 #define VIRTUAL_OUTGOING_ARGS_REGNUM    ((FIRST_VIRTUAL_REGISTER) + 3)
2217
2218 /* This points to the Canonical Frame Address of the function.  This
2219    should correspond to the CFA produced by INCOMING_FRAME_SP_OFFSET,
2220    but is calculated relative to the arg pointer for simplicity; the
2221    frame pointer nor stack pointer are necessarily fixed relative to
2222    the CFA until after reload.  */
2223
2224 #define virtual_cfa_rtx                 (global_rtl[GR_VIRTUAL_CFA])
2225
2226 #define VIRTUAL_CFA_REGNUM              ((FIRST_VIRTUAL_REGISTER) + 4)
2227
2228 #define LAST_VIRTUAL_POINTER_REGISTER   ((FIRST_VIRTUAL_REGISTER) + 4)
2229
2230 /* This is replaced by crtl->preferred_stack_boundary / BITS_PER_UNIT
2231    when finalized.  */
2232
2233 #define virtual_preferred_stack_boundary_rtx \
2234         (global_rtl[GR_VIRTUAL_PREFERRED_STACK_BOUNDARY])
2235
2236 #define VIRTUAL_PREFERRED_STACK_BOUNDARY_REGNUM \
2237                                         ((FIRST_VIRTUAL_REGISTER) + 5)
2238
2239 #define LAST_VIRTUAL_REGISTER           ((FIRST_VIRTUAL_REGISTER) + 5)
2240
2241 /* Nonzero if REGNUM is a pointer into the stack frame.  */
2242 #define REGNO_PTR_FRAME_P(REGNUM)               \
2243   ((REGNUM) == STACK_POINTER_REGNUM             \
2244    || (REGNUM) == FRAME_POINTER_REGNUM          \
2245    || (REGNUM) == HARD_FRAME_POINTER_REGNUM     \
2246    || (REGNUM) == ARG_POINTER_REGNUM            \
2247    || ((REGNUM) >= FIRST_VIRTUAL_REGISTER       \
2248        && (REGNUM) <= LAST_VIRTUAL_POINTER_REGISTER))
2249
2250 /* REGNUM never really appearing in the INSN stream.  */
2251 #define INVALID_REGNUM                  (~(unsigned int) 0)
2252
2253 extern rtx output_constant_def (tree, int);
2254 extern rtx lookup_constant_def (tree);
2255
2256 /* Nonzero after end of reload pass.
2257    Set to 1 or 0 by reload1.c.  */
2258
2259 extern int reload_completed;
2260
2261 /* Nonzero after thread_prologue_and_epilogue_insns has run.  */
2262 extern int epilogue_completed;
2263
2264 /* Set to 1 while reload_as_needed is operating.
2265    Required by some machines to handle any generated moves differently.  */
2266
2267 extern int reload_in_progress;
2268
2269 /* This macro indicates whether you may create a new
2270    pseudo-register.  */
2271
2272 #define can_create_pseudo_p() (!reload_in_progress && !reload_completed)
2273
2274 #ifdef STACK_REGS
2275 /* Nonzero after end of regstack pass.
2276    Set to 1 or 0 by reg-stack.c.  */
2277 extern int regstack_completed;
2278 #endif
2279
2280 /* If this is nonzero, we do not bother generating VOLATILE
2281    around volatile memory references, and we are willing to
2282    output indirect addresses.  If cse is to follow, we reject
2283    indirect addresses so a useful potential cse is generated;
2284    if it is used only once, instruction combination will produce
2285    the same indirect address eventually.  */
2286 extern int cse_not_expected;
2287
2288 /* Translates rtx code to tree code, for those codes needed by
2289    REAL_ARITHMETIC.  The function returns an int because the caller may not
2290    know what `enum tree_code' means.  */
2291
2292 extern int rtx_to_tree_code (enum rtx_code);
2293
2294 /* In cse.c */
2295 extern int delete_trivially_dead_insns (rtx, int);
2296 extern int cse_main (rtx, int);
2297 extern int exp_equiv_p (const_rtx, const_rtx, int, bool);
2298 extern unsigned hash_rtx (const_rtx x, enum machine_mode, int *, int *, bool);
2299
2300 /* In dse.c */
2301 extern void check_for_inc_dec (rtx insn);
2302
2303 /* In jump.c */
2304 extern int comparison_dominates_p (enum rtx_code, enum rtx_code);
2305 extern int condjump_p (const_rtx);
2306 extern int any_condjump_p (const_rtx);
2307 extern int any_uncondjump_p (const_rtx);
2308 extern rtx pc_set (const_rtx);
2309 extern rtx condjump_label (const_rtx);
2310 extern int simplejump_p (const_rtx);
2311 extern int returnjump_p (rtx);
2312 extern int eh_returnjump_p (rtx);
2313 extern int onlyjump_p (const_rtx);
2314 extern int only_sets_cc0_p (const_rtx);
2315 extern int sets_cc0_p (const_rtx);
2316 extern int invert_jump_1 (rtx, rtx);
2317 extern int invert_jump (rtx, rtx, int);
2318 extern int rtx_renumbered_equal_p (const_rtx, const_rtx);
2319 extern int true_regnum (const_rtx);
2320 extern unsigned int reg_or_subregno (const_rtx);
2321 extern int redirect_jump_1 (rtx, rtx);
2322 extern void redirect_jump_2 (rtx, rtx, rtx, int, int);
2323 extern int redirect_jump (rtx, rtx, int);
2324 extern void rebuild_jump_labels (rtx);
2325 extern void rebuild_jump_labels_chain (rtx);
2326 extern rtx reversed_comparison (const_rtx, enum machine_mode);
2327 extern enum rtx_code reversed_comparison_code (const_rtx, const_rtx);
2328 extern enum rtx_code reversed_comparison_code_parts (enum rtx_code, const_rtx,
2329                                                      const_rtx, const_rtx);
2330 extern void delete_for_peephole (rtx, rtx);
2331 extern int condjump_in_parallel_p (const_rtx);
2332
2333 /* In emit-rtl.c.  */
2334 extern int max_reg_num (void);
2335 extern int max_label_num (void);
2336 extern int get_first_label_num (void);
2337 extern void maybe_set_first_label_num (rtx);
2338 extern void delete_insns_since (rtx);
2339 extern void mark_reg_pointer (rtx, int);
2340 extern void mark_user_reg (rtx);
2341 extern void reset_used_flags (rtx);
2342 extern void set_used_flags (rtx);
2343 extern void reorder_insns (rtx, rtx, rtx);
2344 extern void reorder_insns_nobb (rtx, rtx, rtx);
2345 extern int get_max_insn_count (void);
2346 extern int in_sequence_p (void);
2347 extern void force_next_line_note (void);
2348 extern void init_emit (void);
2349 extern void init_emit_regs (void);
2350 extern void init_emit_once (void);
2351 extern void push_topmost_sequence (void);
2352 extern void pop_topmost_sequence (void);
2353 extern void set_new_first_and_last_insn (rtx, rtx);
2354 extern unsigned int unshare_all_rtl (void);
2355 extern void unshare_all_rtl_again (rtx);
2356 extern void unshare_all_rtl_in_chain (rtx);
2357 extern void verify_rtl_sharing (void);
2358 extern void link_cc0_insns (rtx);
2359 extern void add_insn (rtx);
2360 extern void add_insn_before (rtx, rtx, struct basic_block_def *);
2361 extern void add_insn_after (rtx, rtx, struct basic_block_def *);
2362 extern void remove_insn (rtx);
2363 extern rtx emit (rtx);
2364 extern rtx delete_insn (rtx);
2365 extern rtx entry_of_function (void);
2366 extern void emit_insn_at_entry (rtx);
2367 extern void delete_insn_chain (rtx, rtx, bool);
2368 extern rtx unlink_insn_chain (rtx, rtx);
2369 extern rtx delete_insn_and_edges (rtx);
2370 extern rtx gen_lowpart_SUBREG (enum machine_mode, rtx);
2371 extern rtx gen_const_mem (enum machine_mode, rtx);
2372 extern rtx gen_frame_mem (enum machine_mode, rtx);
2373 extern rtx gen_tmp_stack_mem (enum machine_mode, rtx);
2374 extern bool validate_subreg (enum machine_mode, enum machine_mode,
2375                              const_rtx, unsigned int);
2376
2377 /* In combine.c  */
2378 extern unsigned int extended_count (const_rtx, enum machine_mode, int);
2379 extern rtx remove_death (unsigned int, rtx);
2380 extern void dump_combine_stats (FILE *);
2381 extern void dump_combine_total_stats (FILE *);
2382
2383 /* In cfgcleanup.c  */
2384 extern void delete_dead_jumptables (void);
2385
2386 /* In sched-vis.c.  */
2387 extern void debug_bb_n_slim (int);
2388 extern void debug_bb_slim (struct basic_block_def *);
2389 extern void print_rtl_slim (FILE *, rtx, rtx, int, int);
2390 extern void print_rtl_slim_with_bb (FILE *, rtx, int);
2391 extern void dump_insn_slim (FILE *f, rtx x);
2392 extern void debug_insn_slim (rtx x);
2393
2394 /* In sched-rgn.c.  */
2395 extern void schedule_insns (void);
2396
2397 /* In sched-ebb.c.  */
2398 extern void schedule_ebbs (void);
2399
2400 /* In sel-sched-dump.c.  */
2401 extern void sel_sched_fix_param (const char *param, const char *val);
2402
2403 /* In print-rtl.c */
2404 extern const char *print_rtx_head;
2405 extern void debug_rtx (const_rtx);
2406 extern void debug_rtx_list (const_rtx, int);
2407 extern void debug_rtx_range (const_rtx, const_rtx);
2408 extern const_rtx debug_rtx_find (const_rtx, int);
2409 extern void print_mem_expr (FILE *, const_tree);
2410 extern void print_rtl (FILE *, const_rtx);
2411 extern void print_simple_rtl (FILE *, const_rtx);
2412 extern int print_rtl_single (FILE *, const_rtx);
2413 extern void print_inline_rtx (FILE *, const_rtx, int);
2414
2415 /* In function.c */
2416 extern void reposition_prologue_and_epilogue_notes (void);
2417 extern int prologue_epilogue_contains (const_rtx);
2418 extern int sibcall_epilogue_contains (const_rtx);
2419 extern void mark_temp_addr_taken (rtx);
2420 extern void update_temp_slot_address (rtx, rtx);
2421 extern void maybe_copy_prologue_epilogue_insn (rtx, rtx);
2422
2423 /* In stmt.c */
2424 extern void expand_null_return (void);
2425 extern void expand_naked_return (void);
2426 extern void emit_jump (rtx);
2427
2428 /* In expr.c */
2429 extern rtx move_by_pieces (rtx, rtx, unsigned HOST_WIDE_INT,
2430                            unsigned int, int);
2431
2432 /* In cfgrtl.c */
2433 extern void print_rtl_with_bb (FILE *, const_rtx);
2434
2435 /* In cfg.c.  */
2436 extern void dump_reg_info (FILE *);
2437 extern void dump_flow_info (FILE *, int);
2438
2439 /* In expmed.c */
2440 extern void init_expmed (void);
2441 extern void expand_inc (rtx, rtx);
2442 extern void expand_dec (rtx, rtx);
2443
2444 /* In gcse.c */
2445 extern bool can_copy_p (enum machine_mode);
2446 extern bool can_assign_to_reg_without_clobbers_p (rtx);
2447 extern rtx fis_get_condition (rtx);
2448
2449 /* In ira.c */
2450 #ifdef HARD_CONST
2451 extern HARD_REG_SET eliminable_regset;
2452 #endif
2453 extern void mark_elimination (int, int);
2454
2455 /* In reginfo.c */
2456 extern int reg_classes_intersect_p (reg_class_t, reg_class_t);
2457 extern int reg_class_subset_p (reg_class_t, reg_class_t);
2458 extern void globalize_reg (tree, int);
2459 extern void init_reg_modes_target (void);
2460 extern void init_regs (void);
2461 extern void reinit_regs (void);
2462 extern void init_fake_stack_mems (void);
2463 extern void save_register_info (void);
2464 extern void init_reg_sets (void);
2465 extern void regclass (rtx, int);
2466 extern void reg_scan (rtx, unsigned int);
2467 extern void fix_register (const char *, int, int);
2468 extern bool invalid_mode_change_p (unsigned int, enum reg_class);
2469
2470 /* In reorg.c */
2471 extern void dbr_schedule (rtx);
2472
2473 /* In reload1.c */
2474 extern int function_invariant_p (const_rtx);
2475
2476 /* In calls.c */
2477 enum libcall_type
2478 {
2479   LCT_NORMAL = 0,
2480   LCT_CONST = 1,
2481   LCT_PURE = 2,
2482   LCT_NORETURN = 3,
2483   LCT_THROW = 4,
2484   LCT_RETURNS_TWICE = 5
2485 };
2486
2487 extern void emit_library_call (rtx, enum libcall_type, enum machine_mode, int,
2488                                ...);
2489 extern rtx emit_library_call_value (rtx, rtx, enum libcall_type,
2490                                     enum machine_mode, int, ...);
2491
2492 /* In varasm.c */
2493 extern void init_varasm_once (void);
2494
2495 extern rtx make_debug_expr_from_rtl (const_rtx);
2496
2497 /* In read-rtl.c */
2498 extern bool read_rtx (const char *, rtx *);
2499
2500 /* In alias.c */
2501 extern rtx canon_rtx (rtx);
2502 extern int true_dependence (const_rtx, enum machine_mode, const_rtx, bool (*)(const_rtx, bool));
2503 extern rtx get_addr (rtx);
2504 extern int canon_true_dependence (const_rtx, enum machine_mode, rtx, const_rtx,
2505                                   rtx, bool (*)(const_rtx, bool));
2506 extern int read_dependence (const_rtx, const_rtx);
2507 extern int anti_dependence (const_rtx, const_rtx);
2508 extern int output_dependence (const_rtx, const_rtx);
2509 extern int may_alias_p (const_rtx, const_rtx);
2510 extern void init_alias_target (void);
2511 extern void init_alias_analysis (void);
2512 extern void end_alias_analysis (void);
2513 extern void vt_equate_reg_base_value (const_rtx, const_rtx);
2514 extern bool memory_modified_in_insn_p (const_rtx, const_rtx);
2515 extern rtx find_base_term (rtx);
2516 extern rtx gen_hard_reg_clobber (enum machine_mode, unsigned int);
2517 extern rtx get_reg_known_value (unsigned int);
2518 extern bool get_reg_known_equiv_p (unsigned int);
2519 extern rtx get_reg_base_value (unsigned int);
2520
2521 #ifdef STACK_REGS
2522 extern int stack_regs_mentioned (const_rtx insn);
2523 #endif
2524
2525 /* In toplev.c */
2526 extern GTY(()) rtx stack_limit_rtx;
2527
2528 /* In predict.c */
2529 extern void invert_br_probabilities (rtx);
2530 extern bool expensive_function_p (int);
2531
2532 /* In var-tracking.c */
2533 extern unsigned int variable_tracking_main (void);
2534
2535 /* In stor-layout.c.  */
2536 extern void get_mode_bounds (enum machine_mode, int, enum machine_mode,
2537                              rtx *, rtx *);
2538
2539 /* In loop-unswitch.c  */
2540 extern rtx reversed_condition (rtx);
2541 extern rtx compare_and_jump_seq (rtx, rtx, enum rtx_code, rtx, int, rtx);
2542
2543 /* In loop-iv.c  */
2544 extern rtx canon_condition (rtx);
2545 extern void simplify_using_condition (rtx, rtx *, struct bitmap_head_def *);
2546
2547 /* In final.c  */
2548 extern unsigned int compute_alignments (void);
2549 extern int asm_str_count (const char *templ);
2550 \f
2551 struct rtl_hooks
2552 {
2553   rtx (*gen_lowpart) (enum machine_mode, rtx);
2554   rtx (*gen_lowpart_no_emit) (enum machine_mode, rtx);
2555   rtx (*reg_nonzero_bits) (const_rtx, enum machine_mode, const_rtx, enum machine_mode,
2556                            unsigned HOST_WIDE_INT, unsigned HOST_WIDE_INT *);
2557   rtx (*reg_num_sign_bit_copies) (const_rtx, enum machine_mode, const_rtx, enum machine_mode,
2558                                   unsigned int, unsigned int *);
2559   bool (*reg_truncated_to_mode) (enum machine_mode, const_rtx);
2560
2561   /* Whenever you add entries here, make sure you adjust rtlhooks-def.h.  */
2562 };
2563
2564 /* Each pass can provide its own.  */
2565 extern struct rtl_hooks rtl_hooks;
2566
2567 /* ... but then it has to restore these.  */
2568 extern const struct rtl_hooks general_rtl_hooks;
2569
2570 /* Keep this for the nonce.  */
2571 #define gen_lowpart rtl_hooks.gen_lowpart
2572
2573 extern void insn_locators_alloc (void);
2574 extern void insn_locators_free (void);
2575 extern void insn_locators_finalize (void);
2576 extern void set_curr_insn_source_location (location_t);
2577 extern location_t get_curr_insn_source_location (void);
2578 extern void set_curr_insn_block (tree);
2579 extern tree get_curr_insn_block (void);
2580 extern int curr_insn_locator (void);
2581 extern bool optimize_insn_for_size_p (void);
2582 extern bool optimize_insn_for_speed_p (void);
2583
2584 /* rtl-error.c */
2585 extern void _fatal_insn_not_found (const_rtx, const char *, int, const char *)
2586      ATTRIBUTE_NORETURN;
2587 extern void _fatal_insn (const char *, const_rtx, const char *, int, const char *)
2588      ATTRIBUTE_NORETURN;
2589
2590 #define fatal_insn(msgid, insn) \
2591         _fatal_insn (msgid, insn, __FILE__, __LINE__, __FUNCTION__)
2592 #define fatal_insn_not_found(insn) \
2593         _fatal_insn_not_found (insn, __FILE__, __LINE__, __FUNCTION__)
2594
2595
2596
2597 #endif /* ! GCC_RTL_H */