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