X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=include%2Flibfirm%2Firdom.h;h=35261d8f9c7d23ae00853b6812314ebdbd41b3d5;hb=0ed495da32589b78283d9ede3cb9e33727316006;hp=ead693df05898ed33ef04be7c7ca1b79725b3f33;hpb=fbe9e7db119eb320ecfa3b1e9911c55c38a97126;p=libfirm diff --git a/include/libfirm/irdom.h b/include/libfirm/irdom.h index ead693df0..35261d8f9 100644 --- a/include/libfirm/irdom.h +++ b/include/libfirm/irdom.h @@ -49,54 +49,51 @@ * @{ */ -/** Accessing the dominator data structure. +/** return immediate dominator of block */ +FIRM_API ir_node *get_Block_idom(const ir_node *block); + +/** return immediate postdominator of a block */ +FIRM_API ir_node *get_Block_ipostdom(const ir_node *block); + +/** + * Check, if a block dominates another block. * - * These routines only work properly if the ir_graph is in state - * dom_consistent or dom_inconsistent. + * @param a The potential dominator block. + * @param b The potentially dominated block. * - * If the block is not reachable from Start, returns a Bad node. + * @return 1, if @p a dominates @p b, else 0. */ -FIRM_API ir_node *get_Block_idom(const ir_node *bl); -FIRM_API void set_Block_idom(ir_node *bl, ir_node *n); - -FIRM_API int get_Block_dom_depth(const ir_node *bl); -FIRM_API void set_Block_dom_depth(ir_node *bl, int depth); - -FIRM_API int get_Block_dom_pre_num(const ir_node *bl); -FIRM_API void set_Block_dom_pre_num(ir_node *bl, int num); +FIRM_API int block_dominates(const ir_node *a, const ir_node *b); -/** Accessing the post dominator data structure. +/** + * Check, if a block strictly dominates another block, i.e. a != b. * - * These routines only work properly if the ir_graph is in state - * dom_consistent or dom_inconsistent. + * @param a The potential dominator block. + * @param b The potentially dominated block. + * + * @return 1, if @p a strictly dominates @p b, else 0. */ -FIRM_API ir_node *get_Block_ipostdom(const ir_node *bl); -FIRM_API void set_Block_ipostdom(ir_node *bl, ir_node *n); - -FIRM_API int get_Block_postdom_depth(const ir_node *bl); -FIRM_API void set_Block_postdom_depth(ir_node *bl, int depth); - -FIRM_API int get_Block_postdom_pre_num(const ir_node *bl); -FIRM_API void set_Block_postdom_pre_num(ir_node *bl, int num); +FIRM_API int block_strictly_dominates(const ir_node *a, const ir_node *b); /** - * Get the pre-order number of a block resulting from a - * Depth-First-Search walkover the dominator tree. + * Check, if a block post dominates another block. * - * @param bl The block. - * @return The pre-order number. + * @param a The potential post dominator block. + * @param b The potentially post dominated block. + * + * @return 1, if @p a post dominates @p b, else 0. */ -FIRM_API unsigned get_Block_dom_tree_pre_num(const ir_node *bl); -FIRM_API unsigned get_Block_pdom_tree_pre_num(const ir_node *bl); +FIRM_API int block_postdominates(const ir_node *a, const ir_node *b); /** - * Get the largest pre-order number found in the subtree of the - * dominator tree rooted at a given block. - * @param bl The block. - * @return The largest pre-order number of block's dominator subtree. + * Check, if a block strictly post dominates another block, i.e. a != b. + * + * @param a The potential post dominator block. + * @param b The potentially post dominated block. + * + * @return 1, if @p a strictly post dominates @p b, else 0. */ -FIRM_API unsigned get_Block_dom_max_subtree_pre_num(const ir_node *bl); -FIRM_API unsigned get_Block_pdom_max_subtree_pre_num(const ir_node *bl); +FIRM_API int block_strictly_postdominates(const ir_node *a, const ir_node *b); /** * Get the first node in the list of nodes dominated by a given block. @@ -109,7 +106,10 @@ FIRM_API unsigned get_Block_pdom_max_subtree_pre_num(const ir_node *bl); * @param bl The block for which to get the first node dominated by @c bl. * @return The first node dominated by @p bl. */ -FIRM_API ir_node *get_Block_dominated_first(const ir_node *bl); +FIRM_API ir_node *get_Block_dominated_first(const ir_node *block); +/** + * Get the first node in the list of nodes postdominated by a given blcok. + */ FIRM_API ir_node *get_Block_postdominated_first(const ir_node *bl); /** @@ -119,8 +119,11 @@ FIRM_API ir_node *get_Block_postdominated_first(const ir_node *bl); * @param dom The previous node. * @return The next node in this list or NULL if it was the last. */ -FIRM_API ir_node *get_Block_dominated_next(const ir_node *dom); -FIRM_API ir_node *get_Block_postdominated_next(const ir_node *dom); +FIRM_API ir_node *get_Block_dominated_next(const ir_node *node); +/** + * Get the next node in a list of nodes which are postdominated by another node + */ +FIRM_API ir_node *get_Block_postdominated_next(const ir_node *node); /** * Iterate over all nodes which are immediately dominated by a given @@ -142,26 +145,6 @@ FIRM_API ir_node *get_Block_postdominated_next(const ir_node *dom); for(curr = get_Block_postdominated_first(bl); curr; \ curr = get_Block_postdominated_next(curr)) -/** - * Check, if a block dominates another block. - * - * @param a The potential dominator block. - * @param b The potentially dominated block. - * - * @return 1, if @p a dominates @p b, else 0. - */ -FIRM_API int block_dominates(const ir_node *a, const ir_node *b); - -/** - * Check, if a block strictly dominates another block, i.e. a != b. - * - * @param a The potential dominator block. - * @param b The potentially dominated block. - * - * @return 1, if @p a strictly dominates @p b, else 0. - */ -FIRM_API int block_strictly_dominates(const ir_node *a, const ir_node *b); - /** * Returns the smallest common dominator block of two nodes. * @param a A node. @@ -170,41 +153,6 @@ FIRM_API int block_strictly_dominates(const ir_node *a, const ir_node *b); */ FIRM_API ir_node *node_smallest_common_dominator(ir_node *a, ir_node *b); -/** - * Returns the smallest common dominator block of all users of a node - * BEWARE: @p irn must not be a block - * If on or more users are Phi nodes, one can request special handling - * with @p handle_phi = 1. In this case the cfg predecessor block - * corresponding to the position of the irn in the argument list of the - * Phi is determined and treated as user. - * - * @param irn A node. - * @param handle_phi 1 if Phis should be handled different - * @return The first block dominating all users of @p irn - */ -FIRM_API ir_node *node_users_smallest_common_dominator(ir_node *irn, - int handle_phi); - -/** - * Check, if a block post dominates another block. - * - * @param a The potential post dominator block. - * @param b The potentially post dominated block. - * - * @return 1, if @p a post dominates @p b, else 0. - */ -FIRM_API int block_postdominates(const ir_node *a, const ir_node *b); - -/** - * Check, if a block strictly post dominates another block, i.e. a != b. - * - * @param a The potential post dominator block. - * @param b The potentially post dominated block. - * - * @return 1, if @p a strictly post dominates @p b, else 0. - */ -FIRM_API int block_strictly_postdominates(const ir_node *a, const ir_node *b); - /** * Visit all nodes in the dominator subtree of a given node. * Call a pre-visitor before descending to the children and call a @@ -249,9 +197,7 @@ FIRM_API void dom_tree_walk_irg(ir_graph *irg, irg_walk_func *pre, FIRM_API void postdom_tree_walk_irg(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env); -/* ------------ Building and Removing the dominator data structure ----------- */ - -/** Computes the dominator trees. +/** Computes the dominance relation for all basic blocks of a given graph. * * Sets a flag in irg to "dom_consistent". * If the control flow of the graph is changed this flag must be set to @@ -268,10 +214,10 @@ FIRM_API void postdom_tree_walk_irg(ir_graph *irg, irg_walk_func *pre, */ FIRM_API void compute_doms(ir_graph *irg); -/** Computes the dominator trees on demand, @see compute_doms(). */ +/** Recomputes dominator relation of a graph if necessary */ FIRM_API void assure_doms(ir_graph *irg); -/** Computes the post dominator trees. +/** Computes the post dominance relation for all basic blocks of a given graph. * * Sets a flag in irg to "dom_consistent". * If the control flow of the graph is changed this flag must be set to @@ -288,15 +234,14 @@ FIRM_API void assure_doms(ir_graph *irg); */ FIRM_API void compute_postdoms(ir_graph *irg); -/** Computes the dominator trees on demand */ +/** Recompute postdominance relation if necessary */ FIRM_API void assure_postdoms(ir_graph *irg); -/** Frees the dominator data structures. Sets the flag in irg to "dom_none". */ +/** Frees the dominance data structures. Sets the flag in irg to "dom_none". */ FIRM_API void free_dom(ir_graph *irg); /** - * Frees the post dominator data structures. - * Sets the flag in irg to "dom_none". + * Frees the postdominance data structures. Sets the flag in irg to "dom_none". */ FIRM_API void free_postdom(ir_graph *irg);