nsz Git - libfirm/blob - ir/ir/irdump.c

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