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 fprintf(F, "%s", get_irn_opname(n));
679 if (get_Div_no_remainder(n))
681 fprintf(F, "[%s]", get_mode_name_ex(get_Div_resmode(n), NULL));
684 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Mod_resmode(n), NULL));
687 fprintf(F, "%s[%s]", get_irn_opname(n), get_builtin_kind_name(get_Builtin_kind(n)));
691 fprintf(F, "%s", get_irn_opname(n));
696 * Dump the mode of a node n to a file F.
697 * Ignore modes that are "always known".
699 static void dump_node_mode(FILE *F, const ir_node *n)
701 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
705 /* call the dump_node operation if available */
706 if (ops->dump_node) {
707 ops->dump_node(F, n, dump_node_mode_txt);
711 /* default implementation */
712 iro = get_irn_opcode(n);
724 mode = get_irn_mode(n);
726 if (mode != NULL && mode != mode_BB && mode != mode_ANY && mode != mode_BAD &&
727 (mode != mode_T || iro == iro_Proj))
728 fprintf(F, "%s", get_mode_name_ex(mode, NULL));
733 * Dump the type of a node n to a file F if it's known.
735 static int dump_node_typeinfo(FILE *F, const ir_node *n)
737 ir_graph *irg = get_irn_irg(n);
740 if (ir_get_dump_flags() & ir_dump_flag_analysed_types) {
741 if (get_irg_typeinfo_state(irg) == ir_typeinfo_consistent ||
742 get_irg_typeinfo_state(irg) == ir_typeinfo_inconsistent) {
743 ir_type *tp = get_irn_typeinfo_type(n);
744 if (tp != get_none_type()) {
745 ir_fprintf(F, "[%+F]", tp);
755 * Dump additional node attributes of some nodes to a file F.
757 static void dump_node_nodeattr(FILE *F, const ir_node *n)
762 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
764 /* call the dump_node operation if available */
765 if (ops->dump_node) {
766 ops->dump_node(F, n, dump_node_nodeattr_txt);
770 switch (get_irn_opcode(n)) {
772 ir_fprintf(F, "%T ", get_Const_tarval(n));
776 pred = get_Proj_pred(n);
777 proj_nr = get_Proj_proj(n);
778 code = get_irn_opcode(pred);
780 if (code == iro_Proj && get_irn_opcode(get_Proj_pred(pred)) == iro_Start)
781 fprintf(F, "Arg %ld ", proj_nr);
782 else if (code == iro_Cond && get_irn_mode(get_Cond_selector(pred)) != mode_b)
783 fprintf(F, "%ld ", proj_nr);
785 unsigned i, j, f = 0;
787 for (i = 0; i < ARRAY_SIZE(proj_lut); ++i) {
788 if (code == proj_lut[i].code) {
789 for (j = 0; j < proj_lut[i].num_data; ++j) {
790 if (proj_nr == proj_lut[i].data[j].nr) {
791 fprintf(F, "%s ", proj_lut[i].data[j].name);
800 fprintf(F, "%ld ", proj_nr);
801 if (code == iro_Cond && get_Cond_jmp_pred(pred) != COND_JMP_PRED_NONE) {
802 if (proj_nr == pn_Cond_false && get_Cond_jmp_pred(pred) == COND_JMP_PRED_FALSE)
804 if (proj_nr == pn_Cond_true && get_Cond_jmp_pred(pred) == COND_JMP_PRED_TRUE)
810 fprintf(F, "%s ", get_ent_dump_name(get_Sel_entity(n)));
813 ir_fprintf(F, "(%+F)", get_Cast_type(n));
816 fprintf(F, "%s ", get_relation_string(get_Cmp_relation(n)));
819 fprintf(F, "%s ", get_relation_string(get_Confirm_relation(n)));
822 ir_fprintf(F, "(%+F)", get_CopyB_type(n));
830 void dump_node_label(FILE *F, const ir_node *n)
832 dump_node_opcode(F, n);
834 dump_node_mode(F, n);
836 dump_node_typeinfo(F, n);
837 dump_node_nodeattr(F, n);
838 if (flags & ir_dump_flag_number_label) {
839 fprintf(F, "%ld", get_irn_node_nr(n));
841 if (flags & ir_dump_flag_idx_label) {
842 fprintf(F, ":%u", get_irn_idx(n));
847 * Dumps the attributes of a node n into the file F.
848 * Currently this is only the color of a node.
850 static void dump_node_vcgattr(FILE *F, const ir_node *node, const ir_node *local, bool bad)
856 print_vcg_color(F, ird_color_error);
860 if (dump_node_vcgattr_hook != NULL) {
861 dump_node_vcgattr_hook(F, node, local);
865 n = local ? local : node;
867 if (overrule_nodecolor != ird_color_default_node) {
868 print_vcg_color(F, overrule_nodecolor);
872 mode = get_irn_mode(n);
873 if (mode == mode_M) {
874 print_vcg_color(F, ird_color_memory);
877 if (mode == mode_X) {
878 print_vcg_color(F, ird_color_controlflow);
882 switch (get_irn_opcode(n)) {
885 print_vcg_color(F, ird_color_anchor);
888 print_vcg_color(F, ird_color_error);
891 print_vcg_color(F, ird_color_block_background);
894 print_vcg_color(F, ird_color_phi);
897 print_vcg_color(F, ird_color_memory);
901 print_vcg_color(F, ird_color_const);
904 print_vcg_color(F, ird_color_proj);
907 ir_op *op = get_irn_op(node);
909 if (is_op_constlike(op)) {
910 print_vcg_color(F, ird_color_const);
911 } else if (is_op_uses_memory(op)) {
912 print_vcg_color(F, ird_color_uses_memory);
913 } else if (is_op_cfopcode(op) || is_op_forking(op)) {
914 print_vcg_color(F, ird_color_controlflow);
920 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data)
922 hook_entry_t *info = XMALLOCZ(hook_entry_t);
924 info->hook._hook_node_info = cb;
925 info->context = data;
926 register_hook(hook_node_info, info);
931 void dump_remove_node_info_callback(void *handle)
933 hook_entry_t *info = (hook_entry_t*)handle;
934 unregister_hook(hook_node_info, info);
939 * Dump the node information of a node n to a file F.
941 static void dump_node_info(FILE *F, const ir_node *n)
943 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
945 fprintf(F, " info1: \"");
946 dump_irnode_to_file(F, n);
947 /* call the dump_node operation if available */
949 ops->dump_node(F, n, dump_node_info_txt);
951 /* allow additional info to be added */
952 hook_node_info(F, n);
956 static int is_constlike_node(const ir_node *node)
958 const ir_op *op = get_irn_op(node);
959 return is_op_constlike(op);
962 static void print_constid(FILE *F, const ir_node *user, const ir_node *node)
964 fprintf(F, "\"n%ldb%ld\"", get_irn_node_nr(user), get_irn_node_nr(node));
967 static void print_constblkid(FILE *F, const ir_node *node, const ir_node *block)
969 fprintf(F, "\"n%ldb%ld\"", get_irn_node_nr(node), get_irn_node_nr(block));
973 /** outputs the predecessors of n, that are constants, local. I.e.,
974 generates a copy of the constant predecessors for each node called with. */
975 static void dump_const_node_local(FILE *F, const ir_node *n)
977 ir_graph *irg = get_irn_irg(n);
979 if (!get_opt_dump_const_local()) return;
981 /* Use visited flag to avoid outputting nodes twice.
982 initialize it first. */
983 for (i = 0; i < get_irn_arity(n); i++) {
984 ir_node *con = get_irn_n(n, i);
985 if (is_constlike_node(con)) {
986 set_irn_visited(con, get_irg_visited(irg) - 1);
990 for (i = 0; i < get_irn_arity(n); i++) {
991 ir_node *con = get_irn_n(n, i);
992 if (is_constlike_node(con) && !irn_visited_else_mark(con)) {
993 /* Generate a new name for the node by appending the names of
995 fprintf(F, "node: {title: ");
996 print_constid(F, n, con);
997 fprintf(F, " label: \"");
998 dump_node_label(F, con);
1000 dump_node_info(F, con);
1001 dump_node_vcgattr(F, n, con, 0);
1007 /** If the block of an edge is a const_like node, dump it local with an edge */
1008 static void dump_const_block_local(FILE *F, const ir_node *n)
1012 if (!get_opt_dump_const_local()) return;
1014 blk = get_nodes_block(n);
1015 if (is_constlike_node(blk)) {
1016 /* Generate a new name for the node by appending the names of
1018 fprintf(F, "node: {title: ");
1019 print_constblkid(F, n, blk);
1020 fprintf(F, " label: \"");
1021 dump_node_label(F, blk);
1023 dump_node_info(F, blk);
1024 dump_node_vcgattr(F, n, blk, 0);
1027 fprintf(F, "edge: { sourcename: ");
1029 fprintf(F, " targetname: ");
1030 print_constblkid(F, n, blk);
1033 if (dump_edge_vcgattr_hook != NULL
1034 && dump_edge_vcgattr_hook(F, n, -1)) {
1039 fprintf(F, BLOCK_EDGE_ATTR "}\n");
1044 * prints the error message of a node to a file F as info2.
1046 static void print_node_error(FILE *F, const char *err_msg)
1051 fprintf(F, " info2: \"%s\"", err_msg);
1055 * prints debug messages of a node to file F as info3.
1057 static void print_dbg_info(FILE *F, dbg_info *dbg)
1061 ir_dbg_info_snprint(buf, sizeof(buf), dbg);
1063 fprintf(F, " info3: \"%s\"\n", buf);
1067 static void print_type_dbg_info(FILE *F, type_dbg_info *dbg)
1077 void dump_node(FILE *F, const ir_node *n)
1083 if (get_opt_dump_const_local() && is_constlike_node(n))
1086 /* dump this node */
1087 fputs("node: {title: ", F);
1090 fputs(" label: \"", F);
1091 irg = get_irn_irg(n);
1092 bad = ! irn_verify_irg_dump(n, irg, &p);
1093 dump_node_label(F, n);
1096 dump_node_info(F, n);
1097 print_node_error(F, p);
1098 print_dbg_info(F, get_irn_dbg_info(n));
1099 dump_node_vcgattr(F, n, NULL, bad);
1101 dump_const_node_local(F, n);
1105 /** dump the edge to the block this node belongs to */
1106 static void dump_ir_block_edge(FILE *F, const ir_node *n)
1108 if (get_opt_dump_const_local() && is_constlike_node(n)) return;
1110 ir_node *block = get_nodes_block(n);
1112 if (get_opt_dump_const_local() && is_constlike_node(block)) {
1113 dump_const_block_local(F, n);
1115 fprintf(F, "edge: { sourcename: ");
1117 fprintf(F, " targetname: ");
1118 print_nodeid(F, block);
1121 if (dump_edge_vcgattr_hook && dump_edge_vcgattr_hook(F, n, -1)) {
1126 fprintf(F, BLOCK_EDGE_ATTR "}\n");
1131 static void print_data_edge_vcgattr(FILE *F, const ir_node *from, int to)
1134 * do not use get_nodes_block() here, will fail
1135 * if the irg is not pinned.
1137 if (get_nodes_block(from) == get_nodes_block(get_irn_n(from, to)))
1138 fprintf(F, INTRA_DATA_EDGE_ATTR);
1140 fprintf(F, INTER_DATA_EDGE_ATTR);
1143 static void print_mem_edge_vcgattr(FILE *F, const ir_node *from, int to)
1146 * do not use get_nodes_block() here, will fail
1147 * if the irg is not pinned.
1149 if (get_nodes_block(from) == get_nodes_block(get_irn_n(from, to)))
1150 fprintf(F, INTRA_MEM_EDGE_ATTR);
1152 fprintf(F, INTER_MEM_EDGE_ATTR);
1155 /** Print the vcg attributes for the edge from node "from" to its "to"th input */
1156 static void print_edge_vcgattr(FILE *F, const ir_node *from, int to)
1160 if (dump_edge_vcgattr_hook)
1161 if (dump_edge_vcgattr_hook(F, from, to))
1164 if ((flags & ir_dump_flag_back_edges) && is_backedge(from, to))
1165 fprintf(F, BACK_EDGE_ATTR);
1167 switch (get_irn_opcode(from)) {
1169 fprintf(F, CF_EDGE_ATTR);
1171 case iro_Start: break;
1174 if (get_irn_mode(get_End_keepalive(from, to)) == mode_BB)
1175 fprintf(F, KEEP_ALIVE_CF_EDGE_ATTR);
1177 fprintf(F, KEEP_ALIVE_DF_EDGE_ATTR);
1181 if (is_Proj(from)) {
1182 if (get_irn_mode(from) == mode_M)
1183 print_mem_edge_vcgattr(F, from, to);
1184 else if (get_irn_mode(from) == mode_X)
1185 fprintf(F, CF_EDGE_ATTR);
1187 print_data_edge_vcgattr(F, from, to);
1189 else if (get_irn_mode(get_irn_n(from, to)) == mode_M)
1190 print_mem_edge_vcgattr(F, from, to);
1191 else if (get_irn_mode(get_irn_n(from, to)) == mode_X)
1192 fprintf(F, CF_EDGE_ATTR);
1194 print_data_edge_vcgattr(F, from, to);
1198 /** dump edges to our inputs */
1199 static void dump_ir_data_edges(FILE *F, const ir_node *n)
1203 if (dump_node_edge_hook)
1204 dump_node_edge_hook(F, n);
1206 if (!(flags & ir_dump_flag_keepalive_edges) && is_End(n)) {
1207 /* the End node has only keep-alive edges */
1211 /* dump the dependency edges. */
1212 num = get_irn_deps(n);
1213 for (i = 0; i < num; ++i) {
1214 ir_node *dep = get_irn_dep(n, i);
1217 print_node_edge_kind(F, n);
1218 fprintf(F, "{sourcename: ");
1220 fprintf(F, " targetname: ");
1221 if ((get_opt_dump_const_local()) && is_constlike_node(dep)) {
1222 print_constid(F, n, dep);
1224 print_nodeid(F, dep);
1226 fprintf(F, " label: \"%d\" ", i);
1227 fprintf(F, " color: darkgreen}\n");
1231 num = get_irn_arity(n);
1232 for (i = 0; i < num; i++) {
1233 ir_node *pred = get_irn_n(n, i);
1236 if ((flags & ir_dump_flag_back_edges) && is_backedge(n, i)) {
1237 fprintf(F, "backedge: {sourcename: ");
1239 print_node_edge_kind(F, n);
1240 fprintf(F, "{sourcename: ");
1243 fprintf(F, " targetname: ");
1244 if ((get_opt_dump_const_local()) && is_constlike_node(pred)) {
1245 print_constid(F, n, pred);
1247 print_nodeid(F, pred);
1249 fprintf(F, " label: \"%d\" ", i);
1250 print_edge_vcgattr(F, n, i);
1258 static void dump_ir_edges(ir_node *node, void *env)
1261 FILE *F = (FILE*)env;
1263 foreach_out_edge(node, edge) {
1264 ir_node *succ = get_edge_src_irn(edge);
1266 print_node_edge_kind(F, succ);
1267 fprintf(F, "{sourcename: ");
1268 print_nodeid(F, node);
1269 fprintf(F, " targetname: ");
1270 print_nodeid(F, succ);
1272 fprintf(F, " label: \"%d\" ", i);
1273 fprintf(F, OUT_EDGE_ATTR);
1280 /** Dumps a node and its edges but not the block edge */
1281 static void dump_node_wo_blockedge(FILE *F, const ir_node *n)
1284 dump_ir_data_edges(F, n);
1287 /** Dumps a node and its edges. */
1288 static void dump_node_with_edges(ir_node *n, void *env)
1290 FILE *F = (FILE*)env;
1291 dump_node_wo_blockedge(F, n);
1292 if (!node_floats(n))
1293 dump_ir_block_edge(F, n);
1296 /** Dumps a const-like node. */
1297 static void dump_const_node(ir_node *n, void *env)
1299 FILE *F = (FILE*)env;
1300 if (is_Block(n)) return;
1301 dump_node_wo_blockedge(F, n);
1304 /***********************************************************************/
1305 /* the following routines dump the nodes/irgs bracketed to graphs. */
1306 /***********************************************************************/
1308 /** Dumps a constant expression as entity initializer, array bound ... */
1309 static void dump_const_expression(FILE *F, ir_node *value)
1311 ir_graph *irg = get_const_code_irg();
1312 ir_dump_flags_t old_flags = ir_get_dump_flags();
1313 ir_remove_dump_flags(ir_dump_flag_consts_local);
1315 irg_walk(value, dump_const_node, NULL, F);
1316 /* Decrease visited flag so that we walk with the same flag for the next
1317 expression. This guarantees that we don't dump the same node twice,
1318 as for const expressions cse is performed to save memory. */
1319 set_irg_visited(irg, get_irg_visited(irg) -1);
1321 ir_set_dump_flags(old_flags);
1324 /** Dump a block as graph containing its nodes.
1326 * Expects to find nodes belonging to the block as list in its
1328 * Dumps the edges of all nodes including itself. */
1329 static void dump_whole_block(FILE *F, const ir_node *block)
1332 ird_color_t color = ird_color_block_background;
1334 assert(is_Block(block));
1336 fprintf(F, "graph: { title: ");
1337 print_nodeid(F, block);
1338 fprintf(F, " label: \"");
1339 dump_node_label(F, block);
1341 /* colorize blocks */
1342 if (! get_Block_matured(block))
1343 color = ird_color_block_background;
1345 fprintf(F, "\" status:clustered ");
1346 print_vcg_color(F, color);
1349 /* yComp can show attributes for blocks, XVCG parses but ignores them */
1350 dump_node_info(F, block);
1351 print_dbg_info(F, get_irn_dbg_info(block));
1353 /* dump the blocks edges */
1354 dump_ir_data_edges(F, block);
1356 if (dump_block_edge_hook)
1357 dump_block_edge_hook(F, block);
1359 /* dump the nodes that go into the block */
1360 for (node = (ir_node*)ird_get_irn_link(block); node; node = (ir_node*)ird_get_irn_link(node)) {
1362 dump_ir_data_edges(F, node);
1365 /* Close the vcg information for the block */
1367 dump_const_node_local(F, block);
1371 /** dumps a graph block-wise. Expects all blockless nodes in arr in irgs link.
1372 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1373 static void dump_block_graph(FILE *F, ir_graph *irg)
1376 ir_node **arr = (ir_node**)ird_get_irg_link(irg);
1378 for (i = 0, n = ARR_LEN(arr); i < n; ++i) {
1379 ir_node *node = arr[i];
1380 if (is_Block(node)) {
1381 /* Dumps the block and all the nodes in the block, which are to
1382 be found in Block->link. */
1383 dump_whole_block(F, node);
1385 /* Nodes that are not in a Block. */
1387 if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
1388 dump_const_block_local(F, node);
1390 dump_ir_data_edges(F, node);
1392 if ((flags & ir_dump_flag_iredges) && edges_activated(irg))
1393 dump_ir_edges(node, F);
1396 if ((flags & ir_dump_flag_loops)
1397 && irg_has_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_LOOPINFO))
1398 dump_loop_nodes_into_graph(F, irg);
1402 * Dump the info for an irg.
1403 * Parsed by XVCG but not shown. use yComp.
1405 static void dump_graph_info(FILE *F, ir_graph *irg)
1407 fprintf(F, "info1: \"");
1408 dump_entity_to_file(F, get_irg_entity(irg));
1411 /* dump graph state */
1412 fprintf(F, "constraints:");
1413 if (irg_is_constrained(irg, IR_GRAPH_CONSTRAINT_ARCH_DEP))
1414 fprintf(F, " arch_dep");
1415 if (irg_is_constrained(irg, IR_GRAPH_CONSTRAINT_MODEB_LOWERED))
1416 fprintf(F, " modeb_lowered");
1417 if (irg_is_constrained(irg, IR_GRAPH_CONSTRAINT_NORMALISATION2))
1418 fprintf(F, " normalisation2");
1419 if (irg_is_constrained(irg, IR_GRAPH_CONSTRAINT_OPTIMIZE_UNREACHABLE_CODE))
1420 fprintf(F, " optimize_unreachable_code");
1423 fprintf(F, "properties:");
1424 if (irg_has_properties(irg, IR_GRAPH_PROPERTY_NO_CRITICAL_EDGES))
1425 fprintf(F, " no_critical_edges");
1426 if (irg_has_properties(irg, IR_GRAPH_PROPERTY_NO_BADS))
1427 fprintf(F, " no_bads");
1428 if (irg_has_properties(irg, IR_GRAPH_PROPERTY_NO_UNREACHABLE_CODE))
1429 fprintf(F, " no_unreachable_code");
1430 if (irg_has_properties(irg, IR_GRAPH_PROPERTY_ONE_RETURN))
1431 fprintf(F, " one_return");
1432 if (irg_has_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE))
1433 fprintf(F, " consistent_dominance");
1434 if (irg_has_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_POSTDOMINANCE))
1435 fprintf(F, " consistent_postdominance");
1436 if (irg_has_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_OUT_EDGES))
1437 fprintf(F, " consistent_out_edges");
1438 if (irg_has_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_OUTS))
1439 fprintf(F, " consistent_outs");
1440 if (irg_has_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_LOOPINFO))
1441 fprintf(F, " consistent_loopinfo");
1442 if (irg_has_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_ENTITY_USAGE))
1443 fprintf(F, " consistent_entity_usage");
1447 /** Dumps an irg as a graph clustered by block nodes.
1448 * If interprocedural view edges can point to nodes out of this graph.
1450 static void dump_graph_from_list(FILE *F, ir_graph *irg)
1452 ir_entity *ent = get_irg_entity(irg);
1454 fprintf(F, "graph: { title: ");
1455 print_irgid(F, irg);
1456 fprintf(F, " label: \"%s\" status:clustered color:%s\n",
1457 get_ent_dump_name(ent), color_names[ird_color_prog_background]);
1459 dump_graph_info(F, irg);
1460 print_dbg_info(F, get_entity_dbg_info(ent));
1462 dump_block_graph(F, irg);
1464 /* Close the vcg information for the irg */
1465 fprintf(F, "}\n\n");
1468 /*******************************************************************/
1469 /* Basic type and entity nodes and edges. */
1470 /*******************************************************************/
1472 /** dumps the edges between nodes and their type or entity attributes. */
1473 static void dump_node2type_edges(ir_node *n, void *env)
1475 FILE *F = (FILE*)env;
1478 switch (get_irn_opcode(n)) {
1480 /* @@@ some consts have an entity */
1483 if (SYMCONST_HAS_TYPE(get_SymConst_kind(n)))
1484 print_node_type_edge(F,n,get_SymConst_type(n),NODE2TYPE_EDGE_ATTR);
1487 print_node_ent_edge(F,n,get_Sel_entity(n),NODE2TYPE_EDGE_ATTR);
1490 print_node_type_edge(F,n,get_Call_type(n),NODE2TYPE_EDGE_ATTR);
1493 print_node_type_edge(F,n,get_Alloc_type(n),NODE2TYPE_EDGE_ATTR);
1496 print_node_type_edge(F,n,get_Free_type(n),NODE2TYPE_EDGE_ATTR);
1499 print_node_type_edge(F,n,get_Cast_type(n),NODE2TYPE_EDGE_ATTR);
1506 static void print_typespecific_vcgattr(FILE *F, ir_type *tp)
1508 switch (get_type_tpop_code(tp)) {
1510 fprintf(F, " " TYPE_CLASS_NODE_ATTR);
1513 fprintf(F, " " TYPE_METH_NODE_ATTR);
1521 case tpo_enumeration:
1532 void dump_type_node(FILE *F, ir_type *tp)
1534 fprintf(F, "node: {title: ");
1535 print_typeid(F, tp);
1536 fprintf(F, " label: \"");
1537 if (tp->dbi != NULL) {
1539 ir_print_type(buf, sizeof(buf), tp);
1540 fprintf(F, "%s '%s'", get_type_tpop_name(tp), buf);
1542 ir_fprintf(F, "%+F", tp);
1544 fputs("\" info1: \"", F);
1545 dump_type_to_file(F, tp);
1547 print_type_dbg_info(F, get_type_dbg_info(tp));
1548 print_typespecific_vcgattr(F, tp);
1552 static void dump_entity_node(FILE *F, ir_entity *ent)
1554 fprintf(F, "node: {title: ");
1555 print_entityid(F, ent);
1556 fprintf(F, " label: ");
1557 fprintf(F, "\"%s\" ", get_ent_dump_name(ent));
1559 print_vcg_color(F, ird_color_entity);
1560 fprintf(F, "\n info1: \"");
1562 dump_entity_to_file(F, ent);
1565 print_dbg_info(F, get_entity_dbg_info(ent));
1569 static void dump_enum_item(FILE *F, ir_type *tp, size_t pos)
1572 ir_enum_const *ec = get_enumeration_const(tp, pos);
1573 ident *id = get_enumeration_const_nameid(ec);
1574 ir_tarval *tv = get_enumeration_value(ec);
1577 tarval_snprintf(buf, sizeof(buf), tv);
1579 strncpy(buf, "<not set>", sizeof(buf));
1580 fprintf(F, "node: {title: ");
1581 print_itemid(F, tp, pos);
1582 fprintf(F, " label: ");
1583 fprintf(F, "\"enum item %s\" " ENUM_ITEM_NODE_ATTR, get_id_str(id));
1584 fprintf(F, "\n info1: \"value: %s\"}\n", buf);
1588 * Dumps a new style initializer.
1590 static void dump_entity_initializer(FILE *F, const ir_entity *ent)
1598 * type-walker: Dumps a type or entity and its edges.
1600 static void dump_type_info(type_or_ent tore, void *env)
1602 FILE *F = (FILE*)env;
1603 size_t i = 0; /* to shutup gcc */
1605 /* dump this type or entity */
1607 switch (get_kind(tore.ent)) {
1609 ir_entity *ent = tore.ent;
1611 dump_entity_node(F, ent);
1613 /* skip this to reduce graph. Member edge of type is parallel to this edge. *
1614 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
1615 ENT_OWN_EDGE_ATTR "}\n", ent, get_entity_owner(ent));*/
1616 print_ent_type_edge(F,ent, get_entity_type(ent), ENT_TYPE_EDGE_ATTR);
1617 if (is_Class_type(get_entity_owner(ent))) {
1618 for (i = get_entity_n_overwrites(ent); i > 0;)
1619 print_ent_ent_edge(F, ent, get_entity_overwrites(ent, --i), 0, ird_color_none, ENT_OVERWRITES_EDGE_ATTR);
1621 /* attached subgraphs */
1622 if (! (flags & ir_dump_flag_no_entity_values)) {
1623 if (ent->initializer != NULL) {
1624 /* new style initializers */
1625 dump_entity_initializer(F, ent);
1631 ir_type *tp = tore.typ;
1632 dump_type_node(F, tp);
1633 /* and now the edges */
1634 switch (get_type_tpop_code(tp)) {
1636 for (i = get_class_n_supertypes(tp); i > 0;) {
1638 print_type_type_edge(F, tp, get_class_supertype(tp, i), TYPE_SUPER_EDGE_ATTR);
1640 for (i = get_class_n_members(tp); i > 0;) {
1642 print_type_ent_edge(F, tp, get_class_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
1646 for (i = get_struct_n_members(tp); i > 0;) {
1648 print_type_ent_edge(F, tp, get_struct_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
1652 for (i = get_method_n_params(tp); i > 0;) {
1654 print_type_type_edge(F, tp, get_method_param_type(tp, i), METH_PAR_EDGE_ATTR,i);
1656 for (i = get_method_n_ress(tp); i > 0;) {
1658 print_type_type_edge(F, tp, get_method_res_type(tp, i), METH_RES_EDGE_ATTR,i);
1662 for (i = get_union_n_members(tp); i > 0;) {
1664 print_type_ent_edge(F, tp, get_union_member(tp, i), UNION_EDGE_ATTR);
1668 print_type_type_edge(F, tp, get_array_element_type(tp), ARR_ELT_TYPE_EDGE_ATTR);
1669 print_type_ent_edge(F, tp, get_array_element_entity(tp), ARR_ENT_EDGE_ATTR);
1670 for (i = get_array_n_dimensions(tp); i > 0;) {
1671 ir_node *upper, *lower;
1674 upper = get_array_upper_bound(tp, i);
1675 lower = get_array_lower_bound(tp, i);
1676 print_node_type_edge(F, upper, tp, "label: \"upper %zu\"", get_array_order(tp, i));
1677 print_node_type_edge(F, lower, tp, "label: \"lower %zu\"", get_array_order(tp, i));
1678 dump_const_expression(F, upper);
1679 dump_const_expression(F, lower);
1682 case tpo_enumeration:
1683 for (i = get_enumeration_n_enums(tp); i > 0;) {
1685 dump_enum_item(F, tp, i);
1686 print_enum_item_edge(F, tp, i, "label: \"item %zu\"", i);
1690 print_type_type_edge(F, tp, get_pointer_points_to_type(tp), PTR_PTS_TO_EDGE_ATTR);
1694 case tpo_uninitialized:
1699 break; /* case k_type */
1702 printf(" *** irdump, dump_type_info(l.%i), faulty type.\n", __LINE__);
1706 /** For dumping class hierarchies.
1707 * Dumps a class type node and a superclass edge.
1709 static void dump_class_hierarchy_node(type_or_ent tore, void *ctx)
1711 FILE *F = (FILE*)ctx;
1712 size_t i = 0; /* to shutup gcc */
1714 /* dump this type or entity */
1715 switch (get_kind(tore.ent)) {
1717 ir_entity *ent = tore.ent;
1718 if (get_entity_owner(ent) == get_glob_type()) break;
1719 if (!is_Method_type(get_entity_type(ent)))
1721 if (flags & ir_dump_flag_entities_in_hierarchy
1722 && is_Class_type(get_entity_owner(ent))) {
1724 dump_entity_node(F, ent);
1726 print_type_ent_edge(F, get_entity_owner(ent), ent, TYPE_MEMBER_EDGE_ATTR);
1727 for (i = get_entity_n_overwrites(ent); i > 0;) {
1729 print_ent_ent_edge(F, get_entity_overwrites(ent, i), ent, 0, ird_color_none, ENT_OVERWRITES_EDGE_ATTR);
1735 ir_type *tp = tore.typ;
1736 if (tp == get_glob_type())
1738 switch (get_type_tpop_code(tp)) {
1740 dump_type_node(F, tp);
1741 /* and now the edges */
1742 for (i = get_class_n_supertypes(tp); i > 0;) {
1744 print_type_type_edge(F,tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
1749 break; /* case k_type */
1752 printf(" *** irdump, dump_class_hierarchy_node(l.%i), faulty type.\n", __LINE__);
1756 /*******************************************************************/
1757 /* dump analysis information that is expressed in graph terms. */
1758 /*******************************************************************/
1760 /* dump out edges */
1761 static void dump_out_edge(ir_node *n, void *env)
1763 FILE *F = (FILE*)env;
1765 for (i = get_irn_n_outs(n) - 1; i >= 0; --i) {
1766 ir_node *succ = get_irn_out(n, i);
1768 print_node_edge_kind(F, succ);
1769 fprintf(F, "{sourcename: ");
1771 fprintf(F, " targetname: ");
1772 print_nodeid(F, succ);
1773 fprintf(F, " color: red linestyle: dashed");
1778 static void dump_loop_label(FILE *F, const ir_loop *loop)
1780 fprintf(F, "loop %u", get_loop_depth(loop));
1783 static void dump_loop_info(FILE *F, const ir_loop *loop)
1785 fprintf(F, " info1: \"");
1786 fprintf(F, " loop nr: %ld", get_loop_loop_nr(loop));
1787 #ifdef DEBUG_libfirm
1788 fprintf(F, "\n The loop was analyzed %ld times.", (long int) PTR_TO_INT(get_loop_link(loop)));
1793 void print_loopid(FILE *F, const ir_loop *loop)
1795 fprintf(F, "\"l%ld\"", get_loop_loop_nr(loop));
1798 static void dump_loop_node(FILE *F, const ir_loop *loop)
1800 fprintf(F, "node: {title: ");
1801 print_loopid(F, loop);
1802 fprintf(F, " label: \"");
1803 dump_loop_label(F, loop);
1805 dump_loop_info(F, loop);
1809 static void dump_loop_node_edge(FILE *F, const ir_loop *loop, size_t i)
1812 fprintf(F, "edge: {sourcename: ");
1813 print_loopid(F, loop);
1814 fprintf(F, " targetname: ");
1815 print_nodeid(F, get_loop_element(loop, i).node);
1816 fprintf(F, " color: green");
1820 static void dump_loop_son_edge(FILE *F, const ir_loop *loop, size_t i)
1823 fprintf(F, "edge: {sourcename: ");
1824 print_loopid(F, loop);
1825 fprintf(F, " targetname: ");
1826 print_loopid(F, get_loop_element(loop, i).son);
1827 ir_fprintf(F, " color: darkgreen label: \"%zu\"}\n", i);
1830 static void dump_loops(FILE *F, const ir_loop *loop)
1833 size_t n_elements = get_loop_n_elements(loop);
1834 /* dump this loop node */
1835 dump_loop_node(F, loop);
1837 /* dump edges to nodes in loop -- only if it is a real loop */
1838 if (get_loop_depth(loop) != 0) {
1839 for (i = n_elements; i > 0;) {
1840 loop_element element;
1842 element = get_loop_element(loop, i);
1843 if (*element.kind != k_ir_node)
1845 dump_loop_node_edge(F, loop, i);
1848 for (i = n_elements; i > 0;) {
1849 loop_element element;
1851 element = get_loop_element(loop, i);
1852 if (*element.kind != k_ir_loop)
1854 dump_loops(F, element.son);
1855 dump_loop_son_edge(F, loop, i);
1859 static void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg)
1861 ir_loop *loop = get_irg_loop(irg);
1863 dump_loops(F, loop);
1867 void dump_vcg_header_colors(FILE *F)
1871 for (i = 0; i < ird_color_count; ++i) {
1872 if (color_rgb[i] != NULL) {
1873 fprintf(F, "colorentry %s: %s\n", color_names[i], color_rgb[i]);
1878 void dump_vcg_infonames(FILE *F)
1881 "infoname 1: \"Attribute\"\n"
1882 "infoname 2: \"Verification errors\"\n"
1883 "infoname 3: \"Debug info\"\n", F);
1887 * dumps the VCG header
1889 void dump_vcg_header(FILE *F, const char *name, const char *layout, const char *orientation)
1892 = (flags & ir_dump_flag_disable_edge_labels) ? "no" : "yes";
1894 if (! layout) layout = "Compilergraph";
1895 if (!orientation) orientation = "bottom_to_top";
1899 "graph: { title: \"ir graph of %s\"\n"
1900 "display_edge_labels: %s\n"
1901 "layoutalgorithm: mindepth //$ \"%s\"\n"
1902 "manhattan_edges: yes\n"
1903 "port_sharing: no\n"
1905 "classname 1: \"intrablock Data\"\n"
1906 "classname 2: \"Block\"\n"
1907 "classname 3: \"Entity type\"\n"
1908 "classname 4: \"Entity owner\"\n"
1909 "classname 5: \"Method Param\"\n"
1910 "classname 6: \"Method Res\"\n"
1911 "classname 7: \"Super\"\n"
1912 "classname 8: \"Union\"\n"
1913 "classname 9: \"Points-to\"\n"
1914 "classname 10: \"Array Element Type\"\n"
1915 "classname 11: \"Overwrites\"\n"
1916 "classname 12: \"Member\"\n"
1917 "classname 13: \"Control Flow\"\n"
1918 "classname 14: \"intrablock Memory\"\n"
1919 "classname 15: \"Dominators\"\n"
1920 "classname 16: \"interblock Data\"\n"
1921 "classname 17: \"interblock Memory\"\n"
1922 "classname 18: \"Exception Control Flow for Interval Analysis\"\n"
1923 "classname 19: \"Postdominators\"\n"
1924 "classname 20: \"Keep Alive\"\n"
1925 "classname 21: \"Out Edges\"\n"
1926 "classname 22: \"Macro Block Edges\"\n",
1927 name, label, layout, orientation);
1928 dump_vcg_infonames(F);
1929 dump_vcg_header_colors(F);
1934 * Dumps the vcg file footer
1936 void dump_vcg_footer(FILE *F)
1943 static void dump_blocks_as_subgraphs(FILE *out, ir_graph *irg)
1947 construct_block_lists(irg);
1950 * If we are in the interprocedural view, we dump not
1951 * only the requested irg but also all irgs that can be reached
1954 for (i = get_irp_n_irgs(); i > 0;) {
1955 ir_graph *other_irg = get_irp_irg(--i);
1956 ir_node **arr = (ir_node**)ird_get_irg_link(other_irg);
1960 dump_graph_from_list(out, other_irg);
1965 void dump_ir_graph_file(FILE *out, ir_graph *irg)
1967 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
1970 if (flags & ir_dump_flag_blocks_as_subgraphs) {
1971 dump_blocks_as_subgraphs(out, irg);
1973 /* dump_node_with_edges must be called in post visiting predecessors */
1974 ird_walk_graph(irg, NULL, dump_node_with_edges, out);
1977 /* dump type info */
1978 if (flags & ir_dump_flag_with_typegraph) {
1979 type_walk_irg(irg, dump_type_info, NULL, out);
1980 inc_irg_visited(get_const_code_irg());
1981 /* dump edges from graph to type info */
1982 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
1985 /* dump iredges out edges */
1986 if ((flags & ir_dump_flag_iredges) && edges_activated(irg)) {
1987 irg_walk_edges(get_irg_start_block(irg), dump_ir_edges, NULL, out);
1990 /* dump the out edges in a separate walk */
1991 if ((flags & ir_dump_flag_out_edges)
1992 && (irg_has_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_OUTS))) {
1993 irg_out_walk(get_irg_start(irg), dump_out_edge, NULL, out);
1996 dump_vcg_footer(out);
1999 static void dump_block_to_cfg(ir_node *block, void *env)
2001 FILE *F = (FILE*)env;
2004 if (is_Bad(block) && get_irn_mode(block) == mode_X) {
2005 dump_node(F, block);
2008 if (is_Block(block)) {
2009 /* This is a block. Dump a node for the block. */
2010 fprintf(F, "node: {title: ");
2011 print_nodeid(F, block);
2012 fprintf(F, " label: \"");
2013 if (block == get_irg_start_block(get_irn_irg(block)))
2014 fprintf(F, "Start ");
2015 if (block == get_irg_end_block(get_irn_irg(block)))
2018 fprintf(F, "%s ", get_op_name(get_irn_op(block)));
2019 print_nodeid(F, block);
2021 fprintf(F, "info1:\"");
2023 /* the generic version. */
2024 dump_irnode_to_file(F, block);
2026 fprintf(F, "\""); /* closing quote of info */
2028 if ((block == get_irg_start_block(get_irn_irg(block))) ||
2029 (block == get_irg_end_block(get_irn_irg(block))) )
2030 fprintf(F, " color:blue ");
2034 /* Dump the edges */
2035 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i) {
2036 ir_node *pred = get_Block_cfgpred(block, i);
2038 pred = get_nodes_block(pred);
2039 fprintf(F, "edge: { sourcename: ");
2040 print_nodeid(F, block);
2041 fprintf(F, " targetname: ");
2042 print_nodeid(F, pred);
2043 fprintf(F, "\"}\n");
2046 /* Dump dominator/postdominator edge */
2047 if (ir_get_dump_flags() & ir_dump_flag_dominance) {
2048 if (irg_has_properties(get_irn_irg(block), IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE) && get_Block_idom(block)) {
2049 ir_node *pred = get_Block_idom(block);
2050 fprintf(F, "edge: { sourcename: ");
2051 print_nodeid(F, block);
2052 fprintf(F, " targetname: ");
2053 print_nodeid(F, pred);
2054 fprintf(F, " " DOMINATOR_EDGE_ATTR "}\n");
2056 if (irg_has_properties(get_irn_irg(block), IR_GRAPH_PROPERTY_CONSISTENT_POSTDOMINANCE) && get_Block_ipostdom(block)) {
2057 ir_node *pred = get_Block_ipostdom(block);
2058 fprintf(F, "edge: { sourcename: ");
2059 print_nodeid(F, block);
2060 fprintf(F, " targetname: ");
2061 print_nodeid(F, pred);
2062 fprintf(F, " " POSTDOMINATOR_EDGE_ATTR "}\n");
2068 void dump_cfg(FILE *F, ir_graph *irg)
2070 dump_vcg_header(F, get_irg_dump_name(irg), NULL, NULL);
2072 /* walk over the blocks in the graph */
2073 irg_walk_graph(irg, dump_block_to_cfg, NULL, F);
2078 void dump_callgraph(FILE *F)
2081 ir_dump_flags_t old_flags = ir_get_dump_flags();
2083 ir_remove_dump_flags(ir_dump_flag_disable_edge_labels);
2084 dump_vcg_header(F, "Callgraph", "Hierarchic", NULL);
2086 for (i = get_irp_n_irgs(); i > 0;) {
2087 ir_graph *irg = get_irp_irg(--i);
2088 ir_entity *ent = get_irg_entity(irg);
2089 size_t j, n_callees = get_irg_n_callees(irg);
2091 dump_entity_node(F, ent);
2092 for (j = 0; j < n_callees; ++j) {
2093 ir_entity *c = get_irg_entity(get_irg_callee(irg, j));
2094 int be = is_irg_callee_backedge(irg, j);
2095 const char *attr = be
2096 ? "label:\"recursion %zu\""
2097 : "label:\"calls %zu\"";
2098 print_ent_ent_edge(F, ent, c, be, ird_color_entity, attr,
2099 get_irg_callee_loop_depth(irg, j));
2103 ir_set_dump_flags(old_flags);
2107 void dump_typegraph(FILE *out)
2109 dump_vcg_header(out, "All_types", NULL, NULL);
2110 type_walk(dump_type_info, NULL, out);
2111 dump_vcg_footer(out);
2114 void dump_class_hierarchy(FILE *out)
2116 dump_vcg_header(out, "class_hierarchy", NULL, NULL);
2117 type_walk(dump_class_hierarchy_node, NULL, out);
2118 dump_vcg_footer(out);
2121 static void dump_loops_standalone(FILE *F, ir_loop *loop)
2124 bool loop_node_started = false;
2126 size_t son_number = 0;
2128 ir_loop *son = NULL;
2130 /* Dump a new loop node. */
2131 dump_loop_node(F, loop);
2133 /* Dump the loop elements. */
2134 for (i = 0; i < get_loop_n_elements(loop); i++) {
2135 le = get_loop_element(loop, i);
2137 if (get_kind(son) == k_ir_loop) {
2139 /* We are a loop son -> Recurse */
2141 if (loop_node_started) { /* Close the "firm-nodes" node first if we started one. */
2142 fprintf(F, "\" }\n");
2143 fprintf(F, "edge: {sourcename: ");
2144 print_loopid(F, loop);
2145 fprintf(F, " targetname: \"l%ld-%lu-nodes\" label:\"%lu...%lu\"}\n",
2146 get_loop_loop_nr(loop),
2147 (unsigned long) first,
2148 (unsigned long) first,
2149 (unsigned long) i-1);
2150 loop_node_started = false;
2152 dump_loop_son_edge(F, loop, son_number++);
2153 dump_loops_standalone(F, son);
2154 } else if (get_kind(son) == k_ir_node) {
2155 /* We are a loop node -> Collect firm nodes */
2157 ir_node *n = le.node;
2158 if (!loop_node_started) {
2159 /* Start a new node which contains all firm nodes of the current loop */
2160 fprintf(F, "node: { title: \"l%ld-%lu-nodes\" color: lightyellow label: \"",
2161 get_loop_loop_nr(loop),
2163 loop_node_started = true;
2168 dump_node_label(F, n);
2169 if (has_backedges(n)) fprintf(F, "\t loop head!");
2170 } else { /* for callgraph loop tree */
2172 assert(get_kind(son) == k_ir_graph);
2174 /* We are a loop node -> Collect firm graphs */
2176 if (!loop_node_started) {
2177 /* Start a new node which contains all firm nodes of the current loop */
2178 fprintf(F, "node: { title: \"l%ld-%lu-nodes\" color: lightyellow label: \"",
2179 get_loop_loop_nr(loop),
2181 loop_node_started = true;
2185 fprintf(F, " %s", get_irg_dump_name(n));
2186 /* fprintf(F, " %s (depth %d)", get_irg_dump_name(n), n->callgraph_weighted_loop_depth); */
2190 if (loop_node_started) {
2191 fprintf(F, "\" }\n");
2192 fprintf(F, "edge: {sourcename: \"");
2193 print_loopid(F, loop);
2194 fprintf(F, "\" targetname: \"l%ld-%lu-nodes\" label:\"%lu...%lu\"}\n",
2195 get_loop_loop_nr(loop),
2196 (unsigned long) first,
2197 (unsigned long) first,
2198 (unsigned long) i-1);
2199 loop_node_started = false;
2203 void dump_loop_tree(FILE *out, ir_graph *irg)
2205 ir_dump_flags_t old_flags = ir_get_dump_flags();
2207 ir_remove_dump_flags(ir_dump_flag_disable_edge_labels);
2209 dump_vcg_header(out, get_irg_dump_name(irg), "Tree", "top_to_bottom");
2211 if (get_irg_loop(irg))
2212 dump_loops_standalone(out, get_irg_loop(irg));
2214 dump_vcg_footer(out);
2216 ir_set_dump_flags(old_flags);
2219 void dump_callgraph_loop_tree(FILE *out)
2221 dump_vcg_header(out, "callgraph looptree", "Tree", "top_to_bottom");
2222 dump_loops_standalone(out, irp->outermost_cg_loop);
2223 dump_vcg_footer(out);
2226 static void collect_nodeloop(FILE *F, ir_loop *loop, pset *loopnodes)
2230 int node_number = 0;
2232 if (flags & ir_dump_flag_loops)
2233 dump_loop_node(F, loop);
2235 for (i = 0; i < get_loop_n_elements(loop); i++) {
2236 loop_element le = get_loop_element(loop, i);
2237 if (*(le.kind) == k_ir_loop) {
2238 if (flags & ir_dump_flag_loops)
2239 dump_loop_son_edge(F, loop, son_number++);
2241 collect_nodeloop(F, le.son, loopnodes);
2243 if (flags & ir_dump_flag_loops)
2244 dump_loop_node_edge(F, loop, node_number++);
2245 pset_insert_ptr(loopnodes, le.node);
2250 static void collect_nodeloop_external_nodes(ir_loop *loop, pset *loopnodes,
2256 for (i = 0; i < get_loop_n_elements(loop); i++) {
2257 loop_element le = get_loop_element(loop, i);
2258 if (*(le.kind) == k_ir_loop) {
2260 collect_nodeloop_external_nodes(le.son, loopnodes, extnodes);
2262 if (is_Block(le.node)) start = 0; else start = -1;
2263 for (j = start; j < get_irn_arity(le.node); j++) {
2264 ir_node *pred = get_irn_n(le.node, j);
2265 if (!pset_find_ptr(loopnodes, pred)) {
2266 pset_insert_ptr(extnodes, pred);
2267 if (!is_Block(pred)) {
2268 pred = get_nodes_block(pred);
2269 if (!pset_find_ptr(loopnodes, pred))
2270 pset_insert_ptr(extnodes, pred);
2278 void dump_loop(FILE *F, ir_loop *l)
2280 pset *loopnodes = pset_new_ptr_default();
2281 pset *extnodes = pset_new_ptr_default();
2284 snprintf(name, sizeof(name), "loop_%ld", get_loop_loop_nr(l));
2285 dump_vcg_header(F, name, NULL, NULL);
2287 /* collect all nodes to dump */
2288 collect_nodeloop(F, l, loopnodes);
2289 collect_nodeloop_external_nodes(l, loopnodes, extnodes);
2291 /* build block lists */
2292 foreach_pset(loopnodes, ir_node, n) {
2293 set_irn_link(n, NULL);
2295 foreach_pset(extnodes, ir_node, n) {
2296 set_irn_link(n, NULL);
2298 foreach_pset(loopnodes, ir_node, n) {
2300 ir_node *const b = get_nodes_block(n);
2301 set_irn_link(n, get_irn_link(b));
2305 foreach_pset(extnodes, ir_node, n) {
2307 ir_node *const b = get_nodes_block(n);
2308 set_irn_link(n, get_irn_link(b));
2313 foreach_pset(loopnodes, ir_node, b) {
2315 fprintf(F, "graph: { title: ");
2317 fprintf(F, " label: \"");
2318 dump_node_opcode(F, b);
2319 fprintf(F, " %ld:%u", get_irn_node_nr(b), get_irn_idx(b));
2320 fprintf(F, "\" status:clustered color:yellow\n");
2322 /* dump the blocks edges */
2323 dump_ir_data_edges(F, b);
2325 /* dump the nodes that go into the block */
2326 for (ir_node *n = (ir_node*)get_irn_link(b); n; n = (ir_node*)get_irn_link(n)) {
2327 if (pset_find_ptr(extnodes, n))
2328 overrule_nodecolor = ird_color_block_inout;
2330 overrule_nodecolor = ird_color_default_node;
2331 if (!pset_find_ptr(extnodes, n)) dump_ir_data_edges(F, n);
2334 /* Close the vcg information for the block */
2336 dump_const_node_local(F, b);
2340 foreach_pset(extnodes, ir_node, b) {
2342 fprintf(F, "graph: { title: ");
2344 fprintf(F, " label: \"");
2345 dump_node_opcode(F, b);
2346 fprintf(F, " %ld:%u", get_irn_node_nr(b), get_irn_idx(b));
2347 fprintf(F, "\" status:clustered color:lightblue\n");
2349 /* dump the nodes that go into the block */
2350 for (ir_node *n = (ir_node*)get_irn_link(b); n; n = (ir_node*)get_irn_link(n)) {
2351 if (!pset_find_ptr(loopnodes, n))
2352 overrule_nodecolor = ird_color_block_inout;
2354 overrule_nodecolor = ird_color_default_node;
2355 if (pset_find_ptr(loopnodes, n)) dump_ir_data_edges(F, n);
2358 /* Close the vcg information for the block */
2360 dump_const_node_local(F, b);
2364 del_pset(loopnodes);
2370 static bool obstack_init;
2371 static struct obstack obst;
2372 static char *dump_path;
2374 void ir_set_dump_path(const char *path)
2377 dump_path = xstrdup(path);
2380 static void add_string_escaped(const char *string)
2383 for (p = string; *p != '\0'; ++p) {
2386 obstack_1grow(&obst, '@');
2387 obstack_1grow(&obst, '1');
2388 } else if (c == '@') {
2389 obstack_1grow(&obst, '@');
2390 obstack_1grow(&obst, '2');
2392 obstack_1grow(&obst, c);
2397 static void add_dump_path(void)
2399 if (!obstack_init) {
2400 obstack_init(&obst);
2401 obstack_init = true;
2404 if (dump_path != NULL) {
2405 size_t len = strlen(dump_path);
2406 obstack_grow(&obst, dump_path, len);
2407 if (len > 0 && dump_path[len-1] != '/')
2408 obstack_1grow(&obst, '/');
2412 void dump_ir_graph_ext(ir_graph_dump_func func, ir_graph *graph,
2415 const char *dump_name = get_irg_dump_name(graph);
2419 if (!ir_should_dump(dump_name))
2424 add_string_escaped(dump_name);
2425 obstack_printf(&obst, "-%02u", graph->dump_nr++);
2427 if (suffix != NULL) {
2428 if (suffix[0] != '.')
2429 obstack_1grow(&obst, '-');
2430 add_string_escaped(suffix);
2432 obstack_1grow(&obst, '\0');
2434 file_name = (char*)obstack_finish(&obst);
2435 /* xvcg expects only <LF> so we need "b"inary mode (for win32) */
2436 out = fopen(file_name, "wb");
2437 obstack_free(&obst, file_name);
2440 fprintf(stderr, "Couldn't open '%s': %s\n", file_name, strerror(errno));
2448 void dump_ir_prog_ext(ir_prog_dump_func func, const char *suffix)
2455 obstack_printf(&obst, "%02u", irp->dump_nr++);
2456 if (suffix != NULL) {
2457 if (suffix[0] != '.')
2458 obstack_1grow(&obst, '-');
2459 add_string_escaped(suffix);
2461 obstack_1grow(&obst, '\0');
2463 file_name = (char*)obstack_finish(&obst);
2464 out = fopen(file_name, "wb");
2465 obstack_free(&obst, file_name);
2468 fprintf(stderr, "Couldn't open '%s': %s\n", file_name, strerror(errno));
2475 void dump_ir_graph(ir_graph *graph, const char *suffix)
2479 snprintf(buf, sizeof(buf), "%s.vcg", suffix);
2480 dump_ir_graph_ext(dump_ir_graph_file, graph, buf);
2483 void dump_all_ir_graphs(const char *suffix)
2485 size_t i, n_irgs = get_irp_n_irgs();
2487 for (i = 0; i < n_irgs; ++i) {
2488 ir_graph *irg = get_irp_irg(i);
2489 dump_ir_graph(irg, suffix);
2493 typedef struct pass_t {
2494 ir_prog_pass_t pass;
2499 * Wrapper around dump_all_ir_graphs().
2501 static int dump_all_ir_graphs_wrapper(ir_prog *irp, void *context)
2503 pass_t *pass = (pass_t*)context;
2506 dump_all_ir_graphs(pass->suffix);
2510 ir_prog_pass_t *dump_all_ir_graph_pass(const char *name, const char *suffix)
2512 size_t len = strlen(suffix) + 1;
2513 pass_t *pass = XMALLOCF(pass_t, suffix, len);
2514 ir_prog_pass_t *res = def_prog_pass_constructor(
2515 &pass->pass, name ? name : "dump_all_graphs", dump_all_ir_graphs_wrapper);
2517 /* this pass does not change anything, so neither dump nor verify is needed. */
2518 res->dump_irprog = ir_prog_no_dump;
2519 res->verify_irprog = ir_prog_no_verify;
2521 memcpy(pass->suffix, suffix, len);