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_Global(addr))
806 ent = get_Global_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 }
931 /** the lookup table for Proj(Cond) names */
932 static const pns_lookup_t cond_lut[] = {
933 #define X(a) { pn_Cond_##a, #a }
939 /** the lookup table for Proj(Call) names */
940 static const pns_lookup_t call_lut[] = {
941 #define X(a) { pn_Call_##a, #a }
951 /** the lookup table for Proj(Quot) names */
952 static const pns_lookup_t quot_lut[] = {
953 #define X(a) { pn_Quot_##a, #a }
961 /** the lookup table for Proj(DivMod) names */
962 static const pns_lookup_t divmod_lut[] = {
963 #define X(a) { pn_DivMod_##a, #a }
972 /** the lookup table for Proj(Div) names */
973 static const pns_lookup_t div_lut[] = {
974 #define X(a) { pn_Div_##a, #a }
982 /** the lookup table for Proj(Mod) names */
983 static const pns_lookup_t mod_lut[] = {
984 #define X(a) { pn_Mod_##a, #a }
992 /** the lookup table for Proj(Load) names */
993 static const pns_lookup_t load_lut[] = {
994 #define X(a) { pn_Load_##a, #a }
1002 /** the lookup table for Proj(Store) names */
1003 static const pns_lookup_t store_lut[] = {
1004 #define X(a) { pn_Store_##a, #a }
1011 /** the lookup table for Proj(Alloc) names */
1012 static const pns_lookup_t alloc_lut[] = {
1013 #define X(a) { pn_Alloc_##a, #a }
1021 /** the lookup table for Proj(CopyB) names */
1022 static const pns_lookup_t copyb_lut[] = {
1023 #define X(a) { pn_CopyB_##a, #a }
1031 /** the lookup table for Proj(InstOf) names */
1032 static const pns_lookup_t instof_lut[] = {
1033 #define X(a) { pn_InstOf_##a, #a }
1042 /** the lookup table for Proj(Raise) names */
1043 static const pns_lookup_t raise_lut[] = {
1044 #define X(a) { pn_Raise_##a, #a }
1050 /** the lookup table for Proj(Bound) names */
1051 static const pns_lookup_t bound_lut[] = {
1052 #define X(a) { pn_Bound_##a, #a }
1060 /** the Proj lookup table */
1061 static const proj_lookup_t proj_lut[] = {
1062 #define E(a) ARR_SIZE(a), a
1063 { iro_Start, E(start_lut) },
1064 { iro_Cond, E(cond_lut) },
1065 { iro_Call, E(call_lut) },
1066 { iro_Quot, E(quot_lut) },
1067 { iro_DivMod, E(divmod_lut) },
1068 { iro_Div, E(div_lut) },
1069 { iro_Mod, E(mod_lut) },
1070 { iro_Load, E(load_lut) },
1071 { iro_Store, E(store_lut) },
1072 { iro_Alloc, E(alloc_lut) },
1073 { iro_CopyB, E(copyb_lut) },
1074 { iro_InstOf, E(instof_lut) },
1075 { iro_Raise, E(raise_lut) },
1076 { iro_Bound, E(bound_lut) }
1081 * Dump additional node attributes of some nodes to a file F.
1084 dump_node_nodeattr(FILE *F, ir_node *n)
1090 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1092 /* call the dump_node operation if available */
1094 return ops->dump_node(n, F, dump_node_nodeattr_txt);
1096 switch (get_irn_opcode(n)) {
1098 if (0 && get_interprocedural_view()) {
1099 fprintf(F, "%s ", get_ent_dump_name(get_irg_entity(current_ir_graph)));
1104 pred = get_Proj_pred(n);
1105 proj_nr = get_Proj_proj(n);
1107 code = get_irn_opcode(pred);
1109 if (code == iro_Cmp)
1110 fprintf(F, "%s ", get_pnc_string(get_Proj_proj(n)));
1111 else if (code == iro_Proj && get_irn_opcode(get_Proj_pred(pred)) == iro_Start)
1112 fprintf(F, "Arg %ld ", proj_nr);
1113 else if (code == iro_Cond && get_irn_mode(get_Cond_selector(pred)) != mode_b)
1114 fprintf(F, "%ld ", proj_nr);
1116 unsigned i, j, f = 0;
1118 for (i = 0; i < ARR_SIZE(proj_lut); ++i) {
1119 if (code == proj_lut[i].code) {
1120 for (j = 0; j < proj_lut[i].num_data; ++j) {
1121 if (proj_nr == proj_lut[i].data[j].nr) {
1122 fprintf(F, "%s ", proj_lut[i].data[j].name);
1131 fprintf(F, "%ld ", proj_nr);
1132 if (code == iro_Cond && get_Cond_jmp_pred(pred) != COND_JMP_PRED_NONE) {
1133 if (proj_nr == pn_Cond_false && get_Cond_jmp_pred(pred) == COND_JMP_PRED_FALSE)
1134 fprintf(F, "PRED ");
1135 if (proj_nr == pn_Cond_true && get_Cond_jmp_pred(pred) == COND_JMP_PRED_TRUE)
1136 fprintf(F, "PRED ");
1141 proj_nr = get_Filter_proj(n);
1142 if (! get_interprocedural_view()) {
1144 pred = get_Filter_pred(n);
1147 fprintf(F, "%ld ", proj_nr);
1150 fprintf(F, "%s ", get_ent_dump_name(get_Sel_entity(n)));
1153 fprintf(F, "(%s) ", get_type_name_ex(get_Cast_type(n), &bad));
1156 fprintf(F, "%s ", get_pnc_string(get_Confirm_cmp(n)));
1159 fprintf(F, "(%s) ", get_type_name_ex(get_CopyB_type(n), &bad));
1170 #include "execution_frequency.h"
1172 static void dump_node_ana_vals(FILE *F, ir_node *n) {
1176 #ifdef INTERPROCEDURAL_VIEW
1177 fprintf(F, " %lf*(%2.0lf + %2.0lf) = %2.0lf ",
1178 get_irn_exec_freq(n),
1179 get_irg_method_execution_frequency(get_irn_irg(n)),
1180 pow(5, get_irg_recursion_depth(get_irn_irg(n))),
1181 get_irn_exec_freq(n) * (get_irg_method_execution_frequency(get_irn_irg(n)) + pow(5, get_irg_recursion_depth(get_irn_irg(n))))
1187 /* Dumps a node label without the enclosing ". */
1188 int dump_node_label(FILE *F, ir_node *n) {
1191 bad |= dump_node_opcode(F, n);
1192 bad |= dump_node_mode(F, n);
1194 bad |= dump_node_typeinfo(F, n);
1195 bad |= dump_node_nodeattr(F, n);
1196 if(dump_node_idx_labels) {
1197 fprintf(F, "%ld:%d", get_irn_node_nr(n), get_irn_idx(n));
1199 fprintf(F, "%ld", get_irn_node_nr(n));
1206 * Dumps the attributes of a node n into the file F.
1207 * Currently this is only the color of a node.
1209 static void dump_node_vcgattr(FILE *F, ir_node *node, ir_node *local, int bad)
1215 print_vcg_color(F, ird_color_error);
1219 if (dump_node_vcgattr_hook)
1220 if (dump_node_vcgattr_hook(F, node, local))
1223 n = local ? local : node;
1225 if (overrule_nodecolor != ird_color_default_node) {
1226 print_vcg_color(F, overrule_nodecolor);
1230 mode = get_irn_mode(node);
1231 if(mode == mode_M) {
1232 print_vcg_color(F, ird_color_memory);
1235 if(mode == mode_X) {
1236 print_vcg_color(F, ird_color_controlflow);
1240 switch (get_irn_opcode(n)) {
1245 print_vcg_color(F, ird_color_anchor);
1248 print_vcg_color(F, ird_color_error);
1251 if (is_Block_dead(n))
1252 print_vcg_color(F, ird_color_dead_block_background);
1254 print_vcg_color(F, ird_color_block_background);
1257 print_vcg_color(F, ird_color_phi);
1260 print_vcg_color(F, ird_color_memory);
1264 print_vcg_color(F, ird_color_const);
1267 print_vcg_color(F, ird_color_proj);
1270 ir_op *op = get_irn_op(node);
1272 if(is_op_constlike(op)) {
1273 print_vcg_color(F, ird_color_const);
1274 } else if(is_op_uses_memory(op)) {
1275 print_vcg_color(F, ird_color_uses_memory);
1276 } else if(is_op_cfopcode(op) || is_op_forking(op)) {
1277 print_vcg_color(F, ird_color_controlflow);
1279 PRINT_DEFAULT_NODE_ATTR;
1285 /* Adds a new node info dumper callback. */
1286 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data)
1288 hook_entry_t *info = xmalloc(sizeof(*info));
1290 info->hook._hook_node_info = cb;
1291 info->context = data;
1292 register_hook(hook_node_info, info);
1297 /* Remove a previously added info dumper callback. */
1298 void dump_remv_node_info_callback(void *handle)
1300 hook_entry_t *info = handle;
1301 unregister_hook(hook_node_info, info);
1306 * Dump the node information of a node n to a file F.
1308 static INLINE int dump_node_info(FILE *F, ir_node *n)
1311 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1313 fprintf(F, " info1: \"");
1314 bad = dump_irnode_to_file(F, n);
1315 /* call the dump_node operation if available */
1317 bad = ops->dump_node(n, F, dump_node_info_txt);
1319 /* allow additional info to be added */
1320 hook_node_info(F, n);
1326 static INLINE int is_constlike_node(const ir_node *node)
1328 const ir_op *op = get_irn_op(node);
1329 return is_op_constlike(op);
1333 /** outputs the predecessors of n, that are constants, local. I.e.,
1334 generates a copy of the constant predecessors for each node called with. */
1335 static void dump_const_node_local(FILE *F, ir_node *n) {
1337 if (!get_opt_dump_const_local()) return;
1339 /* Use visited flag to avoid outputting nodes twice.
1340 initialize it first. */
1341 for (i = 0; i < get_irn_arity(n); i++) {
1342 ir_node *con = get_irn_n(n, i);
1343 if (is_constlike_node(con)) {
1344 set_irn_visited(con, get_irg_visited(current_ir_graph) - 1);
1348 for (i = 0; i < get_irn_arity(n); i++) {
1349 ir_node *con = get_irn_n(n, i);
1350 if (is_constlike_node(con) && irn_not_visited(con)) {
1353 mark_irn_visited(con);
1354 /* Generate a new name for the node by appending the names of
1356 fprintf(F, "node: {title: "); PRINT_CONSTID(n, con);
1357 fprintf(F, " label: \"");
1358 bad |= dump_node_label(F, con);
1360 bad |= dump_node_info(F, con);
1361 dump_node_vcgattr(F, n, con, bad);
1367 /** If the block of an edge is a const_like node, dump it local with an edge */
1368 static void dump_const_block_local(FILE *F, ir_node *n) {
1371 if (!get_opt_dump_const_local()) return;
1373 blk = get_nodes_block(n);
1374 if (is_constlike_node(blk)) {
1377 /* Generate a new name for the node by appending the names of
1379 fprintf(F, "node: {title: \""); PRINT_CONSTBLKID(n, blk);
1380 fprintf(F, "\" label: \"");
1381 bad |= dump_node_label(F, blk);
1383 bad |= dump_node_info(F, blk);
1384 dump_node_vcgattr(F, n, blk, bad);
1387 fprintf(F, "edge: { sourcename: \"");
1389 fprintf(F, "\" targetname: \""); PRINT_CONSTBLKID(n,blk);
1391 if (dump_edge_vcgattr_hook) {
1393 if (dump_edge_vcgattr_hook(F, n, -1)) {
1397 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1402 fprintf(F, "\" " BLOCK_EDGE_ATTR "}\n");
1407 * prints the error message of a node to a file F as info2.
1409 static void print_node_error(FILE *F, const char *err_msg)
1414 fprintf(F, " info2: \"%s\"", err_msg);
1418 * prints debug messages of a node to file F as info3.
1420 static void print_dbg_info(FILE *F, dbg_info *dbg)
1424 if (__dbg_info_snprint) {
1426 if (__dbg_info_snprint(buf, sizeof(buf), dbg) > 0)
1427 fprintf(F, " info3: \"%s\"\n", buf);
1434 static void dump_node(FILE *F, ir_node *n)
1439 if (get_opt_dump_const_local() && is_constlike_node(n))
1442 /* dump this node */
1443 fprintf(F, "node: {title: \""); PRINT_NODEID(n); fprintf(F, "\" label: \"");
1445 bad = ! irn_vrfy_irg_dump(n, current_ir_graph, &p);
1446 bad |= dump_node_label(F, n);
1447 dump_node_ana_vals(F, n);
1448 //dump_node_ana_info(F, n);
1450 bad |= dump_node_info(F, n);
1451 print_node_error(F, p);
1452 print_dbg_info(F, get_irn_dbg_info(n));
1453 dump_node_vcgattr(F, n, NULL, bad);
1455 dump_const_node_local(F, n);
1457 if(dump_node_edge_hook)
1458 dump_node_edge_hook(F, n);
1460 dump_irn_chi_term(F, n);
1461 dump_irn_state(F, n);
1465 /** dump the edge to the block this node belongs to */
1467 dump_ir_block_edge(FILE *F, ir_node *n) {
1468 if (get_opt_dump_const_local() && is_constlike_node(n)) return;
1469 if (is_no_Block(n)) {
1470 ir_node *block = get_nodes_block(n);
1472 if (get_opt_dump_const_local() && is_constlike_node(block)) {
1473 dump_const_block_local(F, n);
1475 fprintf(F, "edge: { sourcename: \"");
1477 fprintf(F, "\" targetname: ");
1478 fprintf(F, "\""); PRINT_NODEID(block); fprintf(F, "\"");
1480 if (dump_edge_vcgattr_hook) {
1482 if (dump_edge_vcgattr_hook(F, n, -1)) {
1486 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1491 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1497 print_data_edge_vcgattr(FILE *F, ir_node *from, int to) {
1499 * do not use get_nodes_block() here, will fail
1500 * if the irg is not pinned.
1502 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1503 fprintf(F, INTRA_DATA_EDGE_ATTR);
1505 fprintf(F, INTER_DATA_EDGE_ATTR);
1509 print_mem_edge_vcgattr(FILE *F, ir_node *from, int to) {
1511 * do not use get_nodes_block() here, will fail
1512 * if the irg is not pinned.
1514 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1515 fprintf(F, INTRA_MEM_EDGE_ATTR);
1517 fprintf(F, INTER_MEM_EDGE_ATTR);
1520 /** Print the vcg attributes for the edge from node from to it's to's input */
1521 static void print_edge_vcgattr(FILE *F, ir_node *from, int to) {
1524 if (dump_edge_vcgattr_hook)
1525 if (dump_edge_vcgattr_hook(F, from, to))
1528 if (dump_backedge_information_flag && is_backedge(from, to))
1529 fprintf(F, BACK_EDGE_ATTR);
1531 switch (get_irn_opcode(from)) {
1533 fprintf(F, CF_EDGE_ATTR);
1535 case iro_Start: break;
1538 if (get_irn_mode(get_End_keepalive(from, to)) == mode_BB)
1539 fprintf(F, KEEP_ALIVE_CF_EDGE_ATTR);
1541 fprintf(F, KEEP_ALIVE_DF_EDGE_ATTR);
1545 if (is_Proj(from)) {
1546 if (get_irn_mode(from) == mode_M)
1547 print_mem_edge_vcgattr(F, from, to);
1548 else if (get_irn_mode(from) == mode_X)
1549 fprintf(F, CF_EDGE_ATTR);
1551 print_data_edge_vcgattr(F, from, to);
1553 else if (get_irn_mode(get_irn_n(from, to)) == mode_M)
1554 print_mem_edge_vcgattr(F, from, to);
1555 else if (get_irn_mode(get_irn_n(from, to)) == mode_X)
1556 fprintf(F, CF_EDGE_ATTR);
1558 print_data_edge_vcgattr(F, from, to);
1562 /** dump edges to our inputs */
1563 static void dump_ir_data_edges(FILE *F, ir_node *n) {
1565 unsigned long visited = get_irn_visited(n);
1567 if (!dump_keepalive && is_End(n)) {
1568 /* the End node has only keep-alive edges */
1572 /* dump the dependency edges. */
1573 num = get_irn_deps(n);
1574 for (i = 0; i < num; ++i) {
1575 ir_node *dep = get_irn_dep(n, i);
1578 fprintf(F, "edge: {sourcename: \"");
1580 fprintf(F, "\" targetname: ");
1581 if ((get_opt_dump_const_local()) && is_constlike_node(dep)) {
1582 PRINT_CONSTID(n, dep);
1588 fprintf(F, " label: \"%d\" ", i);
1589 fprintf(F, " color: darkgreen}\n");
1593 num = get_irn_arity(n);
1594 for (i = 0; i < num; i++) {
1595 ir_node *pred = get_irn_n(n, i);
1598 if ((get_interprocedural_view() && get_irn_visited(pred) < visited))
1599 continue; /* pred not dumped */
1601 if (dump_backedge_information_flag && is_backedge(n, i))
1602 fprintf(F, "backedge: {sourcename: \"");
1604 fprintf(F, "edge: {sourcename: \"");
1606 fprintf(F, "\" targetname: ");
1607 if ((get_opt_dump_const_local()) && is_constlike_node(pred)) {
1608 PRINT_CONSTID(n, pred);
1610 fprintf(F, "\""); PRINT_NODEID(pred); fprintf(F, "\"");
1612 fprintf(F, " label: \"%d\" ", i);
1613 print_edge_vcgattr(F, n, i);
1617 if (dump_macro_block_edges && is_Block(n)) {
1618 ir_node *mb = get_Block_MacroBlock(n);
1619 fprintf(F, "edge: {sourcename: \"");
1621 fprintf(F, "\" targetname: \"");
1623 fprintf(F, "\" label: \"mb\" " MACROBLOCK_EDGE_ATTR);
1632 dump_ir_edges(FILE *F, ir_node *n) {
1633 const ir_edge_t *edge;
1636 foreach_out_edge(n, edge) {
1637 ir_node *succ = get_edge_src_irn(edge);
1639 fprintf(F, "edge: {sourcename: \"");
1641 fprintf(F, "\" targetname: \"");
1645 fprintf(F, " label: \"%d\" ", i);
1646 fprintf(F, OUT_EDGE_ATTR);
1653 /** Dumps a node and its edges but not the block edge */
1654 static void dump_node_wo_blockedge(ir_node *n, void *env) {
1657 dump_ir_data_edges(F, n);
1660 /** Dumps a node and its edges. */
1661 static void dump_whole_node(ir_node *n, void *env) {
1663 dump_node_wo_blockedge(n, env);
1664 if (!node_floats(n))
1665 dump_ir_block_edge(F, n);
1666 if (dump_new_edges_flag && edges_activated(current_ir_graph))
1667 dump_ir_edges(F, n);
1670 /** Dumps a const-like node. */
1671 static void dump_const_node(ir_node *n, void *env) {
1672 if (is_Block(n)) return;
1673 dump_node_wo_blockedge(n, env);
1676 /***********************************************************************/
1677 /* the following routines dump the nodes/irgs bracketed to graphs. */
1678 /***********************************************************************/
1680 /** Dumps a constant expression as entity initializer, array bound ...
1682 static void dump_const_expression(FILE *F, ir_node *value) {
1683 ir_graph *rem = current_ir_graph;
1684 int rem_dump_const_local = dump_const_local;
1685 dump_const_local = 0;
1686 current_ir_graph = get_const_code_irg();
1687 irg_walk(value, dump_const_node, NULL, F);
1688 /* Decrease visited flag so that we walk with the same flag for the next
1689 expression. This guarantees that we don't dump the same node twice,
1690 as for const expressions cse is performed to save memory. */
1691 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph) -1);
1692 current_ir_graph = rem;
1693 dump_const_local = rem_dump_const_local;
1696 /** Dump a block as graph containing its nodes.
1698 * Expects to find nodes belonging to the block as list in its
1700 * Dumps the edges of all nodes including itself. */
1701 static void dump_whole_block(FILE *F, ir_node *block) {
1703 ird_color_t color = ird_color_block_background;
1705 assert(is_Block(block));
1707 fprintf(F, "graph: { title: \"");
1708 PRINT_NODEID(block);
1709 fprintf(F, "\" label: \"");
1710 dump_node_label(F, block);
1712 if (get_opt_dump_abstvals())
1713 fprintf(F, " seqno: %d", (int)get_Block_seqno(block));
1716 /* colorize blocks */
1717 if (! get_Block_matured(block))
1718 color = ird_color_block_background;
1719 if (is_Block_dead(block))
1720 color = ird_color_dead_block_background;
1722 fprintf(F, "\" status:clustered ");
1723 print_vcg_color(F, color);
1726 /* yComp can show attributes for blocks, XVCG parses but ignores them */
1727 dump_node_info(F, block);
1728 print_dbg_info(F, get_irn_dbg_info(block));
1730 /* dump the blocks edges */
1731 dump_ir_data_edges(F, block);
1733 if (dump_block_edge_hook)
1734 dump_block_edge_hook(F, block);
1736 /* dump the nodes that go into the block */
1737 for (node = ird_get_irn_link(block); node; node = ird_get_irn_link(node)) {
1739 dump_ir_data_edges(F, node);
1742 /* Close the vcg information for the block */
1744 dump_const_node_local(F, block);
1746 dump_irn_chi_term(F, block);
1751 /** dumps a graph block-wise. Expects all blockless nodes in arr in irgs link.
1752 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1754 dump_block_graph(FILE *F, ir_graph *irg) {
1756 ir_graph *rem = current_ir_graph;
1757 ir_node **arr = ird_get_irg_link(irg);
1758 current_ir_graph = irg;
1760 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1761 ir_node * node = arr[i];
1762 if (is_Block(node)) {
1763 /* Dumps the block and all the nodes in the block, which are to
1764 be found in Block->link. */
1765 dump_whole_block(F, node);
1767 /* Nodes that are not in a Block. */
1769 if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
1770 dump_const_block_local(F, node);
1772 dump_ir_data_edges(F, node);
1774 if (dump_new_edges_flag && edges_activated(irg))
1775 dump_ir_edges(F, node);
1778 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1779 dump_loop_nodes_into_graph(F, irg);
1781 current_ir_graph = rem;
1785 * Dump the info for an irg.
1786 * Parsed by XVCG but not shown. use yComp.
1788 static void dump_graph_info(FILE *F, ir_graph *irg) {
1789 fprintf(F, "info1: \"");
1790 dump_entity_to_file(F, get_irg_entity(irg), dump_verbosity_entattrs | dump_verbosity_entconsts);
1794 /** Dumps an irg as a graph clustered by block nodes.
1795 * If interprocedural view edges can point to nodes out of this graph.
1797 static void dump_graph_from_list(FILE *F, ir_graph *irg) {
1798 ir_entity *ent = get_irg_entity(irg);
1800 fprintf(F, "graph: { title: \"");
1802 fprintf(F, "\" label: \"%s\" status:clustered color:%s \n",
1803 get_ent_dump_name(ent), color_names[ird_color_prog_background]);
1805 dump_graph_info(F, irg);
1806 print_dbg_info(F, get_entity_dbg_info(ent));
1808 dump_block_graph(F, irg);
1810 /* Close the vcg information for the irg */
1811 fprintf(F, "}\n\n");
1814 /** dumps a graph extended block-wise. Expects all blockless nodes in arr in irgs link.
1815 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1817 dump_extblock_graph(FILE *F, ir_graph *irg) {
1819 ir_graph *rem = current_ir_graph;
1820 ir_extblk **arr = ird_get_irg_link(irg);
1821 current_ir_graph = irg;
1823 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1824 ir_extblk *extbb = arr[i];
1825 ir_node *leader = get_extbb_leader(extbb);
1828 fprintf(F, "graph: { title: \"");
1829 PRINT_EXTBBID(leader);
1830 fprintf(F, "\" label: \"ExtBB %ld\" status:clustered color:lightgreen\n",
1831 get_irn_node_nr(leader));
1833 for (j = ARR_LEN(extbb->blks) - 1; j >= 0; --j) {
1834 ir_node * node = extbb->blks[j];
1835 if (is_Block(node)) {
1836 /* Dumps the block and all the nodes in the block, which are to
1837 be found in Block->link. */
1838 dump_whole_block(F, node);
1840 /* Nodes that are not in a Block. */
1842 if (is_Bad(get_nodes_block(node)) && !node_floats(node)) {
1843 dump_const_block_local(F, node);
1845 dump_ir_data_edges(F, node);
1851 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1852 dump_loop_nodes_into_graph(F, irg);
1854 current_ir_graph = rem;
1859 /*******************************************************************/
1860 /* Basic type and entity nodes and edges. */
1861 /*******************************************************************/
1863 /** dumps the edges between nodes and their type or entity attributes. */
1864 static void dump_node2type_edges(ir_node *n, void *env)
1869 switch (get_irn_opcode(n)) {
1871 /* @@@ some consts have an entity */
1874 if (SYMCONST_HAS_TYPE(get_SymConst_kind(n)))
1875 print_node_type_edge(F,n,get_SymConst_type(n),NODE2TYPE_EDGE_ATTR);
1878 print_node_ent_edge(F,n,get_Sel_entity(n),NODE2TYPE_EDGE_ATTR);
1881 print_node_type_edge(F,n,get_Call_type(n),NODE2TYPE_EDGE_ATTR);
1884 print_node_type_edge(F,n,get_Alloc_type(n),NODE2TYPE_EDGE_ATTR);
1887 print_node_type_edge(F,n,get_Free_type(n),NODE2TYPE_EDGE_ATTR);
1890 print_node_type_edge(F,n,get_Cast_type(n),NODE2TYPE_EDGE_ATTR);
1898 static int print_type_info(FILE *F, ir_type *tp) {
1901 if (get_type_state(tp) == layout_undefined) {
1902 fprintf(F, "state: layout_undefined\n");
1904 fprintf(F, "state: layout_fixed,\n");
1906 if (get_type_mode(tp))
1907 fprintf(F, "mode: %s,\n", get_mode_name_ex(get_type_mode(tp), &bad));
1908 fprintf(F, "size: %db,\n", get_type_size_bits(tp));
1913 static void print_typespecific_info(FILE *F, ir_type *tp) {
1914 switch (get_type_tpop_code(tp)) {
1916 fprintf(F, "peculiarity: %s\n", get_peculiarity_string(get_class_peculiarity(tp)));
1921 fprintf(F, "variadicity: %s\n", get_variadicity_name(get_method_variadicity(tp)));
1922 fprintf(F, "params: %d\n", get_method_n_params(tp));
1923 fprintf(F, "results: %d\n", get_method_n_ress(tp));
1929 case tpo_enumeration:
1941 static void print_typespecific_vcgattr(FILE *F, ir_type *tp) {
1942 switch (get_type_tpop_code(tp)) {
1944 if (peculiarity_existent == get_class_peculiarity(tp))
1945 fprintf(F, " " TYPE_CLASS_NODE_ATTR);
1947 fprintf(F, " " TYPE_DESCRIPTION_NODE_ATTR);
1950 fprintf(F, " " TYPE_METH_NODE_ATTR);
1958 case tpo_enumeration:
1970 int dump_type_node(FILE *F, ir_type *tp)
1974 fprintf(F, "node: {title: ");
1976 fprintf(F, " label: \"%s %s\"", get_type_tpop_name(tp), get_type_name_ex(tp, &bad));
1977 fprintf(F, " info1: \"");
1979 bad |= print_type_info(F, tp);
1980 print_typespecific_info(F, tp);
1982 dump_type_to_file(F, tp, dump_verbosity_max);
1985 print_dbg_info(F, get_type_dbg_info(tp));
1986 print_typespecific_vcgattr(F, tp);
1993 void dump_entity_node(FILE *F, ir_entity *ent, int color)
1995 fprintf(F, "node: {title: \"");
1996 PRINT_ENTID(ent); fprintf(F, "\"");
1997 fprintf(F, DEFAULT_TYPE_ATTRIBUTE);
1998 fprintf(F, "label: ");
1999 fprintf(F, "\"ent %s\" ", get_ent_dump_name(ent));
2001 fprintf(F, "color:%d", color);
2003 fprintf(F, ENTITY_NODE_ATTR);
2004 fprintf(F, "\n info1: \"");
2006 dump_entity_to_file(F, ent, dump_verbosity_entattrs | dump_verbosity_entconsts);
2009 print_dbg_info(F, get_entity_dbg_info(ent));
2013 static void dump_enum_item(FILE *F, ir_type *tp, int pos)
2016 ir_enum_const *ec = get_enumeration_const(tp, pos);
2017 ident *id = get_enumeration_nameid(ec);
2018 tarval *tv = get_enumeration_value(ec);
2021 tarval_snprintf(buf, sizeof(buf), tv);
2023 strncpy(buf, "<not set>", sizeof(buf));
2024 fprintf(F, "node: {title: \"");
2025 PRINT_ITEMID(tp, pos); fprintf(F, "\"");
2026 fprintf(F, DEFAULT_ENUM_ITEM_ATTRIBUTE);
2027 fprintf(F, "label: ");
2028 fprintf(F, "\"enum item %s\" " ENUM_ITEM_NODE_ATTR, get_id_str(id));
2029 fprintf(F, "\n info1: \"value: %s\"}\n", buf);
2032 /* dumps a type or entity and it's edges. */
2034 dump_type_info(type_or_ent *tore, void *env) {
2036 int i = 0; /* to shutup gcc */
2038 /* dump this type or entity */
2040 switch (get_kind(tore)) {
2042 ir_entity *ent = (ir_entity *)tore;
2045 dump_entity_node(F, ent, 0);
2047 /* skip this to reduce graph. Member edge of type is parallel to this edge. *
2048 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2049 ENT_OWN_EDGE_ATTR "}\n", ent, get_entity_owner(ent));*/
2050 print_ent_type_edge(F,ent, get_entity_type(ent), ENT_TYPE_EDGE_ATTR);
2051 if (is_Class_type(get_entity_owner(ent))) {
2052 for(i = 0; i < get_entity_n_overwrites(ent); i++)
2053 print_ent_ent_edge(F,ent, get_entity_overwrites(ent, i), 0, ENT_OVERWRITES_EDGE_ATTR);
2055 /* attached subgraphs */
2056 if (const_entities && (get_entity_variability(ent) != variability_uninitialized)) {
2057 if (is_atomic_entity(ent)) {
2058 value = get_atomic_ent_value(ent);
2060 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2061 /* DDMN(value); $$$ */
2062 dump_const_expression(F, value);
2065 if (is_compound_entity(ent)) {
2066 for (i = 0; i < get_compound_ent_n_values(ent); i++) {
2067 value = get_compound_ent_value(ent, i);
2069 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2070 dump_const_expression(F, value);
2071 print_ent_ent_edge(F, ent, get_compound_ent_value_member(ent, i), 0, ENT_CORR_EDGE_ATTR, i);
2073 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2074 ENT_CORR_EDGE_ATTR "}\n", GET_ENTID(ent),
2075 get_compound_ent_value_member(ent, i), i);
2084 ir_type *tp = (ir_type *)tore;
2085 dump_type_node(F, tp);
2086 /* and now the edges */
2087 switch (get_type_tpop_code(tp)) {
2089 for (i=0; i < get_class_n_supertypes(tp); i++)
2090 print_type_type_edge(F, tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2091 for (i=0; i < get_class_n_members(tp); i++)
2092 print_type_ent_edge(F,tp,get_class_member(tp, i),TYPE_MEMBER_EDGE_ATTR);
2095 for (i=0; i < get_struct_n_members(tp); i++)
2096 print_type_ent_edge(F,tp,get_struct_member(tp, i),TYPE_MEMBER_EDGE_ATTR);
2099 for (i = 0; i < get_method_n_params(tp); i++)
2100 print_type_type_edge(F,tp,get_method_param_type(tp, i),METH_PAR_EDGE_ATTR,i);
2101 for (i = 0; i < get_method_n_ress(tp); i++)
2102 print_type_type_edge(F,tp,get_method_res_type(tp, i),METH_RES_EDGE_ATTR,i);
2105 for (i = 0; i < get_union_n_members(tp); i++)
2106 print_type_ent_edge(F,tp,get_union_member(tp, i),UNION_EDGE_ATTR);
2109 print_type_type_edge(F,tp,get_array_element_type(tp),ARR_ELT_TYPE_EDGE_ATTR);
2110 print_type_ent_edge(F,tp,get_array_element_entity(tp),ARR_ENT_EDGE_ATTR);
2111 for (i = 0; i < get_array_n_dimensions(tp); i++) {
2112 ir_node *upper = get_array_upper_bound(tp, i);
2113 ir_node *lower = get_array_lower_bound(tp, i);
2114 print_node_type_edge(F, upper, tp, "label: \"upper %d\"", get_array_order(tp, i));
2115 print_node_type_edge(F, lower, tp, "label: \"lower %d\"", get_array_order(tp, i));
2116 dump_const_expression(F, upper);
2117 dump_const_expression(F, lower);
2120 case tpo_enumeration:
2121 for (i = 0; i < get_enumeration_n_enums(tp); ++i) {
2122 dump_enum_item(F, tp, i);
2123 print_enum_item_edge(F, tp, i, "label: \"item %d\"", i);
2127 print_type_type_edge(F,tp,get_pointer_points_to_type(tp), PTR_PTS_TO_EDGE_ATTR);
2134 break; /* case k_type */
2137 printf(" *** irdump, dump_type_info(l.%i), faulty type.\n", __LINE__);
2138 } /* switch kind_or_entity */
2141 typedef struct _h_env {
2146 /** For dumping class hierarchies.
2147 * Dumps a class type node and a superclass edge.
2148 * If env->dump_ent dumps entities of classes and overwrites edges.
2151 dump_class_hierarchy_node(type_or_ent *tore, void *ctx) {
2154 int i = 0; /* to shutup gcc */
2156 /* dump this type or entity */
2157 switch (get_kind(tore)) {
2159 ir_entity *ent = (ir_entity *)tore;
2160 if (get_entity_owner(ent) == get_glob_type()) break;
2161 if (!is_Method_type(get_entity_type(ent))) break; /* GL */
2162 if (env->dump_ent && is_Class_type(get_entity_owner(ent))) {
2164 dump_entity_node(F, ent, 0);
2166 print_type_ent_edge(F,get_entity_owner(ent),ent,TYPE_MEMBER_EDGE_ATTR);
2167 for(i = 0; i < get_entity_n_overwrites(ent); i++)
2168 print_ent_ent_edge(F, get_entity_overwrites(ent, i), ent, 0, ENT_OVERWRITES_EDGE_ATTR);
2173 ir_type *tp = (ir_type *)tore;
2174 if (tp == get_glob_type()) break;
2175 switch (get_type_tpop_code(tp)) {
2177 dump_type_node(F, tp);
2178 /* and now the edges */
2179 for (i=0; i < get_class_n_supertypes(tp); i++) {
2180 print_type_type_edge(F,tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2185 break; /* case k_type */
2188 printf(" *** irdump, dump_class_hierarchy_node(l.%i), faulty type.\n", __LINE__);
2189 } /* switch kind_or_entity */
2192 /*******************************************************************/
2193 /* dump analysis information that is expressed in graph terms. */
2194 /*******************************************************************/
2196 /* dump out edges */
2198 dump_out_edge(ir_node *n, void *env) {
2201 for (i = 0; i < get_irn_n_outs(n); i++) {
2202 assert(get_irn_out(n, i));
2203 fprintf(F, "edge: {sourcename: \"");
2205 fprintf(F, "\" targetname: \"");
2206 PRINT_NODEID(get_irn_out(n, i));
2207 fprintf(F, "\" color: red linestyle: dashed");
2213 dump_loop_label(FILE *F, ir_loop *loop) {
2214 fprintf(F, "loop %d, %d sons, %d nodes",
2215 get_loop_depth(loop), get_loop_n_sons(loop), get_loop_n_nodes(loop));
2218 static INLINE void dump_loop_info(FILE *F, ir_loop *loop) {
2219 fprintf(F, " info1: \"");
2220 fprintf(F, " loop nr: %d", get_loop_loop_nr(loop));
2221 #ifdef DEBUG_libfirm /* GL @@@ debug analyses */
2222 fprintf(F, "\n The loop was analyzed %d times.", PTR_TO_INT(get_loop_link(loop)));
2228 dump_loop_node(FILE *F, ir_loop *loop) {
2229 fprintf(F, "node: {title: \"");
2231 fprintf(F, "\" label: \"");
2232 dump_loop_label(F, loop);
2234 dump_loop_info(F, loop);
2239 dump_loop_node_edge(FILE *F, ir_loop *loop, int i) {
2241 fprintf(F, "edge: {sourcename: \"");
2243 fprintf(F, "\" targetname: \"");
2244 PRINT_NODEID(get_loop_node(loop, i));
2245 fprintf(F, "\" color: green");
2250 dump_loop_son_edge(FILE *F, ir_loop *loop, int i) {
2252 fprintf(F, "edge: {sourcename: \"");
2254 fprintf(F, "\" targetname: \"");
2255 PRINT_LOOPID(get_loop_son(loop, i));
2256 fprintf(F, "\" color: darkgreen label: \"%d\"}\n",
2257 get_loop_element_pos(loop, get_loop_son(loop, i)));
2261 void dump_loops(FILE *F, ir_loop *loop) {
2263 /* dump this loop node */
2264 dump_loop_node(F, loop);
2266 /* dump edges to nodes in loop -- only if it is a real loop */
2267 if (get_loop_depth(loop) != 0) {
2268 for (i = 0; i < get_loop_n_nodes(loop); i++) {
2269 dump_loop_node_edge(F, loop, i);
2272 for (i = 0; i < get_loop_n_sons(loop); i++) {
2273 dump_loops(F, get_loop_son(loop, i));
2274 dump_loop_son_edge(F, loop, i);
2279 void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg) {
2280 ir_graph *rem = current_ir_graph;
2281 current_ir_graph = irg;
2283 if (get_irg_loop(irg)) dump_loops(F, get_irg_loop(irg));
2285 current_ir_graph = rem;
2290 * dumps the VCG header
2292 void dump_vcg_header(FILE *F, const char *name, const char *layout, const char *orientation) {
2298 label = edge_label ? "yes" : "no";
2299 if (! layout) layout = "Compilergraph";
2300 if (!orientation) orientation = "bottom_to_top";
2304 "graph: { title: \"ir graph of %s\"\n"
2305 "display_edge_labels: %s\n"
2306 "layoutalgorithm: mindepth //$ \"%s\"\n"
2307 "manhattan_edges: yes\n"
2308 "port_sharing: no\n"
2310 "classname 1: \"intrablock Data\"\n"
2311 "classname 2: \"Block\"\n"
2312 "classname 3: \"Entity type\"\n"
2313 "classname 4: \"Entity owner\"\n"
2314 "classname 5: \"Method Param\"\n"
2315 "classname 6: \"Method Res\"\n"
2316 "classname 7: \"Super\"\n"
2317 "classname 8: \"Union\"\n"
2318 "classname 9: \"Points-to\"\n"
2319 "classname 10: \"Array Element Type\"\n"
2320 "classname 11: \"Overwrites\"\n"
2321 "classname 12: \"Member\"\n"
2322 "classname 13: \"Control Flow\"\n"
2323 "classname 14: \"intrablock Memory\"\n"
2324 "classname 15: \"Dominators\"\n"
2325 "classname 16: \"interblock Data\"\n"
2326 "classname 17: \"interblock Memory\"\n"
2327 "classname 18: \"Exception Control Flow for Interval Analysis\"\n"
2328 "classname 19: \"Postdominators\"\n"
2329 "classname 20: \"Keep Alive\"\n"
2330 "classname 21: \"Out Edges\"\n"
2331 "classname 22: \"Macro Block Edges\"\n"
2332 "infoname 1: \"Attribute\"\n"
2333 "infoname 2: \"Verification errors\"\n"
2334 "infoname 3: \"Debug info\"\n",
2335 name, label, layout, orientation);
2337 for (i = 0; i < ird_color_count; ++i) {
2338 if (color_rgb[i] != NULL) {
2339 fprintf(F, "colorentry %s: %s\n", color_names[i], color_rgb[i]);
2342 fprintf(F, "\n"); /* a separator */
2348 * @param irg The graph to be dumped
2349 * @param suffix1 first filename suffix
2350 * @param suffix2 second filename suffix
2352 FILE *vcg_open(ir_graph *irg, const char * suffix1, const char *suffix2) {
2354 const char *nm = get_irg_dump_name(irg);
2355 int len = strlen(nm), i, j;
2356 char *fname; /* filename to put the vcg information in */
2358 if (!suffix1) suffix1 = "";
2359 if (!suffix2) suffix2 = "";
2361 /* open file for vcg graph */
2362 fname = xmalloc (len * 2 + strlen(suffix1) + strlen(suffix2) + 5);
2364 /* strncpy (fname, nm, len); */ /* copy the filename */
2366 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2368 fname[j] = '@'; j++; fname[j] = '1'; j++;
2369 } else if (nm[i] == '@') {
2370 fname[j] = '@'; j++; fname[j] = '2'; j++;
2372 fname[j] = nm[i]; j++;
2376 strcat(fname, suffix1); /* append file suffix */
2377 strcat(fname, suffix2); /* append file suffix */
2378 strcat(fname, ".vcg"); /* append the .vcg suffix */
2380 /* vcg really expect only a <CR> at end of line, so
2381 * the "b"inary mode is what you mean (and even needed for Win32)
2383 F = fopen(fname, "wb"); /* open file for writing */
2395 * @param name prefix file name
2396 * @param suffix filename suffix
2398 FILE *vcg_open_name(const char *name, const char *suffix) {
2400 char *fname; /* filename to put the vcg information in */
2401 int i, j, len = strlen(name);
2403 if (!suffix) suffix = "";
2405 /** open file for vcg graph */
2406 fname = xmalloc(len * 2 + 5 + strlen(suffix));
2407 /* strcpy (fname, name);*/ /* copy the filename */
2409 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2410 if (name[i] == '/') {
2411 fname[j] = '@'; j++; fname[j] = '1'; j++;
2412 } else if (name[i] == '@') {
2413 fname[j] = '@'; j++; fname[j] = '2'; j++;
2415 fname[j] = name[i]; j++;
2419 strcat(fname, suffix);
2420 strcat(fname, ".vcg"); /* append the .vcg suffix */
2422 /* vcg really expect only a <CR> at end of line, so
2423 * the "b"inary mode is what you mean (and even needed for Win32)
2425 F = fopen(fname, "wb"); /* open file for writing */
2435 * Dumps the vcg file footer
2437 void dump_vcg_footer(FILE *F) {
2441 /************************************************************************/
2442 /************************************************************************/
2443 /* Routines that dump all or parts of the firm representation to a file */
2444 /************************************************************************/
2445 /************************************************************************/
2447 /************************************************************************/
2448 /* Dump ir graphs, different formats and additional information. */
2449 /************************************************************************/
2451 typedef void (*do_dump_graph_func) (ir_graph *irg, FILE *out);
2453 static void do_dump(ir_graph *irg, const char *suffix, const char *suffix_ip,
2454 const char *suffix_nonip, do_dump_graph_func dump_func)
2458 const char *suffix1;
2460 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2463 rem = current_ir_graph;
2464 current_ir_graph = irg;
2465 if (get_interprocedural_view())
2466 suffix1 = suffix_ip;
2468 suffix1 = suffix_nonip;
2469 current_ir_graph = rem;
2471 out = vcg_open(irg, suffix, suffix1);
2473 dump_func(irg, out);
2478 void dump_ir_graph_file(ir_graph *irg, FILE *out)
2480 if (dump_backedge_information_flag
2481 && get_irg_loopinfo_state(irg) != loopinfo_consistent) {
2482 construct_backedges(irg);
2485 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2487 /* call the dump graph hook */
2488 if (dump_ir_graph_hook) {
2489 if (dump_ir_graph_hook(out, irg)) {
2494 /* walk over the graph */
2495 /* dump_whole_node must be called in post visiting predecessors */
2496 ird_walk_graph(irg, NULL, dump_whole_node, out);
2498 /* dump the out edges in a separate walk */
2499 if ((dump_out_edge_flag) && (get_irg_outs_state(irg) != outs_none)) {
2500 irg_out_walk(get_irg_start(irg), dump_out_edge, NULL, out);
2503 dump_vcg_footer(out);
2506 /** Routine to dump a graph, blocks as conventional nodes. */
2507 void dump_ir_graph(ir_graph *irg, const char *suffix )
2509 do_dump(irg, suffix, "-pure-ip", "-pure", dump_ir_graph_file);
2512 void dump_ir_block_graph_file(ir_graph *irg, FILE *out)
2516 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2518 construct_block_lists(irg);
2521 * If we are in the interprocedural view, we dump not
2522 * only the requested irg but also all irgs that can be reached
2525 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2526 ir_graph *g = get_irp_irg(i);
2527 ir_node **arr = ird_get_irg_link(g);
2529 dump_graph_from_list(out, g);
2534 dump_vcg_footer(out);
2537 /* Dump a firm graph without explicit block nodes. */
2538 void dump_ir_block_graph(ir_graph *irg, const char *suffix)
2540 do_dump(irg, suffix, "-ip", "", dump_ir_block_graph_file);
2543 void dump_ir_extblock_graph_file(ir_graph *irg, FILE *F)
2546 ir_entity *ent = get_irg_entity(irg);
2548 if (get_irg_extblk_state(irg) != extblk_valid)
2551 dump_vcg_header(F, get_irg_dump_name(irg), NULL, NULL);
2553 construct_extblock_lists(irg);
2555 fprintf(F, "graph: { title: \"");
2557 fprintf(F, "\" label: \"%s\" status:clustered color: white \n",
2558 get_ent_dump_name(ent));
2560 dump_graph_info(F, irg);
2561 print_dbg_info(F, get_entity_dbg_info(ent));
2563 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2564 ir_graph *irg = get_irp_irg(i);
2565 list_tuple *lists = ird_get_irg_link(irg);
2568 /* dump the extended blocks first */
2569 if (ARR_LEN(lists->extbb_list)) {
2570 ird_set_irg_link(irg, lists->extbb_list);
2571 dump_extblock_graph(F, irg);
2574 /* we may have blocks without extended blocks, bad for instance */
2575 if (ARR_LEN(lists->blk_list)) {
2576 ird_set_irg_link(irg, lists->blk_list);
2577 dump_block_graph(F, irg);
2580 DEL_ARR_F(lists->extbb_list);
2581 DEL_ARR_F(lists->blk_list);
2586 /* Close the vcg information for the irg */
2587 fprintf(F, "}\n\n");
2593 /* Dump a firm graph without explicit block nodes but grouped in extended blocks. */
2594 void dump_ir_extblock_graph(ir_graph *irg, const char *suffix)
2596 do_dump(irg, suffix, "-ip", "", dump_ir_extblock_graph_file);
2599 void dump_ir_graph_w_types_file(ir_graph *irg, FILE *out)
2601 ir_graph *rem = current_ir_graph;
2602 int rem_dump_const_local;
2604 rem = current_ir_graph;
2605 current_ir_graph = irg;
2606 rem_dump_const_local = dump_const_local;
2607 /* dumping types does not work with local nodes */
2608 dump_const_local = 0;
2610 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2612 /* dump common ir graph */
2613 irg_walk(get_irg_end(irg), NULL, dump_whole_node, out);
2614 /* dump type info */
2615 type_walk_irg(irg, dump_type_info, NULL, out);
2616 inc_irg_visited(get_const_code_irg());
2617 /* dump edges from graph to type info */
2618 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2620 dump_vcg_footer(out);
2621 dump_const_local = rem_dump_const_local;
2622 current_ir_graph = rem;
2625 /* dumps a graph with type information */
2626 void dump_ir_graph_w_types(ir_graph *irg, const char *suffix)
2628 do_dump(irg, suffix, "-pure-wtypes-ip", "-pure-wtypes",
2629 dump_ir_graph_w_types_file);
2632 void dump_ir_block_graph_w_types_file(ir_graph *irg, FILE *out)
2635 int rem_dump_const_local;
2636 ir_graph *rem = current_ir_graph;
2638 rem_dump_const_local = dump_const_local;
2639 /* dumping types does not work with local nodes */
2640 dump_const_local = 0;
2642 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2644 /* dump common blocked ir graph */
2645 construct_block_lists(irg);
2647 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2648 ir_node **arr = ird_get_irg_link(get_irp_irg(i));
2650 dump_graph_from_list(out, get_irp_irg(i));
2655 /* dump type info */
2656 current_ir_graph = irg;
2657 type_walk_irg(irg, dump_type_info, NULL, out);
2658 inc_irg_visited(get_const_code_irg());
2660 /* dump edges from graph to type info */
2661 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2663 dump_vcg_footer(out);
2664 dump_const_local = rem_dump_const_local;
2665 current_ir_graph = rem;
2668 void dump_ir_block_graph_w_types(ir_graph *irg, const char *suffix)
2670 do_dump(irg, suffix, "-wtypes-ip", "-wtypes",
2671 dump_ir_block_graph_w_types_file);
2674 /*---------------------------------------------------------------------*/
2675 /* The following routines dump a control flow graph. */
2676 /*---------------------------------------------------------------------*/
2679 dump_block_to_cfg(ir_node *block, void *env) {
2684 if (is_Block(block)) {
2685 /* This is a block. Dump a node for the block. */
2686 fprintf(F, "node: {title: \""); PRINT_NODEID(block);
2687 fprintf(F, "\" label: \"");
2688 if (block == get_irg_start_block(get_irn_irg(block)))
2689 fprintf(F, "Start ");
2690 if (block == get_irg_end_block(get_irn_irg(block)))
2693 fprintf(F, "%s ", get_op_name(get_irn_op(block)));
2694 PRINT_NODEID(block);
2696 fprintf(F, "info1:\"");
2698 /* the generic version. */
2699 dump_irnode_to_file(F, block);
2701 /* Check whether we have bad predecessors to color the block. */
2702 for (i = 0; i < get_Block_n_cfgpreds(block); ++i)
2703 if ((fl = is_Bad(get_Block_cfgpred(block, i))))
2706 fprintf(F, "\""); /* closing quote of info */
2708 if ((block == get_irg_start_block(get_irn_irg(block))) ||
2709 (block == get_irg_end_block(get_irn_irg(block))) )
2710 fprintf(F, " color:blue ");
2712 fprintf(F, " color:yellow ");
2715 /* Dump the edges */
2716 for ( i = 0; i < get_Block_n_cfgpreds(block); i++)
2717 if (get_irn_op(skip_Proj(get_Block_cfgpred(block, i))) != op_Bad) {
2718 pred = get_nodes_block(skip_Proj(get_Block_cfgpred(block, i)));
2719 fprintf(F, "edge: { sourcename: \"");
2720 PRINT_NODEID(block);
2721 fprintf(F, "\" targetname: \"");
2723 fprintf(F, "\"}\n");
2726 /* Dump dominator/postdominator edge */
2727 if (dump_dominator_information_flag) {
2728 if (get_irg_dom_state(current_ir_graph) == dom_consistent && get_Block_idom(block)) {
2729 pred = get_Block_idom(block);
2730 fprintf(F, "edge: { sourcename: \"");
2731 PRINT_NODEID(block);
2732 fprintf(F, "\" targetname: \"");
2734 fprintf(F, "\" " DOMINATOR_EDGE_ATTR "}\n");
2736 if (get_irg_postdom_state(current_ir_graph) == dom_consistent && get_Block_ipostdom(block)) {
2737 pred = get_Block_ipostdom(block);
2738 fprintf(F, "edge: { sourcename: \"");
2739 PRINT_NODEID(block);
2740 fprintf(F, "\" targetname: \"");
2742 fprintf(F, "\" " POSTDOMINATOR_EDGE_ATTR "}\n");
2748 void dump_cfg(ir_graph *irg, const char *suffix)
2751 /* if a filter is set, dump only the irg's that match the filter */
2752 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2755 f = vcg_open(irg, suffix, "-cfg");
2757 ir_graph *rem = current_ir_graph;
2758 #ifdef INTERPROCEDURAL_VIEW
2759 int ipv = get_interprocedural_view();
2762 current_ir_graph = irg;
2763 dump_vcg_header(f, get_irg_dump_name(irg), NULL, NULL);
2765 #ifdef INTERPROCEDURAL_VIEW
2767 printf("Warning: dumping cfg not in interprocedural view!\n");
2768 set_interprocedural_view(0);
2772 /* walk over the blocks in the graph */
2773 irg_block_walk(get_irg_end(irg), dump_block_to_cfg, NULL, f);
2774 dump_node(f, get_irg_bad(irg));
2776 #ifdef INTERPROCEDURAL_VIEW
2777 set_interprocedural_view(ipv);
2781 current_ir_graph = rem;
2786 static void descend_and_dump(FILE *F, ir_node *n, int depth, pset *mark_set) {
2787 if (pset_find_ptr(mark_set, n)) return;
2789 pset_insert_ptr(mark_set, n);
2792 int i, start = is_Block(n) ? 0 : -1;
2793 dump_whole_node(n, F);
2794 for (i = start; i < get_irn_arity(n); ++i)
2795 descend_and_dump(F, get_irn_n(n, i), depth-1, mark_set);
2798 /* Don't dump edges to nodes further out. These might be edges to
2799 nodes we already dumped, if there is a shorter path to these. */
2803 static int subgraph_counter = 0;
2804 void dump_subgraph(ir_node *root, int depth, const char *suffix) {
2808 sprintf(buf, "-subg_%03d", subgraph_counter++);
2809 F = vcg_open(get_irn_irg(root), suffix, buf);
2811 pset *mark_set = pset_new_ptr(1);
2812 dump_vcg_header(F, get_irg_dump_name(get_irn_irg(root)), NULL, NULL);
2813 descend_and_dump(F, root, depth, mark_set);
2820 #ifdef INTERPROCEDURAL_VIEW
2821 void dump_callgraph(const char *suffix) {
2822 FILE *F = vcg_open_name("Callgraph", suffix);
2825 int i, rem = edge_label;
2828 dump_vcg_header(F, "Callgraph", NULL);
2830 //colorize = get_irp_callgraph_state() == irp_callgraph_and_calltree_consistent;
2832 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2833 ir_graph *irg = get_irp_irg(i);
2834 ir_entity *ent = get_irg_entity(irg);
2836 //int n_callees = get_irg_n_callees(irg);
2839 //color = colorize ? get_entity_color(ent) : ird_color_green;
2840 color = ird_color_green;
2841 dump_entity_node(F, ent, color);
2842 for (j = 0; j < n_callees; ++j) {
2843 ir_entity *c = get_irg_entity(get_irg_callee(irg, j));
2844 //if (id_is_prefix(prefix, get_entity_ld_ident(c))) continue;
2845 int be = is_irg_callee_backedge(irg, j);
2848 "label:\"recursion %d\" color:%d" :
2849 "label:\"calls %d\" color:%d";
2850 print_ent_ent_edge(F, ent, c, be, attr, get_irg_callee_loop_depth(irg, j), color);
2860 /* Dump all irgs in interprocedural view to a single file. */
2861 void dump_all_cg_block_graph(const char *suffix) {
2862 FILE *f = vcg_open_name("All_graphs", suffix);
2866 int rem_view = get_interprocedural_view();
2868 set_interprocedural_view(1);
2869 dump_vcg_header(f, "All_graphs", NULL);
2871 /* collect nodes in all irgs reachable in call graph*/
2872 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2873 ird_set_irg_link(get_irp_irg(i), NULL);
2875 cg_walk(clear_link, collect_node, NULL);
2877 /* dump all graphs */
2878 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2879 current_ir_graph = get_irp_irg(i);
2880 assert(ird_get_irg_link(current_ir_graph));
2881 dump_graph_from_list(f, current_ir_graph);
2882 DEL_ARR_F(ird_get_irg_link(current_ir_graph));
2887 set_interprocedural_view(rem_view);
2892 /*---------------------------------------------------------------------*/
2893 /* the following routines dumps type information without any ir nodes. */
2894 /*---------------------------------------------------------------------*/
2897 dump_type_graph(ir_graph *irg, const char *suffix)
2901 /* if a filter is set, dump only the irg's that match the filter */
2902 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
2904 f = vcg_open(irg, suffix, "-type");
2906 ir_graph *rem = current_ir_graph;
2907 current_ir_graph = irg;
2909 dump_vcg_header(f, get_irg_dump_name(irg), "Hierarchic", NULL);
2911 /* walk over the blocks in the graph */
2912 type_walk_irg(irg, dump_type_info, NULL, f);
2913 /* The walker for the const code can be called several times for the
2914 same (sub) expression. So that no nodes are dumped several times
2915 we decrease the visited flag of the corresponding graph after each
2916 walk. So now increase it finally. */
2917 inc_irg_visited(get_const_code_irg());
2921 current_ir_graph = rem;
2926 dump_all_types(const char *suffix)
2928 FILE *f = vcg_open_name("All_types", suffix);
2930 dump_vcg_header(f, "All_types", "Hierarchic", NULL);
2931 type_walk(dump_type_info, NULL, f);
2932 inc_irg_visited(get_const_code_irg());
2940 dump_class_hierarchy(int entities, const char *suffix)
2942 FILE *f = vcg_open_name("class_hierarchy", suffix);
2947 env.dump_ent = entities;
2948 dump_vcg_header(f, "class_hierarchy", "Hierarchic", NULL);
2949 type_walk(dump_class_hierarchy_node, NULL, &env);
2956 /*---------------------------------------------------------------------*/
2957 /* dumps all graphs with the graph-dumper passed. Possible dumpers: */
2959 /* dump_ir_block_graph */
2961 /* dump_type_graph */
2962 /* dump_ir_graph_w_types */
2963 /*---------------------------------------------------------------------*/
2965 void dump_all_ir_graphs(dump_graph_func *dmp_grph, const char *suffix) {
2967 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2968 dmp_grph(get_irp_irg(i), suffix);
2972 /*--------------------------------------------------------------------------------*
2973 * Dumps a stand alone loop graph with firm nodes which belong to one loop node *
2974 * packed together in one subgraph/box *
2975 *--------------------------------------------------------------------------------*/
2977 void dump_loops_standalone(FILE *F, ir_loop *loop) {
2978 int i = 0, loop_node_started = 0, son_number = 0, first = 0;
2980 ir_loop *son = NULL;
2982 /* Dump a new loop node. */
2983 dump_loop_node(F, loop);
2985 /* Dump the loop elements. */
2986 for (i = 0; i < get_loop_n_elements(loop); i++) {
2987 le = get_loop_element(loop, i);
2989 if (get_kind(son) == k_ir_loop) {
2991 /* We are a loop son -> Recurse */
2993 if (loop_node_started) { /* Close the "firm-nodes" node first if we started one. */
2994 fprintf(F, "\" }\n");
2995 fprintf(F, "edge: {sourcename: \"");
2997 fprintf(F, "\" targetname: \"");
2999 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3000 loop_node_started = 0;
3002 dump_loop_son_edge(F, loop, son_number++);
3003 dump_loops_standalone(F, son);
3004 } else if (get_kind(son) == k_ir_node) {
3005 /* We are a loop node -> Collect firm nodes */
3007 ir_node *n = le.node;
3010 if (!loop_node_started) {
3011 /* Start a new node which contains all firm nodes of the current loop */
3012 fprintf(F, "node: { title: \"");
3014 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3015 loop_node_started = 1;
3020 bad |= dump_node_label(F, n);
3021 /* Causes indeterministic output: if (is_Block(n)) fprintf(F, "\t ->%d", (int)get_irn_link(n)); */
3022 if (has_backedges(n)) fprintf(F, "\t loop head!");
3023 } else { /* for callgraph loop tree */
3025 assert(get_kind(son) == k_ir_graph);
3027 /* We are a loop node -> Collect firm graphs */
3029 if (!loop_node_started) {
3030 /* Start a new node which contains all firm nodes of the current loop */
3031 fprintf(F, "node: { title: \"");
3033 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3034 loop_node_started = 1;
3038 fprintf(F, " %s", get_irg_dump_name(n));
3039 /* fprintf(F, " %s (depth %d)", get_irg_dump_name(n), n->callgraph_weighted_loop_depth); */
3043 if (loop_node_started) {
3044 fprintf(F, "\" }\n");
3045 fprintf(F, "edge: {sourcename: \"");
3047 fprintf(F, "\" targetname: \"");
3049 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3050 loop_node_started = 0;
3054 void dump_loop_tree(ir_graph *irg, const char *suffix)
3058 /* if a filter is set, dump only the irg's that match the filter */
3059 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
3061 f = vcg_open(irg, suffix, "-looptree");
3063 ir_graph *rem = current_ir_graph;
3064 int el_rem = edge_label;
3066 current_ir_graph = irg;
3069 dump_vcg_header(f, get_irg_dump_name(irg), "Tree", "top_to_bottom");
3071 if (get_irg_loop(irg))
3072 dump_loops_standalone(f, get_irg_loop(irg));
3077 edge_label = el_rem;
3078 current_ir_graph = rem;
3082 void dump_callgraph_loop_tree(const char *suffix) {
3084 F = vcg_open_name("Callgraph_looptree", suffix);
3085 dump_vcg_header(F, "callgraph looptree", "Tree", "top_to_bottom");
3086 dump_loops_standalone(F, irp->outermost_cg_loop);
3092 /*----------------------------------------------------------------------------*/
3093 /* Dumps the firm nodes in the loop tree to a graph along with the loop nodes.*/
3094 /*----------------------------------------------------------------------------*/
3096 void collect_nodeloop(FILE *F, ir_loop *loop, eset *loopnodes) {
3097 int i, son_number = 0, node_number = 0;
3099 if (dump_loop_information_flag) dump_loop_node(F, loop);
3101 for (i = 0; i < get_loop_n_elements(loop); i++) {
3102 loop_element le = get_loop_element(loop, i);
3103 if (*(le.kind) == k_ir_loop) {
3104 if (dump_loop_information_flag) dump_loop_son_edge(F, loop, son_number++);
3106 collect_nodeloop(F, le.son, loopnodes);
3108 if (dump_loop_information_flag) dump_loop_node_edge(F, loop, node_number++);
3109 eset_insert(loopnodes, le.node);
3114 void collect_nodeloop_external_nodes(ir_loop *loop, eset *loopnodes, eset *extnodes) {
3117 for(i = 0; i < get_loop_n_elements(loop); i++) {
3118 loop_element le = get_loop_element(loop, i);
3119 if (*(le.kind) == k_ir_loop) {
3121 collect_nodeloop_external_nodes(le.son, loopnodes, extnodes);
3123 if (is_Block(le.node)) start = 0; else start = -1;
3124 for (j = start; j < get_irn_arity(le.node); j++) {
3125 ir_node *pred = get_irn_n(le.node, j);
3126 if (!eset_contains(loopnodes, pred)) {
3127 eset_insert(extnodes, pred);
3128 if (!is_Block(pred)) {
3129 pred = get_nodes_block(pred);
3130 if (!eset_contains(loopnodes, pred)) eset_insert(extnodes, pred);
3138 void dump_loop(ir_loop *l, const char *suffix) {
3142 snprintf(name, sizeof(name), "loop_%d", get_loop_loop_nr(l));
3143 F = vcg_open_name(name, suffix);
3145 eset *loopnodes = eset_create();
3146 eset *extnodes = eset_create();
3149 dump_vcg_header(F, name, NULL, NULL);
3151 /* collect all nodes to dump */
3152 collect_nodeloop(F, l, loopnodes);
3153 collect_nodeloop_external_nodes(l, loopnodes, extnodes);
3155 /* build block lists */
3156 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes))
3157 set_irn_link(n, NULL);
3158 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes))
3159 set_irn_link(n, NULL);
3160 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes)) {
3162 b = get_nodes_block(n);
3163 set_irn_link(n, get_irn_link(b));
3167 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes)) {
3169 b = get_nodes_block(n);
3170 set_irn_link(n, get_irn_link(b));
3175 for (b = eset_first(loopnodes); b != NULL; b = eset_next(loopnodes)) {
3177 fprintf(F, "graph: { title: \"");
3179 fprintf(F, "\" label: \"");
3180 dump_node_opcode(F, b);
3181 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3182 fprintf(F, "\" status:clustered color:yellow\n");
3184 /* dump the blocks edges */
3185 dump_ir_data_edges(F, b);
3187 /* dump the nodes that go into the block */
3188 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3189 if (eset_contains(extnodes, n))
3190 overrule_nodecolor = ird_color_block_inout;
3192 overrule_nodecolor = ird_color_default_node;
3193 if (!eset_contains(extnodes, n)) dump_ir_data_edges(F, n);
3196 /* Close the vcg information for the block */
3198 dump_const_node_local(F, b);
3202 for (b = eset_first(extnodes); b != NULL; b = eset_next(extnodes)) {
3204 fprintf(F, "graph: { title: \"");
3206 fprintf(F, "\" label: \"");
3207 dump_node_opcode(F, b);
3208 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3209 fprintf(F, "\" status:clustered color:lightblue\n");
3211 /* dump the nodes that go into the block */
3212 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3213 if (!eset_contains(loopnodes, n))
3214 overrule_nodecolor = ird_color_block_inout;
3216 overrule_nodecolor = ird_color_default_node;
3217 if (eset_contains(loopnodes, n)) dump_ir_data_edges(F, n);
3220 /* Close the vcg information for the block */
3222 dump_const_node_local(F, b);
3226 eset_destroy(loopnodes);
3227 eset_destroy(extnodes);