added get_next_ir_opcodes() to allow allocation of cosecutive opcodes
[libfirm] / ir / be / bespillbelady.c
index f8566ee..04cf887 100644 (file)
@@ -3,18 +3,31 @@
  * Date:               20.09.2005
  * Copyright:   (c) Universitaet Karlsruhe
  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ *
+ * NOTE: Comments my be (partially) wrong, since there was a major bug
+ *       (spilling of phis, prespill) whose fixing changed a lot.
  */
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
 
+#ifdef HAVE_ALLOCA_H
 #include <alloca.h>
+#endif
+
+#ifdef HAVE_MALLOC_H
+#include <malloc.h>
+#endif
+
 #include "obst.h"
 #include "set.h"
 #include "pset.h"
 #include "irgraph.h"
 #include "irnode.h"
 #include "irmode.h"
-#include "ircons.h"
 #include "irgwalk.h"
 #include "iredges_t.h"
+#include "ircons_t.h"
 
 #include "beutil.h"
 #include "bearch.h"
 #include "beirgmod.h"
 #include "belive_t.h"
 #include "benode_t.h"
+#include "bechordal_t.h"
+
+#define DBG_SPILL   1
+#define DBG_WSETS   2
+#define DBG_FIX     4
+#define DBG_DECIDE  8
+#define DBG_START  16
+#define DBG_SLOTS  32
+#define DBG_TRACE  64
+#define DEBUG_LVL 0 //(DBG_START | DBG_DECIDE | DBG_WSETS | DBG_FIX | DBG_SPILL)
+static firm_dbg_module_t *dbg = NULL;
 
 #define MIN(a,b) (((a)<(b))?(a):(b))
