2 * Copyright (C) 1995-2011 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Write vcg representation of firm to file.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Hubert Schmidt,
38 #include "irgraph_t.h"
52 #include "callgraph.h"
54 #include "dbginfo_t.h"
67 typedef struct pns_lookup {
68 long nr; /**< the proj number */
69 const char *name; /**< the name of the Proj */
72 typedef struct proj_lookup {
73 unsigned code; /**< the opcode of the Proj predecessor */
74 unsigned num_data; /**< number of data entries */
75 const pns_lookup_t *data; /**< the data */
78 #include "gen_irdump.c.inl"
80 /** Dump only irgs with names that start with this prefix. */
81 static ident *dump_file_filter_id = NULL;
83 static ir_dump_flags_t flags =
84 ir_dump_flag_blocks_as_subgraphs |
85 ir_dump_flag_keepalive_edges |
86 ir_dump_flag_ld_names |
87 ir_dump_flag_back_edges |
88 ir_dump_flag_consts_local |
89 ir_dump_flag_analysed_types |
90 ir_dump_flag_entities_in_hierarchy |
91 ir_dump_flag_number_label;
93 static ird_color_t overrule_nodecolor = ird_color_default_node;
95 /** The vcg node attribute hook. */
96 static dump_node_vcgattr_func dump_node_vcgattr_hook = NULL;
97 /** The vcg edge attribute hook. */
98 static dump_edge_vcgattr_func dump_edge_vcgattr_hook = NULL;
99 /** The vcg dump block edge hook */
100 static dump_node_edge_func dump_block_edge_hook = NULL;
101 /** The vcg dump node edge hook. */
102 static dump_node_edge_func dump_node_edge_hook = NULL;
104 void set_dump_node_edge_hook(dump_node_edge_func func)
106 dump_node_edge_hook = func;
109 dump_node_edge_func get_dump_node_edge_hook(void)
111 return dump_node_edge_hook;
114 void set_dump_block_edge_hook(dump_node_edge_func func)
116 dump_block_edge_hook = func;
119 dump_node_edge_func get_dump_block_edge_hook(void)
121 return dump_node_edge_hook;
124 void set_dump_node_vcgattr_hook(dump_node_vcgattr_func hook)
126 dump_node_vcgattr_hook = hook;
129 void set_dump_edge_vcgattr_hook(dump_edge_vcgattr_func hook)
131 dump_edge_vcgattr_hook = hook;
134 void ir_set_dump_flags(ir_dump_flags_t new_flags)
139 void ir_add_dump_flags(ir_dump_flags_t new_flags)
144 void ir_remove_dump_flags(ir_dump_flags_t to_remove)
149 ir_dump_flags_t ir_get_dump_flags(void)
154 /** Returns 0 if dump_out_edge_flag or dump_loop_information_flag
155 * are set, else returns dump_const_local_flag.
157 static bool get_opt_dump_const_local(void)
159 return (flags & ir_dump_flag_out_edges)
160 || (flags & ir_dump_flag_loops)
161 || (flags & ir_dump_flag_consts_local)
162 || (flags & ir_dump_flag_iredges);
165 static char *dump_filter;
167 void ir_set_dump_filter(const char *new_filter)
170 dump_filter = xstrdup(new_filter);
173 const char *ir_get_dump_filter(void)
178 int ir_should_dump(const char *name)
182 if (dump_filter == NULL || dump_filter[0] == '\0')
185 for (n = name, f = dump_filter; *f != '\0' && *n != '\0';
193 /* -------------- some extended helper functions ----------------- */
195 const char *get_mode_name_ex(const ir_mode *mode, int *bad)
198 return get_mode_name(mode);
204 #define CUSTOM_COLOR_BASE 100
205 static const char *color_names[ird_color_count];
206 static const char *color_rgb[ird_color_count];
207 static struct obstack color_obst;
209 /** define a custom color. */
210 static void custom_color(int num, const char *rgb_def)
212 assert(num < ird_color_count);
213 obstack_printf(&color_obst, "%d", CUSTOM_COLOR_BASE + num);
214 obstack_1grow(&color_obst, '\0');
216 color_rgb[num] = rgb_def;
217 color_names[num] = (const char*)obstack_finish(&color_obst);
220 /** Define a named color. */
221 static void named_color(int num, const char *name)
223 assert(num < ird_color_count);
224 color_rgb[num] = NULL;
225 color_names[num] = name;
228 /** Initializes the used colors. */
229 static void init_colors(void)
231 static bool initialized = 0;
235 obstack_init(&color_obst);
237 custom_color(ird_color_prog_background, "204 204 204");
238 custom_color(ird_color_block_background, "255 255 0");
239 custom_color(ird_color_dead_block_background, "190 150 150");
240 named_color(ird_color_block_inout, "lightblue");
241 named_color(ird_color_default_node, "white");
242 custom_color(ird_color_memory, "153 153 255");
243 custom_color(ird_color_controlflow, "255 153 153");
244 custom_color(ird_color_const, "204 255 255");
245 custom_color(ird_color_proj, "255 255 153");
246 custom_color(ird_color_uses_memory, "153 153 255");
247 custom_color(ird_color_phi, "105 255 105");
248 custom_color(ird_color_anchor, "100 100 255");
249 named_color(ird_color_error, "red");
250 custom_color(ird_color_entity, "204 204 255");
256 * Prints the VCG color to a file.
258 static void print_vcg_color(FILE *out, ird_color_t color)
260 assert(color < ird_color_count);
261 fprintf(out, "color:%s", color_names[color]);
264 void print_nodeid(FILE *F, const ir_node *node)
266 fprintf(F, "\"n%ld\"", get_irn_node_nr(node));
269 void print_irgid(FILE *F, const ir_graph *irg)
271 fprintf(F, "\"g%ld\"", get_irg_graph_nr(irg));
274 void print_typeid(FILE *F, const ir_type *type)
276 fprintf(F, "\"t%ld\"", get_type_nr(type));
279 void print_entityid(FILE *F, const ir_entity *entity)
281 fprintf(F, "\"e%ld\"", get_entity_nr(entity));
284 static void print_itemid(FILE *F, const ir_type *tp, size_t itemnr)
286 fprintf(F, "\"i%ldT%zu\"", get_type_nr(tp), itemnr);
290 * Prints the edge kind of a given IR node.
292 * Projs should be dumped near their predecessor, so they get "nearedge".
294 static void print_node_edge_kind(FILE *out, const ir_node *node)
297 fprintf(out, "nearedge: ");
299 fprintf(out, "edge: ");
304 * Prints the edge from a type S to a type T with additional info fmt, ...
307 static void print_type_type_edge(FILE *F, const ir_type *S, const ir_type *T, const char *fmt, ...)
312 fprintf(F, "edge: { sourcename: ");
314 fprintf(F, " targetname: ");
316 ir_vfprintf(F, fmt, ap);
322 * Prints the edge from a type tp to an entity ent with additional info fmt, ...
325 static void print_type_ent_edge(FILE *F, const ir_type *tp, const ir_entity *ent, const char *fmt, ...)
330 fprintf(F, "edge: { sourcename: ");
332 fprintf(F, " targetname: ");
333 print_entityid(F, ent);
334 ir_vfprintf(F, fmt, ap);
340 * Prints the edge from an entity ent1 to an entity ent2 with additional info fmt, ...
343 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, ...)
349 fprintf(F, "backedge: { sourcename: ");
351 fprintf(F, "edge: { sourcename: ");
352 print_entityid(F, ent1);
353 fprintf(F, " targetname: ");
354 print_entityid(F, ent2);
355 ir_vfprintf(F, fmt, ap);
357 if (color != ird_color_none)
358 print_vcg_color(F, color);
364 * Prints the edge from an entity ent to a type tp with additional info fmt, ...
367 static void print_ent_type_edge(FILE *F, const ir_entity *ent, const ir_type *tp, const char *fmt, ...)
372 fprintf(F, "edge: { sourcename: ");
373 print_entityid(F, ent);
374 fprintf(F, " targetname: ");
376 ir_vfprintf(F, fmt, ap);
382 * Prints the edge from a node irn to a type tp with additional info fmt, ...
385 static void print_node_type_edge(FILE *F, const ir_node *irn, ir_type *tp, const char *fmt, ...)
390 fprintf(F, "edge: { sourcename: ");
391 print_nodeid(F, irn);
392 fprintf(F, " targetname: ");
394 ir_vfprintf(F, fmt, ap);
400 * Prints the edge from a node irn to an entity ent with additional info fmt, ...
403 static void print_node_ent_edge(FILE *F, const ir_node *irn, const ir_entity *ent, const char *fmt, ...)
408 fprintf(F, "edge: { sourcename: ");
409 print_nodeid(F, irn);
410 fprintf(F, " targetname: ");
411 print_entityid(F, ent);
412 ir_vfprintf(F, fmt, ap);
418 * Prints the edge from a type tp to an enumeration item item with additional info fmt, ...
421 static void print_enum_item_edge(FILE *F, const ir_type *tp, size_t item, const char *fmt, ...)
426 fprintf(F, "edge: { sourcename: ");
428 fprintf(F, " targetname: ");
429 print_itemid(F, tp, item);
430 ir_vfprintf(F, fmt, ap);
435 /*-----------------------------------------------------------------*/
436 /* global and ahead declarations */
437 /*-----------------------------------------------------------------*/
439 static void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg);
441 /*-----------------------------------------------------------------*/
442 /* Helper functions. */
443 /*-----------------------------------------------------------------*/
446 * This map is used as a private link attr to be able to call dumper
447 * anywhere without destroying link fields.
449 static pmap *irdump_link_map = NULL;
451 /** NOT A STANDARD LIBFIRM INIT METHOD
453 * We do not want to integrate dumping into libfirm, i.e., if the dumpers
454 * are off, we want to have as few interferences as possible. Therefore the
455 * initialization is performed lazily and not called from within init_firm.
457 * Creates the link attribute map. */
458 static void init_irdump(void)
460 /* We need a new, empty map. */
461 if (irdump_link_map) pmap_destroy(irdump_link_map);
462 irdump_link_map = pmap_create();
463 if (!dump_file_filter_id)
464 dump_file_filter_id = new_id_from_str("");
468 * Returns the private link field.
470 static void *ird_get_irn_link(const ir_node *n)
472 if (irdump_link_map == NULL)
475 return pmap_get(void, irdump_link_map, n);
479 * Sets the private link field.
481 static void ird_set_irn_link(const ir_node *n, void *x)
483 if (irdump_link_map == NULL)
485 pmap_insert(irdump_link_map, n, x);
489 * Gets the private link field of an irg.
491 static void *ird_get_irg_link(const ir_graph *irg)
493 if (irdump_link_map == NULL)
496 return pmap_get(void, irdump_link_map, irg);
500 * Sets the private link field of an irg.
502 static void ird_set_irg_link(const ir_graph *irg, void *x)
504 if (irdump_link_map == NULL)
506 pmap_insert(irdump_link_map, irg, x);
510 * Walker, clears the private link field.
512 static void clear_link(ir_node *node, void *env)
515 ird_set_irn_link(node, NULL);
519 * If the entity has a ld_name, returns it if the dump_ld_name is set,
520 * else returns the name of the entity.
522 static const char *get_ent_dump_name_(const ir_entity *ent, bool dump_ld_name)
525 return "<NULL entity>";
527 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
528 if (ent->ld_name != NULL)
529 return get_id_str(ent->ld_name);
531 return get_id_str(ent->name);
534 const char *get_ent_dump_name(const ir_entity *ent)
536 return get_ent_dump_name_(ent, flags & ir_dump_flag_ld_names);
539 const char *get_irg_dump_name(const ir_graph *irg)
541 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
542 return get_ent_dump_name_(get_irg_entity(irg), true);
546 * Returns non-zero if a node is in floating state.
548 static int node_floats(const ir_node *n)
550 ir_graph *irg = get_irn_irg(n);
551 return ((get_irn_pinned(n) == op_pin_state_floats) &&
552 (get_irg_pinned(irg) == op_pin_state_floats));
556 * Walker that visits the anchors
558 static void ird_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env)
560 if ((flags & ir_dump_flag_all_anchors)
561 || ((flags & ir_dump_flag_iredges) && edges_activated(irg))) {
562 irg_walk_anchors(irg, pre, post, env);
564 irg_walk_graph(irg, pre, post, env);
569 * Walker, allocates an array for all blocks and puts their non-floating
570 * nodes into this array.
572 static void collect_node(ir_node *node, void *env)
577 || (get_op_flags(get_irn_op(node)) & irop_flag_dump_noblock)) {
578 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
579 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
580 ARR_APP1(ir_node *, arr, node);
581 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
583 ir_node * block = get_nodes_block(node);
586 /* this node is in a Bad block, so we must place it into the graph's list */
587 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
588 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
589 ARR_APP1(ir_node *, arr, node);
590 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
592 ird_set_irn_link(node, ird_get_irn_link(block));
593 ird_set_irn_link(block, node);
598 /** Construct lists to walk ir block-wise.
600 * Collects all blocks, nodes not op_pin_state_pinned,
601 * Bad, NoMem and Unknown into a flexible array in link field of
602 * irg they belong to. Sets the irg link field to NULL in all
603 * graphs not visited.
604 * Free the list with DEL_ARR_F().
606 static ir_node **construct_block_lists(ir_graph *irg)
609 int walk_flag = ir_resources_reserved(irg) & IR_RESOURCE_IRN_VISITED;
612 ir_free_resources(irg, IR_RESOURCE_IRN_VISITED);
615 for (i = get_irp_n_irgs(); i > 0;)
616 ird_set_irg_link(get_irp_irg(--i), NULL);
618 ird_walk_graph(irg, clear_link, collect_node, irg);
621 ir_reserve_resources(irg, IR_RESOURCE_IRN_VISITED);
624 return (ir_node**)ird_get_irg_link(irg);
627 void dump_node_opcode(FILE *F, const ir_node *n)
629 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
631 /* call the dump_node operation if available */
632 if (ops->dump_node) {
633 ops->dump_node(F, n, dump_node_opcode_txt);
637 /* implementation for default nodes */
638 switch (get_irn_opcode(n)) {
640 switch (get_SymConst_kind(n)) {
641 case symconst_addr_ent:
642 fprintf(F, "SymC &%s", get_entity_name(get_SymConst_entity(n)));
644 case symconst_ofs_ent:
645 fprintf(F, "SymC %s offset", get_entity_name(get_SymConst_entity(n)));
647 case symconst_type_size:
648 ir_fprintf(F, "SymC %+F size", get_SymConst_type(n));
650 case symconst_type_align:
651 ir_fprintf(F, "SymC %+F align", get_SymConst_type(n));
653 case symconst_enum_const:
654 fprintf(F, "SymC %s enum", get_enumeration_const_name(get_SymConst_enum(n)));
660 if (get_Load_unaligned(n) == align_non_aligned)
662 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Load_mode(n), NULL));
665 if (get_Store_unaligned(n) == align_non_aligned)
667 fprintf(F, "%s", get_irn_opname(n));
670 if (n == get_irg_start_block(get_irn_irg(n)))
672 if (n == get_irg_end_block(get_irn_irg(n)))
674 fprintf(F, "%s%s", get_irn_opname(n),
675 (flags & ir_dump_flag_show_marks) ? (get_Block_mark(n) ? "*" : "") : "");
678 if (get_Conv_strict(n))
679 fprintf(F, "strict");
680 fprintf(F, "%s", get_irn_opname(n));
683 fprintf(F, "%s", get_irn_opname(n));
684 if (get_Div_no_remainder(n))
686 fprintf(F, "[%s]", get_mode_name_ex(get_Div_resmode(n), NULL));
689 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Mod_resmode(n), NULL));
692 fprintf(F, "%s[%s]", get_irn_opname(n), get_builtin_kind_name(get_Builtin_kind(n)));
696 fprintf(F, "%s", get_irn_opname(n));
701 * Dump the mode of a node n to a file F.
702 * Ignore modes that are "always known".
704 static void dump_node_mode(FILE *F, const ir_node *n)
706 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
710 /* call the dump_node operation if available */
711 if (ops->dump_node) {
712 ops->dump_node(F, n, dump_node_mode_txt);
716 /* default implementation */
717 iro = get_irn_opcode(n);
729 mode = get_irn_mode(n);
731 if (mode != NULL && mode != mode_BB && mode != mode_ANY && mode != mode_BAD &&
732 (mode != mode_T || iro == iro_Proj))
733 fprintf(F, "%s", get_mode_name_ex(mode, NULL));
738 * Dump the type of a node n to a file F if it's known.
740 static int dump_node_typeinfo(FILE *F, const ir_node *n)
742 ir_graph *irg = get_irn_irg(n);
745 if (ir_get_dump_flags() & ir_dump_flag_analysed_types) {
746 if (get_irg_typeinfo_state(irg) == ir_typeinfo_consistent ||
747 get_irg_typeinfo_state(irg) == ir_typeinfo_inconsistent) {
748 ir_type *tp = get_irn_typeinfo_type(n);
749 if (tp != get_none_type()) {
750 ir_fprintf(F, "[%+F]", tp);
760 * Dump additional node attributes of some nodes to a file F.
762 static void dump_node_nodeattr(FILE *F, const ir_node *n)
767 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
769 /* call the dump_node operation if available */
770 if (ops->dump_node) {
771 ops->dump_node(F, n, dump_node_nodeattr_txt);
775 switch (get_irn_opcode(n)) {
777 ir_fprintf(F, "%T ", get_Const_tarval(n));
781 pred = get_Proj_pred(n);
782 proj_nr = get_Proj_proj(n);
783 code = get_irn_opcode(pred);
785 if (code == iro_Proj && get_irn_opcode(get_Proj_pred(pred)) == iro_Start)
786 fprintf(F, "Arg %ld ", proj_nr);
787 else if (code == iro_Cond && get_irn_mode(get_Cond_selector(pred)) != mode_b)
788 fprintf(F, "%ld ", proj_nr);
790 unsigned i, j, f = 0;
792 for (i = 0; i < ARRAY_SIZE(proj_lut); ++i) {
793 if (code == proj_lut[i].code) {
794 for (j = 0; j < proj_lut[i].num_data; ++j) {
795 if (proj_nr == proj_lut[i].data[j].nr) {
796 fprintf(F, "%s ", proj_lut[i].data[j].name);
805 fprintf(F, "%ld ", proj_nr);
806 if (code == iro_Cond && get_Cond_jmp_pred(pred) != COND_JMP_PRED_NONE) {
807 if (proj_nr == pn_Cond_false && get_Cond_jmp_pred(pred) == COND_JMP_PRED_FALSE)
809 if (proj_nr == pn_Cond_true && get_Cond_jmp_pred(pred) == COND_JMP_PRED_TRUE)
815 fprintf(F, "%s ", get_ent_dump_name(get_Sel_entity(n)));
818 ir_fprintf(F, "(%+F)", get_Cast_type(n));
821 fprintf(F, "%s ", get_relation_string(get_Cmp_relation(n)));
824 fprintf(F, "%s ", get_relation_string(get_Confirm_relation(n)));
827 ir_fprintf(F, "(%+F)", get_CopyB_type(n));
835 void dump_node_label(FILE *F, const ir_node *n)
837 dump_node_opcode(F, n);
839 dump_node_mode(F, n);
841 dump_node_typeinfo(F, n);
842 dump_node_nodeattr(F, n);
843 if (flags & ir_dump_flag_number_label) {
844 fprintf(F, "%ld", get_irn_node_nr(n));
846 if (flags & ir_dump_flag_idx_label) {
847 fprintf(F, ":%u", get_irn_idx(n));
852 * Dumps the attributes of a node n into the file F.
853 * Currently this is only the color of a node.
855 static void dump_node_vcgattr(FILE *F, const ir_node *node, const ir_node *local, bool bad)
861 print_vcg_color(F, ird_color_error);
865 if (dump_node_vcgattr_hook != NULL) {
866 dump_node_vcgattr_hook(F, node, local);
870 n = local ? local : node;
872 if (overrule_nodecolor != ird_color_default_node) {
873 print_vcg_color(F, overrule_nodecolor);
877 mode = get_irn_mode(n);
878 if (mode == mode_M) {
879 print_vcg_color(F, ird_color_memory);
882 if (mode == mode_X) {
883 print_vcg_color(F, ird_color_controlflow);
887 switch (get_irn_opcode(n)) {
890 print_vcg_color(F, ird_color_anchor);
893 print_vcg_color(F, ird_color_error);
896 print_vcg_color(F, ird_color_block_background);
899 print_vcg_color(F, ird_color_phi);
902 print_vcg_color(F, ird_color_memory);
906 print_vcg_color(F, ird_color_const);
909 print_vcg_color(F, ird_color_proj);
912 ir_op *op = get_irn_op(node);
914 if (is_op_constlike(op)) {
915 print_vcg_color(F, ird_color_const);
916 } else if (is_op_uses_memory(op)) {
917 print_vcg_color(F, ird_color_uses_memory);
918 } else if (is_op_cfopcode(op) || is_op_forking(op)) {
919 print_vcg_color(F, ird_color_controlflow);
925 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data)
927 hook_entry_t *info = XMALLOCZ(hook_entry_t);
929 info->hook._hook_node_info = cb;
930 info->context = data;
931 register_hook(hook_node_info, info);
936 void dump_remove_node_info_callback(void *handle)
938 hook_entry_t *info = (hook_entry_t*)handle;
939 unregister_hook(hook_node_info, info);
944 * Dump the node information of a node n to a file F.
946 static void dump_node_info(FILE *F, const ir_node *n)
948 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
950 fprintf(F, " info1: \"");
951 dump_irnode_to_file(F, n);
952 /* call the dump_node operation if available */
954 ops->dump_node(F, n, dump_node_info_txt);
956 /* allow additional info to be added */
957 hook_node_info(F, n);
961 static int is_constlike_node(const ir_node *node)
963 const ir_op *op = get_irn_op(node);
964 return is_op_constlike(op);
967 static void print_constid(FILE *F, const ir_node *user, const ir_node *node)
969 fprintf(F, "\"n%ldb%ld\"", get_irn_node_nr(user), get_irn_node_nr(node));
972 static void print_constblkid(FILE *F, const ir_node *node, const ir_node *block)
974 fprintf(F, "\"n%ldb%ld\"", get_irn_node_nr(node), get_irn_node_nr(block));
978 /** outputs the predecessors of n, that are constants, local. I.e.,
979 generates a copy of the constant predecessors for each node called with. */
980 static void dump_const_node_local(FILE *F, const ir_node *n)
982 ir_graph *irg = get_irn_irg(n);
984 if (!get_opt_dump_const_local()) return;
986 /* Use visited flag to avoid outputting nodes twice.
987 initialize it first. */
988 for (i = 0; i < get_irn_arity(n); i++) {
989 ir_node *con = get_irn_n(n, i);
990 if (is_constlike_node(con)) {
991 set_irn_visited(con, get_irg_visited(irg) - 1);
995 for (i = 0; i < get_irn_arity(n); i++) {
996 ir_node *con = get_irn_n(n, i);
997 if (is_constlike_node(con) && !irn_visited_else_mark(con)) {
998 /* Generate a new name for the node by appending the names of
1000 fprintf(F, "node: {title: ");
1001 print_constid(F, n, con);
1002 fprintf(F, " label: \"");
1003 dump_node_label(F, con);
1005 dump_node_info(F, con);
1006 dump_node_vcgattr(F, n, con, 0);
1012 /** If the block of an edge is a const_like node, dump it local with an edge */
1013 static void dump_const_block_local(FILE *F, const ir_node *n)
1017 if (!get_opt_dump_const_local()) return;
1019 blk = get_nodes_block(n);
1020 if (is_constlike_node(blk)) {
1021 /* Generate a new name for the node by appending the names of
1023 fprintf(F, "node: {title: ");
1024 print_constblkid(F, n, blk);
1025 fprintf(F, " label: \"");
1026 dump_node_label(F, blk);
1028 dump_node_info(F, blk);
1029 dump_node_vcgattr(F, n, blk, 0);
1032 fprintf(F, "edge: { sourcename: ");
1034 fprintf(F, " targetname: ");
1035 print_constblkid(F, n, blk);
1038 if (dump_edge_vcgattr_hook != NULL
1039 && dump_edge_vcgattr_hook(F, n, -1)) {
1044 fprintf(F, BLOCK_EDGE_ATTR "}\n");
1049 * prints the error message of a node to a file F as info2.
1051 static void print_node_error(FILE *F, const char *err_msg)
1056 fprintf(F, " info2: \"%s\"", err_msg);
1060 * prints debug messages of a node to file F as info3.
1062 static void print_dbg_info(FILE *F, dbg_info *dbg)
1066 ir_dbg_info_snprint(buf, sizeof(buf), dbg);
1068 fprintf(F, " info3: \"%s\"\n", buf);
1072 static void print_type_dbg_info(FILE *F, type_dbg_info *dbg)
1082 void dump_node(FILE *F, const ir_node *n)
1088 if (get_opt_dump_const_local() && is_constlike_node(n))
1091 /* dump this node */
1092 fputs("node: {title: ", F);
1095 fputs(" label: \"", F);
1096 irg = get_irn_irg(n);
1097 bad = ! irn_verify_irg_dump(n, irg, &p);
1098 dump_node_label(F, n);
1101 dump_node_info(F, n);
1102 print_node_error(F, p);
1103 print_dbg_info(F, get_irn_dbg_info(n));
1104 dump_node_vcgattr(F, n, NULL, bad);
1106 dump_const_node_local(F, n);
1110 /** dump the edge to the block this node belongs to */
1111 static void dump_ir_block_edge(FILE *F, const ir_node *n)
1113 if (get_opt_dump_const_local() && is_constlike_node(n)) return;
1115 ir_node *block = get_nodes_block(n);
1117 if (get_opt_dump_const_local() && is_constlike_node(block)) {
1118 dump_const_block_local(F, n);
1120 fprintf(F, "edge: { sourcename: ");
1122 fprintf(F, " targetname: ");
1123 print_nodeid(F, block);
1126 if (dump_edge_vcgattr_hook && dump_edge_vcgattr_hook(F, n, -1)) {
1131 fprintf(F, BLOCK_EDGE_ATTR "}\n");
1136 static void print_data_edge_vcgattr(FILE *F, const ir_node *from, int to)
1139 * do not use get_nodes_block() here, will fail
1140 * if the irg is not pinned.
1142 if (get_nodes_block(from) == get_nodes_block(get_irn_n(from, to)))
1143 fprintf(F, INTRA_DATA_EDGE_ATTR);
1145 fprintf(F, INTER_DATA_EDGE_ATTR);
1148 static void print_mem_edge_vcgattr(FILE *F, const ir_node *from, int to)
1151 * do not use get_nodes_block() here, will fail
1152 * if the irg is not pinned.
1154 if (get_nodes_block(from) == get_nodes_block(get_irn_n(from, to)))
1155 fprintf(F, INTRA_MEM_EDGE_ATTR);
1157 fprintf(F, INTER_MEM_EDGE_ATTR);
1160 /** Print the vcg attributes for the edge from node "from" to its "to"th input */
1161 static void print_edge_vcgattr(FILE *F, const ir_node *from, int to)
1165 if (dump_edge_vcgattr_hook)
1166 if (dump_edge_vcgattr_hook(F, from, to))
1169 if ((flags & ir_dump_flag_back_edges) && is_backedge(from, to))
1170 fprintf(F, BACK_EDGE_ATTR);
1172 switch (get_irn_opcode(from)) {
1174 fprintf(F, CF_EDGE_ATTR);
1176 case iro_Start: break;
1179 if (get_irn_mode(get_End_keepalive(from, to)) == mode_BB)
1180 fprintf(F, KEEP_ALIVE_CF_EDGE_ATTR);
1182 fprintf(F, KEEP_ALIVE_DF_EDGE_ATTR);
1186 if (is_Proj(from)) {
1187 if (get_irn_mode(from) == mode_M)
1188 print_mem_edge_vcgattr(F, from, to);
1189 else if (get_irn_mode(from) == mode_X)
1190 fprintf(F, CF_EDGE_ATTR);
1192 print_data_edge_vcgattr(F, from, to);
1194 else if (get_irn_mode(get_irn_n(from, to)) == mode_M)
1195 print_mem_edge_vcgattr(F, from, to);
1196 else if (get_irn_mode(get_irn_n(from, to)) == mode_X)
1197 fprintf(F, CF_EDGE_ATTR);
1199 print_data_edge_vcgattr(F, from, to);
1203 /** dump edges to our inputs */
1204 static void dump_ir_data_edges(FILE *F, const ir_node *n)
1208 if (dump_node_edge_hook)
1209 dump_node_edge_hook(F, n);
1211 if (!(flags & ir_dump_flag_keepalive_edges) && is_End(n)) {
1212 /* the End node has only keep-alive edges */
1216 /* dump the dependency edges. */
1217 num = get_irn_deps(n);
1218 for (i = 0; i < num; ++i) {
1219 ir_node *dep = get_irn_dep(n, i);
1222 print_node_edge_kind(F, n);
1223 fprintf(F, "{sourcename: ");
1225 fprintf(F, " targetname: ");
1226 if ((get_opt_dump_const_local()) && is_constlike_node(dep)) {
1227 print_constid(F, n, dep);
1229 print_nodeid(F, dep);
1231 fprintf(F, " label: \"%d\" ", i);
1232 fprintf(F, " color: darkgreen}\n");
1236 num = get_irn_arity(n);
1237 for (i = 0; i < num; i++) {
1238 ir_node *pred = get_irn_n(n, i);
1241 if ((flags & ir_dump_flag_back_edges) && is_backedge(n, i)) {
1242 fprintf(F, "backedge: {sourcename: ");
1244 print_node_edge_kind(F, n);
1245 fprintf(F, "{sourcename: ");
1248 fprintf(F, " targetname: ");
1249 if ((get_opt_dump_const_local()) && is_constlike_node(pred)) {
1250 print_constid(F, n, pred);
1252 print_nodeid(F, pred);
1254 fprintf(F, " label: \"%d\" ", i);
1255 print_edge_vcgattr(F, n, i);
1263 static void dump_ir_edges(ir_node *node, void *env)
1266 FILE *F = (FILE*)env;
1268 foreach_out_edge(node, edge) {
1269 ir_node *succ = get_edge_src_irn(edge);
1271 print_node_edge_kind(F, succ);
1272 fprintf(F, "{sourcename: ");
1273 print_nodeid(F, node);
1274 fprintf(F, " targetname: ");
1275 print_nodeid(F, succ);
1277 fprintf(F, " label: \"%d\" ", i);
1278 fprintf(F, OUT_EDGE_ATTR);
1285 /** Dumps a node and its edges but not the block edge */
1286 static void dump_node_wo_blockedge(FILE *F, const ir_node *n)
1289 dump_ir_data_edges(F, n);
1292 /** Dumps a node and its edges. */
1293 static void dump_node_with_edges(ir_node *n, void *env)
1295 FILE *F = (FILE*)env;
1296 dump_node_wo_blockedge(F, n);
1297 if (!node_floats(n))
1298 dump_ir_block_edge(F, n);
1301 /** Dumps a const-like node. */
1302 static void dump_const_node(ir_node *n, void *env)
1304 FILE *F = (FILE*)env;
1305 if (is_Block(n)) return;
1306 dump_node_wo_blockedge(F, n);
1309 /***********************************************************************/
1310 /* the following routines dump the nodes/irgs bracketed to graphs. */
1311 /***********************************************************************/
1313 /** Dumps a constant expression as entity initializer, array bound ... */
1314 static void dump_const_expression(FILE *F, ir_node *value)
1316 ir_graph *irg = get_const_code_irg();
1317 ir_dump_flags_t old_flags = ir_get_dump_flags();
1318 ir_remove_dump_flags(ir_dump_flag_consts_local);
1320 irg_walk(value, dump_const_node, NULL, F);
1321 /* Decrease visited flag so that we walk with the same flag for the next
1322 expression. This guarantees that we don't dump the same node twice,
1323 as for const expressions cse is performed to save memory. */
1324 set_irg_visited(irg, get_irg_visited(irg) -1);
1326 ir_set_dump_flags(old_flags);
1329 /** Dump a block as graph containing its nodes.
1331 * Expects to find nodes belonging to the block as list in its
1333 * Dumps the edges of all nodes including itself. */
1334 static void dump_whole_block(FILE *F, const ir_node *block)
1337 ird_color_t color = ird_color_block_background;
1339 assert(is_Block(block));
1341 fprintf(F, "graph: { title: ");
1342 print_nodeid(F, block);
1343 fprintf(F, " label: \"");
1344 dump_node_label(F, block);
1346 /* colorize blocks */
1347 if (! get_Block_matured(block))
1348 color = ird_color_block_background;
1350 fprintf(F, "\" status:clustered ");
1351 print_vcg_color(F, color);
1354 /* yComp can show attributes for blocks, XVCG parses but ignores them */
1355 dump_node_info(F, block);
1356 print_dbg_info(F, get_irn_dbg_info(block));
1358 /* dump the blocks edges */
1359 dump_ir_data_edges(F, block);
1361 if (dump_block_edge_hook)
1362 dump_block_edge_hook(F, block);
1364 /* dump the nodes that go into the block */
1365 for (node = (ir_node*)ird_get_irn_link(block); node; node = (ir_node*)ird_get_irn_link(node)) {
1367 dump_ir_data_edges(F, node);
1370 /* Close the vcg information for the block */
1372 dump_const_node_local(F, block);
1376 /** dumps a graph block-wise. Expects all blockless nodes in arr in irgs link.
1377 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1378 static void dump_block_graph(FILE *F, ir_graph *irg)
1381 ir_node **arr = (ir_node**)ird_get_irg_link(irg);
1383 for (i = 0, n = ARR_LEN(arr); i < n; ++i) {
1384 ir_node *node = arr[i];
1385 if (is_Block(node)) {
1386 /* Dumps the block and all the nodes in the block, which are to
1387 be found in Block->link. */
1388 dump_whole_block(F, node);
1390 /* Nodes that are not in a Block. */
1392 if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
1393 dump_const_block_local(F, node);
1395 dump_ir_data_edges(F, node);
1397 if ((flags & ir_dump_flag_iredges) && edges_activated(irg))
1398 dump_ir_edges(node, F);
1401 if ((flags & ir_dump_flag_loops)
1402 && irg_has_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_LOOPINFO))
1403 dump_loop_nodes_into_graph(F, irg);
1407 * Dump the info for an irg.
1408 * Parsed by XVCG but not shown. use yComp.
1410 static void dump_graph_info(FILE *F, ir_graph *irg)
1412 fprintf(F, "info1: \"");
1413 dump_entity_to_file(F, get_irg_entity(irg));
1416 /* dump graph state */
1417 fprintf(F, "constraints:");
1418 if (irg_is_constrained(irg, IR_GRAPH_CONSTRAINT_ARCH_DEP))
1419 fprintf(F, " arch_dep");
1420 if (irg_is_constrained(irg, IR_GRAPH_CONSTRAINT_MODEB_LOWERED))
1421 fprintf(F, " modeb_lowered");
1422 if (irg_is_constrained(irg, IR_GRAPH_CONSTRAINT_NORMALISATION2))
1423 fprintf(F, " normalisation2");
1424 if (irg_is_constrained(irg, IR_GRAPH_CONSTRAINT_OPTIMIZE_UNREACHABLE_CODE))
1425 fprintf(F, " optimize_unreachable_code");
1428 fprintf(F, "properties:");
1429 if (irg_has_properties(irg, IR_GRAPH_PROPERTY_NO_CRITICAL_EDGES))
1430 fprintf(F, " no_critical_edges");
1431 if (irg_has_properties(irg, IR_GRAPH_PROPERTY_NO_BADS))
1432 fprintf(F, " no_bads");
1433 if (irg_has_properties(irg, IR_GRAPH_PROPERTY_NO_UNREACHABLE_CODE))
1434 fprintf(F, " no_unreachable_code");
1435 if (irg_has_properties(irg, IR_GRAPH_PROPERTY_ONE_RETURN))
1436 fprintf(F, " one_return");
1437 if (irg_has_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE))
1438 fprintf(F, " consistent_dominance");
1439 if (irg_has_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_POSTDOMINANCE))
1440 fprintf(F, " consistent_postdominance");
1441 if (irg_has_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_OUT_EDGES))
1442 fprintf(F, " consistent_out_edges");
1443 if (irg_has_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_OUTS))
1444 fprintf(F, " consistent_outs");
1445 if (irg_has_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_LOOPINFO))
1446 fprintf(F, " consistent_loopinfo");
1447 if (irg_has_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_ENTITY_USAGE))
1448 fprintf(F, " consistent_entity_usage");
1452 /** Dumps an irg as a graph clustered by block nodes.
1453 * If interprocedural view edges can point to nodes out of this graph.
1455 static void dump_graph_from_list(FILE *F, ir_graph *irg)
1457 ir_entity *ent = get_irg_entity(irg);
1459 fprintf(F, "graph: { title: ");
1460 print_irgid(F, irg);
1461 fprintf(F, " label: \"%s\" status:clustered color:%s\n",
1462 get_ent_dump_name(ent), color_names[ird_color_prog_background]);
1464 dump_graph_info(F, irg);
1465 print_dbg_info(F, get_entity_dbg_info(ent));
1467 dump_block_graph(F, irg);
1469 /* Close the vcg information for the irg */
1470 fprintf(F, "}\n\n");
1473 /*******************************************************************/
1474 /* Basic type and entity nodes and edges. */
1475 /*******************************************************************/
1477 /** dumps the edges between nodes and their type or entity attributes. */
1478 static void dump_node2type_edges(ir_node *n, void *env)
1480 FILE *F = (FILE*)env;
1483 switch (get_irn_opcode(n)) {
1485 /* @@@ some consts have an entity */
1488 if (SYMCONST_HAS_TYPE(get_SymConst_kind(n)))
1489 print_node_type_edge(F,n,get_SymConst_type(n),NODE2TYPE_EDGE_ATTR);
1492 print_node_ent_edge(F,n,get_Sel_entity(n),NODE2TYPE_EDGE_ATTR);
1495 print_node_type_edge(F,n,get_Call_type(n),NODE2TYPE_EDGE_ATTR);
1498 print_node_type_edge(F,n,get_Alloc_type(n),NODE2TYPE_EDGE_ATTR);
1501 print_node_type_edge(F,n,get_Free_type(n),NODE2TYPE_EDGE_ATTR);
1504 print_node_type_edge(F,n,get_Cast_type(n),NODE2TYPE_EDGE_ATTR);
1511 static void print_typespecific_vcgattr(FILE *F, ir_type *tp)
1513 switch (get_type_tpop_code(tp)) {
1515 fprintf(F, " " TYPE_CLASS_NODE_ATTR);
1518 fprintf(F, " " TYPE_METH_NODE_ATTR);
1526 case tpo_enumeration:
1537 void dump_type_node(FILE *F, ir_type *tp)
1539 fprintf(F, "node: {title: ");
1540 print_typeid(F, tp);
1541 fprintf(F, " label: \"");
1542 if (tp->dbi != NULL) {
1544 ir_print_type(buf, sizeof(buf), tp);
1545 fprintf(F, "%s '%s'", get_type_tpop_name(tp), buf);
1547 ir_fprintf(F, "%+F", tp);
1549 fputs("\" info1: \"", F);
1550 dump_type_to_file(F, tp);
1552 print_type_dbg_info(F, get_type_dbg_info(tp));
1553 print_typespecific_vcgattr(F, tp);
1557 static void dump_entity_node(FILE *F, ir_entity *ent)
1559 fprintf(F, "node: {title: ");
1560 print_entityid(F, ent);
1561 fprintf(F, " label: ");
1562 fprintf(F, "\"%s\" ", get_ent_dump_name(ent));
1564 print_vcg_color(F, ird_color_entity);
1565 fprintf(F, "\n info1: \"");
1567 dump_entity_to_file(F, ent);
1570 print_dbg_info(F, get_entity_dbg_info(ent));
1574 static void dump_enum_item(FILE *F, ir_type *tp, size_t pos)
1577 ir_enum_const *ec = get_enumeration_const(tp, pos);
1578 ident *id = get_enumeration_const_nameid(ec);
1579 ir_tarval *tv = get_enumeration_value(ec);
1582 tarval_snprintf(buf, sizeof(buf), tv);
1584 strncpy(buf, "<not set>", sizeof(buf));
1585 fprintf(F, "node: {title: ");
1586 print_itemid(F, tp, pos);
1587 fprintf(F, " label: ");
1588 fprintf(F, "\"enum item %s\" " ENUM_ITEM_NODE_ATTR, get_id_str(id));
1589 fprintf(F, "\n info1: \"value: %s\"}\n", buf);
1593 * Dumps a new style initializer.
1595 static void dump_entity_initializer(FILE *F, const ir_entity *ent)
1603 * type-walker: Dumps a type or entity and its edges.
1605 static void dump_type_info(type_or_ent tore, void *env)
1607 FILE *F = (FILE*)env;
1608 size_t i = 0; /* to shutup gcc */
1610 /* dump this type or entity */
1612 switch (get_kind(tore.ent)) {
1614 ir_entity *ent = tore.ent;
1616 dump_entity_node(F, ent);
1618 /* skip this to reduce graph. Member edge of type is parallel to this edge. *
1619 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
1620 ENT_OWN_EDGE_ATTR "}\n", ent, get_entity_owner(ent));*/
1621 print_ent_type_edge(F,ent, get_entity_type(ent), ENT_TYPE_EDGE_ATTR);
1622 if (is_Class_type(get_entity_owner(ent))) {
1623 for (i = get_entity_n_overwrites(ent); i > 0;)
1624 print_ent_ent_edge(F, ent, get_entity_overwrites(ent, --i), 0, ird_color_none, ENT_OVERWRITES_EDGE_ATTR);
1626 /* attached subgraphs */
1627 if (! (flags & ir_dump_flag_no_entity_values)) {
1628 if (ent->initializer != NULL) {
1629 /* new style initializers */
1630 dump_entity_initializer(F, ent);
1636 ir_type *tp = tore.typ;
1637 dump_type_node(F, tp);
1638 /* and now the edges */
1639 switch (get_type_tpop_code(tp)) {
1641 for (i = get_class_n_supertypes(tp); i > 0;) {
1643 print_type_type_edge(F, tp, get_class_supertype(tp, i), TYPE_SUPER_EDGE_ATTR);
1645 for (i = get_class_n_members(tp); i > 0;) {
1647 print_type_ent_edge(F, tp, get_class_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
1651 for (i = get_struct_n_members(tp); i > 0;) {
1653 print_type_ent_edge(F, tp, get_struct_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
1657 for (i = get_method_n_params(tp); i > 0;) {
1659 print_type_type_edge(F, tp, get_method_param_type(tp, i), METH_PAR_EDGE_ATTR,i);
1661 for (i = get_method_n_ress(tp); i > 0;) {
1663 print_type_type_edge(F, tp, get_method_res_type(tp, i), METH_RES_EDGE_ATTR,i);
1667 for (i = get_union_n_members(tp); i > 0;) {
1669 print_type_ent_edge(F, tp, get_union_member(tp, i), UNION_EDGE_ATTR);
1673 print_type_type_edge(F, tp, get_array_element_type(tp), ARR_ELT_TYPE_EDGE_ATTR);
1674 print_type_ent_edge(F, tp, get_array_element_entity(tp), ARR_ENT_EDGE_ATTR);
1675 for (i = get_array_n_dimensions(tp); i > 0;) {
1676 ir_node *upper, *lower;
1679 upper = get_array_upper_bound(tp, i);
1680 lower = get_array_lower_bound(tp, i);
1681 print_node_type_edge(F, upper, tp, "label: \"upper %zu\"", get_array_order(tp, i));
1682 print_node_type_edge(F, lower, tp, "label: \"lower %zu\"", get_array_order(tp, i));
1683 dump_const_expression(F, upper);
1684 dump_const_expression(F, lower);
1687 case tpo_enumeration:
1688 for (i = get_enumeration_n_enums(tp); i > 0;) {
1690 dump_enum_item(F, tp, i);
1691 print_enum_item_edge(F, tp, i, "label: \"item %zu\"", i);
1695 print_type_type_edge(F, tp, get_pointer_points_to_type(tp), PTR_PTS_TO_EDGE_ATTR);
1699 case tpo_uninitialized:
1704 break; /* case k_type */
1707 printf(" *** irdump, dump_type_info(l.%i), faulty type.\n", __LINE__);
1711 /** For dumping class hierarchies.
1712 * Dumps a class type node and a superclass edge.
1714 static void dump_class_hierarchy_node(type_or_ent tore, void *ctx)
1716 FILE *F = (FILE*)ctx;
1717 size_t i = 0; /* to shutup gcc */
1719 /* dump this type or entity */
1720 switch (get_kind(tore.ent)) {
1722 ir_entity *ent = tore.ent;
1723 if (get_entity_owner(ent) == get_glob_type()) break;
1724 if (!is_Method_type(get_entity_type(ent)))
1726 if (flags & ir_dump_flag_entities_in_hierarchy
1727 && is_Class_type(get_entity_owner(ent))) {
1729 dump_entity_node(F, ent);
1731 print_type_ent_edge(F, get_entity_owner(ent), ent, TYPE_MEMBER_EDGE_ATTR);
1732 for (i = get_entity_n_overwrites(ent); i > 0;) {
1734 print_ent_ent_edge(F, get_entity_overwrites(ent, i), ent, 0, ird_color_none, ENT_OVERWRITES_EDGE_ATTR);
1740 ir_type *tp = tore.typ;
1741 if (tp == get_glob_type())
1743 switch (get_type_tpop_code(tp)) {
1745 dump_type_node(F, tp);
1746 /* and now the edges */
1747 for (i = get_class_n_supertypes(tp); i > 0;) {
1749 print_type_type_edge(F,tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
1754 break; /* case k_type */
1757 printf(" *** irdump, dump_class_hierarchy_node(l.%i), faulty type.\n", __LINE__);
1761 /*******************************************************************/
1762 /* dump analysis information that is expressed in graph terms. */
1763 /*******************************************************************/
1765 /* dump out edges */
1766 static void dump_out_edge(ir_node *n, void *env)
1768 FILE *F = (FILE*)env;
1770 for (i = get_irn_n_outs(n) - 1; i >= 0; --i) {
1771 ir_node *succ = get_irn_out(n, i);
1773 print_node_edge_kind(F, succ);
1774 fprintf(F, "{sourcename: ");
1776 fprintf(F, " targetname: ");
1777 print_nodeid(F, succ);
1778 fprintf(F, " color: red linestyle: dashed");
1783 static void dump_loop_label(FILE *F, const ir_loop *loop)
1785 fprintf(F, "loop %u", get_loop_depth(loop));
1788 static void dump_loop_info(FILE *F, const ir_loop *loop)
1790 fprintf(F, " info1: \"");
1791 fprintf(F, " loop nr: %ld", get_loop_loop_nr(loop));
1792 #ifdef DEBUG_libfirm
1793 fprintf(F, "\n The loop was analyzed %ld times.", (long int) PTR_TO_INT(get_loop_link(loop)));
1798 void print_loopid(FILE *F, const ir_loop *loop)
1800 fprintf(F, "\"l%ld\"", get_loop_loop_nr(loop));
1803 static void dump_loop_node(FILE *F, const ir_loop *loop)
1805 fprintf(F, "node: {title: ");
1806 print_loopid(F, loop);
1807 fprintf(F, " label: \"");
1808 dump_loop_label(F, loop);
1810 dump_loop_info(F, loop);
1814 static void dump_loop_node_edge(FILE *F, const ir_loop *loop, size_t i)
1817 fprintf(F, "edge: {sourcename: ");
1818 print_loopid(F, loop);
1819 fprintf(F, " targetname: ");
1820 print_nodeid(F, get_loop_element(loop, i).node);
1821 fprintf(F, " color: green");
1825 static void dump_loop_son_edge(FILE *F, const ir_loop *loop, size_t i)
1828 fprintf(F, "edge: {sourcename: ");
1829 print_loopid(F, loop);
1830 fprintf(F, " targetname: ");
1831 print_loopid(F, get_loop_element(loop, i).son);
1832 ir_fprintf(F, " color: darkgreen label: \"%zu\"}\n", i);
1835 static void dump_loops(FILE *F, const ir_loop *loop)
1838 size_t n_elements = get_loop_n_elements(loop);
1839 /* dump this loop node */
1840 dump_loop_node(F, loop);
1842 /* dump edges to nodes in loop -- only if it is a real loop */
1843 if (get_loop_depth(loop) != 0) {
1844 for (i = n_elements; i > 0;) {
1845 loop_element element;
1847 element = get_loop_element(loop, i);
1848 if (*element.kind != k_ir_node)
1850 dump_loop_node_edge(F, loop, i);
1853 for (i = n_elements; i > 0;) {
1854 loop_element element;
1856 element = get_loop_element(loop, i);
1857 if (*element.kind != k_ir_loop)
1859 dump_loops(F, element.son);
1860 dump_loop_son_edge(F, loop, i);
1864 static void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg)
1866 ir_loop *loop = get_irg_loop(irg);
1868 dump_loops(F, loop);
1872 void dump_vcg_header_colors(FILE *F)
1876 for (i = 0; i < ird_color_count; ++i) {
1877 if (color_rgb[i] != NULL) {
1878 fprintf(F, "colorentry %s: %s\n", color_names[i], color_rgb[i]);
1883 void dump_vcg_infonames(FILE *F)
1886 "infoname 1: \"Attribute\"\n"
1887 "infoname 2: \"Verification errors\"\n"
1888 "infoname 3: \"Debug info\"\n", F);
1892 * dumps the VCG header
1894 void dump_vcg_header(FILE *F, const char *name, const char *layout, const char *orientation)
1897 = (flags & ir_dump_flag_disable_edge_labels) ? "no" : "yes";
1899 if (! layout) layout = "Compilergraph";
1900 if (!orientation) orientation = "bottom_to_top";
1904 "graph: { title: \"ir graph of %s\"\n"
1905 "display_edge_labels: %s\n"
1906 "layoutalgorithm: mindepth //$ \"%s\"\n"
1907 "manhattan_edges: yes\n"
1908 "port_sharing: no\n"
1910 "classname 1: \"intrablock Data\"\n"
1911 "classname 2: \"Block\"\n"
1912 "classname 3: \"Entity type\"\n"
1913 "classname 4: \"Entity owner\"\n"
1914 "classname 5: \"Method Param\"\n"
1915 "classname 6: \"Method Res\"\n"
1916 "classname 7: \"Super\"\n"
1917 "classname 8: \"Union\"\n"
1918 "classname 9: \"Points-to\"\n"
1919 "classname 10: \"Array Element Type\"\n"
1920 "classname 11: \"Overwrites\"\n"
1921 "classname 12: \"Member\"\n"
1922 "classname 13: \"Control Flow\"\n"
1923 "classname 14: \"intrablock Memory\"\n"
1924 "classname 15: \"Dominators\"\n"
1925 "classname 16: \"interblock Data\"\n"
1926 "classname 17: \"interblock Memory\"\n"
1927 "classname 18: \"Exception Control Flow for Interval Analysis\"\n"
1928 "classname 19: \"Postdominators\"\n"
1929 "classname 20: \"Keep Alive\"\n"
1930 "classname 21: \"Out Edges\"\n"
1931 "classname 22: \"Macro Block Edges\"\n",
1932 name, label, layout, orientation);
1933 dump_vcg_infonames(F);
1934 dump_vcg_header_colors(F);
1939 * Dumps the vcg file footer
1941 void dump_vcg_footer(FILE *F)
1948 static void dump_blocks_as_subgraphs(FILE *out, ir_graph *irg)
1952 construct_block_lists(irg);
1955 * If we are in the interprocedural view, we dump not
1956 * only the requested irg but also all irgs that can be reached
1959 for (i = get_irp_n_irgs(); i > 0;) {
1960 ir_graph *other_irg = get_irp_irg(--i);
1961 ir_node **arr = (ir_node**)ird_get_irg_link(other_irg);
1965 dump_graph_from_list(out, other_irg);
1970 void dump_ir_graph_file(FILE *out, ir_graph *irg)
1972 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
1975 if (flags & ir_dump_flag_blocks_as_subgraphs) {
1976 dump_blocks_as_subgraphs(out, irg);
1978 /* dump_node_with_edges must be called in post visiting predecessors */
1979 ird_walk_graph(irg, NULL, dump_node_with_edges, out);
1982 /* dump type info */
1983 if (flags & ir_dump_flag_with_typegraph) {
1984 type_walk_irg(irg, dump_type_info, NULL, out);
1985 inc_irg_visited(get_const_code_irg());
1986 /* dump edges from graph to type info */
1987 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
1990 /* dump iredges out edges */
1991 if ((flags & ir_dump_flag_iredges) && edges_activated(irg)) {
1992 irg_walk_edges(get_irg_start_block(irg), dump_ir_edges, NULL, out);
1995 /* dump the out edges in a separate walk */
1996 if ((flags & ir_dump_flag_out_edges)
1997 && (irg_has_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_OUTS))) {
1998 irg_out_walk(get_irg_start(irg), dump_out_edge, NULL, out);
2001 dump_vcg_footer(out);
2004 static void dump_block_to_cfg(ir_node *block, void *env)
2006 FILE *F = (FILE*)env;
2009 if (is_Bad(block) && get_irn_mode(block) == mode_X) {
2010 dump_node(F, block);
2013 if (is_Block(block)) {
2014 /* This is a block. Dump a node for the block. */
2015 fprintf(F, "node: {title: ");
2016 print_nodeid(F, block);
2017 fprintf(F, " label: \"");
2018 if (block == get_irg_start_block(get_irn_irg(block)))
2019 fprintf(F, "Start ");
2020 if (block == get_irg_end_block(get_irn_irg(block)))
2023 fprintf(F, "%s ", get_op_name(get_irn_op(block)));
2024 print_nodeid(F, block);
2026 fprintf(F, "info1:\"");
2028 /* the generic version. */
2029 dump_irnode_to_file(F, block);
2031 fprintf(F, "\""); /* closing quote of info */
2033 if ((block == get_irg_start_block(get_irn_irg(block))) ||
2034 (block == get_irg_end_block(get_irn_irg(block))) )
2035 fprintf(F, " color:blue ");
2039 /* Dump the edges */
2040 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i) {
2041 ir_node *pred = get_Block_cfgpred(block, i);
2043 pred = get_nodes_block(pred);
2044 fprintf(F, "edge: { sourcename: ");
2045 print_nodeid(F, block);
2046 fprintf(F, " targetname: ");
2047 print_nodeid(F, pred);
2048 fprintf(F, "\"}\n");
2051 /* Dump dominator/postdominator edge */
2052 if (ir_get_dump_flags() & ir_dump_flag_dominance) {
2053 if (irg_has_properties(get_irn_irg(block), IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE) && get_Block_idom(block)) {
2054 ir_node *pred = get_Block_idom(block);
2055 fprintf(F, "edge: { sourcename: ");
2056 print_nodeid(F, block);
2057 fprintf(F, " targetname: ");
2058 print_nodeid(F, pred);
2059 fprintf(F, " " DOMINATOR_EDGE_ATTR "}\n");
2061 if (irg_has_properties(get_irn_irg(block), IR_GRAPH_PROPERTY_CONSISTENT_POSTDOMINANCE) && get_Block_ipostdom(block)) {
2062 ir_node *pred = get_Block_ipostdom(block);
2063 fprintf(F, "edge: { sourcename: ");
2064 print_nodeid(F, block);
2065 fprintf(F, " targetname: ");
2066 print_nodeid(F, pred);
2067 fprintf(F, " " POSTDOMINATOR_EDGE_ATTR "}\n");
2073 void dump_cfg(FILE *F, ir_graph *irg)
2075 dump_vcg_header(F, get_irg_dump_name(irg), NULL, NULL);
2077 /* walk over the blocks in the graph */
2078 irg_walk_graph(irg, dump_block_to_cfg, NULL, F);
2083 void dump_callgraph(FILE *F)
2086 ir_dump_flags_t old_flags = ir_get_dump_flags();
2088 ir_remove_dump_flags(ir_dump_flag_disable_edge_labels);
2089 dump_vcg_header(F, "Callgraph", "Hierarchic", NULL);
2091 for (i = get_irp_n_irgs(); i > 0;) {
2092 ir_graph *irg = get_irp_irg(--i);
2093 ir_entity *ent = get_irg_entity(irg);
2094 size_t j, n_callees = get_irg_n_callees(irg);
2096 dump_entity_node(F, ent);
2097 for (j = 0; j < n_callees; ++j) {
2098 ir_entity *c = get_irg_entity(get_irg_callee(irg, j));
2099 int be = is_irg_callee_backedge(irg, j);
2100 const char *attr = be
2101 ? "label:\"recursion %zu\""
2102 : "label:\"calls %zu\"";
2103 print_ent_ent_edge(F, ent, c, be, ird_color_entity, attr,
2104 get_irg_callee_loop_depth(irg, j));
2108 ir_set_dump_flags(old_flags);
2112 void dump_typegraph(FILE *out)
2114 dump_vcg_header(out, "All_types", NULL, NULL);
2115 type_walk(dump_type_info, NULL, out);
2116 dump_vcg_footer(out);
2119 void dump_class_hierarchy(FILE *out)
2121 dump_vcg_header(out, "class_hierarchy", NULL, NULL);
2122 type_walk(dump_class_hierarchy_node, NULL, out);
2123 dump_vcg_footer(out);
2126 static void dump_loops_standalone(FILE *F, ir_loop *loop)
2129 bool loop_node_started = false;
2131 size_t son_number = 0;
2133 ir_loop *son = NULL;
2135 /* Dump a new loop node. */
2136 dump_loop_node(F, loop);
2138 /* Dump the loop elements. */
2139 for (i = 0; i < get_loop_n_elements(loop); i++) {
2140 le = get_loop_element(loop, i);
2142 if (get_kind(son) == k_ir_loop) {
2144 /* We are a loop son -> Recurse */
2146 if (loop_node_started) { /* Close the "firm-nodes" node first if we started one. */
2147 fprintf(F, "\" }\n");
2148 fprintf(F, "edge: {sourcename: ");
2149 print_loopid(F, loop);
2150 fprintf(F, " targetname: \"l%ld-%lu-nodes\" label:\"%lu...%lu\"}\n",
2151 get_loop_loop_nr(loop),
2152 (unsigned long) first,
2153 (unsigned long) first,
2154 (unsigned long) i-1);
2155 loop_node_started = false;
2157 dump_loop_son_edge(F, loop, son_number++);
2158 dump_loops_standalone(F, son);
2159 } else if (get_kind(son) == k_ir_node) {
2160 /* We are a loop node -> Collect firm nodes */
2162 ir_node *n = le.node;
2163 if (!loop_node_started) {
2164 /* Start a new node which contains all firm nodes of the current loop */
2165 fprintf(F, "node: { title: \"l%ld-%lu-nodes\" color: lightyellow label: \"",
2166 get_loop_loop_nr(loop),
2168 loop_node_started = true;
2173 dump_node_label(F, n);
2174 if (has_backedges(n)) fprintf(F, "\t loop head!");
2175 } else { /* for callgraph loop tree */
2177 assert(get_kind(son) == k_ir_graph);
2179 /* We are a loop node -> Collect firm graphs */
2181 if (!loop_node_started) {
2182 /* Start a new node which contains all firm nodes of the current loop */
2183 fprintf(F, "node: { title: \"l%ld-%lu-nodes\" color: lightyellow label: \"",
2184 get_loop_loop_nr(loop),
2186 loop_node_started = true;
2190 fprintf(F, " %s", get_irg_dump_name(n));
2191 /* fprintf(F, " %s (depth %d)", get_irg_dump_name(n), n->callgraph_weighted_loop_depth); */
2195 if (loop_node_started) {
2196 fprintf(F, "\" }\n");
2197 fprintf(F, "edge: {sourcename: \"");
2198 print_loopid(F, loop);
2199 fprintf(F, "\" targetname: \"l%ld-%lu-nodes\" label:\"%lu...%lu\"}\n",
2200 get_loop_loop_nr(loop),
2201 (unsigned long) first,
2202 (unsigned long) first,
2203 (unsigned long) i-1);
2204 loop_node_started = false;
2208 void dump_loop_tree(FILE *out, ir_graph *irg)
2210 ir_dump_flags_t old_flags = ir_get_dump_flags();
2212 ir_remove_dump_flags(ir_dump_flag_disable_edge_labels);
2214 dump_vcg_header(out, get_irg_dump_name(irg), "Tree", "top_to_bottom");
2216 if (get_irg_loop(irg))
2217 dump_loops_standalone(out, get_irg_loop(irg));
2219 dump_vcg_footer(out);
2221 ir_set_dump_flags(old_flags);
2224 void dump_callgraph_loop_tree(FILE *out)
2226 dump_vcg_header(out, "callgraph looptree", "Tree", "top_to_bottom");
2227 dump_loops_standalone(out, irp->outermost_cg_loop);
2228 dump_vcg_footer(out);
2231 static void collect_nodeloop(FILE *F, ir_loop *loop, pset *loopnodes)
2235 int node_number = 0;
2237 if (flags & ir_dump_flag_loops)
2238 dump_loop_node(F, loop);
2240 for (i = 0; i < get_loop_n_elements(loop); i++) {
2241 loop_element le = get_loop_element(loop, i);
2242 if (*(le.kind) == k_ir_loop) {
2243 if (flags & ir_dump_flag_loops)
2244 dump_loop_son_edge(F, loop, son_number++);
2246 collect_nodeloop(F, le.son, loopnodes);
2248 if (flags & ir_dump_flag_loops)
2249 dump_loop_node_edge(F, loop, node_number++);
2250 pset_insert_ptr(loopnodes, le.node);
2255 static void collect_nodeloop_external_nodes(ir_loop *loop, pset *loopnodes,
2261 for (i = 0; i < get_loop_n_elements(loop); i++) {
2262 loop_element le = get_loop_element(loop, i);
2263 if (*(le.kind) == k_ir_loop) {
2265 collect_nodeloop_external_nodes(le.son, loopnodes, extnodes);
2267 if (is_Block(le.node)) start = 0; else start = -1;
2268 for (j = start; j < get_irn_arity(le.node); j++) {
2269 ir_node *pred = get_irn_n(le.node, j);
2270 if (!pset_find_ptr(loopnodes, pred)) {
2271 pset_insert_ptr(extnodes, pred);
2272 if (!is_Block(pred)) {
2273 pred = get_nodes_block(pred);
2274 if (!pset_find_ptr(loopnodes, pred))
2275 pset_insert_ptr(extnodes, pred);
2283 void dump_loop(FILE *F, ir_loop *l)
2285 pset *loopnodes = pset_new_ptr_default();
2286 pset *extnodes = pset_new_ptr_default();
2289 snprintf(name, sizeof(name), "loop_%ld", get_loop_loop_nr(l));
2290 dump_vcg_header(F, name, NULL, NULL);
2292 /* collect all nodes to dump */
2293 collect_nodeloop(F, l, loopnodes);
2294 collect_nodeloop_external_nodes(l, loopnodes, extnodes);
2296 /* build block lists */
2297 foreach_pset(loopnodes, ir_node, n) {
2298 set_irn_link(n, NULL);
2300 foreach_pset(extnodes, ir_node, n) {
2301 set_irn_link(n, NULL);
2303 foreach_pset(loopnodes, ir_node, n) {
2305 ir_node *const b = get_nodes_block(n);
2306 set_irn_link(n, get_irn_link(b));
2310 foreach_pset(extnodes, ir_node, n) {
2312 ir_node *const b = get_nodes_block(n);
2313 set_irn_link(n, get_irn_link(b));
2318 foreach_pset(loopnodes, ir_node, b) {
2320 fprintf(F, "graph: { title: ");
2322 fprintf(F, " label: \"");
2323 dump_node_opcode(F, b);
2324 fprintf(F, " %ld:%u", get_irn_node_nr(b), get_irn_idx(b));
2325 fprintf(F, "\" status:clustered color:yellow\n");
2327 /* dump the blocks edges */
2328 dump_ir_data_edges(F, b);
2330 /* dump the nodes that go into the block */
2331 for (ir_node *n = (ir_node*)get_irn_link(b); n; n = (ir_node*)get_irn_link(n)) {
2332 if (pset_find_ptr(extnodes, n))
2333 overrule_nodecolor = ird_color_block_inout;
2335 overrule_nodecolor = ird_color_default_node;
2336 if (!pset_find_ptr(extnodes, n)) dump_ir_data_edges(F, n);
2339 /* Close the vcg information for the block */
2341 dump_const_node_local(F, b);
2345 foreach_pset(extnodes, ir_node, b) {
2347 fprintf(F, "graph: { title: ");
2349 fprintf(F, " label: \"");
2350 dump_node_opcode(F, b);
2351 fprintf(F, " %ld:%u", get_irn_node_nr(b), get_irn_idx(b));
2352 fprintf(F, "\" status:clustered color:lightblue\n");
2354 /* dump the nodes that go into the block */
2355 for (ir_node *n = (ir_node*)get_irn_link(b); n; n = (ir_node*)get_irn_link(n)) {
2356 if (!pset_find_ptr(loopnodes, n))
2357 overrule_nodecolor = ird_color_block_inout;
2359 overrule_nodecolor = ird_color_default_node;
2360 if (pset_find_ptr(loopnodes, n)) dump_ir_data_edges(F, n);
2363 /* Close the vcg information for the block */
2365 dump_const_node_local(F, b);
2369 del_pset(loopnodes);
2375 static bool obstack_init;
2376 static struct obstack obst;
2377 static char *dump_path;
2379 void ir_set_dump_path(const char *path)
2382 dump_path = xstrdup(path);
2385 static void add_string_escaped(const char *string)
2388 for (p = string; *p != '\0'; ++p) {
2391 obstack_1grow(&obst, '@');
2392 obstack_1grow(&obst, '1');
2393 } else if (c == '@') {
2394 obstack_1grow(&obst, '@');
2395 obstack_1grow(&obst, '2');
2397 obstack_1grow(&obst, c);
2402 static void add_dump_path(void)
2404 if (!obstack_init) {
2405 obstack_init(&obst);
2406 obstack_init = true;
2409 if (dump_path != NULL) {
2410 size_t len = strlen(dump_path);
2411 obstack_grow(&obst, dump_path, len);
2412 if (len > 0 && dump_path[len-1] != '/')
2413 obstack_1grow(&obst, '/');
2417 void dump_ir_graph_ext(ir_graph_dump_func func, ir_graph *graph,
2420 const char *dump_name = get_irg_dump_name(graph);
2424 if (!ir_should_dump(dump_name))
2429 add_string_escaped(dump_name);
2430 obstack_printf(&obst, "-%02u", graph->dump_nr++);
2432 if (suffix != NULL) {
2433 if (suffix[0] != '.')
2434 obstack_1grow(&obst, '-');
2435 add_string_escaped(suffix);
2437 obstack_1grow(&obst, '\0');
2439 file_name = (char*)obstack_finish(&obst);
2440 /* xvcg expects only <LF> so we need "b"inary mode (for win32) */
2441 out = fopen(file_name, "wb");
2442 obstack_free(&obst, file_name);
2445 fprintf(stderr, "Couldn't open '%s': %s\n", file_name, strerror(errno));
2453 void dump_ir_prog_ext(ir_prog_dump_func func, const char *suffix)
2460 obstack_printf(&obst, "%02u", irp->dump_nr++);
2461 if (suffix != NULL) {
2462 if (suffix[0] != '.')
2463 obstack_1grow(&obst, '-');
2464 add_string_escaped(suffix);
2466 obstack_1grow(&obst, '\0');
2468 file_name = (char*)obstack_finish(&obst);
2469 out = fopen(file_name, "wb");
2470 obstack_free(&obst, file_name);
2473 fprintf(stderr, "Couldn't open '%s': %s\n", file_name, strerror(errno));
2480 void dump_ir_graph(ir_graph *graph, const char *suffix)
2484 snprintf(buf, sizeof(buf), "%s.vcg", suffix);
2485 dump_ir_graph_ext(dump_ir_graph_file, graph, buf);
2488 void dump_all_ir_graphs(const char *suffix)
2490 size_t i, n_irgs = get_irp_n_irgs();
2492 for (i = 0; i < n_irgs; ++i) {
2493 ir_graph *irg = get_irp_irg(i);
2494 dump_ir_graph(irg, suffix);
2498 typedef struct pass_t {
2499 ir_prog_pass_t pass;
2504 * Wrapper around dump_all_ir_graphs().
2506 static int dump_all_ir_graphs_wrapper(ir_prog *irp, void *context)
2508 pass_t *pass = (pass_t*)context;
2511 dump_all_ir_graphs(pass->suffix);
2515 ir_prog_pass_t *dump_all_ir_graph_pass(const char *name, const char *suffix)
2517 size_t len = strlen(suffix) + 1;
2518 pass_t *pass = XMALLOCF(pass_t, suffix, len);
2519 ir_prog_pass_t *res = def_prog_pass_constructor(
2520 &pass->pass, name ? name : "dump_all_graphs", dump_all_ir_graphs_wrapper);
2522 /* this pass does not change anything, so neither dump nor verify is needed. */
2523 res->dump_irprog = ir_prog_no_dump;
2524 res->verify_irprog = ir_prog_no_verify;
2526 memcpy(pass->suffix, suffix, len);