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 $
41 void add_loop_son(ir_loop *loop, ir_loop *son) {
43 assert(loop && loop->kind == k_ir_loop);
44 assert(get_kind(son) == k_ir_loop);
46 ARR_APP1(loop_element, loop->children, lson);
48 loop->flags |= loop_outer_loop;
51 void add_loop_node(ir_loop *loop, ir_node *n) {
54 assert(loop && loop->kind == k_ir_loop);
55 ARR_APP1(loop_element, loop->children, ln);
59 void add_loop_irg(ir_loop *loop, ir_graph *irg) {
62 assert(loop && loop->kind == k_ir_loop);
63 ARR_APP1(loop_element, loop->children, ln);
68 * Mature all loops by removing the flexible arrays of a loop.
70 void mature_loops(ir_loop *loop, struct obstack *obst) {
71 loop_element *new_children = DUP_ARR_D(loop_element, obst, loop->children);
72 DEL_ARR_F(loop->children);
73 loop->children = new_children;
75 if (loop->n_sons > 0) {
76 /* we have child loops, mature them */
79 for (i = ARR_LEN(new_children) - 1; i >= 0; --i) {
80 loop_element child = new_children[i];
82 if (*child.kind == k_ir_loop) {
83 mature_loops(child.son, obst);
89 /* Returns outer loop, itself if outermost. */
90 ir_loop *(get_loop_outer_loop)(const ir_loop *loop) {
91 return _get_loop_outer_loop(loop);
94 /* Returns nesting depth of this loop */
95 int (get_loop_depth)(const ir_loop *loop) {
96 return _get_loop_depth(loop);
99 /* Returns the number of inner loops */
100 int (get_loop_n_sons)(const ir_loop *loop) {
101 return _get_loop_n_sons(loop);
104 /* Returns the pos`th loop_node-child *
105 * TODO: This method isn`t very efficient ! *
106 * Returns NULL if there isn`t a pos`th loop_node */
107 ir_loop *get_loop_son(ir_loop *loop, int pos) {
108 int child_nr = 0, loop_nr = -1;
110 assert(loop && loop->kind == k_ir_loop);
111 while (child_nr < ARR_LEN(loop->children)) {
112 if (*(loop->children[child_nr].kind) == k_ir_loop)
115 return loop->children[child_nr].son;
121 /* Returns the number of nodes in the loop */
122 int get_loop_n_nodes(ir_loop *loop) {
123 assert(loop); assert(loop->kind == k_ir_loop);
124 return loop->n_nodes;
127 /* Returns the pos'th ir_node-child *
128 * TODO: This method isn't very efficient ! *
129 * Returns NULL if there isn't a pos'th ir_node */
130 ir_node *get_loop_node(ir_loop *loop, int pos) {
131 int child_nr, node_nr = -1;
133 assert(loop && loop->kind == k_ir_loop);
134 assert(pos < get_loop_n_nodes(loop));
136 for (child_nr = 0; child_nr < ARR_LEN(loop->children); child_nr++) {
137 if (*(loop->children[child_nr].kind) == k_ir_node)
140 return loop -> children[child_nr].node;
143 assert(0 && "no child at pos found");
147 /* Returns the number of elements contained in loop. */
148 int get_loop_n_elements(const ir_loop *loop) {
149 assert(loop && loop->kind == k_ir_loop);
150 return(ARR_LEN(loop->children));
154 Returns the pos`th loop element.
155 This may be a loop_node or a ir_node. The caller of this function has
156 to check the *(loop_element.kind) field for "k_ir_node" or "k_ir_loop"
157 and then select the appropriate "loop_element.node" or "loop_element.son".
159 loop_element get_loop_element(const ir_loop *loop, int pos) {
160 assert(loop && loop->kind == k_ir_loop && pos < ARR_LEN(loop->children));
161 return(loop -> children[pos]);
164 int get_loop_element_pos(const ir_loop *loop, void *le) {
166 assert(loop && loop->kind == k_ir_loop);
168 n = get_loop_n_elements(loop);
169 for (i = 0; i < n; i++)
170 if (get_loop_element(loop, i).node == le)
177 * Sets the loop for a node.
179 void set_irn_loop(ir_node *n, ir_loop *loop) {
183 /* Uses temporary information to get the loop */
184 ir_loop *(get_irn_loop)(const ir_node *n) {
185 return _get_irn_loop(n);
188 int get_loop_loop_nr(const ir_loop *loop) {
189 assert(loop && loop->kind == k_ir_loop);
191 return loop->loop_nr;
197 /** A field to connect additional information to a loop. Only valid
198 if libfirm_debug is set. */
199 void set_loop_link(ir_loop *loop, void *link) {
200 assert(loop && loop->kind == k_ir_loop);
203 void *get_loop_link(const ir_loop *loop) {
204 assert(loop && loop->kind == k_ir_loop);
208 int (is_ir_loop)(const void *thing) {
209 return _is_ir_loop(thing);
212 /* The outermost loop is remarked in the surrounding graph. */
213 void (set_irg_loop)(ir_graph *irg, ir_loop *loop) {
214 _set_irg_loop(irg, loop);
217 /* Returns the root loop info (if exists) for an irg. */
218 ir_loop *(get_irg_loop)(ir_graph *irg) {
219 return _get_irg_loop(irg);
223 * Allocates a new loop as son of father on the given obstack.
224 * If father is equal NULL, a new root loop is created.
226 ir_loop *alloc_loop(ir_loop *father, struct obstack *obst) {
229 son = obstack_alloc(obst, sizeof(*son));
230 memset(son, 0, sizeof(*son));
231 son->kind = k_ir_loop;
232 son->children = NEW_ARR_F(loop_element, 0);
237 son->outer_loop = father;
238 add_loop_son(father, son);
239 son->depth = father->depth + 1;
240 } else { /* The root loop */
241 son->outer_loop = son;
246 son->loop_nr = get_irp_new_node_nr();