2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Write vcg representation of firm to file.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Hubert Schmidt
35 #include "irgraph_t.h"
49 #include "callgraph.h"
50 #include "irextbb_t.h"
52 #include "dbginfo_t.h"
64 /** Dump only irgs with names that start with this prefix. */
65 static ident *dump_file_filter_id = NULL;
67 #define ERROR_TXT "<ERROR>"
69 /*******************************************************************/
70 /* flags to steer output */
71 /*******************************************************************/
73 /** An option to turn off edge labels */
74 static int edge_label = 1;
75 /** An option to turn off dumping values of constant entities */
76 static int const_entities = 1;
77 /** An option to dump the keep alive edges */
78 static int dump_keepalive = 1;
79 /** An option to dump the new out edges */
80 static int dump_new_edges_flag = 0;
81 /** An option to dump ld_names instead of names. */
82 static int dump_ld_name = 1;
83 /** Compiler options to dump analysis information in dump_ir_graph */
84 static int dump_out_edge_flag = 0;
85 static int dump_loop_information_flag = 0;
86 static int dump_backedge_information_flag = 1;
87 /** An option to dump const-like nodes locally. */
88 static int dump_const_local = 1;
89 /** An option to dump the node index number. */
90 static int dump_node_idx_labels = 0;
91 /** An option to dump all graph anchors */
92 static int dump_anchors = 0;
93 /** An option to dump the macro block edges. */
94 static int dump_macro_block_edges = 0;
95 /** An option to dump block marker in the block title */
96 static int dump_block_marker = 0;
98 int dump_dominator_information_flag = 0;
99 int opt_dump_analysed_type_info = 1;
100 int opt_dump_pointer_values_to_info = 0; /* default off: for test compares!! */
102 static ird_color_t overrule_nodecolor = ird_color_default_node;
104 /** The vcg node attribute hook. */
105 static DUMP_IR_GRAPH_FUNC dump_ir_graph_hook = NULL;
106 /** The vcg node attribute hook. */
107 static DUMP_NODE_VCGATTR_FUNC dump_node_vcgattr_hook = NULL;
108 /** The vcg edge attribute hook. */
109 static DUMP_EDGE_VCGATTR_FUNC dump_edge_vcgattr_hook = NULL;
110 /** The vcg dump block edge hook */
111 static DUMP_NODE_EDGE_FUNC dump_block_edge_hook = NULL;
112 /** The vcg dump node edge hook. */
113 static DUMP_NODE_EDGE_FUNC dump_node_edge_hook = NULL;
115 /* Set the hook to be called to dump additional edges to a node. */
116 void set_dump_node_edge_hook(DUMP_NODE_EDGE_FUNC func) {
117 dump_node_edge_hook = func;
120 /* Get the additional edge dump hook. */
121 DUMP_NODE_EDGE_FUNC get_dump_node_edge_hook(void) {
122 return dump_node_edge_hook;
125 /* Set the hook to be called to dump additional edges to a block. */
126 void set_dump_block_edge_hook(DUMP_NODE_EDGE_FUNC func) {
127 dump_block_edge_hook = func;
130 /* Get the additional block edge dump hook. */
131 DUMP_NODE_EDGE_FUNC get_dump_block_edge_hook(void) {
132 return dump_node_edge_hook;
135 /* set the ir graph hook */
136 void set_dump_ir_graph_hook(DUMP_IR_GRAPH_FUNC hook) {
137 dump_ir_graph_hook = hook;
140 /* set the node attribute hook */
141 void set_dump_node_vcgattr_hook(DUMP_NODE_VCGATTR_FUNC hook) {
142 dump_node_vcgattr_hook = hook;
145 /* set the edge attribute hook */
146 void set_dump_edge_vcgattr_hook(DUMP_EDGE_VCGATTR_FUNC hook) {
147 dump_edge_vcgattr_hook = hook;
150 /** Returns 0 if dump_out_edge_flag or dump_loop_information_flag
151 * are set, else returns dump_const_local_flag.
153 static int get_opt_dump_const_local(void) {
154 if (dump_out_edge_flag || dump_loop_information_flag || (dump_new_edges_flag && edges_activated(current_ir_graph)))
156 return dump_const_local;
159 /* Set a prefix filter for output functions. */
160 void only_dump_method_with_name(ident *name) {
161 dump_file_filter_id = name;
164 /* Returns the prefix filter set with only_dump_method_with_name(). */
165 ident *get_dump_file_filter_ident(void) {
166 return dump_file_filter_id;
169 /* Returns non-zero if dump file filter is not set, or if it is a prefix of name. */
170 int is_filtered_dump_name(ident *name) {
171 if (!dump_file_filter_id) return 1;
172 return id_is_prefix(dump_file_filter_id, name);
175 /* To turn off display of edge labels. Edge labels often cause xvcg to
176 abort with a segmentation fault. */
177 void turn_off_edge_labels(void) {
181 void dump_consts_local(int flag) {
182 dump_const_local = flag;
185 void dump_node_idx_label(int flag) {
186 dump_node_idx_labels = flag;
189 void dump_constant_entity_values(int flag) {
190 const_entities = flag;
193 void dump_keepalive_edges(int flag) {
194 dump_keepalive = flag;
197 void dump_new_edges(int flag) {
198 dump_new_edges_flag = flag;
201 int get_opt_dump_keepalive_edges(void) {
202 return dump_keepalive;
205 void dump_out_edges(int flag) {
206 dump_out_edge_flag = flag;
209 void dump_dominator_information(int flag) {
210 dump_dominator_information_flag = flag;
213 void dump_loop_information(int flag) {
214 dump_loop_information_flag = flag;
217 void dump_backedge_information(int flag) {
218 dump_backedge_information_flag = flag;
221 /* Dump the information of type field specified in ana/irtypeinfo.h.
222 * If the flag is set, the type name is output in [] in the node label,
223 * else it is output as info.
225 void set_opt_dump_analysed_type_info(int flag) {
226 opt_dump_analysed_type_info = flag;
229 void dump_pointer_values_to_info(int flag) {
230 opt_dump_pointer_values_to_info = flag;
233 void dump_ld_names(int flag) {
237 void dump_all_anchors(int flag) {
241 void dump_macroblock_edges(int flag) {
242 dump_macro_block_edges = flag;
245 void dump_block_marker_in_title(int flag) {
246 dump_block_marker = flag;
249 /* -------------- some extended helper functions ----------------- */
252 * returns the name of a mode or ERROR_TXT if mode is NOT a mode object.
253 * in the later case, sets bad.
255 const char *get_mode_name_ex(const ir_mode *mode, int *bad) {
257 return get_mode_name(mode);
263 * returns the name of a type or <ERROR> if mode is NOT a mode object.
264 * in the later case, sets bad
266 const char *get_type_name_ex(const ir_type *tp, int *bad) {
268 return get_type_name(tp);
273 #define CUSTOM_COLOR_BASE 100
274 static const char *color_names[ird_color_count];
275 static const char *color_rgb[ird_color_count];
276 static struct obstack color_obst;
278 /** define a custom color. */
279 static void custom_color(int num, const char *rgb_def)
281 assert(num < ird_color_count);
282 obstack_printf(&color_obst, "%d", CUSTOM_COLOR_BASE + num);
283 obstack_1grow(&color_obst, '\0');
285 color_rgb[num] = rgb_def;
286 color_names[num] = obstack_finish(&color_obst);
289 /** Define a named color. */
290 static void named_color(int num, const char *name)
292 assert(num < ird_color_count);
293 color_rgb[num] = NULL;
294 color_names[num] = name;
297 /** Initializes the used colors. */
298 static void init_colors(void)
300 static int initialized = 0;
304 obstack_init(&color_obst);
306 custom_color(ird_color_prog_background, "204 204 204");
307 custom_color(ird_color_block_background, "255 255 0");
308 custom_color(ird_color_dead_block_background, "190 150 150");
309 named_color(ird_color_block_inout, "lightblue");
310 named_color(ird_color_default_node, "white");
311 custom_color(ird_color_memory, "153 153 255");
312 custom_color(ird_color_controlflow, "255 153 153");
313 custom_color(ird_color_const, "204 255 255");
314 custom_color(ird_color_proj, "255 255 153");
315 custom_color(ird_color_uses_memory, "153 153 255");
316 custom_color(ird_color_phi, "105 255 105");
317 custom_color(ird_color_anchor, "100 100 255");
318 named_color(ird_color_error, "red");
319 custom_color(ird_color_entity, "204 204 255");
325 * Prints the VCG color to a file.
327 static void print_vcg_color(FILE *F, ird_color_t color) {
328 assert(color < ird_color_count);
329 fprintf(F, "color:%s", color_names[color]);
333 * Prints the edge kind of a given IR node.
335 * Projs should be dumped near their predecessor, so they get "nearedge".
337 static void print_node_edge_kind(FILE *F, ir_node *node) {
339 fprintf(F, "nearedge: ");
341 fprintf(F, "edge: ");
346 * Prints the edge from a type S to a type T with additional info fmt, ...
349 static void print_type_type_edge(FILE *F, const ir_type *S, const ir_type *T, const char *fmt, ...)
354 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(S);
355 fprintf(F, " targetname: "); PRINT_TYPEID(T);
356 vfprintf(F, fmt, ap);
362 * Prints the edge from a type tp to an entity ent with additional info fmt, ...
365 static void print_type_ent_edge(FILE *F, const ir_type *tp, const ir_entity *ent, const char *fmt, ...)
370 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(tp);
371 fprintf(F, " targetname: \""); PRINT_ENTID(ent); fprintf(F, "\"");
372 vfprintf(F, fmt, ap);
378 * Prints the edge from an entity ent1 to an entity ent2 with additional info fmt, ...
381 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, ...)
387 fprintf(F, "backedge: { sourcename: \"");
389 fprintf(F, "edge: { sourcename: \"");
391 fprintf(F, "\" targetname: \""); PRINT_ENTID(ent2); fprintf(F, "\"");
392 vfprintf(F, fmt, ap);
394 if (color != (ird_color_t) -1)
395 print_vcg_color(F, color);
401 * Prints the edge from an entity ent to a type tp with additional info fmt, ...
404 static void print_ent_type_edge(FILE *F, const ir_entity *ent, const ir_type *tp, const char *fmt, ...)
409 fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(ent);
410 fprintf(F, "\" targetname: "); PRINT_TYPEID(tp);
411 vfprintf(F, fmt, ap);
417 * Prints the edge from a node irn to a type tp with additional info fmt, ...
420 static void print_node_type_edge(FILE *F, const ir_node *irn, ir_type *tp, const char *fmt, ...)
425 fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(irn);
426 fprintf(F, "\" targetname: "); PRINT_TYPEID(tp);
427 vfprintf(F, fmt, ap);
433 * Prints the edge from a node irn to an entity ent with additional info fmt, ...
436 static void print_node_ent_edge(FILE *F, const ir_node *irn, const ir_entity *ent, const char *fmt, ...)
441 fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(irn);
442 fprintf(F, "\" targetname: \""); PRINT_ENTID(ent);
444 vfprintf(F, fmt, ap);
450 * Prints the edge from an entity ent to a node irn with additional info fmt, ...
453 static void print_ent_node_edge(FILE *F, const ir_entity *ent, const ir_node *irn, const char *fmt, ...)
458 fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(ent);
459 fprintf(F, "\" targetname: \""); PRINT_NODEID(irn); fprintf(F, "\"");
460 vfprintf(F, fmt, ap);
466 * Prints the edge from a type tp to an enumeration item item with additional info fmt, ...
469 static void print_enum_item_edge(FILE *F, const ir_type *tp, int item, const char *fmt, ...)
474 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(tp);
475 fprintf(F, " targetname: \""); PRINT_ITEMID(tp, item); fprintf(F, "\" ");
476 vfprintf(F, fmt, ap);
481 /*-----------------------------------------------------------------*/
482 /* global and ahead declarations */
483 /*-----------------------------------------------------------------*/
485 static void dump_whole_node(ir_node *n, void *env);
486 static inline void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg);
488 /*-----------------------------------------------------------------*/
489 /* Helper functions. */
490 /*-----------------------------------------------------------------*/
493 * This map is used as a private link attr to be able to call dumper
494 * anywhere without destroying link fields.
496 static pmap *irdump_link_map = NULL;
498 /** NOT A STANDARD LIBFIRM INIT METHOD
500 * We do not want to integrate dumping into libfirm, i.e., if the dumpers
501 * are off, we want to have as few interferences as possible. Therefore the
502 * initialization is performed lazily and not called from within init_firm.
504 * Creates the link attribute map. */
505 static void init_irdump(void) {
506 /* We need a new, empty map. */
507 if (irdump_link_map) pmap_destroy(irdump_link_map);
508 irdump_link_map = pmap_create();
509 if (!dump_file_filter_id)
510 dump_file_filter_id = new_id_from_str("");
514 * Returns the private link field.
516 static void *ird_get_irn_link(const ir_node *n) {
518 if (irdump_link_map == NULL)
521 if (pmap_contains(irdump_link_map, n))
522 res = pmap_get(irdump_link_map, n);
527 * Sets the private link field.
529 static void ird_set_irn_link(const ir_node *n, void *x) {
530 if (irdump_link_map == NULL)
532 pmap_insert(irdump_link_map, n, x);
536 * Gets the private link field of an irg.
538 static void *ird_get_irg_link(const ir_graph *irg) {
540 if (irdump_link_map == NULL)
543 if (pmap_contains(irdump_link_map, irg))
544 res = pmap_get(irdump_link_map, irg);
549 * Sets the private link field of an irg.
551 static void ird_set_irg_link(const ir_graph *irg, void *x) {
552 if (irdump_link_map == NULL)
554 pmap_insert(irdump_link_map, irg, x);
558 * Walker, clears the private link field.
560 static void clear_link(ir_node *node, void *env) {
562 ird_set_irn_link(node, NULL);
566 * If the entity has a ld_name, returns it if the dump_ld_name is set,
567 * else returns the name of the entity.
569 static const char *_get_ent_dump_name(const ir_entity *ent, int dump_ld_name) {
571 return "<NULL entity>";
573 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
574 if (ent->ld_name != NULL)
575 return get_id_str(ent->ld_name);
577 return get_id_str(ent->name);
581 * If the entity has a ld_name, returns it if the option dump_ld_name is set,
582 * else returns the name of the entity.
584 const char *get_ent_dump_name(const ir_entity *ent) {
585 return _get_ent_dump_name(ent, dump_ld_name);
588 /* Returns the name of an IRG. */
589 const char *get_irg_dump_name(const ir_graph *irg) {
590 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
591 return _get_ent_dump_name(get_irg_entity(irg), 1);
595 * Returns non-zero if a node is in floating state.
597 static int node_floats(const ir_node *n) {
598 return ((get_irn_pinned(n) == op_pin_state_floats) &&
599 (get_irg_pinned(current_ir_graph) == op_pin_state_floats));
603 * Walker that visits the anchors
605 static void ird_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env) {
606 if (dump_anchors || (dump_new_edges_flag && edges_activated(irg))) {
607 irg_walk_anchors(irg, pre, post, env);
609 irg_walk_graph(irg, pre, post, env);
614 * Walker, allocates an array for all blocks and puts it's nodes non-floating nodes into this array.
616 static void collect_node(ir_node *node, void *env) {
620 || (get_op_flags(get_irn_op(node)) & irop_flag_dump_noblock)) {
621 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
622 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
623 ARR_APP1(ir_node *, arr, node);
624 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
626 ir_node * block = get_nodes_block(node);
629 /* this node is in a Bad block, so we must place it into the graph's list */
630 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
631 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
632 ARR_APP1(ir_node *, arr, node);
633 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
635 ird_set_irn_link(node, ird_get_irn_link(block));
636 ird_set_irn_link(block, node);
641 /** Construct lists to walk ir block-wise.
643 * Collects all blocks, nodes not op_pin_state_pinned,
644 * Bad, NoMem and Unknown into a flexible array in link field of
645 * irg they belong to. Sets the irg link field to NULL in all
646 * graphs not visited.
647 * Free the list with DEL_ARR_F().
649 static ir_node **construct_block_lists(ir_graph *irg) {
651 #ifdef INTERPROCEDURAL_VIEW
652 int rem_view = get_interprocedural_view();
654 int walk_flag = ir_resources_reserved(irg) & IR_RESOURCE_IRN_VISITED;
655 ir_graph *rem = current_ir_graph;
657 current_ir_graph = irg;
660 ir_free_resources(irg, IR_RESOURCE_IRN_VISITED);
663 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
664 ird_set_irg_link(get_irp_irg(i), NULL);
666 ird_walk_graph(current_ir_graph, clear_link, collect_node, current_ir_graph);
668 #ifdef INTERPROCEDURAL_VIEW
669 /* Collect also EndReg and EndExcept. We do not want to change the walker. */
670 set_interprocedural_view(0);
673 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
674 irg_walk(get_irg_end_reg(current_ir_graph), clear_link, collect_node, current_ir_graph);
675 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
676 irg_walk(get_irg_end_except(current_ir_graph), clear_link, collect_node, current_ir_graph);
678 #ifdef INTERPROCEDURAL_VIEW
679 set_interprocedural_view(rem_view);
683 ir_reserve_resources(irg, IR_RESOURCE_IRN_VISITED);
686 current_ir_graph = rem;
687 return ird_get_irg_link(irg);
690 typedef struct _list_tuple {
692 ir_extblk **extbb_list;
695 /** Construct lists to walk IR extended block-wise.
696 * Free the lists in the tuple with DEL_ARR_F().
697 * Sets the irg link field to NULL in all
698 * graphs not visited.
700 static list_tuple *construct_extblock_lists(ir_graph *irg) {
701 ir_node **blk_list = construct_block_lists(irg);
703 ir_graph *rem = current_ir_graph;
704 list_tuple *lists = XMALLOC(list_tuple);
706 current_ir_graph = irg;
708 lists->blk_list = NEW_ARR_F(ir_node *, 0);
709 lists->extbb_list = NEW_ARR_F(ir_extblk *, 0);
711 inc_irg_block_visited(irg);
712 for (i = ARR_LEN(blk_list) - 1; i >= 0; --i) {
715 if (is_Block(blk_list[i])) {
716 ext = get_Block_extbb(blk_list[i]);
718 if (extbb_not_visited(ext)) {
719 ARR_APP1(ir_extblk *, lists->extbb_list, ext);
720 mark_extbb_visited(ext);
723 ARR_APP1(ir_node *, lists->blk_list, blk_list[i]);
727 current_ir_graph = rem;
728 ird_set_irg_link(irg, lists);
732 /*-----------------------------------------------------------------*/
733 /* Routines to dump information about a single ir node. */
734 /*-----------------------------------------------------------------*/
737 * dump the name of a node n to the File F.
739 int dump_node_opcode(FILE *F, ir_node *n)
742 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
744 /* call the dump_node operation if available */
746 return ops->dump_node(n, F, dump_node_opcode_txt);
748 /* implementation for default nodes */
749 switch (get_irn_opcode(n)) {
751 switch (get_SymConst_kind(n)) {
752 case symconst_addr_name:
753 /* don't use get_SymConst_ptr_info as it mangles the name. */
754 fprintf(F, "SymC %s", get_id_str(get_SymConst_name(n)));
756 case symconst_addr_ent:
757 fprintf(F, "SymC &%s", get_entity_name(get_SymConst_entity(n)));
759 case symconst_ofs_ent:
760 fprintf(F, "SymC %s offset", get_entity_name(get_SymConst_entity(n)));
762 case symconst_type_tag:
763 fprintf(F, "SymC %s tag", get_type_name_ex(get_SymConst_type(n), &bad));
765 case symconst_type_size:
766 fprintf(F, "SymC %s size", get_type_name_ex(get_SymConst_type(n), &bad));
768 case symconst_type_align:
769 fprintf(F, "SymC %s align", get_type_name_ex(get_SymConst_type(n), &bad));
771 case symconst_enum_const:
772 fprintf(F, "SymC %s enum", get_enumeration_name(get_SymConst_enum(n)));
778 if (!get_interprocedural_view())
785 ir_node *pred = get_Proj_pred(n);
787 if (get_irn_opcode(pred) == iro_Cond
788 && get_Proj_proj(n) == get_Cond_default_proj(pred)
789 && get_irn_mode(get_Cond_selector(pred)) != mode_b)
790 fprintf(F, "defProj");
798 if (get_interprocedural_view()) {
799 fprintf(F, "%s %s", get_irn_opname(n), get_ent_dump_name(get_irg_entity(get_irn_irg(n))));
804 case iro_CallBegin: {
805 ir_node *addr = get_CallBegin_ptr(n);
806 ir_entity *ent = NULL;
808 ent = get_Sel_entity(addr);
809 else if (is_Global(addr))
810 ent = get_Global_entity(addr);
811 fprintf(F, "%s", get_irn_opname(n));
812 if (ent) fprintf(F, " %s", get_entity_name(ent));
816 if (get_Load_align(n) == align_non_aligned)
818 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Load_mode(n), &bad));
821 if (get_Store_align(n) == align_non_aligned)
823 fprintf(F, "%s", get_irn_opname(n));
827 is_Block_dead(n) ? "Dead " : "", get_irn_opname(n),
828 dump_block_marker ? (get_Block_mark(n) ? "*" : "") : "");
831 if (get_Conv_strict(n))
832 fprintf(F, "strict");
833 fprintf(F, "%s", get_irn_opname(n));
836 fprintf(F, "%s", get_irn_opname(n));
837 if (get_Div_no_remainder(n))
839 fprintf(F, "[%s]", get_mode_name_ex(get_Div_resmode(n), &bad));
842 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Mod_resmode(n), &bad));
845 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_DivMod_resmode(n), &bad));
848 fprintf(F, "%s[%s]", get_irn_opname(n), get_builtin_kind_name(get_Builtin_kind(n)));
853 fprintf(F, "%s", get_irn_opname(n));
860 * Dump the mode of a node n to a file F.
861 * Ignore modes that are "always known".
863 static int dump_node_mode(FILE *F, ir_node *n)
866 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
870 /* call the dump_node operation if available */
872 return ops->dump_node(n, F, dump_node_mode_txt);
874 /* default implementation */
875 iro = get_irn_opcode(n);
887 mode = get_irn_mode(n);
889 if (mode != NULL && mode != mode_BB && mode != mode_ANY && mode != mode_BAD &&
890 (mode != mode_T || iro == iro_Proj))
891 fprintf(F, "%s", get_mode_name_ex(mode, &bad));
897 * Dump the type of a node n to a file F if it's known.
899 static int dump_node_typeinfo(FILE *F, ir_node *n) {
902 if (opt_dump_analysed_type_info) {
903 if (get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_consistent ||
904 get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_inconsistent) {
905 ir_type *tp = get_irn_typeinfo_type(n);
906 if (tp != firm_none_type)
907 fprintf(F, "[%s] ", get_type_name_ex(tp, &bad));
915 typedef struct _pns_lookup {
916 long nr; /**< the proj number */
917 const char *name; /**< the name of the Proj */
920 typedef struct _proj_lookup {
921 ir_opcode code; /**< the opcode of the Proj predecessor */
922 unsigned num_data; /**< number of data entries */
923 const pns_lookup_t *data; /**< the data */
926 #define ARR_SIZE(a) (sizeof(a)/sizeof(a[0]))
928 /** the lookup table for Proj(Start) names */
929 static const pns_lookup_t start_lut[] = {
930 #define X(a) { pn_Start_##a, #a }
938 /** the lookup table for Proj(Cond) names */
939 static const pns_lookup_t cond_lut[] = {
940 #define X(a) { pn_Cond_##a, #a }
946 /** the lookup table for Proj(Call) names */
947 static const pns_lookup_t call_lut[] = {
948 #define X(a) { pn_Call_##a, #a }
958 /** the lookup table for Proj(Quot) names */
959 static const pns_lookup_t quot_lut[] = {
960 #define X(a) { pn_Quot_##a, #a }
968 /** the lookup table for Proj(DivMod) names */
969 static const pns_lookup_t divmod_lut[] = {
970 #define X(a) { pn_DivMod_##a, #a }
979 /** the lookup table for Proj(Div) names */
980 static const pns_lookup_t div_lut[] = {
981 #define X(a) { pn_Div_##a, #a }
989 /** the lookup table for Proj(Mod) names */
990 static const pns_lookup_t mod_lut[] = {
991 #define X(a) { pn_Mod_##a, #a }
999 /** the lookup table for Proj(Load) names */
1000 static const pns_lookup_t load_lut[] = {
1001 #define X(a) { pn_Load_##a, #a }
1009 /** the lookup table for Proj(Store) names */
1010 static const pns_lookup_t store_lut[] = {
1011 #define X(a) { pn_Store_##a, #a }
1018 /** the lookup table for Proj(Alloc) names */
1019 static const pns_lookup_t alloc_lut[] = {
1020 #define X(a) { pn_Alloc_##a, #a }
1028 /** the lookup table for Proj(CopyB) names */
1029 static const pns_lookup_t copyb_lut[] = {
1030 #define X(a) { pn_CopyB_##a, #a }
1038 /** the lookup table for Proj(InstOf) names */
1039 static const pns_lookup_t instof_lut[] = {
1040 #define X(a) { pn_InstOf_##a, #a }
1049 /** the lookup table for Proj(Raise) names */
1050 static const pns_lookup_t raise_lut[] = {
1051 #define X(a) { pn_Raise_##a, #a }
1057 /** the lookup table for Proj(Bound) names */
1058 static const pns_lookup_t bound_lut[] = {
1059 #define X(a) { pn_Bound_##a, #a }
1067 /** the Proj lookup table */
1068 static const proj_lookup_t proj_lut[] = {
1069 #define E(a) ARR_SIZE(a), a
1070 { iro_Start, E(start_lut) },
1071 { iro_Cond, E(cond_lut) },
1072 { iro_Call, E(call_lut) },
1073 { iro_Quot, E(quot_lut) },
1074 { iro_DivMod, E(divmod_lut) },
1075 { iro_Div, E(div_lut) },
1076 { iro_Mod, E(mod_lut) },
1077 { iro_Load, E(load_lut) },
1078 { iro_Store, E(store_lut) },
1079 { iro_Alloc, E(alloc_lut) },
1080 { iro_CopyB, E(copyb_lut) },
1081 { iro_InstOf, E(instof_lut) },
1082 { iro_Raise, E(raise_lut) },
1083 { iro_Bound, E(bound_lut) }
1088 * Dump additional node attributes of some nodes to a file F.
1091 dump_node_nodeattr(FILE *F, ir_node *n)
1097 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1099 /* call the dump_node operation if available */
1101 return ops->dump_node(n, F, dump_node_nodeattr_txt);
1103 switch (get_irn_opcode(n)) {
1105 if (0 && get_interprocedural_view()) {
1106 fprintf(F, "%s ", get_ent_dump_name(get_irg_entity(current_ir_graph)));
1111 ir_fprintf(F, "%T ", get_Const_tarval(n));
1115 pred = get_Proj_pred(n);
1116 proj_nr = get_Proj_proj(n);
1118 code = get_irn_opcode(pred);
1120 if (code == iro_Cmp)
1121 fprintf(F, "%s ", get_pnc_string(get_Proj_proj(n)));
1122 else if (code == iro_Proj && get_irn_opcode(get_Proj_pred(pred)) == iro_Start)
1123 fprintf(F, "Arg %ld ", proj_nr);
1124 else if (code == iro_Cond && get_irn_mode(get_Cond_selector(pred)) != mode_b)
1125 fprintf(F, "%ld ", proj_nr);
1127 unsigned i, j, f = 0;
1129 for (i = 0; i < ARR_SIZE(proj_lut); ++i) {
1130 if (code == proj_lut[i].code) {
1131 for (j = 0; j < proj_lut[i].num_data; ++j) {
1132 if (proj_nr == proj_lut[i].data[j].nr) {
1133 fprintf(F, "%s ", proj_lut[i].data[j].name);
1142 fprintf(F, "%ld ", proj_nr);
1143 if (code == iro_Cond && get_Cond_jmp_pred(pred) != COND_JMP_PRED_NONE) {
1144 if (proj_nr == pn_Cond_false && get_Cond_jmp_pred(pred) == COND_JMP_PRED_FALSE)
1145 fprintf(F, "PRED ");
1146 if (proj_nr == pn_Cond_true && get_Cond_jmp_pred(pred) == COND_JMP_PRED_TRUE)
1147 fprintf(F, "PRED ");
1152 proj_nr = get_Filter_proj(n);
1153 if (! get_interprocedural_view()) {
1155 pred = get_Filter_pred(n);
1158 fprintf(F, "%ld ", proj_nr);
1161 fprintf(F, "%s ", get_ent_dump_name(get_Sel_entity(n)));
1164 fprintf(F, "(%s) ", get_type_name_ex(get_Cast_type(n), &bad));
1167 fprintf(F, "%s ", get_pnc_string(get_Confirm_cmp(n)));
1170 fprintf(F, "(%s) ", get_type_name_ex(get_CopyB_type(n), &bad));
1181 #include "execution_frequency.h"
1183 static void dump_node_ana_vals(FILE *F, ir_node *n) {
1187 #ifdef INTERPROCEDURAL_VIEW
1188 fprintf(F, " %lf*(%2.0lf + %2.0lf) = %2.0lf ",
1189 get_irn_exec_freq(n),
1190 get_irg_method_execution_frequency(get_irn_irg(n)),
1191 pow(5, get_irg_recursion_depth(get_irn_irg(n))),
1192 get_irn_exec_freq(n) * (get_irg_method_execution_frequency(get_irn_irg(n)) + pow(5, get_irg_recursion_depth(get_irn_irg(n))))
1198 /* Dumps a node label without the enclosing ". */
1199 int dump_node_label(FILE *F, ir_node *n) {
1202 bad |= dump_node_opcode(F, n);
1203 bad |= dump_node_mode(F, n);
1205 bad |= dump_node_typeinfo(F, n);
1206 bad |= dump_node_nodeattr(F, n);
1207 if(dump_node_idx_labels) {
1208 fprintf(F, "%ld:%d", get_irn_node_nr(n), get_irn_idx(n));
1210 fprintf(F, "%ld", get_irn_node_nr(n));
1217 * Dumps the attributes of a node n into the file F.
1218 * Currently this is only the color of a node.
1220 static void dump_node_vcgattr(FILE *F, ir_node *node, ir_node *local, int bad)
1226 print_vcg_color(F, ird_color_error);
1230 if (dump_node_vcgattr_hook)
1231 if (dump_node_vcgattr_hook(F, node, local))
1234 n = local ? local : node;
1236 if (overrule_nodecolor != ird_color_default_node) {
1237 print_vcg_color(F, overrule_nodecolor);
1241 mode = get_irn_mode(n);
1242 if(mode == mode_M) {
1243 print_vcg_color(F, ird_color_memory);
1246 if(mode == mode_X) {
1247 print_vcg_color(F, ird_color_controlflow);
1251 switch (get_irn_opcode(n)) {
1256 print_vcg_color(F, ird_color_anchor);
1259 print_vcg_color(F, ird_color_error);
1262 if (is_Block_dead(n))
1263 print_vcg_color(F, ird_color_dead_block_background);
1265 print_vcg_color(F, ird_color_block_background);
1268 print_vcg_color(F, ird_color_phi);
1271 print_vcg_color(F, ird_color_memory);
1275 print_vcg_color(F, ird_color_const);
1278 print_vcg_color(F, ird_color_proj);
1281 ir_op *op = get_irn_op(node);
1283 if(is_op_constlike(op)) {
1284 print_vcg_color(F, ird_color_const);
1285 } else if(is_op_uses_memory(op)) {
1286 print_vcg_color(F, ird_color_uses_memory);
1287 } else if(is_op_cfopcode(op) || is_op_forking(op)) {
1288 print_vcg_color(F, ird_color_controlflow);
1290 PRINT_DEFAULT_NODE_ATTR;
1296 /* Adds a new node info dumper callback. */
1297 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data)
1299 hook_entry_t *info = XMALLOC(hook_entry_t);
1301 info->hook._hook_node_info = cb;
1302 info->context = data;
1303 register_hook(hook_node_info, info);
1308 /* Remove a previously added info dumper callback. */
1309 void dump_remv_node_info_callback(void *handle)
1311 hook_entry_t *info = handle;
1312 unregister_hook(hook_node_info, info);
1317 * Dump the node information of a node n to a file F.
1319 static inline int dump_node_info(FILE *F, ir_node *n)
1322 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1324 fprintf(F, " info1: \"");
1325 bad = dump_irnode_to_file(F, n);
1326 /* call the dump_node operation if available */
1328 bad = ops->dump_node(n, F, dump_node_info_txt);
1330 /* allow additional info to be added */
1331 hook_node_info(F, n);
1337 static inline int is_constlike_node(const ir_node *node)
1339 const ir_op *op = get_irn_op(node);
1340 return is_op_constlike(op);
1344 /** outputs the predecessors of n, that are constants, local. I.e.,
1345 generates a copy of the constant predecessors for each node called with. */
1346 static void dump_const_node_local(FILE *F, ir_node *n) {
1348 if (!get_opt_dump_const_local()) return;
1350 /* Use visited flag to avoid outputting nodes twice.
1351 initialize it first. */
1352 for (i = 0; i < get_irn_arity(n); i++) {
1353 ir_node *con = get_irn_n(n, i);
1354 if (is_constlike_node(con)) {
1355 set_irn_visited(con, get_irg_visited(current_ir_graph) - 1);
1359 for (i = 0; i < get_irn_arity(n); i++) {
1360 ir_node *con = get_irn_n(n, i);
1361 if (is_constlike_node(con) && !irn_visited(con)) {
1364 mark_irn_visited(con);
1365 /* Generate a new name for the node by appending the names of
1367 fprintf(F, "node: {title: "); PRINT_CONSTID(n, con);
1368 fprintf(F, " label: \"");
1369 bad |= dump_node_label(F, con);
1371 bad |= dump_node_info(F, con);
1372 dump_node_vcgattr(F, n, con, bad);
1378 /** If the block of an edge is a const_like node, dump it local with an edge */
1379 static void dump_const_block_local(FILE *F, ir_node *n) {
1382 if (!get_opt_dump_const_local()) return;
1384 blk = get_nodes_block(n);
1385 if (is_constlike_node(blk)) {
1388 /* Generate a new name for the node by appending the names of
1390 fprintf(F, "node: {title: \""); PRINT_CONSTBLKID(n, blk);
1391 fprintf(F, "\" label: \"");
1392 bad |= dump_node_label(F, blk);
1394 bad |= dump_node_info(F, blk);
1395 dump_node_vcgattr(F, n, blk, bad);
1398 fprintf(F, "edge: { sourcename: \"");
1400 fprintf(F, "\" targetname: \""); PRINT_CONSTBLKID(n,blk);
1402 if (dump_edge_vcgattr_hook) {
1404 if (dump_edge_vcgattr_hook(F, n, -1)) {
1408 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1413 fprintf(F, "\" " BLOCK_EDGE_ATTR "}\n");
1418 * prints the error message of a node to a file F as info2.
1420 static void print_node_error(FILE *F, const char *err_msg)
1425 fprintf(F, " info2: \"%s\"", err_msg);
1429 * prints debug messages of a node to file F as info3.
1431 static void print_dbg_info(FILE *F, dbg_info *dbg)
1435 if (__dbg_info_snprint) {
1437 if (__dbg_info_snprint(buf, sizeof(buf), dbg) > 0)
1438 fprintf(F, " info3: \"%s\"\n", buf);
1445 static void dump_node(FILE *F, ir_node *n)
1450 if (get_opt_dump_const_local() && is_constlike_node(n))
1453 /* dump this node */
1454 fputs("node: {title: \"", F);
1458 fputs(" label: \"", F);
1459 bad = ! irn_vrfy_irg_dump(n, current_ir_graph, &p);
1460 bad |= dump_node_label(F, n);
1461 dump_node_ana_vals(F, n);
1462 //dump_node_ana_info(F, n);
1465 if (get_op_flags(get_irn_op(n)) & irop_flag_dump_noinput) {
1466 //fputs(" node_class:23", F);
1469 bad |= dump_node_info(F, n);
1470 print_node_error(F, p);
1471 print_dbg_info(F, get_irn_dbg_info(n));
1472 dump_node_vcgattr(F, n, NULL, bad);
1474 dump_const_node_local(F, n);
1476 if(dump_node_edge_hook)
1477 dump_node_edge_hook(F, n);
1480 /** dump the edge to the block this node belongs to */
1482 dump_ir_block_edge(FILE *F, ir_node *n) {
1483 if (get_opt_dump_const_local() && is_constlike_node(n)) return;
1484 if (is_no_Block(n)) {
1485 ir_node *block = get_nodes_block(n);
1487 if (get_opt_dump_const_local() && is_constlike_node(block)) {
1488 dump_const_block_local(F, n);
1490 fprintf(F, "edge: { sourcename: \"");
1492 fprintf(F, "\" targetname: ");
1493 fprintf(F, "\""); PRINT_NODEID(block); fprintf(F, "\"");
1495 if (dump_edge_vcgattr_hook) {
1497 if (dump_edge_vcgattr_hook(F, n, -1)) {
1501 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1506 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1512 print_data_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_DATA_EDGE_ATTR);
1520 fprintf(F, INTER_DATA_EDGE_ATTR);
1524 print_mem_edge_vcgattr(FILE *F, ir_node *from, int to) {
1526 * do not use get_nodes_block() here, will fail
1527 * if the irg is not pinned.
1529 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1530 fprintf(F, INTRA_MEM_EDGE_ATTR);
1532 fprintf(F, INTER_MEM_EDGE_ATTR);
1535 /** Print the vcg attributes for the edge from node from to it's to's input */
1536 static void print_edge_vcgattr(FILE *F, ir_node *from, int to) {
1539 if (dump_edge_vcgattr_hook)
1540 if (dump_edge_vcgattr_hook(F, from, to))
1543 if (dump_backedge_information_flag && is_backedge(from, to))
1544 fprintf(F, BACK_EDGE_ATTR);
1546 switch (get_irn_opcode(from)) {
1548 fprintf(F, CF_EDGE_ATTR);
1550 case iro_Start: break;
1553 if (get_irn_mode(get_End_keepalive(from, to)) == mode_BB)
1554 fprintf(F, KEEP_ALIVE_CF_EDGE_ATTR);
1556 fprintf(F, KEEP_ALIVE_DF_EDGE_ATTR);
1560 if (is_Proj(from)) {
1561 if (get_irn_mode(from) == mode_M)
1562 print_mem_edge_vcgattr(F, from, to);
1563 else if (get_irn_mode(from) == mode_X)
1564 fprintf(F, CF_EDGE_ATTR);
1566 print_data_edge_vcgattr(F, from, to);
1568 else if (get_irn_mode(get_irn_n(from, to)) == mode_M)
1569 print_mem_edge_vcgattr(F, from, to);
1570 else if (get_irn_mode(get_irn_n(from, to)) == mode_X)
1571 fprintf(F, CF_EDGE_ATTR);
1573 print_data_edge_vcgattr(F, from, to);
1577 /** dump edges to our inputs */
1578 static void dump_ir_data_edges(FILE *F, ir_node *n) {
1580 ir_visited_t visited = get_irn_visited(n);
1582 if (!dump_keepalive && is_End(n)) {
1583 /* the End node has only keep-alive edges */
1587 /* dump the dependency edges. */
1588 num = get_irn_deps(n);
1589 for (i = 0; i < num; ++i) {
1590 ir_node *dep = get_irn_dep(n, i);
1593 print_node_edge_kind(F, n);
1594 fprintf(F, "{sourcename: \"");
1596 fprintf(F, "\" targetname: ");
1597 if ((get_opt_dump_const_local()) && is_constlike_node(dep)) {
1598 PRINT_CONSTID(n, dep);
1604 fprintf(F, " label: \"%d\" ", i);
1605 fprintf(F, " color: darkgreen}\n");
1609 num = get_irn_arity(n);
1610 for (i = 0; i < num; i++) {
1611 ir_node *pred = get_irn_n(n, i);
1614 if ((get_interprocedural_view() && get_irn_visited(pred) < visited))
1615 continue; /* pred not dumped */
1617 if (dump_backedge_information_flag && is_backedge(n, i))
1618 fprintf(F, "backedge: {sourcename: \"");
1620 print_node_edge_kind(F, n);
1621 fprintf(F, "{sourcename: \"");
1624 fprintf(F, "\" targetname: ");
1625 if ((get_opt_dump_const_local()) && is_constlike_node(pred)) {
1626 PRINT_CONSTID(n, pred);
1628 fprintf(F, "\""); PRINT_NODEID(pred); fprintf(F, "\"");
1630 fprintf(F, " label: \"%d\" ", i);
1631 print_edge_vcgattr(F, n, i);
1635 if (dump_macro_block_edges && is_Block(n)) {
1636 ir_node *mb = get_Block_MacroBlock(n);
1637 fprintf(F, "edge: {sourcename: \"");
1639 fprintf(F, "\" targetname: \"");
1641 fprintf(F, "\" label: \"mb\" " MACROBLOCK_EDGE_ATTR);
1650 dump_ir_edges(FILE *F, ir_node *n) {
1651 const ir_edge_t *edge;
1654 foreach_out_edge(n, edge) {
1655 ir_node *succ = get_edge_src_irn(edge);
1657 print_node_edge_kind(F, succ);
1658 fprintf(F, "{sourcename: \"");
1660 fprintf(F, "\" targetname: \"");
1664 fprintf(F, " label: \"%d\" ", i);
1665 fprintf(F, OUT_EDGE_ATTR);
1672 /** Dumps a node and its edges but not the block edge */
1673 static void dump_node_wo_blockedge(ir_node *n, void *env) {
1676 dump_ir_data_edges(F, n);
1679 /** Dumps a node and its edges. */
1680 static void dump_whole_node(ir_node *n, void *env) {
1682 dump_node_wo_blockedge(n, env);
1683 if (!node_floats(n))
1684 dump_ir_block_edge(F, n);
1685 if (dump_new_edges_flag && edges_activated(current_ir_graph))
1686 dump_ir_edges(F, n);
1689 /** Dumps a const-like node. */
1690 static void dump_const_node(ir_node *n, void *env) {
1691 if (is_Block(n)) return;
1692 dump_node_wo_blockedge(n, env);
1695 /***********************************************************************/
1696 /* the following routines dump the nodes/irgs bracketed to graphs. */
1697 /***********************************************************************/
1699 /** Dumps a constant expression as entity initializer, array bound ...
1701 static void dump_const_expression(FILE *F, ir_node *value) {
1702 ir_graph *rem = current_ir_graph;
1703 int rem_dump_const_local = dump_const_local;
1704 dump_const_local = 0;
1705 current_ir_graph = get_const_code_irg();
1706 irg_walk(value, dump_const_node, NULL, F);
1707 /* Decrease visited flag so that we walk with the same flag for the next
1708 expression. This guarantees that we don't dump the same node twice,
1709 as for const expressions cse is performed to save memory. */
1710 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph) -1);
1711 current_ir_graph = rem;
1712 dump_const_local = rem_dump_const_local;
1715 /** Dump a block as graph containing its nodes.
1717 * Expects to find nodes belonging to the block as list in its
1719 * Dumps the edges of all nodes including itself. */
1720 static void dump_whole_block(FILE *F, ir_node *block) {
1722 ird_color_t color = ird_color_block_background;
1724 assert(is_Block(block));
1726 fprintf(F, "graph: { title: \"");
1727 PRINT_NODEID(block);
1728 fprintf(F, "\" label: \"");
1729 dump_node_label(F, block);
1731 /* colorize blocks */
1732 if (! get_Block_matured(block))
1733 color = ird_color_block_background;
1734 if (is_Block_dead(block))
1735 color = ird_color_dead_block_background;
1737 fprintf(F, "\" status:clustered ");
1738 print_vcg_color(F, color);
1741 /* yComp can show attributes for blocks, XVCG parses but ignores them */
1742 dump_node_info(F, block);
1743 print_dbg_info(F, get_irn_dbg_info(block));
1745 /* dump the blocks edges */
1746 dump_ir_data_edges(F, block);
1748 if (dump_block_edge_hook)
1749 dump_block_edge_hook(F, block);
1751 /* dump the nodes that go into the block */
1752 for (node = ird_get_irn_link(block); node; node = ird_get_irn_link(node)) {
1754 dump_ir_data_edges(F, node);
1757 /* Close the vcg information for the block */
1759 dump_const_node_local(F, block);
1763 /** dumps a graph block-wise. Expects all blockless nodes in arr in irgs link.
1764 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1766 dump_block_graph(FILE *F, ir_graph *irg) {
1768 ir_graph *rem = current_ir_graph;
1769 ir_node **arr = ird_get_irg_link(irg);
1770 current_ir_graph = irg;
1772 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1773 ir_node * node = arr[i];
1774 if (is_Block(node)) {
1775 /* Dumps the block and all the nodes in the block, which are to
1776 be found in Block->link. */
1777 dump_whole_block(F, node);
1779 /* Nodes that are not in a Block. */
1781 if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
1782 dump_const_block_local(F, node);
1784 dump_ir_data_edges(F, node);
1786 if (dump_new_edges_flag && edges_activated(irg))
1787 dump_ir_edges(F, node);
1790 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1791 dump_loop_nodes_into_graph(F, irg);
1793 current_ir_graph = rem;
1797 * Dump the info for an irg.
1798 * Parsed by XVCG but not shown. use yComp.
1800 static void dump_graph_info(FILE *F, ir_graph *irg) {
1801 fprintf(F, "info1: \"");
1802 dump_entity_to_file(F, get_irg_entity(irg), dump_verbosity_entattrs | dump_verbosity_entconsts);
1806 /** Dumps an irg as a graph clustered by block nodes.
1807 * If interprocedural view edges can point to nodes out of this graph.
1809 static void dump_graph_from_list(FILE *F, ir_graph *irg) {
1810 ir_entity *ent = get_irg_entity(irg);
1812 fprintf(F, "graph: { title: \"");
1814 fprintf(F, "\" label: \"%s\" status:clustered color:%s \n",
1815 get_ent_dump_name(ent), color_names[ird_color_prog_background]);
1817 dump_graph_info(F, irg);
1818 print_dbg_info(F, get_entity_dbg_info(ent));
1820 dump_block_graph(F, irg);
1822 /* Close the vcg information for the irg */
1823 fprintf(F, "}\n\n");
1826 /** dumps a graph extended block-wise. Expects all blockless nodes in arr in irgs link.
1827 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1829 dump_extblock_graph(FILE *F, ir_graph *irg) {
1831 ir_graph *rem = current_ir_graph;
1832 ir_extblk **arr = ird_get_irg_link(irg);
1833 current_ir_graph = irg;
1835 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1836 ir_extblk *extbb = arr[i];
1837 ir_node *leader = get_extbb_leader(extbb);
1840 fprintf(F, "graph: { title: \"");
1841 PRINT_EXTBBID(leader);
1842 fprintf(F, "\" label: \"ExtBB %ld\" status:clustered color:lightgreen\n",
1843 get_irn_node_nr(leader));
1845 for (j = ARR_LEN(extbb->blks) - 1; j >= 0; --j) {
1846 ir_node * node = extbb->blks[j];
1847 if (is_Block(node)) {
1848 /* Dumps the block and all the nodes in the block, which are to
1849 be found in Block->link. */
1850 dump_whole_block(F, node);
1852 /* Nodes that are not in a Block. */
1854 if (is_Bad(get_nodes_block(node)) && !node_floats(node)) {
1855 dump_const_block_local(F, node);
1857 dump_ir_data_edges(F, node);
1863 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1864 dump_loop_nodes_into_graph(F, irg);
1866 current_ir_graph = rem;
1871 /*******************************************************************/
1872 /* Basic type and entity nodes and edges. */
1873 /*******************************************************************/
1875 /** dumps the edges between nodes and their type or entity attributes. */
1876 static void dump_node2type_edges(ir_node *n, void *env)
1881 switch (get_irn_opcode(n)) {
1883 /* @@@ some consts have an entity */
1886 if (SYMCONST_HAS_TYPE(get_SymConst_kind(n)))
1887 print_node_type_edge(F,n,get_SymConst_type(n),NODE2TYPE_EDGE_ATTR);
1890 print_node_ent_edge(F,n,get_Sel_entity(n),NODE2TYPE_EDGE_ATTR);
1893 print_node_type_edge(F,n,get_Call_type(n),NODE2TYPE_EDGE_ATTR);
1896 print_node_type_edge(F,n,get_Alloc_type(n),NODE2TYPE_EDGE_ATTR);
1899 print_node_type_edge(F,n,get_Free_type(n),NODE2TYPE_EDGE_ATTR);
1902 print_node_type_edge(F,n,get_Cast_type(n),NODE2TYPE_EDGE_ATTR);
1910 static int print_type_info(FILE *F, ir_type *tp) {
1913 if (get_type_state(tp) == layout_undefined) {
1914 fprintf(F, "state: layout_undefined\n");
1916 fprintf(F, "state: layout_fixed,\n");
1918 if (get_type_mode(tp))
1919 fprintf(F, "mode: %s,\n", get_mode_name_ex(get_type_mode(tp), &bad));
1920 fprintf(F, "size: %db,\n", get_type_size_bits(tp));
1925 static void print_typespecific_info(FILE *F, ir_type *tp) {
1926 switch (get_type_tpop_code(tp)) {
1928 fprintf(F, "peculiarity: %s\n", get_peculiarity_string(get_class_peculiarity(tp)));
1933 fprintf(F, "variadicity: %s\n", get_variadicity_name(get_method_variadicity(tp)));
1934 fprintf(F, "params: %d\n", get_method_n_params(tp));
1935 fprintf(F, "results: %d\n", get_method_n_ress(tp));
1941 case tpo_enumeration:
1953 static void print_typespecific_vcgattr(FILE *F, ir_type *tp) {
1954 switch (get_type_tpop_code(tp)) {
1956 if (peculiarity_existent == get_class_peculiarity(tp))
1957 fprintf(F, " " TYPE_CLASS_NODE_ATTR);
1959 fprintf(F, " " TYPE_DESCRIPTION_NODE_ATTR);
1962 fprintf(F, " " TYPE_METH_NODE_ATTR);
1970 case tpo_enumeration:
1982 int dump_type_node(FILE *F, ir_type *tp)
1986 fprintf(F, "node: {title: ");
1988 fprintf(F, " label: \"%s %s\"", get_type_tpop_name(tp), get_type_name_ex(tp, &bad));
1989 fprintf(F, " info1: \"");
1991 bad |= print_type_info(F, tp);
1992 print_typespecific_info(F, tp);
1994 dump_type_to_file(F, tp, dump_verbosity_max);
1997 print_dbg_info(F, get_type_dbg_info(tp));
1998 print_typespecific_vcgattr(F, tp);
2005 void dump_entity_node(FILE *F, ir_entity *ent)
2007 fprintf(F, "node: {title: \"");
2008 PRINT_ENTID(ent); fprintf(F, "\"");
2009 fprintf(F, DEFAULT_TYPE_ATTRIBUTE);
2010 fprintf(F, "label: ");
2011 fprintf(F, "\"%s\" ", get_ent_dump_name(ent));
2013 print_vcg_color(F, ird_color_entity);
2014 fprintf(F, "\n info1: \"");
2016 dump_entity_to_file(F, ent, dump_verbosity_entattrs | dump_verbosity_entconsts);
2019 print_dbg_info(F, get_entity_dbg_info(ent));
2023 static void dump_enum_item(FILE *F, ir_type *tp, int pos)
2026 ir_enum_const *ec = get_enumeration_const(tp, pos);
2027 ident *id = get_enumeration_nameid(ec);
2028 tarval *tv = get_enumeration_value(ec);
2031 tarval_snprintf(buf, sizeof(buf), tv);
2033 strncpy(buf, "<not set>", sizeof(buf));
2034 fprintf(F, "node: {title: \"");
2035 PRINT_ITEMID(tp, pos); fprintf(F, "\"");
2036 fprintf(F, DEFAULT_ENUM_ITEM_ATTRIBUTE);
2037 fprintf(F, "label: ");
2038 fprintf(F, "\"enum item %s\" " ENUM_ITEM_NODE_ATTR, get_id_str(id));
2039 fprintf(F, "\n info1: \"value: %s\"}\n", buf);
2043 * Dumps a new style initializer.
2045 static void dump_entity_initializer(FILE *F, const ir_entity *ent) {
2051 /** Dumps a type or entity and it's edges. */
2052 static void dump_type_info(type_or_ent tore, void *env) {
2054 int i = 0; /* to shutup gcc */
2056 /* dump this type or entity */
2058 switch (get_kind(tore.ent)) {
2060 ir_entity *ent = tore.ent;
2063 dump_entity_node(F, ent);
2065 /* skip this to reduce graph. Member edge of type is parallel to this edge. *
2066 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2067 ENT_OWN_EDGE_ATTR "}\n", ent, get_entity_owner(ent));*/
2068 print_ent_type_edge(F,ent, get_entity_type(ent), ENT_TYPE_EDGE_ATTR);
2069 if (is_Class_type(get_entity_owner(ent))) {
2070 for (i = get_entity_n_overwrites(ent) - 1; i >= 0; --i)
2071 print_ent_ent_edge(F,ent, get_entity_overwrites(ent, i), 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2073 /* attached subgraphs */
2074 if (const_entities && (get_entity_variability(ent) != variability_uninitialized)) {
2075 if (is_atomic_entity(ent)) {
2076 value = get_atomic_ent_value(ent);
2078 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2079 /* DDMN(value); $$$ */
2080 dump_const_expression(F, value);
2083 if (is_compound_entity(ent)) {
2084 if (has_entity_initializer(ent)) {
2085 /* new style initializers */
2086 dump_entity_initializer(F, ent);
2088 /* old style compound entity values */
2089 for (i = get_compound_ent_n_values(ent) - 1; i >= 0; --i) {
2090 value = get_compound_ent_value(ent, i);
2092 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2093 dump_const_expression(F, value);
2094 print_ent_ent_edge(F, ent, get_compound_ent_value_member(ent, i), 0, -1, ENT_CORR_EDGE_ATTR, i);
2096 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2097 ENT_CORR_EDGE_ATTR "}\n", GET_ENTID(ent),
2098 get_compound_ent_value_member(ent, i), i);
2108 ir_type *tp = tore.typ;
2109 dump_type_node(F, tp);
2110 /* and now the edges */
2111 switch (get_type_tpop_code(tp)) {
2113 for (i = get_class_n_supertypes(tp) - 1; i >= 0; --i)
2114 print_type_type_edge(F, tp, get_class_supertype(tp, i), TYPE_SUPER_EDGE_ATTR);
2115 for (i = get_class_n_members(tp) - 1; i >= 0; --i)
2116 print_type_ent_edge(F, tp, get_class_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
2119 for (i = get_struct_n_members(tp) - 1; i >= 0; --i)
2120 print_type_ent_edge(F, tp, get_struct_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
2123 for (i = get_method_n_params(tp) - 1; i >= 0; --i)
2124 print_type_type_edge(F, tp, get_method_param_type(tp, i), METH_PAR_EDGE_ATTR,i);
2125 for (i = get_method_n_ress(tp) - 1; i >= 0; --i)
2126 print_type_type_edge(F, tp, get_method_res_type(tp, i), METH_RES_EDGE_ATTR,i);
2129 for (i = get_union_n_members(tp) - 1; i >= 0; --i)
2130 print_type_ent_edge(F, tp, get_union_member(tp, i), UNION_EDGE_ATTR);
2133 print_type_type_edge(F, tp, get_array_element_type(tp), ARR_ELT_TYPE_EDGE_ATTR);
2134 print_type_ent_edge(F, tp, get_array_element_entity(tp), ARR_ENT_EDGE_ATTR);
2135 for (i = get_array_n_dimensions(tp) - 1; i >= 0; --i) {
2136 ir_node *upper = get_array_upper_bound(tp, i);
2137 ir_node *lower = get_array_lower_bound(tp, i);
2138 print_node_type_edge(F, upper, tp, "label: \"upper %d\"", get_array_order(tp, i));
2139 print_node_type_edge(F, lower, tp, "label: \"lower %d\"", get_array_order(tp, i));
2140 dump_const_expression(F, upper);
2141 dump_const_expression(F, lower);
2144 case tpo_enumeration:
2145 for (i = get_enumeration_n_enums(tp) - 1; i >= 0; --i) {
2146 dump_enum_item(F, tp, i);
2147 print_enum_item_edge(F, tp, i, "label: \"item %d\"", i);
2151 print_type_type_edge(F, tp, get_pointer_points_to_type(tp), PTR_PTS_TO_EDGE_ATTR);
2158 break; /* case k_type */
2161 printf(" *** irdump, dump_type_info(l.%i), faulty type.\n", __LINE__);
2162 } /* switch kind_or_entity */
2165 typedef struct _h_env {
2170 /** For dumping class hierarchies.
2171 * Dumps a class type node and a superclass edge.
2172 * If env->dump_ent dumps entities of classes and overwrites edges.
2175 dump_class_hierarchy_node(type_or_ent tore, void *ctx) {
2178 int i = 0; /* to shutup gcc */
2180 /* dump this type or entity */
2181 switch (get_kind(tore.ent)) {
2183 ir_entity *ent = tore.ent;
2184 if (get_entity_owner(ent) == get_glob_type()) break;
2185 if (!is_Method_type(get_entity_type(ent)))
2187 if (env->dump_ent && is_Class_type(get_entity_owner(ent))) {
2189 dump_entity_node(F, ent);
2191 print_type_ent_edge(F, get_entity_owner(ent), ent, TYPE_MEMBER_EDGE_ATTR);
2192 for (i = get_entity_n_overwrites(ent) - 1; i >= 0; --i)
2193 print_ent_ent_edge(F, get_entity_overwrites(ent, i), ent, 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2198 ir_type *tp = tore.typ;
2199 if (tp == get_glob_type())
2201 switch (get_type_tpop_code(tp)) {
2203 dump_type_node(F, tp);
2204 /* and now the edges */
2205 for (i = get_class_n_supertypes(tp) - 1; i >= 0; --i) {
2206 print_type_type_edge(F,tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2211 break; /* case k_type */
2214 printf(" *** irdump, dump_class_hierarchy_node(l.%i), faulty type.\n", __LINE__);
2215 } /* switch kind_or_entity */
2218 /*******************************************************************/
2219 /* dump analysis information that is expressed in graph terms. */
2220 /*******************************************************************/
2222 /* dump out edges */
2224 dump_out_edge(ir_node *n, void *env) {
2227 for (i = get_irn_n_outs(n) - 1; i >= 0; --i) {
2228 ir_node *succ = get_irn_out(n, i);
2230 print_node_edge_kind(F, succ);
2231 fprintf(F, "{sourcename: \"");
2233 fprintf(F, "\" targetname: \"");
2235 fprintf(F, "\" color: red linestyle: dashed");
2241 dump_loop_label(FILE *F, ir_loop *loop) {
2242 fprintf(F, "loop %d, %d sons, %d nodes",
2243 get_loop_depth(loop), get_loop_n_sons(loop), get_loop_n_nodes(loop));
2246 static inline void dump_loop_info(FILE *F, ir_loop *loop) {
2247 fprintf(F, " info1: \"");
2248 fprintf(F, " loop nr: %d", get_loop_loop_nr(loop));
2249 #ifdef DEBUG_libfirm /* GL @@@ debug analyses */
2250 fprintf(F, "\n The loop was analyzed %d times.", PTR_TO_INT(get_loop_link(loop)));
2256 dump_loop_node(FILE *F, ir_loop *loop) {
2257 fprintf(F, "node: {title: \"");
2259 fprintf(F, "\" label: \"");
2260 dump_loop_label(F, loop);
2262 dump_loop_info(F, loop);
2267 dump_loop_node_edge(FILE *F, ir_loop *loop, int i) {
2269 fprintf(F, "edge: {sourcename: \"");
2271 fprintf(F, "\" targetname: \"");
2272 PRINT_NODEID(get_loop_node(loop, i));
2273 fprintf(F, "\" color: green");
2278 dump_loop_son_edge(FILE *F, ir_loop *loop, int i) {
2280 fprintf(F, "edge: {sourcename: \"");
2282 fprintf(F, "\" targetname: \"");
2283 PRINT_LOOPID(get_loop_son(loop, i));
2284 fprintf(F, "\" color: darkgreen label: \"%d\"}\n",
2285 get_loop_element_pos(loop, get_loop_son(loop, i)));
2289 void dump_loops(FILE *F, ir_loop *loop) {
2291 /* dump this loop node */
2292 dump_loop_node(F, loop);
2294 /* dump edges to nodes in loop -- only if it is a real loop */
2295 if (get_loop_depth(loop) != 0) {
2296 for (i = get_loop_n_nodes(loop) - 1; i >= 0; --i) {
2297 dump_loop_node_edge(F, loop, i);
2300 for (i = get_loop_n_sons(loop) - 1; i >= 0; --i) {
2301 dump_loops(F, get_loop_son(loop, i));
2302 dump_loop_son_edge(F, loop, i);
2307 void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg) {
2308 ir_loop *loop = get_irg_loop(irg);
2311 ir_graph *rem = current_ir_graph;
2312 current_ir_graph = irg;
2314 dump_loops(F, loop);
2316 current_ir_graph = rem;
2322 * dumps the VCG header
2324 void dump_vcg_header(FILE *F, const char *name, const char *layout, const char *orientation) {
2330 label = edge_label ? "yes" : "no";
2331 if (! layout) layout = "Compilergraph";
2332 if (!orientation) orientation = "bottom_to_top";
2336 "graph: { title: \"ir graph of %s\"\n"
2337 "display_edge_labels: %s\n"
2338 "layoutalgorithm: mindepth //$ \"%s\"\n"
2339 "manhattan_edges: yes\n"
2340 "port_sharing: no\n"
2342 "classname 1: \"intrablock Data\"\n"
2343 "classname 2: \"Block\"\n"
2344 "classname 3: \"Entity type\"\n"
2345 "classname 4: \"Entity owner\"\n"
2346 "classname 5: \"Method Param\"\n"
2347 "classname 6: \"Method Res\"\n"
2348 "classname 7: \"Super\"\n"
2349 "classname 8: \"Union\"\n"
2350 "classname 9: \"Points-to\"\n"
2351 "classname 10: \"Array Element Type\"\n"
2352 "classname 11: \"Overwrites\"\n"
2353 "classname 12: \"Member\"\n"
2354 "classname 13: \"Control Flow\"\n"
2355 "classname 14: \"intrablock Memory\"\n"
2356 "classname 15: \"Dominators\"\n"
2357 "classname 16: \"interblock Data\"\n"
2358 "classname 17: \"interblock Memory\"\n"
2359 "classname 18: \"Exception Control Flow for Interval Analysis\"\n"
2360 "classname 19: \"Postdominators\"\n"
2361 "classname 20: \"Keep Alive\"\n"
2362 "classname 21: \"Out Edges\"\n"
2363 "classname 22: \"Macro Block Edges\"\n"
2364 //"classname 23: \"NoInput Nodes\"\n"
2365 "infoname 1: \"Attribute\"\n"
2366 "infoname 2: \"Verification errors\"\n"
2367 "infoname 3: \"Debug info\"\n",
2368 name, label, layout, orientation);
2370 for (i = 0; i < ird_color_count; ++i) {
2371 if (color_rgb[i] != NULL) {
2372 fprintf(F, "colorentry %s: %s\n", color_names[i], color_rgb[i]);
2375 fprintf(F, "\n"); /* a separator */
2381 * @param irg The graph to be dumped
2382 * @param suffix1 first filename suffix
2383 * @param suffix2 second filename suffix
2385 FILE *vcg_open(const ir_graph *irg, const char *suffix1, const char *suffix2) {
2387 const char *nm = get_irg_dump_name(irg);
2388 int len = strlen(nm), i, j;
2389 char *fname; /* filename to put the vcg information in */
2391 if (!suffix1) suffix1 = "";
2392 if (!suffix2) suffix2 = "";
2394 /* open file for vcg graph */
2395 fname = XMALLOCN(char, len * 2 + strlen(suffix1) + strlen(suffix2) + 5);
2397 /* strncpy (fname, nm, len); */ /* copy the filename */
2399 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2401 fname[j] = '@'; j++; fname[j] = '1'; j++;
2402 } else if (nm[i] == '@') {
2403 fname[j] = '@'; j++; fname[j] = '2'; j++;
2405 fname[j] = nm[i]; j++;
2409 strcat(fname, suffix1); /* append file suffix */
2410 strcat(fname, suffix2); /* append file suffix */
2411 strcat(fname, ".vcg"); /* append the .vcg suffix */
2413 /* vcg really expect only a <CR> at end of line, so
2414 * the "b"inary mode is what you mean (and even needed for Win32)
2416 F = fopen(fname, "wb"); /* open file for writing */
2428 * @param name prefix file name
2429 * @param suffix filename suffix
2431 FILE *vcg_open_name(const char *name, const char *suffix) {
2433 char *fname; /* filename to put the vcg information in */
2434 int i, j, len = strlen(name);
2436 if (!suffix) suffix = "";
2438 /** open file for vcg graph */
2439 fname = XMALLOCN(char, len * 2 + 5 + strlen(suffix));
2440 /* strcpy (fname, name);*/ /* copy the filename */
2442 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2443 if (name[i] == '/') {
2444 fname[j] = '@'; j++; fname[j] = '1'; j++;
2445 } else if (name[i] == '@') {
2446 fname[j] = '@'; j++; fname[j] = '2'; j++;
2448 fname[j] = name[i]; j++;
2452 strcat(fname, suffix);
2453 strcat(fname, ".vcg"); /* append the .vcg suffix */
2455 /* vcg really expect only a <CR> at end of line, so
2456 * the "b"inary mode is what you mean (and even needed for Win32)
2458 F = fopen(fname, "wb"); /* open file for writing */
2468 * Dumps the vcg file footer
2470 void dump_vcg_footer(FILE *F) {
2474 /************************************************************************/
2475 /************************************************************************/
2476 /* Routines that dump all or parts of the firm representation to a file */
2477 /************************************************************************/
2478 /************************************************************************/
2480 /************************************************************************/
2481 /* Dump ir graphs, different formats and additional information. */
2482 /************************************************************************/
2484 typedef void (*do_dump_graph_func) (ir_graph *irg, FILE *out);
2486 static void do_dump(ir_graph *irg, const char *suffix, const char *suffix_ip,
2487 const char *suffix_nonip, do_dump_graph_func dump_func)
2491 const char *suffix1;
2493 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2496 rem = current_ir_graph;
2497 current_ir_graph = irg;
2498 if (get_interprocedural_view())
2499 suffix1 = suffix_ip;
2501 suffix1 = suffix_nonip;
2502 current_ir_graph = rem;
2504 out = vcg_open(irg, suffix, suffix1);
2506 dump_func(irg, out);
2511 void dump_ir_graph_file(ir_graph *irg, FILE *out)
2513 if (dump_backedge_information_flag
2514 && get_irg_loopinfo_state(irg) != loopinfo_consistent) {
2515 construct_backedges(irg);
2518 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2520 /* call the dump graph hook */
2521 if (dump_ir_graph_hook) {
2522 if (dump_ir_graph_hook(out, irg)) {
2527 /* walk over the graph */
2528 /* dump_whole_node must be called in post visiting predecessors */
2529 ird_walk_graph(irg, NULL, dump_whole_node, out);
2531 /* dump the out edges in a separate walk */
2532 if ((dump_out_edge_flag) && (get_irg_outs_state(irg) != outs_none)) {
2533 irg_out_walk(get_irg_start(irg), dump_out_edge, NULL, out);
2536 dump_vcg_footer(out);
2539 /** Routine to dump a graph, blocks as conventional nodes. */
2540 void dump_ir_graph(ir_graph *irg, const char *suffix )
2542 do_dump(irg, suffix, "-pure-ip", "-pure", dump_ir_graph_file);
2545 void dump_ir_block_graph_file(ir_graph *irg, FILE *out)
2549 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2551 construct_block_lists(irg);
2554 * If we are in the interprocedural view, we dump not
2555 * only the requested irg but also all irgs that can be reached
2558 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2559 ir_graph *g = get_irp_irg(i);
2560 ir_node **arr = ird_get_irg_link(g);
2562 dump_graph_from_list(out, g);
2567 dump_vcg_footer(out);
2570 /* Dump a firm graph without explicit block nodes. */
2571 void dump_ir_block_graph(ir_graph *irg, const char *suffix)
2573 do_dump(irg, suffix, "-ip", "", dump_ir_block_graph_file);
2576 void dump_ir_extblock_graph_file(ir_graph *irg, FILE *F)
2579 ir_entity *ent = get_irg_entity(irg);
2581 if (get_irg_extblk_state(irg) != extblk_valid)
2584 dump_vcg_header(F, get_irg_dump_name(irg), NULL, NULL);
2586 construct_extblock_lists(irg);
2588 fprintf(F, "graph: { title: \"");
2590 fprintf(F, "\" label: \"%s\" status:clustered color: white \n",
2591 get_ent_dump_name(ent));
2593 dump_graph_info(F, irg);
2594 print_dbg_info(F, get_entity_dbg_info(ent));
2596 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2597 ir_graph *irg = get_irp_irg(i);
2598 list_tuple *lists = ird_get_irg_link(irg);
2601 /* dump the extended blocks first */
2602 if (ARR_LEN(lists->extbb_list)) {
2603 ird_set_irg_link(irg, lists->extbb_list);
2604 dump_extblock_graph(F, irg);
2607 /* we may have blocks without extended blocks, bad for instance */
2608 if (ARR_LEN(lists->blk_list)) {
2609 ird_set_irg_link(irg, lists->blk_list);
2610 dump_block_graph(F, irg);
2613 DEL_ARR_F(lists->extbb_list);
2614 DEL_ARR_F(lists->blk_list);
2619 /* Close the vcg information for the irg */
2620 fprintf(F, "}\n\n");
2626 /* Dump a firm graph without explicit block nodes but grouped in extended blocks. */
2627 void dump_ir_extblock_graph(ir_graph *irg, const char *suffix)
2629 do_dump(irg, suffix, "-ip", "", dump_ir_extblock_graph_file);
2632 void dump_ir_graph_w_types_file(ir_graph *irg, FILE *out)
2634 ir_graph *rem = current_ir_graph;
2635 int rem_dump_const_local;
2637 rem = current_ir_graph;
2638 current_ir_graph = irg;
2639 rem_dump_const_local = dump_const_local;
2640 /* dumping types does not work with local nodes */
2641 dump_const_local = 0;
2643 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2645 /* dump common ir graph */
2646 irg_walk(get_irg_end(irg), NULL, dump_whole_node, out);
2647 /* dump type info */
2648 type_walk_irg(irg, dump_type_info, NULL, out);
2649 inc_irg_visited(get_const_code_irg());
2650 /* dump edges from graph to type info */
2651 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2653 dump_vcg_footer(out);
2654 dump_const_local = rem_dump_const_local;
2655 current_ir_graph = rem;
2658 /* dumps a graph with type information */
2659 void dump_ir_graph_w_types(ir_graph *irg, const char *suffix)
2661 do_dump(irg, suffix, "-pure-wtypes-ip", "-pure-wtypes",
2662 dump_ir_graph_w_types_file);
2665 void dump_ir_block_graph_w_types_file(ir_graph *irg, FILE *out)
2668 int rem_dump_const_local;
2669 ir_graph *rem = current_ir_graph;
2671 rem_dump_const_local = dump_const_local;
2672 /* dumping types does not work with local nodes */
2673 dump_const_local = 0;
2675 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2677 /* dump common blocked ir graph */
2678 construct_block_lists(irg);
2680 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2681 ir_node **arr = ird_get_irg_link(get_irp_irg(i));
2683 dump_graph_from_list(out, get_irp_irg(i));
2688 /* dump type info */
2689 current_ir_graph = irg;
2690 type_walk_irg(irg, dump_type_info, NULL, out);
2691 inc_irg_visited(get_const_code_irg());
2693 /* dump edges from graph to type info */
2694 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2696 dump_vcg_footer(out);
2697 dump_const_local = rem_dump_const_local;
2698 current_ir_graph = rem;
2701 void dump_ir_block_graph_w_types(ir_graph *irg, const char *suffix)
2703 do_dump(irg, suffix, "-wtypes-ip", "-wtypes",
2704 dump_ir_block_graph_w_types_file);
2707 /*---------------------------------------------------------------------*/
2708 /* The following routines dump a control flow graph. */
2709 /*---------------------------------------------------------------------*/
2712 dump_block_to_cfg(ir_node *block, void *env) {
2717 if (is_Block(block)) {
2718 /* This is a block. Dump a node for the block. */
2719 fprintf(F, "node: {title: \""); PRINT_NODEID(block);
2720 fprintf(F, "\" label: \"");
2721 if (block == get_irg_start_block(get_irn_irg(block)))
2722 fprintf(F, "Start ");
2723 if (block == get_irg_end_block(get_irn_irg(block)))
2726 fprintf(F, "%s ", get_op_name(get_irn_op(block)));
2727 PRINT_NODEID(block);
2729 fprintf(F, "info1:\"");
2731 /* the generic version. */
2732 dump_irnode_to_file(F, block);
2734 /* Check whether we have bad predecessors to color the block. */
2735 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
2736 if ((fl = is_Bad(get_Block_cfgpred(block, i))))
2739 fprintf(F, "\""); /* closing quote of info */
2741 if ((block == get_irg_start_block(get_irn_irg(block))) ||
2742 (block == get_irg_end_block(get_irn_irg(block))) )
2743 fprintf(F, " color:blue ");
2745 fprintf(F, " color:yellow ");
2748 /* Dump the edges */
2749 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
2750 if (!is_Bad(skip_Proj(get_Block_cfgpred(block, i)))) {
2751 pred = get_nodes_block(skip_Proj(get_Block_cfgpred(block, i)));
2752 fprintf(F, "edge: { sourcename: \"");
2753 PRINT_NODEID(block);
2754 fprintf(F, "\" targetname: \"");
2756 fprintf(F, "\"}\n");
2759 /* Dump dominator/postdominator edge */
2760 if (dump_dominator_information_flag) {
2761 if (get_irg_dom_state(current_ir_graph) == dom_consistent && get_Block_idom(block)) {
2762 pred = get_Block_idom(block);
2763 fprintf(F, "edge: { sourcename: \"");
2764 PRINT_NODEID(block);
2765 fprintf(F, "\" targetname: \"");
2767 fprintf(F, "\" " DOMINATOR_EDGE_ATTR "}\n");
2769 if (get_irg_postdom_state(current_ir_graph) == dom_consistent && get_Block_ipostdom(block)) {
2770 pred = get_Block_ipostdom(block);
2771 fprintf(F, "edge: { sourcename: \"");
2772 PRINT_NODEID(block);
2773 fprintf(F, "\" targetname: \"");
2775 fprintf(F, "\" " POSTDOMINATOR_EDGE_ATTR "}\n");
2781 void dump_cfg(ir_graph *irg, const char *suffix)
2784 /* if a filter is set, dump only the irg's that match the filter */
2785 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2788 f = vcg_open(irg, suffix, "-cfg");
2790 ir_graph *rem = current_ir_graph;
2791 #ifdef INTERPROCEDURAL_VIEW
2792 int ipv = get_interprocedural_view();
2795 current_ir_graph = irg;
2796 dump_vcg_header(f, get_irg_dump_name(irg), NULL, NULL);
2798 #ifdef INTERPROCEDURAL_VIEW
2800 printf("Warning: dumping cfg not in interprocedural view!\n");
2801 set_interprocedural_view(0);
2805 /* walk over the blocks in the graph */
2806 irg_block_walk(get_irg_end(irg), dump_block_to_cfg, NULL, f);
2807 dump_node(f, get_irg_bad(irg));
2809 #ifdef INTERPROCEDURAL_VIEW
2810 set_interprocedural_view(ipv);
2814 current_ir_graph = rem;
2819 static void descend_and_dump(FILE *F, ir_node *n, int depth, pset *mark_set) {
2820 if (pset_find_ptr(mark_set, n))
2823 pset_insert_ptr(mark_set, n);
2826 int i, start = is_Block(n) ? 0 : -1;
2827 dump_whole_node(n, F);
2828 for (i = start; i < get_irn_arity(n); ++i)
2829 descend_and_dump(F, get_irn_n(n, i), depth-1, mark_set);
2832 /* Don't dump edges to nodes further out. These might be edges to
2833 nodes we already dumped, if there is a shorter path to these. */
2837 static int subgraph_counter = 0;
2838 void dump_subgraph(ir_node *root, int depth, const char *suffix) {
2842 sprintf(buf, "-subg_%03d", subgraph_counter++);
2843 F = vcg_open(get_irn_irg(root), suffix, buf);
2845 pset *mark_set = pset_new_ptr(1);
2846 dump_vcg_header(F, get_irg_dump_name(get_irn_irg(root)), NULL, NULL);
2847 descend_and_dump(F, root, depth, mark_set);
2854 void dump_callgraph(const char *suffix) {
2855 FILE *F = vcg_open_name("Callgraph", suffix);
2858 int i, rem = edge_label;
2861 dump_vcg_header(F, "Callgraph", "Hierarchiv", NULL);
2863 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2864 ir_graph *irg = get_irp_irg(i);
2865 ir_entity *ent = get_irg_entity(irg);
2867 int n_callees = get_irg_n_callees(irg);
2869 dump_entity_node(F, ent);
2870 for (j = 0; j < n_callees; ++j) {
2871 ir_entity *c = get_irg_entity(get_irg_callee(irg, j));
2872 //if (id_is_prefix(prefix, get_entity_ld_ident(c))) continue;
2873 int be = is_irg_callee_backedge(irg, j);
2876 "label:\"recursion %d\"" :
2877 "label:\"calls %d\"";
2878 print_ent_ent_edge(F, ent, c, be, ird_color_entity, attr, get_irg_callee_loop_depth(irg, j));
2889 /* Dump all irgs in interprocedural view to a single file. */
2890 void dump_all_cg_block_graph(const char *suffix) {
2891 FILE *f = vcg_open_name("All_graphs", suffix);
2895 int rem_view = get_interprocedural_view();
2897 set_interprocedural_view(1);
2898 dump_vcg_header(f, "All_graphs", NULL);
2900 /* collect nodes in all irgs reachable in call graph*/
2901 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2902 ird_set_irg_link(get_irp_irg(i), NULL);
2904 cg_walk(clear_link, collect_node, NULL);
2906 /* dump all graphs */
2907 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2908 current_ir_graph = get_irp_irg(i);
2909 assert(ird_get_irg_link(current_ir_graph));
2910 dump_graph_from_list(f, current_ir_graph);
2911 DEL_ARR_F(ird_get_irg_link(current_ir_graph));
2916 set_interprocedural_view(rem_view);
2921 /*---------------------------------------------------------------------*/
2922 /* the following routines dumps type information without any ir nodes. */
2923 /*---------------------------------------------------------------------*/
2926 dump_type_graph(ir_graph *irg, const char *suffix)
2930 /* if a filter is set, dump only the irg's that match the filter */
2931 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
2933 f = vcg_open(irg, suffix, "-type");
2935 ir_graph *rem = current_ir_graph;
2936 current_ir_graph = irg;
2938 dump_vcg_header(f, get_irg_dump_name(irg), "Hierarchic", NULL);
2940 /* walk over the blocks in the graph */
2941 type_walk_irg(irg, dump_type_info, NULL, f);
2942 /* The walker for the const code can be called several times for the
2943 same (sub) expression. So that no nodes are dumped several times
2944 we decrease the visited flag of the corresponding graph after each
2945 walk. So now increase it finally. */
2946 inc_irg_visited(get_const_code_irg());
2950 current_ir_graph = rem;
2955 dump_all_types(const char *suffix)
2957 FILE *f = vcg_open_name("All_types", suffix);
2959 dump_vcg_header(f, "All_types", "Hierarchic", NULL);
2960 type_walk(dump_type_info, NULL, f);
2961 inc_irg_visited(get_const_code_irg());
2969 dump_class_hierarchy(int entities, const char *suffix)
2971 FILE *f = vcg_open_name("class_hierarchy", suffix);
2976 env.dump_ent = entities;
2977 dump_vcg_header(f, "class_hierarchy", "Hierarchic", NULL);
2978 type_walk(dump_class_hierarchy_node, NULL, &env);
2985 /*---------------------------------------------------------------------*/
2986 /* dumps all graphs with the graph-dumper passed. Possible dumpers: */
2988 /* dump_ir_block_graph */
2990 /* dump_type_graph */
2991 /* dump_ir_graph_w_types */
2992 /*---------------------------------------------------------------------*/
2994 void dump_all_ir_graphs(dump_graph_func *dmp_grph, const char *suffix) {
2996 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2997 dmp_grph(get_irp_irg(i), suffix);
3001 ir_prog_pass_t pass;
3002 dump_graph_func *dump_graph;
3007 * Wrapper around dump_all_ir_graphs().
3009 static int dump_all_ir_graphs_wrapper(ir_prog *irp, void *context) {
3010 struct pass_t *pass = context;
3013 dump_all_ir_graphs(pass->dump_graph, pass->suffix);
3017 ir_prog_pass_t *dump_all_ir_graph_pass(
3018 const char *name, dump_graph_func *dump_graph, const char *suffix) {
3019 size_t len = strlen(suffix);
3020 struct pass_t *pass = xmalloc(sizeof(*pass) + len);
3021 ir_prog_pass_t *res = def_prog_pass_constructor(
3022 &pass->pass, name ? name : "dump_all_graphs", dump_all_ir_graphs_wrapper);
3024 /* this pass does not change anything, so neither dump nor verify is needed. */
3025 res->dump_irprog = ir_prog_no_dump;
3026 res->verify_irprog = ir_prog_no_verify;
3028 pass->dump_graph = dump_graph;
3029 strcpy(pass->suffix, suffix);
3034 /*--------------------------------------------------------------------------------*
3035 * Dumps a stand alone loop graph with firm nodes which belong to one loop node *
3036 * packed together in one subgraph/box *
3037 *--------------------------------------------------------------------------------*/
3039 void dump_loops_standalone(FILE *F, ir_loop *loop) {
3040 int i = 0, loop_node_started = 0, son_number = 0, first = 0;
3042 ir_loop *son = NULL;
3044 /* Dump a new loop node. */
3045 dump_loop_node(F, loop);
3047 /* Dump the loop elements. */
3048 for (i = 0; i < get_loop_n_elements(loop); i++) {
3049 le = get_loop_element(loop, i);
3051 if (get_kind(son) == k_ir_loop) {
3053 /* We are a loop son -> Recurse */
3055 if (loop_node_started) { /* Close the "firm-nodes" node first if we started one. */
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;
3064 dump_loop_son_edge(F, loop, son_number++);
3065 dump_loops_standalone(F, son);
3066 } else if (get_kind(son) == k_ir_node) {
3067 /* We are a loop node -> Collect firm nodes */
3069 ir_node *n = le.node;
3072 if (!loop_node_started) {
3073 /* Start a new node which contains all firm nodes of the current loop */
3074 fprintf(F, "node: { title: \"");
3076 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3077 loop_node_started = 1;
3082 bad |= dump_node_label(F, n);
3083 /* Causes indeterministic output: if (is_Block(n)) fprintf(F, "\t ->%d", (int)get_irn_link(n)); */
3084 if (has_backedges(n)) fprintf(F, "\t loop head!");
3085 } else { /* for callgraph loop tree */
3087 assert(get_kind(son) == k_ir_graph);
3089 /* We are a loop node -> Collect firm graphs */
3091 if (!loop_node_started) {
3092 /* Start a new node which contains all firm nodes of the current loop */
3093 fprintf(F, "node: { title: \"");
3095 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3096 loop_node_started = 1;
3100 fprintf(F, " %s", get_irg_dump_name(n));
3101 /* fprintf(F, " %s (depth %d)", get_irg_dump_name(n), n->callgraph_weighted_loop_depth); */
3105 if (loop_node_started) {
3106 fprintf(F, "\" }\n");
3107 fprintf(F, "edge: {sourcename: \"");
3109 fprintf(F, "\" targetname: \"");
3111 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3112 loop_node_started = 0;
3116 void dump_loop_tree(ir_graph *irg, const char *suffix)
3120 /* if a filter is set, dump only the irg's that match the filter */
3121 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
3124 f = vcg_open(irg, suffix, "-looptree");
3126 ir_graph *rem = current_ir_graph;
3127 int el_rem = edge_label;
3129 current_ir_graph = irg;
3132 dump_vcg_header(f, get_irg_dump_name(irg), "Tree", "top_to_bottom");
3134 if (get_irg_loop(irg))
3135 dump_loops_standalone(f, get_irg_loop(irg));
3140 edge_label = el_rem;
3141 current_ir_graph = rem;
3145 void dump_callgraph_loop_tree(const char *suffix) {
3147 F = vcg_open_name("Callgraph_looptree", suffix);
3148 dump_vcg_header(F, "callgraph looptree", "Tree", "top_to_bottom");
3149 dump_loops_standalone(F, irp->outermost_cg_loop);
3155 /*----------------------------------------------------------------------------*/
3156 /* Dumps the firm nodes in the loop tree to a graph along with the loop nodes.*/
3157 /*----------------------------------------------------------------------------*/
3159 void collect_nodeloop(FILE *F, ir_loop *loop, eset *loopnodes) {
3160 int i, son_number = 0, node_number = 0;
3162 if (dump_loop_information_flag) dump_loop_node(F, loop);
3164 for (i = 0; i < get_loop_n_elements(loop); i++) {
3165 loop_element le = get_loop_element(loop, i);
3166 if (*(le.kind) == k_ir_loop) {
3167 if (dump_loop_information_flag) dump_loop_son_edge(F, loop, son_number++);
3169 collect_nodeloop(F, le.son, loopnodes);
3171 if (dump_loop_information_flag) dump_loop_node_edge(F, loop, node_number++);
3172 eset_insert(loopnodes, le.node);
3177 void collect_nodeloop_external_nodes(ir_loop *loop, eset *loopnodes, eset *extnodes) {
3180 for(i = 0; i < get_loop_n_elements(loop); i++) {
3181 loop_element le = get_loop_element(loop, i);
3182 if (*(le.kind) == k_ir_loop) {
3184 collect_nodeloop_external_nodes(le.son, loopnodes, extnodes);
3186 if (is_Block(le.node)) start = 0; else start = -1;
3187 for (j = start; j < get_irn_arity(le.node); j++) {
3188 ir_node *pred = get_irn_n(le.node, j);
3189 if (!eset_contains(loopnodes, pred)) {
3190 eset_insert(extnodes, pred);
3191 if (!is_Block(pred)) {
3192 pred = get_nodes_block(pred);
3193 if (!eset_contains(loopnodes, pred)) eset_insert(extnodes, pred);
3201 void dump_loop(ir_loop *l, const char *suffix) {
3205 snprintf(name, sizeof(name), "loop_%d", get_loop_loop_nr(l));
3206 F = vcg_open_name(name, suffix);
3208 eset *loopnodes = eset_create();
3209 eset *extnodes = eset_create();
3212 dump_vcg_header(F, name, NULL, NULL);
3214 /* collect all nodes to dump */
3215 collect_nodeloop(F, l, loopnodes);
3216 collect_nodeloop_external_nodes(l, loopnodes, extnodes);
3218 /* build block lists */
3219 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes))
3220 set_irn_link(n, NULL);
3221 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes))
3222 set_irn_link(n, NULL);
3223 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes)) {
3225 b = get_nodes_block(n);
3226 set_irn_link(n, get_irn_link(b));
3230 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes)) {
3232 b = get_nodes_block(n);
3233 set_irn_link(n, get_irn_link(b));
3238 for (b = eset_first(loopnodes); b != NULL; b = eset_next(loopnodes)) {
3240 fprintf(F, "graph: { title: \"");
3242 fprintf(F, "\" label: \"");
3243 dump_node_opcode(F, b);
3244 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3245 fprintf(F, "\" status:clustered color:yellow\n");
3247 /* dump the blocks edges */
3248 dump_ir_data_edges(F, b);
3250 /* dump the nodes that go into the block */
3251 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3252 if (eset_contains(extnodes, n))
3253 overrule_nodecolor = ird_color_block_inout;
3255 overrule_nodecolor = ird_color_default_node;
3256 if (!eset_contains(extnodes, n)) dump_ir_data_edges(F, n);
3259 /* Close the vcg information for the block */
3261 dump_const_node_local(F, b);
3265 for (b = eset_first(extnodes); b != NULL; b = eset_next(extnodes)) {
3267 fprintf(F, "graph: { title: \"");
3269 fprintf(F, "\" label: \"");
3270 dump_node_opcode(F, b);
3271 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3272 fprintf(F, "\" status:clustered color:lightblue\n");
3274 /* dump the nodes that go into the block */
3275 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3276 if (!eset_contains(loopnodes, n))
3277 overrule_nodecolor = ird_color_block_inout;
3279 overrule_nodecolor = ird_color_default_node;
3280 if (eset_contains(loopnodes, n)) dump_ir_data_edges(F, n);
3283 /* Close the vcg information for the block */
3285 dump_const_node_local(F, b);
3289 eset_destroy(loopnodes);
3290 eset_destroy(extnodes);