more comments added
[libfirm] / ir / be / belistsched.c
index d898439..45e6c44 100644 (file)
  * @author Sebastian Hack
  */
 
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
 #include <stdio.h>
 #include <stdarg.h>
 #include <string.h>
+#include <limits.h>
+
+#include "benode_t.h"
 
-#include "fourcc.h"
 #include "obst.h"
-#include "irouts.h"
+#include "list.h"
+#include "iterator.h"
+
+#include "iredges_t.h"
 #include "irgwalk.h"
 #include "irnode_t.h"
 #include "irmode_t.h"
-#include "list.h"
-#include "iterator.h"
 #include "irdump.h"
 #include "irprintf_t.h"
+#include "debug.h"
 
 #include "besched_t.h"
 #include "beutil.h"
+#include "belive_t.h"
 #include "belistsched.h"
+#include "bearch.h"
+
+#define MAX(x,y) ((x) > (y) ? (x) : (y))
+#define MIN(x,y) ((x) < (y) ? (x) : (y))
 
 /**
  * Scheduling environment for the whole graph.
  */
 typedef struct _sched_env_t {
-       const ir_graph *irg;                                            /**< The graph to schedule. */
-       list_sched_selector_t *select;  /**< The node selector. */
-       void *select_env;                                                               /**< A pointer to give to the selector. */
+    const list_sched_selector_t *selector;      /**< The node selector. */
+       const arch_env_t *arch_env;                 /**< The architecture enviromnent. */
+       const ir_graph *irg;                        /**< The graph to schedule. */
+    void *selector_env;                         /**< A pointer to give to the selector. */
 } sched_env_t;
 
