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
32 #include "firm_common_t.h"
37 #include "irgraph_t.h"
50 #include "callgraph.h"
51 #include "irextbb_t.h"
53 #include "dbginfo_t.h"
65 /** Dump only irgs with names that start with this prefix. */
66 static ident *dump_file_filter_id = NULL;
68 #define ERROR_TXT "<ERROR>"
70 /*******************************************************************/
71 /* flags to steer output */
72 /*******************************************************************/
74 /** An option to turn off edge labels */
75 static int edge_label = 1;
76 /** An option to turn off dumping values of constant entities */
77 static int const_entities = 1;
78 /** An option to dump the keep alive edges */
79 static int dump_keepalive = 1;
80 /** An option to dump the new out edges */
81 static int dump_new_edges_flag = 0;
82 /** An option to dump ld_names instead of names. */
83 static int dump_ld_name = 1;
84 /** Compiler options to dump analysis information in dump_ir_graph */
85 static int dump_out_edge_flag = 0;
86 static int dump_loop_information_flag = 0;
87 static int dump_backedge_information_flag = 1;
88 /** An option to dump const-like nodes locally. */
89 static int dump_const_local = 1;
90 /** An option to dump the node index number. */
91 static int dump_node_idx_labels = 0;
92 /** An option to dump all graph anchors */
93 static int dump_anchors = 0;
94 /** An option to dump the macro block edges. */
95 static int dump_macro_block_edges = 0;
96 /** An option to dump block marker in the block title */
97 static int dump_block_marker = 0;
99 int dump_dominator_information_flag = 0;
100 int opt_dump_analysed_type_info = 1;
101 int opt_dump_pointer_values_to_info = 0; /* default off: for test compares!! */
103 static ird_color_t overrule_nodecolor = ird_color_default_node;
105 /** The vcg node attribute hook. */
106 static DUMP_IR_GRAPH_FUNC dump_ir_graph_hook = NULL;
107 /** The vcg node attribute hook. */
108 static DUMP_NODE_VCGATTR_FUNC dump_node_vcgattr_hook = NULL;
109 /** The vcg edge attribute hook. */
110 static DUMP_EDGE_VCGATTR_FUNC dump_edge_vcgattr_hook = NULL;
111 /** The vcg dump block edge hook */
112 static DUMP_NODE_EDGE_FUNC dump_block_edge_hook = NULL;
113 /** The vcg dump node edge hook. */
114 static DUMP_NODE_EDGE_FUNC dump_node_edge_hook = NULL;
116 /* Set the hook to be called to dump additional edges to a node. */
117 void set_dump_node_edge_hook(DUMP_NODE_EDGE_FUNC func) {
118 dump_node_edge_hook = func;
121 /* Get the additional edge dump hook. */
122 DUMP_NODE_EDGE_FUNC get_dump_node_edge_hook(void) {
123 return dump_node_edge_hook;
126 /* Set the hook to be called to dump additional edges to a block. */
127 void set_dump_block_edge_hook(DUMP_NODE_EDGE_FUNC func) {
128 dump_block_edge_hook = func;
131 /* Get the additional block edge dump hook. */
132 DUMP_NODE_EDGE_FUNC get_dump_block_edge_hook(void) {
133 return dump_node_edge_hook;
136 /* set the ir graph hook */
137 void set_dump_ir_graph_hook(DUMP_IR_GRAPH_FUNC hook) {
138 dump_ir_graph_hook = hook;
141 /* set the node attribute hook */
142 void set_dump_node_vcgattr_hook(DUMP_NODE_VCGATTR_FUNC hook) {
143 dump_node_vcgattr_hook = hook;
146 /* set the edge attribute hook */
147 void set_dump_edge_vcgattr_hook(DUMP_EDGE_VCGATTR_FUNC hook) {
148 dump_edge_vcgattr_hook = hook;
151 /** Returns 0 if dump_out_edge_flag or dump_loop_information_flag
152 * are set, else returns dump_const_local_flag.
154 static int get_opt_dump_const_local(void) {
155 if (dump_out_edge_flag || dump_loop_information_flag || (dump_new_edges_flag && edges_activated(current_ir_graph)))
157 return dump_const_local;
160 /* Set a prefix filter for output functions. */
161 void only_dump_method_with_name(ident *name) {
162 dump_file_filter_id = name;
165 /* Returns the prefix filter set with only_dump_method_with_name(). */
166 ident *get_dump_file_filter_ident(void) {
167 return dump_file_filter_id;
170 /* Returns non-zero if dump file filter is not set, or if it is a prefix of name. */
171 int is_filtered_dump_name(ident *name) {
172 if (!dump_file_filter_id) return 1;
173 return id_is_prefix(dump_file_filter_id, name);
176 /* To turn off display of edge labels. Edge labels often cause xvcg to
177 abort with a segmentation fault. */
178 void turn_off_edge_labels(void) {
182 void dump_consts_local(int flag) {
183 dump_const_local = flag;
186 void dump_node_idx_label(int flag) {
187 dump_node_idx_labels = flag;
190 void dump_constant_entity_values(int flag) {
191 const_entities = flag;
194 void dump_keepalive_edges(int flag) {
195 dump_keepalive = flag;
198 void dump_new_edges(int flag) {
199 dump_new_edges_flag = flag;
202 int get_opt_dump_keepalive_edges(void) {
203 return dump_keepalive;
206 void dump_out_edges(int flag) {
207 dump_out_edge_flag = flag;
210 void dump_dominator_information(int flag) {
211 dump_dominator_information_flag = flag;
214 void dump_loop_information(int flag) {
215 dump_loop_information_flag = flag;
218 void dump_backedge_information(int flag) {
219 dump_backedge_information_flag = flag;
222 /* Dump the information of type field specified in ana/irtypeinfo.h.
223 * If the flag is set, the type name is output in [] in the node label,
224 * else it is output as info.
226 void set_opt_dump_analysed_type_info(int flag) {
227 opt_dump_analysed_type_info = flag;
230 void dump_pointer_values_to_info(int flag) {
231 opt_dump_pointer_values_to_info = flag;
234 void dump_ld_names(int flag) {
238 void dump_all_anchors(int flag) {
242 void dump_macroblock_edges(int flag) {
243 dump_macro_block_edges = flag;
246 void dump_block_marker_in_title(int flag) {
247 dump_block_marker = flag;
250 /* -------------- some extended helper functions ----------------- */
253 * returns the name of a mode or ERROR_TXT if mode is NOT a mode object.
254 * in the later case, sets bad.
256 const char *get_mode_name_ex(ir_mode *mode, int *bad) {
258 return get_mode_name(mode);
264 * returns the name of a type or <ERROR> if mode is NOT a mode object.
265 * in the later case, sets bad
267 const char *get_type_name_ex(ir_type *tp, int *bad) {
269 return get_type_name(tp);
274 #define CUSTOM_COLOR_BASE 100
275 static const char *color_names[ird_color_count];
276 static const char *color_rgb[ird_color_count];
277 static struct obstack color_obst;
279 static void custom_color(int num, const char *rgb_def)
281 assert(num < ird_color_count);
282 obstack_printf(&color_obst, "%d", CUSTOM_COLOR_BASE + num);
283 obstack_1grow(&color_obst, '\0');
285 color_rgb[num] = rgb_def;
286 color_names[num] = obstack_finish(&color_obst);
289 static void named_color(int num, const char *name)
291 assert(num < ird_color_count);
292 color_rgb[num] = NULL;
293 color_names[num] = name;
296 static void init_colors(void)
298 static int initialized = 0;
302 obstack_init(&color_obst);
304 custom_color(ird_color_prog_background, "204 204 204");
305 custom_color(ird_color_block_background, "255 255 0");
306 custom_color(ird_color_dead_block_background, "190 150 150");
307 named_color(ird_color_block_inout, "lightblue");
308 named_color(ird_color_default_node, "white");
309 custom_color(ird_color_memory, "153 153 255");
310 custom_color(ird_color_controlflow, "255 153 153");
311 custom_color(ird_color_const, "204 255 255");
312 custom_color(ird_color_proj, "255 255 153");
313 custom_color(ird_color_uses_memory, "153 153 255");
314 custom_color(ird_color_phi, "105 255 105");
315 custom_color(ird_color_anchor, "100 100 255");
316 named_color(ird_color_error, "red");
317 custom_color(ird_color_entity, "204 204 255");
323 * Prints the VCG color to a file.
325 static void print_vcg_color(FILE *F, ird_color_t color) {
326 assert(color < ird_color_count);
327 fprintf(F, "color:%s", color_names[color]);
331 * Prints the edge from a type S to a type T with additional info fmt, ...
334 static void print_type_type_edge(FILE *F, ir_type *S, ir_type *T, const char *fmt, ...)
339 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(S);
340 fprintf(F, " targetname: "); PRINT_TYPEID(T);
341 vfprintf(F, fmt, ap);
347 * Prints the edge from a type T to an entity E with additional info fmt, ...
350 static void print_type_ent_edge(FILE *F, ir_type *T, ir_entity *E, const char *fmt, ...)
355 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(T);
356 fprintf(F, " targetname: \""); PRINT_ENTID(E); fprintf(F, "\"");
357 vfprintf(F, fmt, ap);
363 * Prints the edge from an entity E to an entity T with additional info fmt, ...
366 static void print_ent_ent_edge(FILE *F, ir_entity *E, ir_entity *T, int backedge, ird_color_t color, const char *fmt, ...)
372 fprintf(F, "backedge: { sourcename: \"");
374 fprintf(F, "edge: { sourcename: \"");
376 fprintf(F, "\" targetname: \""); PRINT_ENTID(T); fprintf(F, "\"");
377 vfprintf(F, fmt, ap);
379 if (color != (ird_color_t) -1)
380 print_vcg_color(F, color);
386 * Prints the edge from an entity E to a type T with additional info fmt, ...
389 static void print_ent_type_edge(FILE *F, ir_entity *E, ir_type *T, const char *fmt, ...)
394 fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(E);
395 fprintf(F, "\" targetname: "); PRINT_TYPEID(T);
396 vfprintf(F, fmt, ap);
402 * Prints the edge from a node N to a type T with additional info fmt, ...
405 static void print_node_type_edge(FILE *F, const ir_node *N, ir_type *T, const char *fmt, ...)
410 fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(N);
411 fprintf(F, "\" targetname: "); PRINT_TYPEID(T);
412 vfprintf(F, fmt, ap);
418 * Prints the edge from a node N to an entity E with additional info fmt, ...
421 static void print_node_ent_edge(FILE *F, const ir_node *N, ir_entity *E, const char *fmt, ...)
426 fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(N);
427 fprintf(F, "\" targetname: \""); PRINT_ENTID(E);
429 vfprintf(F, fmt, ap);
435 * Prints the edge from an entity E to a node N with additional info fmt, ...
438 static void print_ent_node_edge(FILE *F, ir_entity *E, const ir_node *N, const char *fmt, ...)
443 fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(E);
444 fprintf(F, "\" targetname: \""); PRINT_NODEID(N); fprintf(F, "\"");
445 vfprintf(F, fmt, ap);
451 * Prints the edge from a type E to an enumeration item item with additional info fmt, ...
454 static void print_enum_item_edge(FILE *F, ir_type *E, int item, const char *fmt, ...)
459 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(E);
460 fprintf(F, " targetname: \""); PRINT_ITEMID(E, item); fprintf(F, "\" ");
461 vfprintf(F, fmt, ap);
466 /*-----------------------------------------------------------------*/
467 /* global and ahead declarations */
468 /*-----------------------------------------------------------------*/
470 static void dump_whole_node(ir_node *n, void *env);
471 static inline void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg);
473 /*-----------------------------------------------------------------*/
474 /* Helper functions. */
475 /*-----------------------------------------------------------------*/
478 * This map is used as a private link attr to be able to call dumper
479 * anywhere without destroying link fields.
481 static pmap *irdump_link_map = NULL;
483 /** NOT A STANDARD LIBFIRM INIT METHOD
485 * We do not want to integrate dumping into libfirm, i.e., if the dumpers
486 * are off, we want to have as few interferences as possible. Therefore the
487 * initialization is performed lazily and not called from within init_firm.
489 * Creates the link attribute map. */
490 static void init_irdump(void) {
491 /* We need a new, empty map. */
492 if (irdump_link_map) pmap_destroy(irdump_link_map);
493 irdump_link_map = pmap_create();
494 if (!dump_file_filter_id)
495 dump_file_filter_id = new_id_from_str("");
499 * Returns the private link field.
501 static void *ird_get_irn_link(ir_node *n) {
503 if (!irdump_link_map) return NULL;
505 if (pmap_contains(irdump_link_map, (void *)n))
506 res = pmap_get(irdump_link_map, (void *)n);
511 * Sets the private link field.
513 static void ird_set_irn_link(ir_node *n, void *x) {
514 if (!irdump_link_map)
516 pmap_insert(irdump_link_map, (void *)n, x);
520 * Gets the private link field of an irg.
522 static void *ird_get_irg_link(ir_graph *irg) {
524 if (!irdump_link_map) return NULL;
526 if (pmap_contains(irdump_link_map, (void *)irg))
527 res = pmap_get(irdump_link_map, (void *)irg);
532 * Sets the private link field of an irg.
534 static void ird_set_irg_link(ir_graph *irg, void *x) {
535 if (!irdump_link_map) init_irdump();
536 pmap_insert(irdump_link_map, (void *)irg, x);
540 * Walker, clears the private link field.
542 static void clear_link(ir_node * node, void * env) {
544 ird_set_irn_link(node, NULL);
548 * If the entity has a ld_name, returns it if the dump_ld_name is set,
549 * else returns the name of the entity.
551 static const char *_get_ent_dump_name(ir_entity *ent, int dump_ld_name) {
553 return "<NULL entity>";
555 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
556 if (ent->ld_name) return get_id_str(ent->ld_name);
558 return get_id_str(ent->name);
562 * If the entity has a ld_name, returns it if the option dump_ld_name is set,
563 * else returns the name of the entity.
565 const char *get_ent_dump_name(ir_entity *ent) {
566 return _get_ent_dump_name(ent, dump_ld_name);
569 /* Returns the name of an IRG. */
570 const char *get_irg_dump_name(ir_graph *irg) {
571 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
572 return _get_ent_dump_name(get_irg_entity(irg), 1);
576 * Returns non-zero if a node is in floating state.
578 static int node_floats(ir_node *n) {
579 return ((get_irn_pinned(n) == op_pin_state_floats) &&
580 (get_irg_pinned(current_ir_graph) == op_pin_state_floats));
584 * Walker that visits the anchors
586 static void ird_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env) {
587 if (dump_anchors || (dump_new_edges_flag && edges_activated(irg))) {
588 irg_walk_anchors(irg, pre, post, env);
590 irg_walk_graph(irg, pre, post, env);
595 * Walker, allocates an array for all blocks and puts it's nodes non-floating nodes into this array.
597 static void collect_node(ir_node * node, void *env) {
601 || (get_op_flags(get_irn_op(node)) & irop_flag_dump_noblock)) {
602 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
603 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
604 ARR_APP1(ir_node *, arr, node);
605 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
607 ir_node * block = get_nodes_block(node);
610 /* this node is in a Bad block, so we must place it into the graph's list */
611 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
612 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
613 ARR_APP1(ir_node *, arr, node);
614 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
616 ird_set_irn_link(node, ird_get_irn_link(block));
617 ird_set_irn_link(block, node);
622 /** Construct lists to walk ir block-wise.
624 * Collects all blocks, nodes not op_pin_state_pinned,
625 * Bad, NoMem and Unknown into a flexible array in link field of
626 * irg they belong to. Sets the irg link field to NULL in all
627 * graphs not visited.
628 * Free the list with DEL_ARR_F().
630 static ir_node **construct_block_lists(ir_graph *irg) {
632 #ifdef INTERPROCEDURAL_VIEW
633 int rem_view = get_interprocedural_view();
635 int walk_flag = ir_resources_reserved(irg) & IR_RESOURCE_IRN_VISITED;
636 ir_graph *rem = current_ir_graph;
638 current_ir_graph = irg;
641 ir_free_resources(irg, IR_RESOURCE_IRN_VISITED);
644 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
645 ird_set_irg_link(get_irp_irg(i), NULL);
647 ird_walk_graph(current_ir_graph, clear_link, collect_node, current_ir_graph);
649 #ifdef INTERPROCEDURAL_VIEW
650 /* Collect also EndReg and EndExcept. We do not want to change the walker. */
651 set_interprocedural_view(0);
654 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
655 irg_walk(get_irg_end_reg(current_ir_graph), clear_link, collect_node, current_ir_graph);
656 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
657 irg_walk(get_irg_end_except(current_ir_graph), clear_link, collect_node, current_ir_graph);
659 #ifdef INTERPROCEDURAL_VIEW
660 set_interprocedural_view(rem_view);
664 ir_reserve_resources(irg, IR_RESOURCE_IRN_VISITED);
667 current_ir_graph = rem;
668 return ird_get_irg_link(irg);
671 typedef struct _list_tuple {
673 ir_extblk **extbb_list;
676 /** Construct lists to walk IR extended block-wise.
677 * Free the lists in the tuple with DEL_ARR_F().
678 * Sets the irg link field to NULL in all
679 * graphs not visited.
681 static list_tuple *construct_extblock_lists(ir_graph *irg) {
682 ir_node **blk_list = construct_block_lists(irg);
684 ir_graph *rem = current_ir_graph;
685 list_tuple *lists = XMALLOC(list_tuple);
687 current_ir_graph = irg;
689 lists->blk_list = NEW_ARR_F(ir_node *, 0);
690 lists->extbb_list = NEW_ARR_F(ir_extblk *, 0);
692 inc_irg_block_visited(irg);
693 for (i = ARR_LEN(blk_list) - 1; i >= 0; --i) {
696 if (is_Block(blk_list[i])) {
697 ext = get_Block_extbb(blk_list[i]);
699 if (extbb_not_visited(ext)) {
700 ARR_APP1(ir_extblk *, lists->extbb_list, ext);
701 mark_extbb_visited(ext);
704 ARR_APP1(ir_node *, lists->blk_list, blk_list[i]);
708 current_ir_graph = rem;
709 ird_set_irg_link(irg, lists);
713 /*-----------------------------------------------------------------*/
714 /* Routines to dump information about a single ir node. */
715 /*-----------------------------------------------------------------*/
718 * dump the name of a node n to the File F.
720 int dump_node_opcode(FILE *F, ir_node *n)
723 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
725 /* call the dump_node operation if available */
727 return ops->dump_node(n, F, dump_node_opcode_txt);
729 /* implementation for default nodes */
730 switch (get_irn_opcode(n)) {
732 switch (get_SymConst_kind(n)) {
733 case symconst_addr_name:
734 /* don't use get_SymConst_ptr_info as it mangles the name. */
735 fprintf(F, "SymC %s", get_id_str(get_SymConst_name(n)));
737 case symconst_addr_ent:
738 fprintf(F, "SymC &%s", get_entity_name(get_SymConst_entity(n)));
740 case symconst_ofs_ent:
741 fprintf(F, "SymC %s offset", get_entity_name(get_SymConst_entity(n)));
743 case symconst_type_tag:
744 fprintf(F, "SymC %s tag", get_type_name_ex(get_SymConst_type(n), &bad));
746 case symconst_type_size:
747 fprintf(F, "SymC %s size", get_type_name_ex(get_SymConst_type(n), &bad));
749 case symconst_type_align:
750 fprintf(F, "SymC %s align", get_type_name_ex(get_SymConst_type(n), &bad));
752 case symconst_enum_const:
753 fprintf(F, "SymC %s enum", get_enumeration_name(get_SymConst_enum(n)));
756 fprintf(F, "SymC %lu label", get_SymConst_label(n));
762 if (!get_interprocedural_view())
769 ir_node *pred = get_Proj_pred(n);
771 if (get_irn_opcode(pred) == iro_Cond
772 && get_Proj_proj(n) == get_Cond_defaultProj(pred)
773 && get_irn_mode(get_Cond_selector(pred)) != mode_b)
774 fprintf(F, "defProj");
782 if (get_interprocedural_view()) {
783 fprintf(F, "%s %s", get_irn_opname(n), get_ent_dump_name(get_irg_entity(get_irn_irg(n))));
788 case iro_CallBegin: {
789 ir_node *addr = get_CallBegin_ptr(n);
790 ir_entity *ent = NULL;
792 ent = get_Sel_entity(addr);
793 else if (is_Global(addr))
794 ent = get_Global_entity(addr);
795 fprintf(F, "%s", get_irn_opname(n));
796 if (ent) fprintf(F, " %s", get_entity_name(ent));
800 if (get_Load_align(n) == align_non_aligned)
802 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Load_mode(n), &bad));
805 if (get_Store_align(n) == align_non_aligned)
807 fprintf(F, "%s", get_irn_opname(n));
811 is_Block_dead(n) ? "Dead " : "", get_irn_opname(n),
812 dump_block_marker ? (get_Block_mark(n) ? "*" : "") : "");
815 if (get_Conv_strict(n))
816 fprintf(F, "strict");
817 fprintf(F, "%s", get_irn_opname(n));
820 fprintf(F, "%s", get_irn_opname(n));
821 if (is_Div_remainderless(n))
823 fprintf(F, "[%s]", get_mode_name_ex(get_Div_resmode(n), &bad));
826 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Mod_resmode(n), &bad));
829 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_DivMod_resmode(n), &bad));
832 fprintf(F, "%s[%s]", get_irn_opname(n), get_builtin_kind_name(get_Builtin_kind(n)));
837 fprintf(F, "%s", get_irn_opname(n));
844 * Dump the mode of a node n to a file F.
845 * Ignore modes that are "always known".
847 static int dump_node_mode(FILE *F, ir_node *n)
850 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
853 /* call the dump_node operation if available */
855 return ops->dump_node(n, F, dump_node_mode_txt);
857 /* default implementation */
858 iro = get_irn_opcode(n);
870 ir_mode *mode = get_irn_mode(n);
872 if (mode && mode != mode_BB && mode != mode_ANY && mode != mode_BAD &&
873 (mode != mode_T || iro == iro_Proj))
874 fprintf(F, "%s", get_mode_name_ex(mode, &bad));
882 * Dump the type of a node n to a file F if it's known.
884 static int dump_node_typeinfo(FILE *F, ir_node *n) {
887 if (opt_dump_analysed_type_info) {
888 if (get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_consistent ||
889 get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_inconsistent) {
890 ir_type *tp = get_irn_typeinfo_type(n);
891 if (tp != firm_none_type)
892 fprintf(F, "[%s] ", get_type_name_ex(tp, &bad));
900 typedef struct _pns_lookup {
901 long nr; /**< the proj number */
902 const char *name; /**< the name of the Proj */
905 typedef struct _proj_lookup {
906 ir_opcode code; /**< the opcode of the Proj predecessor */
907 unsigned num_data; /**< number of data entries */
908 const pns_lookup_t *data; /**< the data */
911 #define ARR_SIZE(a) (sizeof(a)/sizeof(a[0]))
913 /** the lookup table for Proj(Start) names */
914 static const pns_lookup_t start_lut[] = {
915 #define X(a) { pn_Start_##a, #a }
924 /** the lookup table for Proj(Cond) names */
925 static const pns_lookup_t cond_lut[] = {
926 #define X(a) { pn_Cond_##a, #a }
932 /** the lookup table for Proj(Call) names */
933 static const pns_lookup_t call_lut[] = {
934 #define X(a) { pn_Call_##a, #a }
944 /** the lookup table for Proj(Quot) names */
945 static const pns_lookup_t quot_lut[] = {
946 #define X(a) { pn_Quot_##a, #a }
954 /** the lookup table for Proj(DivMod) names */
955 static const pns_lookup_t divmod_lut[] = {
956 #define X(a) { pn_DivMod_##a, #a }
965 /** the lookup table for Proj(Div) names */
966 static const pns_lookup_t div_lut[] = {
967 #define X(a) { pn_Div_##a, #a }
975 /** the lookup table for Proj(Mod) names */
976 static const pns_lookup_t mod_lut[] = {
977 #define X(a) { pn_Mod_##a, #a }
985 /** the lookup table for Proj(Load) names */
986 static const pns_lookup_t load_lut[] = {
987 #define X(a) { pn_Load_##a, #a }
995 /** the lookup table for Proj(Store) names */
996 static const pns_lookup_t store_lut[] = {
997 #define X(a) { pn_Store_##a, #a }
1004 /** the lookup table for Proj(Alloc) names */
1005 static const pns_lookup_t alloc_lut[] = {
1006 #define X(a) { pn_Alloc_##a, #a }
1014 /** the lookup table for Proj(CopyB) names */
1015 static const pns_lookup_t copyb_lut[] = {
1016 #define X(a) { pn_CopyB_##a, #a }
1024 /** the lookup table for Proj(InstOf) names */
1025 static const pns_lookup_t instof_lut[] = {
1026 #define X(a) { pn_InstOf_##a, #a }
1035 /** the lookup table for Proj(Raise) names */
1036 static const pns_lookup_t raise_lut[] = {
1037 #define X(a) { pn_Raise_##a, #a }
1043 /** the lookup table for Proj(Bound) names */
1044 static const pns_lookup_t bound_lut[] = {
1045 #define X(a) { pn_Bound_##a, #a }
1053 /** the Proj lookup table */
1054 static const proj_lookup_t proj_lut[] = {
1055 #define E(a) ARR_SIZE(a), a
1056 { iro_Start, E(start_lut) },
1057 { iro_Cond, E(cond_lut) },
1058 { iro_Call, E(call_lut) },
1059 { iro_Quot, E(quot_lut) },
1060 { iro_DivMod, E(divmod_lut) },
1061 { iro_Div, E(div_lut) },
1062 { iro_Mod, E(mod_lut) },
1063 { iro_Load, E(load_lut) },
1064 { iro_Store, E(store_lut) },
1065 { iro_Alloc, E(alloc_lut) },
1066 { iro_CopyB, E(copyb_lut) },
1067 { iro_InstOf, E(instof_lut) },
1068 { iro_Raise, E(raise_lut) },
1069 { iro_Bound, E(bound_lut) }
1074 * Dump additional node attributes of some nodes to a file F.
1077 dump_node_nodeattr(FILE *F, ir_node *n)
1083 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1085 /* call the dump_node operation if available */
1087 return ops->dump_node(n, F, dump_node_nodeattr_txt);
1089 switch (get_irn_opcode(n)) {
1091 if (0 && get_interprocedural_view()) {
1092 fprintf(F, "%s ", get_ent_dump_name(get_irg_entity(current_ir_graph)));
1097 ir_fprintf(F, "%T ", get_Const_tarval(n));
1101 pred = get_Proj_pred(n);
1102 proj_nr = get_Proj_proj(n);
1104 code = get_irn_opcode(pred);
1106 if (code == iro_Cmp)
1107 fprintf(F, "%s ", get_pnc_string(get_Proj_proj(n)));
1108 else if (code == iro_Proj && get_irn_opcode(get_Proj_pred(pred)) == iro_Start)
1109 fprintf(F, "Arg %ld ", proj_nr);
1110 else if (code == iro_Cond && get_irn_mode(get_Cond_selector(pred)) != mode_b)
1111 fprintf(F, "%ld ", proj_nr);
1113 unsigned i, j, f = 0;
1115 for (i = 0; i < ARR_SIZE(proj_lut); ++i) {
1116 if (code == proj_lut[i].code) {
1117 for (j = 0; j < proj_lut[i].num_data; ++j) {
1118 if (proj_nr == proj_lut[i].data[j].nr) {
1119 fprintf(F, "%s ", proj_lut[i].data[j].name);
1128 fprintf(F, "%ld ", proj_nr);
1129 if (code == iro_Cond && get_Cond_jmp_pred(pred) != COND_JMP_PRED_NONE) {
1130 if (proj_nr == pn_Cond_false && get_Cond_jmp_pred(pred) == COND_JMP_PRED_FALSE)
1131 fprintf(F, "PRED ");
1132 if (proj_nr == pn_Cond_true && get_Cond_jmp_pred(pred) == COND_JMP_PRED_TRUE)
1133 fprintf(F, "PRED ");
1138 proj_nr = get_Filter_proj(n);
1139 if (! get_interprocedural_view()) {
1141 pred = get_Filter_pred(n);
1144 fprintf(F, "%ld ", proj_nr);
1147 fprintf(F, "%s ", get_ent_dump_name(get_Sel_entity(n)));
1150 fprintf(F, "(%s) ", get_type_name_ex(get_Cast_type(n), &bad));
1153 fprintf(F, "%s ", get_pnc_string(get_Confirm_cmp(n)));
1156 fprintf(F, "(%s) ", get_type_name_ex(get_CopyB_type(n), &bad));
1167 #include "execution_frequency.h"
1169 static void dump_node_ana_vals(FILE *F, ir_node *n) {
1173 #ifdef INTERPROCEDURAL_VIEW
1174 fprintf(F, " %lf*(%2.0lf + %2.0lf) = %2.0lf ",
1175 get_irn_exec_freq(n),
1176 get_irg_method_execution_frequency(get_irn_irg(n)),
1177 pow(5, get_irg_recursion_depth(get_irn_irg(n))),
1178 get_irn_exec_freq(n) * (get_irg_method_execution_frequency(get_irn_irg(n)) + pow(5, get_irg_recursion_depth(get_irn_irg(n))))
1184 /* Dumps a node label without the enclosing ". */
1185 int dump_node_label(FILE *F, ir_node *n) {
1188 bad |= dump_node_opcode(F, n);
1189 bad |= dump_node_mode(F, n);
1191 bad |= dump_node_typeinfo(F, n);
1192 bad |= dump_node_nodeattr(F, n);
1193 if(dump_node_idx_labels) {
1194 fprintf(F, "%ld:%d", get_irn_node_nr(n), get_irn_idx(n));
1196 fprintf(F, "%ld", get_irn_node_nr(n));
1203 * Dumps the attributes of a node n into the file F.
1204 * Currently this is only the color of a node.
1206 static void dump_node_vcgattr(FILE *F, ir_node *node, ir_node *local, int bad)
1212 print_vcg_color(F, ird_color_error);
1216 if (dump_node_vcgattr_hook)
1217 if (dump_node_vcgattr_hook(F, node, local))
1220 n = local ? local : node;
1222 if (overrule_nodecolor != ird_color_default_node) {
1223 print_vcg_color(F, overrule_nodecolor);
1227 mode = get_irn_mode(n);
1228 if(mode == mode_M) {
1229 print_vcg_color(F, ird_color_memory);
1232 if(mode == mode_X) {
1233 print_vcg_color(F, ird_color_controlflow);
1237 switch (get_irn_opcode(n)) {
1242 print_vcg_color(F, ird_color_anchor);
1245 print_vcg_color(F, ird_color_error);
1248 if (is_Block_dead(n))
1249 print_vcg_color(F, ird_color_dead_block_background);
1251 print_vcg_color(F, ird_color_block_background);
1254 print_vcg_color(F, ird_color_phi);
1257 print_vcg_color(F, ird_color_memory);
1261 print_vcg_color(F, ird_color_const);
1264 print_vcg_color(F, ird_color_proj);
1267 ir_op *op = get_irn_op(node);
1269 if(is_op_constlike(op)) {
1270 print_vcg_color(F, ird_color_const);
1271 } else if(is_op_uses_memory(op)) {
1272 print_vcg_color(F, ird_color_uses_memory);
1273 } else if(is_op_cfopcode(op) || is_op_forking(op)) {
1274 print_vcg_color(F, ird_color_controlflow);
1276 PRINT_DEFAULT_NODE_ATTR;
1282 /* Adds a new node info dumper callback. */
1283 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data)
1285 hook_entry_t *info = XMALLOC(hook_entry_t);
1287 info->hook._hook_node_info = cb;
1288 info->context = data;
1289 register_hook(hook_node_info, info);
1294 /* Remove a previously added info dumper callback. */
1295 void dump_remv_node_info_callback(void *handle)
1297 hook_entry_t *info = handle;
1298 unregister_hook(hook_node_info, info);
1303 * Dump the node information of a node n to a file F.
1305 static inline int dump_node_info(FILE *F, ir_node *n)
1308 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1310 fprintf(F, " info1: \"");
1311 bad = dump_irnode_to_file(F, n);
1312 /* call the dump_node operation if available */
1314 bad = ops->dump_node(n, F, dump_node_info_txt);
1316 /* allow additional info to be added */
1317 hook_node_info(F, n);
1323 static inline int is_constlike_node(const ir_node *node)
1325 const ir_op *op = get_irn_op(node);
1326 return is_op_constlike(op);
1330 /** outputs the predecessors of n, that are constants, local. I.e.,
1331 generates a copy of the constant predecessors for each node called with. */
1332 static void dump_const_node_local(FILE *F, ir_node *n) {
1334 if (!get_opt_dump_const_local()) return;
1336 /* Use visited flag to avoid outputting nodes twice.
1337 initialize it first. */
1338 for (i = 0; i < get_irn_arity(n); i++) {
1339 ir_node *con = get_irn_n(n, i);
1340 if (is_constlike_node(con)) {
1341 set_irn_visited(con, get_irg_visited(current_ir_graph) - 1);
1345 for (i = 0; i < get_irn_arity(n); i++) {
1346 ir_node *con = get_irn_n(n, i);
1347 if (is_constlike_node(con) && !irn_visited(con)) {
1350 mark_irn_visited(con);
1351 /* Generate a new name for the node by appending the names of
1353 fprintf(F, "node: {title: "); PRINT_CONSTID(n, con);
1354 fprintf(F, " label: \"");
1355 bad |= dump_node_label(F, con);
1357 bad |= dump_node_info(F, con);
1358 dump_node_vcgattr(F, n, con, bad);
1364 /** If the block of an edge is a const_like node, dump it local with an edge */
1365 static void dump_const_block_local(FILE *F, ir_node *n) {
1368 if (!get_opt_dump_const_local()) return;
1370 blk = get_nodes_block(n);
1371 if (is_constlike_node(blk)) {
1374 /* Generate a new name for the node by appending the names of
1376 fprintf(F, "node: {title: \""); PRINT_CONSTBLKID(n, blk);
1377 fprintf(F, "\" label: \"");
1378 bad |= dump_node_label(F, blk);
1380 bad |= dump_node_info(F, blk);
1381 dump_node_vcgattr(F, n, blk, bad);
1384 fprintf(F, "edge: { sourcename: \"");
1386 fprintf(F, "\" targetname: \""); PRINT_CONSTBLKID(n,blk);
1388 if (dump_edge_vcgattr_hook) {
1390 if (dump_edge_vcgattr_hook(F, n, -1)) {
1394 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1399 fprintf(F, "\" " BLOCK_EDGE_ATTR "}\n");
1404 * prints the error message of a node to a file F as info2.
1406 static void print_node_error(FILE *F, const char *err_msg)
1411 fprintf(F, " info2: \"%s\"", err_msg);
1415 * prints debug messages of a node to file F as info3.
1417 static void print_dbg_info(FILE *F, dbg_info *dbg)
1421 if (__dbg_info_snprint) {
1423 if (__dbg_info_snprint(buf, sizeof(buf), dbg) > 0)
1424 fprintf(F, " info3: \"%s\"\n", buf);
1431 static void dump_node(FILE *F, ir_node *n)
1436 if (get_opt_dump_const_local() && is_constlike_node(n))
1439 /* dump this node */
1440 fputs("node: {title: \"", F);
1444 fputs(" label: \"", F);
1445 bad = ! irn_vrfy_irg_dump(n, current_ir_graph, &p);
1446 bad |= dump_node_label(F, n);
1447 dump_node_ana_vals(F, n);
1448 //dump_node_ana_info(F, n);
1451 if (get_op_flags(get_irn_op(n)) & irop_flag_dump_noinput) {
1452 //fputs(" node_class:23", F);
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);
1466 /** dump the edge to the block this node belongs to */
1468 dump_ir_block_edge(FILE *F, ir_node *n) {
1469 if (get_opt_dump_const_local() && is_constlike_node(n)) return;
1470 if (is_no_Block(n)) {
1471 ir_node *block = get_nodes_block(n);
1473 if (get_opt_dump_const_local() && is_constlike_node(block)) {
1474 dump_const_block_local(F, n);
1476 fprintf(F, "edge: { sourcename: \"");
1478 fprintf(F, "\" targetname: ");
1479 fprintf(F, "\""); PRINT_NODEID(block); fprintf(F, "\"");
1481 if (dump_edge_vcgattr_hook) {
1483 if (dump_edge_vcgattr_hook(F, n, -1)) {
1487 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1492 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1498 print_data_edge_vcgattr(FILE *F, ir_node *from, int to) {
1500 * do not use get_nodes_block() here, will fail
1501 * if the irg is not pinned.
1503 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1504 fprintf(F, INTRA_DATA_EDGE_ATTR);
1506 fprintf(F, INTER_DATA_EDGE_ATTR);
1510 print_mem_edge_vcgattr(FILE *F, ir_node *from, int to) {
1512 * do not use get_nodes_block() here, will fail
1513 * if the irg is not pinned.
1515 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1516 fprintf(F, INTRA_MEM_EDGE_ATTR);
1518 fprintf(F, INTER_MEM_EDGE_ATTR);
1521 /** Print the vcg attributes for the edge from node from to it's to's input */
1522 static void print_edge_vcgattr(FILE *F, ir_node *from, int to) {
1525 if (dump_edge_vcgattr_hook)
1526 if (dump_edge_vcgattr_hook(F, from, to))
1529 if (dump_backedge_information_flag && is_backedge(from, to))
1530 fprintf(F, BACK_EDGE_ATTR);
1532 switch (get_irn_opcode(from)) {
1534 fprintf(F, CF_EDGE_ATTR);
1536 case iro_Start: break;
1539 if (get_irn_mode(get_End_keepalive(from, to)) == mode_BB)
1540 fprintf(F, KEEP_ALIVE_CF_EDGE_ATTR);
1542 fprintf(F, KEEP_ALIVE_DF_EDGE_ATTR);
1546 if (is_Proj(from)) {
1547 if (get_irn_mode(from) == mode_M)
1548 print_mem_edge_vcgattr(F, from, to);
1549 else if (get_irn_mode(from) == mode_X)
1550 fprintf(F, CF_EDGE_ATTR);
1552 print_data_edge_vcgattr(F, from, to);
1554 else if (get_irn_mode(get_irn_n(from, to)) == mode_M)
1555 print_mem_edge_vcgattr(F, from, to);
1556 else if (get_irn_mode(get_irn_n(from, to)) == mode_X)
1557 fprintf(F, CF_EDGE_ATTR);
1559 print_data_edge_vcgattr(F, from, to);
1563 /** dump edges to our inputs */
1564 static void dump_ir_data_edges(FILE *F, ir_node *n) {
1566 ir_visited_t visited = get_irn_visited(n);
1568 if (!dump_keepalive && is_End(n)) {
1569 /* the End node has only keep-alive edges */
1573 /* dump the dependency edges. */
1574 num = get_irn_deps(n);
1575 for (i = 0; i < num; ++i) {
1576 ir_node *dep = get_irn_dep(n, i);
1579 fprintf(F, "edge: {sourcename: \"");
1581 fprintf(F, "\" targetname: ");
1582 if ((get_opt_dump_const_local()) && is_constlike_node(dep)) {
1583 PRINT_CONSTID(n, dep);
1589 fprintf(F, " label: \"%d\" ", i);
1590 fprintf(F, " color: darkgreen}\n");
1594 num = get_irn_arity(n);
1595 for (i = 0; i < num; i++) {
1596 ir_node *pred = get_irn_n(n, i);
1599 if ((get_interprocedural_view() && get_irn_visited(pred) < visited))
1600 continue; /* pred not dumped */
1602 if (dump_backedge_information_flag && is_backedge(n, i))
1603 fprintf(F, "backedge: {sourcename: \"");
1605 fprintf(F, "edge: {sourcename: \"");
1607 fprintf(F, "\" targetname: ");
1608 if ((get_opt_dump_const_local()) && is_constlike_node(pred)) {
1609 PRINT_CONSTID(n, pred);
1611 fprintf(F, "\""); PRINT_NODEID(pred); fprintf(F, "\"");
1613 fprintf(F, " label: \"%d\" ", i);
1614 print_edge_vcgattr(F, n, i);
1618 if (dump_macro_block_edges && is_Block(n)) {
1619 ir_node *mb = get_Block_MacroBlock(n);
1620 fprintf(F, "edge: {sourcename: \"");
1622 fprintf(F, "\" targetname: \"");
1624 fprintf(F, "\" label: \"mb\" " MACROBLOCK_EDGE_ATTR);
1633 dump_ir_edges(FILE *F, ir_node *n) {
1634 const ir_edge_t *edge;
1637 foreach_out_edge(n, edge) {
1638 ir_node *succ = get_edge_src_irn(edge);
1640 fprintf(F, "edge: {sourcename: \"");
1642 fprintf(F, "\" targetname: \"");
1646 fprintf(F, " label: \"%d\" ", i);
1647 fprintf(F, OUT_EDGE_ATTR);
1654 /** Dumps a node and its edges but not the block edge */
1655 static void dump_node_wo_blockedge(ir_node *n, void *env) {
1658 dump_ir_data_edges(F, n);
1661 /** Dumps a node and its edges. */
1662 static void dump_whole_node(ir_node *n, void *env) {
1664 dump_node_wo_blockedge(n, env);
1665 if (!node_floats(n))
1666 dump_ir_block_edge(F, n);
1667 if (dump_new_edges_flag && edges_activated(current_ir_graph))
1668 dump_ir_edges(F, n);
1671 /** Dumps a const-like node. */
1672 static void dump_const_node(ir_node *n, void *env) {
1673 if (is_Block(n)) return;
1674 dump_node_wo_blockedge(n, env);
1677 /***********************************************************************/
1678 /* the following routines dump the nodes/irgs bracketed to graphs. */
1679 /***********************************************************************/
1681 /** Dumps a constant expression as entity initializer, array bound ...
1683 static void dump_const_expression(FILE *F, ir_node *value) {
1684 ir_graph *rem = current_ir_graph;
1685 int rem_dump_const_local = dump_const_local;
1686 dump_const_local = 0;
1687 current_ir_graph = get_const_code_irg();
1688 irg_walk(value, dump_const_node, NULL, F);
1689 /* Decrease visited flag so that we walk with the same flag for the next
1690 expression. This guarantees that we don't dump the same node twice,
1691 as for const expressions cse is performed to save memory. */
1692 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph) -1);
1693 current_ir_graph = rem;
1694 dump_const_local = rem_dump_const_local;
1697 /** Dump a block as graph containing its nodes.
1699 * Expects to find nodes belonging to the block as list in its
1701 * Dumps the edges of all nodes including itself. */
1702 static void dump_whole_block(FILE *F, ir_node *block) {
1704 ird_color_t color = ird_color_block_background;
1706 assert(is_Block(block));
1708 fprintf(F, "graph: { title: \"");
1709 PRINT_NODEID(block);
1710 fprintf(F, "\" label: \"");
1711 dump_node_label(F, block);
1713 /* colorize blocks */
1714 if (! get_Block_matured(block))
1715 color = ird_color_block_background;
1716 if (is_Block_dead(block))
1717 color = ird_color_dead_block_background;
1719 fprintf(F, "\" status:clustered ");
1720 print_vcg_color(F, color);
1723 /* yComp can show attributes for blocks, XVCG parses but ignores them */
1724 dump_node_info(F, block);
1725 print_dbg_info(F, get_irn_dbg_info(block));
1727 /* dump the blocks edges */
1728 dump_ir_data_edges(F, block);
1730 if (dump_block_edge_hook)
1731 dump_block_edge_hook(F, block);
1733 /* dump the nodes that go into the block */
1734 for (node = ird_get_irn_link(block); node; node = ird_get_irn_link(node)) {
1736 dump_ir_data_edges(F, node);
1739 /* Close the vcg information for the block */
1741 dump_const_node_local(F, block);
1745 /** dumps a graph block-wise. Expects all blockless nodes in arr in irgs link.
1746 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1748 dump_block_graph(FILE *F, ir_graph *irg) {
1750 ir_graph *rem = current_ir_graph;
1751 ir_node **arr = ird_get_irg_link(irg);
1752 current_ir_graph = irg;
1754 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1755 ir_node * node = arr[i];
1756 if (is_Block(node)) {
1757 /* Dumps the block and all the nodes in the block, which are to
1758 be found in Block->link. */
1759 dump_whole_block(F, node);
1761 /* Nodes that are not in a Block. */
1763 if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
1764 dump_const_block_local(F, node);
1766 dump_ir_data_edges(F, node);
1768 if (dump_new_edges_flag && edges_activated(irg))
1769 dump_ir_edges(F, node);
1772 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1773 dump_loop_nodes_into_graph(F, irg);
1775 current_ir_graph = rem;
1779 * Dump the info for an irg.
1780 * Parsed by XVCG but not shown. use yComp.
1782 static void dump_graph_info(FILE *F, ir_graph *irg) {
1783 fprintf(F, "info1: \"");
1784 dump_entity_to_file(F, get_irg_entity(irg), dump_verbosity_entattrs | dump_verbosity_entconsts);
1788 /** Dumps an irg as a graph clustered by block nodes.
1789 * If interprocedural view edges can point to nodes out of this graph.
1791 static void dump_graph_from_list(FILE *F, ir_graph *irg) {
1792 ir_entity *ent = get_irg_entity(irg);
1794 fprintf(F, "graph: { title: \"");
1796 fprintf(F, "\" label: \"%s\" status:clustered color:%s \n",
1797 get_ent_dump_name(ent), color_names[ird_color_prog_background]);
1799 dump_graph_info(F, irg);
1800 print_dbg_info(F, get_entity_dbg_info(ent));
1802 dump_block_graph(F, irg);
1804 /* Close the vcg information for the irg */
1805 fprintf(F, "}\n\n");
1808 /** dumps a graph extended block-wise. Expects all blockless nodes in arr in irgs link.
1809 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1811 dump_extblock_graph(FILE *F, ir_graph *irg) {
1813 ir_graph *rem = current_ir_graph;
1814 ir_extblk **arr = ird_get_irg_link(irg);
1815 current_ir_graph = irg;
1817 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1818 ir_extblk *extbb = arr[i];
1819 ir_node *leader = get_extbb_leader(extbb);
1822 fprintf(F, "graph: { title: \"");
1823 PRINT_EXTBBID(leader);
1824 fprintf(F, "\" label: \"ExtBB %ld\" status:clustered color:lightgreen\n",
1825 get_irn_node_nr(leader));
1827 for (j = ARR_LEN(extbb->blks) - 1; j >= 0; --j) {
1828 ir_node * node = extbb->blks[j];
1829 if (is_Block(node)) {
1830 /* Dumps the block and all the nodes in the block, which are to
1831 be found in Block->link. */
1832 dump_whole_block(F, node);
1834 /* Nodes that are not in a Block. */
1836 if (is_Bad(get_nodes_block(node)) && !node_floats(node)) {
1837 dump_const_block_local(F, node);
1839 dump_ir_data_edges(F, node);
1845 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1846 dump_loop_nodes_into_graph(F, irg);
1848 current_ir_graph = rem;
1853 /*******************************************************************/
1854 /* Basic type and entity nodes and edges. */
1855 /*******************************************************************/
1857 /** dumps the edges between nodes and their type or entity attributes. */
1858 static void dump_node2type_edges(ir_node *n, void *env)
1863 switch (get_irn_opcode(n)) {
1865 /* @@@ some consts have an entity */
1868 if (SYMCONST_HAS_TYPE(get_SymConst_kind(n)))
1869 print_node_type_edge(F,n,get_SymConst_type(n),NODE2TYPE_EDGE_ATTR);
1872 print_node_ent_edge(F,n,get_Sel_entity(n),NODE2TYPE_EDGE_ATTR);
1875 print_node_type_edge(F,n,get_Call_type(n),NODE2TYPE_EDGE_ATTR);
1878 print_node_type_edge(F,n,get_Alloc_type(n),NODE2TYPE_EDGE_ATTR);
1881 print_node_type_edge(F,n,get_Free_type(n),NODE2TYPE_EDGE_ATTR);
1884 print_node_type_edge(F,n,get_Cast_type(n),NODE2TYPE_EDGE_ATTR);
1892 static int print_type_info(FILE *F, ir_type *tp) {
1895 if (get_type_state(tp) == layout_undefined) {
1896 fprintf(F, "state: layout_undefined\n");
1898 fprintf(F, "state: layout_fixed,\n");
1900 if (get_type_mode(tp))
1901 fprintf(F, "mode: %s,\n", get_mode_name_ex(get_type_mode(tp), &bad));
1902 fprintf(F, "size: %db,\n", get_type_size_bits(tp));
1907 static void print_typespecific_info(FILE *F, ir_type *tp) {
1908 switch (get_type_tpop_code(tp)) {
1910 fprintf(F, "peculiarity: %s\n", get_peculiarity_string(get_class_peculiarity(tp)));
1915 fprintf(F, "variadicity: %s\n", get_variadicity_name(get_method_variadicity(tp)));
1916 fprintf(F, "params: %d\n", get_method_n_params(tp));
1917 fprintf(F, "results: %d\n", get_method_n_ress(tp));
1923 case tpo_enumeration:
1935 static void print_typespecific_vcgattr(FILE *F, ir_type *tp) {
1936 switch (get_type_tpop_code(tp)) {
1938 if (peculiarity_existent == get_class_peculiarity(tp))
1939 fprintf(F, " " TYPE_CLASS_NODE_ATTR);
1941 fprintf(F, " " TYPE_DESCRIPTION_NODE_ATTR);
1944 fprintf(F, " " TYPE_METH_NODE_ATTR);
1952 case tpo_enumeration:
1964 int dump_type_node(FILE *F, ir_type *tp)
1968 fprintf(F, "node: {title: ");
1970 fprintf(F, " label: \"%s %s\"", get_type_tpop_name(tp), get_type_name_ex(tp, &bad));
1971 fprintf(F, " info1: \"");
1973 bad |= print_type_info(F, tp);
1974 print_typespecific_info(F, tp);
1976 dump_type_to_file(F, tp, dump_verbosity_max);
1979 print_dbg_info(F, get_type_dbg_info(tp));
1980 print_typespecific_vcgattr(F, tp);
1987 void dump_entity_node(FILE *F, ir_entity *ent)
1989 fprintf(F, "node: {title: \"");
1990 PRINT_ENTID(ent); fprintf(F, "\"");
1991 fprintf(F, DEFAULT_TYPE_ATTRIBUTE);
1992 fprintf(F, "label: ");
1993 fprintf(F, "\"%s\" ", get_ent_dump_name(ent));
1995 print_vcg_color(F, ird_color_entity);
1996 fprintf(F, "\n info1: \"");
1998 dump_entity_to_file(F, ent, dump_verbosity_entattrs | dump_verbosity_entconsts);
2001 print_dbg_info(F, get_entity_dbg_info(ent));
2005 static void dump_enum_item(FILE *F, ir_type *tp, int pos)
2008 ir_enum_const *ec = get_enumeration_const(tp, pos);
2009 ident *id = get_enumeration_nameid(ec);
2010 tarval *tv = get_enumeration_value(ec);
2013 tarval_snprintf(buf, sizeof(buf), tv);
2015 strncpy(buf, "<not set>", sizeof(buf));
2016 fprintf(F, "node: {title: \"");
2017 PRINT_ITEMID(tp, pos); fprintf(F, "\"");
2018 fprintf(F, DEFAULT_ENUM_ITEM_ATTRIBUTE);
2019 fprintf(F, "label: ");
2020 fprintf(F, "\"enum item %s\" " ENUM_ITEM_NODE_ATTR, get_id_str(id));
2021 fprintf(F, "\n info1: \"value: %s\"}\n", buf);
2024 /* dumps a type or entity and it's edges. */
2026 dump_type_info(type_or_ent tore, void *env) {
2028 int i = 0; /* to shutup gcc */
2030 /* dump this type or entity */
2032 switch (get_kind(tore.ent)) {
2034 ir_entity *ent = tore.ent;
2037 dump_entity_node(F, ent);
2039 /* skip this to reduce graph. Member edge of type is parallel to this edge. *
2040 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2041 ENT_OWN_EDGE_ATTR "}\n", ent, get_entity_owner(ent));*/
2042 print_ent_type_edge(F,ent, get_entity_type(ent), ENT_TYPE_EDGE_ATTR);
2043 if (is_Class_type(get_entity_owner(ent))) {
2044 for(i = 0; i < get_entity_n_overwrites(ent); i++)
2045 print_ent_ent_edge(F,ent, get_entity_overwrites(ent, i), 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2047 /* attached subgraphs */
2048 if (const_entities && (get_entity_variability(ent) != variability_uninitialized)) {
2049 if (is_atomic_entity(ent)) {
2050 value = get_atomic_ent_value(ent);
2052 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2053 /* DDMN(value); $$$ */
2054 dump_const_expression(F, value);
2057 if (is_compound_entity(ent)) {
2058 for (i = 0; i < get_compound_ent_n_values(ent); i++) {
2059 value = get_compound_ent_value(ent, i);
2061 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2062 dump_const_expression(F, value);
2063 print_ent_ent_edge(F, ent, get_compound_ent_value_member(ent, i), 0, -1, ENT_CORR_EDGE_ATTR, i);
2065 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2066 ENT_CORR_EDGE_ATTR "}\n", GET_ENTID(ent),
2067 get_compound_ent_value_member(ent, i), i);
2076 ir_type *tp = tore.typ;
2077 dump_type_node(F, tp);
2078 /* and now the edges */
2079 switch (get_type_tpop_code(tp)) {
2081 for (i=0; i < get_class_n_supertypes(tp); i++)
2082 print_type_type_edge(F, tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2083 for (i=0; i < get_class_n_members(tp); i++)
2084 print_type_ent_edge(F,tp,get_class_member(tp, i),TYPE_MEMBER_EDGE_ATTR);
2087 for (i=0; i < get_struct_n_members(tp); i++)
2088 print_type_ent_edge(F,tp,get_struct_member(tp, i),TYPE_MEMBER_EDGE_ATTR);
2091 for (i = 0; i < get_method_n_params(tp); i++)
2092 print_type_type_edge(F,tp,get_method_param_type(tp, i),METH_PAR_EDGE_ATTR,i);
2093 for (i = 0; i < get_method_n_ress(tp); i++)
2094 print_type_type_edge(F,tp,get_method_res_type(tp, i),METH_RES_EDGE_ATTR,i);
2097 for (i = 0; i < get_union_n_members(tp); i++)
2098 print_type_ent_edge(F,tp,get_union_member(tp, i),UNION_EDGE_ATTR);
2101 print_type_type_edge(F,tp,get_array_element_type(tp),ARR_ELT_TYPE_EDGE_ATTR);
2102 print_type_ent_edge(F,tp,get_array_element_entity(tp),ARR_ENT_EDGE_ATTR);
2103 for (i = 0; i < get_array_n_dimensions(tp); i++) {
2104 ir_node *upper = get_array_upper_bound(tp, i);
2105 ir_node *lower = get_array_lower_bound(tp, i);
2106 print_node_type_edge(F, upper, tp, "label: \"upper %d\"", get_array_order(tp, i));
2107 print_node_type_edge(F, lower, tp, "label: \"lower %d\"", get_array_order(tp, i));
2108 dump_const_expression(F, upper);
2109 dump_const_expression(F, lower);
2112 case tpo_enumeration:
2113 for (i = 0; i < get_enumeration_n_enums(tp); ++i) {
2114 dump_enum_item(F, tp, i);
2115 print_enum_item_edge(F, tp, i, "label: \"item %d\"", i);
2119 print_type_type_edge(F,tp,get_pointer_points_to_type(tp), PTR_PTS_TO_EDGE_ATTR);
2126 break; /* case k_type */
2129 printf(" *** irdump, dump_type_info(l.%i), faulty type.\n", __LINE__);
2130 } /* switch kind_or_entity */
2133 typedef struct _h_env {
2138 /** For dumping class hierarchies.
2139 * Dumps a class type node and a superclass edge.
2140 * If env->dump_ent dumps entities of classes and overwrites edges.
2143 dump_class_hierarchy_node(type_or_ent tore, void *ctx) {
2146 int i = 0; /* to shutup gcc */
2148 /* dump this type or entity */
2149 switch (get_kind(tore.ent)) {
2151 ir_entity *ent = tore.ent;
2152 if (get_entity_owner(ent) == get_glob_type()) break;
2153 if (!is_Method_type(get_entity_type(ent)))
2155 if (env->dump_ent && is_Class_type(get_entity_owner(ent))) {
2157 dump_entity_node(F, ent);
2159 print_type_ent_edge(F,get_entity_owner(ent),ent,TYPE_MEMBER_EDGE_ATTR);
2160 for(i = 0; i < get_entity_n_overwrites(ent); i++)
2161 print_ent_ent_edge(F, get_entity_overwrites(ent, i), ent, 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2166 ir_type *tp = tore.typ;
2167 if (tp == get_glob_type())
2169 switch (get_type_tpop_code(tp)) {
2171 dump_type_node(F, tp);
2172 /* and now the edges */
2173 for (i=0; i < get_class_n_supertypes(tp); i++) {
2174 print_type_type_edge(F,tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2179 break; /* case k_type */
2182 printf(" *** irdump, dump_class_hierarchy_node(l.%i), faulty type.\n", __LINE__);
2183 } /* switch kind_or_entity */
2186 /*******************************************************************/
2187 /* dump analysis information that is expressed in graph terms. */
2188 /*******************************************************************/
2190 /* dump out edges */
2192 dump_out_edge(ir_node *n, void *env) {
2195 for (i = 0; i < get_irn_n_outs(n); i++) {
2196 assert(get_irn_out(n, i));
2197 fprintf(F, "edge: {sourcename: \"");
2199 fprintf(F, "\" targetname: \"");
2200 PRINT_NODEID(get_irn_out(n, i));
2201 fprintf(F, "\" color: red linestyle: dashed");
2207 dump_loop_label(FILE *F, ir_loop *loop) {
2208 fprintf(F, "loop %d, %d sons, %d nodes",
2209 get_loop_depth(loop), get_loop_n_sons(loop), get_loop_n_nodes(loop));
2212 static inline void dump_loop_info(FILE *F, ir_loop *loop) {
2213 fprintf(F, " info1: \"");
2214 fprintf(F, " loop nr: %d", get_loop_loop_nr(loop));
2215 #ifdef DEBUG_libfirm /* GL @@@ debug analyses */
2216 fprintf(F, "\n The loop was analyzed %d times.", PTR_TO_INT(get_loop_link(loop)));
2222 dump_loop_node(FILE *F, ir_loop *loop) {
2223 fprintf(F, "node: {title: \"");
2225 fprintf(F, "\" label: \"");
2226 dump_loop_label(F, loop);
2228 dump_loop_info(F, loop);
2233 dump_loop_node_edge(FILE *F, ir_loop *loop, int i) {
2235 fprintf(F, "edge: {sourcename: \"");
2237 fprintf(F, "\" targetname: \"");
2238 PRINT_NODEID(get_loop_node(loop, i));
2239 fprintf(F, "\" color: green");
2244 dump_loop_son_edge(FILE *F, ir_loop *loop, int i) {
2246 fprintf(F, "edge: {sourcename: \"");
2248 fprintf(F, "\" targetname: \"");
2249 PRINT_LOOPID(get_loop_son(loop, i));
2250 fprintf(F, "\" color: darkgreen label: \"%d\"}\n",
2251 get_loop_element_pos(loop, get_loop_son(loop, i)));
2255 void dump_loops(FILE *F, ir_loop *loop) {
2257 /* dump this loop node */
2258 dump_loop_node(F, loop);
2260 /* dump edges to nodes in loop -- only if it is a real loop */
2261 if (get_loop_depth(loop) != 0) {
2262 for (i = 0; i < get_loop_n_nodes(loop); i++) {
2263 dump_loop_node_edge(F, loop, i);
2266 for (i = 0; i < get_loop_n_sons(loop); i++) {
2267 dump_loops(F, get_loop_son(loop, i));
2268 dump_loop_son_edge(F, loop, i);
2273 void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg) {
2274 ir_graph *rem = current_ir_graph;
2275 current_ir_graph = irg;
2277 if (get_irg_loop(irg)) dump_loops(F, get_irg_loop(irg));
2279 current_ir_graph = rem;
2284 * dumps the VCG header
2286 void dump_vcg_header(FILE *F, const char *name, const char *layout, const char *orientation) {
2292 label = edge_label ? "yes" : "no";
2293 if (! layout) layout = "Compilergraph";
2294 if (!orientation) orientation = "bottom_to_top";
2298 "graph: { title: \"ir graph of %s\"\n"
2299 "display_edge_labels: %s\n"
2300 "layoutalgorithm: mindepth //$ \"%s\"\n"
2301 "manhattan_edges: yes\n"
2302 "port_sharing: no\n"
2304 "classname 1: \"intrablock Data\"\n"
2305 "classname 2: \"Block\"\n"
2306 "classname 3: \"Entity type\"\n"
2307 "classname 4: \"Entity owner\"\n"
2308 "classname 5: \"Method Param\"\n"
2309 "classname 6: \"Method Res\"\n"
2310 "classname 7: \"Super\"\n"
2311 "classname 8: \"Union\"\n"
2312 "classname 9: \"Points-to\"\n"
2313 "classname 10: \"Array Element Type\"\n"
2314 "classname 11: \"Overwrites\"\n"
2315 "classname 12: \"Member\"\n"
2316 "classname 13: \"Control Flow\"\n"
2317 "classname 14: \"intrablock Memory\"\n"
2318 "classname 15: \"Dominators\"\n"
2319 "classname 16: \"interblock Data\"\n"
2320 "classname 17: \"interblock Memory\"\n"
2321 "classname 18: \"Exception Control Flow for Interval Analysis\"\n"
2322 "classname 19: \"Postdominators\"\n"
2323 "classname 20: \"Keep Alive\"\n"
2324 "classname 21: \"Out Edges\"\n"
2325 "classname 22: \"Macro Block Edges\"\n"
2326 //"classname 23: \"NoInput Nodes\"\n"
2327 "infoname 1: \"Attribute\"\n"
2328 "infoname 2: \"Verification errors\"\n"
2329 "infoname 3: \"Debug info\"\n",
2330 name, label, layout, orientation);
2332 for (i = 0; i < ird_color_count; ++i) {
2333 if (color_rgb[i] != NULL) {
2334 fprintf(F, "colorentry %s: %s\n", color_names[i], color_rgb[i]);
2337 fprintf(F, "\n"); /* a separator */
2343 * @param irg The graph to be dumped
2344 * @param suffix1 first filename suffix
2345 * @param suffix2 second filename suffix
2347 FILE *vcg_open(ir_graph *irg, const char * suffix1, const char *suffix2) {
2349 const char *nm = get_irg_dump_name(irg);
2350 int len = strlen(nm), i, j;
2351 char *fname; /* filename to put the vcg information in */
2353 if (!suffix1) suffix1 = "";
2354 if (!suffix2) suffix2 = "";
2356 /* open file for vcg graph */
2357 fname = XMALLOCN(char, len * 2 + strlen(suffix1) + strlen(suffix2) + 5);
2359 /* strncpy (fname, nm, len); */ /* copy the filename */
2361 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2363 fname[j] = '@'; j++; fname[j] = '1'; j++;
2364 } else if (nm[i] == '@') {
2365 fname[j] = '@'; j++; fname[j] = '2'; j++;
2367 fname[j] = nm[i]; j++;
2371 strcat(fname, suffix1); /* append file suffix */
2372 strcat(fname, suffix2); /* append file suffix */
2373 strcat(fname, ".vcg"); /* append the .vcg suffix */
2375 /* vcg really expect only a <CR> at end of line, so
2376 * the "b"inary mode is what you mean (and even needed for Win32)
2378 F = fopen(fname, "wb"); /* open file for writing */
2390 * @param name prefix file name
2391 * @param suffix filename suffix
2393 FILE *vcg_open_name(const char *name, const char *suffix) {
2395 char *fname; /* filename to put the vcg information in */
2396 int i, j, len = strlen(name);
2398 if (!suffix) suffix = "";
2400 /** open file for vcg graph */
2401 fname = XMALLOCN(char, len * 2 + 5 + strlen(suffix));
2402 /* strcpy (fname, name);*/ /* copy the filename */
2404 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2405 if (name[i] == '/') {
2406 fname[j] = '@'; j++; fname[j] = '1'; j++;
2407 } else if (name[i] == '@') {
2408 fname[j] = '@'; j++; fname[j] = '2'; j++;
2410 fname[j] = name[i]; j++;
2414 strcat(fname, suffix);
2415 strcat(fname, ".vcg"); /* append the .vcg suffix */
2417 /* vcg really expect only a <CR> at end of line, so
2418 * the "b"inary mode is what you mean (and even needed for Win32)
2420 F = fopen(fname, "wb"); /* open file for writing */
2430 * Dumps the vcg file footer
2432 void dump_vcg_footer(FILE *F) {
2436 /************************************************************************/
2437 /************************************************************************/
2438 /* Routines that dump all or parts of the firm representation to a file */
2439 /************************************************************************/
2440 /************************************************************************/
2442 /************************************************************************/
2443 /* Dump ir graphs, different formats and additional information. */
2444 /************************************************************************/
2446 typedef void (*do_dump_graph_func) (ir_graph *irg, FILE *out);
2448 static void do_dump(ir_graph *irg, const char *suffix, const char *suffix_ip,
2449 const char *suffix_nonip, do_dump_graph_func dump_func)
2453 const char *suffix1;
2455 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2458 rem = current_ir_graph;
2459 current_ir_graph = irg;
2460 if (get_interprocedural_view())
2461 suffix1 = suffix_ip;
2463 suffix1 = suffix_nonip;
2464 current_ir_graph = rem;
2466 out = vcg_open(irg, suffix, suffix1);
2468 dump_func(irg, out);
2473 void dump_ir_graph_file(ir_graph *irg, FILE *out)
2475 if (dump_backedge_information_flag
2476 && get_irg_loopinfo_state(irg) != loopinfo_consistent) {
2477 construct_backedges(irg);
2480 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2482 /* call the dump graph hook */
2483 if (dump_ir_graph_hook) {
2484 if (dump_ir_graph_hook(out, irg)) {
2489 /* walk over the graph */
2490 /* dump_whole_node must be called in post visiting predecessors */
2491 ird_walk_graph(irg, NULL, dump_whole_node, out);
2493 /* dump the out edges in a separate walk */
2494 if ((dump_out_edge_flag) && (get_irg_outs_state(irg) != outs_none)) {
2495 irg_out_walk(get_irg_start(irg), dump_out_edge, NULL, out);
2498 dump_vcg_footer(out);
2501 /** Routine to dump a graph, blocks as conventional nodes. */
2502 void dump_ir_graph(ir_graph *irg, const char *suffix )
2504 do_dump(irg, suffix, "-pure-ip", "-pure", dump_ir_graph_file);
2507 void dump_ir_block_graph_file(ir_graph *irg, FILE *out)
2511 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2513 construct_block_lists(irg);
2516 * If we are in the interprocedural view, we dump not
2517 * only the requested irg but also all irgs that can be reached
2520 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2521 ir_graph *g = get_irp_irg(i);
2522 ir_node **arr = ird_get_irg_link(g);
2524 dump_graph_from_list(out, g);
2529 dump_vcg_footer(out);
2532 /* Dump a firm graph without explicit block nodes. */
2533 void dump_ir_block_graph(ir_graph *irg, const char *suffix)
2535 do_dump(irg, suffix, "-ip", "", dump_ir_block_graph_file);
2538 void dump_ir_extblock_graph_file(ir_graph *irg, FILE *F)
2541 ir_entity *ent = get_irg_entity(irg);
2543 if (get_irg_extblk_state(irg) != extblk_valid)
2546 dump_vcg_header(F, get_irg_dump_name(irg), NULL, NULL);
2548 construct_extblock_lists(irg);
2550 fprintf(F, "graph: { title: \"");
2552 fprintf(F, "\" label: \"%s\" status:clustered color: white \n",
2553 get_ent_dump_name(ent));
2555 dump_graph_info(F, irg);
2556 print_dbg_info(F, get_entity_dbg_info(ent));
2558 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2559 ir_graph *irg = get_irp_irg(i);
2560 list_tuple *lists = ird_get_irg_link(irg);
2563 /* dump the extended blocks first */
2564 if (ARR_LEN(lists->extbb_list)) {
2565 ird_set_irg_link(irg, lists->extbb_list);
2566 dump_extblock_graph(F, irg);
2569 /* we may have blocks without extended blocks, bad for instance */
2570 if (ARR_LEN(lists->blk_list)) {
2571 ird_set_irg_link(irg, lists->blk_list);
2572 dump_block_graph(F, irg);
2575 DEL_ARR_F(lists->extbb_list);
2576 DEL_ARR_F(lists->blk_list);
2581 /* Close the vcg information for the irg */
2582 fprintf(F, "}\n\n");
2588 /* Dump a firm graph without explicit block nodes but grouped in extended blocks. */
2589 void dump_ir_extblock_graph(ir_graph *irg, const char *suffix)
2591 do_dump(irg, suffix, "-ip", "", dump_ir_extblock_graph_file);
2594 void dump_ir_graph_w_types_file(ir_graph *irg, FILE *out)
2596 ir_graph *rem = current_ir_graph;
2597 int rem_dump_const_local;
2599 rem = current_ir_graph;
2600 current_ir_graph = irg;
2601 rem_dump_const_local = dump_const_local;
2602 /* dumping types does not work with local nodes */
2603 dump_const_local = 0;
2605 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2607 /* dump common ir graph */
2608 irg_walk(get_irg_end(irg), NULL, dump_whole_node, out);
2609 /* dump type info */
2610 type_walk_irg(irg, dump_type_info, NULL, out);
2611 inc_irg_visited(get_const_code_irg());
2612 /* dump edges from graph to type info */
2613 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2615 dump_vcg_footer(out);
2616 dump_const_local = rem_dump_const_local;
2617 current_ir_graph = rem;
2620 /* dumps a graph with type information */
2621 void dump_ir_graph_w_types(ir_graph *irg, const char *suffix)
2623 do_dump(irg, suffix, "-pure-wtypes-ip", "-pure-wtypes",
2624 dump_ir_graph_w_types_file);
2627 void dump_ir_block_graph_w_types_file(ir_graph *irg, FILE *out)
2630 int rem_dump_const_local;
2631 ir_graph *rem = current_ir_graph;
2633 rem_dump_const_local = dump_const_local;
2634 /* dumping types does not work with local nodes */
2635 dump_const_local = 0;
2637 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2639 /* dump common blocked ir graph */
2640 construct_block_lists(irg);
2642 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2643 ir_node **arr = ird_get_irg_link(get_irp_irg(i));
2645 dump_graph_from_list(out, get_irp_irg(i));
2650 /* dump type info */
2651 current_ir_graph = irg;
2652 type_walk_irg(irg, dump_type_info, NULL, out);
2653 inc_irg_visited(get_const_code_irg());
2655 /* dump edges from graph to type info */
2656 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2658 dump_vcg_footer(out);
2659 dump_const_local = rem_dump_const_local;
2660 current_ir_graph = rem;
2663 void dump_ir_block_graph_w_types(ir_graph *irg, const char *suffix)
2665 do_dump(irg, suffix, "-wtypes-ip", "-wtypes",
2666 dump_ir_block_graph_w_types_file);
2669 /*---------------------------------------------------------------------*/
2670 /* The following routines dump a control flow graph. */
2671 /*---------------------------------------------------------------------*/
2674 dump_block_to_cfg(ir_node *block, void *env) {
2679 if (is_Block(block)) {
2680 /* This is a block. Dump a node for the block. */
2681 fprintf(F, "node: {title: \""); PRINT_NODEID(block);
2682 fprintf(F, "\" label: \"");
2683 if (block == get_irg_start_block(get_irn_irg(block)))
2684 fprintf(F, "Start ");
2685 if (block == get_irg_end_block(get_irn_irg(block)))
2688 fprintf(F, "%s ", get_op_name(get_irn_op(block)));
2689 PRINT_NODEID(block);
2691 fprintf(F, "info1:\"");
2693 /* the generic version. */
2694 dump_irnode_to_file(F, block);
2696 /* Check whether we have bad predecessors to color the block. */
2697 for (i = 0; i < get_Block_n_cfgpreds(block); ++i)
2698 if ((fl = is_Bad(get_Block_cfgpred(block, i))))
2701 fprintf(F, "\""); /* closing quote of info */
2703 if ((block == get_irg_start_block(get_irn_irg(block))) ||
2704 (block == get_irg_end_block(get_irn_irg(block))) )
2705 fprintf(F, " color:blue ");
2707 fprintf(F, " color:yellow ");
2710 /* Dump the edges */
2711 for ( i = 0; i < get_Block_n_cfgpreds(block); i++)
2712 if (!is_Bad(skip_Proj(get_Block_cfgpred(block, i)))) {
2713 pred = get_nodes_block(skip_Proj(get_Block_cfgpred(block, i)));
2714 fprintf(F, "edge: { sourcename: \"");
2715 PRINT_NODEID(block);
2716 fprintf(F, "\" targetname: \"");
2718 fprintf(F, "\"}\n");
2721 /* Dump dominator/postdominator edge */
2722 if (dump_dominator_information_flag) {
2723 if (get_irg_dom_state(current_ir_graph) == dom_consistent && get_Block_idom(block)) {
2724 pred = get_Block_idom(block);
2725 fprintf(F, "edge: { sourcename: \"");
2726 PRINT_NODEID(block);
2727 fprintf(F, "\" targetname: \"");
2729 fprintf(F, "\" " DOMINATOR_EDGE_ATTR "}\n");
2731 if (get_irg_postdom_state(current_ir_graph) == dom_consistent && get_Block_ipostdom(block)) {
2732 pred = get_Block_ipostdom(block);
2733 fprintf(F, "edge: { sourcename: \"");
2734 PRINT_NODEID(block);
2735 fprintf(F, "\" targetname: \"");
2737 fprintf(F, "\" " POSTDOMINATOR_EDGE_ATTR "}\n");
2743 void dump_cfg(ir_graph *irg, const char *suffix)
2746 /* if a filter is set, dump only the irg's that match the filter */
2747 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2750 f = vcg_open(irg, suffix, "-cfg");
2752 ir_graph *rem = current_ir_graph;
2753 #ifdef INTERPROCEDURAL_VIEW
2754 int ipv = get_interprocedural_view();
2757 current_ir_graph = irg;
2758 dump_vcg_header(f, get_irg_dump_name(irg), NULL, NULL);
2760 #ifdef INTERPROCEDURAL_VIEW
2762 printf("Warning: dumping cfg not in interprocedural view!\n");
2763 set_interprocedural_view(0);
2767 /* walk over the blocks in the graph */
2768 irg_block_walk(get_irg_end(irg), dump_block_to_cfg, NULL, f);
2769 dump_node(f, get_irg_bad(irg));
2771 #ifdef INTERPROCEDURAL_VIEW
2772 set_interprocedural_view(ipv);
2776 current_ir_graph = rem;
2781 static void descend_and_dump(FILE *F, ir_node *n, int depth, pset *mark_set) {
2782 if (pset_find_ptr(mark_set, n)) return;
2784 pset_insert_ptr(mark_set, n);
2787 int i, start = is_Block(n) ? 0 : -1;
2788 dump_whole_node(n, F);
2789 for (i = start; i < get_irn_arity(n); ++i)
2790 descend_and_dump(F, get_irn_n(n, i), depth-1, mark_set);
2793 /* Don't dump edges to nodes further out. These might be edges to
2794 nodes we already dumped, if there is a shorter path to these. */
2798 static int subgraph_counter = 0;
2799 void dump_subgraph(ir_node *root, int depth, const char *suffix) {
2803 sprintf(buf, "-subg_%03d", subgraph_counter++);
2804 F = vcg_open(get_irn_irg(root), suffix, buf);
2806 pset *mark_set = pset_new_ptr(1);
2807 dump_vcg_header(F, get_irg_dump_name(get_irn_irg(root)), NULL, NULL);
2808 descend_and_dump(F, root, depth, mark_set);
2815 void dump_callgraph(const char *suffix) {
2816 FILE *F = vcg_open_name("Callgraph", suffix);
2819 int i, rem = edge_label;
2822 dump_vcg_header(F, "Callgraph", "Hierarchiv", NULL);
2824 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2825 ir_graph *irg = get_irp_irg(i);
2826 ir_entity *ent = get_irg_entity(irg);
2828 int n_callees = get_irg_n_callees(irg);
2830 dump_entity_node(F, ent);
2831 for (j = 0; j < n_callees; ++j) {
2832 ir_entity *c = get_irg_entity(get_irg_callee(irg, j));
2833 //if (id_is_prefix(prefix, get_entity_ld_ident(c))) continue;
2834 int be = is_irg_callee_backedge(irg, j);
2837 "label:\"recursion %d\"" :
2838 "label:\"calls %d\"";
2839 print_ent_ent_edge(F, ent, c, be, ird_color_entity, attr, get_irg_callee_loop_depth(irg, j));
2850 /* Dump all irgs in interprocedural view to a single file. */
2851 void dump_all_cg_block_graph(const char *suffix) {
2852 FILE *f = vcg_open_name("All_graphs", suffix);
2856 int rem_view = get_interprocedural_view();
2858 set_interprocedural_view(1);
2859 dump_vcg_header(f, "All_graphs", NULL);
2861 /* collect nodes in all irgs reachable in call graph*/
2862 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2863 ird_set_irg_link(get_irp_irg(i), NULL);
2865 cg_walk(clear_link, collect_node, NULL);
2867 /* dump all graphs */
2868 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2869 current_ir_graph = get_irp_irg(i);
2870 assert(ird_get_irg_link(current_ir_graph));
2871 dump_graph_from_list(f, current_ir_graph);
2872 DEL_ARR_F(ird_get_irg_link(current_ir_graph));
2877 set_interprocedural_view(rem_view);
2882 /*---------------------------------------------------------------------*/
2883 /* the following routines dumps type information without any ir nodes. */
2884 /*---------------------------------------------------------------------*/
2887 dump_type_graph(ir_graph *irg, const char *suffix)
2891 /* if a filter is set, dump only the irg's that match the filter */
2892 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
2894 f = vcg_open(irg, suffix, "-type");
2896 ir_graph *rem = current_ir_graph;
2897 current_ir_graph = irg;
2899 dump_vcg_header(f, get_irg_dump_name(irg), "Hierarchic", NULL);
2901 /* walk over the blocks in the graph */
2902 type_walk_irg(irg, dump_type_info, NULL, f);
2903 /* The walker for the const code can be called several times for the
2904 same (sub) expression. So that no nodes are dumped several times
2905 we decrease the visited flag of the corresponding graph after each
2906 walk. So now increase it finally. */
2907 inc_irg_visited(get_const_code_irg());
2911 current_ir_graph = rem;
2916 dump_all_types(const char *suffix)
2918 FILE *f = vcg_open_name("All_types", suffix);
2920 dump_vcg_header(f, "All_types", "Hierarchic", NULL);
2921 type_walk(dump_type_info, NULL, f);
2922 inc_irg_visited(get_const_code_irg());
2930 dump_class_hierarchy(int entities, const char *suffix)
2932 FILE *f = vcg_open_name("class_hierarchy", suffix);
2937 env.dump_ent = entities;
2938 dump_vcg_header(f, "class_hierarchy", "Hierarchic", NULL);
2939 type_walk(dump_class_hierarchy_node, NULL, &env);
2946 /*---------------------------------------------------------------------*/
2947 /* dumps all graphs with the graph-dumper passed. Possible dumpers: */
2949 /* dump_ir_block_graph */
2951 /* dump_type_graph */
2952 /* dump_ir_graph_w_types */
2953 /*---------------------------------------------------------------------*/
2955 void dump_all_ir_graphs(dump_graph_func *dmp_grph, const char *suffix) {
2957 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2958 dmp_grph(get_irp_irg(i), suffix);
2962 /*--------------------------------------------------------------------------------*
2963 * Dumps a stand alone loop graph with firm nodes which belong to one loop node *
2964 * packed together in one subgraph/box *
2965 *--------------------------------------------------------------------------------*/
2967 void dump_loops_standalone(FILE *F, ir_loop *loop) {
2968 int i = 0, loop_node_started = 0, son_number = 0, first = 0;
2970 ir_loop *son = NULL;
2972 /* Dump a new loop node. */
2973 dump_loop_node(F, loop);
2975 /* Dump the loop elements. */
2976 for (i = 0; i < get_loop_n_elements(loop); i++) {
2977 le = get_loop_element(loop, i);
2979 if (get_kind(son) == k_ir_loop) {
2981 /* We are a loop son -> Recurse */
2983 if (loop_node_started) { /* Close the "firm-nodes" node first if we started one. */
2984 fprintf(F, "\" }\n");
2985 fprintf(F, "edge: {sourcename: \"");
2987 fprintf(F, "\" targetname: \"");
2989 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
2990 loop_node_started = 0;
2992 dump_loop_son_edge(F, loop, son_number++);
2993 dump_loops_standalone(F, son);
2994 } else if (get_kind(son) == k_ir_node) {
2995 /* We are a loop node -> Collect firm nodes */
2997 ir_node *n = le.node;
3000 if (!loop_node_started) {
3001 /* Start a new node which contains all firm nodes of the current loop */
3002 fprintf(F, "node: { title: \"");
3004 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3005 loop_node_started = 1;
3010 bad |= dump_node_label(F, n);
3011 /* Causes indeterministic output: if (is_Block(n)) fprintf(F, "\t ->%d", (int)get_irn_link(n)); */
3012 if (has_backedges(n)) fprintf(F, "\t loop head!");
3013 } else { /* for callgraph loop tree */
3015 assert(get_kind(son) == k_ir_graph);
3017 /* We are a loop node -> Collect firm graphs */
3019 if (!loop_node_started) {
3020 /* Start a new node which contains all firm nodes of the current loop */
3021 fprintf(F, "node: { title: \"");
3023 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3024 loop_node_started = 1;
3028 fprintf(F, " %s", get_irg_dump_name(n));
3029 /* fprintf(F, " %s (depth %d)", get_irg_dump_name(n), n->callgraph_weighted_loop_depth); */
3033 if (loop_node_started) {
3034 fprintf(F, "\" }\n");
3035 fprintf(F, "edge: {sourcename: \"");
3037 fprintf(F, "\" targetname: \"");
3039 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3040 loop_node_started = 0;
3044 void dump_loop_tree(ir_graph *irg, const char *suffix)
3048 /* if a filter is set, dump only the irg's that match the filter */
3049 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
3051 f = vcg_open(irg, suffix, "-looptree");
3053 ir_graph *rem = current_ir_graph;
3054 int el_rem = edge_label;
3056 current_ir_graph = irg;
3059 dump_vcg_header(f, get_irg_dump_name(irg), "Tree", "top_to_bottom");
3061 if (get_irg_loop(irg))
3062 dump_loops_standalone(f, get_irg_loop(irg));
3067 edge_label = el_rem;
3068 current_ir_graph = rem;
3072 void dump_callgraph_loop_tree(const char *suffix) {
3074 F = vcg_open_name("Callgraph_looptree", suffix);
3075 dump_vcg_header(F, "callgraph looptree", "Tree", "top_to_bottom");
3076 dump_loops_standalone(F, irp->outermost_cg_loop);
3082 /*----------------------------------------------------------------------------*/
3083 /* Dumps the firm nodes in the loop tree to a graph along with the loop nodes.*/
3084 /*----------------------------------------------------------------------------*/
3086 void collect_nodeloop(FILE *F, ir_loop *loop, eset *loopnodes) {
3087 int i, son_number = 0, node_number = 0;
3089 if (dump_loop_information_flag) dump_loop_node(F, loop);
3091 for (i = 0; i < get_loop_n_elements(loop); i++) {
3092 loop_element le = get_loop_element(loop, i);
3093 if (*(le.kind) == k_ir_loop) {
3094 if (dump_loop_information_flag) dump_loop_son_edge(F, loop, son_number++);
3096 collect_nodeloop(F, le.son, loopnodes);
3098 if (dump_loop_information_flag) dump_loop_node_edge(F, loop, node_number++);
3099 eset_insert(loopnodes, le.node);
3104 void collect_nodeloop_external_nodes(ir_loop *loop, eset *loopnodes, eset *extnodes) {
3107 for(i = 0; i < get_loop_n_elements(loop); i++) {
3108 loop_element le = get_loop_element(loop, i);
3109 if (*(le.kind) == k_ir_loop) {
3111 collect_nodeloop_external_nodes(le.son, loopnodes, extnodes);
3113 if (is_Block(le.node)) start = 0; else start = -1;
3114 for (j = start; j < get_irn_arity(le.node); j++) {
3115 ir_node *pred = get_irn_n(le.node, j);
3116 if (!eset_contains(loopnodes, pred)) {
3117 eset_insert(extnodes, pred);
3118 if (!is_Block(pred)) {
3119 pred = get_nodes_block(pred);
3120 if (!eset_contains(loopnodes, pred)) eset_insert(extnodes, pred);
3128 void dump_loop(ir_loop *l, const char *suffix) {
3132 snprintf(name, sizeof(name), "loop_%d", get_loop_loop_nr(l));
3133 F = vcg_open_name(name, suffix);
3135 eset *loopnodes = eset_create();
3136 eset *extnodes = eset_create();
3139 dump_vcg_header(F, name, NULL, NULL);
3141 /* collect all nodes to dump */
3142 collect_nodeloop(F, l, loopnodes);
3143 collect_nodeloop_external_nodes(l, loopnodes, extnodes);
3145 /* build block lists */
3146 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes))
3147 set_irn_link(n, NULL);
3148 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes))
3149 set_irn_link(n, NULL);
3150 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes)) {
3152 b = get_nodes_block(n);
3153 set_irn_link(n, get_irn_link(b));
3157 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes)) {
3159 b = get_nodes_block(n);
3160 set_irn_link(n, get_irn_link(b));
3165 for (b = eset_first(loopnodes); b != NULL; b = eset_next(loopnodes)) {
3167 fprintf(F, "graph: { title: \"");
3169 fprintf(F, "\" label: \"");
3170 dump_node_opcode(F, b);
3171 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3172 fprintf(F, "\" status:clustered color:yellow\n");
3174 /* dump the blocks edges */
3175 dump_ir_data_edges(F, b);
3177 /* dump the nodes that go into the block */
3178 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3179 if (eset_contains(extnodes, n))
3180 overrule_nodecolor = ird_color_block_inout;
3182 overrule_nodecolor = ird_color_default_node;
3183 if (!eset_contains(extnodes, n)) dump_ir_data_edges(F, n);
3186 /* Close the vcg information for the block */
3188 dump_const_node_local(F, b);
3192 for (b = eset_first(extnodes); b != NULL; b = eset_next(extnodes)) {
3194 fprintf(F, "graph: { title: \"");
3196 fprintf(F, "\" label: \"");
3197 dump_node_opcode(F, b);
3198 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3199 fprintf(F, "\" status:clustered color:lightblue\n");
3201 /* dump the nodes that go into the block */
3202 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3203 if (!eset_contains(loopnodes, n))
3204 overrule_nodecolor = ird_color_block_inout;
3206 overrule_nodecolor = ird_color_default_node;
3207 if (eset_contains(loopnodes, n)) dump_ir_data_edges(F, n);
3210 /* Close the vcg information for the block */
3212 dump_const_node_local(F, b);
3216 eset_destroy(loopnodes);
3217 eset_destroy(extnodes);