missing include added
[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 "firm_types.h"
27 # include "irgraph.h"
28 # include "irnode.h"
29
30 /*------------------------------------------------------------------*/
31 /* Accessing the out datastructures.                                */
32 /* These routines only work properly if the ir_graph is in state    */
33 /* outs_consistent or outs_inconsistent.                            */
34 /*------------------------------------------------------------------*/
35
36 /** To iterate through the successors iterate from 0 to i < get_irn_outs(). No
37    order of successors guaranteed.  Will return edges from block to floating
38    nodes even if irgraph is in state "op_pin_state_floats". */
39 /* returns the number of successors of the node: */
40 int             get_irn_n_outs (ir_node *node);
41
42 /** Get predecessor n */
43 ir_node *get_irn_out  (ir_node *node, int pos);
44
45 /** Set predecessor n */
46 void     set_irn_out  (ir_node *node, int pos, ir_node *out);
47
48 /* Methods to iterate through the control flow graph. Iterate from 0 to
49    i < get_Block_cfg_outs(block). No order of successors guaranteed. */
50 int             get_Block_n_cfg_outs (ir_node *node);
51
52 /** Access predecessor n. */
53 ir_node *get_Block_cfg_out  (ir_node *node, int pos);
54
55 /** Walks over the graph starting at node.  Walks also if graph is in state
56    "outs_inconsistent".  Assumes current_ir_graph is set properly. */
57 void irg_out_walk(ir_node *node,
58                   irg_walk_func *pre, irg_walk_func *post,
59                   void *env);
60
61 /** Walks only over Block nodes in the graph.  Has it's own visited
62    flag, so that it can be interleaved with the other walker.
63    node must be either op_Block or mode_X.  */
64 void irg_out_block_walk(ir_node *node,
65                         irg_walk_func *pre, irg_walk_func *post,
66                         void *env);
67
68 /*------------------------------------------------------------------*/
69 /* Building and Removing the out datastructure                      */
70 /*------------------------------------------------------------------*/
71
72 /** Computes the out edges.  Sets a flag in irg to "outs_consistent".  If the
73    graph is changed this flag must be set to "outs_inconsistent".  Computes
74    out edges from block to floating nodes even if graph is in state
75    "op_pin_state_floats".   Optimizes Tuple nodes. */
76 void compute_irg_outs(ir_graph *irg);
77 void compute_irp_outs(void);
78 /** Computes the out edges in interprocedural view */
79 void compute_ip_outs(void);
80 /** Frees the out datastructures.  Sets the flag in irg to "outs_none". */
81 void free_ip_outs(void);
82 void free_irg_outs(ir_graph *irg);
83 void free_irp_outs(void);
84
85 #endif /* _IROUTS_H_ */