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