cleanup: Remove duplicate MIN/MAX macros.
[libfirm] / ir / ana / irdom.c
index c44f751..ab46923 100644 (file)
@@ -1,20 +1,6 @@
 /*
- * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
- *
  * This file is part of libFirm.
- *
- * This file may be distributed and/or modified under the terms of the
- * GNU General Public License version 2 as published by the Free Software
- * Foundation and appearing in the file LICENSE.GPL included in the
- * packaging of this file.
- *
- * Licensees holding valid libFirm Professional Edition licenses may use
- * this file in accordance with the libFirm Commercial License.
- * Agreement provided with the Software.
- *
- * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
- * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
- * PURPOSE.
+ * Copyright (C) 2012 University of Karlsruhe.
  */
 
 /**
@@ -22,7 +8,6 @@
  * @brief     Construct and access dominator / post dominator tree.
  * @author    Goetz Lindenmaier, Michael Beck, Rubino Geiss
  * @date      2.2002
- * @version   $Id$
  */
 #include "config.h"
 
 #define get_dom_info(bl)  (&(bl)->attr.block.dom)
 #define get_pdom_info(bl) (&(bl)->attr.block.pdom)
 
-/*--------------------------------------------------------------------*/
-/** Accessing the dominator and post dominator data structures       **/
-/*--------------------------------------------------------------------*/
-
 ir_node *get_Block_idom(const ir_node *bl)
 {
-       assert(is_Block(bl));
        if (get_Block_dom_depth(bl) == -1) {
                /* This block is not reachable from Start */
-               return new_Bad();
+               ir_graph *irg = get_irn_irg(bl);
+               return new_r_Bad(irg, mode_BB);
        }
        return get_dom_info(bl)->idom;
 }
@@ -80,10 +61,10 @@ void set_Block_idom(ir_node *bl, ir_node *n)
 
 ir_node *get_Block_ipostdom(const ir_node *bl)
 {
-       assert(is_Block(bl));
        if (get_Block_postdom_depth(bl) == -1) {
                /* This block is not reachable from Start */
-               return new_Bad();
+               ir_graph *irg = get_irn_irg(bl);
+               return new_r_Bad(irg, mode_BB);
        }
        return get_pdom_info(bl)->idom;
 }
@@ -182,7 +163,6 @@ unsigned get_Block_pdom_max_subtree_pre_num(const ir_node *bl)
        return get_pdom_info(bl)->max_subtree_pre_num;
 }
 
-/* Check, if a block dominates another block. */
 int block_dominates(const ir_node *a, const ir_node *b)
 {
        const ir_dom_info *ai, *bi;
@@ -197,13 +177,11 @@ int block_dominates(const ir_node *a, const ir_node *b)
        return 0;
 }
 
-/* Check, if a block strictly dominates another block. */
 int block_strictly_dominates(const ir_node *a, const ir_node *b)
 {
        return (a != b) && block_dominates(a, b);
 }
 
-/* Returns the smallest common dominator block of two nodes. */
 ir_node *node_smallest_common_dominator(ir_node *a, ir_node *b)
 {
        ir_node *bl_a   = is_Block(a) ? a : get_nodes_block(a);
@@ -231,64 +209,6 @@ ir_node *node_smallest_common_dominator(ir_node *a, ir_node *b)
        return dom_bl;
 }
 
