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"
71 extern void dump_irn_chi_term(FILE *FL, ir_node *n);
72 extern void dump_irn_state(FILE *FL, ir_node *n);
73 extern int get_opt_dump_abstvals(void);
74 typedef unsigned long SeqNo;
75 extern SeqNo get_Block_seqno(ir_node *n);
78 /** Dump only irgs with names that start with this prefix. */
79 static ident *dump_file_filter_id = NULL;
81 #define ERROR_TXT "<ERROR>"
83 /*******************************************************************/
84 /* flags to steer output */
85 /*******************************************************************/
87 /** An option to turn off edge labels */
88 static int edge_label = 1;
89 /** An option to turn off dumping values of constant entities */
90 static int const_entities = 1;
91 /** An option to dump the keep alive edges */
92 static int dump_keepalive = 1;
93 /** An option to dump the new out edges */
94 static int dump_new_edges_flag = 0;
95 /** An option to dump ld_names instead of names. */
96 static int dump_ld_name = 1;
97 /** Compiler options to dump analysis information in dump_ir_graph */
98 static int dump_out_edge_flag = 0;
99 static int dump_loop_information_flag = 0;
100 static int dump_backedge_information_flag = 1;
101 /** An option to dump const-like nodes locally. */
102 static int dump_const_local = 1;
103 /** An option to dump the node index number. */
104 static int dump_node_idx_labels = 0;
105 /** An option to dump all graph anchors */
106 static int dump_anchors = 0;
107 /** An option to dump the macro block edges. */
108 static int dump_macro_block_edges = 0;
110 int dump_dominator_information_flag = 0;
111 int opt_dump_analysed_type_info = 1;
112 int opt_dump_pointer_values_to_info = 0; /* default off: for test compares!! */
114 static ird_color_t overrule_nodecolor = ird_color_default_node;
116 /** The vcg node attribute hook. */
117 static DUMP_IR_GRAPH_FUNC dump_ir_graph_hook = NULL;
118 /** The vcg node attribute hook. */
119 static DUMP_NODE_VCGATTR_FUNC dump_node_vcgattr_hook = NULL;
120 /** The vcg edge attribute hook. */
121 static DUMP_EDGE_VCGATTR_FUNC dump_edge_vcgattr_hook = NULL;
122 /** The vcg dump block edge hook */
123 static DUMP_NODE_EDGE_FUNC dump_block_edge_hook = NULL;
124 /** The vcg dump node edge hook. */
125 static DUMP_NODE_EDGE_FUNC dump_node_edge_hook = NULL;
127 /* Set the hook to be called to dump additional edges to a node. */
128 void set_dump_node_edge_hook(DUMP_NODE_EDGE_FUNC func) {
129 dump_node_edge_hook = func;
132 /* Get the additional edge dump hook. */
133 DUMP_NODE_EDGE_FUNC get_dump_node_edge_hook(void) {
134 return dump_node_edge_hook;
137 /* Set the hook to be called to dump additional edges to a block. */
138 void set_dump_block_edge_hook(DUMP_NODE_EDGE_FUNC func) {
139 dump_block_edge_hook = func;
142 /* Get the additional block edge dump hook. */
143 DUMP_NODE_EDGE_FUNC get_dump_block_edge_hook(void) {
144 return dump_node_edge_hook;
147 /* set the ir graph hook */
148 void set_dump_ir_graph_hook(DUMP_IR_GRAPH_FUNC hook) {
149 dump_ir_graph_hook = hook;
152 /* set the node attribute hook */
153 void set_dump_node_vcgattr_hook(DUMP_NODE_VCGATTR_FUNC hook) {
154 dump_node_vcgattr_hook = hook;
157 /* set the edge attribute hook */
158 void set_dump_edge_vcgattr_hook(DUMP_EDGE_VCGATTR_FUNC hook) {
159 dump_edge_vcgattr_hook = hook;
162 /** Returns 0 if dump_out_edge_flag or dump_loop_information_flag
163 * are set, else returns dump_const_local_flag.
165 static int get_opt_dump_const_local(void) {
166 if (dump_out_edge_flag || dump_loop_information_flag || (dump_new_edges_flag && edges_activated(current_ir_graph)))
168 return dump_const_local;
171 /* Set a prefix filter for output functions. */
172 void only_dump_method_with_name(ident *name) {
173 dump_file_filter_id = name;
176 /* Returns the prefix filter set with only_dump_method_with_name(). */
177 ident *get_dump_file_filter_ident(void) {
178 return dump_file_filter_id;
181 /* Returns non-zero if dump file filter is not set, or if it is a prefix of name. */
182 int is_filtered_dump_name(ident *name) {
183 if (!dump_file_filter_id) return 1;
184 return id_is_prefix(dump_file_filter_id, name);
187 /* To turn off display of edge labels. Edge labels often cause xvcg to
188 abort with a segmentation fault. */
189 void turn_off_edge_labels(void) {
193 void dump_consts_local(int flag) {
194 dump_const_local = flag;
197 void dump_node_idx_label(int flag) {
198 dump_node_idx_labels = flag;
201 void dump_constant_entity_values(int flag) {
202 const_entities = flag;
205 void dump_keepalive_edges(int flag) {
206 dump_keepalive = flag;
209 void dump_new_edges(int flag) {
210 dump_new_edges_flag = flag;
213 int get_opt_dump_keepalive_edges(void) {
214 return dump_keepalive;
217 void dump_out_edges(int flag) {
218 dump_out_edge_flag = flag;
221 void dump_dominator_information(int flag) {
222 dump_dominator_information_flag = flag;
225 void dump_loop_information(int flag) {
226 dump_loop_information_flag = flag;
229 void dump_backedge_information(int flag) {
230 dump_backedge_information_flag = flag;
233 /* Dump the information of type field specified in ana/irtypeinfo.h.
234 * If the flag is set, the type name is output in [] in the node label,
235 * else it is output as info.
237 void set_opt_dump_analysed_type_info(int flag) {
238 opt_dump_analysed_type_info = flag;
241 void dump_pointer_values_to_info(int flag) {
242 opt_dump_pointer_values_to_info = flag;
245 void dump_ld_names(int flag) {
249 void dump_all_anchors(int flag) {
253 void dump_macroblock_edges(int flag) {
254 dump_macro_block_edges = flag;
257 /* -------------- some extended helper functions ----------------- */
260 * returns the name of a mode or ERROR_TXT if mode is NOT a mode object.
261 * in the later case, sets bad.
263 const char *get_mode_name_ex(ir_mode *mode, int *bad) {
265 return get_mode_name(mode);
271 * returns the name of a type or <ERROR> if mode is NOT a mode object.
272 * in the later case, sets bad
274 const char *get_type_name_ex(ir_type *tp, int *bad) {
276 return get_type_name(tp);
281 #define CUSTOM_COLOR_BASE 100
282 static const char *color_names[ird_color_count];
283 static const char *color_rgb[ird_color_count];
284 static struct obstack color_obst;
286 static void custom_color(int num, const char *rgb_def)
288 assert(num < ird_color_count);
289 obstack_printf(&color_obst, "%d", CUSTOM_COLOR_BASE + num);
290 obstack_1grow(&color_obst, '\0');
292 color_rgb[num] = rgb_def;
293 color_names[num] = obstack_finish(&color_obst);
296 static void named_color(int num, const char *name)
298 assert(num < ird_color_count);
299 color_rgb[num] = NULL;
300 color_names[num] = name;
303 static void init_colors(void)
305 static int initialized = 0;
309 obstack_init(&color_obst);
311 custom_color(ird_color_prog_background, "204 204 204");
312 custom_color(ird_color_block_background, "255 255 0");
313 custom_color(ird_color_dead_block_background, "190 150 150");
314 named_color(ird_color_block_inout, "lightblue");
315 named_color(ird_color_default_node, "white");
316 custom_color(ird_color_memory, "153 153 255");
317 custom_color(ird_color_controlflow, "255 153 153");
318 custom_color(ird_color_const, "204 255 255");
319 custom_color(ird_color_proj, "255 255 153");
320 custom_color(ird_color_uses_memory, "153 153 255");
321 custom_color(ird_color_phi, "105 255 105");
322 custom_color(ird_color_anchor, "100 100 255");
323 named_color(ird_color_error, "red");
329 * Prints the VCG color to a file.
331 static void print_vcg_color(FILE *F, ird_color_t color) {
332 assert(color < ird_color_count);
333 fprintf(F, "color:%s", color_names[color]);
337 * Prints the edge from a type S to a type T with additional info fmt, ...
340 static void print_type_type_edge(FILE *F, ir_type *S, ir_type *T, const char *fmt, ...)
345 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(S);
346 fprintf(F, " targetname: "); PRINT_TYPEID(T);
347 vfprintf(F, fmt, ap);
353 * Prints the edge from a type T to an entity E with additional info fmt, ...
356 static void print_type_ent_edge(FILE *F, ir_type *T, ir_entity *E, const char *fmt, ...)
361 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(T);
362 fprintf(F, " targetname: \""); PRINT_ENTID(E); fprintf(F, "\"");
363 vfprintf(F, fmt, ap);
369 * Prints the edge from an entity E to an entity T with additional info fmt, ...
372 static void print_ent_ent_edge(FILE *F, ir_entity *E, ir_entity *T, int backedge, const char *fmt, ...)
378 fprintf(F, "backedge: { sourcename: \"");
380 fprintf(F, "edge: { sourcename: \"");
382 fprintf(F, "\" targetname: \""); PRINT_ENTID(T); fprintf(F, "\"");
383 vfprintf(F, fmt, ap);
389 * Prints the edge from an entity E to a type T with additional info fmt, ...
392 static void print_ent_type_edge(FILE *F, ir_entity *E, ir_type *T, const char *fmt, ...)
397 fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(E);
398 fprintf(F, "\" targetname: "); PRINT_TYPEID(T);
399 vfprintf(F, fmt, ap);
405 * Prints the edge from a node N to a type T with additional info fmt, ...
408 static void print_node_type_edge(FILE *F, const ir_node *N, ir_type *T, const char *fmt, ...)
413 fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(N);
414 fprintf(F, "\" targetname: "); PRINT_TYPEID(T);
415 vfprintf(F, fmt, ap);
421 * Prints the edge from a node N to an entity E with additional info fmt, ...
424 static void print_node_ent_edge(FILE *F, const ir_node *N, ir_entity *E, const char *fmt, ...)
429 fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(N);
430 fprintf(F, "\" targetname: \""); PRINT_ENTID(E);
432 vfprintf(F, fmt, ap);
438 * Prints the edge from an entity E to a node N with additional info fmt, ...
441 static void print_ent_node_edge(FILE *F, ir_entity *E, const ir_node *N, const char *fmt, ...)
446 fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(E);
447 fprintf(F, "\" targetname: \""); PRINT_NODEID(N); fprintf(F, "\"");
448 vfprintf(F, fmt, ap);
454 * Prints the edge from a type E to an enumeration item item with additional info fmt, ...
457 static void print_enum_item_edge(FILE *F, ir_type *E, int item, const char *fmt, ...)
462 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(E);
463 fprintf(F, " targetname: \""); PRINT_ITEMID(E, item); fprintf(F, "\" ");
464 vfprintf(F, fmt, ap);
469 /*-----------------------------------------------------------------*/
470 /* global and ahead declarations */
471 /*-----------------------------------------------------------------*/
473 static void dump_whole_node(ir_node *n, void *env);
474 static INLINE void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg);
476 /*-----------------------------------------------------------------*/
477 /* Helper functions. */
478 /*-----------------------------------------------------------------*/
481 * This map is used as a private link attr to be able to call dumper
482 * anywhere without destroying link fields.
484 static pmap *irdump_link_map = NULL;
486 /** NOT A STANDARD LIBFIRM INIT METHOD
488 * We do not want to integrate dumping into libfirm, i.e., if the dumpers
489 * are off, we want to have as few interferences as possible. Therefore the
490 * initialization is performed lazily and not called from within init_firm.
492 * Creates the link attribute map. */
493 static void init_irdump(void) {
494 /* We need a new, empty map. */
495 if (irdump_link_map) pmap_destroy(irdump_link_map);
496 irdump_link_map = pmap_create();
497 if (!dump_file_filter_id)
498 dump_file_filter_id = new_id_from_str("");
502 * Returns the private link field.
504 static void *ird_get_irn_link(ir_node *n) {
506 if (!irdump_link_map) return NULL;
508 if (pmap_contains(irdump_link_map, (void *)n))
509 res = pmap_get(irdump_link_map, (void *)n);
514 * Sets the private link field.
516 static void ird_set_irn_link(ir_node *n, void *x) {
517 if (!irdump_link_map)
519 pmap_insert(irdump_link_map, (void *)n, x);
523 * Gets the private link field of an irg.
525 static void *ird_get_irg_link(ir_graph *irg) {
527 if (!irdump_link_map) return NULL;
529 if (pmap_contains(irdump_link_map, (void *)irg))
530 res = pmap_get(irdump_link_map, (void *)irg);
535 * Sets the private link field of an irg.
537 static void ird_set_irg_link(ir_graph *irg, void *x) {
538 if (!irdump_link_map) init_irdump();
539 pmap_insert(irdump_link_map, (void *)irg, x);
543 * Walker, clears the private link field.
545 static void clear_link(ir_node * node, void * env) {
547 ird_set_irn_link(node, NULL);
551 * If the entity has a ld_name, returns it if the dump_ld_name is set,
552 * else returns the name of the entity.
554 static const char *_get_ent_dump_name(ir_entity *ent, int dump_ld_name) {
556 return "<NULL entity>";
558 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
559 if (ent->ld_name) return get_id_str(ent->ld_name);
561 return get_id_str(ent->name);
565 * If the entity has a ld_name, returns it if the option dump_ld_name is set,
566 * else returns the name of the entity.
568 const char *get_ent_dump_name(ir_entity *ent) {
569 return _get_ent_dump_name(ent, dump_ld_name);
572 /* Returns the name of an IRG. */
573 const char *get_irg_dump_name(ir_graph *irg) {
574 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
575 return _get_ent_dump_name(get_irg_entity(irg), 1);
579 * Returns non-zero if a node is in floating state.
581 static int node_floats(ir_node *n) {
582 return ((get_irn_pinned(n) == op_pin_state_floats) &&
583 (get_irg_pinned(current_ir_graph) == op_pin_state_floats));
587 * Walker that visits the anchors
589 static void ird_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env) {
590 if (dump_anchors || (dump_new_edges_flag && edges_activated(irg))) {
591 irg_walk_anchors(irg, pre, post, env);
593 irg_walk_graph(irg, pre, post, env);
598 * Walker, allocates an array for all blocks and puts it's nodes non-floating nodes into this array.
600 static void collect_node(ir_node * node, void *env) {
604 || get_irn_op(node) == op_Bad
605 || get_irn_op(node) == op_Unknown
606 || get_irn_op(node) == op_NoMem) {
607 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
608 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
609 ARR_APP1(ir_node *, arr, node);
610 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
612 ir_node * block = get_nodes_block(node);
615 /* this node is in a Bad block, so we must place it into the graph's list */
616 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
617 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
618 ARR_APP1(ir_node *, arr, node);
619 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
621 ird_set_irn_link(node, ird_get_irn_link(block));
622 ird_set_irn_link(block, node);
627 /** Construct lists to walk ir block-wise.
629 * Collects all blocks, nodes not op_pin_state_pinned,
630 * Bad, NoMem and Unknown into a flexible array in link field of
631 * irg they belong to. Sets the irg link field to NULL in all
632 * graphs not visited.
633 * Free the list with DEL_ARR_F().
635 static ir_node **construct_block_lists(ir_graph *irg) {
637 #ifdef INTERPROCEDURAL_VIEW
638 int rem_view = get_interprocedural_view();
640 int walk_flag = using_irn_visited(irg);
641 ir_graph *rem = current_ir_graph;
643 current_ir_graph = irg;
646 clear_using_irn_visited(current_ir_graph);
648 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
649 ird_set_irg_link(get_irp_irg(i), NULL);
651 ird_walk_graph(current_ir_graph, clear_link, collect_node, current_ir_graph);
653 #ifdef INTERPROCEDURAL_VIEW
654 /* Collect also EndReg and EndExcept. We do not want to change the walker. */
655 set_interprocedural_view(0);
658 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
659 irg_walk(get_irg_end_reg(current_ir_graph), clear_link, collect_node, current_ir_graph);
660 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
661 irg_walk(get_irg_end_except(current_ir_graph), clear_link, collect_node, current_ir_graph);
663 #ifdef INTERPROCEDURAL_VIEW
664 set_interprocedural_view(rem_view);
668 set_using_irn_visited(current_ir_graph);
670 current_ir_graph = rem;
671 return ird_get_irg_link(irg);
674 typedef struct _list_tuple {
676 ir_extblk **extbb_list;
679 /** Construct lists to walk IR extended block-wise.
680 * Free the lists in the tuple with DEL_ARR_F().
681 * Sets the irg link field to NULL in all
682 * graphs not visited.
684 static list_tuple *construct_extblock_lists(ir_graph *irg) {
685 ir_node **blk_list = construct_block_lists(irg);
687 ir_graph *rem = current_ir_graph;
688 list_tuple *lists = xmalloc(sizeof(*lists));
690 current_ir_graph = irg;
692 lists->blk_list = NEW_ARR_F(ir_node *, 0);
693 lists->extbb_list = NEW_ARR_F(ir_extblk *, 0);
695 inc_irg_block_visited(irg);
696 for (i = ARR_LEN(blk_list) - 1; i >= 0; --i) {
699 if (is_Block(blk_list[i])) {
700 ext = get_Block_extbb(blk_list[i]);
702 if (extbb_not_visited(ext)) {
703 ARR_APP1(ir_extblk *, lists->extbb_list, ext);
704 mark_extbb_visited(ext);
707 ARR_APP1(ir_node *, lists->blk_list, blk_list[i]);
711 current_ir_graph = rem;
712 ird_set_irg_link(irg, lists);
716 /*-----------------------------------------------------------------*/
717 /* Routines to dump information about a single ir node. */
718 /*-----------------------------------------------------------------*/
721 * dump the name of a node n to the File F.
723 int dump_node_opcode(FILE *F, ir_node *n)
726 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
728 /* call the dump_node operation if available */
730 return ops->dump_node(n, F, dump_node_opcode_txt);
732 /* implementation for default nodes */
733 switch (get_irn_opcode(n)) {
738 res = tarval_snprintf(buf, sizeof(buf), get_Const_tarval(n));
739 assert(res < (int) sizeof(buf) && "buffer to small for tarval_snprintf");
744 switch (get_SymConst_kind(n)) {
745 case symconst_addr_name:
746 /* don't use get_SymConst_ptr_info as it mangles the name. */
747 fprintf(F, "SymC %s", get_id_str(get_SymConst_name(n)));
749 case symconst_addr_ent:
750 fprintf(F, "SymC &%s", get_entity_name(get_SymConst_entity(n)));
752 case symconst_ofs_ent:
753 fprintf(F, "SymC %s offset", get_entity_name(get_SymConst_entity(n)));
755 case symconst_type_tag:
756 fprintf(F, "SymC %s tag", get_type_name_ex(get_SymConst_type(n), &bad));
758 case symconst_type_size:
759 fprintf(F, "SymC %s size", get_type_name_ex(get_SymConst_type(n), &bad));
761 case symconst_type_align:
762 fprintf(F, "SymC %s align", get_type_name_ex(get_SymConst_type(n), &bad));
764 case symconst_enum_const:
765 fprintf(F, "SymC %s enum", get_enumeration_name(get_SymConst_enum(n)));
768 fprintf(F, "SymC %lu label", get_SymConst_label(n));
774 if (!get_interprocedural_view())
781 ir_node *pred = get_Proj_pred(n);
783 if (get_irn_opcode(pred) == iro_Cond
784 && get_Proj_proj(n) == get_Cond_defaultProj(pred)
785 && get_irn_mode(get_Cond_selector(pred)) != mode_b)
786 fprintf(F, "defProj");
794 if (get_interprocedural_view()) {
795 fprintf(F, "%s %s", get_irn_opname(n), get_ent_dump_name(get_irg_entity(get_irn_irg(n))));
800 case iro_CallBegin: {
801 ir_node *addr = get_CallBegin_ptr(n);
802 ir_entity *ent = NULL;
803 if (get_irn_op(addr) == op_Sel)
804 ent = get_Sel_entity(addr);
805 else if (is_SymConst_addr_ent(addr))
806 ent = get_SymConst_entity(addr);
807 fprintf(F, "%s", get_irn_opname(n));
808 if (ent) fprintf(F, " %s", get_entity_name(ent));
812 if (get_Load_align(n) == align_non_aligned)
814 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Load_mode(n), &bad));
817 if (get_Store_align(n) == align_non_aligned)
819 fprintf(F, "%s", get_irn_opname(n));
822 fprintf(F, "%s%s", is_Block_dead(n) ? "Dead " : "", get_irn_opname(n));
825 if (get_Conv_strict(n))
826 fprintf(F, "strict");
827 fprintf(F, "%s", get_irn_opname(n));
830 fprintf(F, "%s", get_irn_opname(n));
831 if (is_Div_remainderless(n))
833 fprintf(F, "[%s]", get_mode_name_ex(get_Div_resmode(n), &bad));
836 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Mod_resmode(n), &bad));
839 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_DivMod_resmode(n), &bad));
844 fprintf(F, "%s", get_irn_opname(n));
851 * Dump the mode of a node n to a file F.
852 * Ignore modes that are "always known".
854 static int dump_node_mode(FILE *F, ir_node *n)
857 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
860 /* call the dump_node operation if available */
862 return ops->dump_node(n, F, dump_node_mode_txt);
864 /* default implementation */
865 iro = get_irn_opcode(n);
877 ir_mode *mode = get_irn_mode(n);
879 if (mode && mode != mode_BB && mode != mode_ANY && mode != mode_BAD &&
880 (mode != mode_T || iro == iro_Proj))
881 fprintf(F, "%s", get_mode_name_ex(mode, &bad));
889 * Dump the type of a node n to a file F if it's known.
891 static int dump_node_typeinfo(FILE *F, ir_node *n) {
894 if (opt_dump_analysed_type_info) {
895 if (get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_consistent ||
896 get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_inconsistent) {
897 ir_type *tp = get_irn_typeinfo_type(n);
898 if (tp != firm_none_type)
899 fprintf(F, "[%s] ", get_type_name_ex(tp, &bad));
907 typedef struct _pns_lookup {
908 long nr; /**< the proj number */
909 const char *name; /**< the name of the Proj */
912 typedef struct _proj_lookup {
913 ir_opcode code; /**< the opcode of the Proj predecessor */
914 unsigned num_data; /**< number of data entries */
915 const pns_lookup_t *data; /**< the data */
918 #define ARR_SIZE(a) (sizeof(a)/sizeof(a[0]))
920 /** the lookup table for Proj(Start) names */
921 static const pns_lookup_t start_lut[] = {
922 #define X(a) { pn_Start_##a, #a }
932 /** the lookup table for Proj(Cond) names */
933 static const pns_lookup_t cond_lut[] = {
934 #define X(a) { pn_Cond_##a, #a }
940 /** the lookup table for Proj(Call) names */
941 static const pns_lookup_t call_lut[] = {
942 #define X(a) { pn_Call_##a, #a }
952 /** the lookup table for Proj(Quot) names */
953 static const pns_lookup_t quot_lut[] = {
954 #define X(a) { pn_Quot_##a, #a }
962 /** the lookup table for Proj(DivMod) names */
963 static const pns_lookup_t divmod_lut[] = {
964 #define X(a) { pn_DivMod_##a, #a }
973 /** the lookup table for Proj(Div) names */
974 static const pns_lookup_t div_lut[] = {
975 #define X(a) { pn_Div_##a, #a }
983 /** the lookup table for Proj(Mod) names */
984 static const pns_lookup_t mod_lut[] = {
985 #define X(a) { pn_Mod_##a, #a }
993 /** the lookup table for Proj(Load) names */
994 static const pns_lookup_t load_lut[] = {
995 #define X(a) { pn_Load_##a, #a }
1003 /** the lookup table for Proj(Store) names */
1004 static const pns_lookup_t store_lut[] = {
1005 #define X(a) { pn_Store_##a, #a }
1012 /** the lookup table for Proj(Alloc) names */
1013 static const pns_lookup_t alloc_lut[] = {
1014 #define X(a) { pn_Alloc_##a, #a }
1022 /** the lookup table for Proj(CopyB) names */
1023 static const pns_lookup_t copyb_lut[] = {
1024 #define X(a) { pn_CopyB_##a, #a }
1032 /** the lookup table for Proj(InstOf) names */
1033 static const pns_lookup_t instof_lut[] = {
1034 #define X(a) { pn_InstOf_##a, #a }
1043 /** the lookup table for Proj(Raise) names */
1044 static const pns_lookup_t raise_lut[] = {
1045 #define X(a) { pn_Raise_##a, #a }
1051 /** the lookup table for Proj(Bound) names */
1052 static const pns_lookup_t bound_lut[] = {
1053 #define X(a) { pn_Bound_##a, #a }
1061 /** the Proj lookup table */
1062 static const proj_lookup_t proj_lut[] = {
1063 #define E(a) ARR_SIZE(a), a
1064 { iro_Start, E(start_lut) },
1065 { iro_Cond, E(cond_lut) },
1066 { iro_Call, E(call_lut) },
1067 { iro_Quot, E(quot_lut) },
1068 { iro_DivMod, E(divmod_lut) },
1069 { iro_Div, E(div_lut) },
1070 { iro_Mod, E(mod_lut) },
1071 { iro_Load, E(load_lut) },
1072 { iro_Store, E(store_lut) },
1073 { iro_Alloc, E(alloc_lut) },
1074 { iro_CopyB, E(copyb_lut) },
1075 { iro_InstOf, E(instof_lut) },
1076 { iro_Raise, E(raise_lut) },
1077 { iro_Bound, E(bound_lut) }
1082 * Dump additional node attributes of some nodes to a file F.
1085 dump_node_nodeattr(FILE *F, ir_node *n)
1091 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1093 /* call the dump_node operation if available */
1095 return ops->dump_node(n, F, dump_node_nodeattr_txt);
1097 switch (get_irn_opcode(n)) {
1099 if (0 && get_interprocedural_view()) {
1100 fprintf(F, "%s ", get_ent_dump_name(get_irg_entity(current_ir_graph)));
1105 pred = get_Proj_pred(n);
1106 proj_nr = get_Proj_proj(n);
1108 code = get_irn_opcode(pred);
1110 if (code == iro_Cmp)
1111 fprintf(F, "%s ", get_pnc_string(get_Proj_proj(n)));
1112 else if (code == iro_Proj && get_irn_opcode(get_Proj_pred(pred)) == iro_Start)
1113 fprintf(F, "Arg %ld ", proj_nr);
1114 else if (code == iro_Cond && get_irn_mode(get_Cond_selector(pred)) != mode_b)
1115 fprintf(F, "%ld ", proj_nr);
1117 unsigned i, j, f = 0;
1119 for (i = 0; i < ARR_SIZE(proj_lut); ++i) {
1120 if (code == proj_lut[i].code) {
1121 for (j = 0; j < proj_lut[i].num_data; ++j) {
1122 if (proj_nr == proj_lut[i].data[j].nr) {
1123 fprintf(F, "%s ", proj_lut[i].data[j].name);
1132 fprintf(F, "%ld ", proj_nr);
1133 if (code == iro_Cond && get_Cond_jmp_pred(pred) != COND_JMP_PRED_NONE) {
1134 if (proj_nr == pn_Cond_false && get_Cond_jmp_pred(pred) == COND_JMP_PRED_FALSE)
1135 fprintf(F, "PRED ");
1136 if (proj_nr == pn_Cond_true && get_Cond_jmp_pred(pred) == COND_JMP_PRED_TRUE)
1137 fprintf(F, "PRED ");
1142 proj_nr = get_Filter_proj(n);
1143 if (! get_interprocedural_view()) {
1145 pred = get_Filter_pred(n);
1148 fprintf(F, "%ld ", proj_nr);
1151 fprintf(F, "%s ", get_ent_dump_name(get_Sel_entity(n)));
1154 fprintf(F, "(%s) ", get_type_name_ex(get_Cast_type(n), &bad));
1157 fprintf(F, "%s ", get_pnc_string(get_Confirm_cmp(n)));
1160 fprintf(F, "(%s) ", get_type_name_ex(get_CopyB_type(n), &bad));
1171 #include "execution_frequency.h"
1173 static void dump_node_ana_vals(FILE *F, ir_node *n) {
1177 #ifdef INTERPROCEDURAL_VIEW
1178 fprintf(F, " %lf*(%2.0lf + %2.0lf) = %2.0lf ",
1179 get_irn_exec_freq(n),
1180 get_irg_method_execution_frequency(get_irn_irg(n)),
1181 pow(5, get_irg_recursion_depth(get_irn_irg(n))),
1182 get_irn_exec_freq(n) * (get_irg_method_execution_frequency(get_irn_irg(n)) + pow(5, get_irg_recursion_depth(get_irn_irg(n))))
1188 /* Dumps a node label without the enclosing ". */
1189 int dump_node_label(FILE *F, ir_node *n) {
1192 bad |= dump_node_opcode(F, n);
1193 bad |= dump_node_mode(F, n);
1195 bad |= dump_node_typeinfo(F, n);
1196 bad |= dump_node_nodeattr(F, n);
1197 if(dump_node_idx_labels) {
1198 fprintf(F, "%ld:%d", get_irn_node_nr(n), get_irn_idx(n));
1200 fprintf(F, "%ld", get_irn_node_nr(n));
1207 * Dumps the attributes of a node n into the file F.
1208 * Currently this is only the color of a node.
1210 static void dump_node_vcgattr(FILE *F, ir_node *node, ir_node *local, int bad)
1216 print_vcg_color(F, ird_color_error);
1220 if (dump_node_vcgattr_hook)
1221 if (dump_node_vcgattr_hook(F, node, local))
1224 n = local ? local : node;
1226 if (overrule_nodecolor != ird_color_default_node) {
1227 print_vcg_color(F, overrule_nodecolor);
1231 mode = get_irn_mode(node);
1232 if(mode == mode_M) {
1233 print_vcg_color(F, ird_color_memory);
1236 if(mode == mode_X) {
1237 print_vcg_color(F, ird_color_controlflow);
1241 switch (get_irn_opcode(n)) {
1246 print_vcg_color(F, ird_color_anchor);
1249 print_vcg_color(F, ird_color_error);
1252 if (is_Block_dead(n))
1253 print_vcg_color(F, ird_color_dead_block_background);
1255 print_vcg_color(F, ird_color_block_background);
1258 print_vcg_color(F, ird_color_phi);
1261 print_vcg_color(F, ird_color_memory);
1265 print_vcg_color(F, ird_color_const);
1268 print_vcg_color(F, ird_color_proj);
1271 ir_op *op = get_irn_op(node);
1273 if(is_op_constlike(op)) {
1274 print_vcg_color(F, ird_color_const);
1275 } else if(is_op_uses_memory(op)) {
1276 print_vcg_color(F, ird_color_uses_memory);
1277 } else if(is_op_cfopcode(op) || is_op_forking(op)) {
1278 print_vcg_color(F, ird_color_controlflow);
1280 PRINT_DEFAULT_NODE_ATTR;
1286 /* Adds a new node info dumper callback. */
1287 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data)
1289 hook_entry_t *info = xmalloc(sizeof(*info));
1291 info->hook._hook_node_info = cb;
1292 info->context = data;
1293 register_hook(hook_node_info, info);
1298 /* Remove a previously added info dumper callback. */
1299 void dump_remv_node_info_callback(void *handle)
1301 hook_entry_t *info = handle;
1302 unregister_hook(hook_node_info, info);
1307 * Dump the node information of a node n to a file F.
1309 static INLINE int dump_node_info(FILE *F, ir_node *n)
1312 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1314 fprintf(F, " info1: \"");
1315 bad = dump_irnode_to_file(F, n);
1316 /* call the dump_node operation if available */
1318 bad = ops->dump_node(n, F, dump_node_info_txt);
1320 /* allow additional info to be added */
1321 hook_node_info(F, n);
1327 static INLINE int is_constlike_node(const ir_node *node)
1329 const ir_op *op = get_irn_op(node);
1330 return is_op_constlike(op);
1334 /** outputs the predecessors of n, that are constants, local. I.e.,
1335 generates a copy of the constant predecessors for each node called with. */
1336 static void dump_const_node_local(FILE *F, ir_node *n) {
1338 if (!get_opt_dump_const_local()) return;
1340 /* Use visited flag to avoid outputting nodes twice.
1341 initialize it first. */
1342 for (i = 0; i < get_irn_arity(n); i++) {
1343 ir_node *con = get_irn_n(n, i);
1344 if (is_constlike_node(con)) {
1345 set_irn_visited(con, get_irg_visited(current_ir_graph) - 1);
1349 for (i = 0; i < get_irn_arity(n); i++) {
1350 ir_node *con = get_irn_n(n, i);
1351 if (is_constlike_node(con) && irn_not_visited(con)) {
1354 mark_irn_visited(con);
1355 /* Generate a new name for the node by appending the names of
1357 fprintf(F, "node: {title: "); PRINT_CONSTID(n, con);
1358 fprintf(F, " label: \"");
1359 bad |= dump_node_label(F, con);
1361 bad |= dump_node_info(F, con);
1362 dump_node_vcgattr(F, n, con, bad);
1368 /** If the block of an edge is a const_like node, dump it local with an edge */
1369 static void dump_const_block_local(FILE *F, ir_node *n) {
1372 if (!get_opt_dump_const_local()) return;
1374 blk = get_nodes_block(n);
1375 if (is_constlike_node(blk)) {
1378 /* Generate a new name for the node by appending the names of
1380 fprintf(F, "node: {title: \""); PRINT_CONSTBLKID(n, blk);
1381 fprintf(F, "\" label: \"");
1382 bad |= dump_node_label(F, blk);
1384 bad |= dump_node_info(F, blk);
1385 dump_node_vcgattr(F, n, blk, bad);
1388 fprintf(F, "edge: { sourcename: \"");
1390 fprintf(F, "\" targetname: \""); PRINT_CONSTBLKID(n,blk);
1392 if (dump_edge_vcgattr_hook) {
1394 if (dump_edge_vcgattr_hook(F, n, -1)) {
1398 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1403 fprintf(F, "\" " BLOCK_EDGE_ATTR "}\n");
1408 * prints the error message of a node to a file F as info2.
1410 static void print_node_error(FILE *F, const char *err_msg)
1415 fprintf(F, " info2: \"%s\"", err_msg);
1419 * prints debug messages of a node to file F as info3.
1421 static void print_dbg_info(FILE *F, dbg_info *dbg)
1425 if (__dbg_info_snprint) {
1427 if (__dbg_info_snprint(buf, sizeof(buf), dbg) > 0)
1428 fprintf(F, " info3: \"%s\"\n", buf);
1435 static void dump_node(FILE *F, ir_node *n)
1440 if (get_opt_dump_const_local() && is_constlike_node(n))
1443 /* dump this node */
1444 fprintf(F, "node: {title: \""); PRINT_NODEID(n); fprintf(F, "\" label: \"");
1446 bad = ! irn_vrfy_irg_dump(n, current_ir_graph, &p);
1447 bad |= dump_node_label(F, n);
1448 dump_node_ana_vals(F, n);
1449 //dump_node_ana_info(F, n);
1451 bad |= dump_node_info(F, n);
1452 print_node_error(F, p);
1453 print_dbg_info(F, get_irn_dbg_info(n));
1454 dump_node_vcgattr(F, n, NULL, bad);
1456 dump_const_node_local(F, n);
1458 if(dump_node_edge_hook)
1459 dump_node_edge_hook(F, n);
1461 dump_irn_chi_term(F, n);
1462 dump_irn_state(F, n);
1466 /** dump the edge to the block this node belongs to */
1468 dump_ir_block_edge(FILE *F, ir_node *n) {
1469 if (get_opt_dump_const_local() && is_constlike_node(n)) return;
1470 if (is_no_Block(n)) {
1471 ir_node *block = get_nodes_block(n);
1473 if (get_opt_dump_const_local() && is_constlike_node(block)) {
1474 dump_const_block_local(F, n);
1476 fprintf(F, "edge: { sourcename: \"");
1478 fprintf(F, "\" targetname: ");
1479 fprintf(F, "\""); PRINT_NODEID(block); fprintf(F, "\"");
1481 if (dump_edge_vcgattr_hook) {
1483 if (dump_edge_vcgattr_hook(F, n, -1)) {
1487 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1492 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1498 print_data_edge_vcgattr(FILE *F, ir_node *from, int to) {
1500 * do not use get_nodes_block() here, will fail
1501 * if the irg is not pinned.
1503 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1504 fprintf(F, INTRA_DATA_EDGE_ATTR);
1506 fprintf(F, INTER_DATA_EDGE_ATTR);
1510 print_mem_edge_vcgattr(FILE *F, ir_node *from, int to) {
1512 * do not use get_nodes_block() here, will fail
1513 * if the irg is not pinned.
1515 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1516 fprintf(F, INTRA_MEM_EDGE_ATTR);
1518 fprintf(F, INTER_MEM_EDGE_ATTR);
1521 /** Print the vcg attributes for the edge from node from to it's to's input */
1522 static void print_edge_vcgattr(FILE *F, ir_node *from, int to) {
1525 if (dump_edge_vcgattr_hook)
1526 if (dump_edge_vcgattr_hook(F, from, to))
1529 if (dump_backedge_information_flag && is_backedge(from, to))
1530 fprintf(F, BACK_EDGE_ATTR);
1532 switch (get_irn_opcode(from)) {
1534 fprintf(F, CF_EDGE_ATTR);
1536 case iro_Start: break;
1539 if (get_irn_mode(get_End_keepalive(from, to)) == mode_BB)
1540 fprintf(F, KEEP_ALIVE_CF_EDGE_ATTR);
1542 fprintf(F, KEEP_ALIVE_DF_EDGE_ATTR);
1546 if (is_Proj(from)) {
1547 if (get_irn_mode(from) == mode_M)
1548 print_mem_edge_vcgattr(F, from, to);
1549 else if (get_irn_mode(from) == mode_X)
1550 fprintf(F, CF_EDGE_ATTR);
1552 print_data_edge_vcgattr(F, from, to);
1554 else if (get_irn_mode(get_irn_n(from, to)) == mode_M)
1555 print_mem_edge_vcgattr(F, from, to);
1556 else if (get_irn_mode(get_irn_n(from, to)) == mode_X)
1557 fprintf(F, CF_EDGE_ATTR);
1559 print_data_edge_vcgattr(F, from, to);
1563 /** dump edges to our inputs */
1564 static void dump_ir_data_edges(FILE *F, ir_node *n) {
1566 unsigned long visited = get_irn_visited(n);
1568 if (!dump_keepalive && is_End(n)) {
1569 /* the End node has only keep-alive edges */
1573 /* dump the dependency edges. */
1574 num = get_irn_deps(n);
1575 for (i = 0; i < num; ++i) {
1576 ir_node *dep = get_irn_dep(n, i);
1579 fprintf(F, "edge: {sourcename: \"");
1581 fprintf(F, "\" targetname: ");
1582 if ((get_opt_dump_const_local()) && is_constlike_node(dep)) {
1583 PRINT_CONSTID(n, dep);
1589 fprintf(F, " label: \"%d\" ", i);
1590 fprintf(F, " color: darkgreen}\n");
1594 num = get_irn_arity(n);
1595 for (i = 0; i < num; i++) {
1596 ir_node *pred = get_irn_n(n, i);
1599 if ((get_interprocedural_view() && get_irn_visited(pred) < visited))
1600 continue; /* pred not dumped */
1602 if (dump_backedge_information_flag && is_backedge(n, i))
1603 fprintf(F, "backedge: {sourcename: \"");
1605 fprintf(F, "edge: {sourcename: \"");
1607 fprintf(F, "\" targetname: ");
1608 if ((get_opt_dump_const_local()) && is_constlike_node(pred)) {
1609 PRINT_CONSTID(n, pred);
1611 fprintf(F, "\""); PRINT_NODEID(pred); fprintf(F, "\"");
1613 fprintf(F, " label: \"%d\" ", i);
1614 print_edge_vcgattr(F, n, i);
1618 if (dump_macro_block_edges && is_Block(n)) {
1619 ir_node *mb = get_Block_MacroBlock(n);
1620 fprintf(F, "edge: {sourcename: \"");
1622 fprintf(F, "\" targetname: \"");
1624 fprintf(F, "\" label: \"mb\" " MACROBLOCK_EDGE_ATTR);
1633 dump_ir_edges(FILE *F, ir_node *n) {
1634 const ir_edge_t *edge;
1637 foreach_out_edge(n, edge) {
1638 ir_node *succ = get_edge_src_irn(edge);
1640 fprintf(F, "edge: {sourcename: \"");
1642 fprintf(F, "\" targetname: \"");
1646 fprintf(F, " label: \"%d\" ", i);
1647 fprintf(F, OUT_EDGE_ATTR);
1654 /** Dumps a node and its edges but not the block edge */
1655 static void dump_node_wo_blockedge(ir_node *n, void *env) {
1658 dump_ir_data_edges(F, n);
1661 /** Dumps a node and its edges. */
1662 static void dump_whole_node(ir_node *n, void *env) {
1664 dump_node_wo_blockedge(n, env);
1665 if (!node_floats(n))
1666 dump_ir_block_edge(F, n);
1667 if (dump_new_edges_flag && edges_activated(current_ir_graph))
1668 dump_ir_edges(F, n);
1671 /** Dumps a const-like node. */
1672 static void dump_const_node(ir_node *n, void *env) {
1673 if (is_Block(n)) return;
1674 dump_node_wo_blockedge(n, env);
1677 /***********************************************************************/
1678 /* the following routines dump the nodes/irgs bracketed to graphs. */
1679 /***********************************************************************/
1681 /** Dumps a constant expression as entity initializer, array bound ...
1683 static void dump_const_expression(FILE *F, ir_node *value) {
1684 ir_graph *rem = current_ir_graph;
1685 int rem_dump_const_local = dump_const_local;
1686 dump_const_local = 0;
1687 current_ir_graph = get_const_code_irg();
1688 irg_walk(value, dump_const_node, NULL, F);
1689 /* Decrease visited flag so that we walk with the same flag for the next
1690 expression. This guarantees that we don't dump the same node twice,
1691 as for const expressions cse is performed to save memory. */
1692 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph) -1);
1693 current_ir_graph = rem;
1694 dump_const_local = rem_dump_const_local;
1697 /** Dump a block as graph containing its nodes.
1699 * Expects to find nodes belonging to the block as list in its
1701 * Dumps the edges of all nodes including itself. */
1702 static void dump_whole_block(FILE *F, ir_node *block) {
1704 ird_color_t color = ird_color_block_background;
1706 assert(is_Block(block));
1708 fprintf(F, "graph: { title: \"");
1709 PRINT_NODEID(block);
1710 fprintf(F, "\" label: \"");
1711 dump_node_label(F, block);
1713 if (get_opt_dump_abstvals())
1714 fprintf(F, " seqno: %d", (int)get_Block_seqno(block));
1717 /* colorize blocks */
1718 if (! get_Block_matured(block))
1719 color = ird_color_block_background;
1720 if (is_Block_dead(block))
1721 color = ird_color_dead_block_background;
1723 fprintf(F, "\" status:clustered ");
1724 print_vcg_color(F, color);
1727 /* yComp can show attributes for blocks, XVCG parses but ignores them */
1728 dump_node_info(F, block);
1729 print_dbg_info(F, get_irn_dbg_info(block));
1731 /* dump the blocks edges */
1732 dump_ir_data_edges(F, block);
1734 if (dump_block_edge_hook)
1735 dump_block_edge_hook(F, block);
1737 /* dump the nodes that go into the block */
1738 for (node = ird_get_irn_link(block); node; node = ird_get_irn_link(node)) {
1740 dump_ir_data_edges(F, node);
1743 /* Close the vcg information for the block */
1745 dump_const_node_local(F, block);
1747 dump_irn_chi_term(F, block);
1752 /** dumps a graph block-wise. Expects all blockless nodes in arr in irgs link.
1753 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1755 dump_block_graph(FILE *F, ir_graph *irg) {
1757 ir_graph *rem = current_ir_graph;
1758 ir_node **arr = ird_get_irg_link(irg);
1759 current_ir_graph = irg;
1761 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1762 ir_node * node = arr[i];
1763 if (is_Block(node)) {
1764 /* Dumps the block and all the nodes in the block, which are to
1765 be found in Block->link. */
1766 dump_whole_block(F, node);
1768 /* Nodes that are not in a Block. */
1770 if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
1771 dump_const_block_local(F, node);
1773 dump_ir_data_edges(F, node);
1775 if (dump_new_edges_flag && edges_activated(irg))
1776 dump_ir_edges(F, node);
1779 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1780 dump_loop_nodes_into_graph(F, irg);
1782 current_ir_graph = rem;
1786 * Dump the info for an irg.
1787 * Parsed by XVCG but not shown. use yComp.
1789 static void dump_graph_info(FILE *F, ir_graph *irg) {
1790 fprintf(F, "info1: \"");
1791 dump_entity_to_file(F, get_irg_entity(irg), dump_verbosity_entattrs | dump_verbosity_entconsts);
1795 /** Dumps an irg as a graph clustered by block nodes.
1796 * If interprocedural view edges can point to nodes out of this graph.
1798 static void dump_graph_from_list(FILE *F, ir_graph *irg) {
1799 ir_entity *ent = get_irg_entity(irg);
1801 fprintf(F, "graph: { title: \"");
1803 fprintf(F, "\" label: \"%s\" status:clustered color:%s \n",
1804 get_ent_dump_name(ent), color_names[ird_color_prog_background]);
1806 dump_graph_info(F, irg);
1807 print_dbg_info(F, get_entity_dbg_info(ent));
1809 dump_block_graph(F, irg);
1811 /* Close the vcg information for the irg */
1812 fprintf(F, "}\n\n");
1815 /** dumps a graph extended block-wise. Expects all blockless nodes in arr in irgs link.
1816 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1818 dump_extblock_graph(FILE *F, ir_graph *irg) {
1820 ir_graph *rem = current_ir_graph;
1821 ir_extblk **arr = ird_get_irg_link(irg);
1822 current_ir_graph = irg;
1824 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1825 ir_extblk *extbb = arr[i];
1826 ir_node *leader = get_extbb_leader(extbb);
1829 fprintf(F, "graph: { title: \"");
1830 PRINT_EXTBBID(leader);
1831 fprintf(F, "\" label: \"ExtBB %ld\" status:clustered color:lightgreen\n",
1832 get_irn_node_nr(leader));
1834 for (j = ARR_LEN(extbb->blks) - 1; j >= 0; --j) {
1835 ir_node * node = extbb->blks[j];
1836 if (is_Block(node)) {
1837 /* Dumps the block and all the nodes in the block, which are to
1838 be found in Block->link. */
1839 dump_whole_block(F, node);
1841 /* Nodes that are not in a Block. */
1843 if (is_Bad(get_nodes_block(node)) && !node_floats(node)) {
1844 dump_const_block_local(F, node);
1846 dump_ir_data_edges(F, node);
1852 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1853 dump_loop_nodes_into_graph(F, irg);
1855 current_ir_graph = rem;
1860 /*******************************************************************/
1861 /* Basic type and entity nodes and edges. */
1862 /*******************************************************************/
1864 /** dumps the edges between nodes and their type or entity attributes. */
1865 static void dump_node2type_edges(ir_node *n, void *env)
1870 switch (get_irn_opcode(n)) {
1872 /* @@@ some consts have an entity */
1875 if (SYMCONST_HAS_TYPE(get_SymConst_kind(n)))
1876 print_node_type_edge(F,n,get_SymConst_type(n),NODE2TYPE_EDGE_ATTR);
1879 print_node_ent_edge(F,n,get_Sel_entity(n),NODE2TYPE_EDGE_ATTR);
1882 print_node_type_edge(F,n,get_Call_type(n),NODE2TYPE_EDGE_ATTR);
1885 print_node_type_edge(F,n,get_Alloc_type(n),NODE2TYPE_EDGE_ATTR);
1888 print_node_type_edge(F,n,get_Free_type(n),NODE2TYPE_EDGE_ATTR);
1891 print_node_type_edge(F,n,get_Cast_type(n),NODE2TYPE_EDGE_ATTR);
1899 static int print_type_info(FILE *F, ir_type *tp) {
1902 if (get_type_state(tp) == layout_undefined) {
1903 fprintf(F, "state: layout_undefined\n");
1905 fprintf(F, "state: layout_fixed,\n");
1907 if (get_type_mode(tp))
1908 fprintf(F, "mode: %s,\n", get_mode_name_ex(get_type_mode(tp), &bad));
1909 fprintf(F, "size: %db,\n", get_type_size_bits(tp));
1914 static void print_typespecific_info(FILE *F, ir_type *tp) {
1915 switch (get_type_tpop_code(tp)) {
1917 fprintf(F, "peculiarity: %s\n", get_peculiarity_string(get_class_peculiarity(tp)));
1922 fprintf(F, "variadicity: %s\n", get_variadicity_name(get_method_variadicity(tp)));
1923 fprintf(F, "params: %d\n", get_method_n_params(tp));
1924 fprintf(F, "results: %d\n", get_method_n_ress(tp));
1930 case tpo_enumeration:
1942 static void print_typespecific_vcgattr(FILE *F, ir_type *tp) {
1943 switch (get_type_tpop_code(tp)) {
1945 if (peculiarity_existent == get_class_peculiarity(tp))
1946 fprintf(F, " " TYPE_CLASS_NODE_ATTR);
1948 fprintf(F, " " TYPE_DESCRIPTION_NODE_ATTR);
1951 fprintf(F, " " TYPE_METH_NODE_ATTR);
1959 case tpo_enumeration:
1971 int dump_type_node(FILE *F, ir_type *tp)
1975 fprintf(F, "node: {title: ");
1977 fprintf(F, " label: \"%s %s\"", get_type_tpop_name(tp), get_type_name_ex(tp, &bad));
1978 fprintf(F, " info1: \"");
1980 bad |= print_type_info(F, tp);
1981 print_typespecific_info(F, tp);
1983 dump_type_to_file(F, tp, dump_verbosity_max);
1986 print_dbg_info(F, get_type_dbg_info(tp));
1987 print_typespecific_vcgattr(F, tp);
1994 void dump_entity_node(FILE *F, ir_entity *ent, int color)
1996 fprintf(F, "node: {title: \"");
1997 PRINT_ENTID(ent); fprintf(F, "\"");
1998 fprintf(F, DEFAULT_TYPE_ATTRIBUTE);
1999 fprintf(F, "label: ");
2000 fprintf(F, "\"ent %s\" ", get_ent_dump_name(ent));
2002 fprintf(F, "color:%d", color);
2004 fprintf(F, ENTITY_NODE_ATTR);
2005 fprintf(F, "\n info1: \"");
2007 dump_entity_to_file(F, ent, dump_verbosity_entattrs | dump_verbosity_entconsts);
2010 print_dbg_info(F, get_entity_dbg_info(ent));
2014 static void dump_enum_item(FILE *F, ir_type *tp, int pos)
2017 ir_enum_const *ec = get_enumeration_const(tp, pos);
2018 ident *id = get_enumeration_nameid(ec);
2019 tarval *tv = get_enumeration_value(ec);
2022 tarval_snprintf(buf, sizeof(buf), tv);
2024 strncpy(buf, "<not set>", sizeof(buf));
2025 fprintf(F, "node: {title: \"");
2026 PRINT_ITEMID(tp, pos); fprintf(F, "\"");
2027 fprintf(F, DEFAULT_ENUM_ITEM_ATTRIBUTE);
2028 fprintf(F, "label: ");
2029 fprintf(F, "\"enum item %s\" " ENUM_ITEM_NODE_ATTR, get_id_str(id));
2030 fprintf(F, "\n info1: \"value: %s\"}\n", buf);
2033 /* dumps a type or entity and it's edges. */
2035 dump_type_info(type_or_ent *tore, void *env) {
2037 int i = 0; /* to shutup gcc */
2039 /* dump this type or entity */
2041 switch (get_kind(tore)) {
2043 ir_entity *ent = (ir_entity *)tore;
2046 dump_entity_node(F, ent, 0);
2048 /* skip this to reduce graph. Member edge of type is parallel to this edge. *
2049 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2050 ENT_OWN_EDGE_ATTR "}\n", ent, get_entity_owner(ent));*/
2051 print_ent_type_edge(F,ent, get_entity_type(ent), ENT_TYPE_EDGE_ATTR);
2052 if (is_Class_type(get_entity_owner(ent))) {
2053 for(i = 0; i < get_entity_n_overwrites(ent); i++)
2054 print_ent_ent_edge(F,ent, get_entity_overwrites(ent, i), 0, ENT_OVERWRITES_EDGE_ATTR);
2056 /* attached subgraphs */
2057 if (const_entities && (get_entity_variability(ent) != variability_uninitialized)) {
2058 if (is_atomic_entity(ent)) {
2059 value = get_atomic_ent_value(ent);
2061 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2062 /* DDMN(value); $$$ */
2063 dump_const_expression(F, value);
2066 if (is_compound_entity(ent)) {
2067 for (i = 0; i < get_compound_ent_n_values(ent); i++) {
2068 value = get_compound_ent_value(ent, i);
2070 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2071 dump_const_expression(F, value);
2072 print_ent_ent_edge(F, ent, get_compound_ent_value_member(ent, i), 0, ENT_CORR_EDGE_ATTR, i);
2074 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2075 ENT_CORR_EDGE_ATTR "}\n", GET_ENTID(ent),
2076 get_compound_ent_value_member(ent, i), i);
2085 ir_type *tp = (ir_type *)tore;
2086 dump_type_node(F, tp);
2087 /* and now the edges */
2088 switch (get_type_tpop_code(tp)) {
2090 for (i=0; i < get_class_n_supertypes(tp); i++)
2091 print_type_type_edge(F, tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2092 for (i=0; i < get_class_n_members(tp); i++)
2093 print_type_ent_edge(F,tp,get_class_member(tp, i),TYPE_MEMBER_EDGE_ATTR);
2096 for (i=0; i < get_struct_n_members(tp); i++)
2097 print_type_ent_edge(F,tp,get_struct_member(tp, i),TYPE_MEMBER_EDGE_ATTR);
2100 for (i = 0; i < get_method_n_params(tp); i++)
2101 print_type_type_edge(F,tp,get_method_param_type(tp, i),METH_PAR_EDGE_ATTR,i);
2102 for (i = 0; i < get_method_n_ress(tp); i++)
2103 print_type_type_edge(F,tp,get_method_res_type(tp, i),METH_RES_EDGE_ATTR,i);
2106 for (i = 0; i < get_union_n_members(tp); i++)
2107 print_type_ent_edge(F,tp,get_union_member(tp, i),UNION_EDGE_ATTR);
2110 print_type_type_edge(F,tp,get_array_element_type(tp),ARR_ELT_TYPE_EDGE_ATTR);
2111 print_type_ent_edge(F,tp,get_array_element_entity(tp),ARR_ENT_EDGE_ATTR);
2112 for (i = 0; i < get_array_n_dimensions(tp); i++) {
2113 ir_node *upper = get_array_upper_bound(tp, i);
2114 ir_node *lower = get_array_lower_bound(tp, i);
2115 print_node_type_edge(F, upper, tp, "label: \"upper %d\"", get_array_order(tp, i));
2116 print_node_type_edge(F, lower, tp, "label: \"lower %d\"", get_array_order(tp, i));
2117 dump_const_expression(F, upper);
2118 dump_const_expression(F, lower);
2121 case tpo_enumeration:
2122 for (i = 0; i < get_enumeration_n_enums(tp); ++i) {
2123 dump_enum_item(F, tp, i);
2124 print_enum_item_edge(F, tp, i, "label: \"item %d\"", i);
2128 print_type_type_edge(F,tp,get_pointer_points_to_type(tp), PTR_PTS_TO_EDGE_ATTR);
2135 break; /* case k_type */
2138 printf(" *** irdump, dump_type_info(l.%i), faulty type.\n", __LINE__);
2139 } /* switch kind_or_entity */
2142 typedef struct _h_env {
2147 /** For dumping class hierarchies.
2148 * Dumps a class type node and a superclass edge.
2149 * If env->dump_ent dumps entities of classes and overwrites edges.
2152 dump_class_hierarchy_node(type_or_ent *tore, void *ctx) {
2155 int i = 0; /* to shutup gcc */
2157 /* dump this type or entity */
2158 switch (get_kind(tore)) {
2160 ir_entity *ent = (ir_entity *)tore;
2161 if (get_entity_owner(ent) == get_glob_type()) break;
2162 if (!is_Method_type(get_entity_type(ent))) break; /* GL */
2163 if (env->dump_ent && is_Class_type(get_entity_owner(ent))) {
2165 dump_entity_node(F, ent, 0);
2167 print_type_ent_edge(F,get_entity_owner(ent),ent,TYPE_MEMBER_EDGE_ATTR);
2168 for(i = 0; i < get_entity_n_overwrites(ent); i++)
2169 print_ent_ent_edge(F, get_entity_overwrites(ent, i), ent, 0, ENT_OVERWRITES_EDGE_ATTR);
2174 ir_type *tp = (ir_type *)tore;
2175 if (tp == get_glob_type()) break;
2176 switch (get_type_tpop_code(tp)) {
2178 dump_type_node(F, tp);
2179 /* and now the edges */
2180 for (i=0; i < get_class_n_supertypes(tp); i++) {
2181 print_type_type_edge(F,tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2186 break; /* case k_type */
2189 printf(" *** irdump, dump_class_hierarchy_node(l.%i), faulty type.\n", __LINE__);
2190 } /* switch kind_or_entity */
2193 /*******************************************************************/
2194 /* dump analysis information that is expressed in graph terms. */
2195 /*******************************************************************/
2197 /* dump out edges */
2199 dump_out_edge(ir_node *n, void *env) {
2202 for (i = 0; i < get_irn_n_outs(n); i++) {
2203 assert(get_irn_out(n, i));
2204 fprintf(F, "edge: {sourcename: \"");
2206 fprintf(F, "\" targetname: \"");
2207 PRINT_NODEID(get_irn_out(n, i));
2208 fprintf(F, "\" color: red linestyle: dashed");
2214 dump_loop_label(FILE *F, ir_loop *loop) {
2215 fprintf(F, "loop %d, %d sons, %d nodes",
2216 get_loop_depth(loop), get_loop_n_sons(loop), get_loop_n_nodes(loop));
2219 static INLINE void dump_loop_info(FILE *F, ir_loop *loop) {
2220 fprintf(F, " info1: \"");
2221 fprintf(F, " loop nr: %d", get_loop_loop_nr(loop));
2222 #ifdef DEBUG_libfirm /* GL @@@ debug analyses */
2223 fprintf(F, "\n The loop was analyzed %d times.", PTR_TO_INT(get_loop_link(loop)));
2229 dump_loop_node(FILE *F, ir_loop *loop) {
2230 fprintf(F, "node: {title: \"");
2232 fprintf(F, "\" label: \"");
2233 dump_loop_label(F, loop);
2235 dump_loop_info(F, loop);
2240 dump_loop_node_edge(FILE *F, ir_loop *loop, int i) {
2242 fprintf(F, "edge: {sourcename: \"");
2244 fprintf(F, "\" targetname: \"");
2245 PRINT_NODEID(get_loop_node(loop, i));
2246 fprintf(F, "\" color: green");
2251 dump_loop_son_edge(FILE *F, ir_loop *loop, int i) {
2253 fprintf(F, "edge: {sourcename: \"");
2255 fprintf(F, "\" targetname: \"");
2256 PRINT_LOOPID(get_loop_son(loop, i));
2257 fprintf(F, "\" color: darkgreen label: \"%d\"}\n",
2258 get_loop_element_pos(loop, get_loop_son(loop, i)));
2262 void dump_loops(FILE *F, ir_loop *loop) {
2264 /* dump this loop node */
2265 dump_loop_node(F, loop);
2267 /* dump edges to nodes in loop -- only if it is a real loop */
2268 if (get_loop_depth(loop) != 0) {
2269 for (i = 0; i < get_loop_n_nodes(loop); i++) {
2270 dump_loop_node_edge(F, loop, i);
2273 for (i = 0; i < get_loop_n_sons(loop); i++) {
2274 dump_loops(F, get_loop_son(loop, i));
2275 dump_loop_son_edge(F, loop, i);
2280 void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg) {
2281 ir_graph *rem = current_ir_graph;
2282 current_ir_graph = irg;
2284 if (get_irg_loop(irg)) dump_loops(F, get_irg_loop(irg));
2286 current_ir_graph = rem;
2291 * dumps the VCG header
2293 void dump_vcg_header(FILE *F, const char *name, const char *orientation) {
2305 if (!orientation) orientation = "bottom_to_top";
2309 "graph: { title: \"ir graph of %s\"\n"
2310 "display_edge_labels: %s\n"
2311 "layoutalgorithm: mindepth\n"
2312 "manhattan_edges: yes\n"
2313 "port_sharing: no\n"
2315 "classname 1: \"intrablock Data\"\n"
2316 "classname 2: \"Block\"\n"
2317 "classname 3: \"Entity type\"\n"
2318 "classname 4: \"Entity owner\"\n"
2319 "classname 5: \"Method Param\"\n"
2320 "classname 6: \"Method Res\"\n"
2321 "classname 7: \"Super\"\n"
2322 "classname 8: \"Union\"\n"
2323 "classname 9: \"Points-to\"\n"
2324 "classname 10: \"Array Element Type\"\n"
2325 "classname 11: \"Overwrites\"\n"
2326 "classname 12: \"Member\"\n"
2327 "classname 13: \"Control Flow\"\n"
2328 "classname 14: \"intrablock Memory\"\n"
2329 "classname 15: \"Dominators\"\n"
2330 "classname 16: \"interblock Data\"\n"
2331 "classname 17: \"interblock Memory\"\n"
2332 "classname 18: \"Exception Control Flow for Interval Analysis\"\n"
2333 "classname 19: \"Postdominators\"\n"
2334 "classname 20: \"Keep Alive\"\n"
2335 "classname 21: \"Out Edges\"\n"
2336 "classname 22: \"Macro Block Edges\"\n"
2337 "infoname 1: \"Attribute\"\n"
2338 "infoname 2: \"Verification errors\"\n"
2339 "infoname 3: \"Debug info\"\n",
2340 name, label, orientation);
2342 for (i = 0; i < ird_color_count; ++i) {
2343 if(color_rgb[i] != NULL) {
2344 fprintf(F, "colorentry %s: %s\n", color_names[i], color_rgb[i]);
2347 fprintf(F, "\n"); /* a separator */
2353 * @param irg The graph to be dumped
2354 * @param suffix1 first filename suffix
2355 * @param suffix2 second filename suffix
2357 FILE *vcg_open(ir_graph *irg, const char * suffix1, const char *suffix2) {
2359 const char *nm = get_irg_dump_name(irg);
2360 int len = strlen(nm), i, j;
2361 char *fname; /* filename to put the vcg information in */
2363 if (!suffix1) suffix1 = "";
2364 if (!suffix2) suffix2 = "";
2366 /* open file for vcg graph */
2367 fname = xmalloc (len * 2 + strlen(suffix1) + strlen(suffix2) + 5);
2369 /* strncpy (fname, nm, len); */ /* copy the filename */
2371 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2373 fname[j] = '@'; j++; fname[j] = '1'; j++;
2374 } else if (nm[i] == '@') {
2375 fname[j] = '@'; j++; fname[j] = '2'; j++;
2377 fname[j] = nm[i]; j++;
2381 strcat(fname, suffix1); /* append file suffix */
2382 strcat(fname, suffix2); /* append file suffix */
2383 strcat(fname, ".vcg"); /* append the .vcg suffix */
2385 /* vcg really expect only a <CR> at end of line, so
2386 * the "b"inary mode is what you mean (and even needed for Win32)
2388 F = fopen(fname, "wb"); /* open file for writing */
2400 * @param name prefix file name
2401 * @param suffix filename suffix
2403 FILE *vcg_open_name(const char *name, const char *suffix) {
2405 char *fname; /* filename to put the vcg information in */
2406 int i, j, len = strlen(name);
2408 if (!suffix) suffix = "";
2410 /** open file for vcg graph */
2411 fname = xmalloc(len * 2 + 5 + strlen(suffix));
2412 /* strcpy (fname, name);*/ /* copy the filename */
2414 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2415 if (name[i] == '/') {
2416 fname[j] = '@'; j++; fname[j] = '1'; j++;
2417 } else if (name[i] == '@') {
2418 fname[j] = '@'; j++; fname[j] = '2'; j++;
2420 fname[j] = name[i]; j++;
2424 strcat(fname, suffix);
2425 strcat(fname, ".vcg"); /* append the .vcg suffix */
2427 /* vcg really expect only a <CR> at end of line, so
2428 * the "b"inary mode is what you mean (and even needed for Win32)
2430 F = fopen(fname, "wb"); /* open file for writing */
2440 * Dumps the vcg file footer
2442 void dump_vcg_footer(FILE *F) {
2446 /************************************************************************/
2447 /************************************************************************/
2448 /* Routines that dump all or parts of the firm representation to a file */
2449 /************************************************************************/
2450 /************************************************************************/
2452 /************************************************************************/
2453 /* Dump ir graphs, different formats and additional information. */
2454 /************************************************************************/
2456 typedef void (*do_dump_graph_func) (ir_graph *irg, FILE *out);
2458 static void do_dump(ir_graph *irg, const char *suffix, const char *suffix_ip,
2459 const char *suffix_nonip, do_dump_graph_func dump_func)
2463 const char *suffix1;
2465 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2468 rem = current_ir_graph;
2469 current_ir_graph = irg;
2470 if (get_interprocedural_view())
2471 suffix1 = suffix_ip;
2473 suffix1 = suffix_nonip;
2474 current_ir_graph = rem;
2476 out = vcg_open(irg, suffix, suffix1);
2478 dump_func(irg, out);
2483 void dump_ir_graph_file(ir_graph *irg, FILE *out)
2485 if (dump_backedge_information_flag
2486 && get_irg_loopinfo_state(irg) != loopinfo_consistent) {
2487 construct_backedges(irg);
2490 dump_vcg_header(out, get_irg_dump_name(irg), NULL);
2492 /* call the dump graph hook */
2493 if (dump_ir_graph_hook) {
2494 if (dump_ir_graph_hook(out, irg)) {
2499 /* walk over the graph */
2500 /* dump_whole_node must be called in post visiting predecessors */
2501 ird_walk_graph(irg, NULL, dump_whole_node, out);
2503 /* dump the out edges in a separate walk */
2504 if ((dump_out_edge_flag) && (get_irg_outs_state(irg) != outs_none)) {
2505 irg_out_walk(get_irg_start(irg), dump_out_edge, NULL, out);
2508 dump_vcg_footer(out);
2511 /** Routine to dump a graph, blocks as conventional nodes. */
2512 void dump_ir_graph(ir_graph *irg, const char *suffix )
2514 do_dump(irg, suffix, "-pure-ip", "-pure", dump_ir_graph_file);
2517 void dump_ir_block_graph_file(ir_graph *irg, FILE *out)
2521 dump_vcg_header(out, get_irg_dump_name(irg), NULL);
2523 construct_block_lists(irg);
2526 * If we are in the interprocedural view, we dump not
2527 * only the requested irg but also all irgs that can be reached
2530 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2531 ir_graph *g = get_irp_irg(i);
2532 ir_node **arr = ird_get_irg_link(g);
2534 dump_graph_from_list(out, g);
2539 dump_vcg_footer(out);
2542 /* Dump a firm graph without explicit block nodes. */
2543 void dump_ir_block_graph(ir_graph *irg, const char *suffix)
2545 do_dump(irg, suffix, "-ip", "", dump_ir_block_graph_file);
2548 void dump_ir_extblock_graph_file(ir_graph *irg, FILE *F)
2551 ir_entity *ent = get_irg_entity(irg);
2553 if (get_irg_extblk_state(irg) != extblk_valid)
2556 dump_vcg_header(F, get_irg_dump_name(irg), NULL);
2558 construct_extblock_lists(irg);
2560 fprintf(F, "graph: { title: \"");
2562 fprintf(F, "\" label: \"%s\" status:clustered color: white \n",
2563 get_ent_dump_name(ent));
2565 dump_graph_info(F, irg);
2566 print_dbg_info(F, get_entity_dbg_info(ent));
2568 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2569 ir_graph *irg = get_irp_irg(i);
2570 list_tuple *lists = ird_get_irg_link(irg);
2573 /* dump the extended blocks first */
2574 if (ARR_LEN(lists->extbb_list)) {
2575 ird_set_irg_link(irg, lists->extbb_list);
2576 dump_extblock_graph(F, irg);
2579 /* we may have blocks without extended blocks, bad for instance */
2580 if (ARR_LEN(lists->blk_list)) {
2581 ird_set_irg_link(irg, lists->blk_list);
2582 dump_block_graph(F, irg);
2585 DEL_ARR_F(lists->extbb_list);
2586 DEL_ARR_F(lists->blk_list);
2591 /* Close the vcg information for the irg */
2592 fprintf(F, "}\n\n");
2598 /* Dump a firm graph without explicit block nodes but grouped in extended blocks. */
2599 void dump_ir_extblock_graph(ir_graph *irg, const char *suffix)
2601 do_dump(irg, suffix, "-ip", "", dump_ir_extblock_graph_file);
2604 void dump_ir_graph_w_types_file(ir_graph *irg, FILE *out)
2606 ir_graph *rem = current_ir_graph;
2607 int rem_dump_const_local;
2609 rem = current_ir_graph;
2610 current_ir_graph = irg;
2611 rem_dump_const_local = dump_const_local;
2612 /* dumping types does not work with local nodes */
2613 dump_const_local = 0;
2615 dump_vcg_header(out, get_irg_dump_name(irg), NULL);
2617 /* dump common ir graph */
2618 irg_walk(get_irg_end(irg), NULL, dump_whole_node, out);
2619 /* dump type info */
2620 type_walk_irg(irg, dump_type_info, NULL, out);
2621 inc_irg_visited(get_const_code_irg());
2622 /* dump edges from graph to type info */
2623 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2625 dump_vcg_footer(out);
2626 dump_const_local = rem_dump_const_local;
2627 current_ir_graph = rem;
2630 /* dumps a graph with type information */
2631 void dump_ir_graph_w_types(ir_graph *irg, const char *suffix)
2633 do_dump(irg, suffix, "-pure-wtypes-ip", "-pure-wtypes",
2634 dump_ir_graph_w_types_file);
2637 void dump_ir_block_graph_w_types_file(ir_graph *irg, FILE *out)
2640 int rem_dump_const_local;
2641 ir_graph *rem = current_ir_graph;
2643 rem_dump_const_local = dump_const_local;
2644 /* dumping types does not work with local nodes */
2645 dump_const_local = 0;
2647 dump_vcg_header(out, get_irg_dump_name(irg), NULL);
2649 /* dump common blocked ir graph */
2650 construct_block_lists(irg);
2652 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2653 ir_node **arr = ird_get_irg_link(get_irp_irg(i));
2655 dump_graph_from_list(out, get_irp_irg(i));
2660 /* dump type info */
2661 current_ir_graph = irg;
2662 type_walk_irg(irg, dump_type_info, NULL, out);
2663 inc_irg_visited(get_const_code_irg());
2665 /* dump edges from graph to type info */
2666 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2668 dump_vcg_footer(out);
2669 dump_const_local = rem_dump_const_local;
2670 current_ir_graph = rem;
2673 void dump_ir_block_graph_w_types(ir_graph *irg, const char *suffix)
2675 do_dump(irg, suffix, "-wtypes-ip", "-wtypes",
2676 dump_ir_block_graph_w_types_file);
2679 /*---------------------------------------------------------------------*/
2680 /* The following routines dump a control flow graph. */
2681 /*---------------------------------------------------------------------*/
2684 dump_block_to_cfg(ir_node *block, void *env) {
2689 if (is_Block(block)) {
2690 /* This is a block. Dump a node for the block. */
2691 fprintf(F, "node: {title: \""); PRINT_NODEID(block);
2692 fprintf(F, "\" label: \"");
2693 if (block == get_irg_start_block(get_irn_irg(block)))
2694 fprintf(F, "Start ");
2695 if (block == get_irg_end_block(get_irn_irg(block)))
2698 fprintf(F, "%s ", get_op_name(get_irn_op(block)));
2699 PRINT_NODEID(block);
2701 fprintf(F, "info1:\"");
2703 /* the generic version. */
2704 dump_irnode_to_file(F, block);
2706 /* Check whether we have bad predecessors to color the block. */
2707 for (i = 0; i < get_Block_n_cfgpreds(block); ++i)
2708 if ((fl = is_Bad(get_Block_cfgpred(block, i))))
2711 fprintf(F, "\""); /* closing quote of info */
2713 if ((block == get_irg_start_block(get_irn_irg(block))) ||
2714 (block == get_irg_end_block(get_irn_irg(block))) )
2715 fprintf(F, " color:blue ");
2717 fprintf(F, " color:yellow ");
2720 /* Dump the edges */
2721 for ( i = 0; i < get_Block_n_cfgpreds(block); i++)
2722 if (get_irn_op(skip_Proj(get_Block_cfgpred(block, i))) != op_Bad) {
2723 pred = get_nodes_block(skip_Proj(get_Block_cfgpred(block, i)));
2724 fprintf(F, "edge: { sourcename: \"");
2725 PRINT_NODEID(block);
2726 fprintf(F, "\" targetname: \"");
2728 fprintf(F, "\"}\n");
2731 /* Dump dominator/postdominator edge */
2732 if (dump_dominator_information_flag) {
2733 if (get_irg_dom_state(current_ir_graph) == dom_consistent && get_Block_idom(block)) {
2734 pred = get_Block_idom(block);
2735 fprintf(F, "edge: { sourcename: \"");
2736 PRINT_NODEID(block);
2737 fprintf(F, "\" targetname: \"");
2739 fprintf(F, "\" " DOMINATOR_EDGE_ATTR "}\n");
2741 if (get_irg_postdom_state(current_ir_graph) == dom_consistent && get_Block_ipostdom(block)) {
2742 pred = get_Block_ipostdom(block);
2743 fprintf(F, "edge: { sourcename: \"");
2744 PRINT_NODEID(block);
2745 fprintf(F, "\" targetname: \"");
2747 fprintf(F, "\" " POSTDOMINATOR_EDGE_ATTR "}\n");
2753 void dump_cfg(ir_graph *irg, const char *suffix)
2756 /* if a filter is set, dump only the irg's that match the filter */
2757 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2760 f = vcg_open(irg, suffix, "-cfg");
2762 ir_graph *rem = current_ir_graph;
2763 #ifdef INTERPROCEDURAL_VIEW
2764 int ipv = get_interprocedural_view();
2767 current_ir_graph = irg;
2768 dump_vcg_header(f, get_irg_dump_name(irg), NULL);
2770 #ifdef INTERPROCEDURAL_VIEW
2772 printf("Warning: dumping cfg not in interprocedural view!\n");
2773 set_interprocedural_view(0);
2777 /* walk over the blocks in the graph */
2778 irg_block_walk(get_irg_end(irg), dump_block_to_cfg, NULL, f);
2779 dump_node(f, get_irg_bad(irg));
2781 #ifdef INTERPROCEDURAL_VIEW
2782 set_interprocedural_view(ipv);
2786 current_ir_graph = rem;
2791 static void descend_and_dump(FILE *F, ir_node *n, int depth, pset *mark_set) {
2792 if (pset_find_ptr(mark_set, n)) return;
2794 pset_insert_ptr(mark_set, n);
2797 int i, start = is_Block(n) ? 0 : -1;
2798 dump_whole_node(n, F);
2799 for (i = start; i < get_irn_arity(n); ++i)
2800 descend_and_dump(F, get_irn_n(n, i), depth-1, mark_set);
2803 /* Don't dump edges to nodes further out. These might be edges to
2804 nodes we already dumped, if there is a shorter path to these. */
2808 static int subgraph_counter = 0;
2809 void dump_subgraph(ir_node *root, int depth, const char *suffix) {
2813 sprintf(buf, "-subg_%03d", subgraph_counter++);
2814 F = vcg_open(get_irn_irg(root), suffix, buf);
2816 pset *mark_set = pset_new_ptr(1);
2817 dump_vcg_header(F, get_irg_dump_name(get_irn_irg(root)), NULL);
2818 descend_and_dump(F, root, depth, mark_set);
2825 #ifdef INTERPROCEDURAL_VIEW
2826 void dump_callgraph(const char *suffix) {
2827 FILE *F = vcg_open_name("Callgraph", suffix);
2830 int i, rem = edge_label;
2833 dump_vcg_header(F, "Callgraph", NULL);
2835 //colorize = get_irp_callgraph_state() == irp_callgraph_and_calltree_consistent;
2837 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2838 ir_graph *irg = get_irp_irg(i);
2839 ir_entity *ent = get_irg_entity(irg);
2841 //int n_callees = get_irg_n_callees(irg);
2844 //color = colorize ? get_entity_color(ent) : ird_color_green;
2845 color = ird_color_green;
2846 dump_entity_node(F, ent, color);
2847 for (j = 0; j < n_callees; ++j) {
2848 ir_entity *c = get_irg_entity(get_irg_callee(irg, j));
2849 //if (id_is_prefix(prefix, get_entity_ld_ident(c))) continue;
2850 int be = is_irg_callee_backedge(irg, j);
2853 "label:\"recursion %d\" color:%d" :
2854 "label:\"calls %d\" color:%d";
2855 print_ent_ent_edge(F, ent, c, be, attr, get_irg_callee_loop_depth(irg, j), color);
2865 /* Dump all irgs in interprocedural view to a single file. */
2866 void dump_all_cg_block_graph(const char *suffix) {
2867 FILE *f = vcg_open_name("All_graphs", suffix);
2871 int rem_view = get_interprocedural_view();
2873 set_interprocedural_view(1);
2874 dump_vcg_header(f, "All_graphs", NULL);
2876 /* collect nodes in all irgs reachable in call graph*/
2877 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2878 ird_set_irg_link(get_irp_irg(i), NULL);
2880 cg_walk(clear_link, collect_node, NULL);
2882 /* dump all graphs */
2883 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2884 current_ir_graph = get_irp_irg(i);
2885 assert(ird_get_irg_link(current_ir_graph));
2886 dump_graph_from_list(f, current_ir_graph);
2887 DEL_ARR_F(ird_get_irg_link(current_ir_graph));
2892 set_interprocedural_view(rem_view);
2897 /*---------------------------------------------------------------------*/
2898 /* the following routines dumps type information without any ir nodes. */
2899 /*---------------------------------------------------------------------*/
2902 dump_type_graph(ir_graph *irg, const char *suffix)
2906 /* if a filter is set, dump only the irg's that match the filter */
2907 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
2909 f = vcg_open(irg, suffix, "-type");
2911 ir_graph *rem = current_ir_graph;
2912 current_ir_graph = irg;
2914 dump_vcg_header(f, get_irg_dump_name(irg), NULL);
2916 /* walk over the blocks in the graph */
2917 type_walk_irg(irg, dump_type_info, NULL, f);
2918 /* The walker for the const code can be called several times for the
2919 same (sub) expression. So that no nodes are dumped several times
2920 we decrease the visited flag of the corresponding graph after each
2921 walk. So now increase it finally. */
2922 inc_irg_visited(get_const_code_irg());
2926 current_ir_graph = rem;
2931 dump_all_types(const char *suffix)
2933 FILE *f = vcg_open_name("All_types", suffix);
2935 dump_vcg_header(f, "All_types", NULL);
2936 type_walk(dump_type_info, NULL, f);
2937 inc_irg_visited(get_const_code_irg());
2945 dump_class_hierarchy(int entities, const char *suffix)
2947 FILE *f = vcg_open_name("class_hierarchy", suffix);
2952 env.dump_ent = entities;
2953 dump_vcg_header(f, "class_hierarchy", NULL);
2954 type_walk(dump_class_hierarchy_node, NULL, &env);
2961 /*---------------------------------------------------------------------*/
2962 /* dumps all graphs with the graph-dumper passed. Possible dumpers: */
2964 /* dump_ir_block_graph */
2966 /* dump_type_graph */
2967 /* dump_ir_graph_w_types */
2968 /*---------------------------------------------------------------------*/
2970 void dump_all_ir_graphs(dump_graph_func *dmp_grph, const char *suffix) {
2972 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2973 dmp_grph(get_irp_irg(i), suffix);
2977 /*--------------------------------------------------------------------------------*
2978 * Dumps a stand alone loop graph with firm nodes which belong to one loop node *
2979 * packed together in one subgraph/box *
2980 *--------------------------------------------------------------------------------*/
2982 void dump_loops_standalone(FILE *F, ir_loop *loop) {
2983 int i = 0, loop_node_started = 0, son_number = 0, first = 0;
2985 ir_loop *son = NULL;
2987 /* Dump a new loop node. */
2988 dump_loop_node(F, loop);
2990 /* Dump the loop elements. */
2992 for(i = 0; i < get_loop_n_elements(loop); i++) {
2993 le = get_loop_element(loop, i);
2995 if (get_kind(son) == k_ir_loop) {
2997 /* We are a loop son -> Recurse */
2999 if(loop_node_started) { /* Close the "firm-nodes" node first if we started one. */
3000 fprintf(F, "\" }\n");
3001 fprintf(F, "edge: {sourcename: \"");
3003 fprintf(F, "\" targetname: \"");
3005 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3006 loop_node_started = 0;
3008 dump_loop_son_edge(F, loop, son_number++);
3009 dump_loops_standalone(F, son);
3010 } else if (get_kind(son) == k_ir_node) {
3011 /* We are a loop node -> Collect firm nodes */
3013 ir_node *n = le.node;
3016 if (!loop_node_started) {
3017 /* Start a new node which contains all firm nodes of the current loop */
3018 fprintf(F, "node: { title: \"");
3020 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3021 loop_node_started = 1;
3026 bad |= dump_node_label(F, n);
3027 /* Causes indeterministic output: if (is_Block(n)) fprintf(F, "\t ->%d", (int)get_irn_link(n)); */
3028 if (has_backedges(n)) fprintf(F, "\t loop head!");
3029 } else { /* for callgraph loop tree */
3031 assert(get_kind(son) == k_ir_graph);
3033 /* We are a loop node -> Collect firm graphs */
3034 n = (ir_graph *)le.node;
3035 if (!loop_node_started) {
3036 /* Start a new node which contains all firm nodes of the current loop */
3037 fprintf(F, "node: { title: \"");
3039 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3040 loop_node_started = 1;
3044 fprintf(F, " %s", get_irg_dump_name(n));
3045 /* fprintf(F, " %s (depth %d)", get_irg_dump_name(n), n->callgraph_weighted_loop_depth); */
3049 if (loop_node_started) {
3050 fprintf(F, "\" }\n");
3051 fprintf(F, "edge: {sourcename: \"");
3053 fprintf(F, "\" targetname: \"");
3055 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3056 loop_node_started = 0;
3060 void dump_loop_tree(ir_graph *irg, const char *suffix)
3064 /* if a filter is set, dump only the irg's that match the filter */
3065 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
3067 f = vcg_open(irg, suffix, "-looptree");
3069 ir_graph *rem = current_ir_graph;
3070 int el_rem = edge_label;
3072 current_ir_graph = irg;
3075 dump_vcg_header(f, get_irg_dump_name(irg), "top_to_bottom");
3077 if (get_irg_loop(irg)) dump_loops_standalone(f, get_irg_loop(irg));
3082 edge_label = el_rem;
3083 current_ir_graph = rem;
3087 void dump_callgraph_loop_tree(const char *suffix) {
3089 F = vcg_open_name("Callgraph_looptree", suffix);
3090 dump_vcg_header(F, "callgraph looptree", "top_to_bottom");
3091 dump_loops_standalone(F, irp->outermost_cg_loop);
3097 /*----------------------------------------------------------------------------*/
3098 /* Dumps the firm nodes in the loop tree to a graph along with the loop nodes.*/
3099 /*----------------------------------------------------------------------------*/
3101 void collect_nodeloop(FILE *F, ir_loop *loop, eset *loopnodes) {
3102 int i, son_number = 0, node_number = 0;
3104 if (dump_loop_information_flag) dump_loop_node(F, loop);
3106 for (i = 0; i < get_loop_n_elements(loop); i++) {
3107 loop_element le = get_loop_element(loop, i);
3108 if (*(le.kind) == k_ir_loop) {
3109 if (dump_loop_information_flag) dump_loop_son_edge(F, loop, son_number++);
3111 collect_nodeloop(F, le.son, loopnodes);
3113 if (dump_loop_information_flag) dump_loop_node_edge(F, loop, node_number++);
3114 eset_insert(loopnodes, le.node);
3119 void collect_nodeloop_external_nodes(ir_loop *loop, eset *loopnodes, eset *extnodes) {
3122 for(i = 0; i < get_loop_n_elements(loop); i++) {
3123 loop_element le = get_loop_element(loop, i);
3124 if (*(le.kind) == k_ir_loop) {
3126 collect_nodeloop_external_nodes(le.son, loopnodes, extnodes);
3128 if (is_Block(le.node)) start = 0; else start = -1;
3129 for (j = start; j < get_irn_arity(le.node); j++) {
3130 ir_node *pred = get_irn_n(le.node, j);
3131 if (!eset_contains(loopnodes, pred)) {
3132 eset_insert(extnodes, pred);
3133 if (!is_Block(pred)) {
3134 pred = get_nodes_block(pred);
3135 if (!eset_contains(loopnodes, pred)) eset_insert(extnodes, pred);
3143 void dump_loop(ir_loop *l, const char *suffix) {
3147 snprintf(name, sizeof(name), "loop_%d", get_loop_loop_nr(l));
3148 F = vcg_open_name(name, suffix);
3150 eset *loopnodes = eset_create();
3151 eset *extnodes = eset_create();
3154 dump_vcg_header(F, name, NULL);
3156 /* collect all nodes to dump */
3157 collect_nodeloop(F, l, loopnodes);
3158 collect_nodeloop_external_nodes(l, loopnodes, extnodes);
3160 /* build block lists */
3161 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes))
3162 set_irn_link(n, NULL);
3163 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes))
3164 set_irn_link(n, NULL);
3165 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes)) {
3167 b = get_nodes_block(n);
3168 set_irn_link(n, get_irn_link(b));
3172 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes)) {
3174 b = get_nodes_block(n);
3175 set_irn_link(n, get_irn_link(b));
3180 for (b = eset_first(loopnodes); b != NULL; b = eset_next(loopnodes)) {
3182 fprintf(F, "graph: { title: \"");
3184 fprintf(F, "\" label: \"");
3185 dump_node_opcode(F, b);
3186 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3187 fprintf(F, "\" status:clustered color:yellow\n");
3189 /* dump the blocks edges */
3190 dump_ir_data_edges(F, b);
3192 /* dump the nodes that go into the block */
3193 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3194 if (eset_contains(extnodes, n))
3195 overrule_nodecolor = ird_color_block_inout;
3197 overrule_nodecolor = ird_color_default_node;
3198 if (!eset_contains(extnodes, n)) dump_ir_data_edges(F, n);
3201 /* Close the vcg information for the block */
3203 dump_const_node_local(F, b);
3207 for (b = eset_first(extnodes); b != NULL; b = eset_next(extnodes)) {
3209 fprintf(F, "graph: { title: \"");
3211 fprintf(F, "\" label: \"");
3212 dump_node_opcode(F, b);
3213 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3214 fprintf(F, "\" status:clustered color:lightblue\n");
3216 /* dump the nodes that go into the block */
3217 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3218 if (!eset_contains(loopnodes, n))
3219 overrule_nodecolor = ird_color_block_inout;
3221 overrule_nodecolor = ird_color_default_node;
3222 if (eset_contains(loopnodes, n)) dump_ir_data_edges(F, n);
3225 /* Close the vcg information for the block */
3227 dump_const_node_local(F, b);
3231 eset_destroy(loopnodes);
3232 eset_destroy(extnodes);