2 * Copyright (C) 1995-2007 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"
55 #include "callgraph.h"
56 #include "irextbb_t.h"
58 #include "dbginfo_t.h"
70 extern void dump_irn_chi_term(FILE *FL, ir_node *n);
71 extern void dump_irn_state(FILE *FL, ir_node *n);
72 extern int get_opt_dump_abstvals(void);
73 typedef unsigned long SeqNo;
74 extern SeqNo get_Block_seqno(ir_node *n);
77 /* basis for a color range for vcg */
78 static int n_colors = 0;
79 static int base_color = 0;
81 /** Dump only irgs with names that start with this string */
82 static ident *dump_file_filter_id = NULL;
84 #define ERROR_TXT "<ERROR>"
86 /*******************************************************************/
87 /* flags to steer output */
88 /*******************************************************************/
90 /** An option to turn off edge labels */
91 static int edge_label = 1;
92 /** An option to turn off dumping values of constant entities */
93 static int const_entities = 1;
94 /** An option to dump the keep alive edges */
95 static int dump_keepalive = 0;
96 /** An option to dump ld_names instead of names. */
97 static int dump_ld_name = 1;
98 /** Compiler options to dump analysis information in dump_ir_graph */
99 static int dump_out_edge_flag = 0;
100 static int dump_loop_information_flag = 0;
101 static int dump_backedge_information_flag = 1;
102 static int dump_const_local = 0;
103 /** An option to dump all graph anchors */
104 static int dump_anchors = 0;
106 int dump_dominator_information_flag = 0;
107 int opt_dump_analysed_type_info = 1;
108 int opt_dump_pointer_values_to_info = 0; /* default off: for test compares!! */
110 static dumper_colors overrule_nodecolor = ird_color_default;
112 /** The vcg node attribute hook. */
113 static DUMP_IR_GRAPH_FUNC dump_ir_graph_hook = NULL;
114 /** The vcg node attribute hook. */
115 static DUMP_NODE_VCGATTR_FUNC dump_node_vcgattr_hook = NULL;
116 /** The vcg edge attribute hook. */
117 static DUMP_EDGE_VCGATTR_FUNC dump_edge_vcgattr_hook = NULL;
118 /** The vcg dump block edge hook */
119 static DUMP_NODE_EDGE_FUNC dump_block_edge_hook = NULL;
120 /** The vcg dump node edge hook. */
121 static DUMP_NODE_EDGE_FUNC dump_node_edge_hook = NULL;
123 /* Set the hook to be called to dump additional edges to a node. */
124 void set_dump_node_edge_hook(DUMP_NODE_EDGE_FUNC func) {
125 dump_node_edge_hook = func;
128 /* Get the additional edge dump hook. */
129 DUMP_NODE_EDGE_FUNC get_dump_node_edge_hook(void) {
130 return dump_node_edge_hook;
133 /* Set the hook to be called to dump additional edges to a block. */
134 void set_dump_block_edge_hook(DUMP_NODE_EDGE_FUNC func) {
135 dump_block_edge_hook = func;
138 /* Get the additional block edge dump hook. */
139 DUMP_NODE_EDGE_FUNC get_dump_block_edge_hook(void) {
140 return dump_node_edge_hook;
143 /* set the ir graph hook */
144 void set_dump_ir_graph_hook(DUMP_IR_GRAPH_FUNC hook) {
145 dump_ir_graph_hook = hook;
148 /* set the node attribute hook */
149 void set_dump_node_vcgattr_hook(DUMP_NODE_VCGATTR_FUNC hook) {
150 dump_node_vcgattr_hook = hook;
153 /* set the edge attribute hook */
154 void set_dump_edge_vcgattr_hook(DUMP_EDGE_VCGATTR_FUNC hook) {
155 dump_edge_vcgattr_hook = hook;
158 /* Returns 0 if dump_out_edge_flag or dump_loop_information_flag
159 * are set, else returns dump_const_local_flag.
161 int get_opt_dump_const_local(void) {
162 if (!dump_out_edge_flag && !dump_loop_information_flag)
163 return dump_const_local;
168 /* Set a prefix filter for output functions. */
169 void only_dump_method_with_name(ident *name) {
170 dump_file_filter_id = name;
173 /* Returns the prefix filter set with only_dump_method_with_name(). */
174 ident *get_dump_file_filter_ident(void) {
175 return dump_file_filter_id;
178 /* Returns non-zero if dump file filter is not set, or if it is a prefix of name. */
179 int is_filtered_dump_name(ident *name) {
180 if (!dump_file_filter_id) return 1;
181 return id_is_prefix(dump_file_filter_id, name);
184 /* To turn off display of edge labels. Edge labels often cause xvcg to
185 abort with a segmentation fault. */
186 void turn_off_edge_labels(void) {
190 void dump_consts_local(int flag) {
191 dump_const_local = flag;
194 void dump_constant_entity_values(int flag) {
195 const_entities = flag;
198 void dump_keepalive_edges(int flag) {
199 dump_keepalive = flag;
202 int get_opt_dump_keepalive_edges(void) {
203 return dump_keepalive;
206 void dump_out_edges(int flag) {
207 dump_out_edge_flag = flag;
210 void dump_dominator_information(int flag) {
211 dump_dominator_information_flag = flag;
214 void dump_loop_information(int flag) {
215 dump_loop_information_flag = flag;
218 void dump_backedge_information(int flag) {
219 dump_backedge_information_flag = flag;
222 /* Dump the information of type field specified in ana/irtypeinfo.h.
223 * If the flag is set, the type name is output in [] in the node label,
224 * else it is output as info.
226 void set_opt_dump_analysed_type_info(int flag) {
227 opt_dump_analysed_type_info = flag;
230 void dump_pointer_values_to_info(int flag) {
231 opt_dump_pointer_values_to_info = flag;
234 void dump_ld_names(int flag) {
238 void dump_all_anchors(int flag) {
242 /* -------------- some extended helper functions ----------------- */
245 * returns the name of a mode or <ERROR> if mode is NOT a mode object.
246 * in the later case, sets bad
248 const char *get_mode_name_ex(ir_mode *mode, int *bad) {
250 return get_mode_name(mode);
256 * returns the name of a type or <ERROR> if mode is NOT a mode object.
257 * in the later case, sets bad
259 const char *get_type_name_ex(ir_type *tp, int *bad) {
261 return get_type_name(tp);
267 * printf the VCG color to a file
269 static void print_vcg_color(FILE *F, dumper_colors color) {
270 static const char *color_names[32] = {
271 "white", "blue", "red", "green",
272 "yellow", "magenta", "cyan", "darkgray",
273 "darkblue", "darkred", "darkgreen", "darkyellow",
274 "darkmagenta", "darkcyan", "gold", "lightgray",
275 "lightblue", "lightred", "lightgreen", "lightyellow",
276 "lightmagenta", "lightcyan", "lilac", "turquoise",
277 "aquamarine", "khaki", "purple", "yellowgreen",
278 "pink", "orange", "orchid", "black"
281 if (color != ird_color_default)
282 fprintf(F, "color:%s", color_names[color]);
286 * prints the edge from a type S to a type T with additional info fmt, ...
289 static void print_type_type_edge(FILE *F, ir_type *S, ir_type *T, const char *fmt, ...)
294 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(S);
295 fprintf(F, " targetname: "); PRINT_TYPEID(T);
296 vfprintf(F, fmt, ap);
302 * prints the edge from a type T to an entity E with additional info fmt, ...
305 static void print_type_ent_edge(FILE *F, ir_type *T, ir_entity *E, const char *fmt, ...)
310 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(T);
311 fprintf(F, " targetname: \""); PRINT_ENTID(E); fprintf(F, "\"");
312 vfprintf(F, fmt, ap);
318 * prints the edge from an entity E to an entity T with additional info fmt, ...
321 static void print_ent_ent_edge(FILE *F, ir_entity *E, ir_entity *T, int backedge, const char *fmt, ...)
327 fprintf(F, "backedge: { sourcename: \"");
329 fprintf(F, "edge: { sourcename: \"");
331 fprintf(F, "\" targetname: \""); PRINT_ENTID(T); fprintf(F, "\"");
332 vfprintf(F, fmt, ap);
338 * prints the edge from an entity E to a type T with additional info fmt, ...
341 static void print_ent_type_edge(FILE *F, ir_entity *E, ir_type *T, const char *fmt, ...)
346 fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(E);
347 fprintf(F, "\" targetname: "); PRINT_TYPEID(T);
348 vfprintf(F, fmt, ap);
354 * prints the edge from a node N to a type T with additional info fmt, ...
357 static void print_node_type_edge(FILE *F, const ir_node *N, ir_type *T, const char *fmt, ...)
362 fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(N);
363 fprintf(F, "\" targetname: "); PRINT_TYPEID(T);
364 vfprintf(F, fmt, ap);
370 * prints the edge from a node N to an entity E with additional info fmt, ...
373 static void print_node_ent_edge(FILE *F, const ir_node *N, ir_entity *E, const char *fmt, ...)
378 fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(N);
379 fprintf(F, "\" targetname: \""); PRINT_ENTID(E);
381 vfprintf(F, fmt, ap);
387 * prints the edge from an entity E to a node N with additional info fmt, ...
390 static void print_ent_node_edge(FILE *F, ir_entity *E, const ir_node *N, const char *fmt, ...)
395 fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(E);
396 fprintf(F, "\" targetname: \""); PRINT_NODEID(N); fprintf(F, "\"");
397 vfprintf(F, fmt, ap);
403 * prints the edge from a type E to an enumeration item item with additional info fmt, ...
406 static void print_enum_item_edge(FILE *F, ir_type *E, int item, const char *fmt, ...)
411 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(E);
412 fprintf(F, " targetname: \""); PRINT_ITEMID(E, item); fprintf(F, "\" ");
413 vfprintf(F, fmt, ap);
418 /*-----------------------------------------------------------------*/
419 /* global and ahead declarations */
420 /*-----------------------------------------------------------------*/
422 static void dump_whole_node(ir_node *n, void *env);
423 static INLINE void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg);
425 /*-----------------------------------------------------------------*/
426 /* Helper functions. */
427 /*-----------------------------------------------------------------*/
430 * This map is used as a private link attr to be able to call dumper
431 * anywhere without destroying link fields.
433 static pmap *irdump_link_map = NULL;
435 /** NOT A STANDARD LIBFIRM INIT METHOD
437 * We do not want to integrate dumping into libfirm, i.e., if the dumpers
438 * are off, we want to have as few interferences as possible. Therefore the
439 * initialization is performed lazily and not called from within init_firm.
441 * Creates the link attribute map. */
442 static void init_irdump(void) {
443 /* We need a new, empty map. */
444 if (irdump_link_map) pmap_destroy(irdump_link_map);
445 irdump_link_map = pmap_create();
446 if (!dump_file_filter_id)
447 dump_file_filter_id = new_id_from_str("");
451 * Returns the private link field.
453 static void *ird_get_irn_link(ir_node *n) {
455 if (!irdump_link_map) return NULL;
457 if (pmap_contains(irdump_link_map, (void *)n))
458 res = pmap_get(irdump_link_map, (void *)n);
463 * Sets the private link field.
465 static void ird_set_irn_link(ir_node *n, void *x) {
466 if (!irdump_link_map)
468 pmap_insert(irdump_link_map, (void *)n, x);
472 * Gets the private link field of an irg.
474 static void *ird_get_irg_link(ir_graph *irg) {
476 if (!irdump_link_map) return NULL;
478 if (pmap_contains(irdump_link_map, (void *)irg))
479 res = pmap_get(irdump_link_map, (void *)irg);
484 * Sets the private link field of an irg.
486 static void ird_set_irg_link(ir_graph *irg, void *x) {
487 if (!irdump_link_map) init_irdump();
488 pmap_insert(irdump_link_map, (void *)irg, x);
492 * Walker, clears the private link field.
494 static void clear_link(ir_node * node, void * env) {
496 ird_set_irn_link(node, NULL);
500 * If the entity has a ld_name, returns it if the dump_ld_name is set,
501 * else returns the name of the entity.
503 static const char *_get_ent_dump_name(ir_entity *ent, int dump_ld_name) {
505 return "<NULL entity>";
507 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
508 if (ent->ld_name) return get_id_str(ent->ld_name);
510 return get_id_str(ent->name);
514 * If the entity has a ld_name, returns it if the option dump_ld_name is set,
515 * else returns the name of the entity.
517 const char *get_ent_dump_name(ir_entity *ent) {
518 return _get_ent_dump_name(ent, dump_ld_name);
521 /* Returns the name of an IRG. */
522 const char *get_irg_dump_name(ir_graph *irg) {
523 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
524 return _get_ent_dump_name(get_irg_entity(irg), 1);
528 * Returns non-zero if a node is in floating state.
530 static int node_floats(ir_node *n) {
531 return ((get_irn_pinned(n) == op_pin_state_floats) &&
532 (get_irg_pinned(current_ir_graph) == op_pin_state_floats));
536 * Walker that visits the anchors
538 static void ird_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env) {
540 irg_walk_anchors(irg, pre, post, env);
542 irg_walk_graph(irg, pre, post, env);
547 * Walker, allocates an array for all blocks and puts it's nodes non-floating nodes into this array.
549 static void collect_node(ir_node * node, void *env) {
553 || get_irn_op(node) == op_Bad
554 || get_irn_op(node) == op_Unknown
555 || get_irn_op(node) == op_NoMem) {
556 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
557 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
558 ARR_APP1(ir_node *, arr, node);
559 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
561 ir_node * block = get_nodes_block(node);
564 /* this node is in a Bad block, so we must place it into the graph's list */
565 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
566 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
567 ARR_APP1(ir_node *, arr, node);
568 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
570 ird_set_irn_link(node, ird_get_irn_link(block));
571 ird_set_irn_link(block, node);
576 /** Construct lists to walk ir block-wise.
578 * Collects all blocks, nodes not op_pin_state_pinned,
579 * Bad, NoMem and Unknown into a flexible array in link field of
580 * irg they belong to. Sets the irg link field to NULL in all
581 * graphs not visited.
582 * Free the list with DEL_ARR_F().
584 static ir_node **construct_block_lists(ir_graph *irg) {
586 int rem_view = get_interprocedural_view();
587 int walk_flag = using_visited(irg);
588 ir_graph *rem = current_ir_graph;
590 current_ir_graph = irg;
593 clear_using_visited(current_ir_graph);
595 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
596 ird_set_irg_link(get_irp_irg(i), NULL);
598 ird_walk_graph(current_ir_graph, clear_link, collect_node, current_ir_graph);
600 /* Collect also EndReg and EndExcept. We do not want to change the walker. */
601 set_interprocedural_view(0);
603 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
604 irg_walk(get_irg_end_reg(current_ir_graph), clear_link, collect_node, current_ir_graph);
605 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
606 irg_walk(get_irg_end_except(current_ir_graph), clear_link, collect_node, current_ir_graph);
608 set_interprocedural_view(rem_view);
611 set_using_visited(current_ir_graph);
613 current_ir_graph = rem;
614 return ird_get_irg_link(irg);
617 typedef struct _list_tuple {
619 ir_extblk **extbb_list;
622 /** Construct lists to walk IR extended block-wise.
623 * Free the lists in the tuple with DEL_ARR_F().
624 * Sets the irg link field to NULL in all
625 * graphs not visited.
627 static list_tuple *construct_extblock_lists(ir_graph *irg) {
628 ir_node **blk_list = construct_block_lists(irg);
630 ir_graph *rem = current_ir_graph;
631 list_tuple *lists = xmalloc(sizeof(*lists));
633 current_ir_graph = irg;
635 lists->blk_list = NEW_ARR_F(ir_node *, 0);
636 lists->extbb_list = NEW_ARR_F(ir_extblk *, 0);
638 inc_irg_block_visited(irg);
639 for (i = ARR_LEN(blk_list) - 1; i >= 0; --i) {
642 if (is_Block(blk_list[i])) {
643 ext = get_Block_extbb(blk_list[i]);
645 if (extbb_not_visited(ext)) {
646 ARR_APP1(ir_extblk *, lists->extbb_list, ext);
647 mark_extbb_visited(ext);
650 ARR_APP1(ir_node *, lists->blk_list, blk_list[i]);
654 current_ir_graph = rem;
655 ird_set_irg_link(irg, lists);
659 /*-----------------------------------------------------------------*/
660 /* Routines to dump information about a single ir node. */
661 /*-----------------------------------------------------------------*/
664 * dump the name of a node n to the File F.
666 int dump_node_opcode(FILE *F, ir_node *n)
669 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
671 /* call the dump_node operation if available */
673 return ops->dump_node(n, F, dump_node_opcode_txt);
675 /* implementation for default nodes */
676 switch (get_irn_opcode(n)) {
681 res = tarval_snprintf(buf, sizeof(buf), get_Const_tarval(n));
682 assert(res < (int) sizeof(buf) && "buffer to small for tarval_snprintf");
687 switch (get_SymConst_kind(n)) {
688 case symconst_addr_name:
689 /* don't use get_SymConst_ptr_info as it mangles the name. */
690 fprintf(F, "SymC %s", get_id_str(get_SymConst_name(n)));
692 case symconst_addr_ent:
693 fprintf(F, "SymC &%s", get_entity_name(get_SymConst_entity(n)));
695 case symconst_ofs_ent:
696 fprintf(F, "SymC %s offset", get_entity_name(get_SymConst_entity(n)));
698 case symconst_type_tag:
699 fprintf(F, "SymC %s tag", get_type_name_ex(get_SymConst_type(n), &bad));
701 case symconst_type_size:
702 fprintf(F, "SymC %s size", get_type_name_ex(get_SymConst_type(n), &bad));
704 case symconst_type_align:
705 fprintf(F, "SymC %s align", get_type_name_ex(get_SymConst_type(n), &bad));
707 case symconst_enum_const:
708 fprintf(F, "SymC %s enum", get_enumeration_name(get_SymConst_enum(n)));
711 fprintf(F, "SymC %lu label", get_SymConst_label(n));
717 if (!get_interprocedural_view())
724 ir_node *pred = get_Proj_pred(n);
726 if (get_irn_opcode(pred) == iro_Cond
727 && get_Proj_proj(n) == get_Cond_defaultProj(pred)
728 && get_irn_mode(get_Cond_selector(pred)) != mode_b)
729 fprintf(F, "defProj");
737 if (get_interprocedural_view()) {
738 fprintf(F, "%s %s", get_irn_opname(n), get_ent_dump_name(get_irg_entity(get_irn_irg(n))));
743 case iro_CallBegin: {
744 ir_node *addr = get_CallBegin_ptr(n);
745 ir_entity *ent = NULL;
746 if (get_irn_op(addr) == op_Sel)
747 ent = get_Sel_entity(addr);
748 else if ((get_irn_op(addr) == op_SymConst) && (get_SymConst_kind(addr) == symconst_addr_ent))
749 ent = get_SymConst_entity(addr);
750 fprintf(F, "%s", get_irn_opname(n));
751 if (ent) fprintf(F, " %s", get_entity_name(ent));
755 if (get_Load_align(n) == align_non_aligned)
757 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Load_mode(n), &bad));
760 if (get_Store_align(n) == align_non_aligned)
762 fprintf(F, "%s", get_irn_opname(n));
765 fprintf(F, "%s%s", is_Block_dead(n) ? "Dead " : "", get_irn_opname(n));
768 if (get_Conv_strict(n))
769 fprintf(F, "strict");
770 fprintf(F, "%s", get_irn_opname(n));
775 fprintf(F, "%s", get_irn_opname(n));
782 * Dump the mode of a node n to a file F.
783 * Ignore modes that are "always known".
785 static int dump_node_mode(FILE *F, ir_node *n)
788 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
791 /* call the dump_node operation if available */
793 return ops->dump_node(n, F, dump_node_mode_txt);
795 /* default implementation */
796 iro = get_irn_opcode(n);
808 ir_mode *mode = get_irn_mode(n);
810 if (mode && mode != mode_BB && mode != mode_ANY && mode != mode_BAD &&
811 (mode != mode_T || iro == iro_Proj))
812 fprintf(F, "%s", get_mode_name_ex(mode, &bad));
820 * Dump the type of a node n to a file F if it's known.
822 static int dump_node_typeinfo(FILE *F, ir_node *n) {
825 if (opt_dump_analysed_type_info) {
826 if (get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_consistent ||
827 get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_inconsistent) {
828 ir_type *tp = get_irn_typeinfo_type(n);
829 if (tp != firm_none_type)
830 fprintf(F, "[%s] ", get_type_name_ex(tp, &bad));
838 typedef struct _pns_lookup {
839 long nr; /**< the proj number */
840 const char *name; /**< the name of the Proj */
843 typedef struct _proj_lookup {
844 ir_opcode code; /**< the opcode of the Proj predecessor */
845 unsigned num_data; /**< number of data entries */
846 const pns_lookup_t *data; /**< the data */
849 #define ARR_SIZE(a) (sizeof(a)/sizeof(a[0]))
851 /** the lookup table for Proj(Start) names */
852 static const pns_lookup_t start_lut[] = {
853 #define X(a) { pn_Start_##a, #a }
863 /** the lookup table for Proj(Cond) names */
864 static const pns_lookup_t cond_lut[] = {
865 #define X(a) { pn_Cond_##a, #a }
871 /** the lookup table for Proj(Call) names */
872 static const pns_lookup_t call_lut[] = {
873 #define X(a) { pn_Call_##a, #a }
883 /** the lookup table for Proj(Quot) names */
884 static const pns_lookup_t quot_lut[] = {
885 #define X(a) { pn_Quot_##a, #a }
893 /** the lookup table for Proj(DivMod) names */
894 static const pns_lookup_t divmod_lut[] = {
895 #define X(a) { pn_DivMod_##a, #a }
904 /** the lookup table for Proj(Div) names */
905 static const pns_lookup_t div_lut[] = {
906 #define X(a) { pn_Div_##a, #a }
914 /** the lookup table for Proj(Mod) names */
915 static const pns_lookup_t mod_lut[] = {
916 #define X(a) { pn_Mod_##a, #a }
924 /** the lookup table for Proj(Load) names */
925 static const pns_lookup_t load_lut[] = {
926 #define X(a) { pn_Load_##a, #a }
934 /** the lookup table for Proj(Store) names */
935 static const pns_lookup_t store_lut[] = {
936 #define X(a) { pn_Store_##a, #a }
943 /** the lookup table for Proj(Alloc) names */
944 static const pns_lookup_t alloc_lut[] = {
945 #define X(a) { pn_Alloc_##a, #a }
953 /** the lookup table for Proj(CopyB) names */
954 static const pns_lookup_t copyb_lut[] = {
955 #define X(a) { pn_CopyB_##a, #a }
963 /** the lookup table for Proj(InstOf) names */
964 static const pns_lookup_t instof_lut[] = {
965 #define X(a) { pn_InstOf_##a, #a }
974 /** the lookup table for Proj(Raise) names */
975 static const pns_lookup_t raise_lut[] = {
976 #define X(a) { pn_Raise_##a, #a }
982 /** the lookup table for Proj(Bound) names */
983 static const pns_lookup_t bound_lut[] = {
984 #define X(a) { pn_Bound_##a, #a }
992 /** the Proj lookup table */
993 static const proj_lookup_t proj_lut[] = {
994 #define E(a) ARR_SIZE(a), a
995 { iro_Start, E(start_lut) },
996 { iro_Cond, E(cond_lut) },
997 { iro_Call, E(call_lut) },
998 { iro_Quot, E(quot_lut) },
999 { iro_DivMod, E(divmod_lut) },
1000 { iro_Div, E(div_lut) },
1001 { iro_Mod, E(mod_lut) },
1002 { iro_Load, E(load_lut) },
1003 { iro_Store, E(store_lut) },
1004 { iro_Alloc, E(alloc_lut) },
1005 { iro_CopyB, E(copyb_lut) },
1006 { iro_InstOf, E(instof_lut) },
1007 { iro_Raise, E(raise_lut) },
1008 { iro_Bound, E(bound_lut) }
1013 * Dump additional node attributes of some nodes to a file F.
1016 dump_node_nodeattr(FILE *F, ir_node *n)
1022 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1024 /* call the dump_node operation if available */
1026 return ops->dump_node(n, F, dump_node_nodeattr_txt);
1028 switch (get_irn_opcode(n)) {
1030 if (0 && get_interprocedural_view()) {
1031 fprintf(F, "%s ", get_ent_dump_name(get_irg_entity(current_ir_graph)));
1036 pred = get_Proj_pred(n);
1037 proj_nr = get_Proj_proj(n);
1039 code = get_irn_opcode(pred);
1041 if (code == iro_Cmp)
1042 fprintf(F, "%s ", get_pnc_string(get_Proj_proj(n)));
1043 else if (code == iro_Proj && get_irn_opcode(get_Proj_pred(pred)) == iro_Start)
1044 fprintf(F, "Arg %ld ", proj_nr);
1045 else if (code == iro_Cond && get_irn_mode(get_Cond_selector(pred)) != mode_b)
1046 fprintf(F, "%ld ", proj_nr);
1048 unsigned i, j, f = 0;
1050 for (i = 0; i < ARR_SIZE(proj_lut); ++i) {
1051 if (code == proj_lut[i].code) {
1052 for (j = 0; j < proj_lut[i].num_data; ++j) {
1053 if (proj_nr == proj_lut[i].data[j].nr) {
1054 fprintf(F, "%s ", proj_lut[i].data[j].name);
1063 fprintf(F, "%ld ", proj_nr);
1064 if (code == iro_Cond && get_Cond_jmp_pred(pred) != COND_JMP_PRED_NONE) {
1065 if (proj_nr == pn_Cond_false && get_Cond_jmp_pred(pred) == COND_JMP_PRED_FALSE)
1066 fprintf(F, "PRED ");
1067 if (proj_nr == pn_Cond_true && get_Cond_jmp_pred(pred) == COND_JMP_PRED_TRUE)
1068 fprintf(F, "PRED ");
1073 proj_nr = get_Filter_proj(n);
1074 if (! get_interprocedural_view()) {
1076 pred = get_Filter_pred(n);
1079 fprintf(F, "%ld ", proj_nr);
1082 fprintf(F, "%s ", get_ent_dump_name(get_Sel_entity(n)));
1085 fprintf(F, "(%s) ", get_type_name_ex(get_Cast_type(n), &bad));
1088 fprintf(F, "%s ", get_pnc_string(get_Confirm_cmp(n)));
1091 fprintf(F, "(%s) ", get_type_name_ex(get_CopyB_type(n), &bad));
1102 #include "execution_frequency.h"
1104 static void dump_node_ana_vals(FILE *F, ir_node *n) {
1106 fprintf(F, " %lf*(%2.0lf + %2.0lf) = %2.0lf ",
1107 get_irn_exec_freq(n),
1108 get_irg_method_execution_frequency(get_irn_irg(n)),
1109 pow(5, get_irg_recursion_depth(get_irn_irg(n))),
1110 get_irn_exec_freq(n) * (get_irg_method_execution_frequency(get_irn_irg(n)) + pow(5, get_irg_recursion_depth(get_irn_irg(n))))
1115 /* Dumps a node label without the enclosing ". */
1116 int dump_node_label(FILE *F, ir_node *n) {
1119 bad |= dump_node_opcode(F, n);
1120 bad |= dump_node_mode(F, n);
1122 bad |= dump_node_typeinfo(F, n);
1123 bad |= dump_node_nodeattr(F, n);
1124 fprintf(F, "%ld:%d", get_irn_node_nr(n), get_irn_idx(n));
1131 * Dumps the attributes of a node n into the file F.
1132 * Currently this is only the color of a node.
1134 static void dump_node_vcgattr(FILE *F, ir_node *node, ir_node *local, int bad)
1139 print_vcg_color(F, ird_color_red);
1143 if (dump_node_vcgattr_hook)
1144 if (dump_node_vcgattr_hook(F, node, local))
1147 n = local ? local : node;
1149 if (overrule_nodecolor != ird_color_default) {
1150 print_vcg_color(F, overrule_nodecolor);
1154 switch (get_irn_opcode(n)) {
1161 print_vcg_color(F, ird_color_blue);
1164 if (is_Block_dead(n))
1165 print_vcg_color(F, ird_color_lightred);
1167 print_vcg_color(F, ird_color_lightyellow);
1170 print_vcg_color(F, ird_color_green);
1174 print_vcg_color(F, ird_color_gold);
1177 print_vcg_color(F, ird_color_orchid);
1183 print_vcg_color(F, ird_color_yellow);
1186 print_vcg_color(F, ird_color_darkyellow);
1189 PRINT_DEFAULT_NODE_ATTR;
1193 /* Adds a new node info dumper callback. */
1194 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data)
1196 hook_entry_t *info = xmalloc(sizeof(*info));
1198 info->hook._hook_node_info = cb;
1199 info->context = data;
1200 register_hook(hook_node_info, info);
1205 /* Remove a previously added info dumper callback. */
1206 void dump_remv_node_info_callback(void *handle)
1208 hook_entry_t *info = handle;
1209 unregister_hook(hook_node_info, info);
1214 * Dump the node information of a node n to a file F.
1216 static INLINE int dump_node_info(FILE *F, ir_node *n)
1219 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1221 fprintf(F, " info1: \"");
1222 bad = dump_irnode_to_file(F, n);
1223 /* call the dump_node operation if available */
1225 bad = ops->dump_node(n, F, dump_node_info_txt);
1227 /* allow additional info to be added */
1228 hook_node_info(F, n);
1235 * checks whether a node is "constant-like" ie can be treated "block-less"
1238 int is_constlike_node(ir_node *n) {
1239 ir_opcode code = get_irn_opcode(n);
1240 return (code == iro_Const || code == iro_Bad || code == iro_NoMem || code == iro_SymConst || code == iro_Unknown);
1244 /** outputs the predecessors of n, that are constants, local. I.e.,
1245 generates a copy of the constant predecessors for each node called with. */
1246 static void dump_const_node_local(FILE *F, ir_node *n) {
1248 if (!get_opt_dump_const_local()) return;
1250 /* Use visited flag to avoid outputting nodes twice.
1251 initialize it first. */
1252 for (i = 0; i < get_irn_arity(n); i++) {
1253 ir_node *con = get_irn_n(n, i);
1254 if (is_constlike_node(con)) {
1255 set_irn_visited(con, get_irg_visited(current_ir_graph) - 1);
1259 for (i = 0; i < get_irn_arity(n); i++) {
1260 ir_node *con = get_irn_n(n, i);
1261 if (is_constlike_node(con) && irn_not_visited(con)) {
1264 mark_irn_visited(con);
1265 /* Generate a new name for the node by appending the names of
1267 fprintf(F, "node: {title: "); PRINT_CONSTID(n, con);
1268 fprintf(F, " label: \"");
1269 bad |= dump_node_label(F, con);
1271 bad |= dump_node_info(F, con);
1272 dump_node_vcgattr(F, n, con, bad);
1278 /** If the block of an edge is a const_like node, dump it local with an edge */
1279 static void dump_const_block_local(FILE *F, ir_node *n) {
1282 if (!get_opt_dump_const_local()) return;
1284 blk = get_nodes_block(n);
1285 if (is_constlike_node(blk)) {
1288 /* Generate a new name for the node by appending the names of
1290 fprintf(F, "node: {title: \""); PRINT_CONSTBLKID(n, blk);
1291 fprintf(F, "\" label: \"");
1292 bad |= dump_node_label(F, blk);
1294 bad |= dump_node_info(F, blk);
1295 dump_node_vcgattr(F, n, blk, bad);
1298 fprintf(F, "edge: { sourcename: \"");
1300 fprintf(F, "\" targetname: \""); PRINT_CONSTBLKID(n,blk);
1302 if (dump_edge_vcgattr_hook) {
1304 if (dump_edge_vcgattr_hook(F, n, -1)) {
1308 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1313 fprintf(F, "\" " BLOCK_EDGE_ATTR "}\n");
1318 * prints the error message of a node to a file F as info2.
1320 static void print_node_error(FILE *F, const char *err_msg)
1325 fprintf(F, " info2: \"%s\"", err_msg);
1329 * prints debug messages of a node to file F as info3.
1331 static void print_dbg_info(FILE *F, dbg_info *dbg)
1335 if (__dbg_info_snprint) {
1337 if (__dbg_info_snprint(buf, sizeof(buf), dbg) > 0)
1338 fprintf(F, " info3: \"%s\"\n", buf);
1345 static void dump_node(FILE *F, ir_node *n)
1350 if (get_opt_dump_const_local() && is_constlike_node(n))
1353 /* dump this node */
1354 fprintf(F, "node: {title: \""); PRINT_NODEID(n); fprintf(F, "\" label: \"");
1356 bad = ! irn_vrfy_irg_dump(n, current_ir_graph, &p);
1357 bad |= dump_node_label(F, n);
1358 dump_node_ana_vals(F, n);
1359 //dump_node_ana_info(F, n);
1361 bad |= dump_node_info(F, n);
1362 print_node_error(F, p);
1363 print_dbg_info(F, get_irn_dbg_info(n));
1364 dump_node_vcgattr(F, n, NULL, bad);
1366 dump_const_node_local(F, n);
1368 if(dump_node_edge_hook)
1369 dump_node_edge_hook(F, n);
1371 dump_irn_chi_term(F, n);
1372 dump_irn_state(F, n);
1376 /** dump the edge to the block this node belongs to */
1378 dump_ir_block_edge(FILE *F, ir_node *n) {
1379 if (get_opt_dump_const_local() && is_constlike_node(n)) return;
1380 if (is_no_Block(n)) {
1381 ir_node *block = get_nodes_block(n);
1383 if (get_opt_dump_const_local() && is_constlike_node(block)) {
1384 dump_const_block_local(F, n);
1386 fprintf(F, "edge: { sourcename: \"");
1388 fprintf(F, "\" targetname: ");
1389 fprintf(F, "\""); PRINT_NODEID(block); fprintf(F, "\"");
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");
1408 print_data_edge_vcgattr(FILE *F, ir_node *from, int to) {
1410 * do not use get_nodes_block() here, will fail
1411 * if the irg is not pinned.
1413 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1414 fprintf(F, INTRA_DATA_EDGE_ATTR);
1416 fprintf(F, INTER_DATA_EDGE_ATTR);
1420 print_mem_edge_vcgattr(FILE *F, ir_node *from, int to) {
1422 * do not use get_nodes_block() here, will fail
1423 * if the irg is not pinned.
1425 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1426 fprintf(F, INTRA_MEM_EDGE_ATTR);
1428 fprintf(F, INTER_MEM_EDGE_ATTR);
1431 /** Print the vcg attributes for the edge from node from to it's to's input */
1432 static void print_edge_vcgattr(FILE *F, ir_node *from, int to) {
1435 if (dump_edge_vcgattr_hook)
1436 if (dump_edge_vcgattr_hook(F, from, to))
1439 if (dump_backedge_information_flag && is_backedge(from, to))
1440 fprintf(F, BACK_EDGE_ATTR);
1442 switch (get_irn_opcode(from)) {
1444 fprintf(F, CF_EDGE_ATTR);
1446 case iro_Start: break;
1449 if (get_irn_mode(get_End_keepalive(from, to)) == mode_BB)
1450 fprintf(F, KEEP_ALIVE_CF_EDGE_ATTR);
1452 fprintf(F, KEEP_ALIVE_DF_EDGE_ATTR);
1456 if (is_Proj(from)) {
1457 if (get_irn_mode(from) == mode_M)
1458 print_mem_edge_vcgattr(F, from, to);
1459 else if (get_irn_mode(from) == mode_X)
1460 fprintf(F, CF_EDGE_ATTR);
1462 print_data_edge_vcgattr(F, from, to);
1464 else if (get_irn_mode(get_irn_n(from, to)) == mode_M)
1465 print_mem_edge_vcgattr(F, from, to);
1466 else if (get_irn_mode(get_irn_n(from, to)) == mode_X)
1467 fprintf(F, CF_EDGE_ATTR);
1469 print_data_edge_vcgattr(F, from, to);
1473 /** dump edges to our inputs */
1474 static void dump_ir_data_edges(FILE *F, ir_node *n) {
1476 unsigned long visited = get_irn_visited(n);
1478 if ((get_irn_op(n) == op_End) && (!dump_keepalive))
1481 /* dump the dependency edges. */
1482 for (i = 0; i < get_irn_deps(n); ++i) {
1483 ir_node *dep = get_irn_dep(n, i);
1486 fprintf(F, "edge: {sourcename: \"");
1488 fprintf(F, "\" targetname: ");
1489 if ((get_opt_dump_const_local()) && is_constlike_node(dep)) {
1490 PRINT_CONSTID(n, dep);
1496 fprintf(F, " label: \"%d\" ", i);
1497 fprintf(F, " color: darkgreen}\n");
1501 for (i = 0; i < get_irn_arity(n); i++) {
1502 ir_node * pred = get_irn_n(n, i);
1505 if ((get_interprocedural_view() && get_irn_visited(pred) < visited))
1506 continue; /* pred not dumped */
1508 if (dump_backedge_information_flag && is_backedge(n, i))
1509 fprintf(F, "backedge: {sourcename: \"");
1511 fprintf(F, "edge: {sourcename: \"");
1513 fprintf(F, "\" targetname: ");
1514 if ((get_opt_dump_const_local()) && is_constlike_node(pred)) {
1515 PRINT_CONSTID(n, pred);
1517 fprintf(F, "\""); PRINT_NODEID(pred); fprintf(F, "\"");
1519 fprintf(F, " label: \"%d\" ", i);
1520 print_edge_vcgattr(F, n, i);
1525 /** Dumps a node and its edges but not the block edge
1528 dump_node_wo_blockedge(ir_node *n, void *env) {
1531 dump_ir_data_edges(F, n);
1534 /** Dumps a node and its edges.
1537 dump_whole_node(ir_node *n, void *env) {
1539 dump_node_wo_blockedge(n, env);
1540 if (!node_floats(n)) dump_ir_block_edge(F, n);
1544 dump_const_node(ir_node *n, void *env) {
1545 if (is_Block(n)) return;
1546 dump_node_wo_blockedge(n, env);
1549 /***********************************************************************/
1550 /* the following routines dump the nodes/irgs bracketed to graphs. */
1551 /***********************************************************************/
1553 /** Dumps a constant expression as entity initializer, array bound ...
1555 static void dump_const_expression(FILE *F, ir_node *value) {
1556 ir_graph *rem = current_ir_graph;
1557 int rem_dump_const_local = dump_const_local;
1558 dump_const_local = 0;
1559 current_ir_graph = get_const_code_irg();
1560 irg_walk(value, dump_const_node, NULL, F);
1561 /* Decrease visited flag so that we walk with the same flag for the next
1562 expression. This guarantees that we don't dump the same node twice,
1563 as for const expressions cse is performed to save memory. */
1564 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph) -1);
1565 current_ir_graph = rem;
1566 dump_const_local = rem_dump_const_local;
1569 /** Dump a block as graph containing its nodes.
1571 * Expects to find nodes belonging to the block as list in its
1573 * Dumps the edges of all nodes including itself. */
1575 dump_whole_block(FILE *F, ir_node *block) {
1577 dumper_colors color = ird_color_yellow;
1579 assert(is_Block(block));
1581 fprintf(F, "graph: { title: \"");
1582 PRINT_NODEID(block);
1583 fprintf(F, "\" label: \"");
1584 dump_node_label(F, block);
1586 if (get_opt_dump_abstvals())
1587 fprintf(F, " seqno: %d", (int)get_Block_seqno(block));
1590 /* colorize blocks */
1591 if (! get_Block_matured(block))
1592 color = ird_color_red;
1593 if (is_Block_dead(block))
1594 color = ird_color_orange;
1596 fprintf(F, "\" status:clustered ");
1597 print_vcg_color(F, color);
1600 /* yComp can show attributes for blocks, XVCG parses but ignores them */
1601 dump_node_info(F, block);
1602 print_dbg_info(F, get_irn_dbg_info(block));
1604 /* dump the blocks edges */
1605 dump_ir_data_edges(F, block);
1607 if (dump_block_edge_hook)
1608 dump_block_edge_hook(F, block);
1610 /* dump the nodes that go into the block */
1611 for (node = ird_get_irn_link(block); node; node = ird_get_irn_link(node)) {
1613 dump_ir_data_edges(F, node);
1616 /* Close the vcg information for the block */
1618 dump_const_node_local(F, block);
1620 dump_irn_chi_term(F, block);
1625 /** dumps a graph block-wise. Expects all blockless nodes in arr in irgs link.
1626 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1628 dump_block_graph(FILE *F, ir_graph *irg) {
1630 ir_graph *rem = current_ir_graph;
1631 ir_node **arr = ird_get_irg_link(irg);
1632 current_ir_graph = irg;
1634 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1635 ir_node * node = arr[i];
1636 if (is_Block(node)) {
1637 /* Dumps the block and all the nodes in the block, which are to
1638 be found in Block->link. */
1639 dump_whole_block(F, node);
1641 /* Nodes that are not in a Block. */
1643 if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
1644 dump_const_block_local(F, node);
1646 dump_ir_data_edges(F, node);
1650 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1651 dump_loop_nodes_into_graph(F, irg);
1653 current_ir_graph = rem;
1657 * Dump the info for an irg.
1658 * Parsed by XVCG but not shown. use yComp.
1660 static void dump_graph_info(FILE *F, ir_graph *irg) {
1661 fprintf(F, "info1: \"");
1662 dump_entity_to_file(F, get_irg_entity(irg), dump_verbosity_entattrs | dump_verbosity_entconsts);
1666 /** Dumps an irg as a graph clustered by block nodes.
1667 * If interprocedural view edges can point to nodes out of this graph.
1669 static void dump_graph_from_list(FILE *F, ir_graph *irg) {
1670 ir_entity *ent = get_irg_entity(irg);
1672 fprintf(F, "graph: { title: \"");
1674 fprintf(F, "\" label: \"%s\" status:clustered color:white \n",
1675 get_ent_dump_name(ent));
1677 dump_graph_info(F, irg);
1678 print_dbg_info(F, get_entity_dbg_info(ent));
1680 dump_block_graph(F, irg);
1682 /* Close the vcg information for the irg */
1683 fprintf(F, "}\n\n");
1686 /** dumps a graph extended block-wise. Expects all blockless nodes in arr in irgs link.
1687 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1689 dump_extblock_graph(FILE *F, ir_graph *irg) {
1691 ir_graph *rem = current_ir_graph;
1692 ir_extblk **arr = ird_get_irg_link(irg);
1693 current_ir_graph = irg;
1695 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1696 ir_extblk *extbb = arr[i];
1697 ir_node *leader = get_extbb_leader(extbb);
1700 fprintf(F, "graph: { title: \"");
1701 PRINT_EXTBBID(leader);
1702 fprintf(F, "\" label: \"ExtBB %ld\" status:clustered color:lightgreen\n",
1703 get_irn_node_nr(leader));
1705 for (j = ARR_LEN(extbb->blks) - 1; j >= 0; --j) {
1706 ir_node * node = extbb->blks[j];
1707 if (is_Block(node)) {
1708 /* Dumps the block and all the nodes in the block, which are to
1709 be found in Block->link. */
1710 dump_whole_block(F, node);
1712 /* Nodes that are not in a Block. */
1714 if (is_Bad(get_nodes_block(node)) && !node_floats(node)) {
1715 dump_const_block_local(F, node);
1717 dump_ir_data_edges(F, node);
1723 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1724 dump_loop_nodes_into_graph(F, irg);
1726 current_ir_graph = rem;
1731 /*******************************************************************/
1732 /* Basic type and entity nodes and edges. */
1733 /*******************************************************************/
1735 /** dumps the edges between nodes and their type or entity attributes. */
1736 static void dump_node2type_edges(ir_node *n, void *env)
1741 switch (get_irn_opcode(n)) {
1743 /* @@@ some consts have an entity */
1746 if (SYMCONST_HAS_TYPE(get_SymConst_kind(n)))
1747 print_node_type_edge(F,n,get_SymConst_type(n),NODE2TYPE_EDGE_ATTR);
1750 print_node_ent_edge(F,n,get_Sel_entity(n),NODE2TYPE_EDGE_ATTR);
1753 print_node_type_edge(F,n,get_Call_type(n),NODE2TYPE_EDGE_ATTR);
1756 print_node_type_edge(F,n,get_Alloc_type(n),NODE2TYPE_EDGE_ATTR);
1759 print_node_type_edge(F,n,get_Free_type(n),NODE2TYPE_EDGE_ATTR);
1762 print_node_type_edge(F,n,get_Cast_type(n),NODE2TYPE_EDGE_ATTR);
1770 static int print_type_info(FILE *F, ir_type *tp) {
1773 if (get_type_state(tp) == layout_undefined) {
1774 fprintf(F, "state: layout_undefined\n");
1776 fprintf(F, "state: layout_fixed,\n");
1778 if (get_type_mode(tp))
1779 fprintf(F, "mode: %s,\n", get_mode_name_ex(get_type_mode(tp), &bad));
1780 fprintf(F, "size: %db,\n", get_type_size_bits(tp));
1785 static void print_typespecific_info(FILE *F, ir_type *tp) {
1786 switch (get_type_tpop_code(tp)) {
1788 fprintf(F, "peculiarity: %s\n", get_peculiarity_string(get_class_peculiarity(tp)));
1793 fprintf(F, "variadicity: %s\n", get_variadicity_name(get_method_variadicity(tp)));
1794 fprintf(F, "params: %d\n", get_method_n_params(tp));
1795 fprintf(F, "results: %d\n", get_method_n_ress(tp));
1801 case tpo_enumeration:
1813 static void print_typespecific_vcgattr(FILE *F, ir_type *tp) {
1814 switch (get_type_tpop_code(tp)) {
1816 if (peculiarity_existent == get_class_peculiarity(tp))
1817 fprintf(F, " " TYPE_CLASS_NODE_ATTR);
1819 fprintf(F, " " TYPE_DESCRIPTION_NODE_ATTR);
1822 fprintf(F, " " TYPE_METH_NODE_ATTR);
1830 case tpo_enumeration:
1842 int dump_type_node(FILE *F, ir_type *tp)
1846 fprintf(F, "node: {title: ");
1848 fprintf(F, " label: \"%s %s\"", get_type_tpop_name(tp), get_type_name_ex(tp, &bad));
1849 fprintf(F, " info1: \"");
1851 bad |= print_type_info(F, tp);
1852 print_typespecific_info(F, tp);
1854 dump_type_to_file(F, tp, dump_verbosity_max);
1857 print_dbg_info(F, get_type_dbg_info(tp));
1858 print_typespecific_vcgattr(F, tp);
1865 void dump_entity_node(FILE *F, ir_entity *ent, int color)
1867 fprintf(F, "node: {title: \"");
1868 PRINT_ENTID(ent); fprintf(F, "\"");
1869 fprintf(F, DEFAULT_TYPE_ATTRIBUTE);
1870 fprintf(F, "label: ");
1871 fprintf(F, "\"ent %s\" ", get_ent_dump_name(ent));
1873 fprintf(F, "color:%d", color);
1875 fprintf(F, ENTITY_NODE_ATTR);
1876 fprintf(F, "\n info1: \"");
1878 dump_entity_to_file(F, ent, dump_verbosity_entattrs | dump_verbosity_entconsts);
1881 print_dbg_info(F, get_entity_dbg_info(ent));
1885 static void dump_enum_item(FILE *F, ir_type *tp, int pos)
1888 ir_enum_const *ec = get_enumeration_const(tp, pos);
1889 ident *id = get_enumeration_nameid(ec);
1890 tarval *tv = get_enumeration_value(ec);
1893 tarval_snprintf(buf, sizeof(buf), tv);
1895 strncpy(buf, "<not set>", sizeof(buf));
1896 fprintf(F, "node: {title: \"");
1897 PRINT_ITEMID(tp, pos); fprintf(F, "\"");
1898 fprintf(F, DEFAULT_ENUM_ITEM_ATTRIBUTE);
1899 fprintf(F, "label: ");
1900 fprintf(F, "\"enum item %s\" " ENUM_ITEM_NODE_ATTR, get_id_str(id));
1901 fprintf(F, "\n info1: \"value: %s\"}\n", buf);
1904 /* dumps a type or entity and it's edges. */
1906 dump_type_info(type_or_ent *tore, void *env) {
1908 int i = 0; /* to shutup gcc */
1910 /* dump this type or entity */
1912 switch (get_kind(tore)) {
1914 ir_entity *ent = (ir_entity *)tore;
1917 dump_entity_node(F, ent, 0);
1919 /* skip this to reduce graph. Member edge of type is parallel to this edge. *
1920 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
1921 ENT_OWN_EDGE_ATTR "}\n", ent, get_entity_owner(ent));*/
1922 print_ent_type_edge(F,ent, get_entity_type(ent), ENT_TYPE_EDGE_ATTR);
1923 if (is_Class_type(get_entity_owner(ent))) {
1924 for(i = 0; i < get_entity_n_overwrites(ent); i++)
1925 print_ent_ent_edge(F,ent, get_entity_overwrites(ent, i), 0, ENT_OVERWRITES_EDGE_ATTR);
1927 /* attached subgraphs */
1928 if (const_entities && (get_entity_variability(ent) != variability_uninitialized)) {
1929 if (is_atomic_entity(ent)) {
1930 value = get_atomic_ent_value(ent);
1932 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
1933 /* DDMN(value); $$$ */
1934 dump_const_expression(F, value);
1937 if (is_compound_entity(ent)) {
1938 for (i = 0; i < get_compound_ent_n_values(ent); i++) {
1939 value = get_compound_ent_value(ent, i);
1941 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
1942 dump_const_expression(F, value);
1943 print_ent_ent_edge(F, ent, get_compound_ent_value_member(ent, i), 0, ENT_CORR_EDGE_ATTR, i);
1945 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
1946 ENT_CORR_EDGE_ATTR "}\n", GET_ENTID(ent),
1947 get_compound_ent_value_member(ent, i), i);
1956 ir_type *tp = (ir_type *)tore;
1957 dump_type_node(F, tp);
1958 /* and now the edges */
1959 switch (get_type_tpop_code(tp)) {
1961 for (i=0; i < get_class_n_supertypes(tp); i++)
1962 print_type_type_edge(F, tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
1963 for (i=0; i < get_class_n_members(tp); i++)
1964 print_type_ent_edge(F,tp,get_class_member(tp, i),TYPE_MEMBER_EDGE_ATTR);
1967 for (i=0; i < get_struct_n_members(tp); i++)
1968 print_type_ent_edge(F,tp,get_struct_member(tp, i),TYPE_MEMBER_EDGE_ATTR);
1971 for (i = 0; i < get_method_n_params(tp); i++)
1972 print_type_type_edge(F,tp,get_method_param_type(tp, i),METH_PAR_EDGE_ATTR,i);
1973 for (i = 0; i < get_method_n_ress(tp); i++)
1974 print_type_type_edge(F,tp,get_method_res_type(tp, i),METH_RES_EDGE_ATTR,i);
1977 for (i = 0; i < get_union_n_members(tp); i++)
1978 print_type_ent_edge(F,tp,get_union_member(tp, i),UNION_EDGE_ATTR);
1981 print_type_type_edge(F,tp,get_array_element_type(tp),ARR_ELT_TYPE_EDGE_ATTR);
1982 print_type_ent_edge(F,tp,get_array_element_entity(tp),ARR_ENT_EDGE_ATTR);
1983 for (i = 0; i < get_array_n_dimensions(tp); i++) {
1984 ir_node *upper = get_array_upper_bound(tp, i);
1985 ir_node *lower = get_array_lower_bound(tp, i);
1986 print_node_type_edge(F, upper, tp, "label: \"upper %d\"", get_array_order(tp, i));
1987 print_node_type_edge(F, lower, tp, "label: \"lower %d\"", get_array_order(tp, i));
1988 dump_const_expression(F, upper);
1989 dump_const_expression(F, lower);
1992 case tpo_enumeration:
1993 for (i = 0; i < get_enumeration_n_enums(tp); ++i) {
1994 dump_enum_item(F, tp, i);
1995 print_enum_item_edge(F, tp, i, "label: \"item %d\"", i);
1999 print_type_type_edge(F,tp,get_pointer_points_to_type(tp), PTR_PTS_TO_EDGE_ATTR);
2006 break; /* case k_type */
2009 printf(" *** irdump, dump_type_info(l.%i), faulty type.\n", __LINE__);
2010 } /* switch kind_or_entity */
2013 typedef struct _h_env {
2018 /** For dumping class hierarchies.
2019 * Dumps a class type node and a superclass edge.
2020 * If env->dump_ent dumps entities of classes and overwrites edges.
2023 dump_class_hierarchy_node(type_or_ent *tore, void *ctx) {
2026 int i = 0; /* to shutup gcc */
2028 /* dump this type or entity */
2029 switch (get_kind(tore)) {
2031 ir_entity *ent = (ir_entity *)tore;
2032 if (get_entity_owner(ent) == get_glob_type()) break;
2033 if (!is_Method_type(get_entity_type(ent))) break; /* GL */
2034 if (env->dump_ent && is_Class_type(get_entity_owner(ent))) {
2036 dump_entity_node(F, ent, 0);
2038 print_type_ent_edge(F,get_entity_owner(ent),ent,TYPE_MEMBER_EDGE_ATTR);
2039 for(i = 0; i < get_entity_n_overwrites(ent); i++)
2040 print_ent_ent_edge(F, get_entity_overwrites(ent, i), ent, 0, ENT_OVERWRITES_EDGE_ATTR);
2045 ir_type *tp = (ir_type *)tore;
2046 if (tp == get_glob_type()) break;
2047 switch (get_type_tpop_code(tp)) {
2049 dump_type_node(F, tp);
2050 /* and now the edges */
2051 for (i=0; i < get_class_n_supertypes(tp); i++) {
2052 print_type_type_edge(F,tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2057 break; /* case k_type */
2060 printf(" *** irdump, dump_class_hierarchy_node(l.%i), faulty type.\n", __LINE__);
2061 } /* switch kind_or_entity */
2064 /*******************************************************************/
2065 /* dump analysis information that is expressed in graph terms. */
2066 /*******************************************************************/
2068 /* dump out edges */
2070 dump_out_edge(ir_node *n, void *env) {
2073 for (i = 0; i < get_irn_n_outs(n); i++) {
2074 assert(get_irn_out(n, i));
2075 fprintf(F, "edge: {sourcename: \"");
2077 fprintf(F, "\" targetname: \"");
2078 PRINT_NODEID(get_irn_out(n, i));
2079 fprintf(F, "\" color: red linestyle: dashed");
2085 dump_loop_label(FILE *F, ir_loop *loop) {
2086 fprintf(F, "loop %d, %d sons, %d nodes",
2087 get_loop_depth(loop), get_loop_n_sons(loop), get_loop_n_nodes(loop));
2090 static INLINE void dump_loop_info(FILE *F, ir_loop *loop) {
2091 fprintf(F, " info1: \"");
2092 fprintf(F, " loop nr: %d", get_loop_loop_nr(loop));
2093 #ifdef DEBUG_libfirm /* GL @@@ debug analyses */
2094 fprintf(F, "\n The loop was analyzed %d times.", PTR_TO_INT(get_loop_link(loop)));
2100 dump_loop_node(FILE *F, ir_loop *loop) {
2101 fprintf(F, "node: {title: \"");
2103 fprintf(F, "\" label: \"");
2104 dump_loop_label(F, loop);
2106 dump_loop_info(F, loop);
2111 dump_loop_node_edge(FILE *F, ir_loop *loop, int i) {
2113 fprintf(F, "edge: {sourcename: \"");
2115 fprintf(F, "\" targetname: \"");
2116 PRINT_NODEID(get_loop_node(loop, i));
2117 fprintf(F, "\" color: green");
2122 dump_loop_son_edge(FILE *F, ir_loop *loop, int i) {
2124 fprintf(F, "edge: {sourcename: \"");
2126 fprintf(F, "\" targetname: \"");
2127 PRINT_LOOPID(get_loop_son(loop, i));
2128 fprintf(F, "\" color: darkgreen label: \"%d\"}\n",
2129 get_loop_element_pos(loop, get_loop_son(loop, i)));
2133 void dump_loops(FILE *F, ir_loop *loop) {
2135 /* dump this loop node */
2136 dump_loop_node(F, loop);
2138 /* dump edges to nodes in loop -- only if it is a real loop */
2139 if (get_loop_depth(loop) != 0) {
2140 for (i = 0; i < get_loop_n_nodes(loop); i++) {
2141 dump_loop_node_edge(F, loop, i);
2144 for (i = 0; i < get_loop_n_sons(loop); i++) {
2145 dump_loops(F, get_loop_son(loop, i));
2146 dump_loop_son_edge(F, loop, i);
2151 void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg) {
2152 ir_graph *rem = current_ir_graph;
2153 current_ir_graph = irg;
2155 if (get_irg_loop(irg)) dump_loops(F, get_irg_loop(irg));
2157 current_ir_graph = rem;
2162 * dumps the VCG header
2164 void dump_vcg_header(FILE *F, const char *name, const char *orientation) {
2173 if (!orientation) orientation = "bottom_to_top";
2177 "graph: { title: \"ir graph of %s\"\n"
2178 "display_edge_labels: %s\n"
2179 "layoutalgorithm: mindepth\n"
2180 "manhattan_edges: yes\n"
2181 "port_sharing: no\n"
2183 "classname 1: \"intrablock Data\"\n"
2184 "classname 2: \"Block\"\n"
2185 "classname 3: \"Entity type\"\n"
2186 "classname 4: \"Entity owner\"\n"
2187 "classname 5: \"Method Param\"\n"
2188 "classname 6: \"Method Res\"\n"
2189 "classname 7: \"Super\"\n"
2190 "classname 8: \"Union\"\n"
2191 "classname 9: \"Points-to\"\n"
2192 "classname 10: \"Array Element Type\"\n"
2193 "classname 11: \"Overwrites\"\n"
2194 "classname 12: \"Member\"\n"
2195 "classname 13: \"Control Flow\"\n"
2196 "classname 14: \"intrablock Memory\"\n"
2197 "classname 15: \"Dominators\"\n"
2198 "classname 16: \"interblock Data\"\n"
2199 "classname 17: \"interblock Memory\"\n"
2200 "classname 18: \"Exception Control Flow for Interval Analysis\"\n"
2201 "classname 19: \"Postdominators\"\n"
2202 "classname 20: \"Keep Alive\"\n"
2203 "infoname 1: \"Attribute\"\n"
2204 "infoname 2: \"Verification errors\"\n"
2205 "infoname 3: \"Debug info\"\n",
2206 name, label, orientation);
2208 /* don't use all, the range is too whith/black. */
2212 "colorentry 100: 0 0 0\n"
2213 "colorentry 101: 20 0 0\n"
2214 "colorentry 102: 40 0 0\n"
2215 "colorentry 103: 60 0 0\n"
2216 "colorentry 104: 80 0 0\n"
2217 "colorentry 105: 100 0 0\n"
2218 "colorentry 106: 120 0 0\n"
2219 "colorentry 107: 140 0 0\n"
2220 "colorentry 108: 150 0 0\n"
2221 "colorentry 109: 180 0 0\n"
2222 "colorentry 110: 200 0 0\n"
2223 "colorentry 111: 220 0 0\n"
2224 "colorentry 112: 240 0 0\n"
2225 "colorentry 113: 255 0 0\n"
2226 "colorentry 113: 255 20 20\n"
2227 "colorentry 114: 255 40 40\n"
2228 "colorentry 115: 255 60 60\n"
2229 "colorentry 116: 255 80 80\n"
2230 "colorentry 117: 255 100 100\n"
2231 "colorentry 118: 255 120 120\n"
2232 "colorentry 119: 255 140 140\n"
2233 "colorentry 120: 255 150 150\n"
2234 "colorentry 121: 255 180 180\n"
2235 "colorentry 122: 255 200 200\n"
2236 "colorentry 123: 255 220 220\n"
2237 "colorentry 124: 255 240 240\n"
2238 "colorentry 125: 255 250 250\n"
2241 fprintf(F, "\n"); /* a separator */
2247 * @param irg The graph to be dumped
2248 * @param suffix1 first filename suffix
2249 * @param suffix2 second filename suffix
2251 FILE *vcg_open(ir_graph *irg, const char * suffix1, const char *suffix2) {
2253 const char *nm = get_irg_dump_name(irg);
2254 int len = strlen(nm), i, j;
2255 char *fname; /* filename to put the vcg information in */
2257 if (!suffix1) suffix1 = "";
2258 if (!suffix2) suffix2 = "";
2260 /* open file for vcg graph */
2261 fname = xmalloc (len * 2 + strlen(suffix1) + strlen(suffix2) + 5);
2263 /* strncpy (fname, nm, len); */ /* copy the filename */
2265 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2267 fname[j] = '@'; j++; fname[j] = '1'; j++;
2268 } else if (nm[i] == '@') {
2269 fname[j] = '@'; j++; fname[j] = '2'; j++;
2271 fname[j] = nm[i]; j++;
2275 strcat(fname, suffix1); /* append file suffix */
2276 strcat(fname, suffix2); /* append file suffix */
2277 strcat(fname, ".vcg"); /* append the .vcg suffix */
2279 /* vcg really expect only a <CR> at end of line, so
2280 * the "b"inary mode is what you mean (and even needed for Win32)
2282 F = fopen(fname, "wb"); /* open file for writing */
2294 * @param name prefix file name
2295 * @param suffix filename suffix
2297 FILE *vcg_open_name(const char *name, const char *suffix) {
2299 char *fname; /* filename to put the vcg information in */
2300 int i, j, len = strlen(name);
2302 if (!suffix) suffix = "";
2304 /** open file for vcg graph */
2305 fname = xmalloc(len * 2 + 5 + strlen(suffix));
2306 /* strcpy (fname, name);*/ /* copy the filename */
2308 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2309 if (name[i] == '/') {
2310 fname[j] = '@'; j++; fname[j] = '1'; j++;
2311 } else if (name[i] == '@') {
2312 fname[j] = '@'; j++; fname[j] = '2'; j++;
2314 fname[j] = name[i]; j++;
2318 strcat(fname, suffix);
2319 strcat(fname, ".vcg"); /* append the .vcg suffix */
2321 /* vcg really expect only a <CR> at end of line, so
2322 * the "b"inary mode is what you mean (and even needed for Win32)
2324 F = fopen(fname, "wb"); /* open file for writing */
2334 * Dumps the vcg file footer
2336 static void dump_vcg_footer(FILE *F) {
2341 * close the vcg file
2343 void vcg_close(FILE *F) {
2344 dump_vcg_footer(F); /* print footer */
2345 fclose (F); /* close vcg file */
2348 /************************************************************************/
2349 /************************************************************************/
2350 /* Routines that dump all or parts of the firm representation to a file */
2351 /************************************************************************/
2352 /************************************************************************/
2354 /************************************************************************/
2355 /* Dump ir graphs, different formats and additional information. */
2356 /************************************************************************/
2358 /** Routine to dump a graph, blocks as conventional nodes. */
2360 dump_ir_graph(ir_graph *irg, const char *suffix )
2366 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2369 if (dump_backedge_information_flag && get_irg_loopinfo_state(irg) != loopinfo_consistent) {
2370 construct_backedges(irg);
2373 rem = current_ir_graph;
2374 current_ir_graph = irg;
2375 if (get_interprocedural_view()) suffix1 = "-pure-ip";
2376 else suffix1 = "-pure";
2377 f = vcg_open(irg, suffix, suffix1);
2379 dump_vcg_header(f, get_irg_dump_name(irg), NULL);
2381 /* call the dump graph hook */
2382 if (dump_ir_graph_hook)
2383 if (dump_ir_graph_hook(f, irg)) {
2384 current_ir_graph = rem;
2388 /* walk over the graph */
2389 /* dump_whole_node must be called in post visiting predecessors */
2390 ird_walk_graph(irg, NULL, dump_whole_node, f);
2392 /* dump the out edges in a separate walk */
2393 if ((dump_out_edge_flag) && (get_irg_outs_state(irg) != outs_none)) {
2394 irg_out_walk(get_irg_start(irg), dump_out_edge, NULL, f);
2399 current_ir_graph = rem;
2402 /* Dump a firm graph without explicit block nodes. */
2403 void dump_ir_block_graph(ir_graph *irg, const char *suffix)
2409 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2412 if (get_interprocedural_view()) suffix1 = "-ip";
2414 f = vcg_open(irg, suffix, suffix1);
2417 dump_vcg_header(f, get_irg_dump_name(irg), NULL);
2419 construct_block_lists(irg);
2422 * If we are in the interprocedural view, we dump not
2423 * only the requested irg but also all irgs that can be reached
2426 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2427 ir_node **arr = ird_get_irg_link(get_irp_irg(i));
2429 dump_graph_from_list(f, get_irp_irg(i));
2438 /* Dump a firm graph without explicit block nodes but grouped in extended blocks. */
2439 void dump_ir_extblock_graph(ir_graph *irg, const char *suffix)
2446 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2449 if (get_irg_extblk_state(irg) != extblk_valid)
2452 if (get_interprocedural_view()) suffix1 = "-ip";
2455 ent = get_irg_entity(irg);
2457 F = vcg_open(irg, suffix, suffix1);
2459 dump_vcg_header(F, get_irg_dump_name(irg), NULL);
2461 construct_extblock_lists(irg);
2463 fprintf(F, "graph: { title: \"");
2465 fprintf(F, "\" label: \"%s\" status:clustered color: white \n",
2466 get_ent_dump_name(ent));
2468 dump_graph_info(F, irg);
2469 print_dbg_info(F, get_entity_dbg_info(ent));
2471 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2472 ir_graph *irg = get_irp_irg(i);
2473 list_tuple *lists = ird_get_irg_link(irg);
2476 /* dump the extended blocks first */
2477 if (ARR_LEN(lists->extbb_list)) {
2478 ird_set_irg_link(irg, lists->extbb_list);
2479 dump_extblock_graph(F, irg);
2482 /* we may have blocks without extended blocks, bad for instance */
2483 if (ARR_LEN(lists->blk_list)) {
2484 ird_set_irg_link(irg, lists->blk_list);
2485 dump_block_graph(F, irg);
2488 DEL_ARR_F(lists->extbb_list);
2489 DEL_ARR_F(lists->blk_list);
2494 /* Close the vcg information for the irg */
2495 fprintf(F, "}\n\n");
2502 /* dumps a graph with type information */
2504 dump_ir_graph_w_types(ir_graph *irg, const char *suffix)
2509 /* if a filter is set, dump only the irg's that match the filter */
2510 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2513 if (get_interprocedural_view()) suffix1 = "-pure-wtypes-ip";
2514 else suffix1 = "-pure-wtypes";
2515 f = vcg_open(irg,suffix, suffix1);
2517 ir_graph *rem = current_ir_graph;
2518 int rem_dump_const_local;
2520 current_ir_graph = irg;
2521 rem_dump_const_local = dump_const_local;
2522 /* dumping types does not work with local nodes */
2523 dump_const_local = 0;
2525 dump_vcg_header(f, get_irg_dump_name(irg), NULL);
2527 /* dump common ir graph */
2528 irg_walk(get_irg_end(irg), NULL, dump_whole_node, f);
2529 /* dump type info */
2530 type_walk_irg(irg, dump_type_info, NULL, f);
2531 inc_irg_visited(get_const_code_irg());
2532 /* dump edges from graph to type info */
2533 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, f);
2536 dump_const_local = rem_dump_const_local;
2537 current_ir_graph = rem;
2542 dump_ir_block_graph_w_types(ir_graph *irg, const char *suffix)
2548 /* if a filter is set, dump only the irg's that match the filter */
2549 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2552 if (get_interprocedural_view()) suffix1 = "-wtypes-ip";
2553 else suffix1 = "-wtypes";
2554 f = vcg_open(irg, suffix, suffix1);
2556 ir_graph *rem = current_ir_graph;
2557 int rem_dump_const_local;
2559 rem_dump_const_local = dump_const_local;
2560 /* dumping types does not work with local nodes */
2561 dump_const_local = 0;
2563 dump_vcg_header(f, get_irg_dump_name(irg), NULL);
2565 /* dump common blocked ir graph */
2566 construct_block_lists(irg);
2568 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2569 ir_node **arr = ird_get_irg_link(get_irp_irg(i));
2571 dump_graph_from_list(f, get_irp_irg(i));
2576 /* dump type info */
2577 current_ir_graph = irg;
2578 type_walk_irg(irg, dump_type_info, NULL, f);
2579 inc_irg_visited(get_const_code_irg());
2581 /* dump edges from graph to type info */
2582 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, f);
2585 dump_const_local = rem_dump_const_local;
2586 current_ir_graph = rem;
2590 /*---------------------------------------------------------------------*/
2591 /* The following routines dump a control flow graph. */
2592 /*---------------------------------------------------------------------*/
2595 dump_block_to_cfg(ir_node *block, void *env) {
2600 if (is_Block(block)) {
2601 /* This is a block. Dump a node for the block. */
2602 fprintf(F, "node: {title: \""); PRINT_NODEID(block);
2603 fprintf(F, "\" label: \"");
2604 if (block == get_irg_start_block(get_irn_irg(block)))
2605 fprintf(F, "Start ");
2606 if (block == get_irg_end_block(get_irn_irg(block)))
2609 fprintf(F, "%s ", get_op_name(get_irn_op(block)));
2610 PRINT_NODEID(block);
2612 fprintf(F, "info1:\"");
2614 /* the generic version. */
2615 dump_irnode_to_file(F, block);
2617 /* Check whether we have bad predecessors to color the block. */
2618 for (i = 0; i < get_Block_n_cfgpreds(block); ++i)
2619 if ((fl = is_Bad(get_Block_cfgpred(block, i))))
2622 fprintf(F, "\""); /* closing quote of info */
2624 if ((block == get_irg_start_block(get_irn_irg(block))) ||
2625 (block == get_irg_end_block(get_irn_irg(block))) )
2626 fprintf(F, " color:blue ");
2628 fprintf(F, " color:yellow ");
2631 /* Dump the edges */
2632 for ( i = 0; i < get_Block_n_cfgpreds(block); i++)
2633 if (get_irn_op(skip_Proj(get_Block_cfgpred(block, i))) != op_Bad) {
2634 pred = get_nodes_block(skip_Proj(get_Block_cfgpred(block, i)));
2635 fprintf(F, "edge: { sourcename: \"");
2636 PRINT_NODEID(block);
2637 fprintf(F, "\" targetname: \"");
2639 fprintf(F, "\"}\n");
2642 /* Dump dominator/postdominator edge */
2643 if (dump_dominator_information_flag) {
2644 if (get_irg_dom_state(current_ir_graph) == dom_consistent && get_Block_idom(block)) {
2645 pred = get_Block_idom(block);
2646 fprintf(F, "edge: { sourcename: \"");
2647 PRINT_NODEID(block);
2648 fprintf(F, "\" targetname: \"");
2650 fprintf(F, "\" " DOMINATOR_EDGE_ATTR "}\n");
2652 if (get_irg_postdom_state(current_ir_graph) == dom_consistent && get_Block_ipostdom(block)) {
2653 pred = get_Block_ipostdom(block);
2654 fprintf(F, "edge: { sourcename: \"");
2655 PRINT_NODEID(block);
2656 fprintf(F, "\" targetname: \"");
2658 fprintf(F, "\" " POSTDOMINATOR_EDGE_ATTR "}\n");
2665 dump_cfg(ir_graph *irg, const char *suffix)
2668 /* if a filter is set, dump only the irg's that match the filter */
2669 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2672 f = vcg_open(irg, suffix, "-cfg");
2674 ir_graph *rem = current_ir_graph;
2675 int ipv = get_interprocedural_view();
2677 current_ir_graph = irg;
2678 dump_vcg_header(f, get_irg_dump_name(irg), NULL);
2681 printf("Warning: dumping cfg not in interprocedural view!\n");
2682 set_interprocedural_view(0);
2685 /* walk over the blocks in the graph */
2686 irg_block_walk(get_irg_end(irg), dump_block_to_cfg, NULL, f);
2687 dump_node(f, get_irg_bad(irg));
2689 set_interprocedural_view(ipv);
2691 current_ir_graph = rem;
2696 static void descend_and_dump(FILE *F, ir_node *n, int depth, pset *mark_set) {
2697 if (pset_find_ptr(mark_set, n)) return;
2699 pset_insert_ptr(mark_set, n);
2702 int i, start = is_Block(n) ? 0 : -1;
2703 dump_whole_node(n, F);
2704 for (i = start; i < get_irn_arity(n); ++i)
2705 descend_and_dump(F, get_irn_n(n, i), depth-1, mark_set);
2708 /* Don't dump edges to nodes further out. These might be edges to
2709 nodes we already dumped, if there is a shorter path to these. */
2713 static int subgraph_counter = 0;
2714 void dump_subgraph(ir_node *root, int depth, const char *suffix) {
2718 sprintf(buf, "-subg_%03d", subgraph_counter++);
2719 F = vcg_open(get_irn_irg(root), suffix, buf);
2721 pset *mark_set = pset_new_ptr(1);
2722 dump_vcg_header(F, get_irg_dump_name(get_irn_irg(root)), NULL);
2723 descend_and_dump(F, root, depth, mark_set);
2730 static int weight_overall(int rec, int loop) {
2731 return 2*rec + loop;
2734 static int compute_color(int my, int max) {
2741 /* if small, scale to the full color range. */
2743 my = my * (n_colors/max);
2745 step = 1 + (max / n_colors);
2749 return base_color + n_colors - color;
2753 * Calculate a entity color depending on it's execution propability.
2755 static int get_entity_color(ir_entity *ent) {
2756 ir_graph *irg = get_entity_irg(ent);
2760 int rec_depth = get_irg_recursion_depth(irg);
2761 int loop_depth = get_irg_loop_depth(irg);
2762 int overall_depth = weight_overall(rec_depth, loop_depth);
2764 int max_rec_depth = irp->max_callgraph_recursion_depth;
2765 int max_loop_depth = irp->max_callgraph_loop_depth;
2766 int max_overall_depth = weight_overall(max_rec_depth, max_loop_depth);
2768 /* int my_rec_color = compute_color(rec_depth, max_rec_depth); */
2769 /* int my_loop_color = compute_color(loop_depth, max_loop_depth); */
2770 int my_overall_color = compute_color(overall_depth, max_overall_depth);
2772 return my_overall_color;
2776 void dump_callgraph(const char *suffix) {
2777 FILE *F = vcg_open_name("Callgraph", suffix);
2780 int i, rem = edge_label, colorize;
2782 dump_vcg_header(F, "Callgraph", NULL);
2784 colorize = get_irp_callgraph_state() == irp_callgraph_and_calltree_consistent;
2786 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2787 ir_graph *irg = get_irp_irg(i);
2788 ir_entity *ent = get_irg_entity(irg);
2789 int j, n_callees = get_irg_n_callees(irg);
2792 color = colorize ? get_entity_color(ent) : ird_color_green;
2793 dump_entity_node(F, ent, color);
2794 for (j = 0; j < n_callees; ++j) {
2795 ir_entity *c = get_irg_entity(get_irg_callee(irg, j));
2796 //if (id_is_prefix(prefix, get_entity_ld_ident(c))) continue;
2797 int be = is_irg_callee_backedge(irg, j);
2800 "label:\"recursion %d\" color:%d" :
2801 "label:\"calls %d\" color:%d";
2802 print_ent_ent_edge(F, ent, c, be, attr, get_irg_callee_loop_depth(irg, j), color);
2811 /* Dump all irgs in interprocedural view to a single file. */
2812 void dump_all_cg_block_graph(const char *suffix) {
2813 FILE *f = vcg_open_name("All_graphs", suffix);
2817 int rem_view = get_interprocedural_view();
2819 set_interprocedural_view(1);
2820 dump_vcg_header(f, "All_graphs", NULL);
2822 /* collect nodes in all irgs reachable in call graph*/
2823 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2824 ird_set_irg_link(get_irp_irg(i), NULL);
2826 cg_walk(clear_link, collect_node, NULL);
2828 /* dump all graphs */
2829 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2830 current_ir_graph = get_irp_irg(i);
2831 assert(ird_get_irg_link(current_ir_graph));
2832 dump_graph_from_list(f, current_ir_graph);
2833 DEL_ARR_F(ird_get_irg_link(current_ir_graph));
2837 set_interprocedural_view(rem_view);
2841 /*---------------------------------------------------------------------*/
2842 /* the following routines dumps type information without any ir nodes. */
2843 /*---------------------------------------------------------------------*/
2846 dump_type_graph(ir_graph *irg, const char *suffix)
2850 /* if a filter is set, dump only the irg's that match the filter */
2851 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
2853 f = vcg_open(irg, suffix, "-type");
2855 ir_graph *rem = current_ir_graph;
2856 current_ir_graph = irg;
2858 dump_vcg_header(f, get_irg_dump_name(irg), NULL);
2860 /* walk over the blocks in the graph */
2861 type_walk_irg(irg, dump_type_info, NULL, f);
2862 /* The walker for the const code can be called several times for the
2863 same (sub) expression. So that no nodes are dumped several times
2864 we decrease the visited flag of the corresponding graph after each
2865 walk. So now increase it finally. */
2866 inc_irg_visited(get_const_code_irg());
2869 current_ir_graph = rem;
2874 dump_all_types(const char *suffix)
2876 FILE *f = vcg_open_name("All_types", suffix);
2878 dump_vcg_header(f, "All_types", NULL);
2879 type_walk(dump_type_info, NULL, f);
2880 inc_irg_visited(get_const_code_irg());
2886 dump_class_hierarchy(int entities, const char *suffix)
2888 FILE *f = vcg_open_name("class_hierarchy", suffix);
2893 env.dump_ent = entities;
2894 dump_vcg_header(f, "class_hierarchy", NULL);
2895 type_walk(dump_class_hierarchy_node, NULL, &env);
2900 /*---------------------------------------------------------------------*/
2901 /* dumps all graphs with the graph-dumper passed. Possible dumpers: */
2903 /* dump_ir_block_graph */
2905 /* dump_type_graph */
2906 /* dump_ir_graph_w_types */
2907 /*---------------------------------------------------------------------*/
2909 void dump_all_ir_graphs(dump_graph_func *dmp_grph, const char *suffix) {
2911 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2912 dmp_grph(get_irp_irg(i), suffix);
2916 /*--------------------------------------------------------------------------------*
2917 * Dumps a stand alone loop graph with firm nodes which belong to one loop node *
2918 * packed together in one subgraph/box *
2919 *--------------------------------------------------------------------------------*/
2921 void dump_loops_standalone(FILE *F, ir_loop *loop) {
2922 int i = 0, loop_node_started = 0, son_number = 0, first = 0;
2924 ir_loop *son = NULL;
2926 /* Dump a new loop node. */
2927 dump_loop_node(F, loop);
2929 /* Dump the loop elements. */
2931 for(i = 0; i < get_loop_n_elements(loop); i++) {
2932 le = get_loop_element(loop, i);
2934 if (get_kind(son) == k_ir_loop) {
2936 /* We are a loop son -> Recurse */
2938 if(loop_node_started) { /* Close the "firm-nodes" node first if we started one. */
2939 fprintf(F, "\" }\n");
2940 fprintf(F, "edge: {sourcename: \"");
2942 fprintf(F, "\" targetname: \"");
2944 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
2945 loop_node_started = 0;
2947 dump_loop_son_edge(F, loop, son_number++);
2948 dump_loops_standalone(F, son);
2949 } else if (get_kind(son) == k_ir_node) {
2950 /* We are a loop node -> Collect firm nodes */
2952 ir_node *n = le.node;
2955 if (!loop_node_started) {
2956 /* Start a new node which contains all firm nodes of the current loop */
2957 fprintf(F, "node: { title: \"");
2959 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
2960 loop_node_started = 1;
2965 bad |= dump_node_label(F, n);
2966 /* Causes indeterministic output: if (is_Block(n)) fprintf(F, "\t ->%d", (int)get_irn_link(n)); */
2967 if (has_backedges(n)) fprintf(F, "\t loop head!");
2968 } else { /* for callgraph loop tree */
2970 assert(get_kind(son) == k_ir_graph);
2972 /* We are a loop node -> Collect firm graphs */
2973 n = (ir_graph *)le.node;
2974 if (!loop_node_started) {
2975 /* Start a new node which contains all firm nodes of the current loop */
2976 fprintf(F, "node: { title: \"");
2978 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
2979 loop_node_started = 1;
2983 fprintf(F, " %s", get_irg_dump_name(n));
2984 /* fprintf(F, " %s (depth %d)", get_irg_dump_name(n), n->callgraph_weighted_loop_depth); */
2988 if (loop_node_started) {
2989 fprintf(F, "\" }\n");
2990 fprintf(F, "edge: {sourcename: \"");
2992 fprintf(F, "\" targetname: \"");
2994 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
2995 loop_node_started = 0;
2999 void dump_loop_tree(ir_graph *irg, const char *suffix)
3003 /* if a filter is set, dump only the irg's that match the filter */
3004 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
3006 f = vcg_open(irg, suffix, "-looptree");
3008 ir_graph *rem = current_ir_graph;
3009 int el_rem = edge_label;
3011 current_ir_graph = irg;
3014 dump_vcg_header(f, get_irg_dump_name(irg), "top_to_bottom");
3016 if (get_irg_loop(irg)) dump_loops_standalone(f, get_irg_loop(irg));
3020 edge_label = el_rem;
3021 current_ir_graph = rem;
3025 void dump_callgraph_loop_tree(const char *suffix) {
3027 F = vcg_open_name("Callgraph_looptree", suffix);
3028 dump_vcg_header(F, "callgraph looptree", "top_to_bottom");
3029 dump_loops_standalone(F, irp->outermost_cg_loop);
3034 /*----------------------------------------------------------------------------*/
3035 /* Dumps the firm nodes in the loop tree to a graph along with the loop nodes.*/
3036 /*----------------------------------------------------------------------------*/
3038 void collect_nodeloop(FILE *F, ir_loop *loop, eset *loopnodes) {
3039 int i, son_number = 0, node_number = 0;
3041 if (dump_loop_information_flag) dump_loop_node(F, loop);
3043 for (i = 0; i < get_loop_n_elements(loop); i++) {
3044 loop_element le = get_loop_element(loop, i);
3045 if (*(le.kind) == k_ir_loop) {
3046 if (dump_loop_information_flag) dump_loop_son_edge(F, loop, son_number++);
3048 collect_nodeloop(F, le.son, loopnodes);
3050 if (dump_loop_information_flag) dump_loop_node_edge(F, loop, node_number++);
3051 eset_insert(loopnodes, le.node);
3056 void collect_nodeloop_external_nodes(ir_loop *loop, eset *loopnodes, eset *extnodes) {
3059 for(i = 0; i < get_loop_n_elements(loop); i++) {
3060 loop_element le = get_loop_element(loop, i);
3061 if (*(le.kind) == k_ir_loop) {
3063 collect_nodeloop_external_nodes(le.son, loopnodes, extnodes);
3065 if (is_Block(le.node)) start = 0; else start = -1;
3066 for (j = start; j < get_irn_arity(le.node); j++) {
3067 ir_node *pred = get_irn_n(le.node, j);
3068 if (!eset_contains(loopnodes, pred)) {
3069 eset_insert(extnodes, pred);
3070 if (!is_Block(pred)) {
3071 pred = get_nodes_block(pred);
3072 if (!eset_contains(loopnodes, pred)) eset_insert(extnodes, pred);
3080 void dump_loop(ir_loop *l, const char *suffix) {
3084 snprintf(name, sizeof(name), "loop_%d", get_loop_loop_nr(l));
3085 F = vcg_open_name(name, suffix);
3087 eset *loopnodes = eset_create();
3088 eset *extnodes = eset_create();
3091 dump_vcg_header(F, name, NULL);
3093 /* collect all nodes to dump */
3094 collect_nodeloop(F, l, loopnodes);
3095 collect_nodeloop_external_nodes(l, loopnodes, extnodes);
3097 /* build block lists */
3098 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes))
3099 set_irn_link(n, NULL);
3100 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes))
3101 set_irn_link(n, NULL);
3102 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes)) {
3104 b = get_nodes_block(n);
3105 set_irn_link(n, get_irn_link(b));
3109 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes)) {
3111 b = get_nodes_block(n);
3112 set_irn_link(n, get_irn_link(b));
3117 for (b = eset_first(loopnodes); b != NULL; b = eset_next(loopnodes)) {
3119 fprintf(F, "graph: { title: \"");
3121 fprintf(F, "\" label: \"");
3122 dump_node_opcode(F, b);
3123 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3124 fprintf(F, "\" status:clustered color:yellow\n");
3126 /* dump the blocks edges */
3127 dump_ir_data_edges(F, b);
3129 /* dump the nodes that go into the block */
3130 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3131 if (eset_contains(extnodes, n))
3132 overrule_nodecolor = ird_color_lightblue;
3134 overrule_nodecolor = ird_color_default;
3135 if (!eset_contains(extnodes, n)) dump_ir_data_edges(F, n);
3138 /* Close the vcg information for the block */
3140 dump_const_node_local(F, b);
3144 for (b = eset_first(extnodes); b != NULL; b = eset_next(extnodes)) {
3146 fprintf(F, "graph: { title: \"");
3148 fprintf(F, "\" label: \"");
3149 dump_node_opcode(F, b);
3150 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3151 fprintf(F, "\" status:clustered color:lightblue\n");
3153 /* dump the nodes that go into the block */
3154 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3155 if (!eset_contains(loopnodes, n))
3156 overrule_nodecolor = ird_color_lightblue;
3158 overrule_nodecolor = ird_color_default;
3159 if (eset_contains(loopnodes, n)) dump_ir_data_edges(F, n);
3162 /* Close the vcg information for the block */
3164 dump_const_node_local(F, b);
3168 eset_destroy(loopnodes);
3169 eset_destroy(extnodes);