gcc/print-rtl.c

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