rtl.h 96.5 KB
Newer Older
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, 2007, 2008, 2009, 2010
4
   Free Software Foundation, Inc.
Jim Wilson committed
5

6
This file is part of GCC.
Jim Wilson committed
7

8 9
GCC is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
10
Software Foundation; either version 3, or (at your option) any later
11
version.
Jim Wilson committed
12

13 14 15 16
GCC is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.
Jim Wilson committed
17 18

You should have received a copy of the GNU General Public License
19 20
along with GCC; see the file COPYING3.  If not see
<http://www.gnu.org/licenses/>.  */
Jim Wilson committed
21

22 23
#ifndef GCC_RTL_H
#define GCC_RTL_H
24

25
#include "statistics.h"
Jim Wilson committed
26
#include "machmode.h"
27
#include "input.h"
28
#include "real.h"
29
#include "vec.h"
30
#include "vecir.h"
31
#include "fixed-value.h"
32
#include "alias.h"
33
#include "hashtab.h"
Jim Wilson committed
34 35

#undef FFS  /* Some systems predefine this symbol; don't let it interfere.  */
36
#undef FLOAT /* Likewise.  */
37
#undef ABS /* Likewise.  */
Richard Stallman committed
38
#undef PC /* Likewise.  */
Jim Wilson committed
39

40
/* Value used by some passes to "recognize" noop moves as valid
Kazu Hirata committed
41
 instructions.  */
42 43
#define NOOP_MOVE_INSN_CODE	INT_MAX

Jim Wilson committed
44 45 46 47 48 49 50 51 52
/* Register Transfer Language EXPRESSIONS CODES */

#define RTX_CODE	enum rtx_code
enum rtx_code  {

#define DEF_RTL_EXPR(ENUM, NAME, FORMAT, CLASS)   ENUM ,
#include "rtl.def"		/* rtl expressions are documented here */
#undef DEF_RTL_EXPR

53
  LAST_AND_UNUSED_RTX_CODE};	/* A convenient way to get a value for
Jim Wilson committed
54
				   NUM_RTX_CODE.
55
				   Assumes default enum value assignment.  */
Jim Wilson committed
56

Kazu Hirata committed
57
#define NUM_RTX_CODE ((int) LAST_AND_UNUSED_RTX_CODE)
Jim Wilson committed
58 59
				/* The cast here, saves many elsewhere.  */

60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
/* Register Transfer Language EXPRESSIONS CODE CLASSES */

enum rtx_class  {
  /* We check bit 0-1 of some rtx class codes in the predicates below.  */

  /* Bit 0 = comparison if 0, arithmetic is 1
     Bit 1 = 1 if commutative.  */
  RTX_COMPARE,		/* 0 */
  RTX_COMM_COMPARE,
  RTX_BIN_ARITH,
  RTX_COMM_ARITH,

  /* Must follow the four preceding values.  */
  RTX_UNARY,		/* 4 */

  RTX_EXTRA,
  RTX_MATCH,
  RTX_INSN,

  /* Bit 0 = 1 if constant.  */
  RTX_OBJ,		/* 8 */
  RTX_CONST_OBJ,

  RTX_TERNARY,
  RTX_BITFIELD_OPS,
  RTX_AUTOINC
};

#define RTX_OBJ_MASK (~1)
#define RTX_OBJ_RESULT (RTX_OBJ & RTX_OBJ_MASK)
#define RTX_COMPARE_MASK (~1)
#define RTX_COMPARE_RESULT (RTX_COMPARE & RTX_COMPARE_MASK)
#define RTX_ARITHMETIC_MASK (~1)
#define RTX_ARITHMETIC_RESULT (RTX_COMM_ARITH & RTX_ARITHMETIC_MASK)
#define RTX_BINARY_MASK (~3)
#define RTX_BINARY_RESULT (RTX_COMPARE & RTX_BINARY_MASK)
#define RTX_COMMUTATIVE_MASK (~2)
#define RTX_COMMUTATIVE_RESULT (RTX_COMM_COMPARE & RTX_COMMUTATIVE_MASK)
#define RTX_NON_COMMUTATIVE_RESULT (RTX_COMPARE & RTX_COMMUTATIVE_MASK)

100
extern const unsigned char rtx_length[NUM_RTX_CODE];
Mike Stump committed
101
#define GET_RTX_LENGTH(CODE)		(rtx_length[(int) (CODE)])
Jim Wilson committed
102

103
extern const char * const rtx_name[NUM_RTX_CODE];
Mike Stump committed
104
#define GET_RTX_NAME(CODE)		(rtx_name[(int) (CODE)])
Jim Wilson committed
105

106
extern const char * const rtx_format[NUM_RTX_CODE];
Mike Stump committed
107
#define GET_RTX_FORMAT(CODE)		(rtx_format[(int) (CODE)])
Jim Wilson committed
108

109
extern const enum rtx_class rtx_class[NUM_RTX_CODE];
Mike Stump committed
110
#define GET_RTX_CLASS(CODE)		(rtx_class[(int) (CODE)])
Geoffrey Keating committed
111

112
extern const unsigned char rtx_code_size[NUM_RTX_CODE];
Geoffrey Keating committed
113
extern const unsigned char rtx_next[NUM_RTX_CODE];
Jim Wilson committed
114

115 116 117 118 119 120 121 122
/* The flags and bitfields of an ADDR_DIFF_VEC.  BASE is the base label
   relative to which the offsets are calculated, as explained in rtl.def.  */
typedef struct
{
  /* Set at the start of shorten_branches - ONLY WHEN OPTIMIZING - : */
  unsigned min_align: 8;
  /* Flags: */
  unsigned base_after_vec: 1; /* BASE is after the ADDR_DIFF_VEC.  */
123 124 125 126 127 128 129 130
  unsigned min_after_vec: 1;  /* minimum address target label is
				 after the ADDR_DIFF_VEC.  */
  unsigned max_after_vec: 1;  /* maximum address target label is
				 after the ADDR_DIFF_VEC.  */
  unsigned min_after_base: 1; /* minimum address target label is
				 after BASE.  */
  unsigned max_after_base: 1; /* maximum address target label is
				 after BASE.  */
131 132 133 134 135 136
  /* Set by the actual branch shortening process - ONLY WHEN OPTIMIZING - : */
  unsigned offset_unsigned: 1; /* offsets have to be treated as unsigned.  */
  unsigned : 2;
  unsigned scale : 8;
} addr_diff_vec_flags;

137 138 139 140
/* Structure used to describe the attributes of a MEM.  These are hashed
   so MEMs that the same attributes share a data structure.  This means
   they cannot be modified in place.  If any element is nonzero, it means
   the value of the corresponding attribute is unknown.  */
141 142 143
/* ALIGN and SIZE are the alignment and size of the MEM itself,
   while EXPR can describe a larger underlying object, which might have a
   stricter alignment; OFFSET is the offset of the MEM within that object.  */
144
typedef struct GTY(()) mem_attrs
145
{
146
  tree expr;			/* expr corresponding to MEM.  */
Kazu Hirata committed
147
  rtx offset;			/* Offset from start of DECL, as CONST_INT.  */
148
  rtx size;			/* Size in bytes, as a CONST_INT.  */
149
  alias_set_type alias;		/* Memory alias set.  */
150
  unsigned int align;		/* Alignment of MEM in bits.  */
151
  unsigned char addrspace;	/* Address space (0 for generic).  */
152 153
} mem_attrs;

154
/* Structure used to describe the attributes of a REG in similar way as
155 156 157 158 159
   mem_attrs does for MEM above.  Note that the OFFSET field is calculated
   in the same way as for mem_attrs, rather than in the same way as a
   SUBREG_BYTE.  For example, if a big-endian target stores a byte
   object in the low part of a 4-byte register, the OFFSET field
   will be -3 rather than 0.  */
160

161
typedef struct GTY(()) reg_attrs {
162 163 164 165
  tree decl;			/* decl corresponding to REG.  */
  HOST_WIDE_INT offset;		/* Offset from start of DECL.  */
} reg_attrs;

Jim Wilson committed
166 167
/* Common union for an element of an rtx.  */

Geoffrey Keating committed
168
union rtunion_def
Jim Wilson committed
169
{
170 171 172 173 174 175
  int rt_int;
  unsigned int rt_uint;
  const char *rt_str;
  rtx rt_rtx;
  rtvec rt_rtvec;
  enum machine_mode rt_type;
176
  addr_diff_vec_flags rt_addr_diff_vec_flags;
177
  struct cselib_val_struct *rt_cselib;
178 179 180 181
  tree rt_tree;
  struct basic_block_def *rt_bb;
  mem_attrs *rt_mem;
  reg_attrs *rt_reg;
182
  struct constant_descriptor_rtx *rt_constant;
Geoffrey Keating committed
183 184
};
typedef union rtunion_def rtunion;
Jim Wilson committed
185

186 187
/* This structure remembers the position of a SYMBOL_REF within an
   object_block structure.  A SYMBOL_REF only provides this information
188
   if SYMBOL_REF_HAS_BLOCK_INFO_P is true.  */
189
struct GTY(()) block_symbol {
190 191 192 193 194 195 196 197 198 199 200 201 202
  /* The usual SYMBOL_REF fields.  */
  rtunion GTY ((skip)) fld[3];

  /* The block that contains this object.  */
  struct object_block *block;

  /* The offset of this object from the start of its block.  It is negative
     if the symbol has not yet been assigned an offset.  */
  HOST_WIDE_INT offset;
};

/* Describes a group of objects that are to be placed together in such
   a way that their relative positions are known.  */
203
struct GTY(()) object_block {
204 205 206 207 208 209 210 211 212 213 214 215 216
  /* The section in which these objects should be placed.  */
  section *sect;

  /* The alignment of the first object, measured in bits.  */
  unsigned int alignment;

  /* The total size of the objects, measured in bytes.  */
  HOST_WIDE_INT size;

  /* The SYMBOL_REFs for each object.  The vector is sorted in
     order of increasing offset and the following conditions will
     hold for each element X:

217
	 SYMBOL_REF_HAS_BLOCK_INFO_P (X)
218 219 220 221 222 223 224 225 226
	 !SYMBOL_REF_ANCHOR_P (X)
	 SYMBOL_REF_BLOCK (X) == [address of this structure]
	 SYMBOL_REF_BLOCK_OFFSET (X) >= 0.  */
  VEC(rtx,gc) *objects;

  /* All the anchor SYMBOL_REFs used to address these objects, sorted
     in order of increasing offset, and then increasing TLS model.
     The following conditions will hold for each element X in this vector:

227
	 SYMBOL_REF_HAS_BLOCK_INFO_P (X)
228 229 230 231 232 233
	 SYMBOL_REF_ANCHOR_P (X)
	 SYMBOL_REF_BLOCK (X) == [address of this structure]
	 SYMBOL_REF_BLOCK_OFFSET (X) >= 0.  */
  VEC(rtx,gc) *anchors;
};

Jim Wilson committed
234 235
/* RTL expression ("rtx").  */

236
struct GTY((chain_next ("RTX_NEXT (&%h)"),
237
	    chain_prev ("RTX_PREV (&%h)"), variable_size)) rtx_def {
Jim Wilson committed
238
  /* The kind of expression this is.  */
239
  ENUM_BITFIELD(rtx_code) code: 16;
240

Jim Wilson committed
241
  /* The kind of value the expression has.  */
242 243
  ENUM_BITFIELD(machine_mode) mode : 8;

244 245 246
  /* 1 in a MEM if we should keep the alias set for this mem unchanged
     when we access a component.
     1 in a CALL_INSN if it is a sibling call.
247 248
     1 in a SET that is for a return.
     In a CODE_LABEL, part of the two-bit alternate entry field.  */
Jim Wilson committed
249
  unsigned int jump : 1;
250
  /* In a CODE_LABEL, part of the two-bit alternate entry field.
H.J. Lu committed
251
     1 in a MEM if it cannot trap.
Kenneth Zadeck committed
252 253
     1 in a CALL_INSN logically equivalent to
       ECF_LOOPING_CONST_OR_PURE and DECL_LOOPING_CONST_OR_PURE_P. */
Jim Wilson committed
254
  unsigned int call : 1;
255
  /* 1 in a REG, MEM, or CONCAT if the value is set at most once, anywhere.
256
     1 in a SUBREG used for SUBREG_PROMOTED_UNSIGNED_P.
Jim Wilson committed
257 258
     1 in a SYMBOL_REF if it addresses something in the per-function
     constants pool.
H.J. Lu committed
259
     1 in a CALL_INSN logically equivalent to ECF_CONST and TREE_READONLY.
Kenneth Zadeck committed
260
     1 in a NOTE, or EXPR_LIST for a const call.
261
     1 in a JUMP_INSN, CALL_INSN, or INSN of an annulling branch.  */
Jim Wilson committed
262
  unsigned int unchanging : 1;
263 264 265 266
  /* 1 in a MEM or ASM_OPERANDS expression if the memory reference is volatile.
     1 in an INSN, CALL_INSN, JUMP_INSN, CODE_LABEL, BARRIER, or NOTE
     if it has been deleted.
     1 in a REG expression if corresponds to a variable declared by the user,
Jim Wilson committed
267
     0 for an internally generated temporary.
268
     1 in a SUBREG used for SUBREG_PROMOTED_UNSIGNED_P.
269 270
     1 in a LABEL_REF, REG_LABEL_TARGET or REG_LABEL_OPERAND note for a
     non-local label.
271 272 273
     In a SYMBOL_REF, this flag is used for machine-specific purposes.
     In a PREFETCH, this flag indicates that it should be considered a scheduling
     barrier.  */
Jim Wilson committed
274
  unsigned int volatil : 1;
275
  /* 1 in a MEM referring to a field of an aggregate.
Jim Wilson committed
276 277 278
     0 if the MEM was a variable or the result of a * operator in C;
     1 if it was the result of a . or -> operator (on a struct) in C.
     1 in a REG if the register is used only in exit code a loop.
279
     1 in a SUBREG expression if was generated from a variable with a
280
     promoted mode.
Jim Wilson committed
281 282
     1 in a CODE_LABEL if the label is used for nonlocal gotos
     and must not be deleted even if its count is zero.
283 284
     1 in an INSN, JUMP_INSN or CALL_INSN if this insn must be scheduled
     together with the preceding insn.  Valid only within sched.
Jim Wilson committed
285 286
     1 in an INSN, JUMP_INSN, or CALL_INSN if insn is in a delay slot and
     from the target of a branch.  Valid from reorg until end of compilation;
287
     cleared before used.  */
Jim Wilson committed
288
  unsigned int in_struct : 1;
289 290
  /* At the end of RTL generation, 1 if this rtx is used.  This is used for
     copying shared structure.  See `unshare_all_rtl'.
291
     In a REG, this is not needed for that purpose, and used instead
Jim Wilson committed
292
     in `leaf_renumber_regs_insn'.
293
     1 in a SYMBOL_REF, means that emit_library_call
Jim Wilson committed
294 295
     has used it as the function.  */
  unsigned int used : 1;
296
  /* 1 in an INSN or a SET if this rtx is related to the call frame,
297
     either changing how we compute the frame address or saving and
298
     restoring registers in the prologue and epilogue.
299
     1 in a REG or MEM if it is a pointer.
300 301
     1 in a SYMBOL_REF if it addresses something in the per-function
     constant string pool.  */
x  
Jason Merrill committed
302
  unsigned frame_related : 1;
303
  /* 1 in a REG or PARALLEL that is the current function's return value.
304
     1 in a MEM if it refers to a scalar.
H.J. Lu committed
305 306
     1 in a SYMBOL_REF for a weak symbol.
     1 in a CALL_INSN logically equivalent to ECF_PURE and DECL_PURE_P. */
307
  unsigned return_val : 1;
308

Jim Wilson committed
309 310 311
  /* The first element of the operands of this rtx.
     The number of operands and their types are controlled
     by the `code' field, according to rtl.def.  */
312 313 314
  union u {
    rtunion fld[1];
    HOST_WIDE_INT hwint[1];
315
    struct block_symbol block_sym;
316
    struct real_value rv;
317
    struct fixed_value fv;
318
  } GTY ((special ("rtx_def"), desc ("GET_CODE (&%0)"))) u;
319
};
Jim Wilson committed
320

321 322 323 324
/* The size in bytes of an rtx header (code, mode and flags).  */
#define RTX_HDR_SIZE offsetof (struct rtx_def, u)

/* The size in bytes of an rtx with code CODE.  */
325
#define RTX_CODE_SIZE(CODE) rtx_code_size[CODE]
326

Jim Wilson committed
327 328
#define NULL_RTX (rtx) 0

Geoffrey Keating committed
329 330 331 332 333 334 335
/* The "next" and "previous" RTX, relative to this one.  */

#define RTX_NEXT(X) (rtx_next[GET_CODE (X)] == 0 ? NULL			\
		     : *(rtx *)(((char *)X) + rtx_next[GET_CODE (X)]))

/* FIXME: the "NEXT_INSN (PREV_INSN (X)) == X" condition shouldn't be needed.
 */
336 337 338 339
#define RTX_PREV(X) ((INSN_P (X)       			\
                      || NOTE_P (X)       		\
                      || BARRIER_P (X)        		\
                      || LABEL_P (X))    		\
Geoffrey Keating committed
340 341 342 343
                     && PREV_INSN (X) != NULL           \
                     && NEXT_INSN (PREV_INSN (X)) == X  \
                     ? PREV_INSN (X) : NULL)

Jim Wilson committed
344 345
/* Define macros to access the `code' field of the rtx.  */

346
#define GET_CODE(RTX)	    ((enum rtx_code) (RTX)->code)
347
#define PUT_CODE(RTX, CODE) ((RTX)->code = (CODE))
Jim Wilson committed
348

349
#define GET_MODE(RTX)	    ((enum machine_mode) (RTX)->mode)
350
#define PUT_MODE(RTX, MODE) ((RTX)->mode = (MODE))
Jim Wilson committed
351 352 353 354 355

