2 * Copyright (C) 1995-2008 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
46 #include "firm_types.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,
73 data_edge = 0x01, /**< A data edge between two basic blocks. */
74 block_edge = 0x02, /**< An edge from a node to its basic block. */
75 cf_edge = 0x03, /**< A regularly control flow edge. */
76 exc_cf_edge = 0x04, /**< An exceptional control flow edge. */
77 mem_edge = 0x05, /**< A memory edge. */
78 dominator_edge = 0x06, /**< A dominator edge from a block to its immediate dominator. */
79 node2type_edge = 0x07, /**< An edge from an IR node to a type. */
81 ent_type_edge = 0x11, /**< An edge from an entity to its type. */
82 ent_own_edge = 0x12, /**< An edge from an entity to its owner type. */
83 ent_overwrites_edge = 0x13, /**< An edge from an entity to the entity it overwrites. */
84 ent_value_edge = 0x14, /**< An edge from an entity to its value entity. */
85 ent_corr_edge = 0x15, /**< An edge from an entity to the member entity its initializes. */
87 meth_par_edge = 0x21, /**< An edge from a method type to one of its parameter types. */
88 meth_res_edge = 0x22, /**< An edge from a method type to one of its result types. */
89 type_super_edge = 0x23, /**< An edge from a class type to its super/basis type. */
90 union_edge = 0x24, /**< An edge from a union type to its member types. */
91 ptr_pts_to_edge = 0x25, /**< An edge from a pointer type to its points-to type. */
92 arr_elt_type_edge = 0x26, /**< An edge from an array type to its element type. */
93 arr_ent_edge = 0x27, /**< An edge from a array type to its element entity. */
94 type_member_edge = 0x28, /**< An edge from a compound type to its member entities. */
96 /* additional flags */
97 intra_edge = 0, /**< Intra edge flag: edge do not cross basic block boundaries */
98 inter_edge = 0x40, /**< Inter edge flag: edge cross basic block boundaries */
99 back_edge = 0x80 /**< Backwards edge flag. */
102 /* **************************************************************************** */
104 /* **************************************************************************** */
107 * This hook is called to insert some special nodes into dumped graph
109 typedef int (*DUMP_IR_GRAPH_FUNC)(FILE *F, ir_graph *irg);
111 * This hook is called to dump the vcg attributes of a node to a file.
112 * If this function returns zero, the default attributes are added, else
115 typedef int (*DUMP_NODE_VCGATTR_FUNC)(FILE *F, ir_node *node, ir_node *local);
117 * This hook is called to dump the vcg attributes of an edge to a file.
118 * If this function returns zero, the default attributes are added, else
121 typedef int (*DUMP_EDGE_VCGATTR_FUNC)(FILE *F, ir_node *node, int to);
123 /** Set the ir graph dump hook. */
124 void set_dump_ir_graph_hook(DUMP_IR_GRAPH_FUNC hook);
125 /** Set the node_vcgattr hook. */
126 void set_dump_node_vcgattr_hook(DUMP_NODE_VCGATTR_FUNC hook);
127 /** Set the edge_vcgattr hook. */
128 void set_dump_edge_vcgattr_hook(DUMP_EDGE_VCGATTR_FUNC hook);
130 typedef int (*DUMP_NODE_EDGE_FUNC)(FILE *f, ir_node *node);
133 * Set the hook to be called to dump additional edges to a node.
134 * @param func The hook to be called.
136 void set_dump_node_edge_hook(DUMP_NODE_EDGE_FUNC func);
139 * Get the additional edge dump hook.
140 * @return The current additional edge dump hook.]
142 DUMP_NODE_EDGE_FUNC get_dump_node_edge_hook(void);
145 * Set the hook to be called to dump additional edges to a block.
146 * @param func The hook to be called.
148 void set_dump_block_edge_hook(DUMP_NODE_EDGE_FUNC func);
151 * Get the additional block edge dump hook.
152 * @return The current additional block edge dump hook.
154 DUMP_NODE_EDGE_FUNC get_dump_block_edge_hook(void);
156 /** Dump a firm graph.
158 * @param irg The firm graph to be dumped.
159 * @param suffix A suffix for the file name.
162 * A file containing the firm graph in vcg format.
164 * Dumps all Firm nodes of a single graph for a single procedure in
165 * standard xvcg format. Dumps the graph to a file. The file name
166 * is constructed from the name of the entity describing the
167 * procedure (irg->entity) and the ending -pure<-ip>.vcg. Eventually
168 * overwrites existing files. Visits all nodes in
169 * interprocedural_view.
171 * @see turn_off_edge_labels()
173 void dump_ir_graph(ir_graph *irg, const char *suffix);
174 void dump_ir_graph_file(ir_graph *irg, FILE *out);
176 /** Dump a firm graph without explicit block nodes.
178 * @param irg The firm graph to be dumped.
179 * @param suffix A suffix for the file name.
182 * A file containing the firm graph in vcg format.
184 * Dumps all Firm nodes of a single graph for a single procedure in
185 * extended xvcg format.
186 * Dumps the graph to a file. The file name is constructed from the
187 * name of the entity describing the procedure (irg->entity) and the
188 * ending <-ip>.vcg. Eventually overwrites existing files. Dumps several
189 * procedures in boxes if interprocedural_view.
191 * @see turn_off_edge_labels()
193 void dump_ir_block_graph(ir_graph *irg, const char *suffix);
194 void dump_ir_block_graph_file(ir_graph *irg, FILE *out);
196 /** Dump a firm graph without explicit block nodes but grouped in extended blocks.
198 * @param irg The firm graph to be dumped.
201 * A file containing the firm graph in vcg format.
203 * Dumps all Firm nodes of a single graph for a single procedure in
204 * extended xvcg format.
205 * Dumps the graph to a file. The file name is constructed from the
206 * name of the entity describing the procedure (irg->entity) and the
207 * ending <-ip>.vcg. Eventually overwrites existing files. Dumps several
208 * procedures in boxes if interprocedural_view.
210 * @see turn_off_edge_labels()
212 void dump_ir_extblock_graph(ir_graph *irg, const char *suffix);
213 void dump_ir_extblock_graph_file(ir_graph *irg, FILE *out);
215 /** Dumps all graphs in interprocedural view to a file named All_graphs\<suffix\>.vcg.
217 * @param suffix A suffix for the file name.
219 void dump_all_cg_block_graph(const char *suffix);
221 /** Dumps a firm graph and all the type information needed for Calls,
222 * Sels, ... in this graph.
224 * @param irg The firm graph to be dumped with its type information.
225 * @param suffix A suffix for the file name.
228 * A file containing the firm graph and the type information of the firm graph in vcg format.
230 * Dumps the graph to a file. The file name is constructed from the
231 * name of the entity describing the procedure (irg->entity) and the
232 * ending -all.vcg. Eventually overwrites existing files.
234 * @see turn_off_edge_labels()
236 void dump_ir_graph_w_types(ir_graph *irg, const char *suffix);
237 void dump_ir_graph_w_types_file(ir_graph *irg, FILE *out);
239 /** Dumps a firm graph and all the type information needed for Calls,
240 * Sels, ... in this graph.
242 * @param irg The firm graph to be dumped with its type information.
243 * @param suffix A suffix for the file name.
246 * A file containing the firm graph and the type information of the firm graph in vcg format.
248 * The graph is in blocked format.
249 * Dumps the graph to a file. The file name is constructed from the
250 * name of the entity describing the procedure (irg->entity) and the
251 * ending -all.vcg. Eventually overwrites existing files.
253 * @see turn_off_edge_labels()
255 void dump_ir_block_graph_w_types(ir_graph *irg, const char *suffix);
257 /** The type of a dump function that is called for each graph.
259 * @param irg current visited graph
260 * @param suffix A suffix for the file name.
262 typedef void dump_graph_func(ir_graph *irg, const char *suffix);
265 * A walker that calls a dumper for each graph.
267 * @param dump_graph The dumper to be used for dumping.
268 * @param suffix A suffix for the file name.
271 * Whatever the dumper creates.
273 * Walks over all firm graphs and calls a dumper for each graph.
274 * The following dumpers can be passed as arguments:
276 * - dump_ir_block_graph()
278 * - dump_type_graph()
279 * - dump_ir_graph_w_types()
281 * @see turn_off_edge_labels()
283 void dump_all_ir_graphs(dump_graph_func *dump_graph, const char *suffix);
286 * Creates an ir_prog pass for dump_all_ir_graphs().
288 * @param name the name of this pass or NULL
289 * @param dump_graph The dumper to be used for dumping.
290 * @param suffix A suffix for the file name.
292 * @return the newly created ir_prog pass
294 ir_prog_pass_t *dump_all_ir_graph_pass(
295 const char *name, dump_graph_func *dump_graph, const char *suffix);
298 * Dump the control flow graph of a procedure.
300 * @param irg The firm graph whose CFG shall be dumped.
301 * @param suffix A suffix for the file name.
304 * A file containing the CFG in vcg format.
306 * Dumps the control flow graph of a procedure in standard xvcg format.
307 * Dumps the graph to a file. The file name is constructed from the
308 * name of the entity describing the procedure (irg->entity) and the
309 * ending -cfg.vcg. Eventually overwrites existing files.
311 * @see turn_off_edge_labels()
313 void dump_cfg(ir_graph *irg, const char *suffix);
316 * Dump a node and its predecessors forming a subgraph to a vcg file.
318 * @param root The node serving as root for the subgraph.
319 * @param depth Dump nodes on paths starting at root with length depth.
320 * @param suffix A suffix for the file name.
322 * Dumps the graph to a file. The file name is constructed from the
323 * name of the entity describing the procedure the passed node is
324 * in, suffix and the ending -subg_\<nr\>.vcg. nr is a unique number
325 * for each graph dumped. Eventually overwrites existing files.
328 * A file containing the subgraph in vcg format.
330 void dump_subgraph(ir_node *root, int depth, const char *suffix);
332 /* **************************************************************************** */
333 /* CALLGRAPH DUMPERS */
334 /* **************************************************************************** */
337 /** Dump the call graph.
339 * Dumps the callgraph to a file "Callgraph"\<suffix\>".vcg".
341 * @param suffix A suffix for the file name.
343 * @see dump_callgraph_loop_tree(const char *suffix)
345 void dump_callgraph(const char *suffix);
347 /* **************************************************************************** */
348 /* TYPEGRAPH DUMPERS */
349 /* **************************************************************************** */
352 * Dumps all the type information needed for Calls, Sels, ... in this graph.
353 * Does not dump the graph!
355 * @param irg The firm graph whose type information is to be dumped.
356 * @param suffix A suffix for the file name.
359 * A file containing the type information of the firm graph in vcg format.
361 * Dumps this graph to a file. The file name is constructed from the
362 * name of the entity describing the procedure (irg->entity) and the
363 * ending -type.vcg. Eventually overwrites existing files.
365 * @see turn_off_edge_labels()
367 void dump_type_graph(ir_graph *irg, const char *suffix);
370 * Dumps all type information.
372 * @param suffix A suffix for the file name.
375 * A file containing all type information for the program in standard
378 * Dumps all type information that is somehow reachable in standard vcg
380 * Dumps the graph to a file named All_types.vcg.
382 * @see turn_off_edge_labels()
384 void dump_all_types(const char *suffix);
387 * Dumps the class hierarchy with or without entities.
389 * @param entities Flag whether to dump the entities.
390 * @param suffix A suffix for the file name.
393 * A file containing the class hierarchy tree for the program in standard
396 * Does not dump the global type.
397 * Dumps a node for all classes and the sub/supertype relations. If
398 * entities is set to true also dumps the entities of classes, but without
399 * any additional information as the entities type. The overwrites relation
400 * is dumped along with the entities.
401 * Dumps to a file class_hierarchy.vcg
403 void dump_class_hierarchy(int entities, const char *suffix);
405 /* **************************************************************************** */
406 /* LOOPTREE DUMPERS */
407 /* **************************************************************************** */
410 * Dump a standalone loop tree, which contains the loop nodes and the firm nodes
411 * belonging to one loop packed together in one subgraph. Dumps to file
412 * \<name of irg\>\<suffix\>-looptree.vcg
413 * Turns on edge labels by default.
415 * Implementing this dumper was stimulated by Florian Liekwegs similar dumper.
417 * @param irg Dump the loop tree for this graph.
418 * @param suffix A suffix for the file name.
420 void dump_loop_tree(ir_graph *irg, const char *suffix);
422 /** Dumps the firm nodes in the sub-loop-tree of loop to a graph.
424 * Dumps the loop nodes if dump_loop_information() is set.
425 * The name of the file is loop_<loop_nr>\<suffix\>.vcg.
427 * @param l Dump the loop tree for this loop.
428 * @param suffix A suffix for the file name.
430 void dump_loop(ir_loop *l, const char *suffix);
432 /** Dumps the loop tree over the call graph.
434 * See for yourself what you can use this for.
435 * The filename is "Callgraph_looptree\<suffix\>.vcg".
437 * @param suffix A suffix for the file name.
439 void dump_callgraph_loop_tree(const char *suffix);
442 /* **************************************************************************** */
444 /* **************************************************************************** */
447 /** Write the irnode and all its attributes to the file passed.
449 int dump_irnode_to_file(FILE *f, ir_node *n);
451 /** Write the irnode and all its attributes to stdout.
453 void dump_irnode(ir_node *n);
455 /** Write the graph and all its attributes to the file passed.
456 * Does not write the nodes.
458 void dump_graph_to_file(FILE *F, ir_graph *irg);
460 /** Write the graph and all its attributes to stdout.
461 * Does not write the nodes.
463 void dump_graph(ir_graph *g);
466 /** Dump graph information as text.
468 * Often graphs are unhandy in their vcg representation. The text
469 * dumper represents the information for the firm nodes more compact,
470 * but the relations between the nodes only implicitly.
472 * The file name is the graph name (get_entity_name()), appended by
475 void dump_graph_as_text(ir_graph *irg, const char *suffix);
478 /** Verbosity for text dumpers */
480 dump_verbosity_onlynames = 0x00000001, /**< Only dump names. Turns off all other
481 flags up to 0x00010000. */
482 dump_verbosity_fields = 0x00000002, /**< Dump types and fields (like a type declaration). */
483 dump_verbosity_methods = 0x00000004, /**< Dump types and methods (like a type declaration). */
484 dump_verbosity_nostatic = 0x00000040, /**< Dump types and dynamic allocated fields (like a
485 type declaration). This excludes methods and
486 static, polymorphic fields. */
487 dump_verbosity_typeattrs = 0x00000008, /**< Dump all type attributes. */
488 dump_verbosity_entattrs = 0x00000010, /**< Dump all entity attributes. */
489 dump_verbosity_entconsts = 0x00000020, /**< Dump entity constants. */
491 dump_verbosity_accessStats = 0x00000100, /**< Dump entity access statistics. */
492 dump_verbosity_csv = 0x00000200, /**< Dump access statistics as comma separated list. */
494 dump_verbosity_noClassTypes = 0x00001000, /**< Dump no class types. */
495 dump_verbosity_noStructTypes = 0x00002000, /**< Dump no struct types. */
496 dump_verbosity_noUnionTypes = 0x00004000, /**< Dump no union types. */
497 dump_verbosity_noArrayTypes = 0x00008000, /**< Dump no array types. */
498 dump_verbosity_noPointerTypes = 0x00010000, /**< Dump no pointer types. */
499 dump_verbosity_noMethodTypes = 0x00020000, /**< Dump no method types. */
500 dump_verbosity_noPrimitiveTypes = 0x00040000, /**< Dump no primitive types .*/
501 dump_verbosity_noEnumerationTypes= 0x00080000, /**< Dump no enumeration types. */
503 dump_verbosity_onlyClassTypes = 0x000FE000, /**< Dump only class types. */
504 dump_verbosity_onlyStructTypes = 0x000FD000, /**< Dump only struct types. */
505 dump_verbosity_onlyUnionTypes = 0x000FB000, /**< Dump only union types. */
506 dump_verbosity_onlyArrayTypes = 0x000F7000, /**< Dump only array types. */
507 dump_verbosity_onlyPointerTypes = 0x000EF000, /**< Dump only pointer types. */
508 dump_verbosity_onlyMethodTypes = 0x000DF000, /**< Dump only method types. */
509 dump_verbosity_onlyPrimitiveTypes = 0x000BF000, /**< Dump only primitive types. */
510 dump_verbosity_onlyEnumerationTypes=0x0007F000, /**< Dump only enumeration types. */
512 dump_verbosity_max = 0x4FF00FBE /**< Turn on all verbosity.
513 Do not turn on negative flags!
514 @@@ Because of a bug in gcc 3.2 we can not set the
519 /** Write the entity and all its attributes to the passed file.
521 void dump_entity_to_file(FILE *F, ir_entity *ent, unsigned verbosity);
523 /** Write the entity and all its attributes to the stdout.
525 * Calls dump_entity_to_file(). */
526 void dump_entity(ir_entity *ent);
528 /** Write the type and all its attributes to the file passed.
530 void dump_type_to_file(FILE *f, ir_type *tp, dump_verbosity verbosity);
532 /** Write the type and all its attributes to stdout.
534 void dump_type(ir_type *tp);
537 /** Dump type information as text.
539 * Often type graphs are unhandy in their vcg representation. The text
540 * dumper represents the information for a single type more compact, but
541 * the relations between the types only implicitly.
542 * Dumps only 'real' types, i.e., those in the type list. Does not dump
543 * the global type nor frame types or the like.
545 * The file name is the program name (get_irp_name()), or 'TextTypes'
546 * if the program name is not set, appended by \<suffix\>-types.txt.
547 * For verbosity see the documentation of the verbosity flags above.
549 void dump_types_as_text(unsigned verbosity, const char *suffix);
551 /** Dumps all global variables as text.
553 * @param suffix A suffix for the file name.
555 * Dumps a text representation of the entities in the global type.
557 * The file name is the program name (get_irp_name()), or 'TextTypes'
558 * if the program name is not set, appended by \<suffix\>-globals.txt.
559 * For verbosity see the documentation of the verbosity flags above.
561 void dump_globals_as_text(unsigned verbosity, const char *suffix);
563 /* **************************************************************************** */
565 /* **************************************************************************** */
567 /** Set a prefix filter for output functions.
569 * All graph dumpers check this name. If the name is != "" and
570 * not a prefix of the graph to be dumped, the dumper does not
573 * @param name The prefix of the name (not the ld_name) of the method
574 * entity to be dumped.
576 void only_dump_method_with_name(ident *name);
578 /** Returns the prefix filter set with only_dump_method_with_name(). */
579 ident *get_dump_file_filter_ident(void);
581 /** Returns true if dump file filter is not set, or if it is a
583 int is_filtered_dump_name(ident *name);
585 /** Sets the vcg flag "display_edge_labels" to no.
587 * This is necessary as xvcg and aisee both fail to display graphs
588 * with self-edges if these edges have labels.
590 void turn_off_edge_labels(void);
593 * If set to non-zero constants will be replicated for every use. In non
594 * blocked view edges from constant to block are skipped. Vcg then
595 * layouts the graphs more compact, this makes them better readable.
596 * The flag is automatically and temporarily set to false if other
597 * edges are dumped, as outs, loop, ...
598 * Default setting: false.
600 void dump_consts_local(int flag);
603 * if set to non-zero node idx will be added to node labels
605 void dump_node_idx_label(int flag);
607 /** Turns off dumping the values of constant entities. Makes type graphs
610 void dump_constant_entity_values(int flag);
612 /** Turns on dumping the edges from the End node to nodes to be kept
615 void dump_keepalive_edges(int flag);
616 int get_opt_dump_keepalive_edges(void);
618 /** Turns on dumping the out edges starting from the Start block in
621 * To test the consistency of the out data structure.
623 void dump_out_edges(int flag);
625 /** If this flag is set the dumper dumps edges to immediate dominator in cfg.
627 void dump_dominator_information(int flag);
629 /** If this flag is set the dumper dumps loop nodes and edges from
630 * these nodes to the contained ir nodes.
632 * If the loops are interprocedural nodes can be missing.
634 void dump_loop_information(int flag);
636 /** If set and backedge info is computed, backedges are dumped dashed
637 * and as vcg 'backedge' construct.
641 void dump_backedge_information(int flag);
643 /** Dump the information of type field specified in ana/irtypeinfo.h.
645 * If the flag is set, the type name is output in [] in the node label,
646 * else it is output as info.
648 void set_opt_dump_analysed_type_info(int flag);
650 /** Write the address of a node into the vcg info.
652 * This is off per default for automatic comparisons of
653 * vcg graphs -- these will differ in the pointer values!
655 void dump_pointer_values_to_info(int flag);
657 /** Dumps ld_names of entities instead of there names.
659 * This option is on per default.
661 void dump_ld_names(int flag);
663 /** Dumps all graph anchor nodes, even if they
666 * This option is off per default.
668 void dump_all_anchors(int flag);
670 /** Dumps a MacroBlock edge from every Block to its
673 * This option is off per default.
675 void dump_macroblock_edges(int flag);
677 /** Dumps a marked blocks with a asterisk in the title.
679 * This option is off per default.
681 void dump_block_marker_in_title(int flag);
683 /** A node info dumper callback. */
684 typedef void (dump_node_info_cb_t)(void *data, FILE *f, const ir_node *n);
687 * Adds a new node info dumper callback. It is possible to add an unlimited
688 * number of callbacks. The callbacks are called at the end of the default
691 * @param cb the callback function to be called
692 * @param data a context parameter
694 * @return A callback handle.
696 * @note This functionality is only available, if Firm hooks are enabled (default).
698 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data);
701 * Remove a previously added info dumper callback.
703 * @param handle the callback handle returned from dump_add_node_info_callback()
705 void dump_remv_node_info_callback(void *handle);