merge common graph copying code; move dead code elimination into an own file
[libfirm] / ir / ir / iredges.c
index fd5b2f5..89e56c4 100644 (file)
@@ -40,6 +40,7 @@
 #include "set.h"
 #include "bitset.h"
 #include "error.h"
+#include "irpass_t.h"
 
 #include "iredgeset.h"
 #include "hashptr.h"
  */
 typedef void (set_edge_func_t)(ir_node *src, int pos, ir_node *tgt);
 
+/**
+ * A function that returns the "arity" of a given edge kind
+ * for a node.
+ */
 typedef int (get_edge_src_arity_func_t)(const ir_node *src);
 
+/**
+ * A function that returns the pos'th edge of a given edge kind for a node.
+ */
 typedef ir_node *(get_edge_src_n_func_t)(const ir_node *src, int pos);
 
 /**
@@ -93,9 +101,10 @@ typedef struct {
 /**
  * Get the predecessor block.
  */
-static ir_node *get_block_n(const ir_node *irn, int pos) {
-       if (is_Block(irn))
-               return get_Block_cfgpred_block(irn, pos);
+static ir_node *get_block_n(const ir_node *block, int pos)
+{
+       if (is_Block(block))
+               return get_Block_cfgpred_block(block, pos);
        /* might be a Bad */
        return NULL;
 }
@@ -106,7 +115,7 @@ static const ir_edge_kind_info_t edge_kind_info[EDGE_KIND_LAST] = {
        { "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)
+#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)
 #define get_n(irn, pos, kind)        (edge_kind_info[kind].get_n(irn, pos))
 #define get_kind_str(kind)           (edge_kind_info[kind].name)
 
@@ -135,7 +144,11 @@ static int edges_dbg = 0;
 static long last_edge_num = -1;
 #endif
 
-static inline long edge_get_id(const ir_edge_t *e) {
+/**
+ * Returns an ID for the given edge.
+ */
+static inline long edge_get_id(const ir_edge_t *e)
+{
 #ifdef DEBUG_libfirm
        return e->edge_nr;
 #else /* DEBUG_libfirm */
@@ -154,7 +167,8 @@ static inline long edge_get_id(const ir_edge_t *e) {
  * Each user has to remember his given offset and the size of his private data.
  * To be called before FIRM is initialized.
  */
-int edges_register_private_data(size_t n) {
+int edges_register_private_data(size_t n)
+{
        int res = edges_private_size;
 
        assert(!edges_used && "you cannot register private edge data, if edges have been initialized");
@@ -168,7 +182,8 @@ int edges_register_private_data(size_t n) {
  * 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) {
+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);
        ir_edge_t             *edge;
        ir_edgeset_iterator_t  iter;
@@ -188,13 +203,14 @@ void edges_reset_private_data(ir_graph *irg, int offset, unsigned size) {
  * 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) {
+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);
                size_t amount = irg->estimated_node_count * 2;
 
                edges_used = 1;
-               if(info->allocated) {
+               if (info->allocated) {
                        amount = ir_edgeset_size(&info->edges);
                        ir_edgeset_destroy(&info->edges);
                        obstack_free(&info->edges_obst, NULL);
@@ -208,9 +224,10 @@ 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  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.
  */
@@ -233,9 +250,10 @@ const ir_edge_t *get_irn_edge_kind(ir_graph *irg, const ir_node *src, int pos, i
  * Get the edge object of an outgoing edge at a node.
  * Looks for an edge for all kinds.
  */
-const ir_edge_t *get_irn_edge(ir_graph *irg, const ir_node *src, int pos) {
+const ir_edge_t *get_irn_edge(ir_graph *irg, const ir_node *src, int pos)
+{
        const ir_edge_t *edge;
-       if((edge = get_irn_edge_kind(irg, src, pos, EDGE_KIND_NORMAL)) == NULL)
+       if ((edge = get_irn_edge_kind(irg, src, pos, EDGE_KIND_NORMAL)) == NULL)
                edge = get_irn_edge_kind(irg, src, pos, EDGE_KIND_BLOCK);
        return(edge);
 }
@@ -246,7 +264,8 @@ const ir_edge_t *get_irn_edge(ir_graph *irg, const ir_node *src, int pos) {
  * @param tgt  the edge target
  * @param kind the kind of the edge
  */
-static inline void edge_change_cnt(ir_node *tgt, ir_edge_kind_t kind, int ofs) {
+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);
        info->out_count += ofs;
 
@@ -275,7 +294,8 @@ static inline void edge_change_cnt(ir_node *tgt, ir_edge_kind_t kind, int ofs) {
  * Verify the edge list of a node, ie. ensure it's a loop:
  * head -> e_1 -> ... -> e_n -> head
  */
-static inline void vrfy_list_head(ir_node *irn, ir_edge_kind_t kind) {
+static inline void vrfy_list_head(ir_node *irn, ir_edge_kind_t kind)
+{
        int                    err       = 0;
        int                    num       = 0;
        pset                   *lh_set   = pset_new_ptr(16);
@@ -304,6 +324,29 @@ static inline void vrfy_list_head(ir_node *irn, ir_edge_kind_t kind) {
        assert(err == 0);
 }
 
+#ifdef DEBUG_libfirm
+/**
+ * Helper function to dump the edge set of a graph,
+ * unused in normal code.
+ */
+void edges_dump_kind(ir_graph *irg, ir_edge_kind_t kind)
+{
+       irg_edge_info_t *info;
+       ir_edgeset_t    *edges;
+       ir_edgeset_iterator_t iter;
+       ir_edge_t      *e;
+
+       if (!edges_activated_kind(irg, kind))
+               return;
+
+       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);
+       }
+}
+#endif
+
 /* 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,
@@ -395,7 +438,7 @@ void edges_notify_edge_kind(ir_node *src, int pos, ir_node *tgt,
                        edge->kind      = kind;
                        edge->list.next = NULL;
                        edge->list.prev = NULL;
-                       memset(((char*)edge) + sizeof(ir_edge_t), 0, edges_private_size);
+                       memset(edge + 1, 0, edges_private_size);
                        DEBUG_ONLY(edge->src_nr = get_irn_node_nr(src));
 
                        new_edge = ir_edgeset_insert(edges, edge);
@@ -467,6 +510,34 @@ static void edges_node_deleted_kind(ir_node *old, ir_edge_kind_t kind, ir_graph
        }
 }
 
+/**
+ * A node might be revivaled by CSE. Assure its edges.
+ *
+ * @param irn   the node
+ * @param kind  the kind of edges to remove
+ * @param irg   the irg of the old node
+ */
+static void edges_node_revival_kind(ir_node *irn, ir_edge_kind_t kind, ir_graph *irg)
+{
+       irn_edge_info_t *info;
+       int             i, n;
+
+       if (!edges_activated_kind(irg, kind))
+               return;
+
+       info = _get_irn_edge_info(irn, kind);
+       if (info->edges_built)
+               return;
+
+       DBG((dbg, LEVEL_5, "node revivaled (kind: %s): %+F\n", get_kind_str(kind), irn));
+
+       foreach_tgt(irn, i, n, kind) {
+               ir_node *tgt = get_n(irn, i, kind);
+               edges_notify_edge_kind(irn, i, tgt, NULL, kind, irg);
+       }
+       info->edges_built = 1;
+}
+
 struct build_walker {
        ir_graph       *irg;
        ir_edge_kind_t kind;
@@ -477,7 +548,8 @@ struct build_walker {
 /**
  * Post-Walker: notify all edges
  */
-static void build_edges_walker(ir_node *irn, void *data) {
+static void build_edges_walker(ir_node *irn, void *data)
+{
        struct build_walker   *w = data;
        int                   i, n;
        ir_edge_kind_t        kind = w->kind;
@@ -489,18 +561,21 @@ 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;
 }
 
 /**
  * Pre-Walker: initializes the list-heads and set the out-count
  * of all nodes to 0.
  */
-static void init_lh_walker(ir_node *irn, void *data) {
+static void init_lh_walker(ir_node *irn, void *data)
+{
        struct build_walker *w   = data;
        ir_edge_kind_t      kind = w->kind;
        list_head           *head = _get_irn_outs_head(irn, kind);
        INIT_LIST_HEAD(head);
-       _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;
 }
 
 /**
@@ -514,14 +589,16 @@ static void init_lh_walker(ir_node *irn, void *data) {
  * b) it might be sufficient to add those stupid NO_REG nodes
  * to the anchor
  */
-static void init_lh_walker_dep(ir_node *irn, void *data) {
+static void init_lh_walker_dep(ir_node *irn, void *data)
+{
        struct build_walker *w   = data;
        ir_edge_kind_t      kind = w->kind;
        list_head           *head = _get_irn_outs_head(irn, kind);
        int                 i;
 
        INIT_LIST_HEAD(head);
-       _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);
@@ -529,7 +606,8 @@ static void init_lh_walker_dep(ir_node *irn, void *data) {
                head = _get_irn_outs_head(dep, kind);
 
                INIT_LIST_HEAD(head);
-               _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;
        }
 }
 
@@ -542,11 +620,11 @@ typedef struct visitor_info_t {
  * Visitor: initializes the list-heads and set the out-count
  * of all nodes to 0 of nodes that are not seen so far.
  */
-static void visitor(ir_node *irn, void *data) {
+static void visitor(ir_node *irn, void *data)
+{
        visitor_info_t *info = data;
 
-       if (!irn_visited(irn)) {
-               mark_irn_visited(irn);
+       if (!irn_visited_else_mark(irn)) {
                info->visit(irn, info->data);
        }
 }
@@ -630,7 +708,7 @@ void edges_reroute_kind(ir_node *from, ir_node *to, ir_edge_kind_t kind, ir_grap
 {
        set_edge_func_t *set_edge = edge_kind_info[kind].set_edge;
 
-       if(set_edge && edges_activated_kind(irg, kind)) {
+       if (set_edge && edges_activated_kind(irg, kind)) {
                struct list_head *head = _get_irn_outs_head(from, kind);
 
                DBG((dbg, LEVEL_5, "reroute from %+F to %+F\n", from, to));
@@ -656,7 +734,7 @@ static void verify_set_presence(ir_node *irn, void *data)
                templ.pos = i;
 
                e = ir_edgeset_find(edges, &templ);
-               if(e != NULL) {
+               if (e != NULL) {
                        e->present = 1;
                } else {
                        w->problem_found = 1;
@@ -741,7 +819,8 @@ int edges_verify_kind(ir_graph *irg, ir_edge_kind_t kind)
 /**
  * Clear link field of all nodes.
  */
-static void clear_links(ir_node *irn, void *env) {
+static void clear_links(ir_node *irn, void *env)
+{
        struct build_walker *w  = env;
        bitset_t            *bs;
 
@@ -757,7 +836,8 @@ static void clear_links(ir_node *irn, void *env) {
 /**
  * Increases count (stored in link field) for all operands of a node.
  */
-static void count_user(ir_node *irn, void *env) {
+static void count_user(ir_node *irn, void *env)
+{
        int i;
        int first;
        (void) env;
@@ -775,7 +855,8 @@ static void count_user(ir_node *irn, void *env) {
 /**
  * Verifies if collected count, number of edges in list and stored edge count are in sync.
  */
-static void verify_edge_counter(ir_node *irn, void *env) {
+static void verify_edge_counter(ir_node *irn, void *env)
+{
        struct build_walker    *w = env;
        bitset_t               *bs;
        int                    list_cnt;
@@ -852,7 +933,8 @@ static void verify_edge_counter(ir_node *irn, void *env) {
 /**
  * Verifies the out edges of an irg.
  */
-int edges_verify(ir_graph *irg) {
+int edges_verify(ir_graph *irg)
+{
        struct build_walker w;
        int    problem_found = 0;
 
@@ -870,23 +952,60 @@ int edges_verify(ir_graph *irg) {
        return problem_found ? 1 : w.problem_found;
 }
 
-void init_edges(void) {
+struct pass_t {
+       ir_graph_pass_t pass;
+       unsigned        assert_on_problem;
+};
+
+/**
+ * Wrapper to edges_verify to be run as an ir_graph pass.
+ */
+static int edges_verify_wrapper(ir_graph *irg, void *context)
+{
+       struct pass_t *pass = context;
+       int problems_found = edges_verify(irg);
+       /* do NOT rerun the pass if verify is ok :-) */
+       assert(problems_found && pass->assert_on_problem);
+       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)
+{
+       struct pass_t *pass = XMALLOCZ(struct pass_t);
+
+       def_graph_pass_constructor(
+               &pass->pass, name ? name : "edges_verify", edges_verify_wrapper);
+
+       /* neither dump nor verify */
+       pass->pass.dump_irg   = (DUMP_ON_IRG_FUNC)ir_prog_no_dump;
+       pass->pass.verify_irg = (RUN_ON_IRG_FUNC)ir_prog_no_verify;
+
+       pass->assert_on_problem = assert_on_problem;
+       return &pass->pass;
+}
+
+void init_edges(void)
+{
        FIRM_DBG_REGISTER(dbg, DBG_EDGES);
        /* firm_dbg_set_mask(dbg, -1); */
 }
 
-void edges_init_dbg(int do_dbg) {
+void edges_init_dbg(int do_dbg)
+{
        edges_dbg = do_dbg;
 }
 
-void edges_activate(ir_graph *irg) {
+void edges_activate(ir_graph *irg)
+{
        edges_activate_kind(irg, EDGE_KIND_NORMAL);
        edges_activate_kind(irg, EDGE_KIND_BLOCK);
        if (get_irg_phase_state(irg) == phase_backend)
                edges_activate_kind(irg, EDGE_KIND_DEP);
 }
 
-void edges_deactivate(ir_graph *irg) {
+void edges_deactivate(ir_graph *irg)
+{
        if (get_irg_phase_state(irg) == phase_backend)
                edges_deactivate_kind(irg, EDGE_KIND_DEP);
        edges_deactivate_kind(irg, EDGE_KIND_BLOCK);
@@ -911,7 +1030,8 @@ int edges_assure(ir_graph *irg)
        return activated;
 }
 
-int edges_assure_kind(ir_graph *irg, ir_edge_kind_t kind) {
+int edges_assure_kind(ir_graph *irg, ir_edge_kind_t kind)
+{
        int activated = edges_activated_kind(irg, kind);
 
        if (!activated)
@@ -920,33 +1040,45 @@ int edges_assure_kind(ir_graph *irg, ir_edge_kind_t kind) {
        return activated;
 }
 
-void edges_node_deleted(ir_node *irn, ir_graph *irg) {
+void edges_node_deleted(ir_node *irn, ir_graph *irg)
+{
        edges_node_deleted_kind(irn, EDGE_KIND_NORMAL, irg);
        edges_node_deleted_kind(irn, EDGE_KIND_BLOCK, irg);
 }
 
+void edges_node_revival(ir_node *irn, ir_graph *irg)
+{
+       edges_node_revival_kind(irn, EDGE_KIND_NORMAL, irg);
+       edges_node_revival_kind(irn, EDGE_KIND_BLOCK, irg);
+}
 
-const ir_edge_t *(get_irn_out_edge_first_kind)(const ir_node *irn, ir_edge_kind_t kind) {
+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);
 }
 
-const ir_edge_t *(get_irn_out_edge_next)(const ir_node *irn, const ir_edge_t *last) {
+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);
 }
 
-ir_node *(get_edge_src_irn)(const ir_edge_t *edge) {
+ir_node *(get_edge_src_irn)(const ir_edge_t *edge)
+{
        return _get_edge_src_irn(edge);
 }
 
-int (get_edge_src_pos)(const ir_edge_t *edge) {
+int (get_edge_src_pos)(const ir_edge_t *edge)
+{
        return _get_edge_src_pos(edge);
 }
 
-int (get_irn_n_edges_kind)(const ir_node *irn, ir_edge_kind_t kind) {
+int (get_irn_n_edges_kind)(const ir_node *irn, ir_edge_kind_t kind)
+{
        return _get_irn_n_edges_kind(irn, kind);
 }
 
-void dump_all_out_edges(ir_node *irn) {
+void dump_all_out_edges(ir_node *irn)
+{
        int i;
        for (i = 0; i < EDGE_KIND_LAST; ++i) {
                const ir_edge_t *edge;
@@ -958,9 +1090,9 @@ void dump_all_out_edges(ir_node *irn) {
        }
 }
 
-static void irg_block_edges_walk2(ir_node *bl,
-                                irg_walk_func *pre, irg_walk_func *post,
-                                void *env) {
+static void irg_block_edges_walk2(ir_node *bl, irg_walk_func *pre,
+                                  irg_walk_func *post, void *env)
+{
        const ir_edge_t *edge, *next;
 
        if (!Block_block_visited(bl)) {
@@ -980,10 +1112,9 @@ static void irg_block_edges_walk2(ir_node *bl,
        }
 }
 
-void irg_block_edges_walk(ir_node *node,
-                          irg_walk_func *pre, irg_walk_func *post,
-                          void *env) {
-
+void irg_block_edges_walk(ir_node *node, irg_walk_func *pre,
+                          irg_walk_func *post, void *env)
+{
        assert(edges_activated(current_ir_graph));
        assert(is_Block(node));