2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Write vcg representation of firm to file.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Hubert Schmidt
35 #include "irgraph_t.h"
49 #include "callgraph.h"
50 #include "irextbb_t.h"
52 #include "dbginfo_t.h"
64 /** Dump only irgs with names that start with this prefix. */
65 static ident *dump_file_filter_id = NULL;
67 #define ERROR_TXT "<ERROR>"
69 /*******************************************************************/
70 /* flags to steer output */
71 /*******************************************************************/
73 /** An option to turn off edge labels */
74 static int edge_label = 1;
75 /** An option to turn off dumping values of constant entities */
76 static int const_entities = 1;
77 /** An option to dump the keep alive edges */
78 static int dump_keepalive = 1;
79 /** An option to dump the new out edges */
80 static int dump_new_edges_flag = 0;
81 /** An option to dump ld_names instead of names. */
82 static int dump_ld_name = 1;
83 /** Compiler options to dump analysis information in dump_ir_graph */
84 static int dump_out_edge_flag = 0;
85 static int dump_loop_information_flag = 0;
86 static int dump_backedge_information_flag = 1;
87 /** An option to dump const-like nodes locally. */
88 static int dump_const_local = 1;
89 /** An option to dump the node index number. */
90 static int dump_node_idx_labels = 0;
91 /** An option to dump all graph anchors */
92 static int dump_anchors = 0;
93 /** An option to dump the macro block edges. */
94 static int dump_macro_block_edges = 0;
95 /** An option to dump block marker in the block title */
96 static int dump_block_marker = 0;
98 int dump_dominator_information_flag = 0;
99 int opt_dump_analysed_type_info = 1;
100 int opt_dump_pointer_values_to_info = 0; /* default off: for test compares!! */
102 static ird_color_t overrule_nodecolor = ird_color_default_node;
104 /** The vcg node attribute hook. */
105 static DUMP_IR_GRAPH_FUNC dump_ir_graph_hook = NULL;
106 /** The vcg node attribute hook. */
107 static DUMP_NODE_VCGATTR_FUNC dump_node_vcgattr_hook = NULL;
108 /** The vcg edge attribute hook. */
109 static DUMP_EDGE_VCGATTR_FUNC dump_edge_vcgattr_hook = NULL;
110 /** The vcg dump block edge hook */
111 static DUMP_NODE_EDGE_FUNC dump_block_edge_hook = NULL;
112 /** The vcg dump node edge hook. */
113 static DUMP_NODE_EDGE_FUNC dump_node_edge_hook = NULL;
115 /* Set the hook to be called to dump additional edges to a node. */
116 void set_dump_node_edge_hook(DUMP_NODE_EDGE_FUNC func) {
117 dump_node_edge_hook = func;
120 /* Get the additional edge dump hook. */
121 DUMP_NODE_EDGE_FUNC get_dump_node_edge_hook(void) {
122 return dump_node_edge_hook;
125 /* Set the hook to be called to dump additional edges to a block. */
126 void set_dump_block_edge_hook(DUMP_NODE_EDGE_FUNC func) {
127 dump_block_edge_hook = func;
130 /* Get the additional block edge dump hook. */
131 DUMP_NODE_EDGE_FUNC get_dump_block_edge_hook(void) {
132 return dump_node_edge_hook;
135 /* set the ir graph hook */
136 void set_dump_ir_graph_hook(DUMP_IR_GRAPH_FUNC hook) {
137 dump_ir_graph_hook = hook;
140 /* set the node attribute hook */
141 void set_dump_node_vcgattr_hook(DUMP_NODE_VCGATTR_FUNC hook) {
142 dump_node_vcgattr_hook = hook;
145 /* set the edge attribute hook */
146 void set_dump_edge_vcgattr_hook(DUMP_EDGE_VCGATTR_FUNC hook) {
147 dump_edge_vcgattr_hook = hook;
150 /** Returns 0 if dump_out_edge_flag or dump_loop_information_flag
151 * are set, else returns dump_const_local_flag.
153 static int get_opt_dump_const_local(void) {
154 if (dump_out_edge_flag || dump_loop_information_flag || (dump_new_edges_flag && edges_activated(current_ir_graph)))
156 return dump_const_local;
159 /* Set a prefix filter for output functions. */
160 void only_dump_method_with_name(ident *name) {
161 dump_file_filter_id = name;
164 /* Returns the prefix filter set with only_dump_method_with_name(). */
165 ident *get_dump_file_filter_ident(void) {
166 return dump_file_filter_id;
169 /* Returns non-zero if dump file filter is not set, or if it is a prefix of name. */
170 int is_filtered_dump_name(ident *name) {
171 if (!dump_file_filter_id) return 1;
172 return id_is_prefix(dump_file_filter_id, name);
175 /* To turn off display of edge labels. Edge labels often cause xvcg to
176 abort with a segmentation fault. */
177 void turn_off_edge_labels(void) {
181 void dump_consts_local(int flag) {
182 dump_const_local = flag;
185 void dump_node_idx_label(int flag) {
186 dump_node_idx_labels = flag;
189 void dump_constant_entity_values(int flag) {
190 const_entities = flag;
193 void dump_keepalive_edges(int flag) {
194 dump_keepalive = flag;
197 void dump_new_edges(int flag) {
198 dump_new_edges_flag = flag;
201 int get_opt_dump_keepalive_edges(void) {
202 return dump_keepalive;
205 void dump_out_edges(int flag) {
206 dump_out_edge_flag = flag;
209 void dump_dominator_information(int flag) {
210 dump_dominator_information_flag = flag;
213 void dump_loop_information(int flag) {
214 dump_loop_information_flag = flag;
217 void dump_backedge_information(int flag) {
218 dump_backedge_information_flag = flag;
221 /* Dump the information of type field specified in ana/irtypeinfo.h.
222 * If the flag is set, the type name is output in [] in the node label,
223 * else it is output as info.
225 void set_opt_dump_analysed_type_info(int flag) {
226 opt_dump_analysed_type_info = flag;
229 void dump_pointer_values_to_info(int flag) {
230 opt_dump_pointer_values_to_info = flag;
233 void dump_ld_names(int flag) {
237 void dump_all_anchors(int flag) {
241 void dump_macroblock_edges(int flag) {
242 dump_macro_block_edges = flag;
245 void dump_block_marker_in_title(int flag) {
246 dump_block_marker = flag;
249 /* -------------- some extended helper functions ----------------- */
252 * returns the name of a mode or ERROR_TXT if mode is NOT a mode object.
253 * in the later case, sets bad.
255 const char *get_mode_name_ex(const ir_mode *mode, int *bad) {
257 return get_mode_name(mode);
263 * returns the name of a type or <ERROR> if mode is NOT a mode object.
264 * in the later case, sets bad
266 const char *get_type_name_ex(const ir_type *tp, int *bad) {
268 return get_type_name(tp);
273 #define CUSTOM_COLOR_BASE 100
274 static const char *color_names[ird_color_count];
275 static const char *color_rgb[ird_color_count];
276 static struct obstack color_obst;
278 /** define a custom color. */
279 static void custom_color(int num, const char *rgb_def)
281 assert(num < ird_color_count);
282 obstack_printf(&color_obst, "%d", CUSTOM_COLOR_BASE + num);
283 obstack_1grow(&color_obst, '\0');
285 color_rgb[num] = rgb_def;
286 color_names[num] = obstack_finish(&color_obst);
289 /** Define a named color. */
290 static void named_color(int num, const char *name)
292 assert(num < ird_color_count);
293 color_rgb[num] = NULL;
294 color_names[num] = name;
297 /** Initializes the used colors. */
298 static void init_colors(void)
300 static int initialized = 0;
304 obstack_init(&color_obst);
306 custom_color(ird_color_prog_background, "204 204 204");
307 custom_color(ird_color_block_background, "255 255 0");
308 custom_color(ird_color_dead_block_background, "190 150 150");
309 named_color(ird_color_block_inout, "lightblue");
310 named_color(ird_color_default_node, "white");
311 custom_color(ird_color_memory, "153 153 255");
312 custom_color(ird_color_controlflow, "255 153 153");
313 custom_color(ird_color_const, "204 255 255");
314 custom_color(ird_color_proj, "255 255 153");
315 custom_color(ird_color_uses_memory, "153 153 255");
316 custom_color(ird_color_phi, "105 255 105");
317 custom_color(ird_color_anchor, "100 100 255");
318 named_color(ird_color_error, "red");
319 custom_color(ird_color_entity, "204 204 255");
325 * Prints the VCG color to a file.
327 static void print_vcg_color(FILE *F, ird_color_t color) {
328 assert(color < ird_color_count);
329 fprintf(F, "color:%s", color_names[color]);
333 * Prints the edge kind of a given IR node.
335 * Projs should be dumped near their predecessor, so they get "nearedge".
337 static void print_node_edge_kind(FILE *F, ir_node *node) {
339 fprintf(F, "nearedge: ");
341 fprintf(F, "edge: ");
346 * Prints the edge from a type S to a type T with additional info fmt, ...
349 static void print_type_type_edge(FILE *F, const ir_type *S, const ir_type *T, const char *fmt, ...)
354 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(S);
355 fprintf(F, " targetname: "); PRINT_TYPEID(T);
356 vfprintf(F, fmt, ap);
362 * Prints the edge from a type tp to an entity ent with additional info fmt, ...
365 static void print_type_ent_edge(FILE *F, const ir_type *tp, const ir_entity *ent, const char *fmt, ...)
370 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(tp);
371 fprintf(F, " targetname: \""); PRINT_ENTID(ent); fprintf(F, "\"");
372 vfprintf(F, fmt, ap);
378 * Prints the edge from an entity ent1 to an entity ent2 with additional info fmt, ...
381 static void print_ent_ent_edge(FILE *F, const ir_entity *ent1, const ir_entity *ent2, int backedge, ird_color_t color, const char *fmt, ...)
387 fprintf(F, "backedge: { sourcename: \"");
389 fprintf(F, "edge: { sourcename: \"");
391 fprintf(F, "\" targetname: \""); PRINT_ENTID(ent2); fprintf(F, "\"");
392 vfprintf(F, fmt, ap);
394 if (color != (ird_color_t) -1)
395 print_vcg_color(F, color);
401 * Prints the edge from an entity ent to a type tp with additional info fmt, ...
404 static void print_ent_type_edge(FILE *F, const ir_entity *ent, const ir_type *tp, const char *fmt, ...)
409 fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(ent);
410 fprintf(F, "\" targetname: "); PRINT_TYPEID(tp);
411 vfprintf(F, fmt, ap);
417 * Prints the edge from a node irn to a type tp with additional info fmt, ...
420 static void print_node_type_edge(FILE *F, const ir_node *irn, ir_type *tp, const char *fmt, ...)
425 fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(irn);
426 fprintf(F, "\" targetname: "); PRINT_TYPEID(tp);
427 vfprintf(F, fmt, ap);
433 * Prints the edge from a node irn to an entity ent with additional info fmt, ...
436 static void print_node_ent_edge(FILE *F, const ir_node *irn, const ir_entity *ent, const char *fmt, ...)
441 fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(irn);
442 fprintf(F, "\" targetname: \""); PRINT_ENTID(ent);
444 vfprintf(F, fmt, ap);
450 * Prints the edge from an entity ent to a node irn with additional info fmt, ...
453 static void print_ent_node_edge(FILE *F, const ir_entity *ent, const ir_node *irn, const char *fmt, ...)
458 fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(ent);
459 fprintf(F, "\" targetname: \""); PRINT_NODEID(irn); fprintf(F, "\"");
460 vfprintf(F, fmt, ap);
466 * Prints the edge from a type tp to an enumeration item item with additional info fmt, ...
469 static void print_enum_item_edge(FILE *F, const ir_type *tp, int item, const char *fmt, ...)
474 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(tp);
475 fprintf(F, " targetname: \""); PRINT_ITEMID(tp, item); fprintf(F, "\" ");
476 vfprintf(F, fmt, ap);
481 /*-----------------------------------------------------------------*/
482 /* global and ahead declarations */
483 /*-----------------------------------------------------------------*/
485 static void dump_whole_node(ir_node *n, void *env);
486 static inline void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg);
488 /*-----------------------------------------------------------------*/
489 /* Helper functions. */
490 /*-----------------------------------------------------------------*/
493 * This map is used as a private link attr to be able to call dumper
494 * anywhere without destroying link fields.
496 static pmap *irdump_link_map = NULL;
498 /** NOT A STANDARD LIBFIRM INIT METHOD
500 * We do not want to integrate dumping into libfirm, i.e., if the dumpers
501 * are off, we want to have as few interferences as possible. Therefore the
502 * initialization is performed lazily and not called from within init_firm.
504 * Creates the link attribute map. */
505 static void init_irdump(void) {
506 /* We need a new, empty map. */
507 if (irdump_link_map) pmap_destroy(irdump_link_map);
508 irdump_link_map = pmap_create();
509 if (!dump_file_filter_id)
510 dump_file_filter_id = new_id_from_str("");
514 * Returns the private link field.
516 static void *ird_get_irn_link(const ir_node *n) {
518 if (irdump_link_map == NULL)
521 if (pmap_contains(irdump_link_map, n))
522 res = pmap_get(irdump_link_map, n);
527 * Sets the private link field.
529 static void ird_set_irn_link(const ir_node *n, void *x) {
530 if (irdump_link_map == NULL)
532 pmap_insert(irdump_link_map, n, x);
536 * Gets the private link field of an irg.
538 static void *ird_get_irg_link(const ir_graph *irg) {
540 if (irdump_link_map == NULL)
543 if (pmap_contains(irdump_link_map, irg))
544 res = pmap_get(irdump_link_map, irg);
549 * Sets the private link field of an irg.
551 static void ird_set_irg_link(const ir_graph *irg, void *x) {
552 if (irdump_link_map == NULL)
554 pmap_insert(irdump_link_map, irg, x);
558 * Walker, clears the private link field.
560 static void clear_link(ir_node *node, void *env) {
562 ird_set_irn_link(node, NULL);
566 * If the entity has a ld_name, returns it if the dump_ld_name is set,
567 * else returns the name of the entity.
569 static const char *_get_ent_dump_name(const ir_entity *ent, int dump_ld_name) {
571 return "<NULL entity>";
573 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
574 if (ent->ld_name != NULL)
575 return get_id_str(ent->ld_name);
577 return get_id_str(ent->name);
581 * If the entity has a ld_name, returns it if the option dump_ld_name is set,
582 * else returns the name of the entity.
584 const char *get_ent_dump_name(const ir_entity *ent) {
585 return _get_ent_dump_name(ent, dump_ld_name);
588 /* Returns the name of an IRG. */
589 const char *get_irg_dump_name(const ir_graph *irg) {
590 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
591 return _get_ent_dump_name(get_irg_entity(irg), 1);
595 * Returns non-zero if a node is in floating state.
597 static int node_floats(const ir_node *n) {
598 return ((get_irn_pinned(n) == op_pin_state_floats) &&
599 (get_irg_pinned(current_ir_graph) == op_pin_state_floats));
603 * Walker that visits the anchors
605 static void ird_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env) {
606 if (dump_anchors || (dump_new_edges_flag && edges_activated(irg))) {
607 irg_walk_anchors(irg, pre, post, env);
609 irg_walk_graph(irg, pre, post, env);
614 * Walker, allocates an array for all blocks and puts it's nodes non-floating nodes into this array.
616 static void collect_node(ir_node *node, void *env) {
620 || (get_op_flags(get_irn_op(node)) & irop_flag_dump_noblock)) {
621 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
622 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
623 ARR_APP1(ir_node *, arr, node);
624 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
626 ir_node * block = get_nodes_block(node);
629 /* this node is in a Bad block, so we must place it into the graph's list */
630 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
631 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
632 ARR_APP1(ir_node *, arr, node);
633 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
635 ird_set_irn_link(node, ird_get_irn_link(block));
636 ird_set_irn_link(block, node);
641 /** Construct lists to walk ir block-wise.
643 * Collects all blocks, nodes not op_pin_state_pinned,
644 * Bad, NoMem and Unknown into a flexible array in link field of
645 * irg they belong to. Sets the irg link field to NULL in all
646 * graphs not visited.
647 * Free the list with DEL_ARR_F().
649 static ir_node **construct_block_lists(ir_graph *irg) {
651 #ifdef INTERPROCEDURAL_VIEW
652 int rem_view = get_interprocedural_view();
654 int walk_flag = ir_resources_reserved(irg) & IR_RESOURCE_IRN_VISITED;
655 ir_graph *rem = current_ir_graph;
657 current_ir_graph = irg;
660 ir_free_resources(irg, IR_RESOURCE_IRN_VISITED);
663 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
664 ird_set_irg_link(get_irp_irg(i), NULL);
666 ird_walk_graph(current_ir_graph, clear_link, collect_node, current_ir_graph);
668 #ifdef INTERPROCEDURAL_VIEW
669 /* Collect also EndReg and EndExcept. We do not want to change the walker. */
670 set_interprocedural_view(0);
673 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
674 irg_walk(get_irg_end_reg(current_ir_graph), clear_link, collect_node, current_ir_graph);
675 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
676 irg_walk(get_irg_end_except(current_ir_graph), clear_link, collect_node, current_ir_graph);
678 #ifdef INTERPROCEDURAL_VIEW
679 set_interprocedural_view(rem_view);
683 ir_reserve_resources(irg, IR_RESOURCE_IRN_VISITED);
686 current_ir_graph = rem;
687 return ird_get_irg_link(irg);
690 typedef struct _list_tuple {
692 ir_extblk **extbb_list;
695 /** Construct lists to walk IR extended block-wise.
696 * Free the lists in the tuple with DEL_ARR_F().
697 * Sets the irg link field to NULL in all
698 * graphs not visited.
700 static list_tuple *construct_extblock_lists(ir_graph *irg) {
701 ir_node **blk_list = construct_block_lists(irg);
703 ir_graph *rem = current_ir_graph;
704 list_tuple *lists = XMALLOC(list_tuple);
706 current_ir_graph = irg;
708 lists->blk_list = NEW_ARR_F(ir_node *, 0);
709 lists->extbb_list = NEW_ARR_F(ir_extblk *, 0);
711 inc_irg_block_visited(irg);
712 for (i = ARR_LEN(blk_list) - 1; i >= 0; --i) {
715 if (is_Block(blk_list[i])) {
716 ext = get_Block_extbb(blk_list[i]);
718 if (extbb_not_visited(ext)) {
719 ARR_APP1(ir_extblk *, lists->extbb_list, ext);
720 mark_extbb_visited(ext);
723 ARR_APP1(ir_node *, lists->blk_list, blk_list[i]);
727 current_ir_graph = rem;
728 ird_set_irg_link(irg, lists);
732 /*-----------------------------------------------------------------*/
733 /* Routines to dump information about a single ir node. */
734 /*-----------------------------------------------------------------*/
737 * dump the name of a node n to the File F.
739 int dump_node_opcode(FILE *F, ir_node *n)
742 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
744 /* call the dump_node operation if available */
746 return ops->dump_node(n, F, dump_node_opcode_txt);
748 /* implementation for default nodes */
749 switch (get_irn_opcode(n)) {
751 switch (get_SymConst_kind(n)) {
752 case symconst_addr_name:
753 /* don't use get_SymConst_ptr_info as it mangles the name. */
754 fprintf(F, "SymC %s", get_id_str(get_SymConst_name(n)));
756 case symconst_addr_ent:
757 fprintf(F, "SymC &%s", get_entity_name(get_SymConst_entity(n)));
759 case symconst_ofs_ent:
760 fprintf(F, "SymC %s offset", get_entity_name(get_SymConst_entity(n)));
762 case symconst_type_tag:
763 fprintf(F, "SymC %s tag", get_type_name_ex(get_SymConst_type(n), &bad));
765 case symconst_type_size:
766 fprintf(F, "SymC %s size", get_type_name_ex(get_SymConst_type(n), &bad));
768 case symconst_type_align:
769 fprintf(F, "SymC %s align", get_type_name_ex(get_SymConst_type(n), &bad));
771 case symconst_enum_const:
772 fprintf(F, "SymC %s enum", get_enumeration_name(get_SymConst_enum(n)));
778 if (!get_interprocedural_view())
785 ir_node *pred = get_Proj_pred(n);
787 if (get_irn_opcode(pred) == iro_Cond
788 && get_Proj_proj(n) == get_Cond_default_proj(pred)
789 && get_irn_mode(get_Cond_selector(pred)) != mode_b)
790 fprintf(F, "defProj");
798 if (get_interprocedural_view()) {
799 fprintf(F, "%s %s", get_irn_opname(n), get_ent_dump_name(get_irg_entity(get_irn_irg(n))));
804 case iro_CallBegin: {
805 ir_node *addr = get_CallBegin_ptr(n);
806 ir_entity *ent = NULL;
808 ent = get_Sel_entity(addr);
809 else if (is_Global(addr))
810 ent = get_Global_entity(addr);
811 fprintf(F, "%s", get_irn_opname(n));
812 if (ent) fprintf(F, " %s", get_entity_name(ent));
816 if (get_Load_align(n) == align_non_aligned)
818 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Load_mode(n), &bad));
821 if (get_Store_align(n) == align_non_aligned)
823 fprintf(F, "%s", get_irn_opname(n));
827 is_Block_dead(n) ? "Dead " : "", get_irn_opname(n),
828 dump_block_marker ? (get_Block_mark(n) ? "*" : "") : "");
831 if (get_Conv_strict(n))
832 fprintf(F, "strict");
833 fprintf(F, "%s", get_irn_opname(n));
836 fprintf(F, "%s", get_irn_opname(n));
837 if (get_Div_no_remainder(n))
839 fprintf(F, "[%s]", get_mode_name_ex(get_Div_resmode(n), &bad));
842 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Mod_resmode(n), &bad));
845 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_DivMod_resmode(n), &bad));
848 fprintf(F, "%s[%s]", get_irn_opname(n), get_builtin_kind_name(get_Builtin_kind(n)));
853 fprintf(F, "%s", get_irn_opname(n));
860 * Dump the mode of a node n to a file F.
861 * Ignore modes that are "always known".
863 static int dump_node_mode(FILE *F, ir_node *n)
866 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
870 /* call the dump_node operation if available */
872 return ops->dump_node(n, F, dump_node_mode_txt);
874 /* default implementation */
875 iro = get_irn_opcode(n);
887 mode = get_irn_mode(n);
889 if (mode != NULL && mode != mode_BB && mode != mode_ANY && mode != mode_BAD &&
890 (mode != mode_T || iro == iro_Proj))
891 fprintf(F, "%s", get_mode_name_ex(mode, &bad));
897 * Dump the type of a node n to a file F if it's known.
899 static int dump_node_typeinfo(FILE *F, ir_node *n) {
902 if (opt_dump_analysed_type_info) {
903 if (get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_consistent ||
904 get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_inconsistent) {
905 ir_type *tp = get_irn_typeinfo_type(n);
906 if (tp != firm_none_type)
907 fprintf(F, "[%s] ", get_type_name_ex(tp, &bad));
915 typedef struct _pns_lookup {
916 long nr; /**< the proj number */
917 const char *name; /**< the name of the Proj */
920 typedef struct _proj_lookup {
921 ir_opcode code; /**< the opcode of the Proj predecessor */
922 unsigned num_data; /**< number of data entries */
923 const pns_lookup_t *data; /**< the data */
926 #define ARR_SIZE(a) (sizeof(a)/sizeof(a[0]))
928 /** the lookup table for Proj(Start) names */
929 static const pns_lookup_t start_lut[] = {
930 #define X(a) { pn_Start_##a, #a }
938 /** the lookup table for Proj(Cond) names */
939 static const pns_lookup_t cond_lut[] = {
940 #define X(a) { pn_Cond_##a, #a }
946 /** the lookup table for Proj(Call) names */
947 static const pns_lookup_t call_lut[] = {
948 #define X(a) { pn_Call_##a, #a }
958 /** the lookup table for Proj(Quot) names */
959 static const pns_lookup_t quot_lut[] = {
960 #define X(a) { pn_Quot_##a, #a }
968 /** the lookup table for Proj(DivMod) names */
969 static const pns_lookup_t divmod_lut[] = {
970 #define X(a) { pn_DivMod_##a, #a }
979 /** the lookup table for Proj(Div) names */
980 static const pns_lookup_t div_lut[] = {
981 #define X(a) { pn_Div_##a, #a }
989 /** the lookup table for Proj(Mod) names */
990 static const pns_lookup_t mod_lut[] = {
991 #define X(a) { pn_Mod_##a, #a }
999 /** the lookup table for Proj(Load) names */
1000 static const pns_lookup_t load_lut[] = {
1001 #define X(a) { pn_Load_##a, #a }
1009 /** the lookup table for Proj(Store) names */
1010 static const pns_lookup_t store_lut[] = {
1011 #define X(a) { pn_Store_##a, #a }
1018 /** the lookup table for Proj(Alloc) names */
1019 static const pns_lookup_t alloc_lut[] = {
1020 #define X(a) { pn_Alloc_##a, #a }
1028 /** the lookup table for Proj(CopyB) names */
1029 static const pns_lookup_t copyb_lut[] = {
1030 #define X(a) { pn_CopyB_##a, #a }
1038 /** the lookup table for Proj(InstOf) names */
1039 static const pns_lookup_t instof_lut[] = {
1040 #define X(a) { pn_InstOf_##a, #a }
1049 /** the lookup table for Proj(Raise) names */
1050 static const pns_lookup_t raise_lut[] = {
1051 #define X(a) { pn_Raise_##a, #a }
1057 /** the lookup table for Proj(Bound) names */
1058 static const pns_lookup_t bound_lut[] = {
1059 #define X(a) { pn_Bound_##a, #a }
1067 /** the Proj lookup table */
1068 static const proj_lookup_t proj_lut[] = {
1069 #define E(a) ARR_SIZE(a), a
1070 { iro_Start, E(start_lut) },
1071 { iro_Cond, E(cond_lut) },
1072 { iro_Call, E(call_lut) },
1073 { iro_Quot, E(quot_lut) },
1074 { iro_DivMod, E(divmod_lut) },
1075 { iro_Div, E(div_lut) },
1076 { iro_Mod, E(mod_lut) },
1077 { iro_Load, E(load_lut) },
1078 { iro_Store, E(store_lut) },
1079 { iro_Alloc, E(alloc_lut) },
1080 { iro_CopyB, E(copyb_lut) },
1081 { iro_InstOf, E(instof_lut) },
1082 { iro_Raise, E(raise_lut) },
1083 { iro_Bound, E(bound_lut) }
1088 * Dump additional node attributes of some nodes to a file F.
1091 dump_node_nodeattr(FILE *F, ir_node *n)
1097 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1099 /* call the dump_node operation if available */
1101 return ops->dump_node(n, F, dump_node_nodeattr_txt);
1103 switch (get_irn_opcode(n)) {
1105 if (0 && get_interprocedural_view()) {
1106 fprintf(F, "%s ", get_ent_dump_name(get_irg_entity(current_ir_graph)));
1111 ir_fprintf(F, "%T ", get_Const_tarval(n));
1115 pred = get_Proj_pred(n);
1116 proj_nr = get_Proj_proj(n);
1118 code = get_irn_opcode(pred);
1120 if (code == iro_Cmp)
1121 fprintf(F, "%s ", get_pnc_string(get_Proj_proj(n)));
1122 else if (code == iro_Proj && get_irn_opcode(get_Proj_pred(pred)) == iro_Start)
1123 fprintf(F, "Arg %ld ", proj_nr);
1124 else if (code == iro_Cond && get_irn_mode(get_Cond_selector(pred)) != mode_b)
1125 fprintf(F, "%ld ", proj_nr);
1127 unsigned i, j, f = 0;
1129 for (i = 0; i < ARR_SIZE(proj_lut); ++i) {
1130 if (code == proj_lut[i].code) {
1131 for (j = 0; j < proj_lut[i].num_data; ++j) {
1132 if (proj_nr == proj_lut[i].data[j].nr) {
1133 fprintf(F, "%s ", proj_lut[i].data[j].name);
1142 fprintf(F, "%ld ", proj_nr);
1143 if (code == iro_Cond && get_Cond_jmp_pred(pred) != COND_JMP_PRED_NONE) {
1144 if (proj_nr == pn_Cond_false && get_Cond_jmp_pred(pred) == COND_JMP_PRED_FALSE)
1145 fprintf(F, "PRED ");
1146 if (proj_nr == pn_Cond_true && get_Cond_jmp_pred(pred) == COND_JMP_PRED_TRUE)
1147 fprintf(F, "PRED ");
1152 proj_nr = get_Filter_proj(n);
1153 if (! get_interprocedural_view()) {
1155 pred = get_Filter_pred(n);
1158 fprintf(F, "%ld ", proj_nr);
1161 fprintf(F, "%s ", get_ent_dump_name(get_Sel_entity(n)));
1164 fprintf(F, "(%s) ", get_type_name_ex(get_Cast_type(n), &bad));
1167 fprintf(F, "%s ", get_pnc_string(get_Confirm_cmp(n)));
1170 fprintf(F, "(%s) ", get_type_name_ex(get_CopyB_type(n), &bad));
1181 #include "execution_frequency.h"
1183 static void dump_node_ana_vals(FILE *F, ir_node *n) {
1187 #ifdef INTERPROCEDURAL_VIEW
1188 fprintf(F, " %lf*(%2.0lf + %2.0lf) = %2.0lf ",
1189 get_irn_exec_freq(n),
1190 get_irg_method_execution_frequency(get_irn_irg(n)),
1191 pow(5, get_irg_recursion_depth(get_irn_irg(n))),
1192 get_irn_exec_freq(n) * (get_irg_method_execution_frequency(get_irn_irg(n)) + pow(5, get_irg_recursion_depth(get_irn_irg(n))))
1198 /* Dumps a node label without the enclosing ". */
1199 int dump_node_label(FILE *F, ir_node *n) {
1202 bad |= dump_node_opcode(F, n);
1204 bad |= dump_node_mode(F, n);
1206 bad |= dump_node_typeinfo(F, n);
1207 bad |= dump_node_nodeattr(F, n);
1208 if(dump_node_idx_labels) {
1209 fprintf(F, "%ld:%d", get_irn_node_nr(n), get_irn_idx(n));
1211 fprintf(F, "%ld", get_irn_node_nr(n));
1218 * Dumps the attributes of a node n into the file F.
1219 * Currently this is only the color of a node.
1221 static void dump_node_vcgattr(FILE *F, ir_node *node, ir_node *local, int bad)
1227 print_vcg_color(F, ird_color_error);
1231 if (dump_node_vcgattr_hook)
1232 if (dump_node_vcgattr_hook(F, node, local))
1235 n = local ? local : node;
1237 if (overrule_nodecolor != ird_color_default_node) {
1238 print_vcg_color(F, overrule_nodecolor);
1242 mode = get_irn_mode(n);
1243 if(mode == mode_M) {
1244 print_vcg_color(F, ird_color_memory);
1247 if(mode == mode_X) {
1248 print_vcg_color(F, ird_color_controlflow);
1252 switch (get_irn_opcode(n)) {
1257 print_vcg_color(F, ird_color_anchor);
1260 print_vcg_color(F, ird_color_error);
1263 if (is_Block_dead(n))
1264 print_vcg_color(F, ird_color_dead_block_background);
1266 print_vcg_color(F, ird_color_block_background);
1269 print_vcg_color(F, ird_color_phi);
1272 print_vcg_color(F, ird_color_memory);
1276 print_vcg_color(F, ird_color_const);
1279 print_vcg_color(F, ird_color_proj);
1282 ir_op *op = get_irn_op(node);
1284 if(is_op_constlike(op)) {
1285 print_vcg_color(F, ird_color_const);
1286 } else if(is_op_uses_memory(op)) {
1287 print_vcg_color(F, ird_color_uses_memory);
1288 } else if(is_op_cfopcode(op) || is_op_forking(op)) {
1289 print_vcg_color(F, ird_color_controlflow);
1291 PRINT_DEFAULT_NODE_ATTR;
1297 /* Adds a new node info dumper callback. */
1298 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data)
1300 hook_entry_t *info = XMALLOC(hook_entry_t);
1302 info->hook._hook_node_info = cb;
1303 info->context = data;
1304 register_hook(hook_node_info, info);
1309 /* Remove a previously added info dumper callback. */
1310 void dump_remv_node_info_callback(void *handle)
1312 hook_entry_t *info = handle;
1313 unregister_hook(hook_node_info, info);
1318 * Dump the node information of a node n to a file F.
1320 static inline int dump_node_info(FILE *F, ir_node *n)
1323 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1325 fprintf(F, " info1: \"");
1326 bad = dump_irnode_to_file(F, n);
1327 /* call the dump_node operation if available */
1329 bad = ops->dump_node(n, F, dump_node_info_txt);
1331 /* allow additional info to be added */
1332 hook_node_info(F, n);
1338 static inline int is_constlike_node(const ir_node *node)
1340 const ir_op *op = get_irn_op(node);
1341 return is_op_constlike(op);
1345 /** outputs the predecessors of n, that are constants, local. I.e.,
1346 generates a copy of the constant predecessors for each node called with. */
1347 static void dump_const_node_local(FILE *F, ir_node *n) {
1349 if (!get_opt_dump_const_local()) return;
1351 /* Use visited flag to avoid outputting nodes twice.
1352 initialize it first. */
1353 for (i = 0; i < get_irn_arity(n); i++) {
1354 ir_node *con = get_irn_n(n, i);
1355 if (is_constlike_node(con)) {
1356 set_irn_visited(con, get_irg_visited(current_ir_graph) - 1);
1360 for (i = 0; i < get_irn_arity(n); i++) {
1361 ir_node *con = get_irn_n(n, i);
1362 if (is_constlike_node(con) && !irn_visited(con)) {
1365 mark_irn_visited(con);
1366 /* Generate a new name for the node by appending the names of
1368 fprintf(F, "node: {title: "); PRINT_CONSTID(n, con);
1369 fprintf(F, " label: \"");
1370 bad |= dump_node_label(F, con);
1372 bad |= dump_node_info(F, con);
1373 dump_node_vcgattr(F, n, con, bad);
1379 /** If the block of an edge is a const_like node, dump it local with an edge */
1380 static void dump_const_block_local(FILE *F, ir_node *n) {
1383 if (!get_opt_dump_const_local()) return;
1385 blk = get_nodes_block(n);
1386 if (is_constlike_node(blk)) {
1389 /* Generate a new name for the node by appending the names of
1391 fprintf(F, "node: {title: \""); PRINT_CONSTBLKID(n, blk);
1392 fprintf(F, "\" label: \"");
1393 bad |= dump_node_label(F, blk);
1395 bad |= dump_node_info(F, blk);
1396 dump_node_vcgattr(F, n, blk, bad);
1399 fprintf(F, "edge: { sourcename: \"");
1401 fprintf(F, "\" targetname: \""); PRINT_CONSTBLKID(n,blk);
1403 if (dump_edge_vcgattr_hook) {
1405 if (dump_edge_vcgattr_hook(F, n, -1)) {
1409 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1414 fprintf(F, "\" " BLOCK_EDGE_ATTR "}\n");
1419 * prints the error message of a node to a file F as info2.
1421 static void print_node_error(FILE *F, const char *err_msg)
1426 fprintf(F, " info2: \"%s\"", err_msg);
1430 * prints debug messages of a node to file F as info3.
1432 static void print_dbg_info(FILE *F, dbg_info *dbg)
1436 if (__dbg_info_snprint) {
1438 if (__dbg_info_snprint(buf, sizeof(buf), dbg) > 0)
1439 fprintf(F, " info3: \"%s\"\n", buf);
1446 static void dump_node(FILE *F, ir_node *n)
1451 if (get_opt_dump_const_local() && is_constlike_node(n))
1454 /* dump this node */
1455 fputs("node: {title: \"", F);
1459 fputs(" label: \"", F);
1460 bad = ! irn_vrfy_irg_dump(n, current_ir_graph, &p);
1461 bad |= dump_node_label(F, n);
1462 dump_node_ana_vals(F, n);
1463 //dump_node_ana_info(F, n);
1466 if (get_op_flags(get_irn_op(n)) & irop_flag_dump_noinput) {
1467 //fputs(" node_class:23", F);
1470 bad |= dump_node_info(F, n);
1471 print_node_error(F, p);
1472 print_dbg_info(F, get_irn_dbg_info(n));
1473 dump_node_vcgattr(F, n, NULL, bad);
1475 dump_const_node_local(F, n);
1477 if(dump_node_edge_hook)
1478 dump_node_edge_hook(F, n);
1481 /** dump the edge to the block this node belongs to */
1483 dump_ir_block_edge(FILE *F, ir_node *n) {
1484 if (get_opt_dump_const_local() && is_constlike_node(n)) return;
1485 if (is_no_Block(n)) {
1486 ir_node *block = get_nodes_block(n);
1488 if (get_opt_dump_const_local() && is_constlike_node(block)) {
1489 dump_const_block_local(F, n);
1491 fprintf(F, "edge: { sourcename: \"");
1493 fprintf(F, "\" targetname: ");
1494 fprintf(F, "\""); PRINT_NODEID(block); fprintf(F, "\"");
1496 if (dump_edge_vcgattr_hook) {
1498 if (dump_edge_vcgattr_hook(F, n, -1)) {
1502 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1507 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1513 print_data_edge_vcgattr(FILE *F, ir_node *from, int to) {
1515 * do not use get_nodes_block() here, will fail
1516 * if the irg is not pinned.
1518 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1519 fprintf(F, INTRA_DATA_EDGE_ATTR);
1521 fprintf(F, INTER_DATA_EDGE_ATTR);
1525 print_mem_edge_vcgattr(FILE *F, ir_node *from, int to) {
1527 * do not use get_nodes_block() here, will fail
1528 * if the irg is not pinned.
1530 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1531 fprintf(F, INTRA_MEM_EDGE_ATTR);
1533 fprintf(F, INTER_MEM_EDGE_ATTR);
1536 /** Print the vcg attributes for the edge from node from to it's to's input */
1537 static void print_edge_vcgattr(FILE *F, ir_node *from, int to) {
1540 if (dump_edge_vcgattr_hook)
1541 if (dump_edge_vcgattr_hook(F, from, to))
1544 if (dump_backedge_information_flag && is_backedge(from, to))
1545 fprintf(F, BACK_EDGE_ATTR);
1547 switch (get_irn_opcode(from)) {
1549 fprintf(F, CF_EDGE_ATTR);
1551 case iro_Start: break;
1554 if (get_irn_mode(get_End_keepalive(from, to)) == mode_BB)
1555 fprintf(F, KEEP_ALIVE_CF_EDGE_ATTR);
1557 fprintf(F, KEEP_ALIVE_DF_EDGE_ATTR);
1561 if (is_Proj(from)) {
1562 if (get_irn_mode(from) == mode_M)
1563 print_mem_edge_vcgattr(F, from, to);
1564 else if (get_irn_mode(from) == mode_X)
1565 fprintf(F, CF_EDGE_ATTR);
1567 print_data_edge_vcgattr(F, from, to);
1569 else if (get_irn_mode(get_irn_n(from, to)) == mode_M)
1570 print_mem_edge_vcgattr(F, from, to);
1571 else if (get_irn_mode(get_irn_n(from, to)) == mode_X)
1572 fprintf(F, CF_EDGE_ATTR);
1574 print_data_edge_vcgattr(F, from, to);
1578 /** dump edges to our inputs */
1579 static void dump_ir_data_edges(FILE *F, ir_node *n) {
1581 ir_visited_t visited = get_irn_visited(n);
1583 if (!dump_keepalive && is_End(n)) {
1584 /* the End node has only keep-alive edges */
1588 /* dump the dependency edges. */
1589 num = get_irn_deps(n);
1590 for (i = 0; i < num; ++i) {
1591 ir_node *dep = get_irn_dep(n, i);
1594 print_node_edge_kind(F, n);
1595 fprintf(F, "{sourcename: \"");
1597 fprintf(F, "\" targetname: ");
1598 if ((get_opt_dump_const_local()) && is_constlike_node(dep)) {
1599 PRINT_CONSTID(n, dep);
1605 fprintf(F, " label: \"%d\" ", i);
1606 fprintf(F, " color: darkgreen}\n");
1610 num = get_irn_arity(n);
1611 for (i = 0; i < num; i++) {
1612 ir_node *pred = get_irn_n(n, i);
1615 if ((get_interprocedural_view() && get_irn_visited(pred) < visited))
1616 continue; /* pred not dumped */
1618 if (dump_backedge_information_flag && is_backedge(n, i))
1619 fprintf(F, "backedge: {sourcename: \"");
1621 print_node_edge_kind(F, n);
1622 fprintf(F, "{sourcename: \"");
1625 fprintf(F, "\" targetname: ");
1626 if ((get_opt_dump_const_local()) && is_constlike_node(pred)) {
1627 PRINT_CONSTID(n, pred);
1629 fprintf(F, "\""); PRINT_NODEID(pred); fprintf(F, "\"");
1631 fprintf(F, " label: \"%d\" ", i);
1632 print_edge_vcgattr(F, n, i);
1636 if (dump_macro_block_edges && is_Block(n)) {
1637 ir_node *mb = get_Block_MacroBlock(n);
1638 fprintf(F, "edge: {sourcename: \"");
1640 fprintf(F, "\" targetname: \"");
1642 fprintf(F, "\" label: \"mb\" " MACROBLOCK_EDGE_ATTR);
1651 dump_ir_edges(FILE *F, ir_node *n) {
1652 const ir_edge_t *edge;
1655 foreach_out_edge(n, edge) {
1656 ir_node *succ = get_edge_src_irn(edge);
1658 print_node_edge_kind(F, succ);
1659 fprintf(F, "{sourcename: \"");
1661 fprintf(F, "\" targetname: \"");
1665 fprintf(F, " label: \"%d\" ", i);
1666 fprintf(F, OUT_EDGE_ATTR);
1673 /** Dumps a node and its edges but not the block edge */
1674 static void dump_node_wo_blockedge(ir_node *n, void *env) {
1677 dump_ir_data_edges(F, n);
1680 /** Dumps a node and its edges. */
1681 static void dump_whole_node(ir_node *n, void *env) {
1683 dump_node_wo_blockedge(n, env);
1684 if (!node_floats(n))
1685 dump_ir_block_edge(F, n);
1686 if (dump_new_edges_flag && edges_activated(current_ir_graph))
1687 dump_ir_edges(F, n);
1690 /** Dumps a const-like node. */
1691 static void dump_const_node(ir_node *n, void *env) {
1692 if (is_Block(n)) return;
1693 dump_node_wo_blockedge(n, env);
1696 /***********************************************************************/
1697 /* the following routines dump the nodes/irgs bracketed to graphs. */
1698 /***********************************************************************/
1700 /** Dumps a constant expression as entity initializer, array bound ...
1702 static void dump_const_expression(FILE *F, ir_node *value) {
1703 ir_graph *rem = current_ir_graph;
1704 int rem_dump_const_local = dump_const_local;
1705 dump_const_local = 0;
1706 current_ir_graph = get_const_code_irg();
1707 irg_walk(value, dump_const_node, NULL, F);
1708 /* Decrease visited flag so that we walk with the same flag for the next
1709 expression. This guarantees that we don't dump the same node twice,
1710 as for const expressions cse is performed to save memory. */
1711 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph) -1);
1712 current_ir_graph = rem;
1713 dump_const_local = rem_dump_const_local;
1716 /** Dump a block as graph containing its nodes.
1718 * Expects to find nodes belonging to the block as list in its
1720 * Dumps the edges of all nodes including itself. */
1721 static void dump_whole_block(FILE *F, ir_node *block) {
1723 ird_color_t color = ird_color_block_background;
1725 assert(is_Block(block));
1727 fprintf(F, "graph: { title: \"");
1728 PRINT_NODEID(block);
1729 fprintf(F, "\" label: \"");
1730 dump_node_label(F, block);
1732 /* colorize blocks */
1733 if (! get_Block_matured(block))
1734 color = ird_color_block_background;
1735 if (is_Block_dead(block))
1736 color = ird_color_dead_block_background;
1738 fprintf(F, "\" status:clustered ");
1739 print_vcg_color(F, color);
1742 /* yComp can show attributes for blocks, XVCG parses but ignores them */
1743 dump_node_info(F, block);
1744 print_dbg_info(F, get_irn_dbg_info(block));
1746 /* dump the blocks edges */
1747 dump_ir_data_edges(F, block);
1749 if (dump_block_edge_hook)
1750 dump_block_edge_hook(F, block);
1752 /* dump the nodes that go into the block */
1753 for (node = ird_get_irn_link(block); node; node = ird_get_irn_link(node)) {
1755 dump_ir_data_edges(F, node);
1758 /* Close the vcg information for the block */
1760 dump_const_node_local(F, block);
1764 /** dumps a graph block-wise. Expects all blockless nodes in arr in irgs link.
1765 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1767 dump_block_graph(FILE *F, ir_graph *irg) {
1769 ir_graph *rem = current_ir_graph;
1770 ir_node **arr = ird_get_irg_link(irg);
1771 current_ir_graph = irg;
1773 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1774 ir_node * node = arr[i];
1775 if (is_Block(node)) {
1776 /* Dumps the block and all the nodes in the block, which are to
1777 be found in Block->link. */
1778 dump_whole_block(F, node);
1780 /* Nodes that are not in a Block. */
1782 if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
1783 dump_const_block_local(F, node);
1785 dump_ir_data_edges(F, node);
1787 if (dump_new_edges_flag && edges_activated(irg))
1788 dump_ir_edges(F, node);
1791 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1792 dump_loop_nodes_into_graph(F, irg);
1794 current_ir_graph = rem;
1798 * Dump the info for an irg.
1799 * Parsed by XVCG but not shown. use yComp.
1801 static void dump_graph_info(FILE *F, ir_graph *irg) {
1802 fprintf(F, "info1: \"");
1803 dump_entity_to_file(F, get_irg_entity(irg), dump_verbosity_entattrs | dump_verbosity_entconsts);
1807 /** Dumps an irg as a graph clustered by block nodes.
1808 * If interprocedural view edges can point to nodes out of this graph.
1810 static void dump_graph_from_list(FILE *F, ir_graph *irg) {
1811 ir_entity *ent = get_irg_entity(irg);
1813 fprintf(F, "graph: { title: \"");
1815 fprintf(F, "\" label: \"%s\" status:clustered color:%s \n",
1816 get_ent_dump_name(ent), color_names[ird_color_prog_background]);
1818 dump_graph_info(F, irg);
1819 print_dbg_info(F, get_entity_dbg_info(ent));
1821 dump_block_graph(F, irg);
1823 /* Close the vcg information for the irg */
1824 fprintf(F, "}\n\n");
1827 /** dumps a graph extended block-wise. Expects all blockless nodes in arr in irgs link.
1828 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1830 dump_extblock_graph(FILE *F, ir_graph *irg) {
1832 ir_graph *rem = current_ir_graph;
1833 ir_extblk **arr = ird_get_irg_link(irg);
1834 current_ir_graph = irg;
1836 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1837 ir_extblk *extbb = arr[i];
1838 ir_node *leader = get_extbb_leader(extbb);
1841 fprintf(F, "graph: { title: \"");
1842 PRINT_EXTBBID(leader);
1843 fprintf(F, "\" label: \"ExtBB %ld\" status:clustered color:lightgreen\n",
1844 get_irn_node_nr(leader));
1846 for (j = ARR_LEN(extbb->blks) - 1; j >= 0; --j) {
1847 ir_node * node = extbb->blks[j];
1848 if (is_Block(node)) {
1849 /* Dumps the block and all the nodes in the block, which are to
1850 be found in Block->link. */
1851 dump_whole_block(F, node);
1853 /* Nodes that are not in a Block. */
1855 if (is_Bad(get_nodes_block(node)) && !node_floats(node)) {
1856 dump_const_block_local(F, node);
1858 dump_ir_data_edges(F, node);
1864 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1865 dump_loop_nodes_into_graph(F, irg);
1867 current_ir_graph = rem;
1872 /*******************************************************************/
1873 /* Basic type and entity nodes and edges. */
1874 /*******************************************************************/
1876 /** dumps the edges between nodes and their type or entity attributes. */
1877 static void dump_node2type_edges(ir_node *n, void *env)
1882 switch (get_irn_opcode(n)) {
1884 /* @@@ some consts have an entity */
1887 if (SYMCONST_HAS_TYPE(get_SymConst_kind(n)))
1888 print_node_type_edge(F,n,get_SymConst_type(n),NODE2TYPE_EDGE_ATTR);
1891 print_node_ent_edge(F,n,get_Sel_entity(n),NODE2TYPE_EDGE_ATTR);
1894 print_node_type_edge(F,n,get_Call_type(n),NODE2TYPE_EDGE_ATTR);
1897 print_node_type_edge(F,n,get_Alloc_type(n),NODE2TYPE_EDGE_ATTR);
1900 print_node_type_edge(F,n,get_Free_type(n),NODE2TYPE_EDGE_ATTR);
1903 print_node_type_edge(F,n,get_Cast_type(n),NODE2TYPE_EDGE_ATTR);
1911 static int print_type_info(FILE *F, ir_type *tp) {
1914 if (get_type_state(tp) == layout_undefined) {
1915 fprintf(F, "state: layout_undefined\n");
1917 fprintf(F, "state: layout_fixed,\n");
1919 if (get_type_mode(tp))
1920 fprintf(F, "mode: %s,\n", get_mode_name_ex(get_type_mode(tp), &bad));
1921 fprintf(F, "size: %db,\n", get_type_size_bits(tp));
1926 static void print_typespecific_info(FILE *F, ir_type *tp) {
1927 switch (get_type_tpop_code(tp)) {
1929 fprintf(F, "peculiarity: %s\n", get_peculiarity_string(get_class_peculiarity(tp)));
1934 fprintf(F, "variadicity: %s\n", get_variadicity_name(get_method_variadicity(tp)));
1935 fprintf(F, "params: %d\n", get_method_n_params(tp));
1936 fprintf(F, "results: %d\n", get_method_n_ress(tp));
1942 case tpo_enumeration:
1954 static void print_typespecific_vcgattr(FILE *F, ir_type *tp) {
1955 switch (get_type_tpop_code(tp)) {
1957 if (peculiarity_existent == get_class_peculiarity(tp))
1958 fprintf(F, " " TYPE_CLASS_NODE_ATTR);
1960 fprintf(F, " " TYPE_DESCRIPTION_NODE_ATTR);
1963 fprintf(F, " " TYPE_METH_NODE_ATTR);
1971 case tpo_enumeration:
1983 int dump_type_node(FILE *F, ir_type *tp)
1987 fprintf(F, "node: {title: ");
1989 fprintf(F, " label: \"%s %s\"", get_type_tpop_name(tp), get_type_name_ex(tp, &bad));
1990 fprintf(F, " info1: \"");
1992 bad |= print_type_info(F, tp);
1993 print_typespecific_info(F, tp);
1995 dump_type_to_file(F, tp, dump_verbosity_max);
1998 print_dbg_info(F, get_type_dbg_info(tp));
1999 print_typespecific_vcgattr(F, tp);
2006 void dump_entity_node(FILE *F, ir_entity *ent)
2008 fprintf(F, "node: {title: \"");
2009 PRINT_ENTID(ent); fprintf(F, "\"");
2010 fprintf(F, DEFAULT_TYPE_ATTRIBUTE);
2011 fprintf(F, "label: ");
2012 fprintf(F, "\"%s\" ", get_ent_dump_name(ent));
2014 print_vcg_color(F, ird_color_entity);
2015 fprintf(F, "\n info1: \"");
2017 dump_entity_to_file(F, ent, dump_verbosity_entattrs | dump_verbosity_entconsts);
2020 print_dbg_info(F, get_entity_dbg_info(ent));
2024 static void dump_enum_item(FILE *F, ir_type *tp, int pos)
2027 ir_enum_const *ec = get_enumeration_const(tp, pos);
2028 ident *id = get_enumeration_nameid(ec);
2029 tarval *tv = get_enumeration_value(ec);
2032 tarval_snprintf(buf, sizeof(buf), tv);
2034 strncpy(buf, "<not set>", sizeof(buf));
2035 fprintf(F, "node: {title: \"");
2036 PRINT_ITEMID(tp, pos); fprintf(F, "\"");
2037 fprintf(F, DEFAULT_ENUM_ITEM_ATTRIBUTE);
2038 fprintf(F, "label: ");
2039 fprintf(F, "\"enum item %s\" " ENUM_ITEM_NODE_ATTR, get_id_str(id));
2040 fprintf(F, "\n info1: \"value: %s\"}\n", buf);
2044 * Dumps a new style initializer.
2046 static void dump_entity_initializer(FILE *F, const ir_entity *ent) {
2052 /** Dumps a type or entity and it's edges. */
2053 static void dump_type_info(type_or_ent tore, void *env) {
2055 int i = 0; /* to shutup gcc */
2057 /* dump this type or entity */
2059 switch (get_kind(tore.ent)) {
2061 ir_entity *ent = tore.ent;
2064 dump_entity_node(F, ent);
2066 /* skip this to reduce graph. Member edge of type is parallel to this edge. *
2067 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2068 ENT_OWN_EDGE_ATTR "}\n", ent, get_entity_owner(ent));*/
2069 print_ent_type_edge(F,ent, get_entity_type(ent), ENT_TYPE_EDGE_ATTR);
2070 if (is_Class_type(get_entity_owner(ent))) {
2071 for (i = get_entity_n_overwrites(ent) - 1; i >= 0; --i)
2072 print_ent_ent_edge(F,ent, get_entity_overwrites(ent, i), 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2074 /* attached subgraphs */
2075 if (const_entities && (get_entity_variability(ent) != variability_uninitialized)) {
2076 if (is_atomic_entity(ent)) {
2077 value = get_atomic_ent_value(ent);
2079 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2080 /* DDMN(value); $$$ */
2081 dump_const_expression(F, value);
2084 if (is_compound_entity(ent)) {
2085 if (has_entity_initializer(ent)) {
2086 /* new style initializers */
2087 dump_entity_initializer(F, ent);
2089 /* old style compound entity values */
2090 for (i = get_compound_ent_n_values(ent) - 1; i >= 0; --i) {
2091 value = get_compound_ent_value(ent, i);
2093 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2094 dump_const_expression(F, value);
2095 print_ent_ent_edge(F, ent, get_compound_ent_value_member(ent, i), 0, -1, ENT_CORR_EDGE_ATTR, i);
2097 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2098 ENT_CORR_EDGE_ATTR "}\n", GET_ENTID(ent),
2099 get_compound_ent_value_member(ent, i), i);
2109 ir_type *tp = tore.typ;
2110 dump_type_node(F, tp);
2111 /* and now the edges */
2112 switch (get_type_tpop_code(tp)) {
2114 for (i = get_class_n_supertypes(tp) - 1; i >= 0; --i)
2115 print_type_type_edge(F, tp, get_class_supertype(tp, i), TYPE_SUPER_EDGE_ATTR);
2116 for (i = get_class_n_members(tp) - 1; i >= 0; --i)
2117 print_type_ent_edge(F, tp, get_class_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
2120 for (i = get_struct_n_members(tp) - 1; i >= 0; --i)
2121 print_type_ent_edge(F, tp, get_struct_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
2124 for (i = get_method_n_params(tp) - 1; i >= 0; --i)
2125 print_type_type_edge(F, tp, get_method_param_type(tp, i), METH_PAR_EDGE_ATTR,i);
2126 for (i = get_method_n_ress(tp) - 1; i >= 0; --i)
2127 print_type_type_edge(F, tp, get_method_res_type(tp, i), METH_RES_EDGE_ATTR,i);
2130 for (i = get_union_n_members(tp) - 1; i >= 0; --i)
2131 print_type_ent_edge(F, tp, get_union_member(tp, i), UNION_EDGE_ATTR);
2134 print_type_type_edge(F, tp, get_array_element_type(tp), ARR_ELT_TYPE_EDGE_ATTR);
2135 print_type_ent_edge(F, tp, get_array_element_entity(tp), ARR_ENT_EDGE_ATTR);
2136 for (i = get_array_n_dimensions(tp) - 1; i >= 0; --i) {
2137 ir_node *upper = get_array_upper_bound(tp, i);
2138 ir_node *lower = get_array_lower_bound(tp, i);
2139 print_node_type_edge(F, upper, tp, "label: \"upper %d\"", get_array_order(tp, i));
2140 print_node_type_edge(F, lower, tp, "label: \"lower %d\"", get_array_order(tp, i));
2141 dump_const_expression(F, upper);
2142 dump_const_expression(F, lower);
2145 case tpo_enumeration:
2146 for (i = get_enumeration_n_enums(tp) - 1; i >= 0; --i) {
2147 dump_enum_item(F, tp, i);
2148 print_enum_item_edge(F, tp, i, "label: \"item %d\"", i);
2152 print_type_type_edge(F, tp, get_pointer_points_to_type(tp), PTR_PTS_TO_EDGE_ATTR);
2159 break; /* case k_type */
2162 printf(" *** irdump, dump_type_info(l.%i), faulty type.\n", __LINE__);
2163 } /* switch kind_or_entity */
2166 typedef struct _h_env {
2171 /** For dumping class hierarchies.
2172 * Dumps a class type node and a superclass edge.
2173 * If env->dump_ent dumps entities of classes and overwrites edges.
2176 dump_class_hierarchy_node(type_or_ent tore, void *ctx) {
2179 int i = 0; /* to shutup gcc */
2181 /* dump this type or entity */
2182 switch (get_kind(tore.ent)) {
2184 ir_entity *ent = tore.ent;
2185 if (get_entity_owner(ent) == get_glob_type()) break;
2186 if (!is_Method_type(get_entity_type(ent)))
2188 if (env->dump_ent && is_Class_type(get_entity_owner(ent))) {
2190 dump_entity_node(F, ent);
2192 print_type_ent_edge(F, get_entity_owner(ent), ent, TYPE_MEMBER_EDGE_ATTR);
2193 for (i = get_entity_n_overwrites(ent) - 1; i >= 0; --i)
2194 print_ent_ent_edge(F, get_entity_overwrites(ent, i), ent, 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2199 ir_type *tp = tore.typ;
2200 if (tp == get_glob_type())
2202 switch (get_type_tpop_code(tp)) {
2204 dump_type_node(F, tp);
2205 /* and now the edges */
2206 for (i = get_class_n_supertypes(tp) - 1; i >= 0; --i) {
2207 print_type_type_edge(F,tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2212 break; /* case k_type */
2215 printf(" *** irdump, dump_class_hierarchy_node(l.%i), faulty type.\n", __LINE__);
2216 } /* switch kind_or_entity */
2219 /*******************************************************************/
2220 /* dump analysis information that is expressed in graph terms. */
2221 /*******************************************************************/
2223 /* dump out edges */
2225 dump_out_edge(ir_node *n, void *env) {
2228 for (i = get_irn_n_outs(n) - 1; i >= 0; --i) {
2229 ir_node *succ = get_irn_out(n, i);
2231 print_node_edge_kind(F, succ);
2232 fprintf(F, "{sourcename: \"");
2234 fprintf(F, "\" targetname: \"");
2236 fprintf(F, "\" color: red linestyle: dashed");
2242 dump_loop_label(FILE *F, ir_loop *loop) {
2243 fprintf(F, "loop %d, %d sons, %d nodes",
2244 get_loop_depth(loop), get_loop_n_sons(loop), get_loop_n_nodes(loop));
2247 static inline void dump_loop_info(FILE *F, ir_loop *loop) {
2248 fprintf(F, " info1: \"");
2249 fprintf(F, " loop nr: %d", get_loop_loop_nr(loop));
2250 #ifdef DEBUG_libfirm /* GL @@@ debug analyses */
2251 fprintf(F, "\n The loop was analyzed %d times.", PTR_TO_INT(get_loop_link(loop)));
2257 dump_loop_node(FILE *F, ir_loop *loop) {
2258 fprintf(F, "node: {title: \"");
2260 fprintf(F, "\" label: \"");
2261 dump_loop_label(F, loop);
2263 dump_loop_info(F, loop);
2268 dump_loop_node_edge(FILE *F, ir_loop *loop, int i) {
2270 fprintf(F, "edge: {sourcename: \"");
2272 fprintf(F, "\" targetname: \"");
2273 PRINT_NODEID(get_loop_node(loop, i));
2274 fprintf(F, "\" color: green");
2279 dump_loop_son_edge(FILE *F, ir_loop *loop, int i) {
2281 fprintf(F, "edge: {sourcename: \"");
2283 fprintf(F, "\" targetname: \"");
2284 PRINT_LOOPID(get_loop_son(loop, i));
2285 fprintf(F, "\" color: darkgreen label: \"%d\"}\n",
2286 get_loop_element_pos(loop, get_loop_son(loop, i)));
2290 void dump_loops(FILE *F, ir_loop *loop) {
2292 /* dump this loop node */
2293 dump_loop_node(F, loop);
2295 /* dump edges to nodes in loop -- only if it is a real loop */
2296 if (get_loop_depth(loop) != 0) {
2297 for (i = get_loop_n_nodes(loop) - 1; i >= 0; --i) {
2298 dump_loop_node_edge(F, loop, i);
2301 for (i = get_loop_n_sons(loop) - 1; i >= 0; --i) {
2302 dump_loops(F, get_loop_son(loop, i));
2303 dump_loop_son_edge(F, loop, i);
2308 void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg) {
2309 ir_loop *loop = get_irg_loop(irg);
2312 ir_graph *rem = current_ir_graph;
2313 current_ir_graph = irg;
2315 dump_loops(F, loop);
2317 current_ir_graph = rem;
2323 * dumps the VCG header
2325 void dump_vcg_header(FILE *F, const char *name, const char *layout, const char *orientation) {
2331 label = edge_label ? "yes" : "no";
2332 if (! layout) layout = "Compilergraph";
2333 if (!orientation) orientation = "bottom_to_top";
2337 "graph: { title: \"ir graph of %s\"\n"
2338 "display_edge_labels: %s\n"
2339 "layoutalgorithm: mindepth //$ \"%s\"\n"
2340 "manhattan_edges: yes\n"
2341 "port_sharing: no\n"
2343 "classname 1: \"intrablock Data\"\n"
2344 "classname 2: \"Block\"\n"
2345 "classname 3: \"Entity type\"\n"
2346 "classname 4: \"Entity owner\"\n"
2347 "classname 5: \"Method Param\"\n"
2348 "classname 6: \"Method Res\"\n"
2349 "classname 7: \"Super\"\n"
2350 "classname 8: \"Union\"\n"
2351 "classname 9: \"Points-to\"\n"
2352 "classname 10: \"Array Element Type\"\n"
2353 "classname 11: \"Overwrites\"\n"
2354 "classname 12: \"Member\"\n"
2355 "classname 13: \"Control Flow\"\n"
2356 "classname 14: \"intrablock Memory\"\n"
2357 "classname 15: \"Dominators\"\n"
2358 "classname 16: \"interblock Data\"\n"
2359 "classname 17: \"interblock Memory\"\n"
2360 "classname 18: \"Exception Control Flow for Interval Analysis\"\n"
2361 "classname 19: \"Postdominators\"\n"
2362 "classname 20: \"Keep Alive\"\n"
2363 "classname 21: \"Out Edges\"\n"
2364 "classname 22: \"Macro Block Edges\"\n"
2365 //"classname 23: \"NoInput Nodes\"\n"
2366 "infoname 1: \"Attribute\"\n"
2367 "infoname 2: \"Verification errors\"\n"
2368 "infoname 3: \"Debug info\"\n",
2369 name, label, layout, orientation);
2371 for (i = 0; i < ird_color_count; ++i) {
2372 if (color_rgb[i] != NULL) {
2373 fprintf(F, "colorentry %s: %s\n", color_names[i], color_rgb[i]);
2376 fprintf(F, "\n"); /* a separator */
2382 * @param irg The graph to be dumped
2383 * @param suffix1 first filename suffix
2384 * @param suffix2 second filename suffix
2386 FILE *vcg_open(const ir_graph *irg, const char *suffix1, const char *suffix2) {
2388 const char *nm = get_irg_dump_name(irg);
2389 int len = strlen(nm), i, j;
2390 char *fname; /* filename to put the vcg information in */
2392 if (!suffix1) suffix1 = "";
2393 if (!suffix2) suffix2 = "";
2395 /* open file for vcg graph */
2396 fname = XMALLOCN(char, len * 2 + strlen(suffix1) + strlen(suffix2) + 5);
2398 /* strncpy (fname, nm, len); */ /* copy the filename */
2400 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2402 fname[j] = '@'; j++; fname[j] = '1'; j++;
2403 } else if (nm[i] == '@') {
2404 fname[j] = '@'; j++; fname[j] = '2'; j++;
2406 fname[j] = nm[i]; j++;
2410 strcat(fname, suffix1); /* append file suffix */
2411 strcat(fname, suffix2); /* append file suffix */
2412 strcat(fname, ".vcg"); /* append the .vcg suffix */
2414 /* vcg really expect only a <CR> at end of line, so
2415 * the "b"inary mode is what you mean (and even needed for Win32)
2417 F = fopen(fname, "wb"); /* open file for writing */
2429 * @param name prefix file name
2430 * @param suffix filename suffix
2432 FILE *vcg_open_name(const char *name, const char *suffix) {
2434 char *fname; /* filename to put the vcg information in */
2435 int i, j, len = strlen(name);
2437 if (!suffix) suffix = "";
2439 /** open file for vcg graph */
2440 fname = XMALLOCN(char, len * 2 + 5 + strlen(suffix));
2441 /* strcpy (fname, name);*/ /* copy the filename */
2443 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2444 if (name[i] == '/') {
2445 fname[j] = '@'; j++; fname[j] = '1'; j++;
2446 } else if (name[i] == '@') {
2447 fname[j] = '@'; j++; fname[j] = '2'; j++;
2449 fname[j] = name[i]; j++;
2453 strcat(fname, suffix);
2454 strcat(fname, ".vcg"); /* append the .vcg suffix */
2456 /* vcg really expect only a <CR> at end of line, so
2457 * the "b"inary mode is what you mean (and even needed for Win32)
2459 F = fopen(fname, "wb"); /* open file for writing */
2469 * Dumps the vcg file footer
2471 void dump_vcg_footer(FILE *F) {
2475 /************************************************************************/
2476 /************************************************************************/
2477 /* Routines that dump all or parts of the firm representation to a file */
2478 /************************************************************************/
2479 /************************************************************************/
2481 /************************************************************************/
2482 /* Dump ir graphs, different formats and additional information. */
2483 /************************************************************************/
2485 typedef void (*do_dump_graph_func) (ir_graph *irg, FILE *out);
2487 static void do_dump(ir_graph *irg, const char *suffix, const char *suffix_ip,
2488 const char *suffix_nonip, do_dump_graph_func dump_func)
2492 const char *suffix1;
2494 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2497 rem = current_ir_graph;
2498 current_ir_graph = irg;
2499 if (get_interprocedural_view())
2500 suffix1 = suffix_ip;
2502 suffix1 = suffix_nonip;
2503 current_ir_graph = rem;
2505 out = vcg_open(irg, suffix, suffix1);
2507 dump_func(irg, out);
2512 void dump_ir_graph_file(ir_graph *irg, FILE *out)
2514 if (dump_backedge_information_flag
2515 && get_irg_loopinfo_state(irg) != loopinfo_consistent) {
2516 construct_backedges(irg);
2519 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2521 /* call the dump graph hook */
2522 if (dump_ir_graph_hook) {
2523 if (dump_ir_graph_hook(out, irg)) {
2528 /* walk over the graph */
2529 /* dump_whole_node must be called in post visiting predecessors */
2530 ird_walk_graph(irg, NULL, dump_whole_node, out);
2532 /* dump the out edges in a separate walk */
2533 if ((dump_out_edge_flag) && (get_irg_outs_state(irg) != outs_none)) {
2534 irg_out_walk(get_irg_start(irg), dump_out_edge, NULL, out);
2537 dump_vcg_footer(out);
2540 /** Routine to dump a graph, blocks as conventional nodes. */
2541 void dump_ir_graph(ir_graph *irg, const char *suffix )
2543 do_dump(irg, suffix, "-pure-ip", "-pure", dump_ir_graph_file);
2546 void dump_ir_block_graph_file(ir_graph *irg, FILE *out)
2550 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2552 construct_block_lists(irg);
2555 * If we are in the interprocedural view, we dump not
2556 * only the requested irg but also all irgs that can be reached
2559 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2560 ir_graph *g = get_irp_irg(i);
2561 ir_node **arr = ird_get_irg_link(g);
2563 dump_graph_from_list(out, g);
2568 dump_vcg_footer(out);
2571 /* Dump a firm graph without explicit block nodes. */
2572 void dump_ir_block_graph(ir_graph *irg, const char *suffix)
2574 do_dump(irg, suffix, "-ip", "", dump_ir_block_graph_file);
2577 void dump_ir_extblock_graph_file(ir_graph *irg, FILE *F)
2580 ir_entity *ent = get_irg_entity(irg);
2582 if (get_irg_extblk_state(irg) != extblk_valid)
2585 dump_vcg_header(F, get_irg_dump_name(irg), NULL, NULL);
2587 construct_extblock_lists(irg);
2589 fprintf(F, "graph: { title: \"");
2591 fprintf(F, "\" label: \"%s\" status:clustered color: white \n",
2592 get_ent_dump_name(ent));
2594 dump_graph_info(F, irg);
2595 print_dbg_info(F, get_entity_dbg_info(ent));
2597 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2598 ir_graph *irg = get_irp_irg(i);
2599 list_tuple *lists = ird_get_irg_link(irg);
2602 /* dump the extended blocks first */
2603 if (ARR_LEN(lists->extbb_list)) {
2604 ird_set_irg_link(irg, lists->extbb_list);
2605 dump_extblock_graph(F, irg);
2608 /* we may have blocks without extended blocks, bad for instance */
2609 if (ARR_LEN(lists->blk_list)) {
2610 ird_set_irg_link(irg, lists->blk_list);
2611 dump_block_graph(F, irg);
2614 DEL_ARR_F(lists->extbb_list);
2615 DEL_ARR_F(lists->blk_list);
2620 /* Close the vcg information for the irg */
2621 fprintf(F, "}\n\n");
2627 /* Dump a firm graph without explicit block nodes but grouped in extended blocks. */
2628 void dump_ir_extblock_graph(ir_graph *irg, const char *suffix)
2630 do_dump(irg, suffix, "-ip", "", dump_ir_extblock_graph_file);
2633 void dump_ir_graph_w_types_file(ir_graph *irg, FILE *out)
2635 ir_graph *rem = current_ir_graph;
2636 int rem_dump_const_local;
2638 rem = current_ir_graph;
2639 current_ir_graph = irg;
2640 rem_dump_const_local = dump_const_local;
2641 /* dumping types does not work with local nodes */
2642 dump_const_local = 0;
2644 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2646 /* dump common ir graph */
2647 irg_walk(get_irg_end(irg), NULL, dump_whole_node, out);
2648 /* dump type info */
2649 type_walk_irg(irg, dump_type_info, NULL, out);
2650 inc_irg_visited(get_const_code_irg());
2651 /* dump edges from graph to type info */
2652 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2654 dump_vcg_footer(out);
2655 dump_const_local = rem_dump_const_local;
2656 current_ir_graph = rem;
2659 /* dumps a graph with type information */
2660 void dump_ir_graph_w_types(ir_graph *irg, const char *suffix)
2662 do_dump(irg, suffix, "-pure-wtypes-ip", "-pure-wtypes",
2663 dump_ir_graph_w_types_file);
2666 void dump_ir_block_graph_w_types_file(ir_graph *irg, FILE *out)
2669 int rem_dump_const_local;
2670 ir_graph *rem = current_ir_graph;
2672 rem_dump_const_local = dump_const_local;
2673 /* dumping types does not work with local nodes */
2674 dump_const_local = 0;
2676 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2678 /* dump common blocked ir graph */
2679 construct_block_lists(irg);
2681 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2682 ir_node **arr = ird_get_irg_link(get_irp_irg(i));
2684 dump_graph_from_list(out, get_irp_irg(i));
2689 /* dump type info */
2690 current_ir_graph = irg;
2691 type_walk_irg(irg, dump_type_info, NULL, out);
2692 inc_irg_visited(get_const_code_irg());
2694 /* dump edges from graph to type info */
2695 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2697 dump_vcg_footer(out);
2698 dump_const_local = rem_dump_const_local;
2699 current_ir_graph = rem;
2702 void dump_ir_block_graph_w_types(ir_graph *irg, const char *suffix)
2704 do_dump(irg, suffix, "-wtypes-ip", "-wtypes",
2705 dump_ir_block_graph_w_types_file);
2708 /*---------------------------------------------------------------------*/
2709 /* The following routines dump a control flow graph. */
2710 /*---------------------------------------------------------------------*/
2713 dump_block_to_cfg(ir_node *block, void *env) {
2718 if (is_Block(block)) {
2719 /* This is a block. Dump a node for the block. */
2720 fprintf(F, "node: {title: \""); PRINT_NODEID(block);
2721 fprintf(F, "\" label: \"");
2722 if (block == get_irg_start_block(get_irn_irg(block)))
2723 fprintf(F, "Start ");
2724 if (block == get_irg_end_block(get_irn_irg(block)))
2727 fprintf(F, "%s ", get_op_name(get_irn_op(block)));
2728 PRINT_NODEID(block);
2730 fprintf(F, "info1:\"");
2732 /* the generic version. */
2733 dump_irnode_to_file(F, block);
2735 /* Check whether we have bad predecessors to color the block. */
2736 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
2737 if ((fl = is_Bad(get_Block_cfgpred(block, i))))
2740 fprintf(F, "\""); /* closing quote of info */
2742 if ((block == get_irg_start_block(get_irn_irg(block))) ||
2743 (block == get_irg_end_block(get_irn_irg(block))) )
2744 fprintf(F, " color:blue ");
2746 fprintf(F, " color:yellow ");
2749 /* Dump the edges */
2750 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
2751 if (!is_Bad(skip_Proj(get_Block_cfgpred(block, i)))) {
2752 pred = get_nodes_block(skip_Proj(get_Block_cfgpred(block, i)));
2753 fprintf(F, "edge: { sourcename: \"");
2754 PRINT_NODEID(block);
2755 fprintf(F, "\" targetname: \"");
2757 fprintf(F, "\"}\n");
2760 /* Dump dominator/postdominator edge */
2761 if (dump_dominator_information_flag) {
2762 if (get_irg_dom_state(current_ir_graph) == dom_consistent && get_Block_idom(block)) {
2763 pred = get_Block_idom(block);
2764 fprintf(F, "edge: { sourcename: \"");
2765 PRINT_NODEID(block);
2766 fprintf(F, "\" targetname: \"");
2768 fprintf(F, "\" " DOMINATOR_EDGE_ATTR "}\n");
2770 if (get_irg_postdom_state(current_ir_graph) == dom_consistent && get_Block_ipostdom(block)) {
2771 pred = get_Block_ipostdom(block);
2772 fprintf(F, "edge: { sourcename: \"");
2773 PRINT_NODEID(block);
2774 fprintf(F, "\" targetname: \"");
2776 fprintf(F, "\" " POSTDOMINATOR_EDGE_ATTR "}\n");
2782 void dump_cfg(ir_graph *irg, const char *suffix)
2785 /* if a filter is set, dump only the irg's that match the filter */
2786 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2789 f = vcg_open(irg, suffix, "-cfg");
2791 ir_graph *rem = current_ir_graph;
2792 #ifdef INTERPROCEDURAL_VIEW
2793 int ipv = get_interprocedural_view();
2796 current_ir_graph = irg;
2797 dump_vcg_header(f, get_irg_dump_name(irg), NULL, NULL);
2799 #ifdef INTERPROCEDURAL_VIEW
2801 printf("Warning: dumping cfg not in interprocedural view!\n");
2802 set_interprocedural_view(0);
2806 /* walk over the blocks in the graph */
2807 irg_block_walk(get_irg_end(irg), dump_block_to_cfg, NULL, f);
2808 dump_node(f, get_irg_bad(irg));
2810 #ifdef INTERPROCEDURAL_VIEW
2811 set_interprocedural_view(ipv);
2815 current_ir_graph = rem;
2820 static void descend_and_dump(FILE *F, ir_node *n, int depth, pset *mark_set) {
2821 if (pset_find_ptr(mark_set, n))
2824 pset_insert_ptr(mark_set, n);
2827 int i, start = is_Block(n) ? 0 : -1;
2828 dump_whole_node(n, F);
2829 for (i = start; i < get_irn_arity(n); ++i)
2830 descend_and_dump(F, get_irn_n(n, i), depth-1, mark_set);
2833 /* Don't dump edges to nodes further out. These might be edges to
2834 nodes we already dumped, if there is a shorter path to these. */
2838 static int subgraph_counter = 0;
2839 void dump_subgraph(ir_node *root, int depth, const char *suffix) {
2843 sprintf(buf, "-subg_%03d", subgraph_counter++);
2844 F = vcg_open(get_irn_irg(root), suffix, buf);
2846 pset *mark_set = pset_new_ptr(1);
2847 dump_vcg_header(F, get_irg_dump_name(get_irn_irg(root)), NULL, NULL);
2848 descend_and_dump(F, root, depth, mark_set);
2855 void dump_callgraph(const char *suffix) {
2856 FILE *F = vcg_open_name("Callgraph", suffix);
2859 int i, rem = edge_label;
2862 dump_vcg_header(F, "Callgraph", "Hierarchiv", NULL);
2864 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2865 ir_graph *irg = get_irp_irg(i);
2866 ir_entity *ent = get_irg_entity(irg);
2868 int n_callees = get_irg_n_callees(irg);
2870 dump_entity_node(F, ent);
2871 for (j = 0; j < n_callees; ++j) {
2872 ir_entity *c = get_irg_entity(get_irg_callee(irg, j));
2873 //if (id_is_prefix(prefix, get_entity_ld_ident(c))) continue;
2874 int be = is_irg_callee_backedge(irg, j);
2877 "label:\"recursion %d\"" :
2878 "label:\"calls %d\"";
2879 print_ent_ent_edge(F, ent, c, be, ird_color_entity, attr, get_irg_callee_loop_depth(irg, j));
2890 /* Dump all irgs in interprocedural view to a single file. */
2891 void dump_all_cg_block_graph(const char *suffix) {
2892 FILE *f = vcg_open_name("All_graphs", suffix);
2896 int rem_view = get_interprocedural_view();
2898 set_interprocedural_view(1);
2899 dump_vcg_header(f, "All_graphs", NULL);
2901 /* collect nodes in all irgs reachable in call graph*/
2902 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2903 ird_set_irg_link(get_irp_irg(i), NULL);
2905 cg_walk(clear_link, collect_node, NULL);
2907 /* dump all graphs */
2908 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2909 current_ir_graph = get_irp_irg(i);
2910 assert(ird_get_irg_link(current_ir_graph));
2911 dump_graph_from_list(f, current_ir_graph);
2912 DEL_ARR_F(ird_get_irg_link(current_ir_graph));
2917 set_interprocedural_view(rem_view);
2922 /*---------------------------------------------------------------------*/
2923 /* the following routines dumps type information without any ir nodes. */
2924 /*---------------------------------------------------------------------*/
2927 dump_type_graph(ir_graph *irg, const char *suffix)
2931 /* if a filter is set, dump only the irg's that match the filter */
2932 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
2934 f = vcg_open(irg, suffix, "-type");
2936 ir_graph *rem = current_ir_graph;
2937 current_ir_graph = irg;
2939 dump_vcg_header(f, get_irg_dump_name(irg), "Hierarchic", NULL);
2941 /* walk over the blocks in the graph */
2942 type_walk_irg(irg, dump_type_info, NULL, f);
2943 /* The walker for the const code can be called several times for the
2944 same (sub) expression. So that no nodes are dumped several times
2945 we decrease the visited flag of the corresponding graph after each
2946 walk. So now increase it finally. */
2947 inc_irg_visited(get_const_code_irg());
2951 current_ir_graph = rem;
2956 dump_all_types(const char *suffix)
2958 FILE *f = vcg_open_name("All_types", suffix);
2960 dump_vcg_header(f, "All_types", "Hierarchic", NULL);
2961 type_walk(dump_type_info, NULL, f);
2962 inc_irg_visited(get_const_code_irg());
2970 dump_class_hierarchy(int entities, const char *suffix)
2972 FILE *f = vcg_open_name("class_hierarchy", suffix);
2977 env.dump_ent = entities;
2978 dump_vcg_header(f, "class_hierarchy", "Hierarchic", NULL);
2979 type_walk(dump_class_hierarchy_node, NULL, &env);
2986 /*---------------------------------------------------------------------*/
2987 /* dumps all graphs with the graph-dumper passed. Possible dumpers: */
2989 /* dump_ir_block_graph */
2991 /* dump_type_graph */
2992 /* dump_ir_graph_w_types */
2993 /*---------------------------------------------------------------------*/
2995 void dump_all_ir_graphs(dump_graph_func *dmp_grph, const char *suffix) {
2997 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2998 dmp_grph(get_irp_irg(i), suffix);
3002 ir_prog_pass_t pass;
3003 dump_graph_func *dump_graph;
3008 * Wrapper around dump_all_ir_graphs().
3010 static int dump_all_ir_graphs_wrapper(ir_prog *irp, void *context) {
3011 struct pass_t *pass = context;
3014 dump_all_ir_graphs(pass->dump_graph, pass->suffix);
3018 ir_prog_pass_t *dump_all_ir_graph_pass(
3019 const char *name, dump_graph_func *dump_graph, const char *suffix) {
3020 size_t len = strlen(suffix);
3021 struct pass_t *pass = xmalloc(sizeof(*pass) + len);
3022 ir_prog_pass_t *res = def_prog_pass_constructor(
3023 &pass->pass, name ? name : "dump_all_graphs", dump_all_ir_graphs_wrapper);
3025 /* this pass does not change anything, so neither dump nor verify is needed. */
3026 res->dump_irprog = ir_prog_no_dump;
3027 res->verify_irprog = ir_prog_no_verify;
3029 pass->dump_graph = dump_graph;
3030 strcpy(pass->suffix, suffix);
3035 /*--------------------------------------------------------------------------------*
3036 * Dumps a stand alone loop graph with firm nodes which belong to one loop node *
3037 * packed together in one subgraph/box *
3038 *--------------------------------------------------------------------------------*/
3040 void dump_loops_standalone(FILE *F, ir_loop *loop) {
3041 int i = 0, loop_node_started = 0, son_number = 0, first = 0;
3043 ir_loop *son = NULL;
3045 /* Dump a new loop node. */
3046 dump_loop_node(F, loop);
3048 /* Dump the loop elements. */
3049 for (i = 0; i < get_loop_n_elements(loop); i++) {
3050 le = get_loop_element(loop, i);
3052 if (get_kind(son) == k_ir_loop) {
3054 /* We are a loop son -> Recurse */
3056 if (loop_node_started) { /* Close the "firm-nodes" node first if we started one. */
3057 fprintf(F, "\" }\n");
3058 fprintf(F, "edge: {sourcename: \"");
3060 fprintf(F, "\" targetname: \"");
3062 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3063 loop_node_started = 0;
3065 dump_loop_son_edge(F, loop, son_number++);
3066 dump_loops_standalone(F, son);
3067 } else if (get_kind(son) == k_ir_node) {
3068 /* We are a loop node -> Collect firm nodes */
3070 ir_node *n = le.node;
3073 if (!loop_node_started) {
3074 /* Start a new node which contains all firm nodes of the current loop */
3075 fprintf(F, "node: { title: \"");
3077 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3078 loop_node_started = 1;
3083 bad |= dump_node_label(F, n);
3084 /* Causes indeterministic output: if (is_Block(n)) fprintf(F, "\t ->%d", (int)get_irn_link(n)); */
3085 if (has_backedges(n)) fprintf(F, "\t loop head!");
3086 } else { /* for callgraph loop tree */
3088 assert(get_kind(son) == k_ir_graph);
3090 /* We are a loop node -> Collect firm graphs */
3092 if (!loop_node_started) {
3093 /* Start a new node which contains all firm nodes of the current loop */
3094 fprintf(F, "node: { title: \"");
3096 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3097 loop_node_started = 1;
3101 fprintf(F, " %s", get_irg_dump_name(n));
3102 /* fprintf(F, " %s (depth %d)", get_irg_dump_name(n), n->callgraph_weighted_loop_depth); */
3106 if (loop_node_started) {
3107 fprintf(F, "\" }\n");
3108 fprintf(F, "edge: {sourcename: \"");
3110 fprintf(F, "\" targetname: \"");
3112 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3113 loop_node_started = 0;
3117 void dump_loop_tree(ir_graph *irg, const char *suffix)
3121 /* if a filter is set, dump only the irg's that match the filter */
3122 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
3125 f = vcg_open(irg, suffix, "-looptree");
3127 ir_graph *rem = current_ir_graph;
3128 int el_rem = edge_label;
3130 current_ir_graph = irg;
3133 dump_vcg_header(f, get_irg_dump_name(irg), "Tree", "top_to_bottom");
3135 if (get_irg_loop(irg))
3136 dump_loops_standalone(f, get_irg_loop(irg));
3141 edge_label = el_rem;
3142 current_ir_graph = rem;
3146 void dump_callgraph_loop_tree(const char *suffix) {
3148 F = vcg_open_name("Callgraph_looptree", suffix);
3149 dump_vcg_header(F, "callgraph looptree", "Tree", "top_to_bottom");
3150 dump_loops_standalone(F, irp->outermost_cg_loop);
3156 /*----------------------------------------------------------------------------*/
3157 /* Dumps the firm nodes in the loop tree to a graph along with the loop nodes.*/
3158 /*----------------------------------------------------------------------------*/
3160 void collect_nodeloop(FILE *F, ir_loop *loop, eset *loopnodes) {
3161 int i, son_number = 0, node_number = 0;
3163 if (dump_loop_information_flag) dump_loop_node(F, loop);
3165 for (i = 0; i < get_loop_n_elements(loop); i++) {
3166 loop_element le = get_loop_element(loop, i);
3167 if (*(le.kind) == k_ir_loop) {
3168 if (dump_loop_information_flag) dump_loop_son_edge(F, loop, son_number++);
3170 collect_nodeloop(F, le.son, loopnodes);
3172 if (dump_loop_information_flag) dump_loop_node_edge(F, loop, node_number++);
3173 eset_insert(loopnodes, le.node);
3178 void collect_nodeloop_external_nodes(ir_loop *loop, eset *loopnodes, eset *extnodes) {
3181 for(i = 0; i < get_loop_n_elements(loop); i++) {
3182 loop_element le = get_loop_element(loop, i);
3183 if (*(le.kind) == k_ir_loop) {
3185 collect_nodeloop_external_nodes(le.son, loopnodes, extnodes);
3187 if (is_Block(le.node)) start = 0; else start = -1;
3188 for (j = start; j < get_irn_arity(le.node); j++) {
3189 ir_node *pred = get_irn_n(le.node, j);
3190 if (!eset_contains(loopnodes, pred)) {
3191 eset_insert(extnodes, pred);
3192 if (!is_Block(pred)) {
3193 pred = get_nodes_block(pred);
3194 if (!eset_contains(loopnodes, pred)) eset_insert(extnodes, pred);
3202 void dump_loop(ir_loop *l, const char *suffix) {
3206 snprintf(name, sizeof(name), "loop_%d", get_loop_loop_nr(l));
3207 F = vcg_open_name(name, suffix);
3209 eset *loopnodes = eset_create();
3210 eset *extnodes = eset_create();
3213 dump_vcg_header(F, name, NULL, NULL);
3215 /* collect all nodes to dump */
3216 collect_nodeloop(F, l, loopnodes);
3217 collect_nodeloop_external_nodes(l, loopnodes, extnodes);
3219 /* build block lists */
3220 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes))
3221 set_irn_link(n, NULL);
3222 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes))
3223 set_irn_link(n, NULL);
3224 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes)) {
3226 b = get_nodes_block(n);
3227 set_irn_link(n, get_irn_link(b));
3231 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes)) {
3233 b = get_nodes_block(n);
3234 set_irn_link(n, get_irn_link(b));
3239 for (b = eset_first(loopnodes); b != NULL; b = eset_next(loopnodes)) {
3241 fprintf(F, "graph: { title: \"");
3243 fprintf(F, "\" label: \"");
3244 dump_node_opcode(F, b);
3245 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3246 fprintf(F, "\" status:clustered color:yellow\n");
3248 /* dump the blocks edges */
3249 dump_ir_data_edges(F, b);
3251 /* dump the nodes that go into the block */
3252 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3253 if (eset_contains(extnodes, n))
3254 overrule_nodecolor = ird_color_block_inout;
3256 overrule_nodecolor = ird_color_default_node;
3257 if (!eset_contains(extnodes, n)) dump_ir_data_edges(F, n);
3260 /* Close the vcg information for the block */
3262 dump_const_node_local(F, b);
3266 for (b = eset_first(extnodes); b != NULL; b = eset_next(extnodes)) {
3268 fprintf(F, "graph: { title: \"");
3270 fprintf(F, "\" label: \"");
3271 dump_node_opcode(F, b);
3272 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3273 fprintf(F, "\" status:clustered color:lightblue\n");
3275 /* dump the nodes that go into the block */
3276 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3277 if (!eset_contains(loopnodes, n))
3278 overrule_nodecolor = ird_color_block_inout;
3280 overrule_nodecolor = ird_color_default_node;
3281 if (eset_contains(loopnodes, n)) dump_ir_data_edges(F, n);
3284 /* Close the vcg information for the block */
3286 dump_const_node_local(F, b);
3290 eset_destroy(loopnodes);
3291 eset_destroy(extnodes);