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 * File name: ir/ir/irdump.h
23 * Purpose: Write vcg representation of firm to file.
24 * Author: Martin Trapp, Christian Schaefer
25 * Modified by: Goetz Lindenmaier, Hubert Schmidt
28 * Copyright: (c) 1998-2003 Universität Karlsruhe
34 * Dump routines for the ir graph and all type information.
36 * @author Martin Trapp, Christian Schaefer
38 * The dump format of most functions is vcg. This is a text based graph
39 * representation. Some use the original format,
40 * but most generate an extended format that is only read by some special
41 * versions of xvcg or by the comercialized version now calles aiSee.
42 * A test version of aiSee is available at
43 * http://www.absint.de/aisee/download/index.htm.
45 * Most routines use the name of the passed entity as the name of the
48 #ifndef _FIRM_IR_IRDUMP_H_
49 #define _FIRM_IR_IRDUMP_H_
56 * Names of the 32 supported colors
59 ird_color_default = -1,
65 ird_color_magenta = 5,
67 ird_color_darkgray = 7,
68 ird_color_darkblue = 8,
69 ird_color_darkred = 9,
70 ird_color_darkgreen = 10,
71 ird_color_darkyellow = 11,
72 ird_color_darkmagenta = 12,
73 ird_color_darkcyan = 13,
75 ird_color_lightgray = 15,
76 ird_color_lightblue = 16,
77 ird_color_lightred = 17,
78 ird_color_lightgreen = 18,
79 ird_color_lightyellow = 19,
80 ird_color_lightmagenta = 20,
81 ird_color_lightcyan = 21,
83 ird_color_turquoise = 23,
84 ird_color_aquamarine = 24,
86 ird_color_purple = 26,
87 ird_color_yellowgreen = 27,
89 ird_color_orange = 29,
90 ird_color_orchid = 30,
98 data_edge = 0x01, /**< a data edge between two basic blocks */
99 block_edge = 0x02, /**< an edge from a node to its basic block */
100 cf_edge = 0x03, /**< regularly control flow edge */
101 exc_cf_edge = 0x04, /**< exceptional control flow edge */
102 mem_edge = 0x05, /**< memory edge */
103 dominator_edge = 0x06, /**< dominator edge */
104 node2type_edge = 0x07, /**< an edge from an IR node to a type */
106 ent_type_edge = 0x11, /**< an edge from an entity to its type */
107 ent_own_edge = 0x12, /**< an edge from an entity to its owner type */
108 ent_overwrites_edge = 0x13, /**< an edge from an entity to the entity it overwrites */
109 ent_value_edge = 0x14, /**< an edge from an entity to its value entity */
110 ent_corr_edge = 0x15, /**< an edge from an entity to the member entity its initializes */
112 meth_par_edge = 0x21, /**< an edge from a method type to one of its parameter types */
113 meth_res_edge = 0x22, /**< an edge from a method type to one of its result types */
114 type_super_edge = 0x23, /**< an edge from a class type to its super/basis type */
115 union_edge = 0x24, /**< an edge from a union type to its member types */
116 ptr_pts_to_edge = 0x25, /**< an edge from a pointer type to its points-to type */
117 arr_elt_type_edge = 0x26, /**< an edge from an array type to its element type */
118 arr_ent_edge = 0x27, /**< an edge from a array type to its element entity */
119 type_member_edge = 0x28, /**< an edge from a compound type to its member entities */
121 /* additional flags */
122 intra_edge = 0, /**< intra edge flag: edge do not cross basic block boundaries */
123 inter_edge = 0x40, /**< inter edge flag: edge cross basic block boundaries */
124 back_edge = 0x80 /**< backwards edge flag */
127 /* **************************************************************************** */
129 /* **************************************************************************** */
132 * This hook is called to insert some special nodes into dumped graph
134 typedef int (*DUMP_IR_GRAPH_FUNC)(FILE *F, ir_graph *irg);
136 * This hook is called to dump the vcg attributes of a node to a file.
137 * If this function returns zero, the default attributes are added, else
140 typedef int (*DUMP_NODE_VCGATTR_FUNC)(FILE *F, ir_node *node, ir_node *local);
142 * This hook is called to dump the vcg attributes of an edge to a file.
143 * If this function returns zero, the default attributes are added, else
146 typedef int (*DUMP_EDGE_VCGATTR_FUNC)(FILE *F, ir_node *node, int to);
148 /** Set the ir graph dump hook. */
149 void set_dump_ir_graph_hook(DUMP_IR_GRAPH_FUNC hook);
150 /** Set the node_vcgattr hook. */
151 void set_dump_node_vcgattr_hook(DUMP_NODE_VCGATTR_FUNC hook);
152 /** Set the edge_vcgattr hook. */
153 void set_dump_edge_vcgattr_hook(DUMP_EDGE_VCGATTR_FUNC hook);
155 typedef int (*DUMP_NODE_EDGE_FUNC)(FILE *f, ir_node *node);
158 * Set the hook to be called to dump additional edges to a node.
159 * @param func The hook to be called.
161 void set_dump_node_edge_hook(DUMP_NODE_EDGE_FUNC func);
164 * Get the additional edge dump hook.
165 * @return The current additional edge dump hook.]
167 DUMP_NODE_EDGE_FUNC get_dump_node_edge_hook(void);
170 * Set the hook to be called to dump additional edges to a block.
171 * @param func The hook to be called.
173 void set_dump_block_edge_hook(DUMP_NODE_EDGE_FUNC func);
176 * Get the additional block edge dump hook.
177 * @return The current additional block edge dump hook.
179 DUMP_NODE_EDGE_FUNC get_dump_block_edge_hook(void);
181 /** Dump a firm graph.
183 * @param irg The firm graph to be dumped.
184 * @param suffix A suffix for the file name.
187 * A file containing the firm graph in vcg format.
189 * Dumps all Firm nodes of a single graph for a single procedure in
190 * standard xvcg format. Dumps the graph to a file. The file name
191 * is constructed from the name of the entity describing the
192 * procedure (irg->entity) and the ending -pure<-ip>.vcg. Eventually
193 * overwrites existing files. Visits all nodes in
194 * interprocedural_view.
196 * @see turn_off_edge_labels()
198 void dump_ir_graph (ir_graph *irg, const char *suffix);
200 /** Dump a firm graph without explicit block nodes.
202 * @param irg The firm graph to be dumped.
203 * @param suffix A suffix for the file name.
206 * A file containing the firm graph in vcg format.
208 * Dumps all Firm nodes of a single graph for a single procedure in
209 * extended xvcg format.
210 * Dumps the graph to a file. The file name is constructed from the
211 * name of the entity describing the procedure (irg->entity) and the
212 * ending <-ip>.vcg. Eventually overwrites existing files. Dumps several
213 * procedures in boxes if interprocedural_view.
215 * @see turn_off_edge_labels()
217 void dump_ir_block_graph (ir_graph *irg, const char *suffix);
219 /** Dump a firm graph without explicit block nodes but grouped in extended blocks.
221 * @param irg The firm graph to be dumped.
224 * A file containing the firm graph in vcg format.
226 * Dumps all Firm nodes of a single graph for a single procedure in
227 * extended xvcg format.
228 * Dumps the graph to a file. The file name is constructed from the
229 * name of the entity describing the procedure (irg->entity) and the
230 * ending <-ip>.vcg. Eventually overwrites existing files. Dumps several
231 * procedures in boxes if interprocedural_view.
233 * @see turn_off_edge_labels()
235 void dump_ir_extblock_graph (ir_graph *irg, const char *suffix);
237 /** Dumps all graphs in interprocedural view to a file named All_graphs<suffix>.vcg.
239 * @param suffix A suffix for the file name.
241 void dump_all_cg_block_graph(const char *suffix);
243 /** Dumps a firm graph and all the type information needed for Calls,
244 * Sels, ... in this graph.
246 * @param irg The firm graph to be dumped with its type information.
247 * @param suffix A suffix for the file name.
250 * A file containing the firm graph and the type information of the firm graph in vcg format.
252 * Dumps the graph to a file. The file name is constructed from the
253 * name of the entity describing the procedure (irg->entity) and the
254 * ending -all.vcg. Eventually overwrites existing files.
256 * @see turn_off_edge_labels()
258 void dump_ir_graph_w_types (ir_graph *irg, const char *suffix);
260 /** Dumps a firm graph and all the type information needed for Calls,
261 * Sels, ... in this graph.
263 * @param irg The firm graph to be dumped with its type information.
264 * @param suffix A suffix for the file name.
267 * A file containing the firm graph and the type information of the firm graph in vcg format.
269 * The graph is in blocked format.
270 * Dumps the graph to a file. The file name is constructed from the
271 * name of the entity describing the procedure (irg->entity) and the
272 * ending -all.vcg. Eventually overwrites existing files.
274 * @see turn_off_edge_labels()
276 void dump_ir_block_graph_w_types (ir_graph *irg, const char *suffix);
278 /** The type of a dump function that is called for each graph.
280 * @param irg current visited graph
281 * @param suffix A suffix for the file name.
283 typedef void dump_graph_func(ir_graph *irg, const char *suffix);
286 * A walker that calls a dumper for each graph.
288 * @param dump_graph The dumper to be used for dumping.
289 * @param suffix A suffix for the file name.
292 * Whatever the dumper creates.
294 * Walks over all firm graphs and calls a dumper for each graph.
295 * The following dumpers can be passed as arguments:
297 * - dump_ir_block_graph()
299 * - dump_type_graph()
300 * - dump_ir_graph_w_types()
302 * @see turn_off_edge_labels()
304 void dump_all_ir_graphs (dump_graph_func *dump_graph, const char *suffix);
308 * Dump the control flow graph of a procedure.
310 * @param irg The firm graph whose CFG shall be dumped.
311 * @param suffix A suffix for the file name.
314 * A file containing the CFG in vcg format.
316 * Dumps the control flow graph of a procedure in standard xvcg format.
317 * Dumps the graph to a file. The file name is constructed from the
318 * name of the entity describing the procedure (irg->entity) and the
319 * ending -cfg.vcg. Eventually overwrites existing files.
321 * @see turn_off_edge_labels()
323 void dump_cfg (ir_graph *irg, const char *suffix);
326 * Dump a node and its predecessors forming a subgraph to a vcg file.
328 * @param root The node serving as root for the subgraph.
329 * @param depth Dump nodes on paths starting at root with length depth.
330 * @param suffix A suffix for the file name.
332 * Dumps the graph to a file. The file name is constructed from the
333 * name of the entity describing the procedure the passed node is
334 * in, suffix and the ending -subg_<nr>.vcg. nr is a unique number
335 * for each graph dumped. Eventually overwrites existing files.
338 * A file containing the subgraph in vcg format.
340 void dump_subgraph (ir_node *root, int depth, const char *suffix);
342 /* **************************************************************************** */
343 /* CALLGRAPH DUMPERS */
344 /* **************************************************************************** */
347 /** Dump the call graph.
349 * Dumps the callgraph to a file "Callgraph"<suffix>".vcg".
351 * @param suffix A suffix for the file name.
353 * @see dump_callgraph_loop_tree(const char *suffix)
355 void dump_callgraph(const char *suffix);
357 /* **************************************************************************** */
358 /* TYPEGRAPH DUMPERS */
359 /* **************************************************************************** */
362 * Dumps all the type information needed for Calls, Sels, ... in this graph.
363 * Does not dump the graph!
365 * @param irg The firm graph whose type information is to be dumped.
366 * @param suffix A suffix for the file name.
369 * A file containing the type information of the firm graph in vcg format.
371 * Dumps this graph to a file. The file name is constructed from the
372 * name of the entity describing the procedure (irg->entity) and the
373 * ending -type.vcg. Eventually overwrites existing files.
375 * @see turn_off_edge_labels()
377 void dump_type_graph (ir_graph *irg, const char *suffix);
380 * Dumps all type information.
382 * @param suffix A suffix for the file name.
385 * A file containing all type information for the program in standard
388 * Dumps all type information that is somehow reachable in standard vcg
390 * Dumps the graph to a file named All_types.vcg.
392 * @see turn_off_edge_labels()
394 void dump_all_types (const char *suffix);
397 * Dumps the class hierarchy with or without entities.
399 * @param entities Flag whether to dump the entities.
400 * @param suffix A suffix for the file name.
403 * A file containing the class hierarchy tree for the program in standard
406 * Does not dump the global type.
407 * Dumps a node for all classes and the sub/supertype relations. If
408 * entities is set to true also dumps the entities of classes, but without
409 * any additional information as the entities type. The overwrites relation
410 * is dumped along with the entities.
411 * Dumps to a file class_hierarchy.vcg
413 void dump_class_hierarchy (int entities, const char *suffix);
415 /* **************************************************************************** */
416 /* LOOPTREE DUMPERS */
417 /* **************************************************************************** */
420 * Dump a standalone loop tree, which contains the loop nodes and the firm nodes
421 * belonging to one loop packed together in one subgraph. Dumps to file
422 * <name of irg><suffix>-looptree.vcg
423 * Turns on edge labels by default.
425 * Implementing this dumper was stimulated by Florian Liekwegs similar dumper.
427 * @param irg Dump the loop tree for this graph.
428 * @param suffix A suffix for the file name.
430 void dump_loop_tree(ir_graph *irg, const char *suffix);
432 /** Dumps the firm nodes in the sub-loop-tree of loop to a graph.
434 * Dumps the loop nodes if dump_loop_information() is set.
435 * The name of the file is loop_<loop_nr><suffix>.vcg.
437 * @param l Dump the loop tree for this loop.
438 * @param suffix A suffix for the file name.
440 void dump_loop (ir_loop *l, const char *suffix);
442 /** Dumps the loop tree over the call graph.
444 * See for yourself what you can use this for.
445 * The filename is "Callgraph_looptree<suffix>.vcg".
447 * @param suffix A suffix for the file name.
449 void dump_callgraph_loop_tree(const char *suffix);
452 /* **************************************************************************** */
454 /* **************************************************************************** */
457 /** Write the irnode and all its attributes to the file passed.
459 int dump_irnode_to_file (FILE *f, ir_node *n);
461 /** Write the irnode and all its attributes to stdout.
463 void dump_irnode (ir_node *n);
465 /** Write the graph and all its attributes to the file passed.
466 * Does not write the nodes.
468 void dump_graph_to_file(FILE *F, ir_graph *irg);
470 /** Write the graph and all its attributes to stdout.
471 * Does not write the nodes.
473 void dump_graph(ir_graph *g);
476 /** Dump graph information as text.
478 * Often graphs are unhandy in their vcg representation. The text
479 * dumper represents the information for the firm nodes more compact,
480 * but the relations between the nodes only implicitly.
482 * The file name is the graph name (get_entity_name()), appended by
485 void dump_graph_as_text(ir_graph *irg, const char *suffix);
488 /** Verbosity for text dumpers */
490 dump_verbosity_onlynames = 0x00000001, /**< only dump names. turns off all other
491 flags up to 0x00010000. */
492 dump_verbosity_fields = 0x00000002, /**< dump types and fields (like a type declaration) */
493 dump_verbosity_methods = 0x00000004, /**< dump types and methods (like a type declaration) */
494 dump_verbosity_nostatic = 0x00000040, /**< dump types and dynamic allocated fields (like a
495 type declaration). This excludes methods and
496 static, polymorphic fields. */
497 dump_verbosity_typeattrs = 0x00000008, /**< dump all type attributes */
498 dump_verbosity_entattrs = 0x00000010, /**< dump all entity attributes */
499 dump_verbosity_entconsts = 0x00000020, /**< dump entity constants */
501 dump_verbosity_accessStats = 0x00000100, /**< dump entity access statistics */
502 dump_verbosity_csv = 0x00000200, /**< dump access statistics as comma separated list */
504 dump_verbosity_noClassTypes = 0x00001000, /**< dump no class types */
505 dump_verbosity_noStructTypes = 0x00002000, /**< dump no struct types */
506 dump_verbosity_noUnionTypes = 0x00004000, /**< dump no union types */
507 dump_verbosity_noArrayTypes = 0x00008000, /**< dump no array types */
508 dump_verbosity_noPointerTypes = 0x00010000, /**< dump no pointer types */
509 dump_verbosity_noMethodTypes = 0x00020000, /**< dump no method types */
510 dump_verbosity_noPrimitiveTypes = 0x00040000, /**< dump no primitive types */
511 dump_verbosity_noEnumerationTypes= 0x00080000, /**< dump no enumeration types */
513 dump_verbosity_onlyClassTypes = 0x000FE000, /**< dump only class types */
514 dump_verbosity_onlyStructTypes = 0x000FD000, /**< dump only struct types */
515 dump_verbosity_onlyUnionTypes = 0x000FB000, /**< dump only union types */
516 dump_verbosity_onlyArrayTypes = 0x000F7000, /**< dump only array types */
517 dump_verbosity_onlyPointerTypes = 0x000EF000, /**< dump only pointer types */
518 dump_verbosity_onlyMethodTypes = 0x000DF000, /**< dump only method types */
519 dump_verbosity_onlyPrimitiveTypes = 0x000BF000, /**< dump only primitive types */
520 dump_verbosity_onlyEnumerationTypes=0x0007F000, /**< dump only enumeration types */
522 dump_verbosity_max = 0x4FF00FBE /**< turn on all verbosity.
523 Do not turn on negative flags!
524 @@@ Because of a bug in gcc 3.2 we can not set the
529 /** Write the entity and all its attributes to the passed file.
531 void dump_entity_to_file (FILE *F, ir_entity *ent, unsigned verbosity);
533 /** Write the entity and all its attributes to the stdout.
535 * Calls dump_entity_to_file(). */
536 void dump_entity (ir_entity *ent);
538 /** Write the type and all its attributes to the file passed.
540 void dump_type_to_file (FILE *f, ir_type *tp, dump_verbosity verbosity);
542 /** Write the type and all its attributes to stdout.
544 void dump_type (ir_type *tp);
547 /** Dump type information as text.
549 * Often type graphs are unhandy in their vcg representation. The text
550 * dumper represents the information for a single type more compact, but
551 * the relations between the types only implicitly.
552 * Dumps only 'real' types, i.e., those in the type list. Does not dump
553 * the global type nor frame types or the like.
555 * The file name is the program name (get_irp_name()), or 'TextTypes'
556 * if the program name is not set, appended by <suffix>-types.txt.
557 * For verbosity see the documentation of the verbosity flags above.
559 void dump_types_as_text(unsigned verbosity, const char *suffix);
561 /** Dumps all global variables as text.
563 * @param suffix A suffix for the file name.
565 * Dumps a text representation of the entities in the global type.
567 * The file name is the program name (get_irp_name()), or 'TextTypes'
568 * if the program name is not set, appended by <suffix>-globals.txt.
569 * For verbosity see the documentation of the verbosity flags above.
571 void dump_globals_as_text(unsigned verbosity, const char *suffix);
573 /* **************************************************************************** */
575 /* **************************************************************************** */
577 /** Set a prefix filter for output functions.
579 * All graph dumpers check this name. If the name is != "" and
580 * not a prefix of the graph to be dumped, the dumper does not
583 * @param name The prefix of the name (not the ld_name) of the method
584 * entity to be dumped.
586 void only_dump_method_with_name(ident *name);
588 /** Returns the prefix filter set with only_dump_method_with_name(). */
589 ident *get_dump_file_filter_ident(void);
591 /** Returns true if dump file filter is not set, or if it is a
593 int is_filtered_dump_name(ident *name);
595 /** Sets the vcg flag "display_edge_labels" to no.
597 * This is necessary as xvcg and aisee both fail to display graphs
598 * with self-edges if these edges have labels.
600 void turn_off_edge_labels(void);
603 * If set to non-zero constants will be replicated for every use. In non
604 * blocked view edges from constant to block are skipped. Vcg then
605 * layouts the graphs more compact, this makes them better readable.
606 * The flag is automatically and temporarily set to false if other
607 * edges are dumped, as outs, loop, ...
608 * Default setting: false.
610 void dump_consts_local(int flag);
613 * Returns 0 if dump_out_edge_flag or dump_loop_information_flag
614 * are set, else returns dump_const_local_flag.
616 int get_opt_dump_const_local(void);
618 /** Turns off dumping the values of constant entities. Makes type graphs
621 void dump_constant_entity_values(int flag);
623 /** Turns on dumping the edges from the End node to nodes to be kept
626 void dump_keepalive_edges(int flag);
627 int get_opt_dump_keepalive_edges(void);
629 /** Turns on dumping the out edges starting from the Start block in
632 * To test the consistency of the out data structure.
634 void dump_out_edges(int flag);
636 /** If this flag is set the dumper dumps edges to immediate dominator in cfg.
638 void dump_dominator_information(int flag);
640 /** If this flag is set the dumper dumps loop nodes and edges from
641 * these nodes to the contained ir nodes.
643 * If the loops are interprocedural nodes can be missing.
645 void dump_loop_information(int flag);
647 /** If set and backedge info is computed, backedges are dumped dashed
648 * and as vcg 'backedge' construct.
652 void dump_backedge_information(int flag);
654 /** Dump the information of type field specified in ana/irtypeinfo.h.
656 * If the flag is set, the type name is output in [] in the node label,
657 * else it is output as info.
659 void set_opt_dump_analysed_type_info(int flag);
661 /** Write the address of a node into the vcg info.
663 * This is off per default for automatic comparisons of
664 * vcg graphs -- these will differ in the pointer values!
666 void dump_pointer_values_to_info(int flag);
668 /** Dumps ld_names of entities instead of there names.
670 * This option is on per default.
672 void dump_ld_names(int flag);
674 /** Dumps all graph anchor nodes, even if they
677 * This option is off per default.
679 void dump_all_anchors(int flag);
681 /** A node info dumper callback. */
682 typedef void (dump_node_info_cb_t)(void *data, FILE *f, const ir_node *n);
685 * Adds a new node info dumper callback. It is possible to add an unlimited
686 * number of callbacks. The callbacks are called at the end of the default
689 * @param cb the callback function to be called
690 * @param data a context parameter
692 * @return A callback handle.
694 * @note This functionality is only available, if Firm hooks are enabled (default).
696 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data);
699 * Remove a previously added info dumper callback.
701 * @param handle the callback handle returned from dump_add_node_info_callback()
703 void dump_remv_node_info_callback(void *handle);
705 #endif /* _FIRM_IR_IRDUMP_H_ */