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