-/* Returns the smallest common dominator block of all users of a node. */
-ir_node *node_users_smallest_common_dominator(ir_node *irn, int handle_phi)
-{
-       int n, j, i = 0, success;
-       ir_node **user_blocks, *dom_bl;
-       const ir_edge_t *edge;
-
-       assert(! is_Block(irn) && "WRONG USAGE of node_users_smallest_common_dominator");
-       assert(edges_activated(get_irn_irg(irn)) && "need edges activated");
-
-       n = get_irn_n_edges(irn);
-
-       /* get array to hold all block of the node users */
-       NEW_ARR_A(ir_node *, user_blocks, n);
-       foreach_out_edge(irn, edge) {
-               ir_node *src = get_edge_src_irn(edge);
-
-               if (is_Phi(src) && handle_phi) {
-                       /* get the corresponding cfg predecessor block if phi handling requested */
-                       j  = get_edge_src_pos(edge);
-                       assert(j >= 0 && "kaputt");
-                       user_blocks[i++] = get_Block_cfgpred_block(get_nodes_block(src), j);
-               }
-               else
-                       user_blocks[i++] = is_Block(src) ? src : get_nodes_block(src);
-       }
-
-       assert(i == n && "get_irn_n_edges probably broken");
-
-       /* in case of only one user: return the block of the user */
-       if (n == 1)
-               return user_blocks[0];
-
-       i = 0;
-       /* search the smallest block dominating all user blocks */
-       do {
-               dom_bl  = node_smallest_common_dominator(user_blocks[i], user_blocks[i + 1]);
-               success = 1;
-
-               /* check if this block dominates all remaining blocks as well */
-               for (j = i + 2; j < n; j++) {
-                       if (! block_dominates(dom_bl, user_blocks[j]))
-                               success = 0;
-               }
-
-               if (success)
-                       break;
-
-               /* inherit the dominator block of the first (i + 1) users */
-               user_blocks[++i] = dom_bl;
-       } while (i < n - 1);
-
-       assert(success && "no block found dominating all users");
-
-       return dom_bl;
-}
-
-
 /* Get the first node in the list of nodes dominated by a given block. */
 ir_node *get_Block_dominated_first(const ir_node *bl)
 {
@@ -296,15 +216,12 @@ ir_node *get_Block_dominated_first(const ir_node *bl)
        return get_dom_info(bl)->first;
 }
 
-/* Get the next node in a list of nodes which are dominated by some
- * other node. */
 ir_node *get_Block_dominated_next(const ir_node *bl)
 {
        assert(is_Block(bl));
        return get_dom_info(bl)->next;
 }
 
-/* Check, if a block post dominates another block. */
 int block_postdominates(const ir_node *a, const ir_node *b)
 {
        const ir_dom_info *ai, *bi;
@@ -319,29 +236,23 @@ int block_postdominates(const ir_node *a, const ir_node *b)
        return 0;
 }
 
-/* Check, if a block strictly dominates another block. */
 int block_strictly_postdominates(const ir_node *a, const ir_node *b)
 {
        return (a != b) && block_postdominates(a, b);
 }
 
-
-/* Get the first node in the list of nodes post dominated by a given block. */
 ir_node *get_Block_postdominated_first(const ir_node *bl)
 {
        assert(is_Block(bl));
        return get_pdom_info(bl)->first;
 }
 
-/* Get the next node in a list of nodes which are post dominated by some
- * other node. */
 ir_node *get_Block_postdominated_next(const ir_node *bl)
 {
        assert(is_Block(bl));
        return get_pdom_info(bl)->next;
 }
 
