OSDN Git Service

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