[libfirm] / ir / be / becopyheur2.c

/*
 * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
 *
 * This file is part of libFirm.
 *
 * This file may be distributed and/or modified under the terms of the
 * GNU General Public License version 2 as published by the Free Software
 * Foundation and appearing in the file LICENSE.GPL included in the
 * packaging of this file.
 *
 * Licensees holding valid libFirm Professional Edition licenses may use
 * this file in accordance with the libFirm Commercial License.
 * Agreement provided with the Software.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */

/**
 * @file
 * @brief       More experiments on coalescing.
 * @author      Sebastian Hack
 * @date        14.04.2006
 * @version     $Id$
 */
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <stdlib.h>
#include <limits.h>

#include "list.h"
#include "pdeq.h"
#include "bitset.h"
#include "raw_bitset.h"

#include "debug.h"
#include "bitfiddle.h"

#include "irphase_t.h"
#include "irgraph_t.h"
#include "irnode_t.h"
#include "irprintf.h"
#include "irtools.h"

#include "bemodule.h"
#include "beabi.h"
#include "benode_t.h"
#include "becopyopt.h"
#include "becopyopt_t.h"
#include "bechordal_t.h"
#include "beirg_t.h"

#define DUMP_BEFORE 1
#define DUMP_AFTER  2
#define DUMP_CLOUD  4
#define DUMP_ALL    2 * DUMP_CLOUD - 1

static unsigned dump_flags      = 0;
static int      subtree_iter    = 4;
static int      max_depth       = 20;
static double   constr_factor   = 0.9;

#ifdef WITH_LIBCORE
#include <libcore/lc_opts.h>
#include <libcore/lc_opts_enum.h>

/* Options using libcore */
static const lc_opt_enum_mask_items_t dump_items[] = {
        { "before",  DUMP_BEFORE },
        { "after",   DUMP_AFTER  },
        { "cloud",   DUMP_CLOUD  },
        { "all",     DUMP_ALL    },
        { NULL,      0 }
};

static lc_opt_enum_mask_var_t dump_var = {
        &dump_flags, dump_items
};

static const lc_opt_table_entry_t options[] = {
        LC_OPT_ENT_ENUM_MASK("dump", "dump ifg cloud",                                         &dump_var),
        LC_OPT_ENT_INT      ("iter", "iterations for subtree nodes",                           &subtree_iter),
        LC_OPT_ENT_DBL      ("cf",   "factor of constraint importance (between 0.0 and 1.0)",  &constr_factor),
        LC_OPT_ENT_INT      ("max",  "maximum recursion depth",                                &max_depth),
        LC_OPT_LAST
};
#endif /* WITH_LIBCORE */

void be_init_copyheur2(void)
{
#ifdef WITH_LIBCORE
        lc_opt_entry_t *be_grp = lc_opt_get_grp(firm_opt_get_root(), "be");
        lc_opt_entry_t *ra_grp = lc_opt_get_grp(be_grp, "ra");
        lc_opt_entry_t *chordal_grp = lc_opt_get_grp(ra_grp, "chordal");
        lc_opt_entry_t *co2_grp = lc_opt_get_grp(chordal_grp, "co2");

        lc_opt_add_table(co2_grp, options);
#endif
}

BE_REGISTER_MODULE_CONSTRUCTOR(be_init_copyheur2);

/*
  ____  _             _
 / ___|| |_ __ _ _ __| |_
 \___ \| __/ _` | '__| __|
  ___) | || (_| | |  | |_
 |____/ \__\__,_|_|   \__|

*/

#define INFEASIBLE(cost) ((cost) == INT_MAX)

static be_ifg_dump_dot_cb_t ifg_dot_cb;

typedef unsigned col_t;

typedef struct _co2_irn_t       co2_irn_t;
typedef struct _co2_cloud_t     co2_cloud_t;
typedef struct _co2_cloud_irn_t co2_cloud_irn_t;

typedef struct {
        col_t col;
        int costs;
} col_cost_pair_t;

typedef struct {
        ir_phase     ph;
        copy_opt_t *co;
        bitset_t   *ignore_regs;
        co2_irn_t  *touched;
        int         visited;
        int         n_regs;
        struct list_head cloud_head;
        DEBUG_ONLY(firm_dbg_module_t *dbg;)
} co2_t;

struct _co2_irn_t {
        ir_node         *irn;
        affinity_node_t *aff;
        co2_irn_t       *touched_next;
        col_t            tmp_col;
        col_t            orig_col;
        int                              last_color_change;
        bitset_t        *adm_cache;
        unsigned         fixed          : 1;
        unsigned         tmp_fixed      : 1;
        unsigned         is_constrained : 1;
        struct list_head changed_list;
};

struct _co2_cloud_irn_t {
        struct _co2_irn_t  inh;
        co2_cloud_t       *cloud;
        int                visited;
        int                index;
        co2_cloud_irn_t   *mst_parent;
        int                mst_costs;
        int                mst_n_childs;
        co2_cloud_irn_t  **mst_childs;
        int               *col_costs;
        int                costs;
        int               *fronts;
        int               *color_badness;
        col_cost_pair_t   *tmp_coloring;
        struct list_head   cloud_list;
        struct list_head   mst_list;
};

struct _co2_cloud_t {
        co2_t            *env;
        struct obstack    obst;
        int               costs;
        int               mst_costs;
        int               inevit;
        int               best_costs;
        int               n_memb;
        int               n_constr;
        int               max_degree;
        int                           ticks;
        double            freedom;
        co2_cloud_irn_t  *master;
        co2_cloud_irn_t  *mst_root;
        co2_cloud_irn_t **seq;
        struct list_head  members_head;
        struct list_head  list;
};

