2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Compute and access out edges (also called def-use edges).
23 * @author Goetz Lindenmaier, Michael Beck
27 #ifndef FIRM_ANA_IROUTS_H
28 #define FIRM_ANA_IROUTS_H
30 #include "firm_types.h"
33 /*------------------------------------------------------------------*/
34 /* Accessing the out datastructures. */
35 /* These routines only work properly if the ir_graph is in state */
36 /* outs_consistent or outs_inconsistent. */
37 /*------------------------------------------------------------------*/
39 /** To iterate through the successors iterate from 0 to i < get_irn_outs(). No
40 order of successors guaranteed. Will return edges from block to floating
41 nodes even if irgraph is in state "op_pin_state_floats". */
42 /* returns the number of successors of the node: */
43 FIRM_API int get_irn_n_outs(const ir_node *node);
45 /** Get the User of a node from the Def-Use edge at position pos. */
46 FIRM_API ir_node *get_irn_out(const ir_node *def, int pos);
49 * Get the User and its input position from the Def-Use edge of def
52 FIRM_API ir_node *get_irn_out_ex(const ir_node *def, int pos, int *in_pos);
55 * Set the User at position pos.
57 * @param def the Def node
58 * @param pos the number of the Def-Use edge tat is modified
59 * @param use the Use node
60 * @param in_pos the number of the corresponding Use-Def edge in the use node in array
62 FIRM_API void set_irn_out(ir_node *def, int pos, ir_node *use, int in_pos);
64 /* Methods to iterate through the control flow graph. Iterate from 0 to
65 i < get_Block_cfg_outs(block). No order of successors guaranteed. */
67 /** Return the number of control flow successors, ignore keep-alives. */
68 FIRM_API int get_Block_n_cfg_outs(const ir_node *node);
70 /** Return the number of control flow successors, honor keep-alives. */
71 FIRM_API int get_Block_n_cfg_outs_ka(const ir_node *node);
73 /** Access predecessor n, ignore keep-alives. */
74 FIRM_API ir_node *get_Block_cfg_out(const ir_node *node, int pos);
76 /** Access predecessor n, honor keep-alives. */
77 FIRM_API ir_node *get_Block_cfg_out_ka(const ir_node *node, int pos);
79 /** Walks over the graph starting at node. Walks also if graph is in state
80 "outs_inconsistent". Assumes current_ir_graph is set properly. */
81 FIRM_API void irg_out_walk(ir_node *node, irg_walk_func *pre,
82 irg_walk_func *post, void *env);
84 /** Walks only over Block nodes in the graph. Has its own visited
85 flag, so that it can be interleaved with the other walker.
86 node must be either op_Block or mode_X. */
87 FIRM_API void irg_out_block_walk(ir_node *node, irg_walk_func *pre,
88 irg_walk_func *post, void *env);
91 * returns 1 if outs have been computed for a node, 0 otherwise.
93 * this is useful to detect newly created nodes that have no outs set yet
95 FIRM_API int get_irn_outs_computed(const ir_node *node);
97 /*------------------------------------------------------------------*/
98 /* Building and Removing the out datastructure */
99 /*------------------------------------------------------------------*/
101 /** Computes the out edges. Sets a flag in irg to "outs_consistent". If the
102 graph is changed this flag must be set to "outs_inconsistent". Computes
103 out edges from block to floating nodes even if graph is in state
104 "op_pin_state_floats". Optimizes Tuple nodes. */
105 FIRM_API void compute_irg_outs(ir_graph *irg);
106 FIRM_API void compute_irp_outs(void);
108 FIRM_API void assure_irg_outs(ir_graph *irg);
110 FIRM_API void free_irg_outs(ir_graph *irg);
111 FIRM_API void free_irp_outs(void);