2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Common functions for creating listscheduling algorithms
23 * @author Sebastian Hack
26 #ifndef FIRM_BE_BELISTSCHED_H
27 #define FIRM_BE_BELISTSCHED_H
29 #include "firm_types.h"
30 #include "irnodeset.h"
37 * A selector interface which is used by the list schedule framework.
38 * You can implement your own list scheduler by implementing these
41 typedef struct list_sched_selector_t {
44 * Called before a graph is being scheduled.
47 * @param irg The backend graph.
48 * @return The environment pointer that is passed to all other
49 * functions in this struct.
51 void *(*init_graph)(ir_graph *irg);
54 * Called before scheduling starts on a block.
57 * @param graph_env The environment.
58 * @param block The block which is to be scheduled.
59 * @return A per-block pointer that is additionally passed to select.
61 void *(*init_block)(void *graph_env, ir_node *block);
64 * The selection function.
65 * It picks one node out of the ready list to be scheduled next.
66 * The function does not have to delete the node from the ready set.
67 * MUST be implemented.
69 * @param block_env Some private information as returned by init_block().
70 * @param sched_head The schedule so far.
71 * @param ready_set A set containing all ready nodes. Pick one of these nodes.
72 * @return The chosen node.
74 ir_node *(*select)(void *block_env, ir_nodeset_t *ready_set);
77 * This function gets executed after a node finally has been made ready.
80 * @param block_env The block environment.
81 * @param irn The node made ready.
82 * @param pred The previously scheduled node.
84 void (*node_ready)(void *block_env, ir_node *irn, ir_node *pred);
87 * This function gets executed after a node finally has been selected.
90 * @param block_env The block environment.
91 * @param irn The selected node.
93 void (*node_selected)(void *block_env, ir_node *irn);
96 * Called after a block has been scheduled.
99 * @param env The environment.
100 * @param block_env The per block environment as returned by init_block().
102 void (*finish_block)(void *block_env);
105 * Called after a whole graph has been scheduled.
108 * @param env The environment.
110 void (*finish_graph)(void *env);
111 } list_sched_selector_t;
114 * List schedule a graph.
115 * Each block in the graph gets a list head to its link field being the
116 * head of the schedule. You can walk this list using the functions in
119 * @param irg The backend irg.
121 void be_list_sched_graph(ir_graph *irg, const list_sched_selector_t *selector);