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 /** Dump a firm graph without explicit block nodes but grouped in extended blocks.
93 * @param irg The firm graph to be dumped.
96 * A file containing the firm graph in vcg format.
98 * Dumps all Firm nodes of a single graph for a single procedure in
99 * extended xvcg 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 <-ip>.vcg. Eventually overwrites existing files. Dumps several
103 * procedures in boxes if interprocedural_view.
105 * @see turn_off_edge_labels()
107 void dump_ir_extblock_graph (ir_graph *irg, const char *suffix);
109 /** Dumps all graphs in interprocedural view to a file named All_graphs.vcg.
111 void dump_all_cg_block_graph(const char *suffix);
113 /** Dumps a firm graph and all the type information needed for Calls,
114 * Sels, ... in this graph.
116 * @param irg The firm graph to be dumped with its type information.
119 * A file containing the firm graph and the type information of the firm graph in vcg format.
121 * Dumps the graph to a file. The file name is constructed from the
122 * name of the entity describing the procedure (irg->entity) and the
123 * ending -all.vcg. Eventually overwrites existing files.
125 * @see turn_off_edge_labels()
127 void dump_ir_graph_w_types (ir_graph *irg, const char *suffix);
129 /** Dumps a firm graph and all the type information needed for Calls,
130 * Sels, ... in this graph.
132 * @param irg The firm graph to be dumped with its type information.
135 * A file containing the firm graph and the type information of the firm graph in vcg format.
137 * The graph is in blocked format.
138 * Dumps the graph to a file. The file name is constructed from the
139 * name of the entity describing the procedure (irg->entity) and the
140 * ending -all.vcg. Eventually overwrites existing files.
142 * @see turn_off_edge_labels()
144 void dump_ir_block_graph_w_types (ir_graph *irg, const char *suffix);
146 /** The type of a walker function that is called for each graph.
148 * @param irg current visited graph
150 typedef void dump_graph_func(ir_graph *irg, const char *suffix);
152 /** A walker that calls a dumper for each graph.
154 * @param dump_graph The dumper to be used for dumping.
157 * Whatever the dumper creates.
159 * Walks over all firm graphs and calls a dumper for each graph.
160 * The following dumpers can be passed as arguments:
162 * - dump_ir_block_graph()
164 * - dump_type_graph()
165 * - dump_ir_graph_w_types()
167 * @see turn_off_edge_labels()
169 void dump_all_ir_graphs (dump_graph_func *dump_graph, const char *suffix);
172 /** Dump the control flow graph of a procedure.
174 * @param irg The firm graph whose CFG shall be dumped.
177 * A file containing the CFG in vcg format.
179 * Dumps the control flow graph of a procedure in standard xvcg format.
180 * Dumps the graph to a file. The file name is constructed from the
181 * name of the entity describing the procedure (irg->entity) and the
182 * ending -cfg.vcg. Eventually overwrites existing files.
184 * @see turn_off_edge_labels()
186 void dump_cfg (ir_graph *irg, const char *suffix);
188 /** Dump a node and its predecessors forming a subgraph to a vcg file.
190 * @param root The node serving as root for the subgraph.
191 * @param depth Dump nodes on paths starting at root with length depth.
192 * @param suffix A suffix for the file name.
194 * Dumps the graph to a file. The file name is constructed from the
195 * name of the entity describing the procedure the passed node is
196 * in, suffix and the ending -subg_<nr>.vcg. nr is a unique number
197 * for each graph dumped. Eventually overwrites existing files.
200 * A file containing the subgraph in vcg format.
202 void dump_subgraph (ir_node *root, int depth, const char *suffix);
204 /* **************************************************************************** */
205 /* CALLGRAPH DUMPERS */
206 /* **************************************************************************** */
209 /** Dump the call graph.
211 * Dumps the callgraph to a file "Callgraph"<suffix>".vcg".
213 * @see dump_callgraph_loop_tree(const char *suffix)
215 void dump_callgraph(const char *suffix);
217 /* **************************************************************************** */
218 /* TYPEGRAPH DUMPERS */
219 /* **************************************************************************** */
222 * Dumps all the type information needed for Calls, Sels, ... in this graph.
223 * Does not dump the graph!
225 * @param irg The firm graph whose type information is to be dumped.
227 * A file containing the type information of the firm graph in vcg format.
229 * Dumps this graph to a file. The file name is constructed from the
230 * name of the entity describing the procedure (irg->entity) and the
231 * ending -type.vcg. Eventually overwrites existing files.
233 * @see turn_off_edge_labels()
235 void dump_type_graph (ir_graph *irg, const char *suffix);
237 /** Dumps all type information.
240 * A file containing all type information for the program in standard
243 * Dumps all type information that is somehow reachable in standard vcg
245 * Dumps the graph to a file named All_types.vcg.
247 * @see turn_off_edge_labels()
249 void dump_all_types (const char *suffix);
251 /** Dumps the class hierarchy with or without entities.
253 * @param entities Flag whether to dump the entities.
256 * A file containing the class hierarchy tree for the program in standard
259 * Does not dump the global type.
260 * Dumps a node for all classes and the sub/supertype relations. If
261 * entities is set to true also dumps the entities of classes, but without
262 * any additional information as the entities type. The overwrites relation
263 * is dumped along with the entities.
264 * Dumps to a file class_hierarchy.vcg
266 void dump_class_hierarchy (bool entities, const char *suffix);
268 /* **************************************************************************** */
269 /* LOOPTREE DUMPERS */
270 /* **************************************************************************** */
273 * Dump a standalone loop tree, which contains the loop nodes and the firm nodes
274 * belonging to one loop packed together in one subgraph. Dumps to file
275 * <name of irg><suffix>-looptree.vcg
276 * Turns on edge labels by default.
278 * Implementing this dumper was stimulated by Florian Liekwegs similar dumper.
280 * @arg irg Dump the loop tree for this graph.
281 * @arg suffix Suffix to filename.
283 void dump_loop_tree(ir_graph *irg, const char *suffix);
285 /** Dumps the firm nodes in the sub-loop-tree of loop to a graph.
287 * Dumps the loop nodes if dump_loop_information() is set.
288 * The name of the file is loop_<loop_nr><suffix>.vcg.
290 * @arg loop Dump the loop tree for this loop.
291 * @arg suffix Suffix to filename.
293 void dump_loop (ir_loop *l, const char *suffix);
295 /** Dumps the loop tree over the call graph.
297 * See for yourself what you can use this for.
298 * The filename is "Callgraph_looptree<suffix>.vcg".
300 * @arg suffix Suffix to filename.
302 void dump_callgraph_loop_tree(const char *suffix);
305 /* **************************************************************************** */
307 /* **************************************************************************** */
310 /** Write the irnode and all its attributes to the file passed.
312 int dump_irnode_to_file (FILE *f, ir_node *n);
314 /** Write the irnode and all its attributes to stdout.
316 void dump_irnode (ir_node *n);
318 /** Write the graph and all its attributes to the file passed.
319 * Does not write the nodes.
321 void dump_graph_to_file(FILE *F, ir_graph *irg);
323 /** Write the graph and all its attributes to stdout.
324 * Does not write the nodes.
326 void dump_graph(ir_graph *g);
329 /** Dump graph information as text.
331 * Often graphs are unhandy in their vcg representation. The text
332 * dumper represents the information for the firm nodes more compact,
333 * but the relations between the nodes only implicitly.
335 * The file name is the graph name (get_entity_name()), appended by
338 void dump_graph_as_text(ir_graph *irg, const char *suffix);
341 /** Verbosity for text dumpers */
343 dump_verbosity_onlynames = 0x00000001, /**< only dump names. turns off all other
344 flags up to 0x00010000. */
345 dump_verbosity_fields = 0x00000002, /**< dump types and fields (like a type declaration) */
346 dump_verbosity_methods = 0x00000004, /**< dump types and methods (like a type declaration) */
347 dump_verbosity_nostatic = 0x00000040, /**< dump types and dynamic allocated fields (like a
348 type declaration). This excludes methods and
349 static, polymorphic fields. */
350 dump_verbosity_typeattrs = 0x00000008, /**< dump all type attributes */
351 dump_verbosity_entattrs = 0x00000010, /**< dump all entity attributes */
352 dump_verbosity_entconsts = 0x00000020, /**< dump entity constants */
354 dump_verbosity_accessStats = 0x00000100, /**< dump entity access statistics */
355 dump_verbosity_csv = 0x00000200, /**< dump access statistics as comma separated list */
357 dump_verbosity_noClassTypes = 0x00001000, /**< dump no class types */
358 dump_verbosity_noStructTypes = 0x00002000, /**< dump no struct types */
359 dump_verbosity_noUnionTypes = 0x00004000, /**< dump no union types */
360 dump_verbosity_noArrayTypes = 0x00008000, /**< dump no array types */
361 dump_verbosity_noPointerTypes = 0x00010000, /**< dump no pointer types */
362 dump_verbosity_noMethodTypes = 0x00020000, /**< dump no method types */
363 dump_verbosity_noPrimitiveTypes = 0x00040000, /**< dump no primitive types */
364 dump_verbosity_noEnumerationTypes= 0x00080000, /**< dump no enumeration types */
366 dump_verbosity_onlyClassTypes = 0x000FE000, /**< dump only class types */
367 dump_verbosity_onlyStructTypes = 0x000FD000, /**< dump only struct types */
368 dump_verbosity_onlyUnionTypes = 0x000FB000, /**< dump only union types */
369 dump_verbosity_onlyArrayTypes = 0x000F7000, /**< dump only array types */
370 dump_verbosity_onlyPointerTypes = 0x000EF000, /**< dump only pointer types */
371 dump_verbosity_onlyMethodTypes = 0x000DF000, /**< dump only method types */
372 dump_verbosity_onlyPrimitiveTypes = 0x000BF000, /**< dump only primitive types */
373 dump_verbosity_onlyEnumerationTypes=0x0007F000, /**< dump only enumeration types */
375 dump_verbosity_max = 0x4FF00FBE /**< turn on all verbosity.
376 Do not turn on negative flags!
377 @@@ Because of a bug in gcc 3.2 we can not set the
382 /** Write the entity and all its attributes to the passed file.
384 void dump_entity_to_file (FILE *F, entity *ent, unsigned verbosity);
386 /** Write the entity and all its attributes to the stdout.
388 * Calls dump_entity_to_file(). */
389 void dump_entity (entity *ent);
391 /** Write the type and all its attributes to the file passed.
393 void dump_type_to_file (FILE *f, type *tp, dump_verbosity verbosity);
395 /** Write the type and all its attributes to stdout.
397 void dump_type (type *tp);
400 /** Dump type information as text.
402 * Often type graphs are unhandy in their vcg representation. The text
403 * dumper represents the information for a single type more compact, but
404 * the relations between the types only implicitly.
405 * Dumps only 'real' types, i.e., those in the type list. Does not dump
406 * the global type nor frame types or the like.
408 * The file name is the program name (get_irp_name()), or 'TextTypes'
409 * if the program name is not set, appended by <suffix>-types.txt.
410 * For verbosity see the documentation of the verbosity flags above.
412 void dump_types_as_text(unsigned verbosity, const char *suffix);
414 /** Dumps all global variables as text.
416 * Dumps a text representation of the entities in the global type.
418 * The file name is the program name (get_irp_name()), or 'TextTypes'
419 * if the program name is not set, appended by <suffix>-globals.txt.
420 * For verbosity see the documentation of the verbosity flags above.
422 void dump_globals_as_text(unsigned verbosity, const char *suffix);
424 /* **************************************************************************** */
426 /* **************************************************************************** */
428 /** Output a selected graph.
430 * All graph dumpers check this name. If the name is != "" and
431 * not a prefix of the graph to be dumped, the dumper does not
434 * @param name The prefix of the name (not the ld_name) of the method
435 * entity to be dumped.
437 void only_dump_method_with_name(ident *name);
439 /** Returns the name set with only_dump_method_with_name(). */
440 ident *get_dump_file_filter_ident(void);
442 /** Returns true if dump file filter is not set, or if it is a
444 int is_filtered_dump_name(ident *name);
446 /** Sets the vcg flag "display_edge_labels" to no.
448 * This is necessary as xvcg and aisee both fail to display graphs
449 * with self-edges if these edges have lables.
451 void turn_off_edge_labels(void);
454 * If set to true constants will be replicated for every use. In non
455 * blocked view edges from constant to block are skipped. Vcg then
456 * layouts the graphs more compact, this makes them better readable.
457 * The flag is automatically and temporarily set to false if other
458 * edges are dumped, as outs, loop, ...
459 * Default setting: false.
461 void dump_consts_local(bool b);
464 * Returns false if dump_out_edge_flag or dump_loop_information_flag
465 * are set, else returns dump_const_local_flag.
467 bool get_opt_dump_const_local(void);
469 /** Turns off dumping the values of constant entities. Makes type graphs
472 void dump_constant_entity_values(bool b);
474 /** Turns on dumping the edges from the End node to nodes to be kept
477 void dump_keepalive_edges(bool b);
478 bool get_opt_dump_keepalive_edges(void);
480 /** Turns on dumping the out edges starting from the Start block in
483 * To test the consistency of the out datastructure.
485 void dump_out_edges(bool b);
487 /** If this flag is set the dumper dumps edges to immediate dominator in cfg.
489 void dump_dominator_information(bool b);
491 /** If this flag is set the dumper dumps loop nodes and edges from
492 * these nodes to the contained ir nodes.
494 * If the loops are interprocedural nodes can be missing.
496 void dump_loop_information(bool b);
498 /** If set and backedge info is computed, backedges are dumped dashed
499 * and as vcg 'backedge' construct.
503 void dump_backedge_information(bool b);
505 /** Dump the information of type field specified in ana/irtypeinfo.h.
507 * If the flag is set, the type name is output in [] in the node label,
508 * else it is output as info.
510 void set_opt_dump_analysed_type_info(bool b);
512 /** Write the address of a node into the vcg info.
514 * This is off per default for automatic comparisons of
515 * vcg graphs -- these will differ in the pointer values!
517 void dump_pointer_values_to_info(bool b);
520 # endif /* _IRDUMP_H_ */