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 Everlasting outs -- private header.
23 * @author Sebastian Hack, Andreas Schoesser
27 #ifndef FIRM_IR_EDGES_T_H
28 #define FIRM_IR_EDGES_T_H
36 #include "irgraph_t.h"
38 #include "iredgekinds.h"
41 #define DBG_EDGES "firm.ir.edges"
47 ir_node *src; /**< The source node of the edge. */
48 int pos; /**< The position of the edge at @p src. */
49 unsigned invalid : 1; /**< edges that are removed are marked invalid. */
50 unsigned present : 1; /**< Used by the verifier. Don't rely on its content. */
51 unsigned kind : 4; /**< The kind of the edge. */
52 struct list_head list; /**< The list head to queue all out edges at a node. */
54 long src_nr; /**< The node number of the source node. */
55 long edge_nr; /**< A unique number identifying the edge. */
60 /** Accessor for private irn info. */
61 #define _get_irn_edge_info(irn, kind) (&(((irn)->edge_info)[kind]))
63 /** Accessor for private irg info. */
64 #define _get_irg_edge_info(irg, kind) (&(((irg)->edge_info)[kind]))
67 * Convenience macro to get the outs_head from a irn_edge_info_t
70 #define _get_irn_outs_head(irn, kind) (&_get_irn_edge_info(irn, kind)->outs_head)
73 * Get the first edge pointing to some node.
74 * @note There is no order on out edges. First in this context only
75 * means, that you get some starting point into the list of edges.
76 * @param irn The node.
77 * @return The first out edge that points to this node.
79 static inline const ir_edge_t *_get_irn_out_edge_first_kind(const ir_node *irn, ir_edge_kind_t kind)
81 const struct list_head *head = _get_irn_outs_head(irn, kind);
82 return list_empty(head) ? NULL : list_entry(head->next, ir_edge_t, list);
86 * Get the next edge in the out list of some node.
87 * @param irn The node.
88 * @param last The last out edge you have seen.
89 * @return The next out edge in @p irn 's out list after @p last.
91 static inline const ir_edge_t *_get_irn_out_edge_next(const ir_node *irn, const ir_edge_t *last)
93 struct list_head *next = last->list.next;
94 return next == _get_irn_outs_head(irn, last->kind) ? NULL : list_entry(next, ir_edge_t, list);
98 * Get the number of edges pointing to a node.
99 * @param irn The node.
100 * @return The number of edges pointing to this node.
102 static inline int _get_irn_n_edges_kind(const ir_node *irn, int kind)
104 /* Perhaps out_count was buggy. This code does it more safely. */
107 const struct list_head *pos, *head = _get_irn_outs_head(irn, kind);
108 list_for_each(pos, head)
112 return _get_irn_edge_info(irn, kind)->out_count;
116 static inline int _edges_activated_kind(const ir_graph *irg, ir_edge_kind_t kind)
118 return _get_irg_edge_info(irg, kind)->activated;
122 * Assure, that the edges information is present for a certain graph.
123 * @param irg The graph.
125 static inline void _edges_assure_kind(ir_graph *irg, int kind)
127 if(!_edges_activated_kind(irg, kind))
128 edges_activate_kind(irg, kind);
131 void edges_init_graph_kind(ir_graph *irg, ir_edge_kind_t kind);
134 * Notify of a edge change.
135 * The edge from (src, pos) -> old_tgt is redirected to tgt
137 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);
142 void edges_node_deleted(ir_node *old, ir_graph *irg);
144 void edges_invalidate_kind(ir_node *irn, ir_edge_kind_t kind, ir_graph *irg);
147 * Register additional memory in an edge.
148 * This must be called before Firm is initialized.
149 * @param n Number of bytes you need.
150 * @return A number you have to keep and to pass
151 * edges_get_private_data()
152 * to get a pointer to your data.
154 int edges_register_private_data(size_t n);
157 * Get a pointer to the private data you registered.
158 * @param edge The edge.
159 * @param ofs The number, you obtained with
160 * edges_register_private_data().
161 * @return A pointer to the private data.
163 static inline void *_get_edge_private_data(const ir_edge_t *edge, int ofs)
165 return (void *) ((char *) edge + sizeof(edge[0]) + ofs);
168 static inline ir_node *_get_edge_src_irn(const ir_edge_t *edge)
173 static inline int _get_edge_src_pos(const ir_edge_t *edge)
179 * Initialize the out edges.
180 * This must be called before firm is initialized.
182 extern void init_edges(void);
185 * Set dbg information for edges.
187 void edges_init_dbg(int do_dbg);
189 void edges_invalidate_all(ir_node *irn, ir_graph *irg);
191 #define get_irn_n_edges_kind(irn, kind) _get_irn_n_edges_kind(irn, kind)
192 #define get_edge_src_irn(edge) _get_edge_src_irn(edge)
193 #define get_edge_src_pos(edge) _get_edge_src_pos(edge)
194 #define get_edge_private_data(edge, ofs) _get_edge_private_data(edge,ofs)
195 #define get_irn_out_edge_next(irn, last) _get_irn_out_edge_next(irn, last)
197 #ifndef get_irn_n_edges
198 #define get_irn_n_edges(irn) _get_irn_n_edges_kind(irn, EDGE_KIND_NORMAL)
201 #ifndef get_irn_out_edge_first
202 #define get_irn_out_edge_first(irn) _get_irn_out_edge_first_kind(irn, EDGE_KIND_NORMAL)
205 #ifndef get_block_succ_first
206 #define get_block_succ_first(irn) _get_irn_out_edge_first_kind(irn, EDGE_KIND_BLOCK)
209 #ifndef get_block_succ_next
210 #define get_block_succ_next(irn, last) _get_irn_out_edge_next(irn, last)