gcc/print-rtl.c

   1 /* Print RTL for GNU C Compiler.
   2    Copyright (C) 1987, 1988, 1992, 1997, 1998 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 "bitmap.h"
  26 #include "real.h"
  27 #include "flags.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 (GET_MODE (in_rtx) != VOIDmode)
 125         {
 126           /* Print REG_NOTE names for EXPR_LIST and INSN_LIST.  */
 127           if (GET_CODE (in_rtx) == EXPR_LIST || GET_CODE (in_rtx) == INSN_LIST)
 128             fprintf (outfile, ":%s", GET_REG_NOTE_NAME (GET_MODE (in_rtx)));
 129           else
 130             fprintf (outfile, ":%s", GET_MODE_NAME (GET_MODE (in_rtx)));
 131         }
 132     }
 133
 134   /* Get the format string and skip the first elements if we have handled
 135      them already.  */
 136   format_ptr = GET_RTX_FORMAT (GET_CODE (in_rtx)) + i;
 137
 138   for (; i < GET_RTX_LENGTH (GET_CODE (in_rtx)); i++)
 139     switch (*format_ptr++)
 140       {
 141       case 'S':
 142       case 's':
 143         if (i == 3 && GET_CODE (in_rtx) == NOTE
 144             && (NOTE_LINE_NUMBER (in_rtx) == NOTE_INSN_EH_REGION_BEG
 145                 || NOTE_LINE_NUMBER (in_rtx) == NOTE_INSN_EH_REGION_END
 146                 || NOTE_LINE_NUMBER (in_rtx) == NOTE_INSN_BLOCK_BEG
 147                 || NOTE_LINE_NUMBER (in_rtx) == NOTE_INSN_BLOCK_END))
 148           {
 149             fprintf (outfile, " %d", NOTE_BLOCK_NUMBER (in_rtx));
 150             sawclose = 1;
 151             break;
 152           }
 153
 154         if (i == 3 && GET_CODE (in_rtx) == NOTE
 155             && (NOTE_LINE_NUMBER (in_rtx) == NOTE_INSN_RANGE_START
 156                 || NOTE_LINE_NUMBER (in_rtx) == NOTE_INSN_RANGE_END
 157                 || NOTE_LINE_NUMBER (in_rtx) == NOTE_INSN_LIVE))
 158           {
 159             indent += 2;
 160             if (!sawclose)
 161               fprintf (outfile, " ");
 162             print_rtx (NOTE_RANGE_INFO (in_rtx));
 163             indent -= 2;
 164             break;
 165           }
 166
 167         if (XSTR (in_rtx, i) == 0)
 168           fputs (dump_for_graph ? " \\\"\\\"" : " \"\"", outfile);
 169         else
 170           fprintf (outfile, dump_for_graph ? " (\\\"%s\\\")" : " (\"%s\")",
 171                    XSTR (in_rtx, i));
 172         sawclose = 1;
 173         break;
 174
 175         /* 0 indicates a field for internal use that should not be printed.  */
 176       case '0':
 177         break;
 178
 179       case 'e':
 180         indent += 2;
 181         if (!sawclose)
 182           fprintf (outfile, " ");
 183         print_rtx (XEXP (in_rtx, i));
 184         indent -= 2;
 185         break;
 186
 187       case 'E':
 188       case 'V':
 189         indent += 2;
 190         if (sawclose)
 191           {
 192             fprintf (outfile, "\n%s",
 193                      (xspaces + (sizeof xspaces - 1 - indent * 2)));
 194             sawclose = 0;
 195           }
 196         fputs ("[ ", outfile);
 197         if (NULL != XVEC (in_rtx, i))
 198           {
 199             indent += 2;
 200             if (XVECLEN (in_rtx, i))
 201               sawclose = 1;
 202
 203             for (j = 0; j < XVECLEN (in_rtx, i); j++)
 204               print_rtx (XVECEXP (in_rtx, i, j));
 205
 206             indent -= 2;
 207           }
 208         if (sawclose)
 209           fprintf (outfile, "\n%s",
 210                    (xspaces + (sizeof xspaces - 1 - indent * 2)));
 211
 212         fputs ("] ", outfile);
 213         sawclose = 1;
 214         indent -= 2;
 215         break;
 216
 217       case 'w':
 218         fprintf (outfile, " ");
 219         fprintf (outfile, HOST_WIDE_INT_PRINT_DEC, XWINT (in_rtx, i));
 220         break;
 221
 222       case 'i':
 223         {
 224           register int value = XINT (in_rtx, i);
 225
 226           if (GET_CODE (in_rtx) == REG && value < FIRST_PSEUDO_REGISTER)
 227             {
 228               fputc (' ', outfile);
 229               DEBUG_PRINT_REG (in_rtx, 0, outfile);
 230             }
 231           else if (flag_dump_unnumbered
 232                    && (is_insn || GET_CODE (in_rtx) == NOTE))
 233             fputc ('#', outfile);
 234           else
 235             fprintf (outfile, " %d", value);
 236         }
 237         if (is_insn && &INSN_CODE (in_rtx) == &XINT (in_rtx, i)
 238             && insn_name_ptr
 239             && XINT (in_rtx, i) >= 0)
 240           fprintf (outfile, " {%s}", insn_name_ptr[XINT (in_rtx, i)]);
 241         sawclose = 0;
 242         break;
 243
 244       /* Print NOTE_INSN names rather than integer codes.  */
 245
 246       case 'n':
 247         if (XINT (in_rtx, i) <= 0)
 248           fprintf (outfile, " %s", GET_NOTE_INSN_NAME (XINT (in_rtx, i)));
 249         else
 250           fprintf (outfile, " %d", XINT (in_rtx, i));
 251         sawclose = 0;
 252         break;
 253
 254       case 'u':
 255         if (XEXP (in_rtx, i) != NULL)
 256           {
 257             if (flag_dump_unnumbered)
 258               fputc ('#', outfile);
 259             else
 260               fprintf (outfile, " %d", INSN_UID (XEXP (in_rtx, i)));
 261           }
 262         else
 263           fputs (" 0", outfile);
 264         sawclose = 0;
 265         break;
 266
 267       case 'b':
 268         if (XBITMAP (in_rtx, i) == NULL)
 269           fputs (" {null}", outfile);
 270         else
 271           bitmap_print (outfile, XBITMAP (in_rtx, i), " {", "}");
 272         sawclose = 0;
 273         break;
 274
 275       case 't':
 276         putc (' ', outfile);
 277         fprintf (outfile, HOST_PTR_PRINTF, (char *) XTREE (in_rtx, i));
 278         break;
 279
 280       case '*':
 281         fputs (" Unknown", outfile);
 282         sawclose = 0;
 283         break;
 284
 285       default:
 286         fprintf (stderr,
 287                  "switch format wrong in rtl.print_rtx(). format was: %c.\n",
 288                  format_ptr[-1]);
 289         abort ();
 290       }
 291
 292   if (GET_CODE (in_rtx) == MEM)
 293     fprintf (outfile, " %d", MEM_ALIAS_SET (in_rtx));
 294
 295 #if HOST_FLOAT_FORMAT == TARGET_FLOAT_FORMAT && LONG_DOUBLE_TYPE_SIZE == 64
 296   if (GET_CODE (in_rtx) == CONST_DOUBLE && FLOAT_MODE_P (GET_MODE (in_rtx)))
 297     {
 298       double val;
 299       REAL_VALUE_FROM_CONST_DOUBLE (val, in_rtx);
 300       fprintf (outfile, " [%.16g]", val);
 301     }
 302 #endif
 303
 304   if (dump_for_graph
 305       && (is_insn || GET_CODE (in_rtx) == NOTE
 306           || GET_CODE (in_rtx) == CODE_LABEL || GET_CODE (in_rtx) == BARRIER))
 307     sawclose = 0;
 308   else
 309     {
 310       fputc (')', outfile);
 311       sawclose = 1;
 312     }
 313 }
 314
 315 /* Print an rtx on the current line of FILE.  Initially indent IND
 316    characters.  */
 317
 318 void
 319 print_inline_rtx (outf, x, ind)
 320      FILE *outf;
 321      rtx x;
 322      int ind;
 323 {
 324   int oldsaw = sawclose;
 325   int oldindent = indent;
 326
 327   sawclose = 0;
 328   indent = ind;
 329   outfile = outf;
 330   print_rtx (x);
 331   sawclose = oldsaw;
 332   indent = oldindent;
 333 }
 334
 335 /* Call this function from the debugger to see what X looks like.  */
 336
 337 void
 338 debug_rtx (x)
 339      rtx x;
 340 {
 341   outfile = stderr;
 342   print_rtx (x);
 343   fprintf (stderr, "\n");
 344 }
 345
 346 /* Count of rtx's to print with debug_rtx_list.
 347    This global exists because gdb user defined commands have no arguments.  */
 348
 349 int debug_rtx_count = 0;        /* 0 is treated as equivalent to 1 */
 350
 351 /* Call this function to print list from X on.
 352
 353    N is a count of the rtx's to print. Positive values print from the specified
 354    rtx on.  Negative values print a window around the rtx.
 355    EG: -5 prints 2 rtx's on either side (in addition to the specified rtx).  */
 356
 357 void
 358 debug_rtx_list (x, n)
 359      rtx x;
 360      int n;
 361 {
 362   int i,count;
 363   rtx insn;
 364
 365   count = n == 0 ? 1 : n < 0 ? -n : n;
 366
 367   /* If we are printing a window, back up to the start.  */
 368
 369   if (n < 0)
 370     for (i = count / 2; i > 0; i--)
 371       {
 372         if (PREV_INSN (x) == 0)
 373           break;
 374         x = PREV_INSN (x);
 375       }
 376
 377   for (i = count, insn = x; i > 0 && insn != 0; i--, insn = NEXT_INSN (insn))
 378     debug_rtx (insn);
 379 }
 380
 381 /* Call this function to search an rtx list to find one with insn uid UID,
 382    and then call debug_rtx_list to print it, using DEBUG_RTX_COUNT.
 383    The found insn is returned to enable further debugging analysis.  */
 384
 385 rtx
 386 debug_rtx_find (x, uid)
 387      rtx x;
 388      int uid;
 389 {
 390   while (x != 0 && INSN_UID (x) != uid)
 391     x = NEXT_INSN (x);
 392   if (x != 0)
 393     {
 394       debug_rtx_list (x, debug_rtx_count);
 395       return x;
 396     }
 397   else
 398     {
 399       fprintf (stderr, "insn uid %d not found\n", uid);
 400       return 0;
 401     }
 402 }
 403
 404 /* External entry point for printing a chain of insns
 405    starting with RTX_FIRST onto file OUTF.
 406    A blank line separates insns.
 407
 408    If RTX_FIRST is not an insn, then it alone is printed, with no newline.  */
 409
 410 void
 411 print_rtl (outf, rtx_first)
 412      FILE *outf;
 413      rtx rtx_first;
 414 {
 415   register rtx tmp_rtx;
 416
 417   outfile = outf;
 418   sawclose = 0;
 419
 420   if (rtx_first == 0)
 421     fputs ("(nil)\n", outf);
 422   else
 423     switch (GET_CODE (rtx_first))
 424       {
 425       case INSN:
 426       case JUMP_INSN:
 427       case CALL_INSN:
 428       case NOTE:
 429       case CODE_LABEL:
 430       case BARRIER:
 431         for (tmp_rtx = rtx_first; NULL != tmp_rtx; tmp_rtx = NEXT_INSN (tmp_rtx))
 432           {
 433             if (! flag_dump_unnumbered
 434                 || GET_CODE (tmp_rtx) != NOTE
 435                 || NOTE_LINE_NUMBER (tmp_rtx) < 0)
 436               {
 437                 print_rtx (tmp_rtx);
 438                 fprintf (outfile, "\n");
 439               }
 440           }
 441         break;
 442
 443       default:
 444         print_rtx (rtx_first);
 445       }
 446 }
 447
 448 /* Like print_rtx, except specify a file.  */
 449 /* Return nonzero if we actually printed anything.  */
 450
 451 int
 452 print_rtl_single (outf, x)
 453      FILE *outf;
 454      rtx x;
 455 {
 456   outfile = outf;
 457   sawclose = 0;
 458   if (! flag_dump_unnumbered
 459       || GET_CODE (x) != NOTE || NOTE_LINE_NUMBER (x) < 0)
 460     {
 461       print_rtx (x);
 462       putc ('\n', outf);
 463       return 1;
 464     }
 465   return 0;
 466 }