Implicit set_irg_loopinfo_inconsistent
[libfirm] / ir / ir / irdump.c
1 /*
2  * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
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.
10  *
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.
14  *
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
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief   Write vcg representation of firm to file.
23  * @author  Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Hubert Schmidt,
24  *          Matthias Braun
25  * @version $Id$
26  */
27 #include "config.h"
28
29 #include <string.h>
30 #include <stdlib.h>
31 #include <stdarg.h>
32 #include <stdbool.h>
33 #include <errno.h>
34
35 #include "list.h"
36
37 #include "irnode_t.h"
38 #include "irgraph_t.h"
39 #include "irprog_t.h"
40 #include "entity_t.h"
41 #include "irop.h"
42
43 #include "irdump_t.h"
44 #include "irpass_t.h"
45
46 #include "irgwalk.h"
47 #include "tv_t.h"
48 #include "irouts.h"
49 #include "iredges.h"
50 #include "irdom.h"
51 #include "irloop_t.h"
52 #include "callgraph.h"
53 #include "irextbb_t.h"
54 #include "irhooks.h"
55 #include "dbginfo_t.h"
56 #include "irtools.h"
57 #include "irprintf.h"
58
59 #include "irverify.h"
60
61 #include "error.h"
62 #include "array.h"
63 #include "pmap.h"
64 #include "obst.h"
65 #include "eset.h"
66 #include "pset.h"
67 #include "util.h"
68
69 /** Dump only irgs with names that start with this prefix. */
70 static ident *dump_file_filter_id = NULL;
71
72 static ir_dump_flags_t flags =
73         ir_dump_flag_blocks_as_subgraphs |
74         ir_dump_flag_keepalive_edges |
75         ir_dump_flag_ld_names |
76         ir_dump_flag_back_edges |
77         ir_dump_flag_consts_local |
78         ir_dump_flag_analysed_types |
79         ir_dump_flag_entities_in_hierarchy |
80         ir_dump_flag_number_label;
81
82 static ird_color_t overrule_nodecolor = ird_color_default_node;
83
84 /** The vcg node attribute hook. */
85 static dump_node_vcgattr_func dump_node_vcgattr_hook = NULL;
86 /** The vcg edge attribute hook. */
87 static dump_edge_vcgattr_func dump_edge_vcgattr_hook = NULL;
88 /** The vcg dump block edge hook */
89 static dump_node_edge_func dump_block_edge_hook = NULL;
90 /** The vcg dump node edge hook. */
91 static dump_node_edge_func dump_node_edge_hook = NULL;
92
93 void set_dump_node_edge_hook(dump_node_edge_func func)
94 {
95         dump_node_edge_hook = func;
96 }
97
98 dump_node_edge_func get_dump_node_edge_hook(void)
99 {
100         return dump_node_edge_hook;
101 }
102
103 void set_dump_block_edge_hook(dump_node_edge_func func)
104 {
105         dump_block_edge_hook = func;
106 }
107
108 dump_node_edge_func get_dump_block_edge_hook(void)
109 {
110         return dump_node_edge_hook;
111 }
112
113 void set_dump_node_vcgattr_hook(dump_node_vcgattr_func hook)
114 {
115         dump_node_vcgattr_hook = hook;
116 }
117
118 void set_dump_edge_vcgattr_hook(dump_edge_vcgattr_func hook)
119 {
120         dump_edge_vcgattr_hook = hook;
121 }
122
123 void ir_set_dump_flags(ir_dump_flags_t new_flags)
124 {
125         flags = new_flags;
126 }
127
128 void ir_add_dump_flags(ir_dump_flags_t new_flags)
129 {
130         flags |= new_flags;
131 }
132
133 void ir_remove_dump_flags(ir_dump_flags_t to_remove)
134 {
135         flags &= ~to_remove;
136 }
137
138 ir_dump_flags_t ir_get_dump_flags(void)
139 {
140         return flags;
141 }
142
143 /** Returns 0 if dump_out_edge_flag or dump_loop_information_flag
144  * are set, else returns dump_const_local_flag.
145  */
146 static bool get_opt_dump_const_local(void)
147 {
148         return (flags & ir_dump_flag_out_edges)
149                 || (flags & ir_dump_flag_loops)
150                 || (flags & ir_dump_flag_consts_local)
151                 || (flags & ir_dump_flag_iredges);
152 }
153
154 static char *dump_filter;
155
156 void ir_set_dump_filter(const char *new_filter)
157 {
158         xfree(dump_filter);
159         dump_filter = xstrdup(new_filter);
160 }
161
162 const char *ir_get_dump_filter(void)
163 {
164         return dump_filter;
165 }
166
167 int ir_should_dump(const char *name)
168 {
169         const char *f, *n;
170
171         if (dump_filter == NULL || dump_filter[0] == '\0')
172                 return 1;
173
174         for (n = name, f = dump_filter; *f != '\0' && *n != '\0';
175                         ++n, ++f) {
176                 if (*n != *f)
177                         return 0;
178         }
179         return 1;
180 }
181
182 /* -------------- some extended helper functions ----------------- */
183
184 const char *get_mode_name_ex(const ir_mode *mode, int *bad)
185 {
186         if (is_mode(mode))
187                 return get_mode_name(mode);
188         if (bad != NULL)
189                 *bad |= 1;
190         return "<ERROR>";
191 }
192
193 #define CUSTOM_COLOR_BASE    100
194 static const char *color_names[ird_color_count];
195 static const char *color_rgb[ird_color_count];
196 static struct obstack color_obst;
197
198 /** define a custom color. */
199 static void custom_color(int num, const char *rgb_def)
200 {
201         assert(num < ird_color_count);
202         obstack_printf(&color_obst, "%d", CUSTOM_COLOR_BASE + num);
203         obstack_1grow(&color_obst, '\0');
204
205         color_rgb[num]   = rgb_def;
206         color_names[num] = (const char*)obstack_finish(&color_obst);
207 }
208
209 /** Define a named color. */
210 static void named_color(int num, const char *name)
211 {
212         assert(num < ird_color_count);
213         color_rgb[num]   = NULL;
214         color_names[num] = name;
215 }
216
217 /** Initializes the used colors. */
218 static void init_colors(void)
219 {
220         static int initialized = 0;
221         if (initialized)
222                 return;
223
224         obstack_init(&color_obst);
225
226         custom_color(ird_color_prog_background,       "204 204 204");
227         custom_color(ird_color_block_background,      "255 255 0");
228         custom_color(ird_color_dead_block_background, "190 150 150");
229         named_color(ird_color_block_inout,            "lightblue");
230         named_color(ird_color_default_node,           "white");
231         custom_color(ird_color_memory,                "153 153 255");
232         custom_color(ird_color_controlflow,           "255 153 153");
233         custom_color(ird_color_const,                 "204 255 255");
234         custom_color(ird_color_proj,                  "255 255 153");
235         custom_color(ird_color_uses_memory,           "153 153 255");
236         custom_color(ird_color_phi,                   "105 255 105");
237         custom_color(ird_color_anchor,                "100 100 255");
238         named_color(ird_color_error,                  "red");
239         custom_color(ird_color_entity,                "204 204 255");
240
241         initialized = 1;
242 }
243
244 /**
245  * Prints the VCG color to a file.
246  */
247 static void print_vcg_color(FILE *out, ird_color_t color)
248 {
249         assert(color < ird_color_count);
250         fprintf(out, "color:%s", color_names[color]);
251 }
252
253 /**
254  * Prints the edge kind of a given IR node.
255  *
256  * Projs should be dumped near their predecessor, so they get "nearedge".
257  */
258 static void print_node_edge_kind(FILE *out, ir_node *node)
259 {
260         if (is_Proj(node)) {
261                 fprintf(out, "nearedge: ");
262         } else {
263                 fprintf(out, "edge: ");
264         }
265 }
266
267 /**
268  * Prints the edge from a type S to a type T with additional info fmt, ...
269  * to the file F.
270  */
271 static void print_type_type_edge(FILE *F, const ir_type *S, const ir_type *T, const char *fmt, ...)
272 {
273         va_list ap;
274
275         va_start(ap, fmt);
276         fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(S);
277         fprintf(F, " targetname: "); PRINT_TYPEID(T);
278         ir_vfprintf(F, fmt, ap);
279         fprintf(F,"}\n");
280         va_end(ap);
281 }
282
283 /**
284  * Prints the edge from a type tp to an entity ent with additional info fmt, ...
285  * to the file F.
286  */
287 static void print_type_ent_edge(FILE *F, const ir_type *tp, const ir_entity *ent, const char *fmt, ...)
288 {
289         va_list ap;
290
291         va_start(ap, fmt);
292         fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(tp);
293         fprintf(F, " targetname: \""); PRINT_ENTID(ent); fprintf(F, "\"");
294         ir_vfprintf(F, fmt, ap);
295         fprintf(F, "}\n");
296         va_end(ap);
297 }
298
299 /**
300  * Prints the edge from an entity ent1 to an entity ent2 with additional info fmt, ...
301  * to the file F.
302  */
303 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, ...)
304 {
305         va_list ap;
306
307         va_start(ap, fmt);
308         if (backedge)
309                 fprintf(F, "backedge: { sourcename: \"");
310         else
311                 fprintf(F, "edge: { sourcename: \"");
312         PRINT_ENTID(ent1);
313         fprintf(F, "\" targetname: \""); PRINT_ENTID(ent2);  fprintf(F, "\"");
314         ir_vfprintf(F, fmt, ap);
315         fprintf(F, " ");
316         if (color != ird_color_none)
317                 print_vcg_color(F, color);
318         fprintf(F, "}\n");
319         va_end(ap);
320 }
321
322 /**
323  * Prints the edge from an entity ent to a type tp with additional info fmt, ...
324  * to the file F.
325  */
326 static void print_ent_type_edge(FILE *F, const ir_entity *ent, const ir_type *tp, const char *fmt, ...)
327 {
328         va_list ap;
329
330         va_start(ap, fmt);
331         fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(ent);
332         fprintf(F, "\" targetname: "); PRINT_TYPEID(tp);
333         ir_vfprintf(F, fmt, ap);
334         fprintf(F,"}\n");
335         va_end(ap);
336 }
337
338 /**
339  * Prints the edge from a node irn to a type tp with additional info fmt, ...
340  * to the file F.
341  */
342 static void print_node_type_edge(FILE *F, const ir_node *irn, ir_type *tp, const char *fmt, ...)
343 {
344         va_list ap;
345
346         va_start(ap, fmt);
347         fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(irn);
348         fprintf(F, "\" targetname: "); PRINT_TYPEID(tp);
349         ir_vfprintf(F, fmt, ap);
350         fprintf(F,"}\n");
351         va_end(ap);
352 }
353
354 /**
355  * Prints the edge from a node irn to an entity ent with additional info fmt, ...
356  * to the file F.
357  */
358 static void print_node_ent_edge(FILE *F, const ir_node *irn, const ir_entity *ent, const char *fmt, ...)
359 {
360         va_list ap;
361
362         va_start(ap, fmt);
363         fprintf(F, "edge: { sourcename: \""); PRINT_NODEID(irn);
364         fprintf(F, "\" targetname: \""); PRINT_ENTID(ent);
365         fprintf(F, "\"");
366         ir_vfprintf(F, fmt, ap);
367         fprintf(F,"}\n");
368         va_end(ap);
369 }
370
371 /**
372  * Prints the edge from an entity ent to a node irn with additional info fmt, ...
373  * to the file F.
374  */
375 static void print_ent_node_edge(FILE *F, const ir_entity *ent, const ir_node *irn, const char *fmt, ...)
376 {
377         va_list ap;
378
379         va_start(ap, fmt);
380         fprintf(F, "edge: { sourcename: \""); PRINT_ENTID(ent);
381         fprintf(F, "\" targetname: \""); PRINT_NODEID(irn); fprintf(F, "\"");
382         ir_vfprintf(F, fmt, ap);
383         fprintf(F,"}\n");
384         va_end(ap);
385 }
386
387 /**
388  * Prints the edge from a type tp to an enumeration item item with additional info fmt, ...
389  * to the file F.
390  */
391 static void print_enum_item_edge(FILE *F, const ir_type *tp, size_t item, const char *fmt, ...)
392 {
393         va_list ap;
394
395         va_start(ap, fmt);
396         fprintf(F, "edge: { sourcename: "); PRINT_TYPEID(tp);
397         fprintf(F, " targetname: \""); PRINT_ITEMID(tp, item); fprintf(F, "\" ");
398         ir_vfprintf(F, fmt, ap);
399         fprintf(F,"}\n");
400         va_end(ap);
401 }
402
403 /*-----------------------------------------------------------------*/
404 /* global and ahead declarations                                   */
405 /*-----------------------------------------------------------------*/
406
407 static void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg);
408
409 /*-----------------------------------------------------------------*/
410 /* Helper functions.                                                */
411 /*-----------------------------------------------------------------*/
412
413 /**
414  * This map is used as a private link attr to be able to call dumper
415  * anywhere without destroying link fields.
416  */
417 static pmap *irdump_link_map = NULL;
418
419 /** NOT A STANDARD LIBFIRM INIT METHOD
420  *
421  * We do not want to integrate dumping into libfirm, i.e., if the dumpers
422  * are off, we want to have as few interferences as possible.  Therefore the
423  * initialization is performed lazily and not called from within init_firm.
424  *
425  * Creates the link attribute map. */
426 static void init_irdump(void)
427 {
428         /* We need a new, empty map. */
429         if (irdump_link_map) pmap_destroy(irdump_link_map);
430         irdump_link_map = pmap_create();
431         if (!dump_file_filter_id)
432                 dump_file_filter_id = new_id_from_str("");
433 }
434
435 /**
436  * Returns the private link field.
437  */
438 static void *ird_get_irn_link(const ir_node *n)
439 {
440         void *res = NULL;
441         if (irdump_link_map == NULL)
442                 return NULL;
443
444         if (pmap_contains(irdump_link_map, n))
445                 res = pmap_get(irdump_link_map, n);
446         return res;
447 }
448
449 /**
450  * Sets the private link field.
451  */
452 static void ird_set_irn_link(const ir_node *n, void *x)
453 {
454         if (irdump_link_map == NULL)
455                 init_irdump();
456         pmap_insert(irdump_link_map, n, x);
457 }
458
459 /**
460  * Gets the private link field of an irg.
461  */
462 static void *ird_get_irg_link(const ir_graph *irg)
463 {
464         void *res = NULL;
465         if (irdump_link_map == NULL)
466                 return NULL;
467
468         if (pmap_contains(irdump_link_map, irg))
469                 res = pmap_get(irdump_link_map, irg);
470         return res;
471 }
472
473 /**
474  * Sets the private link field of an irg.
475  */
476 static void ird_set_irg_link(const ir_graph *irg, void *x)
477 {
478         if (irdump_link_map == NULL)
479                 init_irdump();
480         pmap_insert(irdump_link_map, irg, x);
481 }
482
483 /**
484  * Walker, clears the private link field.
485  */
486 static void clear_link(ir_node *node, void *env)
487 {
488         (void) env;
489         ird_set_irn_link(node, NULL);
490 }
491
492 /**
493  * If the entity has a ld_name, returns it if the dump_ld_name is set,
494  * else returns the name of the entity.
495  */
496 static const char *_get_ent_dump_name(const ir_entity *ent, bool dump_ld_name)
497 {
498         if (ent == NULL)
499                 return "<NULL entity>";
500         if (dump_ld_name) {
501                 /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
502                 if (ent->ld_name != NULL)
503                         return get_id_str(ent->ld_name);
504         }
505         return get_id_str(ent->name);
506 }
507
508 const char *get_ent_dump_name(const ir_entity *ent)
509 {
510         return _get_ent_dump_name(ent, flags & ir_dump_flag_ld_names);
511 }
512
513 const char *get_irg_dump_name(const ir_graph *irg)
514 {
515         /* Don't use get_entity_ld_ident (ent) as it computes the mangled name! */
516         return _get_ent_dump_name(get_irg_entity(irg), true);
517 }
518
519 /**
520  * Returns non-zero if a node is in floating state.
521  */
522 static int node_floats(const ir_node *n)
523 {
524         return ((get_irn_pinned(n) == op_pin_state_floats) &&
525                 (get_irg_pinned(current_ir_graph) == op_pin_state_floats));
526 }
527
528 /**
529  *  Walker that visits the anchors
530  */
531 static void ird_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env)
532 {
533         if ((flags & ir_dump_flag_all_anchors)
534                         || ((flags & ir_dump_flag_iredges) && edges_activated(irg))) {
535                 irg_walk_anchors(irg, pre, post, env);
536         } else {
537                 irg_walk_graph(irg, pre, post, env);
538         }
539 }
540
541 /**
542  * Walker, allocates an array for all blocks and puts their non-floating
543  * nodes into this array.
544  */
545 static void collect_node(ir_node *node, void *env)
546 {
547         (void) env;
548         if (is_Block(node)
549             || node_floats(node)
550             || (get_op_flags(get_irn_op(node)) & irop_flag_dump_noblock)) {
551                 ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
552                 if (!arr) arr = NEW_ARR_F(ir_node *, 0);
553                 ARR_APP1(ir_node *, arr, node);
554                 ird_set_irg_link(get_irn_irg(node), arr);    /* arr is an l-value, APP_ARR might change it! */
555         } else {
556                 ir_node * block = get_nodes_block(node);
557
558                 if (is_Bad(block)) {
559                         /* this node is in a Bad block, so we must place it into the graph's list */
560                         ir_node ** arr = (ir_node **) ird_get_irg_link(get_irn_irg(node));
561                         if (!arr) arr = NEW_ARR_F(ir_node *, 0);
562                         ARR_APP1(ir_node *, arr, node);
563                         ird_set_irg_link(get_irn_irg(node), arr);    /* arr is an l-value, APP_ARR might change it! */
564                 } else {
565                         ird_set_irn_link(node, ird_get_irn_link(block));
566                         ird_set_irn_link(block, node);
567                 }
568         }
569 }
570
571 /** Construct lists to walk ir block-wise.
572  *
573  * Collects all blocks, nodes not op_pin_state_pinned,
574  * Bad, NoMem and Unknown into a flexible array in link field of
575  * irg they belong to.  Sets the irg link field to NULL in all
576  * graphs not visited.
577  * Free the list with DEL_ARR_F().
578  */
579 static ir_node **construct_block_lists(ir_graph *irg)
580 {
581         size_t   i;
582         int      walk_flag = ir_resources_reserved(irg) & IR_RESOURCE_IRN_VISITED;
583         ir_graph *rem      = current_ir_graph;
584
585         current_ir_graph = irg;
586
587         if (walk_flag) {
588                 ir_free_resources(irg, IR_RESOURCE_IRN_VISITED);
589         }
590
591         for (i = get_irp_n_irgs(); i > 0;)
592                 ird_set_irg_link(get_irp_irg(--i), NULL);
593
594         ird_walk_graph(current_ir_graph, clear_link, collect_node, current_ir_graph);
595
596         if (walk_flag) {
597                 ir_reserve_resources(irg, IR_RESOURCE_IRN_VISITED);
598         }
599
600         current_ir_graph = rem;
601         return (ir_node**)ird_get_irg_link(irg);
602 }
603
604 typedef struct list_tuple {
605         ir_node **blk_list;
606         ir_extblk **extbb_list;
607 } list_tuple;
608
609 /** Construct lists to walk IR extended block-wise.
610  * Free the lists in the tuple with DEL_ARR_F(). Sets the irg link field to
611  * NULL in all graphs not visited.
612  */
613 static list_tuple *construct_extblock_lists(ir_graph *irg)
614 {
615         ir_node **blk_list = construct_block_lists(irg);
616         size_t i, n;
617         ir_graph *rem = current_ir_graph;
618         list_tuple *lists = XMALLOC(list_tuple);
619
620         current_ir_graph = irg;
621
622         lists->blk_list   = NEW_ARR_F(ir_node *, 0);
623         lists->extbb_list = NEW_ARR_F(ir_extblk *, 0);
624
625         inc_irg_block_visited(irg);
626         for (i = 0, n = ARR_LEN(blk_list); i < n; ++i) {
627                 ir_extblk *ext;
628
629                 if (is_Block(blk_list[i])) {
630                         ext = get_Block_extbb(blk_list[i]);
631
632                         if (extbb_not_visited(ext)) {
633                                 ARR_APP1(ir_extblk *, lists->extbb_list, ext);
634                                 mark_extbb_visited(ext);
635                         }
636                 } else
637                         ARR_APP1(ir_node *, lists->blk_list, blk_list[i]);
638         }
639         DEL_ARR_F(blk_list);
640
641         current_ir_graph = rem;
642         ird_set_irg_link(irg, lists);
643         return lists;
644 }
645
646 void dump_node_opcode(FILE *F, ir_node *n)
647 {
648         const ir_op_ops *ops = get_op_ops(get_irn_op(n));
649
650         /* call the dump_node operation if available */
651         if (ops->dump_node) {
652                 ops->dump_node(F, n, dump_node_opcode_txt);
653                 return;
654         }
655
656         /* implementation for default nodes */
657         switch (get_irn_opcode(n)) {
658         case iro_SymConst:
659                 switch (get_SymConst_kind(n)) {
660                 case symconst_addr_ent:
661                         fprintf(F, "SymC &%s", get_entity_name(get_SymConst_entity(n)));
662                         break;
663                 case symconst_ofs_ent:
664                         fprintf(F, "SymC %s offset", get_entity_name(get_SymConst_entity(n)));
665                         break;
666                 case symconst_type_tag:
667                         ir_fprintf(F, "SymC %+F tag", get_SymConst_type(n));
668                         break;
669                 case symconst_type_size:
670                         ir_fprintf(F, "SymC %+F size", get_SymConst_type(n));
671                         break;
672                 case symconst_type_align:
673                         ir_fprintf(F, "SymC %+F align", get_SymConst_type(n));
674                         break;
675                 case symconst_enum_const:
676                         fprintf(F, "SymC %s enum", get_enumeration_const_name(get_SymConst_enum(n)));
677                         break;
678                 }
679                 break;
680
681         case iro_Proj: {
682                 ir_node *pred = get_Proj_pred(n);
683
684                 if (get_irn_opcode(pred) == iro_Cond
685                         && get_Proj_proj(n) == get_Cond_default_proj(pred)
686                         && get_irn_mode(get_Cond_selector(pred)) != mode_b)
687                         fprintf(F, "defProj");
688                 else
689                         goto default_case;
690         } break;
691
692         case iro_Load:
693                 if (get_Load_unaligned(n) == align_non_aligned)
694                         fprintf(F, "ua");
695                 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Load_mode(n), NULL));
696                 break;
697         case iro_Store:
698                 if (get_Store_unaligned(n) == align_non_aligned)
699                         fprintf(F, "ua");
700                 fprintf(F, "%s", get_irn_opname(n));
701                 break;
702         case iro_Block:
703                 if (n == get_irg_start_block(get_irn_irg(n)))
704                         fputs("Start ", F);
705                 if (n == get_irg_end_block(get_irn_irg(n)))
706                         fputs("End ", F);
707                 fprintf(F, "%s%s", get_irn_opname(n),
708                         (flags & ir_dump_flag_show_marks) ? (get_Block_mark(n) ? "*" : "") : "");
709                 break;
710         case iro_Conv:
711                 if (get_Conv_strict(n))
712                         fprintf(F, "strict");
713                 fprintf(F, "%s", get_irn_opname(n));
714                 break;
715         case iro_Div:
716                 fprintf(F, "%s", get_irn_opname(n));
717                 if (get_Div_no_remainder(n))
718                         fprintf(F, "RL");
719                 fprintf(F, "[%s]", get_mode_name_ex(get_Div_resmode(n), NULL));
720                 break;
721         case iro_Mod:
722                 fprintf(F, "%s[%s]", get_irn_opname(n), get_mode_name_ex(get_Mod_resmode(n), NULL));
723                 break;
724         case iro_Builtin:
725                 fprintf(F, "%s[%s]", get_irn_opname(n), get_builtin_kind_name(get_Builtin_kind(n)));
726                 break;
727
728         default:
729 default_case:
730                 fprintf(F, "%s", get_irn_opname(n));
731         }
732 }
733
734 /**
735  * Dump the mode of a node n to a file F.
736  * Ignore modes that are "always known".
737  */
738 static void dump_node_mode(FILE *F, ir_node *n)
739 {
740         const ir_op_ops *ops = get_op_ops(get_irn_op(n));
741         unsigned         iro;
742         ir_mode         *mode;
743
744         /* call the dump_node operation if available */
745         if (ops->dump_node) {
746                 ops->dump_node(F, n, dump_node_mode_txt);
747                 return;
748         }
749
750         /* default implementation */
751         iro = get_irn_opcode(n);
752         switch (iro) {
753         case iro_SymConst:
754         case iro_Sel:
755         case iro_End:
756         case iro_Return:
757         case iro_Free:
758         case iro_Sync:
759         case iro_Jmp:
760         case iro_NoMem:
761                 break;
762         default:
763                 mode = get_irn_mode(n);
764
765                 if (mode != NULL && mode != mode_BB && mode != mode_ANY && mode != mode_BAD &&
766                         (mode != mode_T || iro == iro_Proj))
767                         fprintf(F, "%s", get_mode_name_ex(mode, NULL));
768         }
769 }
770
771 /**
772  * Dump the type of a node n to a file F if it's known.
773  */
774 static int dump_node_typeinfo(FILE *F, ir_node *n)
775 {
776         int bad = 0;
777
778         if (ir_get_dump_flags() & ir_dump_flag_analysed_types) {
779                 if (get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_consistent  ||
780                         get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_inconsistent) {
781                         ir_type *tp = get_irn_typeinfo_type(n);
782                         if (tp != firm_none_type) {
783                                 ir_fprintf(F, "[%+F]", tp);
784                         } else {
785                                 fprintf(F, "[] ");
786                         }
787                 }
788         }
789         return bad;
790 }
791
792 typedef struct pns_lookup {
793         long       nr;      /**< the proj number */
794         const char *name;   /**< the name of the Proj */
795 } pns_lookup_t;
796
797 typedef struct proj_lookup {
798         unsigned           code;      /**< the opcode of the Proj predecessor */
799         unsigned           num_data;  /**< number of data entries */
800         const pns_lookup_t *data;     /**< the data */
801 } proj_lookup_t;
802
803 /** the lookup table for Proj(Start) names */
804 static const pns_lookup_t start_lut[] = {
805 #define X(a)    { pn_Start_##a, #a }
806         X(X_initial_exec),
807         X(M),
808         X(P_frame_base),
809         X(T_args),
810 #undef X
811 };
812
813 /** the lookup table for Proj(Cond) names */
814 static const pns_lookup_t cond_lut[] = {
815 #define X(a)    { pn_Cond_##a, #a }
816         X(false),
817         X(true)
818 #undef X
819 };
820
821 /** the lookup table for Proj(Call) names */
822 static const pns_lookup_t call_lut[] = {
823 #define X(a)    { pn_Call_##a, #a }
824         X(M),
825         X(X_regular),
826         X(X_except),
827         X(T_result),
828 #undef X
829 };
830
831 /** the lookup table for Proj(Div) names */
832 static const pns_lookup_t div_lut[] = {
833 #define X(a)    { pn_Div_##a, #a }
834         X(M),
835         X(X_regular),
836         X(X_except),
837         X(res)
838 #undef X
839 };
840
841 /** the lookup table for Proj(Mod) names */
842 static const pns_lookup_t mod_lut[] = {
843 #define X(a)    { pn_Mod_##a, #a }
844         X(M),
845         X(X_regular),
846         X(X_except),
847         X(res)
848 #undef X
849 };
850
851 /** the lookup table for Proj(Load) names */
852 static const pns_lookup_t load_lut[] = {
853 #define X(a)    { pn_Load_##a, #a }
854         X(M),
855         X(X_regular),
856         X(X_except),
857         X(res)
858 #undef X
859 };
860
861 /** the lookup table for Proj(Store) names */
862 static const pns_lookup_t store_lut[] = {
863 #define X(a)    { pn_Store_##a, #a }
864         X(M),
865         X(X_regular),
866         X(X_except)
867 #undef X
868 };
869
870 /** the lookup table for Proj(Alloc) names */
871 static const pns_lookup_t alloc_lut[] = {
872 #define X(a)    { pn_Alloc_##a, #a }
873         X(M),
874         X(X_regular),
875         X(X_except),
876         X(res)
877 #undef X
878 };
879
880 /** the lookup table for Proj(CopyB) names */
881 static const pns_lookup_t copyb_lut[] = {
882 #define X(a)    { pn_CopyB_##a, #a }
883         X(M),
884         X(X_regular),
885         X(X_except),
886 #undef X
887 };
888
889 /** the lookup table for Proj(InstOf) names */
890 static const pns_lookup_t instof_lut[] = {
891 #define X(a)    { pn_InstOf_##a, #a }
892         X(M),
893         X(X_regular),
894         X(X_except),
895         X(res),
896 #undef X
897 };
898
899 /** the lookup table for Proj(Raise) names */
900 static const pns_lookup_t raise_lut[] = {
901 #define X(a)    { pn_Raise_##a, #a }
902         X(M),
903         X(X),
904 #undef X
905 };
906
907 /** the lookup table for Proj(Bound) names */
908 static const pns_lookup_t bound_lut[] = {
909 #define X(a)    { pn_Bound_##a, #a }
910         X(M),
911         X(X_regular),
912         X(X_except),
913         X(res),
914 #undef X
915 };
916
917 /** the Proj lookup table */
918 static const proj_lookup_t proj_lut[] = {
919 #define E(a)  ARRAY_SIZE(a), a
920         { iro_Start,   E(start_lut) },
921         { iro_Cond,    E(cond_lut) },
922         { iro_Call,    E(call_lut) },
923         { iro_Div,     E(div_lut) },
924         { iro_Mod,     E(mod_lut) },
925         { iro_Load,    E(load_lut) },
926         { iro_Store,   E(store_lut) },
927         { iro_Alloc,   E(alloc_lut) },
928         { iro_CopyB,   E(copyb_lut) },
929         { iro_InstOf,  E(instof_lut) },
930         { iro_Raise,   E(raise_lut) },
931         { iro_Bound,   E(bound_lut) }
932 #undef E
933 };
934
935 /**
936  * Dump additional node attributes of some nodes to a file F.
937  */
938 static void dump_node_nodeattr(FILE *F, ir_node *n)
939 {
940         ir_node *pred;
941         unsigned code;
942         long proj_nr;
943         const ir_op_ops *ops = get_op_ops(get_irn_op(n));
944
945         /* call the dump_node operation if available */
946         if (ops->dump_node) {
947                 ops->dump_node(F, n, dump_node_nodeattr_txt);
948                 return;
949         }
950
951         switch (get_irn_opcode(n)) {
952         case iro_Const:
953                 ir_fprintf(F, "%T ", get_Const_tarval(n));
954                 break;
955
956         case iro_Proj:
957                 pred    = get_Proj_pred(n);
958                 proj_nr = get_Proj_proj(n);
959                 code    = get_irn_opcode(pred);
960
961                 if (code == iro_Proj && get_irn_opcode(get_Proj_pred(pred)) == iro_Start)
962                         fprintf(F, "Arg %ld ", proj_nr);
963                 else if (code == iro_Cond && get_irn_mode(get_Cond_selector(pred)) != mode_b)
964                         fprintf(F, "%ld ", proj_nr);
965                 else {
966                         unsigned i, j, f = 0;
967
968                         for (i = 0; i < ARRAY_SIZE(proj_lut); ++i) {
969                                 if (code == proj_lut[i].code) {
970                                         for (j = 0; j < proj_lut[i].num_data; ++j) {
971                                                 if (proj_nr == proj_lut[i].data[j].nr) {
972                                                         fprintf(F, "%s ", proj_lut[i].data[j].name);
973                                                         f = 1;
974                                                         break;
975                                                 }
976                                         }
977                                         break;
978                                 }
979                         }
980                         if (! f)
981                                 fprintf(F, "%ld ", proj_nr);
982                         if (code == iro_Cond && get_Cond_jmp_pred(pred) != COND_JMP_PRED_NONE) {
983                                 if (proj_nr == pn_Cond_false && get_Cond_jmp_pred(pred) == COND_JMP_PRED_FALSE)
984                                         fprintf(F, "PRED ");
985                                 if (proj_nr == pn_Cond_true && get_Cond_jmp_pred(pred) == COND_JMP_PRED_TRUE)
986                                         fprintf(F, "PRED ");
987                         }
988                 }
989                 break;
990         case iro_Sel:
991                 fprintf(F, "%s ", get_ent_dump_name(get_Sel_entity(n)));
992                 break;
993         case iro_Cast:
994                 ir_fprintf(F, "(%+F)", get_Cast_type(n));
995                 break;
996         case iro_Cmp:
997                 fprintf(F, "%s ", get_relation_string(get_Cmp_relation(n)));
998                 break;
999         case iro_Confirm:
1000                 fprintf(F, "%s ", get_relation_string(get_Confirm_relation(n)));
1001                 break;
1002         case iro_CopyB:
1003                 ir_fprintf(F, "(%+F)", get_CopyB_type(n));
1004                 break;
1005
1006         default:
1007                 ;
1008         } /* end switch */
1009 }
1010
1011 #include <math.h>
1012 #include "execution_frequency.h"
1013
1014 static void dump_node_ana_vals(FILE *F, ir_node *n)
1015 {
1016         (void) F;
1017         (void) n;
1018         return;
1019 }
1020
1021 void dump_node_label(FILE *F, ir_node *n)
1022 {
1023         dump_node_opcode(F, n);
1024         fputs(" ", F);
1025         dump_node_mode(F, n);
1026         fprintf(F, " ");
1027         dump_node_typeinfo(F, n);
1028         dump_node_nodeattr(F, n);
1029         if (flags & ir_dump_flag_number_label) {
1030                 fprintf(F, "%ld", get_irn_node_nr(n));
1031         }
1032         if (flags & ir_dump_flag_idx_label) {
1033                 fprintf(F, ":%u", get_irn_idx(n));
1034         }
1035 }
1036
1037 void dump_vrp_info(FILE *F, ir_node *n)
1038 {
1039         vrp_attr *vrp = vrp_get_info(n);
1040         if (n == NULL) {
1041                 return;
1042         }
1043
1044         fprintf(F, "range_type: %d\n", (int) vrp->range_type);
1045         if (vrp->range_type == VRP_RANGE || vrp->range_type ==
1046                         VRP_ANTIRANGE) {
1047                 ir_fprintf(F, "range_bottom: %F\n",vrp->range_bottom);
1048                 ir_fprintf(F, "range_top: %F\n", vrp->range_top);
1049         }
1050         ir_fprintf(F, "bits_set: %T\n", vrp->bits_set);
1051         ir_fprintf(F, "bits_not_set: %T\n", vrp->bits_not_set);
1052 }
1053
1054 /**
1055  * Dumps the attributes of a node n into the file F.
1056  * Currently this is only the color of a node.
1057  */
1058 static void dump_node_vcgattr(FILE *F, ir_node *node, ir_node *local, int bad)
1059 {
1060         ir_mode *mode;
1061         ir_node *n;
1062
1063         if (bad) {
1064                 print_vcg_color(F, ird_color_error);
1065                 return;
1066         }
1067
1068         if (dump_node_vcgattr_hook != NULL) {
1069                 dump_node_vcgattr_hook(F, node, local);
1070                 return;
1071         }
1072
1073         n = local ? local : node;
1074
1075         if (overrule_nodecolor != ird_color_default_node) {
1076                 print_vcg_color(F, overrule_nodecolor);
1077                 return;
1078         }
1079
1080         mode = get_irn_mode(n);
1081         if (mode == mode_M) {
1082                 print_vcg_color(F, ird_color_memory);
1083                 return;
1084         }
1085         if (mode == mode_X) {
1086                 print_vcg_color(F, ird_color_controlflow);
1087                 return;
1088         }
1089
1090         switch (get_irn_opcode(n)) {
1091         case iro_Start:
1092         case iro_End:
1093                 print_vcg_color(F, ird_color_anchor);
1094                 break;
1095         case iro_Bad:
1096                 print_vcg_color(F, ird_color_error);
1097                 break;
1098         case iro_Block:
1099                 print_vcg_color(F, ird_color_block_background);
1100                 break;
1101         case iro_Phi:
1102                 print_vcg_color(F, ird_color_phi);
1103                 break;
1104         case iro_Pin:
1105                 print_vcg_color(F, ird_color_memory);
1106                 break;
1107         case iro_SymConst:
1108         case iro_Const:
1109                 print_vcg_color(F, ird_color_const);
1110                 break;
1111         case iro_Proj:
1112                 print_vcg_color(F, ird_color_proj);
1113                 break;
1114         default: {
1115                 ir_op *op = get_irn_op(node);
1116
1117                 if (is_op_constlike(op)) {
1118                         print_vcg_color(F, ird_color_const);
1119                 } else if (is_op_uses_memory(op)) {
1120                         print_vcg_color(F, ird_color_uses_memory);
1121                 } else if (is_op_cfopcode(op) || is_op_forking(op)) {
1122                         print_vcg_color(F, ird_color_controlflow);
1123                 }
1124         }
1125         }
1126 }
1127
1128 void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data)
1129 {
1130         hook_entry_t *info = XMALLOC(hook_entry_t);
1131
1132         info->hook._hook_node_info = cb;
1133         info->context              = data;
1134         register_hook(hook_node_info, info);
1135
1136         return info;
1137 }
1138
1139 void dump_remove_node_info_callback(void *handle)
1140 {
1141         hook_entry_t *info = (hook_entry_t*)handle;
1142         unregister_hook(hook_node_info, info);
1143         xfree(info);
1144 }
1145
1146 /**
1147  * Dump the node information of a node n to a file F.
1148  */
1149 static void dump_node_info(FILE *F, ir_node *n)
1150 {
1151         const ir_op_ops *ops = get_op_ops(get_irn_op(n));
1152
1153         fprintf(F, " info1: \"");
1154         dump_irnode_to_file(F, n);
1155         /* call the dump_node operation if available */
1156         if (ops->dump_node)
1157                 ops->dump_node(F, n, dump_node_info_txt);
1158
1159         /* allow additional info to be added */
1160         hook_node_info(F, n);
1161         fprintf(F, "\"\n");
1162 }
1163
1164 static int is_constlike_node(const ir_node *node)
1165 {
1166         const ir_op *op = get_irn_op(node);
1167         return is_op_constlike(op);
1168 }
1169
1170
1171 /** outputs the predecessors of n, that are constants, local.  I.e.,
1172    generates a copy of the constant predecessors for each node called with. */
1173 static void dump_const_node_local(FILE *F, ir_node *n)
1174 {
1175         int i;
1176         if (!get_opt_dump_const_local()) return;
1177
1178         /* Use visited flag to avoid outputting nodes twice.
1179         initialize it first. */
1180         for (i = 0; i < get_irn_arity(n); i++) {
1181                 ir_node *con = get_irn_n(n, i);
1182                 if (is_constlike_node(con)) {
1183                         set_irn_visited(con, get_irg_visited(current_ir_graph) - 1);
1184                 }
1185         }
1186
1187         for (i = 0; i < get_irn_arity(n); i++) {
1188                 ir_node *con = get_irn_n(n, i);
1189                 if (is_constlike_node(con) && !irn_visited_else_mark(con)) {
1190                         /* Generate a new name for the node by appending the names of
1191                         n and const. */
1192                         fprintf(F, "node: {title: "); PRINT_CONSTID(n, con);
1193                         fprintf(F, " label: \"");
1194                         dump_node_label(F, con);
1195                         fprintf(F, "\" ");
1196                         dump_node_info(F, con);
1197                         dump_node_vcgattr(F, n, con, 0);
1198                         fprintf(F, "}\n");
1199                 }
1200         }
1201 }
1202
1203 /** If the block of an edge is a const_like node, dump it local with an edge */
1204 static void dump_const_block_local(FILE *F, ir_node *n)
1205 {
1206         ir_node *blk;
1207
1208         if (!get_opt_dump_const_local()) return;
1209
1210         blk = get_nodes_block(n);
1211         if (is_constlike_node(blk)) {
1212                 /* Generate a new name for the node by appending the names of
1213                 n and blk. */
1214                 fprintf(F, "node: {title: \""); PRINT_CONSTBLKID(n, blk);
1215                 fprintf(F, "\" label: \"");
1216                 dump_node_label(F, blk);
1217                 fprintf(F, "\" ");
1218                 dump_node_info(F, blk);
1219                 dump_node_vcgattr(F, n, blk, 0);
1220                 fprintf(F, "}\n");
1221
1222                 fprintf(F, "edge: { sourcename: \"");
1223                 PRINT_NODEID(n);
1224                 fprintf(F, "\" targetname: \""); PRINT_CONSTBLKID(n,blk);
1225
1226                 if (dump_edge_vcgattr_hook) {
1227                         fprintf(F, "\" ");
1228                         if (dump_edge_vcgattr_hook(F, n, -1)) {
1229                                 fprintf(F, "}\n");
1230                                 return;
1231                         } else {
1232                                 fprintf(F, " " BLOCK_EDGE_ATTR "}\n");
1233                                 return;
1234                         }
1235                 }
1236
1237                 fprintf(F, "\" "   BLOCK_EDGE_ATTR "}\n");
1238         }
1239 }
1240
1241 /**
1242  * prints the error message of a node to a file F as info2.
1243  */
1244 static void print_node_error(FILE *F, const char *err_msg)
1245 {
1246         if (! err_msg)
1247                 return;
1248
1249         fprintf(F, " info2: \"%s\"", err_msg);
1250 }
1251
1252 /**
1253  * prints debug messages of a node to file F as info3.
1254  */
1255 static void print_dbg_info(FILE *F, dbg_info *dbg)
1256 {
1257         char buf[1024];
1258
1259         ir_dbg_info_snprint(buf, sizeof(buf), dbg);
1260         if (buf[0] != 0) {
1261                 fprintf(F, " info3: \"%s\"\n", buf);
1262         }
1263 }
1264
1265 static void print_type_dbg_info(FILE *F, type_dbg_info *dbg)
1266 {
1267         (void) F;
1268         (void) dbg;
1269         /* TODO */
1270 }
1271
1272 /**
1273  * Dump a node
1274  */
1275 static void dump_node(FILE *F, ir_node *n)
1276 {
1277         int bad = 0;
1278         const char *p;
1279
1280         if (get_opt_dump_const_local() && is_constlike_node(n))
1281                 return;
1282
1283         /* dump this node */
1284         fputs("node: {title: \"", F);
1285         PRINT_NODEID(n);
1286         fputs("\"", F);
1287
1288         fputs(" label: \"", F);
1289         bad = ! irn_verify_irg_dump(n, current_ir_graph, &p);
1290         dump_node_label(F, n);
1291         dump_node_ana_vals(F, n);
1292         //dump_node_ana_info(F, n);
1293         fputs("\" ", F);
1294
1295         if (get_op_flags(get_irn_op(n)) & irop_flag_dump_noinput) {
1296                 //fputs(" node_class:23", F);
1297         }
1298
1299         dump_node_info(F, n);
1300         print_node_error(F, p);
1301         print_dbg_info(F, get_irn_dbg_info(n));
1302         dump_node_vcgattr(F, n, NULL, bad);
1303         fputs("}\n", F);
1304         dump_const_node_local(F, n);
1305
1306         if (dump_node_edge_hook)
1307                 dump_node_edge_hook(F, n);
1308 }
1309
1310 /** dump the edge to the block this node belongs to */
1311 static void dump_ir_block_edge(FILE *F, ir_node *n)
1312 {
1313         if (get_opt_dump_const_local() && is_constlike_node(n)) return;
1314         if (!is_Block(n)) {
1315                 ir_node *block = get_nodes_block(n);
1316
1317                 if (get_opt_dump_const_local() && is_constlike_node(block)) {
1318                         dump_const_block_local(F, n);
1319                 } else {
1320                         fprintf(F, "edge: { sourcename: \"");
1321                         PRINT_NODEID(n);
1322                         fprintf(F, "\" targetname: ");
1323                         fprintf(F, "\""); PRINT_NODEID(block); fprintf(F, "\"");
1324
1325                         if (dump_edge_vcgattr_hook) {
1326                                 fprintf(F, " ");
1327                                 if (dump_edge_vcgattr_hook(F, n, -1)) {
1328                                         fprintf(F, "}\n");
1329                                         return;
1330                                 } else {
1331                                         fprintf(F, " "  BLOCK_EDGE_ATTR "}\n");
1332                                         return;
1333                                 }
1334                         }
1335
1336                         fprintf(F, " "   BLOCK_EDGE_ATTR "}\n");
1337                 }
1338         }
1339 }
1340
1341 static void print_data_edge_vcgattr(FILE *F, ir_node *from, int to)
1342 {
1343         /*
1344          * do not use get_nodes_block() here, will fail
1345          * if the irg is not pinned.
1346          */
1347         if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1348                 fprintf(F, INTRA_DATA_EDGE_ATTR);
1349         else
1350                 fprintf(F, INTER_DATA_EDGE_ATTR);
1351 }
1352
1353 static void print_mem_edge_vcgattr(FILE *F, ir_node *from, int to)
1354 {
1355         /*
1356          * do not use get_nodes_block() here, will fail
1357          * if the irg is not pinned.
1358          */
1359         if (get_irn_n(from, -1) == get_irn_n(get_irn_n(from, to), -1))
1360                 fprintf(F, INTRA_MEM_EDGE_ATTR);
1361         else
1362                 fprintf(F, INTER_MEM_EDGE_ATTR);
1363 }
1364
1365 /** Print the vcg attributes for the edge from node "from" to its "to"th input */
1366 static void print_edge_vcgattr(FILE *F, ir_node *from, int to)
1367 {
1368         assert(from);
1369
1370         if (dump_edge_vcgattr_hook)
1371                 if (dump_edge_vcgattr_hook(F, from, to))
1372                         return;
1373
1374         if ((flags & ir_dump_flag_back_edges) && is_backedge(from, to))
1375                 fprintf(F, BACK_EDGE_ATTR);
1376
1377         switch (get_irn_opcode(from)) {
1378         case iro_Block:
1379                 fprintf(F, CF_EDGE_ATTR);
1380                 break;
1381         case iro_Start:  break;
1382         case iro_End:
1383                 if (to >= 0) {
1384                         if (get_irn_mode(get_End_keepalive(from, to)) == mode_BB)
1385                                 fprintf(F, KEEP_ALIVE_CF_EDGE_ATTR);
1386                         else
1387                                 fprintf(F, KEEP_ALIVE_DF_EDGE_ATTR);
1388                 }
1389                 break;
1390         default:
1391                 if (is_Proj(from)) {
1392                         if (get_irn_mode(from) == mode_M)
1393                                 print_mem_edge_vcgattr(F, from, to);
1394                         else if (get_irn_mode(from) == mode_X)
1395                                 fprintf(F, CF_EDGE_ATTR);
1396                         else
1397                                 print_data_edge_vcgattr(F, from, to);
1398                 }
1399                 else if (get_irn_mode(get_irn_n(from, to)) == mode_M)
1400                         print_mem_edge_vcgattr(F, from, to);
1401                 else if (get_irn_mode(get_irn_n(from, to)) == mode_X)
1402                         fprintf(F, CF_EDGE_ATTR);
1403                 else
1404                         print_data_edge_vcgattr(F, from, to);
1405         }
1406 }
1407
1408 /** dump edges to our inputs */
1409 static void dump_ir_data_edges(FILE *F, ir_node *n)
1410 {
1411         int i, num;
1412
1413         if (!(flags & ir_dump_flag_keepalive_edges) && is_End(n)) {
1414                 /* the End node has only keep-alive edges */
1415                 return;
1416         }
1417
1418         /* dump the dependency edges. */
1419         num = get_irn_deps(n);
1420         for (i = 0; i < num; ++i) {
1421                 ir_node *dep = get_irn_dep(n, i);
1422
1423                 if (dep) {
1424                         print_node_edge_kind(F, n);
1425                         fprintf(F, "{sourcename: \"");
1426                         PRINT_NODEID(n);
1427                         fprintf(F, "\" targetname: ");
1428                         if ((get_opt_dump_const_local()) && is_constlike_node(dep)) {
1429                                 PRINT_CONSTID(n, dep);
1430                         } else {
1431                                 fprintf(F, "\"");
1432                                 PRINT_NODEID(dep);
1433                                 fprintf(F, "\"");
1434                         }
1435                         fprintf(F, " label: \"%d\" ", i);
1436                         fprintf(F, " color: darkgreen}\n");
1437                 }
1438         }
1439
1440         num = get_irn_arity(n);
1441         for (i = 0; i < num; i++) {
1442                 ir_node *pred = get_irn_n(n, i);
1443                 assert(pred);
1444
1445                 if ((flags & ir_dump_flag_back_edges) && is_backedge(n, i)) {
1446                         fprintf(F, "backedge: {sourcename: \"");
1447                 } else {
1448                         print_node_edge_kind(F, n);
1449                         fprintf(F, "{sourcename: \"");
1450                 }
1451                 PRINT_NODEID(n);
1452                 fprintf(F, "\" targetname: ");
1453                 if ((get_opt_dump_const_local()) && is_constlike_node(pred)) {
1454                         PRINT_CONSTID(n, pred);
1455                 } else {
1456                         fprintf(F, "\""); PRINT_NODEID(pred); fprintf(F, "\"");
1457                 }
1458                 fprintf(F, " label: \"%d\" ", i);
1459                 print_edge_vcgattr(F, n, i);
1460                 fprintf(F, "}\n");
1461         }
1462 }
1463
1464 /**
1465  * Dump the ir_edges
1466  */
1467 static void dump_ir_edges(ir_node *node, void *env)
1468 {
1469         int              i = 0;
1470         FILE            *F = (FILE*)env;
1471         const ir_edge_t *edge;
1472
1473         foreach_out_edge(node, edge) {
1474                 ir_node *succ = get_edge_src_irn(edge);
1475
1476                 print_node_edge_kind(F, succ);
1477                 fprintf(F, "{sourcename: \"");
1478                 PRINT_NODEID(node);
1479                 fprintf(F, "\" targetname: \"");
1480                 PRINT_NODEID(succ);
1481                 fprintf(F, "\"");
1482
1483                 fprintf(F, " label: \"%d\" ", i);
1484                 fprintf(F, OUT_EDGE_ATTR);
1485                 fprintf(F, "}\n");
1486                 ++i;
1487         }
1488 }
1489
1490
1491 /** Dumps a node and its edges but not the block edge  */
1492 static void dump_node_wo_blockedge(ir_node *n, void *env)
1493 {
1494         FILE *F = (FILE*)env;
1495         dump_node(F, n);
1496         dump_ir_data_edges(F, n);
1497 }
1498
1499 /** Dumps a node and its edges. */
1500 static void dump_node_with_edges(ir_node *n, void *env)
1501 {
1502         FILE *F = (FILE*)env;
1503         dump_node_wo_blockedge(n, env);
1504         if (!node_floats(n))
1505                 dump_ir_block_edge(F, n);
1506 }
1507
1508 /** Dumps a const-like node. */
1509 static void dump_const_node(ir_node *n, void *env)
1510 {
1511         if (is_Block(n)) return;
1512         dump_node_wo_blockedge(n, env);
1513 }
1514
1515 /***********************************************************************/
1516 /* the following routines dump the nodes/irgs bracketed to graphs.     */
1517 /***********************************************************************/
1518
1519 /** Dumps a constant expression as entity initializer, array bound ... */
1520 static void dump_const_expression(FILE *F, ir_node *value)
1521 {
1522         ir_graph *rem = current_ir_graph;
1523         ir_dump_flags_t old_flags = ir_get_dump_flags();
1524         ir_remove_dump_flags(ir_dump_flag_consts_local);
1525
1526         current_ir_graph = get_const_code_irg();
1527         irg_walk(value, dump_const_node, NULL, F);
1528         /* Decrease visited flag so that we walk with the same flag for the next
1529            expression.  This guarantees that we don't dump the same node twice,
1530            as for const expressions cse is performed to save memory. */
1531         set_irg_visited(current_ir_graph, get_irg_visited(current_ir_graph) -1);
1532
1533         ir_set_dump_flags(old_flags);
1534         current_ir_graph = rem;
1535 }
1536
1537 /** Dump a block as graph containing its nodes.
1538  *
1539  *  Expects to find nodes belonging to the block as list in its
1540  *  link field.
1541  *  Dumps the edges of all nodes including itself. */
1542 static void dump_whole_block(FILE *F, ir_node *block)
1543 {
1544         ir_node *node;
1545         ird_color_t color = ird_color_block_background;
1546
1547         assert(is_Block(block));
1548
1549         fprintf(F, "graph: { title: \"");
1550         PRINT_NODEID(block);
1551         fprintf(F, "\"  label: \"");
1552         dump_node_label(F, block);
1553
1554         /* colorize blocks */
1555         if (! get_Block_matured(block))
1556                 color = ird_color_block_background;
1557
1558         fprintf(F, "\" status:clustered ");
1559         print_vcg_color(F, color);
1560         fprintf(F, "\n");
1561
1562         /* yComp can show attributes for blocks, XVCG parses but ignores them */
1563         dump_node_info(F, block);
1564         print_dbg_info(F, get_irn_dbg_info(block));
1565
1566         /* dump the blocks edges */
1567         dump_ir_data_edges(F, block);
1568
1569         if (dump_block_edge_hook)
1570                 dump_block_edge_hook(F, block);
1571
1572         /* dump the nodes that go into the block */
1573         for (node = (ir_node*)ird_get_irn_link(block); node; node = (ir_node*)ird_get_irn_link(node)) {
1574                 dump_node(F, node);
1575                 dump_ir_data_edges(F, node);
1576         }
1577
1578         /* Close the vcg information for the block */
1579         fprintf(F, "}\n");
1580         dump_const_node_local(F, block);
1581         fprintf(F, "\n");
1582 }
1583
1584 /** dumps a graph block-wise. Expects all blockless nodes in arr in irgs link.
1585  *  The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
1586 static void dump_block_graph(FILE *F, ir_graph *irg)
1587 {
1588         size_t i, n;
1589         ir_graph *rem = current_ir_graph;
1590         ir_node **arr = (ir_node**)ird_get_irg_link(irg);
1591         current_ir_graph = irg;
1592
1593         for (i = 0, n = ARR_LEN(arr); i < n; ++i) {
1594                 ir_node *node = arr[i];
1595                 if (is_Block(node)) {
1596                 /* Dumps the block and all the nodes in the block, which are to
1597                         be found in Block->link. */
1598                         dump_whole_block(F, node);
1599                 } else {
1600                         /* Nodes that are not in a Block. */
1601                         dump_node(F, node);
1602                         if (!node_floats(node) && is_Bad(get_nodes_block(node))) {
1603                                 dump_const_block_local(F, node);
1604                         }
1605                         dump_ir_data_edges(F, node);
1606                 }
1607                 if ((flags & ir_dump_flag_iredges) && edges_activated(irg))
1608                         dump_ir_edges(node, F);
1609         }
1610
1611         if ((flags & ir_dump_flag_loops) && (get_irg_loopinfo_state(irg) & loopinfo_valid))
1612                 dump_loop_nodes_into_graph(F, irg);
1613
1614         current_ir_graph = rem;
1615 }
1616
1617 /**
1618  * Dump the info for an irg.
1619  * Parsed by XVCG but not shown. use yComp.
1620  */
1621 static void dump_graph_info(FILE *F, ir_graph *irg)
1622 {
1623         fprintf(F, "info1: \"");
1624         dump_entity_to_file(F, get_irg_entity(irg));
1625         fprintf(F, "\"\n");
1626 }
1627
1628 /** Dumps an irg as a graph clustered by block nodes.
1629  *  If interprocedural view edges can point to nodes out of this graph.
1630  */
1631 static void dump_graph_from_list(FILE *F, ir_graph *irg)
1632 {
1633         ir_entity *ent = get_irg_entity(irg);
1634
1635         fprintf(F, "graph: { title: \"");
1636         PRINT_IRGID(irg);
1637         fprintf(F, "\" label: \"%s\" status:clustered color:%s \n",
1638           get_ent_dump_name(ent), color_names[ird_color_prog_background]);
1639
1640         dump_graph_info(F, irg);
1641         print_dbg_info(F, get_entity_dbg_info(ent));
1642
1643         dump_block_graph(F, irg);
1644
1645         /* Close the vcg information for the irg */
1646         fprintf(F, "}\n\n");
1647 }
1648
1649 /*******************************************************************/
1650 /* Basic type and entity nodes and edges.                          */
1651 /*******************************************************************/
1652
1653 /** dumps the edges between nodes and their type or entity attributes. */
1654 static void dump_node2type_edges(ir_node *n, void *env)
1655 {
1656         FILE *F = (FILE*)env;
1657         assert(n);
1658
1659         switch (get_irn_opcode(n)) {
1660         case iro_Const :
1661                 /* @@@ some consts have an entity */
1662                 break;
1663         case iro_SymConst:
1664                 if (SYMCONST_HAS_TYPE(get_SymConst_kind(n)))
1665                         print_node_type_edge(F,n,get_SymConst_type(n),NODE2TYPE_EDGE_ATTR);
1666                 break;
1667         case iro_Sel:
1668                 print_node_ent_edge(F,n,get_Sel_entity(n),NODE2TYPE_EDGE_ATTR);
1669                 break;
1670         case iro_Call:
1671                 print_node_type_edge(F,n,get_Call_type(n),NODE2TYPE_EDGE_ATTR);
1672                 break;
1673         case iro_Alloc:
1674                 print_node_type_edge(F,n,get_Alloc_type(n),NODE2TYPE_EDGE_ATTR);
1675                 break;
1676         case iro_Free:
1677                 print_node_type_edge(F,n,get_Free_type(n),NODE2TYPE_EDGE_ATTR);
1678                 break;
1679         case iro_Cast:
1680                 print_node_type_edge(F,n,get_Cast_type(n),NODE2TYPE_EDGE_ATTR);
1681                 break;
1682         default:
1683                 break;
1684         }
1685 }
1686
1687 #if 0
1688 static int print_type_info(FILE *F, ir_type *tp)
1689 {
1690         int bad = 0;
1691
1692         if (get_type_state(tp) == layout_undefined) {
1693                 fprintf(F, "state: layout_undefined\n");
1694         } else {
1695                 fprintf(F, "state: layout_fixed,\n");
1696         }
1697         if (get_type_mode(tp))
1698                 fprintf(F, "mode: %s,\n", get_mode_name_ex(get_type_mode(tp), &bad));
1699         fprintf(F, "size: %db,\n", get_type_size_bits(tp));
1700
1701         return bad;
1702 }
1703
1704 static void print_typespecific_info(FILE *F, ir_type *tp)
1705 {
1706         switch (get_type_tpop_code(tp)) {
1707         case tpo_class:
1708                 fprintf(F, "peculiarity: %s\n", get_peculiarity_string(get_class_peculiarity(tp)));
1709                 break;
1710         case tpo_struct:
1711                 break;
1712         case tpo_method:
1713                 fprintf(F, "variadicity: %s\n", get_variadicity_name(get_method_variadicity(tp)));
1714                 fprintf(F, "params: %d\n", get_method_n_params(tp));
1715                 fprintf(F, "results: %d\n", get_method_n_ress(tp));
1716                 break;
1717         case tpo_union:
1718                 break;
1719         case tpo_array:
1720                 break;
1721         case tpo_enumeration:
1722                 break;
1723         case tpo_pointer:
1724                 break;
1725         case tpo_primitive:
1726                 break;
1727         default:
1728                 break;
1729         } /* switch type */
1730 }
1731 #endif
1732
1733 static void print_typespecific_vcgattr(FILE *F, ir_type *tp)
1734 {
1735         switch (get_type_tpop_code(tp)) {
1736         case tpo_class:
1737                 fprintf(F, " " TYPE_CLASS_NODE_ATTR);
1738                 break;
1739         case tpo_struct:
1740                 fprintf(F, " " TYPE_METH_NODE_ATTR);
1741                 break;
1742         case tpo_method:
1743                 break;
1744         case tpo_union:
1745                 break;
1746         case tpo_array:
1747                 break;
1748         case tpo_enumeration:
1749                 break;
1750         case tpo_pointer:
1751                 break;
1752         case tpo_primitive:
1753                 break;
1754         default:
1755                 break;
1756         } /* switch type */
1757 }
1758
1759 void dump_type_node(FILE *F, ir_type *tp)
1760 {
1761         fprintf(F, "node: {title: ");
1762         PRINT_TYPEID(tp);
1763         fprintf(F, " label: \"");
1764         if (tp->dbi != NULL) {
1765                 char buf[1024];
1766                 ir_print_type(buf, sizeof(buf), tp);
1767                 fprintf(F, "%s '%s'", get_type_tpop_name(tp), buf);
1768         } else {
1769                 ir_fprintf(F, "%+F", tp);
1770         }
1771         fputs("\" info1: \"", F);
1772         dump_type_to_file(F, tp);
1773         fprintf(F, "\"\n");
1774         print_type_dbg_info(F, get_type_dbg_info(tp));
1775         print_typespecific_vcgattr(F, tp);
1776         fprintf(F, "}\n");
1777 }
1778
1779 static void dump_entity_node(FILE *F, ir_entity *ent)
1780 {
1781         fprintf(F, "node: {title: \"");
1782         PRINT_ENTID(ent); fprintf(F, "\"");
1783         fprintf(F, " label: ");
1784         fprintf(F, "\"%s\" ", get_ent_dump_name(ent));
1785
1786         print_vcg_color(F, ird_color_entity);
1787         fprintf(F, "\n info1: \"");
1788
1789         dump_entity_to_file(F, ent);
1790
1791         fprintf(F, "\"\n");
1792         print_dbg_info(F, get_entity_dbg_info(ent));
1793         fprintf(F, "}\n");
1794 }
1795
1796 static void dump_enum_item(FILE *F, ir_type *tp, size_t pos)
1797 {
1798         char buf[1024];
1799         ir_enum_const *ec = get_enumeration_const(tp, pos);
1800         ident         *id = get_enumeration_const_nameid(ec);
1801         ir_tarval     *tv = get_enumeration_value(ec);
1802
1803         if (tv)
1804                 tarval_snprintf(buf, sizeof(buf), tv);
1805         else
1806                 strncpy(buf, "<not set>", sizeof(buf));
1807         fprintf(F, "node: {title: \"");
1808         PRINT_ITEMID(tp, pos); fprintf(F, "\"");
1809         fprintf(F, " label: ");
1810         fprintf(F, "\"enum item %s\" " ENUM_ITEM_NODE_ATTR, get_id_str(id));
1811         fprintf(F, "\n info1: \"value: %s\"}\n", buf);
1812 }
1813
1814 /**
1815  * Dumps a new style initializer.
1816  */
1817 static void dump_entity_initializer(FILE *F, const ir_entity *ent)
1818 {
1819         /* TODO */
1820         (void) F;
1821         (void) ent;
1822 }
1823
1824 /**
1825  * type-walker: Dumps a type or entity and its edges.
1826  */
1827 static void dump_type_info(type_or_ent tore, void *env)
1828 {
1829         FILE *F = (FILE*)env;
1830         size_t i = 0;  /* to shutup gcc */
1831
1832         /* dump this type or entity */
1833
1834         switch (get_kind(tore.ent)) {
1835         case k_entity: {
1836                 ir_entity *ent = tore.ent;
1837                 ir_node *value;
1838                 /* The node */
1839                 dump_entity_node(F, ent);
1840                 /* The Edges */
1841                 /* skip this to reduce graph.  Member edge of type is parallel to this edge. *
1842                 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
1843                 ENT_OWN_EDGE_ATTR "}\n", ent, get_entity_owner(ent));*/
1844                 print_ent_type_edge(F,ent, get_entity_type(ent), ENT_TYPE_EDGE_ATTR);
1845                 if (is_Class_type(get_entity_owner(ent))) {
1846                         for (i = get_entity_n_overwrites(ent); i > 0;)
1847                                 print_ent_ent_edge(F, ent, get_entity_overwrites(ent, --i), 0, ird_color_none, ENT_OVERWRITES_EDGE_ATTR);
1848                 }
1849                 /* attached subgraphs */
1850                 if (! (flags & ir_dump_flag_no_entity_values)) {
1851                         if (ent->initializer != NULL) {
1852                                 /* new style initializers */
1853                                 dump_entity_initializer(F, ent);
1854                         } else if (entity_has_compound_ent_values(ent)) {
1855                                 /* old style compound entity values */
1856                                 for (i = get_compound_ent_n_values(ent); i > 0;) {
1857                                         value = get_compound_ent_value(ent, --i);
1858                                         if (value) {
1859                                                 print_ent_node_edge(F, ent, value, ENT_VALUE_EDGE_ATTR, i);
1860                                                 dump_const_expression(F, value);
1861                                                 print_ent_ent_edge(F, ent, get_compound_ent_value_member(ent, i), 0, ird_color_none, ENT_CORR_EDGE_ATTR, i);
1862                                                 /*
1863                                                 fprintf(F, "edge: { sourcename: \"%p\" targetname: \"%p\" "
1864                                                 ENT_CORR_EDGE_ATTR  "}\n", GET_ENTID(ent),
1865                                                 get_compound_ent_value_member(ent, i), i);
1866                                                 */
1867                                         }
1868                                 }
1869                         }
1870                 }
1871                 break;
1872         }
1873         case k_type: {
1874                 ir_type *tp = tore.typ;
1875                 dump_type_node(F, tp);
1876                 /* and now the edges */
1877                 switch (get_type_tpop_code(tp)) {
1878                 case tpo_class:
1879                         for (i = get_class_n_supertypes(tp); i > 0;) {
1880                                 --i;
1881                                 print_type_type_edge(F, tp, get_class_supertype(tp, i), TYPE_SUPER_EDGE_ATTR);
1882                         }
1883                         for (i = get_class_n_members(tp); i > 0;) {
1884                                 --i;
1885                                 print_type_ent_edge(F, tp, get_class_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
1886                         }
1887                         break;
1888                 case tpo_struct:
1889                         for (i = get_struct_n_members(tp); i > 0;) {
1890                                 --i;
1891                                 print_type_ent_edge(F, tp, get_struct_member(tp, i), TYPE_MEMBER_EDGE_ATTR);
1892                         }
1893                         break;
1894                 case tpo_method:
1895                         for (i = get_method_n_params(tp); i > 0;) {
1896                                 --i;
1897                                 print_type_type_edge(F, tp, get_method_param_type(tp, i), METH_PAR_EDGE_ATTR,i);
1898                         }
1899                         for (i = get_method_n_ress(tp); i > 0;) {
1900                                  --i;
1901                                 print_type_type_edge(F, tp, get_method_res_type(tp, i), METH_RES_EDGE_ATTR,i);
1902                         }
1903                         break;
1904                 case tpo_union:
1905                         for (i = get_union_n_members(tp); i > 0;) {
1906                                  --i;
1907                                 print_type_ent_edge(F, tp, get_union_member(tp, i), UNION_EDGE_ATTR);
1908                         }
1909                         break;
1910                 case tpo_array:
1911                         print_type_type_edge(F, tp, get_array_element_type(tp), ARR_ELT_TYPE_EDGE_ATTR);
1912                         print_type_ent_edge(F, tp, get_array_element_entity(tp), ARR_ENT_EDGE_ATTR);
1913                         for (i = get_array_n_dimensions(tp); i > 0;) {
1914                                 ir_node *upper, *lower;
1915
1916                                  --i;
1917                                 upper = get_array_upper_bound(tp, i);
1918                                 lower = get_array_lower_bound(tp, i);
1919                                 print_node_type_edge(F, upper, tp, "label: \"upper %zu\"", get_array_order(tp, i));
1920                                 print_node_type_edge(F, lower, tp, "label: \"lower %zu\"", get_array_order(tp, i));
1921                                 dump_const_expression(F, upper);
1922                                 dump_const_expression(F, lower);
1923                         }
1924                         break;
1925                 case tpo_enumeration:
1926                         for (i = get_enumeration_n_enums(tp); i > 0;) {
1927                                  --i;
1928                                 dump_enum_item(F, tp, i);
1929                                 print_enum_item_edge(F, tp, i, "label: \"item %zu\"", i);
1930                         }
1931                         break;
1932                 case tpo_pointer:
1933                         print_type_type_edge(F, tp, get_pointer_points_to_type(tp), PTR_PTS_TO_EDGE_ATTR);
1934                         break;
1935                 case tpo_primitive:
1936                         break;
1937                 default:
1938                         break;
1939                 } /* switch type */
1940                 break; /* case k_type */
1941         }
1942         default:
1943                 printf(" *** irdump,  dump_type_info(l.%i), faulty type.\n", __LINE__);
1944         } /* switch kind_or_entity */
1945 }
1946
1947 /** For dumping class hierarchies.
1948  * Dumps a class type node and a superclass edge.
1949  */
1950 static void dump_class_hierarchy_node(type_or_ent tore, void *ctx)
1951 {
1952         FILE *F = (FILE*)ctx;
1953         size_t i = 0;  /* to shutup gcc */
1954
1955         /* dump this type or entity */
1956         switch (get_kind(tore.ent)) {
1957         case k_entity: {
1958                 ir_entity *ent = tore.ent;
1959                 if (get_entity_owner(ent) == get_glob_type()) break;
1960                 if (!is_Method_type(get_entity_type(ent)))
1961                         break;  /* GL */
1962                 if (flags & ir_dump_flag_entities_in_hierarchy
1963                                 && is_Class_type(get_entity_owner(ent))) {
1964                         /* The node */
1965                         dump_entity_node(F, ent);
1966                         /* The edges */
1967                         print_type_ent_edge(F, get_entity_owner(ent), ent, TYPE_MEMBER_EDGE_ATTR);
1968                         for (i = get_entity_n_overwrites(ent); i > 0;) {
1969                                  --i;
1970                                 print_ent_ent_edge(F, get_entity_overwrites(ent, i), ent, 0, ird_color_none, ENT_OVERWRITES_EDGE_ATTR);
1971                         }
1972                 }
1973                 break;
1974         }
1975         case k_type: {
1976                 ir_type *tp = tore.typ;
1977                 if (tp == get_glob_type())
1978                         break;
1979                 switch (get_type_tpop_code(tp)) {
1980                 case tpo_class:
1981                         dump_type_node(F, tp);
1982                         /* and now the edges */
1983                         for (i = get_class_n_supertypes(tp); i > 0;) {
1984                                  --i;
1985                                 print_type_type_edge(F,tp,get_class_supertype(tp, i),TYPE_SUPER_EDGE_ATTR);
1986                         }
1987                         break;
1988                 default: break;
1989                 } /* switch type */
1990                 break; /* case k_type */
1991         }
1992         default:
1993                 printf(" *** irdump,  dump_class_hierarchy_node(l.%i), faulty type.\n", __LINE__);
1994         } /* switch kind_or_entity */
1995 }
1996
1997 /*******************************************************************/
1998 /* dump analysis information that is expressed in graph terms.     */
1999 /*******************************************************************/
2000
2001 /* dump out edges */
2002 static void dump_out_edge(ir_node *n, void *env)
2003 {
2004         FILE *F = (FILE*)env;
2005         int i;
2006         for (i = get_irn_n_outs(n) - 1; i >= 0; --i) {
2007                 ir_node *succ = get_irn_out(n, i);
2008                 assert(succ);
2009                 print_node_edge_kind(F, succ);
2010                 fprintf(F, "{sourcename: \"");
2011                 PRINT_NODEID(n);
2012                 fprintf(F, "\" targetname: \"");
2013                 PRINT_NODEID(succ);
2014                 fprintf(F, "\" color: red linestyle: dashed");
2015                 fprintf(F, "}\n");
2016         }
2017 }
2018
2019 static void dump_loop_label(FILE *F, ir_loop *loop)
2020 {
2021         fprintf(F, "loop %u, %lu sons, %lu nodes",
2022                 get_loop_depth(loop), (unsigned long) get_loop_n_sons(loop),
2023                 (unsigned long) get_loop_n_nodes(loop));
2024 }
2025
2026 static void dump_loop_info(FILE *F, ir_loop *loop)
2027 {
2028         fprintf(F, " info1: \"");
2029         fprintf(F, " loop nr: %ld", get_loop_loop_nr(loop));
2030 #ifdef DEBUG_libfirm   /* GL @@@ debug analyses */
2031         fprintf(F, "\n The loop was analyzed %ld times.", (long int) PTR_TO_INT(get_loop_link(loop)));
2032 #endif
2033         fprintf(F, "\"");
2034 }
2035
2036 static void dump_loop_node(FILE *F, ir_loop *loop)
2037 {
2038         fprintf(F, "node: {title: \"");
2039         PRINT_LOOPID(loop);
2040         fprintf(F, "\" label: \"");
2041         dump_loop_label(F, loop);
2042         fprintf(F, "\" ");
2043         dump_loop_info(F, loop);
2044         fprintf(F, "}\n");
2045 }
2046
2047 static void dump_loop_node_edge(FILE *F, ir_loop *loop, size_t i)
2048 {
2049         assert(loop);
2050         fprintf(F, "edge: {sourcename: \"");
2051         PRINT_LOOPID(loop);
2052         fprintf(F, "\" targetname: \"");
2053         PRINT_NODEID(get_loop_node(loop, i));
2054         fprintf(F, "\" color: green");
2055         fprintf(F, "}\n");
2056 }
2057
2058 static void dump_loop_son_edge(FILE *F, ir_loop *loop, size_t i)
2059 {
2060         assert(loop);
2061         fprintf(F, "edge: {sourcename: \"");
2062         PRINT_LOOPID(loop);
2063         fprintf(F, "\" targetname: \"");
2064         PRINT_LOOPID(get_loop_son(loop, i));
2065         ir_fprintf(F, "\" color: darkgreen label: \"%zu\"}\n",
2066                 get_loop_element_pos(loop, get_loop_son(loop, i)));
2067 }
2068
2069 static void dump_loops(FILE *F, ir_loop *loop)
2070 {
2071         size_t i;
2072         /* dump this loop node */
2073         dump_loop_node(F, loop);
2074
2075         /* dump edges to nodes in loop -- only if it is a real loop */
2076         if (get_loop_depth(loop) != 0) {
2077                 for (i = get_loop_n_nodes(loop); i > 0;) {
2078                         --i;
2079                         dump_loop_node_edge(F, loop, i);
2080                 }
2081         }
2082         for (i = get_loop_n_sons(loop); i > 0;) {
2083                  --i;
2084                 dump_loops(F, get_loop_son(loop, i));
2085                 dump_loop_son_edge(F, loop, i);
2086         }
2087 }
2088
2089 static void dump_loop_nodes_into_graph(FILE *F, ir_graph *irg)
2090 {
2091         ir_loop *loop = get_irg_loop(irg);
2092
2093         if (loop != NULL) {
2094                 ir_graph *rem = current_ir_graph;
2095                 current_ir_graph = irg;
2096
2097                 dump_loops(F, loop);
2098
2099                 current_ir_graph = rem;
2100         }
2101 }
2102
2103
2104 /**
2105  * dumps the VCG header
2106  */
2107 void dump_vcg_header(FILE *F, const char *name, const char *layout, const char *orientation)
2108 {
2109         int   i;
2110         const char *label
2111                 = (flags & ir_dump_flag_disable_edge_labels) ? "no" : "yes";
2112
2113         init_colors();
2114
2115         if (! layout)     layout = "Compilergraph";
2116         if (!orientation) orientation = "bottom_to_top";
2117
2118         /* print header */
2119         fprintf(F,
2120                 "graph: { title: \"ir graph of %s\"\n"
2121                 "display_edge_labels: %s\n"
2122                 "layoutalgorithm: mindepth //$ \"%s\"\n"
2123                 "manhattan_edges: yes\n"
2124                 "port_sharing: no\n"
2125                 "orientation: %s\n"
2126                 "classname 1:  \"intrablock Data\"\n"
2127                 "classname 2:  \"Block\"\n"
2128                 "classname 3:  \"Entity type\"\n"
2129                 "classname 4:  \"Entity owner\"\n"
2130                 "classname 5:  \"Method Param\"\n"
2131                 "classname 6:  \"Method Res\"\n"
2132                 "classname 7:  \"Super\"\n"
2133                 "classname 8:  \"Union\"\n"
2134                 "classname 9:  \"Points-to\"\n"
2135                 "classname 10: \"Array Element Type\"\n"
2136                 "classname 11: \"Overwrites\"\n"
2137                 "classname 12: \"Member\"\n"
2138                 "classname 13: \"Control Flow\"\n"
2139                 "classname 14: \"intrablock Memory\"\n"
2140                 "classname 15: \"Dominators\"\n"
2141                 "classname 16: \"interblock Data\"\n"
2142                 "classname 17: \"interblock Memory\"\n"
2143                 "classname 18: \"Exception Control Flow for Interval Analysis\"\n"
2144                 "classname 19: \"Postdominators\"\n"
2145                 "classname 20: \"Keep Alive\"\n"
2146                 "classname 21: \"Out Edges\"\n"
2147                 "classname 22: \"Macro Block Edges\"\n"
2148                 //"classname 23: \"NoInput Nodes\"\n"
2149                 "infoname 1: \"Attribute\"\n"
2150                 "infoname 2: \"Verification errors\"\n"
2151                 "infoname 3: \"Debug info\"\n",
2152                 name, label, layout, orientation);
2153
2154         for (i = 0; i < ird_color_count; ++i) {
2155                 if (color_rgb[i] != NULL) {
2156                         fprintf(F, "colorentry %s: %s\n", color_names[i], color_rgb[i]);
2157                 }
2158         }
2159         fprintf(F, "\n");
2160 }
2161
2162 /**
2163  * Dumps the vcg file footer
2164  */
2165 void dump_vcg_footer(FILE *F)
2166 {
2167         fprintf(F, "}\n");
2168 }
2169
2170
2171
2172 static void dump_blocks_as_subgraphs(FILE *out, ir_graph *irg)
2173 {
2174         size_t i;
2175
2176         construct_block_lists(irg);
2177
2178         /*
2179          * If we are in the interprocedural view, we dump not
2180          * only the requested irg but also all irgs that can be reached
2181          * from irg.
2182          */
2183         for (i = get_irp_n_irgs(); i > 0;) {
2184                 ir_graph *irg = get_irp_irg(--i);
2185                 ir_node **arr = (ir_node**)ird_get_irg_link(irg);
2186                 if (arr == NULL)
2187                         continue;
2188
2189                 dump_graph_from_list(out, irg);
2190                 DEL_ARR_F(arr);
2191         }
2192 }
2193
2194 /** dumps a graph extended block-wise. Expects all blockless nodes in arr in irgs link.
2195  *  The outermost nodes: blocks and nodes not op_pin_state_pinned, Bad, Unknown. */
2196 static void dump_extblock_graph(FILE *F, ir_graph *irg)
2197 {
2198         size_t i, arr_len;
2199         ir_graph *rem = current_ir_graph;
2200         ir_extblk **arr = (ir_extblk**)ird_get_irg_link(irg);
2201         current_ir_graph = irg;
2202
2203         for (i = 0, arr_len = ARR_LEN(arr); i < arr_len; ++i) {
2204                 ir_extblk *extbb = arr[i];
2205                 ir_node *leader = get_extbb_leader(extbb);
2206                 size_t j, n_blks;
2207
2208                 fprintf(F, "graph: { title: \"");
2209                 PRINT_EXTBBID(leader);
2210                 fprintf(F, "\"  label: \"ExtBB %ld\" status:clustered color:lightgreen\n",
2211                         get_irn_node_nr(leader));
2212
2213                 for (j = 0, n_blks = ARR_LEN(extbb->blks); j < n_blks; ++j) {
2214                         ir_node *node = extbb->blks[j];
2215                         if (is_Block(node)) {
2216                         /* Dumps the block and all the nodes in the block, which are to
2217                                 be found in Block->link. */
2218                                 dump_whole_block(F, node);
2219                         } else {
2220                                 /* Nodes that are not in a Block. */
2221                                 dump_node(F, node);
2222                                 if (is_Bad(get_nodes_block(node)) && !node_floats(node)) {
2223                                         dump_const_block_local(F, node);
2224                                 }
2225                                 dump_ir_data_edges(F, node);
2226                         }
2227                 }
2228                 fprintf(F, "}\n");
2229         }
2230
2231         if ((flags & ir_dump_flag_loops)
2232                         && (get_irg_loopinfo_state(irg) & loopinfo_valid))
2233                 dump_loop_nodes_into_graph(F, irg);
2234
2235         current_ir_graph = rem;
2236         free_extbb(irg);
2237 }
2238
2239 static void dump_blocks_extbb_grouped(FILE *F, ir_graph *irg)
2240 {
2241         size_t    i;
2242         ir_entity *ent = get_irg_entity(irg);
2243
2244         if (get_irg_extblk_state(irg) != ir_extblk_info_valid)
2245                 compute_extbb(irg);
2246
2247         construct_extblock_lists(irg);
2248
2249         fprintf(F, "graph: { title: \"");
2250         PRINT_IRGID(irg);
2251         fprintf(F, "\" label: \"%s\" status:clustered color: white \n",
2252                 get_ent_dump_name(ent));
2253
2254         dump_graph_info(F, irg);
2255         print_dbg_info(F, get_entity_dbg_info(ent));
2256
2257         for (i = get_irp_n_irgs(); i > 0;) {
2258                 ir_graph *irg     = get_irp_irg(--i);
2259                 list_tuple *lists = (list_tuple*)ird_get_irg_link(irg);
2260
2261                 if (lists) {
2262                         /* dump the extended blocks first */
2263                         if (ARR_LEN(lists->extbb_list)) {
2264                                 ird_set_irg_link(irg, lists->extbb_list);
2265                                 dump_extblock_graph(F, irg);
2266                         }
2267
2268                         /* we may have blocks without extended blocks, bad for instance */
2269                         if (ARR_LEN(lists->blk_list)) {
2270                                 ird_set_irg_link(irg, lists->blk_list);
2271                                 dump_block_graph(F, irg);
2272                         }
2273
2274                         DEL_ARR_F(lists->extbb_list);
2275                         DEL_ARR_F(lists->blk_list);
2276                         xfree(lists);
2277                 }
2278         }
2279
2280         /* Close the vcg information for the irg */
2281         fprintf(F, "}\n\n");
2282
2283         free_extbb(irg);
2284 }
2285
2286 void dump_ir_graph_file(FILE *out, ir_graph *irg)
2287 {
2288         dump_vcg_header(out, get_irg_dump_name(irg), NULL, NULL);
2289
2290         /* dump nodes */
2291         if (flags & ir_dump_flag_blocks_as_subgraphs) {
2292                 if (flags & ir_dump_flag_group_extbb) {
2293                         dump_blocks_extbb_grouped(out, irg);
2294                 } else {
2295                         dump_blocks_as_subgraphs(out, irg);
2296                 }
2297         } else {
2298                 /* dump_node_with_edges must be called in post visiting predecessors */
2299                 ird_walk_graph(irg, NULL, dump_node_with_edges, out);
2300         }
2301
2302         /* dump type info */
2303         if (flags & ir_dump_flag_with_typegraph) {
2304                 ir_graph *rem = current_ir_graph;
2305                 current_ir_graph = irg;
2306
2307                 type_walk_irg(irg, dump_type_info, NULL, out);
2308                 inc_irg_visited(get_const_code_irg());
2309                 /* dump edges from graph to type info */
2310                 irg_walk(get_irg_end(irg), dump_node2type_edges, NULL, out);
2311
2312                 current_ir_graph = rem;
2313         }
2314
2315         /* dump iredges out edges */
2316         if ((flags & ir_dump_flag_iredges) && edges_activated(current_ir_graph)) {
2317                 irg_walk_edges(get_irg_start_block(irg), dump_ir_edges, NULL, out);
2318         }
2319
2320         /* dump the out edges in a separate walk */
2321         if ((flags & ir_dump_flag_out_edges)
2322                         && (get_irg_outs_state(irg) != outs_none)) {
2323                 irg_out_walk(get_irg_start(irg), dump_out_edge, NULL, out);
2324         }
2325
2326         dump_vcg_footer(out);
2327 }
2328
2329 static void dump_block_to_cfg(ir_node *block, void *env)
2330 {
2331         FILE *F = (FILE*)env;
2332         int i, fl = 0;
2333         ir_node *pred;
2334
2335         if (is_Block(block)) {
2336                 /* This is a block. Dump a node for the block. */
2337                 fprintf(F, "node: {title: \""); PRINT_NODEID(block);
2338                 fprintf(F, "\" label: \"");
2339                 if (block == get_irg_start_block(get_irn_irg(block)))
2340                         fprintf(F, "Start ");
2341                 if (block == get_irg_end_block(get_irn_irg(block)))
2342                         fprintf(F, "End ");
2343
2344                 fprintf(F, "%s ", get_op_name(get_irn_op(block)));
2345                 PRINT_NODEID(block);
2346                 fprintf(F, "\" ");
2347                 fprintf(F, "info1:\"");
2348
2349                 /* the generic version. */
2350                 dump_irnode_to_file(F, block);
2351
2352                 /* Check whether we have bad predecessors to color the block. */
2353                 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
2354                         if ((fl = is_Bad(get_Block_cfgpred(block, i))))
2355                                 break;
2356
2357                 fprintf(F, "\"");  /* closing quote of info */
2358
2359                 if ((block == get_irg_start_block(get_irn_irg(block))) ||
2360                         (block == get_irg_end_block(get_irn_irg(block)))     )
2361                         fprintf(F, " color:blue ");
2362                 else if (fl)
2363                         fprintf(F, " color:yellow ");
2364
2365                 fprintf(F, "}\n");
2366                 /* Dump the edges */
2367                 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i)
2368                         if (!is_Bad(skip_Proj(get_Block_cfgpred(block, i)))) {
2369                                 pred = get_nodes_block(skip_Proj(get_Block_cfgpred(block, i)));
2370                                 fprintf(F, "edge: { sourcename: \"");
2371                                 PRINT_NODEID(block);
2372                                 fprintf(F, "\" targetname: \"");
2373                                 PRINT_NODEID(pred);
2374                                 fprintf(F, "\"}\n");
2375                         }
2376
2377                 /* Dump dominator/postdominator edge */
2378                 if (ir_get_dump_flags() & ir_dump_flag_dominance) {
2379                         if (get_irg_dom_state(current_ir_graph) == dom_consistent && get_Block_idom(block)) {
2380                                 pred = get_Block_idom(block);
2381                                 fprintf(F, "edge: { sourcename: \"");
2382                                 PRINT_NODEID(block);
2383                                 fprintf(F, "\" targetname: \"");
2384                                 PRINT_NODEID(pred);
2385                                 fprintf(F, "\" " DOMINATOR_EDGE_ATTR "}\n");
2386                         }
2387                         if (get_irg_postdom_state(current_ir_graph) == dom_consistent && get_Block_ipostdom(block)) {
2388                                 pred = get_Block_ipostdom(block);
2389                                 fprintf(F, "edge: { sourcename: \"");
2390                                 PRINT_NODEID(block);
2391                                 fprintf(F, "\" targetname: \"");
2392                                 PRINT_NODEID(pred);
2393                                 fprintf(F, "\" " POSTDOMINATOR_EDGE_ATTR "}\n");
2394                         }
2395                 }
2396         }
2397 }
2398
2399 void dump_cfg(FILE *F, ir_graph *irg)
2400 {
2401         dump_vcg_header(F, get_irg_dump_name(irg), NULL, NULL);
2402
2403         /* walk over the blocks in the graph */
2404         irg_block_walk(get_irg_end(irg), dump_block_to_cfg, NULL, F);
2405         /* dump_node(F, get_irg_bad(irg)); */
2406
2407         dump_vcg_footer(F);
2408 }
2409
2410 void dump_callgraph(FILE *F)
2411 {
2412         size_t          i;
2413         ir_dump_flags_t old_flags = ir_get_dump_flags();
2414
2415         ir_remove_dump_flags(ir_dump_flag_disable_edge_labels);
2416         dump_vcg_header(F, "Callgraph", "Hierarchic", NULL);
2417
2418         for (i = get_irp_n_irgs(); i > 0;) {
2419                 ir_graph *irg = get_irp_irg(--i);
2420                 ir_entity *ent = get_irg_entity(irg);
2421                 size_t j, n_callees = get_irg_n_callees(irg);
2422
2423                 dump_entity_node(F, ent);
2424                 for (j = 0; j < n_callees; ++j) {
2425                         ir_entity  *c    = get_irg_entity(get_irg_callee(irg, j));
2426                         int         be   = is_irg_callee_backedge(irg, j);
2427                         const char *attr = be
2428                                 ? "label:\"recursion %zu\""
2429                                 : "label:\"calls %zu\"";
2430                         print_ent_ent_edge(F, ent, c, be, ird_color_entity, attr,
2431                                            get_irg_callee_loop_depth(irg, j));
2432                 }
2433         }
2434
2435         ir_set_dump_flags(old_flags);
2436         dump_vcg_footer(F);
2437 }
2438
2439 void dump_typegraph(FILE *out)
2440 {
2441         dump_vcg_header(out, "All_types", "Hierarchic", NULL);
2442         type_walk(dump_type_info, NULL, out);
2443         dump_vcg_footer(out);
2444 }
2445
2446 void dump_class_hierarchy(FILE *out)
2447 {
2448         dump_vcg_header(out, "class_hierarchy", "Hierarchic", NULL);
2449         type_walk(dump_class_hierarchy_node, NULL, out);
2450         dump_vcg_footer(out);
2451 }
2452
2453 static void dump_loops_standalone(FILE *F, ir_loop *loop)
2454 {
2455         size_t i;
2456         bool   loop_node_started = false;
2457         size_t first      = 0;
2458         size_t son_number = 0;
2459         loop_element le;
2460         ir_loop *son = NULL;
2461
2462         /* Dump a new loop node. */
2463         dump_loop_node(F, loop);
2464
2465         /* Dump the loop elements. */
2466         for (i = 0; i < get_loop_n_elements(loop); i++) {
2467                 le = get_loop_element(loop, i);
2468                 son = le.son;
2469                 if (get_kind(son) == k_ir_loop) {
2470
2471                         /* We are a loop son -> Recurse */
2472
2473                         if (loop_node_started) { /* Close the "firm-nodes" node first if we started one. */
2474                                 fprintf(F, "\" }\n");
2475                                 fprintf(F, "edge: {sourcename: \"");
2476                                 PRINT_LOOPID(loop);
2477                                 fprintf(F, "\" targetname: \"");
2478                                 PRINT_LOOPID(loop);
2479                                 fprintf(F, "-%lu-nodes\" label:\"%lu...%lu\"}\n",
2480                                                 (unsigned long) first,
2481                                                 (unsigned long) first,
2482                                         (unsigned long) i-1);
2483                                 loop_node_started = false;
2484                         }
2485                         dump_loop_son_edge(F, loop, son_number++);
2486                         dump_loops_standalone(F, son);
2487                 } else if (get_kind(son) == k_ir_node) {
2488                         /* We are a loop node -> Collect firm nodes */
2489
2490                         ir_node *n = le.node;
2491                         if (!loop_node_started) {
2492                                 /* Start a new node which contains all firm nodes of the current loop */
2493                                 fprintf(F, "node: { title: \"");
2494                                 PRINT_LOOPID(loop);
2495                                 fprintf(F, "-%lu-nodes\" color: lightyellow label: \"",
2496                                         (unsigned long)i);
2497                                 loop_node_started = true;
2498                                 first = i;
2499                         } else
2500                                 fprintf(F, "\n");
2501
2502                         dump_node_label(F, n);
2503                         /* Causes indeterministic output: if (is_Block(n)) fprintf(F, "\t ->%d", (int)get_irn_link(n)); */
2504                         if (has_backedges(n)) fprintf(F, "\t loop head!");
2505                 } else { /* for callgraph loop tree */
2506                         ir_graph *n;
2507                         assert(get_kind(son) == k_ir_graph);
2508
2509                         /* We are a loop node -> Collect firm graphs */
2510                         n = le.irg;
2511                         if (!loop_node_started) {
2512                                 /* Start a new node which contains all firm nodes of the current loop */
2513                                 fprintf(F, "node: { title: \"");
2514                                 PRINT_LOOPID(loop);
2515                                 fprintf(F, "-%lu-nodes\" color: lightyellow label: \"",
2516                                         (unsigned long)i);
2517                                 loop_node_started = true;
2518                                 first = i;
2519                         } else
2520                                 fprintf(F, "\n");
2521                         fprintf(F, " %s", get_irg_dump_name(n));
2522                         /* fprintf(F, " %s (depth %d)", get_irg_dump_name(n), n->callgraph_weighted_loop_depth); */
2523                 }
2524         }
2525
2526         if (loop_node_started) {
2527                 fprintf(F, "\" }\n");
2528                 fprintf(F, "edge: {sourcename: \"");
2529                 PRINT_LOOPID(loop);
2530                 fprintf(F, "\" targetname: \"");
2531                 PRINT_LOOPID(loop);
2532                 fprintf(F, "-%lu-nodes\" label:\"%lu...%lu\"}\n",
2533                         (unsigned long) first,
2534                         (unsigned long) first,
2535                         (unsigned long) i-1);
2536                 loop_node_started = false;
2537         }
2538 }
2539
2540 void dump_loop_tree(FILE *out, ir_graph *irg)
2541 {
2542         ir_graph       *rem       = current_ir_graph;
2543         ir_dump_flags_t old_flags = ir_get_dump_flags();
2544
2545         current_ir_graph = irg;
2546         ir_remove_dump_flags(ir_dump_flag_disable_edge_labels);
2547
2548         dump_vcg_header(out, get_irg_dump_name(irg), "Tree", "top_to_bottom");
2549
2550         if (get_irg_loop(irg))
2551                 dump_loops_standalone(out, get_irg_loop(irg));
2552
2553         dump_vcg_footer(out);
2554
2555         ir_set_dump_flags(old_flags);
2556         current_ir_graph = rem;
2557 }
2558
2559 void dump_callgraph_loop_tree(FILE *out)
2560 {
2561         dump_vcg_header(out, "callgraph looptree", "Tree", "top_to_bottom");
2562         dump_loops_standalone(out, irp->outermost_cg_loop);
2563         dump_vcg_footer(out);
2564 }
2565
2566 static void collect_nodeloop(FILE *F, ir_loop *loop, eset *loopnodes)
2567 {
2568         size_t i;
2569         int    son_number = 0;
2570         int    node_number = 0;
2571
2572         if (flags & ir_dump_flag_loops)
2573                 dump_loop_node(F, loop);
2574
2575         for (i = 0; i < get_loop_n_elements(loop); i++) {
2576                 loop_element le = get_loop_element(loop, i);
2577                 if (*(le.kind) == k_ir_loop) {
2578                         if (flags & ir_dump_flag_loops)
2579                                 dump_loop_son_edge(F, loop, son_number++);
2580                         /* Recur */
2581                         collect_nodeloop(F, le.son, loopnodes);
2582                 } else {
2583                         if (flags & ir_dump_flag_loops)
2584                                 dump_loop_node_edge(F, loop, node_number++);
2585                         eset_insert(loopnodes, le.node);
2586                 }
2587         }
2588 }
2589
2590 static void collect_nodeloop_external_nodes(ir_loop *loop, eset *loopnodes,
2591                                             eset *extnodes)
2592 {
2593         size_t i;
2594         int j, start;
2595
2596         for (i = 0; i < get_loop_n_elements(loop); i++) {
2597                 loop_element le = get_loop_element(loop, i);
2598                 if (*(le.kind) == k_ir_loop) {
2599                         /* Recur */
2600                         collect_nodeloop_external_nodes(le.son, loopnodes, extnodes);
2601                 } else {
2602                         if (is_Block(le.node)) start = 0; else start = -1;
2603                         for (j = start; j < get_irn_arity(le.node); j++) {
2604                                 ir_node *pred = get_irn_n(le.node, j);
2605                                 if (!eset_contains(loopnodes, pred)) {
2606                                         eset_insert(extnodes, pred);
2607                                         if (!is_Block(pred)) {
2608                                                 pred = get_nodes_block(pred);
2609                                                 if (!eset_contains(loopnodes, pred)) eset_insert(extnodes, pred);
2610                                         }
2611                                 }
2612                         }
2613                 }
2614         }
2615 }
2616
2617 void dump_loop(FILE *F, ir_loop *l)
2618 {
2619         eset *loopnodes = eset_create();
2620         eset *extnodes = eset_create();
2621         ir_node *n, *b;
2622         char name[50];
2623
2624         snprintf(name, sizeof(name), "loop_%ld", get_loop_loop_nr(l));
2625         dump_vcg_header(F, name, NULL, NULL);
2626
2627         /* collect all nodes to dump */
2628         collect_nodeloop(F, l, loopnodes);
2629         collect_nodeloop_external_nodes(l, loopnodes, extnodes);
2630
2631         /* build block lists */
2632         eset_foreach(loopnodes, ir_node*, n) {
2633                 set_irn_link(n, NULL);
2634         }
2635         eset_foreach(extnodes, ir_node*, n) {
2636                 set_irn_link(n, NULL);
2637         }
2638         eset_foreach(loopnodes, ir_node*, n) {
2639                 if (!is_Block(n)) {
2640                         b = get_nodes_block(n);
2641                         set_irn_link(n, get_irn_link(b));
2642                         set_irn_link(b, n);
2643                 }
2644         }
2645         eset_foreach(extnodes, ir_node*, n) {
2646                 if (!is_Block(n)) {
2647                         b = get_nodes_block(n);
2648                         set_irn_link(n, get_irn_link(b));
2649                         set_irn_link(b, n);
2650                 }
2651         }
2652
2653         eset_foreach(loopnodes, ir_node*, b) {
2654                 if (is_Block(b)) {
2655                         fprintf(F, "graph: { title: \"");
2656                         PRINT_NODEID(b);
2657                         fprintf(F, "\"  label: \"");
2658                         dump_node_opcode(F, b);
2659                         fprintf(F, " %ld:%u", get_irn_node_nr(b), get_irn_idx(b));
2660                         fprintf(F, "\" status:clustered color:yellow\n");
2661
2662                         /* dump the blocks edges */
2663                         dump_ir_data_edges(F, b);
2664
2665                         /* dump the nodes that go into the block */
2666                         for (n = (ir_node*)get_irn_link(b); n; n = (ir_node*)get_irn_link(n)) {
2667                                 if (eset_contains(extnodes, n))
2668                                         overrule_nodecolor = ird_color_block_inout;
2669                                 dump_node(F, n);
2670                                 overrule_nodecolor = ird_color_default_node;
2671                                 if (!eset_contains(extnodes, n)) dump_ir_data_edges(F, n);
2672                         }
2673
2674                         /* Close the vcg information for the block */
2675                         fprintf(F, "}\n");
2676                         dump_const_node_local(F, b);
2677                         fprintf(F, "\n");
2678                 }
2679         }
2680         eset_foreach(extnodes, ir_node*, b) {
2681                 if (is_Block(b)) {
2682                         fprintf(F, "graph: { title: \"");
2683                         PRINT_NODEID(b);
2684                         fprintf(F, "\"  label: \"");
2685                         dump_node_opcode(F, b);
2686                         fprintf(F, " %ld:%u", get_irn_node_nr(b), get_irn_idx(b));
2687                         fprintf(F, "\" status:clustered color:lightblue\n");
2688
2689                         /* dump the nodes that go into the block */
2690                         for (n = (ir_node*)get_irn_link(b); n; n = (ir_node*)get_irn_link(n)) {
2691                                 if (!eset_contains(loopnodes, n))
2692                                         overrule_nodecolor = ird_color_block_inout;
2693                                 dump_node(F, n);
2694                                 overrule_nodecolor = ird_color_default_node;
2695                                 if (eset_contains(loopnodes, n)) dump_ir_data_edges(F, n);
2696                         }
2697
2698                         /* Close the vcg information for the block */
2699                         fprintf(F, "}\n");
2700                         dump_const_node_local(F, b);
2701                         fprintf(F, "\n");
2702                 }
2703         }
2704         eset_destroy(loopnodes);
2705         eset_destroy(extnodes);
2706
2707         dump_vcg_footer(F);
2708 }
2709
2710 static bool   obstack_init;
2711 static struct obstack obst;
2712 static char  *dump_path;
2713
2714 void ir_set_dump_path(const char *path)
2715 {
2716         xfree(dump_path);
2717         dump_path = xstrdup(path);
2718 }
2719
2720 static void add_string_escaped(const char *string)
2721 {
2722         const char *p;
2723         for (p = string; *p != '\0'; ++p) {
2724                 char c = *p;
2725                 if (c == '/') {
2726                         obstack_1grow(&obst, '@');
2727                         obstack_1grow(&obst, '1');
2728                 } else if (c == '@') {
2729                         obstack_1grow(&obst, '@');
2730                         obstack_1grow(&obst, '2');
2731                 } else {
2732                         obstack_1grow(&obst, c);
2733                 }
2734         }
2735 }
2736
2737 static void add_dump_path(void)
2738 {
2739         if (!obstack_init) {
2740                 obstack_init(&obst);
2741                 obstack_init = true;
2742         }
2743
2744         if (dump_path != NULL) {
2745                 size_t len = strlen(dump_path);
2746                 obstack_grow(&obst, dump_path, len);
2747                 if (len > 0 && dump_path[len-1] != '/')
2748                         obstack_1grow(&obst, '/');
2749         }
2750 }
2751
2752 void dump_ir_graph_ext(ir_graph_dump_func func, ir_graph *graph,
2753                        const char *suffix)
2754 {
2755         const char *dump_name = get_irg_dump_name(graph);
2756         char       *file_name;
2757         FILE       *out;
2758
2759         if (!ir_should_dump(dump_name))
2760                 return;
2761
2762         add_dump_path();
2763
2764         add_string_escaped(dump_name);
2765         obstack_printf(&obst, "-%02u", graph->dump_nr++);
2766
2767         if (suffix != NULL) {
2768                 if (suffix[0] != '.')
2769                         obstack_1grow(&obst, '-');
2770                 add_string_escaped(suffix);
2771         }
2772         obstack_1grow(&obst, '\0');
2773
2774         file_name = (char*)obstack_finish(&obst);
2775         /* xvcg expects only <CR> so we need "b"inary mode (for win32) */
2776         out       = fopen(file_name, "wb");
2777         obstack_free(&obst, file_name);
2778
2779         if (out == NULL) {
2780                 fprintf(stderr, "Couldn't open '%s': %s\n", file_name, strerror(errno));
2781                 return;
2782         }
2783
2784         func(out, graph);
2785         fclose(out);
2786 }
2787
2788 void dump_ir_prog_ext(ir_prog_dump_func func, const char *suffix)
2789 {
2790         char *file_name;
2791         FILE *out;
2792
2793         add_dump_path();
2794
2795         obstack_printf(&obst, "%02u", irp->dump_nr++);
2796         if (suffix != NULL) {
2797                 if (suffix[0] != '.')
2798                         obstack_1grow(&obst, '-');
2799                 add_string_escaped(suffix);
2800         }
2801         obstack_1grow(&obst, '\0');
2802
2803         file_name = (char*)obstack_finish(&obst);
2804         out       = fopen(file_name, "wb");
2805         obstack_free(&obst, file_name);
2806
2807         if (out == NULL) {
2808                 fprintf(stderr, "Couldn't open '%s': %s\n", file_name, strerror(errno));
2809                 return;
2810         }
2811         func(out);
2812         fclose(out);
2813 }
2814
2815 void dump_ir_graph(ir_graph *graph, const char *suffix)
2816 {
2817         char buf[256];
2818
2819         snprintf(buf, sizeof(buf), "%s.vcg", suffix);
2820         dump_ir_graph_ext(dump_ir_graph_file, graph, buf);
2821 }
2822
2823 void dump_all_ir_graphs(const char *suffix)
2824 {
2825         size_t i, n_irgs = get_irp_n_irgs();
2826
2827         for (i = 0; i < n_irgs; ++i) {
2828                 ir_graph *irg = get_irp_irg(i);
2829                 dump_ir_graph(irg, suffix);
2830         }
2831 }
2832
2833 typedef struct pass_t {
2834         ir_prog_pass_t pass;
2835         char           suffix[1];
2836 } pass_t;
2837
2838 /**
2839  * Wrapper around dump_all_ir_graphs().
2840  */
2841 static int dump_all_ir_graphs_wrapper(ir_prog *irp, void *context)
2842 {
2843         pass_t *pass = (pass_t*)context;
2844
2845         (void)irp;
2846         dump_all_ir_graphs(pass->suffix);
2847         return 0;
2848 }
2849
2850 ir_prog_pass_t *dump_all_ir_graph_pass(const char *name, const char *suffix)
2851 {
2852         size_t  len  = strlen(suffix) + 1;
2853         pass_t *pass = XMALLOCF(pass_t, suffix, len);
2854         ir_prog_pass_t *res  = def_prog_pass_constructor(
2855                 &pass->pass, name ? name : "dump_all_graphs", dump_all_ir_graphs_wrapper);
2856
2857         /* this pass does not change anything, so neither dump nor verify is needed. */
2858         res->dump_irprog   = ir_prog_no_dump;
2859         res->verify_irprog = ir_prog_no_verify;
2860
2861         memcpy(pass->suffix, suffix, len);
2862
2863         return res;
2864 }