put register classes into arch_env struct, no need for complicated callbacks
[libfirm] / ir / be / belistsched.h
index f4fb4cf..b852d7a 100644 (file)
+/*
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
+ */
+
 /**
- * Primitive list scheduling.
- * @date 20.10.2004
- * @author Sebastian Hack
+ * @file
+ * @brief       Primitive list scheduling with different node selectors.
+ * @author      Sebastian Hack
+ * @date        20.10.2004
+ * @version     $Id$
  */
+#ifndef FIRM_BE_BELISTSCHED_H
+#define FIRM_BE_BELISTSCHED_H
+
+#include "firm_types.h"
+#include "irnodeset.h"
+
+#include "be.h"
+#include "be_types.h"
+#include "bearch.h"
+#include "beirg.h"
 
-#ifndef _FIRM_LIST_SCHED
-#define _FIRM_LIST_SCHED
+/**
+ * A selector interface which is used by the list schedule framework.
+ * You can implement your own list scheduler by implementing these
+ * functions.
+ */
+struct list_sched_selector_t {
 
-#include "pset.h"
-#include "pmap.h"
-#include "list.h"
+       /**
+        * Called before a graph is being scheduled.
+        * May be NULL.
+        *
+        * @param vtab     The selector vtab.
+        * @param irg      The backend graph.
+        * @return         The environment pointer that is passed to all other functions in this struct.
+        */
+       void *(*init_graph)(const list_sched_selector_t *vtab, ir_graph *irg);
+
+       /**
+        * Called before scheduling starts on a block.
+        * 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 *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 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.
+        * @param live_set    A set containing all nodes currently alive.
+        * @return The chosen node.
+        */
+       ir_node *(*select)(void *block_env, ir_nodeset_t *ready_set,
+                       ir_nodeset_t *live_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);
+
+       /**
+        * Returns the execution time of node irn.
+        * May be NULL.
+        *
+        * @param block_env The block environment.
+        * @param irn       The selected node.
+        */
+       unsigned (*exectime)(void *block_env, const ir_node *irn);
+
+       /**
+        * Calculates the latency of executing cycle curr_cycle of node curr in cycle pred_cycle
+        * of node pred.
+        * May be NULL.
+        *
+        * @param block_env   The block environment.
+        * @param pred        The previous node.
+        * @param pred_cycle  The previous node execution cycle.
+        * @param curr        The current node.
+        * @param curr_cycle  The current node execution cycle.
+        */
+       unsigned (*latency)(void *block_env, const ir_node *pred, int pred_cycle, const ir_node *curr, int curr_cycle);
+
+       /**
+        * Called after a block has been scheduled.
+        * May be NULL.
+        *
+        * @param env The environment.
+        * @param block_env The per block environment as returned by init_block().
+        */
+       void (*finish_block)(void *block_env);
+
+       /**
+        * Called after a whole graph has been scheduled.
+        * May be NULL.
+        *
+        * @param env The environment.
+        */
+       void (*finish_graph)(void *env);
+};
 
-#include "besched_t.h"
 
 /**
- * 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.
- *
- * @param env Some private information as passed to list_schedule().
- * @param block The block which is currentliy scheduled.
- * @param curr_time The current time step which the picked node
- * will be assigned to.
- * @param already_scheduled A set containing all nodes already
- * scheduled.
- * @param ready_list A set containing all ready nodes. Pick one of these
- * nodes.
- * @return The chosen node.
+ * A trivial selector, that just selects the first ready node.
  */
-typedef ir_node *(list_sched_selector_t)(void *env, ir_node *block,
-               int curr_time, pset *already_scheduled, pset *ready_list);
+extern const list_sched_selector_t trivial_selector;
 
-ir_node *trivial_selector(void *env, ir_node *block, int curr_time,
-               pset *already_scheduled, pset *ready_list);
+/**
+ * A trivial selector that selects a pseudo-random-node (deterministic).
+ */
+extern const list_sched_selector_t random_selector;
+
+/**
+ * A selector that tries to minimize the register pressure.
+ * @note Not really operational yet.
+ */
+extern const list_sched_selector_t reg_pressure_selector;
+
+/**
+ * A selector based on trace scheduling as introduced by Muchnik[TM]
+ */
+extern const list_sched_selector_t muchnik_selector;
+
+/**
+ * A selector based on trace scheduling as introduced by Muchnik[TM]
+ * but using the Mueller heuristic selector.
+ */
+extern const list_sched_selector_t heuristic_selector;
+
+/**
+ * A selector based on the strong normal form theorem (ie minimizing
+ * the register pressure).
+ */
+extern const list_sched_selector_t normal_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 env Some private data to give to the select function.
+ *
+ * @param irg     The backend irg.
  */
-void list_sched(ir_graph *irg, list_sched_selector_t *select_func, void *env);
-
+void list_sched(ir_graph *irg);
 
+/**
+ * List schedule a block.
+ * Same as list_sched but only for a certain block (needed for ILP fallback).
+ */
+void list_sched_single_block(ir_graph *irg, ir_node *block);
 
 #endif