is_irn_always_opt() added
[libfirm] / ir / ir / irgwalk.h
index 1983be4..5173e4b 100644 (file)
  * Uses current_ir_graph (from irgraph.h)!!! Set it to the proper
  * graph before starting the walker.
  */
+#ifndef _FIRM_IR_IRGWALK_H_
+#define _FIRM_IR_IRGWALK_H_
 
-
-# ifndef _IRGWALK_H_
-# define _IRGWALK_H_
-
-# include "irnode.h"
+#include "firm_types.h"
 
 /* type of callback function for ir_graph walk */
 #ifndef _IRG_WALK_FUNC_TYPEDEF_
@@ -59,7 +57,7 @@ typedef void irg_walk_func(ir_node *node, void *env);
  * @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
  *
  */
 void irg_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env);
@@ -70,7 +68,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
@@ -84,7 +82,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
@@ -98,7 +96,7 @@ 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.
@@ -110,12 +108,12 @@ void cg_walk(irg_walk_func *pre, irg_walk_func *post, void *env);
  * @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);
 
@@ -125,7 +123,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.
@@ -137,7 +135,7 @@ 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.
@@ -146,38 +144,33 @@ 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 node given as first argument.
+ * before going to another block, starting at the end operation.
  * Executes pre before visiting the predecessor of a node, post after.
- * irg_walk_blkwise() 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.  Therefore current_ir_graph must be set before calling the walker.
- * It marks the node as visited before executing pre.
+ * 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.
- * Do NOT leave the graph in interprocedural view.
+ * 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, passend to pre and post
- *
- * This function works like irg_walk, except that it enters and leaves blocks only once.
- * So, the post walker see a 'valid schedule' of the code, the pre-walker a 'reversed schedule'
+ * @param env  - environment, passed to pre and post
  */
-void irg_walk_blkwise(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env);
+void irg_walk_blkwise_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env);
 
 /**
- * Walks over all reachable nodes in the ir graph in block-wise order.
+ * Additionally walk over all anchors. Do NOT increase the visit flag.
+ * This function visits all anchor nodes that otherwise might not been visited in a
+ * walk, for instance the Bad() node.
  *
  * @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
- *
- * Like irg_walk_blkwise(), but walks over all reachable nodes in the ir
- * graph, starting at the end operation. During the walk current_ir_graph
- * is set to irg.  Does not use the link fields.
- * Do NOT leave the graph in interprocedural view.
+ * @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);
+void irg_walk_anchors(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env);
 
-# endif /* _IRGWALK_H_ */
+#endif /* _FIRM_IR_IRGWALK_H_ */