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