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