OSDN Git Service

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