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       Common functions for creating listscheduling algorithms
  23  * @author      Sebastian Hack
  24  * @date        20.10.2004
  25  */
  26 #ifndef FIRM_BE_BELISTSCHED_H
  27 #define FIRM_BE_BELISTSCHED_H
  28
  29 #include "firm_types.h"
  30 #include "irnodeset.h"
  31
  32 #include "be.h"
  33 #include "be_types.h"
  34 #include "bearch.h"
  35
  36 /**
  37  * A selector interface which is used by the list schedule framework.
  38  * You can implement your own list scheduler by implementing these
  39  * functions.
  40  */
  41 typedef struct list_sched_selector_t {
  42
  43         /**
  44          * Called before a graph is being scheduled.
  45          * May be NULL.
  46          *
  47          * @param irg      The backend graph.
  48          * @return         The environment pointer that is passed to all other
  49          *                 functions in this struct.
  50          */
  51         void *(*init_graph)(ir_graph *irg);
  52
  53         /**
  54          * Called before scheduling starts on a block.
  55          * May be NULL.
  56          *
  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.
  60          */
  61         void *(*init_block)(void *graph_env, ir_node *block);
  62
  63         /**
  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.
  68          *
  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.
  73          */
  74         ir_node *(*select)(void *block_env, ir_nodeset_t *ready_set);
  75
  76         /**
  77          * This function gets executed after a node finally has been made ready.
  78          * May be NULL.
  79          *
  80          * @param block_env The block environment.
  81          * @param irn       The node made ready.
  82          * @param pred      The previously scheduled node.
  83          */
  84         void (*node_ready)(void *block_env, ir_node *irn, ir_node *pred);
  85
  86         /**
  87          * This function gets executed after a node finally has been selected.
  88          * May be NULL.
  89          *
  90          * @param block_env The block environment.
  91          * @param irn       The selected node.
  92          */
  93         void (*node_selected)(void *block_env, ir_node *irn);
  94
  95         /**
  96          * Called after a block has been scheduled.
  97          * May be NULL.
  98          *
  99          * @param env The environment.
 100          * @param block_env The per block environment as returned by init_block().
 101          */
 102         void (*finish_block)(void *block_env);
 103
 104         /**
 105          * Called after a whole graph has been scheduled.
 106          * May be NULL.
 107          *
 108          * @param env The environment.
 109          */
 110         void (*finish_graph)(void *env);
 111 } list_sched_selector_t;
 112
 113 /**
 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
 117  * list.h.
 118  *
 119  * @param irg     The backend irg.
 120  */
 121 void be_list_sched_graph(ir_graph *irg, const list_sched_selector_t *selector);
 122
 123 #endif