nest/route.h

   1 /*
   2  *      BIRD Internet Routing Daemon -- Routing Table
   3  *
   4  *      (c) 1998--2000 Martin Mares <mj@ucw.cz>
   5  *
   6  *      Can be freely distributed and used under the terms of the GNU GPL.
   7  */
   8
   9 #ifndef _BIRD_ROUTE_H_
  10 #define _BIRD_ROUTE_H_
  11
  12 #include "lib/lists.h"
  13 #include "lib/resource.h"
  14 #include "lib/timer.h"
  15 #include "nest/protocol.h"
  16
  17 struct protocol;
  18 struct proto;
  19 struct symbol;
  20 struct filter;
  21 struct cli;
  22
  23 /*
  24  *      Generic data structure for storing network prefixes. Also used
  25  *      for the master routing table. Currently implemented as a hash
  26  *      table.
  27  *
  28  *      Available operations:
  29  *              - insertion of new entry
  30  *              - deletion of entry
  31  *              - searching for entry by network prefix
  32  *              - asynchronous retrieval of fib contents
  33  */
  34
  35 struct fib_node {
  36   struct fib_node *next;                /* Next in hash chain */
  37   struct fib_iterator *readers;         /* List of readers of this node */
  38   byte flags;                           /* User-defined, will be removed */
  39   u32 uid;                              /* Unique ID based on hash, will be removed */
  40   net_addr addr[0];
  41 };
  42
  43 struct fib_iterator {                   /* See lib/slists.h for an explanation */
  44   struct fib_iterator *prev, *next;     /* Must be synced with struct fib_node! */
  45   byte efef;                            /* 0xff to distinguish between iterator and node */
  46   byte pad[3];
  47   struct fib_node *node;                /* Or NULL if freshly merged */
  48   uint hash;
  49 };
  50
  51 typedef void (*fib_init_fn)(void *);
  52
  53 struct fib {
  54   pool *fib_pool;                       /* Pool holding all our data */
  55   slab *fib_slab;                       /* Slab holding all fib nodes */
  56   struct fib_node **hash_table;         /* Node hash table */
  57   uint hash_size;                       /* Number of hash table entries (a power of two) */
  58   uint hash_order;                      /* Binary logarithm of hash_size */
  59   uint hash_shift;                      /* 16 - hash_log */
  60   uint addr_type;                       /* Type of address data stored in fib (NET_*) */
  61   uint node_size;       /* XXXX */
  62   uint node_offset;     /* XXXX */
  63   uint entries;                         /* Number of entries */
  64   uint entries_min, entries_max;        /* Entry count limits (else start rehashing) */
  65   fib_init_fn init;                     /* Constructor */
  66 };
  67
  68 static inline void * fib_node_to_user(struct fib *f, struct fib_node *e)
  69 { return e ? (void *) ((char *) e - f->node_offset) : NULL; }
  70
  71 static inline struct fib_node * fib_user_to_node(struct fib *f, void *e)
  72 { return e ? (void *) ((char *) e + f->node_offset) : NULL; }
  73
  74 void fib_init(struct fib *f, pool *p, uint addr_type, uint node_size, uint node_offset, uint hash_order, fib_init_fn init);
  75 void *fib_find(struct fib *, const net_addr *); /* Find or return NULL if doesn't exist */
  76 void *fib_get(struct fib *, const net_addr *);  /* Find or create new if nonexistent */
  77 void *fib_route(struct fib *, const net_addr *); /* Longest-match routing lookup */
  78 void fib_delete(struct fib *, void *);  /* Remove fib entry */
  79 void fib_free(struct fib *);            /* Destroy the fib */
  80 void fib_check(struct fib *);           /* Consistency check for debugging */
  81
  82 void fit_init(struct fib_iterator *, struct fib *); /* Internal functions, don't call */
  83 struct fib_node *fit_get(struct fib *, struct fib_iterator *);
  84 void fit_put(struct fib_iterator *, struct fib_node *);
  85 void fit_put_next(struct fib *f, struct fib_iterator *i, struct fib_node *n, uint hpos);
  86
  87
  88 #define FIB_WALK(fib, type, z) do {                             \
  89         struct fib_node *fn_, **ff_ = (fib)->hash_table;        \
  90         uint count_ = (fib)->hash_size;                         \
  91         type *z;                                                \
  92         while (count_--)                                        \
  93           for (fn_ = *ff_++; z = fib_node_to_user(fib, fn_); fn_=fn_->next)
  94
  95 #define FIB_WALK_END } while (0)
  96
  97 #define FIB_ITERATE_INIT(it, fib) fit_init(it, fib)
  98
  99 #define FIB_ITERATE_START(fib, it, type, z) do {                \
 100         struct fib_node *fn_ = fit_get(fib, it);                \
 101         uint count_ = (fib)->hash_size;                         \
 102         uint hpos_ = (it)->hash;                                \
 103         type *z;                                                \
 104         for(;;) {                                               \
 105           if (!fn_)                                             \
 106             {                                                   \
 107                if (++hpos_ >= count_)                           \
 108                  break;                                         \
 109                fn_ = (fib)->hash_table[hpos_];                  \
 110                continue;                                        \
 111             }                                                   \
 112           z = fib_node_to_user(fib, fn_);
 113
 114 #define FIB_ITERATE_END fn_ = fn_->next; } } while(0)
 115
 116 #define FIB_ITERATE_PUT(it) fit_put(it, fn_)
 117
 118 #define FIB_ITERATE_PUT_NEXT(it, fib) fit_put_next(fib, it, fn_, hpos_)
 119
 120 #define FIB_ITERATE_UNLINK(it, fib) fit_get(fib, it)
 121
 122
 123 /*
 124  *      Master Routing Tables. Generally speaking, each of them contains a FIB
 125  *      with each entry pointing to a list of route entries representing routes
 126  *      to given network (with the selected one at the head).
 127  *
 128  *      Each of the RTE's contains variable data (the preference and protocol-dependent
 129  *      metrics) and a pointer to a route attribute block common for many routes).
 130  *
 131  *      It's guaranteed that there is at most one RTE for every (prefix,proto) pair.
 132  */
 133
 134 struct rtable_config {
 135   node n;
 136   char *name;
 137   struct rtable *table;
 138   struct proto_config *krt_attached;    /* Kernel syncer attached to this table */
 139   uint addr_type;                       /* Type of address data stored in table (NET_*) */
 140   int gc_max_ops;                       /* Maximum number of operations before GC is run */
 141   int gc_min_time;                      /* Minimum time between two consecutive GC runs */
 142   byte sorted;                          /* Routes of network are sorted according to rte_better() */
 143 };
 144
 145 typedef struct rtable {
 146   node n;                               /* Node in list of all tables */
 147   struct fib fib;
 148   char *name;                           /* Name of this table */
 149   list hooks;                           /* List of announcement hooks */
 150   uint addr_type;                       /* Type of address data stored in table (NET_*) */
 151   int pipe_busy;                        /* Pipe loop detection */
 152   int use_count;                        /* Number of protocols using this table */
 153   struct hostcache *hostcache;
 154   struct rtable_config *config;         /* Configuration of this table */
 155   struct config *deleted;               /* Table doesn't exist in current configuration,
 156                                          * delete as soon as use_count becomes 0 and remove
 157                                          * obstacle from this routing table.
 158                                          */
 159   struct event *rt_event;               /* Routing table event */
 160   int gc_counter;                       /* Number of operations since last GC */
 161   bird_clock_t gc_time;                 /* Time of last GC */
 162   byte gc_scheduled;                    /* GC is scheduled */
 163   byte prune_state;                     /* Table prune state, 1 -> scheduled, 2-> running */
 164   byte hcu_scheduled;                   /* Hostcache update is scheduled */
 165   byte nhu_state;                       /* Next Hop Update state */
 166   struct fib_iterator prune_fit;        /* Rtable prune FIB iterator */
 167   struct fib_iterator nhu_fit;          /* Next Hop Update FIB iterator */
 168 } rtable;
 169
 170 #define RPS_NONE        0
 171 #define RPS_SCHEDULED   1
 172 #define RPS_RUNNING     2
 173
 174 typedef struct network {
 175   struct rte *routes;                   /* Available routes for this network */
 176   struct fib_node n;                    /* FIB flags reserved for kernel syncer */
 177 } net;
 178
 179 struct hostcache {
 180   slab *slab;                           /* Slab holding all hostentries */
 181   struct hostentry **hash_table;        /* Hash table for hostentries */
 182   unsigned hash_order, hash_shift;
 183   unsigned hash_max, hash_min;
 184   unsigned hash_items;
 185   linpool *lp;                          /* Linpool for trie */
 186   struct f_trie *trie;                  /* Trie of prefixes that might affect hostentries */
 187   list hostentries;                     /* List of all hostentries */
 188   byte update_hostcache;
 189 };
 190
 191 struct hostentry {
 192   node ln;
 193   ip_addr addr;                         /* IP address of host, part of key */
 194   ip_addr link;                         /* (link-local) IP address of host, used as gw
 195                                            if host is directly attached */
 196   struct rtable *tab;                   /* Dependent table, part of key */
 197   struct hostentry *next;               /* Next in hash chain */
 198   unsigned hash_key;                    /* Hash key */
 199   unsigned uc;                          /* Use count */
 200   struct rta *src;                      /* Source rta entry */
 201   ip_addr gw;                           /* Chosen next hop */
 202   byte dest;                            /* Chosen route destination type (RTD_...) */
 203   u32 igp_metric;                       /* Chosen route IGP metric */
 204 };
 205
 206 typedef struct rte {
 207   struct rte *next;
 208   net *net;                             /* Network this RTE belongs to */
 209   struct announce_hook *sender;         /* Announce hook used to send the route to the routing table */
 210   struct rta *attrs;                    /* Attributes of this route */
 211   byte flags;                           /* Flags (REF_...) */
 212   byte pflags;                          /* Protocol-specific flags */
 213   word pref;                            /* Route preference */
 214   bird_clock_t lastmod;                 /* Last modified */
 215   union {                               /* Protocol-dependent data (metrics etc.) */
 216 #ifdef CONFIG_RIP
 217     struct {
 218       struct iface *from;               /* Incoming iface */
 219       u8 metric;                        /* RIP metric */
 220       u16 tag;                          /* External route tag */
 221     } rip;
 222 #endif
 223 #ifdef CONFIG_OSPF
 224     struct {
 225       u32 metric1, metric2;             /* OSPF Type 1 and Type 2 metrics */
 226       u32 tag;                          /* External route tag */
 227       u32 router_id;                    /* Router that originated this route */
 228     } ospf;
 229 #endif
 230 #ifdef CONFIG_BGP
 231     struct {
 232       u8 suppressed;                    /* Used for deterministic MED comparison */
 233     } bgp;
 234 #endif
 235     struct {                            /* Routes generated by krt sync (both temporary and inherited ones) */
 236       s8 src;                           /* Alleged route source (see krt.h) */
 237       u8 proto;                         /* Kernel source protocol ID */
 238       u8 type;                          /* Kernel route type */
 239       u8 seen;                          /* Seen during last scan */
 240       u32 metric;                       /* Kernel metric */
 241     } krt;
 242   } u;
 243 } rte;
 244
 245 #define REF_COW         1               /* Copy this rte on write */
 246 #define REF_FILTERED    2               /* Route is rejected by import filter */
 247 #define REF_STALE       4               /* Route is stale in a refresh cycle */
 248 #define REF_DISCARD     8               /* Route is scheduled for discard */
 249
 250 /* Route is valid for propagation (may depend on other flags in the future), accepts NULL */
 251 static inline int rte_is_valid(rte *r) { return r && !(r->flags & REF_FILTERED); }
 252
 253 /* Route just has REF_FILTERED flag */
 254 static inline int rte_is_filtered(rte *r) { return !!(r->flags & REF_FILTERED); }
 255
 256
 257 /* Types of route announcement, also used as flags */
 258 #define RA_OPTIMAL      1               /* Announcement of optimal route change */
 259 #define RA_ACCEPTED     2               /* Announcement of first accepted route */
 260 #define RA_ANY          3               /* Announcement of any route change */
 261 #define RA_MERGED       4               /* Announcement of optimal route merged with next ones */
 262
 263 /* Return value of import_control() callback */
 264 #define RIC_ACCEPT      1               /* Accepted by protocol */
 265 #define RIC_PROCESS     0               /* Process it through import filter */
 266 #define RIC_REJECT      -1              /* Rejected by protocol */
 267 #define RIC_DROP        -2              /* Silently dropped by protocol */
 268
 269 struct config;
 270
 271 void rt_init(void);
 272 void rt_preconfig(struct config *);
 273 void rt_commit(struct config *new, struct config *old);
 274 void rt_lock_table(rtable *);
 275 void rt_unlock_table(rtable *);
 276 void rt_setup(pool *, rtable *, char *, struct rtable_config *);
 277 static inline net *net_find(rtable *tab, net_addr *addr) { return (net *) fib_find(&tab->fib, addr); }
 278 static inline net *net_get(rtable *tab, net_addr *addr) { return (net *) fib_get(&tab->fib, addr); }
 279
 280 static inline net *net_find_ipa(rtable *tab, ip_addr px, uint pxlen)
 281 { net_addr addr; net_fill_ipa(&addr, px, pxlen); return (net *) fib_find(&tab->fib, &addr); }
 282 static inline net *net_get_ipa(rtable *tab, ip_addr px, uint pxlen)
 283 { net_addr addr; net_fill_ipa(&addr, px, pxlen); return (net *) fib_get(&tab->fib, &addr); }
 284
 285 rte *rte_find(net *net, struct rte_src *src);
 286 rte *rte_get_temp(struct rta *);
 287 void rte_update2(struct announce_hook *ah, net *net, rte *new, struct rte_src *src);
 288 static inline void rte_update(struct proto *p, net *net, rte *new) { rte_update2(p->main_ahook, net, new, p->main_source); }
 289 void rte_discard(rtable *tab, rte *old);
 290 int rt_examine(rtable *t, net_addr *a, struct proto *p, struct filter *filter);
 291 rte *rt_export_merged(struct announce_hook *ah, net *net, rte **rt_free, struct ea_list **tmpa, int silent);
 292 void rt_refresh_begin(rtable *t, struct announce_hook *ah);
 293 void rt_refresh_end(rtable *t, struct announce_hook *ah);
 294 void rte_dump(rte *);
 295 void rte_free(rte *);
 296 rte *rte_do_cow(rte *);
 297 static inline rte * rte_cow(rte *r) { return (r->flags & REF_COW) ? rte_do_cow(r) : r; }
 298 rte *rte_cow_rta(rte *r, linpool *lp);
 299 void rt_dump(rtable *);
 300 void rt_dump_all(void);
 301 int rt_feed_baby(struct proto *p);
 302 void rt_feed_baby_abort(struct proto *p);
 303 int rt_prune_loop(void);
 304 struct rtable_config *rt_new_table(struct symbol *s, uint addr_type);
 305
 306 static inline void
 307 rt_mark_for_prune(rtable *tab)
 308 {
 309   if (tab->prune_state == RPS_RUNNING)
 310     fit_get(&tab->fib, &tab->prune_fit);
 311
 312   tab->prune_state = RPS_SCHEDULED;
 313 }
 314
 315 struct rt_show_data {
 316   net_addr *prefix;
 317   rtable *table;
 318   struct filter *filter;
 319   int verbose;
 320   struct fib_iterator fit;
 321   struct proto *show_protocol;
 322   struct proto *export_protocol;
 323   int export_mode, primary_only, filtered;
 324   struct config *running_on_config;
 325   int net_counter, rt_counter, show_counter;
 326   int stats, show_for;
 327 };
 328 void rt_show(struct rt_show_data *);
 329
 330 /* Value of export_mode in struct rt_show_data */
 331 #define RSEM_NONE       0               /* Export mode not used */
 332 #define RSEM_PREEXPORT  1               /* Routes ready for export, before filtering */
 333 #define RSEM_EXPORT     2               /* Routes accepted by export filter */
 334 #define RSEM_NOEXPORT   3               /* Routes rejected by export filter */
 335
 336 /*
 337  *      Route Attributes
 338  *
 339  *      Beware: All standard BGP attributes must be represented here instead
 340  *      of making them local to the route. This is needed to ensure proper
 341  *      construction of BGP route attribute lists.
 342  */
 343
 344 /* Multipath next-hop */
 345 struct mpnh {
 346   ip_addr gw;                           /* Next hop */
 347   struct iface *iface;                  /* Outgoing interface */
 348   struct mpnh *next;
 349   byte weight;
 350 };
 351
 352 struct rte_src {
 353   struct rte_src *next;                 /* Hash chain */
 354   struct proto *proto;                  /* Protocol the source is based on */
 355   u32 private_id;                       /* Private ID, assigned by the protocol */
 356   u32 global_id;                        /* Globally unique ID of the source */
 357   unsigned uc;                          /* Use count */
 358 };
 359
 360
 361 typedef struct rta {
 362   struct rta *next, **pprev;            /* Hash chain */
 363   struct rte_src *src;                  /* Route source that created the route */
 364   unsigned uc;                          /* Use count */
 365   byte source;                          /* Route source (RTS_...) */
 366   byte scope;                           /* Route scope (SCOPE_... -- see ip.h) */
 367   byte cast;                            /* Casting type (RTC_...) */
 368   byte dest;                            /* Route destination type (RTD_...) */
 369   byte flags;                           /* Route flags (RTF_...), now unused */
 370   byte aflags;                          /* Attribute cache flags (RTAF_...) */
 371   u16 hash_key;                         /* Hash over important fields */
 372   u32 igp_metric;                       /* IGP metric to next hop (for iBGP routes) */
 373   ip_addr gw;                           /* Next hop */
 374   ip_addr from;                         /* Advertising router */
 375   struct hostentry *hostentry;          /* Hostentry for recursive next-hops */
 376   struct iface *iface;                  /* Outgoing interface */
 377   struct mpnh *nexthops;                /* Next-hops for multipath routes */
 378   struct ea_list *eattrs;               /* Extended Attribute chain */
 379 } rta;
 380
 381 #define RTS_DUMMY 0                     /* Dummy route to be removed soon */
 382 #define RTS_STATIC 1                    /* Normal static route */
 383 #define RTS_INHERIT 2                   /* Route inherited from kernel */
 384 #define RTS_DEVICE 3                    /* Device route */
 385 #define RTS_STATIC_DEVICE 4             /* Static device route */
 386 #define RTS_REDIRECT 5                  /* Learned via redirect */
 387 #define RTS_RIP 6                       /* RIP route */
 388 #define RTS_OSPF 7                      /* OSPF route */
 389 #define RTS_OSPF_IA 8                   /* OSPF inter-area route */
 390 #define RTS_OSPF_EXT1 9                 /* OSPF external route type 1 */
 391 #define RTS_OSPF_EXT2 10                /* OSPF external route type 2 */
 392 #define RTS_BGP 11                      /* BGP route */
 393 #define RTS_PIPE 12                     /* Inter-table wormhole */
 394
 395 #define RTC_UNICAST 0
 396 #define RTC_BROADCAST 1
 397 #define RTC_MULTICAST 2
 398 #define RTC_ANYCAST 3                   /* IPv6 Anycast */
 399
 400 #define RTD_ROUTER 0                    /* Next hop is neighbor router */
 401 #define RTD_DEVICE 1                    /* Points to device */
 402 #define RTD_BLACKHOLE 2                 /* Silently drop packets */
 403 #define RTD_UNREACHABLE 3               /* Reject as unreachable */
 404 #define RTD_PROHIBIT 4                  /* Administratively prohibited */
 405 #define RTD_MULTIPATH 5                 /* Multipath route (nexthops != NULL) */
 406 #define RTD_NONE 6                      /* Invalid RTD */
 407
 408                                         /* Flags for net->n.flags, used by kernel syncer */
 409 #define KRF_INSTALLED 0x80              /* This route should be installed in the kernel */
 410 #define KRF_SYNC_ERROR 0x40             /* Error during kernel table synchronization */
 411
 412 #define RTAF_CACHED 1                   /* This is a cached rta */
 413
 414 #define IGP_METRIC_UNKNOWN 0x80000000   /* Default igp_metric used when no other
 415                                            protocol-specific metric is availabe */
 416
 417
 418 /* Route has regular, reachable nexthop (i.e. not RTD_UNREACHABLE and like) */
 419 static inline int rte_is_reachable(rte *r)
 420 { uint d = r->attrs->dest; return (d == RTD_ROUTER) || (d == RTD_DEVICE) || (d == RTD_MULTIPATH); }
 421
 422
 423 /*
 424  *      Extended Route Attributes
 425  */
 426
 427 typedef struct eattr {
 428   word id;                              /* EA_CODE(EAP_..., protocol-dependent ID) */
 429   byte flags;                           /* Protocol-dependent flags */
 430   byte type;                            /* Attribute type and several flags (EAF_...) */
 431   union {
 432     u32 data;
 433     struct adata *ptr;                  /* Attribute data elsewhere */
 434   } u;
 435 } eattr;
 436
 437 #define EAP_GENERIC 0                   /* Generic attributes */
 438 #define EAP_BGP 1                       /* BGP attributes */
 439 #define EAP_RIP 2                       /* RIP */
 440 #define EAP_OSPF 3                      /* OSPF */
 441 #define EAP_KRT 4                       /* Kernel route attributes */
 442 #define EAP_MAX 5
 443
 444 #define EA_CODE(proto,id) (((proto) << 8) | (id))
 445 #define EA_PROTO(ea) ((ea) >> 8)
 446 #define EA_ID(ea) ((ea) & 0xff)
 447
 448 #define EA_GEN_IGP_METRIC EA_CODE(EAP_GENERIC, 0)
 449
 450 #define EA_CODE_MASK 0xffff
 451 #define EA_ALLOW_UNDEF 0x10000          /* ea_find: allow EAF_TYPE_UNDEF */
 452 #define EA_BIT(n) ((n) << 24)           /* Used in bitfield accessors */
 453
 454 #define EAF_TYPE_MASK 0x0f              /* Mask with this to get type */
 455 #define EAF_TYPE_INT 0x01               /* 32-bit unsigned integer number */
 456 #define EAF_TYPE_OPAQUE 0x02            /* Opaque byte string (not filterable) */
 457 #define EAF_TYPE_IP_ADDRESS 0x04        /* IP address */
 458 #define EAF_TYPE_ROUTER_ID 0x05         /* Router ID (IPv4 address) */
 459 #define EAF_TYPE_AS_PATH 0x06           /* BGP AS path (encoding per RFC 1771:4.3) */
 460 #define EAF_TYPE_BITFIELD 0x09          /* 32-bit embedded bitfield */
 461 #define EAF_TYPE_INT_SET 0x0a           /* Set of u32's (e.g., a community list) */
 462 #define EAF_TYPE_EC_SET 0x0e            /* Set of pairs of u32's - ext. community list */
 463 #define EAF_TYPE_UNDEF 0x0f             /* `force undefined' entry */
 464 #define EAF_EMBEDDED 0x01               /* Data stored in eattr.u.data (part of type spec) */
 465 #define EAF_VAR_LENGTH 0x02             /* Attribute length is variable (part of type spec) */
 466 #define EAF_ORIGINATED 0x40             /* The attribute has originated locally */
 467 #define EAF_TEMP 0x80                   /* A temporary attribute (the one stored in the tmp attr list) */
 468
 469 struct adata {
 470   uint length;                          /* Length of data */
 471   byte data[0];
 472 };
 473
 474 static inline int adata_same(struct adata *a, struct adata *b)
 475 { return (a->length == b->length && !memcmp(a->data, b->data, a->length)); }
 476
 477
 478 typedef struct ea_list {
 479   struct ea_list *next;                 /* In case we have an override list */
 480   byte flags;                           /* Flags: EALF_... */
 481   byte rfu;
 482   word count;                           /* Number of attributes */
 483   eattr attrs[0];                       /* Attribute definitions themselves */
 484 } ea_list;
 485
 486 #define EALF_SORTED 1                   /* Attributes are sorted by code */
 487 #define EALF_BISECT 2                   /* Use interval bisection for searching */
 488 #define EALF_CACHED 4                   /* Attributes belonging to cached rta */
 489
 490 struct rte_src *rt_find_source(struct proto *p, u32 id);
 491 struct rte_src *rt_get_source(struct proto *p, u32 id);
 492 static inline void rt_lock_source(struct rte_src *src) { src->uc++; }
 493 static inline void rt_unlock_source(struct rte_src *src) { src->uc--; }
 494 void rt_prune_sources(void);
 495
 496 struct ea_walk_state {
 497   ea_list *eattrs;                      /* Ccurrent ea_list, initially set by caller */
 498   eattr *ea;                            /* Current eattr, initially NULL */
 499   u32 visited[4];                       /* Bitfield, limiting max to 128 */
 500 };
 501
 502 eattr *ea_find(ea_list *, unsigned ea);
 503 eattr *ea_walk(struct ea_walk_state *s, uint id, uint max);
 504 int ea_get_int(ea_list *, unsigned ea, int def);
 505 void ea_dump(ea_list *);
 506 void ea_sort(ea_list *);                /* Sort entries in all sub-lists */
 507 unsigned ea_scan(ea_list *);            /* How many bytes do we need for merged ea_list */
 508 void ea_merge(ea_list *from, ea_list *to); /* Merge sub-lists to allocated buffer */
 509 int ea_same(ea_list *x, ea_list *y);    /* Test whether two ea_lists are identical */
 510 uint ea_hash(ea_list *e);       /* Calculate 16-bit hash value */
 511 ea_list *ea_append(ea_list *to, ea_list *what);
 512 void ea_format_bitfield(struct eattr *a, byte *buf, int bufsize, const char **names, int min, int max);
 513
 514 int mpnh__same(struct mpnh *x, struct mpnh *y); /* Compare multipath nexthops */
 515 static inline int mpnh_same(struct mpnh *x, struct mpnh *y)
 516 { return (x == y) || mpnh__same(x, y); }
 517 struct mpnh *mpnh_merge(struct mpnh *x, struct mpnh *y, int rx, int ry, int max, linpool *lp);
 518
 519 void rta_init(void);
 520 rta *rta_lookup(rta *);                 /* Get rta equivalent to this one, uc++ */
 521 static inline int rta_is_cached(rta *r) { return r->aflags & RTAF_CACHED; }
 522 static inline rta *rta_clone(rta *r) { r->uc++; return r; }
 523 void rta__free(rta *r);
 524 static inline void rta_free(rta *r) { if (r && !--r->uc) rta__free(r); }
 525 rta *rta_do_cow(rta *o, linpool *lp);
 526 static inline rta * rta_cow(rta *r, linpool *lp) { return rta_is_cached(r) ? rta_do_cow(r, lp) : r; }
 527 void rta_dump(rta *);
 528 void rta_dump_all(void);
 529 void rta_show(struct cli *, rta *, ea_list *);
 530 void rta_set_recursive_next_hop(rtable *dep, rta *a, rtable *tab, ip_addr *gw, ip_addr *ll);
 531
 532 /*
 533  * rta_set_recursive_next_hop() acquires hostentry from hostcache and fills
 534  * rta->hostentry field.  New hostentry has zero use count. Cached rta locks its
 535  * hostentry (increases its use count), uncached rta does not lock it. Hostentry
 536  * with zero use count is removed asynchronously during host cache update,
 537  * therefore it is safe to hold such hostentry temorarily. Hostentry holds a
 538  * lock for a 'source' rta, mainly to share multipath nexthops.
 539  *
 540  * There is no need to hold a lock for hostentry->dep table, because that table
 541  * contains routes responsible for that hostentry, and therefore is non-empty if
 542  * given hostentry has non-zero use count. If the hostentry has zero use count,
 543  * the entry is removed before dep is referenced.
 544  *
 545  * The protocol responsible for routes with recursive next hops should hold a
 546  * lock for a 'source' table governing that routes (argument tab to
 547  * rta_set_recursive_next_hop()), because its routes reference hostentries
 548  * (through rta) related to the governing table. When all such routes are
 549  * removed, rtas are immediately removed achieving zero uc. Then the 'source'
 550  * table lock could be immediately released, although hostentries may still
 551  * exist - they will be freed together with the 'source' table.
 552  */
 553
 554 static inline void rt_lock_hostentry(struct hostentry *he) { if (he) he->uc++; }
 555 static inline void rt_unlock_hostentry(struct hostentry *he) { if (he) he->uc--; }
 556
 557
 558 extern struct protocol *attr_class_to_protocol[EAP_MAX];
 559
 560 /*
 561  *      Default protocol preferences
 562  */
 563
 564 #define DEF_PREF_DIRECT         240     /* Directly connected */
 565 #define DEF_PREF_STATIC         200     /* Static route */
 566 #define DEF_PREF_OSPF           150     /* OSPF intra-area, inter-area and type 1 external routes */
 567 #define DEF_PREF_RIP            120     /* RIP */
 568 #define DEF_PREF_BGP            100     /* BGP */
 569 #define DEF_PREF_PIPE           70      /* Routes piped from other tables */
 570 #define DEF_PREF_INHERITED      10      /* Routes inherited from other routing daemons */
 571
 572 #if 0
 573
 574 /*
 575  *      Route Origin Authorization
 576  */
 577
 578 struct roa_item {
 579   u32 asn;
 580   byte maxlen;
 581   byte src;
 582   struct roa_item *next;
 583 };
 584
 585 struct roa_node {
 586   struct fib_node n;
 587   struct roa_item *items;
 588   // u32 cached_asn;
 589 };
 590
 591 struct roa_table {
 592   node n;                               /* Node in roa_table_list */
 593   struct fib fib;
 594   char *name;                           /* Name of this ROA table */
 595   struct roa_table_config *cf;          /* Configuration of this ROA table */
 596 };
 597
 598 struct roa_item_config {
 599   ip_addr prefix;
 600   byte pxlen, maxlen;
 601   u32 asn;
 602   struct roa_item_config *next;
 603 };
 604
 605 struct roa_table_config {
 606   node n;                               /* Node in config->rpa_tables */
 607   char *name;                           /* Name of this ROA table */
 608   struct roa_table *table;
 609
 610   struct roa_item_config *roa_items;    /* Preconfigured ROA items */
 611
 612   // char *filename;
 613   // int gc_max_ops;                    /* Maximum number of operations before GC is run */
 614   // int gc_min_time;                   /* Minimum time between two consecutive GC runs */
 615 };
 616
 617 struct roa_show_data {
 618   struct fib_iterator fit;
 619   struct roa_table *table;
 620   ip_addr prefix;
 621   byte pxlen;
 622   byte mode;                            /* ROA_SHOW_* values */
 623   u32 asn;                              /* Filter ASN, 0 -> all */
 624 };
 625
 626 #define ROA_UNKNOWN     0
 627 #define ROA_VALID       1
 628 #define ROA_INVALID     2
 629
 630 #define ROA_SRC_ANY     0
 631 #define ROA_SRC_CONFIG  1
 632 #define ROA_SRC_DYNAMIC 2
 633
 634 #define ROA_SHOW_ALL    0
 635 #define ROA_SHOW_PX     1
 636 #define ROA_SHOW_IN     2
 637 #define ROA_SHOW_FOR    3
 638
 639 extern struct roa_table *roa_table_default;
 640
 641 void roa_add_item(struct roa_table *t, ip_addr prefix, byte pxlen, byte maxlen, u32 asn, byte src);
 642 void roa_delete_item(struct roa_table *t, ip_addr prefix, byte pxlen, byte maxlen, u32 asn, byte src);
 643 void roa_flush(struct roa_table *t, byte src);
 644 byte roa_check(struct roa_table *t, ip_addr prefix, byte pxlen, u32 asn);
 645 struct roa_table_config * roa_new_table_config(struct symbol *s);
 646 void roa_add_item_config(struct roa_table_config *rtc, ip_addr prefix, byte pxlen, byte maxlen, u32 asn);
 647 void roa_init(void);
 648 void roa_preconfig(struct config *c);
 649 void roa_commit(struct config *new, struct config *old);
 650 void roa_show(struct roa_show_data *d);
 651
 652 #endif
 653 #endif