gcc/rtl.h

   1 /* Register Transfer Language (RTL) definitions for GNU C-Compiler
   2    Copyright (C) 1987, 1991, 1992 Free Software Foundation, Inc.
   3
   4 This file is part of GNU CC.
   5
   6 GNU CC is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU CC is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU CC; see the file COPYING.  If not, write to
  18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
  19
  20
  21 #include "machmode.h"
  22
  23 #undef FFS  /* Some systems predefine this symbol; don't let it interfere.  */
  24 #undef FLOAT /* Likewise.  */
  25
  26 /* Register Transfer Language EXPRESSIONS CODES */
  27
  28 #define RTX_CODE        enum rtx_code
  29 enum rtx_code  {
  30
  31 #define DEF_RTL_EXPR(ENUM, NAME, FORMAT, CLASS)   ENUM ,
  32 #include "rtl.def"              /* rtl expressions are documented here */
  33 #undef DEF_RTL_EXPR
  34
  35   LAST_AND_UNUSED_RTX_CODE};    /* A convenient way to get a value for
  36                                    NUM_RTX_CODE.
  37                                    Assumes default enum value assignment.  */
  38
  39 #define NUM_RTX_CODE ((int)LAST_AND_UNUSED_RTX_CODE)
  40                                 /* The cast here, saves many elsewhere.  */
  41
  42 extern int rtx_length[];
  43 #define GET_RTX_LENGTH(CODE)            (rtx_length[(int)(CODE)])
  44
  45 extern char *rtx_name[];
  46 #define GET_RTX_NAME(CODE)              (rtx_name[(int)(CODE)])
  47
  48 extern char *rtx_format[];
  49 #define GET_RTX_FORMAT(CODE)            (rtx_format[(int)(CODE)])
  50
  51 extern char rtx_class[];
  52 #define GET_RTX_CLASS(CODE)             (rtx_class[(int)(CODE)])
  53 \f
  54 /* Common union for an element of an rtx.  */
  55
  56 typedef union rtunion_def
  57 {
  58   HOST_WIDE_INT rtwint;
  59   int rtint;
  60   char *rtstr;
  61   struct rtx_def *rtx;
  62   struct rtvec_def *rtvec;
  63   enum machine_mode rttype;
  64 } rtunion;
  65
  66 /* RTL expression ("rtx").  */
  67
  68 typedef struct rtx_def
  69 {
  70 #ifdef ONLY_INT_FIELDS
  71   unsigned short code;
  72 #else
  73   /* The kind of expression this is.  */
  74   enum rtx_code code : 16;
  75 #endif
  76   /* The kind of value the expression has.  */
  77 #ifdef ONLY_INT_FIELDS
  78   int mode : 8;
  79 #else
  80   enum machine_mode mode : 8;
  81 #endif
  82   /* 1 in an INSN if it can alter flow of control
  83      within this function.  Not yet used!  */
  84   unsigned int jump : 1;
  85   /* 1 in an INSN if it can call another function.  Not yet used!  */
  86   unsigned int call : 1;
  87   /* 1 in a MEM or REG if value of this expression will never change
  88      during the current function, even though it is not
  89      manifestly constant.
  90      1 in a SYMBOL_REF if it addresses something in the per-function
  91      constants pool.
  92      1 in a CALL_INSN if it is a const call.
  93      1 in a JUMP_INSN if it is a branch that should be annulled.  Valid from
  94      reorg until end of compilation; cleared before used.  */
  95   unsigned int unchanging : 1;
  96   /* 1 in a MEM expression if contents of memory are volatile.
  97      1 in an INSN, CALL_INSN, JUMP_INSN, CODE_LABEL or BARRIER
  98      if it is deleted.
  99      1 in a REG expression if corresponds to a variable declared by the user.
 100      0 for an internally generated temporary.
 101      In a SYMBOL_REF, this flag is used for machine-specific purposes.  */
 102   unsigned int volatil : 1;
 103   /* 1 in a MEM referring to a field of a structure (not a union!).
 104      0 if the MEM was a variable or the result of a * operator in C;
 105      1 if it was the result of a . or -> operator (on a struct) in C.
 106      1 in a REG if the register is used only in exit code a loop.
 107      1 in a CODE_LABEL if the label is used for nonlocal gotos
 108      and must not be deleted even if its count is zero.
 109      1 in a LABEL_REF if this is a reference to a label outside the
 110      current loop.
 111      1 in an INSN, JUMP_INSN, or CALL_INSN if this insn must be scheduled
 112      together with the preceding insn.  Valid only within sched.
 113      1 in an INSN, JUMP_INSN, or CALL_INSN if insn is in a delay slot and
 114      from the target of a branch.  Valid from reorg until end of compilation;
 115      cleared before used.  */
 116   unsigned int in_struct : 1;
 117   /* 1 if this rtx is used.  This is used for copying shared structure.
 118      See `unshare_all_rtl'.
 119      In a REG, this is not needed for that purpose, and used instead
 120      in `leaf_renumber_regs_insn'.
 121      In a SYMBOL_REF, means that emit_library_call
 122      has used it as the function.  */
 123   unsigned int used : 1;
 124   /* Nonzero if this rtx came from procedure integration.
 125      In a REG, nonzero means this reg refers to the return value
 126      of the current function.  */
 127   unsigned integrated : 1;
 128   /* The first element of the operands of this rtx.
 129      The number of operands and their types are controlled
 130      by the `code' field, according to rtl.def.  */
 131   rtunion fld[1];
 132 } *rtx;
 133
 134 /* Add prototype support.  */
 135 #ifndef PROTO
 136 #if defined (USE_PROTOTYPES) ? USE_PROTOTYPES : defined (__STDC__)
 137 #define PROTO(ARGS) ARGS
 138 #else
 139 #define PROTO(ARGS) ()
 140 #endif
 141 #endif
 142
 143 #define NULL_RTX (rtx) 0
 144
 145 /* Define a generic NULL if one hasn't already been defined.  */
 146
 147 #ifndef NULL
 148 #define NULL 0
 149 #endif
 150
 151 #ifndef GENERIC_PTR
 152 #if defined (USE_PROTOTYPES) ? USE_PROTOTYPES : defined (__STDC__)
 153 #define GENERIC_PTR void *
 154 #else
 155 #define GENERIC_PTR char *
 156 #endif
 157 #endif
 158
 159 #ifndef NULL_PTR
 160 #define NULL_PTR ((GENERIC_PTR)0)
 161 #endif
 162
 163 /* Define macros to access the `code' field of the rtx.  */
 164
 165 #ifdef SHORT_ENUM_BUG
 166 #define GET_CODE(RTX)           ((enum rtx_code) ((RTX)->code))
 167 #define PUT_CODE(RTX, CODE)     ((RTX)->code = ((short) (CODE)))
 168 #else
 169 #define GET_CODE(RTX)           ((RTX)->code)
 170 #define PUT_CODE(RTX, CODE)     ((RTX)->code = (CODE))
 171 #endif
 172
 173 #define GET_MODE(RTX)           ((RTX)->mode)
 174 #define PUT_MODE(RTX, MODE)     ((RTX)->mode = (MODE))
 175
 176 #define RTX_INTEGRATED_P(RTX) ((RTX)->integrated)
 177 #define RTX_UNCHANGING_P(RTX) ((RTX)->unchanging)
 178
 179 /* RTL vector.  These appear inside RTX's when there is a need
 180    for a variable number of things.  The principle use is inside
 181    PARALLEL expressions.  */
 182
 183 typedef struct rtvec_def{
 184   unsigned num_elem;            /* number of elements */
 185   rtunion elem[1];
 186 } *rtvec;
 187
 188 #define NULL_RTVEC (rtvec) 0
 189
 190 #define GET_NUM_ELEM(RTVEC)             ((RTVEC)->num_elem)
 191 #define PUT_NUM_ELEM(RTVEC, NUM)        ((RTVEC)->num_elem = (unsigned) NUM)
 192
 193 #define RTVEC_ELT(RTVEC, I)  ((RTVEC)->elem[(I)].rtx)
 194
 195 /* 1 if X is a REG.  */
 196
 197 #define REG_P(X) (GET_CODE (X) == REG)
 198
 199 /* 1 if X is a constant value that is an integer.  */
 200
 201 #define CONSTANT_P(X)   \
 202   (GET_CODE (X) == LABEL_REF || GET_CODE (X) == SYMBOL_REF              \
 203    || GET_CODE (X) == CONST_INT || GET_CODE (X) == CONST_DOUBLE         \
 204    || GET_CODE (X) == CONST || GET_CODE (X) == HIGH)
 205
 206 /* General accessor macros for accessing the fields of an rtx.  */
 207
 208 #define XEXP(RTX, N)    ((RTX)->fld[N].rtx)
 209 #define XINT(RTX, N)    ((RTX)->fld[N].rtint)
 210 #define XWINT(RTX, N)   ((RTX)->fld[N].rtwint)
 211 #define XSTR(RTX, N)    ((RTX)->fld[N].rtstr)
 212 #define XVEC(RTX, N)    ((RTX)->fld[N].rtvec)
 213 #define XVECLEN(RTX, N) ((RTX)->fld[N].rtvec->num_elem)
 214 #define XVECEXP(RTX,N,M)((RTX)->fld[N].rtvec->elem[M].rtx)
 215 \f
 216 /* ACCESS MACROS for particular fields of insns.  */
 217
 218 /* Holds a unique number for each insn.
 219    These are not necessarily sequentially increasing.  */
 220 #define INSN_UID(INSN)  ((INSN)->fld[0].rtint)
 221
 222 /* Chain insns together in sequence.  */
 223 #define PREV_INSN(INSN) ((INSN)->fld[1].rtx)
 224 #define NEXT_INSN(INSN) ((INSN)->fld[2].rtx)
 225
 226 /* The body of an insn.  */
 227 #define PATTERN(INSN)   ((INSN)->fld[3].rtx)
 228
 229 /* Code number of instruction, from when it was recognized.
 230    -1 means this instruction has not been recognized yet.  */
 231 #define INSN_CODE(INSN) ((INSN)->fld[4].rtint)
 232
 233 /* Set up in flow.c; empty before then.
 234    Holds a chain of INSN_LIST rtx's whose first operands point at
 235    previous insns with direct data-flow connections to this one.
 236    That means that those insns set variables whose next use is in this insn.
 237    They are always in the same basic block as this insn.  */
 238 #define LOG_LINKS(INSN)         ((INSN)->fld[5].rtx)
 239
 240 /* 1 if insn has been deleted.  */
 241 #define INSN_DELETED_P(INSN) ((INSN)->volatil)
 242
 243 /* 1 if insn is a call to a const function.  */
 244 #define CONST_CALL_P(INSN) ((INSN)->unchanging)
 245
 246 /* 1 if insn is a branch that should not unconditionally execute its
 247    delay slots, i.e., it is an annulled branch.   */
 248 #define INSN_ANNULLED_BRANCH_P(INSN) ((INSN)->unchanging)
 249
 250 /* 1 if insn is in a delay slot and is from the target of the branch.  If
 251    the branch insn has INSN_ANNULLED_BRANCH_P set, this insn should only be
 252    executed if the branch is taken.  For annulled branches with this bit
 253    clear, the insn should be executed only if the branch is not taken.  */
 254 #define INSN_FROM_TARGET_P(INSN) ((INSN)->in_struct)
 255
 256 /* Holds a list of notes on what this insn does to various REGs.
 257    It is a chain of EXPR_LIST rtx's, where the second operand
 258    is the chain pointer and the first operand is the REG being described.
 259    The mode field of the EXPR_LIST contains not a real machine mode
 260    but a value that says what this note says about the REG:
 261      REG_DEAD means that the value in REG dies in this insn (i.e., it is
 262    not needed past this insn).  If REG is set in this insn, the REG_DEAD
 263    note may, but need not, be omitted.
 264      REG_INC means that the REG is autoincremented or autodecremented.
 265      REG_EQUIV describes the insn as a whole; it says that the
 266    insn sets a register to a constant value or to be equivalent to
 267    a memory address.  If the
 268    register is spilled to the stack then the constant value
 269    should be substituted for it.  The contents of the REG_EQUIV
 270    is the constant value or memory address, which may be different
 271    from the source of the SET although it has the same value.
 272      REG_EQUAL is like REG_EQUIV except that the destination
 273    is only momentarily equal to the specified rtx.  Therefore, it
 274    cannot be used for substitution; but it can be used for cse.
 275      REG_RETVAL means that this insn copies the return-value of
 276    a library call out of the hard reg for return values.  This note
 277    is actually an INSN_LIST and it points to the first insn involved
 278    in setting up arguments for the call.  flow.c uses this to delete
 279    the entire library call when its result is dead.
 280      REG_LIBCALL is the inverse of REG_RETVAL: it goes on the first insn
 281    of the library call and points at the one that has the REG_RETVAL.
 282      REG_WAS_0 says that the register set in this insn held 0 before the insn.
 283    The contents of the note is the insn that stored the 0.
 284    If that insn is deleted or patched to a NOTE, the REG_WAS_0 is inoperative.
 285    The REG_WAS_0 note is actually an INSN_LIST, not an EXPR_LIST.
 286      REG_NONNEG means that the register is always nonnegative during
 287    the containing loop.  This is used in branches so that decrement and
 288    branch instructions terminating on zero can be matched.  There must be
 289    an insn pattern in the md file named `decrement_and_branch_until_zero'
 290    or else this will never be added to any instructions.
 291      REG_NO_CONFLICT means there is no conflict *after this insn*
 292    between the register in the note and the destination of this insn.
 293      REG_UNUSED identifies a register set in this insn and never used.
 294      REG_CC_SETTER and REG_CC_USER link a pair of insns that set and use
 295    CC0, respectively.  Normally, these are required to be consecutive insns,
 296    but we permit putting a cc0-setting insn in the delay slot of a branch
 297    as long as only one copy of the insn exists.  In that case, these notes
 298    point from one to the other to allow code generation to determine what
 299    any require information and to properly update CC_STATUS.
 300      REG_LABEL points to a CODE_LABEL.  Used by non-JUMP_INSNs to
 301    say that the CODE_LABEL contained in the REG_LABEL note is used
 302    by the insn.
 303      REG_DEP_ANTI is used in LOG_LINKS which represent anti (write after read)
 304    dependencies.  REG_DEP_OUTPUT is used in LOG_LINKS which represent output
 305    (write after write) dependencies.  Data dependencies, which are the only
 306    type of LOG_LINK created by flow, are represented by a 0 reg note kind.  */
 307
 308 #define REG_NOTES(INSN) ((INSN)->fld[6].rtx)
 309
 310 /* Don't forget to change reg_note_name in rtl.c.  */
 311 enum reg_note { REG_DEAD = 1, REG_INC = 2, REG_EQUIV = 3, REG_WAS_0 = 4,
 312                 REG_EQUAL = 5, REG_RETVAL = 6, REG_LIBCALL = 7,
 313                 REG_NONNEG = 8, REG_NO_CONFLICT = 9, REG_UNUSED = 10,
 314                 REG_CC_SETTER = 11, REG_CC_USER = 12, REG_LABEL = 13,
 315                 REG_DEP_ANTI = 14, REG_DEP_OUTPUT = 15 };
 316
 317 /* Define macros to extract and insert the reg-note kind in an EXPR_LIST.  */
 318 #define REG_NOTE_KIND(LINK) ((enum reg_note) GET_MODE (LINK))
 319 #define PUT_REG_NOTE_KIND(LINK,KIND) PUT_MODE(LINK, (enum machine_mode) (KIND))
 320
 321 /* Names for REG_NOTE's in EXPR_LIST insn's.  */
 322
 323 extern char *reg_note_name[];
 324 #define GET_REG_NOTE_NAME(MODE) (reg_note_name[(int)(MODE)])
 325
 326 /* The label-number of a code-label.  The assembler label
 327    is made from `L' and the label-number printed in decimal.
 328    Label numbers are unique in a compilation.  */
 329 #define CODE_LABEL_NUMBER(INSN) ((INSN)->fld[3].rtint)
 330
 331 #define LINE_NUMBER NOTE
 332
 333 /* In a NOTE that is a line number, this is a string for the file name
 334    that the line is in.  We use the same field to record block numbers
 335    temporarily in NOTE_INSN_BLOCK_BEG and NOTE_INSN_BLOCK_END notes.
 336    (We avoid lots of casts between ints and pointers if we use a
 337    different macro for the bock number.)  */
 338
 339 #define NOTE_SOURCE_FILE(INSN)  ((INSN)->fld[3].rtstr)
 340 #define NOTE_BLOCK_NUMBER(INSN) ((INSN)->fld[3].rtint)
 341
 342 /* In a NOTE that is a line number, this is the line number.
 343    Other kinds of NOTEs are identified by negative numbers here.  */
 344 #define NOTE_LINE_NUMBER(INSN) ((INSN)->fld[4].rtint)
 345
 346 /* Codes that appear in the NOTE_LINE_NUMBER field
 347    for kinds of notes that are not line numbers.  */
 348
 349 /* This note indicates the end of the real body of the function,
 350    after moving the parms into their homes, etc.  */
 351 #define NOTE_INSN_FUNCTION_BEG 0
 352
 353 /* This note is used to get rid of an insn
 354    when it isn't safe to patch the insn out of the chain.  */
 355 #define NOTE_INSN_DELETED -1
 356 #define NOTE_INSN_BLOCK_BEG -2
 357 #define NOTE_INSN_BLOCK_END -3
 358 #define NOTE_INSN_LOOP_BEG -4
 359 #define NOTE_INSN_LOOP_END -5
 360 /* This kind of note is generated at the end of the function body,
 361    just before the return insn or return label.
 362    In an optimizing compilation it is deleted by the first jump optimization,
 363    after enabling that optimizer to determine whether control can fall
 364    off the end of the function body without a return statement.  */
 365 #define NOTE_INSN_FUNCTION_END -6
 366 /* This kind of note is generated just after each call to `setjmp', et al.  */
 367 #define NOTE_INSN_SETJMP -7
 368 /* Generated at the place in a loop that `continue' jumps to.  */
 369 #define NOTE_INSN_LOOP_CONT -8
 370 /* Generated at the start of a duplicated exit test.  */
 371 #define NOTE_INSN_LOOP_VTOP -9
 372 /* This marks the point immediately after the last prologue insn.  */
 373 #define NOTE_INSN_PROLOGUE_END -10
 374 /* This marks the point immediately prior to the first epilogue insn.  */
 375 #define NOTE_INSN_EPILOGUE_BEG -11
 376 /* Generated in place of user-declared labels when they are deleted.  */
 377 #define NOTE_INSN_DELETED_LABEL -12
 378 /* Don't forget to change note_insn_name in rtl.c.  */
 379
 380
 381 #if 0 /* These are not used, and I don't know what they were for. --rms.  */
 382 #define NOTE_DECL_NAME(INSN) ((INSN)->fld[3].rtstr)
 383 #define NOTE_DECL_CODE(INSN) ((INSN)->fld[4].rtint)
 384 #define NOTE_DECL_RTL(INSN) ((INSN)->fld[5].rtx)
 385 #define NOTE_DECL_IDENTIFIER(INSN) ((INSN)->fld[6].rtint)
 386 #define NOTE_DECL_TYPE(INSN) ((INSN)->fld[7].rtint)
 387 #endif /* 0 */
 388
 389 /* Names for NOTE insn's other than line numbers.  */
 390
 391 extern char *note_insn_name[];
 392 #define GET_NOTE_INSN_NAME(NOTE_CODE) (note_insn_name[-(NOTE_CODE)])
 393
 394 /* The name of a label, in case it corresponds to an explicit label
 395    in the input source code.  */
 396 #define LABEL_NAME(LABEL) ((LABEL)->fld[4].rtstr)
 397
 398 /* In jump.c, each label contains a count of the number
 399    of LABEL_REFs that point at it, so unused labels can be deleted.  */
 400 #define LABEL_NUSES(LABEL) ((LABEL)->fld[5].rtint)
 401
 402 /* In jump.c, each JUMP_INSN can point to a label that it can jump to,
 403    so that if the JUMP_INSN is deleted, the label's LABEL_NUSES can
 404    be decremented and possibly the label can be deleted.  */
 405 #define JUMP_LABEL(INSN)   ((INSN)->fld[7].rtx)
 406
 407 /* Once basic blocks are found in flow.c,
 408    each CODE_LABEL starts a chain that goes through
 409    all the LABEL_REFs that jump to that label.
 410    The chain eventually winds up at the CODE_LABEL; it is circular.  */
 411 #define LABEL_REFS(LABEL) ((LABEL)->fld[5].rtx)
 412 \f
 413 /* This is the field in the LABEL_REF through which the circular chain
 414    of references to a particular label is linked.
 415    This chain is set up in flow.c.  */
 416
 417 #define LABEL_NEXTREF(REF) ((REF)->fld[1].rtx)
 418
 419 /* Once basic blocks are found in flow.c,
 420    Each LABEL_REF points to its containing instruction with this field.  */
 421
 422 #define CONTAINING_INSN(RTX) ((RTX)->fld[2].rtx)
 423
 424 /* For a REG rtx, REGNO extracts the register number.  */
 425
 426 #define REGNO(RTX) ((RTX)->fld[0].rtint)
 427
 428 /* For a REG rtx, REG_FUNCTION_VALUE_P is nonzero if the reg
 429    is the current function's return value.  */
 430
 431 #define REG_FUNCTION_VALUE_P(RTX) ((RTX)->integrated)
 432
 433 /* 1 in a REG rtx if it corresponds to a variable declared by the user.  */
 434 #define REG_USERVAR_P(RTX) ((RTX)->volatil)
 435
 436 /* For a CONST_INT rtx, INTVAL extracts the integer.  */
 437
 438 #define INTVAL(RTX) ((RTX)->fld[0].rtwint)
 439
 440 /* For a SUBREG rtx, SUBREG_REG extracts the value we want a subreg of.
 441    SUBREG_WORD extracts the word-number.  */
 442
 443 #define SUBREG_REG(RTX) ((RTX)->fld[0].rtx)
 444 #define SUBREG_WORD(RTX) ((RTX)->fld[1].rtint)
 445
 446 /* Access various components of an ASM_OPERANDS rtx.  */
 447
 448 #define ASM_OPERANDS_TEMPLATE(RTX) XSTR ((RTX), 0)
 449 #define ASM_OPERANDS_OUTPUT_CONSTRAINT(RTX) XSTR ((RTX), 1)
 450 #define ASM_OPERANDS_OUTPUT_IDX(RTX) XINT ((RTX), 2)
 451 #define ASM_OPERANDS_INPUT_VEC(RTX) XVEC ((RTX), 3)
 452 #define ASM_OPERANDS_INPUT_CONSTRAINT_VEC(RTX) XVEC ((RTX), 4)
 453 #define ASM_OPERANDS_INPUT(RTX, N) XVECEXP ((RTX), 3, (N))
 454 #define ASM_OPERANDS_INPUT_LENGTH(RTX) XVECLEN ((RTX), 3)
 455 #define ASM_OPERANDS_INPUT_CONSTRAINT(RTX, N) XSTR (XVECEXP ((RTX), 4, (N)), 0)
 456 #define ASM_OPERANDS_INPUT_MODE(RTX, N) GET_MODE (XVECEXP ((RTX), 4, (N)))
 457 #define ASM_OPERANDS_SOURCE_FILE(RTX) XSTR ((RTX), 5)
 458 #define ASM_OPERANDS_SOURCE_LINE(RTX) XINT ((RTX), 6)
 459
 460 /* For a MEM rtx, 1 if it's a volatile reference.
 461    Also in an ASM_OPERANDS rtx.  */
 462 #define MEM_VOLATILE_P(RTX) ((RTX)->volatil)
 463
 464 /* For a MEM rtx, 1 if it refers to a structure or union component.  */
 465 #define MEM_IN_STRUCT_P(RTX) ((RTX)->in_struct)
 466
 467 /* For a LABEL_REF, 1 means that this reference is to a label outside the
 468    loop containing the reference.  */
 469 #define LABEL_OUTSIDE_LOOP_P(RTX) ((RTX)->in_struct)
 470
 471 /* For a LABEL_REF, 1 means it is for a nonlocal label.  */
 472 #define LABEL_REF_NONLOCAL_P(RTX) ((RTX)->volatil)
 473
 474 /* For a CODE_LABEL, 1 means always consider this label to be needed.  */
 475 #define LABEL_PRESERVE_P(RTX) ((RTX)->in_struct)
 476
 477 /* For a REG, 1 means the register is used only in an exit test of a loop.  */
 478 #define REG_LOOP_TEST_P(RTX) ((RTX)->in_struct)
 479
 480 /* During sched, for an insn, 1 means that the insn must be scheduled together
 481    with the preceding insn.  */
 482 #define SCHED_GROUP_P(INSN) ((INSN)->in_struct)
 483
 484 /* During sched, for the LOG_LINKS of an insn, these cache the adjusted
 485    cost of the dependence link.  The cost of executing an instruction
 486    may vary based on how the results are used.  LINK_COST_ZERO is 1 when
 487    the cost through the link varies and is unchanged (i.e., the link has
 488    zero additional cost).  LINK_COST_FREE is 1 when the cost through the
 489    link is zero (i.e., the link makes the cost free).  In other cases,
 490    the adjustment to the cost is recomputed each time it is needed.  */
 491 #define LINK_COST_ZERO(X) ((X)->jump)
 492 #define LINK_COST_FREE(X) ((X)->call)
 493
 494 /* For a SET rtx, SET_DEST is the place that is set
 495    and SET_SRC is the value it is set to.  */
 496 #define SET_DEST(RTX) ((RTX)->fld[0].rtx)
 497 #define SET_SRC(RTX) ((RTX)->fld[1].rtx)
 498
 499 /* For a TRAP_IF rtx, TRAP_CONDITION is an expression.  */
 500 #define TRAP_CONDITION(RTX) ((RTX)->fld[0].rtx)
 501
 502 /* 1 in a SYMBOL_REF if it addresses this function's constants pool.  */
 503 #define CONSTANT_POOL_ADDRESS_P(RTX) ((RTX)->unchanging)
 504
 505 /* Flag in a SYMBOL_REF for machine-specific purposes.  */
 506 #define SYMBOL_REF_FLAG(RTX) ((RTX)->volatil)
 507
 508 /* 1 means a SYMBOL_REF has been the library function in emit_library_call.  */
 509 #define SYMBOL_REF_USED(RTX) ((RTX)->used)
 510
 511 /* For an INLINE_HEADER rtx, FIRST_FUNCTION_INSN is the first insn
 512    of the function that is not involved in copying parameters to
 513    pseudo-registers.  FIRST_PARM_INSN is the very first insn of
 514    the function, including the parameter copying.
 515    We keep this around in case we must splice
 516    this function into the assembly code at the end of the file.
 517    FIRST_LABELNO is the first label number used by the function (inclusive).
 518    LAST_LABELNO is the last label used by the function (exclusive).
 519    MAX_REGNUM is the largest pseudo-register used by that function.
 520    FUNCTION_ARGS_SIZE is the size of the argument block in the stack.
 521    POPS_ARGS is the number of bytes of input arguments popped by the function
 522    STACK_SLOT_LIST is the list of stack slots.
 523    FUNCTION_FLAGS are where single-bit flags are saved.
 524    OUTGOING_ARGS_SIZE is the size of the largest outgoing stack parameter list.
 525    ORIGINAL_ARG_VECTOR is a vector of the original DECL_RTX values
 526     for the function arguments.
 527    ORIGINAL_DECL_INITIAL is a pointer to the original DECL_INITIAL for the
 528     function.
 529
 530    We want this to lay down like an INSN.  The PREV_INSN field
 531    is always NULL.  The NEXT_INSN field always points to the
 532    first function insn of the function being squirreled away.  */
 533
 534 #define FIRST_FUNCTION_INSN(RTX) ((RTX)->fld[2].rtx)
 535 #define FIRST_PARM_INSN(RTX) ((RTX)->fld[3].rtx)
 536 #define FIRST_LABELNO(RTX) ((RTX)->fld[4].rtint)
 537 #define LAST_LABELNO(RTX) ((RTX)->fld[5].rtint)
 538 #define MAX_PARMREG(RTX) ((RTX)->fld[6].rtint)
 539 #define MAX_REGNUM(RTX) ((RTX)->fld[7].rtint)
 540 #define FUNCTION_ARGS_SIZE(RTX) ((RTX)->fld[8].rtint)
 541 #define POPS_ARGS(RTX) ((RTX)->fld[9].rtint)
 542 #define STACK_SLOT_LIST(RTX) ((RTX)->fld[10].rtx)
 543 #define FUNCTION_FLAGS(RTX) ((RTX)->fld[11].rtint)
 544 #define OUTGOING_ARGS_SIZE(RTX) ((RTX)->fld[12].rtint)
 545 #define ORIGINAL_ARG_VECTOR(RTX) ((RTX)->fld[13].rtvec)
 546 #define ORIGINAL_DECL_INITIAL(RTX) ((RTX)->fld[14].rtx)
 547
 548 /* In FUNCTION_FLAGS we save some variables computed when emitting the code
 549    for the function and which must be `or'ed into the current flag values when
 550    insns from that function are being inlined.  */
 551
 552 /* These ought to be an enum, but non-ANSI compilers don't like that.  */
 553 #define FUNCTION_FLAGS_CALLS_ALLOCA 01
 554 #define FUNCTION_FLAGS_CALLS_SETJMP 02
 555 #define FUNCTION_FLAGS_RETURNS_STRUCT 04
 556 #define FUNCTION_FLAGS_RETURNS_PCC_STRUCT 010
 557 #define FUNCTION_FLAGS_NEEDS_CONTEXT 020
 558 #define FUNCTION_FLAGS_HAS_NONLOCAL_LABEL 040
 559 #define FUNCTION_FLAGS_RETURNS_POINTER 0100
 560 #define FUNCTION_FLAGS_USES_CONST_POOL 0200
 561 #define FUNCTION_FLAGS_CALLS_LONGJMP 0400
 562 #define FUNCTION_FLAGS_USES_PIC_OFFSET_TABLE 01000
 563
 564 /* Define a macro to look for REG_INC notes,
 565    but save time on machines where they never exist.  */
 566
 567 /* Don't continue this line--convex cc version 4.1 would lose.  */
 568 #if (defined (HAVE_PRE_INCREMENT) || defined (HAVE_PRE_DECREMENT) || defined (HAVE_POST_INCREMENT) || defined (HAVE_POST_DECREMENT))
 569 #define FIND_REG_INC_NOTE(insn, reg) (find_reg_note ((insn), REG_INC, (reg)))
 570 #else
 571 #define FIND_REG_INC_NOTE(insn, reg) 0
 572 #endif
 573
 574 /* Indicate whether the machine has any sort of auto increment addressing.
 575    If not, we can avoid checking for REG_INC notes.  */
 576
 577 /* Don't continue this line--convex cc version 4.1 would lose.  */
 578 #if (defined (HAVE_PRE_INCREMENT) || defined (HAVE_PRE_DECREMENT) || defined (HAVE_POST_INCREMENT) || defined (HAVE_POST_DECREMENT))
 579 #define AUTO_INC_DEC
 580 #endif
 581 \f
 582 /* Generally useful functions.  */
 583
 584 /* The following functions accept a wide integer argument.  Rather than
 585    having to cast on every function call, we use a macro instead, that is
 586    defined here and in tree.h.  */
 587
 588 #ifndef exact_log2
 589 #define exact_log2(N) exact_log2_wide ((HOST_WIDE_INT) (N))
 590 #define floor_log2(N) floor_log2_wide ((HOST_WIDE_INT) (N))
 591 #endif
 592
 593 #define plus_constant(X,C) plus_constant_wide (X, (HOST_WIDE_INT) (C))
 594
 595 #define plus_constant_for_output(X,C)  \
 596   plus_constant_for_output_wide (X, (HOST_WIDE_INT) (C))
 597
 598 extern rtx plus_constant_wide            PROTO((rtx, HOST_WIDE_INT));
 599 extern rtx plus_constant_for_output_wide PROTO((rtx, HOST_WIDE_INT));
 600
 601 #define GEN_INT(N) gen_rtx (CONST_INT, VOIDmode, (N))
 602
 603 #if 0
 604 /* We cannot define prototypes for the variable argument functions,
 605    since they have not been ANSI-fied, and an ANSI compiler would
 606    complain when compiling the definition of these functions.  */
 607
 608 extern rtx gen_rtx                      PROTO((enum rtx_code, enum machine_mode, ...));
 609 extern rtvec gen_rtvec                  PROTO((int, ...));
 610
 611 #else
 612 extern rtx gen_rtx ();
 613 extern rtvec gen_rtvec ();
 614 #endif
 615
 616 #ifdef BUFSIZ                   /* stdio.h has been included */
 617 extern rtx read_rtx                     PROTO((FILE *));
 618 #else
 619 extern rtx read_rtx ();
 620 #endif
 621
 622 #if 0
 623 /* At present, don't prototype xrealloc, since all of the callers don't
 624    cast their pointers to char *, and all of the xrealloc's don't use
 625    void * yet.  */
 626 extern char *xrealloc                   PROTO((void *, unsigned));
 627 #else
 628 extern char *xrealloc ();
 629 #endif
 630
 631 extern char *xmalloc                    PROTO((unsigned));
 632 extern char *oballoc                    PROTO((int));
 633 extern char *permalloc                  PROTO((int));
 634 extern void free                        PROTO((void *));
 635 extern rtx rtx_alloc                    PROTO((RTX_CODE));
 636 extern rtvec rtvec_alloc                PROTO((int));
 637 extern rtx find_reg_note                PROTO((rtx, enum reg_note, rtx));
 638 extern rtx find_regno_note              PROTO((rtx, enum reg_note, int));
 639 extern HOST_WIDE_INT get_integer_term   PROTO((rtx));
 640 extern rtx get_related_value            PROTO((rtx));
 641 extern rtx single_set                   PROTO((rtx));
 642 extern rtx find_last_value              PROTO((rtx, rtx *, rtx));
 643 extern rtx copy_rtx                     PROTO((rtx));
 644 extern rtx copy_rtx_if_shared           PROTO((rtx));
 645 extern rtx copy_most_rtx                PROTO((rtx, rtx));
 646 extern rtx replace_rtx                  PROTO((rtx, rtx, rtx));
 647 extern rtvec gen_rtvec_v                PROTO((int, rtx *));
 648 extern rtx gen_reg_rtx                  PROTO((enum machine_mode));
 649 extern rtx gen_label_rtx                PROTO((void));
 650 extern rtx gen_inline_header_rtx        PROTO((rtx, rtx, int, int, int, int, int, int, rtx, int, int, rtvec, rtx));
 651 extern rtx gen_lowpart_common           PROTO((enum machine_mode, rtx));
 652 extern rtx gen_lowpart                  PROTO((enum machine_mode, rtx));
 653 extern rtx gen_lowpart_if_possible      PROTO((enum machine_mode, rtx));
 654 extern rtx gen_highpart                 PROTO((enum machine_mode, rtx));
 655 extern rtx operand_subword              PROTO((rtx, int, int, enum machine_mode));
 656 extern rtx operand_subword_force        PROTO((rtx, int, enum machine_mode));
 657 extern int subreg_lowpart_p             PROTO((rtx));
 658 extern rtx make_safe_from               PROTO((rtx, rtx));
 659 extern rtx memory_address               PROTO((enum machine_mode, rtx));
 660 extern rtx get_insns                    PROTO((void));
 661 extern rtx get_last_insn                PROTO((void));
 662 extern rtx get_last_insn_anywhere       PROTO((void));
 663 extern void start_sequence              PROTO((void));
 664 extern void push_to_sequence            PROTO((rtx));
 665 extern void end_sequence                PROTO((void));
 666 extern rtx gen_sequence                 PROTO((void));
 667 extern rtx immed_double_const           PROTO((HOST_WIDE_INT, HOST_WIDE_INT, enum machine_mode));
 668 extern rtx force_const_mem              PROTO((enum machine_mode, rtx));
 669 extern rtx force_reg                    PROTO((enum machine_mode, rtx));
 670 extern rtx get_pool_constant            PROTO((rtx));
 671 extern enum machine_mode get_pool_mode  PROTO((rtx));
 672 extern int get_pool_offset              PROTO((rtx));
 673 extern rtx assign_stack_local           PROTO((enum machine_mode, int, int));
 674 extern rtx assign_stack_temp            PROTO((enum machine_mode, int, int));
 675 extern rtx protect_from_queue           PROTO((rtx, int));
 676 extern void emit_queue                  PROTO((void));
 677 extern rtx emit_move_insn               PROTO((rtx, rtx));
 678 extern rtx emit_insn_before             PROTO((rtx, rtx));
 679 extern rtx emit_jump_insn_before        PROTO((rtx, rtx));
 680 extern rtx emit_call_insn_before        PROTO((rtx, rtx));
 681 extern rtx emit_barrier_before          PROTO((rtx));
 682 extern rtx emit_note_before             PROTO((int, rtx));
 683 extern rtx emit_insn_after              PROTO((rtx, rtx));
 684 extern rtx emit_jump_insn_after         PROTO((rtx, rtx));
 685 extern rtx emit_barrier_after           PROTO((rtx));
 686 extern rtx emit_label_after             PROTO((rtx, rtx));
 687 extern rtx emit_note_after              PROTO((int, rtx));
 688 extern rtx emit_line_note_after         PROTO((char *, int, rtx));
 689 extern rtx emit_insn                    PROTO((rtx));
 690 extern rtx emit_insns                   PROTO((rtx));
 691 extern rtx emit_insns_before            PROTO((rtx, rtx));
 692 extern rtx emit_jump_insn               PROTO((rtx));
 693 extern rtx emit_call_insn               PROTO((rtx));
 694 extern rtx emit_label                   PROTO((rtx));
 695 extern rtx emit_barrier                 PROTO((void));
 696 extern rtx emit_line_note               PROTO((char *, int));
 697 extern rtx emit_note                    PROTO((char *, int));
 698 extern rtx emit_line_note_force         PROTO((char *, int));
 699 extern rtx make_insn_raw                PROTO((rtx));
 700 extern rtx previous_insn                PROTO((rtx));
 701 extern rtx next_insn                    PROTO((rtx));
 702 extern rtx prev_nonnote_insn            PROTO((rtx));
 703 extern rtx next_nonnote_insn            PROTO((rtx));
 704 extern rtx prev_real_insn               PROTO((rtx));
 705 extern rtx next_real_insn               PROTO((rtx));
 706 extern rtx prev_active_insn             PROTO((rtx));
 707 extern rtx next_active_insn             PROTO((rtx));
 708 extern rtx prev_label                   PROTO((rtx));
 709 extern rtx next_label                   PROTO((rtx));
 710 extern rtx next_cc0_user                PROTO((rtx));
 711 extern rtx prev_cc0_setter              PROTO((rtx));
 712 extern rtx reg_set_last                 PROTO((rtx, rtx));
 713 extern rtx next_nondeleted_insn         PROTO((rtx));
 714 extern enum rtx_code reverse_condition  PROTO((enum rtx_code));
 715 extern enum rtx_code swap_condition     PROTO((enum rtx_code));
 716 extern enum rtx_code unsigned_condition PROTO((enum rtx_code));
 717 extern enum rtx_code signed_condition   PROTO((enum rtx_code));
 718 extern rtx find_equiv_reg               PROTO((rtx, rtx, enum reg_class, int, short *, int, enum machine_mode));
 719 extern rtx squeeze_notes                PROTO((rtx, rtx));
 720 extern rtx delete_insn                  PROTO((rtx));
 721 extern void delete_jump                 PROTO((rtx));
 722 extern rtx get_label_before             PROTO((rtx));
 723 extern rtx get_label_after              PROTO((rtx));
 724 extern rtx follow_jumps                 PROTO((rtx));
 725 extern rtx adj_offsettable_operand      PROTO((rtx, int));
 726 extern rtx try_split                    PROTO((rtx, rtx, int));
 727 extern rtx split_insns                  PROTO((rtx, rtx));
 728 extern rtx simplify_unary_operation     PROTO((enum rtx_code, enum machine_mode, rtx, enum machine_mode));
 729 extern rtx simplify_binary_operation    PROTO((enum rtx_code, enum machine_mode, rtx, rtx));
 730 extern rtx simplify_ternary_operation   PROTO((enum rtx_code, enum machine_mode, enum machine_mode, rtx, rtx, rtx));
 731 extern rtx simplify_relational_operation PROTO((enum rtx_code, enum machine_mode, rtx, rtx));
 732 extern rtx nonlocal_label_rtx_list      PROTO((void));
 733 extern rtx gen_move_insn                PROTO((rtx, rtx));
 734 extern rtx gen_jump                     PROTO((rtx));
 735 extern rtx gen_beq                      PROTO((rtx));
 736 extern rtx gen_bge                      PROTO((rtx));
 737 extern rtx gen_ble                      PROTO((rtx));
 738 extern rtx eliminate_constant_term      PROTO((rtx, rtx *));
 739
 740 /* Maximum number of parallel sets and clobbers in any insn in this fn.
 741    Always at least 3, since the combiner could put that many togetherm
 742    and we want this to remain correct for all the remaining passes.  */
 743
 744 extern int max_parallel;
 745
 746 extern int asm_noperands                PROTO((rtx));
 747 extern char *decode_asm_operands        PROTO((rtx, rtx *, rtx **, char **, enum machine_mode *));
 748
 749 extern enum reg_class reg_preferred_class PROTO((int));
 750 extern enum reg_class reg_alternate_class PROTO((int));
 751
 752 extern rtx get_first_nonparm_insn       PROTO((void));
 753
 754 /* Standard pieces of rtx, to be substituted directly into things.  */
 755 extern rtx pc_rtx;
 756 extern rtx cc0_rtx;
 757 extern rtx const0_rtx;
 758 extern rtx const1_rtx;
 759 extern rtx const2_rtx;
 760 extern rtx constm1_rtx;
 761 extern rtx const_true_rtx;
 762
 763 extern rtx const_tiny_rtx[3][(int) MAX_MACHINE_MODE];
 764
 765 /* Returns a constant 0 rtx in mode MODE.  Integer modes are treated the
 766    same as VOIDmode.  */
 767
 768 #define CONST0_RTX(MODE) (const_tiny_rtx[0][(int) (MODE)])
 769
 770 /* Likewise, for the constants 1 and 2.  */
 771
 772 #define CONST1_RTX(MODE) (const_tiny_rtx[1][(int) (MODE)])
 773 #define CONST2_RTX(MODE) (const_tiny_rtx[2][(int) (MODE)])
 774
 775 /* All references to certain hard regs, except those created
 776    by allocating pseudo regs into them (when that's possible),
 777    go through these unique rtx objects.  */
 778 extern rtx stack_pointer_rtx;
 779 extern rtx frame_pointer_rtx;
 780 extern rtx arg_pointer_rtx;
 781 extern rtx pic_offset_table_rtx;
 782 extern rtx struct_value_rtx;
 783 extern rtx struct_value_incoming_rtx;
 784 extern rtx static_chain_rtx;
 785 extern rtx static_chain_incoming_rtx;
 786
 787 /* Virtual registers are used during RTL generation to refer to locations into
 788    the stack frame when the actual location isn't known until RTL generation
 789    is complete.  The routine instantiate_virtual_regs replaces these with
 790    the proper value, which is normally {frame,arg,stack}_pointer_rtx plus
 791    a constant.  */
 792
 793 #define FIRST_VIRTUAL_REGISTER  (FIRST_PSEUDO_REGISTER)
 794
 795 /* This points to the first word of the incoming arguments passed on the stack,
 796    either by the caller or by the callee when pretending it was passed by the
 797    caller.  */
 798
 799 extern rtx virtual_incoming_args_rtx;
 800
 801 #define VIRTUAL_INCOMING_ARGS_REGNUM    (FIRST_VIRTUAL_REGISTER)
 802
 803 /* If FRAME_GROWS_DOWNWARDS, this points to immediately above the first
 804    variable on the stack.  Otherwise, it points to the first variable on
 805    the stack.  */
 806
 807 extern rtx virtual_stack_vars_rtx;
 808
 809 #define VIRTUAL_STACK_VARS_REGNUM       ((FIRST_VIRTUAL_REGISTER) + 1)
 810
 811 /* This points to the location of dynamically-allocated memory on the stack
 812    immediately after the stack pointer has been adjusted by the amount
 813    desired.  */
 814
 815 extern rtx virtual_stack_dynamic_rtx;
 816
 817 #define VIRTUAL_STACK_DYNAMIC_REGNUM    ((FIRST_VIRTUAL_REGISTER) + 2)
 818
 819 /* This points to the location in the stack at which outgoing arguments should
 820    be written when the stack is pre-pushed (arguments pushed using push
 821    insns always use sp).  */
 822
 823 extern rtx virtual_outgoing_args_rtx;
 824
 825 #define VIRTUAL_OUTGOING_ARGS_REGNUM    ((FIRST_VIRTUAL_REGISTER) + 3)
 826
 827 #define LAST_VIRTUAL_REGISTER   ((FIRST_VIRTUAL_REGISTER) + 3)
 828
 829 extern rtx find_next_ref                PROTO((rtx, rtx));
 830 extern rtx *find_single_use             PROTO((rtx, rtx, rtx *));
 831
 832 /* It is hard to write the prototype for expand_expr, since it needs
 833    expr.h to be included for the enumeration.  */
 834
 835 extern rtx expand_expr ();
 836 extern rtx immed_real_const_1();
 837
 838 #ifdef TREE_CODE
 839 /* rtl.h and tree.h were included.  */
 840 extern rtx  output_constant_def PROTO((tree));
 841 extern rtx  immed_real_const    PROTO((tree));
 842 extern rtx  immed_real_const_1  PROTO((REAL_VALUE_TYPE, enum machine_mode));
 843 extern tree make_tree           PROTO((tree, rtx));
 844
 845 #else
 846 extern rtx output_constant_def ();
 847 extern rtx immed_real_const ();
 848 extern rtx immed_real_const_1 ();
 849 #endif
 850
 851 /* Define a default value for STORE_FLAG_VALUE.  */
 852
 853 #ifndef STORE_FLAG_VALUE
 854 #define STORE_FLAG_VALUE 1
 855 #endif
 856
 857 /* Nonzero after end of reload pass.
 858    Set to 1 or 0 by toplev.c.  */
 859
 860 extern int reload_completed;
 861
 862 /* Set to 1 while reload_as_needed is operating.
 863    Required by some machines to handle any generated moves differently.  */
 864
 865 extern int reload_in_progress;
 866
 867 /* If this is nonzero, we do not bother generating VOLATILE
 868    around volatile memory references, and we are willing to
 869    output indirect addresses.  If cse is to follow, we reject
 870    indirect addresses so a useful potential cse is generated;
 871    if it is used only once, instruction combination will produce
 872    the same indirect address eventually.  */
 873 extern int cse_not_expected;
 874
 875 /* Indexed by pseudo register number, gives the rtx for that pseudo.
 876    Allocated in parallel with regno_pointer_flag.  */
 877 extern rtx *regno_reg_rtx;