2 * Copyright (C) 1995-2007 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 * File name: ir/ir/iredges.h
23 * Purpose: Public header for the automatically updating outs.
24 * Author: Sebastian Hack
27 * Copyright: (c) 1998-2005 Universität Karlsruhe
31 * Public header for the automatically updating outs.
32 * @author Sebastian Hack
36 #ifndef _FIRM_IR_EDGES_H
37 #define _FIRM_IR_EDGES_H
39 #include "firm_types.h"
40 #include "iredgekinds.h"
42 #ifndef _IR_EDGE_TYPEDEF_
43 #define _IR_EDGE_TYPEDEF_
44 typedef struct _ir_edge_t ir_edge_t;
48 #ifndef _IR_EDGE_KIND_TYPEDEF_
49 #define _IR_EDGE_KIND_TYPEDEF_
50 typedef enum _ir_edge_kind_t ir_edge_kind_t;
51 #endif /* _IR_EDGE_KIND_TYPEDEF_ */
55 * Get the first edge pointing to some node.
56 * @note There is no order on out edges. First in this context only
57 * means, that you get some starting point into the list of edges.
58 * @param irn The node.
59 * @param kind The kind of the edge.
60 * @return The first out edge that points to this node.
62 const ir_edge_t *get_irn_out_edge_first_kind(const ir_node *irn, ir_edge_kind_t kind);
65 * Get the next edge in the out list of some node.
66 * @param irn The node.
67 * @param last The last out edge you have seen.
68 * @return The next out edge in @p irn 's out list after @p last.
70 const ir_edge_t *get_irn_out_edge_next(const ir_node *irn, const ir_edge_t *last);
73 * A convenience iteration macro over all out edges of a node.
74 * @param irn The node.
75 * @param kind The edge's kind.
76 * @param edge An ir_edge_t pointer which shall be set to the current
79 #define foreach_out_edge_kind(irn, edge, kind) \
80 for(edge = get_irn_out_edge_first_kind(irn, kind); edge; edge = get_irn_out_edge_next(irn, edge))
83 * A convenience iteration macro over all out edges of a node, which is safe
84 * against alteration of the current edge.
86 * @param irn The node.
87 * @param edge An ir_edge_t pointer which shall be set to the current edge.
88 * @param ne The next edge, enables alteration safe edge processing.
90 #define foreach_out_edge_kind_safe(irn, edge, ne, kind) \
91 for((edge) = (get_irn_out_edge_first_kind(irn, kind)), (ne) = ((edge) ? (get_irn_out_edge_next(irn, edge)) : NULL); \
92 edge; (edge) = (ne), (ne) = ((edge) ? (get_irn_out_edge_next(irn, edge)) : NULL))
95 * Convenience macro for normal out edges.
97 #define foreach_out_edge(irn, edge) foreach_out_edge_kind(irn, edge, EDGE_KIND_NORMAL)
100 * Convenience macro for normal out edges.
102 #define foreach_out_edge_safe(irn, edge, tmp) foreach_out_edge_kind_safe(irn, edge, tmp, EDGE_KIND_NORMAL)
105 * A convenience iteration macro for all control flow edges.
107 #define foreach_block_succ(bl, edge) foreach_out_edge_kind(bl, edge, EDGE_KIND_BLOCK)
110 * Get the source node of an edge.
111 * @param edge The edge.
112 * @return The source node of that edge.
114 ir_node *get_edge_src_irn(const ir_edge_t *edge);
117 * Get the number of edges pointing to a node.
118 * @param irn The node.
119 * @return The number of edges pointing to this node.
121 int get_irn_n_edges(const ir_node *irn);
124 * Get the position of an edge.
125 * @param edge The edge.
126 * @return The position in the in array of that edges source.
128 extern int get_edge_src_pos(const ir_edge_t *edge);
131 * Get the edge object of an outgoing edge at a node.
132 * @param irg The graph, the node is in.
133 * @param irn The node at which the edge originates.
134 * @param pos The position of the edge.
135 * @return The corresponding edge object or NULL,
136 * if no such edge exists.
138 const ir_edge_t *get_irn_edge_kind(ir_graph *irg, const ir_node *irn, int pos, ir_edge_kind_t kind);
141 * Get the number of registered out edges for a specific kind.
142 * @param irn The node.
143 * @param kind The kind.
145 extern int get_irn_n_edges_kind(const ir_node *irn, ir_edge_kind_t kind);
149 * Check, if the out edges are activated.
150 * @param irg The graph.
151 * @param kind The edge kind.
152 * @return 1, if the edges are present for the given irg, 0 if not.
154 extern int edges_activated_kind(const ir_graph *irg, ir_edge_kind_t kind);
157 * Activate the edges for an irg.
158 * @param irg The graph to activate the edges for.
159 * @param kind The edge kind.
161 extern void edges_activate_kind(ir_graph *irg, ir_edge_kind_t kind);
164 * Deactivate the edges for an irg.
165 * @param irg The graph.
166 * @param kind The edge kind.
168 extern void edges_deactivate_kind(ir_graph *irg, ir_edge_kind_t kind);
170 extern void edges_reroute_kind(ir_node *old, ir_node *nw, ir_edge_kind_t kind, ir_graph *irg);
173 * Verifies the out edges of graph @p irg.
174 * @return 1 if a problem was found, 0 otherwise
176 int edges_verify(ir_graph *irg);
180 * Set edge verification flag.
183 void edges_init_dbg(int do_dbg);
185 /************************************************************************/
186 /* Begin Old Interface */
187 /************************************************************************/
189 const ir_edge_t *get_irn_edge(ir_graph *irg, const ir_node *src, int pos);
191 #define edges_reroute(old, nw, irg) edges_reroute_kind(old, nw, EDGE_KIND_NORMAL, irg)
192 #define edges_activated(irg) (edges_activated_kind(irg, EDGE_KIND_NORMAL) && edges_activated_kind(irg, EDGE_KIND_BLOCK))
194 #ifndef get_irn_n_edges
195 #define get_irn_n_edges(irn) get_irn_n_edges_kind(irn, EDGE_KIND_NORMAL)
198 #ifndef get_irn_out_edge_first
199 #define get_irn_out_edge_first(irn) get_irn_out_edge_first_kind(irn, EDGE_KIND_NORMAL)
202 #ifndef get_block_succ_first
203 #define get_block_succ_first(irn) get_irn_out_edge_first_kind(irn, EDGE_KIND_BLOCK)
206 #ifndef get_block_succ_next
207 #define get_block_succ_next(irn, last) get_irn_out_edge_next(irn, last)
211 * Activate all the edges for an irg.
212 * @param irg The graph to activate the edges for.
214 extern void edges_activate(ir_graph *irg);
217 * Deactivate all the edges for an irg.
218 * @param irg The graph.
220 extern void edges_deactivate(ir_graph *irg);
222 extern int edges_assure(ir_graph *irg);
224 extern void edges_node_deleted(ir_node *irn, ir_graph *irg);
227 * Notify normal and block edges.
229 extern void edges_notify_edge(ir_node *src, int pos, ir_node *tgt, ir_node *old_tgt, ir_graph *irg);
231 void edges_reset_private_data(ir_graph *irg, int offset, size_t size);
233 /************************************************************************/
234 /* End Old Interface */
235 /************************************************************************/
238 #endif /* _FIRM_IR_EDGES_H */