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