gcc/rtl.h

   1 /* Register Transfer Language (RTL) definitions for GCC
   2    Copyright (C) 1987, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
   3    2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
   4    Free Software Foundation, Inc.
   5
   6 This file is part of GCC.
   7
   8 GCC is free software; you can redistribute it and/or modify it under
   9 the terms of the GNU General Public License as published by the Free
  10 Software Foundation; either version 3, or (at your option) any later
  11 version.
  12
  13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16 for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with GCC; see the file COPYING3.  If not see
  20 <http://www.gnu.org/licenses/>.  */
  21
  22 #ifndef GCC_RTL_H
  23 #define GCC_RTL_H
  24
  25 #include "statistics.h"
  26 #include "machmode.h"
  27 #include "input.h"
  28 #include "real.h"
  29 #include "vec.h"
  30 #include "vecir.h"
  31 #include "fixed-value.h"
  32 #include "alias.h"
  33 #include "hashtab.h"
  34 #include "flags.h"
  35
  36 /* Value used by some passes to "recognize" noop moves as valid
  37  instructions.  */
  38 #define NOOP_MOVE_INSN_CODE     INT_MAX
  39
  40 /* Register Transfer Language EXPRESSIONS CODES */
  41
  42 #define RTX_CODE        enum rtx_code
  43 enum rtx_code  {
  44
  45 #define DEF_RTL_EXPR(ENUM, NAME, FORMAT, CLASS)   ENUM ,
  46 #include "rtl.def"              /* rtl expressions are documented here */
  47 #undef DEF_RTL_EXPR
  48
  49   LAST_AND_UNUSED_RTX_CODE};    /* A convenient way to get a value for
  50                                    NUM_RTX_CODE.
  51                                    Assumes default enum value assignment.  */
  52
  53 /* The cast here, saves many elsewhere.  */
  54 #define NUM_RTX_CODE ((int) LAST_AND_UNUSED_RTX_CODE)
  55
  56 /* Similar, but since generator files get more entries... */
  57 #ifdef GENERATOR_FILE
  58 # define NON_GENERATOR_NUM_RTX_CODE ((int) MATCH_OPERAND)
  59 #endif
  60
  61 /* Register Transfer Language EXPRESSIONS CODE CLASSES */
  62
  63 enum rtx_class  {
  64   /* We check bit 0-1 of some rtx class codes in the predicates below.  */
  65
  66   /* Bit 0 = comparison if 0, arithmetic is 1
  67      Bit 1 = 1 if commutative.  */
  68   RTX_COMPARE,          /* 0 */
  69   RTX_COMM_COMPARE,
  70   RTX_BIN_ARITH,
  71   RTX_COMM_ARITH,
  72
  73   /* Must follow the four preceding values.  */
  74   RTX_UNARY,            /* 4 */
  75
  76   RTX_EXTRA,
  77   RTX_MATCH,
  78   RTX_INSN,
  79
  80   /* Bit 0 = 1 if constant.  */
  81   RTX_OBJ,              /* 8 */
  82   RTX_CONST_OBJ,
  83
  84   RTX_TERNARY,
  85   RTX_BITFIELD_OPS,
  86   RTX_AUTOINC
  87 };
  88
  89 #define RTX_OBJ_MASK (~1)
  90 #define RTX_OBJ_RESULT (RTX_OBJ & RTX_OBJ_MASK)
  91 #define RTX_COMPARE_MASK (~1)
  92 #define RTX_COMPARE_RESULT (RTX_COMPARE & RTX_COMPARE_MASK)
  93 #define RTX_ARITHMETIC_MASK (~1)
  94 #define RTX_ARITHMETIC_RESULT (RTX_COMM_ARITH & RTX_ARITHMETIC_MASK)
  95 #define RTX_BINARY_MASK (~3)
  96 #define RTX_BINARY_RESULT (RTX_COMPARE & RTX_BINARY_MASK)
  97 #define RTX_COMMUTATIVE_MASK (~2)
  98 #define RTX_COMMUTATIVE_RESULT (RTX_COMM_COMPARE & RTX_COMMUTATIVE_MASK)
  99 #define RTX_NON_COMMUTATIVE_RESULT (RTX_COMPARE & RTX_COMMUTATIVE_MASK)
 100
 101 extern const unsigned char rtx_length[NUM_RTX_CODE];
 102 #define GET_RTX_LENGTH(CODE)            (rtx_length[(int) (CODE)])
 103
 104 extern const char * const rtx_name[NUM_RTX_CODE];
 105 #define GET_RTX_NAME(CODE)              (rtx_name[(int) (CODE)])
 106
 107 extern const char * const rtx_format[NUM_RTX_CODE];
 108 #define GET_RTX_FORMAT(CODE)            (rtx_format[(int) (CODE)])
 109
 110 extern const enum rtx_class rtx_class[NUM_RTX_CODE];
 111 #define GET_RTX_CLASS(CODE)             (rtx_class[(int) (CODE)])
 112
 113 extern const unsigned char rtx_code_size[NUM_RTX_CODE];
 114 extern const unsigned char rtx_next[NUM_RTX_CODE];
 115 \f
 116 /* The flags and bitfields of an ADDR_DIFF_VEC.  BASE is the base label
 117    relative to which the offsets are calculated, as explained in rtl.def.  */
 118 typedef struct
 119 {
 120   /* Set at the start of shorten_branches - ONLY WHEN OPTIMIZING - : */
 121   unsigned min_align: 8;
 122   /* Flags: */
 123   unsigned base_after_vec: 1; /* BASE is after the ADDR_DIFF_VEC.  */
 124   unsigned min_after_vec: 1;  /* minimum address target label is
 125                                  after the ADDR_DIFF_VEC.  */
 126   unsigned max_after_vec: 1;  /* maximum address target label is
 127                                  after the ADDR_DIFF_VEC.  */
 128   unsigned min_after_base: 1; /* minimum address target label is
 129                                  after BASE.  */
 130   unsigned max_after_base: 1; /* maximum address target label is
 131                                  after BASE.  */
 132   /* Set by the actual branch shortening process - ONLY WHEN OPTIMIZING - : */
 133   unsigned offset_unsigned: 1; /* offsets have to be treated as unsigned.  */
 134   unsigned : 2;
 135   unsigned scale : 8;
 136 } addr_diff_vec_flags;
 137
 138 /* Structure used to describe the attributes of a MEM.  These are hashed
 139    so MEMs that the same attributes share a data structure.  This means
 140    they cannot be modified in place.  */
 141 typedef struct GTY(()) mem_attrs
 142 {
 143   /* The expression that the MEM accesses, or null if not known.
 144      This expression might be larger than the memory reference itself.
 145      (In other words, the MEM might access only part of the object.)  */
 146   tree expr;
 147
 148   /* The offset of the memory reference from the start of EXPR.
 149      Only valid if OFFSET_KNOWN_P.  */
 150   HOST_WIDE_INT offset;
 151
 152   /* The size of the memory reference in bytes.  Only valid if
 153      SIZE_KNOWN_P.  */
 154   HOST_WIDE_INT size;
 155
 156   /* The alias set of the memory reference.  */
 157   alias_set_type alias;
 158
 159   /* The alignment of the reference in bits.  Always a multiple of
 160      BITS_PER_UNIT.  Note that EXPR may have a stricter alignment
 161      than the memory reference itself.  */
 162   unsigned int align;
 163
 164   /* The address space that the memory reference uses.  */
 165   unsigned char addrspace;
 166
 167   /* True if OFFSET is known.  */
 168   bool offset_known_p;
 169
 170   /* True if SIZE is known.  */
 171   bool size_known_p;
 172 } mem_attrs;
 173
 174 /* Structure used to describe the attributes of a REG in similar way as
 175    mem_attrs does for MEM above.  Note that the OFFSET field is calculated
 176    in the same way as for mem_attrs, rather than in the same way as a
 177    SUBREG_BYTE.  For example, if a big-endian target stores a byte
 178    object in the low part of a 4-byte register, the OFFSET field
 179    will be -3 rather than 0.  */
 180
 181 typedef struct GTY(()) reg_attrs {
 182   tree decl;                    /* decl corresponding to REG.  */
 183   HOST_WIDE_INT offset;         /* Offset from start of DECL.  */
 184 } reg_attrs;
 185
 186 /* Common union for an element of an rtx.  */
 187
 188 union rtunion_def
 189 {
 190   int rt_int;
 191   unsigned int rt_uint;
 192   const char *rt_str;
 193   rtx rt_rtx;
 194   rtvec rt_rtvec;
 195   enum machine_mode rt_type;
 196   addr_diff_vec_flags rt_addr_diff_vec_flags;
 197   struct cselib_val_struct *rt_cselib;
 198   tree rt_tree;
 199   basic_block rt_bb;
 200   mem_attrs *rt_mem;
 201   reg_attrs *rt_reg;
 202   struct constant_descriptor_rtx *rt_constant;
 203   struct dw_cfi_struct *rt_cfi;
 204 };
 205 typedef union rtunion_def rtunion;
 206
 207 /* This structure remembers the position of a SYMBOL_REF within an
 208    object_block structure.  A SYMBOL_REF only provides this information
 209    if SYMBOL_REF_HAS_BLOCK_INFO_P is true.  */
 210 struct GTY(()) block_symbol {
 211   /* The usual SYMBOL_REF fields.  */
 212   rtunion GTY ((skip)) fld[3];
 213
 214   /* The block that contains this object.  */
 215   struct object_block *block;
 216
 217   /* The offset of this object from the start of its block.  It is negative
 218      if the symbol has not yet been assigned an offset.  */
 219   HOST_WIDE_INT offset;
 220 };
 221
 222 /* Describes a group of objects that are to be placed together in such
 223    a way that their relative positions are known.  */
 224 struct GTY(()) object_block {
 225   /* The section in which these objects should be placed.  */
 226   section *sect;
 227
 228   /* The alignment of the first object, measured in bits.  */
 229   unsigned int alignment;
 230
 231   /* The total size of the objects, measured in bytes.  */
 232   HOST_WIDE_INT size;
 233
 234   /* The SYMBOL_REFs for each object.  The vector is sorted in
 235      order of increasing offset and the following conditions will
 236      hold for each element X:
 237
 238          SYMBOL_REF_HAS_BLOCK_INFO_P (X)
 239          !SYMBOL_REF_ANCHOR_P (X)
 240          SYMBOL_REF_BLOCK (X) == [address of this structure]
 241          SYMBOL_REF_BLOCK_OFFSET (X) >= 0.  */
 242   VEC(rtx,gc) *objects;
 243
 244   /* All the anchor SYMBOL_REFs used to address these objects, sorted
 245      in order of increasing offset, and then increasing TLS model.
 246      The following conditions will hold for each element X in this vector:
 247
 248          SYMBOL_REF_HAS_BLOCK_INFO_P (X)
 249          SYMBOL_REF_ANCHOR_P (X)
 250          SYMBOL_REF_BLOCK (X) == [address of this structure]
 251          SYMBOL_REF_BLOCK_OFFSET (X) >= 0.  */
 252   VEC(rtx,gc) *anchors;
 253 };
 254
 255 /* RTL expression ("rtx").  */
 256
 257 struct GTY((chain_next ("RTX_NEXT (&%h)"),
 258             chain_prev ("RTX_PREV (&%h)"), variable_size)) rtx_def {
 259   /* The kind of expression this is.  */
 260   ENUM_BITFIELD(rtx_code) code: 16;
 261
 262   /* The kind of value the expression has.  */
 263   ENUM_BITFIELD(machine_mode) mode : 8;
 264
 265   /* 1 in a MEM if we should keep the alias set for this mem unchanged
 266      when we access a component.
 267      1 in a CALL_INSN if it is a sibling call.
 268      1 in a SET that is for a return.
 269      In a CODE_LABEL, part of the two-bit alternate entry field.
 270      1 in a CONCAT is VAL_EXPR_IS_COPIED in var-tracking.c.  */
 271   unsigned int jump : 1;
 272   /* In a CODE_LABEL, part of the two-bit alternate entry field.
 273      1 in a MEM if it cannot trap.
 274      1 in a CALL_INSN logically equivalent to
 275        ECF_LOOPING_CONST_OR_PURE and DECL_LOOPING_CONST_OR_PURE_P. */
 276   unsigned int call : 1;
 277   /* 1 in a REG, MEM, or CONCAT if the value is set at most once, anywhere.
 278      1 in a SUBREG used for SUBREG_PROMOTED_UNSIGNED_P.
 279      1 in a SYMBOL_REF if it addresses something in the per-function
 280      constants pool.
 281      1 in a CALL_INSN logically equivalent to ECF_CONST and TREE_READONLY.
 282      1 in a NOTE, or EXPR_LIST for a const call.
 283      1 in a JUMP_INSN of an annulling branch.
 284      1 in a CONCAT is VAL_EXPR_IS_CLOBBERED in var-tracking.c.
 285      1 in a preserved VALUE is PRESERVED_VALUE_P in cselib.c.  */
 286   unsigned int unchanging : 1;
 287   /* 1 in a MEM or ASM_OPERANDS expression if the memory reference is volatile.
 288      1 in an INSN, CALL_INSN, JUMP_INSN, CODE_LABEL, BARRIER, or NOTE
 289      if it has been deleted.
 290      1 in a REG expression if corresponds to a variable declared by the user,
 291      0 for an internally generated temporary.
 292      1 in a SUBREG used for SUBREG_PROMOTED_UNSIGNED_P.
 293      1 in a LABEL_REF, REG_LABEL_TARGET or REG_LABEL_OPERAND note for a
 294      non-local label.
 295      In a SYMBOL_REF, this flag is used for machine-specific purposes.
 296      In a PREFETCH, this flag indicates that it should be considered a scheduling
 297      barrier.
 298      1 in a CONCAT is VAL_NEEDS_RESOLUTION in var-tracking.c.  */
 299   unsigned int volatil : 1;
 300   /* 1 in a REG if the register is used only in exit code a loop.
 301      1 in a SUBREG expression if was generated from a variable with a
 302      promoted mode.
 303      1 in a CODE_LABEL if the label is used for nonlocal gotos
 304      and must not be deleted even if its count is zero.
 305      1 in an INSN, JUMP_INSN or CALL_INSN if this insn must be scheduled
 306      together with the preceding insn.  Valid only within sched.
 307      1 in an INSN, JUMP_INSN, or CALL_INSN if insn is in a delay slot and
 308      from the target of a branch.  Valid from reorg until end of compilation;
 309      cleared before used.
 310
 311      The name of the field is historical.  It used to be used in MEMs
 312      to record whether the MEM accessed part of a structure.  */
 313   unsigned int in_struct : 1;
 314   /* At the end of RTL generation, 1 if this rtx is used.  This is used for
 315      copying shared structure.  See `unshare_all_rtl'.
 316      In a REG, this is not needed for that purpose, and used instead
 317      in `leaf_renumber_regs_insn'.
 318      1 in a SYMBOL_REF, means that emit_library_call
 319      has used it as the function.
 320      1 in a CONCAT is VAL_HOLDS_TRACK_EXPR in var-tracking.c.
 321      1 in a VALUE or DEBUG_EXPR is VALUE_RECURSED_INTO in var-tracking.c.  */
 322   unsigned int used : 1;
 323   /* 1 in an INSN or a SET if this rtx is related to the call frame,
 324      either changing how we compute the frame address or saving and
 325      restoring registers in the prologue and epilogue.
 326      1 in a REG or MEM if it is a pointer.
 327      1 in a SYMBOL_REF if it addresses something in the per-function
 328      constant string pool.
 329      1 in a VALUE is VALUE_CHANGED in var-tracking.c.  */
 330   unsigned frame_related : 1;
 331   /* 1 in a REG or PARALLEL that is the current function's return value.
 332      1 in a SYMBOL_REF for a weak symbol.
 333      1 in a CALL_INSN logically equivalent to ECF_PURE and DECL_PURE_P.
 334      1 in a CONCAT is VAL_EXPR_HAS_REVERSE in var-tracking.c.
 335      1 in a VALUE or DEBUG_EXPR is NO_LOC_P in var-tracking.c.  */
 336   unsigned return_val : 1;
 337
 338   /* The first element of the operands of this rtx.
 339      The number of operands and their types are controlled
 340      by the `code' field, according to rtl.def.  */
 341   union u {
 342     rtunion fld[1];
 343     HOST_WIDE_INT hwint[1];
 344     struct block_symbol block_sym;
 345     struct real_value rv;
 346     struct fixed_value fv;
 347   } GTY ((special ("rtx_def"), desc ("GET_CODE (&%0)"))) u;
 348 };
 349
 350 /* The size in bytes of an rtx header (code, mode and flags).  */
 351 #define RTX_HDR_SIZE offsetof (struct rtx_def, u)
 352
 353 /* The size in bytes of an rtx with code CODE.  */
 354 #define RTX_CODE_SIZE(CODE) rtx_code_size[CODE]
 355
 356 #define NULL_RTX (rtx) 0
 357
 358 /* The "next" and "previous" RTX, relative to this one.  */
 359
 360 #define RTX_NEXT(X) (rtx_next[GET_CODE (X)] == 0 ? NULL                 \
 361                      : *(rtx *)(((char *)X) + rtx_next[GET_CODE (X)]))
 362
 363 /* FIXME: the "NEXT_INSN (PREV_INSN (X)) == X" condition shouldn't be needed.
 364  */
 365 #define RTX_PREV(X) ((INSN_P (X)                        \
 366                       || NOTE_P (X)                     \
 367                       || BARRIER_P (X)                  \
 368                       || LABEL_P (X))                   \
 369                      && PREV_INSN (X) != NULL           \
 370                      && NEXT_INSN (PREV_INSN (X)) == X  \
 371                      ? PREV_INSN (X) : NULL)
 372
 373 /* Define macros to access the `code' field of the rtx.  */
 374
 375 #define GET_CODE(RTX)       ((enum rtx_code) (RTX)->code)
 376 #define PUT_CODE(RTX, CODE) ((RTX)->code = (CODE))
 377
 378 #define GET_MODE(RTX)       ((enum machine_mode) (RTX)->mode)
 379 #define PUT_MODE(RTX, MODE) ((RTX)->mode = (MODE))
 380
 381 /* RTL vector.  These appear inside RTX's when there is a need
 382    for a variable number of things.  The principle use is inside
 383    PARALLEL expressions.  */
 384
 385 struct GTY((variable_size)) rtvec_def {
 386   int num_elem;         /* number of elements */
 387   rtx GTY ((length ("%h.num_elem"))) elem[1];
 388 };
 389
 390 #define NULL_RTVEC (rtvec) 0
 391
 392 #define GET_NUM_ELEM(RTVEC)             ((RTVEC)->num_elem)
 393 #define PUT_NUM_ELEM(RTVEC, NUM)        ((RTVEC)->num_elem = (NUM))
 394
 395 /* Predicate yielding nonzero iff X is an rtx for a register.  */
 396 #define REG_P(X) (GET_CODE (X) == REG)
 397
 398 /* Predicate yielding nonzero iff X is an rtx for a memory location.  */
 399 #define MEM_P(X) (GET_CODE (X) == MEM)
 400
 401 /* Match CONST_*s that can represent compile-time constant integers.  */
 402 #define CASE_CONST_SCALAR_INT \
 403    case CONST_INT: \
 404    case CONST_DOUBLE
 405
 406 /* Match CONST_*s for which pointer equality corresponds to value equality.  */
 407 #define CASE_CONST_UNIQUE \
 408    case CONST_INT: \
 409    case CONST_DOUBLE: \
 410    case CONST_FIXED
 411
 412 /* Match all CONST_* rtxes.  */
 413 #define CASE_CONST_ANY \
 414    case CONST_INT: \
 415    case CONST_DOUBLE: \
 416    case CONST_FIXED: \
 417    case CONST_VECTOR
 418
 419 /* Predicate yielding nonzero iff X is an rtx for a constant integer.  */
 420 #define CONST_INT_P(X) (GET_CODE (X) == CONST_INT)
 421
 422 /* Predicate yielding nonzero iff X is an rtx for a constant fixed-point.  */
 423 #define CONST_FIXED_P(X) (GET_CODE (X) == CONST_FIXED)
 424
 425 /* Predicate yielding true iff X is an rtx for a double-int
 426    or floating point constant.  */
 427 #define CONST_DOUBLE_P(X) (GET_CODE (X) == CONST_DOUBLE)
 428
 429 /* Predicate yielding true iff X is an rtx for a double-int.  */
 430 #define CONST_DOUBLE_AS_INT_P(X) \
 431   (GET_CODE (X) == CONST_DOUBLE && GET_MODE (X) == VOIDmode)
 432
 433 /* Predicate yielding true iff X is an rtx for a double-int.  */
 434 #define CONST_DOUBLE_AS_FLOAT_P(X) \
 435   (GET_CODE (X) == CONST_DOUBLE && GET_MODE (X) != VOIDmode)
 436
 437 /* Predicate yielding nonzero iff X is a label insn.  */
 438 #define LABEL_P(X) (GET_CODE (X) == CODE_LABEL)
 439
 440 /* Predicate yielding nonzero iff X is a jump insn.  */
 441 #define JUMP_P(X) (GET_CODE (X) == JUMP_INSN)
 442
 443 /* Predicate yielding nonzero iff X is a call insn.  */
 444 #define CALL_P(X) (GET_CODE (X) == CALL_INSN)
 445
 446 /* Predicate yielding nonzero iff X is an insn that cannot jump.  */
 447 #define NONJUMP_INSN_P(X) (GET_CODE (X) == INSN)
 448
 449 /* Predicate yielding nonzero iff X is a debug note/insn.  */
 450 #define DEBUG_INSN_P(X) (GET_CODE (X) == DEBUG_INSN)
 451
 452 /* Predicate yielding nonzero iff X is an insn that is not a debug insn.  */
 453 #define NONDEBUG_INSN_P(X) (INSN_P (X) && !DEBUG_INSN_P (X))
 454
 455 /* Nonzero if DEBUG_INSN_P may possibly hold.  */
 456 #define MAY_HAVE_DEBUG_INSNS (flag_var_tracking_assignments)
 457
 458 /* Predicate yielding nonzero iff X is a real insn.  */
 459 #define INSN_P(X) \
 460   (NONJUMP_INSN_P (X) || DEBUG_INSN_P (X) || JUMP_P (X) || CALL_P (X))
 461
 462 /* Predicate yielding nonzero iff X is a note insn.  */
 463 #define NOTE_P(X) (GET_CODE (X) == NOTE)
 464
 465 /* Predicate yielding nonzero iff X is a barrier insn.  */
 466 #define BARRIER_P(X) (GET_CODE (X) == BARRIER)
 467
 468 /* Predicate yielding nonzero iff X is a data for a jump table.  */
 469 #define JUMP_TABLE_DATA_P(INSN) \
 470   (JUMP_P (INSN) && (GET_CODE (PATTERN (INSN)) == ADDR_VEC || \
 471                      GET_CODE (PATTERN (INSN)) == ADDR_DIFF_VEC))
 472
 473 /* Predicate yielding nonzero iff X is a return or simple_return.  */
 474 #define ANY_RETURN_P(X) \
 475   (GET_CODE (X) == RETURN || GET_CODE (X) == SIMPLE_RETURN)
 476
 477 /* 1 if X is a unary operator.  */
 478
 479 #define UNARY_P(X)   \
 480   (GET_RTX_CLASS (GET_CODE (X)) == RTX_UNARY)
 481
 482 /* 1 if X is a binary operator.  */
 483
 484 #define BINARY_P(X)   \
 485   ((GET_RTX_CLASS (GET_CODE (X)) & RTX_BINARY_MASK) == RTX_BINARY_RESULT)
 486
 487 /* 1 if X is an arithmetic operator.  */
 488
 489 #define ARITHMETIC_P(X)   \
 490   ((GET_RTX_CLASS (GET_CODE (X)) & RTX_ARITHMETIC_MASK)                 \
 491     == RTX_ARITHMETIC_RESULT)
 492
 493 /* 1 if X is an arithmetic operator.  */
 494
 495 #define COMMUTATIVE_ARITH_P(X)   \
 496   (GET_RTX_CLASS (GET_CODE (X)) == RTX_COMM_ARITH)
 497
 498 /* 1 if X is a commutative arithmetic operator or a comparison operator.
 499    These two are sometimes selected together because it is possible to
 500    swap the two operands.  */
 501
 502 #define SWAPPABLE_OPERANDS_P(X)   \
 503   ((1 << GET_RTX_CLASS (GET_CODE (X)))                                  \
 504     & ((1 << RTX_COMM_ARITH) | (1 << RTX_COMM_COMPARE)                  \
 505        | (1 << RTX_COMPARE)))
 506
 507 /* 1 if X is a non-commutative operator.  */
 508
 509 #define NON_COMMUTATIVE_P(X)   \
 510   ((GET_RTX_CLASS (GET_CODE (X)) & RTX_COMMUTATIVE_MASK)                \
 511     == RTX_NON_COMMUTATIVE_RESULT)
 512
 513 /* 1 if X is a commutative operator on integers.  */
 514
 515 #define COMMUTATIVE_P(X)   \
 516   ((GET_RTX_CLASS (GET_CODE (X)) & RTX_COMMUTATIVE_MASK)                \
 517     == RTX_COMMUTATIVE_RESULT)
 518
 519 /* 1 if X is a relational operator.  */
 520
 521 #define COMPARISON_P(X)   \
 522   ((GET_RTX_CLASS (GET_CODE (X)) & RTX_COMPARE_MASK) == RTX_COMPARE_RESULT)
 523
 524 /* 1 if X is a constant value that is an integer.  */
 525
 526 #define CONSTANT_P(X)   \
 527   (GET_RTX_CLASS (GET_CODE (X)) == RTX_CONST_OBJ)
 528
 529 /* 1 if X can be used to represent an object.  */
 530 #define OBJECT_P(X)                                                     \
 531   ((GET_RTX_CLASS (GET_CODE (X)) & RTX_OBJ_MASK) == RTX_OBJ_RESULT)
 532
 533 /* General accessor macros for accessing the fields of an rtx.  */
 534
 535 #if defined ENABLE_RTL_CHECKING && (GCC_VERSION >= 2007)
 536 /* The bit with a star outside the statement expr and an & inside is
 537    so that N can be evaluated only once.  */
 538 #define RTL_CHECK1(RTX, N, C1) __extension__                            \
 539 (*({ __typeof (RTX) const _rtx = (RTX); const int _n = (N);             \
 540      const enum rtx_code _code = GET_CODE (_rtx);                       \
 541      if (_n < 0 || _n >= GET_RTX_LENGTH (_code))                        \
 542        rtl_check_failed_bounds (_rtx, _n, __FILE__, __LINE__,           \
 543                                 __FUNCTION__);                          \
 544      if (GET_RTX_FORMAT(_code)[_n] != C1)                               \
 545        rtl_check_failed_type1 (_rtx, _n, C1, __FILE__, __LINE__,        \
 546                                __FUNCTION__);                           \
 547      &_rtx->u.fld[_n]; }))
 548
 549 #define RTL_CHECK2(RTX, N, C1, C2) __extension__                        \
 550 (*({ __typeof (RTX) const _rtx = (RTX); const int _n = (N);             \
 551      const enum rtx_code _code = GET_CODE (_rtx);                       \
 552      if (_n < 0 || _n >= GET_RTX_LENGTH (_code))                        \
 553        rtl_check_failed_bounds (_rtx, _n, __FILE__, __LINE__,           \
 554                                 __FUNCTION__);                          \
 555      if (GET_RTX_FORMAT(_code)[_n] != C1                                \
 556          && GET_RTX_FORMAT(_code)[_n] != C2)                            \
 557        rtl_check_failed_type2 (_rtx, _n, C1, C2, __FILE__, __LINE__,    \
 558                                __FUNCTION__);                           \
 559      &_rtx->u.fld[_n]; }))
 560
 561 #define RTL_CHECKC1(RTX, N, C) __extension__                            \
 562 (*({ __typeof (RTX) const _rtx = (RTX); const int _n = (N);             \
 563      if (GET_CODE (_rtx) != (C))                                        \
 564        rtl_check_failed_code1 (_rtx, (C), __FILE__, __LINE__,           \
 565                                __FUNCTION__);                           \
 566      &_rtx->u.fld[_n]; }))
 567
 568 #define RTL_CHECKC2(RTX, N, C1, C2) __extension__                       \
 569 (*({ __typeof (RTX) const _rtx = (RTX); const int _n = (N);             \
 570      const enum rtx_code _code = GET_CODE (_rtx);                       \
 571      if (_code != (C1) && _code != (C2))                                \
 572        rtl_check_failed_code2 (_rtx, (C1), (C2), __FILE__, __LINE__,    \
 573                                __FUNCTION__); \
 574      &_rtx->u.fld[_n]; }))
 575
 576 #define RTVEC_ELT(RTVEC, I) __extension__                               \
 577 (*({ __typeof (RTVEC) const _rtvec = (RTVEC); const int _i = (I);       \
 578      if (_i < 0 || _i >= GET_NUM_ELEM (_rtvec))                         \
 579        rtvec_check_failed_bounds (_rtvec, _i, __FILE__, __LINE__,       \
 580                                   __FUNCTION__);                        \
 581      &_rtvec->elem[_i]; }))
 582
 583 #define XWINT(RTX, N) __extension__                                     \
 584 (*({ __typeof (RTX) const _rtx = (RTX); const int _n = (N);             \
 585      const enum rtx_code _code = GET_CODE (_rtx);                       \
 586      if (_n < 0 || _n >= GET_RTX_LENGTH (_code))                        \
 587        rtl_check_failed_bounds (_rtx, _n, __FILE__, __LINE__,           \
 588                                 __FUNCTION__);                          \
 589      if (GET_RTX_FORMAT(_code)[_n] != 'w')                              \
 590        rtl_check_failed_type1 (_rtx, _n, 'w', __FILE__, __LINE__,       \
 591                                __FUNCTION__);                           \
 592      &_rtx->u.hwint[_n]; }))
 593
 594 #define XCWINT(RTX, N, C) __extension__                                 \
 595 (*({ __typeof (RTX) const _rtx = (RTX);                                 \
 596      if (GET_CODE (_rtx) != (C))                                        \
 597        rtl_check_failed_code1 (_rtx, (C), __FILE__, __LINE__,           \
 598                                __FUNCTION__);                           \
 599      &_rtx->u.hwint[N]; }))
 600
 601 #define XCMWINT(RTX, N, C, M) __extension__                             \
 602 (*({ __typeof (RTX) const _rtx = (RTX);                                 \
 603      if (GET_CODE (_rtx) != (C) || GET_MODE (_rtx) != (M))              \
 604        rtl_check_failed_code_mode (_rtx, (C), (M), false, __FILE__,     \
 605                                    __LINE__, __FUNCTION__);             \
 606      &_rtx->u.hwint[N]; }))
 607
 608 #define XCNMPRV(RTX, C, M) __extension__                                \
 609 ({ __typeof (RTX) const _rtx = (RTX);                                   \
 610    if (GET_CODE (_rtx) != (C) || GET_MODE (_rtx) == (M))                \
 611      rtl_check_failed_code_mode (_rtx, (C), (M), true, __FILE__,        \
 612                                  __LINE__, __FUNCTION__);               \
 613    &_rtx->u.rv; })
 614
 615 #define XCNMPFV(RTX, C, M) __extension__                                \
 616 ({ __typeof (RTX) const _rtx = (RTX);                                   \
 617    if (GET_CODE (_rtx) != (C) || GET_MODE (_rtx) == (M))                \
 618      rtl_check_failed_code_mode (_rtx, (C), (M), true, __FILE__,        \
 619                                  __LINE__, __FUNCTION__);               \
 620    &_rtx->u.fv; })
 621
 622 #define BLOCK_SYMBOL_CHECK(RTX) __extension__                           \
 623 ({ __typeof (RTX) const _symbol = (RTX);                                \
 624    const unsigned int flags = RTL_CHECKC1 (_symbol, 1, SYMBOL_REF).rt_int; \
 625    if ((flags & SYMBOL_FLAG_HAS_BLOCK_INFO) == 0)                       \
 626      rtl_check_failed_block_symbol (__FILE__, __LINE__,                 \
 627                                     __FUNCTION__);                      \
 628    &_symbol->u.block_sym; })
 629
 630 extern void rtl_check_failed_bounds (const_rtx, int, const char *, int,
 631                                      const char *)
 632     ATTRIBUTE_NORETURN;
 633 extern void rtl_check_failed_type1 (const_rtx, int, int, const char *, int,
 634                                     const char *)
 635     ATTRIBUTE_NORETURN;
 636 extern void rtl_check_failed_type2 (const_rtx, int, int, int, const char *,
 637                                     int, const char *)
 638     ATTRIBUTE_NORETURN;
 639 extern void rtl_check_failed_code1 (const_rtx, enum rtx_code, const char *,
 640                                     int, const char *)
 641     ATTRIBUTE_NORETURN;
 642 extern void rtl_check_failed_code2 (const_rtx, enum rtx_code, enum rtx_code,
 643                                     const char *, int, const char *)
 644     ATTRIBUTE_NORETURN;
 645 extern void rtl_check_failed_code_mode (const_rtx, enum rtx_code, enum machine_mode,
 646                                         bool, const char *, int, const char *)
 647     ATTRIBUTE_NORETURN;
 648 extern void rtl_check_failed_block_symbol (const char *, int, const char *)
 649     ATTRIBUTE_NORETURN;
 650 extern void rtvec_check_failed_bounds (const_rtvec, int, const char *, int,
 651                                        const char *)
 652     ATTRIBUTE_NORETURN;
 653
 654 #else   /* not ENABLE_RTL_CHECKING */
 655
 656 #define RTL_CHECK1(RTX, N, C1)      ((RTX)->u.fld[N])
 657 #define RTL_CHECK2(RTX, N, C1, C2)  ((RTX)->u.fld[N])
 658 #define RTL_CHECKC1(RTX, N, C)      ((RTX)->u.fld[N])
 659 #define RTL_CHECKC2(RTX, N, C1, C2) ((RTX)->u.fld[N])
 660 #define RTVEC_ELT(RTVEC, I)         ((RTVEC)->elem[I])
 661 #define XWINT(RTX, N)               ((RTX)->u.hwint[N])
 662 #define XCWINT(RTX, N, C)           ((RTX)->u.hwint[N])
 663 #define XCMWINT(RTX, N, C, M)       ((RTX)->u.hwint[N])
 664 #define XCNMWINT(RTX, N, C, M)      ((RTX)->u.hwint[N])
 665 #define XCNMPRV(RTX, C, M)          (&(RTX)->u.rv)
 666 #define XCNMPFV(RTX, C, M)          (&(RTX)->u.fv)
 667 #define BLOCK_SYMBOL_CHECK(RTX)     (&(RTX)->u.block_sym)
 668
 669 #endif
 670
 671 /* General accessor macros for accessing the flags of an rtx.  */
 672
 673 /* Access an individual rtx flag, with no checking of any kind.  */
 674 #define RTX_FLAG(RTX, FLAG)     ((RTX)->FLAG)
 675
 676 #if defined ENABLE_RTL_FLAG_CHECKING && (GCC_VERSION >= 2007)
 677 #define RTL_FLAG_CHECK1(NAME, RTX, C1) __extension__                    \
 678 ({ __typeof (RTX) const _rtx = (RTX);                                   \
 679    if (GET_CODE(_rtx) != C1)                                            \
 680      rtl_check_failed_flag  (NAME, _rtx, __FILE__, __LINE__,            \
 681                              __FUNCTION__);                             \
 682    _rtx; })
 683
 684 #define RTL_FLAG_CHECK2(NAME, RTX, C1, C2) __extension__                \
 685 ({ __typeof (RTX) const _rtx = (RTX);                                   \
 686    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2)                    \
 687      rtl_check_failed_flag  (NAME,_rtx, __FILE__, __LINE__,             \
 688                               __FUNCTION__);                            \
 689    _rtx; })
 690
 691 #define RTL_FLAG_CHECK3(NAME, RTX, C1, C2, C3) __extension__            \
 692 ({ __typeof (RTX) const _rtx = (RTX);                                   \
 693    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2                     \
 694        && GET_CODE(_rtx) != C3)                                         \
 695      rtl_check_failed_flag  (NAME, _rtx, __FILE__, __LINE__,            \
 696                              __FUNCTION__);                             \
 697    _rtx; })
 698
 699 #define RTL_FLAG_CHECK4(NAME, RTX, C1, C2, C3, C4) __extension__        \
 700 ({ __typeof (RTX) const _rtx = (RTX);                                   \
 701    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2                     \
 702        && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4)                 \
 703      rtl_check_failed_flag  (NAME, _rtx, __FILE__, __LINE__,            \
 704                               __FUNCTION__);                            \
 705    _rtx; })
 706
 707 #define RTL_FLAG_CHECK5(NAME, RTX, C1, C2, C3, C4, C5) __extension__    \
 708 ({ __typeof (RTX) const _rtx = (RTX);                                   \
 709    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2                     \
 710        && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4                  \
 711        && GET_CODE(_rtx) != C5)                                         \
 712      rtl_check_failed_flag  (NAME, _rtx, __FILE__, __LINE__,            \
 713                              __FUNCTION__);                             \
 714    _rtx; })
 715
 716 #define RTL_FLAG_CHECK6(NAME, RTX, C1, C2, C3, C4, C5, C6)              \
 717   __extension__                                                         \
 718 ({ __typeof (RTX) const _rtx = (RTX);                                   \
 719    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2                     \
 720        && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4                  \
 721        && GET_CODE(_rtx) != C5 && GET_CODE(_rtx) != C6)                 \
 722      rtl_check_failed_flag  (NAME,_rtx, __FILE__, __LINE__,             \
 723                              __FUNCTION__);                             \
 724    _rtx; })
 725
 726 #define RTL_FLAG_CHECK7(NAME, RTX, C1, C2, C3, C4, C5, C6, C7)          \
 727   __extension__                                                         \
 728 ({ __typeof (RTX) const _rtx = (RTX);                                   \
 729    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2                     \
 730        && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4                  \
 731        && GET_CODE(_rtx) != C5 && GET_CODE(_rtx) != C6                  \
 732        && GET_CODE(_rtx) != C7)                                         \
 733      rtl_check_failed_flag  (NAME, _rtx, __FILE__, __LINE__,            \
 734                              __FUNCTION__);                             \
 735    _rtx; })
 736
 737 #define RTL_FLAG_CHECK8(NAME, RTX, C1, C2, C3, C4, C5, C6, C7, C8)      \
 738   __extension__                                                         \
 739 ({ __typeof (RTX) const _rtx = (RTX);                                   \
 740    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2                     \
 741        && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4                  \
 742        && GET_CODE(_rtx) != C5 && GET_CODE(_rtx) != C6                  \
 743        && GET_CODE(_rtx) != C7 && GET_CODE(_rtx) != C8)                 \
 744      rtl_check_failed_flag  (NAME, _rtx, __FILE__, __LINE__,            \
 745                              __FUNCTION__);                             \
 746    _rtx; })
 747
 748 extern void rtl_check_failed_flag (const char *, const_rtx, const char *,
 749                                    int, const char *)
 750     ATTRIBUTE_NORETURN
 751     ;
 752
 753 #else   /* not ENABLE_RTL_FLAG_CHECKING */
 754
 755 #define RTL_FLAG_CHECK1(NAME, RTX, C1)                                  (RTX)
 756 #define RTL_FLAG_CHECK2(NAME, RTX, C1, C2)                              (RTX)
 757 #define RTL_FLAG_CHECK3(NAME, RTX, C1, C2, C3)                          (RTX)
 758 #define RTL_FLAG_CHECK4(NAME, RTX, C1, C2, C3, C4)                      (RTX)
 759 #define RTL_FLAG_CHECK5(NAME, RTX, C1, C2, C3, C4, C5)          (RTX)
 760 #define RTL_FLAG_CHECK6(NAME, RTX, C1, C2, C3, C4, C5, C6)              (RTX)
 761 #define RTL_FLAG_CHECK7(NAME, RTX, C1, C2, C3, C4, C5, C6, C7)          (RTX)
 762 #define RTL_FLAG_CHECK8(NAME, RTX, C1, C2, C3, C4, C5, C6, C7, C8)      (RTX)
 763 #endif
 764
 765 #define XINT(RTX, N)    (RTL_CHECK2 (RTX, N, 'i', 'n').rt_int)
 766 #define XUINT(RTX, N)   (RTL_CHECK2 (RTX, N, 'i', 'n').rt_uint)
 767 #define XSTR(RTX, N)    (RTL_CHECK2 (RTX, N, 's', 'S').rt_str)
 768 #define XEXP(RTX, N)    (RTL_CHECK2 (RTX, N, 'e', 'u').rt_rtx)
 769 #define XVEC(RTX, N)    (RTL_CHECK2 (RTX, N, 'E', 'V').rt_rtvec)
 770 #define XMODE(RTX, N)   (RTL_CHECK1 (RTX, N, 'M').rt_type)
 771 #define XTREE(RTX, N)   (RTL_CHECK1 (RTX, N, 't').rt_tree)
 772 #define XBBDEF(RTX, N)  (RTL_CHECK1 (RTX, N, 'B').rt_bb)
 773 #define XTMPL(RTX, N)   (RTL_CHECK1 (RTX, N, 'T').rt_str)
 774 #define XCFI(RTX, N)    (RTL_CHECK1 (RTX, N, 'C').rt_cfi)
 775
 776 #define XVECEXP(RTX, N, M)      RTVEC_ELT (XVEC (RTX, N), M)
 777 #define XVECLEN(RTX, N)         GET_NUM_ELEM (XVEC (RTX, N))
 778
 779 /* These are like XINT, etc. except that they expect a '0' field instead
 780    of the normal type code.  */
 781
 782 #define X0INT(RTX, N)      (RTL_CHECK1 (RTX, N, '0').rt_int)
 783 #define X0UINT(RTX, N)     (RTL_CHECK1 (RTX, N, '0').rt_uint)
 784 #define X0STR(RTX, N)      (RTL_CHECK1 (RTX, N, '0').rt_str)
 785 #define X0EXP(RTX, N)      (RTL_CHECK1 (RTX, N, '0').rt_rtx)
 786 #define X0VEC(RTX, N)      (RTL_CHECK1 (RTX, N, '0').rt_rtvec)
 787 #define X0MODE(RTX, N)     (RTL_CHECK1 (RTX, N, '0').rt_type)
 788 #define X0TREE(RTX, N)     (RTL_CHECK1 (RTX, N, '0').rt_tree)
 789 #define X0BBDEF(RTX, N)    (RTL_CHECK1 (RTX, N, '0').rt_bb)
 790 #define X0ADVFLAGS(RTX, N) (RTL_CHECK1 (RTX, N, '0').rt_addr_diff_vec_flags)
 791 #define X0CSELIB(RTX, N)   (RTL_CHECK1 (RTX, N, '0').rt_cselib)
 792 #define X0MEMATTR(RTX, N)  (RTL_CHECKC1 (RTX, N, MEM).rt_mem)
 793 #define X0REGATTR(RTX, N)  (RTL_CHECKC1 (RTX, N, REG).rt_reg)
 794 #define X0CONSTANT(RTX, N) (RTL_CHECK1 (RTX, N, '0').rt_constant)
 795
 796 /* Access a '0' field with any type.  */
 797 #define X0ANY(RTX, N)      RTL_CHECK1 (RTX, N, '0')
 798
 799 #define XCINT(RTX, N, C)      (RTL_CHECKC1 (RTX, N, C).rt_int)
 800 #define XCUINT(RTX, N, C)     (RTL_CHECKC1 (RTX, N, C).rt_uint)
 801 #define XCSTR(RTX, N, C)      (RTL_CHECKC1 (RTX, N, C).rt_str)
 802 #define XCEXP(RTX, N, C)      (RTL_CHECKC1 (RTX, N, C).rt_rtx)
 803 #define XCVEC(RTX, N, C)      (RTL_CHECKC1 (RTX, N, C).rt_rtvec)
 804 #define XCMODE(RTX, N, C)     (RTL_CHECKC1 (RTX, N, C).rt_type)
 805 #define XCTREE(RTX, N, C)     (RTL_CHECKC1 (RTX, N, C).rt_tree)
 806 #define XCBBDEF(RTX, N, C)    (RTL_CHECKC1 (RTX, N, C).rt_bb)
 807 #define XCCFI(RTX, N, C)      (RTL_CHECKC1 (RTX, N, C).rt_cfi)
 808 #define XCCSELIB(RTX, N, C)   (RTL_CHECKC1 (RTX, N, C).rt_cselib)
 809
 810 #define XCVECEXP(RTX, N, M, C)  RTVEC_ELT (XCVEC (RTX, N, C), M)
 811 #define XCVECLEN(RTX, N, C)     GET_NUM_ELEM (XCVEC (RTX, N, C))
 812
 813 #define XC2EXP(RTX, N, C1, C2)      (RTL_CHECKC2 (RTX, N, C1, C2).rt_rtx)
 814 \f
 815 /* ACCESS MACROS for particular fields of insns.  */
 816
 817 /* Holds a unique number for each insn.
 818    These are not necessarily sequentially increasing.  */
 819 #define INSN_UID(INSN)  XINT (INSN, 0)
 820
 821 /* Chain insns together in sequence.  */
 822 #define PREV_INSN(INSN) XEXP (INSN, 1)
 823 #define NEXT_INSN(INSN) XEXP (INSN, 2)
 824
 825 #define BLOCK_FOR_INSN(INSN) XBBDEF (INSN, 3)
 826
 827 /* The body of an insn.  */
 828 #define PATTERN(INSN)   XEXP (INSN, 4)
 829
 830 #define INSN_LOCATION(INSN) XUINT (INSN, 5)
 831
 832 #define INSN_HAS_LOCATION(INSN) ((LOCATION_LOCUS (INSN_LOCATION (INSN)))\
 833   != UNKNOWN_LOCATION)
 834
 835 /* LOCATION of an RTX if relevant.  */
 836 #define RTL_LOCATION(X) (INSN_P (X) ? \
 837                          INSN_LOCATION (X) : UNKNOWN_LOCATION)
 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 tree insn_scope (const_rtx);
