[gcc.git] / gcc / print-rtl.c

/* Print RTL for GNU C Compiler.
   Copyright (C) 1987, 1988, 1992 Free Software Foundation, Inc.

This file is part of GNU CC.

GNU CC is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU CC is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU CC; see the file COPYING.  If not, write to
the Free Software Foundation, 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */


#include "config.h"
#include <ctype.h>
#include <stdio.h>
#include "rtl.h"


/* How to print out a register name.
   We don't use PRINT_REG because some definitions of PRINT_REG
   don't work here.  */
#ifndef DEBUG_PRINT_REG
#define DEBUG_PRINT_REG(RTX, CODE, FILE) \
  fprintf ((FILE), "%d %s", REGNO (RTX), reg_names[REGNO (RTX)])
#endif

/* Array containing all of the register names */

#ifdef DEBUG_REGISTER_NAMES
static char *reg_names[] = DEBUG_REGISTER_NAMES;
#else
static char *reg_names[] = REGISTER_NAMES;
#endif

static FILE *outfile;

char spaces[] = "                                                                                                                                                                ";

static int sawclose = 0;

/* Names for patterns.  Non-zero only when linked with insn-output.c.  */

extern char **insn_name_ptr;

/* Print IN_RTX onto OUTFILE.  This is the recursive part of printing.  */

static void
print_rtx (in_rtx)
     register rtx in_rtx;
{
  static int indent;
  register int i, j;
  register char *format_ptr;
  register int is_insn;

  if (sawclose)
    {
      fprintf (outfile, "\n%s",
	       (spaces + (sizeof spaces - 1 - indent * 2)));
      sawclose = 0;
    }

  if (in_rtx == 0)
    {
      fprintf (outfile, "(nil)");
      sawclose = 1;
      return;
    }

  /* print name of expression code */
  fprintf (outfile, "(%s", GET_RTX_NAME (GET_CODE (in_rtx)));

  if (in_rtx->in_struct)
    fprintf (outfile, "/s");

  if (in_rtx->volatil)
    fprintf (outfile, "/v");

  if (in_rtx->unchanging)
    fprintf (outfile, "/u");

  if (in_rtx->integrated)
    fprintf (outfile, "/i");

  if (GET_MODE (in_rtx) != VOIDmode)
    {
      /* Print REG_NOTE names for EXPR_LIST and INSN_LIST.  */
      if (GET_CODE (in_rtx) == EXPR_LIST || GET_CODE (in_rtx) == INSN_LIST)
	fprintf (outfile, ":%s", GET_REG_NOTE_NAME (GET_MODE (in_rtx)));
      else
	fprintf (outfile, ":%s", GET_MODE_NAME (GET_MODE (in_rtx)));
    }

  is_insn = (GET_RTX_CLASS (GET_CODE (in_rtx)) == 'i');
  format_ptr = GET_RTX_FORMAT (GET_CODE (in_rtx));

  for (i = 0; i < GET_RTX_LENGTH (GET_CODE (in_rtx)); i++)
    switch (*format_ptr++)
      {
      case 'S':
      case 's':
	if (i == 3 && GET_CODE (in_rtx) == NOTE
	    && (NOTE_LINE_NUMBER (in_rtx) == NOTE_INSN_EH_REGION_BEG
		|| NOTE_LINE_NUMBER (in_rtx) == NOTE_INSN_EH_REGION_END))
	  {
	    fprintf (outfile, " %d", NOTE_BLOCK_NUMBER (in_rtx));
	    sawclose = 1;
	    break;
	  }
	if (XSTR (in_rtx, i) == 0)
	  fprintf (outfile, " \"\"");
	else
	  fprintf (outfile, " (\"%s\")", XSTR (in_rtx, i));
	sawclose = 1;
	break;

	/* 0 indicates a field for internal use that should not be printed.  */
      case '0':
	break;

      case 'e':
	indent += 2;
	if (!sawclose)
	  fprintf (outfile, " ");
	print_rtx (XEXP (in_rtx, i));
	indent -= 2;
	break;

      case 'E':
      case 'V':
	indent += 2;
	if (sawclose)
	  {
	    fprintf (outfile, "\n%s",
		     (spaces + (sizeof spaces - 1 - indent * 2)));
	    sawclose = 0;
	  }
	fprintf (outfile, "[ ");
	if (NULL != XVEC (in_rtx, i))
	  {
	    indent += 2;
	    if (XVECLEN (in_rtx, i))
	      sawclose = 1;

	    for (j = 0; j < XVECLEN (in_rtx, i); j++)
	      print_rtx (XVECEXP (in_rtx, i, j));

	    indent -= 2;
	  }
	if (sawclose)
	  fprintf (outfile, "\n%s",
		   (spaces + (sizeof spaces - 1 - indent * 2)));

	fprintf (outfile, "] ");
	sawclose = 1;
	indent -= 2;
	break;

      case 'w':
	fprintf (outfile, " ");
	fprintf (outfile, HOST_WIDE_INT_PRINT_DEC, XWINT (in_rtx, i));
	break;

      case 'i':
	{
	  register int value = XINT (in_rtx, i);

	  if (GET_CODE (in_rtx) == REG && value < FIRST_PSEUDO_REGISTER)
	    {
	      fputc (' ', outfile);
	      DEBUG_PRINT_REG (in_rtx, 0, outfile);
	    }
	  else
	    fprintf (outfile, " %d", value);
	}
	if (is_insn && &INSN_CODE (in_rtx) == &XINT (in_rtx, i)
	    && insn_name_ptr
	    && XINT (in_rtx, i) >= 0)
	  fprintf (outfile, " {%s}", insn_name_ptr[XINT (in_rtx, i)]);
	sawclose = 0;
	break;

      /* Print NOTE_INSN names rather than integer codes.  */

      case 'n':
	if (XINT (in_rtx, i) <= 0)
	  fprintf (outfile, " %s", GET_NOTE_INSN_NAME (XINT (in_rtx, i)));
	else
	  fprintf (outfile, " %d", XINT (in_rtx, i));
	sawclose = 0;
	break;

      case 'u':
	if (XEXP (in_rtx, i) != NULL)
	  fprintf (outfile, " %d", INSN_UID (XEXP (in_rtx, i)));
	else
	  fprintf (outfile, " 0");
	sawclose = 0;
	break;

      case '*':
	fprintf (outfile, " Unknown");
	sawclose = 0;
	break;

      default:
	fprintf (stderr,
		 "switch format wrong in rtl.print_rtx(). format was: %c.\n",
		 format_ptr[-1]);
	abort ();
      }

  fprintf (outfile, ")");
  sawclose = 1;
}

