extended functionality
[libfirm] / ir / ana / irouts.h
1 /*
2  * Project:     libFIRM
3  * File name:   ir/ana/irouts.h
4  * Purpose:     Compute and access out edges.
5  * Author:      Goetz Lindenmaier
6  * Modified by:
7  * Created:     1.2002
8  * CVS-ID:      $Id$
9  * Copyright:   (c) 2002-2003 Universität Karlsruhe
10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
11  */
12
13 /**
14 * @file irouts.h
15 *
16 * Implements Def-Use edges, also called outedges.
17 *
18 * @author Goetz Lindenmaier
19 *
20 * @todo eventually add reverse conrtol flow graph. (If needed.)
21 */
22
23 # ifndef _IROUTS_H_
24 # define _IROUTS_H_
25
26 # include "irgraph.h"
27 # include "irnode.h"
28
29 /*------------------------------------------------------------------*/
30 /* Accessing the out datastructures.                                */
31 /* These routines only work properly if the ir_graph is in state    */
32 /* outs_consistent or outs_inconsistent.                            */
33 /*------------------------------------------------------------------*/
34
35 /** To iterate through the successors iterate from 0 to i < get_irn_outs(). No
36    order of successors guaranteed.  Will return edges from block to floating
37    nodes even if irgraph is in state "op_pin_state_floats". */
38 /* returns the number of successors of the node: */
39 int             get_irn_n_outs (ir_node *node);
40
41 /** Get predecessor n */
42 ir_node *get_irn_out  (ir_node *node, int pos);
43
44 /** Set predecessor n */
45 void     set_irn_out  (ir_node *node, int pos, ir_node *out);
46
47 /* Methods to iterate through the control flow graph. Iterate from 0 to
48    i < get_Block_cfg_outs(block). No order of successors guaranteed. */
49 int             get_Block_n_cfg_outs (ir_node *node);
50
51 /** Access predecessor n. */
52 ir_node *get_Block_cfg_out  (ir_node *node, int pos);
53
54 #ifndef _IRG_WALK_FUNC_TYPEDEF_
55 #define _IRG_WALK_FUNC_TYPEDEF_
56 /** The type of the walk function */
57 typedef void irg_walk_func(ir_node *, void *);
58 #endif
59
60 /** Walks over the graph starting at node.  Walks also if graph is in state
61    "outs_inconsistent".  Assumes current_ir_graph is set properly. */
62 void irg_out_walk(ir_node *node,
63                   irg_walk_func *pre, irg_walk_func *post,
64                   void *env);
65
66 /** Walks only over Block nodes in the graph.  Has it's own visited
67    flag, so that it can be interleaved with the other walker.
68    node must be either op_Block or mode_X.  */
69 void irg_out_block_walk(ir_node *node,
70                         irg_walk_func *pre, irg_walk_func *post,
71                         void *env);
72
73 /*------------------------------------------------------------------*/
74 /* Building and Removing the out datastructure                      */
75 /*------------------------------------------------------------------*/
76
77 /** Computes the out edges.  Sets a flag in irg to "outs_consistent".  If the
78    graph is changed this flag must be set to "outs_inconsistent".  Computes
79    out edges from block to floating nodes even if graph is in state
80    "op_pin_state_floats".   Optimizes Tuple nodes. */
81 void compute_outs(ir_graph *irg);
82 /** Computes the out edges in interprocedural view */
83 void compute_ip_outs(void);
84 /** Frees the out datastructures.  Sets the flag in irg to "outs_none". */
85 void free_ip_outs(void);
86 void free_outs(ir_graph *irg);
87
88 #endif /* _IROUTS_H_ */