2 * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Write vcg representation of firm to file.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Hubert Schmidt
26 * Dump routines for the ir graph and all type information.
28 * The dump format of most functions is vcg. This is a text based graph
29 * representation. Some use the original format,
30 * but most generate an extended format that is only read by some special
31 * versions of xvcg or by the comercialized version now calles aiSee.
32 * A test version of aiSee is available at
33 * http://www.absint.de/aisee/download/index.htm.
35 * We have developed an own advanced viewer called ycomp:
36 * http://www.info.uni-karlsruhe.de/software.php/id=6&lang=en
38 * Most routines use the name of the passed entity as the name of the
41 #ifndef FIRM_IR_IRDUMP_H
42 #define FIRM_IR_IRDUMP_H
49 * Symbolic names for the different dumping colors.
51 typedef enum ird_color_t {
52 ird_color_prog_background,
53 ird_color_block_background,
54 ird_color_dead_block_background,
55 ird_color_block_inout,
56 ird_color_default_node,
59 ird_color_controlflow,
63 ird_color_uses_memory,
72 data_edge = 0x01, /**< A data edge between two basic blocks. */
73 block_edge = 0x02, /**< An edge from a node to its basic block. */
74 cf_edge = 0x03, /**< A regularly control flow edge. */
75 exc_cf_edge = 0x04, /**< An exceptional control flow edge. */
76 mem_edge = 0x05, /**< A memory edge. */
77 dominator_edge = 0x06, /**< A dominator edge from a block to its immediate dominator. */
78 node2type_edge = 0x07, /**< An edge from an IR node to a type. */
80 ent_type_edge = 0x11, /**< An edge from an entity to its type. */
81 ent_own_edge = 0x12, /**< An edge from an entity to its owner type. */
82 ent_overwrites_edge = 0x13, /**< An edge from an entity to the entity it overwrites. */
83 ent_value_edge = 0x14, /**< An edge from an entity to its value entity. */
84 ent_corr_edge = 0x15, /**< An edge from an entity to the member entity its initializes. */
86 meth_par_edge = 0x21, /**< An edge from a method type to one of its parameter types. */
87 meth_res_edge = 0x22, /**< An edge from a method type to one of its result types. */
88 type_super_edge = 0x23, /**< An edge from a class type to its super/basis type. */
89 union_edge = 0x24, /**< An edge from a union type to its member types. */
90 ptr_pts_to_edge = 0x25, /**< An edge from a pointer type to its points-to type. */
91 arr_elt_type_edge = 0x26, /**< An edge from an array type to its element type. */
92 arr_ent_edge = 0x27, /**< An edge from a array type to its element entity. */
93 type_member_edge = 0x28, /**< An edge from a compound type to its member entities. */
95 /* additional flags */
96 intra_edge = 0, /**< Intra edge flag: edge do not cross basic block boundaries */
97 inter_edge = 0x40, /**< Inter edge flag: edge cross basic block boundaries */
98 back_edge = 0x80 /**< Backwards edge flag. */
101 /* **************************************************************************** */
103 /* **************************************************************************** */
106 * This hook is called to insert some special nodes into dumped graph
108 typedef int (*DUMP_IR_GRAPH_FUNC)(FILE *F, ir_graph *irg);
110 * This hook is called to dump the vcg attributes of a node to a file.
111 * If this function returns zero, the default attributes are added, else
114 typedef int (*DUMP_NODE_VCGATTR_FUNC)(FILE *F, ir_node *node, ir_node *local);
116 * This hook is called to dump the vcg attributes of an edge to a file.
117 * If this function returns zero, the default attributes are added, else
120 typedef int (*DUMP_EDGE_VCGATTR_FUNC)(FILE *F, ir_node *node, int to);
122 /** Set the ir graph dump hook. */
123 void set_dump_ir_graph_hook(DUMP_IR_GRAPH_FUNC hook);
124 /** Set the node_vcgattr hook. */
125 void set_dump_node_vcgattr_hook(DUMP_NODE_VCGATTR_FUNC hook);
126 /** Set the edge_vcgattr hook. */
127 void set_dump_edge_vcgattr_hook(DUMP_EDGE_VCGATTR_FUNC hook);
129 typedef int (*DUMP_NODE_EDGE_FUNC)(FILE *f, ir_node *node);
132 * Set the hook to be called to dump additional edges to a node.
133 * @param func The hook to be called.
135 void set_dump_node_edge_hook(DUMP_NODE_EDGE_FUNC func);
138 * Get the additional edge dump hook.
139 * @return The current additional edge dump hook.]
141 DUMP_NODE_EDGE_FUNC get_dump_node_edge_hook(void);
144 * Set the hook to be called to dump additional edges to a block.
145 * @param func The hook to be called.
147 void set_dump_block_edge_hook(DUMP_NODE_EDGE_FUNC func);
150 * Get the additional block edge dump hook.
151 * @return The current additional block edge dump hook.
153 DUMP_NODE_EDGE_FUNC get_dump_block_edge_hook(void);
155 /** Dump a firm graph.
157 * @param irg The firm graph to be dumped.
158 * @param suffix A suffix for the file name.
161 * A file containing the firm graph in vcg format.
163 * Dumps all Firm nodes of a single graph for a single procedure in
164 * standard xvcg format. Dumps the graph to a file. The file name
165 * is constructed from the name of the entity describing the
166 * procedure (irg->entity) and the ending -pure<-ip>.vcg. Eventually
167 * overwrites existing files. Visits all nodes in
168 * interprocedural_view.
170 * @see turn_off_edge_labels()
172 void dump_ir_graph (ir_graph *irg, const char *suffix);
173 void dump_ir_graph_file (ir_graph *irg, FILE *out);
175 /** Dump a firm graph without explicit block nodes.
177 * @param irg The firm graph to be dumped.
178 * @param suffix A suffix for the file name.
181 * A file containing the firm graph in vcg format.
183 * Dumps all Firm nodes of a single graph for a single procedure in
184 * extended xvcg format.
185 * Dumps the graph to a file. The file name is constructed from the
186 * name of the entity describing the procedure (irg->entity) and the
187 * ending <-ip>.vcg. Eventually overwrites existing files. Dumps several
188 * procedures in boxes if interprocedural_view.
190 * @see turn_off_edge_labels()
192 void dump_ir_block_graph (ir_graph *irg, const char *suffix);
193 void dump_ir_block_graph_file (ir_graph *irg, FILE *out);
195 /** Dump a firm graph without explicit block nodes but grouped in extended blocks.
197 * @param irg The firm graph to be dumped.
200 * A file containing the firm graph in vcg format.
202 * Dumps all Firm nodes of a single graph for a single procedure in
203 * extended xvcg format.
204 * Dumps the graph to a file. The file name is constructed from the
205 * name of the entity describing the procedure (irg->entity) and the
206 * ending <-ip>.vcg. Eventually overwrites existing files. Dumps several
207 * procedures in boxes if interprocedural_view.
209 * @see turn_off_edge_labels()
211 void dump_ir_extblock_graph (ir_graph *irg, const char *suffix);
212 void dump_ir_extblock_graph_file (ir_graph *irg, FILE *out);
214 /** Dumps all graphs in interprocedural view to a file named All_graphs<suffix>.vcg.
216 * @param suffix A suffix for the file name.
218 void dump_all_cg_block_graph(const char *suffix);
220 /** Dumps a firm graph and all the type information needed for Calls,
221 * Sels, ... in this graph.
223 * @param irg The firm graph to be dumped with its type information.
224 * @param suffix A suffix for the file name.
227 * A file containing the firm graph and the type information of the firm graph in vcg format.
229 * Dumps the 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 -all.vcg. Eventually overwrites existing files.
233 * @see turn_off_edge_labels()
235 void dump_ir_graph_w_types (ir_graph *irg, const char *suffix);
236 void dump_ir_graph_w_types_file (ir_graph *irg, FILE *out);
238 /** Dumps a firm graph and all the type information needed for Calls,
239 * Sels, ... in this graph.
241 * @param irg The firm graph to be dumped with its type information.
242 * @param suffix A suffix for the file name.
245 * A file containing the firm graph and the type information of the firm graph in vcg format.
247 * The graph is in blocked format.
248 * Dumps the graph to a file. The file name is constructed from the
249 * name of the entity describing the procedure (irg->entity) and the
250 * ending -all.vcg. Eventually overwrites existing files.
252 * @see turn_off_edge_labels()
254 void dump_ir_block_graph_w_types (ir_graph *irg, const char *suffix);
256 /** The type of a dump function that is called for each graph.
258 * @param irg current visited graph
259 * @param suffix A suffix for the file name.
261 typedef void dump_graph_func(ir_graph *irg, const char *suffix);
264 * A walker that calls a dumper for each graph.
266 * @param dump_graph The dumper to be used for dumping.
267 * @param suffix A suffix for the file name.
270 * Whatever the dumper creates.
272 * Walks over all firm graphs and calls a dumper for each graph.
273 * The following dumpers can be passed as arguments:
275 * - dump_ir_block_graph()
277 * - dump_type_graph()
278 * - dump_ir_graph_w_types()
280 * @see turn_off_edge_labels()
282 void dump_all_ir_graphs (dump_graph_func *dump_graph, const char *suffix);
286 * Dump the control flow graph of a procedure.
288 * @param irg The firm graph whose CFG shall be dumped.
289 * @param suffix A suffix for the file name.
292 * A file containing the CFG in vcg format.
294 * Dumps the control flow graph of a procedure in standard xvcg format.
295 * Dumps the graph to a file. The file name is constructed from the
296 * name of the entity describing the procedure (irg->entity) and the
297 * ending -cfg.vcg. Eventually overwrites existing files.
299 * @see turn_off_edge_labels()
301 void dump_cfg (ir_graph *irg, const char *suffix);
304 * Dump a node and its predecessors forming a subgraph to a vcg file.
306 * @param root The node serving as root for the subgraph.
307 * @param depth Dump nodes on paths starting at root with length depth.
308 * @param suffix A suffix for the file name.
310 * Dumps the graph to a file. The file name is constructed from the
311 * name of the entity describing the procedure the passed node is
312 * in, suffix and the ending -subg_<nr>.vcg. nr is a unique number
313 * for each graph dumped. Eventually overwrites existing files.
316 * A file containing the subgraph in vcg format.
318 void dump_subgraph (ir_node *root, int depth, const char *suffix);
320 /* **************************************************************************** */
321 /* CALLGRAPH DUMPERS */
322 /* **************************************************************************** */
325 /** Dump the call graph.
327 * Dumps the callgraph to a file "Callgraph"<suffix>".vcg".
329 * @param suffix A suffix for the file name.
331 * @see dump_callgraph_loop_tree(const char *suffix)
333 void dump_callgraph(const char *suffix);
335 /* **************************************************************************** */
336 /* TYPEGRAPH DUMPERS */
337 /* **************************************************************************** */
340 * Dumps all the type information needed for Calls, Sels, ... in this graph.
341 * Does not dump the graph!
343 * @param irg The firm graph whose type information is to be dumped.
344 * @param suffix A suffix for the file name.
347 * A file containing the type information of the firm graph in vcg format.
349 * Dumps this graph to a file. The file name is constructed from the
350 * name of the entity describing the procedure (irg->entity) and the
351 * ending -type.vcg. Eventually overwrites existing files.
353 * @see turn_off_edge_labels()
355 void dump_type_graph (ir_graph *irg, const char *suffix);
358 * Dumps all type information.
360 * @param suffix A suffix for the file name.
363 * A file containing all type information for the program in standard
366 * Dumps all type information that is somehow reachable in standard vcg
368 * Dumps the graph to a file named All_types.vcg.
370 * @see turn_off_edge_labels()
372 void dump_all_types (const char *suffix);
375 * Dumps the class hierarchy with or without entities.
377 * @param entities Flag whether to dump the entities.
378 * @param suffix A suffix for the file name.
381 * A file containing the class hierarchy tree for the program in standard
384 * Does not dump the global type.
385 * Dumps a node for all classes and the sub/supertype relations. If
386 * entities is set to true also dumps the entities of classes, but without
387 * any additional information as the entities type. The overwrites relation
388 * is dumped along with the entities.
389 * Dumps to a file class_hierarchy.vcg
391 void dump_class_hierarchy (int entities, const char *suffix);
393 /* **************************************************************************** */
394 /* LOOPTREE DUMPERS */
395 /* **************************************************************************** */
398 * Dump a standalone loop tree, which contains the loop nodes and the firm nodes
399 * belonging to one loop packed together in one subgraph. Dumps to file
400 * <name of irg><suffix>-looptree.vcg
401 * Turns on edge labels by default.
403 * Implementing this dumper was stimulated by Florian Liekwegs similar dumper.
405 * @param irg Dump the loop tree for this graph.
406 * @param suffix A suffix for the file name.
408 void dump_loop_tree(ir_graph *irg, const char *suffix);
410 /** Dumps the firm nodes in the sub-loop-tree of loop to a graph.
412 * Dumps the loop nodes if dump_loop_information() is set.
413 * The name of the file is loop_<loop_nr><suffix>.vcg.
415 * @param l Dump the loop tree for this loop.
416 * @param suffix A suffix for the file name.
418 void dump_loop (ir_loop *l, const char *suffix);
420 /** Dumps the loop tree over the call graph.
422 * See for yourself what you can use this for.
423 * The filename is "Callgraph_looptree<suffix>.vcg".
425 * @param suffix A suffix for the file name.
427 void dump_callgraph_loop_tree(const char *suffix);
430 /* **************************************************************************** */
432 /* **************************************************************************** */
435 /** Write the irnode and all its attributes to the file passed.
437 int dump_irnode_to_file (FILE *f, ir_node *n);
439 /** Write the irnode and all its attributes to stdout.
441 void dump_irnode (ir_node *n);
443 /** Write the graph and all its attributes to the file passed.
444 * Does not write the nodes.
446 void dump_graph_to_file(FILE *F, ir_graph *irg);
448 /** Write the graph and all its attributes to stdout.
449 * Does not write the nodes.
451 void dump_graph(ir_graph *g);
454 /** Dump graph information as text.
456 * Often graphs are unhandy in their vcg representation. The text
457 * dumper represents the information for the firm nodes more compact,
458 * but the relations between the nodes only implicitly.
460 * The file name is the graph name (get_entity_name()), appended by
463 void dump_graph_as_text(ir_graph *irg, const char *suffix);
466 /** Verbosity for text dumpers */
468 dump_verbosity_onlynames = 0x00000001, /**< Only dump names. Turns off all other
469 flags up to 0x00010000. */
470 dump_verbosity_fields = 0x00000002, /**< Dump types and fields (like a type declaration). */
471 dump_verbosity_methods = 0x00000004, /**< Dump types and methods (like a type declaration). */
472 dump_verbosity_nostatic = 0x00000040, /**< Dump types and dynamic allocated fields (like a
473 type declaration). This excludes methods and
474 static, polymorphic fields. */
475 dump_verbosity_typeattrs = 0x00000008, /**< Dump all type attributes. */
476 dump_verbosity_entattrs = 0x00000010, /**< Dump all entity attributes. */
477 dump_verbosity_entconsts = 0x00000020, /**< Dump entity constants. */
479 dump_verbosity_accessStats = 0x00000100, /**< Dump entity access statistics. */
480 dump_verbosity_csv = 0x00000200, /**< Dump access statistics as comma separated list. */
482 dump_verbosity_noClassTypes = 0x00001000, /**< Dump no class types. */
483 dump_verbosity_noStructTypes = 0x00002000, /**< Dump no struct types. */
484 dump_verbosity_noUnionTypes = 0x00004000, /**< Dump no union types. */
485 dump_verbosity_noArrayTypes = 0x00008000, /**< Dump no array types. */
486 dump_verbosity_noPointerTypes = 0x00010000, /**< Dump no pointer types. */
487 dump_verbosity_noMethodTypes = 0x00020000, /**< Dump no method types. */
488 dump_verbosity_noPrimitiveTypes = 0x00040000, /**< Dump no primitive types .*/
489 dump_verbosity_noEnumerationTypes= 0x00080000, /**< Dump no enumeration types. */
491 dump_verbosity_onlyClassTypes = 0x000FE000, /**< Dump only class types. */
492 dump_verbosity_onlyStructTypes = 0x000FD000, /**< Dump only struct types. */
493 dump_verbosity_onlyUnionTypes = 0x000FB000, /**< Dump only union types. */
494 dump_verbosity_onlyArrayTypes = 0x000F7000, /**< Dump only array types. */
495 dump_verbosity_onlyPointerTypes = 0x000EF000, /**< Dump only pointer types. */
496 dump_verbosity_onlyMethodTypes = 0x000DF000, /**< Dump only method types. */
497 dump_verbosity_onlyPrimitiveTypes = 0x000BF000, /**< Dump only primitive types. */
498 dump_verbosity_onlyEnumerationTypes=0x0007F000, /**< Dump only enumeration types. */
500 dump_verbosity_max = 0x4FF00FBE /**< Turn on all verbosity.
501 Do not turn on negative flags!
502 @@@ Because of a bug in gcc 3.2 we can not set the
507 /** Write the entity and all its attributes to the passed file.
509 void dump_entity_to_file (FILE *F, ir_entity *ent, unsigned verbosity);
511 /** Write the entity and all its attributes to the stdout.
513 * Calls dump_entity_to_file(). */
514 void dump_entity (ir_entity *ent);
516 /** Write the type and all its attributes to the file passed.
518 void dump_type_to_file (FILE *f, ir_type *tp, dump_verbosity verbosity);
520 /** Write the type and all its attributes to stdout.
522 void dump_type (ir_type *tp);
525 /** Dump type information as text.
527 * Often type graphs are unhandy in their vcg representation. The text
528 * dumper represents the information for a single type more compact, but
529 * the relations between the types only implicitly.
530 * Dumps only 'real' types, i.e., those in the type list. Does not dump
531 * the global type nor frame types or the like.
533 * The file name is the program name (get_irp_name()), or 'TextTypes'
534 * if the program name is not set, appended by <suffix>-types.txt.
535 * For verbosity see the documentation of the verbosity flags above.
537 void dump_types_as_text(unsigned verbosity, const char *suffix);
539 /** Dumps all global variables as text.
541 * @param suffix A suffix for the file name.
543 * Dumps a text representation of the entities in the global type.
545 * The file name is the program name (get_irp_name()), or 'TextTypes'
546 * if the program name is not set, appended by <suffix>-globals.txt.
547 * For verbosity see the documentation of the verbosity flags above.
549 void dump_globals_as_text(unsigned verbosity, const char *suffix);
551 /* **************************************************************************** */
553 /* **************************************************************************** */
555 /** Set a prefix filter for output functions.
557 * All graph dumpers check this name. If the name is != "" and
558 * not a prefix of the graph to be dumped, the dumper does not
561 * @param name The prefix of the name (not the ld_name) of the method
562 * entity to be dumped.
564 void only_dump_method_with_name(ident *name);
566 /** Returns the prefix filter set with only_dump_method_with_name(). */
567 ident *get_dump_file_filter_ident(void);
569 /** Returns true if dump file filter is not set, or if it is a
571 int is_filtered_dump_name(ident *name);
573 /** Sets the vcg flag "display_edge_labels" to no.
575 * This is necessary as xvcg and aisee both fail to display graphs
576 * with self-edges if these edges have labels.
578 void turn_off_edge_labels(void);
581 * If set to non-zero constants will be replicated for every use. In non
582 * blocked view edges from constant to block are skipped. Vcg then
583 * layouts the graphs more compact, this makes them better readable.
584 * The flag is automatically and temporarily set to false if other
585 * edges are dumped, as outs, loop, ...
586 * Default setting: false.
588 void dump_consts_local(int flag);
591 * if set to non-zero node idx will be added to node labels
593 void dump_node_idx_label(int flag);
595 /** Turns off dumping the values of constant entities. Makes type graphs
598 void dump_constant_entity_values(int flag);
600 /** Turns on dumping the edges from the End node to nodes to be kept
603 void dump_keepalive_edges(int flag);
604 int get_opt_dump_keepalive_edges(void);
606 /** Turns on dumping the out edges starting from the Start block in
609 * To test the consistency of the out data structure.
611 void dump_out_edges(int flag);
613 /** If this flag is set the dumper dumps edges to immediate dominator in cfg.
615 void dump_dominator_information(int flag);
617 /** If this flag is set the dumper dumps loop nodes and edges from
618 * these nodes to the contained ir nodes.
620 * If the loops are interprocedural nodes can be missing.
622 void dump_loop_information(int flag);
624 /** If set and backedge info is computed, backedges are dumped dashed
625 * and as vcg 'backedge' construct.
629 void dump_backedge_information(int flag);
631 /** Dump the information of type field specified in ana/irtypeinfo.h.
633 * If the flag is set, the type name is output in [] in the node label,
634 * else it is output as info.
636 void set_opt_dump_analysed_type_info(int flag);
638 /** Write the address of a node into the vcg info.
640 * This is off per default for automatic comparisons of
641 * vcg graphs -- these will differ in the pointer values!
643 void dump_pointer_values_to_info(int flag);
645 /** Dumps ld_names of entities instead of there names.
647 * This option is on per default.
649 void dump_ld_names(int flag);
651 /** Dumps all graph anchor nodes, even if they
654 * This option is off per default.
656 void dump_all_anchors(int flag);
658 /** Dumps a MacroBlock edge from every Block to its
661 * This option is off per default.
663 void dump_macroblock_edges(int flag);
665 /** A node info dumper callback. */
666 typedef void (dump_node_info_cb_t)(void *data, FILE *f, const ir_node *n);
669 * Adds a new node info dumper callback. It is possible to add an unlimited
670 * number of callbacks. The callbacks are called at the end of the default
673 * @param cb the callback function to be called
674 * @param data a context parameter
676 * @return A callback handle.
678 * @note This functionality is only available, if Firm hooks are enabled (default).
680 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data);
683 * Remove a previously added info dumper callback.
685 * @param handle the callback handle returned from dump_add_node_info_callback()
687 void dump_remv_node_info_callback(void *handle);