/* Call this function from the debugger to see what X looks like.  */

void
debug_rtx (x)
     rtx x;
{
  outfile = stderr;
  print_rtx (x);
  fprintf (stderr, "\n");
}

/* Count of rtx's to print with debug_rtx_list.
   This global exists because gdb user defined commands have no arguments.  */

int debug_rtx_count = 0;	/* 0 is treated as equivalent to 1 */

/* Call this function to print list from X on.

   N is a count of the rtx's to print. Positive values print from the specified
   rtx on.  Negative values print a window around the rtx.
   EG: -5 prints 2 rtx's on either side (in addition to the specified rtx).  */

void
debug_rtx_list (x, n)
     rtx x;
     int n;
{
  int i,count;
  rtx insn;

  count = n == 0 ? 1 : n < 0 ? -n : n;

  /* If we are printing a window, back up to the start.  */

  if (n < 0)
    for (i = count / 2; i > 0; i--)
      {
	if (PREV_INSN (x) == 0)
	  break;
	x = PREV_INSN (x);
      }

  for (i = count, insn = x; i > 0 && insn != 0; i--, insn = NEXT_INSN (insn))
    debug_rtx (insn);
}

/* Call this function to search an rtx list to find one with insn uid UID,
   and then call debug_rtx_list to print it, using DEBUG_RTX_COUNT.
   The found insn is returned to enable further debugging analysis.  */