/* RTL vector.  These appear inside RTX's when there is a need
   for a variable number of things.  The principle use is inside
   PARALLEL expressions.  */

356
struct GTY((variable_size)) rtvec_def {
357
  int num_elem;		/* number of elements */
358
  rtx GTY ((length ("%h.num_elem"))) elem[1];
359
};
Jim Wilson committed
360 361 362 363

#define NULL_RTVEC (rtvec) 0

#define GET_NUM_ELEM(RTVEC)		((RTVEC)->num_elem)
364
#define PUT_NUM_ELEM(RTVEC, NUM)	((RTVEC)->num_elem = (NUM))
Jim Wilson committed
365

366
/* Predicate yielding nonzero iff X is an rtx for a register.  */
Jim Wilson committed
367 368
#define REG_P(X) (GET_CODE (X) == REG)

369 370 371
/* Predicate yielding nonzero iff X is an rtx for a memory location.  */
#define MEM_P(X) (GET_CODE (X) == MEM)

372
/* Predicate yielding nonzero iff X is an rtx for a constant integer.  */
373 374
#define CONST_INT_P(X) (GET_CODE (X) == CONST_INT)

375 376 377 378
/* Predicate yielding true iff X is an rtx for a double-int
   or floating point constant.  */
#define CONST_DOUBLE_P(X) (GET_CODE (X) == CONST_DOUBLE)

379 380 381 382 383 384
/* Predicate yielding nonzero iff X is a label insn.  */
#define LABEL_P(X) (GET_CODE (X) == CODE_LABEL)

/* Predicate yielding nonzero iff X is a jump insn.  */
#define JUMP_P(X) (GET_CODE (X) == JUMP_INSN)

385 386 387 388 389 390
/* Predicate yielding nonzero iff X is a call insn.  */
#define CALL_P(X) (GET_CODE (X) == CALL_INSN)

/* Predicate yielding nonzero iff X is an insn that cannot jump.  */
#define NONJUMP_INSN_P(X) (GET_CODE (X) == INSN)

391 392 393 394 395 396 397 398 399
/* Predicate yielding nonzero iff X is a debug note/insn.  */
#define DEBUG_INSN_P(X) (GET_CODE (X) == DEBUG_INSN)

/* Predicate yielding nonzero iff X is an insn that is not a debug insn.  */
#define NONDEBUG_INSN_P(X) (INSN_P (X) && !DEBUG_INSN_P (X))

/* Nonzero if DEBUG_INSN_P may possibly hold.  */
#define MAY_HAVE_DEBUG_INSNS MAY_HAVE_DEBUG_STMTS

400 401
/* Predicate yielding nonzero iff X is a real insn.  */
#define INSN_P(X) \
402
  (NONJUMP_INSN_P (X) || DEBUG_INSN_P (X) || JUMP_P (X) || CALL_P (X))
403

404 405 406 407 408 409 410 411 412 413 414
/* Predicate yielding nonzero iff X is a note insn.  */
#define NOTE_P(X) (GET_CODE (X) == NOTE)

/* Predicate yielding nonzero iff X is a barrier insn.  */
#define BARRIER_P(X) (GET_CODE (X) == BARRIER)

/* Predicate yielding nonzero iff X is a data for a jump table.  */
#define JUMP_TABLE_DATA_P(INSN) \
  (JUMP_P (INSN) && (GET_CODE (PATTERN (INSN)) == ADDR_VEC || \
		     GET_CODE (PATTERN (INSN)) == ADDR_DIFF_VEC))

415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
/* 1 if X is a unary operator.  */

#define UNARY_P(X)   \
  (GET_RTX_CLASS (GET_CODE (X)) == RTX_UNARY)

/* 1 if X is a binary operator.  */

#define BINARY_P(X)   \
  ((GET_RTX_CLASS (GET_CODE (X)) & RTX_BINARY_MASK) == RTX_BINARY_RESULT)

/* 1 if X is an arithmetic operator.  */

#define ARITHMETIC_P(X)   \
  ((GET_RTX_CLASS (GET_CODE (X)) & RTX_ARITHMETIC_MASK)			\
    == RTX_ARITHMETIC_RESULT)

/* 1 if X is an arithmetic operator.  */

#define COMMUTATIVE_ARITH_P(X)   \
  (GET_RTX_CLASS (GET_CODE (X)) == RTX_COMM_ARITH)

/* 1 if X is a commutative arithmetic operator or a comparison operator.
   These two are sometimes selected together because it is possible to
   swap the two operands.  */

#define SWAPPABLE_OPERANDS_P(X)   \
  ((1 << GET_RTX_CLASS (GET_CODE (X)))					\
    & ((1 << RTX_COMM_ARITH) | (1 << RTX_COMM_COMPARE)			\
       | (1 << RTX_COMPARE)))

/* 1 if X is a non-commutative operator.  */

#define NON_COMMUTATIVE_P(X)   \
  ((GET_RTX_CLASS (GET_CODE (X)) & RTX_COMMUTATIVE_MASK)		\
    == RTX_NON_COMMUTATIVE_RESULT)

/* 1 if X is a commutative operator on integers.  */

#define COMMUTATIVE_P(X)   \
  ((GET_RTX_CLASS (GET_CODE (X)) & RTX_COMMUTATIVE_MASK)		\
    == RTX_COMMUTATIVE_RESULT)

/* 1 if X is a relational operator.  */

#define COMPARISON_P(X)   \
  ((GET_RTX_CLASS (GET_CODE (X)) & RTX_COMPARE_MASK) == RTX_COMPARE_RESULT)

Jim Wilson committed
462 463 464
/* 1 if X is a constant value that is an integer.  */

#define CONSTANT_P(X)   \
465
  (GET_RTX_CLASS (GET_CODE (X)) == RTX_CONST_OBJ)
Jim Wilson committed
466

467 468 469 470
/* 1 if X can be used to represent an object.  */
#define OBJECT_P(X)							\
  ((GET_RTX_CLASS (GET_CODE (X)) & RTX_OBJ_MASK) == RTX_OBJ_RESULT)

Jim Wilson committed
471 472
/* General accessor macros for accessing the fields of an rtx.  */

473
#if defined ENABLE_RTL_CHECKING && (GCC_VERSION >= 2007)
474 475
/* The bit with a star outside the statement expr and an & inside is
   so that N can be evaluated only once.  */
476
#define RTL_CHECK1(RTX, N, C1) __extension__				\
477
(*({ __typeof (RTX) const _rtx = (RTX); const int _n = (N);		\
478
     const enum rtx_code _code = GET_CODE (_rtx);			\
479
     if (_n < 0 || _n >= GET_RTX_LENGTH (_code))			\
480 481
       rtl_check_failed_bounds (_rtx, _n, __FILE__, __LINE__,		\
				__FUNCTION__);				\
482
     if (GET_RTX_FORMAT(_code)[_n] != C1)				\
483 484
       rtl_check_failed_type1 (_rtx, _n, C1, __FILE__, __LINE__,	\
			       __FUNCTION__);				\
485
     &_rtx->u.fld[_n]; }))
486

487
#define RTL_CHECK2(RTX, N, C1, C2) __extension__			\
488
(*({ __typeof (RTX) const _rtx = (RTX); const int _n = (N);		\
489
     const enum rtx_code _code = GET_CODE (_rtx);			\
490
     if (_n < 0 || _n >= GET_RTX_LENGTH (_code))			\
491 492
       rtl_check_failed_bounds (_rtx, _n, __FILE__, __LINE__,		\
				__FUNCTION__);				\
493 494 495
     if (GET_RTX_FORMAT(_code)[_n] != C1				\
	 && GET_RTX_FORMAT(_code)[_n] != C2)				\
       rtl_check_failed_type2 (_rtx, _n, C1, C2, __FILE__, __LINE__,	\
496
			       __FUNCTION__);				\
497
     &_rtx->u.fld[_n]; }))
498

499
#define RTL_CHECKC1(RTX, N, C) __extension__				\
500
(*({ __typeof (RTX) const _rtx = (RTX); const int _n = (N);		\
501 502 503
     if (GET_CODE (_rtx) != (C))					\
       rtl_check_failed_code1 (_rtx, (C), __FILE__, __LINE__,		\
			       __FUNCTION__);				\
504
     &_rtx->u.fld[_n]; }))
505

506
#define RTL_CHECKC2(RTX, N, C1, C2) __extension__			\
507
(*({ __typeof (RTX) const _rtx = (RTX); const int _n = (N);		\
508
     const enum rtx_code _code = GET_CODE (_rtx);			\
509 510 511
     if (_code != (C1) && _code != (C2))				\
       rtl_check_failed_code2 (_rtx, (C1), (C2), __FILE__, __LINE__,	\
			       __FUNCTION__); \
512
     &_rtx->u.fld[_n]; }))
513

514
#define RTVEC_ELT(RTVEC, I) __extension__				\
515
(*({ __typeof (RTVEC) const _rtvec = (RTVEC); const int _i = (I);	\
516 517
     if (_i < 0 || _i >= GET_NUM_ELEM (_rtvec))				\
       rtvec_check_failed_bounds (_rtvec, _i, __FILE__, __LINE__,	\
518
				  __FUNCTION__);			\
519 520
     &_rtvec->elem[_i]; }))

521
#define XWINT(RTX, N) __extension__					\
522
(*({ __typeof (RTX) const _rtx = (RTX); const int _n = (N);		\
523 524 525 526 527 528 529 530 531 532
     const enum rtx_code _code = GET_CODE (_rtx);			\
     if (_n < 0 || _n >= GET_RTX_LENGTH (_code))			\
       rtl_check_failed_bounds (_rtx, _n, __FILE__, __LINE__,		\
				__FUNCTION__);				\
     if (GET_RTX_FORMAT(_code)[_n] != 'w')				\
       rtl_check_failed_type1 (_rtx, _n, 'w', __FILE__, __LINE__,	\
			       __FUNCTION__);				\
     &_rtx->u.hwint[_n]; }))

#define XCWINT(RTX, N, C) __extension__					\
533
(*({ __typeof (RTX) const _rtx = (RTX);					\
534 535 536 537 538
     if (GET_CODE (_rtx) != (C))					\
       rtl_check_failed_code1 (_rtx, (C), __FILE__, __LINE__,		\
			       __FUNCTION__);				\
     &_rtx->u.hwint[N]; }))

539
#define XCMWINT(RTX, N, C, M) __extension__				\
540
(*({ __typeof (RTX) const _rtx = (RTX);					\
541 542 543 544 545 546
     if (GET_CODE (_rtx) != (C) || GET_MODE (_rtx) != (M))		\
       rtl_check_failed_code_mode (_rtx, (C), (M), false, __FILE__,	\
				   __LINE__, __FUNCTION__);		\
     &_rtx->u.hwint[N]; }))

#define XCNMPRV(RTX, C, M) __extension__				\
547
({ __typeof (RTX) const _rtx = (RTX);					\
548 549 550 551 552
   if (GET_CODE (_rtx) != (C) || GET_MODE (_rtx) == (M))		\
     rtl_check_failed_code_mode (_rtx, (C), (M), true, __FILE__,	\
				 __LINE__, __FUNCTION__);		\
   &_rtx->u.rv; })

553
#define XCNMPFV(RTX, C, M) __extension__				\
554
({ __typeof (RTX) const _rtx = (RTX);					\
555 556 557 558 559
   if (GET_CODE (_rtx) != (C) || GET_MODE (_rtx) == (M))		\
     rtl_check_failed_code_mode (_rtx, (C), (M), true, __FILE__,	\
				 __LINE__, __FUNCTION__);		\
   &_rtx->u.fv; })

560
#define BLOCK_SYMBOL_CHECK(RTX) __extension__				\
561 562
({ __typeof (RTX) const _symbol = (RTX);				\
   const unsigned int flags = RTL_CHECKC1 (_symbol, 1, SYMBOL_REF).rt_int; \
563
   if ((flags & SYMBOL_FLAG_HAS_BLOCK_INFO) == 0)			\
564 565 566 567
     rtl_check_failed_block_symbol (__FILE__, __LINE__,			\
				    __FUNCTION__);			\
   &_symbol->u.block_sym; })

568
extern void rtl_check_failed_bounds (const_rtx, int, const char *, int,
569
				     const char *)
570
    ATTRIBUTE_NORETURN;
571
extern void rtl_check_failed_type1 (const_rtx, int, int, const char *, int,
572
				    const char *)
573
    ATTRIBUTE_NORETURN;
574
extern void rtl_check_failed_type2 (const_rtx, int, int, int, const char *,
575
				    int, const char *)
576
    ATTRIBUTE_NORETURN;
577
extern void rtl_check_failed_code1 (const_rtx, enum rtx_code, const char *,
578
				    int, const char *)
579
    ATTRIBUTE_NORETURN;
580
extern void rtl_check_failed_code2 (const_rtx, enum rtx_code, enum rtx_code,
581
				    const char *, int, const char *)
582
    ATTRIBUTE_NORETURN;
583
extern void rtl_check_failed_code_mode (const_rtx, enum rtx_code, enum machine_mode,
584 585
					bool, const char *, int, const char *)
    ATTRIBUTE_NORETURN;
586 587
extern void rtl_check_failed_block_symbol (const char *, int, const char *)
    ATTRIBUTE_NORETURN;
588
extern void rtvec_check_failed_bounds (const_rtvec, int, const char *, int,
589
				       const char *)
590 591
    ATTRIBUTE_NORETURN;

592
#else   /* not ENABLE_RTL_CHECKING */
593

594 595 596 597
#define RTL_CHECK1(RTX, N, C1)      ((RTX)->u.fld[N])
#define RTL_CHECK2(RTX, N, C1, C2)  ((RTX)->u.fld[N])
#define RTL_CHECKC1(RTX, N, C)	    ((RTX)->u.fld[N])
#define RTL_CHECKC2(RTX, N, C1, C2) ((RTX)->u.fld[N])
598
#define RTVEC_ELT(RTVEC, I)	    ((RTVEC)->elem[I])
599 600
#define XWINT(RTX, N)		    ((RTX)->u.hwint[N])
#define XCWINT(RTX, N, C)	    ((RTX)->u.hwint[N])
601 602 603
#define XCMWINT(RTX, N, C, M)	    ((RTX)->u.hwint[N])
#define XCNMWINT(RTX, N, C, M)	    ((RTX)->u.hwint[N])
#define XCNMPRV(RTX, C, M)	    (&(RTX)->u.rv)
604
#define XCNMPFV(RTX, C, M)	    (&(RTX)->u.fv)
605
#define BLOCK_SYMBOL_CHECK(RTX)	    (&(RTX)->u.block_sym)
606 607 608

#endif

609 610 611 612 613
/* General accessor macros for accessing the flags of an rtx.  */

/* Access an individual rtx flag, with no checking of any kind.  */
#define RTX_FLAG(RTX, FLAG)	((RTX)->FLAG)

614
#if defined ENABLE_RTL_FLAG_CHECKING && (GCC_VERSION >= 2007)
615
#define RTL_FLAG_CHECK1(NAME, RTX, C1) __extension__			\
616
({ __typeof (RTX) const _rtx = (RTX);					\
617
   if (GET_CODE(_rtx) != C1)						\
618
     rtl_check_failed_flag  (NAME, _rtx, __FILE__, __LINE__,		\
619
			     __FUNCTION__);				\
620 621
   _rtx; })

622
#define RTL_FLAG_CHECK2(NAME, RTX, C1, C2) __extension__		\
623
({ __typeof (RTX) const _rtx = (RTX);					\
624
   if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2)			\
625
     rtl_check_failed_flag  (NAME,_rtx, __FILE__, __LINE__,		\
626
			      __FUNCTION__);				\
627 628
   _rtx; })

629
#define RTL_FLAG_CHECK3(NAME, RTX, C1, C2, C3) __extension__		\
630
({ __typeof (RTX) const _rtx = (RTX);					\
631
   if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2			\
632
       && GET_CODE(_rtx) != C3)						\
633
     rtl_check_failed_flag  (NAME, _rtx, __FILE__, __LINE__,		\
634
			     __FUNCTION__);				\
635 636
   _rtx; })

637
#define RTL_FLAG_CHECK4(NAME, RTX, C1, C2, C3, C4) __extension__	\
638
({ __typeof (RTX) const _rtx = (RTX);					\
639
   if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2			\
640
       && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4)			\
641
     rtl_check_failed_flag  (NAME, _rtx, __FILE__, __LINE__,		\
642
			      __FUNCTION__);				\
643 644
   _rtx; })

645
#define RTL_FLAG_CHECK5(NAME, RTX, C1, C2, C3, C4, C5) __extension__	\
646
({ __typeof (RTX) const _rtx = (RTX);					\
647
   if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2			\
648 649
       && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4			\
       && GET_CODE(_rtx) != C5)						\
650
     rtl_check_failed_flag  (NAME, _rtx, __FILE__, __LINE__,		\
651
			     __FUNCTION__);				\
652 653
   _rtx; })

654 655
#define RTL_FLAG_CHECK6(NAME, RTX, C1, C2, C3, C4, C5, C6)		\
  __extension__								\
656
({ __typeof (RTX) const _rtx = (RTX);					\
657
   if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2			\
658 659
       && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4			\
       && GET_CODE(_rtx) != C5 && GET_CODE(_rtx) != C6)			\
660
     rtl_check_failed_flag  (NAME,_rtx, __FILE__, __LINE__,		\
661
			     __FUNCTION__);				\
662 663
   _rtx; })

664 665
#define RTL_FLAG_CHECK7(NAME, RTX, C1, C2, C3, C4, C5, C6, C7)		\
  __extension__								\
666
({ __typeof (RTX) const _rtx = (RTX);					\
667
   if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2			\
668 669 670
       && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4			\
       && GET_CODE(_rtx) != C5 && GET_CODE(_rtx) != C6			\
       && GET_CODE(_rtx) != C7)						\
671
     rtl_check_failed_flag  (NAME, _rtx, __FILE__, __LINE__,		\
672
			     __FUNCTION__);				\
673 674
   _rtx; })

