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_default_proj(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 (get_Div_no_remainder(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 }
923 /** the lookup table for Proj(Cond) names */
924 static const pns_lookup_t cond_lut[] = {
925 #define X(a) { pn_Cond_##a, #a }
931 /** the lookup table for Proj(Call) names */
932 static const pns_lookup_t call_lut[] = {
933 #define X(a) { pn_Call_##a, #a }
943 /** the lookup table for Proj(Quot) names */
944 static const pns_lookup_t quot_lut[] = {
945 #define X(a) { pn_Quot_##a, #a }
953 /** the lookup table for Proj(DivMod) names */
954 static const pns_lookup_t divmod_lut[] = {
955 #define X(a) { pn_DivMod_##a, #a }
964 /** the lookup table for Proj(Div) names */
965 static const pns_lookup_t div_lut[] = {
966 #define X(a) { pn_Div_##a, #a }
974 /** the lookup table for Proj(Mod) names */
975 static const pns_lookup_t mod_lut[] = {
976 #define X(a) { pn_Mod_##a, #a }
984 /** the lookup table for Proj(Load) names */
985 static const pns_lookup_t load_lut[] = {
986 #define X(a) { pn_Load_##a, #a }
994 /** the lookup table for Proj(Store) names */
995 static const pns_lookup_t store_lut[] = {
996 #define X(a) { pn_Store_##a, #a }
1003 /** the lookup table for Proj(Alloc) names */
1004 static const pns_lookup_t alloc_lut[] = {
1005 #define X(a) { pn_Alloc_##a, #a }
1013 /** the lookup table for Proj(CopyB) names */
1014 static const pns_lookup_t copyb_lut[] = {
1015 #define X(a) { pn_CopyB_##a, #a }
1023 /** the lookup table for Proj(InstOf) names */
1024 static const pns_lookup_t instof_lut[] = {
1025 #define X(a) { pn_InstOf_##a, #a }
1034 /** the lookup table for Proj(Raise) names */
1035 static const pns_lookup_t raise_lut[] = {
1036 #define X(a) { pn_Raise_##a, #a }
1042 /** the lookup table for Proj(Bound) names */
1043 static const pns_lookup_t bound_lut[] = {
1044 #define X(a) { pn_Bound_##a, #a }
1052 /** the Proj lookup table */
1053 static const proj_lookup_t proj_lut[] = {
1054 #define E(a) ARR_SIZE(a), a
1055 { iro_Start, E(start_lut) },
1056 { iro_Cond, E(cond_lut) },
1057 { iro_Call, E(call_lut) },
1058 { iro_Quot, E(quot_lut) },
1059 { iro_DivMod, E(divmod_lut) },
1060 { iro_Div, E(div_lut) },
1061 { iro_Mod, E(mod_lut) },
1062 { iro_Load, E(load_lut) },
1063 { iro_Store, E(store_lut) },
1064 { iro_Alloc, E(alloc_lut) },
1065 { iro_CopyB, E(copyb_lut) },
1066 { iro_InstOf, E(instof_lut) },
1067 { iro_Raise, E(raise_lut) },
1068 { iro_Bound, E(bound_lut) }
1073 * Dump additional node attributes of some nodes to a file F.
1076 dump_node_nodeattr(FILE *F, ir_node *n)
1082 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1084 /* call the dump_node operation if available */
1086 return ops->dump_node(n, F, dump_node_nodeattr_txt);
1088 switch (get_irn_opcode(n)) {
1090 if (0 && get_interprocedural_view()) {
1091 fprintf(F, "%s ", get_ent_dump_name(get_irg_entity(current_ir_graph)));
1096 ir_fprintf(F, "%T ", get_Const_tarval(n));
1100 pred = get_Proj_pred(n);
1101 proj_nr = get_Proj_proj(n);
1103 code = get_irn_opcode(pred);
1105 if (code == iro_Cmp)
1106 fprintf(F, "%s ", get_pnc_string(get_Proj_proj(n)));
1107 else if (code == iro_Proj && get_irn_opcode(get_Proj_pred(pred)) == iro_Start)
1108 fprintf(F, "Arg %ld ", proj_nr);
1109 else if (code == iro_Cond && get_irn_mode(get_Cond_selector(pred)) != mode_b)
1110 fprintf(F, "%ld ", proj_nr);
1112 unsigned i, j, f = 0;
1114 for (i = 0; i < ARR_SIZE(proj_lut); ++i) {
1115 if (code == proj_lut[i].code) {
1116 for (j = 0; j < proj_lut[i].num_data; ++j) {
1117 if (proj_nr == proj_lut[i].data[j].nr) {
1118 fprintf(F, "%s ", proj_lut[i].data[j].name);
1127 fprintf(F, "%ld ", proj_nr);
1128 if (code == iro_Cond && get_Cond_jmp_pred(pred) != COND_JMP_PRED_NONE) {
1129 if (proj_nr == pn_Cond_false && get_Cond_jmp_pred(pred) == COND_JMP_PRED_FALSE)
1130 fprintf(F, "PRED ");
1131 if (proj_nr == pn_Cond_true && get_Cond_jmp_pred(pred) == COND_JMP_PRED_TRUE)
1132 fprintf(F, "PRED ");
1137 proj_nr = get_Filter_proj(n);
1138 if (! get_interprocedural_view()) {
1140 pred = get_Filter_pred(n);
1143 fprintf(F, "%ld ", proj_nr);
1146 fprintf(F, "%s ", get_ent_dump_name(get_Sel_entity(n)));
1149 fprintf(F, "(%s) ", get_type_name_ex(get_Cast_type(n), &bad));
1152 fprintf(F, "%s ", get_pnc_string(get_Confirm_cmp(n)));
1155 fprintf(F, "(%s) ", get_type_name_ex(get_CopyB_type(n), &bad));
1166 #include "execution_frequency.h"
1168 static void dump_node_ana_vals(FILE *F, ir_node *n) {
1172 #ifdef INTERPROCEDURAL_VIEW
1173 fprintf(F, " %lf*(%2.0lf + %2.0lf) = %2.0lf ",
1174 get_irn_exec_freq(n),
1175 get_irg_method_execution_frequency(get_irn_irg(n)),
1176 pow(5, get_irg_recursion_depth(get_irn_irg(n))),
1177 get_irn_exec_freq(n) * (get_irg_method_execution_frequency(get_irn_irg(n)) + pow(5, get_irg_recursion_depth(get_irn_irg(n))))
1183 /* Dumps a node label without the enclosing ". */
1184 int dump_node_label(FILE *F, ir_node *n) {
1187 bad |= dump_node_opcode(F, n);
1188 bad |= dump_node_mode(F, n);
1190 bad |= dump_node_typeinfo(F, n);
1191 bad |= dump_node_nodeattr(F, n);
1192 if(dump_node_idx_labels) {
1193 fprintf(F, "%ld:%d", get_irn_node_nr(n), get_irn_idx(n));
1195 fprintf(F, "%ld", get_irn_node_nr(n));
1202 * Dumps the attributes of a node n into the file F.
1203 * Currently this is only the color of a node.
1205 static void dump_node_vcgattr(FILE *F, ir_node *node, ir_node *local, int bad)
1211 print_vcg_color(F, ird_color_error);
1215 if (dump_node_vcgattr_hook)
1216 if (dump_node_vcgattr_hook(F, node, local))
1219 n = local ? local : node;
1221 if (overrule_nodecolor != ird_color_default_node) {
1222 print_vcg_color(F, overrule_nodecolor);
1226 mode = get_irn_mode(n);
1227 if(mode == mode_M) {
1228 print_vcg_color(F, ird_color_memory);
1231 if(mode == mode_X) {
1232 print_vcg_color(F, ird_color_controlflow);
1236 switch (get_irn_opcode(n)) {
1241 print_vcg_color(F, ird_color_anchor);
1244 print_vcg_color(F, ird_color_error);
1247 if (is_Block_dead(n))
1248 print_vcg_color(F, ird_color_dead_block_background);
1250 print_vcg_color(F, ird_color_block_background);
1253 print_vcg_color(F, ird_color_phi);
1256 print_vcg_color(F, ird_color_memory);
1260 print_vcg_color(F, ird_color_const);
1263 print_vcg_color(F, ird_color_proj);
1266 ir_op *op = get_irn_op(node);
1268 if(is_op_constlike(op)) {
1269 print_vcg_color(F, ird_color_const);
1270 } else if(is_op_uses_memory(op)) {
1271 print_vcg_color(F, ird_color_uses_memory);
1272 } else if(is_op_cfopcode(op) || is_op_forking(op)) {
1273 print_vcg_color(F, ird_color_controlflow);
1275 PRINT_DEFAULT_NODE_ATTR;
1281 /* Adds a new node info dumper callback. */
1282 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data)
1284 hook_entry_t *info = XMALLOC(hook_entry_t);
1286 info->hook._hook_node_info = cb;
1287 info->context = data;
1288 register_hook(hook_node_info, info);
1293 /* Remove a previously added info dumper callback. */
1294 void dump_remv_node_info_callback(void *handle)
1296 hook_entry_t *info = handle;
1297 unregister_hook(hook_node_info, info);
1302 * Dump the node information of a node n to a file F.
1304 static inline int dump_node_info(FILE *F, ir_node *n)
1307 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1309 fprintf(F, " info1: \"");
1310 bad = dump_irnode_to_file(F, n);
1311 /* call the dump_node operation if available */
1313 bad = ops->dump_node(n, F, dump_node_info_txt);
1315 /* allow additional info to be added */
1316 hook_node_info(F, n);
1322 static inline int is_constlike_node(const ir_node *node)
1324 const ir_op *op = get_irn_op(node);
1325 return is_op_constlike(op);
1329 /** outputs the predecessors of n, that are constants, local. I.e.,
1330 generates a copy of the constant predecessors for each node called with. */
1331 static void dump_const_node_local(FILE *F, ir_node *n) {
1333 if (!get_opt_dump_const_local()) return;
1335 /* Use visited flag to avoid outputting nodes twice.
1336 initialize it first. */
1337 for (i = 0; i < get_irn_arity(n); i++) {
1338 ir_node *con = get_irn_n(n, i);
1339 if (is_constlike_node(con)) {
1340 set_irn_visited(con, get_irg_visited(current_ir_graph) - 1);
1344 for (i = 0; i < get_irn_arity(n); i++) {
1345 ir_node *con = get_irn_n(n, i);
1346 if (is_constlike_node(con) && !irn_visited(con)) {
1349 mark_irn_visited(con);
1350 /* Generate a new name for the node by appending the names of
1352 fprintf(F, "node: {title: "); PRINT_CONSTID(n, con);
1353 fprintf(F, " label: \"");
1354 bad |= dump_node_label(F, con);
1356 bad |= dump_node_info(F, con);
1357 dump_node_vcgattr(F, n, con, bad);
1363 /** If the block of an edge is a const_like node, dump it local with an edge */
1364 static void dump_const_block_local(FILE *F, ir_node *n) {
1367 if (!get_opt_dump_const_local()) return;
1369 blk = get_nodes_block(n);
1370 if (is_constlike_node(blk)) {
1373 /* Generate a new name for the node by appending the names of
1375 fprintf(F, "node: {title: \""); PRINT_CONSTBLKID(n, blk);
1376 fprintf(F, "\" label: \"");
1377 bad |= dump_node_label(F, blk);
1379 bad |= dump_node_info(F, blk);
1380 dump_node_vcgattr(F, n, blk, bad);
1383 fprintf(F, "edge: { sourcename: \"");
1385 fprintf(F, "\" targetname: \""); PRINT_CONSTBLKID(n,blk);
1387 if (dump_edge_vcgattr_hook) {
1389 if (dump_edge_vcgattr_hook(F, n, -1)) {
1393 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1398 fprintf(F, "\" " BLOCK_EDGE_ATTR "}\n");
1403 * prints the error message of a node to a file F as info2.
1405 static void print_node_error(FILE *F, const char *err_msg)
1410 fprintf(F, " info2: \"%s\"", err_msg);
1414 * prints debug messages of a node to file F as info3.
1416 static void print_dbg_info(FILE *F, dbg_info *dbg)
1420 if (__dbg_info_snprint) {
1422 if (__dbg_info_snprint(buf, sizeof(buf), dbg) > 0)
1423 fprintf(F, " info3: \"%s\"\n", buf);
1430 static void dump_node(FILE *F, ir_node *n)
1435 if (get_opt_dump_const_local() && is_constlike_node(n))
1438 /* dump this node */
1439 fputs("node: {title: \"", F);
1443 fputs(" label: \"", F);
1444 bad = ! irn_vrfy_irg_dump(n, current_ir_graph, &p);
1445 bad |= dump_node_label(F, n);
1446 dump_node_ana_vals(F, n);
1447 //dump_node_ana_info(F, n);
1450 if (get_op_flags(get_irn_op(n)) & irop_flag_dump_noinput) {
1451 //fputs(" node_class:23", F);
1454 bad |= dump_node_info(F, n);
1455 print_node_error(F, p);
1456 print_dbg_info(F, get_irn_dbg_info(n));
1457 dump_node_vcgattr(F, n, NULL, bad);
1459 dump_const_node_local(F, n);
1461 if(dump_node_edge_hook)
1462 dump_node_edge_hook(F, n);
1465 /** dump the edge to the block this node belongs to */
1467 dump_ir_block_edge(FILE *F, ir_node *n) {
1468 if (get_opt_dump_const_local() && is_constlike_node(n)) return;
1469 if (is_no_Block(n)) {
1470 ir_node *block = get_nodes_block(n);
1472 if (get_opt_dump_const_local() && is_constlike_node(block)) {
1473 dump_const_block_local(F, n);
1475 fprintf(F, "edge: { sourcename: \"");
1477 fprintf(F, "\" targetname: ");
1478 fprintf(F, "\""); PRINT_NODEID(block); fprintf(F, "\"");
1480 if (dump_edge_vcgattr_hook) {
1482 if (dump_edge_vcgattr_hook(F, n, -1)) {
1486 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1491 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1497 print_data_edge_vcgattr(FILE *F, ir_node *from, int to) {
1499 * do not use get_nodes_block() here, will fail
1500 * if the irg is not pinned.
1502 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1503 fprintf(F, INTRA_DATA_EDGE_ATTR);
1505 fprintf(F, INTER_DATA_EDGE_ATTR);
1509 print_mem_edge_vcgattr(FILE *F, ir_node *from, int to) {
1511 * do not use get_nodes_block() here, will fail
1512 * if the irg is not pinned.
1514 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1515 fprintf(F, INTRA_MEM_EDGE_ATTR);
1517 fprintf(F, INTER_MEM_EDGE_ATTR);
1520 /** Print the vcg attributes for the edge from node from to it's to's input */
1521 static void print_edge_vcgattr(FILE *F, ir_node *from, int to) {
1524 if (dump_edge_vcgattr_hook)
1525 if (dump_edge_vcgattr_hook(F, from, to))
1528 if (dump_backedge_information_flag && is_backedge(from, to))
1529 fprintf(F, BACK_EDGE_ATTR);
1531 switch (get_irn_opcode(from)) {
1533 fprintf(F, CF_EDGE_ATTR);
1535 case iro_Start: break;
1538 if (get_irn_mode(get_End_keepalive(from, to)) == mode_BB)
1539 fprintf(F, KEEP_ALIVE_CF_EDGE_ATTR);
1541 fprintf(F, KEEP_ALIVE_DF_EDGE_ATTR);
1545 if (is_Proj(from)) {
1546 if (get_irn_mode(from) == mode_M)
1547 print_mem_edge_vcgattr(F, from, to);
1548 else if (get_irn_mode(from) == mode_X)
1549 fprintf(F, CF_EDGE_ATTR);
1551 print_data_edge_vcgattr(F, from, to);
1553 else if (get_irn_mode(get_irn_n(from, to)) == mode_M)
1554 print_mem_edge_vcgattr(F, from, to);
1555 else if (get_irn_mode(get_irn_n(from, to)) == mode_X)
1556 fprintf(F, CF_EDGE_ATTR);
1558 print_data_edge_vcgattr(F, from, to);
1562 /** dump edges to our inputs */
1563 static void dump_ir_data_edges(FILE *F, ir_node *n) {
1565 ir_visited_t visited = get_irn_visited(n);
1567 if (!dump_keepalive && is_End(n)) {
1568 /* the End node has only keep-alive edges */
1572 /* dump the dependency edges. */
1573 num = get_irn_deps(n);
1574 for (i = 0; i < num; ++i) {
1575 ir_node *dep = get_irn_dep(n, i);
1578 fprintf(F, "edge: {sourcename: \"");
1580 fprintf(F, "\" targetname: ");
1581 if ((get_opt_dump_const_local()) && is_constlike_node(dep)) {
1582 PRINT_CONSTID(n, dep);
1588 fprintf(F, " label: \"%d\" ", i);
1589 fprintf(F, " color: darkgreen}\n");
1593 num = get_irn_arity(n);
1594 for (i = 0; i < num; i++) {
1595 ir_node *pred = get_irn_n(n, i);
1598 if ((get_interprocedural_view() && get_irn_visited(pred) < visited))
1599 continue; /* pred not dumped */
1601 if (dump_backedge_information_flag && is_backedge(n, i))
1602 fprintf(F, "backedge: {sourcename: \"");
1604 fprintf(F, "edge: {sourcename: \"");
1606 fprintf(F, "\" targetname: ");
1607 if ((get_opt_dump_const_local()) && is_constlike_node(pred)) {
1608 PRINT_CONSTID(n, pred);
1610 fprintf(F, "\""); PRINT_NODEID(pred); fprintf(F, "\"");
1612 fprintf(F, " label: \"%d\" ", i);
1613 print_edge_vcgattr(F, n, i);
1617 if (dump_macro_block_edges && is_Block(n)) {
1618 ir_node *mb = get_Block_MacroBlock(n);
1619 fprintf(F, "edge: {sourcename: \"");
1621 fprintf(F, "\" targetname: \"");
1623 fprintf(F, "\" label: \"mb\" " MACROBLOCK_EDGE_ATTR);
1632 dump_ir_edges(FILE *F, ir_node *n) {
1633 const ir_edge_t *edge;
1636 foreach_out_edge(n, edge) {
1637 ir_node *succ = get_edge_src_irn(edge);
1639 fprintf(F, "edge: {sourcename: \"");
1641 fprintf(F, "\" targetname: \"");
1645 fprintf(F, " label: \"%d\" ", i);
1646 fprintf(F, OUT_EDGE_ATTR);
1653 /** Dumps a node and its edges but not the block edge */
1654 static void dump_node_wo_blockedge(ir_node *n, void *env) {
1657 dump_ir_data_edges(F, n);
1660 /** Dumps a node and its edges. */
1661 static void dump_whole_node(ir_node *n, void *env) {
1663 dump_node_wo_blockedge(n, env);
1664 if (!node_floats(n))
1665 dump_ir_block_edge(F, n);
1666 if (dump_new_edges_flag && edges_activated(current_ir_graph))
1667 dump_ir_edges(F, n);
1670 /** Dumps a const-like node. */
1671 static void dump_const_node(ir_node *n, void *env) {
1672 if (is_Block(n)) return;
1673 dump_node_wo_blockedge(n, env);
1676 /***********************************************************************/
1677 /* the following routines dump the nodes/irgs bracketed to graphs. */
1678 /***********************************************************************/
1680 /** Dumps a constant expression as entity initializer, array bound ...
1682 static void dump_const_expression(FILE *F, ir_node *value) {
1683 ir_graph *rem = current_ir_graph;
1684 int rem_dump_const_local = dump_const_local;
1685 dump_const_local = 0;
1686 current_ir_graph = get_const_code_irg();
1687 irg_walk(value, dump_const_node, NULL, F);
1688 /* Decrease visited flag so that we walk with the same flag for the next
1689 expression. This guarantees that we don't dump the same node twice,
1690 as for const expressions cse is performed to save memory. */
1691 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph) -1);
1692 current_ir_graph = rem;
1693 dump_const_local = rem_dump_const_local;
1696 /** Dump a block as graph containing its nodes.
1698 * Expects to find nodes belonging to the block as list in its
1700 * Dumps the edges of all nodes including itself. */
1701 static void dump_whole_block(FILE *F, ir_node *block) {
1703 ird_color_t color = ird_color_block_background;
1705 assert(is_Block(block));
1707 fprintf(F, "graph: { title: \"");
1708 PRINT_NODEID(block);
1709 fprintf(F, "\" label: \"");
1710 dump_node_label(F, block);
1712 /* colorize blocks */
1713 if (! get_Block_matured(block))
1714 color = ird_color_block_background;
1715 if (is_Block_dead(block))
1716 color = ird_color_dead_block_background;
1718 fprintf(F, "\" status:clustered ");
1719 print_vcg_color(F, color);
1722 /* yComp can show attributes for blocks, XVCG parses but ignores them */
1723 dump_node_info(F, block);
1724 print_dbg_info(F, get_irn_dbg_info(block));
1726 /* dump the blocks edges */
1727 dump_ir_data_edges(F, block);
1729 if (dump_block_edge_hook)
1730 dump_block_edge_hook(F, block);
1732 /* dump the nodes that go into the block */
1733 for (node = ird_get_irn_link(block); node; node = ird_get_irn_link(node)) {
1735 dump_ir_data_edges(F, node);
1738 /* Close the vcg information for the block */
1740 dump_const_node_local(F, block);
1744 /** dumps a graph block-wise. Expects all blockless nodes in arr in irgs link.
1745 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1747 dump_block_graph(FILE *F, ir_graph *irg) {
1749 ir_graph *rem = current_ir_graph;
1750 ir_node **arr = ird_get_irg_link(irg);
1751 current_ir_graph = irg;
1753 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1754 ir_node * node = arr[i];
1755 if (is_Block(node)) {
1756 /* Dumps the block and all the nodes in the block, which are to
1757 be found in Block->link. */
1758 dump_whole_block(F, node);
1760 /* Nodes that are not in a Block. */
1762 if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
1763 dump_const_block_local(F, node);
1765 dump_ir_data_edges(F, node);
1767 if (dump_new_edges_flag && edges_activated(irg))
1768 dump_ir_edges(F, node);
1771 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1772 dump_loop_nodes_into_graph(F, irg);
1774 current_ir_graph = rem;
1778 * Dump the info for an irg.
1779 * Parsed by XVCG but not shown. use yComp.
1781 static void dump_graph_info(FILE *F, ir_graph *irg) {
1782 fprintf(F, "info1: \"");
1783 dump_entity_to_file(F, get_irg_entity(irg), dump_verbosity_entattrs | dump_verbosity_entconsts);
1787 /** Dumps an irg as a graph clustered by block nodes.
1788 * If interprocedural view edges can point to nodes out of this graph.
1790 static void dump_graph_from_list(FILE *F, ir_graph *irg) {
1791 ir_entity *ent = get_irg_entity(irg);
1793 fprintf(F, "graph: { title: \"");
1795 fprintf(F, "\" label: \"%s\" status:clustered color:%s \n",
1796 get_ent_dump_name(ent), color_names[ird_color_prog_background]);
1798 dump_graph_info(F, irg);
1799 print_dbg_info(F, get_entity_dbg_info(ent));
1801 dump_block_graph(F, irg);
1803 /* Close the vcg information for the irg */
1804 fprintf(F, "}\n\n");
1807 /** dumps a graph extended block-wise. Expects all blockless nodes in arr in irgs link.
1808 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1810 dump_extblock_graph(FILE *F, ir_graph *irg) {
1812 ir_graph *rem = current_ir_graph;
1813 ir_extblk **arr = ird_get_irg_link(irg);
1814 current_ir_graph = irg;
1816 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1817 ir_extblk *extbb = arr[i];
1818 ir_node *leader = get_extbb_leader(extbb);
1821 fprintf(F, "graph: { title: \"");
1822 PRINT_EXTBBID(leader);
1823 fprintf(F, "\" label: \"ExtBB %ld\" status:clustered color:lightgreen\n",
1824 get_irn_node_nr(leader));
1826 for (j = ARR_LEN(extbb->blks) - 1; j >= 0; --j) {
1827 ir_node * node = extbb->blks[j];
1828 if (is_Block(node)) {
1829 /* Dumps the block and all the nodes in the block, which are to
1830 be found in Block->link. */
1831 dump_whole_block(F, node);
1833 /* Nodes that are not in a Block. */
1835 if (is_Bad(get_nodes_block(node)) && !node_floats(node)) {
1836 dump_const_block_local(F, node);
1838 dump_ir_data_edges(F, node);
1844 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1845 dump_loop_nodes_into_graph(F, irg);
1847 current_ir_graph = rem;
1852 /*******************************************************************/
1853 /* Basic type and entity nodes and edges. */
1854 /*******************************************************************/
1856 /** dumps the edges between nodes and their type or entity attributes. */
1857 static void dump_node2type_edges(ir_node *n, void *env)
1862 switch (get_irn_opcode(n)) {
1864 /* @@@ some consts have an entity */
1867 if (SYMCONST_HAS_TYPE(get_SymConst_kind(n)))
1868 print_node_type_edge(F,n,get_SymConst_type(n),NODE2TYPE_EDGE_ATTR);
1871 print_node_ent_edge(F,n,get_Sel_entity(n),NODE2TYPE_EDGE_ATTR);
1874 print_node_type_edge(F,n,get_Call_type(n),NODE2TYPE_EDGE_ATTR);
1877 print_node_type_edge(F,n,get_Alloc_type(n),NODE2TYPE_EDGE_ATTR);
1880 print_node_type_edge(F,n,get_Free_type(n),NODE2TYPE_EDGE_ATTR);
1883 print_node_type_edge(F,n,get_Cast_type(n),NODE2TYPE_EDGE_ATTR);
1891 static int print_type_info(FILE *F, ir_type *tp) {
1894 if (get_type_state(tp) == layout_undefined) {
1895 fprintf(F, "state: layout_undefined\n");
1897 fprintf(F, "state: layout_fixed,\n");
1899 if (get_type_mode(tp))
1900 fprintf(F, "mode: %s,\n", get_mode_name_ex(get_type_mode(tp), &bad));
1901 fprintf(F, "size: %db,\n", get_type_size_bits(tp));
1906 static void print_typespecific_info(FILE *F, ir_type *tp) {
1907 switch (get_type_tpop_code(tp)) {
1909 fprintf(F, "peculiarity: %s\n", get_peculiarity_string(get_class_peculiarity(tp)));
1914 fprintf(F, "variadicity: %s\n", get_variadicity_name(get_method_variadicity(tp)));
1915 fprintf(F, "params: %d\n", get_method_n_params(tp));
1916 fprintf(F, "results: %d\n", get_method_n_ress(tp));
1922 case tpo_enumeration:
1934 static void print_typespecific_vcgattr(FILE *F, ir_type *tp) {
1935 switch (get_type_tpop_code(tp)) {
1937 if (peculiarity_existent == get_class_peculiarity(tp))
1938 fprintf(F, " " TYPE_CLASS_NODE_ATTR);
1940 fprintf(F, " " TYPE_DESCRIPTION_NODE_ATTR);
1943 fprintf(F, " " TYPE_METH_NODE_ATTR);
1951 case tpo_enumeration:
1963 int dump_type_node(FILE *F, ir_type *tp)
1967 fprintf(F, "node: {title: ");
1969 fprintf(F, " label: \"%s %s\"", get_type_tpop_name(tp), get_type_name_ex(tp, &bad));
1970 fprintf(F, " info1: \"");
1972 bad |= print_type_info(F, tp);
1973 print_typespecific_info(F, tp);
1975 dump_type_to_file(F, tp, dump_verbosity_max);
1978 print_dbg_info(F, get_type_dbg_info(tp));
1979 print_typespecific_vcgattr(F, tp);
1986 void dump_entity_node(FILE *F, ir_entity *ent)
1988 fprintf(F, "node: {title: \"");
1989 PRINT_ENTID(ent); fprintf(F, "\"");
1990 fprintf(F, DEFAULT_TYPE_ATTRIBUTE);
1991 fprintf(F, "label: ");
1992 fprintf(F, "\"%s\" ", get_ent_dump_name(ent));
1994 print_vcg_color(F, ird_color_entity);
1995 fprintf(F, "\n info1: \"");
1997 dump_entity_to_file(F, ent, dump_verbosity_entattrs | dump_verbosity_entconsts);
2000 print_dbg_info(F, get_entity_dbg_info(ent));
2004 static void dump_enum_item(FILE *F, ir_type *tp, int pos)
2007 ir_enum_const *ec = get_enumeration_const(tp, pos);
2008 ident *id = get_enumeration_nameid(ec);
2009 tarval *tv = get_enumeration_value(ec);
2012 tarval_snprintf(buf, sizeof(buf), tv);
2014 strncpy(buf, "<not set>", sizeof(buf));
2015 fprintf(F, "node: {title: \"");
2016 PRINT_ITEMID(tp, pos); fprintf(F, "\"");
2017 fprintf(F, DEFAULT_ENUM_ITEM_ATTRIBUTE);
2018 fprintf(F, "label: ");
2019 fprintf(F, "\"enum item %s\" " ENUM_ITEM_NODE_ATTR, get_id_str(id));
2020 fprintf(F, "\n info1: \"value: %s\"}\n", buf);
2023 /* dumps a type or entity and it's edges. */
2025 dump_type_info(type_or_ent tore, void *env) {
2027 int i = 0; /* to shutup gcc */
2029 /* dump this type or entity */
2031 switch (get_kind(tore.ent)) {
2033 ir_entity *ent = tore.ent;
2036 dump_entity_node(F, ent);
2038 /* skip this to reduce graph. Member edge of type is parallel to this edge. *
2039 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2040 ENT_OWN_EDGE_ATTR "}\n", ent, get_entity_owner(ent));*/
2041 print_ent_type_edge(F,ent, get_entity_type(ent), ENT_TYPE_EDGE_ATTR);
2042 if (is_Class_type(get_entity_owner(ent))) {
2043 for(i = 0; i < get_entity_n_overwrites(ent); i++)
2044 print_ent_ent_edge(F,ent, get_entity_overwrites(ent, i), 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2046 /* attached subgraphs */
2047 if (const_entities && (get_entity_variability(ent) != variability_uninitialized)) {
2048 if (is_atomic_entity(ent)) {
2049 value = get_atomic_ent_value(ent);
2051 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2052 /* DDMN(value); $$$ */
2053 dump_const_expression(F, value);
2056 if (is_compound_entity(ent)) {
2057 if (has_entity_initializer(ent)) {
2058 /* new style initializers */
2060 /* old style compound entity values */
2061 for (i = 0; i < get_compound_ent_n_values(ent); i++) {
2062 value = get_compound_ent_value(ent, i);
2064 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2065 dump_const_expression(F, value);
2066 print_ent_ent_edge(F, ent, get_compound_ent_value_member(ent, i), 0, -1, ENT_CORR_EDGE_ATTR, i);
2068 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2069 ENT_CORR_EDGE_ATTR "}\n", GET_ENTID(ent),
2070 get_compound_ent_value_member(ent, i), i);
2080 ir_type *tp = tore.typ;
2081 dump_type_node(F, tp);
2082 /* and now the edges */
2083 switch (get_type_tpop_code(tp)) {
2085 for (i=0; i < get_class_n_supertypes(tp); i++)
2086 print_type_type_edge(F, tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2087 for (i=0; i < get_class_n_members(tp); i++)
2088 print_type_ent_edge(F,tp,get_class_member(tp, i),TYPE_MEMBER_EDGE_ATTR);
2091 for (i=0; i < get_struct_n_members(tp); i++)
2092 print_type_ent_edge(F,tp,get_struct_member(tp, i),TYPE_MEMBER_EDGE_ATTR);
2095 for (i = 0; i < get_method_n_params(tp); i++)
2096 print_type_type_edge(F,tp,get_method_param_type(tp, i),METH_PAR_EDGE_ATTR,i);
2097 for (i = 0; i < get_method_n_ress(tp); i++)
2098 print_type_type_edge(F,tp,get_method_res_type(tp, i),METH_RES_EDGE_ATTR,i);
2101 for (i = 0; i < get_union_n_members(tp); i++)
2102 print_type_ent_edge(F,tp,get_union_member(tp, i),UNION_EDGE_ATTR);
2105 print_type_type_edge(F,tp,get_array_element_type(tp),ARR_ELT_TYPE_EDGE_ATTR);
2106 print_type_ent_edge(F,tp,get_array_element_entity(tp),ARR_ENT_EDGE_ATTR);
2107 for (i = 0; i < get_array_n_dimensions(tp); i++) {
2108 ir_node *upper = get_array_upper_bound(tp, i);
2109 ir_node *lower = get_array_lower_bound(tp, i);
2110 print_node_type_edge(F, upper, tp, "label: \"upper %d\"", get_array_order(tp, i));
2111 print_node_type_edge(F, lower, tp, "label: \"lower %d\"", get_array_order(tp, i));
2112 dump_const_expression(F, upper);
2113 dump_const_expression(F, lower);
2116 case tpo_enumeration:
2117 for (i = 0; i < get_enumeration_n_enums(tp); ++i) {
2118 dump_enum_item(F, tp, i);
2119 print_enum_item_edge(F, tp, i, "label: \"item %d\"", i);
2123 print_type_type_edge(F,tp,get_pointer_points_to_type(tp), PTR_PTS_TO_EDGE_ATTR);
2130 break; /* case k_type */
2133 printf(" *** irdump, dump_type_info(l.%i), faulty type.\n", __LINE__);
2134 } /* switch kind_or_entity */
2137 typedef struct _h_env {
2142 /** For dumping class hierarchies.
2143 * Dumps a class type node and a superclass edge.
2144 * If env->dump_ent dumps entities of classes and overwrites edges.
2147 dump_class_hierarchy_node(type_or_ent tore, void *ctx) {
2150 int i = 0; /* to shutup gcc */
2152 /* dump this type or entity */
2153 switch (get_kind(tore.ent)) {
2155 ir_entity *ent = tore.ent;
2156 if (get_entity_owner(ent) == get_glob_type()) break;
2157 if (!is_Method_type(get_entity_type(ent)))
2159 if (env->dump_ent && is_Class_type(get_entity_owner(ent))) {
2161 dump_entity_node(F, ent);
2163 print_type_ent_edge(F,get_entity_owner(ent),ent,TYPE_MEMBER_EDGE_ATTR);
2164 for(i = 0; i < get_entity_n_overwrites(ent); i++)
2165 print_ent_ent_edge(F, get_entity_overwrites(ent, i), ent, 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2170 ir_type *tp = tore.typ;
2171 if (tp == get_glob_type())
2173 switch (get_type_tpop_code(tp)) {
2175 dump_type_node(F, tp);
2176 /* and now the edges */
2177 for (i=0; i < get_class_n_supertypes(tp); i++) {
2178 print_type_type_edge(F,tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2183 break; /* case k_type */
2186 printf(" *** irdump, dump_class_hierarchy_node(l.%i), faulty type.\n", __LINE__);
2187 } /* switch kind_or_entity */
2190 /*******************************************************************/
2191 /* dump analysis information that is expressed in graph terms. */
2192 /*******************************************************************/
2194 /* dump out edges */
2196 dump_out_edge(ir_node *n, void *env) {
2199 for (i = 0; i < get_irn_n_outs(n); i++) {
2200 assert(get_irn_out(n, i));
2201 fprintf(F, "edge: {sourcename: \"");
2203 fprintf(F, "\" targetname: \"");
2204 PRINT_NODEID(get_irn_out(n, i));
2205 fprintf(F, "\" color: red linestyle: dashed");
2211 dump_loop_label(FILE *F, ir_loop *loop) {
2212 fprintf(F, "loop %d, %d sons, %d nodes",
2213 get_loop_depth(loop), get_loop_n_sons(loop), get_loop_n_nodes(loop));
2216 static inline void dump_loop_info(FILE *F, ir_loop *loop) {
2217 fprintf(F, " info1: \"");
2218 fprintf(F, " loop nr: %d", get_loop_loop_nr(loop));
2219 #ifdef DEBUG_libfirm /* GL @@@ debug analyses */
2220 fprintf(F, "\n The loop was analyzed %d times.", PTR_TO_INT(get_loop_link(loop)));
2226 dump_loop_node(FILE *F, ir_loop *loop) {
2227 fprintf(F, "node: {title: \"");
2229 fprintf(F, "\" label: \"");
2230 dump_loop_label(F, loop);
2232 dump_loop_info(F, loop);
2237 dump_loop_node_edge(FILE *F, ir_loop *loop, int i) {
2239 fprintf(F, "edge: {sourcename: \"");
2241 fprintf(F, "\" targetname: \"");
2242 PRINT_NODEID(get_loop_node(loop, i));
2243 fprintf(F, "\" color: green");
2248 dump_loop_son_edge(FILE *F, ir_loop *loop, int i) {
2250 fprintf(F, "edge: {sourcename: \"");
2252 fprintf(F, "\" targetname: \"");
2253 PRINT_LOOPID(get_loop_son(loop, i));
2254 fprintf(F, "\" color: darkgreen label: \"%d\"}\n",
2255 get_loop_element_pos(loop, get_loop_son(loop, i)));
2259 void dump_loops(FILE *F, ir_loop *loop) {
2261 /* dump this loop node */
2262 dump_loop_node(F, loop);
2264 /* dump edges to nodes in loop -- only if it is a real loop */
2265 if (get_loop_depth(loop) != 0) {
2266 for (i = 0; i < get_loop_n_nodes(loop); i++) {
2267 dump_loop_node_edge(F, loop, i);
2270 for (i = 0; i < get_loop_n_sons(loop); i++) {
2271 dump_loops(F, get_loop_son(loop, i));
2272 dump_loop_son_edge(F, loop, i);
2277 void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg) {
2278 ir_graph *rem = current_ir_graph;
2279 current_ir_graph = irg;
2281 if (get_irg_loop(irg)) dump_loops(F, get_irg_loop(irg));
2283 current_ir_graph = rem;
2288 * dumps the VCG header
2290 void dump_vcg_header(FILE *F, const char *name, const char *layout, const char *orientation) {
2296 label = edge_label ? "yes" : "no";
2297 if (! layout) layout = "Compilergraph";
2298 if (!orientation) orientation = "bottom_to_top";
2302 "graph: { title: \"ir graph of %s\"\n"
2303 "display_edge_labels: %s\n"
2304 "layoutalgorithm: mindepth //$ \"%s\"\n"
2305 "manhattan_edges: yes\n"
2306 "port_sharing: no\n"
2308 "classname 1: \"intrablock Data\"\n"
2309 "classname 2: \"Block\"\n"
2310 "classname 3: \"Entity type\"\n"
2311 "classname 4: \"Entity owner\"\n"
2312 "classname 5: \"Method Param\"\n"
2313 "classname 6: \"Method Res\"\n"
2314 "classname 7: \"Super\"\n"
2315 "classname 8: \"Union\"\n"
2316 "classname 9: \"Points-to\"\n"
2317 "classname 10: \"Array Element Type\"\n"
2318 "classname 11: \"Overwrites\"\n"
2319 "classname 12: \"Member\"\n"
2320 "classname 13: \"Control Flow\"\n"
2321 "classname 14: \"intrablock Memory\"\n"
2322 "classname 15: \"Dominators\"\n"
2323 "classname 16: \"interblock Data\"\n"
2324 "classname 17: \"interblock Memory\"\n"
2325 "classname 18: \"Exception Control Flow for Interval Analysis\"\n"
2326 "classname 19: \"Postdominators\"\n"
2327 "classname 20: \"Keep Alive\"\n"
2328 "classname 21: \"Out Edges\"\n"
2329 "classname 22: \"Macro Block Edges\"\n"
2330 //"classname 23: \"NoInput Nodes\"\n"
2331 "infoname 1: \"Attribute\"\n"
2332 "infoname 2: \"Verification errors\"\n"
2333 "infoname 3: \"Debug info\"\n",
2334 name, label, layout, orientation);
2336 for (i = 0; i < ird_color_count; ++i) {
2337 if (color_rgb[i] != NULL) {
2338 fprintf(F, "colorentry %s: %s\n", color_names[i], color_rgb[i]);
2341 fprintf(F, "\n"); /* a separator */
2347 * @param irg The graph to be dumped
2348 * @param suffix1 first filename suffix
2349 * @param suffix2 second filename suffix
2351 FILE *vcg_open(ir_graph *irg, const char * suffix1, const char *suffix2) {
2353 const char *nm = get_irg_dump_name(irg);
2354 int len = strlen(nm), i, j;
2355 char *fname; /* filename to put the vcg information in */
2357 if (!suffix1) suffix1 = "";
2358 if (!suffix2) suffix2 = "";
2360 /* open file for vcg graph */
2361 fname = XMALLOCN(char, len * 2 + strlen(suffix1) + strlen(suffix2) + 5);
2363 /* strncpy (fname, nm, len); */ /* copy the filename */
2365 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2367 fname[j] = '@'; j++; fname[j] = '1'; j++;
2368 } else if (nm[i] == '@') {
2369 fname[j] = '@'; j++; fname[j] = '2'; j++;
2371 fname[j] = nm[i]; j++;
2375 strcat(fname, suffix1); /* append file suffix */
2376 strcat(fname, suffix2); /* append file suffix */
2377 strcat(fname, ".vcg"); /* append the .vcg suffix */
2379 /* vcg really expect only a <CR> at end of line, so
2380 * the "b"inary mode is what you mean (and even needed for Win32)
2382 F = fopen(fname, "wb"); /* open file for writing */
2394 * @param name prefix file name
2395 * @param suffix filename suffix
2397 FILE *vcg_open_name(const char *name, const char *suffix) {
2399 char *fname; /* filename to put the vcg information in */
2400 int i, j, len = strlen(name);
2402 if (!suffix) suffix = "";
2404 /** open file for vcg graph */
2405 fname = XMALLOCN(char, len * 2 + 5 + strlen(suffix));
2406 /* strcpy (fname, name);*/ /* copy the filename */
2408 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2409 if (name[i] == '/') {
2410 fname[j] = '@'; j++; fname[j] = '1'; j++;
2411 } else if (name[i] == '@') {
2412 fname[j] = '@'; j++; fname[j] = '2'; j++;
2414 fname[j] = name[i]; j++;
2418 strcat(fname, suffix);
2419 strcat(fname, ".vcg"); /* append the .vcg suffix */
2421 /* vcg really expect only a <CR> at end of line, so
2422 * the "b"inary mode is what you mean (and even needed for Win32)
2424 F = fopen(fname, "wb"); /* open file for writing */
2434 * Dumps the vcg file footer
2436 void dump_vcg_footer(FILE *F) {
2440 /************************************************************************/
2441 /************************************************************************/
2442 /* Routines that dump all or parts of the firm representation to a file */
2443 /************************************************************************/
2444 /************************************************************************/
2446 /************************************************************************/
2447 /* Dump ir graphs, different formats and additional information. */
2448 /************************************************************************/
2450 typedef void (*do_dump_graph_func) (ir_graph *irg, FILE *out);
2452 static void do_dump(ir_graph *irg, const char *suffix, const char *suffix_ip,
2453 const char *suffix_nonip, do_dump_graph_func dump_func)
2457 const char *suffix1;
2459 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2462 rem = current_ir_graph;
2463 current_ir_graph = irg;
2464 if (get_interprocedural_view())
2465 suffix1 = suffix_ip;
2467 suffix1 = suffix_nonip;
2468 current_ir_graph = rem;
2470 out = vcg_open(irg, suffix, suffix1);
2472 dump_func(irg, out);
2477 void dump_ir_graph_file(ir_graph *irg, FILE *out)
2479 if (dump_backedge_information_flag
2480 && get_irg_loopinfo_state(irg) != loopinfo_consistent) {
2481 construct_backedges(irg);
2484 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2486 /* call the dump graph hook */
2487 if (dump_ir_graph_hook) {
2488 if (dump_ir_graph_hook(out, irg)) {
2493 /* walk over the graph */
2494 /* dump_whole_node must be called in post visiting predecessors */
2495 ird_walk_graph(irg, NULL, dump_whole_node, out);
2497 /* dump the out edges in a separate walk */
2498 if ((dump_out_edge_flag) && (get_irg_outs_state(irg) != outs_none)) {
2499 irg_out_walk(get_irg_start(irg), dump_out_edge, NULL, out);
2502 dump_vcg_footer(out);
2505 /** Routine to dump a graph, blocks as conventional nodes. */
2506 void dump_ir_graph(ir_graph *irg, const char *suffix )
2508 do_dump(irg, suffix, "-pure-ip", "-pure", dump_ir_graph_file);
2511 void dump_ir_block_graph_file(ir_graph *irg, FILE *out)
2515 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2517 construct_block_lists(irg);
2520 * If we are in the interprocedural view, we dump not
2521 * only the requested irg but also all irgs that can be reached
2524 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2525 ir_graph *g = get_irp_irg(i);
2526 ir_node **arr = ird_get_irg_link(g);
2528 dump_graph_from_list(out, g);
2533 dump_vcg_footer(out);
2536 /* Dump a firm graph without explicit block nodes. */
2537 void dump_ir_block_graph(ir_graph *irg, const char *suffix)
2539 do_dump(irg, suffix, "-ip", "", dump_ir_block_graph_file);
2542 void dump_ir_extblock_graph_file(ir_graph *irg, FILE *F)
2545 ir_entity *ent = get_irg_entity(irg);
2547 if (get_irg_extblk_state(irg) != extblk_valid)
2550 dump_vcg_header(F, get_irg_dump_name(irg), NULL, NULL);
2552 construct_extblock_lists(irg);
2554 fprintf(F, "graph: { title: \"");
2556 fprintf(F, "\" label: \"%s\" status:clustered color: white \n",
2557 get_ent_dump_name(ent));
2559 dump_graph_info(F, irg);
2560 print_dbg_info(F, get_entity_dbg_info(ent));
2562 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2563 ir_graph *irg = get_irp_irg(i);
2564 list_tuple *lists = ird_get_irg_link(irg);
2567 /* dump the extended blocks first */
2568 if (ARR_LEN(lists->extbb_list)) {
2569 ird_set_irg_link(irg, lists->extbb_list);
2570 dump_extblock_graph(F, irg);
2573 /* we may have blocks without extended blocks, bad for instance */
2574 if (ARR_LEN(lists->blk_list)) {
2575 ird_set_irg_link(irg, lists->blk_list);
2576 dump_block_graph(F, irg);
2579 DEL_ARR_F(lists->extbb_list);
2580 DEL_ARR_F(lists->blk_list);
2585 /* Close the vcg information for the irg */
2586 fprintf(F, "}\n\n");
2592 /* Dump a firm graph without explicit block nodes but grouped in extended blocks. */
2593 void dump_ir_extblock_graph(ir_graph *irg, const char *suffix)
2595 do_dump(irg, suffix, "-ip", "", dump_ir_extblock_graph_file);
2598 void dump_ir_graph_w_types_file(ir_graph *irg, FILE *out)
2600 ir_graph *rem = current_ir_graph;
2601 int rem_dump_const_local;
2603 rem = current_ir_graph;
2604 current_ir_graph = irg;
2605 rem_dump_const_local = dump_const_local;
2606 /* dumping types does not work with local nodes */
2607 dump_const_local = 0;
2609 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2611 /* dump common ir graph */
2612 irg_walk(get_irg_end(irg), NULL, dump_whole_node, out);
2613 /* dump type info */
2614 type_walk_irg(irg, dump_type_info, NULL, out);
2615 inc_irg_visited(get_const_code_irg());
2616 /* dump edges from graph to type info */
2617 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2619 dump_vcg_footer(out);
2620 dump_const_local = rem_dump_const_local;
2621 current_ir_graph = rem;
2624 /* dumps a graph with type information */
2625 void dump_ir_graph_w_types(ir_graph *irg, const char *suffix)
2627 do_dump(irg, suffix, "-pure-wtypes-ip", "-pure-wtypes",
2628 dump_ir_graph_w_types_file);
2631 void dump_ir_block_graph_w_types_file(ir_graph *irg, FILE *out)
2634 int rem_dump_const_local;
2635 ir_graph *rem = current_ir_graph;
2637 rem_dump_const_local = dump_const_local;
2638 /* dumping types does not work with local nodes */
2639 dump_const_local = 0;
2641 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2643 /* dump common blocked ir graph */
2644 construct_block_lists(irg);
2646 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2647 ir_node **arr = ird_get_irg_link(get_irp_irg(i));
2649 dump_graph_from_list(out, get_irp_irg(i));
2654 /* dump type info */
2655 current_ir_graph = irg;
2656 type_walk_irg(irg, dump_type_info, NULL, out);
2657 inc_irg_visited(get_const_code_irg());
2659 /* dump edges from graph to type info */
2660 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2662 dump_vcg_footer(out);
2663 dump_const_local = rem_dump_const_local;
2664 current_ir_graph = rem;
2667 void dump_ir_block_graph_w_types(ir_graph *irg, const char *suffix)
2669 do_dump(irg, suffix, "-wtypes-ip", "-wtypes",
2670 dump_ir_block_graph_w_types_file);
2673 /*---------------------------------------------------------------------*/
2674 /* The following routines dump a control flow graph. */
2675 /*---------------------------------------------------------------------*/
2678 dump_block_to_cfg(ir_node *block, void *env) {
2683 if (is_Block(block)) {
2684 /* This is a block. Dump a node for the block. */
2685 fprintf(F, "node: {title: \""); PRINT_NODEID(block);
2686 fprintf(F, "\" label: \"");
2687 if (block == get_irg_start_block(get_irn_irg(block)))
2688 fprintf(F, "Start ");
2689 if (block == get_irg_end_block(get_irn_irg(block)))
2692 fprintf(F, "%s ", get_op_name(get_irn_op(block)));
2693 PRINT_NODEID(block);
2695 fprintf(F, "info1:\"");
2697 /* the generic version. */
2698 dump_irnode_to_file(F, block);
2700 /* Check whether we have bad predecessors to color the block. */
2701 for (i = 0; i < get_Block_n_cfgpreds(block); ++i)
2702 if ((fl = is_Bad(get_Block_cfgpred(block, i))))
2705 fprintf(F, "\""); /* closing quote of info */
2707 if ((block == get_irg_start_block(get_irn_irg(block))) ||
2708 (block == get_irg_end_block(get_irn_irg(block))) )
2709 fprintf(F, " color:blue ");
2711 fprintf(F, " color:yellow ");
2714 /* Dump the edges */
2715 for ( i = 0; i < get_Block_n_cfgpreds(block); i++)
2716 if (!is_Bad(skip_Proj(get_Block_cfgpred(block, i)))) {
2717 pred = get_nodes_block(skip_Proj(get_Block_cfgpred(block, i)));
2718 fprintf(F, "edge: { sourcename: \"");
2719 PRINT_NODEID(block);
2720 fprintf(F, "\" targetname: \"");
2722 fprintf(F, "\"}\n");
2725 /* Dump dominator/postdominator edge */
2726 if (dump_dominator_information_flag) {
2727 if (get_irg_dom_state(current_ir_graph) == dom_consistent && get_Block_idom(block)) {
2728 pred = get_Block_idom(block);
2729 fprintf(F, "edge: { sourcename: \"");
2730 PRINT_NODEID(block);
2731 fprintf(F, "\" targetname: \"");
2733 fprintf(F, "\" " DOMINATOR_EDGE_ATTR "}\n");
2735 if (get_irg_postdom_state(current_ir_graph) == dom_consistent && get_Block_ipostdom(block)) {
2736 pred = get_Block_ipostdom(block);
2737 fprintf(F, "edge: { sourcename: \"");
2738 PRINT_NODEID(block);
2739 fprintf(F, "\" targetname: \"");
2741 fprintf(F, "\" " POSTDOMINATOR_EDGE_ATTR "}\n");
2747 void dump_cfg(ir_graph *irg, const char *suffix)
2750 /* if a filter is set, dump only the irg's that match the filter */
2751 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2754 f = vcg_open(irg, suffix, "-cfg");
2756 ir_graph *rem = current_ir_graph;
2757 #ifdef INTERPROCEDURAL_VIEW
2758 int ipv = get_interprocedural_view();
2761 current_ir_graph = irg;
2762 dump_vcg_header(f, get_irg_dump_name(irg), NULL, NULL);
2764 #ifdef INTERPROCEDURAL_VIEW
2766 printf("Warning: dumping cfg not in interprocedural view!\n");
2767 set_interprocedural_view(0);
2771 /* walk over the blocks in the graph */
2772 irg_block_walk(get_irg_end(irg), dump_block_to_cfg, NULL, f);
2773 dump_node(f, get_irg_bad(irg));
2775 #ifdef INTERPROCEDURAL_VIEW
2776 set_interprocedural_view(ipv);
2780 current_ir_graph = rem;
2785 static void descend_and_dump(FILE *F, ir_node *n, int depth, pset *mark_set) {
2786 if (pset_find_ptr(mark_set, n)) return;
2788 pset_insert_ptr(mark_set, n);
2791 int i, start = is_Block(n) ? 0 : -1;
2792 dump_whole_node(n, F);
2793 for (i = start; i < get_irn_arity(n); ++i)
2794 descend_and_dump(F, get_irn_n(n, i), depth-1, mark_set);
2797 /* Don't dump edges to nodes further out. These might be edges to
2798 nodes we already dumped, if there is a shorter path to these. */
2802 static int subgraph_counter = 0;
2803 void dump_subgraph(ir_node *root, int depth, const char *suffix) {
2807 sprintf(buf, "-subg_%03d", subgraph_counter++);
2808 F = vcg_open(get_irn_irg(root), suffix, buf);
2810 pset *mark_set = pset_new_ptr(1);
2811 dump_vcg_header(F, get_irg_dump_name(get_irn_irg(root)), NULL, NULL);
2812 descend_and_dump(F, root, depth, mark_set);
2819 void dump_callgraph(const char *suffix) {
2820 FILE *F = vcg_open_name("Callgraph", suffix);
2823 int i, rem = edge_label;
2826 dump_vcg_header(F, "Callgraph", "Hierarchiv", NULL);
2828 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2829 ir_graph *irg = get_irp_irg(i);
2830 ir_entity *ent = get_irg_entity(irg);
2832 int n_callees = get_irg_n_callees(irg);
2834 dump_entity_node(F, ent);
2835 for (j = 0; j < n_callees; ++j) {
2836 ir_entity *c = get_irg_entity(get_irg_callee(irg, j));
2837 //if (id_is_prefix(prefix, get_entity_ld_ident(c))) continue;
2838 int be = is_irg_callee_backedge(irg, j);
2841 "label:\"recursion %d\"" :
2842 "label:\"calls %d\"";
2843 print_ent_ent_edge(F, ent, c, be, ird_color_entity, attr, get_irg_callee_loop_depth(irg, j));
2854 /* Dump all irgs in interprocedural view to a single file. */
2855 void dump_all_cg_block_graph(const char *suffix) {
2856 FILE *f = vcg_open_name("All_graphs", suffix);
2860 int rem_view = get_interprocedural_view();
2862 set_interprocedural_view(1);
2863 dump_vcg_header(f, "All_graphs", NULL);
2865 /* collect nodes in all irgs reachable in call graph*/
2866 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2867 ird_set_irg_link(get_irp_irg(i), NULL);
2869 cg_walk(clear_link, collect_node, NULL);
2871 /* dump all graphs */
2872 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2873 current_ir_graph = get_irp_irg(i);
2874 assert(ird_get_irg_link(current_ir_graph));
2875 dump_graph_from_list(f, current_ir_graph);
2876 DEL_ARR_F(ird_get_irg_link(current_ir_graph));
2881 set_interprocedural_view(rem_view);
2886 /*---------------------------------------------------------------------*/
2887 /* the following routines dumps type information without any ir nodes. */
2888 /*---------------------------------------------------------------------*/
2891 dump_type_graph(ir_graph *irg, const char *suffix)
2895 /* if a filter is set, dump only the irg's that match the filter */
2896 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
2898 f = vcg_open(irg, suffix, "-type");
2900 ir_graph *rem = current_ir_graph;
2901 current_ir_graph = irg;
2903 dump_vcg_header(f, get_irg_dump_name(irg), "Hierarchic", NULL);
2905 /* walk over the blocks in the graph */
2906 type_walk_irg(irg, dump_type_info, NULL, f);
2907 /* The walker for the const code can be called several times for the
2908 same (sub) expression. So that no nodes are dumped several times
2909 we decrease the visited flag of the corresponding graph after each
2910 walk. So now increase it finally. */
2911 inc_irg_visited(get_const_code_irg());
2915 current_ir_graph = rem;
2920 dump_all_types(const char *suffix)
2922 FILE *f = vcg_open_name("All_types", suffix);
2924 dump_vcg_header(f, "All_types", "Hierarchic", NULL);
2925 type_walk(dump_type_info, NULL, f);
2926 inc_irg_visited(get_const_code_irg());
2934 dump_class_hierarchy(int entities, const char *suffix)
2936 FILE *f = vcg_open_name("class_hierarchy", suffix);
2941 env.dump_ent = entities;
2942 dump_vcg_header(f, "class_hierarchy", "Hierarchic", NULL);
2943 type_walk(dump_class_hierarchy_node, NULL, &env);
2950 /*---------------------------------------------------------------------*/
2951 /* dumps all graphs with the graph-dumper passed. Possible dumpers: */
2953 /* dump_ir_block_graph */
2955 /* dump_type_graph */
2956 /* dump_ir_graph_w_types */
2957 /*---------------------------------------------------------------------*/
2959 void dump_all_ir_graphs(dump_graph_func *dmp_grph, const char *suffix) {
2961 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2962 dmp_grph(get_irp_irg(i), suffix);
2966 /*--------------------------------------------------------------------------------*
2967 * Dumps a stand alone loop graph with firm nodes which belong to one loop node *
2968 * packed together in one subgraph/box *
2969 *--------------------------------------------------------------------------------*/
2971 void dump_loops_standalone(FILE *F, ir_loop *loop) {
2972 int i = 0, loop_node_started = 0, son_number = 0, first = 0;
2974 ir_loop *son = NULL;
2976 /* Dump a new loop node. */
2977 dump_loop_node(F, loop);
2979 /* Dump the loop elements. */
2980 for (i = 0; i < get_loop_n_elements(loop); i++) {
2981 le = get_loop_element(loop, i);
2983 if (get_kind(son) == k_ir_loop) {
2985 /* We are a loop son -> Recurse */
2987 if (loop_node_started) { /* Close the "firm-nodes" node first if we started one. */
2988 fprintf(F, "\" }\n");
2989 fprintf(F, "edge: {sourcename: \"");
2991 fprintf(F, "\" targetname: \"");
2993 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
2994 loop_node_started = 0;
2996 dump_loop_son_edge(F, loop, son_number++);
2997 dump_loops_standalone(F, son);
2998 } else if (get_kind(son) == k_ir_node) {
2999 /* We are a loop node -> Collect firm nodes */
3001 ir_node *n = le.node;
3004 if (!loop_node_started) {
3005 /* Start a new node which contains all firm nodes of the current loop */
3006 fprintf(F, "node: { title: \"");
3008 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3009 loop_node_started = 1;
3014 bad |= dump_node_label(F, n);
3015 /* Causes indeterministic output: if (is_Block(n)) fprintf(F, "\t ->%d", (int)get_irn_link(n)); */
3016 if (has_backedges(n)) fprintf(F, "\t loop head!");
3017 } else { /* for callgraph loop tree */
3019 assert(get_kind(son) == k_ir_graph);
3021 /* We are a loop node -> Collect firm graphs */
3023 if (!loop_node_started) {
3024 /* Start a new node which contains all firm nodes of the current loop */
3025 fprintf(F, "node: { title: \"");
3027 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3028 loop_node_started = 1;
3032 fprintf(F, " %s", get_irg_dump_name(n));
3033 /* fprintf(F, " %s (depth %d)", get_irg_dump_name(n), n->callgraph_weighted_loop_depth); */
3037 if (loop_node_started) {
3038 fprintf(F, "\" }\n");
3039 fprintf(F, "edge: {sourcename: \"");
3041 fprintf(F, "\" targetname: \"");
3043 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3044 loop_node_started = 0;
3048 void dump_loop_tree(ir_graph *irg, const char *suffix)
3052 /* if a filter is set, dump only the irg's that match the filter */
3053 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
3055 f = vcg_open(irg, suffix, "-looptree");
3057 ir_graph *rem = current_ir_graph;
3058 int el_rem = edge_label;
3060 current_ir_graph = irg;
3063 dump_vcg_header(f, get_irg_dump_name(irg), "Tree", "top_to_bottom");
3065 if (get_irg_loop(irg))
3066 dump_loops_standalone(f, get_irg_loop(irg));
3071 edge_label = el_rem;
3072 current_ir_graph = rem;
3076 void dump_callgraph_loop_tree(const char *suffix) {
3078 F = vcg_open_name("Callgraph_looptree", suffix);
3079 dump_vcg_header(F, "callgraph looptree", "Tree", "top_to_bottom");
3080 dump_loops_standalone(F, irp->outermost_cg_loop);
3086 /*----------------------------------------------------------------------------*/
3087 /* Dumps the firm nodes in the loop tree to a graph along with the loop nodes.*/
3088 /*----------------------------------------------------------------------------*/
3090 void collect_nodeloop(FILE *F, ir_loop *loop, eset *loopnodes) {
3091 int i, son_number = 0, node_number = 0;
3093 if (dump_loop_information_flag) dump_loop_node(F, loop);
3095 for (i = 0; i < get_loop_n_elements(loop); i++) {
3096 loop_element le = get_loop_element(loop, i);
3097 if (*(le.kind) == k_ir_loop) {
3098 if (dump_loop_information_flag) dump_loop_son_edge(F, loop, son_number++);
3100 collect_nodeloop(F, le.son, loopnodes);
3102 if (dump_loop_information_flag) dump_loop_node_edge(F, loop, node_number++);
3103 eset_insert(loopnodes, le.node);
3108 void collect_nodeloop_external_nodes(ir_loop *loop, eset *loopnodes, eset *extnodes) {
3111 for(i = 0; i < get_loop_n_elements(loop); i++) {
3112 loop_element le = get_loop_element(loop, i);
3113 if (*(le.kind) == k_ir_loop) {
3115 collect_nodeloop_external_nodes(le.son, loopnodes, extnodes);
3117 if (is_Block(le.node)) start = 0; else start = -1;
3118 for (j = start; j < get_irn_arity(le.node); j++) {
3119 ir_node *pred = get_irn_n(le.node, j);
3120 if (!eset_contains(loopnodes, pred)) {
3121 eset_insert(extnodes, pred);
3122 if (!is_Block(pred)) {
3123 pred = get_nodes_block(pred);
3124 if (!eset_contains(loopnodes, pred)) eset_insert(extnodes, pred);
3132 void dump_loop(ir_loop *l, const char *suffix) {
3136 snprintf(name, sizeof(name), "loop_%d", get_loop_loop_nr(l));
3137 F = vcg_open_name(name, suffix);
3139 eset *loopnodes = eset_create();
3140 eset *extnodes = eset_create();
3143 dump_vcg_header(F, name, NULL, NULL);
3145 /* collect all nodes to dump */
3146 collect_nodeloop(F, l, loopnodes);
3147 collect_nodeloop_external_nodes(l, loopnodes, extnodes);
3149 /* build block lists */
3150 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes))
3151 set_irn_link(n, NULL);
3152 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes))
3153 set_irn_link(n, NULL);
3154 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes)) {
3156 b = get_nodes_block(n);
3157 set_irn_link(n, get_irn_link(b));
3161 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes)) {
3163 b = get_nodes_block(n);
3164 set_irn_link(n, get_irn_link(b));
3169 for (b = eset_first(loopnodes); b != NULL; b = eset_next(loopnodes)) {
3171 fprintf(F, "graph: { title: \"");
3173 fprintf(F, "\" label: \"");
3174 dump_node_opcode(F, b);
3175 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3176 fprintf(F, "\" status:clustered color:yellow\n");
3178 /* dump the blocks edges */
3179 dump_ir_data_edges(F, b);
3181 /* dump the nodes that go into the block */
3182 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3183 if (eset_contains(extnodes, n))
3184 overrule_nodecolor = ird_color_block_inout;
3186 overrule_nodecolor = ird_color_default_node;
3187 if (!eset_contains(extnodes, n)) dump_ir_data_edges(F, n);
3190 /* Close the vcg information for the block */
3192 dump_const_node_local(F, b);
3196 for (b = eset_first(extnodes); b != NULL; b = eset_next(extnodes)) {
3198 fprintf(F, "graph: { title: \"");
3200 fprintf(F, "\" label: \"");
3201 dump_node_opcode(F, b);
3202 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3203 fprintf(F, "\" status:clustered color:lightblue\n");
3205 /* dump the nodes that go into the block */
3206 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3207 if (!eset_contains(loopnodes, n))
3208 overrule_nodecolor = ird_color_block_inout;
3210 overrule_nodecolor = ird_color_default_node;
3211 if (eset_contains(loopnodes, n)) dump_ir_data_edges(F, n);
3214 /* Close the vcg information for the block */
3216 dump_const_node_local(F, b);
3220 eset_destroy(loopnodes);
3221 eset_destroy(extnodes);