beifg: Factorise code to count interference components.
[libfirm] / ir / be / belistsched.h
index ac9fd3d..fd59bca 100644 (file)
-/**
- * Primitive list scheduling.
- * @date 20.10.2004
- * @author Sebastian Hack
+/*
+ * This file is part of libFirm.
+ * Copyright (C) 2012 University of Karlsruhe.
  */
 
-#ifndef _FIRM_LIST_SCHED
-#define _FIRM_LIST_SCHED
+/**
+ * @file
+ * @brief       Common functions for creating listscheduling algorithms
+ * @author      Sebastian Hack
+ * @date        20.10.2004
+ */
+#ifndef FIRM_BE_BELISTSCHED_H
+#define FIRM_BE_BELISTSCHED_H
 
-#include "irgraph.h"
-#include "irnode.h"
+#include "firm_types.h"
+#include "irnodeset.h"
 
-#include "pset.h"
-#include "pmap.h"
-#include "list.h"
+#include "be.h"
+#include "be_types.h"
+#include "bearch.h"
 
 /**
  * A selector interface which is used by the list schedule framework.
  * You can implement your own list scheduler by implementing these
  * functions.
  */
-typedef struct _list_sched_selector_t {
+typedef struct list_sched_selector_t {
+
        /**
         * Called before a graph is being scheduled.
-        * @param irg The graph.
-        * @return The environment pointer that is passed to all other
-        * functions in this struct.
+        * May be NULL.
+        *
+        * @param irg      The backend graph.
+        * @return         The environment pointer that is passed to all other
+        *                 functions in this struct.
         */
        void *(*init_graph)(ir_graph *irg);
 
        /**
         * Called before scheduling starts on a block.
-        * @param env The environment.
-        * @param block The block which is to be scheduled.
+        * May be NULL.
+        *
+        * @param graph_env   The environment.
+        * @param block       The block which is to be scheduled.
         * @return A per-block pointer that is additionally passed to select.
         */
-       void *(*init_block)(void *env, ir_node *block);
+       void *(*init_block)(void *graph_env, ir_node *block);
 
        /**
         * The selection function.
         * It picks one node out of the ready list to be scheduled next.
         * The function does not have to delete the node from the ready set.
+        * MUST be implemented.
         *
-        * @param env Some private information as returned by init_graph().
-        * @return block_env Some provate information as returned by init_block().
-        * @param sched_head The schedule so far.
-        * @param curr_time The current time step which the picked node
-        * will be assigned to.
-        * @param ready_list A set containing all ready nodes. Pick one of these
-        * nodes.
+        * @param block_env   Some private information as returned by init_block().
+        * @param sched_head  The schedule so far.
+        * @param ready_set   A set containing all ready nodes. Pick one of these nodes.
         * @return The chosen node.
         */
-       ir_node *(*select)(void *env, void *block_env,
-                       const struct list_head *sched_head,
-                       int curr_time, pset *ready_set);
+       ir_node *(*select)(void *block_env, ir_nodeset_t *ready_set);
+
+       /**
+        * This function gets executed after a node finally has been made ready.
+        * May be NULL.
+        *
+        * @param block_env The block environment.
+        * @param irn       The node made ready.
+        * @param pred      The previously scheduled node.
+        */
+       void (*node_ready)(void *block_env, ir_node *irn, ir_node *pred);
+
+       /**
+        * This function gets executed after a node finally has been selected.
+        * May be NULL.
+        *
+        * @param block_env The block environment.
+        * @param irn       The selected node.
+        */
+       void (*node_selected)(void *block_env, ir_node *irn);
 
        /**
         * Called after a block has been scheduled.
+        * May be NULL.
+        *
         * @param env The environment.
-        * @param block_env The per block environemtn as returned by init_block().
-        * @param block The block that has been finished.
+        * @param block_env The per block environment as returned by init_block().
         */
-       void (*finish_block)(void *env, void *block_env, ir_node *block);
+       void (*finish_block)(void *block_env);
 
        /**
         * Called after a whole graph has been scheduled.
+        * May be NULL.
+        *
         * @param env The environment.
-        * @param irg The graph.
         */
-       void (*finish_graph)(void *env, ir_graph *irg);
+       void (*finish_graph)(void *env);
 } list_sched_selector_t;
 
-
-/**
- * A trivial selector, that just selects the first ready node.
- */
-extern const list_sched_selector_t *trivial_selector;
-
 /**
  * List schedule a graph.
  * Each block in the graph gets a list head to its link field being the
  * head of the schedule. You can walk this list using the functions in
  * list.h.
- * @param irg The graph to schedule.
- * @param sched_obst An obstack to allocate the lists on.
- * @param map Maps each block to a list head giving the schedule.
- * @param select_func A selection function.
+ *
+ * @param irg     The backend irg.
  */
-void list_sched(ir_graph *irg, const list_sched_selector_t *select_func);
-
-void be_sched_imm(ir_graph *irg);
+void be_list_sched_graph(ir_graph *irg, const list_sched_selector_t *selector);
 
 #endif