675 676
#define RTL_FLAG_CHECK8(NAME, RTX, C1, C2, C3, C4, C5, C6, C7, C8)	\
  __extension__								\
677
({ __typeof (RTX) const _rtx = (RTX);					\
678
   if (GET_CODE(_rtx) != C1 && GET_CODE(_rtx) != C2			\
679 680 681
       && GET_CODE(_rtx) != C3 && GET_CODE(_rtx) != C4			\
       && GET_CODE(_rtx) != C5 && GET_CODE(_rtx) != C6			\
       && GET_CODE(_rtx) != C7 && GET_CODE(_rtx) != C8)			\
682
     rtl_check_failed_flag  (NAME, _rtx, __FILE__, __LINE__,		\
683
			     __FUNCTION__);				\
684 685
   _rtx; })

686
extern void rtl_check_failed_flag (const char *, const_rtx, const char *,
687
				   int, const char *)
688 689 690 691 692
    ATTRIBUTE_NORETURN
    ;

#else	/* not ENABLE_RTL_FLAG_CHECKING */

693 694 695 696
#define RTL_FLAG_CHECK1(NAME, RTX, C1)					(RTX)
#define RTL_FLAG_CHECK2(NAME, RTX, C1, C2)				(RTX)
#define RTL_FLAG_CHECK3(NAME, RTX, C1, C2, C3)				(RTX)
#define RTL_FLAG_CHECK4(NAME, RTX, C1, C2, C3, C4)			(RTX)
697
#define RTL_FLAG_CHECK5(NAME, RTX, C1, C2, C3, C4, C5)		(RTX)
698 699 700
#define RTL_FLAG_CHECK6(NAME, RTX, C1, C2, C3, C4, C5, C6)		(RTX)
#define RTL_FLAG_CHECK7(NAME, RTX, C1, C2, C3, C4, C5, C6, C7)		(RTX)
#define RTL_FLAG_CHECK8(NAME, RTX, C1, C2, C3, C4, C5, C6, C7, C8)	(RTX)
701 702
#endif

703 704 705 706 707 708 709 710
#define XINT(RTX, N)	(RTL_CHECK2 (RTX, N, 'i', 'n').rt_int)
#define XSTR(RTX, N)	(RTL_CHECK2 (RTX, N, 's', 'S').rt_str)
#define XEXP(RTX, N)	(RTL_CHECK2 (RTX, N, 'e', 'u').rt_rtx)
#define XVEC(RTX, N)	(RTL_CHECK2 (RTX, N, 'E', 'V').rt_rtvec)
#define XMODE(RTX, N)	(RTL_CHECK1 (RTX, N, 'M').rt_type)
#define XTREE(RTX, N)   (RTL_CHECK1 (RTX, N, 't').rt_tree)
#define XBBDEF(RTX, N)	(RTL_CHECK1 (RTX, N, 'B').rt_bb)
#define XTMPL(RTX, N)	(RTL_CHECK1 (RTX, N, 'T').rt_str)
711 712 713 714

#define XVECEXP(RTX, N, M)	RTVEC_ELT (XVEC (RTX, N), M)
#define XVECLEN(RTX, N)		GET_NUM_ELEM (XVEC (RTX, N))

715
/* These are like XINT, etc. except that they expect a '0' field instead
716 717
   of the normal type code.  */

718 719 720 721 722 723 724 725
#define X0INT(RTX, N)	   (RTL_CHECK1 (RTX, N, '0').rt_int)
#define X0UINT(RTX, N)	   (RTL_CHECK1 (RTX, N, '0').rt_uint)
#define X0STR(RTX, N)	   (RTL_CHECK1 (RTX, N, '0').rt_str)
#define X0EXP(RTX, N)	   (RTL_CHECK1 (RTX, N, '0').rt_rtx)
#define X0VEC(RTX, N)	   (RTL_CHECK1 (RTX, N, '0').rt_rtvec)
#define X0MODE(RTX, N)	   (RTL_CHECK1 (RTX, N, '0').rt_type)
#define X0TREE(RTX, N)	   (RTL_CHECK1 (RTX, N, '0').rt_tree)
#define X0BBDEF(RTX, N)	   (RTL_CHECK1 (RTX, N, '0').rt_bb)
726 727
#define X0ADVFLAGS(RTX, N) (RTL_CHECK1 (RTX, N, '0').rt_addr_diff_vec_flags)
#define X0CSELIB(RTX, N)   (RTL_CHECK1 (RTX, N, '0').rt_cselib)
728 729
#define X0MEMATTR(RTX, N)  (RTL_CHECKC1 (RTX, N, MEM).rt_mem)
#define X0REGATTR(RTX, N)  (RTL_CHECKC1 (RTX, N, REG).rt_reg)
730
#define X0CONSTANT(RTX, N) (RTL_CHECK1 (RTX, N, '0').rt_constant)
731

732 733 734
/* Access a '0' field with any type.  */
#define X0ANY(RTX, N)	   RTL_CHECK1 (RTX, N, '0')

735 736 737 738 739 740 741 742
#define XCINT(RTX, N, C)      (RTL_CHECKC1 (RTX, N, C).rt_int)
#define XCUINT(RTX, N, C)     (RTL_CHECKC1 (RTX, N, C).rt_uint)
#define XCSTR(RTX, N, C)      (RTL_CHECKC1 (RTX, N, C).rt_str)
#define XCEXP(RTX, N, C)      (RTL_CHECKC1 (RTX, N, C).rt_rtx)
#define XCVEC(RTX, N, C)      (RTL_CHECKC1 (RTX, N, C).rt_rtvec)
#define XCMODE(RTX, N, C)     (RTL_CHECKC1 (RTX, N, C).rt_type)
#define XCTREE(RTX, N, C)     (RTL_CHECKC1 (RTX, N, C).rt_tree)
#define XCBBDEF(RTX, N, C)    (RTL_CHECKC1 (RTX, N, C).rt_bb)
743
#define XCCSELIB(RTX, N, C)   (RTL_CHECKC1 (RTX, N, C).rt_cselib)
744 745 746 747

#define XCVECEXP(RTX, N, M, C)	RTVEC_ELT (XCVEC (RTX, N, C), M)
#define XCVECLEN(RTX, N, C)	GET_NUM_ELEM (XCVEC (RTX, N, C))

748
#define XC2EXP(RTX, N, C1, C2)      (RTL_CHECKC2 (RTX, N, C1, C2).rt_rtx)
Jim Wilson committed
749 750 751 752 753

/* ACCESS MACROS for particular fields of insns.  */

/* Holds a unique number for each insn.
   These are not necessarily sequentially increasing.  */
754
#define INSN_UID(INSN)  XINT (INSN, 0)
Jim Wilson committed
755 756

/* Chain insns together in sequence.  */
757 758
#define PREV_INSN(INSN)	XEXP (INSN, 1)
#define NEXT_INSN(INSN)	XEXP (INSN, 2)
Jim Wilson committed
759

760
#define BLOCK_FOR_INSN(INSN) XBBDEF (INSN, 3)
761 762 763 764 765

/* The body of an insn.  */
#define PATTERN(INSN)	XEXP (INSN, 4)

#define INSN_LOCATOR(INSN) XINT (INSN, 5)
766 767
/* LOCATION of an RTX if relevant.  */
#define RTL_LOCATION(X) (INSN_P (X) ? \
768
			 locator_location (INSN_LOCATOR (X)) \
769 770 771
			 : UNKNOWN_LOCATION)
/* LOCATION of current INSN.  */
#define CURR_INSN_LOCATION (locator_location (curr_insn_locator ()))
Jim Wilson committed
772 773 774

/* Code number of instruction, from when it was recognized.
   -1 means this instruction has not been recognized yet.  */
775
#define INSN_CODE(INSN) XINT (INSN, 6)
Jim Wilson committed
776

777
#define RTX_FRAME_RELATED_P(RTX)					\
778 779
  (RTL_FLAG_CHECK6("RTX_FRAME_RELATED_P", (RTX), DEBUG_INSN, INSN,	\
		   CALL_INSN, JUMP_INSN, BARRIER, SET)->frame_related)
780 781 782

/* 1 if RTX is an insn that has been deleted.  */
#define INSN_DELETED_P(RTX)						\
783 784
  (RTL_FLAG_CHECK7("INSN_DELETED_P", (RTX), DEBUG_INSN, INSN,		\
		   CALL_INSN, JUMP_INSN,				\
785 786
		   CODE_LABEL, BARRIER, NOTE)->volatil)

Kenneth Zadeck committed
787 788 789 790 791 792 793 794 795 796
/* 1 if RTX is a call to a const function.  Built from ECF_CONST and
   TREE_READONLY.  */
#define RTL_CONST_CALL_P(RTX)					\
  (RTL_FLAG_CHECK1("RTL_CONST_CALL_P", (RTX), CALL_INSN)->unchanging)

/* 1 if RTX is a call to a pure function.  Built from ECF_PURE and
   DECL_PURE_P.  */
#define RTL_PURE_CALL_P(RTX)					\
  (RTL_FLAG_CHECK1("RTL_PURE_CALL_P", (RTX), CALL_INSN)->return_val)

797
/* 1 if RTX is a call to a const or pure function.  */
Kenneth Zadeck committed
798 799 800 801 802 803 804
#define RTL_CONST_OR_PURE_CALL_P(RTX) \
  (RTL_CONST_CALL_P(RTX) || RTL_PURE_CALL_P(RTX))

/* 1 if RTX is a call to a looping const or pure function.  Built from
   ECF_LOOPING_CONST_OR_PURE and DECL_LOOPING_CONST_OR_PURE_P.  */
#define RTL_LOOPING_CONST_OR_PURE_CALL_P(RTX)					\
  (RTL_FLAG_CHECK1("CONST_OR_PURE_CALL_P", (RTX), CALL_INSN)->call)
805 806 807 808 809

/* 1 if RTX is a call_insn for a sibling call.  */
#define SIBLING_CALL_P(RTX)						\
  (RTL_FLAG_CHECK1("SIBLING_CALL_P", (RTX), CALL_INSN)->jump)

810
/* 1 if RTX is a jump_insn, call_insn, or insn that is an annulling branch.  */
811
#define INSN_ANNULLED_BRANCH_P(RTX)					\
812
  (RTL_FLAG_CHECK3("INSN_ANNULLED_BRANCH_P", (RTX), JUMP_INSN, CALL_INSN, INSN)->unchanging)
813 814 815

/* 1 if RTX is an insn in a delay slot and is from the target of the branch.
   If the branch insn has INSN_ANNULLED_BRANCH_P set, this insn should only be
Jim Wilson committed
816 817
   executed if the branch is taken.  For annulled branches with this bit
   clear, the insn should be executed only if the branch is not taken.  */
818
#define INSN_FROM_TARGET_P(RTX)						\
819
  (RTL_FLAG_CHECK3("INSN_FROM_TARGET_P", (RTX), INSN, JUMP_INSN, CALL_INSN)->in_struct)
Jim Wilson committed
820

821 822
/* In an ADDR_DIFF_VEC, the flags for RTX for use by branch shortening.
   See the comments for ADDR_DIFF_VEC in rtl.def.  */
823 824
#define ADDR_DIFF_VEC_FLAGS(RTX) X0ADVFLAGS(RTX, 4)

825 826
/* In a VALUE, the value cselib has assigned to RTX.
   This is a "struct cselib_val_struct", see cselib.h.  */
827 828
#define CSELIB_VAL_PTR(RTX) X0CSELIB(RTX, 0)

Jim Wilson committed
829
/* Holds a list of notes on what this insn does to various REGs.
830 831
   It is a chain of EXPR_LIST rtx's, where the second operand is the
   chain pointer and the first operand is the REG being described.
Jim Wilson committed
832
   The mode field of the EXPR_LIST contains not a real machine mode
833
   but a value from enum reg_note.  */
834
#define REG_NOTES(INSN)	XEXP(INSN, 7)
Jim Wilson committed
835

836 837
enum reg_note
{
838 839 840 841
#define DEF_REG_NOTE(NAME) NAME,
#include "reg-notes.def"
#undef DEF_REG_NOTE
  REG_NOTE_MAX
842 843
};

Jim Wilson committed
844 845
/* Define macros to extract and insert the reg-note kind in an EXPR_LIST.  */
#define REG_NOTE_KIND(LINK) ((enum reg_note) GET_MODE (LINK))
846 847
#define PUT_REG_NOTE_KIND(LINK, KIND) \
  PUT_MODE (LINK, (enum machine_mode) (KIND))
Jim Wilson committed
848 849 850

/* Names for REG_NOTE's in EXPR_LIST insn's.  */

851
extern const char * const reg_note_name[];
Mike Stump committed
852
#define GET_REG_NOTE_NAME(MODE) (reg_note_name[(int) (MODE)])
Jim Wilson committed
853

854 855 856 857 858 859 860
/* This field is only present on CALL_INSNs.  It holds a chain of EXPR_LIST of
   USE and CLOBBER expressions.
     USE expressions list the registers filled with arguments that
   are passed to the function.
     CLOBBER expressions document the registers explicitly clobbered
   by this CALL_INSN.
     Pseudo registers can not be mentioned in this list.  */
861
#define CALL_INSN_FUNCTION_USAGE(INSN)	XEXP(INSN, 8)
862

Jim Wilson committed
863 864 865
/* The label-number of a code-label.  The assembler label
   is made from `L' and the label-number printed in decimal.
   Label numbers are unique in a compilation.  */
866
#define CODE_LABEL_NUMBER(INSN)	XINT (INSN, 6)
Jim Wilson committed
867

868 869 870 871
/* In a NOTE that is a line number, this is a string for the file name that the
   line is in.  We use the same field to record block numbers temporarily in
   NOTE_INSN_BLOCK_BEG and NOTE_INSN_BLOCK_END notes.  (We avoid lots of casts
   between ints and pointers if we use a different macro for the block number.)
872
   */
Jim Wilson committed
873

874
/* Opaque data.  */
875 876
#define NOTE_DATA(INSN)	        RTL_CHECKC1 (INSN, 4, NOTE)
#define NOTE_DELETED_LABEL_NAME(INSN) XCSTR (INSN, 4, NOTE)
877
#define SET_INSN_DELETED(INSN) set_insn_deleted (INSN);
878 879 880 881
#define NOTE_BLOCK(INSN)	XCTREE (INSN, 4, NOTE)
#define NOTE_EH_HANDLER(INSN)	XCINT (INSN, 4, NOTE)
#define NOTE_BASIC_BLOCK(INSN)	XCBBDEF (INSN, 4, NOTE)
#define NOTE_VAR_LOCATION(INSN)	XCEXP (INSN, 4, NOTE)
882

Jim Wilson committed
883 884
/* In a NOTE that is a line number, this is the line number.
   Other kinds of NOTEs are identified by negative numbers here.  */
885
#define NOTE_KIND(INSN) XCINT (INSN, 5, NOTE)
Jim Wilson committed
886

887
/* Nonzero if INSN is a note marking the beginning of a basic block.  */
888
#define NOTE_INSN_BASIC_BLOCK_P(INSN)			\
889
  (GET_CODE (INSN) == NOTE				\
890
   && NOTE_KIND (INSN) == NOTE_INSN_BASIC_BLOCK)
891

892
/* Variable declaration and the location of a variable.  */
893 894
#define PAT_VAR_LOCATION_DECL(PAT) (XCTREE ((PAT), 0, VAR_LOCATION))
#define PAT_VAR_LOCATION_LOC(PAT) (XCEXP ((PAT), 1, VAR_LOCATION))
Jim Wilson committed
895

896 897 898
/* Initialization status of the variable in the location.  Status
   can be unknown, uninitialized or initialized.  See enumeration
   type below.  */
899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
#define PAT_VAR_LOCATION_STATUS(PAT) \
  ((enum var_init_status) (XCINT ((PAT), 2, VAR_LOCATION)))

/* Accessors for a NOTE_INSN_VAR_LOCATION.  */
#define NOTE_VAR_LOCATION_DECL(NOTE) \
  PAT_VAR_LOCATION_DECL (NOTE_VAR_LOCATION (NOTE))
#define NOTE_VAR_LOCATION_LOC(NOTE) \
  PAT_VAR_LOCATION_LOC (NOTE_VAR_LOCATION (NOTE))
#define NOTE_VAR_LOCATION_STATUS(NOTE) \
  PAT_VAR_LOCATION_STATUS (NOTE_VAR_LOCATION (NOTE))

/* The VAR_LOCATION rtx in a DEBUG_INSN.  */
#define INSN_VAR_LOCATION(INSN) PATTERN (INSN)

/* Accessors for a tree-expanded var location debug insn.  */
#define INSN_VAR_LOCATION_DECL(INSN) \
  PAT_VAR_LOCATION_DECL (INSN_VAR_LOCATION (INSN))
#define INSN_VAR_LOCATION_LOC(INSN) \
  PAT_VAR_LOCATION_LOC (INSN_VAR_LOCATION (INSN))
#define INSN_VAR_LOCATION_STATUS(INSN) \
  PAT_VAR_LOCATION_STATUS (INSN_VAR_LOCATION (INSN))

/* Expand to the RTL that denotes an unknown variable location in a
   DEBUG_INSN.  */
#define gen_rtx_UNKNOWN_VAR_LOC() (gen_rtx_CLOBBER (VOIDmode, const0_rtx))

/* Determine whether X is such an unknown location.  */
#define VAR_LOC_UNKNOWN_P(X) \
  (GET_CODE (X) == CLOBBER && XEXP ((X), 0) == const0_rtx)

/* 1 if RTX is emitted after a call, but it should take effect before
   the call returns.  */
#define NOTE_DURING_CALL_P(RTX)				\
  (RTL_FLAG_CHECK1("NOTE_VAR_LOCATION_DURING_CALL_P", (RTX), NOTE)->call)
933

934 935 936
/* DEBUG_EXPR_DECL corresponding to a DEBUG_EXPR RTX.  */
#define DEBUG_EXPR_TREE_DECL(RTX) XCTREE (RTX, 0, DEBUG_EXPR)

