C99 feature removed, fixed indentation.
[libfirm] / ir / ana / irloop.c
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: irloop_t.h 17143 2008-01-02 20:56:33Z beck $
26  */
27 # include "config.h"
28
29 #include <string.h>
30 #include <stdlib.h>
31
32 #include "irloop_t.h"
33 #include "irprog_t.h"
34 #include "error.h"
35
36 void add_loop_son(ir_loop *loop, ir_loop *son)
37 {
38         loop_element lson;
39         assert(loop && loop->kind == k_ir_loop);
40         assert(get_kind(son) == k_ir_loop);
41         lson.son = son;
42         ARR_APP1(loop_element, loop->children, lson);
43         ++loop->n_sons;
44         loop->flags |= loop_outer_loop;
45 }
46
47 void add_loop_node(ir_loop *loop, ir_node *n)
48 {
49         loop_element ln;
50         ln.node = n;
51         assert(loop && loop->kind == k_ir_loop);
52         ARR_APP1(loop_element, loop->children, ln);
53         loop->n_nodes++;
54 }
55
56 void add_loop_irg(ir_loop *loop, ir_graph *irg)
57 {
58         loop_element ln;
59         ln.irg = irg;
60         assert(loop && loop->kind == k_ir_loop);
61         ARR_APP1(loop_element, loop->children, ln);
62         loop->n_nodes++;
63 }
64
65 /**
66  * Mature all loops by removing the flexible arrays of a loop.
67  *
68  * @param loop  the loop to mature
69  * @param obst  an obstack, where the new arrays are allocated on
70  */
71 void mature_loops(ir_loop *loop, struct obstack *obst)
72 {
73         loop_element *new_children = DUP_ARR_D(loop_element, obst, loop->children);
74         DEL_ARR_F(loop->children);
75         loop->children = new_children;
76
77         if (loop->n_sons > 0) {
78                 /* we have child loops, mature them */
79                 int i;
80
81                 for (i = ARR_LEN(new_children) - 1; i >= 0; --i) {
82                         loop_element child = new_children[i];
83
84                         if (*child.kind == k_ir_loop) {
85                                 mature_loops(child.son, obst);
86                         }
87                 }
88         }
89 }
90
91 /* Returns outer loop, itself if outermost. */
92 ir_loop *(get_loop_outer_loop)(const ir_loop *loop)
93 {
94         return _get_loop_outer_loop(loop);
95 }
96
97 /* Returns nesting depth of this loop */
98 int (get_loop_depth)(const ir_loop *loop)
99 {
100         return _get_loop_depth(loop);
101 }
102
103 /* Returns the number of inner loops */
104 int (get_loop_n_sons)(const ir_loop *loop)
105 {
106         return _get_loop_n_sons(loop);
107 }
108
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)
113 {
114         int child_nr = 0, loop_nr = -1;
115
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)
119                         loop_nr++;
120                 if (loop_nr == pos)
121                         return loop->children[child_nr].son;
122                 child_nr++;
123         }
124         return NULL;
125 }
126
127 /* Returns the number of nodes in the loop */
128 int get_loop_n_nodes(const ir_loop *loop)
129 {
130         assert(loop); assert(loop->kind == k_ir_loop);
131         return loop->n_nodes;
132 }
133
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)
138 {
139         int child_nr, node_nr = -1;
140
141         assert(loop && loop->kind == k_ir_loop);
142         assert(pos < get_loop_n_nodes(loop));
143
144         for (child_nr = 0; child_nr < ARR_LEN(loop->children); child_nr++) {
145                 if (*(loop->children[child_nr].kind) == k_ir_node)
146                         node_nr++;
147                 if (node_nr == pos)
148                         return loop -> children[child_nr].node;
149         }
150
151         panic("no child at pos found");
152 }
153
154 /* Returns the number of elements contained in loop.  */
155 int get_loop_n_elements(const ir_loop *loop)
156 {
157         assert(loop && loop->kind == k_ir_loop);
158         return(ARR_LEN(loop->children));
159 }
160
161 /*
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".
166 */
167 loop_element get_loop_element(const ir_loop *loop, int pos)
168 {
169         assert(loop && loop->kind == k_ir_loop && pos < ARR_LEN(loop->children));
170         return(loop -> children[pos]);
171 }
172
173 int get_loop_element_pos(const ir_loop *loop, void *le)
174 {
175         int i, n;
176         assert(loop && loop->kind == k_ir_loop);
177
178         n = get_loop_n_elements(loop);
179         for (i = 0; i < n; i++)
180                 if (get_loop_element(loop, i).node == le)
181                         return i;
182         return -1;
183 }
184
185
186 /**
187  * Sets the loop for a node.
188  */
189 void set_irn_loop(ir_node *n, ir_loop *loop)
190 {
191         n->loop = loop;
192 }
193
194 ir_loop *(get_irn_loop)(const ir_node *n)
195 {
196         return _get_irn_loop(n);
197 }
198
199 int get_loop_loop_nr(const ir_loop *loop)
200 {
201         assert(loop && loop->kind == k_ir_loop);
202 #ifdef DEBUG_libfirm
203         return loop->loop_nr;
204 #else
205         return (int)loop;
206 #endif
207 }
208
209 void set_loop_link(ir_loop *loop, void *link)
210 {
211         assert(loop && loop->kind == k_ir_loop);
212         loop->link = link;
213 }
214
215 void *get_loop_link(const ir_loop *loop)
216 {
217         assert(loop && loop->kind == k_ir_loop);
218         return loop->link;
219 }
220
221 int (is_ir_loop)(const void *thing)
222 {
223         return _is_ir_loop(thing);
224 }
225
226 /* The outermost loop is remarked in the surrounding graph. */
227 void (set_irg_loop)(ir_graph *irg, ir_loop *loop)
228 {
229         _set_irg_loop(irg, loop);
230 }
231
232 /* Returns the root loop info (if exists) for an irg. */
233 ir_loop *(get_irg_loop)(const ir_graph *irg)
234 {
235         return _get_irg_loop(irg);
236 }
237
238 /*
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.
241  */
242 ir_loop *alloc_loop(ir_loop *father, struct obstack *obst)
243 {
244         ir_loop *son;
245
246         son = OALLOCZ(obst, ir_loop);
247         son->kind     = k_ir_loop;
248         son->children = NEW_ARR_F(loop_element, 0);
249         son->n_nodes  = 0;
250         son->n_sons   = 0;
251         son->link     = NULL;
252         if (father) {
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;
258                 son->depth      = 0;
259         }
260
261 #ifdef DEBUG_libfirm
262         son->loop_nr = get_irp_new_node_nr();
263 #endif
264
265         return son;
266 }