nsz Git - libfirm/blob - include/libfirm/irdom.h

   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     Construct and access dominator tree.
  23  * @author    Goetz Lindenmaier
  24  * @date      2.2002
  25  * @version   $Id$
  26  * @brief
  27  *   This file contains routines to construct and access dominator information.
  28  *
  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
  31  *       this block.
  32  *     - dom_depth: a number giving the depth of the block in the dominator
  33  *       tree.
  34  *     - pre_num:  Number in preorder traversal.
  35  */
  36 #ifndef FIRM_ANA_IRDOM_H
  37 #define FIRM_ANA_IRDOM_H
  38
  39 #include "firm_types.h"
  40
  41
  42 /** Accessing the dominator data structure.
  43  *
  44  * These routines only work properly if the ir_graph is in state
  45  * dom_consistent or dom_inconsistent.
  46  *
  47  * If the block is not reachable from Start, returns a Bad node.
  48  */
  49 ir_node *get_Block_idom(const ir_node *bl);
  50 void set_Block_idom(ir_node *bl, ir_node *n);
  51
  52 int get_Block_dom_depth(const ir_node *bl);
  53 void set_Block_dom_depth(ir_node *bl, int depth);
  54
  55 int get_Block_dom_pre_num(const ir_node *bl);
  56 void set_Block_dom_pre_num(ir_node *bl, int num);
  57
  58 /** Accessing the post dominator data structure.
  59  *
  60  * These routines only work properly if the ir_graph is in state
  61  * dom_consistent or dom_inconsistent.
  62  *
  63  * If the block is not reachable from End, returns a Bad node.
  64  */
  65 ir_node *get_Block_ipostdom(const ir_node *bl);
  66 void set_Block_ipostdom(ir_node *bl, ir_node *n);
  67
  68 int get_Block_postdom_depth(const ir_node *bl);
  69 void set_Block_postdom_depth(ir_node *bl, int depth);
  70
  71 int get_Block_postdom_pre_num(const ir_node *bl);
  72 void set_Block_postdom_pre_num(ir_node *bl, int num);
  73
  74 /**
  75  * Get the pre-order number of a block resulting from a
  76  * Depth-First-Search walkover the dominator tree.
  77  *
  78  * @param bl The block.
  79  * @return The pre-order number.
  80  */
  81 unsigned get_Block_dom_tree_pre_num(const ir_node *bl);
  82 unsigned get_Block_pdom_tree_pre_num(const ir_node *bl);
  83
  84 /**
  85  * Get the largest pre-order number found in the subtree of the
  86  * dominator tree rooted at a given block.
  87  * @param bl The block.
  88  * @return The largest pre-order number of block's dominator subtree.
  89  */
  90 unsigned get_Block_dom_max_subtree_pre_num(const ir_node *bl);
  91 unsigned get_Block_pdom_max_subtree_pre_num(const ir_node *bl);
  92
  93 /**
  94  * Get the first node in the list of nodes dominated by a given block.
  95  *
  96  * Each node keeps a list of nodes which it immediately dominates. The
  97  * nodes are queued using the @c next pointer in the @c dom_info struct.
  98  * Each node keeps a head of this list using the pointer @c first in the
  99  * same structure.
 100  *
 101  * @param bl The block for which to get the first node dominated by @c bl.
 102  * @return The first node dominated by @p bl.
 103  */
 104 ir_node *get_Block_dominated_first(const ir_node *bl);
 105 ir_node *get_Block_postdominated_first(const ir_node *bl);
 106
 107 /**
 108  * Get the next node in a list of nodes which are dominated by some
 109  * other node.
 110  * @see get_Block_dominated_first().
 111  * @param dom The previous node.
 112  * @return The next node in this list or NULL if it was the last.
 113  */
 114 ir_node *get_Block_dominated_next(const ir_node *dom);
 115 ir_node *get_Block_postdominated_next(const ir_node *dom);
 116
 117 /**
 118  * Iterate over all nodes which are immediately dominated by a given
 119  * node.
 120  * @param bl   The block whose dominated blocks shall be iterated on.
 121  * @param curr An iterator variable of type ir_node*
 122  */
 123 #define dominates_for_each(bl,curr) \
 124         for(curr = get_Block_dominated_first(bl); curr; \
 125                         curr = get_Block_dominated_next(curr))
 126
 127 /**
 128  * Iterate over all nodes which are immediately post dominated by a given
 129  * node.
 130  * @param bl   The block whose post dominated blocks shall be iterated on.
 131  * @param curr An iterator variable of type ir_node*
 132  */
 133 #define postdominates_for_each(bl,curr) \
 134         for(curr = get_Block_postdominated_first(bl); curr; \
 135                         curr = get_Block_postdominated_next(curr))
 136
 137 /**
 138  * Check, if a block dominates another block.
 139  *
 140  * @param a   The potential dominator block.
 141  * @param b   The potentially dominated block.
 142  *
 143  * @return 1, if @p a dominates @p b, else 0.
 144  */
 145 int block_dominates(const ir_node *a, const ir_node *b);
 146
 147 /**
 148  * Check, if a block strictly dominates another block, i.e. a != b.
 149  *
 150  * @param a The potential dominator block.
 151  * @param b The potentially dominated block.
 152  *
 153  * @return 1, if @p a strictly dominates @p b, else 0.
 154  */
 155 int block_strictly_dominates(const ir_node *a, const ir_node *b);
 156
 157 /**
 158  * Returns the smallest common dominator block of two nodes.
 159  * @param a A node.
 160  * @param b Another node.
 161  * @return The first block dominating @p a and @p b
 162  */
 163 ir_node *node_smallest_common_dominator(ir_node *a, ir_node *b);
 164
 165 /**
 166  * Returns the smallest common dominator block of all users of a node
 167  * BEWARE: @p irn must not be a block
 168  * If on or more users are Phi nodes, one can request special handling
 169  * with @p handle_phi = 1.  In this case the cfg predecessor block
 170  * corresponding to the position of the irn in the argument list of the
 171  * Phi is determined and treated as user.
 172  *
 173  * @param irn        A node.
 174  * @param handle_phi 1 if Phis should be handled different
 175  * @return The first block dominating all users of @p irn
 176  */
 177 ir_node *node_users_smallest_common_dominator(ir_node *irn, int handle_phi);
 178
 179 /**
 180  * Check, if a block post dominates another block.
 181  *
 182  * @param a The potential post dominator block.
 183  * @param b The potentially post dominated block.
 184  *
 185  * @return 1, if @p a post dominates @p b, else 0.
 186  */
 187 int block_postdominates(const ir_node *a, const ir_node *b);
 188
 189 /**
 190  * Check, if a block strictly post dominates another block, i.e. a != b.
 191  *
 192  * @param a The potential post dominator block.
 193  * @param b The potentially post dominated block.
 194  *
 195  * @return 1, if @p a strictly post dominates @p b, else 0.
 196  */
 197 int block_strictly_postdominates(const ir_node *a, const ir_node *b);
 198
 199 /**
 200  * Visit all nodes in the dominator subtree of a given node.
 201  * Call a pre-visitor before descending to the children and call a
 202  * post-visitor after returning from them.
 203  * @param n The node to start walking from.
 204  * @param pre The pre-visitor callback.
 205  * @param post The post-visitor callback.
 206  * @param env Some custom data passed to the visitors.
 207  */
 208 void dom_tree_walk(ir_node *n, irg_walk_func *pre,
 209                 irg_walk_func *post, void *env);
 210
 211 /**
 212  * Visit all nodes in the post dominator subtree of a given node.
 213  * Call a pre-visitor before descending to the children and call a
 214  * post-visitor after returning from them.
 215  * @param n The node to start walking from.
 216  * @param pre The pre-visitor callback.
 217  * @param post The post-visitor callback.
 218  * @param env Some custom data passed to the visitors.
 219  */
 220 void postdom_tree_walk(ir_node *n, irg_walk_func *pre,
 221                 irg_walk_func *post, void *env);
 222
 223 /**
 224  * Walk over the dominator tree of an irg starting at the root.
 225  * @param irg The graph.
 226  * @param pre A pre-visitor to call.
 227  * @param post A post-visitor to call.
 228  * @param env Some private data to give to the visitors.
 229  */
 230 void dom_tree_walk_irg(ir_graph *irg, irg_walk_func *pre,
 231                 irg_walk_func *post, void *env);
 232
 233 /**
 234  * Walk over the post dominator tree of an irg starting at the root.
 235  * @param irg The graph.
 236  * @param pre A pre-visitor to call.
 237  * @param post A post-visitor to call.
 238  * @param env Some private data to give to the visitors.
 239  */
 240 void postdom_tree_walk_irg(ir_graph *irg, irg_walk_func *pre,
 241                 irg_walk_func *post, void *env);
 242
 243 /* ------------ Building and Removing the dominator data structure ----------- */
 244
 245 /** Computes the dominator trees.
 246  *
 247  * Sets a flag in irg to "dom_consistent".
 248  * If the control flow of the graph is changed this flag must be set to
 249  * "dom_inconsistent".
 250  * Does not compute dominator information for control dead code.  Blocks
 251  * not reachable from Start contain the following information:
 252  * @code
 253  *   idom = NULL;
 254  *   dom_depth = -1;
 255  *   pre_num = -1;
 256  * @endcode
 257  * Also constructs outs information.  As this information is correct after
 258  * the run does not free the outs information.
 259  */
 260 void compute_doms(ir_graph *irg);
 261
 262 /** Computes the dominator trees on demand, @see compute_doms(). */
 263 void assure_doms(ir_graph *irg);
 264
 265 /** Computes the post dominator trees.
 266  *
 267  * Sets a flag in irg to "dom_consistent".
 268  * If the control flow of the graph is changed this flag must be set to
 269  * "dom_inconsistent".
 270  * Does not compute post dominator information for endless lops.  Blocks
 271  * not reachable from End contain the following information:
 272  * @code
 273  *   idom = NULL;
 274  *   dom_depth = -1;
 275  *   pre_num = -1;
 276  * @endcode
 277  * Also constructs outs information.  As this information is correct after
 278  * the run does not free the outs information.
 279  */
 280 void compute_postdoms(ir_graph *irg);
 281
 282 /** Computes the dominator trees on demand */
 283 void assure_postdoms(ir_graph *irg);
 284
 285 /** Frees the dominator data structures.  Sets the flag in irg to "dom_none". */
 286 void free_dom(ir_graph *irg);
 287
 288 /** Frees the post dominator data structures.  Sets the flag in irg to "dom_none". */
 289 void free_postdom(ir_graph *irg);
 290
 291 #endif