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
38 #include "firm_common_t.h"
43 #include "irgraph_t.h"
56 #include "callgraph.h"
57 #include "irextbb_t.h"
59 #include "dbginfo_t.h"
72 extern void dump_irn_chi_term(FILE *FL, ir_node *n);
73 extern void dump_irn_state(FILE *FL, ir_node *n);
74 extern int get_opt_dump_abstvals(void);
75 typedef unsigned long SeqNo;
76 extern SeqNo get_Block_seqno(ir_node *n);
79 /** Dump only irgs with names that start with this prefix. */
80 static ident *dump_file_filter_id = NULL;
82 #define ERROR_TXT "<ERROR>"
84 /*******************************************************************/
85 /* flags to steer output */
86 /*******************************************************************/
88 /** An option to turn off edge labels */
89 static int edge_label = 1;
90 /** An option to turn off dumping values of constant entities */
91 static int const_entities = 1;
92 /** An option to dump the keep alive edges */
93 static int dump_keepalive = 1;
94 /** An option to dump the new out edges */
95 static int dump_new_edges_flag = 0;
96 /** An option to dump ld_names instead of names. */
97 static int dump_ld_name = 1;
98 /** Compiler options to dump analysis information in dump_ir_graph */
99 static int dump_out_edge_flag = 0;
100 static int dump_loop_information_flag = 0;
101 static int dump_backedge_information_flag = 1;
102 /** An option to dump const-like nodes locally. */
103 static int dump_const_local = 1;
104 /** An option to dump the node index number. */
105 static int dump_node_idx_labels = 0;
106 /** An option to dump all graph anchors */
107 static int dump_anchors = 0;
108 /** An option to dump the macro block edges. */
109 static int dump_macro_block_edges = 0;
110 /** An option to dump block marker in the block title */
111 static int dump_block_marker = 0;
113 int dump_dominator_information_flag = 0;
114 int opt_dump_analysed_type_info = 1;
115 int opt_dump_pointer_values_to_info = 0; /* default off: for test compares!! */
117 static ird_color_t overrule_nodecolor = ird_color_default_node;
119 /** The vcg node attribute hook. */
120 static DUMP_IR_GRAPH_FUNC dump_ir_graph_hook = NULL;
121 /** The vcg node attribute hook. */
122 static DUMP_NODE_VCGATTR_FUNC dump_node_vcgattr_hook = NULL;
123 /** The vcg edge attribute hook. */
124 static DUMP_EDGE_VCGATTR_FUNC dump_edge_vcgattr_hook = NULL;
125 /** The vcg dump block edge hook */
126 static DUMP_NODE_EDGE_FUNC dump_block_edge_hook = NULL;
127 /** The vcg dump node edge hook. */
128 static DUMP_NODE_EDGE_FUNC dump_node_edge_hook = NULL;
130 /* Set the hook to be called to dump additional edges to a node. */
131 void set_dump_node_edge_hook(DUMP_NODE_EDGE_FUNC func) {
132 dump_node_edge_hook = func;
135 /* Get the additional edge dump hook. */
136 DUMP_NODE_EDGE_FUNC get_dump_node_edge_hook(void) {
137 return dump_node_edge_hook;
140 /* Set the hook to be called to dump additional edges to a block. */
141 void set_dump_block_edge_hook(DUMP_NODE_EDGE_FUNC func) {
142 dump_block_edge_hook = func;
145 /* Get the additional block edge dump hook. */
146 DUMP_NODE_EDGE_FUNC get_dump_block_edge_hook(void) {
147 return dump_node_edge_hook;
150 /* set the ir graph hook */
151 void set_dump_ir_graph_hook(DUMP_IR_GRAPH_FUNC hook) {
152 dump_ir_graph_hook = hook;
155 /* set the node attribute hook */
156 void set_dump_node_vcgattr_hook(DUMP_NODE_VCGATTR_FUNC hook) {
157 dump_node_vcgattr_hook = hook;
160 /* set the edge attribute hook */
161 void set_dump_edge_vcgattr_hook(DUMP_EDGE_VCGATTR_FUNC hook) {
162 dump_edge_vcgattr_hook = hook;
165 /** Returns 0 if dump_out_edge_flag or dump_loop_information_flag
166 * are set, else returns dump_const_local_flag.
168 static int get_opt_dump_const_local(void) {
169 if (dump_out_edge_flag || dump_loop_information_flag || (dump_new_edges_flag && edges_activated(current_ir_graph)))
171 return dump_const_local;
174 /* Set a prefix filter for output functions. */
175 void only_dump_method_with_name(ident *name) {
176 dump_file_filter_id = name;
179 /* Returns the prefix filter set with only_dump_method_with_name(). */
180 ident *get_dump_file_filter_ident(void) {
181 return dump_file_filter_id;
184 /* Returns non-zero if dump file filter is not set, or if it is a prefix of name. */
185 int is_filtered_dump_name(ident *name) {
186 if (!dump_file_filter_id) return 1;
187 return id_is_prefix(dump_file_filter_id, name);
190 /* To turn off display of edge labels. Edge labels often cause xvcg to
191 abort with a segmentation fault. */
192 void turn_off_edge_labels(void) {
196 void dump_consts_local(int flag) {
197 dump_const_local = flag;
200 void dump_node_idx_label(int flag) {
201 dump_node_idx_labels = flag;
204 void dump_constant_entity_values(int flag) {
205 const_entities = flag;
208 void dump_keepalive_edges(int flag) {
209 dump_keepalive = flag;
212 void dump_new_edges(int flag) {
213 dump_new_edges_flag = flag;
216 int get_opt_dump_keepalive_edges(void) {
217 return dump_keepalive;
220 void dump_out_edges(int flag) {
221 dump_out_edge_flag = flag;
224 void dump_dominator_information(int flag) {
225 dump_dominator_information_flag = flag;
228 void dump_loop_information(int flag) {
229 dump_loop_information_flag = flag;
232 void dump_backedge_information(int flag) {
233 dump_backedge_information_flag = flag;
236 /* Dump the information of type field specified in ana/irtypeinfo.h.
237 * If the flag is set, the type name is output in [] in the node label,
238 * else it is output as info.
240 void set_opt_dump_analysed_type_info(int flag) {
241 opt_dump_analysed_type_info = flag;
244 void dump_pointer_values_to_info(int flag) {
245 opt_dump_pointer_values_to_info = flag;
248 void dump_ld_names(int flag) {
252 void dump_all_anchors(int flag) {
256 void dump_macroblock_edges(int flag) {
257 dump_macro_block_edges = flag;
260 void dump_block_marker_in_title(int flag) {
261 dump_block_marker = flag;
264 /* -------------- some extended helper functions ----------------- */
267 * returns the name of a mode or ERROR_TXT if mode is NOT a mode object.
268 * in the later case, sets bad.
270 const char *get_mode_name_ex(ir_mode *mode, int *bad) {
272 return get_mode_name(mode);
278 * returns the name of a type or <ERROR> if mode is NOT a mode object.
279 * in the later case, sets bad
281 const char *get_type_name_ex(ir_type *tp, int *bad) {
283 return get_type_name(tp);
288 #define CUSTOM_COLOR_BASE 100
289 static const char *color_names[ird_color_count];
290 static const char *color_rgb[ird_color_count];
291 static struct obstack color_obst;
293 static void custom_color(int num, const char *rgb_def)
295 assert(num < ird_color_count);
296 obstack_printf(&color_obst, "%d", CUSTOM_COLOR_BASE + num);
297 obstack_1grow(&color_obst, '\0');
299 color_rgb[num] = rgb_def;
300 color_names[num] = obstack_finish(&color_obst);
303 static void named_color(int num, const char *name)
305 assert(num < ird_color_count);
306 color_rgb[num] = NULL;
307 color_names[num] = name;
310 static void init_colors(void)
312 static int initialized = 0;
316 obstack_init(&color_obst);
318 custom_color(ird_color_prog_background, "204 204 204");
319 custom_color(ird_color_block_background, "255 255 0");
320 custom_color(ird_color_dead_block_background, "190 150 150");
321 named_color(ird_color_block_inout, "lightblue");
322 named_color(ird_color_default_node, "white");
323 custom_color(ird_color_memory, "153 153 255");
324 custom_color(ird_color_controlflow, "255 153 153");
325 custom_color(ird_color_const, "204 255 255");
326 custom_color(ird_color_proj, "255 255 153");
327 custom_color(ird_color_uses_memory, "153 153 255");
328 custom_color(ird_color_phi, "105 255 105");
329 custom_color(ird_color_anchor, "100 100 255");
330 named_color(ird_color_error, "red");
336 * Prints the VCG color to a file.
338 static void print_vcg_color(FILE *F, ird_color_t color) {
339 assert(color < ird_color_count);
340 fprintf(F, "color:%s", color_names[color]);
344 * Prints the edge from a type S to a type T with additional info fmt, ...
347 static void print_type_type_edge(FILE *F, ir_type *S, ir_type *T, const char *fmt, ...)
352 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(S);
353 fprintf(F, " targetname: "); PRINT_TYPEID(T);
354 vfprintf(F, fmt, ap);
360 * Prints the edge from a type T to an entity E with additional info fmt, ...
363 static void print_type_ent_edge(FILE *F, ir_type *T, ir_entity *E, const char *fmt, ...)
368 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(T);
369 fprintf(F, " targetname: \""); PRINT_ENTID(E); fprintf(F, "\"");
370 vfprintf(F, fmt, ap);
376 * Prints the edge from an entity E to an entity T with additional info fmt, ...
379 static void print_ent_ent_edge(FILE *F, ir_entity *E, ir_entity *T, int backedge, const char *fmt, ...)
385 fprintf(F, "backedge: { sourcename: \"");
387 fprintf(F, "edge: { sourcename: \"");
389 fprintf(F, "\" targetname: \""); PRINT_ENTID(T); fprintf(F, "\"");
390 vfprintf(F, fmt, ap);
396 * Prints the edge from an entity E to a type T with additional info fmt, ...
399 static void print_ent_type_edge(FILE *F, ir_entity *E, ir_type *T, const char *fmt, ...)
404 fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(E);
405 fprintf(F, "\" targetname: "); PRINT_TYPEID(T);
406 vfprintf(F, fmt, ap);
412 * Prints the edge from a node N to a type T with additional info fmt, ...
415 static void print_node_type_edge(FILE *F, const ir_node *N, ir_type *T, const char *fmt, ...)
420 fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(N);
421 fprintf(F, "\" targetname: "); PRINT_TYPEID(T);
422 vfprintf(F, fmt, ap);
428 * Prints the edge from a node N to an entity E with additional info fmt, ...
431 static void print_node_ent_edge(FILE *F, const ir_node *N, ir_entity *E, const char *fmt, ...)
436 fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(N);
437 fprintf(F, "\" targetname: \""); PRINT_ENTID(E);
439 vfprintf(F, fmt, ap);
445 * Prints the edge from an entity E to a node N with additional info fmt, ...
448 static void print_ent_node_edge(FILE *F, ir_entity *E, const ir_node *N, const char *fmt, ...)
453 fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(E);
454 fprintf(F, "\" targetname: \""); PRINT_NODEID(N); fprintf(F, "\"");
455 vfprintf(F, fmt, ap);
461 * Prints the edge from a type E to an enumeration item item with additional info fmt, ...
464 static void print_enum_item_edge(FILE *F, ir_type *E, int item, const char *fmt, ...)
469 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(E);
470 fprintf(F, " targetname: \""); PRINT_ITEMID(E, item); fprintf(F, "\" ");
471 vfprintf(F, fmt, ap);
476 /*-----------------------------------------------------------------*/
477 /* global and ahead declarations */
478 /*-----------------------------------------------------------------*/
480 static void dump_whole_node(ir_node *n, void *env);
481 static INLINE void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg);
483 /*-----------------------------------------------------------------*/
484 /* Helper functions. */
485 /*-----------------------------------------------------------------*/
488 * This map is used as a private link attr to be able to call dumper
489 * anywhere without destroying link fields.
491 static pmap *irdump_link_map = NULL;
493 /** NOT A STANDARD LIBFIRM INIT METHOD
495 * We do not want to integrate dumping into libfirm, i.e., if the dumpers
496 * are off, we want to have as few interferences as possible. Therefore the
497 * initialization is performed lazily and not called from within init_firm.
499 * Creates the link attribute map. */
500 static void init_irdump(void) {
501 /* We need a new, empty map. */
502 if (irdump_link_map) pmap_destroy(irdump_link_map);
503 irdump_link_map = pmap_create();
504 if (!dump_file_filter_id)
505 dump_file_filter_id = new_id_from_str("");
509 * Returns the private link field.
511 static void *ird_get_irn_link(ir_node *n) {
513 if (!irdump_link_map) return NULL;
515 if (pmap_contains(irdump_link_map, (void *)n))
516 res = pmap_get(irdump_link_map, (void *)n);
521 * Sets the private link field.
523 static void ird_set_irn_link(ir_node *n, void *x) {
524 if (!irdump_link_map)
526 pmap_insert(irdump_link_map, (void *)n, x);
530 * Gets the private link field of an irg.
532 static void *ird_get_irg_link(ir_graph *irg) {
534 if (!irdump_link_map) return NULL;
536 if (pmap_contains(irdump_link_map, (void *)irg))
537 res = pmap_get(irdump_link_map, (void *)irg);
542 * Sets the private link field of an irg.
544 static void ird_set_irg_link(ir_graph *irg, void *x) {
545 if (!irdump_link_map) init_irdump();
546 pmap_insert(irdump_link_map, (void *)irg, x);
550 * Walker, clears the private link field.
552 static void clear_link(ir_node * node, void * env) {
554 ird_set_irn_link(node, NULL);
558 * If the entity has a ld_name, returns it if the dump_ld_name is set,
559 * else returns the name of the entity.
561 static const char *_get_ent_dump_name(ir_entity *ent, int dump_ld_name) {
563 return "<NULL entity>";
565 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
566 if (ent->ld_name) return get_id_str(ent->ld_name);
568 return get_id_str(ent->name);
572 * If the entity has a ld_name, returns it if the option dump_ld_name is set,
573 * else returns the name of the entity.
575 const char *get_ent_dump_name(ir_entity *ent) {
576 return _get_ent_dump_name(ent, dump_ld_name);
579 /* Returns the name of an IRG. */
580 const char *get_irg_dump_name(ir_graph *irg) {
581 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
582 return _get_ent_dump_name(get_irg_entity(irg), 1);
586 * Returns non-zero if a node is in floating state.
588 static int node_floats(ir_node *n) {
589 return ((get_irn_pinned(n) == op_pin_state_floats) &&
590 (get_irg_pinned(current_ir_graph) == op_pin_state_floats));
594 * Walker that visits the anchors
596 static void ird_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env) {
597 if (dump_anchors || (dump_new_edges_flag && edges_activated(irg))) {
598 irg_walk_anchors(irg, pre, post, env);
600 irg_walk_graph(irg, pre, post, env);
605 * Walker, allocates an array for all blocks and puts it's nodes non-floating nodes into this array.
607 static void collect_node(ir_node * node, void *env) {
611 || (get_op_flags(get_irn_op(node)) & irop_flag_dump_noblock)) {
612 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
613 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
614 ARR_APP1(ir_node *, arr, node);
615 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
617 ir_node * block = get_nodes_block(node);
620 /* this node is in a Bad block, so we must place it into the graph's list */
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 ird_set_irn_link(node, ird_get_irn_link(block));
627 ird_set_irn_link(block, node);
632 /** Construct lists to walk ir block-wise.
634 * Collects all blocks, nodes not op_pin_state_pinned,
635 * Bad, NoMem and Unknown into a flexible array in link field of
636 * irg they belong to. Sets the irg link field to NULL in all
637 * graphs not visited.
638 * Free the list with DEL_ARR_F().
640 static ir_node **construct_block_lists(ir_graph *irg) {
642 #ifdef INTERPROCEDURAL_VIEW
643 int rem_view = get_interprocedural_view();
645 int walk_flag = using_irn_visited(irg);
646 ir_graph *rem = current_ir_graph;
648 current_ir_graph = irg;
651 clear_using_irn_visited(current_ir_graph);
653 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
654 ird_set_irg_link(get_irp_irg(i), NULL);
656 ird_walk_graph(current_ir_graph, clear_link, collect_node, current_ir_graph);
658 #ifdef INTERPROCEDURAL_VIEW
659 /* Collect also EndReg and EndExcept. We do not want to change the walker. */
660 set_interprocedural_view(0);
663 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
664 irg_walk(get_irg_end_reg(current_ir_graph), clear_link, collect_node, current_ir_graph);
665 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
666 irg_walk(get_irg_end_except(current_ir_graph), clear_link, collect_node, current_ir_graph);
668 #ifdef INTERPROCEDURAL_VIEW
669 set_interprocedural_view(rem_view);
673 set_using_irn_visited(current_ir_graph);
675 current_ir_graph = rem;
676 return ird_get_irg_link(irg);
679 typedef struct _list_tuple {
681 ir_extblk **extbb_list;
684 /** Construct lists to walk IR extended block-wise.
685 * Free the lists in the tuple with DEL_ARR_F().
686 * Sets the irg link field to NULL in all
687 * graphs not visited.
689 static list_tuple *construct_extblock_lists(ir_graph *irg) {
690 ir_node **blk_list = construct_block_lists(irg);
692 ir_graph *rem = current_ir_graph;
693 list_tuple *lists = xmalloc(sizeof(*lists));
695 current_ir_graph = irg;
697 lists->blk_list = NEW_ARR_F(ir_node *, 0);
698 lists->extbb_list = NEW_ARR_F(ir_extblk *, 0);
700 inc_irg_block_visited(irg);
701 for (i = ARR_LEN(blk_list) - 1; i >= 0; --i) {
704 if (is_Block(blk_list[i])) {
705 ext = get_Block_extbb(blk_list[i]);
707 if (extbb_not_visited(ext)) {
708 ARR_APP1(ir_extblk *, lists->extbb_list, ext);
709 mark_extbb_visited(ext);
712 ARR_APP1(ir_node *, lists->blk_list, blk_list[i]);
716 current_ir_graph = rem;
717 ird_set_irg_link(irg, lists);
721 /*-----------------------------------------------------------------*/
722 /* Routines to dump information about a single ir node. */
723 /*-----------------------------------------------------------------*/
726 * dump the name of a node n to the File F.
728 int dump_node_opcode(FILE *F, ir_node *n)
731 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
733 /* call the dump_node operation if available */
735 return ops->dump_node(n, F, dump_node_opcode_txt);
737 /* implementation for default nodes */
738 switch (get_irn_opcode(n)) {
741 ir_fprintf(F, "%T", get_Const_tarval(n));
745 switch (get_SymConst_kind(n)) {
746 case symconst_addr_name:
747 /* don't use get_SymConst_ptr_info as it mangles the name. */
748 fprintf(F, "SymC %s", get_id_str(get_SymConst_name(n)));
750 case symconst_addr_ent:
751 fprintf(F, "SymC &%s", get_entity_name(get_SymConst_entity(n)));
753 case symconst_ofs_ent:
754 fprintf(F, "SymC %s offset", get_entity_name(get_SymConst_entity(n)));
756 case symconst_type_tag:
757 fprintf(F, "SymC %s tag", get_type_name_ex(get_SymConst_type(n), &bad));
759 case symconst_type_size:
760 fprintf(F, "SymC %s size", get_type_name_ex(get_SymConst_type(n), &bad));
762 case symconst_type_align:
763 fprintf(F, "SymC %s align", get_type_name_ex(get_SymConst_type(n), &bad));
765 case symconst_enum_const:
766 fprintf(F, "SymC %s enum", get_enumeration_name(get_SymConst_enum(n)));
769 fprintf(F, "SymC %lu label", get_SymConst_label(n));
775 if (!get_interprocedural_view())
782 ir_node *pred = get_Proj_pred(n);
784 if (get_irn_opcode(pred) == iro_Cond
785 && get_Proj_proj(n) == get_Cond_defaultProj(pred)
786 && get_irn_mode(get_Cond_selector(pred)) != mode_b)
787 fprintf(F, "defProj");
795 if (get_interprocedural_view()) {
796 fprintf(F, "%s %s", get_irn_opname(n), get_ent_dump_name(get_irg_entity(get_irn_irg(n))));
801 case iro_CallBegin: {
802 ir_node *addr = get_CallBegin_ptr(n);
803 ir_entity *ent = NULL;
804 if (get_irn_op(addr) == op_Sel)
805 ent = get_Sel_entity(addr);
806 else if (is_Global(addr))
807 ent = get_Global_entity(addr);
808 fprintf(F, "%s", get_irn_opname(n));
809 if (ent) fprintf(F, " %s", get_entity_name(ent));
813 if (get_Load_align(n) == align_non_aligned)
815 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Load_mode(n), &bad));
818 if (get_Store_align(n) == align_non_aligned)
820 fprintf(F, "%s", get_irn_opname(n));
824 is_Block_dead(n) ? "Dead " : "", get_irn_opname(n),
825 dump_block_marker ? (get_Block_mark(n) ? "*" : "") : "");
828 if (get_Conv_strict(n))
829 fprintf(F, "strict");
830 fprintf(F, "%s", get_irn_opname(n));
833 fprintf(F, "%s", get_irn_opname(n));
834 if (is_Div_remainderless(n))
836 fprintf(F, "[%s]", get_mode_name_ex(get_Div_resmode(n), &bad));
839 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Mod_resmode(n), &bad));
842 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_DivMod_resmode(n), &bad));
847 fprintf(F, "%s", get_irn_opname(n));
854 * Dump the mode of a node n to a file F.
855 * Ignore modes that are "always known".
857 static int dump_node_mode(FILE *F, ir_node *n)
860 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
863 /* call the dump_node operation if available */
865 return ops->dump_node(n, F, dump_node_mode_txt);
867 /* default implementation */
868 iro = get_irn_opcode(n);
880 ir_mode *mode = get_irn_mode(n);
882 if (mode && mode != mode_BB && mode != mode_ANY && mode != mode_BAD &&
883 (mode != mode_T || iro == iro_Proj))
884 fprintf(F, "%s", get_mode_name_ex(mode, &bad));
892 * Dump the type of a node n to a file F if it's known.
894 static int dump_node_typeinfo(FILE *F, ir_node *n) {
897 if (opt_dump_analysed_type_info) {
898 if (get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_consistent ||
899 get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_inconsistent) {
900 ir_type *tp = get_irn_typeinfo_type(n);
901 if (tp != firm_none_type)
902 fprintf(F, "[%s] ", get_type_name_ex(tp, &bad));
910 typedef struct _pns_lookup {
911 long nr; /**< the proj number */
912 const char *name; /**< the name of the Proj */
915 typedef struct _proj_lookup {
916 ir_opcode code; /**< the opcode of the Proj predecessor */
917 unsigned num_data; /**< number of data entries */
918 const pns_lookup_t *data; /**< the data */
921 #define ARR_SIZE(a) (sizeof(a)/sizeof(a[0]))
923 /** the lookup table for Proj(Start) names */
924 static const pns_lookup_t start_lut[] = {
925 #define X(a) { pn_Start_##a, #a }
934 /** the lookup table for Proj(Cond) names */
935 static const pns_lookup_t cond_lut[] = {
936 #define X(a) { pn_Cond_##a, #a }
942 /** the lookup table for Proj(Call) names */
943 static const pns_lookup_t call_lut[] = {
944 #define X(a) { pn_Call_##a, #a }
954 /** the lookup table for Proj(Quot) names */
955 static const pns_lookup_t quot_lut[] = {
956 #define X(a) { pn_Quot_##a, #a }
964 /** the lookup table for Proj(DivMod) names */
965 static const pns_lookup_t divmod_lut[] = {
966 #define X(a) { pn_DivMod_##a, #a }
975 /** the lookup table for Proj(Div) names */
976 static const pns_lookup_t div_lut[] = {
977 #define X(a) { pn_Div_##a, #a }
985 /** the lookup table for Proj(Mod) names */
986 static const pns_lookup_t mod_lut[] = {
987 #define X(a) { pn_Mod_##a, #a }
995 /** the lookup table for Proj(Load) names */
996 static const pns_lookup_t load_lut[] = {
997 #define X(a) { pn_Load_##a, #a }
1005 /** the lookup table for Proj(Store) names */
1006 static const pns_lookup_t store_lut[] = {
1007 #define X(a) { pn_Store_##a, #a }
1014 /** the lookup table for Proj(Alloc) names */
1015 static const pns_lookup_t alloc_lut[] = {
1016 #define X(a) { pn_Alloc_##a, #a }
1024 /** the lookup table for Proj(CopyB) names */
1025 static const pns_lookup_t copyb_lut[] = {
1026 #define X(a) { pn_CopyB_##a, #a }
1034 /** the lookup table for Proj(InstOf) names */
1035 static const pns_lookup_t instof_lut[] = {
1036 #define X(a) { pn_InstOf_##a, #a }
1045 /** the lookup table for Proj(Raise) names */
1046 static const pns_lookup_t raise_lut[] = {
1047 #define X(a) { pn_Raise_##a, #a }
1053 /** the lookup table for Proj(Bound) names */
1054 static const pns_lookup_t bound_lut[] = {
1055 #define X(a) { pn_Bound_##a, #a }
1063 /** the Proj lookup table */
1064 static const proj_lookup_t proj_lut[] = {
1065 #define E(a) ARR_SIZE(a), a
1066 { iro_Start, E(start_lut) },
1067 { iro_Cond, E(cond_lut) },
1068 { iro_Call, E(call_lut) },
1069 { iro_Quot, E(quot_lut) },
1070 { iro_DivMod, E(divmod_lut) },
1071 { iro_Div, E(div_lut) },
1072 { iro_Mod, E(mod_lut) },
1073 { iro_Load, E(load_lut) },
1074 { iro_Store, E(store_lut) },
1075 { iro_Alloc, E(alloc_lut) },
1076 { iro_CopyB, E(copyb_lut) },
1077 { iro_InstOf, E(instof_lut) },
1078 { iro_Raise, E(raise_lut) },
1079 { iro_Bound, E(bound_lut) }
1084 * Dump additional node attributes of some nodes to a file F.
1087 dump_node_nodeattr(FILE *F, ir_node *n)
1093 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1095 /* call the dump_node operation if available */
1097 return ops->dump_node(n, F, dump_node_nodeattr_txt);
1099 switch (get_irn_opcode(n)) {
1101 if (0 && get_interprocedural_view()) {
1102 fprintf(F, "%s ", get_ent_dump_name(get_irg_entity(current_ir_graph)));
1107 pred = get_Proj_pred(n);
1108 proj_nr = get_Proj_proj(n);
1110 code = get_irn_opcode(pred);
1112 if (code == iro_Cmp)
1113 fprintf(F, "%s ", get_pnc_string(get_Proj_proj(n)));
1114 else if (code == iro_Proj && get_irn_opcode(get_Proj_pred(pred)) == iro_Start)
1115 fprintf(F, "Arg %ld ", proj_nr);
1116 else if (code == iro_Cond && get_irn_mode(get_Cond_selector(pred)) != mode_b)
1117 fprintf(F, "%ld ", proj_nr);
1119 unsigned i, j, f = 0;
1121 for (i = 0; i < ARR_SIZE(proj_lut); ++i) {
1122 if (code == proj_lut[i].code) {
1123 for (j = 0; j < proj_lut[i].num_data; ++j) {
1124 if (proj_nr == proj_lut[i].data[j].nr) {
1125 fprintf(F, "%s ", proj_lut[i].data[j].name);
1134 fprintf(F, "%ld ", proj_nr);
1135 if (code == iro_Cond && get_Cond_jmp_pred(pred) != COND_JMP_PRED_NONE) {
1136 if (proj_nr == pn_Cond_false && get_Cond_jmp_pred(pred) == COND_JMP_PRED_FALSE)
1137 fprintf(F, "PRED ");
1138 if (proj_nr == pn_Cond_true && get_Cond_jmp_pred(pred) == COND_JMP_PRED_TRUE)
1139 fprintf(F, "PRED ");
1144 proj_nr = get_Filter_proj(n);
1145 if (! get_interprocedural_view()) {
1147 pred = get_Filter_pred(n);
1150 fprintf(F, "%ld ", proj_nr);
1153 fprintf(F, "%s ", get_ent_dump_name(get_Sel_entity(n)));
1156 fprintf(F, "(%s) ", get_type_name_ex(get_Cast_type(n), &bad));
1159 fprintf(F, "%s ", get_pnc_string(get_Confirm_cmp(n)));
1162 fprintf(F, "(%s) ", get_type_name_ex(get_CopyB_type(n), &bad));
1173 #include "execution_frequency.h"
1175 static void dump_node_ana_vals(FILE *F, ir_node *n) {
1179 #ifdef INTERPROCEDURAL_VIEW
1180 fprintf(F, " %lf*(%2.0lf + %2.0lf) = %2.0lf ",
1181 get_irn_exec_freq(n),
1182 get_irg_method_execution_frequency(get_irn_irg(n)),
1183 pow(5, get_irg_recursion_depth(get_irn_irg(n))),
1184 get_irn_exec_freq(n) * (get_irg_method_execution_frequency(get_irn_irg(n)) + pow(5, get_irg_recursion_depth(get_irn_irg(n))))
1190 /* Dumps a node label without the enclosing ". */
1191 int dump_node_label(FILE *F, ir_node *n) {
1194 bad |= dump_node_opcode(F, n);
1195 bad |= dump_node_mode(F, n);
1197 bad |= dump_node_typeinfo(F, n);
1198 bad |= dump_node_nodeattr(F, n);
1199 if(dump_node_idx_labels) {
1200 fprintf(F, "%ld:%d", get_irn_node_nr(n), get_irn_idx(n));
1202 fprintf(F, "%ld", get_irn_node_nr(n));
1209 * Dumps the attributes of a node n into the file F.
1210 * Currently this is only the color of a node.
1212 static void dump_node_vcgattr(FILE *F, ir_node *node, ir_node *local, int bad)
1218 print_vcg_color(F, ird_color_error);
1222 if (dump_node_vcgattr_hook)
1223 if (dump_node_vcgattr_hook(F, node, local))
1226 n = local ? local : node;
1228 if (overrule_nodecolor != ird_color_default_node) {
1229 print_vcg_color(F, overrule_nodecolor);
1233 mode = get_irn_mode(node);
1234 if(mode == mode_M) {
1235 print_vcg_color(F, ird_color_memory);
1238 if(mode == mode_X) {
1239 print_vcg_color(F, ird_color_controlflow);
1243 switch (get_irn_opcode(n)) {
1248 print_vcg_color(F, ird_color_anchor);
1251 print_vcg_color(F, ird_color_error);
1254 if (is_Block_dead(n))
1255 print_vcg_color(F, ird_color_dead_block_background);
1257 print_vcg_color(F, ird_color_block_background);
1260 print_vcg_color(F, ird_color_phi);
1263 print_vcg_color(F, ird_color_memory);
1267 print_vcg_color(F, ird_color_const);
1270 print_vcg_color(F, ird_color_proj);
1273 ir_op *op = get_irn_op(node);
1275 if(is_op_constlike(op)) {
1276 print_vcg_color(F, ird_color_const);
1277 } else if(is_op_uses_memory(op)) {
1278 print_vcg_color(F, ird_color_uses_memory);
1279 } else if(is_op_cfopcode(op) || is_op_forking(op)) {
1280 print_vcg_color(F, ird_color_controlflow);
1282 PRINT_DEFAULT_NODE_ATTR;
1288 /* Adds a new node info dumper callback. */
1289 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data)
1291 hook_entry_t *info = xmalloc(sizeof(*info));
1293 info->hook._hook_node_info = cb;
1294 info->context = data;
1295 register_hook(hook_node_info, info);
1300 /* Remove a previously added info dumper callback. */
1301 void dump_remv_node_info_callback(void *handle)
1303 hook_entry_t *info = handle;
1304 unregister_hook(hook_node_info, info);
1309 * Dump the node information of a node n to a file F.
1311 static INLINE int dump_node_info(FILE *F, ir_node *n)
1314 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1316 fprintf(F, " info1: \"");
1317 bad = dump_irnode_to_file(F, n);
1318 /* call the dump_node operation if available */
1320 bad = ops->dump_node(n, F, dump_node_info_txt);
1322 /* allow additional info to be added */
1323 hook_node_info(F, n);
1329 static INLINE int is_constlike_node(const ir_node *node)
1331 const ir_op *op = get_irn_op(node);
1332 return is_op_constlike(op);
1336 /** outputs the predecessors of n, that are constants, local. I.e.,
1337 generates a copy of the constant predecessors for each node called with. */
1338 static void dump_const_node_local(FILE *F, ir_node *n) {
1340 if (!get_opt_dump_const_local()) return;
1342 /* Use visited flag to avoid outputting nodes twice.
1343 initialize it first. */
1344 for (i = 0; i < get_irn_arity(n); i++) {
1345 ir_node *con = get_irn_n(n, i);
1346 if (is_constlike_node(con)) {
1347 set_irn_visited(con, get_irg_visited(current_ir_graph) - 1);
1351 for (i = 0; i < get_irn_arity(n); i++) {
1352 ir_node *con = get_irn_n(n, i);
1353 if (is_constlike_node(con) && irn_not_visited(con)) {
1356 mark_irn_visited(con);
1357 /* Generate a new name for the node by appending the names of
1359 fprintf(F, "node: {title: "); PRINT_CONSTID(n, con);
1360 fprintf(F, " label: \"");
1361 bad |= dump_node_label(F, con);
1363 bad |= dump_node_info(F, con);
1364 dump_node_vcgattr(F, n, con, bad);
1370 /** If the block of an edge is a const_like node, dump it local with an edge */
1371 static void dump_const_block_local(FILE *F, ir_node *n) {
1374 if (!get_opt_dump_const_local()) return;
1376 blk = get_nodes_block(n);
1377 if (is_constlike_node(blk)) {
1380 /* Generate a new name for the node by appending the names of
1382 fprintf(F, "node: {title: \""); PRINT_CONSTBLKID(n, blk);
1383 fprintf(F, "\" label: \"");
1384 bad |= dump_node_label(F, blk);
1386 bad |= dump_node_info(F, blk);
1387 dump_node_vcgattr(F, n, blk, bad);
1390 fprintf(F, "edge: { sourcename: \"");
1392 fprintf(F, "\" targetname: \""); PRINT_CONSTBLKID(n,blk);
1394 if (dump_edge_vcgattr_hook) {
1396 if (dump_edge_vcgattr_hook(F, n, -1)) {
1400 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1405 fprintf(F, "\" " BLOCK_EDGE_ATTR "}\n");
1410 * prints the error message of a node to a file F as info2.
1412 static void print_node_error(FILE *F, const char *err_msg)
1417 fprintf(F, " info2: \"%s\"", err_msg);
1421 * prints debug messages of a node to file F as info3.
1423 static void print_dbg_info(FILE *F, dbg_info *dbg)
1427 if (__dbg_info_snprint) {
1429 if (__dbg_info_snprint(buf, sizeof(buf), dbg) > 0)
1430 fprintf(F, " info3: \"%s\"\n", buf);
1437 static void dump_node(FILE *F, ir_node *n)
1442 if (get_opt_dump_const_local() && is_constlike_node(n))
1445 /* dump this node */
1446 fputs("node: {title: \"", F);
1450 fputs(" label: \"", F);
1451 bad = ! irn_vrfy_irg_dump(n, current_ir_graph, &p);
1452 bad |= dump_node_label(F, n);
1453 dump_node_ana_vals(F, n);
1454 //dump_node_ana_info(F, n);
1457 if (get_op_flags(get_irn_op(n)) & irop_flag_dump_noinput) {
1458 //fputs(" node_class:23", F);
1461 bad |= dump_node_info(F, n);
1462 print_node_error(F, p);
1463 print_dbg_info(F, get_irn_dbg_info(n));
1464 dump_node_vcgattr(F, n, NULL, bad);
1466 dump_const_node_local(F, n);
1468 if(dump_node_edge_hook)
1469 dump_node_edge_hook(F, n);
1471 dump_irn_chi_term(F, n);
1472 dump_irn_state(F, n);
1476 /** dump the edge to the block this node belongs to */
1478 dump_ir_block_edge(FILE *F, ir_node *n) {
1479 if (get_opt_dump_const_local() && is_constlike_node(n)) return;
1480 if (is_no_Block(n)) {
1481 ir_node *block = get_nodes_block(n);
1483 if (get_opt_dump_const_local() && is_constlike_node(block)) {
1484 dump_const_block_local(F, n);
1486 fprintf(F, "edge: { sourcename: \"");
1488 fprintf(F, "\" targetname: ");
1489 fprintf(F, "\""); PRINT_NODEID(block); fprintf(F, "\"");
1491 if (dump_edge_vcgattr_hook) {
1493 if (dump_edge_vcgattr_hook(F, n, -1)) {
1497 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1502 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1508 print_data_edge_vcgattr(FILE *F, ir_node *from, int to) {
1510 * do not use get_nodes_block() here, will fail
1511 * if the irg is not pinned.
1513 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1514 fprintf(F, INTRA_DATA_EDGE_ATTR);
1516 fprintf(F, INTER_DATA_EDGE_ATTR);
1520 print_mem_edge_vcgattr(FILE *F, ir_node *from, int to) {
1522 * do not use get_nodes_block() here, will fail
1523 * if the irg is not pinned.
1525 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1526 fprintf(F, INTRA_MEM_EDGE_ATTR);
1528 fprintf(F, INTER_MEM_EDGE_ATTR);
1531 /** Print the vcg attributes for the edge from node from to it's to's input */
1532 static void print_edge_vcgattr(FILE *F, ir_node *from, int to) {
1535 if (dump_edge_vcgattr_hook)
1536 if (dump_edge_vcgattr_hook(F, from, to))
1539 if (dump_backedge_information_flag && is_backedge(from, to))
1540 fprintf(F, BACK_EDGE_ATTR);
1542 switch (get_irn_opcode(from)) {
1544 fprintf(F, CF_EDGE_ATTR);
1546 case iro_Start: break;
1549 if (get_irn_mode(get_End_keepalive(from, to)) == mode_BB)
1550 fprintf(F, KEEP_ALIVE_CF_EDGE_ATTR);
1552 fprintf(F, KEEP_ALIVE_DF_EDGE_ATTR);
1556 if (is_Proj(from)) {
1557 if (get_irn_mode(from) == mode_M)
1558 print_mem_edge_vcgattr(F, from, to);
1559 else if (get_irn_mode(from) == mode_X)
1560 fprintf(F, CF_EDGE_ATTR);
1562 print_data_edge_vcgattr(F, from, to);
1564 else if (get_irn_mode(get_irn_n(from, to)) == mode_M)
1565 print_mem_edge_vcgattr(F, from, to);
1566 else if (get_irn_mode(get_irn_n(from, to)) == mode_X)
1567 fprintf(F, CF_EDGE_ATTR);
1569 print_data_edge_vcgattr(F, from, to);
1573 /** dump edges to our inputs */
1574 static void dump_ir_data_edges(FILE *F, ir_node *n) {
1576 unsigned long visited = get_irn_visited(n);
1578 if (!dump_keepalive && is_End(n)) {
1579 /* the End node has only keep-alive edges */
1583 /* dump the dependency edges. */
1584 num = get_irn_deps(n);
1585 for (i = 0; i < num; ++i) {
1586 ir_node *dep = get_irn_dep(n, i);
1589 fprintf(F, "edge: {sourcename: \"");
1591 fprintf(F, "\" targetname: ");
1592 if ((get_opt_dump_const_local()) && is_constlike_node(dep)) {
1593 PRINT_CONSTID(n, dep);
1599 fprintf(F, " label: \"%d\" ", i);
1600 fprintf(F, " color: darkgreen}\n");
1604 num = get_irn_arity(n);
1605 for (i = 0; i < num; i++) {
1606 ir_node *pred = get_irn_n(n, i);
1609 if ((get_interprocedural_view() && get_irn_visited(pred) < visited))
1610 continue; /* pred not dumped */
1612 if (dump_backedge_information_flag && is_backedge(n, i))
1613 fprintf(F, "backedge: {sourcename: \"");
1615 fprintf(F, "edge: {sourcename: \"");
1617 fprintf(F, "\" targetname: ");
1618 if ((get_opt_dump_const_local()) && is_constlike_node(pred)) {
1619 PRINT_CONSTID(n, pred);
1621 fprintf(F, "\""); PRINT_NODEID(pred); fprintf(F, "\"");
1623 fprintf(F, " label: \"%d\" ", i);
1624 print_edge_vcgattr(F, n, i);
1628 if (dump_macro_block_edges && is_Block(n)) {
1629 ir_node *mb = get_Block_MacroBlock(n);
1630 fprintf(F, "edge: {sourcename: \"");
1632 fprintf(F, "\" targetname: \"");
1634 fprintf(F, "\" label: \"mb\" " MACROBLOCK_EDGE_ATTR);
1643 dump_ir_edges(FILE *F, ir_node *n) {
1644 const ir_edge_t *edge;
1647 foreach_out_edge(n, edge) {
1648 ir_node *succ = get_edge_src_irn(edge);
1650 fprintf(F, "edge: {sourcename: \"");
1652 fprintf(F, "\" targetname: \"");
1656 fprintf(F, " label: \"%d\" ", i);
1657 fprintf(F, OUT_EDGE_ATTR);
1664 /** Dumps a node and its edges but not the block edge */
1665 static void dump_node_wo_blockedge(ir_node *n, void *env) {
1668 dump_ir_data_edges(F, n);
1671 /** Dumps a node and its edges. */
1672 static void dump_whole_node(ir_node *n, void *env) {
1674 dump_node_wo_blockedge(n, env);
1675 if (!node_floats(n))
1676 dump_ir_block_edge(F, n);
1677 if (dump_new_edges_flag && edges_activated(current_ir_graph))
1678 dump_ir_edges(F, n);
1681 /** Dumps a const-like node. */
1682 static void dump_const_node(ir_node *n, void *env) {
1683 if (is_Block(n)) return;
1684 dump_node_wo_blockedge(n, env);
1687 /***********************************************************************/
1688 /* the following routines dump the nodes/irgs bracketed to graphs. */
1689 /***********************************************************************/
1691 /** Dumps a constant expression as entity initializer, array bound ...
1693 static void dump_const_expression(FILE *F, ir_node *value) {
1694 ir_graph *rem = current_ir_graph;
1695 int rem_dump_const_local = dump_const_local;
1696 dump_const_local = 0;
1697 current_ir_graph = get_const_code_irg();
1698 irg_walk(value, dump_const_node, NULL, F);
1699 /* Decrease visited flag so that we walk with the same flag for the next
1700 expression. This guarantees that we don't dump the same node twice,
1701 as for const expressions cse is performed to save memory. */
1702 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph) -1);
1703 current_ir_graph = rem;
1704 dump_const_local = rem_dump_const_local;
1707 /** Dump a block as graph containing its nodes.
1709 * Expects to find nodes belonging to the block as list in its
1711 * Dumps the edges of all nodes including itself. */
1712 static void dump_whole_block(FILE *F, ir_node *block) {
1714 ird_color_t color = ird_color_block_background;
1716 assert(is_Block(block));
1718 fprintf(F, "graph: { title: \"");
1719 PRINT_NODEID(block);
1720 fprintf(F, "\" label: \"");
1721 dump_node_label(F, block);
1723 if (get_opt_dump_abstvals())
1724 fprintf(F, " seqno: %d", (int)get_Block_seqno(block));
1727 /* colorize blocks */
1728 if (! get_Block_matured(block))
1729 color = ird_color_block_background;
1730 if (is_Block_dead(block))
1731 color = ird_color_dead_block_background;
1733 fprintf(F, "\" status:clustered ");
1734 print_vcg_color(F, color);
1737 /* yComp can show attributes for blocks, XVCG parses but ignores them */
1738 dump_node_info(F, block);
1739 print_dbg_info(F, get_irn_dbg_info(block));
1741 /* dump the blocks edges */
1742 dump_ir_data_edges(F, block);
1744 if (dump_block_edge_hook)
1745 dump_block_edge_hook(F, block);
1747 /* dump the nodes that go into the block */
1748 for (node = ird_get_irn_link(block); node; node = ird_get_irn_link(node)) {
1750 dump_ir_data_edges(F, node);
1753 /* Close the vcg information for the block */
1755 dump_const_node_local(F, block);
1757 dump_irn_chi_term(F, block);
1762 /** dumps a graph block-wise. Expects all blockless nodes in arr in irgs link.
1763 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1765 dump_block_graph(FILE *F, ir_graph *irg) {
1767 ir_graph *rem = current_ir_graph;
1768 ir_node **arr = ird_get_irg_link(irg);
1769 current_ir_graph = irg;
1771 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1772 ir_node * node = arr[i];
1773 if (is_Block(node)) {
1774 /* Dumps the block and all the nodes in the block, which are to
1775 be found in Block->link. */
1776 dump_whole_block(F, node);
1778 /* Nodes that are not in a Block. */
1780 if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
1781 dump_const_block_local(F, node);
1783 dump_ir_data_edges(F, node);
1785 if (dump_new_edges_flag && edges_activated(irg))
1786 dump_ir_edges(F, node);
1789 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1790 dump_loop_nodes_into_graph(F, irg);
1792 current_ir_graph = rem;
1796 * Dump the info for an irg.
1797 * Parsed by XVCG but not shown. use yComp.
1799 static void dump_graph_info(FILE *F, ir_graph *irg) {
1800 fprintf(F, "info1: \"");
1801 dump_entity_to_file(F, get_irg_entity(irg), dump_verbosity_entattrs | dump_verbosity_entconsts);
1805 /** Dumps an irg as a graph clustered by block nodes.
1806 * If interprocedural view edges can point to nodes out of this graph.
1808 static void dump_graph_from_list(FILE *F, ir_graph *irg) {
1809 ir_entity *ent = get_irg_entity(irg);
1811 fprintf(F, "graph: { title: \"");
1813 fprintf(F, "\" label: \"%s\" status:clustered color:%s \n",
1814 get_ent_dump_name(ent), color_names[ird_color_prog_background]);
1816 dump_graph_info(F, irg);
1817 print_dbg_info(F, get_entity_dbg_info(ent));
1819 dump_block_graph(F, irg);
1821 /* Close the vcg information for the irg */
1822 fprintf(F, "}\n\n");
1825 /** dumps a graph extended block-wise. Expects all blockless nodes in arr in irgs link.
1826 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1828 dump_extblock_graph(FILE *F, ir_graph *irg) {
1830 ir_graph *rem = current_ir_graph;
1831 ir_extblk **arr = ird_get_irg_link(irg);
1832 current_ir_graph = irg;
1834 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1835 ir_extblk *extbb = arr[i];
1836 ir_node *leader = get_extbb_leader(extbb);
1839 fprintf(F, "graph: { title: \"");
1840 PRINT_EXTBBID(leader);
1841 fprintf(F, "\" label: \"ExtBB %ld\" status:clustered color:lightgreen\n",
1842 get_irn_node_nr(leader));
1844 for (j = ARR_LEN(extbb->blks) - 1; j >= 0; --j) {
1845 ir_node * node = extbb->blks[j];
1846 if (is_Block(node)) {
1847 /* Dumps the block and all the nodes in the block, which are to
1848 be found in Block->link. */
1849 dump_whole_block(F, node);
1851 /* Nodes that are not in a Block. */
1853 if (is_Bad(get_nodes_block(node)) && !node_floats(node)) {
1854 dump_const_block_local(F, node);
1856 dump_ir_data_edges(F, node);
1862 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1863 dump_loop_nodes_into_graph(F, irg);
1865 current_ir_graph = rem;
1870 /*******************************************************************/
1871 /* Basic type and entity nodes and edges. */
1872 /*******************************************************************/
1874 /** dumps the edges between nodes and their type or entity attributes. */
1875 static void dump_node2type_edges(ir_node *n, void *env)
1880 switch (get_irn_opcode(n)) {
1882 /* @@@ some consts have an entity */
1885 if (SYMCONST_HAS_TYPE(get_SymConst_kind(n)))
1886 print_node_type_edge(F,n,get_SymConst_type(n),NODE2TYPE_EDGE_ATTR);
1889 print_node_ent_edge(F,n,get_Sel_entity(n),NODE2TYPE_EDGE_ATTR);
1892 print_node_type_edge(F,n,get_Call_type(n),NODE2TYPE_EDGE_ATTR);
1895 print_node_type_edge(F,n,get_Alloc_type(n),NODE2TYPE_EDGE_ATTR);
1898 print_node_type_edge(F,n,get_Free_type(n),NODE2TYPE_EDGE_ATTR);
1901 print_node_type_edge(F,n,get_Cast_type(n),NODE2TYPE_EDGE_ATTR);
1909 static int print_type_info(FILE *F, ir_type *tp) {
1912 if (get_type_state(tp) == layout_undefined) {
1913 fprintf(F, "state: layout_undefined\n");
1915 fprintf(F, "state: layout_fixed,\n");
1917 if (get_type_mode(tp))
1918 fprintf(F, "mode: %s,\n", get_mode_name_ex(get_type_mode(tp), &bad));
1919 fprintf(F, "size: %db,\n", get_type_size_bits(tp));
1924 static void print_typespecific_info(FILE *F, ir_type *tp) {
1925 switch (get_type_tpop_code(tp)) {
1927 fprintf(F, "peculiarity: %s\n", get_peculiarity_string(get_class_peculiarity(tp)));
1932 fprintf(F, "variadicity: %s\n", get_variadicity_name(get_method_variadicity(tp)));
1933 fprintf(F, "params: %d\n", get_method_n_params(tp));
1934 fprintf(F, "results: %d\n", get_method_n_ress(tp));
1940 case tpo_enumeration:
1952 static void print_typespecific_vcgattr(FILE *F, ir_type *tp) {
1953 switch (get_type_tpop_code(tp)) {
1955 if (peculiarity_existent == get_class_peculiarity(tp))
1956 fprintf(F, " " TYPE_CLASS_NODE_ATTR);
1958 fprintf(F, " " TYPE_DESCRIPTION_NODE_ATTR);
1961 fprintf(F, " " TYPE_METH_NODE_ATTR);
1969 case tpo_enumeration:
1981 int dump_type_node(FILE *F, ir_type *tp)
1985 fprintf(F, "node: {title: ");
1987 fprintf(F, " label: \"%s %s\"", get_type_tpop_name(tp), get_type_name_ex(tp, &bad));
1988 fprintf(F, " info1: \"");
1990 bad |= print_type_info(F, tp);
1991 print_typespecific_info(F, tp);
1993 dump_type_to_file(F, tp, dump_verbosity_max);
1996 print_dbg_info(F, get_type_dbg_info(tp));
1997 print_typespecific_vcgattr(F, tp);
2004 void dump_entity_node(FILE *F, ir_entity *ent, int color)
2006 fprintf(F, "node: {title: \"");
2007 PRINT_ENTID(ent); fprintf(F, "\"");
2008 fprintf(F, DEFAULT_TYPE_ATTRIBUTE);
2009 fprintf(F, "label: ");
2010 fprintf(F, "\"ent %s\" ", get_ent_dump_name(ent));
2012 fprintf(F, "color:%d", color);
2014 fprintf(F, ENTITY_NODE_ATTR);
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);
2043 /* dumps a type or entity and it's edges. */
2045 dump_type_info(type_or_ent tore, void *env) {
2047 int i = 0; /* to shutup gcc */
2049 /* dump this type or entity */
2051 switch (get_kind(tore.ent)) {
2053 ir_entity *ent = tore.ent;
2056 dump_entity_node(F, ent, 0);
2058 /* skip this to reduce graph. Member edge of type is parallel to this edge. *
2059 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2060 ENT_OWN_EDGE_ATTR "}\n", ent, get_entity_owner(ent));*/
2061 print_ent_type_edge(F,ent, get_entity_type(ent), ENT_TYPE_EDGE_ATTR);
2062 if (is_Class_type(get_entity_owner(ent))) {
2063 for(i = 0; i < get_entity_n_overwrites(ent); i++)
2064 print_ent_ent_edge(F,ent, get_entity_overwrites(ent, i), 0, ENT_OVERWRITES_EDGE_ATTR);
2066 /* attached subgraphs */
2067 if (const_entities && (get_entity_variability(ent) != variability_uninitialized)) {
2068 if (is_atomic_entity(ent)) {
2069 value = get_atomic_ent_value(ent);
2071 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2072 /* DDMN(value); $$$ */
2073 dump_const_expression(F, value);
2076 if (is_compound_entity(ent)) {
2077 for (i = 0; i < get_compound_ent_n_values(ent); i++) {
2078 value = get_compound_ent_value(ent, i);
2080 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2081 dump_const_expression(F, value);
2082 print_ent_ent_edge(F, ent, get_compound_ent_value_member(ent, i), 0, ENT_CORR_EDGE_ATTR, i);
2084 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2085 ENT_CORR_EDGE_ATTR "}\n", GET_ENTID(ent),
2086 get_compound_ent_value_member(ent, i), i);
2095 ir_type *tp = tore.typ;
2096 dump_type_node(F, tp);
2097 /* and now the edges */
2098 switch (get_type_tpop_code(tp)) {
2100 for (i=0; i < get_class_n_supertypes(tp); i++)
2101 print_type_type_edge(F, tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2102 for (i=0; i < get_class_n_members(tp); i++)
2103 print_type_ent_edge(F,tp,get_class_member(tp, i),TYPE_MEMBER_EDGE_ATTR);
2106 for (i=0; i < get_struct_n_members(tp); i++)
2107 print_type_ent_edge(F,tp,get_struct_member(tp, i),TYPE_MEMBER_EDGE_ATTR);
2110 for (i = 0; i < get_method_n_params(tp); i++)
2111 print_type_type_edge(F,tp,get_method_param_type(tp, i),METH_PAR_EDGE_ATTR,i);
2112 for (i = 0; i < get_method_n_ress(tp); i++)
2113 print_type_type_edge(F,tp,get_method_res_type(tp, i),METH_RES_EDGE_ATTR,i);
2116 for (i = 0; i < get_union_n_members(tp); i++)
2117 print_type_ent_edge(F,tp,get_union_member(tp, i),UNION_EDGE_ATTR);
2120 print_type_type_edge(F,tp,get_array_element_type(tp),ARR_ELT_TYPE_EDGE_ATTR);
2121 print_type_ent_edge(F,tp,get_array_element_entity(tp),ARR_ENT_EDGE_ATTR);
2122 for (i = 0; i < get_array_n_dimensions(tp); i++) {
2123 ir_node *upper = get_array_upper_bound(tp, i);
2124 ir_node *lower = get_array_lower_bound(tp, i);
2125 print_node_type_edge(F, upper, tp, "label: \"upper %d\"", get_array_order(tp, i));
2126 print_node_type_edge(F, lower, tp, "label: \"lower %d\"", get_array_order(tp, i));
2127 dump_const_expression(F, upper);
2128 dump_const_expression(F, lower);
2131 case tpo_enumeration:
2132 for (i = 0; i < get_enumeration_n_enums(tp); ++i) {
2133 dump_enum_item(F, tp, i);
2134 print_enum_item_edge(F, tp, i, "label: \"item %d\"", i);
2138 print_type_type_edge(F,tp,get_pointer_points_to_type(tp), PTR_PTS_TO_EDGE_ATTR);
2145 break; /* case k_type */
2148 printf(" *** irdump, dump_type_info(l.%i), faulty type.\n", __LINE__);
2149 } /* switch kind_or_entity */
2152 typedef struct _h_env {
2157 /** For dumping class hierarchies.
2158 * Dumps a class type node and a superclass edge.
2159 * If env->dump_ent dumps entities of classes and overwrites edges.
2162 dump_class_hierarchy_node(type_or_ent tore, void *ctx) {
2165 int i = 0; /* to shutup gcc */
2167 /* dump this type or entity */
2168 switch (get_kind(tore.ent)) {
2170 ir_entity *ent = tore.ent;
2171 if (get_entity_owner(ent) == get_glob_type()) break;
2172 if (!is_Method_type(get_entity_type(ent)))
2174 if (env->dump_ent && is_Class_type(get_entity_owner(ent))) {
2176 dump_entity_node(F, ent, 0);
2178 print_type_ent_edge(F,get_entity_owner(ent),ent,TYPE_MEMBER_EDGE_ATTR);
2179 for(i = 0; i < get_entity_n_overwrites(ent); i++)
2180 print_ent_ent_edge(F, get_entity_overwrites(ent, i), ent, 0, ENT_OVERWRITES_EDGE_ATTR);
2185 ir_type *tp = tore.typ;
2186 if (tp == get_glob_type())
2188 switch (get_type_tpop_code(tp)) {
2190 dump_type_node(F, tp);
2191 /* and now the edges */
2192 for (i=0; i < get_class_n_supertypes(tp); i++) {
2193 print_type_type_edge(F,tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2198 break; /* case k_type */
2201 printf(" *** irdump, dump_class_hierarchy_node(l.%i), faulty type.\n", __LINE__);
2202 } /* switch kind_or_entity */
2205 /*******************************************************************/
2206 /* dump analysis information that is expressed in graph terms. */
2207 /*******************************************************************/
2209 /* dump out edges */
2211 dump_out_edge(ir_node *n, void *env) {
2214 for (i = 0; i < get_irn_n_outs(n); i++) {
2215 assert(get_irn_out(n, i));
2216 fprintf(F, "edge: {sourcename: \"");
2218 fprintf(F, "\" targetname: \"");
2219 PRINT_NODEID(get_irn_out(n, i));
2220 fprintf(F, "\" color: red linestyle: dashed");
2226 dump_loop_label(FILE *F, ir_loop *loop) {
2227 fprintf(F, "loop %d, %d sons, %d nodes",
2228 get_loop_depth(loop), get_loop_n_sons(loop), get_loop_n_nodes(loop));
2231 static INLINE void dump_loop_info(FILE *F, ir_loop *loop) {
2232 fprintf(F, " info1: \"");
2233 fprintf(F, " loop nr: %d", get_loop_loop_nr(loop));
2234 #ifdef DEBUG_libfirm /* GL @@@ debug analyses */
2235 fprintf(F, "\n The loop was analyzed %d times.", PTR_TO_INT(get_loop_link(loop)));
2241 dump_loop_node(FILE *F, ir_loop *loop) {
2242 fprintf(F, "node: {title: \"");
2244 fprintf(F, "\" label: \"");
2245 dump_loop_label(F, loop);
2247 dump_loop_info(F, loop);
2252 dump_loop_node_edge(FILE *F, ir_loop *loop, int i) {
2254 fprintf(F, "edge: {sourcename: \"");
2256 fprintf(F, "\" targetname: \"");
2257 PRINT_NODEID(get_loop_node(loop, i));
2258 fprintf(F, "\" color: green");
2263 dump_loop_son_edge(FILE *F, ir_loop *loop, int i) {
2265 fprintf(F, "edge: {sourcename: \"");
2267 fprintf(F, "\" targetname: \"");
2268 PRINT_LOOPID(get_loop_son(loop, i));
2269 fprintf(F, "\" color: darkgreen label: \"%d\"}\n",
2270 get_loop_element_pos(loop, get_loop_son(loop, i)));
2274 void dump_loops(FILE *F, ir_loop *loop) {
2276 /* dump this loop node */
2277 dump_loop_node(F, loop);
2279 /* dump edges to nodes in loop -- only if it is a real loop */
2280 if (get_loop_depth(loop) != 0) {
2281 for (i = 0; i < get_loop_n_nodes(loop); i++) {
2282 dump_loop_node_edge(F, loop, i);
2285 for (i = 0; i < get_loop_n_sons(loop); i++) {
2286 dump_loops(F, get_loop_son(loop, i));
2287 dump_loop_son_edge(F, loop, i);
2292 void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg) {
2293 ir_graph *rem = current_ir_graph;
2294 current_ir_graph = irg;
2296 if (get_irg_loop(irg)) dump_loops(F, get_irg_loop(irg));
2298 current_ir_graph = rem;
2303 * dumps the VCG header
2305 void dump_vcg_header(FILE *F, const char *name, const char *layout, const char *orientation) {
2311 label = edge_label ? "yes" : "no";
2312 if (! layout) layout = "Compilergraph";
2313 if (!orientation) orientation = "bottom_to_top";
2317 "graph: { title: \"ir graph of %s\"\n"
2318 "display_edge_labels: %s\n"
2319 "layoutalgorithm: mindepth //$ \"%s\"\n"
2320 "manhattan_edges: yes\n"
2321 "port_sharing: no\n"
2323 "classname 1: \"intrablock Data\"\n"
2324 "classname 2: \"Block\"\n"
2325 "classname 3: \"Entity type\"\n"
2326 "classname 4: \"Entity owner\"\n"
2327 "classname 5: \"Method Param\"\n"
2328 "classname 6: \"Method Res\"\n"
2329 "classname 7: \"Super\"\n"
2330 "classname 8: \"Union\"\n"
2331 "classname 9: \"Points-to\"\n"
2332 "classname 10: \"Array Element Type\"\n"
2333 "classname 11: \"Overwrites\"\n"
2334 "classname 12: \"Member\"\n"
2335 "classname 13: \"Control Flow\"\n"
2336 "classname 14: \"intrablock Memory\"\n"
2337 "classname 15: \"Dominators\"\n"
2338 "classname 16: \"interblock Data\"\n"
2339 "classname 17: \"interblock Memory\"\n"
2340 "classname 18: \"Exception Control Flow for Interval Analysis\"\n"
2341 "classname 19: \"Postdominators\"\n"
2342 "classname 20: \"Keep Alive\"\n"
2343 "classname 21: \"Out Edges\"\n"
2344 "classname 22: \"Macro Block Edges\"\n"
2345 //"classname 23: \"NoInput Nodes\"\n"
2346 "infoname 1: \"Attribute\"\n"
2347 "infoname 2: \"Verification errors\"\n"
2348 "infoname 3: \"Debug info\"\n",
2349 name, label, layout, orientation);
2351 for (i = 0; i < ird_color_count; ++i) {
2352 if (color_rgb[i] != NULL) {
2353 fprintf(F, "colorentry %s: %s\n", color_names[i], color_rgb[i]);
2356 fprintf(F, "\n"); /* a separator */
2362 * @param irg The graph to be dumped
2363 * @param suffix1 first filename suffix
2364 * @param suffix2 second filename suffix
2366 FILE *vcg_open(ir_graph *irg, const char * suffix1, const char *suffix2) {
2368 const char *nm = get_irg_dump_name(irg);
2369 int len = strlen(nm), i, j;
2370 char *fname; /* filename to put the vcg information in */
2372 if (!suffix1) suffix1 = "";
2373 if (!suffix2) suffix2 = "";
2375 /* open file for vcg graph */
2376 fname = xmalloc (len * 2 + strlen(suffix1) + strlen(suffix2) + 5);
2378 /* strncpy (fname, nm, len); */ /* copy the filename */
2380 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2382 fname[j] = '@'; j++; fname[j] = '1'; j++;
2383 } else if (nm[i] == '@') {
2384 fname[j] = '@'; j++; fname[j] = '2'; j++;
2386 fname[j] = nm[i]; j++;
2390 strcat(fname, suffix1); /* append file suffix */
2391 strcat(fname, suffix2); /* append file suffix */
2392 strcat(fname, ".vcg"); /* append the .vcg suffix */
2394 /* vcg really expect only a <CR> at end of line, so
2395 * the "b"inary mode is what you mean (and even needed for Win32)
2397 F = fopen(fname, "wb"); /* open file for writing */
2409 * @param name prefix file name
2410 * @param suffix filename suffix
2412 FILE *vcg_open_name(const char *name, const char *suffix) {
2414 char *fname; /* filename to put the vcg information in */
2415 int i, j, len = strlen(name);
2417 if (!suffix) suffix = "";
2419 /** open file for vcg graph */
2420 fname = xmalloc(len * 2 + 5 + strlen(suffix));
2421 /* strcpy (fname, name);*/ /* copy the filename */
2423 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2424 if (name[i] == '/') {
2425 fname[j] = '@'; j++; fname[j] = '1'; j++;
2426 } else if (name[i] == '@') {
2427 fname[j] = '@'; j++; fname[j] = '2'; j++;
2429 fname[j] = name[i]; j++;
2433 strcat(fname, suffix);
2434 strcat(fname, ".vcg"); /* append the .vcg suffix */
2436 /* vcg really expect only a <CR> at end of line, so
2437 * the "b"inary mode is what you mean (and even needed for Win32)
2439 F = fopen(fname, "wb"); /* open file for writing */
2449 * Dumps the vcg file footer
2451 void dump_vcg_footer(FILE *F) {
2455 /************************************************************************/
2456 /************************************************************************/
2457 /* Routines that dump all or parts of the firm representation to a file */
2458 /************************************************************************/
2459 /************************************************************************/
2461 /************************************************************************/
2462 /* Dump ir graphs, different formats and additional information. */
2463 /************************************************************************/
2465 typedef void (*do_dump_graph_func) (ir_graph *irg, FILE *out);
2467 static void do_dump(ir_graph *irg, const char *suffix, const char *suffix_ip,
2468 const char *suffix_nonip, do_dump_graph_func dump_func)
2472 const char *suffix1;
2474 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2477 rem = current_ir_graph;
2478 current_ir_graph = irg;
2479 if (get_interprocedural_view())
2480 suffix1 = suffix_ip;
2482 suffix1 = suffix_nonip;
2483 current_ir_graph = rem;
2485 out = vcg_open(irg, suffix, suffix1);
2487 dump_func(irg, out);
2492 void dump_ir_graph_file(ir_graph *irg, FILE *out)
2494 if (dump_backedge_information_flag
2495 && get_irg_loopinfo_state(irg) != loopinfo_consistent) {
2496 construct_backedges(irg);
2499 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2501 /* call the dump graph hook */
2502 if (dump_ir_graph_hook) {
2503 if (dump_ir_graph_hook(out, irg)) {
2508 /* walk over the graph */
2509 /* dump_whole_node must be called in post visiting predecessors */
2510 ird_walk_graph(irg, NULL, dump_whole_node, out);
2512 /* dump the out edges in a separate walk */
2513 if ((dump_out_edge_flag) && (get_irg_outs_state(irg) != outs_none)) {
2514 irg_out_walk(get_irg_start(irg), dump_out_edge, NULL, out);
2517 dump_vcg_footer(out);
2520 /** Routine to dump a graph, blocks as conventional nodes. */
2521 void dump_ir_graph(ir_graph *irg, const char *suffix )
2523 do_dump(irg, suffix, "-pure-ip", "-pure", dump_ir_graph_file);
2526 void dump_ir_block_graph_file(ir_graph *irg, FILE *out)
2530 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2532 construct_block_lists(irg);
2535 * If we are in the interprocedural view, we dump not
2536 * only the requested irg but also all irgs that can be reached
2539 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2540 ir_graph *g = get_irp_irg(i);
2541 ir_node **arr = ird_get_irg_link(g);
2543 dump_graph_from_list(out, g);
2548 dump_vcg_footer(out);
2551 /* Dump a firm graph without explicit block nodes. */
2552 void dump_ir_block_graph(ir_graph *irg, const char *suffix)
2554 do_dump(irg, suffix, "-ip", "", dump_ir_block_graph_file);
2557 void dump_ir_extblock_graph_file(ir_graph *irg, FILE *F)
2560 ir_entity *ent = get_irg_entity(irg);
2562 if (get_irg_extblk_state(irg) != extblk_valid)
2565 dump_vcg_header(F, get_irg_dump_name(irg), NULL, NULL);
2567 construct_extblock_lists(irg);
2569 fprintf(F, "graph: { title: \"");
2571 fprintf(F, "\" label: \"%s\" status:clustered color: white \n",
2572 get_ent_dump_name(ent));
2574 dump_graph_info(F, irg);
2575 print_dbg_info(F, get_entity_dbg_info(ent));
2577 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2578 ir_graph *irg = get_irp_irg(i);
2579 list_tuple *lists = ird_get_irg_link(irg);
2582 /* dump the extended blocks first */
2583 if (ARR_LEN(lists->extbb_list)) {
2584 ird_set_irg_link(irg, lists->extbb_list);
2585 dump_extblock_graph(F, irg);
2588 /* we may have blocks without extended blocks, bad for instance */
2589 if (ARR_LEN(lists->blk_list)) {
2590 ird_set_irg_link(irg, lists->blk_list);
2591 dump_block_graph(F, irg);
2594 DEL_ARR_F(lists->extbb_list);
2595 DEL_ARR_F(lists->blk_list);
2600 /* Close the vcg information for the irg */
2601 fprintf(F, "}\n\n");
2607 /* Dump a firm graph without explicit block nodes but grouped in extended blocks. */
2608 void dump_ir_extblock_graph(ir_graph *irg, const char *suffix)
2610 do_dump(irg, suffix, "-ip", "", dump_ir_extblock_graph_file);
2613 void dump_ir_graph_w_types_file(ir_graph *irg, FILE *out)
2615 ir_graph *rem = current_ir_graph;
2616 int rem_dump_const_local;
2618 rem = current_ir_graph;
2619 current_ir_graph = irg;
2620 rem_dump_const_local = dump_const_local;
2621 /* dumping types does not work with local nodes */
2622 dump_const_local = 0;
2624 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2626 /* dump common ir graph */
2627 irg_walk(get_irg_end(irg), NULL, dump_whole_node, out);
2628 /* dump type info */
2629 type_walk_irg(irg, dump_type_info, NULL, out);
2630 inc_irg_visited(get_const_code_irg());
2631 /* dump edges from graph to type info */
2632 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2634 dump_vcg_footer(out);
2635 dump_const_local = rem_dump_const_local;
2636 current_ir_graph = rem;
2639 /* dumps a graph with type information */
2640 void dump_ir_graph_w_types(ir_graph *irg, const char *suffix)
2642 do_dump(irg, suffix, "-pure-wtypes-ip", "-pure-wtypes",
2643 dump_ir_graph_w_types_file);
2646 void dump_ir_block_graph_w_types_file(ir_graph *irg, FILE *out)
2649 int rem_dump_const_local;
2650 ir_graph *rem = current_ir_graph;
2652 rem_dump_const_local = dump_const_local;
2653 /* dumping types does not work with local nodes */
2654 dump_const_local = 0;
2656 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2658 /* dump common blocked ir graph */
2659 construct_block_lists(irg);
2661 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2662 ir_node **arr = ird_get_irg_link(get_irp_irg(i));
2664 dump_graph_from_list(out, get_irp_irg(i));
2669 /* dump type info */
2670 current_ir_graph = irg;
2671 type_walk_irg(irg, dump_type_info, NULL, out);
2672 inc_irg_visited(get_const_code_irg());
2674 /* dump edges from graph to type info */
2675 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2677 dump_vcg_footer(out);
2678 dump_const_local = rem_dump_const_local;
2679 current_ir_graph = rem;
2682 void dump_ir_block_graph_w_types(ir_graph *irg, const char *suffix)
2684 do_dump(irg, suffix, "-wtypes-ip", "-wtypes",
2685 dump_ir_block_graph_w_types_file);
2688 /*---------------------------------------------------------------------*/
2689 /* The following routines dump a control flow graph. */
2690 /*---------------------------------------------------------------------*/
2693 dump_block_to_cfg(ir_node *block, void *env) {
2698 if (is_Block(block)) {
2699 /* This is a block. Dump a node for the block. */
2700 fprintf(F, "node: {title: \""); PRINT_NODEID(block);
2701 fprintf(F, "\" label: \"");
2702 if (block == get_irg_start_block(get_irn_irg(block)))
2703 fprintf(F, "Start ");
2704 if (block == get_irg_end_block(get_irn_irg(block)))
2707 fprintf(F, "%s ", get_op_name(get_irn_op(block)));
2708 PRINT_NODEID(block);
2710 fprintf(F, "info1:\"");
2712 /* the generic version. */
2713 dump_irnode_to_file(F, block);
2715 /* Check whether we have bad predecessors to color the block. */
2716 for (i = 0; i < get_Block_n_cfgpreds(block); ++i)
2717 if ((fl = is_Bad(get_Block_cfgpred(block, i))))
2720 fprintf(F, "\""); /* closing quote of info */
2722 if ((block == get_irg_start_block(get_irn_irg(block))) ||
2723 (block == get_irg_end_block(get_irn_irg(block))) )
2724 fprintf(F, " color:blue ");
2726 fprintf(F, " color:yellow ");
2729 /* Dump the edges */
2730 for ( i = 0; i < get_Block_n_cfgpreds(block); i++)
2731 if (get_irn_op(skip_Proj(get_Block_cfgpred(block, i))) != op_Bad) {
2732 pred = get_nodes_block(skip_Proj(get_Block_cfgpred(block, i)));
2733 fprintf(F, "edge: { sourcename: \"");
2734 PRINT_NODEID(block);
2735 fprintf(F, "\" targetname: \"");
2737 fprintf(F, "\"}\n");
2740 /* Dump dominator/postdominator edge */
2741 if (dump_dominator_information_flag) {
2742 if (get_irg_dom_state(current_ir_graph) == dom_consistent && get_Block_idom(block)) {
2743 pred = get_Block_idom(block);
2744 fprintf(F, "edge: { sourcename: \"");
2745 PRINT_NODEID(block);
2746 fprintf(F, "\" targetname: \"");
2748 fprintf(F, "\" " DOMINATOR_EDGE_ATTR "}\n");
2750 if (get_irg_postdom_state(current_ir_graph) == dom_consistent && get_Block_ipostdom(block)) {
2751 pred = get_Block_ipostdom(block);
2752 fprintf(F, "edge: { sourcename: \"");
2753 PRINT_NODEID(block);
2754 fprintf(F, "\" targetname: \"");
2756 fprintf(F, "\" " POSTDOMINATOR_EDGE_ATTR "}\n");
2762 void dump_cfg(ir_graph *irg, const char *suffix)
2765 /* if a filter is set, dump only the irg's that match the filter */
2766 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2769 f = vcg_open(irg, suffix, "-cfg");
2771 ir_graph *rem = current_ir_graph;
2772 #ifdef INTERPROCEDURAL_VIEW
2773 int ipv = get_interprocedural_view();
2776 current_ir_graph = irg;
2777 dump_vcg_header(f, get_irg_dump_name(irg), NULL, NULL);
2779 #ifdef INTERPROCEDURAL_VIEW
2781 printf("Warning: dumping cfg not in interprocedural view!\n");
2782 set_interprocedural_view(0);
2786 /* walk over the blocks in the graph */
2787 irg_block_walk(get_irg_end(irg), dump_block_to_cfg, NULL, f);
2788 dump_node(f, get_irg_bad(irg));
2790 #ifdef INTERPROCEDURAL_VIEW
2791 set_interprocedural_view(ipv);
2795 current_ir_graph = rem;
2800 static void descend_and_dump(FILE *F, ir_node *n, int depth, pset *mark_set) {
2801 if (pset_find_ptr(mark_set, n)) return;
2803 pset_insert_ptr(mark_set, n);
2806 int i, start = is_Block(n) ? 0 : -1;
2807 dump_whole_node(n, F);
2808 for (i = start; i < get_irn_arity(n); ++i)
2809 descend_and_dump(F, get_irn_n(n, i), depth-1, mark_set);
2812 /* Don't dump edges to nodes further out. These might be edges to
2813 nodes we already dumped, if there is a shorter path to these. */
2817 static int subgraph_counter = 0;
2818 void dump_subgraph(ir_node *root, int depth, const char *suffix) {
2822 sprintf(buf, "-subg_%03d", subgraph_counter++);
2823 F = vcg_open(get_irn_irg(root), suffix, buf);
2825 pset *mark_set = pset_new_ptr(1);
2826 dump_vcg_header(F, get_irg_dump_name(get_irn_irg(root)), NULL, NULL);
2827 descend_and_dump(F, root, depth, mark_set);
2834 #ifdef INTERPROCEDURAL_VIEW
2835 void dump_callgraph(const char *suffix) {
2836 FILE *F = vcg_open_name("Callgraph", suffix);
2839 int i, rem = edge_label;
2842 dump_vcg_header(F, "Callgraph", NULL);
2844 //colorize = get_irp_callgraph_state() == irp_callgraph_and_calltree_consistent;
2846 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2847 ir_graph *irg = get_irp_irg(i);
2848 ir_entity *ent = get_irg_entity(irg);
2850 //int n_callees = get_irg_n_callees(irg);
2853 //color = colorize ? get_entity_color(ent) : ird_color_green;
2854 color = ird_color_green;
2855 dump_entity_node(F, ent, color);
2856 for (j = 0; j < n_callees; ++j) {
2857 ir_entity *c = get_irg_entity(get_irg_callee(irg, j));
2858 //if (id_is_prefix(prefix, get_entity_ld_ident(c))) continue;
2859 int be = is_irg_callee_backedge(irg, j);
2862 "label:\"recursion %d\" color:%d" :
2863 "label:\"calls %d\" color:%d";
2864 print_ent_ent_edge(F, ent, c, be, attr, get_irg_callee_loop_depth(irg, j), color);
2874 /* Dump all irgs in interprocedural view to a single file. */
2875 void dump_all_cg_block_graph(const char *suffix) {
2876 FILE *f = vcg_open_name("All_graphs", suffix);
2880 int rem_view = get_interprocedural_view();
2882 set_interprocedural_view(1);
2883 dump_vcg_header(f, "All_graphs", NULL);
2885 /* collect nodes in all irgs reachable in call graph*/
2886 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2887 ird_set_irg_link(get_irp_irg(i), NULL);
2889 cg_walk(clear_link, collect_node, NULL);
2891 /* dump all graphs */
2892 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2893 current_ir_graph = get_irp_irg(i);
2894 assert(ird_get_irg_link(current_ir_graph));
2895 dump_graph_from_list(f, current_ir_graph);
2896 DEL_ARR_F(ird_get_irg_link(current_ir_graph));
2901 set_interprocedural_view(rem_view);
2906 /*---------------------------------------------------------------------*/
2907 /* the following routines dumps type information without any ir nodes. */
2908 /*---------------------------------------------------------------------*/
2911 dump_type_graph(ir_graph *irg, const char *suffix)
2915 /* if a filter is set, dump only the irg's that match the filter */
2916 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
2918 f = vcg_open(irg, suffix, "-type");
2920 ir_graph *rem = current_ir_graph;
2921 current_ir_graph = irg;
2923 dump_vcg_header(f, get_irg_dump_name(irg), "Hierarchic", NULL);
2925 /* walk over the blocks in the graph */
2926 type_walk_irg(irg, dump_type_info, NULL, f);
2927 /* The walker for the const code can be called several times for the
2928 same (sub) expression. So that no nodes are dumped several times
2929 we decrease the visited flag of the corresponding graph after each
2930 walk. So now increase it finally. */
2931 inc_irg_visited(get_const_code_irg());
2935 current_ir_graph = rem;
2940 dump_all_types(const char *suffix)
2942 FILE *f = vcg_open_name("All_types", suffix);
2944 dump_vcg_header(f, "All_types", "Hierarchic", NULL);
2945 type_walk(dump_type_info, NULL, f);
2946 inc_irg_visited(get_const_code_irg());
2954 dump_class_hierarchy(int entities, const char *suffix)
2956 FILE *f = vcg_open_name("class_hierarchy", suffix);
2961 env.dump_ent = entities;
2962 dump_vcg_header(f, "class_hierarchy", "Hierarchic", NULL);
2963 type_walk(dump_class_hierarchy_node, NULL, &env);
2970 /*---------------------------------------------------------------------*/
2971 /* dumps all graphs with the graph-dumper passed. Possible dumpers: */
2973 /* dump_ir_block_graph */
2975 /* dump_type_graph */
2976 /* dump_ir_graph_w_types */
2977 /*---------------------------------------------------------------------*/
2979 void dump_all_ir_graphs(dump_graph_func *dmp_grph, const char *suffix) {
2981 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2982 dmp_grph(get_irp_irg(i), suffix);
2986 /*--------------------------------------------------------------------------------*
2987 * Dumps a stand alone loop graph with firm nodes which belong to one loop node *
2988 * packed together in one subgraph/box *
2989 *--------------------------------------------------------------------------------*/
2991 void dump_loops_standalone(FILE *F, ir_loop *loop) {
2992 int i = 0, loop_node_started = 0, son_number = 0, first = 0;
2994 ir_loop *son = NULL;
2996 /* Dump a new loop node. */
2997 dump_loop_node(F, loop);
2999 /* Dump the loop elements. */
3000 for (i = 0; i < get_loop_n_elements(loop); i++) {
3001 le = get_loop_element(loop, i);
3003 if (get_kind(son) == k_ir_loop) {
3005 /* We are a loop son -> Recurse */
3007 if (loop_node_started) { /* Close the "firm-nodes" node first if we started one. */
3008 fprintf(F, "\" }\n");
3009 fprintf(F, "edge: {sourcename: \"");
3011 fprintf(F, "\" targetname: \"");
3013 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3014 loop_node_started = 0;
3016 dump_loop_son_edge(F, loop, son_number++);
3017 dump_loops_standalone(F, son);
3018 } else if (get_kind(son) == k_ir_node) {
3019 /* We are a loop node -> Collect firm nodes */
3021 ir_node *n = le.node;
3024 if (!loop_node_started) {
3025 /* Start a new node which contains all firm nodes of the current loop */
3026 fprintf(F, "node: { title: \"");
3028 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3029 loop_node_started = 1;
3034 bad |= dump_node_label(F, n);
3035 /* Causes indeterministic output: if (is_Block(n)) fprintf(F, "\t ->%d", (int)get_irn_link(n)); */
3036 if (has_backedges(n)) fprintf(F, "\t loop head!");
3037 } else { /* for callgraph loop tree */
3039 assert(get_kind(son) == k_ir_graph);
3041 /* We are a loop node -> Collect firm graphs */
3043 if (!loop_node_started) {
3044 /* Start a new node which contains all firm nodes of the current loop */
3045 fprintf(F, "node: { title: \"");
3047 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3048 loop_node_started = 1;
3052 fprintf(F, " %s", get_irg_dump_name(n));
3053 /* fprintf(F, " %s (depth %d)", get_irg_dump_name(n), n->callgraph_weighted_loop_depth); */
3057 if (loop_node_started) {
3058 fprintf(F, "\" }\n");
3059 fprintf(F, "edge: {sourcename: \"");
3061 fprintf(F, "\" targetname: \"");
3063 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3064 loop_node_started = 0;
3068 void dump_loop_tree(ir_graph *irg, const char *suffix)
3072 /* if a filter is set, dump only the irg's that match the filter */
3073 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
3075 f = vcg_open(irg, suffix, "-looptree");
3077 ir_graph *rem = current_ir_graph;
3078 int el_rem = edge_label;
3080 current_ir_graph = irg;
3083 dump_vcg_header(f, get_irg_dump_name(irg), "Tree", "top_to_bottom");
3085 if (get_irg_loop(irg))
3086 dump_loops_standalone(f, get_irg_loop(irg));
3091 edge_label = el_rem;
3092 current_ir_graph = rem;
3096 void dump_callgraph_loop_tree(const char *suffix) {
3098 F = vcg_open_name("Callgraph_looptree", suffix);
3099 dump_vcg_header(F, "callgraph looptree", "Tree", "top_to_bottom");
3100 dump_loops_standalone(F, irp->outermost_cg_loop);
3106 /*----------------------------------------------------------------------------*/
3107 /* Dumps the firm nodes in the loop tree to a graph along with the loop nodes.*/
3108 /*----------------------------------------------------------------------------*/
3110 void collect_nodeloop(FILE *F, ir_loop *loop, eset *loopnodes) {
3111 int i, son_number = 0, node_number = 0;
3113 if (dump_loop_information_flag) dump_loop_node(F, loop);
3115 for (i = 0; i < get_loop_n_elements(loop); i++) {
3116 loop_element le = get_loop_element(loop, i);
3117 if (*(le.kind) == k_ir_loop) {
3118 if (dump_loop_information_flag) dump_loop_son_edge(F, loop, son_number++);
3120 collect_nodeloop(F, le.son, loopnodes);
3122 if (dump_loop_information_flag) dump_loop_node_edge(F, loop, node_number++);
3123 eset_insert(loopnodes, le.node);
3128 void collect_nodeloop_external_nodes(ir_loop *loop, eset *loopnodes, eset *extnodes) {
3131 for(i = 0; i < get_loop_n_elements(loop); i++) {
3132 loop_element le = get_loop_element(loop, i);
3133 if (*(le.kind) == k_ir_loop) {
3135 collect_nodeloop_external_nodes(le.son, loopnodes, extnodes);
3137 if (is_Block(le.node)) start = 0; else start = -1;
3138 for (j = start; j < get_irn_arity(le.node); j++) {
3139 ir_node *pred = get_irn_n(le.node, j);
3140 if (!eset_contains(loopnodes, pred)) {
3141 eset_insert(extnodes, pred);
3142 if (!is_Block(pred)) {
3143 pred = get_nodes_block(pred);
3144 if (!eset_contains(loopnodes, pred)) eset_insert(extnodes, pred);
3152 void dump_loop(ir_loop *l, const char *suffix) {
3156 snprintf(name, sizeof(name), "loop_%d", get_loop_loop_nr(l));
3157 F = vcg_open_name(name, suffix);
3159 eset *loopnodes = eset_create();
3160 eset *extnodes = eset_create();
3163 dump_vcg_header(F, name, NULL, NULL);
3165 /* collect all nodes to dump */
3166 collect_nodeloop(F, l, loopnodes);
3167 collect_nodeloop_external_nodes(l, loopnodes, extnodes);
3169 /* build block lists */
3170 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes))
3171 set_irn_link(n, NULL);
3172 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes))
3173 set_irn_link(n, NULL);
3174 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes)) {
3176 b = get_nodes_block(n);
3177 set_irn_link(n, get_irn_link(b));
3181 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes)) {
3183 b = get_nodes_block(n);
3184 set_irn_link(n, get_irn_link(b));
3189 for (b = eset_first(loopnodes); b != NULL; b = eset_next(loopnodes)) {
3191 fprintf(F, "graph: { title: \"");
3193 fprintf(F, "\" label: \"");
3194 dump_node_opcode(F, b);
3195 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3196 fprintf(F, "\" status:clustered color:yellow\n");
3198 /* dump the blocks edges */
3199 dump_ir_data_edges(F, b);
3201 /* dump the nodes that go into the block */
3202 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3203 if (eset_contains(extnodes, n))
3204 overrule_nodecolor = ird_color_block_inout;
3206 overrule_nodecolor = ird_color_default_node;
3207 if (!eset_contains(extnodes, n)) dump_ir_data_edges(F, n);
3210 /* Close the vcg information for the block */
3212 dump_const_node_local(F, b);
3216 for (b = eset_first(extnodes); b != NULL; b = eset_next(extnodes)) {
3218 fprintf(F, "graph: { title: \"");
3220 fprintf(F, "\" label: \"");
3221 dump_node_opcode(F, b);
3222 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3223 fprintf(F, "\" status:clustered color:lightblue\n");
3225 /* dump the nodes that go into the block */
3226 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3227 if (!eset_contains(loopnodes, n))
3228 overrule_nodecolor = ird_color_block_inout;
3230 overrule_nodecolor = ird_color_default_node;
3231 if (eset_contains(loopnodes, n)) dump_ir_data_edges(F, n);
3234 /* Close the vcg information for the block */
3236 dump_const_node_local(F, b);
3240 eset_destroy(loopnodes);
3241 eset_destroy(extnodes);