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