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);
262 #define CUSTOM_COLOR_BASE 100
263 static const char *color_names[ird_color_count];
264 static const char *color_rgb[ird_color_count];
265 static struct obstack color_obst;
267 /** define a custom color. */
268 static void custom_color(int num, const char *rgb_def)
270 assert(num < ird_color_count);
271 obstack_printf(&color_obst, "%d", CUSTOM_COLOR_BASE + num);
272 obstack_1grow(&color_obst, '\0');
274 color_rgb[num] = rgb_def;
275 color_names[num] = obstack_finish(&color_obst);
278 /** Define a named color. */
279 static void named_color(int num, const char *name)
281 assert(num < ird_color_count);
282 color_rgb[num] = NULL;
283 color_names[num] = name;
286 /** Initializes the used colors. */
287 static void init_colors(void)
289 static int initialized = 0;
293 obstack_init(&color_obst);
295 custom_color(ird_color_prog_background, "204 204 204");
296 custom_color(ird_color_block_background, "255 255 0");
297 custom_color(ird_color_dead_block_background, "190 150 150");
298 named_color(ird_color_block_inout, "lightblue");
299 named_color(ird_color_default_node, "white");
300 custom_color(ird_color_memory, "153 153 255");
301 custom_color(ird_color_controlflow, "255 153 153");
302 custom_color(ird_color_const, "204 255 255");
303 custom_color(ird_color_proj, "255 255 153");
304 custom_color(ird_color_uses_memory, "153 153 255");
305 custom_color(ird_color_phi, "105 255 105");
306 custom_color(ird_color_anchor, "100 100 255");
307 named_color(ird_color_error, "red");
308 custom_color(ird_color_entity, "204 204 255");
314 * Prints the VCG color to a file.
316 static void print_vcg_color(FILE *F, ird_color_t color) {
317 assert(color < ird_color_count);
318 fprintf(F, "color:%s", color_names[color]);
322 * Prints the edge kind of a given IR node.
324 * Projs should be dumped near their predecessor, so they get "nearedge".
326 static void print_node_edge_kind(FILE *F, ir_node *node) {
328 fprintf(F, "nearedge: ");
330 fprintf(F, "edge: ");
335 * Prints the edge from a type S to a type T with additional info fmt, ...
338 static void print_type_type_edge(FILE *F, const ir_type *S, const ir_type *T, const char *fmt, ...)
343 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(S);
344 fprintf(F, " targetname: "); PRINT_TYPEID(T);
345 vfprintf(F, fmt, ap);
351 * Prints the edge from a type tp to an entity ent with additional info fmt, ...
354 static void print_type_ent_edge(FILE *F, const ir_type *tp, const ir_entity *ent, const char *fmt, ...)
359 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(tp);
360 fprintf(F, " targetname: \""); PRINT_ENTID(ent); fprintf(F, "\"");
361 vfprintf(F, fmt, ap);
367 * Prints the edge from an entity ent1 to an entity ent2 with additional info fmt, ...
370 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, ...)
376 fprintf(F, "backedge: { sourcename: \"");
378 fprintf(F, "edge: { sourcename: \"");
380 fprintf(F, "\" targetname: \""); PRINT_ENTID(ent2); fprintf(F, "\"");
381 vfprintf(F, fmt, ap);
383 if (color != (ird_color_t) -1)
384 print_vcg_color(F, color);
390 * Prints the edge from an entity ent to a type tp with additional info fmt, ...
393 static void print_ent_type_edge(FILE *F, const ir_entity *ent, const ir_type *tp, const char *fmt, ...)
398 fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(ent);
399 fprintf(F, "\" targetname: "); PRINT_TYPEID(tp);
400 vfprintf(F, fmt, ap);
406 * Prints the edge from a node irn to a type tp with additional info fmt, ...
409 static void print_node_type_edge(FILE *F, const ir_node *irn, ir_type *tp, const char *fmt, ...)
414 fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(irn);
415 fprintf(F, "\" targetname: "); PRINT_TYPEID(tp);
416 vfprintf(F, fmt, ap);
422 * Prints the edge from a node irn to an entity ent with additional info fmt, ...
425 static void print_node_ent_edge(FILE *F, const ir_node *irn, const ir_entity *ent, const char *fmt, ...)
430 fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(irn);
431 fprintf(F, "\" targetname: \""); PRINT_ENTID(ent);
433 vfprintf(F, fmt, ap);
439 * Prints the edge from an entity ent to a node irn with additional info fmt, ...
442 static void print_ent_node_edge(FILE *F, const ir_entity *ent, const ir_node *irn, const char *fmt, ...)
447 fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(ent);
448 fprintf(F, "\" targetname: \""); PRINT_NODEID(irn); fprintf(F, "\"");
449 vfprintf(F, fmt, ap);
455 * Prints the edge from a type tp to an enumeration item item with additional info fmt, ...
458 static void print_enum_item_edge(FILE *F, const ir_type *tp, int item, const char *fmt, ...)
463 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(tp);
464 fprintf(F, " targetname: \""); PRINT_ITEMID(tp, item); fprintf(F, "\" ");
465 vfprintf(F, fmt, ap);
470 /*-----------------------------------------------------------------*/
471 /* global and ahead declarations */
472 /*-----------------------------------------------------------------*/
474 static void dump_whole_node(ir_node *n, void *env);
475 static inline void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg);
477 /*-----------------------------------------------------------------*/
478 /* Helper functions. */
479 /*-----------------------------------------------------------------*/
482 * This map is used as a private link attr to be able to call dumper
483 * anywhere without destroying link fields.
485 static pmap *irdump_link_map = NULL;
487 /** NOT A STANDARD LIBFIRM INIT METHOD
489 * We do not want to integrate dumping into libfirm, i.e., if the dumpers
490 * are off, we want to have as few interferences as possible. Therefore the
491 * initialization is performed lazily and not called from within init_firm.
493 * Creates the link attribute map. */
494 static void init_irdump(void) {
495 /* We need a new, empty map. */
496 if (irdump_link_map) pmap_destroy(irdump_link_map);
497 irdump_link_map = pmap_create();
498 if (!dump_file_filter_id)
499 dump_file_filter_id = new_id_from_str("");
503 * Returns the private link field.
505 static void *ird_get_irn_link(const ir_node *n) {
507 if (irdump_link_map == NULL)
510 if (pmap_contains(irdump_link_map, n))
511 res = pmap_get(irdump_link_map, n);
516 * Sets the private link field.
518 static void ird_set_irn_link(const ir_node *n, void *x) {
519 if (irdump_link_map == NULL)
521 pmap_insert(irdump_link_map, n, x);
525 * Gets the private link field of an irg.
527 static void *ird_get_irg_link(const ir_graph *irg) {
529 if (irdump_link_map == NULL)
532 if (pmap_contains(irdump_link_map, irg))
533 res = pmap_get(irdump_link_map, irg);
538 * Sets the private link field of an irg.
540 static void ird_set_irg_link(const ir_graph *irg, void *x) {
541 if (irdump_link_map == NULL)
543 pmap_insert(irdump_link_map, irg, x);
547 * Walker, clears the private link field.
549 static void clear_link(ir_node *node, void *env) {
551 ird_set_irn_link(node, NULL);
555 * If the entity has a ld_name, returns it if the dump_ld_name is set,
556 * else returns the name of the entity.
558 static const char *_get_ent_dump_name(const ir_entity *ent, int dump_ld_name) {
560 return "<NULL entity>";
562 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
563 if (ent->ld_name != NULL)
564 return get_id_str(ent->ld_name);
566 return get_id_str(ent->name);
570 * If the entity has a ld_name, returns it if the option dump_ld_name is set,
571 * else returns the name of the entity.
573 const char *get_ent_dump_name(const ir_entity *ent) {
574 return _get_ent_dump_name(ent, dump_ld_name);
577 /* Returns the name of an IRG. */
578 const char *get_irg_dump_name(const ir_graph *irg) {
579 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
580 return _get_ent_dump_name(get_irg_entity(irg), 1);
584 * Returns non-zero if a node is in floating state.
586 static int node_floats(const ir_node *n) {
587 return ((get_irn_pinned(n) == op_pin_state_floats) &&
588 (get_irg_pinned(current_ir_graph) == op_pin_state_floats));
592 * Walker that visits the anchors
594 static void ird_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env) {
595 if (dump_anchors || (dump_new_edges_flag && edges_activated(irg))) {
596 irg_walk_anchors(irg, pre, post, env);
598 irg_walk_graph(irg, pre, post, env);
603 * Walker, allocates an array for all blocks and puts it's nodes non-floating nodes into this array.
605 static void collect_node(ir_node *node, void *env) {
609 || (get_op_flags(get_irn_op(node)) & irop_flag_dump_noblock)) {
610 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
611 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
612 ARR_APP1(ir_node *, arr, node);
613 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
615 ir_node * block = get_nodes_block(node);
618 /* this node is in a Bad block, so we must place it into the graph's list */
619 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
620 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
621 ARR_APP1(ir_node *, arr, node);
622 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
624 ird_set_irn_link(node, ird_get_irn_link(block));
625 ird_set_irn_link(block, node);
630 /** Construct lists to walk ir block-wise.
632 * Collects all blocks, nodes not op_pin_state_pinned,
633 * Bad, NoMem and Unknown into a flexible array in link field of
634 * irg they belong to. Sets the irg link field to NULL in all
635 * graphs not visited.
636 * Free the list with DEL_ARR_F().
638 static ir_node **construct_block_lists(ir_graph *irg) {
640 #ifdef INTERPROCEDURAL_VIEW
641 int rem_view = get_interprocedural_view();
643 int walk_flag = ir_resources_reserved(irg) & IR_RESOURCE_IRN_VISITED;
644 ir_graph *rem = current_ir_graph;
646 current_ir_graph = irg;
649 ir_free_resources(irg, IR_RESOURCE_IRN_VISITED);
652 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
653 ird_set_irg_link(get_irp_irg(i), NULL);
655 ird_walk_graph(current_ir_graph, clear_link, collect_node, current_ir_graph);
657 #ifdef INTERPROCEDURAL_VIEW
658 /* Collect also EndReg and EndExcept. We do not want to change the walker. */
659 set_interprocedural_view(0);
662 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
663 irg_walk(get_irg_end_reg(current_ir_graph), clear_link, collect_node, current_ir_graph);
664 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
665 irg_walk(get_irg_end_except(current_ir_graph), clear_link, collect_node, current_ir_graph);
667 #ifdef INTERPROCEDURAL_VIEW
668 set_interprocedural_view(rem_view);
672 ir_reserve_resources(irg, IR_RESOURCE_IRN_VISITED);
675 current_ir_graph = rem;
676 return ird_get_irg_link(irg);
679 typedef struct _list_tuple {
681 ir_extblk **extbb_list;
684 /** Construct lists to walk IR extended block-wise.
685 * Free the lists in the tuple with DEL_ARR_F().
686 * Sets the irg link field to NULL in all
687 * graphs not visited.
689 static list_tuple *construct_extblock_lists(ir_graph *irg) {
690 ir_node **blk_list = construct_block_lists(irg);
692 ir_graph *rem = current_ir_graph;
693 list_tuple *lists = XMALLOC(list_tuple);
695 current_ir_graph = irg;
697 lists->blk_list = NEW_ARR_F(ir_node *, 0);
698 lists->extbb_list = NEW_ARR_F(ir_extblk *, 0);
700 inc_irg_block_visited(irg);
701 for (i = ARR_LEN(blk_list) - 1; i >= 0; --i) {
704 if (is_Block(blk_list[i])) {
705 ext = get_Block_extbb(blk_list[i]);
707 if (extbb_not_visited(ext)) {
708 ARR_APP1(ir_extblk *, lists->extbb_list, ext);
709 mark_extbb_visited(ext);
712 ARR_APP1(ir_node *, lists->blk_list, blk_list[i]);
716 current_ir_graph = rem;
717 ird_set_irg_link(irg, lists);
721 /*-----------------------------------------------------------------*/
722 /* Routines to dump information about a single ir node. */
723 /*-----------------------------------------------------------------*/
726 * dump the name of a node n to the File F.
728 int dump_node_opcode(FILE *F, ir_node *n)
731 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
733 /* call the dump_node operation if available */
735 return ops->dump_node(n, F, dump_node_opcode_txt);
737 /* implementation for default nodes */
738 switch (get_irn_opcode(n)) {
740 switch (get_SymConst_kind(n)) {
741 case symconst_addr_name:
742 /* don't use get_SymConst_ptr_info as it mangles the name. */
743 fprintf(F, "SymC %s", get_id_str(get_SymConst_name(n)));
745 case symconst_addr_ent:
746 fprintf(F, "SymC &%s", get_entity_name(get_SymConst_entity(n)));
748 case symconst_ofs_ent:
749 fprintf(F, "SymC %s offset", get_entity_name(get_SymConst_entity(n)));
751 case symconst_type_tag:
752 ir_fprintf(F, "SymC %+F tag", get_SymConst_type(n));
754 case symconst_type_size:
755 ir_fprintf(F, "SymC %+F size", get_SymConst_type(n));
757 case symconst_type_align:
758 ir_fprintf(F, "SymC %+F align", get_SymConst_type(n));
760 case symconst_enum_const:
761 fprintf(F, "SymC %s enum", get_enumeration_const_name(get_SymConst_enum(n)));
767 if (!get_interprocedural_view())
774 ir_node *pred = get_Proj_pred(n);
776 if (get_irn_opcode(pred) == iro_Cond
777 && get_Proj_proj(n) == get_Cond_default_proj(pred)
778 && get_irn_mode(get_Cond_selector(pred)) != mode_b)
779 fprintf(F, "defProj");
787 if (get_interprocedural_view()) {
788 fprintf(F, "%s %s", get_irn_opname(n), get_ent_dump_name(get_irg_entity(get_irn_irg(n))));
793 case iro_CallBegin: {
794 ir_node *addr = get_CallBegin_ptr(n);
795 ir_entity *ent = NULL;
797 ent = get_Sel_entity(addr);
798 else if (is_Global(addr))
799 ent = get_Global_entity(addr);
800 fprintf(F, "%s", get_irn_opname(n));
801 if (ent) fprintf(F, " %s", get_entity_name(ent));
805 if (get_Load_align(n) == align_non_aligned)
807 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Load_mode(n), &bad));
810 if (get_Store_align(n) == align_non_aligned)
812 fprintf(F, "%s", get_irn_opname(n));
816 is_Block_dead(n) ? "Dead " : "", get_irn_opname(n),
817 dump_block_marker ? (get_Block_mark(n) ? "*" : "") : "");
820 if (get_Conv_strict(n))
821 fprintf(F, "strict");
822 fprintf(F, "%s", get_irn_opname(n));
825 fprintf(F, "%s", get_irn_opname(n));
826 if (get_Div_no_remainder(n))
828 fprintf(F, "[%s]", get_mode_name_ex(get_Div_resmode(n), &bad));
831 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Mod_resmode(n), &bad));
834 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_DivMod_resmode(n), &bad));
837 fprintf(F, "%s[%s]", get_irn_opname(n), get_builtin_kind_name(get_Builtin_kind(n)));
842 fprintf(F, "%s", get_irn_opname(n));
849 * Dump the mode of a node n to a file F.
850 * Ignore modes that are "always known".
852 static int dump_node_mode(FILE *F, ir_node *n)
855 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
859 /* call the dump_node operation if available */
861 return ops->dump_node(n, F, dump_node_mode_txt);
863 /* default implementation */
864 iro = get_irn_opcode(n);
876 mode = get_irn_mode(n);
878 if (mode != NULL && mode != mode_BB && mode != mode_ANY && mode != mode_BAD &&
879 (mode != mode_T || iro == iro_Proj))
880 fprintf(F, "%s", get_mode_name_ex(mode, &bad));
886 * Dump the type of a node n to a file F if it's known.
888 static int dump_node_typeinfo(FILE *F, ir_node *n) {
891 if (opt_dump_analysed_type_info) {
892 if (get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_consistent ||
893 get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_inconsistent) {
894 ir_type *tp = get_irn_typeinfo_type(n);
895 if (tp != firm_none_type) {
896 ir_fprintf(F, "[%+F]", tp);
905 typedef struct _pns_lookup {
906 long nr; /**< the proj number */
907 const char *name; /**< the name of the Proj */
910 typedef struct _proj_lookup {
911 ir_opcode code; /**< the opcode of the Proj predecessor */
912 unsigned num_data; /**< number of data entries */
913 const pns_lookup_t *data; /**< the data */
916 #define ARR_SIZE(a) (sizeof(a)/sizeof(a[0]))
918 /** the lookup table for Proj(Start) names */
919 static const pns_lookup_t start_lut[] = {
920 #define X(a) { pn_Start_##a, #a }
928 /** the lookup table for Proj(Cond) names */
929 static const pns_lookup_t cond_lut[] = {
930 #define X(a) { pn_Cond_##a, #a }
936 /** the lookup table for Proj(Call) names */
937 static const pns_lookup_t call_lut[] = {
938 #define X(a) { pn_Call_##a, #a }
947 /** the lookup table for Proj(Quot) names */
948 static const pns_lookup_t quot_lut[] = {
949 #define X(a) { pn_Quot_##a, #a }
957 /** the lookup table for Proj(DivMod) names */
958 static const pns_lookup_t divmod_lut[] = {
959 #define X(a) { pn_DivMod_##a, #a }
968 /** the lookup table for Proj(Div) names */
969 static const pns_lookup_t div_lut[] = {
970 #define X(a) { pn_Div_##a, #a }
978 /** the lookup table for Proj(Mod) names */
979 static const pns_lookup_t mod_lut[] = {
980 #define X(a) { pn_Mod_##a, #a }
988 /** the lookup table for Proj(Load) names */
989 static const pns_lookup_t load_lut[] = {
990 #define X(a) { pn_Load_##a, #a }
998 /** the lookup table for Proj(Store) names */
999 static const pns_lookup_t store_lut[] = {
1000 #define X(a) { pn_Store_##a, #a }
1007 /** the lookup table for Proj(Alloc) names */
1008 static const pns_lookup_t alloc_lut[] = {
1009 #define X(a) { pn_Alloc_##a, #a }
1017 /** the lookup table for Proj(CopyB) names */
1018 static const pns_lookup_t copyb_lut[] = {
1019 #define X(a) { pn_CopyB_##a, #a }
1026 /** the lookup table for Proj(InstOf) names */
1027 static const pns_lookup_t instof_lut[] = {
1028 #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 ir_fprintf(F, "(%+F)", get_Cast_type(n));
1154 fprintf(F, "%s ", get_pnc_string(get_Confirm_cmp(n)));
1157 ir_fprintf(F, "(%+F)", get_CopyB_type(n));
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);
1191 bad |= dump_node_mode(F, n);
1193 bad |= dump_node_typeinfo(F, n);
1194 bad |= dump_node_nodeattr(F, n);
1195 if(dump_node_idx_labels) {
1196 fprintf(F, "%ld:%d", get_irn_node_nr(n), get_irn_idx(n));
1198 fprintf(F, "%ld", get_irn_node_nr(n));
1205 * Dumps the attributes of a node n into the file F.
1206 * Currently this is only the color of a node.
1208 static void dump_node_vcgattr(FILE *F, ir_node *node, ir_node *local, int bad)
1214 print_vcg_color(F, ird_color_error);
1218 if (dump_node_vcgattr_hook)
1219 if (dump_node_vcgattr_hook(F, node, local))
1222 n = local ? local : node;
1224 if (overrule_nodecolor != ird_color_default_node) {
1225 print_vcg_color(F, overrule_nodecolor);
1229 mode = get_irn_mode(n);
1230 if(mode == mode_M) {
1231 print_vcg_color(F, ird_color_memory);
1234 if(mode == mode_X) {
1235 print_vcg_color(F, ird_color_controlflow);
1239 switch (get_irn_opcode(n)) {
1244 print_vcg_color(F, ird_color_anchor);
1247 print_vcg_color(F, ird_color_error);
1250 if (is_Block_dead(n))
1251 print_vcg_color(F, ird_color_dead_block_background);
1253 print_vcg_color(F, ird_color_block_background);
1256 print_vcg_color(F, ird_color_phi);
1259 print_vcg_color(F, ird_color_memory);
1263 print_vcg_color(F, ird_color_const);
1266 print_vcg_color(F, ird_color_proj);
1269 ir_op *op = get_irn_op(node);
1271 if(is_op_constlike(op)) {
1272 print_vcg_color(F, ird_color_const);
1273 } else if(is_op_uses_memory(op)) {
1274 print_vcg_color(F, ird_color_uses_memory);
1275 } else if(is_op_cfopcode(op) || is_op_forking(op)) {
1276 print_vcg_color(F, ird_color_controlflow);
1278 PRINT_DEFAULT_NODE_ATTR;
1284 /* Adds a new node info dumper callback. */
1285 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data)
1287 hook_entry_t *info = XMALLOC(hook_entry_t);
1289 info->hook._hook_node_info = cb;
1290 info->context = data;
1291 register_hook(hook_node_info, info);
1296 /* Remove a previously added info dumper callback. */
1297 void dump_remv_node_info_callback(void *handle)
1299 hook_entry_t *info = handle;
1300 unregister_hook(hook_node_info, info);
1305 * Dump the node information of a node n to a file F.
1307 static inline int dump_node_info(FILE *F, ir_node *n)
1310 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1312 fprintf(F, " info1: \"");
1313 bad = dump_irnode_to_file(F, n);
1314 /* call the dump_node operation if available */
1316 bad = ops->dump_node(n, F, dump_node_info_txt);
1318 /* allow additional info to be added */
1319 hook_node_info(F, n);
1325 static inline int is_constlike_node(const ir_node *node)
1327 const ir_op *op = get_irn_op(node);
1328 return is_op_constlike(op);
1332 /** outputs the predecessors of n, that are constants, local. I.e.,
1333 generates a copy of the constant predecessors for each node called with. */
1334 static void dump_const_node_local(FILE *F, ir_node *n) {
1336 if (!get_opt_dump_const_local()) return;
1338 /* Use visited flag to avoid outputting nodes twice.
1339 initialize it first. */
1340 for (i = 0; i < get_irn_arity(n); i++) {
1341 ir_node *con = get_irn_n(n, i);
1342 if (is_constlike_node(con)) {
1343 set_irn_visited(con, get_irg_visited(current_ir_graph) - 1);
1347 for (i = 0; i < get_irn_arity(n); i++) {
1348 ir_node *con = get_irn_n(n, i);
1349 if (is_constlike_node(con) && !irn_visited(con)) {
1352 mark_irn_visited(con);
1353 /* Generate a new name for the node by appending the names of
1355 fprintf(F, "node: {title: "); PRINT_CONSTID(n, con);
1356 fprintf(F, " label: \"");
1357 bad |= dump_node_label(F, con);
1359 bad |= dump_node_info(F, con);
1360 dump_node_vcgattr(F, n, con, bad);
1366 /** If the block of an edge is a const_like node, dump it local with an edge */
1367 static void dump_const_block_local(FILE *F, ir_node *n) {
1370 if (!get_opt_dump_const_local()) return;
1372 blk = get_nodes_block(n);
1373 if (is_constlike_node(blk)) {
1376 /* Generate a new name for the node by appending the names of
1378 fprintf(F, "node: {title: \""); PRINT_CONSTBLKID(n, blk);
1379 fprintf(F, "\" label: \"");
1380 bad |= dump_node_label(F, blk);
1382 bad |= dump_node_info(F, blk);
1383 dump_node_vcgattr(F, n, blk, bad);
1386 fprintf(F, "edge: { sourcename: \"");
1388 fprintf(F, "\" targetname: \""); PRINT_CONSTBLKID(n,blk);
1390 if (dump_edge_vcgattr_hook) {
1392 if (dump_edge_vcgattr_hook(F, n, -1)) {
1396 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1401 fprintf(F, "\" " BLOCK_EDGE_ATTR "}\n");
1406 * prints the error message of a node to a file F as info2.
1408 static void print_node_error(FILE *F, const char *err_msg)
1413 fprintf(F, " info2: \"%s\"", err_msg);
1417 * prints debug messages of a node to file F as info3.
1419 static void print_dbg_info(FILE *F, dbg_info *dbg)
1423 ir_dbg_info_snprint(buf, sizeof(buf), dbg);
1425 fprintf(F, " info3: \"%s\"\n", buf);
1429 static void print_type_dbg_info(FILE *F, type_dbg_info *dbg)
1439 static void dump_node(FILE *F, ir_node *n)
1444 if (get_opt_dump_const_local() && is_constlike_node(n))
1447 /* dump this node */
1448 fputs("node: {title: \"", F);
1452 fputs(" label: \"", F);
1453 bad = ! irn_vrfy_irg_dump(n, current_ir_graph, &p);
1454 bad |= dump_node_label(F, n);
1455 dump_node_ana_vals(F, n);
1456 //dump_node_ana_info(F, n);
1459 if (get_op_flags(get_irn_op(n)) & irop_flag_dump_noinput) {
1460 //fputs(" node_class:23", F);
1463 bad |= dump_node_info(F, n);
1464 print_node_error(F, p);
1465 print_dbg_info(F, get_irn_dbg_info(n));
1466 dump_node_vcgattr(F, n, NULL, bad);
1468 dump_const_node_local(F, n);
1470 if(dump_node_edge_hook)
1471 dump_node_edge_hook(F, n);
1474 /** dump the edge to the block this node belongs to */
1476 dump_ir_block_edge(FILE *F, ir_node *n) {
1477 if (get_opt_dump_const_local() && is_constlike_node(n)) return;
1478 if (is_no_Block(n)) {
1479 ir_node *block = get_nodes_block(n);
1481 if (get_opt_dump_const_local() && is_constlike_node(block)) {
1482 dump_const_block_local(F, n);
1484 fprintf(F, "edge: { sourcename: \"");
1486 fprintf(F, "\" targetname: ");
1487 fprintf(F, "\""); PRINT_NODEID(block); fprintf(F, "\"");
1489 if (dump_edge_vcgattr_hook) {
1491 if (dump_edge_vcgattr_hook(F, n, -1)) {
1495 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1500 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1506 print_data_edge_vcgattr(FILE *F, ir_node *from, int to) {
1508 * do not use get_nodes_block() here, will fail
1509 * if the irg is not pinned.
1511 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1512 fprintf(F, INTRA_DATA_EDGE_ATTR);
1514 fprintf(F, INTER_DATA_EDGE_ATTR);
1518 print_mem_edge_vcgattr(FILE *F, ir_node *from, int to) {
1520 * do not use get_nodes_block() here, will fail
1521 * if the irg is not pinned.
1523 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1524 fprintf(F, INTRA_MEM_EDGE_ATTR);
1526 fprintf(F, INTER_MEM_EDGE_ATTR);
1529 /** Print the vcg attributes for the edge from node from to it's to's input */
1530 static void print_edge_vcgattr(FILE *F, ir_node *from, int to) {
1533 if (dump_edge_vcgattr_hook)
1534 if (dump_edge_vcgattr_hook(F, from, to))
1537 if (dump_backedge_information_flag && is_backedge(from, to))
1538 fprintf(F, BACK_EDGE_ATTR);
1540 switch (get_irn_opcode(from)) {
1542 fprintf(F, CF_EDGE_ATTR);
1544 case iro_Start: break;
1547 if (get_irn_mode(get_End_keepalive(from, to)) == mode_BB)
1548 fprintf(F, KEEP_ALIVE_CF_EDGE_ATTR);
1550 fprintf(F, KEEP_ALIVE_DF_EDGE_ATTR);
1554 if (is_Proj(from)) {
1555 if (get_irn_mode(from) == mode_M)
1556 print_mem_edge_vcgattr(F, from, to);
1557 else if (get_irn_mode(from) == mode_X)
1558 fprintf(F, CF_EDGE_ATTR);
1560 print_data_edge_vcgattr(F, from, to);
1562 else if (get_irn_mode(get_irn_n(from, to)) == mode_M)
1563 print_mem_edge_vcgattr(F, from, to);
1564 else if (get_irn_mode(get_irn_n(from, to)) == mode_X)
1565 fprintf(F, CF_EDGE_ATTR);
1567 print_data_edge_vcgattr(F, from, to);
1571 /** dump edges to our inputs */
1572 static void dump_ir_data_edges(FILE *F, ir_node *n) {
1574 ir_visited_t visited = get_irn_visited(n);
1576 if (!dump_keepalive && is_End(n)) {
1577 /* the End node has only keep-alive edges */
1581 /* dump the dependency edges. */
1582 num = get_irn_deps(n);
1583 for (i = 0; i < num; ++i) {
1584 ir_node *dep = get_irn_dep(n, i);
1587 print_node_edge_kind(F, n);
1588 fprintf(F, "{sourcename: \"");
1590 fprintf(F, "\" targetname: ");
1591 if ((get_opt_dump_const_local()) && is_constlike_node(dep)) {
1592 PRINT_CONSTID(n, dep);
1598 fprintf(F, " label: \"%d\" ", i);
1599 fprintf(F, " color: darkgreen}\n");
1603 num = get_irn_arity(n);
1604 for (i = 0; i < num; i++) {
1605 ir_node *pred = get_irn_n(n, i);
1608 if ((get_interprocedural_view() && get_irn_visited(pred) < visited))
1609 continue; /* pred not dumped */
1611 if (dump_backedge_information_flag && is_backedge(n, i))
1612 fprintf(F, "backedge: {sourcename: \"");
1614 print_node_edge_kind(F, n);
1615 fprintf(F, "{sourcename: \"");
1618 fprintf(F, "\" targetname: ");
1619 if ((get_opt_dump_const_local()) && is_constlike_node(pred)) {
1620 PRINT_CONSTID(n, pred);
1622 fprintf(F, "\""); PRINT_NODEID(pred); fprintf(F, "\"");
1624 fprintf(F, " label: \"%d\" ", i);
1625 print_edge_vcgattr(F, n, i);
1629 if (dump_macro_block_edges && is_Block(n)) {
1630 ir_node *mb = get_Block_MacroBlock(n);
1631 fprintf(F, "edge: {sourcename: \"");
1633 fprintf(F, "\" targetname: \"");
1635 fprintf(F, "\" label: \"mb\" " MACROBLOCK_EDGE_ATTR);
1644 dump_ir_edges(FILE *F, ir_node *n) {
1645 const ir_edge_t *edge;
1648 foreach_out_edge(n, edge) {
1649 ir_node *succ = get_edge_src_irn(edge);
1651 print_node_edge_kind(F, succ);
1652 fprintf(F, "{sourcename: \"");
1654 fprintf(F, "\" targetname: \"");
1658 fprintf(F, " label: \"%d\" ", i);
1659 fprintf(F, OUT_EDGE_ATTR);
1666 /** Dumps a node and its edges but not the block edge */
1667 static void dump_node_wo_blockedge(ir_node *n, void *env) {
1670 dump_ir_data_edges(F, n);
1673 /** Dumps a node and its edges. */
1674 static void dump_whole_node(ir_node *n, void *env) {
1676 dump_node_wo_blockedge(n, env);
1677 if (!node_floats(n))
1678 dump_ir_block_edge(F, n);
1679 if (dump_new_edges_flag && edges_activated(current_ir_graph))
1680 dump_ir_edges(F, n);
1683 /** Dumps a const-like node. */
1684 static void dump_const_node(ir_node *n, void *env) {
1685 if (is_Block(n)) return;
1686 dump_node_wo_blockedge(n, env);
1689 /***********************************************************************/
1690 /* the following routines dump the nodes/irgs bracketed to graphs. */
1691 /***********************************************************************/
1693 /** Dumps a constant expression as entity initializer, array bound ...
1695 static void dump_const_expression(FILE *F, ir_node *value) {
1696 ir_graph *rem = current_ir_graph;
1697 int rem_dump_const_local = dump_const_local;
1698 dump_const_local = 0;
1699 current_ir_graph = get_const_code_irg();
1700 irg_walk(value, dump_const_node, NULL, F);
1701 /* Decrease visited flag so that we walk with the same flag for the next
1702 expression. This guarantees that we don't dump the same node twice,
1703 as for const expressions cse is performed to save memory. */
1704 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph) -1);
1705 current_ir_graph = rem;
1706 dump_const_local = rem_dump_const_local;
1709 /** Dump a block as graph containing its nodes.
1711 * Expects to find nodes belonging to the block as list in its
1713 * Dumps the edges of all nodes including itself. */
1714 static void dump_whole_block(FILE *F, ir_node *block) {
1716 ird_color_t color = ird_color_block_background;
1718 assert(is_Block(block));
1720 fprintf(F, "graph: { title: \"");
1721 PRINT_NODEID(block);
1722 fprintf(F, "\" label: \"");
1723 dump_node_label(F, block);
1725 /* colorize blocks */
1726 if (! get_Block_matured(block))
1727 color = ird_color_block_background;
1728 if (is_Block_dead(block))
1729 color = ird_color_dead_block_background;
1731 fprintf(F, "\" status:clustered ");
1732 print_vcg_color(F, color);
1735 /* yComp can show attributes for blocks, XVCG parses but ignores them */
1736 dump_node_info(F, block);
1737 print_dbg_info(F, get_irn_dbg_info(block));
1739 /* dump the blocks edges */
1740 dump_ir_data_edges(F, block);
1742 if (dump_block_edge_hook)
1743 dump_block_edge_hook(F, block);
1745 /* dump the nodes that go into the block */
1746 for (node = ird_get_irn_link(block); node; node = ird_get_irn_link(node)) {
1748 dump_ir_data_edges(F, node);
1751 /* Close the vcg information for the block */
1753 dump_const_node_local(F, block);
1757 /** dumps a graph block-wise. Expects all blockless nodes in arr in irgs link.
1758 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1760 dump_block_graph(FILE *F, ir_graph *irg) {
1762 ir_graph *rem = current_ir_graph;
1763 ir_node **arr = ird_get_irg_link(irg);
1764 current_ir_graph = irg;
1766 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1767 ir_node * node = arr[i];
1768 if (is_Block(node)) {
1769 /* Dumps the block and all the nodes in the block, which are to
1770 be found in Block->link. */
1771 dump_whole_block(F, node);
1773 /* Nodes that are not in a Block. */
1775 if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
1776 dump_const_block_local(F, node);
1778 dump_ir_data_edges(F, node);
1780 if (dump_new_edges_flag && edges_activated(irg))
1781 dump_ir_edges(F, node);
1784 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1785 dump_loop_nodes_into_graph(F, irg);
1787 current_ir_graph = rem;
1791 * Dump the info for an irg.
1792 * Parsed by XVCG but not shown. use yComp.
1794 static void dump_graph_info(FILE *F, ir_graph *irg) {
1795 fprintf(F, "info1: \"");
1796 dump_entity_to_file(F, get_irg_entity(irg), dump_verbosity_entattrs | dump_verbosity_entconsts);
1800 /** Dumps an irg as a graph clustered by block nodes.
1801 * If interprocedural view edges can point to nodes out of this graph.
1803 static void dump_graph_from_list(FILE *F, ir_graph *irg) {
1804 ir_entity *ent = get_irg_entity(irg);
1806 fprintf(F, "graph: { title: \"");
1808 fprintf(F, "\" label: \"%s\" status:clustered color:%s \n",
1809 get_ent_dump_name(ent), color_names[ird_color_prog_background]);
1811 dump_graph_info(F, irg);
1812 print_dbg_info(F, get_entity_dbg_info(ent));
1814 dump_block_graph(F, irg);
1816 /* Close the vcg information for the irg */
1817 fprintf(F, "}\n\n");
1820 /** dumps a graph extended block-wise. Expects all blockless nodes in arr in irgs link.
1821 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1823 dump_extblock_graph(FILE *F, ir_graph *irg) {
1825 ir_graph *rem = current_ir_graph;
1826 ir_extblk **arr = ird_get_irg_link(irg);
1827 current_ir_graph = irg;
1829 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1830 ir_extblk *extbb = arr[i];
1831 ir_node *leader = get_extbb_leader(extbb);
1834 fprintf(F, "graph: { title: \"");
1835 PRINT_EXTBBID(leader);
1836 fprintf(F, "\" label: \"ExtBB %ld\" status:clustered color:lightgreen\n",
1837 get_irn_node_nr(leader));
1839 for (j = ARR_LEN(extbb->blks) - 1; j >= 0; --j) {
1840 ir_node * node = extbb->blks[j];
1841 if (is_Block(node)) {
1842 /* Dumps the block and all the nodes in the block, which are to
1843 be found in Block->link. */
1844 dump_whole_block(F, node);
1846 /* Nodes that are not in a Block. */
1848 if (is_Bad(get_nodes_block(node)) && !node_floats(node)) {
1849 dump_const_block_local(F, node);
1851 dump_ir_data_edges(F, node);
1857 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1858 dump_loop_nodes_into_graph(F, irg);
1860 current_ir_graph = rem;
1865 /*******************************************************************/
1866 /* Basic type and entity nodes and edges. */
1867 /*******************************************************************/
1869 /** dumps the edges between nodes and their type or entity attributes. */
1870 static void dump_node2type_edges(ir_node *n, void *env)
1875 switch (get_irn_opcode(n)) {
1877 /* @@@ some consts have an entity */
1880 if (SYMCONST_HAS_TYPE(get_SymConst_kind(n)))
1881 print_node_type_edge(F,n,get_SymConst_type(n),NODE2TYPE_EDGE_ATTR);
1884 print_node_ent_edge(F,n,get_Sel_entity(n),NODE2TYPE_EDGE_ATTR);
1887 print_node_type_edge(F,n,get_Call_type(n),NODE2TYPE_EDGE_ATTR);
1890 print_node_type_edge(F,n,get_Alloc_type(n),NODE2TYPE_EDGE_ATTR);
1893 print_node_type_edge(F,n,get_Free_type(n),NODE2TYPE_EDGE_ATTR);
1896 print_node_type_edge(F,n,get_Cast_type(n),NODE2TYPE_EDGE_ATTR);
1904 static int print_type_info(FILE *F, ir_type *tp) {
1907 if (get_type_state(tp) == layout_undefined) {
1908 fprintf(F, "state: layout_undefined\n");
1910 fprintf(F, "state: layout_fixed,\n");
1912 if (get_type_mode(tp))
1913 fprintf(F, "mode: %s,\n", get_mode_name_ex(get_type_mode(tp), &bad));
1914 fprintf(F, "size: %db,\n", get_type_size_bits(tp));
1919 static void print_typespecific_info(FILE *F, ir_type *tp) {
1920 switch (get_type_tpop_code(tp)) {
1922 fprintf(F, "peculiarity: %s\n", get_peculiarity_string(get_class_peculiarity(tp)));
1927 fprintf(F, "variadicity: %s\n", get_variadicity_name(get_method_variadicity(tp)));
1928 fprintf(F, "params: %d\n", get_method_n_params(tp));
1929 fprintf(F, "results: %d\n", get_method_n_ress(tp));
1935 case tpo_enumeration:
1947 static void print_typespecific_vcgattr(FILE *F, ir_type *tp) {
1948 switch (get_type_tpop_code(tp)) {
1950 fprintf(F, " " TYPE_CLASS_NODE_ATTR);
1953 fprintf(F, " " TYPE_METH_NODE_ATTR);
1961 case tpo_enumeration:
1972 int dump_type_node(FILE *F, ir_type *tp)
1976 fprintf(F, "node: {title: ");
1978 ir_fprintf(F, " label: \"%s %+F\" info1: \"", get_type_tpop_name(tp), tp);
1979 dump_type_to_file(F, tp, dump_verbosity_max);
1981 print_type_dbg_info(F, get_type_dbg_info(tp));
1982 print_typespecific_vcgattr(F, tp);
1989 void dump_entity_node(FILE *F, ir_entity *ent)
1991 fprintf(F, "node: {title: \"");
1992 PRINT_ENTID(ent); fprintf(F, "\"");
1993 fprintf(F, DEFAULT_TYPE_ATTRIBUTE);
1994 fprintf(F, "label: ");
1995 fprintf(F, "\"%s\" ", get_ent_dump_name(ent));
1997 print_vcg_color(F, ird_color_entity);
1998 fprintf(F, "\n info1: \"");
2000 dump_entity_to_file(F, ent, dump_verbosity_entattrs | dump_verbosity_entconsts);
2003 print_dbg_info(F, get_entity_dbg_info(ent));
2007 static void dump_enum_item(FILE *F, ir_type *tp, int pos)
2010 ir_enum_const *ec = get_enumeration_const(tp, pos);
2011 ident *id = get_enumeration_const_nameid(ec);
2012 tarval *tv = get_enumeration_value(ec);
2015 tarval_snprintf(buf, sizeof(buf), tv);
2017 strncpy(buf, "<not set>", sizeof(buf));
2018 fprintf(F, "node: {title: \"");
2019 PRINT_ITEMID(tp, pos); fprintf(F, "\"");
2020 fprintf(F, DEFAULT_ENUM_ITEM_ATTRIBUTE);
2021 fprintf(F, "label: ");
2022 fprintf(F, "\"enum item %s\" " ENUM_ITEM_NODE_ATTR, get_id_str(id));
2023 fprintf(F, "\n info1: \"value: %s\"}\n", buf);
2027 * Dumps a new style initializer.
2029 static void dump_entity_initializer(FILE *F, const ir_entity *ent) {
2035 /** Dumps a type or entity and it's edges. */
2036 static void dump_type_info(type_or_ent tore, void *env) {
2038 int i = 0; /* to shutup gcc */
2040 /* dump this type or entity */
2042 switch (get_kind(tore.ent)) {
2044 ir_entity *ent = tore.ent;
2047 dump_entity_node(F, ent);
2049 /* skip this to reduce graph. Member edge of type is parallel to this edge. *
2050 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2051 ENT_OWN_EDGE_ATTR "}\n", ent, get_entity_owner(ent));*/
2052 print_ent_type_edge(F,ent, get_entity_type(ent), ENT_TYPE_EDGE_ATTR);
2053 if (is_Class_type(get_entity_owner(ent))) {
2054 for (i = get_entity_n_overwrites(ent) - 1; i >= 0; --i)
2055 print_ent_ent_edge(F,ent, get_entity_overwrites(ent, i), 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2057 /* attached subgraphs */
2058 if (const_entities) {
2059 if (ent->initializer != NULL) {
2060 /* new style initializers */
2061 dump_entity_initializer(F, ent);
2062 } else if (entity_has_compound_ent_values(ent)) {
2063 /* old style compound entity values */
2064 for (i = get_compound_ent_n_values(ent) - 1; i >= 0; --i) {
2065 value = get_compound_ent_value(ent, i);
2067 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2068 dump_const_expression(F, value);
2069 print_ent_ent_edge(F, ent, get_compound_ent_value_member(ent, i), 0, -1, ENT_CORR_EDGE_ATTR, i);
2071 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2072 ENT_CORR_EDGE_ATTR "}\n", GET_ENTID(ent),
2073 get_compound_ent_value_member(ent, i), i);
2082 ir_type *tp = tore.typ;
2083 dump_type_node(F, tp);
2084 /* and now the edges */
2085 switch (get_type_tpop_code(tp)) {
2087 for (i = get_class_n_supertypes(tp) - 1; i >= 0; --i)
2088 print_type_type_edge(F, tp, get_class_supertype(tp, i), TYPE_SUPER_EDGE_ATTR);
2089 for (i = get_class_n_members(tp) - 1; i >= 0; --i)
2090 print_type_ent_edge(F, tp, get_class_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
2093 for (i = get_struct_n_members(tp) - 1; i >= 0; --i)
2094 print_type_ent_edge(F, tp, get_struct_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
2097 for (i = get_method_n_params(tp) - 1; i >= 0; --i)
2098 print_type_type_edge(F, tp, get_method_param_type(tp, i), METH_PAR_EDGE_ATTR,i);
2099 for (i = get_method_n_ress(tp) - 1; i >= 0; --i)
2100 print_type_type_edge(F, tp, get_method_res_type(tp, i), METH_RES_EDGE_ATTR,i);
2103 for (i = get_union_n_members(tp) - 1; i >= 0; --i)
2104 print_type_ent_edge(F, tp, get_union_member(tp, i), UNION_EDGE_ATTR);
2107 print_type_type_edge(F, tp, get_array_element_type(tp), ARR_ELT_TYPE_EDGE_ATTR);
2108 print_type_ent_edge(F, tp, get_array_element_entity(tp), ARR_ENT_EDGE_ATTR);
2109 for (i = get_array_n_dimensions(tp) - 1; i >= 0; --i) {
2110 ir_node *upper = get_array_upper_bound(tp, i);
2111 ir_node *lower = get_array_lower_bound(tp, i);
2112 print_node_type_edge(F, upper, tp, "label: \"upper %d\"", get_array_order(tp, i));
2113 print_node_type_edge(F, lower, tp, "label: \"lower %d\"", get_array_order(tp, i));
2114 dump_const_expression(F, upper);
2115 dump_const_expression(F, lower);
2118 case tpo_enumeration:
2119 for (i = get_enumeration_n_enums(tp) - 1; i >= 0; --i) {
2120 dump_enum_item(F, tp, i);
2121 print_enum_item_edge(F, tp, i, "label: \"item %d\"", i);
2125 print_type_type_edge(F, tp, get_pointer_points_to_type(tp), PTR_PTS_TO_EDGE_ATTR);
2132 break; /* case k_type */
2135 printf(" *** irdump, dump_type_info(l.%i), faulty type.\n", __LINE__);
2136 } /* switch kind_or_entity */
2139 typedef struct _h_env {
2144 /** For dumping class hierarchies.
2145 * Dumps a class type node and a superclass edge.
2146 * If env->dump_ent dumps entities of classes and overwrites edges.
2149 dump_class_hierarchy_node(type_or_ent tore, void *ctx) {
2152 int i = 0; /* to shutup gcc */
2154 /* dump this type or entity */
2155 switch (get_kind(tore.ent)) {
2157 ir_entity *ent = tore.ent;
2158 if (get_entity_owner(ent) == get_glob_type()) break;
2159 if (!is_Method_type(get_entity_type(ent)))
2161 if (env->dump_ent && is_Class_type(get_entity_owner(ent))) {
2163 dump_entity_node(F, ent);
2165 print_type_ent_edge(F, get_entity_owner(ent), ent, TYPE_MEMBER_EDGE_ATTR);
2166 for (i = get_entity_n_overwrites(ent) - 1; i >= 0; --i)
2167 print_ent_ent_edge(F, get_entity_overwrites(ent, i), ent, 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2172 ir_type *tp = tore.typ;
2173 if (tp == get_glob_type())
2175 switch (get_type_tpop_code(tp)) {
2177 dump_type_node(F, tp);
2178 /* and now the edges */
2179 for (i = get_class_n_supertypes(tp) - 1; i >= 0; --i) {
2180 print_type_type_edge(F,tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2185 break; /* case k_type */
2188 printf(" *** irdump, dump_class_hierarchy_node(l.%i), faulty type.\n", __LINE__);
2189 } /* switch kind_or_entity */
2192 /*******************************************************************/
2193 /* dump analysis information that is expressed in graph terms. */
2194 /*******************************************************************/
2196 /* dump out edges */
2198 dump_out_edge(ir_node *n, void *env) {
2201 for (i = get_irn_n_outs(n) - 1; i >= 0; --i) {
2202 ir_node *succ = get_irn_out(n, i);
2204 print_node_edge_kind(F, succ);
2205 fprintf(F, "{sourcename: \"");
2207 fprintf(F, "\" targetname: \"");
2209 fprintf(F, "\" color: red linestyle: dashed");
2215 dump_loop_label(FILE *F, ir_loop *loop) {
2216 fprintf(F, "loop %d, %d sons, %d nodes",
2217 get_loop_depth(loop), get_loop_n_sons(loop), get_loop_n_nodes(loop));
2220 static inline void dump_loop_info(FILE *F, ir_loop *loop) {
2221 fprintf(F, " info1: \"");
2222 fprintf(F, " loop nr: %d", get_loop_loop_nr(loop));
2223 #ifdef DEBUG_libfirm /* GL @@@ debug analyses */
2224 fprintf(F, "\n The loop was analyzed %d times.", PTR_TO_INT(get_loop_link(loop)));
2230 dump_loop_node(FILE *F, ir_loop *loop) {
2231 fprintf(F, "node: {title: \"");
2233 fprintf(F, "\" label: \"");
2234 dump_loop_label(F, loop);
2236 dump_loop_info(F, loop);
2241 dump_loop_node_edge(FILE *F, ir_loop *loop, int i) {
2243 fprintf(F, "edge: {sourcename: \"");
2245 fprintf(F, "\" targetname: \"");
2246 PRINT_NODEID(get_loop_node(loop, i));
2247 fprintf(F, "\" color: green");
2252 dump_loop_son_edge(FILE *F, ir_loop *loop, int i) {
2254 fprintf(F, "edge: {sourcename: \"");
2256 fprintf(F, "\" targetname: \"");
2257 PRINT_LOOPID(get_loop_son(loop, i));
2258 fprintf(F, "\" color: darkgreen label: \"%d\"}\n",
2259 get_loop_element_pos(loop, get_loop_son(loop, i)));
2263 void dump_loops(FILE *F, ir_loop *loop) {
2265 /* dump this loop node */
2266 dump_loop_node(F, loop);
2268 /* dump edges to nodes in loop -- only if it is a real loop */
2269 if (get_loop_depth(loop) != 0) {
2270 for (i = get_loop_n_nodes(loop) - 1; i >= 0; --i) {
2271 dump_loop_node_edge(F, loop, i);
2274 for (i = get_loop_n_sons(loop) - 1; i >= 0; --i) {
2275 dump_loops(F, get_loop_son(loop, i));
2276 dump_loop_son_edge(F, loop, i);
2281 void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg) {
2282 ir_loop *loop = get_irg_loop(irg);
2285 ir_graph *rem = current_ir_graph;
2286 current_ir_graph = irg;
2288 dump_loops(F, loop);
2290 current_ir_graph = rem;
2296 * dumps the VCG header
2298 void dump_vcg_header(FILE *F, const char *name, const char *layout, const char *orientation) {
2304 label = edge_label ? "yes" : "no";
2305 if (! layout) layout = "Compilergraph";
2306 if (!orientation) orientation = "bottom_to_top";
2310 "graph: { title: \"ir graph of %s\"\n"
2311 "display_edge_labels: %s\n"
2312 "layoutalgorithm: mindepth //$ \"%s\"\n"
2313 "manhattan_edges: yes\n"
2314 "port_sharing: no\n"
2316 "classname 1: \"intrablock Data\"\n"
2317 "classname 2: \"Block\"\n"
2318 "classname 3: \"Entity type\"\n"
2319 "classname 4: \"Entity owner\"\n"
2320 "classname 5: \"Method Param\"\n"
2321 "classname 6: \"Method Res\"\n"
2322 "classname 7: \"Super\"\n"
2323 "classname 8: \"Union\"\n"
2324 "classname 9: \"Points-to\"\n"
2325 "classname 10: \"Array Element Type\"\n"
2326 "classname 11: \"Overwrites\"\n"
2327 "classname 12: \"Member\"\n"
2328 "classname 13: \"Control Flow\"\n"
2329 "classname 14: \"intrablock Memory\"\n"
2330 "classname 15: \"Dominators\"\n"
2331 "classname 16: \"interblock Data\"\n"
2332 "classname 17: \"interblock Memory\"\n"
2333 "classname 18: \"Exception Control Flow for Interval Analysis\"\n"
2334 "classname 19: \"Postdominators\"\n"
2335 "classname 20: \"Keep Alive\"\n"
2336 "classname 21: \"Out Edges\"\n"
2337 "classname 22: \"Macro Block Edges\"\n"
2338 //"classname 23: \"NoInput Nodes\"\n"
2339 "infoname 1: \"Attribute\"\n"
2340 "infoname 2: \"Verification errors\"\n"
2341 "infoname 3: \"Debug info\"\n",
2342 name, label, layout, orientation);
2344 for (i = 0; i < ird_color_count; ++i) {
2345 if (color_rgb[i] != NULL) {
2346 fprintf(F, "colorentry %s: %s\n", color_names[i], color_rgb[i]);
2349 fprintf(F, "\n"); /* a separator */
2355 * @param irg The graph to be dumped
2356 * @param suffix1 first filename suffix
2357 * @param suffix2 second filename suffix
2359 FILE *vcg_open(const ir_graph *irg, const char *suffix1, const char *suffix2) {
2361 const char *nm = get_irg_dump_name(irg);
2362 int len = strlen(nm), i, j;
2363 char *fname; /* filename to put the vcg information in */
2365 if (!suffix1) suffix1 = "";
2366 if (!suffix2) suffix2 = "";
2368 /* open file for vcg graph */
2369 fname = XMALLOCN(char, len * 2 + strlen(suffix1) + strlen(suffix2) + 5);
2371 /* strncpy (fname, nm, len); */ /* copy the filename */
2373 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2375 fname[j] = '@'; j++; fname[j] = '1'; j++;
2376 } else if (nm[i] == '@') {
2377 fname[j] = '@'; j++; fname[j] = '2'; j++;
2379 fname[j] = nm[i]; j++;
2383 strcat(fname, suffix1); /* append file suffix */
2384 strcat(fname, suffix2); /* append file suffix */
2385 strcat(fname, ".vcg"); /* append the .vcg suffix */
2387 /* vcg really expect only a <CR> at end of line, so
2388 * the "b"inary mode is what you mean (and even needed for Win32)
2390 F = fopen(fname, "wb"); /* open file for writing */
2402 * @param name prefix file name
2403 * @param suffix filename suffix
2405 FILE *vcg_open_name(const char *name, const char *suffix) {
2407 char *fname; /* filename to put the vcg information in */
2408 int i, j, len = strlen(name);
2410 if (!suffix) suffix = "";
2412 /** open file for vcg graph */
2413 fname = XMALLOCN(char, len * 2 + 5 + strlen(suffix));
2414 /* strcpy (fname, name);*/ /* copy the filename */
2416 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2417 if (name[i] == '/') {
2418 fname[j] = '@'; j++; fname[j] = '1'; j++;
2419 } else if (name[i] == '@') {
2420 fname[j] = '@'; j++; fname[j] = '2'; j++;
2422 fname[j] = name[i]; j++;
2426 strcat(fname, suffix);
2427 strcat(fname, ".vcg"); /* append the .vcg suffix */
2429 /* vcg really expect only a <CR> at end of line, so
2430 * the "b"inary mode is what you mean (and even needed for Win32)
2432 F = fopen(fname, "wb"); /* open file for writing */
2442 * Dumps the vcg file footer
2444 void dump_vcg_footer(FILE *F) {
2448 /************************************************************************/
2449 /************************************************************************/
2450 /* Routines that dump all or parts of the firm representation to a file */
2451 /************************************************************************/
2452 /************************************************************************/
2454 /************************************************************************/
2455 /* Dump ir graphs, different formats and additional information. */
2456 /************************************************************************/
2458 typedef void (*do_dump_graph_func) (ir_graph *irg, FILE *out);
2460 static void do_dump(ir_graph *irg, const char *suffix, const char *suffix_ip,
2461 const char *suffix_nonip, do_dump_graph_func dump_func)
2465 const char *suffix1;
2467 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2470 rem = current_ir_graph;
2471 current_ir_graph = irg;
2472 if (get_interprocedural_view())
2473 suffix1 = suffix_ip;
2475 suffix1 = suffix_nonip;
2476 current_ir_graph = rem;
2478 out = vcg_open(irg, suffix, suffix1);
2480 dump_func(irg, out);
2485 void dump_ir_graph_file(ir_graph *irg, FILE *out)
2487 if (dump_backedge_information_flag
2488 && get_irg_loopinfo_state(irg) != loopinfo_consistent) {
2489 construct_backedges(irg);
2492 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2494 /* call the dump graph hook */
2495 if (dump_ir_graph_hook) {
2496 if (dump_ir_graph_hook(out, irg)) {
2501 /* walk over the graph */
2502 /* dump_whole_node must be called in post visiting predecessors */
2503 ird_walk_graph(irg, NULL, dump_whole_node, out);
2505 /* dump the out edges in a separate walk */
2506 if ((dump_out_edge_flag) && (get_irg_outs_state(irg) != outs_none)) {
2507 irg_out_walk(get_irg_start(irg), dump_out_edge, NULL, out);
2510 dump_vcg_footer(out);
2513 /** Routine to dump a graph, blocks as conventional nodes. */
2514 void dump_ir_graph(ir_graph *irg, const char *suffix )
2516 do_dump(irg, suffix, "-pure-ip", "-pure", dump_ir_graph_file);
2519 void dump_ir_block_graph_file(ir_graph *irg, FILE *out)
2523 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2525 construct_block_lists(irg);
2528 * If we are in the interprocedural view, we dump not
2529 * only the requested irg but also all irgs that can be reached
2532 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2533 ir_graph *g = get_irp_irg(i);
2534 ir_node **arr = ird_get_irg_link(g);
2536 dump_graph_from_list(out, g);
2541 dump_vcg_footer(out);
2544 /* Dump a firm graph without explicit block nodes. */
2545 void dump_ir_block_graph(ir_graph *irg, const char *suffix)
2547 do_dump(irg, suffix, "-ip", "", dump_ir_block_graph_file);
2550 void dump_ir_extblock_graph_file(ir_graph *irg, FILE *F)
2553 ir_entity *ent = get_irg_entity(irg);
2555 if (get_irg_extblk_state(irg) != extblk_valid)
2558 dump_vcg_header(F, get_irg_dump_name(irg), NULL, NULL);
2560 construct_extblock_lists(irg);
2562 fprintf(F, "graph: { title: \"");
2564 fprintf(F, "\" label: \"%s\" status:clustered color: white \n",
2565 get_ent_dump_name(ent));
2567 dump_graph_info(F, irg);
2568 print_dbg_info(F, get_entity_dbg_info(ent));
2570 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2571 ir_graph *irg = get_irp_irg(i);
2572 list_tuple *lists = ird_get_irg_link(irg);
2575 /* dump the extended blocks first */
2576 if (ARR_LEN(lists->extbb_list)) {
2577 ird_set_irg_link(irg, lists->extbb_list);
2578 dump_extblock_graph(F, irg);
2581 /* we may have blocks without extended blocks, bad for instance */
2582 if (ARR_LEN(lists->blk_list)) {
2583 ird_set_irg_link(irg, lists->blk_list);
2584 dump_block_graph(F, irg);
2587 DEL_ARR_F(lists->extbb_list);
2588 DEL_ARR_F(lists->blk_list);
2593 /* Close the vcg information for the irg */
2594 fprintf(F, "}\n\n");
2600 /* Dump a firm graph without explicit block nodes but grouped in extended blocks. */
2601 void dump_ir_extblock_graph(ir_graph *irg, const char *suffix)
2603 do_dump(irg, suffix, "-ip", "", dump_ir_extblock_graph_file);
2606 void dump_ir_graph_w_types_file(ir_graph *irg, FILE *out)
2608 ir_graph *rem = current_ir_graph;
2609 int rem_dump_const_local;
2611 rem = current_ir_graph;
2612 current_ir_graph = irg;
2613 rem_dump_const_local = dump_const_local;
2614 /* dumping types does not work with local nodes */
2615 dump_const_local = 0;
2617 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2619 /* dump common ir graph */
2620 irg_walk(get_irg_end(irg), NULL, dump_whole_node, out);
2621 /* dump type info */
2622 type_walk_irg(irg, dump_type_info, NULL, out);
2623 inc_irg_visited(get_const_code_irg());
2624 /* dump edges from graph to type info */
2625 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2627 dump_vcg_footer(out);
2628 dump_const_local = rem_dump_const_local;
2629 current_ir_graph = rem;
2632 /* dumps a graph with type information */
2633 void dump_ir_graph_w_types(ir_graph *irg, const char *suffix)
2635 do_dump(irg, suffix, "-pure-wtypes-ip", "-pure-wtypes",
2636 dump_ir_graph_w_types_file);
2639 void dump_ir_block_graph_w_types_file(ir_graph *irg, FILE *out)
2642 int rem_dump_const_local;
2643 ir_graph *rem = current_ir_graph;
2645 rem_dump_const_local = dump_const_local;
2646 /* dumping types does not work with local nodes */
2647 dump_const_local = 0;
2649 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2651 /* dump common blocked ir graph */
2652 construct_block_lists(irg);
2654 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2655 ir_node **arr = ird_get_irg_link(get_irp_irg(i));
2657 dump_graph_from_list(out, get_irp_irg(i));
2662 /* dump type info */
2663 current_ir_graph = irg;
2664 type_walk_irg(irg, dump_type_info, NULL, out);
2665 inc_irg_visited(get_const_code_irg());
2667 /* dump edges from graph to type info */
2668 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2670 dump_vcg_footer(out);
2671 dump_const_local = rem_dump_const_local;
2672 current_ir_graph = rem;
2675 void dump_ir_block_graph_w_types(ir_graph *irg, const char *suffix)
2677 do_dump(irg, suffix, "-wtypes-ip", "-wtypes",
2678 dump_ir_block_graph_w_types_file);
2681 /*---------------------------------------------------------------------*/
2682 /* The following routines dump a control flow graph. */
2683 /*---------------------------------------------------------------------*/
2686 dump_block_to_cfg(ir_node *block, void *env) {
2691 if (is_Block(block)) {
2692 /* This is a block. Dump a node for the block. */
2693 fprintf(F, "node: {title: \""); PRINT_NODEID(block);
2694 fprintf(F, "\" label: \"");
2695 if (block == get_irg_start_block(get_irn_irg(block)))
2696 fprintf(F, "Start ");
2697 if (block == get_irg_end_block(get_irn_irg(block)))
2700 fprintf(F, "%s ", get_op_name(get_irn_op(block)));
2701 PRINT_NODEID(block);
2703 fprintf(F, "info1:\"");
2705 /* the generic version. */
2706 dump_irnode_to_file(F, block);
2708 /* Check whether we have bad predecessors to color the block. */
2709 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
2710 if ((fl = is_Bad(get_Block_cfgpred(block, i))))
2713 fprintf(F, "\""); /* closing quote of info */
2715 if ((block == get_irg_start_block(get_irn_irg(block))) ||
2716 (block == get_irg_end_block(get_irn_irg(block))) )
2717 fprintf(F, " color:blue ");
2719 fprintf(F, " color:yellow ");
2722 /* Dump the edges */
2723 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
2724 if (!is_Bad(skip_Proj(get_Block_cfgpred(block, i)))) {
2725 pred = get_nodes_block(skip_Proj(get_Block_cfgpred(block, i)));
2726 fprintf(F, "edge: { sourcename: \"");
2727 PRINT_NODEID(block);
2728 fprintf(F, "\" targetname: \"");
2730 fprintf(F, "\"}\n");
2733 /* Dump dominator/postdominator edge */
2734 if (dump_dominator_information_flag) {
2735 if (get_irg_dom_state(current_ir_graph) == dom_consistent && get_Block_idom(block)) {
2736 pred = get_Block_idom(block);
2737 fprintf(F, "edge: { sourcename: \"");
2738 PRINT_NODEID(block);
2739 fprintf(F, "\" targetname: \"");
2741 fprintf(F, "\" " DOMINATOR_EDGE_ATTR "}\n");
2743 if (get_irg_postdom_state(current_ir_graph) == dom_consistent && get_Block_ipostdom(block)) {
2744 pred = get_Block_ipostdom(block);
2745 fprintf(F, "edge: { sourcename: \"");
2746 PRINT_NODEID(block);
2747 fprintf(F, "\" targetname: \"");
2749 fprintf(F, "\" " POSTDOMINATOR_EDGE_ATTR "}\n");
2755 void dump_cfg(ir_graph *irg, const char *suffix)
2758 /* if a filter is set, dump only the irg's that match the filter */
2759 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2762 f = vcg_open(irg, suffix, "-cfg");
2764 ir_graph *rem = current_ir_graph;
2765 #ifdef INTERPROCEDURAL_VIEW
2766 int ipv = get_interprocedural_view();
2769 current_ir_graph = irg;
2770 dump_vcg_header(f, get_irg_dump_name(irg), NULL, NULL);
2772 #ifdef INTERPROCEDURAL_VIEW
2774 printf("Warning: dumping cfg not in interprocedural view!\n");
2775 set_interprocedural_view(0);
2779 /* walk over the blocks in the graph */
2780 irg_block_walk(get_irg_end(irg), dump_block_to_cfg, NULL, f);
2781 dump_node(f, get_irg_bad(irg));
2783 #ifdef INTERPROCEDURAL_VIEW
2784 set_interprocedural_view(ipv);
2788 current_ir_graph = rem;
2793 static void descend_and_dump(FILE *F, ir_node *n, int depth, pset *mark_set) {
2794 if (pset_find_ptr(mark_set, n))
2797 pset_insert_ptr(mark_set, n);
2800 int i, start = is_Block(n) ? 0 : -1;
2801 dump_whole_node(n, F);
2802 for (i = start; i < get_irn_arity(n); ++i)
2803 descend_and_dump(F, get_irn_n(n, i), depth-1, mark_set);
2806 /* Don't dump edges to nodes further out. These might be edges to
2807 nodes we already dumped, if there is a shorter path to these. */
2811 static int subgraph_counter = 0;
2812 void dump_subgraph(ir_node *root, int depth, const char *suffix) {
2816 sprintf(buf, "-subg_%03d", subgraph_counter++);
2817 F = vcg_open(get_irn_irg(root), suffix, buf);
2819 pset *mark_set = pset_new_ptr(1);
2820 dump_vcg_header(F, get_irg_dump_name(get_irn_irg(root)), NULL, NULL);
2821 descend_and_dump(F, root, depth, mark_set);
2828 void dump_callgraph(const char *suffix) {
2829 FILE *F = vcg_open_name("Callgraph", suffix);
2832 int i, rem = edge_label;
2835 dump_vcg_header(F, "Callgraph", "Hierarchiv", NULL);
2837 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2838 ir_graph *irg = get_irp_irg(i);
2839 ir_entity *ent = get_irg_entity(irg);
2841 int n_callees = get_irg_n_callees(irg);
2843 dump_entity_node(F, ent);
2844 for (j = 0; j < n_callees; ++j) {
2845 ir_entity *c = get_irg_entity(get_irg_callee(irg, j));
2846 //if (id_is_prefix(prefix, get_entity_ld_ident(c))) continue;
2847 int be = is_irg_callee_backedge(irg, j);
2850 "label:\"recursion %d\"" :
2851 "label:\"calls %d\"";
2852 print_ent_ent_edge(F, ent, c, be, ird_color_entity, attr, get_irg_callee_loop_depth(irg, j));
2863 /* Dump all irgs in interprocedural view to a single file. */
2864 void dump_all_cg_block_graph(const char *suffix) {
2865 FILE *f = vcg_open_name("All_graphs", suffix);
2869 int rem_view = get_interprocedural_view();
2871 set_interprocedural_view(1);
2872 dump_vcg_header(f, "All_graphs", NULL);
2874 /* collect nodes in all irgs reachable in call graph*/
2875 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2876 ird_set_irg_link(get_irp_irg(i), NULL);
2878 cg_walk(clear_link, collect_node, NULL);
2880 /* dump all graphs */
2881 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2882 current_ir_graph = get_irp_irg(i);
2883 assert(ird_get_irg_link(current_ir_graph));
2884 dump_graph_from_list(f, current_ir_graph);
2885 DEL_ARR_F(ird_get_irg_link(current_ir_graph));
2890 set_interprocedural_view(rem_view);
2895 /*---------------------------------------------------------------------*/
2896 /* the following routines dumps type information without any ir nodes. */
2897 /*---------------------------------------------------------------------*/
2900 dump_type_graph(ir_graph *irg, const char *suffix)
2904 /* if a filter is set, dump only the irg's that match the filter */
2905 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
2907 f = vcg_open(irg, suffix, "-type");
2909 ir_graph *rem = current_ir_graph;
2910 current_ir_graph = irg;
2912 dump_vcg_header(f, get_irg_dump_name(irg), "Hierarchic", NULL);
2914 /* walk over the blocks in the graph */
2915 type_walk_irg(irg, dump_type_info, NULL, f);
2916 /* The walker for the const code can be called several times for the
2917 same (sub) expression. So that no nodes are dumped several times
2918 we decrease the visited flag of the corresponding graph after each
2919 walk. So now increase it finally. */
2920 inc_irg_visited(get_const_code_irg());
2924 current_ir_graph = rem;
2929 dump_all_types(const char *suffix)
2931 FILE *f = vcg_open_name("All_types", suffix);
2933 dump_vcg_header(f, "All_types", "Hierarchic", NULL);
2934 type_walk(dump_type_info, NULL, f);
2935 inc_irg_visited(get_const_code_irg());
2943 dump_class_hierarchy(int entities, const char *suffix)
2945 FILE *f = vcg_open_name("class_hierarchy", suffix);
2950 env.dump_ent = entities;
2951 dump_vcg_header(f, "class_hierarchy", "Hierarchic", NULL);
2952 type_walk(dump_class_hierarchy_node, NULL, &env);
2959 /*---------------------------------------------------------------------*/
2960 /* dumps all graphs with the graph-dumper passed. Possible dumpers: */
2962 /* dump_ir_block_graph */
2964 /* dump_type_graph */
2965 /* dump_ir_graph_w_types */
2966 /*---------------------------------------------------------------------*/
2968 void dump_all_ir_graphs(dump_graph_func *dmp_grph, const char *suffix) {
2970 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2971 dmp_grph(get_irp_irg(i), suffix);
2975 ir_prog_pass_t pass;
2976 dump_graph_func *dump_graph;
2981 * Wrapper around dump_all_ir_graphs().
2983 static int dump_all_ir_graphs_wrapper(ir_prog *irp, void *context) {
2984 struct pass_t *pass = context;
2987 dump_all_ir_graphs(pass->dump_graph, pass->suffix);
2991 ir_prog_pass_t *dump_all_ir_graph_pass(
2992 const char *name, dump_graph_func *dump_graph, const char *suffix) {
2993 size_t len = strlen(suffix);
2994 struct pass_t *pass = xmalloc(sizeof(*pass) + len);
2995 ir_prog_pass_t *res = def_prog_pass_constructor(
2996 &pass->pass, name ? name : "dump_all_graphs", dump_all_ir_graphs_wrapper);
2998 /* this pass does not change anything, so neither dump nor verify is needed. */
2999 res->dump_irprog = ir_prog_no_dump;
3000 res->verify_irprog = ir_prog_no_verify;
3002 pass->dump_graph = dump_graph;
3003 strcpy(pass->suffix, suffix);
3008 /*--------------------------------------------------------------------------------*
3009 * Dumps a stand alone loop graph with firm nodes which belong to one loop node *
3010 * packed together in one subgraph/box *
3011 *--------------------------------------------------------------------------------*/
3013 void dump_loops_standalone(FILE *F, ir_loop *loop) {
3014 int i = 0, loop_node_started = 0, son_number = 0, first = 0;
3016 ir_loop *son = NULL;
3018 /* Dump a new loop node. */
3019 dump_loop_node(F, loop);
3021 /* Dump the loop elements. */
3022 for (i = 0; i < get_loop_n_elements(loop); i++) {
3023 le = get_loop_element(loop, i);
3025 if (get_kind(son) == k_ir_loop) {
3027 /* We are a loop son -> Recurse */
3029 if (loop_node_started) { /* Close the "firm-nodes" node first if we started one. */
3030 fprintf(F, "\" }\n");
3031 fprintf(F, "edge: {sourcename: \"");
3033 fprintf(F, "\" targetname: \"");
3035 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3036 loop_node_started = 0;
3038 dump_loop_son_edge(F, loop, son_number++);
3039 dump_loops_standalone(F, son);
3040 } else if (get_kind(son) == k_ir_node) {
3041 /* We are a loop node -> Collect firm nodes */
3043 ir_node *n = le.node;
3046 if (!loop_node_started) {
3047 /* Start a new node which contains all firm nodes of the current loop */
3048 fprintf(F, "node: { title: \"");
3050 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3051 loop_node_started = 1;
3056 bad |= dump_node_label(F, n);
3057 /* Causes indeterministic output: if (is_Block(n)) fprintf(F, "\t ->%d", (int)get_irn_link(n)); */
3058 if (has_backedges(n)) fprintf(F, "\t loop head!");
3059 } else { /* for callgraph loop tree */
3061 assert(get_kind(son) == k_ir_graph);
3063 /* We are a loop node -> Collect firm graphs */
3065 if (!loop_node_started) {
3066 /* Start a new node which contains all firm nodes of the current loop */
3067 fprintf(F, "node: { title: \"");
3069 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3070 loop_node_started = 1;
3074 fprintf(F, " %s", get_irg_dump_name(n));
3075 /* fprintf(F, " %s (depth %d)", get_irg_dump_name(n), n->callgraph_weighted_loop_depth); */
3079 if (loop_node_started) {
3080 fprintf(F, "\" }\n");
3081 fprintf(F, "edge: {sourcename: \"");
3083 fprintf(F, "\" targetname: \"");
3085 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3086 loop_node_started = 0;
3090 void dump_loop_tree(ir_graph *irg, const char *suffix)
3094 /* if a filter is set, dump only the irg's that match the filter */
3095 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
3098 f = vcg_open(irg, suffix, "-looptree");
3100 ir_graph *rem = current_ir_graph;
3101 int el_rem = edge_label;
3103 current_ir_graph = irg;
3106 dump_vcg_header(f, get_irg_dump_name(irg), "Tree", "top_to_bottom");
3108 if (get_irg_loop(irg))
3109 dump_loops_standalone(f, get_irg_loop(irg));
3114 edge_label = el_rem;
3115 current_ir_graph = rem;
3119 void dump_callgraph_loop_tree(const char *suffix) {
3121 F = vcg_open_name("Callgraph_looptree", suffix);
3122 dump_vcg_header(F, "callgraph looptree", "Tree", "top_to_bottom");
3123 dump_loops_standalone(F, irp->outermost_cg_loop);
3129 /*----------------------------------------------------------------------------*/
3130 /* Dumps the firm nodes in the loop tree to a graph along with the loop nodes.*/
3131 /*----------------------------------------------------------------------------*/
3133 void collect_nodeloop(FILE *F, ir_loop *loop, eset *loopnodes) {
3134 int i, son_number = 0, node_number = 0;
3136 if (dump_loop_information_flag) dump_loop_node(F, loop);
3138 for (i = 0; i < get_loop_n_elements(loop); i++) {
3139 loop_element le = get_loop_element(loop, i);
3140 if (*(le.kind) == k_ir_loop) {
3141 if (dump_loop_information_flag) dump_loop_son_edge(F, loop, son_number++);
3143 collect_nodeloop(F, le.son, loopnodes);
3145 if (dump_loop_information_flag) dump_loop_node_edge(F, loop, node_number++);
3146 eset_insert(loopnodes, le.node);
3151 void collect_nodeloop_external_nodes(ir_loop *loop, eset *loopnodes, eset *extnodes) {
3154 for(i = 0; i < get_loop_n_elements(loop); i++) {
3155 loop_element le = get_loop_element(loop, i);
3156 if (*(le.kind) == k_ir_loop) {
3158 collect_nodeloop_external_nodes(le.son, loopnodes, extnodes);
3160 if (is_Block(le.node)) start = 0; else start = -1;
3161 for (j = start; j < get_irn_arity(le.node); j++) {
3162 ir_node *pred = get_irn_n(le.node, j);
3163 if (!eset_contains(loopnodes, pred)) {
3164 eset_insert(extnodes, pred);
3165 if (!is_Block(pred)) {
3166 pred = get_nodes_block(pred);
3167 if (!eset_contains(loopnodes, pred)) eset_insert(extnodes, pred);
3175 void dump_loop(ir_loop *l, const char *suffix) {
3179 snprintf(name, sizeof(name), "loop_%d", get_loop_loop_nr(l));
3180 F = vcg_open_name(name, suffix);
3182 eset *loopnodes = eset_create();
3183 eset *extnodes = eset_create();
3186 dump_vcg_header(F, name, NULL, NULL);
3188 /* collect all nodes to dump */
3189 collect_nodeloop(F, l, loopnodes);
3190 collect_nodeloop_external_nodes(l, loopnodes, extnodes);
3192 /* build block lists */
3193 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes))
3194 set_irn_link(n, NULL);
3195 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes))
3196 set_irn_link(n, NULL);
3197 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes)) {
3199 b = get_nodes_block(n);
3200 set_irn_link(n, get_irn_link(b));
3204 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes)) {
3206 b = get_nodes_block(n);
3207 set_irn_link(n, get_irn_link(b));
3212 for (b = eset_first(loopnodes); b != NULL; b = eset_next(loopnodes)) {
3214 fprintf(F, "graph: { title: \"");
3216 fprintf(F, "\" label: \"");
3217 dump_node_opcode(F, b);
3218 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3219 fprintf(F, "\" status:clustered color:yellow\n");
3221 /* dump the blocks edges */
3222 dump_ir_data_edges(F, b);
3224 /* dump the nodes that go into the block */
3225 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3226 if (eset_contains(extnodes, n))
3227 overrule_nodecolor = ird_color_block_inout;
3229 overrule_nodecolor = ird_color_default_node;
3230 if (!eset_contains(extnodes, n)) dump_ir_data_edges(F, n);
3233 /* Close the vcg information for the block */
3235 dump_const_node_local(F, b);
3239 for (b = eset_first(extnodes); b != NULL; b = eset_next(extnodes)) {
3241 fprintf(F, "graph: { title: \"");
3243 fprintf(F, "\" label: \"");
3244 dump_node_opcode(F, b);
3245 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3246 fprintf(F, "\" status:clustered color:lightblue\n");
3248 /* dump the nodes that go into the block */
3249 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3250 if (!eset_contains(loopnodes, n))
3251 overrule_nodecolor = ird_color_block_inout;
3253 overrule_nodecolor = ird_color_default_node;
3254 if (eset_contains(loopnodes, n)) dump_ir_data_edges(F, n);
3257 /* Close the vcg information for the block */
3259 dump_const_node_local(F, b);
3263 eset_destroy(loopnodes);
3264 eset_destroy(extnodes);