committing ilp based spilling
[libfirm] / ir / be / bespill.c
index 73b1d1d..b812541 100644 (file)
@@ -20,6 +20,7 @@
 #include "debug.h"
 #include "irgwalk.h"
 #include "array.h"
+#include "pdeq.h"
 
 #include "belive_t.h"
 #include "besched_t.h"
@@ -27,7 +28,7 @@
 #include "benode_t.h"
 #include "bechordal_t.h"
 
-#undef REMAT
+#define REMAT
 /* This enables re-computation of values. Current state: Unfinished and buggy. */
 #undef BUGGY_REMAT
 
@@ -57,41 +58,70 @@ struct _spill_env_t {
        set *spill_ctxs;
        set *spills;                            /**< all spill_info_t's, which must be placed */
        pset *mem_phis;                         /**< set of all special spilled phis. allocated and freed separately */
-       decide_irn_t is_mem_phi;        /**< callback func to decide if a phi needs special spilling */
+       decide_irn_t is_spilled_phi;/**< callback func to decide if a phi needs special spilling */
        void *data;                                     /**< data passed to all callbacks */
        DEBUG_ONLY(firm_dbg_module_t *dbg;)
 };
 
+/* associated Phi -> Spill*/
+typedef struct _phi_spill_assoc_t {
+       ir_node *phi;
+       ir_node *spill;
+} phi_spill_assoc_t;
+
+/**
+ * Compare two Phi->Spill associations.
+ */
+static int cmp_phi_spill_assoc(const void *a, const void *b, size_t n) {
+       const phi_spill_assoc_t *p1 = a;
+       const phi_spill_assoc_t *p2 = b;
+       return p1->phi != p2->phi;
+}
+
+/**
+ * compare two spill contexts.
+ */
 static int cmp_spillctx(const void *a, const void *b, size_t n) {
        const spill_ctx_t *p = a;
        const spill_ctx_t *q = b;
-       return !(p->user == q->user && p->spilled == q->spilled);
+       return p->user != q->user || p->spilled != q->spilled;
 }
 
+/**
+ * Compare two spill infos.
+ */
 static int cmp_spillinfo(const void *x, const void *y, size_t size) {
        const spill_info_t *xx = x;
        const spill_info_t *yy = y;
-       return ! (xx->spilled_node == yy->spilled_node);
+       return xx->spilled_node != yy->spilled_node;
 }
 
 DEBUG_ONLY(
+/* Sets the debug module of a spill environment. */
 void be_set_spill_env_dbg_module(spill_env_t *env, firm_dbg_module_t *dbg) {
        env->dbg = dbg;
 }
-);
-
-spill_env_t *be_new_spill_env(const be_chordal_env_t *chordal_env, decide_irn_t is_mem_phi, void *data) {
-       spill_env_t *env = xmalloc(sizeof(env[0]));
-       env->spill_ctxs  = new_set(cmp_spillctx, 1024);
-       env->spills      = new_set(cmp_spillinfo, 1024);
-       env->cls         = chordal_env->cls;
-       env->is_mem_phi  = is_mem_phi;
-       env->data        = data;
-       env->chordal_env = chordal_env;
+)
+
+/* Creates a new spill environment. */
+spill_env_t *be_new_spill_env(const be_chordal_env_t *chordal_env, decide_irn_t is_spilled_phi, void *data) {
+       spill_env_t *env        = xmalloc(sizeof(env[0]));
+       env->spill_ctxs         = new_set(cmp_spillctx, 1024);
+       env->spills                     = new_set(cmp_spillinfo, 1024);
+       env->cls                        = chordal_env->cls;
+       env->is_spilled_phi     = is_spilled_phi;
+       env->data                       = data;
+       env->chordal_env        = chordal_env;
        obstack_init(&env->obst);
        return env;
 }
 
