Simplify handling of unreachable code
[libfirm] / ir / ana / irloop.c
1 /*
2  * Copyright (C) 1995-2011 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                 size_t i;
80
81                 for (i = ARR_LEN(new_children); i > 0;) {
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 unsigned (get_loop_depth)(const ir_loop *loop)
99 {
100         return _get_loop_depth(loop);
101 }
102
103 /* Returns the number of inner loops */
104 size_t (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, size_t pos)
113 {
114         size_t child_nr = 0;
115         size_t loop_nr = 0;
116
117         assert(loop && loop->kind == k_ir_loop);
118         for (child_nr = 0; child_nr < ARR_LEN(loop->children); ++child_nr) {
119                 if (*(loop->children[child_nr].kind) != k_ir_loop)
120                         continue;
121                 if (loop_nr == pos)
122                         return loop->children[child_nr].son;
123                 loop_nr++;
124         }
125         return NULL;
126 }
127
128 /* Returns the number of nodes in the loop */
129 size_t get_loop_n_nodes(const ir_loop *loop)
130 {
131         assert(loop);
132         assert(loop->kind == k_ir_loop);
133         return loop->n_nodes;
134 }
135
136 /* Returns the pos'th ir_node-child                *
137  * TODO: This method isn't very efficient !        *
138  * Returns NULL if there isn't a pos'th ir_node   */
139 ir_node *get_loop_node(const ir_loop *loop, size_t pos)
140 {
141         size_t node_nr = 0;
142         size_t child_nr;
143
144         assert(loop && loop->kind == k_ir_loop);
145         assert(pos < get_loop_n_nodes(loop));
146
147         for (child_nr = 0; child_nr < ARR_LEN(loop->children); ++child_nr) {
148                 if (*(loop->children[child_nr].kind) != k_ir_node)
149                         continue;
150                 if (node_nr == pos)
151                         return loop -> children[child_nr].node;
152                 node_nr++;
153         }
154         panic("no child at pos found");
155 }
156
157 /* Returns the number of elements contained in loop.  */
158 size_t get_loop_n_elements(const ir_loop *loop)
159 {
160         assert(loop && loop->kind == k_ir_loop);
161         return(ARR_LEN(loop->children));
162 }
163
164 loop_element get_loop_element(const ir_loop *loop, size_t pos)
165 {
166         assert(loop && loop->kind == k_ir_loop && pos < ARR_LEN(loop->children));
167         return(loop -> children[pos]);
168 }
169
170 size_t get_loop_element_pos(const ir_loop *loop, void *le)
171 {
172         size_t n;
173         size_t i;
174         assert(loop && loop->kind == k_ir_loop);
175
176         n = get_loop_n_elements(loop);
177         for (i = 0; i < n; i++)
178                 if (get_loop_element(loop, i).node == le)
179                         return i;
180         return INVALID_LOOP_POS;
181 }
182
183
184 /**
185  * Sets the loop for a node.
186  */
187 void set_irn_loop(ir_node *n, ir_loop *loop)
188 {
189         n->loop = loop;
190 }
191
192 ir_loop *(get_irn_loop)(const ir_node *n)
193 {
194         return _get_irn_loop(n);
195 }
196
197 long get_loop_loop_nr(const ir_loop *loop)
198 {
199         assert(loop && loop->kind == k_ir_loop);
200 #ifdef DEBUG_libfirm
201         return loop->loop_nr;
202 #else
203         return (long)loop;
204 #endif
205 }
206
207 void set_loop_link(ir_loop *loop, void *link)
208 {
209         assert(loop && loop->kind == k_ir_loop);
210         loop->link = link;
211 }
212
213 void *get_loop_link(const ir_loop *loop)
214 {
215         assert(loop && loop->kind == k_ir_loop);
216         return loop->link;
217 }
218
219 int (is_ir_loop)(const void *thing)
220 {
221         return _is_ir_loop(thing);
222 }
223
224 /* The outermost loop is remarked in the surrounding graph. */
225 void (set_irg_loop)(ir_graph *irg, ir_loop *loop)
226 {
227         _set_irg_loop(irg, loop);
228 }
229
230 /* Returns the root loop info (if exists) for an irg. */
231 ir_loop *(get_irg_loop)(const ir_graph *irg)
232 {
233         return _get_irg_loop(irg);
234 }
235
236 /*
237  * Allocates a new loop as son of father on the given obstack.
238  * If father is equal NULL, a new root loop is created.
239  */
240 ir_loop *alloc_loop(ir_loop *father, struct obstack *obst)
241 {
242         ir_loop *son;
243
244         son = OALLOCZ(obst, ir_loop);
245         son->kind     = k_ir_loop;
246         son->children = NEW_ARR_F(loop_element, 0);
247         son->n_nodes  = 0;
248         son->n_sons   = 0;
249         son->link     = NULL;
250         if (father) {
251                 son->outer_loop = father;
252                 add_loop_son(father, son);
253                 son->depth = father->depth + 1;
254         } else {  /* The root loop */
255                 son->outer_loop = son;
256                 son->depth      = 0;
257         }
258
259 #ifdef DEBUG_libfirm
260         son->loop_nr = get_irp_new_node_nr();
261 #endif
262
263         return son;
264 }