local_optimize() now kills unrteachable code if dominance info is available.

[libfirm] / ir / ir / irgwalk.h

diff --git a/ir/ir/irgwalk.h b/ir/ir/irgwalk.h
index 8f44976..fcf691b 100644 (file)
--- a/ir/ir/irgwalk.h
+++ b/ir/ir/irgwalk.h
@@ -44,27 +44,23 @@
 typedef void irg_walk_func(ir_node *node, void *env);
 #endif
 
-/** Allocates some necessary datastructures. */
-void init_ip_walk(void);
-
-/** Frees some necessary datastructures. */
-void finish_ip_walk(void);
-
 /**
  * Walks over the ir graph.
  *
- * @param node - the start node
- * @param pre  - walker function, executed before the predecessor of a node are visited
- * @param post - walker function, executed after the predecessor of a node are visited
- * @param env  - environment, passend to pre and post
- *
  * Walks over the ir graph, starting at the node given as first argument.
  * Executes pre before visiting the predecessor of a node, post after.
  * irg_walk uses the visited flag in irg and the nodes to determine visited
  * nodes.  It executes inc_irg_visited(current_ir_graph) to generate a new
- * flag.  It marks the node as visited before executing pre.
+ * flag.  Therefore current_ir_graph must be set before calling the walker.
+ * It marks the node as visited before executing pre.
  * The void* env can be used to pass status information between the
- * pre and post functions.  Does not use the link field.
+ * pre and post functions.  Does not use the link fields.
+ *
+ * @param node - the start node
+ * @param pre  - walker function, executed before the predecessor of a node are visited
+ * @param post - walker function, executed after the predecessor of a node are visited
+ * @param env  - environment, passed to pre and post
+ *
  */
 void irg_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env);
 
@@ -74,7 +70,7 @@ void irg_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env)
  * @param irg  - the irg graph
  * @param pre  - walker function, executed before the predecessor of a node are visited
  * @param post - walker function, executed after the predecessor of a node are visited
- * @param env  - environment, passend to pre and post
+ * @param env  - environment, passed to pre and post
  *
  * Like irg_walk(), but walks over all reachable nodes in the ir
  * graph, starting at the end operation. During the walk current_ir_graph
@@ -88,7 +84,7 @@ void irg_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void
  *
  * @param pre  - walker function, executed before the predecessor of a node are visited
  * @param post - walker function, executed after the predecessor of a node are visited
- * @param env  - environment, passend to pre and post
+ * @param env  - environment, passed to pre and post
  *
  * This function executes irg_walk(end, pre, post, env) for all irgraphs in irprog.
  * Sets current_ir_graph properly for each walk.  Conserves current
@@ -102,25 +98,24 @@ void all_irg_walk(irg_walk_func *pre, irg_walk_func *post, void *env);
  *
  * @param pre  - walker function, executed before the predecessor of a node are visited
  * @param post - walker function, executed after the predecessor of a node are visited
- * @param env  - environment, passend to pre and post
+ * @param env  - environment, passed to pre and post
  *
  * This function walks all irgs in interprocedural view.
  * Visits each node only once.  Sets current_ir_graph properly. Does not use the link field.
  */
 void cg_walk(irg_walk_func *pre, irg_walk_func *post, void *env);
 
-/**
- * Walks only over Block nodes in the graph.
+/** Walks only over Block nodes in the graph.
  *
  * @param node - the start node
  * @param pre  - walker function, executed before the predecessor of a node are visited
  * @param post - walker function, executed after the predecessor of a node are visited
- * @param env  - environment, passend to pre and post
+ * @param env  - environment, passed to pre and post
  *
  * This function Walks only over Block nodes in the graph. Has it's own visited
  * flag, so that it can be interleaved with the other walker.
  * If a none block is passed, starts at the block this node belongs to.
- * If end is passed also visites kept alive blocks. Does not use the link field.
+ * If end is passed also visits kept alive blocks. Does not use the link field.
  */
 void irg_block_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env);
 
@@ -130,7 +125,7 @@ void irg_block_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void
  * @param irg  - the irg graph
  * @param pre  - walker function, executed before the predecessor of a node are visited
  * @param post - walker function, executed after the predecessor of a node are visited
- * @param env  - environment, passend to pre and post
+ * @param env  - environment, passed to pre and post
  *
  * Like irg_block_walk(), but walks over all reachable blocks in the
  * ir graph, starting at the end block. Does not use the link field.
@@ -142,11 +137,30 @@ void irg_block_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post
  *
  * @param pre  - walker function, executed before the predecessor of a node are visited
  * @param post - walker function, executed after the predecessor of a node are visited
- * @param env  - environment, passend to pre and post
+ * @param env  - environment, passed to pre and post
  *
  * This function walks over all code in const_code_irg.
  * Uses visited flag in const_code_irg.  Does not use the link field.
  */
 void walk_const_code(irg_walk_func *pre, irg_walk_func *post, void *env);
 
+/**
+ * Walks over reachable nodes in block-wise order, i.e. visit all nodes in a block
+ * before going to another block, starting at the end operation.
+ * Executes pre before visiting the predecessor of a node, post after.
+ * irg_walk_blkwise_graph() uses the visited flag in irg and the nodes to
+ * determine visited nodes.
+ * It executes inc_irg_visited(current_ir_graph) to generate a new
+ * flag. It marks the node as visited before executing pre.
+ * The void *env can be used to pass status information between the
+ * pre and post functions.  Does not use the link fields.
+ * Walks only intraprocedural, even in interprocedural view.
+ *
+ * @param irg  - the irg graph
+ * @param pre  - walker function, executed before the predecessor of a node are visited
+ * @param post - walker function, executed after the predecessor of a node are visited
+ * @param env  - environment, passed to pre and post
+ */
+void irg_walk_blkwise_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env);
+
 # endif /* _IRGWALK_H_ */