GCC Middle and Back End API Reference
print-rtl.h
Go to the documentation of this file.
1/* Print RTL for GCC.
2 Copyright (C) 1987-2024 Free Software Foundation, Inc.
3
4This file is part of GCC.
5
6GCC is free software; you can redistribute it and/or modify it under
7the terms of the GNU General Public License as published by the Free
8Software Foundation; either version 3, or (at your option) any later
9version.
10
11GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12WARRANTY; without even the implied warranty of MERCHANTABILITY or
13FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14for more details.
15
16You should have received a copy of the GNU General Public License
17along with GCC; see the file COPYING3. If not see
18<http://www.gnu.org/licenses/>. */
19
20#ifndef GCC_PRINT_RTL_H
21#define GCC_PRINT_RTL_H
22
23#ifndef GENERATOR_FILE
24#include "bitmap.h"
25#endif /* #ifndef GENERATOR_FILE */
26
28
29/* A class for writing rtx to a FILE *. */
30
32{
33 public:
34 rtx_writer (FILE *outfile, int ind, bool simple, bool compact,
35 rtx_reuse_manager *reuse_manager);
36
37 void print_rtx (const_rtx in_rtx);
38 void print_rtl (const_rtx rtx_first);
40
41 void finish_directive ();
42
43 private:
44 void print_rtx_operand_code_0 (const_rtx in_rtx, int idx);
45 void print_rtx_operand_code_e (const_rtx in_rtx, int idx);
46 void print_rtx_operand_codes_E_and_V (const_rtx in_rtx, int idx);
47 void print_rtx_operand_code_i (const_rtx in_rtx, int idx);
49 void print_rtx_operand_code_u (const_rtx in_rtx, int idx);
50 void print_rtx_operand (const_rtx in_rtx, int idx);
51 bool operand_has_default_value_p (const_rtx in_rtx, int idx);
52
53 private:
54 FILE *m_outfile;
58
59 /* True means use simplified format without flags, modes, etc. */
61
62 /* If true, use compact dump format:
63 - PREV/NEXT_INSN UIDs are omitted
64 - INSN_CODEs are omitted,
65 - register numbers are omitted for hard and virtual regs, and
66 non-virtual pseudos are offset relative to the first such reg, and
67 printed with a '%' sigil e.g. "%0" for (LAST_VIRTUAL_REGISTER + 1),
68 - insn names are prefixed with "c" (e.g. "cinsn", "cnote", etc). */
70
71#ifndef GENERATOR_FILE
72 /* An optional instance of rtx_reuse_manager. */
74#endif
75};
76
77#ifdef BUFSIZ
78extern void print_rtl (FILE *, const_rtx);
79#endif
80extern void print_rtx_insn_vec (FILE *file, const vec<rtx_insn *> &vec);
81
82extern void dump_value_slim (FILE *, const_rtx, int);
83extern void dump_insn_slim (FILE *, const rtx_insn *);
84extern void dump_rtl_slim (FILE *, const rtx_insn *, const rtx_insn *,
85 int, int);
86extern void print_value (pretty_printer *, const_rtx, int);
87extern void print_pattern (pretty_printer *, const_rtx, int);
88extern void print_insn (pretty_printer *pp, const rtx_insn *x, int verbose);
89extern void print_insn_with_notes (pretty_printer *, const rtx_insn *);
90
92extern const char *str_pattern_slim (const_rtx);
93
94extern void print_rtx_function (FILE *file, function *fn, bool compact);
95
96#ifndef GENERATOR_FILE
97
98/* For some rtx codes (such as SCRATCH), instances are defined to only be
99 equal for pointer equality: two distinct SCRATCH instances are non-equal.
100 copy_rtx preserves this equality by reusing the SCRATCH instance.
101
102 For example, in this x86 instruction:
103
104 (cinsn (set (mem/v:BLK (scratch:DI) [0 A8])
105 (unspec:BLK [
106 (mem/v:BLK (scratch:DI) [0 A8])
107 ] UNSPEC_MEMORY_BLOCKAGE)) "test.c":2
108 (nil))
109
110 the two instances of "(scratch:DI)" are actually the same underlying
111 rtx pointer (and thus "equal"), and the insn will only be recognized
112 (as "*memory_blockage") if this pointer-equality is preserved.
113
114 To be able to preserve this pointer-equality when round-tripping
115 through dumping/loading the rtl, we need some syntax. The first
116 time a reused rtx is encountered in the dump, we prefix it with
117 a reuse ID:
118
119 (0|scratch:DI)
120
121 Subsequent references to the rtx in the dump can be expressed using
122 "reuse_rtx" e.g.:
123
124 (reuse_rtx 0)
125
126 This class is responsible for tracking a set of reuse IDs during a dump.
127
128 Dumping with reuse-support is done in two passes:
129
130 (a) a first pass in which "preprocess" is called on each top-level rtx
131 to be seen in the dump. This traverses the rtx and its descendents,
132 identifying rtx that will be seen more than once in the actual dump,
133 and assigning them reuse IDs.
134
135 (b) the actual dump, via print_rtx etc. print_rtx detect the presence
136 of a live rtx_reuse_manager and uses it if there is one. Any rtx
137 that were assigned reuse IDs will be printed with it the first time
138 that they are seen, and then printed as "(reuse_rtx ID)" subsequently.
139
140 The first phase is needed since otherwise there would be no way to tell
141 if an rtx will be reused when first encountering it. */
142
144{
145 public:
147
148 /* The first pass. */
149 void preprocess (const_rtx x);
150
151 /* The second pass (within print_rtx). */
152 bool has_reuse_id (const_rtx x, int *out);
153 bool seen_def_p (int reuse_id);
154 void set_seen_def (int reuse_id);
155
156 private:
161};
162
163#endif /* #ifndef GENERATOR_FILE */
164
165#endif // GCC_PRINT_RTL_H
Definition bitmap.h:950
Definition hash-map.h:40
Definition pretty-print.h:255
Definition print-rtl.h:144
int m_next_id
Definition print-rtl.h:160
rtx_reuse_manager()
Definition print-rtl.cc:100
auto_bitmap m_defs_seen
Definition print-rtl.h:159
hash_map< const_rtx, int > m_rtx_occurrence_count
Definition print-rtl.h:157
void set_seen_def(int reuse_id)
Definition print-rtl.cc:176
void preprocess(const_rtx x)
Definition print-rtl.cc:132
hash_map< const_rtx, int > m_rtx_reuse_ids
Definition print-rtl.h:158
bool seen_def_p(int reuse_id)
Definition print-rtl.cc:168
bool has_reuse_id(const_rtx x, int *out)
Definition print-rtl.cc:152
Definition print-rtl.h:32
bool m_sawclose
Definition print-rtl.h:56
void print_rtx_operand_code_i(const_rtx in_rtx, int idx)
Definition print-rtl.cc:441
FILE * m_outfile
Definition print-rtl.h:54
void print_rtl(const_rtx rtx_first)
Definition print-rtl.cc:1177
bool operand_has_default_value_p(const_rtx in_rtx, int idx)
Definition print-rtl.cc:755
void print_rtx_operand_code_u(const_rtx in_rtx, int idx)
Definition print-rtl.cc:602
void print_rtx_operand_codes_E_and_V(const_rtx in_rtx, int idx)
Definition print-rtl.cc:366
void finish_directive()
Definition print-rtl.cc:1036
void print_rtx_operand_code_0(const_rtx in_rtx, int idx)
Definition print-rtl.cc:217
void print_rtx_operand_code_r(const_rtx in_rtx)
Definition print-rtl.cc:534
int m_indent
Definition print-rtl.h:55
bool m_in_call_function_usage
Definition print-rtl.h:57
bool m_simple
Definition print-rtl.h:60
void print_rtx_operand(const_rtx in_rtx, int idx)
Definition print-rtl.cc:649
void print_rtx(const_rtx in_rtx)
Definition print-rtl.cc:790
void print_rtl_single_with_indent(const_rtx x, int ind)
Definition print-rtl.cc:1237
rtx_reuse_manager * m_rtx_reuse_manager
Definition print-rtl.h:73
bool m_compact
Definition print-rtl.h:69
void print_rtx_operand_code_e(const_rtx in_rtx, int idx)
Definition print-rtl.cc:343
rtx_writer(FILE *outfile, int ind, bool simple, bool compact, rtx_reuse_manager *reuse_manager)
Definition print-rtl.cc:86
bool verbose
Definition collect-utils.cc:35
void print_rtl(FILE *outf, const_rtx rtx_first)
Definition print-rtl.cc:1219
void dump_insn_slim(FILE *, const rtx_insn *)
Definition print-rtl.cc:2081
void print_rtx_insn_vec(FILE *file, const vec< rtx_insn * > &vec)
Definition print-rtl.cc:1267
void print_value(pretty_printer *, const_rtx, int)
Definition print-rtl.cc:1660
const char * str_pattern_slim(const_rtx)
Definition print-rtl.cc:2143
void rtl_dump_bb_for_graph(pretty_printer *, basic_block)
Definition print-rtl.cc:2117
void print_insn_with_notes(pretty_printer *, const rtx_insn *)
Definition print-rtl.cc:2045
void print_pattern(pretty_printer *, const_rtx, int)
Definition print-rtl.cc:1775
void print_insn(pretty_printer *pp, const rtx_insn *x, int verbose)
Definition print-rtl.cc:1910
void dump_value_slim(FILE *, const_rtx, int)
Definition print-rtl.cc:2070
void print_rtx_function(FILE *file, function *fn, bool compact)
Definition print-rtl-function.cc:219
void dump_rtl_slim(FILE *, const rtx_insn *, const rtx_insn *, int, int)
Definition print-rtl.cc:2093
Definition basic-block.h:117
Definition function.h:249
Definition rtl.h:311
Definition rtl.h:545
Definition vec.h:450