bird/nest/route.h

291 lines
9.4 KiB
C
Raw Normal View History

/*
* BIRD Internet Routing Daemon -- Routing Table
*
* (c) 1998 Martin Mares <mj@ucw.cz>
*
* Can be freely distributed and used under the terms of the GNU GPL.
*/
#ifndef _BIRD_ROUTE_H_
#define _BIRD_ROUTE_H_
#include "lib/resource.h"
#include "lib/timer.h"
struct protocol;
struct proto;
/*
* Generic data structure for storing network prefixes. Also used
* for the master routing table. Currently implemented as a hash
* table.
*
* Available operations:
* - insertion of new entry
* - deletion of entry
* - searching for entry by network prefix
* - asynchronous retrieval of fib contents
*/
struct fib_node {
struct fib_node *next; /* Next in hash chain */
struct fib_iterator *readers; /* List of readers of this node */
byte pxlen;
byte flags; /* User-defined */
byte x0, x1; /* User-defined */
ip_addr prefix; /* In host order */
};
struct fib_iterator { /* See lib/slists.h for an explanation */
struct fib_iterator *prev, *next; /* Must be synced with struct fib_node! */
struct fib_node *node; /* Or NULL if freshly merged */
byte efef; /* 0xff to distinguish between iterator and node */
byte pad[3];
unsigned int hash;
};
struct fib {
pool *fib_pool; /* Pool holding all our data */
slab *fib_slab; /* Slab holding all fib nodes */
struct fib_node **hash_table; /* Node hash table */
1998-05-04 00:42:45 +08:00
unsigned int hash_size; /* Number of hash table entries (a power of two) */
unsigned int hash_order; /* Binary logarithm of hash_size */
unsigned int hash_shift; /* 16 - hash_log */
1998-05-04 00:42:45 +08:00
unsigned int entries; /* Number of entries */
unsigned int entries_min, entries_max;/* Entry count limits (else start rehashing) */
void (*init)(struct fib_node *); /* Constructor */
};
void fib_init(struct fib *, pool *, unsigned node_size, unsigned hash_order, void (*init)(struct fib_node *));
void *fib_find(struct fib *, ip_addr *, int); /* Find or return NULL if doesn't exist */
void *fib_get(struct fib *, ip_addr *, int); /* Find or create new if nonexistent */
void fib_delete(struct fib *, void *); /* Remove fib entry */
1998-05-04 00:42:45 +08:00
void fib_free(struct fib *); /* Destroy the fib */
void fib_check(struct fib *); /* Consistency check for debugging */
void fit_init(struct fib_iterator *, struct fib *); /* Internal functions, don't call */
struct fib_node *fit_get(struct fib *, struct fib_iterator *);
void fit_put(struct fib_iterator *, struct fib_node *);
1998-05-04 00:42:45 +08:00
#define FIB_WALK(fib, z) do { \
struct fib_node *z, **ff = (fib)->hash_table; \
1998-05-04 00:42:45 +08:00
unsigned int count = (fib)->hash_size; \
while (count--) \
for(z = *ff++; z; z=z->next)
#define FIB_WALK_END } while (0)
1998-05-04 00:42:45 +08:00
#define FIB_ITERATE_INIT(it, fib) fit_init(it, fib)
#define FIB_ITERATE_START(fib, it, z) do { \
struct fib_node *z = fit_get(fib, it); \
unsigned int count = (fib)->hash_size; \
unsigned int hpos = (it)->hash; \
for(;;) { \
again: if (!z) { \
if (++hpos >= count) \
break; \
z = (fib)->hash_table[hpos]; \
goto again; \
}
#define FIB_ITERATE_END z = z->next; } } while(0)
#define FIB_ITERATE_PUT(it, z) fit_put(it, z)
/*
* Master Routing Tables. Generally speaking, each of them is a list
* of FIB (one per TOS) with each entry pointing to a list of route entries
* representing routes to given network.
* Each of the RTE's contains variable data (the preference and protocol-dependent
* metrics) and a pointer to a route attribute block common for many routes).
* It's guaranteed that there is at most one RTE for every (prefix,proto,source) triplet.
*/
typedef struct rtable {
struct rtable *sibling; /* Our sibling for different TOS */
byte tos; /* TOS for this table */
struct fib fib;
char *name; /* Name of this table */
} rtable;
typedef struct network {
struct fib_node n; /* FIB flags reserved for kernel syncer */
struct rte *routes; /* Available routes for this network */
} net;
typedef struct rte {
struct rte *next;
net *net; /* Network this RTE belongs to */
struct rtattr *attrs; /* Attributes of this route */
byte flags; /* Flags (REF_...) */
1998-04-23 16:09:39 +08:00
byte pflags; /* Protocol-specific flags */
word pref; /* Route preference */
bird_clock_t lastmod; /* Last modified */
union { /* Protocol-dependent data (metrics etc.) */
#ifdef CONFIG_RIP
struct {
1998-10-21 00:12:43 +08:00
node garbage; /* List for garbage collection */
byte metric; /* RIP metric */
1998-04-23 16:09:39 +08:00
u16 tag; /* External route tag */
} rip;
#endif
#ifdef CONFIG_OSPF
struct {
u32 metric1, metric2; /* OSPF Type 1 and Type 2 metrics */
1998-04-23 16:09:39 +08:00
u32 tag; /* External route tag */
} ospf;
#endif
#ifdef CONFIG_BGP
struct {
} bgp;
#endif
} u;
} rte;
#define REF_CHOSEN 1 /* Currently chosen route */
extern rtable master_table;
void rt_init(void);
void rt_setup(rtable *, char *);
net *net_find(rtable *tab, unsigned tos, ip_addr addr, unsigned len);
net *net_get(rtable *tab, unsigned tos, ip_addr addr, unsigned len);
rte *rte_find(net *net, struct proto *p);
rte *rte_get_temp(struct rtattr *);
void rte_update(net *net, struct proto *p, rte *new);
void rte_discard(rte *old);
void rte_dump(rte *);
void rte_free(rte *);
void rt_dump(rtable *);
void rt_dump_all(void);
void rt_feed_baby(struct proto *p);
/*
* Route Attributes
*
* Beware: All standard BGP attributes must be represented here instead
* of making them local to the route. This is needed to ensure proper
* construction of BGP route attribute lists.
*/
typedef struct rtattr {
struct rtattr *next, *prev; /* Hash chain */
struct rtattr *garbage; /* Garbage collector chain */
struct proto *proto; /* Protocol instance */
unsigned uc; /* Use count */
byte source; /* Route source (RTS_...) */
1998-05-04 00:42:45 +08:00
byte scope; /* Route scope (SCOPE_... -- see ip.h) */
byte cast; /* Casting type (RTC_...) */
byte dest; /* Route destination type (RTD_...) */
byte tos; /* TOS of this route */
byte flags; /* Route flags (RTF_...) */
byte aflags; /* Attribute cache flags (RTAF_...) */
ip_addr gw; /* Next hop */
1998-05-04 00:42:45 +08:00
ip_addr from; /* Advertising router */
struct iface *iface; /* Outgoing interface */
struct ea_list *attrs; /* Extended Attribute chain */
1998-05-04 00:42:45 +08:00
union { /* Protocol-specific data */
} u;
} rta;
#define RTS_DUMMY 0 /* Dummy route to be removed soon */
#define RTS_STATIC 1 /* Normal static route */
#define RTS_INHERIT 2 /* Route inherited from kernel */
#define RTS_DEVICE 3 /* Device route */
#define RTS_STATIC_DEVICE 4 /* Static device route */
#define RTS_REDIRECT 5 /* Learned via redirect */
#define RTS_RIP 6 /* RIP route */
#define RTS_RIP_EXT 7 /* RIP external route */
#define RTS_OSPF 8 /* OSPF route */
#define RTS_OSPF_EXT 9 /* OSPF external route */
#define RTS_OSPF_IA 10 /* OSPF inter-area route */
1998-04-23 16:09:39 +08:00
#define RTS_OSPF_BOUNDARY 11 /* OSPF route to boundary router (???) */
#define RTS_BGP 12 /* BGP route */
#define RTC_UNICAST 0
#define RTC_BROADCAST 1
#define RTC_MULTICAST 2
#define RTC_ANYCAST 3 /* IPv6 Anycast */
#define RTD_ROUTER 0 /* Next hop is neighbor router */
#define RTD_DEVICE 1 /* Points to device */
#define RTD_BLACKHOLE 2 /* Silently drop packets */
#define RTD_UNREACHABLE 3 /* Reject as unreachable */
#define RTD_PROHIBIT 4 /* Administratively prohibited */
1998-04-23 16:09:39 +08:00
#define RTF_EXTERIOR 1 /* Learned via exterior protocol */
1998-05-04 00:42:45 +08:00
#define RTF_TAGGED 2 /* Tagged external route learned via IGP */
1998-04-23 16:09:39 +08:00
#define RTAF_CACHED 1 /* This is a cached rta */
/*
* Extended Route Attributes
*/
typedef struct eattr {
byte protocol; /* Protocol ID (EAP_...) */
byte flags; /* Attribute flags (EAF_...) */
byte id; /* Protocol-dependent ID */
1998-05-04 00:42:45 +08:00
byte rfu; /* ??? */
union {
u32 data;
struct adata *ptr; /* Attribute data elsewhere */
} u;
} eattr;
#define EAP_GENERIC 0 /* Generic attributes */
#define EAP_BGP 1 /* BGP attributes */
#define EAF_OPTIONAL 0x80 /* Refer to BGP specs for full meaning */
#define EAF_TRANSITIVE 0x40
#define EAF_PARTIAL 0x20
#define EAF_EXTENDED_LENGTH 0x10 /* Not used by us, internal to BGP */
#define EAF_LONGWORD 0x01 /* Embedded value [Not a BGP flag!] */
struct adata {
unsigned int length;
byte data[0];
};
typedef struct ea_list {
struct ea_list *next; /* In case we have an override list */
1998-05-04 00:42:45 +08:00
byte sorted; /* `Really sorted' flag (???) */
byte rfu;
word nattrs; /* Number of attributes */
eattr attrs[0]; /* Attribute definitions themselves */
} ea_list;
eattr *ea_find(ea_list *, unsigned protocol, unsigned id);
#define EA_LIST_NEW(p, alloc, n) do { \
unsigned cnt = n; \
p = alloc(sizeof(ea_list) + cnt*sizeof(eattr)); \
1998-05-04 00:42:45 +08:00
memset(p, 0, sizeof(ea_list)); \
p->nattrs = cnt; \
} while(0)
void rta_init(void);
rta *rta_lookup(rta *); /* Get rta equivalent to this one, uc++ */
static inline rta *rta_clone(rta *r) { r->uc++; return r; }
void _rta_free(rta *r);
static inline void rta_free(rta *r) { if (r && !--r->uc) _rta_free(r); }
void rta_dump(rta *);
void rta_dump_all(void);
1998-05-04 00:42:45 +08:00
/*
* Default protocol preferences
*/
#define DEF_PREF_DIRECT 240 /* Directly connected */
#define DEF_PREF_STATIC 200 /* Static route */
#define DEF_PREF_OSPF_INTERNAL 150 /* OSPF intra-area, inter-area and type 1 external routes */
#define DEF_PREF_RIP 120 /* RIP */
#define DEF_PREF_BGP 100 /* BGP */
#define DEF_PREF_OSPF_EXTERNAL 80 /* OSPF external routes */
#define DEF_PREF_RIP_EXTERNAL 70 /* RIP external routes */
#define DEF_PREF_UKR 50 /* Unidentified Kernel Route */
1998-05-04 00:42:45 +08:00
#define DEF_PREF_SINK 10 /* Sink route */
#endif