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)));
808 if (!get_interprocedural_view())
815 ir_node *pred = get_Proj_pred(n);
817 if (get_irn_opcode(pred) == iro_Cond
818 && get_Proj_proj(n) == get_Cond_default_proj(pred)
819 && get_irn_mode(get_Cond_selector(pred)) != mode_b)
820 fprintf(F, "defProj");
828 if (get_interprocedural_view()) {
829 fprintf(F, "%s %s", get_irn_opname(n), get_ent_dump_name(get_irg_entity(get_irn_irg(n))));
834 case iro_CallBegin: {
835 ir_node *addr = get_CallBegin_ptr(n);
836 ir_entity *ent = NULL;
838 ent = get_Sel_entity(addr);
839 else if (is_Global(addr))
840 ent = get_Global_entity(addr);
841 fprintf(F, "%s", get_irn_opname(n));
842 if (ent) fprintf(F, " %s", get_entity_name(ent));
846 if (get_Load_align(n) == align_non_aligned)
848 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Load_mode(n), &bad));
851 if (get_Store_align(n) == align_non_aligned)
853 fprintf(F, "%s", get_irn_opname(n));
857 is_Block_dead(n) ? "Dead " : "", get_irn_opname(n),
858 dump_block_marker ? (get_Block_mark(n) ? "*" : "") : "");
861 if (get_Conv_strict(n))
862 fprintf(F, "strict");
863 fprintf(F, "%s", get_irn_opname(n));
866 fprintf(F, "%s", get_irn_opname(n));
867 if (get_Div_no_remainder(n))
869 fprintf(F, "[%s]", get_mode_name_ex(get_Div_resmode(n), &bad));
872 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Mod_resmode(n), &bad));
875 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_DivMod_resmode(n), &bad));
878 fprintf(F, "%s[%s]", get_irn_opname(n), get_builtin_kind_name(get_Builtin_kind(n)));
883 fprintf(F, "%s", get_irn_opname(n));
890 * Dump the mode of a node n to a file F.
891 * Ignore modes that are "always known".
893 static int dump_node_mode(FILE *F, ir_node *n)
896 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
900 /* call the dump_node operation if available */
902 return ops->dump_node(n, F, dump_node_mode_txt);
904 /* default implementation */
905 iro = get_irn_opcode(n);
917 mode = get_irn_mode(n);
919 if (mode != NULL && mode != mode_BB && mode != mode_ANY && mode != mode_BAD &&
920 (mode != mode_T || iro == iro_Proj))
921 fprintf(F, "%s", get_mode_name_ex(mode, &bad));
927 * Dump the type of a node n to a file F if it's known.
929 static int dump_node_typeinfo(FILE *F, ir_node *n)
933 if (opt_dump_analysed_type_info) {
934 if (get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_consistent ||
935 get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_inconsistent) {
936 ir_type *tp = get_irn_typeinfo_type(n);
937 if (tp != firm_none_type) {
938 ir_fprintf(F, "[%+F]", tp);
947 typedef struct _pns_lookup {
948 long nr; /**< the proj number */
949 const char *name; /**< the name of the Proj */
952 typedef struct _proj_lookup {
953 ir_opcode code; /**< the opcode of the Proj predecessor */
954 unsigned num_data; /**< number of data entries */
955 const pns_lookup_t *data; /**< the data */
958 #define ARR_SIZE(a) (sizeof(a)/sizeof(a[0]))
960 /** the lookup table for Proj(Start) names */
961 static const pns_lookup_t start_lut[] = {
962 #define X(a) { pn_Start_##a, #a }
970 /** the lookup table for Proj(Cond) names */
971 static const pns_lookup_t cond_lut[] = {
972 #define X(a) { pn_Cond_##a, #a }
978 /** the lookup table for Proj(Call) names */
979 static const pns_lookup_t call_lut[] = {
980 #define X(a) { pn_Call_##a, #a }
989 /** the lookup table for Proj(Quot) names */
990 static const pns_lookup_t quot_lut[] = {
991 #define X(a) { pn_Quot_##a, #a }
999 /** the lookup table for Proj(DivMod) names */
1000 static const pns_lookup_t divmod_lut[] = {
1001 #define X(a) { pn_DivMod_##a, #a }
1010 /** the lookup table for Proj(Div) names */
1011 static const pns_lookup_t div_lut[] = {
1012 #define X(a) { pn_Div_##a, #a }
1020 /** the lookup table for Proj(Mod) names */
1021 static const pns_lookup_t mod_lut[] = {
1022 #define X(a) { pn_Mod_##a, #a }
1030 /** the lookup table for Proj(Load) names */
1031 static const pns_lookup_t load_lut[] = {
1032 #define X(a) { pn_Load_##a, #a }
1040 /** the lookup table for Proj(Store) names */
1041 static const pns_lookup_t store_lut[] = {
1042 #define X(a) { pn_Store_##a, #a }
1049 /** the lookup table for Proj(Alloc) names */
1050 static const pns_lookup_t alloc_lut[] = {
1051 #define X(a) { pn_Alloc_##a, #a }
1059 /** the lookup table for Proj(CopyB) names */
1060 static const pns_lookup_t copyb_lut[] = {
1061 #define X(a) { pn_CopyB_##a, #a }
1068 /** the lookup table for Proj(InstOf) names */
1069 static const pns_lookup_t instof_lut[] = {
1070 #define X(a) { pn_InstOf_##a, #a }
1078 /** the lookup table for Proj(Raise) names */
1079 static const pns_lookup_t raise_lut[] = {
1080 #define X(a) { pn_Raise_##a, #a }
1086 /** the lookup table for Proj(Bound) names */
1087 static const pns_lookup_t bound_lut[] = {
1088 #define X(a) { pn_Bound_##a, #a }
1096 /** the Proj lookup table */
1097 static const proj_lookup_t proj_lut[] = {
1098 #define E(a) ARR_SIZE(a), a
1099 { iro_Start, E(start_lut) },
1100 { iro_Cond, E(cond_lut) },
1101 { iro_Call, E(call_lut) },
1102 { iro_Quot, E(quot_lut) },
1103 { iro_DivMod, E(divmod_lut) },
1104 { iro_Div, E(div_lut) },
1105 { iro_Mod, E(mod_lut) },
1106 { iro_Load, E(load_lut) },
1107 { iro_Store, E(store_lut) },
1108 { iro_Alloc, E(alloc_lut) },
1109 { iro_CopyB, E(copyb_lut) },
1110 { iro_InstOf, E(instof_lut) },
1111 { iro_Raise, E(raise_lut) },
1112 { iro_Bound, E(bound_lut) }
1117 * Dump additional node attributes of some nodes to a file F.
1119 static int dump_node_nodeattr(FILE *F, ir_node *n)
1125 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1127 /* call the dump_node operation if available */
1129 return ops->dump_node(n, F, dump_node_nodeattr_txt);
1131 switch (get_irn_opcode(n)) {
1133 if (0 && get_interprocedural_view()) {
1134 fprintf(F, "%s ", get_ent_dump_name(get_irg_entity(current_ir_graph)));
1139 ir_fprintf(F, "%T ", get_Const_tarval(n));
1143 pred = get_Proj_pred(n);
1144 proj_nr = get_Proj_proj(n);
1146 code = get_irn_opcode(pred);
1148 if (code == iro_Cmp)
1149 fprintf(F, "%s ", get_pnc_string(get_Proj_proj(n)));
1150 else if (code == iro_Proj && get_irn_opcode(get_Proj_pred(pred)) == iro_Start)
1151 fprintf(F, "Arg %ld ", proj_nr);
1152 else if (code == iro_Cond && get_irn_mode(get_Cond_selector(pred)) != mode_b)
1153 fprintf(F, "%ld ", proj_nr);
1155 unsigned i, j, f = 0;
1157 for (i = 0; i < ARR_SIZE(proj_lut); ++i) {
1158 if (code == proj_lut[i].code) {
1159 for (j = 0; j < proj_lut[i].num_data; ++j) {
1160 if (proj_nr == proj_lut[i].data[j].nr) {
1161 fprintf(F, "%s ", proj_lut[i].data[j].name);
1170 fprintf(F, "%ld ", proj_nr);
1171 if (code == iro_Cond && get_Cond_jmp_pred(pred) != COND_JMP_PRED_NONE) {
1172 if (proj_nr == pn_Cond_false && get_Cond_jmp_pred(pred) == COND_JMP_PRED_FALSE)
1173 fprintf(F, "PRED ");
1174 if (proj_nr == pn_Cond_true && get_Cond_jmp_pred(pred) == COND_JMP_PRED_TRUE)
1175 fprintf(F, "PRED ");
1180 proj_nr = get_Filter_proj(n);
1181 if (! get_interprocedural_view()) {
1183 pred = get_Filter_pred(n);
1186 fprintf(F, "%ld ", proj_nr);
1189 fprintf(F, "%s ", get_ent_dump_name(get_Sel_entity(n)));
1192 ir_fprintf(F, "(%+F)", get_Cast_type(n));
1195 fprintf(F, "%s ", get_pnc_string(get_Confirm_cmp(n)));
1198 ir_fprintf(F, "(%+F)", get_CopyB_type(n));
1209 #include "execution_frequency.h"
1211 static void dump_node_ana_vals(FILE *F, ir_node *n)
1216 #ifdef INTERPROCEDURAL_VIEW
1217 fprintf(F, " %lf*(%2.0lf + %2.0lf) = %2.0lf ",
1218 get_irn_exec_freq(n),
1219 get_irg_method_execution_frequency(get_irn_irg(n)),
1220 pow(5, get_irg_recursion_depth(get_irn_irg(n))),
1221 get_irn_exec_freq(n) * (get_irg_method_execution_frequency(get_irn_irg(n)) + pow(5, get_irg_recursion_depth(get_irn_irg(n))))
1227 /* Dumps a node label without the enclosing ". */
1228 int dump_node_label(FILE *F, ir_node *n)
1232 bad |= dump_node_opcode(F, n);
1234 bad |= dump_node_mode(F, n);
1236 bad |= dump_node_typeinfo(F, n);
1237 bad |= dump_node_nodeattr(F, n);
1238 if (dump_node_idx_labels) {
1239 fprintf(F, "%ld:%d", get_irn_node_nr(n), get_irn_idx(n));
1241 fprintf(F, "%ld", get_irn_node_nr(n));
1247 /* Dumps the vrp information of a node to a file */
1248 int dump_vrp_info(FILE *F, ir_node *n)
1250 if (!n->vrp.valid) {
1254 fprintf(F, "range_type: %d\n", n->vrp.range_type);
1255 if (n->vrp.range_type == VRP_RANGE || n->vrp.range_type ==
1257 ir_fprintf(F, "range_bottom: %F\n",n->vrp.range_bottom);
1258 ir_fprintf(F, "range_top: %F\n", n->vrp.range_top);
1260 ir_fprintf(F, "bits_set: %T\n", n->vrp.bits_set);
1261 ir_fprintf(F, "bits_not_set: %T\n", n->vrp.bits_not_set);
1262 if (n->vrp.bits_node == NULL) {
1263 fprintf(F, "bits_node: None");
1265 fprintf(F, "bits_node: #%ld\n", get_irn_node_nr(n->vrp.bits_node));
1272 * Dumps the attributes of a node n into the file F.
1273 * Currently this is only the color of a node.
1275 static void dump_node_vcgattr(FILE *F, ir_node *node, ir_node *local, int bad)
1281 print_vcg_color(F, ird_color_error);
1285 if (dump_node_vcgattr_hook)
1286 if (dump_node_vcgattr_hook(F, node, local))
1289 n = local ? local : node;
1291 if (overrule_nodecolor != ird_color_default_node) {
1292 print_vcg_color(F, overrule_nodecolor);
1296 mode = get_irn_mode(n);
1297 if (mode == mode_M) {
1298 print_vcg_color(F, ird_color_memory);
1301 if (mode == mode_X) {
1302 print_vcg_color(F, ird_color_controlflow);
1306 switch (get_irn_opcode(n)) {
1311 print_vcg_color(F, ird_color_anchor);
1314 print_vcg_color(F, ird_color_error);
1317 if (is_Block_dead(n))
1318 print_vcg_color(F, ird_color_dead_block_background);
1320 print_vcg_color(F, ird_color_block_background);
1323 print_vcg_color(F, ird_color_phi);
1326 print_vcg_color(F, ird_color_memory);
1330 print_vcg_color(F, ird_color_const);
1333 print_vcg_color(F, ird_color_proj);
1336 ir_op *op = get_irn_op(node);
1338 if (is_op_constlike(op)) {
1339 print_vcg_color(F, ird_color_const);
1340 } else if (is_op_uses_memory(op)) {
1341 print_vcg_color(F, ird_color_uses_memory);
1342 } else if (is_op_cfopcode(op) || is_op_forking(op)) {
1343 print_vcg_color(F, ird_color_controlflow);
1345 PRINT_DEFAULT_NODE_ATTR;
1351 /* Adds a new node info dumper callback. */
1352 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data)
1354 hook_entry_t *info = XMALLOC(hook_entry_t);
1356 info->hook._hook_node_info = cb;
1357 info->context = data;
1358 register_hook(hook_node_info, info);
1363 /* Remove a previously added info dumper callback. */
1364 void dump_remv_node_info_callback(void *handle)
1366 hook_entry_t *info = handle;
1367 unregister_hook(hook_node_info, info);
1372 * Dump the node information of a node n to a file F.
1374 static inline int dump_node_info(FILE *F, ir_node *n)
1377 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1379 fprintf(F, " info1: \"");
1380 bad = dump_irnode_to_file(F, n);
1381 /* call the dump_node operation if available */
1383 bad = ops->dump_node(n, F, dump_node_info_txt);
1385 /* allow additional info to be added */
1386 hook_node_info(F, n);
1392 static inline int is_constlike_node(const ir_node *node)
1394 const ir_op *op = get_irn_op(node);
1395 return is_op_constlike(op);
1399 /** outputs the predecessors of n, that are constants, local. I.e.,
1400 generates a copy of the constant predecessors for each node called with. */
1401 static void dump_const_node_local(FILE *F, ir_node *n)
1404 if (!get_opt_dump_const_local()) return;
1406 /* Use visited flag to avoid outputting nodes twice.
1407 initialize it first. */
1408 for (i = 0; i < get_irn_arity(n); i++) {
1409 ir_node *con = get_irn_n(n, i);
1410 if (is_constlike_node(con)) {
1411 set_irn_visited(con, get_irg_visited(current_ir_graph) - 1);
1415 for (i = 0; i < get_irn_arity(n); i++) {
1416 ir_node *con = get_irn_n(n, i);
1417 if (is_constlike_node(con) && !irn_visited(con)) {
1420 mark_irn_visited(con);
1421 /* Generate a new name for the node by appending the names of
1423 fprintf(F, "node: {title: "); PRINT_CONSTID(n, con);
1424 fprintf(F, " label: \"");
1425 bad |= dump_node_label(F, con);
1427 bad |= dump_node_info(F, con);
1428 dump_node_vcgattr(F, n, con, bad);
1434 /** If the block of an edge is a const_like node, dump it local with an edge */
1435 static void dump_const_block_local(FILE *F, ir_node *n)
1439 if (!get_opt_dump_const_local()) return;
1441 blk = get_nodes_block(n);
1442 if (is_constlike_node(blk)) {
1445 /* Generate a new name for the node by appending the names of
1447 fprintf(F, "node: {title: \""); PRINT_CONSTBLKID(n, blk);
1448 fprintf(F, "\" label: \"");
1449 bad |= dump_node_label(F, blk);
1451 bad |= dump_node_info(F, blk);
1452 dump_node_vcgattr(F, n, blk, bad);
1455 fprintf(F, "edge: { sourcename: \"");
1457 fprintf(F, "\" targetname: \""); PRINT_CONSTBLKID(n,blk);
1459 if (dump_edge_vcgattr_hook) {
1461 if (dump_edge_vcgattr_hook(F, n, -1)) {
1465 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1470 fprintf(F, "\" " BLOCK_EDGE_ATTR "}\n");
1475 * prints the error message of a node to a file F as info2.
1477 static void print_node_error(FILE *F, const char *err_msg)
1482 fprintf(F, " info2: \"%s\"", err_msg);
1486 * prints debug messages of a node to file F as info3.
1488 static void print_dbg_info(FILE *F, dbg_info *dbg)
1492 ir_dbg_info_snprint(buf, sizeof(buf), dbg);
1494 fprintf(F, " info3: \"%s\"\n", buf);
1498 static void print_type_dbg_info(FILE *F, type_dbg_info *dbg)
1508 static void dump_node(FILE *F, ir_node *n)
1513 if (get_opt_dump_const_local() && is_constlike_node(n))
1516 /* dump this node */
1517 fputs("node: {title: \"", F);
1521 fputs(" label: \"", F);
1522 bad = ! irn_vrfy_irg_dump(n, current_ir_graph, &p);
1523 bad |= dump_node_label(F, n);
1524 dump_node_ana_vals(F, n);
1525 //dump_node_ana_info(F, n);
1528 if (get_op_flags(get_irn_op(n)) & irop_flag_dump_noinput) {
1529 //fputs(" node_class:23", F);
1532 bad |= dump_node_info(F, n);
1533 print_node_error(F, p);
1534 print_dbg_info(F, get_irn_dbg_info(n));
1535 dump_node_vcgattr(F, n, NULL, bad);
1537 dump_const_node_local(F, n);
1539 if (dump_node_edge_hook)
1540 dump_node_edge_hook(F, n);
1543 /** dump the edge to the block this node belongs to */
1544 static void dump_ir_block_edge(FILE *F, ir_node *n)
1546 if (get_opt_dump_const_local() && is_constlike_node(n)) return;
1547 if (is_no_Block(n)) {
1548 ir_node *block = get_nodes_block(n);
1550 if (get_opt_dump_const_local() && is_constlike_node(block)) {
1551 dump_const_block_local(F, n);
1553 fprintf(F, "edge: { sourcename: \"");
1555 fprintf(F, "\" targetname: ");
1556 fprintf(F, "\""); PRINT_NODEID(block); fprintf(F, "\"");
1558 if (dump_edge_vcgattr_hook) {
1560 if (dump_edge_vcgattr_hook(F, n, -1)) {
1564 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1569 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1574 static void print_data_edge_vcgattr(FILE *F, ir_node *from, int to)
1577 * do not use get_nodes_block() here, will fail
1578 * if the irg is not pinned.
1580 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1581 fprintf(F, INTRA_DATA_EDGE_ATTR);
1583 fprintf(F, INTER_DATA_EDGE_ATTR);
1586 static void print_mem_edge_vcgattr(FILE *F, ir_node *from, int to)
1589 * do not use get_nodes_block() here, will fail
1590 * if the irg is not pinned.
1592 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1593 fprintf(F, INTRA_MEM_EDGE_ATTR);
1595 fprintf(F, INTER_MEM_EDGE_ATTR);
1598 /** Print the vcg attributes for the edge from node from to it's to's input */
1599 static void print_edge_vcgattr(FILE *F, ir_node *from, int to)
1603 if (dump_edge_vcgattr_hook)
1604 if (dump_edge_vcgattr_hook(F, from, to))
1607 if (dump_backedge_information_flag && is_backedge(from, to))
1608 fprintf(F, BACK_EDGE_ATTR);
1610 switch (get_irn_opcode(from)) {
1612 fprintf(F, CF_EDGE_ATTR);
1614 case iro_Start: break;
1617 if (get_irn_mode(get_End_keepalive(from, to)) == mode_BB)
1618 fprintf(F, KEEP_ALIVE_CF_EDGE_ATTR);
1620 fprintf(F, KEEP_ALIVE_DF_EDGE_ATTR);
1624 if (is_Proj(from)) {
1625 if (get_irn_mode(from) == mode_M)
1626 print_mem_edge_vcgattr(F, from, to);
1627 else if (get_irn_mode(from) == mode_X)
1628 fprintf(F, CF_EDGE_ATTR);
1630 print_data_edge_vcgattr(F, from, to);
1632 else if (get_irn_mode(get_irn_n(from, to)) == mode_M)
1633 print_mem_edge_vcgattr(F, from, to);
1634 else if (get_irn_mode(get_irn_n(from, to)) == mode_X)
1635 fprintf(F, CF_EDGE_ATTR);
1637 print_data_edge_vcgattr(F, from, to);
1641 /** dump edges to our inputs */
1642 static void dump_ir_data_edges(FILE *F, ir_node *n)
1645 ir_visited_t visited = get_irn_visited(n);
1647 if (!dump_keepalive && is_End(n)) {
1648 /* the End node has only keep-alive edges */
1652 /* dump the dependency edges. */
1653 num = get_irn_deps(n);
1654 for (i = 0; i < num; ++i) {
1655 ir_node *dep = get_irn_dep(n, i);
1658 print_node_edge_kind(F, n);
1659 fprintf(F, "{sourcename: \"");
1661 fprintf(F, "\" targetname: ");
1662 if ((get_opt_dump_const_local()) && is_constlike_node(dep)) {
1663 PRINT_CONSTID(n, dep);
1669 fprintf(F, " label: \"%d\" ", i);
1670 fprintf(F, " color: darkgreen}\n");
1674 num = get_irn_arity(n);
1675 for (i = 0; i < num; i++) {
1676 ir_node *pred = get_irn_n(n, i);
1679 if ((get_interprocedural_view() && get_irn_visited(pred) < visited))
1680 continue; /* pred not dumped */
1682 if (dump_backedge_information_flag && is_backedge(n, i))
1683 fprintf(F, "backedge: {sourcename: \"");
1685 print_node_edge_kind(F, n);
1686 fprintf(F, "{sourcename: \"");
1689 fprintf(F, "\" targetname: ");
1690 if ((get_opt_dump_const_local()) && is_constlike_node(pred)) {
1691 PRINT_CONSTID(n, pred);
1693 fprintf(F, "\""); PRINT_NODEID(pred); fprintf(F, "\"");
1695 fprintf(F, " label: \"%d\" ", i);
1696 print_edge_vcgattr(F, n, i);
1700 if (dump_macro_block_edges && is_Block(n)) {
1701 ir_node *mb = get_Block_MacroBlock(n);
1702 fprintf(F, "edge: {sourcename: \"");
1704 fprintf(F, "\" targetname: \"");
1706 fprintf(F, "\" label: \"mb\" " MACROBLOCK_EDGE_ATTR);
1714 static void dump_ir_edges(FILE *F, ir_node *n)
1716 const ir_edge_t *edge;
1719 foreach_out_edge(n, edge) {
1720 ir_node *succ = get_edge_src_irn(edge);
1722 print_node_edge_kind(F, succ);
1723 fprintf(F, "{sourcename: \"");
1725 fprintf(F, "\" targetname: \"");
1729 fprintf(F, " label: \"%d\" ", i);
1730 fprintf(F, OUT_EDGE_ATTR);
1737 /** Dumps a node and its edges but not the block edge */
1738 static void dump_node_wo_blockedge(ir_node *n, void *env)
1742 dump_ir_data_edges(F, n);
1745 /** Dumps a node and its edges. */
1746 static void dump_whole_node(ir_node *n, void *env)
1749 dump_node_wo_blockedge(n, env);
1750 if (!node_floats(n))
1751 dump_ir_block_edge(F, n);
1752 if (dump_new_edges_flag && edges_activated(current_ir_graph))
1753 dump_ir_edges(F, n);
1756 /** Dumps a const-like node. */
1757 static void dump_const_node(ir_node *n, void *env)
1759 if (is_Block(n)) return;
1760 dump_node_wo_blockedge(n, env);
1763 /***********************************************************************/
1764 /* the following routines dump the nodes/irgs bracketed to graphs. */
1765 /***********************************************************************/
1767 /** Dumps a constant expression as entity initializer, array bound ...
1769 static void dump_const_expression(FILE *F, ir_node *value)
1771 ir_graph *rem = current_ir_graph;
1772 int rem_dump_const_local = dump_const_local;
1773 dump_const_local = 0;
1774 current_ir_graph = get_const_code_irg();
1775 irg_walk(value, dump_const_node, NULL, F);
1776 /* Decrease visited flag so that we walk with the same flag for the next
1777 expression. This guarantees that we don't dump the same node twice,
1778 as for const expressions cse is performed to save memory. */
1779 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph) -1);
1780 current_ir_graph = rem;
1781 dump_const_local = rem_dump_const_local;
1784 /** Dump a block as graph containing its nodes.
1786 * Expects to find nodes belonging to the block as list in its
1788 * Dumps the edges of all nodes including itself. */
1789 static void dump_whole_block(FILE *F, ir_node *block)
1792 ird_color_t color = ird_color_block_background;
1794 assert(is_Block(block));
1796 fprintf(F, "graph: { title: \"");
1797 PRINT_NODEID(block);
1798 fprintf(F, "\" label: \"");
1799 dump_node_label(F, block);
1801 /* colorize blocks */
1802 if (! get_Block_matured(block))
1803 color = ird_color_block_background;
1804 if (is_Block_dead(block))
1805 color = ird_color_dead_block_background;
1807 fprintf(F, "\" status:clustered ");
1808 print_vcg_color(F, color);
1811 /* yComp can show attributes for blocks, XVCG parses but ignores them */
1812 dump_node_info(F, block);
1813 print_dbg_info(F, get_irn_dbg_info(block));
1815 /* dump the blocks edges */
1816 dump_ir_data_edges(F, block);
1818 if (dump_block_edge_hook)
1819 dump_block_edge_hook(F, block);
1821 /* dump the nodes that go into the block */
1822 for (node = ird_get_irn_link(block); node; node = ird_get_irn_link(node)) {
1824 dump_ir_data_edges(F, node);
1827 /* Close the vcg information for the block */
1829 dump_const_node_local(F, block);
1833 /** dumps a graph block-wise. Expects all blockless nodes in arr in irgs link.
1834 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1835 static void dump_block_graph(FILE *F, ir_graph *irg)
1838 ir_graph *rem = current_ir_graph;
1839 ir_node **arr = ird_get_irg_link(irg);
1840 current_ir_graph = irg;
1842 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1843 ir_node * node = arr[i];
1844 if (is_Block(node)) {
1845 /* Dumps the block and all the nodes in the block, which are to
1846 be found in Block->link. */
1847 dump_whole_block(F, node);
1849 /* Nodes that are not in a Block. */
1851 if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
1852 dump_const_block_local(F, node);
1854 dump_ir_data_edges(F, node);
1856 if (dump_new_edges_flag && edges_activated(irg))
1857 dump_ir_edges(F, node);
1860 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1861 dump_loop_nodes_into_graph(F, irg);
1863 current_ir_graph = rem;
1867 * Dump the info for an irg.
1868 * Parsed by XVCG but not shown. use yComp.
1870 static void dump_graph_info(FILE *F, ir_graph *irg)
1872 fprintf(F, "info1: \"");
1873 dump_entity_to_file(F, get_irg_entity(irg), dump_verbosity_entattrs | dump_verbosity_entconsts);
1877 /** Dumps an irg as a graph clustered by block nodes.
1878 * If interprocedural view edges can point to nodes out of this graph.
1880 static void dump_graph_from_list(FILE *F, ir_graph *irg)
1882 ir_entity *ent = get_irg_entity(irg);
1884 fprintf(F, "graph: { title: \"");
1886 fprintf(F, "\" label: \"%s\" status:clustered color:%s \n",
1887 get_ent_dump_name(ent), color_names[ird_color_prog_background]);
1889 dump_graph_info(F, irg);
1890 print_dbg_info(F, get_entity_dbg_info(ent));
1892 dump_block_graph(F, irg);
1894 /* Close the vcg information for the irg */
1895 fprintf(F, "}\n\n");
1898 /** dumps a graph extended block-wise. Expects all blockless nodes in arr in irgs link.
1899 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1900 static void dump_extblock_graph(FILE *F, ir_graph *irg)
1903 ir_graph *rem = current_ir_graph;
1904 ir_extblk **arr = ird_get_irg_link(irg);
1905 current_ir_graph = irg;
1907 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1908 ir_extblk *extbb = arr[i];
1909 ir_node *leader = get_extbb_leader(extbb);
1912 fprintf(F, "graph: { title: \"");
1913 PRINT_EXTBBID(leader);
1914 fprintf(F, "\" label: \"ExtBB %ld\" status:clustered color:lightgreen\n",
1915 get_irn_node_nr(leader));
1917 for (j = ARR_LEN(extbb->blks) - 1; j >= 0; --j) {
1918 ir_node * node = extbb->blks[j];
1919 if (is_Block(node)) {
1920 /* Dumps the block and all the nodes in the block, which are to
1921 be found in Block->link. */
1922 dump_whole_block(F, node);
1924 /* Nodes that are not in a Block. */
1926 if (is_Bad(get_nodes_block(node)) && !node_floats(node)) {
1927 dump_const_block_local(F, node);
1929 dump_ir_data_edges(F, node);
1935 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1936 dump_loop_nodes_into_graph(F, irg);
1938 current_ir_graph = rem;
1943 /*******************************************************************/
1944 /* Basic type and entity nodes and edges. */
1945 /*******************************************************************/
1947 /** dumps the edges between nodes and their type or entity attributes. */
1948 static void dump_node2type_edges(ir_node *n, void *env)
1953 switch (get_irn_opcode(n)) {
1955 /* @@@ some consts have an entity */
1958 if (SYMCONST_HAS_TYPE(get_SymConst_kind(n)))
1959 print_node_type_edge(F,n,get_SymConst_type(n),NODE2TYPE_EDGE_ATTR);
1962 print_node_ent_edge(F,n,get_Sel_entity(n),NODE2TYPE_EDGE_ATTR);
1965 print_node_type_edge(F,n,get_Call_type(n),NODE2TYPE_EDGE_ATTR);
1968 print_node_type_edge(F,n,get_Alloc_type(n),NODE2TYPE_EDGE_ATTR);
1971 print_node_type_edge(F,n,get_Free_type(n),NODE2TYPE_EDGE_ATTR);
1974 print_node_type_edge(F,n,get_Cast_type(n),NODE2TYPE_EDGE_ATTR);
1982 static int print_type_info(FILE *F, ir_type *tp)
1986 if (get_type_state(tp) == layout_undefined) {
1987 fprintf(F, "state: layout_undefined\n");
1989 fprintf(F, "state: layout_fixed,\n");
1991 if (get_type_mode(tp))
1992 fprintf(F, "mode: %s,\n", get_mode_name_ex(get_type_mode(tp), &bad));
1993 fprintf(F, "size: %db,\n", get_type_size_bits(tp));
1998 static void print_typespecific_info(FILE *F, ir_type *tp)
2000 switch (get_type_tpop_code(tp)) {
2002 fprintf(F, "peculiarity: %s\n", get_peculiarity_string(get_class_peculiarity(tp)));
2007 fprintf(F, "variadicity: %s\n", get_variadicity_name(get_method_variadicity(tp)));
2008 fprintf(F, "params: %d\n", get_method_n_params(tp));
2009 fprintf(F, "results: %d\n", get_method_n_ress(tp));
2015 case tpo_enumeration:
2027 static void print_typespecific_vcgattr(FILE *F, ir_type *tp)
2029 switch (get_type_tpop_code(tp)) {
2031 fprintf(F, " " TYPE_CLASS_NODE_ATTR);
2034 fprintf(F, " " TYPE_METH_NODE_ATTR);
2042 case tpo_enumeration:
2053 int dump_type_node(FILE *F, ir_type *tp)
2057 fprintf(F, "node: {title: ");
2059 ir_fprintf(F, " label: \"%s %+F\" info1: \"", get_type_tpop_name(tp), tp);
2060 dump_type_to_file(F, tp, dump_verbosity_max);
2062 print_type_dbg_info(F, get_type_dbg_info(tp));
2063 print_typespecific_vcgattr(F, tp);
2070 void dump_entity_node(FILE *F, ir_entity *ent)
2072 fprintf(F, "node: {title: \"");
2073 PRINT_ENTID(ent); fprintf(F, "\"");
2074 fprintf(F, DEFAULT_TYPE_ATTRIBUTE);
2075 fprintf(F, "label: ");
2076 fprintf(F, "\"%s\" ", get_ent_dump_name(ent));
2078 print_vcg_color(F, ird_color_entity);
2079 fprintf(F, "\n info1: \"");
2081 dump_entity_to_file(F, ent, dump_verbosity_entattrs | dump_verbosity_entconsts);
2084 print_dbg_info(F, get_entity_dbg_info(ent));
2088 static void dump_enum_item(FILE *F, ir_type *tp, int pos)
2091 ir_enum_const *ec = get_enumeration_const(tp, pos);
2092 ident *id = get_enumeration_const_nameid(ec);
2093 tarval *tv = get_enumeration_value(ec);
2096 tarval_snprintf(buf, sizeof(buf), tv);
2098 strncpy(buf, "<not set>", sizeof(buf));
2099 fprintf(F, "node: {title: \"");
2100 PRINT_ITEMID(tp, pos); fprintf(F, "\"");
2101 fprintf(F, DEFAULT_ENUM_ITEM_ATTRIBUTE);
2102 fprintf(F, "label: ");
2103 fprintf(F, "\"enum item %s\" " ENUM_ITEM_NODE_ATTR, get_id_str(id));
2104 fprintf(F, "\n info1: \"value: %s\"}\n", buf);
2108 * Dumps a new style initializer.
2110 static void dump_entity_initializer(FILE *F, const ir_entity *ent)
2117 /** Dumps a type or entity and it's edges. */
2118 static void dump_type_info(type_or_ent tore, void *env)
2121 int i = 0; /* to shutup gcc */
2123 /* dump this type or entity */
2125 switch (get_kind(tore.ent)) {
2127 ir_entity *ent = tore.ent;
2130 dump_entity_node(F, ent);
2132 /* skip this to reduce graph. Member edge of type is parallel to this edge. *
2133 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2134 ENT_OWN_EDGE_ATTR "}\n", ent, get_entity_owner(ent));*/
2135 print_ent_type_edge(F,ent, get_entity_type(ent), ENT_TYPE_EDGE_ATTR);
2136 if (is_Class_type(get_entity_owner(ent))) {
2137 for (i = get_entity_n_overwrites(ent) - 1; i >= 0; --i)
2138 print_ent_ent_edge(F,ent, get_entity_overwrites(ent, i), 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2140 /* attached subgraphs */
2141 if (const_entities) {
2142 if (ent->initializer != NULL) {
2143 /* new style initializers */
2144 dump_entity_initializer(F, ent);
2145 } else if (entity_has_compound_ent_values(ent)) {
2146 /* old style compound entity values */
2147 for (i = get_compound_ent_n_values(ent) - 1; i >= 0; --i) {
2148 value = get_compound_ent_value(ent, i);
2150 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2151 dump_const_expression(F, value);
2152 print_ent_ent_edge(F, ent, get_compound_ent_value_member(ent, i), 0, -1, ENT_CORR_EDGE_ATTR, i);
2154 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2155 ENT_CORR_EDGE_ATTR "}\n", GET_ENTID(ent),
2156 get_compound_ent_value_member(ent, i), i);
2165 ir_type *tp = tore.typ;
2166 dump_type_node(F, tp);
2167 /* and now the edges */
2168 switch (get_type_tpop_code(tp)) {
2170 for (i = get_class_n_supertypes(tp) - 1; i >= 0; --i)
2171 print_type_type_edge(F, tp, get_class_supertype(tp, i), TYPE_SUPER_EDGE_ATTR);
2172 for (i = get_class_n_members(tp) - 1; i >= 0; --i)
2173 print_type_ent_edge(F, tp, get_class_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
2176 for (i = get_struct_n_members(tp) - 1; i >= 0; --i)
2177 print_type_ent_edge(F, tp, get_struct_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
2180 for (i = get_method_n_params(tp) - 1; i >= 0; --i)
2181 print_type_type_edge(F, tp, get_method_param_type(tp, i), METH_PAR_EDGE_ATTR,i);
2182 for (i = get_method_n_ress(tp) - 1; i >= 0; --i)
2183 print_type_type_edge(F, tp, get_method_res_type(tp, i), METH_RES_EDGE_ATTR,i);
2186 for (i = get_union_n_members(tp) - 1; i >= 0; --i)
2187 print_type_ent_edge(F, tp, get_union_member(tp, i), UNION_EDGE_ATTR);
2190 print_type_type_edge(F, tp, get_array_element_type(tp), ARR_ELT_TYPE_EDGE_ATTR);
2191 print_type_ent_edge(F, tp, get_array_element_entity(tp), ARR_ENT_EDGE_ATTR);
2192 for (i = get_array_n_dimensions(tp) - 1; i >= 0; --i) {
2193 ir_node *upper = get_array_upper_bound(tp, i);
2194 ir_node *lower = get_array_lower_bound(tp, i);
2195 print_node_type_edge(F, upper, tp, "label: \"upper %d\"", get_array_order(tp, i));
2196 print_node_type_edge(F, lower, tp, "label: \"lower %d\"", get_array_order(tp, i));
2197 dump_const_expression(F, upper);
2198 dump_const_expression(F, lower);
2201 case tpo_enumeration:
2202 for (i = get_enumeration_n_enums(tp) - 1; i >= 0; --i) {
2203 dump_enum_item(F, tp, i);
2204 print_enum_item_edge(F, tp, i, "label: \"item %d\"", i);
2208 print_type_type_edge(F, tp, get_pointer_points_to_type(tp), PTR_PTS_TO_EDGE_ATTR);
2215 break; /* case k_type */
2218 printf(" *** irdump, dump_type_info(l.%i), faulty type.\n", __LINE__);
2219 } /* switch kind_or_entity */
2222 typedef struct _h_env {
2227 /** For dumping class hierarchies.
2228 * Dumps a class type node and a superclass edge.
2229 * If env->dump_ent dumps entities of classes and overwrites edges.
2231 static void dump_class_hierarchy_node(type_or_ent tore, void *ctx)
2235 int i = 0; /* to shutup gcc */
2237 /* dump this type or entity */
2238 switch (get_kind(tore.ent)) {
2240 ir_entity *ent = tore.ent;
2241 if (get_entity_owner(ent) == get_glob_type()) break;
2242 if (!is_Method_type(get_entity_type(ent)))
2244 if (env->dump_ent && is_Class_type(get_entity_owner(ent))) {
2246 dump_entity_node(F, ent);
2248 print_type_ent_edge(F, get_entity_owner(ent), ent, TYPE_MEMBER_EDGE_ATTR);
2249 for (i = get_entity_n_overwrites(ent) - 1; i >= 0; --i)
2250 print_ent_ent_edge(F, get_entity_overwrites(ent, i), ent, 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2255 ir_type *tp = tore.typ;
2256 if (tp == get_glob_type())
2258 switch (get_type_tpop_code(tp)) {
2260 dump_type_node(F, tp);
2261 /* and now the edges */
2262 for (i = get_class_n_supertypes(tp) - 1; i >= 0; --i) {
2263 print_type_type_edge(F,tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2268 break; /* case k_type */
2271 printf(" *** irdump, dump_class_hierarchy_node(l.%i), faulty type.\n", __LINE__);
2272 } /* switch kind_or_entity */
2275 /*******************************************************************/
2276 /* dump analysis information that is expressed in graph terms. */
2277 /*******************************************************************/
2279 /* dump out edges */
2280 static void dump_out_edge(ir_node *n, void *env)
2284 for (i = get_irn_n_outs(n) - 1; i >= 0; --i) {
2285 ir_node *succ = get_irn_out(n, i);
2287 print_node_edge_kind(F, succ);
2288 fprintf(F, "{sourcename: \"");
2290 fprintf(F, "\" targetname: \"");
2292 fprintf(F, "\" color: red linestyle: dashed");
2297 static inline void dump_loop_label(FILE *F, ir_loop *loop)
2299 fprintf(F, "loop %d, %d sons, %d nodes",
2300 get_loop_depth(loop), get_loop_n_sons(loop), get_loop_n_nodes(loop));
2303 static inline void dump_loop_info(FILE *F, ir_loop *loop)
2305 fprintf(F, " info1: \"");
2306 fprintf(F, " loop nr: %d", get_loop_loop_nr(loop));
2307 #ifdef DEBUG_libfirm /* GL @@@ debug analyses */
2308 fprintf(F, "\n The loop was analyzed %d times.", PTR_TO_INT(get_loop_link(loop)));
2313 static inline void dump_loop_node(FILE *F, ir_loop *loop)
2315 fprintf(F, "node: {title: \"");
2317 fprintf(F, "\" label: \"");
2318 dump_loop_label(F, loop);
2320 dump_loop_info(F, loop);
2324 static inline void dump_loop_node_edge(FILE *F, ir_loop *loop, int i)
2327 fprintf(F, "edge: {sourcename: \"");
2329 fprintf(F, "\" targetname: \"");
2330 PRINT_NODEID(get_loop_node(loop, i));
2331 fprintf(F, "\" color: green");
2335 static inline void dump_loop_son_edge(FILE *F, ir_loop *loop, int i)
2338 fprintf(F, "edge: {sourcename: \"");
2340 fprintf(F, "\" targetname: \"");
2341 PRINT_LOOPID(get_loop_son(loop, i));
2342 fprintf(F, "\" color: darkgreen label: \"%d\"}\n",
2343 get_loop_element_pos(loop, get_loop_son(loop, i)));
2346 static void dump_loops(FILE *F, ir_loop *loop)
2349 /* dump this loop node */
2350 dump_loop_node(F, loop);
2352 /* dump edges to nodes in loop -- only if it is a real loop */
2353 if (get_loop_depth(loop) != 0) {
2354 for (i = get_loop_n_nodes(loop) - 1; i >= 0; --i) {
2355 dump_loop_node_edge(F, loop, i);
2358 for (i = get_loop_n_sons(loop) - 1; i >= 0; --i) {
2359 dump_loops(F, get_loop_son(loop, i));
2360 dump_loop_son_edge(F, loop, i);
2364 static inline void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg)
2366 ir_loop *loop = get_irg_loop(irg);
2369 ir_graph *rem = current_ir_graph;
2370 current_ir_graph = irg;
2372 dump_loops(F, loop);
2374 current_ir_graph = rem;
2380 * dumps the VCG header
2382 void dump_vcg_header(FILE *F, const char *name, const char *layout, const char *orientation)
2389 label = edge_label ? "yes" : "no";
2390 if (! layout) layout = "Compilergraph";
2391 if (!orientation) orientation = "bottom_to_top";
2395 "graph: { title: \"ir graph of %s\"\n"
2396 "display_edge_labels: %s\n"
2397 "layoutalgorithm: mindepth //$ \"%s\"\n"
2398 "manhattan_edges: yes\n"
2399 "port_sharing: no\n"
2401 "classname 1: \"intrablock Data\"\n"
2402 "classname 2: \"Block\"\n"
2403 "classname 3: \"Entity type\"\n"
2404 "classname 4: \"Entity owner\"\n"
2405 "classname 5: \"Method Param\"\n"
2406 "classname 6: \"Method Res\"\n"
2407 "classname 7: \"Super\"\n"
2408 "classname 8: \"Union\"\n"
2409 "classname 9: \"Points-to\"\n"
2410 "classname 10: \"Array Element Type\"\n"
2411 "classname 11: \"Overwrites\"\n"
2412 "classname 12: \"Member\"\n"
2413 "classname 13: \"Control Flow\"\n"
2414 "classname 14: \"intrablock Memory\"\n"
2415 "classname 15: \"Dominators\"\n"
2416 "classname 16: \"interblock Data\"\n"
2417 "classname 17: \"interblock Memory\"\n"
2418 "classname 18: \"Exception Control Flow for Interval Analysis\"\n"
2419 "classname 19: \"Postdominators\"\n"
2420 "classname 20: \"Keep Alive\"\n"
2421 "classname 21: \"Out Edges\"\n"
2422 "classname 22: \"Macro Block Edges\"\n"
2423 //"classname 23: \"NoInput Nodes\"\n"
2424 "infoname 1: \"Attribute\"\n"
2425 "infoname 2: \"Verification errors\"\n"
2426 "infoname 3: \"Debug info\"\n",
2427 name, label, layout, orientation);
2429 for (i = 0; i < ird_color_count; ++i) {
2430 if (color_rgb[i] != NULL) {
2431 fprintf(F, "colorentry %s: %s\n", color_names[i], color_rgb[i]);
2434 fprintf(F, "\n"); /* a separator */
2440 * @param irg The graph to be dumped
2441 * @param suffix1 first filename suffix
2442 * @param suffix2 second filename suffix
2444 FILE *vcg_open(const ir_graph *irg, const char *suffix1, const char *suffix2)
2447 const char *nm = get_irg_dump_name(irg);
2448 int len = strlen(nm), i, j;
2449 char *fname; /* filename to put the vcg information in */
2451 if (!suffix1) suffix1 = "";
2452 if (!suffix2) suffix2 = "";
2454 /* open file for vcg graph */
2455 fname = XMALLOCN(char, len * 2 + strlen(suffix1) + strlen(suffix2) + 5);
2457 /* strncpy (fname, nm, len); */ /* copy the filename */
2459 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2461 fname[j] = '@'; j++; fname[j] = '1'; j++;
2462 } else if (nm[i] == '@') {
2463 fname[j] = '@'; j++; fname[j] = '2'; j++;
2465 fname[j] = nm[i]; j++;
2469 strcat(fname, suffix1); /* append file suffix */
2470 strcat(fname, suffix2); /* append file suffix */
2471 strcat(fname, ".vcg"); /* append the .vcg suffix */
2473 /* vcg really expect only a <CR> at end of line, so
2474 * the "b"inary mode is what you mean (and even needed for Win32)
2476 F = fopen(fname, "wb"); /* open file for writing */
2488 * @param name prefix file name
2489 * @param suffix filename suffix
2491 FILE *vcg_open_name(const char *name, const char *suffix)
2494 char *fname; /* filename to put the vcg information in */
2495 int i, j, len = strlen(name);
2497 if (!suffix) suffix = "";
2499 /** open file for vcg graph */
2500 fname = XMALLOCN(char, len * 2 + 5 + strlen(suffix));
2501 /* strcpy (fname, name);*/ /* copy the filename */
2503 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2504 if (name[i] == '/') {
2505 fname[j] = '@'; j++; fname[j] = '1'; j++;
2506 } else if (name[i] == '@') {
2507 fname[j] = '@'; j++; fname[j] = '2'; j++;
2509 fname[j] = name[i]; j++;
2513 strcat(fname, suffix);
2514 strcat(fname, ".vcg"); /* append the .vcg suffix */
2516 /* vcg really expect only a <CR> at end of line, so
2517 * the "b"inary mode is what you mean (and even needed for Win32)
2519 F = fopen(fname, "wb"); /* open file for writing */
2529 * Dumps the vcg file footer
2531 void dump_vcg_footer(FILE *F)
2536 /************************************************************************/
2537 /************************************************************************/
2538 /* Routines that dump all or parts of the firm representation to a file */
2539 /************************************************************************/
2540 /************************************************************************/
2542 /************************************************************************/
2543 /* Dump ir graphs, different formats and additional information. */
2544 /************************************************************************/
2546 typedef void (*do_dump_graph_func) (ir_graph *irg, FILE *out);
2548 static void do_dump(ir_graph *irg, const char *suffix, const char *suffix_ip,
2549 const char *suffix_nonip, do_dump_graph_func dump_func)
2553 const char *suffix1;
2555 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2558 rem = current_ir_graph;
2559 current_ir_graph = irg;
2560 if (get_interprocedural_view())
2561 suffix1 = suffix_ip;
2563 suffix1 = suffix_nonip;
2564 current_ir_graph = rem;
2566 out = vcg_open(irg, suffix, suffix1);
2568 dump_func(irg, out);
2573 void dump_ir_graph_file(ir_graph *irg, FILE *out)
2575 if (dump_backedge_information_flag
2576 && get_irg_loopinfo_state(irg) != loopinfo_consistent) {
2577 construct_backedges(irg);
2580 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2582 /* call the dump graph hook */
2583 if (dump_ir_graph_hook) {
2584 if (dump_ir_graph_hook(out, irg)) {
2589 /* walk over the graph */
2590 /* dump_whole_node must be called in post visiting predecessors */
2591 ird_walk_graph(irg, NULL, dump_whole_node, out);
2593 /* dump the out edges in a separate walk */
2594 if ((dump_out_edge_flag) && (get_irg_outs_state(irg) != outs_none)) {
2595 irg_out_walk(get_irg_start(irg), dump_out_edge, NULL, out);
2598 dump_vcg_footer(out);
2601 /** Routine to dump a graph, blocks as conventional nodes. */
2602 void dump_ir_graph(ir_graph *irg, const char *suffix )
2604 do_dump(irg, suffix, "-pure-ip", "-pure", dump_ir_graph_file);
2607 void dump_ir_block_graph_file(ir_graph *irg, FILE *out)
2611 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2613 construct_block_lists(irg);
2616 * If we are in the interprocedural view, we dump not
2617 * only the requested irg but also all irgs that can be reached
2620 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2621 ir_graph *g = get_irp_irg(i);
2622 ir_node **arr = ird_get_irg_link(g);
2624 dump_graph_from_list(out, g);
2629 dump_vcg_footer(out);
2632 /* Dump a firm graph without explicit block nodes. */
2633 void dump_ir_block_graph(ir_graph *irg, const char *suffix)
2635 do_dump(irg, suffix, "-ip", "", dump_ir_block_graph_file);
2638 void dump_ir_extblock_graph_file(ir_graph *irg, FILE *F)
2641 ir_entity *ent = get_irg_entity(irg);
2643 if (get_irg_extblk_state(irg) != extblk_valid)
2646 dump_vcg_header(F, get_irg_dump_name(irg), NULL, NULL);
2648 construct_extblock_lists(irg);
2650 fprintf(F, "graph: { title: \"");
2652 fprintf(F, "\" label: \"%s\" status:clustered color: white \n",
2653 get_ent_dump_name(ent));
2655 dump_graph_info(F, irg);
2656 print_dbg_info(F, get_entity_dbg_info(ent));
2658 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2659 ir_graph *irg = get_irp_irg(i);
2660 list_tuple *lists = ird_get_irg_link(irg);
2663 /* dump the extended blocks first */
2664 if (ARR_LEN(lists->extbb_list)) {
2665 ird_set_irg_link(irg, lists->extbb_list);
2666 dump_extblock_graph(F, irg);
2669 /* we may have blocks without extended blocks, bad for instance */
2670 if (ARR_LEN(lists->blk_list)) {
2671 ird_set_irg_link(irg, lists->blk_list);
2672 dump_block_graph(F, irg);
2675 DEL_ARR_F(lists->extbb_list);
2676 DEL_ARR_F(lists->blk_list);
2681 /* Close the vcg information for the irg */
2682 fprintf(F, "}\n\n");
2688 /* Dump a firm graph without explicit block nodes but grouped in extended blocks. */
2689 void dump_ir_extblock_graph(ir_graph *irg, const char *suffix)
2691 do_dump(irg, suffix, "-ip", "", dump_ir_extblock_graph_file);
2694 void dump_ir_graph_w_types_file(ir_graph *irg, FILE *out)
2696 ir_graph *rem = current_ir_graph;
2697 int rem_dump_const_local;
2699 rem = current_ir_graph;
2700 current_ir_graph = irg;
2701 rem_dump_const_local = dump_const_local;
2702 /* dumping types does not work with local nodes */
2703 dump_const_local = 0;
2705 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2707 /* dump common ir graph */
2708 irg_walk(get_irg_end(irg), NULL, dump_whole_node, out);
2709 /* dump type info */
2710 type_walk_irg(irg, dump_type_info, NULL, out);
2711 inc_irg_visited(get_const_code_irg());
2712 /* dump edges from graph to type info */
2713 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2715 dump_vcg_footer(out);
2716 dump_const_local = rem_dump_const_local;
2717 current_ir_graph = rem;
2720 /* dumps a graph with type information */
2721 void dump_ir_graph_w_types(ir_graph *irg, const char *suffix)
2723 do_dump(irg, suffix, "-pure-wtypes-ip", "-pure-wtypes",
2724 dump_ir_graph_w_types_file);
2727 void dump_ir_block_graph_w_types_file(ir_graph *irg, FILE *out)
2730 int rem_dump_const_local;
2731 ir_graph *rem = current_ir_graph;
2733 rem_dump_const_local = dump_const_local;
2734 /* dumping types does not work with local nodes */
2735 dump_const_local = 0;
2737 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2739 /* dump common blocked ir graph */
2740 construct_block_lists(irg);
2742 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2743 ir_node **arr = ird_get_irg_link(get_irp_irg(i));
2745 dump_graph_from_list(out, get_irp_irg(i));
2750 /* dump type info */
2751 current_ir_graph = irg;
2752 type_walk_irg(irg, dump_type_info, NULL, out);
2753 inc_irg_visited(get_const_code_irg());
2755 /* dump edges from graph to type info */
2756 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2758 dump_vcg_footer(out);
2759 dump_const_local = rem_dump_const_local;
2760 current_ir_graph = rem;
2763 void dump_ir_block_graph_w_types(ir_graph *irg, const char *suffix)
2765 do_dump(irg, suffix, "-wtypes-ip", "-wtypes",
2766 dump_ir_block_graph_w_types_file);
2769 /*---------------------------------------------------------------------*/
2770 /* The following routines dump a control flow graph. */
2771 /*---------------------------------------------------------------------*/
2773 static void dump_block_to_cfg(ir_node *block, void *env)
2779 if (is_Block(block)) {
2780 /* This is a block. Dump a node for the block. */
2781 fprintf(F, "node: {title: \""); PRINT_NODEID(block);
2782 fprintf(F, "\" label: \"");
2783 if (block == get_irg_start_block(get_irn_irg(block)))
2784 fprintf(F, "Start ");
2785 if (block == get_irg_end_block(get_irn_irg(block)))
2788 fprintf(F, "%s ", get_op_name(get_irn_op(block)));
2789 PRINT_NODEID(block);
2791 fprintf(F, "info1:\"");
2793 /* the generic version. */
2794 dump_irnode_to_file(F, block);
2796 /* Check whether we have bad predecessors to color the block. */
2797 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
2798 if ((fl = is_Bad(get_Block_cfgpred(block, i))))
2801 fprintf(F, "\""); /* closing quote of info */
2803 if ((block == get_irg_start_block(get_irn_irg(block))) ||
2804 (block == get_irg_end_block(get_irn_irg(block))) )
2805 fprintf(F, " color:blue ");
2807 fprintf(F, " color:yellow ");
2810 /* Dump the edges */
2811 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
2812 if (!is_Bad(skip_Proj(get_Block_cfgpred(block, i)))) {
2813 pred = get_nodes_block(skip_Proj(get_Block_cfgpred(block, i)));
2814 fprintf(F, "edge: { sourcename: \"");
2815 PRINT_NODEID(block);
2816 fprintf(F, "\" targetname: \"");
2818 fprintf(F, "\"}\n");
2821 /* Dump dominator/postdominator edge */
2822 if (dump_dominator_information_flag) {
2823 if (get_irg_dom_state(current_ir_graph) == dom_consistent && get_Block_idom(block)) {
2824 pred = get_Block_idom(block);
2825 fprintf(F, "edge: { sourcename: \"");
2826 PRINT_NODEID(block);
2827 fprintf(F, "\" targetname: \"");
2829 fprintf(F, "\" " DOMINATOR_EDGE_ATTR "}\n");
2831 if (get_irg_postdom_state(current_ir_graph) == dom_consistent && get_Block_ipostdom(block)) {
2832 pred = get_Block_ipostdom(block);
2833 fprintf(F, "edge: { sourcename: \"");
2834 PRINT_NODEID(block);
2835 fprintf(F, "\" targetname: \"");
2837 fprintf(F, "\" " POSTDOMINATOR_EDGE_ATTR "}\n");
2843 void dump_cfg(ir_graph *irg, const char *suffix)
2846 /* if a filter is set, dump only the irg's that match the filter */
2847 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2850 f = vcg_open(irg, suffix, "-cfg");
2852 ir_graph *rem = current_ir_graph;
2853 #ifdef INTERPROCEDURAL_VIEW
2854 int ipv = get_interprocedural_view();
2857 current_ir_graph = irg;
2858 dump_vcg_header(f, get_irg_dump_name(irg), NULL, NULL);
2860 #ifdef INTERPROCEDURAL_VIEW
2862 printf("Warning: dumping cfg not in interprocedural view!\n");
2863 set_interprocedural_view(0);
2867 /* walk over the blocks in the graph */
2868 irg_block_walk(get_irg_end(irg), dump_block_to_cfg, NULL, f);
2869 dump_node(f, get_irg_bad(irg));
2871 #ifdef INTERPROCEDURAL_VIEW
2872 set_interprocedural_view(ipv);
2876 current_ir_graph = rem;
2881 static void descend_and_dump(FILE *F, ir_node *n, int depth, pset *mark_set)
2883 if (pset_find_ptr(mark_set, n))
2886 pset_insert_ptr(mark_set, n);
2889 int i, start = is_Block(n) ? 0 : -1;
2890 dump_whole_node(n, F);
2891 for (i = start; i < get_irn_arity(n); ++i)
2892 descend_and_dump(F, get_irn_n(n, i), depth-1, mark_set);
2895 /* Don't dump edges to nodes further out. These might be edges to
2896 nodes we already dumped, if there is a shorter path to these. */
2900 static int subgraph_counter = 0;
2901 void dump_subgraph(ir_node *root, int depth, const char *suffix)
2906 sprintf(buf, "-subg_%03d", subgraph_counter++);
2907 F = vcg_open(get_irn_irg(root), suffix, buf);
2909 pset *mark_set = pset_new_ptr(1);
2910 dump_vcg_header(F, get_irg_dump_name(get_irn_irg(root)), NULL, NULL);
2911 descend_and_dump(F, root, depth, mark_set);
2918 void dump_callgraph(const char *suffix)
2920 FILE *F = vcg_open_name("Callgraph", suffix);
2923 int i, rem = edge_label;
2926 dump_vcg_header(F, "Callgraph", "Hierarchiv", NULL);
2928 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2929 ir_graph *irg = get_irp_irg(i);
2930 ir_entity *ent = get_irg_entity(irg);
2932 int n_callees = get_irg_n_callees(irg);
2934 dump_entity_node(F, ent);
2935 for (j = 0; j < n_callees; ++j) {
2936 ir_entity *c = get_irg_entity(get_irg_callee(irg, j));
2937 //if (id_is_prefix(prefix, get_entity_ld_ident(c))) continue;
2938 int be = is_irg_callee_backedge(irg, j);
2941 "label:\"recursion %d\"" :
2942 "label:\"calls %d\"";
2943 print_ent_ent_edge(F, ent, c, be, ird_color_entity, attr, get_irg_callee_loop_depth(irg, j));
2954 /* Dump all irgs in interprocedural view to a single file. */
2955 void dump_all_cg_block_graph(const char *suffix)
2957 FILE *f = vcg_open_name("All_graphs", suffix);
2961 int rem_view = get_interprocedural_view();
2963 set_interprocedural_view(1);
2964 dump_vcg_header(f, "All_graphs", NULL);
2966 /* collect nodes in all irgs reachable in call graph*/
2967 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2968 ird_set_irg_link(get_irp_irg(i), NULL);
2970 cg_walk(clear_link, collect_node, NULL);
2972 /* dump all graphs */
2973 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2974 current_ir_graph = get_irp_irg(i);
2975 assert(ird_get_irg_link(current_ir_graph));
2976 dump_graph_from_list(f, current_ir_graph);
2977 DEL_ARR_F(ird_get_irg_link(current_ir_graph));
2982 set_interprocedural_view(rem_view);
2987 /*---------------------------------------------------------------------*/
2988 /* the following routines dumps type information without any ir nodes. */
2989 /*---------------------------------------------------------------------*/
2991 void dump_type_graph(ir_graph *irg, const char *suffix)
2995 /* if a filter is set, dump only the irg's that match the filter */
2996 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
2998 f = vcg_open(irg, suffix, "-type");
3000 ir_graph *rem = current_ir_graph;
3001 current_ir_graph = irg;
3003 dump_vcg_header(f, get_irg_dump_name(irg), "Hierarchic", NULL);
3005 /* walk over the blocks in the graph */
3006 type_walk_irg(irg, dump_type_info, NULL, f);
3007 /* The walker for the const code can be called several times for the
3008 same (sub) expression. So that no nodes are dumped several times
3009 we decrease the visited flag of the corresponding graph after each
3010 walk. So now increase it finally. */
3011 inc_irg_visited(get_const_code_irg());
3015 current_ir_graph = rem;
3019 void dump_all_types(const char *suffix)
3021 FILE *f = vcg_open_name("All_types", suffix);
3023 dump_vcg_header(f, "All_types", "Hierarchic", NULL);
3024 type_walk(dump_type_info, NULL, f);
3025 inc_irg_visited(get_const_code_irg());
3032 void dump_class_hierarchy(int entities, const char *suffix)
3034 FILE *f = vcg_open_name("class_hierarchy", suffix);
3039 env.dump_ent = entities;
3040 dump_vcg_header(f, "class_hierarchy", "Hierarchic", NULL);
3041 type_walk(dump_class_hierarchy_node, NULL, &env);
3048 /*---------------------------------------------------------------------*/
3049 /* dumps all graphs with the graph-dumper passed. Possible dumpers: */
3051 /* dump_ir_block_graph */
3053 /* dump_type_graph */
3054 /* dump_ir_graph_w_types */
3055 /*---------------------------------------------------------------------*/
3057 void dump_all_ir_graphs(dump_graph_func *dmp_grph, const char *suffix)
3060 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
3061 dmp_grph(get_irp_irg(i), suffix);
3065 ir_prog_pass_t pass;
3066 dump_graph_func *dump_graph;
3071 * Wrapper around dump_all_ir_graphs().
3073 static int dump_all_ir_graphs_wrapper(ir_prog *irp, void *context)
3075 struct pass_t *pass = context;
3078 dump_all_ir_graphs(pass->dump_graph, pass->suffix);
3082 ir_prog_pass_t *dump_all_ir_graph_pass(const char *name,
3083 dump_graph_func *dump_graph,
3086 size_t len = strlen(suffix);
3087 struct pass_t *pass = xmalloc(sizeof(*pass) + len);
3088 ir_prog_pass_t *res = def_prog_pass_constructor(
3089 &pass->pass, name ? name : "dump_all_graphs", dump_all_ir_graphs_wrapper);
3091 /* this pass does not change anything, so neither dump nor verify is needed. */
3092 res->dump_irprog = ir_prog_no_dump;
3093 res->verify_irprog = ir_prog_no_verify;
3095 pass->dump_graph = dump_graph;
3096 strcpy(pass->suffix, suffix);
3101 /*--------------------------------------------------------------------------------*
3102 * Dumps a stand alone loop graph with firm nodes which belong to one loop node *
3103 * packed together in one subgraph/box *
3104 *--------------------------------------------------------------------------------*/
3106 void dump_loops_standalone(FILE *F, ir_loop *loop)
3108 int i = 0, loop_node_started = 0, son_number = 0, first = 0;
3110 ir_loop *son = NULL;
3112 /* Dump a new loop node. */
3113 dump_loop_node(F, loop);
3115 /* Dump the loop elements. */
3116 for (i = 0; i < get_loop_n_elements(loop); i++) {
3117 le = get_loop_element(loop, i);
3119 if (get_kind(son) == k_ir_loop) {
3121 /* We are a loop son -> Recurse */
3123 if (loop_node_started) { /* Close the "firm-nodes" node first if we started one. */
3124 fprintf(F, "\" }\n");
3125 fprintf(F, "edge: {sourcename: \"");
3127 fprintf(F, "\" targetname: \"");
3129 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3130 loop_node_started = 0;
3132 dump_loop_son_edge(F, loop, son_number++);
3133 dump_loops_standalone(F, son);
3134 } else if (get_kind(son) == k_ir_node) {
3135 /* We are a loop node -> Collect firm nodes */
3137 ir_node *n = le.node;
3140 if (!loop_node_started) {
3141 /* Start a new node which contains all firm nodes of the current loop */
3142 fprintf(F, "node: { title: \"");
3144 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3145 loop_node_started = 1;
3150 bad |= dump_node_label(F, n);
3151 /* Causes indeterministic output: if (is_Block(n)) fprintf(F, "\t ->%d", (int)get_irn_link(n)); */
3152 if (has_backedges(n)) fprintf(F, "\t loop head!");
3153 } else { /* for callgraph loop tree */
3155 assert(get_kind(son) == k_ir_graph);
3157 /* We are a loop node -> Collect firm graphs */
3159 if (!loop_node_started) {
3160 /* Start a new node which contains all firm nodes of the current loop */
3161 fprintf(F, "node: { title: \"");
3163 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3164 loop_node_started = 1;
3168 fprintf(F, " %s", get_irg_dump_name(n));
3169 /* fprintf(F, " %s (depth %d)", get_irg_dump_name(n), n->callgraph_weighted_loop_depth); */
3173 if (loop_node_started) {
3174 fprintf(F, "\" }\n");
3175 fprintf(F, "edge: {sourcename: \"");
3177 fprintf(F, "\" targetname: \"");
3179 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3180 loop_node_started = 0;
3184 void dump_loop_tree(ir_graph *irg, const char *suffix)
3188 /* if a filter is set, dump only the irg's that match the filter */
3189 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
3192 f = vcg_open(irg, suffix, "-looptree");
3194 ir_graph *rem = current_ir_graph;
3195 int el_rem = edge_label;
3197 current_ir_graph = irg;
3200 dump_vcg_header(f, get_irg_dump_name(irg), "Tree", "top_to_bottom");
3202 if (get_irg_loop(irg))
3203 dump_loops_standalone(f, get_irg_loop(irg));
3208 edge_label = el_rem;
3209 current_ir_graph = rem;
3213 void dump_callgraph_loop_tree(const char *suffix)
3216 F = vcg_open_name("Callgraph_looptree", suffix);
3217 dump_vcg_header(F, "callgraph looptree", "Tree", "top_to_bottom");
3218 dump_loops_standalone(F, irp->outermost_cg_loop);
3224 /*----------------------------------------------------------------------------*/
3225 /* Dumps the firm nodes in the loop tree to a graph along with the loop nodes.*/
3226 /*----------------------------------------------------------------------------*/
3228 void collect_nodeloop(FILE *F, ir_loop *loop, eset *loopnodes)
3230 int i, son_number = 0, node_number = 0;
3232 if (dump_loop_information_flag) dump_loop_node(F, loop);
3234 for (i = 0; i < get_loop_n_elements(loop); i++) {
3235 loop_element le = get_loop_element(loop, i);
3236 if (*(le.kind) == k_ir_loop) {
3237 if (dump_loop_information_flag) dump_loop_son_edge(F, loop, son_number++);
3239 collect_nodeloop(F, le.son, loopnodes);
3241 if (dump_loop_information_flag) dump_loop_node_edge(F, loop, node_number++);
3242 eset_insert(loopnodes, le.node);
3247 void collect_nodeloop_external_nodes(ir_loop *loop, eset *loopnodes, eset *extnodes)
3251 for (i = 0; i < get_loop_n_elements(loop); i++) {
3252 loop_element le = get_loop_element(loop, i);
3253 if (*(le.kind) == k_ir_loop) {
3255 collect_nodeloop_external_nodes(le.son, loopnodes, extnodes);
3257 if (is_Block(le.node)) start = 0; else start = -1;
3258 for (j = start; j < get_irn_arity(le.node); j++) {
3259 ir_node *pred = get_irn_n(le.node, j);
3260 if (!eset_contains(loopnodes, pred)) {
3261 eset_insert(extnodes, pred);
3262 if (!is_Block(pred)) {
3263 pred = get_nodes_block(pred);
3264 if (!eset_contains(loopnodes, pred)) eset_insert(extnodes, pred);
3272 void dump_loop(ir_loop *l, const char *suffix)
3277 snprintf(name, sizeof(name), "loop_%d", get_loop_loop_nr(l));
3278 F = vcg_open_name(name, suffix);
3280 eset *loopnodes = eset_create();
3281 eset *extnodes = eset_create();
3284 dump_vcg_header(F, name, NULL, NULL);
3286 /* collect all nodes to dump */
3287 collect_nodeloop(F, l, loopnodes);
3288 collect_nodeloop_external_nodes(l, loopnodes, extnodes);
3290 /* build block lists */
3291 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes))
3292 set_irn_link(n, NULL);
3293 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes))
3294 set_irn_link(n, NULL);
3295 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes)) {
3297 b = get_nodes_block(n);
3298 set_irn_link(n, get_irn_link(b));
3302 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes)) {
3304 b = get_nodes_block(n);
3305 set_irn_link(n, get_irn_link(b));
3310 for (b = eset_first(loopnodes); b != NULL; b = eset_next(loopnodes)) {
3312 fprintf(F, "graph: { title: \"");
3314 fprintf(F, "\" label: \"");
3315 dump_node_opcode(F, b);
3316 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3317 fprintf(F, "\" status:clustered color:yellow\n");
3319 /* dump the blocks edges */
3320 dump_ir_data_edges(F, b);
3322 /* dump the nodes that go into the block */
3323 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3324 if (eset_contains(extnodes, n))
3325 overrule_nodecolor = ird_color_block_inout;
3327 overrule_nodecolor = ird_color_default_node;
3328 if (!eset_contains(extnodes, n)) dump_ir_data_edges(F, n);
3331 /* Close the vcg information for the block */
3333 dump_const_node_local(F, b);
3337 for (b = eset_first(extnodes); b != NULL; b = eset_next(extnodes)) {
3339 fprintf(F, "graph: { title: \"");
3341 fprintf(F, "\" label: \"");
3342 dump_node_opcode(F, b);
3343 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3344 fprintf(F, "\" status:clustered color:lightblue\n");
3346 /* dump the nodes that go into the block */
3347 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3348 if (!eset_contains(loopnodes, n))
3349 overrule_nodecolor = ird_color_block_inout;
3351 overrule_nodecolor = ird_color_default_node;
3352 if (eset_contains(loopnodes, n)) dump_ir_data_edges(F, n);
3355 /* Close the vcg information for the block */
3357 dump_const_node_local(F, b);
3361 eset_destroy(loopnodes);
3362 eset_destroy(extnodes);