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