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 Public header for the automatically updating outs.
23 * @author Sebastian Hack
27 #ifndef FIRM_IR_IREDGES_H
28 #define FIRM_IR_IREDGES_H
30 #include "firm_types.h"
31 #include "iredgekinds.h"
34 * Get the first edge pointing to some node.
35 * @note There is no order on out edges. First in this context only
36 * means, that you get some starting point into the list of edges.
37 * @param irn The node.
38 * @param kind The kind of the edge.
39 * @return The first out edge that points to this node.
41 const ir_edge_t *get_irn_out_edge_first_kind(const ir_node *irn, ir_edge_kind_t kind);
44 * Get the next edge in the out list of some node.
45 * @param irn The node.
46 * @param last The last out edge you have seen.
47 * @return The next out edge in @p irn 's out list after @p last.
49 const ir_edge_t *get_irn_out_edge_next(const ir_node *irn, const ir_edge_t *last);
52 * A convenience iteration macro over all out edges of a node.
53 * @param irn The node.
54 * @param kind The edge's kind.
55 * @param edge An ir_edge_t pointer which shall be set to the current
58 #define foreach_out_edge_kind(irn, edge, kind) \
59 for(edge = get_irn_out_edge_first_kind(irn, kind); edge; edge = get_irn_out_edge_next(irn, edge))
62 * A convenience iteration macro over all out edges of a node, which is safe
63 * against alteration of the current edge.
65 * @param irn The node.
66 * @param edge An ir_edge_t pointer which shall be set to the current edge.
67 * @param ne The next edge, enables alteration safe edge processing.
69 #define foreach_out_edge_kind_safe(irn, edge, ne, kind) \
70 for((edge) = (get_irn_out_edge_first_kind(irn, kind)), (ne) = ((edge) ? (get_irn_out_edge_next(irn, edge)) : NULL); \
71 edge; (edge) = (ne), (ne) = ((edge) ? (get_irn_out_edge_next(irn, edge)) : NULL))
74 * Convenience macro for normal out edges.
76 #define foreach_out_edge(irn, edge) foreach_out_edge_kind(irn, edge, EDGE_KIND_NORMAL)
79 * Convenience macro for normal out edges.
81 #define foreach_out_edge_safe(irn, edge, tmp) foreach_out_edge_kind_safe(irn, edge, tmp, EDGE_KIND_NORMAL)
84 * A convenience iteration macro for all control flow edges.
86 #define foreach_block_succ(bl, edge) foreach_out_edge_kind(bl, edge, EDGE_KIND_BLOCK)
89 * Get the source node of an edge.
90 * @param edge The edge.
91 * @return The source node of that edge.
93 ir_node *get_edge_src_irn(const ir_edge_t *edge);
96 * Get the number of edges pointing to a node.
97 * @param irn The node.
98 * @return The number of edges pointing to this node.
100 int get_irn_n_edges(const ir_node *irn);
103 * Get the position of an edge.
104 * @param edge The edge.
105 * @return The position in the in array of that edges source.
107 int get_edge_src_pos(const ir_edge_t *edge);
110 * Get the edge object of an outgoing edge at a node.
111 * @param irg The graph, the node is in.
112 * @param irn The node at which the edge originates.
113 * @param pos The position of the edge.
114 * @return The corresponding edge object or NULL,
115 * if no such edge exists.
117 const ir_edge_t *get_irn_edge_kind(ir_graph *irg, const ir_node *irn, int pos, ir_edge_kind_t kind);
120 * Get the number of registered out edges for a specific kind.
121 * @param irn The node.
122 * @param kind The kind.
124 int get_irn_n_edges_kind(const ir_node *irn, ir_edge_kind_t kind);
127 * Check, if the out edges are activated.
129 * @param irg The graph.
130 * @param kind The edge kind.
132 * @return 1, if the edges are present for the given irg, 0 if not.
134 int edges_activated_kind(const ir_graph *irg, ir_edge_kind_t kind);
137 * Activate the edges for an irg.
139 * @param irg The graph to activate the edges for.
140 * @param kind The edge kind.
142 void edges_activate_kind(ir_graph *irg, ir_edge_kind_t kind);
145 * Deactivate the edges for an irg.
147 * @param irg The graph.
148 * @param kind The edge kind.
150 void edges_deactivate_kind(ir_graph *irg, ir_edge_kind_t kind);
153 * Reroute edges of a specified kind from an old node to
156 * @param old the old node
157 * @param nw the new node
158 * @param kind the edge kind
159 * @param irg the graph on which the rerouting occurs
161 void edges_reroute_kind(ir_node *old, ir_node *nw, ir_edge_kind_t kind, ir_graph *irg);
164 * Verifies the out edges of graph @p irg.
165 * @return 1 if a problem was found, 0 otherwise
167 int edges_verify(ir_graph *irg);
170 * Set edge verification flag.
172 void edges_init_dbg(int do_dbg);
174 /************************************************************************/
175 /* Begin Old Interface */
176 /************************************************************************/
178 const ir_edge_t *get_irn_edge(ir_graph *irg, const ir_node *src, int pos);
180 #define edges_reroute(old, nw, irg) edges_reroute_kind(old, nw, EDGE_KIND_NORMAL, irg)
181 #define edges_activated(irg) (edges_activated_kind(irg, EDGE_KIND_NORMAL) && edges_activated_kind(irg, EDGE_KIND_BLOCK))
183 #ifndef get_irn_n_edges
184 #define get_irn_n_edges(irn) get_irn_n_edges_kind(irn, EDGE_KIND_NORMAL)
187 #ifndef get_irn_out_edge_first
188 #define get_irn_out_edge_first(irn) get_irn_out_edge_first_kind(irn, EDGE_KIND_NORMAL)
191 #ifndef get_block_succ_first
192 #define get_block_succ_first(irn) get_irn_out_edge_first_kind(irn, EDGE_KIND_BLOCK)
195 #ifndef get_block_succ_next
196 #define get_block_succ_next(irn, last) get_irn_out_edge_next(irn, last)
200 * Activates data and block edges for an irg.
201 * If the irg phase is phase_backend, Dependence edges are
202 * additionally activated.
204 * @param irg The graph to activate the edges for.
206 void edges_activate(ir_graph *irg);
209 * Deactivate data and block edges for an irg.
210 * If the irg phase is phase_backend, Dependence edges are
211 * additionally deactivated.
212 * @param irg The graph.
214 void edges_deactivate(ir_graph *irg);
217 * Ensure that edges are activated.
219 * @param irg the IR graph
221 * @return 0 if edges was deactivated before the call, 1 else
223 int edges_assure(ir_graph *irg);
226 * Ensure that edges of a given kind are activated.
228 * @param irg the IR graph
229 * @param kind the edge kind
231 * @return 0 if edges was deactivated before the call, 1 else
233 int edges_assure_kind(ir_graph *irg, ir_edge_kind_t kind);
235 void edges_node_deleted(ir_node *irn, ir_graph *irg);
238 * Notify normal and block edges.
240 void edges_notify_edge(ir_node *src, int pos, ir_node *tgt, ir_node *old_tgt, ir_graph *irg);
243 * Walks only over Block nodes in the graph. Uses the block visited
244 * flag, so that it can be interleaved with another walker.
246 * @param block the start block
247 * @param pre the pre visit function
248 * @param post the post visit function
249 * @param env the environment for the walker
251 void irg_block_edges_walk(ir_node *block, irg_walk_func *pre, irg_walk_func *post, void *env);
254 * Reset the user's private data at offset 'offset'
255 * The user has to remember his offset and the size of his data!
256 * Caution: Using wrong values here can destroy other users private data!
258 * @param irg the IR graph to operate on
259 * @param offset offset of the private data inside the edge
260 * @param size length of the private data inside the edge
262 void edges_reset_private_data(ir_graph *irg, int offset, unsigned size);
264 /************************************************************************/
265 /* End Old Interface */
266 /************************************************************************/