1 /* Print RTL functions for GCC.
2 Copyright (C) 2016 Free Software Foundation, Inc.
4 This file is part of GCC.
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 3, or (at your option) any later
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING3. If not see
18 <http://www.gnu.org/licenses/>. */
22 #include "coretypes.h"
31 #include "basic-block.h"
32 #include "print-rtl.h"
33 #include "langhooks.h"
38 /* Print an "(edge-from)" or "(edge-to)" directive describing E
42 print_edge (FILE *outfile
, edge e
, bool from
)
44 fprintf (outfile
, " (%s ", from
? "edge-from" : "edge-to");
45 basic_block bb
= from
? e
->src
: e
->dest
;
50 fprintf (outfile
, "entry");
53 fprintf (outfile
, "exit");
56 fprintf (outfile
, "%i", bb
->index
);
60 /* Express edge flags as a string with " | " separator.
61 e.g. (flags "FALLTHRU | DFS_BACK"). */
64 fprintf (outfile
, " (flags \"");
65 bool seen_flag
= false;
66 #define DEF_EDGE_FLAG(NAME,IDX) \
68 if (e->flags & EDGE_##NAME) \
71 fprintf (outfile, " | "); \
72 fprintf (outfile, "%s", (#NAME)); \
76 #include "cfg-flags.def"
79 fprintf (outfile
, "\")");
82 fprintf (outfile
, ")\n");
85 /* If BB is non-NULL, print the start of a "(block)" directive for it
86 to OUTFILE, otherwise do nothing. */
89 begin_any_block (FILE *outfile
, basic_block bb
)
97 fprintf (outfile
, " (block %i\n", bb
->index
);
98 FOR_EACH_EDGE (e
, ei
, bb
->preds
)
99 print_edge (outfile
, e
, true);
102 /* If BB is non-NULL, print the end of a "(block)" directive for it
103 to OUTFILE, otherwise do nothing. */
106 end_any_block (FILE *outfile
, basic_block bb
)
114 FOR_EACH_EDGE (e
, ei
, bb
->succs
)
115 print_edge (outfile
, e
, false);
116 fprintf (outfile
, " ) ;; block %i\n", bb
->index
);
119 /* Determine if INSN is of a kind that can have a basic block. */
122 can_have_basic_block_p (const rtx_insn
*insn
)
124 rtx_code code
= GET_CODE (insn
);
127 gcc_assert (GET_RTX_FORMAT (code
)[2] == 'B');
131 /* Subroutine of print_param. Write the name of ARG, if any, to OUTFILE. */
134 print_any_param_name (FILE *outfile
, tree arg
)
137 fprintf (outfile
, " \"%s\"", IDENTIFIER_POINTER (DECL_NAME (arg
)));
140 /* Print a "(param)" directive for ARG to OUTFILE. */
143 print_param (FILE *outfile
, rtx_writer
&w
, tree arg
)
145 fprintf (outfile
, " (param");
146 print_any_param_name (outfile
, arg
);
147 fprintf (outfile
, "\n");
149 /* Print the value of DECL_RTL (without lazy-evaluation). */
150 fprintf (outfile
, " (DECL_RTL ");
151 w
.print_rtx (DECL_RTL_IF_SET (arg
));
152 w
.finish_directive ();
154 /* Print DECL_INCOMING_RTL. */
155 fprintf (outfile
, " (DECL_RTL_INCOMING ");
156 w
.print_rtx (DECL_INCOMING_RTL (arg
));
157 fprintf (outfile
, ")");
159 w
.finish_directive ();
162 /* Write FN to OUTFILE in a form suitable for parsing, with indentation
163 and comments to make the structure easy for a human to grok. Track
164 the basic blocks of insns in the chain, wrapping those that are within
165 blocks within "(block)" directives.
167 If COMPACT, then instructions are printed in a compact form:
168 - INSN_UIDs are omitted, except for jumps and CODE_LABELs,
169 - INSN_CODEs are omitted,
170 - register numbers are omitted for hard and virtual regs, and
171 non-virtual pseudos are offset relative to the first such reg, and
172 printed with a '%' sigil e.g. "%0" for (LAST_VIRTUAL_REGISTER + 1),
173 - insn names are prefixed with "c" (e.g. "cinsn", "cnote", etc)
175 Example output (with COMPACT==true):
177 (function "times_two"
179 (cnote NOTE_INSN_DELETED)
181 (edge-from entry (flags "FALLTHRU"))
182 (cnote [bb 2] NOTE_INSN_BASIC_BLOCK)
183 (cinsn (set (mem/c:SI (plus:DI (reg/f:DI virtual-stack-vars)
184 (const_int -4)) [1 i+0 S4 A32])
185 (reg:SI di [ i ])) "t.c":2
187 (cnote NOTE_INSN_FUNCTION_BEG)
188 (cinsn (set (reg:SI %2)
189 (mem/c:SI (plus:DI (reg/f:DI virtual-stack-vars)
190 (const_int -4)) [1 i+0 S4 A32])) "t.c":3
193 (set (reg:SI %0 [ _2 ])
194 (ashift:SI (reg:SI %2)
196 (clobber (reg:CC flags))
198 (expr_list:REG_EQUAL (ashift:SI (mem/c:SI (plus:DI (reg/f:DI virtual-stack-vars)
199 (const_int -4)) [1 i+0 S4 A32])
202 (cinsn (set (reg:SI %1 [ <retval> ])
203 (reg:SI %0 [ _2 ])) "t.c":3
205 (cinsn (set (reg/i:SI ax)
206 (reg:SI %1 [ <retval> ])) "t.c":4
208 (cinsn (use (reg/i:SI ax)) "t.c":4
210 (edge-to exit (flags "FALLTHRU"))
218 ) ;; function "times_two"
222 print_rtx_function (FILE *outfile
, function
*fn
, bool compact
)
225 rtx_writer
w (outfile
, 0, false, compact
, &r
);
227 /* Support "reuse_rtx" in the dump. */
228 for (rtx_insn
*insn
= get_insns (); insn
; insn
= NEXT_INSN (insn
))
231 tree fdecl
= fn
->decl
;
233 const char *dname
= lang_hooks
.decl_printable_name (fdecl
, 2);
235 fprintf (outfile
, "(function \"%s\"\n", dname
);
238 for (tree arg
= DECL_ARGUMENTS (fdecl
); arg
; arg
= DECL_CHAIN (arg
))
239 print_param (outfile
, w
, arg
);
241 /* The instruction chain. */
242 fprintf (outfile
, " (insn-chain\n");
243 basic_block curr_bb
= NULL
;
244 for (rtx_insn
*insn
= get_insns (); insn
; insn
= NEXT_INSN (insn
))
247 if (can_have_basic_block_p (insn
))
248 insn_bb
= BLOCK_FOR_INSN (insn
);
251 if (curr_bb
!= insn_bb
)
253 end_any_block (outfile
, curr_bb
);
255 begin_any_block (outfile
, curr_bb
);
257 w
.print_rtl_single_with_indent (insn
, curr_bb
? 6 : 4);
259 end_any_block (outfile
, curr_bb
);
260 fprintf (outfile
, " ) ;; insn-chain\n");
262 /* Additional RTL state. */
263 fprintf (outfile
, " (crtl\n");
264 fprintf (outfile
, " (return_rtx \n");
265 w
.print_rtl_single_with_indent (crtl
->return_rtx
, 6);
266 fprintf (outfile
, " ) ;; return_rtx\n");
267 fprintf (outfile
, " ) ;; crtl\n");
269 fprintf (outfile
, ") ;; function \"%s\"\n", dname
);