-ir_node *trivial_selector(void *env, ir_node *block, int curr_time,
-               pset *already_scheduled, pset *ready_list)
+#if 0
+/*
+ * Ugly global variable for the compare function
+ * since qsort(3) does not pass an extra pointer.
+ */
+static ir_node *curr_bl = NULL;
+
+static int cmp_usage(const void *a, const void *b)
+{
+       struct trivial_sched_env *env;
+       const ir_node *p = a;
+       const ir_node *q = b;
+       int res = 0;
+
+       res = is_live_end(env->curr_bl, a) - is_live_end(env->curr_bl, b);
+
+       /*
+        * One of them is live at the end of the block.
+        * Then, that one shall be scheduled at after the other
+        */
+       if(res != 0)
+               return res;
+
+
+       return res;
+}
+#endif
+
+/**
+ * The trivial selector:
+ * Just assure that branches are executed last, otherwise select
+ * the first node ready.
+ */
+static ir_node *trivial_select(void *block_env, pset *ready_set)
+{
+       const arch_env_t *arch_env = block_env;
+       ir_node *irn = NULL;
+
+       /* assure that branches are executed last */
+       for(irn = pset_first(ready_set); irn; irn = pset_next(ready_set)) {
+               if(arch_irn_classify(arch_env, irn) != arch_irn_class_branch) {
+                       pset_break(ready_set);
+                       return irn;
+               }
+       }
+
+       irn = pset_first(ready_set);
+       pset_break(ready_set);
+
+       return irn;
+}
+
+static void *trivial_init_graph(const list_sched_selector_t *vtab, const arch_env_t *arch_env, ir_graph *irg)
+{
+       return (void *) arch_env;
+}
+
+static void *trivial_init_block(void *graph_env, ir_node *bl)
+{
+       return graph_env;
+}
+
+static INLINE int must_appear_in_schedule(const list_sched_selector_t *sel, void *block_env, const ir_node *irn)
+{
+       int res = 0;
+
+       if(sel->to_appear_in_schedule)
+               res = sel->to_appear_in_schedule(block_env, irn);
+
+       return res || to_appear_in_schedule(irn) || be_is_Keep(irn) || be_is_RegParams(irn);
+}
+
+static const list_sched_selector_t trivial_selector_struct = {
+       trivial_init_graph,
+       trivial_init_block,
+       trivial_select,
+       NULL,
+       NULL,
+       NULL
+};
+
+const list_sched_selector_t *trivial_selector = &trivial_selector_struct;
+
+typedef struct _usage_stats_t {
+       ir_node *irn;
+       struct _usage_stats_t *next;
+       int max_hops;
+       int uses_in_block;      /**< Number of uses inside the current block. */
+       int already_consumed;   /**< Number of insns using this value already
+                                                         scheduled. */
+} usage_stats_t;
+
+typedef struct {
+       const list_sched_selector_t *vtab;
+       const arch_env_t *arch_env;
+} reg_pressure_main_env_t;
+
+typedef struct {
+       struct obstack obst;
+       const reg_pressure_main_env_t *main_env;
+       usage_stats_t *root;
+       pset *already_scheduled;
+} reg_pressure_selector_env_t;
+
+static INLINE usage_stats_t *get_or_set_usage_stats(reg_pressure_selector_env_t *env, ir_node *irn)
+{
+       usage_stats_t *us = get_irn_link(irn);
+
+       if(!us) {
+               us                   = obstack_alloc(&env->obst, sizeof(us[0]));
+               us->irn              = irn;
+               us->already_consumed = 0;
+               us->max_hops         = INT_MAX;
+               us->next             = env->root;
+               env->root            = us;
+               set_irn_link(irn, us);
+       }
+
+       return us;
+}
+
+static INLINE usage_stats_t *get_usage_stats(ir_node *irn)
+{
+       usage_stats_t *us = get_irn_link(irn);
+       assert(us && "This node must have usage stats");
+       return us;
+}
+
+static int max_hops_walker(reg_pressure_selector_env_t *env, ir_node *irn, ir_node *curr_bl, int depth, unsigned visited_nr)
+{
+       ir_node *bl = get_nodes_block(irn);
+       /*
+        * If the reached node is not in the block desired,
+        * return the value passed for this situation.
+        */
+       if(get_nodes_block(irn) != bl)
+               return block_dominates(bl, curr_bl) ? 0 : INT_MAX;
+
+       /*
+        * If the node is in the current block but not
+        * yet scheduled, we keep on searching from that node.
+        */
+       if(!pset_find_ptr(env->already_scheduled, irn)) {
+               int i, n;
+               int res = 0;
+               for(i = 0, n = get_irn_arity(irn); i < n; ++i) {
+                       ir_node *operand = get_irn_n(irn, i);
+
+                       if(get_irn_visited(operand) < visited_nr) {
+                               int tmp;
+
+                               set_irn_visited(operand, visited_nr);
+                               tmp = max_hops_walker(env, operand, bl, depth + 1, visited_nr);
+                               res = MAX(tmp, res);
+                       }
+               }
+
+               return res;
+       }
+
+       /*
+        * If the node is in the current block and scheduled, return
+        * the depth which indicates the number of steps to the
+        * region of scheduled nodes.
+        */
+       return depth;
+}
+
+static int compute_max_hops(reg_pressure_selector_env_t *env, ir_node *irn)
+{
+       ir_node *bl   = get_nodes_block(irn);
+       ir_graph *irg = get_irn_irg(bl);
+       int res       = 0;
+
+       const ir_edge_t *edge;
+
+       foreach_out_edge(irn, edge) {
+               ir_node *user       = get_edge_src_irn(edge);
+               unsigned visited_nr = get_irg_visited(irg) + 1;
+               int max_hops;
+
+               set_irg_visited(irg, visited_nr);
+               max_hops = max_hops_walker(env, user, irn, 0, visited_nr);
+               res      = MAX(res, max_hops);
+       }
+
+       return res;
+}
+
+static void *reg_pressure_graph_init(const list_sched_selector_t *vtab, const arch_env_t *arch_env, ir_graph *irg)
+{
+       reg_pressure_main_env_t *main_env = xmalloc(sizeof(main_env[0]));
+
+       main_env->arch_env = arch_env;
+       main_env->vtab     = vtab;
+       irg_walk_graph(irg, firm_clear_link, NULL, NULL);
+
+       return main_env;
+}
+
+static void *reg_pressure_block_init(void *graph_env, ir_node *bl)
+{
+       ir_node *irn;
+       reg_pressure_selector_env_t *env  = xmalloc(sizeof(env[0]));
+
+       obstack_init(&env->obst);
+       env->already_scheduled = pset_new_ptr(32);
+       env->root              = NULL;
+       env->main_env          = graph_env;
+
+       /*
+        * Collect usage statistics.
+        */
+       sched_foreach(bl, irn) {
+               if(must_appear_in_schedule(env->main_env->vtab, env, irn)) {
+                       int i, n;
+
+                       for(i = 0, n = get_irn_arity(irn); i < n; ++i) {
+                               ir_node *op = get_irn_n(irn, i);
+                               if(must_appear_in_schedule(env->main_env->vtab, env, irn)) {
+                                       usage_stats_t *us = get_or_set_usage_stats(env, irn);
+                                       if(is_live_end(bl, op))
+                                               us->uses_in_block = 99999;
+                                       else
+                                               us->uses_in_block++;
+                               }
+                       }
+               }
+       }
+
+       return env;
+}
+
+static void reg_pressure_block_free(void *block_env)
+{
+       reg_pressure_selector_env_t *env = block_env;
+       usage_stats_t *us;
+
+       for(us = env->root; us; us = us->next)
+               set_irn_link(us->irn, NULL);
+
+       obstack_free(&env->obst, NULL);
+       del_pset(env->already_scheduled);
+       free(env);
+}
+
+static int get_result_hops_sum(reg_pressure_selector_env_t *env, ir_node *irn)
+{
+       int res = 0;
+       if(get_irn_mode(irn) == mode_T) {
+               const ir_edge_t *edge;
+
+               foreach_out_edge(irn, edge)
+                       res += get_result_hops_sum(env, get_edge_src_irn(edge));
+       }
+
+       else if(mode_is_data(get_irn_mode(irn)))
+               res = compute_max_hops(env, irn);
+
+
+       return res;
+}
+
+static INLINE int reg_pr_costs(reg_pressure_selector_env_t *env, ir_node *irn)
+{
+       int i, n;
+       int sum = 0;
+
+       for(i = 0, n = get_irn_arity(irn); i < n; ++i) {
+               ir_node *op = get_irn_n(irn, i);
+
+               if(must_appear_in_schedule(env->main_env->vtab, env, op))
+                       sum += compute_max_hops(env, op);
+       }
+
+       sum += get_result_hops_sum(env, irn);
+
+       return sum;
+}
+
+static ir_node *reg_pressure_select(void *block_env, pset *ready_set)
 {
-       ir_node *res = pset_first(ready_list);
-       pset_break(ready_list);
+       reg_pressure_selector_env_t *env = block_env;
+       ir_node *irn, *res     = NULL;
+       int curr_cost          = INT_MAX;
+
+       assert(pset_count(ready_set) > 0);
+
+       for(irn = pset_first(ready_set); irn; irn = pset_next(ready_set)) {
+               /*
+                       Ignore branch instructions for the time being.
+                       They should only be scheduled if there is nothing else.
+               */
+               if(arch_irn_classify(env->main_env->arch_env, irn) != arch_irn_class_branch) {
+                       int costs = reg_pr_costs(env, irn);
+                       if(costs <= curr_cost) {
+                               res       = irn;
+                               curr_cost = costs;
+                       }
+               }
+       }
+
+       /*
+               There was no result so we only saw a branch.
+               Take it and finish.
+       */
+
+       if(!res) {
+               res = pset_first(ready_set);
+               pset_break(ready_set);
+
+               assert(res && "There must be a node scheduled.");
+       }
+
+       pset_insert_ptr(env->already_scheduled, res);
        return res;
 }
 