typedef struct {
        co2_cloud_irn_t *src, *tgt;
        int costs;
} edge_t;

#define FRONT_BASE(ci,col)  ((ci)->fronts + col * (ci)->mst_n_childs)

#define get_co2_irn(co2, irn)         ((co2_irn_t *)       phase_get_or_set_irn_data(&co2->ph, irn))
#define get_co2_cloud_irn(co2, irn)   ((co2_cloud_irn_t *) phase_get_or_set_irn_data(&co2->ph, irn))

static void *co2_irn_init(ir_phase *ph, ir_node *irn, void *data)
{
        co2_t *env         = (co2_t *) ph;
        affinity_node_t *a = get_affinity_info(env->co, irn);
        size_t size        = a ? sizeof(co2_cloud_irn_t) : sizeof(co2_irn_t);
        co2_irn_t *ci      = data ? data : phase_alloc(ph, size);

        memset(ci, 0, size);
        INIT_LIST_HEAD(&ci->changed_list);
        ci->touched_next = env->touched;
        ci->orig_col     = get_irn_col(env->co, irn);
        env->touched     = ci;
        ci->irn          = irn;
        ci->aff          = a;

        if(a) {
                co2_cloud_irn_t *cci = (co2_cloud_irn_t *) ci;
                INIT_LIST_HEAD(&cci->cloud_list);
                cci->mst_parent   = cci;
        }

        return ci;
}

#define CLOUD_WEIGHT(c) ((1 - constr_factor) * (c)->costs + constr_factor * (c)->freedom)

static int cmp_clouds_gt(const void *a, const void *b)
{
        const co2_cloud_t * const *p = a;
        const co2_cloud_t * const *q = b;
        double c = CLOUD_WEIGHT(*p);
        double d = CLOUD_WEIGHT(*q);
        return QSORT_CMP(d, c);
}

/**
 * An order on color/costs pairs.
 * If the costs are equal, we use the color as a kind of normalization.
 */
static int col_cost_pair_lt(const void *a, const void *b)
{
        const col_cost_pair_t *p = a;
        const col_cost_pair_t *q = b;
        int c = p->costs;
        int d = q->costs;
        return QSORT_CMP(c, d);
}

int cmp_edges(const void *a, const void *b)
{
        const edge_t *p = a;
        const edge_t *q = b;
        return QSORT_CMP(q->costs, p->costs);
}

static col_t get_col(co2_t *env, ir_node *irn)
{
        co2_irn_t *ci = get_co2_irn(env, irn);
        return ci->tmp_fixed ? ci->tmp_col : ci->orig_col;
}

static INLINE int color_is_fix(co2_t *env, ir_node *irn)
{
        co2_irn_t *ci = get_co2_irn(env, irn);
        return ci->fixed || ci->tmp_fixed;
}

static INLINE bitset_t *get_adm(co2_t *env, co2_irn_t *ci)
{
        if(ci->adm_cache == NULL) {
                const arch_register_req_t *req;
                ci->adm_cache = bitset_obstack_alloc(phase_obst(&env->ph), env->n_regs);
                req = arch_get_register_req(env->co->aenv, ci->irn, BE_OUT_POS(0));

                if(arch_register_req_is(req, limited)) {
                        int i, n;

                        n = env->n_regs;
                        for(i = 0; i < n; ++i) {
                                if(rbitset_is_set(req->limited, i))
                                        bitset_set(ci->adm_cache, i);
                        }
                        ci->is_constrained = 1;
                } else {
                        bitset_copy(ci->adm_cache, env->ignore_regs);
                        bitset_flip_all(ci->adm_cache);
                }
        }

        return ci->adm_cache;
}

static INLINE bitset_t *admissible_colors(co2_t *env, co2_irn_t *ci, bitset_t *bs)
{
        bitset_copy(bs, get_adm(env, ci));
        return bs;
}

static INLINE int is_color_admissible(co2_t *env, co2_irn_t *ci, col_t col)
{
        bitset_t *bs = get_adm(env, ci);
        return bitset_is_set(bs, col);
}

static INLINE int is_constrained(co2_t *env, co2_irn_t *ci)
{
        if(!ci->adm_cache)
                get_adm(env, ci);
        return ci->is_constrained;
}

static void incur_constraint_costs(co2_t *env, ir_node *irn, col_cost_pair_t *col_costs, int costs)
{
        const arch_register_req_t *req;

        req = arch_get_register_req(env->co->aenv, irn, BE_OUT_POS(0));

        if (arch_register_req_is(req, limited)) {
                unsigned n_regs   = env->co->cls->n_regs;
                unsigned n_constr = 0;
                unsigned i;

                n_constr = rbitset_popcnt(req->limited, n_regs);
                for (i = 0; i < n_regs; ++i) {
                        if (rbitset_is_set(req->limited, i)) {
                                col_costs[i].costs = add_saturated(col_costs[i].costs, costs / n_constr);
                        }
                }
        }
}

/**
 * Determine costs which shall indicate how cheap/expensive it is to try
 * to assign a node some color.
 * The costs are computed for all colors. INT_MAX means that it is impossible
 * to give the node that specific color.
 *
 * @param env       The co2 this pointer.
 * @param irn       The node.
 * @param col_costs An array of colors x costs where the costs are written to.
 */
