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