replaced malloc by xmalloc
[libfirm] / ir / be / belistsched.h
index 5a24ab4..680cafc 100644 (file)
@@ -7,44 +7,97 @@
 #ifndef _FIRM_LIST_SCHED
 #define _FIRM_LIST_SCHED
 
+#include "firm_types.h"
+
 #include "pset.h"
 #include "pmap.h"
 #include "list.h"
 
+#include "bearch_t.h"
+
+typedef struct _list_sched_selector_t list_sched_selector_t;
+
+/**
+ * A selector interface which is used by the list schedule framework.
+ * You can implement your own list scheduler by implementing these
+ * functions.
+ */
+struct _list_sched_selector_t {
+
+       /**
+        * Called before a graph is being scheduled.
+        * @param arch_env The architecture environment.
+        * @param irg      The 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);
+
+       /**
+        * Called before scheduling starts on a block.
+        * @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.
+        */
+       void *(*init_block)(void *graph_env, ir_node *block);
+
+       /**
+        * 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.
+        *
+        * @return block_env Some private information as returned by init_block().
+        * @param sched_head The schedule so far.
+        * @param curr_time The current time step which the picked node
+        * will be assigned to.
+        * @param ready_list A set containing all ready nodes. Pick one of these
+        * nodes.
+        * @return The chosen node.
+        */
+       ir_node *(*select)(void *block_env, pset *ready_set);
+
+       /**
+        * This function decides, if a node should appear in a schedule.
+        * @param block_env The block environment.
+        * @param irn       The node.
+        * @return 1, if the node should be scheduled, 0 if not.
+        */
+       int (*to_appear_in_schedule)(void *block_env, const ir_node *irn);
+
+       /**
+        * Called after a block has been scheduled.
+        * @param env The environment.
+        * @param block_env The per block environment as returned by init_block().
+        */
+       void (*finish_block)(void *block_env);
+
+       /**
+        * Called after a whole graph has been scheduled.
+        * @param env The environment.
+        */
+       void (*finish_graph)(void *env);
+
+};
+
+
 /**
- * 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.
- *
- * @param env Some private information as passed to list_schedule().
- * @param block The block which is currentliy scheduled.
- * @param curr_time The current time step which the picked node
- * will be assigned to.
- * @param already_scheduled A set containing all nodes already
- * scheduled.
- * @param ready_list A set containing all ready nodes. Pick one of these
- * nodes.
- * @return The chosen node.
+ * A trivial selector, that just selects the first ready node.
  */
-typedef ir_node *(list_sched_selector_t)(void *env, ir_node *block,
-               int curr_time, pset *already_scheduled, pset *ready_list);
+extern const list_sched_selector_t *trivial_selector;
 
-ir_node *trivial_selector(void *env, ir_node *block, int curr_time,
-               pset *already_scheduled, pset *ready_list);
+/**
+ * A selector that tries to minimize the register pressure.
+ * @note Not really operational yet.
+ */
+extern const list_sched_selector_t *reg_pressure_selector;
 
 /**
  * List schedule a graph.
  * Each block in the graph gets a list head to its link field being the
  * head of the schedule. You can walk this list using the functions in
  * list.h.
- * @param irg The graph to schedule.
- * @param sched_obst An obstack to allocate the lists on.
- * @param map Maps each block to a list head giving the schedule.
- * @param select_func A selection function.
- * @param env Some private data to give to the select function.
+ * @param arch_env The architecture environment.
+ * @param irg      The graph to schedule.
  */
-void list_sched(ir_graph *irg, list_sched_selector_t *select_func, void *env);
-
-
+void list_sched(const arch_env_t *arch_env, ir_graph *irg);
 
-#endif
+#endif /* _FIRM_LIST_SCHED */