nsz Git - libfirm/blob - ir/ana/irloop_t.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 -- 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 itarate once */
  47 } loop_flags_t;
  48
  49 /** The loops datastructure. */
  50 struct ir_loop {
  51   firm_kind kind;                   /**< A type tag, set to k_ir_loop. */
  52
  53   struct ir_loop *outer_loop;       /**< The outer loop */
  54   loop_element   *children;         /**< Mixed array: Contains sons and loop_nodes */
  55   int depth;                        /**< Nesting depth */
  56   int n_sons;                       /**< Number of ir_nodes in array "children" */
  57   int n_nodes;                      /**< Number of loop_nodes in array "children" */
  58   unsigned flags;                   /**< a set of loop_flags_t */
  59   tarval  *loop_iter_start;         /**< counting loop: the start value */
  60   tarval  *loop_iter_end;           /**< counting loop: the last value reached */
  61   tarval  *loop_iter_increment;     /**< counting loop: the increment */
  62   ir_node *loop_iter_variable;      /**< The iteration variable of counting loop.*/
  63
  64   /*
  65   struct state_entry *mem_phis;
  66   struct state_entry *states;
  67
  68   struct obset **oval;
  69   struct loop_node *link;
  70   */
  71 #ifdef DEBUG_libfirm
  72   long loop_nr;            /**< a unique node number for each loop node to make output
  73                               readable. */
  74   void *link;              /**< GL @@@ For debugging the analyses. */
  75 #endif
  76 };
  77
  78
  79 /** Add a son loop to a father loop. */
  80 void add_loop_son(ir_loop *loop, ir_loop *son);
  81
  82 /** Add a node to a loop. */
  83 void add_loop_node(ir_loop *loop, ir_node *n);
  84
  85 /** Sets the loop a node belonging to. */
  86 void set_irn_loop(ir_node *n, ir_loop *loop);
  87
  88 /* -------- INLINE functions -------- */
  89
  90 static INLINE int
  91 _is_ir_loop(const void *thing) {
  92   return (get_kind(thing) == k_ir_loop);
  93 }
  94
  95 static INLINE void
  96 _set_irg_loop(ir_graph *irg, ir_loop *loop) {
  97   assert(irg);
  98   irg->loop = loop;
  99 }
 100
 101 static INLINE ir_loop *
 102 _get_irg_loop(ir_graph *irg) {
 103   assert(irg);
 104   return irg->loop;
 105 }
 106
 107 static INLINE ir_loop *
 108 _get_loop_outer_loop(const ir_loop *loop) {
 109   assert(_is_ir_loop(loop));
 110   return loop->outer_loop;
 111 }
 112
 113 static INLINE int
 114 _get_loop_depth(const ir_loop *loop) {
 115   assert(_is_ir_loop(loop));
 116   return loop->depth;
 117 }
 118
 119 static INLINE int
 120 _get_loop_n_sons(const ir_loop *loop) {
 121   assert(_is_ir_loop(loop));
 122   return loop->n_sons;
 123 }
 124
 125 /* Uses temporary information to get the loop */
 126 static INLINE ir_loop *
 127 _get_irn_loop(const ir_node *n) {
 128   return n->loop;
 129 }
 130
 131 #define is_ir_loop(thing)         _is_ir_loop(thing)
 132 #define set_irg_loop(irg, loop)   _set_irg_loop(irg, loop)
 133 #define get_irg_loop(irg)         _get_irg_loop(irg)
 134 #define get_loop_outer_loop(loop) _get_loop_outer_loop(loop)
 135 #define get_loop_depth(loop)      _get_loop_depth(loop)
 136 #define get_loop_n_sons(loop)     _get_loop_n_sons(loop)
 137 #define get_irn_loop(n)           _get_irn_loop(n)
 138
 139 #endif