1 /* RTL utility routines.
2 Copyright (C) 1987-2014 Free Software Foundation, Inc.
4 This file is part of GCC.
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 3, or (at your option) any later
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING3. If not see
18 <http://www.gnu.org/licenses/>. */
20 /* This file is compiled twice: once for the generator programs
21 once for the compiler. */
29 #include "coretypes.h"
36 # include "diagnostic-core.h"
40 /* Indexed by rtx code, gives number of operands for an rtx with that code.
41 Does NOT include rtx header data (code and links). */
43 #define DEF_RTL_EXPR(ENUM, NAME, FORMAT, CLASS) sizeof FORMAT - 1 ,
45 const unsigned char rtx_length
[NUM_RTX_CODE
] = {
51 /* Indexed by rtx code, gives the name of that kind of rtx, as a C string. */
53 #define DEF_RTL_EXPR(ENUM, NAME, FORMAT, CLASS) NAME ,
55 const char * const rtx_name
[NUM_RTX_CODE
] = {
56 #include "rtl.def" /* rtl expressions are documented here */
61 /* Indexed by rtx code, gives a sequence of operand-types for
62 rtx's of that code. The sequence is a C string in which
63 each character describes one operand. */
65 const char * const rtx_format
[NUM_RTX_CODE
] = {
67 can cause a warning message
68 "0" field is unused (or used in a phase-dependent manner)
72 "n" like "i", but prints entries from `note_insn_name'
73 "w" an integer of width HOST_BITS_PER_WIDE_INT
75 "s" a pointer to a string
77 "S" like "s", but optional:
78 the containing rtx may end before this operand
79 "T" like "s", but treated specially by the RTL reader;
80 only found in machine description patterns.
81 "e" a pointer to an rtl expression
83 "E" a pointer to a vector that points to a number of rtl expressions
84 prints a list of the rtl expressions
85 "V" like "E", but optional:
86 the containing rtx may end before this operand
87 "u" a pointer to another insn
88 prints the uid of the insn.
89 "b" is a pointer to a bitmap header.
90 "B" is a basic block pointer.
91 "t" is a tree pointer. */
93 #define DEF_RTL_EXPR(ENUM, NAME, FORMAT, CLASS) FORMAT ,
94 #include "rtl.def" /* rtl expressions are defined here */
98 /* Indexed by rtx code, gives a character representing the "class" of
99 that rtx code. See rtl.def for documentation on the defined classes. */
101 const enum rtx_class rtx_class
[NUM_RTX_CODE
] = {
102 #define DEF_RTL_EXPR(ENUM, NAME, FORMAT, CLASS) CLASS,
103 #include "rtl.def" /* rtl expressions are defined here */
107 /* Indexed by rtx code, gives the size of the rtx in bytes. */
109 const unsigned char rtx_code_size
[NUM_RTX_CODE
] = {
110 #define DEF_RTL_EXPR(ENUM, NAME, FORMAT, CLASS) \
111 (((ENUM) == CONST_INT || (ENUM) == CONST_DOUBLE \
112 || (ENUM) == CONST_FIXED || (ENUM) == CONST_WIDE_INT) \
113 ? RTX_HDR_SIZE + (sizeof FORMAT - 1) * sizeof (HOST_WIDE_INT) \
114 : RTX_HDR_SIZE + (sizeof FORMAT - 1) * sizeof (rtunion)),
120 /* Names for kinds of NOTEs and REG_NOTEs. */
122 const char * const note_insn_name
[NOTE_INSN_MAX
] =
124 #define DEF_INSN_NOTE(NAME) #NAME,
125 #include "insn-notes.def"
129 const char * const reg_note_name
[REG_NOTE_MAX
] =
131 #define DEF_REG_NOTE(NAME) #NAME,
132 #include "reg-notes.def"
136 static int rtx_alloc_counts
[(int) LAST_AND_UNUSED_RTX_CODE
];
137 static int rtx_alloc_sizes
[(int) LAST_AND_UNUSED_RTX_CODE
];
138 static int rtvec_alloc_counts
;
139 static int rtvec_alloc_sizes
;
142 /* Allocate an rtx vector of N elements.
143 Store the length, and initialize all elements to zero. */
150 rt
= ggc_alloc_rtvec_sized (n
);
151 /* Clear out the vector. */
152 memset (&rt
->elem
[0], 0, n
* sizeof (rtx
));
154 PUT_NUM_ELEM (rt
, n
);
156 if (GATHER_STATISTICS
)
158 rtvec_alloc_counts
++;
159 rtvec_alloc_sizes
+= n
* sizeof (rtx
);
165 /* Create a bitwise copy of VEC. */
168 shallow_copy_rtvec (rtvec vec
)
173 n
= GET_NUM_ELEM (vec
);
174 newvec
= rtvec_alloc (n
);
175 memcpy (&newvec
->elem
[0], &vec
->elem
[0], sizeof (rtx
) * n
);
179 /* Return the number of bytes occupied by rtx value X. */
182 rtx_size (const_rtx x
)
184 if (CONST_WIDE_INT_P (x
))
186 + sizeof (struct hwivec_def
)
187 + ((CONST_WIDE_INT_NUNITS (x
) - 1)
188 * sizeof (HOST_WIDE_INT
)));
189 if (GET_CODE (x
) == SYMBOL_REF
&& SYMBOL_REF_HAS_BLOCK_INFO_P (x
))
190 return RTX_HDR_SIZE
+ sizeof (struct block_symbol
);
191 return RTX_CODE_SIZE (GET_CODE (x
));
194 /* Allocate an rtx of code CODE with EXTRA bytes in it. The CODE is
195 stored in the rtx; all the rest is initialized to zero. */
198 rtx_alloc_stat_v (RTX_CODE code MEM_STAT_DECL
, int extra
)
200 rtx rt
= ggc_alloc_rtx_def_stat (RTX_CODE_SIZE (code
) + extra
203 /* We want to clear everything up to the FLD array. Normally, this
204 is one int, but we don't want to assume that and it isn't very
205 portable anyway; this is. */
207 memset (rt
, 0, RTX_HDR_SIZE
);
210 if (GATHER_STATISTICS
)
212 rtx_alloc_counts
[code
]++;
213 rtx_alloc_sizes
[code
] += RTX_CODE_SIZE (code
);
219 /* Allocate an rtx of code CODE. The CODE is stored in the rtx;
220 all the rest is initialized to zero. */
223 rtx_alloc_stat (RTX_CODE code MEM_STAT_DECL
)
225 return rtx_alloc_stat_v (code PASS_MEM_STAT
, 0);
228 /* Write the wide constant X to OUTFILE. */
231 cwi_output_hex (FILE *outfile
, const_rtx x
)
233 int i
= CWI_GET_NUM_ELEM (x
);
235 if (CWI_ELT (x
, i
- 1) == 0)
236 /* The HOST_WIDE_INT_PRINT_HEX prepends a 0x only if the val is
237 non zero. We want all numbers to have a 0x prefix. */
238 fprintf (outfile
, "0x");
239 fprintf (outfile
, HOST_WIDE_INT_PRINT_HEX
, CWI_ELT (x
, --i
));
241 fprintf (outfile
, HOST_WIDE_INT_PRINT_PADDED_HEX
, CWI_ELT (x
, i
));
245 /* Return true if ORIG is a sharable CONST. */
248 shared_const_p (const_rtx orig
)
250 gcc_assert (GET_CODE (orig
) == CONST
);
252 /* CONST can be shared if it contains a SYMBOL_REF. If it contains
253 a LABEL_REF, it isn't sharable. */
254 return (GET_CODE (XEXP (orig
, 0)) == PLUS
255 && GET_CODE (XEXP (XEXP (orig
, 0), 0)) == SYMBOL_REF
256 && CONST_INT_P (XEXP (XEXP (orig
, 0), 1)));
260 /* Create a new copy of an rtx.
261 Recursively copies the operands of the rtx,
262 except for those few rtx codes that are sharable. */
270 const char *format_ptr
;
272 code
= GET_CODE (orig
);
287 /* SCRATCH must be shared because they represent distinct values. */
290 /* Share clobbers of hard registers (like cc0), but do not share pseudo reg
291 clobbers or clobbers of hard registers that originated as pseudos.
292 This is needed to allow safe register renaming. */
293 if (REG_P (XEXP (orig
, 0)) && REGNO (XEXP (orig
, 0)) < FIRST_PSEUDO_REGISTER
294 && ORIGINAL_REGNO (XEXP (orig
, 0)) == REGNO (XEXP (orig
, 0)))
299 if (shared_const_p (orig
))
303 /* A MEM with a constant address is not sharable. The problem is that
304 the constant address may need to be reloaded. If the mem is shared,
305 then reloading one copy of this mem will cause all copies to appear
306 to have been reloaded. */
312 /* Copy the various flags, fields, and other information. We assume
313 that all fields need copying, and then clear the fields that should
314 not be copied. That is the sensible default behavior, and forces
315 us to explicitly document why we are *not* copying a flag. */
316 copy
= shallow_copy_rtx (orig
);
318 /* We do not copy the USED flag, which is used as a mark bit during
319 walks over the RTL. */
320 RTX_FLAG (copy
, used
) = 0;
322 format_ptr
= GET_RTX_FORMAT (GET_CODE (copy
));
324 for (i
= 0; i
< GET_RTX_LENGTH (GET_CODE (copy
)); i
++)
325 switch (*format_ptr
++)
328 if (XEXP (orig
, i
) != NULL
)
329 XEXP (copy
, i
) = copy_rtx (XEXP (orig
, i
));
334 if (XVEC (orig
, i
) != NULL
)
336 XVEC (copy
, i
) = rtvec_alloc (XVECLEN (orig
, i
));
337 for (j
= 0; j
< XVECLEN (copy
, i
); j
++)
338 XVECEXP (copy
, i
, j
) = copy_rtx (XVECEXP (orig
, i
, j
));
351 /* These are left unchanged. */
360 /* Create a new copy of an rtx. Only copy just one level. */
363 shallow_copy_rtx_stat (const_rtx orig MEM_STAT_DECL
)
365 const unsigned int size
= rtx_size (orig
);
366 rtx
const copy
= ggc_alloc_rtx_def_stat (size PASS_MEM_STAT
);
367 return (rtx
) memcpy (copy
, orig
, size
);
370 /* Nonzero when we are generating CONCATs. */
371 int generating_concat_p
;
373 /* Nonzero when we are expanding trees to RTL. */
374 int currently_expanding_to_rtl
;
378 /* Same as rtx_equal_p, but call CB on each pair of rtx if CB is not NULL.
379 When the callback returns true, we continue with the new pair.
380 Whenever changing this function check if rtx_equal_p below doesn't need
384 rtx_equal_p_cb (const_rtx x
, const_rtx y
, rtx_equal_p_callback_function cb
)
394 if (x
== 0 || y
== 0)
397 /* Invoke the callback first. */
399 && ((*cb
) (&x
, &y
, &nx
, &ny
)))
400 return rtx_equal_p_cb (nx
, ny
, cb
);
403 /* Rtx's of different codes cannot be equal. */
404 if (code
!= GET_CODE (y
))
407 /* (MULT:SI x y) and (MULT:HI x y) are NOT equivalent.
408 (REG:SI x) and (REG:HI x) are NOT equivalent. */
410 if (GET_MODE (x
) != GET_MODE (y
))
413 /* MEMs referring to different address space are not equivalent. */
414 if (code
== MEM
&& MEM_ADDR_SPACE (x
) != MEM_ADDR_SPACE (y
))
417 /* Some RTL can be compared nonrecursively. */
421 return (REGNO (x
) == REGNO (y
));
424 return XEXP (x
, 0) == XEXP (y
, 0);
427 return XSTR (x
, 0) == XSTR (y
, 0);
435 case DEBUG_IMPLICIT_PTR
:
436 return DEBUG_IMPLICIT_PTR_DECL (x
)
437 == DEBUG_IMPLICIT_PTR_DECL (y
);
439 case DEBUG_PARAMETER_REF
:
440 return DEBUG_PARAMETER_REF_DECL (x
)
441 == DEBUG_PARAMETER_REF_DECL (x
);
444 return rtx_equal_p_cb (ENTRY_VALUE_EXP (x
), ENTRY_VALUE_EXP (y
), cb
);
450 /* Compare the elements. If any pair of corresponding elements
451 fail to match, return 0 for the whole thing. */
453 fmt
= GET_RTX_FORMAT (code
);
454 for (i
= GET_RTX_LENGTH (code
) - 1; i
>= 0; i
--)
459 if (XWINT (x
, i
) != XWINT (y
, i
))
465 if (XINT (x
, i
) != XINT (y
, i
))
467 #ifndef GENERATOR_FILE
468 if (((code
== ASM_OPERANDS
&& i
== 6)
469 || (code
== ASM_INPUT
&& i
== 1))
470 && XINT (x
, i
) == XINT (y
, i
))
479 /* Two vectors must have the same length. */
480 if (XVECLEN (x
, i
) != XVECLEN (y
, i
))
483 /* And the corresponding elements must match. */
484 for (j
= 0; j
< XVECLEN (x
, i
); j
++)
485 if (rtx_equal_p_cb (XVECEXP (x
, i
, j
),
486 XVECEXP (y
, i
, j
), cb
) == 0)
491 if (rtx_equal_p_cb (XEXP (x
, i
), XEXP (y
, i
), cb
) == 0)
497 if ((XSTR (x
, i
) || XSTR (y
, i
))
498 && (! XSTR (x
, i
) || ! XSTR (y
, i
)
499 || strcmp (XSTR (x
, i
), XSTR (y
, i
))))
504 /* These are just backpointers, so they don't matter. */
511 /* It is believed that rtx's at this level will never
512 contain anything but integers and other rtx's,
513 except for within LABEL_REFs and SYMBOL_REFs. */
521 /* Return 1 if X and Y are identical-looking rtx's.
522 This is the Lisp function EQUAL for rtx arguments.
523 Whenever changing this function check if rtx_equal_p_cb above doesn't need
527 rtx_equal_p (const_rtx x
, const_rtx y
)
536 if (x
== 0 || y
== 0)
540 /* Rtx's of different codes cannot be equal. */
541 if (code
!= GET_CODE (y
))
544 /* (MULT:SI x y) and (MULT:HI x y) are NOT equivalent.
545 (REG:SI x) and (REG:HI x) are NOT equivalent. */
547 if (GET_MODE (x
) != GET_MODE (y
))
550 /* MEMs referring to different address space are not equivalent. */
551 if (code
== MEM
&& MEM_ADDR_SPACE (x
) != MEM_ADDR_SPACE (y
))
554 /* Some RTL can be compared nonrecursively. */
558 return (REGNO (x
) == REGNO (y
));
561 return XEXP (x
, 0) == XEXP (y
, 0);
564 return XSTR (x
, 0) == XSTR (y
, 0);
572 case DEBUG_IMPLICIT_PTR
:
573 return DEBUG_IMPLICIT_PTR_DECL (x
)
574 == DEBUG_IMPLICIT_PTR_DECL (y
);
576 case DEBUG_PARAMETER_REF
:
577 return DEBUG_PARAMETER_REF_DECL (x
)
578 == DEBUG_PARAMETER_REF_DECL (y
);
581 return rtx_equal_p (ENTRY_VALUE_EXP (x
), ENTRY_VALUE_EXP (y
));
587 /* Compare the elements. If any pair of corresponding elements
588 fail to match, return 0 for the whole thing. */
590 fmt
= GET_RTX_FORMAT (code
);
591 for (i
= GET_RTX_LENGTH (code
) - 1; i
>= 0; i
--)
596 if (XWINT (x
, i
) != XWINT (y
, i
))
602 if (XINT (x
, i
) != XINT (y
, i
))
604 #ifndef GENERATOR_FILE
605 if (((code
== ASM_OPERANDS
&& i
== 6)
606 || (code
== ASM_INPUT
&& i
== 1))
607 && XINT (x
, i
) == XINT (y
, i
))
616 /* Two vectors must have the same length. */
617 if (XVECLEN (x
, i
) != XVECLEN (y
, i
))
620 /* And the corresponding elements must match. */
621 for (j
= 0; j
< XVECLEN (x
, i
); j
++)
622 if (rtx_equal_p (XVECEXP (x
, i
, j
), XVECEXP (y
, i
, j
)) == 0)
627 if (rtx_equal_p (XEXP (x
, i
), XEXP (y
, i
)) == 0)
633 if ((XSTR (x
, i
) || XSTR (y
, i
))
634 && (! XSTR (x
, i
) || ! XSTR (y
, i
)
635 || strcmp (XSTR (x
, i
), XSTR (y
, i
))))
640 /* These are just backpointers, so they don't matter. */
647 /* It is believed that rtx's at this level will never
648 contain anything but integers and other rtx's,
649 except for within LABEL_REFs and SYMBOL_REFs. */
657 /* Iteratively hash rtx X. */
660 iterative_hash_rtx (const_rtx x
, hashval_t hash
)
663 enum machine_mode mode
;
670 hash
= iterative_hash_object (code
, hash
);
672 hash
= iterative_hash_object (mode
, hash
);
677 return iterative_hash_object (i
, hash
);
679 return iterative_hash_object (INTVAL (x
), hash
);
681 for (i
= 0; i
< CONST_WIDE_INT_NUNITS (x
); i
++)
682 hash
= iterative_hash_object (CONST_WIDE_INT_ELT (x
, i
), hash
);
686 return iterative_hash (XSTR (x
, 0), strlen (XSTR (x
, 0)) + 1,
695 case DEBUG_IMPLICIT_PTR
:
696 case DEBUG_PARAMETER_REF
:
702 fmt
= GET_RTX_FORMAT (code
);
703 for (i
= GET_RTX_LENGTH (code
) - 1; i
>= 0; i
--)
707 hash
= iterative_hash_object (XWINT (x
, i
), hash
);
711 hash
= iterative_hash_object (XINT (x
, i
), hash
);
716 hash
= iterative_hash_object (j
, hash
);
717 for (j
= 0; j
< XVECLEN (x
, i
); j
++)
718 hash
= iterative_hash_rtx (XVECEXP (x
, i
, j
), hash
);
721 hash
= iterative_hash_rtx (XEXP (x
, i
), hash
);
726 hash
= iterative_hash (XSTR (x
, 0), strlen (XSTR (x
, 0)) + 1,
736 dump_rtx_statistics (void)
739 int total_counts
= 0;
742 if (! GATHER_STATISTICS
)
744 fprintf (stderr
, "No RTX statistics\n");
748 fprintf (stderr
, "\nRTX Kind Count Bytes\n");
749 fprintf (stderr
, "---------------------------------------\n");
750 for (i
= 0; i
< LAST_AND_UNUSED_RTX_CODE
; i
++)
751 if (rtx_alloc_counts
[i
])
753 fprintf (stderr
, "%-20s %7d %10d\n", GET_RTX_NAME (i
),
754 rtx_alloc_counts
[i
], rtx_alloc_sizes
[i
]);
755 total_counts
+= rtx_alloc_counts
[i
];
756 total_sizes
+= rtx_alloc_sizes
[i
];
758 if (rtvec_alloc_counts
)
760 fprintf (stderr
, "%-20s %7d %10d\n", "rtvec",
761 rtvec_alloc_counts
, rtvec_alloc_sizes
);
762 total_counts
+= rtvec_alloc_counts
;
763 total_sizes
+= rtvec_alloc_sizes
;
765 fprintf (stderr
, "---------------------------------------\n");
766 fprintf (stderr
, "%-20s %7d %10d\n",
767 "Total", total_counts
, total_sizes
);
768 fprintf (stderr
, "---------------------------------------\n");
771 #if defined ENABLE_RTL_CHECKING && (GCC_VERSION >= 2007)
773 rtl_check_failed_bounds (const_rtx r
, int n
, const char *file
, int line
,
777 ("RTL check: access of elt %d of '%s' with last elt %d in %s, at %s:%d",
778 n
, GET_RTX_NAME (GET_CODE (r
)), GET_RTX_LENGTH (GET_CODE (r
)) - 1,
779 func
, trim_filename (file
), line
);
783 rtl_check_failed_type1 (const_rtx r
, int n
, int c1
, const char *file
, int line
,
787 ("RTL check: expected elt %d type '%c', have '%c' (rtx %s) in %s, at %s:%d",
788 n
, c1
, GET_RTX_FORMAT (GET_CODE (r
))[n
], GET_RTX_NAME (GET_CODE (r
)),
789 func
, trim_filename (file
), line
);
793 rtl_check_failed_type2 (const_rtx r
, int n
, int c1
, int c2
, const char *file
,
794 int line
, const char *func
)
797 ("RTL check: expected elt %d type '%c' or '%c', have '%c' (rtx %s) in %s, at %s:%d",
798 n
, c1
, c2
, GET_RTX_FORMAT (GET_CODE (r
))[n
], GET_RTX_NAME (GET_CODE (r
)),
799 func
, trim_filename (file
), line
);
803 rtl_check_failed_code1 (const_rtx r
, enum rtx_code code
, const char *file
,
804 int line
, const char *func
)
806 internal_error ("RTL check: expected code '%s', have '%s' in %s, at %s:%d",
807 GET_RTX_NAME (code
), GET_RTX_NAME (GET_CODE (r
)), func
,
808 trim_filename (file
), line
);
812 rtl_check_failed_code2 (const_rtx r
, enum rtx_code code1
, enum rtx_code code2
,
813 const char *file
, int line
, const char *func
)
816 ("RTL check: expected code '%s' or '%s', have '%s' in %s, at %s:%d",
817 GET_RTX_NAME (code1
), GET_RTX_NAME (code2
), GET_RTX_NAME (GET_CODE (r
)),
818 func
, trim_filename (file
), line
);
822 rtl_check_failed_code_mode (const_rtx r
, enum rtx_code code
, enum machine_mode mode
,
823 bool not_mode
, const char *file
, int line
,
826 internal_error ((not_mode
827 ? ("RTL check: expected code '%s' and not mode '%s', "
828 "have code '%s' and mode '%s' in %s, at %s:%d")
829 : ("RTL check: expected code '%s' and mode '%s', "
830 "have code '%s' and mode '%s' in %s, at %s:%d")),
831 GET_RTX_NAME (code
), GET_MODE_NAME (mode
),
832 GET_RTX_NAME (GET_CODE (r
)), GET_MODE_NAME (GET_MODE (r
)),
833 func
, trim_filename (file
), line
);
836 /* Report that line LINE of FILE tried to access the block symbol fields
837 of a non-block symbol. FUNC is the function that contains the line. */
840 rtl_check_failed_block_symbol (const char *file
, int line
, const char *func
)
843 ("RTL check: attempt to treat non-block symbol as a block symbol "
844 "in %s, at %s:%d", func
, trim_filename (file
), line
);
847 /* XXX Maybe print the vector? */
849 cwi_check_failed_bounds (const_rtx x
, int n
, const char *file
, int line
,
853 ("RTL check: access of hwi elt %d of vector with last elt %d in %s, at %s:%d",
854 n
, CWI_GET_NUM_ELEM (x
) - 1, func
, trim_filename (file
), line
);
857 /* XXX Maybe print the vector? */
859 rtvec_check_failed_bounds (const_rtvec r
, int n
, const char *file
, int line
,
863 ("RTL check: access of elt %d of vector with last elt %d in %s, at %s:%d",
864 n
, GET_NUM_ELEM (r
) - 1, func
, trim_filename (file
), line
);
866 #endif /* ENABLE_RTL_CHECKING */
868 #if defined ENABLE_RTL_FLAG_CHECKING
870 rtl_check_failed_flag (const char *name
, const_rtx r
, const char *file
,
871 int line
, const char *func
)
874 ("RTL flag check: %s used with unexpected rtx code '%s' in %s, at %s:%d",
875 name
, GET_RTX_NAME (GET_CODE (r
)), func
, trim_filename (file
), line
);
877 #endif /* ENABLE_RTL_FLAG_CHECKING */