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"
38 * A selector interface which is used by the list schedule framework.
39 * You can implement your own list scheduler by implementing these
42 typedef struct list_sched_selector_t {
45 * Called before a graph is being scheduled.
48 * @param irg The backend graph.
49 * @return The environment pointer that is passed to all other
50 * functions in this struct.
52 void *(*init_graph)(ir_graph *irg);
55 * Called before scheduling starts on a block.
58 * @param graph_env The environment.
59 * @param block The block which is to be scheduled.
60 * @return A per-block pointer that is additionally passed to select.
62 void *(*init_block)(void *graph_env, ir_node *block);
65 * The selection function.
66 * It picks one node out of the ready list to be scheduled next.
67 * The function does not have to delete the node from the ready set.
68 * MUST be implemented.
70 * @param block_env Some private information as returned by init_block().
71 * @param sched_head The schedule so far.
72 * @param ready_set A set containing all ready nodes. Pick one of these nodes.
73 * @return The chosen node.
75 ir_node *(*select)(void *block_env, ir_nodeset_t *ready_set);
78 * This function gets executed after a node finally has been made ready.
81 * @param block_env The block environment.
82 * @param irn The node made ready.
83 * @param pred The previously scheduled node.
85 void (*node_ready)(void *block_env, ir_node *irn, ir_node *pred);
88 * This function gets executed after a node finally has been selected.
91 * @param block_env The block environment.
92 * @param irn The selected node.
94 void (*node_selected)(void *block_env, ir_node *irn);
97 * Called after a block has been scheduled.
100 * @param env The environment.
101 * @param block_env The per block environment as returned by init_block().
103 void (*finish_block)(void *block_env);
106 * Called after a whole graph has been scheduled.
109 * @param env The environment.
111 void (*finish_graph)(void *env);
112 } list_sched_selector_t;
115 * List schedule a graph.
116 * Each block in the graph gets a list head to its link field being the
117 * head of the schedule. You can walk this list using the functions in
120 * @param irg The backend irg.
122 void be_list_sched_graph(ir_graph *irg, const list_sched_selector_t *selector);