don't call be_spill_phis for phis of other reg classes
[libfirm] / ir / be / bespillmorgan.c
index db86172..b30ea6e 100644 (file)
@@ -14,6 +14,7 @@
 #include "bechordal_t.h"
 #include "bespill.h"
 #include "belive_t.h"
+#include "beabi.h"
 #include "irgwalk.h"
 #include "besched.h"
 #include "beutil.h"
 
 #include "bespillbelady.h"
 #include "beverify.h"
+#include "benodesets.h"
+#include "bespilloptions.h"
 
 #define DBG_LIVE               1
 #define DBG_LOOPANA            2
 #define DBG_PRESSURE   4
+#define DBG_SPILLS      8
+#define DBG_CHOOSE             16
 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
 
 typedef struct morgan_env {
-       const be_chordal_env_t *cenv;
        const arch_env_t *arch;
        const arch_register_class_t *cls;
        ir_graph *irg;
+       const be_lv_t *lv;
        struct obstack obst;
        /** maximum safe register pressure */
        int registers_available;
@@ -58,7 +63,7 @@ typedef struct loop_attr {
        bitset_t *livethrough_unused;
 } loop_attr_t;
 
-typedef struct block_attr {
+typedef struct morgan_block_attr {
        const ir_node *block;
        /** set of all values that are live in the block but not used in the block */
        bitset_t *livethrough_unused;
@@ -88,15 +93,19 @@ static int block_attr_cmp(const void *e1, const void *e2, size_t s) {
 }
 
 static INLINE int loop_attr_hash(const loop_attr_t *a) {
+#ifdef DEBUG_libfirm
+       return a->loop->loop_nr;
+#else
        return HASH_PTR(a->loop);
+#endif
 }
 
 static INLINE int block_attr_hash(const block_attr_t *b) {
-       return HASH_PTR(b->block);
+       return nodeset_hash(b->block);
 }
 
 static INLINE int loop_edge_hash(const loop_edge_t *e) {
-       return HASH_PTR(e->block) ^ (e->pos * 31);
+       return nodeset_hash(e->block) ^ (e->pos * 31);
 }
 
 static INLINE loop_attr_t *get_loop_attr(morgan_env_t *env, const ir_loop *loop) {
@@ -127,7 +136,7 @@ static INLINE block_attr_t *get_block_attr(morgan_env_t *env, const ir_node *blo
        res = set_find(env->block_attr_set, &b_attr, sizeof(b_attr), hash);
 
        if(res == NULL) {
-               b_attr.livethrough_unused = bitset_obstack_alloc(&env->obst, get_irg_last_idx(env->irg));
+               b_attr.livethrough_unused = NULL;
                res = set_insert(env->block_attr_set, &b_attr, sizeof(b_attr), hash);
        }
 
@@ -144,71 +153,63 @@ static INLINE int consider_for_spilling(const arch_env_t *env, const arch_regist
 }
 
 /**
- * Determine edges going out of a loop (= edges that go to a block that is not inside
- * the loop or one of its subloops)
+ * Determine edges going out of a loop (= edges that go to a block that is not
+ * inside the loop or one of its subloops)
  */
-static INLINE void construct_loop_edges(ir_node* block, void* e) {
-       morgan_env_t *env = (morgan_env_t*) e;
+static INLINE void construct_loop_edges(ir_node *block, void *data) {
+       morgan_env_t *env = data;
        int n_cfgpreds = get_Block_n_cfgpreds(block);
        int i;
        ir_loop* loop = get_irn_loop(block);
-       loop_attr_t *loop_attr = get_loop_attr(env, loop);
        DBG((dbg, DBG_LOOPANA, "Loop for %+F: %d (depth %d)\n", block, loop->loop_nr, loop->depth));
 
        for(i = 0; i < n_cfgpreds; ++i) {
+               loop_edge_t edge;
+               int hash;
                ir_node* cfgpred = get_Block_cfgpred(block, i);
                ir_node* cfgpred_block = get_nodes_block(cfgpred);
                ir_loop* cfgpred_loop = get_irn_loop(cfgpred_block);
-               loop_attr_t *outedges = get_loop_attr(env, cfgpred_loop);
 
                if(cfgpred_loop == loop)
                        continue;
 
-               // is it an edge into the loop?
-               if(get_loop_depth(loop) > get_loop_depth(cfgpred_loop)) {
-                       loop_edge_t edge;
-                       edge.block = block;
-                       edge.pos = i;
-                       DBG((dbg, DBG_LOOPANA, "Loop in edge from %+F (loop %d) to %+F (loop %d)\n", cfgpred_block, get_loop_loop_nr(cfgpred_loop), block, get_loop_loop_nr(loop)));
-                       set_insert(loop_attr->in_edges, &edge, sizeof(edge), loop_edge_hash(&edge));
-               } else {
-                       ir_loop *p_loop = cfgpred_loop;
-                       while(get_loop_depth(p_loop) > get_loop_depth(loop)) {
-                               p_loop = get_loop_outer_loop(p_loop);
-                       }
-                       if(p_loop != loop) {
-                               loop_edge_t edge;
-                               edge.block = block;
-                               edge.pos = i;
-                               DBG((dbg, DBG_LOOPANA, "Loop in edge from %+F (loop %d) to %+F (loop %d)\n", cfgpred_block, get_loop_loop_nr(cfgpred_loop), block, get_loop_loop_nr(loop)));
-                               set_insert(loop_attr->in_edges, &edge, sizeof(edge), loop_edge_hash(&edge));
-                       }
-               }
+               assert(get_loop_depth(cfgpred_loop) != get_loop_depth(loop));
 
-               // an edge out of the loop?
-               if(get_loop_depth(cfgpred_loop) >= get_loop_depth(loop)) {
-                       loop_edge_t edge;
-                       edge.block = block;
-                       edge.pos = i;
-                       DBG((dbg, DBG_LOOPANA, "Loop out edge from %+F (loop %d) to %+F\n", cfgpred_block, cfgpred_loop->loop_nr, block));
-                       set_insert(outedges->out_edges, &edge, sizeof(edge), loop_edge_hash(&edge));
+               edge.block = block;
+               edge.pos = i;
+               hash = loop_edge_hash(&edge);
+
+               // edge out of a loop?
+               if(get_loop_depth(cfgpred_loop) > get_loop_depth(loop)) {
+                       ir_loop *l;
+
+                       DBG((dbg, DBG_LOOPANA, "Loop out edge from %+F (loop %d) to %+F (loop %d)\n", block, get_loop_loop_nr(loop),
+                            cfgpred_block, get_loop_loop_nr(cfgpred_loop)));
+
+                       /* this might be a jump out of multiple loops, so add this to all
+                    * needed outedge sets */
+                       l = cfgpred_loop;
+                       do {
+                               loop_attr_t *l_attr = get_loop_attr(env, l);
+                               set_insert(l_attr->out_edges, &edge, sizeof(edge), hash);
+
+                               l = get_loop_outer_loop(l);
+                               assert(l != NULL);
+                       } while(l != loop);
                } else {
-                       ir_loop *o_loop = loop;
+                       ir_loop *l;
 
-                       // we might jump in the middle of another inner loop which is not inside
-                       // our loop (happens for irreducible graphs). This would be a
-                       // real out edge then.
-                       while(get_loop_depth(o_loop) > get_loop_depth(cfgpred_loop)) {
-                               o_loop = get_loop_outer_loop(o_loop);
-                       }
+                       // edge into a loop
+                       DBG((dbg, DBG_LOOPANA, "Loop in edge from %+F (loop %d) to %+F (loop %d)\n", block, get_loop_loop_nr(loop),
+                            cfgpred_block, get_loop_loop_nr(cfgpred_loop)));
 
-                       if(cfgpred_loop != o_loop) {
-                               loop_edge_t edge;
-                               edge.block = block;
-                               edge.pos = i;
-                               DBG((dbg, DBG_LOOPANA, "Loop out edge from %+F (loop %d) to %+F (into jump)\n", cfgpred_block, cfgpred_loop->loop_nr, block));
-                               set_insert(outedges->out_edges, &edge, sizeof(edge), loop_edge_hash(&edge));
-                       }
+                       l = loop;
+                       do {
+                               loop_attr_t *l_attr = get_loop_attr(env, l);
+                               set_insert(l_attr->in_edges, &edge, sizeof(edge), hash);
+
+                               l = get_loop_outer_loop(l);
+                       } while(l != cfgpred_loop);
                }
        }
 }
@@ -222,6 +223,7 @@ static void free_loop_edges(morgan_env_t *env) {
        }
 }
 
+#if 0
 /**
  * Debugging help, shows all nodes in a (node-)bitset
  */
@@ -230,29 +232,60 @@ static void show_nodebitset(ir_graph* irg, const bitset_t* bitset) {
 
        bitset_foreach(bitset, i) {
                ir_node* node = get_idx_irn(irg, i);
-               DBG((dbg, DBG_LIVE, "\t%+F\n", node));
+               ir_fprintf(stderr, " %+F", node);
        }
+       fprintf(stderr, "\n");
 }
+#endif
 
-/**
- * Construct the livethrough unused set for a block
- */
-static bitset_t *construct_block_livethrough_unused(morgan_env_t* env, const ir_node* block) {
-       block_attr_t *block_attr = get_block_attr(env, block);
-       ir_node *node;
+static INLINE void init_livethrough_unuseds(block_attr_t *attr, morgan_env_t *env) {
+       const ir_node *block;
        int i;
+       const be_lv_t *lv = env->lv;
+
+       if(attr->livethrough_unused != NULL)
+               return;
+
+       block = attr->block;
+
+       attr->livethrough_unused = bitset_obstack_alloc(&env->obst, get_irg_last_idx(env->irg));
 
-       DBG((dbg, DBG_LIVE, "Processing block %d\n", get_irn_node_nr(block)));
        // copy all live-outs into the livethrough_unused set
-       be_lv_foreach(env->cenv->lv, block, be_lv_state_in | be_lv_state_out, i) {
-               ir_node *irn = be_lv_get_irn(env->cenv->lv, block, i);
+       be_lv_foreach(lv, block, be_lv_state_in | be_lv_state_out, i) {
+               ir_node *irn = be_lv_get_irn(lv, block, i);
                int node_idx;
 
                if(!consider_for_spilling(env->arch, env->cls, irn))
                        continue;
 
                node_idx = get_irn_idx(irn);
-               bitset_set(block_attr->livethrough_unused, node_idx);
+               bitset_set(attr->livethrough_unused, node_idx);
+       }
+}
+
+/**
+ * Construct the livethrough unused set for a block
+ */
+static void construct_block_livethrough_unused(ir_node *block, void *data) {
+       morgan_env_t* env = data;
+       block_attr_t *block_attr = get_block_attr(env, block);
+       ir_node *node;
+       int n_cfgpreds;
+       block_attr_t **pred_attrs = NULL;
+       int i;
+
+       init_livethrough_unuseds(block_attr, env);
+
+       DBG((dbg, DBG_LIVE, "Processing block %d\n", get_irn_node_nr(block)));
+
+       n_cfgpreds = get_Block_n_cfgpreds(block);
+       if(n_cfgpreds > 1) {
+               pred_attrs = alloca(sizeof(pred_attrs[0]) * n_cfgpreds);
+               for(i = 0; i < n_cfgpreds; ++i) {
+                       ir_node *pred_block = get_Block_cfgpred_block(block, i);
+                       pred_attrs[i] = get_block_attr(env, pred_block);
+                       init_livethrough_unuseds(pred_attrs[i], env);
+               }
        }
 
        /*
@@ -262,14 +295,24 @@ static bitset_t *construct_block_livethrough_unused(morgan_env_t* env, const ir_
        sched_foreach(block, node) {
                int i, arity;
 
-               for(i = 0, arity = get_irn_arity(node); i < arity; ++i) {
-                       int idx = get_irn_idx(get_irn_n(node, i));
-                       bitset_clear(block_attr->livethrough_unused, idx);
+               // phis are really uses in the pred block
+               if(is_Phi(node)) {
+                       int j;
+                       for(j = 0; j < n_cfgpreds; ++j) {
+                               ir_node *used_value = get_Phi_pred(node, j);
+                               int idx = get_irn_idx(used_value);
+                               block_attr_t *pred_attr = pred_attrs[j];
+
+                               bitset_clear(pred_attr->livethrough_unused, idx);
+                       }
+               } else {
+                       // mark all used values as used
+                       for(i = 0, arity = get_irn_arity(node); i < arity; ++i) {
+                               int idx = get_irn_idx(get_irn_n(node, i));
+                               bitset_clear(block_attr->livethrough_unused, idx);
+                       }
                }
        }
-
-       show_nodebitset(env->irg, block_attr->livethrough_unused);
-       return block_attr->livethrough_unused;
 }
 
 /**
@@ -285,9 +328,13 @@ static bitset_t *construct_loop_livethrough_unused(morgan_env_t *env, const ir_l
                loop_element elem = get_loop_element(loop, i);
                switch (*elem.kind) {
                case k_ir_node: {
-                       bitset_t *livethrough_block_unused;
+                       ir_node *block = elem.node;
+                       block_attr_t *block_attr = get_block_attr(env, block);
+                       bitset_t *livethrough_block_unused = block_attr->livethrough_unused;
+
                        assert(is_Block(elem.node));
-                       livethrough_block_unused = construct_block_livethrough_unused(env, elem.node);
+                       assert(livethrough_block_unused != NULL);
+
                        if(i == 0) {
                                bitset_copy(loop_attr->livethrough_unused, livethrough_block_unused);
                        } else {
@@ -322,13 +369,11 @@ static bitset_t *construct_loop_livethrough_unused(morgan_env_t *env, const ir_l
                        bitset_andnot(son_attr->livethrough_unused, loop_attr->livethrough_unused);
 
                        DBG((dbg, DBG_LIVE, "Livethroughs for loop %d:\n", loop->loop_nr));
-                       show_nodebitset(env->irg, son_attr->livethrough_unused);
                } else if(*elem.kind == k_ir_node) {
                        block_attr_t *block_attr = get_block_attr(env, elem.node);
                        bitset_andnot(block_attr->livethrough_unused, loop_attr->livethrough_unused);
 
                        DBG((dbg, DBG_LIVE, "Livethroughs for block %+F\n", elem.node));
-                       show_nodebitset(env->irg, block_attr->livethrough_unused);
                } else {
                        assert(0);
                }
@@ -339,13 +384,68 @@ static bitset_t *construct_loop_livethrough_unused(morgan_env_t *env, const ir_l
 
 /*---------------------------------------------------------------------------*/
 
+typedef struct _spillcandidate_t {
+       ir_node *node;
+       int cost;
+} spillcandidate_t;
+
+static int compare_spillcandidates(const void *d1, const void *d2) {
+       const spillcandidate_t *cand1 = d1;
+       const spillcandidate_t *cand2 = d2;
+
+       return cand1->cost - cand2->cost;
+}
+
+static void spill_values(morgan_env_t *env, const loop_attr_t *loop_attr, int spills) {
+       const bitset_t *cand_bitset = loop_attr->livethrough_unused;
+       int candidatecount = bitset_popcnt(cand_bitset);
+       spillcandidate_t *candidates;
+       int i, c;
+       loop_edge_t *edge;
+
+       assert(spills <= candidatecount);
+
+       candidates = alloca(sizeof(candidates[0]) * candidatecount);
+
+       DBG((dbg, DBG_CHOOSE, "Candidates for loop %d\n", get_loop_loop_nr(loop_attr->loop)));
+       // build candidiatelist
+       c = 0;
+       bitset_foreach(cand_bitset, i) {
+               ir_node *node = get_idx_irn(env->irg, i);
+               candidates[c].node = node;
+               candidates[c].cost = 0;
+
+               for(edge = set_first(loop_attr->out_edges); edge != NULL; edge = set_next(loop_attr->out_edges)) {
+                       candidates[c].cost += be_get_reload_costs_on_edge(env->senv, node, edge->block, edge->pos);
+               }
+               DBG((dbg, DBG_CHOOSE, "%+F has costs %d\n", node, candidates[c].cost));
+
+               c++;
+       }
+       assert(c == candidatecount);
+
+       // sort list
+       qsort(candidates, candidatecount, sizeof(candidates[0]), compare_spillcandidates);
+
+       // spill values
+       for(i = 0; i < spills; ++i) {
+               ir_node *to_spill = candidates[i].node;
+               DBG((dbg, DBG_CHOOSE, "Spilling %+F ", to_spill));
+
+               for(edge = set_first(loop_attr->out_edges); edge != NULL; edge = set_next(loop_attr->out_edges)) {
+                       be_add_reload_on_edge(env->senv, to_spill, edge->block, edge->pos, env->cls, 1);
+               }
+       }
+}
+
 static int reduce_register_pressure_in_block(morgan_env_t *env, const ir_node* block, int loop_unused_spills_possible) {
        ir_node *node;
        int max_pressure;
        int loop_unused_spills_needed;
        pset *live_nodes = pset_new_ptr_default();
+       const be_lv_t *lv = env->lv;
 
-       be_liveness_end_of_block(env->cenv->lv, env->arch, env->cls, block, live_nodes);
+       be_liveness_end_of_block(lv, env->arch, env->cls, block, live_nodes);
        max_pressure = pset_count(live_nodes);
 
        DBG((dbg, DBG_LIVE, "Reduce pressure to %d In Block %+F:\n", env->registers_available, block));
@@ -366,8 +466,6 @@ static int reduce_register_pressure_in_block(morgan_env_t *env, const ir_node* b
        }
        del_pset(live_nodes);
 
-       DBG((dbg, DBG_PRESSURE, "\tMax Pressure in %+F: %d\n", block, max_pressure));
-
        loop_unused_spills_needed = max_pressure - env->registers_available;
 
        if(loop_unused_spills_needed < 0) {
@@ -376,7 +474,8 @@ static int reduce_register_pressure_in_block(morgan_env_t *env, const ir_node* b
                loop_unused_spills_needed = loop_unused_spills_possible;
        }
 
-       DBG((dbg, DBG_PRESSURE, "Unused spills for Block %+F needed: %d\n", block, loop_unused_spills_needed));
+       DBG((dbg, DBG_PRESSURE, "Block %+F: max-pressure %d spills possible: %d spills used: %d\n",
+                block, max_pressure, loop_unused_spills_possible, loop_unused_spills_needed));
        return loop_unused_spills_needed;
 }
 
@@ -422,8 +521,7 @@ static int reduce_register_pressure_in_loop(morgan_env_t *env, const ir_loop *lo
     }
 
        /* calculate number of spills needed in outer loop and spill
-        * unused livethrough nodes around this loop
-        */
+        * unused livethrough nodes around this loop */
        if(spills_needed > outer_spills_possible) {
                int spills_to_place;
                outer_spills_needed = outer_spills_possible;
@@ -431,20 +529,10 @@ static int reduce_register_pressure_in_loop(morgan_env_t *env, const ir_loop *lo
 
                spills_to_place = spills_needed;
 
-               bitset_foreach(loop_attr->livethrough_unused, i) {
-                       loop_edge_t *edge;
-                       ir_node *to_spill = get_idx_irn(env->irg, i);
+               DBG((dbg, DBG_SPILLS, "%d values unused in loop %d, spilling %d\n",
+                spills_possible - outer_spills_possible, loop->loop_nr, spills_to_place));
 
-                       for(edge = set_first(loop_attr->out_edges); edge != NULL; edge = set_next(loop_attr->out_edges)) {
-                               DBG((dbg, DBG_PRESSURE, "Spilling node %+F around loop %d\n", to_spill, loop->loop_nr));
-                               be_add_reload_on_edge(env->senv, to_spill, edge->block, edge->pos);
-                       }
-
-                       spills_to_place--;
-                       if(spills_to_place <= 0) {
-                               break;
-                       }
-               }
+               spill_values(env, loop_attr, spills_to_place);
        } else {
                outer_spills_needed = spills_needed;
        }
@@ -452,64 +540,74 @@ static int reduce_register_pressure_in_loop(morgan_env_t *env, const ir_loop *lo
        return outer_spills_needed;
 }
 
-void be_spill_morgan(be_chordal_env_t *chordal_env) {
+void be_spill_morgan(be_irg_t *birg, const arch_register_class_t *cls) {
+       ir_graph *irg = be_get_birg_irg(birg);
        morgan_env_t env;
 
-       FIRM_DBG_REGISTER(dbg, "ir.be.spillmorgan");
-       //firm_dbg_set_mask(dbg, DBG_LOOPANA | DBG_PRESSURE);
+       be_assure_liveness(birg);
 
-       env.cenv = chordal_env;
-       env.arch = chordal_env->birg->main_env->arch_env;
-       env.irg = chordal_env->irg;
-       env.cls = chordal_env->cls;
-       env.senv = be_new_spill_env(chordal_env);
+       env.arch = birg->main_env->arch_env;
+       env.irg = irg;
+       env.cls = cls;
+       env.lv = be_get_birg_liveness(birg);
+       env.senv = be_new_spill_env(birg);
        DEBUG_ONLY(be_set_spill_env_dbg_module(env.senv, dbg);)
 
        obstack_init(&env.obst);
 
-       env.registers_available = arch_count_non_ignore_regs(env.arch, env.cls);
+       env.registers_available = env.cls->n_regs - be_put_ignore_regs(birg, env.cls, NULL);
 
        env.loop_attr_set = new_set(loop_attr_cmp, 5);
        env.block_attr_set = new_set(block_attr_cmp, 20);
 
        /*-- Part1: Analysis --*/
-       be_liveness_recompute(chordal_env->lv);
 
        /* construct control flow loop tree */
-       construct_cf_backedges(chordal_env->irg);
+       if(! (get_irg_loopinfo_state(irg) & loopinfo_cf_consistent)) {
+               construct_cf_backedges(irg);
+       }
 
        /* construct loop out edges and livethrough_unused sets for loops and blocks */
-       irg_block_walk_graph(chordal_env->irg, NULL, construct_loop_edges, &env);
-       construct_loop_livethrough_unused(&env, get_irg_loop(env.irg));
+       irg_block_walk_graph(irg, construct_block_livethrough_unused, construct_loop_edges, &env);
+       construct_loop_livethrough_unused(&env, get_irg_loop(irg));
 
        /*-- Part2: Transformation --*/
 
        /* spill unused livethrough values around loops and blocks where
         * the pressure is too high
         */
-       reduce_register_pressure_in_loop(&env, get_irg_loop(env.irg), 0);
+       reduce_register_pressure_in_loop(&env, get_irg_loop(irg), 0);
 
        /* Insert real spill/reload nodes and fix usages */
        be_insert_spills_reloads(env.senv);
 
        /* Verify the result */
-       if (chordal_env->opts->vrfy_option == BE_CH_VRFY_WARN) {
-               be_verify_schedule(env.irg);
-       } else if (chordal_env->opts->vrfy_option == BE_CH_VRFY_ASSERT) {
-               assert(be_verify_schedule(env.irg));
+       if(birg->main_env->options->vrfy_option == BE_VRFY_WARN) {
+               be_verify_schedule(irg);
+       } else if (birg->main_env->options->vrfy_option == BE_VRFY_ASSERT) {
+               assert(be_verify_schedule(irg));
        }
 
-       if (chordal_env->opts->dump_flags & BE_CH_DUMP_SPILL)
-               be_dump(env.irg, "-spillmorgan", dump_ir_block_graph_sched);
-
        /* cleanup */
        free_loop_edges(&env);
        del_set(env.loop_attr_set);
        del_set(env.block_attr_set);
 
        /* fix the remaining places with too high register pressure with beladies algorithm */
-       be_spill_belady_spill_env(chordal_env, env.senv);
+       be_spill_belady_spill_env(birg, cls, env.senv);
 
        be_delete_spill_env(env.senv);
        obstack_free(&env.obst, NULL);
 }
+
+void be_init_spillmorgan(void)
+{
+       static be_spiller_t morgan_spiller = {
+               be_spill_morgan
+       };
+
+       be_register_spiller("morgan", &morgan_spiller);
+       FIRM_DBG_REGISTER(dbg, "ir.be.spillmorgan");
+}
+
+BE_REGISTER_MODULE_CONSTRUCTOR(be_init_spillmorgan);