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 /* **************************************************************************** */
46 * This hook is called to dump the vcg attributes of a node to a file.
47 * If this function returns zero, the default attributes are added, else
50 typedef int (*DUMP_NODE_VCGATTR_FUNC)(FILE *F, ir_node *node, ir_node *local);
52 /** Set the node_vcgattr hook. */
53 void set_dump_node_vcgattr_hook(DUMP_NODE_VCGATTR_FUNC hook);
55 /** Dump a firm graph.
57 * @param irg The firm graph to be dumped.
60 * A file containing the firm graph in vcg format.
62 * Dumps all Firm nodes of a single graph for a single procedure in
63 * standard xvcg format. Dumps the graph to a file. The file name
64 * is constructed from the name of the entity describing the
65 * procedure (irg->entity) and the ending -pure<-ip>.vcg. Eventually
66 * overwrites existing files. Visits all nodes in
67 * interprocedural_view.
69 * @see turn_off_edge_labels()
71 void dump_ir_graph (ir_graph *irg, const char *suffix);
73 /** Dump a firm graph without explicit block nodes.
75 * @param irg The firm graph to be dumped.
78 * A file containing the firm graph in vcg format.
80 * Dumps all Firm nodes of a single graph for a single procedure in
81 * extended xvcg format.
82 * Dumps the graph to a file. The file name is constructed from the
83 * name of the entity describing the procedure (irg->entity) and the
84 * ending <-ip>.vcg. Eventually overwrites existing files. Dumps several
85 * procedures in boxes if interprocedural_view.
87 * @see turn_off_edge_labels()
89 void dump_ir_block_graph (ir_graph *irg, const char *suffix);
91 /** Dumps all graphs in interprocedural view to a file named All_graphs.vcg.
93 void dump_all_cg_block_graph(const char *suffix);
95 /** Dumps a firm graph and all the type information needed for Calls,
96 * Sels, ... in this graph.
98 * @param irg The firm graph to be dumped with its type information.
101 * A file containing the firm graph and the type information of the firm graph in vcg format.
103 * Dumps the graph to a file. The file name is constructed from the
104 * name of the entity describing the procedure (irg->entity) and the
105 * ending -all.vcg. Eventually overwrites existing files.
107 * @see turn_off_edge_labels()
109 void dump_ir_graph_w_types (ir_graph *irg, const 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, const char *suffix);
128 /** The type of a walker function that is called for each graph.
130 * @param irg current visited graph
132 typedef void dump_graph_func(ir_graph *irg, const char *suffix);
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, const char *suffix);
154 /** Dump the control flow graph of a procedure.
156 * @param irg The firm graph whose CFG shall be dumped.
159 * A file containing the CFG in vcg format.
161 * Dumps the control flow graph of a procedure in standard xvcg format.
162 * Dumps the graph to a file. The file name is constructed from the
163 * name of the entity describing the procedure (irg->entity) and the
164 * ending -cfg.vcg. Eventually overwrites existing files.
166 * @see turn_off_edge_labels()
168 void dump_cfg (ir_graph *irg, const char *suffix);
170 /** Dump a node and its predecessors forming a subgraph to a vcg file.
172 * @param root The node serving as root for the subgraph.
173 * @param depth Dump nodes on paths starting at root with length depth.
174 * @param suffix A suffix for the file name.
176 * Dumps the graph to a file. The file name is constructed from the
177 * name of the entity describing the procedure the passed node is
178 * in, suffix and the ending -subg_<nr>.vcg. nr is a unique number
179 * for each graph dumped. Eventually overwrites existing files.
182 * A file containing the subgraph in vcg format.
184 void dump_subgraph (ir_node *root, int depth, const char *suffix);
186 /* **************************************************************************** */
187 /* CALLGRAPH DUMPERS */
188 /* **************************************************************************** */
191 /** Dump the call graph.
193 * Dumps the callgraph to a file "Callgraph"<suffix>".vcg".
195 void dump_callgraph(const char *suffix);
197 /* **************************************************************************** */
198 /* TYPEGRAPH DUMPERS */
199 /* **************************************************************************** */
202 * Dumps all the type information needed for Calls, Sels, ... in this graph.
203 * Does not dump the graph!
205 * @param irg The firm graph whose type information is to be dumped.
207 * A file containing the type information of the firm graph in vcg format.
209 * Dumps this graph to a file. The file name is constructed from the
210 * name of the entity describing the procedure (irg->entity) and the
211 * ending -type.vcg. Eventually overwrites existing files.
213 * @see turn_off_edge_labels()
215 void dump_type_graph (ir_graph *irg, const char *suffix);
217 /** Dumps all type information.
220 * A file containing all type information for the program in standard
223 * Dumps all type information that is somehow reachable in standard vcg
225 * Dumps the graph to a file named All_types.vcg.
227 * @see turn_off_edge_labels()
229 void dump_all_types (const char *suffix);
231 /** Dumps the class hierarchy with or without entities.
233 * @param entities Flag whether to dump the entities.
236 * A file containing the class hierarchy tree for the program in standard
239 * Does not dump the global type.
240 * Dumps a node for all classes and the sub/supertype relations. If
241 * entities is set to true also dumps the entities of classes, but without
242 * any additional information as the entities type. The overwrites relation
243 * is dumped along with the entities.
244 * Dumps to a file class_hierarchy.vcg
246 void dump_class_hierarchy (bool entities, const char *suffix);
248 /* **************************************************************************** */
249 /* LOOPTREE DUMPERS */
250 /* **************************************************************************** */
253 * Dump a standalone loop tree, which contains the loop nodes and the firm nodes
254 * belonging to one loop packed together in one subgraph. Dumps to file
255 * <name of irg><suffix>-looptree.vcg
256 * Turns on edge labels by default.
258 * Implementing this dumper was stimulated by Florian Liekwegs similar dumper.
260 * @arg irg Dump the loop tree for this graph.
261 * @arg suffix Suffix to filename.
263 void dump_loop_tree(ir_graph *irg, const char *suffix);
265 /** Dumps the firm nodes in the sub-loop-tree of loop to a graph.
267 * Dumps the loop nodes if dump_loop_information() is set.
268 * The name of the file is loop_<loop_nr><suffix>.vcg.
270 * @arg loop Dump the loop tree for this loop.
271 * @arg suffix Suffix to filename.
273 void dump_loop (ir_loop *l, const char *suffix);
275 /** Dumps the loop tree over the call graph.
277 * See for yourself what you can use this for.
278 * The filename is "Callgraph_looptree<suffix>.vcg".
280 * @arg suffix Suffix to filename.
282 void dump_callgraph_loop_tree(const char *suffix);
285 /* **************************************************************************** */
287 /* **************************************************************************** */
290 /** Write the irnode and all its attributes to the file passed.
292 int dump_irnode_to_file (FILE *f, ir_node *n);
294 /** Write the irnode and all its attributes to stdout.
296 void dump_irnode (ir_node *n);
298 /** Write the graph and all its attributes to the file passed.
299 * Does not write the nodes.
301 void dump_graph_to_file(FILE *F, ir_graph *irg);
303 /** Write the graph and all its attributes to stdout.
304 * Does not write the nodes.
306 void dump_graph(ir_graph *g);
309 /** Dump graph information as text.
311 * Often graphs are unhandy in their vcg representation. The text
312 * dumper represents the information for the firm nodes more compact,
313 * but the relations between the nodes only implicitly.
315 * The file name is the graph name (get_entity_name()), appended by
318 void dump_graph_as_text(ir_graph *irg, const char *suffix);
321 /** Verbosity for text dumpers */
323 dump_verbosity_onlynames = 0x00000001, /**< only dump names. turns off all other
324 flags up to 0x00010000. */
325 dump_verbosity_fields = 0x00000002, /**< dump types and fields (like a type declaration) */
326 dump_verbosity_methods = 0x00000004, /**< dump types and methods (like a type declaration) */
327 dump_verbosity_typeattrs = 0x00000008, /**< dump all type attributes */
328 dump_verbosity_entattrs = 0x00000010, /**< dump all entity attributes */
329 dump_verbosity_entconsts = 0x00000020, /**< dump entity constants */
331 dump_verbosity_accessStats = 0x00000100, /**< dump entity access statistics */
332 dump_verbosity_csv = 0x00000200, /**< dump access statistics as comma separated list */
334 dump_verbosity_noClassTypes = 0x00001000, /**< dump no class types */
335 dump_verbosity_noStructTypes = 0x00002000, /**< dump no struct types */
336 dump_verbosity_noUnionTypes = 0x00004000, /**< dump no union types */
337 dump_verbosity_noArrayTypes = 0x00008000, /**< dump no array types */
338 dump_verbosity_noPointerTypes = 0x00010000, /**< dump no pointer types */
339 dump_verbosity_noMethodTypes = 0x00020000, /**< dump no method types */
340 dump_verbosity_noPrimitiveTypes = 0x00040000, /**< dump no primitive types */
341 dump_verbosity_noEnumerationTypes= 0x00080000, /**< dump no enumeration types */
343 dump_verbosity_onlyClassTypes = 0x000FE000, /**< dump only class types */
344 dump_verbosity_onlyStructTypes = 0x000FD000, /**< dump only struct types */
345 dump_verbosity_onlyUnionTypes = 0x000FB000, /**< dump only union types */
346 dump_verbosity_onlyArrayTypes = 0x000F7000, /**< dump only array types */
347 dump_verbosity_onlyPointerTypes = 0x000EF000, /**< dump only pointer types */
348 dump_verbosity_onlyMethodTypes = 0x000DF000, /**< dump only method types */
349 dump_verbosity_onlyPrimitiveTypes = 0x000BF000, /**< dump only primitive types */
350 dump_verbosity_onlyEnumerationTypes=0x0007F000, /**< dump only enumeration types */
352 dump_verbosity_max = 0x4FF00FFE /**< turn on all verbosity.
353 @@@ Because of a bug in gcc 3.2 we can not set the first two bits. */
357 /** Write the entity and all its attributes to the passed file.
359 void dump_entity_to_file (FILE *F, entity *ent, unsigned verbosity);
361 /** Write the entity and all its attributes to the stdout.
363 * Calls dump_entity_to_file(). */
364 void dump_entity (entity *ent);
366 /** Write the type and all its attributes to the file passed.
368 void dump_type_to_file (FILE *f, type *tp, dump_verbosity verbosity);
370 /** Write the type and all its attributes to stdout.
372 void dump_type (type *tp);
375 /** Dump type information as text.
377 * Often type graphs are unhandy in their vcg representation. The text
378 * dumper represents the information for a single type more compact, but
379 * the relations between the types only implicitly.
380 * Dumps only 'real' types, i.e., those in the type list. Does not dump
381 * the global type nor frame types or the like.
383 * The file name is the program name (get_irp_name()), or 'TextTypes'
384 * if the program name is not set, appended by <suffix>-types.txt.
385 * For verbosity see the documentation of the verbosity flags above.
387 void dump_types_as_text(unsigned verbosity, const char *suffix);
389 /* **************************************************************************** */
391 /* **************************************************************************** */
393 /** Output a selected graph.
395 * All graph dumpers check this name. If the name is != "" and
396 * not a prefix of the graph to be dumped, the dumper does not
399 * @param name The prefix of the name (not the ld_name) of the method
400 * entity to be dumped.
402 void only_dump_method_with_name(ident *name);
404 /** Sets the vcg flag "display_edge_labels" to no.
406 * This is necessary as xvcg and aisee both fail to display graphs
407 * with self-edges if these edges have lables.
409 void turn_off_edge_labels(void);
412 * If set to true constants will be replicated for every use. In non
413 * blocked view edges from constant to block are skipped. Vcg then
414 * layouts the graphs more compact, this makes them better readable.
415 * The flag is automatically and temporarily set to false if other
416 * edges are dumped, as outs, loop, ...
417 * Default setting: false.
419 void dump_consts_local(bool b);
422 * Returns false if dump_out_edge_flag or dump_loop_information_flag
423 * are set, else returns dump_const_local_flag.
425 bool get_opt_dump_const_local(void);
427 /** Turns off dumping the values of constant entities. Makes type graphs
430 void dump_constant_entity_values(bool b);
432 /** Turns on dumping the edges from the End node to nodes to be kept
435 void dump_keepalive_edges(bool b);
436 bool get_opt_dump_keepalive_edges(void);
438 /** Turns on dumping the out edges starting from the Start block in
441 * To test the consistency of the out datastructure.
443 void dump_out_edges(bool b);
445 /** If this flag is set the dumper dumps edges to immediate dominator in cfg.
447 void dump_dominator_information(bool b);
449 /** If this flag is set the dumper dumps loop nodes and edges from
450 * these nodes to the contained ir nodes.
452 * If the loops are interprocedural nodes can be missing.
454 void dump_loop_information(bool b);
456 /** If set and backedge info is computed, backedges are dumped dashed
457 * and as vcg 'backedge' construct.
461 void dump_backedge_information(bool b);
463 /** Dump the information of type field specified in ana/irtypeinfo.h.
465 * If the flag is set, the type name is output in [] in the node label,
466 * else it is output as info.
468 void dump_analysed_type_info(bool b);
470 /** Write the address of a node into the vcg info.
472 * This is off per default for automatic comparisons of
473 * vcg graphs -- these will differ in the pointer values!
475 void dump_pointer_values_to_info(bool b);
478 # endif /* _IRDUMP_H_ */