route.h 24 KB
Newer Older
1 2 3
/*
 *	BIRD Internet Routing Daemon -- Routing Table
 *
4
 *	(c) 1998--2000 Martin Mares <mj@ucw.cz>
5 6 7 8 9 10 11
 *
 *	Can be freely distributed and used under the terms of the GNU GPL.
 */

#ifndef _BIRD_ROUTE_H_
#define _BIRD_ROUTE_H_

12
#include "lib/lists.h"
13
#include "lib/resource.h"
14
#include "sysdep/unix/timer.h"
15
#include "lib/net.h"
16

17
struct ea_list;
18
struct protocol;
19
struct proto;
20
struct rte_src;
21 22 23
struct symbol;
struct filter;
struct cli;
24

25 26
/*
 *	Generic data structure for storing network prefixes. Also used
27
 *	for the master routing table. Currently implemented as a hash
28
 *	table.
29 30 31 32
 *
 *	Available operations:
 *		- insertion of new entry
 *		- deletion of entry
33
 *		- searching for entry by network prefix
34
 *		- asynchronous retrieval of fib contents
35 36 37
 */

struct fib_node {
38 39
  struct fib_node *next;		/* Next in hash chain */
  struct fib_iterator *readers;		/* List of readers of this node */
40 41
  byte flags;				/* User-defined, will be removed */
  net_addr addr[0];
42 43 44 45 46 47
};

struct fib_iterator {			/* See lib/slists.h for an explanation */
  struct fib_iterator *prev, *next;	/* Must be synced with struct fib_node! */
  byte efef;				/* 0xff to distinguish between iterator and node */
  byte pad[3];
48
  struct fib_node *node;		/* Or NULL if freshly merged */
Pavel Tvrdík's avatar
Pavel Tvrdík committed
49
  uint hash;
50 51
};

52
typedef void (*fib_init_fn)(void *);
Martin Mareš's avatar
Martin Mareš committed
53

54
struct fib {
55 56 57
  pool *fib_pool;			/* Pool holding all our data */
  slab *fib_slab;			/* Slab holding all fib nodes */
  struct fib_node **hash_table;		/* Node hash table */
Pavel Tvrdík's avatar
Pavel Tvrdík committed
58 59
  uint hash_size;			/* Number of hash table entries (a power of two) */
  uint hash_order;			/* Binary logarithm of hash_size */
60
  uint hash_shift;			/* 32 - hash_order */
61
  uint addr_type;			/* Type of address data stored in fib (NET_*) */
62 63
  uint node_size;			/* FIB node size, 0 for nonuniform */
  uint node_offset;			/* Offset of fib_node struct inside of user data */
Pavel Tvrdík's avatar
Pavel Tvrdík committed
64 65
  uint entries;				/* Number of entries */
  uint entries_min, entries_max;	/* Entry count limits (else start rehashing) */
66
  fib_init_fn init;			/* Constructor */
67 68
};

69 70 71 72 73 74
static inline void * fib_node_to_user(struct fib *f, struct fib_node *e)
{ return e ? (void *) ((char *) e - f->node_offset) : NULL; }

static inline struct fib_node * fib_user_to_node(struct fib *f, void *e)
{ return e ? (void *) ((char *) e + f->node_offset) : NULL; }

75
void fib_init(struct fib *f, pool *p, uint addr_type, uint node_size, uint node_offset, uint hash_order, fib_init_fn init);
76
void *fib_find(struct fib *, const net_addr *);	/* Find or return NULL if doesn't exist */
77
void *fib_get_chain(struct fib *f, const net_addr *a); /* Find first node in linked list from hash table */
78 79
void *fib_get(struct fib *, const net_addr *); 	/* Find or create new if nonexistent */
void *fib_route(struct fib *, const net_addr *); /* Longest-match routing lookup */
80
void fib_delete(struct fib *, void *);	/* Remove fib entry */
81
void fib_free(struct fib *);		/* Destroy the fib */
82 83 84 85 86
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 *);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
87 88
void fit_put_next(struct fib *f, struct fib_iterator *i, struct fib_node *n, uint hpos);

