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
25 * @version $Id: irloop_t.h 17143 2008-01-02 20:56:33Z beck $
36 void add_loop_son(ir_loop *loop, ir_loop *son)
39 assert(loop && loop->kind == k_ir_loop);
40 assert(get_kind(son) == k_ir_loop);
42 ARR_APP1(loop_element, loop->children, lson);
44 loop->flags |= loop_outer_loop;
47 void add_loop_node(ir_loop *loop, ir_node *n)
51 assert(loop && loop->kind == k_ir_loop);
52 ARR_APP1(loop_element, loop->children, ln);
56 void add_loop_irg(ir_loop *loop, ir_graph *irg)
60 assert(loop && loop->kind == k_ir_loop);
61 ARR_APP1(loop_element, loop->children, ln);
66 * Mature all loops by removing the flexible arrays of a loop.
68 * @param loop the loop to mature
69 * @param obst an obstack, where the new arrays are allocated on
71 void mature_loops(ir_loop *loop, struct obstack *obst)
73 loop_element *new_children = DUP_ARR_D(loop_element, obst, loop->children);
74 DEL_ARR_F(loop->children);
75 loop->children = new_children;
77 if (loop->n_sons > 0) {
78 /* we have child loops, mature them */
81 for (i = ARR_LEN(new_children) - 1; i >= 0; --i) {
82 loop_element child = new_children[i];
84 if (*child.kind == k_ir_loop) {
85 mature_loops(child.son, obst);
91 /* Returns outer loop, itself if outermost. */
92 ir_loop *(get_loop_outer_loop)(const ir_loop *loop)
94 return _get_loop_outer_loop(loop);
97 /* Returns nesting depth of this loop */
98 int (get_loop_depth)(const ir_loop *loop)
100 return _get_loop_depth(loop);
103 /* Returns the number of inner loops */
104 int (get_loop_n_sons)(const ir_loop *loop)
106 return _get_loop_n_sons(loop);
109 /* Returns the pos`th loop_node-child *
110 * TODO: This method isn`t very efficient ! *
111 * Returns NULL if there isn`t a pos`th loop_node */
112 ir_loop *get_loop_son(ir_loop *loop, int pos)
114 int child_nr = 0, loop_nr = -1;
116 assert(loop && loop->kind == k_ir_loop);
117 while (child_nr < ARR_LEN(loop->children)) {
118 if (*(loop->children[child_nr].kind) == k_ir_loop)
121 return loop->children[child_nr].son;
127 /* Returns the number of nodes in the loop */
128 int get_loop_n_nodes(const ir_loop *loop)
130 assert(loop); assert(loop->kind == k_ir_loop);
131 return loop->n_nodes;
134 /* Returns the pos'th ir_node-child *
135 * TODO: This method isn't very efficient ! *
136 * Returns NULL if there isn't a pos'th ir_node */
137 ir_node *get_loop_node(const ir_loop *loop, int pos)
139 int child_nr, node_nr = -1;
141 assert(loop && loop->kind == k_ir_loop);
142 assert(pos < get_loop_n_nodes(loop));
144 for (child_nr = 0; child_nr < ARR_LEN(loop->children); child_nr++) {
145 if (*(loop->children[child_nr].kind) == k_ir_node)
148 return loop -> children[child_nr].node;
151 panic("no child at pos found");
154 /* Returns the number of elements contained in loop. */
155 int get_loop_n_elements(const ir_loop *loop)
157 assert(loop && loop->kind == k_ir_loop);
158 return(ARR_LEN(loop->children));
162 Returns the pos`th loop element.
163 This may be a loop_node or a ir_node. The caller of this function has
164 to check the *(loop_element.kind) field for "k_ir_node" or "k_ir_loop"
165 and then select the appropriate "loop_element.node" or "loop_element.son".
167 loop_element get_loop_element(const ir_loop *loop, int pos)
169 assert(loop && loop->kind == k_ir_loop && pos < ARR_LEN(loop->children));
170 return(loop -> children[pos]);
173 int get_loop_element_pos(const ir_loop *loop, void *le)
176 assert(loop && loop->kind == k_ir_loop);
178 n = get_loop_n_elements(loop);
179 for (i = 0; i < n; i++)
180 if (get_loop_element(loop, i).node == le)
187 * Sets the loop for a node.
189 void set_irn_loop(ir_node *n, ir_loop *loop)
194 ir_loop *(get_irn_loop)(const ir_node *n)
196 return _get_irn_loop(n);
199 int get_loop_loop_nr(const ir_loop *loop)
201 assert(loop && loop->kind == k_ir_loop);
203 return loop->loop_nr;
209 void set_loop_link(ir_loop *loop, void *link)
211 assert(loop && loop->kind == k_ir_loop);
215 void *get_loop_link(const ir_loop *loop)
217 assert(loop && loop->kind == k_ir_loop);
221 int (is_ir_loop)(const void *thing)
223 return _is_ir_loop(thing);
226 /* The outermost loop is remarked in the surrounding graph. */
227 void (set_irg_loop)(ir_graph *irg, ir_loop *loop)
229 _set_irg_loop(irg, loop);
232 /* Returns the root loop info (if exists) for an irg. */
233 ir_loop *(get_irg_loop)(const ir_graph *irg)
235 return _get_irg_loop(irg);
239 * Allocates a new loop as son of father on the given obstack.
240 * If father is equal NULL, a new root loop is created.
242 ir_loop *alloc_loop(ir_loop *father, struct obstack *obst)
246 son = OALLOCZ(obst, ir_loop);
247 son->kind = k_ir_loop;
248 son->children = NEW_ARR_F(loop_element, 0);
253 son->outer_loop = father;
254 add_loop_son(father, son);
255 son->depth = father->depth + 1;
256 } else { /* The root loop */
257 son->outer_loop = son;
262 son->loop_nr = get_irp_new_node_nr();