give Bad nodes a mode
[libfirm] / include / libfirm / irloop.h
index 98fc703..7c6db43 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
@@ -27,7 +27,7 @@
  *  Computes backedges in the control and data flow.
  *
  * @note
- *  Only Block and Phi/Filter nodes can have incoming backedges.
+ *  Only Block and Phi nodes can have incoming backedges.
  *  Constructs loops data structure: indicates loop nesting.
  */
 #ifndef FIRM_ANA_IRLOOP_H
 /*
  * Backedge information.
  *
- * Predecessors of Block, Phi and interprocedural Filter nodes can
- * have  backedges.  If loop information is computed, this
- * information is computed, too.
+ * Predecessors of Block and Phi nodes can have  backedges.
+ * If loop information is computed, this information is computed, too.
  * The backedge information can only be used if the graph is not in
  * phase phase_building.
  */
 /* ------------------------------------------------------------------- */
 
-#ifdef INTERPROCEDURAL_VIEW
-/** Returns true if the predecessor pos is a backedge in the interprocedural view. */
-FIRM_API int is_inter_backedge(ir_node *n, int pos);
-/** Returns true if the predecessor pos is a backedge in the intraprocedural view. */
-FIRM_API int is_intra_backedge(ir_node *n, int pos);
-#endif
 /** Returns non-zero if the predecessor pos is a backedge. */
 FIRM_API int is_backedge(ir_node *n, int pos);
 /** Marks edge pos as a backedge. */
@@ -88,38 +81,40 @@ FIRM_API ir_loop *get_irn_loop(const ir_node *n);
 /** Returns outer loop, itself if outermost. */
 FIRM_API ir_loop *get_loop_outer_loop(const ir_loop *loop);
 /** Returns nesting depth of this loop */
-FIRM_API int get_loop_depth(const ir_loop *loop);
+FIRM_API unsigned get_loop_depth(const ir_loop *loop);
 
 /* Sons are the inner loops contained in this loop. */
 /** Returns the number of inner loops */
-FIRM_API int get_loop_n_sons(const ir_loop *loop);
+FIRM_API size_t get_loop_n_sons(const ir_loop *loop);
 
 /** Returns the pos`th son loop (inner loop) of a loop.
 Returns NULL if there is not a pos`th loop_node. */
-FIRM_API ir_loop *get_loop_son(ir_loop *loop, int pos);
+FIRM_API ir_loop *get_loop_son(ir_loop *loop, size_t pos);
 
 /** Returns the number of nodes contained in loop.  */
-FIRM_API int get_loop_n_nodes(const ir_loop *loop);
+FIRM_API size_t 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. */
-FIRM_API ir_node *get_loop_node(const ir_loop *loop, int pos);
+FIRM_API ir_node *get_loop_node(const ir_loop *loop, size_t pos);
 
 /** Returns the number of elements contained in loop.  */
-FIRM_API int get_loop_n_elements(const ir_loop *loop);
+FIRM_API size_t get_loop_n_elements(const ir_loop *loop);
 
 /** Returns a loop element.  A loop element can be interpreted as a
 kind pointer, an ir_node* or an ir_loop*. */
-FIRM_API loop_element get_loop_element(const ir_loop *loop, int pos);
+FIRM_API loop_element get_loop_element(const ir_loop *loop, size_t pos);
+
+#define INVALID_LOOP_POS ((size_t)-1)
 
 /** Returns the element number of the loop son in loop.
-*  Returns -1 if not found. O(|elements|). */
-FIRM_API int get_loop_element_pos(const ir_loop *loop, void *le);
+*  Returns INVALID_LOOP_POS if not found. O(|elements|). */
+FIRM_API size_t get_loop_element_pos(const ir_loop *loop, void *le);
 
 /** Returns a unique node number for the loop node to make output
 readable. If libfirm_debug is not set it returns the loop cast to
 int. */
-FIRM_API int get_loop_loop_nr(const ir_loop *loop);
+FIRM_API long get_loop_loop_nr(const ir_loop *loop);
 
 /** A field to connect additional information to a loop. */
 FIRM_API void set_loop_link(ir_loop *loop, void *link);
@@ -129,7 +124,7 @@ FIRM_API void *get_loop_link(const ir_loop *loop);
 /* Constructing and destructing the loop/backedge information.         */
 /* ------------------------------------------------------------------- */
 
-/** Constructs backedge information and loop tree for a graph in intraprocedural view.
+/** Constructs backedge information and loop tree for a graph.
  *
  *  The algorithm views the program representation as a pure graph.
  *  It assumes that only block and phi nodes may be loop headers.
@@ -151,22 +146,6 @@ FIRM_API void *get_loop_link(const ir_loop *loop);
  */
 FIRM_API int construct_backedges(ir_graph *irg);
 
-#ifdef INTERPROCEDURAL_VIEW
-/** Constructs backedges for all irgs in interprocedural view.
- *
- *  @see As construct_backedges(), but for interprocedural view.
- *
- *  @remark
- *  All loops in the graph will be marked as such, not only
- *  realizeable loops and recursions in the program.  E.g., if the
- *  same funcion is called twice, there is a loop between the first
- *  function return and the second call.
- *
- *  @returns Maximal depth of loop tree.
- */
-FIRM_API int construct_ip_backedges(void);
-#endif
-
 /**
  * Construct Intra-procedural control flow loop tree for a IR-graph.
  *
@@ -192,15 +171,6 @@ FIRM_API int construct_cf_backedges(ir_graph *irg);
  */
 FIRM_API void assure_cf_loop(ir_graph *irg);
 
-#ifdef INTERPROCEDURAL_VIEW
-/**
- * Construct Inter-procedural control flow loop tree.
- *
- * @see construct_cf_backedges() and construct_ip_backedges().
- */
-FIRM_API int construct_ip_cf_backedges(void);
-#endif
-
 /**
  * Removes all loop information.
  * Resets all backedges.  Works for any construction algorithm.