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               default:
 214                 {
 215                   const char * const str = X0STR (in_rtx, i);
 216
 217                   if (NOTE_LINE_NUMBER (in_rtx) < 0)
 218                     ;
 219                   else if (str == 0)
 220                     fputs (dump_for_graph ? " \\\"\\\"" : " \"\"", outfile);
 221                   else
 222                     {
 223                       if (dump_for_graph)
 224                         fprintf (outfile, " (\\\"%s\\\")", str);
 225                       else
 226                         fprintf (outfile, " (\"%s\")", str);
 227                     }
 228                   break;
 229                 }
 230               }
 231           }
 232         break;
 233
 234       case 'e':
 235       do_e:
 236         indent += 2;
 237         if (!sawclose)
 238           fprintf (outfile, " ");
 239         print_rtx (XEXP (in_rtx, i));
 240         indent -= 2;
 241         break;
 242
 243       case 'E':
 244       case 'V':
 245         indent += 2;
 246         if (sawclose)
 247           {
 248             fprintf (outfile, "\n%s",
 249                      (xspaces + (sizeof xspaces - 1 - indent * 2)));
 250             sawclose = 0;
 251           }
 252         fputs ("[ ", outfile);
 253         if (NULL != XVEC (in_rtx, i))
 254           {
 255             indent += 2;
 256             if (XVECLEN (in_rtx, i))
 257               sawclose = 1;
 258
 259             for (j = 0; j < XVECLEN (in_rtx, i); j++)
 260               print_rtx (XVECEXP (in_rtx, i, j));
 261
 262             indent -= 2;
 263           }
 264         if (sawclose)
 265           fprintf (outfile, "\n%s",
 266                    (xspaces + (sizeof xspaces - 1 - indent * 2)));
 267
 268         fputs ("] ", outfile);
 269         sawclose = 1;
 270         indent -= 2;
 271         break;
 272
 273       case 'w':
 274         fprintf (outfile, " ");
 275         fprintf (outfile, HOST_WIDE_INT_PRINT_DEC, XWINT (in_rtx, i));
 276         fprintf (outfile, " [");
 277         fprintf (outfile, HOST_WIDE_INT_PRINT_HEX, XWINT (in_rtx, i));
 278         fprintf (outfile, "]");
 279         break;
 280
 281       case 'i':
 282         {
 283           register int value = XINT (in_rtx, i);
 284           const char *name;
 285
 286           if (GET_CODE (in_rtx) == REG && value < FIRST_PSEUDO_REGISTER)
 287             {
 288               fputc (' ', outfile);
 289               DEBUG_PRINT_REG (in_rtx, 0, outfile);
 290             }
 291           else if (GET_CODE (in_rtx) == REG && value <= LAST_VIRTUAL_REGISTER)
 292             {
 293               if (value == VIRTUAL_INCOMING_ARGS_REGNUM)
 294                 fprintf (outfile, " %d virtual-incoming-args", value);
 295               else if (value == VIRTUAL_STACK_VARS_REGNUM)
 296                 fprintf (outfile, " %d virtual-stack-vars", value);
 297               else if (value == VIRTUAL_STACK_DYNAMIC_REGNUM)
 298                 fprintf (outfile, " %d virtual-stack-dynamic", value);
 299               else if (value == VIRTUAL_OUTGOING_ARGS_REGNUM)
 300                 fprintf (outfile, " %d virtual-outgoing-args", value);
 301               else if (value == VIRTUAL_CFA_REGNUM)
 302                 fprintf (outfile, " %d virtual-cfa", value);
 303               else
 304                 fprintf (outfile, " %d virtual-reg-%d", value,
 305                          value-FIRST_VIRTUAL_REGISTER);
 306             }
 307           else if (flag_dump_unnumbered
 308                    && (is_insn || GET_CODE (in_rtx) == NOTE))
 309             fputc ('#', outfile);
 310           else
 311             fprintf (outfile, " %d", value);
 312
 313           if (is_insn && &INSN_CODE (in_rtx) == &XINT (in_rtx, i)
 314               && XINT (in_rtx, i) >= 0
 315               && (name = get_insn_name (XINT (in_rtx, i))) != NULL)
 316             fprintf (outfile, " {%s}", name);
 317           sawclose = 0;
 318         }
 319         break;
 320
 321       /* Print NOTE_INSN names rather than integer codes.  */
 322
 323       case 'n':
 324         if (XINT (in_rtx, i) <= 0)
 325           fprintf (outfile, " %s", GET_NOTE_INSN_NAME (XINT (in_rtx, i)));
 326         else
 327           fprintf (outfile, " %d", XINT (in_rtx, i));
 328         sawclose = 0;
 329         break;
 330
 331       case 'u':
 332         if (XEXP (in_rtx, i) != NULL)
 333           {
 334             rtx sub = XEXP (in_rtx, i);
 335             enum rtx_code subc = GET_CODE (sub);
 336
 337             if (GET_CODE (in_rtx) == LABEL_REF && subc != CODE_LABEL)
 338               goto do_e;
 339
 340             if (flag_dump_unnumbered)
 341               fputc ('#', outfile);
 342             else
 343               fprintf (outfile, " %d", INSN_UID (sub));
 344           }
 345         else
 346           fputs (" 0", outfile);
 347         sawclose = 0;
 348         break;
 349
 350       case 'b':
 351         if (XBITMAP (in_rtx, i) == NULL)
 352           fputs (" {null}", outfile);
 353         else
 354           bitmap_print (outfile, XBITMAP (in_rtx, i), " {", "}");
 355         sawclose = 0;
 356         break;
 357
 358       case 't':
 359         putc (' ', outfile);
 360         fprintf (outfile, HOST_PTR_PRINTF, (char *) XTREE (in_rtx, i));
 361         break;
 362
 363       case '*':
 364         fputs (" Unknown", outfile);
 365         sawclose = 0;
 366         break;
 367
 368       default:
 369         fprintf (stderr,
 370                  "switch format wrong in rtl.print_rtx(). format was: %c.\n",
 371                  format_ptr[-1]);
 372         abort ();
 373       }
 374
 375   if (GET_CODE (in_rtx) == MEM)
 376     fprintf (outfile, " %d", MEM_ALIAS_SET (in_rtx));
 377
 378 #if HOST_FLOAT_FORMAT == TARGET_FLOAT_FORMAT && MAX_LONG_DOUBLE_TYPE_SIZE == 64
 379   if (GET_CODE (in_rtx) == CONST_DOUBLE && FLOAT_MODE_P (GET_MODE (in_rtx)))
 380     {
 381       double val;
 382       REAL_VALUE_FROM_CONST_DOUBLE (val, in_rtx);
 383       fprintf (outfile, " [%.16g]", val);
 384     }
 385 #endif
 386
 387   if (GET_CODE (in_rtx) == CODE_LABEL)
 388     {
 389       fprintf (outfile, " [%d uses]", LABEL_NUSES (in_rtx));
 390       if (LABEL_ALTERNATE_NAME (in_rtx))
 391         fprintf (outfile, " [alternate name: %s]",
 392                  LABEL_ALTERNATE_NAME (in_rtx));
 393     }
 394
 395   if (GET_CODE (in_rtx) == CALL_PLACEHOLDER)
 396     for (tem = XEXP (in_rtx, 0); tem != 0; tem = NEXT_INSN (tem))
 397       if (GET_CODE (tem) == CALL_INSN)
 398         {
 399           fprintf (outfile, " ");
 400           print_rtx (tem);
 401           break;
 402         }
 403
 404   if (dump_for_graph
 405       && (is_insn || GET_CODE (in_rtx) == NOTE
 406           || GET_CODE (in_rtx) == CODE_LABEL || GET_CODE (in_rtx) == BARRIER))
 407     sawclose = 0;
 408   else
 409     {
 410       fputc (')', outfile);
 411       sawclose = 1;
 412     }
 413 }
 414
 415 /* Print an rtx on the current line of FILE.  Initially indent IND
 416    characters.  */
 417
 418 void
 419 print_inline_rtx (outf, x, ind)
 420      FILE *outf;
 421      rtx x;
 422      int ind;
 423 {
 424   int oldsaw = sawclose;
 425   int oldindent = indent;
 426
 427   sawclose = 0;
 428   indent = ind;
 429   outfile = outf;
 430   print_rtx (x);
 431   sawclose = oldsaw;
 432   indent = oldindent;
 433 }
 434
 435 /* Call this function from the debugger to see what X looks like.  */
 436
 437 void
 438 debug_rtx (x)
 439      rtx x;
 440 {
 441   outfile = stderr;
 442   print_rtx (x);
 443   fprintf (stderr, "\n");
 444 }
 445
 446 /* Count of rtx's to print with debug_rtx_list.
 447    This global exists because gdb user defined commands have no arguments.  */
 448
 449 int debug_rtx_count = 0;        /* 0 is treated as equivalent to 1 */
 450
 451 /* Call this function to print list from X on.
 452
 453    N is a count of the rtx's to print. Positive values print from the specified
 454    rtx on.  Negative values print a window around the rtx.
 455    EG: -5 prints 2 rtx's on either side (in addition to the specified rtx).  */
 456
 457 void
 458 debug_rtx_list (x, n)
 459      rtx x;
 460      int n;
 461 {
 462   int i,count;
 463   rtx insn;
 464
 465   count = n == 0 ? 1 : n < 0 ? -n : n;
 466
 467   /* If we are printing a window, back up to the start.  */
 468
 469   if (n < 0)
 470     for (i = count / 2; i > 0; i--)
 471       {
 472         if (PREV_INSN (x) == 0)
 473           break;
 474         x = PREV_INSN (x);
 475       }
 476
 477   for (i = count, insn = x; i > 0 && insn != 0; i--, insn = NEXT_INSN (insn))
 478     debug_rtx (insn);
 479 }
 480
 481 /* Call this function to print an rtx list from START to END inclusive.  */
 482
 483 void
 484 debug_rtx_range (start, end)
 485      rtx start, end;
 486 {
 487   while (1)
 488     {
 489       debug_rtx (start);
 490       if (!start || start == end)
 491         break;
 492       start = NEXT_INSN (start);
 493     }
 494 }
 495
 496 /* Call this function to search an rtx list to find one with insn uid UID,
 497    and then call debug_rtx_list to print it, using DEBUG_RTX_COUNT.
 498    The found insn is returned to enable further debugging analysis.  */
 499
 500 rtx
 501 debug_rtx_find (x, uid)
 502      rtx x;
 503      int uid;
 504 {
 505   while (x != 0 && INSN_UID (x) != uid)
 506     x = NEXT_INSN (x);
 507   if (x != 0)
 508     {
 509       debug_rtx_list (x, debug_rtx_count);
 510       return x;
 511     }
 512   else
 513     {
 514       fprintf (stderr, "insn uid %d not found\n", uid);
 515       return 0;
 516     }
 517 }
 518
 519 /* External entry point for printing a chain of insns
 520    starting with RTX_FIRST onto file OUTF.
 521    A blank line separates insns.
 522
 523    If RTX_FIRST is not an insn, then it alone is printed, with no newline.  */
 524
 525 void
 526 print_rtl (outf, rtx_first)
 527      FILE *outf;
 528      rtx rtx_first;
 529 {
 530   register rtx tmp_rtx;
 531
 532   outfile = outf;
 533   sawclose = 0;
 534
 535   if (rtx_first == 0)
 536     fputs ("(nil)\n", outf);
 537   else
 538     switch (GET_CODE (rtx_first))
 539       {
 540       case INSN:
 541       case JUMP_INSN:
 542       case CALL_INSN:
 543       case NOTE:
 544       case CODE_LABEL:
 545       case BARRIER:
 546         for (tmp_rtx = rtx_first; tmp_rtx != 0; tmp_rtx = NEXT_INSN (tmp_rtx))
 547           if (! flag_dump_unnumbered
 548               || GET_CODE (tmp_rtx) != NOTE || NOTE_LINE_NUMBER (tmp_rtx) < 0)
 549             {
 550               print_rtx (tmp_rtx);
 551               fprintf (outfile, "\n");
 552             }
 553         break;
 554
 555       default:
 556         print_rtx (rtx_first);
 557       }
 558 }
 559
 560 /* Like print_rtx, except specify a file.  */
 561 /* Return nonzero if we actually printed anything.  */
 562
 563 int
 564 print_rtl_single (outf, x)
 565      FILE *outf;
 566      rtx x;
 567 {
 568   outfile = outf;
 569   sawclose = 0;
 570   if (! flag_dump_unnumbered
 571       || GET_CODE (x) != NOTE || NOTE_LINE_NUMBER (x) < 0)
 572     {
 573       print_rtx (x);
 574       putc ('\n', outf);
 575       return 1;
 576     }
 577   return 0;
 578 }