gcc/print-rtl.c

   1 /* Print RTL for GNU C Compiler.
   2    Copyright (C) 1987, 1988, 1992, 1997, 1998, 1999, 2000
   3    Free Software Foundation, Inc.
   4
   5 This file is part of GNU CC.
   6
   7 GNU CC is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2, or (at your option)
  10 any later version.
  11
  12 GNU CC is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU CC; see the file COPYING.  If not, write to
  19 the Free Software Foundation, 59 Temple Place - Suite 330,
  20 Boston, MA 02111-1307, USA.  */
  21
  22
  23 #include "config.h"
  24 #include "system.h"
  25 #include "rtl.h"
  26 #include "real.h"
  27 #include "flags.h"
  28 #include "hard-reg-set.h"
  29 #include "basic-block.h"
  30
  31 /* How to print out a register name.
  32    We don't use PRINT_REG because some definitions of PRINT_REG
  33    don't work here.  */
  34 #ifndef DEBUG_PRINT_REG
  35 #define DEBUG_PRINT_REG(RTX, CODE, FILE) \
  36   fprintf ((FILE), "%d %s", REGNO (RTX), reg_names[REGNO (RTX)])
  37 #endif
  38
  39 /* Array containing all of the register names */
  40
  41 #ifdef DEBUG_REGISTER_NAMES
  42 static const char * const debug_reg_names[] = DEBUG_REGISTER_NAMES;
  43 #define reg_names debug_reg_names
  44 #else
  45 const char * reg_names[] = REGISTER_NAMES;
  46 #endif
  47
  48 static FILE *outfile;
  49
  50 static int sawclose = 0;
  51
  52 static int indent;
  53
  54 static void print_rtx           PARAMS ((rtx));
  55
  56 /* String printed at beginning of each RTL when it is dumped.
  57    This string is set to ASM_COMMENT_START when the RTL is dumped in
  58    the assembly output file.  */
  59 const char *print_rtx_head = "";
  60
  61 /* Nonzero means suppress output of instruction numbers and line number
  62    notes in debugging dumps.
  63    This must be defined here so that programs like gencodes can be linked.  */
  64 int flag_dump_unnumbered = 0;
  65
  66 /* Nonzero means use simplified format without flags, modes, etc.  */
  67 int flag_simple = 0;
  68
  69 /* Nonzero if we are dumping graphical description.  */
  70 int dump_for_graph;
  71
  72 /* Nonzero to dump all call_placeholder alternatives.  */
  73 static int debug_call_placeholder_verbose;
  74
  75 /* Print IN_RTX onto OUTFILE.  This is the recursive part of printing.  */
  76
  77 static void
  78 print_rtx (in_rtx)
  79      register rtx in_rtx;
  80 {
  81   register int i = 0;
  82   register int j;
  83   register const char *format_ptr;
  84   register int is_insn;
  85   rtx tem;
  86
  87   if (sawclose)
  88     {
  89       if (flag_simple)
  90         fputc (' ', outfile);
  91       else
  92         fprintf (outfile, "\n%s%*s",
  93                  print_rtx_head, indent * 2, "");
  94       sawclose = 0;
  95     }
  96
  97   if (in_rtx == 0)
  98     {
  99       fputs ("(nil)", outfile);
 100       sawclose = 1;
 101       return;
 102     }
 103
 104   is_insn = (INSN_P (in_rtx));
 105
 106   /* When printing in VCG format we write INSNs, NOTE, LABEL, and BARRIER
 107      in separate nodes and therefore have to handle them special here.  */
 108   if (dump_for_graph &&
 109       (is_insn || GET_CODE (in_rtx) == NOTE || GET_CODE (in_rtx) == CODE_LABEL
 110        || GET_CODE (in_rtx) == BARRIER))
 111     {
 112       i = 3;
 113       indent = 0;
 114     }
 115   else
 116     {
 117       /* print name of expression code */
 118       if (flag_simple && GET_CODE (in_rtx) == CONST_INT)
 119         fputc ('(', outfile);
 120       else
 121         fprintf (outfile, "(%s", GET_RTX_NAME (GET_CODE (in_rtx)));
 122
 123       if (! flag_simple)
 124         {
 125           if (in_rtx->in_struct)
 126             fputs ("/s", outfile);
 127
 128           if (in_rtx->volatil)
 129             fputs ("/v", outfile);
 130
 131           if (in_rtx->unchanging)
 132             fputs ("/u", outfile);
 133
 134           if (in_rtx->integrated)
 135             fputs ("/i", outfile);
 136
 137           if (in_rtx->frame_related)
 138             fputs ("/f", outfile);
 139
 140           if (in_rtx->jump)
 141             fputs ("/j", outfile);
 142
 143           if (in_rtx->call)
 144             fputs ("/c", outfile);
 145
 146           if (GET_MODE (in_rtx) != VOIDmode)
 147             {
 148               /* Print REG_NOTE names for EXPR_LIST and INSN_LIST.  */
 149               if (GET_CODE (in_rtx) == EXPR_LIST
 150                   || GET_CODE (in_rtx) == INSN_LIST)
 151                 fprintf (outfile, ":%s",
 152                          GET_REG_NOTE_NAME (GET_MODE (in_rtx)));
 153               else
 154                 fprintf (outfile, ":%s", GET_MODE_NAME (GET_MODE (in_rtx)));
 155             }
 156         }
 157     }
 158
 159   /* Get the format string and skip the first elements if we have handled
 160      them already.  */
 161   format_ptr = GET_RTX_FORMAT (GET_CODE (in_rtx)) + i;
 162
 163   for (; i < GET_RTX_LENGTH (GET_CODE (in_rtx)); i++)
 164     switch (*format_ptr++)
 165       {
 166       case 'S':
 167       case 's':
 168         if (XSTR (in_rtx, i) == 0)
 169           fputs (dump_for_graph ? " \\\"\\\"" : " \"\"", outfile);
 170         else
 171           {
 172             if (dump_for_graph)
 173               fprintf (outfile, " (\\\"%s\\\")", XSTR (in_rtx, i));
 174             else
 175               fprintf (outfile, " (\"%s\")", XSTR (in_rtx, i));
 176           }
 177         sawclose = 1;
 178         break;
 179
 180         /* 0 indicates a field for internal use that should not be printed.
 181            An exception is the third field of a NOTE, where it indicates
 182            that the field has several different valid contents.  */
 183       case '0':
 184         if (i == 1 && GET_CODE (in_rtx) == REG)
 185           {
 186             if (REGNO (in_rtx) != ORIGINAL_REGNO (in_rtx))
 187               fprintf (outfile, " [%d]", ORIGINAL_REGNO (in_rtx));
 188             break;
 189           }
 190         if (i == 3 && GET_CODE (in_rtx) == NOTE)
 191           {
 192             switch (NOTE_LINE_NUMBER (in_rtx))
 193               {
 194               case NOTE_INSN_EH_REGION_BEG:
 195               case NOTE_INSN_EH_REGION_END:
 196                 if (flag_dump_unnumbered)
 197                   fprintf (outfile, " #");
 198                 else
 199                   fprintf (outfile, " %d", NOTE_EH_HANDLER (in_rtx));
 200                 sawclose = 1;
 201                 break;
 202
 203               case NOTE_INSN_BLOCK_BEG:
 204               case NOTE_INSN_BLOCK_END:
 205                 fprintf (outfile, " ");
 206                 if (flag_dump_unnumbered)
 207                   fprintf (outfile, "#");
 208                 else
 209                   fprintf (outfile, HOST_PTR_PRINTF,
 210                            (char *) NOTE_BLOCK (in_rtx));
 211                 sawclose = 1;
 212                 break;
 213
 214               case NOTE_INSN_RANGE_BEG:
 215               case NOTE_INSN_RANGE_END:
 216               case NOTE_INSN_LIVE:
 217                 indent += 2;
 218                 if (!sawclose)
 219                   fprintf (outfile, " ");
 220                 print_rtx (NOTE_RANGE_INFO (in_rtx));
 221                 indent -= 2;
 222                 break;
 223
 224               case NOTE_INSN_BASIC_BLOCK:
 225                 {
 226                   basic_block bb = NOTE_BASIC_BLOCK (in_rtx);
 227                   if (bb != 0)
 228                     fprintf (outfile, " [bb %d]", bb->index);
 229                   break;
 230                 }
 231
 232               case NOTE_INSN_EXPECTED_VALUE:
 233                 indent += 2;
 234                 if (!sawclose)
 235                   fprintf (outfile, " ");
 236                 print_rtx (NOTE_EXPECTED_VALUE (in_rtx));
 237                 indent -= 2;
 238                 break;
 239
 240               case NOTE_INSN_DELETED_LABEL:
 241                 if (NOTE_SOURCE_FILE (in_rtx))
 242                   fprintf (outfile, " (\"%s\")", NOTE_SOURCE_FILE (in_rtx));
 243                 else
 244                   fprintf (outfile, " \"\"");
 245                 break;
 246
 247               default:
 248                 {
 249                   const char * const str = X0STR (in_rtx, i);
 250
 251                   if (NOTE_LINE_NUMBER (in_rtx) < 0)
 252                     ;
 253                   else if (str == 0)
 254                     fputs (dump_for_graph ? " \\\"\\\"" : " \"\"", outfile);
 255                   else
 256                     {
 257                       if (dump_for_graph)
 258                         fprintf (outfile, " (\\\"%s\\\")", str);
 259                       else
 260                         fprintf (outfile, " (\"%s\")", str);
 261                     }
 262                   break;
 263                 }
 264               }
 265           }
 266         break;
 267
 268       case 'e':
 269       do_e:
 270         indent += 2;
 271         if (!sawclose)
 272           fprintf (outfile, " ");
 273         print_rtx (XEXP (in_rtx, i));
 274         indent -= 2;
 275         break;
 276
 277       case 'E':
 278       case 'V':
 279         indent += 2;
 280         if (sawclose)
 281           {
 282             fprintf (outfile, "\n%s%*s",
 283                      print_rtx_head, indent * 2, "");
 284             sawclose = 0;
 285           }
 286         fputs ("[ ", outfile);
 287         if (NULL != XVEC (in_rtx, i))
 288           {
 289             indent += 2;
 290             if (XVECLEN (in_rtx, i))
 291               sawclose = 1;
 292
 293             for (j = 0; j < XVECLEN (in_rtx, i); j++)
 294               print_rtx (XVECEXP (in_rtx, i, j));
 295
 296             indent -= 2;
 297           }
 298         if (sawclose)
 299           fprintf (outfile, "\n%s%*s",
 300                    print_rtx_head, indent * 2, "");
 301
 302         fputs ("] ", outfile);
 303         sawclose = 1;
 304         indent -= 2;
 305         break;
 306
 307       case 'w':
 308         if (! flag_simple)
 309           fprintf (outfile, " ");
 310         fprintf (outfile, HOST_WIDE_INT_PRINT_DEC, XWINT (in_rtx, i));
 311         if (! flag_simple)
 312           {
 313             fprintf (outfile, " [");
 314             fprintf (outfile, HOST_WIDE_INT_PRINT_HEX, XWINT (in_rtx, i));
 315             fprintf (outfile, "]");
 316           }
 317         break;
 318
 319       case 'i':
 320         {
 321           register int value = XINT (in_rtx, i);
 322           const char *name;
 323
 324           if (GET_CODE (in_rtx) == REG && value < FIRST_PSEUDO_REGISTER)
 325             {
 326               fputc (' ', outfile);
 327               DEBUG_PRINT_REG (in_rtx, 0, outfile);
 328             }
 329           else if (GET_CODE (in_rtx) == REG && value <= LAST_VIRTUAL_REGISTER)
 330             {
 331               if (value == VIRTUAL_INCOMING_ARGS_REGNUM)
 332                 fprintf (outfile, " %d virtual-incoming-args", value);
 333               else if (value == VIRTUAL_STACK_VARS_REGNUM)
 334                 fprintf (outfile, " %d virtual-stack-vars", value);
 335               else if (value == VIRTUAL_STACK_DYNAMIC_REGNUM)
 336                 fprintf (outfile, " %d virtual-stack-dynamic", value);
 337               else if (value == VIRTUAL_OUTGOING_ARGS_REGNUM)
 338                 fprintf (outfile, " %d virtual-outgoing-args", value);
 339               else if (value == VIRTUAL_CFA_REGNUM)
 340                 fprintf (outfile, " %d virtual-cfa", value);
 341               else
 342                 fprintf (outfile, " %d virtual-reg-%d", value,
 343                          value-FIRST_VIRTUAL_REGISTER);
 344             }
 345           else if (flag_dump_unnumbered
 346                    && (is_insn || GET_CODE (in_rtx) == NOTE))
 347             fputc ('#', outfile);
 348           else
 349             fprintf (outfile, " %d", value);
 350
 351           if (is_insn && &INSN_CODE (in_rtx) == &XINT (in_rtx, i)
 352               && XINT (in_rtx, i) >= 0
 353               && (name = get_insn_name (XINT (in_rtx, i))) != NULL)
 354             fprintf (outfile, " {%s}", name);
 355           sawclose = 0;
 356         }
 357         break;
 358
 359       /* Print NOTE_INSN names rather than integer codes.  */
 360
 361       case 'n':
 362         if (XINT (in_rtx, i) >= (int) NOTE_INSN_BIAS
 363             && XINT (in_rtx, i) < (int) NOTE_INSN_MAX)
 364           fprintf (outfile, " %s", GET_NOTE_INSN_NAME (XINT (in_rtx, i)));
 365         else
 366           fprintf (outfile, " %d", XINT (in_rtx, i));
 367         sawclose = 0;
 368         break;
 369
 370       case 'u':
 371         if (XEXP (in_rtx, i) != NULL)
 372           {
 373             rtx sub = XEXP (in_rtx, i);
 374             enum rtx_code subc = GET_CODE (sub);
 375
 376             if (GET_CODE (in_rtx) == LABEL_REF)
 377               {
 378                 if (subc == NOTE
 379                     && NOTE_LINE_NUMBER (sub) == NOTE_INSN_DELETED_LABEL)
 380                   {
 381                     if (flag_dump_unnumbered)
 382                       fprintf (outfile, " [# deleted]");
 383                     else
 384                       fprintf (outfile, " [%d deleted]", INSN_UID (sub));
 385                     sawclose = 0;
 386                     break;
 387                   }
 388
 389                 if (subc != CODE_LABEL)
 390                   goto do_e;
 391               }
 392
 393             if (flag_dump_unnumbered)
 394               fputs (" #", outfile);
 395             else
 396               fprintf (outfile, " %d", INSN_UID (sub));
 397           }
 398         else
 399           fputs (" 0", outfile);
 400         sawclose = 0;
 401         break;
 402
 403       case 'b':
 404         if (XBITMAP (in_rtx, i) == NULL)
 405           fputs (" {null}", outfile);
 406         else
 407           bitmap_print (outfile, XBITMAP (in_rtx, i), " {", "}");
 408         sawclose = 0;
 409         break;
 410
 411       case 't':
 412         putc (' ', outfile);
 413         fprintf (outfile, HOST_PTR_PRINTF, (char *) XTREE (in_rtx, i));
 414         break;
 415
 416       case '*':
 417         fputs (" Unknown", outfile);
 418         sawclose = 0;
 419         break;
 420
 421       default:
 422         fprintf (stderr,
 423                  "switch format wrong in rtl.print_rtx(). format was: %c.\n",
 424                  format_ptr[-1]);
 425         abort ();
 426       }
 427
 428   switch (GET_CODE (in_rtx))
 429     {
 430     case MEM:
 431       fputc (' ', outfile);
 432       fprintf (outfile, HOST_WIDE_INT_PRINT_DEC, MEM_ALIAS_SET (in_rtx));
 433       break;
 434
 435 #if HOST_FLOAT_FORMAT == TARGET_FLOAT_FORMAT && MAX_LONG_DOUBLE_TYPE_SIZE == 64
 436     case CONST_DOUBLE:
 437       if (FLOAT_MODE_P (GET_MODE (in_rtx)))
 438         {
 439           double val;
 440           REAL_VALUE_FROM_CONST_DOUBLE (val, in_rtx);
 441           fprintf (outfile, " [%.16g]", val);
 442         }
 443       break;
 444 #endif
 445
 446     case CODE_LABEL:
 447       fprintf (outfile, " [%d uses]", LABEL_NUSES (in_rtx));
 448       if (LABEL_ALTERNATE_NAME (in_rtx))
 449         fprintf (outfile, " [alternate name: %s]",
 450                  LABEL_ALTERNATE_NAME (in_rtx));
 451       break;
 452
 453     case CALL_PLACEHOLDER:
 454       if (debug_call_placeholder_verbose)
 455         {
 456           fputs (" (cond [\n  (const_string \"normal\") (sequence [", outfile);
 457           for (tem = XEXP (in_rtx, 0); tem != 0; tem = NEXT_INSN (tem))
 458             {
 459               fputs ("\n    ", outfile);
 460               print_inline_rtx (outfile, tem, 4);
 461             }
 462
 463           tem = XEXP (in_rtx, 1);
 464           if (tem)
 465             fputs ("\n    ])\n  (const_string \"tail_call\") (sequence [", outfile);
 466           for (; tem != 0; tem = NEXT_INSN (tem))
 467             {
 468               fputs ("\n    ", outfile);
 469               print_inline_rtx (outfile, tem, 4);
 470             }
 471
 472           tem = XEXP (in_rtx, 2);
 473           if (tem)
 474             fputs ("\n    ])\n  (const_string \"tail_recursion\") (sequence [", outfile);
 475           for (; tem != 0; tem = NEXT_INSN (tem))
 476             {
 477               fputs ("\n    ", outfile);
 478               print_inline_rtx (outfile, tem, 4);
 479             }
 480
 481           fputs ("\n    ])\n  ])", outfile);
 482           break;
 483         }
 484
 485       for (tem = XEXP (in_rtx, 0); tem != 0; tem = NEXT_INSN (tem))
 486         if (GET_CODE (tem) == CALL_INSN)
 487           {
 488             fprintf (outfile, " ");
 489             print_rtx (tem);
 490             break;
 491           }
 492       break;
 493
 494     default:
 495       break;
 496     }
 497
 498   if (dump_for_graph
 499       && (is_insn || GET_CODE (in_rtx) == NOTE
 500           || GET_CODE (in_rtx) == CODE_LABEL || GET_CODE (in_rtx) == BARRIER))
 501     sawclose = 0;
 502   else
 503     {
 504       fputc (')', outfile);
 505       sawclose = 1;
 506     }
 507 }
 508
 509 /* Print an rtx on the current line of FILE.  Initially indent IND
 510    characters.  */
 511
 512 void
 513 print_inline_rtx (outf, x, ind)
 514      FILE *outf;
 515      rtx x;
 516      int ind;
 517 {
 518   int oldsaw = sawclose;
 519   int oldindent = indent;
 520
 521   sawclose = 0;
 522   indent = ind;
 523   outfile = outf;
 524   print_rtx (x);
 525   sawclose = oldsaw;
 526   indent = oldindent;
 527 }
 528
 529 /* Call this function from the debugger to see what X looks like.  */
 530
 531 void
 532 debug_rtx (x)
 533      rtx x;
 534 {
 535   outfile = stderr;
 536   print_rtx (x);
 537   fprintf (stderr, "\n");
 538 }
 539
 540 /* Count of rtx's to print with debug_rtx_list.
 541    This global exists because gdb user defined commands have no arguments.  */
 542
 543 int debug_rtx_count = 0;        /* 0 is treated as equivalent to 1 */
 544
 545 /* Call this function to print list from X on.
 546
 547    N is a count of the rtx's to print. Positive values print from the specified
 548    rtx on.  Negative values print a window around the rtx.
 549    EG: -5 prints 2 rtx's on either side (in addition to the specified rtx).  */
 550
 551 void
 552 debug_rtx_list (x, n)
 553      rtx x;
 554      int n;
 555 {
 556   int i,count;
 557   rtx insn;
 558
 559   count = n == 0 ? 1 : n < 0 ? -n : n;
 560
 561   /* If we are printing a window, back up to the start.  */
 562
 563   if (n < 0)
 564     for (i = count / 2; i > 0; i--)
 565       {
 566         if (PREV_INSN (x) == 0)
 567           break;
 568         x = PREV_INSN (x);
 569       }
 570
 571   for (i = count, insn = x; i > 0 && insn != 0; i--, insn = NEXT_INSN (insn))
 572     debug_rtx (insn);
 573 }
 574
 575 /* Call this function to print an rtx list from START to END inclusive.  */
 576
 577 void
 578 debug_rtx_range (start, end)
 579      rtx start, end;
 580 {
 581   while (1)
 582     {
 583       debug_rtx (start);
 584       if (!start || start == end)
 585         break;
 586       start = NEXT_INSN (start);
 587     }
 588 }
 589
 590 /* Call this function to search an rtx list to find one with insn uid UID,
 591    and then call debug_rtx_list to print it, using DEBUG_RTX_COUNT.
 592    The found insn is returned to enable further debugging analysis.  */
 593
 594 rtx
 595 debug_rtx_find (x, uid)
 596      rtx x;
 597      int uid;
 598 {
 599   while (x != 0 && INSN_UID (x) != uid)
 600     x = NEXT_INSN (x);
 601   if (x != 0)
 602     {
 603       debug_rtx_list (x, debug_rtx_count);
 604       return x;
 605     }
 606   else
 607     {
 608       fprintf (stderr, "insn uid %d not found\n", uid);
 609       return 0;
 610     }
 611 }
 612
 613 /* External entry point for printing a chain of insns
 614    starting with RTX_FIRST onto file OUTF.
 615    A blank line separates insns.
 616
 617    If RTX_FIRST is not an insn, then it alone is printed, with no newline.  */
 618
 619 void
 620 print_rtl (outf, rtx_first)
 621      FILE *outf;
 622      rtx rtx_first;
 623 {
 624   register rtx tmp_rtx;
 625
 626   outfile = outf;
 627   sawclose = 0;
 628
 629   if (rtx_first == 0)
 630     {
 631       fputs (print_rtx_head, outf);
 632       fputs ("(nil)\n", outf);
 633     }
 634   else
 635     switch (GET_CODE (rtx_first))
 636       {
 637       case INSN:
 638       case JUMP_INSN:
 639       case CALL_INSN:
 640       case NOTE:
 641       case CODE_LABEL:
 642       case BARRIER:
 643         for (tmp_rtx = rtx_first; tmp_rtx != 0; tmp_rtx = NEXT_INSN (tmp_rtx))
 644           if (! flag_dump_unnumbered
 645               || GET_CODE (tmp_rtx) != NOTE || NOTE_LINE_NUMBER (tmp_rtx) < 0)
 646             {
 647               fputs (print_rtx_head, outfile);
 648               print_rtx (tmp_rtx);
 649               fprintf (outfile, "\n");
 650             }
 651         break;
 652
 653       default:
 654         fputs (print_rtx_head, outfile);
 655         print_rtx (rtx_first);
 656       }
 657 }
 658
 659 /* Like print_rtx, except specify a file.  */
 660 /* Return nonzero if we actually printed anything.  */
 661
 662 int
 663 print_rtl_single (outf, x)
 664      FILE *outf;
 665      rtx x;
 666 {
 667   outfile = outf;
 668   sawclose = 0;
 669   if (! flag_dump_unnumbered
 670       || GET_CODE (x) != NOTE || NOTE_LINE_NUMBER (x) < 0)
 671     {
 672       fputs (print_rtx_head, outfile);
 673       print_rtx (x);
 674       putc ('\n', outf);
 675       return 1;
 676     }
 677   return 0;
 678 }
 679
 680
 681 /* Like print_rtl except without all the detail; for example,
 682    if RTX is a CONST_INT then print in decimal format.  */
 683
 684 void
 685 print_simple_rtl (outf, x)
 686      FILE *outf;
 687      rtx x;
 688 {
 689   flag_simple = 1;
 690   print_rtl (outf, x);
 691   flag_simple = 0;
 692 }