2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Write vcg representation of firm to file.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Hubert Schmidt
35 #include "irgraph_t.h"
49 #include "callgraph.h"
50 #include "irextbb_t.h"
52 #include "dbginfo_t.h"
64 /** Dump only irgs with names that start with this prefix. */
65 static ident *dump_file_filter_id = NULL;
67 #define ERROR_TXT "<ERROR>"
69 /*******************************************************************/
70 /* flags to steer output */
71 /*******************************************************************/
73 /** An option to turn off edge labels */
74 static int edge_label = 1;
75 /** An option to turn off dumping values of constant entities */
76 static int const_entities = 1;
77 /** An option to dump the keep alive edges */
78 static int dump_keepalive = 1;
79 /** An option to dump the new out edges */
80 static int dump_new_edges_flag = 0;
81 /** An option to dump ld_names instead of names. */
82 static int dump_ld_name = 1;
83 /** Compiler options to dump analysis information in dump_ir_graph */
84 static int dump_out_edge_flag = 0;
85 static int dump_loop_information_flag = 0;
86 static int dump_backedge_information_flag = 1;
87 /** An option to dump const-like nodes locally. */
88 static int dump_const_local = 1;
89 /** An option to dump the node index number. */
90 static int dump_node_idx_labels = 0;
91 /** An option to dump all graph anchors */
92 static int dump_anchors = 0;
93 /** An option to dump the macro block edges. */
94 static int dump_macro_block_edges = 0;
95 /** An option to dump block marker in the block title */
96 static int dump_block_marker = 0;
98 int dump_dominator_information_flag = 0;
99 int opt_dump_analysed_type_info = 1;
100 int opt_dump_pointer_values_to_info = 0; /* default off: for test compares!! */
102 static ird_color_t overrule_nodecolor = ird_color_default_node;
104 /** The vcg node attribute hook. */
105 static DUMP_IR_GRAPH_FUNC dump_ir_graph_hook = NULL;
106 /** The vcg node attribute hook. */
107 static DUMP_NODE_VCGATTR_FUNC dump_node_vcgattr_hook = NULL;
108 /** The vcg edge attribute hook. */
109 static DUMP_EDGE_VCGATTR_FUNC dump_edge_vcgattr_hook = NULL;
110 /** The vcg dump block edge hook */
111 static DUMP_NODE_EDGE_FUNC dump_block_edge_hook = NULL;
112 /** The vcg dump node edge hook. */
113 static DUMP_NODE_EDGE_FUNC dump_node_edge_hook = NULL;
115 /* Set the hook to be called to dump additional edges to a node. */
116 void set_dump_node_edge_hook(DUMP_NODE_EDGE_FUNC func)
118 dump_node_edge_hook = func;
121 /* Get the additional edge dump hook. */
122 DUMP_NODE_EDGE_FUNC get_dump_node_edge_hook(void)
124 return dump_node_edge_hook;
127 /* Set the hook to be called to dump additional edges to a block. */
128 void set_dump_block_edge_hook(DUMP_NODE_EDGE_FUNC func)
130 dump_block_edge_hook = func;
133 /* Get the additional block edge dump hook. */
134 DUMP_NODE_EDGE_FUNC get_dump_block_edge_hook(void)
136 return dump_node_edge_hook;
139 /* set the ir graph hook */
140 void set_dump_ir_graph_hook(DUMP_IR_GRAPH_FUNC hook)
142 dump_ir_graph_hook = hook;
145 /* set the node attribute hook */
146 void set_dump_node_vcgattr_hook(DUMP_NODE_VCGATTR_FUNC hook)
148 dump_node_vcgattr_hook = hook;
151 /* set the edge attribute hook */
152 void set_dump_edge_vcgattr_hook(DUMP_EDGE_VCGATTR_FUNC hook)
154 dump_edge_vcgattr_hook = hook;
157 /** Returns 0 if dump_out_edge_flag or dump_loop_information_flag
158 * are set, else returns dump_const_local_flag.
160 static int get_opt_dump_const_local(void)
162 if (dump_out_edge_flag || dump_loop_information_flag || (dump_new_edges_flag && edges_activated(current_ir_graph)))
164 return dump_const_local;
167 /* Set a prefix filter for output functions. */
168 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)
176 return dump_file_filter_id;
179 /* Returns non-zero if dump file filter is not set, or if it is a prefix of name. */
180 int is_filtered_dump_name(ident *name)
182 if (!dump_file_filter_id) return 1;
183 return id_is_prefix(dump_file_filter_id, name);
186 /* To turn off display of edge labels. Edge labels often cause xvcg to
187 abort with a segmentation fault. */
188 void turn_off_edge_labels(void)
193 void dump_consts_local(int flag)
195 dump_const_local = flag;
198 void dump_node_idx_label(int flag)
200 dump_node_idx_labels = flag;
203 void dump_constant_entity_values(int flag)
205 const_entities = flag;
208 void dump_keepalive_edges(int flag)
210 dump_keepalive = flag;
213 void dump_new_edges(int flag)
215 dump_new_edges_flag = flag;
218 int get_opt_dump_keepalive_edges(void)
220 return dump_keepalive;
223 void dump_out_edges(int flag)
225 dump_out_edge_flag = flag;
228 void dump_dominator_information(int flag)
230 dump_dominator_information_flag = flag;
233 void dump_loop_information(int flag)
235 dump_loop_information_flag = flag;
238 void dump_backedge_information(int flag)
240 dump_backedge_information_flag = flag;
243 /* Dump the information of type field specified in ana/irtypeinfo.h.
244 * If the flag is set, the type name is output in [] in the node label,
245 * else it is output as info.
247 void set_opt_dump_analysed_type_info(int flag)
249 opt_dump_analysed_type_info = flag;
252 void dump_pointer_values_to_info(int flag)
254 opt_dump_pointer_values_to_info = flag;
257 void dump_ld_names(int flag)
262 void dump_all_anchors(int flag)
267 void dump_macroblock_edges(int flag)
269 dump_macro_block_edges = flag;
272 void dump_block_marker_in_title(int flag)
274 dump_block_marker = flag;
277 /* -------------- some extended helper functions ----------------- */
280 * returns the name of a mode or ERROR_TXT if mode is NOT a mode object.
281 * in the later case, sets bad.
283 const char *get_mode_name_ex(const ir_mode *mode, int *bad)
286 return get_mode_name(mode);
291 #define CUSTOM_COLOR_BASE 100
292 static const char *color_names[ird_color_count];
293 static const char *color_rgb[ird_color_count];
294 static struct obstack color_obst;
296 /** define a custom color. */
297 static void custom_color(int num, const char *rgb_def)
299 assert(num < ird_color_count);
300 obstack_printf(&color_obst, "%d", CUSTOM_COLOR_BASE + num);
301 obstack_1grow(&color_obst, '\0');
303 color_rgb[num] = rgb_def;
304 color_names[num] = obstack_finish(&color_obst);
307 /** Define a named color. */
308 static void named_color(int num, const char *name)
310 assert(num < ird_color_count);
311 color_rgb[num] = NULL;
312 color_names[num] = name;
315 /** Initializes the used colors. */
316 static void init_colors(void)
318 static int initialized = 0;
322 obstack_init(&color_obst);
324 custom_color(ird_color_prog_background, "204 204 204");
325 custom_color(ird_color_block_background, "255 255 0");
326 custom_color(ird_color_dead_block_background, "190 150 150");
327 named_color(ird_color_block_inout, "lightblue");
328 named_color(ird_color_default_node, "white");
329 custom_color(ird_color_memory, "153 153 255");
330 custom_color(ird_color_controlflow, "255 153 153");
331 custom_color(ird_color_const, "204 255 255");
332 custom_color(ird_color_proj, "255 255 153");
333 custom_color(ird_color_uses_memory, "153 153 255");
334 custom_color(ird_color_phi, "105 255 105");
335 custom_color(ird_color_anchor, "100 100 255");
336 named_color(ird_color_error, "red");
337 custom_color(ird_color_entity, "204 204 255");
343 * Prints the VCG color to a file.
345 static void print_vcg_color(FILE *F, ird_color_t color)
347 assert(color < ird_color_count);
348 fprintf(F, "color:%s", color_names[color]);
352 * Prints the edge kind of a given IR node.
354 * Projs should be dumped near their predecessor, so they get "nearedge".
356 static void print_node_edge_kind(FILE *F, ir_node *node)
359 fprintf(F, "nearedge: ");
361 fprintf(F, "edge: ");
366 * Prints the edge from a type S to a type T with additional info fmt, ...
369 static void print_type_type_edge(FILE *F, const ir_type *S, const ir_type *T, const char *fmt, ...)
374 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(S);
375 fprintf(F, " targetname: "); PRINT_TYPEID(T);
376 vfprintf(F, fmt, ap);
382 * Prints the edge from a type tp to an entity ent with additional info fmt, ...
385 static void print_type_ent_edge(FILE *F, const ir_type *tp, const ir_entity *ent, const char *fmt, ...)
390 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(tp);
391 fprintf(F, " targetname: \""); PRINT_ENTID(ent); fprintf(F, "\"");
392 vfprintf(F, fmt, ap);
398 * Prints the edge from an entity ent1 to an entity ent2 with additional info fmt, ...
401 static void print_ent_ent_edge(FILE *F, const ir_entity *ent1, const ir_entity *ent2, int backedge, ird_color_t color, const char *fmt, ...)
407 fprintf(F, "backedge: { sourcename: \"");
409 fprintf(F, "edge: { sourcename: \"");
411 fprintf(F, "\" targetname: \""); PRINT_ENTID(ent2); fprintf(F, "\"");
412 vfprintf(F, fmt, ap);
414 if (color != (ird_color_t) -1)
415 print_vcg_color(F, color);
421 * Prints the edge from an entity ent to a type tp with additional info fmt, ...
424 static void print_ent_type_edge(FILE *F, const ir_entity *ent, const ir_type *tp, const char *fmt, ...)
429 fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(ent);
430 fprintf(F, "\" targetname: "); PRINT_TYPEID(tp);
431 vfprintf(F, fmt, ap);
437 * Prints the edge from a node irn to a type tp with additional info fmt, ...
440 static void print_node_type_edge(FILE *F, const ir_node *irn, ir_type *tp, const char *fmt, ...)
445 fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(irn);
446 fprintf(F, "\" targetname: "); PRINT_TYPEID(tp);
447 vfprintf(F, fmt, ap);
453 * Prints the edge from a node irn to an entity ent with additional info fmt, ...
456 static void print_node_ent_edge(FILE *F, const ir_node *irn, const ir_entity *ent, const char *fmt, ...)
461 fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(irn);
462 fprintf(F, "\" targetname: \""); PRINT_ENTID(ent);
464 vfprintf(F, fmt, ap);
470 * Prints the edge from an entity ent to a node irn with additional info fmt, ...
473 static void print_ent_node_edge(FILE *F, const ir_entity *ent, const ir_node *irn, const char *fmt, ...)
478 fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(ent);
479 fprintf(F, "\" targetname: \""); PRINT_NODEID(irn); fprintf(F, "\"");
480 vfprintf(F, fmt, ap);
486 * Prints the edge from a type tp to an enumeration item item with additional info fmt, ...
489 static void print_enum_item_edge(FILE *F, const ir_type *tp, int item, const char *fmt, ...)
494 fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(tp);
495 fprintf(F, " targetname: \""); PRINT_ITEMID(tp, item); fprintf(F, "\" ");
496 vfprintf(F, fmt, ap);
501 /*-----------------------------------------------------------------*/
502 /* global and ahead declarations */
503 /*-----------------------------------------------------------------*/
505 static void dump_whole_node(ir_node *n, void *env);
506 static inline void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg);
508 /*-----------------------------------------------------------------*/
509 /* Helper functions. */
510 /*-----------------------------------------------------------------*/
513 * This map is used as a private link attr to be able to call dumper
514 * anywhere without destroying link fields.
516 static pmap *irdump_link_map = NULL;
518 /** NOT A STANDARD LIBFIRM INIT METHOD
520 * We do not want to integrate dumping into libfirm, i.e., if the dumpers
521 * are off, we want to have as few interferences as possible. Therefore the
522 * initialization is performed lazily and not called from within init_firm.
524 * Creates the link attribute map. */
525 static void init_irdump(void)
527 /* We need a new, empty map. */
528 if (irdump_link_map) pmap_destroy(irdump_link_map);
529 irdump_link_map = pmap_create();
530 if (!dump_file_filter_id)
531 dump_file_filter_id = new_id_from_str("");
535 * Returns the private link field.
537 static void *ird_get_irn_link(const ir_node *n)
540 if (irdump_link_map == NULL)
543 if (pmap_contains(irdump_link_map, n))
544 res = pmap_get(irdump_link_map, n);
549 * Sets the private link field.
551 static void ird_set_irn_link(const ir_node *n, void *x)
553 if (irdump_link_map == NULL)
555 pmap_insert(irdump_link_map, n, x);
559 * Gets the private link field of an irg.
561 static void *ird_get_irg_link(const ir_graph *irg)
564 if (irdump_link_map == NULL)
567 if (pmap_contains(irdump_link_map, irg))
568 res = pmap_get(irdump_link_map, irg);
573 * Sets the private link field of an irg.
575 static void ird_set_irg_link(const ir_graph *irg, void *x)
577 if (irdump_link_map == NULL)
579 pmap_insert(irdump_link_map, irg, x);
583 * Walker, clears the private link field.
585 static void clear_link(ir_node *node, void *env)
588 ird_set_irn_link(node, NULL);
592 * If the entity has a ld_name, returns it if the dump_ld_name is set,
593 * else returns the name of the entity.
595 static const char *_get_ent_dump_name(const ir_entity *ent, int dump_ld_name)
598 return "<NULL entity>";
600 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
601 if (ent->ld_name != NULL)
602 return get_id_str(ent->ld_name);
604 return get_id_str(ent->name);
608 * If the entity has a ld_name, returns it if the option dump_ld_name is set,
609 * else returns the name of the entity.
611 const char *get_ent_dump_name(const ir_entity *ent)
613 return _get_ent_dump_name(ent, dump_ld_name);
616 /* Returns the name of an IRG. */
617 const char *get_irg_dump_name(const ir_graph *irg)
619 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
620 return _get_ent_dump_name(get_irg_entity(irg), 1);
624 * Returns non-zero if a node is in floating state.
626 static int node_floats(const ir_node *n)
628 return ((get_irn_pinned(n) == op_pin_state_floats) &&
629 (get_irg_pinned(current_ir_graph) == op_pin_state_floats));
633 * Walker that visits the anchors
635 static void ird_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env)
637 if (dump_anchors || (dump_new_edges_flag && edges_activated(irg))) {
638 irg_walk_anchors(irg, pre, post, env);
640 irg_walk_graph(irg, pre, post, env);
645 * Walker, allocates an array for all blocks and puts it's nodes non-floating nodes into this array.
647 static void collect_node(ir_node *node, void *env)
652 || (get_op_flags(get_irn_op(node)) & irop_flag_dump_noblock)) {
653 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
654 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
655 ARR_APP1(ir_node *, arr, node);
656 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
658 ir_node * block = get_nodes_block(node);
661 /* this node is in a Bad block, so we must place it into the graph's list */
662 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
663 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
664 ARR_APP1(ir_node *, arr, node);
665 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
667 ird_set_irn_link(node, ird_get_irn_link(block));
668 ird_set_irn_link(block, node);
673 /** Construct lists to walk ir block-wise.
675 * Collects all blocks, nodes not op_pin_state_pinned,
676 * Bad, NoMem and Unknown into a flexible array in link field of
677 * irg they belong to. Sets the irg link field to NULL in all
678 * graphs not visited.
679 * Free the list with DEL_ARR_F().
681 static ir_node **construct_block_lists(ir_graph *irg)
684 #ifdef INTERPROCEDURAL_VIEW
685 int rem_view = get_interprocedural_view();
687 int walk_flag = ir_resources_reserved(irg) & IR_RESOURCE_IRN_VISITED;
688 ir_graph *rem = current_ir_graph;
690 current_ir_graph = irg;
693 ir_free_resources(irg, IR_RESOURCE_IRN_VISITED);
696 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
697 ird_set_irg_link(get_irp_irg(i), NULL);
699 ird_walk_graph(current_ir_graph, clear_link, collect_node, current_ir_graph);
701 #ifdef INTERPROCEDURAL_VIEW
702 /* Collect also EndReg and EndExcept. We do not want to change the walker. */
703 set_interprocedural_view(0);
706 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
707 irg_walk(get_irg_end_reg(current_ir_graph), clear_link, collect_node, current_ir_graph);
708 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph)-1);
709 irg_walk(get_irg_end_except(current_ir_graph), clear_link, collect_node, current_ir_graph);
711 #ifdef INTERPROCEDURAL_VIEW
712 set_interprocedural_view(rem_view);
716 ir_reserve_resources(irg, IR_RESOURCE_IRN_VISITED);
719 current_ir_graph = rem;
720 return ird_get_irg_link(irg);
723 typedef struct _list_tuple {
725 ir_extblk **extbb_list;
728 /** Construct lists to walk IR extended block-wise.
729 * Free the lists in the tuple with DEL_ARR_F().
730 * Sets the irg link field to NULL in all
731 * graphs not visited.
733 static list_tuple *construct_extblock_lists(ir_graph *irg)
735 ir_node **blk_list = construct_block_lists(irg);
737 ir_graph *rem = current_ir_graph;
738 list_tuple *lists = XMALLOC(list_tuple);
740 current_ir_graph = irg;
742 lists->blk_list = NEW_ARR_F(ir_node *, 0);
743 lists->extbb_list = NEW_ARR_F(ir_extblk *, 0);
745 inc_irg_block_visited(irg);
746 for (i = ARR_LEN(blk_list) - 1; i >= 0; --i) {
749 if (is_Block(blk_list[i])) {
750 ext = get_Block_extbb(blk_list[i]);
752 if (extbb_not_visited(ext)) {
753 ARR_APP1(ir_extblk *, lists->extbb_list, ext);
754 mark_extbb_visited(ext);
757 ARR_APP1(ir_node *, lists->blk_list, blk_list[i]);
761 current_ir_graph = rem;
762 ird_set_irg_link(irg, lists);
766 /*-----------------------------------------------------------------*/
767 /* Routines to dump information about a single ir node. */
768 /*-----------------------------------------------------------------*/
771 * dump the name of a node n to the File F.
773 int dump_node_opcode(FILE *F, ir_node *n)
776 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
778 /* call the dump_node operation if available */
780 return ops->dump_node(n, F, dump_node_opcode_txt);
782 /* implementation for default nodes */
783 switch (get_irn_opcode(n)) {
785 switch (get_SymConst_kind(n)) {
786 case symconst_addr_ent:
787 fprintf(F, "SymC &%s", get_entity_name(get_SymConst_entity(n)));
789 case symconst_ofs_ent:
790 fprintf(F, "SymC %s offset", get_entity_name(get_SymConst_entity(n)));
792 case symconst_type_tag:
793 ir_fprintf(F, "SymC %+F tag", get_SymConst_type(n));
795 case symconst_type_size:
796 ir_fprintf(F, "SymC %+F size", get_SymConst_type(n));
798 case symconst_type_align:
799 ir_fprintf(F, "SymC %+F align", get_SymConst_type(n));
801 case symconst_enum_const:
802 fprintf(F, "SymC %s enum", get_enumeration_const_name(get_SymConst_enum(n)));
807 #ifdef INTERPROCEDURAL_VIEW
809 if (!get_interprocedural_view())
817 ir_node *pred = get_Proj_pred(n);
819 if (get_irn_opcode(pred) == iro_Cond
820 && get_Proj_proj(n) == get_Cond_default_proj(pred)
821 && get_irn_mode(get_Cond_selector(pred)) != mode_b)
822 fprintf(F, "defProj");
827 #ifdef INTERPROCEDURAL_VIEW
832 if (get_interprocedural_view()) {
833 fprintf(F, "%s %s", get_irn_opname(n), get_ent_dump_name(get_irg_entity(get_irn_irg(n))));
839 case iro_CallBegin: {
840 ir_node *addr = get_CallBegin_ptr(n);
841 ir_entity *ent = NULL;
843 ent = get_Sel_entity(addr);
844 else if (is_Global(addr))
845 ent = get_Global_entity(addr);
846 fprintf(F, "%s", get_irn_opname(n));
847 if (ent) fprintf(F, " %s", get_entity_name(ent));
851 if (get_Load_align(n) == align_non_aligned)
853 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Load_mode(n), &bad));
856 if (get_Store_align(n) == align_non_aligned)
858 fprintf(F, "%s", get_irn_opname(n));
861 if (is_Block_dead(n))
863 if (n == get_irg_start_block(get_irn_irg(n)))
865 if (n == get_irg_end_block(get_irn_irg(n)))
867 fprintf(F, "%s%s", get_irn_opname(n),
868 dump_block_marker ? (get_Block_mark(n) ? "*" : "") : "");
871 if (get_Conv_strict(n))
872 fprintf(F, "strict");
873 fprintf(F, "%s", get_irn_opname(n));
876 fprintf(F, "%s", get_irn_opname(n));
877 if (get_Div_no_remainder(n))
879 fprintf(F, "[%s]", get_mode_name_ex(get_Div_resmode(n), &bad));
882 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Mod_resmode(n), &bad));
885 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_DivMod_resmode(n), &bad));
888 fprintf(F, "%s[%s]", get_irn_opname(n), get_builtin_kind_name(get_Builtin_kind(n)));
893 fprintf(F, "%s", get_irn_opname(n));
900 * Dump the mode of a node n to a file F.
901 * Ignore modes that are "always known".
903 static int dump_node_mode(FILE *F, ir_node *n)
906 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
910 /* call the dump_node operation if available */
912 return ops->dump_node(n, F, dump_node_mode_txt);
914 /* default implementation */
915 iro = get_irn_opcode(n);
927 mode = get_irn_mode(n);
929 if (mode != NULL && mode != mode_BB && mode != mode_ANY && mode != mode_BAD &&
930 (mode != mode_T || iro == iro_Proj))
931 fprintf(F, "%s", get_mode_name_ex(mode, &bad));
937 * Dump the type of a node n to a file F if it's known.
939 static int dump_node_typeinfo(FILE *F, ir_node *n)
943 if (opt_dump_analysed_type_info) {
944 if (get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_consistent ||
945 get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_inconsistent) {
946 ir_type *tp = get_irn_typeinfo_type(n);
947 if (tp != firm_none_type) {
948 ir_fprintf(F, "[%+F]", tp);
957 typedef struct _pns_lookup {
958 long nr; /**< the proj number */
959 const char *name; /**< the name of the Proj */
962 typedef struct _proj_lookup {
963 ir_opcode code; /**< the opcode of the Proj predecessor */
964 unsigned num_data; /**< number of data entries */
965 const pns_lookup_t *data; /**< the data */
968 #define ARR_SIZE(a) (sizeof(a)/sizeof(a[0]))
970 /** the lookup table for Proj(Start) names */
971 static const pns_lookup_t start_lut[] = {
972 #define X(a) { pn_Start_##a, #a }
980 /** the lookup table for Proj(Cond) names */
981 static const pns_lookup_t cond_lut[] = {
982 #define X(a) { pn_Cond_##a, #a }
988 /** the lookup table for Proj(Call) names */
989 static const pns_lookup_t call_lut[] = {
990 #define X(a) { pn_Call_##a, #a }
999 /** the lookup table for Proj(Quot) names */
1000 static const pns_lookup_t quot_lut[] = {
1001 #define X(a) { pn_Quot_##a, #a }
1009 /** the lookup table for Proj(DivMod) names */
1010 static const pns_lookup_t divmod_lut[] = {
1011 #define X(a) { pn_DivMod_##a, #a }
1020 /** the lookup table for Proj(Div) names */
1021 static const pns_lookup_t div_lut[] = {
1022 #define X(a) { pn_Div_##a, #a }
1030 /** the lookup table for Proj(Mod) names */
1031 static const pns_lookup_t mod_lut[] = {
1032 #define X(a) { pn_Mod_##a, #a }
1040 /** the lookup table for Proj(Load) names */
1041 static const pns_lookup_t load_lut[] = {
1042 #define X(a) { pn_Load_##a, #a }
1050 /** the lookup table for Proj(Store) names */
1051 static const pns_lookup_t store_lut[] = {
1052 #define X(a) { pn_Store_##a, #a }
1059 /** the lookup table for Proj(Alloc) names */
1060 static const pns_lookup_t alloc_lut[] = {
1061 #define X(a) { pn_Alloc_##a, #a }
1069 /** the lookup table for Proj(CopyB) names */
1070 static const pns_lookup_t copyb_lut[] = {
1071 #define X(a) { pn_CopyB_##a, #a }
1078 /** the lookup table for Proj(InstOf) names */
1079 static const pns_lookup_t instof_lut[] = {
1080 #define X(a) { pn_InstOf_##a, #a }
1088 /** the lookup table for Proj(Raise) names */
1089 static const pns_lookup_t raise_lut[] = {
1090 #define X(a) { pn_Raise_##a, #a }
1096 /** the lookup table for Proj(Bound) names */
1097 static const pns_lookup_t bound_lut[] = {
1098 #define X(a) { pn_Bound_##a, #a }
1106 /** the Proj lookup table */
1107 static const proj_lookup_t proj_lut[] = {
1108 #define E(a) ARR_SIZE(a), a
1109 { iro_Start, E(start_lut) },
1110 { iro_Cond, E(cond_lut) },
1111 { iro_Call, E(call_lut) },
1112 { iro_Quot, E(quot_lut) },
1113 { iro_DivMod, E(divmod_lut) },
1114 { iro_Div, E(div_lut) },
1115 { iro_Mod, E(mod_lut) },
1116 { iro_Load, E(load_lut) },
1117 { iro_Store, E(store_lut) },
1118 { iro_Alloc, E(alloc_lut) },
1119 { iro_CopyB, E(copyb_lut) },
1120 { iro_InstOf, E(instof_lut) },
1121 { iro_Raise, E(raise_lut) },
1122 { iro_Bound, E(bound_lut) }
1127 * Dump additional node attributes of some nodes to a file F.
1129 static int dump_node_nodeattr(FILE *F, ir_node *n)
1135 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1137 /* call the dump_node operation if available */
1139 return ops->dump_node(n, F, dump_node_nodeattr_txt);
1141 switch (get_irn_opcode(n)) {
1143 ir_fprintf(F, "%T ", get_Const_tarval(n));
1147 pred = get_Proj_pred(n);
1148 proj_nr = get_Proj_proj(n);
1149 #ifdef INTERPROCEDURAL_VIEW
1152 code = get_irn_opcode(pred);
1154 if (code == iro_Cmp)
1155 fprintf(F, "%s ", get_pnc_string(get_Proj_proj(n)));
1156 else if (code == iro_Proj && get_irn_opcode(get_Proj_pred(pred)) == iro_Start)
1157 fprintf(F, "Arg %ld ", proj_nr);
1158 else if (code == iro_Cond && get_irn_mode(get_Cond_selector(pred)) != mode_b)
1159 fprintf(F, "%ld ", proj_nr);
1161 unsigned i, j, f = 0;
1163 for (i = 0; i < ARR_SIZE(proj_lut); ++i) {
1164 if (code == proj_lut[i].code) {
1165 for (j = 0; j < proj_lut[i].num_data; ++j) {
1166 if (proj_nr == proj_lut[i].data[j].nr) {
1167 fprintf(F, "%s ", proj_lut[i].data[j].name);
1176 fprintf(F, "%ld ", proj_nr);
1177 if (code == iro_Cond && get_Cond_jmp_pred(pred) != COND_JMP_PRED_NONE) {
1178 if (proj_nr == pn_Cond_false && get_Cond_jmp_pred(pred) == COND_JMP_PRED_FALSE)
1179 fprintf(F, "PRED ");
1180 if (proj_nr == pn_Cond_true && get_Cond_jmp_pred(pred) == COND_JMP_PRED_TRUE)
1181 fprintf(F, "PRED ");
1186 proj_nr = get_Filter_proj(n);
1187 #ifdef INTERPROCEDURAL_VIEW
1188 if (! get_interprocedural_view()) {
1190 pred = get_Filter_pred(n);
1194 fprintf(F, "%ld ", proj_nr);
1197 fprintf(F, "%s ", get_ent_dump_name(get_Sel_entity(n)));
1200 ir_fprintf(F, "(%+F)", get_Cast_type(n));
1203 fprintf(F, "%s ", get_pnc_string(get_Confirm_cmp(n)));
1206 ir_fprintf(F, "(%+F)", get_CopyB_type(n));
1217 #include "execution_frequency.h"
1219 static void dump_node_ana_vals(FILE *F, ir_node *n)
1224 #ifdef INTERPROCEDURAL_VIEW
1225 fprintf(F, " %lf*(%2.0lf + %2.0lf) = %2.0lf ",
1226 get_irn_exec_freq(n),
1227 get_irg_method_execution_frequency(get_irn_irg(n)),
1228 pow(5, get_irg_recursion_depth(get_irn_irg(n))),
1229 get_irn_exec_freq(n) * (get_irg_method_execution_frequency(get_irn_irg(n)) + pow(5, get_irg_recursion_depth(get_irn_irg(n))))
1235 /* Dumps a node label without the enclosing ". */
1236 int dump_node_label(FILE *F, ir_node *n)
1240 bad |= dump_node_opcode(F, n);
1242 bad |= dump_node_mode(F, n);
1244 bad |= dump_node_typeinfo(F, n);
1245 bad |= dump_node_nodeattr(F, n);
1246 if (dump_node_idx_labels) {
1247 fprintf(F, "%ld:%u", get_irn_node_nr(n), get_irn_idx(n));
1249 fprintf(F, "%ld", get_irn_node_nr(n));
1255 /* Dumps the vrp information of a node to a file */
1256 int dump_vrp_info(FILE *F, ir_node *n)
1258 vrp_attr *vrp = vrp_get_info(n);
1263 fprintf(F, "range_type: %d\n", (int) vrp->range_type);
1264 if (vrp->range_type == VRP_RANGE || vrp->range_type ==
1266 ir_fprintf(F, "range_bottom: %F\n",vrp->range_bottom);
1267 ir_fprintf(F, "range_top: %F\n", vrp->range_top);
1269 ir_fprintf(F, "bits_set: %T\n", vrp->bits_set);
1270 ir_fprintf(F, "bits_not_set: %T\n", vrp->bits_not_set);
1276 * Dumps the attributes of a node n into the file F.
1277 * Currently this is only the color of a node.
1279 static void dump_node_vcgattr(FILE *F, ir_node *node, ir_node *local, int bad)
1285 print_vcg_color(F, ird_color_error);
1289 if (dump_node_vcgattr_hook)
1290 if (dump_node_vcgattr_hook(F, node, local))
1293 n = local ? local : node;
1295 if (overrule_nodecolor != ird_color_default_node) {
1296 print_vcg_color(F, overrule_nodecolor);
1300 mode = get_irn_mode(n);
1301 if (mode == mode_M) {
1302 print_vcg_color(F, ird_color_memory);
1305 if (mode == mode_X) {
1306 print_vcg_color(F, ird_color_controlflow);
1310 switch (get_irn_opcode(n)) {
1315 print_vcg_color(F, ird_color_anchor);
1318 print_vcg_color(F, ird_color_error);
1321 if (is_Block_dead(n))
1322 print_vcg_color(F, ird_color_dead_block_background);
1324 print_vcg_color(F, ird_color_block_background);
1327 print_vcg_color(F, ird_color_phi);
1330 print_vcg_color(F, ird_color_memory);
1334 print_vcg_color(F, ird_color_const);
1337 print_vcg_color(F, ird_color_proj);
1340 ir_op *op = get_irn_op(node);
1342 if (is_op_constlike(op)) {
1343 print_vcg_color(F, ird_color_const);
1344 } else if (is_op_uses_memory(op)) {
1345 print_vcg_color(F, ird_color_uses_memory);
1346 } else if (is_op_cfopcode(op) || is_op_forking(op)) {
1347 print_vcg_color(F, ird_color_controlflow);
1353 /* Adds a new node info dumper callback. */
1354 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data)
1356 hook_entry_t *info = XMALLOC(hook_entry_t);
1358 info->hook._hook_node_info = cb;
1359 info->context = data;
1360 register_hook(hook_node_info, info);
1365 /* Remove a previously added info dumper callback. */
1366 void dump_remv_node_info_callback(void *handle)
1368 hook_entry_t *info = handle;
1369 unregister_hook(hook_node_info, info);
1374 * Dump the node information of a node n to a file F.
1376 static inline int dump_node_info(FILE *F, ir_node *n)
1379 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1381 fprintf(F, " info1: \"");
1382 bad = dump_irnode_to_file(F, n);
1383 /* call the dump_node operation if available */
1385 bad = ops->dump_node(n, F, dump_node_info_txt);
1387 /* allow additional info to be added */
1388 hook_node_info(F, n);
1394 static inline int is_constlike_node(const ir_node *node)
1396 const ir_op *op = get_irn_op(node);
1397 return is_op_constlike(op);
1401 /** outputs the predecessors of n, that are constants, local. I.e.,
1402 generates a copy of the constant predecessors for each node called with. */
1403 static void dump_const_node_local(FILE *F, ir_node *n)
1406 if (!get_opt_dump_const_local()) return;
1408 /* Use visited flag to avoid outputting nodes twice.
1409 initialize it first. */
1410 for (i = 0; i < get_irn_arity(n); i++) {
1411 ir_node *con = get_irn_n(n, i);
1412 if (is_constlike_node(con)) {
1413 set_irn_visited(con, get_irg_visited(current_ir_graph) - 1);
1417 for (i = 0; i < get_irn_arity(n); i++) {
1418 ir_node *con = get_irn_n(n, i);
1419 if (is_constlike_node(con) && !irn_visited(con)) {
1422 mark_irn_visited(con);
1423 /* Generate a new name for the node by appending the names of
1425 fprintf(F, "node: {title: "); PRINT_CONSTID(n, con);
1426 fprintf(F, " label: \"");
1427 bad |= dump_node_label(F, con);
1429 bad |= dump_node_info(F, con);
1430 dump_node_vcgattr(F, n, con, bad);
1436 /** If the block of an edge is a const_like node, dump it local with an edge */
1437 static void dump_const_block_local(FILE *F, ir_node *n)
1441 if (!get_opt_dump_const_local()) return;
1443 blk = get_nodes_block(n);
1444 if (is_constlike_node(blk)) {
1447 /* Generate a new name for the node by appending the names of
1449 fprintf(F, "node: {title: \""); PRINT_CONSTBLKID(n, blk);
1450 fprintf(F, "\" label: \"");
1451 bad |= dump_node_label(F, blk);
1453 bad |= dump_node_info(F, blk);
1454 dump_node_vcgattr(F, n, blk, bad);
1457 fprintf(F, "edge: { sourcename: \"");
1459 fprintf(F, "\" targetname: \""); PRINT_CONSTBLKID(n,blk);
1461 if (dump_edge_vcgattr_hook) {
1463 if (dump_edge_vcgattr_hook(F, n, -1)) {
1467 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1472 fprintf(F, "\" " BLOCK_EDGE_ATTR "}\n");
1477 * prints the error message of a node to a file F as info2.
1479 static void print_node_error(FILE *F, const char *err_msg)
1484 fprintf(F, " info2: \"%s\"", err_msg);
1488 * prints debug messages of a node to file F as info3.
1490 static void print_dbg_info(FILE *F, dbg_info *dbg)
1494 ir_dbg_info_snprint(buf, sizeof(buf), dbg);
1496 fprintf(F, " info3: \"%s\"\n", buf);
1500 static void print_type_dbg_info(FILE *F, type_dbg_info *dbg)
1510 static void dump_node(FILE *F, ir_node *n)
1515 if (get_opt_dump_const_local() && is_constlike_node(n))
1518 /* dump this node */
1519 fputs("node: {title: \"", F);
1523 fputs(" label: \"", F);
1524 bad = ! irn_vrfy_irg_dump(n, current_ir_graph, &p);
1525 bad |= dump_node_label(F, n);
1526 dump_node_ana_vals(F, n);
1527 //dump_node_ana_info(F, n);
1530 if (get_op_flags(get_irn_op(n)) & irop_flag_dump_noinput) {
1531 //fputs(" node_class:23", F);
1534 bad |= dump_node_info(F, n);
1535 print_node_error(F, p);
1536 print_dbg_info(F, get_irn_dbg_info(n));
1537 dump_node_vcgattr(F, n, NULL, bad);
1539 dump_const_node_local(F, n);
1541 if (dump_node_edge_hook)
1542 dump_node_edge_hook(F, n);
1545 /** dump the edge to the block this node belongs to */
1546 static void dump_ir_block_edge(FILE *F, ir_node *n)
1548 if (get_opt_dump_const_local() && is_constlike_node(n)) return;
1549 if (is_no_Block(n)) {
1550 ir_node *block = get_nodes_block(n);
1552 if (get_opt_dump_const_local() && is_constlike_node(block)) {
1553 dump_const_block_local(F, n);
1555 fprintf(F, "edge: { sourcename: \"");
1557 fprintf(F, "\" targetname: ");
1558 fprintf(F, "\""); PRINT_NODEID(block); fprintf(F, "\"");
1560 if (dump_edge_vcgattr_hook) {
1562 if (dump_edge_vcgattr_hook(F, n, -1)) {
1566 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1571 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1576 static void print_data_edge_vcgattr(FILE *F, ir_node *from, int to)
1579 * do not use get_nodes_block() here, will fail
1580 * if the irg is not pinned.
1582 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1583 fprintf(F, INTRA_DATA_EDGE_ATTR);
1585 fprintf(F, INTER_DATA_EDGE_ATTR);
1588 static void print_mem_edge_vcgattr(FILE *F, ir_node *from, int to)
1591 * do not use get_nodes_block() here, will fail
1592 * if the irg is not pinned.
1594 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1595 fprintf(F, INTRA_MEM_EDGE_ATTR);
1597 fprintf(F, INTER_MEM_EDGE_ATTR);
1600 /** Print the vcg attributes for the edge from node from to it's to's input */
1601 static void print_edge_vcgattr(FILE *F, ir_node *from, int to)
1605 if (dump_edge_vcgattr_hook)
1606 if (dump_edge_vcgattr_hook(F, from, to))
1609 if (dump_backedge_information_flag && is_backedge(from, to))
1610 fprintf(F, BACK_EDGE_ATTR);
1612 switch (get_irn_opcode(from)) {
1614 fprintf(F, CF_EDGE_ATTR);
1616 case iro_Start: break;
1619 if (get_irn_mode(get_End_keepalive(from, to)) == mode_BB)
1620 fprintf(F, KEEP_ALIVE_CF_EDGE_ATTR);
1622 fprintf(F, KEEP_ALIVE_DF_EDGE_ATTR);
1626 if (is_Proj(from)) {
1627 if (get_irn_mode(from) == mode_M)
1628 print_mem_edge_vcgattr(F, from, to);
1629 else if (get_irn_mode(from) == mode_X)
1630 fprintf(F, CF_EDGE_ATTR);
1632 print_data_edge_vcgattr(F, from, to);
1634 else if (get_irn_mode(get_irn_n(from, to)) == mode_M)
1635 print_mem_edge_vcgattr(F, from, to);
1636 else if (get_irn_mode(get_irn_n(from, to)) == mode_X)
1637 fprintf(F, CF_EDGE_ATTR);
1639 print_data_edge_vcgattr(F, from, to);
1643 /** dump edges to our inputs */
1644 static void dump_ir_data_edges(FILE *F, ir_node *n)
1648 if (!dump_keepalive && is_End(n)) {
1649 /* the End node has only keep-alive edges */
1653 /* dump the dependency edges. */
1654 num = get_irn_deps(n);
1655 for (i = 0; i < num; ++i) {
1656 ir_node *dep = get_irn_dep(n, i);
1659 print_node_edge_kind(F, n);
1660 fprintf(F, "{sourcename: \"");
1662 fprintf(F, "\" targetname: ");
1663 if ((get_opt_dump_const_local()) && is_constlike_node(dep)) {
1664 PRINT_CONSTID(n, dep);
1670 fprintf(F, " label: \"%d\" ", i);
1671 fprintf(F, " color: darkgreen}\n");
1675 num = get_irn_arity(n);
1676 for (i = 0; i < num; i++) {
1677 ir_node *pred = get_irn_n(n, i);
1680 #ifdef INTERPROCEDURAL_VIEW
1681 if ((get_interprocedural_view() && get_irn_visited(pred) < get_irn_visited(n)))
1682 continue; /* pred not dumped */
1685 if (dump_backedge_information_flag && is_backedge(n, i))
1686 fprintf(F, "backedge: {sourcename: \"");
1688 print_node_edge_kind(F, n);
1689 fprintf(F, "{sourcename: \"");
1692 fprintf(F, "\" targetname: ");
1693 if ((get_opt_dump_const_local()) && is_constlike_node(pred)) {
1694 PRINT_CONSTID(n, pred);
1696 fprintf(F, "\""); PRINT_NODEID(pred); fprintf(F, "\"");
1698 fprintf(F, " label: \"%d\" ", i);
1699 print_edge_vcgattr(F, n, i);
1703 if (dump_macro_block_edges && is_Block(n)) {
1704 ir_node *mb = get_Block_MacroBlock(n);
1705 fprintf(F, "edge: {sourcename: \"");
1707 fprintf(F, "\" targetname: \"");
1709 fprintf(F, "\" label: \"mb\" " MACROBLOCK_EDGE_ATTR);
1717 static void dump_ir_edges(FILE *F, ir_node *n)
1719 const ir_edge_t *edge;
1722 foreach_out_edge(n, edge) {
1723 ir_node *succ = get_edge_src_irn(edge);
1725 print_node_edge_kind(F, succ);
1726 fprintf(F, "{sourcename: \"");
1728 fprintf(F, "\" targetname: \"");
1732 fprintf(F, " label: \"%d\" ", i);
1733 fprintf(F, OUT_EDGE_ATTR);
1740 /** Dumps a node and its edges but not the block edge */
1741 static void dump_node_wo_blockedge(ir_node *n, void *env)
1745 dump_ir_data_edges(F, n);
1748 /** Dumps a node and its edges. */
1749 static void dump_whole_node(ir_node *n, void *env)
1752 dump_node_wo_blockedge(n, env);
1753 if (!node_floats(n))
1754 dump_ir_block_edge(F, n);
1755 if (dump_new_edges_flag && edges_activated(current_ir_graph))
1756 dump_ir_edges(F, n);
1759 /** Dumps a const-like node. */
1760 static void dump_const_node(ir_node *n, void *env)
1762 if (is_Block(n)) return;
1763 dump_node_wo_blockedge(n, env);
1766 /***********************************************************************/
1767 /* the following routines dump the nodes/irgs bracketed to graphs. */
1768 /***********************************************************************/
1770 /** Dumps a constant expression as entity initializer, array bound ...
1772 static void dump_const_expression(FILE *F, ir_node *value)
1774 ir_graph *rem = current_ir_graph;
1775 int rem_dump_const_local = dump_const_local;
1776 dump_const_local = 0;
1777 current_ir_graph = get_const_code_irg();
1778 irg_walk(value, dump_const_node, NULL, F);
1779 /* Decrease visited flag so that we walk with the same flag for the next
1780 expression. This guarantees that we don't dump the same node twice,
1781 as for const expressions cse is performed to save memory. */
1782 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph) -1);
1783 current_ir_graph = rem;
1784 dump_const_local = rem_dump_const_local;
1787 /** Dump a block as graph containing its nodes.
1789 * Expects to find nodes belonging to the block as list in its
1791 * Dumps the edges of all nodes including itself. */
1792 static void dump_whole_block(FILE *F, ir_node *block)
1795 ird_color_t color = ird_color_block_background;
1797 assert(is_Block(block));
1799 fprintf(F, "graph: { title: \"");
1800 PRINT_NODEID(block);
1801 fprintf(F, "\" label: \"");
1802 dump_node_label(F, block);
1804 /* colorize blocks */
1805 if (! get_Block_matured(block))
1806 color = ird_color_block_background;
1807 if (is_Block_dead(block))
1808 color = ird_color_dead_block_background;
1810 fprintf(F, "\" status:clustered ");
1811 print_vcg_color(F, color);
1814 /* yComp can show attributes for blocks, XVCG parses but ignores them */
1815 dump_node_info(F, block);
1816 print_dbg_info(F, get_irn_dbg_info(block));
1818 /* dump the blocks edges */
1819 dump_ir_data_edges(F, block);
1821 if (dump_block_edge_hook)
1822 dump_block_edge_hook(F, block);
1824 /* dump the nodes that go into the block */
1825 for (node = ird_get_irn_link(block); node; node = ird_get_irn_link(node)) {
1827 dump_ir_data_edges(F, node);
1830 /* Close the vcg information for the block */
1832 dump_const_node_local(F, block);
1836 /** dumps a graph block-wise. Expects all blockless nodes in arr in irgs link.
1837 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1838 static void dump_block_graph(FILE *F, ir_graph *irg)
1841 ir_graph *rem = current_ir_graph;
1842 ir_node **arr = ird_get_irg_link(irg);
1843 current_ir_graph = irg;
1845 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1846 ir_node * node = arr[i];
1847 if (is_Block(node)) {
1848 /* Dumps the block and all the nodes in the block, which are to
1849 be found in Block->link. */
1850 dump_whole_block(F, node);
1852 /* Nodes that are not in a Block. */
1854 if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
1855 dump_const_block_local(F, node);
1857 dump_ir_data_edges(F, node);
1859 if (dump_new_edges_flag && edges_activated(irg))
1860 dump_ir_edges(F, node);
1863 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1864 dump_loop_nodes_into_graph(F, irg);
1866 current_ir_graph = rem;
1870 * Dump the info for an irg.
1871 * Parsed by XVCG but not shown. use yComp.
1873 static void dump_graph_info(FILE *F, ir_graph *irg)
1875 fprintf(F, "info1: \"");
1876 dump_entity_to_file(F, get_irg_entity(irg), dump_verbosity_entattrs | dump_verbosity_entconsts);
1880 /** Dumps an irg as a graph clustered by block nodes.
1881 * If interprocedural view edges can point to nodes out of this graph.
1883 static void dump_graph_from_list(FILE *F, ir_graph *irg)
1885 ir_entity *ent = get_irg_entity(irg);
1887 fprintf(F, "graph: { title: \"");
1889 fprintf(F, "\" label: \"%s\" status:clustered color:%s \n",
1890 get_ent_dump_name(ent), color_names[ird_color_prog_background]);
1892 dump_graph_info(F, irg);
1893 print_dbg_info(F, get_entity_dbg_info(ent));
1895 dump_block_graph(F, irg);
1897 /* Close the vcg information for the irg */
1898 fprintf(F, "}\n\n");
1901 /** dumps a graph extended block-wise. Expects all blockless nodes in arr in irgs link.
1902 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1903 static void dump_extblock_graph(FILE *F, ir_graph *irg)
1906 ir_graph *rem = current_ir_graph;
1907 ir_extblk **arr = ird_get_irg_link(irg);
1908 current_ir_graph = irg;
1910 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1911 ir_extblk *extbb = arr[i];
1912 ir_node *leader = get_extbb_leader(extbb);
1915 fprintf(F, "graph: { title: \"");
1916 PRINT_EXTBBID(leader);
1917 fprintf(F, "\" label: \"ExtBB %ld\" status:clustered color:lightgreen\n",
1918 get_irn_node_nr(leader));
1920 for (j = ARR_LEN(extbb->blks) - 1; j >= 0; --j) {
1921 ir_node * node = extbb->blks[j];
1922 if (is_Block(node)) {
1923 /* Dumps the block and all the nodes in the block, which are to
1924 be found in Block->link. */
1925 dump_whole_block(F, node);
1927 /* Nodes that are not in a Block. */
1929 if (is_Bad(get_nodes_block(node)) && !node_floats(node)) {
1930 dump_const_block_local(F, node);
1932 dump_ir_data_edges(F, node);
1938 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1939 dump_loop_nodes_into_graph(F, irg);
1941 current_ir_graph = rem;
1946 /*******************************************************************/
1947 /* Basic type and entity nodes and edges. */
1948 /*******************************************************************/
1950 /** dumps the edges between nodes and their type or entity attributes. */
1951 static void dump_node2type_edges(ir_node *n, void *env)
1956 switch (get_irn_opcode(n)) {
1958 /* @@@ some consts have an entity */
1961 if (SYMCONST_HAS_TYPE(get_SymConst_kind(n)))
1962 print_node_type_edge(F,n,get_SymConst_type(n),NODE2TYPE_EDGE_ATTR);
1965 print_node_ent_edge(F,n,get_Sel_entity(n),NODE2TYPE_EDGE_ATTR);
1968 print_node_type_edge(F,n,get_Call_type(n),NODE2TYPE_EDGE_ATTR);
1971 print_node_type_edge(F,n,get_Alloc_type(n),NODE2TYPE_EDGE_ATTR);
1974 print_node_type_edge(F,n,get_Free_type(n),NODE2TYPE_EDGE_ATTR);
1977 print_node_type_edge(F,n,get_Cast_type(n),NODE2TYPE_EDGE_ATTR);
1985 static int print_type_info(FILE *F, ir_type *tp)
1989 if (get_type_state(tp) == layout_undefined) {
1990 fprintf(F, "state: layout_undefined\n");
1992 fprintf(F, "state: layout_fixed,\n");
1994 if (get_type_mode(tp))
1995 fprintf(F, "mode: %s,\n", get_mode_name_ex(get_type_mode(tp), &bad));
1996 fprintf(F, "size: %db,\n", get_type_size_bits(tp));
2001 static void print_typespecific_info(FILE *F, ir_type *tp)
2003 switch (get_type_tpop_code(tp)) {
2005 fprintf(F, "peculiarity: %s\n", get_peculiarity_string(get_class_peculiarity(tp)));
2010 fprintf(F, "variadicity: %s\n", get_variadicity_name(get_method_variadicity(tp)));
2011 fprintf(F, "params: %d\n", get_method_n_params(tp));
2012 fprintf(F, "results: %d\n", get_method_n_ress(tp));
2018 case tpo_enumeration:
2030 static void print_typespecific_vcgattr(FILE *F, ir_type *tp)
2032 switch (get_type_tpop_code(tp)) {
2034 fprintf(F, " " TYPE_CLASS_NODE_ATTR);
2037 fprintf(F, " " TYPE_METH_NODE_ATTR);
2045 case tpo_enumeration:
2056 int dump_type_node(FILE *F, ir_type *tp)
2060 fprintf(F, "node: {title: ");
2062 ir_fprintf(F, " label: \"%s %+F\" info1: \"", get_type_tpop_name(tp), tp);
2063 dump_type_to_file(F, tp, dump_verbosity_max);
2065 print_type_dbg_info(F, get_type_dbg_info(tp));
2066 print_typespecific_vcgattr(F, tp);
2073 static void dump_entity_node(FILE *F, ir_entity *ent)
2075 fprintf(F, "node: {title: \"");
2076 PRINT_ENTID(ent); fprintf(F, "\"");
2077 fprintf(F, " label: ");
2078 fprintf(F, "\"%s\" ", get_ent_dump_name(ent));
2080 print_vcg_color(F, ird_color_entity);
2081 fprintf(F, "\n info1: \"");
2083 dump_entity_to_file(F, ent, dump_verbosity_entattrs | dump_verbosity_entconsts);
2086 print_dbg_info(F, get_entity_dbg_info(ent));
2090 static void dump_enum_item(FILE *F, ir_type *tp, int pos)
2093 ir_enum_const *ec = get_enumeration_const(tp, pos);
2094 ident *id = get_enumeration_const_nameid(ec);
2095 tarval *tv = get_enumeration_value(ec);
2098 tarval_snprintf(buf, sizeof(buf), tv);
2100 strncpy(buf, "<not set>", sizeof(buf));
2101 fprintf(F, "node: {title: \"");
2102 PRINT_ITEMID(tp, pos); fprintf(F, "\"");
2103 fprintf(F, " label: ");
2104 fprintf(F, "\"enum item %s\" " ENUM_ITEM_NODE_ATTR, get_id_str(id));
2105 fprintf(F, "\n info1: \"value: %s\"}\n", buf);
2109 * Dumps a new style initializer.
2111 static void dump_entity_initializer(FILE *F, const ir_entity *ent)
2118 /** Dumps a type or entity and it's edges. */
2119 static void dump_type_info(type_or_ent tore, void *env)
2122 int i = 0; /* to shutup gcc */
2124 /* dump this type or entity */
2126 switch (get_kind(tore.ent)) {
2128 ir_entity *ent = tore.ent;
2131 dump_entity_node(F, ent);
2133 /* skip this to reduce graph. Member edge of type is parallel to this edge. *
2134 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2135 ENT_OWN_EDGE_ATTR "}\n", ent, get_entity_owner(ent));*/
2136 print_ent_type_edge(F,ent, get_entity_type(ent), ENT_TYPE_EDGE_ATTR);
2137 if (is_Class_type(get_entity_owner(ent))) {
2138 for (i = get_entity_n_overwrites(ent) - 1; i >= 0; --i)
2139 print_ent_ent_edge(F,ent, get_entity_overwrites(ent, i), 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2141 /* attached subgraphs */
2142 if (const_entities) {
2143 if (ent->initializer != NULL) {
2144 /* new style initializers */
2145 dump_entity_initializer(F, ent);
2146 } else if (entity_has_compound_ent_values(ent)) {
2147 /* old style compound entity values */
2148 for (i = get_compound_ent_n_values(ent) - 1; i >= 0; --i) {
2149 value = get_compound_ent_value(ent, i);
2151 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2152 dump_const_expression(F, value);
2153 print_ent_ent_edge(F, ent, get_compound_ent_value_member(ent, i), 0, -1, ENT_CORR_EDGE_ATTR, i);
2155 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2156 ENT_CORR_EDGE_ATTR "}\n", GET_ENTID(ent),
2157 get_compound_ent_value_member(ent, i), i);
2166 ir_type *tp = tore.typ;
2167 dump_type_node(F, tp);
2168 /* and now the edges */
2169 switch (get_type_tpop_code(tp)) {
2171 for (i = get_class_n_supertypes(tp) - 1; i >= 0; --i)
2172 print_type_type_edge(F, tp, get_class_supertype(tp, i), TYPE_SUPER_EDGE_ATTR);
2173 for (i = get_class_n_members(tp) - 1; i >= 0; --i)
2174 print_type_ent_edge(F, tp, get_class_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
2177 for (i = get_struct_n_members(tp) - 1; i >= 0; --i)
2178 print_type_ent_edge(F, tp, get_struct_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
2181 for (i = get_method_n_params(tp) - 1; i >= 0; --i)
2182 print_type_type_edge(F, tp, get_method_param_type(tp, i), METH_PAR_EDGE_ATTR,i);
2183 for (i = get_method_n_ress(tp) - 1; i >= 0; --i)
2184 print_type_type_edge(F, tp, get_method_res_type(tp, i), METH_RES_EDGE_ATTR,i);
2187 for (i = get_union_n_members(tp) - 1; i >= 0; --i)
2188 print_type_ent_edge(F, tp, get_union_member(tp, i), UNION_EDGE_ATTR);
2191 print_type_type_edge(F, tp, get_array_element_type(tp), ARR_ELT_TYPE_EDGE_ATTR);
2192 print_type_ent_edge(F, tp, get_array_element_entity(tp), ARR_ENT_EDGE_ATTR);
2193 for (i = get_array_n_dimensions(tp) - 1; i >= 0; --i) {
2194 ir_node *upper = get_array_upper_bound(tp, i);
2195 ir_node *lower = get_array_lower_bound(tp, i);
2196 print_node_type_edge(F, upper, tp, "label: \"upper %d\"", get_array_order(tp, i));
2197 print_node_type_edge(F, lower, tp, "label: \"lower %d\"", get_array_order(tp, i));
2198 dump_const_expression(F, upper);
2199 dump_const_expression(F, lower);
2202 case tpo_enumeration:
2203 for (i = get_enumeration_n_enums(tp) - 1; i >= 0; --i) {
2204 dump_enum_item(F, tp, i);
2205 print_enum_item_edge(F, tp, i, "label: \"item %d\"", i);
2209 print_type_type_edge(F, tp, get_pointer_points_to_type(tp), PTR_PTS_TO_EDGE_ATTR);
2216 break; /* case k_type */
2219 printf(" *** irdump, dump_type_info(l.%i), faulty type.\n", __LINE__);
2220 } /* switch kind_or_entity */
2223 typedef struct _h_env {
2228 /** For dumping class hierarchies.
2229 * Dumps a class type node and a superclass edge.
2230 * If env->dump_ent dumps entities of classes and overwrites edges.
2232 static void dump_class_hierarchy_node(type_or_ent tore, void *ctx)
2236 int i = 0; /* to shutup gcc */
2238 /* dump this type or entity */
2239 switch (get_kind(tore.ent)) {
2241 ir_entity *ent = tore.ent;
2242 if (get_entity_owner(ent) == get_glob_type()) break;
2243 if (!is_Method_type(get_entity_type(ent)))
2245 if (env->dump_ent && is_Class_type(get_entity_owner(ent))) {
2247 dump_entity_node(F, ent);
2249 print_type_ent_edge(F, get_entity_owner(ent), ent, TYPE_MEMBER_EDGE_ATTR);
2250 for (i = get_entity_n_overwrites(ent) - 1; i >= 0; --i)
2251 print_ent_ent_edge(F, get_entity_overwrites(ent, i), ent, 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2256 ir_type *tp = tore.typ;
2257 if (tp == get_glob_type())
2259 switch (get_type_tpop_code(tp)) {
2261 dump_type_node(F, tp);
2262 /* and now the edges */
2263 for (i = get_class_n_supertypes(tp) - 1; i >= 0; --i) {
2264 print_type_type_edge(F,tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2269 break; /* case k_type */
2272 printf(" *** irdump, dump_class_hierarchy_node(l.%i), faulty type.\n", __LINE__);
2273 } /* switch kind_or_entity */
2276 /*******************************************************************/
2277 /* dump analysis information that is expressed in graph terms. */
2278 /*******************************************************************/
2280 /* dump out edges */
2281 static void dump_out_edge(ir_node *n, void *env)
2285 for (i = get_irn_n_outs(n) - 1; i >= 0; --i) {
2286 ir_node *succ = get_irn_out(n, i);
2288 print_node_edge_kind(F, succ);
2289 fprintf(F, "{sourcename: \"");
2291 fprintf(F, "\" targetname: \"");
2293 fprintf(F, "\" color: red linestyle: dashed");
2298 static inline void dump_loop_label(FILE *F, ir_loop *loop)
2300 fprintf(F, "loop %d, %d sons, %d nodes",
2301 get_loop_depth(loop), get_loop_n_sons(loop), get_loop_n_nodes(loop));
2304 static inline void dump_loop_info(FILE *F, ir_loop *loop)
2306 fprintf(F, " info1: \"");
2307 fprintf(F, " loop nr: %d", get_loop_loop_nr(loop));
2308 #ifdef DEBUG_libfirm /* GL @@@ debug analyses */
2309 fprintf(F, "\n The loop was analyzed %d times.", PTR_TO_INT(get_loop_link(loop)));
2314 static inline void dump_loop_node(FILE *F, ir_loop *loop)
2316 fprintf(F, "node: {title: \"");
2318 fprintf(F, "\" label: \"");
2319 dump_loop_label(F, loop);
2321 dump_loop_info(F, loop);
2325 static inline void dump_loop_node_edge(FILE *F, ir_loop *loop, int i)
2328 fprintf(F, "edge: {sourcename: \"");
2330 fprintf(F, "\" targetname: \"");
2331 PRINT_NODEID(get_loop_node(loop, i));
2332 fprintf(F, "\" color: green");
2336 static inline void dump_loop_son_edge(FILE *F, ir_loop *loop, int i)
2339 fprintf(F, "edge: {sourcename: \"");
2341 fprintf(F, "\" targetname: \"");
2342 PRINT_LOOPID(get_loop_son(loop, i));
2343 fprintf(F, "\" color: darkgreen label: \"%d\"}\n",
2344 get_loop_element_pos(loop, get_loop_son(loop, i)));
2347 static void dump_loops(FILE *F, ir_loop *loop)
2350 /* dump this loop node */
2351 dump_loop_node(F, loop);
2353 /* dump edges to nodes in loop -- only if it is a real loop */
2354 if (get_loop_depth(loop) != 0) {
2355 for (i = get_loop_n_nodes(loop) - 1; i >= 0; --i) {
2356 dump_loop_node_edge(F, loop, i);
2359 for (i = get_loop_n_sons(loop) - 1; i >= 0; --i) {
2360 dump_loops(F, get_loop_son(loop, i));
2361 dump_loop_son_edge(F, loop, i);
2365 static inline void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg)
2367 ir_loop *loop = get_irg_loop(irg);
2370 ir_graph *rem = current_ir_graph;
2371 current_ir_graph = irg;
2373 dump_loops(F, loop);
2375 current_ir_graph = rem;
2381 * dumps the VCG header
2383 void dump_vcg_header(FILE *F, const char *name, const char *layout, const char *orientation)
2390 label = edge_label ? "yes" : "no";
2391 if (! layout) layout = "Compilergraph";
2392 if (!orientation) orientation = "bottom_to_top";
2396 "graph: { title: \"ir graph of %s\"\n"
2397 "display_edge_labels: %s\n"
2398 "layoutalgorithm: mindepth //$ \"%s\"\n"
2399 "manhattan_edges: yes\n"
2400 "port_sharing: no\n"
2402 "classname 1: \"intrablock Data\"\n"
2403 "classname 2: \"Block\"\n"
2404 "classname 3: \"Entity type\"\n"
2405 "classname 4: \"Entity owner\"\n"
2406 "classname 5: \"Method Param\"\n"
2407 "classname 6: \"Method Res\"\n"
2408 "classname 7: \"Super\"\n"
2409 "classname 8: \"Union\"\n"
2410 "classname 9: \"Points-to\"\n"
2411 "classname 10: \"Array Element Type\"\n"
2412 "classname 11: \"Overwrites\"\n"
2413 "classname 12: \"Member\"\n"
2414 "classname 13: \"Control Flow\"\n"
2415 "classname 14: \"intrablock Memory\"\n"
2416 "classname 15: \"Dominators\"\n"
2417 "classname 16: \"interblock Data\"\n"
2418 "classname 17: \"interblock Memory\"\n"
2419 "classname 18: \"Exception Control Flow for Interval Analysis\"\n"
2420 "classname 19: \"Postdominators\"\n"
2421 "classname 20: \"Keep Alive\"\n"
2422 "classname 21: \"Out Edges\"\n"
2423 "classname 22: \"Macro Block Edges\"\n"
2424 //"classname 23: \"NoInput Nodes\"\n"
2425 "infoname 1: \"Attribute\"\n"
2426 "infoname 2: \"Verification errors\"\n"
2427 "infoname 3: \"Debug info\"\n",
2428 name, label, layout, orientation);
2430 for (i = 0; i < ird_color_count; ++i) {
2431 if (color_rgb[i] != NULL) {
2432 fprintf(F, "colorentry %s: %s\n", color_names[i], color_rgb[i]);
2435 fprintf(F, "\n"); /* a separator */
2441 * @param irg The graph to be dumped
2442 * @param suffix1 first filename suffix
2443 * @param suffix2 second filename suffix
2445 FILE *vcg_open(const ir_graph *irg, const char *suffix1, const char *suffix2)
2448 const char *nm = get_irg_dump_name(irg);
2449 int len = strlen(nm), i, j;
2450 char *fname; /* filename to put the vcg information in */
2452 if (!suffix1) suffix1 = "";
2453 if (!suffix2) suffix2 = "";
2455 /* open file for vcg graph */
2456 fname = XMALLOCN(char, len * 2 + strlen(suffix1) + strlen(suffix2) + 5);
2458 /* strncpy (fname, nm, len); */ /* copy the filename */
2460 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2462 fname[j] = '@'; j++; fname[j] = '1'; j++;
2463 } else if (nm[i] == '@') {
2464 fname[j] = '@'; j++; fname[j] = '2'; j++;
2466 fname[j] = nm[i]; j++;
2470 strcat(fname, suffix1); /* append file suffix */
2471 strcat(fname, suffix2); /* append file suffix */
2472 strcat(fname, ".vcg"); /* append the .vcg suffix */
2474 /* vcg really expect only a <CR> at end of line, so
2475 * the "b"inary mode is what you mean (and even needed for Win32)
2477 F = fopen(fname, "wb"); /* open file for writing */
2489 * @param name prefix file name
2490 * @param suffix filename suffix
2492 FILE *vcg_open_name(const char *name, const char *suffix)
2495 char *fname; /* filename to put the vcg information in */
2496 int i, j, len = strlen(name);
2498 if (!suffix) suffix = "";
2500 /** open file for vcg graph */
2501 fname = XMALLOCN(char, len * 2 + 5 + strlen(suffix));
2502 /* strcpy (fname, name);*/ /* copy the filename */
2504 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2505 if (name[i] == '/') {
2506 fname[j] = '@'; j++; fname[j] = '1'; j++;
2507 } else if (name[i] == '@') {
2508 fname[j] = '@'; j++; fname[j] = '2'; j++;
2510 fname[j] = name[i]; j++;
2514 strcat(fname, suffix);
2515 strcat(fname, ".vcg"); /* append the .vcg suffix */
2517 /* vcg really expect only a <CR> at end of line, so
2518 * the "b"inary mode is what you mean (and even needed for Win32)
2520 F = fopen(fname, "wb"); /* open file for writing */
2530 * Dumps the vcg file footer
2532 void dump_vcg_footer(FILE *F)
2537 /************************************************************************/
2538 /************************************************************************/
2539 /* Routines that dump all or parts of the firm representation to a file */
2540 /************************************************************************/
2541 /************************************************************************/
2543 /************************************************************************/
2544 /* Dump ir graphs, different formats and additional information. */
2545 /************************************************************************/
2547 typedef void (*do_dump_graph_func) (ir_graph *irg, FILE *out);
2549 static void do_dump(ir_graph *irg, const char *suffix, const char *suffix_ip,
2550 const char *suffix_nonip, do_dump_graph_func dump_func)
2554 const char *suffix1;
2556 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2559 rem = current_ir_graph;
2560 current_ir_graph = irg;
2562 #ifdef INTERPROCEDURAL_VIEW
2563 if (get_interprocedural_view())
2564 suffix1 = suffix_ip;
2567 suffix1 = suffix_nonip;
2568 current_ir_graph = rem;
2570 out = vcg_open(irg, suffix, suffix1);
2572 dump_func(irg, out);
2577 void dump_ir_graph_file(ir_graph *irg, FILE *out)
2579 if (dump_backedge_information_flag
2580 && get_irg_loopinfo_state(irg) != loopinfo_consistent) {
2581 construct_backedges(irg);
2584 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2586 /* call the dump graph hook */
2587 if (dump_ir_graph_hook) {
2588 if (dump_ir_graph_hook(out, irg)) {
2593 /* walk over the graph */
2594 /* dump_whole_node must be called in post visiting predecessors */
2595 ird_walk_graph(irg, NULL, dump_whole_node, out);
2597 /* dump the out edges in a separate walk */
2598 if ((dump_out_edge_flag) && (get_irg_outs_state(irg) != outs_none)) {
2599 irg_out_walk(get_irg_start(irg), dump_out_edge, NULL, out);
2602 dump_vcg_footer(out);
2605 /** Routine to dump a graph, blocks as conventional nodes. */
2606 void dump_ir_graph(ir_graph *irg, const char *suffix )
2608 do_dump(irg, suffix, "-pure-ip", "-pure", dump_ir_graph_file);
2611 void dump_ir_block_graph_file(ir_graph *irg, FILE *out)
2615 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2617 construct_block_lists(irg);
2620 * If we are in the interprocedural view, we dump not
2621 * only the requested irg but also all irgs that can be reached
2624 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2625 ir_graph *g = get_irp_irg(i);
2626 ir_node **arr = ird_get_irg_link(g);
2628 dump_graph_from_list(out, g);
2633 dump_vcg_footer(out);
2636 /* Dump a firm graph without explicit block nodes. */
2637 void dump_ir_block_graph(ir_graph *irg, const char *suffix)
2639 do_dump(irg, suffix, "-ip", "", dump_ir_block_graph_file);
2642 void dump_ir_extblock_graph_file(ir_graph *irg, FILE *F)
2645 ir_entity *ent = get_irg_entity(irg);
2647 if (get_irg_extblk_state(irg) != extblk_valid)
2650 dump_vcg_header(F, get_irg_dump_name(irg), NULL, NULL);
2652 construct_extblock_lists(irg);
2654 fprintf(F, "graph: { title: \"");
2656 fprintf(F, "\" label: \"%s\" status:clustered color: white \n",
2657 get_ent_dump_name(ent));
2659 dump_graph_info(F, irg);
2660 print_dbg_info(F, get_entity_dbg_info(ent));
2662 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2663 ir_graph *irg = get_irp_irg(i);
2664 list_tuple *lists = ird_get_irg_link(irg);
2667 /* dump the extended blocks first */
2668 if (ARR_LEN(lists->extbb_list)) {
2669 ird_set_irg_link(irg, lists->extbb_list);
2670 dump_extblock_graph(F, irg);
2673 /* we may have blocks without extended blocks, bad for instance */
2674 if (ARR_LEN(lists->blk_list)) {
2675 ird_set_irg_link(irg, lists->blk_list);
2676 dump_block_graph(F, irg);
2679 DEL_ARR_F(lists->extbb_list);
2680 DEL_ARR_F(lists->blk_list);
2685 /* Close the vcg information for the irg */
2686 fprintf(F, "}\n\n");
2692 /* Dump a firm graph without explicit block nodes but grouped in extended blocks. */
2693 void dump_ir_extblock_graph(ir_graph *irg, const char *suffix)
2695 do_dump(irg, suffix, "-ip", "", dump_ir_extblock_graph_file);
2698 void dump_ir_graph_w_types_file(ir_graph *irg, FILE *out)
2700 ir_graph *rem = current_ir_graph;
2701 int rem_dump_const_local;
2703 rem = current_ir_graph;
2704 current_ir_graph = irg;
2705 rem_dump_const_local = dump_const_local;
2706 /* dumping types does not work with local nodes */
2707 dump_const_local = 0;
2709 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2711 /* dump common ir graph */
2712 irg_walk(get_irg_end(irg), NULL, dump_whole_node, out);
2713 /* dump type info */
2714 type_walk_irg(irg, dump_type_info, NULL, out);
2715 inc_irg_visited(get_const_code_irg());
2716 /* dump edges from graph to type info */
2717 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2719 dump_vcg_footer(out);
2720 dump_const_local = rem_dump_const_local;
2721 current_ir_graph = rem;
2724 /* dumps a graph with type information */
2725 void dump_ir_graph_w_types(ir_graph *irg, const char *suffix)
2727 do_dump(irg, suffix, "-pure-wtypes-ip", "-pure-wtypes",
2728 dump_ir_graph_w_types_file);
2731 void dump_ir_block_graph_w_types_file(ir_graph *irg, FILE *out)
2734 int rem_dump_const_local;
2735 ir_graph *rem = current_ir_graph;
2737 rem_dump_const_local = dump_const_local;
2738 /* dumping types does not work with local nodes */
2739 dump_const_local = 0;
2741 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2743 /* dump common blocked ir graph */
2744 construct_block_lists(irg);
2746 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2747 ir_node **arr = ird_get_irg_link(get_irp_irg(i));
2749 dump_graph_from_list(out, get_irp_irg(i));
2754 /* dump type info */
2755 current_ir_graph = irg;
2756 type_walk_irg(irg, dump_type_info, NULL, out);
2757 inc_irg_visited(get_const_code_irg());
2759 /* dump edges from graph to type info */
2760 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2762 dump_vcg_footer(out);
2763 dump_const_local = rem_dump_const_local;
2764 current_ir_graph = rem;
2767 void dump_ir_block_graph_w_types(ir_graph *irg, const char *suffix)
2769 do_dump(irg, suffix, "-wtypes-ip", "-wtypes",
2770 dump_ir_block_graph_w_types_file);
2773 /*---------------------------------------------------------------------*/
2774 /* The following routines dump a control flow graph. */
2775 /*---------------------------------------------------------------------*/
2777 static void dump_block_to_cfg(ir_node *block, void *env)
2783 if (is_Block(block)) {
2784 /* This is a block. Dump a node for the block. */
2785 fprintf(F, "node: {title: \""); PRINT_NODEID(block);
2786 fprintf(F, "\" label: \"");
2787 if (block == get_irg_start_block(get_irn_irg(block)))
2788 fprintf(F, "Start ");
2789 if (block == get_irg_end_block(get_irn_irg(block)))
2792 fprintf(F, "%s ", get_op_name(get_irn_op(block)));
2793 PRINT_NODEID(block);
2795 fprintf(F, "info1:\"");
2797 /* the generic version. */
2798 dump_irnode_to_file(F, block);
2800 /* Check whether we have bad predecessors to color the block. */
2801 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
2802 if ((fl = is_Bad(get_Block_cfgpred(block, i))))
2805 fprintf(F, "\""); /* closing quote of info */
2807 if ((block == get_irg_start_block(get_irn_irg(block))) ||
2808 (block == get_irg_end_block(get_irn_irg(block))) )
2809 fprintf(F, " color:blue ");
2811 fprintf(F, " color:yellow ");
2814 /* Dump the edges */
2815 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
2816 if (!is_Bad(skip_Proj(get_Block_cfgpred(block, i)))) {
2817 pred = get_nodes_block(skip_Proj(get_Block_cfgpred(block, i)));
2818 fprintf(F, "edge: { sourcename: \"");
2819 PRINT_NODEID(block);
2820 fprintf(F, "\" targetname: \"");
2822 fprintf(F, "\"}\n");
2825 /* Dump dominator/postdominator edge */
2826 if (dump_dominator_information_flag) {
2827 if (get_irg_dom_state(current_ir_graph) == dom_consistent && get_Block_idom(block)) {
2828 pred = get_Block_idom(block);
2829 fprintf(F, "edge: { sourcename: \"");
2830 PRINT_NODEID(block);
2831 fprintf(F, "\" targetname: \"");
2833 fprintf(F, "\" " DOMINATOR_EDGE_ATTR "}\n");
2835 if (get_irg_postdom_state(current_ir_graph) == dom_consistent && get_Block_ipostdom(block)) {
2836 pred = get_Block_ipostdom(block);
2837 fprintf(F, "edge: { sourcename: \"");
2838 PRINT_NODEID(block);
2839 fprintf(F, "\" targetname: \"");
2841 fprintf(F, "\" " POSTDOMINATOR_EDGE_ATTR "}\n");
2847 void dump_cfg(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))))
2854 f = vcg_open(irg, suffix, "-cfg");
2856 ir_graph *rem = current_ir_graph;
2857 #ifdef INTERPROCEDURAL_VIEW
2858 int ipv = get_interprocedural_view();
2861 current_ir_graph = irg;
2862 dump_vcg_header(f, get_irg_dump_name(irg), NULL, NULL);
2864 #ifdef INTERPROCEDURAL_VIEW
2866 printf("Warning: dumping cfg not in interprocedural view!\n");
2867 set_interprocedural_view(0);
2871 /* walk over the blocks in the graph */
2872 irg_block_walk(get_irg_end(irg), dump_block_to_cfg, NULL, f);
2873 dump_node(f, get_irg_bad(irg));
2875 #ifdef INTERPROCEDURAL_VIEW
2876 set_interprocedural_view(ipv);
2880 current_ir_graph = rem;
2885 static void descend_and_dump(FILE *F, ir_node *n, int depth, pset *mark_set)
2887 if (pset_find_ptr(mark_set, n))
2890 pset_insert_ptr(mark_set, n);
2893 int i, start = is_Block(n) ? 0 : -1;
2894 dump_whole_node(n, F);
2895 for (i = start; i < get_irn_arity(n); ++i)
2896 descend_and_dump(F, get_irn_n(n, i), depth-1, mark_set);
2899 /* Don't dump edges to nodes further out. These might be edges to
2900 nodes we already dumped, if there is a shorter path to these. */
2904 static int subgraph_counter = 0;
2905 void dump_subgraph(ir_node *root, int depth, const char *suffix)
2910 sprintf(buf, "-subg_%03d", subgraph_counter++);
2911 F = vcg_open(get_irn_irg(root), suffix, buf);
2913 pset *mark_set = pset_new_ptr(1);
2914 dump_vcg_header(F, get_irg_dump_name(get_irn_irg(root)), NULL, NULL);
2915 descend_and_dump(F, root, depth, mark_set);
2922 void dump_callgraph(const char *suffix)
2924 FILE *F = vcg_open_name("Callgraph", suffix);
2927 int i, rem = edge_label;
2930 dump_vcg_header(F, "Callgraph", "Hierarchiv", NULL);
2932 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2933 ir_graph *irg = get_irp_irg(i);
2934 ir_entity *ent = get_irg_entity(irg);
2936 int n_callees = get_irg_n_callees(irg);
2938 dump_entity_node(F, ent);
2939 for (j = 0; j < n_callees; ++j) {
2940 ir_entity *c = get_irg_entity(get_irg_callee(irg, j));
2941 //if (id_is_prefix(prefix, get_entity_ld_ident(c))) continue;
2942 int be = is_irg_callee_backedge(irg, j);
2945 "label:\"recursion %d\"" :
2946 "label:\"calls %d\"";
2947 print_ent_ent_edge(F, ent, c, be, ird_color_entity, attr, get_irg_callee_loop_depth(irg, j));
2958 /* Dump all irgs in interprocedural view to a single file. */
2959 void dump_all_cg_block_graph(const char *suffix)
2961 FILE *f = vcg_open_name("All_graphs", suffix);
2965 int rem_view = get_interprocedural_view();
2967 set_interprocedural_view(1);
2968 dump_vcg_header(f, "All_graphs", NULL);
2970 /* collect nodes in all irgs reachable in call graph*/
2971 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2972 ird_set_irg_link(get_irp_irg(i), NULL);
2974 cg_walk(clear_link, collect_node, NULL);
2976 /* dump all graphs */
2977 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2978 current_ir_graph = get_irp_irg(i);
2979 assert(ird_get_irg_link(current_ir_graph));
2980 dump_graph_from_list(f, current_ir_graph);
2981 DEL_ARR_F(ird_get_irg_link(current_ir_graph));
2986 set_interprocedural_view(rem_view);
2991 /*---------------------------------------------------------------------*/
2992 /* the following routines dumps type information without any ir nodes. */
2993 /*---------------------------------------------------------------------*/
2995 void dump_type_graph(ir_graph *irg, const char *suffix)
2999 /* if a filter is set, dump only the irg's that match the filter */
3000 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
3002 f = vcg_open(irg, suffix, "-type");
3004 ir_graph *rem = current_ir_graph;
3005 current_ir_graph = irg;
3007 dump_vcg_header(f, get_irg_dump_name(irg), "Hierarchic", NULL);
3009 /* walk over the blocks in the graph */
3010 type_walk_irg(irg, dump_type_info, NULL, f);
3011 /* The walker for the const code can be called several times for the
3012 same (sub) expression. So that no nodes are dumped several times
3013 we decrease the visited flag of the corresponding graph after each
3014 walk. So now increase it finally. */
3015 inc_irg_visited(get_const_code_irg());
3019 current_ir_graph = rem;
3023 void dump_all_types(const char *suffix)
3025 FILE *f = vcg_open_name("All_types", suffix);
3027 dump_vcg_header(f, "All_types", "Hierarchic", NULL);
3028 type_walk(dump_type_info, NULL, f);
3029 inc_irg_visited(get_const_code_irg());
3036 void dump_class_hierarchy(int entities, const char *suffix)
3038 FILE *f = vcg_open_name("class_hierarchy", suffix);
3043 env.dump_ent = entities;
3044 dump_vcg_header(f, "class_hierarchy", "Hierarchic", NULL);
3045 type_walk(dump_class_hierarchy_node, NULL, &env);
3052 /*---------------------------------------------------------------------*/
3053 /* dumps all graphs with the graph-dumper passed. Possible dumpers: */
3055 /* dump_ir_block_graph */
3057 /* dump_type_graph */
3058 /* dump_ir_graph_w_types */
3059 /*---------------------------------------------------------------------*/
3061 void dump_all_ir_graphs(dump_graph_func *dmp_grph, const char *suffix)
3064 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
3065 dmp_grph(get_irp_irg(i), suffix);
3069 ir_prog_pass_t pass;
3070 dump_graph_func *dump_graph;
3075 * Wrapper around dump_all_ir_graphs().
3077 static int dump_all_ir_graphs_wrapper(ir_prog *irp, void *context)
3079 struct pass_t *pass = context;
3082 dump_all_ir_graphs(pass->dump_graph, pass->suffix);
3086 ir_prog_pass_t *dump_all_ir_graph_pass(const char *name,
3087 dump_graph_func *dump_graph,
3090 size_t len = strlen(suffix);
3091 struct pass_t *pass = xmalloc(sizeof(*pass) + len);
3092 ir_prog_pass_t *res = def_prog_pass_constructor(
3093 &pass->pass, name ? name : "dump_all_graphs", dump_all_ir_graphs_wrapper);
3095 /* this pass does not change anything, so neither dump nor verify is needed. */
3096 res->dump_irprog = ir_prog_no_dump;
3097 res->verify_irprog = ir_prog_no_verify;
3099 pass->dump_graph = dump_graph;
3100 strcpy(pass->suffix, suffix);
3105 /*--------------------------------------------------------------------------------*
3106 * Dumps a stand alone loop graph with firm nodes which belong to one loop node *
3107 * packed together in one subgraph/box *
3108 *--------------------------------------------------------------------------------*/
3110 static void dump_loops_standalone(FILE *F, ir_loop *loop)
3112 int i = 0, loop_node_started = 0, son_number = 0, first = 0;
3114 ir_loop *son = NULL;
3116 /* Dump a new loop node. */
3117 dump_loop_node(F, loop);
3119 /* Dump the loop elements. */
3120 for (i = 0; i < get_loop_n_elements(loop); i++) {
3121 le = get_loop_element(loop, i);
3123 if (get_kind(son) == k_ir_loop) {
3125 /* We are a loop son -> Recurse */
3127 if (loop_node_started) { /* Close the "firm-nodes" node first if we started one. */
3128 fprintf(F, "\" }\n");
3129 fprintf(F, "edge: {sourcename: \"");
3131 fprintf(F, "\" targetname: \"");
3133 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3134 loop_node_started = 0;
3136 dump_loop_son_edge(F, loop, son_number++);
3137 dump_loops_standalone(F, son);
3138 } else if (get_kind(son) == k_ir_node) {
3139 /* We are a loop node -> Collect firm nodes */
3141 ir_node *n = le.node;
3144 if (!loop_node_started) {
3145 /* Start a new node which contains all firm nodes of the current loop */
3146 fprintf(F, "node: { title: \"");
3148 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3149 loop_node_started = 1;
3154 bad |= dump_node_label(F, n);
3155 /* Causes indeterministic output: if (is_Block(n)) fprintf(F, "\t ->%d", (int)get_irn_link(n)); */
3156 if (has_backedges(n)) fprintf(F, "\t loop head!");
3157 } else { /* for callgraph loop tree */
3159 assert(get_kind(son) == k_ir_graph);
3161 /* We are a loop node -> Collect firm graphs */
3163 if (!loop_node_started) {
3164 /* Start a new node which contains all firm nodes of the current loop */
3165 fprintf(F, "node: { title: \"");
3167 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3168 loop_node_started = 1;
3172 fprintf(F, " %s", get_irg_dump_name(n));
3173 /* fprintf(F, " %s (depth %d)", get_irg_dump_name(n), n->callgraph_weighted_loop_depth); */
3177 if (loop_node_started) {
3178 fprintf(F, "\" }\n");
3179 fprintf(F, "edge: {sourcename: \"");
3181 fprintf(F, "\" targetname: \"");
3183 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3184 loop_node_started = 0;
3188 void dump_loop_tree(ir_graph *irg, const char *suffix)
3192 /* if a filter is set, dump only the irg's that match the filter */
3193 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
3196 f = vcg_open(irg, suffix, "-looptree");
3198 ir_graph *rem = current_ir_graph;
3199 int el_rem = edge_label;
3201 current_ir_graph = irg;
3204 dump_vcg_header(f, get_irg_dump_name(irg), "Tree", "top_to_bottom");
3206 if (get_irg_loop(irg))
3207 dump_loops_standalone(f, get_irg_loop(irg));
3212 edge_label = el_rem;
3213 current_ir_graph = rem;
3217 void dump_callgraph_loop_tree(const char *suffix)
3220 F = vcg_open_name("Callgraph_looptree", suffix);
3221 dump_vcg_header(F, "callgraph looptree", "Tree", "top_to_bottom");
3222 dump_loops_standalone(F, irp->outermost_cg_loop);
3228 /*----------------------------------------------------------------------------*/
3229 /* Dumps the firm nodes in the loop tree to a graph along with the loop nodes.*/
3230 /*----------------------------------------------------------------------------*/
3232 static void collect_nodeloop(FILE *F, ir_loop *loop, eset *loopnodes)
3234 int i, son_number = 0, node_number = 0;
3236 if (dump_loop_information_flag) dump_loop_node(F, loop);
3238 for (i = 0; i < get_loop_n_elements(loop); i++) {
3239 loop_element le = get_loop_element(loop, i);
3240 if (*(le.kind) == k_ir_loop) {
3241 if (dump_loop_information_flag) dump_loop_son_edge(F, loop, son_number++);
3243 collect_nodeloop(F, le.son, loopnodes);
3245 if (dump_loop_information_flag) dump_loop_node_edge(F, loop, node_number++);
3246 eset_insert(loopnodes, le.node);
3251 static void collect_nodeloop_external_nodes(ir_loop *loop, eset *loopnodes,
3256 for (i = 0; i < get_loop_n_elements(loop); i++) {
3257 loop_element le = get_loop_element(loop, i);
3258 if (*(le.kind) == k_ir_loop) {
3260 collect_nodeloop_external_nodes(le.son, loopnodes, extnodes);
3262 if (is_Block(le.node)) start = 0; else start = -1;
3263 for (j = start; j < get_irn_arity(le.node); j++) {
3264 ir_node *pred = get_irn_n(le.node, j);
3265 if (!eset_contains(loopnodes, pred)) {
3266 eset_insert(extnodes, pred);
3267 if (!is_Block(pred)) {
3268 pred = get_nodes_block(pred);
3269 if (!eset_contains(loopnodes, pred)) eset_insert(extnodes, pred);
3277 void dump_loop(ir_loop *l, const char *suffix)
3282 snprintf(name, sizeof(name), "loop_%d", get_loop_loop_nr(l));
3283 F = vcg_open_name(name, suffix);
3285 eset *loopnodes = eset_create();
3286 eset *extnodes = eset_create();
3289 dump_vcg_header(F, name, NULL, NULL);
3291 /* collect all nodes to dump */
3292 collect_nodeloop(F, l, loopnodes);
3293 collect_nodeloop_external_nodes(l, loopnodes, extnodes);
3295 /* build block lists */
3296 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes))
3297 set_irn_link(n, NULL);
3298 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes))
3299 set_irn_link(n, NULL);
3300 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes)) {
3302 b = get_nodes_block(n);
3303 set_irn_link(n, get_irn_link(b));
3307 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes)) {
3309 b = get_nodes_block(n);
3310 set_irn_link(n, get_irn_link(b));
3315 for (b = eset_first(loopnodes); b != NULL; b = eset_next(loopnodes)) {
3317 fprintf(F, "graph: { title: \"");
3319 fprintf(F, "\" label: \"");
3320 dump_node_opcode(F, b);
3321 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3322 fprintf(F, "\" status:clustered color:yellow\n");
3324 /* dump the blocks edges */
3325 dump_ir_data_edges(F, b);
3327 /* dump the nodes that go into the block */
3328 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3329 if (eset_contains(extnodes, n))
3330 overrule_nodecolor = ird_color_block_inout;
3332 overrule_nodecolor = ird_color_default_node;
3333 if (!eset_contains(extnodes, n)) dump_ir_data_edges(F, n);
3336 /* Close the vcg information for the block */
3338 dump_const_node_local(F, b);
3342 for (b = eset_first(extnodes); b != NULL; b = eset_next(extnodes)) {
3344 fprintf(F, "graph: { title: \"");
3346 fprintf(F, "\" label: \"");
3347 dump_node_opcode(F, b);
3348 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3349 fprintf(F, "\" status:clustered color:lightblue\n");
3351 /* dump the nodes that go into the block */
3352 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3353 if (!eset_contains(loopnodes, n))
3354 overrule_nodecolor = ird_color_block_inout;
3356 overrule_nodecolor = ird_color_default_node;
3357 if (eset_contains(loopnodes, n)) dump_ir_data_edges(F, n);
3360 /* Close the vcg information for the block */
3362 dump_const_node_local(F, b);
3366 eset_destroy(loopnodes);
3367 eset_destroy(extnodes);