X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;ds=sidebyside;f=ir%2Fbe%2Fbeuses.h;h=290961b0e1a2dea34520dca4a8fed72d681880ae;hb=6f068af98daa4725d60e5d23a8f98ec2841cfa44;hp=b69ddc10602e5d774823a67dc560a0c254fd968c;hpb=bbcab952705661d254a89f66c5841f05bdce402e;p=libfirm

diff --git a/ir/be/beuses.h b/ir/be/beuses.h
index b69ddc106..290961b0e 100644
--- a/ir/be/beuses.h
+++ b/ir/be/beuses.h
@@ -1,45 +1,76 @@
-/**
- * @file   beuse.h
- * @date   27.06.2005
- * @author Sebastian Hack, Matthias Braun
+/*
+ * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
  *
- * Determine future usages of values.
+ * 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.
  *
- * Copyright (C) 2005 Universitaet Karlsruhe
- * Released under the GPL
+ * 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 _BEUSES_H
-#define _BEUSES_H
 
-#include "bearch.h"
+/**
+ * @file
+ * @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
+
+#include "firm_types.h"
 #include "belive.h"
 
-typedef struct _be_next_use_t {
-	unsigned time;
-	int outermost_loop;
+/**
+ * Describes a use of a value.
+ */
+typedef struct be_next_use_t {
+	unsigned       time;
+	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
+#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 /* _BEUSES_H */
+#endif