nsz Git - libfirm/blob - ir/be/belistsched.h

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   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.
  10  *
  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.
  14  *
  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
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief       Primitive list scheduling with different node selectors.
  23  * @author      Sebastian Hack
  24  * @date        20.10.2004
  25  * @version     $Id$
  26  */
  27 #ifndef FIRM_BE_BELISTSCHED_H
  28 #define FIRM_BE_BELISTSCHED_H
  29
  30 #include "firm_types.h"
  31 #include "irnodeset.h"
  32
  33 #include "be.h"
  34 #include "be_types.h"
  35 #include "bearch.h"
  36 #include "beirg.h"
  37
  38 /**
  39  * A selector interface which is used by the list schedule framework.
  40  * You can implement your own list scheduler by implementing these
  41  * functions.
  42  */
  43 struct _list_sched_selector_t {
  44
  45         /**
  46          * Called before a graph is being scheduled.
  47          * May be NULL.
  48          *
  49          * @param vtab     The selector vtab.
  50          * @param birg     The backend graph.
  51          * @return         The environment pointer that is passed to all other functions in this struct.
  52          */
  53         void *(*init_graph)(const list_sched_selector_t *vtab, const be_irg_t *birg);
  54
  55         /**
  56          * Called before scheduling starts on a block.
  57          * May be NULL.
  58          *
  59          * @param graph_env   The environment.
  60          * @param block       The block which is to be scheduled.
  61          * @return A per-block pointer that is additionally passed to select.
  62          */
  63         void *(*init_block)(void *graph_env, ir_node *block);
  64
  65         /**
  66          * The selection function.
  67          * It picks one node out of the ready list to be scheduled next.
  68          * The function does not have to delete the node from the ready set.
  69          * MUST be implemented.
  70          *
  71          * @param block_env   Some private information as returned by init_block().
  72          * @param sched_head  The schedule so far.
  73          * @param ready_set   A set containing all ready nodes. Pick one of these nodes.
  74          * @param live_set    A set containing all nodes currently alive.
  75          * @return The chosen node.
  76          */
  77         ir_node *(*select)(void *block_env, ir_nodeset_t *ready_set,
  78                        ir_nodeset_t *live_set);
  79
  80         /**
  81          * This function decides, if a node should appear in a schedule.
  82          * May be NULL.
  83          *
  84          * @param block_env The block environment.
  85          * @param irn       The node.
  86          * @return 1, if the node should be scheduled, 0 if not.
  87          */
  88         int (*to_appear_in_schedule)(void *block_env, const ir_node *irn);
  89
  90         /**
  91          * This function gets executed after a node finally has been made ready.
  92          * May be NULL.
  93          *
  94          * @param block_env The block environment.
  95          * @param irn       The node made ready.
  96          * @param pred      The previously scheduled node.
  97          */
  98         void (*node_ready)(void *block_env, ir_node *irn, ir_node *pred);
  99
 100         /**
 101          * This function gets executed after a node finally has been selected.
 102          * May be NULL.
 103          *
 104          * @param block_env The block environment.
 105          * @param irn       The selected node.
 106          */
 107         void (*node_selected)(void *block_env, ir_node *irn);
 108
 109         /**
 110          * Returns the execution time of node irn.
 111          * May be NULL.
 112          *
 113          * @param block_env The block environment.
 114          * @param irn       The selected node.
 115          */
 116         unsigned (*exectime)(void *block_env, const ir_node *irn);
 117
 118         /**
 119          * Calculates the latency of executing cycle curr_cycle of node curr in cycle pred_cycle
 120          * of node pred.
 121          * May be NULL.
 122          *
 123          * @param block_env   The block environment.
 124          * @param pred        The previous node.
 125          * @param pred_cycle  The previous node execution cycle.
 126          * @param curr        The current node.
 127          * @param curr_cycle  The current node execution cycle.
 128          */
 129         unsigned (*latency)(void *block_env, const ir_node *pred, int pred_cycle, const ir_node *curr, int curr_cycle);
 130
 131         /**
 132          * Called after a block has been scheduled.
 133          * May be NULL.
 134          *
 135          * @param env The environment.
 136          * @param block_env The per block environment as returned by init_block().
 137          */
 138         void (*finish_block)(void *block_env);
 139
 140         /**
 141          * Called after a whole graph has been scheduled.
 142          * May be NULL.
 143          *
 144          * @param env The environment.
 145          */
 146         void (*finish_graph)(void *env);
 147 };
 148
 149
 150 /**
 151  * A trivial selector, that just selects the first ready node.
 152  */
 153 extern const list_sched_selector_t trivial_selector;
 154
 155 /**
 156  * A trivial selector that selects a pseudo-random-node (deterministic).
 157  */
 158 extern const list_sched_selector_t random_selector;
 159
 160 /**
 161  * A selector that tries to minimize the register pressure.
 162  * @note Not really operational yet.
 163  */
 164 extern const list_sched_selector_t reg_pressure_selector;
 165
 166 /**
 167  * A selector based on trace scheduling as introduced by Muchnik[TM]
 168  */
 169 extern const list_sched_selector_t muchnik_selector;
 170
 171 /**
 172  * A selector based on trace scheduling as introduced by Muchnik[TM]
 173  * but using the Mueller heuristic selector.
 174  */
 175 extern const list_sched_selector_t heuristic_selector;
 176
 177 /**
 178  * A selector based on the strong normal form theorem (ie minimizing
 179  * the register pressure).
 180  */
 181 extern const list_sched_selector_t normal_selector;
 182
 183 /**
 184  * List schedule a graph.
 185  * Each block in the graph gets a list head to its link field being the
 186  * head of the schedule. You can walk this list using the functions in
 187  * list.h.
 188  *
 189  * @param birg    The backend irg.
 190  * @param be_opts The backend options
 191  */
 192 void list_sched(be_irg_t *birg, be_options_t *be_opts);
 193
 194 /**
 195  * List schedule a block.
 196  * Same as list_sched but only for a certain block (needed for ILP fallback).
 197  */
 198 void list_sched_single_block(const be_irg_t *birg, ir_node *block, be_options_t *be_opts);
 199
 200 #endif /* FIRM_BE_BELISTSCHED_H */