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
28 DECLARE_MTYPE(ROUTE_TABLE
)
29 DECLARE_MTYPE(ROUTE_NODE
)
32 * Forward declarations.
38 * route_table_delegate_t
40 * Function vector that can be used by a client to customize the
41 * behavior of one or more route tables.
43 typedef struct route_table_delegate_t_ route_table_delegate_t
;
45 typedef struct route_node
*(*route_table_create_node_func_t
)(
46 route_table_delegate_t
*, struct route_table
*);
48 typedef void (*route_table_destroy_node_func_t
)(route_table_delegate_t
*,
52 struct route_table_delegate_t_
{
53 route_table_create_node_func_t create_node
;
54 route_table_destroy_node_func_t destroy_node
;
57 /* Routing table top structure. */
59 struct route_node
*top
;
63 * Delegate that performs certain functions for this table.
65 route_table_delegate_t
*delegate
;
66 void (*cleanup
)(struct route_table
*, struct route_node
*);
77 * node->link is really internal to the table code and should not be
78 * accessed by outside code. We don't have any writers (yay), though some
79 * readers are left to be fixed.
81 * rationale: we need to add a hash table in parallel, to speed up
82 * exact-match lookups.
84 * same really applies for node->parent, though that's less of an issue.
85 * table->link should be - and is - NEVER written by outside code
87 #ifdef FRR_COMPILING_TABLE_C
88 #define table_rdonly(x) x
89 #define table_internal(x) x
91 #define table_rdonly(x) const x
92 #define table_internal(x) \
93 const x __attribute__( \
94 (deprecated("this should only be accessed by lib/table.c")))
95 /* table_internal is for node->link and node->lock, once we have done
96 * something about remaining accesses */
99 /* so... the problem with this is that "const" doesn't mean "readonly".
100 * It in fact may allow the compiler to optimize based on the assumption
101 * that the value doesn't change. Hence, since the only purpose of this
102 * is to aid in development, don't put the "const" in release builds.
104 * (I haven't seen this actually break, but GCC and LLVM are getting ever
105 * more aggressive in optimizing...)
109 #define table_rdonly(x) x
113 * Macro that defines all fields in a route node.
115 #define ROUTE_NODE_FIELDS \
116 /* Actual prefix of this radix. */ \
120 struct route_table *table_rdonly(table); \
121 struct route_node *table_rdonly(parent); \
122 struct route_node *table_rdonly(link[2]); \
124 /* Lock of this radix */ \
125 unsigned int table_rdonly(lock); \
127 /* Each node of route. */ \
134 /* Each routing entry. */
138 #define l_left link[0]
139 #define l_right link[1]
142 typedef struct route_table_iter_t_ route_table_iter_t
;
146 RT_ITER_STATE_ITERATING
,
147 RT_ITER_STATE_PAUSED
,
149 } route_table_iter_state_t
;
154 * Structure that holds state for iterating over a route table.
156 struct route_table_iter_t_
{
158 route_table_iter_state_t state
;
161 * Routing table that we are iterating over. The caller must ensure
162 * that that table outlives the iterator.
164 struct route_table
*table
;
167 * The node that the iterator is currently on.
169 struct route_node
*current
;
172 * The last prefix that the iterator processed before it was paused.
174 struct prefix pause_prefix
;
178 extern struct route_table
*route_table_init(void);
180 extern struct route_table
*
181 route_table_init_with_delegate(route_table_delegate_t
*);
183 extern route_table_delegate_t
*route_table_get_default_delegate(void);
185 extern void route_table_finish(struct route_table
*);
186 extern struct route_node
*route_top(struct route_table
*);
187 extern struct route_node
*route_next(struct route_node
*);
188 extern struct route_node
*route_next_until(struct route_node
*,
189 const struct route_node
*);
190 extern struct route_node
*route_node_get(struct route_table
*const,
191 union prefixconstptr
);
192 extern struct route_node
*route_node_lookup(const struct route_table
*,
193 union prefixconstptr
);
194 extern struct route_node
*route_node_lookup_maynull(const struct route_table
*,
195 union prefixconstptr
);
196 extern struct route_node
*route_node_match(const struct route_table
*,
197 union prefixconstptr
);
198 extern struct route_node
*route_node_match_ipv4(const struct route_table
*,
199 const struct in_addr
*);
200 extern struct route_node
*route_node_match_ipv6(const struct route_table
*,
201 const struct in6_addr
*);
203 extern unsigned long route_table_count(const struct route_table
*);
205 extern struct route_node
*route_node_create(route_table_delegate_t
*,
206 struct route_table
*);
207 extern void route_node_delete(struct route_node
*);
208 extern void route_node_destroy(route_table_delegate_t
*, struct route_table
*,
209 struct route_node
*);
211 extern struct route_node
*route_table_get_next(const struct route_table
*table
,
212 union prefixconstptr pu
);
213 extern int route_table_prefix_iter_cmp(const struct prefix
*p1
,
214 const struct prefix
*p2
);
217 * Iterator functions.
219 extern void route_table_iter_init(route_table_iter_t
*iter
,
220 struct route_table
*table
);
221 extern void route_table_iter_pause(route_table_iter_t
*iter
);
222 extern void route_table_iter_cleanup(route_table_iter_t
*iter
);
229 static inline struct route_node
*route_lock_node(struct route_node
*node
)
231 (*(unsigned *)&node
->lock
)++;
236 static inline struct route_node
*route_unlock_node(struct route_node
*node
)
238 assert(node
->lock
> 0);
239 (*(unsigned *)&node
->lock
)--;
241 if (node
->lock
== 0) {
242 route_node_delete(node
);
250 * route_table_iter_next
252 * Get the next node in the tree.
254 static inline struct route_node
*route_table_iter_next(route_table_iter_t
*iter
)
256 struct route_node
*node
;
258 switch (iter
->state
) {
260 case RT_ITER_STATE_INIT
:
263 * We're just starting the iteration.
265 node
= route_top(iter
->table
);
268 case RT_ITER_STATE_ITERATING
:
269 node
= route_next(iter
->current
);
272 case RT_ITER_STATE_PAUSED
:
275 * Start with the node following pause_prefix.
277 node
= route_table_get_next(iter
->table
, &iter
->pause_prefix
);
280 case RT_ITER_STATE_DONE
:
287 iter
->current
= node
;
289 iter
->state
= RT_ITER_STATE_ITERATING
;
291 iter
->state
= RT_ITER_STATE_DONE
;
297 * route_table_iter_is_done
299 * Returns TRUE if the iteration is complete.
301 static inline int route_table_iter_is_done(route_table_iter_t
*iter
)
303 return iter
->state
== RT_ITER_STATE_DONE
;
307 * route_table_iter_started
309 * Returns TRUE if this iterator has started iterating over the tree.
311 static inline int route_table_iter_started(route_table_iter_t
*iter
)
313 return iter
->state
!= RT_ITER_STATE_INIT
;
316 #endif /* _ZEBRA_TABLE_H */