OSDN Git Service

* rtl.h (INSN_P): New macro.
[pf3gnuchains/gcc-fork.git] / gcc / rtl.h
1 /* Register Transfer Language (RTL) definitions for GNU C-Compiler
2    Copyright (C) 1987, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
3    1999, 2000 Free Software Foundation, Inc.
4
5 This file is part of GNU CC.
6
7 GNU CC is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
11
12 GNU CC is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GNU CC; see the file COPYING.  If not, write to
19 the Free Software Foundation, 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA.  */
21
22 #ifndef _RTL_H
23 #define _RTL_H
24
25 struct function;
26
27 #include "machmode.h"
28
29 #undef FFS  /* Some systems predefine this symbol; don't let it interfere.  */
30 #undef FLOAT /* Likewise.  */
31 #undef ABS /* Likewise.  */
32 #undef PC /* Likewise.  */
33
34 #ifndef TREE_CODE
35 union tree_node;
36 #endif
37
38 /* Register Transfer Language EXPRESSIONS CODES */
39
40 #define RTX_CODE        enum rtx_code
41 enum rtx_code  {
42
43 #define DEF_RTL_EXPR(ENUM, NAME, FORMAT, CLASS)   ENUM ,
44 #include "rtl.def"              /* rtl expressions are documented here */
45 #undef DEF_RTL_EXPR
46
47   LAST_AND_UNUSED_RTX_CODE};    /* A convenient way to get a value for
48                                    NUM_RTX_CODE.
49                                    Assumes default enum value assignment.  */
50
51 #define NUM_RTX_CODE ((int)LAST_AND_UNUSED_RTX_CODE)
52                                 /* The cast here, saves many elsewhere.  */
53
54 extern const int rtx_length[];
55 #define GET_RTX_LENGTH(CODE)            (rtx_length[(int) (CODE)])
56
57 extern const char * const rtx_name[];
58 #define GET_RTX_NAME(CODE)              (rtx_name[(int) (CODE)])
59
60 extern const char * const rtx_format[];
61 #define GET_RTX_FORMAT(CODE)            (rtx_format[(int) (CODE)])
62
63 extern const char rtx_class[];
64 #define GET_RTX_CLASS(CODE)             (rtx_class[(int) (CODE)])
65 \f
66 /* The flags and bitfields of an ADDR_DIFF_VEC.  BASE is the base label
67    relative to which the offsets are calculated, as explained in rtl.def.  */
68 typedef struct
69 {
70   /* Set at the start of shorten_branches - ONLY WHEN OPTIMIZING - : */
71   unsigned min_align: 8;
72   /* Flags: */
73   unsigned base_after_vec: 1; /* BASE is after the ADDR_DIFF_VEC.  */
74   unsigned min_after_vec: 1;  /* minimum address target label is after the ADDR_DIFF_VEC.  */
75   unsigned max_after_vec: 1;  /* maximum address target label is after the ADDR_DIFF_VEC.  */
76   unsigned min_after_base: 1; /* minimum address target label is after BASE.  */
77   unsigned max_after_base: 1; /* maximum address target label is after BASE.  */
78   /* Set by the actual branch shortening process - ONLY WHEN OPTIMIZING - : */
79   unsigned offset_unsigned: 1; /* offsets have to be treated as unsigned.  */
80   unsigned : 2;
81   unsigned scale : 8;
82 } addr_diff_vec_flags;
83
84 /* Common union for an element of an rtx.  */
85
86 typedef union rtunion_def
87 {
88   HOST_WIDE_INT rtwint;
89   int rtint;
90   unsigned int rtuint;
91   const char *rtstr;
92   struct rtx_def *rtx;
93   struct rtvec_def *rtvec;
94   enum machine_mode rttype;
95   addr_diff_vec_flags rt_addr_diff_vec_flags;
96   struct cselib_val_struct *rt_cselib;
97   struct bitmap_head_def *rtbit;
98   union tree_node *rttree;
99   struct basic_block_def *bb;
100 } rtunion;
101
102 /* RTL expression ("rtx").  */
103
104 typedef struct rtx_def
105 {
106 #ifdef ONLY_INT_FIELDS
107 #ifdef CODE_FIELD_BUG
108   unsigned int code : 16;
109 #else
110   unsigned short code;
111 #endif
112 #else
113   /* The kind of expression this is.  */
114   enum rtx_code code : 16;
115 #endif
116
117   /* The kind of value the expression has.  */
118 #ifdef ONLY_INT_FIELDS
119   int mode : 8;
120 #else
121   enum machine_mode mode : 8;
122 #endif
123   /* 1 in an INSN if it can alter flow of control
124      within this function.
125      LINK_COST_ZERO in an INSN_LIST.  */
126   unsigned int jump : 1;
127   /* 1 in an INSN if it can call another function.
128      LINK_COST_FREE in an INSN_LIST.  */
129   unsigned int call : 1;
130   /* 1 in a MEM or REG if value of this expression will never change
131      during the current function, even though it is not
132      manifestly constant.
133      1 in a SUBREG if it is from a promoted variable that is unsigned.
134      1 in a SYMBOL_REF if it addresses something in the per-function
135      constants pool.
136      1 in a CALL_INSN if it is a const call.
137      1 in a JUMP_INSN if it is a branch that should be annulled.  Valid from
138      reorg until end of compilation; cleared before used.  */
139   unsigned int unchanging : 1;
140   /* 1 in a MEM expression if contents of memory are volatile.
141      1 in an INSN, CALL_INSN, JUMP_INSN, CODE_LABEL or BARRIER
142      if it is deleted.
143      1 in a REG expression if corresponds to a variable declared by the user.
144      0 for an internally generated temporary.
145      In a SYMBOL_REF, this flag is used for machine-specific purposes.
146      In a LABEL_REF or in a REG_LABEL note, this is LABEL_REF_NONLOCAL_P.  */
147   unsigned int volatil : 1;
148   /* 1 in a MEM referring to a field of an aggregate.
149      0 if the MEM was a variable or the result of a * operator in C;
150      1 if it was the result of a . or -> operator (on a struct) in C.
151      1 in a REG if the register is used only in exit code a loop.
152      1 in a SUBREG expression if was generated from a variable with a
153      promoted mode.
154      1 in a CODE_LABEL if the label is used for nonlocal gotos
155      and must not be deleted even if its count is zero.
156      1 in a LABEL_REF if this is a reference to a label outside the
157      current loop.
158      1 in an INSN, JUMP_INSN, or CALL_INSN if this insn must be scheduled
159      together with the preceding insn.  Valid only within sched.
160      1 in an INSN, JUMP_INSN, or CALL_INSN if insn is in a delay slot and
161      from the target of a branch.  Valid from reorg until end of compilation;
162      cleared before used.  */
163   unsigned int in_struct : 1;
164   /* 1 if this rtx is used.  This is used for copying shared structure.
165      See `unshare_all_rtl'.
166      In a REG, this is not needed for that purpose, and used instead
167      in `leaf_renumber_regs_insn'.
168      In a SYMBOL_REF, means that emit_library_call
169      has used it as the function.  */
170   unsigned int used : 1;
171   /* Nonzero if this rtx came from procedure integration.
172      In a REG, nonzero means this reg refers to the return value
173      of the current function.  */
174   unsigned integrated : 1;
175   /* 1 in an INSN or a SET if this rtx is related to the call frame,
176      either changing how we compute the frame address or saving and
177      restoring registers in the prologue and epilogue.
178      1 in a MEM if the MEM refers to a scalar, rather than a member of
179      an aggregate.  */
180   unsigned frame_related : 1;
181
182   /* The first element of the operands of this rtx.
183      The number of operands and their types are controlled
184      by the `code' field, according to rtl.def.  */
185   rtunion fld[1];
186 } *rtx;
187
188 #define NULL_RTX (rtx) 0
189
190 /* Define macros to access the `code' field of the rtx.  */
191
192 #ifdef SHORT_ENUM_BUG
193 #define GET_CODE(RTX)           ((enum rtx_code) ((RTX)->code))
194 #define PUT_CODE(RTX, CODE)     ((RTX)->code = ((short) (CODE)))
195 #else
196 #define GET_CODE(RTX)           ((RTX)->code)
197 #define PUT_CODE(RTX, CODE)     ((RTX)->code = (CODE))
198 #endif
199
200 #define GET_MODE(RTX)           ((RTX)->mode)
201 #define PUT_MODE(RTX, MODE)     ((RTX)->mode = (MODE))
202
203 #define RTX_INTEGRATED_P(RTX) ((RTX)->integrated)
204 #define RTX_UNCHANGING_P(RTX) ((RTX)->unchanging)
205 #define RTX_FRAME_RELATED_P(RTX) ((RTX)->frame_related)
206
207 /* RTL vector.  These appear inside RTX's when there is a need
208    for a variable number of things.  The principle use is inside
209    PARALLEL expressions.  */
210
211 typedef struct rtvec_def{
212   int num_elem;         /* number of elements */
213   struct rtx_def *elem[1];
214 } *rtvec;
215
216 #define NULL_RTVEC (rtvec) 0
217
218 #define GET_NUM_ELEM(RTVEC)             ((RTVEC)->num_elem)
219 #define PUT_NUM_ELEM(RTVEC, NUM)        ((RTVEC)->num_elem = (NUM))
220
221 /* 1 if X is a REG.  */
222
223 #define REG_P(X) (GET_CODE (X) == REG)
224
225 /* 1 if X is a constant value that is an integer.  */
226
227 #define CONSTANT_P(X)   \
228   (GET_CODE (X) == LABEL_REF || GET_CODE (X) == SYMBOL_REF              \
229    || GET_CODE (X) == CONST_INT || GET_CODE (X) == CONST_DOUBLE         \
230    || GET_CODE (X) == CONST || GET_CODE (X) == HIGH                     \
231    || GET_CODE (X) == CONSTANT_P_RTX)
232
233 /* General accessor macros for accessing the fields of an rtx.  */
234
235 #if defined ENABLE_RTL_CHECKING && (GCC_VERSION >= 2007)
236 /* The bit with a star outside the statement expr and an & inside is
237    so that N can be evaluated only once.  */
238 #define RTL_CHECK1(RTX, N, C1)                                          \
239 (*({ rtx _rtx = (RTX); int _n = (N);                                    \
240      enum rtx_code _code = GET_CODE (_rtx);                             \
241      if (_n < 0 || _n >= GET_RTX_LENGTH (_code))                        \
242        rtl_check_failed_bounds (_rtx, _n, __FILE__, __LINE__,           \
243                                 __PRETTY_FUNCTION__);                   \
244      if (GET_RTX_FORMAT(_code)[_n] != C1)                               \
245        rtl_check_failed_type1 (_rtx, _n, C1, __FILE__, __LINE__,        \
246                                __PRETTY_FUNCTION__);                    \
247      &_rtx->fld[_n]; }))
248
249 #define RTL_CHECK2(RTX, N, C1, C2)                                      \
250 (*({ rtx _rtx = (RTX); int _n = (N);                                    \
251      enum rtx_code _code = GET_CODE (_rtx);                             \
252      if (_n < 0 || _n >= GET_RTX_LENGTH (_code))                        \
253        rtl_check_failed_bounds (_rtx, _n, __FILE__, __LINE__,           \
254                                 __PRETTY_FUNCTION__);                   \
255      if (GET_RTX_FORMAT(_code)[_n] != C1                                \
256          && GET_RTX_FORMAT(_code)[_n] != C2)                            \
257        rtl_check_failed_type2 (_rtx, _n, C1, C2, __FILE__, __LINE__,    \
258                                __PRETTY_FUNCTION__);                    \
259      &_rtx->fld[_n]; }))
260
261 #define RTL_CHECKC1(RTX, N, C)                                          \
262 (*({ rtx _rtx = (RTX); int _n = (N);                                    \
263      if (GET_CODE (_rtx) != C)                                          \
264        rtl_check_failed_code1 (_rtx, C, __FILE__, __LINE__,             \
265                                __PRETTY_FUNCTION__);                    \
266      &_rtx->fld[_n]; }))
267
268 #define RTL_CHECKC2(RTX, N, C1, C2)                                     \
269 (*({ rtx _rtx = (RTX); int _n = (N);                                    \
270      enum rtx_code _code = GET_CODE (_rtx);                             \
271      if (_code != C1 && _code != C2)                                    \
272        rtl_check_failed_code2 (_rtx, C1, C2, __FILE__, __LINE__,        \
273                                __PRETTY_FUNCTION__);                    \
274      &_rtx->fld[_n]; }))
275
276 #define RTVEC_ELT(RTVEC, I)                                             \
277 (*({ rtvec _rtvec = (RTVEC); int _i = (I);                              \
278      if (_i < 0 || _i >= GET_NUM_ELEM (_rtvec))                         \
279        rtvec_check_failed_bounds (_rtvec, _i, __FILE__, __LINE__,       \
280                                   __PRETTY_FUNCTION__);                 \
281      &_rtvec->elem[_i]; }))
282
283 extern void rtl_check_failed_bounds PARAMS ((rtx, int,
284                                            const char *, int, const char *))
285     ATTRIBUTE_NORETURN;
286 extern void rtl_check_failed_type1 PARAMS ((rtx, int, int,
287                                           const char *, int, const char *))
288     ATTRIBUTE_NORETURN;
289 extern void rtl_check_failed_type2 PARAMS ((rtx, int, int, int,
290                                           const char *, int, const char *))
291     ATTRIBUTE_NORETURN;
292 extern void rtl_check_failed_code1 PARAMS ((rtx, enum rtx_code,
293                                           const char *, int, const char *))
294     ATTRIBUTE_NORETURN;
295 extern void rtl_check_failed_code2 PARAMS ((rtx, enum rtx_code, enum rtx_code,
296                                           const char *, int, const char *))
297     ATTRIBUTE_NORETURN;
298 extern void rtvec_check_failed_bounds PARAMS ((rtvec, int,
299                                              const char *, int, const char *))
300     ATTRIBUTE_NORETURN;
301
302 #else   /* not ENABLE_RTL_CHECKING */
303
304 #define RTL_CHECK1(RTX, N, C1)      ((RTX)->fld[N])
305 #define RTL_CHECK2(RTX, N, C1, C2)  ((RTX)->fld[N])
306 #define RTL_CHECKC1(RTX, N, C)      ((RTX)->fld[N])
307 #define RTL_CHECKC2(RTX, N, C1, C2) ((RTX)->fld[N])
308 #define RTVEC_ELT(RTVEC, I)         ((RTVEC)->elem[I])
309
310 #endif
311
312 #define XWINT(RTX, N)   (RTL_CHECK1(RTX, N, 'w').rtwint)
313 #define XINT(RTX, N)    (RTL_CHECK2(RTX, N, 'i', 'n').rtint)
314 #define XSTR(RTX, N)    (RTL_CHECK2(RTX, N, 's', 'S').rtstr)
315 #define XEXP(RTX, N)    (RTL_CHECK2(RTX, N, 'e', 'u').rtx)
316 #define XVEC(RTX, N)    (RTL_CHECK2(RTX, N, 'E', 'V').rtvec)
317 #define XMODE(RTX, N)   (RTL_CHECK1(RTX, N, 'M').rttype)
318 #define XBITMAP(RTX, N) (RTL_CHECK1(RTX, N, 'b').rtbit)
319 #define XTREE(RTX, N)   (RTL_CHECK1(RTX, N, 't').rttree)
320 #define XBBDEF(RTX, N)  (RTL_CHECK1(RTX, N, 'B').bb)
321
322 #define XVECEXP(RTX, N, M)      RTVEC_ELT (XVEC (RTX, N), M)
323 #define XVECLEN(RTX, N)         GET_NUM_ELEM (XVEC (RTX, N))
324
325 /* These are like XWINT, etc. except that they expect a '0' field instead
326    of the normal type code.  */
327
328 #define X0WINT(RTX, N)     (RTL_CHECK1(RTX, N, '0').rtwint)
329 #define X0INT(RTX, N)      (RTL_CHECK1(RTX, N, '0').rtint)
330 #define X0STR(RTX, N)      (RTL_CHECK1(RTX, N, '0').rtstr)
331 #define X0EXP(RTX, N)      (RTL_CHECK1(RTX, N, '0').rtx)
332 #define X0VEC(RTX, N)      (RTL_CHECK1(RTX, N, '0').rtvec)
333 #define X0MODE(RTX, N)     (RTL_CHECK1(RTX, N, '0').rttype)
334 #define X0BITMAP(RTX, N)   (RTL_CHECK1(RTX, N, '0').rtbit)
335 #define X0TREE(RTX, N)     (RTL_CHECK1(RTX, N, '0').rttree)
336 #define X0BBDEF(RTX, N)    (RTL_CHECK1(RTX, N, '0').bb)
337 #define X0ADVFLAGS(RTX, N) (RTL_CHECK1(RTX, N, '0').rt_addr_diff_vec_flags)
338 #define X0CSELIB(RTX, N)   (RTL_CHECK1(RTX, N, '0').rt_cselib)
339
340 #define XCWINT(RTX, N, C)     (RTL_CHECKC1(RTX, N, C).rtwint)
341 #define XCINT(RTX, N, C)      (RTL_CHECKC1(RTX, N, C).rtint)
342 #define XCUINT(RTX, N, C)     (RTL_CHECKC1(RTX, N, C).rtuint)
343 #define XCSTR(RTX, N, C)      (RTL_CHECKC1(RTX, N, C).rtstr)
344 #define XCEXP(RTX, N, C)      (RTL_CHECKC1(RTX, N, C).rtx)
345 #define XCVEC(RTX, N, C)      (RTL_CHECKC1(RTX, N, C).rtvec)
346 #define XCMODE(RTX, N, C)     (RTL_CHECKC1(RTX, N, C).rttype)
347 #define XCBITMAP(RTX, N, C)   (RTL_CHECKC1(RTX, N, C).rtbit)
348 #define XCTREE(RTX, N, C)     (RTL_CHECKC1(RTX, N, C).rttree)
349 #define XCBBDEF(RTX, N, C)    (RTL_CHECKC1(RTX, N, C).bb)
350 #define XCADVFLAGS(RTX, N, C) (RTL_CHECKC1(RTX, N, C).rt_addr_diff_vec_flags)
351 #define XCCSELIB(RTX, N, C)   (RTL_CHECKC1(RTX, N, C).rt_cselib)
352
353 #define XCVECEXP(RTX, N, M, C)  RTVEC_ELT (XCVEC (RTX, N, C), M)
354 #define XCVECLEN(RTX, N, C)     GET_NUM_ELEM (XCVEC (RTX, N, C))
355
356 #define XC2EXP(RTX, N, C1, C2)      (RTL_CHECKC2(RTX, N, C1, C2).rtx)
357 \f
358 /* ACCESS MACROS for particular fields of insns.  */
359
360 /* Determines whether X is an insn.  */
361 #define INSN_P(X)       (GET_RTX_CLASS (GET_CODE(X)) == 'i')
362
363 /* Holds a unique number for each insn.
364    These are not necessarily sequentially increasing.  */
365 #define INSN_UID(INSN)  XINT(INSN, 0)
366
367 /* Chain insns together in sequence.  */
368 #define PREV_INSN(INSN) XEXP(INSN, 1)
369 #define NEXT_INSN(INSN) XEXP(INSN, 2)
370
371 /* The body of an insn.  */
372 #define PATTERN(INSN)   XEXP(INSN, 3)
373
374 /* Code number of instruction, from when it was recognized.
375    -1 means this instruction has not been recognized yet.  */
376 #define INSN_CODE(INSN) XINT(INSN, 4)
377
378 /* Set up in flow.c; empty before then.
379    Holds a chain of INSN_LIST rtx's whose first operands point at
380    previous insns with direct data-flow connections to this one.
381    That means that those insns set variables whose next use is in this insn.
382    They are always in the same basic block as this insn.  */
383 #define LOG_LINKS(INSN) XEXP(INSN, 5)
384
385 /* 1 if insn has been deleted.  */
386 #define INSN_DELETED_P(INSN) ((INSN)->volatil)
387
388 /* 1 if insn is a call to a const function.  */
389 #define CONST_CALL_P(INSN) ((INSN)->unchanging)
390
391 /* 1 if insn (assumed to be a CALL_INSN) is a sibling call.  */
392 #define SIBLING_CALL_P(INSN) ((INSN)->jump)
393
394 /* 1 if insn is a branch that should not unconditionally execute its
395    delay slots, i.e., it is an annulled branch.   */
396 #define INSN_ANNULLED_BRANCH_P(INSN) ((INSN)->unchanging)
397
398 /* 1 if insn is in a delay slot and is from the target of the branch.  If
399    the branch insn has INSN_ANNULLED_BRANCH_P set, this insn should only be
400    executed if the branch is taken.  For annulled branches with this bit
401    clear, the insn should be executed only if the branch is not taken.  */
402 #define INSN_FROM_TARGET_P(INSN) ((INSN)->in_struct)
403
404 #define ADDR_DIFF_VEC_FLAGS(RTX) X0ADVFLAGS(RTX, 4)
405
406 #define CSELIB_VAL_PTR(RTX) X0CSELIB(RTX, 0)
407
408 /* Holds a list of notes on what this insn does to various REGs.
409    It is a chain of EXPR_LIST rtx's, where the second operand is the
410    chain pointer and the first operand is the REG being described.
411    The mode field of the EXPR_LIST contains not a real machine mode
412    but a value from enum reg_note.  */
413
414 #define REG_NOTES(INSN) XEXP(INSN, 6)
415
416 /* Don't forget to change reg_note_name in rtl.c.  */
417 enum reg_note
418 {
419   /* The value in REG dies in this insn (i.e., it is not needed past
420      this insn).  If REG is set in this insn, the REG_DEAD note may,
421      but need not, be omitted.  */
422   REG_DEAD = 1,
423
424   /* The REG is autoincremented or autodecremented.  */
425   REG_INC,
426
427   /* Describes the insn as a whole; it says that the insn sets a register
428      to a constant value or to be equivalent to a memory address.  If the
429      register is spilled to the stack then the constant value should be
430      substituted for it.  The contents of the REG_EQUIV is the constant
431      value or memory address, which may be different from the source of
432      the SET although it has the same value.  A REG_EQUIV note may also
433      appear on an insn which copies a register parameter to a pseudo-register,
434      if there is a memory address which could be used to hold that
435      pseudo-register throughout the function.  */
436    REG_EQUIV,
437
438   /* Like REG_EQUIV except that the destination is only momentarily equal
439      to the specified rtx.  Therefore, it cannot be used for substitution;
440      but it can be used for cse.  */
441   REG_EQUAL,
442
443   /* The register set in this insn held 0 before the insn.  The contents of
444      the note is the insn that stored the 0.  If that insn is deleted or
445      patched to a NOTE, the REG_WAS_0 is inoperative.  The REG_WAS_0 note
446      is actually an INSN_LIST, not an EXPR_LIST.  */
447   REG_WAS_0,
448
449   /* This insn copies the return-value of a library call out of the hard reg
450      for return values.  This note is actually an INSN_LIST and it points to
451      the first insn involved in setting up arguments for the call.  flow.c
452      uses this to delete the entire library call when its result is dead.  */
453   REG_RETVAL,
454
455   /* The inverse of REG_RETVAL: it goes on the first insn of the library call
456      and points at the one that has the REG_RETVAL.  */
457   REG_LIBCALL,
458
459   /* The register is always nonnegative during the containing loop.  This is
460      used in branches so that decrement and branch instructions terminating
461      on zero can be matched.  There must be an insn pattern in the md file
462      named `decrement_and_branch_until_zero' or else this will never be added
463      to any instructions.  */
464   REG_NONNEG,
465
466   /* There is no conflict *after this insn* between the register in the note
467      and the destination of this insn.  */
468   REG_NO_CONFLICT,
469
470   /* Identifies a register set in this insn and never used.  */
471   REG_UNUSED,
472
473   /* REG_CC_SETTER and REG_CC_USER link a pair of insns that set and use CC0,
474      respectively.  Normally, these are required to be consecutive insns, but
475      we permit putting a cc0-setting insn in the delay slot of a branch as
476      long as only one copy of the insn exists.  In that case, these notes
477      point from one to the other to allow code generation to determine what
478      any require information and to properly update CC_STATUS.  */
479   REG_CC_SETTER, REG_CC_USER,
480
481   /* Points to a CODE_LABEL.  Used by non-JUMP_INSNs to say that the
482      CODE_LABEL contained in the REG_LABEL note is used by the insn.  */
483   REG_LABEL,
484
485   /* REG_DEP_ANTI and REG_DEP_OUTPUT are used in LOG_LINKS to represent
486      write-after-read and write-after-write dependencies respectively.
487      Data dependencies, which are the only type of LOG_LINK created by
488      flow, are represented by a 0 reg note kind.  */
489   REG_DEP_ANTI, REG_DEP_OUTPUT,
490
491   /* REG_BR_PROB is attached to JUMP_INSNs and CALL_INSNs when the flag
492      -fbranch-probabilities is given.  It has an integer value.  For jumps,
493      it is the probability that this is a taken branch.  For calls, it is
494      the probability that this call won't return.  */
495   REG_BR_PROB,
496
497   /* REG_EXEC_COUNT is attached to the first insn of each basic block, and
498      the first insn after each CALL_INSN.  It indicates how many times this
499      block was executed.  */
500   REG_EXEC_COUNT,
501
502   /* Attached to a call insn; indicates that the call is malloc-like and
503      that the pointer returned cannot alias anything else.  */
504   REG_NOALIAS,
505
506   /* Used to optimize rtl generated by dynamic stack allocations for targets
507      where SETJMP_VIA_SAVE_AREA is true.  */
508   REG_SAVE_AREA,
509
510   /* Attached to JUMP_INSNs only, it holds the branch prediction flags
511      computed by get_jump_flags() after dbr scheduling is complete.  */
512   REG_BR_PRED,
513
514   /* Attached to insns that are RTX_FRAME_RELATED_P, but are too complex
515      for DWARF to interpret what they imply.  The attached rtx is used
516      instead of intuition.  */
517   REG_FRAME_RELATED_EXPR,
518
519   /* Indicates that REG holds the exception context for the function.
520      This context is shared by inline functions, so the code to acquire
521      the real exception context is delayed until after inlining.  */
522   REG_EH_CONTEXT,
523
524   /* Indicates what exception region an INSN belongs in.  This is used to
525      indicate what region to which a call may throw.  REGION 0 indicates
526      that a call cannot throw at all.  REGION -1 indicates that it cannot
527      throw, nor will it execute a non-local goto.  */
528   REG_EH_REGION,
529
530   /* Indicates that a call is actually a call to rethrow, and specifies the
531      rethrow symbol for the region the rethrow is targetting.  This provides
532      a way to generate the non standard flow edges required for a rethrow.  */
533   REG_EH_RETHROW,
534
535   /* Used by haifa-sched to save NOTE_INSN notes across scheduling.  */
536   REG_SAVE_NOTE
537 };
538
539 /* The base value for branch probability notes.  */
540 #define REG_BR_PROB_BASE  10000
541
542 /* Define macros to extract and insert the reg-note kind in an EXPR_LIST.  */
543 #define REG_NOTE_KIND(LINK) ((enum reg_note) GET_MODE (LINK))
544 #define PUT_REG_NOTE_KIND(LINK,KIND) PUT_MODE(LINK, (enum machine_mode) (KIND))
545
546 /* Names for REG_NOTE's in EXPR_LIST insn's.  */
547
548 extern const char * const reg_note_name[];
549 #define GET_REG_NOTE_NAME(MODE) (reg_note_name[(int) (MODE)])
550
551 /* This field is only present on CALL_INSNs.  It holds a chain of EXPR_LIST of
552    USE and CLOBBER expressions.
553      USE expressions list the registers filled with arguments that
554    are passed to the function.
555      CLOBBER expressions document the registers explicitly clobbered
556    by this CALL_INSN.
557      Pseudo registers can not be mentioned in this list.  */
558 #define CALL_INSN_FUNCTION_USAGE(INSN)  XEXP(INSN, 7)
559
560 /* The label-number of a code-label.  The assembler label
561    is made from `L' and the label-number printed in decimal.
562    Label numbers are unique in a compilation.  */
563 #define CODE_LABEL_NUMBER(INSN) XINT(INSN, 3)
564
565 #define LINE_NUMBER NOTE
566
567 /* In a NOTE that is a line number, this is a string for the file name that the
568    line is in.  We use the same field to record block numbers temporarily in
569    NOTE_INSN_BLOCK_BEG and NOTE_INSN_BLOCK_END notes.  (We avoid lots of casts
570    between ints and pointers if we use a different macro for the block number.)
571    The NOTE_INSN_RANGE_{START,END} and NOTE_INSN_LIVE notes record their
572    information as a rtx in the field.  */
573
574 #define NOTE_SOURCE_FILE(INSN)  XCSTR(INSN, 3, NOTE)
575 #define NOTE_BLOCK(INSN)        XCTREE(INSN, 3, NOTE)
576 #define NOTE_EH_HANDLER(INSN)   XCINT(INSN, 3, NOTE)
577 #define NOTE_RANGE_INFO(INSN)   XCEXP(INSN, 3, NOTE)
578 #define NOTE_LIVE_INFO(INSN)    XCEXP(INSN, 3, NOTE)
579 #define NOTE_BASIC_BLOCK(INSN)  XCBBDEF(INSN, 3, NOTE)
580
581 /* In a NOTE that is a line number, this is the line number.
582    Other kinds of NOTEs are identified by negative numbers here.  */
583 #define NOTE_LINE_NUMBER(INSN) XCINT(INSN, 4, NOTE)
584
585 /* Codes that appear in the NOTE_LINE_NUMBER field
586    for kinds of notes that are not line numbers.
587
588    Notice that we do not try to use zero here for any of
589    the special note codes because sometimes the source line
590    actually can be zero!  This happens (for example) when we
591    are generating code for the per-translation-unit constructor
592    and destructor routines for some C++ translation unit.
593
594    If you should change any of the following values, or if you
595    should add a new value here, don't forget to change the
596    note_insn_name array in rtl.c.  */
597
598 /* This note is used to get rid of an insn
599    when it isn't safe to patch the insn out of the chain.  */
600 #define NOTE_INSN_DELETED -1
601 #define NOTE_INSN_BLOCK_BEG -2
602 #define NOTE_INSN_BLOCK_END -3
603 #define NOTE_INSN_LOOP_BEG -4
604 #define NOTE_INSN_LOOP_END -5
605 /* This kind of note is generated at the end of the function body,
606    just before the return insn or return label.
607    In an optimizing compilation it is deleted by the first jump optimization,
608    after enabling that optimizer to determine whether control can fall
609    off the end of the function body without a return statement.  */
610 #define NOTE_INSN_FUNCTION_END -6
611 /* This kind of note is generated just after each call to `setjmp', et al.  */
612 #define NOTE_INSN_SETJMP -7
613 /* Generated at the place in a loop that `continue' jumps to.  */
614 #define NOTE_INSN_LOOP_CONT -8
615 /* Generated at the start of a duplicated exit test.  */
616 #define NOTE_INSN_LOOP_VTOP -9
617 /* This marks the point immediately after the last prologue insn.  */
618 #define NOTE_INSN_PROLOGUE_END -10
619 /* This marks the point immediately prior to the first epilogue insn.  */
620 #define NOTE_INSN_EPILOGUE_BEG -11
621 /* Generated in place of user-declared labels when they are deleted.  */
622 #define NOTE_INSN_DELETED_LABEL -12
623 /* This note indicates the start of the real body of the function,
624    i.e. the point just after all of the parms have been moved into
625    their homes, etc.  */
626 #define NOTE_INSN_FUNCTION_BEG -13
627 /* These note where exception handling regions begin and end.  */
628 #define NOTE_INSN_EH_REGION_BEG -14
629 #define NOTE_INSN_EH_REGION_END -15
630 /* Generated whenever a duplicate line number note is output.  For example,
631    one is output after the end of an inline function, in order to prevent
632    the line containing the inline call from being counted twice in gcov. */
633 #define NOTE_REPEATED_LINE_NUMBER -16
634
635 /* Start/end of a live range region, where pseudos allocated on the stack can
636    be allocated to temporary registers.  */
637 #define NOTE_INSN_RANGE_START -17
638 #define NOTE_INSN_RANGE_END -18
639 /* Record which registers are currently live.  */
640 #define NOTE_INSN_LIVE -19
641 /* Record the struct for the following basic block.  */
642 #define NOTE_INSN_BASIC_BLOCK -20
643
644 /* Names for NOTE insn's other than line numbers.  */
645
646 extern const char * const note_insn_name[];
647 #define GET_NOTE_INSN_NAME(NOTE_CODE) (note_insn_name[-(NOTE_CODE)])
648
649 /* The name of a label, in case it corresponds to an explicit label
650    in the input source code.  */
651 #define LABEL_NAME(RTX) XCSTR(RTX, 4, CODE_LABEL)
652
653 /* In jump.c, each label contains a count of the number
654    of LABEL_REFs that point at it, so unused labels can be deleted.  */
655 #define LABEL_NUSES(RTX) XCINT(RTX, 5, CODE_LABEL)
656
657 /* Associate a name with a CODE_LABEL.  */
658 #define LABEL_ALTERNATE_NAME(RTX) XCSTR(RTX, 7, CODE_LABEL)
659
660 /* The original regno this ADDRESSOF was built for.  */
661 #define ADDRESSOF_REGNO(RTX) XCUINT(RTX, 1, ADDRESSOF)
662
663 /* The variable in the register we took the address of.  */
664 #define ADDRESSOF_DECL(RTX) XCTREE(RTX, 2, ADDRESSOF)
665
666 /* In jump.c, each JUMP_INSN can point to a label that it can jump to,
667    so that if the JUMP_INSN is deleted, the label's LABEL_NUSES can
668    be decremented and possibly the label can be deleted.  */
669 #define JUMP_LABEL(INSN)   XCEXP(INSN, 7, JUMP_INSN)
670
671 /* Once basic blocks are found in flow.c,
672    each CODE_LABEL starts a chain that goes through
673    all the LABEL_REFs that jump to that label.
674    The chain eventually winds up at the CODE_LABEL; it is circular.  */
675 #define LABEL_REFS(LABEL) XCEXP(LABEL, 6, CODE_LABEL)
676 \f
677 /* This is the field in the LABEL_REF through which the circular chain
678    of references to a particular label is linked.
679    This chain is set up in flow.c.  */
680
681 #define LABEL_NEXTREF(REF) XCEXP(REF, 1, LABEL_REF)
682
683 /* Once basic blocks are found in flow.c,
684    Each LABEL_REF points to its containing instruction with this field.  */
685
686 #define CONTAINING_INSN(RTX) XCEXP(RTX, 2, LABEL_REF)
687
688 /* For a REG rtx, REGNO extracts the register number.  */
689
690 #define REGNO(RTX) XCUINT(RTX, 0, REG)
691
692 /* For a REG rtx, REG_FUNCTION_VALUE_P is nonzero if the reg
693    is the current function's return value.  */
694
695 #define REG_FUNCTION_VALUE_P(RTX) ((RTX)->integrated)
696
697 /* 1 in a REG rtx if it corresponds to a variable declared by the user.  */
698 #define REG_USERVAR_P(RTX) ((RTX)->volatil)
699
700 /* For a CONST_INT rtx, INTVAL extracts the integer.  */
701
702 #define INTVAL(RTX) XCWINT(RTX, 0, CONST_INT)
703
704 /* For a SUBREG rtx, SUBREG_REG extracts the value we want a subreg of.
705    SUBREG_WORD extracts the word-number.  */
706
707 #define SUBREG_REG(RTX) XCEXP(RTX, 0, SUBREG)
708 #define SUBREG_WORD(RTX) XCUINT(RTX, 1, SUBREG)
709
710 /* 1 if the REG contained in SUBREG_REG is already known to be
711    sign- or zero-extended from the mode of the SUBREG to the mode of
712    the reg.  SUBREG_PROMOTED_UNSIGNED_P gives the signedness of the
713    extension.
714
715    When used as a LHS, is means that this extension must be done
716    when assigning to SUBREG_REG.  */
717
718 #define SUBREG_PROMOTED_VAR_P(RTX) ((RTX)->in_struct)
719 #define SUBREG_PROMOTED_UNSIGNED_P(RTX) ((RTX)->unchanging)
720
721 /* Access various components of an ASM_OPERANDS rtx.  */
722
723 #define ASM_OPERANDS_TEMPLATE(RTX) XCSTR ((RTX), 0, ASM_OPERANDS)
724 #define ASM_OPERANDS_OUTPUT_CONSTRAINT(RTX) XCSTR ((RTX), 1, ASM_OPERANDS)
725 #define ASM_OPERANDS_OUTPUT_IDX(RTX) XCINT ((RTX), 2, ASM_OPERANDS)
726 #define ASM_OPERANDS_INPUT_VEC(RTX) XCVEC ((RTX), 3, ASM_OPERANDS)
727 #define ASM_OPERANDS_INPUT_CONSTRAINT_VEC(RTX) XCVEC ((RTX), 4, ASM_OPERANDS)
728 #define ASM_OPERANDS_INPUT(RTX, N) XCVECEXP ((RTX), 3, (N), ASM_OPERANDS)
729 #define ASM_OPERANDS_INPUT_LENGTH(RTX) XCVECLEN ((RTX), 3, ASM_OPERANDS)
730 #define ASM_OPERANDS_INPUT_CONSTRAINT(RTX, N) XSTR (XCVECEXP ((RTX), 4, (N), ASM_OPERANDS), 0)
731 #define ASM_OPERANDS_INPUT_MODE(RTX, N) GET_MODE (XCVECEXP ((RTX), 4, (N), ASM_OPERANDS))
732 #define ASM_OPERANDS_SOURCE_FILE(RTX) XCSTR ((RTX), 5, ASM_OPERANDS)
733 #define ASM_OPERANDS_SOURCE_LINE(RTX) XCINT ((RTX), 6, ASM_OPERANDS)
734
735 /* For a MEM rtx, 1 if it's a volatile reference.
736    Also in an ASM_OPERANDS rtx.  */
737 #define MEM_VOLATILE_P(RTX) ((RTX)->volatil)
738
739 /* For a MEM rtx, 1 if it refers to a field of an aggregate.  If zero,
740    RTX may or may not refer to a field of an aggregate.  */
741 #define MEM_IN_STRUCT_P(RTX) ((RTX)->in_struct)
742
743 /* For a MEM rtx, 1 if it refers to a scalar.  If zero, RTX may or may
744    not refer to a scalar.*/
745 #define MEM_SCALAR_P(RTX) ((RTX)->frame_related)
746
747 /* Copy the MEM_VOLATILE_P, MEM_IN_STRUCT_P, and MEM_SCALAR_P
748    attributes from RHS to LHS.  */
749 #define MEM_COPY_ATTRIBUTES(LHS, RHS)                   \
750   (MEM_VOLATILE_P (LHS) = MEM_VOLATILE_P (RHS),         \
751    MEM_IN_STRUCT_P (LHS) = MEM_IN_STRUCT_P (RHS),       \
752    MEM_SCALAR_P (LHS) = MEM_SCALAR_P (RHS))
753
754 /* If VAL is non-zero, set MEM_IN_STRUCT_P and clear MEM_SCALAR_P in
755    RTX.  Otherwise, vice versa.  Use this macro only when you are
756    *sure* that you know that the MEM is in a structure, or is a
757    scalar.  VAL is evaluated only once.  */
758 #define MEM_SET_IN_STRUCT_P(RTX, VAL)                           \
759   ((VAL) ? (MEM_IN_STRUCT_P (RTX) = 1, MEM_SCALAR_P (RTX) = 0)  \
760    : (MEM_IN_STRUCT_P (RTX) = 0, MEM_SCALAR_P (RTX) = 1))
761
762 /* For a MEM rtx, the alias set.  If 0, this MEM is not in any alias
763    set, and may alias anything.  Otherwise, the MEM can only alias
764    MEMs in the same alias set.  This value is set in a
765    language-dependent manner in the front-end, and should not be
766    altered in the back-end.  These set numbers are tested for zero,
767    and compared for equality; they have no other significance.  In
768    some front-ends, these numbers may correspond in some way to types,
769    or other language-level entities, but they need not, and the
770    back-end makes no such assumptions.  */
771 #define MEM_ALIAS_SET(RTX) XCINT(RTX, 1, MEM)
772
773 /* For a LABEL_REF, 1 means that this reference is to a label outside the
774    loop containing the reference.  */
775 #define LABEL_OUTSIDE_LOOP_P(RTX) ((RTX)->in_struct)
776
777 /* For a LABEL_REF, 1 means it is for a nonlocal label.  */
778 /* Likewise in an EXPR_LIST for a REG_LABEL note.  */
779 #define LABEL_REF_NONLOCAL_P(RTX) ((RTX)->volatil)
780
781 /* For a CODE_LABEL, 1 means always consider this label to be needed.  */
782 #define LABEL_PRESERVE_P(RTX) ((RTX)->in_struct)
783
784 /* For a REG, 1 means the register is used only in an exit test of a loop.  */
785 #define REG_LOOP_TEST_P(RTX) ((RTX)->in_struct)
786
787 /* During sched, for an insn, 1 means that the insn must be scheduled together
788    with the preceding insn.  */
789 #define SCHED_GROUP_P(INSN) ((INSN)->in_struct)
790
791 /* During sched, for the LOG_LINKS of an insn, these cache the adjusted
792    cost of the dependence link.  The cost of executing an instruction
793    may vary based on how the results are used.  LINK_COST_ZERO is 1 when
794    the cost through the link varies and is unchanged (i.e., the link has
795    zero additional cost).  LINK_COST_FREE is 1 when the cost through the
796    link is zero (i.e., the link makes the cost free).  In other cases,
797    the adjustment to the cost is recomputed each time it is needed.  */
798 #define LINK_COST_ZERO(X) ((X)->jump)
799 #define LINK_COST_FREE(X) ((X)->call)
800
801 /* For a SET rtx, SET_DEST is the place that is set
802    and SET_SRC is the value it is set to.  */
803 #define SET_DEST(RTX) XC2EXP(RTX, 0, SET, CLOBBER)
804 #define SET_SRC(RTX) XCEXP(RTX, 1, SET)
805
806 /* For a TRAP_IF rtx, TRAP_CONDITION is an expression.  */
807 #define TRAP_CONDITION(RTX) XCEXP(RTX, 0, TRAP_IF)
808 #define TRAP_CODE(RTX) XCEXP(RTX, 1, TRAP_IF)
809
810 /* 1 in a SYMBOL_REF if it addresses this function's constants pool.  */
811 #define CONSTANT_POOL_ADDRESS_P(RTX) ((RTX)->unchanging)
812
813 /* Flag in a SYMBOL_REF for machine-specific purposes.  */
814 #define SYMBOL_REF_FLAG(RTX) ((RTX)->volatil)
815
816 /* 1 in a SYMBOL_REF if it represents a symbol which might have to change
817    if its inlined or unrolled. */
818 #define SYMBOL_REF_NEED_ADJUST(RTX)  ((RTX)->in_struct)
819
820 /* 1 means a SYMBOL_REF has been the library function in emit_library_call.  */
821 #define SYMBOL_REF_USED(RTX) ((RTX)->used)
822
823 /* Define a macro to look for REG_INC notes,
824    but save time on machines where they never exist.  */
825
826 /* Don't continue this line--convex cc version 4.1 would lose.  */
827 #if (defined (HAVE_PRE_INCREMENT) || defined (HAVE_PRE_DECREMENT) || defined (HAVE_POST_INCREMENT) || defined (HAVE_POST_DECREMENT))
828 #define FIND_REG_INC_NOTE(insn, reg) (find_reg_note ((insn), REG_INC, (reg)))
829 #else
830 #define FIND_REG_INC_NOTE(insn, reg) 0
831 #endif
832
833 /* Indicate whether the machine has any sort of auto increment addressing.
834    If not, we can avoid checking for REG_INC notes.  */
835
836 /* Don't continue this line--convex cc version 4.1 would lose.  */
837 #if (defined (HAVE_PRE_INCREMENT) || defined (HAVE_PRE_DECREMENT) || defined (HAVE_POST_INCREMENT) || defined (HAVE_POST_DECREMENT))
838 #define AUTO_INC_DEC
839 #endif
840
841 #ifndef HAVE_PRE_INCREMENT
842 #define HAVE_PRE_INCREMENT 0
843 #endif
844
845 #ifndef HAVE_PRE_DECREMENT
846 #define HAVE_PRE_DECREMENT 0
847 #endif
848
849 #ifndef HAVE_POST_INCREMENT
850 #define HAVE_POST_INCREMENT 0
851 #endif
852
853 #ifndef HAVE_POST_DECREMENT
854 #define HAVE_POST_DECREMENT 0
855 #endif
856
857
858 /* Some architectures do not have complete pre/post increment/decrement
859    instruction sets, or only move some modes efficiently.  These macros
860    allow us to tune autoincrement generation.  */
861
862 #ifndef USE_LOAD_POST_INCREMENT
863 #define USE_LOAD_POST_INCREMENT(MODE)   HAVE_POST_INCREMENT
864 #endif
865
866 #ifndef USE_LOAD_POST_DECREMENT
867 #define USE_LOAD_POST_DECREMENT(MODE)   HAVE_POST_DECREMENT
868 #endif
869
870 #ifndef USE_LOAD_PRE_INCREMENT
871 #define USE_LOAD_PRE_INCREMENT(MODE)    HAVE_PRE_INCREMENT
872 #endif
873
874 #ifndef USE_LOAD_PRE_DECREMENT
875 #define USE_LOAD_PRE_DECREMENT(MODE)    HAVE_PRE_DECREMENT
876 #endif
877
878 #ifndef USE_STORE_POST_INCREMENT
879 #define USE_STORE_POST_INCREMENT(MODE)  HAVE_POST_INCREMENT
880 #endif
881
882 #ifndef USE_STORE_POST_DECREMENT
883 #define USE_STORE_POST_DECREMENT(MODE)  HAVE_POST_DECREMENT
884 #endif
885
886 #ifndef USE_STORE_PRE_INCREMENT
887 #define USE_STORE_PRE_INCREMENT(MODE)   HAVE_PRE_INCREMENT
888 #endif
889
890 #ifndef USE_STORE_PRE_DECREMENT
891 #define USE_STORE_PRE_DECREMENT(MODE)   HAVE_PRE_DECREMENT
892 #endif
893
894
895 /* Accessors for RANGE_INFO.  */
896 /* For RANGE_{START,END} notes return the RANGE_START note.  */
897 #define RANGE_INFO_NOTE_START(INSN) XCEXP (INSN, 0, RANGE_INFO)
898
899 /* For RANGE_{START,END} notes return the RANGE_START note.  */
900 #define RANGE_INFO_NOTE_END(INSN) XCEXP (INSN, 1, RANGE_INFO)
901
902 /* For RANGE_{START,END} notes, return the vector containing the registers used
903    in the range.  */
904 #define RANGE_INFO_REGS(INSN) XCVEC (INSN, 2, RANGE_INFO)
905 #define RANGE_INFO_REGS_REG(INSN, N) XCVECEXP (INSN, 2, N, RANGE_INFO)
906 #define RANGE_INFO_NUM_REGS(INSN) XCVECLEN (INSN, 2, RANGE_INFO)
907
908 /* For RANGE_{START,END} notes, the number of calls within the range.  */
909 #define RANGE_INFO_NCALLS(INSN) XCINT (INSN, 3, RANGE_INFO)
910
911 /* For RANGE_{START,END} notes, the number of insns within the range.  */
912 #define RANGE_INFO_NINSNS(INSN) XCINT (INSN, 4, RANGE_INFO)
913
914 /* For RANGE_{START,END} notes, a unique # to identify this range.  */
915 #define RANGE_INFO_UNIQUE(INSN) XCINT (INSN, 5, RANGE_INFO)
916
917 /* For RANGE_{START,END} notes, the basic block # the range starts with. */
918 #define RANGE_INFO_BB_START(INSN) XCINT (INSN, 6, RANGE_INFO)
919
920 /* For RANGE_{START,END} notes, the basic block # the range ends with. */
921 #define RANGE_INFO_BB_END(INSN) XCINT (INSN, 7, RANGE_INFO)
922
923 /* For RANGE_{START,END} notes, the loop depth the range is in.  */
924 #define RANGE_INFO_LOOP_DEPTH(INSN) XCINT (INSN, 8, RANGE_INFO)
925
926 /* For RANGE_{START,END} notes, the bitmap of live registers at the start
927    of the range.  */
928 #define RANGE_INFO_LIVE_START(INSN) XCBITMAP (INSN, 9, RANGE_INFO)
929
930 /* For RANGE_{START,END} notes, the bitmap of live registers at the end
931    of the range.  */
932 #define RANGE_INFO_LIVE_END(INSN) XCBITMAP (INSN, 10, RANGE_INFO)
933
934 /* For RANGE_START notes, the marker # of the start of the range.  */
935 #define RANGE_INFO_MARKER_START(INSN) XCINT (INSN, 11, RANGE_INFO)
936
937 /* For RANGE_START notes, the marker # of the end of the range.  */
938 #define RANGE_INFO_MARKER_END(INSN) XCINT (INSN, 12, RANGE_INFO)
939
940 /* Original pseudo register # for a live range note.  */
941 #define RANGE_REG_PSEUDO(INSN,N) XCINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 0, REG)
942
943 /* Pseudo register # original register is copied into or -1.  */
944 #define RANGE_REG_COPY(INSN,N) XCINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 1, REG)
945
946 /* How many times a register in a live range note was referenced.  */
947 #define RANGE_REG_REFS(INSN,N) XINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 2)
948
949 /* How many times a register in a live range note was set.  */
950 #define RANGE_REG_SETS(INSN,N) XINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 3)
951
952 /* How many times a register in a live range note died.  */
953 #define RANGE_REG_DEATHS(INSN,N) XINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 4)
954
955 /* Whether the original value is needed to be copied into the range register at
956    the start of the range. */
957 #define RANGE_REG_COPY_FLAGS(INSN,N) XINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 5)
958
959 /* # of insns the register copy is live over.  */
960 #define RANGE_REG_LIVE_LENGTH(INSN,N) XINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 6)
961
962 /* # of calls the register copy is live over.  */
963 #define RANGE_REG_N_CALLS(INSN,N) XINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 7)
964
965 /* DECL_NODE pointer of the declaration if the register is a user defined
966    variable.  */
967 #define RANGE_REG_SYMBOL_NODE(INSN,N) XTREE (XCVECEXP (INSN, 2, N, RANGE_INFO), 8)
968
969 /* BLOCK_NODE pointer to the block the variable is declared in if the
970    register is a user defined variable.  */
971 #define RANGE_REG_BLOCK_NODE(INSN,N) XTREE (XCVECEXP (INSN, 2, N, RANGE_INFO), 9)
972
973 /* EXPR_LIST of the distinct ranges a variable is in.  */
974 #define RANGE_VAR_LIST(INSN) (XEXP (INSN, 0))
975
976 /* Block a variable is declared in.  */
977 #define RANGE_VAR_BLOCK(INSN) (XTREE (INSN, 1))
978
979 /* # of distinct ranges a variable is in.  */
980 #define RANGE_VAR_NUM(INSN) (XINT (INSN, 2))
981
982 /* For a NOTE_INSN_LIVE note, the registers which are currently live.  */
983 #define RANGE_LIVE_BITMAP(INSN) (XBITMAP (INSN, 0))
984
985 /* For a NOTE_INSN_LIVE note, the original basic block number.  */
986 #define RANGE_LIVE_ORIG_BLOCK(INSN) (XINT (INSN, 1))
987
988 /* Determine if the insn is a PHI node.  */
989 #define PHI_NODE_P(X)                           \
990   (X && GET_CODE (X) == INSN                    \
991    && GET_CODE (PATTERN (X)) == SET             \
992    && GET_CODE (SET_SRC (PATTERN (X))) == PHI)
993 \f
994 /* Nonzero if we need to distinguish between the return value of this function
995    and the return value of a function called by this function.  This helps
996    integrate.c.
997    This is 1 until after the rtl generation pass.  */
998 extern int rtx_equal_function_value_matters;
999
1000 /* Generally useful functions.  */
1001
1002 /* The following functions accept a wide integer argument.  Rather than
1003    having to cast on every function call, we use a macro instead, that is
1004    defined here and in tree.h.  */
1005
1006 #ifndef exact_log2
1007 #define exact_log2(N) exact_log2_wide ((unsigned HOST_WIDE_INT) (N))
1008 #define floor_log2(N) floor_log2_wide ((unsigned HOST_WIDE_INT) (N))
1009 #endif
1010 extern int exact_log2_wide              PARAMS ((unsigned HOST_WIDE_INT));
1011 extern int floor_log2_wide              PARAMS ((unsigned HOST_WIDE_INT));
1012
1013 /* In expmed.c */
1014 extern int ceil_log2                    PARAMS ((unsigned HOST_WIDE_INT));
1015
1016 #define plus_constant(X,C) plus_constant_wide (X, (HOST_WIDE_INT) (C))
1017
1018 #define plus_constant_for_output(X,C)  \
1019   plus_constant_for_output_wide (X, (HOST_WIDE_INT) (C))
1020
1021 /* In explow.c */
1022 extern void set_stack_check_libfunc PARAMS ((rtx));
1023 extern HOST_WIDE_INT trunc_int_for_mode PARAMS ((HOST_WIDE_INT,
1024                                                enum machine_mode));
1025 extern rtx plus_constant_wide            PARAMS ((rtx, HOST_WIDE_INT));
1026 extern rtx plus_constant_for_output_wide PARAMS ((rtx, HOST_WIDE_INT));
1027 extern void optimize_save_area_alloca   PARAMS ((rtx));
1028
1029 extern rtx gen_rtx                      PARAMS ((enum rtx_code,
1030                                                  enum machine_mode, ...));
1031 extern rtvec gen_rtvec                  PARAMS ((int, ...));
1032
1033 extern char *oballoc                    PARAMS ((int));
1034 extern char *permalloc                  PARAMS ((int));
1035 extern rtx rtx_alloc                    PARAMS ((RTX_CODE));
1036 extern rtvec rtvec_alloc                PARAMS ((int));
1037 extern rtx copy_insn_1                  PARAMS ((rtx));
1038 extern rtx copy_insn                    PARAMS ((rtx));
1039 extern rtx copy_rtx                     PARAMS ((rtx));
1040 extern rtx copy_rtx_if_shared           PARAMS ((rtx));
1041 extern rtx copy_most_rtx                PARAMS ((rtx, rtx));
1042 extern rtx shallow_copy_rtx             PARAMS ((rtx));
1043 extern int rtx_equal_p                  PARAMS ((rtx, rtx));
1044 extern rtvec gen_rtvec_v                PARAMS ((int, rtx *));
1045 extern rtx gen_reg_rtx                  PARAMS ((enum machine_mode));
1046 extern rtx gen_label_rtx                PARAMS ((void));
1047 extern rtx gen_lowpart_common           PARAMS ((enum machine_mode, rtx));
1048 extern rtx gen_lowpart                  PARAMS ((enum machine_mode, rtx));
1049 extern rtx gen_lowpart_if_possible      PARAMS ((enum machine_mode, rtx));
1050 extern rtx gen_highpart                 PARAMS ((enum machine_mode, rtx));
1051 extern rtx gen_realpart                 PARAMS ((enum machine_mode, rtx));
1052 extern rtx gen_imagpart                 PARAMS ((enum machine_mode, rtx));
1053 extern rtx operand_subword              PARAMS ((rtx, unsigned int, int,
1054                                                  enum machine_mode));
1055 extern rtx operand_subword_force        PARAMS ((rtx, unsigned int,
1056                                                  enum machine_mode));
1057 extern int subreg_lowpart_p             PARAMS ((rtx));
1058 extern rtx make_safe_from               PARAMS ((rtx, rtx));
1059 extern rtx convert_memory_address       PARAMS ((enum machine_mode, rtx));
1060 extern rtx memory_address               PARAMS ((enum machine_mode, rtx));
1061 extern rtx get_insns                    PARAMS ((void));
1062 extern const char *get_insn_name        PARAMS ((int));
1063 extern rtx get_last_insn                PARAMS ((void));
1064 extern rtx get_last_insn_anywhere       PARAMS ((void));
1065 extern void start_sequence              PARAMS ((void));
1066 extern void push_to_sequence            PARAMS ((rtx));
1067 extern void end_sequence                PARAMS ((void));
1068 extern void push_to_full_sequence       PARAMS ((rtx, rtx));
1069 extern void end_full_sequence           PARAMS ((rtx*, rtx*));
1070 extern rtx gen_sequence                 PARAMS ((void));
1071 extern rtx immed_double_const           PARAMS ((HOST_WIDE_INT, HOST_WIDE_INT, enum machine_mode));
1072 extern rtx force_const_mem              PARAMS ((enum machine_mode, rtx));
1073 extern rtx force_reg                    PARAMS ((enum machine_mode, rtx));
1074 extern rtx get_pool_constant            PARAMS ((rtx));
1075 extern enum machine_mode get_pool_mode  PARAMS ((rtx));
1076 extern rtx get_pool_constant_for_function       PARAMS ((struct function *, rtx));
1077 extern enum machine_mode get_pool_mode_for_function     PARAMS ((struct function *, rtx));
1078 extern int get_pool_offset              PARAMS ((rtx));
1079 extern rtx simplify_subtraction         PARAMS ((rtx));
1080 extern rtx assign_stack_local           PARAMS ((enum machine_mode,
1081                                                HOST_WIDE_INT, int));
1082 extern rtx assign_stack_temp            PARAMS ((enum machine_mode,
1083                                                HOST_WIDE_INT, int));
1084 extern rtx assign_temp                  PARAMS ((union tree_node *,
1085                                                int, int, int));
1086 extern rtx protect_from_queue           PARAMS ((rtx, int));
1087 extern void emit_queue                  PARAMS ((void));
1088 extern rtx emit_move_insn               PARAMS ((rtx, rtx));
1089 extern rtx emit_insn_before             PARAMS ((rtx, rtx));
1090 extern rtx emit_jump_insn_before        PARAMS ((rtx, rtx));
1091 extern rtx emit_call_insn_before        PARAMS ((rtx, rtx));
1092 extern rtx emit_barrier_before          PARAMS ((rtx));
1093 extern rtx emit_label_before            PARAMS ((rtx, rtx));
1094 extern rtx emit_note_before             PARAMS ((int, rtx));
1095 extern rtx emit_insn_after              PARAMS ((rtx, rtx));
1096 extern rtx emit_jump_insn_after         PARAMS ((rtx, rtx));
1097 extern rtx emit_barrier_after           PARAMS ((rtx));
1098 extern rtx emit_label_after             PARAMS ((rtx, rtx));
1099 extern rtx emit_note_after              PARAMS ((int, rtx));
1100 extern rtx emit_line_note_after         PARAMS ((const char *, int, rtx));
1101 extern rtx emit_insn                    PARAMS ((rtx));
1102 extern rtx emit_insns                   PARAMS ((rtx));
1103 extern rtx emit_insns_before            PARAMS ((rtx, rtx));
1104 extern rtx emit_insns_after             PARAMS ((rtx, rtx));
1105 extern rtx emit_jump_insn               PARAMS ((rtx));
1106 extern rtx emit_call_insn               PARAMS ((rtx));
1107 extern rtx emit_label                   PARAMS ((rtx));
1108 extern rtx emit_barrier                 PARAMS ((void));
1109 extern rtx emit_line_note               PARAMS ((const char *, int));
1110 extern rtx emit_note                    PARAMS ((const char *, int));
1111 extern rtx emit_line_note_force         PARAMS ((const char *, int));
1112 extern rtx make_insn_raw                PARAMS ((rtx));
1113 extern rtx previous_insn                PARAMS ((rtx));
1114 extern rtx next_insn                    PARAMS ((rtx));
1115 extern rtx prev_nonnote_insn            PARAMS ((rtx));
1116 extern rtx next_nonnote_insn            PARAMS ((rtx));
1117 extern rtx prev_real_insn               PARAMS ((rtx));
1118 extern rtx next_real_insn               PARAMS ((rtx));
1119 extern rtx prev_active_insn             PARAMS ((rtx));
1120 extern rtx next_active_insn             PARAMS ((rtx));
1121 extern int active_insn_p                PARAMS ((rtx));
1122 extern rtx prev_label                   PARAMS ((rtx));
1123 extern rtx next_label                   PARAMS ((rtx));
1124 extern rtx next_cc0_user                PARAMS ((rtx));
1125 extern rtx prev_cc0_setter              PARAMS ((rtx));
1126 extern rtx next_nondeleted_insn         PARAMS ((rtx));
1127 extern enum rtx_code reverse_condition  PARAMS ((enum rtx_code));
1128 extern enum rtx_code reverse_condition_maybe_unordered PARAMS ((enum rtx_code));
1129 extern enum rtx_code swap_condition     PARAMS ((enum rtx_code));
1130 extern enum rtx_code unsigned_condition PARAMS ((enum rtx_code));
1131 extern enum rtx_code signed_condition   PARAMS ((enum rtx_code));
1132 extern rtx find_equiv_reg               PARAMS ((rtx, rtx, enum reg_class, int, short *, int, enum machine_mode));
1133 extern rtx squeeze_notes                PARAMS ((rtx, rtx));
1134 extern rtx delete_insn                  PARAMS ((rtx));
1135 extern void delete_jump                 PARAMS ((rtx));
1136 extern void delete_barrier              PARAMS ((rtx));
1137 extern rtx get_label_before             PARAMS ((rtx));
1138 extern rtx get_label_after              PARAMS ((rtx));
1139 extern rtx follow_jumps                 PARAMS ((rtx));
1140 extern rtx adj_offsettable_operand      PARAMS ((rtx, int));
1141 extern rtx try_split                    PARAMS ((rtx, rtx, int));
1142 extern rtx split_insns                  PARAMS ((rtx, rtx));
1143 extern rtx simplify_unary_operation     PARAMS ((enum rtx_code, enum machine_mode, rtx, enum machine_mode));
1144 extern rtx simplify_binary_operation    PARAMS ((enum rtx_code, enum machine_mode, rtx, rtx));
1145 extern rtx simplify_ternary_operation   PARAMS ((enum rtx_code, enum machine_mode, enum machine_mode, rtx, rtx, rtx));
1146 extern rtx simplify_relational_operation PARAMS ((enum rtx_code, enum machine_mode, rtx, rtx));
1147 extern rtx simplify_gen_binary          PARAMS ((enum rtx_code, enum machine_mode,
1148                                                rtx, rtx));
1149 extern rtx simplify_rtx                 PARAMS ((rtx));
1150 extern rtx gen_move_insn                PARAMS ((rtx, rtx));
1151 extern rtx gen_jump                     PARAMS ((rtx));
1152 extern rtx gen_beq                      PARAMS ((rtx));
1153 extern rtx gen_bge                      PARAMS ((rtx));
1154 extern rtx gen_ble                      PARAMS ((rtx));
1155 extern rtx gen_mem_addressof            PARAMS ((rtx, union tree_node *));
1156 extern rtx eliminate_constant_term      PARAMS ((rtx, rtx *));
1157 extern rtx expand_complex_abs           PARAMS ((enum machine_mode, rtx, rtx,
1158                                                  int));
1159 extern enum machine_mode choose_hard_reg_mode PARAMS ((unsigned int,
1160                                                        unsigned int));
1161 extern void set_unique_reg_note         PARAMS ((rtx, enum reg_note, rtx));
1162
1163 /* Functions in rtlanal.c */
1164
1165 extern int rtx_unstable_p               PARAMS ((rtx));
1166 extern int rtx_varies_p                 PARAMS ((rtx));
1167 extern int rtx_addr_varies_p            PARAMS ((rtx));
1168 extern HOST_WIDE_INT get_integer_term   PARAMS ((rtx));
1169 extern rtx get_related_value            PARAMS ((rtx));
1170 extern int reg_mentioned_p              PARAMS ((rtx, rtx));
1171 extern int reg_referenced_p             PARAMS ((rtx, rtx));
1172 extern int reg_used_between_p           PARAMS ((rtx, rtx, rtx));
1173 extern int reg_referenced_between_p     PARAMS ((rtx, rtx, rtx));
1174 extern int reg_set_between_p            PARAMS ((rtx, rtx, rtx));
1175 extern int regs_set_between_p           PARAMS ((rtx, rtx, rtx));
1176 extern int modified_between_p           PARAMS ((rtx, rtx, rtx));
1177 extern int no_labels_between_p          PARAMS ((rtx, rtx));
1178 extern int no_jumps_between_p           PARAMS ((rtx, rtx));
1179 extern int modified_in_p                PARAMS ((rtx, rtx));
1180 extern int reg_set_p                    PARAMS ((rtx, rtx));
1181 extern rtx single_set                   PARAMS ((rtx));
1182 extern int multiple_sets                PARAMS ((rtx));
1183 extern rtx find_last_value              PARAMS ((rtx, rtx *, rtx, int));
1184 extern int refers_to_regno_p            PARAMS ((unsigned int, unsigned int,
1185                                                  rtx, rtx *));
1186 extern int reg_overlap_mentioned_p      PARAMS ((rtx, rtx));
1187 extern void note_stores                 PARAMS ((rtx,
1188                                                  void (*) (rtx, rtx, void *),
1189                                                  void *));
1190 extern rtx reg_set_last                 PARAMS ((rtx, rtx));
1191 extern int dead_or_set_p                PARAMS ((rtx, rtx));
1192 extern int dead_or_set_regno_p          PARAMS ((rtx, unsigned int));
1193 extern rtx find_reg_note                PARAMS ((rtx, enum reg_note, rtx));
1194 extern rtx find_regno_note              PARAMS ((rtx, enum reg_note,
1195                                                  unsigned int));
1196 extern int find_reg_fusage              PARAMS ((rtx, enum rtx_code, rtx));
1197 extern int find_regno_fusage            PARAMS ((rtx, enum rtx_code,
1198                                                  unsigned int));
1199 extern void remove_note                 PARAMS ((rtx, rtx));
1200 extern int side_effects_p               PARAMS ((rtx));
1201 extern int volatile_refs_p              PARAMS ((rtx));
1202 extern int volatile_insn_p              PARAMS ((rtx));
1203 extern int may_trap_p                   PARAMS ((rtx));
1204 extern int inequality_comparisons_p     PARAMS ((rtx));
1205 extern rtx replace_rtx                  PARAMS ((rtx, rtx, rtx));
1206 extern rtx replace_regs                 PARAMS ((rtx, rtx *, unsigned int,
1207                                                  int));
1208 extern int computed_jump_p              PARAMS ((rtx));
1209 typedef int (*rtx_function)             PARAMS ((rtx *, void *));
1210 extern int for_each_rtx                 PARAMS ((rtx *, rtx_function, void *));
1211 extern rtx regno_use_in                 PARAMS ((unsigned int, rtx));
1212 extern int auto_inc_p                   PARAMS ((rtx));
1213 extern void remove_node_from_expr_list  PARAMS ((rtx, rtx *));
1214 extern int insns_safe_to_move_p         PARAMS ((rtx, rtx, rtx *));
1215
1216 /* flow.c */
1217
1218 extern rtx find_use_as_address          PARAMS ((rtx, rtx, HOST_WIDE_INT));
1219 void init_EXPR_INSN_LIST_cache          PARAMS ((void));
1220 void free_EXPR_LIST_list                PARAMS ((rtx *));
1221 void free_INSN_LIST_list                PARAMS ((rtx *));
1222 void free_EXPR_LIST_node                PARAMS ((rtx));
1223 void free_INSN_LIST_node                PARAMS ((rtx));
1224 rtx alloc_INSN_LIST                     PARAMS ((rtx, rtx));
1225 rtx alloc_EXPR_LIST                     PARAMS ((int, rtx, rtx));
1226 void clear_log_links                    PARAMS ((rtx));
1227
1228 /* regclass.c */
1229
1230 /* Maximum number of parallel sets and clobbers in any insn in this fn.
1231    Always at least 3, since the combiner could put that many togetherm
1232    and we want this to remain correct for all the remaining passes.  */
1233
1234 extern int max_parallel;
1235
1236 /* Free up register info memory.  */
1237 extern void free_reg_info               PARAMS ((void));
1238
1239 /* recog.c */
1240 extern int asm_noperands                PARAMS ((rtx));
1241 extern const char *decode_asm_operands  PARAMS ((rtx, rtx *, rtx **,
1242                                                const char **,
1243                                                enum machine_mode *));
1244
1245 extern enum reg_class reg_preferred_class PARAMS ((int));
1246 extern enum reg_class reg_alternate_class PARAMS ((int));
1247
1248 extern rtx get_first_nonparm_insn       PARAMS ((void));
1249
1250 extern void split_all_insns             PARAMS ((int));
1251
1252 #define MAX_SAVED_CONST_INT 64
1253 extern rtx const_int_rtx[MAX_SAVED_CONST_INT * 2 + 1];
1254
1255 #define const0_rtx      (const_int_rtx[MAX_SAVED_CONST_INT])
1256 #define const1_rtx      (const_int_rtx[MAX_SAVED_CONST_INT+1])
1257 #define const2_rtx      (const_int_rtx[MAX_SAVED_CONST_INT+2])
1258 #define constm1_rtx     (const_int_rtx[MAX_SAVED_CONST_INT-1])
1259 extern rtx const_true_rtx;
1260
1261 extern rtx const_tiny_rtx[3][(int) MAX_MACHINE_MODE];
1262
1263 /* Returns a constant 0 rtx in mode MODE.  Integer modes are treated the
1264    same as VOIDmode.  */
1265
1266 #define CONST0_RTX(MODE) (const_tiny_rtx[0][(int) (MODE)])
1267
1268 /* Likewise, for the constants 1 and 2.  */
1269
1270 #define CONST1_RTX(MODE) (const_tiny_rtx[1][(int) (MODE)])
1271 #define CONST2_RTX(MODE) (const_tiny_rtx[2][(int) (MODE)])
1272
1273 /* If HARD_FRAME_POINTER_REGNUM is defined, then a special dummy reg
1274    is used to represent the frame pointer.  This is because the
1275    hard frame pointer and the automatic variables are separated by an amount
1276    that cannot be determined until after register allocation.  We can assume
1277    that in this case ELIMINABLE_REGS will be defined, one action of which
1278    will be to eliminate FRAME_POINTER_REGNUM into HARD_FRAME_POINTER_REGNUM. */
1279 #ifndef HARD_FRAME_POINTER_REGNUM
1280 #define HARD_FRAME_POINTER_REGNUM FRAME_POINTER_REGNUM
1281 #endif
1282
1283 /* Index labels for global_rtl.  */
1284 enum global_rtl_index
1285 {
1286   GR_PC,
1287   GR_CC0,
1288   GR_STACK_POINTER,
1289   GR_FRAME_POINTER,
1290 /* For register elimination to work properly these hard_frame_pointer_rtx,
1291    frame_pointer_rtx, and arg_pointer_rtx must be the same if they refer to
1292    the same register.  */
1293 #if FRAME_POINTER_REGNUM == ARG_POINTER_REGNUM
1294   GR_ARG_POINTER = GR_FRAME_POINTER,
1295 #endif
1296 #if HARD_FRAME_POINTER_REGNUM == FRAME_POINTER_REGNUM
1297   GR_HARD_FRAME_POINTER = GR_FRAME_POINTER,
1298 #else
1299   GR_HARD_FRAME_POINTER,
1300 #endif
1301 #if FRAME_POINTER_REGNUM != ARG_POINTER_REGNUM
1302 #if HARD_FRAME_POINTER_REGNUM == ARG_POINTER_REGNUM
1303   GR_ARG_POINTER = GR_HARD_FRAME_POINTER,
1304 #else
1305   GR_ARG_POINTER,
1306 #endif
1307 #endif
1308   GR_VIRTUAL_INCOMING_ARGS,
1309   GR_VIRTUAL_STACK_ARGS,
1310   GR_VIRTUAL_STACK_DYNAMIC,
1311   GR_VIRTUAL_OUTGOING_ARGS,
1312   GR_VIRTUAL_CFA,
1313
1314   GR_MAX
1315 };
1316
1317 /* Pointers to standard pieces of rtx are stored here.  */
1318 extern rtx global_rtl[GR_MAX];
1319
1320 /* Standard pieces of rtx, to be substituted directly into things.  */
1321 #define pc_rtx                  (global_rtl[GR_PC])
1322 #define cc0_rtx                 (global_rtl[GR_CC0])
1323
1324 /* All references to certain hard regs, except those created
1325    by allocating pseudo regs into them (when that's possible),
1326    go through these unique rtx objects.  */
1327 #define stack_pointer_rtx       (global_rtl[GR_STACK_POINTER])
1328 #define frame_pointer_rtx       (global_rtl[GR_FRAME_POINTER])
1329 #define hard_frame_pointer_rtx  (global_rtl[GR_HARD_FRAME_POINTER])
1330 #define arg_pointer_rtx         (global_rtl[GR_ARG_POINTER])
1331
1332 extern rtx pic_offset_table_rtx;
1333 extern rtx struct_value_rtx;
1334 extern rtx struct_value_incoming_rtx;
1335 extern rtx static_chain_rtx;
1336 extern rtx static_chain_incoming_rtx;
1337 extern rtx return_address_pointer_rtx;
1338
1339 /* Include the RTL generation functions.  */
1340
1341 #ifndef NO_GENRTL_H
1342 #include "genrtl.h"
1343 #endif
1344
1345 /* There are some RTL codes that require special attention; the
1346    generation functions included above do the raw handling.  If you
1347    add to this list, modify special_rtx in gengenrtl.c as well.  You
1348    should also modify gen_rtx to use the special function.  */
1349
1350 extern rtx gen_rtx_CONST_DOUBLE PARAMS ((enum machine_mode, rtx,
1351                                        HOST_WIDE_INT, HOST_WIDE_INT));
1352 extern rtx gen_rtx_CONST_INT PARAMS ((enum machine_mode, HOST_WIDE_INT));
1353 extern rtx gen_rtx_REG PARAMS ((enum machine_mode, int));
1354 extern rtx gen_rtx_MEM PARAMS ((enum machine_mode, rtx));
1355
1356 /* We need the cast here to ensure that we get the same result both with
1357    and without prototypes.  */
1358 #define GEN_INT(N)  gen_rtx_CONST_INT (VOIDmode, (HOST_WIDE_INT) (N))
1359
1360 /* Virtual registers are used during RTL generation to refer to locations into
1361    the stack frame when the actual location isn't known until RTL generation
1362    is complete.  The routine instantiate_virtual_regs replaces these with
1363    the proper value, which is normally {frame,arg,stack}_pointer_rtx plus
1364    a constant.  */
1365
1366 #define FIRST_VIRTUAL_REGISTER  (FIRST_PSEUDO_REGISTER)
1367
1368 /* This points to the first word of the incoming arguments passed on the stack,
1369    either by the caller or by the callee when pretending it was passed by the
1370    caller.  */
1371
1372 #define virtual_incoming_args_rtx       (global_rtl[GR_VIRTUAL_INCOMING_ARGS])
1373
1374 #define VIRTUAL_INCOMING_ARGS_REGNUM    (FIRST_VIRTUAL_REGISTER)
1375
1376 /* If FRAME_GROWS_DOWNWARD, this points to immediately above the first
1377    variable on the stack.  Otherwise, it points to the first variable on
1378    the stack.  */
1379
1380 #define virtual_stack_vars_rtx          (global_rtl[GR_VIRTUAL_STACK_ARGS])
1381
1382 #define VIRTUAL_STACK_VARS_REGNUM       ((FIRST_VIRTUAL_REGISTER) + 1)
1383
1384 /* This points to the location of dynamically-allocated memory on the stack
1385    immediately after the stack pointer has been adjusted by the amount
1386    desired.  */
1387
1388 #define virtual_stack_dynamic_rtx       (global_rtl[GR_VIRTUAL_STACK_DYNAMIC])
1389
1390 #define VIRTUAL_STACK_DYNAMIC_REGNUM    ((FIRST_VIRTUAL_REGISTER) + 2)
1391
1392 /* This points to the location in the stack at which outgoing arguments should
1393    be written when the stack is pre-pushed (arguments pushed using push
1394    insns always use sp).  */
1395
1396 #define virtual_outgoing_args_rtx       (global_rtl[GR_VIRTUAL_OUTGOING_ARGS])
1397
1398 #define VIRTUAL_OUTGOING_ARGS_REGNUM    ((FIRST_VIRTUAL_REGISTER) + 3)
1399
1400 /* This points to the Canonical Frame Address of the function.  This
1401    should corrospond to the CFA produced by INCOMING_FRAME_SP_OFFSET,
1402    but is calculated relative to the arg pointer for simplicity; the
1403    frame pointer nor stack pointer are necessarily fixed relative to
1404    the CFA until after reload.  */
1405
1406 #define virtual_cfa_rtx                 (global_rtl[GR_VIRTUAL_CFA])
1407
1408 #define VIRTUAL_CFA_REGNUM              ((FIRST_VIRTUAL_REGISTER) + 4)
1409
1410 #define LAST_VIRTUAL_REGISTER           ((FIRST_VIRTUAL_REGISTER) + 4)
1411
1412 extern rtx find_next_ref                PARAMS ((rtx, rtx));
1413 extern rtx *find_single_use             PARAMS ((rtx, rtx, rtx *));
1414
1415 extern rtx output_constant_def          PARAMS ((union tree_node *));
1416 extern rtx immed_real_const             PARAMS ((union tree_node *));
1417 extern union tree_node *make_tree       PARAMS ((union tree_node *, rtx));
1418
1419 /* Define a default value for STORE_FLAG_VALUE.  */
1420
1421 #ifndef STORE_FLAG_VALUE
1422 #define STORE_FLAG_VALUE 1
1423 #endif
1424
1425 /* Nonzero after the second flow pass has completed.
1426    Set to 1 or 0 by toplev.c  */
1427 extern int flow2_completed;
1428
1429 /* Nonzero after end of reload pass.
1430    Set to 1 or 0 by reload1.c.  */
1431
1432 extern int reload_completed;
1433
1434 /* Set to 1 while reload_as_needed is operating.
1435    Required by some machines to handle any generated moves differently.  */
1436
1437 extern int reload_in_progress;
1438
1439 /* If this is nonzero, we do not bother generating VOLATILE
1440    around volatile memory references, and we are willing to
1441    output indirect addresses.  If cse is to follow, we reject
1442    indirect addresses so a useful potential cse is generated;
1443    if it is used only once, instruction combination will produce
1444    the same indirect address eventually.  */
1445 extern int cse_not_expected;
1446
1447 /* Set to nonzero before life analysis to indicate that it is unsafe to
1448    generate any new pseudo registers.  */
1449 extern int no_new_pseudos;
1450
1451 /* Translates rtx code to tree code, for those codes needed by
1452    REAL_ARITHMETIC.  The function returns an int because the caller may not
1453    know what `enum tree_code' means.  */
1454
1455 extern int rtx_to_tree_code     PARAMS ((enum rtx_code));
1456
1457 /* In tree.c */
1458 extern void obfree                      PARAMS ((char *));
1459 struct obstack;
1460 extern void gcc_obstack_init            PARAMS ((struct obstack *));
1461 extern void pop_obstacks                PARAMS ((void));
1462 extern void push_obstacks               PARAMS ((struct obstack *,
1463                                                 struct obstack *));
1464 /* In cse.c */
1465 struct cse_basic_block_data;
1466 extern int rtx_cost                     PARAMS ((rtx, enum rtx_code));
1467 extern void delete_trivially_dead_insns PARAMS ((rtx, int));
1468 #ifdef BUFSIZ
1469 extern int cse_main                     PARAMS ((rtx, int, int, FILE *));
1470 #endif
1471 extern void cse_end_of_basic_block      PARAMS ((rtx,
1472                                                 struct cse_basic_block_data *,
1473                                                 int, int, int));
1474
1475 /* In jump.c */
1476 extern int comparison_dominates_p       PARAMS ((enum rtx_code, enum rtx_code));
1477 extern int condjump_p                   PARAMS ((rtx));
1478 extern rtx condjump_label               PARAMS ((rtx));
1479 extern int simplejump_p                 PARAMS ((rtx));
1480 extern int returnjump_p                 PARAMS ((rtx));
1481 extern int onlyjump_p                   PARAMS ((rtx));
1482 extern int sets_cc0_p                   PARAMS ((rtx));
1483 extern int invert_jump                  PARAMS ((rtx, rtx));
1484 extern int rtx_renumbered_equal_p       PARAMS ((rtx, rtx));
1485 extern int true_regnum                  PARAMS ((rtx));
1486 extern int redirect_jump                PARAMS ((rtx, rtx));
1487 extern void jump_optimize               PARAMS ((rtx, int, int, int));
1488 extern void jump_optimize_minimal       PARAMS ((rtx));
1489 extern void rebuild_jump_labels         PARAMS ((rtx));
1490 extern void thread_jumps                PARAMS ((rtx, int, int));
1491 extern int redirect_exp                 PARAMS ((rtx *, rtx, rtx, rtx));
1492 extern int rtx_equal_for_thread_p       PARAMS ((rtx, rtx, rtx));
1493 extern int invert_exp                   PARAMS ((rtx, rtx));
1494 extern int can_reverse_comparison_p     PARAMS ((rtx, rtx));
1495 extern void delete_for_peephole         PARAMS ((rtx, rtx));
1496 extern int condjump_in_parallel_p       PARAMS ((rtx));
1497 extern void never_reached_warning       PARAMS ((rtx));
1498
1499 /* Flags for jump_optimize() */
1500 #define JUMP_CROSS_JUMP                 1
1501 #define JUMP_CROSS_JUMP_DEATH_MATTERS   2
1502 #define JUMP_NOOP_MOVES                 1
1503 #define JUMP_AFTER_REGSCAN              1
1504
1505 /* In emit-rtl.c. */
1506 extern int max_reg_num                          PARAMS ((void));
1507 extern int max_label_num                        PARAMS ((void));
1508 extern int get_first_label_num                  PARAMS ((void));
1509 extern void delete_insns_since                  PARAMS ((rtx));
1510 extern void mark_reg_pointer                    PARAMS ((rtx, int));
1511 extern void mark_user_reg                       PARAMS ((rtx));
1512 extern void reset_used_flags                    PARAMS ((rtx));
1513 extern void reorder_insns                       PARAMS ((rtx, rtx, rtx));
1514 extern int get_max_uid                          PARAMS ((void));
1515 extern int in_sequence_p                        PARAMS ((void));
1516 extern void force_next_line_note                PARAMS ((void));
1517 extern void clear_emit_caches                   PARAMS ((void));
1518 extern void init_emit                           PARAMS ((void));
1519 extern void init_emit_once                      PARAMS ((int));
1520 extern void push_topmost_sequence               PARAMS ((void));
1521 extern void pop_topmost_sequence                PARAMS ((void));
1522 extern int subreg_realpart_p                    PARAMS ((rtx));
1523 extern void reverse_comparison                  PARAMS ((rtx));
1524 extern void set_new_first_and_last_insn         PARAMS ((rtx, rtx));
1525 extern void set_new_first_and_last_label_num    PARAMS ((int, int));
1526 extern void set_new_last_label_num              PARAMS ((int));
1527 extern void unshare_all_rtl_again               PARAMS ((rtx));
1528 extern void set_last_insn                       PARAMS ((rtx));
1529 extern void link_cc0_insns                      PARAMS ((rtx));
1530 extern void add_insn                            PARAMS ((rtx));
1531 extern void add_insn_before                     PARAMS ((rtx, rtx));
1532 extern void add_insn_after                      PARAMS ((rtx, rtx));
1533 extern void remove_insn                         PARAMS ((rtx));
1534 extern void reorder_insns_with_line_notes       PARAMS ((rtx, rtx, rtx));
1535 extern void emit_insn_after_with_line_notes     PARAMS ((rtx, rtx, rtx));
1536 extern enum rtx_code classify_insn              PARAMS ((rtx));
1537 extern rtx emit                                 PARAMS ((rtx));
1538 /* Query and clear/ restore no_line_numbers.  This is used by the
1539    switch / case handling in stmt.c to give proper line numbers in
1540    warnings about unreachable code.  */
1541 int force_line_numbers PARAMS ((void));
1542 void restore_line_number_status PARAMS ((int old_value));
1543 extern void renumber_insns                      PARAMS ((FILE *));
1544 extern void remove_unncessary_notes             PARAMS ((void));
1545
1546 /* In insn-emit.c */
1547 extern void add_clobbers                PARAMS ((rtx, int));
1548
1549 /* In combine.c */
1550 extern int combine_instructions         PARAMS ((rtx, unsigned int));
1551 extern unsigned int extended_count      PARAMS ((rtx, enum machine_mode, int));
1552 extern rtx remove_death                 PARAMS ((unsigned int, rtx));
1553 #ifdef BUFSIZ
1554 extern void dump_combine_stats          PARAMS ((FILE *));
1555 extern void dump_combine_total_stats    PARAMS ((FILE *));
1556 #endif
1557
1558 /* In sched.c. */
1559 #ifdef BUFSIZ
1560 extern void schedule_insns              PARAMS ((FILE *));
1561 #endif
1562 extern void fix_sched_param             PARAMS ((const char *, const char *));
1563
1564 /* In print-rtl.c */
1565 extern void debug_rtx                   PARAMS ((rtx));
1566 extern void debug_rtx_list              PARAMS ((rtx, int));
1567 extern rtx debug_rtx_find               PARAMS ((rtx, int));
1568 #ifdef BUFSIZ
1569 extern void print_rtl                   PARAMS ((FILE *, rtx));
1570 extern int print_rtl_single             PARAMS ((FILE *, rtx));
1571 extern void print_inline_rtx            PARAMS ((FILE *, rtx, int));
1572 #endif
1573
1574 /* In loop.c */
1575 extern void init_loop                   PARAMS ((void));
1576 extern rtx libcall_other_reg            PARAMS ((rtx, rtx));
1577 #ifdef BUFSIZ
1578 extern void loop_optimize               PARAMS ((rtx, FILE *, int, int));
1579 #endif
1580 extern void record_excess_regs          PARAMS ((rtx, rtx, rtx *));
1581
1582 /* In function.c */
1583 extern void reposition_prologue_and_epilogue_notes      PARAMS ((rtx));
1584 extern void thread_prologue_and_epilogue_insns          PARAMS ((rtx));
1585 extern int prologue_epilogue_contains                   PARAMS ((rtx));
1586 extern int sibcall_epilogue_contains                    PARAMS ((rtx));
1587 extern HOST_WIDE_INT get_frame_size                     PARAMS ((void));
1588 extern void preserve_rtl_expr_result                    PARAMS ((rtx));
1589 extern void mark_temp_addr_taken                        PARAMS ((rtx));
1590 extern void update_temp_slot_address                    PARAMS ((rtx, rtx));
1591 extern void purge_addressof                             PARAMS ((rtx));
1592
1593 /* In reload.c */
1594 extern int operands_match_p             PARAMS ((rtx, rtx));
1595 extern int safe_from_earlyclobber       PARAMS ((rtx, rtx));
1596
1597 /* In stmt.c */
1598 extern void set_file_and_line_for_stmt  PARAMS ((const char *, int));
1599 extern void expand_null_return          PARAMS ((void));
1600 extern void emit_jump                   PARAMS ((rtx));
1601 extern int preserve_subexpressions_p    PARAMS ((void));
1602
1603 /* In expr.c */
1604 extern void init_expr_once              PARAMS ((void));
1605 extern void move_by_pieces              PARAMS ((rtx, rtx, int, unsigned int));
1606
1607 /* In flow.c */
1608 extern void allocate_bb_life_data       PARAMS ((void));
1609 extern void allocate_reg_life_data      PARAMS ((void));
1610 extern void recompute_reg_usage         PARAMS ((rtx, int));
1611 #ifdef BUFSIZ
1612 extern void print_rtl_with_bb           PARAMS ((FILE *, rtx));
1613 extern void dump_flow_info              PARAMS ((FILE *));
1614 #endif
1615
1616 /* In expmed.c */
1617 extern void init_expmed                 PARAMS ((void));
1618 extern void expand_inc                  PARAMS ((rtx, rtx));
1619 extern void expand_dec                  PARAMS ((rtx, rtx));
1620 extern rtx expand_mult_highpart         PARAMS ((enum machine_mode, rtx,
1621                                                 unsigned HOST_WIDE_INT, rtx,
1622                                                 int, int));
1623
1624 /* In gcse.c */
1625 #ifdef BUFSIZ
1626 extern int gcse_main                    PARAMS ((rtx, FILE *));
1627 #endif
1628
1629 /* In global.c */
1630 extern void mark_elimination            PARAMS ((int, int));
1631 #ifdef BUFSIZ
1632 extern int global_alloc                 PARAMS ((FILE *));
1633 extern void dump_global_regs            PARAMS ((FILE *));
1634 #endif
1635 #ifdef HARD_CONST
1636 extern void retry_global_alloc          PARAMS ((int, HARD_REG_SET));
1637 #endif
1638 extern void build_insn_chain            PARAMS ((rtx));
1639
1640 /* In regclass.c */
1641 extern int reg_classes_intersect_p      PARAMS ((enum reg_class, enum reg_class));
1642 extern int reg_class_subset_p           PARAMS ((enum reg_class, enum reg_class));
1643 extern void globalize_reg               PARAMS ((int));
1644 extern void init_regs                   PARAMS ((void));
1645 extern void init_reg_sets               PARAMS ((void));
1646 extern void regset_release_memory       PARAMS ((void));
1647 extern void regclass_init               PARAMS ((void));
1648 extern void regclass                    PARAMS ((rtx, int, FILE *));
1649 extern void reg_scan                    PARAMS ((rtx, unsigned int, int));
1650 extern void reg_scan_update             PARAMS ((rtx, rtx, unsigned int));
1651 extern void fix_register                PARAMS ((const char *, int, int));
1652
1653 extern void delete_null_pointer_checks  PARAMS ((rtx));
1654
1655 /* In regmove.c */
1656 #ifdef BUFSIZ
1657 extern void regmove_optimize            PARAMS ((rtx, int, FILE *));
1658 #endif
1659 extern void combine_stack_adjustments   PARAMS ((void));
1660
1661 /* In reorg.c */
1662 #ifdef BUFSIZ
1663 extern void dbr_schedule                PARAMS ((rtx, FILE *));
1664 #endif
1665
1666 /* In optabs.c */
1667 extern void init_optabs                 PARAMS ((void));
1668
1669 /* In local-alloc.c */
1670 #ifdef BUFSIZ
1671 extern void dump_local_alloc            PARAMS ((FILE *));
1672 #endif
1673 extern int local_alloc                  PARAMS ((void));
1674 extern int function_invariant_p         PARAMS ((rtx));
1675
1676 /* In reload1.c */
1677 extern void reload_cse_regs             PARAMS ((rtx));
1678 extern void init_reload                 PARAMS ((void));
1679 extern void mark_home_live              PARAMS ((int));
1680 #ifdef BUFSIZ
1681 extern int reload                       PARAMS ((rtx, int, FILE *));
1682 #endif
1683
1684 /* In caller-save.c */
1685 extern void init_caller_save            PARAMS ((void));
1686
1687 /* In profile.c */
1688 extern void init_branch_prob            PARAMS ((const char *));
1689 #ifdef BUFSIZ
1690 extern void branch_prob                 PARAMS ((rtx, FILE *));
1691 extern void end_branch_prob             PARAMS ((FILE *));
1692 #endif
1693 extern void output_func_start_profiler  PARAMS ((void));
1694
1695 /* In reg-stack.c */
1696 #ifdef BUFSIZ
1697 extern void reg_to_stack                PARAMS ((rtx, FILE *));
1698 #endif
1699
1700 /* In fold-const.c */
1701 extern int add_double           PARAMS ((unsigned HOST_WIDE_INT, HOST_WIDE_INT,
1702                                          unsigned HOST_WIDE_INT, HOST_WIDE_INT,
1703                                          unsigned HOST_WIDE_INT *,
1704                                          HOST_WIDE_INT *));
1705 extern int neg_double           PARAMS ((unsigned HOST_WIDE_INT, HOST_WIDE_INT,
1706                                          unsigned HOST_WIDE_INT *,
1707                                          HOST_WIDE_INT *));
1708 extern int mul_double           PARAMS ((unsigned HOST_WIDE_INT,
1709                                          HOST_WIDE_INT,
1710                                          unsigned HOST_WIDE_INT, HOST_WIDE_INT,
1711                                          unsigned HOST_WIDE_INT *,
1712                                          HOST_WIDE_INT *));
1713 extern void lshift_double       PARAMS ((unsigned HOST_WIDE_INT, HOST_WIDE_INT,
1714                                          HOST_WIDE_INT, unsigned int,
1715                                          unsigned HOST_WIDE_INT *,
1716                                          HOST_WIDE_INT *, int));
1717 extern void rshift_double       PARAMS ((unsigned HOST_WIDE_INT, HOST_WIDE_INT,
1718                                          HOST_WIDE_INT, unsigned int,
1719                                          unsigned HOST_WIDE_INT *,
1720                                          HOST_WIDE_INT *, int));
1721 extern void lrotate_double      PARAMS ((unsigned HOST_WIDE_INT, HOST_WIDE_INT,
1722                                          HOST_WIDE_INT, unsigned int,
1723                                          unsigned HOST_WIDE_INT *,
1724                                          HOST_WIDE_INT *));
1725 extern void rrotate_double      PARAMS ((unsigned HOST_WIDE_INT, HOST_WIDE_INT,
1726                                          HOST_WIDE_INT, unsigned int,
1727                                          unsigned HOST_WIDE_INT *,
1728                                          HOST_WIDE_INT *));
1729
1730 /* In calls.c */
1731 extern void emit_library_call           PARAMS ((rtx, int, enum machine_mode,
1732                                                   int, ...));
1733 extern rtx emit_library_call_value      PARAMS ((rtx, rtx, int,
1734                                                  enum machine_mode,
1735                                                  int, ...));
1736
1737 /* In unroll.c */
1738 extern int set_dominates_use            PARAMS ((int, int, int, rtx, rtx));
1739
1740 /* In varasm.c */
1741 extern void bss_section                 PARAMS ((void));
1742 extern int in_data_section              PARAMS ((void));
1743 extern int supports_one_only            PARAMS ((void));
1744 extern void init_varasm_once            PARAMS ((void));
1745
1746 /* In rtl.c */
1747 extern void init_rtl                    PARAMS ((void));
1748 extern void rtx_free                    PARAMS ((rtx));
1749
1750 #ifdef BUFSIZ
1751 extern int read_skip_spaces             PARAMS ((FILE *));
1752 extern rtx read_rtx                     PARAMS ((FILE *));
1753 #endif
1754
1755 extern const char *read_rtx_filename;
1756 extern int read_rtx_lineno;
1757
1758 /* Redefine abort to report an internal error w/o coredump, and
1759    reporting the location of the error in the source file.  This logic
1760    is duplicated in rtl.h and tree.h because every file that needs the
1761    special abort includes one or both.  toplev.h gets too few files,
1762    system.h gets too many.  */
1763
1764 extern void fancy_abort PARAMS ((const char *, int, const char *))
1765     ATTRIBUTE_NORETURN;
1766 #if (GCC_VERSION >= 2007)
1767 #define abort() fancy_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
1768 #else
1769 #define abort() fancy_abort (__FILE__, __LINE__, 0)
1770 #endif
1771
1772 /* In alias.c */
1773 extern rtx canon_rtx                    PARAMS ((rtx));
1774 extern int true_dependence              PARAMS ((rtx, enum machine_mode, rtx,
1775                                                 int (*)(rtx)));
1776 extern int read_dependence              PARAMS ((rtx, rtx));
1777 extern int anti_dependence              PARAMS ((rtx, rtx));
1778 extern int output_dependence            PARAMS ((rtx, rtx));
1779 extern void mark_constant_function      PARAMS ((void));
1780 extern void init_alias_once             PARAMS ((void));
1781 extern void init_alias_analysis         PARAMS ((void));
1782 extern void end_alias_analysis          PARAMS ((void));
1783
1784 extern void record_base_value           PARAMS ((int, rtx, int));
1785 extern void record_alias_subset         PARAMS ((int, int));
1786 extern rtx addr_side_effect_eval        PARAMS ((rtx, int, int));
1787
1788 /* In sibcall.c */
1789 typedef enum {
1790   sibcall_use_normal = 1,
1791   sibcall_use_tail_recursion,
1792   sibcall_use_sibcall
1793 } sibcall_use_t;
1794
1795 extern void optimize_sibling_and_tail_recursive_calls PARAMS ((void));
1796 extern void replace_call_placeholder    PARAMS ((rtx, sibcall_use_t));
1797
1798 #ifdef STACK_REGS
1799 extern int stack_regs_mentioned         PARAMS ((rtx insn));
1800 #endif
1801
1802 /* In ssa.c */
1803 extern void convert_to_ssa              PARAMS ((void));
1804 extern void convert_from_ssa            PARAMS ((void));
1805 typedef int (*successor_phi_fn)         PARAMS ((rtx, int, int, void *));
1806 extern int for_each_successor_phi       PARAMS ((int bb,
1807                                                  successor_phi_fn,
1808                                                  void *));
1809 extern int in_ssa_form;
1810
1811 /* In toplev.c */
1812
1813 extern rtx stack_limit_rtx;
1814
1815 /* In regrename.c */
1816
1817 extern void regrename_optimize          PARAMS ((void));
1818
1819 #endif /* _RTL_H */