gcc/print-rtl.c

   1 /* Print RTL for GNU C Compiler.
   2    Copyright (C) 1987, 1988, 1992, 1997, 1998, 1999 Free Software Foundation, Inc.
   3
   4 This file is part of GNU CC.
   5
   6 GNU CC is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU CC is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU CC; see the file COPYING.  If not, write to
  18 the Free Software Foundation, 59 Temple Place - Suite 330,
  19 Boston, MA 02111-1307, USA.  */
  20
  21
  22 #include "config.h"
  23 #include "system.h"
  24 #include "rtl.h"
  25 #include "real.h"
  26 #include "flags.h"
  27 #include "basic-block.h"
  28
  29
  30 /* How to print out a register name.
  31    We don't use PRINT_REG because some definitions of PRINT_REG
  32    don't work here.  */
  33 #ifndef DEBUG_PRINT_REG
  34 #define DEBUG_PRINT_REG(RTX, CODE, FILE) \
  35   fprintf ((FILE), "%d %s", REGNO (RTX), reg_names[REGNO (RTX)])
  36 #endif
  37
  38 /* Array containing all of the register names */
  39
  40 #ifdef DEBUG_REGISTER_NAMES
  41 static char *reg_names[] = DEBUG_REGISTER_NAMES;
  42 #else
  43 static char *reg_names[] = REGISTER_NAMES;
  44 #endif
  45
  46 static FILE *outfile;
  47
  48 static const char xspaces[] = "                                                                                                                                                                ";
  49
  50 static int sawclose = 0;
  51
  52 static int indent;
  53
  54 /* Names for patterns.  Non-zero only when linked with insn-output.c.  */
  55
  56 extern char **insn_name_ptr;
  57
  58 static void print_rtx           PROTO ((rtx));
  59
  60 /* Nonzero means suppress output of instruction numbers and line number
  61    notes in debugging dumps.
  62    This must be defined here so that programs like gencodes can be linked.  */
  63 int flag_dump_unnumbered = 0;
  64
  65 /* Nonzero if we are dumping graphical description.  */
  66 int dump_for_graph;
  67
  68 /* Print IN_RTX onto OUTFILE.  This is the recursive part of printing.  */
  69
  70 static void
  71 print_rtx (in_rtx)
  72      register rtx in_rtx;
  73 {
  74   register int i = 0;
  75   register int j;
  76   register char *format_ptr;
  77   register int is_insn;
  78
  79   if (sawclose)
  80     {
  81       fprintf (outfile, "\n%s",
  82                (xspaces + (sizeof xspaces - 1 - indent * 2)));
  83       sawclose = 0;
  84     }
  85
  86   if (in_rtx == 0)
  87     {
  88       fputs ("(nil)", outfile);
  89       sawclose = 1;
  90       return;
  91     }
  92
  93   is_insn = (GET_RTX_CLASS (GET_CODE (in_rtx)) == 'i');
  94
  95   /* When printing in VCG format we write INSNs, NOTE, LABEL, and BARRIER
  96      in separate nodes and therefore have to handle them special here.  */
  97   if (dump_for_graph &&
  98       (is_insn || GET_CODE (in_rtx) == NOTE || GET_CODE (in_rtx) == CODE_LABEL
  99        || GET_CODE (in_rtx) == BARRIER))
 100     {
 101       i = 3;
 102       indent = 0;
 103     }
 104   else
 105     {
 106       /* print name of expression code */
 107       fprintf (outfile, "(%s", GET_RTX_NAME (GET_CODE (in_rtx)));
 108
 109       if (in_rtx->in_struct)
 110         fputs ("/s", outfile);
 111
 112       if (in_rtx->volatil)
 113         fputs ("/v", outfile);
 114
 115       if (in_rtx->unchanging)
 116         fputs ("/u", outfile);
 117
 118       if (in_rtx->integrated)
 119         fputs ("/i", outfile);
 120
 121       if (in_rtx->frame_related)
 122         fputs ("/f", outfile);
 123
 124       if (in_rtx->jump)
 125         fputs ("/j", outfile);
 126
 127       if (in_rtx->call)
 128         fputs ("/c", outfile);
 129
 130       if (GET_MODE (in_rtx) != VOIDmode)
 131         {
 132           /* Print REG_NOTE names for EXPR_LIST and INSN_LIST.  */
 133           if (GET_CODE (in_rtx) == EXPR_LIST || GET_CODE (in_rtx) == INSN_LIST)
 134             fprintf (outfile, ":%s", GET_REG_NOTE_NAME (GET_MODE (in_rtx)));
 135           else
 136             fprintf (outfile, ":%s", GET_MODE_NAME (GET_MODE (in_rtx)));
 137         }
 138     }
 139
 140   /* Get the format string and skip the first elements if we have handled
 141      them already.  */
 142   format_ptr = GET_RTX_FORMAT (GET_CODE (in_rtx)) + i;
 143
 144   for (; i < GET_RTX_LENGTH (GET_CODE (in_rtx)); i++)
 145     switch (*format_ptr++)
 146       {
 147       case 'S':
 148       case 's':
 149         if (i == 3 && GET_CODE (in_rtx) == NOTE
 150             && (NOTE_LINE_NUMBER (in_rtx) == NOTE_INSN_EH_REGION_BEG
 151                 || NOTE_LINE_NUMBER (in_rtx) == NOTE_INSN_EH_REGION_END
 152                 || NOTE_LINE_NUMBER (in_rtx) == NOTE_INSN_BLOCK_BEG
 153                 || NOTE_LINE_NUMBER (in_rtx) == NOTE_INSN_BLOCK_END))
 154           {
 155             fprintf (outfile, " %d", NOTE_BLOCK_NUMBER (in_rtx));
 156             sawclose = 1;
 157             break;
 158           }
 159
 160         if (i == 3 && GET_CODE (in_rtx) == NOTE
 161             && (NOTE_LINE_NUMBER (in_rtx) == NOTE_INSN_RANGE_START
 162                 || NOTE_LINE_NUMBER (in_rtx) == NOTE_INSN_RANGE_END
 163                 || NOTE_LINE_NUMBER (in_rtx) == NOTE_INSN_LIVE))
 164           {
 165             indent += 2;
 166             if (!sawclose)
 167               fprintf (outfile, " ");
 168             print_rtx (NOTE_RANGE_INFO (in_rtx));
 169             indent -= 2;
 170             break;
 171           }
 172
 173         if (i == 3 && GET_CODE (in_rtx) == NOTE
 174             && NOTE_LINE_NUMBER (in_rtx) == NOTE_INSN_BASIC_BLOCK)
 175           {
 176             basic_block bb = NOTE_BASIC_BLOCK (in_rtx);
 177             fprintf (outfile, " [bb %d]", bb->index);
 178             break;
 179           }
 180
 181         if (XSTR (in_rtx, i) == 0)
 182           fputs (dump_for_graph ? " \\\"\\\"" : " \"\"", outfile);
 183         else
 184           fprintf (outfile, dump_for_graph ? " (\\\"%s\\\")" : " (\"%s\")",
 185                    XSTR (in_rtx, i));
 186         sawclose = 1;
 187         break;
 188
 189         /* 0 indicates a field for internal use that should not be printed.  */
 190       case '0':
 191         break;
 192
 193       case 'e':
 194         indent += 2;
 195         if (!sawclose)
 196           fprintf (outfile, " ");
 197         print_rtx (XEXP (in_rtx, i));
 198         indent -= 2;
 199         break;
 200
 201       case 'E':
 202       case 'V':
 203         indent += 2;
 204         if (sawclose)
 205           {
 206             fprintf (outfile, "\n%s",
 207                      (xspaces + (sizeof xspaces - 1 - indent * 2)));
 208             sawclose = 0;
 209           }
 210         fputs ("[ ", outfile);
 211         if (NULL != XVEC (in_rtx, i))
 212           {
 213             indent += 2;
 214             if (XVECLEN (in_rtx, i))
 215               sawclose = 1;
 216
 217             for (j = 0; j < XVECLEN (in_rtx, i); j++)
 218               print_rtx (XVECEXP (in_rtx, i, j));
 219
 220             indent -= 2;
 221           }
 222         if (sawclose)
 223           fprintf (outfile, "\n%s",
 224                    (xspaces + (sizeof xspaces - 1 - indent * 2)));
 225
 226         fputs ("] ", outfile);
 227         sawclose = 1;
 228         indent -= 2;
 229         break;
 230
 231       case 'w':
 232         fprintf (outfile, " ");
 233         fprintf (outfile, HOST_WIDE_INT_PRINT_DEC, XWINT (in_rtx, i));
 234         fprintf (outfile, " [");
 235         fprintf (outfile, HOST_WIDE_INT_PRINT_HEX, XWINT (in_rtx, i));
 236         fprintf (outfile, "]");
 237         break;
 238
 239       case 'i':
 240         {
 241           register int value = XINT (in_rtx, i);
 242
 243           if (GET_CODE (in_rtx) == REG && value < FIRST_PSEUDO_REGISTER)
 244             {
 245               fputc (' ', outfile);
 246               DEBUG_PRINT_REG (in_rtx, 0, outfile);
 247             }
 248           else if (GET_CODE (in_rtx) == REG && value <= LAST_VIRTUAL_REGISTER)
 249             {
 250               if (value == VIRTUAL_INCOMING_ARGS_REGNUM)
 251                 fprintf (outfile, " %d virtual-incoming-args", value);
 252               else if (value == VIRTUAL_STACK_VARS_REGNUM)
 253                 fprintf (outfile, " %d virtual-stack-vars", value);
 254               else if (value == VIRTUAL_STACK_DYNAMIC_REGNUM)
 255                 fprintf (outfile, " %d virtual-stack-dynamic", value);
 256               else if (value == VIRTUAL_OUTGOING_ARGS_REGNUM)
 257                 fprintf (outfile, " %d virtual-outgoing-args", value);
 258               else if (value == VIRTUAL_CFA_REGNUM)
 259                 fprintf (outfile, " %d virtual-cfa", value);
 260               else
 261                 fprintf (outfile, " %d virtual-reg-%d", value,
 262                          value-FIRST_VIRTUAL_REGISTER);
 263             }
 264           else if (flag_dump_unnumbered
 265                    && (is_insn || GET_CODE (in_rtx) == NOTE))
 266             fputc ('#', outfile);
 267           else
 268             fprintf (outfile, " %d", value);
 269         }
 270         if (is_insn && &INSN_CODE (in_rtx) == &XINT (in_rtx, i)
 271             && insn_name_ptr
 272             && XINT (in_rtx, i) >= 0)
 273           fprintf (outfile, " {%s}", insn_name_ptr[XINT (in_rtx, i)]);
 274         sawclose = 0;
 275         break;
 276
 277       /* Print NOTE_INSN names rather than integer codes.  */
 278
 279       case 'n':
 280         if (XINT (in_rtx, i) <= 0)
 281           fprintf (outfile, " %s", GET_NOTE_INSN_NAME (XINT (in_rtx, i)));
 282         else
 283           fprintf (outfile, " %d", XINT (in_rtx, i));
 284         sawclose = 0;
 285         break;
 286
 287       case 'u':
 288         if (XEXP (in_rtx, i) != NULL)
 289           {
 290             if (flag_dump_unnumbered)
 291               fputc ('#', outfile);
 292             else
 293               fprintf (outfile, " %d", INSN_UID (XEXP (in_rtx, i)));
 294           }
 295         else
 296           fputs (" 0", outfile);
 297         sawclose = 0;
 298         break;
 299
 300       case 'b':
 301         if (XBITMAP (in_rtx, i) == NULL)
 302           fputs (" {null}", outfile);
 303         else
 304           bitmap_print (outfile, XBITMAP (in_rtx, i), " {", "}");
 305         sawclose = 0;
 306         break;
 307
 308       case 't':
 309         putc (' ', outfile);
 310         fprintf (outfile, HOST_PTR_PRINTF, (char *) XTREE (in_rtx, i));
 311         break;
 312
 313       case '*':
 314         fputs (" Unknown", outfile);
 315         sawclose = 0;
 316         break;
 317
 318       default:
 319         fprintf (stderr,
 320                  "switch format wrong in rtl.print_rtx(). format was: %c.\n",
 321                  format_ptr[-1]);
 322         abort ();
 323       }
 324
 325   if (GET_CODE (in_rtx) == MEM)
 326     fprintf (outfile, " %d", MEM_ALIAS_SET (in_rtx));
 327
 328 #if HOST_FLOAT_FORMAT == TARGET_FLOAT_FORMAT && LONG_DOUBLE_TYPE_SIZE == 64
 329   if (GET_CODE (in_rtx) == CONST_DOUBLE && FLOAT_MODE_P (GET_MODE (in_rtx)))
 330     {
 331       double val;
 332       REAL_VALUE_FROM_CONST_DOUBLE (val, in_rtx);
 333       fprintf (outfile, " [%.16g]", val);
 334     }
 335 #endif
 336
 337   if (GET_CODE (in_rtx) == CODE_LABEL)
 338     fprintf (outfile, " [num uses: %d]", LABEL_NUSES (in_rtx));
 339
 340   if (dump_for_graph
 341       && (is_insn || GET_CODE (in_rtx) == NOTE
 342           || GET_CODE (in_rtx) == CODE_LABEL || GET_CODE (in_rtx) == BARRIER))
 343     sawclose = 0;
 344   else
 345     {
 346       fputc (')', outfile);
 347       sawclose = 1;
 348     }
 349 }
 350
 351 /* Print an rtx on the current line of FILE.  Initially indent IND
 352    characters.  */
 353
 354 void
 355 print_inline_rtx (outf, x, ind)
 356      FILE *outf;
 357      rtx x;
 358      int ind;
 359 {
 360   int oldsaw = sawclose;
 361   int oldindent = indent;
 362
 363   sawclose = 0;
 364   indent = ind;
 365   outfile = outf;
 366   print_rtx (x);
 367   sawclose = oldsaw;
 368   indent = oldindent;
 369 }
 370
 371 /* Call this function from the debugger to see what X looks like.  */
 372
 373 void
 374 debug_rtx (x)
 375      rtx x;
 376 {
 377   outfile = stderr;
 378   print_rtx (x);
 379   fprintf (stderr, "\n");
 380 }
 381
 382 /* Count of rtx's to print with debug_rtx_list.
 383    This global exists because gdb user defined commands have no arguments.  */
 384
 385 int debug_rtx_count = 0;        /* 0 is treated as equivalent to 1 */
 386
 387 /* Call this function to print list from X on.
 388
 389    N is a count of the rtx's to print. Positive values print from the specified
 390    rtx on.  Negative values print a window around the rtx.
 391    EG: -5 prints 2 rtx's on either side (in addition to the specified rtx).  */
 392
 393 void
 394 debug_rtx_list (x, n)
 395      rtx x;
 396      int n;
 397 {
 398   int i,count;
 399   rtx insn;
 400
 401   count = n == 0 ? 1 : n < 0 ? -n : n;
 402
 403   /* If we are printing a window, back up to the start.  */
 404
 405   if (n < 0)
 406     for (i = count / 2; i > 0; i--)
 407       {
 408         if (PREV_INSN (x) == 0)
 409           break;
 410         x = PREV_INSN (x);
 411       }
 412
 413   for (i = count, insn = x; i > 0 && insn != 0; i--, insn = NEXT_INSN (insn))
 414     debug_rtx (insn);
 415 }
 416
 417 /* Call this function to search an rtx list to find one with insn uid UID,
 418    and then call debug_rtx_list to print it, using DEBUG_RTX_COUNT.
 419    The found insn is returned to enable further debugging analysis.  */
 420
 421 rtx
 422 debug_rtx_find (x, uid)
 423      rtx x;
 424      int uid;
 425 {
 426   while (x != 0 && INSN_UID (x) != uid)
 427     x = NEXT_INSN (x);
 428   if (x != 0)
 429     {
 430       debug_rtx_list (x, debug_rtx_count);
 431       return x;
 432     }
 433   else
 434     {
 435       fprintf (stderr, "insn uid %d not found\n", uid);
 436       return 0;
 437     }
 438 }
 439
 440 /* External entry point for printing a chain of insns
 441    starting with RTX_FIRST onto file OUTF.
 442    A blank line separates insns.
 443
 444    If RTX_FIRST is not an insn, then it alone is printed, with no newline.  */
 445
 446 void
 447 print_rtl (outf, rtx_first)
 448      FILE *outf;
 449      rtx rtx_first;
 450 {
 451   register rtx tmp_rtx;
 452
 453   outfile = outf;
 454   sawclose = 0;
 455
 456   if (rtx_first == 0)
 457     fputs ("(nil)\n", outf);
 458   else
 459     switch (GET_CODE (rtx_first))
 460       {
 461       case INSN:
 462       case JUMP_INSN:
 463       case CALL_INSN:
 464       case NOTE:
 465       case CODE_LABEL:
 466       case BARRIER:
 467         for (tmp_rtx = rtx_first; NULL != tmp_rtx; tmp_rtx = NEXT_INSN (tmp_rtx))
 468           {
 469             if (! flag_dump_unnumbered
 470                 || GET_CODE (tmp_rtx) != NOTE
 471                 || NOTE_LINE_NUMBER (tmp_rtx) < 0)
 472               {
 473                 print_rtx (tmp_rtx);
 474                 fprintf (outfile, "\n");
 475               }
 476           }
 477         break;
 478
 479       default:
 480         print_rtx (rtx_first);
 481       }
 482 }
 483
 484 /* Like print_rtx, except specify a file.  */
 485 /* Return nonzero if we actually printed anything.  */
 486
 487 int
 488 print_rtl_single (outf, x)
 489      FILE *outf;
 490      rtx x;
 491 {
 492   outfile = outf;
 493   sawclose = 0;
 494   if (! flag_dump_unnumbered
 495       || GET_CODE (x) != NOTE || NOTE_LINE_NUMBER (x) < 0)
 496     {
 497       print_rtx (x);
 498       putc ('\n', outf);
 499       return 1;
 500     }
 501   return 0;
 502 }