+static const list_sched_selector_t reg_pressure_selector_struct = {
+       reg_pressure_graph_init,
+       reg_pressure_block_init,
+       reg_pressure_select,
+       NULL,
+       reg_pressure_block_free,
+       free
+};
+
+const list_sched_selector_t *reg_pressure_selector = &reg_pressure_selector_struct;
+
 static void list_sched_block(ir_node *block, void *env_ptr);
 
-void list_sched(ir_graph *irg, list_sched_selector_t *selector, void *select_env)
+void list_sched(const arch_env_t *arch_env, ir_graph *irg)
 {
        sched_env_t env;
 
        memset(&env, 0, sizeof(env));
-       env.select = selector;
-       env.select_env = select_env;
-       env.irg = irg;
-
-       /* Normalize proj nodes. */
-       normalize_proj_nodes(irg);
+       env.selector = arch_env->isa->impl->get_list_sched_selector(arch_env->isa);
+       env.arch_env = arch_env;
+       env.irg      = irg;
 
-       /* Compute the outs */
-       if(get_irg_outs_state(irg) != outs_consistent)
-               compute_outs(irg);
+       if(env.selector->init_graph)
+               env.selector_env = env.selector->init_graph(env.selector, arch_env, irg);
 
-       /* Dump the graph. */
-       dump_ir_block_graph(irg, "-before-sched");
+       /* Assure, that the out edges are computed */
+       edges_assure(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);
 }
 
 
