2007-12-17 Vladimir Makarov <vmakarov@redhat.com>
[official-gcc.git] / gcc / print-rtl.c
blob1485d0f6853cd94bba359d311ed6e58d00dd2a9d
1 /* Print RTL for GCC.
2 Copyright (C) 1987, 1988, 1992, 1997, 1998, 1999, 2000, 2002, 2003,
3 2004, 2005, 2007
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
11 version.
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
16 for more details.
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. */
24 #ifdef GENERATOR_FILE
25 #include "bconfig.h"
26 #else
27 #include "config.h"
28 #endif
30 #include "system.h"
31 #include "coretypes.h"
32 #include "tm.h"
33 #include "rtl.h"
35 /* These headers all define things which are not available in
36 generator programs. */
37 #ifndef GENERATOR_FILE
38 #include "tree.h"
39 #include "real.h"
40 #include "flags.h"
41 #include "hard-reg-set.h"
42 #include "basic-block.h"
43 #endif
45 static FILE *outfile;
47 static int sawclose = 0;
49 static int indent;
51 static void print_rtx (const_rtx);
53 /* String printed at beginning of each RTL when it is dumped.
54 This string is set to ASM_COMMENT_START when the RTL is dumped in
55 the assembly output file. */
56 const char *print_rtx_head = "";
58 /* Nonzero means suppress output of instruction numbers
59 in debugging dumps.
60 This must be defined here so that programs like gencodes can be linked. */
61 int flag_dump_unnumbered = 0;
63 #ifdef GENERATOR_FILE
64 /* Nonzero means use simplified format without flags, modes, etc. */
65 int flag_dump_simple_rtl = 0;
66 #endif
68 /* Nonzero if we are dumping graphical description. */
69 int dump_for_graph;
71 #ifndef GENERATOR_FILE
72 static void
73 print_decl_name (FILE *outfile, const_tree node)
75 if (DECL_NAME (node))
76 fputs (IDENTIFIER_POINTER (DECL_NAME (node)), outfile);
77 else
79 if (TREE_CODE (node) == LABEL_DECL && LABEL_DECL_UID (node) != -1)
80 fprintf (outfile, "L." HOST_WIDE_INT_PRINT_DEC, LABEL_DECL_UID (node));
81 else
83 char c = TREE_CODE (node) == CONST_DECL ? 'C' : 'D';
84 fprintf (outfile, "%c.%u", c, DECL_UID (node));
89 void
90 print_mem_expr (FILE *outfile, const_tree expr)
92 if (TREE_CODE (expr) == COMPONENT_REF)
94 if (TREE_OPERAND (expr, 0))
95 print_mem_expr (outfile, TREE_OPERAND (expr, 0));
96 else
97 fputs (" <variable>", outfile);
98 fputc ('.', outfile);
99 print_decl_name (outfile, TREE_OPERAND (expr, 1));
101 else if (TREE_CODE (expr) == INDIRECT_REF)
103 fputs (" (*", outfile);
104 print_mem_expr (outfile, TREE_OPERAND (expr, 0));
105 fputs (")", outfile);
107 else if (TREE_CODE (expr) == ALIGN_INDIRECT_REF)
109 fputs (" (A*", outfile);
110 print_mem_expr (outfile, TREE_OPERAND (expr, 0));
111 fputs (")", outfile);
113 else if (TREE_CODE (expr) == MISALIGNED_INDIRECT_REF)
115 fputs (" (M*", outfile);
116 print_mem_expr (outfile, TREE_OPERAND (expr, 0));
117 fputs (")", outfile);
119 else if (TREE_CODE (expr) == RESULT_DECL)
120 fputs (" <result>", outfile);
121 else
123 fputc (' ', outfile);
124 print_decl_name (outfile, expr);
127 #endif
129 /* Print IN_RTX onto OUTFILE. This is the recursive part of printing. */
131 static void
132 print_rtx (const_rtx in_rtx)
134 int i = 0;
135 int j;
136 const char *format_ptr;
137 int is_insn;
139 if (sawclose)
141 if (flag_dump_simple_rtl)
142 fputc (' ', outfile);
143 else
144 fprintf (outfile, "\n%s%*s", print_rtx_head, indent * 2, "");
145 sawclose = 0;
148 if (in_rtx == 0)
150 fputs ("(nil)", outfile);
151 sawclose = 1;
152 return;
154 else if (GET_CODE (in_rtx) > NUM_RTX_CODE)
156 fprintf (outfile, "(??? bad code %d\n)", GET_CODE (in_rtx));
157 sawclose = 1;
158 return;
161 is_insn = INSN_P (in_rtx);
163 /* When printing in VCG format we write INSNs, NOTE, LABEL, and BARRIER
164 in separate nodes and therefore have to handle them special here. */
165 if (dump_for_graph
166 && (is_insn || NOTE_P (in_rtx)
167 || LABEL_P (in_rtx) || BARRIER_P (in_rtx)))
169 i = 3;
170 indent = 0;
172 else
174 /* Print name of expression code. */
175 if (flag_dump_simple_rtl && GET_CODE (in_rtx) == CONST_INT)
176 fputc ('(', outfile);
177 else
178 fprintf (outfile, "(%s", GET_RTX_NAME (GET_CODE (in_rtx)));
180 if (! flag_dump_simple_rtl)
182 if (RTX_FLAG (in_rtx, in_struct))
183 fputs ("/s", outfile);
185 if (RTX_FLAG (in_rtx, volatil))
186 fputs ("/v", outfile);
188 if (RTX_FLAG (in_rtx, unchanging))
189 fputs ("/u", outfile);
191 if (RTX_FLAG (in_rtx, frame_related))
192 fputs ("/f", outfile);
194 if (RTX_FLAG (in_rtx, jump))
195 fputs ("/j", outfile);
197 if (RTX_FLAG (in_rtx, call))
198 fputs ("/c", outfile);
200 if (RTX_FLAG (in_rtx, return_val))
201 fputs ("/i", outfile);
203 /* Print REG_NOTE names for EXPR_LIST and INSN_LIST. */
204 if (GET_CODE (in_rtx) == EXPR_LIST
205 || GET_CODE (in_rtx) == INSN_LIST)
206 fprintf (outfile, ":%s",
207 GET_REG_NOTE_NAME (GET_MODE (in_rtx)));
209 /* For other rtl, print the mode if it's not VOID. */
210 else if (GET_MODE (in_rtx) != VOIDmode)
211 fprintf (outfile, ":%s", GET_MODE_NAME (GET_MODE (in_rtx)));
215 #ifndef GENERATOR_FILE
216 if (GET_CODE (in_rtx) == CONST_DOUBLE && FLOAT_MODE_P (GET_MODE (in_rtx)))
217 i = 5;
218 #endif
220 /* Get the format string and skip the first elements if we have handled
221 them already. */
222 format_ptr = GET_RTX_FORMAT (GET_CODE (in_rtx)) + i;
223 for (; i < GET_RTX_LENGTH (GET_CODE (in_rtx)); i++)
224 switch (*format_ptr++)
226 const char *str;
228 case 'T':
229 str = XTMPL (in_rtx, i);
230 goto string;
232 case 'S':
233 case 's':
234 str = XSTR (in_rtx, i);
235 string:
237 if (str == 0)
238 fputs (dump_for_graph ? " \\\"\\\"" : " \"\"", outfile);
239 else
241 if (dump_for_graph)
242 fprintf (outfile, " (\\\"%s\\\")", str);
243 else
244 fprintf (outfile, " (\"%s\")", str);
246 sawclose = 1;
247 break;
249 /* 0 indicates a field for internal use that should not be printed.
250 An exception is the third field of a NOTE, where it indicates
251 that the field has several different valid contents. */
252 case '0':
253 if (i == 1 && REG_P (in_rtx))
255 if (REGNO (in_rtx) != ORIGINAL_REGNO (in_rtx))
256 fprintf (outfile, " [%d]", ORIGINAL_REGNO (in_rtx));
258 #ifndef GENERATOR_FILE
259 else if (i == 1 && GET_CODE (in_rtx) == SYMBOL_REF)
261 int flags = SYMBOL_REF_FLAGS (in_rtx);
262 if (flags)
263 fprintf (outfile, " [flags 0x%x]", flags);
265 else if (i == 2 && GET_CODE (in_rtx) == SYMBOL_REF)
267 tree decl = SYMBOL_REF_DECL (in_rtx);
268 if (decl)
269 print_node_brief (outfile, "", decl, 0);
271 #endif
272 else if (i == 4 && NOTE_P (in_rtx))
274 switch (NOTE_KIND (in_rtx))
276 case NOTE_INSN_EH_REGION_BEG:
277 case NOTE_INSN_EH_REGION_END:
278 if (flag_dump_unnumbered)
279 fprintf (outfile, " #");
280 else
281 fprintf (outfile, " %d", NOTE_EH_HANDLER (in_rtx));
282 sawclose = 1;
283 break;
285 case NOTE_INSN_BLOCK_BEG:
286 case NOTE_INSN_BLOCK_END:
287 #ifndef GENERATOR_FILE
288 dump_addr (outfile, " ", NOTE_BLOCK (in_rtx));
289 #endif
290 sawclose = 1;
291 break;
293 case NOTE_INSN_BASIC_BLOCK:
295 #ifndef GENERATOR_FILE
296 basic_block bb = NOTE_BASIC_BLOCK (in_rtx);
297 if (bb != 0)
298 fprintf (outfile, " [bb %d]", bb->index);
299 #endif
300 break;
303 case NOTE_INSN_DELETED_LABEL:
305 const char *label = NOTE_DELETED_LABEL_NAME (in_rtx);
306 if (label)
307 fprintf (outfile, " (\"%s\")", label);
308 else
309 fprintf (outfile, " \"\"");
311 break;
313 case NOTE_INSN_SWITCH_TEXT_SECTIONS:
315 #ifndef GENERATOR_FILE
316 basic_block bb = NOTE_BASIC_BLOCK (in_rtx);
317 if (bb != 0)
318 fprintf (outfile, " [bb %d]", bb->index);
319 #endif
320 break;
323 case NOTE_INSN_VAR_LOCATION:
324 #ifndef GENERATOR_FILE
325 fprintf (outfile, " (");
326 print_mem_expr (outfile, NOTE_VAR_LOCATION_DECL (in_rtx));
327 fprintf (outfile, " ");
328 print_rtx (NOTE_VAR_LOCATION_LOC (in_rtx));
329 if (NOTE_VAR_LOCATION_STATUS (in_rtx) ==
330 VAR_INIT_STATUS_UNINITIALIZED)
331 fprintf (outfile, " [uninit]");
332 fprintf (outfile, ")");
333 #endif
334 break;
336 default:
337 break;
340 break;
342 case 'e':
343 do_e:
344 indent += 2;
345 if (!sawclose)
346 fprintf (outfile, " ");
347 print_rtx (XEXP (in_rtx, i));
348 indent -= 2;
349 break;
351 case 'E':
352 case 'V':
353 indent += 2;
354 if (sawclose)
356 fprintf (outfile, "\n%s%*s",
357 print_rtx_head, indent * 2, "");
358 sawclose = 0;
360 fputs (" [", outfile);
361 if (NULL != XVEC (in_rtx, i))
363 indent += 2;
364 if (XVECLEN (in_rtx, i))
365 sawclose = 1;
367 for (j = 0; j < XVECLEN (in_rtx, i); j++)
368 print_rtx (XVECEXP (in_rtx, i, j));
370 indent -= 2;
372 if (sawclose)
373 fprintf (outfile, "\n%s%*s", print_rtx_head, indent * 2, "");
375 fputs ("]", outfile);
376 sawclose = 1;
377 indent -= 2;
378 break;
380 case 'w':
381 if (! flag_dump_simple_rtl)
382 fprintf (outfile, " ");
383 fprintf (outfile, HOST_WIDE_INT_PRINT_DEC, XWINT (in_rtx, i));
384 if (! flag_dump_simple_rtl)
385 fprintf (outfile, " [" HOST_WIDE_INT_PRINT_HEX "]",
386 XWINT (in_rtx, i));
387 break;
389 case 'i':
390 if (i == 4 && INSN_P (in_rtx))
392 #ifndef GENERATOR_FILE
393 /* Pretty-print insn locators. Ignore scoping as it is mostly
394 redundant with line number information and do not print anything
395 when there is no location information available. */
396 if (INSN_LOCATOR (in_rtx) && insn_file (in_rtx))
397 fprintf(outfile, " %s:%i", insn_file (in_rtx), insn_line (in_rtx));
398 #endif
400 else if (i == 6 && NOTE_P (in_rtx))
402 /* This field is only used for NOTE_INSN_DELETED_LABEL, and
403 other times often contains garbage from INSN->NOTE death. */
404 if (NOTE_KIND (in_rtx) == NOTE_INSN_DELETED_LABEL)
405 fprintf (outfile, " %d", XINT (in_rtx, i));
407 else
409 int value = XINT (in_rtx, i);
410 const char *name;
412 #ifndef GENERATOR_FILE
413 if (REG_P (in_rtx) && value < FIRST_PSEUDO_REGISTER)
414 fprintf (outfile, " %d %s", REGNO (in_rtx),
415 reg_names[REGNO (in_rtx)]);
416 else if (REG_P (in_rtx)
417 && value <= LAST_VIRTUAL_REGISTER)
419 if (value == VIRTUAL_INCOMING_ARGS_REGNUM)
420 fprintf (outfile, " %d virtual-incoming-args", value);
421 else if (value == VIRTUAL_STACK_VARS_REGNUM)
422 fprintf (outfile, " %d virtual-stack-vars", value);
423 else if (value == VIRTUAL_STACK_DYNAMIC_REGNUM)
424 fprintf (outfile, " %d virtual-stack-dynamic", value);
425 else if (value == VIRTUAL_OUTGOING_ARGS_REGNUM)
426 fprintf (outfile, " %d virtual-outgoing-args", value);
427 else if (value == VIRTUAL_CFA_REGNUM)
428 fprintf (outfile, " %d virtual-cfa", value);
429 else
430 fprintf (outfile, " %d virtual-reg-%d", value,
431 value-FIRST_VIRTUAL_REGISTER);
433 else
434 #endif
435 if (flag_dump_unnumbered
436 && (is_insn || NOTE_P (in_rtx)))
437 fputc ('#', outfile);
438 else
439 fprintf (outfile, " %d", value);
441 #ifndef GENERATOR_FILE
442 if (REG_P (in_rtx) && REG_ATTRS (in_rtx))
444 fputs (" [", outfile);
445 if (ORIGINAL_REGNO (in_rtx) != REGNO (in_rtx))
446 fprintf (outfile, "orig:%i", ORIGINAL_REGNO (in_rtx));
447 if (REG_EXPR (in_rtx))
448 print_mem_expr (outfile, REG_EXPR (in_rtx));
450 if (REG_OFFSET (in_rtx))
451 fprintf (outfile, "+" HOST_WIDE_INT_PRINT_DEC,
452 REG_OFFSET (in_rtx));
453 fputs (" ]", outfile);
455 #endif
457 if (is_insn && &INSN_CODE (in_rtx) == &XINT (in_rtx, i)
458 && XINT (in_rtx, i) >= 0
459 && (name = get_insn_name (XINT (in_rtx, i))) != NULL)
460 fprintf (outfile, " {%s}", name);
461 sawclose = 0;
463 break;
465 /* Print NOTE_INSN names rather than integer codes. */
467 case 'n':
468 fprintf (outfile, " %s", GET_NOTE_INSN_NAME (XINT (in_rtx, i)));
469 sawclose = 0;
470 break;
472 case 'u':
473 if (XEXP (in_rtx, i) != NULL)
475 rtx sub = XEXP (in_rtx, i);
476 enum rtx_code subc = GET_CODE (sub);
478 if (GET_CODE (in_rtx) == LABEL_REF)
480 if (subc == NOTE
481 && NOTE_KIND (sub) == NOTE_INSN_DELETED_LABEL)
483 if (flag_dump_unnumbered)
484 fprintf (outfile, " [# deleted]");
485 else
486 fprintf (outfile, " [%d deleted]", INSN_UID (sub));
487 sawclose = 0;
488 break;
491 if (subc != CODE_LABEL)
492 goto do_e;
495 if (flag_dump_unnumbered)
496 fputs (" #", outfile);
497 else
498 fprintf (outfile, " %d", INSN_UID (sub));
500 else
501 fputs (" 0", outfile);
502 sawclose = 0;
503 break;
505 case 'b':
506 #ifndef GENERATOR_FILE
507 if (XBITMAP (in_rtx, i) == NULL)
508 fputs (" {null}", outfile);
509 else
510 bitmap_print (outfile, XBITMAP (in_rtx, i), " {", "}");
511 #endif
512 sawclose = 0;
513 break;
515 case 't':
516 #ifndef GENERATOR_FILE
517 dump_addr (outfile, " ", XTREE (in_rtx, i));
518 #endif
519 break;
521 case '*':
522 fputs (" Unknown", outfile);
523 sawclose = 0;
524 break;
526 case 'B':
527 #ifndef GENERATOR_FILE
528 if (XBBDEF (in_rtx, i))
529 fprintf (outfile, " %i", XBBDEF (in_rtx, i)->index);
530 #endif
531 break;
533 default:
534 gcc_unreachable ();
537 switch (GET_CODE (in_rtx))
539 #ifndef GENERATOR_FILE
540 case MEM:
541 fprintf (outfile, " [" HOST_WIDE_INT_PRINT_DEC,
542 (HOST_WIDE_INT) MEM_ALIAS_SET (in_rtx));
544 if (MEM_EXPR (in_rtx))
545 print_mem_expr (outfile, MEM_EXPR (in_rtx));
547 if (MEM_OFFSET (in_rtx))
548 fprintf (outfile, "+" HOST_WIDE_INT_PRINT_DEC,
549 INTVAL (MEM_OFFSET (in_rtx)));
551 if (MEM_SIZE (in_rtx))
552 fprintf (outfile, " S" HOST_WIDE_INT_PRINT_DEC,
553 INTVAL (MEM_SIZE (in_rtx)));
555 if (MEM_ALIGN (in_rtx) != 1)
556 fprintf (outfile, " A%u", MEM_ALIGN (in_rtx));
558 fputc (']', outfile);
559 break;
561 case CONST_DOUBLE:
562 if (FLOAT_MODE_P (GET_MODE (in_rtx)))
564 char s[60];
566 real_to_decimal (s, CONST_DOUBLE_REAL_VALUE (in_rtx),
567 sizeof (s), 0, 1);
568 fprintf (outfile, " %s", s);
570 real_to_hexadecimal (s, CONST_DOUBLE_REAL_VALUE (in_rtx),
571 sizeof (s), 0, 1);
572 fprintf (outfile, " [%s]", s);
574 break;
575 #endif
577 case CODE_LABEL:
578 fprintf (outfile, " [%d uses]", LABEL_NUSES (in_rtx));
579 switch (LABEL_KIND (in_rtx))
581 case LABEL_NORMAL: break;
582 case LABEL_STATIC_ENTRY: fputs (" [entry]", outfile); break;
583 case LABEL_GLOBAL_ENTRY: fputs (" [global entry]", outfile); break;
584 case LABEL_WEAK_ENTRY: fputs (" [weak entry]", outfile); break;
585 default: gcc_unreachable ();
587 break;
589 default:
590 break;
593 if (dump_for_graph
594 && (is_insn || NOTE_P (in_rtx)
595 || LABEL_P (in_rtx) || BARRIER_P (in_rtx)))
596 sawclose = 0;
597 else
599 fputc (')', outfile);
600 sawclose = 1;
604 /* Print an rtx on the current line of FILE. Initially indent IND
605 characters. */
607 void
608 print_inline_rtx (FILE *outf, const_rtx x, int ind)
610 int oldsaw = sawclose;
611 int oldindent = indent;
613 sawclose = 0;
614 indent = ind;
615 outfile = outf;
616 print_rtx (x);
617 sawclose = oldsaw;
618 indent = oldindent;
621 /* Call this function from the debugger to see what X looks like. */
623 void
624 debug_rtx (const_rtx x)
626 outfile = stderr;
627 sawclose = 0;
628 print_rtx (x);
629 fprintf (stderr, "\n");
632 /* Count of rtx's to print with debug_rtx_list.
633 This global exists because gdb user defined commands have no arguments. */
635 int debug_rtx_count = 0; /* 0 is treated as equivalent to 1 */
637 /* Call this function to print list from X on.
639 N is a count of the rtx's to print. Positive values print from the specified
640 rtx on. Negative values print a window around the rtx.
641 EG: -5 prints 2 rtx's on either side (in addition to the specified rtx). */
643 void
644 debug_rtx_list (const_rtx x, int n)
646 int i,count;
647 const_rtx insn;
649 count = n == 0 ? 1 : n < 0 ? -n : n;
651 /* If we are printing a window, back up to the start. */
653 if (n < 0)
654 for (i = count / 2; i > 0; i--)
656 if (PREV_INSN (x) == 0)
657 break;
658 x = PREV_INSN (x);
661 for (i = count, insn = x; i > 0 && insn != 0; i--, insn = NEXT_INSN (insn))
663 debug_rtx (insn);
664 fprintf (stderr, "\n");
668 /* Call this function to print an rtx list from START to END inclusive. */
670 void
671 debug_rtx_range (const_rtx start, const_rtx end)
673 while (1)
675 debug_rtx (start);
676 fprintf (stderr, "\n");
677 if (!start || start == end)
678 break;
679 start = NEXT_INSN (start);
683 /* Call this function to search an rtx list to find one with insn uid UID,
684 and then call debug_rtx_list to print it, using DEBUG_RTX_COUNT.
685 The found insn is returned to enable further debugging analysis. */
687 const_rtx
688 debug_rtx_find (const_rtx x, int uid)
690 while (x != 0 && INSN_UID (x) != uid)
691 x = NEXT_INSN (x);
692 if (x != 0)
694 debug_rtx_list (x, debug_rtx_count);
695 return x;
697 else
699 fprintf (stderr, "insn uid %d not found\n", uid);
700 return 0;
704 /* External entry point for printing a chain of insns
705 starting with RTX_FIRST onto file OUTF.
706 A blank line separates insns.
708 If RTX_FIRST is not an insn, then it alone is printed, with no newline. */
710 void
711 print_rtl (FILE *outf, const_rtx rtx_first)
713 const_rtx tmp_rtx;
715 outfile = outf;
716 sawclose = 0;
718 if (rtx_first == 0)
720 fputs (print_rtx_head, outf);
721 fputs ("(nil)\n", outf);
723 else
724 switch (GET_CODE (rtx_first))
726 case INSN:
727 case JUMP_INSN:
728 case CALL_INSN:
729 case NOTE:
730 case CODE_LABEL:
731 case BARRIER:
732 for (tmp_rtx = rtx_first; tmp_rtx != 0; tmp_rtx = NEXT_INSN (tmp_rtx))
734 fputs (print_rtx_head, outfile);
735 print_rtx (tmp_rtx);
736 fprintf (outfile, "\n");
738 break;
740 default:
741 fputs (print_rtx_head, outfile);
742 print_rtx (rtx_first);
746 /* Like print_rtx, except specify a file. */
747 /* Return nonzero if we actually printed anything. */
750 print_rtl_single (FILE *outf, const_rtx x)
752 outfile = outf;
753 sawclose = 0;
754 if (! flag_dump_unnumbered)
756 fputs (print_rtx_head, outfile);
757 print_rtx (x);
758 putc ('\n', outf);
759 return 1;
761 return 0;
765 /* Like print_rtl except without all the detail; for example,
766 if RTX is a CONST_INT then print in decimal format. */
768 void
769 print_simple_rtl (FILE *outf, const_rtx x)
771 int save = flag_dump_simple_rtl;
773 flag_dump_simple_rtl = 1;
774 print_rtl (outf, x);
775 flag_dump_simple_rtl = save;