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
35 #include "irgraph_t.h"
49 #include "callgraph.h"
50 #include "irextbb_t.h"
52 #include "dbginfo_t.h"
64 /** Dump only irgs with names that start with this prefix. */
65 static ident *dump_file_filter_id = NULL;
67 #define ERROR_TXT "<ERROR>"
69 /*******************************************************************/
70 /* flags to steer output */
71 /*******************************************************************/
73 /** An option to turn off edge labels */
74 static int edge_label = 1;
75 /** An option to turn off dumping values of constant entities */
76 static int const_entities = 1;
77 /** An option to dump the keep alive edges */
78 static int dump_keepalive = 1;
79 /** An option to dump the new out edges */
80 static int dump_new_edges_flag = 0;
81 /** An option to dump ld_names instead of names. */
82 static int dump_ld_name = 1;
83 /** Compiler options to dump analysis information in dump_ir_graph */
84 static int dump_out_edge_flag = 0;
85 static int dump_loop_information_flag = 0;
86 static int dump_backedge_information_flag = 1;
87 /** An option to dump const-like nodes locally. */
88 static int dump_const_local = 1;
89 /** An option to dump the node index number. */
90 static int dump_node_idx_labels = 0;
91 /** An option to dump all graph anchors */
92 static int dump_anchors = 0;
93 /** An option to dump the macro block edges. */
94 static int dump_macro_block_edges = 0;
95 /** An option to dump block marker in the block title */
96 static int dump_block_marker = 0;
98 int dump_dominator_information_flag = 0;
99 int opt_dump_analysed_type_info = 1;
100 int opt_dump_pointer_values_to_info = 0; /* default off: for test compares!! */
102 static ird_color_t overrule_nodecolor = ird_color_default_node;
104 /** The vcg node attribute hook. */
105 static DUMP_IR_GRAPH_FUNC dump_ir_graph_hook = NULL;
106 /** The vcg node attribute hook. */
107 static DUMP_NODE_VCGATTR_FUNC dump_node_vcgattr_hook = NULL;
108 /** The vcg edge attribute hook. */
109 static DUMP_EDGE_VCGATTR_FUNC dump_edge_vcgattr_hook = NULL;
110 /** The vcg dump block edge hook */
111 static DUMP_NODE_EDGE_FUNC dump_block_edge_hook = NULL;
112 /** The vcg dump node edge hook. */
113 static DUMP_NODE_EDGE_FUNC dump_node_edge_hook = NULL;
115 /* Set the hook to be called to dump additional edges to a node. */
116 void set_dump_node_edge_hook(DUMP_NODE_EDGE_FUNC func) {
117 dump_node_edge_hook = func;
120 /* Get the additional edge dump hook. */
121 DUMP_NODE_EDGE_FUNC get_dump_node_edge_hook(void) {
122 return dump_node_edge_hook;
125 /* Set the hook to be called to dump additional edges to a block. */
126 void set_dump_block_edge_hook(DUMP_NODE_EDGE_FUNC func) {
127 dump_block_edge_hook = func;
130 /* Get the additional block edge dump hook. */
131 DUMP_NODE_EDGE_FUNC get_dump_block_edge_hook(void) {
132 return dump_node_edge_hook;
135 /* set the ir graph hook */
136 void set_dump_ir_graph_hook(DUMP_IR_GRAPH_FUNC hook) {
137 dump_ir_graph_hook = hook;
140 /* set the node attribute hook */
141 void set_dump_node_vcgattr_hook(DUMP_NODE_VCGATTR_FUNC hook) {
142 dump_node_vcgattr_hook = hook;
145 /* set the edge attribute hook */
146 void set_dump_edge_vcgattr_hook(DUMP_EDGE_VCGATTR_FUNC hook) {
147 dump_edge_vcgattr_hook = hook;
150 /** Returns 0 if dump_out_edge_flag or dump_loop_information_flag
151 * are set, else returns dump_const_local_flag.
153 static int get_opt_dump_const_local(void) {
154 if (dump_out_edge_flag || dump_loop_information_flag || (dump_new_edges_flag && edges_activated(current_ir_graph)))
156 return dump_const_local;
159 /* Set a prefix filter for output functions. */
160 void only_dump_method_with_name(ident *name) {
161 dump_file_filter_id = name;
164 /* Returns the prefix filter set with only_dump_method_with_name(). */
165 ident *get_dump_file_filter_ident(void) {
166 return dump_file_filter_id;
169 /* Returns non-zero if dump file filter is not set, or if it is a prefix of name. */
170 int is_filtered_dump_name(ident *name) {
171 if (!dump_file_filter_id) return 1;
172 return id_is_prefix(dump_file_filter_id, name);
175 /* To turn off display of edge labels. Edge labels often cause xvcg to
176 abort with a segmentation fault. */
177 void turn_off_edge_labels(void) {
181 void dump_consts_local(int flag) {
182 dump_const_local = flag;
185 void dump_node_idx_label(int flag) {
186 dump_node_idx_labels = flag;
189 void dump_constant_entity_values(int flag) {
190 const_entities = flag;
193 void dump_keepalive_edges(int flag) {
194 dump_keepalive = flag;
197 void dump_new_edges(int flag) {
198 dump_new_edges_flag = flag;
201 int get_opt_dump_keepalive_edges(void) {
202 return dump_keepalive;
205 void dump_out_edges(int flag) {
206 dump_out_edge_flag = flag;
209 void dump_dominator_information(int flag) {
210 dump_dominator_information_flag = flag;
213 void dump_loop_information(int flag) {
214 dump_loop_information_flag = flag;
217 void dump_backedge_information(int flag) {
218 dump_backedge_information_flag = flag;
221 /* Dump the information of type field specified in ana/irtypeinfo.h.
222 * If the flag is set, the type name is output in [] in the node label,
223 * else it is output as info.
225 void set_opt_dump_analysed_type_info(int flag) {
226 opt_dump_analysed_type_info = flag;
229 void dump_pointer_values_to_info(int flag) {
230 opt_dump_pointer_values_to_info = flag;
233 void dump_ld_names(int flag) {
237 void dump_all_anchors(int flag) {
241 void dump_macroblock_edges(int flag) {
242 dump_macro_block_edges = flag;
245 void dump_block_marker_in_title(int flag) {
246 dump_block_marker = flag;
249 /* -------------- some extended helper functions ----------------- */
252 * returns the name of a mode or ERROR_TXT if mode is NOT a mode object.
253 * in the later case, sets bad.
255 const char *get_mode_name_ex(const ir_mode *mode, int *bad) {
257 return get_mode_name(mode);
263 * returns the name of a type or <ERROR> if mode is NOT a mode object.
264 * in the later case, sets bad
266 const char *get_type_name_ex(const ir_type *tp, int *bad) {
268 return get_type_name(tp);
273 #define CUSTOM_COLOR_BASE 100
274 static const char *color_names[ird_color_count];
275 static const char *color_rgb[ird_color_count];
276 static struct obstack color_obst;
278 /** define a custom color. */
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 /** Define a named color. */
290 static void named_color(int num, const char *name)
292 assert(num < ird_color_count);
293 color_rgb[num] = NULL;
294 color_names[num] = name;
297 /** Initializes the used colors. */
298 static void init_colors(void)
300 static int initialized = 0;
304 obstack_init(&color_obst);
306 custom_color(ird_color_prog_background, "204 204 204");
307 custom_color(ird_color_block_background, "255 255 0");
308 custom_color(ird_color_dead_block_background, "190 150 150");
309 named_color(ird_color_block_inout, "lightblue");
310 named_color(ird_color_default_node, "white");
311 custom_color(ird_color_memory, "153 153 255");
312 custom_color(ird_color_controlflow, "255 153 153");
313 custom_color(ird_color_const, "204 255 255");
314 custom_color(ird_color_proj, "255 255 153");
315 custom_color(ird_color_uses_memory, "153 153 255");
316 custom_color(ird_color_phi, "105 255 105");
317 custom_color(ird_color_anchor, "100 100 255");
318 named_color(ird_color_error, "red");
319 custom_color(ird_color_entity, "204 204 255");
325 * Prints the VCG color to a file.
327 static void print_vcg_color(FILE *F, ird_color_t color) {
328 assert(color < ird_color_count);
329 fprintf(F, "color:%s", color_names[color]);
333 * Prints the edge from a type S to a type T with additional info fmt, ...
336 static void print_type_type_edge(FILE *F, const ir_type *S, const ir_type *T, const char *fmt, ...)
341 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(S);
342 fprintf(F, " targetname: "); PRINT_TYPEID(T);
343 vfprintf(F, fmt, ap);
349 * Prints the edge from a type tp to an entity ent with additional info fmt, ...
352 static void print_type_ent_edge(FILE *F, const ir_type *tp, const ir_entity *ent, const char *fmt, ...)
357 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(tp);
358 fprintf(F, " targetname: \""); PRINT_ENTID(ent); fprintf(F, "\"");
359 vfprintf(F, fmt, ap);
365 * Prints the edge from an entity ent1 to an entity ent2 with additional info fmt, ...
368 static void print_ent_ent_edge(FILE *F, const ir_entity *ent1, const ir_entity *ent2, int backedge, ird_color_t color, const char *fmt, ...)
374 fprintf(F, "backedge: { sourcename: \"");
376 fprintf(F, "edge: { sourcename: \"");
378 fprintf(F, "\" targetname: \""); PRINT_ENTID(ent2); fprintf(F, "\"");
379 vfprintf(F, fmt, ap);
381 if (color != (ird_color_t) -1)
382 print_vcg_color(F, color);
388 * Prints the edge from an entity ent to a type tp with additional info fmt, ...
391 static void print_ent_type_edge(FILE *F, const ir_entity *ent, const ir_type *tp, const char *fmt, ...)
396 fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(ent);
397 fprintf(F, "\" targetname: "); PRINT_TYPEID(tp);
398 vfprintf(F, fmt, ap);
404 * Prints the edge from a node irn to a type tp with additional info fmt, ...
407 static void print_node_type_edge(FILE *F, const ir_node *irn, ir_type *tp, const char *fmt, ...)
412 fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(irn);
413 fprintf(F, "\" targetname: "); PRINT_TYPEID(tp);
414 vfprintf(F, fmt, ap);
420 * Prints the edge from a node irn to an entity ent with additional info fmt, ...
423 static void print_node_ent_edge(FILE *F, const ir_node *irn, const ir_entity *ent, const char *fmt, ...)
428 fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(irn);
429 fprintf(F, "\" targetname: \""); PRINT_ENTID(ent);
431 vfprintf(F, fmt, ap);
437 * Prints the edge from an entity ent to a node irn with additional info fmt, ...
440 static void print_ent_node_edge(FILE *F, const ir_entity *ent, const ir_node *irn, const char *fmt, ...)
445 fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(ent);
446 fprintf(F, "\" targetname: \""); PRINT_NODEID(irn); fprintf(F, "\"");
447 vfprintf(F, fmt, ap);
453 * Prints the edge from a type tp to an enumeration item item with additional info fmt, ...
456 static void print_enum_item_edge(FILE *F, const ir_type *tp, int item, const char *fmt, ...)
461 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(tp);
462 fprintf(F, " targetname: \""); PRINT_ITEMID(tp, item); fprintf(F, "\" ");
463 vfprintf(F, fmt, ap);
468 /*-----------------------------------------------------------------*/
469 /* global and ahead declarations */
470 /*-----------------------------------------------------------------*/
472 static void dump_whole_node(ir_node *n, void *env);
473 static inline void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg);
475 /*-----------------------------------------------------------------*/
476 /* Helper functions. */
477 /*-----------------------------------------------------------------*/
480 * This map is used as a private link attr to be able to call dumper
481 * anywhere without destroying link fields.
483 static pmap *irdump_link_map = NULL;
485 /** NOT A STANDARD LIBFIRM INIT METHOD
487 * We do not want to integrate dumping into libfirm, i.e., if the dumpers
488 * are off, we want to have as few interferences as possible. Therefore the
489 * initialization is performed lazily and not called from within init_firm.
491 * Creates the link attribute map. */
492 static void init_irdump(void) {
493 /* We need a new, empty map. */
494 if (irdump_link_map) pmap_destroy(irdump_link_map);
495 irdump_link_map = pmap_create();
496 if (!dump_file_filter_id)
497 dump_file_filter_id = new_id_from_str("");
501 * Returns the private link field.
503 static void *ird_get_irn_link(const ir_node *n) {
505 if (irdump_link_map == NULL)
508 if (pmap_contains(irdump_link_map, n))
509 res = pmap_get(irdump_link_map, n);
514 * Sets the private link field.
516 static void ird_set_irn_link(const ir_node *n, void *x) {
517 if (irdump_link_map == NULL)
519 pmap_insert(irdump_link_map, n, x);
523 * Gets the private link field of an irg.
525 static void *ird_get_irg_link(const ir_graph *irg) {
527 if (irdump_link_map == NULL)
530 if (pmap_contains(irdump_link_map, irg))
531 res = pmap_get(irdump_link_map, irg);
536 * Sets the private link field of an irg.
538 static void ird_set_irg_link(const ir_graph *irg, void *x) {
539 if (irdump_link_map == NULL)
541 pmap_insert(irdump_link_map, irg, x);
545 * Walker, clears the private link field.
547 static void clear_link(ir_node *node, void *env) {
549 ird_set_irn_link(node, NULL);
553 * If the entity has a ld_name, returns it if the dump_ld_name is set,
554 * else returns the name of the entity.
556 static const char *_get_ent_dump_name(const ir_entity *ent, int dump_ld_name) {
558 return "<NULL entity>";
560 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
561 if (ent->ld_name != NULL)
562 return get_id_str(ent->ld_name);
564 return get_id_str(ent->name);
568 * If the entity has a ld_name, returns it if the option dump_ld_name is set,
569 * else returns the name of the entity.
571 const char *get_ent_dump_name(const ir_entity *ent) {
572 return _get_ent_dump_name(ent, dump_ld_name);
575 /* Returns the name of an IRG. */
576 const char *get_irg_dump_name(const ir_graph *irg) {
577 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
578 return _get_ent_dump_name(get_irg_entity(irg), 1);
582 * Returns non-zero if a node is in floating state.
584 static int node_floats(const ir_node *n) {
585 return ((get_irn_pinned(n) == op_pin_state_floats) &&
586 (get_irg_pinned(current_ir_graph) == op_pin_state_floats));
590 * Walker that visits the anchors
592 static void ird_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env) {
593 if (dump_anchors || (dump_new_edges_flag && edges_activated(irg))) {
594 irg_walk_anchors(irg, pre, post, env);
596 irg_walk_graph(irg, pre, post, env);
601 * Walker, allocates an array for all blocks and puts it's nodes non-floating nodes into this array.
603 static void collect_node(ir_node *node, void *env) {
607 || (get_op_flags(get_irn_op(node)) & irop_flag_dump_noblock)) {
608 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
609 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
610 ARR_APP1(ir_node *, arr, node);
611 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
613 ir_node * block = get_nodes_block(node);
616 /* this node is in a Bad block, so we must place it into the graph's list */
617 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
618 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
619 ARR_APP1(ir_node *, arr, node);
620 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
622 ird_set_irn_link(node, ird_get_irn_link(block));
623 ird_set_irn_link(block, node);
628 /** Construct lists to walk ir block-wise.
630 * Collects all blocks, nodes not op_pin_state_pinned,
631 * Bad, NoMem and Unknown into a flexible array in link field of
632 * irg they belong to. Sets the irg link field to NULL in all
633 * graphs not visited.
634 * Free the list with DEL_ARR_F().
636 static ir_node **construct_block_lists(ir_graph *irg) {
638 #ifdef INTERPROCEDURAL_VIEW
639 int rem_view = get_interprocedural_view();
641 int walk_flag = ir_resources_reserved(irg) & IR_RESOURCE_IRN_VISITED;
642 ir_graph *rem = current_ir_graph;
644 current_ir_graph = irg;
647 ir_free_resources(irg, IR_RESOURCE_IRN_VISITED);
650 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
651 ird_set_irg_link(get_irp_irg(i), NULL);
653 ird_walk_graph(current_ir_graph, clear_link, collect_node, current_ir_graph);
655 #ifdef INTERPROCEDURAL_VIEW
656 /* Collect also EndReg and EndExcept. We do not want to change the walker. */
657 set_interprocedural_view(0);
660 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
661 irg_walk(get_irg_end_reg(current_ir_graph), clear_link, collect_node, current_ir_graph);
662 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
663 irg_walk(get_irg_end_except(current_ir_graph), clear_link, collect_node, current_ir_graph);
665 #ifdef INTERPROCEDURAL_VIEW
666 set_interprocedural_view(rem_view);
670 ir_reserve_resources(irg, IR_RESOURCE_IRN_VISITED);
673 current_ir_graph = rem;
674 return ird_get_irg_link(irg);
677 typedef struct _list_tuple {
679 ir_extblk **extbb_list;
682 /** Construct lists to walk IR extended block-wise.
683 * Free the lists in the tuple with DEL_ARR_F().
684 * Sets the irg link field to NULL in all
685 * graphs not visited.
687 static list_tuple *construct_extblock_lists(ir_graph *irg) {
688 ir_node **blk_list = construct_block_lists(irg);
690 ir_graph *rem = current_ir_graph;
691 list_tuple *lists = XMALLOC(list_tuple);
693 current_ir_graph = irg;
695 lists->blk_list = NEW_ARR_F(ir_node *, 0);
696 lists->extbb_list = NEW_ARR_F(ir_extblk *, 0);
698 inc_irg_block_visited(irg);
699 for (i = ARR_LEN(blk_list) - 1; i >= 0; --i) {
702 if (is_Block(blk_list[i])) {
703 ext = get_Block_extbb(blk_list[i]);
705 if (extbb_not_visited(ext)) {
706 ARR_APP1(ir_extblk *, lists->extbb_list, ext);
707 mark_extbb_visited(ext);
710 ARR_APP1(ir_node *, lists->blk_list, blk_list[i]);
714 current_ir_graph = rem;
715 ird_set_irg_link(irg, lists);
719 /*-----------------------------------------------------------------*/
720 /* Routines to dump information about a single ir node. */
721 /*-----------------------------------------------------------------*/
724 * dump the name of a node n to the File F.
726 int dump_node_opcode(FILE *F, ir_node *n)
729 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
731 /* call the dump_node operation if available */
733 return ops->dump_node(n, F, dump_node_opcode_txt);
735 /* implementation for default nodes */
736 switch (get_irn_opcode(n)) {
738 switch (get_SymConst_kind(n)) {
739 case symconst_addr_name:
740 /* don't use get_SymConst_ptr_info as it mangles the name. */
741 fprintf(F, "SymC %s", get_id_str(get_SymConst_name(n)));
743 case symconst_addr_ent:
744 fprintf(F, "SymC &%s", get_entity_name(get_SymConst_entity(n)));
746 case symconst_ofs_ent:
747 fprintf(F, "SymC %s offset", get_entity_name(get_SymConst_entity(n)));
749 case symconst_type_tag:
750 fprintf(F, "SymC %s tag", get_type_name_ex(get_SymConst_type(n), &bad));
752 case symconst_type_size:
753 fprintf(F, "SymC %s size", get_type_name_ex(get_SymConst_type(n), &bad));
755 case symconst_type_align:
756 fprintf(F, "SymC %s align", get_type_name_ex(get_SymConst_type(n), &bad));
758 case symconst_enum_const:
759 fprintf(F, "SymC %s enum", get_enumeration_name(get_SymConst_enum(n)));
765 if (!get_interprocedural_view())
772 ir_node *pred = get_Proj_pred(n);
774 if (get_irn_opcode(pred) == iro_Cond
775 && get_Proj_proj(n) == get_Cond_default_proj(pred)
776 && get_irn_mode(get_Cond_selector(pred)) != mode_b)
777 fprintf(F, "defProj");
785 if (get_interprocedural_view()) {
786 fprintf(F, "%s %s", get_irn_opname(n), get_ent_dump_name(get_irg_entity(get_irn_irg(n))));
791 case iro_CallBegin: {
792 ir_node *addr = get_CallBegin_ptr(n);
793 ir_entity *ent = NULL;
795 ent = get_Sel_entity(addr);
796 else if (is_Global(addr))
797 ent = get_Global_entity(addr);
798 fprintf(F, "%s", get_irn_opname(n));
799 if (ent) fprintf(F, " %s", get_entity_name(ent));
803 if (get_Load_align(n) == align_non_aligned)
805 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Load_mode(n), &bad));
808 if (get_Store_align(n) == align_non_aligned)
810 fprintf(F, "%s", get_irn_opname(n));
814 is_Block_dead(n) ? "Dead " : "", get_irn_opname(n),
815 dump_block_marker ? (get_Block_mark(n) ? "*" : "") : "");
818 if (get_Conv_strict(n))
819 fprintf(F, "strict");
820 fprintf(F, "%s", get_irn_opname(n));
823 fprintf(F, "%s", get_irn_opname(n));
824 if (get_Div_no_remainder(n))
826 fprintf(F, "[%s]", get_mode_name_ex(get_Div_resmode(n), &bad));
829 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Mod_resmode(n), &bad));
832 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_DivMod_resmode(n), &bad));
835 fprintf(F, "%s[%s]", get_irn_opname(n), get_builtin_kind_name(get_Builtin_kind(n)));
840 fprintf(F, "%s", get_irn_opname(n));
847 * Dump the mode of a node n to a file F.
848 * Ignore modes that are "always known".
850 static int dump_node_mode(FILE *F, ir_node *n)
853 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
857 /* call the dump_node operation if available */
859 return ops->dump_node(n, F, dump_node_mode_txt);
861 /* default implementation */
862 iro = get_irn_opcode(n);
874 mode = get_irn_mode(n);
876 if (mode != NULL && mode != mode_BB && mode != mode_ANY && mode != mode_BAD &&
877 (mode != mode_T || iro == iro_Proj))
878 fprintf(F, "%s", get_mode_name_ex(mode, &bad));
884 * Dump the type of a node n to a file F if it's known.
886 static int dump_node_typeinfo(FILE *F, ir_node *n) {
889 if (opt_dump_analysed_type_info) {
890 if (get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_consistent ||
891 get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_inconsistent) {
892 ir_type *tp = get_irn_typeinfo_type(n);
893 if (tp != firm_none_type)
894 fprintf(F, "[%s] ", get_type_name_ex(tp, &bad));
902 typedef struct _pns_lookup {
903 long nr; /**< the proj number */
904 const char *name; /**< the name of the Proj */
907 typedef struct _proj_lookup {
908 ir_opcode code; /**< the opcode of the Proj predecessor */
909 unsigned num_data; /**< number of data entries */
910 const pns_lookup_t *data; /**< the data */
913 #define ARR_SIZE(a) (sizeof(a)/sizeof(a[0]))
915 /** the lookup table for Proj(Start) names */
916 static const pns_lookup_t start_lut[] = {
917 #define X(a) { pn_Start_##a, #a }
925 /** the lookup table for Proj(Cond) names */
926 static const pns_lookup_t cond_lut[] = {
927 #define X(a) { pn_Cond_##a, #a }
933 /** the lookup table for Proj(Call) names */
934 static const pns_lookup_t call_lut[] = {
935 #define X(a) { pn_Call_##a, #a }
945 /** the lookup table for Proj(Quot) names */
946 static const pns_lookup_t quot_lut[] = {
947 #define X(a) { pn_Quot_##a, #a }
955 /** the lookup table for Proj(DivMod) names */
956 static const pns_lookup_t divmod_lut[] = {
957 #define X(a) { pn_DivMod_##a, #a }
966 /** the lookup table for Proj(Div) names */
967 static const pns_lookup_t div_lut[] = {
968 #define X(a) { pn_Div_##a, #a }
976 /** the lookup table for Proj(Mod) names */
977 static const pns_lookup_t mod_lut[] = {
978 #define X(a) { pn_Mod_##a, #a }
986 /** the lookup table for Proj(Load) names */
987 static const pns_lookup_t load_lut[] = {
988 #define X(a) { pn_Load_##a, #a }
996 /** the lookup table for Proj(Store) names */
997 static const pns_lookup_t store_lut[] = {
998 #define X(a) { pn_Store_##a, #a }
1005 /** the lookup table for Proj(Alloc) names */
1006 static const pns_lookup_t alloc_lut[] = {
1007 #define X(a) { pn_Alloc_##a, #a }
1015 /** the lookup table for Proj(CopyB) names */
1016 static const pns_lookup_t copyb_lut[] = {
1017 #define X(a) { pn_CopyB_##a, #a }
1025 /** the lookup table for Proj(InstOf) names */
1026 static const pns_lookup_t instof_lut[] = {
1027 #define X(a) { pn_InstOf_##a, #a }
1036 /** the lookup table for Proj(Raise) names */
1037 static const pns_lookup_t raise_lut[] = {
1038 #define X(a) { pn_Raise_##a, #a }
1044 /** the lookup table for Proj(Bound) names */
1045 static const pns_lookup_t bound_lut[] = {
1046 #define X(a) { pn_Bound_##a, #a }
1054 /** the Proj lookup table */
1055 static const proj_lookup_t proj_lut[] = {
1056 #define E(a) ARR_SIZE(a), a
1057 { iro_Start, E(start_lut) },
1058 { iro_Cond, E(cond_lut) },
1059 { iro_Call, E(call_lut) },
1060 { iro_Quot, E(quot_lut) },
1061 { iro_DivMod, E(divmod_lut) },
1062 { iro_Div, E(div_lut) },
1063 { iro_Mod, E(mod_lut) },
1064 { iro_Load, E(load_lut) },
1065 { iro_Store, E(store_lut) },
1066 { iro_Alloc, E(alloc_lut) },
1067 { iro_CopyB, E(copyb_lut) },
1068 { iro_InstOf, E(instof_lut) },
1069 { iro_Raise, E(raise_lut) },
1070 { iro_Bound, E(bound_lut) }
1075 * Dump additional node attributes of some nodes to a file F.
1078 dump_node_nodeattr(FILE *F, ir_node *n)
1084 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1086 /* call the dump_node operation if available */
1088 return ops->dump_node(n, F, dump_node_nodeattr_txt);
1090 switch (get_irn_opcode(n)) {
1092 if (0 && get_interprocedural_view()) {
1093 fprintf(F, "%s ", get_ent_dump_name(get_irg_entity(current_ir_graph)));
1098 ir_fprintf(F, "%T ", get_Const_tarval(n));
1102 pred = get_Proj_pred(n);
1103 proj_nr = get_Proj_proj(n);
1105 code = get_irn_opcode(pred);
1107 if (code == iro_Cmp)
1108 fprintf(F, "%s ", get_pnc_string(get_Proj_proj(n)));
1109 else if (code == iro_Proj && get_irn_opcode(get_Proj_pred(pred)) == iro_Start)
1110 fprintf(F, "Arg %ld ", proj_nr);
1111 else if (code == iro_Cond && get_irn_mode(get_Cond_selector(pred)) != mode_b)
1112 fprintf(F, "%ld ", proj_nr);
1114 unsigned i, j, f = 0;
1116 for (i = 0; i < ARR_SIZE(proj_lut); ++i) {
1117 if (code == proj_lut[i].code) {
1118 for (j = 0; j < proj_lut[i].num_data; ++j) {
1119 if (proj_nr == proj_lut[i].data[j].nr) {
1120 fprintf(F, "%s ", proj_lut[i].data[j].name);
1129 fprintf(F, "%ld ", proj_nr);
1130 if (code == iro_Cond && get_Cond_jmp_pred(pred) != COND_JMP_PRED_NONE) {
1131 if (proj_nr == pn_Cond_false && get_Cond_jmp_pred(pred) == COND_JMP_PRED_FALSE)
1132 fprintf(F, "PRED ");
1133 if (proj_nr == pn_Cond_true && get_Cond_jmp_pred(pred) == COND_JMP_PRED_TRUE)
1134 fprintf(F, "PRED ");
1139 proj_nr = get_Filter_proj(n);
1140 if (! get_interprocedural_view()) {
1142 pred = get_Filter_pred(n);
1145 fprintf(F, "%ld ", proj_nr);
1148 fprintf(F, "%s ", get_ent_dump_name(get_Sel_entity(n)));
1151 fprintf(F, "(%s) ", get_type_name_ex(get_Cast_type(n), &bad));
1154 fprintf(F, "%s ", get_pnc_string(get_Confirm_cmp(n)));
1157 fprintf(F, "(%s) ", get_type_name_ex(get_CopyB_type(n), &bad));
1168 #include "execution_frequency.h"
1170 static void dump_node_ana_vals(FILE *F, ir_node *n) {
1174 #ifdef INTERPROCEDURAL_VIEW
1175 fprintf(F, " %lf*(%2.0lf + %2.0lf) = %2.0lf ",
1176 get_irn_exec_freq(n),
1177 get_irg_method_execution_frequency(get_irn_irg(n)),
1178 pow(5, get_irg_recursion_depth(get_irn_irg(n))),
1179 get_irn_exec_freq(n) * (get_irg_method_execution_frequency(get_irn_irg(n)) + pow(5, get_irg_recursion_depth(get_irn_irg(n))))
1185 /* Dumps a node label without the enclosing ". */
1186 int dump_node_label(FILE *F, ir_node *n) {
1189 bad |= dump_node_opcode(F, n);
1190 bad |= dump_node_mode(F, n);
1192 bad |= dump_node_typeinfo(F, n);
1193 bad |= dump_node_nodeattr(F, n);
1194 if(dump_node_idx_labels) {
1195 fprintf(F, "%ld:%d", get_irn_node_nr(n), get_irn_idx(n));
1197 fprintf(F, "%ld", get_irn_node_nr(n));
1204 * Dumps the attributes of a node n into the file F.
1205 * Currently this is only the color of a node.
1207 static void dump_node_vcgattr(FILE *F, ir_node *node, ir_node *local, int bad)
1213 print_vcg_color(F, ird_color_error);
1217 if (dump_node_vcgattr_hook)
1218 if (dump_node_vcgattr_hook(F, node, local))
1221 n = local ? local : node;
1223 if (overrule_nodecolor != ird_color_default_node) {
1224 print_vcg_color(F, overrule_nodecolor);
1228 mode = get_irn_mode(n);
1229 if(mode == mode_M) {
1230 print_vcg_color(F, ird_color_memory);
1233 if(mode == mode_X) {
1234 print_vcg_color(F, ird_color_controlflow);
1238 switch (get_irn_opcode(n)) {
1243 print_vcg_color(F, ird_color_anchor);
1246 print_vcg_color(F, ird_color_error);
1249 if (is_Block_dead(n))
1250 print_vcg_color(F, ird_color_dead_block_background);
1252 print_vcg_color(F, ird_color_block_background);
1255 print_vcg_color(F, ird_color_phi);
1258 print_vcg_color(F, ird_color_memory);
1262 print_vcg_color(F, ird_color_const);
1265 print_vcg_color(F, ird_color_proj);
1268 ir_op *op = get_irn_op(node);
1270 if(is_op_constlike(op)) {
1271 print_vcg_color(F, ird_color_const);
1272 } else if(is_op_uses_memory(op)) {
1273 print_vcg_color(F, ird_color_uses_memory);
1274 } else if(is_op_cfopcode(op) || is_op_forking(op)) {
1275 print_vcg_color(F, ird_color_controlflow);
1277 PRINT_DEFAULT_NODE_ATTR;
1283 /* Adds a new node info dumper callback. */
1284 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data)
1286 hook_entry_t *info = XMALLOC(hook_entry_t);
1288 info->hook._hook_node_info = cb;
1289 info->context = data;
1290 register_hook(hook_node_info, info);
1295 /* Remove a previously added info dumper callback. */
1296 void dump_remv_node_info_callback(void *handle)
1298 hook_entry_t *info = handle;
1299 unregister_hook(hook_node_info, info);
1304 * Dump the node information of a node n to a file F.
1306 static inline int dump_node_info(FILE *F, ir_node *n)
1309 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1311 fprintf(F, " info1: \"");
1312 bad = dump_irnode_to_file(F, n);
1313 /* call the dump_node operation if available */
1315 bad = ops->dump_node(n, F, dump_node_info_txt);
1317 /* allow additional info to be added */
1318 hook_node_info(F, n);
1324 static inline int is_constlike_node(const ir_node *node)
1326 const ir_op *op = get_irn_op(node);
1327 return is_op_constlike(op);
1331 /** outputs the predecessors of n, that are constants, local. I.e.,
1332 generates a copy of the constant predecessors for each node called with. */
1333 static void dump_const_node_local(FILE *F, ir_node *n) {
1335 if (!get_opt_dump_const_local()) return;
1337 /* Use visited flag to avoid outputting nodes twice.
1338 initialize it first. */
1339 for (i = 0; i < get_irn_arity(n); i++) {
1340 ir_node *con = get_irn_n(n, i);
1341 if (is_constlike_node(con)) {
1342 set_irn_visited(con, get_irg_visited(current_ir_graph) - 1);
1346 for (i = 0; i < get_irn_arity(n); i++) {
1347 ir_node *con = get_irn_n(n, i);
1348 if (is_constlike_node(con) && !irn_visited(con)) {
1351 mark_irn_visited(con);
1352 /* Generate a new name for the node by appending the names of
1354 fprintf(F, "node: {title: "); PRINT_CONSTID(n, con);
1355 fprintf(F, " label: \"");
1356 bad |= dump_node_label(F, con);
1358 bad |= dump_node_info(F, con);
1359 dump_node_vcgattr(F, n, con, bad);
1365 /** If the block of an edge is a const_like node, dump it local with an edge */
1366 static void dump_const_block_local(FILE *F, ir_node *n) {
1369 if (!get_opt_dump_const_local()) return;
1371 blk = get_nodes_block(n);
1372 if (is_constlike_node(blk)) {
1375 /* Generate a new name for the node by appending the names of
1377 fprintf(F, "node: {title: \""); PRINT_CONSTBLKID(n, blk);
1378 fprintf(F, "\" label: \"");
1379 bad |= dump_node_label(F, blk);
1381 bad |= dump_node_info(F, blk);
1382 dump_node_vcgattr(F, n, blk, bad);
1385 fprintf(F, "edge: { sourcename: \"");
1387 fprintf(F, "\" targetname: \""); PRINT_CONSTBLKID(n,blk);
1389 if (dump_edge_vcgattr_hook) {
1391 if (dump_edge_vcgattr_hook(F, n, -1)) {
1395 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1400 fprintf(F, "\" " BLOCK_EDGE_ATTR "}\n");
1405 * prints the error message of a node to a file F as info2.
1407 static void print_node_error(FILE *F, const char *err_msg)
1412 fprintf(F, " info2: \"%s\"", err_msg);
1416 * prints debug messages of a node to file F as info3.
1418 static void print_dbg_info(FILE *F, dbg_info *dbg)
1422 if (__dbg_info_snprint) {
1424 if (__dbg_info_snprint(buf, sizeof(buf), dbg) > 0)
1425 fprintf(F, " info3: \"%s\"\n", buf);
1432 static void dump_node(FILE *F, ir_node *n)
1437 if (get_opt_dump_const_local() && is_constlike_node(n))
1440 /* dump this node */
1441 fputs("node: {title: \"", F);
1445 fputs(" label: \"", F);
1446 bad = ! irn_vrfy_irg_dump(n, current_ir_graph, &p);
1447 bad |= dump_node_label(F, n);
1448 dump_node_ana_vals(F, n);
1449 //dump_node_ana_info(F, n);
1452 if (get_op_flags(get_irn_op(n)) & irop_flag_dump_noinput) {
1453 //fputs(" node_class:23", F);
1456 bad |= dump_node_info(F, n);
1457 print_node_error(F, p);
1458 print_dbg_info(F, get_irn_dbg_info(n));
1459 dump_node_vcgattr(F, n, NULL, bad);
1461 dump_const_node_local(F, n);
1463 if(dump_node_edge_hook)
1464 dump_node_edge_hook(F, n);
1467 /** dump the edge to the block this node belongs to */
1469 dump_ir_block_edge(FILE *F, ir_node *n) {
1470 if (get_opt_dump_const_local() && is_constlike_node(n)) return;
1471 if (is_no_Block(n)) {
1472 ir_node *block = get_nodes_block(n);
1474 if (get_opt_dump_const_local() && is_constlike_node(block)) {
1475 dump_const_block_local(F, n);
1477 fprintf(F, "edge: { sourcename: \"");
1479 fprintf(F, "\" targetname: ");
1480 fprintf(F, "\""); PRINT_NODEID(block); fprintf(F, "\"");
1482 if (dump_edge_vcgattr_hook) {
1484 if (dump_edge_vcgattr_hook(F, n, -1)) {
1488 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1493 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1499 print_data_edge_vcgattr(FILE *F, ir_node *from, int to) {
1501 * do not use get_nodes_block() here, will fail
1502 * if the irg is not pinned.
1504 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1505 fprintf(F, INTRA_DATA_EDGE_ATTR);
1507 fprintf(F, INTER_DATA_EDGE_ATTR);
1511 print_mem_edge_vcgattr(FILE *F, ir_node *from, int to) {
1513 * do not use get_nodes_block() here, will fail
1514 * if the irg is not pinned.
1516 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1517 fprintf(F, INTRA_MEM_EDGE_ATTR);
1519 fprintf(F, INTER_MEM_EDGE_ATTR);
1522 /** Print the vcg attributes for the edge from node from to it's to's input */
1523 static void print_edge_vcgattr(FILE *F, ir_node *from, int to) {
1526 if (dump_edge_vcgattr_hook)
1527 if (dump_edge_vcgattr_hook(F, from, to))
1530 if (dump_backedge_information_flag && is_backedge(from, to))
1531 fprintf(F, BACK_EDGE_ATTR);
1533 switch (get_irn_opcode(from)) {
1535 fprintf(F, CF_EDGE_ATTR);
1537 case iro_Start: break;
1540 if (get_irn_mode(get_End_keepalive(from, to)) == mode_BB)
1541 fprintf(F, KEEP_ALIVE_CF_EDGE_ATTR);
1543 fprintf(F, KEEP_ALIVE_DF_EDGE_ATTR);
1547 if (is_Proj(from)) {
1548 if (get_irn_mode(from) == mode_M)
1549 print_mem_edge_vcgattr(F, from, to);
1550 else if (get_irn_mode(from) == mode_X)
1551 fprintf(F, CF_EDGE_ATTR);
1553 print_data_edge_vcgattr(F, from, to);
1555 else if (get_irn_mode(get_irn_n(from, to)) == mode_M)
1556 print_mem_edge_vcgattr(F, from, to);
1557 else if (get_irn_mode(get_irn_n(from, to)) == mode_X)
1558 fprintf(F, CF_EDGE_ATTR);
1560 print_data_edge_vcgattr(F, from, to);
1564 /** dump edges to our inputs */
1565 static void dump_ir_data_edges(FILE *F, ir_node *n) {
1567 ir_visited_t visited = get_irn_visited(n);
1569 if (!dump_keepalive && is_End(n)) {
1570 /* the End node has only keep-alive edges */
1574 /* dump the dependency edges. */
1575 num = get_irn_deps(n);
1576 for (i = 0; i < num; ++i) {
1577 ir_node *dep = get_irn_dep(n, i);
1580 fprintf(F, "edge: {sourcename: \"");
1582 fprintf(F, "\" targetname: ");
1583 if ((get_opt_dump_const_local()) && is_constlike_node(dep)) {
1584 PRINT_CONSTID(n, dep);
1590 fprintf(F, " label: \"%d\" ", i);
1591 fprintf(F, " color: darkgreen}\n");
1595 num = get_irn_arity(n);
1596 for (i = 0; i < num; i++) {
1597 ir_node *pred = get_irn_n(n, i);
1600 if ((get_interprocedural_view() && get_irn_visited(pred) < visited))
1601 continue; /* pred not dumped */
1603 if (dump_backedge_information_flag && is_backedge(n, i))
1604 fprintf(F, "backedge: {sourcename: \"");
1606 fprintf(F, "edge: {sourcename: \"");
1608 fprintf(F, "\" targetname: ");
1609 if ((get_opt_dump_const_local()) && is_constlike_node(pred)) {
1610 PRINT_CONSTID(n, pred);
1612 fprintf(F, "\""); PRINT_NODEID(pred); fprintf(F, "\"");
1614 fprintf(F, " label: \"%d\" ", i);
1615 print_edge_vcgattr(F, n, i);
1619 if (dump_macro_block_edges && is_Block(n)) {
1620 ir_node *mb = get_Block_MacroBlock(n);
1621 fprintf(F, "edge: {sourcename: \"");
1623 fprintf(F, "\" targetname: \"");
1625 fprintf(F, "\" label: \"mb\" " MACROBLOCK_EDGE_ATTR);
1634 dump_ir_edges(FILE *F, ir_node *n) {
1635 const ir_edge_t *edge;
1638 foreach_out_edge(n, edge) {
1639 ir_node *succ = get_edge_src_irn(edge);
1641 fprintf(F, "edge: {sourcename: \"");
1643 fprintf(F, "\" targetname: \"");
1647 fprintf(F, " label: \"%d\" ", i);
1648 fprintf(F, OUT_EDGE_ATTR);
1655 /** Dumps a node and its edges but not the block edge */
1656 static void dump_node_wo_blockedge(ir_node *n, void *env) {
1659 dump_ir_data_edges(F, n);
1662 /** Dumps a node and its edges. */
1663 static void dump_whole_node(ir_node *n, void *env) {
1665 dump_node_wo_blockedge(n, env);
1666 if (!node_floats(n))
1667 dump_ir_block_edge(F, n);
1668 if (dump_new_edges_flag && edges_activated(current_ir_graph))
1669 dump_ir_edges(F, n);
1672 /** Dumps a const-like node. */
1673 static void dump_const_node(ir_node *n, void *env) {
1674 if (is_Block(n)) return;
1675 dump_node_wo_blockedge(n, env);
1678 /***********************************************************************/
1679 /* the following routines dump the nodes/irgs bracketed to graphs. */
1680 /***********************************************************************/
1682 /** Dumps a constant expression as entity initializer, array bound ...
1684 static void dump_const_expression(FILE *F, ir_node *value) {
1685 ir_graph *rem = current_ir_graph;
1686 int rem_dump_const_local = dump_const_local;
1687 dump_const_local = 0;
1688 current_ir_graph = get_const_code_irg();
1689 irg_walk(value, dump_const_node, NULL, F);
1690 /* Decrease visited flag so that we walk with the same flag for the next
1691 expression. This guarantees that we don't dump the same node twice,
1692 as for const expressions cse is performed to save memory. */
1693 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph) -1);
1694 current_ir_graph = rem;
1695 dump_const_local = rem_dump_const_local;
1698 /** Dump a block as graph containing its nodes.
1700 * Expects to find nodes belonging to the block as list in its
1702 * Dumps the edges of all nodes including itself. */
1703 static void dump_whole_block(FILE *F, ir_node *block) {
1705 ird_color_t color = ird_color_block_background;
1707 assert(is_Block(block));
1709 fprintf(F, "graph: { title: \"");
1710 PRINT_NODEID(block);
1711 fprintf(F, "\" label: \"");
1712 dump_node_label(F, block);
1714 /* colorize blocks */
1715 if (! get_Block_matured(block))
1716 color = ird_color_block_background;
1717 if (is_Block_dead(block))
1718 color = ird_color_dead_block_background;
1720 fprintf(F, "\" status:clustered ");
1721 print_vcg_color(F, color);
1724 /* yComp can show attributes for blocks, XVCG parses but ignores them */
1725 dump_node_info(F, block);
1726 print_dbg_info(F, get_irn_dbg_info(block));
1728 /* dump the blocks edges */
1729 dump_ir_data_edges(F, block);
1731 if (dump_block_edge_hook)
1732 dump_block_edge_hook(F, block);
1734 /* dump the nodes that go into the block */
1735 for (node = ird_get_irn_link(block); node; node = ird_get_irn_link(node)) {
1737 dump_ir_data_edges(F, node);
1740 /* Close the vcg information for the block */
1742 dump_const_node_local(F, block);
1746 /** dumps a graph block-wise. Expects all blockless nodes in arr in irgs link.
1747 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1749 dump_block_graph(FILE *F, ir_graph *irg) {
1751 ir_graph *rem = current_ir_graph;
1752 ir_node **arr = ird_get_irg_link(irg);
1753 current_ir_graph = irg;
1755 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1756 ir_node * node = arr[i];
1757 if (is_Block(node)) {
1758 /* Dumps the block and all the nodes in the block, which are to
1759 be found in Block->link. */
1760 dump_whole_block(F, node);
1762 /* Nodes that are not in a Block. */
1764 if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
1765 dump_const_block_local(F, node);
1767 dump_ir_data_edges(F, node);
1769 if (dump_new_edges_flag && edges_activated(irg))
1770 dump_ir_edges(F, node);
1773 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1774 dump_loop_nodes_into_graph(F, irg);
1776 current_ir_graph = rem;
1780 * Dump the info for an irg.
1781 * Parsed by XVCG but not shown. use yComp.
1783 static void dump_graph_info(FILE *F, ir_graph *irg) {
1784 fprintf(F, "info1: \"");
1785 dump_entity_to_file(F, get_irg_entity(irg), dump_verbosity_entattrs | dump_verbosity_entconsts);
1789 /** Dumps an irg as a graph clustered by block nodes.
1790 * If interprocedural view edges can point to nodes out of this graph.
1792 static void dump_graph_from_list(FILE *F, ir_graph *irg) {
1793 ir_entity *ent = get_irg_entity(irg);
1795 fprintf(F, "graph: { title: \"");
1797 fprintf(F, "\" label: \"%s\" status:clustered color:%s \n",
1798 get_ent_dump_name(ent), color_names[ird_color_prog_background]);
1800 dump_graph_info(F, irg);
1801 print_dbg_info(F, get_entity_dbg_info(ent));
1803 dump_block_graph(F, irg);
1805 /* Close the vcg information for the irg */
1806 fprintf(F, "}\n\n");
1809 /** dumps a graph extended block-wise. Expects all blockless nodes in arr in irgs link.
1810 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1812 dump_extblock_graph(FILE *F, ir_graph *irg) {
1814 ir_graph *rem = current_ir_graph;
1815 ir_extblk **arr = ird_get_irg_link(irg);
1816 current_ir_graph = irg;
1818 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1819 ir_extblk *extbb = arr[i];
1820 ir_node *leader = get_extbb_leader(extbb);
1823 fprintf(F, "graph: { title: \"");
1824 PRINT_EXTBBID(leader);
1825 fprintf(F, "\" label: \"ExtBB %ld\" status:clustered color:lightgreen\n",
1826 get_irn_node_nr(leader));
1828 for (j = ARR_LEN(extbb->blks) - 1; j >= 0; --j) {
1829 ir_node * node = extbb->blks[j];
1830 if (is_Block(node)) {
1831 /* Dumps the block and all the nodes in the block, which are to
1832 be found in Block->link. */
1833 dump_whole_block(F, node);
1835 /* Nodes that are not in a Block. */
1837 if (is_Bad(get_nodes_block(node)) && !node_floats(node)) {
1838 dump_const_block_local(F, node);
1840 dump_ir_data_edges(F, node);
1846 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1847 dump_loop_nodes_into_graph(F, irg);
1849 current_ir_graph = rem;
1854 /*******************************************************************/
1855 /* Basic type and entity nodes and edges. */
1856 /*******************************************************************/
1858 /** dumps the edges between nodes and their type or entity attributes. */
1859 static void dump_node2type_edges(ir_node *n, void *env)
1864 switch (get_irn_opcode(n)) {
1866 /* @@@ some consts have an entity */
1869 if (SYMCONST_HAS_TYPE(get_SymConst_kind(n)))
1870 print_node_type_edge(F,n,get_SymConst_type(n),NODE2TYPE_EDGE_ATTR);
1873 print_node_ent_edge(F,n,get_Sel_entity(n),NODE2TYPE_EDGE_ATTR);
1876 print_node_type_edge(F,n,get_Call_type(n),NODE2TYPE_EDGE_ATTR);
1879 print_node_type_edge(F,n,get_Alloc_type(n),NODE2TYPE_EDGE_ATTR);
1882 print_node_type_edge(F,n,get_Free_type(n),NODE2TYPE_EDGE_ATTR);
1885 print_node_type_edge(F,n,get_Cast_type(n),NODE2TYPE_EDGE_ATTR);
1893 static int print_type_info(FILE *F, ir_type *tp) {
1896 if (get_type_state(tp) == layout_undefined) {
1897 fprintf(F, "state: layout_undefined\n");
1899 fprintf(F, "state: layout_fixed,\n");
1901 if (get_type_mode(tp))
1902 fprintf(F, "mode: %s,\n", get_mode_name_ex(get_type_mode(tp), &bad));
1903 fprintf(F, "size: %db,\n", get_type_size_bits(tp));
1908 static void print_typespecific_info(FILE *F, ir_type *tp) {
1909 switch (get_type_tpop_code(tp)) {
1911 fprintf(F, "peculiarity: %s\n", get_peculiarity_string(get_class_peculiarity(tp)));
1916 fprintf(F, "variadicity: %s\n", get_variadicity_name(get_method_variadicity(tp)));
1917 fprintf(F, "params: %d\n", get_method_n_params(tp));
1918 fprintf(F, "results: %d\n", get_method_n_ress(tp));
1924 case tpo_enumeration:
1936 static void print_typespecific_vcgattr(FILE *F, ir_type *tp) {
1937 switch (get_type_tpop_code(tp)) {
1939 if (peculiarity_existent == get_class_peculiarity(tp))
1940 fprintf(F, " " TYPE_CLASS_NODE_ATTR);
1942 fprintf(F, " " TYPE_DESCRIPTION_NODE_ATTR);
1945 fprintf(F, " " TYPE_METH_NODE_ATTR);
1953 case tpo_enumeration:
1965 int dump_type_node(FILE *F, ir_type *tp)
1969 fprintf(F, "node: {title: ");
1971 fprintf(F, " label: \"%s %s\"", get_type_tpop_name(tp), get_type_name_ex(tp, &bad));
1972 fprintf(F, " info1: \"");
1974 bad |= print_type_info(F, tp);
1975 print_typespecific_info(F, tp);
1977 dump_type_to_file(F, tp, dump_verbosity_max);
1980 print_dbg_info(F, get_type_dbg_info(tp));
1981 print_typespecific_vcgattr(F, tp);
1988 void dump_entity_node(FILE *F, ir_entity *ent)
1990 fprintf(F, "node: {title: \"");
1991 PRINT_ENTID(ent); fprintf(F, "\"");
1992 fprintf(F, DEFAULT_TYPE_ATTRIBUTE);
1993 fprintf(F, "label: ");
1994 fprintf(F, "\"%s\" ", get_ent_dump_name(ent));
1996 print_vcg_color(F, ird_color_entity);
1997 fprintf(F, "\n info1: \"");
1999 dump_entity_to_file(F, ent, dump_verbosity_entattrs | dump_verbosity_entconsts);
2002 print_dbg_info(F, get_entity_dbg_info(ent));
2006 static void dump_enum_item(FILE *F, ir_type *tp, int pos)
2009 ir_enum_const *ec = get_enumeration_const(tp, pos);
2010 ident *id = get_enumeration_nameid(ec);
2011 tarval *tv = get_enumeration_value(ec);
2014 tarval_snprintf(buf, sizeof(buf), tv);
2016 strncpy(buf, "<not set>", sizeof(buf));
2017 fprintf(F, "node: {title: \"");
2018 PRINT_ITEMID(tp, pos); fprintf(F, "\"");
2019 fprintf(F, DEFAULT_ENUM_ITEM_ATTRIBUTE);
2020 fprintf(F, "label: ");
2021 fprintf(F, "\"enum item %s\" " ENUM_ITEM_NODE_ATTR, get_id_str(id));
2022 fprintf(F, "\n info1: \"value: %s\"}\n", buf);
2026 * Dumps a new style initializer.
2028 static void dump_entity_initializer(FILE *F, const ir_entity *ent) {
2034 /** Dumps a type or entity and it's edges. */
2035 static void dump_type_info(type_or_ent tore, void *env) {
2037 int i = 0; /* to shutup gcc */
2039 /* dump this type or entity */
2041 switch (get_kind(tore.ent)) {
2043 ir_entity *ent = tore.ent;
2046 dump_entity_node(F, ent);
2048 /* skip this to reduce graph. Member edge of type is parallel to this edge. *
2049 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2050 ENT_OWN_EDGE_ATTR "}\n", ent, get_entity_owner(ent));*/
2051 print_ent_type_edge(F,ent, get_entity_type(ent), ENT_TYPE_EDGE_ATTR);
2052 if (is_Class_type(get_entity_owner(ent))) {
2053 for (i = get_entity_n_overwrites(ent) - 1; i >= 0; --i)
2054 print_ent_ent_edge(F,ent, get_entity_overwrites(ent, i), 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2056 /* attached subgraphs */
2057 if (const_entities && (get_entity_variability(ent) != variability_uninitialized)) {
2058 if (is_atomic_entity(ent)) {
2059 value = get_atomic_ent_value(ent);
2061 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2062 /* DDMN(value); $$$ */
2063 dump_const_expression(F, value);
2066 if (is_compound_entity(ent)) {
2067 if (has_entity_initializer(ent)) {
2068 /* new style initializers */
2069 dump_entity_initializer(F, ent);
2071 /* old style compound entity values */
2072 for (i = get_compound_ent_n_values(ent) - 1; i >= 0; --i) {
2073 value = get_compound_ent_value(ent, i);
2075 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2076 dump_const_expression(F, value);
2077 print_ent_ent_edge(F, ent, get_compound_ent_value_member(ent, i), 0, -1, ENT_CORR_EDGE_ATTR, i);
2079 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2080 ENT_CORR_EDGE_ATTR "}\n", GET_ENTID(ent),
2081 get_compound_ent_value_member(ent, i), i);
2091 ir_type *tp = tore.typ;
2092 dump_type_node(F, tp);
2093 /* and now the edges */
2094 switch (get_type_tpop_code(tp)) {
2096 for (i = get_class_n_supertypes(tp) - 1; i >= 0; --i)
2097 print_type_type_edge(F, tp, get_class_supertype(tp, i), TYPE_SUPER_EDGE_ATTR);
2098 for (i = get_class_n_members(tp) - 1; i >= 0; --i)
2099 print_type_ent_edge(F, tp, get_class_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
2102 for (i = get_struct_n_members(tp) - 1; i >= 0; --i)
2103 print_type_ent_edge(F, tp, get_struct_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
2106 for (i = get_method_n_params(tp) - 1; i >= 0; --i)
2107 print_type_type_edge(F, tp, get_method_param_type(tp, i), METH_PAR_EDGE_ATTR,i);
2108 for (i = get_method_n_ress(tp) - 1; i >= 0; --i)
2109 print_type_type_edge(F, tp, get_method_res_type(tp, i), METH_RES_EDGE_ATTR,i);
2112 for (i = get_union_n_members(tp) - 1; i >= 0; --i)
2113 print_type_ent_edge(F, tp, get_union_member(tp, i), UNION_EDGE_ATTR);
2116 print_type_type_edge(F, tp, get_array_element_type(tp), ARR_ELT_TYPE_EDGE_ATTR);
2117 print_type_ent_edge(F, tp, get_array_element_entity(tp), ARR_ENT_EDGE_ATTR);
2118 for (i = get_array_n_dimensions(tp) - 1; i >= 0; --i) {
2119 ir_node *upper = get_array_upper_bound(tp, i);
2120 ir_node *lower = get_array_lower_bound(tp, i);
2121 print_node_type_edge(F, upper, tp, "label: \"upper %d\"", get_array_order(tp, i));
2122 print_node_type_edge(F, lower, tp, "label: \"lower %d\"", get_array_order(tp, i));
2123 dump_const_expression(F, upper);
2124 dump_const_expression(F, lower);
2127 case tpo_enumeration:
2128 for (i = get_enumeration_n_enums(tp) - 1; i >= 0; --i) {
2129 dump_enum_item(F, tp, i);
2130 print_enum_item_edge(F, tp, i, "label: \"item %d\"", i);
2134 print_type_type_edge(F, tp, get_pointer_points_to_type(tp), PTR_PTS_TO_EDGE_ATTR);
2141 break; /* case k_type */
2144 printf(" *** irdump, dump_type_info(l.%i), faulty type.\n", __LINE__);
2145 } /* switch kind_or_entity */
2148 typedef struct _h_env {
2153 /** For dumping class hierarchies.
2154 * Dumps a class type node and a superclass edge.
2155 * If env->dump_ent dumps entities of classes and overwrites edges.
2158 dump_class_hierarchy_node(type_or_ent tore, void *ctx) {
2161 int i = 0; /* to shutup gcc */
2163 /* dump this type or entity */
2164 switch (get_kind(tore.ent)) {
2166 ir_entity *ent = tore.ent;
2167 if (get_entity_owner(ent) == get_glob_type()) break;
2168 if (!is_Method_type(get_entity_type(ent)))
2170 if (env->dump_ent && is_Class_type(get_entity_owner(ent))) {
2172 dump_entity_node(F, ent);
2174 print_type_ent_edge(F, get_entity_owner(ent), ent, TYPE_MEMBER_EDGE_ATTR);
2175 for (i = get_entity_n_overwrites(ent) - 1; i >= 0; --i)
2176 print_ent_ent_edge(F, get_entity_overwrites(ent, i), ent, 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2181 ir_type *tp = tore.typ;
2182 if (tp == get_glob_type())
2184 switch (get_type_tpop_code(tp)) {
2186 dump_type_node(F, tp);
2187 /* and now the edges */
2188 for (i = get_class_n_supertypes(tp) - 1; i >= 0; --i) {
2189 print_type_type_edge(F,tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2194 break; /* case k_type */
2197 printf(" *** irdump, dump_class_hierarchy_node(l.%i), faulty type.\n", __LINE__);
2198 } /* switch kind_or_entity */
2201 /*******************************************************************/
2202 /* dump analysis information that is expressed in graph terms. */
2203 /*******************************************************************/
2205 /* dump out edges */
2207 dump_out_edge(ir_node *n, void *env) {
2210 for (i = get_irn_n_outs(n) - 1; i >= 0; --i) {
2211 ir_node *succ = get_irn_out(n, i);
2213 fprintf(F, "edge: {sourcename: \"");
2215 fprintf(F, "\" targetname: \"");
2217 fprintf(F, "\" color: red linestyle: dashed");
2223 dump_loop_label(FILE *F, ir_loop *loop) {
2224 fprintf(F, "loop %d, %d sons, %d nodes",
2225 get_loop_depth(loop), get_loop_n_sons(loop), get_loop_n_nodes(loop));
2228 static inline void dump_loop_info(FILE *F, ir_loop *loop) {
2229 fprintf(F, " info1: \"");
2230 fprintf(F, " loop nr: %d", get_loop_loop_nr(loop));
2231 #ifdef DEBUG_libfirm /* GL @@@ debug analyses */
2232 fprintf(F, "\n The loop was analyzed %d times.", PTR_TO_INT(get_loop_link(loop)));
2238 dump_loop_node(FILE *F, ir_loop *loop) {
2239 fprintf(F, "node: {title: \"");
2241 fprintf(F, "\" label: \"");
2242 dump_loop_label(F, loop);
2244 dump_loop_info(F, loop);
2249 dump_loop_node_edge(FILE *F, ir_loop *loop, int i) {
2251 fprintf(F, "edge: {sourcename: \"");
2253 fprintf(F, "\" targetname: \"");
2254 PRINT_NODEID(get_loop_node(loop, i));
2255 fprintf(F, "\" color: green");
2260 dump_loop_son_edge(FILE *F, ir_loop *loop, int i) {
2262 fprintf(F, "edge: {sourcename: \"");
2264 fprintf(F, "\" targetname: \"");
2265 PRINT_LOOPID(get_loop_son(loop, i));
2266 fprintf(F, "\" color: darkgreen label: \"%d\"}\n",
2267 get_loop_element_pos(loop, get_loop_son(loop, i)));
2271 void dump_loops(FILE *F, ir_loop *loop) {
2273 /* dump this loop node */
2274 dump_loop_node(F, loop);
2276 /* dump edges to nodes in loop -- only if it is a real loop */
2277 if (get_loop_depth(loop) != 0) {
2278 for (i = get_loop_n_nodes(loop) - 1; i >= 0; --i) {
2279 dump_loop_node_edge(F, loop, i);
2282 for (i = get_loop_n_sons(loop) - 1; i >= 0; --i) {
2283 dump_loops(F, get_loop_son(loop, i));
2284 dump_loop_son_edge(F, loop, i);
2289 void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg) {
2290 ir_loop *loop = get_irg_loop(irg);
2293 ir_graph *rem = current_ir_graph;
2294 current_ir_graph = irg;
2296 dump_loops(F, loop);
2298 current_ir_graph = rem;
2304 * dumps the VCG header
2306 void dump_vcg_header(FILE *F, const char *name, const char *layout, const char *orientation) {
2312 label = edge_label ? "yes" : "no";
2313 if (! layout) layout = "Compilergraph";
2314 if (!orientation) orientation = "bottom_to_top";
2318 "graph: { title: \"ir graph of %s\"\n"
2319 "display_edge_labels: %s\n"
2320 "layoutalgorithm: mindepth //$ \"%s\"\n"
2321 "manhattan_edges: yes\n"
2322 "port_sharing: no\n"
2324 "classname 1: \"intrablock Data\"\n"
2325 "classname 2: \"Block\"\n"
2326 "classname 3: \"Entity type\"\n"
2327 "classname 4: \"Entity owner\"\n"
2328 "classname 5: \"Method Param\"\n"
2329 "classname 6: \"Method Res\"\n"
2330 "classname 7: \"Super\"\n"
2331 "classname 8: \"Union\"\n"
2332 "classname 9: \"Points-to\"\n"
2333 "classname 10: \"Array Element Type\"\n"
2334 "classname 11: \"Overwrites\"\n"
2335 "classname 12: \"Member\"\n"
2336 "classname 13: \"Control Flow\"\n"
2337 "classname 14: \"intrablock Memory\"\n"
2338 "classname 15: \"Dominators\"\n"
2339 "classname 16: \"interblock Data\"\n"
2340 "classname 17: \"interblock Memory\"\n"
2341 "classname 18: \"Exception Control Flow for Interval Analysis\"\n"
2342 "classname 19: \"Postdominators\"\n"
2343 "classname 20: \"Keep Alive\"\n"
2344 "classname 21: \"Out Edges\"\n"
2345 "classname 22: \"Macro Block Edges\"\n"
2346 //"classname 23: \"NoInput Nodes\"\n"
2347 "infoname 1: \"Attribute\"\n"
2348 "infoname 2: \"Verification errors\"\n"
2349 "infoname 3: \"Debug info\"\n",
2350 name, label, layout, orientation);
2352 for (i = 0; i < ird_color_count; ++i) {
2353 if (color_rgb[i] != NULL) {
2354 fprintf(F, "colorentry %s: %s\n", color_names[i], color_rgb[i]);
2357 fprintf(F, "\n"); /* a separator */
2363 * @param irg The graph to be dumped
2364 * @param suffix1 first filename suffix
2365 * @param suffix2 second filename suffix
2367 FILE *vcg_open(const ir_graph *irg, const char *suffix1, const char *suffix2) {
2369 const char *nm = get_irg_dump_name(irg);
2370 int len = strlen(nm), i, j;
2371 char *fname; /* filename to put the vcg information in */
2373 if (!suffix1) suffix1 = "";
2374 if (!suffix2) suffix2 = "";
2376 /* open file for vcg graph */
2377 fname = XMALLOCN(char, len * 2 + strlen(suffix1) + strlen(suffix2) + 5);
2379 /* strncpy (fname, nm, len); */ /* copy the filename */
2381 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2383 fname[j] = '@'; j++; fname[j] = '1'; j++;
2384 } else if (nm[i] == '@') {
2385 fname[j] = '@'; j++; fname[j] = '2'; j++;
2387 fname[j] = nm[i]; j++;
2391 strcat(fname, suffix1); /* append file suffix */
2392 strcat(fname, suffix2); /* append file suffix */
2393 strcat(fname, ".vcg"); /* append the .vcg suffix */
2395 /* vcg really expect only a <CR> at end of line, so
2396 * the "b"inary mode is what you mean (and even needed for Win32)
2398 F = fopen(fname, "wb"); /* open file for writing */
2410 * @param name prefix file name
2411 * @param suffix filename suffix
2413 FILE *vcg_open_name(const char *name, const char *suffix) {
2415 char *fname; /* filename to put the vcg information in */
2416 int i, j, len = strlen(name);
2418 if (!suffix) suffix = "";
2420 /** open file for vcg graph */
2421 fname = XMALLOCN(char, len * 2 + 5 + strlen(suffix));
2422 /* strcpy (fname, name);*/ /* copy the filename */
2424 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2425 if (name[i] == '/') {
2426 fname[j] = '@'; j++; fname[j] = '1'; j++;
2427 } else if (name[i] == '@') {
2428 fname[j] = '@'; j++; fname[j] = '2'; j++;
2430 fname[j] = name[i]; j++;
2434 strcat(fname, suffix);
2435 strcat(fname, ".vcg"); /* append the .vcg suffix */
2437 /* vcg really expect only a <CR> at end of line, so
2438 * the "b"inary mode is what you mean (and even needed for Win32)
2440 F = fopen(fname, "wb"); /* open file for writing */
2450 * Dumps the vcg file footer
2452 void dump_vcg_footer(FILE *F) {
2456 /************************************************************************/
2457 /************************************************************************/
2458 /* Routines that dump all or parts of the firm representation to a file */
2459 /************************************************************************/
2460 /************************************************************************/
2462 /************************************************************************/
2463 /* Dump ir graphs, different formats and additional information. */
2464 /************************************************************************/
2466 typedef void (*do_dump_graph_func) (ir_graph *irg, FILE *out);
2468 static void do_dump(ir_graph *irg, const char *suffix, const char *suffix_ip,
2469 const char *suffix_nonip, do_dump_graph_func dump_func)
2473 const char *suffix1;
2475 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2478 rem = current_ir_graph;
2479 current_ir_graph = irg;
2480 if (get_interprocedural_view())
2481 suffix1 = suffix_ip;
2483 suffix1 = suffix_nonip;
2484 current_ir_graph = rem;
2486 out = vcg_open(irg, suffix, suffix1);
2488 dump_func(irg, out);
2493 void dump_ir_graph_file(ir_graph *irg, FILE *out)
2495 if (dump_backedge_information_flag
2496 && get_irg_loopinfo_state(irg) != loopinfo_consistent) {
2497 construct_backedges(irg);
2500 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2502 /* call the dump graph hook */
2503 if (dump_ir_graph_hook) {
2504 if (dump_ir_graph_hook(out, irg)) {
2509 /* walk over the graph */
2510 /* dump_whole_node must be called in post visiting predecessors */
2511 ird_walk_graph(irg, NULL, dump_whole_node, out);
2513 /* dump the out edges in a separate walk */
2514 if ((dump_out_edge_flag) && (get_irg_outs_state(irg) != outs_none)) {
2515 irg_out_walk(get_irg_start(irg), dump_out_edge, NULL, out);
2518 dump_vcg_footer(out);
2521 /** Routine to dump a graph, blocks as conventional nodes. */
2522 void dump_ir_graph(ir_graph *irg, const char *suffix )
2524 do_dump(irg, suffix, "-pure-ip", "-pure", dump_ir_graph_file);
2527 void dump_ir_block_graph_file(ir_graph *irg, FILE *out)
2531 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2533 construct_block_lists(irg);
2536 * If we are in the interprocedural view, we dump not
2537 * only the requested irg but also all irgs that can be reached
2540 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2541 ir_graph *g = get_irp_irg(i);
2542 ir_node **arr = ird_get_irg_link(g);
2544 dump_graph_from_list(out, g);
2549 dump_vcg_footer(out);
2552 /* Dump a firm graph without explicit block nodes. */
2553 void dump_ir_block_graph(ir_graph *irg, const char *suffix)
2555 do_dump(irg, suffix, "-ip", "", dump_ir_block_graph_file);
2558 void dump_ir_extblock_graph_file(ir_graph *irg, FILE *F)
2561 ir_entity *ent = get_irg_entity(irg);
2563 if (get_irg_extblk_state(irg) != extblk_valid)
2566 dump_vcg_header(F, get_irg_dump_name(irg), NULL, NULL);
2568 construct_extblock_lists(irg);
2570 fprintf(F, "graph: { title: \"");
2572 fprintf(F, "\" label: \"%s\" status:clustered color: white \n",
2573 get_ent_dump_name(ent));
2575 dump_graph_info(F, irg);
2576 print_dbg_info(F, get_entity_dbg_info(ent));
2578 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2579 ir_graph *irg = get_irp_irg(i);
2580 list_tuple *lists = ird_get_irg_link(irg);
2583 /* dump the extended blocks first */
2584 if (ARR_LEN(lists->extbb_list)) {
2585 ird_set_irg_link(irg, lists->extbb_list);
2586 dump_extblock_graph(F, irg);
2589 /* we may have blocks without extended blocks, bad for instance */
2590 if (ARR_LEN(lists->blk_list)) {
2591 ird_set_irg_link(irg, lists->blk_list);
2592 dump_block_graph(F, irg);
2595 DEL_ARR_F(lists->extbb_list);
2596 DEL_ARR_F(lists->blk_list);
2601 /* Close the vcg information for the irg */
2602 fprintf(F, "}\n\n");
2608 /* Dump a firm graph without explicit block nodes but grouped in extended blocks. */
2609 void dump_ir_extblock_graph(ir_graph *irg, const char *suffix)
2611 do_dump(irg, suffix, "-ip", "", dump_ir_extblock_graph_file);
2614 void dump_ir_graph_w_types_file(ir_graph *irg, FILE *out)
2616 ir_graph *rem = current_ir_graph;
2617 int rem_dump_const_local;
2619 rem = current_ir_graph;
2620 current_ir_graph = irg;
2621 rem_dump_const_local = dump_const_local;
2622 /* dumping types does not work with local nodes */
2623 dump_const_local = 0;
2625 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2627 /* dump common ir graph */
2628 irg_walk(get_irg_end(irg), NULL, dump_whole_node, out);
2629 /* dump type info */
2630 type_walk_irg(irg, dump_type_info, NULL, out);
2631 inc_irg_visited(get_const_code_irg());
2632 /* dump edges from graph to type info */
2633 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2635 dump_vcg_footer(out);
2636 dump_const_local = rem_dump_const_local;
2637 current_ir_graph = rem;
2640 /* dumps a graph with type information */
2641 void dump_ir_graph_w_types(ir_graph *irg, const char *suffix)
2643 do_dump(irg, suffix, "-pure-wtypes-ip", "-pure-wtypes",
2644 dump_ir_graph_w_types_file);
2647 void dump_ir_block_graph_w_types_file(ir_graph *irg, FILE *out)
2650 int rem_dump_const_local;
2651 ir_graph *rem = current_ir_graph;
2653 rem_dump_const_local = dump_const_local;
2654 /* dumping types does not work with local nodes */
2655 dump_const_local = 0;
2657 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2659 /* dump common blocked ir graph */
2660 construct_block_lists(irg);
2662 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2663 ir_node **arr = ird_get_irg_link(get_irp_irg(i));
2665 dump_graph_from_list(out, get_irp_irg(i));
2670 /* dump type info */
2671 current_ir_graph = irg;
2672 type_walk_irg(irg, dump_type_info, NULL, out);
2673 inc_irg_visited(get_const_code_irg());
2675 /* dump edges from graph to type info */
2676 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2678 dump_vcg_footer(out);
2679 dump_const_local = rem_dump_const_local;
2680 current_ir_graph = rem;
2683 void dump_ir_block_graph_w_types(ir_graph *irg, const char *suffix)
2685 do_dump(irg, suffix, "-wtypes-ip", "-wtypes",
2686 dump_ir_block_graph_w_types_file);
2689 /*---------------------------------------------------------------------*/
2690 /* The following routines dump a control flow graph. */
2691 /*---------------------------------------------------------------------*/
2694 dump_block_to_cfg(ir_node *block, void *env) {
2699 if (is_Block(block)) {
2700 /* This is a block. Dump a node for the block. */
2701 fprintf(F, "node: {title: \""); PRINT_NODEID(block);
2702 fprintf(F, "\" label: \"");
2703 if (block == get_irg_start_block(get_irn_irg(block)))
2704 fprintf(F, "Start ");
2705 if (block == get_irg_end_block(get_irn_irg(block)))
2708 fprintf(F, "%s ", get_op_name(get_irn_op(block)));
2709 PRINT_NODEID(block);
2711 fprintf(F, "info1:\"");
2713 /* the generic version. */
2714 dump_irnode_to_file(F, block);
2716 /* Check whether we have bad predecessors to color the block. */
2717 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
2718 if ((fl = is_Bad(get_Block_cfgpred(block, i))))
2721 fprintf(F, "\""); /* closing quote of info */
2723 if ((block == get_irg_start_block(get_irn_irg(block))) ||
2724 (block == get_irg_end_block(get_irn_irg(block))) )
2725 fprintf(F, " color:blue ");
2727 fprintf(F, " color:yellow ");
2730 /* Dump the edges */
2731 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
2732 if (!is_Bad(skip_Proj(get_Block_cfgpred(block, i)))) {
2733 pred = get_nodes_block(skip_Proj(get_Block_cfgpred(block, i)));
2734 fprintf(F, "edge: { sourcename: \"");
2735 PRINT_NODEID(block);
2736 fprintf(F, "\" targetname: \"");
2738 fprintf(F, "\"}\n");
2741 /* Dump dominator/postdominator edge */
2742 if (dump_dominator_information_flag) {
2743 if (get_irg_dom_state(current_ir_graph) == dom_consistent && get_Block_idom(block)) {
2744 pred = get_Block_idom(block);
2745 fprintf(F, "edge: { sourcename: \"");
2746 PRINT_NODEID(block);
2747 fprintf(F, "\" targetname: \"");
2749 fprintf(F, "\" " DOMINATOR_EDGE_ATTR "}\n");
2751 if (get_irg_postdom_state(current_ir_graph) == dom_consistent && get_Block_ipostdom(block)) {
2752 pred = get_Block_ipostdom(block);
2753 fprintf(F, "edge: { sourcename: \"");
2754 PRINT_NODEID(block);
2755 fprintf(F, "\" targetname: \"");
2757 fprintf(F, "\" " POSTDOMINATOR_EDGE_ATTR "}\n");
2763 void dump_cfg(ir_graph *irg, const char *suffix)
2766 /* if a filter is set, dump only the irg's that match the filter */
2767 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2770 f = vcg_open(irg, suffix, "-cfg");
2772 ir_graph *rem = current_ir_graph;
2773 #ifdef INTERPROCEDURAL_VIEW
2774 int ipv = get_interprocedural_view();
2777 current_ir_graph = irg;
2778 dump_vcg_header(f, get_irg_dump_name(irg), NULL, NULL);
2780 #ifdef INTERPROCEDURAL_VIEW
2782 printf("Warning: dumping cfg not in interprocedural view!\n");
2783 set_interprocedural_view(0);
2787 /* walk over the blocks in the graph */
2788 irg_block_walk(get_irg_end(irg), dump_block_to_cfg, NULL, f);
2789 dump_node(f, get_irg_bad(irg));
2791 #ifdef INTERPROCEDURAL_VIEW
2792 set_interprocedural_view(ipv);
2796 current_ir_graph = rem;
2801 static void descend_and_dump(FILE *F, ir_node *n, int depth, pset *mark_set) {
2802 if (pset_find_ptr(mark_set, n))
2805 pset_insert_ptr(mark_set, n);
2808 int i, start = is_Block(n) ? 0 : -1;
2809 dump_whole_node(n, F);
2810 for (i = start; i < get_irn_arity(n); ++i)
2811 descend_and_dump(F, get_irn_n(n, i), depth-1, mark_set);
2814 /* Don't dump edges to nodes further out. These might be edges to
2815 nodes we already dumped, if there is a shorter path to these. */
2819 static int subgraph_counter = 0;
2820 void dump_subgraph(ir_node *root, int depth, const char *suffix) {
2824 sprintf(buf, "-subg_%03d", subgraph_counter++);
2825 F = vcg_open(get_irn_irg(root), suffix, buf);
2827 pset *mark_set = pset_new_ptr(1);
2828 dump_vcg_header(F, get_irg_dump_name(get_irn_irg(root)), NULL, NULL);
2829 descend_and_dump(F, root, depth, mark_set);
2836 void dump_callgraph(const char *suffix) {
2837 FILE *F = vcg_open_name("Callgraph", suffix);
2840 int i, rem = edge_label;
2843 dump_vcg_header(F, "Callgraph", "Hierarchiv", NULL);
2845 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2846 ir_graph *irg = get_irp_irg(i);
2847 ir_entity *ent = get_irg_entity(irg);
2849 int n_callees = get_irg_n_callees(irg);
2851 dump_entity_node(F, ent);
2852 for (j = 0; j < n_callees; ++j) {
2853 ir_entity *c = get_irg_entity(get_irg_callee(irg, j));
2854 //if (id_is_prefix(prefix, get_entity_ld_ident(c))) continue;
2855 int be = is_irg_callee_backedge(irg, j);
2858 "label:\"recursion %d\"" :
2859 "label:\"calls %d\"";
2860 print_ent_ent_edge(F, ent, c, be, ird_color_entity, attr, get_irg_callee_loop_depth(irg, j));
2871 /* Dump all irgs in interprocedural view to a single file. */
2872 void dump_all_cg_block_graph(const char *suffix) {
2873 FILE *f = vcg_open_name("All_graphs", suffix);
2877 int rem_view = get_interprocedural_view();
2879 set_interprocedural_view(1);
2880 dump_vcg_header(f, "All_graphs", NULL);
2882 /* collect nodes in all irgs reachable in call graph*/
2883 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2884 ird_set_irg_link(get_irp_irg(i), NULL);
2886 cg_walk(clear_link, collect_node, NULL);
2888 /* dump all graphs */
2889 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2890 current_ir_graph = get_irp_irg(i);
2891 assert(ird_get_irg_link(current_ir_graph));
2892 dump_graph_from_list(f, current_ir_graph);
2893 DEL_ARR_F(ird_get_irg_link(current_ir_graph));
2898 set_interprocedural_view(rem_view);
2903 /*---------------------------------------------------------------------*/
2904 /* the following routines dumps type information without any ir nodes. */
2905 /*---------------------------------------------------------------------*/
2908 dump_type_graph(ir_graph *irg, const char *suffix)
2912 /* if a filter is set, dump only the irg's that match the filter */
2913 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
2915 f = vcg_open(irg, suffix, "-type");
2917 ir_graph *rem = current_ir_graph;
2918 current_ir_graph = irg;
2920 dump_vcg_header(f, get_irg_dump_name(irg), "Hierarchic", NULL);
2922 /* walk over the blocks in the graph */
2923 type_walk_irg(irg, dump_type_info, NULL, f);
2924 /* The walker for the const code can be called several times for the
2925 same (sub) expression. So that no nodes are dumped several times
2926 we decrease the visited flag of the corresponding graph after each
2927 walk. So now increase it finally. */
2928 inc_irg_visited(get_const_code_irg());
2932 current_ir_graph = rem;
2937 dump_all_types(const char *suffix)
2939 FILE *f = vcg_open_name("All_types", suffix);
2941 dump_vcg_header(f, "All_types", "Hierarchic", NULL);
2942 type_walk(dump_type_info, NULL, f);
2943 inc_irg_visited(get_const_code_irg());
2951 dump_class_hierarchy(int entities, const char *suffix)
2953 FILE *f = vcg_open_name("class_hierarchy", suffix);
2958 env.dump_ent = entities;
2959 dump_vcg_header(f, "class_hierarchy", "Hierarchic", NULL);
2960 type_walk(dump_class_hierarchy_node, NULL, &env);
2967 /*---------------------------------------------------------------------*/
2968 /* dumps all graphs with the graph-dumper passed. Possible dumpers: */
2970 /* dump_ir_block_graph */
2972 /* dump_type_graph */
2973 /* dump_ir_graph_w_types */
2974 /*---------------------------------------------------------------------*/
2976 void dump_all_ir_graphs(dump_graph_func *dmp_grph, const char *suffix) {
2978 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2979 dmp_grph(get_irp_irg(i), suffix);
2983 ir_prog_pass_t pass;
2984 dump_graph_func *dump_graph;
2989 * Wrapper around dump_all_ir_graphs().
2991 static int dump_all_ir_graphs_wrapper(ir_prog *irp, void *context) {
2992 struct pass_t *pass = context;
2995 dump_all_ir_graphs(pass->dump_graph, pass->suffix);
2999 ir_prog_pass_t *dump_all_ir_graph_pass(
3000 const char *name, dump_graph_func *dump_graph, const char *suffix) {
3001 size_t len = strlen(suffix);
3002 struct pass_t *pass = xmalloc(sizeof(*pass) + len);
3003 ir_prog_pass_t *res = def_prog_pass_constructor(
3004 &pass->pass, name ? name : "dump_all_graphs", dump_all_ir_graphs_wrapper);
3006 /* this pass does not change anything, so neither dump nor verify is needed. */
3007 res->dump_irprog = ir_prog_no_dump;
3008 res->verify_irprog = ir_prog_no_verify;
3010 pass->dump_graph = dump_graph;
3011 strcpy(pass->suffix, suffix);
3016 /*--------------------------------------------------------------------------------*
3017 * Dumps a stand alone loop graph with firm nodes which belong to one loop node *
3018 * packed together in one subgraph/box *
3019 *--------------------------------------------------------------------------------*/
3021 void dump_loops_standalone(FILE *F, ir_loop *loop) {
3022 int i = 0, loop_node_started = 0, son_number = 0, first = 0;
3024 ir_loop *son = NULL;
3026 /* Dump a new loop node. */
3027 dump_loop_node(F, loop);
3029 /* Dump the loop elements. */
3030 for (i = 0; i < get_loop_n_elements(loop); i++) {
3031 le = get_loop_element(loop, i);
3033 if (get_kind(son) == k_ir_loop) {
3035 /* We are a loop son -> Recurse */
3037 if (loop_node_started) { /* Close the "firm-nodes" node first if we started one. */
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;
3046 dump_loop_son_edge(F, loop, son_number++);
3047 dump_loops_standalone(F, son);
3048 } else if (get_kind(son) == k_ir_node) {
3049 /* We are a loop node -> Collect firm nodes */
3051 ir_node *n = le.node;
3054 if (!loop_node_started) {
3055 /* Start a new node which contains all firm nodes of the current loop */
3056 fprintf(F, "node: { title: \"");
3058 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3059 loop_node_started = 1;
3064 bad |= dump_node_label(F, n);
3065 /* Causes indeterministic output: if (is_Block(n)) fprintf(F, "\t ->%d", (int)get_irn_link(n)); */
3066 if (has_backedges(n)) fprintf(F, "\t loop head!");
3067 } else { /* for callgraph loop tree */
3069 assert(get_kind(son) == k_ir_graph);
3071 /* We are a loop node -> Collect firm graphs */
3073 if (!loop_node_started) {
3074 /* Start a new node which contains all firm nodes of the current loop */
3075 fprintf(F, "node: { title: \"");
3077 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3078 loop_node_started = 1;
3082 fprintf(F, " %s", get_irg_dump_name(n));
3083 /* fprintf(F, " %s (depth %d)", get_irg_dump_name(n), n->callgraph_weighted_loop_depth); */
3087 if (loop_node_started) {
3088 fprintf(F, "\" }\n");
3089 fprintf(F, "edge: {sourcename: \"");
3091 fprintf(F, "\" targetname: \"");
3093 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3094 loop_node_started = 0;
3098 void dump_loop_tree(ir_graph *irg, const char *suffix)
3102 /* if a filter is set, dump only the irg's that match the filter */
3103 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
3106 f = vcg_open(irg, suffix, "-looptree");
3108 ir_graph *rem = current_ir_graph;
3109 int el_rem = edge_label;
3111 current_ir_graph = irg;
3114 dump_vcg_header(f, get_irg_dump_name(irg), "Tree", "top_to_bottom");
3116 if (get_irg_loop(irg))
3117 dump_loops_standalone(f, get_irg_loop(irg));
3122 edge_label = el_rem;
3123 current_ir_graph = rem;
3127 void dump_callgraph_loop_tree(const char *suffix) {
3129 F = vcg_open_name("Callgraph_looptree", suffix);
3130 dump_vcg_header(F, "callgraph looptree", "Tree", "top_to_bottom");
3131 dump_loops_standalone(F, irp->outermost_cg_loop);
3137 /*----------------------------------------------------------------------------*/
3138 /* Dumps the firm nodes in the loop tree to a graph along with the loop nodes.*/
3139 /*----------------------------------------------------------------------------*/
3141 void collect_nodeloop(FILE *F, ir_loop *loop, eset *loopnodes) {
3142 int i, son_number = 0, node_number = 0;
3144 if (dump_loop_information_flag) dump_loop_node(F, loop);
3146 for (i = 0; i < get_loop_n_elements(loop); i++) {
3147 loop_element le = get_loop_element(loop, i);
3148 if (*(le.kind) == k_ir_loop) {
3149 if (dump_loop_information_flag) dump_loop_son_edge(F, loop, son_number++);
3151 collect_nodeloop(F, le.son, loopnodes);
3153 if (dump_loop_information_flag) dump_loop_node_edge(F, loop, node_number++);
3154 eset_insert(loopnodes, le.node);
3159 void collect_nodeloop_external_nodes(ir_loop *loop, eset *loopnodes, eset *extnodes) {
3162 for(i = 0; i < get_loop_n_elements(loop); i++) {
3163 loop_element le = get_loop_element(loop, i);
3164 if (*(le.kind) == k_ir_loop) {
3166 collect_nodeloop_external_nodes(le.son, loopnodes, extnodes);
3168 if (is_Block(le.node)) start = 0; else start = -1;
3169 for (j = start; j < get_irn_arity(le.node); j++) {
3170 ir_node *pred = get_irn_n(le.node, j);
3171 if (!eset_contains(loopnodes, pred)) {
3172 eset_insert(extnodes, pred);
3173 if (!is_Block(pred)) {
3174 pred = get_nodes_block(pred);
3175 if (!eset_contains(loopnodes, pred)) eset_insert(extnodes, pred);
3183 void dump_loop(ir_loop *l, const char *suffix) {
3187 snprintf(name, sizeof(name), "loop_%d", get_loop_loop_nr(l));
3188 F = vcg_open_name(name, suffix);
3190 eset *loopnodes = eset_create();
3191 eset *extnodes = eset_create();
3194 dump_vcg_header(F, name, NULL, NULL);
3196 /* collect all nodes to dump */
3197 collect_nodeloop(F, l, loopnodes);
3198 collect_nodeloop_external_nodes(l, loopnodes, extnodes);
3200 /* build block lists */
3201 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes))
3202 set_irn_link(n, NULL);
3203 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes))
3204 set_irn_link(n, NULL);
3205 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes)) {
3207 b = get_nodes_block(n);
3208 set_irn_link(n, get_irn_link(b));
3212 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes)) {
3214 b = get_nodes_block(n);
3215 set_irn_link(n, get_irn_link(b));
3220 for (b = eset_first(loopnodes); b != NULL; b = eset_next(loopnodes)) {
3222 fprintf(F, "graph: { title: \"");
3224 fprintf(F, "\" label: \"");
3225 dump_node_opcode(F, b);
3226 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3227 fprintf(F, "\" status:clustered color:yellow\n");
3229 /* dump the blocks edges */
3230 dump_ir_data_edges(F, b);
3232 /* dump the nodes that go into the block */
3233 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3234 if (eset_contains(extnodes, n))
3235 overrule_nodecolor = ird_color_block_inout;
3237 overrule_nodecolor = ird_color_default_node;
3238 if (!eset_contains(extnodes, n)) dump_ir_data_edges(F, n);
3241 /* Close the vcg information for the block */
3243 dump_const_node_local(F, b);
3247 for (b = eset_first(extnodes); b != NULL; b = eset_next(extnodes)) {
3249 fprintf(F, "graph: { title: \"");
3251 fprintf(F, "\" label: \"");
3252 dump_node_opcode(F, b);
3253 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3254 fprintf(F, "\" status:clustered color:lightblue\n");
3256 /* dump the nodes that go into the block */
3257 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3258 if (!eset_contains(loopnodes, n))
3259 overrule_nodecolor = ird_color_block_inout;
3261 overrule_nodecolor = ird_color_default_node;
3262 if (eset_contains(loopnodes, n)) dump_ir_data_edges(F, n);
3265 /* Close the vcg information for the block */
3267 dump_const_node_local(F, b);
3271 eset_destroy(loopnodes);
3272 eset_destroy(extnodes);