X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Fbe%2Fbelistsched.h;h=d98d3edc816c7312289190ea75c00265f1268964;hb=026ec52ac914eee06e7afb961fb754735fb4ad9f;hp=564251a6551537648b0db5770d57c7b8d184aeed;hpb=39f3a8dbd0f00f90b7b12a849d1bf7b9c1329479;p=libfirm

diff --git a/ir/be/belistsched.h b/ir/be/belistsched.h
index 564251a65..d98d3edc8 100644
--- a/ir/be/belistsched.h
+++ b/ir/be/belistsched.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
@@ -27,8 +27,7 @@
 #ifndef FIRM_BE_BELISTSCHED_H
 #define FIRM_BE_BELISTSCHED_H
 
-#include "irgraph.h"
-#include "irnode.h"
+#include "firm_types.h"
 #include "irnodeset.h"
 
 #include "be.h"
@@ -46,14 +45,18 @@ struct _list_sched_selector_t {
 
 	/**
 	 * Called before a graph is being scheduled.
-	 * @param arch_env The architecture environment.
-	 * @param irg      The graph.
+	 * May be NULL.
+	 *
+	 * @param vtab     The selector vtab.
+	 * @param birg     The backend graph.
 	 * @return         The environment pointer that is passed to all other functions in this struct.
 	 */
-	void *(*init_graph)(const list_sched_selector_t *vtab, const arch_env_t *arch_env, ir_graph *irg);
+	void *(*init_graph)(const list_sched_selector_t *vtab, const be_irg_t *birg);
 
 	/**
 	 * Called before scheduling starts on a block.
+	 * May be NULL.
+	 *
 	 * @param graph_env   The environment.
 	 * @param block       The block which is to be scheduled.
 	 * @return A per-block pointer that is additionally passed to select.
@@ -64,6 +67,7 @@ struct _list_sched_selector_t {
 	 * The selection function.
 	 * It picks one node out of the ready list to be scheduled next.
 	 * The function does not have to delete the node from the ready set.
+	 * MUST be implemented.
 	 *
 	 * @param block_env   Some private information as returned by init_block().
 	 * @param sched_head  The schedule so far.
@@ -76,6 +80,8 @@ struct _list_sched_selector_t {
 
 	/**
 	 * This function decides, if a node should appear in a schedule.
+	 * May be NULL.
+	 *
 	 * @param block_env The block environment.
 	 * @param irn       The node.
 	 * @return 1, if the node should be scheduled, 0 if not.
@@ -84,6 +90,8 @@ struct _list_sched_selector_t {
 
 	/**
 	 * This function gets executed after a node finally has been made ready.
+	 * May be NULL.
+	 *
 	 * @param block_env The block environment.
 	 * @param irn       The node made ready.
 	 * @param pred      The previously scheduled node.
@@ -92,6 +100,8 @@ struct _list_sched_selector_t {
 
 	/**
 	 * This function gets executed after a node finally has been selected.
+	 * May be NULL.
+	 *
 	 * @param block_env The block environment.
 	 * @param irn       The selected node.
 	 */
@@ -99,12 +109,17 @@ struct _list_sched_selector_t {
 
 	/**
 	 * Returns the execution time of node irn.
+	 * May be NULL.
+	 *
+	 * @param block_env The block environment.
+	 * @param irn       The selected node.
 	 */
 	unsigned (*exectime)(void *block_env, const ir_node *irn);
 
 	/**
 	 * Calculates the latency of executing cycle curr_cycle of node curr in cycle pred_cycle
 	 * of node pred.
+	 * May be NULL.
 	 *
 	 * @param block_env   The block environment.
 	 * @param pred        The previous node.
@@ -116,6 +131,8 @@ struct _list_sched_selector_t {
 
 	/**
 	 * Called after a block has been scheduled.
+	 * May be NULL.
+	 *
 	 * @param env The environment.
 	 * @param block_env The per block environment as returned by init_block().
 	 */
@@ -123,36 +140,46 @@ struct _list_sched_selector_t {
 
 	/**
 	 * Called after a whole graph has been scheduled.
+	 * May be NULL.
+	 *
 	 * @param env The environment.
 	 */
 	void (*finish_graph)(void *env);
-
 };
 
 
 /**
  * A trivial selector, that just selects the first ready node.
  */
-extern const list_sched_selector_t *trivial_selector;
+extern const list_sched_selector_t trivial_selector;
 
-extern const list_sched_selector_t *random_selector;
+/**
+ * A trivial selector that selects a pseudo-random-node (deterministic).
+ */
+extern const list_sched_selector_t random_selector;
 
 /**
  * A selector that tries to minimize the register pressure.
  * @note Not really operational yet.
  */
-extern const list_sched_selector_t *reg_pressure_selector;
+extern const list_sched_selector_t reg_pressure_selector;
 
 /**
  * A selector based on trace scheduling as introduced by Muchnik[TM]
  */
-extern const list_sched_selector_t *muchnik_selector;
+extern const list_sched_selector_t muchnik_selector;
 
 /**
  * A selector based on trace scheduling as introduced by Muchnik[TM]
- * but using the mueller heuristic selector.
+ * but using the Mueller heuristic selector.
+ */
+extern const list_sched_selector_t heuristic_selector;
+
+/**
+ * A selector based on the strong normal form theorem (ie minimizing
+ * the register pressure).
  */
-extern const list_sched_selector_t *heuristic_selector;
+extern const list_sched_selector_t normal_selector;
 
 /**
  * List schedule a graph.
@@ -163,7 +190,7 @@ extern const list_sched_selector_t *heuristic_selector;
  * @param birg    The backend irg.
  * @param be_opts The backend options
  */
-void list_sched(const be_irg_t *birg, be_options_t *be_opts);
+void list_sched(be_irg_t *birg, be_options_t *be_opts);
 
 /**
  * List schedule a block.