OSDN Git Service

* rtl.h (struct rtx_def): Update comments.
[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, 2001, 2002 Free Software Foundation, Inc.
4
5 This file is part of GCC.
6
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
10 version.
11
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15 for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING.  If not, write to the Free
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
20 02111-1307, USA.  */
21
22 #ifndef GCC_RTL_H
23 #define GCC_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 /* Value used by some passes to "recognize" noop moves as valid
35  instructions.  */
36 #define NOOP_MOVE_INSN_CODE     INT_MAX
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 unsigned char rtx_length[NUM_RTX_CODE];
55 #define GET_RTX_LENGTH(CODE)            (rtx_length[(int) (CODE)])
56
57 extern const char * const rtx_name[NUM_RTX_CODE];
58 #define GET_RTX_NAME(CODE)              (rtx_name[(int) (CODE)])
59
60 extern const char * const rtx_format[NUM_RTX_CODE];
61 #define GET_RTX_FORMAT(CODE)            (rtx_format[(int) (CODE)])
62
63 extern const char rtx_class[NUM_RTX_CODE];
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
75                                  after the ADDR_DIFF_VEC.  */
76   unsigned max_after_vec: 1;  /* maximum address target label is
77                                  after the ADDR_DIFF_VEC.  */
78   unsigned min_after_base: 1; /* minimum address target label is
79                                  after BASE.  */
80   unsigned max_after_base: 1; /* maximum address target label is
81                                  after BASE.  */
82   /* Set by the actual branch shortening process - ONLY WHEN OPTIMIZING - : */
83   unsigned offset_unsigned: 1; /* offsets have to be treated as unsigned.  */
84   unsigned : 2;
85   unsigned scale : 8;
86 } addr_diff_vec_flags;
87
88 /* Structure used to describe the attributes of a MEM.  These are hashed
89    so MEMs that the same attributes share a data structure.  This means
90    they cannot be modified in place.  If any element is nonzero, it means
91    the value of the corresponding attribute is unknown.  */
92 typedef struct
93 {
94   HOST_WIDE_INT alias;          /* Memory alias set.  */
95   tree expr;                    /* expr corresponding to MEM.  */
96   rtx offset;                   /* Offset from start of DECL, as CONST_INT.  */
97   rtx size;                     /* Size in bytes, as a CONST_INT.  */
98   unsigned int align;           /* Alignment of MEM in bits.  */
99 } mem_attrs;
100
101 /* Common union for an element of an rtx.  */
102
103 typedef union rtunion_def
104 {
105   HOST_WIDE_INT rtwint;
106   int rtint;
107   unsigned int rtuint;
108   const char *rtstr;
109   rtx rtx;
110   rtvec rtvec;
111   enum machine_mode rttype;
112   addr_diff_vec_flags rt_addr_diff_vec_flags;
113   struct cselib_val_struct *rt_cselib;
114   struct bitmap_head_def *rtbit;
115   tree rttree;
116   struct basic_block_def *bb;
117   mem_attrs *rtmem;
118 } rtunion;
119
120 /* RTL expression ("rtx").  */
121
122 struct rtx_def
123 {
124   /* The kind of expression this is.  */
125   ENUM_BITFIELD(rtx_code) code: 16;
126
127   /* The kind of value the expression has.  */
128   ENUM_BITFIELD(machine_mode) mode : 8;
129
130   /* 1 in a MEM if we should keep the alias set for this mem unchanged
131      when we access a component.
132      1 in a CALL_INSN if it is a sibling call.
133      1 in a SET that is for a return.  */
134   unsigned int jump : 1;
135   /* This flag is currently unused.  */
136   unsigned int call : 1;
137   /* 1 in a REG, MEM, or CONCAT if the value is set at most once, anywhere.
138      1 in a SUBREG if it references an unsigned object whose mode has been
139      from a promoted to a wider mode.
140      1 in a SYMBOL_REF if it addresses something in the per-function
141      constants pool.
142      1 in a CALL_INSN, NOTE, or EXPR_LIST for a const or pure call.
143      1 in an INSN in the delay slot of a branch insn if an annulling branch
144      should be used.  */
145   unsigned int unchanging : 1;
146   /* 1 in a MEM or ASM_OPERANDS expression if the memory reference is volatile.
147      1 in an INSN, CALL_INSN, JUMP_INSN, CODE_LABEL, BARRIER, or NOTE
148      if it has been deleted.
149      1 in a REG expression if corresponds to a variable declared by the user,
150      0 for an internally generated temporary.
151      1 in a SUBREG with a negative value.
152      1 in a LABEL_REF or in a REG_LABEL note for a non-local label.
153      In a SYMBOL_REF, this flag is used for machine-specific purposes.  */
154   unsigned int volatil : 1;
155   /* 1 in a MEM referring to a field of an aggregate.
156      0 if the MEM was a variable or the result of a * operator in C;
157      1 if it was the result of a . or -> operator (on a struct) in C.
158      1 in a REG if the register is used only in exit code a loop.
159      1 in a SUBREG expression if was generated from a variable with a
160      promoted mode.
161      1 in a CODE_LABEL if the label is used for nonlocal gotos
162      and must not be deleted even if its count is zero.
163      1 in a LABEL_REF if this is a reference to a label outside the
164      current loop.
165      1 in an INSN, JUMP_INSN, CALL_INSN, CODE_LABEL, BARRIER, or NOTE if
166      this insn must be scheduled together with the preceding insn.  Valid
167      only within sched.
168      1 in an INSN, JUMP_INSN, or CALL_INSN if insn is in a delay slot and
169      from the target of a branch.  Valid from reorg until end of compilation;
170      cleared before used.
171      1 in an INSN in a delay slot that is the target of a branch, during reorg.
172      1 in an INSN or related rtx if this insn is dead code.  Valid only during
173      dead-code elimination phase; cleared before use.  */
174   unsigned int in_struct : 1;
175   /* At the end of RTL generation, 1 if this rtx is used.  This is used for
176      copying shared structure.  See `unshare_all_rtl'.
177      In a REG, this is not needed for that purpose, and used instead
178      in `leaf_renumber_regs_insn'.
179      1 in a SYMBOL_REF, means that emit_library_call
180      has used it as the function.  */
181   unsigned int used : 1;
182   /* Nonzero if this rtx came from procedure integration.
183      1 in a REG means this reg refers to the return value
184      of the current function.
185      1 in a SYMBOL_REF if the symbol is weak.  */
186   unsigned integrated : 1;
187   /* 1 in an INSN or a SET if this rtx is related to the call frame,
188      either changing how we compute the frame address or saving and
189      restoring registers in the prologue and epilogue.
190      1 in a MEM if the MEM refers to a scalar, rather than a member of
191      an aggregate.
192      1 in a REG if the register is a pointer.
193      1 in a SYMBOL_REF if it addresses something in the per-function
194      constant string pool.  */
195   unsigned frame_related : 1;
196
197   /* The first element of the operands of this rtx.
198      The number of operands and their types are controlled
199      by the `code' field, according to rtl.def.  */
200   rtunion fld[1];
201 };
202
203 #define NULL_RTX (rtx) 0
204
205 /* Define macros to access the `code' field of the rtx.  */
206
207 #define GET_CODE(RTX)       ((enum rtx_code) (RTX)->code)
208 #define PUT_CODE(RTX, CODE) ((RTX)->code = (ENUM_BITFIELD(rtx_code)) (CODE))
209
210 #define GET_MODE(RTX)       ((enum machine_mode) (RTX)->mode)
211 #define PUT_MODE(RTX, MODE) ((RTX)->mode = (ENUM_BITFIELD(machine_mode)) (MODE))
212
213 /* RTL vector.  These appear inside RTX's when there is a need
214    for a variable number of things.  The principle use is inside
215    PARALLEL expressions.  */
216
217 struct rtvec_def {
218   int num_elem;         /* number of elements */
219   rtx elem[1];
220 };
221
222 #define NULL_RTVEC (rtvec) 0
223
224 #define GET_NUM_ELEM(RTVEC)             ((RTVEC)->num_elem)
225 #define PUT_NUM_ELEM(RTVEC, NUM)        ((RTVEC)->num_elem = (NUM))
226
227 /* Predicate yielding nonzero iff X is an rtl for a register.  */
228 #define REG_P(X) (GET_CODE (X) == REG)
229
230 /* Predicate yielding nonzero iff X is a label insn.  */
231 #define LABEL_P(X) (GET_CODE (X) == CODE_LABEL)
232
233 /* Predicate yielding nonzero iff X is a jump insn.  */
234 #define JUMP_P(X) (GET_CODE (X) == JUMP_INSN)
235
236 /* Predicate yielding nonzero iff X is a note insn.  */
237 #define NOTE_P(X) (GET_CODE (X) == NOTE)
238
239 /* Predicate yielding nonzero iff X is a barrier insn.  */
240 #define BARRIER_P(X) (GET_CODE (X) == BARRIER)
241
242 /* Predicate yielding nonzero iff X is a data for a jump table.  */
243 #define JUMP_TABLE_DATA_P(INSN) \
244   (JUMP_P (INSN) && (GET_CODE (PATTERN (INSN)) == ADDR_VEC || \
245                      GET_CODE (PATTERN (INSN)) == ADDR_DIFF_VEC))
246
247 /* 1 if X is a constant value that is an integer.  */
248
249 #define CONSTANT_P(X)   \
250   (GET_CODE (X) == LABEL_REF || GET_CODE (X) == SYMBOL_REF              \
251    || GET_CODE (X) == CONST_INT || GET_CODE (X) == CONST_DOUBLE         \
252    || GET_CODE (X) == CONST || GET_CODE (X) == HIGH                     \
253    || GET_CODE (X) == CONST_VECTOR                                      \
254    || GET_CODE (X) == CONSTANT_P_RTX)
255
256 /* General accessor macros for accessing the fields of an rtx.  */
257
258 #if defined ENABLE_RTL_CHECKING && (GCC_VERSION >= 2007)
259 /* The bit with a star outside the statement expr and an & inside is
260    so that N can be evaluated only once.  */
261 #define RTL_CHECK1(RTX, N, C1) __extension__                            \
262 (*({ rtx const _rtx = (RTX); const int _n = (N);                        \
263      const enum rtx_code _code = GET_CODE (_rtx);                       \
264      if (_n < 0 || _n >= GET_RTX_LENGTH (_code))                        \
265        rtl_check_failed_bounds (_rtx, _n, __FILE__, __LINE__,           \
266                                 __FUNCTION__);                          \
267      if (GET_RTX_FORMAT(_code)[_n] != C1)                               \
268        rtl_check_failed_type1 (_rtx, _n, C1, __FILE__, __LINE__,        \
269                                __FUNCTION__);                           \
270      &_rtx->fld[_n]; }))
271
272 #define RTL_CHECK2(RTX, N, C1, C2) __extension__                        \
273 (*({ rtx const _rtx = (RTX); const int _n = (N);                        \
274      const enum rtx_code _code = GET_CODE (_rtx);                       \
275      if (_n < 0 || _n >= GET_RTX_LENGTH (_code))                        \
276        rtl_check_failed_bounds (_rtx, _n, __FILE__, __LINE__,           \
277                                 __FUNCTION__);                          \
278      if (GET_RTX_FORMAT(_code)[_n] != C1                                \
279          && GET_RTX_FORMAT(_code)[_n] != C2)                            \
280        rtl_check_failed_type2 (_rtx, _n, C1, C2, __FILE__, __LINE__,    \
281                                __FUNCTION__);                           \
282      &_rtx->fld[_n]; }))
283
284 #define RTL_CHECKC1(RTX, N, C) __extension__                            \
285 (*({ rtx const _rtx = (RTX); const int _n = (N);                        \
286      if (GET_CODE (_rtx) != (C))                                        \
287        rtl_check_failed_code1 (_rtx, (C), __FILE__, __LINE__,           \
288                                __FUNCTION__);                           \
289      &_rtx->fld[_n]; }))
290
291 #define RTL_CHECKC2(RTX, N, C1, C2) __extension__                       \
292 (*({ rtx const _rtx = (RTX); const int _n = (N);                        \
293      const enum rtx_code _code = GET_CODE (_rtx);                       \
294      if (_code != (C1) && _code != (C2))                                \
295        rtl_check_failed_code2 (_rtx, (C1), (C2), __FILE__, __LINE__,    \
296                                __FUNCTION__); \
297      &_rtx->fld[_n]; }))
298
299 #define RTVEC_ELT(RTVEC, I) __extension__                               \
300 (*({ rtvec const _rtvec = (RTVEC); const int _i = (I);                  \
301      if (_i < 0 || _i >= GET_NUM_ELEM (_rtvec))                         \
302        rtvec_check_failed_bounds (_rtvec, _i, __FILE__, __LINE__,       \
303                                   __FUNCTION__);                        \
304      &_rtvec->elem[_i]; }))
305
306 extern void rtl_check_failed_bounds PARAMS ((rtx, int,
307                                            const char *, int, const char *))
308     ATTRIBUTE_NORETURN;
309 extern void rtl_check_failed_type1 PARAMS ((rtx, int, int,
310                                           const char *, int, const char *))
311     ATTRIBUTE_NORETURN;
312 extern void rtl_check_failed_type2 PARAMS ((rtx, int, int, int,
313                                           const char *, int, const char *))
314     ATTRIBUTE_NORETURN;
315 extern void rtl_check_failed_code1 PARAMS ((rtx, enum rtx_code,
316                                           const char *, int, const char *))
317     ATTRIBUTE_NORETURN;
318 extern void rtl_check_failed_code2 PARAMS ((rtx, enum rtx_code, enum rtx_code,
319                                           const char *, int, const char *))
320     ATTRIBUTE_NORETURN;
321 extern void rtvec_check_failed_bounds PARAMS ((rtvec, int,
322                                              const char *, int, const char *))
323     ATTRIBUTE_NORETURN;
324
325 #else   /* not ENABLE_RTL_CHECKING */
326
327 #define RTL_CHECK1(RTX, N, C1)      ((RTX)->fld[N])
328 #define RTL_CHECK2(RTX, N, C1, C2)  ((RTX)->fld[N])
329 #define RTL_CHECKC1(RTX, N, C)      ((RTX)->fld[N])
330 #define RTL_CHECKC2(RTX, N, C1, C2) ((RTX)->fld[N])
331 #define RTVEC_ELT(RTVEC, I)         ((RTVEC)->elem[I])
332
333 #endif
334
335 /* General accessor macros for accessing the flags of an rtx.  */
336
337 /* Access an individual rtx flag, with no checking of any kind.  */
338 #define RTX_FLAG(RTX, FLAG)     ((RTX)->FLAG)
339
340 #if defined ENABLE_RTL_FLAG_CHECKING
341 #define RTL_FLAG_CHECK1(RTX, C1) __extension__                  \
342 ({ rtx const _rtx = (RTX);                                              \
343    if (GET_CODE(_rtx) != C1)                                            \
344      rtl_check_failed_flag  (_rtx, __FILE__, __LINE__, __FUNCTION__);   \
345    _rtx; })
346
347 #define RTL_FLAG_CHECK2(RTX, C1, C2) __extension__              \
348 ({ rtx const _rtx = (RTX);                                              \
349    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2)                    \
350      rtl_check_failed_flag  (_rtx, __FILE__, __LINE__, __FUNCTION__);   \
351    _rtx; })
352
353 #define RTL_FLAG_CHECK3(RTX, C1, C2, C3) __extension__          \
354 ({ rtx const _rtx = (RTX);                                              \
355    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2                     \
356        && GET_CODE(_rtx) != C3)                                         \
357      rtl_check_failed_flag  (_rtx, __FILE__, __LINE__, __FUNCTION__);   \
358    _rtx; })
359
360 #define RTL_FLAG_CHECK4(RTX, C1, C2, C3, C4) __extension__      \
361 ({ rtx const _rtx = (RTX);                                              \
362    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2                     \
363        && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4)                 \
364      rtl_check_failed_flag  (_rtx, __FILE__, __LINE__, __FUNCTION__);   \
365    _rtx; })
366
367 #define RTL_FLAG_CHECK5(RTX, C1, C2, C3, C4, C5) __extension__  \
368 ({ rtx const _rtx = (RTX);                                              \
369    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2                     \
370        && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4                  \
371        && GET_CODE(_rtx) != C5)                                         \
372      rtl_check_failed_flag  (_rtx, __FILE__, __LINE__, __FUNCTION__);   \
373    _rtx; })
374
375 #define RTL_FLAG_CHECK6(RTX, C1, C2, C3, C4, C5, C6) __extension__      \
376 ({ rtx const _rtx = (RTX);                                              \
377    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2                     \
378        && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4                  \
379        && GET_CODE(_rtx) != C5 && GET_CODE(_rtx) != C6)                 \
380      rtl_check_failed_flag  (_rtx, __FILE__, __LINE__, __FUNCTION__);   \
381    _rtx; })
382
383 #define RTL_FLAG_CHECK7(RTX, C1, C2, C3, C4, C5, C6, C7) __extension__  \
384 ({ rtx const _rtx = (RTX);                                              \
385    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2                     \
386        && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4                  \
387        && GET_CODE(_rtx) != C5 && GET_CODE(_rtx) != C6                  \
388        && GET_CODE(_rtx) != C7)                                         \
389      rtl_check_failed_flag  (_rtx, __FILE__, __LINE__, __FUNCTION__);   \
390    _rtx; })
391
392 #define RTL_FLAG_CHECK8(RTX, C1, C2, C3, C4, C5, C6, C7, C8) __extension__ \
393 ({ rtx const _rtx = (RTX);                                              \
394    if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2                     \
395        && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4                  \
396        && GET_CODE(_rtx) != C5 && GET_CODE(_rtx) != C6                  \
397        && GET_CODE(_rtx) != C7 && GET_CODE(_rtx) != C8)                 \
398      rtl_check_failed_flag  (_rtx, __FILE__, __LINE__, __FUNCTION__);   \
399    _rtx; })
400
401 extern void rtl_check_failed_flag PARAMS ((rtx, const char *, int,
402                                          const char *))
403     ATTRIBUTE_NORETURN
404     ;
405
406 #else   /* not ENABLE_RTL_FLAG_CHECKING */
407
408 #define RTL_FLAG_CHECK1(RTX, C1)                        (RTX)
409 #define RTL_FLAG_CHECK2(RTX, C1, C2)                    (RTX)
410 #define RTL_FLAG_CHECK3(RTX, C1, C2, C3)                (RTX)
411 #define RTL_FLAG_CHECK4(RTX, C1, C2, C3, C4)            (RTX)
412 #define RTL_FLAG_CHECK5(RTX, C1, C2, C3, C4, C5)        (RTX)
413 #define RTL_FLAG_CHECK6(RTX, C1, C2, C3, C4, C5, C6)    (RTX)
414 #define RTL_FLAG_CHECK7(RTX, C1, C2, C3, C4, C5, C6, C7) (RTX)
415 #define RTL_FLAG_CHECK8(RTX, C1, C2, C3, C4, C5, C6, C7, C8) (RTX)
416 #endif
417
418 #define CLEAR_RTX_FLAGS(RTX)    \
419 do {                            \
420   rtx const _rtx = (RTX);       \
421   _rtx->call = 0;               \
422   _rtx->frame_related = 0;      \
423   _rtx->in_struct = 0;          \
424   _rtx->integrated = 0;         \
425   _rtx->jump = 0;               \
426   _rtx->unchanging = 0;         \
427   _rtx->used = 0;               \
428   _rtx->volatil = 0;            \
429 } while (0)
430
431 #define XWINT(RTX, N)   (RTL_CHECK1 (RTX, N, 'w').rtwint)
432 #define XINT(RTX, N)    (RTL_CHECK2 (RTX, N, 'i', 'n').rtint)
433 #define XSTR(RTX, N)    (RTL_CHECK2 (RTX, N, 's', 'S').rtstr)
434 #define XEXP(RTX, N)    (RTL_CHECK2 (RTX, N, 'e', 'u').rtx)
435 #define XVEC(RTX, N)    (RTL_CHECK2 (RTX, N, 'E', 'V').rtvec)
436 #define XMODE(RTX, N)   (RTL_CHECK1 (RTX, N, 'M').rttype)
437 #define XBITMAP(RTX, N) (RTL_CHECK1 (RTX, N, 'b').rtbit)
438 #define XTREE(RTX, N)   (RTL_CHECK1 (RTX, N, 't').rttree)
439 #define XBBDEF(RTX, N)  (RTL_CHECK1 (RTX, N, 'B').bb)
440 #define XTMPL(RTX, N)   (RTL_CHECK1 (RTX, N, 'T').rtstr)
441
442 #define XVECEXP(RTX, N, M)      RTVEC_ELT (XVEC (RTX, N), M)
443 #define XVECLEN(RTX, N)         GET_NUM_ELEM (XVEC (RTX, N))
444
445 /* These are like XWINT, etc. except that they expect a '0' field instead
446    of the normal type code.  */
447
448 #define X0WINT(RTX, N)     (RTL_CHECK1 (RTX, N, '0').rtwint)
449 #define X0INT(RTX, N)      (RTL_CHECK1 (RTX, N, '0').rtint)
450 #define X0UINT(RTX, N)     (RTL_CHECK1 (RTX, N, '0').rtuint)
451 #define X0STR(RTX, N)      (RTL_CHECK1 (RTX, N, '0').rtstr)
452 #define X0EXP(RTX, N)      (RTL_CHECK1 (RTX, N, '0').rtx)
453 #define X0VEC(RTX, N)      (RTL_CHECK1 (RTX, N, '0').rtvec)
454 #define X0MODE(RTX, N)     (RTL_CHECK1 (RTX, N, '0').rttype)
455 #define X0BITMAP(RTX, N)   (RTL_CHECK1 (RTX, N, '0').rtbit)
456 #define X0TREE(RTX, N)     (RTL_CHECK1 (RTX, N, '0').rttree)
457 #define X0BBDEF(RTX, N)    (RTL_CHECK1 (RTX, N, '0').bb)
458 #define X0ADVFLAGS(RTX, N) (RTL_CHECK1 (RTX, N, '0').rt_addr_diff_vec_flags)
459 #define X0CSELIB(RTX, N)   (RTL_CHECK1 (RTX, N, '0').rt_cselib)
460 #define X0MEMATTR(RTX, N)  (RTL_CHECK1 (RTX, N, '0').rtmem)
461
462 #define XCWINT(RTX, N, C)     (RTL_CHECKC1 (RTX, N, C).rtwint)
463 #define XCINT(RTX, N, C)      (RTL_CHECKC1 (RTX, N, C).rtint)
464 #define XCUINT(RTX, N, C)     (RTL_CHECKC1 (RTX, N, C).rtuint)
465 #define XCSTR(RTX, N, C)      (RTL_CHECKC1 (RTX, N, C).rtstr)
466 #define XCEXP(RTX, N, C)      (RTL_CHECKC1 (RTX, N, C).rtx)
467 #define XCVEC(RTX, N, C)      (RTL_CHECKC1 (RTX, N, C).rtvec)
468 #define XCMODE(RTX, N, C)     (RTL_CHECKC1 (RTX, N, C).rttype)
469 #define XCBITMAP(RTX, N, C)   (RTL_CHECKC1 (RTX, N, C).rtbit)
470 #define XCTREE(RTX, N, C)     (RTL_CHECKC1 (RTX, N, C).rttree)
471 #define XCBBDEF(RTX, N, C)    (RTL_CHECKC1 (RTX, N, C).bb)
472 #define XCADVFLAGS(RTX, N, C) (RTL_CHECKC1 (RTX, N, C).rt_addr_diff_vec_flags)
473 #define XCCSELIB(RTX, N, C)   (RTL_CHECKC1 (RTX, N, C).rt_cselib)
474
475 #define XCVECEXP(RTX, N, M, C)  RTVEC_ELT (XCVEC (RTX, N, C), M)
476 #define XCVECLEN(RTX, N, C)     GET_NUM_ELEM (XCVEC (RTX, N, C))
477
478 #define XC2EXP(RTX, N, C1, C2)      (RTL_CHECKC2 (RTX, N, C1, C2).rtx)
479 \f
480 /* ACCESS MACROS for particular fields of insns.  */
481
482 /* Determines whether X is an insn.  */
483 #define INSN_P(X)       (GET_RTX_CLASS (GET_CODE(X)) == 'i')
484
485 /* Holds a unique number for each insn.
486    These are not necessarily sequentially increasing.  */
487 #define INSN_UID(INSN)  XINT (INSN, 0)
488
489 /* Chain insns together in sequence.  */
490 #define PREV_INSN(INSN) XEXP (INSN, 1)
491 #define NEXT_INSN(INSN) XEXP (INSN, 2)
492
493 /* The body of an insn.  */
494 #define PATTERN(INSN)   XEXP (INSN, 3)
495
496 /* Code number of instruction, from when it was recognized.
497    -1 means this instruction has not been recognized yet.  */
498 #define INSN_CODE(INSN) XINT (INSN, 4)
499
500 /* Set up in flow.c; empty before then.
501    Holds a chain of INSN_LIST rtx's whose first operands point at
502    previous insns with direct data-flow connections to this one.
503    That means that those insns set variables whose next use is in this insn.
504    They are always in the same basic block as this insn.  */
505 #define LOG_LINKS(INSN) XEXP(INSN, 5)
506
507 #define RTX_INTEGRATED_P(RTX)   \
508   (RTL_FLAG_CHECK8((RTX), INSN, CALL_INSN, JUMP_INSN, INSN_LIST,        \
509                    BARRIER, CODE_LABEL, CONST, NOTE)->integrated)
510 #define RTX_UNCHANGING_P(RTX)           \
511   (RTL_FLAG_CHECK3((RTX), REG, MEM, CONCAT)->unchanging)
512 #define RTX_FRAME_RELATED_P(RTX)        \
513   (RTL_FLAG_CHECK5((RTX), INSN, CALL_INSN, JUMP_INSN, BARRIER,  \
514                    SET)->frame_related)
515
516 /* 1 if insn has been deleted.  */
517 #define INSN_DELETED_P(RTX)     \
518   (RTL_FLAG_CHECK6((RTX), INSN, CALL_INSN, JUMP_INSN, CODE_LABEL,       \
519                    BARRIER, NOTE)->volatil)
520
521 /* 1 if insn is a call to a const or pure function.  */
522 #define CONST_OR_PURE_CALL_P(RTX)       \
523   (RTL_FLAG_CHECK3((RTX), CALL_INSN, NOTE, EXPR_LIST)->unchanging)
524
525 /* 1 if insn (assumed to be a CALL_INSN) is a sibling call.  */
526 #define SIBLING_CALL_P(INSN) (RTL_FLAG_CHECK1((INSN), CALL_INSN)->jump)
527
528 /* 1 in an INSN in the delay slot of a branch insn if an annulling branch
529    should be used.  */
530 #define INSN_ANNULLED_BRANCH_P(RTX) (RTL_FLAG_CHECK1((RTX), INSN)->unchanging)
531
532 /* 1 if insn is a dead code.  Valid only for dead-code elimination phase.  */
533 #define INSN_DEAD_CODE_P(RTX) (RTL_FLAG_CHECK1((RTX), INSN)->in_struct)
534
535 /* 1 if insn is in a delay slot and is from the target of the branch.  If
536    the branch insn has INSN_ANNULLED_BRANCH_P set, this insn should only be
537    executed if the branch is taken.  For annulled branches with this bit
538    clear, the insn should be executed only if the branch is not taken.  */
539 #define INSN_FROM_TARGET_P(RTX) (RTL_FLAG_CHECK1((RTX), INSN)->in_struct)
540
541 #define ADDR_DIFF_VEC_FLAGS(RTX) X0ADVFLAGS(RTX, 4)
542
543 #define CSELIB_VAL_PTR(RTX) X0CSELIB(RTX, 0)
544
545 /* Holds a list of notes on what this insn does to various REGs.
546    It is a chain of EXPR_LIST rtx's, where the second operand is the
547    chain pointer and the first operand is the REG being described.
548    The mode field of the EXPR_LIST contains not a real machine mode
549    but a value from enum reg_note.  */
550
551 #define REG_NOTES(INSN) XEXP(INSN, 6)
552
553 /* Don't forget to change reg_note_name in rtl.c.  */
554 enum reg_note
555 {
556   /* The value in REG dies in this insn (i.e., it is not needed past
557      this insn).  If REG is set in this insn, the REG_DEAD note may,
558      but need not, be omitted.  */
559   REG_DEAD = 1,
560
561   /* The REG is autoincremented or autodecremented.  */
562   REG_INC,
563
564   /* Describes the insn as a whole; it says that the insn sets a register
565      to a constant value or to be equivalent to a memory address.  If the
566      register is spilled to the stack then the constant value should be
567      substituted for it.  The contents of the REG_EQUIV is the constant
568      value or memory address, which may be different from the source of
569      the SET although it has the same value.  A REG_EQUIV note may also
570      appear on an insn which copies a register parameter to a pseudo-register,
571      if there is a memory address which could be used to hold that
572      pseudo-register throughout the function.  */
573   REG_EQUIV,
574
575   /* Like REG_EQUIV except that the destination is only momentarily equal
576      to the specified rtx.  Therefore, it cannot be used for substitution;
577      but it can be used for cse.  */
578   REG_EQUAL,
579
580   /* The register set in this insn held 0 before the insn.  The contents of
581      the note is the insn that stored the 0.  If that insn is deleted or
582      patched to a NOTE, the REG_WAS_0 is inoperative.  The REG_WAS_0 note
583      is actually an INSN_LIST, not an EXPR_LIST.  */
584   REG_WAS_0,
585
586   /* This insn copies the return-value of a library call out of the hard reg
587      for return values.  This note is actually an INSN_LIST and it points to
588      the first insn involved in setting up arguments for the call.  flow.c
589      uses this to delete the entire library call when its result is dead.  */
590   REG_RETVAL,
591
592   /* The inverse of REG_RETVAL: it goes on the first insn of the library call
593      and points at the one that has the REG_RETVAL.  This note is also an
594      INSN_LIST.  */
595   REG_LIBCALL,
596
597   /* The register is always nonnegative during the containing loop.  This is
598      used in branches so that decrement and branch instructions terminating
599      on zero can be matched.  There must be an insn pattern in the md file
600      named `decrement_and_branch_until_zero' or else this will never be added
601      to any instructions.  */
602   REG_NONNEG,
603
604   /* There is no conflict *after this insn* between the register in the note
605      and the destination of this insn.  */
606   REG_NO_CONFLICT,
607
608   /* Identifies a register set in this insn and never used.  */
609   REG_UNUSED,
610
611   /* REG_CC_SETTER and REG_CC_USER link a pair of insns that set and use CC0,
612      respectively.  Normally, these are required to be consecutive insns, but
613      we permit putting a cc0-setting insn in the delay slot of a branch as
614      long as only one copy of the insn exists.  In that case, these notes
615      point from one to the other to allow code generation to determine what
616      any require information and to properly update CC_STATUS.  These notes
617      are INSN_LISTs.  */
618   REG_CC_SETTER, REG_CC_USER,
619
620   /* Points to a CODE_LABEL.  Used by non-JUMP_INSNs to say that the
621      CODE_LABEL contained in the REG_LABEL note is used by the insn. 
622      This note is an INSN_LIST.  */
623   REG_LABEL,
624
625   /* REG_DEP_ANTI and REG_DEP_OUTPUT are used in LOG_LINKS to represent
626      write-after-read and write-after-write dependencies respectively.
627      Data dependencies, which are the only type of LOG_LINK created by
628      flow, are represented by a 0 reg note kind.  */
629   REG_DEP_ANTI, REG_DEP_OUTPUT,
630
631   /* REG_BR_PROB is attached to JUMP_INSNs and CALL_INSNs.
632      It has an integer value.  For jumps, it is the probability that this is a
633      taken branch.  For calls, it is the probability that this call won't
634      return.  */
635   REG_BR_PROB,
636
637   /* REG_EXEC_COUNT is attached to the first insn of each basic block, and
638      the first insn after each CALL_INSN.  It indicates how many times this
639      block was executed.  */
640   REG_EXEC_COUNT,
641
642   /* Attached to a call insn; indicates that the call is malloc-like and
643      that the pointer returned cannot alias anything else.  */
644   REG_NOALIAS,
645
646   /* Used to optimize rtl generated by dynamic stack allocations for targets
647      where SETJMP_VIA_SAVE_AREA is true.  */
648   REG_SAVE_AREA,
649
650   /* REG_BR_PRED is attached to JUMP_INSNs and CALL_INSNSs.  It contains
651      CONCAT of two integer value.  First specifies the branch predictor
652      that added the note, second specifies the predicted hitrate of branch
653      in the same format as REG_BR_PROB note uses.  */
654   REG_BR_PRED,
655
656   /* Attached to insns that are RTX_FRAME_RELATED_P, but are too complex
657      for DWARF to interpret what they imply.  The attached rtx is used
658      instead of intuition.  */
659   REG_FRAME_RELATED_EXPR,
660
661   /* Indicates that REG holds the exception context for the function.
662      This context is shared by inline functions, so the code to acquire
663      the real exception context is delayed until after inlining.  */
664   REG_EH_CONTEXT,
665
666   /* Indicates what exception region an INSN belongs in.  This is used to
667      indicate what region to which a call may throw.  REGION 0 indicates
668      that a call cannot throw at all.  REGION -1 indicates that it cannot
669      throw, nor will it execute a non-local goto.  */
670   REG_EH_REGION,
671
672   /* Used by haifa-sched to save NOTE_INSN notes across scheduling.  */
673   REG_SAVE_NOTE,
674
675   /* Indicates that this insn (which is part of the prologue) computes
676      a value which might not be used later, and if so it's OK to delete
677      the insn.  Normally, deleting any insn in the prologue is an error. 
678      At present the parameter is unused and set to (const_int 0).  */
679   REG_MAYBE_DEAD,
680
681   /* Indicates that a call does not return.  */
682   REG_NORETURN,
683
684   /* Indicates that an indirect jump is a non-local goto instead of a 
685      computed goto.  */
686   REG_NON_LOCAL_GOTO,
687
688   /* This kind of note is generated at each to `setjmp',
689      and similar functions that can return twice.  */
690   REG_SETJMP,
691
692   /* Indicate calls that always returns.  */
693   REG_ALWAYS_RETURN,
694
695   /* Indicate that the memory load references a vtable.  The expression
696      is of the form (plus (symbol_ref vtable_sym) (const_int offset)).  */
697   REG_VTABLE_REF
698 };
699
700 /* The base value for branch probability notes.  */
701 #define REG_BR_PROB_BASE  10000
702
703 /* Define macros to extract and insert the reg-note kind in an EXPR_LIST.  */
704 #define REG_NOTE_KIND(LINK) ((enum reg_note) GET_MODE (LINK))
705 #define PUT_REG_NOTE_KIND(LINK, KIND) \
706   PUT_MODE (LINK, (enum machine_mode) (KIND))
707
708 /* Names for REG_NOTE's in EXPR_LIST insn's.  */
709
710 extern const char * const reg_note_name[];
711 #define GET_REG_NOTE_NAME(MODE) (reg_note_name[(int) (MODE)])
712
713 /* This field is only present on CALL_INSNs.  It holds a chain of EXPR_LIST of
714    USE and CLOBBER expressions.
715      USE expressions list the registers filled with arguments that
716    are passed to the function.
717      CLOBBER expressions document the registers explicitly clobbered
718    by this CALL_INSN.
719      Pseudo registers can not be mentioned in this list.  */
720 #define CALL_INSN_FUNCTION_USAGE(INSN)  XEXP(INSN, 7)
721
722 /* The label-number of a code-label.  The assembler label
723    is made from `L' and the label-number printed in decimal.
724    Label numbers are unique in a compilation.  */
725 #define CODE_LABEL_NUMBER(INSN) XINT (INSN, 5)
726
727 #define LINE_NUMBER NOTE
728
729 /* In a NOTE that is a line number, this is a string for the file name that the
730    line is in.  We use the same field to record block numbers temporarily in
731    NOTE_INSN_BLOCK_BEG and NOTE_INSN_BLOCK_END notes.  (We avoid lots of casts
732    between ints and pointers if we use a different macro for the block number.)
733    The NOTE_INSN_RANGE_{START,END} and NOTE_INSN_LIVE notes record their
734    information as an rtx in the field.  */
735
736 #define NOTE_SOURCE_FILE(INSN)  XCSTR (INSN, 3, NOTE)
737 #define NOTE_BLOCK(INSN)        XCTREE (INSN, 3, NOTE)
738 #define NOTE_EH_HANDLER(INSN)   XCINT (INSN, 3, NOTE)
739 #define NOTE_RANGE_INFO(INSN)   XCEXP (INSN, 3, NOTE)
740 #define NOTE_LIVE_INFO(INSN)    XCEXP (INSN, 3, NOTE)
741 #define NOTE_BASIC_BLOCK(INSN)  XCBBDEF (INSN, 3, NOTE)
742 #define NOTE_EXPECTED_VALUE(INSN) XCEXP (INSN, 3, NOTE)
743
744 /* In a NOTE that is a line number, this is the line number.
745    Other kinds of NOTEs are identified by negative numbers here.  */
746 #define NOTE_LINE_NUMBER(INSN) XCINT (INSN, 4, NOTE)
747
748 /* Nonzero if INSN is a note marking the beginning of a basic block.  */
749 #define NOTE_INSN_BASIC_BLOCK_P(INSN)                   \
750   (GET_CODE (INSN) == NOTE                              \
751    && NOTE_LINE_NUMBER (INSN) == NOTE_INSN_BASIC_BLOCK)
752
753 /* Codes that appear in the NOTE_LINE_NUMBER field
754    for kinds of notes that are not line numbers.
755
756    Notice that we do not try to use zero here for any of
757    the special note codes because sometimes the source line
758    actually can be zero!  This happens (for example) when we
759    are generating code for the per-translation-unit constructor
760    and destructor routines for some C++ translation unit.
761
762    If you should change any of the following values, or if you
763    should add a new value here, don't forget to change the
764    note_insn_name array in rtl.c.  */
765
766 enum insn_note
767 {
768   /* Keep all of these numbers negative.  Adjust as needed.  */
769   NOTE_INSN_BIAS = -100,
770
771   /* This note is used to get rid of an insn
772      when it isn't safe to patch the insn out of the chain.  */
773   NOTE_INSN_DELETED,
774
775   /* These are used to mark the beginning and end of a lexical block.
776      See NOTE_BLOCK, identify_blocks and reorder_blocks.  */
777   NOTE_INSN_BLOCK_BEG,
778   NOTE_INSN_BLOCK_END,
779
780   /* These mark the extremes of a loop.  */
781   NOTE_INSN_LOOP_BEG,
782   NOTE_INSN_LOOP_END,
783
784   /* Generated at the place in a loop that `continue' jumps to.  */
785   NOTE_INSN_LOOP_CONT,
786   /* Generated at the start of a duplicated exit test.  */
787   NOTE_INSN_LOOP_VTOP,
788
789   /* Generated at the end of a conditional at the top of the loop.
790      This is used to perform a lame form of loop rotation in lieu
791      of actually understanding the loop structure.  The note is
792      discarded after rotation is complete.  */
793   NOTE_INSN_LOOP_END_TOP_COND,
794
795   /* This kind of note is generated at the end of the function body,
796      just before the return insn or return label.  In an optimizing
797      compilation it is deleted by the first jump optimization, after
798      enabling that optimizer to determine whether control can fall
799      off the end of the function body without a return statement.  */
800   NOTE_INSN_FUNCTION_END,
801
802   /* This marks the point immediately after the last prologue insn.  */
803   NOTE_INSN_PROLOGUE_END,
804
805   /* This marks the point immediately prior to the first epilogue insn.  */
806   NOTE_INSN_EPILOGUE_BEG,
807
808   /* Generated in place of user-declared labels when they are deleted.  */
809   NOTE_INSN_DELETED_LABEL,
810
811   /* This note indicates the start of the real body of the function,
812      i.e. the point just after all of the parms have been moved into
813      their homes, etc.  */
814   NOTE_INSN_FUNCTION_BEG,
815
816   /* These note where exception handling regions begin and end. 
817      Uses NOTE_EH_HANDLER to identify the region in question.  */
818   NOTE_INSN_EH_REGION_BEG,
819   NOTE_INSN_EH_REGION_END,
820
821   /* Generated whenever a duplicate line number note is output.  For example,
822      one is output after the end of an inline function, in order to prevent
823      the line containing the inline call from being counted twice in gcov.  */
824   NOTE_INSN_REPEATED_LINE_NUMBER,
825
826   /* Start/end of a live range region, where pseudos allocated on the stack
827      can be allocated to temporary registers.  Uses NOTE_RANGE_INFO.  */
828   NOTE_INSN_RANGE_BEG,
829   NOTE_INSN_RANGE_END,
830
831   /* Record which registers are currently live.  Uses NOTE_LIVE_INFO.  */
832   NOTE_INSN_LIVE,
833
834   /* Record the struct for the following basic block.  Uses NOTE_BASIC_BLOCK.  */
835   NOTE_INSN_BASIC_BLOCK,
836
837   /* Record the expected value of a register at a location.  Uses
838      NOTE_EXPECTED_VALUE; stored as (eq (reg) (const_int)).  */
839   NOTE_INSN_EXPECTED_VALUE,
840
841   NOTE_INSN_MAX
842 };
843
844 /* Names for NOTE insn's other than line numbers.  */
845
846 extern const char * const note_insn_name[NOTE_INSN_MAX - NOTE_INSN_BIAS];
847 #define GET_NOTE_INSN_NAME(NOTE_CODE) \
848   (note_insn_name[(NOTE_CODE) - (int) NOTE_INSN_BIAS])
849
850 /* The name of a label, in case it corresponds to an explicit label
851    in the input source code.  */
852 #define LABEL_NAME(RTX) XCSTR (RTX, 6, CODE_LABEL)
853
854 /* In jump.c, each label contains a count of the number
855    of LABEL_REFs that point at it, so unused labels can be deleted.  */
856 #define LABEL_NUSES(RTX) XCINT (RTX, 3, CODE_LABEL)
857
858 /* Associate a name with a CODE_LABEL.  */
859 #define LABEL_ALTERNATE_NAME(RTX) XCSTR (RTX, 7, CODE_LABEL)
860
861 /* The original regno this ADDRESSOF was built for.  */
862 #define ADDRESSOF_REGNO(RTX) XCUINT (RTX, 1, ADDRESSOF)
863
864 /* The variable in the register we took the address of.  */
865 #define ADDRESSOF_DECL(RTX) XCTREE (RTX, 2, ADDRESSOF)
866
867 /* In jump.c, each JUMP_INSN can point to a label that it can jump to,
868    so that if the JUMP_INSN is deleted, the label's LABEL_NUSES can
869    be decremented and possibly the label can be deleted.  */
870 #define JUMP_LABEL(INSN)   XCEXP (INSN, 7, JUMP_INSN)
871
872 /* Once basic blocks are found in flow.c,
873    each CODE_LABEL starts a chain that goes through
874    all the LABEL_REFs that jump to that label.
875    The chain eventually winds up at the CODE_LABEL: it is circular.  */
876 #define LABEL_REFS(LABEL) XCEXP (LABEL, 4, CODE_LABEL)
877 \f
878 /* This is the field in the LABEL_REF through which the circular chain
879    of references to a particular label is linked.
880    This chain is set up in flow.c.  */
881
882 #define LABEL_NEXTREF(REF) XCEXP (REF, 1, LABEL_REF)
883
884 /* Once basic blocks are found in flow.c,
885    Each LABEL_REF points to its containing instruction with this field.  */
886
887 #define CONTAINING_INSN(RTX) XCEXP (RTX, 2, LABEL_REF)
888
889 /* For a REG rtx, REGNO extracts the register number.  ORIGINAL_REGNO holds
890    the number the register originally had; for a pseudo register turned into
891    a hard reg this will hold the old pseudo register number.  */
892
893 #define REGNO(RTX) XCUINT (RTX, 0, REG)
894 #define ORIGINAL_REGNO(RTX) X0UINT (RTX, 1)
895
896 /* For a REG rtx, REG_FUNCTION_VALUE_P is nonzero if the reg
897    is the current function's return value.  */
898
899 #define REG_FUNCTION_VALUE_P(RTX) (RTL_FLAG_CHECK1((RTX), REG)->integrated)
900
901 /* 1 in a REG rtx if it corresponds to a variable declared by the user.  */
902 #define REG_USERVAR_P(RTX) (RTL_FLAG_CHECK1((RTX), REG)->volatil)
903
904 /* 1 in a REG rtx if the register is a pointer.  */
905 #define REG_POINTER(RTX) (RTL_FLAG_CHECK1((RTX), REG)->frame_related)
906
907 /* 1 if the given register REG corresponds to a hard register.  */
908 #define HARD_REGISTER_P(REG) (HARD_REGISTER_NUM_P (REGNO (REG)))
909
910 /* 1 if the given register number REG_NO corresponds to a hard register.  */
911 #define HARD_REGISTER_NUM_P(REG_NO) ((REG_NO) < FIRST_PSEUDO_REGISTER)
912
913 /* For a CONST_INT rtx, INTVAL extracts the integer.  */
914
915 #define INTVAL(RTX) XCWINT(RTX, 0, CONST_INT)
916
917 /* For a CONST_DOUBLE:
918    The usual two ints that hold the value.
919    For a DImode, that is all there are;
920     and CONST_DOUBLE_LOW is the low-order word and ..._HIGH the high-order.
921    For a float, the number of ints varies,
922     and CONST_DOUBLE_LOW is the one that should come first *in memory*.
923     So use &CONST_DOUBLE_LOW(r) as the address of an array of ints.  */
924 #define CONST_DOUBLE_LOW(r) XCWINT (r, 1, CONST_DOUBLE)
925 #define CONST_DOUBLE_HIGH(r) XCWINT (r, 2, CONST_DOUBLE)
926
927 /* Link for chain of all CONST_DOUBLEs in use in current function.  */
928 #define CONST_DOUBLE_CHAIN(r) XCEXP (r, 0, CONST_DOUBLE)
929
930 /* For a CONST_VECTOR, return element #n.  */
931 #define CONST_VECTOR_ELT(RTX, N) XCVECEXP (RTX, 0, N, CONST_VECTOR)
932
933 /* For a CONST_VECTOR, return the number of elements in a vector.  */
934 #define CONST_VECTOR_NUNITS(RTX) XCVECLEN (RTX, 0, CONST_VECTOR)
935
936 /* For a SUBREG rtx, SUBREG_REG extracts the value we want a subreg of.
937    SUBREG_BYTE extracts the byte-number.  */
938
939 #define SUBREG_REG(RTX) XCEXP (RTX, 0, SUBREG)
940 #define SUBREG_BYTE(RTX) XCUINT (RTX, 1, SUBREG)
941
942 /* in rtlanal.c */
943 extern unsigned int subreg_lsb          PARAMS ((rtx));
944 extern unsigned int subreg_regno_offset         PARAMS ((unsigned int, 
945                                                          enum machine_mode, 
946                                                          unsigned int, 
947                                                          enum machine_mode));
948 extern unsigned int subreg_regno        PARAMS ((rtx));
949
950 /* 1 if the REG contained in SUBREG_REG is already known to be
951    sign- or zero-extended from the mode of the SUBREG to the mode of
952    the reg.  SUBREG_PROMOTED_UNSIGNED_P gives the signedness of the
953    extension.
954
955    When used as a LHS, is means that this extension must be done
956    when assigning to SUBREG_REG.  */
957
958 #define SUBREG_PROMOTED_VAR_P(RTX) (RTL_FLAG_CHECK1((RTX), SUBREG)->in_struct)
959 #define SUBREG_PROMOTED_UNSIGNED_SET(RTX, VAL)  \
960 do {                                            \
961   RTL_FLAG_CHECK1((RTX), SUBREG);               \
962   if ((VAL) < 0)                                \
963     (RTX)->volatil = 1;                         \
964   else {                                        \
965     (RTX)->volatil = 0;                         \
966     (RTX)->unchanging = (VAL);                  \
967   }                                             \
968 } while (0)
969 #define SUBREG_PROMOTED_UNSIGNED_P(RTX) \
970   ((RTL_FLAG_CHECK1((RTX), SUBREG)->volatil) ? -1 : (RTX)->unchanging)
971
972 /* Access various components of an ASM_OPERANDS rtx.  */
973
974 #define ASM_OPERANDS_TEMPLATE(RTX) XCSTR (RTX, 0, ASM_OPERANDS)
975 #define ASM_OPERANDS_OUTPUT_CONSTRAINT(RTX) XCSTR (RTX, 1, ASM_OPERANDS)
976 #define ASM_OPERANDS_OUTPUT_IDX(RTX) XCINT (RTX, 2, ASM_OPERANDS)
977 #define ASM_OPERANDS_INPUT_VEC(RTX) XCVEC (RTX, 3, ASM_OPERANDS)
978 #define ASM_OPERANDS_INPUT_CONSTRAINT_VEC(RTX) XCVEC (RTX, 4, ASM_OPERANDS)
979 #define ASM_OPERANDS_INPUT(RTX, N) XCVECEXP (RTX, 3, N, ASM_OPERANDS)
980 #define ASM_OPERANDS_INPUT_LENGTH(RTX) XCVECLEN (RTX, 3, ASM_OPERANDS)
981 #define ASM_OPERANDS_INPUT_CONSTRAINT_EXP(RTX, N) \
982   XCVECEXP (RTX, 4, N, ASM_OPERANDS)
983 #define ASM_OPERANDS_INPUT_CONSTRAINT(RTX, N) \
984   XSTR (XCVECEXP (RTX, 4, N, ASM_OPERANDS), 0)
985 #define ASM_OPERANDS_INPUT_MODE(RTX, N)  \
986   GET_MODE (XCVECEXP (RTX, 4, N, ASM_OPERANDS))
987 #define ASM_OPERANDS_SOURCE_FILE(RTX) XCSTR (RTX, 5, ASM_OPERANDS)
988 #define ASM_OPERANDS_SOURCE_LINE(RTX) XCINT (RTX, 6, ASM_OPERANDS)
989
990 /* For a MEM RTX, 1 if we should keep the alias set for this mem
991    unchanged when we access a component.  Set to 1, or example, when we
992    are already in a non-addressable component of an aggregate.  */
993 #define MEM_KEEP_ALIAS_SET_P(RTX) (RTL_FLAG_CHECK1((RTX), MEM)->jump)
994
995 /* For a MEM rtx, 1 if it's a volatile reference.
996    Also in an ASM_OPERANDS rtx.  */
997 #define MEM_VOLATILE_P(RTX) (RTL_FLAG_CHECK2((RTX), MEM, ASM_OPERANDS)->volatil)
998
999 /* For a MEM rtx, 1 if it refers to an aggregate, either to the
1000    aggregate itself of to a field of the aggregate.  If zero, RTX may
1001    or may not be such a reference.  */
1002 #define MEM_IN_STRUCT_P(RTX) (RTL_FLAG_CHECK1((RTX), MEM)->in_struct)
1003
1004 /* For a MEM rtx, 1 if it refers to a scalar.  If zero, RTX may or may
1005    not refer to a scalar.  */
1006 #define MEM_SCALAR_P(RTX) (RTL_FLAG_CHECK1((RTX), MEM)->frame_related)
1007
1008 /* If VAL is non-zero, set MEM_IN_STRUCT_P and clear MEM_SCALAR_P in
1009    RTX.  Otherwise, vice versa.  Use this macro only when you are
1010    *sure* that you know that the MEM is in a structure, or is a
1011    scalar.  VAL is evaluated only once.  */
1012 #define MEM_SET_IN_STRUCT_P(RTX, VAL)           \
1013 do {                                            \
1014   if (VAL)                                      \
1015     {                                           \
1016       MEM_IN_STRUCT_P (RTX) = 1;                \
1017       MEM_SCALAR_P (RTX) = 0;                   \
1018     }                                           \
1019   else                                          \
1020     {                                           \
1021       MEM_IN_STRUCT_P (RTX) = 0;                \
1022       MEM_SCALAR_P (RTX) = 1;                   \
1023     }                                           \
1024 } while (0)
1025
1026 /* The memory attribute block.  We provide access macros for each value
1027    in the block and provide defaults if none specified.  */
1028 #define MEM_ATTRS(RTX) X0MEMATTR (RTX, 1)
1029
1030 /* For a MEM rtx, the alias set.  If 0, this MEM is not in any alias
1031    set, and may alias anything.  Otherwise, the MEM can only alias
1032    MEMs in the same alias set.  This value is set in a
1033    language-dependent manner in the front-end, and should not be
1034    altered in the back-end.  These set numbers are tested for zero,
1035    and compared for equality; they have no other significance.  In
1036    some front-ends, these numbers may correspond in some way to types,
1037    or other language-level entities, but they need not, and the
1038    back-end makes no such assumptions.  */
1039 #define MEM_ALIAS_SET(RTX) (MEM_ATTRS (RTX) == 0 ? 0 : MEM_ATTRS (RTX)->alias)
1040
1041 /* For a MEM rtx, the decl it is known to refer to, if it is known to
1042    refer to part of a DECL.  It may also be a COMPONENT_REF.  */
1043 #define MEM_EXPR(RTX) (MEM_ATTRS (RTX) == 0 ? 0 : MEM_ATTRS (RTX)->expr)
1044
1045 /* For a MEM rtx, the offset from the start of MEM_EXPR, if known, as a
1046    RTX that is always a CONST_INT.  */
1047 #define MEM_OFFSET(RTX) (MEM_ATTRS (RTX) == 0 ? 0 : MEM_ATTRS (RTX)->offset)
1048
1049 /* For a MEM rtx, the size in bytes of the MEM, if known, as an RTX that
1050    is always a CONST_INT.  */
1051 #define MEM_SIZE(RTX)                                                   \
1052 (MEM_ATTRS (RTX) != 0 ? MEM_ATTRS (RTX)->size                           \
1053  : GET_MODE (RTX) != BLKmode ? GEN_INT (GET_MODE_SIZE (GET_MODE (RTX))) \
1054  : 0)
1055
1056 /* For a MEM rtx, the alignment in bits.  We can use the alignment of the
1057    mode as a default when STRICT_ALIGNMENT, but not if not.  */
1058 #define MEM_ALIGN(RTX)                                                  \
1059 (MEM_ATTRS (RTX) != 0 ? MEM_ATTRS (RTX)->align                          \
1060  : (STRICT_ALIGNMENT && GET_MODE (RTX) != BLKmode                       \
1061     ? GET_MODE_ALIGNMENT (GET_MODE (RTX)) : BITS_PER_UNIT))
1062
1063 /* Copy the attributes that apply to memory locations from RHS to LHS.  */
1064 #define MEM_COPY_ATTRIBUTES(LHS, RHS)                           \
1065   (MEM_VOLATILE_P (LHS) = MEM_VOLATILE_P (RHS),                 \
1066    MEM_IN_STRUCT_P (LHS) = MEM_IN_STRUCT_P (RHS),               \
1067    MEM_SCALAR_P (LHS) = MEM_SCALAR_P (RHS),                     \
1068    RTX_UNCHANGING_P (LHS) = RTX_UNCHANGING_P (RHS),             \
1069    MEM_KEEP_ALIAS_SET_P (LHS) = MEM_KEEP_ALIAS_SET_P (RHS),     \
1070    MEM_ATTRS (LHS) = MEM_ATTRS (RHS))
1071
1072 /* For a LABEL_REF, 1 means that this reference is to a label outside the
1073    loop containing the reference.  */
1074 #define LABEL_OUTSIDE_LOOP_P(RTX) (RTL_FLAG_CHECK1((RTX), LABEL_REF)->in_struct)
1075
1076 /* For a LABEL_REF, 1 means it is for a nonlocal label.  */
1077 /* Likewise in an EXPR_LIST for a REG_LABEL note.  */
1078 #define LABEL_REF_NONLOCAL_P(RTX)       \
1079   (RTL_FLAG_CHECK2((RTX), LABEL_REF, REG_LABEL)->volatil)
1080
1081 /* For a CODE_LABEL, 1 means always consider this label to be needed.  */
1082 #define LABEL_PRESERVE_P(RTX) \
1083   (RTL_FLAG_CHECK2((RTX), CODE_LABEL, NOTE)->in_struct)
1084
1085 /* For a REG, 1 means the register is used only in an exit test of a loop.  */
1086 #define REG_LOOP_TEST_P(RTX) (RTL_FLAG_CHECK1((RTX), REG)->in_struct)
1087
1088 /* During sched, for an insn, 1 means that the insn must be scheduled together
1089    with the preceding insn.  */
1090 #define SCHED_GROUP_P(RTX)      \
1091   (RTL_FLAG_CHECK6((RTX), INSN, JUMP_INSN, CALL_INSN, CODE_LABEL, \
1092                           BARRIER, NOTE)->in_struct)
1093
1094 /* For a SET rtx, SET_DEST is the place that is set
1095    and SET_SRC is the value it is set to.  */
1096 #define SET_DEST(RTX) XC2EXP(RTX, 0, SET, CLOBBER)
1097 #define SET_SRC(RTX) XCEXP(RTX, 1, SET)
1098 #define SET_IS_RETURN_P(RTX) (RTL_FLAG_CHECK1((RTX), SET)->jump)
1099
1100 /* For a TRAP_IF rtx, TRAP_CONDITION is an expression.  */
1101 #define TRAP_CONDITION(RTX) XCEXP (RTX, 0, TRAP_IF)
1102 #define TRAP_CODE(RTX) XCEXP (RTX, 1, TRAP_IF)
1103
1104 /* For a COND_EXEC rtx, COND_EXEC_TEST is the condition to base
1105    conditionally executing the code on, COND_EXEC_CODE is the code
1106    to execute if the condition is true.  */
1107 #define COND_EXEC_TEST(RTX) XCEXP (RTX, 0, COND_EXEC)
1108 #define COND_EXEC_CODE(RTX) XCEXP (RTX, 1, COND_EXEC)
1109
1110 /* 1 in a SYMBOL_REF if it addresses this function's constants pool.  */
1111 #define CONSTANT_POOL_ADDRESS_P(RTX)    \
1112   (RTL_FLAG_CHECK1((RTX), SYMBOL_REF)->unchanging)
1113
1114 /* 1 in a SYMBOL_REF if it addresses this function's string constant pool.  */
1115 #define STRING_POOL_ADDRESS_P(RTX)      \
1116   (RTL_FLAG_CHECK1((RTX), SYMBOL_REF)->frame_related)
1117
1118 /* Flag in a SYMBOL_REF for machine-specific purposes.  */
1119 #define SYMBOL_REF_FLAG(RTX) (RTL_FLAG_CHECK1((RTX), SYMBOL_REF)->volatil)
1120
1121 /* 1 means a SYMBOL_REF has been the library function in emit_library_call.  */
1122 #define SYMBOL_REF_USED(RTX) (RTL_FLAG_CHECK1((RTX), SYMBOL_REF)->used)
1123
1124 /* 1 means a SYMBOL_REF is weak.  */
1125 #define SYMBOL_REF_WEAK(RTX) (RTL_FLAG_CHECK1((RTX), SYMBOL_REF)->integrated)
1126
1127 /* Define a macro to look for REG_INC notes,
1128    but save time on machines where they never exist.  */
1129
1130 /* Don't continue this line--convex cc version 4.1 would lose.  */
1131 #if (defined (HAVE_PRE_INCREMENT) || defined (HAVE_PRE_DECREMENT) || defined (HAVE_POST_INCREMENT) || defined (HAVE_POST_DECREMENT))
1132 #define FIND_REG_INC_NOTE(INSN, REG)                    \
1133   ((REG) != NULL_RTX && REG_P ((REG))                   \
1134    ? find_regno_note ((INSN), REG_INC, REGNO (REG))     \
1135    : find_reg_note ((INSN), REG_INC, (REG)))
1136 #else
1137 #define FIND_REG_INC_NOTE(INSN, REG) 0
1138 #endif
1139
1140 /* Indicate whether the machine has any sort of auto increment addressing.
1141    If not, we can avoid checking for REG_INC notes.  */
1142
1143 /* Don't continue this line--convex cc version 4.1 would lose.  */
1144 #if (defined (HAVE_PRE_INCREMENT) || defined (HAVE_PRE_DECREMENT) || defined (HAVE_POST_INCREMENT) || defined (HAVE_POST_DECREMENT))
1145 #define AUTO_INC_DEC
1146 #endif
1147
1148 #ifndef HAVE_PRE_INCREMENT
1149 #define HAVE_PRE_INCREMENT 0
1150 #endif
1151
1152 #ifndef HAVE_PRE_DECREMENT
1153 #define HAVE_PRE_DECREMENT 0
1154 #endif
1155
1156 #ifndef HAVE_POST_INCREMENT
1157 #define HAVE_POST_INCREMENT 0
1158 #endif
1159
1160 #ifndef HAVE_POST_DECREMENT
1161 #define HAVE_POST_DECREMENT 0
1162 #endif
1163
1164 #ifndef HAVE_POST_MODIFY_DISP
1165 #define HAVE_POST_MODIFY_DISP 0
1166 #endif
1167
1168 #ifndef HAVE_POST_MODIFY_REG
1169 #define HAVE_POST_MODIFY_REG 0
1170 #endif
1171
1172 #ifndef HAVE_PRE_MODIFY_DISP
1173 #define HAVE_PRE_MODIFY_DISP 0
1174 #endif
1175
1176 #ifndef HAVE_PRE_MODIFY_REG
1177 #define HAVE_PRE_MODIFY_REG 0
1178 #endif
1179
1180
1181 /* Some architectures do not have complete pre/post increment/decrement
1182    instruction sets, or only move some modes efficiently.  These macros
1183    allow us to tune autoincrement generation.  */
1184
1185 #ifndef USE_LOAD_POST_INCREMENT
1186 #define USE_LOAD_POST_INCREMENT(MODE)   HAVE_POST_INCREMENT
1187 #endif
1188
1189 #ifndef USE_LOAD_POST_DECREMENT
1190 #define USE_LOAD_POST_DECREMENT(MODE)   HAVE_POST_DECREMENT
1191 #endif
1192
1193 #ifndef USE_LOAD_PRE_INCREMENT
1194 #define USE_LOAD_PRE_INCREMENT(MODE)    HAVE_PRE_INCREMENT
1195 #endif
1196
1197 #ifndef USE_LOAD_PRE_DECREMENT
1198 #define USE_LOAD_PRE_DECREMENT(MODE)    HAVE_PRE_DECREMENT
1199 #endif
1200
1201 #ifndef USE_STORE_POST_INCREMENT
1202 #define USE_STORE_POST_INCREMENT(MODE)  HAVE_POST_INCREMENT
1203 #endif
1204
1205 #ifndef USE_STORE_POST_DECREMENT
1206 #define USE_STORE_POST_DECREMENT(MODE)  HAVE_POST_DECREMENT
1207 #endif
1208
1209 #ifndef USE_STORE_PRE_INCREMENT
1210 #define USE_STORE_PRE_INCREMENT(MODE)   HAVE_PRE_INCREMENT
1211 #endif
1212
1213 #ifndef USE_STORE_PRE_DECREMENT
1214 #define USE_STORE_PRE_DECREMENT(MODE)   HAVE_PRE_DECREMENT
1215 #endif
1216
1217
1218 /* Accessors for RANGE_INFO.  */
1219 /* For RANGE_{START,END} notes return the RANGE_START note.  */
1220 #define RANGE_INFO_NOTE_START(INSN) XCEXP (INSN, 0, RANGE_INFO)
1221
1222 /* For RANGE_{START,END} notes return the RANGE_START note.  */
1223 #define RANGE_INFO_NOTE_END(INSN) XCEXP (INSN, 1, RANGE_INFO)
1224
1225 /* For RANGE_{START,END} notes, return the vector containing the registers used
1226    in the range.  */
1227 #define RANGE_INFO_REGS(INSN) XCVEC (INSN, 2, RANGE_INFO)
1228 #define RANGE_INFO_REGS_REG(INSN, N) XCVECEXP (INSN, 2, N, RANGE_INFO)
1229 #define RANGE_INFO_NUM_REGS(INSN) XCVECLEN (INSN, 2, RANGE_INFO)
1230
1231 /* For RANGE_{START,END} notes, the number of calls within the range.  */
1232 #define RANGE_INFO_NCALLS(INSN) XCINT (INSN, 3, RANGE_INFO)
1233
1234 /* For RANGE_{START,END} notes, the number of insns within the range.  */
1235 #define RANGE_INFO_NINSNS(INSN) XCINT (INSN, 4, RANGE_INFO)
1236
1237 /* For RANGE_{START,END} notes, a unique # to identify this range.  */
1238 #define RANGE_INFO_UNIQUE(INSN) XCINT (INSN, 5, RANGE_INFO)
1239
1240 /* For RANGE_{START,END} notes, the basic block # the range starts with.  */
1241 #define RANGE_INFO_BB_START(INSN) XCINT (INSN, 6, RANGE_INFO)
1242
1243 /* For RANGE_{START,END} notes, the basic block # the range ends with.  */
1244 #define RANGE_INFO_BB_END(INSN) XCINT (INSN, 7, RANGE_INFO)
1245
1246 /* For RANGE_{START,END} notes, the loop depth the range is in.  */
1247 #define RANGE_INFO_LOOP_DEPTH(INSN) XCINT (INSN, 8, RANGE_INFO)
1248
1249 /* For RANGE_{START,END} notes, the bitmap of live registers at the start
1250    of the range.  */
1251 #define RANGE_INFO_LIVE_START(INSN) XCBITMAP (INSN, 9, RANGE_INFO)
1252
1253 /* For RANGE_{START,END} notes, the bitmap of live registers at the end
1254    of the range.  */
1255 #define RANGE_INFO_LIVE_END(INSN) XCBITMAP (INSN, 10, RANGE_INFO)
1256
1257 /* For RANGE_START notes, the marker # of the start of the range.  */
1258 #define RANGE_INFO_MARKER_START(INSN) XCINT (INSN, 11, RANGE_INFO)
1259
1260 /* For RANGE_START notes, the marker # of the end of the range.  */
1261 #define RANGE_INFO_MARKER_END(INSN) XCINT (INSN, 12, RANGE_INFO)
1262
1263 /* Original pseudo register # for a live range note.  */
1264 #define RANGE_REG_PSEUDO(INSN,N) XCINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 0, REG)
1265
1266 /* Pseudo register # original register is copied into or -1.  */
1267 #define RANGE_REG_COPY(INSN,N) XCINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 1, REG)
1268
1269 /* How many times a register in a live range note was referenced.  */
1270 #define RANGE_REG_REFS(INSN,N) XINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 2)
1271
1272 /* How many times a register in a live range note was set.  */
1273 #define RANGE_REG_SETS(INSN,N) XINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 3)
1274
1275 /* How many times a register in a live range note died.  */
1276 #define RANGE_REG_DEATHS(INSN,N) XINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 4)
1277
1278 /* Whether the original value is needed to be copied into the range register at
1279    the start of the range.  */
1280 #define RANGE_REG_COPY_FLAGS(INSN,N) XINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 5)
1281
1282 /* # of insns the register copy is live over.  */
1283 #define RANGE_REG_LIVE_LENGTH(INSN,N) XINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 6)
1284
1285 /* # of calls the register copy is live over.  */
1286 #define RANGE_REG_N_CALLS(INSN,N) XINT (XCVECEXP (INSN, 2, N, RANGE_INFO), 7)
1287
1288 /* DECL_NODE pointer of the declaration if the register is a user defined
1289    variable.  */
1290 #define RANGE_REG_SYMBOL_NODE(INSN,N) XTREE (XCVECEXP (INSN, 2, N, RANGE_INFO), 8)
1291
1292 /* BLOCK_NODE pointer to the block the variable is declared in if the
1293    register is a user defined variable.  */
1294 #define RANGE_REG_BLOCK_NODE(INSN,N) XTREE (XCVECEXP (INSN, 2, N, RANGE_INFO), 9)
1295
1296 /* EXPR_LIST of the distinct ranges a variable is in.  */
1297 #define RANGE_VAR_LIST(INSN) (XEXP (INSN, 0))
1298
1299 /* Block a variable is declared in.  */
1300 #define RANGE_VAR_BLOCK(INSN) (XTREE (INSN, 1))
1301
1302 /* # of distinct ranges a variable is in.  */
1303 #define RANGE_VAR_NUM(INSN) (XINT (INSN, 2))
1304
1305 /* For a NOTE_INSN_LIVE note, the registers which are currently live.  */
1306 #define RANGE_LIVE_BITMAP(INSN) (XBITMAP (INSN, 0))
1307
1308 /* For a NOTE_INSN_LIVE note, the original basic block number.  */
1309 #define RANGE_LIVE_ORIG_BLOCK(INSN) (XINT (INSN, 1))
1310
1311 /* Determine if the insn is a PHI node.  */
1312 #define PHI_NODE_P(X)                           \
1313   ((X) && GET_CODE (X) == INSN                  \
1314    && GET_CODE (PATTERN (X)) == SET             \
1315    && GET_CODE (SET_SRC (PATTERN (X))) == PHI)
1316 \f
1317 /* Nonzero if we need to distinguish between the return value of this function
1318    and the return value of a function called by this function.  This helps
1319    integrate.c.
1320    This is 1 until after the rtl generation pass.  */
1321 extern int rtx_equal_function_value_matters;
1322
1323 /* Nonzero when we are generating CONCATs.  */
1324 extern int generating_concat_p;
1325
1326 /* Generally useful functions.  */
1327
1328 /* In expmed.c */
1329 extern int ceil_log2                    PARAMS ((unsigned HOST_WIDE_INT));
1330
1331 #define plus_constant(X, C) plus_constant_wide ((X), (HOST_WIDE_INT) (C))
1332
1333 /* In builtins.c */
1334 extern rtx expand_builtin_expect_jump   PARAMS ((tree, rtx, rtx));
1335
1336 /* In explow.c */
1337 extern void set_stack_check_libfunc PARAMS ((rtx));
1338 extern HOST_WIDE_INT trunc_int_for_mode PARAMS ((HOST_WIDE_INT,
1339                                                enum machine_mode));
1340 extern rtx plus_constant_wide            PARAMS ((rtx, HOST_WIDE_INT));
1341 extern rtx plus_constant_for_output_wide PARAMS ((rtx, HOST_WIDE_INT));
1342 extern void optimize_save_area_alloca   PARAMS ((rtx));
1343
1344 /* In emit-rtl.c */
1345 extern rtx gen_rtx                      PARAMS ((enum rtx_code,
1346                                                  enum machine_mode, ...));
1347 extern rtvec gen_rtvec                  PARAMS ((int, ...));
1348 extern rtx copy_insn_1                  PARAMS ((rtx));
1349 extern rtx copy_insn                    PARAMS ((rtx));
1350 extern rtx gen_int_mode                 PARAMS ((HOST_WIDE_INT,
1351                                                  enum machine_mode));
1352
1353 /* In rtl.c */
1354 extern rtx rtx_alloc                    PARAMS ((RTX_CODE));
1355 extern rtvec rtvec_alloc                PARAMS ((int));
1356 extern rtx copy_rtx                     PARAMS ((rtx));
1357
1358 /* In emit-rtl.c */
1359 extern rtx copy_rtx_if_shared           PARAMS ((rtx));
1360
1361 /* In rtl.c */
1362 extern rtx copy_most_rtx                PARAMS ((rtx, rtx));
1363 extern rtx shallow_copy_rtx             PARAMS ((rtx));
1364 extern int rtx_equal_p                  PARAMS ((rtx, rtx));
1365
1366 /* In emit-rtl.c */
1367 extern rtvec gen_rtvec_v                PARAMS ((int, rtx *));
1368 extern rtx gen_reg_rtx                  PARAMS ((enum machine_mode));
1369 extern rtx gen_label_rtx                PARAMS ((void));
1370 extern int subreg_hard_regno            PARAMS ((rtx, int));
1371 extern rtx gen_lowpart_common           PARAMS ((enum machine_mode, rtx));
1372 extern rtx gen_lowpart                  PARAMS ((enum machine_mode, rtx));
1373
1374 /* In cse.c */
1375 extern rtx gen_lowpart_if_possible      PARAMS ((enum machine_mode, rtx));
1376
1377 /* In emit-rtl.c */
1378 extern rtx gen_highpart                 PARAMS ((enum machine_mode, rtx));
1379 extern rtx gen_highpart_mode            PARAMS ((enum machine_mode,
1380                                                  enum machine_mode, rtx));
1381 extern rtx gen_realpart                 PARAMS ((enum machine_mode, rtx));
1382 extern rtx gen_imagpart                 PARAMS ((enum machine_mode, rtx));
1383 extern rtx operand_subword              PARAMS ((rtx, unsigned int, int,
1384                                                  enum machine_mode));
1385 extern rtx constant_subword             PARAMS ((rtx, int,
1386                                                  enum machine_mode));
1387
1388 /* In emit-rtl.c */
1389 extern rtx operand_subword_force        PARAMS ((rtx, unsigned int,
1390                                                  enum machine_mode));
1391 extern int subreg_lowpart_p             PARAMS ((rtx));
1392 extern unsigned int subreg_lowpart_offset PARAMS ((enum machine_mode,
1393                                                    enum machine_mode));
1394 extern unsigned int subreg_highpart_offset PARAMS ((enum machine_mode,
1395                                                     enum machine_mode));
1396 extern rtx make_safe_from               PARAMS ((rtx, rtx));
1397 extern rtx convert_memory_address       PARAMS ((enum machine_mode, rtx));
1398 extern rtx get_insns                    PARAMS ((void));
1399 extern const char *get_insn_name        PARAMS ((int));
1400 extern rtx get_last_insn                PARAMS ((void));
1401 extern rtx get_last_insn_anywhere       PARAMS ((void));
1402 extern void start_sequence              PARAMS ((void));
1403 extern void push_to_sequence            PARAMS ((rtx));
1404 extern void end_sequence                PARAMS ((void));
1405 extern void push_to_full_sequence       PARAMS ((rtx, rtx));
1406 extern void end_full_sequence           PARAMS ((rtx*, rtx*));
1407 extern rtx gen_sequence                 PARAMS ((void));
1408
1409 /* In varasm.c  */
1410 extern rtx immed_double_const           PARAMS ((HOST_WIDE_INT, HOST_WIDE_INT, enum machine_mode));
1411 extern rtx mem_for_const_double         PARAMS ((rtx));
1412 extern rtx force_const_mem              PARAMS ((enum machine_mode, rtx));
1413
1414 /* In varasm.c  */
1415 extern rtx get_pool_constant            PARAMS ((rtx));
1416 extern rtx get_pool_constant_mark       PARAMS ((rtx, bool *));
1417 extern enum machine_mode get_pool_mode  PARAMS ((rtx));
1418 extern rtx get_pool_constant_for_function       PARAMS ((struct function *, rtx));
1419 extern enum machine_mode get_pool_mode_for_function     PARAMS ((struct function *, rtx));
1420 extern int get_pool_offset              PARAMS ((rtx));
1421 extern rtx simplify_subtraction         PARAMS ((rtx));
1422
1423 /* In function.c  */
1424 extern rtx assign_stack_local           PARAMS ((enum machine_mode,
1425                                                HOST_WIDE_INT, int));
1426 extern rtx assign_stack_temp            PARAMS ((enum machine_mode,
1427                                                HOST_WIDE_INT, int));
1428 extern rtx assign_stack_temp_for_type   PARAMS ((enum machine_mode,
1429                                                  HOST_WIDE_INT, int, tree));
1430 extern rtx assign_temp                  PARAMS ((tree, int, int, int));
1431 /* In emit-rtl.c */
1432 extern rtx emit_insn_before             PARAMS ((rtx, rtx));
1433 extern rtx emit_jump_insn_before        PARAMS ((rtx, rtx));
1434 extern rtx emit_call_insn_before        PARAMS ((rtx, rtx));
1435 extern rtx emit_barrier_before          PARAMS ((rtx));
1436 extern rtx emit_label_before            PARAMS ((rtx, rtx));
1437 extern rtx emit_note_before             PARAMS ((int, rtx));
1438 extern rtx emit_insn_after              PARAMS ((rtx, rtx));
1439 extern rtx emit_jump_insn_after         PARAMS ((rtx, rtx));
1440 extern rtx emit_barrier_after           PARAMS ((rtx));
1441 extern rtx emit_label_after             PARAMS ((rtx, rtx));
1442 extern rtx emit_note_after              PARAMS ((int, rtx));
1443 extern rtx emit_line_note_after         PARAMS ((const char *, int, rtx));
1444 extern rtx emit_insn                    PARAMS ((rtx));
1445 extern rtx emit_insns                   PARAMS ((rtx));
1446 extern rtx emit_insns_before            PARAMS ((rtx, rtx));
1447 extern rtx emit_insns_after             PARAMS ((rtx, rtx));
1448 extern rtx emit_jump_insn               PARAMS ((rtx));
1449 extern rtx emit_call_insn               PARAMS ((rtx));
1450 extern rtx emit_label                   PARAMS ((rtx));
1451 extern rtx emit_barrier                 PARAMS ((void));
1452 extern rtx emit_line_note               PARAMS ((const char *, int));
1453 extern rtx emit_note                    PARAMS ((const char *, int));
1454 extern rtx emit_line_note_force         PARAMS ((const char *, int));
1455 extern rtx make_insn_raw                PARAMS ((rtx));
1456 extern rtx previous_insn                PARAMS ((rtx));
1457 extern rtx next_insn                    PARAMS ((rtx));
1458 extern rtx prev_nonnote_insn            PARAMS ((rtx));
1459 extern rtx next_nonnote_insn            PARAMS ((rtx));
1460 extern rtx prev_real_insn               PARAMS ((rtx));
1461 extern rtx next_real_insn               PARAMS ((rtx));
1462 extern rtx prev_active_insn             PARAMS ((rtx));
1463 extern rtx next_active_insn             PARAMS ((rtx));
1464 extern int active_insn_p                PARAMS ((rtx));
1465 extern rtx prev_label                   PARAMS ((rtx));
1466 extern rtx next_label                   PARAMS ((rtx));
1467 extern rtx next_cc0_user                PARAMS ((rtx));
1468 extern rtx prev_cc0_setter              PARAMS ((rtx));
1469
1470 /* In jump.c */
1471 extern rtx next_nondeleted_insn         PARAMS ((rtx));
1472 extern enum rtx_code reverse_condition  PARAMS ((enum rtx_code));
1473 extern enum rtx_code reverse_condition_maybe_unordered PARAMS ((enum rtx_code));
1474 extern enum rtx_code swap_condition     PARAMS ((enum rtx_code));
1475 extern enum rtx_code unsigned_condition PARAMS ((enum rtx_code));
1476 extern enum rtx_code signed_condition   PARAMS ((enum rtx_code));
1477 extern void mark_jump_label             PARAMS ((rtx, rtx, int));
1478 extern void cleanup_barriers            PARAMS ((void));
1479
1480 /* In jump.c */
1481 extern bool squeeze_notes               PARAMS ((rtx *, rtx *));
1482 extern rtx delete_related_insns                 PARAMS ((rtx));
1483 extern void delete_jump                 PARAMS ((rtx));
1484 extern void delete_barrier              PARAMS ((rtx));
1485 extern rtx get_label_before             PARAMS ((rtx));
1486 extern rtx get_label_after              PARAMS ((rtx));
1487 extern rtx follow_jumps                 PARAMS ((rtx));
1488
1489 /* In recog.c  */
1490 extern rtx *find_constant_term_loc      PARAMS ((rtx *));
1491
1492 /* In emit-rtl.c  */
1493 extern rtx try_split                    PARAMS ((rtx, rtx, int));
1494 extern int split_branch_probability;
1495
1496 /* In unknown file  */
1497 extern rtx split_insns                  PARAMS ((rtx, rtx));
1498
1499 /* In simplify-rtx.c  */
1500 extern rtx simplify_unary_operation     PARAMS ((enum rtx_code,
1501                                                  enum machine_mode, rtx,
1502                                                  enum machine_mode));
1503 extern rtx simplify_binary_operation    PARAMS ((enum rtx_code,
1504                                                  enum machine_mode, rtx,
1505                                                  rtx));
1506 extern rtx simplify_ternary_operation   PARAMS ((enum rtx_code,
1507                                                  enum machine_mode,
1508                                                  enum machine_mode, rtx, rtx,
1509                                                  rtx));
1510 extern rtx simplify_relational_operation PARAMS ((enum rtx_code,
1511                                                   enum machine_mode, rtx,
1512                                                   rtx));
1513 extern rtx simplify_gen_binary          PARAMS ((enum rtx_code,
1514                                                  enum machine_mode,
1515                                                  rtx, rtx));
1516 extern rtx simplify_gen_unary           PARAMS ((enum rtx_code,
1517                                                  enum machine_mode, rtx,
1518                                                  enum machine_mode));
1519 extern rtx simplify_gen_ternary         PARAMS ((enum rtx_code,
1520                                                  enum machine_mode,
1521                                                  enum machine_mode,
1522                                                  rtx, rtx, rtx));
1523 extern rtx simplify_gen_relational      PARAMS ((enum rtx_code,
1524                                                  enum machine_mode,
1525                                                  enum machine_mode,
1526                                                  rtx, rtx));
1527 extern rtx simplify_subreg              PARAMS ((enum machine_mode,
1528                                                  rtx,
1529                                                  enum machine_mode,
1530                                                  unsigned int));
1531 extern rtx simplify_gen_subreg          PARAMS ((enum machine_mode,
1532                                                  rtx,
1533                                                  enum machine_mode,
1534                                                  unsigned int));
1535 extern rtx simplify_replace_rtx         PARAMS ((rtx, rtx, rtx));
1536 extern rtx simplify_rtx                 PARAMS ((rtx));
1537 extern rtx avoid_constant_pool_reference PARAMS ((rtx));
1538
1539 /* In function.c  */
1540 extern rtx gen_mem_addressof            PARAMS ((rtx, tree));
1541
1542 /* In regclass.c  */
1543 extern enum machine_mode choose_hard_reg_mode PARAMS ((unsigned int,
1544                                                        unsigned int));
1545
1546 /* In emit-rtl.c  */
1547 extern rtx set_unique_reg_note          PARAMS ((rtx, enum reg_note, rtx));
1548
1549 /* Functions in rtlanal.c */
1550
1551 /* Single set is implemented as macro for performance reasons.  */
1552 #define single_set(I) (INSN_P (I) \
1553                        ? (GET_CODE (PATTERN (I)) == SET \
1554                           ? PATTERN (I) : single_set_1 (I)) \
1555                        : NULL_RTX)
1556 #define single_set_1(I) single_set_2 (I, PATTERN (I))
1557
1558 extern int rtx_addr_can_trap_p          PARAMS ((rtx));
1559 extern int rtx_unstable_p               PARAMS ((rtx));
1560 extern int rtx_varies_p                 PARAMS ((rtx, int));
1561 extern int rtx_addr_varies_p            PARAMS ((rtx, int));
1562 extern HOST_WIDE_INT get_integer_term   PARAMS ((rtx));
1563 extern rtx get_related_value            PARAMS ((rtx));
1564 extern rtx get_jump_table_offset        PARAMS ((rtx, rtx *));
1565 extern int global_reg_mentioned_p       PARAMS ((rtx));
1566 extern int reg_mentioned_p              PARAMS ((rtx, rtx));
1567 extern int count_occurrences            PARAMS ((rtx, rtx, int));
1568 extern int reg_referenced_p             PARAMS ((rtx, rtx));
1569 extern int reg_used_between_p           PARAMS ((rtx, rtx, rtx));
1570 extern int reg_referenced_between_p     PARAMS ((rtx, rtx, rtx));
1571 extern int reg_set_between_p            PARAMS ((rtx, rtx, rtx));
1572 extern int regs_set_between_p           PARAMS ((rtx, rtx, rtx));
1573 extern int commutative_operand_precedence PARAMS ((rtx));
1574 extern int swap_commutative_operands_p  PARAMS ((rtx, rtx));
1575 extern int modified_between_p           PARAMS ((rtx, rtx, rtx));
1576 extern int no_labels_between_p          PARAMS ((rtx, rtx));
1577 extern int no_jumps_between_p           PARAMS ((rtx, rtx));
1578 extern int modified_in_p                PARAMS ((rtx, rtx));
1579 extern int insn_dependent_p             PARAMS ((rtx, rtx));
1580 extern int reg_set_p                    PARAMS ((rtx, rtx));
1581 extern rtx single_set_2                 PARAMS ((rtx, rtx));
1582 extern int multiple_sets                PARAMS ((rtx));
1583 extern int set_noop_p                   PARAMS ((rtx));
1584 extern int noop_move_p                  PARAMS ((rtx));
1585 extern rtx find_last_value              PARAMS ((rtx, rtx *, rtx, int));
1586 extern int refers_to_regno_p            PARAMS ((unsigned int, unsigned int,
1587                                                  rtx, rtx *));
1588 extern int reg_overlap_mentioned_p      PARAMS ((rtx, rtx));
1589 extern rtx set_of                       PARAMS ((rtx, rtx));
1590 extern void note_stores                 PARAMS ((rtx,
1591                                                  void (*) (rtx, rtx, void *),
1592                                                  void *));
1593 extern void note_uses                   PARAMS ((rtx *,
1594                                                  void (*) (rtx *, void *),
1595                                                  void *));
1596 extern rtx reg_set_last                 PARAMS ((rtx, rtx));
1597 extern int dead_or_set_p                PARAMS ((rtx, rtx));
1598 extern int dead_or_set_regno_p          PARAMS ((rtx, unsigned int));
1599 extern rtx find_reg_note                PARAMS ((rtx, enum reg_note, rtx));
1600 extern rtx find_regno_note              PARAMS ((rtx, enum reg_note,
1601                                                  unsigned int));
1602 extern rtx find_reg_equal_equiv_note    PARAMS ((rtx));
1603 extern int find_reg_fusage              PARAMS ((rtx, enum rtx_code, rtx));
1604 extern int find_regno_fusage            PARAMS ((rtx, enum rtx_code,
1605                                                  unsigned int));
1606 extern int pure_call_p                  PARAMS ((rtx));
1607 extern void remove_note                 PARAMS ((rtx, rtx));
1608 extern int side_effects_p               PARAMS ((rtx));
1609 extern int volatile_refs_p              PARAMS ((rtx));
1610 extern int volatile_insn_p              PARAMS ((rtx));
1611 extern int may_trap_p                   PARAMS ((rtx));
1612 extern int inequality_comparisons_p     PARAMS ((rtx));
1613 extern rtx replace_rtx                  PARAMS ((rtx, rtx, rtx));
1614 extern rtx replace_regs                 PARAMS ((rtx, rtx *, unsigned int,
1615                                                  int));
1616 extern int computed_jump_p              PARAMS ((rtx));
1617 typedef int (*rtx_function)             PARAMS ((rtx *, void *));
1618 extern int for_each_rtx                 PARAMS ((rtx *, rtx_function, void *));
1619 extern rtx regno_use_in                 PARAMS ((unsigned int, rtx));
1620 extern int auto_inc_p                   PARAMS ((rtx));
1621 extern int in_expr_list_p               PARAMS ((rtx, rtx));
1622 extern void remove_node_from_expr_list  PARAMS ((rtx, rtx *));
1623 extern int insns_safe_to_move_p         PARAMS ((rtx, rtx, rtx *));
1624 extern int loc_mentioned_in_p           PARAMS ((rtx *, rtx));
1625 extern rtx find_first_parameter_load    PARAMS ((rtx, rtx));
1626 extern bool keep_with_call_p            PARAMS ((rtx));
1627
1628 /* flow.c */
1629
1630 extern rtx find_use_as_address          PARAMS ((rtx, rtx, HOST_WIDE_INT));
1631 void init_EXPR_INSN_LIST_cache          PARAMS ((void));
1632 void free_EXPR_LIST_list                PARAMS ((rtx *));
1633 void free_INSN_LIST_list                PARAMS ((rtx *));
1634 void free_EXPR_LIST_node                PARAMS ((rtx));
1635 void free_INSN_LIST_node                PARAMS ((rtx));
1636 rtx alloc_INSN_LIST                     PARAMS ((rtx, rtx));
1637 rtx alloc_EXPR_LIST                     PARAMS ((int, rtx, rtx));
1638
1639 /* regclass.c */
1640
1641 /* Maximum number of parallel sets and clobbers in any insn in this fn.
1642    Always at least 3, since the combiner could put that many togetherm
1643    and we want this to remain correct for all the remaining passes.  */
1644
1645 extern int max_parallel;
1646
1647 /* Free up register info memory.  */
1648 extern void free_reg_info               PARAMS ((void));
1649
1650 /* recog.c */
1651 extern int asm_noperands                PARAMS ((rtx));
1652 extern const char *decode_asm_operands  PARAMS ((rtx, rtx *, rtx **,
1653                                                const char **,
1654                                                enum machine_mode *));
1655
1656 extern enum reg_class reg_preferred_class PARAMS ((int));
1657 extern enum reg_class reg_alternate_class PARAMS ((int));
1658
1659 extern rtx get_first_nonparm_insn       PARAMS ((void));
1660
1661 extern void split_all_insns             PARAMS ((int));
1662 extern void split_all_insns_noflow      PARAMS ((void));
1663
1664 #define MAX_SAVED_CONST_INT 64
1665 extern rtx const_int_rtx[MAX_SAVED_CONST_INT * 2 + 1];
1666
1667 #define const0_rtx      (const_int_rtx[MAX_SAVED_CONST_INT])
1668 #define const1_rtx      (const_int_rtx[MAX_SAVED_CONST_INT+1])
1669 #define const2_rtx      (const_int_rtx[MAX_SAVED_CONST_INT+2])
1670 #define constm1_rtx     (const_int_rtx[MAX_SAVED_CONST_INT-1])
1671 extern rtx const_true_rtx;
1672
1673 extern rtx const_tiny_rtx[3][(int) MAX_MACHINE_MODE];
1674
1675 /* Returns a constant 0 rtx in mode MODE.  Integer modes are treated the
1676    same as VOIDmode.  */
1677
1678 #define CONST0_RTX(MODE) (const_tiny_rtx[0][(int) (MODE)])
1679
1680 /* Likewise, for the constants 1 and 2.  */
1681
1682 #define CONST1_RTX(MODE) (const_tiny_rtx[1][(int) (MODE)])
1683 #define CONST2_RTX(MODE) (const_tiny_rtx[2][(int) (MODE)])
1684
1685 /* If HARD_FRAME_POINTER_REGNUM is defined, then a special dummy reg
1686    is used to represent the frame pointer.  This is because the
1687    hard frame pointer and the automatic variables are separated by an amount
1688    that cannot be determined until after register allocation.  We can assume
1689    that in this case ELIMINABLE_REGS will be defined, one action of which
1690    will be to eliminate FRAME_POINTER_REGNUM into HARD_FRAME_POINTER_REGNUM.  */
1691 #ifndef HARD_FRAME_POINTER_REGNUM
1692 #define HARD_FRAME_POINTER_REGNUM FRAME_POINTER_REGNUM
1693 #endif
1694
1695 /* Index labels for global_rtl.  */
1696 enum global_rtl_index
1697 {
1698   GR_PC,
1699   GR_CC0,
1700   GR_STACK_POINTER,
1701   GR_FRAME_POINTER,
1702 /* For register elimination to work properly these hard_frame_pointer_rtx,
1703    frame_pointer_rtx, and arg_pointer_rtx must be the same if they refer to
1704    the same register.  */
1705 #if FRAME_POINTER_REGNUM == ARG_POINTER_REGNUM
1706   GR_ARG_POINTER = GR_FRAME_POINTER,
1707 #endif
1708 #if HARD_FRAME_POINTER_REGNUM == FRAME_POINTER_REGNUM
1709   GR_HARD_FRAME_POINTER = GR_FRAME_POINTER,
1710 #else
1711   GR_HARD_FRAME_POINTER,
1712 #endif
1713 #if FRAME_POINTER_REGNUM != ARG_POINTER_REGNUM
1714 #if HARD_FRAME_POINTER_REGNUM == ARG_POINTER_REGNUM
1715   GR_ARG_POINTER = GR_HARD_FRAME_POINTER,
1716 #else
1717   GR_ARG_POINTER,
1718 #endif
1719 #endif
1720   GR_VIRTUAL_INCOMING_ARGS,
1721   GR_VIRTUAL_STACK_ARGS,
1722   GR_VIRTUAL_STACK_DYNAMIC,
1723   GR_VIRTUAL_OUTGOING_ARGS,
1724   GR_VIRTUAL_CFA,
1725
1726   GR_MAX
1727 };
1728
1729 /* Pointers to standard pieces of rtx are stored here.  */
1730 extern rtx global_rtl[GR_MAX];
1731
1732 /* Standard pieces of rtx, to be substituted directly into things.  */
1733 #define pc_rtx                  (global_rtl[GR_PC])
1734 #define cc0_rtx                 (global_rtl[GR_CC0])
1735
1736 /* All references to certain hard regs, except those created
1737    by allocating pseudo regs into them (when that's possible),
1738    go through these unique rtx objects.  */
1739 #define stack_pointer_rtx       (global_rtl[GR_STACK_POINTER])
1740 #define frame_pointer_rtx       (global_rtl[GR_FRAME_POINTER])
1741 #define hard_frame_pointer_rtx  (global_rtl[GR_HARD_FRAME_POINTER])
1742 #define arg_pointer_rtx         (global_rtl[GR_ARG_POINTER])
1743
1744 extern rtx pic_offset_table_rtx;
1745 extern rtx struct_value_rtx;
1746 extern rtx struct_value_incoming_rtx;
1747 extern rtx static_chain_rtx;
1748 extern rtx static_chain_incoming_rtx;
1749 extern rtx return_address_pointer_rtx;
1750
1751 /* Include the RTL generation functions.  */
1752
1753 #ifndef NO_GENRTL_H
1754 #include "genrtl.h"
1755 #endif
1756
1757 /* There are some RTL codes that require special attention; the
1758    generation functions included above do the raw handling.  If you
1759    add to this list, modify special_rtx in gengenrtl.c as well.  You
1760    should also modify gen_rtx to use the special function.  */
1761
1762 extern rtx gen_rtx_CONST_DOUBLE PARAMS ((enum machine_mode,
1763                                        HOST_WIDE_INT, HOST_WIDE_INT));
1764 extern rtx gen_rtx_CONST_INT PARAMS ((enum machine_mode, HOST_WIDE_INT));
1765 extern rtx gen_raw_REG PARAMS ((enum machine_mode, int));
1766 extern rtx gen_rtx_REG PARAMS ((enum machine_mode, int));
1767 extern rtx gen_rtx_SUBREG PARAMS ((enum machine_mode, rtx, int));
1768 extern rtx gen_rtx_MEM PARAMS ((enum machine_mode, rtx));
1769
1770 extern rtx gen_lowpart_SUBREG PARAMS ((enum machine_mode, rtx));
1771
1772 /* We need the cast here to ensure that we get the same result both with
1773    and without prototypes.  */
1774 #define GEN_INT(N)  gen_rtx_CONST_INT (VOIDmode, (HOST_WIDE_INT) (N))
1775
1776 /* Virtual registers are used during RTL generation to refer to locations into
1777    the stack frame when the actual location isn't known until RTL generation
1778    is complete.  The routine instantiate_virtual_regs replaces these with
1779    the proper value, which is normally {frame,arg,stack}_pointer_rtx plus
1780    a constant.  */
1781
1782 #define FIRST_VIRTUAL_REGISTER  (FIRST_PSEUDO_REGISTER)
1783
1784 /* This points to the first word of the incoming arguments passed on the stack,
1785    either by the caller or by the callee when pretending it was passed by the
1786    caller.  */
1787
1788 #define virtual_incoming_args_rtx       (global_rtl[GR_VIRTUAL_INCOMING_ARGS])
1789
1790 #define VIRTUAL_INCOMING_ARGS_REGNUM    (FIRST_VIRTUAL_REGISTER)
1791
1792 /* If FRAME_GROWS_DOWNWARD, this points to immediately above the first
1793    variable on the stack.  Otherwise, it points to the first variable on
1794    the stack.  */
1795
1796 #define virtual_stack_vars_rtx          (global_rtl[GR_VIRTUAL_STACK_ARGS])
1797
1798 #define VIRTUAL_STACK_VARS_REGNUM       ((FIRST_VIRTUAL_REGISTER) + 1)
1799
1800 /* This points to the location of dynamically-allocated memory on the stack
1801    immediately after the stack pointer has been adjusted by the amount
1802    desired.  */
1803
1804 #define virtual_stack_dynamic_rtx       (global_rtl[GR_VIRTUAL_STACK_DYNAMIC])
1805
1806 #define VIRTUAL_STACK_DYNAMIC_REGNUM    ((FIRST_VIRTUAL_REGISTER) + 2)
1807
1808 /* This points to the location in the stack at which outgoing arguments should
1809    be written when the stack is pre-pushed (arguments pushed using push
1810    insns always use sp).  */
1811
1812 #define virtual_outgoing_args_rtx       (global_rtl[GR_VIRTUAL_OUTGOING_ARGS])
1813
1814 #define VIRTUAL_OUTGOING_ARGS_REGNUM    ((FIRST_VIRTUAL_REGISTER) + 3)
1815
1816 /* This points to the Canonical Frame Address of the function.  This
1817    should corrospond to the CFA produced by INCOMING_FRAME_SP_OFFSET,
1818    but is calculated relative to the arg pointer for simplicity; the
1819    frame pointer nor stack pointer are necessarily fixed relative to
1820    the CFA until after reload.  */
1821
1822 #define virtual_cfa_rtx                 (global_rtl[GR_VIRTUAL_CFA])
1823
1824 #define VIRTUAL_CFA_REGNUM              ((FIRST_VIRTUAL_REGISTER) + 4)
1825
1826 #define LAST_VIRTUAL_REGISTER           ((FIRST_VIRTUAL_REGISTER) + 4)
1827
1828 /* Nonzero if REGNUM is a pointer into the stack frame.  */
1829 #define REGNO_PTR_FRAME_P(REGNUM)               \
1830   ((REGNUM) == STACK_POINTER_REGNUM             \
1831    || (REGNUM) == FRAME_POINTER_REGNUM          \
1832    || (REGNUM) == HARD_FRAME_POINTER_REGNUM     \
1833    || (REGNUM) == ARG_POINTER_REGNUM            \
1834    || ((REGNUM) >= FIRST_VIRTUAL_REGISTER       \
1835        && (REGNUM) <= LAST_VIRTUAL_REGISTER))
1836
1837 /* REGNUM never really appearing in the INSN stream.  */
1838 #define INVALID_REGNUM                  (~(unsigned int) 0)
1839
1840 extern rtx find_next_ref                PARAMS ((rtx, rtx));
1841
1842 extern rtx output_constant_def          PARAMS ((tree, int));
1843 extern rtx immed_real_const             PARAMS ((tree));
1844
1845 /* Define a default value for STORE_FLAG_VALUE.  */
1846
1847 #ifndef STORE_FLAG_VALUE
1848 #define STORE_FLAG_VALUE 1
1849 #endif
1850
1851 /* Nonzero after the second flow pass has completed.
1852    Set to 1 or 0 by toplev.c  */
1853 extern int flow2_completed;
1854
1855 /* Nonzero after end of reload pass.
1856    Set to 1 or 0 by reload1.c.  */
1857
1858 extern int reload_completed;
1859
1860 /* Set to 1 while reload_as_needed is operating.
1861    Required by some machines to handle any generated moves differently.  */
1862
1863 extern int reload_in_progress;
1864
1865 /* If this is nonzero, we do not bother generating VOLATILE
1866    around volatile memory references, and we are willing to
1867    output indirect addresses.  If cse is to follow, we reject
1868    indirect addresses so a useful potential cse is generated;
1869    if it is used only once, instruction combination will produce
1870    the same indirect address eventually.  */
1871 extern int cse_not_expected;
1872
1873 /* Set to nonzero before life analysis to indicate that it is unsafe to
1874    generate any new pseudo registers.  */
1875 extern int no_new_pseudos;
1876
1877 /* Translates rtx code to tree code, for those codes needed by
1878    REAL_ARITHMETIC.  The function returns an int because the caller may not
1879    know what `enum tree_code' means.  */
1880
1881 extern int rtx_to_tree_code     PARAMS ((enum rtx_code));
1882
1883 /* In tree.c */
1884 struct obstack;
1885 extern void gcc_obstack_init            PARAMS ((struct obstack *));
1886
1887 /* In cse.c */
1888 struct cse_basic_block_data;
1889
1890 /* Return the right cost to give to an operation
1891    to make the cost of the corresponding register-to-register instruction
1892    N times that of a fast register-to-register instruction.  */
1893 #define COSTS_N_INSNS(N) ((N) * 4)
1894
1895 /* Maximum cost of a rtl expression.  This value has the special meaning
1896    not to use an rtx with this cost under any circumstances.  */
1897 #define MAX_COST INT_MAX
1898
1899 extern int rtx_cost                     PARAMS ((rtx, enum rtx_code));
1900 extern int address_cost                 PARAMS ((rtx, enum machine_mode));
1901 extern int delete_trivially_dead_insns  PARAMS ((rtx, int));
1902 #ifdef BUFSIZ
1903 extern int cse_main                     PARAMS ((rtx, int, int, FILE *));
1904 #endif
1905 extern void cse_end_of_basic_block      PARAMS ((rtx,
1906                                                 struct cse_basic_block_data *,
1907                                                 int, int, int));
1908
1909 /* In jump.c */
1910 extern int comparison_dominates_p       PARAMS ((enum rtx_code, enum rtx_code));
1911 extern int condjump_p                   PARAMS ((rtx));
1912 extern int any_condjump_p               PARAMS ((rtx));
1913 extern int any_uncondjump_p             PARAMS ((rtx));
1914 extern int safe_to_remove_jump_p        PARAMS ((rtx));
1915 extern rtx pc_set                       PARAMS ((rtx));
1916 extern rtx condjump_label               PARAMS ((rtx));
1917 extern int simplejump_p                 PARAMS ((rtx));
1918 extern int returnjump_p                 PARAMS ((rtx));
1919 extern int onlyjump_p                   PARAMS ((rtx));
1920 extern int only_sets_cc0_p              PARAMS ((rtx));
1921 extern int sets_cc0_p                   PARAMS ((rtx));
1922 extern int invert_jump_1                PARAMS ((rtx, rtx));
1923 extern int invert_jump                  PARAMS ((rtx, rtx, int));
1924 extern int rtx_renumbered_equal_p       PARAMS ((rtx, rtx));
1925 extern int true_regnum                  PARAMS ((rtx));
1926 extern int redirect_jump_1              PARAMS ((rtx, rtx));
1927 extern int redirect_jump                PARAMS ((rtx, rtx, int));
1928 extern void rebuild_jump_labels         PARAMS ((rtx));
1929 extern enum rtx_code reversed_comparison_code PARAMS ((rtx, rtx));
1930 extern enum rtx_code reversed_comparison_code_parts PARAMS ((enum rtx_code,
1931                                                              rtx, rtx, rtx));
1932 extern void delete_for_peephole         PARAMS ((rtx, rtx));
1933 extern int condjump_in_parallel_p       PARAMS ((rtx));
1934 extern void never_reached_warning       PARAMS ((rtx, rtx));
1935 extern void purge_line_number_notes     PARAMS ((rtx));
1936 extern void copy_loop_headers           PARAMS ((rtx));
1937
1938 /* In emit-rtl.c.  */
1939 extern int max_reg_num                          PARAMS ((void));
1940 extern int max_label_num                        PARAMS ((void));
1941 extern int get_first_label_num                  PARAMS ((void));
1942 extern void delete_insns_since                  PARAMS ((rtx));
1943 extern void mark_reg_pointer                    PARAMS ((rtx, int));
1944 extern void mark_user_reg                       PARAMS ((rtx));
1945 extern void reset_used_flags                    PARAMS ((rtx));
1946 extern void reorder_insns                       PARAMS ((rtx, rtx, rtx));
1947 extern void reorder_insns_nobb                  PARAMS ((rtx, rtx, rtx));
1948 extern int get_max_uid                          PARAMS ((void));
1949 extern int in_sequence_p                        PARAMS ((void));
1950 extern void force_next_line_note                PARAMS ((void));
1951 extern void clear_emit_caches                   PARAMS ((void));
1952 extern void init_emit                           PARAMS ((void));
1953 extern void init_emit_once                      PARAMS ((int));
1954 extern void push_topmost_sequence               PARAMS ((void));
1955 extern void pop_topmost_sequence                PARAMS ((void));
1956 extern int subreg_realpart_p                    PARAMS ((rtx));
1957 extern void reverse_comparison                  PARAMS ((rtx));
1958 extern void set_new_first_and_last_insn         PARAMS ((rtx, rtx));
1959 extern void set_new_first_and_last_label_num    PARAMS ((int, int));
1960 extern void set_new_last_label_num              PARAMS ((int));
1961 extern void unshare_all_rtl_again               PARAMS ((rtx));
1962 extern void set_first_insn                      PARAMS ((rtx));
1963 extern void set_last_insn                       PARAMS ((rtx));
1964 extern void link_cc0_insns                      PARAMS ((rtx));
1965 extern void add_insn                            PARAMS ((rtx));
1966 extern void add_insn_before                     PARAMS ((rtx, rtx));
1967 extern void add_insn_after                      PARAMS ((rtx, rtx));
1968 extern void remove_insn                         PARAMS ((rtx));
1969 extern void reorder_insns_with_line_notes       PARAMS ((rtx, rtx, rtx));
1970 extern void emit_insn_after_with_line_notes     PARAMS ((rtx, rtx, rtx));
1971 extern enum rtx_code classify_insn              PARAMS ((rtx));
1972 extern rtx emit                                 PARAMS ((rtx));
1973 /* Query and clear/ restore no_line_numbers.  This is used by the
1974    switch / case handling in stmt.c to give proper line numbers in
1975    warnings about unreachable code.  */
1976 int force_line_numbers PARAMS ((void));
1977 void restore_line_number_status PARAMS ((int old_value));
1978 extern void renumber_insns                      PARAMS ((FILE *));
1979 extern void remove_unnecessary_notes             PARAMS ((void));
1980 extern rtx delete_insn                  PARAMS ((rtx));
1981 extern void delete_insn_chain           PARAMS ((rtx, rtx));
1982 extern rtx delete_insn_and_edges        PARAMS ((rtx));
1983 extern void delete_insn_chain_and_edges PARAMS ((rtx, rtx));
1984
1985 /* In combine.c */
1986 extern int combine_instructions         PARAMS ((rtx, unsigned int));
1987 extern unsigned int extended_count      PARAMS ((rtx, enum machine_mode, int));
1988 extern rtx remove_death                 PARAMS ((unsigned int, rtx));
1989 #ifdef BUFSIZ
1990 extern void dump_combine_stats          PARAMS ((FILE *));
1991 extern void dump_combine_total_stats    PARAMS ((FILE *));
1992 #endif
1993
1994 /* In sched.c.  */
1995 #ifdef BUFSIZ
1996 extern void schedule_insns              PARAMS ((FILE *));
1997 extern void schedule_ebbs               PARAMS ((FILE *));
1998 #endif
1999 extern void fix_sched_param             PARAMS ((const char *, const char *));
2000
2001 /* In print-rtl.c */
2002 extern const char *print_rtx_head;
2003 extern void debug_rtx                   PARAMS ((rtx));
2004 extern void debug_rtx_list              PARAMS ((rtx, int));
2005 extern void debug_rtx_range             PARAMS ((rtx, rtx));
2006 extern rtx debug_rtx_find               PARAMS ((rtx, int));
2007 #ifdef BUFSIZ
2008 extern void print_mem_expr              PARAMS ((FILE *, tree));
2009 extern void print_rtl                   PARAMS ((FILE *, rtx));
2010 extern void print_simple_rtl            PARAMS ((FILE *, rtx));
2011 extern int print_rtl_single             PARAMS ((FILE *, rtx));
2012 extern void print_inline_rtx            PARAMS ((FILE *, rtx, int));
2013 #endif
2014
2015 /* In loop.c */
2016 extern void init_loop                   PARAMS ((void));
2017 extern rtx libcall_other_reg            PARAMS ((rtx, rtx));
2018 #ifdef BUFSIZ
2019 extern void loop_optimize               PARAMS ((rtx, FILE *, int));
2020 #endif
2021 extern void record_excess_regs          PARAMS ((rtx, rtx, rtx *));
2022
2023 /* In function.c */
2024 extern void reposition_prologue_and_epilogue_notes      PARAMS ((rtx));
2025 extern void thread_prologue_and_epilogue_insns          PARAMS ((rtx));
2026 extern int prologue_epilogue_contains                   PARAMS ((rtx));
2027 extern int sibcall_epilogue_contains                    PARAMS ((rtx));
2028 extern void preserve_rtl_expr_result                    PARAMS ((rtx));
2029 extern void mark_temp_addr_taken                        PARAMS ((rtx));
2030 extern void update_temp_slot_address                    PARAMS ((rtx, rtx));
2031 extern void purge_addressof                             PARAMS ((rtx));
2032 extern void purge_hard_subreg_sets                      PARAMS ((rtx));
2033
2034 /* In stmt.c */
2035 extern void set_file_and_line_for_stmt  PARAMS ((const char *, int));
2036 extern void expand_null_return          PARAMS ((void));
2037 extern void emit_jump                   PARAMS ((rtx));
2038 extern int preserve_subexpressions_p    PARAMS ((void));
2039
2040 /* In expr.c */
2041 extern void move_by_pieces              PARAMS ((rtx, rtx,
2042                                                  unsigned HOST_WIDE_INT,
2043                                                  unsigned int));
2044
2045 /* In flow.c */
2046 extern void recompute_reg_usage                 PARAMS ((rtx, int));
2047 extern int initialize_uninitialized_subregs     PARAMS ((void));
2048 extern void delete_dead_jumptables              PARAMS ((void));
2049 #ifdef BUFSIZ
2050 extern void print_rtl_with_bb                   PARAMS ((FILE *, rtx));
2051 extern void dump_flow_info                      PARAMS ((FILE *));
2052 #endif
2053
2054 /* In expmed.c */
2055 extern void init_expmed                 PARAMS ((void));
2056 extern void expand_inc                  PARAMS ((rtx, rtx));
2057 extern void expand_dec                  PARAMS ((rtx, rtx));
2058 extern rtx expand_mult_highpart         PARAMS ((enum machine_mode, rtx,
2059                                                 unsigned HOST_WIDE_INT, rtx,
2060                                                 int, int));
2061
2062 /* In gcse.c */
2063 #ifdef BUFSIZ
2064 extern int gcse_main                    PARAMS ((rtx, FILE *));
2065 #endif
2066
2067 /* In global.c */
2068 extern void mark_elimination            PARAMS ((int, int));
2069 #ifdef BUFSIZ
2070 extern int global_alloc                 PARAMS ((FILE *));
2071 extern void dump_global_regs            PARAMS ((FILE *));
2072 #endif
2073 #ifdef HARD_CONST
2074 extern void retry_global_alloc          PARAMS ((int, HARD_REG_SET));
2075 #endif
2076 extern void build_insn_chain            PARAMS ((rtx));
2077
2078 /* In regclass.c */
2079 extern int reg_classes_intersect_p      PARAMS ((enum reg_class, enum reg_class));
2080 extern int reg_class_subset_p           PARAMS ((enum reg_class, enum reg_class));
2081 extern void globalize_reg               PARAMS ((int));
2082 extern void init_regs                   PARAMS ((void));
2083 extern void init_reg_sets               PARAMS ((void));
2084 extern void regset_release_memory       PARAMS ((void));
2085 extern void regclass_init               PARAMS ((void));
2086 extern void regclass                    PARAMS ((rtx, int, FILE *));
2087 extern void reg_scan                    PARAMS ((rtx, unsigned int, int));
2088 extern void reg_scan_update             PARAMS ((rtx, rtx, unsigned int));
2089 extern void fix_register                PARAMS ((const char *, int, int));
2090
2091 extern void delete_null_pointer_checks  PARAMS ((rtx));
2092
2093 /* In regmove.c */
2094 #ifdef BUFSIZ
2095 extern void regmove_optimize            PARAMS ((rtx, int, FILE *));
2096 #endif
2097 extern void combine_stack_adjustments   PARAMS ((void));
2098
2099 /* In reorg.c */
2100 #ifdef BUFSIZ
2101 extern void dbr_schedule                PARAMS ((rtx, FILE *));
2102 #endif
2103
2104 /* In local-alloc.c */
2105 #ifdef BUFSIZ
2106 extern void dump_local_alloc            PARAMS ((FILE *));
2107 #endif
2108 extern int local_alloc                  PARAMS ((void));
2109 extern int function_invariant_p         PARAMS ((rtx));
2110
2111 /* In profile.c */
2112 extern void init_branch_prob            PARAMS ((const char *));
2113 extern void branch_prob                 PARAMS ((void));
2114 extern void end_branch_prob             PARAMS ((void));
2115 extern void output_func_start_profiler  PARAMS ((void));
2116
2117 /* In reg-stack.c */
2118 #ifdef BUFSIZ
2119 extern void reg_to_stack                PARAMS ((rtx, FILE *));
2120 #endif
2121
2122 /* In fold-const.c */
2123 extern int add_double           PARAMS ((unsigned HOST_WIDE_INT, HOST_WIDE_INT,
2124                                          unsigned HOST_WIDE_INT, HOST_WIDE_INT,
2125                                          unsigned HOST_WIDE_INT *,
2126                                          HOST_WIDE_INT *));
2127 extern int neg_double           PARAMS ((unsigned HOST_WIDE_INT, HOST_WIDE_INT,
2128                                          unsigned HOST_WIDE_INT *,
2129                                          HOST_WIDE_INT *));
2130 extern int mul_double           PARAMS ((unsigned HOST_WIDE_INT,
2131                                          HOST_WIDE_INT,
2132                                          unsigned HOST_WIDE_INT, HOST_WIDE_INT,
2133                                          unsigned HOST_WIDE_INT *,
2134                                          HOST_WIDE_INT *));
2135 extern void lshift_double       PARAMS ((unsigned HOST_WIDE_INT, HOST_WIDE_INT,
2136                                          HOST_WIDE_INT, unsigned int,
2137                                          unsigned HOST_WIDE_INT *,
2138                                          HOST_WIDE_INT *, int));
2139 extern void rshift_double       PARAMS ((unsigned HOST_WIDE_INT, HOST_WIDE_INT,
2140                                          HOST_WIDE_INT, unsigned int,
2141                                          unsigned HOST_WIDE_INT *,
2142                                          HOST_WIDE_INT *, int));
2143 extern void lrotate_double      PARAMS ((unsigned HOST_WIDE_INT, HOST_WIDE_INT,
2144                                          HOST_WIDE_INT, unsigned int,
2145                                          unsigned HOST_WIDE_INT *,
2146                                          HOST_WIDE_INT *));
2147 extern void rrotate_double      PARAMS ((unsigned HOST_WIDE_INT, HOST_WIDE_INT,
2148                                          HOST_WIDE_INT, unsigned int,
2149                                          unsigned HOST_WIDE_INT *,
2150                                          HOST_WIDE_INT *));
2151
2152 /* In calls.c */
2153 enum libcall_type
2154 {
2155   LCT_NORMAL = 0,
2156   LCT_CONST = 1,
2157   LCT_PURE = 2,
2158   LCT_CONST_MAKE_BLOCK = 3,
2159   LCT_PURE_MAKE_BLOCK = 4,
2160   LCT_NORETURN = 5,
2161   LCT_THROW = 6,
2162   LCT_ALWAYS_RETURN = 7,
2163   LCT_RETURNS_TWICE = 8
2164 };
2165
2166 extern void emit_library_call           PARAMS ((rtx, enum libcall_type,
2167                                                  enum machine_mode, int,
2168                                                  ...));
2169 extern rtx emit_library_call_value      PARAMS ((rtx, rtx, enum libcall_type,
2170                                                  enum machine_mode, int,
2171                                                  ...));
2172
2173 /* In unroll.c */
2174 extern int set_dominates_use            PARAMS ((int, int, int, rtx, rtx));
2175
2176 /* In varasm.c */
2177 extern int in_data_section              PARAMS ((void));
2178 extern void init_varasm_once            PARAMS ((void));
2179
2180 /* In rtl.c */
2181 extern void init_rtl                    PARAMS ((void));
2182 extern void traverse_md_constants       PARAMS ((int (*) (void **, void *),
2183                                                  void *));
2184 struct md_constant { char *name, *value; };
2185
2186 #ifdef BUFSIZ
2187 extern int read_skip_spaces             PARAMS ((FILE *));
2188 extern rtx read_rtx                     PARAMS ((FILE *));
2189 #endif
2190
2191 extern const char *read_rtx_filename;
2192 extern int read_rtx_lineno;
2193
2194 /* Redefine abort to report an internal error w/o coredump, and
2195    reporting the location of the error in the source file.  This logic
2196    is duplicated in rtl.h and tree.h because every file that needs the
2197    special abort includes one or both.  toplev.h gets too few files,
2198    system.h gets too many.  */
2199
2200 extern void fancy_abort PARAMS ((const char *, int, const char *))
2201     ATTRIBUTE_NORETURN;
2202 #define abort() fancy_abort (__FILE__, __LINE__, __FUNCTION__)
2203
2204 /* In alias.c */
2205 extern void clear_reg_alias_info        PARAMS ((rtx));
2206 extern rtx canon_rtx                    PARAMS ((rtx));
2207 extern int true_dependence              PARAMS ((rtx, enum machine_mode, rtx,
2208                                                 int (*)(rtx, int)));
2209 extern rtx get_addr                     PARAMS ((rtx));
2210 extern int canon_true_dependence        PARAMS ((rtx, enum machine_mode, rtx,
2211                                                 rtx, int (*)(rtx, int)));
2212 extern int read_dependence              PARAMS ((rtx, rtx));
2213 extern int anti_dependence              PARAMS ((rtx, rtx));
2214 extern int output_dependence            PARAMS ((rtx, rtx));
2215 extern void mark_constant_function      PARAMS ((void));
2216 extern void init_alias_once             PARAMS ((void));
2217 extern void init_alias_analysis         PARAMS ((void));
2218 extern void end_alias_analysis          PARAMS ((void));
2219 extern rtx addr_side_effect_eval        PARAMS ((rtx, int, int));
2220
2221 /* In sibcall.c */
2222 typedef enum {
2223   sibcall_use_normal = 1,
2224   sibcall_use_tail_recursion,
2225   sibcall_use_sibcall
2226 } sibcall_use_t;
2227
2228 extern void optimize_sibling_and_tail_recursive_calls PARAMS ((void));
2229 extern void replace_call_placeholder    PARAMS ((rtx, sibcall_use_t));
2230
2231 #ifdef STACK_REGS
2232 extern int stack_regs_mentioned         PARAMS ((rtx insn));
2233 #endif
2234
2235 /* In toplev.c */
2236 extern rtx stack_limit_rtx;
2237
2238 /* In regrename.c */
2239 extern void regrename_optimize          PARAMS ((void));
2240 extern void copyprop_hardreg_forward    PARAMS ((void));
2241
2242 /* In ifcvt.c */
2243 extern void if_convert                  PARAMS ((int));
2244
2245 /* In predict.c */
2246 extern void invert_br_probabilities     PARAMS ((rtx));
2247 extern bool expensive_function_p        PARAMS ((int));
2248 #endif /* ! GCC_RTL_H */