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
38 #include "firm_common_t.h"
43 #include "irgraph_t.h"
56 #include "callgraph.h"
57 #include "irextbb_t.h"
59 #include "dbginfo_t.h"
72 extern void dump_irn_chi_term(FILE *FL, ir_node *n);
73 extern void dump_irn_state(FILE *FL, ir_node *n);
74 extern int get_opt_dump_abstvals(void);
75 typedef unsigned long SeqNo;
76 extern SeqNo get_Block_seqno(ir_node *n);
79 /** Dump only irgs with names that start with this prefix. */
80 static ident *dump_file_filter_id = NULL;
82 #define ERROR_TXT "<ERROR>"
84 /*******************************************************************/
85 /* flags to steer output */
86 /*******************************************************************/
88 /** An option to turn off edge labels */
89 static int edge_label = 1;
90 /** An option to turn off dumping values of constant entities */
91 static int const_entities = 1;
92 /** An option to dump the keep alive edges */
93 static int dump_keepalive = 1;
94 /** An option to dump the new out edges */
95 static int dump_new_edges_flag = 0;
96 /** An option to dump ld_names instead of names. */
97 static int dump_ld_name = 1;
98 /** Compiler options to dump analysis information in dump_ir_graph */
99 static int dump_out_edge_flag = 0;
100 static int dump_loop_information_flag = 0;
101 static int dump_backedge_information_flag = 1;
102 /** An option to dump const-like nodes locally. */
103 static int dump_const_local = 1;
104 /** An option to dump the node index number. */
105 static int dump_node_idx_labels = 0;
106 /** An option to dump all graph anchors */
107 static int dump_anchors = 0;
108 /** An option to dump the macro block edges. */
109 static int dump_macro_block_edges = 0;
110 /** An option to dump block marker in the block title */
111 static int dump_block_marker = 0;
113 int dump_dominator_information_flag = 0;
114 int opt_dump_analysed_type_info = 1;
115 int opt_dump_pointer_values_to_info = 0; /* default off: for test compares!! */
117 static ird_color_t overrule_nodecolor = ird_color_default_node;
119 /** The vcg node attribute hook. */
120 static DUMP_IR_GRAPH_FUNC dump_ir_graph_hook = NULL;
121 /** The vcg node attribute hook. */
122 static DUMP_NODE_VCGATTR_FUNC dump_node_vcgattr_hook = NULL;
123 /** The vcg edge attribute hook. */
124 static DUMP_EDGE_VCGATTR_FUNC dump_edge_vcgattr_hook = NULL;
125 /** The vcg dump block edge hook */
126 static DUMP_NODE_EDGE_FUNC dump_block_edge_hook = NULL;
127 /** The vcg dump node edge hook. */
128 static DUMP_NODE_EDGE_FUNC dump_node_edge_hook = NULL;
130 /* Set the hook to be called to dump additional edges to a node. */
131 void set_dump_node_edge_hook(DUMP_NODE_EDGE_FUNC func) {
132 dump_node_edge_hook = func;
135 /* Get the additional edge dump hook. */
136 DUMP_NODE_EDGE_FUNC get_dump_node_edge_hook(void) {
137 return dump_node_edge_hook;
140 /* Set the hook to be called to dump additional edges to a block. */
141 void set_dump_block_edge_hook(DUMP_NODE_EDGE_FUNC func) {
142 dump_block_edge_hook = func;
145 /* Get the additional block edge dump hook. */
146 DUMP_NODE_EDGE_FUNC get_dump_block_edge_hook(void) {
147 return dump_node_edge_hook;
150 /* set the ir graph hook */
151 void set_dump_ir_graph_hook(DUMP_IR_GRAPH_FUNC hook) {
152 dump_ir_graph_hook = hook;
155 /* set the node attribute hook */
156 void set_dump_node_vcgattr_hook(DUMP_NODE_VCGATTR_FUNC hook) {
157 dump_node_vcgattr_hook = hook;
160 /* set the edge attribute hook */
161 void set_dump_edge_vcgattr_hook(DUMP_EDGE_VCGATTR_FUNC hook) {
162 dump_edge_vcgattr_hook = hook;
165 /** Returns 0 if dump_out_edge_flag or dump_loop_information_flag
166 * are set, else returns dump_const_local_flag.
168 static int get_opt_dump_const_local(void) {
169 if (dump_out_edge_flag || dump_loop_information_flag || (dump_new_edges_flag && edges_activated(current_ir_graph)))
171 return dump_const_local;
174 /* Set a prefix filter for output functions. */
175 void only_dump_method_with_name(ident *name) {
176 dump_file_filter_id = name;
179 /* Returns the prefix filter set with only_dump_method_with_name(). */
180 ident *get_dump_file_filter_ident(void) {
181 return dump_file_filter_id;
184 /* Returns non-zero if dump file filter is not set, or if it is a prefix of name. */
185 int is_filtered_dump_name(ident *name) {
186 if (!dump_file_filter_id) return 1;
187 return id_is_prefix(dump_file_filter_id, name);
190 /* To turn off display of edge labels. Edge labels often cause xvcg to
191 abort with a segmentation fault. */
192 void turn_off_edge_labels(void) {
196 void dump_consts_local(int flag) {
197 dump_const_local = flag;
200 void dump_node_idx_label(int flag) {
201 dump_node_idx_labels = flag;
204 void dump_constant_entity_values(int flag) {
205 const_entities = flag;
208 void dump_keepalive_edges(int flag) {
209 dump_keepalive = flag;
212 void dump_new_edges(int flag) {
213 dump_new_edges_flag = flag;
216 int get_opt_dump_keepalive_edges(void) {
217 return dump_keepalive;
220 void dump_out_edges(int flag) {
221 dump_out_edge_flag = flag;
224 void dump_dominator_information(int flag) {
225 dump_dominator_information_flag = flag;
228 void dump_loop_information(int flag) {
229 dump_loop_information_flag = flag;
232 void dump_backedge_information(int flag) {
233 dump_backedge_information_flag = flag;
236 /* Dump the information of type field specified in ana/irtypeinfo.h.
237 * If the flag is set, the type name is output in [] in the node label,
238 * else it is output as info.
240 void set_opt_dump_analysed_type_info(int flag) {
241 opt_dump_analysed_type_info = flag;
244 void dump_pointer_values_to_info(int flag) {
245 opt_dump_pointer_values_to_info = flag;
248 void dump_ld_names(int flag) {
252 void dump_all_anchors(int flag) {
256 void dump_macroblock_edges(int flag) {
257 dump_macro_block_edges = flag;
260 void dump_block_marker_in_title(int flag) {
261 dump_block_marker = flag;
264 /* -------------- some extended helper functions ----------------- */
267 * returns the name of a mode or ERROR_TXT if mode is NOT a mode object.
268 * in the later case, sets bad.
270 const char *get_mode_name_ex(ir_mode *mode, int *bad) {
272 return get_mode_name(mode);
278 * returns the name of a type or <ERROR> if mode is NOT a mode object.
279 * in the later case, sets bad
281 const char *get_type_name_ex(ir_type *tp, int *bad) {
283 return get_type_name(tp);
288 #define CUSTOM_COLOR_BASE 100
289 static const char *color_names[ird_color_count];
290 static const char *color_rgb[ird_color_count];
291 static struct obstack color_obst;
293 static void custom_color(int num, const char *rgb_def)
295 assert(num < ird_color_count);
296 obstack_printf(&color_obst, "%d", CUSTOM_COLOR_BASE + num);
297 obstack_1grow(&color_obst, '\0');
299 color_rgb[num] = rgb_def;
300 color_names[num] = obstack_finish(&color_obst);
303 static void named_color(int num, const char *name)
305 assert(num < ird_color_count);
306 color_rgb[num] = NULL;
307 color_names[num] = name;
310 static void init_colors(void)
312 static int initialized = 0;
316 obstack_init(&color_obst);
318 custom_color(ird_color_prog_background, "204 204 204");
319 custom_color(ird_color_block_background, "255 255 0");
320 custom_color(ird_color_dead_block_background, "190 150 150");
321 named_color(ird_color_block_inout, "lightblue");
322 named_color(ird_color_default_node, "white");
323 custom_color(ird_color_memory, "153 153 255");
324 custom_color(ird_color_controlflow, "255 153 153");
325 custom_color(ird_color_const, "204 255 255");
326 custom_color(ird_color_proj, "255 255 153");
327 custom_color(ird_color_uses_memory, "153 153 255");
328 custom_color(ird_color_phi, "105 255 105");
329 custom_color(ird_color_anchor, "100 100 255");
330 named_color(ird_color_error, "red");
336 * Prints the VCG color to a file.
338 static void print_vcg_color(FILE *F, ird_color_t color) {
339 assert(color < ird_color_count);
340 fprintf(F, "color:%s", color_names[color]);
344 * Prints the edge from a type S to a type T with additional info fmt, ...
347 static void print_type_type_edge(FILE *F, ir_type *S, ir_type *T, const char *fmt, ...)
352 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(S);
353 fprintf(F, " targetname: "); PRINT_TYPEID(T);
354 vfprintf(F, fmt, ap);
360 * Prints the edge from a type T to an entity E with additional info fmt, ...
363 static void print_type_ent_edge(FILE *F, ir_type *T, ir_entity *E, const char *fmt, ...)
368 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(T);
369 fprintf(F, " targetname: \""); PRINT_ENTID(E); fprintf(F, "\"");
370 vfprintf(F, fmt, ap);
376 * Prints the edge from an entity E to an entity T with additional info fmt, ...
379 static void print_ent_ent_edge(FILE *F, ir_entity *E, ir_entity *T, int backedge, const char *fmt, ...)
385 fprintf(F, "backedge: { sourcename: \"");
387 fprintf(F, "edge: { sourcename: \"");
389 fprintf(F, "\" targetname: \""); PRINT_ENTID(T); fprintf(F, "\"");
390 vfprintf(F, fmt, ap);
396 * Prints the edge from an entity E to a type T with additional info fmt, ...
399 static void print_ent_type_edge(FILE *F, ir_entity *E, ir_type *T, const char *fmt, ...)
404 fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(E);
405 fprintf(F, "\" targetname: "); PRINT_TYPEID(T);
406 vfprintf(F, fmt, ap);
412 * Prints the edge from a node N to a type T with additional info fmt, ...
415 static void print_node_type_edge(FILE *F, const ir_node *N, ir_type *T, const char *fmt, ...)
420 fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(N);
421 fprintf(F, "\" targetname: "); PRINT_TYPEID(T);
422 vfprintf(F, fmt, ap);
428 * Prints the edge from a node N to an entity E with additional info fmt, ...
431 static void print_node_ent_edge(FILE *F, const ir_node *N, ir_entity *E, const char *fmt, ...)
436 fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(N);
437 fprintf(F, "\" targetname: \""); PRINT_ENTID(E);
439 vfprintf(F, fmt, ap);
445 * Prints the edge from an entity E to a node N with additional info fmt, ...
448 static void print_ent_node_edge(FILE *F, ir_entity *E, const ir_node *N, const char *fmt, ...)
453 fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(E);
454 fprintf(F, "\" targetname: \""); PRINT_NODEID(N); fprintf(F, "\"");
455 vfprintf(F, fmt, ap);
461 * Prints the edge from a type E to an enumeration item item with additional info fmt, ...
464 static void print_enum_item_edge(FILE *F, ir_type *E, int item, const char *fmt, ...)
469 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(E);
470 fprintf(F, " targetname: \""); PRINT_ITEMID(E, item); fprintf(F, "\" ");
471 vfprintf(F, fmt, ap);
476 /*-----------------------------------------------------------------*/
477 /* global and ahead declarations */
478 /*-----------------------------------------------------------------*/
480 static void dump_whole_node(ir_node *n, void *env);
481 static INLINE void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg);
483 /*-----------------------------------------------------------------*/
484 /* Helper functions. */
485 /*-----------------------------------------------------------------*/
488 * This map is used as a private link attr to be able to call dumper
489 * anywhere without destroying link fields.
491 static pmap *irdump_link_map = NULL;
493 /** NOT A STANDARD LIBFIRM INIT METHOD
495 * We do not want to integrate dumping into libfirm, i.e., if the dumpers
496 * are off, we want to have as few interferences as possible. Therefore the
497 * initialization is performed lazily and not called from within init_firm.
499 * Creates the link attribute map. */
500 static void init_irdump(void) {
501 /* We need a new, empty map. */
502 if (irdump_link_map) pmap_destroy(irdump_link_map);
503 irdump_link_map = pmap_create();
504 if (!dump_file_filter_id)
505 dump_file_filter_id = new_id_from_str("");
509 * Returns the private link field.
511 static void *ird_get_irn_link(ir_node *n) {
513 if (!irdump_link_map) return NULL;
515 if (pmap_contains(irdump_link_map, (void *)n))
516 res = pmap_get(irdump_link_map, (void *)n);
521 * Sets the private link field.
523 static void ird_set_irn_link(ir_node *n, void *x) {
524 if (!irdump_link_map)
526 pmap_insert(irdump_link_map, (void *)n, x);
530 * Gets the private link field of an irg.
532 static void *ird_get_irg_link(ir_graph *irg) {
534 if (!irdump_link_map) return NULL;
536 if (pmap_contains(irdump_link_map, (void *)irg))
537 res = pmap_get(irdump_link_map, (void *)irg);
542 * Sets the private link field of an irg.
544 static void ird_set_irg_link(ir_graph *irg, void *x) {
545 if (!irdump_link_map) init_irdump();
546 pmap_insert(irdump_link_map, (void *)irg, x);
550 * Walker, clears the private link field.
552 static void clear_link(ir_node * node, void * env) {
554 ird_set_irn_link(node, NULL);
558 * If the entity has a ld_name, returns it if the dump_ld_name is set,
559 * else returns the name of the entity.
561 static const char *_get_ent_dump_name(ir_entity *ent, int dump_ld_name) {
563 return "<NULL entity>";
565 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
566 if (ent->ld_name) return get_id_str(ent->ld_name);
568 return get_id_str(ent->name);
572 * If the entity has a ld_name, returns it if the option dump_ld_name is set,
573 * else returns the name of the entity.
575 const char *get_ent_dump_name(ir_entity *ent) {
576 return _get_ent_dump_name(ent, dump_ld_name);
579 /* Returns the name of an IRG. */
580 const char *get_irg_dump_name(ir_graph *irg) {
581 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
582 return _get_ent_dump_name(get_irg_entity(irg), 1);
586 * Returns non-zero if a node is in floating state.
588 static int node_floats(ir_node *n) {
589 return ((get_irn_pinned(n) == op_pin_state_floats) &&
590 (get_irg_pinned(current_ir_graph) == op_pin_state_floats));
594 * Walker that visits the anchors
596 static void ird_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env) {
597 if (dump_anchors || (dump_new_edges_flag && edges_activated(irg))) {
598 irg_walk_anchors(irg, pre, post, env);
600 irg_walk_graph(irg, pre, post, env);
605 * Walker, allocates an array for all blocks and puts it's nodes non-floating nodes into this array.
607 static void collect_node(ir_node * node, void *env) {
611 || get_irn_op(node) == op_Bad
612 || get_irn_op(node) == op_Unknown
613 || get_irn_op(node) == op_NoMem) {
614 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
615 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
616 ARR_APP1(ir_node *, arr, node);
617 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
619 ir_node * block = get_nodes_block(node);
622 /* this node is in a Bad block, so we must place it into the graph's list */
623 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
624 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
625 ARR_APP1(ir_node *, arr, node);
626 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
628 ird_set_irn_link(node, ird_get_irn_link(block));
629 ird_set_irn_link(block, node);
634 /** Construct lists to walk ir block-wise.
636 * Collects all blocks, nodes not op_pin_state_pinned,
637 * Bad, NoMem and Unknown into a flexible array in link field of
638 * irg they belong to. Sets the irg link field to NULL in all
639 * graphs not visited.
640 * Free the list with DEL_ARR_F().
642 static ir_node **construct_block_lists(ir_graph *irg) {
644 #ifdef INTERPROCEDURAL_VIEW
645 int rem_view = get_interprocedural_view();
647 int walk_flag = using_irn_visited(irg);
648 ir_graph *rem = current_ir_graph;
650 current_ir_graph = irg;
653 clear_using_irn_visited(current_ir_graph);
655 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
656 ird_set_irg_link(get_irp_irg(i), NULL);
658 ird_walk_graph(current_ir_graph, clear_link, collect_node, current_ir_graph);
660 #ifdef INTERPROCEDURAL_VIEW
661 /* Collect also EndReg and EndExcept. We do not want to change the walker. */
662 set_interprocedural_view(0);
665 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
666 irg_walk(get_irg_end_reg(current_ir_graph), clear_link, collect_node, current_ir_graph);
667 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
668 irg_walk(get_irg_end_except(current_ir_graph), clear_link, collect_node, current_ir_graph);
670 #ifdef INTERPROCEDURAL_VIEW
671 set_interprocedural_view(rem_view);
675 set_using_irn_visited(current_ir_graph);
677 current_ir_graph = rem;
678 return ird_get_irg_link(irg);
681 typedef struct _list_tuple {
683 ir_extblk **extbb_list;
686 /** Construct lists to walk IR extended block-wise.
687 * Free the lists in the tuple with DEL_ARR_F().
688 * Sets the irg link field to NULL in all
689 * graphs not visited.
691 static list_tuple *construct_extblock_lists(ir_graph *irg) {
692 ir_node **blk_list = construct_block_lists(irg);
694 ir_graph *rem = current_ir_graph;
695 list_tuple *lists = xmalloc(sizeof(*lists));
697 current_ir_graph = irg;
699 lists->blk_list = NEW_ARR_F(ir_node *, 0);
700 lists->extbb_list = NEW_ARR_F(ir_extblk *, 0);
702 inc_irg_block_visited(irg);
703 for (i = ARR_LEN(blk_list) - 1; i >= 0; --i) {
706 if (is_Block(blk_list[i])) {
707 ext = get_Block_extbb(blk_list[i]);
709 if (extbb_not_visited(ext)) {
710 ARR_APP1(ir_extblk *, lists->extbb_list, ext);
711 mark_extbb_visited(ext);
714 ARR_APP1(ir_node *, lists->blk_list, blk_list[i]);
718 current_ir_graph = rem;
719 ird_set_irg_link(irg, lists);
723 /*-----------------------------------------------------------------*/
724 /* Routines to dump information about a single ir node. */
725 /*-----------------------------------------------------------------*/
728 * dump the name of a node n to the File F.
730 int dump_node_opcode(FILE *F, ir_node *n)
733 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
735 /* call the dump_node operation if available */
737 return ops->dump_node(n, F, dump_node_opcode_txt);
739 /* implementation for default nodes */
740 switch (get_irn_opcode(n)) {
743 ir_fprintf(F, "%T", get_Const_tarval(n));
747 switch (get_SymConst_kind(n)) {
748 case symconst_addr_name:
749 /* don't use get_SymConst_ptr_info as it mangles the name. */
750 fprintf(F, "SymC %s", get_id_str(get_SymConst_name(n)));
752 case symconst_addr_ent:
753 fprintf(F, "SymC &%s", get_entity_name(get_SymConst_entity(n)));
755 case symconst_ofs_ent:
756 fprintf(F, "SymC %s offset", get_entity_name(get_SymConst_entity(n)));
758 case symconst_type_tag:
759 fprintf(F, "SymC %s tag", get_type_name_ex(get_SymConst_type(n), &bad));
761 case symconst_type_size:
762 fprintf(F, "SymC %s size", get_type_name_ex(get_SymConst_type(n), &bad));
764 case symconst_type_align:
765 fprintf(F, "SymC %s align", get_type_name_ex(get_SymConst_type(n), &bad));
767 case symconst_enum_const:
768 fprintf(F, "SymC %s enum", get_enumeration_name(get_SymConst_enum(n)));
771 fprintf(F, "SymC %lu label", get_SymConst_label(n));
777 if (!get_interprocedural_view())
784 ir_node *pred = get_Proj_pred(n);
786 if (get_irn_opcode(pred) == iro_Cond
787 && get_Proj_proj(n) == get_Cond_defaultProj(pred)
788 && get_irn_mode(get_Cond_selector(pred)) != mode_b)
789 fprintf(F, "defProj");
797 if (get_interprocedural_view()) {
798 fprintf(F, "%s %s", get_irn_opname(n), get_ent_dump_name(get_irg_entity(get_irn_irg(n))));
803 case iro_CallBegin: {
804 ir_node *addr = get_CallBegin_ptr(n);
805 ir_entity *ent = NULL;
806 if (get_irn_op(addr) == op_Sel)
807 ent = get_Sel_entity(addr);
808 else if (is_Global(addr))
809 ent = get_Global_entity(addr);
810 fprintf(F, "%s", get_irn_opname(n));
811 if (ent) fprintf(F, " %s", get_entity_name(ent));
815 if (get_Load_align(n) == align_non_aligned)
817 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Load_mode(n), &bad));
820 if (get_Store_align(n) == align_non_aligned)
822 fprintf(F, "%s", get_irn_opname(n));
826 is_Block_dead(n) ? "Dead " : "", get_irn_opname(n),
827 dump_block_marker ? (get_Block_mark(n) ? "*" : "") : "");
830 if (get_Conv_strict(n))
831 fprintf(F, "strict");
832 fprintf(F, "%s", get_irn_opname(n));
835 fprintf(F, "%s", get_irn_opname(n));
836 if (is_Div_remainderless(n))
838 fprintf(F, "[%s]", get_mode_name_ex(get_Div_resmode(n), &bad));
841 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Mod_resmode(n), &bad));
844 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_DivMod_resmode(n), &bad));
849 fprintf(F, "%s", get_irn_opname(n));
856 * Dump the mode of a node n to a file F.
857 * Ignore modes that are "always known".
859 static int dump_node_mode(FILE *F, ir_node *n)
862 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
865 /* call the dump_node operation if available */
867 return ops->dump_node(n, F, dump_node_mode_txt);
869 /* default implementation */
870 iro = get_irn_opcode(n);
882 ir_mode *mode = get_irn_mode(n);
884 if (mode && mode != mode_BB && mode != mode_ANY && mode != mode_BAD &&
885 (mode != mode_T || iro == iro_Proj))
886 fprintf(F, "%s", get_mode_name_ex(mode, &bad));
894 * Dump the type of a node n to a file F if it's known.
896 static int dump_node_typeinfo(FILE *F, ir_node *n) {
899 if (opt_dump_analysed_type_info) {
900 if (get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_consistent ||
901 get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_inconsistent) {
902 ir_type *tp = get_irn_typeinfo_type(n);
903 if (tp != firm_none_type)
904 fprintf(F, "[%s] ", get_type_name_ex(tp, &bad));
912 typedef struct _pns_lookup {
913 long nr; /**< the proj number */
914 const char *name; /**< the name of the Proj */
917 typedef struct _proj_lookup {
918 ir_opcode code; /**< the opcode of the Proj predecessor */
919 unsigned num_data; /**< number of data entries */
920 const pns_lookup_t *data; /**< the data */
923 #define ARR_SIZE(a) (sizeof(a)/sizeof(a[0]))
925 /** the lookup table for Proj(Start) names */
926 static const pns_lookup_t start_lut[] = {
927 #define X(a) { pn_Start_##a, #a }
936 /** the lookup table for Proj(Cond) names */
937 static const pns_lookup_t cond_lut[] = {
938 #define X(a) { pn_Cond_##a, #a }
944 /** the lookup table for Proj(Call) names */
945 static const pns_lookup_t call_lut[] = {
946 #define X(a) { pn_Call_##a, #a }
956 /** the lookup table for Proj(Quot) names */
957 static const pns_lookup_t quot_lut[] = {
958 #define X(a) { pn_Quot_##a, #a }
966 /** the lookup table for Proj(DivMod) names */
967 static const pns_lookup_t divmod_lut[] = {
968 #define X(a) { pn_DivMod_##a, #a }
977 /** the lookup table for Proj(Div) names */
978 static const pns_lookup_t div_lut[] = {
979 #define X(a) { pn_Div_##a, #a }
987 /** the lookup table for Proj(Mod) names */
988 static const pns_lookup_t mod_lut[] = {
989 #define X(a) { pn_Mod_##a, #a }
997 /** the lookup table for Proj(Load) names */
998 static const pns_lookup_t load_lut[] = {
999 #define X(a) { pn_Load_##a, #a }
1007 /** the lookup table for Proj(Store) names */
1008 static const pns_lookup_t store_lut[] = {
1009 #define X(a) { pn_Store_##a, #a }
1016 /** the lookup table for Proj(Alloc) names */
1017 static const pns_lookup_t alloc_lut[] = {
1018 #define X(a) { pn_Alloc_##a, #a }
1026 /** the lookup table for Proj(CopyB) names */
1027 static const pns_lookup_t copyb_lut[] = {
1028 #define X(a) { pn_CopyB_##a, #a }
1036 /** the lookup table for Proj(InstOf) names */
1037 static const pns_lookup_t instof_lut[] = {
1038 #define X(a) { pn_InstOf_##a, #a }
1047 /** the lookup table for Proj(Raise) names */
1048 static const pns_lookup_t raise_lut[] = {
1049 #define X(a) { pn_Raise_##a, #a }
1055 /** the lookup table for Proj(Bound) names */
1056 static const pns_lookup_t bound_lut[] = {
1057 #define X(a) { pn_Bound_##a, #a }
1065 /** the Proj lookup table */
1066 static const proj_lookup_t proj_lut[] = {
1067 #define E(a) ARR_SIZE(a), a
1068 { iro_Start, E(start_lut) },
1069 { iro_Cond, E(cond_lut) },
1070 { iro_Call, E(call_lut) },
1071 { iro_Quot, E(quot_lut) },
1072 { iro_DivMod, E(divmod_lut) },
1073 { iro_Div, E(div_lut) },
1074 { iro_Mod, E(mod_lut) },
1075 { iro_Load, E(load_lut) },
1076 { iro_Store, E(store_lut) },
1077 { iro_Alloc, E(alloc_lut) },
1078 { iro_CopyB, E(copyb_lut) },
1079 { iro_InstOf, E(instof_lut) },
1080 { iro_Raise, E(raise_lut) },
1081 { iro_Bound, E(bound_lut) }
1086 * Dump additional node attributes of some nodes to a file F.
1089 dump_node_nodeattr(FILE *F, ir_node *n)
1095 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1097 /* call the dump_node operation if available */
1099 return ops->dump_node(n, F, dump_node_nodeattr_txt);
1101 switch (get_irn_opcode(n)) {
1103 if (0 && get_interprocedural_view()) {
1104 fprintf(F, "%s ", get_ent_dump_name(get_irg_entity(current_ir_graph)));
1109 pred = get_Proj_pred(n);
1110 proj_nr = get_Proj_proj(n);
1112 code = get_irn_opcode(pred);
1114 if (code == iro_Cmp)
1115 fprintf(F, "%s ", get_pnc_string(get_Proj_proj(n)));
1116 else if (code == iro_Proj && get_irn_opcode(get_Proj_pred(pred)) == iro_Start)
1117 fprintf(F, "Arg %ld ", proj_nr);
1118 else if (code == iro_Cond && get_irn_mode(get_Cond_selector(pred)) != mode_b)
1119 fprintf(F, "%ld ", proj_nr);
1121 unsigned i, j, f = 0;
1123 for (i = 0; i < ARR_SIZE(proj_lut); ++i) {
1124 if (code == proj_lut[i].code) {
1125 for (j = 0; j < proj_lut[i].num_data; ++j) {
1126 if (proj_nr == proj_lut[i].data[j].nr) {
1127 fprintf(F, "%s ", proj_lut[i].data[j].name);
1136 fprintf(F, "%ld ", proj_nr);
1137 if (code == iro_Cond && get_Cond_jmp_pred(pred) != COND_JMP_PRED_NONE) {
1138 if (proj_nr == pn_Cond_false && get_Cond_jmp_pred(pred) == COND_JMP_PRED_FALSE)
1139 fprintf(F, "PRED ");
1140 if (proj_nr == pn_Cond_true && get_Cond_jmp_pred(pred) == COND_JMP_PRED_TRUE)
1141 fprintf(F, "PRED ");
1146 proj_nr = get_Filter_proj(n);
1147 if (! get_interprocedural_view()) {
1149 pred = get_Filter_pred(n);
1152 fprintf(F, "%ld ", proj_nr);
1155 fprintf(F, "%s ", get_ent_dump_name(get_Sel_entity(n)));
1158 fprintf(F, "(%s) ", get_type_name_ex(get_Cast_type(n), &bad));
1161 fprintf(F, "%s ", get_pnc_string(get_Confirm_cmp(n)));
1164 fprintf(F, "(%s) ", get_type_name_ex(get_CopyB_type(n), &bad));
1175 #include "execution_frequency.h"
1177 static void dump_node_ana_vals(FILE *F, ir_node *n) {
1181 #ifdef INTERPROCEDURAL_VIEW
1182 fprintf(F, " %lf*(%2.0lf + %2.0lf) = %2.0lf ",
1183 get_irn_exec_freq(n),
1184 get_irg_method_execution_frequency(get_irn_irg(n)),
1185 pow(5, get_irg_recursion_depth(get_irn_irg(n))),
1186 get_irn_exec_freq(n) * (get_irg_method_execution_frequency(get_irn_irg(n)) + pow(5, get_irg_recursion_depth(get_irn_irg(n))))
1192 /* Dumps a node label without the enclosing ". */
1193 int dump_node_label(FILE *F, ir_node *n) {
1196 bad |= dump_node_opcode(F, n);
1197 bad |= dump_node_mode(F, n);
1199 bad |= dump_node_typeinfo(F, n);
1200 bad |= dump_node_nodeattr(F, n);
1201 if(dump_node_idx_labels) {
1202 fprintf(F, "%ld:%d", get_irn_node_nr(n), get_irn_idx(n));
1204 fprintf(F, "%ld", get_irn_node_nr(n));
1211 * Dumps the attributes of a node n into the file F.
1212 * Currently this is only the color of a node.
1214 static void dump_node_vcgattr(FILE *F, ir_node *node, ir_node *local, int bad)
1220 print_vcg_color(F, ird_color_error);
1224 if (dump_node_vcgattr_hook)
1225 if (dump_node_vcgattr_hook(F, node, local))
1228 n = local ? local : node;
1230 if (overrule_nodecolor != ird_color_default_node) {
1231 print_vcg_color(F, overrule_nodecolor);
1235 mode = get_irn_mode(node);
1236 if(mode == mode_M) {
1237 print_vcg_color(F, ird_color_memory);
1240 if(mode == mode_X) {
1241 print_vcg_color(F, ird_color_controlflow);
1245 switch (get_irn_opcode(n)) {
1250 print_vcg_color(F, ird_color_anchor);
1253 print_vcg_color(F, ird_color_error);
1256 if (is_Block_dead(n))
1257 print_vcg_color(F, ird_color_dead_block_background);
1259 print_vcg_color(F, ird_color_block_background);
1262 print_vcg_color(F, ird_color_phi);
1265 print_vcg_color(F, ird_color_memory);
1269 print_vcg_color(F, ird_color_const);
1272 print_vcg_color(F, ird_color_proj);
1275 ir_op *op = get_irn_op(node);
1277 if(is_op_constlike(op)) {
1278 print_vcg_color(F, ird_color_const);
1279 } else if(is_op_uses_memory(op)) {
1280 print_vcg_color(F, ird_color_uses_memory);
1281 } else if(is_op_cfopcode(op) || is_op_forking(op)) {
1282 print_vcg_color(F, ird_color_controlflow);
1284 PRINT_DEFAULT_NODE_ATTR;
1290 /* Adds a new node info dumper callback. */
1291 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data)
1293 hook_entry_t *info = xmalloc(sizeof(*info));
1295 info->hook._hook_node_info = cb;
1296 info->context = data;
1297 register_hook(hook_node_info, info);
1302 /* Remove a previously added info dumper callback. */
1303 void dump_remv_node_info_callback(void *handle)
1305 hook_entry_t *info = handle;
1306 unregister_hook(hook_node_info, info);
1311 * Dump the node information of a node n to a file F.
1313 static INLINE int dump_node_info(FILE *F, ir_node *n)
1316 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1318 fprintf(F, " info1: \"");
1319 bad = dump_irnode_to_file(F, n);
1320 /* call the dump_node operation if available */
1322 bad = ops->dump_node(n, F, dump_node_info_txt);
1324 /* allow additional info to be added */
1325 hook_node_info(F, n);
1331 static INLINE int is_constlike_node(const ir_node *node)
1333 const ir_op *op = get_irn_op(node);
1334 return is_op_constlike(op);
1338 /** outputs the predecessors of n, that are constants, local. I.e.,
1339 generates a copy of the constant predecessors for each node called with. */
1340 static void dump_const_node_local(FILE *F, ir_node *n) {
1342 if (!get_opt_dump_const_local()) return;
1344 /* Use visited flag to avoid outputting nodes twice.
1345 initialize it first. */
1346 for (i = 0; i < get_irn_arity(n); i++) {
1347 ir_node *con = get_irn_n(n, i);
1348 if (is_constlike_node(con)) {
1349 set_irn_visited(con, get_irg_visited(current_ir_graph) - 1);
1353 for (i = 0; i < get_irn_arity(n); i++) {
1354 ir_node *con = get_irn_n(n, i);
1355 if (is_constlike_node(con) && irn_not_visited(con)) {
1358 mark_irn_visited(con);
1359 /* Generate a new name for the node by appending the names of
1361 fprintf(F, "node: {title: "); PRINT_CONSTID(n, con);
1362 fprintf(F, " label: \"");
1363 bad |= dump_node_label(F, con);
1365 bad |= dump_node_info(F, con);
1366 dump_node_vcgattr(F, n, con, bad);
1372 /** If the block of an edge is a const_like node, dump it local with an edge */
1373 static void dump_const_block_local(FILE *F, ir_node *n) {
1376 if (!get_opt_dump_const_local()) return;
1378 blk = get_nodes_block(n);
1379 if (is_constlike_node(blk)) {
1382 /* Generate a new name for the node by appending the names of
1384 fprintf(F, "node: {title: \""); PRINT_CONSTBLKID(n, blk);
1385 fprintf(F, "\" label: \"");
1386 bad |= dump_node_label(F, blk);
1388 bad |= dump_node_info(F, blk);
1389 dump_node_vcgattr(F, n, blk, bad);
1392 fprintf(F, "edge: { sourcename: \"");
1394 fprintf(F, "\" targetname: \""); PRINT_CONSTBLKID(n,blk);
1396 if (dump_edge_vcgattr_hook) {
1398 if (dump_edge_vcgattr_hook(F, n, -1)) {
1402 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1407 fprintf(F, "\" " BLOCK_EDGE_ATTR "}\n");
1412 * prints the error message of a node to a file F as info2.
1414 static void print_node_error(FILE *F, const char *err_msg)
1419 fprintf(F, " info2: \"%s\"", err_msg);
1423 * prints debug messages of a node to file F as info3.
1425 static void print_dbg_info(FILE *F, dbg_info *dbg)
1429 if (__dbg_info_snprint) {
1431 if (__dbg_info_snprint(buf, sizeof(buf), dbg) > 0)
1432 fprintf(F, " info3: \"%s\"\n", buf);
1439 static void dump_node(FILE *F, ir_node *n)
1444 if (get_opt_dump_const_local() && is_constlike_node(n))
1447 /* dump this node */
1448 fprintf(F, "node: {title: \""); PRINT_NODEID(n); fprintf(F, "\" label: \"");
1450 bad = ! irn_vrfy_irg_dump(n, current_ir_graph, &p);
1451 bad |= dump_node_label(F, n);
1452 dump_node_ana_vals(F, n);
1453 //dump_node_ana_info(F, n);
1455 bad |= dump_node_info(F, n);
1456 print_node_error(F, p);
1457 print_dbg_info(F, get_irn_dbg_info(n));
1458 dump_node_vcgattr(F, n, NULL, bad);
1460 dump_const_node_local(F, n);
1462 if(dump_node_edge_hook)
1463 dump_node_edge_hook(F, n);
1465 dump_irn_chi_term(F, n);
1466 dump_irn_state(F, n);
1470 /** dump the edge to the block this node belongs to */
1472 dump_ir_block_edge(FILE *F, ir_node *n) {
1473 if (get_opt_dump_const_local() && is_constlike_node(n)) return;
1474 if (is_no_Block(n)) {
1475 ir_node *block = get_nodes_block(n);
1477 if (get_opt_dump_const_local() && is_constlike_node(block)) {
1478 dump_const_block_local(F, n);
1480 fprintf(F, "edge: { sourcename: \"");
1482 fprintf(F, "\" targetname: ");
1483 fprintf(F, "\""); PRINT_NODEID(block); fprintf(F, "\"");
1485 if (dump_edge_vcgattr_hook) {
1487 if (dump_edge_vcgattr_hook(F, n, -1)) {
1491 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1496 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1502 print_data_edge_vcgattr(FILE *F, ir_node *from, int to) {
1504 * do not use get_nodes_block() here, will fail
1505 * if the irg is not pinned.
1507 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1508 fprintf(F, INTRA_DATA_EDGE_ATTR);
1510 fprintf(F, INTER_DATA_EDGE_ATTR);
1514 print_mem_edge_vcgattr(FILE *F, ir_node *from, int to) {
1516 * do not use get_nodes_block() here, will fail
1517 * if the irg is not pinned.
1519 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1520 fprintf(F, INTRA_MEM_EDGE_ATTR);
1522 fprintf(F, INTER_MEM_EDGE_ATTR);
1525 /** Print the vcg attributes for the edge from node from to it's to's input */
1526 static void print_edge_vcgattr(FILE *F, ir_node *from, int to) {
1529 if (dump_edge_vcgattr_hook)
1530 if (dump_edge_vcgattr_hook(F, from, to))
1533 if (dump_backedge_information_flag && is_backedge(from, to))
1534 fprintf(F, BACK_EDGE_ATTR);
1536 switch (get_irn_opcode(from)) {
1538 fprintf(F, CF_EDGE_ATTR);
1540 case iro_Start: break;
1543 if (get_irn_mode(get_End_keepalive(from, to)) == mode_BB)
1544 fprintf(F, KEEP_ALIVE_CF_EDGE_ATTR);
1546 fprintf(F, KEEP_ALIVE_DF_EDGE_ATTR);
1550 if (is_Proj(from)) {
1551 if (get_irn_mode(from) == mode_M)
1552 print_mem_edge_vcgattr(F, from, to);
1553 else if (get_irn_mode(from) == mode_X)
1554 fprintf(F, CF_EDGE_ATTR);
1556 print_data_edge_vcgattr(F, from, to);
1558 else if (get_irn_mode(get_irn_n(from, to)) == mode_M)
1559 print_mem_edge_vcgattr(F, from, to);
1560 else if (get_irn_mode(get_irn_n(from, to)) == mode_X)
1561 fprintf(F, CF_EDGE_ATTR);
1563 print_data_edge_vcgattr(F, from, to);
1567 /** dump edges to our inputs */
1568 static void dump_ir_data_edges(FILE *F, ir_node *n) {
1570 unsigned long visited = get_irn_visited(n);
1572 if (!dump_keepalive && is_End(n)) {
1573 /* the End node has only keep-alive edges */
1577 /* dump the dependency edges. */
1578 num = get_irn_deps(n);
1579 for (i = 0; i < num; ++i) {
1580 ir_node *dep = get_irn_dep(n, i);
1583 fprintf(F, "edge: {sourcename: \"");
1585 fprintf(F, "\" targetname: ");
1586 if ((get_opt_dump_const_local()) && is_constlike_node(dep)) {
1587 PRINT_CONSTID(n, dep);
1593 fprintf(F, " label: \"%d\" ", i);
1594 fprintf(F, " color: darkgreen}\n");
1598 num = get_irn_arity(n);
1599 for (i = 0; i < num; i++) {
1600 ir_node *pred = get_irn_n(n, i);
1603 if ((get_interprocedural_view() && get_irn_visited(pred) < visited))
1604 continue; /* pred not dumped */
1606 if (dump_backedge_information_flag && is_backedge(n, i))
1607 fprintf(F, "backedge: {sourcename: \"");
1609 fprintf(F, "edge: {sourcename: \"");
1611 fprintf(F, "\" targetname: ");
1612 if ((get_opt_dump_const_local()) && is_constlike_node(pred)) {
1613 PRINT_CONSTID(n, pred);
1615 fprintf(F, "\""); PRINT_NODEID(pred); fprintf(F, "\"");
1617 fprintf(F, " label: \"%d\" ", i);
1618 print_edge_vcgattr(F, n, i);
1622 if (dump_macro_block_edges && is_Block(n)) {
1623 ir_node *mb = get_Block_MacroBlock(n);
1624 fprintf(F, "edge: {sourcename: \"");
1626 fprintf(F, "\" targetname: \"");
1628 fprintf(F, "\" label: \"mb\" " MACROBLOCK_EDGE_ATTR);
1637 dump_ir_edges(FILE *F, ir_node *n) {
1638 const ir_edge_t *edge;
1641 foreach_out_edge(n, edge) {
1642 ir_node *succ = get_edge_src_irn(edge);
1644 fprintf(F, "edge: {sourcename: \"");
1646 fprintf(F, "\" targetname: \"");
1650 fprintf(F, " label: \"%d\" ", i);
1651 fprintf(F, OUT_EDGE_ATTR);
1658 /** Dumps a node and its edges but not the block edge */
1659 static void dump_node_wo_blockedge(ir_node *n, void *env) {
1662 dump_ir_data_edges(F, n);
1665 /** Dumps a node and its edges. */
1666 static void dump_whole_node(ir_node *n, void *env) {
1668 dump_node_wo_blockedge(n, env);
1669 if (!node_floats(n))
1670 dump_ir_block_edge(F, n);
1671 if (dump_new_edges_flag && edges_activated(current_ir_graph))
1672 dump_ir_edges(F, n);
1675 /** Dumps a const-like node. */
1676 static void dump_const_node(ir_node *n, void *env) {
1677 if (is_Block(n)) return;
1678 dump_node_wo_blockedge(n, env);
1681 /***********************************************************************/
1682 /* the following routines dump the nodes/irgs bracketed to graphs. */
1683 /***********************************************************************/
1685 /** Dumps a constant expression as entity initializer, array bound ...
1687 static void dump_const_expression(FILE *F, ir_node *value) {
1688 ir_graph *rem = current_ir_graph;
1689 int rem_dump_const_local = dump_const_local;
1690 dump_const_local = 0;
1691 current_ir_graph = get_const_code_irg();
1692 irg_walk(value, dump_const_node, NULL, F);
1693 /* Decrease visited flag so that we walk with the same flag for the next
1694 expression. This guarantees that we don't dump the same node twice,
1695 as for const expressions cse is performed to save memory. */
1696 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph) -1);
1697 current_ir_graph = rem;
1698 dump_const_local = rem_dump_const_local;
1701 /** Dump a block as graph containing its nodes.
1703 * Expects to find nodes belonging to the block as list in its
1705 * Dumps the edges of all nodes including itself. */
1706 static void dump_whole_block(FILE *F, ir_node *block) {
1708 ird_color_t color = ird_color_block_background;
1710 assert(is_Block(block));
1712 fprintf(F, "graph: { title: \"");
1713 PRINT_NODEID(block);
1714 fprintf(F, "\" label: \"");
1715 dump_node_label(F, block);
1717 if (get_opt_dump_abstvals())
1718 fprintf(F, " seqno: %d", (int)get_Block_seqno(block));
1721 /* colorize blocks */
1722 if (! get_Block_matured(block))
1723 color = ird_color_block_background;
1724 if (is_Block_dead(block))
1725 color = ird_color_dead_block_background;
1727 fprintf(F, "\" status:clustered ");
1728 print_vcg_color(F, color);
1731 /* yComp can show attributes for blocks, XVCG parses but ignores them */
1732 dump_node_info(F, block);
1733 print_dbg_info(F, get_irn_dbg_info(block));
1735 /* dump the blocks edges */
1736 dump_ir_data_edges(F, block);
1738 if (dump_block_edge_hook)
1739 dump_block_edge_hook(F, block);
1741 /* dump the nodes that go into the block */
1742 for (node = ird_get_irn_link(block); node; node = ird_get_irn_link(node)) {
1744 dump_ir_data_edges(F, node);
1747 /* Close the vcg information for the block */
1749 dump_const_node_local(F, block);
1751 dump_irn_chi_term(F, block);
1756 /** dumps a graph block-wise. Expects all blockless nodes in arr in irgs link.
1757 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1759 dump_block_graph(FILE *F, ir_graph *irg) {
1761 ir_graph *rem = current_ir_graph;
1762 ir_node **arr = ird_get_irg_link(irg);
1763 current_ir_graph = irg;
1765 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1766 ir_node * node = arr[i];
1767 if (is_Block(node)) {
1768 /* Dumps the block and all the nodes in the block, which are to
1769 be found in Block->link. */
1770 dump_whole_block(F, node);
1772 /* Nodes that are not in a Block. */
1774 if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
1775 dump_const_block_local(F, node);
1777 dump_ir_data_edges(F, node);
1779 if (dump_new_edges_flag && edges_activated(irg))
1780 dump_ir_edges(F, node);
1783 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1784 dump_loop_nodes_into_graph(F, irg);
1786 current_ir_graph = rem;
1790 * Dump the info for an irg.
1791 * Parsed by XVCG but not shown. use yComp.
1793 static void dump_graph_info(FILE *F, ir_graph *irg) {
1794 fprintf(F, "info1: \"");
1795 dump_entity_to_file(F, get_irg_entity(irg), dump_verbosity_entattrs | dump_verbosity_entconsts);
1799 /** Dumps an irg as a graph clustered by block nodes.
1800 * If interprocedural view edges can point to nodes out of this graph.
1802 static void dump_graph_from_list(FILE *F, ir_graph *irg) {
1803 ir_entity *ent = get_irg_entity(irg);
1805 fprintf(F, "graph: { title: \"");
1807 fprintf(F, "\" label: \"%s\" status:clustered color:%s \n",
1808 get_ent_dump_name(ent), color_names[ird_color_prog_background]);
1810 dump_graph_info(F, irg);
1811 print_dbg_info(F, get_entity_dbg_info(ent));
1813 dump_block_graph(F, irg);
1815 /* Close the vcg information for the irg */
1816 fprintf(F, "}\n\n");
1819 /** dumps a graph extended block-wise. Expects all blockless nodes in arr in irgs link.
1820 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1822 dump_extblock_graph(FILE *F, ir_graph *irg) {
1824 ir_graph *rem = current_ir_graph;
1825 ir_extblk **arr = ird_get_irg_link(irg);
1826 current_ir_graph = irg;
1828 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1829 ir_extblk *extbb = arr[i];
1830 ir_node *leader = get_extbb_leader(extbb);
1833 fprintf(F, "graph: { title: \"");
1834 PRINT_EXTBBID(leader);
1835 fprintf(F, "\" label: \"ExtBB %ld\" status:clustered color:lightgreen\n",
1836 get_irn_node_nr(leader));
1838 for (j = ARR_LEN(extbb->blks) - 1; j >= 0; --j) {
1839 ir_node * node = extbb->blks[j];
1840 if (is_Block(node)) {
1841 /* Dumps the block and all the nodes in the block, which are to
1842 be found in Block->link. */
1843 dump_whole_block(F, node);
1845 /* Nodes that are not in a Block. */
1847 if (is_Bad(get_nodes_block(node)) && !node_floats(node)) {
1848 dump_const_block_local(F, node);
1850 dump_ir_data_edges(F, node);
1856 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1857 dump_loop_nodes_into_graph(F, irg);
1859 current_ir_graph = rem;
1864 /*******************************************************************/
1865 /* Basic type and entity nodes and edges. */
1866 /*******************************************************************/
1868 /** dumps the edges between nodes and their type or entity attributes. */
1869 static void dump_node2type_edges(ir_node *n, void *env)
1874 switch (get_irn_opcode(n)) {
1876 /* @@@ some consts have an entity */
1879 if (SYMCONST_HAS_TYPE(get_SymConst_kind(n)))
1880 print_node_type_edge(F,n,get_SymConst_type(n),NODE2TYPE_EDGE_ATTR);
1883 print_node_ent_edge(F,n,get_Sel_entity(n),NODE2TYPE_EDGE_ATTR);
1886 print_node_type_edge(F,n,get_Call_type(n),NODE2TYPE_EDGE_ATTR);
1889 print_node_type_edge(F,n,get_Alloc_type(n),NODE2TYPE_EDGE_ATTR);
1892 print_node_type_edge(F,n,get_Free_type(n),NODE2TYPE_EDGE_ATTR);
1895 print_node_type_edge(F,n,get_Cast_type(n),NODE2TYPE_EDGE_ATTR);
1903 static int print_type_info(FILE *F, ir_type *tp) {
1906 if (get_type_state(tp) == layout_undefined) {
1907 fprintf(F, "state: layout_undefined\n");
1909 fprintf(F, "state: layout_fixed,\n");
1911 if (get_type_mode(tp))
1912 fprintf(F, "mode: %s,\n", get_mode_name_ex(get_type_mode(tp), &bad));
1913 fprintf(F, "size: %db,\n", get_type_size_bits(tp));
1918 static void print_typespecific_info(FILE *F, ir_type *tp) {
1919 switch (get_type_tpop_code(tp)) {
1921 fprintf(F, "peculiarity: %s\n", get_peculiarity_string(get_class_peculiarity(tp)));
1926 fprintf(F, "variadicity: %s\n", get_variadicity_name(get_method_variadicity(tp)));
1927 fprintf(F, "params: %d\n", get_method_n_params(tp));
1928 fprintf(F, "results: %d\n", get_method_n_ress(tp));
1934 case tpo_enumeration:
1946 static void print_typespecific_vcgattr(FILE *F, ir_type *tp) {
1947 switch (get_type_tpop_code(tp)) {
1949 if (peculiarity_existent == get_class_peculiarity(tp))
1950 fprintf(F, " " TYPE_CLASS_NODE_ATTR);
1952 fprintf(F, " " TYPE_DESCRIPTION_NODE_ATTR);
1955 fprintf(F, " " TYPE_METH_NODE_ATTR);
1963 case tpo_enumeration:
1975 int dump_type_node(FILE *F, ir_type *tp)
1979 fprintf(F, "node: {title: ");
1981 fprintf(F, " label: \"%s %s\"", get_type_tpop_name(tp), get_type_name_ex(tp, &bad));
1982 fprintf(F, " info1: \"");
1984 bad |= print_type_info(F, tp);
1985 print_typespecific_info(F, tp);
1987 dump_type_to_file(F, tp, dump_verbosity_max);
1990 print_dbg_info(F, get_type_dbg_info(tp));
1991 print_typespecific_vcgattr(F, tp);
1998 void dump_entity_node(FILE *F, ir_entity *ent, int color)
2000 fprintf(F, "node: {title: \"");
2001 PRINT_ENTID(ent); fprintf(F, "\"");
2002 fprintf(F, DEFAULT_TYPE_ATTRIBUTE);
2003 fprintf(F, "label: ");
2004 fprintf(F, "\"ent %s\" ", get_ent_dump_name(ent));
2006 fprintf(F, "color:%d", color);
2008 fprintf(F, ENTITY_NODE_ATTR);
2009 fprintf(F, "\n info1: \"");
2011 dump_entity_to_file(F, ent, dump_verbosity_entattrs | dump_verbosity_entconsts);
2014 print_dbg_info(F, get_entity_dbg_info(ent));
2018 static void dump_enum_item(FILE *F, ir_type *tp, int pos)
2021 ir_enum_const *ec = get_enumeration_const(tp, pos);
2022 ident *id = get_enumeration_nameid(ec);
2023 tarval *tv = get_enumeration_value(ec);
2026 tarval_snprintf(buf, sizeof(buf), tv);
2028 strncpy(buf, "<not set>", sizeof(buf));
2029 fprintf(F, "node: {title: \"");
2030 PRINT_ITEMID(tp, pos); fprintf(F, "\"");
2031 fprintf(F, DEFAULT_ENUM_ITEM_ATTRIBUTE);
2032 fprintf(F, "label: ");
2033 fprintf(F, "\"enum item %s\" " ENUM_ITEM_NODE_ATTR, get_id_str(id));
2034 fprintf(F, "\n info1: \"value: %s\"}\n", buf);
2037 /* dumps a type or entity and it's edges. */
2039 dump_type_info(type_or_ent *tore, void *env) {
2041 int i = 0; /* to shutup gcc */
2043 /* dump this type or entity */
2045 switch (get_kind(tore)) {
2047 ir_entity *ent = (ir_entity *)tore;
2050 dump_entity_node(F, ent, 0);
2052 /* skip this to reduce graph. Member edge of type is parallel to this edge. *
2053 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2054 ENT_OWN_EDGE_ATTR "}\n", ent, get_entity_owner(ent));*/
2055 print_ent_type_edge(F,ent, get_entity_type(ent), ENT_TYPE_EDGE_ATTR);
2056 if (is_Class_type(get_entity_owner(ent))) {
2057 for(i = 0; i < get_entity_n_overwrites(ent); i++)
2058 print_ent_ent_edge(F,ent, get_entity_overwrites(ent, i), 0, ENT_OVERWRITES_EDGE_ATTR);
2060 /* attached subgraphs */
2061 if (const_entities && (get_entity_variability(ent) != variability_uninitialized)) {
2062 if (is_atomic_entity(ent)) {
2063 value = get_atomic_ent_value(ent);
2065 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2066 /* DDMN(value); $$$ */
2067 dump_const_expression(F, value);
2070 if (is_compound_entity(ent)) {
2071 for (i = 0; i < get_compound_ent_n_values(ent); i++) {
2072 value = get_compound_ent_value(ent, i);
2074 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2075 dump_const_expression(F, value);
2076 print_ent_ent_edge(F, ent, get_compound_ent_value_member(ent, i), 0, ENT_CORR_EDGE_ATTR, i);
2078 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2079 ENT_CORR_EDGE_ATTR "}\n", GET_ENTID(ent),
2080 get_compound_ent_value_member(ent, i), i);
2089 ir_type *tp = (ir_type *)tore;
2090 dump_type_node(F, tp);
2091 /* and now the edges */
2092 switch (get_type_tpop_code(tp)) {
2094 for (i=0; i < get_class_n_supertypes(tp); i++)
2095 print_type_type_edge(F, tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2096 for (i=0; i < get_class_n_members(tp); i++)
2097 print_type_ent_edge(F,tp,get_class_member(tp, i),TYPE_MEMBER_EDGE_ATTR);
2100 for (i=0; i < get_struct_n_members(tp); i++)
2101 print_type_ent_edge(F,tp,get_struct_member(tp, i),TYPE_MEMBER_EDGE_ATTR);
2104 for (i = 0; i < get_method_n_params(tp); i++)
2105 print_type_type_edge(F,tp,get_method_param_type(tp, i),METH_PAR_EDGE_ATTR,i);
2106 for (i = 0; i < get_method_n_ress(tp); i++)
2107 print_type_type_edge(F,tp,get_method_res_type(tp, i),METH_RES_EDGE_ATTR,i);
2110 for (i = 0; i < get_union_n_members(tp); i++)
2111 print_type_ent_edge(F,tp,get_union_member(tp, i),UNION_EDGE_ATTR);
2114 print_type_type_edge(F,tp,get_array_element_type(tp),ARR_ELT_TYPE_EDGE_ATTR);
2115 print_type_ent_edge(F,tp,get_array_element_entity(tp),ARR_ENT_EDGE_ATTR);
2116 for (i = 0; i < get_array_n_dimensions(tp); i++) {
2117 ir_node *upper = get_array_upper_bound(tp, i);
2118 ir_node *lower = get_array_lower_bound(tp, i);
2119 print_node_type_edge(F, upper, tp, "label: \"upper %d\"", get_array_order(tp, i));
2120 print_node_type_edge(F, lower, tp, "label: \"lower %d\"", get_array_order(tp, i));
2121 dump_const_expression(F, upper);
2122 dump_const_expression(F, lower);
2125 case tpo_enumeration:
2126 for (i = 0; i < get_enumeration_n_enums(tp); ++i) {
2127 dump_enum_item(F, tp, i);
2128 print_enum_item_edge(F, tp, i, "label: \"item %d\"", i);
2132 print_type_type_edge(F,tp,get_pointer_points_to_type(tp), PTR_PTS_TO_EDGE_ATTR);
2139 break; /* case k_type */
2142 printf(" *** irdump, dump_type_info(l.%i), faulty type.\n", __LINE__);
2143 } /* switch kind_or_entity */
2146 typedef struct _h_env {
2151 /** For dumping class hierarchies.
2152 * Dumps a class type node and a superclass edge.
2153 * If env->dump_ent dumps entities of classes and overwrites edges.
2156 dump_class_hierarchy_node(type_or_ent *tore, void *ctx) {
2159 int i = 0; /* to shutup gcc */
2161 /* dump this type or entity */
2162 switch (get_kind(tore)) {
2164 ir_entity *ent = (ir_entity *)tore;
2165 if (get_entity_owner(ent) == get_glob_type()) break;
2166 if (!is_Method_type(get_entity_type(ent))) break; /* GL */
2167 if (env->dump_ent && is_Class_type(get_entity_owner(ent))) {
2169 dump_entity_node(F, ent, 0);
2171 print_type_ent_edge(F,get_entity_owner(ent),ent,TYPE_MEMBER_EDGE_ATTR);
2172 for(i = 0; i < get_entity_n_overwrites(ent); i++)
2173 print_ent_ent_edge(F, get_entity_overwrites(ent, i), ent, 0, ENT_OVERWRITES_EDGE_ATTR);
2178 ir_type *tp = (ir_type *)tore;
2179 if (tp == get_glob_type()) break;
2180 switch (get_type_tpop_code(tp)) {
2182 dump_type_node(F, tp);
2183 /* and now the edges */
2184 for (i=0; i < get_class_n_supertypes(tp); i++) {
2185 print_type_type_edge(F,tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2190 break; /* case k_type */
2193 printf(" *** irdump, dump_class_hierarchy_node(l.%i), faulty type.\n", __LINE__);
2194 } /* switch kind_or_entity */
2197 /*******************************************************************/
2198 /* dump analysis information that is expressed in graph terms. */
2199 /*******************************************************************/
2201 /* dump out edges */
2203 dump_out_edge(ir_node *n, void *env) {
2206 for (i = 0; i < get_irn_n_outs(n); i++) {
2207 assert(get_irn_out(n, i));
2208 fprintf(F, "edge: {sourcename: \"");
2210 fprintf(F, "\" targetname: \"");
2211 PRINT_NODEID(get_irn_out(n, i));
2212 fprintf(F, "\" color: red linestyle: dashed");
2218 dump_loop_label(FILE *F, ir_loop *loop) {
2219 fprintf(F, "loop %d, %d sons, %d nodes",
2220 get_loop_depth(loop), get_loop_n_sons(loop), get_loop_n_nodes(loop));
2223 static INLINE void dump_loop_info(FILE *F, ir_loop *loop) {
2224 fprintf(F, " info1: \"");
2225 fprintf(F, " loop nr: %d", get_loop_loop_nr(loop));
2226 #ifdef DEBUG_libfirm /* GL @@@ debug analyses */
2227 fprintf(F, "\n The loop was analyzed %d times.", PTR_TO_INT(get_loop_link(loop)));
2233 dump_loop_node(FILE *F, ir_loop *loop) {
2234 fprintf(F, "node: {title: \"");
2236 fprintf(F, "\" label: \"");
2237 dump_loop_label(F, loop);
2239 dump_loop_info(F, loop);
2244 dump_loop_node_edge(FILE *F, ir_loop *loop, int i) {
2246 fprintf(F, "edge: {sourcename: \"");
2248 fprintf(F, "\" targetname: \"");
2249 PRINT_NODEID(get_loop_node(loop, i));
2250 fprintf(F, "\" color: green");
2255 dump_loop_son_edge(FILE *F, ir_loop *loop, int i) {
2257 fprintf(F, "edge: {sourcename: \"");
2259 fprintf(F, "\" targetname: \"");
2260 PRINT_LOOPID(get_loop_son(loop, i));
2261 fprintf(F, "\" color: darkgreen label: \"%d\"}\n",
2262 get_loop_element_pos(loop, get_loop_son(loop, i)));
2266 void dump_loops(FILE *F, ir_loop *loop) {
2268 /* dump this loop node */
2269 dump_loop_node(F, loop);
2271 /* dump edges to nodes in loop -- only if it is a real loop */
2272 if (get_loop_depth(loop) != 0) {
2273 for (i = 0; i < get_loop_n_nodes(loop); i++) {
2274 dump_loop_node_edge(F, loop, i);
2277 for (i = 0; i < get_loop_n_sons(loop); i++) {
2278 dump_loops(F, get_loop_son(loop, i));
2279 dump_loop_son_edge(F, loop, i);
2284 void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg) {
2285 ir_graph *rem = current_ir_graph;
2286 current_ir_graph = irg;
2288 if (get_irg_loop(irg)) dump_loops(F, get_irg_loop(irg));
2290 current_ir_graph = rem;
2295 * dumps the VCG header
2297 void dump_vcg_header(FILE *F, const char *name, const char *layout, const char *orientation) {
2303 label = edge_label ? "yes" : "no";
2304 if (! layout) layout = "Compilergraph";
2305 if (!orientation) orientation = "bottom_to_top";
2309 "graph: { title: \"ir graph of %s\"\n"
2310 "display_edge_labels: %s\n"
2311 "layoutalgorithm: mindepth //$ \"%s\"\n"
2312 "manhattan_edges: yes\n"
2313 "port_sharing: no\n"
2315 "classname 1: \"intrablock Data\"\n"
2316 "classname 2: \"Block\"\n"
2317 "classname 3: \"Entity type\"\n"
2318 "classname 4: \"Entity owner\"\n"
2319 "classname 5: \"Method Param\"\n"
2320 "classname 6: \"Method Res\"\n"
2321 "classname 7: \"Super\"\n"
2322 "classname 8: \"Union\"\n"
2323 "classname 9: \"Points-to\"\n"
2324 "classname 10: \"Array Element Type\"\n"
2325 "classname 11: \"Overwrites\"\n"
2326 "classname 12: \"Member\"\n"
2327 "classname 13: \"Control Flow\"\n"
2328 "classname 14: \"intrablock Memory\"\n"
2329 "classname 15: \"Dominators\"\n"
2330 "classname 16: \"interblock Data\"\n"
2331 "classname 17: \"interblock Memory\"\n"
2332 "classname 18: \"Exception Control Flow for Interval Analysis\"\n"
2333 "classname 19: \"Postdominators\"\n"
2334 "classname 20: \"Keep Alive\"\n"
2335 "classname 21: \"Out Edges\"\n"
2336 "classname 22: \"Macro Block Edges\"\n"
2337 "infoname 1: \"Attribute\"\n"
2338 "infoname 2: \"Verification errors\"\n"
2339 "infoname 3: \"Debug info\"\n",
2340 name, label, layout, orientation);
2342 for (i = 0; i < ird_color_count; ++i) {
2343 if (color_rgb[i] != NULL) {
2344 fprintf(F, "colorentry %s: %s\n", color_names[i], color_rgb[i]);
2347 fprintf(F, "\n"); /* a separator */
2353 * @param irg The graph to be dumped
2354 * @param suffix1 first filename suffix
2355 * @param suffix2 second filename suffix
2357 FILE *vcg_open(ir_graph *irg, const char * suffix1, const char *suffix2) {
2359 const char *nm = get_irg_dump_name(irg);
2360 int len = strlen(nm), i, j;
2361 char *fname; /* filename to put the vcg information in */
2363 if (!suffix1) suffix1 = "";
2364 if (!suffix2) suffix2 = "";
2366 /* open file for vcg graph */
2367 fname = xmalloc (len * 2 + strlen(suffix1) + strlen(suffix2) + 5);
2369 /* strncpy (fname, nm, len); */ /* copy the filename */
2371 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2373 fname[j] = '@'; j++; fname[j] = '1'; j++;
2374 } else if (nm[i] == '@') {
2375 fname[j] = '@'; j++; fname[j] = '2'; j++;
2377 fname[j] = nm[i]; j++;
2381 strcat(fname, suffix1); /* append file suffix */
2382 strcat(fname, suffix2); /* append file suffix */
2383 strcat(fname, ".vcg"); /* append the .vcg suffix */
2385 /* vcg really expect only a <CR> at end of line, so
2386 * the "b"inary mode is what you mean (and even needed for Win32)
2388 F = fopen(fname, "wb"); /* open file for writing */
2400 * @param name prefix file name
2401 * @param suffix filename suffix
2403 FILE *vcg_open_name(const char *name, const char *suffix) {
2405 char *fname; /* filename to put the vcg information in */
2406 int i, j, len = strlen(name);
2408 if (!suffix) suffix = "";
2410 /** open file for vcg graph */
2411 fname = xmalloc(len * 2 + 5 + strlen(suffix));
2412 /* strcpy (fname, name);*/ /* copy the filename */
2414 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2415 if (name[i] == '/') {
2416 fname[j] = '@'; j++; fname[j] = '1'; j++;
2417 } else if (name[i] == '@') {
2418 fname[j] = '@'; j++; fname[j] = '2'; j++;
2420 fname[j] = name[i]; j++;
2424 strcat(fname, suffix);
2425 strcat(fname, ".vcg"); /* append the .vcg suffix */
2427 /* vcg really expect only a <CR> at end of line, so
2428 * the "b"inary mode is what you mean (and even needed for Win32)
2430 F = fopen(fname, "wb"); /* open file for writing */
2440 * Dumps the vcg file footer
2442 void dump_vcg_footer(FILE *F) {
2446 /************************************************************************/
2447 /************************************************************************/
2448 /* Routines that dump all or parts of the firm representation to a file */
2449 /************************************************************************/
2450 /************************************************************************/
2452 /************************************************************************/
2453 /* Dump ir graphs, different formats and additional information. */
2454 /************************************************************************/
2456 typedef void (*do_dump_graph_func) (ir_graph *irg, FILE *out);
2458 static void do_dump(ir_graph *irg, const char *suffix, const char *suffix_ip,
2459 const char *suffix_nonip, do_dump_graph_func dump_func)
2463 const char *suffix1;
2465 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2468 rem = current_ir_graph;
2469 current_ir_graph = irg;
2470 if (get_interprocedural_view())
2471 suffix1 = suffix_ip;
2473 suffix1 = suffix_nonip;
2474 current_ir_graph = rem;
2476 out = vcg_open(irg, suffix, suffix1);
2478 dump_func(irg, out);
2483 void dump_ir_graph_file(ir_graph *irg, FILE *out)
2485 if (dump_backedge_information_flag
2486 && get_irg_loopinfo_state(irg) != loopinfo_consistent) {
2487 construct_backedges(irg);
2490 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2492 /* call the dump graph hook */
2493 if (dump_ir_graph_hook) {
2494 if (dump_ir_graph_hook(out, irg)) {
2499 /* walk over the graph */
2500 /* dump_whole_node must be called in post visiting predecessors */
2501 ird_walk_graph(irg, NULL, dump_whole_node, out);
2503 /* dump the out edges in a separate walk */
2504 if ((dump_out_edge_flag) && (get_irg_outs_state(irg) != outs_none)) {
2505 irg_out_walk(get_irg_start(irg), dump_out_edge, NULL, out);
2508 dump_vcg_footer(out);
2511 /** Routine to dump a graph, blocks as conventional nodes. */
2512 void dump_ir_graph(ir_graph *irg, const char *suffix )
2514 do_dump(irg, suffix, "-pure-ip", "-pure", dump_ir_graph_file);
2517 void dump_ir_block_graph_file(ir_graph *irg, FILE *out)
2521 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2523 construct_block_lists(irg);
2526 * If we are in the interprocedural view, we dump not
2527 * only the requested irg but also all irgs that can be reached
2530 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2531 ir_graph *g = get_irp_irg(i);
2532 ir_node **arr = ird_get_irg_link(g);
2534 dump_graph_from_list(out, g);
2539 dump_vcg_footer(out);
2542 /* Dump a firm graph without explicit block nodes. */
2543 void dump_ir_block_graph(ir_graph *irg, const char *suffix)
2545 do_dump(irg, suffix, "-ip", "", dump_ir_block_graph_file);
2548 void dump_ir_extblock_graph_file(ir_graph *irg, FILE *F)
2551 ir_entity *ent = get_irg_entity(irg);
2553 if (get_irg_extblk_state(irg) != extblk_valid)
2556 dump_vcg_header(F, get_irg_dump_name(irg), NULL, NULL);
2558 construct_extblock_lists(irg);
2560 fprintf(F, "graph: { title: \"");
2562 fprintf(F, "\" label: \"%s\" status:clustered color: white \n",
2563 get_ent_dump_name(ent));
2565 dump_graph_info(F, irg);
2566 print_dbg_info(F, get_entity_dbg_info(ent));
2568 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2569 ir_graph *irg = get_irp_irg(i);
2570 list_tuple *lists = ird_get_irg_link(irg);
2573 /* dump the extended blocks first */
2574 if (ARR_LEN(lists->extbb_list)) {
2575 ird_set_irg_link(irg, lists->extbb_list);
2576 dump_extblock_graph(F, irg);
2579 /* we may have blocks without extended blocks, bad for instance */
2580 if (ARR_LEN(lists->blk_list)) {
2581 ird_set_irg_link(irg, lists->blk_list);
2582 dump_block_graph(F, irg);
2585 DEL_ARR_F(lists->extbb_list);
2586 DEL_ARR_F(lists->blk_list);
2591 /* Close the vcg information for the irg */
2592 fprintf(F, "}\n\n");
2598 /* Dump a firm graph without explicit block nodes but grouped in extended blocks. */
2599 void dump_ir_extblock_graph(ir_graph *irg, const char *suffix)
2601 do_dump(irg, suffix, "-ip", "", dump_ir_extblock_graph_file);
2604 void dump_ir_graph_w_types_file(ir_graph *irg, FILE *out)
2606 ir_graph *rem = current_ir_graph;
2607 int rem_dump_const_local;
2609 rem = current_ir_graph;
2610 current_ir_graph = irg;
2611 rem_dump_const_local = dump_const_local;
2612 /* dumping types does not work with local nodes */
2613 dump_const_local = 0;
2615 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2617 /* dump common ir graph */
2618 irg_walk(get_irg_end(irg), NULL, dump_whole_node, out);
2619 /* dump type info */
2620 type_walk_irg(irg, dump_type_info, NULL, out);
2621 inc_irg_visited(get_const_code_irg());
2622 /* dump edges from graph to type info */
2623 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2625 dump_vcg_footer(out);
2626 dump_const_local = rem_dump_const_local;
2627 current_ir_graph = rem;
2630 /* dumps a graph with type information */
2631 void dump_ir_graph_w_types(ir_graph *irg, const char *suffix)
2633 do_dump(irg, suffix, "-pure-wtypes-ip", "-pure-wtypes",
2634 dump_ir_graph_w_types_file);
2637 void dump_ir_block_graph_w_types_file(ir_graph *irg, FILE *out)
2640 int rem_dump_const_local;
2641 ir_graph *rem = current_ir_graph;
2643 rem_dump_const_local = dump_const_local;
2644 /* dumping types does not work with local nodes */
2645 dump_const_local = 0;
2647 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2649 /* dump common blocked ir graph */
2650 construct_block_lists(irg);
2652 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2653 ir_node **arr = ird_get_irg_link(get_irp_irg(i));
2655 dump_graph_from_list(out, get_irp_irg(i));
2660 /* dump type info */
2661 current_ir_graph = irg;
2662 type_walk_irg(irg, dump_type_info, NULL, out);
2663 inc_irg_visited(get_const_code_irg());
2665 /* dump edges from graph to type info */
2666 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2668 dump_vcg_footer(out);
2669 dump_const_local = rem_dump_const_local;
2670 current_ir_graph = rem;
2673 void dump_ir_block_graph_w_types(ir_graph *irg, const char *suffix)
2675 do_dump(irg, suffix, "-wtypes-ip", "-wtypes",
2676 dump_ir_block_graph_w_types_file);
2679 /*---------------------------------------------------------------------*/
2680 /* The following routines dump a control flow graph. */
2681 /*---------------------------------------------------------------------*/
2684 dump_block_to_cfg(ir_node *block, void *env) {
2689 if (is_Block(block)) {
2690 /* This is a block. Dump a node for the block. */
2691 fprintf(F, "node: {title: \""); PRINT_NODEID(block);
2692 fprintf(F, "\" label: \"");
2693 if (block == get_irg_start_block(get_irn_irg(block)))
2694 fprintf(F, "Start ");
2695 if (block == get_irg_end_block(get_irn_irg(block)))
2698 fprintf(F, "%s ", get_op_name(get_irn_op(block)));
2699 PRINT_NODEID(block);
2701 fprintf(F, "info1:\"");
2703 /* the generic version. */
2704 dump_irnode_to_file(F, block);
2706 /* Check whether we have bad predecessors to color the block. */
2707 for (i = 0; i < get_Block_n_cfgpreds(block); ++i)
2708 if ((fl = is_Bad(get_Block_cfgpred(block, i))))
2711 fprintf(F, "\""); /* closing quote of info */
2713 if ((block == get_irg_start_block(get_irn_irg(block))) ||
2714 (block == get_irg_end_block(get_irn_irg(block))) )
2715 fprintf(F, " color:blue ");
2717 fprintf(F, " color:yellow ");
2720 /* Dump the edges */
2721 for ( i = 0; i < get_Block_n_cfgpreds(block); i++)
2722 if (get_irn_op(skip_Proj(get_Block_cfgpred(block, i))) != op_Bad) {
2723 pred = get_nodes_block(skip_Proj(get_Block_cfgpred(block, i)));
2724 fprintf(F, "edge: { sourcename: \"");
2725 PRINT_NODEID(block);
2726 fprintf(F, "\" targetname: \"");
2728 fprintf(F, "\"}\n");
2731 /* Dump dominator/postdominator edge */
2732 if (dump_dominator_information_flag) {
2733 if (get_irg_dom_state(current_ir_graph) == dom_consistent && get_Block_idom(block)) {
2734 pred = get_Block_idom(block);
2735 fprintf(F, "edge: { sourcename: \"");
2736 PRINT_NODEID(block);
2737 fprintf(F, "\" targetname: \"");
2739 fprintf(F, "\" " DOMINATOR_EDGE_ATTR "}\n");
2741 if (get_irg_postdom_state(current_ir_graph) == dom_consistent && get_Block_ipostdom(block)) {
2742 pred = get_Block_ipostdom(block);
2743 fprintf(F, "edge: { sourcename: \"");
2744 PRINT_NODEID(block);
2745 fprintf(F, "\" targetname: \"");
2747 fprintf(F, "\" " POSTDOMINATOR_EDGE_ATTR "}\n");
2753 void dump_cfg(ir_graph *irg, const char *suffix)
2756 /* if a filter is set, dump only the irg's that match the filter */
2757 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2760 f = vcg_open(irg, suffix, "-cfg");
2762 ir_graph *rem = current_ir_graph;
2763 #ifdef INTERPROCEDURAL_VIEW
2764 int ipv = get_interprocedural_view();
2767 current_ir_graph = irg;
2768 dump_vcg_header(f, get_irg_dump_name(irg), NULL, NULL);
2770 #ifdef INTERPROCEDURAL_VIEW
2772 printf("Warning: dumping cfg not in interprocedural view!\n");
2773 set_interprocedural_view(0);
2777 /* walk over the blocks in the graph */
2778 irg_block_walk(get_irg_end(irg), dump_block_to_cfg, NULL, f);
2779 dump_node(f, get_irg_bad(irg));
2781 #ifdef INTERPROCEDURAL_VIEW
2782 set_interprocedural_view(ipv);
2786 current_ir_graph = rem;
2791 static void descend_and_dump(FILE *F, ir_node *n, int depth, pset *mark_set) {
2792 if (pset_find_ptr(mark_set, n)) return;
2794 pset_insert_ptr(mark_set, n);
2797 int i, start = is_Block(n) ? 0 : -1;
2798 dump_whole_node(n, F);
2799 for (i = start; i < get_irn_arity(n); ++i)
2800 descend_and_dump(F, get_irn_n(n, i), depth-1, mark_set);
2803 /* Don't dump edges to nodes further out. These might be edges to
2804 nodes we already dumped, if there is a shorter path to these. */
2808 static int subgraph_counter = 0;
2809 void dump_subgraph(ir_node *root, int depth, const char *suffix) {
2813 sprintf(buf, "-subg_%03d", subgraph_counter++);
2814 F = vcg_open(get_irn_irg(root), suffix, buf);
2816 pset *mark_set = pset_new_ptr(1);
2817 dump_vcg_header(F, get_irg_dump_name(get_irn_irg(root)), NULL, NULL);
2818 descend_and_dump(F, root, depth, mark_set);
2825 #ifdef INTERPROCEDURAL_VIEW
2826 void dump_callgraph(const char *suffix) {
2827 FILE *F = vcg_open_name("Callgraph", suffix);
2830 int i, rem = edge_label;
2833 dump_vcg_header(F, "Callgraph", NULL);
2835 //colorize = get_irp_callgraph_state() == irp_callgraph_and_calltree_consistent;
2837 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2838 ir_graph *irg = get_irp_irg(i);
2839 ir_entity *ent = get_irg_entity(irg);
2841 //int n_callees = get_irg_n_callees(irg);
2844 //color = colorize ? get_entity_color(ent) : ird_color_green;
2845 color = ird_color_green;
2846 dump_entity_node(F, ent, color);
2847 for (j = 0; j < n_callees; ++j) {
2848 ir_entity *c = get_irg_entity(get_irg_callee(irg, j));
2849 //if (id_is_prefix(prefix, get_entity_ld_ident(c))) continue;
2850 int be = is_irg_callee_backedge(irg, j);
2853 "label:\"recursion %d\" color:%d" :
2854 "label:\"calls %d\" color:%d";
2855 print_ent_ent_edge(F, ent, c, be, attr, get_irg_callee_loop_depth(irg, j), color);
2865 /* Dump all irgs in interprocedural view to a single file. */
2866 void dump_all_cg_block_graph(const char *suffix) {
2867 FILE *f = vcg_open_name("All_graphs", suffix);
2871 int rem_view = get_interprocedural_view();
2873 set_interprocedural_view(1);
2874 dump_vcg_header(f, "All_graphs", NULL);
2876 /* collect nodes in all irgs reachable in call graph*/
2877 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2878 ird_set_irg_link(get_irp_irg(i), NULL);
2880 cg_walk(clear_link, collect_node, NULL);
2882 /* dump all graphs */
2883 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2884 current_ir_graph = get_irp_irg(i);
2885 assert(ird_get_irg_link(current_ir_graph));
2886 dump_graph_from_list(f, current_ir_graph);
2887 DEL_ARR_F(ird_get_irg_link(current_ir_graph));
2892 set_interprocedural_view(rem_view);
2897 /*---------------------------------------------------------------------*/
2898 /* the following routines dumps type information without any ir nodes. */
2899 /*---------------------------------------------------------------------*/
2902 dump_type_graph(ir_graph *irg, const char *suffix)
2906 /* if a filter is set, dump only the irg's that match the filter */
2907 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
2909 f = vcg_open(irg, suffix, "-type");
2911 ir_graph *rem = current_ir_graph;
2912 current_ir_graph = irg;
2914 dump_vcg_header(f, get_irg_dump_name(irg), "Hierarchic", NULL);
2916 /* walk over the blocks in the graph */
2917 type_walk_irg(irg, dump_type_info, NULL, f);
2918 /* The walker for the const code can be called several times for the
2919 same (sub) expression. So that no nodes are dumped several times
2920 we decrease the visited flag of the corresponding graph after each
2921 walk. So now increase it finally. */
2922 inc_irg_visited(get_const_code_irg());
2926 current_ir_graph = rem;
2931 dump_all_types(const char *suffix)
2933 FILE *f = vcg_open_name("All_types", suffix);
2935 dump_vcg_header(f, "All_types", "Hierarchic", NULL);
2936 type_walk(dump_type_info, NULL, f);
2937 inc_irg_visited(get_const_code_irg());
2945 dump_class_hierarchy(int entities, const char *suffix)
2947 FILE *f = vcg_open_name("class_hierarchy", suffix);
2952 env.dump_ent = entities;
2953 dump_vcg_header(f, "class_hierarchy", "Hierarchic", NULL);
2954 type_walk(dump_class_hierarchy_node, NULL, &env);
2961 /*---------------------------------------------------------------------*/
2962 /* dumps all graphs with the graph-dumper passed. Possible dumpers: */
2964 /* dump_ir_block_graph */
2966 /* dump_type_graph */
2967 /* dump_ir_graph_w_types */
2968 /*---------------------------------------------------------------------*/
2970 void dump_all_ir_graphs(dump_graph_func *dmp_grph, const char *suffix) {
2972 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2973 dmp_grph(get_irp_irg(i), suffix);
2977 /*--------------------------------------------------------------------------------*
2978 * Dumps a stand alone loop graph with firm nodes which belong to one loop node *
2979 * packed together in one subgraph/box *
2980 *--------------------------------------------------------------------------------*/
2982 void dump_loops_standalone(FILE *F, ir_loop *loop) {
2983 int i = 0, loop_node_started = 0, son_number = 0, first = 0;
2985 ir_loop *son = NULL;
2987 /* Dump a new loop node. */
2988 dump_loop_node(F, loop);
2990 /* Dump the loop elements. */
2991 for (i = 0; i < get_loop_n_elements(loop); i++) {
2992 le = get_loop_element(loop, i);
2994 if (get_kind(son) == k_ir_loop) {
2996 /* We are a loop son -> Recurse */
2998 if (loop_node_started) { /* Close the "firm-nodes" node first if we started one. */
2999 fprintf(F, "\" }\n");
3000 fprintf(F, "edge: {sourcename: \"");
3002 fprintf(F, "\" targetname: \"");
3004 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3005 loop_node_started = 0;
3007 dump_loop_son_edge(F, loop, son_number++);
3008 dump_loops_standalone(F, son);
3009 } else if (get_kind(son) == k_ir_node) {
3010 /* We are a loop node -> Collect firm nodes */
3012 ir_node *n = le.node;
3015 if (!loop_node_started) {
3016 /* Start a new node which contains all firm nodes of the current loop */
3017 fprintf(F, "node: { title: \"");
3019 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3020 loop_node_started = 1;
3025 bad |= dump_node_label(F, n);
3026 /* Causes indeterministic output: if (is_Block(n)) fprintf(F, "\t ->%d", (int)get_irn_link(n)); */
3027 if (has_backedges(n)) fprintf(F, "\t loop head!");
3028 } else { /* for callgraph loop tree */
3030 assert(get_kind(son) == k_ir_graph);
3032 /* We are a loop node -> Collect firm graphs */
3034 if (!loop_node_started) {
3035 /* Start a new node which contains all firm nodes of the current loop */
3036 fprintf(F, "node: { title: \"");
3038 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3039 loop_node_started = 1;
3043 fprintf(F, " %s", get_irg_dump_name(n));
3044 /* fprintf(F, " %s (depth %d)", get_irg_dump_name(n), n->callgraph_weighted_loop_depth); */
3048 if (loop_node_started) {
3049 fprintf(F, "\" }\n");
3050 fprintf(F, "edge: {sourcename: \"");
3052 fprintf(F, "\" targetname: \"");
3054 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3055 loop_node_started = 0;
3059 void dump_loop_tree(ir_graph *irg, const char *suffix)
3063 /* if a filter is set, dump only the irg's that match the filter */
3064 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
3066 f = vcg_open(irg, suffix, "-looptree");
3068 ir_graph *rem = current_ir_graph;
3069 int el_rem = edge_label;
3071 current_ir_graph = irg;
3074 dump_vcg_header(f, get_irg_dump_name(irg), "Tree", "top_to_bottom");
3076 if (get_irg_loop(irg))
3077 dump_loops_standalone(f, get_irg_loop(irg));
3082 edge_label = el_rem;
3083 current_ir_graph = rem;
3087 void dump_callgraph_loop_tree(const char *suffix) {
3089 F = vcg_open_name("Callgraph_looptree", suffix);
3090 dump_vcg_header(F, "callgraph looptree", "Tree", "top_to_bottom");
3091 dump_loops_standalone(F, irp->outermost_cg_loop);
3097 /*----------------------------------------------------------------------------*/
3098 /* Dumps the firm nodes in the loop tree to a graph along with the loop nodes.*/
3099 /*----------------------------------------------------------------------------*/
3101 void collect_nodeloop(FILE *F, ir_loop *loop, eset *loopnodes) {
3102 int i, son_number = 0, node_number = 0;
3104 if (dump_loop_information_flag) dump_loop_node(F, loop);
3106 for (i = 0; i < get_loop_n_elements(loop); i++) {
3107 loop_element le = get_loop_element(loop, i);
3108 if (*(le.kind) == k_ir_loop) {
3109 if (dump_loop_information_flag) dump_loop_son_edge(F, loop, son_number++);
3111 collect_nodeloop(F, le.son, loopnodes);
3113 if (dump_loop_information_flag) dump_loop_node_edge(F, loop, node_number++);
3114 eset_insert(loopnodes, le.node);
3119 void collect_nodeloop_external_nodes(ir_loop *loop, eset *loopnodes, eset *extnodes) {
3122 for(i = 0; i < get_loop_n_elements(loop); i++) {
3123 loop_element le = get_loop_element(loop, i);
3124 if (*(le.kind) == k_ir_loop) {
3126 collect_nodeloop_external_nodes(le.son, loopnodes, extnodes);
3128 if (is_Block(le.node)) start = 0; else start = -1;
3129 for (j = start; j < get_irn_arity(le.node); j++) {
3130 ir_node *pred = get_irn_n(le.node, j);
3131 if (!eset_contains(loopnodes, pred)) {
3132 eset_insert(extnodes, pred);
3133 if (!is_Block(pred)) {
3134 pred = get_nodes_block(pred);
3135 if (!eset_contains(loopnodes, pred)) eset_insert(extnodes, pred);
3143 void dump_loop(ir_loop *l, const char *suffix) {
3147 snprintf(name, sizeof(name), "loop_%d", get_loop_loop_nr(l));
3148 F = vcg_open_name(name, suffix);
3150 eset *loopnodes = eset_create();
3151 eset *extnodes = eset_create();
3154 dump_vcg_header(F, name, NULL, NULL);
3156 /* collect all nodes to dump */
3157 collect_nodeloop(F, l, loopnodes);
3158 collect_nodeloop_external_nodes(l, loopnodes, extnodes);
3160 /* build block lists */
3161 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes))
3162 set_irn_link(n, NULL);
3163 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes))
3164 set_irn_link(n, NULL);
3165 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes)) {
3167 b = get_nodes_block(n);
3168 set_irn_link(n, get_irn_link(b));
3172 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes)) {
3174 b = get_nodes_block(n);
3175 set_irn_link(n, get_irn_link(b));
3180 for (b = eset_first(loopnodes); b != NULL; b = eset_next(loopnodes)) {
3182 fprintf(F, "graph: { title: \"");
3184 fprintf(F, "\" label: \"");
3185 dump_node_opcode(F, b);
3186 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3187 fprintf(F, "\" status:clustered color:yellow\n");
3189 /* dump the blocks edges */
3190 dump_ir_data_edges(F, b);
3192 /* dump the nodes that go into the block */
3193 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3194 if (eset_contains(extnodes, n))
3195 overrule_nodecolor = ird_color_block_inout;
3197 overrule_nodecolor = ird_color_default_node;
3198 if (!eset_contains(extnodes, n)) dump_ir_data_edges(F, n);
3201 /* Close the vcg information for the block */
3203 dump_const_node_local(F, b);
3207 for (b = eset_first(extnodes); b != NULL; b = eset_next(extnodes)) {
3209 fprintf(F, "graph: { title: \"");
3211 fprintf(F, "\" label: \"");
3212 dump_node_opcode(F, b);
3213 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3214 fprintf(F, "\" status:clustered color:lightblue\n");
3216 /* dump the nodes that go into the block */
3217 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3218 if (!eset_contains(loopnodes, n))
3219 overrule_nodecolor = ird_color_block_inout;
3221 overrule_nodecolor = ird_color_default_node;
3222 if (eset_contains(loopnodes, n)) dump_ir_data_edges(F, n);
3225 /* Close the vcg information for the block */
3227 dump_const_node_local(F, b);
3231 eset_destroy(loopnodes);
3232 eset_destroy(extnodes);