gcc/print-rtl.c

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