2 * Primitive list scheduling.
4 * @author Sebastian Hack
7 #ifndef _FIRM_LIST_SCHED
8 #define _FIRM_LIST_SCHED
10 #include "firm_config.h"
12 #include "firm_types.h"
14 #include "benodesets.h"
18 typedef struct _list_sched_selector_t list_sched_selector_t;
21 * A selector interface which is used by the list schedule framework.
22 * You can implement your own list scheduler by implementing these
25 struct _list_sched_selector_t {
28 * Called before a graph is being scheduled.
29 * @param arch_env The architecture environment.
30 * @param irg The graph.
31 * @return The environment pointer that is passed to all other functions in this struct.
33 void *(*init_graph)(const list_sched_selector_t *vtab, const arch_env_t *arch_env, ir_graph *irg);
36 * Called before scheduling starts on a block.
37 * @param graph_env The environment.
38 * @param block The block which is to be scheduled.
39 * @return A per-block pointer that is additionally passed to select.
41 void *(*init_block)(void *graph_env, ir_node *block);
44 * The selection function.
45 * It picks one node out of the ready list to be scheduled next.
46 * The function does not have to delete the node from the ready set.
48 * @param block_env Some private information as returned by init_block().
49 * @param sched_head The schedule so far.
50 * @param ready_set A set containing all ready nodes. Pick one of these nodes.
51 * @param live_set A set containing all nodes currently alive.
52 * @return The chosen node.
54 ir_node *(*select)(void *block_env, nodeset *ready_set, nodeset *live_set);
57 * This function decides, if a node should appear in a schedule.
58 * @param block_env The block environment.
59 * @param irn The node.
60 * @return 1, if the node should be scheduled, 0 if not.
62 int (*to_appear_in_schedule)(void *block_env, const ir_node *irn);
65 * This function gets executed after a node finally has been made ready.
66 * @param block_env The block environment.
67 * @param irn The node made ready.
68 * @param pred The previously scheduled node.
70 void (*node_ready)(void *block_env, ir_node *irn, ir_node *pred);
73 * This function gets executed after a node finally has been selected.
74 * @param block_env The block environment.
75 * @param irn The selected node.
77 void (*node_selected)(void *block_env, ir_node *irn);
80 * Returns the execution time of node irn.
82 unsigned (*exectime)(void *block_env, const ir_node *irn);
85 * Calculates the latency of executing cycle curr_cycle of node curr in cycle pred_cycle
88 * @param block_env The block environment.
89 * @param pred The previous node.
90 * @param pred_cycle The previous node execution cycle.
91 * @param curr The current node.
92 * @param curr_cycle The current node execution cycle.
94 unsigned (*latency)(void *block_env, const ir_node *pred, int pred_cycle, const ir_node *curr, int curr_cycle);
97 * Called after a block has been scheduled.
98 * @param env The environment.
99 * @param block_env The per block environment as returned by init_block().
101 void (*finish_block)(void *block_env);
104 * Called after a whole graph has been scheduled.
105 * @param env The environment.
107 void (*finish_graph)(void *env);
113 * A trivial selector, that just selects the first ready node.
115 extern const list_sched_selector_t *trivial_selector;
117 extern const list_sched_selector_t *random_selector;
120 * A selector that tries to minimize the register pressure.
121 * @note Not really operational yet.
123 extern const list_sched_selector_t *reg_pressure_selector;
126 * A selector based on trace scheduling as introduced by Muchnik[TM]
128 extern const list_sched_selector_t *muchnik_selector;
131 * A selector based on trace scheduling as introduced by Muchnik[TM]
132 * but using the mueller heuristic selector.
134 extern const list_sched_selector_t *heuristic_selector;
137 * List schedule a graph.
138 * Each block in the graph gets a list head to its link field being the
139 * head of the schedule. You can walk this list using the functions in
142 * @param birg The backend irg.
143 * @param enable_mris Flag indicating if mris preparation should be done
145 void list_sched(const be_irg_t *birg, be_options_t *be_opts);
148 #include <libcore/lc_opts.h>
151 * Register list scheduler options.
153 void list_sched_register_options(lc_opt_entry_t *grp);
154 #endif /* WITH_LIBCORE */
156 #endif /* _FIRM_LIST_SCHED */