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