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
36 #include "firm_common_t.h"
41 #include "irgraph_t.h"
54 #include "callgraph.h"
55 #include "irextbb_t.h"
57 #include "dbginfo_t.h"
69 /** Dump only irgs with names that start with this prefix. */
70 static ident *dump_file_filter_id = NULL;
72 #define ERROR_TXT "<ERROR>"
74 /*******************************************************************/
75 /* flags to steer output */
76 /*******************************************************************/
78 /** An option to turn off edge labels */
79 static int edge_label = 1;
80 /** An option to turn off dumping values of constant entities */
81 static int const_entities = 1;
82 /** An option to dump the keep alive edges */
83 static int dump_keepalive = 1;
84 /** An option to dump the new out edges */
85 static int dump_new_edges_flag = 0;
86 /** An option to dump ld_names instead of names. */
87 static int dump_ld_name = 1;
88 /** Compiler options to dump analysis information in dump_ir_graph */
89 static int dump_out_edge_flag = 0;
90 static int dump_loop_information_flag = 0;
91 static int dump_backedge_information_flag = 1;
92 /** An option to dump const-like nodes locally. */
93 static int dump_const_local = 1;
94 /** An option to dump the node index number. */
95 static int dump_node_idx_labels = 0;
96 /** An option to dump all graph anchors */
97 static int dump_anchors = 0;
98 /** An option to dump the macro block edges. */
99 static int dump_macro_block_edges = 0;
100 /** An option to dump block marker in the block title */
101 static int dump_block_marker = 0;
103 int dump_dominator_information_flag = 0;
104 int opt_dump_analysed_type_info = 1;
105 int opt_dump_pointer_values_to_info = 0; /* default off: for test compares!! */
107 static ird_color_t overrule_nodecolor = ird_color_default_node;
109 /** The vcg node attribute hook. */
110 static DUMP_IR_GRAPH_FUNC dump_ir_graph_hook = NULL;
111 /** The vcg node attribute hook. */
112 static DUMP_NODE_VCGATTR_FUNC dump_node_vcgattr_hook = NULL;
113 /** The vcg edge attribute hook. */
114 static DUMP_EDGE_VCGATTR_FUNC dump_edge_vcgattr_hook = NULL;
115 /** The vcg dump block edge hook */
116 static DUMP_NODE_EDGE_FUNC dump_block_edge_hook = NULL;
117 /** The vcg dump node edge hook. */
118 static DUMP_NODE_EDGE_FUNC dump_node_edge_hook = NULL;
120 /* Set the hook to be called to dump additional edges to a node. */
121 void set_dump_node_edge_hook(DUMP_NODE_EDGE_FUNC func) {
122 dump_node_edge_hook = func;
125 /* Get the additional edge dump hook. */
126 DUMP_NODE_EDGE_FUNC get_dump_node_edge_hook(void) {
127 return dump_node_edge_hook;
130 /* Set the hook to be called to dump additional edges to a block. */
131 void set_dump_block_edge_hook(DUMP_NODE_EDGE_FUNC func) {
132 dump_block_edge_hook = func;
135 /* Get the additional block edge dump hook. */
136 DUMP_NODE_EDGE_FUNC get_dump_block_edge_hook(void) {
137 return dump_node_edge_hook;
140 /* set the ir graph hook */
141 void set_dump_ir_graph_hook(DUMP_IR_GRAPH_FUNC hook) {
142 dump_ir_graph_hook = hook;
145 /* set the node attribute hook */
146 void set_dump_node_vcgattr_hook(DUMP_NODE_VCGATTR_FUNC hook) {
147 dump_node_vcgattr_hook = hook;
150 /* set the edge attribute hook */
151 void set_dump_edge_vcgattr_hook(DUMP_EDGE_VCGATTR_FUNC hook) {
152 dump_edge_vcgattr_hook = hook;
155 /** Returns 0 if dump_out_edge_flag or dump_loop_information_flag
156 * are set, else returns dump_const_local_flag.
158 static int get_opt_dump_const_local(void) {
159 if (dump_out_edge_flag || dump_loop_information_flag || (dump_new_edges_flag && edges_activated(current_ir_graph)))
161 return dump_const_local;
164 /* Set a prefix filter for output functions. */
165 void only_dump_method_with_name(ident *name) {
166 dump_file_filter_id = name;
169 /* Returns the prefix filter set with only_dump_method_with_name(). */
170 ident *get_dump_file_filter_ident(void) {
171 return dump_file_filter_id;
174 /* Returns non-zero if dump file filter is not set, or if it is a prefix of name. */
175 int is_filtered_dump_name(ident *name) {
176 if (!dump_file_filter_id) return 1;
177 return id_is_prefix(dump_file_filter_id, name);
180 /* To turn off display of edge labels. Edge labels often cause xvcg to
181 abort with a segmentation fault. */
182 void turn_off_edge_labels(void) {
186 void dump_consts_local(int flag) {
187 dump_const_local = flag;
190 void dump_node_idx_label(int flag) {
191 dump_node_idx_labels = flag;
194 void dump_constant_entity_values(int flag) {
195 const_entities = flag;
198 void dump_keepalive_edges(int flag) {
199 dump_keepalive = flag;
202 void dump_new_edges(int flag) {
203 dump_new_edges_flag = flag;
206 int get_opt_dump_keepalive_edges(void) {
207 return dump_keepalive;
210 void dump_out_edges(int flag) {
211 dump_out_edge_flag = flag;
214 void dump_dominator_information(int flag) {
215 dump_dominator_information_flag = flag;
218 void dump_loop_information(int flag) {
219 dump_loop_information_flag = flag;
222 void dump_backedge_information(int flag) {
223 dump_backedge_information_flag = flag;
226 /* Dump the information of type field specified in ana/irtypeinfo.h.
227 * If the flag is set, the type name is output in [] in the node label,
228 * else it is output as info.
230 void set_opt_dump_analysed_type_info(int flag) {
231 opt_dump_analysed_type_info = flag;
234 void dump_pointer_values_to_info(int flag) {
235 opt_dump_pointer_values_to_info = flag;
238 void dump_ld_names(int flag) {
242 void dump_all_anchors(int flag) {
246 void dump_macroblock_edges(int flag) {
247 dump_macro_block_edges = flag;
250 void dump_block_marker_in_title(int flag) {
251 dump_block_marker = flag;
254 /* -------------- some extended helper functions ----------------- */
257 * returns the name of a mode or ERROR_TXT if mode is NOT a mode object.
258 * in the later case, sets bad.
260 const char *get_mode_name_ex(ir_mode *mode, int *bad) {
262 return get_mode_name(mode);
268 * returns the name of a type or <ERROR> if mode is NOT a mode object.
269 * in the later case, sets bad
271 const char *get_type_name_ex(ir_type *tp, int *bad) {
273 return get_type_name(tp);
278 #define CUSTOM_COLOR_BASE 100
279 static const char *color_names[ird_color_count];
280 static const char *color_rgb[ird_color_count];
281 static struct obstack color_obst;
283 static void custom_color(int num, const char *rgb_def)
285 assert(num < ird_color_count);
286 obstack_printf(&color_obst, "%d", CUSTOM_COLOR_BASE + num);
287 obstack_1grow(&color_obst, '\0');
289 color_rgb[num] = rgb_def;
290 color_names[num] = obstack_finish(&color_obst);
293 static void named_color(int num, const char *name)
295 assert(num < ird_color_count);
296 color_rgb[num] = NULL;
297 color_names[num] = name;
300 static void init_colors(void)
302 static int initialized = 0;
306 obstack_init(&color_obst);
308 custom_color(ird_color_prog_background, "204 204 204");
309 custom_color(ird_color_block_background, "255 255 0");
310 custom_color(ird_color_dead_block_background, "190 150 150");
311 named_color(ird_color_block_inout, "lightblue");
312 named_color(ird_color_default_node, "white");
313 custom_color(ird_color_memory, "153 153 255");
314 custom_color(ird_color_controlflow, "255 153 153");
315 custom_color(ird_color_const, "204 255 255");
316 custom_color(ird_color_proj, "255 255 153");
317 custom_color(ird_color_uses_memory, "153 153 255");
318 custom_color(ird_color_phi, "105 255 105");
319 custom_color(ird_color_anchor, "100 100 255");
320 named_color(ird_color_error, "red");
321 custom_color(ird_color_entity, "204 204 255");
327 * Prints the VCG color to a file.
329 static void print_vcg_color(FILE *F, ird_color_t color) {
330 assert(color < ird_color_count);
331 fprintf(F, "color:%s", color_names[color]);
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, ir_type *S, 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 T to an entity E with additional info fmt, ...
354 static void print_type_ent_edge(FILE *F, ir_type *T, ir_entity *E, const char *fmt, ...)
359 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(T);
360 fprintf(F, " targetname: \""); PRINT_ENTID(E); fprintf(F, "\"");
361 vfprintf(F, fmt, ap);
367 * Prints the edge from an entity E to an entity T with additional info fmt, ...
370 static void print_ent_ent_edge(FILE *F, ir_entity *E, ir_entity *T, 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(T); 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 E to a type T with additional info fmt, ...
393 static void print_ent_type_edge(FILE *F, ir_entity *E, ir_type *T, const char *fmt, ...)
398 fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(E);
399 fprintf(F, "\" targetname: "); PRINT_TYPEID(T);
400 vfprintf(F, fmt, ap);
406 * Prints the edge from a node N to a type T with additional info fmt, ...
409 static void print_node_type_edge(FILE *F, const ir_node *N, ir_type *T, const char *fmt, ...)
414 fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(N);
415 fprintf(F, "\" targetname: "); PRINT_TYPEID(T);
416 vfprintf(F, fmt, ap);
422 * Prints the edge from a node N to an entity E with additional info fmt, ...
425 static void print_node_ent_edge(FILE *F, const ir_node *N, ir_entity *E, const char *fmt, ...)
430 fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(N);
431 fprintf(F, "\" targetname: \""); PRINT_ENTID(E);
433 vfprintf(F, fmt, ap);
439 * Prints the edge from an entity E to a node N with additional info fmt, ...
442 static void print_ent_node_edge(FILE *F, ir_entity *E, const ir_node *N, const char *fmt, ...)
447 fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(E);
448 fprintf(F, "\" targetname: \""); PRINT_NODEID(N); fprintf(F, "\"");
449 vfprintf(F, fmt, ap);
455 * Prints the edge from a type E to an enumeration item item with additional info fmt, ...
458 static void print_enum_item_edge(FILE *F, ir_type *E, int item, const char *fmt, ...)
463 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(E);
464 fprintf(F, " targetname: \""); PRINT_ITEMID(E, 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(ir_node *n) {
507 if (!irdump_link_map) return NULL;
509 if (pmap_contains(irdump_link_map, (void *)n))
510 res = pmap_get(irdump_link_map, (void *)n);
515 * Sets the private link field.
517 static void ird_set_irn_link(ir_node *n, void *x) {
518 if (!irdump_link_map)
520 pmap_insert(irdump_link_map, (void *)n, x);
524 * Gets the private link field of an irg.
526 static void *ird_get_irg_link(ir_graph *irg) {
528 if (!irdump_link_map) return NULL;
530 if (pmap_contains(irdump_link_map, (void *)irg))
531 res = pmap_get(irdump_link_map, (void *)irg);
536 * Sets the private link field of an irg.
538 static void ird_set_irg_link(ir_graph *irg, void *x) {
539 if (!irdump_link_map) init_irdump();
540 pmap_insert(irdump_link_map, (void *)irg, x);
544 * Walker, clears the private link field.
546 static void clear_link(ir_node * node, void * env) {
548 ird_set_irn_link(node, NULL);
552 * If the entity has a ld_name, returns it if the dump_ld_name is set,
553 * else returns the name of the entity.
555 static const char *_get_ent_dump_name(ir_entity *ent, int dump_ld_name) {
557 return "<NULL entity>";
559 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
560 if (ent->ld_name) return get_id_str(ent->ld_name);
562 return get_id_str(ent->name);
566 * If the entity has a ld_name, returns it if the option dump_ld_name is set,
567 * else returns the name of the entity.
569 const char *get_ent_dump_name(ir_entity *ent) {
570 return _get_ent_dump_name(ent, dump_ld_name);
573 /* Returns the name of an IRG. */
574 const char *get_irg_dump_name(ir_graph *irg) {
575 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
576 return _get_ent_dump_name(get_irg_entity(irg), 1);
580 * Returns non-zero if a node is in floating state.
582 static int node_floats(ir_node *n) {
583 return ((get_irn_pinned(n) == op_pin_state_floats) &&
584 (get_irg_pinned(current_ir_graph) == op_pin_state_floats));
588 * Walker that visits the anchors
590 static void ird_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env) {
591 if (dump_anchors || (dump_new_edges_flag && edges_activated(irg))) {
592 irg_walk_anchors(irg, pre, post, env);
594 irg_walk_graph(irg, pre, post, env);
599 * Walker, allocates an array for all blocks and puts it's nodes non-floating nodes into this array.
601 static void collect_node(ir_node * node, void *env) {
605 || (get_op_flags(get_irn_op(node)) & irop_flag_dump_noblock)) {
606 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
607 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
608 ARR_APP1(ir_node *, arr, node);
609 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
611 ir_node * block = get_nodes_block(node);
614 /* this node is in a Bad block, so we must place it into the graph's list */
615 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
616 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
617 ARR_APP1(ir_node *, arr, node);
618 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
620 ird_set_irn_link(node, ird_get_irn_link(block));
621 ird_set_irn_link(block, node);
626 /** Construct lists to walk ir block-wise.
628 * Collects all blocks, nodes not op_pin_state_pinned,
629 * Bad, NoMem and Unknown into a flexible array in link field of
630 * irg they belong to. Sets the irg link field to NULL in all
631 * graphs not visited.
632 * Free the list with DEL_ARR_F().
634 static ir_node **construct_block_lists(ir_graph *irg) {
636 #ifdef INTERPROCEDURAL_VIEW
637 int rem_view = get_interprocedural_view();
639 int walk_flag = ir_resources_reserved(irg) & IR_RESOURCE_IRN_VISITED;
640 ir_graph *rem = current_ir_graph;
642 current_ir_graph = irg;
645 ir_free_resources(irg, IR_RESOURCE_IRN_VISITED);
648 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
649 ird_set_irg_link(get_irp_irg(i), NULL);
651 ird_walk_graph(current_ir_graph, clear_link, collect_node, current_ir_graph);
653 #ifdef INTERPROCEDURAL_VIEW
654 /* Collect also EndReg and EndExcept. We do not want to change the walker. */
655 set_interprocedural_view(0);
658 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
659 irg_walk(get_irg_end_reg(current_ir_graph), clear_link, collect_node, current_ir_graph);
660 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
661 irg_walk(get_irg_end_except(current_ir_graph), clear_link, collect_node, current_ir_graph);
663 #ifdef INTERPROCEDURAL_VIEW
664 set_interprocedural_view(rem_view);
668 ir_reserve_resources(irg, IR_RESOURCE_IRN_VISITED);
671 current_ir_graph = rem;
672 return ird_get_irg_link(irg);
675 typedef struct _list_tuple {
677 ir_extblk **extbb_list;
680 /** Construct lists to walk IR extended block-wise.
681 * Free the lists in the tuple with DEL_ARR_F().
682 * Sets the irg link field to NULL in all
683 * graphs not visited.
685 static list_tuple *construct_extblock_lists(ir_graph *irg) {
686 ir_node **blk_list = construct_block_lists(irg);
688 ir_graph *rem = current_ir_graph;
689 list_tuple *lists = XMALLOC(list_tuple);
691 current_ir_graph = irg;
693 lists->blk_list = NEW_ARR_F(ir_node *, 0);
694 lists->extbb_list = NEW_ARR_F(ir_extblk *, 0);
696 inc_irg_block_visited(irg);
697 for (i = ARR_LEN(blk_list) - 1; i >= 0; --i) {
700 if (is_Block(blk_list[i])) {
701 ext = get_Block_extbb(blk_list[i]);
703 if (extbb_not_visited(ext)) {
704 ARR_APP1(ir_extblk *, lists->extbb_list, ext);
705 mark_extbb_visited(ext);
708 ARR_APP1(ir_node *, lists->blk_list, blk_list[i]);
712 current_ir_graph = rem;
713 ird_set_irg_link(irg, lists);
717 /*-----------------------------------------------------------------*/
718 /* Routines to dump information about a single ir node. */
719 /*-----------------------------------------------------------------*/
722 * dump the name of a node n to the File F.
724 int dump_node_opcode(FILE *F, ir_node *n)
727 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
729 /* call the dump_node operation if available */
731 return ops->dump_node(n, F, dump_node_opcode_txt);
733 /* implementation for default nodes */
734 switch (get_irn_opcode(n)) {
736 switch (get_SymConst_kind(n)) {
737 case symconst_addr_name:
738 /* don't use get_SymConst_ptr_info as it mangles the name. */
739 fprintf(F, "SymC %s", get_id_str(get_SymConst_name(n)));
741 case symconst_addr_ent:
742 fprintf(F, "SymC &%s", get_entity_name(get_SymConst_entity(n)));
744 case symconst_ofs_ent:
745 fprintf(F, "SymC %s offset", get_entity_name(get_SymConst_entity(n)));
747 case symconst_type_tag:
748 fprintf(F, "SymC %s tag", get_type_name_ex(get_SymConst_type(n), &bad));
750 case symconst_type_size:
751 fprintf(F, "SymC %s size", get_type_name_ex(get_SymConst_type(n), &bad));
753 case symconst_type_align:
754 fprintf(F, "SymC %s align", get_type_name_ex(get_SymConst_type(n), &bad));
756 case symconst_enum_const:
757 fprintf(F, "SymC %s enum", get_enumeration_name(get_SymConst_enum(n)));
760 fprintf(F, "SymC %lu label", get_SymConst_label(n));
766 if (!get_interprocedural_view())
773 ir_node *pred = get_Proj_pred(n);
775 if (get_irn_opcode(pred) == iro_Cond
776 && get_Proj_proj(n) == get_Cond_defaultProj(pred)
777 && get_irn_mode(get_Cond_selector(pred)) != mode_b)
778 fprintf(F, "defProj");
786 if (get_interprocedural_view()) {
787 fprintf(F, "%s %s", get_irn_opname(n), get_ent_dump_name(get_irg_entity(get_irn_irg(n))));
792 case iro_CallBegin: {
793 ir_node *addr = get_CallBegin_ptr(n);
794 ir_entity *ent = NULL;
796 ent = get_Sel_entity(addr);
797 else if (is_Global(addr))
798 ent = get_Global_entity(addr);
799 fprintf(F, "%s", get_irn_opname(n));
800 if (ent) fprintf(F, " %s", get_entity_name(ent));
804 if (get_Load_align(n) == align_non_aligned)
806 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Load_mode(n), &bad));
809 if (get_Store_align(n) == align_non_aligned)
811 fprintf(F, "%s", get_irn_opname(n));
815 is_Block_dead(n) ? "Dead " : "", get_irn_opname(n),
816 dump_block_marker ? (get_Block_mark(n) ? "*" : "") : "");
819 if (get_Conv_strict(n))
820 fprintf(F, "strict");
821 fprintf(F, "%s", get_irn_opname(n));
824 fprintf(F, "%s", get_irn_opname(n));
825 if (is_Div_remainderless(n))
827 fprintf(F, "[%s]", get_mode_name_ex(get_Div_resmode(n), &bad));
830 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Mod_resmode(n), &bad));
833 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_DivMod_resmode(n), &bad));
838 fprintf(F, "%s", get_irn_opname(n));
845 * Dump the mode of a node n to a file F.
846 * Ignore modes that are "always known".
848 static int dump_node_mode(FILE *F, ir_node *n)
851 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
854 /* call the dump_node operation if available */
856 return ops->dump_node(n, F, dump_node_mode_txt);
858 /* default implementation */
859 iro = get_irn_opcode(n);
871 ir_mode *mode = get_irn_mode(n);
873 if (mode && mode != mode_BB && mode != mode_ANY && mode != mode_BAD &&
874 (mode != mode_T || iro == iro_Proj))
875 fprintf(F, "%s", get_mode_name_ex(mode, &bad));
883 * Dump the type of a node n to a file F if it's known.
885 static int dump_node_typeinfo(FILE *F, ir_node *n) {
888 if (opt_dump_analysed_type_info) {
889 if (get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_consistent ||
890 get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_inconsistent) {
891 ir_type *tp = get_irn_typeinfo_type(n);
892 if (tp != firm_none_type)
893 fprintf(F, "[%s] ", get_type_name_ex(tp, &bad));
901 typedef struct _pns_lookup {
902 long nr; /**< the proj number */
903 const char *name; /**< the name of the Proj */
906 typedef struct _proj_lookup {
907 ir_opcode code; /**< the opcode of the Proj predecessor */
908 unsigned num_data; /**< number of data entries */
909 const pns_lookup_t *data; /**< the data */
912 #define ARR_SIZE(a) (sizeof(a)/sizeof(a[0]))
914 /** the lookup table for Proj(Start) names */
915 static const pns_lookup_t start_lut[] = {
916 #define X(a) { pn_Start_##a, #a }
925 /** the lookup table for Proj(Cond) names */
926 static const pns_lookup_t cond_lut[] = {
927 #define X(a) { pn_Cond_##a, #a }
933 /** the lookup table for Proj(Call) names */
934 static const pns_lookup_t call_lut[] = {
935 #define X(a) { pn_Call_##a, #a }
945 /** the lookup table for Proj(Quot) names */
946 static const pns_lookup_t quot_lut[] = {
947 #define X(a) { pn_Quot_##a, #a }
955 /** the lookup table for Proj(DivMod) names */
956 static const pns_lookup_t divmod_lut[] = {
957 #define X(a) { pn_DivMod_##a, #a }
966 /** the lookup table for Proj(Div) names */
967 static const pns_lookup_t div_lut[] = {
968 #define X(a) { pn_Div_##a, #a }
976 /** the lookup table for Proj(Mod) names */
977 static const pns_lookup_t mod_lut[] = {
978 #define X(a) { pn_Mod_##a, #a }
986 /** the lookup table for Proj(Load) names */
987 static const pns_lookup_t load_lut[] = {
988 #define X(a) { pn_Load_##a, #a }
996 /** the lookup table for Proj(Store) names */
997 static const pns_lookup_t store_lut[] = {
998 #define X(a) { pn_Store_##a, #a }
1005 /** the lookup table for Proj(Alloc) names */
1006 static const pns_lookup_t alloc_lut[] = {
1007 #define X(a) { pn_Alloc_##a, #a }
1015 /** the lookup table for Proj(CopyB) names */
1016 static const pns_lookup_t copyb_lut[] = {
1017 #define X(a) { pn_CopyB_##a, #a }
1025 /** the lookup table for Proj(InstOf) names */
1026 static const pns_lookup_t instof_lut[] = {
1027 #define X(a) { pn_InstOf_##a, #a }
1036 /** the lookup table for Proj(Raise) names */
1037 static const pns_lookup_t raise_lut[] = {
1038 #define X(a) { pn_Raise_##a, #a }
1044 /** the lookup table for Proj(Bound) names */
1045 static const pns_lookup_t bound_lut[] = {
1046 #define X(a) { pn_Bound_##a, #a }
1054 /** the Proj lookup table */
1055 static const proj_lookup_t proj_lut[] = {
1056 #define E(a) ARR_SIZE(a), a
1057 { iro_Start, E(start_lut) },
1058 { iro_Cond, E(cond_lut) },
1059 { iro_Call, E(call_lut) },
1060 { iro_Quot, E(quot_lut) },
1061 { iro_DivMod, E(divmod_lut) },
1062 { iro_Div, E(div_lut) },
1063 { iro_Mod, E(mod_lut) },
1064 { iro_Load, E(load_lut) },
1065 { iro_Store, E(store_lut) },
1066 { iro_Alloc, E(alloc_lut) },
1067 { iro_CopyB, E(copyb_lut) },
1068 { iro_InstOf, E(instof_lut) },
1069 { iro_Raise, E(raise_lut) },
1070 { iro_Bound, E(bound_lut) }
1075 * Dump additional node attributes of some nodes to a file F.
1078 dump_node_nodeattr(FILE *F, ir_node *n)
1084 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1086 /* call the dump_node operation if available */
1088 return ops->dump_node(n, F, dump_node_nodeattr_txt);
1090 switch (get_irn_opcode(n)) {
1092 if (0 && get_interprocedural_view()) {
1093 fprintf(F, "%s ", get_ent_dump_name(get_irg_entity(current_ir_graph)));
1098 ir_fprintf(F, "%T ", get_Const_tarval(n));
1102 pred = get_Proj_pred(n);
1103 proj_nr = get_Proj_proj(n);
1105 code = get_irn_opcode(pred);
1107 if (code == iro_Cmp)
1108 fprintf(F, "%s ", get_pnc_string(get_Proj_proj(n)));
1109 else if (code == iro_Proj && get_irn_opcode(get_Proj_pred(pred)) == iro_Start)
1110 fprintf(F, "Arg %ld ", proj_nr);
1111 else if (code == iro_Cond && get_irn_mode(get_Cond_selector(pred)) != mode_b)
1112 fprintf(F, "%ld ", proj_nr);
1114 unsigned i, j, f = 0;
1116 for (i = 0; i < ARR_SIZE(proj_lut); ++i) {
1117 if (code == proj_lut[i].code) {
1118 for (j = 0; j < proj_lut[i].num_data; ++j) {
1119 if (proj_nr == proj_lut[i].data[j].nr) {
1120 fprintf(F, "%s ", proj_lut[i].data[j].name);
1129 fprintf(F, "%ld ", proj_nr);
1130 if (code == iro_Cond && get_Cond_jmp_pred(pred) != COND_JMP_PRED_NONE) {
1131 if (proj_nr == pn_Cond_false && get_Cond_jmp_pred(pred) == COND_JMP_PRED_FALSE)
1132 fprintf(F, "PRED ");
1133 if (proj_nr == pn_Cond_true && get_Cond_jmp_pred(pred) == COND_JMP_PRED_TRUE)
1134 fprintf(F, "PRED ");
1139 proj_nr = get_Filter_proj(n);
1140 if (! get_interprocedural_view()) {
1142 pred = get_Filter_pred(n);
1145 fprintf(F, "%ld ", proj_nr);
1148 fprintf(F, "%s ", get_ent_dump_name(get_Sel_entity(n)));
1151 fprintf(F, "(%s) ", get_type_name_ex(get_Cast_type(n), &bad));
1154 fprintf(F, "%s ", get_pnc_string(get_Confirm_cmp(n)));
1157 fprintf(F, "(%s) ", get_type_name_ex(get_CopyB_type(n), &bad));
1168 #include "execution_frequency.h"
1170 static void dump_node_ana_vals(FILE *F, ir_node *n) {
1174 #ifdef INTERPROCEDURAL_VIEW
1175 fprintf(F, " %lf*(%2.0lf + %2.0lf) = %2.0lf ",
1176 get_irn_exec_freq(n),
1177 get_irg_method_execution_frequency(get_irn_irg(n)),
1178 pow(5, get_irg_recursion_depth(get_irn_irg(n))),
1179 get_irn_exec_freq(n) * (get_irg_method_execution_frequency(get_irn_irg(n)) + pow(5, get_irg_recursion_depth(get_irn_irg(n))))
1185 /* Dumps a node label without the enclosing ". */
1186 int dump_node_label(FILE *F, ir_node *n) {
1189 bad |= dump_node_opcode(F, n);
1190 bad |= dump_node_mode(F, n);
1192 bad |= dump_node_typeinfo(F, n);
1193 bad |= dump_node_nodeattr(F, n);
1194 if(dump_node_idx_labels) {
1195 fprintf(F, "%ld:%d", get_irn_node_nr(n), get_irn_idx(n));
1197 fprintf(F, "%ld", get_irn_node_nr(n));
1204 * Dumps the attributes of a node n into the file F.
1205 * Currently this is only the color of a node.
1207 static void dump_node_vcgattr(FILE *F, ir_node *node, ir_node *local, int bad)
1213 print_vcg_color(F, ird_color_error);
1217 if (dump_node_vcgattr_hook)
1218 if (dump_node_vcgattr_hook(F, node, local))
1221 n = local ? local : node;
1223 if (overrule_nodecolor != ird_color_default_node) {
1224 print_vcg_color(F, overrule_nodecolor);
1228 mode = get_irn_mode(n);
1229 if(mode == mode_M) {
1230 print_vcg_color(F, ird_color_memory);
1233 if(mode == mode_X) {
1234 print_vcg_color(F, ird_color_controlflow);
1238 switch (get_irn_opcode(n)) {
1243 print_vcg_color(F, ird_color_anchor);
1246 print_vcg_color(F, ird_color_error);
1249 if (is_Block_dead(n))
1250 print_vcg_color(F, ird_color_dead_block_background);
1252 print_vcg_color(F, ird_color_block_background);
1255 print_vcg_color(F, ird_color_phi);
1258 print_vcg_color(F, ird_color_memory);
1262 print_vcg_color(F, ird_color_const);
1265 print_vcg_color(F, ird_color_proj);
1268 ir_op *op = get_irn_op(node);
1270 if(is_op_constlike(op)) {
1271 print_vcg_color(F, ird_color_const);
1272 } else if(is_op_uses_memory(op)) {
1273 print_vcg_color(F, ird_color_uses_memory);
1274 } else if(is_op_cfopcode(op) || is_op_forking(op)) {
1275 print_vcg_color(F, ird_color_controlflow);
1277 PRINT_DEFAULT_NODE_ATTR;
1283 /* Adds a new node info dumper callback. */
1284 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data)
1286 hook_entry_t *info = XMALLOC(hook_entry_t);
1288 info->hook._hook_node_info = cb;
1289 info->context = data;
1290 register_hook(hook_node_info, info);
1295 /* Remove a previously added info dumper callback. */
1296 void dump_remv_node_info_callback(void *handle)
1298 hook_entry_t *info = handle;
1299 unregister_hook(hook_node_info, info);
1304 * Dump the node information of a node n to a file F.
1306 static inline int dump_node_info(FILE *F, ir_node *n)
1309 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1311 fprintf(F, " info1: \"");
1312 bad = dump_irnode_to_file(F, n);
1313 /* call the dump_node operation if available */
1315 bad = ops->dump_node(n, F, dump_node_info_txt);
1317 /* allow additional info to be added */
1318 hook_node_info(F, n);
1324 static inline int is_constlike_node(const ir_node *node)
1326 const ir_op *op = get_irn_op(node);
1327 return is_op_constlike(op);
1331 /** outputs the predecessors of n, that are constants, local. I.e.,
1332 generates a copy of the constant predecessors for each node called with. */
1333 static void dump_const_node_local(FILE *F, ir_node *n) {
1335 if (!get_opt_dump_const_local()) return;
1337 /* Use visited flag to avoid outputting nodes twice.
1338 initialize it first. */
1339 for (i = 0; i < get_irn_arity(n); i++) {
1340 ir_node *con = get_irn_n(n, i);
1341 if (is_constlike_node(con)) {
1342 set_irn_visited(con, get_irg_visited(current_ir_graph) - 1);
1346 for (i = 0; i < get_irn_arity(n); i++) {
1347 ir_node *con = get_irn_n(n, i);
1348 if (is_constlike_node(con) && !irn_visited(con)) {
1351 mark_irn_visited(con);
1352 /* Generate a new name for the node by appending the names of
1354 fprintf(F, "node: {title: "); PRINT_CONSTID(n, con);
1355 fprintf(F, " label: \"");
1356 bad |= dump_node_label(F, con);
1358 bad |= dump_node_info(F, con);
1359 dump_node_vcgattr(F, n, con, bad);
1365 /** If the block of an edge is a const_like node, dump it local with an edge */
1366 static void dump_const_block_local(FILE *F, ir_node *n) {
1369 if (!get_opt_dump_const_local()) return;
1371 blk = get_nodes_block(n);
1372 if (is_constlike_node(blk)) {
1375 /* Generate a new name for the node by appending the names of
1377 fprintf(F, "node: {title: \""); PRINT_CONSTBLKID(n, blk);
1378 fprintf(F, "\" label: \"");
1379 bad |= dump_node_label(F, blk);
1381 bad |= dump_node_info(F, blk);
1382 dump_node_vcgattr(F, n, blk, bad);
1385 fprintf(F, "edge: { sourcename: \"");
1387 fprintf(F, "\" targetname: \""); PRINT_CONSTBLKID(n,blk);
1389 if (dump_edge_vcgattr_hook) {
1391 if (dump_edge_vcgattr_hook(F, n, -1)) {
1395 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1400 fprintf(F, "\" " BLOCK_EDGE_ATTR "}\n");
1405 * prints the error message of a node to a file F as info2.
1407 static void print_node_error(FILE *F, const char *err_msg)
1412 fprintf(F, " info2: \"%s\"", err_msg);
1416 * prints debug messages of a node to file F as info3.
1418 static void print_dbg_info(FILE *F, dbg_info *dbg)
1422 if (__dbg_info_snprint) {
1424 if (__dbg_info_snprint(buf, sizeof(buf), dbg) > 0)
1425 fprintf(F, " info3: \"%s\"\n", buf);
1432 static void dump_node(FILE *F, ir_node *n)
1437 if (get_opt_dump_const_local() && is_constlike_node(n))
1440 /* dump this node */
1441 fputs("node: {title: \"", F);
1445 fputs(" label: \"", F);
1446 bad = ! irn_vrfy_irg_dump(n, current_ir_graph, &p);
1447 bad |= dump_node_label(F, n);
1448 dump_node_ana_vals(F, n);
1449 //dump_node_ana_info(F, n);
1452 if (get_op_flags(get_irn_op(n)) & irop_flag_dump_noinput) {
1453 //fputs(" node_class:23", F);
1456 bad |= dump_node_info(F, n);
1457 print_node_error(F, p);
1458 print_dbg_info(F, get_irn_dbg_info(n));
1459 dump_node_vcgattr(F, n, NULL, bad);
1461 dump_const_node_local(F, n);
1463 if(dump_node_edge_hook)
1464 dump_node_edge_hook(F, n);
1467 /** dump the edge to the block this node belongs to */
1469 dump_ir_block_edge(FILE *F, ir_node *n) {
1470 if (get_opt_dump_const_local() && is_constlike_node(n)) return;
1471 if (is_no_Block(n)) {
1472 ir_node *block = get_nodes_block(n);
1474 if (get_opt_dump_const_local() && is_constlike_node(block)) {
1475 dump_const_block_local(F, n);
1477 fprintf(F, "edge: { sourcename: \"");
1479 fprintf(F, "\" targetname: ");
1480 fprintf(F, "\""); PRINT_NODEID(block); fprintf(F, "\"");
1482 if (dump_edge_vcgattr_hook) {
1484 if (dump_edge_vcgattr_hook(F, n, -1)) {
1488 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1493 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1499 print_data_edge_vcgattr(FILE *F, ir_node *from, int to) {
1501 * do not use get_nodes_block() here, will fail
1502 * if the irg is not pinned.
1504 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1505 fprintf(F, INTRA_DATA_EDGE_ATTR);
1507 fprintf(F, INTER_DATA_EDGE_ATTR);
1511 print_mem_edge_vcgattr(FILE *F, ir_node *from, int to) {
1513 * do not use get_nodes_block() here, will fail
1514 * if the irg is not pinned.
1516 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1517 fprintf(F, INTRA_MEM_EDGE_ATTR);
1519 fprintf(F, INTER_MEM_EDGE_ATTR);
1522 /** Print the vcg attributes for the edge from node from to it's to's input */
1523 static void print_edge_vcgattr(FILE *F, ir_node *from, int to) {
1526 if (dump_edge_vcgattr_hook)
1527 if (dump_edge_vcgattr_hook(F, from, to))
1530 if (dump_backedge_information_flag && is_backedge(from, to))
1531 fprintf(F, BACK_EDGE_ATTR);
1533 switch (get_irn_opcode(from)) {
1535 fprintf(F, CF_EDGE_ATTR);
1537 case iro_Start: break;
1540 if (get_irn_mode(get_End_keepalive(from, to)) == mode_BB)
1541 fprintf(F, KEEP_ALIVE_CF_EDGE_ATTR);
1543 fprintf(F, KEEP_ALIVE_DF_EDGE_ATTR);
1547 if (is_Proj(from)) {
1548 if (get_irn_mode(from) == mode_M)
1549 print_mem_edge_vcgattr(F, from, to);
1550 else if (get_irn_mode(from) == mode_X)
1551 fprintf(F, CF_EDGE_ATTR);
1553 print_data_edge_vcgattr(F, from, to);
1555 else if (get_irn_mode(get_irn_n(from, to)) == mode_M)
1556 print_mem_edge_vcgattr(F, from, to);
1557 else if (get_irn_mode(get_irn_n(from, to)) == mode_X)
1558 fprintf(F, CF_EDGE_ATTR);
1560 print_data_edge_vcgattr(F, from, to);
1564 /** dump edges to our inputs */
1565 static void dump_ir_data_edges(FILE *F, ir_node *n) {
1567 ir_visited_t visited = get_irn_visited(n);
1569 if (!dump_keepalive && is_End(n)) {
1570 /* the End node has only keep-alive edges */
1574 /* dump the dependency edges. */
1575 num = get_irn_deps(n);
1576 for (i = 0; i < num; ++i) {
1577 ir_node *dep = get_irn_dep(n, i);
1580 fprintf(F, "edge: {sourcename: \"");
1582 fprintf(F, "\" targetname: ");
1583 if ((get_opt_dump_const_local()) && is_constlike_node(dep)) {
1584 PRINT_CONSTID(n, dep);
1590 fprintf(F, " label: \"%d\" ", i);
1591 fprintf(F, " color: darkgreen}\n");
1595 num = get_irn_arity(n);
1596 for (i = 0; i < num; i++) {
1597 ir_node *pred = get_irn_n(n, i);
1600 if ((get_interprocedural_view() && get_irn_visited(pred) < visited))
1601 continue; /* pred not dumped */
1603 if (dump_backedge_information_flag && is_backedge(n, i))
1604 fprintf(F, "backedge: {sourcename: \"");
1606 fprintf(F, "edge: {sourcename: \"");
1608 fprintf(F, "\" targetname: ");
1609 if ((get_opt_dump_const_local()) && is_constlike_node(pred)) {
1610 PRINT_CONSTID(n, pred);
1612 fprintf(F, "\""); PRINT_NODEID(pred); fprintf(F, "\"");
1614 fprintf(F, " label: \"%d\" ", i);
1615 print_edge_vcgattr(F, n, i);
1619 if (dump_macro_block_edges && is_Block(n)) {
1620 ir_node *mb = get_Block_MacroBlock(n);
1621 fprintf(F, "edge: {sourcename: \"");
1623 fprintf(F, "\" targetname: \"");
1625 fprintf(F, "\" label: \"mb\" " MACROBLOCK_EDGE_ATTR);
1634 dump_ir_edges(FILE *F, ir_node *n) {
1635 const ir_edge_t *edge;
1638 foreach_out_edge(n, edge) {
1639 ir_node *succ = get_edge_src_irn(edge);
1641 fprintf(F, "edge: {sourcename: \"");
1643 fprintf(F, "\" targetname: \"");
1647 fprintf(F, " label: \"%d\" ", i);
1648 fprintf(F, OUT_EDGE_ATTR);
1655 /** Dumps a node and its edges but not the block edge */
1656 static void dump_node_wo_blockedge(ir_node *n, void *env) {
1659 dump_ir_data_edges(F, n);
1662 /** Dumps a node and its edges. */
1663 static void dump_whole_node(ir_node *n, void *env) {
1665 dump_node_wo_blockedge(n, env);
1666 if (!node_floats(n))
1667 dump_ir_block_edge(F, n);
1668 if (dump_new_edges_flag && edges_activated(current_ir_graph))
1669 dump_ir_edges(F, n);
1672 /** Dumps a const-like node. */
1673 static void dump_const_node(ir_node *n, void *env) {
1674 if (is_Block(n)) return;
1675 dump_node_wo_blockedge(n, env);
1678 /***********************************************************************/
1679 /* the following routines dump the nodes/irgs bracketed to graphs. */
1680 /***********************************************************************/
1682 /** Dumps a constant expression as entity initializer, array bound ...
1684 static void dump_const_expression(FILE *F, ir_node *value) {
1685 ir_graph *rem = current_ir_graph;
1686 int rem_dump_const_local = dump_const_local;
1687 dump_const_local = 0;
1688 current_ir_graph = get_const_code_irg();
1689 irg_walk(value, dump_const_node, NULL, F);
1690 /* Decrease visited flag so that we walk with the same flag for the next
1691 expression. This guarantees that we don't dump the same node twice,
1692 as for const expressions cse is performed to save memory. */
1693 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph) -1);
1694 current_ir_graph = rem;
1695 dump_const_local = rem_dump_const_local;
1698 /** Dump a block as graph containing its nodes.
1700 * Expects to find nodes belonging to the block as list in its
1702 * Dumps the edges of all nodes including itself. */
1703 static void dump_whole_block(FILE *F, ir_node *block) {
1705 ird_color_t color = ird_color_block_background;
1707 assert(is_Block(block));
1709 fprintf(F, "graph: { title: \"");
1710 PRINT_NODEID(block);
1711 fprintf(F, "\" label: \"");
1712 dump_node_label(F, block);
1714 /* colorize blocks */
1715 if (! get_Block_matured(block))
1716 color = ird_color_block_background;
1717 if (is_Block_dead(block))
1718 color = ird_color_dead_block_background;
1720 fprintf(F, "\" status:clustered ");
1721 print_vcg_color(F, color);
1724 /* yComp can show attributes for blocks, XVCG parses but ignores them */
1725 dump_node_info(F, block);
1726 print_dbg_info(F, get_irn_dbg_info(block));
1728 /* dump the blocks edges */
1729 dump_ir_data_edges(F, block);
1731 if (dump_block_edge_hook)
1732 dump_block_edge_hook(F, block);
1734 /* dump the nodes that go into the block */
1735 for (node = ird_get_irn_link(block); node; node = ird_get_irn_link(node)) {
1737 dump_ir_data_edges(F, node);
1740 /* Close the vcg information for the block */
1742 dump_const_node_local(F, block);
1746 /** dumps a graph block-wise. Expects all blockless nodes in arr in irgs link.
1747 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1749 dump_block_graph(FILE *F, ir_graph *irg) {
1751 ir_graph *rem = current_ir_graph;
1752 ir_node **arr = ird_get_irg_link(irg);
1753 current_ir_graph = irg;
1755 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1756 ir_node * node = arr[i];
1757 if (is_Block(node)) {
1758 /* Dumps the block and all the nodes in the block, which are to
1759 be found in Block->link. */
1760 dump_whole_block(F, node);
1762 /* Nodes that are not in a Block. */
1764 if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
1765 dump_const_block_local(F, node);
1767 dump_ir_data_edges(F, node);
1769 if (dump_new_edges_flag && edges_activated(irg))
1770 dump_ir_edges(F, node);
1773 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1774 dump_loop_nodes_into_graph(F, irg);
1776 current_ir_graph = rem;
1780 * Dump the info for an irg.
1781 * Parsed by XVCG but not shown. use yComp.
1783 static void dump_graph_info(FILE *F, ir_graph *irg) {
1784 fprintf(F, "info1: \"");
1785 dump_entity_to_file(F, get_irg_entity(irg), dump_verbosity_entattrs | dump_verbosity_entconsts);
1789 /** Dumps an irg as a graph clustered by block nodes.
1790 * If interprocedural view edges can point to nodes out of this graph.
1792 static void dump_graph_from_list(FILE *F, ir_graph *irg) {
1793 ir_entity *ent = get_irg_entity(irg);
1795 fprintf(F, "graph: { title: \"");
1797 fprintf(F, "\" label: \"%s\" status:clustered color:%s \n",
1798 get_ent_dump_name(ent), color_names[ird_color_prog_background]);
1800 dump_graph_info(F, irg);
1801 print_dbg_info(F, get_entity_dbg_info(ent));
1803 dump_block_graph(F, irg);
1805 /* Close the vcg information for the irg */
1806 fprintf(F, "}\n\n");
1809 /** dumps a graph extended block-wise. Expects all blockless nodes in arr in irgs link.
1810 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1812 dump_extblock_graph(FILE *F, ir_graph *irg) {
1814 ir_graph *rem = current_ir_graph;
1815 ir_extblk **arr = ird_get_irg_link(irg);
1816 current_ir_graph = irg;
1818 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1819 ir_extblk *extbb = arr[i];
1820 ir_node *leader = get_extbb_leader(extbb);
1823 fprintf(F, "graph: { title: \"");
1824 PRINT_EXTBBID(leader);
1825 fprintf(F, "\" label: \"ExtBB %ld\" status:clustered color:lightgreen\n",
1826 get_irn_node_nr(leader));
1828 for (j = ARR_LEN(extbb->blks) - 1; j >= 0; --j) {
1829 ir_node * node = extbb->blks[j];
1830 if (is_Block(node)) {
1831 /* Dumps the block and all the nodes in the block, which are to
1832 be found in Block->link. */
1833 dump_whole_block(F, node);
1835 /* Nodes that are not in a Block. */
1837 if (is_Bad(get_nodes_block(node)) && !node_floats(node)) {
1838 dump_const_block_local(F, node);
1840 dump_ir_data_edges(F, node);
1846 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1847 dump_loop_nodes_into_graph(F, irg);
1849 current_ir_graph = rem;
1854 /*******************************************************************/
1855 /* Basic type and entity nodes and edges. */
1856 /*******************************************************************/
1858 /** dumps the edges between nodes and their type or entity attributes. */
1859 static void dump_node2type_edges(ir_node *n, void *env)
1864 switch (get_irn_opcode(n)) {
1866 /* @@@ some consts have an entity */
1869 if (SYMCONST_HAS_TYPE(get_SymConst_kind(n)))
1870 print_node_type_edge(F,n,get_SymConst_type(n),NODE2TYPE_EDGE_ATTR);
1873 print_node_ent_edge(F,n,get_Sel_entity(n),NODE2TYPE_EDGE_ATTR);
1876 print_node_type_edge(F,n,get_Call_type(n),NODE2TYPE_EDGE_ATTR);
1879 print_node_type_edge(F,n,get_Alloc_type(n),NODE2TYPE_EDGE_ATTR);
1882 print_node_type_edge(F,n,get_Free_type(n),NODE2TYPE_EDGE_ATTR);
1885 print_node_type_edge(F,n,get_Cast_type(n),NODE2TYPE_EDGE_ATTR);
1893 static int print_type_info(FILE *F, ir_type *tp) {
1896 if (get_type_state(tp) == layout_undefined) {
1897 fprintf(F, "state: layout_undefined\n");
1899 fprintf(F, "state: layout_fixed,\n");
1901 if (get_type_mode(tp))
1902 fprintf(F, "mode: %s,\n", get_mode_name_ex(get_type_mode(tp), &bad));
1903 fprintf(F, "size: %db,\n", get_type_size_bits(tp));
1908 static void print_typespecific_info(FILE *F, ir_type *tp) {
1909 switch (get_type_tpop_code(tp)) {
1911 fprintf(F, "peculiarity: %s\n", get_peculiarity_string(get_class_peculiarity(tp)));
1916 fprintf(F, "variadicity: %s\n", get_variadicity_name(get_method_variadicity(tp)));
1917 fprintf(F, "params: %d\n", get_method_n_params(tp));
1918 fprintf(F, "results: %d\n", get_method_n_ress(tp));
1924 case tpo_enumeration:
1936 static void print_typespecific_vcgattr(FILE *F, ir_type *tp) {
1937 switch (get_type_tpop_code(tp)) {
1939 if (peculiarity_existent == get_class_peculiarity(tp))
1940 fprintf(F, " " TYPE_CLASS_NODE_ATTR);
1942 fprintf(F, " " TYPE_DESCRIPTION_NODE_ATTR);
1945 fprintf(F, " " TYPE_METH_NODE_ATTR);
1953 case tpo_enumeration:
1965 int dump_type_node(FILE *F, ir_type *tp)
1969 fprintf(F, "node: {title: ");
1971 fprintf(F, " label: \"%s %s\"", get_type_tpop_name(tp), get_type_name_ex(tp, &bad));
1972 fprintf(F, " info1: \"");
1974 bad |= print_type_info(F, tp);
1975 print_typespecific_info(F, tp);
1977 dump_type_to_file(F, tp, dump_verbosity_max);
1980 print_dbg_info(F, get_type_dbg_info(tp));
1981 print_typespecific_vcgattr(F, tp);
1988 void dump_entity_node(FILE *F, ir_entity *ent)
1990 fprintf(F, "node: {title: \"");
1991 PRINT_ENTID(ent); fprintf(F, "\"");
1992 fprintf(F, DEFAULT_TYPE_ATTRIBUTE);
1993 fprintf(F, "label: ");
1994 fprintf(F, "\"%s\" ", get_ent_dump_name(ent));
1996 print_vcg_color(F, ird_color_entity);
1997 fprintf(F, "\n info1: \"");
1999 dump_entity_to_file(F, ent, dump_verbosity_entattrs | dump_verbosity_entconsts);
2002 print_dbg_info(F, get_entity_dbg_info(ent));
2006 static void dump_enum_item(FILE *F, ir_type *tp, int pos)
2009 ir_enum_const *ec = get_enumeration_const(tp, pos);
2010 ident *id = get_enumeration_nameid(ec);
2011 tarval *tv = get_enumeration_value(ec);
2014 tarval_snprintf(buf, sizeof(buf), tv);
2016 strncpy(buf, "<not set>", sizeof(buf));
2017 fprintf(F, "node: {title: \"");
2018 PRINT_ITEMID(tp, pos); fprintf(F, "\"");
2019 fprintf(F, DEFAULT_ENUM_ITEM_ATTRIBUTE);
2020 fprintf(F, "label: ");
2021 fprintf(F, "\"enum item %s\" " ENUM_ITEM_NODE_ATTR, get_id_str(id));
2022 fprintf(F, "\n info1: \"value: %s\"}\n", buf);
2025 /* dumps a type or entity and it's edges. */
2027 dump_type_info(type_or_ent tore, void *env) {
2029 int i = 0; /* to shutup gcc */
2031 /* dump this type or entity */
2033 switch (get_kind(tore.ent)) {
2035 ir_entity *ent = tore.ent;
2038 dump_entity_node(F, ent);
2040 /* skip this to reduce graph. Member edge of type is parallel to this edge. *
2041 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2042 ENT_OWN_EDGE_ATTR "}\n", ent, get_entity_owner(ent));*/
2043 print_ent_type_edge(F,ent, get_entity_type(ent), ENT_TYPE_EDGE_ATTR);
2044 if (is_Class_type(get_entity_owner(ent))) {
2045 for(i = 0; i < get_entity_n_overwrites(ent); i++)
2046 print_ent_ent_edge(F,ent, get_entity_overwrites(ent, i), 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2048 /* attached subgraphs */
2049 if (const_entities && (get_entity_variability(ent) != variability_uninitialized)) {
2050 if (is_atomic_entity(ent)) {
2051 value = get_atomic_ent_value(ent);
2053 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2054 /* DDMN(value); $$$ */
2055 dump_const_expression(F, value);
2058 if (is_compound_entity(ent)) {
2059 for (i = 0; i < get_compound_ent_n_values(ent); i++) {
2060 value = get_compound_ent_value(ent, i);
2062 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2063 dump_const_expression(F, value);
2064 print_ent_ent_edge(F, ent, get_compound_ent_value_member(ent, i), 0, -1, ENT_CORR_EDGE_ATTR, i);
2066 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2067 ENT_CORR_EDGE_ATTR "}\n", GET_ENTID(ent),
2068 get_compound_ent_value_member(ent, i), i);
2077 ir_type *tp = tore.typ;
2078 dump_type_node(F, tp);
2079 /* and now the edges */
2080 switch (get_type_tpop_code(tp)) {
2082 for (i=0; i < get_class_n_supertypes(tp); i++)
2083 print_type_type_edge(F, tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2084 for (i=0; i < get_class_n_members(tp); i++)
2085 print_type_ent_edge(F,tp,get_class_member(tp, i),TYPE_MEMBER_EDGE_ATTR);
2088 for (i=0; i < get_struct_n_members(tp); i++)
2089 print_type_ent_edge(F,tp,get_struct_member(tp, i),TYPE_MEMBER_EDGE_ATTR);
2092 for (i = 0; i < get_method_n_params(tp); i++)
2093 print_type_type_edge(F,tp,get_method_param_type(tp, i),METH_PAR_EDGE_ATTR,i);
2094 for (i = 0; i < get_method_n_ress(tp); i++)
2095 print_type_type_edge(F,tp,get_method_res_type(tp, i),METH_RES_EDGE_ATTR,i);
2098 for (i = 0; i < get_union_n_members(tp); i++)
2099 print_type_ent_edge(F,tp,get_union_member(tp, i),UNION_EDGE_ATTR);
2102 print_type_type_edge(F,tp,get_array_element_type(tp),ARR_ELT_TYPE_EDGE_ATTR);
2103 print_type_ent_edge(F,tp,get_array_element_entity(tp),ARR_ENT_EDGE_ATTR);
2104 for (i = 0; i < get_array_n_dimensions(tp); i++) {
2105 ir_node *upper = get_array_upper_bound(tp, i);
2106 ir_node *lower = get_array_lower_bound(tp, i);
2107 print_node_type_edge(F, upper, tp, "label: \"upper %d\"", get_array_order(tp, i));
2108 print_node_type_edge(F, lower, tp, "label: \"lower %d\"", get_array_order(tp, i));
2109 dump_const_expression(F, upper);
2110 dump_const_expression(F, lower);
2113 case tpo_enumeration:
2114 for (i = 0; i < get_enumeration_n_enums(tp); ++i) {
2115 dump_enum_item(F, tp, i);
2116 print_enum_item_edge(F, tp, i, "label: \"item %d\"", i);
2120 print_type_type_edge(F,tp,get_pointer_points_to_type(tp), PTR_PTS_TO_EDGE_ATTR);
2127 break; /* case k_type */
2130 printf(" *** irdump, dump_type_info(l.%i), faulty type.\n", __LINE__);
2131 } /* switch kind_or_entity */
2134 typedef struct _h_env {
2139 /** For dumping class hierarchies.
2140 * Dumps a class type node and a superclass edge.
2141 * If env->dump_ent dumps entities of classes and overwrites edges.
2144 dump_class_hierarchy_node(type_or_ent tore, void *ctx) {
2147 int i = 0; /* to shutup gcc */
2149 /* dump this type or entity */
2150 switch (get_kind(tore.ent)) {
2152 ir_entity *ent = tore.ent;
2153 if (get_entity_owner(ent) == get_glob_type()) break;
2154 if (!is_Method_type(get_entity_type(ent)))
2156 if (env->dump_ent && is_Class_type(get_entity_owner(ent))) {
2158 dump_entity_node(F, ent);
2160 print_type_ent_edge(F,get_entity_owner(ent),ent,TYPE_MEMBER_EDGE_ATTR);
2161 for(i = 0; i < get_entity_n_overwrites(ent); i++)
2162 print_ent_ent_edge(F, get_entity_overwrites(ent, i), ent, 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2167 ir_type *tp = tore.typ;
2168 if (tp == get_glob_type())
2170 switch (get_type_tpop_code(tp)) {
2172 dump_type_node(F, tp);
2173 /* and now the edges */
2174 for (i=0; i < get_class_n_supertypes(tp); i++) {
2175 print_type_type_edge(F,tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2180 break; /* case k_type */
2183 printf(" *** irdump, dump_class_hierarchy_node(l.%i), faulty type.\n", __LINE__);
2184 } /* switch kind_or_entity */
2187 /*******************************************************************/
2188 /* dump analysis information that is expressed in graph terms. */
2189 /*******************************************************************/
2191 /* dump out edges */
2193 dump_out_edge(ir_node *n, void *env) {
2196 for (i = 0; i < get_irn_n_outs(n); i++) {
2197 assert(get_irn_out(n, i));
2198 fprintf(F, "edge: {sourcename: \"");
2200 fprintf(F, "\" targetname: \"");
2201 PRINT_NODEID(get_irn_out(n, i));
2202 fprintf(F, "\" color: red linestyle: dashed");
2208 dump_loop_label(FILE *F, ir_loop *loop) {
2209 fprintf(F, "loop %d, %d sons, %d nodes",
2210 get_loop_depth(loop), get_loop_n_sons(loop), get_loop_n_nodes(loop));
2213 static inline void dump_loop_info(FILE *F, ir_loop *loop) {
2214 fprintf(F, " info1: \"");
2215 fprintf(F, " loop nr: %d", get_loop_loop_nr(loop));
2216 #ifdef DEBUG_libfirm /* GL @@@ debug analyses */
2217 fprintf(F, "\n The loop was analyzed %d times.", PTR_TO_INT(get_loop_link(loop)));
2223 dump_loop_node(FILE *F, ir_loop *loop) {
2224 fprintf(F, "node: {title: \"");
2226 fprintf(F, "\" label: \"");
2227 dump_loop_label(F, loop);
2229 dump_loop_info(F, loop);
2234 dump_loop_node_edge(FILE *F, ir_loop *loop, int i) {
2236 fprintf(F, "edge: {sourcename: \"");
2238 fprintf(F, "\" targetname: \"");
2239 PRINT_NODEID(get_loop_node(loop, i));
2240 fprintf(F, "\" color: green");
2245 dump_loop_son_edge(FILE *F, ir_loop *loop, int i) {
2247 fprintf(F, "edge: {sourcename: \"");
2249 fprintf(F, "\" targetname: \"");
2250 PRINT_LOOPID(get_loop_son(loop, i));
2251 fprintf(F, "\" color: darkgreen label: \"%d\"}\n",
2252 get_loop_element_pos(loop, get_loop_son(loop, i)));
2256 void dump_loops(FILE *F, ir_loop *loop) {
2258 /* dump this loop node */
2259 dump_loop_node(F, loop);
2261 /* dump edges to nodes in loop -- only if it is a real loop */
2262 if (get_loop_depth(loop) != 0) {
2263 for (i = 0; i < get_loop_n_nodes(loop); i++) {
2264 dump_loop_node_edge(F, loop, i);
2267 for (i = 0; i < get_loop_n_sons(loop); i++) {
2268 dump_loops(F, get_loop_son(loop, i));
2269 dump_loop_son_edge(F, loop, i);
2274 void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg) {
2275 ir_graph *rem = current_ir_graph;
2276 current_ir_graph = irg;
2278 if (get_irg_loop(irg)) dump_loops(F, get_irg_loop(irg));
2280 current_ir_graph = rem;
2285 * dumps the VCG header
2287 void dump_vcg_header(FILE *F, const char *name, const char *layout, const char *orientation) {
2293 label = edge_label ? "yes" : "no";
2294 if (! layout) layout = "Compilergraph";
2295 if (!orientation) orientation = "bottom_to_top";
2299 "graph: { title: \"ir graph of %s\"\n"
2300 "display_edge_labels: %s\n"
2301 "layoutalgorithm: mindepth //$ \"%s\"\n"
2302 "manhattan_edges: yes\n"
2303 "port_sharing: no\n"
2305 "classname 1: \"intrablock Data\"\n"
2306 "classname 2: \"Block\"\n"
2307 "classname 3: \"Entity type\"\n"
2308 "classname 4: \"Entity owner\"\n"
2309 "classname 5: \"Method Param\"\n"
2310 "classname 6: \"Method Res\"\n"
2311 "classname 7: \"Super\"\n"
2312 "classname 8: \"Union\"\n"
2313 "classname 9: \"Points-to\"\n"
2314 "classname 10: \"Array Element Type\"\n"
2315 "classname 11: \"Overwrites\"\n"
2316 "classname 12: \"Member\"\n"
2317 "classname 13: \"Control Flow\"\n"
2318 "classname 14: \"intrablock Memory\"\n"
2319 "classname 15: \"Dominators\"\n"
2320 "classname 16: \"interblock Data\"\n"
2321 "classname 17: \"interblock Memory\"\n"
2322 "classname 18: \"Exception Control Flow for Interval Analysis\"\n"
2323 "classname 19: \"Postdominators\"\n"
2324 "classname 20: \"Keep Alive\"\n"
2325 "classname 21: \"Out Edges\"\n"
2326 "classname 22: \"Macro Block Edges\"\n"
2327 //"classname 23: \"NoInput Nodes\"\n"
2328 "infoname 1: \"Attribute\"\n"
2329 "infoname 2: \"Verification errors\"\n"
2330 "infoname 3: \"Debug info\"\n",
2331 name, label, layout, orientation);
2333 for (i = 0; i < ird_color_count; ++i) {
2334 if (color_rgb[i] != NULL) {
2335 fprintf(F, "colorentry %s: %s\n", color_names[i], color_rgb[i]);
2338 fprintf(F, "\n"); /* a separator */
2344 * @param irg The graph to be dumped
2345 * @param suffix1 first filename suffix
2346 * @param suffix2 second filename suffix
2348 FILE *vcg_open(ir_graph *irg, const char * suffix1, const char *suffix2) {
2350 const char *nm = get_irg_dump_name(irg);
2351 int len = strlen(nm), i, j;
2352 char *fname; /* filename to put the vcg information in */
2354 if (!suffix1) suffix1 = "";
2355 if (!suffix2) suffix2 = "";
2357 /* open file for vcg graph */
2358 fname = XMALLOCN(char, len * 2 + strlen(suffix1) + strlen(suffix2) + 5);
2360 /* strncpy (fname, nm, len); */ /* copy the filename */
2362 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2364 fname[j] = '@'; j++; fname[j] = '1'; j++;
2365 } else if (nm[i] == '@') {
2366 fname[j] = '@'; j++; fname[j] = '2'; j++;
2368 fname[j] = nm[i]; j++;
2372 strcat(fname, suffix1); /* append file suffix */
2373 strcat(fname, suffix2); /* append file suffix */
2374 strcat(fname, ".vcg"); /* append the .vcg suffix */
2376 /* vcg really expect only a <CR> at end of line, so
2377 * the "b"inary mode is what you mean (and even needed for Win32)
2379 F = fopen(fname, "wb"); /* open file for writing */
2391 * @param name prefix file name
2392 * @param suffix filename suffix
2394 FILE *vcg_open_name(const char *name, const char *suffix) {
2396 char *fname; /* filename to put the vcg information in */
2397 int i, j, len = strlen(name);
2399 if (!suffix) suffix = "";
2401 /** open file for vcg graph */
2402 fname = XMALLOCN(char, len * 2 + 5 + strlen(suffix));
2403 /* strcpy (fname, name);*/ /* copy the filename */
2405 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2406 if (name[i] == '/') {
2407 fname[j] = '@'; j++; fname[j] = '1'; j++;
2408 } else if (name[i] == '@') {
2409 fname[j] = '@'; j++; fname[j] = '2'; j++;
2411 fname[j] = name[i]; j++;
2415 strcat(fname, suffix);
2416 strcat(fname, ".vcg"); /* append the .vcg suffix */
2418 /* vcg really expect only a <CR> at end of line, so
2419 * the "b"inary mode is what you mean (and even needed for Win32)
2421 F = fopen(fname, "wb"); /* open file for writing */
2431 * Dumps the vcg file footer
2433 void dump_vcg_footer(FILE *F) {
2437 /************************************************************************/
2438 /************************************************************************/
2439 /* Routines that dump all or parts of the firm representation to a file */
2440 /************************************************************************/
2441 /************************************************************************/
2443 /************************************************************************/
2444 /* Dump ir graphs, different formats and additional information. */
2445 /************************************************************************/
2447 typedef void (*do_dump_graph_func) (ir_graph *irg, FILE *out);
2449 static void do_dump(ir_graph *irg, const char *suffix, const char *suffix_ip,
2450 const char *suffix_nonip, do_dump_graph_func dump_func)
2454 const char *suffix1;
2456 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2459 rem = current_ir_graph;
2460 current_ir_graph = irg;
2461 if (get_interprocedural_view())
2462 suffix1 = suffix_ip;
2464 suffix1 = suffix_nonip;
2465 current_ir_graph = rem;
2467 out = vcg_open(irg, suffix, suffix1);
2469 dump_func(irg, out);
2474 void dump_ir_graph_file(ir_graph *irg, FILE *out)
2476 if (dump_backedge_information_flag
2477 && get_irg_loopinfo_state(irg) != loopinfo_consistent) {
2478 construct_backedges(irg);
2481 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2483 /* call the dump graph hook */
2484 if (dump_ir_graph_hook) {
2485 if (dump_ir_graph_hook(out, irg)) {
2490 /* walk over the graph */
2491 /* dump_whole_node must be called in post visiting predecessors */
2492 ird_walk_graph(irg, NULL, dump_whole_node, out);
2494 /* dump the out edges in a separate walk */
2495 if ((dump_out_edge_flag) && (get_irg_outs_state(irg) != outs_none)) {
2496 irg_out_walk(get_irg_start(irg), dump_out_edge, NULL, out);
2499 dump_vcg_footer(out);
2502 /** Routine to dump a graph, blocks as conventional nodes. */
2503 void dump_ir_graph(ir_graph *irg, const char *suffix )
2505 do_dump(irg, suffix, "-pure-ip", "-pure", dump_ir_graph_file);
2508 void dump_ir_block_graph_file(ir_graph *irg, FILE *out)
2512 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2514 construct_block_lists(irg);
2517 * If we are in the interprocedural view, we dump not
2518 * only the requested irg but also all irgs that can be reached
2521 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2522 ir_graph *g = get_irp_irg(i);
2523 ir_node **arr = ird_get_irg_link(g);
2525 dump_graph_from_list(out, g);
2530 dump_vcg_footer(out);
2533 /* Dump a firm graph without explicit block nodes. */
2534 void dump_ir_block_graph(ir_graph *irg, const char *suffix)
2536 do_dump(irg, suffix, "-ip", "", dump_ir_block_graph_file);
2539 void dump_ir_extblock_graph_file(ir_graph *irg, FILE *F)
2542 ir_entity *ent = get_irg_entity(irg);
2544 if (get_irg_extblk_state(irg) != extblk_valid)
2547 dump_vcg_header(F, get_irg_dump_name(irg), NULL, NULL);
2549 construct_extblock_lists(irg);
2551 fprintf(F, "graph: { title: \"");
2553 fprintf(F, "\" label: \"%s\" status:clustered color: white \n",
2554 get_ent_dump_name(ent));
2556 dump_graph_info(F, irg);
2557 print_dbg_info(F, get_entity_dbg_info(ent));
2559 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2560 ir_graph *irg = get_irp_irg(i);
2561 list_tuple *lists = ird_get_irg_link(irg);
2564 /* dump the extended blocks first */
2565 if (ARR_LEN(lists->extbb_list)) {
2566 ird_set_irg_link(irg, lists->extbb_list);
2567 dump_extblock_graph(F, irg);
2570 /* we may have blocks without extended blocks, bad for instance */
2571 if (ARR_LEN(lists->blk_list)) {
2572 ird_set_irg_link(irg, lists->blk_list);
2573 dump_block_graph(F, irg);
2576 DEL_ARR_F(lists->extbb_list);
2577 DEL_ARR_F(lists->blk_list);
2582 /* Close the vcg information for the irg */
2583 fprintf(F, "}\n\n");
2589 /* Dump a firm graph without explicit block nodes but grouped in extended blocks. */
2590 void dump_ir_extblock_graph(ir_graph *irg, const char *suffix)
2592 do_dump(irg, suffix, "-ip", "", dump_ir_extblock_graph_file);
2595 void dump_ir_graph_w_types_file(ir_graph *irg, FILE *out)
2597 ir_graph *rem = current_ir_graph;
2598 int rem_dump_const_local;
2600 rem = current_ir_graph;
2601 current_ir_graph = irg;
2602 rem_dump_const_local = dump_const_local;
2603 /* dumping types does not work with local nodes */
2604 dump_const_local = 0;
2606 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2608 /* dump common ir graph */
2609 irg_walk(get_irg_end(irg), NULL, dump_whole_node, out);
2610 /* dump type info */
2611 type_walk_irg(irg, dump_type_info, NULL, out);
2612 inc_irg_visited(get_const_code_irg());
2613 /* dump edges from graph to type info */
2614 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2616 dump_vcg_footer(out);
2617 dump_const_local = rem_dump_const_local;
2618 current_ir_graph = rem;
2621 /* dumps a graph with type information */
2622 void dump_ir_graph_w_types(ir_graph *irg, const char *suffix)
2624 do_dump(irg, suffix, "-pure-wtypes-ip", "-pure-wtypes",
2625 dump_ir_graph_w_types_file);
2628 void dump_ir_block_graph_w_types_file(ir_graph *irg, FILE *out)
2631 int rem_dump_const_local;
2632 ir_graph *rem = current_ir_graph;
2634 rem_dump_const_local = dump_const_local;
2635 /* dumping types does not work with local nodes */
2636 dump_const_local = 0;
2638 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2640 /* dump common blocked ir graph */
2641 construct_block_lists(irg);
2643 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2644 ir_node **arr = ird_get_irg_link(get_irp_irg(i));
2646 dump_graph_from_list(out, get_irp_irg(i));
2651 /* dump type info */
2652 current_ir_graph = irg;
2653 type_walk_irg(irg, dump_type_info, NULL, out);
2654 inc_irg_visited(get_const_code_irg());
2656 /* dump edges from graph to type info */
2657 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2659 dump_vcg_footer(out);
2660 dump_const_local = rem_dump_const_local;
2661 current_ir_graph = rem;
2664 void dump_ir_block_graph_w_types(ir_graph *irg, const char *suffix)
2666 do_dump(irg, suffix, "-wtypes-ip", "-wtypes",
2667 dump_ir_block_graph_w_types_file);
2670 /*---------------------------------------------------------------------*/
2671 /* The following routines dump a control flow graph. */
2672 /*---------------------------------------------------------------------*/
2675 dump_block_to_cfg(ir_node *block, void *env) {
2680 if (is_Block(block)) {
2681 /* This is a block. Dump a node for the block. */
2682 fprintf(F, "node: {title: \""); PRINT_NODEID(block);
2683 fprintf(F, "\" label: \"");
2684 if (block == get_irg_start_block(get_irn_irg(block)))
2685 fprintf(F, "Start ");
2686 if (block == get_irg_end_block(get_irn_irg(block)))
2689 fprintf(F, "%s ", get_op_name(get_irn_op(block)));
2690 PRINT_NODEID(block);
2692 fprintf(F, "info1:\"");
2694 /* the generic version. */
2695 dump_irnode_to_file(F, block);
2697 /* Check whether we have bad predecessors to color the block. */
2698 for (i = 0; i < get_Block_n_cfgpreds(block); ++i)
2699 if ((fl = is_Bad(get_Block_cfgpred(block, i))))
2702 fprintf(F, "\""); /* closing quote of info */
2704 if ((block == get_irg_start_block(get_irn_irg(block))) ||
2705 (block == get_irg_end_block(get_irn_irg(block))) )
2706 fprintf(F, " color:blue ");
2708 fprintf(F, " color:yellow ");
2711 /* Dump the edges */
2712 for ( i = 0; i < get_Block_n_cfgpreds(block); i++)
2713 if (!is_Bad(skip_Proj(get_Block_cfgpred(block, i)))) {
2714 pred = get_nodes_block(skip_Proj(get_Block_cfgpred(block, i)));
2715 fprintf(F, "edge: { sourcename: \"");
2716 PRINT_NODEID(block);
2717 fprintf(F, "\" targetname: \"");
2719 fprintf(F, "\"}\n");
2722 /* Dump dominator/postdominator edge */
2723 if (dump_dominator_information_flag) {
2724 if (get_irg_dom_state(current_ir_graph) == dom_consistent && get_Block_idom(block)) {
2725 pred = get_Block_idom(block);
2726 fprintf(F, "edge: { sourcename: \"");
2727 PRINT_NODEID(block);
2728 fprintf(F, "\" targetname: \"");
2730 fprintf(F, "\" " DOMINATOR_EDGE_ATTR "}\n");
2732 if (get_irg_postdom_state(current_ir_graph) == dom_consistent && get_Block_ipostdom(block)) {
2733 pred = get_Block_ipostdom(block);
2734 fprintf(F, "edge: { sourcename: \"");
2735 PRINT_NODEID(block);
2736 fprintf(F, "\" targetname: \"");
2738 fprintf(F, "\" " POSTDOMINATOR_EDGE_ATTR "}\n");
2744 void dump_cfg(ir_graph *irg, const char *suffix)
2747 /* if a filter is set, dump only the irg's that match the filter */
2748 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2751 f = vcg_open(irg, suffix, "-cfg");
2753 ir_graph *rem = current_ir_graph;
2754 #ifdef INTERPROCEDURAL_VIEW
2755 int ipv = get_interprocedural_view();
2758 current_ir_graph = irg;
2759 dump_vcg_header(f, get_irg_dump_name(irg), NULL, NULL);
2761 #ifdef INTERPROCEDURAL_VIEW
2763 printf("Warning: dumping cfg not in interprocedural view!\n");
2764 set_interprocedural_view(0);
2768 /* walk over the blocks in the graph */
2769 irg_block_walk(get_irg_end(irg), dump_block_to_cfg, NULL, f);
2770 dump_node(f, get_irg_bad(irg));
2772 #ifdef INTERPROCEDURAL_VIEW
2773 set_interprocedural_view(ipv);
2777 current_ir_graph = rem;
2782 static void descend_and_dump(FILE *F, ir_node *n, int depth, pset *mark_set) {
2783 if (pset_find_ptr(mark_set, n)) return;
2785 pset_insert_ptr(mark_set, n);
2788 int i, start = is_Block(n) ? 0 : -1;
2789 dump_whole_node(n, F);
2790 for (i = start; i < get_irn_arity(n); ++i)
2791 descend_and_dump(F, get_irn_n(n, i), depth-1, mark_set);
2794 /* Don't dump edges to nodes further out. These might be edges to
2795 nodes we already dumped, if there is a shorter path to these. */
2799 static int subgraph_counter = 0;
2800 void dump_subgraph(ir_node *root, int depth, const char *suffix) {
2804 sprintf(buf, "-subg_%03d", subgraph_counter++);
2805 F = vcg_open(get_irn_irg(root), suffix, buf);
2807 pset *mark_set = pset_new_ptr(1);
2808 dump_vcg_header(F, get_irg_dump_name(get_irn_irg(root)), NULL, NULL);
2809 descend_and_dump(F, root, depth, mark_set);
2816 void dump_callgraph(const char *suffix) {
2817 FILE *F = vcg_open_name("Callgraph", suffix);
2820 int i, rem = edge_label;
2823 dump_vcg_header(F, "Callgraph", "Hierarchiv", NULL);
2825 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2826 ir_graph *irg = get_irp_irg(i);
2827 ir_entity *ent = get_irg_entity(irg);
2829 int n_callees = get_irg_n_callees(irg);
2831 dump_entity_node(F, ent);
2832 for (j = 0; j < n_callees; ++j) {
2833 ir_entity *c = get_irg_entity(get_irg_callee(irg, j));
2834 //if (id_is_prefix(prefix, get_entity_ld_ident(c))) continue;
2835 int be = is_irg_callee_backedge(irg, j);
2838 "label:\"recursion %d\"" :
2839 "label:\"calls %d\"";
2840 print_ent_ent_edge(F, ent, c, be, ird_color_entity, attr, get_irg_callee_loop_depth(irg, j));
2851 /* Dump all irgs in interprocedural view to a single file. */
2852 void dump_all_cg_block_graph(const char *suffix) {
2853 FILE *f = vcg_open_name("All_graphs", suffix);
2857 int rem_view = get_interprocedural_view();
2859 set_interprocedural_view(1);
2860 dump_vcg_header(f, "All_graphs", NULL);
2862 /* collect nodes in all irgs reachable in call graph*/
2863 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2864 ird_set_irg_link(get_irp_irg(i), NULL);
2866 cg_walk(clear_link, collect_node, NULL);
2868 /* dump all graphs */
2869 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2870 current_ir_graph = get_irp_irg(i);
2871 assert(ird_get_irg_link(current_ir_graph));
2872 dump_graph_from_list(f, current_ir_graph);
2873 DEL_ARR_F(ird_get_irg_link(current_ir_graph));
2878 set_interprocedural_view(rem_view);
2883 /*---------------------------------------------------------------------*/
2884 /* the following routines dumps type information without any ir nodes. */
2885 /*---------------------------------------------------------------------*/
2888 dump_type_graph(ir_graph *irg, const char *suffix)
2892 /* if a filter is set, dump only the irg's that match the filter */
2893 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
2895 f = vcg_open(irg, suffix, "-type");
2897 ir_graph *rem = current_ir_graph;
2898 current_ir_graph = irg;
2900 dump_vcg_header(f, get_irg_dump_name(irg), "Hierarchic", NULL);
2902 /* walk over the blocks in the graph */
2903 type_walk_irg(irg, dump_type_info, NULL, f);
2904 /* The walker for the const code can be called several times for the
2905 same (sub) expression. So that no nodes are dumped several times
2906 we decrease the visited flag of the corresponding graph after each
2907 walk. So now increase it finally. */
2908 inc_irg_visited(get_const_code_irg());
2912 current_ir_graph = rem;
2917 dump_all_types(const char *suffix)
2919 FILE *f = vcg_open_name("All_types", suffix);
2921 dump_vcg_header(f, "All_types", "Hierarchic", NULL);
2922 type_walk(dump_type_info, NULL, f);
2923 inc_irg_visited(get_const_code_irg());
2931 dump_class_hierarchy(int entities, const char *suffix)
2933 FILE *f = vcg_open_name("class_hierarchy", suffix);
2938 env.dump_ent = entities;
2939 dump_vcg_header(f, "class_hierarchy", "Hierarchic", NULL);
2940 type_walk(dump_class_hierarchy_node, NULL, &env);
2947 /*---------------------------------------------------------------------*/
2948 /* dumps all graphs with the graph-dumper passed. Possible dumpers: */
2950 /* dump_ir_block_graph */
2952 /* dump_type_graph */
2953 /* dump_ir_graph_w_types */
2954 /*---------------------------------------------------------------------*/
2956 void dump_all_ir_graphs(dump_graph_func *dmp_grph, const char *suffix) {
2958 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2959 dmp_grph(get_irp_irg(i), suffix);
2963 /*--------------------------------------------------------------------------------*
2964 * Dumps a stand alone loop graph with firm nodes which belong to one loop node *
2965 * packed together in one subgraph/box *
2966 *--------------------------------------------------------------------------------*/
2968 void dump_loops_standalone(FILE *F, ir_loop *loop) {
2969 int i = 0, loop_node_started = 0, son_number = 0, first = 0;
2971 ir_loop *son = NULL;
2973 /* Dump a new loop node. */
2974 dump_loop_node(F, loop);
2976 /* Dump the loop elements. */
2977 for (i = 0; i < get_loop_n_elements(loop); i++) {
2978 le = get_loop_element(loop, i);
2980 if (get_kind(son) == k_ir_loop) {
2982 /* We are a loop son -> Recurse */
2984 if (loop_node_started) { /* Close the "firm-nodes" node first if we started one. */
2985 fprintf(F, "\" }\n");
2986 fprintf(F, "edge: {sourcename: \"");
2988 fprintf(F, "\" targetname: \"");
2990 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
2991 loop_node_started = 0;
2993 dump_loop_son_edge(F, loop, son_number++);
2994 dump_loops_standalone(F, son);
2995 } else if (get_kind(son) == k_ir_node) {
2996 /* We are a loop node -> Collect firm nodes */
2998 ir_node *n = le.node;
3001 if (!loop_node_started) {
3002 /* Start a new node which contains all firm nodes of the current loop */
3003 fprintf(F, "node: { title: \"");
3005 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3006 loop_node_started = 1;
3011 bad |= dump_node_label(F, n);
3012 /* Causes indeterministic output: if (is_Block(n)) fprintf(F, "\t ->%d", (int)get_irn_link(n)); */
3013 if (has_backedges(n)) fprintf(F, "\t loop head!");
3014 } else { /* for callgraph loop tree */
3016 assert(get_kind(son) == k_ir_graph);
3018 /* We are a loop node -> Collect firm graphs */
3020 if (!loop_node_started) {
3021 /* Start a new node which contains all firm nodes of the current loop */
3022 fprintf(F, "node: { title: \"");
3024 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3025 loop_node_started = 1;
3029 fprintf(F, " %s", get_irg_dump_name(n));
3030 /* fprintf(F, " %s (depth %d)", get_irg_dump_name(n), n->callgraph_weighted_loop_depth); */
3034 if (loop_node_started) {
3035 fprintf(F, "\" }\n");
3036 fprintf(F, "edge: {sourcename: \"");
3038 fprintf(F, "\" targetname: \"");
3040 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3041 loop_node_started = 0;
3045 void dump_loop_tree(ir_graph *irg, const char *suffix)
3049 /* if a filter is set, dump only the irg's that match the filter */
3050 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
3052 f = vcg_open(irg, suffix, "-looptree");
3054 ir_graph *rem = current_ir_graph;
3055 int el_rem = edge_label;
3057 current_ir_graph = irg;
3060 dump_vcg_header(f, get_irg_dump_name(irg), "Tree", "top_to_bottom");
3062 if (get_irg_loop(irg))
3063 dump_loops_standalone(f, get_irg_loop(irg));
3068 edge_label = el_rem;
3069 current_ir_graph = rem;
3073 void dump_callgraph_loop_tree(const char *suffix) {
3075 F = vcg_open_name("Callgraph_looptree", suffix);
3076 dump_vcg_header(F, "callgraph looptree", "Tree", "top_to_bottom");
3077 dump_loops_standalone(F, irp->outermost_cg_loop);
3083 /*----------------------------------------------------------------------------*/
3084 /* Dumps the firm nodes in the loop tree to a graph along with the loop nodes.*/
3085 /*----------------------------------------------------------------------------*/
3087 void collect_nodeloop(FILE *F, ir_loop *loop, eset *loopnodes) {
3088 int i, son_number = 0, node_number = 0;
3090 if (dump_loop_information_flag) dump_loop_node(F, loop);
3092 for (i = 0; i < get_loop_n_elements(loop); i++) {
3093 loop_element le = get_loop_element(loop, i);
3094 if (*(le.kind) == k_ir_loop) {
3095 if (dump_loop_information_flag) dump_loop_son_edge(F, loop, son_number++);
3097 collect_nodeloop(F, le.son, loopnodes);
3099 if (dump_loop_information_flag) dump_loop_node_edge(F, loop, node_number++);
3100 eset_insert(loopnodes, le.node);
3105 void collect_nodeloop_external_nodes(ir_loop *loop, eset *loopnodes, eset *extnodes) {
3108 for(i = 0; i < get_loop_n_elements(loop); i++) {
3109 loop_element le = get_loop_element(loop, i);
3110 if (*(le.kind) == k_ir_loop) {
3112 collect_nodeloop_external_nodes(le.son, loopnodes, extnodes);
3114 if (is_Block(le.node)) start = 0; else start = -1;
3115 for (j = start; j < get_irn_arity(le.node); j++) {
3116 ir_node *pred = get_irn_n(le.node, j);
3117 if (!eset_contains(loopnodes, pred)) {
3118 eset_insert(extnodes, pred);
3119 if (!is_Block(pred)) {
3120 pred = get_nodes_block(pred);
3121 if (!eset_contains(loopnodes, pred)) eset_insert(extnodes, pred);
3129 void dump_loop(ir_loop *l, const char *suffix) {
3133 snprintf(name, sizeof(name), "loop_%d", get_loop_loop_nr(l));
3134 F = vcg_open_name(name, suffix);
3136 eset *loopnodes = eset_create();
3137 eset *extnodes = eset_create();
3140 dump_vcg_header(F, name, NULL, NULL);
3142 /* collect all nodes to dump */
3143 collect_nodeloop(F, l, loopnodes);
3144 collect_nodeloop_external_nodes(l, loopnodes, extnodes);
3146 /* build block lists */
3147 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes))
3148 set_irn_link(n, NULL);
3149 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes))
3150 set_irn_link(n, NULL);
3151 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes)) {
3153 b = get_nodes_block(n);
3154 set_irn_link(n, get_irn_link(b));
3158 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes)) {
3160 b = get_nodes_block(n);
3161 set_irn_link(n, get_irn_link(b));
3166 for (b = eset_first(loopnodes); b != NULL; b = eset_next(loopnodes)) {
3168 fprintf(F, "graph: { title: \"");
3170 fprintf(F, "\" label: \"");
3171 dump_node_opcode(F, b);
3172 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3173 fprintf(F, "\" status:clustered color:yellow\n");
3175 /* dump the blocks edges */
3176 dump_ir_data_edges(F, b);
3178 /* dump the nodes that go into the block */
3179 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3180 if (eset_contains(extnodes, n))
3181 overrule_nodecolor = ird_color_block_inout;
3183 overrule_nodecolor = ird_color_default_node;
3184 if (!eset_contains(extnodes, n)) dump_ir_data_edges(F, n);
3187 /* Close the vcg information for the block */
3189 dump_const_node_local(F, b);
3193 for (b = eset_first(extnodes); b != NULL; b = eset_next(extnodes)) {
3195 fprintf(F, "graph: { title: \"");
3197 fprintf(F, "\" label: \"");
3198 dump_node_opcode(F, b);
3199 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3200 fprintf(F, "\" status:clustered color:lightblue\n");
3202 /* dump the nodes that go into the block */
3203 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3204 if (!eset_contains(loopnodes, n))
3205 overrule_nodecolor = ird_color_block_inout;
3207 overrule_nodecolor = ird_color_default_node;
3208 if (eset_contains(loopnodes, n)) dump_ir_data_edges(F, n);
3211 /* Close the vcg information for the block */
3213 dump_const_node_local(F, b);
3217 eset_destroy(loopnodes);
3218 eset_destroy(extnodes);