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