937 938 939
/* VAR_DECL/PARM_DECL DEBUG_IMPLICIT_PTR takes address of.  */
#define DEBUG_IMPLICIT_PTR_DECL(RTX) XCTREE (RTX, 0, DEBUG_IMPLICIT_PTR)

940 941 942 943 944 945 946 947 948 949
/* Possible initialization status of a variable.   When requested
   by the user, this information is tracked and recorded in the DWARF
   debug information, along with the variable's location.  */
enum var_init_status
{
  VAR_INIT_STATUS_UNKNOWN,
  VAR_INIT_STATUS_UNINITIALIZED,
  VAR_INIT_STATUS_INITIALIZED
};

950
/* Codes that appear in the NOTE_KIND field for kinds of notes
951
   that are not line numbers.  These codes are all negative.
H.J. Lu committed
952

953 954 955 956
   Notice that we do not try to use zero here for any of
   the special note codes because sometimes the source line
   actually can be zero!  This happens (for example) when we
   are generating code for the per-translation-unit constructor
957
   and destructor routines for some C++ translation unit.  */
Jim Wilson committed
958

959 960
enum insn_note
{
961 962 963
#define DEF_INSN_NOTE(NAME) NAME,
#include "insn-notes.def"
#undef DEF_INSN_NOTE
964

965 966
  NOTE_INSN_MAX
};
967

Jim Wilson committed
968 969
/* Names for NOTE insn's other than line numbers.  */

970
extern const char * const note_insn_name[NOTE_INSN_MAX];
971
#define GET_NOTE_INSN_NAME(NOTE_CODE) \
972
  (note_insn_name[(NOTE_CODE)])
Jim Wilson committed
973 974 975

/* The name of a label, in case it corresponds to an explicit label
   in the input source code.  */
976
#define LABEL_NAME(RTX) XCSTR (RTX, 7, CODE_LABEL)
Jim Wilson committed
977 978 979

/* In jump.c, each label contains a count of the number
   of LABEL_REFs that point at it, so unused labels can be deleted.  */
980
#define LABEL_NUSES(RTX) XCINT (RTX, 5, CODE_LABEL)
Jim Wilson committed
981

982 983 984 985 986 987 988 989 990 991 992 993 994 995 996
/* Labels carry a two-bit field composed of the ->jump and ->call
   bits.  This field indicates whether the label is an alternate
   entry point, and if so, what kind.  */
enum label_kind
{
  LABEL_NORMAL = 0,	/* ordinary label */
  LABEL_STATIC_ENTRY,	/* alternate entry point, not exported */
  LABEL_GLOBAL_ENTRY,	/* alternate entry point, exported */
  LABEL_WEAK_ENTRY	/* alternate entry point, exported as weak symbol */
};

#if defined ENABLE_RTL_FLAG_CHECKING && (GCC_VERSION > 2007)

/* Retrieve the kind of LABEL.  */
#define LABEL_KIND(LABEL) __extension__					\
997
({ __typeof (LABEL) const _label = (LABEL);				\
998 999 1000 1001 1002 1003 1004
   if (GET_CODE (_label) != CODE_LABEL)					\
     rtl_check_failed_flag ("LABEL_KIND", _label, __FILE__, __LINE__,	\
			    __FUNCTION__);				\
   (enum label_kind) ((_label->jump << 1) | _label->call); })

/* Set the kind of LABEL.  */
#define SET_LABEL_KIND(LABEL, KIND) do {				\
1005
   __typeof (LABEL) const _label = (LABEL);				\
1006
   const unsigned int _kind = (KIND);					\
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
   if (GET_CODE (_label) != CODE_LABEL)					\
     rtl_check_failed_flag ("SET_LABEL_KIND", _label, __FILE__, __LINE__, \
			    __FUNCTION__);				\
   _label->jump = ((_kind >> 1) & 1);					\
   _label->call = (_kind & 1);						\
} while (0)

#else

/* Retrieve the kind of LABEL.  */
#define LABEL_KIND(LABEL) \
   ((enum label_kind) (((LABEL)->jump << 1) | (LABEL)->call))

/* Set the kind of LABEL.  */
#define SET_LABEL_KIND(LABEL, KIND) do {				\
1022 1023
   rtx const _label = (LABEL);						\
   const unsigned int _kind = (KIND);					\
1024 1025 1026 1027 1028 1029 1030
   _label->jump = ((_kind >> 1) & 1);					\
   _label->call = (_kind & 1);						\
} while (0)

#endif /* rtl flag checking */

#define LABEL_ALT_ENTRY_P(LABEL) (LABEL_KIND (LABEL) != LABEL_NORMAL)
1031

Jim Wilson committed
1032 1033 1034
/* In jump.c, each JUMP_INSN can point to a label that it can jump to,
   so that if the JUMP_INSN is deleted, the label's LABEL_NUSES can
   be decremented and possibly the label can be deleted.  */
1035
#define JUMP_LABEL(INSN)   XCEXP (INSN, 8, JUMP_INSN)
Jim Wilson committed
1036

1037 1038 1039
/* Once basic blocks are found, each CODE_LABEL starts a chain that
   goes through all the LABEL_REFs that jump to that label.  The chain
   eventually winds up at the CODE_LABEL: it is circular.  */
1040
#define LABEL_REFS(LABEL) XCEXP (LABEL, 4, CODE_LABEL)
Jim Wilson committed
1041

1042 1043 1044 1045
/* For a REG rtx, REGNO extracts the register number.  REGNO can only
   be used on RHS.  Use SET_REGNO to change the value.  */
#define REGNO(RTX) (rhs_regno(RTX))
#define SET_REGNO(RTX,N) (df_ref_change_reg_with_loc (REGNO(RTX), N, RTX), XCUINT (RTX, 0, REG) = N)
1046
#define SET_REGNO_RAW(RTX,N) (XCUINT (RTX, 0, REG) = N)
1047 1048 1049 1050

/* ORIGINAL_REGNO holds the number the register originally had; for a
   pseudo register turned into a hard reg this will hold the old pseudo
   register number.  */
1051
#define ORIGINAL_REGNO(RTX) X0UINT (RTX, 1)
Jim Wilson committed
1052

1053 1054
/* Force the REGNO macro to only be used on the lhs.  */
static inline unsigned int
1055
rhs_regno (const_rtx x)
1056 1057 1058 1059 1060
{
  return XCUINT (x, 0, REG);
}


1061 1062
/* 1 if RTX is a reg or parallel that is the current function's return
   value.  */
1063
#define REG_FUNCTION_VALUE_P(RTX)					\
1064
  (RTL_FLAG_CHECK2("REG_FUNCTION_VALUE_P", (RTX), REG, PARALLEL)->return_val)
Jim Wilson committed
1065

1066 1067 1068
/* 1 if RTX is a reg that corresponds to a variable declared by the user.  */
#define REG_USERVAR_P(RTX)						\
  (RTL_FLAG_CHECK1("REG_USERVAR_P", (RTX), REG)->volatil)
Jim Wilson committed
1069

1070 1071 1072
/* 1 if RTX is a reg that holds a pointer value.  */
#define REG_POINTER(RTX)						\
  (RTL_FLAG_CHECK1("REG_POINTER", (RTX), REG)->frame_related)
1073

1074 1075 1076 1077
/* 1 if RTX is a mem that holds a pointer value.  */
#define MEM_POINTER(RTX)						\
  (RTL_FLAG_CHECK1("MEM_POINTER", (RTX), MEM)->frame_related)

1078 1079 1080 1081
/* 1 if the given register REG corresponds to a hard register.  */
#define HARD_REGISTER_P(REG) (HARD_REGISTER_NUM_P (REGNO (REG)))

/* 1 if the given register number REG_NO corresponds to a hard register.  */
1082
#define HARD_REGISTER_NUM_P(REG_NO) ((REG_NO) < FIRST_PSEUDO_REGISTER)
1083

Jim Wilson committed
1084
/* For a CONST_INT rtx, INTVAL extracts the integer.  */
1085
#define INTVAL(RTX) XCWINT(RTX, 0, CONST_INT)
Stuart Hastings committed
1086
#define UINTVAL(RTX) ((unsigned HOST_WIDE_INT) INTVAL (RTX))
Jim Wilson committed
1087

Zack Weinberg committed
1088
/* For a CONST_DOUBLE:
1089
   For a VOIDmode, there are two integers CONST_DOUBLE_LOW is the
1090
     low-order word and ..._HIGH the high-order.
1091
   For a float, there is a REAL_VALUE_TYPE structure, and
1092
     CONST_DOUBLE_REAL_VALUE(r) is a pointer to it.  */
1093 1094 1095 1096
#define CONST_DOUBLE_LOW(r) XCMWINT (r, 0, CONST_DOUBLE, VOIDmode)
#define CONST_DOUBLE_HIGH(r) XCMWINT (r, 1, CONST_DOUBLE, VOIDmode)
#define CONST_DOUBLE_REAL_VALUE(r) \
  ((const struct real_value *) XCNMPRV (r, CONST_DOUBLE, VOIDmode))
Zack Weinberg committed
1097

1098 1099 1100 1101 1102 1103 1104
#define CONST_FIXED_VALUE(r) \
  ((const struct fixed_value *) XCNMPFV (r, CONST_FIXED, VOIDmode))
#define CONST_FIXED_VALUE_HIGH(r) \
  ((HOST_WIDE_INT) (CONST_FIXED_VALUE(r)->data.high))
#define CONST_FIXED_VALUE_LOW(r) \
  ((HOST_WIDE_INT) (CONST_FIXED_VALUE(r)->data.low))

1105 1106 1107 1108 1109 1110
/* For a CONST_VECTOR, return element #n.  */
#define CONST_VECTOR_ELT(RTX, N) XCVECEXP (RTX, 0, N, CONST_VECTOR)

/* For a CONST_VECTOR, return the number of elements in a vector.  */
#define CONST_VECTOR_NUNITS(RTX) XCVECLEN (RTX, 0, CONST_VECTOR)

Jim Wilson committed
1111
/* For a SUBREG rtx, SUBREG_REG extracts the value we want a subreg of.
1112
   SUBREG_BYTE extracts the byte-number.  */
Jim Wilson committed
1113

1114 1115
#define SUBREG_REG(RTX) XCEXP (RTX, 0, SUBREG)
#define SUBREG_BYTE(RTX) XCUINT (RTX, 1, SUBREG)
1116 1117

/* in rtlanal.c */
1118 1119 1120 1121 1122 1123 1124 1125 1126
/* Return the right cost to give to an operation
   to make the cost of the corresponding register-to-register instruction
   N times that of a fast register-to-register instruction.  */
#define COSTS_N_INSNS(N) ((N) * 4)

/* Maximum cost of an rtl expression.  This value has the special meaning
   not to use an rtx with this cost under any circumstances.  */
#define MAX_COST INT_MAX

1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
/* A structure to hold all available cost information about an rtl
   expression.  */
struct full_rtx_costs
{
  int speed;
  int size;
};

/* Initialize a full_rtx_costs structure C to the maximum cost.  */
static inline void
init_costs_to_max (struct full_rtx_costs *c)
{
  c->speed = MAX_COST;
  c->size = MAX_COST;
}

/* Initialize a full_rtx_costs structure C to zero cost.  */
static inline void
init_costs_to_zero (struct full_rtx_costs *c)
{
  c->speed = 0;
  c->size = 0;
}

/* Compare two full_rtx_costs structures A and B, returning true
   if A < B when optimizing for speed.  */
static inline bool
costs_lt_p (struct full_rtx_costs *a, struct full_rtx_costs *b,
	    bool speed)
{
  if (speed)
    return (a->speed < b->speed
	    || (a->speed == b->speed && a->size < b->size));
  else
    return (a->size < b->size
	    || (a->size == b->size && a->speed < b->speed));
}

/* Increase both members of the full_rtx_costs structure C by the
   cost of N insns.  */
static inline void
costs_add_n_insns (struct full_rtx_costs *c, int n)
{
  c->speed += COSTS_N_INSNS (n);
  c->size += COSTS_N_INSNS (n);
}

1174
extern void init_rtlanal (void);
1175
extern int rtx_cost (rtx, enum rtx_code, bool);
1176
extern int address_cost (rtx, enum machine_mode, addr_space_t, bool);
1177
extern void get_full_rtx_cost (rtx, enum rtx_code, struct full_rtx_costs *);
1178
extern unsigned int subreg_lsb (const_rtx);
1179 1180
extern unsigned int subreg_lsb_1 (enum machine_mode, enum machine_mode,
				  unsigned int);
1181 1182 1183 1184
extern unsigned int subreg_regno_offset	(unsigned int, enum machine_mode,
					 unsigned int, enum machine_mode);
extern bool subreg_offset_representable_p (unsigned int, enum machine_mode,
					   unsigned int, enum machine_mode);
1185
extern unsigned int subreg_regno (const_rtx);
1186 1187
extern int simplify_subreg_regno (unsigned int, enum machine_mode,
				  unsigned int, enum machine_mode);
1188
extern unsigned int subreg_nregs (const_rtx);
1189
extern unsigned int subreg_nregs_with_regno (unsigned int, const_rtx);
1190 1191
extern unsigned HOST_WIDE_INT nonzero_bits (const_rtx, enum machine_mode);
extern unsigned int num_sign_bit_copies (const_rtx, enum machine_mode);
1192
extern bool constant_pool_constant_p (rtx);
1193
extern bool truncated_to_mode (enum machine_mode, const_rtx);
1194
extern int low_bitmask_len (enum machine_mode, unsigned HOST_WIDE_INT);
1195

Jim Wilson committed
1196

1197 1198
/* 1 if RTX is a subreg containing a reg that is already known to be
   sign- or zero-extended from the mode of the subreg to the mode of
1199
   the reg.  SUBREG_PROMOTED_UNSIGNED_P gives the signedness of the
1200
   extension.
1201 1202 1203 1204

   When used as a LHS, is means that this extension must be done
   when assigning to SUBREG_REG.  */

1205 1206 1207 1208 1209
#define SUBREG_PROMOTED_VAR_P(RTX)					\
  (RTL_FLAG_CHECK1("SUBREG_PROMOTED", (RTX), SUBREG)->in_struct)

#define SUBREG_PROMOTED_UNSIGNED_SET(RTX, VAL)				\
do {									\
1210
  rtx const _rtx = RTL_FLAG_CHECK1("SUBREG_PROMOTED_UNSIGNED_SET", (RTX), SUBREG); \
1211
  if ((VAL) < 0)							\
1212
    _rtx->volatil = 1;							\
1213
  else {								\
1214 1215
    _rtx->volatil = 0;							\
    _rtx->unchanging = (VAL);						\
1216
  }									\
1217
} while (0)
1218 1219 1220 1221 1222 1223 1224 1225 1226

/* Valid for subregs which are SUBREG_PROMOTED_VAR_P().  In that case
   this gives the necessary extensions:
   0  - signed
   1  - normal unsigned
   -1 - pointer unsigned, which most often can be handled like unsigned
        extension, except for generating instructions where we need to
	emit special code (ptr_extend insns) on some architectures.  */

1227
#define SUBREG_PROMOTED_UNSIGNED_P(RTX)	\
1228
  ((RTL_FLAG_CHECK1("SUBREG_PROMOTED_UNSIGNED_P", (RTX), SUBREG)->volatil) \
1229
   ? -1 : (int) (RTX)->unchanging)
1230

Jim Wilson committed
1231 1232
/* Access various components of an ASM_OPERANDS rtx.  */

1233 1234 1235 1236 1237 1238 1239
#define ASM_OPERANDS_TEMPLATE(RTX) XCSTR (RTX, 0, ASM_OPERANDS)
#define ASM_OPERANDS_OUTPUT_CONSTRAINT(RTX) XCSTR (RTX, 1, ASM_OPERANDS)
#define ASM_OPERANDS_OUTPUT_IDX(RTX) XCINT (RTX, 2, ASM_OPERANDS)
#define ASM_OPERANDS_INPUT_VEC(RTX) XCVEC (RTX, 3, ASM_OPERANDS)
#define ASM_OPERANDS_INPUT_CONSTRAINT_VEC(RTX) XCVEC (RTX, 4, ASM_OPERANDS)
#define ASM_OPERANDS_INPUT(RTX, N) XCVECEXP (RTX, 3, N, ASM_OPERANDS)
#define ASM_OPERANDS_INPUT_LENGTH(RTX) XCVECLEN (RTX, 3, ASM_OPERANDS)
1240
#define ASM_OPERANDS_INPUT_CONSTRAINT_EXP(RTX, N) \
1241
  XCVECEXP (RTX, 4, N, ASM_OPERANDS)
1242
#define ASM_OPERANDS_INPUT_CONSTRAINT(RTX, N) \
1243
  XSTR (XCVECEXP (RTX, 4, N, ASM_OPERANDS), 0)
1244
#define ASM_OPERANDS_INPUT_MODE(RTX, N)  \
1245
  GET_MODE (XCVECEXP (RTX, 4, N, ASM_OPERANDS))
1246 1247 1248 1249
#define ASM_OPERANDS_LABEL_VEC(RTX) XCVEC (RTX, 5, ASM_OPERANDS)
#define ASM_OPERANDS_LABEL_LENGTH(RTX) XCVECLEN (RTX, 5, ASM_OPERANDS)
#define ASM_OPERANDS_LABEL(RTX, N) XCVECEXP (RTX, 5, N, ASM_OPERANDS)
#define ASM_OPERANDS_SOURCE_LOCATION(RTX) XCUINT (RTX, 6, ASM_OPERANDS)
1250
#define ASM_INPUT_SOURCE_LOCATION(RTX) XCUINT (RTX, 1, ASM_INPUT)
Jim Wilson committed
1251

1252 1253 1254 1255
/* 1 if RTX is a mem that is statically allocated in read-only memory.  */
#define MEM_READONLY_P(RTX) \
  (RTL_FLAG_CHECK1("MEM_READONLY_P", (RTX), MEM)->unchanging)

1256
/* 1 if RTX is a mem and we should keep the alias set for this mem
1257 1258
   unchanged when we access a component.  Set to 1, or example, when we
   are already in a non-addressable component of an aggregate.  */
