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 }
957 /** the lookup table for Proj(Quot) names */
958 static const pns_lookup_t quot_lut[] = {
959 #define X(a) { pn_Quot_##a, #a }
967 /** the lookup table for Proj(DivMod) names */
968 static const pns_lookup_t divmod_lut[] = {
969 #define X(a) { pn_DivMod_##a, #a }
978 /** the lookup table for Proj(Div) names */
979 static const pns_lookup_t div_lut[] = {
980 #define X(a) { pn_Div_##a, #a }
988 /** the lookup table for Proj(Mod) names */
989 static const pns_lookup_t mod_lut[] = {
990 #define X(a) { pn_Mod_##a, #a }
998 /** the lookup table for Proj(Load) names */
999 static const pns_lookup_t load_lut[] = {
1000 #define X(a) { pn_Load_##a, #a }
1008 /** the lookup table for Proj(Store) names */
1009 static const pns_lookup_t store_lut[] = {
1010 #define X(a) { pn_Store_##a, #a }
1017 /** the lookup table for Proj(Alloc) names */
1018 static const pns_lookup_t alloc_lut[] = {
1019 #define X(a) { pn_Alloc_##a, #a }
1027 /** the lookup table for Proj(CopyB) names */
1028 static const pns_lookup_t copyb_lut[] = {
1029 #define X(a) { pn_CopyB_##a, #a }
1036 /** the lookup table for Proj(InstOf) names */
1037 static const pns_lookup_t instof_lut[] = {
1038 #define X(a) { pn_InstOf_##a, #a }
1046 /** the lookup table for Proj(Raise) names */
1047 static const pns_lookup_t raise_lut[] = {
1048 #define X(a) { pn_Raise_##a, #a }
1054 /** the lookup table for Proj(Bound) names */
1055 static const pns_lookup_t bound_lut[] = {
1056 #define X(a) { pn_Bound_##a, #a }
1064 /** the Proj lookup table */
1065 static const proj_lookup_t proj_lut[] = {
1066 #define E(a) ARR_SIZE(a), a
1067 { iro_Start, E(start_lut) },
1068 { iro_Cond, E(cond_lut) },
1069 { iro_Call, E(call_lut) },
1070 { iro_Quot, E(quot_lut) },
1071 { iro_DivMod, E(divmod_lut) },
1072 { iro_Div, E(div_lut) },
1073 { iro_Mod, E(mod_lut) },
1074 { iro_Load, E(load_lut) },
1075 { iro_Store, E(store_lut) },
1076 { iro_Alloc, E(alloc_lut) },
1077 { iro_CopyB, E(copyb_lut) },
1078 { iro_InstOf, E(instof_lut) },
1079 { iro_Raise, E(raise_lut) },
1080 { iro_Bound, E(bound_lut) }
1085 * Dump additional node attributes of some nodes to a file F.
1088 dump_node_nodeattr(FILE *F, ir_node *n)
1094 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1096 /* call the dump_node operation if available */
1098 return ops->dump_node(n, F, dump_node_nodeattr_txt);
1100 switch (get_irn_opcode(n)) {
1102 if (0 && get_interprocedural_view()) {
1103 fprintf(F, "%s ", get_ent_dump_name(get_irg_entity(current_ir_graph)));
1108 ir_fprintf(F, "%T ", get_Const_tarval(n));
1112 pred = get_Proj_pred(n);
1113 proj_nr = get_Proj_proj(n);
1115 code = get_irn_opcode(pred);
1117 if (code == iro_Cmp)
1118 fprintf(F, "%s ", get_pnc_string(get_Proj_proj(n)));
1119 else if (code == iro_Proj && get_irn_opcode(get_Proj_pred(pred)) == iro_Start)
1120 fprintf(F, "Arg %ld ", proj_nr);
1121 else if (code == iro_Cond && get_irn_mode(get_Cond_selector(pred)) != mode_b)
1122 fprintf(F, "%ld ", proj_nr);
1124 unsigned i, j, f = 0;
1126 for (i = 0; i < ARR_SIZE(proj_lut); ++i) {
1127 if (code == proj_lut[i].code) {
1128 for (j = 0; j < proj_lut[i].num_data; ++j) {
1129 if (proj_nr == proj_lut[i].data[j].nr) {
1130 fprintf(F, "%s ", proj_lut[i].data[j].name);
1139 fprintf(F, "%ld ", proj_nr);
1140 if (code == iro_Cond && get_Cond_jmp_pred(pred) != COND_JMP_PRED_NONE) {
1141 if (proj_nr == pn_Cond_false && get_Cond_jmp_pred(pred) == COND_JMP_PRED_FALSE)
1142 fprintf(F, "PRED ");
1143 if (proj_nr == pn_Cond_true && get_Cond_jmp_pred(pred) == COND_JMP_PRED_TRUE)
1144 fprintf(F, "PRED ");
1149 proj_nr = get_Filter_proj(n);
1150 if (! get_interprocedural_view()) {
1152 pred = get_Filter_pred(n);
1155 fprintf(F, "%ld ", proj_nr);
1158 fprintf(F, "%s ", get_ent_dump_name(get_Sel_entity(n)));
1161 fprintf(F, "(%s) ", get_type_name_ex(get_Cast_type(n), &bad));
1164 fprintf(F, "%s ", get_pnc_string(get_Confirm_cmp(n)));
1167 fprintf(F, "(%s) ", get_type_name_ex(get_CopyB_type(n), &bad));
1178 #include "execution_frequency.h"
1180 static void dump_node_ana_vals(FILE *F, ir_node *n) {
1184 #ifdef INTERPROCEDURAL_VIEW
1185 fprintf(F, " %lf*(%2.0lf + %2.0lf) = %2.0lf ",
1186 get_irn_exec_freq(n),
1187 get_irg_method_execution_frequency(get_irn_irg(n)),
1188 pow(5, get_irg_recursion_depth(get_irn_irg(n))),
1189 get_irn_exec_freq(n) * (get_irg_method_execution_frequency(get_irn_irg(n)) + pow(5, get_irg_recursion_depth(get_irn_irg(n))))
1195 /* Dumps a node label without the enclosing ". */
1196 int dump_node_label(FILE *F, ir_node *n) {
1199 bad |= dump_node_opcode(F, n);
1201 bad |= dump_node_mode(F, n);
1203 bad |= dump_node_typeinfo(F, n);
1204 bad |= dump_node_nodeattr(F, n);
1205 if(dump_node_idx_labels) {
1206 fprintf(F, "%ld:%d", get_irn_node_nr(n), get_irn_idx(n));
1208 fprintf(F, "%ld", get_irn_node_nr(n));
1215 * Dumps the attributes of a node n into the file F.
1216 * Currently this is only the color of a node.
1218 static void dump_node_vcgattr(FILE *F, ir_node *node, ir_node *local, int bad)
1224 print_vcg_color(F, ird_color_error);
1228 if (dump_node_vcgattr_hook)
1229 if (dump_node_vcgattr_hook(F, node, local))
1232 n = local ? local : node;
1234 if (overrule_nodecolor != ird_color_default_node) {
1235 print_vcg_color(F, overrule_nodecolor);
1239 mode = get_irn_mode(n);
1240 if(mode == mode_M) {
1241 print_vcg_color(F, ird_color_memory);
1244 if(mode == mode_X) {
1245 print_vcg_color(F, ird_color_controlflow);
1249 switch (get_irn_opcode(n)) {
1254 print_vcg_color(F, ird_color_anchor);
1257 print_vcg_color(F, ird_color_error);
1260 if (is_Block_dead(n))
1261 print_vcg_color(F, ird_color_dead_block_background);
1263 print_vcg_color(F, ird_color_block_background);
1266 print_vcg_color(F, ird_color_phi);
1269 print_vcg_color(F, ird_color_memory);
1273 print_vcg_color(F, ird_color_const);
1276 print_vcg_color(F, ird_color_proj);
1279 ir_op *op = get_irn_op(node);
1281 if(is_op_constlike(op)) {
1282 print_vcg_color(F, ird_color_const);
1283 } else if(is_op_uses_memory(op)) {
1284 print_vcg_color(F, ird_color_uses_memory);
1285 } else if(is_op_cfopcode(op) || is_op_forking(op)) {
1286 print_vcg_color(F, ird_color_controlflow);
1288 PRINT_DEFAULT_NODE_ATTR;
1294 /* Adds a new node info dumper callback. */
1295 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data)
1297 hook_entry_t *info = XMALLOC(hook_entry_t);
1299 info->hook._hook_node_info = cb;
1300 info->context = data;
1301 register_hook(hook_node_info, info);
1306 /* Remove a previously added info dumper callback. */
1307 void dump_remv_node_info_callback(void *handle)
1309 hook_entry_t *info = handle;
1310 unregister_hook(hook_node_info, info);
1315 * Dump the node information of a node n to a file F.
1317 static inline int dump_node_info(FILE *F, ir_node *n)
1320 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1322 fprintf(F, " info1: \"");
1323 bad = dump_irnode_to_file(F, n);
1324 /* call the dump_node operation if available */
1326 bad = ops->dump_node(n, F, dump_node_info_txt);
1328 /* allow additional info to be added */
1329 hook_node_info(F, n);
1335 static inline int is_constlike_node(const ir_node *node)
1337 const ir_op *op = get_irn_op(node);
1338 return is_op_constlike(op);
1342 /** outputs the predecessors of n, that are constants, local. I.e.,
1343 generates a copy of the constant predecessors for each node called with. */
1344 static void dump_const_node_local(FILE *F, ir_node *n) {
1346 if (!get_opt_dump_const_local()) return;
1348 /* Use visited flag to avoid outputting nodes twice.
1349 initialize it first. */
1350 for (i = 0; i < get_irn_arity(n); i++) {
1351 ir_node *con = get_irn_n(n, i);
1352 if (is_constlike_node(con)) {
1353 set_irn_visited(con, get_irg_visited(current_ir_graph) - 1);
1357 for (i = 0; i < get_irn_arity(n); i++) {
1358 ir_node *con = get_irn_n(n, i);
1359 if (is_constlike_node(con) && !irn_visited(con)) {
1362 mark_irn_visited(con);
1363 /* Generate a new name for the node by appending the names of
1365 fprintf(F, "node: {title: "); PRINT_CONSTID(n, con);
1366 fprintf(F, " label: \"");
1367 bad |= dump_node_label(F, con);
1369 bad |= dump_node_info(F, con);
1370 dump_node_vcgattr(F, n, con, bad);
1376 /** If the block of an edge is a const_like node, dump it local with an edge */
1377 static void dump_const_block_local(FILE *F, ir_node *n) {
1380 if (!get_opt_dump_const_local()) return;
1382 blk = get_nodes_block(n);
1383 if (is_constlike_node(blk)) {
1386 /* Generate a new name for the node by appending the names of
1388 fprintf(F, "node: {title: \""); PRINT_CONSTBLKID(n, blk);
1389 fprintf(F, "\" label: \"");
1390 bad |= dump_node_label(F, blk);
1392 bad |= dump_node_info(F, blk);
1393 dump_node_vcgattr(F, n, blk, bad);
1396 fprintf(F, "edge: { sourcename: \"");
1398 fprintf(F, "\" targetname: \""); PRINT_CONSTBLKID(n,blk);
1400 if (dump_edge_vcgattr_hook) {
1402 if (dump_edge_vcgattr_hook(F, n, -1)) {
1406 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1411 fprintf(F, "\" " BLOCK_EDGE_ATTR "}\n");
1416 * prints the error message of a node to a file F as info2.
1418 static void print_node_error(FILE *F, const char *err_msg)
1423 fprintf(F, " info2: \"%s\"", err_msg);
1427 * prints debug messages of a node to file F as info3.
1429 static void print_dbg_info(FILE *F, dbg_info *dbg)
1433 ir_dbg_info_snprint(buf, sizeof(buf), dbg);
1435 fprintf(F, " info3: \"%s\"\n", buf);
1442 static void dump_node(FILE *F, ir_node *n)
1447 if (get_opt_dump_const_local() && is_constlike_node(n))
1450 /* dump this node */
1451 fputs("node: {title: \"", F);
1455 fputs(" label: \"", F);
1456 bad = ! irn_vrfy_irg_dump(n, current_ir_graph, &p);
1457 bad |= dump_node_label(F, n);
1458 dump_node_ana_vals(F, n);
1459 //dump_node_ana_info(F, n);
1462 if (get_op_flags(get_irn_op(n)) & irop_flag_dump_noinput) {
1463 //fputs(" node_class:23", F);
1466 bad |= dump_node_info(F, n);
1467 print_node_error(F, p);
1468 print_dbg_info(F, get_irn_dbg_info(n));
1469 dump_node_vcgattr(F, n, NULL, bad);
1471 dump_const_node_local(F, n);
1473 if(dump_node_edge_hook)
1474 dump_node_edge_hook(F, n);
1477 /** dump the edge to the block this node belongs to */
1479 dump_ir_block_edge(FILE *F, ir_node *n) {
1480 if (get_opt_dump_const_local() && is_constlike_node(n)) return;
1481 if (is_no_Block(n)) {
1482 ir_node *block = get_nodes_block(n);
1484 if (get_opt_dump_const_local() && is_constlike_node(block)) {
1485 dump_const_block_local(F, n);
1487 fprintf(F, "edge: { sourcename: \"");
1489 fprintf(F, "\" targetname: ");
1490 fprintf(F, "\""); PRINT_NODEID(block); fprintf(F, "\"");
1492 if (dump_edge_vcgattr_hook) {
1494 if (dump_edge_vcgattr_hook(F, n, -1)) {
1498 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1503 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1509 print_data_edge_vcgattr(FILE *F, ir_node *from, int to) {
1511 * do not use get_nodes_block() here, will fail
1512 * if the irg is not pinned.
1514 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1515 fprintf(F, INTRA_DATA_EDGE_ATTR);
1517 fprintf(F, INTER_DATA_EDGE_ATTR);
1521 print_mem_edge_vcgattr(FILE *F, ir_node *from, int to) {
1523 * do not use get_nodes_block() here, will fail
1524 * if the irg is not pinned.
1526 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1527 fprintf(F, INTRA_MEM_EDGE_ATTR);
1529 fprintf(F, INTER_MEM_EDGE_ATTR);
1532 /** Print the vcg attributes for the edge from node from to it's to's input */
1533 static void print_edge_vcgattr(FILE *F, ir_node *from, int to) {
1536 if (dump_edge_vcgattr_hook)
1537 if (dump_edge_vcgattr_hook(F, from, to))
1540 if (dump_backedge_information_flag && is_backedge(from, to))
1541 fprintf(F, BACK_EDGE_ATTR);
1543 switch (get_irn_opcode(from)) {
1545 fprintf(F, CF_EDGE_ATTR);
1547 case iro_Start: break;
1550 if (get_irn_mode(get_End_keepalive(from, to)) == mode_BB)
1551 fprintf(F, KEEP_ALIVE_CF_EDGE_ATTR);
1553 fprintf(F, KEEP_ALIVE_DF_EDGE_ATTR);
1557 if (is_Proj(from)) {
1558 if (get_irn_mode(from) == mode_M)
1559 print_mem_edge_vcgattr(F, from, to);
1560 else if (get_irn_mode(from) == mode_X)
1561 fprintf(F, CF_EDGE_ATTR);
1563 print_data_edge_vcgattr(F, from, to);
1565 else if (get_irn_mode(get_irn_n(from, to)) == mode_M)
1566 print_mem_edge_vcgattr(F, from, to);
1567 else if (get_irn_mode(get_irn_n(from, to)) == mode_X)
1568 fprintf(F, CF_EDGE_ATTR);
1570 print_data_edge_vcgattr(F, from, to);
1574 /** dump edges to our inputs */
1575 static void dump_ir_data_edges(FILE *F, ir_node *n) {
1577 ir_visited_t visited = get_irn_visited(n);
1579 if (!dump_keepalive && is_End(n)) {
1580 /* the End node has only keep-alive edges */
1584 /* dump the dependency edges. */
1585 num = get_irn_deps(n);
1586 for (i = 0; i < num; ++i) {
1587 ir_node *dep = get_irn_dep(n, i);
1590 print_node_edge_kind(F, n);
1591 fprintf(F, "{sourcename: \"");
1593 fprintf(F, "\" targetname: ");
1594 if ((get_opt_dump_const_local()) && is_constlike_node(dep)) {
1595 PRINT_CONSTID(n, dep);
1601 fprintf(F, " label: \"%d\" ", i);
1602 fprintf(F, " color: darkgreen}\n");
1606 num = get_irn_arity(n);
1607 for (i = 0; i < num; i++) {
1608 ir_node *pred = get_irn_n(n, i);
1611 if ((get_interprocedural_view() && get_irn_visited(pred) < visited))
1612 continue; /* pred not dumped */
1614 if (dump_backedge_information_flag && is_backedge(n, i))
1615 fprintf(F, "backedge: {sourcename: \"");
1617 print_node_edge_kind(F, n);
1618 fprintf(F, "{sourcename: \"");
1621 fprintf(F, "\" targetname: ");
1622 if ((get_opt_dump_const_local()) && is_constlike_node(pred)) {
1623 PRINT_CONSTID(n, pred);
1625 fprintf(F, "\""); PRINT_NODEID(pred); fprintf(F, "\"");
1627 fprintf(F, " label: \"%d\" ", i);
1628 print_edge_vcgattr(F, n, i);
1632 if (dump_macro_block_edges && is_Block(n)) {
1633 ir_node *mb = get_Block_MacroBlock(n);
1634 fprintf(F, "edge: {sourcename: \"");
1636 fprintf(F, "\" targetname: \"");
1638 fprintf(F, "\" label: \"mb\" " MACROBLOCK_EDGE_ATTR);
1647 dump_ir_edges(FILE *F, ir_node *n) {
1648 const ir_edge_t *edge;
1651 foreach_out_edge(n, edge) {
1652 ir_node *succ = get_edge_src_irn(edge);
1654 print_node_edge_kind(F, succ);
1655 fprintf(F, "{sourcename: \"");
1657 fprintf(F, "\" targetname: \"");
1661 fprintf(F, " label: \"%d\" ", i);
1662 fprintf(F, OUT_EDGE_ATTR);
1669 /** Dumps a node and its edges but not the block edge */
1670 static void dump_node_wo_blockedge(ir_node *n, void *env) {
1673 dump_ir_data_edges(F, n);
1676 /** Dumps a node and its edges. */
1677 static void dump_whole_node(ir_node *n, void *env) {
1679 dump_node_wo_blockedge(n, env);
1680 if (!node_floats(n))
1681 dump_ir_block_edge(F, n);
1682 if (dump_new_edges_flag && edges_activated(current_ir_graph))
1683 dump_ir_edges(F, n);
1686 /** Dumps a const-like node. */
1687 static void dump_const_node(ir_node *n, void *env) {
1688 if (is_Block(n)) return;
1689 dump_node_wo_blockedge(n, env);
1692 /***********************************************************************/
1693 /* the following routines dump the nodes/irgs bracketed to graphs. */
1694 /***********************************************************************/
1696 /** Dumps a constant expression as entity initializer, array bound ...
1698 static void dump_const_expression(FILE *F, ir_node *value) {
1699 ir_graph *rem = current_ir_graph;
1700 int rem_dump_const_local = dump_const_local;
1701 dump_const_local = 0;
1702 current_ir_graph = get_const_code_irg();
1703 irg_walk(value, dump_const_node, NULL, F);
1704 /* Decrease visited flag so that we walk with the same flag for the next
1705 expression. This guarantees that we don't dump the same node twice,
1706 as for const expressions cse is performed to save memory. */
1707 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph) -1);
1708 current_ir_graph = rem;
1709 dump_const_local = rem_dump_const_local;
1712 /** Dump a block as graph containing its nodes.
1714 * Expects to find nodes belonging to the block as list in its
1716 * Dumps the edges of all nodes including itself. */
1717 static void dump_whole_block(FILE *F, ir_node *block) {
1719 ird_color_t color = ird_color_block_background;
1721 assert(is_Block(block));
1723 fprintf(F, "graph: { title: \"");
1724 PRINT_NODEID(block);
1725 fprintf(F, "\" label: \"");
1726 dump_node_label(F, block);
1728 /* colorize blocks */
1729 if (! get_Block_matured(block))
1730 color = ird_color_block_background;
1731 if (is_Block_dead(block))
1732 color = ird_color_dead_block_background;
1734 fprintf(F, "\" status:clustered ");
1735 print_vcg_color(F, color);
1738 /* yComp can show attributes for blocks, XVCG parses but ignores them */
1739 dump_node_info(F, block);
1740 print_dbg_info(F, get_irn_dbg_info(block));
1742 /* dump the blocks edges */
1743 dump_ir_data_edges(F, block);
1745 if (dump_block_edge_hook)
1746 dump_block_edge_hook(F, block);
1748 /* dump the nodes that go into the block */
1749 for (node = ird_get_irn_link(block); node; node = ird_get_irn_link(node)) {
1751 dump_ir_data_edges(F, node);
1754 /* Close the vcg information for the block */
1756 dump_const_node_local(F, block);
1760 /** dumps a graph block-wise. Expects all blockless nodes in arr in irgs link.
1761 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1763 dump_block_graph(FILE *F, ir_graph *irg) {
1765 ir_graph *rem = current_ir_graph;
1766 ir_node **arr = ird_get_irg_link(irg);
1767 current_ir_graph = irg;
1769 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1770 ir_node * node = arr[i];
1771 if (is_Block(node)) {
1772 /* Dumps the block and all the nodes in the block, which are to
1773 be found in Block->link. */
1774 dump_whole_block(F, node);
1776 /* Nodes that are not in a Block. */
1778 if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
1779 dump_const_block_local(F, node);
1781 dump_ir_data_edges(F, node);
1783 if (dump_new_edges_flag && edges_activated(irg))
1784 dump_ir_edges(F, node);
1787 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1788 dump_loop_nodes_into_graph(F, irg);
1790 current_ir_graph = rem;
1794 * Dump the info for an irg.
1795 * Parsed by XVCG but not shown. use yComp.
1797 static void dump_graph_info(FILE *F, ir_graph *irg) {
1798 fprintf(F, "info1: \"");
1799 dump_entity_to_file(F, get_irg_entity(irg), dump_verbosity_entattrs | dump_verbosity_entconsts);
1803 /** Dumps an irg as a graph clustered by block nodes.
1804 * If interprocedural view edges can point to nodes out of this graph.
1806 static void dump_graph_from_list(FILE *F, ir_graph *irg) {
1807 ir_entity *ent = get_irg_entity(irg);
1809 fprintf(F, "graph: { title: \"");
1811 fprintf(F, "\" label: \"%s\" status:clustered color:%s \n",
1812 get_ent_dump_name(ent), color_names[ird_color_prog_background]);
1814 dump_graph_info(F, irg);
1815 print_dbg_info(F, get_entity_dbg_info(ent));
1817 dump_block_graph(F, irg);
1819 /* Close the vcg information for the irg */
1820 fprintf(F, "}\n\n");
1823 /** dumps a graph extended block-wise. Expects all blockless nodes in arr in irgs link.
1824 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1826 dump_extblock_graph(FILE *F, ir_graph *irg) {
1828 ir_graph *rem = current_ir_graph;
1829 ir_extblk **arr = ird_get_irg_link(irg);
1830 current_ir_graph = irg;
1832 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1833 ir_extblk *extbb = arr[i];
1834 ir_node *leader = get_extbb_leader(extbb);
1837 fprintf(F, "graph: { title: \"");
1838 PRINT_EXTBBID(leader);
1839 fprintf(F, "\" label: \"ExtBB %ld\" status:clustered color:lightgreen\n",
1840 get_irn_node_nr(leader));
1842 for (j = ARR_LEN(extbb->blks) - 1; j >= 0; --j) {
1843 ir_node * node = extbb->blks[j];
1844 if (is_Block(node)) {
1845 /* Dumps the block and all the nodes in the block, which are to
1846 be found in Block->link. */
1847 dump_whole_block(F, node);
1849 /* Nodes that are not in a Block. */
1851 if (is_Bad(get_nodes_block(node)) && !node_floats(node)) {
1852 dump_const_block_local(F, node);
1854 dump_ir_data_edges(F, node);
1860 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1861 dump_loop_nodes_into_graph(F, irg);
1863 current_ir_graph = rem;
1868 /*******************************************************************/
1869 /* Basic type and entity nodes and edges. */
1870 /*******************************************************************/
1872 /** dumps the edges between nodes and their type or entity attributes. */
1873 static void dump_node2type_edges(ir_node *n, void *env)
1878 switch (get_irn_opcode(n)) {
1880 /* @@@ some consts have an entity */
1883 if (SYMCONST_HAS_TYPE(get_SymConst_kind(n)))
1884 print_node_type_edge(F,n,get_SymConst_type(n),NODE2TYPE_EDGE_ATTR);
1887 print_node_ent_edge(F,n,get_Sel_entity(n),NODE2TYPE_EDGE_ATTR);
1890 print_node_type_edge(F,n,get_Call_type(n),NODE2TYPE_EDGE_ATTR);
1893 print_node_type_edge(F,n,get_Alloc_type(n),NODE2TYPE_EDGE_ATTR);
1896 print_node_type_edge(F,n,get_Free_type(n),NODE2TYPE_EDGE_ATTR);
1899 print_node_type_edge(F,n,get_Cast_type(n),NODE2TYPE_EDGE_ATTR);
1907 static int print_type_info(FILE *F, ir_type *tp) {
1910 if (get_type_state(tp) == layout_undefined) {
1911 fprintf(F, "state: layout_undefined\n");
1913 fprintf(F, "state: layout_fixed,\n");
1915 if (get_type_mode(tp))
1916 fprintf(F, "mode: %s,\n", get_mode_name_ex(get_type_mode(tp), &bad));
1917 fprintf(F, "size: %db,\n", get_type_size_bits(tp));
1922 static void print_typespecific_info(FILE *F, ir_type *tp) {
1923 switch (get_type_tpop_code(tp)) {
1925 fprintf(F, "peculiarity: %s\n", get_peculiarity_string(get_class_peculiarity(tp)));
1930 fprintf(F, "variadicity: %s\n", get_variadicity_name(get_method_variadicity(tp)));
1931 fprintf(F, "params: %d\n", get_method_n_params(tp));
1932 fprintf(F, "results: %d\n", get_method_n_ress(tp));
1938 case tpo_enumeration:
1950 static void print_typespecific_vcgattr(FILE *F, ir_type *tp) {
1951 switch (get_type_tpop_code(tp)) {
1953 if (peculiarity_existent == get_class_peculiarity(tp))
1954 fprintf(F, " " TYPE_CLASS_NODE_ATTR);
1956 fprintf(F, " " TYPE_DESCRIPTION_NODE_ATTR);
1959 fprintf(F, " " TYPE_METH_NODE_ATTR);
1967 case tpo_enumeration:
1979 int dump_type_node(FILE *F, ir_type *tp)
1983 fprintf(F, "node: {title: ");
1985 fprintf(F, " label: \"%s %s\"", get_type_tpop_name(tp), get_type_name_ex(tp, &bad));
1986 fprintf(F, " info1: \"");
1988 bad |= print_type_info(F, tp);
1989 print_typespecific_info(F, tp);
1991 dump_type_to_file(F, tp, dump_verbosity_max);
1994 print_dbg_info(F, get_type_dbg_info(tp));
1995 print_typespecific_vcgattr(F, tp);
2002 void dump_entity_node(FILE *F, ir_entity *ent)
2004 fprintf(F, "node: {title: \"");
2005 PRINT_ENTID(ent); fprintf(F, "\"");
2006 fprintf(F, DEFAULT_TYPE_ATTRIBUTE);
2007 fprintf(F, "label: ");
2008 fprintf(F, "\"%s\" ", get_ent_dump_name(ent));
2010 print_vcg_color(F, ird_color_entity);
2011 fprintf(F, "\n info1: \"");
2013 dump_entity_to_file(F, ent, dump_verbosity_entattrs | dump_verbosity_entconsts);
2016 print_dbg_info(F, get_entity_dbg_info(ent));
2020 static void dump_enum_item(FILE *F, ir_type *tp, int pos)
2023 ir_enum_const *ec = get_enumeration_const(tp, pos);
2024 ident *id = get_enumeration_nameid(ec);
2025 tarval *tv = get_enumeration_value(ec);
2028 tarval_snprintf(buf, sizeof(buf), tv);
2030 strncpy(buf, "<not set>", sizeof(buf));
2031 fprintf(F, "node: {title: \"");
2032 PRINT_ITEMID(tp, pos); fprintf(F, "\"");
2033 fprintf(F, DEFAULT_ENUM_ITEM_ATTRIBUTE);
2034 fprintf(F, "label: ");
2035 fprintf(F, "\"enum item %s\" " ENUM_ITEM_NODE_ATTR, get_id_str(id));
2036 fprintf(F, "\n info1: \"value: %s\"}\n", buf);
2040 * Dumps a new style initializer.
2042 static void dump_entity_initializer(FILE *F, const ir_entity *ent) {
2048 /** Dumps a type or entity and it's edges. */
2049 static void dump_type_info(type_or_ent tore, void *env) {
2051 int i = 0; /* to shutup gcc */
2053 /* dump this type or entity */
2055 switch (get_kind(tore.ent)) {
2057 ir_entity *ent = tore.ent;
2060 dump_entity_node(F, ent);
2062 /* skip this to reduce graph. Member edge of type is parallel to this edge. *
2063 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2064 ENT_OWN_EDGE_ATTR "}\n", ent, get_entity_owner(ent));*/
2065 print_ent_type_edge(F,ent, get_entity_type(ent), ENT_TYPE_EDGE_ATTR);
2066 if (is_Class_type(get_entity_owner(ent))) {
2067 for (i = get_entity_n_overwrites(ent) - 1; i >= 0; --i)
2068 print_ent_ent_edge(F,ent, get_entity_overwrites(ent, i), 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2070 /* attached subgraphs */
2071 if (const_entities && (get_entity_variability(ent) != variability_uninitialized)) {
2072 if (is_atomic_entity(ent)) {
2073 value = get_atomic_ent_value(ent);
2075 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2076 /* DDMN(value); $$$ */
2077 dump_const_expression(F, value);
2080 if (is_compound_entity(ent)) {
2081 if (has_entity_initializer(ent)) {
2082 /* new style initializers */
2083 dump_entity_initializer(F, ent);
2085 /* old style compound entity values */
2086 for (i = get_compound_ent_n_values(ent) - 1; i >= 0; --i) {
2087 value = get_compound_ent_value(ent, i);
2089 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2090 dump_const_expression(F, value);
2091 print_ent_ent_edge(F, ent, get_compound_ent_value_member(ent, i), 0, -1, ENT_CORR_EDGE_ATTR, i);
2093 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2094 ENT_CORR_EDGE_ATTR "}\n", GET_ENTID(ent),
2095 get_compound_ent_value_member(ent, i), i);
2105 ir_type *tp = tore.typ;
2106 dump_type_node(F, tp);
2107 /* and now the edges */
2108 switch (get_type_tpop_code(tp)) {
2110 for (i = get_class_n_supertypes(tp) - 1; i >= 0; --i)
2111 print_type_type_edge(F, tp, get_class_supertype(tp, i), TYPE_SUPER_EDGE_ATTR);
2112 for (i = get_class_n_members(tp) - 1; i >= 0; --i)
2113 print_type_ent_edge(F, tp, get_class_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
2116 for (i = get_struct_n_members(tp) - 1; i >= 0; --i)
2117 print_type_ent_edge(F, tp, get_struct_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
2120 for (i = get_method_n_params(tp) - 1; i >= 0; --i)
2121 print_type_type_edge(F, tp, get_method_param_type(tp, i), METH_PAR_EDGE_ATTR,i);
2122 for (i = get_method_n_ress(tp) - 1; i >= 0; --i)
2123 print_type_type_edge(F, tp, get_method_res_type(tp, i), METH_RES_EDGE_ATTR,i);
2126 for (i = get_union_n_members(tp) - 1; i >= 0; --i)
2127 print_type_ent_edge(F, tp, get_union_member(tp, i), UNION_EDGE_ATTR);
2130 print_type_type_edge(F, tp, get_array_element_type(tp), ARR_ELT_TYPE_EDGE_ATTR);
2131 print_type_ent_edge(F, tp, get_array_element_entity(tp), ARR_ENT_EDGE_ATTR);
2132 for (i = get_array_n_dimensions(tp) - 1; i >= 0; --i) {
2133 ir_node *upper = get_array_upper_bound(tp, i);
2134 ir_node *lower = get_array_lower_bound(tp, i);
2135 print_node_type_edge(F, upper, tp, "label: \"upper %d\"", get_array_order(tp, i));
2136 print_node_type_edge(F, lower, tp, "label: \"lower %d\"", get_array_order(tp, i));
2137 dump_const_expression(F, upper);
2138 dump_const_expression(F, lower);
2141 case tpo_enumeration:
2142 for (i = get_enumeration_n_enums(tp) - 1; i >= 0; --i) {
2143 dump_enum_item(F, tp, i);
2144 print_enum_item_edge(F, tp, i, "label: \"item %d\"", i);
2148 print_type_type_edge(F, tp, get_pointer_points_to_type(tp), PTR_PTS_TO_EDGE_ATTR);
2155 break; /* case k_type */
2158 printf(" *** irdump, dump_type_info(l.%i), faulty type.\n", __LINE__);
2159 } /* switch kind_or_entity */
2162 typedef struct _h_env {
2167 /** For dumping class hierarchies.
2168 * Dumps a class type node and a superclass edge.
2169 * If env->dump_ent dumps entities of classes and overwrites edges.
2172 dump_class_hierarchy_node(type_or_ent tore, void *ctx) {
2175 int i = 0; /* to shutup gcc */
2177 /* dump this type or entity */
2178 switch (get_kind(tore.ent)) {
2180 ir_entity *ent = tore.ent;
2181 if (get_entity_owner(ent) == get_glob_type()) break;
2182 if (!is_Method_type(get_entity_type(ent)))
2184 if (env->dump_ent && is_Class_type(get_entity_owner(ent))) {
2186 dump_entity_node(F, ent);
2188 print_type_ent_edge(F, get_entity_owner(ent), ent, TYPE_MEMBER_EDGE_ATTR);
2189 for (i = get_entity_n_overwrites(ent) - 1; i >= 0; --i)
2190 print_ent_ent_edge(F, get_entity_overwrites(ent, i), ent, 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2195 ir_type *tp = tore.typ;
2196 if (tp == get_glob_type())
2198 switch (get_type_tpop_code(tp)) {
2200 dump_type_node(F, tp);
2201 /* and now the edges */
2202 for (i = get_class_n_supertypes(tp) - 1; i >= 0; --i) {
2203 print_type_type_edge(F,tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2208 break; /* case k_type */
2211 printf(" *** irdump, dump_class_hierarchy_node(l.%i), faulty type.\n", __LINE__);
2212 } /* switch kind_or_entity */
2215 /*******************************************************************/
2216 /* dump analysis information that is expressed in graph terms. */
2217 /*******************************************************************/
2219 /* dump out edges */
2221 dump_out_edge(ir_node *n, void *env) {
2224 for (i = get_irn_n_outs(n) - 1; i >= 0; --i) {
2225 ir_node *succ = get_irn_out(n, i);
2227 print_node_edge_kind(F, succ);
2228 fprintf(F, "{sourcename: \"");
2230 fprintf(F, "\" targetname: \"");
2232 fprintf(F, "\" color: red linestyle: dashed");
2238 dump_loop_label(FILE *F, ir_loop *loop) {
2239 fprintf(F, "loop %d, %d sons, %d nodes",
2240 get_loop_depth(loop), get_loop_n_sons(loop), get_loop_n_nodes(loop));
2243 static inline void dump_loop_info(FILE *F, ir_loop *loop) {
2244 fprintf(F, " info1: \"");
2245 fprintf(F, " loop nr: %d", get_loop_loop_nr(loop));
2246 #ifdef DEBUG_libfirm /* GL @@@ debug analyses */
2247 fprintf(F, "\n The loop was analyzed %d times.", PTR_TO_INT(get_loop_link(loop)));
2253 dump_loop_node(FILE *F, ir_loop *loop) {
2254 fprintf(F, "node: {title: \"");
2256 fprintf(F, "\" label: \"");
2257 dump_loop_label(F, loop);
2259 dump_loop_info(F, loop);
2264 dump_loop_node_edge(FILE *F, ir_loop *loop, int i) {
2266 fprintf(F, "edge: {sourcename: \"");
2268 fprintf(F, "\" targetname: \"");
2269 PRINT_NODEID(get_loop_node(loop, i));
2270 fprintf(F, "\" color: green");
2275 dump_loop_son_edge(FILE *F, ir_loop *loop, int i) {
2277 fprintf(F, "edge: {sourcename: \"");
2279 fprintf(F, "\" targetname: \"");
2280 PRINT_LOOPID(get_loop_son(loop, i));
2281 fprintf(F, "\" color: darkgreen label: \"%d\"}\n",
2282 get_loop_element_pos(loop, get_loop_son(loop, i)));
2286 void dump_loops(FILE *F, ir_loop *loop) {
2288 /* dump this loop node */
2289 dump_loop_node(F, loop);
2291 /* dump edges to nodes in loop -- only if it is a real loop */
2292 if (get_loop_depth(loop) != 0) {
2293 for (i = get_loop_n_nodes(loop) - 1; i >= 0; --i) {
2294 dump_loop_node_edge(F, loop, i);
2297 for (i = get_loop_n_sons(loop) - 1; i >= 0; --i) {
2298 dump_loops(F, get_loop_son(loop, i));
2299 dump_loop_son_edge(F, loop, i);
2304 void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg) {
2305 ir_loop *loop = get_irg_loop(irg);
2308 ir_graph *rem = current_ir_graph;
2309 current_ir_graph = irg;
2311 dump_loops(F, loop);
2313 current_ir_graph = rem;
2319 * dumps the VCG header
2321 void dump_vcg_header(FILE *F, const char *name, const char *layout, const char *orientation) {
2327 label = edge_label ? "yes" : "no";
2328 if (! layout) layout = "Compilergraph";
2329 if (!orientation) orientation = "bottom_to_top";
2333 "graph: { title: \"ir graph of %s\"\n"
2334 "display_edge_labels: %s\n"
2335 "layoutalgorithm: mindepth //$ \"%s\"\n"
2336 "manhattan_edges: yes\n"
2337 "port_sharing: no\n"
2339 "classname 1: \"intrablock Data\"\n"
2340 "classname 2: \"Block\"\n"
2341 "classname 3: \"Entity type\"\n"
2342 "classname 4: \"Entity owner\"\n"
2343 "classname 5: \"Method Param\"\n"
2344 "classname 6: \"Method Res\"\n"
2345 "classname 7: \"Super\"\n"
2346 "classname 8: \"Union\"\n"
2347 "classname 9: \"Points-to\"\n"
2348 "classname 10: \"Array Element Type\"\n"
2349 "classname 11: \"Overwrites\"\n"
2350 "classname 12: \"Member\"\n"
2351 "classname 13: \"Control Flow\"\n"
2352 "classname 14: \"intrablock Memory\"\n"
2353 "classname 15: \"Dominators\"\n"
2354 "classname 16: \"interblock Data\"\n"
2355 "classname 17: \"interblock Memory\"\n"
2356 "classname 18: \"Exception Control Flow for Interval Analysis\"\n"
2357 "classname 19: \"Postdominators\"\n"
2358 "classname 20: \"Keep Alive\"\n"
2359 "classname 21: \"Out Edges\"\n"
2360 "classname 22: \"Macro Block Edges\"\n"
2361 //"classname 23: \"NoInput Nodes\"\n"
2362 "infoname 1: \"Attribute\"\n"
2363 "infoname 2: \"Verification errors\"\n"
2364 "infoname 3: \"Debug info\"\n",
2365 name, label, layout, orientation);
2367 for (i = 0; i < ird_color_count; ++i) {
2368 if (color_rgb[i] != NULL) {
2369 fprintf(F, "colorentry %s: %s\n", color_names[i], color_rgb[i]);
2372 fprintf(F, "\n"); /* a separator */
2378 * @param irg The graph to be dumped
2379 * @param suffix1 first filename suffix
2380 * @param suffix2 second filename suffix
2382 FILE *vcg_open(const ir_graph *irg, const char *suffix1, const char *suffix2) {
2384 const char *nm = get_irg_dump_name(irg);
2385 int len = strlen(nm), i, j;
2386 char *fname; /* filename to put the vcg information in */
2388 if (!suffix1) suffix1 = "";
2389 if (!suffix2) suffix2 = "";
2391 /* open file for vcg graph */
2392 fname = XMALLOCN(char, len * 2 + strlen(suffix1) + strlen(suffix2) + 5);
2394 /* strncpy (fname, nm, len); */ /* copy the filename */
2396 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2398 fname[j] = '@'; j++; fname[j] = '1'; j++;
2399 } else if (nm[i] == '@') {
2400 fname[j] = '@'; j++; fname[j] = '2'; j++;
2402 fname[j] = nm[i]; j++;
2406 strcat(fname, suffix1); /* append file suffix */
2407 strcat(fname, suffix2); /* append file suffix */
2408 strcat(fname, ".vcg"); /* append the .vcg suffix */
2410 /* vcg really expect only a <CR> at end of line, so
2411 * the "b"inary mode is what you mean (and even needed for Win32)
2413 F = fopen(fname, "wb"); /* open file for writing */
2425 * @param name prefix file name
2426 * @param suffix filename suffix
2428 FILE *vcg_open_name(const char *name, const char *suffix) {
2430 char *fname; /* filename to put the vcg information in */
2431 int i, j, len = strlen(name);
2433 if (!suffix) suffix = "";
2435 /** open file for vcg graph */
2436 fname = XMALLOCN(char, len * 2 + 5 + strlen(suffix));
2437 /* strcpy (fname, name);*/ /* copy the filename */
2439 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2440 if (name[i] == '/') {
2441 fname[j] = '@'; j++; fname[j] = '1'; j++;
2442 } else if (name[i] == '@') {
2443 fname[j] = '@'; j++; fname[j] = '2'; j++;
2445 fname[j] = name[i]; j++;
2449 strcat(fname, suffix);
2450 strcat(fname, ".vcg"); /* append the .vcg suffix */
2452 /* vcg really expect only a <CR> at end of line, so
2453 * the "b"inary mode is what you mean (and even needed for Win32)
2455 F = fopen(fname, "wb"); /* open file for writing */
2465 * Dumps the vcg file footer
2467 void dump_vcg_footer(FILE *F) {
2471 /************************************************************************/
2472 /************************************************************************/
2473 /* Routines that dump all or parts of the firm representation to a file */
2474 /************************************************************************/
2475 /************************************************************************/
2477 /************************************************************************/
2478 /* Dump ir graphs, different formats and additional information. */
2479 /************************************************************************/
2481 typedef void (*do_dump_graph_func) (ir_graph *irg, FILE *out);
2483 static void do_dump(ir_graph *irg, const char *suffix, const char *suffix_ip,
2484 const char *suffix_nonip, do_dump_graph_func dump_func)
2488 const char *suffix1;
2490 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2493 rem = current_ir_graph;
2494 current_ir_graph = irg;
2495 if (get_interprocedural_view())
2496 suffix1 = suffix_ip;
2498 suffix1 = suffix_nonip;
2499 current_ir_graph = rem;
2501 out = vcg_open(irg, suffix, suffix1);
2503 dump_func(irg, out);
2508 void dump_ir_graph_file(ir_graph *irg, FILE *out)
2510 if (dump_backedge_information_flag
2511 && get_irg_loopinfo_state(irg) != loopinfo_consistent) {
2512 construct_backedges(irg);
2515 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2517 /* call the dump graph hook */
2518 if (dump_ir_graph_hook) {
2519 if (dump_ir_graph_hook(out, irg)) {
2524 /* walk over the graph */
2525 /* dump_whole_node must be called in post visiting predecessors */
2526 ird_walk_graph(irg, NULL, dump_whole_node, out);
2528 /* dump the out edges in a separate walk */
2529 if ((dump_out_edge_flag) && (get_irg_outs_state(irg) != outs_none)) {
2530 irg_out_walk(get_irg_start(irg), dump_out_edge, NULL, out);
2533 dump_vcg_footer(out);
2536 /** Routine to dump a graph, blocks as conventional nodes. */
2537 void dump_ir_graph(ir_graph *irg, const char *suffix )
2539 do_dump(irg, suffix, "-pure-ip", "-pure", dump_ir_graph_file);
2542 void dump_ir_block_graph_file(ir_graph *irg, FILE *out)
2546 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2548 construct_block_lists(irg);
2551 * If we are in the interprocedural view, we dump not
2552 * only the requested irg but also all irgs that can be reached
2555 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2556 ir_graph *g = get_irp_irg(i);
2557 ir_node **arr = ird_get_irg_link(g);
2559 dump_graph_from_list(out, g);
2564 dump_vcg_footer(out);
2567 /* Dump a firm graph without explicit block nodes. */
2568 void dump_ir_block_graph(ir_graph *irg, const char *suffix)
2570 do_dump(irg, suffix, "-ip", "", dump_ir_block_graph_file);
2573 void dump_ir_extblock_graph_file(ir_graph *irg, FILE *F)
2576 ir_entity *ent = get_irg_entity(irg);
2578 if (get_irg_extblk_state(irg) != extblk_valid)
2581 dump_vcg_header(F, get_irg_dump_name(irg), NULL, NULL);
2583 construct_extblock_lists(irg);
2585 fprintf(F, "graph: { title: \"");
2587 fprintf(F, "\" label: \"%s\" status:clustered color: white \n",
2588 get_ent_dump_name(ent));
2590 dump_graph_info(F, irg);
2591 print_dbg_info(F, get_entity_dbg_info(ent));
2593 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2594 ir_graph *irg = get_irp_irg(i);
2595 list_tuple *lists = ird_get_irg_link(irg);
2598 /* dump the extended blocks first */
2599 if (ARR_LEN(lists->extbb_list)) {
2600 ird_set_irg_link(irg, lists->extbb_list);
2601 dump_extblock_graph(F, irg);
2604 /* we may have blocks without extended blocks, bad for instance */
2605 if (ARR_LEN(lists->blk_list)) {
2606 ird_set_irg_link(irg, lists->blk_list);
2607 dump_block_graph(F, irg);
2610 DEL_ARR_F(lists->extbb_list);
2611 DEL_ARR_F(lists->blk_list);
2616 /* Close the vcg information for the irg */
2617 fprintf(F, "}\n\n");
2623 /* Dump a firm graph without explicit block nodes but grouped in extended blocks. */
2624 void dump_ir_extblock_graph(ir_graph *irg, const char *suffix)
2626 do_dump(irg, suffix, "-ip", "", dump_ir_extblock_graph_file);
2629 void dump_ir_graph_w_types_file(ir_graph *irg, FILE *out)
2631 ir_graph *rem = current_ir_graph;
2632 int rem_dump_const_local;
2634 rem = current_ir_graph;
2635 current_ir_graph = irg;
2636 rem_dump_const_local = dump_const_local;
2637 /* dumping types does not work with local nodes */
2638 dump_const_local = 0;
2640 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2642 /* dump common ir graph */
2643 irg_walk(get_irg_end(irg), NULL, dump_whole_node, out);
2644 /* dump type info */
2645 type_walk_irg(irg, dump_type_info, NULL, out);
2646 inc_irg_visited(get_const_code_irg());
2647 /* dump edges from graph to type info */
2648 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2650 dump_vcg_footer(out);
2651 dump_const_local = rem_dump_const_local;
2652 current_ir_graph = rem;
2655 /* dumps a graph with type information */
2656 void dump_ir_graph_w_types(ir_graph *irg, const char *suffix)
2658 do_dump(irg, suffix, "-pure-wtypes-ip", "-pure-wtypes",
2659 dump_ir_graph_w_types_file);
2662 void dump_ir_block_graph_w_types_file(ir_graph *irg, FILE *out)
2665 int rem_dump_const_local;
2666 ir_graph *rem = current_ir_graph;
2668 rem_dump_const_local = dump_const_local;
2669 /* dumping types does not work with local nodes */
2670 dump_const_local = 0;
2672 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2674 /* dump common blocked ir graph */
2675 construct_block_lists(irg);
2677 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2678 ir_node **arr = ird_get_irg_link(get_irp_irg(i));
2680 dump_graph_from_list(out, get_irp_irg(i));
2685 /* dump type info */
2686 current_ir_graph = irg;
2687 type_walk_irg(irg, dump_type_info, NULL, out);
2688 inc_irg_visited(get_const_code_irg());
2690 /* dump edges from graph to type info */
2691 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2693 dump_vcg_footer(out);
2694 dump_const_local = rem_dump_const_local;
2695 current_ir_graph = rem;
2698 void dump_ir_block_graph_w_types(ir_graph *irg, const char *suffix)
2700 do_dump(irg, suffix, "-wtypes-ip", "-wtypes",
2701 dump_ir_block_graph_w_types_file);
2704 /*---------------------------------------------------------------------*/
2705 /* The following routines dump a control flow graph. */
2706 /*---------------------------------------------------------------------*/
2709 dump_block_to_cfg(ir_node *block, void *env) {
2714 if (is_Block(block)) {
2715 /* This is a block. Dump a node for the block. */
2716 fprintf(F, "node: {title: \""); PRINT_NODEID(block);
2717 fprintf(F, "\" label: \"");
2718 if (block == get_irg_start_block(get_irn_irg(block)))
2719 fprintf(F, "Start ");
2720 if (block == get_irg_end_block(get_irn_irg(block)))
2723 fprintf(F, "%s ", get_op_name(get_irn_op(block)));
2724 PRINT_NODEID(block);
2726 fprintf(F, "info1:\"");
2728 /* the generic version. */
2729 dump_irnode_to_file(F, block);
2731 /* Check whether we have bad predecessors to color the block. */
2732 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
2733 if ((fl = is_Bad(get_Block_cfgpred(block, i))))
2736 fprintf(F, "\""); /* closing quote of info */
2738 if ((block == get_irg_start_block(get_irn_irg(block))) ||
2739 (block == get_irg_end_block(get_irn_irg(block))) )
2740 fprintf(F, " color:blue ");
2742 fprintf(F, " color:yellow ");
2745 /* Dump the edges */
2746 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
2747 if (!is_Bad(skip_Proj(get_Block_cfgpred(block, i)))) {
2748 pred = get_nodes_block(skip_Proj(get_Block_cfgpred(block, i)));
2749 fprintf(F, "edge: { sourcename: \"");
2750 PRINT_NODEID(block);
2751 fprintf(F, "\" targetname: \"");
2753 fprintf(F, "\"}\n");
2756 /* Dump dominator/postdominator edge */
2757 if (dump_dominator_information_flag) {
2758 if (get_irg_dom_state(current_ir_graph) == dom_consistent && get_Block_idom(block)) {
2759 pred = get_Block_idom(block);
2760 fprintf(F, "edge: { sourcename: \"");
2761 PRINT_NODEID(block);
2762 fprintf(F, "\" targetname: \"");
2764 fprintf(F, "\" " DOMINATOR_EDGE_ATTR "}\n");
2766 if (get_irg_postdom_state(current_ir_graph) == dom_consistent && get_Block_ipostdom(block)) {
2767 pred = get_Block_ipostdom(block);
2768 fprintf(F, "edge: { sourcename: \"");
2769 PRINT_NODEID(block);
2770 fprintf(F, "\" targetname: \"");
2772 fprintf(F, "\" " POSTDOMINATOR_EDGE_ATTR "}\n");
2778 void dump_cfg(ir_graph *irg, const char *suffix)
2781 /* if a filter is set, dump only the irg's that match the filter */
2782 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2785 f = vcg_open(irg, suffix, "-cfg");
2787 ir_graph *rem = current_ir_graph;
2788 #ifdef INTERPROCEDURAL_VIEW
2789 int ipv = get_interprocedural_view();
2792 current_ir_graph = irg;
2793 dump_vcg_header(f, get_irg_dump_name(irg), NULL, NULL);
2795 #ifdef INTERPROCEDURAL_VIEW
2797 printf("Warning: dumping cfg not in interprocedural view!\n");
2798 set_interprocedural_view(0);
2802 /* walk over the blocks in the graph */
2803 irg_block_walk(get_irg_end(irg), dump_block_to_cfg, NULL, f);
2804 dump_node(f, get_irg_bad(irg));
2806 #ifdef INTERPROCEDURAL_VIEW
2807 set_interprocedural_view(ipv);
2811 current_ir_graph = rem;
2816 static void descend_and_dump(FILE *F, ir_node *n, int depth, pset *mark_set) {
2817 if (pset_find_ptr(mark_set, n))
2820 pset_insert_ptr(mark_set, n);
2823 int i, start = is_Block(n) ? 0 : -1;
2824 dump_whole_node(n, F);
2825 for (i = start; i < get_irn_arity(n); ++i)
2826 descend_and_dump(F, get_irn_n(n, i), depth-1, mark_set);
2829 /* Don't dump edges to nodes further out. These might be edges to
2830 nodes we already dumped, if there is a shorter path to these. */
2834 static int subgraph_counter = 0;
2835 void dump_subgraph(ir_node *root, int depth, const char *suffix) {
2839 sprintf(buf, "-subg_%03d", subgraph_counter++);
2840 F = vcg_open(get_irn_irg(root), suffix, buf);
2842 pset *mark_set = pset_new_ptr(1);
2843 dump_vcg_header(F, get_irg_dump_name(get_irn_irg(root)), NULL, NULL);
2844 descend_and_dump(F, root, depth, mark_set);
2851 void dump_callgraph(const char *suffix) {
2852 FILE *F = vcg_open_name("Callgraph", suffix);
2855 int i, rem = edge_label;
2858 dump_vcg_header(F, "Callgraph", "Hierarchiv", NULL);
2860 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2861 ir_graph *irg = get_irp_irg(i);
2862 ir_entity *ent = get_irg_entity(irg);
2864 int n_callees = get_irg_n_callees(irg);
2866 dump_entity_node(F, ent);
2867 for (j = 0; j < n_callees; ++j) {
2868 ir_entity *c = get_irg_entity(get_irg_callee(irg, j));
2869 //if (id_is_prefix(prefix, get_entity_ld_ident(c))) continue;
2870 int be = is_irg_callee_backedge(irg, j);
2873 "label:\"recursion %d\"" :
2874 "label:\"calls %d\"";
2875 print_ent_ent_edge(F, ent, c, be, ird_color_entity, attr, get_irg_callee_loop_depth(irg, j));
2886 /* Dump all irgs in interprocedural view to a single file. */
2887 void dump_all_cg_block_graph(const char *suffix) {
2888 FILE *f = vcg_open_name("All_graphs", suffix);
2892 int rem_view = get_interprocedural_view();
2894 set_interprocedural_view(1);
2895 dump_vcg_header(f, "All_graphs", NULL);
2897 /* collect nodes in all irgs reachable in call graph*/
2898 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2899 ird_set_irg_link(get_irp_irg(i), NULL);
2901 cg_walk(clear_link, collect_node, NULL);
2903 /* dump all graphs */
2904 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2905 current_ir_graph = get_irp_irg(i);
2906 assert(ird_get_irg_link(current_ir_graph));
2907 dump_graph_from_list(f, current_ir_graph);
2908 DEL_ARR_F(ird_get_irg_link(current_ir_graph));
2913 set_interprocedural_view(rem_view);
2918 /*---------------------------------------------------------------------*/
2919 /* the following routines dumps type information without any ir nodes. */
2920 /*---------------------------------------------------------------------*/
2923 dump_type_graph(ir_graph *irg, const char *suffix)
2927 /* if a filter is set, dump only the irg's that match the filter */
2928 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
2930 f = vcg_open(irg, suffix, "-type");
2932 ir_graph *rem = current_ir_graph;
2933 current_ir_graph = irg;
2935 dump_vcg_header(f, get_irg_dump_name(irg), "Hierarchic", NULL);
2937 /* walk over the blocks in the graph */
2938 type_walk_irg(irg, dump_type_info, NULL, f);
2939 /* The walker for the const code can be called several times for the
2940 same (sub) expression. So that no nodes are dumped several times
2941 we decrease the visited flag of the corresponding graph after each
2942 walk. So now increase it finally. */
2943 inc_irg_visited(get_const_code_irg());
2947 current_ir_graph = rem;
2952 dump_all_types(const char *suffix)
2954 FILE *f = vcg_open_name("All_types", suffix);
2956 dump_vcg_header(f, "All_types", "Hierarchic", NULL);
2957 type_walk(dump_type_info, NULL, f);
2958 inc_irg_visited(get_const_code_irg());
2966 dump_class_hierarchy(int entities, const char *suffix)
2968 FILE *f = vcg_open_name("class_hierarchy", suffix);
2973 env.dump_ent = entities;
2974 dump_vcg_header(f, "class_hierarchy", "Hierarchic", NULL);
2975 type_walk(dump_class_hierarchy_node, NULL, &env);
2982 /*---------------------------------------------------------------------*/
2983 /* dumps all graphs with the graph-dumper passed. Possible dumpers: */
2985 /* dump_ir_block_graph */
2987 /* dump_type_graph */
2988 /* dump_ir_graph_w_types */
2989 /*---------------------------------------------------------------------*/
2991 void dump_all_ir_graphs(dump_graph_func *dmp_grph, const char *suffix) {
2993 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2994 dmp_grph(get_irp_irg(i), suffix);
2998 ir_prog_pass_t pass;
2999 dump_graph_func *dump_graph;
3004 * Wrapper around dump_all_ir_graphs().
3006 static int dump_all_ir_graphs_wrapper(ir_prog *irp, void *context) {
3007 struct pass_t *pass = context;
3010 dump_all_ir_graphs(pass->dump_graph, pass->suffix);
3014 ir_prog_pass_t *dump_all_ir_graph_pass(
3015 const char *name, dump_graph_func *dump_graph, const char *suffix) {
3016 size_t len = strlen(suffix);
3017 struct pass_t *pass = xmalloc(sizeof(*pass) + len);
3018 ir_prog_pass_t *res = def_prog_pass_constructor(
3019 &pass->pass, name ? name : "dump_all_graphs", dump_all_ir_graphs_wrapper);
3021 /* this pass does not change anything, so neither dump nor verify is needed. */
3022 res->dump_irprog = ir_prog_no_dump;
3023 res->verify_irprog = ir_prog_no_verify;
3025 pass->dump_graph = dump_graph;
3026 strcpy(pass->suffix, suffix);
3031 /*--------------------------------------------------------------------------------*
3032 * Dumps a stand alone loop graph with firm nodes which belong to one loop node *
3033 * packed together in one subgraph/box *
3034 *--------------------------------------------------------------------------------*/
3036 void dump_loops_standalone(FILE *F, ir_loop *loop) {
3037 int i = 0, loop_node_started = 0, son_number = 0, first = 0;
3039 ir_loop *son = NULL;
3041 /* Dump a new loop node. */
3042 dump_loop_node(F, loop);
3044 /* Dump the loop elements. */
3045 for (i = 0; i < get_loop_n_elements(loop); i++) {
3046 le = get_loop_element(loop, i);
3048 if (get_kind(son) == k_ir_loop) {
3050 /* We are a loop son -> Recurse */
3052 if (loop_node_started) { /* Close the "firm-nodes" node first if we started one. */
3053 fprintf(F, "\" }\n");
3054 fprintf(F, "edge: {sourcename: \"");
3056 fprintf(F, "\" targetname: \"");
3058 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3059 loop_node_started = 0;
3061 dump_loop_son_edge(F, loop, son_number++);
3062 dump_loops_standalone(F, son);
3063 } else if (get_kind(son) == k_ir_node) {
3064 /* We are a loop node -> Collect firm nodes */
3066 ir_node *n = le.node;
3069 if (!loop_node_started) {
3070 /* Start a new node which contains all firm nodes of the current loop */
3071 fprintf(F, "node: { title: \"");
3073 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3074 loop_node_started = 1;
3079 bad |= dump_node_label(F, n);
3080 /* Causes indeterministic output: if (is_Block(n)) fprintf(F, "\t ->%d", (int)get_irn_link(n)); */
3081 if (has_backedges(n)) fprintf(F, "\t loop head!");
3082 } else { /* for callgraph loop tree */
3084 assert(get_kind(son) == k_ir_graph);
3086 /* We are a loop node -> Collect firm graphs */
3088 if (!loop_node_started) {
3089 /* Start a new node which contains all firm nodes of the current loop */
3090 fprintf(F, "node: { title: \"");
3092 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3093 loop_node_started = 1;
3097 fprintf(F, " %s", get_irg_dump_name(n));
3098 /* fprintf(F, " %s (depth %d)", get_irg_dump_name(n), n->callgraph_weighted_loop_depth); */
3102 if (loop_node_started) {
3103 fprintf(F, "\" }\n");
3104 fprintf(F, "edge: {sourcename: \"");
3106 fprintf(F, "\" targetname: \"");
3108 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3109 loop_node_started = 0;
3113 void dump_loop_tree(ir_graph *irg, const char *suffix)
3117 /* if a filter is set, dump only the irg's that match the filter */
3118 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
3121 f = vcg_open(irg, suffix, "-looptree");
3123 ir_graph *rem = current_ir_graph;
3124 int el_rem = edge_label;
3126 current_ir_graph = irg;
3129 dump_vcg_header(f, get_irg_dump_name(irg), "Tree", "top_to_bottom");
3131 if (get_irg_loop(irg))
3132 dump_loops_standalone(f, get_irg_loop(irg));
3137 edge_label = el_rem;
3138 current_ir_graph = rem;
3142 void dump_callgraph_loop_tree(const char *suffix) {
3144 F = vcg_open_name("Callgraph_looptree", suffix);
3145 dump_vcg_header(F, "callgraph looptree", "Tree", "top_to_bottom");
3146 dump_loops_standalone(F, irp->outermost_cg_loop);
3152 /*----------------------------------------------------------------------------*/
3153 /* Dumps the firm nodes in the loop tree to a graph along with the loop nodes.*/
3154 /*----------------------------------------------------------------------------*/
3156 void collect_nodeloop(FILE *F, ir_loop *loop, eset *loopnodes) {
3157 int i, son_number = 0, node_number = 0;
3159 if (dump_loop_information_flag) dump_loop_node(F, loop);
3161 for (i = 0; i < get_loop_n_elements(loop); i++) {
3162 loop_element le = get_loop_element(loop, i);
3163 if (*(le.kind) == k_ir_loop) {
3164 if (dump_loop_information_flag) dump_loop_son_edge(F, loop, son_number++);
3166 collect_nodeloop(F, le.son, loopnodes);
3168 if (dump_loop_information_flag) dump_loop_node_edge(F, loop, node_number++);
3169 eset_insert(loopnodes, le.node);
3174 void collect_nodeloop_external_nodes(ir_loop *loop, eset *loopnodes, eset *extnodes) {
3177 for(i = 0; i < get_loop_n_elements(loop); i++) {
3178 loop_element le = get_loop_element(loop, i);
3179 if (*(le.kind) == k_ir_loop) {
3181 collect_nodeloop_external_nodes(le.son, loopnodes, extnodes);
3183 if (is_Block(le.node)) start = 0; else start = -1;
3184 for (j = start; j < get_irn_arity(le.node); j++) {
3185 ir_node *pred = get_irn_n(le.node, j);
3186 if (!eset_contains(loopnodes, pred)) {
3187 eset_insert(extnodes, pred);
3188 if (!is_Block(pred)) {
3189 pred = get_nodes_block(pred);
3190 if (!eset_contains(loopnodes, pred)) eset_insert(extnodes, pred);
3198 void dump_loop(ir_loop *l, const char *suffix) {
3202 snprintf(name, sizeof(name), "loop_%d", get_loop_loop_nr(l));
3203 F = vcg_open_name(name, suffix);
3205 eset *loopnodes = eset_create();
3206 eset *extnodes = eset_create();
3209 dump_vcg_header(F, name, NULL, NULL);
3211 /* collect all nodes to dump */
3212 collect_nodeloop(F, l, loopnodes);
3213 collect_nodeloop_external_nodes(l, loopnodes, extnodes);
3215 /* build block lists */
3216 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes))
3217 set_irn_link(n, NULL);
3218 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes))
3219 set_irn_link(n, NULL);
3220 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes)) {
3222 b = get_nodes_block(n);
3223 set_irn_link(n, get_irn_link(b));
3227 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes)) {
3229 b = get_nodes_block(n);
3230 set_irn_link(n, get_irn_link(b));
3235 for (b = eset_first(loopnodes); b != NULL; b = eset_next(loopnodes)) {
3237 fprintf(F, "graph: { title: \"");
3239 fprintf(F, "\" label: \"");
3240 dump_node_opcode(F, b);
3241 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3242 fprintf(F, "\" status:clustered color:yellow\n");
3244 /* dump the blocks edges */
3245 dump_ir_data_edges(F, b);
3247 /* dump the nodes that go into the block */
3248 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3249 if (eset_contains(extnodes, n))
3250 overrule_nodecolor = ird_color_block_inout;
3252 overrule_nodecolor = ird_color_default_node;
3253 if (!eset_contains(extnodes, n)) dump_ir_data_edges(F, n);
3256 /* Close the vcg information for the block */
3258 dump_const_node_local(F, b);
3262 for (b = eset_first(extnodes); b != NULL; b = eset_next(extnodes)) {
3264 fprintf(F, "graph: { title: \"");
3266 fprintf(F, "\" label: \"");
3267 dump_node_opcode(F, b);
3268 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3269 fprintf(F, "\" status:clustered color:lightblue\n");
3271 /* dump the nodes that go into the block */
3272 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3273 if (!eset_contains(loopnodes, n))
3274 overrule_nodecolor = ird_color_block_inout;
3276 overrule_nodecolor = ird_color_default_node;
3277 if (eset_contains(loopnodes, n)) dump_ir_data_edges(F, n);
3280 /* Close the vcg information for the block */
3282 dump_const_node_local(F, b);
3286 eset_destroy(loopnodes);
3287 eset_destroy(extnodes);