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