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 "basic-block.h"
  29
  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 reg_names[] = DEBUG_REGISTER_NAMES;
  43 #else
  44 static const char * const reg_names[] = REGISTER_NAMES;
  45 #endif
  46
  47 static FILE *outfile;
  48
  49 static const char xspaces[] = "                                                                                                                                                                ";
  50
  51 static int sawclose = 0;
  52
  53 static int indent;
  54
  55 static void print_rtx           PARAMS ((rtx));
  56
  57 /* Nonzero means suppress output of instruction numbers and line number
  58    notes in debugging dumps.
  59    This must be defined here so that programs like gencodes can be linked.  */
  60 int flag_dump_unnumbered = 0;
  61
  62 /* Nonzero if we are dumping graphical description.  */
  63 int dump_for_graph;
  64
  65 /* Print IN_RTX onto OUTFILE.  This is the recursive part of printing.  */
  66
  67 static void
  68 print_rtx (in_rtx)
  69      register rtx in_rtx;
  70 {
  71   register int i = 0;
  72   register int j;
  73   register const char *format_ptr;
  74   register int is_insn;
  75   rtx tem;
  76
  77   if (sawclose)
  78     {
  79       fprintf (outfile, "\n%s",
  80                (xspaces + (sizeof xspaces - 1 - indent * 2)));
  81       sawclose = 0;
  82     }
  83
  84   if (in_rtx == 0)
  85     {
  86       fputs ("(nil)", outfile);
  87       sawclose = 1;
  88       return;
  89     }
  90
  91   is_insn = (GET_RTX_CLASS (GET_CODE (in_rtx)) == 'i');
  92
  93   /* When printing in VCG format we write INSNs, NOTE, LABEL, and BARRIER
  94      in separate nodes and therefore have to handle them special here.  */
  95   if (dump_for_graph &&
  96       (is_insn || GET_CODE (in_rtx) == NOTE || GET_CODE (in_rtx) == CODE_LABEL
  97        || GET_CODE (in_rtx) == BARRIER))
  98     {
  99       i = 3;
 100       indent = 0;
 101     }
 102   else
 103     {
 104       /* print name of expression code */
 105       fprintf (outfile, "(%s", GET_RTX_NAME (GET_CODE (in_rtx)));
 106
 107       if (in_rtx->in_struct)
 108         fputs ("/s", outfile);
 109
 110       if (in_rtx->volatil)
 111         fputs ("/v", outfile);
 112
 113       if (in_rtx->unchanging)
 114         fputs ("/u", outfile);
 115
 116       if (in_rtx->integrated)
 117         fputs ("/i", outfile);
 118
 119       if (in_rtx->frame_related)
 120         fputs ("/f", outfile);
 121
 122       if (in_rtx->jump)
 123         fputs ("/j", outfile);
 124
 125       if (in_rtx->call)
 126         fputs ("/c", outfile);
 127
 128       if (GET_MODE (in_rtx) != VOIDmode)
 129         {
 130           /* Print REG_NOTE names for EXPR_LIST and INSN_LIST.  */
 131           if (GET_CODE (in_rtx) == EXPR_LIST || GET_CODE (in_rtx) == INSN_LIST)
 132             fprintf (outfile, ":%s", GET_REG_NOTE_NAME (GET_MODE (in_rtx)));
 133           else
 134             fprintf (outfile, ":%s", GET_MODE_NAME (GET_MODE (in_rtx)));
 135         }
 136     }
 137
 138   /* Get the format string and skip the first elements if we have handled
 139      them already.  */
 140   format_ptr = GET_RTX_FORMAT (GET_CODE (in_rtx)) + i;
 141
 142   for (; i < GET_RTX_LENGTH (GET_CODE (in_rtx)); i++)
 143     switch (*format_ptr++)
 144       {
 145       case 'S':
 146       case 's':
 147         if (XSTR (in_rtx, i) == 0)
 148           fputs (dump_for_graph ? " \\\"\\\"" : " \"\"", outfile);
 149         else
 150           {
 151             if (dump_for_graph)
 152               fprintf (outfile, " (\\\"%s\\\")", XSTR (in_rtx, i));
 153             else
 154               fprintf (outfile, " (\"%s\")", XSTR (in_rtx, i));
 155           }
 156         sawclose = 1;
 157         break;
 158
 159         /* 0 indicates a field for internal use that should not be printed.
 160            An exception is the third field of a NOTE, where it indicates
 161            that the field has several different valid contents.  */
 162       case '0':
 163         if (i == 3 && GET_CODE (in_rtx) == NOTE)
 164           {
 165             switch (NOTE_LINE_NUMBER (in_rtx))
 166               {
 167               case NOTE_INSN_EH_REGION_BEG:
 168               case NOTE_INSN_EH_REGION_END:
 169                 if (flag_dump_unnumbered)
 170                   fprintf (outfile, " #");
 171                 else
 172                   fprintf (outfile, " %d", NOTE_EH_HANDLER (in_rtx));
 173                 sawclose = 1;
 174                 break;
 175
 176               case NOTE_INSN_BLOCK_BEG:
 177               case NOTE_INSN_BLOCK_END:
 178                 fprintf (outfile, " ");
 179                 if (flag_dump_unnumbered)
 180                   fprintf (outfile, "#");
 181                 else
 182                   fprintf (outfile, HOST_PTR_PRINTF,
 183                            (char *) NOTE_BLOCK (in_rtx));
 184                 sawclose = 1;
 185                 break;
 186
 187               case NOTE_INSN_RANGE_BEG:
 188               case NOTE_INSN_RANGE_END:
 189               case NOTE_INSN_LIVE:
 190                 indent += 2;
 191                 if (!sawclose)
 192                   fprintf (outfile, " ");
 193                 print_rtx (NOTE_RANGE_INFO (in_rtx));
 194                 indent -= 2;
 195                 break;
 196
 197               case NOTE_INSN_BASIC_BLOCK:
 198                 {
 199                   basic_block bb = NOTE_BASIC_BLOCK (in_rtx);
 200                   if (bb != 0)
 201                     fprintf (outfile, " [bb %d]", bb->index);
 202                   break;
 203                 }
 204
 205               case NOTE_INSN_EXPECTED_VALUE:
 206                 indent += 2;
 207                 if (!sawclose)
 208                   fprintf (outfile, " ");
 209                 print_rtx (NOTE_EXPECTED_VALUE (in_rtx));
 210                 indent -= 2;
 211                 break;
 212
 213               case NOTE_INSN_DELETED_LABEL:
 214                 if (NOTE_SOURCE_FILE (in_rtx))
 215                   fprintf (outfile, " (\"%s\")", NOTE_SOURCE_FILE (in_rtx));
 216                 else
 217                   fprintf (outfile, " \"\"");
 218                 break;
 219
 220               default:
 221                 {
 222                   const char * const str = X0STR (in_rtx, i);
 223
 224                   if (NOTE_LINE_NUMBER (in_rtx) < 0)
 225                     ;
 226                   else if (str == 0)
 227                     fputs (dump_for_graph ? " \\\"\\\"" : " \"\"", outfile);
 228                   else
 229                     {
 230                       if (dump_for_graph)
 231                         fprintf (outfile, " (\\\"%s\\\")", str);
 232                       else
 233                         fprintf (outfile, " (\"%s\")", str);
 234                     }
 235                   break;
 236                 }
 237               }
 238           }
 239         break;
 240
 241       case 'e':
 242       do_e:
 243         indent += 2;
 244         if (!sawclose)
 245           fprintf (outfile, " ");
 246         print_rtx (XEXP (in_rtx, i));
 247         indent -= 2;
 248         break;
 249
 250       case 'E':
 251       case 'V':
 252         indent += 2;
 253         if (sawclose)
 254           {
 255             fprintf (outfile, "\n%s",
 256                      (xspaces + (sizeof xspaces - 1 - indent * 2)));
 257             sawclose = 0;
 258           }
 259         fputs ("[ ", outfile);
 260         if (NULL != XVEC (in_rtx, i))
 261           {
 262             indent += 2;
 263             if (XVECLEN (in_rtx, i))
 264               sawclose = 1;
 265
 266             for (j = 0; j < XVECLEN (in_rtx, i); j++)
 267               print_rtx (XVECEXP (in_rtx, i, j));
 268
 269             indent -= 2;
 270           }
 271         if (sawclose)
 272           fprintf (outfile, "\n%s",
 273                    (xspaces + (sizeof xspaces - 1 - indent * 2)));
 274
 275         fputs ("] ", outfile);
 276         sawclose = 1;
 277         indent -= 2;
 278         break;
 279
 280       case 'w':
 281         fprintf (outfile, " ");
 282         fprintf (outfile, HOST_WIDE_INT_PRINT_DEC, XWINT (in_rtx, i));
 283         fprintf (outfile, " [");
 284         fprintf (outfile, HOST_WIDE_INT_PRINT_HEX, XWINT (in_rtx, i));
 285         fprintf (outfile, "]");
 286         break;
 287
 288       case 'i':
 289         {
 290           register int value = XINT (in_rtx, i);
 291           const char *name;
 292
 293           if (GET_CODE (in_rtx) == REG && value < FIRST_PSEUDO_REGISTER)
 294             {
 295               fputc (' ', outfile);
 296               DEBUG_PRINT_REG (in_rtx, 0, outfile);
 297             }
 298           else if (GET_CODE (in_rtx) == REG && value <= LAST_VIRTUAL_REGISTER)
 299             {
 300               if (value == VIRTUAL_INCOMING_ARGS_REGNUM)
 301                 fprintf (outfile, " %d virtual-incoming-args", value);
 302               else if (value == VIRTUAL_STACK_VARS_REGNUM)
 303                 fprintf (outfile, " %d virtual-stack-vars", value);
 304               else if (value == VIRTUAL_STACK_DYNAMIC_REGNUM)
 305                 fprintf (outfile, " %d virtual-stack-dynamic", value);
 306               else if (value == VIRTUAL_OUTGOING_ARGS_REGNUM)
 307                 fprintf (outfile, " %d virtual-outgoing-args", value);
 308               else if (value == VIRTUAL_CFA_REGNUM)
 309                 fprintf (outfile, " %d virtual-cfa", value);
 310               else
 311                 fprintf (outfile, " %d virtual-reg-%d", value,
 312                          value-FIRST_VIRTUAL_REGISTER);
 313             }
 314           else if (flag_dump_unnumbered
 315                    && (is_insn || GET_CODE (in_rtx) == NOTE))
 316             fputc ('#', outfile);
 317           else
 318             fprintf (outfile, " %d", value);
 319
 320           if (is_insn && &INSN_CODE (in_rtx) == &XINT (in_rtx, i)
 321               && XINT (in_rtx, i) >= 0
 322               && (name = get_insn_name (XINT (in_rtx, i))) != NULL)
 323             fprintf (outfile, " {%s}", name);
 324           sawclose = 0;
 325         }
 326         break;
 327
 328       /* Print NOTE_INSN names rather than integer codes.  */
 329
 330       case 'n':
 331         if (XINT (in_rtx, i) <= 0)
 332           fprintf (outfile, " %s", GET_NOTE_INSN_NAME (XINT (in_rtx, i)));
 333         else
 334           fprintf (outfile, " %d", XINT (in_rtx, i));
 335         sawclose = 0;
 336         break;
 337
 338       case 'u':
 339         if (XEXP (in_rtx, i) != NULL)
 340           {
 341             rtx sub = XEXP (in_rtx, i);
 342             enum rtx_code subc = GET_CODE (sub);
 343
 344             if (GET_CODE (in_rtx) == LABEL_REF)
 345               {
 346                 if (subc == NOTE
 347                     && NOTE_LINE_NUMBER (sub) == NOTE_INSN_DELETED_LABEL)
 348                   {
 349                     if (flag_dump_unnumbered)
 350                       fprintf (outfile, " [# deleted]");
 351                     else
 352                       fprintf (outfile, " [%d deleted]", INSN_UID (sub));
 353                     sawclose = 0;
 354                     break;
 355                   }
 356
 357                 if (subc != CODE_LABEL)
 358                   goto do_e;
 359               }
 360
 361             if (flag_dump_unnumbered)
 362               fputs (" #", outfile);
 363             else
 364               fprintf (outfile, " %d", INSN_UID (sub));
 365           }
 366         else
 367           fputs (" 0", outfile);
 368         sawclose = 0;
 369         break;
 370
 371       case 'b':
 372         if (XBITMAP (in_rtx, i) == NULL)
 373           fputs (" {null}", outfile);
 374         else
 375           bitmap_print (outfile, XBITMAP (in_rtx, i), " {", "}");
 376         sawclose = 0;
 377         break;
 378
 379       case 't':
 380         putc (' ', outfile);
 381         fprintf (outfile, HOST_PTR_PRINTF, (char *) XTREE (in_rtx, i));
 382         break;
 383
 384       case '*':
 385         fputs (" Unknown", outfile);
 386         sawclose = 0;
 387         break;
 388
 389       default:
 390         fprintf (stderr,
 391                  "switch format wrong in rtl.print_rtx(). format was: %c.\n",
 392                  format_ptr[-1]);
 393         abort ();
 394       }
 395
 396   switch (GET_CODE (in_rtx))
 397     {
 398     case MEM:
 399       fprintf (outfile, " %d", MEM_ALIAS_SET (in_rtx));
 400       break;
 401
 402 #if HOST_FLOAT_FORMAT == TARGET_FLOAT_FORMAT && MAX_LONG_DOUBLE_TYPE_SIZE == 64
 403     case CONST_DOUBLE:
 404       if (FLOAT_MODE_P (GET_MODE (in_rtx)))
 405         {
 406           double val;
 407           REAL_VALUE_FROM_CONST_DOUBLE (val, in_rtx);
 408           fprintf (outfile, " [%.16g]", val);
 409         }
 410       break;
 411 #endif
 412
 413     case CODE_LABEL:
 414       fprintf (outfile, " [%d uses]", LABEL_NUSES (in_rtx));
 415       if (LABEL_ALTERNATE_NAME (in_rtx))
 416         fprintf (outfile, " [alternate name: %s]",
 417                  LABEL_ALTERNATE_NAME (in_rtx));
 418       break;
 419
 420     case CALL_PLACEHOLDER:
 421       for (tem = XEXP (in_rtx, 0); tem != 0; tem = NEXT_INSN (tem))
 422         if (GET_CODE (tem) == CALL_INSN)
 423           {
 424             fprintf (outfile, " ");
 425             print_rtx (tem);
 426             break;
 427           }
 428       break;
 429
 430     default:
 431       break;
 432     }
 433
 434   if (dump_for_graph
 435       && (is_insn || GET_CODE (in_rtx) == NOTE
 436           || GET_CODE (in_rtx) == CODE_LABEL || GET_CODE (in_rtx) == BARRIER))
 437     sawclose = 0;
 438   else
 439     {
 440       fputc (')', outfile);
 441       sawclose = 1;
 442     }
 443 }
 444
 445 /* Print an rtx on the current line of FILE.  Initially indent IND
 446    characters.  */
 447
 448 void
 449 print_inline_rtx (outf, x, ind)
 450      FILE *outf;
 451      rtx x;
 452      int ind;
 453 {
 454   int oldsaw = sawclose;
 455   int oldindent = indent;
 456
 457   sawclose = 0;
 458   indent = ind;
 459   outfile = outf;
 460   print_rtx (x);
 461   sawclose = oldsaw;
 462   indent = oldindent;
 463 }
 464
 465 /* Call this function from the debugger to see what X looks like.  */
 466
 467 void
 468 debug_rtx (x)
 469      rtx x;
 470 {
 471   outfile = stderr;
 472   print_rtx (x);
 473   fprintf (stderr, "\n");
 474 }
 475
 476 /* Count of rtx's to print with debug_rtx_list.
 477    This global exists because gdb user defined commands have no arguments.  */
 478
 479 int debug_rtx_count = 0;        /* 0 is treated as equivalent to 1 */
 480
 481 /* Call this function to print list from X on.
 482
 483    N is a count of the rtx's to print. Positive values print from the specified
 484    rtx on.  Negative values print a window around the rtx.
 485    EG: -5 prints 2 rtx's on either side (in addition to the specified rtx).  */
 486
 487 void
 488 debug_rtx_list (x, n)
 489      rtx x;
 490      int n;
 491 {
 492   int i,count;
 493   rtx insn;
 494
 495   count = n == 0 ? 1 : n < 0 ? -n : n;
 496
 497   /* If we are printing a window, back up to the start.  */
 498
 499   if (n < 0)
 500     for (i = count / 2; i > 0; i--)
 501       {
 502         if (PREV_INSN (x) == 0)
 503           break;
 504         x = PREV_INSN (x);
 505       }
 506
 507   for (i = count, insn = x; i > 0 && insn != 0; i--, insn = NEXT_INSN (insn))
 508     debug_rtx (insn);
 509 }
 510
 511 /* Call this function to print an rtx list from START to END inclusive.  */
 512
 513 void
 514 debug_rtx_range (start, end)
 515      rtx start, end;
 516 {
 517   while (1)
 518     {
 519       debug_rtx (start);
 520       if (!start || start == end)
 521         break;
 522       start = NEXT_INSN (start);
 523     }
 524 }
 525
 526 /* Call this function to search an rtx list to find one with insn uid UID,
 527    and then call debug_rtx_list to print it, using DEBUG_RTX_COUNT.
 528    The found insn is returned to enable further debugging analysis.  */
 529
 530 rtx
 531 debug_rtx_find (x, uid)
 532      rtx x;
 533      int uid;
 534 {
 535   while (x != 0 && INSN_UID (x) != uid)
 536     x = NEXT_INSN (x);
 537   if (x != 0)
 538     {
 539       debug_rtx_list (x, debug_rtx_count);
 540       return x;
 541     }
 542   else
 543     {
 544       fprintf (stderr, "insn uid %d not found\n", uid);
 545       return 0;
 546     }
 547 }
 548
 549 /* External entry point for printing a chain of insns
 550    starting with RTX_FIRST onto file OUTF.
 551    A blank line separates insns.
 552
 553    If RTX_FIRST is not an insn, then it alone is printed, with no newline.  */
 554
 555 void
 556 print_rtl (outf, rtx_first)
 557      FILE *outf;
 558      rtx rtx_first;
 559 {
 560   register rtx tmp_rtx;
 561
 562   outfile = outf;
 563   sawclose = 0;
 564
 565   if (rtx_first == 0)
 566     fputs ("(nil)\n", outf);
 567   else
 568     switch (GET_CODE (rtx_first))
 569       {
 570       case INSN:
 571       case JUMP_INSN:
 572       case CALL_INSN:
 573       case NOTE:
 574       case CODE_LABEL:
 575       case BARRIER:
 576         for (tmp_rtx = rtx_first; tmp_rtx != 0; tmp_rtx = NEXT_INSN (tmp_rtx))
 577           if (! flag_dump_unnumbered
 578               || GET_CODE (tmp_rtx) != NOTE || NOTE_LINE_NUMBER (tmp_rtx) < 0)
 579             {
 580               print_rtx (tmp_rtx);
 581               fprintf (outfile, "\n");
 582             }
 583         break;
 584
 585       default:
 586         print_rtx (rtx_first);
 587       }
 588 }
 589
 590 /* Like print_rtx, except specify a file.  */
 591 /* Return nonzero if we actually printed anything.  */
 592
 593 int
 594 print_rtl_single (outf, x)
 595      FILE *outf;
 596      rtx x;
 597 {
 598   outfile = outf;
 599   sawclose = 0;
 600   if (! flag_dump_unnumbered
 601       || GET_CODE (x) != NOTE || NOTE_LINE_NUMBER (x) < 0)
 602     {
 603       print_rtx (x);
 604       putc ('\n', outf);
 605       return 1;
 606     }
 607   return 0;
 608 }