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