nsz Git - libfirm/blob - ir/ana/irloop_t.h

   1 /*
   2  * Copyright (C) 1995-2008 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 -- private stuff.
  23  * @author   Goetz Lindenmaier
  24  * @date     7.2002
  25  * @version  $Id$
  26  */
  27 #ifndef FIRM_ANA_IRLOOP_T_H
  28 #define FIRM_ANA_IRLOOP_T_H
  29
  30 #include "firm_common.h"
  31 #include "irgraph_t.h"
  32 #include "irnode_t.h"
  33 #include "irloop.h"
  34
  35 /**
  36  * Possible loop flags, can be or'ed.
  37  */
  38 typedef enum loop_flags {
  39         loop_is_count_loop = 0x00000001,  /**< if set it's a counting loop */
  40         loop_downto_loop   = 0x00000002,  /**< if set, it's a downto loop, else an upto loop */
  41         loop_is_endless    = 0x00000004,  /**< if set, this is an endless loop */
  42         loop_is_dead       = 0x00000008,  /**< if set, it's a dead loop ie will never be entered */
  43         loop_wrap_around   = 0x00000010,  /**< this loop is NOT endless, because of wrap around */
  44         loop_end_false     = 0x00000020,  /**< this loop end can't be computed "from compute_loop_info.c" */
  45         do_loop            = 0x00000040,  /**< this is a do loop */
  46         once               = 0x00000080,  /**< this is a do loop, with a false condition. It iterate exactly once. */
  47         loop_outer_loop    = 0x00000100   /**< id set, this loop has child loops (is a no leaf). */
  48 } loop_flags_t;
  49
  50 /**
  51  * The loops data structure.
  52  *
  53  * The loops data structure represents circles in the intermediate
  54  * representation.  It does not represent loops in the terms of a
  55  * source program.
  56  * Each ir_graph can contain one outermost loop data structure.
  57  * loop is the entry point to the nested loops.
  58  * The loop data structure contains a field indicating the depth of
  59  * the loop within the nesting.  Further it contains a list of the
  60  * loops with nesting depth -1.  Finally it contains a list of all
  61  * nodes in the loop.
  62  *
  63  * @todo We could add a field pointing from a node to the containing loop,
  64  * this would cost a lot of memory, though.
  65  */
  66 struct ir_loop {
  67         firm_kind kind;                   /**< A type tag, set to k_ir_loop. */
  68         int depth;                        /**< Nesting depth */
  69         int n_sons;                       /**< Number of ir_nodes in array "children" */
  70         int n_nodes;                      /**< Number of loop_nodes in array "children" */
  71         unsigned flags;                   /**< a set of loop_flags_t */
  72         struct ir_loop *outer_loop;       /**< The outer loop */
  73         loop_element   *children;         /**< Mixed flexible array: Contains sons and loop_nodes */
  74         tarval  *loop_iter_start;         /**< counting loop: the start value */
  75         tarval  *loop_iter_end;           /**< counting loop: the last value reached */
  76         tarval  *loop_iter_increment;     /**< counting loop: the increment */
  77         ir_node *loop_iter_variable;      /**< The iteration variable of counting loop.*/
  78
  79         void *link;                       /**< link field. */
  80 #ifdef DEBUG_libfirm
  81         long loop_nr;                     /**< A unique node number for each loop node to make output
  82                                                readable. */
  83 #endif
  84 };
  85
  86 /**
  87  * Allocates a new loop as son of father on the given obstack.
  88  * If father is equal NULL, a new root loop is created.
  89  */
  90 ir_loop *alloc_loop(ir_loop *father, struct obstack *obst);
  91
  92 /** Add a son loop to a father loop. */
  93 void add_loop_son(ir_loop *loop, ir_loop *son);
  94
  95 /** Add a node to a loop. */
  96 void add_loop_node(ir_loop *loop, ir_node *n);
  97
  98 /** Add an IR graph to a loop. */
  99 void add_loop_irg(ir_loop *loop, ir_graph *irg);
 100
 101 /** Sets the loop a node belonging to. */
 102 void set_irn_loop(ir_node *n, ir_loop *loop);
 103
 104 /**
 105  * Mature all loops by removing the flexible arrays of a loop tree
 106  * and putting them on the given obstack.
 107  */
 108 void mature_loops(ir_loop *loop, struct obstack *obst);
 109
 110 /* -------- inline functions -------- */
 111
 112 static inline int
 113 _is_ir_loop(const void *thing) {
 114         return get_kind(thing) == k_ir_loop;
 115 }
 116
 117 static inline void
 118 _set_irg_loop(ir_graph *irg, ir_loop *loop) {
 119         assert(irg);
 120         irg->loop = loop;
 121 }
 122
 123 static inline ir_loop *
 124 _get_irg_loop(ir_graph *irg) {
 125         assert(irg);
 126         return irg->loop;
 127 }
 128
 129 static inline ir_loop *
 130 _get_loop_outer_loop(const ir_loop *loop) {
 131         assert(_is_ir_loop(loop));
 132         return loop->outer_loop;
 133 }
 134
 135 static inline int
 136 _get_loop_depth(const ir_loop *loop) {
 137         assert(_is_ir_loop(loop));
 138         return loop->depth;
 139 }
 140
 141 static inline int
 142 _get_loop_n_sons(const ir_loop *loop) {
 143         assert(_is_ir_loop(loop));
 144         return loop->n_sons;
 145 }
 146
 147 /* Uses temporary information to get the loop */
 148 static inline ir_loop *
 149 _get_irn_loop(const ir_node *n) {
 150         return n->loop;
 151 }
 152
 153 #define is_ir_loop(thing)         _is_ir_loop(thing)
 154 #define set_irg_loop(irg, loop)   _set_irg_loop(irg, loop)
 155 #define get_irg_loop(irg)         _get_irg_loop(irg)
 156 #define get_loop_outer_loop(loop) _get_loop_outer_loop(loop)
 157 #define get_loop_depth(loop)      _get_loop_depth(loop)
 158 #define get_loop_n_sons(loop)     _get_loop_n_sons(loop)
 159 #define get_irn_loop(n)           _get_irn_loop(n)
 160
 161 #endif