iredges: introduce new reroute_edges_except
[libfirm] / ir / ir / iredges.c
index 799dada..cb163b1 100644 (file)
@@ -22,7 +22,6 @@
  * @brief   Always available outs.
  * @author  Sebastian Hack, Michael Beck, Andreas Schoesser
  * @date    14.1.2005
- * @version $Id$
  * @brief
  *   This are out-edges (also called def-use edges) that are dynamically
  *   updated as the graph changes.
@@ -52,7 +51,7 @@
 #define ValueType                 ir_edge_t*
 #define NullValue                 NULL
 #define DeletedValue              ((ir_edge_t*)-1)
-#define Hash(this,key)            (HASH_PTR(key->src) ^ (key->pos * 40013))
+#define Hash(this,key)            (hash_ptr(key->src) ^ (key->pos * 40013))
 #define KeysEqual(this,key1,key2) ((key1->src) == (key2->src) && (key1->pos == key2->pos))
 #define SetRangeEmpty(ptr,size)   memset(ptr, 0, (size) * sizeof((ptr)[0]))
 
@@ -112,10 +111,17 @@ static ir_node *get_block_n(const ir_node *block, int pos)
        return NULL;
 }
 
+static ir_node *get_irn_safe_n(const ir_node *node, int n)
+{
+       if (n == -1 && is_Block(node))
+               return NULL;
+       return get_irn_n(node, n);
+}
+
 static const ir_edge_kind_info_t edge_kind_info[EDGE_KIND_LAST] = {
-       { "normal"     , set_irn_n,   -1, get_irn_arity,  get_irn_n   },
-       { "block succs", NULL,         0, get_irn_arity,  get_block_n },
-       { "dependency",  set_irn_dep,  0, get_irn_deps,   get_irn_dep }
+       { "normal"     , set_irn_n,   -1, get_irn_arity,  get_irn_safe_n },
+       { "block succs", NULL,         0, get_irn_arity,  get_block_n    },
+       { "dependency",  set_irn_dep,  0, get_irn_deps,   get_irn_dep    }
 };
 
 #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)
@@ -150,17 +156,6 @@ static inline long edge_get_id(const ir_edge_t *e)
        return (long)e;
 }
 
-/**
- * Announce to reserve extra space for each edge to be allocated.
- *
- * @param n: Size of the space to reserve
- *
- * @return Offset at which the private data will begin
- *
- * Several users can reserve extra space for private usage.
- * Each user has to remember his given offset and the size of his private data.
- * To be called before FIRM is initialized.
- */
 size_t edges_register_private_data(size_t n)
 {
        size_t res = edges_private_size;
@@ -171,14 +166,9 @@ size_t edges_register_private_data(size_t n)
        return res;
 }
 
