unified main comments
[libfirm] / ir / be / bespillmorgan.c
index 6165cfe..1ebce39 100644 (file)
@@ -1,31 +1,52 @@
 /*
- * Author:      Matthias Braun
- * Date:               05.05.2006
- * Copyright:   (c) Universitaet Karlsruhe
- * License:     This file is protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ * 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       Morgans spill algorithm.
+ * @author      Matthias Braun
+ * @date        05.05.2006
+ * @version     $Id$
  */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
-#include "bespillmorgan.h"
-
-#include "bechordal_t.h"
-#include "bespill.h"
-#include "belive_t.h"
-#include "beabi.h"
 #include "irgwalk.h"
-#include "besched.h"
-#include "beutil.h"
 #include "irloop_t.h"
 #include "irgraph_t.h"
 #include "irprintf.h"
-#include "obstack.h"
+#include "obst.h"
 
+#include "bespillmorgan.h"
+#include "bechordal_t.h"
+#include "bespill.h"
+#include "belive_t.h"
+#include "beabi.h"
 #include "bespillbelady.h"
 #include "beverify.h"
 #include "benodesets.h"
+#include "bespilloptions.h"
+#include "besched.h"
+#include "beutil.h"
+#include "bemodule.h"
+#include "beirg_t.h"
 
 #define DBG_LIVE               1
 #define DBG_LOOPANA            2
 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;
@@ -62,7 +83,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;
@@ -152,10 +173,10 @@ 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* data) {
+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;
@@ -240,6 +261,7 @@ static void show_nodebitset(ir_graph* irg, const bitset_t* bitset) {
 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;
@@ -249,8 +271,8 @@ static INLINE void init_livethrough_unuseds(block_attr_t *attr, morgan_env_t *en
        attr->livethrough_unused = bitset_obstack_alloc(&env->obst, get_irg_last_idx(env->irg));
 
        // 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))
@@ -428,10 +450,10 @@ static void spill_values(morgan_env_t *env, const loop_attr_t *loop_attr, int sp
        // spill values
        for(i = 0; i < spills; ++i) {
                ir_node *to_spill = candidates[i].node;
-               DBG((dbg, "Spilling %+F ", to_spill));
+               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);
+                       be_add_reload_on_edge(env->senv, to_spill, edge->block, edge->pos, env->cls, 1);
                }
        }
 }
@@ -441,8 +463,9 @@ static int reduce_register_pressure_in_block(morgan_env_t *env, const ir_node* b
        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));
@@ -463,8 +486,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) {
@@ -473,7 +494,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;
 }
 
@@ -519,8 +541,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;
@@ -539,64 +560,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_SPILLS | DBG_LOOPANA);
+       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 = env.cls->n_regs - be_put_ignore_regs(chordal_env->birg, env.cls, NULL);
+       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.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);
+       /* -- Part1: Analysis -- */
 
        /* 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, construct_block_livethrough_unused, 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 --*/
+       /* -- 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(birg);
+       } else if (birg->main_env->options->vrfy_option == BE_VRFY_ASSERT) {
+               assert(be_verify_schedule(birg));
        }
 
-       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);