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