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