-/* Visit all nodes in the dominator subtree of a given node. */
 void dom_tree_walk(ir_node *bl, irg_walk_func *pre,
                irg_walk_func *post, void *env)
 {
@@ -358,7 +269,6 @@ void dom_tree_walk(ir_node *bl, irg_walk_func *pre,
                post(bl, env);
 }
 
-/* Visit all nodes in the post dominator subtree of a given node. */
 void postdom_tree_walk(ir_node *bl, irg_walk_func *pre,
                irg_walk_func *post, void *env)
 {
@@ -375,14 +285,13 @@ void postdom_tree_walk(ir_node *bl, irg_walk_func *pre,
                post(bl, env);
 }
 
-/* Walk over the dominator tree of an irg starting at the root. */
 void dom_tree_walk_irg(ir_graph *irg, irg_walk_func *pre,
                irg_walk_func *post, void *env)
 {
        /* The root of the dominator tree should be the Start block. */
        ir_node *root = get_irg_start_block(irg);
 
-       assert(irg->dom_state == dom_consistent
+       assert(irg_has_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE)
                        && "The dominators of the irg must be consistent");
        assert(root && "The start block of the graph is NULL?");
        assert(get_dom_info(root)->idom == NULL
@@ -390,14 +299,13 @@ void dom_tree_walk_irg(ir_graph *irg, irg_walk_func *pre,
        dom_tree_walk(root, pre, post, env);
 }
 
-/* Walk over the post dominator tree of an irg starting at the root. */
 void postdom_tree_walk_irg(ir_graph *irg, irg_walk_func *pre,
                irg_walk_func *post, void *env)
 {
-       /* The root of the dominator tree should be the End block. */
+       /* The root of the post dominator tree should be the End block. */
        ir_node *root = get_irg_end_block(irg);
 
-       assert(irg->pdom_state == dom_consistent
+       assert(irg_has_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_POSTDOMINANCE)
                        && "The dominators of the irg must be consistent");
        assert(root && "The end block of the graph is NULL?");
        assert(get_pdom_info(root)->idom == NULL
@@ -408,7 +316,7 @@ void postdom_tree_walk_irg(ir_graph *irg, irg_walk_func *pre,
 
 static void assign_tree_dom_pre_order(ir_node *bl, void *data)
 {
-       unsigned *num = data;
+       unsigned *num = (unsigned*) data;
        ir_dom_info *bi = get_dom_info(bl);
 
        bi->tree_pre_num = (*num)++;
@@ -434,7 +342,7 @@ static void assign_tree_dom_pre_order_max(ir_node *bl, void *data)
 
 static void assign_tree_postdom_pre_order(ir_node *bl, void *data)
 {
-       unsigned *num = data;
+       unsigned *num = (unsigned*) data;
        ir_dom_info *bi = get_pdom_info(bl);
 
        bi->tree_pre_num = (*num)++;
@@ -458,10 +366,6 @@ static void assign_tree_postdom_pre_order_max(ir_node *bl, void *data)
        assert(bi->max_subtree_pre_num >= bi->tree_pre_num);
 }
 
-/*--------------------------------------------------------------------*/
-/*  Building and Removing the dominator data structure                */
-/*--------------------------------------------------------------------*/
-
 /**
  * count the number of blocks and clears the post dominance info
  */
@@ -469,9 +373,6 @@ static void count_and_init_blocks_pdom(ir_node *bl, void *env)
 {
        int *n_blocks = (int *) env;
 
-       if (is_Block_dead(bl))
-               return;
-
        (*n_blocks) ++;
 
        memset(get_pdom_info(bl), 0, sizeof(ir_dom_info));
@@ -515,10 +416,6 @@ static void init_tmp_dom_info(ir_node *bl, tmp_dom_info *parent,
        tmp_dom_info *tdi;
        int i;
 
-       if (is_Block_dead(bl))
-               return;
-
-       assert(is_Block(bl));
        if (Block_block_visited(bl))
          return;
        mark_Block_block_visited(bl);
@@ -557,10 +454,6 @@ static void init_tmp_pdom_info(ir_node *bl, tmp_dom_info *parent,
        tmp_dom_info *tdi;
        int i;
 
-       if (is_Block_dead(bl))
-               return;
-
-       assert(is_Block(bl));
        if (get_irg_block_visited(current_ir_graph) == get_Block_block_visited(bl))
          return;
        mark_Block_block_visited(bl);
@@ -582,7 +475,6 @@ static void init_tmp_pdom_info(ir_node *bl, tmp_dom_info *parent,
                ir_node *pred = get_Block_cfgpred_block(bl, i);
                if (is_Bad(pred))
                        continue;
-               assert(is_Block(pred));
                init_tmp_pdom_info(pred, tdi, tdi_list, used, n_blocks);
        }
 
@@ -638,8 +530,6 @@ inline static void dom_link(tmp_dom_info *v, tmp_dom_info *w)
 static void count_and_init_blocks_dom(ir_node *bl, void *env)
 {
        int *n_blocks = (int *) env;
-       if (is_Block_dead(bl))
-               return;
 
        (*n_blocks) ++;
 
@@ -649,9 +539,6 @@ static void count_and_init_blocks_dom(ir_node *bl, void *env)
        set_Block_dom_depth(bl, -1);
 }
 
-/* Computes the dominator trees.  Sets a flag in irg to "dom_consistent".
-   If the control flow of the graph is changed this flag must be set to
-   "dom_inconsistent".  */
 void compute_doms(ir_graph *irg)
 {
        ir_graph *rem = current_ir_graph;
@@ -661,8 +548,7 @@ void compute_doms(ir_graph *irg)
        current_ir_graph = irg;
 
        /* Update graph state */
-       assert(get_irg_phase_state(irg) != phase_building);
-       irg->dom_state = dom_consistent;
+       assert(!irg_is_constrained(irg, IR_GRAPH_CONSTRAINT_CONSTRUCTION));
 
        /* Count the number of blocks in the graph. */
        n_blocks = 0;
@@ -687,25 +573,28 @@ void compute_doms(ir_graph *irg)
 
 
        for (i = n_blocks-1; i > 0; i--) {  /* Don't iterate the root, it's done. */
-               int irn_arity;
-               tmp_dom_info *w = &tdi_list[i];
+               tmp_dom_info *w     = &tdi_list[i];
+               ir_node      *block = w->block;
                tmp_dom_info *v;
+               int           irn_arity;
 
                /* Step 2 */
-               irn_arity = get_irn_arity(w->block);
+               irn_arity = get_irn_arity(block);
                for (j = 0; j < irn_arity;  j++) {
-                       ir_node *pred = get_Block_cfgpred_block(w->block, j);
+                       ir_node *pred       = get_Block_cfgpred(block, j);
+                       ir_node *pred_block = get_nodes_block(pred);
                        tmp_dom_info *u;
 
-                       if (is_Bad(pred) || (get_Block_dom_pre_num (pred) == -1))
-                               continue;       /* control-dead */
+                       if (is_Bad(pred) || (get_Block_dom_pre_num (pred_block) == -1))
+                               continue;    /* unreachable */
 
-                       u = dom_eval (&tdi_list[get_Block_dom_pre_num(pred)]);
-                       if (u->semi < w->semi) w->semi = u->semi;
+                       u = dom_eval (&tdi_list[get_Block_dom_pre_num(pred_block)]);
+                       if (u->semi < w->semi)
+                               w->semi = u->semi;
                }
 
                /* handle keep-alives if we are at the end block */
-               if (w->block == get_irg_end_block(irg)) {
+               if (block == get_irg_end_block(irg)) {
                        ir_node *end = get_irg_end(irg);
 
                        irn_arity = get_irn_arity(end);
@@ -713,11 +602,12 @@ void compute_doms(ir_graph *irg)
                                ir_node *pred = get_irn_n(end, j);
                                tmp_dom_info *u;
 
-                               if (is_no_Block(pred) || get_Block_dom_pre_num(pred) == -1)
-                                       continue;       /* control-dead */
+                               if (!is_Block(pred) || get_Block_dom_pre_num(pred) == -1)
+                                       continue;   /* unreachable */
 
                                u = dom_eval (&tdi_list[get_Block_dom_pre_num(pred)]);
-                               if (u->semi < w->semi) w->semi = u->semi;
+                               if (u->semi < w->semi)
+                                       w->semi = u->semi;
                        }
                }
 
@@ -754,7 +644,8 @@ void compute_doms(ir_graph *irg)
                if (! w->dom)
                        continue; /* control dead */
 
-               if (w->dom != w->semi) w->dom = w->dom->dom;
+               if (w->dom != w->semi)
+                       w->dom = w->dom->dom;
                set_Block_idom(w->block, w->dom->block);
 
                /* blocks dominated by dead one's are still dead */
@@ -770,31 +661,30 @@ void compute_doms(ir_graph *irg)
        /* Do a walk over the tree and assign the tree pre orders. */
        {
                unsigned tree_pre_order = 0;
-               dom_tree_walk_irg(irg, assign_tree_dom_pre_order,
-                       assign_tree_dom_pre_order_max, &tree_pre_order);
+               dom_tree_walk(get_irg_start_block(irg), assign_tree_dom_pre_order,
+                                 assign_tree_dom_pre_order_max, &tree_pre_order);
        }
        current_ir_graph = rem;
+       add_irg_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE);
 }
 
 void assure_doms(ir_graph *irg)
 {
-       if (get_irg_dom_state(irg) != dom_consistent)
+       if (! irg_has_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE))
                compute_doms(irg);
 }
 
 void free_dom(ir_graph *irg)
 {
        /* Update graph state */
-       assert(get_irg_phase_state(irg) != phase_building);
-       irg->dom_state = dom_none;
+       clear_irg_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE);
 
-       /* With the implementation right now there is nothing to free,
-          but better call it anyways... */
+       /* With the implementation right now there is nothing to free */
+
+       /* free dominance frontiers */
+       ir_free_dominance_frontiers(irg);
 }
 
-/* Computes the post dominator trees.  Sets a flag in irg to "dom_consistent".
-   If the control flow of the graph is changed this flag must be set to
-   "dom_inconsistent".  */
 void compute_postdoms(ir_graph *irg)
 {
        ir_graph *rem = current_ir_graph;
@@ -804,8 +694,7 @@ void compute_postdoms(ir_graph *irg)
        current_ir_graph = irg;
 
        /* Update graph state */
-       assert(get_irg_phase_state(irg) != phase_building);
-       irg->pdom_state = dom_consistent;
+       assert(!irg_is_constrained(irg, IR_GRAPH_CONSTRAINT_CONSTRUCTION));
 
        /* Count the number of blocks in the graph. */
        n_blocks = 0;
@@ -840,7 +729,7 @@ void compute_postdoms(ir_graph *irg)
                        tmp_dom_info *u;
 
                        if (get_Block_postdom_pre_num (succ) == -1)
-                               continue;       /* endless-loop */
+                               continue;    /* endless-loop */
 
                        u = dom_eval (&tdi_list[get_Block_postdom_pre_num(succ)]);
                        if (u->semi < w->semi) w->semi = u->semi;
@@ -885,24 +774,21 @@ void compute_postdoms(ir_graph *irg)
        /* Do a walk over the tree and assign the tree pre orders. */
        {
                unsigned tree_pre_order = 0;
-               postdom_tree_walk_irg(irg, assign_tree_postdom_pre_order,
+               postdom_tree_walk(get_irg_end_block(irg), assign_tree_postdom_pre_order,
                        assign_tree_postdom_pre_order_max, &tree_pre_order);
        }
        current_ir_graph = rem;
+       add_irg_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_POSTDOMINANCE);
 }
 
 void assure_postdoms(ir_graph *irg)
 {
-       if (get_irg_postdom_state(irg) != dom_consistent)
+       if (! irg_has_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_POSTDOMINANCE))
                compute_postdoms(irg);
 }
 
 void free_postdom(ir_graph *irg)
 {
        /* Update graph state */
-       assert(get_irg_phase_state(irg) != phase_building);
-       irg->pdom_state = dom_none;
-
-       /* With the implementation right now there is nothing to free,
-          but better call it anyways... */
+       clear_irg_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_POSTDOMINANCE);
 }