spill preparation needs liveness
[libfirm] / include / libfirm / irloop.h
index f448d83..0e345c6 100644 (file)
@@ -23,7 +23,7 @@
  * @author   Goetz Lindenmaier
  * @date     7.2002
  * @version  $Id$
- * @summary
+ * @brief
  *  Computes backedges in the control and data flow.
  *
  * @note
@@ -34,6 +34,7 @@
 #define FIRM_ANA_IRLOOP_H
 
 #include "firm_types.h"
+#include "firm_common.h"
 
 /* ------------------------------------------------------------------- */
 /*
@@ -48,7 +49,7 @@
 /* ------------------------------------------------------------------- */
 
 #ifdef INTERPROCEDURAL_VIEW
-/** Returns true if the predecessor pos is a backedge in the interprozeduralem view. */
+/** Returns true if the predecessor pos is a backedge in the interprocedural view. */
 int  is_inter_backedge(ir_node *n, int pos);
 /** Returns true if the predecessor pos is a backedge in the intraprocedural view. */
 int  is_intra_backedge(ir_node *n, int pos);
@@ -78,7 +79,7 @@ int      is_ir_loop(const void *thing);
 void     set_irg_loop(ir_graph *irg, ir_loop *l);
 
 /* Returns the root loop info (if exists) for an irg. */
-ir_loop *get_irg_loop(ir_graph *irg);
+ir_loop *get_irg_loop(const ir_graph *irg);
 
 /** Returns the loop n is contained in.  NULL if node is in no loop. */
 ir_loop *get_irn_loop(const ir_node *n);
@@ -97,11 +98,11 @@ Returns NULL if there is not a pos`th loop_node. */
 ir_loop *get_loop_son(ir_loop *loop, int pos);
 
 /** Returns the number of nodes contained in loop.  */
-int      get_loop_n_nodes(ir_loop *loop);
+int      get_loop_n_nodes(const ir_loop *loop);
 
 /** Returns the pos`th ir_node of a loop.
 Returns NULL if there is not a pos`th ir_node. */
-ir_node *get_loop_node(ir_loop *loop, int pos);
+ir_node *get_loop_node(const ir_loop *loop, int pos);
 
 /** Returns the number of elements contained in loop.  */
 int      get_loop_n_elements(const ir_loop *loop);
@@ -166,31 +167,43 @@ int construct_backedges(ir_graph *irg);
 int construct_ip_backedges(void);
 #endif
 
-/** Construct loop tree only for control flow.
+/**
+ * Construct Intra-procedural control flow loop tree for a IR-graph.
+ *
+ * This constructs loop information resembling the program structure.
+ * It is useful for loop optimizations and analyses, as, e.g., finding
+ * iteration variables or loop invariant code motion.
  *
- *  This constructs loop information resembling the program structure.
- *  It is useful for loop optimizations and analyses, as, e.g., finding
- *  iteration variables or loop invariant code motion.
+ * This algorithm computes only back edge information for Block nodes, not
+ * for Phi nodes.
  *
- *  This algorithm computes only back edge information for Block nodes, not
- *  for Phi nodes.
+ * This algorithm destroyes the link field of block nodes.
  *
- *  This algorithm destroyes the link field of block nodes.
+ * @param irg  the graph
  *
  * @returns Maximal depth of loop tree.
  */
 int construct_cf_backedges(ir_graph *irg);
 
+/**
+ * Computes Intra-procedural control flow loop tree on demand.
+ *
+ * @param irg  the graph
+ */
+void assure_cf_loop(ir_graph *irg);
+
 #ifdef INTERPROCEDURAL_VIEW
-/** Construct interprocedural loop tree for control flow.
+/**
+ * Construct Inter-procedural control flow loop tree.
  *
- *  @see construct_cf_backedges() and construct_ip_backedges().
+ * @see construct_cf_backedges() and construct_ip_backedges().
  */
-int construct_ip_cf_backedges (void);
+int construct_ip_cf_backedges(void);
 #endif
 
-/** Removes all loop information.
- *  Resets all backedges.  Works for any construction algorithm.
+/**
+ * Removes all loop information.
+ * Resets all backedges.  Works for any construction algorithm.
  */
 void free_loop_information(ir_graph *irg);
 void free_all_loop_information (void);
@@ -207,6 +220,6 @@ void free_all_loop_information (void);
  *
  * Returns non-zero, if the node n is not changed in the loop block
  * belongs to or in inner loops of this block. */
-int is_loop_invariant(ir_node *n, ir_node *block);
+int is_loop_invariant(const ir_node *n, const ir_node *block);
 
 #endif