3 * File name: ir/ir/irdump.h
4 * Purpose: Write vcg representation of firm to file.
5 * Author: Martin Trapp, Christian Schaefer
6 * Modified by: Goetz Lindenmaier, Hubert Schmidt
9 * Copyright: (c) 1998-2003 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
17 * Dump routines for the ir graph and all type information.
19 * @author Martin Trapp, Christian Schaefer
21 * The dump format of most functions is vcg. This is a text based graph
22 * representation. Some use the original format,
23 * but most generate an extended format that is only read by some special
24 * versions of xvcg or by the comercialized version now calles aiSee.
25 * A test version of aiSee is available at
26 * http://www.absint.de/aisee/download/index.htm.
28 * Most routines use the name of the passed entity as the name of the
41 * The value of this string will be added to the file name before .vcg
43 * @todo GL: A hack -- add parameter to dumper function.
45 extern char *dump_file_suffix;
50 * @param irg The firm graph to be dumped.
53 * A file containing the firm graph in vcg format.
55 * Dumps all Firm nodes of a single graph for a single procedure in
56 * standard xvcg format. Dumps the graph to a file. The file name
57 * is constructed from the name of the entity describing the
58 * procedure (irg->entity) and the ending -pure<-ip>.vcg. Eventually
59 * overwrites existing files. Visits all nodes in
60 * interprocedural_view.
62 * @see turn_off_edge_labels()
64 void dump_ir_graph (ir_graph *irg);
65 #define dump_cg_graph dump_ir_graph
68 * Dump a firm graph without explicit block nodes.
70 * @param irg The firm graph to be dumped.
73 * A file containing the firm graph in vcg format.
75 * Dumps all Firm nodes of a single graph for a single procedure in
76 * extended xvcg format.
77 * Dumps the graph to a file. The file name is constructed from the
78 * name of the entity describing the procedure (irg->entity) and the
79 * ending <-ip>.vcg. Eventually overwrites existing files. Dumps several
80 * procedures in boxes if interprocedural_view.
82 * @see turn_off_edge_labels()
84 void dump_ir_block_graph (ir_graph *irg);
85 #define dump_cg_block_graph dump_ir_block_graph
87 /** Dumps all graphs in interprocedural view to a file named All_graphs.vcg.
89 void dump_all_cg_block_graph(void);
92 * Dumps a firm graph and all the type information needed for Calls,
93 * Sels, ... in this graph.
95 * @param irg The firm graph to be dumped with its type information.
98 * A file containing the firm graph and the type information of the firm graph in vcg format.
100 * Dumps the graph to a file. The file name is constructed from the
101 * name of the entity describing the procedure (irg->entity) and the
102 * ending -all.vcg. Eventually overwrites existing files.
104 * @see turn_off_edge_labels()
106 void dump_ir_graph_w_types (ir_graph *irg);
109 * Dumps a firm graph and all the type information needed for Calls,
110 * Sels, ... in this graph.
112 * @param irg The firm graph to be dumped with its type information.
115 * A file containing the firm graph and the type information of the firm graph in vcg format.
117 * The graph is in blocked format.
118 * Dumps the graph to a file. The file name is constructed from the
119 * name of the entity describing the procedure (irg->entity) and the
120 * ending -all.vcg. Eventually overwrites existing files.
122 * @see turn_off_edge_labels()
124 void dump_ir_block_graph_w_types (ir_graph *irg);
127 * The type of a walker function that is called for each graph.
129 * @param irg current visited graph
131 typedef void dump_graph_func(ir_graph *irg);
134 * A walker that calls a dumper for each graph.
136 * @param dump_graph The dumper to be used for dumping.
139 * Whatever the dumper creates.
141 * Walks over all firm graphs and calls a dumper for each graph.
142 * The following dumpers can be passed as arguments:
144 * - dump_ir_block_graph()
146 * - dump_type_graph()
147 * - dump_ir_graph_w_types()
149 * @see turn_off_edge_labels()
151 void dump_all_ir_graphs (dump_graph_func *dump_graph);
155 * Dump the control flow graph of a procedure.
157 * @param irg The firm graph whose CFG shall be dumped.
160 * A file containing the CFG in vcg format.
162 * Dumps the control flow graph of a procedure in standard xvcg format.
163 * Dumps the graph to a file. The file name is constructed from the
164 * name of the entity describing the procedure (irg->entity) and the
165 * ending -cfg.vcg. Eventually overwrites existing files.
167 * @see turn_off_edge_labels()
169 void dump_cfg (ir_graph *irg);
172 * Dumps all the type information needed for Calls, Sels, ... in this graph.
173 * Does not dump the graph!
175 * @param irg The firm graph whose type information is to be dumped.
177 * A file containing the type information of the firm graph in vcg format.
179 * Dumps this graph to a file. The file name is constructed from the
180 * name of the entity describing the procedure (irg->entity) and the
181 * ending -type.vcg. Eventually overwrites existing files.
183 * @see turn_off_edge_labels()
185 void dump_type_graph (ir_graph *irg);
188 * Dumps all type information.
191 * A file containing all type information for the program in standard
194 * Dumps all type information that is somehow reachable in standard vcg
196 * Dumps the graph to a file named All_types.vcg.
198 * @see turn_off_edge_labels()
200 void dump_all_types (void);
203 * Dumps the class hierarchy with or without entities.
205 * @param entities Flag whether to dump the entities.
208 * A file containing the class hierarchy tree for the program in standard
211 * Does not dump the global type.
212 * Dumps a node for all classes and the sub/supertype relations. If
213 * entities is set to true also dumps the entities of classes, but without
214 * any additional information as the entities type. The overwrites relation
215 * is dumped along with the entities.
216 * Dumps to a file class_hierarchy.vcg
218 void dump_class_hierarchy (bool entities);
222 * Dump a standalone loop tree, which contains the loop nodes and the firm nodes
223 * belonging to one loop packed together in one subgraph. Dumps to file
224 * <name of irg><suffix>-looptree.vcg
225 * Turns on edge labels by default.
227 * Implementing this dumper was stimulated by Florian Liekwegs similar dumper.
229 * @arg irg Dump the loop tree for this graph.
230 * @arg suffix Suffix to filename.
232 void dump_loop_tree(ir_graph *irg, char *suffix);
234 /** Dumps the firm nodes in the sub-loop-tree of loop to a graph.
235 * Dumps the loop nodes if dump_loop_information() is set.
237 * The name of the file is loop_<loop_nr><suffix>.vcg.
239 * @arg loop Dump the loop tree for this loop.
240 * @arg suffix Suffix to filename.
242 void dump_loop (ir_loop *l, char *suffix);
245 * Sets the vcg flag "display_edge_labels" to no.
248 * as xvcg and aisee both fail to display graphs with self-edges if these
250 * Dumpers will generate vcg flags with a different header.
252 void turn_off_edge_labels(void);
255 * If set to true constants will be replicated for every use. In non blocked
256 * view edges from constant to block are scipped. Vcg
257 * then layouts the graphs more compact, this makes them better readable.
258 * The flag is automatically and temporarily set to false if other
259 * edges are dumped, as outs, loop, ...
260 * Default setting: false.
262 void dump_consts_local(bool b);
264 * Returns false if dump_out_edge_flag or dump_loop_information_flag
265 * are set, else returns dump_const_local_flag.
267 bool get_opt_dump_const_local(void);
270 * Turns off dumping the values of constant entities. Makes type graphs
273 void turn_off_constant_entity_values(void);
276 * Turns on dumping the edges from the End node to nodes to be kept
279 void dump_keepalive_edges(bool b);
280 bool get_opt_dump_keepalive_edges(void);
283 * Turns on dumping the out edges starting from the Start block in
284 * dump_ir_graph. To test the consistency of the out datastructure.
286 void dump_out_edges(void);
289 * If this flag is set the dumper dumps edges to immediate dominator in cfg.
291 void dump_dominator_information(void);
294 * If this flag is set the dumper dumps loop nodes and edges from
295 * these nodes to the contained ir nodes.
296 * Can be turned off with dont_dump_loop_information().
297 * If the loops are interprocedural nodes can be missing.
299 void dump_loop_information(void);
302 * @see dump_loop_information()
304 void dont_dump_loop_information(void);
307 * If set and backedge info is computed, backedges are dumped dashed
308 * and as vcg 'backedge' construct. Default: set.
310 void dump_backedge_information(bool b);
313 * Dump the information of type field specified in ana/irtypeinfo.h.
314 * If the flag is set, the type name is output in [] in the node label,
315 * else it is output as info.
317 void dump_analysed_type_info(bool b);
320 * Write the address of a node into the vcg info.
321 * This is off per default for automatic comparisons of
322 * vcg graphs -- these will differ in the pointer values!
324 void dump_pointer_values_to_info(bool b);
327 # endif /* _IRDUMP_H_ */