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 * @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"
33 #ifndef _IR_EDGE_TYPEDEF_
34 #define _IR_EDGE_TYPEDEF_
35 typedef struct _ir_edge_t ir_edge_t;
39 * Get the first edge pointing to some node.
40 * @note There is no order on out edges. First in this context only
41 * means, that you get some starting point into the list of edges.
42 * @param irn The node.
43 * @param kind The kind of the edge.
44 * @return The first out edge that points to this node.
46 const ir_edge_t *get_irn_out_edge_first_kind(const ir_node *irn, ir_edge_kind_t kind);
49 * Get the next edge in the out list of some node.
50 * @param irn The node.
51 * @param last The last out edge you have seen.
52 * @return The next out edge in @p irn 's out list after @p last.
54 const ir_edge_t *get_irn_out_edge_next(const ir_node *irn, const ir_edge_t *last);
57 * A convenience iteration macro over all out edges of a node.
58 * @param irn The node.
59 * @param kind The edge's kind.
60 * @param edge An ir_edge_t pointer which shall be set to the current
63 #define foreach_out_edge_kind(irn, edge, kind) \
64 for(edge = get_irn_out_edge_first_kind(irn, kind); edge; edge = get_irn_out_edge_next(irn, edge))
67 * A convenience iteration macro over all out edges of a node, which is safe
68 * against alteration of the current edge.
70 * @param irn The node.
71 * @param edge An ir_edge_t pointer which shall be set to the current edge.
72 * @param ne The next edge, enables alteration safe edge processing.
74 #define foreach_out_edge_kind_safe(irn, edge, ne, kind) \
75 for((edge) = (get_irn_out_edge_first_kind(irn, kind)), (ne) = ((edge) ? (get_irn_out_edge_next(irn, edge)) : NULL); \
76 edge; (edge) = (ne), (ne) = ((edge) ? (get_irn_out_edge_next(irn, edge)) : NULL))
79 * Convenience macro for normal out edges.
81 #define foreach_out_edge(irn, edge) foreach_out_edge_kind(irn, edge, EDGE_KIND_NORMAL)
84 * Convenience macro for normal out edges.
86 #define foreach_out_edge_safe(irn, edge, tmp) foreach_out_edge_kind_safe(irn, edge, tmp, EDGE_KIND_NORMAL)
89 * A convenience iteration macro for all control flow edges.
91 #define foreach_block_succ(bl, edge) foreach_out_edge_kind(bl, edge, EDGE_KIND_BLOCK)
94 * Get the source node of an edge.
95 * @param edge The edge.
96 * @return The source node of that edge.
98 ir_node *get_edge_src_irn(const ir_edge_t *edge);
101 * Get the number of edges pointing to a node.
102 * @param irn The node.
103 * @return The number of edges pointing to this node.
105 int get_irn_n_edges(const ir_node *irn);
108 * Get the position of an edge.
109 * @param edge The edge.
110 * @return The position in the in array of that edges source.
112 extern int get_edge_src_pos(const ir_edge_t *edge);
115 * Get the edge object of an outgoing edge at a node.
116 * @param irg The graph, the node is in.
117 * @param irn The node at which the edge originates.
118 * @param pos The position of the edge.
119 * @return The corresponding edge object or NULL,
120 * if no such edge exists.
122 const ir_edge_t *get_irn_edge_kind(ir_graph *irg, const ir_node *irn, int pos, ir_edge_kind_t kind);
125 * Get the number of registered out edges for a specific kind.
126 * @param irn The node.
127 * @param kind The kind.
129 extern int get_irn_n_edges_kind(const ir_node *irn, ir_edge_kind_t kind);
133 * Check, if the out edges are activated.
134 * @param irg The graph.
135 * @param kind The edge kind.
136 * @return 1, if the edges are present for the given irg, 0 if not.
138 extern int edges_activated_kind(const ir_graph *irg, ir_edge_kind_t kind);
141 * Activate the edges for an irg.
142 * @param irg The graph to activate the edges for.
143 * @param kind The edge kind.
145 extern void edges_activate_kind(ir_graph *irg, ir_edge_kind_t kind);
148 * Deactivate the edges for an irg.
149 * @param irg The graph.
150 * @param kind The edge kind.
152 extern void edges_deactivate_kind(ir_graph *irg, ir_edge_kind_t kind);
154 extern void edges_reroute_kind(ir_node *old, ir_node *nw, ir_edge_kind_t kind, ir_graph *irg);
157 * Verifies the out edges of graph @p irg.
158 * @return 1 if a problem was found, 0 otherwise
160 int edges_verify(ir_graph *irg);
164 * Set edge verification flag.
167 void edges_init_dbg(int do_dbg);
169 /************************************************************************/
170 /* Begin Old Interface */
171 /************************************************************************/
173 const ir_edge_t *get_irn_edge(ir_graph *irg, const ir_node *src, int pos);
175 #define edges_reroute(old, nw, irg) edges_reroute_kind(old, nw, EDGE_KIND_NORMAL, irg)
176 #define edges_activated(irg) (edges_activated_kind(irg, EDGE_KIND_NORMAL) && edges_activated_kind(irg, EDGE_KIND_BLOCK))
178 #ifndef get_irn_n_edges
179 #define get_irn_n_edges(irn) get_irn_n_edges_kind(irn, EDGE_KIND_NORMAL)
182 #ifndef get_irn_out_edge_first
183 #define get_irn_out_edge_first(irn) get_irn_out_edge_first_kind(irn, EDGE_KIND_NORMAL)
186 #ifndef get_block_succ_first
187 #define get_block_succ_first(irn) get_irn_out_edge_first_kind(irn, EDGE_KIND_BLOCK)
190 #ifndef get_block_succ_next
191 #define get_block_succ_next(irn, last) get_irn_out_edge_next(irn, last)
195 * Activate all the edges for an irg.
196 * @param irg The graph to activate the edges for.
198 extern void edges_activate(ir_graph *irg);
201 * Deactivate all the edges for an irg.
202 * @param irg The graph.
204 extern void edges_deactivate(ir_graph *irg);
206 extern int edges_assure(ir_graph *irg);
208 extern void edges_node_deleted(ir_node *irn, ir_graph *irg);
211 * Notify normal and block edges.
213 extern void edges_notify_edge(ir_node *src, int pos, ir_node *tgt, ir_node *old_tgt, ir_graph *irg);
215 void edges_reset_private_data(ir_graph *irg, int offset, size_t size);
217 /************************************************************************/
218 /* End Old Interface */
219 /************************************************************************/