rtx
debug_rtx_find(x, uid)
     rtx x;
     int uid;
{
  while (x != 0 && INSN_UID (x) != uid)
    x = NEXT_INSN (x);
  if (x != 0)
    {
      debug_rtx_list (x, debug_rtx_count);
      return x;
    }
  else
    {
      fprintf (stderr, "insn uid %d not found\n", uid);
      return 0;
    }
}

/* External entry point for printing a chain of insns
   starting with RTX_FIRST onto file OUTF.
   A blank line separates insns.

   If RTX_FIRST is not an insn, then it alone is printed, with no newline.  */

void
print_rtl (outf, rtx_first)
     FILE *outf;
     rtx rtx_first;
{
  register rtx tmp_rtx;

  outfile = outf;
  sawclose = 0;

  if (rtx_first == 0)
    fprintf (outf, "(nil)\n");
  else
    switch (GET_CODE (rtx_first))
      {
      case INSN:
      case JUMP_INSN:
      case CALL_INSN:
      case NOTE:
      case CODE_LABEL:
      case BARRIER:
	for (tmp_rtx = rtx_first; NULL != tmp_rtx; tmp_rtx = NEXT_INSN (tmp_rtx))
	  {
	    print_rtx (tmp_rtx);
	    fprintf (outfile, "\n");
	  }
	break;

      default:
	print_rtx (rtx_first);
      }
}
Commit	Line	Data
e1a79915	1	/* Print RTL for GNU C Compiler.
b3fcd290	2	Copyright (C) 1987, 1988, 1992 Free Software Foundation, Inc.
e1a79915 RS	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
e99215a3 RK	18	the Free Software Foundation, 59 Temple Place - Suite 330,
e99215a3 RK	19	Boston, MA 02111-1307, USA. */
e1a79915 RS	20
	21
	22	#include "config.h"
	23	#include <ctype.h>
	24	#include <stdio.h>
	25	#include "rtl.h"
	26
	27
cf99a734 RS	28	/* How to print out a register name.
	29	We don't use PRINT_REG because some definitions of PRINT_REG
	30	don't work here. */
	31	#ifndef DEBUG_PRINT_REG
	32	#define DEBUG_PRINT_REG(RTX, CODE, FILE) \
	33	fprintf ((FILE), "%d %s", REGNO (RTX), reg_names[REGNO (RTX)])
	34	#endif
	35
	36	/* Array containing all of the register names */
	37
	38	#ifdef DEBUG_REGISTER_NAMES
	39	static char *reg_names[] = DEBUG_REGISTER_NAMES;
	40	#else
	41	static char *reg_names[] = REGISTER_NAMES;
	42	#endif
	43
e1a79915 RS	44	static FILE *outfile;
	45
	46	char spaces[] = " ";
	47
	48	static int sawclose = 0;
	49
	50	/* Names for patterns. Non-zero only when linked with insn-output.c. */
	51
	52	extern char **insn_name_ptr;
	53
	54	/* Print IN_RTX onto OUTFILE. This is the recursive part of printing. */
	55
	56	static void
	57	print_rtx (in_rtx)
	58	register rtx in_rtx;
	59	{
	60	static int indent;
	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",
bcd4420d	68	(spaces + (sizeof spaces - 1 - indent * 2)));
e1a79915 RS	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':
6adb4e3a MS	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	}
e1a79915 RS	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",
bcd4420d	144	(spaces + (sizeof spaces - 1 - indent * 2)));
e1a79915 RS	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",
bcd4420d	161	(spaces + (sizeof spaces - 1 - indent * 2)));
e1a79915 RS	162
	163	fprintf (outfile, "] ");
	164	sawclose = 1;
	165	indent -= 2;
	166	break;
	167
5bf665df	168	case 'w':
734de8c8 RK	169	fprintf (outfile, " ");
734de8c8 RK	170	fprintf (outfile, HOST_WIDE_INT_PRINT_DEC, XWINT (in_rtx, i));
5bf665df RK	171	break;
5bf665df RK	172
e1a79915	173	case 'i':
cf99a734 RS	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	}
e1a79915 RS	185	if (is_insn && &INSN_CODE (in_rtx) == &XINT (in_rtx, i)
	186	&& insn_name_ptr
	187	&& XINT (in_rtx, i) >= 0)
