OSDN Git Service

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