-
-#define DBG_DECIDE 1
-#define DBG_WSETS 2
-#define DBG_FIX 4
-#define DBG_SPILL 8
-#define DBG_START 16
-#define DBG_TRACE 32
-#define DEBUG_LVL (DBG_START | DBG_DECIDE | DBG_WSETS | DBG_FIX | DBG_SPILL)
-static firm_dbg_module_t *dbg = NULL;
+#undef SINGLE_START_PROJS
 
 typedef struct _workset_t workset_t;
 
 typedef struct _belady_env_t {
        struct obstack ob;
-       const be_node_factory_t *factory;
        const arch_env_t *arch;
        const arch_register_class_t *cls;
        int n_regs;                     /** number of regs in this reg-class */
@@ -50,6 +65,7 @@ typedef struct _belady_env_t {
        ir_node *instr;         /**< current instruction */
        unsigned instr_nr;      /**< current instruction number (relative to block start) */
        pset *used;                     /**< holds the values used (so far) in the current BB */
+       pset *copies;           /**< holds all copies placed due to phi-spilling */
 
        spill_env_t *senv;      /* see bespill.h */
        pset *reloads;          /**< all reload nodes placed */
@@ -57,7 +73,7 @@ typedef struct _belady_env_t {
 
 struct _workset_t {
        belady_env_t *bel;
-       int i;                          /**< used for iteration */
+       int i;                          /**< used for iteration TODO remove this form the struct */
        int len;                        /**< current length */
        loc_t vals[1];          /**< inlined array of the values/distances in this working set */
 };
@@ -78,6 +94,9 @@ static INLINE workset_t *new_workset(struct obstack *ob, belady_env_t *bel) {
        return res;
 }
 
+/**
+ * Alloc a new instance on obstack and make it equal to @param ws
+ */
 static INLINE workset_t *workset_clone(struct obstack *ob, workset_t *ws) {
        workset_t *res;
        size_t size = sizeof(*res) + (ws->bel->n_regs-1)*sizeof(res->vals[0]);
@@ -86,16 +105,33 @@ static INLINE workset_t *workset_clone(struct obstack *ob, workset_t *ws) {
        return res;
 }
 
+/**
+ * Do NOT alloc anything. Make @param tgt equal to @param src.
+ * returns @param tgt for convinience
+ */
+static INLINE workset_t *workset_copy(workset_t *tgt, workset_t *src) {
+       size_t size = sizeof(*src) + (src->bel->n_regs-1)*sizeof(src->vals[0]);
+       memcpy(tgt, src, size);
+       return tgt;
+}
+
+/**
+ * Overwrites the current content array of @param ws with the
+ * @param count locations given at memory @param locs.
+ * Set the length of @param ws to count.
+ */
+#define workset_bulk_fill(ws, count, locs) memcpy(&(ws)->vals[0], locs, ((ws)->len=count)*sizeof(locs[0]));
+
+
 /**
  * Inserts the value @p val into the workset, iff it is not
  * already contained. The workset must not be full.
  */
 static INLINE void workset_insert(workset_t *ws, ir_node *val) {
        int i;
-       assert(ws->len < ws->bel->n_regs && "Workset already full!");
        /* check for current regclass */
-       if (arch_get_irn_reg_class(ws->bel->arch, val, 0) != ws->bel->cls) {
-               DBG((dbg, 0, "Dropped %+F\n", val));
+       if (arch_get_irn_reg_class(ws->bel->arch, val, -1) != ws->bel->cls) {
+               DBG((dbg, DBG_DECIDE, "Dropped %+F\n", val));
                return;
        }
 
@@ -105,6 +141,7 @@ static INLINE void workset_insert(workset_t *ws, ir_node *val) {
                        return;
 
        /* insert val */
+       assert(ws->len < ws->bel->n_regs && "Workset already full!");
        ws->vals[ws->len++].irn = val;
 }
 
@@ -115,13 +152,12 @@ static INLINE void workset_insert(workset_t *ws, ir_node *val) {
  */
 static INLINE void workset_bulk_insert(workset_t *ws, int cnt, ir_node **vals) {
        int i, o;
-       assert(ws->len + cnt <= ws->bel->n_regs && "Workset does not have enough room!");
 
        for(o=0; o<cnt; ++o) {
                ir_node *val = vals[o];
                DBG((dbg, DBG_TRACE, "Bulk insert %+F\n", val));
                /* check for current regclass */
-               if (arch_get_irn_reg_class(ws->bel->arch, val, 0) != ws->bel->cls) {
+               if (arch_get_irn_reg_class(ws->bel->arch, val, -1) != ws->bel->cls) {
                        DBG((dbg, DBG_TRACE, "Wrong reg class\n"));
                        goto no_insert;
                }
@@ -134,6 +170,7 @@ static INLINE void workset_bulk_insert(workset_t *ws, int cnt, ir_node **vals) {
                        }
 
                /* insert val */
+               assert(ws->len < ws->bel->n_regs && "Workset does not have enough room!");
                ws->vals[ws->len++].irn = val;
                DBG((dbg, DBG_TRACE, "Inserted\n"));
 
@@ -142,12 +179,6 @@ no_insert:
        }
 }
 
-/**
- * Overwrites the current contents of @p ws with the
- * locations given in @p locs
- */
-#define workset_bulk_fill(ws, count, locs) memcpy(&(ws)->vals[0], locs, ((ws)->len=count)*sizeof(locs[0]));
-
 /**
  * Removes all entries from this workset
  */
@@ -184,49 +215,90 @@ static INLINE int workset_contains(const workset_t *ws, const ir_node *val) {
 #define workset_sort(ws) qsort((ws)->vals, (ws)->len, sizeof((ws)->vals[0]), loc_compare);
 
 
+static int is_mem_phi(const ir_node *irn, void *data) {
+       workset_t *sws;
+       ir_node *blk = get_nodes_block(irn);
+
+       DBG((dbg, DBG_SPILL, "Is %+F a mem-phi?\n", irn));
+       sws = ((block_info_t *) get_irn_link(blk))->ws_start;
+       DBG((dbg, DBG_SPILL, "  %d\n", !workset_contains(sws, irn)));
+       return !workset_contains(sws, irn);
+}
+
 /**
  * Collects all values live-in at block @p blk and all phi results in this block.
- * Then it adds the best values (at most n_regs) to the ws.
+ * Then it adds the best values (at most n_regs) to the blocks start_workset.
+ * The phis among the remaining values get spilled: Introduce psudo-copies of
+ *  their args to break interference and make it possible to spill them to the
+ *  same spill slot.
  */
-static void build_start_set(belady_env_t *bel, ir_node *blk) {
-       workset_t *ws = bel->ws;
+static void compute_block_start_info(ir_node *blk, void *env) {
+       belady_env_t *bel = env;
+       block_info_t *blk_info;
        ir_node *irn, *first;
        irn_live_t *li;
-       int count;
+       int i, count, ws_count;
        loc_t loc, *starters;
+       ir_graph *irg = get_irn_irg(blk);
        struct obstack ob;
 
        obstack_init(&ob);
 
-       /* get all values */
+       /* Get all values living at the block start */
+       DBG((dbg, DBG_START, "Living at start of %+F:\n", blk));
        first = sched_first(blk);
        count = 0;
        sched_foreach(blk, irn)
-               if (is_Phi(irn) && arch_get_irn_reg_class(bel->arch, irn, 0) == bel->cls) {
+               if (is_Phi(irn) && arch_get_irn_reg_class(bel->arch, irn, -1) == bel->cls) {
                        loc.irn = irn;
                        loc.time = be_get_next_use(bel->uses, first, 0, irn, 0);
-                       DBG((dbg, DBG_START, "  %+F next-use %d\n", loc.irn, loc.time));
                        obstack_grow(&ob, &loc, sizeof(loc));
+                       DBG((dbg, DBG_START, "    %+F:\n", irn));
                        count++;
                } else
                        break;
 
        live_foreach(blk, li)
-               if (live_is_in(li) && arch_get_irn_reg_class(bel->arch, li->irn, 0) == bel->cls) {
+               if (live_is_in(li) && arch_get_irn_reg_class(bel->arch, li->irn, -1) == bel->cls) {
                        loc.irn = (ir_node *)li->irn;
                        loc.time = be_get_next_use(bel->uses, first, 0, li->irn, 0);
-                       DBG((dbg, DBG_START, "  %+F next-use %d\n", loc.irn, loc.time));
                        obstack_grow(&ob, &loc, sizeof(loc));
+                       DBG((dbg, DBG_START, "    %+F:\n", irn));
                        count++;
                }
        starters = obstack_finish(&ob);
 
-       /* sort all values */
+       /* Sort all values */
        qsort(starters, count, sizeof(starters[0]), loc_compare);
 
-       /* copy the best ones to the ws */
-       count = MIN(count, ws->bel->n_regs);
-       workset_bulk_fill(ws, count, starters);
+       /* Create the start workset for this block. Copy the best ones from starters */
+       blk_info = obstack_alloc(&bel->ob, sizeof(*blk_info));
+       set_irn_link(blk, blk_info);
+
+       ws_count = MIN(count, bel->n_regs);
+       blk_info->ws_start = new_workset(&bel->ob, bel);
+       workset_bulk_fill(blk_info->ws_start, ws_count, starters);
+
+       /* Spill the phis among the remaining values */
+       for (i=ws_count; i<count; ++i) {
+               int o, max;
+
+               irn = starters[i].irn;
+               if (!is_Phi(irn) || get_nodes_block(irn) != blk)
+                       continue;
+
+               DBG((dbg, DBG_START, "For %+F:\n", irn));
+
+               for (max=get_irn_arity(irn), o=0; o<max; ++o) {
+                       ir_node *arg = get_irn_n(irn, o);
+                       ir_node *pred_block = get_Block_cfgpred_block(get_nodes_block(irn), o);
+                       ir_node *cpy = be_new_Copy(bel->cls, irg, pred_block, arg);
+                       pset_insert_ptr(bel->copies, cpy);
+                       DBG((dbg, DBG_START, "    place a %+F of %+F in %+F\n", cpy, arg, pred_block));
+                       sched_add_before(pred_block, cpy);
+                       set_irn_n(irn, o, cpy);
+               }
+       }
 
        obstack_free(&ob, NULL);
 }
@@ -276,7 +348,7 @@ static void displace(belady_env_t *bel, workset_t *new_vals, int is_usage) {
        if (len > max_allowed) {
                /* get current next-use distance */
                for (i=0; i<ws->len; ++i)
-                       workset_set_time(ws, i, be_get_next_use(bel->uses, bel->instr, bel->instr_nr, workset_get_val(ws, i), is_usage));
+                       workset_set_time(ws, i, be_get_next_use(bel->uses, bel->instr, bel->instr_nr, workset_get_val(ws, i), !is_usage));
 
                /* sort entries by increasing nextuse-distance*/
                workset_sort(ws);
@@ -310,21 +382,21 @@ static void displace(belady_env_t *bel, workset_t *new_vals, int is_usage) {
  * whether it is used from a register or is reloaded
  * before the use.
  */
-static void decide(ir_node *blk, void *env) {
+static void belady(ir_node *blk, void *env) {
        belady_env_t *bel = env;
        workset_t *new_vals;
        ir_node *irn;
-       block_info_t *blk_info = obstack_alloc(&bel->ob, sizeof(*blk_info));
-       set_irn_link(blk, blk_info);
+#ifdef SINGLE_START_PROJS
+       ir_node *start_blk = get_irg_start_block(get_irn_irg(blk));
+#endif
+       block_info_t *blk_info = get_irn_link(blk);
 
        DBG((dbg, DBG_DECIDE, "\n"));
        DBG((dbg, DBG_DECIDE, "Decide for %+F\n", blk));
 
-       /* build starting-workset for this block */
-       build_start_set(bel, blk);
-       blk_info->ws_start = workset_clone(&bel->ob, bel->ws);
+       workset_copy(bel->ws, blk_info->ws_start);
        DBG((dbg, DBG_WSETS, "Initial start workset for %+F:\n", blk));
-       workset_foreach(blk_info->ws_start, irn)
+       workset_foreach(bel->ws, irn)
                DBG((dbg, DBG_WSETS, "  %+F\n", irn));
 
        /* process the block from start to end */
@@ -333,19 +405,26 @@ static void decide(ir_node *blk, void *env) {
        bel->instr_nr = 0;
        new_vals = new_workset(&bel->ob, bel);
        sched_foreach(blk, irn) {
-               ir_node *iii;
-               DBG((dbg, DBG_WSETS, "Current workset for %+F:\n", blk));
-               workset_foreach(bel->ws, iii)
-                       DBG((dbg, DBG_WSETS, "  %+F\n", iii));
                assert(workset_get_length(bel->ws) <= bel->n_regs && "Too much values in workset!");
 
-               DBG((dbg, DBG_DECIDE, "  ...%+F\n", irn));
 
+#ifdef SINGLE_START_PROJS
+               if (is_Phi(irn) ||
+                       (is_Proj(irn) && blk!=start_blk) ||
+                       (get_irn_mode(irn) == mode_T && blk==start_blk)) {
+                       DBG((dbg, DBG_DECIDE, "  ...%+F skipped\n", irn));
+                       continue;
+               }
+#else
                /* projs are handled with the tuple value.
                 * Phis are no real instr (see insert_starters)
                 * instr_nr does not increase */
-               if (is_Proj(irn) || is_Phi(irn))
+               if (is_Proj(irn) || is_Phi(irn)) {
+                       DBG((dbg, DBG_DECIDE, "  ...%+F skipped\n", irn));
                        continue;
+               }
+#endif
+               DBG((dbg, DBG_DECIDE, "  ...%+F\n", irn));
 
                /* set instruction in the workset */
                bel->instr = irn;
@@ -381,18 +460,19 @@ static void decide(ir_node *blk, void *env) {
 }
 
 /**
- * 'decide' is block-local and makes assumtions
+ * 'decide' is block-local and makes assumptions
  * about the set of live-ins. Thus we must adapt the
  * live-outs to the live-ins at each block-border.
  */
 static void fix_block_borders(ir_node *blk, void *env) {
+       workset_t *wsb;
        belady_env_t *bel = env;
        int i, max;
 
        DBG((dbg, DBG_FIX, "\n"));
        DBG((dbg, DBG_FIX, "Fixing %+F\n", blk));
 
-       workset_t *wsb = ((block_info_t *)get_irn_link(blk))->ws_start;
+       wsb = ((block_info_t *)get_irn_link(blk))->ws_start;
 
        /* process all pred blocks */
        for (i=0, max=get_irn_arity(blk); i<max; ++i) {
@@ -407,12 +487,17 @@ static void fix_block_borders(ir_node *blk, void *env) {
                        if(is_Phi(irnb) && blk == get_nodes_block(irnb))
                                irnb = get_irn_n(irnb, i);
 
+                       /* Unknowns are available everywhere */
+                       if(get_irn_opcode(irnb) == iro_Unknown)
+                               continue;
+
                        /* check if irnb is in a register at end of pred */
                        workset_foreach(wsp, irnp)
                                if (irnb == irnp)
                                        goto next_value;
 
                        /* irnb is in memory at the end of pred, so we have to reload it */
+                       DBG((dbg, DBG_FIX, "    reload %+F\n", irnb));
                        be_add_reload_on_edge(bel->senv, irnb, blk, i);
 
 next_value:
@@ -426,50 +511,89 @@ next_value:
  * The remaining nodes in bel->reloads will be removed from the graph.
  */
 static void rescue_used_reloads(ir_node *irn, void *env) {
-       pset *rlds = ((belady_env_t *)env)->reloads;
-       if (pset_find_ptr(rlds, irn)) {
-               DBG((dbg, DBG_SPILL, "Removing %+F in %+F\n", irn, get_nodes_block(irn)));
+       pset *rlds = (pset *)env;
+       if (pset_find_ptr(rlds, irn))
                pset_remove_ptr(rlds, irn);
-       }
 }
 
-static int is_mem_phi(const ir_node *irn, void *data) {
-       ir_node *blk = get_nodes_block(irn);
-       workset_t *sws = ((block_info_t *)get_irn_link(blk))->ws_start;
-       return !workset_contains(sws, irn);
+/**
+ * Removes all copies introduced for phi-spills
+ */
+static void remove_copies(belady_env_t *bel) {
+       ir_node *irn;
+
+       for (irn = pset_first(bel->copies); irn; irn = pset_next(bel->copies)) {
+               ir_node *src, *spill;
+
+               assert(be_is_Copy(irn));
+               assert(get_irn_n_edges(irn) == 1 && "This is not a copy introduced in 'compute_block_start_info()'. Who created it?");
+
+               spill = get_irn_edge(get_irn_irg(irn), irn, 0)->src;
+               assert(be_is_Spill(spill) && "This is not a copy introduced in 'compute_block_start_info()'. Who created it?");
+
+               src = get_irn_n(irn, 0);
+               set_irn_n(spill, 0, src);
+       }
 }
 
-void be_spill_belady(const be_main_session_env_t *session, const arch_register_class_t *cls) {
+/**
+ * Finds all unused reloads and remove them from the schedule
+ * Also removes spills if they are not used anymore after removing reloads
+ */
+static void remove_unused_reloads(ir_graph *irg, belady_env_t *bel) {
        ir_node *irn;
 
+       irg_walk_graph(irg, rescue_used_reloads, NULL, bel->reloads);
+       for(irn = pset_first(bel->reloads); irn; irn = pset_next(bel->reloads)) {
+               ir_node *spill;
+               DBG((dbg, DBG_SPILL, "Removing %+F before %+F in %+F\n", irn, sched_next(irn), get_nodes_block(irn)));
+
+               spill = get_irn_n(irn, 0);
+
+               /* remove reload */
+               set_irn_n(irn, 0, new_Bad());
+               sched_remove(irn);
+
+               /* if spill not used anymore, remove it too
+                * test of regclass is necessary since spill may be a phi-M */
+               if (get_irn_n_edges(spill) == 0 && bel->cls == arch_get_irn_reg_class(bel->arch, spill, -1)) {
+                       set_irn_n(spill, 0, new_Bad());
+                       sched_remove(spill);
+               }
+       }
+}
+
+void be_spill_belady(const be_chordal_env_t *chordal_env) {
+       belady_env_t bel;
+
        dbg = firm_dbg_register("ir.be.spillbelady");
-       firm_dbg_set_mask(dbg, DEBUG_LVL);
 
        /* init belady env */
-       belady_env_t *bel = alloca(sizeof(*bel));
-       obstack_init(&bel->ob);
-       bel->factory = session->main_env->node_factory;
-       bel->arch = session->main_env->arch_env;
-       bel->cls = cls;
-       bel->n_regs = arch_register_class_n_regs(cls);
-       bel->ws = new_workset(&bel->ob, bel);
-       bel->uses = be_begin_uses(session->irg, session->main_env->arch_env, cls);
-       bel->senv = be_new_spill_env(dbg, session, cls);
-       bel->reloads = pset_new_ptr_default();
+       obstack_init(&bel.ob);
+       bel.arch    = chordal_env->main_env->arch_env;
+       bel.cls     = chordal_env->cls;
+       bel.n_regs  = arch_register_class_n_regs(bel.cls);
+       bel.ws      = new_workset(&bel.ob, &bel);
+       bel.uses    = be_begin_uses(chordal_env->irg, chordal_env->main_env->arch_env, bel.cls);
+       bel.senv    = be_new_spill_env(dbg, chordal_env, is_mem_phi, NULL);
+       bel.reloads = pset_new_ptr_default();
+       bel.copies  = pset_new_ptr_default();
+
+       DBG((dbg, LEVEL_1, "running on register class: %s\n", bel.cls->name));
 
        /* do the work */
-       irg_block_walk_graph(session->irg, decide, NULL, bel);
-       irg_block_walk_graph(session->irg, fix_block_borders, NULL, bel);
-       be_insert_spills_reloads(bel->senv, bel->reloads, is_mem_phi, NULL);
+       irg_block_walk_graph(chordal_env->irg, compute_block_start_info, NULL, &bel);
+       irg_block_walk_graph(chordal_env->irg, belady, NULL, &bel);
+       irg_block_walk_graph(chordal_env->irg, fix_block_borders, NULL, &bel);
+       be_insert_spills_reloads(bel.senv, bel.reloads);
+       remove_unused_reloads(chordal_env->irg, &bel);
+       remove_copies(&bel);
+
 
-       /* find all unused reloads and remove them from the schedule */
-       irg_walk_graph(session->irg, rescue_used_reloads, NULL, bel);
-       for(irn = pset_first(bel->reloads); irn; irn = pset_next(bel->reloads))
-               sched_remove(irn);
 
        /* clean up */
-       del_pset(bel->reloads);
-       be_delete_spill_env(bel->senv);
-       be_end_uses(bel->uses);
-       obstack_free(&bel->ob, NULL);
+       del_pset(bel.reloads);
+       be_delete_spill_env(bel.senv);
+       be_end_uses(bel.uses);
+       obstack_free(&bel.ob, NULL);
 }