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
26 #ifndef FIRM_ANA_IRLOOP_T_H
27 #define FIRM_ANA_IRLOOP_T_H
29 #include "firm_common.h"
30 #include "irgraph_t.h"
35 * The loops data structure.
37 * The loops data structure represents circles in the intermediate
38 * representation. It does not represent loops in the terms of a
40 * Each ir_graph can contain one outermost loop data structure.
41 * loop is the entry point to the nested loops.
42 * The loop data structure contains a field indicating the depth of
43 * the loop within the nesting. Further it contains a list of the
44 * loops with nesting depth -1. Finally it contains a list of all
48 firm_kind kind; /**< A type tag, set to k_ir_loop. */
49 unsigned depth; /**< Nesting depth */
50 struct ir_loop *outer_loop; /**< The outer loop */
51 loop_element *children; /**< Mixed flexible array: Contains sons and loop_nodes */
52 void *link; /**< link field. */
54 long loop_nr; /**< A unique node number for each loop node to make output
60 * Allocates a new loop as son of father on the given obstack.
61 * If father is equal NULL, a new root loop is created.
63 ir_loop *alloc_loop(ir_loop *father, struct obstack *obst);
65 /** Add a son loop to a father loop. */
66 void add_loop_son(ir_loop *loop, ir_loop *son);
68 /** Add a node to a loop. */
69 void add_loop_node(ir_loop *loop, ir_node *n);
71 /** Add an IR graph to a loop. */
72 void add_loop_irg(ir_loop *loop, ir_graph *irg);
74 /** Sets the loop a node belonging to. */
75 void set_irn_loop(ir_node *n, ir_loop *loop);
78 * Mature all loops by removing the flexible arrays of a loop tree
79 * and putting them on the given obstack.
81 void mature_loops(ir_loop *loop, struct obstack *obst);
83 /* -------- inline functions -------- */
85 static inline int _is_ir_loop(const void *thing)
87 return get_kind(thing) == k_ir_loop;
90 static inline void _set_irg_loop(ir_graph *irg, ir_loop *loop)
96 static inline ir_loop *_get_irg_loop(const ir_graph *irg)
102 static inline ir_loop *_get_loop_outer_loop(const ir_loop *loop)
104 assert(_is_ir_loop(loop));
105 return loop->outer_loop;
108 static inline unsigned _get_loop_depth(const ir_loop *loop)
110 assert(_is_ir_loop(loop));
114 /* Uses temporary information to get the loop */
115 static inline ir_loop *_get_irn_loop(const ir_node *n)
120 #define is_ir_loop(thing) _is_ir_loop(thing)
121 #define set_irg_loop(irg, loop) _set_irg_loop(irg, loop)
122 #define get_irg_loop(irg) _get_irg_loop(irg)
123 #define get_loop_outer_loop(loop) _get_loop_outer_loop(loop)
124 #define get_loop_depth(loop) _get_loop_depth(loop)
125 #define get_irn_loop(n) _get_irn_loop(n)