bearch: Disallow passing Projs to get_irn_ops().
[libfirm] / ir / be / belive.h
index cf9c6fb..9bab539 100644 (file)
@@ -1,26 +1,77 @@
+/*
+ * This file is part of libFirm.
+ * Copyright (C) 2012 University of Karlsruhe.
+ */
+
 /**
- * Interblock liveness analysis.
- * @author Sebastian Hack
- * @date 6.12.2004
+ * @file
+ * @brief       Interblock liveness analysis.
+ * @author      Sebastian Hack
+ * @date        06.12.2004
  */
+#ifndef FIRM_BE_BELIVE_H
+#define FIRM_BE_BELIVE_H
 
-#ifndef _BELIVE_H
-#define _BELIVE_H
+#include "be_types.h"
+#include "irnodeset.h"
 
-#include <stdio.h>
+typedef enum {
+       be_lv_state_none = 0,
+       be_lv_state_in   = 1,
+       be_lv_state_end  = 2,
+       be_lv_state_out  = 4,
+} be_lv_state_t;
+ENUM_BITSET(be_lv_state_t)
 
 /**
  * Compute the inter block liveness for a graph.
  * @param irg The graph.
  */
-void be_liveness(ir_graph *irg);
+be_lv_t *be_liveness_new(ir_graph *irg);
 
 /**
- * Dump the liveness information for a graph.
- * @param f The output.
- * @param irg The graph.
+ * Free the liveness information.
+ */
+void be_liveness_free(be_lv_t *lv);
+
+/**
+ * (Re)compute the liveness information if necessary.
+ */
+void be_liveness_compute_sets(be_lv_t *lv);
+void be_liveness_compute_chk(be_lv_t *lv);
+
+/**
+ * Invalidate the liveness information.
+ * You must call this if you modify the program and do not
+ * update the liveness with the be_liveness_{update,remove,introduce}
+ * functions.
+ * @note If changed the control flow then you must also call
+ *       be_liveness_invalidate_chk()
+ */
+void be_liveness_invalidate_sets(be_lv_t *lv);
+void be_liveness_invalidate_chk(be_lv_t *lv);
+
+/**
+ * Update the liveness information for a single node.
+ * It is irrelevant if there is liveness information present for the node.
+ * The liveness information for the node is firstly deleted and then recomputed.
+ * If the node is fresh and never recorded inf the liveness information before,
+ * it is more efficient to call be_liveness_introduce().
+ */
+void be_liveness_update(be_lv_t *lv, ir_node *irn);
+
+/**
+ * Remove a node from the liveness information.
  */
-void be_liveness_dump(ir_graph *irg, FILE *f);
+void be_liveness_remove(be_lv_t *lv, const ir_node *irn);
+
+/**
+ * Introduce a new node to the liveness information.
+ * The new irn is not deleted from any block's liveness information, so it must be fresh!
+ * @param lv The liveness info.
+ * @param irn The node.
+ */
+void be_liveness_introduce(be_lv_t *lv, ir_node *irn);
 
 /**
  * Check, if a node is live in at a block.
@@ -28,7 +79,7 @@ void be_liveness_dump(ir_graph *irg, FILE *f);
  * @param irn The node to check for.
  * @return 1, if @p irn is live at the entrance of @p block, 0 if not.
  */
-int (is_live_in)(const ir_node *block, const ir_node *irn);
+int (be_is_live_in)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
 
 /**
  * Check, if a node is live out at a block.
@@ -36,7 +87,7 @@ int (is_live_in)(const ir_node *block, const ir_node *irn);
  * @param irn The node to check for.
  * @return 1, if @p irn is live at the exit of @p block, 0 if not.
  */
-int (is_live_out)(const ir_node *block, const ir_node *irn);
+int (be_is_live_out)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
 
 /**
  * Check, if a node is live at the end of a block.
@@ -44,7 +95,38 @@ int (is_live_out)(const ir_node *block, const ir_node *irn);
  * @param irn The node to check for.
  * @return 1, if @p irn is live at the end of the block, 0 if not.
  */
-int (is_live_end)(const ir_node *block, const ir_node *irn);
+int (be_is_live_end)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
 
+/**
+ * The liveness transfer function.
+ * Updates a live set over a single step from a given node to its predecessor.
+ * Everything defined at the node is removed from the set, the uses of the node get inserted.
+ * @param cls      The register class to consider.
+ * @param irn      The node at which liveness should be computed.
+ * @param live     The set of nodes live before @p irn. This set gets modified by updating it to
+ *                 the nodes live after irn.
+ * @return live.
+ */
+void be_liveness_transfer(const arch_register_class_t *cls, ir_node *node,
+                          ir_nodeset_t *nodeset);
+
+/**
+ * Put all node live at the end of a block into a set.
+ * @param cls      The register class to consider.
+ * @param bl       The block.
+ * @param live     The set to put them into.
+ * @return live.
+ */
+void be_liveness_end_of_block(const be_lv_t *lv,
+                              const arch_register_class_t *cls,
+                              const ir_node *bl, ir_nodeset_t *nodeset);
+
+/**
+ * Compute a set of nodes which are live just before the given node.
+ * @param cls      The register class to consider.
+ * @param pos      The node.
+ * @param live     The set to put them into.
+ */
+void be_liveness_nodes_live_before(be_lv_t const *lv, arch_register_class_t const *cls, ir_node const *pos, ir_nodeset_t *live);
 
 #endif