Merge from mainline
[official-gcc.git] / gcc / rtl.c
blob7b6c0a1f9bddb6c19c601a73fa71755300974a4b
1 /* RTL utility routines.
2 Copyright (C) 1987, 1988, 1991, 1994, 1997, 1998, 1999, 2000, 2001, 2002
3 Free Software Foundation, Inc.
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
10 version.
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING. If not, write to the Free
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
20 02111-1307, USA. */
22 #include "config.h"
23 #include "system.h"
24 #include "rtl.h"
25 #include "real.h"
26 #include "ggc.h"
27 #include "errors.h"
30 /* Indexed by rtx code, gives number of operands for an rtx with that code.
31 Does NOT include rtx header data (code and links). */
33 #define DEF_RTL_EXPR(ENUM, NAME, FORMAT, CLASS) sizeof FORMAT - 1 ,
35 const unsigned char rtx_length[NUM_RTX_CODE] = {
36 #include "rtl.def"
39 #undef DEF_RTL_EXPR
41 /* Indexed by rtx code, gives the name of that kind of rtx, as a C string. */
43 #define DEF_RTL_EXPR(ENUM, NAME, FORMAT, CLASS) NAME ,
45 const char * const rtx_name[NUM_RTX_CODE] = {
46 #include "rtl.def" /* rtl expressions are documented here */
49 #undef DEF_RTL_EXPR
51 /* Indexed by machine mode, gives the name of that machine mode.
52 This name does not include the letters "mode". */
54 #define DEF_MACHMODE(SYM, NAME, CLASS, BITSIZE, SIZE, UNIT, WIDER, INNER) NAME,
56 const char * const mode_name[NUM_MACHINE_MODES] = {
57 #include "machmode.def"
60 #undef DEF_MACHMODE
62 /* Indexed by machine mode, gives the class mode for GET_MODE_CLASS. */
64 #define DEF_MACHMODE(SYM, NAME, CLASS, BITSIZE, SIZE, UNIT, WIDER, INNER) CLASS,
66 const enum mode_class mode_class[NUM_MACHINE_MODES] = {
67 #include "machmode.def"
70 #undef DEF_MACHMODE
72 /* Indexed by machine mode, gives the length of the mode, in bits.
73 GET_MODE_BITSIZE uses this. */
75 #define DEF_MACHMODE(SYM, NAME, CLASS, BITSIZE, SIZE, UNIT, WIDER, INNER) BITSIZE,
77 const unsigned short mode_bitsize[NUM_MACHINE_MODES] = {
78 #include "machmode.def"
81 #undef DEF_MACHMODE
83 /* Indexed by machine mode, gives the length of the mode, in bytes.
84 GET_MODE_SIZE uses this. */
86 #define DEF_MACHMODE(SYM, NAME, CLASS, BITSIZE, SIZE, UNIT, WIDER, INNER) SIZE,
88 const unsigned char mode_size[NUM_MACHINE_MODES] = {
89 #include "machmode.def"
92 #undef DEF_MACHMODE
94 /* Indexed by machine mode, gives the length of the mode's subunit.
95 GET_MODE_UNIT_SIZE uses this. */
97 #define DEF_MACHMODE(SYM, NAME, CLASS, BITSIZE, SIZE, UNIT, WIDER, INNER) UNIT,
99 const unsigned char mode_unit_size[NUM_MACHINE_MODES] = {
100 #include "machmode.def" /* machine modes are documented here */
103 #undef DEF_MACHMODE
105 /* Indexed by machine mode, gives next wider natural mode
106 (QI -> HI -> SI -> DI, etc.) Widening multiply instructions
107 use this. */
109 #define DEF_MACHMODE(SYM, NAME, CLASS, BITSIZE, SIZE, UNIT, WIDER, INNER) \
110 (unsigned char) WIDER,
112 const unsigned char mode_wider_mode[NUM_MACHINE_MODES] = {
113 #include "machmode.def" /* machine modes are documented here */
116 #undef DEF_MACHMODE
118 #define DEF_MACHMODE(SYM, NAME, CLASS, BITSIZE, SIZE, UNIT, WIDER, INNER) \
119 ((BITSIZE) >= HOST_BITS_PER_WIDE_INT) ? ~(unsigned HOST_WIDE_INT) 0 : ((unsigned HOST_WIDE_INT) 1 << (BITSIZE)) - 1,
121 /* Indexed by machine mode, gives mask of significant bits in mode. */
123 const unsigned HOST_WIDE_INT mode_mask_array[NUM_MACHINE_MODES] = {
124 #include "machmode.def"
127 #undef DEF_MACHMODE
129 #define DEF_MACHMODE(SYM, NAME, CLASS, BITSIZE, SIZE, UNIT, WIDER, INNER) INNER,
131 /* Indexed by machine mode, gives the mode of the inner elements in a
132 vector type. */
134 const enum machine_mode inner_mode_array[NUM_MACHINE_MODES] = {
135 #include "machmode.def"
138 /* Indexed by mode class, gives the narrowest mode for each class.
139 The Q modes are always of width 1 (2 for complex) - it is impossible
140 for any mode to be narrower.
142 Note that we use QImode instead of BImode for MODE_INT, since
143 otherwise the middle end will try to use it for bitfields in
144 structures and the like, which we do not want. Only the target
145 md file should generate BImode widgets. */
147 const enum machine_mode class_narrowest_mode[(int) MAX_MODE_CLASS] = {
148 /* MODE_RANDOM */ VOIDmode,
149 /* MODE_INT */ QImode,
150 /* MODE_FLOAT */ QFmode,
151 /* MODE_PARTIAL_INT */ PQImode,
152 /* MODE_CC */ CCmode,
153 /* MODE_COMPLEX_INT */ CQImode,
154 /* MODE_COMPLEX_FLOAT */ QCmode,
155 /* MODE_VECTOR_INT */ V2QImode,
156 /* MODE_VECTOR_FLOAT */ V2SFmode
160 /* Indexed by rtx code, gives a sequence of operand-types for
161 rtx's of that code. The sequence is a C string in which
162 each character describes one operand. */
164 const char * const rtx_format[NUM_RTX_CODE] = {
165 /* "*" undefined.
166 can cause a warning message
167 "0" field is unused (or used in a phase-dependent manner)
168 prints nothing
169 "i" an integer
170 prints the integer
171 "n" like "i", but prints entries from `note_insn_name'
172 "w" an integer of width HOST_BITS_PER_WIDE_INT
173 prints the integer
174 "s" a pointer to a string
175 prints the string
176 "S" like "s", but optional:
177 the containing rtx may end before this operand
178 "T" like "s", but treated specially by the RTL reader;
179 only found in machine description patterns.
180 "e" a pointer to an rtl expression
181 prints the expression
182 "E" a pointer to a vector that points to a number of rtl expressions
183 prints a list of the rtl expressions
184 "V" like "E", but optional:
185 the containing rtx may end before this operand
186 "u" a pointer to another insn
187 prints the uid of the insn.
188 "b" is a pointer to a bitmap header.
189 "t" is a tree pointer. */
191 #define DEF_RTL_EXPR(ENUM, NAME, FORMAT, CLASS) FORMAT ,
192 #include "rtl.def" /* rtl expressions are defined here */
193 #undef DEF_RTL_EXPR
196 /* Indexed by rtx code, gives a character representing the "class" of
197 that rtx code. See rtl.def for documentation on the defined classes. */
199 const char rtx_class[NUM_RTX_CODE] = {
200 #define DEF_RTL_EXPR(ENUM, NAME, FORMAT, CLASS) CLASS,
201 #include "rtl.def" /* rtl expressions are defined here */
202 #undef DEF_RTL_EXPR
205 /* Names for kinds of NOTEs and REG_NOTEs. */
207 const char * const note_insn_name[NOTE_INSN_MAX - NOTE_INSN_BIAS] =
209 "", "NOTE_INSN_DELETED",
210 "NOTE_INSN_BLOCK_BEG", "NOTE_INSN_BLOCK_END",
211 "NOTE_INSN_LOOP_BEG", "NOTE_INSN_LOOP_END",
212 "NOTE_INSN_LOOP_CONT", "NOTE_INSN_LOOP_VTOP",
213 "NOTE_INSN_LOOP_END_TOP_COND", "NOTE_INSN_FUNCTION_END",
214 "NOTE_INSN_PROLOGUE_END", "NOTE_INSN_EPILOGUE_BEG",
215 "NOTE_INSN_DELETED_LABEL", "NOTE_INSN_FUNCTION_BEG",
216 "NOTE_INSN_EH_REGION_BEG", "NOTE_INSN_EH_REGION_END",
217 "NOTE_INSN_REPEATED_LINE_NUMBER",
218 "NOTE_INSN_BASIC_BLOCK", "NOTE_INSN_EXPECTED_VALUE",
219 "NOTE_INSN_PREDICTION"
222 const char * const reg_note_name[] =
224 "", "REG_DEAD", "REG_INC", "REG_EQUIV", "REG_EQUAL",
225 "REG_WAS_0", "REG_RETVAL", "REG_LIBCALL", "REG_NONNEG",
226 "REG_NO_CONFLICT", "REG_UNUSED", "REG_CC_SETTER", "REG_CC_USER",
227 "REG_LABEL", "REG_DEP_ANTI", "REG_DEP_OUTPUT", "REG_BR_PROB",
228 "REG_EXEC_COUNT", "REG_NOALIAS", "REG_SAVE_AREA", "REG_BR_PRED",
229 "REG_FRAME_RELATED_EXPR", "REG_EH_CONTEXT", "REG_EH_REGION",
230 "REG_SAVE_NOTE", "REG_MAYBE_DEAD", "REG_NORETURN",
231 "REG_NON_LOCAL_GOTO", "REG_SETJMP", "REG_ALWAYS_RETURN",
232 "REG_VTABLE_REF"
236 /* Allocate an rtx vector of N elements.
237 Store the length, and initialize all elements to zero. */
239 rtvec
240 rtvec_alloc (n)
241 int n;
243 rtvec rt;
245 rt = ggc_alloc_rtvec (n);
246 /* clear out the vector */
247 memset (&rt->elem[0], 0, n * sizeof (rtx));
249 PUT_NUM_ELEM (rt, n);
250 return rt;
253 /* Allocate an rtx of code CODE. The CODE is stored in the rtx;
254 all the rest is initialized to zero. */
257 rtx_alloc (code)
258 RTX_CODE code;
260 rtx rt;
261 int n = GET_RTX_LENGTH (code);
263 rt = ggc_alloc_rtx (n);
265 /* We want to clear everything up to the FLD array. Normally, this
266 is one int, but we don't want to assume that and it isn't very
267 portable anyway; this is. */
269 memset (rt, 0, sizeof (struct rtx_def) - sizeof (rtunion));
270 PUT_CODE (rt, code);
271 return rt;
275 /* Create a new copy of an rtx.
276 Recursively copies the operands of the rtx,
277 except for those few rtx codes that are sharable. */
280 copy_rtx (orig)
281 rtx orig;
283 rtx copy;
284 int i, j;
285 RTX_CODE code;
286 const char *format_ptr;
288 code = GET_CODE (orig);
290 switch (code)
292 case REG:
293 case QUEUED:
294 case CONST_INT:
295 case CONST_DOUBLE:
296 case CONST_VECTOR:
297 case SYMBOL_REF:
298 case CODE_LABEL:
299 case PC:
300 case CC0:
301 case SCRATCH:
302 /* SCRATCH must be shared because they represent distinct values. */
303 case ADDRESSOF:
304 return orig;
306 case CONST:
307 /* CONST can be shared if it contains a SYMBOL_REF. If it contains
308 a LABEL_REF, it isn't sharable. */
309 if (GET_CODE (XEXP (orig, 0)) == PLUS
310 && GET_CODE (XEXP (XEXP (orig, 0), 0)) == SYMBOL_REF
311 && GET_CODE (XEXP (XEXP (orig, 0), 1)) == CONST_INT)
312 return orig;
313 break;
315 /* A MEM with a constant address is not sharable. The problem is that
316 the constant address may need to be reloaded. If the mem is shared,
317 then reloading one copy of this mem will cause all copies to appear
318 to have been reloaded. */
320 default:
321 break;
324 copy = rtx_alloc (code);
326 /* Copy the various flags, and other information. We assume that
327 all fields need copying, and then clear the fields that should
328 not be copied. That is the sensible default behavior, and forces
329 us to explicitly document why we are *not* copying a flag. */
330 memcpy (copy, orig, sizeof (struct rtx_def) - sizeof (rtunion));
332 /* We do not copy the USED flag, which is used as a mark bit during
333 walks over the RTL. */
334 RTX_FLAG (copy, used) = 0;
336 /* We do not copy FRAME_RELATED for INSNs. */
337 if (GET_RTX_CLASS (code) == 'i')
338 RTX_FLAG (copy, frame_related) = 0;
339 RTX_FLAG (copy, jump) = RTX_FLAG (orig, jump);
340 RTX_FLAG (copy, call) = RTX_FLAG (orig, call);
342 format_ptr = GET_RTX_FORMAT (GET_CODE (copy));
344 for (i = 0; i < GET_RTX_LENGTH (GET_CODE (copy)); i++)
346 copy->fld[i] = orig->fld[i];
347 switch (*format_ptr++)
349 case 'e':
350 if (XEXP (orig, i) != NULL)
351 XEXP (copy, i) = copy_rtx (XEXP (orig, i));
352 break;
354 case 'E':
355 case 'V':
356 if (XVEC (orig, i) != NULL)
358 XVEC (copy, i) = rtvec_alloc (XVECLEN (orig, i));
359 for (j = 0; j < XVECLEN (copy, i); j++)
360 XVECEXP (copy, i, j) = copy_rtx (XVECEXP (orig, i, j));
362 break;
364 case 't':
365 case 'w':
366 case 'i':
367 case 's':
368 case 'S':
369 case 'T':
370 case 'u':
371 case 'B':
372 case '0':
373 /* These are left unchanged. */
374 break;
376 default:
377 abort ();
380 return copy;
383 /* Create a new copy of an rtx. Only copy just one level. */
386 shallow_copy_rtx (orig)
387 rtx orig;
389 int i;
390 RTX_CODE code = GET_CODE (orig);
391 rtx copy = rtx_alloc (code);
393 PUT_MODE (copy, GET_MODE (orig));
394 RTX_FLAG (copy, in_struct) = RTX_FLAG (orig, in_struct);
395 RTX_FLAG (copy, volatil) = RTX_FLAG (orig, volatil);
396 RTX_FLAG (copy, unchanging) = RTX_FLAG (orig, unchanging);
397 RTX_FLAG (copy, integrated) = RTX_FLAG (orig, integrated);
398 RTX_FLAG (copy, frame_related) = RTX_FLAG (orig, frame_related);
400 for (i = 0; i < GET_RTX_LENGTH (code); i++)
401 copy->fld[i] = orig->fld[i];
403 return copy;
406 /* Return the alignment of MODE. This will be bounded by 1 and
407 BIGGEST_ALIGNMENT. */
409 unsigned int
410 get_mode_alignment (mode)
411 enum machine_mode mode;
413 unsigned int alignment;
415 if (GET_MODE_CLASS (mode) == MODE_COMPLEX_FLOAT
416 || GET_MODE_CLASS (mode) == MODE_COMPLEX_INT)
417 alignment = GET_MODE_UNIT_SIZE (mode);
418 else
419 alignment = GET_MODE_SIZE (mode);
421 /* Extract the LSB of the size. */
422 alignment = alignment & -alignment;
423 alignment *= BITS_PER_UNIT;
425 alignment = MIN (BIGGEST_ALIGNMENT, MAX (1, alignment));
426 return alignment;
429 /* This is 1 until after the rtl generation pass. */
430 int rtx_equal_function_value_matters;
432 /* Nonzero when we are generating CONCATs. */
433 int generating_concat_p;
435 /* Return 1 if X and Y are identical-looking rtx's.
436 This is the Lisp function EQUAL for rtx arguments. */
439 rtx_equal_p (x, y)
440 rtx x, y;
442 int i;
443 int j;
444 enum rtx_code code;
445 const char *fmt;
447 if (x == y)
448 return 1;
449 if (x == 0 || y == 0)
450 return 0;
452 code = GET_CODE (x);
453 /* Rtx's of different codes cannot be equal. */
454 if (code != GET_CODE (y))
455 return 0;
457 /* (MULT:SI x y) and (MULT:HI x y) are NOT equivalent.
458 (REG:SI x) and (REG:HI x) are NOT equivalent. */
460 if (GET_MODE (x) != GET_MODE (y))
461 return 0;
463 /* Some RTL can be compared nonrecursively. */
464 switch (code)
466 case REG:
467 /* Until rtl generation is complete, don't consider a reference
468 to the return register of the current function the same as
469 the return from a called function. This eases the job of
470 function integration. Once the distinction is no longer
471 needed, they can be considered equivalent. */
472 return (REGNO (x) == REGNO (y)
473 && (! rtx_equal_function_value_matters
474 || REG_FUNCTION_VALUE_P (x) == REG_FUNCTION_VALUE_P (y)));
476 case LABEL_REF:
477 return XEXP (x, 0) == XEXP (y, 0);
479 case SYMBOL_REF:
480 return XSTR (x, 0) == XSTR (y, 0);
482 case SCRATCH:
483 case CONST_DOUBLE:
484 case CONST_INT:
485 case CONST_VECTOR:
486 return 0;
488 default:
489 break;
492 /* Compare the elements. If any pair of corresponding elements
493 fail to match, return 0 for the whole things. */
495 fmt = GET_RTX_FORMAT (code);
496 for (i = GET_RTX_LENGTH (code) - 1; i >= 0; i--)
498 switch (fmt[i])
500 case 'w':
501 if (XWINT (x, i) != XWINT (y, i))
502 return 0;
503 break;
505 case 'n':
506 case 'i':
507 if (XINT (x, i) != XINT (y, i))
508 return 0;
509 break;
511 case 'V':
512 case 'E':
513 /* Two vectors must have the same length. */
514 if (XVECLEN (x, i) != XVECLEN (y, i))
515 return 0;
517 /* And the corresponding elements must match. */
518 for (j = 0; j < XVECLEN (x, i); j++)
519 if (rtx_equal_p (XVECEXP (x, i, j), XVECEXP (y, i, j)) == 0)
520 return 0;
521 break;
523 case 'e':
524 if (rtx_equal_p (XEXP (x, i), XEXP (y, i)) == 0)
525 return 0;
526 break;
528 case 'S':
529 case 's':
530 if ((XSTR (x, i) || XSTR (y, i))
531 && (! XSTR (x, i) || ! XSTR (y, i)
532 || strcmp (XSTR (x, i), XSTR (y, i))))
533 return 0;
534 break;
536 case 'u':
537 /* These are just backpointers, so they don't matter. */
538 break;
540 case '0':
541 case 't':
542 break;
544 /* It is believed that rtx's at this level will never
545 contain anything but integers and other rtx's,
546 except for within LABEL_REFs and SYMBOL_REFs. */
547 default:
548 abort ();
551 return 1;
554 #if defined ENABLE_RTL_CHECKING && (GCC_VERSION >= 2007)
555 void
556 rtl_check_failed_bounds (r, n, file, line, func)
557 rtx r;
558 int n;
559 const char *file;
560 int line;
561 const char *func;
563 internal_error
564 ("RTL check: access of elt %d of `%s' with last elt %d in %s, at %s:%d",
565 n, GET_RTX_NAME (GET_CODE (r)), GET_RTX_LENGTH (GET_CODE (r)) - 1,
566 func, trim_filename (file), line);
569 void
570 rtl_check_failed_type1 (r, n, c1, file, line, func)
571 rtx r;
572 int n;
573 int c1;
574 const char *file;
575 int line;
576 const char *func;
578 internal_error
579 ("RTL check: expected elt %d type '%c', have '%c' (rtx %s) in %s, at %s:%d",
580 n, c1, GET_RTX_FORMAT (GET_CODE (r))[n], GET_RTX_NAME (GET_CODE (r)),
581 func, trim_filename (file), line);
584 void
585 rtl_check_failed_type2 (r, n, c1, c2, file, line, func)
586 rtx r;
587 int n;
588 int c1;
589 int c2;
590 const char *file;
591 int line;
592 const char *func;
594 internal_error
595 ("RTL check: expected elt %d type '%c' or '%c', have '%c' (rtx %s) in %s, at %s:%d",
596 n, c1, c2, GET_RTX_FORMAT (GET_CODE (r))[n], GET_RTX_NAME (GET_CODE (r)),
597 func, trim_filename (file), line);
600 void
601 rtl_check_failed_code1 (r, code, file, line, func)
602 rtx r;
603 enum rtx_code code;
604 const char *file;
605 int line;
606 const char *func;
608 internal_error ("RTL check: expected code `%s', have `%s' in %s, at %s:%d",
609 GET_RTX_NAME (code), GET_RTX_NAME (GET_CODE (r)), func,
610 trim_filename (file), line);
613 void
614 rtl_check_failed_code2 (r, code1, code2, file, line, func)
615 rtx r;
616 enum rtx_code code1, code2;
617 const char *file;
618 int line;
619 const char *func;
621 internal_error
622 ("RTL check: expected code `%s' or `%s', have `%s' in %s, at %s:%d",
623 GET_RTX_NAME (code1), GET_RTX_NAME (code2), GET_RTX_NAME (GET_CODE (r)),
624 func, trim_filename (file), line);
627 /* XXX Maybe print the vector? */
628 void
629 rtvec_check_failed_bounds (r, n, file, line, func)
630 rtvec r;
631 int n;
632 const char *file;
633 int line;
634 const char *func;
636 internal_error
637 ("RTL check: access of elt %d of vector with last elt %d in %s, at %s:%d",
638 n, GET_NUM_ELEM (r) - 1, func, trim_filename (file), line);
640 #endif /* ENABLE_RTL_CHECKING */
642 #if defined ENABLE_RTL_FLAG_CHECKING
643 void
644 rtl_check_failed_flag (name, r, file, line, func)
645 const char *name;
646 rtx r;
647 const char *file;
648 int line;
649 const char *func;
651 internal_error
652 ("RTL flag check: %s used with unexpected rtx code `%s' in %s, at %s:%d",
653 name, GET_RTX_NAME (GET_CODE (r)), func, trim_filename (file), line);
655 #endif /* ENABLE_RTL_FLAG_CHECKING */