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 /* We do not copy FRAME_RELATED for INSNs. */
294 RTX_FLAG (copy
, frame_related
) = 0;
295 RTX_FLAG (copy
, jump
) = RTX_FLAG (orig
, jump
);
296 RTX_FLAG (copy
, call
) = RTX_FLAG (orig
, call
);
298 format_ptr
= GET_RTX_FORMAT (GET_CODE (copy
));
300 for (i
= 0; i
< GET_RTX_LENGTH (GET_CODE (copy
)); i
++)
301 switch (*format_ptr
++)
304 if (XEXP (orig
, i
) != NULL
)
305 XEXP (copy
, i
) = copy_rtx (XEXP (orig
, i
));
310 if (XVEC (orig
, i
) != NULL
)
312 XVEC (copy
, i
) = rtvec_alloc (XVECLEN (orig
, i
));
313 for (j
= 0; j
< XVECLEN (copy
, i
); j
++)
314 XVECEXP (copy
, i
, j
) = copy_rtx (XVECEXP (orig
, i
, j
));
327 /* These are left unchanged. */
336 /* Create a new copy of an rtx. Only copy just one level. */
339 shallow_copy_rtx_stat (const_rtx orig MEM_STAT_DECL
)
341 const unsigned int size
= rtx_size (orig
);
342 rtx
const copy
= ggc_alloc_zone_rtx_def_stat (&rtl_zone
, size PASS_MEM_STAT
);
343 return (rtx
) memcpy (copy
, orig
, size
);
346 /* Nonzero when we are generating CONCATs. */
347 int generating_concat_p
;
349 /* Nonzero when we are expanding trees to RTL. */
350 int currently_expanding_to_rtl
;
354 /* Same as rtx_equal_p, but call CB on each pair of rtx if CB is not NULL.
355 When the callback returns true, we continue with the new pair.
356 Whenever changing this function check if rtx_equal_p below doesn't need
360 rtx_equal_p_cb (const_rtx x
, const_rtx y
, rtx_equal_p_callback_function cb
)
370 if (x
== 0 || y
== 0)
373 /* Invoke the callback first. */
375 && ((*cb
) (&x
, &y
, &nx
, &ny
)))
376 return rtx_equal_p_cb (nx
, ny
, cb
);
379 /* Rtx's of different codes cannot be equal. */
380 if (code
!= GET_CODE (y
))
383 /* (MULT:SI x y) and (MULT:HI x y) are NOT equivalent.
384 (REG:SI x) and (REG:HI x) are NOT equivalent. */
386 if (GET_MODE (x
) != GET_MODE (y
))
389 /* MEMs refering to different address space are not equivalent. */
390 if (code
== MEM
&& MEM_ADDR_SPACE (x
) != MEM_ADDR_SPACE (y
))
393 /* Some RTL can be compared nonrecursively. */
397 return (REGNO (x
) == REGNO (y
));
400 return XEXP (x
, 0) == XEXP (y
, 0);
403 return XSTR (x
, 0) == XSTR (y
, 0);
413 case DEBUG_IMPLICIT_PTR
:
414 return DEBUG_IMPLICIT_PTR_DECL (x
)
415 == DEBUG_IMPLICIT_PTR_DECL (y
);
417 case DEBUG_PARAMETER_REF
:
418 return DEBUG_PARAMETER_REF_DECL (x
)
419 == DEBUG_PARAMETER_REF_DECL (x
);
422 return rtx_equal_p_cb (ENTRY_VALUE_EXP (x
), ENTRY_VALUE_EXP (y
), cb
);
428 /* Compare the elements. If any pair of corresponding elements
429 fail to match, return 0 for the whole thing. */
431 fmt
= GET_RTX_FORMAT (code
);
432 for (i
= GET_RTX_LENGTH (code
) - 1; i
>= 0; i
--)
437 if (XWINT (x
, i
) != XWINT (y
, i
))
443 if (XINT (x
, i
) != XINT (y
, i
))
445 #ifndef GENERATOR_FILE
446 if (((code
== ASM_OPERANDS
&& i
== 6)
447 || (code
== ASM_INPUT
&& i
== 1))
448 && locator_eq (XINT (x
, i
), XINT (y
, i
)))
457 /* Two vectors must have the same length. */
458 if (XVECLEN (x
, i
) != XVECLEN (y
, i
))
461 /* And the corresponding elements must match. */
462 for (j
= 0; j
< XVECLEN (x
, i
); j
++)
463 if (rtx_equal_p_cb (XVECEXP (x
, i
, j
),
464 XVECEXP (y
, i
, j
), cb
) == 0)
469 if (rtx_equal_p_cb (XEXP (x
, i
), XEXP (y
, i
), cb
) == 0)
475 if ((XSTR (x
, i
) || XSTR (y
, i
))
476 && (! XSTR (x
, i
) || ! XSTR (y
, i
)
477 || strcmp (XSTR (x
, i
), XSTR (y
, i
))))
482 /* These are just backpointers, so they don't matter. */
489 /* It is believed that rtx's at this level will never
490 contain anything but integers and other rtx's,
491 except for within LABEL_REFs and SYMBOL_REFs. */
499 /* Return 1 if X and Y are identical-looking rtx's.
500 This is the Lisp function EQUAL for rtx arguments.
501 Whenever changing this function check if rtx_equal_p_cb above doesn't need
505 rtx_equal_p (const_rtx x
, const_rtx y
)
514 if (x
== 0 || y
== 0)
518 /* Rtx's of different codes cannot be equal. */
519 if (code
!= GET_CODE (y
))
522 /* (MULT:SI x y) and (MULT:HI x y) are NOT equivalent.
523 (REG:SI x) and (REG:HI x) are NOT equivalent. */
525 if (GET_MODE (x
) != GET_MODE (y
))
528 /* MEMs refering to different address space are not equivalent. */
529 if (code
== MEM
&& MEM_ADDR_SPACE (x
) != MEM_ADDR_SPACE (y
))
532 /* Some RTL can be compared nonrecursively. */
536 return (REGNO (x
) == REGNO (y
));
539 return XEXP (x
, 0) == XEXP (y
, 0);
542 return XSTR (x
, 0) == XSTR (y
, 0);
552 case DEBUG_IMPLICIT_PTR
:
553 return DEBUG_IMPLICIT_PTR_DECL (x
)
554 == DEBUG_IMPLICIT_PTR_DECL (y
);
556 case DEBUG_PARAMETER_REF
:
557 return DEBUG_PARAMETER_REF_DECL (x
)
558 == DEBUG_PARAMETER_REF_DECL (y
);
561 return rtx_equal_p (ENTRY_VALUE_EXP (x
), ENTRY_VALUE_EXP (y
));
567 /* Compare the elements. If any pair of corresponding elements
568 fail to match, return 0 for the whole thing. */
570 fmt
= GET_RTX_FORMAT (code
);
571 for (i
= GET_RTX_LENGTH (code
) - 1; i
>= 0; i
--)
576 if (XWINT (x
, i
) != XWINT (y
, i
))
582 if (XINT (x
, i
) != XINT (y
, i
))
584 #ifndef GENERATOR_FILE
585 if (((code
== ASM_OPERANDS
&& i
== 6)
586 || (code
== ASM_INPUT
&& i
== 1))
587 && locator_eq (XINT (x
, i
), XINT (y
, i
)))
596 /* Two vectors must have the same length. */
597 if (XVECLEN (x
, i
) != XVECLEN (y
, i
))
600 /* And the corresponding elements must match. */
601 for (j
= 0; j
< XVECLEN (x
, i
); j
++)
602 if (rtx_equal_p (XVECEXP (x
, i
, j
), XVECEXP (y
, i
, j
)) == 0)
607 if (rtx_equal_p (XEXP (x
, i
), XEXP (y
, i
)) == 0)
613 if ((XSTR (x
, i
) || XSTR (y
, i
))
614 && (! XSTR (x
, i
) || ! XSTR (y
, i
)
615 || strcmp (XSTR (x
, i
), XSTR (y
, i
))))
620 /* These are just backpointers, so they don't matter. */
627 /* It is believed that rtx's at this level will never
628 contain anything but integers and other rtx's,
629 except for within LABEL_REFs and SYMBOL_REFs. */
637 /* Iteratively hash rtx X. */
640 iterative_hash_rtx (const_rtx x
, hashval_t hash
)
643 enum machine_mode mode
;
650 hash
= iterative_hash_object (code
, hash
);
652 hash
= iterative_hash_object (mode
, hash
);
657 return iterative_hash_object (i
, hash
);
659 return iterative_hash_object (INTVAL (x
), hash
);
662 return iterative_hash (XSTR (x
, 0), strlen (XSTR (x
, 0)) + 1,
671 case DEBUG_IMPLICIT_PTR
:
672 case DEBUG_PARAMETER_REF
:
678 fmt
= GET_RTX_FORMAT (code
);
679 for (i
= GET_RTX_LENGTH (code
) - 1; i
>= 0; i
--)
683 hash
= iterative_hash_object (XWINT (x
, i
), hash
);
687 hash
= iterative_hash_object (XINT (x
, i
), hash
);
692 hash
= iterative_hash_object (j
, hash
);
693 for (j
= 0; j
< XVECLEN (x
, i
); j
++)
694 hash
= iterative_hash_rtx (XVECEXP (x
, i
, j
), hash
);
697 hash
= iterative_hash_rtx (XEXP (x
, i
), hash
);
702 hash
= iterative_hash (XSTR (x
, 0), strlen (XSTR (x
, 0)) + 1,
712 dump_rtx_statistics (void)
714 #ifdef GATHER_STATISTICS
716 int total_counts
= 0;
718 fprintf (stderr
, "\nRTX Kind Count Bytes\n");
719 fprintf (stderr
, "---------------------------------------\n");
720 for (i
= 0; i
< LAST_AND_UNUSED_RTX_CODE
; i
++)
721 if (rtx_alloc_counts
[i
])
723 fprintf (stderr
, "%-20s %7d %10d\n", GET_RTX_NAME (i
),
724 rtx_alloc_counts
[i
], rtx_alloc_sizes
[i
]);
725 total_counts
+= rtx_alloc_counts
[i
];
726 total_sizes
+= rtx_alloc_sizes
[i
];
728 if (rtvec_alloc_counts
)
730 fprintf (stderr
, "%-20s %7d %10d\n", "rtvec",
731 rtvec_alloc_counts
, rtvec_alloc_sizes
);
732 total_counts
+= rtvec_alloc_counts
;
733 total_sizes
+= rtvec_alloc_sizes
;
735 fprintf (stderr
, "---------------------------------------\n");
736 fprintf (stderr
, "%-20s %7d %10d\n",
737 "Total", total_counts
, total_sizes
);
738 fprintf (stderr
, "---------------------------------------\n");
742 #if defined ENABLE_RTL_CHECKING && (GCC_VERSION >= 2007)
744 rtl_check_failed_bounds (const_rtx r
, int n
, const char *file
, int line
,
748 ("RTL check: access of elt %d of '%s' with last elt %d in %s, at %s:%d",
749 n
, GET_RTX_NAME (GET_CODE (r
)), GET_RTX_LENGTH (GET_CODE (r
)) - 1,
750 func
, trim_filename (file
), line
);
754 rtl_check_failed_type1 (const_rtx r
, int n
, int c1
, const char *file
, int line
,
758 ("RTL check: expected elt %d type '%c', have '%c' (rtx %s) in %s, at %s:%d",
759 n
, c1
, GET_RTX_FORMAT (GET_CODE (r
))[n
], GET_RTX_NAME (GET_CODE (r
)),
760 func
, trim_filename (file
), line
);
764 rtl_check_failed_type2 (const_rtx r
, int n
, int c1
, int c2
, const char *file
,
765 int line
, const char *func
)
768 ("RTL check: expected elt %d type '%c' or '%c', have '%c' (rtx %s) in %s, at %s:%d",
769 n
, c1
, c2
, GET_RTX_FORMAT (GET_CODE (r
))[n
], GET_RTX_NAME (GET_CODE (r
)),
770 func
, trim_filename (file
), line
);
774 rtl_check_failed_code1 (const_rtx r
, enum rtx_code code
, const char *file
,
775 int line
, const char *func
)
777 internal_error ("RTL check: expected code '%s', have '%s' in %s, at %s:%d",
778 GET_RTX_NAME (code
), GET_RTX_NAME (GET_CODE (r
)), func
,
779 trim_filename (file
), line
);
783 rtl_check_failed_code2 (const_rtx r
, enum rtx_code code1
, enum rtx_code code2
,
784 const char *file
, int line
, const char *func
)
787 ("RTL check: expected code '%s' or '%s', have '%s' in %s, at %s:%d",
788 GET_RTX_NAME (code1
), GET_RTX_NAME (code2
), GET_RTX_NAME (GET_CODE (r
)),
789 func
, trim_filename (file
), line
);
793 rtl_check_failed_code_mode (const_rtx r
, enum rtx_code code
, enum machine_mode mode
,
794 bool not_mode
, const char *file
, int line
,
797 internal_error ((not_mode
798 ? ("RTL check: expected code '%s' and not mode '%s', "
799 "have code '%s' and mode '%s' in %s, at %s:%d")
800 : ("RTL check: expected code '%s' and mode '%s', "
801 "have code '%s' and mode '%s' in %s, at %s:%d")),
802 GET_RTX_NAME (code
), GET_MODE_NAME (mode
),
803 GET_RTX_NAME (GET_CODE (r
)), GET_MODE_NAME (GET_MODE (r
)),
804 func
, trim_filename (file
), line
);
807 /* Report that line LINE of FILE tried to access the block symbol fields
808 of a non-block symbol. FUNC is the function that contains the line. */
811 rtl_check_failed_block_symbol (const char *file
, int line
, const char *func
)
814 ("RTL check: attempt to treat non-block symbol as a block symbol "
815 "in %s, at %s:%d", func
, trim_filename (file
), line
);
818 /* XXX Maybe print the vector? */
820 rtvec_check_failed_bounds (const_rtvec r
, int n
, const char *file
, int line
,
824 ("RTL check: access of elt %d of vector with last elt %d in %s, at %s:%d",
825 n
, GET_NUM_ELEM (r
) - 1, func
, trim_filename (file
), line
);
827 #endif /* ENABLE_RTL_CHECKING */
829 #if defined ENABLE_RTL_FLAG_CHECKING
831 rtl_check_failed_flag (const char *name
, const_rtx r
, const char *file
,
832 int line
, const char *func
)
835 ("RTL flag check: %s used with unexpected rtx code '%s' in %s, at %s:%d",
836 name
, GET_RTX_NAME (GET_CODE (r
)), func
, trim_filename (file
), line
);
838 #endif /* ENABLE_RTL_FLAG_CHECKING */