nsz Git - libfirm/blob - include/libfirm/irloop.h

   1 /*
   2  * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief    Loop datastructure and access functions.
  23  * @author   Goetz Lindenmaier
  24  * @date     7.2002
  25  * @version  $Id$
  26  * @brief
  27  *  Computes backedges in the control and data flow.
  28  *
  29  * @note
  30  *  Only Block and Phi nodes can have incoming backedges.
  31  *  Constructs loops data structure: indicates loop nesting.
  32  */
  33 #ifndef FIRM_ANA_IRLOOP_H
  34 #define FIRM_ANA_IRLOOP_H
  35
  36 #include "firm_types.h"
  37 #include "firm_common.h"
  38 #include "begin.h"
  39
  40 /** Returns non-zero if the predecessor pos is a backedge. */
  41 FIRM_API int is_backedge(const ir_node *n, int pos);
  42 /** Marks edge pos as a backedge. */
  43 FIRM_API void set_backedge(ir_node *n, int pos);
  44 /** Marks edge pos as a non-backedge. */
  45 FIRM_API void set_not_backedge(ir_node *n, int pos);
  46 /** Returns non-zero if n has backedges. */
  47 FIRM_API int has_backedges(const ir_node *n);
  48 /** Clears all backedge information. */
  49 FIRM_API void clear_backedges(ir_node *n);
  50
  51 /** Loop elements: loop nodes and ir nodes */
  52 typedef union {
  53         firm_kind *kind;    /**< is either k_ir_node or k_ir_loop */
  54         ir_node  *node;     /**< Pointer to an ir_node element */
  55         ir_loop  *son;      /**< Pointer to an ir_loop element */
  56         ir_graph *irg;      /**< Pointer to an ir_graph element (only callgraph loop trees) */
  57 } loop_element;
  58
  59 FIRM_API int is_ir_loop(const void *thing);
  60
  61 /** Set the outermost loop in ir graph as basic access to loop tree. */
  62 FIRM_API void set_irg_loop(ir_graph *irg, ir_loop *l);
  63
  64 /** Returns the root loop info (if exists) for an irg. */
  65 FIRM_API ir_loop *get_irg_loop(const ir_graph *irg);
  66
  67 /** Returns the loop n is contained in.  NULL if node is in no loop. */
  68 FIRM_API ir_loop *get_irn_loop(const ir_node *n);
  69
  70 /** Returns outer loop, itself if outermost. */
  71 FIRM_API ir_loop *get_loop_outer_loop(const ir_loop *loop);
  72 /** Returns nesting depth of this loop */
  73 FIRM_API unsigned get_loop_depth(const ir_loop *loop);
  74
  75 /** Returns the number of elements contained in loop.  */
  76 FIRM_API size_t get_loop_n_elements(const ir_loop *loop);
  77
  78 /** Returns a loop element.  A loop element can be interpreted as a
  79 kind pointer, an ir_node* or an ir_loop*. */
  80 FIRM_API loop_element get_loop_element(const ir_loop *loop, size_t pos);
  81
  82 /** Returns a unique node number for the loop node to make output
  83 readable. If libfirm_debug is not set it returns the loop cast to
  84 int. */
  85 FIRM_API long get_loop_loop_nr(const ir_loop *loop);
  86
  87 /** A field to connect additional information to a loop. */
  88 FIRM_API void set_loop_link(ir_loop *loop, void *link);
  89 FIRM_API void *get_loop_link(const ir_loop *loop);
  90
  91 /** Constructs backedge information and loop tree for a graph.
  92  *
  93  *  The algorithm views the program representation as a pure graph.
  94  *  It assumes that only block and phi nodes may be loop headers.
  95  *  The resulting loop tree is a possible visiting order for dataflow
  96  *  analysis.
  97  *
  98  *  This algorithm destoyes the link field of block nodes.
  99  *
 100  *  @returns Maximal depth of loop tree.
 101  *
 102  *  @remark
 103  *  One assumes, the Phi nodes in a block with a backedge have backedges
 104  *  at the same positions as the block.  This is not the case, as
 105  *  the scc algorithms does not respect the program semantics in this case.
 106  *  Take a swap in a loop (t = i; i = j; j = t;)  This results in two Phi
 107  *  nodes.  They form a cycle.  Once the scc algorithm deleted one of the
 108  *  edges, the cycle is removed.  The second Phi node does not get a
 109  *  backedge!
 110  */
 111 FIRM_API int construct_backedges(ir_graph *irg);
 112
 113 /**
 114  * Construct Intra-procedural control flow loop tree for a IR-graph.
 115  *
 116  * This constructs loop information resembling the program structure.
 117  * It is useful for loop optimizations and analyses, as, e.g., finding
 118  * iteration variables or loop invariant code motion.
 119  *
 120  * This algorithm computes only back edge information for Block nodes, not
 121  * for Phi nodes.
 122  *
 123  * This algorithm destroyes the link field of block nodes.
 124  *
 125  * @param irg  the graph
 126  *
 127  * @returns Maximal depth of loop tree.
 128  */
 129 FIRM_API int construct_cf_backedges(ir_graph *irg);
 130
 131 /**
 132  * Computes Intra-procedural control flow loop tree on demand.
 133  *
 134  * @param irg  the graph
 135  */
 136 FIRM_API void assure_loopinfo(ir_graph *irg);
 137
 138 /**
 139  * Removes all loop information.
 140  * Resets all backedges.  Works for any construction algorithm.
 141  */
 142 FIRM_API void free_loop_information(ir_graph *irg);
 143 FIRM_API void free_all_loop_information (void);
 144
 145 /** Test whether a value is loop invariant.
 146  *
 147  * @param n      The node to be tested.
 148  * @param block  A block node.
 149  *
 150  * Returns non-zero, if the node n is not changed in the loop block
 151  * belongs to or in inner loops of this block. */
 152 FIRM_API int is_loop_invariant(const ir_node *n, const ir_node *block);
 153
 154 #include "end.h"
 155
 156 #endif