gcc/rtl.h

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