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