2 * Copyright (C) 1995-2007 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 Construct and access dominator tree.
23 * @author Goetz Lindenmaier
27 * This file contains routines to construct and access dominator information.
29 * The dominator information is stored in three fields of block nodes:
30 * - idom: a reference to the block that is the immediate dominator of
32 * - dom_depth: a number giving the depth of the block in the dominator
34 * - pre_num: Number in preorder traversal.
36 #ifndef FIRM_ANA_IRDOM_H
37 #define FIRM_ANA_IRDOM_H
39 #include "firm_types.h"
42 /** Accessing the dominator data structure.
44 * These routines only work properly if the ir_graph is in state
45 * dom_consistent or dom_inconsistent.
47 * If the block is not reachable from Start, returns a Bad node.
49 ir_node *get_Block_idom(const ir_node *bl);
50 void set_Block_idom(ir_node *bl, ir_node *n);
52 int get_Block_dom_depth(const ir_node *bl);
53 void set_Block_dom_depth(ir_node *bl, int depth);
55 int get_Block_dom_pre_num(const ir_node *bl);
56 void set_Block_dom_pre_num(ir_node *bl, int num);
58 /** Accessing the post dominator data structure.
60 * These routines only work properly if the ir_graph is in state
61 * dom_consistent or dom_inconsistent.
63 * If the block is not reachable from End, returns a Bad node.
65 ir_node *get_Block_ipostdom(const ir_node *bl);
66 void set_Block_ipostdom(ir_node *bl, ir_node *n);
68 int get_Block_postdom_depth(const ir_node *bl);
69 void set_Block_postdom_depth(ir_node *bl, int depth);
71 int get_Block_postdom_pre_num(const ir_node *bl);
72 void set_Block_postdom_pre_num(ir_node *bl, int num);
75 * Get the pre-order number of a block resulting from a
76 * Depth-First-Search walkover the dominator tree.
78 * @param bl The block.
79 * @return The pre-order number.
81 unsigned get_Block_dom_tree_pre_num(const ir_node *bl);
84 * Get the largest pre-order number found in the subtree of the
85 * dominator tree rooted at a given block.
86 * @param bl The block.
87 * @return The largest pre-order number of block's dominator subtree.
89 unsigned get_Block_dom_max_subtree_pre_num(const ir_node *bl);
92 * Get the first node in the list of nodes dominated by a given block.
94 * Each node keeps a list of nodes which it immediately dominates. The
95 * nodes are queued using the @c next pointer in the @c dom_info struct.
96 * Each node keeps a head of this list using the pointer @c first in the
99 * @param bl The block for which to get the first node dominated by @c bl.
100 * @return The first node dominated by @p bl.
102 ir_node *get_Block_dominated_first(const ir_node *bl);
105 * Get the next node in a list of nodes which are dominated by some
107 * @see get_Block_dominated_first().
108 * @param dom The previous node.
109 * @return The next node in this list or NULL if it was the last.
111 ir_node *get_Block_dominated_next(const ir_node *dom);
114 * Iterate over all nodes which are immediately dominated by a given
116 * @param bl The block whose dominated blocks shall be iterated on.
117 * @param curr An iterator variable of type ir_node*
119 #define dominates_for_each(bl,curr) \
120 for(curr = get_Block_dominated_first(bl); curr; \
121 curr = get_Block_dominated_next(curr))
124 * Iterate over all nodes which are immediately post dominated by a given
126 * @param bl The block whose post dominated blocks shall be iterated on.
127 * @param curr An iterator variable of type ir_node*
129 #define postdominates_for_each(bl,curr) \
130 for(curr = get_Block_postdominated_first(bl); curr; \
131 curr = get_Block_postdominated_next(curr))
134 * Check, if a block dominates another block.
135 * @param a The first block.
136 * @param b The second block.
137 * @return 1, if @p a dominates @p b, else 0.
139 int block_dominates(const ir_node *a, const ir_node *b);
142 * Returns the smallest common dominator block of two nodes.
144 * @param b Another node.
145 * @return The first block dominating @p a and @p b
147 ir_node *node_smallest_common_dominator(ir_node *a, ir_node *b);
150 * Returns the smallest common dominator block of all users of a node
151 * BEWARE: @p irn must not be a block
152 * If on or more users are Phi nodes, one can request special handling
153 * with @p handle_phi = 1. In this case the cfg predecessor block
154 * corresponding to the position of the irn in the argument list of the
155 * Phi is determined and treated as user.
158 * @param handle_phi 1 if Phis should be handled different
159 * @return The first block dominating all users of @irn
161 ir_node *node_users_smallest_common_dominator(ir_node *irn, int handle_phi);
164 * Check, if a block post dominates another block.
165 * @param a The first block.
166 * @param b The second block.
167 * @return 1, if @p a post dominates @p b, else 0.
169 int block_postdominates(const ir_node *a, const ir_node *b);
172 * Visit all nodes in the dominator subtree of a given node.
173 * Call a pre-visitor before descending to the children and call a
174 * post-visitor after returning from them.
175 * @param n The node to start walking from.
176 * @param pre The pre-visitor callback.
177 * @param post The post-visitor callback.
178 * @param env Some custom data passed to the visitors.
180 void dom_tree_walk(ir_node *n, irg_walk_func *pre,
181 irg_walk_func *post, void *env);
184 * Visit all nodes in the post dominator subtree of a given node.
185 * Call a pre-visitor before descending to the children and call a
186 * post-visitor after returning from them.
187 * @param n The node to start walking from.
188 * @param pre The pre-visitor callback.
189 * @param post The post-visitor callback.
190 * @param env Some custom data passed to the visitors.
192 void postdom_tree_walk(ir_node *n, irg_walk_func *pre,
193 irg_walk_func *post, void *env);
196 * Walk over the dominator tree of an irg starting at the root.
197 * @param irg The graph.
198 * @param pre A pre-visitor to call.
199 * @param post A post-visitor to call.
200 * @param env Some private data to give to the visitors.
202 void dom_tree_walk_irg(ir_graph *irg, irg_walk_func *pre,
203 irg_walk_func *post, void *env);
206 * Walk over the post dominator tree of an irg starting at the root.
207 * @param irg The graph.
208 * @param pre A pre-visitor to call.
209 * @param post A post-visitor to call.
210 * @param env Some private data to give to the visitors.
212 void postdom_tree_walk_irg(ir_graph *irg, irg_walk_func *pre,
213 irg_walk_func *post, void *env);
215 /* ------------ Building and Removing the dominator data structure ----------- */
217 /** Computes the dominator trees.
219 * Sets a flag in irg to "dom_consistent".
220 * If the control flow of the graph is changed this flag must be set to
221 * "dom_inconsistent".
222 * Does not compute dominator information for control dead code. Blocks
223 * not reachable from Start contain the following information:
229 * Also constructs outs information. As this information is correct after
230 * the run does not free the outs information.
232 void compute_doms(ir_graph *irg);
234 /** Computes the dominator trees on demand */
235 void assure_doms(ir_graph *irg);
237 /** Computes the post dominator trees.
239 * Sets a flag in irg to "dom_consistent".
240 * If the control flow of the graph is changed this flag must be set to
241 * "dom_inconsistent".
242 * Does not compute post dominator information for endless lops. Blocks
243 * not reachable from End contain the following information:
249 * Also constructs outs information. As this information is correct after
250 * the run does not free the outs information.
252 void compute_postdoms(ir_graph *irg);
254 /** Computes the dominator trees on demand */
255 void assure_postdoms(ir_graph *irg);
257 /** Frees the dominator data structures. Sets the flag in irg to "dom_none". */
258 void free_dom(ir_graph *irg);
260 /** Frees the post dominator data structures. Sets the flag in irg to "dom_none". */
261 void free_postdom(ir_graph *irg);