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