@@ -75,30 +409,11 @@ typedef struct _block_sched_env_t {
        pset *ready_set;
        pset *already_scheduled;
        ir_node *block;
+       const list_sched_selector_t *selector;
+       void *selector_block_env;
+       DEBUG_ONLY(firm_dbg_module_t *dbg;)
 } block_sched_env_t;
 
-
-
-/**
- * Checks, if a node is to appear in a schedule. Such nodes either
- * consume real data (mode datab) or produce such.
- * @param irn The node to check for.
- * @return 1, if the node consumes/produces data, false if not.
- */
-static INLINE int to_appear_in_schedule(ir_node *irn)
-{
-       int i, n;
-
-       for(i = 0, n = get_irn_arity(irn); i < n; ++i) {
-               ir_node *op = get_irn_n(irn, i);
-               if(mode_is_datab(get_irn_mode(op)))
-                       return 1;
-       }
-
-       return mode_is_datab(get_irn_mode(irn));
-}
-
-
 /**
  * Try to put a node in the ready set.
  * @param env The block scheduler environment.
@@ -107,32 +422,32 @@ static INLINE int to_appear_in_schedule(ir_node *irn)
  */
 static INLINE int make_ready(block_sched_env_t *env, ir_node *irn)
 {
-       int i, n;
+    int i, n;
 
-       /* Blocks cannot be scheduled. */
-       if(is_Block(irn))
-               return 0;
+    /* 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;
+    /*
+     * 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_arity(irn); i < n; ++i) {
-               ir_node *op = get_irn_n(irn, i);
+    for(i = 0, n = get_irn_arity(irn); i < n; ++i) {
+        ir_node *op = get_irn_n(irn, i);
 
-               /* If the operand is local to the scheduled block and not yet
-                * scheduled, this nodes cannot be made ready, so exit. */
-               if(!pset_find_ptr(env->already_scheduled, op) && get_nodes_block(op) == env->block)
-                       return 0;
-       }
+        /* If the operand is local to the scheduled block and not yet
+         * scheduled, this nodes cannot be made ready, so exit. */
+        if(!pset_find_ptr(env->already_scheduled, op) && get_nodes_block(op) == env->block)
+            return 0;
+    }
 
-       ir_debugf("\tmaking ready: %n\n", irn);
-       pset_insert_ptr(env->ready_set, irn);
+    DBG((env->dbg, LEVEL_2, "\tmaking ready: %+F\n", irn));
+    pset_insert_ptr(env->ready_set, irn);
 
