gcc/rtl.h

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