3 * Copyright (C) 1998 Kunihiro Ishiguro
5 * This file is part of GNU Zebra.
7 * GNU Zebra is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; either version 2, or (at your option) any
12 * GNU Zebra is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; see the file COPYING; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 #ifndef _ZEBRA_TABLE_H
23 #define _ZEBRA_TABLE_H
34 DECLARE_MTYPE(ROUTE_TABLE
)
35 DECLARE_MTYPE(ROUTE_NODE
)
38 * Forward declarations.
44 * route_table_delegate_t
46 * Function vector that can be used by a client to customize the
47 * behavior of one or more route tables.
49 typedef struct route_table_delegate_t_ route_table_delegate_t
;
51 typedef struct route_node
*(*route_table_create_node_func_t
)(
52 route_table_delegate_t
*, struct route_table
*);
54 typedef void (*route_table_destroy_node_func_t
)(route_table_delegate_t
*,
58 struct route_table_delegate_t_
{
59 route_table_create_node_func_t create_node
;
60 route_table_destroy_node_func_t destroy_node
;
63 PREDECL_HASH(rn_hash_node
)
65 /* Routing table top structure. */
67 struct route_node
*top
;
68 struct rn_hash_node_head hash
;
71 * Delegate that performs certain functions for this table.
73 route_table_delegate_t
*delegate
;
74 void (*cleanup
)(struct route_table
*, struct route_node
*);
85 * node->link is really internal to the table code and should not be
86 * accessed by outside code. We don't have any writers (yay), though some
87 * readers are left to be fixed.
89 * rationale: we need to add a hash table in parallel, to speed up
90 * exact-match lookups.
92 * same really applies for node->parent, though that's less of an issue.
93 * table->link should be - and is - NEVER written by outside code
95 #ifdef FRR_COMPILING_TABLE_C
96 #define table_rdonly(x) x
97 #define table_internal(x) x
99 #define table_rdonly(x) const x
100 #define table_internal(x) \
101 const x __attribute__( \
102 (deprecated("this should only be accessed by lib/table.c")))
103 /* table_internal is for node->link and node->lock, once we have done
104 * something about remaining accesses */
107 /* so... the problem with this is that "const" doesn't mean "readonly".
108 * It in fact may allow the compiler to optimize based on the assumption
109 * that the value doesn't change. Hence, since the only purpose of this
110 * is to aid in development, don't put the "const" in release builds.
112 * (I haven't seen this actually break, but GCC and LLVM are getting ever
113 * more aggressive in optimizing...)
117 #define table_rdonly(x) x
121 * Macro that defines all fields in a route node.
123 #define ROUTE_NODE_FIELDS \
124 /* Actual prefix of this radix. */ \
128 struct route_table *table_rdonly(table); \
129 struct route_node *table_rdonly(parent); \
130 struct route_node *table_rdonly(link[2]); \
132 /* Lock of this radix */ \
133 unsigned int table_rdonly(lock); \
135 struct rn_hash_node_item nodehash; \
136 /* Each node of route. */ \
140 /* Each routing entry. */
144 #define l_left link[0]
145 #define l_right link[1]
148 typedef struct route_table_iter_t_ route_table_iter_t
;
152 RT_ITER_STATE_ITERATING
,
153 RT_ITER_STATE_PAUSED
,
155 } route_table_iter_state_t
;
160 * Structure that holds state for iterating over a route table.
162 struct route_table_iter_t_
{
164 route_table_iter_state_t state
;
167 * Routing table that we are iterating over. The caller must ensure
168 * that that table outlives the iterator.
170 struct route_table
*table
;
173 * The node that the iterator is currently on.
175 struct route_node
*current
;
178 * The last prefix that the iterator processed before it was paused.
180 struct prefix pause_prefix
;
184 extern struct route_table
*route_table_init(void);
186 extern struct route_table
*
187 route_table_init_with_delegate(route_table_delegate_t
*delegate
);
189 extern route_table_delegate_t
*route_table_get_default_delegate(void);
191 static inline void *route_table_get_info(struct route_table
*table
)
196 static inline void route_table_set_info(struct route_table
*table
, void *d
)
201 extern void route_table_finish(struct route_table
*table
);
202 extern struct route_node
*route_top(struct route_table
*table
);
203 extern struct route_node
*route_next(struct route_node
*node
);
204 extern struct route_node
*route_next_until(struct route_node
*node
,
205 const struct route_node
*limit
);
206 extern struct route_node
*route_node_get(struct route_table
*const table
,
207 union prefixconstptr pu
);
208 extern struct route_node
*route_node_lookup(const struct route_table
*table
,
209 union prefixconstptr pu
);
210 extern struct route_node
*
211 route_node_lookup_maynull(const struct route_table
*table
,
212 union prefixconstptr pu
);
213 extern struct route_node
*route_node_match(const struct route_table
*table
,
214 union prefixconstptr pu
);
215 extern struct route_node
*route_node_match_ipv4(const struct route_table
*table
,
216 const struct in_addr
*addr
);
217 extern struct route_node
*route_node_match_ipv6(const struct route_table
*table
,
218 const struct in6_addr
*addr
);
220 extern unsigned long route_table_count(const struct route_table
*table
);
222 extern struct route_node
*route_node_create(route_table_delegate_t
*delegate
,
223 struct route_table
*table
);
224 extern void route_node_delete(struct route_node
*node
);
225 extern void route_node_destroy(route_table_delegate_t
*delegate
,
226 struct route_table
*table
,
227 struct route_node
*node
);
229 extern struct route_node
*route_table_get_next(const struct route_table
*table
,
230 union prefixconstptr pu
);
231 extern int route_table_prefix_iter_cmp(const struct prefix
*p1
,
232 const struct prefix
*p2
);
235 * Iterator functions.
237 extern void route_table_iter_init(route_table_iter_t
*iter
,
238 struct route_table
*table
);
239 extern void route_table_iter_pause(route_table_iter_t
*iter
);
240 extern void route_table_iter_cleanup(route_table_iter_t
*iter
);
247 static inline struct route_node
*route_lock_node(struct route_node
*node
)
249 (*(unsigned *)&node
->lock
)++;
254 static inline void route_unlock_node(struct route_node
*node
)
256 assert(node
->lock
> 0);
257 (*(unsigned *)&node
->lock
)--;
260 route_node_delete(node
);
264 * route_table_iter_next
266 * Get the next node in the tree.
268 static inline struct route_node
*route_table_iter_next(route_table_iter_t
*iter
)
270 struct route_node
*node
;
272 switch (iter
->state
) {
274 case RT_ITER_STATE_INIT
:
277 * We're just starting the iteration.
279 node
= route_top(iter
->table
);
282 case RT_ITER_STATE_ITERATING
:
283 node
= route_next(iter
->current
);
286 case RT_ITER_STATE_PAUSED
:
289 * Start with the node following pause_prefix.
291 node
= route_table_get_next(iter
->table
, &iter
->pause_prefix
);
294 case RT_ITER_STATE_DONE
:
301 iter
->current
= node
;
303 iter
->state
= RT_ITER_STATE_ITERATING
;
305 iter
->state
= RT_ITER_STATE_DONE
;
311 * route_table_iter_is_done
313 * Returns TRUE if the iteration is complete.
315 static inline int route_table_iter_is_done(route_table_iter_t
*iter
)
317 return iter
->state
== RT_ITER_STATE_DONE
;
321 * route_table_iter_started
323 * Returns TRUE if this iterator has started iterating over the tree.
325 static inline int route_table_iter_started(route_table_iter_t
*iter
)
327 return iter
->state
!= RT_ITER_STATE_INIT
;
334 #endif /* _ZEBRA_TABLE_H */