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
18 * along with GNU Zebra; see the file COPYING. If not, write to the Free
19 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
23 #ifndef _ZEBRA_TABLE_H
24 #define _ZEBRA_TABLE_H
27 DECLARE_MTYPE(ROUTE_TABLE
)
30 * Forward declarations.
36 * route_table_delegate_t
38 * Function vector that can be used by a client to customize the
39 * behavior of one or more route tables.
41 typedef struct route_table_delegate_t_ route_table_delegate_t
;
43 typedef struct route_node
* (*route_table_create_node_func_t
)
44 (route_table_delegate_t
*, struct route_table
*);
46 typedef void (*route_table_destroy_node_func_t
)
47 (route_table_delegate_t
*, struct route_table
*, struct route_node
*);
49 struct route_table_delegate_t_
51 route_table_create_node_func_t create_node
;
52 route_table_destroy_node_func_t destroy_node
;
55 /* Routing table top structure. */
58 struct route_node
*top
;
61 * Delegate that performs certain functions for this table.
63 route_table_delegate_t
*delegate
;
74 * Macro that defines all fields in a route node.
76 #define ROUTE_NODE_FIELDS \
77 /* Actual prefix of this radix. */ \
81 struct route_table *table; \
82 struct route_node *parent; \
83 struct route_node *link[2]; \
85 /* Lock of this radix */ \
88 /* Each node of route. */ \
95 /* Each routing entry. */
100 #define l_left link[0]
101 #define l_right link[1]
104 typedef struct route_table_iter_t_ route_table_iter_t
;
109 RT_ITER_STATE_ITERATING
,
110 RT_ITER_STATE_PAUSED
,
112 } route_table_iter_state_t
;
117 * Structure that holds state for iterating over a route table.
119 struct route_table_iter_t_
122 route_table_iter_state_t state
;
125 * Routing table that we are iterating over. The caller must ensure
126 * that that table outlives the iterator.
128 struct route_table
*table
;
131 * The node that the iterator is currently on.
133 struct route_node
*current
;
136 * The last prefix that the iterator processed before it was paused.
138 struct prefix pause_prefix
;
142 extern struct route_table
*route_table_init (void);
144 extern struct route_table
*
145 route_table_init_with_delegate (route_table_delegate_t
*);
147 extern void route_table_finish (struct route_table
*);
148 extern void route_unlock_node (struct route_node
*node
);
149 extern struct route_node
*route_top (struct route_table
*);
150 extern struct route_node
*route_next (struct route_node
*);
151 extern struct route_node
*route_next_until (struct route_node
*,
152 struct route_node
*);
153 extern struct route_node
*route_node_get (struct route_table
*const,
154 const struct prefix
*);
155 extern struct route_node
*route_node_lookup (const struct route_table
*,
156 const struct prefix
*);
157 extern struct route_node
*route_lock_node (struct route_node
*node
);
158 extern struct route_node
*route_node_match (const struct route_table
*,
159 const struct prefix
*);
160 extern struct route_node
*route_node_match_ipv4 (const struct route_table
*,
161 const struct in_addr
*);
163 extern struct route_node
*route_node_match_ipv6 (const struct route_table
*,
164 const struct in6_addr
*);
165 #endif /* HAVE_IPV6 */
167 extern unsigned long route_table_count (const struct route_table
*);
169 extern struct route_node
*
170 route_table_get_next (const struct route_table
*table
, struct prefix
*p
);
172 route_table_prefix_iter_cmp (struct prefix
*p1
, struct prefix
*p2
);
175 * Iterator functions.
177 extern void route_table_iter_init (route_table_iter_t
*iter
,
178 struct route_table
*table
);
179 extern void route_table_iter_pause (route_table_iter_t
*iter
);
180 extern void route_table_iter_cleanup (route_table_iter_t
*iter
);
187 * route_table_iter_next
189 * Get the next node in the tree.
191 static inline struct route_node
*
192 route_table_iter_next (route_table_iter_t
* iter
)
194 struct route_node
*node
;
199 case RT_ITER_STATE_INIT
:
202 * We're just starting the iteration.
204 node
= route_top (iter
->table
);
207 case RT_ITER_STATE_ITERATING
:
208 node
= route_next (iter
->current
);
211 case RT_ITER_STATE_PAUSED
:
214 * Start with the node following pause_prefix.
216 node
= route_table_get_next (iter
->table
, &iter
->pause_prefix
);
219 case RT_ITER_STATE_DONE
:
226 iter
->current
= node
;
228 iter
->state
= RT_ITER_STATE_ITERATING
;
230 iter
->state
= RT_ITER_STATE_DONE
;
236 * route_table_iter_is_done
238 * Returns TRUE if the iteration is complete.
241 route_table_iter_is_done (route_table_iter_t
*iter
)
243 return iter
->state
== RT_ITER_STATE_DONE
;
247 * route_table_iter_started
249 * Returns TRUE if this iterator has started iterating over the tree.
252 route_table_iter_started (route_table_iter_t
*iter
)
254 return iter
->state
!= RT_ITER_STATE_INIT
;
257 #endif /* _ZEBRA_TABLE_H */