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;
46 /** Set this to the name (not the ld_name) of the method to be dumped. */
47 extern char *dump_file_filter;
52 * @param irg The firm graph to be dumped.
55 * A file containing the firm graph in vcg format.
57 * Dumps all Firm nodes of a single graph for a single procedure in
58 * standard xvcg format. Dumps the graph to a file. The file name
59 * is constructed from the name of the entity describing the
60 * procedure (irg->entity) and the ending -pure<-ip>.vcg. Eventually
61 * overwrites existing files. Visits all nodes in
62 * interprocedural_view.
64 * @see turn_off_edge_labels()
66 void dump_ir_graph (ir_graph *irg, char *suffix);
67 #define dump_cg_graph dump_ir_graph
70 * Dump a firm graph without explicit block nodes.
72 * @param irg The firm graph to be dumped.
75 * A file containing the firm graph in vcg format.
77 * Dumps all Firm nodes of a single graph for a single procedure in
78 * extended xvcg format.
79 * Dumps the graph to a file. The file name is constructed from the
80 * name of the entity describing the procedure (irg->entity) and the
81 * ending <-ip>.vcg. Eventually overwrites existing files. Dumps several
82 * procedures in boxes if interprocedural_view.
84 * @see turn_off_edge_labels()
86 void dump_ir_block_graph (ir_graph *irg, char *suffix);
87 #define dump_cg_block_graph dump_ir_block_graph
89 /** Dumps all graphs in interprocedural view to a file named All_graphs.vcg.
91 void dump_all_cg_block_graph(char *suffix);
94 * Dumps a firm graph and all the type information needed for Calls,
95 * Sels, ... in this graph.
97 * @param irg The firm graph to be dumped with its type information.
100 * A file containing the firm graph and the type information of the firm graph in vcg format.
102 * Dumps the graph to a file. The file name is constructed from the
103 * name of the entity describing the procedure (irg->entity) and the
104 * ending -all.vcg. Eventually overwrites existing files.
106 * @see turn_off_edge_labels()
108 void dump_ir_graph_w_types (ir_graph *irg, char *suffix);
111 * Dumps a firm graph and all the type information needed for Calls,
112 * Sels, ... in this graph.
114 * @param irg The firm graph to be dumped with its type information.
117 * A file containing the firm graph and the type information of the firm graph in vcg format.
119 * The graph is in blocked format.
120 * Dumps the graph to a file. The file name is constructed from the
121 * name of the entity describing the procedure (irg->entity) and the
122 * ending -all.vcg. Eventually overwrites existing files.
124 * @see turn_off_edge_labels()
126 void dump_ir_block_graph_w_types (ir_graph *irg, char *suffix);
129 * The type of a walker function that is called for each graph.
131 * @param irg current visited graph
133 typedef void dump_graph_func(ir_graph *irg, char *suffix);
136 * A walker that calls a dumper for each graph.
138 * @param dump_graph The dumper to be used for dumping.
141 * Whatever the dumper creates.
143 * Walks over all firm graphs and calls a dumper for each graph.
144 * The following dumpers can be passed as arguments:
146 * - dump_ir_block_graph()
148 * - dump_type_graph()
149 * - dump_ir_graph_w_types()
151 * @see turn_off_edge_labels()
153 void dump_all_ir_graphs (dump_graph_func *dump_graph, char *suffix);
157 * Dump the control flow graph of a procedure.
159 * @param irg The firm graph whose CFG shall be dumped.
162 * A file containing the CFG in vcg format.
164 * Dumps the control flow graph of a procedure in standard xvcg format.
165 * Dumps the graph to a file. The file name is constructed from the
166 * name of the entity describing the procedure (irg->entity) and the
167 * ending -cfg.vcg. Eventually overwrites existing files.
169 * @see turn_off_edge_labels()
171 void dump_cfg (ir_graph *irg, char *suffix);
174 /** Dump the call graph.
176 * Dumps the callgraph to a file "callgraph"<filesuffix>".vcg".
178 void dump_callgraph(char *filesuffix);
181 * Dumps all the type information needed for Calls, Sels, ... in this graph.
182 * Does not dump the graph!
184 * @param irg The firm graph whose type information is to be dumped.
186 * A file containing the type information of the firm graph in vcg format.
188 * Dumps this graph to a file. The file name is constructed from the
189 * name of the entity describing the procedure (irg->entity) and the
190 * ending -type.vcg. Eventually overwrites existing files.
192 * @see turn_off_edge_labels()
194 void dump_type_graph (ir_graph *irg, char *suffix);
197 * Dumps all type information.
200 * A file containing all type information for the program in standard
203 * Dumps all type information that is somehow reachable in standard vcg
205 * Dumps the graph to a file named All_types.vcg.
207 * @see turn_off_edge_labels()
209 void dump_all_types (char *suffix);
212 * Dumps the class hierarchy with or without entities.
214 * @param entities Flag whether to dump the entities.
217 * A file containing the class hierarchy tree for the program in standard
220 * Does not dump the global type.
221 * Dumps a node for all classes and the sub/supertype relations. If
222 * entities is set to true also dumps the entities of classes, but without
223 * any additional information as the entities type. The overwrites relation
224 * is dumped along with the entities.
225 * Dumps to a file class_hierarchy.vcg
227 void dump_class_hierarchy (bool entities, char *suffix);
231 * Dump a standalone loop tree, which contains the loop nodes and the firm nodes
232 * belonging to one loop packed together in one subgraph. Dumps to file
233 * <name of irg><suffix>-looptree.vcg
234 * Turns on edge labels by default.
236 * Implementing this dumper was stimulated by Florian Liekwegs similar dumper.
238 * @arg irg Dump the loop tree for this graph.
239 * @arg suffix Suffix to filename.
241 void dump_loop_tree(ir_graph *irg, char *suffix);
243 /** Dumps the firm nodes in the sub-loop-tree of loop to a graph.
244 * Dumps the loop nodes if dump_loop_information() is set.
246 * The name of the file is loop_<loop_nr><suffix>.vcg.
248 * @arg loop Dump the loop tree for this loop.
249 * @arg suffix Suffix to filename.
251 void dump_loop (ir_loop *l, char *suffix);
254 * Sets the vcg flag "display_edge_labels" to no.
257 * as xvcg and aisee both fail to display graphs with self-edges if these
259 * Dumpers will generate vcg flags with a different header.
261 void turn_off_edge_labels(void);
264 * If set to true constants will be replicated for every use. In non blocked
265 * view edges from constant to block are scipped. Vcg
266 * then layouts the graphs more compact, this makes them better readable.
267 * The flag is automatically and temporarily set to false if other
268 * edges are dumped, as outs, loop, ...
269 * Default setting: false.
271 void dump_consts_local(bool b);
273 * Returns false if dump_out_edge_flag or dump_loop_information_flag
274 * are set, else returns dump_const_local_flag.
276 bool get_opt_dump_const_local(void);
279 * Turns off dumping the values of constant entities. Makes type graphs
282 void turn_off_constant_entity_values(void);
285 * Turns on dumping the edges from the End node to nodes to be kept
288 void dump_keepalive_edges(bool b);
289 bool get_opt_dump_keepalive_edges(void);
292 * Turns on dumping the out edges starting from the Start block in
293 * dump_ir_graph. To test the consistency of the out datastructure.
295 void dump_out_edges(void);
298 * If this flag is set the dumper dumps edges to immediate dominator in cfg.
300 void dump_dominator_information(void);
303 * If this flag is set the dumper dumps loop nodes and edges from
304 * these nodes to the contained ir nodes.
305 * Can be turned off with dont_dump_loop_information().
306 * If the loops are interprocedural nodes can be missing.
308 void dump_loop_information(void);
311 * @see dump_loop_information()
313 void dont_dump_loop_information(void);
316 * If set and backedge info is computed, backedges are dumped dashed
317 * and as vcg 'backedge' construct. Default: set.
319 void dump_backedge_information(bool b);
322 * Dump the information of type field specified in ana/irtypeinfo.h.
323 * If the flag is set, the type name is output in [] in the node label,
324 * else it is output as info.
326 void dump_analysed_type_info(bool b);
329 * Write the address of a node into the vcg info.
330 * This is off per default for automatic comparisons of
331 * vcg graphs -- these will differ in the pointer values!
333 void dump_pointer_values_to_info(bool b);
336 # endif /* _IRDUMP_H_ */