static void determine_color_costs(co2_t *env, co2_irn_t *ci, col_cost_pair_t *col_costs)
{
        ir_node *irn       = ci->irn;
        be_ifg_t *ifg      = env->co->cenv->ifg;
        int n_regs         = env->co->cls->n_regs;
        bitset_t *forb     = bitset_alloca(n_regs);
        affinity_node_t *a = ci->aff;

        bitset_pos_t elm;
        ir_node *pos;
        void *it;
        int i;

        /* Put all forbidden colors into the aux bitset. */
        admissible_colors(env, ci, forb);
        bitset_flip_all(forb);

        for(i = 0; i < n_regs; ++i) {
                col_costs[i].col   = i;
                col_costs[i].costs = 0;
        }

        if(a) {
                neighb_t *n;

                co_gs_foreach_neighb(a, n) {
                        if(color_is_fix(env, n->irn)) {
                                col_t col = get_col(env, n->irn);
                                col_costs[col].costs = add_saturated(col_costs[col].costs, -n->costs * 128);
                        }

                        incur_constraint_costs(env, n->irn, col_costs, -n->costs);
                }
        }

        it = be_ifg_neighbours_iter_alloca(ifg);
        be_ifg_foreach_neighbour(ifg, it, irn, pos) {
                col_t col = get_col(env, pos);
                if(color_is_fix(env, pos)) {
                        col_costs[col].costs  = INT_MAX;
                }
                else {
                        incur_constraint_costs(env, pos, col_costs, INT_MAX);
                        col_costs[col].costs = add_saturated(col_costs[col].costs, 8 * be_ifg_degree(ifg, pos));
                }
        }
        be_ifg_neighbours_break(ifg, it);

        /* Set the costs to infinity for each color which is not allowed at this node. */
        bitset_foreach(forb, elm) {
                col_costs[elm].costs  = INT_MAX;
        }

}

static void single_color_cost(co2_t *env, co2_irn_t *ci, col_t col, col_cost_pair_t *seq)
{
        int n_regs = env->co->cls->n_regs;
        int i;

        for(i = 0; i < n_regs; ++i) {
                seq[i].col   = i;
                seq[i].costs = INT_MAX;
        }

        assert(is_color_admissible(env, ci, col));
        seq[col].col = 0;
        seq[0].col   = col;
        seq[0].costs = 0;
}

static void reject_coloring(struct list_head *h)
{
        co2_irn_t *pos;

        list_for_each_entry(co2_irn_t, pos, h, changed_list)
                pos->tmp_fixed = 0;
}

static void materialize_coloring(struct list_head *h)
{
        co2_irn_t *pos;

        list_for_each_entry(co2_irn_t, pos, h, changed_list) {
                pos->orig_col  = pos->tmp_col;
                pos->tmp_fixed = 0;
        }
}

static int change_color_not(co2_t *env, ir_node *irn, col_t not_col, struct list_head *parent_changed, int depth);

static int recolor(co2_t *env, ir_node *irn, col_cost_pair_t *col_list, struct list_head *parent_changed, int depth)
{
        int n_regs         = env->co->cls->n_regs;
        be_ifg_t *ifg      = env->co->cenv->ifg;
        co2_irn_t *ci      = get_co2_irn(env, irn);
        int res            = 0;

        int i;

        if(depth >= max_depth)
          return 0;

        for(i = 0; i < n_regs; ++i) {
                col_t tgt_col  = col_list[i].col;
                unsigned costs = col_list[i].costs;
                int neigh_ok   = 1;

                struct list_head changed;
                ir_node *n;
                void *it;

                DBG((env->dbg, LEVEL_3, "\t\t%2{firm:indent}trying color %d(%d) on %+F\n", depth, tgt_col, costs, irn));

                /* If the costs for that color (and all successive) are infinite, bail out we won't make it anyway. */
                if(INFEASIBLE(costs)) {
                        DB((env->dbg, LEVEL_4, "\t\t%2{firm:indent}color %d infeasible\n", depth, tgt_col));
                        ci->tmp_fixed = 0;
                        return 0;
                }

                /* Set the new color of the node and mark the node as temporarily fixed. */
                ci->tmp_col     = tgt_col;
                ci->tmp_fixed   = 1;

                /*
                If that color has costs > 0, there's at least one neighbor having that color,
                so we will try to change the neighbors' colors, too.
                */
                INIT_LIST_HEAD(&changed);
                list_add(&ci->changed_list, &changed);

                it = be_ifg_neighbours_iter_alloca(ifg);
                be_ifg_foreach_neighbour(ifg, it, irn, n) {

                        /* try to re-color the neighbor if it has the target color. */
                        if(get_col(env, n) == tgt_col) {
                                struct list_head tmp;

                                /*
                                Try to change the color of the neighbor and record all nodes which
                                get changed in the tmp list. Add this list to the "changed" list for
                                that color. If we did not succeed to change the color of the neighbor,
                                we bail out and try the next color.
                                */
                                INIT_LIST_HEAD(&tmp);
                                neigh_ok = change_color_not(env, n, tgt_col, &tmp, depth + 1);
                                list_splice(&tmp, &changed);
                                if(!neigh_ok)
                                        break;
                        }
                }
                be_ifg_neighbours_break(ifg, it);

                /*
                We managed to assign the target color to all neighbors, so from the perspective
                of the current node, every thing was ok and we can return safely.
                */
                if(neigh_ok) {
                        DBG((env->dbg, LEVEL_3, "\t\t%2{firm:indent}color %d(%d) was ok\n", depth, tgt_col, costs));
                        list_splice(&changed, parent_changed);
                        res = 1;
                        break;
                }

                /*
                If not, that color did not succeed and we unfix all nodes we touched
                by traversing the changed list and setting tmp_fixed to 0 for these nodes.
                */
                else
                        reject_coloring(&changed);
        }

        return res;
}

