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_t.h
23 * Purpose: Everlasting outs -- private header.
24 * Author: Sebastian Hack
25 * Modified by: Andreas Schoesser
28 * Copyright: (c) 1998-2005 Universit�t Karlsruhe
33 * @author Sebastian Hack
37 #ifndef _FIRM_EDGES_T_H
38 #define _FIRM_EDGES_T_H
40 #include "firm_config.h"
47 #include "irgraph_t.h"
49 #include "iredgekinds.h"
52 #define DBG_EDGES "firm.ir.edges"
58 ir_node *src; /**< The source node of the edge. */
59 int pos; /**< The position of the edge at @p src. */
60 unsigned invalid : 1; /**< edges that are removed are marked invalid. */
61 unsigned present : 1; /**< Used by the verifier. Don't rely on its content. */
62 unsigned kind : 4; /**< The kind of the edge. */
63 struct list_head list; /**< The list head to queue all out edges at a node. */
65 long src_nr; /**< The node number of the source node. */
66 long edge_nr; /**< A unique number identifying the edge. */
71 /** Accessor for private irn info. */
72 #define _get_irn_edge_info(irn, kind) (&(((irn)->edge_info)[kind]))
74 /** Accessor for private irg info. */
75 #define _get_irg_edge_info(irg, kind) (&(((irg)->edge_info)[kind]))
78 * Convenience macro to get the outs_head from a irn_edge_info_t
81 #define _get_irn_outs_head(irn, kind) (&_get_irn_edge_info(irn, kind)->outs_head)
84 * Get the first edge pointing to some node.
85 * @note There is no order on out edges. First in this context only
86 * means, that you get some starting point into the list of edges.
87 * @param irn The node.
88 * @return The first out edge that points to this node.
90 static INLINE const ir_edge_t *_get_irn_out_edge_first_kind(const ir_node *irn, ir_edge_kind_t kind)
92 const struct list_head *head = _get_irn_outs_head(irn, kind);
93 return list_empty(head) ? NULL : list_entry(head->next, ir_edge_t, list);
97 * Get the next edge in the out list of some node.
98 * @param irn The node.
99 * @param last The last out edge you have seen.
100 * @return The next out edge in @p irn 's out list after @p last.
102 static INLINE const ir_edge_t *_get_irn_out_edge_next(const ir_node *irn, const ir_edge_t *last)
104 struct list_head *next = last->list.next;
105 return next == _get_irn_outs_head(irn, last->kind) ? NULL : list_entry(next, ir_edge_t, list);
109 * Get the number of edges pointing to a node.
110 * @param irn The node.
111 * @return The number of edges pointing to this node.
113 static INLINE int _get_irn_n_edges_kind(const ir_node *irn, int kind)
115 /* Perhaps out_count was buggy. This code does it more safely. */
118 const struct list_head *pos, *head = _get_irn_outs_head(irn, kind);
119 list_for_each(pos, head)
123 return _get_irn_edge_info(irn, kind)->out_count;
127 static INLINE int _edges_activated_kind(const ir_graph *irg, ir_edge_kind_t kind)
129 return _get_irg_edge_info(irg, kind)->activated;
133 * Assure, that the edges information is present for a certain graph.
134 * @param irg The graph.
136 static INLINE void _edges_assure_kind(ir_graph *irg, int kind)
138 if(!_edges_activated_kind(irg, kind))
139 edges_activate_kind(irg, kind);
142 void edges_init_graph_kind(ir_graph *irg, ir_edge_kind_t kind);
145 * Notify of a edge change.
146 * The edge from (src, pos) -> old_tgt is redirected to tgt
148 void edges_notify_edge_kind(ir_node *src, int pos, ir_node *tgt, ir_node *old_tgt, ir_edge_kind_t kind, ir_graph *irg);
153 void edges_node_deleted(ir_node *old, ir_graph *irg);
155 void edges_invalidate_kind(ir_node *irn, ir_edge_kind_t kind, ir_graph *irg);
158 * Register additional memory in an edge.
159 * This must be called before Firm is initialized.
160 * @param n Number of bytes you need.
161 * @return A number you have to keep and to pass
162 * edges_get_private_data()
163 * to get a pointer to your data.
165 int edges_register_private_data(size_t n);
168 * Get a pointer to the private data you registered.
169 * @param edge The edge.
170 * @param ofs The number, you obtained with
171 * edges_register_private_data().
172 * @return A pointer to the private data.
174 static INLINE void *_get_edge_private_data(const ir_edge_t *edge, int ofs)
176 return (void *) ((char *) edge + sizeof(edge[0]) + ofs);
179 static INLINE ir_node *_get_edge_src_irn(const ir_edge_t *edge)
184 static INLINE int _get_edge_src_pos(const ir_edge_t *edge)
190 * Initialize the out edges.
191 * This must be called before firm is initialized.
193 extern void init_edges(void);
196 * Set dbg information for edges.
198 void edges_init_dbg(int do_dbg);
200 void edges_invalidate_all(ir_node *irn, ir_graph *irg);
202 #define get_irn_n_edges_kind(irn, kind) _get_irn_n_edges_kind(irn, kind)
203 #define get_edge_src_irn(edge) _get_edge_src_irn(edge)
204 #define get_edge_src_pos(edge) _get_edge_src_pos(edge)
205 #define get_edge_private_data(edge, ofs) _get_edge_private_data(edge,ofs)
206 #define get_irn_out_edge_next(irn, last) _get_irn_out_edge_next(irn, last)
208 #ifndef get_irn_n_edges
209 #define get_irn_n_edges(irn) _get_irn_n_edges_kind(irn, EDGE_KIND_NORMAL)
212 #ifndef get_irn_out_edge_first
213 #define get_irn_out_edge_first(irn) _get_irn_out_edge_first_kind(irn, EDGE_KIND_NORMAL)
216 #ifndef get_block_succ_first
217 #define get_block_succ_first(irn) _get_irn_out_edge_first_kind(irn, EDGE_KIND_BLOCK)
220 #ifndef get_block_succ_next
221 #define get_block_succ_next(irn, last) _get_irn_out_edge_next(irn, last)
226 #endif /* _FIRM_EDGES_T_H */