Add the column to the debug information.
[libfirm] / ir / be / becopyheur4.c
index 77f0338..ad5ca80 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2010 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
@@ -22,7 +22,6 @@
  * @brief       Simple copy minimization heuristics.
  * @author      Christian Wuerdig
  * @date        27.04.2007
- * @version     $Id$
  *
  * This is the C implementation of the mst algorithm
  * originally written in Java by Sebastian Hack.
 #include "irnode_t.h"
 #include "bitset.h"
 #include "raw_bitset.h"
-#include "irphase_t.h"
+#include "irnodemap.h"
 #include "pqueue.h"
 #include "xmalloc.h"
 #include "pdeq.h"
 #include "irprintf.h"
-#include "irbitset.h"
+#include "util.h"
+#include "irtools.h"
 #include "error.h"
 #include "list.h"
 #include "statev.h"
 
-#include "irbitset.h"
-
 #include "bearch.h"
 #include "beifg.h"
 #include "be_t.h"
@@ -82,7 +80,7 @@ typedef float real_t;
 
 static unsigned last_chunk_id   = 0;
 static int recolor_limit        = 7;
-static real_t dislike_influence = REAL(0.1);
+static double dislike_influence = REAL(0.1);
 
 typedef struct col_cost_t {
        int     col;
@@ -118,7 +116,8 @@ typedef struct co_mst_env_t {
        int              n_regs;         /**< number of regs in class */
        int              k;              /**< number of non-ignore registers in class */
        bitset_t         *allocatable_regs; /**< set containing all global ignore registers */
-       ir_phase         ph;             /**< phase object holding data for nodes */
+       ir_nodemap        map;           /**< phase object holding data for nodes */
+       struct obstack    obst;
        pqueue_t         *chunks;        /**< priority queue for chunks */
        list_head         chunklist;     /**< list holding all chunks */
        be_ifg_t         *ifg;           /**< the interference graph */
@@ -143,7 +142,72 @@ typedef struct co_mst_irn_t {
        real_t           constr_factor;
 } co_mst_irn_t;
 
-#define get_co_mst_irn(mst_env, irn) (phase_get_or_set_irn_data(&(mst_env)->ph, (irn)))
+/**
+ * In case there is no phase information for irn, initialize it.
+ */
+static co_mst_irn_t *co_mst_irn_init(co_mst_env_t *env, const ir_node *irn)
+{
+       co_mst_irn_t *res = OALLOC(&env->obst, co_mst_irn_t);
+
+       const arch_register_req_t *req;
+       neighbours_iter_t nodes_it;
+       ir_node  *neigh;
+       unsigned len;
+
+       res->irn           = irn;
+       res->chunk         = NULL;
+       res->fixed         = 0;
+       res->tmp_col       = -1;
+       res->int_neighs    = NULL;
+       res->int_aff_neigh = 0;
+       res->col           = arch_register_get_index(arch_get_irn_register(irn));
+       res->init_col      = res->col;
+       INIT_LIST_HEAD(&res->list);
+
+       DB((dbg, LEVEL_4, "Creating phase info for %+F\n", irn));
+
+       /* set admissible registers */
+       res->adm_colors = bitset_obstack_alloc(&env->obst, env->n_regs);
+
+       /* Exclude colors not assignable to the irn */
+       req = arch_get_irn_register_req(irn);
+       if (arch_register_req_is(req, limited)) {
+               rbitset_copy_to_bitset(req->limited, res->adm_colors);
+       } else {
+               bitset_set_all(res->adm_colors);
+       }
+
+       /* exclude global ignore registers as well */
+       bitset_and(res->adm_colors, env->allocatable_regs);
+
+       /* compute the constraint factor */
+       res->constr_factor = (real_t) (1 + env->n_regs - bitset_popcount(res->adm_colors)) / env->n_regs;
+
+       /* set the number of interfering affinity neighbours to -1, they are calculated later */
+       res->int_aff_neigh = -1;
+
+       /* build list of interfering neighbours */
+       len = 0;
+       be_ifg_foreach_neighbour(env->ifg, &nodes_it, irn, neigh) {
+               if (!arch_irn_is_ignore(neigh)) {
+                       obstack_ptr_grow(&env->obst, neigh);
+                       ++len;
+               }
+       }
+       res->int_neighs = (ir_node**)obstack_finish(&env->obst);
+       res->n_neighs   = len;
+       return res;
+}
+
+static co_mst_irn_t *get_co_mst_irn(co_mst_env_t *env, const ir_node *node)
+{
+       co_mst_irn_t *res = (co_mst_irn_t*)ir_nodemap_get(&env->map, node);
+       if (res == NULL) {
+               res = co_mst_irn_init(env, node);
+               ir_nodemap_insert(&env->map, node, res);
+       }
+       return res;
+}
 
 typedef int decide_func_t(const co_mst_irn_t *node, int col);
 
@@ -171,14 +235,14 @@ static void dbg_aff_chunk(const co_mst_env_t *env, const aff_chunk_t *c)
  */
 static void dbg_admissible_colors(const co_mst_env_t *env, const co_mst_irn_t *node)
 {
-       unsigned idx;
+       size_t idx;
        (void) env;
 
        if (bitset_popcount(node->adm_colors) < 1)
                fprintf(stderr, "no admissible colors?!?");
        else {
                bitset_foreach(node->adm_colors, idx) {
-                       fprintf(stderr, " %d", idx);
+                       ir_fprintf(stderr, " %zu", idx);
                }
        }
 }
@@ -229,8 +293,8 @@ static int decider_always_yes(const co_mst_irn_t *node, int col)
 /** compares two affinity edges by its weight */
 static int cmp_aff_edge(const void *a, const void *b)
 {
-       const aff_edge_t *e1 = a;
-       const aff_edge_t *e2 = b;
+       const aff_edge_t *e1 = (const aff_edge_t*)a;
+       const aff_edge_t *e2 = (const aff_edge_t*)b;
 
        if (e2->weight == e1->weight) {
                if (e2->src->node_idx == e1->src->node_idx)
@@ -245,16 +309,16 @@ static int cmp_aff_edge(const void *a, const void *b)
 /** compares to color-cost pairs */
 static __attribute__((unused)) int cmp_col_cost_lt(const void *a, const void *b)
 {
-       const col_cost_t *c1 = a;
-       const col_cost_t *c2 = b;
+       const col_cost_t *c1 = (const col_cost_t*)a;
+       const col_cost_t *c2 = (const col_cost_t*)b;
        real_t diff = c1->cost - c2->cost;
        return (diff > 0) - (diff < 0);
 }
 
 static int cmp_col_cost_gt(const void *a, const void *b)
 {
-       const col_cost_t *c1 = a;
-       const col_cost_t *c2 = b;
+       const col_cost_t *c1 = (const col_cost_t*)a;
+       const col_cost_t *c2 = (const col_cost_t*)b;
        real_t diff = c2->cost - c1->cost;
 
        if (diff == 0.0)
@@ -369,63 +433,6 @@ static inline void aff_chunk_add_node(aff_chunk_t *c, co_mst_irn_t *node)
        }
 }
 
-/**
- * In case there is no phase information for irn, initialize it.
- */
-static void *co_mst_irn_init(ir_phase *ph, const ir_node *irn)
-{
-       co_mst_irn_t *res = phase_alloc(ph, sizeof(res[0]));
-       co_mst_env_t *env = ph->priv;
-
-       const arch_register_req_t *req;
-       neighbours_iter_t nodes_it;
-       ir_node  *neigh;
-       unsigned len;
-
-       res->irn           = irn;
-       res->chunk         = NULL;
-       res->fixed         = 0;
-       res->tmp_col       = -1;
-       res->int_neighs    = NULL;
-       res->int_aff_neigh = 0;
-       res->col           = arch_register_get_index(arch_get_irn_register(irn));
-       res->init_col      = res->col;
-       INIT_LIST_HEAD(&res->list);
-
-       DB((dbg, LEVEL_4, "Creating phase info for %+F\n", irn));
-
-       /* set admissible registers */
-       res->adm_colors = bitset_obstack_alloc(phase_obst(ph), env->n_regs);
-
-       /* Exclude colors not assignable to the irn */
-       req = arch_get_register_req_out(irn);
-       if (arch_register_req_is(req, limited))
-               rbitset_copy_to_bitset(req->limited, res->adm_colors);
-       else
-               bitset_set_all(res->adm_colors);
-
-       /* exclude global ignore registers as well */
-       bitset_and(res->adm_colors, env->allocatable_regs);
-
-       /* compute the constraint factor */
-       res->constr_factor = (real_t) (1 + env->n_regs - bitset_popcount(res->adm_colors)) / env->n_regs;
-
-       /* set the number of interfering affinity neighbours to -1, they are calculated later */
-       res->int_aff_neigh = -1;
-
-       /* build list of interfering neighbours */
-       len = 0;
-       be_ifg_foreach_neighbour(env->ifg, &nodes_it, irn, neigh) {
-               if (!arch_irn_is_ignore(neigh)) {
-                       obstack_ptr_grow(phase_obst(ph), neigh);
-                       ++len;
-               }
-       }
-       res->int_neighs = obstack_finish(phase_obst(ph));
-       res->n_neighs   = len;
-       return res;
-}
-
 /**
  * Check if affinity chunk @p chunk interferes with node @p irn.
  */
@@ -568,7 +575,7 @@ static void aff_chunk_assure_weight(co_mst_env_t *env, aff_chunk_t *c)
 
                        node->chunk = c;
                        if (node->constr_factor > REAL(0.0)) {
-                               unsigned col;
+                               size_t col;
                                bitset_foreach (node->adm_colors, col)
                                        c->color_affinity[col].cost += node->constr_factor;
                        }
@@ -638,6 +645,7 @@ static void build_affinity_chunks(co_mst_env_t *env)
        ir_node     *n;
        int         i, len;
        aff_chunk_t *curr_chunk;
+       size_t      pn;
 
        /* at first we create the affinity edge objects */
        be_ifg_foreach_node(env->ifg, &nodes_it, n) {
@@ -710,22 +718,24 @@ static void build_affinity_chunks(co_mst_env_t *env)
                pqueue_put(env->chunks, curr_chunk, curr_chunk->weight);
        }
 
-       foreach_phase_irn(&env->ph, n) {
-               co_mst_irn_t *mirn = get_co_mst_irn(env, n);
+       for (pn = 0; pn < ARR_LEN(env->map.data); ++pn) {
+               co_mst_irn_t *mirn = env->map.data[pn];
+               if (mirn == NULL)
+                       continue;
+               if (mirn->chunk != NULL)
+                       continue;
 
-               if (mirn->chunk == NULL) {
-                       /* no chunk is allocated so far, do it now */
-                       aff_chunk_t *curr_chunk = new_aff_chunk(env);
-                       aff_chunk_add_node(curr_chunk, mirn);
+               /* no chunk is allocated so far, do it now */
+               aff_chunk_t *curr_chunk = new_aff_chunk(env);
+               aff_chunk_add_node(curr_chunk, mirn);
 
-                       aff_chunk_assure_weight(env, curr_chunk);
+               aff_chunk_assure_weight(env, curr_chunk);
 
-                       DBG((dbg, LEVEL_1, "entry #%u", curr_chunk->id));
-                       DBG_AFF_CHUNK(env, LEVEL_1, curr_chunk);
-                       DBG((dbg, LEVEL_1, "\n"));
+               DBG((dbg, LEVEL_1, "entry #%u", curr_chunk->id));
+               DBG_AFF_CHUNK(env, LEVEL_1, curr_chunk);
+               DBG((dbg, LEVEL_1, "\n"));
 
-                       pqueue_put(env->chunks, curr_chunk, curr_chunk->weight);
-               }
+               pqueue_put(env->chunks, curr_chunk, curr_chunk->weight);
        }
 
        DEL_ARR_F(edges);
@@ -733,13 +743,13 @@ static void build_affinity_chunks(co_mst_env_t *env)
 
 static __attribute__((unused)) void chunk_order_nodes(co_mst_env_t *env, aff_chunk_t *chunk)
 {
-       pqueue_t *grow = new_pqueue();
-       const ir_node *max_node = NULL;
-       int max_weight = 0;
-       int i;
+       pqueue_t      *grow       = new_pqueue();
+       ir_node const *max_node   = NULL;
+       int            max_weight = 0;
+       size_t         i;
 
-       for (i = ARR_LEN(chunk->n) - 1; i >= 0; i--) {
-               const ir_node   *irn = chunk->n[i];
+       for (i = ARR_LEN(chunk->n); i != 0;) {
+               const ir_node   *irn = chunk->n[--i];
                affinity_node_t *an  = get_affinity_info(env->co, irn);
                int w = 0;
                neighb_t *neigh;
@@ -759,16 +769,16 @@ static __attribute__((unused)) void chunk_order_nodes(co_mst_env_t *env, aff_chu
        }
 
        if (max_node) {
-               bitset_t *visited = bitset_irg_malloc(env->co->irg);
+               bitset_t *visited = bitset_malloc(get_irg_last_idx(env->co->irg));
 
-               for (i = ARR_LEN(chunk->n) - 1; i >= 0; --i)
-                       bitset_add_irn(visited, chunk->n[i]);
+               for (i = ARR_LEN(chunk->n); i != 0;)
+                       bitset_set(visited, get_irn_idx(chunk->n[--i]));
 
                pqueue_put(grow, (void *) max_node, max_weight);
-               bitset_remv_irn(visited, max_node);
+               bitset_clear(visited, get_irn_idx(max_node));
                i = 0;
                while (!pqueue_empty(grow)) {
-                       ir_node *irn = pqueue_pop_front(grow);
+                       ir_node *irn = (ir_node*)pqueue_pop_front(grow);
                        affinity_node_t *an = get_affinity_info(env->co, irn);
                        neighb_t        *neigh;
 
@@ -784,9 +794,9 @@ static __attribute__((unused)) void chunk_order_nodes(co_mst_env_t *env, aff_chu
                        co_gs_foreach_neighb(an, neigh) {
                                co_mst_irn_t *node = get_co_mst_irn(env, neigh->irn);
 
-                               if (bitset_contains_irn(visited, node->irn)) {
+                               if (bitset_is_set(visited, get_irn_idx(node->irn))) {
                                        pqueue_put(grow, (void *) neigh->irn, neigh->costs);
-                                       bitset_remv_irn(visited, node->irn);
+                                       bitset_clear(visited, get_irn_idx(node->irn));
                                }
                        }
                }
@@ -814,7 +824,7 @@ static void expand_chunk_from(co_mst_env_t *env, co_mst_irn_t *node, bitset_t *v
 
        /* as long as there are nodes in the queue */
        while (! waitq_empty(nodes)) {
-               co_mst_irn_t    *n  = waitq_get(nodes);
+               co_mst_irn_t    *n  = (co_mst_irn_t*)waitq_get(nodes);
                affinity_node_t *an = get_affinity_info(env->co, n->irn);
 
                /* check all affinity neighbors */
@@ -864,7 +874,7 @@ static void expand_chunk_from(co_mst_env_t *env, co_mst_irn_t *node, bitset_t *v
  */
 static aff_chunk_t *fragment_chunk(co_mst_env_t *env, int col, aff_chunk_t *c, waitq *tmp)
 {
-       bitset_t    *visited = bitset_irg_malloc(env->co->irg);
+       bitset_t    *visited = bitset_malloc(get_irg_last_idx(env->co->irg));
        int         idx, len;
        aff_chunk_t *best = NULL;
 
@@ -1115,7 +1125,7 @@ static int recolor_nodes(co_mst_env_t *env, co_mst_irn_t *node, col_cost_t *cost
 }
 
 /**
- * Tries to bring node @p node and all it's neighbours to color @p tgt_col.
+ * Tries to bring node @p node and all its neighbours to color @p tgt_col.
  * @return 1 if color @p col could be applied, 0 otherwise
  */
 static int change_node_color(co_mst_env_t *env, co_mst_irn_t *node, int tgt_col, struct list_head *changed)
@@ -1132,7 +1142,7 @@ static int change_node_color(co_mst_env_t *env, co_mst_irn_t *node, int tgt_col,
 
        /*
                Node has not yet a fixed color and target color is admissible
-               -> try to recolor node and it's affinity neighbours
+               -> try to recolor node and its affinity neighbours
        */
        if (is_loose(node) && bitset_is_set(node->adm_colors, tgt_col)) {
                col_cost_t *costs = env->single_cols[tgt_col];
@@ -1180,7 +1190,11 @@ static void color_aff_chunk(co_mst_env_t *env, aff_chunk_t *c)
        waitq       *best_starts  = NULL;
        col_cost_t  *order        = ALLOCANZ(col_cost_t, env->n_regs);
        bitset_t    *visited;
-       int         idx, len, i, nidx, pos;
+       int         i;
+       size_t      idx;
+       size_t      len;
+       size_t      nidx;
+       size_t      pos;
        struct list_head changed;
 
        DB((dbg, LEVEL_2, "fragmentizing chunk #%u", c->id));
@@ -1229,7 +1243,7 @@ static void color_aff_chunk(co_mst_env_t *env, aff_chunk_t *c)
         */
        for (i = 0; i < env->k; ++i) {
                int         col = order[i].col;
-               waitq       *good_starts = new_waitq();
+               waitq       *good_starts;
                aff_chunk_t *local_best;
                int          n_succeeded;
 
@@ -1240,6 +1254,7 @@ static void color_aff_chunk(co_mst_env_t *env, aff_chunk_t *c)
                DB((dbg, LEVEL_2, "\ttrying color %d\n", col));
 
                n_succeeded = 0;
+               good_starts = new_waitq();
 
                /* try to bring all nodes of given chunk to the current color. */
                for (idx = 0, len = ARR_LEN(c->n); idx < len; ++idx) {
@@ -1278,8 +1293,10 @@ static void color_aff_chunk(co_mst_env_t *env, aff_chunk_t *c)
                }
 
                /* try next color when failed */
-               if (n_succeeded == 0)
+               if (n_succeeded == 0) {
+                       del_waitq(good_starts);
                        continue;
+               }
 
                /* fragment the chunk according to the coloring */
                local_best = fragment_chunk(env, col, c, tmp_chunks);
@@ -1317,7 +1334,7 @@ static void color_aff_chunk(co_mst_env_t *env, aff_chunk_t *c)
 
        /* free all intermediate created chunks except best one */
        while (! waitq_empty(tmp_chunks)) {
-               aff_chunk_t *tmp = waitq_get(tmp_chunks);
+               aff_chunk_t *tmp = (aff_chunk_t*)waitq_get(tmp_chunks);
                if (tmp != best_chunk)
                        delete_aff_chunk(tmp);
        }
@@ -1380,7 +1397,7 @@ static void color_aff_chunk(co_mst_env_t *env, aff_chunk_t *c)
        }
 
        /* fragment the remaining chunk */
-       visited = bitset_irg_malloc(env->co->irg);
+       visited = bitset_malloc(get_irg_last_idx(env->co->irg));
        for (idx = 0, len = ARR_LEN(best_chunk->n); idx < len; ++idx)
                bitset_set(visited, get_irn_idx(best_chunk->n[idx]));
 
@@ -1418,7 +1435,9 @@ static int co_solve_heuristic_mst(copy_opt_t *co)
 {
        unsigned     n_regs            = co->cls->n_regs;
        bitset_t     *allocatable_regs = bitset_alloca(n_regs);
-       unsigned     i, j, k;
+       unsigned     i, j;
+       size_t       k;
+       size_t       pn;
        ir_node      *irn;
        co_mst_env_t mst_env;
 
@@ -1427,8 +1446,8 @@ static int co_solve_heuristic_mst(copy_opt_t *co)
        stat_ev_tim_push();
 
        /* init phase */
-       phase_init(&mst_env.ph, co->irg, co_mst_irn_init);
-       phase_set_private(&mst_env.ph, &mst_env);
+       ir_nodemap_init(&mst_env.map, co->irg);
+       obstack_init(&mst_env.obst);
 
        be_put_allocatable_regs(co->cenv->irg, co->cls, allocatable_regs);
        k = bitset_popcount(allocatable_regs);
@@ -1441,10 +1460,10 @@ static int co_solve_heuristic_mst(copy_opt_t *co)
        mst_env.ifg              = co->cenv->ifg;
        INIT_LIST_HEAD(&mst_env.chunklist);
        mst_env.chunk_visited    = 0;
-       mst_env.single_cols      = phase_alloc(&mst_env.ph, sizeof(*mst_env.single_cols) * n_regs);
+       mst_env.single_cols      = OALLOCN(&mst_env.obst, col_cost_t*, n_regs);
 
        for (i = 0; i < n_regs; ++i) {
-               col_cost_t *vec = phase_alloc(&mst_env.ph, sizeof(*vec) * n_regs);
+               col_cost_t *vec = OALLOCN(&mst_env.obst, col_cost_t, n_regs);
 
                mst_env.single_cols[i] = vec;
                for (j = 0; j < n_regs; ++j) {
@@ -1465,7 +1484,7 @@ static int co_solve_heuristic_mst(copy_opt_t *co)
 
        /* color chunks as long as there are some */
        while (! pqueue_empty(mst_env.chunks)) {
-               aff_chunk_t *chunk = pqueue_pop_front(mst_env.chunks);
+               aff_chunk_t *chunk = (aff_chunk_t*)pqueue_pop_front(mst_env.chunks);
 
                color_aff_chunk(&mst_env, chunk);
                DB((dbg, LEVEL_4, "<<<====== Coloring chunk (%u) done\n", chunk->id));
@@ -1473,16 +1492,15 @@ static int co_solve_heuristic_mst(copy_opt_t *co)
        }
 
        /* apply coloring */
-       foreach_phase_irn(&mst_env.ph, irn) {
-               co_mst_irn_t          *mirn;
+       for (pn = 0; pn < ARR_LEN(mst_env.map.data); ++pn) {
+               co_mst_irn_t *mirn = mst_env.map.data[pn];
                const arch_register_t *reg;
-
+               if (mirn == NULL)
+                       continue;
+               irn = get_idx_irn(co->irg, pn);
                if (arch_irn_is_ignore(irn))
                        continue;
 
-               mirn = get_co_mst_irn(&mst_env, irn);
-               // assert(mirn->fixed && "Node should have fixed color");
-
                /* skip nodes where color hasn't changed */
                if (mirn->init_col == mirn->col)
                        continue;
@@ -1494,7 +1512,8 @@ static int co_solve_heuristic_mst(copy_opt_t *co)
 
        /* free allocated memory */
        del_pqueue(mst_env.chunks);
-       phase_deinit(&mst_env.ph);
+       obstack_free(&mst_env.obst, NULL);
+       ir_nodemap_destroy(&mst_env.map);
 
        stat_ev_tim_pop("heur4_total");
 
@@ -1507,7 +1526,7 @@ static const lc_opt_table_entry_t options[] = {
        LC_OPT_LAST
 };
 
-BE_REGISTER_MODULE_CONSTRUCTOR(be_init_copyheur4);
+BE_REGISTER_MODULE_CONSTRUCTOR(be_init_copyheur4)
 void be_init_copyheur4(void)
 {
        lc_opt_entry_t *be_grp = lc_opt_get_grp(firm_opt_get_root(), "be");