1837 extern location_t prologue_location, epilogue_location;
1838
1839 /* In jump.c */
1840 extern enum rtx_code reverse_condition (enum rtx_code);
1841 extern enum rtx_code reverse_condition_maybe_unordered (enum rtx_code);
1842 extern enum rtx_code swap_condition (enum rtx_code);
1843 extern enum rtx_code unsigned_condition (enum rtx_code);
1844 extern enum rtx_code signed_condition (enum rtx_code);
1845 extern void mark_jump_label (rtx, rtx, int);
1846 extern unsigned int cleanup_barriers (void);
1847
1848 /* In jump.c */
1849 extern rtx delete_related_insns (rtx);
1850
1851 /* In recog.c  */
1852 extern rtx *find_constant_term_loc (rtx *);
1853
1854 /* In emit-rtl.c  */
1855 extern rtx try_split (rtx, rtx, int);
1856 extern int split_branch_probability;
1857
1858 /* In unknown file  */
1859 extern rtx split_insns (rtx, rtx);
1860
1861 /* In simplify-rtx.c  */
1862 extern rtx simplify_const_unary_operation (enum rtx_code, enum machine_mode,
1863                                            rtx, enum machine_mode);
1864 extern rtx simplify_unary_operation (enum rtx_code, enum machine_mode, rtx,
1865                                      enum machine_mode);
1866 extern rtx simplify_const_binary_operation (enum rtx_code, enum machine_mode,
1867                                             rtx, rtx);
1868 extern rtx simplify_binary_operation (enum rtx_code, enum machine_mode, rtx,
1869                                       rtx);
1870 extern rtx simplify_ternary_operation (enum rtx_code, enum machine_mode,
1871                                        enum machine_mode, rtx, rtx, rtx);
1872 extern rtx simplify_const_relational_operation (enum rtx_code,
1873                                                 enum machine_mode, rtx, rtx);
1874 extern rtx simplify_relational_operation (enum rtx_code, enum machine_mode,
1875                                           enum machine_mode, rtx, rtx);
1876 extern rtx simplify_gen_binary (enum rtx_code, enum machine_mode, rtx, rtx);
1877 extern rtx simplify_gen_unary (enum rtx_code, enum machine_mode, rtx,
1878                                enum machine_mode);
1879 extern rtx simplify_gen_ternary (enum rtx_code, enum machine_mode,
1880                                  enum machine_mode, rtx, rtx, rtx);
1881 extern rtx simplify_gen_relational (enum rtx_code, enum machine_mode,
1882                                     enum machine_mode, rtx, rtx);
1883 extern rtx simplify_subreg (enum machine_mode, rtx, enum machine_mode,
1884                             unsigned int);
1885 extern rtx simplify_gen_subreg (enum machine_mode, rtx, enum machine_mode,
1886                                 unsigned int);
1887 extern rtx simplify_replace_fn_rtx (rtx, const_rtx,
1888                                     rtx (*fn) (rtx, const_rtx, void *), void *);
1889 extern rtx simplify_replace_rtx (rtx, const_rtx, rtx);
1890 extern rtx simplify_rtx (const_rtx);
1891 extern rtx avoid_constant_pool_reference (rtx);
1892 extern rtx delegitimize_mem_from_attrs (rtx);
1893 extern bool mode_signbit_p (enum machine_mode, const_rtx);
1894 extern bool val_signbit_p (enum machine_mode, unsigned HOST_WIDE_INT);
1895 extern bool val_signbit_known_set_p (enum machine_mode,
1896                                      unsigned HOST_WIDE_INT);
1897 extern bool val_signbit_known_clear_p (enum machine_mode,
1898                                        unsigned HOST_WIDE_INT);
1899
1900 /* In reginfo.c  */
1901 extern enum machine_mode choose_hard_reg_mode (unsigned int, unsigned int,
1902                                                bool);
1903
1904 /* In emit-rtl.c  */
1905 extern rtx set_unique_reg_note (rtx, enum reg_note, rtx);
1906 extern rtx set_dst_reg_note (rtx, enum reg_note, rtx, rtx);
1907 extern void set_insn_deleted (rtx);
1908
1909 /* Functions in rtlanal.c */
1910
1911 /* Single set is implemented as macro for performance reasons.  */
1912 #define single_set(I) (INSN_P (I) \
1913                        ? (GET_CODE (PATTERN (I)) == SET \
1914                           ? PATTERN (I) : single_set_1 (I)) \
1915                        : NULL_RTX)
1916 #define single_set_1(I) single_set_2 (I, PATTERN (I))
1917
1918 /* Structure used for passing data to REPLACE_LABEL.  */
1919 typedef struct replace_label_data
1920 {
1921   rtx r1;
1922   rtx r2;
1923   bool update_label_nuses;
1924 } replace_label_data;
1925
1926 extern enum machine_mode get_address_mode (rtx mem);
1927 extern int rtx_addr_can_trap_p (const_rtx);
1928 extern bool nonzero_address_p (const_rtx);
1929 extern int rtx_unstable_p (const_rtx);
1930 extern bool rtx_varies_p (const_rtx, bool);
1931 extern bool rtx_addr_varies_p (const_rtx, bool);
1932 extern HOST_WIDE_INT get_integer_term (const_rtx);
1933 extern rtx get_related_value (const_rtx);
1934 extern bool offset_within_block_p (const_rtx, HOST_WIDE_INT);
1935 extern void split_const (rtx, rtx *, rtx *);
1936 extern bool unsigned_reg_p (rtx);
1937 extern int reg_mentioned_p (const_rtx, const_rtx);
1938 extern int count_occurrences (const_rtx, const_rtx, int);
1939 extern int reg_referenced_p (const_rtx, const_rtx);
1940 extern int reg_used_between_p (const_rtx, const_rtx, const_rtx);
1941 extern int reg_set_between_p (const_rtx, const_rtx, const_rtx);
1942 extern int commutative_operand_precedence (rtx);
1943 extern bool swap_commutative_operands_p (rtx, rtx);
1944 extern int modified_between_p (const_rtx, const_rtx, const_rtx);
1945 extern int no_labels_between_p (const_rtx, const_rtx);
1946 extern int modified_in_p (const_rtx, const_rtx);
1947 extern int reg_set_p (const_rtx, const_rtx);
1948 extern rtx single_set_2 (const_rtx, const_rtx);
1949 extern int multiple_sets (const_rtx);
1950 extern int set_noop_p (const_rtx);
1951 extern int noop_move_p (const_rtx);
1952 extern rtx find_last_value (rtx, rtx *, rtx, int);
1953 extern int refers_to_regno_p (unsigned int, unsigned int, const_rtx, rtx *);
1954 extern int reg_overlap_mentioned_p (const_rtx, const_rtx);
1955 extern const_rtx set_of (const_rtx, const_rtx);
1956 extern void record_hard_reg_sets (rtx, const_rtx, void *);
1957 extern void record_hard_reg_uses (rtx *, void *);
1958 #ifdef HARD_CONST
1959 extern void find_all_hard_reg_sets (const_rtx, HARD_REG_SET *);
1960 #endif
1961 extern void note_stores (const_rtx, void (*) (rtx, const_rtx, void *), void *);
1962 extern void note_uses (rtx *, void (*) (rtx *, void *), void *);
1963 extern int dead_or_set_p (const_rtx, const_rtx);
1964 extern int dead_or_set_regno_p (const_rtx, unsigned int);
1965 extern rtx find_reg_note (const_rtx, enum reg_note, const_rtx);
1966 extern rtx find_regno_note (const_rtx, enum reg_note, unsigned int);
1967 extern rtx find_reg_equal_equiv_note (const_rtx);
1968 extern rtx find_constant_src (const_rtx);
1969 extern int find_reg_fusage (const_rtx, enum rtx_code, const_rtx);
1970 extern int find_regno_fusage (const_rtx, enum rtx_code, unsigned int);
1971 extern rtx alloc_reg_note (enum reg_note, rtx, rtx);
1972 extern void add_reg_note (rtx, enum reg_note, rtx);
1973 extern void remove_note (rtx, const_rtx);
1974 extern void remove_reg_equal_equiv_notes (rtx);
1975 extern void remove_reg_equal_equiv_notes_for_regno (unsigned int);
1976 extern int side_effects_p (const_rtx);
1977 extern int volatile_refs_p (const_rtx);
1978 extern int volatile_insn_p (const_rtx);
1979 extern int may_trap_p_1 (const_rtx, unsigned);
1980 extern int may_trap_p (const_rtx);
1981 extern int may_trap_or_fault_p (const_rtx);
1982 extern bool can_throw_internal (const_rtx);
1983 extern bool can_throw_external (const_rtx);
1984 extern bool insn_could_throw_p (const_rtx);
1985 extern bool insn_nothrow_p (const_rtx);
1986 extern bool can_nonlocal_goto (const_rtx);
1987 extern void copy_reg_eh_region_note_forward (rtx, rtx, rtx);
1988 extern void copy_reg_eh_region_note_backward(rtx, rtx, rtx);
1989 extern int inequality_comparisons_p (const_rtx);
1990 extern rtx replace_rtx (rtx, rtx, rtx);
1991 extern int replace_label (rtx *, void *);
1992 extern int rtx_referenced_p (rtx, rtx);
1993 extern bool tablejump_p (const_rtx, rtx *, rtx *);
1994 extern int computed_jump_p (const_rtx);
1995
1996 typedef int (*rtx_function) (rtx *, void *);
1997 extern int for_each_rtx (rtx *, rtx_function, void *);
1998
1999 /* Callback for for_each_inc_dec, to process the autoinc operation OP
2000    within MEM that sets DEST to SRC + SRCOFF, or SRC if SRCOFF is
2001    NULL.  The callback is passed the same opaque ARG passed to
2002    for_each_inc_dec.  Return zero to continue looking for other
2003    autoinc operations, -1 to skip OP's operands, and any other value
2004    to interrupt the traversal and return that value to the caller of
2005    for_each_inc_dec.  */
2006 typedef int (*for_each_inc_dec_fn) (rtx mem, rtx op, rtx dest, rtx src,
2007                                     rtx srcoff, void *arg);
2008 extern int for_each_inc_dec (rtx *, for_each_inc_dec_fn, void *arg);
2009
2010 typedef int (*rtx_equal_p_callback_function) (const_rtx *, const_rtx *,
2011                                               rtx *, rtx *);
2012 extern int rtx_equal_p_cb (const_rtx, const_rtx,
2013                            rtx_equal_p_callback_function);
2014
2015 typedef int (*hash_rtx_callback_function) (const_rtx, enum machine_mode, rtx *,
2016                                            enum machine_mode *);
2017 extern unsigned hash_rtx_cb (const_rtx, enum machine_mode, int *, int *,
2018                              bool, hash_rtx_callback_function);
2019
2020 extern rtx regno_use_in (unsigned int, rtx);
2021 extern int auto_inc_p (const_rtx);
2022 extern int in_expr_list_p (const_rtx, const_rtx);
2023 extern void remove_node_from_expr_list (const_rtx, rtx *);
2024 extern int loc_mentioned_in_p (rtx *, const_rtx);
2025 extern rtx find_first_parameter_load (rtx, rtx);
2026 extern bool keep_with_call_p (const_rtx);
2027 extern bool label_is_jump_target_p (const_rtx, const_rtx);
2028 extern int insn_rtx_cost (rtx, bool);
2029
2030 /* Given an insn and condition, return a canonical description of
2031    the test being made.  */
2032 extern rtx canonicalize_condition (rtx, rtx, int, rtx *, rtx, int, int);
2033
2034 /* Given a JUMP_INSN, return a canonical description of the test
2035    being made.  */
2036 extern rtx get_condition (rtx, rtx *, int, int);
2037
2038 /* Information about a subreg of a hard register.  */
2039 struct subreg_info
2040 {
2041   /* Offset of first hard register involved in the subreg.  */
2042   int offset;
2043   /* Number of hard registers involved in the subreg.  */
2044   int nregs;
2045   /* Whether this subreg can be represented as a hard reg with the new
2046      mode.  */
2047   bool representable_p;
2048 };
2049
2050 extern void subreg_get_info (unsigned int, enum machine_mode,
2051                              unsigned int, enum machine_mode,
2052                              struct subreg_info *);
2053
2054 /* lists.c */
2055
2056 extern void free_EXPR_LIST_list (rtx *);
2057 extern void free_INSN_LIST_list (rtx *);
2058 extern void free_EXPR_LIST_node (rtx);
2059 extern void free_INSN_LIST_node (rtx);
2060 extern rtx alloc_INSN_LIST (rtx, rtx);
2061 extern rtx copy_INSN_LIST (rtx);
2062 extern rtx concat_INSN_LIST (rtx, rtx);
2063 extern rtx alloc_EXPR_LIST (int, rtx, rtx);
2064 extern void remove_free_INSN_LIST_elem (rtx, rtx *);
2065 extern rtx remove_list_elem (rtx, rtx *);
2066 extern rtx remove_free_INSN_LIST_node (rtx *);
2067 extern rtx remove_free_EXPR_LIST_node (rtx *);
2068
2069
2070 /* reginfo.c */
2071
2072 /* Resize reg info.  */
2073 extern bool resize_reg_info (void);
2074 /* Free up register info memory.  */
2075 extern void free_reg_info (void);
2076 extern void init_subregs_of_mode (void);
2077 extern void finish_subregs_of_mode (void);
2078
2079 /* recog.c */
2080 extern rtx extract_asm_operands (rtx);
2081 extern int asm_noperands (const_rtx);
2082 extern const char *decode_asm_operands (rtx, rtx *, rtx **, const char **,
2083                                         enum machine_mode *, location_t *);
2084
2085 extern enum reg_class reg_preferred_class (int);
2086 extern enum reg_class reg_alternate_class (int);
2087 extern enum reg_class reg_allocno_class (int);
2088 extern void setup_reg_classes (int, enum reg_class, enum reg_class,
2089                                enum reg_class);
2090
2091 extern void split_all_insns (void);
2092 extern unsigned int split_all_insns_noflow (void);
2093
2094 #define MAX_SAVED_CONST_INT 64
2095 extern GTY(()) rtx const_int_rtx[MAX_SAVED_CONST_INT * 2 + 1];
2096
2097 #define const0_rtx      (const_int_rtx[MAX_SAVED_CONST_INT])
2098 #define const1_rtx      (const_int_rtx[MAX_SAVED_CONST_INT+1])
2099 #define const2_rtx      (const_int_rtx[MAX_SAVED_CONST_INT+2])
2100 #define constm1_rtx     (const_int_rtx[MAX_SAVED_CONST_INT-1])
2101 extern GTY(()) rtx const_true_rtx;
2102
2103 extern GTY(()) rtx const_tiny_rtx[4][(int) MAX_MACHINE_MODE];
2104
2105 /* Returns a constant 0 rtx in mode MODE.  Integer modes are treated the
2106    same as VOIDmode.  */
2107
2108 #define CONST0_RTX(MODE) (const_tiny_rtx[0][(int) (MODE)])
2109
2110 /* Likewise, for the constants 1 and 2 and -1.  */
2111
2112 #define CONST1_RTX(MODE) (const_tiny_rtx[1][(int) (MODE)])
2113 #define CONST2_RTX(MODE) (const_tiny_rtx[2][(int) (MODE)])
2114 #define CONSTM1_RTX(MODE) (const_tiny_rtx[3][(int) (MODE)])
2115
2116 extern GTY(()) rtx pc_rtx;
2117 extern GTY(()) rtx cc0_rtx;
2118 extern GTY(()) rtx ret_rtx;
2119 extern GTY(()) rtx simple_return_rtx;
2120
2121 /* If HARD_FRAME_POINTER_REGNUM is defined, then a special dummy reg
2122    is used to represent the frame pointer.  This is because the
2123    hard frame pointer and the automatic variables are separated by an amount
2124    that cannot be determined until after register allocation.  We can assume
2125    that in this case ELIMINABLE_REGS will be defined, one action of which
2126    will be to eliminate FRAME_POINTER_REGNUM into HARD_FRAME_POINTER_REGNUM.  */
2127 #ifndef HARD_FRAME_POINTER_REGNUM
2128 #define HARD_FRAME_POINTER_REGNUM FRAME_POINTER_REGNUM
2129 #endif
2130
2131 #ifndef HARD_FRAME_POINTER_IS_FRAME_POINTER
2132 #define HARD_FRAME_POINTER_IS_FRAME_POINTER \
2133   (HARD_FRAME_POINTER_REGNUM == FRAME_POINTER_REGNUM)
2134 #endif
2135
2136 #ifndef HARD_FRAME_POINTER_IS_ARG_POINTER
2137 #define HARD_FRAME_POINTER_IS_ARG_POINTER \
2138   (HARD_FRAME_POINTER_REGNUM == ARG_POINTER_REGNUM)
2139 #endif
2140
2141 /* Index labels for global_rtl.  */
2142 enum global_rtl_index
2143 {
2144   GR_STACK_POINTER,
2145   GR_FRAME_POINTER,
2146 /* For register elimination to work properly these hard_frame_pointer_rtx,
2147    frame_pointer_rtx, and arg_pointer_rtx must be the same if they refer to
2148    the same register.  */
2149 #if FRAME_POINTER_REGNUM == ARG_POINTER_REGNUM
2150   GR_ARG_POINTER = GR_FRAME_POINTER,
2151 #endif
2152 #if HARD_FRAME_POINTER_IS_FRAME_POINTER
2153   GR_HARD_FRAME_POINTER = GR_FRAME_POINTER,
2154 #else
2155   GR_HARD_FRAME_POINTER,
2156 #endif
2157 #if FRAME_POINTER_REGNUM != ARG_POINTER_REGNUM
2158 #if HARD_FRAME_POINTER_IS_ARG_POINTER
2159   GR_ARG_POINTER = GR_HARD_FRAME_POINTER,
2160 #else
2161   GR_ARG_POINTER,
2162 #endif
2163 #endif
2164   GR_VIRTUAL_INCOMING_ARGS,
2165   GR_VIRTUAL_STACK_ARGS,
2166   GR_VIRTUAL_STACK_DYNAMIC,
2167   GR_VIRTUAL_OUTGOING_ARGS,
2168   GR_VIRTUAL_CFA,
2169   GR_VIRTUAL_PREFERRED_STACK_BOUNDARY,
2170
2171   GR_MAX
2172 };
2173
2174 /* Target-dependent globals.  */
2175 struct GTY(()) target_rtl {
2176   /* All references to the hard registers in global_rtl_index go through
2177      these unique rtl objects.  On machines where the frame-pointer and
2178      arg-pointer are the same register, they use the same unique object.
2179
2180      After register allocation, other rtl objects which used to be pseudo-regs
2181      may be clobbered to refer to the frame-pointer register.
2182      But references that were originally to the frame-pointer can be
2183      distinguished from the others because they contain frame_pointer_rtx.
2184
2185      When to use frame_pointer_rtx and hard_frame_pointer_rtx is a little
2186      tricky: until register elimination has taken place hard_frame_pointer_rtx
2187      should be used if it is being set, and frame_pointer_rtx otherwise.  After
2188      register elimination hard_frame_pointer_rtx should always be used.
2189      On machines where the two registers are same (most) then these are the
2190      same.  */
2191   rtx x_global_rtl[GR_MAX];
2192
2193   /* A unique representation of (REG:Pmode PIC_OFFSET_TABLE_REGNUM).  */
2194   rtx x_pic_offset_table_rtx;
2195
2196   /* A unique representation of (REG:Pmode RETURN_ADDRESS_POINTER_REGNUM).
2197      This is used to implement __builtin_return_address for some machines;
2198      see for instance the MIPS port.  */
2199   rtx x_return_address_pointer_rtx;
2200
2201   /* Commonly used RTL for hard registers.  These objects are not
2202      necessarily unique, so we allocate them separately from global_rtl.
2203      They are initialized once per compilation unit, then copied into
2204      regno_reg_rtx at the beginning of each function.  */
2205   rtx x_initial_regno_reg_rtx[FIRST_PSEUDO_REGISTER];
2206
2207   /* A sample (mem:M stack_pointer_rtx) rtx for each mode M.  */
2208   rtx x_top_of_stack[MAX_MACHINE_MODE];
2209
2210   /* Static hunks of RTL used by the aliasing code; these are treated
2211      as persistent to avoid unnecessary RTL allocations.  */
2212   rtx x_static_reg_base_value[FIRST_PSEUDO_REGISTER];
2213
2214   /* The default memory attributes for each mode.  */
2215   struct mem_attrs *x_mode_mem_attrs[(int) MAX_MACHINE_MODE];
2216 };
2217
2218 extern GTY(()) struct target_rtl default_target_rtl;
2219 #if SWITCHABLE_TARGET
2220 extern struct target_rtl *this_target_rtl;
2221 #else
2222 #define this_target_rtl (&default_target_rtl)
2223 #endif
2224
2225 #define global_rtl                              \
2226   (this_target_rtl->x_global_rtl)
2227 #define pic_offset_table_rtx \
2228   (this_target_rtl->x_pic_offset_table_rtx)
2229 #define return_address_pointer_rtx \
2230   (this_target_rtl->x_return_address_pointer_rtx)
2231 #define top_of_stack \
2232   (this_target_rtl->x_top_of_stack)
2233 #define mode_mem_attrs \
2234   (this_target_rtl->x_mode_mem_attrs)
2235
2236 /* All references to certain hard regs, except those created
2237    by allocating pseudo regs into them (when that's possible),
2238    go through these unique rtx objects.  */
2239 #define stack_pointer_rtx       (global_rtl[GR_STACK_POINTER])
2240 #define frame_pointer_rtx       (global_rtl[GR_FRAME_POINTER])
2241 #define hard_frame_pointer_rtx  (global_rtl[GR_HARD_FRAME_POINTER])
2242 #define arg_pointer_rtx         (global_rtl[GR_ARG_POINTER])
2243
2244 #ifndef GENERATOR_FILE
2245 /* Return the attributes of a MEM rtx.  */
2246 static inline struct mem_attrs *
2247 get_mem_attrs (const_rtx x)
2248 {
2249   struct mem_attrs *attrs;
2250
2251   attrs = MEM_ATTRS (x);
2252   if (!attrs)
2253     attrs = mode_mem_attrs[(int) GET_MODE (x)];
2254   return attrs;
2255 }
2256 #endif
2257
2258 /* Include the RTL generation functions.  */
2259
2260 #ifndef GENERATOR_FILE
2261 #include "genrtl.h"
2262 #undef gen_rtx_ASM_INPUT
2263 #define gen_rtx_ASM_INPUT(MODE, ARG0)                           \
2264   gen_rtx_fmt_si (ASM_INPUT, (MODE), (ARG0), 0)
2265 #define gen_rtx_ASM_INPUT_loc(MODE, ARG0, LOC)                  \
2266   gen_rtx_fmt_si (ASM_INPUT, (MODE), (ARG0), (LOC))
2267 #endif
2268
2269 /* There are some RTL codes that require special attention; the
2270    generation functions included above do the raw handling.  If you
2271    add to this list, modify special_rtx in gengenrtl.c as well.  */
2272
2273 extern rtx gen_rtx_CONST_INT (enum machine_mode, HOST_WIDE_INT);
2274 extern rtx gen_rtx_CONST_VECTOR (enum machine_mode, rtvec);
2275 extern rtx gen_raw_REG (enum machine_mode, int);
2276 extern rtx gen_rtx_REG (enum machine_mode, unsigned);
2277 extern rtx gen_rtx_SUBREG (enum machine_mode, rtx, int);
2278 extern rtx gen_rtx_MEM (enum machine_mode, rtx);
2279
2280 #define GEN_INT(N)  gen_rtx_CONST_INT (VOIDmode, (N))
2281
2282 /* Virtual registers are used during RTL generation to refer to locations into
2283    the stack frame when the actual location isn't known until RTL generation
2284    is complete.  The routine instantiate_virtual_regs replaces these with
2285    the proper value, which is normally {frame,arg,stack}_pointer_rtx plus
2286    a constant.  */
2287
2288 #define FIRST_VIRTUAL_REGISTER  (FIRST_PSEUDO_REGISTER)
2289
2290 /* This points to the first word of the incoming arguments passed on the stack,
2291    either by the caller or by the callee when pretending it was passed by the
2292    caller.  */
2293
2294 #define virtual_incoming_args_rtx       (global_rtl[GR_VIRTUAL_INCOMING_ARGS])
2295
2296 #define VIRTUAL_INCOMING_ARGS_REGNUM    (FIRST_VIRTUAL_REGISTER)
2297
2298 /* If FRAME_GROWS_DOWNWARD, this points to immediately above the first
2299    variable on the stack.  Otherwise, it points to the first variable on
2300    the stack.  */
2301
2302 #define virtual_stack_vars_rtx          (global_rtl[GR_VIRTUAL_STACK_ARGS])
2303
2304 #define VIRTUAL_STACK_VARS_REGNUM       ((FIRST_VIRTUAL_REGISTER) + 1)
2305
2306 /* This points to the location of dynamically-allocated memory on the stack
2307    immediately after the stack pointer has been adjusted by the amount
2308    desired.  */
2309
2310 #define virtual_stack_dynamic_rtx       (global_rtl[GR_VIRTUAL_STACK_DYNAMIC])
2311
2312 #define VIRTUAL_STACK_DYNAMIC_REGNUM    ((FIRST_VIRTUAL_REGISTER) + 2)
2313
2314 /* This points to the location in the stack at which outgoing arguments should
2315    be written when the stack is pre-pushed (arguments pushed using push
2316    insns always use sp).  */
2317
2318 #define virtual_outgoing_args_rtx       (global_rtl[GR_VIRTUAL_OUTGOING_ARGS])
2319
2320 #define VIRTUAL_OUTGOING_ARGS_REGNUM    ((FIRST_VIRTUAL_REGISTER) + 3)
2321
2322 /* This points to the Canonical Frame Address of the function.  This
2323    should correspond to the CFA produced by INCOMING_FRAME_SP_OFFSET,
2324    but is calculated relative to the arg pointer for simplicity; the
2325    frame pointer nor stack pointer are necessarily fixed relative to
2326    the CFA until after reload.  */
2327
2328 #define virtual_cfa_rtx                 (global_rtl[GR_VIRTUAL_CFA])
2329
2330 #define VIRTUAL_CFA_REGNUM              ((FIRST_VIRTUAL_REGISTER) + 4)
2331
2332 #define LAST_VIRTUAL_POINTER_REGISTER   ((FIRST_VIRTUAL_REGISTER) + 4)
2333
2334 /* This is replaced by crtl->preferred_stack_boundary / BITS_PER_UNIT
2335    when finalized.  */
2336
2337 #define virtual_preferred_stack_boundary_rtx \
2338         (global_rtl[GR_VIRTUAL_PREFERRED_STACK_BOUNDARY])
2339
2340 #define VIRTUAL_PREFERRED_STACK_BOUNDARY_REGNUM \
2341                                         ((FIRST_VIRTUAL_REGISTER) + 5)
2342
2343 #define LAST_VIRTUAL_REGISTER           ((FIRST_VIRTUAL_REGISTER) + 5)
2344
2345 /* Nonzero if REGNUM is a pointer into the stack frame.  */
2346 #define REGNO_PTR_FRAME_P(REGNUM)               \
2347   ((REGNUM) == STACK_POINTER_REGNUM             \
2348    || (REGNUM) == FRAME_POINTER_REGNUM          \
2349    || (REGNUM) == HARD_FRAME_POINTER_REGNUM     \
2350    || (REGNUM) == ARG_POINTER_REGNUM            \
2351    || ((REGNUM) >= FIRST_VIRTUAL_REGISTER       \
2352        && (REGNUM) <= LAST_VIRTUAL_POINTER_REGISTER))
2353
2354 /* REGNUM never really appearing in the INSN stream.  */
2355 #define INVALID_REGNUM                  (~(unsigned int) 0)
2356
2357 extern rtx output_constant_def (tree, int);
2358 extern rtx lookup_constant_def (tree);
2359
2360 /* Nonzero after end of reload pass.
2361    Set to 1 or 0 by reload1.c.  */
2362
2363 extern int reload_completed;
2364
2365 /* Nonzero after thread_prologue_and_epilogue_insns has run.  */
2366 extern int epilogue_completed;
2367
2368 /* Set to 1 while reload_as_needed is operating.
2369    Required by some machines to handle any generated moves differently.  */
2370
2371 extern int reload_in_progress;
2372
2373 /* This macro indicates whether you may create a new
2374    pseudo-register.  */
2375
2376 #define can_create_pseudo_p() (!reload_in_progress && !reload_completed)
2377
2378 #ifdef STACK_REGS
2379 /* Nonzero after end of regstack pass.
2380    Set to 1 or 0 by reg-stack.c.  */
2381 extern int regstack_completed;
2382 #endif
2383
2384 /* If this is nonzero, we do not bother generating VOLATILE
2385    around volatile memory references, and we are willing to
2386    output indirect addresses.  If cse is to follow, we reject
2387    indirect addresses so a useful potential cse is generated;
2388    if it is used only once, instruction combination will produce
2389    the same indirect address eventually.  */
2390 extern int cse_not_expected;
2391
2392 /* Translates rtx code to tree code, for those codes needed by
2393    REAL_ARITHMETIC.  The function returns an int because the caller may not
2394    know what `enum tree_code' means.  */
2395
2396 extern int rtx_to_tree_code (enum rtx_code);
2397
2398 /* In cse.c */
2399 extern int delete_trivially_dead_insns (rtx, int);
2400 extern int exp_equiv_p (const_rtx, const_rtx, int, bool);
2401 extern unsigned hash_rtx (const_rtx x, enum machine_mode, int *, int *, bool);
2402
2403 /* In dse.c */
2404 extern bool check_for_inc_dec (rtx insn);
2405
2406 /* In jump.c */
2407 extern int comparison_dominates_p (enum rtx_code, enum rtx_code);
2408 extern bool jump_to_label_p (rtx);
2409 extern int condjump_p (const_rtx);
2410 extern int any_condjump_p (const_rtx);
2411 extern int any_uncondjump_p (const_rtx);
2412 extern rtx pc_set (const_rtx);
2413 extern rtx condjump_label (const_rtx);
2414 extern int simplejump_p (const_rtx);
2415 extern int returnjump_p (rtx);
2416 extern int eh_returnjump_p (rtx);
2417 extern int onlyjump_p (const_rtx);
2418 extern int only_sets_cc0_p (const_rtx);
2419 extern int sets_cc0_p (const_rtx);
2420 extern int invert_jump_1 (rtx, rtx);
2421 extern int invert_jump (rtx, rtx, int);
2422 extern int rtx_renumbered_equal_p (const_rtx, const_rtx);
2423 extern int true_regnum (const_rtx);
2424 extern unsigned int reg_or_subregno (const_rtx);
2425 extern int redirect_jump_1 (rtx, rtx);
2426 extern void redirect_jump_2 (rtx, rtx, rtx, int, int);
2427 extern int redirect_jump (rtx, rtx, int);
2428 extern void rebuild_jump_labels (rtx);
2429 extern void rebuild_jump_labels_chain (rtx);
2430 extern rtx reversed_comparison (const_rtx, enum machine_mode);
2431 extern enum rtx_code reversed_comparison_code (const_rtx, const_rtx);
2432 extern enum rtx_code reversed_comparison_code_parts (enum rtx_code, const_rtx,
2433                                                      const_rtx, const_rtx);
2434 extern void delete_for_peephole (rtx, rtx);
2435 extern int condjump_in_parallel_p (const_rtx);
2436
2437 /* In emit-rtl.c.  */
2438 extern int max_reg_num (void);
2439 extern int max_label_num (void);
2440 extern int get_first_label_num (void);
2441 extern void maybe_set_first_label_num (rtx);
2442 extern void delete_insns_since (rtx);
2443 extern void mark_reg_pointer (rtx, int);
2444 extern void mark_user_reg (rtx);
2445 extern void reset_used_flags (rtx);
2446 extern void set_used_flags (rtx);
2447 extern void reorder_insns (rtx, rtx, rtx);
2448 extern void reorder_insns_nobb (rtx, rtx, rtx);
2449 extern int get_max_insn_count (void);
2450 extern int in_sequence_p (void);
2451 extern void init_emit (void);
2452 extern void init_emit_regs (void);
2453 extern void init_emit_once (void);
2454 extern void push_topmost_sequence (void);
2455 extern void pop_topmost_sequence (void);
2456 extern void set_new_first_and_last_insn (rtx, rtx);
2457 extern unsigned int unshare_all_rtl (void);
2458 extern void unshare_all_rtl_again (rtx);
2459 extern void unshare_all_rtl_in_chain (rtx);
2460 extern void verify_rtl_sharing (void);
2461 extern void link_cc0_insns (rtx);
2462 extern void add_insn (rtx);
2463 extern void add_insn_before (rtx, rtx, basic_block);
2464 extern void add_insn_after (rtx, rtx, basic_block);
2465 extern void remove_insn (rtx);
2466 extern rtx emit (rtx);
2467 extern void delete_insn (rtx);
2468 extern rtx entry_of_function (void);
2469 extern void emit_insn_at_entry (rtx);
2470 extern void delete_insn_chain (rtx, rtx, bool);
2471 extern rtx unlink_insn_chain (rtx, rtx);
2472 extern void delete_insn_and_edges (rtx);
2473 extern rtx gen_lowpart_SUBREG (enum machine_mode, rtx);
2474 extern rtx gen_const_mem (enum machine_mode, rtx);
2475 extern rtx gen_frame_mem (enum machine_mode, rtx);
2476 extern rtx gen_tmp_stack_mem (enum machine_mode, rtx);
2477 extern bool validate_subreg (enum machine_mode, enum machine_mode,
2478                              const_rtx, unsigned int);
2479
2480 /* In combine.c  */
2481 extern unsigned int extended_count (const_rtx, enum machine_mode, int);
2482 extern rtx remove_death (unsigned int, rtx);
2483 extern void dump_combine_stats (FILE *);
2484 extern void dump_combine_total_stats (FILE *);
2485 extern rtx make_compound_operation (rtx, enum rtx_code);
2486
2487 /* In cfgcleanup.c  */
2488 extern void delete_dead_jumptables (void);
2489
2490 /* In sched-vis.c.  */
2491 extern void dump_insn_slim (FILE *, const_rtx x);
2492
2493 /* In sched-rgn.c.  */
2494 extern void schedule_insns (void);
2495
2496 /* In sched-ebb.c.  */
2497 extern void schedule_ebbs (void);
2498
2499 /* In sel-sched-dump.c.  */
2500 extern void sel_sched_fix_param (const char *param, const char *val);
2501
2502 /* In print-rtl.c */
2503 extern const char *print_rtx_head;
2504 extern void debug_rtx (const_rtx);
2505 extern void debug_rtx_list (const_rtx, int);
2506 extern void debug_rtx_range (const_rtx, const_rtx);
2507 extern const_rtx debug_rtx_find (const_rtx, int);
2508 extern void print_mem_expr (FILE *, const_tree);
2509 extern void print_rtl (FILE *, const_rtx);
2510 extern void print_simple_rtl (FILE *, const_rtx);
2511 extern int print_rtl_single (FILE *, const_rtx);
2512 extern int print_rtl_single_with_indent (FILE *, const_rtx, int);
2513 extern void print_inline_rtx (FILE *, const_rtx, int);
2514
2515 /* In function.c */
2516 extern void reposition_prologue_and_epilogue_notes (void);
2517 extern int prologue_epilogue_contains (const_rtx);
2518 extern int sibcall_epilogue_contains (const_rtx);
2519 extern void update_temp_slot_address (rtx, rtx);
2520 extern void maybe_copy_prologue_epilogue_insn (rtx, rtx);
2521 extern void set_return_jump_label (rtx);
2522
2523 /* In stmt.c */
2524 extern void expand_null_return (void);
2525 extern void expand_naked_return (void);
2526 extern void emit_jump (rtx);
2527
2528 /* In expr.c */
2529 extern rtx move_by_pieces (rtx, rtx, unsigned HOST_WIDE_INT,
2530                            unsigned int, int);
2531 extern HOST_WIDE_INT find_args_size_adjust (rtx);
2532 extern int fixup_args_size_notes (rtx, rtx, int);
2533
2534 /* In cfgrtl.c */
2535 extern void print_rtl_with_bb (FILE *, const_rtx, int);
2536 extern rtx duplicate_insn_chain (rtx, rtx);
2537
2538 /* In expmed.c */
2539 extern void init_expmed (void);
2540 extern void expand_inc (rtx, rtx);
2541 extern void expand_dec (rtx, rtx);
2542
2543 /* In lower-subreg.c */
2544 extern void init_lower_subreg (void);
2545
2546 /* In gcse.c */
2547 extern bool can_copy_p (enum machine_mode);
2548 extern bool can_assign_to_reg_without_clobbers_p (rtx);
2549 extern rtx fis_get_condition (rtx);
2550
2551 /* In ira.c */
2552 #ifdef HARD_CONST
2553 extern HARD_REG_SET eliminable_regset;
2554 #endif
2555 extern void mark_elimination (int, int);
2556
2557 /* In reginfo.c */
2558 extern int reg_classes_intersect_p (reg_class_t, reg_class_t);
2559 extern int reg_class_subset_p (reg_class_t, reg_class_t);
2560 extern void globalize_reg (tree, int);
2561 extern void init_reg_modes_target (void);
2562 extern void init_regs (void);
2563 extern void reinit_regs (void);
2564 extern void init_fake_stack_mems (void);
2565 extern void save_register_info (void);
2566 extern void init_reg_sets (void);
2567 extern void regclass (rtx, int);
2568 extern void reg_scan (rtx, unsigned int);
2569 extern void fix_register (const char *, int, int);
2570 extern bool invalid_mode_change_p (unsigned int, enum reg_class);
2571
2572 /* In reorg.c */
2573 extern void dbr_schedule (rtx);
2574
2575 /* In reload1.c */
2576 extern int function_invariant_p (const_rtx);
2577
2578 /* In calls.c */
2579 enum libcall_type
2580 {
2581   LCT_NORMAL = 0,
2582   LCT_CONST = 1,
2583   LCT_PURE = 2,
2584   LCT_NORETURN = 3,
2585   LCT_THROW = 4,
2586   LCT_RETURNS_TWICE = 5
2587 };
2588
2589 extern void emit_library_call (rtx, enum libcall_type, enum machine_mode, int,
2590                                ...);
2591 extern rtx emit_library_call_value (rtx, rtx, enum libcall_type,
2592                                     enum machine_mode, int, ...);
2593
2594 /* In varasm.c */
2595 extern void init_varasm_once (void);
2596
2597 extern rtx make_debug_expr_from_rtl (const_rtx);
2598
2599 /* In read-rtl.c */
2600 extern bool read_rtx (const char *, rtx *);
2601
2602 /* In alias.c */
2603 extern rtx canon_rtx (rtx);
2604 extern int true_dependence (const_rtx, enum machine_mode, const_rtx);
2605 extern rtx get_addr (rtx);
2606 extern int canon_true_dependence (const_rtx, enum machine_mode, rtx,
2607                                   const_rtx, rtx);
2608 extern int read_dependence (const_rtx, const_rtx);
2609 extern int anti_dependence (const_rtx, const_rtx);
2610 extern int output_dependence (const_rtx, const_rtx);
2611 extern int may_alias_p (const_rtx, const_rtx);
2612 extern void init_alias_target (void);
2613 extern void init_alias_analysis (void);
2614 extern void end_alias_analysis (void);
2615 extern void vt_equate_reg_base_value (const_rtx, const_rtx);
2616 extern bool memory_modified_in_insn_p (const_rtx, const_rtx);
2617 extern bool may_be_sp_based_p (rtx);
2618 extern rtx gen_hard_reg_clobber (enum machine_mode, unsigned int);
2619 extern rtx get_reg_known_value (unsigned int);
2620 extern bool get_reg_known_equiv_p (unsigned int);
2621 extern rtx get_reg_base_value (unsigned int);
2622
2623 #ifdef STACK_REGS
2624 extern int stack_regs_mentioned (const_rtx insn);
2625 #endif
2626
2627 /* In toplev.c */
2628 extern GTY(()) rtx stack_limit_rtx;
2629
2630 /* In predict.c */
2631 extern void invert_br_probabilities (rtx);
2632 extern bool expensive_function_p (int);
2633
2634 /* In var-tracking.c */
2635 extern unsigned int variable_tracking_main (void);
2636
2637 /* In stor-layout.c.  */
2638 extern void get_mode_bounds (enum machine_mode, int, enum machine_mode,
2639                              rtx *, rtx *);
2640
2641 /* In loop-unswitch.c  */
2642 extern rtx reversed_condition (rtx);
2643 extern rtx compare_and_jump_seq (rtx, rtx, enum rtx_code, rtx, int, rtx);
2644
2645 /* In loop-iv.c  */
2646 extern rtx canon_condition (rtx);
2647 extern void simplify_using_condition (rtx, rtx *, bitmap);
2648
2649 /* In final.c  */
2650 extern unsigned int compute_alignments (void);
2651 extern int asm_str_count (const char *templ);
2652 \f
2653 struct rtl_hooks
2654 {
2655   rtx (*gen_lowpart) (enum machine_mode, rtx);
2656   rtx (*gen_lowpart_no_emit) (enum machine_mode, rtx);
2657   rtx (*reg_nonzero_bits) (const_rtx, enum machine_mode, const_rtx, enum machine_mode,
2658                            unsigned HOST_WIDE_INT, unsigned HOST_WIDE_INT *);
2659   rtx (*reg_num_sign_bit_copies) (const_rtx, enum machine_mode, const_rtx, enum machine_mode,
2660                                   unsigned int, unsigned int *);
2661   bool (*reg_truncated_to_mode) (enum machine_mode, const_rtx);
2662
2663   /* Whenever you add entries here, make sure you adjust rtlhooks-def.h.  */
2664 };
2665
2666 /* Each pass can provide its own.  */
2667 extern struct rtl_hooks rtl_hooks;
2668
2669 /* ... but then it has to restore these.  */
2670 extern const struct rtl_hooks general_rtl_hooks;
2671
2672 /* Keep this for the nonce.  */
2673 #define gen_lowpart rtl_hooks.gen_lowpart
2674
2675 extern void insn_locations_init (void);
2676 extern void insn_locations_finalize (void);
2677 extern void set_curr_insn_location (location_t);
2678 extern location_t curr_insn_location (void);
2679 extern bool optimize_insn_for_size_p (void);
2680 extern bool optimize_insn_for_speed_p (void);
2681
2682 /* rtl-error.c */
2683 extern void _fatal_insn_not_found (const_rtx, const char *, int, const char *)
2684      ATTRIBUTE_NORETURN;
2685 extern void _fatal_insn (const char *, const_rtx, const char *, int, const char *)
2686      ATTRIBUTE_NORETURN;
2687
2688 #define fatal_insn(msgid, insn) \
2689         _fatal_insn (msgid, insn, __FILE__, __LINE__, __FUNCTION__)
2690 #define fatal_insn_not_found(insn) \
2691         _fatal_insn_not_found (insn, __FILE__, __LINE__, __FUNCTION__)
2692
2693
2694
2695 #endif /* ! GCC_RTL_H */