expose some critical bearch functions for inlining

[libfirm] / ir / be / beuses.h

diff --git a/ir/be/beuses.h b/ir/be/beuses.h
index c36ad55..dbd74eb 100644 (file)
--- a/ir/be/beuses.h
+++ b/ir/be/beuses.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
@@ -22,7 +22,6 @@
  * @brief       Methods to compute when a value will be used again.
  * @author      Sebastian Hack, Matthias Braun
  * @date        27.06.2005
- * @version     $Id$
  */
 #ifndef FIRM_BE_BEUSES_H
 #define FIRM_BE_BEUSES_H
@@ -30,33 +29,47 @@
 #include "firm_types.h"
 #include "belive.h"
 
-typedef struct _be_next_use_t {
+/**
+ * Describes a use of a value.
+ */
+typedef struct be_next_use_t {
        unsigned       time;
-       int            outermost_loop;
+       unsigned       outermost_loop;
+       /* point of the next use is at the beginning of this node. */
        const ir_node *before;
 } be_next_use_t;
 
 #define USES_INFINITY  10000000
 #define USES_PENDING   9999999
 
-static INLINE int USES_IS_INFINITE(unsigned time)
+static inline bool USES_IS_INFINITE(unsigned time)
 {
        return time >= USES_INFINITY;
 }
 
-static INLINE int USES_IS_PENDING(unsigned time)
+static inline bool USES_IS_PENDING(unsigned time)
 {
        return time == USES_PENDING;
 }
 
-typedef struct _be_uses_t be_uses_t;
+typedef struct be_uses_t be_uses_t;
 
 be_next_use_t be_get_next_use(be_uses_t *uses, ir_node *from,
-                         unsigned from_step, const ir_node *def,
-                         int skip_from_uses);
+                              const ir_node *def, int skip_from_uses);
 
+/**
+ * Creates a new uses environment for a graph.
+ *
+ * @param irg  the graph
+ * @param lv   liveness information for the graph
+ */
 be_uses_t *be_begin_uses(ir_graph *irg, const be_lv_t *lv);
 
+/**
+ * Destroys the given uses environment.
+ *
+ * @param uses  the environment
+ */
 void be_end_uses(be_uses_t *uses);
 
-#endif /* FIRM_BE_BEUSES_H */
+#endif