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