cf99a734	188	fprintf (outfile, " {%s}", insn_name_ptr[XINT (in_rtx, i)]);
e1a79915 RS	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)
d64be5ec	204	fprintf (outfile, " %d", INSN_UID (XEXP (in_rtx, i)));
e1a79915	205	else
d64be5ec CH	206	fprintf (outfile, " 0");
	207	sawclose = 0;
	208	break;
	209
	210	case '*':
	211	fprintf (outfile, " Unknown");
e1a79915 RS	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	/* Call this function from the debugger to see what X looks like. */
	227
	228	void
	229	debug_rtx (x)
	230	rtx x;
	231	{
	232	outfile = stderr;
	233	print_rtx (x);
	234	fprintf (stderr, "\n");
	235	}
	236
716f003f DE	237	/* Count of rtx's to print with debug_rtx_list.
	238	This global exists because gdb user defined commands have no arguments. */
	239
	240	int debug_rtx_count = 0; /* 0 is treated as equivalent to 1 */
	241
	242	/* Call this function to print list from X on.
	243
	244	N is a count of the rtx's to print. Positive values print from the specified
	245	rtx on. Negative values print a window around the rtx.
	246	EG: -5 prints 2 rtx's on either side (in addition to the specified rtx). */
	247
	248	void
	249	debug_rtx_list (x, n)
	250	rtx x;
	251	int n;
	252	{
	253	int i,count;
	254	rtx insn;
	255
	256	count = n == 0 ? 1 : n < 0 ? -n : n;
	257
	258	/* If we are printing a window, back up to the start. */
	259
	260	if (n < 0)
	261	for (i = count / 2; i > 0; i--)
	262	{
	263	if (PREV_INSN (x) == 0)
	264	break;
	265	x = PREV_INSN (x);
	266	}
	267
	268	for (i = count, insn = x; i > 0 && insn != 0; i--, insn = NEXT_INSN (insn))
	269	debug_rtx (insn);
	270	}
	271
	272	/* Call this function to search an rtx list to find one with insn uid UID,
	273	and then call debug_rtx_list to print it, using DEBUG_RTX_COUNT.
	274	The found insn is returned to enable further debugging analysis. */
	275
	276	rtx
	277	debug_rtx_find(x, uid)
	278	rtx x;
	279	int uid;
	280	{
	281	while (x != 0 && INSN_UID (x) != uid)
	282	x = NEXT_INSN (x);
	283	if (x != 0)
	284	{
	285	debug_rtx_list (x, debug_rtx_count);
	286	return x;
	287	}
	288	else
	289	{
	290	fprintf (stderr, "insn uid %d not found\n", uid);
	291	return 0;
	292	}
	293	}
	294
e1a79915 RS	295	/* External entry point for printing a chain of insns
	296	starting with RTX_FIRST onto file OUTF.
	297	A blank line separates insns.
	298
	299	If RTX_FIRST is not an insn, then it alone is printed, with no newline. */
	300
	301	void
	302	print_rtl (outf, rtx_first)
	303	FILE *outf;
	304	rtx rtx_first;
	305	{
	306	register rtx tmp_rtx;
	307
	308	outfile = outf;
	309	sawclose = 0;
	310
	311	if (rtx_first == 0)
	312	fprintf (outf, "(nil)\n");
	313	else
	314	switch (GET_CODE (rtx_first))
	315	{
	316	case INSN:
	317	case JUMP_INSN:
	318	case CALL_INSN:
	319	case NOTE:
	320	case CODE_LABEL:
	321	case BARRIER:
	322	for (tmp_rtx = rtx_first; NULL != tmp_rtx; tmp_rtx = NEXT_INSN (tmp_rtx))
	323	{
	324	print_rtx (tmp_rtx);
	325	fprintf (outfile, "\n");
	326	}
	327	break;
	328
	329	default:
	330	print_rtx (rtx_first);
	331	}
	332	}