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