89 90 91 92 93 94 95

#define FIB_WALK(fib, type, z) do {				\
	struct fib_node *fn_, **ff_ = (fib)->hash_table;	\
	uint count_ = (fib)->hash_size;				\
	type *z;						\
	while (count_--)					\
	  for (fn_ = *ff_++; z = fib_node_to_user(fib, fn_); fn_=fn_->next)
96 97

#define FIB_WALK_END } while (0)
98

99 100
#define FIB_ITERATE_INIT(it, fib) fit_init(it, fib)

101 102 103 104 105
#define FIB_ITERATE_START(fib, it, type, z) do {		\
	struct fib_node *fn_ = fit_get(fib, it);		\
	uint count_ = (fib)->hash_size;				\
	uint hpos_ = (it)->hash;				\
	type *z;						\
106
	for(;;) {						\
107
	  if (!fn_)						\
108
            {							\
109
	       if (++hpos_ >= count_)				\
110
		 break;						\
111
	       fn_ = (fib)->hash_table[hpos_];			\
112
	       continue;					\
113 114
	    }							\
	  z = fib_node_to_user(fib, fn_);
115

116
#define FIB_ITERATE_END fn_ = fn_->next; } } while(0)
117

118
#define FIB_ITERATE_PUT(it) fit_put(it, fn_)
119

120
#define FIB_ITERATE_PUT_NEXT(it, fib) fit_put_next(fib, it, fn_, hpos_)
Ondřej Zajíček's avatar
Ondřej Zajíček committed
121 122 123 124

#define FIB_ITERATE_UNLINK(it, fib) fit_get(fib, it)


125
/*
126 127 128 129
 *	Master Routing Tables. Generally speaking, each of them contains a FIB
 *	with each entry pointing to a list of route entries representing routes
 *	to given network (with the selected one at the head).
 *
130
 *	Each of the RTE's contains variable data (the preference and protocol-dependent
131
 *	metrics) and a pointer to a route attribute block common for many routes).
132 133
 *
 *	It's guaranteed that there is at most one RTE for every (prefix,proto) pair.
134 135
 */

136 137 138 139
struct rtable_config {
  node n;
  char *name;
  struct rtable *table;
140
  struct proto_config *krt_attached;	/* Kernel syncer attached to this table */
141
  uint addr_type;			/* Type of address data stored in table (NET_*) */
142 143
  int gc_max_ops;			/* Maximum number of operations before GC is run */
  int gc_min_time;			/* Minimum time between two consecutive GC runs */
144
  byte sorted;				/* Routes of network are sorted according to rte_better() */
145 146
};

147
typedef struct rtable {
148
  node n;				/* Node in list of all tables */
149 150
  struct fib fib;
  char *name;				/* Name of this table */
151
  list channels;			/* List of attached channels (struct channel) */
152
  uint addr_type;			/* Type of address data stored in table (NET_*) */
153
  int pipe_busy;			/* Pipe loop detection */
154
  int use_count;			/* Number of protocols using this table */
155
  struct hostcache *hostcache;
156
  struct rtable_config *config;		/* Configuration of this table */
157 158 159 160
  struct config *deleted;		/* Table doesn't exist in current configuration,
					 * delete as soon as use_count becomes 0 and remove
					 * obstacle from this routing table.
					 */
161
  struct event *rt_event;		/* Routing table event */
162 163
  int gc_counter;			/* Number of operations since last GC */
  bird_clock_t gc_time;			/* Time of last GC */
164
  byte prune_state;			/* Table prune state, 1 -> scheduled, 2-> running */
165 166
  byte hcu_scheduled;			/* Hostcache update is scheduled */
  byte nhu_state;			/* Next Hop Update state */
167
  struct fib_iterator prune_fit;	/* Rtable prune FIB iterator */
168
  struct fib_iterator nhu_fit;		/* Next Hop Update FIB iterator */
169 170
} rtable;

171 172 173 174 175
#define NHU_CLEAN	0
#define NHU_SCHEDULED	1
#define NHU_RUNNING	2
#define NHU_DIRTY	3

176 177
typedef struct network {
  struct rte *routes;			/* Available routes for this network */
178
  struct fib_node n;			/* FIB flags reserved for kernel syncer */
179 180
} net;

181
struct hostcache {
182 183 184 185 186
  slab *slab;				/* Slab holding all hostentries */
  struct hostentry **hash_table;	/* Hash table for hostentries */
  unsigned hash_order, hash_shift;
  unsigned hash_max, hash_min;
  unsigned hash_items;
187 188 189
  linpool *lp;				/* Linpool for trie */
  struct f_trie *trie;			/* Trie of prefixes that might affect hostentries */
  list hostentries;			/* List of all hostentries */
190 191 192 193 194
  byte update_hostcache;
};

struct hostentry {
  node ln;
195 196 197
  ip_addr addr;				/* IP address of host, part of key */
  ip_addr link;				/* (link-local) IP address of host, used as gw
					   if host is directly attached */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
198
  struct rtable *tab;			/* Dependent table, part of key */
199 200
  struct hostentry *next;		/* Next in hash chain */
  unsigned hash_key;			/* Hash key */
201
  unsigned uc;				/* Use count */
202
  struct rta *src;			/* Source rta entry */
203
  byte dest;				/* Chosen route destination type (RTD_...) */
204
  byte nexthop_linkable;		/* Nexthop list is completely non-device */
205
  u32 igp_metric;			/* Chosen route IGP metric */
206 207
};

208 209
typedef struct rte {
  struct rte *next;
210
  net *net;				/* Network this RTE belongs to */
211
  struct channel *sender;		/* Channel used to send the route to the routing table */
212
  struct rta *attrs;			/* Attributes of this route */
213
  byte flags;				/* Flags (REF_...) */
214
  byte pflags;				/* Protocol-specific flags */
215
  word pref;				/* Route preference */
216
  bird_clock_t lastmod;			/* Last modified */
217 218 219
  union {				/* Protocol-dependent data (metrics etc.) */
#ifdef CONFIG_RIP
    struct {
Ondřej Zajíček's avatar
Ondřej Zajíček committed
220 221
      struct iface *from;		/* Incoming iface */
      u8 metric;			/* RIP metric */
222
      u16 tag;				/* External route tag */
223 224 225 226 227
    } rip;
#endif
#ifdef CONFIG_OSPF
    struct {
      u32 metric1, metric2;		/* OSPF Type 1 and Type 2 metrics */
228
      u32 tag;				/* External route tag */
229
      u32 router_id;			/* Router that originated this route */
230
    } ospf;
231 232 233 234 235
#endif
#ifdef CONFIG_BGP
    struct {
      u8 suppressed;			/* Used for deterministic MED comparison */
    } bgp;
236 237 238 239 240 241
#endif
#ifdef CONFIG_BABEL
    struct {
      u16 metric;			/* Babel metric */
      u64 router_id;			/* Babel router id */
    } babel;
242
#endif
243 244 245 246
    struct {				/* Routes generated by krt sync (both temporary and inherited ones) */
      s8 src;				/* Alleged route source (see krt.h) */
      u8 proto;				/* Kernel source protocol ID */
      u8 seen;				/* Seen during last scan */
247
      u8 best;				/* Best route in network, propagated to core */
248 249
      u32 metric;			/* Kernel metric */
    } krt;
250 251 252
  } u;
} rte;

253
#define REF_COW		1		/* Copy this rte on write */
254
#define REF_FILTERED	2		/* Route is rejected by import filter */
255 256
#define REF_STALE	4		/* Route is stale in a refresh cycle */
#define REF_DISCARD	8		/* Route is scheduled for discard */
257 258

/* Route is valid for propagation (may depend on other flags in the future), accepts NULL */
259
static inline int rte_is_valid(rte *r) { return r && !(r->flags & REF_FILTERED); }
260

261 262
/* Route just has REF_FILTERED flag */
static inline int rte_is_filtered(rte *r) { return !!(r->flags & REF_FILTERED); }
263

264

265
/* Types of route announcement, also used as flags */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
266
#define RA_UNDEF	0		/* Undefined RA type */
267 268 269
#define RA_OPTIMAL	1		/* Announcement of optimal route change */
#define RA_ACCEPTED	2		/* Announcement of first accepted route */
#define RA_ANY		3		/* Announcement of any route change */
270
#define RA_MERGED	4		/* Announcement of optimal route merged with next ones */
271

272 273 274 275 276 277
/* Return value of import_control() callback */
#define RIC_ACCEPT	1		/* Accepted by protocol */
#define RIC_PROCESS	0		/* Process it through import filter */
#define RIC_REJECT	-1		/* Rejected by protocol */
#define RIC_DROP	-2		/* Silently dropped by protocol */

278
struct config;
279 280

void rt_init(void);
281
void rt_preconfig(struct config *);
282 283 284
void rt_commit(struct config *new, struct config *old);
void rt_lock_table(rtable *);
void rt_unlock_table(rtable *);
285
void rt_setup(pool *, rtable *, char *, struct rtable_config *);
286 287
static inline net *net_find(rtable *tab, const net_addr *addr) { return (net *) fib_find(&tab->fib, addr); }
static inline net *net_get(rtable *tab, const net_addr *addr) { return (net *) fib_get(&tab->fib, addr); }
288 289
void *net_route(rtable *tab, const net_addr *n);
int net_roa_check(rtable *tab, const net_addr *n, u32 asn);
290
rte *rte_find(net *net, struct rte_src *src);
291
rte *rte_get_temp(struct rta *);
292
void rte_update2(struct channel *c, const net_addr *n, rte *new, struct rte_src *src);
293
/* rte_update() moved to protocol.h to avoid dependency conflicts */
294
int rt_examine(rtable *t, net_addr *a, struct proto *p, struct filter *filter);
295
rte *rt_export_merged(struct channel *c, net *net, rte **rt_free, struct ea_list **tmpa, linpool *pool, int silent);
296 297 298
void rt_refresh_begin(rtable *t, struct channel *c);
void rt_refresh_end(rtable *t, struct channel *c);
void rt_schedule_prune(rtable *t);
299
void rte_dump(rte *);
300
void rte_free(rte *);
301 302
rte *rte_do_cow(rte *);
static inline rte * rte_cow(rte *r) { return (r->flags & REF_COW) ? rte_do_cow(r) : r; }
303
rte *rte_cow_rta(rte *r, linpool *lp);
304
void rt_dump(rtable *);
305
void rt_dump_all(void);
306 307
int rt_feed_channel(struct channel *c);
void rt_feed_channel_abort(struct channel *c);
308
struct rtable_config *rt_new_table(struct symbol *s, uint addr_type);
309

310

311 312 313 314 315
struct rt_show_data_rtable {
  node n;
  rtable *table;
};

316
struct rt_show_data {
317
  net_addr *addr;
318 319
  list table;
  struct rt_show_data_rtable *tit;
320
  struct filter *filter;
321
  int verbose, tables_defined_by;
322
  struct fib_iterator fit;
323
  struct proto *show_protocol;
324
  struct proto *export_protocol;
325
  struct channel *export_channel;
326
  int export_mode, primary_only, filtered;
327
  struct config *running_on_config;
328 329 330
  int net_counter, rt_counter, show_counter, table_counter;
  int net_counter_last, rt_counter_last, show_counter_last;
  int stats, show_for, stats_by_table;
331 332
};
void rt_show(struct rt_show_data *);
333 334 335 336 337 338 339 340 341 342
void rt_show_add_table(struct rt_show_data *d, rtable *t);

/* Value of table definition mode in struct rt_show_data */
#define RSD_TDB_DEFAULT	  0		/* no table specified */
#define RSD_TDB_INDIRECT  0		/* show route ... protocol P ... */
#define RSD_TDB_ALL	  RSD_TDB_SET			/* show route ... table all ... */
#define RSD_TDB_DIRECT	  RSD_TDB_SET | RSD_TDB_NMN	/* show route ... table X table Y ... */

#define RSD_TDB_SET	  0x1		/* internal: show empty tables */
#define RSD_TDB_NMN	  0x2		/* internal: need matching net */
343

344 345 346 347 348 349
/* Value of export_mode in struct rt_show_data */
#define RSEM_NONE	0		/* Export mode not used */
#define RSEM_PREEXPORT	1		/* Routes ready for export, before filtering */
#define RSEM_EXPORT	2		/* Routes accepted by export filter */
#define RSEM_NOEXPORT	3		/* Routes rejected by export filter */

350 351 352 353 354 355 356 357
/*
 *	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.
 */

358 359
/* Nexthop structure */
struct nexthop {
360 361
  ip_addr gw;				/* Next hop */
  struct iface *iface;			/* Outgoing interface */
362
  struct nexthop *next;
Pavel Tvrdík's avatar
Pavel Tvrdík committed
363
  byte weight;
364 365
  byte labels_orig;			/* Number of labels before hostentry was applied */
  byte labels;				/* Number of all labels */
366
  u32 label[0];
367 368
};

369 370 371 372 373 374 375 376 377
struct rte_src {
  struct rte_src *next;			/* Hash chain */
  struct proto *proto;			/* Protocol the source is based on */
  u32 private_id;			/* Private ID, assigned by the protocol */
  u32 global_id;			/* Globally unique ID of the source */
  unsigned uc;				/* Use count */
};


378
typedef struct rta {
379
  struct rta *next, **pprev;		/* Hash chain */
380 381 382
  u32 uc;				/* Use count */
  u32 hash_key;				/* Hash over important fields */
  struct ea_list *eattrs;		/* Extended Attribute chain */
383
  struct rte_src *src;			/* Route source that created the route */
384 385 386
  struct hostentry *hostentry;		/* Hostentry for recursive next-hops */
  ip_addr from;				/* Advertising router */
  u32 igp_metric;			/* IGP metric to next hop (for iBGP routes) */
387 388 389 390
  u8 source;				/* Route source (RTS_...) */
  u8 scope;				/* Route scope (SCOPE_... -- see ip.h) */
  u8 dest;				/* Route destination type (RTD_...) */
  u8 aflags;
391
  struct nexthop nh;			/* Next hop */
392 393
} rta;

394
#define RTS_DUMMY 0			/* Dummy route to be removed soon */
395 396 397 398 399 400
#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 */
Martin Mareš's avatar
Martin Mareš committed
401
#define RTS_OSPF 7			/* OSPF route */
402
#define RTS_OSPF_IA 8			/* OSPF inter-area route */
Ondřej Filip's avatar
Ondřej Filip committed
403 404 405 406
#define RTS_OSPF_EXT1 9			/* OSPF external route type 1 */
#define RTS_OSPF_EXT2 10		/* OSPF external route type 2 */
#define RTS_BGP 11			/* BGP route */
#define RTS_PIPE 12			/* Inter-table wormhole */
407
#define RTS_BABEL 13			/* Babel route */
408 409
#define RTS_RPKI 14			/* Route Origin Authorization */

410 411 412 413 414 415

#define RTC_UNICAST 0
#define RTC_BROADCAST 1
#define RTC_MULTICAST 2
#define RTC_ANYCAST 3			/* IPv6 Anycast */

Ondřej Zajíček's avatar
Ondřej Zajíček committed
416 417
#define RTD_NONE 0			/* Undefined next hop */
#define RTD_UNICAST 1			/* Next hop is neighbor router */
418 419 420
#define RTD_BLACKHOLE 2			/* Silently drop packets */
#define RTD_UNREACHABLE 3		/* Reject as unreachable */
#define RTD_PROHIBIT 4			/* Administratively prohibited */
421
#define RTD_MAX 5
422

423 424 425 426
					/* Flags for net->n.flags, used by kernel syncer */
#define KRF_INSTALLED 0x80		/* This route should be installed in the kernel */
#define KRF_SYNC_ERROR 0x40		/* Error during kernel table synchronization */

427 428
#define RTAF_CACHED 1			/* This is a cached rta */

429 430 431
#define IGP_METRIC_UNKNOWN 0x80000000	/* Default igp_metric used when no other
					   protocol-specific metric is availabe */

432

433 434 435 436 437
const char * rta_dest_names[RTD_MAX];

static inline const char *rta_dest_name(uint n)
{ return (n < RTD_MAX) ? rta_dest_names[n] : "???"; }

438 439
/* Route has regular, reachable nexthop (i.e. not RTD_UNREACHABLE and like) */
static inline int rte_is_reachable(rte *r)
Ondřej Zajíček's avatar
Ondřej Zajíček committed
440
{ return r->attrs->dest == RTD_UNICAST; }
441 442


443 444 445 446 447
/*
 *	Extended Route Attributes
 */

typedef struct eattr {
448 449 450
  word id;				/* EA_CODE(EAP_..., protocol-dependent ID) */
  byte flags;				/* Protocol-dependent flags */
  byte type;				/* Attribute type and several flags (EAF_...) */
451 452 453 454 455 456 457 458
  union {
    u32 data;
    struct adata *ptr;			/* Attribute data elsewhere */
  } u;
} eattr;

#define EAP_GENERIC 0			/* Generic attributes */
#define EAP_BGP 1			/* BGP attributes */
459
#define EAP_RIP 2			/* RIP */
460
#define EAP_OSPF 3			/* OSPF */
461
#define EAP_KRT 4			/* Kernel route attributes */
462 463
#define EAP_BABEL 5			/* Babel attributes */
#define EAP_MAX 6
464

465 466 467 468
#define EA_CODE(proto,id) (((proto) << 8) | (id))
#define EA_PROTO(ea) ((ea) >> 8)
#define EA_ID(ea) ((ea) & 0xff)

469 470
#define EA_GEN_IGP_METRIC EA_CODE(EAP_GENERIC, 0)

471 472
#define EA_CODE_MASK 0xffff
#define EA_ALLOW_UNDEF 0x10000		/* ea_find: allow EAF_TYPE_UNDEF */
473
#define EA_BIT(n) ((n) << 24)		/* Used in bitfield accessors */
474

475
#define EAF_TYPE_MASK 0x1f		/* Mask with this to get type */
476
#define EAF_TYPE_INT 0x01		/* 32-bit unsigned integer number */
477
#define EAF_TYPE_OPAQUE 0x02		/* Opaque byte string (not filterable) */
478 479
#define EAF_TYPE_IP_ADDRESS 0x04	/* IP address */
#define EAF_TYPE_ROUTER_ID 0x05		/* Router ID (IPv4 address) */
Martin Mareš's avatar
Martin Mareš committed
480
#define EAF_TYPE_AS_PATH 0x06		/* BGP AS path (encoding per RFC 1771:4.3) */
481
#define EAF_TYPE_BITFIELD 0x09		/* 32-bit embedded bitfield */
Martin Mareš's avatar
Martin Mareš committed
482
#define EAF_TYPE_INT_SET 0x0a		/* Set of u32's (e.g., a community list) */
483
#define EAF_TYPE_EC_SET 0x0e		/* Set of pairs of u32's - ext. community list */
484 485
#define EAF_TYPE_LC_SET 0x12		/* Set of triplets of u32's - large community list */
#define EAF_TYPE_UNDEF 0x1f		/* `force undefined' entry */
486
#define EAF_EMBEDDED 0x01		/* Data stored in eattr.u.data (part of type spec) */
487
#define EAF_VAR_LENGTH 0x02		/* Attribute length is variable (part of type spec) */
Ondřej Zajíček's avatar
Ondřej Zajíček committed
488 489
#define EAF_ORIGINATED 0x20		/* The attribute has originated locally */
#define EAF_FRESH 0x40			/* An uncached attribute (e.g. modified in export filter) */
490
#define EAF_TEMP 0x80			/* A temporary attribute (the one stored in the tmp attr list) */
491

Ondřej Zajíček's avatar
Ondřej Zajíček committed
492
typedef struct adata {
Pavel Tvrdík's avatar
Pavel Tvrdík committed
493
  uint length;				/* Length of data */
494
  byte data[0];
Ondřej Zajíček's avatar
Ondřej Zajíček committed
495 496 497 498 499 500 501 502 503
} adata;

static inline struct adata *
lp_alloc_adata(struct linpool *pool, uint len)
{
  struct adata *ad = lp_alloc(pool, sizeof(struct adata) + len);
  ad->length = len;
  return ad;
}
504

505 506 507 508
static inline int adata_same(struct adata *a, struct adata *b)
{ return (a->length == b->length && !memcmp(a->data, b->data, a->length)); }


509 510
typedef struct ea_list {
  struct ea_list *next;			/* In case we have an override list */
511
  byte flags;				/* Flags: EALF_... */
512
  byte rfu;
513
  word count;				/* Number of attributes */
514 515 516
  eattr attrs[0];			/* Attribute definitions themselves */
} ea_list;

517 518 519
#define EALF_SORTED 1			/* Attributes are sorted by code */
#define EALF_BISECT 2			/* Use interval bisection for searching */
#define EALF_CACHED 4			/* Attributes belonging to cached rta */
520

521 522 523 524 525 526
struct rte_src *rt_find_source(struct proto *p, u32 id);
struct rte_src *rt_get_source(struct proto *p, u32 id);
static inline void rt_lock_source(struct rte_src *src) { src->uc++; }
static inline void rt_unlock_source(struct rte_src *src) { src->uc--; }
void rt_prune_sources(void);

527 528 529 530 531
struct ea_walk_state {
  ea_list *eattrs;			/* Ccurrent ea_list, initially set by caller */
  eattr *ea;				/* Current eattr, initially NULL */
  u32 visited[4];			/* Bitfield, limiting max to 128 */
};
532

533
eattr *ea_find(ea_list *, unsigned ea);
534
eattr *ea_walk(struct ea_walk_state *s, uint id, uint max);
535
int ea_get_int(ea_list *, unsigned ea, int def);
536 537
void ea_dump(ea_list *);
void ea_sort(ea_list *);		/* Sort entries in all sub-lists */
538
unsigned ea_scan(ea_list *);		/* How many bytes do we need for merged ea_list */
539
void ea_merge(ea_list *from, ea_list *to); /* Merge sub-lists to allocated buffer */
540
int ea_same(ea_list *x, ea_list *y);	/* Test whether two ea_lists are identical */
Pavel Tvrdík's avatar
Pavel Tvrdík committed
541
uint ea_hash(ea_list *e);	/* Calculate 16-bit hash value */
542
ea_list *ea_append(ea_list *to, ea_list *what);
543
void ea_format_bitfield(struct eattr *a, byte *buf, int bufsize, const char **names, int min, int max);
544

545
#define NEXTHOP_MAX_SIZE (sizeof(struct nexthop) + sizeof(u32)*MPLS_MAX_LABEL_STACK)
546 547 548

static inline size_t nexthop_size(const struct nexthop *nh)
{ return sizeof(struct nexthop) + sizeof(u32)*nh->labels; }
549 550 551 552 553
int nexthop__same(struct nexthop *x, struct nexthop *y); /* Compare multipath nexthops */
static inline int nexthop_same(struct nexthop *x, struct nexthop *y)
{ return (x == y) || nexthop__same(x, y); }
struct nexthop *nexthop_merge(struct nexthop *x, struct nexthop *y, int rx, int ry, int max, linpool *lp);
static inline void nexthop_link(struct rta *a, struct nexthop *from)
554
{ memcpy(&a->nh, from, nexthop_size(from)); }
Ondřej Zajíček's avatar
Ondřej Zajíček committed
555
void nexthop_insert(struct nexthop **n, struct nexthop *y);
556
int nexthop_is_sorted(struct nexthop *x);
557

558
void rta_init(void);
559
static inline size_t rta_size(const rta *a) { return sizeof(rta) + sizeof(u32)*a->nh.labels; }
560
#define RTA_MAX_SIZE (sizeof(rta) + sizeof(u32)*MPLS_MAX_LABEL_STACK)
561
rta *rta_lookup(rta *);			/* Get rta equivalent to this one, uc++ */
562
static inline int rta_is_cached(rta *r) { return r->aflags & RTAF_CACHED; }
563
static inline rta *rta_clone(rta *r) { r->uc++; return r; }
564 565
void rta__free(rta *r);
static inline void rta_free(rta *r) { if (r && !--r->uc) rta__free(r); }
566 567
rta *rta_do_cow(rta *o, linpool *lp);
static inline rta * rta_cow(rta *r, linpool *lp) { return rta_is_cached(r) ? rta_do_cow(r, lp) : r; }
568 569
void rta_dump(rta *);
void rta_dump_all(void);
570
void rta_show(struct cli *, rta *, ea_list *);
571 572 573 574 575 576 577 578 579

struct hostentry * rt_get_hostentry(rtable *tab, ip_addr a, ip_addr ll, rtable *dep);
void rta_apply_hostentry(rta *a, struct hostentry *he, mpls_label_stack *mls);

static inline void
rta_set_recursive_next_hop(rtable *dep, rta *a, rtable *tab, ip_addr gw, ip_addr ll, mpls_label_stack *mls)
{
  rta_apply_hostentry(a, rt_get_hostentry(tab, gw, ll, dep), mls);
}
580 581

/*
Ondřej Zajíček's avatar
Ondřej Zajíček committed
582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600
 * rta_set_recursive_next_hop() acquires hostentry from hostcache and fills
 * rta->hostentry field.  New hostentry has zero use count. Cached rta locks its
 * hostentry (increases its use count), uncached rta does not lock it. Hostentry
 * with zero use count is removed asynchronously during host cache update,
 * therefore it is safe to hold such hostentry temorarily. Hostentry holds a
 * lock for a 'source' rta, mainly to share multipath nexthops.
 *
 * There is no need to hold a lock for hostentry->dep table, because that table
 * contains routes responsible for that hostentry, and therefore is non-empty if
 * given hostentry has non-zero use count. If the hostentry has zero use count,
 * the entry is removed before dep is referenced.
 *
 * The protocol responsible for routes with recursive next hops should hold a
 * lock for a 'source' table governing that routes (argument tab to
 * rta_set_recursive_next_hop()), because its routes reference hostentries
 * (through rta) related to the governing table. When all such routes are
 * removed, rtas are immediately removed achieving zero uc. Then the 'source'
 * table lock could be immediately released, although hostentries may still
 * exist - they will be freed together with the 'source' table.
601 602 603 604 605
 */

static inline void rt_lock_hostentry(struct hostentry *he) { if (he) he->uc++; }
static inline void rt_unlock_hostentry(struct hostentry *he) { if (he) he->uc--; }

606

607 608
extern struct protocol *attr_class_to_protocol[EAP_MAX];

609 610 611 612 613 614
/*
 *	Default protocol preferences
 */

#define DEF_PREF_DIRECT	    	240	/* Directly connected */
#define DEF_PREF_STATIC		200	/* Static route */
615
#define DEF_PREF_OSPF		150	/* OSPF intra-area, inter-area and type 1 external routes */
616
#define DEF_PREF_BABEL		130	/* Babel */
617 618
#define DEF_PREF_RIP		120	/* RIP */
#define DEF_PREF_BGP		100	/* BGP */
619
#define DEF_PREF_RPKI		100	/* RPKI */
620
#define DEF_PREF_INHERITED	10	/* Routes inherited from other routing daemons */
621

622 623 624 625
/*
 *	Route Origin Authorization
 */

Pavel Tvrdík's avatar
Pavel Tvrdík committed
626 627 628
#define ROA_UNKNOWN	0
#define ROA_VALID	1
#define ROA_INVALID	2
629

Jan Moskyto Matejka's avatar
Jan Moskyto Matejka committed
630
#endif