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