1259 1260
#define MEM_KEEP_ALIAS_SET_P(RTX)					\
  (RTL_FLAG_CHECK1("MEM_KEEP_ALIAS_SET_P", (RTX), MEM)->jump)
1261

1262 1263 1264 1265
/* 1 if RTX is a mem or asm_operand for a volatile reference.  */
#define MEM_VOLATILE_P(RTX)						\
  (RTL_FLAG_CHECK3("MEM_VOLATILE_P", (RTX), MEM, ASM_OPERANDS,		\
		   ASM_INPUT)->volatil)
Jim Wilson committed
1266

1267
/* 1 if RTX is a mem that refers to an aggregate, either to the
1268
   aggregate itself or to a field of the aggregate.  If zero, RTX may
1269
   or may not be such a reference.  */
1270 1271
#define MEM_IN_STRUCT_P(RTX)						\
  (RTL_FLAG_CHECK1("MEM_IN_STRUCT_P", (RTX), MEM)->in_struct)
Jim Wilson committed
1272

1273
/* 1 if RTX is a MEM that refers to a scalar.  If zero, RTX may or may
1274
   not refer to a scalar.  */
1275
#define MEM_SCALAR_P(RTX)						\
1276
  (RTL_FLAG_CHECK1("MEM_SCALAR_P", (RTX), MEM)->return_val)
1277

1278 1279 1280 1281
/* 1 if RTX is a mem that cannot trap.  */
#define MEM_NOTRAP_P(RTX) \
  (RTL_FLAG_CHECK1("MEM_NOTRAP_P", (RTX), MEM)->call)

1282
/* If VAL is nonzero, set MEM_IN_STRUCT_P and clear MEM_SCALAR_P in
1283 1284 1285
   RTX.  Otherwise, vice versa.  Use this macro only when you are
   *sure* that you know that the MEM is in a structure, or is a
   scalar.  VAL is evaluated only once.  */
1286 1287
#define MEM_SET_IN_STRUCT_P(RTX, VAL)		\
do {						\
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298
  if (VAL)					\
    {						\
      MEM_IN_STRUCT_P (RTX) = 1;		\
      MEM_SCALAR_P (RTX) = 0;			\
    }						\
  else						\
    {						\
      MEM_IN_STRUCT_P (RTX) = 0;		\
      MEM_SCALAR_P (RTX) = 1;			\
    }						\
} while (0)
1299

1300 1301 1302 1303
/* The memory attribute block.  We provide access macros for each value
   in the block and provide defaults if none specified.  */
#define MEM_ATTRS(RTX) X0MEMATTR (RTX, 1)

1304 1305 1306 1307
/* The register attribute block.  We provide access macros for each value
   in the block and provide defaults if none specified.  */
#define REG_ATTRS(RTX) X0REGATTR (RTX, 2)

1308 1309
/* For a MEM rtx, the alias set.  If 0, this MEM is not in any alias
   set, and may alias anything.  Otherwise, the MEM can only alias
1310
   MEMs in a conflicting alias set.  This value is set in a
1311
   language-dependent manner in the front-end, and should not be
1312 1313
   altered in the back-end.  These set numbers are tested with
   alias_sets_conflict_p.  */
1314 1315 1316
#define MEM_ALIAS_SET(RTX) (MEM_ATTRS (RTX) == 0 ? 0 : MEM_ATTRS (RTX)->alias)

/* For a MEM rtx, the decl it is known to refer to, if it is known to
1317 1318
   refer to part of a DECL.  It may also be a COMPONENT_REF.  */
#define MEM_EXPR(RTX) (MEM_ATTRS (RTX) == 0 ? 0 : MEM_ATTRS (RTX)->expr)
1319

1320
/* For a MEM rtx, the offset from the start of MEM_EXPR, if known, as a
1321 1322 1323
   RTX that is always a CONST_INT.  */
#define MEM_OFFSET(RTX) (MEM_ATTRS (RTX) == 0 ? 0 : MEM_ATTRS (RTX)->offset)

1324 1325 1326 1327
/* For a MEM rtx, the address space.  */
#define MEM_ADDR_SPACE(RTX) (MEM_ATTRS (RTX) == 0 ? ADDR_SPACE_GENERIC \
						  : MEM_ATTRS (RTX)->addrspace)

1328 1329
/* For a MEM rtx, the size in bytes of the MEM, if known, as an RTX that
   is always a CONST_INT.  */
1330 1331 1332 1333
#define MEM_SIZE(RTX)							\
(MEM_ATTRS (RTX) != 0 ? MEM_ATTRS (RTX)->size				\
 : GET_MODE (RTX) != BLKmode ? GEN_INT (GET_MODE_SIZE (GET_MODE (RTX)))	\
 : 0)
1334

1335 1336
/* For a MEM rtx, the alignment in bits.  We can use the alignment of the
   mode as a default when STRICT_ALIGNMENT, but not if not.  */
1337 1338
#define MEM_ALIGN(RTX)							\
(MEM_ATTRS (RTX) != 0 ? MEM_ATTRS (RTX)->align				\
1339 1340
 : (STRICT_ALIGNMENT && GET_MODE (RTX) != BLKmode			\
    ? GET_MODE_ALIGNMENT (GET_MODE (RTX)) : BITS_PER_UNIT))
1341

1342 1343 1344 1345
/* For a REG rtx, the decl it is known to refer to, if it is known to
   refer to part of a DECL.  */
#define REG_EXPR(RTX) (REG_ATTRS (RTX) == 0 ? 0 : REG_ATTRS (RTX)->decl)

1346 1347
/* For a REG rtx, the offset from the start of REG_EXPR, if known, as an
   HOST_WIDE_INT.  */
1348 1349
#define REG_OFFSET(RTX) (REG_ATTRS (RTX) == 0 ? 0 : REG_ATTRS (RTX)->offset)

1350
/* Copy the attributes that apply to memory locations from RHS to LHS.  */
1351 1352 1353 1354
#define MEM_COPY_ATTRIBUTES(LHS, RHS)				\
  (MEM_VOLATILE_P (LHS) = MEM_VOLATILE_P (RHS),			\
   MEM_IN_STRUCT_P (LHS) = MEM_IN_STRUCT_P (RHS),		\
   MEM_SCALAR_P (LHS) = MEM_SCALAR_P (RHS),			\
1355
   MEM_NOTRAP_P (LHS) = MEM_NOTRAP_P (RHS),			\
1356
   MEM_READONLY_P (LHS) = MEM_READONLY_P (RHS),			\
1357
   MEM_KEEP_ALIAS_SET_P (LHS) = MEM_KEEP_ALIAS_SET_P (RHS),	\
1358
   MEM_POINTER (LHS) = MEM_POINTER (RHS),			\
1359
   MEM_ATTRS (LHS) = MEM_ATTRS (RHS))
1360

1361
/* 1 if RTX is a label_ref for a nonlocal label.  */
1362 1363
/* Likewise in an expr_list for a REG_LABEL_OPERAND or
   REG_LABEL_TARGET note.  */
1364
#define LABEL_REF_NONLOCAL_P(RTX)					\
1365
  (RTL_FLAG_CHECK1("LABEL_REF_NONLOCAL_P", (RTX), LABEL_REF)->volatil)
Richard Stallman committed
1366

1367 1368 1369
/* 1 if RTX is a code_label that should always be considered to be needed.  */
#define LABEL_PRESERVE_P(RTX)						\
  (RTL_FLAG_CHECK2("LABEL_PRESERVE_P", (RTX), CODE_LABEL, NOTE)->in_struct)
Jim Wilson committed
1370

1371
/* During sched, 1 if RTX is an insn that must be scheduled together
1372
   with the preceding insn.  */
1373
#define SCHED_GROUP_P(RTX)						\
1374 1375 1376
  (RTL_FLAG_CHECK4("SCHED_GROUP_P", (RTX), DEBUG_INSN, INSN,		\
		   JUMP_INSN, CALL_INSN					\
		   )->in_struct)
Jim Wilson committed
1377 1378 1379

/* For a SET rtx, SET_DEST is the place that is set
   and SET_SRC is the value it is set to.  */
1380 1381
#define SET_DEST(RTX) XC2EXP(RTX, 0, SET, CLOBBER)
#define SET_SRC(RTX) XCEXP(RTX, 1, SET)
1382 1383
#define SET_IS_RETURN_P(RTX)						\
  (RTL_FLAG_CHECK1("SET_IS_RETURN_P", (RTX), SET)->jump)
Jim Wilson committed
1384 1385

/* For a TRAP_IF rtx, TRAP_CONDITION is an expression.  */
1386 1387
#define TRAP_CONDITION(RTX) XCEXP (RTX, 0, TRAP_IF)
#define TRAP_CODE(RTX) XCEXP (RTX, 1, TRAP_IF)
Jim Wilson committed
1388

1389 1390 1391
/* For a COND_EXEC rtx, COND_EXEC_TEST is the condition to base
   conditionally executing the code on, COND_EXEC_CODE is the code
   to execute if the condition is true.  */
1392 1393
#define COND_EXEC_TEST(RTX) XCEXP (RTX, 0, COND_EXEC)
#define COND_EXEC_CODE(RTX) XCEXP (RTX, 1, COND_EXEC)
1394

1395 1396
/* 1 if RTX is a symbol_ref that addresses this function's rtl
   constants pool.  */
1397 1398
#define CONSTANT_POOL_ADDRESS_P(RTX)					\
  (RTL_FLAG_CHECK1("CONSTANT_POOL_ADDRESS_P", (RTX), SYMBOL_REF)->unchanging)
Jim Wilson committed
1399

1400 1401 1402 1403 1404
/* 1 if RTX is a symbol_ref that addresses a value in the file's
   tree constant pool.  This information is private to varasm.c.  */
#define TREE_CONSTANT_POOL_ADDRESS_P(RTX)				\
  (RTL_FLAG_CHECK1("TREE_CONSTANT_POOL_ADDRESS_P",			\
		   (RTX), SYMBOL_REF)->frame_related)
1405

1406 1407 1408
/* Used if RTX is a symbol_ref, for machine-specific purposes.  */
#define SYMBOL_REF_FLAG(RTX)						\
  (RTL_FLAG_CHECK1("SYMBOL_REF_FLAG", (RTX), SYMBOL_REF)->volatil)
Jim Wilson committed
1409

1410 1411 1412 1413
/* 1 if RTX is a symbol_ref that has been the library function in
   emit_library_call.  */
#define SYMBOL_REF_USED(RTX)						\
  (RTL_FLAG_CHECK1("SYMBOL_REF_USED", (RTX), SYMBOL_REF)->used)
Jim Wilson committed
1414

1415 1416
/* 1 if RTX is a symbol_ref for a weak symbol.  */
#define SYMBOL_REF_WEAK(RTX)						\
1417
  (RTL_FLAG_CHECK1("SYMBOL_REF_WEAK", (RTX), SYMBOL_REF)->return_val)
1418

1419 1420
/* A pointer attached to the SYMBOL_REF; either SYMBOL_REF_DECL or
   SYMBOL_REF_CONSTANT.  */
1421 1422 1423 1424 1425 1426
#define SYMBOL_REF_DATA(RTX) X0ANY ((RTX), 2)

/* Set RTX's SYMBOL_REF_DECL to DECL.  RTX must not be a constant
   pool symbol.  */
#define SET_SYMBOL_REF_DECL(RTX, DECL) \
  (gcc_assert (!CONSTANT_POOL_ADDRESS_P (RTX)), X0TREE ((RTX), 2) = (DECL))
1427

1428
/* The tree (decl or constant) associated with the symbol, or null.  */
1429 1430 1431
#define SYMBOL_REF_DECL(RTX) \
  (CONSTANT_POOL_ADDRESS_P (RTX) ? NULL : X0TREE ((RTX), 2))

1432 1433 1434 1435
/* Set RTX's SYMBOL_REF_CONSTANT to C.  RTX must be a constant pool symbol.  */
#define SET_SYMBOL_REF_CONSTANT(RTX, C) \
  (gcc_assert (CONSTANT_POOL_ADDRESS_P (RTX)), X0CONSTANT ((RTX), 2) = (C))

1436 1437 1438
/* The rtx constant pool entry for a symbol, or null.  */
#define SYMBOL_REF_CONSTANT(RTX) \
  (CONSTANT_POOL_ADDRESS_P (RTX) ? X0CONSTANT ((RTX), 2) : NULL)
1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467

/* A set of flags on a symbol_ref that are, in some respects, redundant with
   information derivable from the tree decl associated with this symbol.
   Except that we build a *lot* of SYMBOL_REFs that aren't associated with a
   decl.  In some cases this is a bug.  But beyond that, it's nice to cache
   this information to avoid recomputing it.  Finally, this allows space for
   the target to store more than one bit of information, as with
   SYMBOL_REF_FLAG.  */
#define SYMBOL_REF_FLAGS(RTX)	X0INT ((RTX), 1)

/* These flags are common enough to be defined for all targets.  They
   are computed by the default version of targetm.encode_section_info.  */

/* Set if this symbol is a function.  */
#define SYMBOL_FLAG_FUNCTION	(1 << 0)
#define SYMBOL_REF_FUNCTION_P(RTX) \
  ((SYMBOL_REF_FLAGS (RTX) & SYMBOL_FLAG_FUNCTION) != 0)
/* Set if targetm.binds_local_p is true.  */
#define SYMBOL_FLAG_LOCAL	(1 << 1)
#define SYMBOL_REF_LOCAL_P(RTX) \
  ((SYMBOL_REF_FLAGS (RTX) & SYMBOL_FLAG_LOCAL) != 0)
/* Set if targetm.in_small_data_p is true.  */
#define SYMBOL_FLAG_SMALL	(1 << 2)
#define SYMBOL_REF_SMALL_P(RTX) \
  ((SYMBOL_REF_FLAGS (RTX) & SYMBOL_FLAG_SMALL) != 0)
/* The three-bit field at [5:3] is true for TLS variables; use
   SYMBOL_REF_TLS_MODEL to extract the field as an enum tls_model.  */
#define SYMBOL_FLAG_TLS_SHIFT	3
#define SYMBOL_REF_TLS_MODEL(RTX) \
1468
  ((enum tls_model) ((SYMBOL_REF_FLAGS (RTX) >> SYMBOL_FLAG_TLS_SHIFT) & 7))
1469 1470 1471 1472
/* Set if this symbol is not defined in this translation unit.  */
#define SYMBOL_FLAG_EXTERNAL	(1 << 6)
#define SYMBOL_REF_EXTERNAL_P(RTX) \
  ((SYMBOL_REF_FLAGS (RTX) & SYMBOL_FLAG_EXTERNAL) != 0)
1473
/* Set if this symbol has a block_symbol structure associated with it.  */
1474 1475 1476
#define SYMBOL_FLAG_HAS_BLOCK_INFO (1 << 7)
#define SYMBOL_REF_HAS_BLOCK_INFO_P(RTX) \
  ((SYMBOL_REF_FLAGS (RTX) & SYMBOL_FLAG_HAS_BLOCK_INFO) != 0)
1477
/* Set if this symbol is a section anchor.  SYMBOL_REF_ANCHOR_P implies
1478
   SYMBOL_REF_HAS_BLOCK_INFO_P.  */
1479 1480 1481
#define SYMBOL_FLAG_ANCHOR	(1 << 8)
#define SYMBOL_REF_ANCHOR_P(RTX) \
  ((SYMBOL_REF_FLAGS (RTX) & SYMBOL_FLAG_ANCHOR) != 0)
1482 1483

/* Subsequent bits are available for the target to use.  */
1484
#define SYMBOL_FLAG_MACH_DEP_SHIFT	9
1485
#define SYMBOL_FLAG_MACH_DEP		(1 << SYMBOL_FLAG_MACH_DEP_SHIFT)
1486

1487 1488 1489
/* If SYMBOL_REF_HAS_BLOCK_INFO_P (RTX), this is the object_block
   structure to which the symbol belongs, or NULL if it has not been
   assigned a block.  */
1490 1491
#define SYMBOL_REF_BLOCK(RTX) (BLOCK_SYMBOL_CHECK (RTX)->block)

1492 1493 1494 1495
/* If SYMBOL_REF_HAS_BLOCK_INFO_P (RTX), this is the offset of RTX from
   the first object in SYMBOL_REF_BLOCK (RTX).  The value is negative if
   RTX has not yet been assigned to a block, or it has not been given an
   offset within that block.  */
1496 1497
#define SYMBOL_REF_BLOCK_OFFSET(RTX) (BLOCK_SYMBOL_CHECK (RTX)->offset)

1498 1499 1500 1501
/* True if RTX is flagged to be a scheduling barrier.  */
#define PREFETCH_SCHEDULE_BARRIER_P(RTX)					\
  (RTL_FLAG_CHECK1("PREFETCH_SCHEDULE_BARRIER_P", (RTX), PREFETCH)->volatil)

1502 1503 1504 1505 1506 1507 1508 1509 1510 1511
/* Indicate whether the machine has any sort of auto increment addressing.
   If not, we can avoid checking for REG_INC notes.  */

#if (defined (HAVE_PRE_INCREMENT) || defined (HAVE_PRE_DECREMENT) \
     || defined (HAVE_POST_INCREMENT) || defined (HAVE_POST_DECREMENT) \
     || defined (HAVE_PRE_MODIFY_DISP) || defined (HAVE_PRE_MODIFY_DISP) \
     || defined (HAVE_PRE_MODIFY_REG) || defined (HAVE_POST_MODIFY_REG))
#define AUTO_INC_DEC
#endif

Jim Wilson committed
1512 1513 1514
/* Define a macro to look for REG_INC notes,
   but save time on machines where they never exist.  */

1515
#ifdef AUTO_INC_DEC
1516 1517 1518 1519
#define FIND_REG_INC_NOTE(INSN, REG)			\
  ((REG) != NULL_RTX && REG_P ((REG))			\
   ? find_regno_note ((INSN), REG_INC, REGNO (REG))	\
   : find_reg_note ((INSN), REG_INC, (REG)))