-       return 1;
+    return 1;
 }
 
 /**
@@ -162,11 +477,12 @@ static INLINE int make_ready(block_sched_env_t *env, ir_node *irn)
  */
 static INLINE void make_users_ready(block_sched_env_t *env, ir_node *irn)
 {
-       int i, n;
+       const ir_edge_t *edge;
 
-       for(i = 0, n = get_irn_n_outs(irn); i < n; ++i) {
-               ir_node *user = get_irn_out(irn, i);
-               make_ready(env, user);
+       foreach_out_edge(irn, edge) {
+               ir_node *user = edge->src;
+               if(!is_Phi(user))
+                       make_ready(env, user);
        }
 }
 
@@ -178,37 +494,37 @@ static INLINE void make_users_ready(block_sched_env_t *env, ir_node *irn)
  */
 static int node_cmp_func(const void *p1, const void *p2)
 {
-       return p1 != p2;
+    return p1 != p2;
 }
 
 /**
  * Append an instruction to a schedule.
- * @param env The block scheduleing environment.
+ * @param env The block scheduling environment.
  * @param irn The node to add to the schedule.
- * @return The given node.
+ * @return    The given node.
  */
 static ir_node *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(to_appear_in_schedule(irn)) {
-               sched_info_t *info = get_irn_sched_info(irn);
-               INIT_LIST_HEAD(&info->list);
-               sched_add(env->block, irn);
-
-               ir_debugf("\tadding %n\n", 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;
+        sched_add_before(env->block, irn);
 
-       /* Insert the node in the set of all already scheduled nodes. */
-       pset_insert_ptr(env->already_scheduled, irn);
+        DBG((env->dbg, LEVEL_2, "\tadding %+F\n", irn));
+    }
 
-       /* Remove the node from the ready set */
-       if(pset_find_ptr(env->ready_set, irn))
-               pset_remove_ptr(env->ready_set, irn);
+    /* Insert the node in the set of all already scheduled nodes. */
+    pset_insert_ptr(env->already_scheduled, irn);
 
-       return irn;
-}
+    /* Remove the node from the ready set */
+    if(pset_find_ptr(env->ready_set, irn))
+        pset_remove_ptr(env->ready_set, irn);
 
+    return irn;
+}
 
 /**
  * Add the proj nodes of a tuple-mode irn to the schedule immediately
@@ -230,11 +546,12 @@ static ir_node *add_to_sched(block_sched_env_t *env, ir_node *irn)
  */
 static void add_tuple_projs(block_sched_env_t *env, ir_node *irn)
 {
-       int i, n;
+       const ir_edge_t *edge;
+
        assert(get_irn_mode(irn) == mode_T && "Mode of node must be tuple");
 
-       for(i = 0, n = get_irn_n_outs(irn); i < n; ++i) {
-               ir_node *out = get_irn_out(irn, i);
+       foreach_out_edge(irn, edge) {
+               ir_node *out = edge->src;
 
                assert(is_Proj(out) && "successor of a modeT node must be a proj");
 
@@ -247,6 +564,20 @@ static void add_tuple_projs(block_sched_env_t *env, ir_node *irn)
        }
 }
 
+static ir_node *select_node(block_sched_env_t *be)
+{
+       ir_node *irn;
+
+       for(irn = pset_first(be->ready_set); irn; irn = pset_next(be->ready_set)) {
+               if(be_is_Keep(irn)) {
+                       pset_break(be->ready_set);
+                       return irn;
+               }
+       }
+
+       return be->selector->select(be->selector_block_env, be->ready_set);
+}
+
 /**
  * Perform list scheduling on a block.
  *
@@ -256,32 +587,44 @@ static void add_tuple_projs(block_sched_env_t *env, ir_node *irn)
  * Also the outs must have been computed.
  *
  * @param block The block node.
- * @param env Schedulting environment.
+ * @param env Scheduling environment.
  */
 static void list_sched_block(ir_node *block, void *env_ptr)
 {
-       sched_env_t *env = env_ptr;
-       block_sched_env_t be;
+       sched_env_t *env                      = env_ptr;
+       const list_sched_selector_t *selector = env->selector;
+       ir_node *start_node                   = get_irg_start(get_irn_irg(block));
+       int phi_seen                          = 0;
+       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;
-       int phi_seen = 0;
-       sched_info_t *info = get_irn_sched_info(block);
 
        /* Initialize the block's list head that will hold the schedule. */
        INIT_LIST_HEAD(&info->list);
 
        /* Initialize the block scheduling environment */
-       be.block = block;
-       be.curr_time = 0;
-       be.ready_set = new_pset(node_cmp_func, get_irn_n_outs(block));
-       be.already_scheduled = new_pset(node_cmp_func, get_irn_n_outs(block));
+       be.block             = block;
+       be.curr_time         = 0;
+       be.ready_set         = new_pset(node_cmp_func, get_irn_n_edges(block));
+       be.already_scheduled = new_pset(node_cmp_func, get_irn_n_edges(block));
+       be.selector          = selector;
+       FIRM_DBG_REGISTER(be.dbg, "firm.be.sched");
+
+       if(selector->init_block)
+               be.selector_block_env = selector->init_block(env->selector_env, block);
 
-       ir_debugf("scheduling %n\n", block);
+       DBG((be.dbg, LEVEL_1, "scheduling %+F\n", block));
 
        /* Then one can add all nodes are ready to the set. */
-       for(int i = 0, n = get_irn_n_outs(block); i < n; ++i) {
-               ir_node *irn = get_irn_out(block, i);
+       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;
 
                /* Phi functions are scheduled immediately, since they only transfer
                 * data flow from the predecessors to this block. */
@@ -291,24 +634,31 @@ static void list_sched_block(ir_node *block, void *env_ptr)
                        phi_seen = 1;
                }
 
+               /* The start block will be scheduled as the first node */
+               else if(irn == start_node) {
+                       add_to_sched(&be, irn);
+                       add_tuple_projs(&be, irn);
+               }
+
+
                /* Other nodes must have all operands in other blocks to be made
                 * ready */
                else {
-                       bool ready = true;
+                       int ready = 1;
 
                        /* Check, if the operands of a node are not local to this block */
                        for(j = 0, m = get_irn_arity(irn); j < m; ++j) {
                                ir_node *operand = get_irn_n(irn, j);
 
                                if(get_nodes_block(operand) == block) {
-                                       ready = false;
+                                       ready = 0;
                                        break;
                                }
                        }
 
                        /* Make the node ready, if all operands live in a foreign block */
                        if(ready) {
-                               ir_debugf("\timmediately ready: %n\n", irn);
+                               DBG((be.dbg, LEVEL_2, "\timmediately ready: %+F\n", irn));
                                make_ready(&be, irn);
                        }
                }
@@ -318,14 +668,10 @@ static void list_sched_block(ir_node *block, void *env_ptr)
        be.curr_time += phi_seen;
 
        while(pset_count(be.ready_set) > 0) {
-               ir_debugf("\tready set: %*n\n", pset_iterator, be.ready_set);
-               // pset_print(stdout, be.ready_set, irn_printer);
-
                /* select a node to be scheduled and check if it was ready */
-               irn = env->select(env->select_env, block, be.curr_time,
-                               be.already_scheduled, be.ready_set);
+               irn = select_node(&be);
 
-               ir_debugf("\tpicked node %n\n", irn);
+               DBG((be.dbg, LEVEL_3, "\tpicked node %+F\n", irn));
 
                /* Add the node to the schedule. */
                add_to_sched(&be, irn);
@@ -343,14 +689,9 @@ static void list_sched_block(ir_node *block, void *env_ptr)
                        pset_remove_ptr(be.ready_set, irn);
        }
 
+       if(selector->finish_block)
+               selector->finish_block(be.selector_block_env);
+
        del_pset(be.ready_set);
        del_pset(be.already_scheduled);
-
-       {
-               sched_info_t *inf;
-               list_for_each_entry(sched_info_t, inf, &info->list, list) {
-                       ir_node *irn = get_sched_info_irn(inf);
-                       ir_debugf("node: %n, pos: %d\n", irn, inf->time_step);
-               }
-       }
 }