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 if (__dbg_info_snprint) {
1435 if (__dbg_info_snprint(buf, sizeof(buf), dbg) > 0)
1436 fprintf(F, " info3: \"%s\"\n", buf);
1443 static void dump_node(FILE *F, ir_node *n)
1448 if (get_opt_dump_const_local() && is_constlike_node(n))
1451 /* dump this node */
1452 fputs("node: {title: \"", F);
1456 fputs(" label: \"", F);
1457 bad = ! irn_vrfy_irg_dump(n, current_ir_graph, &p);
1458 bad |= dump_node_label(F, n);
1459 dump_node_ana_vals(F, n);
1460 //dump_node_ana_info(F, n);
1463 if (get_op_flags(get_irn_op(n)) & irop_flag_dump_noinput) {
1464 //fputs(" node_class:23", F);
1467 bad |= dump_node_info(F, n);
1468 print_node_error(F, p);
1469 print_dbg_info(F, get_irn_dbg_info(n));
1470 dump_node_vcgattr(F, n, NULL, bad);
1472 dump_const_node_local(F, n);
1474 if(dump_node_edge_hook)
1475 dump_node_edge_hook(F, n);
1478 /** dump the edge to the block this node belongs to */
1480 dump_ir_block_edge(FILE *F, ir_node *n) {
1481 if (get_opt_dump_const_local() && is_constlike_node(n)) return;
1482 if (is_no_Block(n)) {
1483 ir_node *block = get_nodes_block(n);
1485 if (get_opt_dump_const_local() && is_constlike_node(block)) {
1486 dump_const_block_local(F, n);
1488 fprintf(F, "edge: { sourcename: \"");
1490 fprintf(F, "\" targetname: ");
1491 fprintf(F, "\""); PRINT_NODEID(block); fprintf(F, "\"");
1493 if (dump_edge_vcgattr_hook) {
1495 if (dump_edge_vcgattr_hook(F, n, -1)) {
1499 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1504 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1510 print_data_edge_vcgattr(FILE *F, ir_node *from, int to) {
1512 * do not use get_nodes_block() here, will fail
1513 * if the irg is not pinned.
1515 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1516 fprintf(F, INTRA_DATA_EDGE_ATTR);
1518 fprintf(F, INTER_DATA_EDGE_ATTR);
1522 print_mem_edge_vcgattr(FILE *F, ir_node *from, int to) {
1524 * do not use get_nodes_block() here, will fail
1525 * if the irg is not pinned.
1527 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1528 fprintf(F, INTRA_MEM_EDGE_ATTR);
1530 fprintf(F, INTER_MEM_EDGE_ATTR);
1533 /** Print the vcg attributes for the edge from node from to it's to's input */
1534 static void print_edge_vcgattr(FILE *F, ir_node *from, int to) {
1537 if (dump_edge_vcgattr_hook)
1538 if (dump_edge_vcgattr_hook(F, from, to))
1541 if (dump_backedge_information_flag && is_backedge(from, to))
1542 fprintf(F, BACK_EDGE_ATTR);
1544 switch (get_irn_opcode(from)) {
1546 fprintf(F, CF_EDGE_ATTR);
1548 case iro_Start: break;
1551 if (get_irn_mode(get_End_keepalive(from, to)) == mode_BB)
1552 fprintf(F, KEEP_ALIVE_CF_EDGE_ATTR);
1554 fprintf(F, KEEP_ALIVE_DF_EDGE_ATTR);
1558 if (is_Proj(from)) {
1559 if (get_irn_mode(from) == mode_M)
1560 print_mem_edge_vcgattr(F, from, to);
1561 else if (get_irn_mode(from) == mode_X)
1562 fprintf(F, CF_EDGE_ATTR);
1564 print_data_edge_vcgattr(F, from, to);
1566 else if (get_irn_mode(get_irn_n(from, to)) == mode_M)
1567 print_mem_edge_vcgattr(F, from, to);
1568 else if (get_irn_mode(get_irn_n(from, to)) == mode_X)
1569 fprintf(F, CF_EDGE_ATTR);
1571 print_data_edge_vcgattr(F, from, to);
1575 /** dump edges to our inputs */
1576 static void dump_ir_data_edges(FILE *F, ir_node *n) {
1578 ir_visited_t visited = get_irn_visited(n);
1580 if (!dump_keepalive && is_End(n)) {
1581 /* the End node has only keep-alive edges */
1585 /* dump the dependency edges. */
1586 num = get_irn_deps(n);
1587 for (i = 0; i < num; ++i) {
1588 ir_node *dep = get_irn_dep(n, i);
1591 print_node_edge_kind(F, n);
1592 fprintf(F, "{sourcename: \"");
1594 fprintf(F, "\" targetname: ");
1595 if ((get_opt_dump_const_local()) && is_constlike_node(dep)) {
1596 PRINT_CONSTID(n, dep);
1602 fprintf(F, " label: \"%d\" ", i);
1603 fprintf(F, " color: darkgreen}\n");
1607 num = get_irn_arity(n);
1608 for (i = 0; i < num; i++) {
1609 ir_node *pred = get_irn_n(n, i);
1612 if ((get_interprocedural_view() && get_irn_visited(pred) < visited))
1613 continue; /* pred not dumped */
1615 if (dump_backedge_information_flag && is_backedge(n, i))
1616 fprintf(F, "backedge: {sourcename: \"");
1618 print_node_edge_kind(F, n);
1619 fprintf(F, "{sourcename: \"");
1622 fprintf(F, "\" targetname: ");
1623 if ((get_opt_dump_const_local()) && is_constlike_node(pred)) {
1624 PRINT_CONSTID(n, pred);
1626 fprintf(F, "\""); PRINT_NODEID(pred); fprintf(F, "\"");
1628 fprintf(F, " label: \"%d\" ", i);
1629 print_edge_vcgattr(F, n, i);
1633 if (dump_macro_block_edges && is_Block(n)) {
1634 ir_node *mb = get_Block_MacroBlock(n);
1635 fprintf(F, "edge: {sourcename: \"");
1637 fprintf(F, "\" targetname: \"");
1639 fprintf(F, "\" label: \"mb\" " MACROBLOCK_EDGE_ATTR);
1648 dump_ir_edges(FILE *F, ir_node *n) {
1649 const ir_edge_t *edge;
1652 foreach_out_edge(n, edge) {
1653 ir_node *succ = get_edge_src_irn(edge);
1655 print_node_edge_kind(F, succ);
1656 fprintf(F, "{sourcename: \"");
1658 fprintf(F, "\" targetname: \"");
1662 fprintf(F, " label: \"%d\" ", i);
1663 fprintf(F, OUT_EDGE_ATTR);
1670 /** Dumps a node and its edges but not the block edge */
1671 static void dump_node_wo_blockedge(ir_node *n, void *env) {
1674 dump_ir_data_edges(F, n);
1677 /** Dumps a node and its edges. */
1678 static void dump_whole_node(ir_node *n, void *env) {
1680 dump_node_wo_blockedge(n, env);
1681 if (!node_floats(n))
1682 dump_ir_block_edge(F, n);
1683 if (dump_new_edges_flag && edges_activated(current_ir_graph))
1684 dump_ir_edges(F, n);
1687 /** Dumps a const-like node. */
1688 static void dump_const_node(ir_node *n, void *env) {
1689 if (is_Block(n)) return;
1690 dump_node_wo_blockedge(n, env);
1693 /***********************************************************************/
1694 /* the following routines dump the nodes/irgs bracketed to graphs. */
1695 /***********************************************************************/
1697 /** Dumps a constant expression as entity initializer, array bound ...
1699 static void dump_const_expression(FILE *F, ir_node *value) {
1700 ir_graph *rem = current_ir_graph;
1701 int rem_dump_const_local = dump_const_local;
1702 dump_const_local = 0;
1703 current_ir_graph = get_const_code_irg();
1704 irg_walk(value, dump_const_node, NULL, F);
1705 /* Decrease visited flag so that we walk with the same flag for the next
1706 expression. This guarantees that we don't dump the same node twice,
1707 as for const expressions cse is performed to save memory. */
1708 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph) -1);
1709 current_ir_graph = rem;
1710 dump_const_local = rem_dump_const_local;
1713 /** Dump a block as graph containing its nodes.
1715 * Expects to find nodes belonging to the block as list in its
1717 * Dumps the edges of all nodes including itself. */
1718 static void dump_whole_block(FILE *F, ir_node *block) {
1720 ird_color_t color = ird_color_block_background;
1722 assert(is_Block(block));
1724 fprintf(F, "graph: { title: \"");
1725 PRINT_NODEID(block);
1726 fprintf(F, "\" label: \"");
1727 dump_node_label(F, block);
1729 /* colorize blocks */
1730 if (! get_Block_matured(block))
1731 color = ird_color_block_background;
1732 if (is_Block_dead(block))
1733 color = ird_color_dead_block_background;
1735 fprintf(F, "\" status:clustered ");
1736 print_vcg_color(F, color);
1739 /* yComp can show attributes for blocks, XVCG parses but ignores them */
1740 dump_node_info(F, block);
1741 print_dbg_info(F, get_irn_dbg_info(block));
1743 /* dump the blocks edges */
1744 dump_ir_data_edges(F, block);
1746 if (dump_block_edge_hook)
1747 dump_block_edge_hook(F, block);
1749 /* dump the nodes that go into the block */
1750 for (node = ird_get_irn_link(block); node; node = ird_get_irn_link(node)) {
1752 dump_ir_data_edges(F, node);
1755 /* Close the vcg information for the block */
1757 dump_const_node_local(F, block);
1761 /** dumps a graph block-wise. Expects all blockless nodes in arr in irgs link.
1762 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1764 dump_block_graph(FILE *F, ir_graph *irg) {
1766 ir_graph *rem = current_ir_graph;
1767 ir_node **arr = ird_get_irg_link(irg);
1768 current_ir_graph = irg;
1770 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1771 ir_node * node = arr[i];
1772 if (is_Block(node)) {
1773 /* Dumps the block and all the nodes in the block, which are to
1774 be found in Block->link. */
1775 dump_whole_block(F, node);
1777 /* Nodes that are not in a Block. */
1779 if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
1780 dump_const_block_local(F, node);
1782 dump_ir_data_edges(F, node);
1784 if (dump_new_edges_flag && edges_activated(irg))
1785 dump_ir_edges(F, node);
1788 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1789 dump_loop_nodes_into_graph(F, irg);
1791 current_ir_graph = rem;
1795 * Dump the info for an irg.
1796 * Parsed by XVCG but not shown. use yComp.
1798 static void dump_graph_info(FILE *F, ir_graph *irg) {
1799 fprintf(F, "info1: \"");
1800 dump_entity_to_file(F, get_irg_entity(irg), dump_verbosity_entattrs | dump_verbosity_entconsts);
1804 /** Dumps an irg as a graph clustered by block nodes.
1805 * If interprocedural view edges can point to nodes out of this graph.
1807 static void dump_graph_from_list(FILE *F, ir_graph *irg) {
1808 ir_entity *ent = get_irg_entity(irg);
1810 fprintf(F, "graph: { title: \"");
1812 fprintf(F, "\" label: \"%s\" status:clustered color:%s \n",
1813 get_ent_dump_name(ent), color_names[ird_color_prog_background]);
1815 dump_graph_info(F, irg);
1816 print_dbg_info(F, get_entity_dbg_info(ent));
1818 dump_block_graph(F, irg);
1820 /* Close the vcg information for the irg */
1821 fprintf(F, "}\n\n");
1824 /** dumps a graph extended block-wise. Expects all blockless nodes in arr in irgs link.
1825 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1827 dump_extblock_graph(FILE *F, ir_graph *irg) {
1829 ir_graph *rem = current_ir_graph;
1830 ir_extblk **arr = ird_get_irg_link(irg);
1831 current_ir_graph = irg;
1833 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1834 ir_extblk *extbb = arr[i];
1835 ir_node *leader = get_extbb_leader(extbb);
1838 fprintf(F, "graph: { title: \"");
1839 PRINT_EXTBBID(leader);
1840 fprintf(F, "\" label: \"ExtBB %ld\" status:clustered color:lightgreen\n",
1841 get_irn_node_nr(leader));
1843 for (j = ARR_LEN(extbb->blks) - 1; j >= 0; --j) {
1844 ir_node * node = extbb->blks[j];
1845 if (is_Block(node)) {
1846 /* Dumps the block and all the nodes in the block, which are to
1847 be found in Block->link. */
1848 dump_whole_block(F, node);
1850 /* Nodes that are not in a Block. */
1852 if (is_Bad(get_nodes_block(node)) && !node_floats(node)) {
1853 dump_const_block_local(F, node);
1855 dump_ir_data_edges(F, node);
1861 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1862 dump_loop_nodes_into_graph(F, irg);
1864 current_ir_graph = rem;
1869 /*******************************************************************/
1870 /* Basic type and entity nodes and edges. */
1871 /*******************************************************************/
1873 /** dumps the edges between nodes and their type or entity attributes. */
1874 static void dump_node2type_edges(ir_node *n, void *env)
1879 switch (get_irn_opcode(n)) {
1881 /* @@@ some consts have an entity */
1884 if (SYMCONST_HAS_TYPE(get_SymConst_kind(n)))
1885 print_node_type_edge(F,n,get_SymConst_type(n),NODE2TYPE_EDGE_ATTR);
1888 print_node_ent_edge(F,n,get_Sel_entity(n),NODE2TYPE_EDGE_ATTR);
1891 print_node_type_edge(F,n,get_Call_type(n),NODE2TYPE_EDGE_ATTR);
1894 print_node_type_edge(F,n,get_Alloc_type(n),NODE2TYPE_EDGE_ATTR);
1897 print_node_type_edge(F,n,get_Free_type(n),NODE2TYPE_EDGE_ATTR);
1900 print_node_type_edge(F,n,get_Cast_type(n),NODE2TYPE_EDGE_ATTR);
1908 static int print_type_info(FILE *F, ir_type *tp) {
1911 if (get_type_state(tp) == layout_undefined) {
1912 fprintf(F, "state: layout_undefined\n");
1914 fprintf(F, "state: layout_fixed,\n");
1916 if (get_type_mode(tp))
1917 fprintf(F, "mode: %s,\n", get_mode_name_ex(get_type_mode(tp), &bad));
1918 fprintf(F, "size: %db,\n", get_type_size_bits(tp));
1923 static void print_typespecific_info(FILE *F, ir_type *tp) {
1924 switch (get_type_tpop_code(tp)) {
1926 fprintf(F, "peculiarity: %s\n", get_peculiarity_string(get_class_peculiarity(tp)));
1931 fprintf(F, "variadicity: %s\n", get_variadicity_name(get_method_variadicity(tp)));
1932 fprintf(F, "params: %d\n", get_method_n_params(tp));
1933 fprintf(F, "results: %d\n", get_method_n_ress(tp));
1939 case tpo_enumeration:
1951 static void print_typespecific_vcgattr(FILE *F, ir_type *tp) {
1952 switch (get_type_tpop_code(tp)) {
1954 if (peculiarity_existent == get_class_peculiarity(tp))
1955 fprintf(F, " " TYPE_CLASS_NODE_ATTR);
1957 fprintf(F, " " TYPE_DESCRIPTION_NODE_ATTR);
1960 fprintf(F, " " TYPE_METH_NODE_ATTR);
1968 case tpo_enumeration:
1980 int dump_type_node(FILE *F, ir_type *tp)
1984 fprintf(F, "node: {title: ");
1986 fprintf(F, " label: \"%s %s\"", get_type_tpop_name(tp), get_type_name_ex(tp, &bad));
1987 fprintf(F, " info1: \"");
1989 bad |= print_type_info(F, tp);
1990 print_typespecific_info(F, tp);
1992 dump_type_to_file(F, tp, dump_verbosity_max);
1995 print_dbg_info(F, get_type_dbg_info(tp));
1996 print_typespecific_vcgattr(F, tp);
2003 void dump_entity_node(FILE *F, ir_entity *ent)
2005 fprintf(F, "node: {title: \"");
2006 PRINT_ENTID(ent); fprintf(F, "\"");
2007 fprintf(F, DEFAULT_TYPE_ATTRIBUTE);
2008 fprintf(F, "label: ");
2009 fprintf(F, "\"%s\" ", get_ent_dump_name(ent));
2011 print_vcg_color(F, ird_color_entity);
2012 fprintf(F, "\n info1: \"");
2014 dump_entity_to_file(F, ent, dump_verbosity_entattrs | dump_verbosity_entconsts);
2017 print_dbg_info(F, get_entity_dbg_info(ent));
2021 static void dump_enum_item(FILE *F, ir_type *tp, int pos)
2024 ir_enum_const *ec = get_enumeration_const(tp, pos);
2025 ident *id = get_enumeration_nameid(ec);
2026 tarval *tv = get_enumeration_value(ec);
2029 tarval_snprintf(buf, sizeof(buf), tv);
2031 strncpy(buf, "<not set>", sizeof(buf));
2032 fprintf(F, "node: {title: \"");
2033 PRINT_ITEMID(tp, pos); fprintf(F, "\"");
2034 fprintf(F, DEFAULT_ENUM_ITEM_ATTRIBUTE);
2035 fprintf(F, "label: ");
2036 fprintf(F, "\"enum item %s\" " ENUM_ITEM_NODE_ATTR, get_id_str(id));
2037 fprintf(F, "\n info1: \"value: %s\"}\n", buf);
2041 * Dumps a new style initializer.
2043 static void dump_entity_initializer(FILE *F, const ir_entity *ent) {
2049 /** Dumps a type or entity and it's edges. */
2050 static void dump_type_info(type_or_ent tore, void *env) {
2052 int i = 0; /* to shutup gcc */
2054 /* dump this type or entity */
2056 switch (get_kind(tore.ent)) {
2058 ir_entity *ent = tore.ent;
2061 dump_entity_node(F, ent);
2063 /* skip this to reduce graph. Member edge of type is parallel to this edge. *
2064 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2065 ENT_OWN_EDGE_ATTR "}\n", ent, get_entity_owner(ent));*/
2066 print_ent_type_edge(F,ent, get_entity_type(ent), ENT_TYPE_EDGE_ATTR);
2067 if (is_Class_type(get_entity_owner(ent))) {
2068 for (i = get_entity_n_overwrites(ent) - 1; i >= 0; --i)
2069 print_ent_ent_edge(F,ent, get_entity_overwrites(ent, i), 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2071 /* attached subgraphs */
2072 if (const_entities && (get_entity_variability(ent) != variability_uninitialized)) {
2073 if (is_atomic_entity(ent)) {
2074 value = get_atomic_ent_value(ent);
2076 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2077 /* DDMN(value); $$$ */
2078 dump_const_expression(F, value);
2081 if (is_compound_entity(ent)) {
2082 if (has_entity_initializer(ent)) {
2083 /* new style initializers */
2084 dump_entity_initializer(F, ent);
2086 /* old style compound entity values */
2087 for (i = get_compound_ent_n_values(ent) - 1; i >= 0; --i) {
2088 value = get_compound_ent_value(ent, i);
2090 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2091 dump_const_expression(F, value);
2092 print_ent_ent_edge(F, ent, get_compound_ent_value_member(ent, i), 0, -1, ENT_CORR_EDGE_ATTR, i);
2094 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2095 ENT_CORR_EDGE_ATTR "}\n", GET_ENTID(ent),
2096 get_compound_ent_value_member(ent, i), i);
2106 ir_type *tp = tore.typ;
2107 dump_type_node(F, tp);
2108 /* and now the edges */
2109 switch (get_type_tpop_code(tp)) {
2111 for (i = get_class_n_supertypes(tp) - 1; i >= 0; --i)
2112 print_type_type_edge(F, tp, get_class_supertype(tp, i), TYPE_SUPER_EDGE_ATTR);
2113 for (i = get_class_n_members(tp) - 1; i >= 0; --i)
2114 print_type_ent_edge(F, tp, get_class_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
2117 for (i = get_struct_n_members(tp) - 1; i >= 0; --i)
2118 print_type_ent_edge(F, tp, get_struct_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
2121 for (i = get_method_n_params(tp) - 1; i >= 0; --i)
2122 print_type_type_edge(F, tp, get_method_param_type(tp, i), METH_PAR_EDGE_ATTR,i);
2123 for (i = get_method_n_ress(tp) - 1; i >= 0; --i)
2124 print_type_type_edge(F, tp, get_method_res_type(tp, i), METH_RES_EDGE_ATTR,i);
2127 for (i = get_union_n_members(tp) - 1; i >= 0; --i)
2128 print_type_ent_edge(F, tp, get_union_member(tp, i), UNION_EDGE_ATTR);
2131 print_type_type_edge(F, tp, get_array_element_type(tp), ARR_ELT_TYPE_EDGE_ATTR);
2132 print_type_ent_edge(F, tp, get_array_element_entity(tp), ARR_ENT_EDGE_ATTR);
2133 for (i = get_array_n_dimensions(tp) - 1; i >= 0; --i) {
2134 ir_node *upper = get_array_upper_bound(tp, i);
2135 ir_node *lower = get_array_lower_bound(tp, i);
2136 print_node_type_edge(F, upper, tp, "label: \"upper %d\"", get_array_order(tp, i));
2137 print_node_type_edge(F, lower, tp, "label: \"lower %d\"", get_array_order(tp, i));
2138 dump_const_expression(F, upper);
2139 dump_const_expression(F, lower);
2142 case tpo_enumeration:
2143 for (i = get_enumeration_n_enums(tp) - 1; i >= 0; --i) {
2144 dump_enum_item(F, tp, i);
2145 print_enum_item_edge(F, tp, i, "label: \"item %d\"", i);
2149 print_type_type_edge(F, tp, get_pointer_points_to_type(tp), PTR_PTS_TO_EDGE_ATTR);
2156 break; /* case k_type */
2159 printf(" *** irdump, dump_type_info(l.%i), faulty type.\n", __LINE__);
2160 } /* switch kind_or_entity */
2163 typedef struct _h_env {
2168 /** For dumping class hierarchies.
2169 * Dumps a class type node and a superclass edge.
2170 * If env->dump_ent dumps entities of classes and overwrites edges.
2173 dump_class_hierarchy_node(type_or_ent tore, void *ctx) {
2176 int i = 0; /* to shutup gcc */
2178 /* dump this type or entity */
2179 switch (get_kind(tore.ent)) {
2181 ir_entity *ent = tore.ent;
2182 if (get_entity_owner(ent) == get_glob_type()) break;
2183 if (!is_Method_type(get_entity_type(ent)))
2185 if (env->dump_ent && is_Class_type(get_entity_owner(ent))) {
2187 dump_entity_node(F, ent);
2189 print_type_ent_edge(F, get_entity_owner(ent), ent, TYPE_MEMBER_EDGE_ATTR);
2190 for (i = get_entity_n_overwrites(ent) - 1; i >= 0; --i)
2191 print_ent_ent_edge(F, get_entity_overwrites(ent, i), ent, 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2196 ir_type *tp = tore.typ;
2197 if (tp == get_glob_type())
2199 switch (get_type_tpop_code(tp)) {
2201 dump_type_node(F, tp);
2202 /* and now the edges */
2203 for (i = get_class_n_supertypes(tp) - 1; i >= 0; --i) {
2204 print_type_type_edge(F,tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2209 break; /* case k_type */
2212 printf(" *** irdump, dump_class_hierarchy_node(l.%i), faulty type.\n", __LINE__);
2213 } /* switch kind_or_entity */
2216 /*******************************************************************/
2217 /* dump analysis information that is expressed in graph terms. */
2218 /*******************************************************************/
2220 /* dump out edges */
2222 dump_out_edge(ir_node *n, void *env) {
2225 for (i = get_irn_n_outs(n) - 1; i >= 0; --i) {
2226 ir_node *succ = get_irn_out(n, i);
2228 print_node_edge_kind(F, succ);
2229 fprintf(F, "{sourcename: \"");
2231 fprintf(F, "\" targetname: \"");
2233 fprintf(F, "\" color: red linestyle: dashed");
2239 dump_loop_label(FILE *F, ir_loop *loop) {
2240 fprintf(F, "loop %d, %d sons, %d nodes",
2241 get_loop_depth(loop), get_loop_n_sons(loop), get_loop_n_nodes(loop));
2244 static inline void dump_loop_info(FILE *F, ir_loop *loop) {
2245 fprintf(F, " info1: \"");
2246 fprintf(F, " loop nr: %d", get_loop_loop_nr(loop));
2247 #ifdef DEBUG_libfirm /* GL @@@ debug analyses */
2248 fprintf(F, "\n The loop was analyzed %d times.", PTR_TO_INT(get_loop_link(loop)));
2254 dump_loop_node(FILE *F, ir_loop *loop) {
2255 fprintf(F, "node: {title: \"");
2257 fprintf(F, "\" label: \"");
2258 dump_loop_label(F, loop);
2260 dump_loop_info(F, loop);
2265 dump_loop_node_edge(FILE *F, ir_loop *loop, int i) {
2267 fprintf(F, "edge: {sourcename: \"");
2269 fprintf(F, "\" targetname: \"");
2270 PRINT_NODEID(get_loop_node(loop, i));
2271 fprintf(F, "\" color: green");
2276 dump_loop_son_edge(FILE *F, ir_loop *loop, int i) {
2278 fprintf(F, "edge: {sourcename: \"");
2280 fprintf(F, "\" targetname: \"");
2281 PRINT_LOOPID(get_loop_son(loop, i));
2282 fprintf(F, "\" color: darkgreen label: \"%d\"}\n",
2283 get_loop_element_pos(loop, get_loop_son(loop, i)));
2287 void dump_loops(FILE *F, ir_loop *loop) {
2289 /* dump this loop node */
2290 dump_loop_node(F, loop);
2292 /* dump edges to nodes in loop -- only if it is a real loop */
2293 if (get_loop_depth(loop) != 0) {
2294 for (i = get_loop_n_nodes(loop) - 1; i >= 0; --i) {
2295 dump_loop_node_edge(F, loop, i);
2298 for (i = get_loop_n_sons(loop) - 1; i >= 0; --i) {
2299 dump_loops(F, get_loop_son(loop, i));
2300 dump_loop_son_edge(F, loop, i);
2305 void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg) {
2306 ir_loop *loop = get_irg_loop(irg);
2309 ir_graph *rem = current_ir_graph;
2310 current_ir_graph = irg;
2312 dump_loops(F, loop);
2314 current_ir_graph = rem;
2320 * dumps the VCG header
2322 void dump_vcg_header(FILE *F, const char *name, const char *layout, const char *orientation) {
2328 label = edge_label ? "yes" : "no";
2329 if (! layout) layout = "Compilergraph";
2330 if (!orientation) orientation = "bottom_to_top";
2334 "graph: { title: \"ir graph of %s\"\n"
2335 "display_edge_labels: %s\n"
2336 "layoutalgorithm: mindepth //$ \"%s\"\n"
2337 "manhattan_edges: yes\n"
2338 "port_sharing: no\n"
2340 "classname 1: \"intrablock Data\"\n"
2341 "classname 2: \"Block\"\n"
2342 "classname 3: \"Entity type\"\n"
2343 "classname 4: \"Entity owner\"\n"
2344 "classname 5: \"Method Param\"\n"
2345 "classname 6: \"Method Res\"\n"
2346 "classname 7: \"Super\"\n"
2347 "classname 8: \"Union\"\n"
2348 "classname 9: \"Points-to\"\n"
2349 "classname 10: \"Array Element Type\"\n"
2350 "classname 11: \"Overwrites\"\n"
2351 "classname 12: \"Member\"\n"
2352 "classname 13: \"Control Flow\"\n"
2353 "classname 14: \"intrablock Memory\"\n"
2354 "classname 15: \"Dominators\"\n"
2355 "classname 16: \"interblock Data\"\n"
2356 "classname 17: \"interblock Memory\"\n"
2357 "classname 18: \"Exception Control Flow for Interval Analysis\"\n"
2358 "classname 19: \"Postdominators\"\n"
2359 "classname 20: \"Keep Alive\"\n"
2360 "classname 21: \"Out Edges\"\n"
2361 "classname 22: \"Macro Block Edges\"\n"
2362 //"classname 23: \"NoInput Nodes\"\n"
2363 "infoname 1: \"Attribute\"\n"
2364 "infoname 2: \"Verification errors\"\n"
2365 "infoname 3: \"Debug info\"\n",
2366 name, label, layout, orientation);
2368 for (i = 0; i < ird_color_count; ++i) {
2369 if (color_rgb[i] != NULL) {
2370 fprintf(F, "colorentry %s: %s\n", color_names[i], color_rgb[i]);
2373 fprintf(F, "\n"); /* a separator */
2379 * @param irg The graph to be dumped
2380 * @param suffix1 first filename suffix
2381 * @param suffix2 second filename suffix
2383 FILE *vcg_open(const ir_graph *irg, const char *suffix1, const char *suffix2) {
2385 const char *nm = get_irg_dump_name(irg);
2386 int len = strlen(nm), i, j;
2387 char *fname; /* filename to put the vcg information in */
2389 if (!suffix1) suffix1 = "";
2390 if (!suffix2) suffix2 = "";
2392 /* open file for vcg graph */
2393 fname = XMALLOCN(char, len * 2 + strlen(suffix1) + strlen(suffix2) + 5);
2395 /* strncpy (fname, nm, len); */ /* copy the filename */
2397 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2399 fname[j] = '@'; j++; fname[j] = '1'; j++;
2400 } else if (nm[i] == '@') {
2401 fname[j] = '@'; j++; fname[j] = '2'; j++;
2403 fname[j] = nm[i]; j++;
2407 strcat(fname, suffix1); /* append file suffix */
2408 strcat(fname, suffix2); /* append file suffix */
2409 strcat(fname, ".vcg"); /* append the .vcg suffix */
2411 /* vcg really expect only a <CR> at end of line, so
2412 * the "b"inary mode is what you mean (and even needed for Win32)
2414 F = fopen(fname, "wb"); /* open file for writing */
2426 * @param name prefix file name
2427 * @param suffix filename suffix
2429 FILE *vcg_open_name(const char *name, const char *suffix) {
2431 char *fname; /* filename to put the vcg information in */
2432 int i, j, len = strlen(name);
2434 if (!suffix) suffix = "";
2436 /** open file for vcg graph */
2437 fname = XMALLOCN(char, len * 2 + 5 + strlen(suffix));
2438 /* strcpy (fname, name);*/ /* copy the filename */
2440 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2441 if (name[i] == '/') {
2442 fname[j] = '@'; j++; fname[j] = '1'; j++;
2443 } else if (name[i] == '@') {
2444 fname[j] = '@'; j++; fname[j] = '2'; j++;
2446 fname[j] = name[i]; j++;
2450 strcat(fname, suffix);
2451 strcat(fname, ".vcg"); /* append the .vcg suffix */
2453 /* vcg really expect only a <CR> at end of line, so
2454 * the "b"inary mode is what you mean (and even needed for Win32)
2456 F = fopen(fname, "wb"); /* open file for writing */
2466 * Dumps the vcg file footer
2468 void dump_vcg_footer(FILE *F) {
2472 /************************************************************************/
2473 /************************************************************************/
2474 /* Routines that dump all or parts of the firm representation to a file */
2475 /************************************************************************/
2476 /************************************************************************/
2478 /************************************************************************/
2479 /* Dump ir graphs, different formats and additional information. */
2480 /************************************************************************/
2482 typedef void (*do_dump_graph_func) (ir_graph *irg, FILE *out);
2484 static void do_dump(ir_graph *irg, const char *suffix, const char *suffix_ip,
2485 const char *suffix_nonip, do_dump_graph_func dump_func)
2489 const char *suffix1;
2491 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2494 rem = current_ir_graph;
2495 current_ir_graph = irg;
2496 if (get_interprocedural_view())
2497 suffix1 = suffix_ip;
2499 suffix1 = suffix_nonip;
2500 current_ir_graph = rem;
2502 out = vcg_open(irg, suffix, suffix1);
2504 dump_func(irg, out);
2509 void dump_ir_graph_file(ir_graph *irg, FILE *out)
2511 if (dump_backedge_information_flag
2512 && get_irg_loopinfo_state(irg) != loopinfo_consistent) {
2513 construct_backedges(irg);
2516 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2518 /* call the dump graph hook */
2519 if (dump_ir_graph_hook) {
2520 if (dump_ir_graph_hook(out, irg)) {
2525 /* walk over the graph */
2526 /* dump_whole_node must be called in post visiting predecessors */
2527 ird_walk_graph(irg, NULL, dump_whole_node, out);
2529 /* dump the out edges in a separate walk */
2530 if ((dump_out_edge_flag) && (get_irg_outs_state(irg) != outs_none)) {
2531 irg_out_walk(get_irg_start(irg), dump_out_edge, NULL, out);
2534 dump_vcg_footer(out);
2537 /** Routine to dump a graph, blocks as conventional nodes. */
2538 void dump_ir_graph(ir_graph *irg, const char *suffix )
2540 do_dump(irg, suffix, "-pure-ip", "-pure", dump_ir_graph_file);
2543 void dump_ir_block_graph_file(ir_graph *irg, FILE *out)
2547 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2549 construct_block_lists(irg);
2552 * If we are in the interprocedural view, we dump not
2553 * only the requested irg but also all irgs that can be reached
2556 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2557 ir_graph *g = get_irp_irg(i);
2558 ir_node **arr = ird_get_irg_link(g);
2560 dump_graph_from_list(out, g);
2565 dump_vcg_footer(out);
2568 /* Dump a firm graph without explicit block nodes. */
2569 void dump_ir_block_graph(ir_graph *irg, const char *suffix)
2571 do_dump(irg, suffix, "-ip", "", dump_ir_block_graph_file);
2574 void dump_ir_extblock_graph_file(ir_graph *irg, FILE *F)
2577 ir_entity *ent = get_irg_entity(irg);
2579 if (get_irg_extblk_state(irg) != extblk_valid)
2582 dump_vcg_header(F, get_irg_dump_name(irg), NULL, NULL);
2584 construct_extblock_lists(irg);
2586 fprintf(F, "graph: { title: \"");
2588 fprintf(F, "\" label: \"%s\" status:clustered color: white \n",
2589 get_ent_dump_name(ent));
2591 dump_graph_info(F, irg);
2592 print_dbg_info(F, get_entity_dbg_info(ent));
2594 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2595 ir_graph *irg = get_irp_irg(i);
2596 list_tuple *lists = ird_get_irg_link(irg);
2599 /* dump the extended blocks first */
2600 if (ARR_LEN(lists->extbb_list)) {
2601 ird_set_irg_link(irg, lists->extbb_list);
2602 dump_extblock_graph(F, irg);
2605 /* we may have blocks without extended blocks, bad for instance */
2606 if (ARR_LEN(lists->blk_list)) {
2607 ird_set_irg_link(irg, lists->blk_list);
2608 dump_block_graph(F, irg);
2611 DEL_ARR_F(lists->extbb_list);
2612 DEL_ARR_F(lists->blk_list);
2617 /* Close the vcg information for the irg */
2618 fprintf(F, "}\n\n");
2624 /* Dump a firm graph without explicit block nodes but grouped in extended blocks. */
2625 void dump_ir_extblock_graph(ir_graph *irg, const char *suffix)
2627 do_dump(irg, suffix, "-ip", "", dump_ir_extblock_graph_file);
2630 void dump_ir_graph_w_types_file(ir_graph *irg, FILE *out)
2632 ir_graph *rem = current_ir_graph;
2633 int rem_dump_const_local;
2635 rem = current_ir_graph;
2636 current_ir_graph = irg;
2637 rem_dump_const_local = dump_const_local;
2638 /* dumping types does not work with local nodes */
2639 dump_const_local = 0;
2641 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2643 /* dump common ir graph */
2644 irg_walk(get_irg_end(irg), NULL, dump_whole_node, out);
2645 /* dump type info */
2646 type_walk_irg(irg, dump_type_info, NULL, out);
2647 inc_irg_visited(get_const_code_irg());
2648 /* dump edges from graph to type info */
2649 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2651 dump_vcg_footer(out);
2652 dump_const_local = rem_dump_const_local;
2653 current_ir_graph = rem;
2656 /* dumps a graph with type information */
2657 void dump_ir_graph_w_types(ir_graph *irg, const char *suffix)
2659 do_dump(irg, suffix, "-pure-wtypes-ip", "-pure-wtypes",
2660 dump_ir_graph_w_types_file);
2663 void dump_ir_block_graph_w_types_file(ir_graph *irg, FILE *out)
2666 int rem_dump_const_local;
2667 ir_graph *rem = current_ir_graph;
2669 rem_dump_const_local = dump_const_local;
2670 /* dumping types does not work with local nodes */
2671 dump_const_local = 0;
2673 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2675 /* dump common blocked ir graph */
2676 construct_block_lists(irg);
2678 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2679 ir_node **arr = ird_get_irg_link(get_irp_irg(i));
2681 dump_graph_from_list(out, get_irp_irg(i));
2686 /* dump type info */
2687 current_ir_graph = irg;
2688 type_walk_irg(irg, dump_type_info, NULL, out);
2689 inc_irg_visited(get_const_code_irg());
2691 /* dump edges from graph to type info */
2692 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2694 dump_vcg_footer(out);
2695 dump_const_local = rem_dump_const_local;
2696 current_ir_graph = rem;
2699 void dump_ir_block_graph_w_types(ir_graph *irg, const char *suffix)
2701 do_dump(irg, suffix, "-wtypes-ip", "-wtypes",
2702 dump_ir_block_graph_w_types_file);
2705 /*---------------------------------------------------------------------*/
2706 /* The following routines dump a control flow graph. */
2707 /*---------------------------------------------------------------------*/
2710 dump_block_to_cfg(ir_node *block, void *env) {
2715 if (is_Block(block)) {
2716 /* This is a block. Dump a node for the block. */
2717 fprintf(F, "node: {title: \""); PRINT_NODEID(block);
2718 fprintf(F, "\" label: \"");
2719 if (block == get_irg_start_block(get_irn_irg(block)))
2720 fprintf(F, "Start ");
2721 if (block == get_irg_end_block(get_irn_irg(block)))
2724 fprintf(F, "%s ", get_op_name(get_irn_op(block)));
2725 PRINT_NODEID(block);
2727 fprintf(F, "info1:\"");
2729 /* the generic version. */
2730 dump_irnode_to_file(F, block);
2732 /* Check whether we have bad predecessors to color the block. */
2733 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
2734 if ((fl = is_Bad(get_Block_cfgpred(block, i))))
2737 fprintf(F, "\""); /* closing quote of info */
2739 if ((block == get_irg_start_block(get_irn_irg(block))) ||
2740 (block == get_irg_end_block(get_irn_irg(block))) )
2741 fprintf(F, " color:blue ");
2743 fprintf(F, " color:yellow ");
2746 /* Dump the edges */
2747 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
2748 if (!is_Bad(skip_Proj(get_Block_cfgpred(block, i)))) {
2749 pred = get_nodes_block(skip_Proj(get_Block_cfgpred(block, i)));
2750 fprintf(F, "edge: { sourcename: \"");
2751 PRINT_NODEID(block);
2752 fprintf(F, "\" targetname: \"");
2754 fprintf(F, "\"}\n");
2757 /* Dump dominator/postdominator edge */
2758 if (dump_dominator_information_flag) {
2759 if (get_irg_dom_state(current_ir_graph) == dom_consistent && get_Block_idom(block)) {
2760 pred = get_Block_idom(block);
2761 fprintf(F, "edge: { sourcename: \"");
2762 PRINT_NODEID(block);
2763 fprintf(F, "\" targetname: \"");
2765 fprintf(F, "\" " DOMINATOR_EDGE_ATTR "}\n");
2767 if (get_irg_postdom_state(current_ir_graph) == dom_consistent && get_Block_ipostdom(block)) {
2768 pred = get_Block_ipostdom(block);
2769 fprintf(F, "edge: { sourcename: \"");
2770 PRINT_NODEID(block);
2771 fprintf(F, "\" targetname: \"");
2773 fprintf(F, "\" " POSTDOMINATOR_EDGE_ATTR "}\n");
2779 void dump_cfg(ir_graph *irg, const char *suffix)
2782 /* if a filter is set, dump only the irg's that match the filter */
2783 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2786 f = vcg_open(irg, suffix, "-cfg");
2788 ir_graph *rem = current_ir_graph;
2789 #ifdef INTERPROCEDURAL_VIEW
2790 int ipv = get_interprocedural_view();
2793 current_ir_graph = irg;
2794 dump_vcg_header(f, get_irg_dump_name(irg), NULL, NULL);
2796 #ifdef INTERPROCEDURAL_VIEW
2798 printf("Warning: dumping cfg not in interprocedural view!\n");
2799 set_interprocedural_view(0);
2803 /* walk over the blocks in the graph */
2804 irg_block_walk(get_irg_end(irg), dump_block_to_cfg, NULL, f);
2805 dump_node(f, get_irg_bad(irg));
2807 #ifdef INTERPROCEDURAL_VIEW
2808 set_interprocedural_view(ipv);
2812 current_ir_graph = rem;
2817 static void descend_and_dump(FILE *F, ir_node *n, int depth, pset *mark_set) {
2818 if (pset_find_ptr(mark_set, n))
2821 pset_insert_ptr(mark_set, n);
2824 int i, start = is_Block(n) ? 0 : -1;
2825 dump_whole_node(n, F);
2826 for (i = start; i < get_irn_arity(n); ++i)
2827 descend_and_dump(F, get_irn_n(n, i), depth-1, mark_set);
2830 /* Don't dump edges to nodes further out. These might be edges to
2831 nodes we already dumped, if there is a shorter path to these. */
2835 static int subgraph_counter = 0;
2836 void dump_subgraph(ir_node *root, int depth, const char *suffix) {
2840 sprintf(buf, "-subg_%03d", subgraph_counter++);
2841 F = vcg_open(get_irn_irg(root), suffix, buf);
2843 pset *mark_set = pset_new_ptr(1);
2844 dump_vcg_header(F, get_irg_dump_name(get_irn_irg(root)), NULL, NULL);
2845 descend_and_dump(F, root, depth, mark_set);
2852 void dump_callgraph(const char *suffix) {
2853 FILE *F = vcg_open_name("Callgraph", suffix);
2856 int i, rem = edge_label;
2859 dump_vcg_header(F, "Callgraph", "Hierarchiv", NULL);
2861 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2862 ir_graph *irg = get_irp_irg(i);
2863 ir_entity *ent = get_irg_entity(irg);
2865 int n_callees = get_irg_n_callees(irg);
2867 dump_entity_node(F, ent);
2868 for (j = 0; j < n_callees; ++j) {
2869 ir_entity *c = get_irg_entity(get_irg_callee(irg, j));
2870 //if (id_is_prefix(prefix, get_entity_ld_ident(c))) continue;
2871 int be = is_irg_callee_backedge(irg, j);
2874 "label:\"recursion %d\"" :
2875 "label:\"calls %d\"";
2876 print_ent_ent_edge(F, ent, c, be, ird_color_entity, attr, get_irg_callee_loop_depth(irg, j));
2887 /* Dump all irgs in interprocedural view to a single file. */
2888 void dump_all_cg_block_graph(const char *suffix) {
2889 FILE *f = vcg_open_name("All_graphs", suffix);
2893 int rem_view = get_interprocedural_view();
2895 set_interprocedural_view(1);
2896 dump_vcg_header(f, "All_graphs", NULL);
2898 /* collect nodes in all irgs reachable in call graph*/
2899 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2900 ird_set_irg_link(get_irp_irg(i), NULL);
2902 cg_walk(clear_link, collect_node, NULL);
2904 /* dump all graphs */
2905 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2906 current_ir_graph = get_irp_irg(i);
2907 assert(ird_get_irg_link(current_ir_graph));
2908 dump_graph_from_list(f, current_ir_graph);
2909 DEL_ARR_F(ird_get_irg_link(current_ir_graph));
2914 set_interprocedural_view(rem_view);
2919 /*---------------------------------------------------------------------*/
2920 /* the following routines dumps type information without any ir nodes. */
2921 /*---------------------------------------------------------------------*/
2924 dump_type_graph(ir_graph *irg, const char *suffix)
2928 /* if a filter is set, dump only the irg's that match the filter */
2929 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
2931 f = vcg_open(irg, suffix, "-type");
2933 ir_graph *rem = current_ir_graph;
2934 current_ir_graph = irg;
2936 dump_vcg_header(f, get_irg_dump_name(irg), "Hierarchic", NULL);
2938 /* walk over the blocks in the graph */
2939 type_walk_irg(irg, dump_type_info, NULL, f);
2940 /* The walker for the const code can be called several times for the
2941 same (sub) expression. So that no nodes are dumped several times
2942 we decrease the visited flag of the corresponding graph after each
2943 walk. So now increase it finally. */
2944 inc_irg_visited(get_const_code_irg());
2948 current_ir_graph = rem;
2953 dump_all_types(const char *suffix)
2955 FILE *f = vcg_open_name("All_types", suffix);
2957 dump_vcg_header(f, "All_types", "Hierarchic", NULL);
2958 type_walk(dump_type_info, NULL, f);
2959 inc_irg_visited(get_const_code_irg());
2967 dump_class_hierarchy(int entities, const char *suffix)
2969 FILE *f = vcg_open_name("class_hierarchy", suffix);
2974 env.dump_ent = entities;
2975 dump_vcg_header(f, "class_hierarchy", "Hierarchic", NULL);
2976 type_walk(dump_class_hierarchy_node, NULL, &env);
2983 /*---------------------------------------------------------------------*/
2984 /* dumps all graphs with the graph-dumper passed. Possible dumpers: */
2986 /* dump_ir_block_graph */
2988 /* dump_type_graph */
2989 /* dump_ir_graph_w_types */
2990 /*---------------------------------------------------------------------*/
2992 void dump_all_ir_graphs(dump_graph_func *dmp_grph, const char *suffix) {
2994 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2995 dmp_grph(get_irp_irg(i), suffix);
2999 ir_prog_pass_t pass;
3000 dump_graph_func *dump_graph;
3005 * Wrapper around dump_all_ir_graphs().
3007 static int dump_all_ir_graphs_wrapper(ir_prog *irp, void *context) {
3008 struct pass_t *pass = context;
3011 dump_all_ir_graphs(pass->dump_graph, pass->suffix);
3015 ir_prog_pass_t *dump_all_ir_graph_pass(
3016 const char *name, dump_graph_func *dump_graph, const char *suffix) {
3017 size_t len = strlen(suffix);
3018 struct pass_t *pass = xmalloc(sizeof(*pass) + len);
3019 ir_prog_pass_t *res = def_prog_pass_constructor(
3020 &pass->pass, name ? name : "dump_all_graphs", dump_all_ir_graphs_wrapper);
3022 /* this pass does not change anything, so neither dump nor verify is needed. */
3023 res->dump_irprog = ir_prog_no_dump;
3024 res->verify_irprog = ir_prog_no_verify;
3026 pass->dump_graph = dump_graph;
3027 strcpy(pass->suffix, suffix);
3032 /*--------------------------------------------------------------------------------*
3033 * Dumps a stand alone loop graph with firm nodes which belong to one loop node *
3034 * packed together in one subgraph/box *
3035 *--------------------------------------------------------------------------------*/
3037 void dump_loops_standalone(FILE *F, ir_loop *loop) {
3038 int i = 0, loop_node_started = 0, son_number = 0, first = 0;
3040 ir_loop *son = NULL;
3042 /* Dump a new loop node. */
3043 dump_loop_node(F, loop);
3045 /* Dump the loop elements. */
3046 for (i = 0; i < get_loop_n_elements(loop); i++) {
3047 le = get_loop_element(loop, i);
3049 if (get_kind(son) == k_ir_loop) {
3051 /* We are a loop son -> Recurse */
3053 if (loop_node_started) { /* Close the "firm-nodes" node first if we started one. */
3054 fprintf(F, "\" }\n");
3055 fprintf(F, "edge: {sourcename: \"");
3057 fprintf(F, "\" targetname: \"");
3059 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3060 loop_node_started = 0;
3062 dump_loop_son_edge(F, loop, son_number++);
3063 dump_loops_standalone(F, son);
3064 } else if (get_kind(son) == k_ir_node) {
3065 /* We are a loop node -> Collect firm nodes */
3067 ir_node *n = le.node;
3070 if (!loop_node_started) {
3071 /* Start a new node which contains all firm nodes of the current loop */
3072 fprintf(F, "node: { title: \"");
3074 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3075 loop_node_started = 1;
3080 bad |= dump_node_label(F, n);
3081 /* Causes indeterministic output: if (is_Block(n)) fprintf(F, "\t ->%d", (int)get_irn_link(n)); */
3082 if (has_backedges(n)) fprintf(F, "\t loop head!");
3083 } else { /* for callgraph loop tree */
3085 assert(get_kind(son) == k_ir_graph);
3087 /* We are a loop node -> Collect firm graphs */
3089 if (!loop_node_started) {
3090 /* Start a new node which contains all firm nodes of the current loop */
3091 fprintf(F, "node: { title: \"");
3093 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3094 loop_node_started = 1;
3098 fprintf(F, " %s", get_irg_dump_name(n));
3099 /* fprintf(F, " %s (depth %d)", get_irg_dump_name(n), n->callgraph_weighted_loop_depth); */
3103 if (loop_node_started) {
3104 fprintf(F, "\" }\n");
3105 fprintf(F, "edge: {sourcename: \"");
3107 fprintf(F, "\" targetname: \"");
3109 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3110 loop_node_started = 0;
3114 void dump_loop_tree(ir_graph *irg, const char *suffix)
3118 /* if a filter is set, dump only the irg's that match the filter */
3119 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
3122 f = vcg_open(irg, suffix, "-looptree");
3124 ir_graph *rem = current_ir_graph;
3125 int el_rem = edge_label;
3127 current_ir_graph = irg;
3130 dump_vcg_header(f, get_irg_dump_name(irg), "Tree", "top_to_bottom");
3132 if (get_irg_loop(irg))
3133 dump_loops_standalone(f, get_irg_loop(irg));
3138 edge_label = el_rem;
3139 current_ir_graph = rem;
3143 void dump_callgraph_loop_tree(const char *suffix) {
3145 F = vcg_open_name("Callgraph_looptree", suffix);
3146 dump_vcg_header(F, "callgraph looptree", "Tree", "top_to_bottom");
3147 dump_loops_standalone(F, irp->outermost_cg_loop);
3153 /*----------------------------------------------------------------------------*/
3154 /* Dumps the firm nodes in the loop tree to a graph along with the loop nodes.*/
3155 /*----------------------------------------------------------------------------*/
3157 void collect_nodeloop(FILE *F, ir_loop *loop, eset *loopnodes) {
3158 int i, son_number = 0, node_number = 0;
3160 if (dump_loop_information_flag) dump_loop_node(F, loop);
3162 for (i = 0; i < get_loop_n_elements(loop); i++) {
3163 loop_element le = get_loop_element(loop, i);
3164 if (*(le.kind) == k_ir_loop) {
3165 if (dump_loop_information_flag) dump_loop_son_edge(F, loop, son_number++);
3167 collect_nodeloop(F, le.son, loopnodes);
3169 if (dump_loop_information_flag) dump_loop_node_edge(F, loop, node_number++);
3170 eset_insert(loopnodes, le.node);
3175 void collect_nodeloop_external_nodes(ir_loop *loop, eset *loopnodes, eset *extnodes) {
3178 for(i = 0; i < get_loop_n_elements(loop); i++) {
3179 loop_element le = get_loop_element(loop, i);
3180 if (*(le.kind) == k_ir_loop) {
3182 collect_nodeloop_external_nodes(le.son, loopnodes, extnodes);
3184 if (is_Block(le.node)) start = 0; else start = -1;
3185 for (j = start; j < get_irn_arity(le.node); j++) {
3186 ir_node *pred = get_irn_n(le.node, j);
3187 if (!eset_contains(loopnodes, pred)) {
3188 eset_insert(extnodes, pred);
3189 if (!is_Block(pred)) {
3190 pred = get_nodes_block(pred);
3191 if (!eset_contains(loopnodes, pred)) eset_insert(extnodes, pred);
3199 void dump_loop(ir_loop *l, const char *suffix) {
3203 snprintf(name, sizeof(name), "loop_%d", get_loop_loop_nr(l));
3204 F = vcg_open_name(name, suffix);
3206 eset *loopnodes = eset_create();
3207 eset *extnodes = eset_create();
3210 dump_vcg_header(F, name, NULL, NULL);
3212 /* collect all nodes to dump */
3213 collect_nodeloop(F, l, loopnodes);
3214 collect_nodeloop_external_nodes(l, loopnodes, extnodes);
3216 /* build block lists */
3217 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes))
3218 set_irn_link(n, NULL);
3219 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes))
3220 set_irn_link(n, NULL);
3221 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes)) {
3223 b = get_nodes_block(n);
3224 set_irn_link(n, get_irn_link(b));
3228 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes)) {
3230 b = get_nodes_block(n);
3231 set_irn_link(n, get_irn_link(b));
3236 for (b = eset_first(loopnodes); b != NULL; b = eset_next(loopnodes)) {
3238 fprintf(F, "graph: { title: \"");
3240 fprintf(F, "\" label: \"");
3241 dump_node_opcode(F, b);
3242 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3243 fprintf(F, "\" status:clustered color:yellow\n");
3245 /* dump the blocks edges */
3246 dump_ir_data_edges(F, b);
3248 /* dump the nodes that go into the block */
3249 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3250 if (eset_contains(extnodes, n))
3251 overrule_nodecolor = ird_color_block_inout;
3253 overrule_nodecolor = ird_color_default_node;
3254 if (!eset_contains(extnodes, n)) dump_ir_data_edges(F, n);
3257 /* Close the vcg information for the block */
3259 dump_const_node_local(F, b);
3263 for (b = eset_first(extnodes); b != NULL; b = eset_next(extnodes)) {
3265 fprintf(F, "graph: { title: \"");
3267 fprintf(F, "\" label: \"");
3268 dump_node_opcode(F, b);
3269 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3270 fprintf(F, "\" status:clustered color:lightblue\n");
3272 /* dump the nodes that go into the block */
3273 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3274 if (!eset_contains(loopnodes, n))
3275 overrule_nodecolor = ird_color_block_inout;
3277 overrule_nodecolor = ird_color_default_node;
3278 if (eset_contains(loopnodes, n)) dump_ir_data_edges(F, n);
3281 /* Close the vcg information for the block */
3283 dump_const_node_local(F, b);
3287 eset_destroy(loopnodes);
3288 eset_destroy(extnodes);