static int change_color_not(co2_t *env, ir_node *irn, col_t not_col, struct list_head *parent_changed, int depth)
{
        co2_irn_t *ci = get_co2_irn(env, irn);
        int res       = 0;
        col_t col     = get_col(env, irn);

        DBG((env->dbg, LEVEL_3, "\t\t%2{firm:indent}clearing %+F(%d) of color %d\n", depth, irn, col, not_col));

        /* the node does not have to forbidden color. That's fine, mark it as visited and return. */
        if(col != not_col) {
                if(!ci->tmp_fixed) {
                        ci->tmp_col     = col;
                        ci->tmp_fixed   = 1;
                }

                list_add(&ci->changed_list, parent_changed);
                return 1;
        }

        /* The node has the color it should not have _and_ has not been visited yet. */
        if(!color_is_fix(env, irn)) {
                int n_regs            = env->co->cls->n_regs;
                col_cost_pair_t *csts = alloca(n_regs * sizeof(csts[0]));

                /* Get the costs for giving the node a specific color. */
                determine_color_costs(env, ci, csts);

                /* Since the node must not have the not_col, set the costs for that color to "infinity" */
                csts[not_col].costs = INT_MAX;

                /* sort the colors according costs, cheapest first. */
                qsort(csts, n_regs, sizeof(csts[0]), col_cost_pair_lt);

                /* Try recoloring the node using the color list. */
                res = recolor(env, irn, csts, parent_changed, depth);
        }

        /* If we came here, everything went ok. */
        return res;
}

static int change_color_single(co2_t *env, ir_node *irn, col_t tgt_col, struct list_head *parent_changed, int depth)
{
        co2_irn_t *ci = get_co2_irn(env, irn);
        col_t col     = get_col(env, irn);
        int res       = 0;

        DBG((env->dbg, LEVEL_3, "\t\t%2{firm:indent}trying to set %+F(%d) to color %d\n", depth, irn, col, tgt_col));

        /* the node has the wanted color. That's fine, mark it as visited and return. */
        if(col == tgt_col) {
                if(!ci->tmp_fixed) {
                        ci->tmp_col     = col;
                        ci->tmp_fixed   = 1;
                        list_add(&ci->changed_list, parent_changed);
                }

                res = 1;
                goto end;
        }

        if(!color_is_fix(env, irn) && is_color_admissible(env, ci, tgt_col)) {
                int n_regs           = env->co->cls->n_regs;
                col_cost_pair_t *seq = alloca(n_regs * sizeof(seq[0]));

                /* Get the costs for giving the node a specific color. */
                single_color_cost(env, ci, tgt_col, seq);

                /* Try recoloring the node using the color list. */
                res = recolor(env, irn, seq, parent_changed, depth);

        }

end:
        DB((env->dbg, LEVEL_3, "\t\t%2{firm:indent}color %d %s for %+F\n", depth, tgt_col, res ? "was ok" : "failed", irn));
        return res;
}

/**
 * Examine the costs of the current coloring concerning a MST subtree.
 * @param ci  The subtree root.
 * @param col The color of @p ci.
 * @return    The best coloring for that subtree under the assumption that @p ci has color @p col.
 */
static int examine_subtree_coloring(co2_cloud_irn_t *ci, col_t col)
{
        int *front = FRONT_BASE(ci, col);
        int cost   = 0;
        int i;

        for(i = 0; i < ci->mst_n_childs; ++i) {
                co2_cloud_irn_t *chld = ci->mst_childs[i];
                col_t chld_col        = front[i];

                cost += examine_subtree_coloring(chld, chld_col);
                cost += col != chld_col ? chld->mst_costs : 0;
        }

        return cost;
}

/**
 * Determine color badnesses of a node.
 * Badness means that it is unlikely that the node in question can
 * obtain a color. The higher the badness, the more unlikely it is that
 * the node can be assigned that color.
 * @param ci      The node.
 * @param badness An integer array as long as there are registers.
 * @note          The array <code>badness</code> is not cleared.
 */
static void node_color_badness(co2_cloud_irn_t *ci, int *badness)
{
        co2_t *env     = ci->cloud->env;
        co2_irn_t *ir  = &ci->inh;
        int n_regs     = env->n_regs;
        be_ifg_t *ifg  = env->co->cenv->ifg;
        bitset_t *bs   = bitset_alloca(n_regs);

        bitset_pos_t elm;
        ir_node *irn;
        void *it;

        admissible_colors(env, &ci->inh, bs);
        bitset_flip_all(bs);
        bitset_foreach(bs, elm)
                badness[elm] = ci->costs;

        /* Use constrained/fixed interfering neighbors to influence the color badness */
        it = be_ifg_neighbours_iter_alloca(ifg);
        be_ifg_foreach_neighbour(ifg, it, ir->irn, irn) {
                co2_irn_t *ni = get_co2_irn(env, irn);

                admissible_colors(env, ni, bs);
                if(bitset_popcnt(bs) == 1) {
                        bitset_pos_t c = bitset_next_set(bs, 0);
                        badness[c] += ci->costs;
                }

                else if(ni->fixed) {
                        col_t c = get_col(env, ni->irn);
                        badness[c] += ci->costs;
                }
        }
        be_ifg_neighbours_break(ifg, it);
}

/**
 * Determine the badness of a MST subtree.
 * The badness is written into the <code>color_badness</code> array of each node and accumulated in the parents.
 * @see node_color_badness() for a definition of badness.
 * @param ci    The root of the subtree.
 * @param depth Depth for debugging purposes.
 */
static void determine_color_badness(co2_cloud_irn_t *ci, int depth)
{
        co2_t *env     = ci->cloud->env;
        int i, j;

        node_color_badness(ci, ci->color_badness);

        /* Collect the color badness for the whole subtree */
        for(i = 0; i < ci->mst_n_childs; ++i) {
                co2_cloud_irn_t *child = ci->mst_childs[i];
                determine_color_badness(child, depth + 1);

                for(j = 0; j < env->n_regs; ++j)
                        ci->color_badness[j] += child->color_badness[j];
        }

        for(j = 0; j < env->n_regs; ++j)
                DBG((env->dbg, LEVEL_2, "%2{firm:indent}%+F col %d badness %d\n", depth, ci->inh.irn, j, ci->color_badness[j]));
}

