Several BugFixes and updates:

[libfirm] / ir / be / besched_t.h

diff --git a/ir/be/besched_t.h b/ir/be/besched_t.h
index 37cd255..4968b98 100644 (file)
--- a/ir/be/besched_t.h
+++ b/ir/be/besched_t.h
@@ -1,6 +1,30 @@
+/*
+ * Copyright (C) 1995-2007 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.
+ */
 
-#ifndef _BESCHED_T_H
-#define _BESCHED_T_H
+/**
+ * @file
+ * @brief       Scheduling utilities for nodes in Blocks and Blocks.
+ * @author      Sebastian Hack
+ * @version     $Id$
+ */
+#ifndef FIRM_BE_BESCHED_T_H
+#define FIRM_BE_BESCHED_T_H
 
 #define SCHED_INITIAL_GRANULARITY (1 << 14)
 
@@ -33,12 +57,6 @@ typedef struct _sched_info_t {
 #define get_irn_sched_info(irn) get_irn_data(irn, sched_info_t, sched_irn_data_offset)
 #define get_sched_info_irn(sched_info) get_irn_data_base(sched_info, sched_irn_data_offset)
 
-/**
- * Init the scheduling stuff.
- * To be called from the central backend initialization routine.
- */
-void be_sched_init(void);
-
 /**
  * Check, if the node is scheduled.
  * @param irn The node.
@@ -192,8 +210,8 @@ static INLINE void _sched_set_time_stamp(ir_node *irn)
  */
 static INLINE ir_node *_sched_add_before(ir_node *before, ir_node *irn)
 {
-       assert(_sched_is_scheduled(before) && !_sched_is_scheduled(irn));
        sched_info_t *info = get_irn_sched_info(irn);
+       assert(_sched_is_scheduled(before) && !_sched_is_scheduled(irn));
        list_add_tail(&info->list, &get_irn_sched_info(before)->list);
        _sched_set_time_stamp(irn);
        info->scheduled = 1;
@@ -208,8 +226,8 @@ static INLINE ir_node *_sched_add_before(ir_node *before, ir_node *irn)
  */
 static INLINE ir_node *_sched_add_after(ir_node *after, ir_node *irn)
 {
-       assert(_sched_is_scheduled(after) && !_sched_is_scheduled(irn));
        sched_info_t *info = get_irn_sched_info(irn);
+       assert(_sched_is_scheduled(after) && !_sched_is_scheduled(irn));
        list_add(&info->list, &get_irn_sched_info(after)->list);
        _sched_set_time_stamp(irn);
        info->scheduled = 1;
@@ -257,20 +275,6 @@ static INLINE int _sched_cmp(const ir_node *a, const ir_node *b)
   return get_irn_sched_info(a)->time_step - get_irn_sched_info(b)->time_step;
 }
 
-/**
- * Verify a schedule.
- * @param block The block whose schedule to verify.
- * @return      1, if the schedule is proper, 0 if not.
- */
-extern int sched_verify(const ir_node *block);
-
-/**
- * Verify the schedules in all blocks of the irg.
- * @param irg The program graph.
- * @return    1, if all schedules were right, 0 if not.
- */
-extern int sched_verify_irg(ir_graph *irg);
-
 /**
  * Checks, if one node is scheduled before another.
  * @param n1   A node.
@@ -294,20 +298,36 @@ static INLINE int _sched_comes_after(const ir_node *n1, const ir_node *n2)
  */
 typedef int (sched_predicator_t)(const ir_node *irn, void *data);
 
-
+/**
+ * Predicate for sched_skip(), returns non-zero if irn is a control flow changing node.
+ *
+ * @param irn   the node to evaluate
+ * @param data  an arch_env_t * used to determine if irn is a cf
+ *              node for the given architecture
+ */
 int sched_skip_cf_predicator(const ir_node *irn, void *data);
+
+/**
+ * Predicate for sched_skip(), returns non-zero if irn is a Phi node.
+ *
+ * Used with sched_skip().
+ *
+ * @param irn  the node to evaluate
+ * @param data unused
+ */
 int sched_skip_phi_predicator(const ir_node *irn, void *data);
 
 /**
  * Skip nodes in a schedule.
- * @param from The node to start from.
- * @param forward The direction (1 for forward, 0 for backward).
- * @param predicator The one who decides what is skipped.
- * @param data Food for the predicator.
- * @return The first node rejected by the predicator or the block
- * itself if none was rejected.
+ * @param from        The node to start from.
+ * @param forward     The direction (1 for forward, 0 for backward).
+ * @param predicator  The predicator function which decides what is skipped.
+ * @param data        context parameter for the predicator.
+ *
+ * @return The first node not rejected by the predicator or the block
+ *         itself if all nodes were rejected.
  */
-extern ir_node *sched_skip(ir_node *from, int forward,
+ir_node *sched_skip(ir_node *from, int forward,
     sched_predicator_t *predicator, void *data);
 
 #define sched_get_time_step(irn)        _sched_get_time_step(irn)
@@ -324,4 +344,4 @@ extern ir_node *sched_skip(ir_node *from, int forward,
 #define sched_comes_after(n1, n2)       _sched_comes_after(n1, n2)
 #define sched_cmp(a, b)                 _sched_cmp(a, b)
 
-#endif
+#endif /* FIRM_BE_BESCHED_T_H */