2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Write vcg representation of firm to file.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Hubert Schmidt
32 #include "firm_common_t.h"
37 #include "irgraph_t.h"
50 #include "callgraph.h"
51 #include "irextbb_t.h"
53 #include "dbginfo_t.h"
65 /** Dump only irgs with names that start with this prefix. */
66 static ident *dump_file_filter_id = NULL;
68 #define ERROR_TXT "<ERROR>"
70 /*******************************************************************/
71 /* flags to steer output */
72 /*******************************************************************/
74 /** An option to turn off edge labels */
75 static int edge_label = 1;
76 /** An option to turn off dumping values of constant entities */
77 static int const_entities = 1;
78 /** An option to dump the keep alive edges */
79 static int dump_keepalive = 1;
80 /** An option to dump the new out edges */
81 static int dump_new_edges_flag = 0;
82 /** An option to dump ld_names instead of names. */
83 static int dump_ld_name = 1;
84 /** Compiler options to dump analysis information in dump_ir_graph */
85 static int dump_out_edge_flag = 0;
86 static int dump_loop_information_flag = 0;
87 static int dump_backedge_information_flag = 1;
88 /** An option to dump const-like nodes locally. */
89 static int dump_const_local = 1;
90 /** An option to dump the node index number. */
91 static int dump_node_idx_labels = 0;
92 /** An option to dump all graph anchors */
93 static int dump_anchors = 0;
94 /** An option to dump the macro block edges. */
95 static int dump_macro_block_edges = 0;
96 /** An option to dump block marker in the block title */
97 static int dump_block_marker = 0;
99 int dump_dominator_information_flag = 0;
100 int opt_dump_analysed_type_info = 1;
101 int opt_dump_pointer_values_to_info = 0; /* default off: for test compares!! */
103 static ird_color_t overrule_nodecolor = ird_color_default_node;
105 /** The vcg node attribute hook. */
106 static DUMP_IR_GRAPH_FUNC dump_ir_graph_hook = NULL;
107 /** The vcg node attribute hook. */
108 static DUMP_NODE_VCGATTR_FUNC dump_node_vcgattr_hook = NULL;
109 /** The vcg edge attribute hook. */
110 static DUMP_EDGE_VCGATTR_FUNC dump_edge_vcgattr_hook = NULL;
111 /** The vcg dump block edge hook */
112 static DUMP_NODE_EDGE_FUNC dump_block_edge_hook = NULL;
113 /** The vcg dump node edge hook. */
114 static DUMP_NODE_EDGE_FUNC dump_node_edge_hook = NULL;
116 /* Set the hook to be called to dump additional edges to a node. */
117 void set_dump_node_edge_hook(DUMP_NODE_EDGE_FUNC func) {
118 dump_node_edge_hook = func;
121 /* Get the additional edge dump hook. */
122 DUMP_NODE_EDGE_FUNC get_dump_node_edge_hook(void) {
123 return dump_node_edge_hook;
126 /* Set the hook to be called to dump additional edges to a block. */
127 void set_dump_block_edge_hook(DUMP_NODE_EDGE_FUNC func) {
128 dump_block_edge_hook = func;
131 /* Get the additional block edge dump hook. */
132 DUMP_NODE_EDGE_FUNC get_dump_block_edge_hook(void) {
133 return dump_node_edge_hook;
136 /* set the ir graph hook */
137 void set_dump_ir_graph_hook(DUMP_IR_GRAPH_FUNC hook) {
138 dump_ir_graph_hook = hook;
141 /* set the node attribute hook */
142 void set_dump_node_vcgattr_hook(DUMP_NODE_VCGATTR_FUNC hook) {
143 dump_node_vcgattr_hook = hook;
146 /* set the edge attribute hook */
147 void set_dump_edge_vcgattr_hook(DUMP_EDGE_VCGATTR_FUNC hook) {
148 dump_edge_vcgattr_hook = hook;
151 /** Returns 0 if dump_out_edge_flag or dump_loop_information_flag
152 * are set, else returns dump_const_local_flag.
154 static int get_opt_dump_const_local(void) {
155 if (dump_out_edge_flag || dump_loop_information_flag || (dump_new_edges_flag && edges_activated(current_ir_graph)))
157 return dump_const_local;
160 /* Set a prefix filter for output functions. */
161 void only_dump_method_with_name(ident *name) {
162 dump_file_filter_id = name;
165 /* Returns the prefix filter set with only_dump_method_with_name(). */
166 ident *get_dump_file_filter_ident(void) {
167 return dump_file_filter_id;
170 /* Returns non-zero if dump file filter is not set, or if it is a prefix of name. */
171 int is_filtered_dump_name(ident *name) {
172 if (!dump_file_filter_id) return 1;
173 return id_is_prefix(dump_file_filter_id, name);
176 /* To turn off display of edge labels. Edge labels often cause xvcg to
177 abort with a segmentation fault. */
178 void turn_off_edge_labels(void) {
182 void dump_consts_local(int flag) {
183 dump_const_local = flag;
186 void dump_node_idx_label(int flag) {
187 dump_node_idx_labels = flag;
190 void dump_constant_entity_values(int flag) {
191 const_entities = flag;
194 void dump_keepalive_edges(int flag) {
195 dump_keepalive = flag;
198 void dump_new_edges(int flag) {
199 dump_new_edges_flag = flag;
202 int get_opt_dump_keepalive_edges(void) {
203 return dump_keepalive;
206 void dump_out_edges(int flag) {
207 dump_out_edge_flag = flag;
210 void dump_dominator_information(int flag) {
211 dump_dominator_information_flag = flag;
214 void dump_loop_information(int flag) {
215 dump_loop_information_flag = flag;
218 void dump_backedge_information(int flag) {
219 dump_backedge_information_flag = flag;
222 /* Dump the information of type field specified in ana/irtypeinfo.h.
223 * If the flag is set, the type name is output in [] in the node label,
224 * else it is output as info.
226 void set_opt_dump_analysed_type_info(int flag) {
227 opt_dump_analysed_type_info = flag;
230 void dump_pointer_values_to_info(int flag) {
231 opt_dump_pointer_values_to_info = flag;
234 void dump_ld_names(int flag) {
238 void dump_all_anchors(int flag) {
242 void dump_macroblock_edges(int flag) {
243 dump_macro_block_edges = flag;
246 void dump_block_marker_in_title(int flag) {
247 dump_block_marker = flag;
250 /* -------------- some extended helper functions ----------------- */
253 * returns the name of a mode or ERROR_TXT if mode is NOT a mode object.
254 * in the later case, sets bad.
256 const char *get_mode_name_ex(const ir_mode *mode, int *bad) {
258 return get_mode_name(mode);
264 * returns the name of a type or <ERROR> if mode is NOT a mode object.
265 * in the later case, sets bad
267 const char *get_type_name_ex(const ir_type *tp, int *bad) {
269 return get_type_name(tp);
274 #define CUSTOM_COLOR_BASE 100
275 static const char *color_names[ird_color_count];
276 static const char *color_rgb[ird_color_count];
277 static struct obstack color_obst;
279 /** define a custom color. */
280 static void custom_color(int num, const char *rgb_def)
282 assert(num < ird_color_count);
283 obstack_printf(&color_obst, "%d", CUSTOM_COLOR_BASE + num);
284 obstack_1grow(&color_obst, '\0');
286 color_rgb[num] = rgb_def;
287 color_names[num] = obstack_finish(&color_obst);
290 /** Define a named color. */
291 static void named_color(int num, const char *name)
293 assert(num < ird_color_count);
294 color_rgb[num] = NULL;
295 color_names[num] = name;
298 /** Initializes the used colors. */
299 static void init_colors(void)
301 static int initialized = 0;
305 obstack_init(&color_obst);
307 custom_color(ird_color_prog_background, "204 204 204");
308 custom_color(ird_color_block_background, "255 255 0");
309 custom_color(ird_color_dead_block_background, "190 150 150");
310 named_color(ird_color_block_inout, "lightblue");
311 named_color(ird_color_default_node, "white");
312 custom_color(ird_color_memory, "153 153 255");
313 custom_color(ird_color_controlflow, "255 153 153");
314 custom_color(ird_color_const, "204 255 255");
315 custom_color(ird_color_proj, "255 255 153");
316 custom_color(ird_color_uses_memory, "153 153 255");
317 custom_color(ird_color_phi, "105 255 105");
318 custom_color(ird_color_anchor, "100 100 255");
319 named_color(ird_color_error, "red");
320 custom_color(ird_color_entity, "204 204 255");
326 * Prints the VCG color to a file.
328 static void print_vcg_color(FILE *F, ird_color_t color) {
329 assert(color < ird_color_count);
330 fprintf(F, "color:%s", color_names[color]);
334 * Prints the edge from a type S to a type T with additional info fmt, ...
337 static void print_type_type_edge(FILE *F, const ir_type *S, const ir_type *T, const char *fmt, ...)
342 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(S);
343 fprintf(F, " targetname: "); PRINT_TYPEID(T);
344 vfprintf(F, fmt, ap);
350 * Prints the edge from a type tp to an entity ent with additional info fmt, ...
353 static void print_type_ent_edge(FILE *F, const ir_type *tp, const ir_entity *ent, const char *fmt, ...)
358 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(tp);
359 fprintf(F, " targetname: \""); PRINT_ENTID(ent); fprintf(F, "\"");
360 vfprintf(F, fmt, ap);
366 * Prints the edge from an entity ent1 to an entity ent2 with additional info fmt, ...
369 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, ...)
375 fprintf(F, "backedge: { sourcename: \"");
377 fprintf(F, "edge: { sourcename: \"");
379 fprintf(F, "\" targetname: \""); PRINT_ENTID(ent2); fprintf(F, "\"");
380 vfprintf(F, fmt, ap);
382 if (color != (ird_color_t) -1)
383 print_vcg_color(F, color);
389 * Prints the edge from an entity ent to a type tp with additional info fmt, ...
392 static void print_ent_type_edge(FILE *F, const ir_entity *ent, const ir_type *tp, const char *fmt, ...)
397 fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(ent);
398 fprintf(F, "\" targetname: "); PRINT_TYPEID(tp);
399 vfprintf(F, fmt, ap);
405 * Prints the edge from a node irn to a type tp with additional info fmt, ...
408 static void print_node_type_edge(FILE *F, const ir_node *irn, ir_type *tp, const char *fmt, ...)
413 fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(irn);
414 fprintf(F, "\" targetname: "); PRINT_TYPEID(tp);
415 vfprintf(F, fmt, ap);
421 * Prints the edge from a node irn to an entity ent with additional info fmt, ...
424 static void print_node_ent_edge(FILE *F, const ir_node *irn, const ir_entity *ent, const char *fmt, ...)
429 fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(irn);
430 fprintf(F, "\" targetname: \""); PRINT_ENTID(ent);
432 vfprintf(F, fmt, ap);
438 * Prints the edge from an entity ent to a node irn with additional info fmt, ...
441 static void print_ent_node_edge(FILE *F, const ir_entity *ent, const ir_node *irn, const char *fmt, ...)
446 fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(ent);
447 fprintf(F, "\" targetname: \""); PRINT_NODEID(irn); fprintf(F, "\"");
448 vfprintf(F, fmt, ap);
454 * Prints the edge from a type tp to an enumeration item item with additional info fmt, ...
457 static void print_enum_item_edge(FILE *F, const ir_type *tp, int item, const char *fmt, ...)
462 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(tp);
463 fprintf(F, " targetname: \""); PRINT_ITEMID(tp, item); fprintf(F, "\" ");
464 vfprintf(F, fmt, ap);
469 /*-----------------------------------------------------------------*/
470 /* global and ahead declarations */
471 /*-----------------------------------------------------------------*/
473 static void dump_whole_node(ir_node *n, void *env);
474 static inline void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg);
476 /*-----------------------------------------------------------------*/
477 /* Helper functions. */
478 /*-----------------------------------------------------------------*/
481 * This map is used as a private link attr to be able to call dumper
482 * anywhere without destroying link fields.
484 static pmap *irdump_link_map = NULL;
486 /** NOT A STANDARD LIBFIRM INIT METHOD
488 * We do not want to integrate dumping into libfirm, i.e., if the dumpers
489 * are off, we want to have as few interferences as possible. Therefore the
490 * initialization is performed lazily and not called from within init_firm.
492 * Creates the link attribute map. */
493 static void init_irdump(void) {
494 /* We need a new, empty map. */
495 if (irdump_link_map) pmap_destroy(irdump_link_map);
496 irdump_link_map = pmap_create();
497 if (!dump_file_filter_id)
498 dump_file_filter_id = new_id_from_str("");
502 * Returns the private link field.
504 static void *ird_get_irn_link(const ir_node *n) {
506 if (irdump_link_map == NULL)
509 if (pmap_contains(irdump_link_map, n))
510 res = pmap_get(irdump_link_map, n);
515 * Sets the private link field.
517 static void ird_set_irn_link(const ir_node *n, void *x) {
518 if (irdump_link_map == NULL)
520 pmap_insert(irdump_link_map, n, x);
524 * Gets the private link field of an irg.
526 static void *ird_get_irg_link(const ir_graph *irg) {
528 if (irdump_link_map == NULL)
531 if (pmap_contains(irdump_link_map, irg))
532 res = pmap_get(irdump_link_map, irg);
537 * Sets the private link field of an irg.
539 static void ird_set_irg_link(const ir_graph *irg, void *x) {
540 if (irdump_link_map == NULL)
542 pmap_insert(irdump_link_map, irg, x);
546 * Walker, clears the private link field.
548 static void clear_link(ir_node *node, void *env) {
550 ird_set_irn_link(node, NULL);
554 * If the entity has a ld_name, returns it if the dump_ld_name is set,
555 * else returns the name of the entity.
557 static const char *_get_ent_dump_name(const ir_entity *ent, int dump_ld_name) {
559 return "<NULL entity>";
561 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
562 if (ent->ld_name != NULL)
563 return get_id_str(ent->ld_name);
565 return get_id_str(ent->name);
569 * If the entity has a ld_name, returns it if the option dump_ld_name is set,
570 * else returns the name of the entity.
572 const char *get_ent_dump_name(const ir_entity *ent) {
573 return _get_ent_dump_name(ent, dump_ld_name);
576 /* Returns the name of an IRG. */
577 const char *get_irg_dump_name(const ir_graph *irg) {
578 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
579 return _get_ent_dump_name(get_irg_entity(irg), 1);
583 * Returns non-zero if a node is in floating state.
585 static int node_floats(const ir_node *n) {
586 return ((get_irn_pinned(n) == op_pin_state_floats) &&
587 (get_irg_pinned(current_ir_graph) == op_pin_state_floats));
591 * Walker that visits the anchors
593 static void ird_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env) {
594 if (dump_anchors || (dump_new_edges_flag && edges_activated(irg))) {
595 irg_walk_anchors(irg, pre, post, env);
597 irg_walk_graph(irg, pre, post, env);
602 * Walker, allocates an array for all blocks and puts it's nodes non-floating nodes into this array.
604 static void collect_node(ir_node *node, void *env) {
608 || (get_op_flags(get_irn_op(node)) & irop_flag_dump_noblock)) {
609 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
610 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
611 ARR_APP1(ir_node *, arr, node);
612 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
614 ir_node * block = get_nodes_block(node);
617 /* this node is in a Bad block, so we must place it into the graph's list */
618 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
619 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
620 ARR_APP1(ir_node *, arr, node);
621 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
623 ird_set_irn_link(node, ird_get_irn_link(block));
624 ird_set_irn_link(block, node);
629 /** Construct lists to walk ir block-wise.
631 * Collects all blocks, nodes not op_pin_state_pinned,
632 * Bad, NoMem and Unknown into a flexible array in link field of
633 * irg they belong to. Sets the irg link field to NULL in all
634 * graphs not visited.
635 * Free the list with DEL_ARR_F().
637 static ir_node **construct_block_lists(ir_graph *irg) {
639 #ifdef INTERPROCEDURAL_VIEW
640 int rem_view = get_interprocedural_view();
642 int walk_flag = ir_resources_reserved(irg) & IR_RESOURCE_IRN_VISITED;
643 ir_graph *rem = current_ir_graph;
645 current_ir_graph = irg;
648 ir_free_resources(irg, IR_RESOURCE_IRN_VISITED);
651 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
652 ird_set_irg_link(get_irp_irg(i), NULL);
654 ird_walk_graph(current_ir_graph, clear_link, collect_node, current_ir_graph);
656 #ifdef INTERPROCEDURAL_VIEW
657 /* Collect also EndReg and EndExcept. We do not want to change the walker. */
658 set_interprocedural_view(0);
661 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
662 irg_walk(get_irg_end_reg(current_ir_graph), clear_link, collect_node, current_ir_graph);
663 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
664 irg_walk(get_irg_end_except(current_ir_graph), clear_link, collect_node, current_ir_graph);
666 #ifdef INTERPROCEDURAL_VIEW
667 set_interprocedural_view(rem_view);
671 ir_reserve_resources(irg, IR_RESOURCE_IRN_VISITED);
674 current_ir_graph = rem;
675 return ird_get_irg_link(irg);
678 typedef struct _list_tuple {
680 ir_extblk **extbb_list;
683 /** Construct lists to walk IR extended block-wise.
684 * Free the lists in the tuple with DEL_ARR_F().
685 * Sets the irg link field to NULL in all
686 * graphs not visited.
688 static list_tuple *construct_extblock_lists(ir_graph *irg) {
689 ir_node **blk_list = construct_block_lists(irg);
691 ir_graph *rem = current_ir_graph;
692 list_tuple *lists = XMALLOC(list_tuple);
694 current_ir_graph = irg;
696 lists->blk_list = NEW_ARR_F(ir_node *, 0);
697 lists->extbb_list = NEW_ARR_F(ir_extblk *, 0);
699 inc_irg_block_visited(irg);
700 for (i = ARR_LEN(blk_list) - 1; i >= 0; --i) {
703 if (is_Block(blk_list[i])) {
704 ext = get_Block_extbb(blk_list[i]);
706 if (extbb_not_visited(ext)) {
707 ARR_APP1(ir_extblk *, lists->extbb_list, ext);
708 mark_extbb_visited(ext);
711 ARR_APP1(ir_node *, lists->blk_list, blk_list[i]);
715 current_ir_graph = rem;
716 ird_set_irg_link(irg, lists);
720 /*-----------------------------------------------------------------*/
721 /* Routines to dump information about a single ir node. */
722 /*-----------------------------------------------------------------*/
725 * dump the name of a node n to the File F.
727 int dump_node_opcode(FILE *F, ir_node *n)
730 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
732 /* call the dump_node operation if available */
734 return ops->dump_node(n, F, dump_node_opcode_txt);
736 /* implementation for default nodes */
737 switch (get_irn_opcode(n)) {
739 switch (get_SymConst_kind(n)) {
740 case symconst_addr_name:
741 /* don't use get_SymConst_ptr_info as it mangles the name. */
742 fprintf(F, "SymC %s", get_id_str(get_SymConst_name(n)));
744 case symconst_addr_ent:
745 fprintf(F, "SymC &%s", get_entity_name(get_SymConst_entity(n)));
747 case symconst_ofs_ent:
748 fprintf(F, "SymC %s offset", get_entity_name(get_SymConst_entity(n)));
750 case symconst_type_tag:
751 fprintf(F, "SymC %s tag", get_type_name_ex(get_SymConst_type(n), &bad));
753 case symconst_type_size:
754 fprintf(F, "SymC %s size", get_type_name_ex(get_SymConst_type(n), &bad));
756 case symconst_type_align:
757 fprintf(F, "SymC %s align", get_type_name_ex(get_SymConst_type(n), &bad));
759 case symconst_enum_const:
760 fprintf(F, "SymC %s enum", get_enumeration_name(get_SymConst_enum(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_default_proj(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 (get_Div_no_remainder(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));
836 fprintf(F, "%s[%s]", get_irn_opname(n), get_builtin_kind_name(get_Builtin_kind(n)));
841 fprintf(F, "%s", get_irn_opname(n));
848 * Dump the mode of a node n to a file F.
849 * Ignore modes that are "always known".
851 static int dump_node_mode(FILE *F, ir_node *n)
854 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
858 /* call the dump_node operation if available */
860 return ops->dump_node(n, F, dump_node_mode_txt);
862 /* default implementation */
863 iro = get_irn_opcode(n);
875 mode = get_irn_mode(n);
877 if (mode != NULL && mode != mode_BB && mode != mode_ANY && mode != mode_BAD &&
878 (mode != mode_T || iro == iro_Proj))
879 fprintf(F, "%s", get_mode_name_ex(mode, &bad));
885 * Dump the type of a node n to a file F if it's known.
887 static int dump_node_typeinfo(FILE *F, ir_node *n) {
890 if (opt_dump_analysed_type_info) {
891 if (get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_consistent ||
892 get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_inconsistent) {
893 ir_type *tp = get_irn_typeinfo_type(n);
894 if (tp != firm_none_type)
895 fprintf(F, "[%s] ", get_type_name_ex(tp, &bad));
903 typedef struct _pns_lookup {
904 long nr; /**< the proj number */
905 const char *name; /**< the name of the Proj */
908 typedef struct _proj_lookup {
909 ir_opcode code; /**< the opcode of the Proj predecessor */
910 unsigned num_data; /**< number of data entries */
911 const pns_lookup_t *data; /**< the data */
914 #define ARR_SIZE(a) (sizeof(a)/sizeof(a[0]))
916 /** the lookup table for Proj(Start) names */
917 static const pns_lookup_t start_lut[] = {
918 #define X(a) { pn_Start_##a, #a }
926 /** the lookup table for Proj(Cond) names */
927 static const pns_lookup_t cond_lut[] = {
928 #define X(a) { pn_Cond_##a, #a }
934 /** the lookup table for Proj(Call) names */
935 static const pns_lookup_t call_lut[] = {
936 #define X(a) { pn_Call_##a, #a }
946 /** the lookup table for Proj(Quot) names */
947 static const pns_lookup_t quot_lut[] = {
948 #define X(a) { pn_Quot_##a, #a }
956 /** the lookup table for Proj(DivMod) names */
957 static const pns_lookup_t divmod_lut[] = {
958 #define X(a) { pn_DivMod_##a, #a }
967 /** the lookup table for Proj(Div) names */
968 static const pns_lookup_t div_lut[] = {
969 #define X(a) { pn_Div_##a, #a }
977 /** the lookup table for Proj(Mod) names */
978 static const pns_lookup_t mod_lut[] = {
979 #define X(a) { pn_Mod_##a, #a }
987 /** the lookup table for Proj(Load) names */
988 static const pns_lookup_t load_lut[] = {
989 #define X(a) { pn_Load_##a, #a }
997 /** the lookup table for Proj(Store) names */
998 static const pns_lookup_t store_lut[] = {
999 #define X(a) { pn_Store_##a, #a }
1006 /** the lookup table for Proj(Alloc) names */
1007 static const pns_lookup_t alloc_lut[] = {
1008 #define X(a) { pn_Alloc_##a, #a }
1016 /** the lookup table for Proj(CopyB) names */
1017 static const pns_lookup_t copyb_lut[] = {
1018 #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 }
1037 /** the lookup table for Proj(Raise) names */
1038 static const pns_lookup_t raise_lut[] = {
1039 #define X(a) { pn_Raise_##a, #a }
1045 /** the lookup table for Proj(Bound) names */
1046 static const pns_lookup_t bound_lut[] = {
1047 #define X(a) { pn_Bound_##a, #a }
1055 /** the Proj lookup table */
1056 static const proj_lookup_t proj_lut[] = {
1057 #define E(a) ARR_SIZE(a), a
1058 { iro_Start, E(start_lut) },
1059 { iro_Cond, E(cond_lut) },
1060 { iro_Call, E(call_lut) },
1061 { iro_Quot, E(quot_lut) },
1062 { iro_DivMod, E(divmod_lut) },
1063 { iro_Div, E(div_lut) },
1064 { iro_Mod, E(mod_lut) },
1065 { iro_Load, E(load_lut) },
1066 { iro_Store, E(store_lut) },
1067 { iro_Alloc, E(alloc_lut) },
1068 { iro_CopyB, E(copyb_lut) },
1069 { iro_InstOf, E(instof_lut) },
1070 { iro_Raise, E(raise_lut) },
1071 { iro_Bound, E(bound_lut) }
1076 * Dump additional node attributes of some nodes to a file F.
1079 dump_node_nodeattr(FILE *F, ir_node *n)
1085 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1087 /* call the dump_node operation if available */
1089 return ops->dump_node(n, F, dump_node_nodeattr_txt);
1091 switch (get_irn_opcode(n)) {
1093 if (0 && get_interprocedural_view()) {
1094 fprintf(F, "%s ", get_ent_dump_name(get_irg_entity(current_ir_graph)));
1099 ir_fprintf(F, "%T ", get_Const_tarval(n));
1103 pred = get_Proj_pred(n);
1104 proj_nr = get_Proj_proj(n);
1106 code = get_irn_opcode(pred);
1108 if (code == iro_Cmp)
1109 fprintf(F, "%s ", get_pnc_string(get_Proj_proj(n)));
1110 else if (code == iro_Proj && get_irn_opcode(get_Proj_pred(pred)) == iro_Start)
1111 fprintf(F, "Arg %ld ", proj_nr);
1112 else if (code == iro_Cond && get_irn_mode(get_Cond_selector(pred)) != mode_b)
1113 fprintf(F, "%ld ", proj_nr);
1115 unsigned i, j, f = 0;
1117 for (i = 0; i < ARR_SIZE(proj_lut); ++i) {
1118 if (code == proj_lut[i].code) {
1119 for (j = 0; j < proj_lut[i].num_data; ++j) {
1120 if (proj_nr == proj_lut[i].data[j].nr) {
1121 fprintf(F, "%s ", proj_lut[i].data[j].name);
1130 fprintf(F, "%ld ", proj_nr);
1131 if (code == iro_Cond && get_Cond_jmp_pred(pred) != COND_JMP_PRED_NONE) {
1132 if (proj_nr == pn_Cond_false && get_Cond_jmp_pred(pred) == COND_JMP_PRED_FALSE)
1133 fprintf(F, "PRED ");
1134 if (proj_nr == pn_Cond_true && get_Cond_jmp_pred(pred) == COND_JMP_PRED_TRUE)
1135 fprintf(F, "PRED ");
1140 proj_nr = get_Filter_proj(n);
1141 if (! get_interprocedural_view()) {
1143 pred = get_Filter_pred(n);
1146 fprintf(F, "%ld ", proj_nr);
1149 fprintf(F, "%s ", get_ent_dump_name(get_Sel_entity(n)));
1152 fprintf(F, "(%s) ", get_type_name_ex(get_Cast_type(n), &bad));
1155 fprintf(F, "%s ", get_pnc_string(get_Confirm_cmp(n)));
1158 fprintf(F, "(%s) ", get_type_name_ex(get_CopyB_type(n), &bad));
1169 #include "execution_frequency.h"
1171 static void dump_node_ana_vals(FILE *F, ir_node *n) {
1175 #ifdef INTERPROCEDURAL_VIEW
1176 fprintf(F, " %lf*(%2.0lf + %2.0lf) = %2.0lf ",
1177 get_irn_exec_freq(n),
1178 get_irg_method_execution_frequency(get_irn_irg(n)),
1179 pow(5, get_irg_recursion_depth(get_irn_irg(n))),
1180 get_irn_exec_freq(n) * (get_irg_method_execution_frequency(get_irn_irg(n)) + pow(5, get_irg_recursion_depth(get_irn_irg(n))))
1186 /* Dumps a node label without the enclosing ". */
1187 int dump_node_label(FILE *F, ir_node *n) {
1190 bad |= dump_node_opcode(F, n);
1191 bad |= dump_node_mode(F, n);
1193 bad |= dump_node_typeinfo(F, n);
1194 bad |= dump_node_nodeattr(F, n);
1195 if(dump_node_idx_labels) {
1196 fprintf(F, "%ld:%d", get_irn_node_nr(n), get_irn_idx(n));
1198 fprintf(F, "%ld", get_irn_node_nr(n));
1205 * Dumps the attributes of a node n into the file F.
1206 * Currently this is only the color of a node.
1208 static void dump_node_vcgattr(FILE *F, ir_node *node, ir_node *local, int bad)
1214 print_vcg_color(F, ird_color_error);
1218 if (dump_node_vcgattr_hook)
1219 if (dump_node_vcgattr_hook(F, node, local))
1222 n = local ? local : node;
1224 if (overrule_nodecolor != ird_color_default_node) {
1225 print_vcg_color(F, overrule_nodecolor);
1229 mode = get_irn_mode(n);
1230 if(mode == mode_M) {
1231 print_vcg_color(F, ird_color_memory);
1234 if(mode == mode_X) {
1235 print_vcg_color(F, ird_color_controlflow);
1239 switch (get_irn_opcode(n)) {
1244 print_vcg_color(F, ird_color_anchor);
1247 print_vcg_color(F, ird_color_error);
1250 if (is_Block_dead(n))
1251 print_vcg_color(F, ird_color_dead_block_background);
1253 print_vcg_color(F, ird_color_block_background);
1256 print_vcg_color(F, ird_color_phi);
1259 print_vcg_color(F, ird_color_memory);
1263 print_vcg_color(F, ird_color_const);
1266 print_vcg_color(F, ird_color_proj);
1269 ir_op *op = get_irn_op(node);
1271 if(is_op_constlike(op)) {
1272 print_vcg_color(F, ird_color_const);
1273 } else if(is_op_uses_memory(op)) {
1274 print_vcg_color(F, ird_color_uses_memory);
1275 } else if(is_op_cfopcode(op) || is_op_forking(op)) {
1276 print_vcg_color(F, ird_color_controlflow);
1278 PRINT_DEFAULT_NODE_ATTR;
1284 /* Adds a new node info dumper callback. */
1285 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data)
1287 hook_entry_t *info = XMALLOC(hook_entry_t);
1289 info->hook._hook_node_info = cb;
1290 info->context = data;
1291 register_hook(hook_node_info, info);
1296 /* Remove a previously added info dumper callback. */
1297 void dump_remv_node_info_callback(void *handle)
1299 hook_entry_t *info = handle;
1300 unregister_hook(hook_node_info, info);
1305 * Dump the node information of a node n to a file F.
1307 static inline int dump_node_info(FILE *F, ir_node *n)
1310 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1312 fprintf(F, " info1: \"");
1313 bad = dump_irnode_to_file(F, n);
1314 /* call the dump_node operation if available */
1316 bad = ops->dump_node(n, F, dump_node_info_txt);
1318 /* allow additional info to be added */
1319 hook_node_info(F, n);
1325 static inline int is_constlike_node(const ir_node *node)
1327 const ir_op *op = get_irn_op(node);
1328 return is_op_constlike(op);
1332 /** outputs the predecessors of n, that are constants, local. I.e.,
1333 generates a copy of the constant predecessors for each node called with. */
1334 static void dump_const_node_local(FILE *F, ir_node *n) {
1336 if (!get_opt_dump_const_local()) return;
1338 /* Use visited flag to avoid outputting nodes twice.
1339 initialize it first. */
1340 for (i = 0; i < get_irn_arity(n); i++) {
1341 ir_node *con = get_irn_n(n, i);
1342 if (is_constlike_node(con)) {
1343 set_irn_visited(con, get_irg_visited(current_ir_graph) - 1);
1347 for (i = 0; i < get_irn_arity(n); i++) {
1348 ir_node *con = get_irn_n(n, i);
1349 if (is_constlike_node(con) && !irn_visited(con)) {
1352 mark_irn_visited(con);
1353 /* Generate a new name for the node by appending the names of
1355 fprintf(F, "node: {title: "); PRINT_CONSTID(n, con);
1356 fprintf(F, " label: \"");
1357 bad |= dump_node_label(F, con);
1359 bad |= dump_node_info(F, con);
1360 dump_node_vcgattr(F, n, con, bad);
1366 /** If the block of an edge is a const_like node, dump it local with an edge */
1367 static void dump_const_block_local(FILE *F, ir_node *n) {
1370 if (!get_opt_dump_const_local()) return;
1372 blk = get_nodes_block(n);
1373 if (is_constlike_node(blk)) {
1376 /* Generate a new name for the node by appending the names of
1378 fprintf(F, "node: {title: \""); PRINT_CONSTBLKID(n, blk);
1379 fprintf(F, "\" label: \"");
1380 bad |= dump_node_label(F, blk);
1382 bad |= dump_node_info(F, blk);
1383 dump_node_vcgattr(F, n, blk, bad);
1386 fprintf(F, "edge: { sourcename: \"");
1388 fprintf(F, "\" targetname: \""); PRINT_CONSTBLKID(n,blk);
1390 if (dump_edge_vcgattr_hook) {
1392 if (dump_edge_vcgattr_hook(F, n, -1)) {
1396 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1401 fprintf(F, "\" " BLOCK_EDGE_ATTR "}\n");
1406 * prints the error message of a node to a file F as info2.
1408 static void print_node_error(FILE *F, const char *err_msg)
1413 fprintf(F, " info2: \"%s\"", err_msg);
1417 * prints debug messages of a node to file F as info3.
1419 static void print_dbg_info(FILE *F, dbg_info *dbg)
1423 if (__dbg_info_snprint) {
1425 if (__dbg_info_snprint(buf, sizeof(buf), dbg) > 0)
1426 fprintf(F, " info3: \"%s\"\n", buf);
1433 static void dump_node(FILE *F, ir_node *n)
1438 if (get_opt_dump_const_local() && is_constlike_node(n))
1441 /* dump this node */
1442 fputs("node: {title: \"", F);
1446 fputs(" label: \"", F);
1447 bad = ! irn_vrfy_irg_dump(n, current_ir_graph, &p);
1448 bad |= dump_node_label(F, n);
1449 dump_node_ana_vals(F, n);
1450 //dump_node_ana_info(F, n);
1453 if (get_op_flags(get_irn_op(n)) & irop_flag_dump_noinput) {
1454 //fputs(" node_class:23", F);
1457 bad |= dump_node_info(F, n);
1458 print_node_error(F, p);
1459 print_dbg_info(F, get_irn_dbg_info(n));
1460 dump_node_vcgattr(F, n, NULL, bad);
1462 dump_const_node_local(F, n);
1464 if(dump_node_edge_hook)
1465 dump_node_edge_hook(F, n);
1468 /** dump the edge to the block this node belongs to */
1470 dump_ir_block_edge(FILE *F, ir_node *n) {
1471 if (get_opt_dump_const_local() && is_constlike_node(n)) return;
1472 if (is_no_Block(n)) {
1473 ir_node *block = get_nodes_block(n);
1475 if (get_opt_dump_const_local() && is_constlike_node(block)) {
1476 dump_const_block_local(F, n);
1478 fprintf(F, "edge: { sourcename: \"");
1480 fprintf(F, "\" targetname: ");
1481 fprintf(F, "\""); PRINT_NODEID(block); fprintf(F, "\"");
1483 if (dump_edge_vcgattr_hook) {
1485 if (dump_edge_vcgattr_hook(F, n, -1)) {
1489 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1494 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1500 print_data_edge_vcgattr(FILE *F, ir_node *from, int to) {
1502 * do not use get_nodes_block() here, will fail
1503 * if the irg is not pinned.
1505 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1506 fprintf(F, INTRA_DATA_EDGE_ATTR);
1508 fprintf(F, INTER_DATA_EDGE_ATTR);
1512 print_mem_edge_vcgattr(FILE *F, ir_node *from, int to) {
1514 * do not use get_nodes_block() here, will fail
1515 * if the irg is not pinned.
1517 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1518 fprintf(F, INTRA_MEM_EDGE_ATTR);
1520 fprintf(F, INTER_MEM_EDGE_ATTR);
1523 /** Print the vcg attributes for the edge from node from to it's to's input */
1524 static void print_edge_vcgattr(FILE *F, ir_node *from, int to) {
1527 if (dump_edge_vcgattr_hook)
1528 if (dump_edge_vcgattr_hook(F, from, to))
1531 if (dump_backedge_information_flag && is_backedge(from, to))
1532 fprintf(F, BACK_EDGE_ATTR);
1534 switch (get_irn_opcode(from)) {
1536 fprintf(F, CF_EDGE_ATTR);
1538 case iro_Start: break;
1541 if (get_irn_mode(get_End_keepalive(from, to)) == mode_BB)
1542 fprintf(F, KEEP_ALIVE_CF_EDGE_ATTR);
1544 fprintf(F, KEEP_ALIVE_DF_EDGE_ATTR);
1548 if (is_Proj(from)) {
1549 if (get_irn_mode(from) == mode_M)
1550 print_mem_edge_vcgattr(F, from, to);
1551 else if (get_irn_mode(from) == mode_X)
1552 fprintf(F, CF_EDGE_ATTR);
1554 print_data_edge_vcgattr(F, from, to);
1556 else if (get_irn_mode(get_irn_n(from, to)) == mode_M)
1557 print_mem_edge_vcgattr(F, from, to);
1558 else if (get_irn_mode(get_irn_n(from, to)) == mode_X)
1559 fprintf(F, CF_EDGE_ATTR);
1561 print_data_edge_vcgattr(F, from, to);
1565 /** dump edges to our inputs */
1566 static void dump_ir_data_edges(FILE *F, ir_node *n) {
1568 ir_visited_t visited = get_irn_visited(n);
1570 if (!dump_keepalive && is_End(n)) {
1571 /* the End node has only keep-alive edges */
1575 /* dump the dependency edges. */
1576 num = get_irn_deps(n);
1577 for (i = 0; i < num; ++i) {
1578 ir_node *dep = get_irn_dep(n, i);
1581 fprintf(F, "edge: {sourcename: \"");
1583 fprintf(F, "\" targetname: ");
1584 if ((get_opt_dump_const_local()) && is_constlike_node(dep)) {
1585 PRINT_CONSTID(n, dep);
1591 fprintf(F, " label: \"%d\" ", i);
1592 fprintf(F, " color: darkgreen}\n");
1596 num = get_irn_arity(n);
1597 for (i = 0; i < num; i++) {
1598 ir_node *pred = get_irn_n(n, i);
1601 if ((get_interprocedural_view() && get_irn_visited(pred) < visited))
1602 continue; /* pred not dumped */
1604 if (dump_backedge_information_flag && is_backedge(n, i))
1605 fprintf(F, "backedge: {sourcename: \"");
1607 fprintf(F, "edge: {sourcename: \"");
1609 fprintf(F, "\" targetname: ");
1610 if ((get_opt_dump_const_local()) && is_constlike_node(pred)) {
1611 PRINT_CONSTID(n, pred);
1613 fprintf(F, "\""); PRINT_NODEID(pred); fprintf(F, "\"");
1615 fprintf(F, " label: \"%d\" ", i);
1616 print_edge_vcgattr(F, n, i);
1620 if (dump_macro_block_edges && is_Block(n)) {
1621 ir_node *mb = get_Block_MacroBlock(n);
1622 fprintf(F, "edge: {sourcename: \"");
1624 fprintf(F, "\" targetname: \"");
1626 fprintf(F, "\" label: \"mb\" " MACROBLOCK_EDGE_ATTR);
1635 dump_ir_edges(FILE *F, ir_node *n) {
1636 const ir_edge_t *edge;
1639 foreach_out_edge(n, edge) {
1640 ir_node *succ = get_edge_src_irn(edge);
1642 fprintf(F, "edge: {sourcename: \"");
1644 fprintf(F, "\" targetname: \"");
1648 fprintf(F, " label: \"%d\" ", i);
1649 fprintf(F, OUT_EDGE_ATTR);
1656 /** Dumps a node and its edges but not the block edge */
1657 static void dump_node_wo_blockedge(ir_node *n, void *env) {
1660 dump_ir_data_edges(F, n);
1663 /** Dumps a node and its edges. */
1664 static void dump_whole_node(ir_node *n, void *env) {
1666 dump_node_wo_blockedge(n, env);
1667 if (!node_floats(n))
1668 dump_ir_block_edge(F, n);
1669 if (dump_new_edges_flag && edges_activated(current_ir_graph))
1670 dump_ir_edges(F, n);
1673 /** Dumps a const-like node. */
1674 static void dump_const_node(ir_node *n, void *env) {
1675 if (is_Block(n)) return;
1676 dump_node_wo_blockedge(n, env);
1679 /***********************************************************************/
1680 /* the following routines dump the nodes/irgs bracketed to graphs. */
1681 /***********************************************************************/
1683 /** Dumps a constant expression as entity initializer, array bound ...
1685 static void dump_const_expression(FILE *F, ir_node *value) {
1686 ir_graph *rem = current_ir_graph;
1687 int rem_dump_const_local = dump_const_local;
1688 dump_const_local = 0;
1689 current_ir_graph = get_const_code_irg();
1690 irg_walk(value, dump_const_node, NULL, F);
1691 /* Decrease visited flag so that we walk with the same flag for the next
1692 expression. This guarantees that we don't dump the same node twice,
1693 as for const expressions cse is performed to save memory. */
1694 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph) -1);
1695 current_ir_graph = rem;
1696 dump_const_local = rem_dump_const_local;
1699 /** Dump a block as graph containing its nodes.
1701 * Expects to find nodes belonging to the block as list in its
1703 * Dumps the edges of all nodes including itself. */
1704 static void dump_whole_block(FILE *F, ir_node *block) {
1706 ird_color_t color = ird_color_block_background;
1708 assert(is_Block(block));
1710 fprintf(F, "graph: { title: \"");
1711 PRINT_NODEID(block);
1712 fprintf(F, "\" label: \"");
1713 dump_node_label(F, block);
1715 /* colorize blocks */
1716 if (! get_Block_matured(block))
1717 color = ird_color_block_background;
1718 if (is_Block_dead(block))
1719 color = ird_color_dead_block_background;
1721 fprintf(F, "\" status:clustered ");
1722 print_vcg_color(F, color);
1725 /* yComp can show attributes for blocks, XVCG parses but ignores them */
1726 dump_node_info(F, block);
1727 print_dbg_info(F, get_irn_dbg_info(block));
1729 /* dump the blocks edges */
1730 dump_ir_data_edges(F, block);
1732 if (dump_block_edge_hook)
1733 dump_block_edge_hook(F, block);
1735 /* dump the nodes that go into the block */
1736 for (node = ird_get_irn_link(block); node; node = ird_get_irn_link(node)) {
1738 dump_ir_data_edges(F, node);
1741 /* Close the vcg information for the block */
1743 dump_const_node_local(F, block);
1747 /** dumps a graph block-wise. Expects all blockless nodes in arr in irgs link.
1748 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1750 dump_block_graph(FILE *F, ir_graph *irg) {
1752 ir_graph *rem = current_ir_graph;
1753 ir_node **arr = ird_get_irg_link(irg);
1754 current_ir_graph = irg;
1756 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1757 ir_node * node = arr[i];
1758 if (is_Block(node)) {
1759 /* Dumps the block and all the nodes in the block, which are to
1760 be found in Block->link. */
1761 dump_whole_block(F, node);
1763 /* Nodes that are not in a Block. */
1765 if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
1766 dump_const_block_local(F, node);
1768 dump_ir_data_edges(F, node);
1770 if (dump_new_edges_flag && edges_activated(irg))
1771 dump_ir_edges(F, node);
1774 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1775 dump_loop_nodes_into_graph(F, irg);
1777 current_ir_graph = rem;
1781 * Dump the info for an irg.
1782 * Parsed by XVCG but not shown. use yComp.
1784 static void dump_graph_info(FILE *F, ir_graph *irg) {
1785 fprintf(F, "info1: \"");
1786 dump_entity_to_file(F, get_irg_entity(irg), dump_verbosity_entattrs | dump_verbosity_entconsts);
1790 /** Dumps an irg as a graph clustered by block nodes.
1791 * If interprocedural view edges can point to nodes out of this graph.
1793 static void dump_graph_from_list(FILE *F, ir_graph *irg) {
1794 ir_entity *ent = get_irg_entity(irg);
1796 fprintf(F, "graph: { title: \"");
1798 fprintf(F, "\" label: \"%s\" status:clustered color:%s \n",
1799 get_ent_dump_name(ent), color_names[ird_color_prog_background]);
1801 dump_graph_info(F, irg);
1802 print_dbg_info(F, get_entity_dbg_info(ent));
1804 dump_block_graph(F, irg);
1806 /* Close the vcg information for the irg */
1807 fprintf(F, "}\n\n");
1810 /** dumps a graph extended block-wise. Expects all blockless nodes in arr in irgs link.
1811 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1813 dump_extblock_graph(FILE *F, ir_graph *irg) {
1815 ir_graph *rem = current_ir_graph;
1816 ir_extblk **arr = ird_get_irg_link(irg);
1817 current_ir_graph = irg;
1819 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1820 ir_extblk *extbb = arr[i];
1821 ir_node *leader = get_extbb_leader(extbb);
1824 fprintf(F, "graph: { title: \"");
1825 PRINT_EXTBBID(leader);
1826 fprintf(F, "\" label: \"ExtBB %ld\" status:clustered color:lightgreen\n",
1827 get_irn_node_nr(leader));
1829 for (j = ARR_LEN(extbb->blks) - 1; j >= 0; --j) {
1830 ir_node * node = extbb->blks[j];
1831 if (is_Block(node)) {
1832 /* Dumps the block and all the nodes in the block, which are to
1833 be found in Block->link. */
1834 dump_whole_block(F, node);
1836 /* Nodes that are not in a Block. */
1838 if (is_Bad(get_nodes_block(node)) && !node_floats(node)) {
1839 dump_const_block_local(F, node);
1841 dump_ir_data_edges(F, node);
1847 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1848 dump_loop_nodes_into_graph(F, irg);
1850 current_ir_graph = rem;
1855 /*******************************************************************/
1856 /* Basic type and entity nodes and edges. */
1857 /*******************************************************************/
1859 /** dumps the edges between nodes and their type or entity attributes. */
1860 static void dump_node2type_edges(ir_node *n, void *env)
1865 switch (get_irn_opcode(n)) {
1867 /* @@@ some consts have an entity */
1870 if (SYMCONST_HAS_TYPE(get_SymConst_kind(n)))
1871 print_node_type_edge(F,n,get_SymConst_type(n),NODE2TYPE_EDGE_ATTR);
1874 print_node_ent_edge(F,n,get_Sel_entity(n),NODE2TYPE_EDGE_ATTR);
1877 print_node_type_edge(F,n,get_Call_type(n),NODE2TYPE_EDGE_ATTR);
1880 print_node_type_edge(F,n,get_Alloc_type(n),NODE2TYPE_EDGE_ATTR);
1883 print_node_type_edge(F,n,get_Free_type(n),NODE2TYPE_EDGE_ATTR);
1886 print_node_type_edge(F,n,get_Cast_type(n),NODE2TYPE_EDGE_ATTR);
1894 static int print_type_info(FILE *F, ir_type *tp) {
1897 if (get_type_state(tp) == layout_undefined) {
1898 fprintf(F, "state: layout_undefined\n");
1900 fprintf(F, "state: layout_fixed,\n");
1902 if (get_type_mode(tp))
1903 fprintf(F, "mode: %s,\n", get_mode_name_ex(get_type_mode(tp), &bad));
1904 fprintf(F, "size: %db,\n", get_type_size_bits(tp));
1909 static void print_typespecific_info(FILE *F, ir_type *tp) {
1910 switch (get_type_tpop_code(tp)) {
1912 fprintf(F, "peculiarity: %s\n", get_peculiarity_string(get_class_peculiarity(tp)));
1917 fprintf(F, "variadicity: %s\n", get_variadicity_name(get_method_variadicity(tp)));
1918 fprintf(F, "params: %d\n", get_method_n_params(tp));
1919 fprintf(F, "results: %d\n", get_method_n_ress(tp));
1925 case tpo_enumeration:
1937 static void print_typespecific_vcgattr(FILE *F, ir_type *tp) {
1938 switch (get_type_tpop_code(tp)) {
1940 if (peculiarity_existent == get_class_peculiarity(tp))
1941 fprintf(F, " " TYPE_CLASS_NODE_ATTR);
1943 fprintf(F, " " TYPE_DESCRIPTION_NODE_ATTR);
1946 fprintf(F, " " TYPE_METH_NODE_ATTR);
1954 case tpo_enumeration:
1966 int dump_type_node(FILE *F, ir_type *tp)
1970 fprintf(F, "node: {title: ");
1972 fprintf(F, " label: \"%s %s\"", get_type_tpop_name(tp), get_type_name_ex(tp, &bad));
1973 fprintf(F, " info1: \"");
1975 bad |= print_type_info(F, tp);
1976 print_typespecific_info(F, tp);
1978 dump_type_to_file(F, tp, dump_verbosity_max);
1981 print_dbg_info(F, get_type_dbg_info(tp));
1982 print_typespecific_vcgattr(F, tp);
1989 void dump_entity_node(FILE *F, ir_entity *ent)
1991 fprintf(F, "node: {title: \"");
1992 PRINT_ENTID(ent); fprintf(F, "\"");
1993 fprintf(F, DEFAULT_TYPE_ATTRIBUTE);
1994 fprintf(F, "label: ");
1995 fprintf(F, "\"%s\" ", get_ent_dump_name(ent));
1997 print_vcg_color(F, ird_color_entity);
1998 fprintf(F, "\n info1: \"");
2000 dump_entity_to_file(F, ent, dump_verbosity_entattrs | dump_verbosity_entconsts);
2003 print_dbg_info(F, get_entity_dbg_info(ent));
2007 static void dump_enum_item(FILE *F, ir_type *tp, int pos)
2010 ir_enum_const *ec = get_enumeration_const(tp, pos);
2011 ident *id = get_enumeration_nameid(ec);
2012 tarval *tv = get_enumeration_value(ec);
2015 tarval_snprintf(buf, sizeof(buf), tv);
2017 strncpy(buf, "<not set>", sizeof(buf));
2018 fprintf(F, "node: {title: \"");
2019 PRINT_ITEMID(tp, pos); fprintf(F, "\"");
2020 fprintf(F, DEFAULT_ENUM_ITEM_ATTRIBUTE);
2021 fprintf(F, "label: ");
2022 fprintf(F, "\"enum item %s\" " ENUM_ITEM_NODE_ATTR, get_id_str(id));
2023 fprintf(F, "\n info1: \"value: %s\"}\n", buf);
2027 * Dumps a new style initializer.
2029 static void dump_entity_initializer(FILE *F, const ir_entity *ent) {
2035 /** Dumps a type or entity and it's edges. */
2036 static void dump_type_info(type_or_ent tore, void *env) {
2038 int i = 0; /* to shutup gcc */
2040 /* dump this type or entity */
2042 switch (get_kind(tore.ent)) {
2044 ir_entity *ent = tore.ent;
2047 dump_entity_node(F, ent);
2049 /* skip this to reduce graph. Member edge of type is parallel to this edge. *
2050 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2051 ENT_OWN_EDGE_ATTR "}\n", ent, get_entity_owner(ent));*/
2052 print_ent_type_edge(F,ent, get_entity_type(ent), ENT_TYPE_EDGE_ATTR);
2053 if (is_Class_type(get_entity_owner(ent))) {
2054 for (i = get_entity_n_overwrites(ent) - 1; i >= 0; --i)
2055 print_ent_ent_edge(F,ent, get_entity_overwrites(ent, i), 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2057 /* attached subgraphs */
2058 if (const_entities && (get_entity_variability(ent) != variability_uninitialized)) {
2059 if (is_atomic_entity(ent)) {
2060 value = get_atomic_ent_value(ent);
2062 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2063 /* DDMN(value); $$$ */
2064 dump_const_expression(F, value);
2067 if (is_compound_entity(ent)) {
2068 if (has_entity_initializer(ent)) {
2069 /* new style initializers */
2070 dump_entity_initializer(F, ent);
2072 /* old style compound entity values */
2073 for (i = get_compound_ent_n_values(ent) - 1; i >= 0; --i) {
2074 value = get_compound_ent_value(ent, i);
2076 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2077 dump_const_expression(F, value);
2078 print_ent_ent_edge(F, ent, get_compound_ent_value_member(ent, i), 0, -1, ENT_CORR_EDGE_ATTR, i);
2080 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2081 ENT_CORR_EDGE_ATTR "}\n", GET_ENTID(ent),
2082 get_compound_ent_value_member(ent, i), i);
2092 ir_type *tp = tore.typ;
2093 dump_type_node(F, tp);
2094 /* and now the edges */
2095 switch (get_type_tpop_code(tp)) {
2097 for (i = get_class_n_supertypes(tp) - 1; i >= 0; --i)
2098 print_type_type_edge(F, tp, get_class_supertype(tp, i), TYPE_SUPER_EDGE_ATTR);
2099 for (i = get_class_n_members(tp) - 1; i >= 0; --i)
2100 print_type_ent_edge(F, tp, get_class_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
2103 for (i = get_struct_n_members(tp) - 1; i >= 0; --i)
2104 print_type_ent_edge(F, tp, get_struct_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
2107 for (i = get_method_n_params(tp) - 1; i >= 0; --i)
2108 print_type_type_edge(F, tp, get_method_param_type(tp, i), METH_PAR_EDGE_ATTR,i);
2109 for (i = get_method_n_ress(tp) - 1; i >= 0; --i)
2110 print_type_type_edge(F, tp, get_method_res_type(tp, i), METH_RES_EDGE_ATTR,i);
2113 for (i = get_union_n_members(tp) - 1; i >= 0; --i)
2114 print_type_ent_edge(F, tp, get_union_member(tp, i), UNION_EDGE_ATTR);
2117 print_type_type_edge(F, tp, get_array_element_type(tp), ARR_ELT_TYPE_EDGE_ATTR);
2118 print_type_ent_edge(F, tp, get_array_element_entity(tp), ARR_ENT_EDGE_ATTR);
2119 for (i = get_array_n_dimensions(tp) - 1; i >= 0; --i) {
2120 ir_node *upper = get_array_upper_bound(tp, i);
2121 ir_node *lower = get_array_lower_bound(tp, i);
2122 print_node_type_edge(F, upper, tp, "label: \"upper %d\"", get_array_order(tp, i));
2123 print_node_type_edge(F, lower, tp, "label: \"lower %d\"", get_array_order(tp, i));
2124 dump_const_expression(F, upper);
2125 dump_const_expression(F, lower);
2128 case tpo_enumeration:
2129 for (i = get_enumeration_n_enums(tp) - 1; i >= 0; --i) {
2130 dump_enum_item(F, tp, i);
2131 print_enum_item_edge(F, tp, i, "label: \"item %d\"", i);
2135 print_type_type_edge(F, tp, get_pointer_points_to_type(tp), PTR_PTS_TO_EDGE_ATTR);
2142 break; /* case k_type */
2145 printf(" *** irdump, dump_type_info(l.%i), faulty type.\n", __LINE__);
2146 } /* switch kind_or_entity */
2149 typedef struct _h_env {
2154 /** For dumping class hierarchies.
2155 * Dumps a class type node and a superclass edge.
2156 * If env->dump_ent dumps entities of classes and overwrites edges.
2159 dump_class_hierarchy_node(type_or_ent tore, void *ctx) {
2162 int i = 0; /* to shutup gcc */
2164 /* dump this type or entity */
2165 switch (get_kind(tore.ent)) {
2167 ir_entity *ent = tore.ent;
2168 if (get_entity_owner(ent) == get_glob_type()) break;
2169 if (!is_Method_type(get_entity_type(ent)))
2171 if (env->dump_ent && is_Class_type(get_entity_owner(ent))) {
2173 dump_entity_node(F, ent);
2175 print_type_ent_edge(F, get_entity_owner(ent), ent, TYPE_MEMBER_EDGE_ATTR);
2176 for (i = get_entity_n_overwrites(ent) - 1; i >= 0; --i)
2177 print_ent_ent_edge(F, get_entity_overwrites(ent, i), ent, 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2182 ir_type *tp = tore.typ;
2183 if (tp == get_glob_type())
2185 switch (get_type_tpop_code(tp)) {
2187 dump_type_node(F, tp);
2188 /* and now the edges */
2189 for (i = get_class_n_supertypes(tp) - 1; i >= 0; --i) {
2190 print_type_type_edge(F,tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2195 break; /* case k_type */
2198 printf(" *** irdump, dump_class_hierarchy_node(l.%i), faulty type.\n", __LINE__);
2199 } /* switch kind_or_entity */
2202 /*******************************************************************/
2203 /* dump analysis information that is expressed in graph terms. */
2204 /*******************************************************************/
2206 /* dump out edges */
2208 dump_out_edge(ir_node *n, void *env) {
2211 for (i = get_irn_n_outs(n) - 1; i >= 0; --i) {
2212 ir_node *succ = get_irn_out(n, i);
2214 fprintf(F, "edge: {sourcename: \"");
2216 fprintf(F, "\" targetname: \"");
2218 fprintf(F, "\" color: red linestyle: dashed");
2224 dump_loop_label(FILE *F, ir_loop *loop) {
2225 fprintf(F, "loop %d, %d sons, %d nodes",
2226 get_loop_depth(loop), get_loop_n_sons(loop), get_loop_n_nodes(loop));
2229 static inline void dump_loop_info(FILE *F, ir_loop *loop) {
2230 fprintf(F, " info1: \"");
2231 fprintf(F, " loop nr: %d", get_loop_loop_nr(loop));
2232 #ifdef DEBUG_libfirm /* GL @@@ debug analyses */
2233 fprintf(F, "\n The loop was analyzed %d times.", PTR_TO_INT(get_loop_link(loop)));
2239 dump_loop_node(FILE *F, ir_loop *loop) {
2240 fprintf(F, "node: {title: \"");
2242 fprintf(F, "\" label: \"");
2243 dump_loop_label(F, loop);
2245 dump_loop_info(F, loop);
2250 dump_loop_node_edge(FILE *F, ir_loop *loop, int i) {
2252 fprintf(F, "edge: {sourcename: \"");
2254 fprintf(F, "\" targetname: \"");
2255 PRINT_NODEID(get_loop_node(loop, i));
2256 fprintf(F, "\" color: green");
2261 dump_loop_son_edge(FILE *F, ir_loop *loop, int i) {
2263 fprintf(F, "edge: {sourcename: \"");
2265 fprintf(F, "\" targetname: \"");
2266 PRINT_LOOPID(get_loop_son(loop, i));
2267 fprintf(F, "\" color: darkgreen label: \"%d\"}\n",
2268 get_loop_element_pos(loop, get_loop_son(loop, i)));
2272 void dump_loops(FILE *F, ir_loop *loop) {
2274 /* dump this loop node */
2275 dump_loop_node(F, loop);
2277 /* dump edges to nodes in loop -- only if it is a real loop */
2278 if (get_loop_depth(loop) != 0) {
2279 for (i = get_loop_n_nodes(loop) - 1; i >= 0; --i) {
2280 dump_loop_node_edge(F, loop, i);
2283 for (i = get_loop_n_sons(loop) - 1; i >= 0; --i) {
2284 dump_loops(F, get_loop_son(loop, i));
2285 dump_loop_son_edge(F, loop, i);
2290 void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg) {
2291 ir_loop *loop = get_irg_loop(irg);
2294 ir_graph *rem = current_ir_graph;
2295 current_ir_graph = irg;
2297 dump_loops(F, loop);
2299 current_ir_graph = rem;
2305 * dumps the VCG header
2307 void dump_vcg_header(FILE *F, const char *name, const char *layout, const char *orientation) {
2313 label = edge_label ? "yes" : "no";
2314 if (! layout) layout = "Compilergraph";
2315 if (!orientation) orientation = "bottom_to_top";
2319 "graph: { title: \"ir graph of %s\"\n"
2320 "display_edge_labels: %s\n"
2321 "layoutalgorithm: mindepth //$ \"%s\"\n"
2322 "manhattan_edges: yes\n"
2323 "port_sharing: no\n"
2325 "classname 1: \"intrablock Data\"\n"
2326 "classname 2: \"Block\"\n"
2327 "classname 3: \"Entity type\"\n"
2328 "classname 4: \"Entity owner\"\n"
2329 "classname 5: \"Method Param\"\n"
2330 "classname 6: \"Method Res\"\n"
2331 "classname 7: \"Super\"\n"
2332 "classname 8: \"Union\"\n"
2333 "classname 9: \"Points-to\"\n"
2334 "classname 10: \"Array Element Type\"\n"
2335 "classname 11: \"Overwrites\"\n"
2336 "classname 12: \"Member\"\n"
2337 "classname 13: \"Control Flow\"\n"
2338 "classname 14: \"intrablock Memory\"\n"
2339 "classname 15: \"Dominators\"\n"
2340 "classname 16: \"interblock Data\"\n"
2341 "classname 17: \"interblock Memory\"\n"
2342 "classname 18: \"Exception Control Flow for Interval Analysis\"\n"
2343 "classname 19: \"Postdominators\"\n"
2344 "classname 20: \"Keep Alive\"\n"
2345 "classname 21: \"Out Edges\"\n"
2346 "classname 22: \"Macro Block Edges\"\n"
2347 //"classname 23: \"NoInput Nodes\"\n"
2348 "infoname 1: \"Attribute\"\n"
2349 "infoname 2: \"Verification errors\"\n"
2350 "infoname 3: \"Debug info\"\n",
2351 name, label, layout, orientation);
2353 for (i = 0; i < ird_color_count; ++i) {
2354 if (color_rgb[i] != NULL) {
2355 fprintf(F, "colorentry %s: %s\n", color_names[i], color_rgb[i]);
2358 fprintf(F, "\n"); /* a separator */
2364 * @param irg The graph to be dumped
2365 * @param suffix1 first filename suffix
2366 * @param suffix2 second filename suffix
2368 FILE *vcg_open(ir_graph *irg, const char *suffix1, const char *suffix2) {
2370 const char *nm = get_irg_dump_name(irg);
2371 int len = strlen(nm), i, j;
2372 char *fname; /* filename to put the vcg information in */
2374 if (!suffix1) suffix1 = "";
2375 if (!suffix2) suffix2 = "";
2377 /* open file for vcg graph */
2378 fname = XMALLOCN(char, len * 2 + strlen(suffix1) + strlen(suffix2) + 5);
2380 /* strncpy (fname, nm, len); */ /* copy the filename */
2382 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2384 fname[j] = '@'; j++; fname[j] = '1'; j++;
2385 } else if (nm[i] == '@') {
2386 fname[j] = '@'; j++; fname[j] = '2'; j++;
2388 fname[j] = nm[i]; j++;
2392 strcat(fname, suffix1); /* append file suffix */
2393 strcat(fname, suffix2); /* append file suffix */
2394 strcat(fname, ".vcg"); /* append the .vcg suffix */
2396 /* vcg really expect only a <CR> at end of line, so
2397 * the "b"inary mode is what you mean (and even needed for Win32)
2399 F = fopen(fname, "wb"); /* open file for writing */
2411 * @param name prefix file name
2412 * @param suffix filename suffix
2414 FILE *vcg_open_name(const char *name, const char *suffix) {
2416 char *fname; /* filename to put the vcg information in */
2417 int i, j, len = strlen(name);
2419 if (!suffix) suffix = "";
2421 /** open file for vcg graph */
2422 fname = XMALLOCN(char, len * 2 + 5 + strlen(suffix));
2423 /* strcpy (fname, name);*/ /* copy the filename */
2425 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2426 if (name[i] == '/') {
2427 fname[j] = '@'; j++; fname[j] = '1'; j++;
2428 } else if (name[i] == '@') {
2429 fname[j] = '@'; j++; fname[j] = '2'; j++;
2431 fname[j] = name[i]; j++;
2435 strcat(fname, suffix);
2436 strcat(fname, ".vcg"); /* append the .vcg suffix */
2438 /* vcg really expect only a <CR> at end of line, so
2439 * the "b"inary mode is what you mean (and even needed for Win32)
2441 F = fopen(fname, "wb"); /* open file for writing */
2451 * Dumps the vcg file footer
2453 void dump_vcg_footer(FILE *F) {
2457 /************************************************************************/
2458 /************************************************************************/
2459 /* Routines that dump all or parts of the firm representation to a file */
2460 /************************************************************************/
2461 /************************************************************************/
2463 /************************************************************************/
2464 /* Dump ir graphs, different formats and additional information. */
2465 /************************************************************************/
2467 typedef void (*do_dump_graph_func) (ir_graph *irg, FILE *out);
2469 static void do_dump(ir_graph *irg, const char *suffix, const char *suffix_ip,
2470 const char *suffix_nonip, do_dump_graph_func dump_func)
2474 const char *suffix1;
2476 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2479 rem = current_ir_graph;
2480 current_ir_graph = irg;
2481 if (get_interprocedural_view())
2482 suffix1 = suffix_ip;
2484 suffix1 = suffix_nonip;
2485 current_ir_graph = rem;
2487 out = vcg_open(irg, suffix, suffix1);
2489 dump_func(irg, out);
2494 void dump_ir_graph_file(ir_graph *irg, FILE *out)
2496 if (dump_backedge_information_flag
2497 && get_irg_loopinfo_state(irg) != loopinfo_consistent) {
2498 construct_backedges(irg);
2501 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2503 /* call the dump graph hook */
2504 if (dump_ir_graph_hook) {
2505 if (dump_ir_graph_hook(out, irg)) {
2510 /* walk over the graph */
2511 /* dump_whole_node must be called in post visiting predecessors */
2512 ird_walk_graph(irg, NULL, dump_whole_node, out);
2514 /* dump the out edges in a separate walk */
2515 if ((dump_out_edge_flag) && (get_irg_outs_state(irg) != outs_none)) {
2516 irg_out_walk(get_irg_start(irg), dump_out_edge, NULL, out);
2519 dump_vcg_footer(out);
2522 /** Routine to dump a graph, blocks as conventional nodes. */
2523 void dump_ir_graph(ir_graph *irg, const char *suffix )
2525 do_dump(irg, suffix, "-pure-ip", "-pure", dump_ir_graph_file);
2528 void dump_ir_block_graph_file(ir_graph *irg, FILE *out)
2532 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2534 construct_block_lists(irg);
2537 * If we are in the interprocedural view, we dump not
2538 * only the requested irg but also all irgs that can be reached
2541 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2542 ir_graph *g = get_irp_irg(i);
2543 ir_node **arr = ird_get_irg_link(g);
2545 dump_graph_from_list(out, g);
2550 dump_vcg_footer(out);
2553 /* Dump a firm graph without explicit block nodes. */
2554 void dump_ir_block_graph(ir_graph *irg, const char *suffix)
2556 do_dump(irg, suffix, "-ip", "", dump_ir_block_graph_file);
2559 void dump_ir_extblock_graph_file(ir_graph *irg, FILE *F)
2562 ir_entity *ent = get_irg_entity(irg);
2564 if (get_irg_extblk_state(irg) != extblk_valid)
2567 dump_vcg_header(F, get_irg_dump_name(irg), NULL, NULL);
2569 construct_extblock_lists(irg);
2571 fprintf(F, "graph: { title: \"");
2573 fprintf(F, "\" label: \"%s\" status:clustered color: white \n",
2574 get_ent_dump_name(ent));
2576 dump_graph_info(F, irg);
2577 print_dbg_info(F, get_entity_dbg_info(ent));
2579 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2580 ir_graph *irg = get_irp_irg(i);
2581 list_tuple *lists = ird_get_irg_link(irg);
2584 /* dump the extended blocks first */
2585 if (ARR_LEN(lists->extbb_list)) {
2586 ird_set_irg_link(irg, lists->extbb_list);
2587 dump_extblock_graph(F, irg);
2590 /* we may have blocks without extended blocks, bad for instance */
2591 if (ARR_LEN(lists->blk_list)) {
2592 ird_set_irg_link(irg, lists->blk_list);
2593 dump_block_graph(F, irg);
2596 DEL_ARR_F(lists->extbb_list);
2597 DEL_ARR_F(lists->blk_list);
2602 /* Close the vcg information for the irg */
2603 fprintf(F, "}\n\n");
2609 /* Dump a firm graph without explicit block nodes but grouped in extended blocks. */
2610 void dump_ir_extblock_graph(ir_graph *irg, const char *suffix)
2612 do_dump(irg, suffix, "-ip", "", dump_ir_extblock_graph_file);
2615 void dump_ir_graph_w_types_file(ir_graph *irg, FILE *out)
2617 ir_graph *rem = current_ir_graph;
2618 int rem_dump_const_local;
2620 rem = current_ir_graph;
2621 current_ir_graph = irg;
2622 rem_dump_const_local = dump_const_local;
2623 /* dumping types does not work with local nodes */
2624 dump_const_local = 0;
2626 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2628 /* dump common ir graph */
2629 irg_walk(get_irg_end(irg), NULL, dump_whole_node, out);
2630 /* dump type info */
2631 type_walk_irg(irg, dump_type_info, NULL, out);
2632 inc_irg_visited(get_const_code_irg());
2633 /* dump edges from graph to type info */
2634 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2636 dump_vcg_footer(out);
2637 dump_const_local = rem_dump_const_local;
2638 current_ir_graph = rem;
2641 /* dumps a graph with type information */
2642 void dump_ir_graph_w_types(ir_graph *irg, const char *suffix)
2644 do_dump(irg, suffix, "-pure-wtypes-ip", "-pure-wtypes",
2645 dump_ir_graph_w_types_file);
2648 void dump_ir_block_graph_w_types_file(ir_graph *irg, FILE *out)
2651 int rem_dump_const_local;
2652 ir_graph *rem = current_ir_graph;
2654 rem_dump_const_local = dump_const_local;
2655 /* dumping types does not work with local nodes */
2656 dump_const_local = 0;
2658 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2660 /* dump common blocked ir graph */
2661 construct_block_lists(irg);
2663 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2664 ir_node **arr = ird_get_irg_link(get_irp_irg(i));
2666 dump_graph_from_list(out, get_irp_irg(i));
2671 /* dump type info */
2672 current_ir_graph = irg;
2673 type_walk_irg(irg, dump_type_info, NULL, out);
2674 inc_irg_visited(get_const_code_irg());
2676 /* dump edges from graph to type info */
2677 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2679 dump_vcg_footer(out);
2680 dump_const_local = rem_dump_const_local;
2681 current_ir_graph = rem;
2684 void dump_ir_block_graph_w_types(ir_graph *irg, const char *suffix)
2686 do_dump(irg, suffix, "-wtypes-ip", "-wtypes",
2687 dump_ir_block_graph_w_types_file);
2690 /*---------------------------------------------------------------------*/
2691 /* The following routines dump a control flow graph. */
2692 /*---------------------------------------------------------------------*/
2695 dump_block_to_cfg(ir_node *block, void *env) {
2700 if (is_Block(block)) {
2701 /* This is a block. Dump a node for the block. */
2702 fprintf(F, "node: {title: \""); PRINT_NODEID(block);
2703 fprintf(F, "\" label: \"");
2704 if (block == get_irg_start_block(get_irn_irg(block)))
2705 fprintf(F, "Start ");
2706 if (block == get_irg_end_block(get_irn_irg(block)))
2709 fprintf(F, "%s ", get_op_name(get_irn_op(block)));
2710 PRINT_NODEID(block);
2712 fprintf(F, "info1:\"");
2714 /* the generic version. */
2715 dump_irnode_to_file(F, block);
2717 /* Check whether we have bad predecessors to color the block. */
2718 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
2719 if ((fl = is_Bad(get_Block_cfgpred(block, i))))
2722 fprintf(F, "\""); /* closing quote of info */
2724 if ((block == get_irg_start_block(get_irn_irg(block))) ||
2725 (block == get_irg_end_block(get_irn_irg(block))) )
2726 fprintf(F, " color:blue ");
2728 fprintf(F, " color:yellow ");
2731 /* Dump the edges */
2732 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
2733 if (!is_Bad(skip_Proj(get_Block_cfgpred(block, i)))) {
2734 pred = get_nodes_block(skip_Proj(get_Block_cfgpred(block, i)));
2735 fprintf(F, "edge: { sourcename: \"");
2736 PRINT_NODEID(block);
2737 fprintf(F, "\" targetname: \"");
2739 fprintf(F, "\"}\n");
2742 /* Dump dominator/postdominator edge */
2743 if (dump_dominator_information_flag) {
2744 if (get_irg_dom_state(current_ir_graph) == dom_consistent && get_Block_idom(block)) {
2745 pred = get_Block_idom(block);
2746 fprintf(F, "edge: { sourcename: \"");
2747 PRINT_NODEID(block);
2748 fprintf(F, "\" targetname: \"");
2750 fprintf(F, "\" " DOMINATOR_EDGE_ATTR "}\n");
2752 if (get_irg_postdom_state(current_ir_graph) == dom_consistent && get_Block_ipostdom(block)) {
2753 pred = get_Block_ipostdom(block);
2754 fprintf(F, "edge: { sourcename: \"");
2755 PRINT_NODEID(block);
2756 fprintf(F, "\" targetname: \"");
2758 fprintf(F, "\" " POSTDOMINATOR_EDGE_ATTR "}\n");
2764 void dump_cfg(ir_graph *irg, const char *suffix)
2767 /* if a filter is set, dump only the irg's that match the filter */
2768 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2771 f = vcg_open(irg, suffix, "-cfg");
2773 ir_graph *rem = current_ir_graph;
2774 #ifdef INTERPROCEDURAL_VIEW
2775 int ipv = get_interprocedural_view();
2778 current_ir_graph = irg;
2779 dump_vcg_header(f, get_irg_dump_name(irg), NULL, NULL);
2781 #ifdef INTERPROCEDURAL_VIEW
2783 printf("Warning: dumping cfg not in interprocedural view!\n");
2784 set_interprocedural_view(0);
2788 /* walk over the blocks in the graph */
2789 irg_block_walk(get_irg_end(irg), dump_block_to_cfg, NULL, f);
2790 dump_node(f, get_irg_bad(irg));
2792 #ifdef INTERPROCEDURAL_VIEW
2793 set_interprocedural_view(ipv);
2797 current_ir_graph = rem;
2802 static void descend_and_dump(FILE *F, ir_node *n, int depth, pset *mark_set) {
2803 if (pset_find_ptr(mark_set, n))
2806 pset_insert_ptr(mark_set, n);
2809 int i, start = is_Block(n) ? 0 : -1;
2810 dump_whole_node(n, F);
2811 for (i = start; i < get_irn_arity(n); ++i)
2812 descend_and_dump(F, get_irn_n(n, i), depth-1, mark_set);
2815 /* Don't dump edges to nodes further out. These might be edges to
2816 nodes we already dumped, if there is a shorter path to these. */
2820 static int subgraph_counter = 0;
2821 void dump_subgraph(ir_node *root, int depth, const char *suffix) {
2825 sprintf(buf, "-subg_%03d", subgraph_counter++);
2826 F = vcg_open(get_irn_irg(root), suffix, buf);
2828 pset *mark_set = pset_new_ptr(1);
2829 dump_vcg_header(F, get_irg_dump_name(get_irn_irg(root)), NULL, NULL);
2830 descend_and_dump(F, root, depth, mark_set);
2837 void dump_callgraph(const char *suffix) {
2838 FILE *F = vcg_open_name("Callgraph", suffix);
2841 int i, rem = edge_label;
2844 dump_vcg_header(F, "Callgraph", "Hierarchiv", NULL);
2846 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2847 ir_graph *irg = get_irp_irg(i);
2848 ir_entity *ent = get_irg_entity(irg);
2850 int n_callees = get_irg_n_callees(irg);
2852 dump_entity_node(F, ent);
2853 for (j = 0; j < n_callees; ++j) {
2854 ir_entity *c = get_irg_entity(get_irg_callee(irg, j));
2855 //if (id_is_prefix(prefix, get_entity_ld_ident(c))) continue;
2856 int be = is_irg_callee_backedge(irg, j);
2859 "label:\"recursion %d\"" :
2860 "label:\"calls %d\"";
2861 print_ent_ent_edge(F, ent, c, be, ird_color_entity, attr, get_irg_callee_loop_depth(irg, j));
2872 /* Dump all irgs in interprocedural view to a single file. */
2873 void dump_all_cg_block_graph(const char *suffix) {
2874 FILE *f = vcg_open_name("All_graphs", suffix);
2878 int rem_view = get_interprocedural_view();
2880 set_interprocedural_view(1);
2881 dump_vcg_header(f, "All_graphs", NULL);
2883 /* collect nodes in all irgs reachable in call graph*/
2884 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2885 ird_set_irg_link(get_irp_irg(i), NULL);
2887 cg_walk(clear_link, collect_node, NULL);
2889 /* dump all graphs */
2890 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2891 current_ir_graph = get_irp_irg(i);
2892 assert(ird_get_irg_link(current_ir_graph));
2893 dump_graph_from_list(f, current_ir_graph);
2894 DEL_ARR_F(ird_get_irg_link(current_ir_graph));
2899 set_interprocedural_view(rem_view);
2904 /*---------------------------------------------------------------------*/
2905 /* the following routines dumps type information without any ir nodes. */
2906 /*---------------------------------------------------------------------*/
2909 dump_type_graph(ir_graph *irg, const char *suffix)
2913 /* if a filter is set, dump only the irg's that match the filter */
2914 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
2916 f = vcg_open(irg, suffix, "-type");
2918 ir_graph *rem = current_ir_graph;
2919 current_ir_graph = irg;
2921 dump_vcg_header(f, get_irg_dump_name(irg), "Hierarchic", NULL);
2923 /* walk over the blocks in the graph */
2924 type_walk_irg(irg, dump_type_info, NULL, f);
2925 /* The walker for the const code can be called several times for the
2926 same (sub) expression. So that no nodes are dumped several times
2927 we decrease the visited flag of the corresponding graph after each
2928 walk. So now increase it finally. */
2929 inc_irg_visited(get_const_code_irg());
2933 current_ir_graph = rem;
2938 dump_all_types(const char *suffix)
2940 FILE *f = vcg_open_name("All_types", suffix);
2942 dump_vcg_header(f, "All_types", "Hierarchic", NULL);
2943 type_walk(dump_type_info, NULL, f);
2944 inc_irg_visited(get_const_code_irg());
2952 dump_class_hierarchy(int entities, const char *suffix)
2954 FILE *f = vcg_open_name("class_hierarchy", suffix);
2959 env.dump_ent = entities;
2960 dump_vcg_header(f, "class_hierarchy", "Hierarchic", NULL);
2961 type_walk(dump_class_hierarchy_node, NULL, &env);
2968 /*---------------------------------------------------------------------*/
2969 /* dumps all graphs with the graph-dumper passed. Possible dumpers: */
2971 /* dump_ir_block_graph */
2973 /* dump_type_graph */
2974 /* dump_ir_graph_w_types */
2975 /*---------------------------------------------------------------------*/
2977 void dump_all_ir_graphs(dump_graph_func *dmp_grph, const char *suffix) {
2979 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2980 dmp_grph(get_irp_irg(i), suffix);
2984 /*--------------------------------------------------------------------------------*
2985 * Dumps a stand alone loop graph with firm nodes which belong to one loop node *
2986 * packed together in one subgraph/box *
2987 *--------------------------------------------------------------------------------*/
2989 void dump_loops_standalone(FILE *F, ir_loop *loop) {
2990 int i = 0, loop_node_started = 0, son_number = 0, first = 0;
2992 ir_loop *son = NULL;
2994 /* Dump a new loop node. */
2995 dump_loop_node(F, loop);
2997 /* Dump the loop elements. */
2998 for (i = 0; i < get_loop_n_elements(loop); i++) {
2999 le = get_loop_element(loop, i);
3001 if (get_kind(son) == k_ir_loop) {
3003 /* We are a loop son -> Recurse */
3005 if (loop_node_started) { /* Close the "firm-nodes" node first if we started one. */
3006 fprintf(F, "\" }\n");
3007 fprintf(F, "edge: {sourcename: \"");
3009 fprintf(F, "\" targetname: \"");
3011 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3012 loop_node_started = 0;
3014 dump_loop_son_edge(F, loop, son_number++);
3015 dump_loops_standalone(F, son);
3016 } else if (get_kind(son) == k_ir_node) {
3017 /* We are a loop node -> Collect firm nodes */
3019 ir_node *n = le.node;
3022 if (!loop_node_started) {
3023 /* Start a new node which contains all firm nodes of the current loop */
3024 fprintf(F, "node: { title: \"");
3026 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3027 loop_node_started = 1;
3032 bad |= dump_node_label(F, n);
3033 /* Causes indeterministic output: if (is_Block(n)) fprintf(F, "\t ->%d", (int)get_irn_link(n)); */
3034 if (has_backedges(n)) fprintf(F, "\t loop head!");
3035 } else { /* for callgraph loop tree */
3037 assert(get_kind(son) == k_ir_graph);
3039 /* We are a loop node -> Collect firm graphs */
3041 if (!loop_node_started) {
3042 /* Start a new node which contains all firm nodes of the current loop */
3043 fprintf(F, "node: { title: \"");
3045 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3046 loop_node_started = 1;
3050 fprintf(F, " %s", get_irg_dump_name(n));
3051 /* fprintf(F, " %s (depth %d)", get_irg_dump_name(n), n->callgraph_weighted_loop_depth); */
3055 if (loop_node_started) {
3056 fprintf(F, "\" }\n");
3057 fprintf(F, "edge: {sourcename: \"");
3059 fprintf(F, "\" targetname: \"");
3061 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3062 loop_node_started = 0;
3066 void dump_loop_tree(ir_graph *irg, const char *suffix)
3070 /* if a filter is set, dump only the irg's that match the filter */
3071 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
3074 f = vcg_open(irg, suffix, "-looptree");
3076 ir_graph *rem = current_ir_graph;
3077 int el_rem = edge_label;
3079 current_ir_graph = irg;
3082 dump_vcg_header(f, get_irg_dump_name(irg), "Tree", "top_to_bottom");
3084 if (get_irg_loop(irg))
3085 dump_loops_standalone(f, get_irg_loop(irg));
3090 edge_label = el_rem;
3091 current_ir_graph = rem;
3095 void dump_callgraph_loop_tree(const char *suffix) {
3097 F = vcg_open_name("Callgraph_looptree", suffix);
3098 dump_vcg_header(F, "callgraph looptree", "Tree", "top_to_bottom");
3099 dump_loops_standalone(F, irp->outermost_cg_loop);
3105 /*----------------------------------------------------------------------------*/
3106 /* Dumps the firm nodes in the loop tree to a graph along with the loop nodes.*/
3107 /*----------------------------------------------------------------------------*/
3109 void collect_nodeloop(FILE *F, ir_loop *loop, eset *loopnodes) {
3110 int i, son_number = 0, node_number = 0;
3112 if (dump_loop_information_flag) dump_loop_node(F, loop);
3114 for (i = 0; i < get_loop_n_elements(loop); i++) {
3115 loop_element le = get_loop_element(loop, i);
3116 if (*(le.kind) == k_ir_loop) {
3117 if (dump_loop_information_flag) dump_loop_son_edge(F, loop, son_number++);
3119 collect_nodeloop(F, le.son, loopnodes);
3121 if (dump_loop_information_flag) dump_loop_node_edge(F, loop, node_number++);
3122 eset_insert(loopnodes, le.node);
3127 void collect_nodeloop_external_nodes(ir_loop *loop, eset *loopnodes, eset *extnodes) {
3130 for(i = 0; i < get_loop_n_elements(loop); i++) {
3131 loop_element le = get_loop_element(loop, i);
3132 if (*(le.kind) == k_ir_loop) {
3134 collect_nodeloop_external_nodes(le.son, loopnodes, extnodes);
3136 if (is_Block(le.node)) start = 0; else start = -1;
3137 for (j = start; j < get_irn_arity(le.node); j++) {
3138 ir_node *pred = get_irn_n(le.node, j);
3139 if (!eset_contains(loopnodes, pred)) {
3140 eset_insert(extnodes, pred);
3141 if (!is_Block(pred)) {
3142 pred = get_nodes_block(pred);
3143 if (!eset_contains(loopnodes, pred)) eset_insert(extnodes, pred);
3151 void dump_loop(ir_loop *l, const char *suffix) {
3155 snprintf(name, sizeof(name), "loop_%d", get_loop_loop_nr(l));
3156 F = vcg_open_name(name, suffix);
3158 eset *loopnodes = eset_create();
3159 eset *extnodes = eset_create();
3162 dump_vcg_header(F, name, NULL, NULL);
3164 /* collect all nodes to dump */
3165 collect_nodeloop(F, l, loopnodes);
3166 collect_nodeloop_external_nodes(l, loopnodes, extnodes);
3168 /* build block lists */
3169 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes))
3170 set_irn_link(n, NULL);
3171 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes))
3172 set_irn_link(n, NULL);
3173 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes)) {
3175 b = get_nodes_block(n);
3176 set_irn_link(n, get_irn_link(b));
3180 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes)) {
3182 b = get_nodes_block(n);
3183 set_irn_link(n, get_irn_link(b));
3188 for (b = eset_first(loopnodes); b != NULL; b = eset_next(loopnodes)) {
3190 fprintf(F, "graph: { title: \"");
3192 fprintf(F, "\" label: \"");
3193 dump_node_opcode(F, b);
3194 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3195 fprintf(F, "\" status:clustered color:yellow\n");
3197 /* dump the blocks edges */
3198 dump_ir_data_edges(F, b);
3200 /* dump the nodes that go into the block */
3201 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3202 if (eset_contains(extnodes, n))
3203 overrule_nodecolor = ird_color_block_inout;
3205 overrule_nodecolor = ird_color_default_node;
3206 if (!eset_contains(extnodes, n)) dump_ir_data_edges(F, n);
3209 /* Close the vcg information for the block */
3211 dump_const_node_local(F, b);
3215 for (b = eset_first(extnodes); b != NULL; b = eset_next(extnodes)) {
3217 fprintf(F, "graph: { title: \"");
3219 fprintf(F, "\" label: \"");
3220 dump_node_opcode(F, b);
3221 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3222 fprintf(F, "\" status:clustered color:lightblue\n");
3224 /* dump the nodes that go into the block */
3225 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3226 if (!eset_contains(loopnodes, n))
3227 overrule_nodecolor = ird_color_block_inout;
3229 overrule_nodecolor = ird_color_default_node;
3230 if (eset_contains(loopnodes, n)) dump_ir_data_edges(F, n);
3233 /* Close the vcg information for the block */
3235 dump_const_node_local(F, b);
3239 eset_destroy(loopnodes);
3240 eset_destroy(extnodes);