gcc/rtl.h

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