/**
 * Unfix all nodes in a MST subtree.
 */
static void unfix_subtree(co2_cloud_irn_t *ci)
{
        int i;

        ci->inh.fixed = 0;
        for(i = 0; i < ci->mst_n_childs; ++i)
                unfix_subtree(ci->mst_childs[i]);
}

static int coalesce_top_down(co2_cloud_irn_t *ci, int child_nr, int depth)
{
        co2_t *env           = ci->cloud->env;
        col_cost_pair_t *seq = alloca(env->n_regs * sizeof(seq[0]));
        int is_root          = ci->mst_parent == ci;
        col_t parent_col     = is_root ? (col_t) -1 : get_col(env, ci->mst_parent->inh.irn);
        int min_badness      = INT_MAX;
        int best_col_costs   = INT_MAX;
        int best_col         = -1;
        int n_regs           = env->n_regs;
        int n_iter           = is_root ? MIN(n_regs, subtree_iter) : 1;

        struct list_head changed;
        int ok, i, j;

        for(i = 0; i < n_regs; ++i) {
                int badness = ci->color_badness[i];

                seq[i].col   = i;
                seq[i].costs = is_color_admissible(env, &ci->inh, i) ? badness : INT_MAX;

                min_badness = MIN(min_badness, badness);
        }

        /* If we are not the root and the parent's color is allowed for this node give it top prio. */
        if(!is_root && is_color_admissible(env, &ci->inh, parent_col))
                seq[parent_col].costs = min_badness - 1;

        /* Sort the colors. The will be processed in that ordering. */
        qsort(seq, env->n_regs, sizeof(seq[0]), col_cost_pair_lt);

        DBG((env->dbg, LEVEL_2, "\t%2{firm:indent}starting top-down coalesce for %+F\n", depth, ci->inh.irn));
        INIT_LIST_HEAD(&changed);
        for(i = 0; i < (best_col < 0 ? n_regs : n_iter); ++i) {
                col_t col    = seq[i].col;
                int add_cost = !is_root && col != parent_col ? ci->mst_costs : 0;

                int subtree_costs, sum_costs;

                DBG((env->dbg, LEVEL_2, "\t%2{firm:indent}%+F trying color %d\n", depth, ci->inh.irn, col));

                unfix_subtree(ci);
                INIT_LIST_HEAD(&changed);
                ok = change_color_single(env, ci->inh.irn, col, &changed, depth);
                if(ok) {
                        materialize_coloring(&changed);
                        ci->inh.fixed = 1;
                }

                else
                        continue;

                for(j = 0; j < ci->mst_n_childs; ++j) {
                        co2_cloud_irn_t *child = ci->mst_childs[j];
                        ok = coalesce_top_down(child, j, depth + 1) >= 0;
                        if(ok)
                                child->inh.fixed = 1;
                        else
                                break;
                }

                /* If the subtree could not be colored, we have to try another color. */
                if(!ok)
                        continue;

                subtree_costs      = examine_subtree_coloring(ci, col);
                sum_costs          = subtree_costs + add_cost;
                DBG((env->dbg, LEVEL_2, "\t%2{firm:indent}-> %+F costing %d + %d is ok.\n", depth, ci->inh.irn, subtree_costs, add_cost));

                if(sum_costs < best_col_costs) {
                        best_col           = col;
                        best_col_costs     = sum_costs;
                        ci->col_costs[col] = subtree_costs;
                }

                if(sum_costs == 0)
                        break;
        }

        if(!is_root) {
                int *front = FRONT_BASE(ci->mst_parent, parent_col);
                front[child_nr] = best_col;
        }

        return best_col;
}

static void populate_cloud(co2_t *env, co2_cloud_t *cloud, affinity_node_t *a, int curr_costs)
{
        be_ifg_t *ifg       = env->co->cenv->ifg;
        co2_cloud_irn_t *ci = get_co2_cloud_irn(env, a->irn);
        int costs           = 0;
        neighb_t *n;

        if(ci->cloud)
                return;

        /* mark the node as visited and add it to the cloud. */
        ci->cloud   = cloud;
        list_add(&ci->cloud_list, &cloud->members_head);

        DB((env->dbg, LEVEL_2, "\t%+F\n", ci->inh.irn));

        /* determine the nodes costs */
        co_gs_foreach_neighb(a, n) {
                costs += n->costs;
                DB((env->dbg, LEVEL_3, "\t\tneigh %+F cost %d\n", n->irn, n->costs));
                if(be_ifg_connected(ifg, a->irn, n->irn))
                        cloud->inevit += n->costs;
        }

        /* add the node's cost to the total costs of the cloud. */
        ci->costs          = costs;
        cloud->costs      += costs;
        cloud->n_constr   += is_constrained(env, &ci->inh);
        cloud->freedom    += bitset_popcnt(get_adm(env, &ci->inh));
        cloud->max_degree  = MAX(cloud->max_degree, ci->inh.aff->degree);
        cloud->n_memb++;

        /* If this is the heaviest node in the cloud, set it as the cloud's master. */
        if(costs >= curr_costs) {
                curr_costs    = costs;
                cloud->master = ci;
        }

        /* add all the neighbors of the node to the cloud. */
        co_gs_foreach_neighb(a, n) {
                affinity_node_t *an = get_affinity_info(env->co, n->irn);
                assert(an);
                populate_cloud(env, cloud, an, curr_costs);
        }
}

