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_name:
787 /* don't use get_SymConst_ptr_info as it mangles the name. */
788 fprintf(F, "SymC %s", get_id_str(get_SymConst_name(n)));
790 case symconst_addr_ent:
791 fprintf(F, "SymC &%s", get_entity_name(get_SymConst_entity(n)));
793 case symconst_ofs_ent:
794 fprintf(F, "SymC %s offset", get_entity_name(get_SymConst_entity(n)));
796 case symconst_type_tag:
797 ir_fprintf(F, "SymC %+F tag", get_SymConst_type(n));
799 case symconst_type_size:
800 ir_fprintf(F, "SymC %+F size", get_SymConst_type(n));
802 case symconst_type_align:
803 ir_fprintf(F, "SymC %+F align", get_SymConst_type(n));
805 case symconst_enum_const:
806 fprintf(F, "SymC %s enum", get_enumeration_const_name(get_SymConst_enum(n)));
812 if (!get_interprocedural_view())
819 ir_node *pred = get_Proj_pred(n);
821 if (get_irn_opcode(pred) == iro_Cond
822 && get_Proj_proj(n) == get_Cond_default_proj(pred)
823 && get_irn_mode(get_Cond_selector(pred)) != mode_b)
824 fprintf(F, "defProj");
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))));
838 case iro_CallBegin: {
839 ir_node *addr = get_CallBegin_ptr(n);
840 ir_entity *ent = NULL;
842 ent = get_Sel_entity(addr);
843 else if (is_Global(addr))
844 ent = get_Global_entity(addr);
845 fprintf(F, "%s", get_irn_opname(n));
846 if (ent) fprintf(F, " %s", get_entity_name(ent));
850 if (get_Load_align(n) == align_non_aligned)
852 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Load_mode(n), &bad));
855 if (get_Store_align(n) == align_non_aligned)
857 fprintf(F, "%s", get_irn_opname(n));
861 is_Block_dead(n) ? "Dead " : "", get_irn_opname(n),
862 dump_block_marker ? (get_Block_mark(n) ? "*" : "") : "");
865 if (get_Conv_strict(n))
866 fprintf(F, "strict");
867 fprintf(F, "%s", get_irn_opname(n));
870 fprintf(F, "%s", get_irn_opname(n));
871 if (get_Div_no_remainder(n))
873 fprintf(F, "[%s]", get_mode_name_ex(get_Div_resmode(n), &bad));
876 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Mod_resmode(n), &bad));
879 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_DivMod_resmode(n), &bad));
882 fprintf(F, "%s[%s]", get_irn_opname(n), get_builtin_kind_name(get_Builtin_kind(n)));
887 fprintf(F, "%s", get_irn_opname(n));
894 * Dump the mode of a node n to a file F.
895 * Ignore modes that are "always known".
897 static int dump_node_mode(FILE *F, ir_node *n)
900 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
904 /* call the dump_node operation if available */
906 return ops->dump_node(n, F, dump_node_mode_txt);
908 /* default implementation */
909 iro = get_irn_opcode(n);
921 mode = get_irn_mode(n);
923 if (mode != NULL && mode != mode_BB && mode != mode_ANY && mode != mode_BAD &&
924 (mode != mode_T || iro == iro_Proj))
925 fprintf(F, "%s", get_mode_name_ex(mode, &bad));
931 * Dump the type of a node n to a file F if it's known.
933 static int dump_node_typeinfo(FILE *F, ir_node *n)
937 if (opt_dump_analysed_type_info) {
938 if (get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_consistent ||
939 get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_inconsistent) {
940 ir_type *tp = get_irn_typeinfo_type(n);
941 if (tp != firm_none_type) {
942 ir_fprintf(F, "[%+F]", tp);
951 typedef struct _pns_lookup {
952 long nr; /**< the proj number */
953 const char *name; /**< the name of the Proj */
956 typedef struct _proj_lookup {
957 ir_opcode code; /**< the opcode of the Proj predecessor */
958 unsigned num_data; /**< number of data entries */
959 const pns_lookup_t *data; /**< the data */
962 #define ARR_SIZE(a) (sizeof(a)/sizeof(a[0]))
964 /** the lookup table for Proj(Start) names */
965 static const pns_lookup_t start_lut[] = {
966 #define X(a) { pn_Start_##a, #a }
974 /** the lookup table for Proj(Cond) names */
975 static const pns_lookup_t cond_lut[] = {
976 #define X(a) { pn_Cond_##a, #a }
982 /** the lookup table for Proj(Call) names */
983 static const pns_lookup_t call_lut[] = {
984 #define X(a) { pn_Call_##a, #a }
993 /** the lookup table for Proj(Quot) names */
994 static const pns_lookup_t quot_lut[] = {
995 #define X(a) { pn_Quot_##a, #a }
1003 /** the lookup table for Proj(DivMod) names */
1004 static const pns_lookup_t divmod_lut[] = {
1005 #define X(a) { pn_DivMod_##a, #a }
1014 /** the lookup table for Proj(Div) names */
1015 static const pns_lookup_t div_lut[] = {
1016 #define X(a) { pn_Div_##a, #a }
1024 /** the lookup table for Proj(Mod) names */
1025 static const pns_lookup_t mod_lut[] = {
1026 #define X(a) { pn_Mod_##a, #a }
1034 /** the lookup table for Proj(Load) names */
1035 static const pns_lookup_t load_lut[] = {
1036 #define X(a) { pn_Load_##a, #a }
1044 /** the lookup table for Proj(Store) names */
1045 static const pns_lookup_t store_lut[] = {
1046 #define X(a) { pn_Store_##a, #a }
1053 /** the lookup table for Proj(Alloc) names */
1054 static const pns_lookup_t alloc_lut[] = {
1055 #define X(a) { pn_Alloc_##a, #a }
1063 /** the lookup table for Proj(CopyB) names */
1064 static const pns_lookup_t copyb_lut[] = {
1065 #define X(a) { pn_CopyB_##a, #a }
1072 /** the lookup table for Proj(InstOf) names */
1073 static const pns_lookup_t instof_lut[] = {
1074 #define X(a) { pn_InstOf_##a, #a }
1082 /** the lookup table for Proj(Raise) names */
1083 static const pns_lookup_t raise_lut[] = {
1084 #define X(a) { pn_Raise_##a, #a }
1090 /** the lookup table for Proj(Bound) names */
1091 static const pns_lookup_t bound_lut[] = {
1092 #define X(a) { pn_Bound_##a, #a }
1100 /** the Proj lookup table */
1101 static const proj_lookup_t proj_lut[] = {
1102 #define E(a) ARR_SIZE(a), a
1103 { iro_Start, E(start_lut) },
1104 { iro_Cond, E(cond_lut) },
1105 { iro_Call, E(call_lut) },
1106 { iro_Quot, E(quot_lut) },
1107 { iro_DivMod, E(divmod_lut) },
1108 { iro_Div, E(div_lut) },
1109 { iro_Mod, E(mod_lut) },
1110 { iro_Load, E(load_lut) },
1111 { iro_Store, E(store_lut) },
1112 { iro_Alloc, E(alloc_lut) },
1113 { iro_CopyB, E(copyb_lut) },
1114 { iro_InstOf, E(instof_lut) },
1115 { iro_Raise, E(raise_lut) },
1116 { iro_Bound, E(bound_lut) }
1121 * Dump additional node attributes of some nodes to a file F.
1124 dump_node_nodeattr(FILE *F, ir_node *n)
1130 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1132 /* call the dump_node operation if available */
1134 return ops->dump_node(n, F, dump_node_nodeattr_txt);
1136 switch (get_irn_opcode(n)) {
1138 if (0 && get_interprocedural_view()) {
1139 fprintf(F, "%s ", get_ent_dump_name(get_irg_entity(current_ir_graph)));
1144 ir_fprintf(F, "%T ", get_Const_tarval(n));
1148 pred = get_Proj_pred(n);
1149 proj_nr = get_Proj_proj(n);
1151 code = get_irn_opcode(pred);
1153 if (code == iro_Cmp)
1154 fprintf(F, "%s ", get_pnc_string(get_Proj_proj(n)));
1155 else if (code == iro_Proj && get_irn_opcode(get_Proj_pred(pred)) == iro_Start)
1156 fprintf(F, "Arg %ld ", proj_nr);
1157 else if (code == iro_Cond && get_irn_mode(get_Cond_selector(pred)) != mode_b)
1158 fprintf(F, "%ld ", proj_nr);
1160 unsigned i, j, f = 0;
1162 for (i = 0; i < ARR_SIZE(proj_lut); ++i) {
1163 if (code == proj_lut[i].code) {
1164 for (j = 0; j < proj_lut[i].num_data; ++j) {
1165 if (proj_nr == proj_lut[i].data[j].nr) {
1166 fprintf(F, "%s ", proj_lut[i].data[j].name);
1175 fprintf(F, "%ld ", proj_nr);
1176 if (code == iro_Cond && get_Cond_jmp_pred(pred) != COND_JMP_PRED_NONE) {
1177 if (proj_nr == pn_Cond_false && get_Cond_jmp_pred(pred) == COND_JMP_PRED_FALSE)
1178 fprintf(F, "PRED ");
1179 if (proj_nr == pn_Cond_true && get_Cond_jmp_pred(pred) == COND_JMP_PRED_TRUE)
1180 fprintf(F, "PRED ");
1185 proj_nr = get_Filter_proj(n);
1186 if (! get_interprocedural_view()) {
1188 pred = get_Filter_pred(n);
1191 fprintf(F, "%ld ", proj_nr);
1194 fprintf(F, "%s ", get_ent_dump_name(get_Sel_entity(n)));
1197 ir_fprintf(F, "(%+F)", get_Cast_type(n));
1200 fprintf(F, "%s ", get_pnc_string(get_Confirm_cmp(n)));
1203 ir_fprintf(F, "(%+F)", get_CopyB_type(n));
1214 #include "execution_frequency.h"
1216 static void dump_node_ana_vals(FILE *F, ir_node *n)
1221 #ifdef INTERPROCEDURAL_VIEW
1222 fprintf(F, " %lf*(%2.0lf + %2.0lf) = %2.0lf ",
1223 get_irn_exec_freq(n),
1224 get_irg_method_execution_frequency(get_irn_irg(n)),
1225 pow(5, get_irg_recursion_depth(get_irn_irg(n))),
1226 get_irn_exec_freq(n) * (get_irg_method_execution_frequency(get_irn_irg(n)) + pow(5, get_irg_recursion_depth(get_irn_irg(n))))
1232 /* Dumps a node label without the enclosing ". */
1233 int dump_node_label(FILE *F, ir_node *n)
1237 bad |= dump_node_opcode(F, n);
1239 bad |= dump_node_mode(F, n);
1241 bad |= dump_node_typeinfo(F, n);
1242 bad |= dump_node_nodeattr(F, n);
1243 if(dump_node_idx_labels) {
1244 fprintf(F, "%ld:%d", get_irn_node_nr(n), get_irn_idx(n));
1246 fprintf(F, "%ld", get_irn_node_nr(n));
1252 /* Dumps the vrp information of a node to a file */
1253 int dump_vrp_info(FILE *F, ir_node *n)
1255 if (!n->vrp.valid) {
1259 fprintf(F, "range_type: %d\n", n->vrp.range_type);
1260 if (n->vrp.range_type == VRP_RANGE || n->vrp.range_type ==
1262 ir_fprintf(F, "range_bottom: %F\n",n->vrp.range_bottom);
1263 ir_fprintf(F, "range_top: %F\n", n->vrp.range_top);
1265 ir_fprintf(F, "bits_set: %T\n", n->vrp.bits_set);
1266 ir_fprintf(F, "bits_not_set: %T\n", n->vrp.bits_not_set);
1267 if (n->vrp.bits_node == NULL) {
1268 fprintf(F, "bits_node: None");
1270 fprintf(F, "bits_node: #%ld\n", get_irn_node_nr(n->vrp.bits_node));
1277 * Dumps the attributes of a node n into the file F.
1278 * Currently this is only the color of a node.
1280 static void dump_node_vcgattr(FILE *F, ir_node *node, ir_node *local, int bad)
1286 print_vcg_color(F, ird_color_error);
1290 if (dump_node_vcgattr_hook)
1291 if (dump_node_vcgattr_hook(F, node, local))
1294 n = local ? local : node;
1296 if (overrule_nodecolor != ird_color_default_node) {
1297 print_vcg_color(F, overrule_nodecolor);
1301 mode = get_irn_mode(n);
1302 if(mode == mode_M) {
1303 print_vcg_color(F, ird_color_memory);
1306 if(mode == mode_X) {
1307 print_vcg_color(F, ird_color_controlflow);
1311 switch (get_irn_opcode(n)) {
1316 print_vcg_color(F, ird_color_anchor);
1319 print_vcg_color(F, ird_color_error);
1322 if (is_Block_dead(n))
1323 print_vcg_color(F, ird_color_dead_block_background);
1325 print_vcg_color(F, ird_color_block_background);
1328 print_vcg_color(F, ird_color_phi);
1331 print_vcg_color(F, ird_color_memory);
1335 print_vcg_color(F, ird_color_const);
1338 print_vcg_color(F, ird_color_proj);
1341 ir_op *op = get_irn_op(node);
1343 if(is_op_constlike(op)) {
1344 print_vcg_color(F, ird_color_const);
1345 } else if(is_op_uses_memory(op)) {
1346 print_vcg_color(F, ird_color_uses_memory);
1347 } else if(is_op_cfopcode(op) || is_op_forking(op)) {
1348 print_vcg_color(F, ird_color_controlflow);
1350 PRINT_DEFAULT_NODE_ATTR;
1356 /* Adds a new node info dumper callback. */
1357 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data)
1359 hook_entry_t *info = XMALLOC(hook_entry_t);
1361 info->hook._hook_node_info = cb;
1362 info->context = data;
1363 register_hook(hook_node_info, info);
1368 /* Remove a previously added info dumper callback. */
1369 void dump_remv_node_info_callback(void *handle)
1371 hook_entry_t *info = handle;
1372 unregister_hook(hook_node_info, info);
1377 * Dump the node information of a node n to a file F.
1379 static inline int dump_node_info(FILE *F, ir_node *n)
1382 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1384 fprintf(F, " info1: \"");
1385 bad = dump_irnode_to_file(F, n);
1386 /* call the dump_node operation if available */
1388 bad = ops->dump_node(n, F, dump_node_info_txt);
1390 /* allow additional info to be added */
1391 hook_node_info(F, n);
1397 static inline int is_constlike_node(const ir_node *node)
1399 const ir_op *op = get_irn_op(node);
1400 return is_op_constlike(op);
1404 /** outputs the predecessors of n, that are constants, local. I.e.,
1405 generates a copy of the constant predecessors for each node called with. */
1406 static void dump_const_node_local(FILE *F, ir_node *n)
1409 if (!get_opt_dump_const_local()) return;
1411 /* Use visited flag to avoid outputting nodes twice.
1412 initialize it first. */
1413 for (i = 0; i < get_irn_arity(n); i++) {
1414 ir_node *con = get_irn_n(n, i);
1415 if (is_constlike_node(con)) {
1416 set_irn_visited(con, get_irg_visited(current_ir_graph) - 1);
1420 for (i = 0; i < get_irn_arity(n); i++) {
1421 ir_node *con = get_irn_n(n, i);
1422 if (is_constlike_node(con) && !irn_visited(con)) {
1425 mark_irn_visited(con);
1426 /* Generate a new name for the node by appending the names of
1428 fprintf(F, "node: {title: "); PRINT_CONSTID(n, con);
1429 fprintf(F, " label: \"");
1430 bad |= dump_node_label(F, con);
1432 bad |= dump_node_info(F, con);
1433 dump_node_vcgattr(F, n, con, bad);
1439 /** If the block of an edge is a const_like node, dump it local with an edge */
1440 static void dump_const_block_local(FILE *F, ir_node *n)
1444 if (!get_opt_dump_const_local()) return;
1446 blk = get_nodes_block(n);
1447 if (is_constlike_node(blk)) {
1450 /* Generate a new name for the node by appending the names of
1452 fprintf(F, "node: {title: \""); PRINT_CONSTBLKID(n, blk);
1453 fprintf(F, "\" label: \"");
1454 bad |= dump_node_label(F, blk);
1456 bad |= dump_node_info(F, blk);
1457 dump_node_vcgattr(F, n, blk, bad);
1460 fprintf(F, "edge: { sourcename: \"");
1462 fprintf(F, "\" targetname: \""); PRINT_CONSTBLKID(n,blk);
1464 if (dump_edge_vcgattr_hook) {
1466 if (dump_edge_vcgattr_hook(F, n, -1)) {
1470 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1475 fprintf(F, "\" " BLOCK_EDGE_ATTR "}\n");
1480 * prints the error message of a node to a file F as info2.
1482 static void print_node_error(FILE *F, const char *err_msg)
1487 fprintf(F, " info2: \"%s\"", err_msg);
1491 * prints debug messages of a node to file F as info3.
1493 static void print_dbg_info(FILE *F, dbg_info *dbg)
1497 ir_dbg_info_snprint(buf, sizeof(buf), dbg);
1499 fprintf(F, " info3: \"%s\"\n", buf);
1503 static void print_type_dbg_info(FILE *F, type_dbg_info *dbg)
1513 static void dump_node(FILE *F, ir_node *n)
1518 if (get_opt_dump_const_local() && is_constlike_node(n))
1521 /* dump this node */
1522 fputs("node: {title: \"", F);
1526 fputs(" label: \"", F);
1527 bad = ! irn_vrfy_irg_dump(n, current_ir_graph, &p);
1528 bad |= dump_node_label(F, n);
1529 dump_node_ana_vals(F, n);
1530 //dump_node_ana_info(F, n);
1533 if (get_op_flags(get_irn_op(n)) & irop_flag_dump_noinput) {
1534 //fputs(" node_class:23", F);
1537 bad |= dump_node_info(F, n);
1538 print_node_error(F, p);
1539 print_dbg_info(F, get_irn_dbg_info(n));
1540 dump_node_vcgattr(F, n, NULL, bad);
1542 dump_const_node_local(F, n);
1544 if(dump_node_edge_hook)
1545 dump_node_edge_hook(F, n);
1548 /** dump the edge to the block this node belongs to */
1550 dump_ir_block_edge(FILE *F, ir_node *n)
1552 if (get_opt_dump_const_local() && is_constlike_node(n)) return;
1553 if (is_no_Block(n)) {
1554 ir_node *block = get_nodes_block(n);
1556 if (get_opt_dump_const_local() && is_constlike_node(block)) {
1557 dump_const_block_local(F, n);
1559 fprintf(F, "edge: { sourcename: \"");
1561 fprintf(F, "\" targetname: ");
1562 fprintf(F, "\""); PRINT_NODEID(block); fprintf(F, "\"");
1564 if (dump_edge_vcgattr_hook) {
1566 if (dump_edge_vcgattr_hook(F, n, -1)) {
1570 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1575 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1581 print_data_edge_vcgattr(FILE *F, ir_node *from, int to)
1584 * do not use get_nodes_block() here, will fail
1585 * if the irg is not pinned.
1587 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1588 fprintf(F, INTRA_DATA_EDGE_ATTR);
1590 fprintf(F, INTER_DATA_EDGE_ATTR);
1594 print_mem_edge_vcgattr(FILE *F, ir_node *from, int to)
1597 * do not use get_nodes_block() here, will fail
1598 * if the irg is not pinned.
1600 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1601 fprintf(F, INTRA_MEM_EDGE_ATTR);
1603 fprintf(F, INTER_MEM_EDGE_ATTR);
1606 /** Print the vcg attributes for the edge from node from to it's to's input */
1607 static void print_edge_vcgattr(FILE *F, ir_node *from, int to)
1611 if (dump_edge_vcgattr_hook)
1612 if (dump_edge_vcgattr_hook(F, from, to))
1615 if (dump_backedge_information_flag && is_backedge(from, to))
1616 fprintf(F, BACK_EDGE_ATTR);
1618 switch (get_irn_opcode(from)) {
1620 fprintf(F, CF_EDGE_ATTR);
1622 case iro_Start: break;
1625 if (get_irn_mode(get_End_keepalive(from, to)) == mode_BB)
1626 fprintf(F, KEEP_ALIVE_CF_EDGE_ATTR);
1628 fprintf(F, KEEP_ALIVE_DF_EDGE_ATTR);
1632 if (is_Proj(from)) {
1633 if (get_irn_mode(from) == mode_M)
1634 print_mem_edge_vcgattr(F, from, to);
1635 else if (get_irn_mode(from) == mode_X)
1636 fprintf(F, CF_EDGE_ATTR);
1638 print_data_edge_vcgattr(F, from, to);
1640 else if (get_irn_mode(get_irn_n(from, to)) == mode_M)
1641 print_mem_edge_vcgattr(F, from, to);
1642 else if (get_irn_mode(get_irn_n(from, to)) == mode_X)
1643 fprintf(F, CF_EDGE_ATTR);
1645 print_data_edge_vcgattr(F, from, to);
1649 /** dump edges to our inputs */
1650 static void dump_ir_data_edges(FILE *F, ir_node *n)
1653 ir_visited_t visited = get_irn_visited(n);
1655 if (!dump_keepalive && is_End(n)) {
1656 /* the End node has only keep-alive edges */
1660 /* dump the dependency edges. */
1661 num = get_irn_deps(n);
1662 for (i = 0; i < num; ++i) {
1663 ir_node *dep = get_irn_dep(n, i);
1666 print_node_edge_kind(F, n);
1667 fprintf(F, "{sourcename: \"");
1669 fprintf(F, "\" targetname: ");
1670 if ((get_opt_dump_const_local()) && is_constlike_node(dep)) {
1671 PRINT_CONSTID(n, dep);
1677 fprintf(F, " label: \"%d\" ", i);
1678 fprintf(F, " color: darkgreen}\n");
1682 num = get_irn_arity(n);
1683 for (i = 0; i < num; i++) {
1684 ir_node *pred = get_irn_n(n, i);
1687 if ((get_interprocedural_view() && get_irn_visited(pred) < visited))
1688 continue; /* pred not dumped */
1690 if (dump_backedge_information_flag && is_backedge(n, i))
1691 fprintf(F, "backedge: {sourcename: \"");
1693 print_node_edge_kind(F, n);
1694 fprintf(F, "{sourcename: \"");
1697 fprintf(F, "\" targetname: ");
1698 if ((get_opt_dump_const_local()) && is_constlike_node(pred)) {
1699 PRINT_CONSTID(n, pred);
1701 fprintf(F, "\""); PRINT_NODEID(pred); fprintf(F, "\"");
1703 fprintf(F, " label: \"%d\" ", i);
1704 print_edge_vcgattr(F, n, i);
1708 if (dump_macro_block_edges && is_Block(n)) {
1709 ir_node *mb = get_Block_MacroBlock(n);
1710 fprintf(F, "edge: {sourcename: \"");
1712 fprintf(F, "\" targetname: \"");
1714 fprintf(F, "\" label: \"mb\" " MACROBLOCK_EDGE_ATTR);
1723 dump_ir_edges(FILE *F, ir_node *n)
1725 const ir_edge_t *edge;
1728 foreach_out_edge(n, edge) {
1729 ir_node *succ = get_edge_src_irn(edge);
1731 print_node_edge_kind(F, succ);
1732 fprintf(F, "{sourcename: \"");
1734 fprintf(F, "\" targetname: \"");
1738 fprintf(F, " label: \"%d\" ", i);
1739 fprintf(F, OUT_EDGE_ATTR);
1746 /** Dumps a node and its edges but not the block edge */
1747 static void dump_node_wo_blockedge(ir_node *n, void *env)
1751 dump_ir_data_edges(F, n);
1754 /** Dumps a node and its edges. */
1755 static void dump_whole_node(ir_node *n, void *env)
1758 dump_node_wo_blockedge(n, env);
1759 if (!node_floats(n))
1760 dump_ir_block_edge(F, n);
1761 if (dump_new_edges_flag && edges_activated(current_ir_graph))
1762 dump_ir_edges(F, n);
1765 /** Dumps a const-like node. */
1766 static void dump_const_node(ir_node *n, void *env)
1768 if (is_Block(n)) return;
1769 dump_node_wo_blockedge(n, env);
1772 /***********************************************************************/
1773 /* the following routines dump the nodes/irgs bracketed to graphs. */
1774 /***********************************************************************/
1776 /** Dumps a constant expression as entity initializer, array bound ...
1778 static void dump_const_expression(FILE *F, ir_node *value)
1780 ir_graph *rem = current_ir_graph;
1781 int rem_dump_const_local = dump_const_local;
1782 dump_const_local = 0;
1783 current_ir_graph = get_const_code_irg();
1784 irg_walk(value, dump_const_node, NULL, F);
1785 /* Decrease visited flag so that we walk with the same flag for the next
1786 expression. This guarantees that we don't dump the same node twice,
1787 as for const expressions cse is performed to save memory. */
1788 set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph) -1);
1789 current_ir_graph = rem;
1790 dump_const_local = rem_dump_const_local;
1793 /** Dump a block as graph containing its nodes.
1795 * Expects to find nodes belonging to the block as list in its
1797 * Dumps the edges of all nodes including itself. */
1798 static void dump_whole_block(FILE *F, ir_node *block)
1801 ird_color_t color = ird_color_block_background;
1803 assert(is_Block(block));
1805 fprintf(F, "graph: { title: \"");
1806 PRINT_NODEID(block);
1807 fprintf(F, "\" label: \"");
1808 dump_node_label(F, block);
1810 /* colorize blocks */
1811 if (! get_Block_matured(block))
1812 color = ird_color_block_background;
1813 if (is_Block_dead(block))
1814 color = ird_color_dead_block_background;
1816 fprintf(F, "\" status:clustered ");
1817 print_vcg_color(F, color);
1820 /* yComp can show attributes for blocks, XVCG parses but ignores them */
1821 dump_node_info(F, block);
1822 print_dbg_info(F, get_irn_dbg_info(block));
1824 /* dump the blocks edges */
1825 dump_ir_data_edges(F, block);
1827 if (dump_block_edge_hook)
1828 dump_block_edge_hook(F, block);
1830 /* dump the nodes that go into the block */
1831 for (node = ird_get_irn_link(block); node; node = ird_get_irn_link(node)) {
1833 dump_ir_data_edges(F, node);
1836 /* Close the vcg information for the block */
1838 dump_const_node_local(F, block);
1842 /** dumps a graph block-wise. Expects all blockless nodes in arr in irgs link.
1843 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1845 dump_block_graph(FILE *F, ir_graph *irg)
1848 ir_graph *rem = current_ir_graph;
1849 ir_node **arr = ird_get_irg_link(irg);
1850 current_ir_graph = irg;
1852 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1853 ir_node * node = arr[i];
1854 if (is_Block(node)) {
1855 /* Dumps the block and all the nodes in the block, which are to
1856 be found in Block->link. */
1857 dump_whole_block(F, node);
1859 /* Nodes that are not in a Block. */
1861 if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
1862 dump_const_block_local(F, node);
1864 dump_ir_data_edges(F, node);
1866 if (dump_new_edges_flag && edges_activated(irg))
1867 dump_ir_edges(F, node);
1870 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1871 dump_loop_nodes_into_graph(F, irg);
1873 current_ir_graph = rem;
1877 * Dump the info for an irg.
1878 * Parsed by XVCG but not shown. use yComp.
1880 static void dump_graph_info(FILE *F, ir_graph *irg)
1882 fprintf(F, "info1: \"");
1883 dump_entity_to_file(F, get_irg_entity(irg), dump_verbosity_entattrs | dump_verbosity_entconsts);
1887 /** Dumps an irg as a graph clustered by block nodes.
1888 * If interprocedural view edges can point to nodes out of this graph.
1890 static void dump_graph_from_list(FILE *F, ir_graph *irg)
1892 ir_entity *ent = get_irg_entity(irg);
1894 fprintf(F, "graph: { title: \"");
1896 fprintf(F, "\" label: \"%s\" status:clustered color:%s \n",
1897 get_ent_dump_name(ent), color_names[ird_color_prog_background]);
1899 dump_graph_info(F, irg);
1900 print_dbg_info(F, get_entity_dbg_info(ent));
1902 dump_block_graph(F, irg);
1904 /* Close the vcg information for the irg */
1905 fprintf(F, "}\n\n");
1908 /** dumps a graph extended block-wise. Expects all blockless nodes in arr in irgs link.
1909 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1911 dump_extblock_graph(FILE *F, ir_graph *irg)
1914 ir_graph *rem = current_ir_graph;
1915 ir_extblk **arr = ird_get_irg_link(irg);
1916 current_ir_graph = irg;
1918 for (i = ARR_LEN(arr) - 1; i >= 0; --i) {
1919 ir_extblk *extbb = arr[i];
1920 ir_node *leader = get_extbb_leader(extbb);
1923 fprintf(F, "graph: { title: \"");
1924 PRINT_EXTBBID(leader);
1925 fprintf(F, "\" label: \"ExtBB %ld\" status:clustered color:lightgreen\n",
1926 get_irn_node_nr(leader));
1928 for (j = ARR_LEN(extbb->blks) - 1; j >= 0; --j) {
1929 ir_node * node = extbb->blks[j];
1930 if (is_Block(node)) {
1931 /* Dumps the block and all the nodes in the block, which are to
1932 be found in Block->link. */
1933 dump_whole_block(F, node);
1935 /* Nodes that are not in a Block. */
1937 if (is_Bad(get_nodes_block(node)) && !node_floats(node)) {
1938 dump_const_block_local(F, node);
1940 dump_ir_data_edges(F, node);
1946 if (dump_loop_information_flag && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1947 dump_loop_nodes_into_graph(F, irg);
1949 current_ir_graph = rem;
1954 /*******************************************************************/
1955 /* Basic type and entity nodes and edges. */
1956 /*******************************************************************/
1958 /** dumps the edges between nodes and their type or entity attributes. */
1959 static void dump_node2type_edges(ir_node *n, void *env)
1964 switch (get_irn_opcode(n)) {
1966 /* @@@ some consts have an entity */
1969 if (SYMCONST_HAS_TYPE(get_SymConst_kind(n)))
1970 print_node_type_edge(F,n,get_SymConst_type(n),NODE2TYPE_EDGE_ATTR);
1973 print_node_ent_edge(F,n,get_Sel_entity(n),NODE2TYPE_EDGE_ATTR);
1976 print_node_type_edge(F,n,get_Call_type(n),NODE2TYPE_EDGE_ATTR);
1979 print_node_type_edge(F,n,get_Alloc_type(n),NODE2TYPE_EDGE_ATTR);
1982 print_node_type_edge(F,n,get_Free_type(n),NODE2TYPE_EDGE_ATTR);
1985 print_node_type_edge(F,n,get_Cast_type(n),NODE2TYPE_EDGE_ATTR);
1993 static int print_type_info(FILE *F, ir_type *tp)
1997 if (get_type_state(tp) == layout_undefined) {
1998 fprintf(F, "state: layout_undefined\n");
2000 fprintf(F, "state: layout_fixed,\n");
2002 if (get_type_mode(tp))
2003 fprintf(F, "mode: %s,\n", get_mode_name_ex(get_type_mode(tp), &bad));
2004 fprintf(F, "size: %db,\n", get_type_size_bits(tp));
2009 static void print_typespecific_info(FILE *F, ir_type *tp)
2011 switch (get_type_tpop_code(tp)) {
2013 fprintf(F, "peculiarity: %s\n", get_peculiarity_string(get_class_peculiarity(tp)));
2018 fprintf(F, "variadicity: %s\n", get_variadicity_name(get_method_variadicity(tp)));
2019 fprintf(F, "params: %d\n", get_method_n_params(tp));
2020 fprintf(F, "results: %d\n", get_method_n_ress(tp));
2026 case tpo_enumeration:
2038 static void print_typespecific_vcgattr(FILE *F, ir_type *tp)
2040 switch (get_type_tpop_code(tp)) {
2042 fprintf(F, " " TYPE_CLASS_NODE_ATTR);
2045 fprintf(F, " " TYPE_METH_NODE_ATTR);
2053 case tpo_enumeration:
2064 int dump_type_node(FILE *F, ir_type *tp)
2068 fprintf(F, "node: {title: ");
2070 ir_fprintf(F, " label: \"%s %+F\" info1: \"", get_type_tpop_name(tp), tp);
2071 dump_type_to_file(F, tp, dump_verbosity_max);
2073 print_type_dbg_info(F, get_type_dbg_info(tp));
2074 print_typespecific_vcgattr(F, tp);
2081 void dump_entity_node(FILE *F, ir_entity *ent)
2083 fprintf(F, "node: {title: \"");
2084 PRINT_ENTID(ent); fprintf(F, "\"");
2085 fprintf(F, DEFAULT_TYPE_ATTRIBUTE);
2086 fprintf(F, "label: ");
2087 fprintf(F, "\"%s\" ", get_ent_dump_name(ent));
2089 print_vcg_color(F, ird_color_entity);
2090 fprintf(F, "\n info1: \"");
2092 dump_entity_to_file(F, ent, dump_verbosity_entattrs | dump_verbosity_entconsts);
2095 print_dbg_info(F, get_entity_dbg_info(ent));
2099 static void dump_enum_item(FILE *F, ir_type *tp, int pos)
2102 ir_enum_const *ec = get_enumeration_const(tp, pos);
2103 ident *id = get_enumeration_const_nameid(ec);
2104 tarval *tv = get_enumeration_value(ec);
2107 tarval_snprintf(buf, sizeof(buf), tv);
2109 strncpy(buf, "<not set>", sizeof(buf));
2110 fprintf(F, "node: {title: \"");
2111 PRINT_ITEMID(tp, pos); fprintf(F, "\"");
2112 fprintf(F, DEFAULT_ENUM_ITEM_ATTRIBUTE);
2113 fprintf(F, "label: ");
2114 fprintf(F, "\"enum item %s\" " ENUM_ITEM_NODE_ATTR, get_id_str(id));
2115 fprintf(F, "\n info1: \"value: %s\"}\n", buf);
2119 * Dumps a new style initializer.
2121 static void dump_entity_initializer(FILE *F, const ir_entity *ent)
2128 /** Dumps a type or entity and it's edges. */
2129 static void dump_type_info(type_or_ent tore, void *env)
2132 int i = 0; /* to shutup gcc */
2134 /* dump this type or entity */
2136 switch (get_kind(tore.ent)) {
2138 ir_entity *ent = tore.ent;
2141 dump_entity_node(F, ent);
2143 /* skip this to reduce graph. Member edge of type is parallel to this edge. *
2144 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2145 ENT_OWN_EDGE_ATTR "}\n", ent, get_entity_owner(ent));*/
2146 print_ent_type_edge(F,ent, get_entity_type(ent), ENT_TYPE_EDGE_ATTR);
2147 if (is_Class_type(get_entity_owner(ent))) {
2148 for (i = get_entity_n_overwrites(ent) - 1; i >= 0; --i)
2149 print_ent_ent_edge(F,ent, get_entity_overwrites(ent, i), 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2151 /* attached subgraphs */
2152 if (const_entities) {
2153 if (ent->initializer != NULL) {
2154 /* new style initializers */
2155 dump_entity_initializer(F, ent);
2156 } else if (entity_has_compound_ent_values(ent)) {
2157 /* old style compound entity values */
2158 for (i = get_compound_ent_n_values(ent) - 1; i >= 0; --i) {
2159 value = get_compound_ent_value(ent, i);
2161 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
2162 dump_const_expression(F, value);
2163 print_ent_ent_edge(F, ent, get_compound_ent_value_member(ent, i), 0, -1, ENT_CORR_EDGE_ATTR, i);
2165 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
2166 ENT_CORR_EDGE_ATTR "}\n", GET_ENTID(ent),
2167 get_compound_ent_value_member(ent, i), i);
2176 ir_type *tp = tore.typ;
2177 dump_type_node(F, tp);
2178 /* and now the edges */
2179 switch (get_type_tpop_code(tp)) {
2181 for (i = get_class_n_supertypes(tp) - 1; i >= 0; --i)
2182 print_type_type_edge(F, tp, get_class_supertype(tp, i), TYPE_SUPER_EDGE_ATTR);
2183 for (i = get_class_n_members(tp) - 1; i >= 0; --i)
2184 print_type_ent_edge(F, tp, get_class_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
2187 for (i = get_struct_n_members(tp) - 1; i >= 0; --i)
2188 print_type_ent_edge(F, tp, get_struct_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
2191 for (i = get_method_n_params(tp) - 1; i >= 0; --i)
2192 print_type_type_edge(F, tp, get_method_param_type(tp, i), METH_PAR_EDGE_ATTR,i);
2193 for (i = get_method_n_ress(tp) - 1; i >= 0; --i)
2194 print_type_type_edge(F, tp, get_method_res_type(tp, i), METH_RES_EDGE_ATTR,i);
2197 for (i = get_union_n_members(tp) - 1; i >= 0; --i)
2198 print_type_ent_edge(F, tp, get_union_member(tp, i), UNION_EDGE_ATTR);
2201 print_type_type_edge(F, tp, get_array_element_type(tp), ARR_ELT_TYPE_EDGE_ATTR);
2202 print_type_ent_edge(F, tp, get_array_element_entity(tp), ARR_ENT_EDGE_ATTR);
2203 for (i = get_array_n_dimensions(tp) - 1; i >= 0; --i) {
2204 ir_node *upper = get_array_upper_bound(tp, i);
2205 ir_node *lower = get_array_lower_bound(tp, i);
2206 print_node_type_edge(F, upper, tp, "label: \"upper %d\"", get_array_order(tp, i));
2207 print_node_type_edge(F, lower, tp, "label: \"lower %d\"", get_array_order(tp, i));
2208 dump_const_expression(F, upper);
2209 dump_const_expression(F, lower);
2212 case tpo_enumeration:
2213 for (i = get_enumeration_n_enums(tp) - 1; i >= 0; --i) {
2214 dump_enum_item(F, tp, i);
2215 print_enum_item_edge(F, tp, i, "label: \"item %d\"", i);
2219 print_type_type_edge(F, tp, get_pointer_points_to_type(tp), PTR_PTS_TO_EDGE_ATTR);
2226 break; /* case k_type */
2229 printf(" *** irdump, dump_type_info(l.%i), faulty type.\n", __LINE__);
2230 } /* switch kind_or_entity */
2233 typedef struct _h_env {
2238 /** For dumping class hierarchies.
2239 * Dumps a class type node and a superclass edge.
2240 * If env->dump_ent dumps entities of classes and overwrites edges.
2243 dump_class_hierarchy_node(type_or_ent tore, void *ctx)
2247 int i = 0; /* to shutup gcc */
2249 /* dump this type or entity */
2250 switch (get_kind(tore.ent)) {
2252 ir_entity *ent = tore.ent;
2253 if (get_entity_owner(ent) == get_glob_type()) break;
2254 if (!is_Method_type(get_entity_type(ent)))
2256 if (env->dump_ent && is_Class_type(get_entity_owner(ent))) {
2258 dump_entity_node(F, ent);
2260 print_type_ent_edge(F, get_entity_owner(ent), ent, TYPE_MEMBER_EDGE_ATTR);
2261 for (i = get_entity_n_overwrites(ent) - 1; i >= 0; --i)
2262 print_ent_ent_edge(F, get_entity_overwrites(ent, i), ent, 0, -1, ENT_OVERWRITES_EDGE_ATTR);
2267 ir_type *tp = tore.typ;
2268 if (tp == get_glob_type())
2270 switch (get_type_tpop_code(tp)) {
2272 dump_type_node(F, tp);
2273 /* and now the edges */
2274 for (i = get_class_n_supertypes(tp) - 1; i >= 0; --i) {
2275 print_type_type_edge(F,tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
2280 break; /* case k_type */
2283 printf(" *** irdump, dump_class_hierarchy_node(l.%i), faulty type.\n", __LINE__);
2284 } /* switch kind_or_entity */
2287 /*******************************************************************/
2288 /* dump analysis information that is expressed in graph terms. */
2289 /*******************************************************************/
2291 /* dump out edges */
2293 dump_out_edge(ir_node *n, void *env)
2297 for (i = get_irn_n_outs(n) - 1; i >= 0; --i) {
2298 ir_node *succ = get_irn_out(n, i);
2300 print_node_edge_kind(F, succ);
2301 fprintf(F, "{sourcename: \"");
2303 fprintf(F, "\" targetname: \"");
2305 fprintf(F, "\" color: red linestyle: dashed");
2311 dump_loop_label(FILE *F, ir_loop *loop)
2313 fprintf(F, "loop %d, %d sons, %d nodes",
2314 get_loop_depth(loop), get_loop_n_sons(loop), get_loop_n_nodes(loop));
2317 static inline void dump_loop_info(FILE *F, ir_loop *loop)
2319 fprintf(F, " info1: \"");
2320 fprintf(F, " loop nr: %d", get_loop_loop_nr(loop));
2321 #ifdef DEBUG_libfirm /* GL @@@ debug analyses */
2322 fprintf(F, "\n The loop was analyzed %d times.", PTR_TO_INT(get_loop_link(loop)));
2328 dump_loop_node(FILE *F, ir_loop *loop)
2330 fprintf(F, "node: {title: \"");
2332 fprintf(F, "\" label: \"");
2333 dump_loop_label(F, loop);
2335 dump_loop_info(F, loop);
2340 dump_loop_node_edge(FILE *F, ir_loop *loop, int i)
2343 fprintf(F, "edge: {sourcename: \"");
2345 fprintf(F, "\" targetname: \"");
2346 PRINT_NODEID(get_loop_node(loop, i));
2347 fprintf(F, "\" color: green");
2352 dump_loop_son_edge(FILE *F, ir_loop *loop, int i)
2355 fprintf(F, "edge: {sourcename: \"");
2357 fprintf(F, "\" targetname: \"");
2358 PRINT_LOOPID(get_loop_son(loop, i));
2359 fprintf(F, "\" color: darkgreen label: \"%d\"}\n",
2360 get_loop_element_pos(loop, get_loop_son(loop, i)));
2364 void dump_loops(FILE *F, ir_loop *loop)
2367 /* dump this loop node */
2368 dump_loop_node(F, loop);
2370 /* dump edges to nodes in loop -- only if it is a real loop */
2371 if (get_loop_depth(loop) != 0) {
2372 for (i = get_loop_n_nodes(loop) - 1; i >= 0; --i) {
2373 dump_loop_node_edge(F, loop, i);
2376 for (i = get_loop_n_sons(loop) - 1; i >= 0; --i) {
2377 dump_loops(F, get_loop_son(loop, i));
2378 dump_loop_son_edge(F, loop, i);
2383 void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg)
2385 ir_loop *loop = get_irg_loop(irg);
2388 ir_graph *rem = current_ir_graph;
2389 current_ir_graph = irg;
2391 dump_loops(F, loop);
2393 current_ir_graph = rem;
2399 * dumps the VCG header
2401 void dump_vcg_header(FILE *F, const char *name, const char *layout, const char *orientation)
2408 label = edge_label ? "yes" : "no";
2409 if (! layout) layout = "Compilergraph";
2410 if (!orientation) orientation = "bottom_to_top";
2414 "graph: { title: \"ir graph of %s\"\n"
2415 "display_edge_labels: %s\n"
2416 "layoutalgorithm: mindepth //$ \"%s\"\n"
2417 "manhattan_edges: yes\n"
2418 "port_sharing: no\n"
2420 "classname 1: \"intrablock Data\"\n"
2421 "classname 2: \"Block\"\n"
2422 "classname 3: \"Entity type\"\n"
2423 "classname 4: \"Entity owner\"\n"
2424 "classname 5: \"Method Param\"\n"
2425 "classname 6: \"Method Res\"\n"
2426 "classname 7: \"Super\"\n"
2427 "classname 8: \"Union\"\n"
2428 "classname 9: \"Points-to\"\n"
2429 "classname 10: \"Array Element Type\"\n"
2430 "classname 11: \"Overwrites\"\n"
2431 "classname 12: \"Member\"\n"
2432 "classname 13: \"Control Flow\"\n"
2433 "classname 14: \"intrablock Memory\"\n"
2434 "classname 15: \"Dominators\"\n"
2435 "classname 16: \"interblock Data\"\n"
2436 "classname 17: \"interblock Memory\"\n"
2437 "classname 18: \"Exception Control Flow for Interval Analysis\"\n"
2438 "classname 19: \"Postdominators\"\n"
2439 "classname 20: \"Keep Alive\"\n"
2440 "classname 21: \"Out Edges\"\n"
2441 "classname 22: \"Macro Block Edges\"\n"
2442 //"classname 23: \"NoInput Nodes\"\n"
2443 "infoname 1: \"Attribute\"\n"
2444 "infoname 2: \"Verification errors\"\n"
2445 "infoname 3: \"Debug info\"\n",
2446 name, label, layout, orientation);
2448 for (i = 0; i < ird_color_count; ++i) {
2449 if (color_rgb[i] != NULL) {
2450 fprintf(F, "colorentry %s: %s\n", color_names[i], color_rgb[i]);
2453 fprintf(F, "\n"); /* a separator */
2459 * @param irg The graph to be dumped
2460 * @param suffix1 first filename suffix
2461 * @param suffix2 second filename suffix
2463 FILE *vcg_open(const ir_graph *irg, const char *suffix1, const char *suffix2)
2466 const char *nm = get_irg_dump_name(irg);
2467 int len = strlen(nm), i, j;
2468 char *fname; /* filename to put the vcg information in */
2470 if (!suffix1) suffix1 = "";
2471 if (!suffix2) suffix2 = "";
2473 /* open file for vcg graph */
2474 fname = XMALLOCN(char, len * 2 + strlen(suffix1) + strlen(suffix2) + 5);
2476 /* strncpy (fname, nm, len); */ /* copy the filename */
2478 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2480 fname[j] = '@'; j++; fname[j] = '1'; j++;
2481 } else if (nm[i] == '@') {
2482 fname[j] = '@'; j++; fname[j] = '2'; j++;
2484 fname[j] = nm[i]; j++;
2488 strcat(fname, suffix1); /* append file suffix */
2489 strcat(fname, suffix2); /* append file suffix */
2490 strcat(fname, ".vcg"); /* append the .vcg suffix */
2492 /* vcg really expect only a <CR> at end of line, so
2493 * the "b"inary mode is what you mean (and even needed for Win32)
2495 F = fopen(fname, "wb"); /* open file for writing */
2507 * @param name prefix file name
2508 * @param suffix filename suffix
2510 FILE *vcg_open_name(const char *name, const char *suffix)
2513 char *fname; /* filename to put the vcg information in */
2514 int i, j, len = strlen(name);
2516 if (!suffix) suffix = "";
2518 /** open file for vcg graph */
2519 fname = XMALLOCN(char, len * 2 + 5 + strlen(suffix));
2520 /* strcpy (fname, name);*/ /* copy the filename */
2522 for (i = 0; i < len; ++i) { /* replace '/' in the name: escape by @. */
2523 if (name[i] == '/') {
2524 fname[j] = '@'; j++; fname[j] = '1'; j++;
2525 } else if (name[i] == '@') {
2526 fname[j] = '@'; j++; fname[j] = '2'; j++;
2528 fname[j] = name[i]; j++;
2532 strcat(fname, suffix);
2533 strcat(fname, ".vcg"); /* append the .vcg suffix */
2535 /* vcg really expect only a <CR> at end of line, so
2536 * the "b"inary mode is what you mean (and even needed for Win32)
2538 F = fopen(fname, "wb"); /* open file for writing */
2548 * Dumps the vcg file footer
2550 void dump_vcg_footer(FILE *F)
2555 /************************************************************************/
2556 /************************************************************************/
2557 /* Routines that dump all or parts of the firm representation to a file */
2558 /************************************************************************/
2559 /************************************************************************/
2561 /************************************************************************/
2562 /* Dump ir graphs, different formats and additional information. */
2563 /************************************************************************/
2565 typedef void (*do_dump_graph_func) (ir_graph *irg, FILE *out);
2567 static void do_dump(ir_graph *irg, const char *suffix, const char *suffix_ip,
2568 const char *suffix_nonip, do_dump_graph_func dump_func)
2572 const char *suffix1;
2574 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2577 rem = current_ir_graph;
2578 current_ir_graph = irg;
2579 if (get_interprocedural_view())
2580 suffix1 = suffix_ip;
2582 suffix1 = suffix_nonip;
2583 current_ir_graph = rem;
2585 out = vcg_open(irg, suffix, suffix1);
2587 dump_func(irg, out);
2592 void dump_ir_graph_file(ir_graph *irg, FILE *out)
2594 if (dump_backedge_information_flag
2595 && get_irg_loopinfo_state(irg) != loopinfo_consistent) {
2596 construct_backedges(irg);
2599 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2601 /* call the dump graph hook */
2602 if (dump_ir_graph_hook) {
2603 if (dump_ir_graph_hook(out, irg)) {
2608 /* walk over the graph */
2609 /* dump_whole_node must be called in post visiting predecessors */
2610 ird_walk_graph(irg, NULL, dump_whole_node, out);
2612 /* dump the out edges in a separate walk */
2613 if ((dump_out_edge_flag) && (get_irg_outs_state(irg) != outs_none)) {
2614 irg_out_walk(get_irg_start(irg), dump_out_edge, NULL, out);
2617 dump_vcg_footer(out);
2620 /** Routine to dump a graph, blocks as conventional nodes. */
2621 void dump_ir_graph(ir_graph *irg, const char *suffix )
2623 do_dump(irg, suffix, "-pure-ip", "-pure", dump_ir_graph_file);
2626 void dump_ir_block_graph_file(ir_graph *irg, FILE *out)
2630 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2632 construct_block_lists(irg);
2635 * If we are in the interprocedural view, we dump not
2636 * only the requested irg but also all irgs that can be reached
2639 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2640 ir_graph *g = get_irp_irg(i);
2641 ir_node **arr = ird_get_irg_link(g);
2643 dump_graph_from_list(out, g);
2648 dump_vcg_footer(out);
2651 /* Dump a firm graph without explicit block nodes. */
2652 void dump_ir_block_graph(ir_graph *irg, const char *suffix)
2654 do_dump(irg, suffix, "-ip", "", dump_ir_block_graph_file);
2657 void dump_ir_extblock_graph_file(ir_graph *irg, FILE *F)
2660 ir_entity *ent = get_irg_entity(irg);
2662 if (get_irg_extblk_state(irg) != extblk_valid)
2665 dump_vcg_header(F, get_irg_dump_name(irg), NULL, NULL);
2667 construct_extblock_lists(irg);
2669 fprintf(F, "graph: { title: \"");
2671 fprintf(F, "\" label: \"%s\" status:clustered color: white \n",
2672 get_ent_dump_name(ent));
2674 dump_graph_info(F, irg);
2675 print_dbg_info(F, get_entity_dbg_info(ent));
2677 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2678 ir_graph *irg = get_irp_irg(i);
2679 list_tuple *lists = ird_get_irg_link(irg);
2682 /* dump the extended blocks first */
2683 if (ARR_LEN(lists->extbb_list)) {
2684 ird_set_irg_link(irg, lists->extbb_list);
2685 dump_extblock_graph(F, irg);
2688 /* we may have blocks without extended blocks, bad for instance */
2689 if (ARR_LEN(lists->blk_list)) {
2690 ird_set_irg_link(irg, lists->blk_list);
2691 dump_block_graph(F, irg);
2694 DEL_ARR_F(lists->extbb_list);
2695 DEL_ARR_F(lists->blk_list);
2700 /* Close the vcg information for the irg */
2701 fprintf(F, "}\n\n");
2707 /* Dump a firm graph without explicit block nodes but grouped in extended blocks. */
2708 void dump_ir_extblock_graph(ir_graph *irg, const char *suffix)
2710 do_dump(irg, suffix, "-ip", "", dump_ir_extblock_graph_file);
2713 void dump_ir_graph_w_types_file(ir_graph *irg, FILE *out)
2715 ir_graph *rem = current_ir_graph;
2716 int rem_dump_const_local;
2718 rem = current_ir_graph;
2719 current_ir_graph = irg;
2720 rem_dump_const_local = dump_const_local;
2721 /* dumping types does not work with local nodes */
2722 dump_const_local = 0;
2724 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2726 /* dump common ir graph */
2727 irg_walk(get_irg_end(irg), NULL, dump_whole_node, out);
2728 /* dump type info */
2729 type_walk_irg(irg, dump_type_info, NULL, out);
2730 inc_irg_visited(get_const_code_irg());
2731 /* dump edges from graph to type info */
2732 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2734 dump_vcg_footer(out);
2735 dump_const_local = rem_dump_const_local;
2736 current_ir_graph = rem;
2739 /* dumps a graph with type information */
2740 void dump_ir_graph_w_types(ir_graph *irg, const char *suffix)
2742 do_dump(irg, suffix, "-pure-wtypes-ip", "-pure-wtypes",
2743 dump_ir_graph_w_types_file);
2746 void dump_ir_block_graph_w_types_file(ir_graph *irg, FILE *out)
2749 int rem_dump_const_local;
2750 ir_graph *rem = current_ir_graph;
2752 rem_dump_const_local = dump_const_local;
2753 /* dumping types does not work with local nodes */
2754 dump_const_local = 0;
2756 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2758 /* dump common blocked ir graph */
2759 construct_block_lists(irg);
2761 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2762 ir_node **arr = ird_get_irg_link(get_irp_irg(i));
2764 dump_graph_from_list(out, get_irp_irg(i));
2769 /* dump type info */
2770 current_ir_graph = irg;
2771 type_walk_irg(irg, dump_type_info, NULL, out);
2772 inc_irg_visited(get_const_code_irg());
2774 /* dump edges from graph to type info */
2775 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2777 dump_vcg_footer(out);
2778 dump_const_local = rem_dump_const_local;
2779 current_ir_graph = rem;
2782 void dump_ir_block_graph_w_types(ir_graph *irg, const char *suffix)
2784 do_dump(irg, suffix, "-wtypes-ip", "-wtypes",
2785 dump_ir_block_graph_w_types_file);
2788 /*---------------------------------------------------------------------*/
2789 /* The following routines dump a control flow graph. */
2790 /*---------------------------------------------------------------------*/
2793 dump_block_to_cfg(ir_node *block, void *env)
2799 if (is_Block(block)) {
2800 /* This is a block. Dump a node for the block. */
2801 fprintf(F, "node: {title: \""); PRINT_NODEID(block);
2802 fprintf(F, "\" label: \"");
2803 if (block == get_irg_start_block(get_irn_irg(block)))
2804 fprintf(F, "Start ");
2805 if (block == get_irg_end_block(get_irn_irg(block)))
2808 fprintf(F, "%s ", get_op_name(get_irn_op(block)));
2809 PRINT_NODEID(block);
2811 fprintf(F, "info1:\"");
2813 /* the generic version. */
2814 dump_irnode_to_file(F, block);
2816 /* Check whether we have bad predecessors to color the block. */
2817 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
2818 if ((fl = is_Bad(get_Block_cfgpred(block, i))))
2821 fprintf(F, "\""); /* closing quote of info */
2823 if ((block == get_irg_start_block(get_irn_irg(block))) ||
2824 (block == get_irg_end_block(get_irn_irg(block))) )
2825 fprintf(F, " color:blue ");
2827 fprintf(F, " color:yellow ");
2830 /* Dump the edges */
2831 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
2832 if (!is_Bad(skip_Proj(get_Block_cfgpred(block, i)))) {
2833 pred = get_nodes_block(skip_Proj(get_Block_cfgpred(block, i)));
2834 fprintf(F, "edge: { sourcename: \"");
2835 PRINT_NODEID(block);
2836 fprintf(F, "\" targetname: \"");
2838 fprintf(F, "\"}\n");
2841 /* Dump dominator/postdominator edge */
2842 if (dump_dominator_information_flag) {
2843 if (get_irg_dom_state(current_ir_graph) == dom_consistent && get_Block_idom(block)) {
2844 pred = get_Block_idom(block);
2845 fprintf(F, "edge: { sourcename: \"");
2846 PRINT_NODEID(block);
2847 fprintf(F, "\" targetname: \"");
2849 fprintf(F, "\" " DOMINATOR_EDGE_ATTR "}\n");
2851 if (get_irg_postdom_state(current_ir_graph) == dom_consistent && get_Block_ipostdom(block)) {
2852 pred = get_Block_ipostdom(block);
2853 fprintf(F, "edge: { sourcename: \"");
2854 PRINT_NODEID(block);
2855 fprintf(F, "\" targetname: \"");
2857 fprintf(F, "\" " POSTDOMINATOR_EDGE_ATTR "}\n");
2863 void dump_cfg(ir_graph *irg, const char *suffix)
2866 /* if a filter is set, dump only the irg's that match the filter */
2867 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
2870 f = vcg_open(irg, suffix, "-cfg");
2872 ir_graph *rem = current_ir_graph;
2873 #ifdef INTERPROCEDURAL_VIEW
2874 int ipv = get_interprocedural_view();
2877 current_ir_graph = irg;
2878 dump_vcg_header(f, get_irg_dump_name(irg), NULL, NULL);
2880 #ifdef INTERPROCEDURAL_VIEW
2882 printf("Warning: dumping cfg not in interprocedural view!\n");
2883 set_interprocedural_view(0);
2887 /* walk over the blocks in the graph */
2888 irg_block_walk(get_irg_end(irg), dump_block_to_cfg, NULL, f);
2889 dump_node(f, get_irg_bad(irg));
2891 #ifdef INTERPROCEDURAL_VIEW
2892 set_interprocedural_view(ipv);
2896 current_ir_graph = rem;
2901 static void descend_and_dump(FILE *F, ir_node *n, int depth, pset *mark_set)
2903 if (pset_find_ptr(mark_set, n))
2906 pset_insert_ptr(mark_set, n);
2909 int i, start = is_Block(n) ? 0 : -1;
2910 dump_whole_node(n, F);
2911 for (i = start; i < get_irn_arity(n); ++i)
2912 descend_and_dump(F, get_irn_n(n, i), depth-1, mark_set);
2915 /* Don't dump edges to nodes further out. These might be edges to
2916 nodes we already dumped, if there is a shorter path to these. */
2920 static int subgraph_counter = 0;
2921 void dump_subgraph(ir_node *root, int depth, const char *suffix)
2926 sprintf(buf, "-subg_%03d", subgraph_counter++);
2927 F = vcg_open(get_irn_irg(root), suffix, buf);
2929 pset *mark_set = pset_new_ptr(1);
2930 dump_vcg_header(F, get_irg_dump_name(get_irn_irg(root)), NULL, NULL);
2931 descend_and_dump(F, root, depth, mark_set);
2938 void dump_callgraph(const char *suffix)
2940 FILE *F = vcg_open_name("Callgraph", suffix);
2943 int i, rem = edge_label;
2946 dump_vcg_header(F, "Callgraph", "Hierarchiv", NULL);
2948 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2949 ir_graph *irg = get_irp_irg(i);
2950 ir_entity *ent = get_irg_entity(irg);
2952 int n_callees = get_irg_n_callees(irg);
2954 dump_entity_node(F, ent);
2955 for (j = 0; j < n_callees; ++j) {
2956 ir_entity *c = get_irg_entity(get_irg_callee(irg, j));
2957 //if (id_is_prefix(prefix, get_entity_ld_ident(c))) continue;
2958 int be = is_irg_callee_backedge(irg, j);
2961 "label:\"recursion %d\"" :
2962 "label:\"calls %d\"";
2963 print_ent_ent_edge(F, ent, c, be, ird_color_entity, attr, get_irg_callee_loop_depth(irg, j));
2974 /* Dump all irgs in interprocedural view to a single file. */
2975 void dump_all_cg_block_graph(const char *suffix)
2977 FILE *f = vcg_open_name("All_graphs", suffix);
2981 int rem_view = get_interprocedural_view();
2983 set_interprocedural_view(1);
2984 dump_vcg_header(f, "All_graphs", NULL);
2986 /* collect nodes in all irgs reachable in call graph*/
2987 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
2988 ird_set_irg_link(get_irp_irg(i), NULL);
2990 cg_walk(clear_link, collect_node, NULL);
2992 /* dump all graphs */
2993 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
2994 current_ir_graph = get_irp_irg(i);
2995 assert(ird_get_irg_link(current_ir_graph));
2996 dump_graph_from_list(f, current_ir_graph);
2997 DEL_ARR_F(ird_get_irg_link(current_ir_graph));
3002 set_interprocedural_view(rem_view);
3007 /*---------------------------------------------------------------------*/
3008 /* the following routines dumps type information without any ir nodes. */
3009 /*---------------------------------------------------------------------*/
3012 dump_type_graph(ir_graph *irg, const char *suffix)
3016 /* if a filter is set, dump only the irg's that match the filter */
3017 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg)))) return;
3019 f = vcg_open(irg, suffix, "-type");
3021 ir_graph *rem = current_ir_graph;
3022 current_ir_graph = irg;
3024 dump_vcg_header(f, get_irg_dump_name(irg), "Hierarchic", NULL);
3026 /* walk over the blocks in the graph */
3027 type_walk_irg(irg, dump_type_info, NULL, f);
3028 /* The walker for the const code can be called several times for the
3029 same (sub) expression. So that no nodes are dumped several times
3030 we decrease the visited flag of the corresponding graph after each
3031 walk. So now increase it finally. */
3032 inc_irg_visited(get_const_code_irg());
3036 current_ir_graph = rem;
3041 dump_all_types(const char *suffix)
3043 FILE *f = vcg_open_name("All_types", suffix);
3045 dump_vcg_header(f, "All_types", "Hierarchic", NULL);
3046 type_walk(dump_type_info, NULL, f);
3047 inc_irg_visited(get_const_code_irg());
3055 dump_class_hierarchy(int entities, const char *suffix)
3057 FILE *f = vcg_open_name("class_hierarchy", suffix);
3062 env.dump_ent = entities;
3063 dump_vcg_header(f, "class_hierarchy", "Hierarchic", NULL);
3064 type_walk(dump_class_hierarchy_node, NULL, &env);
3071 /*---------------------------------------------------------------------*/
3072 /* dumps all graphs with the graph-dumper passed. Possible dumpers: */
3074 /* dump_ir_block_graph */
3076 /* dump_type_graph */
3077 /* dump_ir_graph_w_types */
3078 /*---------------------------------------------------------------------*/
3080 void dump_all_ir_graphs(dump_graph_func *dmp_grph, const char *suffix)
3083 for (i = get_irp_n_irgs() - 1; i >= 0; --i)
3084 dmp_grph(get_irp_irg(i), suffix);
3088 ir_prog_pass_t pass;
3089 dump_graph_func *dump_graph;
3094 * Wrapper around dump_all_ir_graphs().
3096 static int dump_all_ir_graphs_wrapper(ir_prog *irp, void *context)
3098 struct pass_t *pass = context;
3101 dump_all_ir_graphs(pass->dump_graph, pass->suffix);
3105 ir_prog_pass_t *dump_all_ir_graph_pass(
3106 const char *name, dump_graph_func *dump_graph, const char *suffix) {
3107 size_t len = strlen(suffix);
3108 struct pass_t *pass = xmalloc(sizeof(*pass) + len);
3109 ir_prog_pass_t *res = def_prog_pass_constructor(
3110 &pass->pass, name ? name : "dump_all_graphs", dump_all_ir_graphs_wrapper);
3112 /* this pass does not change anything, so neither dump nor verify is needed. */
3113 res->dump_irprog = ir_prog_no_dump;
3114 res->verify_irprog = ir_prog_no_verify;
3116 pass->dump_graph = dump_graph;
3117 strcpy(pass->suffix, suffix);
3122 /*--------------------------------------------------------------------------------*
3123 * Dumps a stand alone loop graph with firm nodes which belong to one loop node *
3124 * packed together in one subgraph/box *
3125 *--------------------------------------------------------------------------------*/
3127 void dump_loops_standalone(FILE *F, ir_loop *loop)
3129 int i = 0, loop_node_started = 0, son_number = 0, first = 0;
3131 ir_loop *son = NULL;
3133 /* Dump a new loop node. */
3134 dump_loop_node(F, loop);
3136 /* Dump the loop elements. */
3137 for (i = 0; i < get_loop_n_elements(loop); i++) {
3138 le = get_loop_element(loop, i);
3140 if (get_kind(son) == k_ir_loop) {
3142 /* We are a loop son -> Recurse */
3144 if (loop_node_started) { /* Close the "firm-nodes" node first if we started one. */
3145 fprintf(F, "\" }\n");
3146 fprintf(F, "edge: {sourcename: \"");
3148 fprintf(F, "\" targetname: \"");
3150 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3151 loop_node_started = 0;
3153 dump_loop_son_edge(F, loop, son_number++);
3154 dump_loops_standalone(F, son);
3155 } else if (get_kind(son) == k_ir_node) {
3156 /* We are a loop node -> Collect firm nodes */
3158 ir_node *n = le.node;
3161 if (!loop_node_started) {
3162 /* Start a new node which contains all firm nodes of the current loop */
3163 fprintf(F, "node: { title: \"");
3165 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3166 loop_node_started = 1;
3171 bad |= dump_node_label(F, n);
3172 /* Causes indeterministic output: if (is_Block(n)) fprintf(F, "\t ->%d", (int)get_irn_link(n)); */
3173 if (has_backedges(n)) fprintf(F, "\t loop head!");
3174 } else { /* for callgraph loop tree */
3176 assert(get_kind(son) == k_ir_graph);
3178 /* We are a loop node -> Collect firm graphs */
3180 if (!loop_node_started) {
3181 /* Start a new node which contains all firm nodes of the current loop */
3182 fprintf(F, "node: { title: \"");
3184 fprintf(F, "-%d-nodes\" color: lightyellow label: \"", i);
3185 loop_node_started = 1;
3189 fprintf(F, " %s", get_irg_dump_name(n));
3190 /* fprintf(F, " %s (depth %d)", get_irg_dump_name(n), n->callgraph_weighted_loop_depth); */
3194 if (loop_node_started) {
3195 fprintf(F, "\" }\n");
3196 fprintf(F, "edge: {sourcename: \"");
3198 fprintf(F, "\" targetname: \"");
3200 fprintf(F, "-%d-nodes\" label:\"%d...%d\"}\n", first, first, i-1);
3201 loop_node_started = 0;
3205 void dump_loop_tree(ir_graph *irg, const char *suffix)
3209 /* if a filter is set, dump only the irg's that match the filter */
3210 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
3213 f = vcg_open(irg, suffix, "-looptree");
3215 ir_graph *rem = current_ir_graph;
3216 int el_rem = edge_label;
3218 current_ir_graph = irg;
3221 dump_vcg_header(f, get_irg_dump_name(irg), "Tree", "top_to_bottom");
3223 if (get_irg_loop(irg))
3224 dump_loops_standalone(f, get_irg_loop(irg));
3229 edge_label = el_rem;
3230 current_ir_graph = rem;
3234 void dump_callgraph_loop_tree(const char *suffix)
3237 F = vcg_open_name("Callgraph_looptree", suffix);
3238 dump_vcg_header(F, "callgraph looptree", "Tree", "top_to_bottom");
3239 dump_loops_standalone(F, irp->outermost_cg_loop);
3245 /*----------------------------------------------------------------------------*/
3246 /* Dumps the firm nodes in the loop tree to a graph along with the loop nodes.*/
3247 /*----------------------------------------------------------------------------*/
3249 void collect_nodeloop(FILE *F, ir_loop *loop, eset *loopnodes)
3251 int i, son_number = 0, node_number = 0;
3253 if (dump_loop_information_flag) dump_loop_node(F, loop);
3255 for (i = 0; i < get_loop_n_elements(loop); i++) {
3256 loop_element le = get_loop_element(loop, i);
3257 if (*(le.kind) == k_ir_loop) {
3258 if (dump_loop_information_flag) dump_loop_son_edge(F, loop, son_number++);
3260 collect_nodeloop(F, le.son, loopnodes);
3262 if (dump_loop_information_flag) dump_loop_node_edge(F, loop, node_number++);
3263 eset_insert(loopnodes, le.node);
3268 void collect_nodeloop_external_nodes(ir_loop *loop, eset *loopnodes, eset *extnodes)
3272 for(i = 0; i < get_loop_n_elements(loop); i++) {
3273 loop_element le = get_loop_element(loop, i);
3274 if (*(le.kind) == k_ir_loop) {
3276 collect_nodeloop_external_nodes(le.son, loopnodes, extnodes);
3278 if (is_Block(le.node)) start = 0; else start = -1;
3279 for (j = start; j < get_irn_arity(le.node); j++) {
3280 ir_node *pred = get_irn_n(le.node, j);
3281 if (!eset_contains(loopnodes, pred)) {
3282 eset_insert(extnodes, pred);
3283 if (!is_Block(pred)) {
3284 pred = get_nodes_block(pred);
3285 if (!eset_contains(loopnodes, pred)) eset_insert(extnodes, pred);
3293 void dump_loop(ir_loop *l, const char *suffix)
3298 snprintf(name, sizeof(name), "loop_%d", get_loop_loop_nr(l));
3299 F = vcg_open_name(name, suffix);
3301 eset *loopnodes = eset_create();
3302 eset *extnodes = eset_create();
3305 dump_vcg_header(F, name, NULL, NULL);
3307 /* collect all nodes to dump */
3308 collect_nodeloop(F, l, loopnodes);
3309 collect_nodeloop_external_nodes(l, loopnodes, extnodes);
3311 /* build block lists */
3312 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes))
3313 set_irn_link(n, NULL);
3314 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes))
3315 set_irn_link(n, NULL);
3316 for (n = eset_first(loopnodes); n != NULL; n = eset_next(loopnodes)) {
3318 b = get_nodes_block(n);
3319 set_irn_link(n, get_irn_link(b));
3323 for (n = eset_first(extnodes); n != NULL; n = eset_next(extnodes)) {
3325 b = get_nodes_block(n);
3326 set_irn_link(n, get_irn_link(b));
3331 for (b = eset_first(loopnodes); b != NULL; b = eset_next(loopnodes)) {
3333 fprintf(F, "graph: { title: \"");
3335 fprintf(F, "\" label: \"");
3336 dump_node_opcode(F, b);
3337 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3338 fprintf(F, "\" status:clustered color:yellow\n");
3340 /* dump the blocks edges */
3341 dump_ir_data_edges(F, b);
3343 /* dump the nodes that go into the block */
3344 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3345 if (eset_contains(extnodes, n))
3346 overrule_nodecolor = ird_color_block_inout;
3348 overrule_nodecolor = ird_color_default_node;
3349 if (!eset_contains(extnodes, n)) dump_ir_data_edges(F, n);
3352 /* Close the vcg information for the block */
3354 dump_const_node_local(F, b);
3358 for (b = eset_first(extnodes); b != NULL; b = eset_next(extnodes)) {
3360 fprintf(F, "graph: { title: \"");
3362 fprintf(F, "\" label: \"");
3363 dump_node_opcode(F, b);
3364 fprintf(F, " %ld:%d", get_irn_node_nr(b), get_irn_idx(b));
3365 fprintf(F, "\" status:clustered color:lightblue\n");
3367 /* dump the nodes that go into the block */
3368 for (n = get_irn_link(b); n; n = get_irn_link(n)) {
3369 if (!eset_contains(loopnodes, n))
3370 overrule_nodecolor = ird_color_block_inout;
3372 overrule_nodecolor = ird_color_default_node;
3373 if (eset_contains(loopnodes, n)) dump_ir_data_edges(F, n);
3376 /* Close the vcg information for the block */
3378 dump_const_node_local(F, b);
3382 eset_destroy(loopnodes);
3383 eset_destroy(extnodes);