3 * File name: ir/ir/iredges_t.h
4 * Purpose: Everlasting outs -- private header.
5 * Author: Sebastian Hack
8 * Copyright: (c) 1998-2005 Universit�t Karlsruhe
9 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
14 * @author Sebastian Hack
18 #ifndef _FIRM_EDGES_T_H
19 #define _FIRM_EDGES_T_H
21 #include "firm_config.h"
28 #include "irgraph_t.h"
30 #include "iredgekinds.h"
33 #define DBG_EDGES "firm.ir.edges"
39 ir_node *src; /**< The source node of the edge. */
40 int pos; /**< The position of the edge at @p src. */
41 unsigned invalid : 1; /**< edges that are removed are marked invalid. */
42 unsigned present : 1; /**< Used by the verifier. Don't rely on its content. */
43 unsigned kind : 4; /**< The kind of the edge. */
44 struct list_head list; /**< The list head to queue all out edges at a node. */
46 long src_nr; /**< The node number of the source node. */
51 /** Accessor for private irn info. */
52 #define _get_irn_edge_info(irn, kind) (&(((irn)->edge_info)[kind]))
54 /** Accessor for private irg info. */
55 #define _get_irg_edge_info(irg, kind) (&(((irg)->edge_info)[kind]))
58 * Convenience macro to get the outs_head from a irn_edge_info_t
61 #define _get_irn_outs_head(irn, kind) (&_get_irn_edge_info(irn, kind)->outs_head)
64 * Get the first edge pointing to some node.
65 * @note There is no order on out edges. First in this context only
66 * means, that you get some starting point into the list of edges.
67 * @param irn The node.
68 * @return The first out edge that points to this node.
70 static INLINE const ir_edge_t *_get_irn_out_edge_first_kind(const ir_node *irn, ir_edge_kind_t kind)
72 const struct list_head *head = _get_irn_outs_head(irn, kind);
73 return list_empty(head) ? NULL : list_entry(head->next, ir_edge_t, list);
77 * Get the next edge in the out list of some node.
78 * @param irn The node.
79 * @param last The last out edge you have seen.
80 * @return The next out edge in @p irn 's out list after @p last.
82 static INLINE const ir_edge_t *_get_irn_out_edge_next(const ir_node *irn, const ir_edge_t *last)
84 struct list_head *next = last->list.next;
85 return next == _get_irn_outs_head(irn, last->kind) ? NULL : list_entry(next, ir_edge_t, list);
89 * Get the number of edges pointing to a node.
90 * @param irn The node.
91 * @return The number of edges pointing to this node.
93 static INLINE int _get_irn_n_edges_kind(const ir_node *irn, int kind)
95 /* Perhaps out_count was buggy. This code does it more safely. */
98 const struct list_head *pos, *head = _get_irn_outs_head(irn, kind);
99 list_for_each(pos, head)
103 return _get_irn_edge_info(irn)->out_count;
107 static INLINE int _edges_activated_kind(const ir_graph *irg, ir_edge_kind_t kind)
109 return _get_irg_edge_info(irg, kind)->activated;
113 * Assure, that the edges information is present for a certain graph.
114 * @param irg The graph.
116 static INLINE void _edges_assure_kind(ir_graph *irg, int kind)
118 if(!_edges_activated_kind(irg, kind))
119 edges_activate_kind(irg, kind);
122 void edges_reroute_kind(ir_node *old, ir_node *nw, ir_edge_kind_t kind, ir_graph *irg);
124 void edges_init_graph_kind(ir_graph *irg, ir_edge_kind_t kind);
127 * Notify of a edge change.
128 * The edge from (src, pos) -> old_tgt is redirected to tgt
130 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);
135 void edges_node_deleted(ir_node *old, ir_graph *irg);
137 void edges_invalidate_kind(ir_node *irn, ir_edge_kind_t kind, ir_graph *irg);
140 * Register additional memory in an edge.
141 * This must be called before Firm is initialized.
142 * @param n Number of bytes you need.
143 * @return A number you have to keep and to pass
144 * edges_get_private_data()
145 * to get a pointer to your data.
147 int edges_register_private_data(size_t n);
150 * Get a pointer to the private data you registered.
151 * @param edge The edge.
152 * @param ofs The number, you obtained with
153 * edges_register_private_data().
154 * @return A pointer to the private data.
156 static INLINE void *_get_edge_private_data(const ir_edge_t *edge, int ofs)
158 return (void *) ((char *) edge + sizeof(edge[0]) + ofs);
161 static INLINE ir_node *_get_edge_src_irn(const ir_edge_t *edge)
166 static INLINE int _get_edge_src_pos(const ir_edge_t *edge)
172 * Initialize the out edges.
173 * This must be called before firm is initialized.
175 extern void init_edges(void);
177 void edges_invalidate_all(ir_node *irn, ir_graph *irg);
179 #define get_irn_n_edges_kind(irn, kind) _get_irn_n_edges_kind(irn, kind)
180 #define get_edge_src_irn(edge) _get_edge_src_irn(edge)
181 #define get_edge_src_pos(edge) _get_edge_src_pos(edge)
182 #define get_edge_private_data(edge, ofs) _get_edge_private_data(edge,ofs)
183 #define get_irn_out_edge_next(irn, last) _get_irn_out_edge_next(irn, last)
185 #ifndef get_irn_n_edges
186 #define get_irn_n_edges(irn) _get_irn_n_edges_kind(irn, EDGE_KIND_NORMAL)
189 #ifndef get_irn_out_edge_first
190 #define get_irn_out_edge_first(irn) _get_irn_out_edge_first_kind(irn, EDGE_KIND_NORMAL)
193 #ifndef get_block_succ_first
194 #define get_block_succ_first(irn) _get_irn_out_edge_first_kind(irn, EDGE_KIND_BLOCK)
197 #ifndef get_block_succ_next
198 #define get_block_succ_next(irn, last) _get_irn_out_edge_next(irn, last)
203 #endif /* _FIRM_EDGES_T_H */