static co2_cloud_t *new_cloud(co2_t *env, affinity_node_t *a)
{
        co2_cloud_t *cloud = phase_alloc(&env->ph, sizeof(cloud[0]));
        co2_cloud_irn_t *ci;
        int i;

        DBG((env->dbg, LEVEL_2, "new cloud with %+F\n", a->irn));
        memset(cloud, 0, sizeof(cloud[0]));
        INIT_LIST_HEAD(&cloud->members_head);
        INIT_LIST_HEAD(&cloud->list);
        list_add(&cloud->list, &env->cloud_head);
        cloud->best_costs = INT_MAX;
        cloud->env = env;
        env->visited++;
        populate_cloud(env, cloud, a, 0);
        cloud->freedom = (cloud->n_memb * env->n_regs) / cloud->freedom;

        /* Also allocate space for the node sequence and compute that sequence. */
        cloud->seq    = phase_alloc(&env->ph, cloud->n_memb * sizeof(cloud->seq[0]));

        i = 0;
        list_for_each_entry(co2_cloud_irn_t, ci, &cloud->members_head, cloud_list) {
                ci->index       = i;
                cloud->seq[i++] = ci;
        }
        DBG((env->dbg, LEVEL_2, "cloud cost %d, freedom %f\n", cloud->costs, cloud->freedom));

        return cloud;
}

static void apply_coloring(co2_cloud_irn_t *ci, col_t col, int depth)
{
        ir_node *irn = ci->inh.irn;
        int *front   = FRONT_BASE(ci, col);
        int i, ok;
        struct list_head changed;

        INIT_LIST_HEAD(&changed);

        DBG((ci->cloud->env->dbg, LEVEL_2, "%2{firm:indent}setting %+F to %d\n", depth, irn, col));
        ok = change_color_single(ci->cloud->env, irn, col, &changed, depth);
        // assert(ok && "Color changing may not fail while committing the coloring");
        materialize_coloring(&changed);

        for(i = 0; i < ci->mst_n_childs; ++i) {
                apply_coloring(ci->mst_childs[i], front[i], depth + 1);
        }
}

static co2_cloud_irn_t *find_mst_root(co2_cloud_irn_t *ci)
{
        while(ci != ci->mst_parent)
                ci = ci->mst_parent;
        return ci;
}


static void process_cloud(co2_cloud_t *cloud)
{
        co2_t *env  = cloud->env;
        int n_regs  = env->n_regs;
        int n_edges = 0;
        int *mst_edges = xmalloc(cloud->n_memb * cloud->n_memb * sizeof(mst_edges[0]));
        pdeq *q;

        edge_t *edges;
        int i;
        int best_col;

        memset(mst_edges, 0, cloud->n_memb * cloud->n_memb * sizeof(mst_edges[0]));

        /* Collect all edges in the cloud on an obstack and sort the increasingly */
        obstack_init(&cloud->obst);
        for(i = 0; i < cloud->n_memb; ++i) {
                co2_cloud_irn_t *ci = cloud->seq[i];
                neighb_t *n;

                co_gs_foreach_neighb(ci->inh.aff, n) {
                        co2_cloud_irn_t *ni = get_co2_cloud_irn(cloud->env, n->irn);
                        if(ci->index < ni->index) {
                                edge_t e;
                                e.src   = ci;
                                e.tgt   = ni;
                                e.costs = n->costs;
                                obstack_grow(&cloud->obst, &e, sizeof(e));
                                n_edges++;
                        }
                }
        }
        edges = obstack_finish(&cloud->obst);
        qsort(edges, n_edges, sizeof(edges[0]), cmp_edges);

        /* Compute the maximum spanning tree using Kruskal/Union-Find */
        DBG((env->dbg, LEVEL_2, "computing spanning tree of cloud with master %+F\n", cloud->master->inh.irn));
        for(i = 0; i < n_edges; ++i) {
                edge_t *e        = &edges[i];
                co2_cloud_irn_t *rs = find_mst_root(e->src);
                co2_cloud_irn_t *rt = find_mst_root(e->tgt);

                /* if the union/find roots are different */
                if(rs != rt) {
                        int si = e->src->index;
                        int ti = e->tgt->index;

                        /* unify the sets */
                        rs->mst_parent = rt;
                        DBG((env->dbg, LEVEL_2, "\tadding edge %+F -- %+F cost %d\n", rs->inh.irn, rt->inh.irn, e->costs));

                        /* this edge is in the MST, so set it in the bitset. */
                        mst_edges[si * cloud->n_memb + ti] = e->costs;
                        mst_edges[ti * cloud->n_memb + si] = e->costs;
                }
        }
        obstack_free(&cloud->obst, edges);

        cloud->master->mst_parent = cloud->master;
        cloud->mst_root = cloud->master;
        q = new_pdeq1(cloud->master);
        while(!pdeq_empty(q)) {
                co2_cloud_irn_t *ci = pdeq_getl(q);
                int ofs    = ci->index * cloud->n_memb;
                int end    = ofs + cloud->n_memb;
                int i;

                ci->mst_n_childs = 0;
                for(i = ofs; i < end; ++i) {
                        if(mst_edges[i] != 0) {
                                int other = i - ofs;
                                co2_cloud_irn_t *child = cloud->seq[i - ofs];

                                /* put the child to the worklist */
                                pdeq_putr(q, child);

                                /* make ci the parent of the child and add the child to the children array of the parent */
                                child->mst_parent = ci;
                                child->mst_costs  = mst_edges[i];
                                ci->mst_n_childs++;
                                obstack_ptr_grow(&cloud->obst, child);

                                mst_edges[other * cloud->n_memb + ci->index] = 0;
                                mst_edges[i] = 0;
                        }
                }

                obstack_ptr_grow(&cloud->obst, NULL);
                ci->mst_childs = obstack_finish(&cloud->obst);
        }
        del_pdeq(q);
        free(mst_edges);


        DBG((env->dbg, LEVEL_3, "mst:\n"));
        for(i = 0; i < cloud->n_memb; ++i) {
                DEBUG_ONLY(co2_cloud_irn_t *ci = cloud->seq[i]);
                DBG((env->dbg, LEVEL_3, "\t%+F -> %+F\n", ci->inh.irn, ci->mst_parent->inh.irn));
        }

        for(i = 0; i < cloud->n_memb; ++i) {
                co2_cloud_irn_t *ci = cloud->seq[i];
                int n_childs = ci->mst_n_childs;
                int j;

                ci->col_costs       = obstack_alloc(&cloud->obst, n_regs * sizeof(ci->col_costs[0]));
                ci->tmp_coloring    = obstack_alloc(&cloud->obst, n_regs * sizeof(ci->tmp_coloring[0]));
                ci->fronts          = obstack_alloc(&cloud->obst, n_regs * n_childs * sizeof(ci->fronts[0]));
                ci->color_badness   = obstack_alloc(&cloud->obst, n_regs * sizeof(ci->fronts[0]));
                memset(ci->color_badness, 0, n_regs * sizeof(ci->color_badness[0]));
                memset(ci->col_costs,     0, n_regs * sizeof(ci->col_costs[0]));
                memset(ci->tmp_coloring,  0, n_regs * sizeof(ci->tmp_coloring[0]));
                memset(ci->fronts,        0, n_regs * n_childs * sizeof(ci->fronts[0]));

                for(j = 0; j < env->n_regs; j++)
                        ci->col_costs[j] = INT_MAX;

        }

        determine_color_badness(cloud->mst_root, 0);
        best_col = coalesce_top_down(cloud->mst_root, -1, 0);
        unfix_subtree(cloud->mst_root);
        apply_coloring(cloud->mst_root, best_col, 0);

        /* The coloring should represent the one with the best costs. */
        //materialize_coloring(&changed);
        DBG((env->dbg, LEVEL_2, "\tbest coloring for root %+F was %d costing %d\n",
                cloud->mst_root->inh.irn, best_col, examine_subtree_coloring(cloud->mst_root, best_col)));

        /* Fix all nodes in the cloud. */
        for(i = 0; i < cloud->n_memb; ++i)
                cloud->seq[i]->inh.fixed = 1;

        /* Free all space used while optimizing this cloud. */
        obstack_free(&cloud->obst, NULL);
}

