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