-/*
- * Reset the user's private data at offset 'offset'
- * The user has to remember his offset and the size of his data!
- * Caution: Using wrong values here can destroy other users private data!
- */
 void edges_reset_private_data(ir_graph *irg, int offset, unsigned size)
 {
-       irg_edge_info_t       *info = _get_irg_edge_info(irg, EDGE_KIND_NORMAL);
+       irg_edge_info_t       *info = get_irg_edge_info(irg, EDGE_KIND_NORMAL);
        ir_edge_t             *edge;
        ir_edgeset_iterator_t  iter;
 
@@ -191,16 +181,12 @@ void edges_reset_private_data(ir_graph *irg, int offset, unsigned size)
 
 #define get_irn_out_list_head(irn) (&get_irn_out_info(irn)->outs)
 
-#define edge_hash(edge) (TIMES37((edge)->pos) + HASH_PTR((edge)->src))
+#define edge_hash(edge) (TIMES37((edge)->pos) + hash_ptr((edge)->src))
 
-/**
- * Initialize the out information for a graph.
- * @note Dead node elimination can call this on an already initialized graph.
- */
 void edges_init_graph_kind(ir_graph *irg, ir_edge_kind_t kind)
 {
        if (edges_activated_kind(irg, kind)) {
-               irg_edge_info_t *info = _get_irg_edge_info(irg, kind);
+               irg_edge_info_t *info = get_irg_edge_info(irg, kind);
                size_t amount = irg->estimated_node_count * 2;
 
                edges_used = 1;
@@ -216,20 +202,11 @@ void edges_init_graph_kind(ir_graph *irg, ir_edge_kind_t kind)
        }
 }
 
-/**
- * Get the edge object of an outgoing edge at a node.
- * @param  irg  The graph, the node is in.
- * @param  src  The node at which the edge originates.
- * @param  pos  The position of the edge.
- * @param  kind The kind of the edge.
- * @return      The corresponding edge object or NULL,
- *              if no such edge exists.
- */
 const ir_edge_t *get_irn_edge_kind(const ir_node *src, int pos, ir_edge_kind_t kind)
 {
        ir_graph *irg = get_irn_irg(src);
        if (edges_activated_kind(irg, kind)) {
-               irg_edge_info_t *info = _get_irg_edge_info(irg, kind);
+               irg_edge_info_t *info = get_irg_edge_info(irg, kind);
                ir_edge_t       key;
 
                key.src = (ir_node *)src;
@@ -249,7 +226,7 @@ const ir_edge_t *get_irn_edge_kind(const ir_node *src, int pos, ir_edge_kind_t k
  */
 static inline void edge_change_cnt(ir_node *tgt, ir_edge_kind_t kind, int ofs)
 {
-       irn_edge_info_t *info = _get_irn_edge_info(tgt, kind);
+       irn_edge_info_t *info = get_irn_edge_info(tgt, kind);
        info->out_count += ofs;
 }
 
@@ -259,10 +236,10 @@ static inline void edge_change_cnt(ir_node *tgt, ir_edge_kind_t kind, int ofs)
  */
 static inline void verify_list_head(ir_node *irn, ir_edge_kind_t kind)
 {
-       int                    err       = 0;
-       int                    num       = 0;
-       pset                   *lh_set   = pset_new_ptr(16);
-       const struct list_head *head     = _get_irn_outs_head(irn, kind);
+       int                    err     = 0;
+       int                    num     = 0;
+       pset                   *lh_set = pset_new_ptr(16);
+       const struct list_head *head   = &get_irn_edge_info(irn, kind)->outs_head;
        const struct list_head *pos;
 
        list_for_each(pos, head) {
@@ -297,14 +274,13 @@ void edges_dump_kind(ir_graph *irg, ir_edge_kind_t kind)
        if (!edges_activated_kind(irg, kind))
                return;
 
-       info  = _get_irg_edge_info(irg, kind);
+       info  = get_irg_edge_info(irg, kind);
        edges = &info->edges;
        foreach_ir_edgeset(edges, e, iter) {
                ir_printf("%+F %d %d\n", e->src, e->pos, e->invalid);
        }
 }
 
-/* The edge from (src, pos) -> old_tgt is redirected to tgt */
 void edges_notify_edge_kind(ir_node *src, int pos, ir_node *tgt,
                             ir_node *old_tgt, ir_edge_kind_t kind,
                             ir_graph *irg)
@@ -322,7 +298,7 @@ void edges_notify_edge_kind(ir_node *src, int pos, ir_node *tgt,
        if (tgt == old_tgt)
                return;
 
-       info  = _get_irg_edge_info(irg, kind);
+       info  = get_irg_edge_info(irg, kind);
        edges = &info->edges;
 
        /* Initialize the edge template to search in the set. */
@@ -357,7 +333,7 @@ void edges_notify_edge_kind(ir_node *src, int pos, ir_node *tgt,
                 * old target was != NULL) or added (if the old target was
                 * NULL).
                 */
-               struct list_head *head = _get_irn_outs_head(tgt, kind);
+               struct list_head *head = &get_irn_edge_info(tgt, kind)->outs_head;
 
                assert(head->next && head->prev &&
                                "target list head must have been initialized");
@@ -403,7 +379,7 @@ void edges_notify_edge_kind(ir_node *src, int pos, ir_node *tgt,
                }
 
                edge_change_cnt(tgt, kind, +1);
-       } /* else */
+       }
 
 #ifndef DEBUG_libfirm
        /* verify list heads */
@@ -490,7 +466,7 @@ static void edges_node_revival_kind(ir_node *irn, ir_edge_kind_t kind)
        if (!edges_activated_kind(irg, kind))
                return;
 
-       info = _get_irn_edge_info(irn, kind);
+       info = get_irn_edge_info(irn, kind);
        if (info->edges_built)
                return;
 
@@ -523,7 +499,7 @@ static void build_edges_walker(ir_node *irn, void *data)
                ir_node *pred = get_n(irn, i, kind);
                edges_notify_edge_kind(irn, i, pred, NULL, kind, irg);
        }
-       _get_irn_edge_info(irn, kind)->edges_built = 1;
+       get_irn_edge_info(irn, kind)->edges_built = 1;
 }
 
 /**
@@ -534,10 +510,10 @@ static void init_lh_walker(ir_node *irn, void *data)
 {
        build_walker   *w    = (build_walker*)data;
        ir_edge_kind_t  kind = w->kind;
-       list_head      *head = _get_irn_outs_head(irn, kind);
+       list_head      *head = &get_irn_edge_info(irn, kind)->outs_head;
        INIT_LIST_HEAD(head);
-       _get_irn_edge_info(irn, kind)->edges_built = 0;
-       _get_irn_edge_info(irn, kind)->out_count   = 0;
+       get_irn_edge_info(irn, kind)->edges_built = 0;
+       get_irn_edge_info(irn, kind)->out_count   = 0;
 }
 
 /**
@@ -555,21 +531,21 @@ static void init_lh_walker_dep(ir_node *irn, void *data)
 {
        build_walker   *w    = (build_walker*)data;
        ir_edge_kind_t  kind = w->kind;
-       list_head      *head = _get_irn_outs_head(irn, kind);
+       list_head      *head = &get_irn_edge_info(irn, kind)->outs_head;
        int             i;
 
        INIT_LIST_HEAD(head);
-       _get_irn_edge_info(irn, kind)->edges_built = 0;
-       _get_irn_edge_info(irn, kind)->out_count   = 0;
+       get_irn_edge_info(irn, kind)->edges_built = 0;
+       get_irn_edge_info(irn, kind)->out_count   = 0;
 
        for (i = get_irn_deps(irn) - 1; i >= 0; --i) {
                ir_node *dep = get_irn_dep(irn, i);
 
-               head = _get_irn_outs_head(dep, kind);
+               head = &get_irn_edge_info(dep, kind)->outs_head;
 
                INIT_LIST_HEAD(head);
-               _get_irn_edge_info(dep, kind)->edges_built = 0;
-               _get_irn_edge_info(dep, kind)->out_count   = 0;
+               get_irn_edge_info(dep, kind)->edges_built = 0;
+               get_irn_edge_info(dep, kind)->out_count   = 0;
        }
 }
 
@@ -596,32 +572,32 @@ static void visitor(ir_node *irn, void *data)
        }
 }
 
-/*
- * Build the initial edge set.
- * Beware, this is not a simple task because it suffers from two
- * difficulties:
- * - the anchor set allows access to Nodes that may not be reachable from
- *   the End node
- * - the identities add nodes to the "root set" that are not yet reachable
- *   from End. However, after some transformations, the CSE may revival these
- *   nodes
- *
- * These problems can be fixed using different strategies:
- * - Add an age flag to every node. Whenever the edge of a node is older
- *   then the current edge, invalidate the edges of this node.
- *   While this would help for revivaled nodes, it increases memory and runtime.
- * - Delete the identities set.
- *   Solves the revival problem, but may increase the memory consumption, as
- *   nodes cannot be revivaled at all.
- * - Manually iterate over the identities root set. This did not consume more memory
- *   but increase the computation time because the |identities| >= |V|
- *
- * Currently, we use the last option.
- */
 void edges_activate_kind(ir_graph *irg, ir_edge_kind_t kind)
 {
+       /*
+        * Build the initial edge set.
+        * Beware, this is not a simple task because it suffers from two
+        * difficulties:
+        * - the anchor set allows access to Nodes that may not be reachable from
+        *   the End node
+        * - the identities add nodes to the "root set" that are not yet reachable
+        *   from End. However, after some transformations, the CSE may revival these
+        *   nodes
+        *
+        * These problems can be fixed using different strategies:
+        * - Add an age flag to every node. Whenever the edge of a node is older
+        *   then the current edge, invalidate the edges of this node.
+        *   While this would help for revivaled nodes, it increases memory and runtime.
+        * - Delete the identities set.
+        *   Solves the revival problem, but may increase the memory consumption, as
+        *   nodes cannot be revivaled at all.
+        * - Manually iterate over the identities root set. This did not consume more memory
+        *   but increase the computation time because the |identities| >= |V|
+        *
+        * Currently, we use the last option.
+        */
        struct build_walker w;
-       irg_edge_info_t     *info = _get_irg_edge_info(irg, kind);
+       irg_edge_info_t     *info = get_irg_edge_info(irg, kind);
        visitor_info_t      visit;
 
        w.kind = kind;
@@ -639,15 +615,15 @@ void edges_activate_kind(ir_graph *irg, ir_edge_kind_t kind)
                visit_all_identities(irg, visitor, &visit);
                irg_walk_anchors(irg, NULL, build_edges_walker, &w);
        } else {
-               irg_walk_anchors(irg, init_lh_walker, build_edges_walker, &w);
                visit.visit = init_lh_walker;
                visit_all_identities(irg, visitor, &visit);
+               irg_walk_anchors(irg, init_lh_walker, build_edges_walker, &w);
        }
 }
 
 void edges_deactivate_kind(ir_graph *irg, ir_edge_kind_t kind)
 {
-       irg_edge_info_t *info = _get_irg_edge_info(irg, kind);
+       irg_edge_info_t *info = get_irg_edge_info(irg, kind);
 
        info->activated = 0;
        if (info->allocated) {
@@ -655,28 +631,21 @@ void edges_deactivate_kind(ir_graph *irg, ir_edge_kind_t kind)
                ir_edgeset_destroy(&info->edges);
                info->allocated = 0;
        }
+       clear_irg_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_OUT_EDGES);
 }
 
 int (edges_activated_kind)(const ir_graph *irg, ir_edge_kind_t kind)
 {
-       return _edges_activated_kind(irg, kind);
+       return edges_activated_kind_(irg, kind);
 }
 
