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