cleanup: Remove unnecessary #include "beirg.h".
[libfirm] / ir / be / belistsched.c
index 1b932df..f9f2b65 100644 (file)
@@ -1,26 +1,41 @@
-/**
- * Scheduling algorithms.
- * Just a simple list scheduling algorithm is here.
- * @date   20.10.2004
- * @author Sebastian Hack
- * @cvs-id $Id$
+/*
+ * Copyright (C) 1995-2008 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.
  */
 
-#ifdef HAVE_CONFIG_H
+/**
+ * @file
+ * @brief       Primitive list scheduling with different node selectors.
+ * @author      Sebastian Hack
+ * @date        20.10.2004
+ */
 #include "config.h"
-#endif
 
 #include <stdio.h>
 #include <stdarg.h>
 #include <string.h>
 #include <limits.h>
+#include <stdbool.h>
 
-#include "benode_t.h"
+#include "benode.h"
 #include "be_t.h"
 
 #include "obst.h"
 #include "list.h"
-#include "iterator.h"
 
 #include "iredges_t.h"
 #include "irgwalk.h"
 #include "debug.h"
 #include "irtools.h"
 
-#include "besched_t.h"
+#include "bemodule.h"
+#include "besched.h"
 #include "beutil.h"
 #include "belive_t.h"
 #include "belistsched.h"
-#include "beschedmris.h"
 #include "bearch.h"
 #include "bestat.h"
 
-/**
- * All scheduling info needed per node.
- */
-typedef struct _sched_irn_t {
-       unsigned num_not_sched_user; /**< The number of not yet scheduled users of this node */
-       unsigned already_sched : 1;  /**< Set if this node is already scheduled */
-} sched_irn_t;
+#include "lc_opts.h"
+#include "lc_opts_enum.h"
+
+DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
 
 /**
  * Scheduling environment for the whole graph.
  */
