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 an entity ent to a node irn with additional info fmt, ...
421 static void print_ent_node_edge(FILE *F, const ir_entity *ent, const ir_node *irn, const char *fmt, ...)
426 fprintf(F, "edge: { sourcename: ");
427 print_entityid(F, ent);
428 fprintf(F, "\" targetname: ");
429 print_nodeid(F, irn);
430 ir_vfprintf(F, fmt, ap);
436 * Prints the edge from a type tp to an enumeration item item with additional info fmt, ...
439 static void print_enum_item_edge(FILE *F, const ir_type *tp, size_t item, const char *fmt, ...)
444 fprintf(F, "edge: { sourcename: ");
446 fprintf(F, " targetname: ");
447 print_itemid(F, tp, item);
448 ir_vfprintf(F, fmt, ap);
453 /*-----------------------------------------------------------------*/
454 /* global and ahead declarations */
455 /*-----------------------------------------------------------------*/
457 static void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg);
459 /*-----------------------------------------------------------------*/
460 /* Helper functions. */
461 /*-----------------------------------------------------------------*/
464 * This map is used as a private link attr to be able to call dumper
465 * anywhere without destroying link fields.
467 static pmap *irdump_link_map = NULL;
469 /** NOT A STANDARD LIBFIRM INIT METHOD
471 * We do not want to integrate dumping into libfirm, i.e., if the dumpers
472 * are off, we want to have as few interferences as possible. Therefore the
473 * initialization is performed lazily and not called from within init_firm.
475 * Creates the link attribute map. */
476 static void init_irdump(void)
478 /* We need a new, empty map. */
479 if (irdump_link_map) pmap_destroy(irdump_link_map);
480 irdump_link_map = pmap_create();
481 if (!dump_file_filter_id)
482 dump_file_filter_id = new_id_from_str("");
486 * Returns the private link field.
488 static void *ird_get_irn_link(const ir_node *n)
491 if (irdump_link_map == NULL)
494 if (pmap_contains(irdump_link_map, n))
495 res = pmap_get(irdump_link_map, n);
500 * Sets the private link field.
502 static void ird_set_irn_link(const ir_node *n, void *x)
504 if (irdump_link_map == NULL)
506 pmap_insert(irdump_link_map, n, x);
510 * Gets the private link field of an irg.
512 static void *ird_get_irg_link(const ir_graph *irg)
515 if (irdump_link_map == NULL)
518 if (pmap_contains(irdump_link_map, irg))
519 res = pmap_get(irdump_link_map, irg);
524 * Sets the private link field of an irg.
526 static void ird_set_irg_link(const ir_graph *irg, void *x)
528 if (irdump_link_map == NULL)
530 pmap_insert(irdump_link_map, irg, x);
534 * Walker, clears the private link field.
536 static void clear_link(ir_node *node, void *env)
539 ird_set_irn_link(node, NULL);
543 * If the entity has a ld_name, returns it if the dump_ld_name is set,
544 * else returns the name of the entity.
546 static const char *get_ent_dump_name_(const ir_entity *ent, bool dump_ld_name)
549 return "<NULL entity>";
551 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
552 if (ent->ld_name != NULL)
553 return get_id_str(ent->ld_name);
555 return get_id_str(ent->name);
558 const char *get_ent_dump_name(const ir_entity *ent)
560 return get_ent_dump_name_(ent, flags & ir_dump_flag_ld_names);
563 const char *get_irg_dump_name(const ir_graph *irg)
565 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
566 return get_ent_dump_name_(get_irg_entity(irg), true);
570 * Returns non-zero if a node is in floating state.
572 static int node_floats(const ir_node *n)
574 ir_graph *irg = get_irn_irg(n);
575 return ((get_irn_pinned(n) == op_pin_state_floats) &&
576 (get_irg_pinned(irg) == op_pin_state_floats));
580 * Walker that visits the anchors
582 static void ird_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env)
584 if ((flags & ir_dump_flag_all_anchors)
585 || ((flags & ir_dump_flag_iredges) && edges_activated(irg))) {
586 irg_walk_anchors(irg, pre, post, env);
588 irg_walk_graph(irg, pre, post, env);
593 * Walker, allocates an array for all blocks and puts their non-floating
594 * nodes into this array.
596 static void collect_node(ir_node *node, void *env)
601 || (get_op_flags(get_irn_op(node)) & irop_flag_dump_noblock)) {
602 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
603 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
604 ARR_APP1(ir_node *, arr, node);
605 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
607 ir_node * block = get_nodes_block(node);
610 /* this node is in a Bad block, so we must place it into the graph's list */
611 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
612 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
613 ARR_APP1(ir_node *, arr, node);
614 ird_set_irg_link(get_irn_irg(node), arr); /* arr is an l-value, APP_ARR might change it! */
616 ird_set_irn_link(node, ird_get_irn_link(block));
617 ird_set_irn_link(block, node);
622 /** Construct lists to walk ir block-wise.
624 * Collects all blocks, nodes not op_pin_state_pinned,
625 * Bad, NoMem and Unknown into a flexible array in link field of
626 * irg they belong to. Sets the irg link field to NULL in all
627 * graphs not visited.
628 * Free the list with DEL_ARR_F().
630 static ir_node **construct_block_lists(ir_graph *irg)
633 int walk_flag = ir_resources_reserved(irg) & IR_RESOURCE_IRN_VISITED;
636 ir_free_resources(irg, IR_RESOURCE_IRN_VISITED);
639 for (i = get_irp_n_irgs(); i > 0;)
640 ird_set_irg_link(get_irp_irg(--i), NULL);
642 ird_walk_graph(irg, clear_link, collect_node, irg);
645 ir_reserve_resources(irg, IR_RESOURCE_IRN_VISITED);
648 return (ir_node**)ird_get_irg_link(irg);
651 void dump_node_opcode(FILE *F, const ir_node *n)
653 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
655 /* call the dump_node operation if available */
656 if (ops->dump_node) {
657 ops->dump_node(F, n, dump_node_opcode_txt);
661 /* implementation for default nodes */
662 switch (get_irn_opcode(n)) {
664 switch (get_SymConst_kind(n)) {
665 case symconst_addr_ent:
666 fprintf(F, "SymC &%s", get_entity_name(get_SymConst_entity(n)));
668 case symconst_ofs_ent:
669 fprintf(F, "SymC %s offset", get_entity_name(get_SymConst_entity(n)));
671 case symconst_type_size:
672 ir_fprintf(F, "SymC %+F size", get_SymConst_type(n));
674 case symconst_type_align:
675 ir_fprintf(F, "SymC %+F align", get_SymConst_type(n));
677 case symconst_enum_const:
678 fprintf(F, "SymC %s enum", get_enumeration_const_name(get_SymConst_enum(n)));
684 if (get_Load_unaligned(n) == align_non_aligned)
686 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Load_mode(n), NULL));
689 if (get_Store_unaligned(n) == align_non_aligned)
691 fprintf(F, "%s", get_irn_opname(n));
694 if (n == get_irg_start_block(get_irn_irg(n)))
696 if (n == get_irg_end_block(get_irn_irg(n)))
698 fprintf(F, "%s%s", get_irn_opname(n),
699 (flags & ir_dump_flag_show_marks) ? (get_Block_mark(n) ? "*" : "") : "");
702 if (get_Conv_strict(n))
703 fprintf(F, "strict");
704 fprintf(F, "%s", get_irn_opname(n));
707 fprintf(F, "%s", get_irn_opname(n));
708 if (get_Div_no_remainder(n))
710 fprintf(F, "[%s]", get_mode_name_ex(get_Div_resmode(n), NULL));
713 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Mod_resmode(n), NULL));
716 fprintf(F, "%s[%s]", get_irn_opname(n), get_builtin_kind_name(get_Builtin_kind(n)));
720 fprintf(F, "%s", get_irn_opname(n));
725 * Dump the mode of a node n to a file F.
726 * Ignore modes that are "always known".
728 static void dump_node_mode(FILE *F, const ir_node *n)
730 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
734 /* call the dump_node operation if available */
735 if (ops->dump_node) {
736 ops->dump_node(F, n, dump_node_mode_txt);
740 /* default implementation */
741 iro = get_irn_opcode(n);
753 mode = get_irn_mode(n);
755 if (mode != NULL && mode != mode_BB && mode != mode_ANY && mode != mode_BAD &&
756 (mode != mode_T || iro == iro_Proj))
757 fprintf(F, "%s", get_mode_name_ex(mode, NULL));
762 * Dump the type of a node n to a file F if it's known.
764 static int dump_node_typeinfo(FILE *F, const ir_node *n)
766 ir_graph *irg = get_irn_irg(n);
769 if (ir_get_dump_flags() & ir_dump_flag_analysed_types) {
770 if (get_irg_typeinfo_state(irg) == ir_typeinfo_consistent ||
771 get_irg_typeinfo_state(irg) == ir_typeinfo_inconsistent) {
772 ir_type *tp = get_irn_typeinfo_type(n);
773 if (tp != get_none_type()) {
774 ir_fprintf(F, "[%+F]", tp);
784 * Dump additional node attributes of some nodes to a file F.
786 static void dump_node_nodeattr(FILE *F, const ir_node *n)
791 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
793 /* call the dump_node operation if available */
794 if (ops->dump_node) {
795 ops->dump_node(F, n, dump_node_nodeattr_txt);
799 switch (get_irn_opcode(n)) {
801 ir_fprintf(F, "%T ", get_Const_tarval(n));
805 pred = get_Proj_pred(n);
806 proj_nr = get_Proj_proj(n);
807 code = get_irn_opcode(pred);
809 if (code == iro_Proj && get_irn_opcode(get_Proj_pred(pred)) == iro_Start)
810 fprintf(F, "Arg %ld ", proj_nr);
811 else if (code == iro_Cond && get_irn_mode(get_Cond_selector(pred)) != mode_b)
812 fprintf(F, "%ld ", proj_nr);
814 unsigned i, j, f = 0;
816 for (i = 0; i < ARRAY_SIZE(proj_lut); ++i) {
817 if (code == proj_lut[i].code) {
818 for (j = 0; j < proj_lut[i].num_data; ++j) {
819 if (proj_nr == proj_lut[i].data[j].nr) {
820 fprintf(F, "%s ", proj_lut[i].data[j].name);
829 fprintf(F, "%ld ", proj_nr);
830 if (code == iro_Cond && get_Cond_jmp_pred(pred) != COND_JMP_PRED_NONE) {
831 if (proj_nr == pn_Cond_false && get_Cond_jmp_pred(pred) == COND_JMP_PRED_FALSE)
833 if (proj_nr == pn_Cond_true && get_Cond_jmp_pred(pred) == COND_JMP_PRED_TRUE)
839 fprintf(F, "%s ", get_ent_dump_name(get_Sel_entity(n)));
842 ir_fprintf(F, "(%+F)", get_Cast_type(n));
845 fprintf(F, "%s ", get_relation_string(get_Cmp_relation(n)));
848 fprintf(F, "%s ", get_relation_string(get_Confirm_relation(n)));
851 ir_fprintf(F, "(%+F)", get_CopyB_type(n));
859 void dump_node_label(FILE *F, const ir_node *n)
861 dump_node_opcode(F, n);
863 dump_node_mode(F, n);
865 dump_node_typeinfo(F, n);
866 dump_node_nodeattr(F, n);
867 if (flags & ir_dump_flag_number_label) {
868 fprintf(F, "%ld", get_irn_node_nr(n));
870 if (flags & ir_dump_flag_idx_label) {
871 fprintf(F, ":%u", get_irn_idx(n));
876 * Dumps the attributes of a node n into the file F.
877 * Currently this is only the color of a node.
879 static void dump_node_vcgattr(FILE *F, const ir_node *node, const ir_node *local, bool bad)
885 print_vcg_color(F, ird_color_error);
889 if (dump_node_vcgattr_hook != NULL) {
890 dump_node_vcgattr_hook(F, node, local);
894 n = local ? local : node;
896 if (overrule_nodecolor != ird_color_default_node) {
897 print_vcg_color(F, overrule_nodecolor);
901 mode = get_irn_mode(n);
902 if (mode == mode_M) {
903 print_vcg_color(F, ird_color_memory);
906 if (mode == mode_X) {
907 print_vcg_color(F, ird_color_controlflow);
911 switch (get_irn_opcode(n)) {
914 print_vcg_color(F, ird_color_anchor);
917 print_vcg_color(F, ird_color_error);
920 print_vcg_color(F, ird_color_block_background);
923 print_vcg_color(F, ird_color_phi);
926 print_vcg_color(F, ird_color_memory);
930 print_vcg_color(F, ird_color_const);
933 print_vcg_color(F, ird_color_proj);
936 ir_op *op = get_irn_op(node);
938 if (is_op_constlike(op)) {
939 print_vcg_color(F, ird_color_const);
940 } else if (is_op_uses_memory(op)) {
941 print_vcg_color(F, ird_color_uses_memory);
942 } else if (is_op_cfopcode(op) || is_op_forking(op)) {
943 print_vcg_color(F, ird_color_controlflow);
949 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data)
951 hook_entry_t *info = XMALLOCZ(hook_entry_t);
953 info->hook._hook_node_info = cb;
954 info->context = data;
955 register_hook(hook_node_info, info);
960 void dump_remove_node_info_callback(void *handle)
962 hook_entry_t *info = (hook_entry_t*)handle;
963 unregister_hook(hook_node_info, info);
968 * Dump the node information of a node n to a file F.
970 static void dump_node_info(FILE *F, const ir_node *n)
972 const ir_op_ops *ops = get_op_ops(get_irn_op(n));
974 fprintf(F, " info1: \"");
975 dump_irnode_to_file(F, n);
976 /* call the dump_node operation if available */
978 ops->dump_node(F, n, dump_node_info_txt);
980 /* allow additional info to be added */
981 hook_node_info(F, n);
985 static int is_constlike_node(const ir_node *node)
987 const ir_op *op = get_irn_op(node);
988 return is_op_constlike(op);
991 static void print_constid(FILE *F, const ir_node *user, const ir_node *node)
993 fprintf(F, "\"n%ldb%ld\"", get_irn_node_nr(user), get_irn_node_nr(node));
996 static void print_constblkid(FILE *F, const ir_node *node, const ir_node *block)
998 fprintf(F, "\"n%ldb%ld\"", get_irn_node_nr(node), get_irn_node_nr(block));
1002 /** outputs the predecessors of n, that are constants, local. I.e.,
1003 generates a copy of the constant predecessors for each node called with. */
1004 static void dump_const_node_local(FILE *F, const ir_node *n)
1006 ir_graph *irg = get_irn_irg(n);
1008 if (!get_opt_dump_const_local()) return;
1010 /* Use visited flag to avoid outputting nodes twice.
1011 initialize it first. */
1012 for (i = 0; i < get_irn_arity(n); i++) {
1013 ir_node *con = get_irn_n(n, i);
1014 if (is_constlike_node(con)) {
1015 set_irn_visited(con, get_irg_visited(irg) - 1);
1019 for (i = 0; i < get_irn_arity(n); i++) {
1020 ir_node *con = get_irn_n(n, i);
1021 if (is_constlike_node(con) && !irn_visited_else_mark(con)) {
1022 /* Generate a new name for the node by appending the names of
1024 fprintf(F, "node: {title: ");
1025 print_constid(F, n, con);
1026 fprintf(F, " label: \"");
1027 dump_node_label(F, con);
1029 dump_node_info(F, con);
1030 dump_node_vcgattr(F, n, con, 0);
1036 /** If the block of an edge is a const_like node, dump it local with an edge */
1037 static void dump_const_block_local(FILE *F, const ir_node *n)
1041 if (!get_opt_dump_const_local()) return;
1043 blk = get_nodes_block(n);
1044 if (is_constlike_node(blk)) {
1045 /* Generate a new name for the node by appending the names of
1047 fprintf(F, "node: {title: ");
1048 print_constblkid(F, n, blk);
1049 fprintf(F, " label: \"");
1050 dump_node_label(F, blk);
1052 dump_node_info(F, blk);
1053 dump_node_vcgattr(F, n, blk, 0);
1056 fprintf(F, "edge: { sourcename: ");
1058 fprintf(F, " targetname: ");
1059 print_constblkid(F, n, blk);
1062 if (dump_edge_vcgattr_hook != NULL
1063 && dump_edge_vcgattr_hook(F, n, -1)) {
1068 fprintf(F, BLOCK_EDGE_ATTR "}\n");
1073 * prints the error message of a node to a file F as info2.
1075 static void print_node_error(FILE *F, const char *err_msg)
1080 fprintf(F, " info2: \"%s\"", err_msg);
1084 * prints debug messages of a node to file F as info3.
1086 static void print_dbg_info(FILE *F, dbg_info *dbg)
1090 ir_dbg_info_snprint(buf, sizeof(buf), dbg);
1092 fprintf(F, " info3: \"%s\"\n", buf);
1096 static void print_type_dbg_info(FILE *F, type_dbg_info *dbg)
1106 void dump_node(FILE *F, const ir_node *n)
1112 if (get_opt_dump_const_local() && is_constlike_node(n))
1115 /* dump this node */
1116 fputs("node: {title: ", F);
1119 fputs(" label: \"", F);
1120 irg = get_irn_irg(n);
1121 bad = ! irn_verify_irg_dump(n, irg, &p);
1122 dump_node_label(F, n);
1125 dump_node_info(F, n);
1126 print_node_error(F, p);
1127 print_dbg_info(F, get_irn_dbg_info(n));
1128 dump_node_vcgattr(F, n, NULL, bad);
1130 dump_const_node_local(F, n);
1134 /** dump the edge to the block this node belongs to */
1135 static void dump_ir_block_edge(FILE *F, const ir_node *n)
1137 if (get_opt_dump_const_local() && is_constlike_node(n)) return;
1139 ir_node *block = get_nodes_block(n);
1141 if (get_opt_dump_const_local() && is_constlike_node(block)) {
1142 dump_const_block_local(F, n);
1144 fprintf(F, "edge: { sourcename: ");
1146 fprintf(F, " targetname: ");
1147 print_nodeid(F, block);
1150 if (dump_edge_vcgattr_hook && dump_edge_vcgattr_hook(F, n, -1)) {
1155 fprintf(F, BLOCK_EDGE_ATTR "}\n");
1160 static void print_data_edge_vcgattr(FILE *F, const ir_node *from, int to)
1163 * do not use get_nodes_block() here, will fail
1164 * if the irg is not pinned.
1166 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1167 fprintf(F, INTRA_DATA_EDGE_ATTR);
1169 fprintf(F, INTER_DATA_EDGE_ATTR);
1172 static void print_mem_edge_vcgattr(FILE *F, const ir_node *from, int to)
1175 * do not use get_nodes_block() here, will fail
1176 * if the irg is not pinned.
1178 if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1179 fprintf(F, INTRA_MEM_EDGE_ATTR);
1181 fprintf(F, INTER_MEM_EDGE_ATTR);
1184 /** Print the vcg attributes for the edge from node "from" to its "to"th input */
1185 static void print_edge_vcgattr(FILE *F, const ir_node *from, int to)
1189 if (dump_edge_vcgattr_hook)
1190 if (dump_edge_vcgattr_hook(F, from, to))
1193 if ((flags & ir_dump_flag_back_edges) && is_backedge(from, to))
1194 fprintf(F, BACK_EDGE_ATTR);
1196 switch (get_irn_opcode(from)) {
1198 fprintf(F, CF_EDGE_ATTR);
1200 case iro_Start: break;
1203 if (get_irn_mode(get_End_keepalive(from, to)) == mode_BB)
1204 fprintf(F, KEEP_ALIVE_CF_EDGE_ATTR);
1206 fprintf(F, KEEP_ALIVE_DF_EDGE_ATTR);
1210 if (is_Proj(from)) {
1211 if (get_irn_mode(from) == mode_M)
1212 print_mem_edge_vcgattr(F, from, to);
1213 else if (get_irn_mode(from) == mode_X)
1214 fprintf(F, CF_EDGE_ATTR);
1216 print_data_edge_vcgattr(F, from, to);
1218 else if (get_irn_mode(get_irn_n(from, to)) == mode_M)
1219 print_mem_edge_vcgattr(F, from, to);
1220 else if (get_irn_mode(get_irn_n(from, to)) == mode_X)
1221 fprintf(F, CF_EDGE_ATTR);
1223 print_data_edge_vcgattr(F, from, to);
1227 /** dump edges to our inputs */
1228 static void dump_ir_data_edges(FILE *F, const ir_node *n)
1232 if (dump_node_edge_hook)
1233 dump_node_edge_hook(F, n);
1235 if (!(flags & ir_dump_flag_keepalive_edges) && is_End(n)) {
1236 /* the End node has only keep-alive edges */
1240 /* dump the dependency edges. */
1241 num = get_irn_deps(n);
1242 for (i = 0; i < num; ++i) {
1243 ir_node *dep = get_irn_dep(n, i);
1246 print_node_edge_kind(F, n);
1247 fprintf(F, "{sourcename: ");
1249 fprintf(F, " targetname: ");
1250 if ((get_opt_dump_const_local()) && is_constlike_node(dep)) {
1251 print_constid(F, n, dep);
1253 print_nodeid(F, dep);
1255 fprintf(F, " label: \"%d\" ", i);
1256 fprintf(F, " color: darkgreen}\n");
1260 num = get_irn_arity(n);
1261 for (i = 0; i < num; i++) {
1262 ir_node *pred = get_irn_n(n, i);
1265 if ((flags & ir_dump_flag_back_edges) && is_backedge(n, i)) {
1266 fprintf(F, "backedge: {sourcename: ");
1268 print_node_edge_kind(F, n);
1269 fprintf(F, "{sourcename: ");
1272 fprintf(F, " targetname: ");
1273 if ((get_opt_dump_const_local()) && is_constlike_node(pred)) {
1274 print_constid(F, n, pred);
1276 print_nodeid(F, pred);
1278 fprintf(F, " label: \"%d\" ", i);
1279 print_edge_vcgattr(F, n, i);
1287 static void dump_ir_edges(ir_node *node, void *env)
1290 FILE *F = (FILE*)env;
1291 const ir_edge_t *edge;
1293 foreach_out_edge(node, edge) {
1294 ir_node *succ = get_edge_src_irn(edge);
1296 print_node_edge_kind(F, succ);
1297 fprintf(F, "{sourcename: ");
1298 print_nodeid(F, node);
1299 fprintf(F, " targetname: ");
1300 print_nodeid(F, succ);
1302 fprintf(F, " label: \"%d\" ", i);
1303 fprintf(F, OUT_EDGE_ATTR);
1310 /** Dumps a node and its edges but not the block edge */
1311 static void dump_node_wo_blockedge(FILE *F, const ir_node *n)
1314 dump_ir_data_edges(F, n);
1317 /** Dumps a node and its edges. */
1318 static void dump_node_with_edges(ir_node *n, void *env)
1320 FILE *F = (FILE*)env;
1321 dump_node_wo_blockedge(F, n);
1322 if (!node_floats(n))
1323 dump_ir_block_edge(F, n);
1326 /** Dumps a const-like node. */
1327 static void dump_const_node(ir_node *n, void *env)
1329 FILE *F = (FILE*)env;
1330 if (is_Block(n)) return;
1331 dump_node_wo_blockedge(F, n);
1334 /***********************************************************************/
1335 /* the following routines dump the nodes/irgs bracketed to graphs. */
1336 /***********************************************************************/
1338 /** Dumps a constant expression as entity initializer, array bound ... */
1339 static void dump_const_expression(FILE *F, ir_node *value)
1341 ir_graph *irg = get_const_code_irg();
1342 ir_dump_flags_t old_flags = ir_get_dump_flags();
1343 ir_remove_dump_flags(ir_dump_flag_consts_local);
1345 irg_walk(value, dump_const_node, NULL, F);
1346 /* Decrease visited flag so that we walk with the same flag for the next
1347 expression. This guarantees that we don't dump the same node twice,
1348 as for const expressions cse is performed to save memory. */
1349 set_irg_visited(irg, get_irg_visited(irg) -1);
1351 ir_set_dump_flags(old_flags);
1354 /** Dump a block as graph containing its nodes.
1356 * Expects to find nodes belonging to the block as list in its
1358 * Dumps the edges of all nodes including itself. */
1359 static void dump_whole_block(FILE *F, const ir_node *block)
1362 ird_color_t color = ird_color_block_background;
1364 assert(is_Block(block));
1366 fprintf(F, "graph: { title: ");
1367 print_nodeid(F, block);
1368 fprintf(F, " label: \"");
1369 dump_node_label(F, block);
1371 /* colorize blocks */
1372 if (! get_Block_matured(block))
1373 color = ird_color_block_background;
1375 fprintf(F, "\" status:clustered ");
1376 print_vcg_color(F, color);
1379 /* yComp can show attributes for blocks, XVCG parses but ignores them */
1380 dump_node_info(F, block);
1381 print_dbg_info(F, get_irn_dbg_info(block));
1383 /* dump the blocks edges */
1384 dump_ir_data_edges(F, block);
1386 if (dump_block_edge_hook)
1387 dump_block_edge_hook(F, block);
1389 /* dump the nodes that go into the block */
1390 for (node = (ir_node*)ird_get_irn_link(block); node; node = (ir_node*)ird_get_irn_link(node)) {
1392 dump_ir_data_edges(F, node);
1395 /* Close the vcg information for the block */
1397 dump_const_node_local(F, block);
1401 /** dumps a graph block-wise. Expects all blockless nodes in arr in irgs link.
1402 * The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1403 static void dump_block_graph(FILE *F, ir_graph *irg)
1406 ir_node **arr = (ir_node**)ird_get_irg_link(irg);
1408 for (i = 0, n = ARR_LEN(arr); i < n; ++i) {
1409 ir_node *node = arr[i];
1410 if (is_Block(node)) {
1411 /* Dumps the block and all the nodes in the block, which are to
1412 be found in Block->link. */
1413 dump_whole_block(F, node);
1415 /* Nodes that are not in a Block. */
1417 if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
1418 dump_const_block_local(F, node);
1420 dump_ir_data_edges(F, node);
1422 if ((flags & ir_dump_flag_iredges) && edges_activated(irg))
1423 dump_ir_edges(node, F);
1426 if ((flags & ir_dump_flag_loops)
1427 && is_irg_state(irg, IR_GRAPH_STATE_CONSISTENT_LOOPINFO))
1428 dump_loop_nodes_into_graph(F, irg);
1432 * Dump the info for an irg.
1433 * Parsed by XVCG but not shown. use yComp.
1435 static void dump_graph_info(FILE *F, ir_graph *irg)
1437 fprintf(F, "info1: \"");
1438 dump_entity_to_file(F, get_irg_entity(irg));
1441 /* dump graph state */
1442 fprintf(F, "state:");
1443 if (is_irg_state(irg, IR_GRAPH_STATE_ARCH_DEP))
1444 fprintf(F, " arch_dep");
1445 if (is_irg_state(irg, IR_GRAPH_STATE_MODEB_LOWERED))
1446 fprintf(F, " modeb_lowered");
1447 if (is_irg_state(irg, IR_GRAPH_STATE_NORMALISATION2))
1448 fprintf(F, " normalisation2");
1449 if (is_irg_state(irg, IR_GRAPH_STATE_IMPLICIT_BITFIELD_MASKING))
1450 fprintf(F, " implicit_bitfield_masking");
1451 if (is_irg_state(irg, IR_GRAPH_STATE_OPTIMIZE_UNREACHABLE_CODE))
1452 fprintf(F, " optimize_unreachable_code");
1453 if (is_irg_state(irg, IR_GRAPH_STATE_NO_CRITICAL_EDGES))
1454 fprintf(F, " no_critical_edges");
1455 if (is_irg_state(irg, IR_GRAPH_STATE_NO_BADS))
1456 fprintf(F, " no_bads");
1457 if (is_irg_state(irg, IR_GRAPH_STATE_NO_UNREACHABLE_CODE))
1458 fprintf(F, " no_unreachable_code");
1459 if (is_irg_state(irg, IR_GRAPH_STATE_ONE_RETURN))
1460 fprintf(F, " one_return");
1461 if (is_irg_state(irg, IR_GRAPH_STATE_CONSISTENT_DOMINANCE))
1462 fprintf(F, " consistent_dominance");
1463 if (is_irg_state(irg, IR_GRAPH_STATE_CONSISTENT_POSTDOMINANCE))
1464 fprintf(F, " consistent_postdominance");
1465 if (is_irg_state(irg, IR_GRAPH_STATE_CONSISTENT_OUT_EDGES))
1466 fprintf(F, " consistent_out_edges");
1467 if (is_irg_state(irg, IR_GRAPH_STATE_CONSISTENT_OUTS))
1468 fprintf(F, " consistent_outs");
1469 if (is_irg_state(irg, IR_GRAPH_STATE_CONSISTENT_LOOPINFO))
1470 fprintf(F, " consistent_loopinfo");
1471 if (is_irg_state(irg, IR_GRAPH_STATE_CONSISTENT_ENTITY_USAGE))
1472 fprintf(F, " consistent_entity_usage");
1476 /** Dumps an irg as a graph clustered by block nodes.
1477 * If interprocedural view edges can point to nodes out of this graph.
1479 static void dump_graph_from_list(FILE *F, ir_graph *irg)
1481 ir_entity *ent = get_irg_entity(irg);
1483 fprintf(F, "graph: { title: ");
1484 print_irgid(F, irg);
1485 fprintf(F, " label: \"%s\" status:clustered color:%s\n",
1486 get_ent_dump_name(ent), color_names[ird_color_prog_background]);
1488 dump_graph_info(F, irg);
1489 print_dbg_info(F, get_entity_dbg_info(ent));
1491 dump_block_graph(F, irg);
1493 /* Close the vcg information for the irg */
1494 fprintf(F, "}\n\n");
1497 /*******************************************************************/
1498 /* Basic type and entity nodes and edges. */
1499 /*******************************************************************/
1501 /** dumps the edges between nodes and their type or entity attributes. */
1502 static void dump_node2type_edges(ir_node *n, void *env)
1504 FILE *F = (FILE*)env;
1507 switch (get_irn_opcode(n)) {
1509 /* @@@ some consts have an entity */
1512 if (SYMCONST_HAS_TYPE(get_SymConst_kind(n)))
1513 print_node_type_edge(F,n,get_SymConst_type(n),NODE2TYPE_EDGE_ATTR);
1516 print_node_ent_edge(F,n,get_Sel_entity(n),NODE2TYPE_EDGE_ATTR);
1519 print_node_type_edge(F,n,get_Call_type(n),NODE2TYPE_EDGE_ATTR);
1522 print_node_type_edge(F,n,get_Alloc_type(n),NODE2TYPE_EDGE_ATTR);
1525 print_node_type_edge(F,n,get_Free_type(n),NODE2TYPE_EDGE_ATTR);
1528 print_node_type_edge(F,n,get_Cast_type(n),NODE2TYPE_EDGE_ATTR);
1535 static void print_typespecific_vcgattr(FILE *F, ir_type *tp)
1537 switch (get_type_tpop_code(tp)) {
1539 fprintf(F, " " TYPE_CLASS_NODE_ATTR);
1542 fprintf(F, " " TYPE_METH_NODE_ATTR);
1550 case tpo_enumeration:
1561 void dump_type_node(FILE *F, ir_type *tp)
1563 fprintf(F, "node: {title: ");
1564 print_typeid(F, tp);
1565 fprintf(F, " label: \"");
1566 if (tp->dbi != NULL) {
1568 ir_print_type(buf, sizeof(buf), tp);
1569 fprintf(F, "%s '%s'", get_type_tpop_name(tp), buf);
1571 ir_fprintf(F, "%+F", tp);
1573 fputs("\" info1: \"", F);
1574 dump_type_to_file(F, tp);
1576 print_type_dbg_info(F, get_type_dbg_info(tp));
1577 print_typespecific_vcgattr(F, tp);
1581 static void dump_entity_node(FILE *F, ir_entity *ent)
1583 fprintf(F, "node: {title: ");
1584 print_entityid(F, ent);
1585 fprintf(F, " label: ");
1586 fprintf(F, "\"%s\" ", get_ent_dump_name(ent));
1588 print_vcg_color(F, ird_color_entity);
1589 fprintf(F, "\n info1: \"");
1591 dump_entity_to_file(F, ent);
1594 print_dbg_info(F, get_entity_dbg_info(ent));
1598 static void dump_enum_item(FILE *F, ir_type *tp, size_t pos)
1601 ir_enum_const *ec = get_enumeration_const(tp, pos);
1602 ident *id = get_enumeration_const_nameid(ec);
1603 ir_tarval *tv = get_enumeration_value(ec);
1606 tarval_snprintf(buf, sizeof(buf), tv);
1608 strncpy(buf, "<not set>", sizeof(buf));
1609 fprintf(F, "node: {title: ");
1610 print_itemid(F, tp, pos);
1611 fprintf(F, " label: ");
1612 fprintf(F, "\"enum item %s\" " ENUM_ITEM_NODE_ATTR, get_id_str(id));
1613 fprintf(F, "\n info1: \"value: %s\"}\n", buf);
1617 * Dumps a new style initializer.
1619 static void dump_entity_initializer(FILE *F, const ir_entity *ent)
1627 * type-walker: Dumps a type or entity and its edges.
1629 static void dump_type_info(type_or_ent tore, void *env)
1631 FILE *F = (FILE*)env;
1632 size_t i = 0; /* to shutup gcc */
1634 /* dump this type or entity */
1636 switch (get_kind(tore.ent)) {
1638 ir_entity *ent = tore.ent;
1641 dump_entity_node(F, ent);
1643 /* skip this to reduce graph. Member edge of type is parallel to this edge. *
1644 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
1645 ENT_OWN_EDGE_ATTR "}\n", ent, get_entity_owner(ent));*/
1646 print_ent_type_edge(F,ent, get_entity_type(ent), ENT_TYPE_EDGE_ATTR);
1647 if (is_Class_type(get_entity_owner(ent))) {
1648 for (i = get_entity_n_overwrites(ent); i > 0;)
1649 print_ent_ent_edge(F, ent, get_entity_overwrites(ent, --i), 0, ird_color_none, ENT_OVERWRITES_EDGE_ATTR);
1651 /* attached subgraphs */
1652 if (! (flags & ir_dump_flag_no_entity_values)) {
1653 if (ent->initializer != NULL) {
1654 /* new style initializers */
1655 dump_entity_initializer(F, ent);
1656 } else if (entity_has_compound_ent_values(ent)) {
1657 /* old style compound entity values */
1658 for (i = get_compound_ent_n_values(ent); i > 0;) {
1659 value = get_compound_ent_value(ent, --i);
1661 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
1662 dump_const_expression(F, value);
1663 print_ent_ent_edge(F, ent, get_compound_ent_value_member(ent, i), 0, ird_color_none, ENT_CORR_EDGE_ATTR, i);
1665 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
1666 ENT_CORR_EDGE_ATTR "}\n", GET_ENTID(ent),
1667 get_compound_ent_value_member(ent, i), i);
1676 ir_type *tp = tore.typ;
1677 dump_type_node(F, tp);
1678 /* and now the edges */
1679 switch (get_type_tpop_code(tp)) {
1681 for (i = get_class_n_supertypes(tp); i > 0;) {
1683 print_type_type_edge(F, tp, get_class_supertype(tp, i), TYPE_SUPER_EDGE_ATTR);
1685 for (i = get_class_n_members(tp); i > 0;) {
1687 print_type_ent_edge(F, tp, get_class_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
1691 for (i = get_struct_n_members(tp); i > 0;) {
1693 print_type_ent_edge(F, tp, get_struct_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
1697 for (i = get_method_n_params(tp); i > 0;) {
1699 print_type_type_edge(F, tp, get_method_param_type(tp, i), METH_PAR_EDGE_ATTR,i);
1701 for (i = get_method_n_ress(tp); i > 0;) {
1703 print_type_type_edge(F, tp, get_method_res_type(tp, i), METH_RES_EDGE_ATTR,i);
1707 for (i = get_union_n_members(tp); i > 0;) {
1709 print_type_ent_edge(F, tp, get_union_member(tp, i), UNION_EDGE_ATTR);
1713 print_type_type_edge(F, tp, get_array_element_type(tp), ARR_ELT_TYPE_EDGE_ATTR);
1714 print_type_ent_edge(F, tp, get_array_element_entity(tp), ARR_ENT_EDGE_ATTR);
1715 for (i = get_array_n_dimensions(tp); i > 0;) {
1716 ir_node *upper, *lower;
1719 upper = get_array_upper_bound(tp, i);
1720 lower = get_array_lower_bound(tp, i);
1721 print_node_type_edge(F, upper, tp, "label: \"upper %zu\"", get_array_order(tp, i));
1722 print_node_type_edge(F, lower, tp, "label: \"lower %zu\"", get_array_order(tp, i));
1723 dump_const_expression(F, upper);
1724 dump_const_expression(F, lower);
1727 case tpo_enumeration:
1728 for (i = get_enumeration_n_enums(tp); i > 0;) {
1730 dump_enum_item(F, tp, i);
1731 print_enum_item_edge(F, tp, i, "label: \"item %zu\"", i);
1735 print_type_type_edge(F, tp, get_pointer_points_to_type(tp), PTR_PTS_TO_EDGE_ATTR);
1739 case tpo_uninitialized:
1744 break; /* case k_type */
1747 printf(" *** irdump, dump_type_info(l.%i), faulty type.\n", __LINE__);
1751 /** For dumping class hierarchies.
1752 * Dumps a class type node and a superclass edge.
1754 static void dump_class_hierarchy_node(type_or_ent tore, void *ctx)
1756 FILE *F = (FILE*)ctx;
1757 size_t i = 0; /* to shutup gcc */
1759 /* dump this type or entity */
1760 switch (get_kind(tore.ent)) {
1762 ir_entity *ent = tore.ent;
1763 if (get_entity_owner(ent) == get_glob_type()) break;
1764 if (!is_Method_type(get_entity_type(ent)))
1766 if (flags & ir_dump_flag_entities_in_hierarchy
1767 && is_Class_type(get_entity_owner(ent))) {
1769 dump_entity_node(F, ent);
1771 print_type_ent_edge(F, get_entity_owner(ent), ent, TYPE_MEMBER_EDGE_ATTR);
1772 for (i = get_entity_n_overwrites(ent); i > 0;) {
1774 print_ent_ent_edge(F, get_entity_overwrites(ent, i), ent, 0, ird_color_none, ENT_OVERWRITES_EDGE_ATTR);
1780 ir_type *tp = tore.typ;
1781 if (tp == get_glob_type())
1783 switch (get_type_tpop_code(tp)) {
1785 dump_type_node(F, tp);
1786 /* and now the edges */
1787 for (i = get_class_n_supertypes(tp); i > 0;) {
1789 print_type_type_edge(F,tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
1794 break; /* case k_type */
1797 printf(" *** irdump, dump_class_hierarchy_node(l.%i), faulty type.\n", __LINE__);
1801 /*******************************************************************/
1802 /* dump analysis information that is expressed in graph terms. */
1803 /*******************************************************************/
1805 /* dump out edges */
1806 static void dump_out_edge(ir_node *n, void *env)
1808 FILE *F = (FILE*)env;
1810 for (i = get_irn_n_outs(n) - 1; i >= 0; --i) {
1811 ir_node *succ = get_irn_out(n, i);
1813 print_node_edge_kind(F, succ);
1814 fprintf(F, "{sourcename: ");
1816 fprintf(F, " targetname: ");
1817 print_nodeid(F, succ);
1818 fprintf(F, " color: red linestyle: dashed");
1823 static void dump_loop_label(FILE *F, const ir_loop *loop)
1825 fprintf(F, "loop %u", get_loop_depth(loop));
1828 static void dump_loop_info(FILE *F, const ir_loop *loop)
1830 fprintf(F, " info1: \"");
1831 fprintf(F, " loop nr: %ld", get_loop_loop_nr(loop));
1832 #ifdef DEBUG_libfirm
1833 fprintf(F, "\n The loop was analyzed %ld times.", (long int) PTR_TO_INT(get_loop_link(loop)));
1838 void print_loopid(FILE *F, const ir_loop *loop)
1840 fprintf(F, "\"l%ld\"", get_loop_loop_nr(loop));
1843 static void dump_loop_node(FILE *F, const ir_loop *loop)
1845 fprintf(F, "node: {title: ");
1846 print_loopid(F, loop);
1847 fprintf(F, " label: \"");
1848 dump_loop_label(F, loop);
1850 dump_loop_info(F, loop);
1854 static void dump_loop_node_edge(FILE *F, const ir_loop *loop, size_t i)
1857 fprintf(F, "edge: {sourcename: ");
1858 print_loopid(F, loop);
1859 fprintf(F, " targetname: ");
1860 print_nodeid(F, get_loop_element(loop, i).node);
1861 fprintf(F, " color: green");
1865 static void dump_loop_son_edge(FILE *F, const ir_loop *loop, size_t i)
1868 fprintf(F, "edge: {sourcename: ");
1869 print_loopid(F, loop);
1870 fprintf(F, " targetname: ");
1871 print_loopid(F, get_loop_element(loop, i).son);
1872 ir_fprintf(F, " color: darkgreen label: \"%zu\"}\n", i);
1875 static void dump_loops(FILE *F, const ir_loop *loop)
1878 size_t n_elements = get_loop_n_elements(loop);
1879 /* dump this loop node */
1880 dump_loop_node(F, loop);
1882 /* dump edges to nodes in loop -- only if it is a real loop */
1883 if (get_loop_depth(loop) != 0) {
1884 for (i = n_elements; i > 0;) {
1885 loop_element element;
1887 element = get_loop_element(loop, i);
1888 if (*element.kind != k_ir_node)
1890 dump_loop_node_edge(F, loop, i);
1893 for (i = n_elements; i > 0;) {
1894 loop_element element;
1896 element = get_loop_element(loop, i);
1897 if (*element.kind != k_ir_loop)
1899 dump_loops(F, element.son);
1900 dump_loop_son_edge(F, loop, i);
1904 static void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg)
1906 ir_loop *loop = get_irg_loop(irg);
1908 dump_loops(F, loop);
1912 void dump_vcg_header_colors(FILE *F)
1916 for (i = 0; i < ird_color_count; ++i) {
1917 if (color_rgb[i] != NULL) {
1918 fprintf(F, "colorentry %s: %s\n", color_names[i], color_rgb[i]);
1923 void dump_vcg_infonames(FILE *F)
1926 "infoname 1: \"Attribute\"\n"
1927 "infoname 2: \"Verification errors\"\n"
1928 "infoname 3: \"Debug info\"\n", F);
1932 * dumps the VCG header
1934 void dump_vcg_header(FILE *F, const char *name, const char *layout, const char *orientation)
1937 = (flags & ir_dump_flag_disable_edge_labels) ? "no" : "yes";
1939 if (! layout) layout = "Compilergraph";
1940 if (!orientation) orientation = "bottom_to_top";
1944 "graph: { title: \"ir graph of %s\"\n"
1945 "display_edge_labels: %s\n"
1946 "layoutalgorithm: mindepth //$ \"%s\"\n"
1947 "manhattan_edges: yes\n"
1948 "port_sharing: no\n"
1950 "classname 1: \"intrablock Data\"\n"
1951 "classname 2: \"Block\"\n"
1952 "classname 3: \"Entity type\"\n"
1953 "classname 4: \"Entity owner\"\n"
1954 "classname 5: \"Method Param\"\n"
1955 "classname 6: \"Method Res\"\n"
1956 "classname 7: \"Super\"\n"
1957 "classname 8: \"Union\"\n"
1958 "classname 9: \"Points-to\"\n"
1959 "classname 10: \"Array Element Type\"\n"
1960 "classname 11: \"Overwrites\"\n"
1961 "classname 12: \"Member\"\n"
1962 "classname 13: \"Control Flow\"\n"
1963 "classname 14: \"intrablock Memory\"\n"
1964 "classname 15: \"Dominators\"\n"
1965 "classname 16: \"interblock Data\"\n"
1966 "classname 17: \"interblock Memory\"\n"
1967 "classname 18: \"Exception Control Flow for Interval Analysis\"\n"
1968 "classname 19: \"Postdominators\"\n"
1969 "classname 20: \"Keep Alive\"\n"
1970 "classname 21: \"Out Edges\"\n"
1971 "classname 22: \"Macro Block Edges\"\n",
1972 name, label, layout, orientation);
1973 dump_vcg_infonames(F);
1974 dump_vcg_header_colors(F);
1979 * Dumps the vcg file footer
1981 void dump_vcg_footer(FILE *F)
1988 static void dump_blocks_as_subgraphs(FILE *out, ir_graph *irg)
1992 construct_block_lists(irg);
1995 * If we are in the interprocedural view, we dump not
1996 * only the requested irg but also all irgs that can be reached
1999 for (i = get_irp_n_irgs(); i > 0;) {
2000 ir_graph *other_irg = get_irp_irg(--i);
2001 ir_node **arr = (ir_node**)ird_get_irg_link(other_irg);
2005 dump_graph_from_list(out, other_irg);
2010 void dump_ir_graph_file(FILE *out, ir_graph *irg)
2012 dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2015 if (flags & ir_dump_flag_blocks_as_subgraphs) {
2016 dump_blocks_as_subgraphs(out, irg);
2018 /* dump_node_with_edges must be called in post visiting predecessors */
2019 ird_walk_graph(irg, NULL, dump_node_with_edges, out);
2022 /* dump type info */
2023 if (flags & ir_dump_flag_with_typegraph) {
2024 type_walk_irg(irg, dump_type_info, NULL, out);
2025 inc_irg_visited(get_const_code_irg());
2026 /* dump edges from graph to type info */
2027 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2030 /* dump iredges out edges */
2031 if ((flags & ir_dump_flag_iredges) && edges_activated(irg)) {
2032 irg_walk_edges(get_irg_start_block(irg), dump_ir_edges, NULL, out);
2035 /* dump the out edges in a separate walk */
2036 if ((flags & ir_dump_flag_out_edges)
2037 && (is_irg_state(irg, IR_GRAPH_STATE_CONSISTENT_OUTS))) {
2038 irg_out_walk(get_irg_start(irg), dump_out_edge, NULL, out);
2041 dump_vcg_footer(out);
2044 static void dump_block_to_cfg(ir_node *block, void *env)
2046 FILE *F = (FILE*)env;
2049 if (is_Bad(block) && get_irn_mode(block) == mode_X) {
2050 dump_node(F, block);
2053 if (is_Block(block)) {
2054 /* This is a block. Dump a node for the block. */
2055 fprintf(F, "node: {title: ");
2056 print_nodeid(F, block);
2057 fprintf(F, " label: \"");
2058 if (block == get_irg_start_block(get_irn_irg(block)))
2059 fprintf(F, "Start ");
2060 if (block == get_irg_end_block(get_irn_irg(block)))
2063 fprintf(F, "%s ", get_op_name(get_irn_op(block)));
2064 print_nodeid(F, block);
2066 fprintf(F, "info1:\"");
2068 /* the generic version. */
2069 dump_irnode_to_file(F, block);
2071 fprintf(F, "\""); /* closing quote of info */
2073 if ((block == get_irg_start_block(get_irn_irg(block))) ||
2074 (block == get_irg_end_block(get_irn_irg(block))) )
2075 fprintf(F, " color:blue ");
2079 /* Dump the edges */
2080 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i) {
2081 ir_node *pred = get_Block_cfgpred(block, i);
2083 pred = get_nodes_block(pred);
2084 fprintf(F, "edge: { sourcename: ");
2085 print_nodeid(F, block);
2086 fprintf(F, " targetname: ");
2087 print_nodeid(F, pred);
2088 fprintf(F, "\"}\n");
2091 /* Dump dominator/postdominator edge */
2092 if (ir_get_dump_flags() & ir_dump_flag_dominance) {
2093 if (is_irg_state(get_irn_irg(block), IR_GRAPH_STATE_CONSISTENT_DOMINANCE) && get_Block_idom(block)) {
2094 ir_node *pred = get_Block_idom(block);
2095 fprintf(F, "edge: { sourcename: ");
2096 print_nodeid(F, block);
2097 fprintf(F, " targetname: ");
2098 print_nodeid(F, pred);
2099 fprintf(F, " " DOMINATOR_EDGE_ATTR "}\n");
2101 if (is_irg_state(get_irn_irg(block), IR_GRAPH_STATE_CONSISTENT_POSTDOMINANCE) && get_Block_ipostdom(block)) {
2102 ir_node *pred = get_Block_ipostdom(block);
2103 fprintf(F, "edge: { sourcename: ");
2104 print_nodeid(F, block);
2105 fprintf(F, " targetname: ");
2106 print_nodeid(F, pred);
2107 fprintf(F, " " POSTDOMINATOR_EDGE_ATTR "}\n");
2113 void dump_cfg(FILE *F, ir_graph *irg)
2115 dump_vcg_header(F, get_irg_dump_name(irg), NULL, NULL);
2117 /* walk over the blocks in the graph */
2118 irg_walk_graph(irg, dump_block_to_cfg, NULL, F);
2123 void dump_callgraph(FILE *F)
2126 ir_dump_flags_t old_flags = ir_get_dump_flags();
2128 ir_remove_dump_flags(ir_dump_flag_disable_edge_labels);
2129 dump_vcg_header(F, "Callgraph", "Hierarchic", NULL);
2131 for (i = get_irp_n_irgs(); i > 0;) {
2132 ir_graph *irg = get_irp_irg(--i);
2133 ir_entity *ent = get_irg_entity(irg);
2134 size_t j, n_callees = get_irg_n_callees(irg);
2136 dump_entity_node(F, ent);
2137 for (j = 0; j < n_callees; ++j) {
2138 ir_entity *c = get_irg_entity(get_irg_callee(irg, j));
2139 int be = is_irg_callee_backedge(irg, j);
2140 const char *attr = be
2141 ? "label:\"recursion %zu\""
2142 : "label:\"calls %zu\"";
2143 print_ent_ent_edge(F, ent, c, be, ird_color_entity, attr,
2144 get_irg_callee_loop_depth(irg, j));
2148 ir_set_dump_flags(old_flags);
2152 void dump_typegraph(FILE *out)
2154 dump_vcg_header(out, "All_types", NULL, NULL);
2155 type_walk(dump_type_info, NULL, out);
2156 dump_vcg_footer(out);
2159 void dump_class_hierarchy(FILE *out)
2161 dump_vcg_header(out, "class_hierarchy", NULL, NULL);
2162 type_walk(dump_class_hierarchy_node, NULL, out);
2163 dump_vcg_footer(out);
2166 static void dump_loops_standalone(FILE *F, ir_loop *loop)
2169 bool loop_node_started = false;
2171 size_t son_number = 0;
2173 ir_loop *son = NULL;
2175 /* Dump a new loop node. */
2176 dump_loop_node(F, loop);
2178 /* Dump the loop elements. */
2179 for (i = 0; i < get_loop_n_elements(loop); i++) {
2180 le = get_loop_element(loop, i);
2182 if (get_kind(son) == k_ir_loop) {
2184 /* We are a loop son -> Recurse */
2186 if (loop_node_started) { /* Close the "firm-nodes" node first if we started one. */
2187 fprintf(F, "\" }\n");
2188 fprintf(F, "edge: {sourcename: ");
2189 print_loopid(F, loop);
2190 fprintf(F, " targetname: \"l%ld-%lu-nodes\" label:\"%lu...%lu\"}\n",
2191 get_loop_loop_nr(loop),
2192 (unsigned long) first,
2193 (unsigned long) first,
2194 (unsigned long) i-1);
2195 loop_node_started = false;
2197 dump_loop_son_edge(F, loop, son_number++);
2198 dump_loops_standalone(F, son);
2199 } else if (get_kind(son) == k_ir_node) {
2200 /* We are a loop node -> Collect firm nodes */
2202 ir_node *n = le.node;
2203 if (!loop_node_started) {
2204 /* Start a new node which contains all firm nodes of the current loop */
2205 fprintf(F, "node: { title: \"l%ld-%lu-nodes\" color: lightyellow label: \"",
2206 get_loop_loop_nr(loop),
2208 loop_node_started = true;
2213 dump_node_label(F, n);
2214 if (has_backedges(n)) fprintf(F, "\t loop head!");
2215 } else { /* for callgraph loop tree */
2217 assert(get_kind(son) == k_ir_graph);
2219 /* We are a loop node -> Collect firm graphs */
2221 if (!loop_node_started) {
2222 /* Start a new node which contains all firm nodes of the current loop */
2223 fprintf(F, "node: { title: \"l%ld-%lu-nodes\" color: lightyellow label: \"",
2224 get_loop_loop_nr(loop),
2226 loop_node_started = true;
2230 fprintf(F, " %s", get_irg_dump_name(n));
2231 /* fprintf(F, " %s (depth %d)", get_irg_dump_name(n), n->callgraph_weighted_loop_depth); */
2235 if (loop_node_started) {
2236 fprintf(F, "\" }\n");
2237 fprintf(F, "edge: {sourcename: \"");
2238 print_loopid(F, loop);
2239 fprintf(F, "\" targetname: \"l%ld-%lu-nodes\" label:\"%lu...%lu\"}\n",
2240 get_loop_loop_nr(loop),
2241 (unsigned long) first,
2242 (unsigned long) first,
2243 (unsigned long) i-1);
2244 loop_node_started = false;
2248 void dump_loop_tree(FILE *out, ir_graph *irg)
2250 ir_dump_flags_t old_flags = ir_get_dump_flags();
2252 ir_remove_dump_flags(ir_dump_flag_disable_edge_labels);
2254 dump_vcg_header(out, get_irg_dump_name(irg), "Tree", "top_to_bottom");
2256 if (get_irg_loop(irg))
2257 dump_loops_standalone(out, get_irg_loop(irg));
2259 dump_vcg_footer(out);
2261 ir_set_dump_flags(old_flags);
2264 void dump_callgraph_loop_tree(FILE *out)
2266 dump_vcg_header(out, "callgraph looptree", "Tree", "top_to_bottom");
2267 dump_loops_standalone(out, irp->outermost_cg_loop);
2268 dump_vcg_footer(out);
2271 static void collect_nodeloop(FILE *F, ir_loop *loop, pset *loopnodes)
2275 int node_number = 0;
2277 if (flags & ir_dump_flag_loops)
2278 dump_loop_node(F, loop);
2280 for (i = 0; i < get_loop_n_elements(loop); i++) {
2281 loop_element le = get_loop_element(loop, i);
2282 if (*(le.kind) == k_ir_loop) {
2283 if (flags & ir_dump_flag_loops)
2284 dump_loop_son_edge(F, loop, son_number++);
2286 collect_nodeloop(F, le.son, loopnodes);
2288 if (flags & ir_dump_flag_loops)
2289 dump_loop_node_edge(F, loop, node_number++);
2290 pset_insert_ptr(loopnodes, le.node);
2295 static void collect_nodeloop_external_nodes(ir_loop *loop, pset *loopnodes,
2301 for (i = 0; i < get_loop_n_elements(loop); i++) {
2302 loop_element le = get_loop_element(loop, i);
2303 if (*(le.kind) == k_ir_loop) {
2305 collect_nodeloop_external_nodes(le.son, loopnodes, extnodes);
2307 if (is_Block(le.node)) start = 0; else start = -1;
2308 for (j = start; j < get_irn_arity(le.node); j++) {
2309 ir_node *pred = get_irn_n(le.node, j);
2310 if (!pset_find_ptr(loopnodes, pred)) {
2311 pset_insert_ptr(extnodes, pred);
2312 if (!is_Block(pred)) {
2313 pred = get_nodes_block(pred);
2314 if (!pset_find_ptr(loopnodes, pred))
2315 pset_insert_ptr(extnodes, pred);
2323 void dump_loop(FILE *F, ir_loop *l)
2325 pset *loopnodes = pset_new_ptr_default();
2326 pset *extnodes = pset_new_ptr_default();
2330 snprintf(name, sizeof(name), "loop_%ld", get_loop_loop_nr(l));
2331 dump_vcg_header(F, name, NULL, NULL);
2333 /* collect all nodes to dump */
2334 collect_nodeloop(F, l, loopnodes);
2335 collect_nodeloop_external_nodes(l, loopnodes, extnodes);
2337 /* build block lists */
2338 foreach_pset(loopnodes, ir_node*, n) {
2339 set_irn_link(n, NULL);
2341 foreach_pset(extnodes, ir_node*, n) {
2342 set_irn_link(n, NULL);
2344 foreach_pset(loopnodes, ir_node*, n) {
2346 b = get_nodes_block(n);
2347 set_irn_link(n, get_irn_link(b));
2351 foreach_pset(extnodes, ir_node*, n) {
2353 b = get_nodes_block(n);
2354 set_irn_link(n, get_irn_link(b));
2359 foreach_pset(loopnodes, ir_node*, b) {
2361 fprintf(F, "graph: { title: ");
2363 fprintf(F, " label: \"");
2364 dump_node_opcode(F, b);
2365 fprintf(F, " %ld:%u", get_irn_node_nr(b), get_irn_idx(b));
2366 fprintf(F, "\" status:clustered color:yellow\n");
2368 /* dump the blocks edges */
2369 dump_ir_data_edges(F, b);
2371 /* dump the nodes that go into the block */
2372 for (n = (ir_node*)get_irn_link(b); n; n = (ir_node*)get_irn_link(n)) {
2373 if (pset_find_ptr(extnodes, n))
2374 overrule_nodecolor = ird_color_block_inout;
2376 overrule_nodecolor = ird_color_default_node;
2377 if (!pset_find_ptr(extnodes, n)) dump_ir_data_edges(F, n);
2380 /* Close the vcg information for the block */
2382 dump_const_node_local(F, b);
2386 foreach_pset(extnodes, ir_node*, b) {
2388 fprintf(F, "graph: { title: ");
2390 fprintf(F, " label: \"");
2391 dump_node_opcode(F, b);
2392 fprintf(F, " %ld:%u", get_irn_node_nr(b), get_irn_idx(b));
2393 fprintf(F, "\" status:clustered color:lightblue\n");
2395 /* dump the nodes that go into the block */
2396 for (n = (ir_node*)get_irn_link(b); n; n = (ir_node*)get_irn_link(n)) {
2397 if (!pset_find_ptr(loopnodes, n))
2398 overrule_nodecolor = ird_color_block_inout;
2400 overrule_nodecolor = ird_color_default_node;
2401 if (pset_find_ptr(loopnodes, n)) dump_ir_data_edges(F, n);
2404 /* Close the vcg information for the block */
2406 dump_const_node_local(F, b);
2410 del_pset(loopnodes);
2416 static bool obstack_init;
2417 static struct obstack obst;
2418 static char *dump_path;
2420 void ir_set_dump_path(const char *path)
2423 dump_path = xstrdup(path);
2426 static void add_string_escaped(const char *string)
2429 for (p = string; *p != '\0'; ++p) {
2432 obstack_1grow(&obst, '@');
2433 obstack_1grow(&obst, '1');
2434 } else if (c == '@') {
2435 obstack_1grow(&obst, '@');
2436 obstack_1grow(&obst, '2');
2438 obstack_1grow(&obst, c);
2443 static void add_dump_path(void)
2445 if (!obstack_init) {
2446 obstack_init(&obst);
2447 obstack_init = true;
2450 if (dump_path != NULL) {
2451 size_t len = strlen(dump_path);
2452 obstack_grow(&obst, dump_path, len);
2453 if (len > 0 && dump_path[len-1] != '/')
2454 obstack_1grow(&obst, '/');
2458 void dump_ir_graph_ext(ir_graph_dump_func func, ir_graph *graph,
2461 const char *dump_name = get_irg_dump_name(graph);
2465 if (!ir_should_dump(dump_name))
2470 add_string_escaped(dump_name);
2471 obstack_printf(&obst, "-%02u", graph->dump_nr++);
2473 if (suffix != NULL) {
2474 if (suffix[0] != '.')
2475 obstack_1grow(&obst, '-');
2476 add_string_escaped(suffix);
2478 obstack_1grow(&obst, '\0');
2480 file_name = (char*)obstack_finish(&obst);
2481 /* xvcg expects only <LF> so we need "b"inary mode (for win32) */
2482 out = fopen(file_name, "wb");
2483 obstack_free(&obst, file_name);
2486 fprintf(stderr, "Couldn't open '%s': %s\n", file_name, strerror(errno));
2494 void dump_ir_prog_ext(ir_prog_dump_func func, const char *suffix)
2501 obstack_printf(&obst, "%02u", irp->dump_nr++);
2502 if (suffix != NULL) {
2503 if (suffix[0] != '.')
2504 obstack_1grow(&obst, '-');
2505 add_string_escaped(suffix);
2507 obstack_1grow(&obst, '\0');
2509 file_name = (char*)obstack_finish(&obst);
2510 out = fopen(file_name, "wb");
2511 obstack_free(&obst, file_name);
2514 fprintf(stderr, "Couldn't open '%s': %s\n", file_name, strerror(errno));
2521 void dump_ir_graph(ir_graph *graph, const char *suffix)
2525 snprintf(buf, sizeof(buf), "%s.vcg", suffix);
2526 dump_ir_graph_ext(dump_ir_graph_file, graph, buf);
2529 void dump_all_ir_graphs(const char *suffix)
2531 size_t i, n_irgs = get_irp_n_irgs();
2533 for (i = 0; i < n_irgs; ++i) {
2534 ir_graph *irg = get_irp_irg(i);
2535 dump_ir_graph(irg, suffix);
2539 typedef struct pass_t {
2540 ir_prog_pass_t pass;
2545 * Wrapper around dump_all_ir_graphs().
2547 static int dump_all_ir_graphs_wrapper(ir_prog *irp, void *context)
2549 pass_t *pass = (pass_t*)context;
2552 dump_all_ir_graphs(pass->suffix);
2556 ir_prog_pass_t *dump_all_ir_graph_pass(const char *name, const char *suffix)
2558 size_t len = strlen(suffix) + 1;
2559 pass_t *pass = XMALLOCF(pass_t, suffix, len);
2560 ir_prog_pass_t *res = def_prog_pass_constructor(
2561 &pass->pass, name ? name : "dump_all_graphs", dump_all_ir_graphs_wrapper);
2563 /* this pass does not change anything, so neither dump nor verify is needed. */
2564 res->dump_irprog = ir_prog_no_dump;
2565 res->verify_irprog = ir_prog_no_verify;
2567 memcpy(pass->suffix, suffix, len);