Jim Wilson committed
1520
#else
1521
#define FIND_REG_INC_NOTE(INSN, REG) 0
Jim Wilson committed
1522 1523
#endif

1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539
#ifndef HAVE_PRE_INCREMENT
#define HAVE_PRE_INCREMENT 0
#endif

#ifndef HAVE_PRE_DECREMENT
#define HAVE_PRE_DECREMENT 0
#endif

#ifndef HAVE_POST_INCREMENT
#define HAVE_POST_INCREMENT 0
#endif

#ifndef HAVE_POST_DECREMENT
#define HAVE_POST_DECREMENT 0
#endif

1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555
#ifndef HAVE_POST_MODIFY_DISP
#define HAVE_POST_MODIFY_DISP 0
#endif

#ifndef HAVE_POST_MODIFY_REG
#define HAVE_POST_MODIFY_REG 0
#endif

#ifndef HAVE_PRE_MODIFY_DISP
#define HAVE_PRE_MODIFY_DISP 0
#endif

#ifndef HAVE_PRE_MODIFY_REG
#define HAVE_PRE_MODIFY_REG 0
#endif

1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591

/* Some architectures do not have complete pre/post increment/decrement
   instruction sets, or only move some modes efficiently.  These macros
   allow us to tune autoincrement generation.  */

#ifndef USE_LOAD_POST_INCREMENT
#define USE_LOAD_POST_INCREMENT(MODE)   HAVE_POST_INCREMENT
#endif

#ifndef USE_LOAD_POST_DECREMENT
#define USE_LOAD_POST_DECREMENT(MODE)   HAVE_POST_DECREMENT
#endif

#ifndef USE_LOAD_PRE_INCREMENT
#define USE_LOAD_PRE_INCREMENT(MODE)    HAVE_PRE_INCREMENT
#endif

#ifndef USE_LOAD_PRE_DECREMENT
#define USE_LOAD_PRE_DECREMENT(MODE)    HAVE_PRE_DECREMENT
#endif

#ifndef USE_STORE_POST_INCREMENT
#define USE_STORE_POST_INCREMENT(MODE)  HAVE_POST_INCREMENT
#endif

#ifndef USE_STORE_POST_DECREMENT
#define USE_STORE_POST_DECREMENT(MODE)  HAVE_POST_DECREMENT
#endif

#ifndef USE_STORE_PRE_INCREMENT
#define USE_STORE_PRE_INCREMENT(MODE)   HAVE_PRE_INCREMENT
#endif

#ifndef USE_STORE_PRE_DECREMENT
#define USE_STORE_PRE_DECREMENT(MODE)   HAVE_PRE_DECREMENT
#endif
Jim Wilson committed
1592

1593 1594 1595
/* Nonzero when we are generating CONCATs.  */
extern int generating_concat_p;

1596 1597 1598
/* Nonzero when we are expanding trees to RTL.  */
extern int currently_expanding_to_rtl;

Jim Wilson committed
1599 1600
/* Generally useful functions.  */

1601
/* In expmed.c */
1602
extern int ceil_log2 (unsigned HOST_WIDE_INT);
1603

Kaveh R. Ghazi committed
1604
/* In explow.c */
1605
extern HOST_WIDE_INT trunc_int_for_mode	(HOST_WIDE_INT, enum machine_mode);
1606
extern rtx plus_constant (rtx, HOST_WIDE_INT);
1607

1608
/* In rtl.c */
1609 1610 1611
extern rtx rtx_alloc_stat (RTX_CODE MEM_STAT_DECL);
#define rtx_alloc(c) rtx_alloc_stat (c MEM_STAT_INFO)

1612
extern rtvec rtvec_alloc (int);
1613
extern rtvec shallow_copy_rtvec (rtvec);
1614
extern bool shared_const_p (const_rtx);
1615
extern rtx copy_rtx (rtx);
1616
extern void dump_rtx_statistics (void);
1617 1618

/* In emit-rtl.c */
1619
extern rtx copy_rtx_if_shared (rtx);
1620 1621

/* In rtl.c */
1622 1623
extern unsigned int rtx_size (const_rtx);
extern rtx shallow_copy_rtx_stat (const_rtx MEM_STAT_DECL);
1624
#define shallow_copy_rtx(a) shallow_copy_rtx_stat (a MEM_STAT_INFO)
1625
extern int rtx_equal_p (const_rtx, const_rtx);
1626
extern hashval_t iterative_hash_rtx (const_rtx, hashval_t);
1627 1628

/* In emit-rtl.c */
1629 1630 1631
extern rtvec gen_rtvec_v (int, rtx *);
extern rtx gen_reg_rtx (enum machine_mode);
extern rtx gen_rtx_REG_offset (rtx, enum machine_mode, unsigned int, int);
1632
extern rtx gen_reg_rtx_offset (rtx, enum machine_mode, int);
Peter Bergner committed
1633
extern rtx gen_reg_rtx_and_attrs (rtx);
1634 1635
extern rtx gen_label_rtx (void);
extern rtx gen_lowpart_common (enum machine_mode, rtx);
1636 1637

/* In cse.c */
1638
extern rtx gen_lowpart_if_possible (enum machine_mode, rtx);
1639 1640

/* In emit-rtl.c */
1641 1642 1643
extern rtx gen_highpart (enum machine_mode, rtx);
extern rtx gen_highpart_mode (enum machine_mode, enum machine_mode, rtx);
extern rtx operand_subword (rtx, unsigned int, int, enum machine_mode);
1644 1645

/* In emit-rtl.c */
1646
extern rtx operand_subword_force (rtx, unsigned int, enum machine_mode);
1647
extern int subreg_lowpart_p (const_rtx);
1648 1649 1650 1651
extern unsigned int subreg_lowpart_offset (enum machine_mode,
					   enum machine_mode);
extern unsigned int subreg_highpart_offset (enum machine_mode,
					    enum machine_mode);
1652
extern int byte_lowpart_offset (enum machine_mode, enum machine_mode);
1653
extern rtx make_safe_from (rtx, rtx);
1654 1655 1656 1657
extern rtx convert_memory_address_addr_space (enum machine_mode, rtx,
					      addr_space_t);
#define convert_memory_address(to_mode,x) \
	convert_memory_address_addr_space ((to_mode), (x), ADDR_SPACE_GENERIC)
1658 1659 1660 1661 1662 1663
extern const char *get_insn_name (int);
extern rtx get_last_insn_anywhere (void);
extern rtx get_first_nonnote_insn (void);
extern rtx get_last_nonnote_insn (void);
extern void start_sequence (void);
extern void push_to_sequence (rtx);
1664
extern void push_to_sequence2 (rtx, rtx);
1665
extern void end_sequence (void);
1666
extern double_int rtx_to_double_int (const_rtx);
1667
extern rtx immed_double_int_const (double_int, enum machine_mode);
1668 1669
extern rtx immed_double_const (HOST_WIDE_INT, HOST_WIDE_INT,
			       enum machine_mode);
1670

1671 1672 1673 1674
/* In loop-iv.c  */

extern rtx lowpart_subreg (enum machine_mode, rtx, enum machine_mode);

1675
/* In varasm.c  */
1676
extern rtx force_const_mem (enum machine_mode, rtx);
1677 1678

/* In varasm.c  */
1679 1680

struct function;
1681 1682
extern rtx get_pool_constant (rtx);
extern rtx get_pool_constant_mark (rtx, bool *);
1683
extern enum machine_mode get_pool_mode (const_rtx);
1684
extern rtx simplify_subtraction (rtx);
1685 1686

/* In function.c  */
1687
extern rtx assign_stack_local (enum machine_mode, HOST_WIDE_INT, int);
H.J. Lu committed
1688
extern rtx assign_stack_local_1 (enum machine_mode, HOST_WIDE_INT, int, bool);
1689 1690 1691 1692
extern rtx assign_stack_temp (enum machine_mode, HOST_WIDE_INT, int);
extern rtx assign_stack_temp_for_type (enum machine_mode,
				       HOST_WIDE_INT, int, tree);
extern rtx assign_temp (tree, int, int, int);
1693

1694
/* In emit-rtl.c */
1695
extern rtx emit_insn_before (rtx, rtx);
1696
extern rtx emit_insn_before_noloc (rtx, rtx, struct basic_block_def *);
1697 1698
extern rtx emit_insn_before_setloc (rtx, rtx, int);
extern rtx emit_jump_insn_before (rtx, rtx);
1699
extern rtx emit_jump_insn_before_noloc (rtx, rtx);
1700 1701
extern rtx emit_jump_insn_before_setloc (rtx, rtx, int);
extern rtx emit_call_insn_before (rtx, rtx);
1702
extern rtx emit_call_insn_before_noloc (rtx, rtx);
1703
extern rtx emit_call_insn_before_setloc (rtx, rtx, int);
1704 1705 1706
extern rtx emit_debug_insn_before (rtx, rtx);
extern rtx emit_debug_insn_before_noloc (rtx, rtx);
extern rtx emit_debug_insn_before_setloc (rtx, rtx, int);
1707 1708
extern rtx emit_barrier_before (rtx);
extern rtx emit_label_before (rtx, rtx);
1709
extern rtx emit_note_before (enum insn_note, rtx);
1710
extern rtx emit_insn_after (rtx, rtx);
1711
extern rtx emit_insn_after_noloc (rtx, rtx, struct basic_block_def *);
1712 1713
extern rtx emit_insn_after_setloc (rtx, rtx, int);
extern rtx emit_jump_insn_after (rtx, rtx);
1714
extern rtx emit_jump_insn_after_noloc (rtx, rtx);
1715 1716
extern rtx emit_jump_insn_after_setloc (rtx, rtx, int);
extern rtx emit_call_insn_after (rtx, rtx);
1717
extern rtx emit_call_insn_after_noloc (rtx, rtx);
1718
extern rtx emit_call_insn_after_setloc (rtx, rtx, int);
1719 1720 1721
extern rtx emit_debug_insn_after (rtx, rtx);
extern rtx emit_debug_insn_after_noloc (rtx, rtx);
extern rtx emit_debug_insn_after_setloc (rtx, rtx, int);
1722 1723
extern rtx emit_barrier_after (rtx);
extern rtx emit_label_after (rtx, rtx);
1724
extern rtx emit_note_after (enum insn_note, rtx);
1725
extern rtx emit_insn (rtx);
1726
extern rtx emit_debug_insn (rtx);
1727 1728 1729 1730
extern rtx emit_jump_insn (rtx);
extern rtx emit_call_insn (rtx);
extern rtx emit_label (rtx);
extern rtx emit_barrier (void);
1731
extern rtx emit_note (enum insn_note);
1732
extern rtx emit_note_copy (rtx);
1733 1734 1735 1736
extern rtx gen_clobber (rtx);
extern rtx emit_clobber (rtx);
extern rtx gen_use (rtx);
extern rtx emit_use (rtx);
1737
extern rtx make_insn_raw (rtx);
1738
extern rtx make_debug_insn_raw (rtx);
1739
extern rtx make_jump_insn_raw (rtx);
1740 1741 1742 1743 1744
extern void add_function_usage_to (rtx, rtx);
extern rtx last_call_insn (void);
extern rtx previous_insn (rtx);
extern rtx next_insn (rtx);
extern rtx prev_nonnote_insn (rtx);
1745
extern rtx prev_nonnote_insn_bb (rtx);
1746
extern rtx next_nonnote_insn (rtx);
1747
extern rtx next_nonnote_insn_bb (rtx);
1748 1749
extern rtx prev_nondebug_insn (rtx);
extern rtx next_nondebug_insn (rtx);
1750 1751
extern rtx prev_nonnote_nondebug_insn (rtx);
extern rtx next_nonnote_nondebug_insn (rtx);
1752 1753 1754 1755
extern rtx prev_real_insn (rtx);
extern rtx next_real_insn (rtx);
extern rtx prev_active_insn (rtx);
extern rtx next_active_insn (rtx);
1756
extern int active_insn_p (const_rtx);
1757 1758
extern rtx prev_label (rtx);
extern rtx next_label (rtx);
1759
extern rtx skip_consecutive_labels (rtx);
1760 1761
extern rtx next_cc0_user (rtx);
extern rtx prev_cc0_setter (rtx);
1762

1763
/* In cfglayout.c  */
1764 1765
extern int insn_line (const_rtx);
extern const char * insn_file (const_rtx);
1766
extern location_t locator_location (int);
1767 1768
extern int locator_line (int);
extern const char * locator_file (int);
1769
extern bool locator_eq (int, int);
1770
extern int prologue_locator, epilogue_locator;
1771

1772
/* In jump.c */
1773 1774 1775 1776 1777 1778
extern enum rtx_code reverse_condition (enum rtx_code);
extern enum rtx_code reverse_condition_maybe_unordered (enum rtx_code);
extern enum rtx_code swap_condition (enum rtx_code);
extern enum rtx_code unsigned_condition (enum rtx_code);
extern enum rtx_code signed_condition (enum rtx_code);
extern void mark_jump_label (rtx, rtx, int);
1779
extern unsigned int cleanup_barriers (void);
1780 1781

/* In jump.c */
1782
extern rtx delete_related_insns (rtx);
1783 1784

/* In recog.c  */
1785
extern rtx *find_constant_term_loc (rtx *);
1786 1787

/* In emit-rtl.c  */
1788
extern rtx try_split (rtx, rtx, int);
1789
extern int split_branch_probability;
1790 1791

/* In unknown file  */
1792
extern rtx split_insns (rtx, rtx);
1793 1794

/* In simplify-rtx.c  */
1795 1796
extern rtx simplify_const_unary_operation (enum rtx_code, enum machine_mode,
					   rtx, enum machine_mode);
1797 1798
extern rtx simplify_unary_operation (enum rtx_code, enum machine_mode, rtx,
				     enum machine_mode);
1799 1800
extern rtx simplify_const_binary_operation (enum rtx_code, enum machine_mode,
					    rtx, rtx);
1801 1802 1803 1804
extern rtx simplify_binary_operation (enum rtx_code, enum machine_mode, rtx,
				      rtx);
extern rtx simplify_ternary_operation (enum rtx_code, enum machine_mode,
				       enum machine_mode, rtx, rtx, rtx);
1805 1806
extern rtx simplify_const_relational_operation (enum rtx_code,
						enum machine_mode, rtx, rtx);
1807
extern rtx simplify_relational_operation (enum rtx_code, enum machine_mode,
1808
					  enum machine_mode, rtx, rtx);
1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819
extern rtx simplify_gen_binary (enum rtx_code, enum machine_mode, rtx, rtx);
extern rtx simplify_gen_unary (enum rtx_code, enum machine_mode, rtx,
			       enum machine_mode);
extern rtx simplify_gen_ternary (enum rtx_code, enum machine_mode,
				 enum machine_mode, rtx, rtx, rtx);
extern rtx simplify_gen_relational (enum rtx_code, enum machine_mode,
				    enum machine_mode, rtx, rtx);
extern rtx simplify_subreg (enum machine_mode, rtx, enum machine_mode,
			    unsigned int);
extern rtx simplify_gen_subreg (enum machine_mode, rtx, enum machine_mode,
				unsigned int);
1820
extern rtx simplify_replace_fn_rtx (rtx, const_rtx,
1821
				    rtx (*fn) (rtx, const_rtx, void *), void *);
1822
extern rtx simplify_replace_rtx (rtx, const_rtx, rtx);
1823
extern rtx simplify_rtx (const_rtx);
1824
extern rtx avoid_constant_pool_reference (rtx);
1825
extern rtx delegitimize_mem_from_attrs (rtx);
1826
extern bool mode_signbit_p (enum machine_mode, const_rtx);
1827

1828
/* In reginfo.c  */
1829 1830
extern enum machine_mode choose_hard_reg_mode (unsigned int, unsigned int,
					       bool);
1831 1832

/* In emit-rtl.c  */
1833
extern rtx set_unique_reg_note (rtx, enum reg_note, rtx);
1834
extern void set_insn_deleted (rtx);
1835

1836 1837
/* Functions in rtlanal.c */

1838 1839 1840 1841 1842
/* Single set is implemented as macro for performance reasons.  */
#define single_set(I) (INSN_P (I) \
		       ? (GET_CODE (PATTERN (I)) == SET \
			  ? PATTERN (I) : single_set_1 (I)) \
		       : NULL_RTX)
1843
#define single_set_1(I) single_set_2 (I, PATTERN (I))
1844

1845
/* Structure used for passing data to REPLACE_LABEL.  */
1846
typedef struct replace_label_data
1847 1848 1849
{
  rtx r1;
  rtx r2;
1850 1851
  bool update_label_nuses;
} replace_label_data;
1852