-typedef struct _sched_env_t {
-       sched_irn_t *sched_info;                    /**< scheduling info per node */
-       const list_sched_selector_t *selector;      /**< The node selector. */
-       const arch_env_t *arch_env;                 /**< The architecture environment. */
-       const ir_graph *irg;                        /**< The graph to schedule. */
-       void *selector_env;                         /**< A pointer to give to the selector. */
+typedef struct sched_env_t {
+       unsigned *scheduled;                   /**< bitset of already scheduled nodes */
+       const list_sched_selector_t *selector; /**< The node selector. */
+       void *selector_env;                    /**< A pointer to give to the selector. */
 } sched_env_t;
 
 /**
  * Environment for a block scheduler.
  */
-typedef struct _block_sched_env_t {
-       sched_irn_t *sched_info;                    /**< scheduling info per node, copied from the global scheduler object */
-       nodeset *cands;                             /**< the set of candidates */
-       ir_node *block;                             /**< the current block */
-       sched_env_t *sched_env;                     /**< the scheduler environment */
-       nodeset *live;                              /**< simple liveness during scheduling */
+typedef struct block_sched_env_t {
+       /** scheduling info per node, copied from the global scheduler object */
+       unsigned                    *scheduled;
+       /** the set of candidates */
+       ir_nodeset_t                 cands;
+       ir_node                     *block;     /**< the current block */
+       sched_env_t                 *sched_env; /**< the scheduler environment */
        const list_sched_selector_t *selector;
-       void *selector_block_env;
-       DEBUG_ONLY(firm_dbg_module_t *dbg;)
+       void                        *selector_block_env;
 } block_sched_env_t;
 
 /**
  * Returns non-zero if the node is already scheduled
  */
-static INLINE int is_already_scheduled(block_sched_env_t *env, ir_node *n)
+static bool is_already_scheduled(const sched_env_t *env, ir_node *n)
 {
-       int idx = get_irn_idx(n);
-
-       assert(idx < ARR_LEN(env->sched_info));
-       return env->sched_info[idx].already_sched;
+       unsigned idx = get_irn_idx(n);
+       return rbitset_is_set(env->scheduled, idx);
 }
 
 /**
  * Mark a node as already scheduled
  */
-static INLINE void mark_already_scheduled(block_sched_env_t *env, ir_node *n)
+static void set_already_scheduled(sched_env_t *env, ir_node *n)
 {
-       int idx = get_irn_idx(n);
+       unsigned idx = get_irn_idx(n);
+       rbitset_set(env->scheduled, idx);
+}
+
+static void selected(block_sched_env_t *env, ir_node *irn);
+static void add_to_sched(block_sched_env_t *env, ir_node *irn);
 
-       assert(idx < ARR_LEN(env->sched_info));
-       env->sched_info[idx].already_sched = 1;
+/**
+ * Put a node in the ready set, or make it available immediately if it doesn't
+ * need to be scheduled
+ */
+static void node_ready(block_sched_env_t *env, ir_node *pred, ir_node *irn)
+{
+       if (is_Proj(irn)
+           || (arch_get_irn_flags(irn) & arch_irn_flags_not_scheduled)) {
+               selected(env, irn);
+               DB((dbg, LEVEL_3, "\tmaking immediately available: %+F\n", irn));
+       } else if (be_is_Keep(irn) || be_is_CopyKeep(irn)) {
+               /* Keeps must be scheduled immediately */
+               add_to_sched(env, irn);
+       } else {
+               ir_nodeset_insert(&env->cands, irn);
+
+               /* Notify selector about the ready node. */
+               if (env->selector->node_ready)
+                       env->selector->node_ready(env->selector_block_env, irn, pred);
+
+               DB((dbg, LEVEL_2, "\tmaking ready: %+F\n", irn));
+       }
 }
 
 /**
@@ -102,245 +135,69 @@ static INLINE void mark_already_scheduled(block_sched_env_t *env, ir_node *n)
  * @param irn   The node to make ready.
  * @return 1, if the node could be made ready, 0 else.
  */
-static INLINE int make_ready(block_sched_env_t *env, ir_node *pred, ir_node *irn)
+static void try_make_ready(block_sched_env_t *env, ir_node *pred, ir_node *irn)
 {
        int i, n;
 
-    /* Blocks cannot be scheduled. */
-    if (is_Block(irn))
-        return 0;
-
-    /*
-     * Check, if the given ir node is in a different block as the
-     * currently scheduled one. If that is so, don't make the node ready.
-     */
-    if (env->block != get_nodes_block(irn))
-        return 0;
-
-       for (i = 0, n = get_irn_ins_or_deps(irn); i < n; ++i) {
-        ir_node *op = get_irn_in_or_dep(irn, i);
-
-        /* if irn is an End we have keep-alives and op might be a block, skip that */
-        if (is_Block(op)) {
-          assert(get_irn_op(irn) == op_End);
-          continue;
-        }
-
-        /* If the operand is local to the scheduled block and not yet
-         * scheduled, this nodes cannot be made ready, so exit. */
-        if (! is_already_scheduled(env, op) && get_nodes_block(op) == env->block)
-            return 0;
-    }
-
-       nodeset_insert(env->cands, irn);
-
-       /* Notify selector about the ready node. */
-       if (env->selector->node_ready)
-               env->selector->node_ready(env->selector_block_env, irn, pred);
-
-    DB((env->dbg, LEVEL_2, "\tmaking ready: %+F\n", irn));
+       /* we schedule one block at a time, so no need to consider users in other
+        * blocks */
+       if (is_Block(irn) || get_nodes_block(irn) != env->block)
+               return;
+       if (is_Phi(irn) || is_End(irn))
+               return;
+       /* check if all operands are already available */
+       n = get_irn_ins_or_deps(irn);
+       for (i = 0; i < n; ++i) {
+               ir_node *op = get_irn_in_or_dep(irn, i);
+
+               /* If the operand is local to the scheduled block and not yet
+                * scheduled, this nodes cannot be made ready, so exit. */
+               if (get_nodes_block(op) == env->block
+                               && !is_already_scheduled(env->sched_env, op))
+                       return;
+       }
 
-    return 1;
+       node_ready(env, pred, irn);
 }
 
-/**
- * Try, to make all users of a node ready.
- * In fact, a usage node can only be made ready, if all its operands
- * have already been scheduled yet. This is checked my make_ready().
- * @param env The block schedule environment.
- * @param irn The node, which usages (successors) are to be made ready.
- */
-static INLINE void make_users_ready(block_sched_env_t *env, ir_node *irn)
+static void selected(block_sched_env_t *env, ir_node *node)
 {
-       const ir_edge_t *edge;
+       /* notify the selector about the finally selected node. */
+       if (env->selector->node_selected)
+               env->selector->node_selected(env->selector_block_env, node);
 
-       foreach_out_edge(irn, edge) {
-               ir_node *user = get_edge_src_irn(edge);
-               if (! is_Phi(user))
-                       make_ready(env, irn, user);
-       }
+    /* Insert the node in the set of all available scheduled nodes. */
+    set_already_scheduled(env->sched_env, node);
 
-       foreach_out_edge_kind(irn, edge, EDGE_KIND_DEP) {
+    /* check users, they might be ready now */
+       foreach_out_edge(node, edge) {
                ir_node *user = get_edge_src_irn(edge);
-               if (! is_Phi(user))
-                       make_ready(env, irn, user);
-       }
-}
-
-/**
- * Returns the number of not yet schedules users.
- */
-static INLINE int get_irn_not_sched_user(block_sched_env_t *env, ir_node *n) {
-       int idx = get_irn_idx(n);
-
-       assert(idx < ARR_LEN(env->sched_info));
-       return env->sched_info[idx].num_not_sched_user;
-}
-
-/**
- * Sets the number of not yet schedules users.
- */
-static INLINE void set_irn_not_sched_user(block_sched_env_t *env, ir_node *n, int num) {
-       int idx = get_irn_idx(n);
-
-       assert(idx < ARR_LEN(env->sched_info));
-       env->sched_info[idx].num_not_sched_user = num;
-}
-
-/**
- * Add @p num to the number of not yet schedules users and returns the result.
- */
-static INLINE int add_irn_not_sched_user(block_sched_env_t *env, ir_node *n, int num) {
-       int idx = get_irn_idx(n);
-
-       assert(idx < ARR_LEN(env->sched_info));
-       env->sched_info[idx].num_not_sched_user += num;
-       return env->sched_info[idx].num_not_sched_user;
-}
-
-/**
- * Returns the number of users of a node having mode datab.
- */
-static int get_num_successors(ir_node *irn) {
-       int             sum = 0;
-       const ir_edge_t *edge;
-
-       if (get_irn_mode(irn) == mode_T) {
-               /* for mode_T nodes: count the users of all Projs */
-               foreach_out_edge(irn, edge) {
-                       ir_node *proj = get_edge_src_irn(edge);
-                       ir_mode *mode = get_irn_mode(proj);
-
-                       if (mode == mode_T)
-                               sum += get_num_successors(proj);
-                       else if (mode_is_datab(mode))
-                               sum += get_irn_n_edges(proj);
-               }
-       }
-       else {
-               /* do not count keep-alive edges */
-               foreach_out_edge(irn, edge) {
-                       if (get_irn_opcode(get_edge_src_irn(edge)) != iro_End)
-                               sum++;
-               }
-       }
-
-       return sum;
-}
-
-/**
- * Adds irn to @p live, updates all inputs that this user is scheduled
- * and counts all of it's non scheduled users.
- */
-static void update_sched_liveness(block_sched_env_t *env, ir_node *irn) {
-       int i;
-
-       /* ignore Projs */
-       if (is_Proj(irn))
-               return;
-
-       for (i = get_irn_ins_or_deps(irn) - 1; i >= 0; --i) {
-               ir_node *in = get_irn_in_or_dep(irn, i);
-
-               /* if in is a proj: update predecessor */
-               while (is_Proj(in))
-                       in = get_Proj_pred(in);
-
-               /* if in is still in the live set: reduce number of users by one */
-               if (nodeset_find(env->live, in)) {
-                       if (add_irn_not_sched_user(env, in, -1) <= 0)
-                               nodeset_remove(env->live, in);
-               }
+               try_make_ready(env, node, user);
        }
-
-       /*
-               get_num_successors returns the number of all users. This includes
-               users in different blocks as well. As the each block is scheduled separately
-               the liveness info of those users will not be updated and so these
-               users will keep up the register pressure as it is desired.
-       */
-       i = get_num_successors(irn);
-       if (i > 0) {
-               set_irn_not_sched_user(env, irn, i);
-               nodeset_insert(env->live, irn);
+       foreach_out_edge_kind(node, edge, EDGE_KIND_DEP) {
+               ir_node *user = get_edge_src_irn(edge);
+               try_make_ready(env, node, user);
        }
 }
 
-static INLINE int must_appear_in_schedule(const list_sched_selector_t *sel, void *block_env, const ir_node *irn)
-{
-       int res = -1;
-
-       if(sel->to_appear_in_schedule)
-               res = sel->to_appear_in_schedule(block_env, irn);
-
-       return res >= 0 ? res : (to_appear_in_schedule(irn) || be_is_Keep(irn) || be_is_CopyKeep(irn) || be_is_RegParams(irn));
-}
-
 /**
  * Append an instruction to a schedule.
  * @param env The block scheduling environment.
  * @param irn The node to add to the schedule.
  * @return    The given node.
  */
-static ir_node *add_to_sched(block_sched_env_t *env, ir_node *irn)
+static void add_to_sched(block_sched_env_t *env, ir_node *irn)
 {
-    /* If the node consumes/produces data, it is appended to the schedule
-     * list, otherwise, it is not put into the list */
-    if (must_appear_in_schedule(env->selector, env->selector_block_env, irn)) {
-        sched_info_t *info = get_irn_sched_info(irn);
-        INIT_LIST_HEAD(&info->list);
-        info->scheduled = 1;
-               update_sched_liveness(env, irn);
-        sched_add_before(env->block, irn);
-
-        DBG((env->dbg, LEVEL_2, "\tadding %+F\n", irn));
-    }
+       assert(! (arch_get_irn_flags(irn) & arch_irn_flags_not_scheduled));
 
-       /* notify the selector about the finally selected node. */
-       if (env->selector->node_selected)
-               env->selector->node_selected(env->selector_block_env, irn);
+       sched_add_before(env->block, irn);
 
-    /* Insert the node in the set of all already scheduled nodes. */
-    mark_already_scheduled(env, irn);
+       DB((dbg, LEVEL_2, "\tschedule %+F\n", irn));
 
-    /* Remove the node from the ready set */
-    if(nodeset_find(env->cands, irn))
-        nodeset_remove(env->cands, irn);
+       /* Remove the node from the ready set */
+       ir_nodeset_remove(&env->cands, irn);
 
-    return irn;
-}
-
-/**
- * Add the proj nodes of a tuple-mode irn to the schedule immediately
- * after the tuple-moded irn. By pinning the projs after the irn, no
- * other nodes can create a new lifetime between the tuple-moded irn and
- * one of its projs. This should render a realistic image of a
- * tuple-moded irn, which in fact models a node which defines multiple
- * values.
- *
- * @param irn The tuple-moded irn.
- */
-static void add_tuple_projs(block_sched_env_t *env, ir_node *irn)
-{
-       const ir_edge_t *edge;
-
-       assert(get_irn_mode(irn) == mode_T && "Mode of node must be tuple");
-
-       if(is_Bad(irn))
-               return;
-
-       foreach_out_edge(irn, edge) {
-               ir_node *out = edge->src;
-
-               assert(is_Proj(out) && "successor of a modeT node must be a proj");
-
-               if (get_irn_mode(out) == mode_T)
-                       add_tuple_projs(env, out);
-               else {
-                       add_to_sched(env, out);
-                       make_users_ready(env, out);
-               }
-       }
+       selected(env, irn);
 }
 
 /**
@@ -356,29 +213,22 @@ static void add_tuple_projs(block_sched_env_t *env, ir_node *irn)
  */
 static void list_sched_block(ir_node *block, void *env_ptr)
 {
-       sched_env_t *env                      = env_ptr;
+       sched_env_t *env                      = (sched_env_t*)env_ptr;
        const list_sched_selector_t *selector = env->selector;
-       ir_node *start_node                   = get_irg_start(get_irn_irg(block));
-       sched_info_t *info                    = get_irn_sched_info(block);
 
        block_sched_env_t be;
-       const ir_edge_t *edge;
-       ir_node *irn;
-       int j, m;
+       ir_nodeset_t *cands = &be.cands;
 
        /* Initialize the block's list head that will hold the schedule. */
-       INIT_LIST_HEAD(&info->list);
+       sched_init_block(block);
 
        /* Initialize the block scheduling environment */
-       be.sched_info        = env->sched_info;
-       be.block             = block;
-       be.cands             = new_nodeset(get_irn_n_edges(block));
-       be.live              = new_nodeset(get_irn_n_edges(block));
-       be.selector          = selector;
-       be.sched_env         = env;
-       FIRM_DBG_REGISTER(be.dbg, "firm.be.sched");
+       be.block     = block;
+       be.selector  = selector;
+       be.sched_env = env;
+       ir_nodeset_init_size(cands, get_irn_n_edges(block));
 
-       DBG((be.dbg, LEVEL_1, "scheduling %+F\n", block));
+       DB((dbg, LEVEL_1, "scheduling %+F\n", block));
 
        if (selector->init_block)
                be.selector_block_env = selector->init_block(env->selector_env, block);
@@ -387,148 +237,69 @@ static void list_sched_block(ir_node *block, void *env_ptr)
        foreach_out_edge(block, edge) {
                ir_node *irn = get_edge_src_irn(edge);
 
-               /* Skip the end node because of keepalive edges. */
-               if (get_irn_opcode(irn) == iro_End)
-                       continue;
-
                if (is_Phi(irn)) {
-                       /*
-                               Phi functions are scheduled immediately, since they     only
-                               transfer data flow from the predecessors to this block.
-                       */
+                       /* Phi functions are scheduled immediately, since they only
+                        * transfer data flow from the predecessors to this block. */
                        add_to_sched(&be, irn);
-                       make_users_ready(&be, irn);
-               }
-               else if (irn == start_node) {
+               } else if (be_is_Start(irn)) {
                        /* The start block will be scheduled as the first node */
                        add_to_sched(&be, irn);
-                       add_tuple_projs(&be, irn);
-               }
-               else {
-                       /* Other nodes must have all operands in other blocks to be made
-                       * ready */
-                       int ready = 1;
-
-                       /* Check, if the operands of a node are not local to this block */
-                       for (j = 0, m = get_irn_ins_or_deps(irn); j < m; ++j) {
-                               ir_node *operand = get_irn_in_or_dep(irn, j);
-
-                               if (get_nodes_block(operand) == block) {
-                                       ready = 0;
-                                       break;
-                               }
-                               else {
-                                       /* live in values increase register pressure */
-                                       update_sched_liveness(&be, operand);
-                               }
-                       }
-
-                       /* Make the node ready, if all operands live in a foreign block */
-                       if (ready) {
-                               DBG((be.dbg, LEVEL_2, "\timmediately ready: %+F\n", irn));
-                               make_ready(&be, NULL, irn);
-                       }
+               } else {
+                       try_make_ready(&be, NULL, irn);
                }
        }
 
        /* Iterate over all remaining nodes */
-       while (nodeset_count(be.cands) > 0) {
-               /* collect statistics about amount of ready nodes */
-               be_do_stat_sched_ready(block, be.cands);
-
-               /* Keeps must be scheduled immediatly */
-               foreach_nodeset(be.cands, irn) {
-                       if (be_is_Keep(irn) || be_is_CopyKeep(irn)) {
-                               nodeset_break(be.cands);
-                               break;
-                       }
-               }
-
-               if (! irn) {
-                       /* Keeps must be immediately scheduled */
-                       irn = be.selector->select(be.selector_block_env, be.cands, be.live);
-               }
-
-               DB((be.dbg, LEVEL_2, "\tpicked node %+F\n", irn));
+       while (ir_nodeset_size(cands) > 0) {
+               ir_node *irn = be.selector->select(be.selector_block_env, cands);
+               DB((dbg, LEVEL_2, "\tpicked node %+F\n", irn));
 
+               /* remove the scheduled node from the ready list. */
+               ir_nodeset_remove(cands, irn);
                /* Add the node to the schedule. */
                add_to_sched(&be, irn);
-
-               if (get_irn_mode(irn) == mode_T)
-                       add_tuple_projs(&be, irn);
-               else
-                       make_users_ready(&be, irn);
-
-               /* remove the scheduled node from the ready list. */
-               if (nodeset_find(be.cands, irn))
-                       nodeset_remove(be.cands, irn);
        }
 
+       ir_nodeset_destroy(cands);
+
        if (selector->finish_block)
                selector->finish_block(be.selector_block_env);
-
-       del_nodeset(be.cands);
-       del_nodeset(be.live);
 }
 
 /* List schedule a graph. */
-void list_sched(const be_irg_t *birg, be_options_t *be_opts)
+void be_list_sched_graph(ir_graph *irg, const list_sched_selector_t *selector)
 {
-       const arch_env_t *arch_env  = birg->main_env->arch_env;
-       ir_graph         *irg       = birg->irg;
-
        int num_nodes;
        sched_env_t env;
-       mris_env_t *mris = NULL;
-       list_sched_selector_t sel;
-
-       /* Select a scheduler based on backend options */
-       switch (be_opts->sched_select) {
-               case BE_SCHED_SELECT_TRIVIAL:
-                       memcpy(&sel, trivial_selector, sizeof(sel));
-                       break;
-               case BE_SCHED_SELECT_REGPRESS:
-                       memcpy(&sel, reg_pressure_selector, sizeof(sel));
-                       break;
-               case BE_SCHED_SELECT_MUCHNIK:
-                       memcpy(&sel, muchnik_selector, sizeof(sel));
-                       break;
-               case BE_SCHED_SELECT_HEUR:
-                       memcpy(&sel, heuristic_selector, sizeof(sel));
-                       break;
-               case BE_SCHED_SELECT_HMUCHNIK:
-               default:
-                       memcpy(&sel, trivial_selector, sizeof(sel));
-       }
-
-       /* Assure, that the out edges are computed */
-       edges_assure(irg);
 
-       if (be_opts->mris)
-               mris = be_sched_mris_preprocess(birg);
+       /* Matze: This is very slow, we should avoid it to improve backend speed,
+        * we just have to make sure that we have no dangling out-edges at this
+        * point...
+        */
+       edges_deactivate(irg);
+       edges_activate(irg);
 
        num_nodes = get_irg_last_idx(irg);
 
        /* initialize environment for list scheduler */
        memset(&env, 0, sizeof(env));
-       env.selector   = arch_env->isa->impl->get_list_sched_selector(arch_env->isa, &sel);
-       env.arch_env   = arch_env;
-       env.irg        = irg;
-       env.sched_info = NEW_ARR_F(sched_irn_t, num_nodes);
+       env.selector  = selector;
+       env.scheduled = rbitset_malloc(num_nodes);
 
-       memset(env.sched_info, 0, num_nodes * sizeof(env.sched_info[0]));
-
-       if (env.selector->init_graph)
-               env.selector_env = env.selector->init_graph(env.selector, arch_env, irg);
+       if (selector->init_graph != NULL)
+               env.selector_env = selector->init_graph(irg);
 
        /* Schedule each single block. */
        irg_block_walk_graph(irg, list_sched_block, NULL, &env);
 
-       if (env.selector->finish_graph)
-               env.selector->finish_graph(env.selector_env);
+       if (selector->finish_graph != NULL)
+               selector->finish_graph(env.selector_env);
 
-       if (be_opts->mris)
-               be_sched_mris_free(mris);
+       free(env.scheduled);
+}
 
-       DEL_ARR_F(env.sched_info);
+BE_REGISTER_MODULE_CONSTRUCTOR(be_init_listsched)
+void be_init_listsched(void)
+{
+       FIRM_DBG_REGISTER(dbg, "firm.be.sched");
 }