* @brief Loop datastructure and access functions.
* @author Goetz Lindenmaier
* @date 7.2002
- * @version $Id$
* @brief
* Computes backedges in the control and data flow.
*
#include "firm_common.h"
#include "begin.h"
-/* ------------------------------------------------------------------- */
-/*
- * Backedge information.
- *
- * 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.
+/** @ingroup irana
+ * @defgroup ir_loop Loops
+ * @{
*/
-/* ------------------------------------------------------------------- */
/** Returns non-zero if the predecessor pos is a backedge. */
-FIRM_API int is_backedge(ir_node *n, int pos);
+FIRM_API int is_backedge(const ir_node *n, int pos);
/** Marks edge pos as a backedge. */
FIRM_API void set_backedge(ir_node *n, int pos);
/** Marks edge pos as a non-backedge. */
FIRM_API void set_not_backedge(ir_node *n, int pos);
/** Returns non-zero if n has backedges. */
-FIRM_API int has_backedges(ir_node *n);
+FIRM_API int has_backedges(const ir_node *n);
/** Clears all backedge information. */
FIRM_API void clear_backedges(ir_node *n);
/** Loop elements: loop nodes and ir nodes */
typedef union {
- firm_kind *kind; /**< is either k_ir_node or k_ir_loop */
- ir_node *node; /**< Pointer to an ir_node element */
- ir_loop *son; /**< Pointer to an ir_loop element */
- ir_graph *irg; /**< Pointer to an ir_graph element (only callgraph loop trees) */
+ firm_kind *kind; /**< is either k_ir_node or k_ir_loop */
+ ir_node *node; /**< Pointer to an ir_node element */
+ ir_loop *son; /**< Pointer to an ir_loop element */
+ ir_graph *irg; /**< Pointer to an ir_graph element (only callgraph loop trees) */
} loop_element;
+/** Tests whether a given pointer points to a loop.
+ * @note only works reliably if @p thing points to something with a ::firm_kind
+ * header */
FIRM_API int is_ir_loop(const void *thing);
-/** Set the outermost loop in ir graph as basic access to loop tree. */
+/** Sets the outermost loop in ir graph as basic access to loop tree. */
FIRM_API void set_irg_loop(ir_graph *irg, ir_loop *l);
-/* Returns the root loop info (if exists) for an irg. */
+/** Returns the root loop info (if exists) for an irg. */
FIRM_API ir_loop *get_irg_loop(const ir_graph *irg);
/** Returns the loop n is contained in. NULL if node is in no loop. */
/** Returns nesting depth of this 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 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, size_t pos);
-
-/** Returns the number of nodes contained in 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, size_t pos);
-
/** Returns the number of elements contained in 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*. */
+/** 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, size_t pos);
-#define INVALID_LOOP_POS ((size_t)-1)
-
-/** Returns the element number of the loop son in loop.
-* 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. */
/** A field to connect additional information to a loop. */
FIRM_API void set_loop_link(ir_loop *loop, void *link);
+/** Returns field with additional loop information.
+ * @see set_loop_link() */
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.
*
* The algorithm views the program representation as a pure graph.
*
* This algorithm destoyes the link field of block nodes.
*
- * @returns Maximal depth of loop tree.
- *
* @remark
* One assumes, the Phi nodes in a block with a backedge have backedges
* at the same positions as the block. This is not the case, as
* edges, the cycle is removed. The second Phi node does not get a
* backedge!
*/
-FIRM_API int construct_backedges(ir_graph *irg);
+FIRM_API void construct_backedges(ir_graph *irg);
/**
* Construct Intra-procedural control flow loop tree for a IR-graph.
* This algorithm destroyes the link field of block nodes.
*
* @param irg the graph
- *
- * @returns Maximal depth of loop tree.
*/
-FIRM_API int construct_cf_backedges(ir_graph *irg);
+FIRM_API void construct_cf_backedges(ir_graph *irg);
/**
* Computes Intra-procedural control flow loop tree on demand.
*
* @param irg the graph
*/
-FIRM_API void assure_cf_loop(ir_graph *irg);
+FIRM_API void assure_loopinfo(ir_graph *irg);
/**
* Removes all loop information.
* Resets all backedges. Works for any construction algorithm.
*/
FIRM_API void free_loop_information(ir_graph *irg);
-FIRM_API void free_all_loop_information (void);
+/** Removes loop information from all graphs in the current program. */
+FIRM_API void free_all_loop_information(void);
-
-/* ------------------------------------------------------------------- */
-/* Simple analyses based on the loop information */
-/* ------------------------------------------------------------------- */
-
-/** Test whether a value is loop invariant.
+/** Tests whether a value is loop invariant.
*
* @param n The node to be tested.
* @param block A block node.
* belongs to or in inner loops of this block. */
FIRM_API int is_loop_invariant(const ir_node *n, const ir_node *block);
+/** @} */
+
#include "end.h"
#endif
projects / libfirm / blobdiff