Merge from mainline
[official-gcc.git] / gcc / print-rtl.c
blob88de967a056418f009ed96cba253d9af54c93eef
1 /* Print RTL for GNU C Compiler.
2 Copyright (C) 1987, 1988, 1992, 1997, 1998, 1999, 2000
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. */
23 #include "config.h"
24 #include "system.h"
25 #include "rtl.h"
27 /* We don't want the tree code checking code for the access to the
28 DECL_NAME to be included in the gen* programs. */
29 #undef ENABLE_TREE_CHECKING
30 #include "tree.h"
31 #include "real.h"
32 #include "flags.h"
33 #include "hard-reg-set.h"
34 #include "basic-block.h"
36 /* How to print out a register name.
37 We don't use PRINT_REG because some definitions of PRINT_REG
38 don't work here. */
39 #ifndef DEBUG_PRINT_REG
40 #define DEBUG_PRINT_REG(RTX, CODE, FILE) \
41 fprintf ((FILE), "%d %s", REGNO (RTX), reg_names[REGNO (RTX)])
42 #endif
44 /* Array containing all of the register names */
46 #ifdef DEBUG_REGISTER_NAMES
47 static const char * const debug_reg_names[] = DEBUG_REGISTER_NAMES;
48 #define reg_names debug_reg_names
49 #else
50 const char * reg_names[] = REGISTER_NAMES;
51 #endif
53 static FILE *outfile;
55 static int sawclose = 0;
57 static int indent;
59 static void print_rtx PARAMS ((rtx));
61 /* String printed at beginning of each RTL when it is dumped.
62 This string is set to ASM_COMMENT_START when the RTL is dumped in
63 the assembly output file. */
64 const char *print_rtx_head = "";
66 /* Nonzero means suppress output of instruction numbers and line number
67 notes in debugging dumps.
68 This must be defined here so that programs like gencodes can be linked. */
69 int flag_dump_unnumbered = 0;
71 /* Nonzero means use simplified format without flags, modes, etc. */
72 int flag_simple = 0;
74 /* Nonzero if we are dumping graphical description. */
75 int dump_for_graph;
77 /* Nonzero to dump all call_placeholder alternatives. */
78 static int debug_call_placeholder_verbose;
80 void
81 print_mem_expr (outfile, expr)
82 FILE *outfile;
83 tree expr;
85 if (TREE_CODE (expr) == COMPONENT_REF)
87 if (TREE_OPERAND (expr, 0))
88 print_mem_expr (outfile, TREE_OPERAND (expr, 0));
89 else
90 fputs (" <variable>", outfile);
91 if (DECL_NAME (TREE_OPERAND (expr, 1)))
92 fprintf (outfile, ".%s",
93 IDENTIFIER_POINTER (DECL_NAME (TREE_OPERAND (expr, 1))));
95 else if (DECL_NAME (expr))
96 fprintf (outfile, " %s", IDENTIFIER_POINTER (DECL_NAME (expr)));
97 else if (TREE_CODE (expr) == RESULT_DECL)
98 fputs (" <result>", outfile);
99 else
100 fputs (" <anonymous>", outfile);
103 /* Print IN_RTX onto OUTFILE. This is the recursive part of printing. */
105 static void
106 print_rtx (in_rtx)
107 rtx in_rtx;
109 int i = 0;
110 int j;
111 const char *format_ptr;
112 int is_insn;
113 rtx tem;
115 if (sawclose)
117 if (flag_simple)
118 fputc (' ', outfile);
119 else
120 fprintf (outfile, "\n%s%*s", print_rtx_head, indent * 2, "");
121 sawclose = 0;
124 if (in_rtx == 0)
126 fputs ("(nil)", outfile);
127 sawclose = 1;
128 return;
130 else if (GET_CODE (in_rtx) > NUM_RTX_CODE)
132 fprintf (outfile, "(??? bad code %d\n)", GET_CODE (in_rtx));
133 sawclose = 1;
134 return;
137 is_insn = INSN_P (in_rtx);
139 /* When printing in VCG format we write INSNs, NOTE, LABEL, and BARRIER
140 in separate nodes and therefore have to handle them special here. */
141 if (dump_for_graph
142 && (is_insn || GET_CODE (in_rtx) == NOTE
143 || GET_CODE (in_rtx) == CODE_LABEL || GET_CODE (in_rtx) == BARRIER))
145 i = 3;
146 indent = 0;
148 else
150 /* Print name of expression code. */
151 if (flag_simple && GET_CODE (in_rtx) == CONST_INT)
152 fputc ('(', outfile);
153 else
154 fprintf (outfile, "(%s", GET_RTX_NAME (GET_CODE (in_rtx)));
156 if (! flag_simple)
158 if (RTX_FLAG (in_rtx, in_struct))
159 fputs ("/s", outfile);
161 if (RTX_FLAG (in_rtx, volatil))
162 fputs ("/v", outfile);
164 if (RTX_FLAG (in_rtx, unchanging))
165 fputs ("/u", outfile);
167 if (RTX_FLAG (in_rtx, integrated))
168 fputs ("/i", outfile);
170 if (RTX_FLAG (in_rtx, frame_related))
171 fputs ("/f", outfile);
173 if (RTX_FLAG (in_rtx, jump))
174 fputs ("/j", outfile);
176 if (RTX_FLAG (in_rtx, call))
177 fputs ("/c", outfile);
179 if (GET_MODE (in_rtx) != VOIDmode)
181 /* Print REG_NOTE names for EXPR_LIST and INSN_LIST. */
182 if (GET_CODE (in_rtx) == EXPR_LIST
183 || GET_CODE (in_rtx) == INSN_LIST)
184 fprintf (outfile, ":%s",
185 GET_REG_NOTE_NAME (GET_MODE (in_rtx)));
186 else
187 fprintf (outfile, ":%s", GET_MODE_NAME (GET_MODE (in_rtx)));
192 /* Get the format string and skip the first elements if we have handled
193 them already. */
194 format_ptr = GET_RTX_FORMAT (GET_CODE (in_rtx)) + i;
195 for (; i < GET_RTX_LENGTH (GET_CODE (in_rtx)); i++)
196 switch (*format_ptr++)
198 const char *str;
200 case 'T':
201 str = XTMPL (in_rtx, i);
202 goto string;
204 case 'S':
205 case 's':
206 str = XSTR (in_rtx, i);
207 string:
209 if (str == 0)
210 fputs (dump_for_graph ? " \\\"\\\"" : " \"\"", outfile);
211 else
213 if (dump_for_graph)
214 fprintf (outfile, " (\\\"%s\\\")", str);
215 else
216 fprintf (outfile, " (\"%s\")", str);
218 sawclose = 1;
219 break;
221 /* 0 indicates a field for internal use that should not be printed.
222 An exception is the third field of a NOTE, where it indicates
223 that the field has several different valid contents. */
224 case '0':
225 if (i == 1 && GET_CODE (in_rtx) == REG)
227 if (REGNO (in_rtx) != ORIGINAL_REGNO (in_rtx))
228 fprintf (outfile, " [%d]", ORIGINAL_REGNO (in_rtx));
229 break;
231 if (i == 3 && GET_CODE (in_rtx) == NOTE)
233 switch (NOTE_LINE_NUMBER (in_rtx))
235 case NOTE_INSN_EH_REGION_BEG:
236 case NOTE_INSN_EH_REGION_END:
237 if (flag_dump_unnumbered)
238 fprintf (outfile, " #");
239 else
240 fprintf (outfile, " %d", NOTE_EH_HANDLER (in_rtx));
241 sawclose = 1;
242 break;
244 case NOTE_INSN_BLOCK_BEG:
245 case NOTE_INSN_BLOCK_END:
246 fprintf (outfile, " ");
247 if (flag_dump_unnumbered)
248 fprintf (outfile, "#");
249 else
250 fprintf (outfile, HOST_PTR_PRINTF,
251 (char *) NOTE_BLOCK (in_rtx));
252 sawclose = 1;
253 break;
255 case NOTE_INSN_BASIC_BLOCK:
257 basic_block bb = NOTE_BASIC_BLOCK (in_rtx);
258 if (bb != 0)
259 fprintf (outfile, " [bb %d]", bb->index);
260 break;
263 case NOTE_INSN_EXPECTED_VALUE:
264 indent += 2;
265 if (!sawclose)
266 fprintf (outfile, " ");
267 print_rtx (NOTE_EXPECTED_VALUE (in_rtx));
268 indent -= 2;
269 break;
271 case NOTE_INSN_DELETED_LABEL:
272 if (NOTE_SOURCE_FILE (in_rtx))
273 fprintf (outfile, " (\"%s\")", NOTE_SOURCE_FILE (in_rtx));
274 else
275 fprintf (outfile, " \"\"");
276 break;
278 case NOTE_INSN_PREDICTION:
279 if (NOTE_PREDICTION (in_rtx))
280 fprintf (outfile, " [ %d %d ] ",
281 (int)NOTE_PREDICTION_ALG (in_rtx),
282 (int) NOTE_PREDICTION_FLAGS (in_rtx));
283 else
284 fprintf (outfile, " [ ERROR ]");
285 break;
287 default:
289 const char * const str = X0STR (in_rtx, i);
291 if (NOTE_LINE_NUMBER (in_rtx) < 0)
293 else if (str == 0)
294 fputs (dump_for_graph ? " \\\"\\\"" : " \"\"", outfile);
295 else
297 if (dump_for_graph)
298 fprintf (outfile, " (\\\"%s\\\")", str);
299 else
300 fprintf (outfile, " (\"%s\")", str);
302 break;
306 break;
308 case 'e':
309 do_e:
310 indent += 2;
311 if (!sawclose)
312 fprintf (outfile, " ");
313 print_rtx (XEXP (in_rtx, i));
314 indent -= 2;
315 break;
317 case 'E':
318 case 'V':
319 indent += 2;
320 if (sawclose)
322 fprintf (outfile, "\n%s%*s",
323 print_rtx_head, indent * 2, "");
324 sawclose = 0;
326 fputs (" [", outfile);
327 if (NULL != XVEC (in_rtx, i))
329 indent += 2;
330 if (XVECLEN (in_rtx, i))
331 sawclose = 1;
333 for (j = 0; j < XVECLEN (in_rtx, i); j++)
334 print_rtx (XVECEXP (in_rtx, i, j));
336 indent -= 2;
338 if (sawclose)
339 fprintf (outfile, "\n%s%*s", print_rtx_head, indent * 2, "");
341 fputs ("]", outfile);
342 sawclose = 1;
343 indent -= 2;
344 break;
346 case 'w':
347 if (! flag_simple)
348 fprintf (outfile, " ");
349 fprintf (outfile, HOST_WIDE_INT_PRINT_DEC, XWINT (in_rtx, i));
350 if (! flag_simple)
352 fprintf (outfile, " [");
353 fprintf (outfile, HOST_WIDE_INT_PRINT_HEX, XWINT (in_rtx, i));
354 fprintf (outfile, "]");
356 break;
358 case 'i':
359 if (i == 5 && GET_CODE (in_rtx) == NOTE)
361 /* This field is only used for NOTE_INSN_DELETED_LABEL, and
362 other times often contains garbage from INSN->NOTE death. */
363 if (NOTE_LINE_NUMBER (in_rtx) == NOTE_INSN_DELETED_LABEL)
364 fprintf (outfile, " %d", XINT (in_rtx, i));
366 else
368 int value = XINT (in_rtx, i);
369 const char *name;
371 if (GET_CODE (in_rtx) == REG && value < FIRST_PSEUDO_REGISTER)
373 fputc (' ', outfile);
374 DEBUG_PRINT_REG (in_rtx, 0, outfile);
376 else if (GET_CODE (in_rtx) == REG
377 && value <= LAST_VIRTUAL_REGISTER)
379 if (value == VIRTUAL_INCOMING_ARGS_REGNUM)
380 fprintf (outfile, " %d virtual-incoming-args", value);
381 else if (value == VIRTUAL_STACK_VARS_REGNUM)
382 fprintf (outfile, " %d virtual-stack-vars", value);
383 else if (value == VIRTUAL_STACK_DYNAMIC_REGNUM)
384 fprintf (outfile, " %d virtual-stack-dynamic", value);
385 else if (value == VIRTUAL_OUTGOING_ARGS_REGNUM)
386 fprintf (outfile, " %d virtual-outgoing-args", value);
387 else if (value == VIRTUAL_CFA_REGNUM)
388 fprintf (outfile, " %d virtual-cfa", value);
389 else
390 fprintf (outfile, " %d virtual-reg-%d", value,
391 value-FIRST_VIRTUAL_REGISTER);
393 else if (flag_dump_unnumbered
394 && (is_insn || GET_CODE (in_rtx) == NOTE))
395 fputc ('#', outfile);
396 else
397 fprintf (outfile, " %d", value);
399 if (is_insn && &INSN_CODE (in_rtx) == &XINT (in_rtx, i)
400 && XINT (in_rtx, i) >= 0
401 && (name = get_insn_name (XINT (in_rtx, i))) != NULL)
402 fprintf (outfile, " {%s}", name);
403 sawclose = 0;
405 break;
407 /* Print NOTE_INSN names rather than integer codes. */
409 case 'n':
410 if (XINT (in_rtx, i) >= (int) NOTE_INSN_BIAS
411 && XINT (in_rtx, i) < (int) NOTE_INSN_MAX)
412 fprintf (outfile, " %s", GET_NOTE_INSN_NAME (XINT (in_rtx, i)));
413 else
414 fprintf (outfile, " %d", XINT (in_rtx, i));
415 sawclose = 0;
416 break;
418 case 'u':
419 if (XEXP (in_rtx, i) != NULL)
421 rtx sub = XEXP (in_rtx, i);
422 enum rtx_code subc = GET_CODE (sub);
424 if (GET_CODE (in_rtx) == LABEL_REF)
426 if (subc == NOTE
427 && NOTE_LINE_NUMBER (sub) == NOTE_INSN_DELETED_LABEL)
429 if (flag_dump_unnumbered)
430 fprintf (outfile, " [# deleted]");
431 else
432 fprintf (outfile, " [%d deleted]", INSN_UID (sub));
433 sawclose = 0;
434 break;
437 if (subc != CODE_LABEL)
438 goto do_e;
441 if (flag_dump_unnumbered)
442 fputs (" #", outfile);
443 else
444 fprintf (outfile, " %d", INSN_UID (sub));
446 else
447 fputs (" 0", outfile);
448 sawclose = 0;
449 break;
451 case 'b':
452 if (XBITMAP (in_rtx, i) == NULL)
453 fputs (" {null}", outfile);
454 else
455 bitmap_print (outfile, XBITMAP (in_rtx, i), " {", "}");
456 sawclose = 0;
457 break;
459 case 't':
460 putc (' ', outfile);
461 fprintf (outfile, HOST_PTR_PRINTF, (char *) XTREE (in_rtx, i));
462 break;
464 case '*':
465 fputs (" Unknown", outfile);
466 sawclose = 0;
467 break;
469 case 'B':
470 if (XBBDEF (in_rtx, i))
471 fprintf (outfile, " %i", XBBDEF (in_rtx, i)->index);
472 break;
474 default:
475 fprintf (stderr,
476 "switch format wrong in rtl.print_rtx(). format was: %c.\n",
477 format_ptr[-1]);
478 abort ();
481 switch (GET_CODE (in_rtx))
483 case MEM:
484 fputs (" [", outfile);
485 fprintf (outfile, HOST_WIDE_INT_PRINT_DEC, MEM_ALIAS_SET (in_rtx));
487 if (MEM_EXPR (in_rtx))
488 print_mem_expr (outfile, MEM_EXPR (in_rtx));
490 if (MEM_OFFSET (in_rtx))
492 fputc ('+', outfile);
493 fprintf (outfile, HOST_WIDE_INT_PRINT_DEC,
494 INTVAL (MEM_OFFSET (in_rtx)));
497 if (MEM_SIZE (in_rtx))
499 fputs (" S", outfile);
500 fprintf (outfile, HOST_WIDE_INT_PRINT_DEC,
501 INTVAL (MEM_SIZE (in_rtx)));
504 if (MEM_ALIGN (in_rtx) != 1)
505 fprintf (outfile, " A%u", MEM_ALIGN (in_rtx));
507 fputc (']', outfile);
508 break;
510 #if 0
511 /* It would be nice to do this, but it would require real.o to
512 be linked into the MD-generator programs. Maybe we should
513 do that. -zw 2002-03-03 */
514 case CONST_DOUBLE:
515 if (FLOAT_MODE_P (GET_MODE (in_rtx)))
517 REAL_VALUE_TYPE val;
518 char s[30];
520 REAL_VALUE_FROM_CONST_DOUBLE (val, in_rtx);
521 REAL_VALUE_TO_DECIMAL (val, "%.16g", s);
522 fprintf (outfile, " [%s]", s);
524 break;
525 #endif
527 case CODE_LABEL:
528 fprintf (outfile, " [%d uses]", LABEL_NUSES (in_rtx));
529 if (LABEL_ALTERNATE_NAME (in_rtx))
530 fprintf (outfile, " [alternate name: %s]",
531 LABEL_ALTERNATE_NAME (in_rtx));
532 break;
534 case CALL_PLACEHOLDER:
535 if (debug_call_placeholder_verbose)
537 fputs (" (cond [\n (const_string \"normal\") (sequence [", outfile);
538 for (tem = XEXP (in_rtx, 0); tem != 0; tem = NEXT_INSN (tem))
540 fputs ("\n ", outfile);
541 print_inline_rtx (outfile, tem, 4);
544 tem = XEXP (in_rtx, 1);
545 if (tem)
546 fputs ("\n ])\n (const_string \"tail_call\") (sequence [",
547 outfile);
548 for (; tem != 0; tem = NEXT_INSN (tem))
550 fputs ("\n ", outfile);
551 print_inline_rtx (outfile, tem, 4);
554 tem = XEXP (in_rtx, 2);
555 if (tem)
556 fputs ("\n ])\n (const_string \"tail_recursion\") (sequence [",
557 outfile);
558 for (; tem != 0; tem = NEXT_INSN (tem))
560 fputs ("\n ", outfile);
561 print_inline_rtx (outfile, tem, 4);
564 fputs ("\n ])\n ])", outfile);
565 break;
568 for (tem = XEXP (in_rtx, 0); tem != 0; tem = NEXT_INSN (tem))
569 if (GET_CODE (tem) == CALL_INSN)
571 fprintf (outfile, " ");
572 print_rtx (tem);
573 break;
575 break;
577 default:
578 break;
581 if (dump_for_graph
582 && (is_insn || GET_CODE (in_rtx) == NOTE
583 || GET_CODE (in_rtx) == CODE_LABEL || GET_CODE (in_rtx) == BARRIER))
584 sawclose = 0;
585 else
587 fputc (')', outfile);
588 sawclose = 1;
592 /* Print an rtx on the current line of FILE. Initially indent IND
593 characters. */
595 void
596 print_inline_rtx (outf, x, ind)
597 FILE *outf;
598 rtx x;
599 int ind;
601 int oldsaw = sawclose;
602 int oldindent = indent;
604 sawclose = 0;
605 indent = ind;
606 outfile = outf;
607 print_rtx (x);
608 sawclose = oldsaw;
609 indent = oldindent;
612 /* Call this function from the debugger to see what X looks like. */
614 void
615 debug_rtx (x)
616 rtx x;
618 outfile = stderr;
619 sawclose = 0;
620 print_rtx (x);
621 fprintf (stderr, "\n");
624 /* Count of rtx's to print with debug_rtx_list.
625 This global exists because gdb user defined commands have no arguments. */
627 int debug_rtx_count = 0; /* 0 is treated as equivalent to 1 */
629 /* Call this function to print list from X on.
631 N is a count of the rtx's to print. Positive values print from the specified
632 rtx on. Negative values print a window around the rtx.
633 EG: -5 prints 2 rtx's on either side (in addition to the specified rtx). */
635 void
636 debug_rtx_list (x, n)
637 rtx x;
638 int n;
640 int i,count;
641 rtx insn;
643 count = n == 0 ? 1 : n < 0 ? -n : n;
645 /* If we are printing a window, back up to the start. */
647 if (n < 0)
648 for (i = count / 2; i > 0; i--)
650 if (PREV_INSN (x) == 0)
651 break;
652 x = PREV_INSN (x);
655 for (i = count, insn = x; i > 0 && insn != 0; i--, insn = NEXT_INSN (insn))
657 debug_rtx (insn);
658 fprintf (stderr, "\n");
662 /* Call this function to print an rtx list from START to END inclusive. */
664 void
665 debug_rtx_range (start, end)
666 rtx start, end;
668 while (1)
670 debug_rtx (start);
671 fprintf (stderr, "\n");
672 if (!start || start == end)
673 break;
674 start = NEXT_INSN (start);
678 /* Call this function to search an rtx list to find one with insn uid UID,
679 and then call debug_rtx_list to print it, using DEBUG_RTX_COUNT.
680 The found insn is returned to enable further debugging analysis. */
683 debug_rtx_find (x, uid)
684 rtx x;
685 int uid;
687 while (x != 0 && INSN_UID (x) != uid)
688 x = NEXT_INSN (x);
689 if (x != 0)
691 debug_rtx_list (x, debug_rtx_count);
692 return x;
694 else
696 fprintf (stderr, "insn uid %d not found\n", uid);
697 return 0;
701 /* External entry point for printing a chain of insns
702 starting with RTX_FIRST onto file OUTF.
703 A blank line separates insns.
705 If RTX_FIRST is not an insn, then it alone is printed, with no newline. */
707 void
708 print_rtl (outf, rtx_first)
709 FILE *outf;
710 rtx rtx_first;
712 rtx tmp_rtx;
714 outfile = outf;
715 sawclose = 0;
717 if (rtx_first == 0)
719 fputs (print_rtx_head, outf);
720 fputs ("(nil)\n", outf);
722 else
723 switch (GET_CODE (rtx_first))
725 case INSN:
726 case JUMP_INSN:
727 case CALL_INSN:
728 case NOTE:
729 case CODE_LABEL:
730 case BARRIER:
731 for (tmp_rtx = rtx_first; tmp_rtx != 0; tmp_rtx = NEXT_INSN (tmp_rtx))
732 if (! flag_dump_unnumbered
733 || GET_CODE (tmp_rtx) != NOTE || NOTE_LINE_NUMBER (tmp_rtx) < 0)
735 fputs (print_rtx_head, outfile);
736 print_rtx (tmp_rtx);
737 fprintf (outfile, "\n");
739 break;
741 default:
742 fputs (print_rtx_head, outfile);
743 print_rtx (rtx_first);
747 /* Like print_rtx, except specify a file. */
748 /* Return nonzero if we actually printed anything. */
751 print_rtl_single (outf, x)
752 FILE *outf;
753 rtx x;
755 outfile = outf;
756 sawclose = 0;
757 if (! flag_dump_unnumbered
758 || GET_CODE (x) != NOTE || NOTE_LINE_NUMBER (x) < 0)
760 fputs (print_rtx_head, outfile);
761 print_rtx (x);
762 putc ('\n', outf);
763 return 1;
765 return 0;
769 /* Like print_rtl except without all the detail; for example,
770 if RTX is a CONST_INT then print in decimal format. */
772 void
773 print_simple_rtl (outf, x)
774 FILE *outf;
775 rtx x;
777 flag_simple = 1;
778 print_rtl (outf, x);
779 flag_simple = 0;