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 /* **************************************************************************** */
43 /* **************************************************************************** */
45 /** Dump a firm graph.
47 * @param irg The firm graph to be dumped.
50 * A file containing the firm graph in vcg format.
52 * Dumps all Firm nodes of a single graph for a single procedure in
53 * standard xvcg format. Dumps the graph to a file. The file name
54 * is constructed from the name of the entity describing the
55 * procedure (irg->entity) and the ending -pure<-ip>.vcg. Eventually
56 * overwrites existing files. Visits all nodes in
57 * interprocedural_view.
59 * @see turn_off_edge_labels()
61 void dump_ir_graph (ir_graph *irg, const char *suffix);
63 /** Dump a firm graph without explicit block nodes.
65 * @param irg The firm graph to be dumped.
68 * A file containing the firm graph in vcg format.
70 * Dumps all Firm nodes of a single graph for a single procedure in
71 * extended xvcg format.
72 * Dumps the graph to a file. The file name is constructed from the
73 * name of the entity describing the procedure (irg->entity) and the
74 * ending <-ip>.vcg. Eventually overwrites existing files. Dumps several
75 * procedures in boxes if interprocedural_view.
77 * @see turn_off_edge_labels()
79 void dump_ir_block_graph (ir_graph *irg, const char *suffix);
81 /** Dumps all graphs in interprocedural view to a file named All_graphs.vcg.
83 void dump_all_cg_block_graph(const char *suffix);
85 /** Dumps a firm graph and all the type information needed for Calls,
86 * Sels, ... in this graph.
88 * @param irg The firm graph to be dumped with its type information.
91 * A file containing the firm graph and the type information of the firm graph in vcg format.
93 * Dumps the graph to a file. The file name is constructed from the
94 * name of the entity describing the procedure (irg->entity) and the
95 * ending -all.vcg. Eventually overwrites existing files.
97 * @see turn_off_edge_labels()
99 void dump_ir_graph_w_types (ir_graph *irg, const char *suffix);
101 /** Dumps a firm graph and all the type information needed for Calls,
102 * Sels, ... in this graph.
104 * @param irg The firm graph to be dumped with its type information.
107 * A file containing the firm graph and the type information of the firm graph in vcg format.
109 * The graph is in blocked format.
110 * Dumps the graph to a file. The file name is constructed from the
111 * name of the entity describing the procedure (irg->entity) and the
112 * ending -all.vcg. Eventually overwrites existing files.
114 * @see turn_off_edge_labels()
116 void dump_ir_block_graph_w_types (ir_graph *irg, const char *suffix);
118 /** The type of a walker function that is called for each graph.
120 * @param irg current visited graph
122 typedef void dump_graph_func(ir_graph *irg, const char *suffix);
124 /** A walker that calls a dumper for each graph.
126 * @param dump_graph The dumper to be used for dumping.
129 * Whatever the dumper creates.
131 * Walks over all firm graphs and calls a dumper for each graph.
132 * The following dumpers can be passed as arguments:
134 * - dump_ir_block_graph()
136 * - dump_type_graph()
137 * - dump_ir_graph_w_types()
139 * @see turn_off_edge_labels()
141 void dump_all_ir_graphs (dump_graph_func *dump_graph, const char *suffix);
144 /** Dump the control flow graph of a procedure.
146 * @param irg The firm graph whose CFG shall be dumped.
149 * A file containing the CFG in vcg format.
151 * Dumps the control flow graph of a procedure in standard xvcg format.
152 * Dumps the graph to a file. The file name is constructed from the
153 * name of the entity describing the procedure (irg->entity) and the
154 * ending -cfg.vcg. Eventually overwrites existing files.
156 * @see turn_off_edge_labels()
158 void dump_cfg (ir_graph *irg, const char *suffix);
161 /* **************************************************************************** */
162 /* CALLGRAPH DUMPERS */
163 /* **************************************************************************** */
166 /** Dump the call graph.
168 * Dumps the callgraph to a file "Callgraph"<suffix>".vcg".
170 void dump_callgraph(const char *suffix);
172 /* **************************************************************************** */
173 /* TYPEGRAPH DUMPERS */
174 /* **************************************************************************** */
177 * Dumps all the type information needed for Calls, Sels, ... in this graph.
178 * Does not dump the graph!
180 * @param irg The firm graph whose type information is to be dumped.
182 * A file containing the type information of the firm graph in vcg format.
184 * Dumps this graph to a file. The file name is constructed from the
185 * name of the entity describing the procedure (irg->entity) and the
186 * ending -type.vcg. Eventually overwrites existing files.
188 * @see turn_off_edge_labels()
190 void dump_type_graph (ir_graph *irg, const char *suffix);
192 /** Dumps all type information.
195 * A file containing all type information for the program in standard
198 * Dumps all type information that is somehow reachable in standard vcg
200 * Dumps the graph to a file named All_types.vcg.
202 * @see turn_off_edge_labels()
204 void dump_all_types (const char *suffix);
206 /** Dumps the class hierarchy with or without entities.
208 * @param entities Flag whether to dump the entities.
211 * A file containing the class hierarchy tree for the program in standard
214 * Does not dump the global type.
215 * Dumps a node for all classes and the sub/supertype relations. If
216 * entities is set to true also dumps the entities of classes, but without
217 * any additional information as the entities type. The overwrites relation
218 * is dumped along with the entities.
219 * Dumps to a file class_hierarchy.vcg
221 void dump_class_hierarchy (bool entities, const char *suffix);
223 /* **************************************************************************** */
224 /* LOOPTREE DUMPERS */
225 /* **************************************************************************** */
228 * Dump a standalone loop tree, which contains the loop nodes and the firm nodes
229 * belonging to one loop packed together in one subgraph. Dumps to file
230 * <name of irg><suffix>-looptree.vcg
231 * Turns on edge labels by default.
233 * Implementing this dumper was stimulated by Florian Liekwegs similar dumper.
235 * @arg irg Dump the loop tree for this graph.
236 * @arg suffix Suffix to filename.
238 void dump_loop_tree(ir_graph *irg, const char *suffix);
240 /** Dumps the firm nodes in the sub-loop-tree of loop to a graph.
242 * Dumps the loop nodes if dump_loop_information() is set.
243 * The name of the file is loop_<loop_nr><suffix>.vcg.
245 * @arg loop Dump the loop tree for this loop.
246 * @arg suffix Suffix to filename.
248 void dump_loop (ir_loop *l, const char *suffix);
250 /** Dumps the loop tree over the call graph.
252 * See for yourself what you can use this for.
253 * The filename is "Callgraph_looptree<suffix>.vcg".
255 * @arg suffix Suffix to filename.
257 void dump_callgraph_loop_tree(const char *suffix);
260 /* **************************************************************************** */
262 /* **************************************************************************** */
264 /** Verbosity for text dumpers */
266 dump_verbosity_onlynames = 0x00000001, /**< only dump names. turns off all other
267 flags up to 0x00010000. */
268 dump_verbosity_fields = 0x00000002, /**< dump types and fields (like a type declaration) */
269 dump_verbosity_methods = 0x00000004, /**< dump types and methods (like a type declaration) */
270 dump_verbosity_typeattrs = 0x00000008, /**< dump all type attributes */
271 dump_verbosity_entattrs = 0x00000010, /**< dump all entity attributes */
272 dump_verbosity_entconsts = 0x00000020, /**< dump entity constants */
274 dump_verbosity_accessStats = 0x00000100, /**< dump entity access statistics */
275 dump_verbosity_csv = 0x00000200, /**< dump access statistics as comma separated list */
277 dump_verbosity_noClassTypes = 0x00001000, /**< dump no class types */
278 dump_verbosity_noStructTypes = 0x00002000, /**< dump no struct types */
279 dump_verbosity_noUnionTypes = 0x00004000, /**< dump no union types */
280 dump_verbosity_noArrayTypes = 0x00008000, /**< dump no array types */
281 dump_verbosity_noPointerTypes = 0x00010000, /**< dump no pointer types */
282 dump_verbosity_noMethodTypes = 0x00020000, /**< dump no method types */
283 dump_verbosity_noPrimitiveTypes = 0x00040000, /**< dump no primitive types */
284 dump_verbosity_noEnumerationTypes= 0x00080000, /**< dump no enumeration types */
286 dump_verbosity_onlyClassTypes = 0x000FE000, /**< dump only class types */
287 dump_verbosity_onlyStructTypes = 0x000FD000, /**< dump only struct types */
288 dump_verbosity_onlyUnionTypes = 0x000FB000, /**< dump only union types */
289 dump_verbosity_onlyArrayTypes = 0x000F7000, /**< dump only array types */
290 dump_verbosity_onlyPointerTypes = 0x000EF000, /**< dump only pointer types */
291 dump_verbosity_onlyMethodTypes = 0x000DF000, /**< dump only method types */
292 dump_verbosity_onlyPrimitiveTypes = 0x000BF000, /**< dump only primitive types */
293 dump_verbosity_onlyEnumerationTypes=0x0007F000, /**< dump only enumeration types */
295 dump_verbosity_max = 0x4FF00FFE /**< turn on all verbosity.
296 @@@ Because of a bug in gcc 3.2 we can not set the first two bits. */
300 /** Write the entity and all its attributes to the passed file.
302 void dump_entity_to_file (FILE *F, entity *ent, unsigned verbosity);
304 /** Write the entity and all its attributes to the stdout.
306 * Calls dump_entity_to_file(). */
307 void dump_entity (entity *ent);
309 /** Write the type and all its attributes to the file passed.
311 void dump_type_to_file (FILE *f, type *tp, unsigned verbosity);
313 /** Write the type and all its attributes to stdout.
315 void dump_type (type *tp);
318 /** Dump type information as text.
320 * Often type graphs are unhandy in their vcg representation. The text
321 * dumper represents the information for a single type more compact, but
322 * the relations between the types only implicitly.
323 * Dumps only 'real' types, i.e., those in the type list. Does not dump
324 * the global type nor frame types or the like.
326 * The file name is the program name (get_irp_name()), or 'TextTypes'
327 * if the program name is not set, appended by <suffix>-types.txt.
328 * For verbosity see the documentation of the verbosity flags above.
330 void dump_types_as_text(unsigned verbosity, const char *suffix);
332 /* **************************************************************************** */
334 /* **************************************************************************** */
336 /** Output a selected graph.
338 * All graph dumpers check this name. If the name is != "" and
339 * not a prefix of the graph to be dumped, the dumper does not
342 * @param name The prefix of the name (not the ld_name) of the method
343 * entity to be dumped.
345 void only_dump_method_with_name(ident *name);
347 /** Sets the vcg flag "display_edge_labels" to no.
349 * This is necessary as xvcg and aisee both fail to display graphs
350 * with self-edges if these edges have labes.
352 void turn_off_edge_labels(void);
355 * If set to true constants will be replicated for every use. In non
356 * blocked view edges from constant to block are skipped. Vcg then
357 * layouts the graphs more compact, this makes them better readable.
358 * The flag is automatically and temporarily set to false if other
359 * edges are dumped, as outs, loop, ...
360 * Default setting: false.
362 void dump_consts_local(bool b);
365 * Returns false if dump_out_edge_flag or dump_loop_information_flag
366 * are set, else returns dump_const_local_flag.
368 bool get_opt_dump_const_local(void);
370 /** Turns off dumping the values of constant entities. Makes type graphs
373 void turn_off_constant_entity_values(void);
375 /** Turns on dumping the edges from the End node to nodes to be kept
378 void dump_keepalive_edges(bool b);
379 bool get_opt_dump_keepalive_edges(void);
381 /** Turns on dumping the out edges starting from the Start block in
384 * To test the consistency of the out datastructure.
386 void dump_out_edges(void);
388 /** If this flag is set the dumper dumps edges to immediate dominator in cfg.
390 void dump_dominator_information(void);
392 /** If this flag is set the dumper dumps loop nodes and edges from
393 * these nodes to the contained ir nodes.
395 * Can be turned off with dont_dump_loop_information().
396 * If the loops are interprocedural nodes can be missing.
398 void dump_loop_information(void);
401 * @see dump_loop_information()
403 void dont_dump_loop_information(void);
405 /** If set and backedge info is computed, backedges are dumped dashed
406 * and as vcg 'backedge' construct.
410 void dump_backedge_information(bool b);
412 /** Dump the information of type field specified in ana/irtypeinfo.h.
414 * If the flag is set, the type name is output in [] in the node label,
415 * else it is output as info.
417 void dump_analysed_type_info(bool b);
419 /** Write the address of a node into the vcg info.
421 * This is off per default for automatic comparisons of
422 * vcg graphs -- these will differ in the pointer values!
424 void dump_pointer_values_to_info(bool b);
427 # endif /* _IRDUMP_H_ */