bring back Carry and Borrow (firm_decomp apparently uses it) and add a note that...
[libfirm] / ir / ana / irlivechk.h
index 90ee3d0..4d258cb 100644 (file)
@@ -1,30 +1,57 @@
+/*
+ * Copyright (C) 1995-2007 Inria Rhone-Alpes.  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.
+ */
+
 /**
- * @file   irlivechk.h
- * @date   22.04.2007
- * @author Sebastian Hack
+ * @file    irlivechk.h
+ * @author  Sebastian Hack
+ * @date    22.04.2007
+ * @version $Id$
+ * @brief
  *
  * Live in/end checks whose only precomputation concerns the structure of the CFG.
  * Hence, nothing has to be updated if the program is modified unless the CFG is touched.
  * See .c file for more comments.
- *
- * Copyright (C) 2007 Universitaet Karlsruhe
- * Released under the GPL
  */
 
-#ifndef _IRLIVECHK_H
-#define _IRLIVECHK_H
+#ifndef FIRM_ANA_IRLIVECHK_H
+#define FIRM_ANA_IRLIVECHK_H
 
 #include "irgraph.h"
 #include "irnode.h"
+#include "dfs.h"
+
+typedef enum {
+       lv_chk_state_in  = 1,
+       lv_chk_state_end = 2,
+       lv_chk_state_out = 4,
+       lv_chk_state_through = lv_chk_state_in | lv_chk_state_out | lv_chk_state_end,
+} lv_chk_state_t;
 
 typedef struct _lv_chk_t lv_chk_t;
 
 /**
  * Make a new liveness check environment.
  * @param irg The graph.
+ * @param dfs A forward DFS on CFG of the given irg.
  * @return    The environment.
  */
-extern lv_chk_t *lv_chk_new(ir_graph *irg);
+extern lv_chk_t *lv_chk_new(ir_graph *irg, const dfs_t *dfs);
 
 /**
  * Free liveness check information.
@@ -32,31 +59,18 @@ extern lv_chk_t *lv_chk_new(ir_graph *irg);
  */
 extern void lv_chk_free(lv_chk_t *lv);
 
-/**
- * Check, if a node is live end of a given block.
- * @param lv   The liveness environment.
- * @param bl   The block to investigate.
- * @param irn  The node to check for.
- * @return     1, if @p what is live end at @p bl, 0 else.
- */
-extern int lv_chk_bl_end(const lv_chk_t *lv, const ir_node *bl, const ir_node *irn);
 
 /**
- * Check, if a node is live out of a given block.
+ * Return liveness information for a node concerning a block.
  * @param lv   The liveness environment.
  * @param bl   The block to investigate.
  * @param irn  The node to check for.
- * @return     1, if @p what is live out at @p bl, 0 else.
+ * @return     A bitmask of <code>lv_chk_state_t</code>.
  */
-extern int lv_chk_bl_out(const lv_chk_t *lv, const ir_node *bl, const ir_node *irn);
+extern unsigned lv_chk_bl_xxx(const lv_chk_t *lv, const ir_node *bl, const ir_node *irn);
 
-/**
- * Check, if a node is live in of a given block.
- * @param lv   The liveness environment.
- * @param bl   The block to investigate.
- * @param irn  The node to check for.
- * @return     1, if @p what is live in at @p bl, 0 else.
- */
-extern int lv_chk_bl_in(const lv_chk_t *lv, const ir_node *bl, const ir_node *irn);
+#define lv_chk_bl_in(lv, bl, irn)  ((lv_chk_bl_xxx((lv), (bl), (irn)) & lv_chk_state_in)  != 0)
+#define lv_chk_bl_end(lv, bl, irn) ((lv_chk_bl_xxx((lv), (bl), (irn)) & lv_chk_state_end) != 0)
+#define lv_chk_bl_out(lv, bl, irn) ((lv_chk_bl_xxx((lv), (bl), (irn)) & lv_chk_state_out) != 0)
 
-#endif /* _IRLIVECHK_H */
+#endif /* FIRM_ANA_IRLIVECHK_H */