+void be_set_is_spilled_phi(spill_env_t *env, decide_irn_t is_spilled_phi, void *data) {
+       env->is_spilled_phi     = is_spilled_phi;
+       env->data                       = data;
+}
+
+/* Deletes a spill environment. */
 void be_delete_spill_env(spill_env_t *senv) {
        del_set(senv->spill_ctxs);
        del_set(senv->spills);
@@ -99,6 +129,15 @@ void be_delete_spill_env(spill_env_t *senv) {
        free(senv);
 }
 
+/**
+ * Returns a spill context. If the context did not exists, create one.
+ *
+ * @param sc        the set containing all spill contexts
+ * @param to_spill  the node that should be spilled
+ * @param ctx_irn   an user of the spilled node
+ *
+ * @return a spill context.
+ */
 static spill_ctx_t *be_get_spill_ctx(set *sc, ir_node *to_spill, ir_node *ctx_irn) {
        spill_ctx_t templ;
 
@@ -109,86 +148,139 @@ static spill_ctx_t *be_get_spill_ctx(set *sc, ir_node *to_spill, ir_node *ctx_ir
        return set_insert(sc, &templ, sizeof(templ), HASH_COMBINE(HASH_PTR(to_spill), HASH_PTR(ctx_irn)));
 }
 
+/**
+ * Creates a spill.
+ *
+ * @param senv      the spill environment
+ * @param irn       the node that should be spilled
+ * @param ctx_irn   an user of the spilled node
+ *
+ * @return a be_Spill node
+ */
 static ir_node *be_spill_irn(spill_env_t *senv, ir_node *irn, ir_node *ctx_irn) {
        spill_ctx_t *ctx;
+       const be_main_env_t *env = senv->chordal_env->birg->main_env;
        DBG((senv->dbg, LEVEL_1, "%+F in ctx %+F\n", irn, ctx_irn));
 
+       // Has the value already been spilled?
        ctx = be_get_spill_ctx(senv->spill_ctxs, irn, ctx_irn);
-       if(!ctx->spill) {
-               const be_main_env_t *env = senv->chordal_env->birg->main_env;
-               ctx->spill = be_spill(env->arch_env, irn, ctx_irn);
+       if(ctx->spill)
+               return ctx->spill;
+
+       /* Trying to spill an already spilled value, no need for a new spill
+        * node then, we can simply connect to the same one for this reload
+        */
+       if(be_is_Reload(irn)) {
+               return get_irn_n(irn, be_pos_Reload_mem);
        }
 
+       ctx->spill = be_spill(env->arch_env, irn, ctx_irn);
        return ctx->spill;
 }
 
 /**
- * If the first usage of a phi result would be out of memory
+ * If the first usage of a Phi result would be out of memory
  * there is no sense in allocating a register for it.
  * Thus we spill it and all its operands to the same spill slot.
  * Therefore the phi/dataB becomes a phi/Memory
+ *
+ * @param senv      the spill environment
+ * @param phi       the Phi node that should be spilled
+ * @param ctx_irn   an user of the spilled node
+ *
+ * @return a be_Spill node
  */
-static ir_node *be_spill_phi(spill_env_t *senv, ir_node *phi, ir_node *ctx_irn) {
-       int i, n = get_irn_arity(phi);
-       ir_node **ins, *bl = get_nodes_block(phi);
-       ir_graph *irg = senv->chordal_env->irg;
+static ir_node *be_spill_phi(spill_env_t *senv, ir_node *phi, ir_node *ctx_irn, set *already_visited_phis, bitset_t *bs) {
+       int         i, n      = get_irn_arity(phi);
+       ir_graph    *irg      = senv->chordal_env->irg;
+       ir_node     *bl       = get_nodes_block(phi);
+       ir_node     **ins, *phi_spill;
+       phi_spill_assoc_t key;
        spill_ctx_t *ctx;
 
        assert(is_Phi(phi));
        DBG((senv->dbg, LEVEL_1, "%+F in ctx %+F\n", phi, ctx_irn));
 
+       /* build a new PhiM */
+       NEW_ARR_A(ir_node *, ins, n);
+       for (i = 0; i < n; ++i) {
+               ins[i] = new_r_Bad(irg);
+       }
+       phi_spill = new_r_Phi(senv->chordal_env->irg, bl, n, ins, mode_M);
+       key.phi   = phi;
+       key.spill = phi_spill;
+       set_insert(already_visited_phis, &key, sizeof(key), HASH_PTR(phi));
+       bitset_set(bs, get_irn_idx(phi));
+
        /* search an existing spill for this context */
        ctx = be_get_spill_ctx(senv->spill_ctxs, phi, ctx_irn);
 
        /* if not found spill the phi */
-       if(!ctx->spill) {
-               /* build a new PhiM with dummy in-array */
-    NEW_ARR_A(ir_node *, ins, n);
-               for(i=0; i<n; ++i)
-                       ins[i] = new_r_Unknown(irg, mode_M);
-               ctx->spill = new_r_Phi(senv->chordal_env->irg, bl, n, ins, mode_M);
-
-               /* re-wire the phiM */
-               for(i=0; i<n; ++i) {
+       if (! ctx->spill) {
+               /* collect all arguments of the phi */
+               for (i = 0; i < n; ++i) {
                        ir_node *arg = get_irn_n(phi, i);
                        ir_node *sub_res;
-
-                       if(is_Phi(arg) && pset_find_ptr(senv->mem_phis, arg))
-                               sub_res = be_spill_phi(senv, arg, ctx_irn);
+                       phi_spill_assoc_t *entry;
+
+                       if(is_Phi(arg) && pset_find_ptr(senv->mem_phis, arg)) {
+                               if (! bitset_is_set(bs, get_irn_idx(arg)))
+                                       sub_res = be_spill_phi(senv, arg, ctx_irn, already_visited_phis, bs);
+                               else {
+                                       /* we already visited the argument phi: get it's spill */
+                                       key.phi   = arg;
+                                       key.spill = NULL;
+                                       entry     = set_find(already_visited_phis, &key, sizeof(key), HASH_PTR(arg));
+                                       assert(entry && "argument phi already visited, but no spill found?!?");
+                                       sub_res   = entry->spill;
+                                       assert(sub_res && "spill missing?!?");
+                               }
+                       }
                        else
                                sub_res = be_spill_irn(senv, arg, ctx_irn);
 
-                       set_irn_n(ctx->spill, i, sub_res);
+                       set_irn_n(phi_spill, i, sub_res);
                }
+
+               ctx->spill = phi_spill;
        }
        return ctx->spill;
 }
 
+/**
+ * Spill a node.
+ *
+ * @param senv      the spill environment
+ * @param to_spill  the node that should be spilled
+ *
+ * @return a be_Spill node
+ */
 static ir_node *be_spill_node(spill_env_t *senv, ir_node *to_spill) {
-       ir_node *res;
+       ir_graph *irg                  = get_irn_irg(to_spill);
+       set      *already_visited_phis = new_set(cmp_phi_spill_assoc, 10);
+       ir_node  *res;
+       bitset_t *bs = bitset_alloca(get_irg_last_idx(irg));
+
        if (pset_find_ptr(senv->mem_phis, to_spill))
-               res = be_spill_phi(senv, to_spill, to_spill);
+               res = be_spill_phi(senv, to_spill, to_spill, already_visited_phis, bs);
        else
                res = be_spill_irn(senv, to_spill, to_spill);
 
        return res;
 }
 
-static void phi_walker(ir_node *irn, void *env) {
-       spill_env_t *senv = env;
-       const arch_env_t *arch = senv->chordal_env->birg->main_env->arch_env;
-
-       if (is_Phi(irn) && arch_irn_has_reg_class(arch, irn, 0, senv->cls)
-                       && senv->is_mem_phi(irn, senv->data)) {
-               DBG((senv->dbg, LEVEL_1, "  %+F\n", irn));
-               pset_insert_ptr(senv->mem_phis, irn);
-       }
-}
-
 #ifdef REMAT
 
 #ifdef BUGGY_REMAT
 
+/**
+ * Check if a spilled node could be rematerialized.
+ *
+ * @param senv      the spill environment
+ * @param spill     the Spill node
+ * @param spilled   the node that was spilled
+ * @param reloader  a irn that requires a reload
+ */
 static int check_remat_conditions(spill_env_t *senv, ir_node *spill, ir_node *spilled, ir_node *reloader) {
        int pos, max;
 
@@ -243,6 +335,14 @@ is_alive:  ;
 
 #else /* BUGGY_REMAT */
 
+/**
+ * A very simple rematerialization checker.
+ *
+ * @param senv      the spill environment
+ * @param spill     the Spill node
+ * @param spilled   the node that was spilled
+ * @param reloader  a irn that requires a reload
+ */
 static int check_remat_conditions(spill_env_t *senv, ir_node *spill, ir_node *spilled, ir_node *reloader) {
        const arch_env_t *aenv = senv->chordal_env->birg->main_env->arch_env;
 
@@ -253,6 +353,15 @@ static int check_remat_conditions(spill_env_t *senv, ir_node *spill, ir_node *sp
 
 #endif /* BUGGY_REMAT */
 
+#endif /* REMAT */
+
+/**
+ * Re-materialize a node.
+ *
+ * @param senv      the spill environment
+ * @param spilled   the node that was spilled
+ * @param reloader  a irn that requires a reload
+ */
 static ir_node *do_remat(spill_env_t *senv, ir_node *spilled, ir_node *reloader) {
        ir_node *res;
        ir_node *bl = (is_Block(reloader)) ? reloader : get_nodes_block(reloader);
@@ -262,7 +371,7 @@ static ir_node *do_remat(spill_env_t *senv, ir_node *spilled, ir_node *reloader)
                get_irn_op(spilled),
                get_irn_mode(spilled),
                get_irn_arity(spilled),
-               get_irn_in(spilled));
+               get_irn_in(spilled) + 1);
        copy_node_attr(spilled, res);
 
        DBG((senv->dbg, LEVEL_1, "Insert remat %+F before reloader %+F\n", res, reloader));
@@ -278,9 +387,24 @@ static ir_node *do_remat(spill_env_t *senv, ir_node *spilled, ir_node *reloader)
        return res;
 }
 
-#endif
+/**
+ * Walker: fills the mem_phis set by evaluating Phi nodes
+ * using the is_spilled_phi() callback.
+ */
+static void phi_walker(ir_node *irn, void *env) {
+       spill_env_t *senv = env;
 
-void be_insert_spills_reloads(spill_env_t *senv, pset *reload_set) {
+       if (is_Phi(irn)) {
+               const arch_env_t *arch = senv->chordal_env->birg->main_env->arch_env;
+               if (arch_irn_has_reg_class(arch, irn, 0, senv->cls) &&
+                       senv->is_spilled_phi(irn, senv->data)) {
+                       DBG((senv->dbg, LEVEL_1, "  %+F\n", irn));
+                       pset_insert_ptr(senv->mem_phis, irn);
+               }
+       }
+}
+
+void be_insert_spills_reloads(spill_env_t *senv) {
        const arch_env_t *aenv = senv->chordal_env->birg->main_env->arch_env;
        ir_graph *irg          = senv->chordal_env->irg;
        ir_node *irn;
@@ -312,6 +436,7 @@ void be_insert_spills_reloads(spill_env_t *senv, pset *reload_set) {
        for(si = set_first(senv->spills); si; si = set_next(senv->spills)) {
                reloader_t *rld;
                ir_mode *mode = get_irn_mode(si->spilled_node);
+               //ir_node *value;
                pset *values = pset_new_ptr(16);
 
                /* go through all reloads for this spill */
@@ -322,8 +447,10 @@ void be_insert_spills_reloads(spill_env_t *senv, pset *reload_set) {
                        ir_node *spill   = be_spill_node(senv, si->spilled_node);
 
 #ifdef REMAT
-                       if (check_remat_conditions(senv, spill, si->spilled_node, rld->reloader))
+                       if (check_remat_conditions(senv, spill, si->spilled_node, rld->reloader)) {
                                new_val = do_remat(senv, si->spilled_node, rld->reloader);
+                               //pdeq_putl(possibly_dead, spill);
+                       }
                        else
 #endif
                                /* do a reload */
@@ -331,8 +458,6 @@ void be_insert_spills_reloads(spill_env_t *senv, pset *reload_set) {
 
                        DBG((senv->dbg, LEVEL_1, " %+F of %+F before %+F\n", new_val, si->spilled_node, rld->reloader));
                        pset_insert_ptr(values, new_val);
-                       if(reload_set)
-                               pset_insert_ptr(reload_set, new_val);
                }
 
                /* introduce copies, rewire the uses */
@@ -343,14 +468,11 @@ void be_insert_spills_reloads(spill_env_t *senv, pset *reload_set) {
                del_pset(values);
        }
 
-       for(irn = pset_first(senv->mem_phis); irn; irn = pset_next(senv->mem_phis)) {
-               int i, n;
-               for(i = 0, n = get_irn_arity(irn); i < n; ++i)
-                       set_irn_n(irn, i, new_r_Bad(senv->chordal_env->irg));
-               sched_remove(irn);
-       }
-
        del_pset(senv->mem_phis);
+
+       // reloads are placed now, but we might reuse the spill environment for further spilling decisions
+       del_set(senv->spills);
+       senv->spills = new_set(cmp_spillinfo, 1024);
 }
 
 void be_add_reload(spill_env_t *senv, ir_node *to_spill, ir_node *before) {
@@ -435,7 +557,7 @@ static void compute_spill_slots_walker(ir_node *spill, void *env) {
                        struct _arch_env_t *arch_env     = ssenv->cenv->birg->main_env->arch_env;
                        const arch_register_class_t *cls = arch_get_irn_reg_class(arch_env, spill, be_pos_Spill_val);
                        int size = get_mode_size_bytes(arch_register_class_mode(cls));
-                       assert(ss->size == size && "Different sizes for the same spill slot are not allowed.");
+                       assert((int) ss->size == size && "Different sizes for the same spill slot are not allowed.");
                        for (irn = pset_first(ss->members); irn; irn = pset_next(ss->members)) {
                                /* use values_interfere here, because it uses the dominance check,
                                         which does work for values in memory */
@@ -452,9 +574,9 @@ static void compute_spill_slots_walker(ir_node *spill, void *env) {
  * qsort compare function, sort spill slots by size.
  */
 static int ss_sorter(const void *v1, const void *v2) {
-       const spill_slot_t *ss1 = v1;
-       const spill_slot_t *ss2 = v2;
-       return ((int) ss2->size) - ((int) ss1->size);
+       const spill_slot_t **ss1 = (const spill_slot_t **)v1;
+       const spill_slot_t **ss2 = (const spill_slot_t **)v2;
+       return ((int) (*ss2)->size) - ((int) (*ss1)->size);
 }
 
 
@@ -469,7 +591,7 @@ static int ss_sorter(const void *v1, const void *v2) {
  *
  * @return An array of spill slots @p ass in specific order
  **/
-static void optimize_slots(ss_env_t *ssenv, int size, spill_slot_t **ass) {
+static void optimize_slots(ss_env_t *ssenv, int size, spill_slot_t *ass[]) {
        int i, o, used_slots;
        pmap_entry *entr;