static int cloud_costs(co2_cloud_t *cloud)
{
        int i, costs = 0;
        neighb_t *n;

        for(i = 0; i < cloud->n_memb; ++i) {
                co2_irn_t *ci = (co2_irn_t *) cloud->seq[i];
                col_t col = get_col(cloud->env, ci->irn);
                co_gs_foreach_neighb(ci->aff, n) {
                        col_t n_col = get_col(cloud->env, n->irn);
                        costs += col != n_col ? n->costs : 0;
                }
        }

        return costs / 2;
}

static void process(co2_t *env)
{
        affinity_node_t *a;
        co2_cloud_t *pos;
        co2_cloud_t **clouds;
        int n_clouds;
        int i;
        int init_costs  = 0;
        int all_costs   = 0;
        int final_costs = 0;

        n_clouds = 0;
        co_gs_foreach_aff_node(env->co, a) {
                co2_cloud_irn_t *ci = get_co2_cloud_irn(env, a->irn);

                if(!ci->cloud) {
                        new_cloud(env, a);
                        n_clouds++;
                }
        }

        i = 0;
        clouds = xmalloc(n_clouds * sizeof(clouds[0]));
        list_for_each_entry(co2_cloud_t, pos, &env->cloud_head, list)
                clouds[i++] = pos;
        qsort(clouds, n_clouds, sizeof(clouds[0]), cmp_clouds_gt);

        for(i = 0; i < n_clouds; ++i) {
                init_costs  += cloud_costs(clouds[i]);

                /* Process the cloud. */
                process_cloud(clouds[i]);

                all_costs   += clouds[i]->costs;
                final_costs += cloud_costs(clouds[i]);

                /* Dump the IFG if the user demanded it. */
                if (dump_flags & DUMP_CLOUD) {
                        char buf[256];
                        FILE *f;

                        ir_snprintf(buf, sizeof(buf), "ifg_%F_%s_cloud_%d.dot", env->co->irg, env->co->cls->name, i);
                        f = fopen(buf, "wt");
                        if(f != NULL) {
                                be_ifg_dump_dot(env->co->cenv->ifg, env->co->irg, f, &ifg_dot_cb, env);
                                fclose(f);
                        }
                }
        }

        DB((env->dbg, LEVEL_1, "all costs: %d, init costs: %d, final costs: %d\n", all_costs, init_costs, final_costs));

        xfree(clouds);
}

static void writeback_colors(co2_t *env)
{
        const arch_env_t *aenv = env->co->aenv;
        co2_irn_t *irn;

        for(irn = env->touched; irn; irn = irn->touched_next) {
                const arch_register_t *reg = arch_register_for_index(env->co->cls, irn->orig_col);
                arch_set_irn_register(aenv, irn->irn, reg);
        }
}


/*
  ___ _____ ____   ____   ___ _____   ____                        _
 |_ _|  ___/ ___| |  _ \ / _ \_   _| |  _ \ _   _ _ __ ___  _ __ (_)_ __   __ _
  | || |_ | |  _  | | | | | | || |   | | | | | | | '_ ` _ \| '_ \| | '_ \ / _` |
  | ||  _|| |_| | | |_| | |_| || |   | |_| | |_| | | | | | | |_) | | | | | (_| |
 |___|_|   \____| |____/ \___/ |_|   |____/ \__,_|_| |_| |_| .__/|_|_| |_|\__, |
                                                           |_|            |___/
*/

