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));
1204 /* Dumps the vrp information of a node to a file */
1205 int dump_vrp_info(FILE *F, ir_node *n) {
1206 if (!n->vrp.valid) {
1210 fprintf(F, "range_type: %d\n", n->vrp.range_type);
1211 if (n->vrp.range_type == VRP_RANGE || n->vrp.range_type ==
1213 ir_fprintf(F, "range_bottom: %F\n",n->vrp.range_bottom);
1214 ir_fprintf(F, "range_top: %F\n", n->vrp.range_top);
1216 ir_fprintf(F, "bits_set: %T\n", n->vrp.bits_set);
1217 ir_fprintf(F, "bits_not_set: %T\n", n->vrp.bits_not_set);
1218 if (n->vrp.bits_node == NULL) {
1219 fprintf(F, "bits_node: None");
1221 fprintf(F, "bits_node: #%ld\n", get_irn_node_nr(n->vrp.bits_node));
1228 * Dumps the attributes of a node n into the file F.
1229 * Currently this is only the color of a node.
1231 static void dump_node_vcgattr(FILE *F, ir_node *node, ir_node *local, int bad)
1237 print_vcg_color(F, ird_color_error);
1241 if (dump_node_vcgattr_hook)
1242 if (dump_node_vcgattr_hook(F, node, local))
1245 n = local ? local : node;
1247 if (overrule_nodecolor != ird_color_default_node) {
1248 print_vcg_color(F, overrule_nodecolor);
1252 mode = get_irn_mode(n);
1253 if(mode == mode_M) {
1254 print_vcg_color(F, ird_color_memory);
1257 if(mode == mode_X) {
1258 print_vcg_color(F, ird_color_controlflow);
1262 switch (get_irn_opcode(n)) {
1267 print_vcg_color(F, ird_color_anchor);
1270 print_vcg_color(F, ird_color_error);
1273 if (is_Block_dead(n))
1274 print_vcg_color(F, ird_color_dead_block_background);
1276 print_vcg_color(F, ird_color_block_background);
1279 print_vcg_color(F, ird_color_phi);
1282 print_vcg_color(F, ird_color_memory);
1286 print_vcg_color(F, ird_color_const);
1289 print_vcg_color(F, ird_color_proj);
1292 ir_op *op = get_irn_op(node);
1294 if(is_op_constlike(op)) {
1295 print_vcg_color(F, ird_color_const);
1296 } else if(is_op_uses_memory(op)) {
1297 print_vcg_color(F, ird_color_uses_memory);
1298 } else if(is_op_cfopcode(op) || is_op_forking(op)) {
1299 print_vcg_color(F, ird_color_controlflow);
1301 PRINT_DEFAULT_NODE_ATTR;
1307 /* Adds a new node info dumper callback. */
1308 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data)
1310 hook_entry_t *info = XMALLOC(hook_entry_t);
1312 info->hook._hook_node_info = cb;
1313 info->context = data;
1314 register_hook(hook_node_info, info);
1319 /* Remove a previously added info dumper callback. */
1320 void dump_remv_node_info_callback(void *handle)
1322 hook_entry_t *info = handle;
1323 unregister_hook(hook_node_info, info);
1328 * Dump the node information of a node n to a file F.
1330 static inline int dump_node_info(FILE *F, ir_node *n)
1333 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1335 fprintf(F, " info1: \"");
1336 bad = dump_irnode_to_file(F, n);
1337 /* call the dump_node operation if available */
1339 bad = ops->dump_node(n, F, dump_node_info_txt);
1341 /* allow additional info to be added */
1342 hook_node_info(F, n);
1348 static inline int is_constlike_node(const ir_node *node)
1350 const ir_op *op = get_irn_op(node);
1351 return is_op_constlike(op);
1355 /** outputs the predecessors of n, that are constants, local. I.e.,
1356 generates a copy of the constant predecessors for each node called with. */
1357 static void dump_const_node_local(FILE *F, ir_node *n) {
1359 if (!get_opt_dump_const_local()) return;
1361 /* Use visited flag to avoid outputting nodes twice.
1362 initialize it first. */
1363 for (i = 0; i < get_irn_arity(n); i++) {
1364 ir_node *con = get_irn_n(n, i);
1365 if (is_constlike_node(con)) {
1366 set_irn_visited(con, get_irg_visited(current_ir_graph) - 1);
1370 for (i = 0; i < get_irn_arity(n); i++) {
1371 ir_node *con = get_irn_n(n, i);
1372 if (is_constlike_node(con) && !irn_visited(con)) {
1375 mark_irn_visited(con);
1376 /* Generate a new name for the node by appending the names of
1378 fprintf(F, "node: {title: "); PRINT_CONSTID(n, con);
1379 fprintf(F, " label: \"");
1380 bad |= dump_node_label(F, con);
1382 bad |= dump_node_info(F, con);
1383 dump_node_vcgattr(F, n, con, bad);
1389 /** If the block of an edge is a const_like node, dump it local with an edge */
1390 static void dump_const_block_local(FILE *F, ir_node *n) {
1393 if (!get_opt_dump_const_local()) return;
1395 blk = get_nodes_block(n);
1396 if (is_constlike_node(blk)) {
1399 /* Generate a new name for the node by appending the names of
1401 fprintf(F, "node: {title: \""); PRINT_CONSTBLKID(n, blk);
1402 fprintf(F, "\" label: \"");
1403 bad |= dump_node_label(F, blk);
1405 bad |= dump_node_info(F, blk);
1406 dump_node_vcgattr(F, n, blk, bad);
1409 fprintf(F, "edge: { sourcename: \"");
1411 fprintf(F, "\" targetname: \""); PRINT_CONSTBLKID(n,blk);
1413 if (dump_edge_vcgattr_hook) {
1415 if (dump_edge_vcgattr_hook(F, n, -1)) {
1419 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1424 fprintf(F, "\" " BLOCK_EDGE_ATTR "}\n");
1429 * prints the error message of a node to a file F as info2.
1431 static void print_node_error(FILE *F, const char *err_msg)
1436 fprintf(F, " info2: \"%s\"", err_msg);
1440 * prints debug messages of a node to file F as info3.
1442 static void print_dbg_info(FILE *F, dbg_info *dbg)
1446 ir_dbg_info_snprint(buf, sizeof(buf), dbg);
1448 fprintf(F, " info3: \"%s\"\n", buf);
1452 static void print_type_dbg_info(FILE *F, type_dbg_info *dbg)
1462 static void dump_node(FILE *F, ir_node *n)
1467 if (get_opt_dump_const_local() && is_constlike_node(n))
1470 /* dump this node */
1471 fputs("node: {title: \"", F);
1475 fputs(" label: \"", F);
1476 bad = ! irn_vrfy_irg_dump(n, current_ir_graph, &p);
1477 bad |= dump_node_label(F, n);
1478 dump_node_ana_vals(F, n);
1479 //dump_node_ana_info(F, n);
1482 if (get_op_flags(get_irn_op(n)) & irop_flag_dump_noinput) {
1483 //fputs(" node_class:23", F);
1486 bad |= dump_node_info(F, n);
1487 print_node_error(F, p);
1488 print_dbg_info(F, get_irn_dbg_info(n));
1489 dump_node_vcgattr(F, n, NULL, bad);
1491 dump_const_node_local(F, n);
1493 if(dump_node_edge_hook)
1494 dump_node_edge_hook(F, n);
1497 /** dump the edge to the block this node belongs to */
1499 dump_ir_block_edge(FILE *F, ir_node *n) {
1500 if (get_opt_dump_const_local() && is_constlike_node(n)) return;
1501 if (is_no_Block(n)) {
1502 ir_node *block = get_nodes_block(n);
1504 if (get_opt_dump_const_local() && is_constlike_node(block)) {
1505 dump_const_block_local(F, n);
1507 fprintf(F, "edge: { sourcename: \"");
1509 fprintf(F, "\" targetname: ");
1510 fprintf(F, "\""); PRINT_NODEID(block); fprintf(F, "\"");
1512 if (dump_edge_vcgattr_hook) {
1514 if (dump_edge_vcgattr_hook(F, n, -1)) {
1518 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1523 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1529 print_data_edge_vcgattr(FILE *F, ir_node *from, int to) {
1531 * do not use get_nodes_block() here, will fail
1532 * if the irg is not pinned.
1534 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1535 fprintf(F, INTRA_DATA_EDGE_ATTR);
1537 fprintf(F, INTER_DATA_EDGE_ATTR);
1541 print_mem_edge_vcgattr(FILE *F, ir_node *from, int to) {
1543 * do not use get_nodes_block() here, will fail
1544 * if the irg is not pinned.
1546 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1547 fprintf(F, INTRA_MEM_EDGE_ATTR);
1549 fprintf(F, INTER_MEM_EDGE_ATTR);
1552 /** Print the vcg attributes for the edge from node from to it's to's input */
1553 static void print_edge_vcgattr(FILE *F, ir_node *from, int to) {
1556 if (dump_edge_vcgattr_hook)
1557 if (dump_edge_vcgattr_hook(F, from, to))
1560 if (dump_backedge_information_flag && is_backedge(from, to))
1561 fprintf(F, BACK_EDGE_ATTR);
1563 switch (get_irn_opcode(from)) {
1565 fprintf(F, CF_EDGE_ATTR);
1567 case iro_Start: break;
1570 if (get_irn_mode(get_End_keepalive(from, to)) == mode_BB)
1571 fprintf(F, KEEP_ALIVE_CF_EDGE_ATTR);
1573 fprintf(F, KEEP_ALIVE_DF_EDGE_ATTR);
1577 if (is_Proj(from)) {
1578 if (get_irn_mode(from) == mode_M)
1579 print_mem_edge_vcgattr(F, from, to);
1580 else if (get_irn_mode(from) == mode_X)
1581 fprintf(F, CF_EDGE_ATTR);
1583 print_data_edge_vcgattr(F, from, to);
1585 else if (get_irn_mode(get_irn_n(from, to)) == mode_M)
1586 print_mem_edge_vcgattr(F, from, to);
1587 else if (get_irn_mode(get_irn_n(from, to)) == mode_X)
1588 fprintf(F, CF_EDGE_ATTR);
1590 print_data_edge_vcgattr(F, from, to);
1594 /** dump edges to our inputs */
1595 static void dump_ir_data_edges(FILE *F, ir_node *n) {
1597 ir_visited_t visited = get_irn_visited(n);
1599 if (!dump_keepalive && is_End(n)) {
1600 /* the End node has only keep-alive edges */
1604 /* dump the dependency edges. */
1605 num = get_irn_deps(n);
1606 for (i = 0; i < num; ++i) {
1607 ir_node *dep = get_irn_dep(n, i);
1610 print_node_edge_kind(F, n);
1611 fprintf(F, "{sourcename: \"");
1613 fprintf(F, "\" targetname: ");
1614 if ((get_opt_dump_const_local()) && is_constlike_node(dep)) {
1615 PRINT_CONSTID(n, dep);
1621 fprintf(F, " label: \"%d\" ", i);
1622 fprintf(F, " color: darkgreen}\n");
1626 num = get_irn_arity(n);
1627 for (i = 0; i < num; i++) {
1628 ir_node *pred = get_irn_n(n, i);
1631 if ((get_interprocedural_view() && get_irn_visited(pred) < visited))
1632 continue; /* pred not dumped */
1634 if (dump_backedge_information_flag && is_backedge(n, i))
1635 fprintf(F, "backedge: {sourcename: \"");
1637 print_node_edge_kind(F, n);
1638 fprintf(F, "{sourcename: \"");
1641 fprintf(F, "\" targetname: ");
1642 if ((get_opt_dump_const_local()) && is_constlike_node(pred)) {
1643 PRINT_CONSTID(n, pred);
1645 fprintf(F, "\""); PRINT_NODEID(pred); fprintf(F, "\"");
1647 fprintf(F, " label: \"%d\" ", i);
1648 print_edge_vcgattr(F, n, i);
1652 if (dump_macro_block_edges && is_Block(n)) {
1653 ir_node *mb = get_Block_MacroBlock(n);
1654 fprintf(F, "edge: {sourcename: \"");
1656 fprintf(F, "\" targetname: \"");
1658 fprintf(F, "\" label: \"mb\" " MACROBLOCK_EDGE_ATTR);
1667 dump_ir_edges(FILE *F, ir_node *n) {
1668 const ir_edge_t *edge;
1671 foreach_out_edge(n, edge) {
1672 ir_node *succ = get_edge_src_irn(edge);
1674 print_node_edge_kind(F, succ);
1675 fprintf(F, "{sourcename: \"");
1677 fprintf(F, "\" targetname: \"");
1681 fprintf(F, " label: \"%d\" ", i);
1682 fprintf(F, OUT_EDGE_ATTR);
1689 /** Dumps a node and its edges but not the block edge */
1690 static void dump_node_wo_blockedge(ir_node *n, void *env) {
1693 dump_ir_data_edges(F, n);
1696 /** Dumps a node and its edges. */
1697 static void dump_whole_node(ir_node *n, void *env) {
1699 dump_node_wo_blockedge(n, env);
1700 if (!node_floats(n))
1701 dump_ir_block_edge(F, n);
1702 if (dump_new_edges_flag && edges_activated(current_ir_graph))
1703 dump_ir_edges(F, n);
1706 /** Dumps a const-like node. */
1707 static void dump_const_node(ir_node *n, void *env) {
1708 if (is_Block(n)) return;
1709 dump_node_wo_blockedge(n, env);
1712 /***********************************************************************/
1713 /* the following routines dump the nodes/irgs bracketed to graphs. */
1714 /***********************************************************************/
1716 /** Dumps a constant expression as entity initializer, array bound ...
1718 static void dump_const_expression(FILE *F, ir_node *value) {
1719 ir_graph *rem = current_ir_graph;
1720 int rem_dump_const_local = dump_const_local;
1721 dump_const_local = 0;
1722 current_ir_graph = get_const_code_irg();
1723 irg_walk(value, dump_const_node, NULL, F);
1724 /* Decrease visited flag so that we walk with the same flag for the next
1725 expression. This guarantees that we don't dump the same node twice,
1726 as for const expressions cse is performed to save memory. */
1727 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph) -1);
1728 current_ir_graph = rem;
1729 dump_const_local = rem_dump_const_local;
1732 /** Dump a block as graph containing its nodes.
1734 * Expects to find nodes belonging to the block as list in its
1736 * Dumps the edges of all nodes including itself. */
1737 static void dump_whole_block(FILE *F, ir_node *block) {
1739 ird_color_t color = ird_color_block_background;
1741 assert(is_Block(block));
1743 fprintf(F, "graph: { title: \"");
1744 PRINT_NODEID(block);
1745 fprintf(F, "\" label: \"");
1746 dump_node_label(F, block);
1748 /* colorize blocks */
1749 if (! get_Block_matured(block))
1750 color = ird_color_block_background;
1751 if (is_Block_dead(block))
1752 color = ird_color_dead_block_background;
1754 fprintf(F, "\" status:clustered ");
1755 print_vcg_color(F, color);
1758 /* yComp can show attributes for blocks, XVCG parses but ignores them */
1759 dump_node_info(F, block);
1760 print_dbg_info(F, get_irn_dbg_info(block));
1762 /* dump the blocks edges */
1763 dump_ir_data_edges(F, block);
1765 if (dump_block_edge_hook)
1766 dump_block_edge_hook(F, block);
1768 /* dump the nodes that go into the block */
1769 for (node = ird_get_irn_link(block); node; node = ird_get_irn_link(node)) {
1771 dump_ir_data_edges(F, node);
1774 /* Close the vcg information for the block */
1776 dump_const_node_local(F, block);
1780 /** dumps a graph block-wise. Expects all blockless nodes in arr in irgs link.
1781 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1783 dump_block_graph(FILE *F, ir_graph *irg) {
1785 ir_graph *rem = current_ir_graph;
1786 ir_node **arr = ird_get_irg_link(irg);
1787 current_ir_graph = irg;
1789 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1790 ir_node * node = arr[i];
1791 if (is_Block(node)) {
1792 /* Dumps the block and all the nodes in the block, which are to
1793 be found in Block->link. */
1794 dump_whole_block(F, node);
1796 /* Nodes that are not in a Block. */
1798 if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
1799 dump_const_block_local(F, node);
1801 dump_ir_data_edges(F, node);
1803 if (dump_new_edges_flag && edges_activated(irg))
1804 dump_ir_edges(F, node);
1807 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1808 dump_loop_nodes_into_graph(F, irg);
1810 current_ir_graph = rem;
1814 * Dump the info for an irg.
1815 * Parsed by XVCG but not shown. use yComp.
1817 static void dump_graph_info(FILE *F, ir_graph *irg) {
1818 fprintf(F, "info1: \"");
1819 dump_entity_to_file(F, get_irg_entity(irg), dump_verbosity_entattrs | dump_verbosity_entconsts);
1823 /** Dumps an irg as a graph clustered by block nodes.
1824 * If interprocedural view edges can point to nodes out of this graph.
1826 static void dump_graph_from_list(FILE *F, ir_graph *irg) {
1827 ir_entity *ent = get_irg_entity(irg);
1829 fprintf(F, "graph: { title: \"");
1831 fprintf(F, "\" label: \"%s\" status:clustered color:%s \n",
1832 get_ent_dump_name(ent), color_names[ird_color_prog_background]);
1834 dump_graph_info(F, irg);
1835 print_dbg_info(F, get_entity_dbg_info(ent));
1837 dump_block_graph(F, irg);
1839 /* Close the vcg information for the irg */
1840 fprintf(F, "}\n\n");
1843 /** dumps a graph extended block-wise. Expects all blockless nodes in arr in irgs link.
1844 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1846 dump_extblock_graph(FILE *F, ir_graph *irg) {
1848 ir_graph *rem = current_ir_graph;
1849 ir_extblk **arr = ird_get_irg_link(irg);
1850 current_ir_graph = irg;
1852 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1853 ir_extblk *extbb = arr[i];
1854 ir_node *leader = get_extbb_leader(extbb);
1857 fprintf(F, "graph: { title: \"");
1858 PRINT_EXTBBID(leader);
1859 fprintf(F, "\" label: \"ExtBB %ld\" status:clustered color:lightgreen\n",
1860 get_irn_node_nr(leader));
1862 for (j = ARR_LEN(extbb->blks) - 1; j >= 0; --j) {
1863 ir_node * node = extbb->blks[j];
1864 if (is_Block(node)) {
1865 /* Dumps the block and all the nodes in the block, which are to
1866 be found in Block->link. */
1867 dump_whole_block(F, node);
1869 /* Nodes that are not in a Block. */
1871 if (is_Bad(get_nodes_block(node)) && !node_floats(node)) {
1872 dump_const_block_local(F, node);
1874 dump_ir_data_edges(F, node);
1880 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1881 dump_loop_nodes_into_graph(F, irg);
1883 current_ir_graph = rem;
1888 /*******************************************************************/
1889 /* Basic type and entity nodes and edges. */
1890 /*******************************************************************/
1892 /** dumps the edges between nodes and their type or entity attributes. */
1893 static void dump_node2type_edges(ir_node *n, void *env)
1898 switch (get_irn_opcode(n)) {
1900 /* @@@ some consts have an entity */
1903 if (SYMCONST_HAS_TYPE(get_SymConst_kind(n)))
1904 print_node_type_edge(F,n,get_SymConst_type(n),NODE2TYPE_EDGE_ATTR);
1907 print_node_ent_edge(F,n,get_Sel_entity(n),NODE2TYPE_EDGE_ATTR);
1910 print_node_type_edge(F,n,get_Call_type(n),NODE2TYPE_EDGE_ATTR);
1913 print_node_type_edge(F,n,get_Alloc_type(n),NODE2TYPE_EDGE_ATTR);
1916 print_node_type_edge(F,n,get_Free_type(n),NODE2TYPE_EDGE_ATTR);
1919 print_node_type_edge(F,n,get_Cast_type(n),NODE2TYPE_EDGE_ATTR);
1927 static int print_type_info(FILE *F, ir_type *tp) {
1930 if (get_type_state(tp) == layout_undefined) {
1931 fprintf(F, "state: layout_undefined\n");
1933 fprintf(F, "state: layout_fixed,\n");
1935 if (get_type_mode(tp))
1936 fprintf(F, "mode: %s,\n", get_mode_name_ex(get_type_mode(tp), &bad));
1937 fprintf(F, "size: %db,\n", get_type_size_bits(tp));
1942 static void print_typespecific_info(FILE *F, ir_type *tp) {
1943 switch (get_type_tpop_code(tp)) {
1945 fprintf(F, "peculiarity: %s\n", get_peculiarity_string(get_class_peculiarity(tp)));
1950 fprintf(F, "variadicity: %s\n", get_variadicity_name(get_method_variadicity(tp)));
1951 fprintf(F, "params: %d\n", get_method_n_params(tp));
1952 fprintf(F, "results: %d\n", get_method_n_ress(tp));
1958 case tpo_enumeration:
1970 static void print_typespecific_vcgattr(FILE *F, ir_type *tp) {
1971 switch (get_type_tpop_code(tp)) {
1973 fprintf(F, " " TYPE_CLASS_NODE_ATTR);
1976 fprintf(F, " " TYPE_METH_NODE_ATTR);
1984 case tpo_enumeration:
1995 int dump_type_node(FILE *F, ir_type *tp)
1999 fprintf(F, "node: {title: ");
2001 ir_fprintf(F, " label: \"%s %+F\" info1: \"", get_type_tpop_name(tp), tp);
2002 dump_type_to_file(F, tp, dump_verbosity_max);
2004 print_type_dbg_info(F, get_type_dbg_info(tp));
2005 print_typespecific_vcgattr(F, tp);
2012 void dump_entity_node(FILE *F, ir_entity *ent)
2014 fprintf(F, "node: {title: \"");
2015 PRINT_ENTID(ent); fprintf(F, "\"");
2016 fprintf(F, DEFAULT_TYPE_ATTRIBUTE);
2017 fprintf(F, "label: ");
2018 fprintf(F, "\"%s\" ", get_ent_dump_name(ent));
2020 print_vcg_color(F, ird_color_entity);
2021 fprintf(F, "\n info1: \"");
2023 dump_entity_to_file(F, ent, dump_verbosity_entattrs | dump_verbosity_entconsts);
2026 print_dbg_info(F, get_entity_dbg_info(ent));
2030 static void dump_enum_item(FILE *F, ir_type *tp, int pos)
2033 ir_enum_const *ec = get_enumeration_const(tp, pos);
2034 ident *id = get_enumeration_const_nameid(ec);
2035 tarval *tv = get_enumeration_value(ec);
2038 tarval_snprintf(buf, sizeof(buf), tv);
2040 strncpy(buf, "<not set>", sizeof(buf));
2041 fprintf(F, "node: {title: \"");
2042 PRINT_ITEMID(tp, pos); fprintf(F, "\"");
2043 fprintf(F, DEFAULT_ENUM_ITEM_ATTRIBUTE);
2044 fprintf(F, "label: ");
2045 fprintf(F, "\"enum item %s\" " ENUM_ITEM_NODE_ATTR, get_id_str(id));
2046 fprintf(F, "\n info1: \"value: %s\"}\n", buf);
2050 * Dumps a new style initializer.
2052 static void dump_entity_initializer(FILE *F, const ir_entity *ent) {
2058 /** Dumps a type or entity and it's edges. */
2059 static void dump_type_info(type_or_ent tore, void *env) {
2061 int i = 0; /* to shutup gcc */
2063 /* dump this type or entity */
2065 switch (get_kind(tore.ent)) {
2067 ir_entity *ent = tore.ent;
2070 dump_entity_node(F, ent);
2072 /* skip this to reduce graph. Member edge of type is parallel to this edge. *
2073 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2074 ENT_OWN_EDGE_ATTR "}\n", ent, get_entity_owner(ent));*/
2075 print_ent_type_edge(F,ent, get_entity_type(ent), ENT_TYPE_EDGE_ATTR);
2076 if (is_Class_type(get_entity_owner(ent))) {
2077 for (i = get_entity_n_overwrites(ent) - 1; i >= 0; --i)
2078 print_ent_ent_edge(F,ent, get_entity_overwrites(ent, i), 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2080 /* attached subgraphs */
2081 if (const_entities) {
2082 if (ent->initializer != NULL) {
2083 /* new style initializers */
2084 dump_entity_initializer(F, ent);
2085 } else if (entity_has_compound_ent_values(ent)) {
2086 /* old style compound entity values */
2087 for (i = get_compound_ent_n_values(ent) - 1; i >= 0; --i) {
2088 value = get_compound_ent_value(ent, i);
2090 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2091 dump_const_expression(F, value);
2092 print_ent_ent_edge(F, ent, get_compound_ent_value_member(ent, i), 0, -1, ENT_CORR_EDGE_ATTR, i);
2094 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2095 ENT_CORR_EDGE_ATTR "}\n", GET_ENTID(ent),
2096 get_compound_ent_value_member(ent, i), i);
2105 ir_type *tp = tore.typ;
2106 dump_type_node(F, tp);
2107 /* and now the edges */
2108 switch (get_type_tpop_code(tp)) {
2110 for (i = get_class_n_supertypes(tp) - 1; i >= 0; --i)
2111 print_type_type_edge(F, tp, get_class_supertype(tp, i), TYPE_SUPER_EDGE_ATTR);
2112 for (i = get_class_n_members(tp) - 1; i >= 0; --i)
2113 print_type_ent_edge(F, tp, get_class_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
2116 for (i = get_struct_n_members(tp) - 1; i >= 0; --i)
2117 print_type_ent_edge(F, tp, get_struct_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
2120 for (i = get_method_n_params(tp) - 1; i >= 0; --i)
2121 print_type_type_edge(F, tp, get_method_param_type(tp, i), METH_PAR_EDGE_ATTR,i);
2122 for (i = get_method_n_ress(tp) - 1; i >= 0; --i)
2123 print_type_type_edge(F, tp, get_method_res_type(tp, i), METH_RES_EDGE_ATTR,i);
2126 for (i = get_union_n_members(tp) - 1; i >= 0; --i)
2127 print_type_ent_edge(F, tp, get_union_member(tp, i), UNION_EDGE_ATTR);
2130 print_type_type_edge(F, tp, get_array_element_type(tp), ARR_ELT_TYPE_EDGE_ATTR);
2131 print_type_ent_edge(F, tp, get_array_element_entity(tp), ARR_ENT_EDGE_ATTR);
2132 for (i = get_array_n_dimensions(tp) - 1; i >= 0; --i) {
2133 ir_node *upper = get_array_upper_bound(tp, i);
2134 ir_node *lower = get_array_lower_bound(tp, i);
2135 print_node_type_edge(F, upper, tp, "label: \"upper %d\"", get_array_order(tp, i));
2136 print_node_type_edge(F, lower, tp, "label: \"lower %d\"", get_array_order(tp, i));
2137 dump_const_expression(F, upper);
2138 dump_const_expression(F, lower);
2141 case tpo_enumeration:
2142 for (i = get_enumeration_n_enums(tp) - 1; i >= 0; --i) {
2143 dump_enum_item(F, tp, i);
2144 print_enum_item_edge(F, tp, i, "label: \"item %d\"", i);
2148 print_type_type_edge(F, tp, get_pointer_points_to_type(tp), PTR_PTS_TO_EDGE_ATTR);
2155 break; /* case k_type */
2158 printf(" *** irdump, dump_type_info(l.%i), faulty type.\n", __LINE__);
2159 } /* switch kind_or_entity */
2162 typedef struct _h_env {
2167 /** For dumping class hierarchies.
2168 * Dumps a class type node and a superclass edge.
2169 * If env->dump_ent dumps entities of classes and overwrites edges.
2172 dump_class_hierarchy_node(type_or_ent tore, void *ctx) {
2175 int i = 0; /* to shutup gcc */
2177 /* dump this type or entity */
2178 switch (get_kind(tore.ent)) {
2180 ir_entity *ent = tore.ent;
2181 if (get_entity_owner(ent) == get_glob_type()) break;
2182 if (!is_Method_type(get_entity_type(ent)))
2184 if (env->dump_ent && is_Class_type(get_entity_owner(ent))) {
2186 dump_entity_node(F, ent);
2188 print_type_ent_edge(F, get_entity_owner(ent), ent, TYPE_MEMBER_EDGE_ATTR);
2189 for (i = get_entity_n_overwrites(ent) - 1; i >= 0; --i)
2190 print_ent_ent_edge(F, get_entity_overwrites(ent, i), ent, 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2195 ir_type *tp = tore.typ;
2196 if (tp == get_glob_type())
2198 switch (get_type_tpop_code(tp)) {
2200 dump_type_node(F, tp);
2201 /* and now the edges */
2202 for (i = get_class_n_supertypes(tp) - 1; i >= 0; --i) {
2203 print_type_type_edge(F,tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2208 break; /* case k_type */
2211 printf(" *** irdump, dump_class_hierarchy_node(l.%i), faulty type.\n", __LINE__);
2212 } /* switch kind_or_entity */
2215 /*******************************************************************/
2216 /* dump analysis information that is expressed in graph terms. */
2217 /*******************************************************************/
2219 /* dump out edges */
2221 dump_out_edge(ir_node *n, void *env) {
2224 for (i = get_irn_n_outs(n) - 1; i >= 0; --i) {
2225 ir_node *succ = get_irn_out(n, i);
2227 print_node_edge_kind(F, succ);
2228 fprintf(F, "{sourcename: \"");
2230 fprintf(F, "\" targetname: \"");
2232 fprintf(F, "\" color: red linestyle: dashed");
2238 dump_loop_label(FILE *F, ir_loop *loop) {
2239 fprintf(F, "loop %d, %d sons, %d nodes",
2240 get_loop_depth(loop), get_loop_n_sons(loop), get_loop_n_nodes(loop));
2243 static inline void dump_loop_info(FILE *F, ir_loop *loop) {
2244 fprintf(F, " info1: \"");
2245 fprintf(F, " loop nr: %d", get_loop_loop_nr(loop));
2246 #ifdef DEBUG_libfirm /* GL @@@ debug analyses */
2247 fprintf(F, "\n The loop was analyzed %d times.", PTR_TO_INT(get_loop_link(loop)));
2253 dump_loop_node(FILE *F, ir_loop *loop) {
2254 fprintf(F, "node: {title: \"");
2256 fprintf(F, "\" label: \"");
2257 dump_loop_label(F, loop);
2259 dump_loop_info(F, loop);
2264 dump_loop_node_edge(FILE *F, ir_loop *loop, int i) {
2266 fprintf(F, "edge: {sourcename: \"");
2268 fprintf(F, "\" targetname: \"");
2269 PRINT_NODEID(get_loop_node(loop, i));
2270 fprintf(F, "\" color: green");
2275 dump_loop_son_edge(FILE *F, ir_loop *loop, int i) {
2277 fprintf(F, "edge: {sourcename: \"");
2279 fprintf(F, "\" targetname: \"");
2280 PRINT_LOOPID(get_loop_son(loop, i));
2281 fprintf(F, "\" color: darkgreen label: \"%d\"}\n",
2282 get_loop_element_pos(loop, get_loop_son(loop, i)));
2286 void dump_loops(FILE *F, ir_loop *loop) {
2288 /* dump this loop node */
2289 dump_loop_node(F, loop);
2291 /* dump edges to nodes in loop -- only if it is a real loop */
2292 if (get_loop_depth(loop) != 0) {
2293 for (i = get_loop_n_nodes(loop) - 1; i >= 0; --i) {
2294 dump_loop_node_edge(F, loop, i);
2297 for (i = get_loop_n_sons(loop) - 1; i >= 0; --i) {
2298 dump_loops(F, get_loop_son(loop, i));
2299 dump_loop_son_edge(F, loop, i);
2304 void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg) {
2305 ir_loop *loop = get_irg_loop(irg);
2308 ir_graph *rem = current_ir_graph;
2309 current_ir_graph = irg;
2311 dump_loops(F, loop);
2313 current_ir_graph = rem;
2319 * dumps the VCG header
2321 void dump_vcg_header(FILE *F, const char *name, const char *layout, const char *orientation) {
2327 label = edge_label ? "yes" : "no";
2328 if (! layout) layout = "Compilergraph";
2329 if (!orientation) orientation = "bottom_to_top";
2333 "graph: { title: \"ir graph of %s\"\n"
2334 "display_edge_labels: %s\n"
2335 "layoutalgorithm: mindepth //$ \"%s\"\n"
2336 "manhattan_edges: yes\n"
2337 "port_sharing: no\n"
2339 "classname 1: \"intrablock Data\"\n"
2340 "classname 2: \"Block\"\n"
2341 "classname 3: \"Entity type\"\n"
2342 "classname 4: \"Entity owner\"\n"
2343 "classname 5: \"Method Param\"\n"
2344 "classname 6: \"Method Res\"\n"
2345 "classname 7: \"Super\"\n"
2346 "classname 8: \"Union\"\n"
2347 "classname 9: \"Points-to\"\n"
2348 "classname 10: \"Array Element Type\"\n"
2349 "classname 11: \"Overwrites\"\n"
2350 "classname 12: \"Member\"\n"
2351 "classname 13: \"Control Flow\"\n"
2352 "classname 14: \"intrablock Memory\"\n"
2353 "classname 15: \"Dominators\"\n"
2354 "classname 16: \"interblock Data\"\n"
2355 "classname 17: \"interblock Memory\"\n"
2356 "classname 18: \"Exception Control Flow for Interval Analysis\"\n"
2357 "classname 19: \"Postdominators\"\n"
2358 "classname 20: \"Keep Alive\"\n"
2359 "classname 21: \"Out Edges\"\n"
2360 "classname 22: \"Macro Block Edges\"\n"
2361 //"classname 23: \"NoInput Nodes\"\n"
2362 "infoname 1: \"Attribute\"\n"
2363 "infoname 2: \"Verification errors\"\n"
2364 "infoname 3: \"Debug info\"\n",
2365 name, label, layout, orientation);
2367 for (i = 0; i < ird_color_count; ++i) {
2368 if (color_rgb[i] != NULL) {
2369 fprintf(F, "colorentry %s: %s\n", color_names[i], color_rgb[i]);
2372 fprintf(F, "\n"); /* a separator */
2378 * @param irg The graph to be dumped
2379 * @param suffix1 first filename suffix
2380 * @param suffix2 second filename suffix
2382 FILE *vcg_open(const ir_graph *irg, const char *suffix1, const char *suffix2) {
2384 const char *nm = get_irg_dump_name(irg);
2385 int len = strlen(nm), i, j;
2386 char *fname; /* filename to put the vcg information in */
2388 if (!suffix1) suffix1 = "";
2389 if (!suffix2) suffix2 = "";
2391 /* open file for vcg graph */
2392 fname = XMALLOCN(char, len * 2 + strlen(suffix1) + strlen(suffix2) + 5);
2394 /* strncpy (fname, nm, len); */ /* copy the filename */
2396 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2398 fname[j] = '@'; j++; fname[j] = '1'; j++;
2399 } else if (nm[i] == '@') {
2400 fname[j] = '@'; j++; fname[j] = '2'; j++;
2402 fname[j] = nm[i]; j++;
2406 strcat(fname, suffix1); /* append file suffix */
2407 strcat(fname, suffix2); /* append file suffix */
2408 strcat(fname, ".vcg"); /* append the .vcg suffix */
2410 /* vcg really expect only a <CR> at end of line, so
2411 * the "b"inary mode is what you mean (and even needed for Win32)
2413 F = fopen(fname, "wb"); /* open file for writing */
2425 * @param name prefix file name
2426 * @param suffix filename suffix
2428 FILE *vcg_open_name(const char *name, const char *suffix) {
2430 char *fname; /* filename to put the vcg information in */
2431 int i, j, len = strlen(name);
2433 if (!suffix) suffix = "";
2435 /** open file for vcg graph */
2436 fname = XMALLOCN(char, len * 2 + 5 + strlen(suffix));
2437 /* strcpy (fname, name);*/ /* copy the filename */
2439 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2440 if (name[i] == '/') {
2441 fname[j] = '@'; j++; fname[j] = '1'; j++;
2442 } else if (name[i] == '@') {
2443 fname[j] = '@'; j++; fname[j] = '2'; j++;
2445 fname[j] = name[i]; j++;
2449 strcat(fname, suffix);
2450 strcat(fname, ".vcg"); /* append the .vcg suffix */
2452 /* vcg really expect only a <CR> at end of line, so
2453 * the "b"inary mode is what you mean (and even needed for Win32)
2455 F = fopen(fname, "wb"); /* open file for writing */
2465 * Dumps the vcg file footer
2467 void dump_vcg_footer(FILE *F) {
2471 /************************************************************************/
2472 /************************************************************************/
2473 /* Routines that dump all or parts of the firm representation to a file */
2474 /************************************************************************/
2475 /************************************************************************/
2477 /************************************************************************/
2478 /* Dump ir graphs, different formats and additional information. */
2479 /************************************************************************/
2481 typedef void (*do_dump_graph_func) (ir_graph *irg, FILE *out);
2483 static void do_dump(ir_graph *irg, const char *suffix, const char *suffix_ip,
2484 const char *suffix_nonip, do_dump_graph_func dump_func)
2488 const char *suffix1;
2490 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2493 rem = current_ir_graph;
2494 current_ir_graph = irg;
2495 if (get_interprocedural_view())
2496 suffix1 = suffix_ip;
2498 suffix1 = suffix_nonip;
2499 current_ir_graph = rem;
2501 out = vcg_open(irg, suffix, suffix1);
2503 dump_func(irg, out);
2508 void dump_ir_graph_file(ir_graph *irg, FILE *out)
2510 if (dump_backedge_information_flag
2511 && get_irg_loopinfo_state(irg) != loopinfo_consistent) {
2512 construct_backedges(irg);
2515 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2517 /* call the dump graph hook */
2518 if (dump_ir_graph_hook) {
2519 if (dump_ir_graph_hook(out, irg)) {
2524 /* walk over the graph */
2525 /* dump_whole_node must be called in post visiting predecessors */
2526 ird_walk_graph(irg, NULL, dump_whole_node, out);
2528 /* dump the out edges in a separate walk */
2529 if ((dump_out_edge_flag) && (get_irg_outs_state(irg) != outs_none)) {
2530 irg_out_walk(get_irg_start(irg), dump_out_edge, NULL, out);
2533 dump_vcg_footer(out);
2536 /** Routine to dump a graph, blocks as conventional nodes. */
2537 void dump_ir_graph(ir_graph *irg, const char *suffix )
2539 do_dump(irg, suffix, "-pure-ip", "-pure", dump_ir_graph_file);
2542 void dump_ir_block_graph_file(ir_graph *irg, FILE *out)
2546 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2548 construct_block_lists(irg);
2551 * If we are in the interprocedural view, we dump not
2552 * only the requested irg but also all irgs that can be reached
2555 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2556 ir_graph *g = get_irp_irg(i);
2557 ir_node **arr = ird_get_irg_link(g);
2559 dump_graph_from_list(out, g);
2564 dump_vcg_footer(out);
2567 /* Dump a firm graph without explicit block nodes. */
2568 void dump_ir_block_graph(ir_graph *irg, const char *suffix)
2570 do_dump(irg, suffix, "-ip", "", dump_ir_block_graph_file);
2573 void dump_ir_extblock_graph_file(ir_graph *irg, FILE *F)
2576 ir_entity *ent = get_irg_entity(irg);
2578 if (get_irg_extblk_state(irg) != extblk_valid)
2581 dump_vcg_header(F, get_irg_dump_name(irg), NULL, NULL);
2583 construct_extblock_lists(irg);
2585 fprintf(F, "graph: { title: \"");
2587 fprintf(F, "\" label: \"%s\" status:clustered color: white \n",
2588 get_ent_dump_name(ent));
2590 dump_graph_info(F, irg);
2591 print_dbg_info(F, get_entity_dbg_info(ent));
2593 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2594 ir_graph *irg = get_irp_irg(i);
2595 list_tuple *lists = ird_get_irg_link(irg);
2598 /* dump the extended blocks first */
2599 if (ARR_LEN(lists->extbb_list)) {
2600 ird_set_irg_link(irg, lists->extbb_list);
2601 dump_extblock_graph(F, irg);
2604 /* we may have blocks without extended blocks, bad for instance */
2605 if (ARR_LEN(lists->blk_list)) {
2606 ird_set_irg_link(irg, lists->blk_list);
2607 dump_block_graph(F, irg);
2610 DEL_ARR_F(lists->extbb_list);
2611 DEL_ARR_F(lists->blk_list);
2616 /* Close the vcg information for the irg */
2617 fprintf(F, "}\n\n");
2623 /* Dump a firm graph without explicit block nodes but grouped in extended blocks. */
2624 void dump_ir_extblock_graph(ir_graph *irg, const char *suffix)
2626 do_dump(irg, suffix, "-ip", "", dump_ir_extblock_graph_file);
2629 void dump_ir_graph_w_types_file(ir_graph *irg, FILE *out)
2631 ir_graph *rem = current_ir_graph;
2632 int rem_dump_const_local;
2634 rem = current_ir_graph;
2635 current_ir_graph = irg;
2636 rem_dump_const_local = dump_const_local;
2637 /* dumping types does not work with local nodes */
2638 dump_const_local = 0;
2640 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2642 /* dump common ir graph */
2643 irg_walk(get_irg_end(irg), NULL, dump_whole_node, out);
2644 /* dump type info */
2645 type_walk_irg(irg, dump_type_info, NULL, out);
2646 inc_irg_visited(get_const_code_irg());
2647 /* dump edges from graph to type info */
2648 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2650 dump_vcg_footer(out);
2651 dump_const_local = rem_dump_const_local;
2652 current_ir_graph = rem;
2655 /* dumps a graph with type information */
2656 void dump_ir_graph_w_types(ir_graph *irg, const char *suffix)
2658 do_dump(irg, suffix, "-pure-wtypes-ip", "-pure-wtypes",
2659 dump_ir_graph_w_types_file);
2662 void dump_ir_block_graph_w_types_file(ir_graph *irg, FILE *out)
2665 int rem_dump_const_local;
2666 ir_graph *rem = current_ir_graph;
2668 rem_dump_const_local = dump_const_local;
2669 /* dumping types does not work with local nodes */
2670 dump_const_local = 0;
2672 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2674 /* dump common blocked ir graph */
2675 construct_block_lists(irg);
2677 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2678 ir_node **arr = ird_get_irg_link(get_irp_irg(i));
2680 dump_graph_from_list(out, get_irp_irg(i));
2685 /* dump type info */
2686 current_ir_graph = irg;
2687 type_walk_irg(irg, dump_type_info, NULL, out);
2688 inc_irg_visited(get_const_code_irg());
2690 /* dump edges from graph to type info */
2691 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2693 dump_vcg_footer(out);
2694 dump_const_local = rem_dump_const_local;
2695 current_ir_graph = rem;
2698 void dump_ir_block_graph_w_types(ir_graph *irg, const char *suffix)
2700 do_dump(irg, suffix, "-wtypes-ip", "-wtypes",
2701 dump_ir_block_graph_w_types_file);
2704 /*---------------------------------------------------------------------*/
2705 /* The following routines dump a control flow graph. */
2706 /*---------------------------------------------------------------------*/
2709 dump_block_to_cfg(ir_node *block, void *env) {
2714 if (is_Block(block)) {
2715 /* This is a block. Dump a node for the block. */
2716 fprintf(F, "node: {title: \""); PRINT_NODEID(block);
2717 fprintf(F, "\" label: \"");
2718 if (block == get_irg_start_block(get_irn_irg(block)))
2719 fprintf(F, "Start ");
2720 if (block == get_irg_end_block(get_irn_irg(block)))
2723 fprintf(F, "%s ", get_op_name(get_irn_op(block)));
2724 PRINT_NODEID(block);
2726 fprintf(F, "info1:\"");
2728 /* the generic version. */
2729 dump_irnode_to_file(F, block);
2731 /* Check whether we have bad predecessors to color the block. */
2732 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
2733 if ((fl = is_Bad(get_Block_cfgpred(block, i))))
2736 fprintf(F, "\""); /* closing quote of info */
2738 if ((block == get_irg_start_block(get_irn_irg(block))) ||
2739 (block == get_irg_end_block(get_irn_irg(block))) )
2740 fprintf(F, " color:blue ");
2742 fprintf(F, " color:yellow ");
2745 /* Dump the edges */
2746 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
2747 if (!is_Bad(skip_Proj(get_Block_cfgpred(block, i)))) {
2748 pred = get_nodes_block(skip_Proj(get_Block_cfgpred(block, i)));
2749 fprintf(F, "edge: { sourcename: \"");
2750 PRINT_NODEID(block);
2751 fprintf(F, "\" targetname: \"");
2753 fprintf(F, "\"}\n");
2756 /* Dump dominator/postdominator edge */
2757 if (dump_dominator_information_flag) {
2758 if (get_irg_dom_state(current_ir_graph) == dom_consistent && get_Block_idom(block)) {
2759 pred = get_Block_idom(block);
2760 fprintf(F, "edge: { sourcename: \"");
2761 PRINT_NODEID(block);
2762 fprintf(F, "\" targetname: \"");
2764 fprintf(F, "\" " DOMINATOR_EDGE_ATTR "}\n");
2766 if (get_irg_postdom_state(current_ir_graph) == dom_consistent && get_Block_ipostdom(block)) {
2767 pred = get_Block_ipostdom(block);
2768 fprintf(F, "edge: { sourcename: \"");
2769 PRINT_NODEID(block);
2770 fprintf(F, "\" targetname: \"");
2772 fprintf(F, "\" " POSTDOMINATOR_EDGE_ATTR "}\n");
2778 void dump_cfg(ir_graph *irg, const char *suffix)
2781 /* if a filter is set, dump only the irg's that match the filter */
2782 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2785 f = vcg_open(irg, suffix, "-cfg");
2787 ir_graph *rem = current_ir_graph;
2788 #ifdef INTERPROCEDURAL_VIEW
2789 int ipv = get_interprocedural_view();
2792 current_ir_graph = irg;
2793 dump_vcg_header(f, get_irg_dump_name(irg), NULL, NULL);
2795 #ifdef INTERPROCEDURAL_VIEW
2797 printf("Warning: dumping cfg not in interprocedural view!\n");
2798 set_interprocedural_view(0);
2802 /* walk over the blocks in the graph */
2803 irg_block_walk(get_irg_end(irg), dump_block_to_cfg, NULL, f);
2804 dump_node(f, get_irg_bad(irg));
2806 #ifdef INTERPROCEDURAL_VIEW
2807 set_interprocedural_view(ipv);
2811 current_ir_graph = rem;
2816 static void descend_and_dump(FILE *F, ir_node *n, int depth, pset *mark_set) {
2817 if (pset_find_ptr(mark_set, n))
2820 pset_insert_ptr(mark_set, n);
2823 int i, start = is_Block(n) ? 0 : -1;
2824 dump_whole_node(n, F);
2825 for (i = start; i < get_irn_arity(n); ++i)
2826 descend_and_dump(F, get_irn_n(n, i), depth-1, mark_set);
2829 /* Don't dump edges to nodes further out. These might be edges to
2830 nodes we already dumped, if there is a shorter path to these. */
2834 static int subgraph_counter = 0;
2835 void dump_subgraph(ir_node *root, int depth, const char *suffix) {
2839 sprintf(buf, "-subg_%03d", subgraph_counter++);
2840 F = vcg_open(get_irn_irg(root), suffix, buf);
2842 pset *mark_set = pset_new_ptr(1);
2843 dump_vcg_header(F, get_irg_dump_name(get_irn_irg(root)), NULL, NULL);
2844 descend_and_dump(F, root, depth, mark_set);
2851 void dump_callgraph(const char *suffix) {
2852 FILE *F = vcg_open_name("Callgraph", suffix);
2855 int i, rem = edge_label;
2858 dump_vcg_header(F, "Callgraph", "Hierarchiv", NULL);
2860 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2861 ir_graph *irg = get_irp_irg(i);
2862 ir_entity *ent = get_irg_entity(irg);
2864 int n_callees = get_irg_n_callees(irg);
2866 dump_entity_node(F, ent);
2867 for (j = 0; j < n_callees; ++j) {
2868 ir_entity *c = get_irg_entity(get_irg_callee(irg, j));
2869 //if (id_is_prefix(prefix, get_entity_ld_ident(c))) continue;
2870 int be = is_irg_callee_backedge(irg, j);
2873 "label:\"recursion %d\"" :
2874 "label:\"calls %d\"";
2875 print_ent_ent_edge(F, ent, c, be, ird_color_entity, attr, get_irg_callee_loop_depth(irg, j));
2886 /* Dump all irgs in interprocedural view to a single file. */
2887 void dump_all_cg_block_graph(const char *suffix) {
2888 FILE *f = vcg_open_name("All_graphs", suffix);
2892 int rem_view = get_interprocedural_view();
2894 set_interprocedural_view(1);
2895 dump_vcg_header(f, "All_graphs", NULL);
2897 /* collect nodes in all irgs reachable in call graph*/
2898 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2899 ird_set_irg_link(get_irp_irg(i), NULL);
2901 cg_walk(clear_link, collect_node, NULL);
2903 /* dump all graphs */
2904 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2905 current_ir_graph = get_irp_irg(i);
2906 assert(ird_get_irg_link(current_ir_graph));
2907 dump_graph_from_list(f, current_ir_graph);
2908 DEL_ARR_F(ird_get_irg_link(current_ir_graph));
2913 set_interprocedural_view(rem_view);
2918 /*---------------------------------------------------------------------*/
2919 /* the following routines dumps type information without any ir nodes. */
2920 /*---------------------------------------------------------------------*/
2923 dump_type_graph(ir_graph *irg, const char *suffix)
2927 /* if a filter is set, dump only the irg's that match the filter */
2928 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
2930 f = vcg_open(irg, suffix, "-type");
2932 ir_graph *rem = current_ir_graph;
2933 current_ir_graph = irg;
2935 dump_vcg_header(f, get_irg_dump_name(irg), "Hierarchic", NULL);
2937 /* walk over the blocks in the graph */
2938 type_walk_irg(irg, dump_type_info, NULL, f);
2939 /* The walker for the const code can be called several times for the
2940 same (sub) expression. So that no nodes are dumped several times
2941 we decrease the visited flag of the corresponding graph after each
2942 walk. So now increase it finally. */
2943 inc_irg_visited(get_const_code_irg());
2947 current_ir_graph = rem;
2952 dump_all_types(const char *suffix)
2954 FILE *f = vcg_open_name("All_types", suffix);
2956 dump_vcg_header(f, "All_types", "Hierarchic", NULL);
2957 type_walk(dump_type_info, NULL, f);
2958 inc_irg_visited(get_const_code_irg());
2966 dump_class_hierarchy(int entities, const char *suffix)
2968 FILE *f = vcg_open_name("class_hierarchy", suffix);
2973 env.dump_ent = entities;
2974 dump_vcg_header(f, "class_hierarchy", "Hierarchic", NULL);
2975 type_walk(dump_class_hierarchy_node, NULL, &env);
2982 /*---------------------------------------------------------------------*/
2983 /* dumps all graphs with the graph-dumper passed. Possible dumpers: */
2985 /* dump_ir_block_graph */
2987 /* dump_type_graph */
2988 /* dump_ir_graph_w_types */
2989 /*---------------------------------------------------------------------*/
2991 void dump_all_ir_graphs(dump_graph_func *dmp_grph, const char *suffix) {
2993 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2994 dmp_grph(get_irp_irg(i), suffix);
2998 ir_prog_pass_t pass;
2999 dump_graph_func *dump_graph;
3004 * Wrapper around dump_all_ir_graphs().
3006 static int dump_all_ir_graphs_wrapper(ir_prog *irp, void *context) {
3007 struct pass_t *pass = context;
3010 dump_all_ir_graphs(pass->dump_graph, pass->suffix);
3014 ir_prog_pass_t *dump_all_ir_graph_pass(
3015 const char *name, dump_graph_func *dump_graph, const char *suffix) {
3016 size_t len = strlen(suffix);
3017 struct pass_t *pass = xmalloc(sizeof(*pass) + len);
3018 ir_prog_pass_t *res = def_prog_pass_constructor(
3019 &pass->pass, name ? name : "dump_all_graphs", dump_all_ir_graphs_wrapper);
3021 /* this pass does not change anything, so neither dump nor verify is needed. */
3022 res->dump_irprog = ir_prog_no_dump;
3023 res->verify_irprog = ir_prog_no_verify;
3025 pass->dump_graph = dump_graph;
3026 strcpy(pass->suffix, suffix);
3031 /*--------------------------------------------------------------------------------*
3032 * Dumps a stand alone loop graph with firm nodes which belong to one loop node *
3033 * packed together in one subgraph/box *
3034 *--------------------------------------------------------------------------------*/
3036 void dump_loops_standalone(FILE *F, ir_loop *loop) {
3037 int i = 0, loop_node_started = 0, son_number = 0, first = 0;
3039 ir_loop *son = NULL;
3041 /* Dump a new loop node. */
3042 dump_loop_node(F, loop);
3044 /* Dump the loop elements. */
3045 for (i = 0; i < get_loop_n_elements(loop); i++) {
3046 le = get_loop_element(loop, i);
3048 if (get_kind(son) == k_ir_loop) {
3050 /* We are a loop son -> Recurse */
3052 if (loop_node_started) { /* Close the "firm-nodes" node first if we started one. */
3053 fprintf(F, "\" }\n");
3054 fprintf(F, "edge: {sourcename: \"");
3056 fprintf(F, "\" targetname: \"");
3058 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3059 loop_node_started = 0;
3061 dump_loop_son_edge(F, loop, son_number++);
3062 dump_loops_standalone(F, son);
3063 } else if (get_kind(son) == k_ir_node) {
3064 /* We are a loop node -> Collect firm nodes */
3066 ir_node *n = le.node;
3069 if (!loop_node_started) {
3070 /* Start a new node which contains all firm nodes of the current loop */
3071 fprintf(F, "node: { title: \"");
3073 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3074 loop_node_started = 1;
3079 bad |= dump_node_label(F, n);
3080 /* Causes indeterministic output: if (is_Block(n)) fprintf(F, "\t ->%d", (int)get_irn_link(n)); */
3081 if (has_backedges(n)) fprintf(F, "\t loop head!");
3082 } else { /* for callgraph loop tree */
3084 assert(get_kind(son) == k_ir_graph);
3086 /* We are a loop node -> Collect firm graphs */
3088 if (!loop_node_started) {
3089 /* Start a new node which contains all firm nodes of the current loop */
3090 fprintf(F, "node: { title: \"");
3092 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3093 loop_node_started = 1;
3097 fprintf(F, " %s", get_irg_dump_name(n));
3098 /* fprintf(F, " %s (depth %d)", get_irg_dump_name(n), n->callgraph_weighted_loop_depth); */
3102 if (loop_node_started) {
3103 fprintf(F, "\" }\n");
3104 fprintf(F, "edge: {sourcename: \"");
3106 fprintf(F, "\" targetname: \"");
3108 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3109 loop_node_started = 0;
3113 void dump_loop_tree(ir_graph *irg, const char *suffix)
3117 /* if a filter is set, dump only the irg's that match the filter */
3118 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
3121 f = vcg_open(irg, suffix, "-looptree");
3123 ir_graph *rem = current_ir_graph;
3124 int el_rem = edge_label;
3126 current_ir_graph = irg;
3129 dump_vcg_header(f, get_irg_dump_name(irg), "Tree", "top_to_bottom");
3131 if (get_irg_loop(irg))
3132 dump_loops_standalone(f, get_irg_loop(irg));
3137 edge_label = el_rem;
3138 current_ir_graph = rem;
3142 void dump_callgraph_loop_tree(const char *suffix) {
3144 F = vcg_open_name("Callgraph_looptree", suffix);
3145 dump_vcg_header(F, "callgraph looptree", "Tree", "top_to_bottom");
3146 dump_loops_standalone(F, irp->outermost_cg_loop);
3152 /*----------------------------------------------------------------------------*/
3153 /* Dumps the firm nodes in the loop tree to a graph along with the loop nodes.*/
3154 /*----------------------------------------------------------------------------*/
3156 void collect_nodeloop(FILE *F, ir_loop *loop, eset *loopnodes) {
3157 int i, son_number = 0, node_number = 0;
3159 if (dump_loop_information_flag) dump_loop_node(F, loop);
3161 for (i = 0; i < get_loop_n_elements(loop); i++) {
3162 loop_element le = get_loop_element(loop, i);
3163 if (*(le.kind) == k_ir_loop) {
3164 if (dump_loop_information_flag) dump_loop_son_edge(F, loop, son_number++);
3166 collect_nodeloop(F, le.son, loopnodes);
3168 if (dump_loop_information_flag) dump_loop_node_edge(F, loop, node_number++);
3169 eset_insert(loopnodes, le.node);
3174 void collect_nodeloop_external_nodes(ir_loop *loop, eset *loopnodes, eset *extnodes) {
3177 for(i = 0; i < get_loop_n_elements(loop); i++) {
3178 loop_element le = get_loop_element(loop, i);
3179 if (*(le.kind) == k_ir_loop) {
3181 collect_nodeloop_external_nodes(le.son, loopnodes, extnodes);
3183 if (is_Block(le.node)) start = 0; else start = -1;
3184 for (j = start; j < get_irn_arity(le.node); j++) {
3185 ir_node *pred = get_irn_n(le.node, j);
3186 if (!eset_contains(loopnodes, pred)) {
3187 eset_insert(extnodes, pred);
3188 if (!is_Block(pred)) {
3189 pred = get_nodes_block(pred);
3190 if (!eset_contains(loopnodes, pred)) eset_insert(extnodes, pred);
3198 void dump_loop(ir_loop *l, const char *suffix) {
3202 snprintf(name, sizeof(name), "loop_%d", get_loop_loop_nr(l));
3203 F = vcg_open_name(name, suffix);
3205 eset *loopnodes = eset_create();
3206 eset *extnodes = eset_create();
3209 dump_vcg_header(F, name, NULL, NULL);
3211 /* collect all nodes to dump */
3212 collect_nodeloop(F, l, loopnodes);
3213 collect_nodeloop_external_nodes(l, loopnodes, extnodes);
3215 /* build block lists */
3216 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes))
3217 set_irn_link(n, NULL);
3218 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes))
3219 set_irn_link(n, NULL);
3220 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes)) {
3222 b = get_nodes_block(n);
3223 set_irn_link(n, get_irn_link(b));
3227 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes)) {
3229 b = get_nodes_block(n);
3230 set_irn_link(n, get_irn_link(b));
3235 for (b = eset_first(loopnodes); b != NULL; b = eset_next(loopnodes)) {
3237 fprintf(F, "graph: { title: \"");
3239 fprintf(F, "\" label: \"");
3240 dump_node_opcode(F, b);
3241 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3242 fprintf(F, "\" status:clustered color:yellow\n");
3244 /* dump the blocks edges */
3245 dump_ir_data_edges(F, b);
3247 /* dump the nodes that go into the block */
3248 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3249 if (eset_contains(extnodes, n))
3250 overrule_nodecolor = ird_color_block_inout;
3252 overrule_nodecolor = ird_color_default_node;
3253 if (!eset_contains(extnodes, n)) dump_ir_data_edges(F, n);
3256 /* Close the vcg information for the block */
3258 dump_const_node_local(F, b);
3262 for (b = eset_first(extnodes); b != NULL; b = eset_next(extnodes)) {
3264 fprintf(F, "graph: { title: \"");
3266 fprintf(F, "\" label: \"");
3267 dump_node_opcode(F, b);
3268 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3269 fprintf(F, "\" status:clustered color:lightblue\n");
3271 /* dump the nodes that go into the block */
3272 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3273 if (!eset_contains(loopnodes, n))
3274 overrule_nodecolor = ird_color_block_inout;
3276 overrule_nodecolor = ird_color_default_node;
3277 if (eset_contains(loopnodes, n)) dump_ir_data_edges(F, n);
3280 /* Close the vcg information for the block */
3282 dump_const_node_local(F, b);
3286 eset_destroy(loopnodes);
3287 eset_destroy(extnodes);