1853 1854 1855
extern int rtx_addr_can_trap_p (const_rtx);
extern bool nonzero_address_p (const_rtx);
extern int rtx_unstable_p (const_rtx);
1856 1857
extern bool rtx_varies_p (const_rtx, bool);
extern bool rtx_addr_varies_p (const_rtx, bool);
1858 1859 1860
extern HOST_WIDE_INT get_integer_term (const_rtx);
extern rtx get_related_value (const_rtx);
extern bool offset_within_block_p (const_rtx, HOST_WIDE_INT);
1861
extern void split_const (rtx, rtx *, rtx *);
1862 1863 1864 1865
extern int reg_mentioned_p (const_rtx, const_rtx);
extern int count_occurrences (const_rtx, const_rtx, int);
extern int reg_referenced_p (const_rtx, const_rtx);
extern int reg_used_between_p (const_rtx, const_rtx, const_rtx);
1866
extern int reg_set_between_p (const_rtx, const_rtx, const_rtx);
1867
extern int commutative_operand_precedence (rtx);
Peter Bergner committed
1868
extern bool swap_commutative_operands_p (rtx, rtx);
1869
extern int modified_between_p (const_rtx, const_rtx, const_rtx);
1870
extern int no_labels_between_p (const_rtx, const_rtx);
1871
extern int modified_in_p (const_rtx, const_rtx);
1872
extern int reg_set_p (const_rtx, const_rtx);
1873 1874 1875
extern rtx single_set_2 (const_rtx, const_rtx);
extern int multiple_sets (const_rtx);
extern int set_noop_p (const_rtx);
1876
extern int noop_move_p (const_rtx);
1877
extern rtx find_last_value (rtx, rtx *, rtx, int);
1878 1879
extern int refers_to_regno_p (unsigned int, unsigned int, const_rtx, rtx *);
extern int reg_overlap_mentioned_p (const_rtx, const_rtx);
1880 1881
extern const_rtx set_of (const_rtx, const_rtx);
extern void note_stores (const_rtx, void (*) (rtx, const_rtx, void *), void *);
1882
extern void note_uses (rtx *, void (*) (rtx *, void *), void *);
1883 1884 1885 1886 1887 1888 1889 1890
extern int dead_or_set_p (const_rtx, const_rtx);
extern int dead_or_set_regno_p (const_rtx, unsigned int);
extern rtx find_reg_note (const_rtx, enum reg_note, const_rtx);
extern rtx find_regno_note (const_rtx, enum reg_note, unsigned int);
extern rtx find_reg_equal_equiv_note (const_rtx);
extern rtx find_constant_src (const_rtx);
extern int find_reg_fusage (const_rtx, enum rtx_code, const_rtx);
extern int find_regno_fusage (const_rtx, enum rtx_code, unsigned int);
1891
extern rtx alloc_reg_note (enum reg_note, rtx, rtx);
1892
extern void add_reg_note (rtx, enum reg_note, rtx);
1893
extern void remove_note (rtx, const_rtx);
1894
extern void remove_reg_equal_equiv_notes (rtx);
1895
extern void remove_reg_equal_equiv_notes_for_regno (unsigned int);
1896 1897 1898
extern int side_effects_p (const_rtx);
extern int volatile_refs_p (const_rtx);
extern int volatile_insn_p (const_rtx);
1899
extern int may_trap_p_1 (const_rtx, unsigned);
1900 1901
extern int may_trap_p (const_rtx);
extern int may_trap_or_fault_p (const_rtx);
1902 1903 1904 1905 1906 1907 1908
extern bool can_throw_internal (const_rtx);
extern bool can_throw_external (const_rtx);
extern bool insn_could_throw_p (const_rtx);
extern bool insn_nothrow_p (const_rtx);
extern bool can_nonlocal_goto (const_rtx);
extern void copy_reg_eh_region_note_forward (rtx, rtx, rtx);
extern void copy_reg_eh_region_note_backward(rtx, rtx, rtx);
1909
extern int inequality_comparisons_p (const_rtx);
1910 1911 1912
extern rtx replace_rtx (rtx, rtx, rtx);
extern int replace_label (rtx *, void *);
extern int rtx_referenced_p (rtx, rtx);
1913 1914
extern bool tablejump_p (const_rtx, rtx *, rtx *);
extern int computed_jump_p (const_rtx);
1915

1916 1917
typedef int (*rtx_function) (rtx *, void *);
extern int for_each_rtx (rtx *, rtx_function, void *);
1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928

typedef int (*rtx_equal_p_callback_function) (const_rtx *, const_rtx *,
                                              rtx *, rtx *);
extern int rtx_equal_p_cb (const_rtx, const_rtx,
                           rtx_equal_p_callback_function);

typedef int (*hash_rtx_callback_function) (const_rtx, enum machine_mode, rtx *,
                                           enum machine_mode *);
extern unsigned hash_rtx_cb (const_rtx, enum machine_mode, int *, int *,
                             bool, hash_rtx_callback_function);

1929
extern rtx regno_use_in (unsigned int, rtx);
1930 1931 1932 1933
extern int auto_inc_p (const_rtx);
extern int in_expr_list_p (const_rtx, const_rtx);
extern void remove_node_from_expr_list (const_rtx, rtx *);
extern int loc_mentioned_in_p (rtx *, const_rtx);
1934
extern rtx find_first_parameter_load (rtx, rtx);
1935
extern bool keep_with_call_p (const_rtx);
1936
extern bool label_is_jump_target_p (const_rtx, const_rtx);
1937
extern int insn_rtx_cost (rtx, bool);
Jim Wilson committed
1938

1939 1940 1941 1942 1943 1944 1945 1946
/* Given an insn and condition, return a canonical description of
   the test being made.  */
extern rtx canonicalize_condition (rtx, rtx, int, rtx *, rtx, int, int);

/* Given a JUMP_INSN, return a canonical description of the test
   being made.  */
extern rtx get_condition (rtx, rtx *, int, int);

1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962
/* Information about a subreg of a hard register.  */
struct subreg_info
{
  /* Offset of first hard register involved in the subreg.  */
  int offset;
  /* Number of hard registers involved in the subreg.  */
  int nregs;
  /* Whether this subreg can be represented as a hard reg with the new
     mode.  */
  bool representable_p;
};

extern void subreg_get_info (unsigned int, enum machine_mode,
			     unsigned int, enum machine_mode,
			     struct subreg_info *);

1963 1964
/* lists.c */

1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975
extern void free_EXPR_LIST_list		(rtx *);
extern void free_INSN_LIST_list		(rtx *);
extern void free_EXPR_LIST_node		(rtx);
extern void free_INSN_LIST_node		(rtx);
extern rtx alloc_INSN_LIST			(rtx, rtx);
extern rtx alloc_EXPR_LIST			(int, rtx, rtx);
extern void remove_free_INSN_LIST_elem (rtx, rtx *);
extern rtx remove_list_elem (rtx, rtx *);
extern rtx remove_free_INSN_LIST_node (rtx *);
extern rtx remove_free_EXPR_LIST_node (rtx *);

1976

1977
/* reginfo.c */
1978

Vladimir Makarov committed
1979 1980 1981
/* Initialize may_move_cost and friends for mode M.  */
extern void init_move_cost (enum machine_mode);
/* Resize reg info.  */
1982
extern bool resize_reg_info (void);
1983
/* Free up register info memory.  */
1984
extern void free_reg_info (void);
1985 1986
extern void init_subregs_of_mode (void);
extern void finish_subregs_of_mode (void);
1987

1988
/* recog.c */
1989
extern rtx extract_asm_operands (rtx);
1990
extern int asm_noperands (const_rtx);
1991
extern const char *decode_asm_operands (rtx, rtx *, rtx **, const char **,
1992
					enum machine_mode *, location_t *);
Jim Wilson committed
1993

1994 1995
extern enum reg_class reg_preferred_class (int);
extern enum reg_class reg_alternate_class (int);
1996 1997 1998
extern enum reg_class reg_cover_class (int);
extern void setup_reg_classes (int, enum reg_class, enum reg_class,
			       enum reg_class);
Jim Wilson committed
1999

2000
extern void split_all_insns (void);
2001
extern unsigned int split_all_insns_noflow (void);
2002

2003
#define MAX_SAVED_CONST_INT 64
2004
extern GTY(()) rtx const_int_rtx[MAX_SAVED_CONST_INT * 2 + 1];
2005

2006 2007 2008 2009
#define const0_rtx	(const_int_rtx[MAX_SAVED_CONST_INT])
#define const1_rtx	(const_int_rtx[MAX_SAVED_CONST_INT+1])
#define const2_rtx	(const_int_rtx[MAX_SAVED_CONST_INT+2])
#define constm1_rtx	(const_int_rtx[MAX_SAVED_CONST_INT-1])
2010
extern GTY(()) rtx const_true_rtx;
2011

2012
extern GTY(()) rtx const_tiny_rtx[3][(int) MAX_MACHINE_MODE];
2013

2014
/* Returns a constant 0 rtx in mode MODE.  Integer modes are treated the
2015 2016 2017 2018 2019 2020 2021 2022
   same as VOIDmode.  */

#define CONST0_RTX(MODE) (const_tiny_rtx[0][(int) (MODE)])

/* Likewise, for the constants 1 and 2.  */

#define CONST1_RTX(MODE) (const_tiny_rtx[1][(int) (MODE)])
#define CONST2_RTX(MODE) (const_tiny_rtx[2][(int) (MODE)])
Jim Wilson committed
2023

2024 2025 2026 2027 2028
/* If HARD_FRAME_POINTER_REGNUM is defined, then a special dummy reg
   is used to represent the frame pointer.  This is because the
   hard frame pointer and the automatic variables are separated by an amount
   that cannot be determined until after register allocation.  We can assume
   that in this case ELIMINABLE_REGS will be defined, one action of which
Kazu Hirata committed
2029
   will be to eliminate FRAME_POINTER_REGNUM into HARD_FRAME_POINTER_REGNUM.  */
2030 2031 2032 2033
#ifndef HARD_FRAME_POINTER_REGNUM
#define HARD_FRAME_POINTER_REGNUM FRAME_POINTER_REGNUM
#endif

2034 2035 2036 2037 2038 2039 2040 2041 2042 2043
#ifndef HARD_FRAME_POINTER_IS_FRAME_POINTER
#define HARD_FRAME_POINTER_IS_FRAME_POINTER \
  (HARD_FRAME_POINTER_REGNUM == FRAME_POINTER_REGNUM)
#endif

#ifndef HARD_FRAME_POINTER_IS_ARG_POINTER
#define HARD_FRAME_POINTER_IS_ARG_POINTER \
  (HARD_FRAME_POINTER_REGNUM == ARG_POINTER_REGNUM)
#endif

2044 2045
/* Index labels for global_rtl.  */
enum global_rtl_index
2046
{
2047 2048 2049 2050 2051 2052 2053 2054 2055 2056
  GR_PC,
  GR_CC0,
  GR_STACK_POINTER,
  GR_FRAME_POINTER,
/* For register elimination to work properly these hard_frame_pointer_rtx,
   frame_pointer_rtx, and arg_pointer_rtx must be the same if they refer to
   the same register.  */
#if FRAME_POINTER_REGNUM == ARG_POINTER_REGNUM
  GR_ARG_POINTER = GR_FRAME_POINTER,
#endif
2057
#if HARD_FRAME_POINTER_IS_FRAME_POINTER
2058 2059 2060 2061 2062
  GR_HARD_FRAME_POINTER = GR_FRAME_POINTER,
#else
  GR_HARD_FRAME_POINTER,
#endif
#if FRAME_POINTER_REGNUM != ARG_POINTER_REGNUM
2063
#if HARD_FRAME_POINTER_IS_ARG_POINTER
2064 2065 2066 2067 2068 2069 2070 2071 2072 2073
  GR_ARG_POINTER = GR_HARD_FRAME_POINTER,
#else
  GR_ARG_POINTER,
#endif
#endif
  GR_VIRTUAL_INCOMING_ARGS,
  GR_VIRTUAL_STACK_ARGS,
  GR_VIRTUAL_STACK_DYNAMIC,
  GR_VIRTUAL_OUTGOING_ARGS,
  GR_VIRTUAL_CFA,
2074
  GR_VIRTUAL_PREFERRED_STACK_BOUNDARY,
2075 2076 2077 2078

  GR_MAX
};

2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110
/* Target-dependent globals.  */
struct GTY(()) target_rtl {
  /* All references to the hard registers in global_rtl_index go through
     these unique rtl objects.  On machines where the frame-pointer and
     arg-pointer are the same register, they use the same unique object.

     After register allocation, other rtl objects which used to be pseudo-regs
     may be clobbered to refer to the frame-pointer register.
     But references that were originally to the frame-pointer can be
     distinguished from the others because they contain frame_pointer_rtx.

     When to use frame_pointer_rtx and hard_frame_pointer_rtx is a little
     tricky: until register elimination has taken place hard_frame_pointer_rtx
     should be used if it is being set, and frame_pointer_rtx otherwise.  After
     register elimination hard_frame_pointer_rtx should always be used.
     On machines where the two registers are same (most) then these are the
     same.  */
  rtx x_global_rtl[GR_MAX];

  /* A unique representation of (REG:Pmode PIC_OFFSET_TABLE_REGNUM).  */
  rtx x_pic_offset_table_rtx;

  /* A unique representation of (REG:Pmode RETURN_ADDRESS_POINTER_REGNUM).
     This is used to implement __builtin_return_address for some machines;
     see for instance the MIPS port.  */
  rtx x_return_address_pointer_rtx;

  /* Commonly used RTL for hard registers.  These objects are not
     necessarily unique, so we allocate them separately from global_rtl.
     They are initialized once per compilation unit, then copied into
     regno_reg_rtx at the beginning of each function.  */
  rtx x_initial_regno_reg_rtx[FIRST_PSEUDO_REGISTER];
2111 2112 2113

  /* A sample (mem:M stack_pointer_rtx) rtx for each mode M.  */
  rtx x_top_of_stack[MAX_MACHINE_MODE];
2114 2115 2116 2117

  /* Static hunks of RTL used by the aliasing code; these are treated
     as persistent to avoid unnecessary RTL allocations.  */
  rtx x_static_reg_base_value[FIRST_PSEUDO_REGISTER];
2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132
};

extern GTY(()) struct target_rtl default_target_rtl;
#if SWITCHABLE_TARGET
extern struct target_rtl *this_target_rtl;
#else
#define this_target_rtl (&default_target_rtl)
#endif

#define global_rtl				\
  (this_target_rtl->x_global_rtl)
#define pic_offset_table_rtx \
  (this_target_rtl->x_pic_offset_table_rtx)
#define return_address_pointer_rtx \
  (this_target_rtl->x_return_address_pointer_rtx)
2133 2134
#define top_of_stack \
  (this_target_rtl->x_top_of_stack)
2135 2136 2137 2138

/* Standard pieces of rtx, to be substituted directly into things.  */
#define pc_rtx                  (global_rtl[GR_PC])
#define cc0_rtx                 (global_rtl[GR_CC0])
2139

Jim Wilson committed
2140 2141 2142
/* All references to certain hard regs, except those created
   by allocating pseudo regs into them (when that's possible),
   go through these unique rtx objects.  */
2143 2144 2145 2146
#define stack_pointer_rtx       (global_rtl[GR_STACK_POINTER])
#define frame_pointer_rtx       (global_rtl[GR_FRAME_POINTER])
#define hard_frame_pointer_rtx	(global_rtl[GR_HARD_FRAME_POINTER])
#define arg_pointer_rtx		(global_rtl[GR_ARG_POINTER])
2147

2148 2149
/* Include the RTL generation functions.  */

2150
#ifndef GENERATOR_FILE
2151
#include "genrtl.h"
2152 2153 2154 2155 2156
#undef gen_rtx_ASM_INPUT
#define gen_rtx_ASM_INPUT(MODE, ARG0)				\
  gen_rtx_fmt_si (ASM_INPUT, (MODE), (ARG0), 0)
#define gen_rtx_ASM_INPUT_loc(MODE, ARG0, LOC)			\
  gen_rtx_fmt_si (ASM_INPUT, (MODE), (ARG0), (LOC))
2157 2158
#endif

2159 2160
/* There are some RTL codes that require special attention; the
   generation functions included above do the raw handling.  If you
2161
   add to this list, modify special_rtx in gengenrtl.c as well.  */
2162

2163 2164 2165 2166 2167 2168
extern rtx gen_rtx_CONST_INT (enum machine_mode, HOST_WIDE_INT);
extern rtx gen_rtx_CONST_VECTOR (enum machine_mode, rtvec);
extern rtx gen_raw_REG (enum machine_mode, int);
extern rtx gen_rtx_REG (enum machine_mode, unsigned);
extern rtx gen_rtx_SUBREG (enum machine_mode, rtx, int);
extern rtx gen_rtx_MEM (enum machine_mode, rtx);
2169

2170
#define GEN_INT(N)  gen_rtx_CONST_INT (VOIDmode, (N))
2171

Jim Wilson committed
2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183
/* Virtual registers are used during RTL generation to refer to locations into
   the stack frame when the actual location isn't known until RTL generation
   is complete.  The routine instantiate_virtual_regs replaces these with
   the proper value, which is normally {frame,arg,stack}_pointer_rtx plus
   a constant.  */

#define FIRST_VIRTUAL_REGISTER	(FIRST_PSEUDO_REGISTER)

/* This points to the first word of the incoming arguments passed on the stack,
   either by the caller or by the callee when pretending it was passed by the
   caller.  */

2184
#define virtual_incoming_args_rtx       (global_rtl[GR_VIRTUAL_INCOMING_ARGS])
Jim Wilson committed
2185 2186 2187

#define VIRTUAL_INCOMING_ARGS_REGNUM	(FIRST_VIRTUAL_REGISTER)

Richard Stallman committed
2188
/* If FRAME_GROWS_DOWNWARD, this points to immediately above the first
Jim Wilson committed
2189 2190 2191
   variable on the stack.  Otherwise, it points to the first variable on
   the stack.  */

2192
#define virtual_stack_vars_rtx	        (global_rtl[GR_VIRTUAL_STACK_ARGS])
Jim Wilson committed
2193 2194 2195 2196 2197 2198 2199

#define VIRTUAL_STACK_VARS_REGNUM	((FIRST_VIRTUAL_REGISTER) + 1)

/* This points to the location of dynamically-allocated memory on the stack
   immediately after the stack pointer has been adjusted by the amount
   desired.  */

2200
#define virtual_stack_dynamic_rtx	(global_rtl[GR_VIRTUAL_STACK_DYNAMIC])
Jim Wilson committed
2201 2202 2203 2204 2205 2206 2207

#define VIRTUAL_STACK_DYNAMIC_REGNUM	((FIRST_VIRTUAL_REGISTER) + 2)

/* This points to the location in the stack at which outgoing arguments should
   be written when the stack is pre-pushed (arguments pushed using push
   insns always use sp).  */

2208
#define virtual_outgoing_args_rtx	(global_rtl[GR_VIRTUAL_OUTGOING_ARGS])
Jim Wilson committed
2209 2210 2211

#define VIRTUAL_OUTGOING_ARGS_REGNUM	((FIRST_VIRTUAL_REGISTER) + 3)

