]>
git.ipfire.org Git - thirdparty/bird.git/blob - nest/route.h
2 * BIRD Internet Routing Daemon -- Routing Table
4 * (c) 1998--2000 Martin Mares <mj@ucw.cz>
6 * Can be freely distributed and used under the terms of the GNU GPL.
10 #define _BIRD_ROUTE_H_
12 #include "lib/lists.h"
13 #include "lib/resource.h"
14 #include "lib/timer.h"
23 * Generic data structure for storing network prefixes. Also used
24 * for the master routing table. Currently implemented as a hash
27 * Available operations:
28 * - insertion of new entry
30 * - searching for entry by network prefix
31 * - asynchronous retrieval of fib contents
35 struct fib_node
*next
; /* Next in hash chain */
36 struct fib_iterator
*readers
; /* List of readers of this node */
38 byte flags
; /* User-defined */
39 byte x0
, x1
; /* User-defined */
40 u32 uid
; /* Unique ID based on hash */
41 ip_addr prefix
; /* In host order */
44 struct fib_iterator
{ /* See lib/slists.h for an explanation */
45 struct fib_iterator
*prev
, *next
; /* Must be synced with struct fib_node! */
46 byte efef
; /* 0xff to distinguish between iterator and node */
48 struct fib_node
*node
; /* Or NULL if freshly merged */
52 typedef void (*fib_init_func
)(struct fib_node
*);
55 pool
*fib_pool
; /* Pool holding all our data */
56 slab
*fib_slab
; /* Slab holding all fib nodes */
57 struct fib_node
**hash_table
; /* Node hash table */
58 unsigned int hash_size
; /* Number of hash table entries (a power of two) */
59 unsigned int hash_order
; /* Binary logarithm of hash_size */
60 unsigned int hash_shift
; /* 16 - hash_log */
61 unsigned int entries
; /* Number of entries */
62 unsigned int entries_min
, entries_max
;/* Entry count limits (else start rehashing) */
63 fib_init_func init
; /* Constructor */
66 void fib_init(struct fib
*, pool
*, unsigned node_size
, unsigned hash_order
, fib_init_func init
);
67 void *fib_find(struct fib
*, ip_addr
*, int); /* Find or return NULL if doesn't exist */
68 void *fib_get(struct fib
*, ip_addr
*, int); /* Find or create new if nonexistent */
69 void *fib_route(struct fib
*, ip_addr
, int); /* Longest-match routing lookup */
70 void fib_delete(struct fib
*, void *); /* Remove fib entry */
71 void fib_free(struct fib
*); /* Destroy the fib */
72 void fib_check(struct fib
*); /* Consistency check for debugging */
74 void fit_init(struct fib_iterator
*, struct fib
*); /* Internal functions, don't call */
75 struct fib_node
*fit_get(struct fib
*, struct fib_iterator
*);
76 void fit_put(struct fib_iterator
*, struct fib_node
*);
78 #define FIB_WALK(fib, z) do { \
79 struct fib_node *z, **ff = (fib)->hash_table; \
80 unsigned int count = (fib)->hash_size; \
82 for(z = *ff++; z; z=z->next)
84 #define FIB_WALK_END } while (0)
86 #define FIB_ITERATE_INIT(it, fib) fit_init(it, fib)
88 #define FIB_ITERATE_START(fib, it, z) do { \
89 struct fib_node *z = fit_get(fib, it); \
90 unsigned int count = (fib)->hash_size; \
91 unsigned int hpos = (it)->hash; \
95 if (++hpos >= count) \
97 z = (fib)->hash_table[hpos]; \
101 #define FIB_ITERATE_END(z) z = z->next; } } while(0)
103 #define FIB_ITERATE_PUT(it, z) fit_put(it, z)
106 * Master Routing Tables. Generally speaking, each of them contains a FIB
107 * with each entry pointing to a list of route entries representing routes
108 * to given network (with the selected one at the head).
110 * Each of the RTE's contains variable data (the preference and protocol-dependent
111 * metrics) and a pointer to a route attribute block common for many routes).
113 * It's guaranteed that there is at most one RTE for every (prefix,proto) pair.
116 struct rtable_config
{
119 struct rtable
*table
;
120 struct proto_config
*krt_attached
; /* Kernel syncer attached to this table */
121 int gc_max_ops
; /* Maximum number of operations before GC is run */
122 int gc_min_time
; /* Minimum time between two consecutive GC runs */
125 typedef struct rtable
{
126 node n
; /* Node in list of all tables */
128 char *name
; /* Name of this table */
129 list hooks
; /* List of announcement hooks */
130 int pipe_busy
; /* Pipe loop detection */
131 int use_count
; /* Number of protocols using this table */
132 struct hostcache
*hostcache
;
133 struct rtable_config
*config
; /* Configuration of this table */
134 struct config
*deleted
; /* Table doesn't exist in current configuration,
135 * delete as soon as use_count becomes 0 and remove
136 * obstacle from this routing table.
138 struct event
*rt_event
; /* Routing table event */
139 int gc_counter
; /* Number of operations since last GC */
140 bird_clock_t gc_time
; /* Time of last GC */
141 byte gc_scheduled
; /* GC is scheduled */
142 byte prune_state
; /* Table prune state, 1 -> prune is running */
143 byte hcu_scheduled
; /* Hostcache update is scheduled */
144 byte nhu_state
; /* Next Hop Update state */
145 struct fib_iterator prune_fit
; /* Rtable prune FIB iterator */
146 struct fib_iterator nhu_fit
; /* Next Hop Update FIB iterator */
149 typedef struct network
{
150 struct fib_node n
; /* FIB flags reserved for kernel syncer */
151 struct rte
*routes
; /* Available routes for this network */
155 slab
*slab
; /* Slab holding all hostentries */
156 struct hostentry
**hash_table
; /* Hash table for hostentries */
157 unsigned hash_order
, hash_shift
;
158 unsigned hash_max
, hash_min
;
160 linpool
*lp
; /* Linpool for trie */
161 struct f_trie
*trie
; /* Trie of prefixes that might affect hostentries */
162 list hostentries
; /* List of all hostentries */
163 byte update_hostcache
;
168 ip_addr addr
; /* IP address of host, part of key */
169 ip_addr link
; /* (link-local) IP address of host, used as gw
170 if host is directly attached */
171 struct rtable
*tab
; /* Dependent table, part of key*/
172 struct hostentry
*next
; /* Next in hash chain */
173 unsigned hash_key
; /* Hash key */
174 unsigned uc
; /* Use count */
175 struct rta
*src
; /* Source rta entry */
176 ip_addr gw
; /* Chosen next hop */
177 byte dest
; /* Chosen route destination type (RTD_...) */
178 u32 igp_metric
; /* Chosen route IGP metric */
183 net
*net
; /* Network this RTE belongs to */
184 struct proto
*sender
; /* Protocol instance that sent the route to the routing table */
185 struct rta
*attrs
; /* Attributes of this route */
186 byte flags
; /* Flags (REF_...) */
187 byte pflags
; /* Protocol-specific flags */
188 word pref
; /* Route preference */
189 bird_clock_t lastmod
; /* Last modified */
190 union { /* Protocol-dependent data (metrics etc.) */
193 node garbage
; /* List for garbage collection */
194 byte metric
; /* RIP metric */
195 u16 tag
; /* External route tag */
196 struct rip_entry
*entry
;
201 u32 metric1
, metric2
; /* OSPF Type 1 and Type 2 metrics */
202 u32 tag
; /* External route tag */
203 u32 router_id
; /* Router that originated this route */
208 u8 suppressed
; /* Used for deterministic MED comparison */
211 struct { /* Routes generated by krt sync (both temporary and inherited ones) */
212 s8 src
; /* Alleged route source (see krt.h) */
213 u8 proto
; /* Kernel source protocol ID */
214 u8 type
; /* Kernel route type */
215 u8 seen
; /* Seen during last scan */
216 u32 metric
; /* Kernel metric */
221 #define REF_COW 1 /* Copy this rte on write */
223 /* Types of route announcement, also used as flags */
224 #define RA_OPTIMAL 1 /* Announcement of optimal route change */
225 #define RA_ANY 2 /* Announcement of any route change */
230 void rt_preconfig(struct config
*);
231 void rt_commit(struct config
*new, struct config
*old
);
232 void rt_lock_table(rtable
*);
233 void rt_unlock_table(rtable
*);
234 void rt_setup(pool
*, rtable
*, char *, struct rtable_config
*);
235 static inline net
*net_find(rtable
*tab
, ip_addr addr
, unsigned len
) { return (net
*) fib_find(&tab
->fib
, &addr
, len
); }
236 static inline net
*net_get(rtable
*tab
, ip_addr addr
, unsigned len
) { return (net
*) fib_get(&tab
->fib
, &addr
, len
); }
237 rte
*rte_find(net
*net
, struct proto
*p
);
238 rte
*rte_get_temp(struct rta
*);
239 void rte_update(rtable
*tab
, net
*net
, struct proto
*p
, struct proto
*src
, rte
*new);
240 void rte_discard(rtable
*tab
, rte
*old
);
241 void rte_dump(rte
*);
242 void rte_free(rte
*);
243 rte
*rte_do_cow(rte
*);
244 static inline rte
* rte_cow(rte
*r
) { return (r
->flags
& REF_COW
) ? rte_do_cow(r
) : r
; }
245 void rt_dump(rtable
*);
246 void rt_dump_all(void);
247 int rt_feed_baby(struct proto
*p
);
248 void rt_feed_baby_abort(struct proto
*p
);
249 void rt_schedule_prune_all(void);
250 int rt_prune_loop(void);
251 struct rtable_config
*rt_new_table(struct symbol
*s
);
253 struct rt_show_data
{
257 struct filter
*filter
;
259 struct fib_iterator fit
;
260 struct proto
*show_protocol
;
261 struct proto
*export_protocol
;
262 int export_mode
, primary_only
;
263 struct config
*running_on_config
;
264 int net_counter
, rt_counter
, show_counter
;
267 void rt_show(struct rt_show_data
*);
272 * Beware: All standard BGP attributes must be represented here instead
273 * of making them local to the route. This is needed to ensure proper
274 * construction of BGP route attribute lists.
277 /* Multipath next-hop */
279 ip_addr gw
; /* Next hop */
280 struct iface
*iface
; /* Outgoing interface */
282 unsigned char weight
;
286 struct rta
*next
, **pprev
; /* Hash chain */
287 struct proto
*proto
; /* Protocol instance that originally created the route */
288 unsigned uc
; /* Use count */
289 byte source
; /* Route source (RTS_...) */
290 byte scope
; /* Route scope (SCOPE_... -- see ip.h) */
291 byte cast
; /* Casting type (RTC_...) */
292 byte dest
; /* Route destination type (RTD_...) */
293 byte flags
; /* Route flags (RTF_...), now unused */
294 byte aflags
; /* Attribute cache flags (RTAF_...) */
295 u16 hash_key
; /* Hash over important fields */
296 u32 igp_metric
; /* IGP metric to next hop (for iBGP routes) */
297 ip_addr gw
; /* Next hop */
298 ip_addr from
; /* Advertising router */
299 struct hostentry
*hostentry
; /* Hostentry for recursive next-hops */
300 struct iface
*iface
; /* Outgoing interface */
301 struct mpnh
*nexthops
; /* Next-hops for multipath routes */
302 struct ea_list
*eattrs
; /* Extended Attribute chain */
305 #define RTS_DUMMY 0 /* Dummy route to be removed soon */
306 #define RTS_STATIC 1 /* Normal static route */
307 #define RTS_INHERIT 2 /* Route inherited from kernel */
308 #define RTS_DEVICE 3 /* Device route */
309 #define RTS_STATIC_DEVICE 4 /* Static device route */
310 #define RTS_REDIRECT 5 /* Learned via redirect */
311 #define RTS_RIP 6 /* RIP route */
312 #define RTS_OSPF 7 /* OSPF route */
313 #define RTS_OSPF_IA 8 /* OSPF inter-area route */
314 #define RTS_OSPF_EXT1 9 /* OSPF external route type 1 */
315 #define RTS_OSPF_EXT2 10 /* OSPF external route type 2 */
316 #define RTS_BGP 11 /* BGP route */
317 #define RTS_PIPE 12 /* Inter-table wormhole */
319 #define RTC_UNICAST 0
320 #define RTC_BROADCAST 1
321 #define RTC_MULTICAST 2
322 #define RTC_ANYCAST 3 /* IPv6 Anycast */
324 #define RTD_ROUTER 0 /* Next hop is neighbor router */
325 #define RTD_DEVICE 1 /* Points to device */
326 #define RTD_BLACKHOLE 2 /* Silently drop packets */
327 #define RTD_UNREACHABLE 3 /* Reject as unreachable */
328 #define RTD_PROHIBIT 4 /* Administratively prohibited */
329 #define RTD_MULTIPATH 5 /* Multipath route (nexthops != NULL) */
330 #define RTD_NONE 6 /* Invalid RTD */
332 /* Flags for net->n.flags, used by kernel syncer */
333 #define KRF_INSTALLED 0x80 /* This route should be installed in the kernel */
334 #define KRF_SYNC_ERROR 0x40 /* Error during kernel table synchronization */
336 #define RTAF_CACHED 1 /* This is a cached rta */
338 #define IGP_METRIC_UNKNOWN 0x80000000 /* Default igp_metric used when no other
339 protocol-specific metric is availabe */
342 * Extended Route Attributes
345 typedef struct eattr
{
346 word id
; /* EA_CODE(EAP_..., protocol-dependent ID) */
347 byte flags
; /* Protocol-dependent flags */
348 byte type
; /* Attribute type and several flags (EAF_...) */
351 struct adata
*ptr
; /* Attribute data elsewhere */
355 #define EAP_GENERIC 0 /* Generic attributes */
356 #define EAP_BGP 1 /* BGP attributes */
357 #define EAP_RIP 2 /* RIP */
358 #define EAP_OSPF 3 /* OSPF */
359 #define EAP_KRT 4 /* Kernel route attributes */
362 #define EA_CODE(proto,id) (((proto) << 8) | (id))
363 #define EA_PROTO(ea) ((ea) >> 8)
364 #define EA_ID(ea) ((ea) & 0xff)
366 #define EA_GEN_IGP_METRIC EA_CODE(EAP_GENERIC, 0)
368 #define EA_CODE_MASK 0xffff
369 #define EA_ALLOW_UNDEF 0x10000 /* ea_find: allow EAF_TYPE_UNDEF */
371 #define EAF_TYPE_MASK 0x0f /* Mask with this to get type */
372 #define EAF_TYPE_INT 0x01 /* 32-bit signed integer number */
373 #define EAF_TYPE_OPAQUE 0x02 /* Opaque byte string (not filterable) */
374 #define EAF_TYPE_IP_ADDRESS 0x04 /* IP address */
375 #define EAF_TYPE_ROUTER_ID 0x05 /* Router ID (IPv4 address) */
376 #define EAF_TYPE_AS_PATH 0x06 /* BGP AS path (encoding per RFC 1771:4.3) */
377 #define EAF_TYPE_INT_SET 0x0a /* Set of u32's (e.g., a community list) */
378 #define EAF_TYPE_EC_SET 0x0e /* Set of pairs of u32's - ext. community list */
379 #define EAF_TYPE_UNDEF 0x0f /* `force undefined' entry */
380 #define EAF_EMBEDDED 0x01 /* Data stored in eattr.u.data (part of type spec) */
381 #define EAF_VAR_LENGTH 0x02 /* Attribute length is variable (part of type spec) */
382 #define EAF_ORIGINATED 0x40 /* The attribute has originated locally */
383 #define EAF_TEMP 0x80 /* A temporary attribute (the one stored in the tmp attr list) */
386 unsigned int length
; /* Length of data */
390 typedef struct ea_list
{
391 struct ea_list
*next
; /* In case we have an override list */
392 byte flags
; /* Flags: EALF_... */
394 word count
; /* Number of attributes */
395 eattr attrs
[0]; /* Attribute definitions themselves */
398 #define EALF_SORTED 1 /* Attributes are sorted by code */
399 #define EALF_BISECT 2 /* Use interval bisection for searching */
400 #define EALF_CACHED 4 /* Attributes belonging to cached rta */
402 eattr
*ea_find(ea_list
*, unsigned ea
);
403 int ea_get_int(ea_list
*, unsigned ea
, int def
);
404 void ea_dump(ea_list
*);
405 void ea_sort(ea_list
*); /* Sort entries in all sub-lists */
406 unsigned ea_scan(ea_list
*); /* How many bytes do we need for merged ea_list */
407 void ea_merge(ea_list
*from
, ea_list
*to
); /* Merge sub-lists to allocated buffer */
408 int ea_same(ea_list
*x
, ea_list
*y
); /* Test whether two ea_lists are identical */
409 unsigned int ea_hash(ea_list
*e
); /* Calculate 16-bit hash value */
410 ea_list
*ea_append(ea_list
*to
, ea_list
*what
);
412 int mpnh__same(struct mpnh
*x
, struct mpnh
*y
); /* Compare multipath nexthops */
413 static inline int mpnh_same(struct mpnh
*x
, struct mpnh
*y
)
414 { return (x
== y
) || mpnh__same(x
, y
); }
417 rta
*rta_lookup(rta
*); /* Get rta equivalent to this one, uc++ */
418 static inline rta
*rta_clone(rta
*r
) { r
->uc
++; return r
; }
419 void rta__free(rta
*r
);
420 static inline void rta_free(rta
*r
) { if (r
&& !--r
->uc
) rta__free(r
); }
421 void rta_dump(rta
*);
422 void rta_dump_all(void);
423 void rta_show(struct cli
*, rta
*, ea_list
*);
424 void rta_set_recursive_next_hop(rtable
*dep
, rta
*a
, rtable
*tab
, ip_addr
*gw
, ip_addr
*ll
);
427 * rta_set_recursive_next_hop() acquires hostentry from hostcache and
428 * fills rta->hostentry field. New hostentry has zero use
429 * count. Cached rta locks its hostentry (increases its use count),
430 * uncached rta does not lock it. Hostentry with zero use count is
431 * removed asynchronously during host cache update, therefore it is
432 * safe to hold such hostentry temorarily. Hostentry holds a lock for
433 * a 'source' rta, mainly to share multipath nexthops. There is no
434 * need to hold a lock for hostentry->dep table, because that table
435 * contains routes responsible for that hostentry, and therefore is
436 * non-empty if given hostentry has non-zero use count. The protocol
437 * responsible for routes with recursive next hops should also hold a
438 * lock for a table governing that routes (argument tab to
439 * rta_set_recursive_next_hop()).
442 static inline void rt_lock_hostentry(struct hostentry
*he
) { if (he
) he
->uc
++; }
443 static inline void rt_unlock_hostentry(struct hostentry
*he
) { if (he
) he
->uc
--; }
446 extern struct protocol
*attr_class_to_protocol
[EAP_MAX
];
449 * Default protocol preferences
452 #define DEF_PREF_DIRECT 240 /* Directly connected */
453 #define DEF_PREF_STATIC 200 /* Static route */
454 #define DEF_PREF_OSPF 150 /* OSPF intra-area, inter-area and type 1 external routes */
455 #define DEF_PREF_RIP 120 /* RIP */
456 #define DEF_PREF_BGP 100 /* BGP */
457 #define DEF_PREF_PIPE 70 /* Routes piped from other tables */
458 #define DEF_PREF_INHERITED 10 /* Routes inherited from other routing daemons */
462 * Route Origin Authorization
469 struct roa_item
*next
;
474 struct roa_item
*items
;
479 node n
; /* Node in roa_table_list */
481 char *name
; /* Name of this ROA table */
482 struct roa_table_config
*cf
; /* Configuration of this ROA table */
485 struct roa_item_config
{
489 struct roa_item_config
*next
;
492 struct roa_table_config
{
493 node n
; /* Node in config->rpa_tables */
494 char *name
; /* Name of this ROA table */
495 struct roa_table
*table
;
497 struct roa_item_config
*roa_items
; /* Preconfigured ROA items */
500 // int gc_max_ops; /* Maximum number of operations before GC is run */
501 // int gc_min_time; /* Minimum time between two consecutive GC runs */
504 struct roa_show_data
{
505 struct fib_iterator fit
;
506 struct roa_table
*table
;
509 byte mode
; /* ROA_SHOW_* values */
510 u32 asn
; /* Filter ASN, 0 -> all */
513 #define ROA_UNKNOWN 0
515 #define ROA_INVALID 2
517 #define ROA_SRC_ANY 0
518 #define ROA_SRC_CONFIG 1
519 #define ROA_SRC_DYNAMIC 2
521 #define ROA_SHOW_ALL 0
522 #define ROA_SHOW_PX 1
523 #define ROA_SHOW_IN 2
524 #define ROA_SHOW_FOR 3
526 extern struct roa_table
*roa_table_default
;
528 void roa_add_item(struct roa_table
*t
, ip_addr prefix
, byte pxlen
, byte maxlen
, u32 asn
, byte src
);
529 void roa_delete_item(struct roa_table
*t
, ip_addr prefix
, byte pxlen
, byte maxlen
, u32 asn
, byte src
);
530 void roa_flush(struct roa_table
*t
, byte src
);
531 byte
roa_check(struct roa_table
*t
, ip_addr prefix
, byte pxlen
, u32 asn
);
532 struct roa_table_config
* roa_new_table_config(struct symbol
*s
);
533 void roa_add_item_config(struct roa_table_config
*rtc
, ip_addr prefix
, byte pxlen
, byte maxlen
, u32 asn
);
535 void roa_preconfig(struct config
*c
);
536 void roa_commit(struct config
*new, struct config
*old
);
537 void roa_show(struct roa_show_data
*d
);