2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Loop datastructure and access functions -- private stuff.
23 * @author Goetz Lindenmaier
27 #ifndef FIRM_ANA_IRLOOP_T_H
28 #define FIRM_ANA_IRLOOP_T_H
30 #include "firm_common.h"
31 #include "irgraph_t.h"
36 * Possible loop flags, can be or'ed.
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 /**< if set, this loop has child loops (is a no leaf). */
51 * The loops data structure.
53 * The loops data structure represents circles in the intermediate
54 * representation. It does not represent loops in the terms of a
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
64 firm_kind kind; /**< A type tag, set to k_ir_loop. */
65 unsigned depth; /**< Nesting depth */
66 size_t n_sons; /**< Number of ir_nodes in array "children" */
67 size_t n_nodes; /**< Number of loop_nodes in array "children" */
68 unsigned flags; /**< a set of loop_flags_t */
69 struct ir_loop *outer_loop; /**< The outer loop */
70 loop_element *children; /**< Mixed flexible array: Contains sons and loop_nodes */
71 ir_tarval *loop_iter_start; /**< counting loop: the start value */
72 ir_tarval *loop_iter_end; /**< counting loop: the last value reached */
73 ir_tarval *loop_iter_increment; /**< counting loop: the increment */
74 ir_node *loop_iter_variable; /**< The iteration variable of counting loop.*/
76 void *link; /**< link field. */
78 long loop_nr; /**< A unique node number for each loop node to make output
84 * Allocates a new loop as son of father on the given obstack.
85 * If father is equal NULL, a new root loop is created.
87 ir_loop *alloc_loop(ir_loop *father, struct obstack *obst);
89 /** Add a son loop to a father loop. */
90 void add_loop_son(ir_loop *loop, ir_loop *son);
92 /** Add a node to a loop. */
93 void add_loop_node(ir_loop *loop, ir_node *n);
95 /** Add an IR graph to a loop. */
96 void add_loop_irg(ir_loop *loop, ir_graph *irg);
98 /** Sets the loop a node belonging to. */
99 void set_irn_loop(ir_node *n, ir_loop *loop);
102 * Mature all loops by removing the flexible arrays of a loop tree
103 * and putting them on the given obstack.
105 void mature_loops(ir_loop *loop, struct obstack *obst);
107 /* -------- inline functions -------- */
109 static inline int _is_ir_loop(const void *thing)
111 return get_kind(thing) == k_ir_loop;
114 static inline void _set_irg_loop(ir_graph *irg, ir_loop *loop)
120 static inline ir_loop *_get_irg_loop(const ir_graph *irg)
126 static inline ir_loop *_get_loop_outer_loop(const ir_loop *loop)
128 assert(_is_ir_loop(loop));
129 return loop->outer_loop;
132 static inline unsigned _get_loop_depth(const ir_loop *loop)
134 assert(_is_ir_loop(loop));
138 static inline size_t _get_loop_n_sons(const ir_loop *loop)
140 assert(_is_ir_loop(loop));
144 /* Uses temporary information to get the loop */
145 static inline ir_loop *_get_irn_loop(const ir_node *n)
150 #define is_ir_loop(thing) _is_ir_loop(thing)
151 #define set_irg_loop(irg, loop) _set_irg_loop(irg, loop)
152 #define get_irg_loop(irg) _get_irg_loop(irg)
153 #define get_loop_outer_loop(loop) _get_loop_outer_loop(loop)
154 #define get_loop_depth(loop) _get_loop_depth(loop)
155 #define get_loop_n_sons(loop) _get_loop_n_sons(loop)
156 #define get_irn_loop(n) _get_irn_loop(n)