2212
/* This points to the Canonical Frame Address of the function.  This
2213
   should correspond to the CFA produced by INCOMING_FRAME_SP_OFFSET,
2214
   but is calculated relative to the arg pointer for simplicity; the
2215
   frame pointer nor stack pointer are necessarily fixed relative to
2216 2217
   the CFA until after reload.  */

2218
#define virtual_cfa_rtx			(global_rtl[GR_VIRTUAL_CFA])
2219 2220 2221

#define VIRTUAL_CFA_REGNUM		((FIRST_VIRTUAL_REGISTER) + 4)

2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233
#define LAST_VIRTUAL_POINTER_REGISTER	((FIRST_VIRTUAL_REGISTER) + 4)

/* This is replaced by crtl->preferred_stack_boundary / BITS_PER_UNIT
   when finalized.  */

#define virtual_preferred_stack_boundary_rtx \
	(global_rtl[GR_VIRTUAL_PREFERRED_STACK_BOUNDARY])

#define VIRTUAL_PREFERRED_STACK_BOUNDARY_REGNUM \
					((FIRST_VIRTUAL_REGISTER) + 5)

#define LAST_VIRTUAL_REGISTER		((FIRST_VIRTUAL_REGISTER) + 5)
Jim Wilson committed
2234

2235
/* Nonzero if REGNUM is a pointer into the stack frame.  */
2236
#define REGNO_PTR_FRAME_P(REGNUM)		\
2237 2238 2239 2240 2241
  ((REGNUM) == STACK_POINTER_REGNUM		\
   || (REGNUM) == FRAME_POINTER_REGNUM		\
   || (REGNUM) == HARD_FRAME_POINTER_REGNUM	\
   || (REGNUM) == ARG_POINTER_REGNUM		\
   || ((REGNUM) >= FIRST_VIRTUAL_REGISTER	\
2242
       && (REGNUM) <= LAST_VIRTUAL_POINTER_REGISTER))
2243

2244
/* REGNUM never really appearing in the INSN stream.  */
Kazu Hirata committed
2245
#define INVALID_REGNUM			(~(unsigned int) 0)
2246

2247
extern rtx output_constant_def (tree, int);
2248
extern rtx lookup_constant_def (tree);
Jim Wilson committed
2249 2250

/* Nonzero after end of reload pass.
2251
   Set to 1 or 0 by reload1.c.  */
Jim Wilson committed
2252 2253 2254

extern int reload_completed;

Stephen Clarke committed
2255 2256 2257
/* Nonzero after thread_prologue_and_epilogue_insns has run.  */
extern int epilogue_completed;

Jim Wilson committed
2258 2259 2260 2261 2262
/* Set to 1 while reload_as_needed is operating.
   Required by some machines to handle any generated moves differently.  */

extern int reload_in_progress;

2263 2264 2265 2266 2267
/* This macro indicates whether you may create a new
   pseudo-register.  */

#define can_create_pseudo_p() (!reload_in_progress && !reload_completed)

2268 2269 2270 2271 2272 2273
#ifdef STACK_REGS
/* Nonzero after end of regstack pass.
   Set to 1 or 0 by reg-stack.c.  */
extern int regstack_completed;
#endif

Jim Wilson committed
2274 2275 2276 2277 2278 2279 2280 2281
/* If this is nonzero, we do not bother generating VOLATILE
   around volatile memory references, and we are willing to
   output indirect addresses.  If cse is to follow, we reject
   indirect addresses so a useful potential cse is generated;
   if it is used only once, instruction combination will produce
   the same indirect address eventually.  */
extern int cse_not_expected;

2282
/* Translates rtx code to tree code, for those codes needed by
2283 2284 2285
   REAL_ARITHMETIC.  The function returns an int because the caller may not
   know what `enum tree_code' means.  */

2286
extern int rtx_to_tree_code (enum rtx_code);
2287

2288
/* In cse.c */
2289
extern int delete_trivially_dead_insns (rtx, int);
2290
extern int cse_main (rtx, int);
2291 2292
extern int exp_equiv_p (const_rtx, const_rtx, int, bool);
extern unsigned hash_rtx (const_rtx x, enum machine_mode, int *, int *, bool);
2293 2294

/* In jump.c */
2295
extern int comparison_dominates_p (enum rtx_code, enum rtx_code);
2296 2297 2298 2299
extern int condjump_p (const_rtx);
extern int any_condjump_p (const_rtx);
extern int any_uncondjump_p (const_rtx);
extern rtx pc_set (const_rtx);
2300
extern rtx condjump_label (const_rtx);
2301
extern int simplejump_p (const_rtx);
2302
extern int returnjump_p (rtx);
2303
extern int eh_returnjump_p (rtx);
2304 2305 2306
extern int onlyjump_p (const_rtx);
extern int only_sets_cc0_p (const_rtx);
extern int sets_cc0_p (const_rtx);
2307 2308
extern int invert_jump_1 (rtx, rtx);
extern int invert_jump (rtx, rtx, int);
2309
extern int rtx_renumbered_equal_p (const_rtx, const_rtx);
2310 2311
extern int true_regnum (const_rtx);
extern unsigned int reg_or_subregno (const_rtx);
2312
extern int redirect_jump_1 (rtx, rtx);
2313
extern void redirect_jump_2 (rtx, rtx, rtx, int, int);
2314 2315
extern int redirect_jump (rtx, rtx, int);
extern void rebuild_jump_labels (rtx);
2316 2317 2318 2319
extern rtx reversed_comparison (const_rtx, enum machine_mode);
extern enum rtx_code reversed_comparison_code (const_rtx, const_rtx);
extern enum rtx_code reversed_comparison_code_parts (enum rtx_code, const_rtx,
						     const_rtx, const_rtx);
2320
extern void delete_for_peephole (rtx, rtx);
2321
extern int condjump_in_parallel_p (const_rtx);
2322

Kazu Hirata committed
2323
/* In emit-rtl.c.  */
2324 2325 2326
extern int max_reg_num (void);
extern int max_label_num (void);
extern int get_first_label_num (void);
2327
extern void maybe_set_first_label_num (rtx);
2328 2329 2330 2331
extern void delete_insns_since (rtx);
extern void mark_reg_pointer (rtx, int);
extern void mark_user_reg (rtx);
extern void reset_used_flags (rtx);
2332
extern void set_used_flags (rtx);
2333 2334
extern void reorder_insns (rtx, rtx, rtx);
extern void reorder_insns_nobb (rtx, rtx, rtx);
2335
extern int get_max_insn_count (void);
2336 2337 2338
extern int in_sequence_p (void);
extern void force_next_line_note (void);
extern void init_emit (void);
2339
extern void init_emit_regs (void);
2340
extern void init_emit_once (void);
2341 2342 2343
extern void push_topmost_sequence (void);
extern void pop_topmost_sequence (void);
extern void set_new_first_and_last_insn (rtx, rtx);
2344
extern unsigned int unshare_all_rtl (void);
2345
extern void unshare_all_rtl_again (rtx);
2346 2347
extern void unshare_all_rtl_in_chain (rtx);
extern void verify_rtl_sharing (void);
2348 2349
extern void link_cc0_insns (rtx);
extern void add_insn (rtx);
2350 2351
extern void add_insn_before (rtx, rtx, struct basic_block_def *);
extern void add_insn_after (rtx, rtx, struct basic_block_def *);
2352 2353 2354
extern void remove_insn (rtx);
extern rtx emit (rtx);
extern rtx delete_insn (rtx);
2355
extern rtx entry_of_function (void);
2356
extern void emit_insn_at_entry (rtx);
2357
extern void delete_insn_chain (rtx, rtx, bool);
2358 2359
extern rtx unlink_insn_chain (rtx, rtx);
extern rtx delete_insn_and_edges (rtx);
2360
extern rtx gen_lowpart_SUBREG (enum machine_mode, rtx);
2361
extern rtx gen_const_mem (enum machine_mode, rtx);
2362 2363
extern rtx gen_frame_mem (enum machine_mode, rtx);
extern rtx gen_tmp_stack_mem (enum machine_mode, rtx);
2364
extern bool validate_subreg (enum machine_mode, enum machine_mode,
2365
			     const_rtx, unsigned int);
2366

2367
/* In combine.c  */
2368
extern unsigned int extended_count (const_rtx, enum machine_mode, int);
2369 2370 2371
extern rtx remove_death (unsigned int, rtx);
extern void dump_combine_stats (FILE *);
extern void dump_combine_total_stats (FILE *);
2372

2373 2374 2375
/* In cfgcleanup.c  */
extern void delete_dead_jumptables (void);

2376
/* In sched-vis.c.  */
2377 2378 2379
extern void debug_bb_n_slim (int);
extern void debug_bb_slim (struct basic_block_def *);
extern void print_rtl_slim (FILE *, rtx, rtx, int, int);
2380 2381 2382 2383
extern void print_rtl_slim_with_bb (FILE *, rtx, int);
extern void dump_insn_slim (FILE *f, rtx x);
extern void debug_insn_slim (rtx x);

2384
/* In sched-rgn.c.  */
2385
extern void schedule_insns (void);
2386 2387

/* In sched-ebb.c.  */
2388
extern void schedule_ebbs (void);
2389

2390 2391 2392
/* In sel-sched-dump.c.  */
extern void sel_sched_fix_param (const char *param, const char *val);

2393
/* In print-rtl.c */
2394
extern const char *print_rtx_head;
2395 2396 2397 2398 2399 2400 2401 2402 2403
extern void debug_rtx (const_rtx);
extern void debug_rtx_list (const_rtx, int);
extern void debug_rtx_range (const_rtx, const_rtx);
extern const_rtx debug_rtx_find (const_rtx, int);
extern void print_mem_expr (FILE *, const_tree);
extern void print_rtl (FILE *, const_rtx);
extern void print_simple_rtl (FILE *, const_rtx);
extern int print_rtl_single (FILE *, const_rtx);
extern void print_inline_rtx (FILE *, const_rtx, int);
2404 2405

/* In function.c */
2406
extern void reposition_prologue_and_epilogue_notes (void);
2407 2408
extern int prologue_epilogue_contains (const_rtx);
extern int sibcall_epilogue_contains (const_rtx);
2409 2410
extern void mark_temp_addr_taken (rtx);
extern void update_temp_slot_address (rtx, rtx);
2411
extern void maybe_copy_prologue_epilogue_insn (rtx, rtx);
2412 2413

/* In stmt.c */
2414
extern void expand_null_return (void);
2415
extern void expand_naked_return (void);
2416
extern void emit_jump (rtx);
2417 2418

/* In expr.c */
2419 2420
extern rtx move_by_pieces (rtx, rtx, unsigned HOST_WIDE_INT,
			   unsigned int, int);
2421

2422
/* In cfgrtl.c */
2423
extern void print_rtl_with_bb (FILE *, const_rtx);
2424 2425 2426

/* In cfg.c.  */
extern void dump_reg_info (FILE *);
2427
extern void dump_flow_info (FILE *, int);
2428 2429

/* In expmed.c */
2430 2431 2432
extern void init_expmed (void);
extern void expand_inc (rtx, rtx);
extern void expand_dec (rtx, rtx);
2433

Kaveh R. Ghazi committed
2434
/* In gcse.c */
2435
extern bool can_copy_p (enum machine_mode);
2436
extern bool can_assign_to_reg_without_clobbers_p (rtx);
2437
extern rtx fis_get_condition (rtx);
2438

2439
/* In ira.c */
Vladimir Makarov committed
2440 2441 2442
#ifdef HARD_CONST
extern HARD_REG_SET eliminable_regset;
#endif
2443
extern void mark_elimination (int, int);
2444

2445
/* In reginfo.c */
2446
extern int reg_classes_intersect_p (reg_class_t, reg_class_t);
2447
extern int reg_class_subset_p (reg_class_t, reg_class_t);
2448
extern void globalize_reg (int);
2449
extern void init_reg_modes_target (void);
2450
extern void init_regs (void);
2451
extern void reinit_regs (void);
2452
extern void init_fake_stack_mems (void);
2453
extern void save_register_info (void);
2454
extern void init_reg_sets (void);
2455
extern void regclass (rtx, int);
2456
extern void reg_scan (rtx, unsigned int);
2457
extern void fix_register (const char *, int, int);
2458
extern bool invalid_mode_change_p (unsigned int, enum reg_class);
2459

Kaveh R. Ghazi committed
2460
/* In reorg.c */
2461
extern void dbr_schedule (rtx);
Kaveh R. Ghazi committed
2462

2463
/* In reload1.c */
2464
extern int function_invariant_p (const_rtx);
2465

2466
/* In calls.c */
2467 2468 2469 2470 2471
enum libcall_type
{
  LCT_NORMAL = 0,
  LCT_CONST = 1,
  LCT_PURE = 2,
2472 2473 2474
  LCT_NORETURN = 3,
  LCT_THROW = 4,
  LCT_RETURNS_TWICE = 5
2475 2476
};

2477 2478 2479 2480
extern void emit_library_call (rtx, enum libcall_type, enum machine_mode, int,
			       ...);
extern rtx emit_library_call_value (rtx, rtx, enum libcall_type,
				    enum machine_mode, int, ...);
2481 2482

/* In varasm.c */
2483
extern void init_varasm_once (void);
H.J. Lu committed
2484

2485 2486
extern rtx make_debug_expr_from_rtl (const_rtx);

2487
/* In read-rtl.c */
2488
extern bool read_rtx (const char *, rtx *);
2489

2490
/* In alias.c */
2491
extern rtx canon_rtx (rtx);
2492
extern int true_dependence (const_rtx, enum machine_mode, const_rtx, bool (*)(const_rtx, bool));
2493
extern rtx get_addr (rtx);
2494
extern int canon_true_dependence (const_rtx, enum machine_mode, rtx, const_rtx,
2495
				  rtx, bool (*)(const_rtx, bool));
2496 2497 2498
extern int read_dependence (const_rtx, const_rtx);
extern int anti_dependence (const_rtx, const_rtx);
extern int output_dependence (const_rtx, const_rtx);
2499
extern int may_alias_p (const_rtx, const_rtx);
2500
extern void init_alias_target (void);
2501 2502
extern void init_alias_analysis (void);
extern void end_alias_analysis (void);
2503
extern void vt_equate_reg_base_value (const_rtx, const_rtx);
2504
extern bool memory_modified_in_insn_p (const_rtx, const_rtx);
2505
extern rtx find_base_term (rtx);
2506
extern rtx gen_hard_reg_clobber (enum machine_mode, unsigned int);
2507 2508
extern rtx get_reg_known_value (unsigned int);
extern bool get_reg_known_equiv_p (unsigned int);
2509
extern rtx get_reg_base_value (unsigned int);
2510

2511
#ifdef STACK_REGS
2512
extern int stack_regs_mentioned (const_rtx insn);
2513 2514
#endif

2515
/* In toplev.c */
2516
extern GTY(()) rtx stack_limit_rtx;
2517

Jan Hubicka committed
2518
/* In predict.c */
2519 2520
extern void invert_br_probabilities (rtx);
extern bool expensive_function_p (int);
2521

2522
/* In var-tracking.c */
2523
extern unsigned int variable_tracking_main (void);
2524

Zdenek Dvorak committed
2525
/* In stor-layout.c.  */
2526 2527
extern void get_mode_bounds (enum machine_mode, int, enum machine_mode,
			     rtx *, rtx *);
Zdenek Dvorak committed
2528 2529 2530 2531 2532 2533 2534 2535

/* In loop-unswitch.c  */
extern rtx reversed_condition (rtx);
extern rtx compare_and_jump_seq (rtx, rtx, enum rtx_code, rtx, int, rtx);

/* In loop-iv.c  */
extern rtx canon_condition (rtx);
extern void simplify_using_condition (rtx, rtx *, struct bitmap_head_def *);
2536 2537 2538

/* In final.c  */
extern unsigned int compute_alignments (void);
2539
extern int asm_str_count (const char *templ);
2540 2541 2542 2543

struct rtl_hooks
{
  rtx (*gen_lowpart) (enum machine_mode, rtx);
2544
  rtx (*gen_lowpart_no_emit) (enum machine_mode, rtx);
2545
  rtx (*reg_nonzero_bits) (const_rtx, enum machine_mode, const_rtx, enum machine_mode,
2546
			   unsigned HOST_WIDE_INT, unsigned HOST_WIDE_INT *);
2547
  rtx (*reg_num_sign_bit_copies) (const_rtx, enum machine_mode, const_rtx, enum machine_mode,
2548
				  unsigned int, unsigned int *);
2549
  bool (*reg_truncated_to_mode) (enum machine_mode, const_rtx);
2550

2551
  /* Whenever you add entries here, make sure you adjust rtlhooks-def.h.  */
2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562
};

/* Each pass can provide its own.  */
extern struct rtl_hooks rtl_hooks;

/* ... but then it has to restore these.  */
extern const struct rtl_hooks general_rtl_hooks;

/* Keep this for the nonce.  */
#define gen_lowpart rtl_hooks.gen_lowpart

2563
extern void insn_locators_alloc (void);
2564
extern void insn_locators_free (void);
2565 2566
extern void insn_locators_finalize (void);
extern void set_curr_insn_source_location (location_t);
2567
extern location_t get_curr_insn_source_location (void);
2568
extern void set_curr_insn_block (tree);
2569
extern tree get_curr_insn_block (void);
2570
extern int curr_insn_locator (void);
2571 2572
extern bool optimize_insn_for_size_p (void);
extern bool optimize_insn_for_speed_p (void);
2573

2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586
/* rtl-error.c */
extern void _fatal_insn_not_found (const_rtx, const char *, int, const char *)
     ATTRIBUTE_NORETURN;
extern void _fatal_insn (const char *, const_rtx, const char *, int, const char *)
     ATTRIBUTE_NORETURN;

#define fatal_insn(msgid, insn) \
	_fatal_insn (msgid, insn, __FILE__, __LINE__, __FUNCTION__)
#define fatal_insn_not_found(insn) \
	_fatal_insn_not_found (insn, __FILE__, __LINE__, __FUNCTION__)



2587
#endif /* ! GCC_RTL_H */