nsz Git - libfirm/blob - ir/ir/iredges.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   Always available outs.
  23  * @author  Sebastian Hack, Michael Beck, Andreas Schoesser
  24  * @date    14.1.2005
  25  * @brief
  26  *   This are out-edges (also called def-use edges) that are dynamically
  27  *   updated as the graph changes.
  28  */
  29 #include "config.h"
  30
  31 #include "irnode_t.h"
  32 #include "iropt_t.h"
  33 #include "iredgekinds.h"
  34 #include "iredges_t.h"
  35 #include "irgwalk.h"
  36 #include "irdump_t.h"
  37 #include "irprintf.h"
  38 #include "debug.h"
  39 #include "set.h"
  40 #include "bitset.h"
  41 #include "error.h"
  42 #include "irpass_t.h"
  43
  44 #include "iredgeset.h"
  45 #include "hashptr.h"
  46
  47 #define DO_REHASH
  48 #define SCALAR_RETURN
  49 #define HashSet                   ir_edgeset_t
  50 #define HashSetIterator           ir_edgeset_iterator_t
  51 #define ValueType                 ir_edge_t*
  52 #define NullValue                 NULL
  53 #define DeletedValue              ((ir_edge_t*)-1)
  54 #define Hash(this,key)            (hash_ptr(key->src) ^ (key->pos * 40013))
  55 #define KeysEqual(this,key1,key2) ((key1->src) == (key2->src) && (key1->pos == key2->pos))
  56 #define SetRangeEmpty(ptr,size)   memset(ptr, 0, (size) * sizeof((ptr)[0]))
  57
  58 #define hashset_init            ir_edgeset_init
  59 void ir_edgeset_init_size(ir_edgeset_t *self, size_t size);
  60 #define hashset_init_size       ir_edgeset_init_size
  61 #define hashset_destroy         ir_edgeset_destroy
  62 #define hashset_insert          ir_edgeset_insert
  63 #define hashset_remove          ir_edgeset_remove
  64 ir_edge_t *ir_edgeset_find(const ir_edgeset_t *self, const ir_edge_t*);
  65 #define hashset_find            ir_edgeset_find
  66 size_t ir_edgeset_size(const ir_edgeset_t *self);
  67 #define hashset_size            ir_edgeset_size
  68 #define hashset_iterator_init   ir_edgeset_iterator_init
  69 #define hashset_iterator_next   ir_edgeset_iterator_next
  70 #define hashset_remove_iterator ir_edgeset_remove_iterator
  71
  72 #include "hashset.c.inl"
  73
  74 /**
  75  * A function that allows for setting an edge.
  76  * This abstraction is necessary since different edge kind have
  77  * different methods of setting edges.
  78  */
  79 typedef void (set_edge_func_t)(ir_node *src, int pos, ir_node *tgt);
  80
  81 /**
  82  * A function that returns the "arity" of a given edge kind
  83  * for a node.
  84  */
  85 typedef int (get_edge_src_arity_func_t)(const ir_node *src);
  86
  87 /**
  88  * A function that returns the pos'th edge of a given edge kind for a node.
  89  */
  90 typedef ir_node *(get_edge_src_n_func_t)(const ir_node *src, int pos);
  91
  92 /**
  93  * Additional data for an edge kind.
  94  */
  95 typedef struct {
  96         const char                *name;       /**< name of this edge kind */
  97         set_edge_func_t           *set_edge;   /**< the set_edge function */
  98         int                       first_idx;   /**< index of the first possible edge */
  99         get_edge_src_arity_func_t *get_arity;  /**< the get_arity function */
 100         get_edge_src_n_func_t     *get_n;      /**< the get_n function */
 101 } ir_edge_kind_info_t;
 102
 103 /**
 104  * Get the predecessor block.
 105  */
 106 static ir_node *get_block_n(const ir_node *block, int pos)
 107 {
 108         if (is_Block(block))
 109                 return get_Block_cfgpred_block(block, pos);
 110         /* might be a Bad */
 111         return NULL;
 112 }
 113
 114 static ir_node *get_irn_safe_n(const ir_node *node, int n)
 115 {
 116         if (n == -1 && is_Block(node))
 117                 return NULL;
 118         return get_irn_n(node, n);
 119 }
 120
 121 static const ir_edge_kind_info_t edge_kind_info[EDGE_KIND_LAST] = {
 122         { "normal"     , set_irn_n,   -1, get_irn_arity,  get_irn_safe_n },
 123         { "block succs", NULL,         0, get_irn_arity,  get_block_n    },
 124         { "dependency",  set_irn_dep,  0, get_irn_deps,   get_irn_dep    }
 125 };
 126
 127 #define foreach_tgt(irn, i, n, kind) for (i = edge_kind_info[kind].first_idx, n = edge_kind_info[kind].get_arity(irn); i < n; ++i)
 128 #define get_n(irn, pos, kind)        (edge_kind_info[kind].get_n(irn, pos))
 129 #define get_kind_str(kind)           (edge_kind_info[kind].name)
 130
 131 DEBUG_ONLY(static firm_dbg_module_t *dbg;)
 132
 133 /**
 134  * This flag is set to 1, if the edges get initialized for an irg.
 135  * Then register additional data is forbidden.
 136  */
 137 static int edges_used = 0;
 138
 139 /**
 140  * Summed size of all users private data
 141  */
 142
 143 static size_t edges_private_size = 0;
 144 #define EDGE_SIZE (sizeof(ir_edge_t) + edges_private_size)
 145
 146 /**
 147  * If set to 1, the list heads are checked every time an edge is changed.
 148  */
 149 static int edges_dbg = 0;
 150
 151 /**
 152  * Returns an ID for the given edge.
 153  */
 154 static inline long edge_get_id(const ir_edge_t *e)
 155 {
 156         return (long)e;
 157 }
 158
 159 size_t edges_register_private_data(size_t n)
 160 {
 161         size_t res = edges_private_size;
 162
 163         assert(!edges_used && "you cannot register private edge data, if edges have been initialized");
 164
 165         edges_private_size += n;
 166         return res;
 167 }
 168
 169 void edges_reset_private_data(ir_graph *irg, int offset, unsigned size)
 170 {
 171         irg_edge_info_t       *info = get_irg_edge_info(irg, EDGE_KIND_NORMAL);
 172         ir_edge_t             *edge;
 173         ir_edgeset_iterator_t  iter;
 174
 175         foreach_ir_edgeset(&info->edges, edge, iter) {
 176                 memset(edge + sizeof(*edge) + offset, 0, size);
 177         }
 178 }
 179
 180 void edges_init_graph_kind(ir_graph *irg, ir_edge_kind_t kind)
 181 {
 182         if (edges_activated_kind(irg, kind)) {
 183                 irg_edge_info_t *info = get_irg_edge_info(irg, kind);
 184                 size_t amount = irg->estimated_node_count * 2;
 185
 186                 edges_used = 1;
 187                 if (info->allocated) {
 188                         amount = ir_edgeset_size(&info->edges);
 189                         ir_edgeset_destroy(&info->edges);
 190                         obstack_free(&info->edges_obst, NULL);
 191                 }
 192                 obstack_init(&info->edges_obst);
 193                 INIT_LIST_HEAD(&info->free_edges);
 194                 ir_edgeset_init_size(&info->edges, amount);
 195                 info->allocated = 1;
 196         }
 197 }
 198
 199 const ir_edge_t *get_irn_edge_kind(const ir_node *src, int pos, ir_edge_kind_t kind)
 200 {
 201         ir_graph *irg = get_irn_irg(src);
 202         if (edges_activated_kind(irg, kind)) {
 203                 irg_edge_info_t *info = get_irg_edge_info(irg, kind);
 204                 ir_edge_t       key;
 205
 206                 key.src = (ir_node *)src;
 207                 key.pos = pos;
 208
 209                 return ir_edgeset_find(&info->edges, &key);
 210         }
 211
 212         return NULL;
 213 }
 214
 215 /**
 216  * Change the out count
 217  *
 218  * @param tgt  the edge target
 219  * @param kind the kind of the edge
 220  */
 221 static inline void edge_change_cnt(ir_node *tgt, ir_edge_kind_t kind, int ofs)
 222 {
 223         irn_edge_info_t *info = get_irn_edge_info(tgt, kind);
 224         info->out_count += ofs;
 225 }
 226
 227 /**
 228  * Verify the edge list of a node, ie. ensure it's a loop:
 229  * head -> e_1 -> ... -> e_n -> head
 230  */
 231 static inline void verify_list_head(ir_node *irn, ir_edge_kind_t kind)
 232 {
 233         int                    err     = 0;
 234         int                    num     = 0;
 235         pset                   *lh_set = pset_new_ptr(16);
 236         const struct list_head *head   = &get_irn_edge_info(irn, kind)->outs_head;
 237         const struct list_head *pos;
 238
 239         list_for_each(pos, head) {
 240                 if (pset_find_ptr(lh_set, pos)) {
 241                         const ir_edge_t *edge = list_entry(pos, ir_edge_t, list);
 242
 243                         ir_fprintf(stderr, "EDGE Verifier: edge list broken (self loop not to head) for %+F:\n", irn);
 244                         fprintf(stderr, "- at list entry %d\n", num);
 245                         if (edge->invalid)
 246                                 fprintf(stderr, "- edge(%ld) is invalid\n", edge_get_id(edge));
 247                         if (edge->src)
 248                                 ir_fprintf(stderr, "- edge(%ld) %+F(%d)\n", edge_get_id(edge), edge->src, edge->pos);
 249                         err = 1;
 250                         break;
 251                 }
 252                 num++;
 253                 pset_insert_ptr(lh_set, pos);
 254         }
 255
 256         del_pset(lh_set);
 257
 258         assert(err == 0);
 259 }
 260
 261 void edges_dump_kind(ir_graph *irg, ir_edge_kind_t kind)
 262 {
 263         irg_edge_info_t *info;
 264         ir_edgeset_t    *edges;
 265         ir_edgeset_iterator_t iter;
 266         ir_edge_t      *e;
 267
 268         if (!edges_activated_kind(irg, kind))
 269                 return;
 270
 271         info  = get_irg_edge_info(irg, kind);
 272         edges = &info->edges;
 273         foreach_ir_edgeset(edges, e, iter) {
 274                 ir_printf("%+F %d %d\n", e->src, e->pos, e->invalid);
 275         }
 276 }
 277
 278 void edges_notify_edge_kind(ir_node *src, int pos, ir_node *tgt,
 279                             ir_node *old_tgt, ir_edge_kind_t kind,
 280                             ir_graph *irg)
 281 {
 282         const char      *msg = "";
 283         irg_edge_info_t *info;
 284         ir_edgeset_t    *edges;
 285         ir_edge_t        templ;
 286
 287         assert(edges_activated_kind(irg, kind));
 288
 289         /*
 290          * Only do something, if the old and new target differ.
 291          */
 292         if (tgt == old_tgt)
 293                 return;
 294
 295         info  = get_irg_edge_info(irg, kind);
 296         edges = &info->edges;
 297
 298         /* Initialize the edge template to search in the set. */
 299         templ.src = src;
 300         templ.pos = pos;
 301
 302         /*
 303          * If the target is NULL, the edge shall be deleted.
 304          */
 305         if (tgt == NULL) {
 306                 /* search the edge in the set. */
 307                 ir_edge_t *edge = ir_edgeset_find(edges, &templ);
 308
 309                 /* mark the edge invalid if it was found */
 310                 if (edge) {
 311                         msg = "deleting";
 312                         list_del(&edge->list);
 313                         ir_edgeset_remove(edges, edge);
 314                         list_add(&edge->list, &info->free_edges);
 315                         edge->invalid = 1;
 316                         edge->pos = -2;
 317                         edge->src = NULL;
 318                         edge_change_cnt(old_tgt, kind, -1);
 319                 } else {
 320                         /* If the edge was not found issue a warning on the debug stream */
 321                         msg = "edge to delete not found!\n";
 322                 }
 323         } else {
 324                 /*
 325                  * The target is not NULL and the old target differs
 326                  * from the new target, the edge shall be moved (if the
 327                  * old target was != NULL) or added (if the old target was
 328                  * NULL).
 329                  */
 330                 struct list_head *head = &get_irn_edge_info(tgt, kind)->outs_head;
 331
 332                 assert(head->next && head->prev &&
 333                                 "target list head must have been initialized");
 334
 335                 /* If the old target is not null, the edge is moved. */
 336                 if (old_tgt) {
 337                         ir_edge_t *edge = ir_edgeset_find(edges, &templ);
 338                         assert(edge && "edge to redirect not found!");
 339                         assert(! edge->invalid && "Invalid edge encountered");
 340
 341                         msg = "redirecting";
 342
 343                         list_move(&edge->list, head);
 344                         edge_change_cnt(old_tgt, kind, -1);
 345                 } else {
 346                         /* The old target was NULL, thus, the edge is newly created. */
 347                         ir_edge_t *new_edge;
 348                         ir_edge_t *edge;
 349
 350                         if (list_empty(&info->free_edges)) {
 351                                 edge = (ir_edge_t*)obstack_alloc(&info->edges_obst, EDGE_SIZE);
 352                         } else {
 353                                 edge = list_entry(info->free_edges.next, ir_edge_t, list);
 354                                 list_del(&edge->list);
 355                         }
 356
 357                         edge->src       = src;
 358                         edge->pos       = pos;
 359                         edge->invalid   = 0;
 360                         edge->present   = 0;
 361                         edge->kind      = kind;
 362                         edge->list.next = NULL;
 363                         edge->list.prev = NULL;
 364                         memset(edge + 1, 0, edges_private_size);
 365
 366                         new_edge = ir_edgeset_insert(edges, edge);
 367                         if (new_edge != edge) {
 368                                 panic("new edge exists already");
 369                         }
 370
 371                         msg = "adding";
 372                         list_add(&edge->list, head);
 373                 }
 374
 375                 edge_change_cnt(tgt, kind, +1);
 376         }
 377
 378 #ifndef DEBUG_libfirm
 379         /* verify list heads */
 380         if (edges_dbg) {
 381                 if (tgt)
 382                         verify_list_head(tgt, kind);
 383                 if (old_tgt)
 384                         verify_list_head(old_tgt, kind);
 385         }
 386 #endif
 387
 388         DBG((dbg, LEVEL_5, "announce out edge: %+F %d-> %+F(%+F): %s\n", src, pos, tgt, old_tgt, msg));
 389 }
 390
 391 void edges_notify_edge(ir_node *src, int pos, ir_node *tgt, ir_node *old_tgt,
 392                        ir_graph *irg)
 393 {
 394         if (edges_activated_kind(irg, EDGE_KIND_NORMAL)) {
 395                 edges_notify_edge_kind(src, pos, tgt, old_tgt, EDGE_KIND_NORMAL, irg);
 396         }
 397
 398         if (edges_activated_kind(irg, EDGE_KIND_BLOCK)) {
 399                 if (is_Block(src)) {
 400                         ir_node *bl_old = old_tgt ? get_nodes_block(old_tgt) : NULL;
 401                         ir_node *bl_tgt = NULL;
 402
 403                         if (tgt)
 404                                 bl_tgt = is_Bad(tgt) ? tgt : get_nodes_block(tgt);
 405
 406                         edges_notify_edge_kind(src, pos, bl_tgt, bl_old, EDGE_KIND_BLOCK, irg);
 407                 } else if (get_irn_mode(src) == mode_X && old_tgt != NULL && is_Block(old_tgt)) {
 408                         /* moving a jump node from one block to another */
 409                         foreach_out_edge_kind_safe(old_tgt, edge, EDGE_KIND_BLOCK) {
 410                                 ir_node *succ       = get_edge_src_irn(edge);
 411                                 int      succ_pos   = get_edge_src_pos(edge);
 412                                 ir_node *block_pred = get_Block_cfgpred(succ, succ_pos);
 413                                 if (block_pred != src)
 414                                         continue;
 415                                 edges_notify_edge_kind(succ, succ_pos, tgt, old_tgt,
 416                                                        EDGE_KIND_BLOCK, irg);
 417                         }
 418                 }
 419         }
 420 }
 421
 422 /**
 423  * Delete all in edges of a given kind from the node old.
 424  *
 425  * @param old   the node
 426  * @param kind  the kind of edges to remove
 427  * @param irg   the irg of the old node
 428  */
 429 static void edges_node_deleted_kind(ir_node *old, ir_edge_kind_t kind)
 430 {
 431         int i, n;
 432         ir_graph *irg = get_irn_irg(old);
 433
 434         if (!edges_activated_kind(irg, kind))
 435                 return;
 436
 437         DBG((dbg, LEVEL_5, "node deleted (kind: %s): %+F\n", get_kind_str(kind), old));
 438
 439         foreach_tgt(old, i, n, kind) {
 440                 ir_node *old_tgt = get_n(old, i, kind);
 441                 edges_notify_edge_kind(old, i, NULL, old_tgt, kind, irg);
 442         }
 443 }
 444
 445 /**
 446  * A node might be revivaled by CSE. Assure its edges.
 447  *
 448  * @param irn   the node
 449  * @param kind  the kind of edges to remove
 450  * @param irg   the irg of the old node
 451  */
 452 static void edges_node_revival_kind(ir_node *irn, ir_edge_kind_t kind)
 453 {
 454         irn_edge_info_t *info;
 455         int             i, n;
 456         ir_graph        *irg = get_irn_irg(irn);
 457
 458         if (!edges_activated_kind(irg, kind))
 459                 return;
 460
 461         info = get_irn_edge_info(irn, kind);
 462         if (info->edges_built)
 463                 return;
 464
 465         DBG((dbg, LEVEL_5, "node revivaled (kind: %s): %+F\n", get_kind_str(kind), irn));
 466
 467         foreach_tgt(irn, i, n, kind) {
 468                 ir_node *tgt = get_n(irn, i, kind);
 469                 edges_notify_edge_kind(irn, i, tgt, NULL, kind, irg);
 470         }
 471         info->edges_built = 1;
 472 }
 473
 474 typedef struct build_walker {
 475         ir_edge_kind_t kind;
 476         bitset_t       *reachable;
 477         unsigned       problem_found;
 478 } build_walker;
 479
 480 /**
 481  * Post-Walker: notify all edges
 482  */
 483 static void build_edges_walker(ir_node *irn, void *data)
 484 {
 485         build_walker          *w = (build_walker*)data;
 486         int                   i, n;
 487         ir_edge_kind_t        kind = w->kind;
 488         ir_graph              *irg = get_irn_irg(irn);
 489
 490         foreach_tgt(irn, i, n, kind) {
 491                 ir_node *pred = get_n(irn, i, kind);
 492                 edges_notify_edge_kind(irn, i, pred, NULL, kind, irg);
 493         }
 494         get_irn_edge_info(irn, kind)->edges_built = 1;
 495 }
 496
 497 /**
 498  * Pre-Walker: initializes the list-heads and set the out-count
 499  * of all nodes to 0.
 500  */
 501 static void init_lh_walker(ir_node *irn, void *data)
 502 {
 503         build_walker   *w    = (build_walker*)data;
 504         ir_edge_kind_t  kind = w->kind;
 505         list_head      *head = &get_irn_edge_info(irn, kind)->outs_head;
 506         INIT_LIST_HEAD(head);
 507         get_irn_edge_info(irn, kind)->edges_built = 0;
 508         get_irn_edge_info(irn, kind)->out_count   = 0;
 509 }
 510
 511 /**
 512  * Pre-Walker: initializes the list-heads and set the out-count
 513  * of all nodes to 0.
 514  *
 515  * Additionally touches DEP nodes, as they might be DEAD.
 516  * THIS IS UGLY, but I don't find a better way until we
 517  *
 518  * a) ensure that dead nodes are not used as input
 519  * b) it might be sufficient to add those stupid NO_REG nodes
 520  * to the anchor
 521  */
 522 static void init_lh_walker_dep(ir_node *irn, void *data)
 523 {
 524         build_walker   *w    = (build_walker*)data;
 525         ir_edge_kind_t  kind = w->kind;
 526         list_head      *head = &get_irn_edge_info(irn, kind)->outs_head;
 527         int             i;
 528
 529         INIT_LIST_HEAD(head);
 530         get_irn_edge_info(irn, kind)->edges_built = 0;
 531         get_irn_edge_info(irn, kind)->out_count   = 0;
 532
 533         for (i = get_irn_deps(irn) - 1; i >= 0; --i) {
 534                 ir_node *dep = get_irn_dep(irn, i);
 535
 536                 head = &get_irn_edge_info(dep, kind)->outs_head;
 537
 538                 INIT_LIST_HEAD(head);
 539                 get_irn_edge_info(dep, kind)->edges_built = 0;
 540                 get_irn_edge_info(dep, kind)->out_count   = 0;
 541         }
 542 }
 543
 544 typedef struct visitor_info_t {
 545         irg_walk_func *visit;
 546         void *data;
 547 } visitor_info_t;
 548
 549 /**
 550  * Visitor: initializes the list-heads and set the out-count
 551  * of all nodes to 0 of nodes that are not seen so far.
 552  */
 553 static void visitor(ir_node *irn, void *data)
 554 {
 555         visitor_info_t *info = (visitor_info_t*)data;
 556
 557         if (is_Deleted(irn))
 558                 return;
 559         if (!is_Block(irn) && is_Deleted(get_nodes_block(irn)))
 560                 return;
 561
 562         if (!irn_visited_else_mark(irn)) {
 563                 info->visit(irn, info->data);
 564         }
 565 }
 566
 567 void edges_activate_kind(ir_graph *irg, ir_edge_kind_t kind)
 568 {
 569         /*
 570          * Build the initial edge set.
 571          * Beware, this is not a simple task because it suffers from two
 572          * difficulties:
 573          * - the anchor set allows access to Nodes that may not be reachable from
 574          *   the End node
 575          * - the identities add nodes to the "root set" that are not yet reachable
 576          *   from End. However, after some transformations, the CSE may revival these
 577          *   nodes
 578          *
 579          * These problems can be fixed using different strategies:
 580          * - Add an age flag to every node. Whenever the edge of a node is older
 581          *   then the current edge, invalidate the edges of this node.
 582          *   While this would help for revivaled nodes, it increases memory and runtime.
 583          * - Delete the identities set.
 584          *   Solves the revival problem, but may increase the memory consumption, as
 585          *   nodes cannot be revivaled at all.
 586          * - Manually iterate over the identities root set. This did not consume more memory
 587          *   but increase the computation time because the |identities| >= |V|
 588          *
 589          * Currently, we use the last option.
 590          */
 591         struct build_walker w;
 592         irg_edge_info_t     *info = get_irg_edge_info(irg, kind);
 593         visitor_info_t      visit;
 594
 595         w.kind = kind;
 596
 597         visit.data = &w;
 598
 599         assert(!info->activated);
 600
 601         info->activated = 1;
 602         edges_init_graph_kind(irg, kind);
 603         if (kind == EDGE_KIND_DEP) {
 604                 irg_walk_anchors(irg, init_lh_walker_dep, NULL, &w);
 605                 /* Argh: Dep nodes might be dead, so we MUST visit identities first */
 606                 visit.visit = init_lh_walker_dep;
 607                 visit_all_identities(irg, visitor, &visit);
 608                 irg_walk_anchors(irg, NULL, build_edges_walker, &w);
 609         } else {
 610                 visit.visit = init_lh_walker;
 611                 visit_all_identities(irg, visitor, &visit);
 612                 irg_walk_anchors(irg, init_lh_walker, build_edges_walker, &w);
 613         }
 614 }
 615
 616 void edges_deactivate_kind(ir_graph *irg, ir_edge_kind_t kind)
 617 {
 618         irg_edge_info_t *info = get_irg_edge_info(irg, kind);
 619
 620         info->activated = 0;
 621         if (info->allocated) {
 622                 obstack_free(&info->edges_obst, NULL);
 623                 ir_edgeset_destroy(&info->edges);
 624                 info->allocated = 0;
 625         }
 626         clear_irg_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_OUT_EDGES);
 627 }
 628
 629 int (edges_activated_kind)(const ir_graph *irg, ir_edge_kind_t kind)
 630 {
 631         return edges_activated_kind_(irg, kind);
 632 }
 633
 634 void edges_reroute_kind(ir_node *from, ir_node *to, ir_edge_kind_t kind)
 635 {
 636         ir_graph *irg = get_irn_irg(from);
 637         set_edge_func_t *set_edge = edge_kind_info[kind].set_edge;
 638
 639         if (set_edge && edges_activated_kind(irg, kind)) {
 640                 struct list_head *head = &get_irn_edge_info(from, kind)->outs_head;
 641
 642                 DBG((dbg, LEVEL_5, "reroute from %+F to %+F\n", from, to));
 643
 644                 while (head != head->next) {
 645                         ir_edge_t *edge = list_entry(head->next, ir_edge_t, list);
 646                         assert(edge->pos >= -1);
 647                         set_edge(edge->src, edge->pos, to);
 648                 }
 649         }
 650 }
 651
 652 void edges_reroute_except(ir_node *from, ir_node *to, ir_node *exception)
 653 {
 654         foreach_out_edge_safe(from, edge) {
 655                 ir_node *src = get_edge_src_irn(edge);
 656                 if (src == exception)
 657                         continue;
 658                 set_irn_n(src, edge->pos, to);
 659         }
 660 }
 661
 662 static void verify_set_presence(ir_node *irn, void *data)
 663 {
 664         build_walker *w     = (build_walker*)data;
 665         ir_graph     *irg   = get_irn_irg(irn);
 666         ir_edgeset_t *edges = &get_irg_edge_info(irg, w->kind)->edges;
 667         int i, n;
 668
 669         foreach_tgt(irn, i, n, w->kind) {
 670                 ir_edge_t templ, *e;
 671
 672                 templ.src = irn;
 673                 templ.pos = i;
 674
 675                 e = ir_edgeset_find(edges, &templ);
 676                 if (e != NULL) {
 677                         e->present = 1;
 678                 } else {
 679                         w->problem_found = 1;
 680                 }
 681         }
 682 }
 683
 684 static void verify_list_presence(ir_node *irn, void *data)
 685 {
 686         build_walker *w = (build_walker*)data;
 687
 688         bitset_set(w->reachable, get_irn_idx(irn));
 689
 690         /* check list heads */
 691         verify_list_head(irn, w->kind);
 692
 693         foreach_out_edge_kind(irn, e, w->kind) {
 694                 ir_node *tgt;
 695
 696                 if (w->kind == EDGE_KIND_NORMAL && get_irn_arity(e->src) <= e->pos) {
 697                         w->problem_found = 1;
 698                         continue;
 699                 }
 700
 701                 tgt = get_n(e->src, e->pos, w->kind);
 702
 703                 if (irn != tgt) {
 704                         w->problem_found = 1;
 705                 }
 706         }
 707 }
 708
 709 int edges_verify_kind(ir_graph *irg, ir_edge_kind_t kind)
 710 {
 711         struct build_walker w;
 712         ir_edgeset_t        *edges = &get_irg_edge_info(irg, kind)->edges;
 713         ir_edge_t           *e;
 714         ir_edgeset_iterator_t  iter;
 715
 716         w.kind          = kind;
 717         w.reachable     = bitset_alloca(get_irg_last_idx(irg));
 718         w.problem_found = 0;
 719
 720         /* Clear the present bit in all edges available. */
 721         foreach_ir_edgeset(edges, e, iter) {
 722                 e->present = 0;
 723         }
 724
 725         irg_walk_graph(irg, verify_set_presence, verify_list_presence, &w);
 726
 727         /*
 728          * Dump all edges which are not invalid and not present.
 729          * These edges are superfluous and their presence in the
 730          * edge set is wrong.
 731          */
 732         foreach_ir_edgeset(edges, e, iter) {
 733                 if (! e->invalid && ! e->present && bitset_is_set(w.reachable, get_irn_idx(e->src))) {
 734                         w.problem_found = 1;
 735                         ir_fprintf(stderr, "Edge Verifier: edge(%ld) %+F,%d is superfluous\n", edge_get_id(e), e->src, e->pos);
 736                 }
 737         }
 738
 739         return w.problem_found;
 740 }
 741
 742 #define IGNORE_NODE(irn) (is_Bad((irn)) || is_Block((irn)))
 743
 744 /**
 745  * Clear link field of all nodes.
 746  */
 747 static void clear_links(ir_node *irn, void *env)
 748 {
 749         bitset_t     *bs;
 750         ir_graph     *irg;
 751         (void) env;
 752
 753         if (IGNORE_NODE(irn)) {
 754                 set_irn_link(irn, NULL);
 755                 return;
 756         }
 757
 758         irg = get_irn_irg(irn);
 759         bs  = bitset_malloc(get_irg_last_idx(irg));
 760         set_irn_link(irn, bs);
 761 }
 762
 763 /**
 764  * Increases count (stored in link field) for all operands of a node.
 765  */
 766 static void count_user(ir_node *irn, void *env)
 767 {
 768         int i;
 769         int first;
 770         (void) env;
 771
 772         first = is_Block(irn) ? 0 : -1;
 773         for (i = get_irn_arity(irn) - 1; i >= first; --i) {
 774                 ir_node  *op = get_irn_n(irn, i);
 775                 bitset_t *bs = (bitset_t*)get_irn_link(op);
 776
 777                 if (bs)
 778                         bitset_set(bs, get_irn_idx(irn));
 779         }
 780 }
 781
 782 /**
 783  * Verifies if collected count, number of edges in list and stored edge count are in sync.
 784  */
 785 static void verify_edge_counter(ir_node *irn, void *env)
 786 {
 787         build_walker *w = (build_walker*)env;
 788         if (IGNORE_NODE(irn))
 789                 return;
 790
 791         bitset_t *bs       = (bitset_t*)get_irn_link(irn);
 792         int       list_cnt = 0;
 793         int       edge_cnt = get_irn_edge_info(irn, EDGE_KIND_NORMAL)->out_count;
 794         const struct list_head *head
 795                 = &get_irn_edge_info(irn, EDGE_KIND_NORMAL)->outs_head;
 796
 797         /* We can iterate safely here, list heads have already been verified. */
 798         const struct list_head *pos;
 799         list_for_each(pos, head) {
 800                 ++list_cnt;
 801         }
 802
 803         /* check all nodes that reference us and count edges that point number
 804          * of ins that actually point to us */
 805         ir_graph *irg     = get_irn_irg(irn);
 806         int       ref_cnt = 0;
 807         bitset_foreach(bs, idx) {
 808                 int i, arity;
 809                 ir_node *src = get_idx_irn(irg, idx);
 810
 811                 arity = get_irn_arity(src);
 812                 for (i = 0; i < arity; ++i) {
 813                         ir_node *in = get_irn_n(src, i);
 814                         if (in == irn)
 815                                 ++ref_cnt;
 816                 }
 817         }
 818
 819         if (edge_cnt != list_cnt) {
 820                 w->problem_found = 1;
 821                 ir_fprintf(stderr, "Edge Verifier: edge count is %d, but %d edge(s) are recorded in list at %+F\n",
 822                         edge_cnt, list_cnt, irn);
 823         }
 824
 825         if (ref_cnt != list_cnt) {
 826                 w->problem_found = 1;
 827                 ir_fprintf(stderr, "Edge Verifier: %+F reachable by %d node(s), but the list contains %d edge(s)\n",
 828                         irn, ref_cnt, list_cnt);
 829         }
 830
 831         bitset_free(bs);
 832 }
 833
 834 int edges_verify(ir_graph *irg)
 835 {
 836         struct build_walker w;
 837         int    problem_found = 0;
 838
 839         /* verify normal edges only */
 840         problem_found  = edges_verify_kind(irg, EDGE_KIND_NORMAL);
 841
 842         w.kind          = EDGE_KIND_NORMAL;
 843         w.problem_found = 0;
 844
 845         /* verify counter */
 846         irg_walk_anchors(irg, clear_links, count_user, &w);
 847         irg_walk_anchors(irg, NULL, verify_edge_counter, &w);
 848
 849         return problem_found ? 1 : w.problem_found;
 850 }
 851
 852 typedef struct pass_t {
 853         ir_graph_pass_t pass;
 854         unsigned        assert_on_problem;
 855 } pass_t;
 856
 857 /**
 858  * Wrapper to edges_verify to be run as an ir_graph pass.
 859  */
 860 static int edges_verify_wrapper(ir_graph *irg, void *context)
 861 {
 862         pass_t *pass           = (pass_t*)context;
 863         int     problems_found = edges_verify(irg);
 864         /* do NOT rerun the pass if verify is ok :-) */
 865         assert(problems_found && pass->assert_on_problem);
 866         return 0;
 867 }
 868
 869 ir_graph_pass_t *irg_verify_edges_pass(const char *name, unsigned assert_on_problem)
 870 {
 871         pass_t *pass = XMALLOCZ(pass_t);
 872
 873         def_graph_pass_constructor(
 874                 &pass->pass, name ? name : "edges_verify", edges_verify_wrapper);
 875
 876         /* neither dump nor verify */
 877         pass->pass.dump_irg   = (DUMP_ON_IRG_FUNC)ir_prog_no_dump;
 878         pass->pass.verify_irg = (RUN_ON_IRG_FUNC)ir_prog_no_verify;
 879
 880         pass->assert_on_problem = assert_on_problem;
 881         return &pass->pass;
 882 }
 883
 884 void init_edges(void)
 885 {
 886         FIRM_DBG_REGISTER(dbg, DBG_EDGES);
 887 }
 888
 889 void edges_init_dbg(int do_dbg)
 890 {
 891         edges_dbg = do_dbg;
 892 }
 893
 894 void edges_activate(ir_graph *irg)
 895 {
 896         edges_activate_kind(irg, EDGE_KIND_NORMAL);
 897         edges_activate_kind(irg, EDGE_KIND_BLOCK);
 898         edges_activate_kind(irg, EDGE_KIND_DEP);
 899 }
 900
 901 void edges_deactivate(ir_graph *irg)
 902 {
 903         edges_deactivate_kind(irg, EDGE_KIND_DEP);
 904         edges_deactivate_kind(irg, EDGE_KIND_BLOCK);
 905         edges_deactivate_kind(irg, EDGE_KIND_NORMAL);
 906 }
 907
 908 void assure_edges(ir_graph *irg)
 909 {
 910         assure_edges_kind(irg, EDGE_KIND_BLOCK);
 911         assure_edges_kind(irg, EDGE_KIND_NORMAL);
 912         assure_edges_kind(irg, EDGE_KIND_DEP);
 913         add_irg_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_OUT_EDGES);
 914 }
 915
 916 void assure_edges_kind(ir_graph *irg, ir_edge_kind_t kind)
 917 {
 918         if (!edges_activated_kind(irg, kind))
 919                 edges_activate_kind(irg, kind);
 920 }
 921
 922 void edges_node_deleted(ir_node *irn)
 923 {
 924         edges_node_deleted_kind(irn, EDGE_KIND_NORMAL);
 925         edges_node_deleted_kind(irn, EDGE_KIND_BLOCK);
 926         edges_node_deleted_kind(irn, EDGE_KIND_DEP);
 927 }
 928
 929 void edges_node_revival(ir_node *irn)
 930 {
 931         edges_node_revival_kind(irn, EDGE_KIND_NORMAL);
 932         edges_node_revival_kind(irn, EDGE_KIND_BLOCK);
 933 }
 934
 935 const ir_edge_t *(get_irn_out_edge_first_kind)(const ir_node *irn, ir_edge_kind_t kind)
 936 {
 937         return get_irn_out_edge_first_kind_(irn, kind);
 938 }
 939
 940 const ir_edge_t *(get_irn_out_edge_next)(const ir_node *irn, const ir_edge_t *last)
 941 {
 942         return get_irn_out_edge_next_(irn, last);
 943 }
 944
 945 ir_node *(get_edge_src_irn)(const ir_edge_t *edge)
 946 {
 947         return get_edge_src_irn_(edge);
 948 }
 949
 950 int (get_edge_src_pos)(const ir_edge_t *edge)
 951 {
 952         return get_edge_src_pos_(edge);
 953 }
 954
 955 int (get_irn_n_edges_kind)(const ir_node *irn, ir_edge_kind_t kind)
 956 {
 957         return get_irn_n_edges_kind_(irn, kind);
 958 }
 959
 960 static void irg_walk_edges2(ir_node *node, irg_walk_func *pre,
 961                             irg_walk_func *post, void *env)
 962 {
 963         if (irn_visited_else_mark(node))
 964                 return;
 965
 966         if (pre != NULL)
 967                 pre(node, env);
 968
 969         foreach_out_edge_kind_safe(node, edge, EDGE_KIND_NORMAL) {
 970                 /* find the corresponding successor block. */
 971                 ir_node *pred = get_edge_src_irn(edge);
 972                 irg_walk_edges2(pred, pre, post, env);
 973         }
 974
 975         if (post != NULL)
 976                 post(node, env);
 977 }
 978
 979 void irg_walk_edges(ir_node *node, irg_walk_func *pre, irg_walk_func *post,
 980                     void *env)
 981 {
 982         ir_graph *irg = get_irn_irg(node);
 983
 984         assert(edges_activated(irg));
 985         assert(is_Block(node));
 986
 987         ir_reserve_resources(irg, IR_RESOURCE_IRN_VISITED);
 988
 989         inc_irg_visited(irg);
 990         irg_walk_edges2(node, pre, post, env);
 991
 992         ir_free_resources(irg, IR_RESOURCE_IRN_VISITED);
 993 }
 994
 995 static void irg_block_edges_walk2(ir_node *bl, irg_walk_func *pre,
 996                                   irg_walk_func *post, void *env)
 997 {
 998         if (!Block_block_visited(bl)) {
 999                 mark_Block_block_visited(bl);
1000
1001                 if (pre)
1002                         pre(bl, env);
1003
1004                 foreach_out_edge_kind_safe(bl, edge, EDGE_KIND_BLOCK) {
1005                         /* find the corresponding successor block. */
1006                         ir_node *pred = get_edge_src_irn(edge);
1007                         irg_block_edges_walk2(pred, pre, post, env);
1008                 }
1009
1010                 if (post)
1011                         post(bl, env);
1012         }
1013 }
1014
1015 void irg_block_edges_walk(ir_node *node, irg_walk_func *pre,
1016                           irg_walk_func *post, void *env)
1017 {
1018         ir_graph *irg = get_irn_irg(node);
1019
1020         assert(edges_activated(irg));
1021         assert(is_Block(node));
1022
1023         ir_reserve_resources(irg, IR_RESOURCE_BLOCK_VISITED);
1024
1025         inc_irg_block_visited(irg);
1026         irg_block_edges_walk2(node, pre, post, env);
1027
1028         ir_free_resources(irg, IR_RESOURCE_BLOCK_VISITED);
1029 }