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
);
260 /* SCRATCH must be shared because they represent distinct values. */
263 if (REG_P (XEXP (orig
, 0)) && REGNO (XEXP (orig
, 0)) < FIRST_PSEUDO_REGISTER
)
268 if (shared_const_p (orig
))
272 /* A MEM with a constant address is not sharable. The problem is that
273 the constant address may need to be reloaded. If the mem is shared,
274 then reloading one copy of this mem will cause all copies to appear
275 to have been reloaded. */
281 /* Copy the various flags, fields, and other information. We assume
282 that all fields need copying, and then clear the fields that should
283 not be copied. That is the sensible default behavior, and forces
284 us to explicitly document why we are *not* copying a flag. */
285 copy
= shallow_copy_rtx (orig
);
287 /* We do not copy the USED flag, which is used as a mark bit during
288 walks over the RTL. */
289 RTX_FLAG (copy
, used
) = 0;
291 /* We do not copy FRAME_RELATED for INSNs. */
293 RTX_FLAG (copy
, frame_related
) = 0;
294 RTX_FLAG (copy
, jump
) = RTX_FLAG (orig
, jump
);
295 RTX_FLAG (copy
, call
) = RTX_FLAG (orig
, call
);
297 format_ptr
= GET_RTX_FORMAT (GET_CODE (copy
));
299 for (i
= 0; i
< GET_RTX_LENGTH (GET_CODE (copy
)); i
++)
300 switch (*format_ptr
++)
303 if (XEXP (orig
, i
) != NULL
)
304 XEXP (copy
, i
) = copy_rtx (XEXP (orig
, i
));
309 if (XVEC (orig
, i
) != NULL
)
311 XVEC (copy
, i
) = rtvec_alloc (XVECLEN (orig
, i
));
312 for (j
= 0; j
< XVECLEN (copy
, i
); j
++)
313 XVECEXP (copy
, i
, j
) = copy_rtx (XVECEXP (orig
, i
, j
));
326 /* These are left unchanged. */
335 /* Create a new copy of an rtx. Only copy just one level. */
338 shallow_copy_rtx_stat (const_rtx orig MEM_STAT_DECL
)
340 const unsigned int size
= rtx_size (orig
);
341 rtx
const copy
= ggc_alloc_zone_rtx_def_stat (&rtl_zone
, size PASS_MEM_STAT
);
342 return (rtx
) memcpy (copy
, orig
, size
);
345 /* Nonzero when we are generating CONCATs. */
346 int generating_concat_p
;
348 /* Nonzero when we are expanding trees to RTL. */
349 int currently_expanding_to_rtl
;
353 /* Same as rtx_equal_p, but call CB on each pair of rtx if CB is not NULL.
354 When the callback returns true, we continue with the new pair.
355 Whenever changing this function check if rtx_equal_p below doesn't need
359 rtx_equal_p_cb (const_rtx x
, const_rtx y
, rtx_equal_p_callback_function cb
)
369 if (x
== 0 || y
== 0)
372 /* Invoke the callback first. */
374 && ((*cb
) (&x
, &y
, &nx
, &ny
)))
375 return rtx_equal_p_cb (nx
, ny
, cb
);
378 /* Rtx's of different codes cannot be equal. */
379 if (code
!= GET_CODE (y
))
382 /* (MULT:SI x y) and (MULT:HI x y) are NOT equivalent.
383 (REG:SI x) and (REG:HI x) are NOT equivalent. */
385 if (GET_MODE (x
) != GET_MODE (y
))
388 /* MEMs refering to different address space are not equivalent. */
389 if (code
== MEM
&& MEM_ADDR_SPACE (x
) != MEM_ADDR_SPACE (y
))
392 /* Some RTL can be compared nonrecursively. */
396 return (REGNO (x
) == REGNO (y
));
399 return XEXP (x
, 0) == XEXP (y
, 0);
402 return XSTR (x
, 0) == XSTR (y
, 0);
412 case DEBUG_IMPLICIT_PTR
:
413 return DEBUG_IMPLICIT_PTR_DECL (x
)
414 == DEBUG_IMPLICIT_PTR_DECL (y
);
416 case DEBUG_PARAMETER_REF
:
417 return DEBUG_PARAMETER_REF_DECL (x
)
418 == DEBUG_PARAMETER_REF_DECL (x
);
421 return rtx_equal_p_cb (ENTRY_VALUE_EXP (x
), ENTRY_VALUE_EXP (y
), cb
);
427 /* Compare the elements. If any pair of corresponding elements
428 fail to match, return 0 for the whole thing. */
430 fmt
= GET_RTX_FORMAT (code
);
431 for (i
= GET_RTX_LENGTH (code
) - 1; i
>= 0; i
--)
436 if (XWINT (x
, i
) != XWINT (y
, i
))
442 if (XINT (x
, i
) != XINT (y
, i
))
444 #ifndef GENERATOR_FILE
445 if (((code
== ASM_OPERANDS
&& i
== 6)
446 || (code
== ASM_INPUT
&& i
== 1))
447 && locator_eq (XINT (x
, i
), XINT (y
, i
)))
456 /* Two vectors must have the same length. */
457 if (XVECLEN (x
, i
) != XVECLEN (y
, i
))
460 /* And the corresponding elements must match. */
461 for (j
= 0; j
< XVECLEN (x
, i
); j
++)
462 if (rtx_equal_p_cb (XVECEXP (x
, i
, j
),
463 XVECEXP (y
, i
, j
), cb
) == 0)
468 if (rtx_equal_p_cb (XEXP (x
, i
), XEXP (y
, i
), cb
) == 0)
474 if ((XSTR (x
, i
) || XSTR (y
, i
))
475 && (! XSTR (x
, i
) || ! XSTR (y
, i
)
476 || strcmp (XSTR (x
, i
), XSTR (y
, i
))))
481 /* These are just backpointers, so they don't matter. */
488 /* It is believed that rtx's at this level will never
489 contain anything but integers and other rtx's,
490 except for within LABEL_REFs and SYMBOL_REFs. */
498 /* Return 1 if X and Y are identical-looking rtx's.
499 This is the Lisp function EQUAL for rtx arguments.
500 Whenever changing this function check if rtx_equal_p_cb above doesn't need
504 rtx_equal_p (const_rtx x
, const_rtx y
)
513 if (x
== 0 || y
== 0)
517 /* Rtx's of different codes cannot be equal. */
518 if (code
!= GET_CODE (y
))
521 /* (MULT:SI x y) and (MULT:HI x y) are NOT equivalent.
522 (REG:SI x) and (REG:HI x) are NOT equivalent. */
524 if (GET_MODE (x
) != GET_MODE (y
))
527 /* MEMs refering to different address space are not equivalent. */
528 if (code
== MEM
&& MEM_ADDR_SPACE (x
) != MEM_ADDR_SPACE (y
))
531 /* Some RTL can be compared nonrecursively. */
535 return (REGNO (x
) == REGNO (y
));
538 return XEXP (x
, 0) == XEXP (y
, 0);
541 return XSTR (x
, 0) == XSTR (y
, 0);
551 case DEBUG_IMPLICIT_PTR
:
552 return DEBUG_IMPLICIT_PTR_DECL (x
)
553 == DEBUG_IMPLICIT_PTR_DECL (y
);
555 case DEBUG_PARAMETER_REF
:
556 return DEBUG_PARAMETER_REF_DECL (x
)
557 == DEBUG_PARAMETER_REF_DECL (y
);
560 return rtx_equal_p (ENTRY_VALUE_EXP (x
), ENTRY_VALUE_EXP (y
));
566 /* Compare the elements. If any pair of corresponding elements
567 fail to match, return 0 for the whole thing. */
569 fmt
= GET_RTX_FORMAT (code
);
570 for (i
= GET_RTX_LENGTH (code
) - 1; i
>= 0; i
--)
575 if (XWINT (x
, i
) != XWINT (y
, i
))
581 if (XINT (x
, i
) != XINT (y
, i
))
583 #ifndef GENERATOR_FILE
584 if (((code
== ASM_OPERANDS
&& i
== 6)
585 || (code
== ASM_INPUT
&& i
== 1))
586 && locator_eq (XINT (x
, i
), XINT (y
, i
)))
595 /* Two vectors must have the same length. */
596 if (XVECLEN (x
, i
) != XVECLEN (y
, i
))
599 /* And the corresponding elements must match. */
600 for (j
= 0; j
< XVECLEN (x
, i
); j
++)
601 if (rtx_equal_p (XVECEXP (x
, i
, j
), XVECEXP (y
, i
, j
)) == 0)
606 if (rtx_equal_p (XEXP (x
, i
), XEXP (y
, i
)) == 0)
612 if ((XSTR (x
, i
) || XSTR (y
, i
))
613 && (! XSTR (x
, i
) || ! XSTR (y
, i
)
614 || strcmp (XSTR (x
, i
), XSTR (y
, i
))))
619 /* These are just backpointers, so they don't matter. */
626 /* It is believed that rtx's at this level will never
627 contain anything but integers and other rtx's,
628 except for within LABEL_REFs and SYMBOL_REFs. */
636 /* Iteratively hash rtx X. */
639 iterative_hash_rtx (const_rtx x
, hashval_t hash
)
642 enum machine_mode mode
;
649 hash
= iterative_hash_object (code
, hash
);
651 hash
= iterative_hash_object (mode
, hash
);
656 return iterative_hash_object (i
, hash
);
658 return iterative_hash_object (INTVAL (x
), hash
);
661 return iterative_hash (XSTR (x
, 0), strlen (XSTR (x
, 0)) + 1,
670 case DEBUG_IMPLICIT_PTR
:
671 case DEBUG_PARAMETER_REF
:
677 fmt
= GET_RTX_FORMAT (code
);
678 for (i
= GET_RTX_LENGTH (code
) - 1; i
>= 0; i
--)
682 hash
= iterative_hash_object (XWINT (x
, i
), hash
);
686 hash
= iterative_hash_object (XINT (x
, i
), hash
);
691 hash
= iterative_hash_object (j
, hash
);
692 for (j
= 0; j
< XVECLEN (x
, i
); j
++)
693 hash
= iterative_hash_rtx (XVECEXP (x
, i
, j
), hash
);
696 hash
= iterative_hash_rtx (XEXP (x
, i
), hash
);
701 hash
= iterative_hash (XSTR (x
, 0), strlen (XSTR (x
, 0)) + 1,
711 dump_rtx_statistics (void)
713 #ifdef GATHER_STATISTICS
715 int total_counts
= 0;
717 fprintf (stderr
, "\nRTX Kind Count Bytes\n");
718 fprintf (stderr
, "---------------------------------------\n");
719 for (i
= 0; i
< LAST_AND_UNUSED_RTX_CODE
; i
++)
720 if (rtx_alloc_counts
[i
])
722 fprintf (stderr
, "%-20s %7d %10d\n", GET_RTX_NAME (i
),
723 rtx_alloc_counts
[i
], rtx_alloc_sizes
[i
]);
724 total_counts
+= rtx_alloc_counts
[i
];
725 total_sizes
+= rtx_alloc_sizes
[i
];
727 if (rtvec_alloc_counts
)
729 fprintf (stderr
, "%-20s %7d %10d\n", "rtvec",
730 rtvec_alloc_counts
, rtvec_alloc_sizes
);
731 total_counts
+= rtvec_alloc_counts
;
732 total_sizes
+= rtvec_alloc_sizes
;
734 fprintf (stderr
, "---------------------------------------\n");
735 fprintf (stderr
, "%-20s %7d %10d\n",
736 "Total", total_counts
, total_sizes
);
737 fprintf (stderr
, "---------------------------------------\n");
741 #if defined ENABLE_RTL_CHECKING && (GCC_VERSION >= 2007)
743 rtl_check_failed_bounds (const_rtx r
, int n
, const char *file
, int line
,
747 ("RTL check: access of elt %d of '%s' with last elt %d in %s, at %s:%d",
748 n
, GET_RTX_NAME (GET_CODE (r
)), GET_RTX_LENGTH (GET_CODE (r
)) - 1,
749 func
, trim_filename (file
), line
);
753 rtl_check_failed_type1 (const_rtx r
, int n
, int c1
, const char *file
, int line
,
757 ("RTL check: expected elt %d type '%c', have '%c' (rtx %s) in %s, at %s:%d",
758 n
, c1
, GET_RTX_FORMAT (GET_CODE (r
))[n
], GET_RTX_NAME (GET_CODE (r
)),
759 func
, trim_filename (file
), line
);
763 rtl_check_failed_type2 (const_rtx r
, int n
, int c1
, int c2
, const char *file
,
764 int line
, const char *func
)
767 ("RTL check: expected elt %d type '%c' or '%c', have '%c' (rtx %s) in %s, at %s:%d",
768 n
, c1
, c2
, GET_RTX_FORMAT (GET_CODE (r
))[n
], GET_RTX_NAME (GET_CODE (r
)),
769 func
, trim_filename (file
), line
);
773 rtl_check_failed_code1 (const_rtx r
, enum rtx_code code
, const char *file
,
774 int line
, const char *func
)
776 internal_error ("RTL check: expected code '%s', have '%s' in %s, at %s:%d",
777 GET_RTX_NAME (code
), GET_RTX_NAME (GET_CODE (r
)), func
,
778 trim_filename (file
), line
);
782 rtl_check_failed_code2 (const_rtx r
, enum rtx_code code1
, enum rtx_code code2
,
783 const char *file
, int line
, const char *func
)
786 ("RTL check: expected code '%s' or '%s', have '%s' in %s, at %s:%d",
787 GET_RTX_NAME (code1
), GET_RTX_NAME (code2
), GET_RTX_NAME (GET_CODE (r
)),
788 func
, trim_filename (file
), line
);
792 rtl_check_failed_code_mode (const_rtx r
, enum rtx_code code
, enum machine_mode mode
,
793 bool not_mode
, const char *file
, int line
,
796 internal_error ((not_mode
797 ? ("RTL check: expected code '%s' and not mode '%s', "
798 "have code '%s' and mode '%s' in %s, at %s:%d")
799 : ("RTL check: expected code '%s' and mode '%s', "
800 "have code '%s' and mode '%s' in %s, at %s:%d")),
801 GET_RTX_NAME (code
), GET_MODE_NAME (mode
),
802 GET_RTX_NAME (GET_CODE (r
)), GET_MODE_NAME (GET_MODE (r
)),
803 func
, trim_filename (file
), line
);
806 /* Report that line LINE of FILE tried to access the block symbol fields
807 of a non-block symbol. FUNC is the function that contains the line. */
810 rtl_check_failed_block_symbol (const char *file
, int line
, const char *func
)
813 ("RTL check: attempt to treat non-block symbol as a block symbol "
814 "in %s, at %s:%d", func
, trim_filename (file
), line
);
817 /* XXX Maybe print the vector? */
819 rtvec_check_failed_bounds (const_rtvec r
, int n
, const char *file
, int line
,
823 ("RTL check: access of elt %d of vector with last elt %d in %s, at %s:%d",
824 n
, GET_NUM_ELEM (r
) - 1, func
, trim_filename (file
), line
);
826 #endif /* ENABLE_RTL_CHECKING */
828 #if defined ENABLE_RTL_FLAG_CHECKING
830 rtl_check_failed_flag (const char *name
, const_rtx r
, const char *file
,
831 int line
, const char *func
)
834 ("RTL flag check: %s used with unexpected rtx code '%s' in %s, at %s:%d",
835 name
, GET_RTX_NAME (GET_CODE (r
)), func
, trim_filename (file
), line
);
837 #endif /* ENABLE_RTL_FLAG_CHECKING */