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  * @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 typedef struct list_sched_selector_t {
  44
  45         /**
  46          * Called before a graph is being scheduled.
  47          * May be NULL.
  48          *
  49          * @param irg      The backend graph.
  50          * @return         The environment pointer that is passed to all other
  51          *                 functions in this struct.
  52          */
  53         void *(*init_graph)(ir_graph *irg);
  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          * @return The chosen node.
  75          */
  76         ir_node *(*select)(void *block_env, ir_nodeset_t *ready_set);
  77
  78         /**
  79          * This function gets executed after a node finally has been made ready.
  80          * May be NULL.
  81          *
  82          * @param block_env The block environment.
  83          * @param irn       The node made ready.
  84          * @param pred      The previously scheduled node.
  85          */
  86         void (*node_ready)(void *block_env, ir_node *irn, ir_node *pred);
  87
  88         /**
  89          * This function gets executed after a node finally has been selected.
  90          * May be NULL.
  91          *
  92          * @param block_env The block environment.
  93          * @param irn       The selected node.
  94          */
  95         void (*node_selected)(void *block_env, ir_node *irn);
  96
  97         /**
  98          * Called after a block has been scheduled.
  99          * May be NULL.
 100          *
 101          * @param env The environment.
 102          * @param block_env The per block environment as returned by init_block().
 103          */
 104         void (*finish_block)(void *block_env);
 105
 106         /**
 107          * Called after a whole graph has been scheduled.
 108          * May be NULL.
 109          *
 110          * @param env The environment.
 111          */
 112         void (*finish_graph)(void *env);
 113 } list_sched_selector_t;
 114
 115 /**
 116  * List schedule a graph.
 117  * Each block in the graph gets a list head to its link field being the
 118  * head of the schedule. You can walk this list using the functions in
 119  * list.h.
 120  *
 121  * @param irg     The backend irg.
 122  */
 123 void be_list_sched_graph(ir_graph *irg, const list_sched_selector_t *selector);
 124
 125 #endif