+/*
+ * 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.
+ */
+
/**
- * Scheduling algorithms.
- * Just a simple list scheduling algorithm is here.
- * @date 20.10.2004
- * @author Sebastian Hack
+ * @file
+ * @brief Primitive list scheduling with different node selectors.
+ * @author Sebastian Hack
+ * @date 20.10.2004
+ * @version $Id$
*/
+#include "config.h"
#include <stdio.h>
#include <stdarg.h>
#include <string.h>
+#include <limits.h>
+#include <stdbool.h>
+
+#include "benode.h"
+#include "be_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 "array.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 "bearch.h"
+#include "bestat.h"
+#include "beirg.h"
+
+#include "lc_opts.h"
+#include "lc_opts_enum.h"
+
+/* we have prolog, "normal" and epilog */
+#define N_PRIORITY_CLASSES 3
+
+DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL);
/**
* 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. */
+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;
-ir_node *trivial_selector(void *env, ir_node *block, int curr_time,
- pset *already_scheduled, pset *ready_list)
-{
- ir_node *res = pset_first(ready_list);
- pset_break(ready_list);
- return res;
-}
-
-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)
-{
- 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);
-
- /* Compute the outs */
- if(get_irg_outs_state(irg) != outs_consistent)
- compute_outs(irg);
-
- /* Dump the graph. */
- dump_ir_block_graph(irg, "-before-sched");
-
- /* Schedule each single block. */
- irg_block_walk_graph(irg, list_sched_block, NULL, &env);
-}
-
-
/**
* Environment for a block scheduler.
*/
-typedef struct _block_sched_env_t {
- int curr_time;
- pset *ready_set;
- pset *already_scheduled;
- ir_node *block;
+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[N_PRIORITY_CLASSES];
+ ir_node *block; /**< the current block */
+ sched_env_t *sched_env; /**< the scheduler environment */
+ const list_sched_selector_t *selector;
+ void *selector_block_env;
} 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.
+ * map prolog/normal/epilog into 3 priority levels
*/
-static INLINE int to_appear_in_schedule(ir_node *irn)
+static unsigned get_priority(const ir_node *node)
{
- 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));
+ arch_irn_flags_t flags = arch_irn_get_flags(node);
+ if (flags & arch_irn_flags_prolog) {
+ assert(! (flags & arch_irn_flags_epilog));
+ return 0;
+ } else if (flags & arch_irn_flags_epilog) {
+ return 2;
+ }
+ return 1;
}
-
/**
- * Try to put a node in the ready set.
- * @param env The block scheduler environment.
- * @param irn The node to make ready.
- * @return 1, if the node could be made ready, 0 else.
+ * Returns non-zero if the node is already scheduled
*/
-static INLINE int make_ready(block_sched_env_t *env, ir_node *irn)
+static bool is_already_scheduled(const sched_env_t *env, ir_node *n)
{
- 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_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;
- }
-
- ir_debugf("\tmaking ready: %n\n", irn);
- pset_insert_ptr(env->ready_set, irn);
-
- return 1;
+ unsigned idx = get_irn_idx(n);
+ return rbitset_is_set(env->scheduled, idx);
}
/**
- * Check, if a node is ready in a block schedule.
- * @param env The block schedule environment.
- * @param irn The node to check for.
- * @return 1 if the node was ready, 0 if not.
+ * Mark a node as already scheduled
*/
-#define is_ready(env,irn) \
- (pset_find_ptr((env)->ready_set, irn) != NULL)
+static void set_already_scheduled(sched_env_t *env, ir_node *n)
+{
+ unsigned idx = get_irn_idx(n);
+ rbitset_set(env->scheduled, idx);
+}
-/**
- * Check, if a node has already been schedules.
- * @param env The block schedule environment.
- * @param irn The node to check for.
- * @return 1 if the node was already scheduled, 0 if not.
- */
-#define is_scheduled(env,irn) \
- (pset_find_ptr((env)->already_scheduled, irn) != NULL)
+static void selected(block_sched_env_t *env, ir_node *irn);
+static void add_to_sched(block_sched_env_t *env, ir_node *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.
+ * Put a node in the ready set, or make it available immediately if it doesn't
+ * need to be scheduled
*/
-static INLINE void make_users_ready(block_sched_env_t *env, ir_node *irn)
+static void node_ready(block_sched_env_t *env, ir_node *pred, ir_node *irn)
{
- int i, n;
-
- for(i = 0, n = get_irn_n_outs(irn); i < n; ++i) {
- ir_node *user = get_irn_out(irn, i);
- if(!is_Phi(user))
- make_ready(env, user);
- }
+ if (is_Proj(irn)
+ || (arch_irn_get_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 {
+ unsigned priority = get_priority(irn);
+ ir_nodeset_insert(&env->cands[priority], 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));
+ }
}
/**
- * Compare to nodes using pointer equality.
- * @param p1 Node one.
- * @param p2 Node two.
- * @return 0 if they are identical.
+ * Try to put a node in the ready set.
+ * @param env The block scheduler environment.
+ * @param pred The previous scheduled node.
+ * @param irn The node to make ready.
+ * @return 1, if the node could be made ready, 0 else.
*/
-static int node_cmp_func(const void *p1, const void *p2)
+static void try_make_ready(block_sched_env_t *env, ir_node *pred, ir_node *irn)
+{
+ int i, n;
+
+ /* 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;
+ }
+
+ node_ready(env, pred, irn);
+}
+
+static void selected(block_sched_env_t *env, ir_node *node)
{
- return p1 != p2;
+ 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);
+
+ /* Insert the node in the set of all available scheduled nodes. */
+ set_already_scheduled(env->sched_env, node);
+
+ /* check users, they might be ready now */
+ foreach_out_edge(node, edge) {
+ ir_node *user = get_edge_src_irn(edge);
+ try_make_ready(env, node, user);
+ }
+ foreach_out_edge_kind(node, edge, EDGE_KIND_DEP) {
+ ir_node *user = get_edge_src_irn(edge);
+ try_make_ready(env, node, user);
+ }
}
/**
* 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)
+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(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);
- }
-
- /* Insert the node in the set of all already scheduled nodes. */
- pset_insert_ptr(env->already_scheduled, 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;
-}
+ unsigned priority = get_priority(irn);
+ assert(! (arch_irn_get_flags(irn) & arch_irn_flags_not_scheduled));
-/**
- * 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.
- * @param list The schedule list to append all the projs.
- * @param time The time step to which the irn and all its projs are
- * related to.
- * @param obst The obstack the scheduling data structures shall be
- * created upon.
- * @param ready_set The ready set of the list scheduler.
- * @param already_scheduled A set containing all nodes already
- * scheduled.
- */
-static void add_tuple_projs(block_sched_env_t *env, ir_node *irn)
-{
- int i, n;
- assert(get_irn_mode(irn) == mode_T && "Mode of node must be tuple");
+ sched_add_before(env->block, irn);
- for(i = 0, n = get_irn_n_outs(irn); i < n; ++i) {
- ir_node *out = get_irn_out(irn, i);
+ DB((dbg, LEVEL_2, "\tschedule %+F\n", irn));
- assert(is_Proj(out) && "successor of a modeT node must be a proj");
+ /* Remove the node from the ready set */
+ ir_nodeset_remove(&env->cands[priority], irn);
- 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);
}
/**
* 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;
-
- 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));
-
- ir_debugf("scheduling %n\n", block);
-
- /* Then one can add all nodes are ready to the set. */
- int i;
- int n;
- for(i = 0, n = get_irn_n_outs(block); i < n; ++i) {
- ir_node *irn = get_irn_out(block, i);
-
- /* Phi functions are scheduled immediately, since they only transfer
- * data flow from the predecessors to this block. */
- if(is_Phi(irn)) {
- add_to_sched(&be, irn);
- make_users_ready(&be, irn);
- phi_seen = 1;
- }
-
- /* Other nodes must have all operands in other blocks to be made
- * ready */
- else {
- bool ready = true;
-
- /* 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;
- break;
- }
- }
-
- /* Make the node ready, if all operands live in a foreign block */
- if(ready) {
- ir_debugf("\timmediately ready: %n\n", irn);
- make_ready(&be, irn);
- }
- }
- }
-
- /* Increase the time, if some phi functions have been scheduled */
- 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);
-
- ir_debugf("\tpicked node %n\n", 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);
-
- /* Increase the time step. */
- be.curr_time += 1;
-
- /* remove the scheduled node from the ready list. */
- if(pset_find_ptr(be.ready_set, irn))
- pset_remove_ptr(be.ready_set, irn);
- }
-
- 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);
- }
- }
+ sched_env_t *env = (sched_env_t*)env_ptr;
+ const list_sched_selector_t *selector = env->selector;
+
+ block_sched_env_t be;
+ const ir_edge_t *edge;
+ unsigned p;
+
+ /* Initialize the block's list head that will hold the schedule. */
+ sched_init_block(block);
+
+ /* Initialize the block scheduling environment */
+ be.block = block;
+ be.selector = selector;
+ be.sched_env = env;
+ for (p = 0; p < N_PRIORITY_CLASSES; ++p) {
+ ir_nodeset_init_size(&be.cands[p], get_irn_n_edges(block));
+ }
+
+ DB((dbg, LEVEL_1, "scheduling %+F\n", block));
+
+ if (selector->init_block)
+ be.selector_block_env = selector->init_block(env->selector_env, block);
+
+ /* Then one can add all nodes are ready to the set. */
+ foreach_out_edge(block, edge) {
+ ir_node *irn = get_edge_src_irn(edge);
+
+ if (is_Phi(irn)) {
+ /* Phi functions are scheduled immediately, since they only
+ * transfer data flow from the predecessors to this block. */
+ add_to_sched(&be, irn);
+ } else if (be_is_Start(irn)) {
+ /* The start block will be scheduled as the first node */
+ add_to_sched(&be, irn);
+ } else {
+ try_make_ready(&be, NULL, irn);
+ }
+ }
+
+ /* Iterate over all remaining nodes */
+ for (p = 0; p < N_PRIORITY_CLASSES; ++p) {
+ ir_nodeset_t *p_cands = &be.cands[p];
+ while (ir_nodeset_size(p_cands) > 0) {
+ ir_node *irn = be.selector->select(be.selector_block_env, p_cands);
+ DB((dbg, LEVEL_2, "\tpicked node %+F\n", irn));
+
+ /* remove the scheduled node from the ready list. */
+ ir_nodeset_remove(p_cands, irn);
+ /* Add the node to the schedule. */
+ add_to_sched(&be, irn);
+ }
+ }
+
+ if (selector->finish_block)
+ selector->finish_block(be.selector_block_env);
+
+ for (p = 0; p < N_PRIORITY_CLASSES; ++p) {
+ /** all cand lists should be empty. Otherwise there was some invalid
+ * dependencies between priority classes (ie. priority 0 value depending
+ * on a priority 1 value) */
+ assert(ir_nodeset_size(&be.cands[p]) == 0);
+ ir_nodeset_init_size(&be.cands[p], get_irn_n_edges(block));
+ }
+}
+
+/* List schedule a graph. */
+void be_list_sched_graph(ir_graph *irg, const list_sched_selector_t *selector)
+{
+ int num_nodes;
+ sched_env_t env;
+
+ /* 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 = selector;
+ env.scheduled = rbitset_malloc(num_nodes);
+
+ 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 (selector->finish_graph != NULL)
+ selector->finish_graph(env.selector_env);
+
+ free(env.scheduled);
+}
+
+BE_REGISTER_MODULE_CONSTRUCTOR(be_init_listsched);
+void be_init_listsched(void)
+{
+ FIRM_DBG_REGISTER(dbg, "firm.be.sched");
}