1 /* RTL utility routines.
2 Copyright (C) 1987, 1988, 1991, 1994, 1997, 1998, 1999, 2000, 2001, 2002,
3 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
4 Free Software Foundation, Inc.
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify it under
9 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
13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING3. If not see
20 <http://www.gnu.org/licenses/>. */
22 /* This file is compiled twice: once for the generator programs
23 once for the compiler. */
31 #include "coretypes.h"
38 # include "diagnostic-core.h"
42 /* Indexed by rtx code, gives number of operands for an rtx with that code.
43 Does NOT include rtx header data (code and links). */
45 #define DEF_RTL_EXPR(ENUM, NAME, FORMAT, CLASS) sizeof FORMAT - 1 ,
47 const unsigned char rtx_length
[NUM_RTX_CODE
] = {
53 /* Indexed by rtx code, gives the name of that kind of rtx, as a C string. */
55 #define DEF_RTL_EXPR(ENUM, NAME, FORMAT, CLASS) NAME ,
57 const char * const rtx_name
[NUM_RTX_CODE
] = {
58 #include "rtl.def" /* rtl expressions are documented here */
63 /* Indexed by rtx code, gives a sequence of operand-types for
64 rtx's of that code. The sequence is a C string in which
65 each character describes one operand. */
67 const char * const rtx_format
[NUM_RTX_CODE
] = {
69 can cause a warning message
70 "0" field is unused (or used in a phase-dependent manner)
74 "n" like "i", but prints entries from `note_insn_name'
75 "w" an integer of width HOST_BITS_PER_WIDE_INT
77 "s" a pointer to a string
79 "S" like "s", but optional:
80 the containing rtx may end before this operand
81 "T" like "s", but treated specially by the RTL reader;
82 only found in machine description patterns.
83 "e" a pointer to an rtl expression
85 "E" a pointer to a vector that points to a number of rtl expressions
86 prints a list of the rtl expressions
87 "V" like "E", but optional:
88 the containing rtx may end before this operand
89 "u" a pointer to another insn
90 prints the uid of the insn.
91 "b" is a pointer to a bitmap header.
92 "B" is a basic block pointer.
93 "t" is a tree pointer. */
95 #define DEF_RTL_EXPR(ENUM, NAME, FORMAT, CLASS) FORMAT ,
96 #include "rtl.def" /* rtl expressions are defined here */
100 /* Indexed by rtx code, gives a character representing the "class" of
101 that rtx code. See rtl.def for documentation on the defined classes. */
103 const enum rtx_class rtx_class
[NUM_RTX_CODE
] = {
104 #define DEF_RTL_EXPR(ENUM, NAME, FORMAT, CLASS) CLASS,
105 #include "rtl.def" /* rtl expressions are defined here */
109 /* Indexed by rtx code, gives the size of the rtx in bytes. */
111 const unsigned char rtx_code_size
[NUM_RTX_CODE
] = {
112 #define DEF_RTL_EXPR(ENUM, NAME, FORMAT, CLASS) \
113 ((ENUM) == CONST_INT || (ENUM) == CONST_DOUBLE || (ENUM) == CONST_FIXED\
114 ? RTX_HDR_SIZE + (sizeof FORMAT - 1) * sizeof (HOST_WIDE_INT) \
115 : RTX_HDR_SIZE + (sizeof FORMAT - 1) * sizeof (rtunion)),
121 /* Names for kinds of NOTEs and REG_NOTEs. */
123 const char * const note_insn_name
[NOTE_INSN_MAX
] =
125 #define DEF_INSN_NOTE(NAME) #NAME,
126 #include "insn-notes.def"
130 const char * const reg_note_name
[REG_NOTE_MAX
] =
132 #define DEF_REG_NOTE(NAME) #NAME,
133 #include "reg-notes.def"
137 #ifdef GATHER_STATISTICS
138 static int rtx_alloc_counts
[(int) LAST_AND_UNUSED_RTX_CODE
];
139 static int rtx_alloc_sizes
[(int) LAST_AND_UNUSED_RTX_CODE
];
140 static int rtvec_alloc_counts
;
141 static int rtvec_alloc_sizes
;
145 /* Allocate an rtx vector of N elements.
146 Store the length, and initialize all elements to zero. */
153 rt
= ggc_alloc_rtvec_sized (n
);
154 /* Clear out the vector. */
155 memset (&rt
->elem
[0], 0, n
* sizeof (rtx
));
157 PUT_NUM_ELEM (rt
, n
);
159 #ifdef GATHER_STATISTICS
160 rtvec_alloc_counts
++;
161 rtvec_alloc_sizes
+= n
* sizeof (rtx
);
167 /* Create a bitwise copy of VEC. */
170 shallow_copy_rtvec (rtvec vec
)
175 n
= GET_NUM_ELEM (vec
);
176 newvec
= rtvec_alloc (n
);
177 memcpy (&newvec
->elem
[0], &vec
->elem
[0], sizeof (rtx
) * n
);
181 /* Return the number of bytes occupied by rtx value X. */
184 rtx_size (const_rtx x
)
186 if (GET_CODE (x
) == SYMBOL_REF
&& SYMBOL_REF_HAS_BLOCK_INFO_P (x
))
187 return RTX_HDR_SIZE
+ sizeof (struct block_symbol
);
188 return RTX_CODE_SIZE (GET_CODE (x
));
191 /* Allocate an rtx of code CODE. The CODE is stored in the rtx;
192 all the rest is initialized to zero. */
195 rtx_alloc_stat (RTX_CODE code MEM_STAT_DECL
)
197 rtx rt
= ggc_alloc_zone_rtx_def_stat (&rtl_zone
, RTX_CODE_SIZE (code
)
200 /* We want to clear everything up to the FLD array. Normally, this
201 is one int, but we don't want to assume that and it isn't very
202 portable anyway; this is. */
204 memset (rt
, 0, RTX_HDR_SIZE
);
207 #ifdef GATHER_STATISTICS
208 rtx_alloc_counts
[code
]++;
209 rtx_alloc_sizes
[code
] += RTX_CODE_SIZE (code
);
216 /* Return true if ORIG is a sharable CONST. */
219 shared_const_p (const_rtx orig
)
221 gcc_assert (GET_CODE (orig
) == CONST
);
223 /* CONST can be shared if it contains a SYMBOL_REF. If it contains
224 a LABEL_REF, it isn't sharable. */
225 return (GET_CODE (XEXP (orig
, 0)) == PLUS
226 && GET_CODE (XEXP (XEXP (orig
, 0), 0)) == SYMBOL_REF
227 && CONST_INT_P(XEXP (XEXP (orig
, 0), 1)));
231 /* Create a new copy of an rtx.
232 Recursively copies the operands of the rtx,
233 except for those few rtx codes that are sharable. */
241 const char *format_ptr
;
243 code
= GET_CODE (orig
);
261 /* SCRATCH must be shared because they represent distinct values. */
264 if (REG_P (XEXP (orig
, 0)) && REGNO (XEXP (orig
, 0)) < FIRST_PSEUDO_REGISTER
)
269 if (shared_const_p (orig
))
273 /* A MEM with a constant address is not sharable. The problem is that
274 the constant address may need to be reloaded. If the mem is shared,
275 then reloading one copy of this mem will cause all copies to appear
276 to have been reloaded. */
282 /* Copy the various flags, fields, and other information. We assume
283 that all fields need copying, and then clear the fields that should
284 not be copied. That is the sensible default behavior, and forces
285 us to explicitly document why we are *not* copying a flag. */
286 copy
= shallow_copy_rtx (orig
);
288 /* We do not copy the USED flag, which is used as a mark bit during
289 walks over the RTL. */
290 RTX_FLAG (copy
, used
) = 0;
292 format_ptr
= GET_RTX_FORMAT (GET_CODE (copy
));
294 for (i
= 0; i
< GET_RTX_LENGTH (GET_CODE (copy
)); i
++)
295 switch (*format_ptr
++)
298 if (XEXP (orig
, i
) != NULL
)
299 XEXP (copy
, i
) = copy_rtx (XEXP (orig
, i
));
304 if (XVEC (orig
, i
) != NULL
)
306 XVEC (copy
, i
) = rtvec_alloc (XVECLEN (orig
, i
));
307 for (j
= 0; j
< XVECLEN (copy
, i
); j
++)
308 XVECEXP (copy
, i
, j
) = copy_rtx (XVECEXP (orig
, i
, j
));
321 /* These are left unchanged. */
330 /* Create a new copy of an rtx. Only copy just one level. */
333 shallow_copy_rtx_stat (const_rtx orig MEM_STAT_DECL
)
335 const unsigned int size
= rtx_size (orig
);
336 rtx
const copy
= ggc_alloc_zone_rtx_def_stat (&rtl_zone
, size PASS_MEM_STAT
);
337 return (rtx
) memcpy (copy
, orig
, size
);
340 /* Nonzero when we are generating CONCATs. */
341 int generating_concat_p
;
343 /* Nonzero when we are expanding trees to RTL. */
344 int currently_expanding_to_rtl
;
348 /* Same as rtx_equal_p, but call CB on each pair of rtx if CB is not NULL.
349 When the callback returns true, we continue with the new pair.
350 Whenever changing this function check if rtx_equal_p below doesn't need
354 rtx_equal_p_cb (const_rtx x
, const_rtx y
, rtx_equal_p_callback_function cb
)
364 if (x
== 0 || y
== 0)
367 /* Invoke the callback first. */
369 && ((*cb
) (&x
, &y
, &nx
, &ny
)))
370 return rtx_equal_p_cb (nx
, ny
, cb
);
373 /* Rtx's of different codes cannot be equal. */
374 if (code
!= GET_CODE (y
))
377 /* (MULT:SI x y) and (MULT:HI x y) are NOT equivalent.
378 (REG:SI x) and (REG:HI x) are NOT equivalent. */
380 if (GET_MODE (x
) != GET_MODE (y
))
383 /* MEMs refering to different address space are not equivalent. */
384 if (code
== MEM
&& MEM_ADDR_SPACE (x
) != MEM_ADDR_SPACE (y
))
387 /* Some RTL can be compared nonrecursively. */
391 return (REGNO (x
) == REGNO (y
));
394 return XEXP (x
, 0) == XEXP (y
, 0);
397 return XSTR (x
, 0) == XSTR (y
, 0);
407 case DEBUG_IMPLICIT_PTR
:
408 return DEBUG_IMPLICIT_PTR_DECL (x
)
409 == DEBUG_IMPLICIT_PTR_DECL (y
);
411 case DEBUG_PARAMETER_REF
:
412 return DEBUG_PARAMETER_REF_DECL (x
)
413 == DEBUG_PARAMETER_REF_DECL (x
);
416 return rtx_equal_p_cb (ENTRY_VALUE_EXP (x
), ENTRY_VALUE_EXP (y
), cb
);
422 /* Compare the elements. If any pair of corresponding elements
423 fail to match, return 0 for the whole thing. */
425 fmt
= GET_RTX_FORMAT (code
);
426 for (i
= GET_RTX_LENGTH (code
) - 1; i
>= 0; i
--)
431 if (XWINT (x
, i
) != XWINT (y
, i
))
437 if (XINT (x
, i
) != XINT (y
, i
))
439 #ifndef GENERATOR_FILE
440 if (((code
== ASM_OPERANDS
&& i
== 6)
441 || (code
== ASM_INPUT
&& i
== 1))
442 && locator_eq (XINT (x
, i
), XINT (y
, i
)))
451 /* Two vectors must have the same length. */
452 if (XVECLEN (x
, i
) != XVECLEN (y
, i
))
455 /* And the corresponding elements must match. */
456 for (j
= 0; j
< XVECLEN (x
, i
); j
++)
457 if (rtx_equal_p_cb (XVECEXP (x
, i
, j
),
458 XVECEXP (y
, i
, j
), cb
) == 0)
463 if (rtx_equal_p_cb (XEXP (x
, i
), XEXP (y
, i
), cb
) == 0)
469 if ((XSTR (x
, i
) || XSTR (y
, i
))
470 && (! XSTR (x
, i
) || ! XSTR (y
, i
)
471 || strcmp (XSTR (x
, i
), XSTR (y
, i
))))
476 /* These are just backpointers, so they don't matter. */
483 /* It is believed that rtx's at this level will never
484 contain anything but integers and other rtx's,
485 except for within LABEL_REFs and SYMBOL_REFs. */
493 /* Return 1 if X and Y are identical-looking rtx's.
494 This is the Lisp function EQUAL for rtx arguments.
495 Whenever changing this function check if rtx_equal_p_cb above doesn't need
499 rtx_equal_p (const_rtx x
, const_rtx y
)
508 if (x
== 0 || y
== 0)
512 /* Rtx's of different codes cannot be equal. */
513 if (code
!= GET_CODE (y
))
516 /* (MULT:SI x y) and (MULT:HI x y) are NOT equivalent.
517 (REG:SI x) and (REG:HI x) are NOT equivalent. */
519 if (GET_MODE (x
) != GET_MODE (y
))
522 /* MEMs refering to different address space are not equivalent. */
523 if (code
== MEM
&& MEM_ADDR_SPACE (x
) != MEM_ADDR_SPACE (y
))
526 /* Some RTL can be compared nonrecursively. */
530 return (REGNO (x
) == REGNO (y
));
533 return XEXP (x
, 0) == XEXP (y
, 0);
536 return XSTR (x
, 0) == XSTR (y
, 0);
546 case DEBUG_IMPLICIT_PTR
:
547 return DEBUG_IMPLICIT_PTR_DECL (x
)
548 == DEBUG_IMPLICIT_PTR_DECL (y
);
550 case DEBUG_PARAMETER_REF
:
551 return DEBUG_PARAMETER_REF_DECL (x
)
552 == DEBUG_PARAMETER_REF_DECL (y
);
555 return rtx_equal_p (ENTRY_VALUE_EXP (x
), ENTRY_VALUE_EXP (y
));
561 /* Compare the elements. If any pair of corresponding elements
562 fail to match, return 0 for the whole thing. */
564 fmt
= GET_RTX_FORMAT (code
);
565 for (i
= GET_RTX_LENGTH (code
) - 1; i
>= 0; i
--)
570 if (XWINT (x
, i
) != XWINT (y
, i
))
576 if (XINT (x
, i
) != XINT (y
, i
))
578 #ifndef GENERATOR_FILE
579 if (((code
== ASM_OPERANDS
&& i
== 6)
580 || (code
== ASM_INPUT
&& i
== 1))
581 && locator_eq (XINT (x
, i
), XINT (y
, i
)))
590 /* Two vectors must have the same length. */
591 if (XVECLEN (x
, i
) != XVECLEN (y
, i
))
594 /* And the corresponding elements must match. */
595 for (j
= 0; j
< XVECLEN (x
, i
); j
++)
596 if (rtx_equal_p (XVECEXP (x
, i
, j
), XVECEXP (y
, i
, j
)) == 0)
601 if (rtx_equal_p (XEXP (x
, i
), XEXP (y
, i
)) == 0)
607 if ((XSTR (x
, i
) || XSTR (y
, i
))
608 && (! XSTR (x
, i
) || ! XSTR (y
, i
)
609 || strcmp (XSTR (x
, i
), XSTR (y
, i
))))
614 /* These are just backpointers, so they don't matter. */
621 /* It is believed that rtx's at this level will never
622 contain anything but integers and other rtx's,
623 except for within LABEL_REFs and SYMBOL_REFs. */
631 /* Iteratively hash rtx X. */
634 iterative_hash_rtx (const_rtx x
, hashval_t hash
)
637 enum machine_mode mode
;
644 hash
= iterative_hash_object (code
, hash
);
646 hash
= iterative_hash_object (mode
, hash
);
651 return iterative_hash_object (i
, hash
);
653 return iterative_hash_object (INTVAL (x
), hash
);
656 return iterative_hash (XSTR (x
, 0), strlen (XSTR (x
, 0)) + 1,
665 case DEBUG_IMPLICIT_PTR
:
666 case DEBUG_PARAMETER_REF
:
672 fmt
= GET_RTX_FORMAT (code
);
673 for (i
= GET_RTX_LENGTH (code
) - 1; i
>= 0; i
--)
677 hash
= iterative_hash_object (XWINT (x
, i
), hash
);
681 hash
= iterative_hash_object (XINT (x
, i
), hash
);
686 hash
= iterative_hash_object (j
, hash
);
687 for (j
= 0; j
< XVECLEN (x
, i
); j
++)
688 hash
= iterative_hash_rtx (XVECEXP (x
, i
, j
), hash
);
691 hash
= iterative_hash_rtx (XEXP (x
, i
), hash
);
696 hash
= iterative_hash (XSTR (x
, 0), strlen (XSTR (x
, 0)) + 1,
706 dump_rtx_statistics (void)
708 #ifdef GATHER_STATISTICS
710 int total_counts
= 0;
712 fprintf (stderr
, "\nRTX Kind Count Bytes\n");
713 fprintf (stderr
, "---------------------------------------\n");
714 for (i
= 0; i
< LAST_AND_UNUSED_RTX_CODE
; i
++)
715 if (rtx_alloc_counts
[i
])
717 fprintf (stderr
, "%-20s %7d %10d\n", GET_RTX_NAME (i
),
718 rtx_alloc_counts
[i
], rtx_alloc_sizes
[i
]);
719 total_counts
+= rtx_alloc_counts
[i
];
720 total_sizes
+= rtx_alloc_sizes
[i
];
722 if (rtvec_alloc_counts
)
724 fprintf (stderr
, "%-20s %7d %10d\n", "rtvec",
725 rtvec_alloc_counts
, rtvec_alloc_sizes
);
726 total_counts
+= rtvec_alloc_counts
;
727 total_sizes
+= rtvec_alloc_sizes
;
729 fprintf (stderr
, "---------------------------------------\n");
730 fprintf (stderr
, "%-20s %7d %10d\n",
731 "Total", total_counts
, total_sizes
);
732 fprintf (stderr
, "---------------------------------------\n");
736 #if defined ENABLE_RTL_CHECKING && (GCC_VERSION >= 2007)
738 rtl_check_failed_bounds (const_rtx r
, int n
, const char *file
, int line
,
742 ("RTL check: access of elt %d of '%s' with last elt %d in %s, at %s:%d",
743 n
, GET_RTX_NAME (GET_CODE (r
)), GET_RTX_LENGTH (GET_CODE (r
)) - 1,
744 func
, trim_filename (file
), line
);
748 rtl_check_failed_type1 (const_rtx r
, int n
, int c1
, const char *file
, int line
,
752 ("RTL check: expected elt %d type '%c', have '%c' (rtx %s) in %s, at %s:%d",
753 n
, c1
, GET_RTX_FORMAT (GET_CODE (r
))[n
], GET_RTX_NAME (GET_CODE (r
)),
754 func
, trim_filename (file
), line
);
758 rtl_check_failed_type2 (const_rtx r
, int n
, int c1
, int c2
, const char *file
,
759 int line
, const char *func
)
762 ("RTL check: expected elt %d type '%c' or '%c', have '%c' (rtx %s) in %s, at %s:%d",
763 n
, c1
, c2
, GET_RTX_FORMAT (GET_CODE (r
))[n
], GET_RTX_NAME (GET_CODE (r
)),
764 func
, trim_filename (file
), line
);
768 rtl_check_failed_code1 (const_rtx r
, enum rtx_code code
, const char *file
,
769 int line
, const char *func
)
771 internal_error ("RTL check: expected code '%s', have '%s' in %s, at %s:%d",
772 GET_RTX_NAME (code
), GET_RTX_NAME (GET_CODE (r
)), func
,
773 trim_filename (file
), line
);
777 rtl_check_failed_code2 (const_rtx r
, enum rtx_code code1
, enum rtx_code code2
,
778 const char *file
, int line
, const char *func
)
781 ("RTL check: expected code '%s' or '%s', have '%s' in %s, at %s:%d",
782 GET_RTX_NAME (code1
), GET_RTX_NAME (code2
), GET_RTX_NAME (GET_CODE (r
)),
783 func
, trim_filename (file
), line
);
787 rtl_check_failed_code_mode (const_rtx r
, enum rtx_code code
, enum machine_mode mode
,
788 bool not_mode
, const char *file
, int line
,
791 internal_error ((not_mode
792 ? ("RTL check: expected code '%s' and not mode '%s', "
793 "have code '%s' and mode '%s' in %s, at %s:%d")
794 : ("RTL check: expected code '%s' and mode '%s', "
795 "have code '%s' and mode '%s' in %s, at %s:%d")),
796 GET_RTX_NAME (code
), GET_MODE_NAME (mode
),
797 GET_RTX_NAME (GET_CODE (r
)), GET_MODE_NAME (GET_MODE (r
)),
798 func
, trim_filename (file
), line
);
801 /* Report that line LINE of FILE tried to access the block symbol fields
802 of a non-block symbol. FUNC is the function that contains the line. */
805 rtl_check_failed_block_symbol (const char *file
, int line
, const char *func
)
808 ("RTL check: attempt to treat non-block symbol as a block symbol "
809 "in %s, at %s:%d", func
, trim_filename (file
), line
);
812 /* XXX Maybe print the vector? */
814 rtvec_check_failed_bounds (const_rtvec r
, int n
, const char *file
, int line
,
818 ("RTL check: access of elt %d of vector with last elt %d in %s, at %s:%d",
819 n
, GET_NUM_ELEM (r
) - 1, func
, trim_filename (file
), line
);
821 #endif /* ENABLE_RTL_CHECKING */
823 #if defined ENABLE_RTL_FLAG_CHECKING
825 rtl_check_failed_flag (const char *name
, const_rtx r
, const char *file
,
826 int line
, const char *func
)
829 ("RTL flag check: %s used with unexpected rtx code '%s' in %s, at %s:%d",
830 name
, GET_RTX_NAME (GET_CODE (r
)), func
, trim_filename (file
), line
);
832 #endif /* ENABLE_RTL_FLAG_CHECKING */