-
-/**
- * Reroute all use-edges from a node to another.
- * @param from The node whose use-edges shall be withdrawn.
- * @param to   The node to which all the use-edges of @p from shall be
- *             sent to.
- * @param irg  The graph.
- */
 void edges_reroute_kind(ir_node *from, ir_node *to, ir_edge_kind_t kind)
 {
        ir_graph *irg = get_irn_irg(from);
        set_edge_func_t *set_edge = edge_kind_info[kind].set_edge;
 
        if (set_edge && edges_activated_kind(irg, kind)) {
-               struct list_head *head = _get_irn_outs_head(from, kind);
+               struct list_head *head = &get_irn_edge_info(from, kind)->outs_head;
 
                DBG((dbg, LEVEL_5, "reroute from %+F to %+F\n", from, to));
 
@@ -688,11 +657,23 @@ void edges_reroute_kind(ir_node *from, ir_node *to, ir_edge_kind_t kind)
        }
 }
 
+void edges_reroute_except(ir_node *from, ir_node *to, ir_node *exception)
+{
+       const ir_edge_t *edge;
+       const ir_edge_t *next;
+       foreach_out_edge_safe(from, edge, next) {
+               ir_node *src = get_edge_src_irn(edge);
+               if (src == exception)
+                       continue;
+               set_irn_n(src, edge->pos, to);
+       }
+}
+
 static void verify_set_presence(ir_node *irn, void *data)
 {
        build_walker *w     = (build_walker*)data;
        ir_graph     *irg   = get_irn_irg(irn);
-       ir_edgeset_t *edges = &_get_irg_edge_info(irg, w->kind)->edges;
+       ir_edgeset_t *edges = &get_irg_edge_info(irg, w->kind)->edges;
        int i, n;
 
        foreach_tgt(irn, i, n, w->kind) {
@@ -739,7 +720,7 @@ static void verify_list_presence(ir_node *irn, void *data)
 int edges_verify_kind(ir_graph *irg, ir_edge_kind_t kind)
 {
        struct build_walker w;
-       ir_edgeset_t        *edges = &_get_irg_edge_info(irg, kind)->edges;
+       ir_edgeset_t        *edges = &get_irg_edge_info(irg, kind)->edges;
        ir_edge_t           *e;
        ir_edgeset_iterator_t  iter;
 
@@ -830,8 +811,8 @@ static void verify_edge_counter(ir_node *irn, void *env)
        bs       = (bitset_t*)get_irn_link(irn);
        list_cnt = 0;
        ref_cnt  = 0;
-       edge_cnt = _get_irn_edge_info(irn, EDGE_KIND_NORMAL)->out_count;
-       head     = _get_irn_outs_head(irn, EDGE_KIND_NORMAL);
+       edge_cnt = get_irn_edge_info(irn, EDGE_KIND_NORMAL)->out_count;
+       head     = &get_irn_edge_info(irn, EDGE_KIND_NORMAL)->outs_head;
 
        /* We can iterate safely here, list heads have already been verified. */
        list_for_each(pos, head) {
@@ -869,9 +850,6 @@ static void verify_edge_counter(ir_node *irn, void *env)
        bitset_free(bs);
 }
 
-/**
- * Verifies the out edges of an irg.
- */
 int edges_verify(ir_graph *irg)
 {
        struct build_walker w;
@@ -907,7 +885,6 @@ static int edges_verify_wrapper(ir_graph *irg, void *context)
        return 0;
 }
 
-/* Creates an ir_graph pass for edges_verify(). */
 ir_graph_pass_t *irg_verify_edges_pass(const char *name, unsigned assert_on_problem)
 {
        pass_t *pass = XMALLOCZ(pass_t);
@@ -949,32 +926,17 @@ void edges_deactivate(ir_graph *irg)
        edges_deactivate_kind(irg, EDGE_KIND_NORMAL);
 }
 
-int edges_assure(ir_graph *irg)
+void assure_edges(ir_graph *irg)
 {
-       int activated = 0;
-
-       if (edges_activated_kind(irg, EDGE_KIND_BLOCK)) {
-               activated = 1;
-       } else {
-               edges_activate_kind(irg, EDGE_KIND_BLOCK);
-       }
-       if (edges_activated_kind(irg, EDGE_KIND_NORMAL)) {
-               activated = 1;
-       } else {
-               edges_activate_kind(irg, EDGE_KIND_NORMAL);
-       }
-
-       return activated;
+       assure_edges_kind(irg, EDGE_KIND_BLOCK);
+       assure_edges_kind(irg, EDGE_KIND_NORMAL);
+       add_irg_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_OUT_EDGES);
 }
 
-int edges_assure_kind(ir_graph *irg, ir_edge_kind_t kind)
+void assure_edges_kind(ir_graph *irg, ir_edge_kind_t kind)
 {
-       int activated = edges_activated_kind(irg, kind);
-
-       if (!activated)
+       if (!edges_activated_kind(irg, kind))
                edges_activate_kind(irg, kind);
-
-       return activated;
 }
 
 void edges_node_deleted(ir_node *irn)
@@ -991,27 +953,27 @@ void edges_node_revival(ir_node *irn)
 
 const ir_edge_t *(get_irn_out_edge_first_kind)(const ir_node *irn, ir_edge_kind_t kind)
 {
-       return _get_irn_out_edge_first_kind(irn, kind);
+       return get_irn_out_edge_first_kind_(irn, kind);
 }
 
 const ir_edge_t *(get_irn_out_edge_next)(const ir_node *irn, const ir_edge_t *last)
 {
-       return _get_irn_out_edge_next(irn, last);
+       return get_irn_out_edge_next_(irn, last);
 }
 
 ir_node *(get_edge_src_irn)(const ir_edge_t *edge)
 {
-       return _get_edge_src_irn(edge);
+       return get_edge_src_irn_(edge);
 }
 
 int (get_edge_src_pos)(const ir_edge_t *edge)
 {
-       return _get_edge_src_pos(edge);
+       return get_edge_src_pos_(edge);
 }
 
 int (get_irn_n_edges_kind)(const ir_node *irn, ir_edge_kind_t kind)
 {
-       return _get_irn_n_edges_kind(irn, kind);
+       return get_irn_n_edges_kind_(irn, kind);
 }
 
 static void irg_walk_edges2(ir_node *node, irg_walk_func *pre,