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

   1 /*
   2  * Copyright (C) 1995-2007 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  * @summary
  27  *  Computes backedges in the control and data flow.
  28  *
  29  * @note
  30  *  Only Block and Phi/Filter 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 "irgraph.h"
  37 # include "irnode.h"
  38
  39 /* ------------------------------------------------------------------- */
  40 /*
  41  * Backedge information.
  42  *
  43  * Predecessors of Block, Phi and interprocedural Filter nodes can
  44  * have  backedges.  If loop information is computed, this
  45  * information is computed, too.
  46  * The backedge information can only be used if the graph is not in
  47  * phase phase_building.
  48  */
  49 /* ------------------------------------------------------------------- */
  50
  51 #ifdef INTERPROCEDURAL_VIEW
  52 /** Returns true if the predecessor pos is a backedge in the interprozeduralem view. */
  53 int  is_inter_backedge(ir_node *n, int pos);
  54 /** Returns true if the predecessor pos is a backedge in the intraprocedural view. */
  55 int  is_intra_backedge(ir_node *n, int pos);
  56 #endif
  57 /** Returns non-zero if the predecessor pos is a backedge. */
  58 int is_backedge (ir_node *n, int pos);
  59 /** Marks edge pos as a backedge. */
  60 void set_backedge (ir_node *n, int pos);
  61 /** Marks edge pos as a non-backedge. */
  62 void set_not_backedge (ir_node *n, int pos);
  63 /** Returns non-zero if n has backedges. */
  64 int has_backedges (ir_node *n);
  65 /** Clears all backedge information. */
  66 void clear_backedges (ir_node *n);
  67
  68
  69
  70 /** Loop elements: loop nodes and ir nodes */
  71 typedef union {
  72     firm_kind *kind;    /**< is either k_ir_node or k_ir_loop */
  73     ir_node *node;      /**< Pointer to an ir_node element */
  74     ir_loop *son;       /**< Pointer to an ir_loop element */
  75 } loop_element;
  76
  77 int      is_ir_loop(const void *thing);
  78
  79 /** Set the outermost loop in ir graph as basic access to loop tree. */
  80 void     set_irg_loop(ir_graph *irg, ir_loop *l);
  81
  82 /* Returns the root loop info (if exists) for an irg. */
  83 ir_loop *get_irg_loop(ir_graph *irg);
  84
  85 /** Returns the loop n is contained in.  NULL if node is in no loop. */
  86 ir_loop *get_irn_loop(const ir_node *n);
  87
  88 /** Returns outer loop, itself if outermost. */
  89 ir_loop *get_loop_outer_loop (const ir_loop *loop);
  90 /** Returns nesting depth of this loop */
  91 int      get_loop_depth (const ir_loop *loop);
  92
  93 /* Sons are the inner loops contained in this loop. */
  94 /** Returns the number of inner loops */
  95 int      get_loop_n_sons (const ir_loop *loop);
  96
  97 /** Returns the pos`th son loop (inner loop) of a loop.
  98     Returns NULL if there is not a pos`th loop_node. */
  99 ir_loop *get_loop_son (ir_loop *loop, int pos);
 100
 101 /** Returns the number of nodes contained in loop.  */
 102 int      get_loop_n_nodes (ir_loop *loop);
 103
 104 /** Returns the pos`th ir_node of a loop.
 105     Returns NULL if there is not a pos`th ir_node. */
 106 ir_node *get_loop_node (ir_loop *loop, int pos);
 107
 108 /** Returns the number of elements contained in loop.  */
 109 int      get_loop_n_elements (const ir_loop *loop);
 110
 111 /** Returns a loop element.  A loop element can be interpreted as a
 112     kind pointer, an ir_node* or an ir_loop*. */
 113 loop_element get_loop_element (const ir_loop *loop, int pos);
 114
 115 /** Returns the element number of the loop son in loop.
 116  *  Returns -1 if not found. O(|elements|). */
 117 int get_loop_element_pos(const ir_loop *loop, void *le);
 118
 119 /** Returns a unique node number for the loop node to make output
 120     readable. If libfirm_debug is not set it returns the loop cast to
 121     int. */
 122 int get_loop_loop_nr(const ir_loop *loop);
 123
 124 /** A field to connect additional information to a loop.  Only valid
 125     if libfirm_debug is set, else returns NULL.  */
 126 void  set_loop_link (ir_loop *loop, void *link);
 127 void *get_loop_link (const ir_loop *loop);
 128
 129 /* ------------------------------------------------------------------- */
 130 /* Constructing and destructing the loop/backedge information.         */
 131 /* ------------------------------------------------------------------- */
 132
 133 /** Constructs backedge information and loop tree for a graph in intraprocedural view.
 134  *
 135  *  The algorithm views the program representation as a pure graph.
 136  *  It assumes that only block and phi nodes may be loop headers.
 137  *  The resulting loop tree is a possible visiting order for dataflow
 138  *  analysis.
 139  *
 140  *  This algorithm destoyes the link field of block nodes.
 141  *
 142  *  @returns Maximal depth of loop tree.
 143  *
 144  *  @remark
 145  *  One assumes, the Phi nodes in a block with a backedge have backedges
 146  *  at the same positions as the block.  This is not the case, as
 147  *  the scc algorithms does not respect the program semantics in this case.
 148  *  Take a swap in a loop (t = i; i = j; j = t;)  This results in two Phi
 149  *  nodes.  They form a cycle.  Once the scc algorithm deleted one of the
 150  *  edges, the cycle is removed.  The second Phi node does not get a
 151  *  backedge!
 152  */
 153 /* @@@ Well, maybe construct_loop_information or analyze_loops ? */
 154 int construct_backedges(ir_graph *irg);
 155
 156 #ifdef INTERPROCEDURAL_VIEW
 157 /** Constructs backedges for all irgs in interprocedural view.
 158  *
 159  *  @see As construct_backedges(), but for interprocedural view.
 160  *
 161  *  @remark
 162  *  All loops in the graph will be marked as such, not only
 163  *  realizeable loops and recursions in the program.  E.g., if the
 164  *  same funcion is called twice, there is a loop between the first
 165  *  function return and the second call.
 166  *
 167  *  @returns Maximal depth of loop tree.
 168 */
 169 int construct_ip_backedges(void);
 170 #endif
 171
 172 /** Construct loop tree only for control flow.
 173  *
 174  *  This constructs loop information resembling the program structure.
 175  *  It is useful for loop optimizations and analyses, as, e.g., finding
 176  *  iteration variables or loop invariant code motion.
 177  *
 178  *  This algorithm computes only back edge information for Block nodes, not
 179  *  for Phi nodes.
 180  *
 181  *  This algorithm destoyes the link field of block nodes.
 182  *
 183  * @returns Maximal depth of loop tree.
 184  */
 185 int construct_cf_backedges(ir_graph *irg);
 186
 187 #ifdef INTERPROCEDURAL_VIEW
 188 /** Construct interprocedural loop tree for control flow.
 189  *
 190  *  @see construct_cf_backedges() and construct_ip_backedges().
 191  */
 192 int construct_ip_cf_backedges (void);
 193 #endif
 194
 195 /** Removes all loop information.
 196  *  Resets all backedges.  Works for any construction algorithm.
 197  */
 198 void free_loop_information(ir_graph *irg);
 199 void free_all_loop_information (void);
 200
 201
 202
 203
 204 /* ------------------------------------------------------------------- */
 205 /* Simple analyses based on the loop information                       */
 206 /* ------------------------------------------------------------------- */
 207
 208 /** Test whether a value is loop invariant.
 209  *
 210  * @param n      The node to be tested.
 211  * @param block  A block node.
 212  *
 213  * Returns non-zero, if the node n is not changed in the loop block
 214  * belongs to or in inner loops of this block. */
 215 int is_loop_invariant(ir_node *n, ir_node *block);
 216
 217 #endif