static const char *get_dot_color_name(size_t col)
{
        static const char *names[] = {
                "blue",
                "red",
                "green",
                "yellow",
                "cyan",
                "magenta",
                "orange",
                "chocolate",
                "beige",
                "navy",
                "darkgreen",
                "darkred",
                "lightPink",
                "chartreuse",
                "lightskyblue",
                "linen",
                "pink",
                "lightslateblue",
                "mintcream",
                "red",
                "darkolivegreen",
                "mediumblue",
                "mistyrose",
                "salmon",
                "darkseagreen",
                "mediumslateblue"
                "moccasin",
                "tomato",
                "forestgreen",
                "darkturquoise",
                "palevioletred"
        };

        return col < (sizeof(names)/sizeof(names[0])) ? names[col] : "white";
}

static const char *get_dot_shape_name(co2_t *env, co2_irn_t *ci)
{
        const arch_register_req_t *req;

        req = arch_get_register_req(env->co->aenv, ci->irn, BE_OUT_POS(0));
        if(arch_register_req_is(req, limited))
                return "diamond";

        if(ci->fixed)
                return "rectangle";

        if(ci->tmp_fixed)
                return "hexagon";

        return "ellipse";
}

static void ifg_dump_graph_attr(FILE *f, void *self)
{
        (void) self;
        fprintf(f, "overlay=false");
}

static int ifg_is_dump_node(void *self, ir_node *irn)
{
        co2_t *env = self;
        return !arch_irn_is(env->co->aenv, irn, ignore);
}

static void ifg_dump_node_attr(FILE *f, void *self, ir_node *irn)
{
        co2_t *env    = self;
        co2_irn_t *ci = get_co2_irn(env, irn);
        int peri      = 1;

        char buf[128] = "";

        if(ci->aff) {
                co2_cloud_irn_t *cci = (void *) ci;
                if (cci->cloud && cci->cloud->mst_root == cci)
                        peri = 2;

                if(cci->cloud && cci->cloud->mst_root)
                        ir_snprintf(buf, sizeof(buf), "%+F", cci->cloud->mst_root->inh.irn);
        }

        ir_fprintf(f, "label=\"%+F%s\" style=filled peripheries=%d color=%s shape=%s", irn, buf, peri,
                get_dot_color_name(get_col(env, irn)), get_dot_shape_name(env, ci));
}

static void ifg_dump_at_end(FILE *file, void *self)
{
        co2_t *env = self;
        affinity_node_t *a;

        co_gs_foreach_aff_node(env->co, a) {
                co2_cloud_irn_t *ai = get_co2_cloud_irn(env, a->irn);
                int idx = get_irn_idx(a->irn);
                neighb_t *n;

                if(ai->mst_parent != ai)
                        fprintf(file, "\tn%d -- n%d [style=dotted color=blue arrowhead=normal];\n", idx, get_irn_idx(ai->mst_parent->inh.irn));

                co_gs_foreach_neighb(a, n) {
                        int nidx = get_irn_idx(n->irn);
                        co2_cloud_irn_t *ci = get_co2_cloud_irn(env, n->irn);

                        if(idx < nidx) {
                                const char *color = get_col(env, a->irn) == get_col(env, n->irn) ? "black" : "red";
                                const char *arr = "arrowhead=dot arrowtail=dot";

                                if(ci->mst_parent == ai)
                                        arr = "arrowtail=normal";
                                else if(ai->mst_parent == ci)
                                        arr = "arrowhead=normal";

                                fprintf(file, "\tn%d -- n%d [label=\"%d\" %s style=dashed color=%s weight=0.01];\n", idx, nidx, n->costs, arr, color);
                        }
                }
        }
}


static be_ifg_dump_dot_cb_t ifg_dot_cb = {
        ifg_is_dump_node,
        ifg_dump_graph_attr,
        ifg_dump_node_attr,
        NULL,
        NULL,
        ifg_dump_at_end
};


int co_solve_heuristic_new(copy_opt_t *co)
{
        char  buf[256];
        co2_t env;
        FILE  *f;

        phase_init(&env.ph, "co2", co->cenv->birg->irg, PHASE_DEFAULT_GROWTH, co2_irn_init, NULL);
        env.touched     = NULL;
        env.visited     = 0;
        env.co          = co;
        env.n_regs      = co->cls->n_regs;
        env.ignore_regs = bitset_alloca(co->cls->n_regs);
        arch_put_non_ignore_regs(co->aenv, co->cls, env.ignore_regs);
        bitset_flip_all(env.ignore_regs);
        be_abi_put_ignore_regs(co->cenv->birg->abi, co->cls, env.ignore_regs);
        FIRM_DBG_REGISTER(env.dbg, "firm.be.co2");
        INIT_LIST_HEAD(&env.cloud_head);

        if(dump_flags & DUMP_BEFORE) {
                ir_snprintf(buf, sizeof(buf), "ifg_%F_%s_before.dot", co->irg, co->cls->name);
                f = fopen(buf, "wt");
                if (f != NULL) {
                        be_ifg_dump_dot(co->cenv->ifg, co->irg, f, &ifg_dot_cb, &env);
                        fclose(f);
                }
        }

        process(&env);

        if(dump_flags & DUMP_AFTER) {
                ir_snprintf(buf, sizeof(buf), "ifg_%F_%s_after.dot", co->irg, co->cls->name);
                f = fopen(buf, "wt");
                if (f != NULL) {
                        be_ifg_dump_dot(co->cenv->ifg, co->irg, f, &ifg_dot_cb, &env);
                        fclose(f);
                }
        }

        writeback_colors(&env);
        phase_free(&env.ph);
        return 0;
}