zebra/rib.h

   1 /*
   2  * Routing Information Base header
   3  * Copyright (C) 1997 Kunihiro Ishiguro
   4  *
   5  * This file is part of GNU Zebra.
   6  *
   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
  10  * later version.
  11  *
  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.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; see the file COPYING; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #ifndef _ZEBRA_RIB_H
  23 #define _ZEBRA_RIB_H
  24
  25 #include "zebra.h"
  26 #include "hook.h"
  27 #include "linklist.h"
  28 #include "prefix.h"
  29 #include "table.h"
  30 #include "queue.h"
  31 #include "nexthop.h"
  32 #include "nexthop_group.h"
  33 #include "vrf.h"
  34 #include "if.h"
  35 #include "mpls.h"
  36 #include "srcdest_table.h"
  37
  38 #define DISTANCE_INFINITY  255
  39 #define ZEBRA_KERNEL_TABLE_MAX 252 /* support for no more than this rt tables */
  40
  41 struct route_entry {
  42         /* Link list. */
  43         struct route_entry *next;
  44         struct route_entry *prev;
  45
  46         /* Nexthop structure */
  47         struct nexthop_group ng;
  48
  49         /* Tag */
  50         route_tag_t tag;
  51
  52         /* Uptime. */
  53         time_t uptime;
  54
  55         /* Type fo this route. */
  56         int type;
  57
  58         /* Source protocol instance */
  59         unsigned short instance;
  60
  61         /* VRF identifier. */
  62         vrf_id_t vrf_id;
  63
  64         /* Which routing table */
  65         uint32_t table;
  66
  67         /* Metric */
  68         uint32_t metric;
  69
  70         /* MTU */
  71         uint32_t mtu;
  72         uint32_t nexthop_mtu;
  73
  74         /* Distance. */
  75         uint8_t distance;
  76
  77         /* Flags of this route.
  78          * This flag's definition is in lib/zebra.h ZEBRA_FLAG_* and is exposed
  79          * to clients via Zserv
  80          */
  81         uint32_t flags;
  82
  83         /* RIB internal status */
  84         uint8_t status;
  85 #define ROUTE_ENTRY_REMOVED          0x1
  86 /* to simplify NHT logic when NHs change, instead of doing a NH by NH cmp */
  87 #define ROUTE_ENTRY_NEXTHOPS_CHANGED 0x2
  88 #define ROUTE_ENTRY_CHANGED          0x4
  89 #define ROUTE_ENTRY_LABELS_CHANGED   0x8
  90
  91         /* Nexthop information. */
  92         uint8_t nexthop_num;
  93         uint8_t nexthop_active_num;
  94 };
  95
  96 /* meta-queue structure:
  97  * sub-queue 0: connected, kernel
  98  * sub-queue 1: static
  99  * sub-queue 2: RIP, RIPng, OSPF, OSPF6, IS-IS, EIGRP, NHRP
 100  * sub-queue 3: iBGP, eBGP
 101  * sub-queue 4: any other origin (if any)
 102  */
 103 #define MQ_SIZE 5
 104 struct meta_queue {
 105         struct list *subq[MQ_SIZE];
 106         uint32_t size; /* sum of lengths of all subqueues */
 107 };
 108
 109 /*
 110  * Structure that represents a single destination (prefix).
 111  */
 112 typedef struct rib_dest_t_ {
 113
 114         /*
 115          * Back pointer to the route node for this destination. This helps
 116          * us get to the prefix that this structure is for.
 117          */
 118         struct route_node *rnode;
 119
 120         /*
 121          * Doubly-linked list of routes for this prefix.
 122          */
 123         struct route_entry *routes;
 124
 125         struct route_entry *selected_fib;
 126
 127         /*
 128          * Flags, see below.
 129          */
 130         uint32_t flags;
 131
 132         /*
 133          * Linkage to put dest on the FPM processing queue.
 134          */
 135         TAILQ_ENTRY(rib_dest_t_) fpm_q_entries;
 136
 137 } rib_dest_t;
 138
 139 #define RIB_ROUTE_QUEUED(x)     (1 << (x))
 140 // If MQ_SIZE is modified this value needs to be updated.
 141 #define RIB_ROUTE_ANY_QUEUED    0x1F
 142
 143 /*
 144  * The maximum qindex that can be used.
 145  */
 146 #define ZEBRA_MAX_QINDEX        (MQ_SIZE - 1)
 147
 148 /*
 149  * This flag indicates that a given prefix has been 'advertised' to
 150  * the FPM to be installed in the forwarding plane.
 151  */
 152 #define RIB_DEST_SENT_TO_FPM   (1 << (ZEBRA_MAX_QINDEX + 1))
 153
 154 /*
 155  * This flag is set when we need to send an update to the FPM about a
 156  * dest.
 157  */
 158 #define RIB_DEST_UPDATE_FPM    (1 << (ZEBRA_MAX_QINDEX + 2))
 159
 160 /*
 161  * Macro to iterate over each route for a destination (prefix).
 162  */
 163 #define RE_DEST_FOREACH_ROUTE(dest, re)                                        \
 164         for ((re) = (dest) ? (dest)->routes : NULL; (re); (re) = (re)->next)
 165
 166 /*
 167  * Same as above, but allows the current node to be unlinked.
 168  */
 169 #define RE_DEST_FOREACH_ROUTE_SAFE(dest, re, next)                             \
 170         for ((re) = (dest) ? (dest)->routes : NULL;                            \
 171              (re) && ((next) = (re)->next, 1); (re) = (next))
 172
 173 #define RNODE_FOREACH_RE(rn, re)                                               \
 174         RE_DEST_FOREACH_ROUTE (rib_dest_from_rnode(rn), re)
 175
 176 #define RNODE_FOREACH_RE_SAFE(rn, re, next)                                    \
 177         RE_DEST_FOREACH_ROUTE_SAFE (rib_dest_from_rnode(rn), re, next)
 178
 179 #if defined(HAVE_RTADV)
 180 /* Structure which hold status of router advertisement. */
 181 struct rtadv {
 182         int sock;
 183
 184         int adv_if_count;
 185         int adv_msec_if_count;
 186
 187         struct thread *ra_read;
 188         struct thread *ra_timer;
 189 };
 190 #endif /* HAVE_RTADV */
 191
 192 /*
 193  * rib_table_info_t
 194  *
 195  * Structure that is hung off of a route_table that holds information about
 196  * the table.
 197  */
 198 typedef struct rib_table_info_t_ {
 199
 200         /*
 201          * Back pointer to zebra_vrf.
 202          */
 203         struct zebra_vrf *zvrf;
 204         afi_t afi;
 205         safi_t safi;
 206
 207 } rib_table_info_t;
 208
 209 typedef enum {
 210         RIB_TABLES_ITER_S_INIT,
 211         RIB_TABLES_ITER_S_ITERATING,
 212         RIB_TABLES_ITER_S_DONE
 213 } rib_tables_iter_state_t;
 214
 215 /*
 216  * Structure that holds state for iterating over all tables in the
 217  * Routing Information Base.
 218  */
 219 typedef struct rib_tables_iter_t_ {
 220         vrf_id_t vrf_id;
 221         int afi_safi_ix;
 222
 223         rib_tables_iter_state_t state;
 224 } rib_tables_iter_t;
 225
 226 /* Events/reasons triggering a RIB update. */
 227 typedef enum {
 228         RIB_UPDATE_IF_CHANGE,
 229         RIB_UPDATE_RMAP_CHANGE,
 230         RIB_UPDATE_OTHER
 231 } rib_update_event_t;
 232
 233 extern struct nexthop *route_entry_nexthop_ifindex_add(struct route_entry *re,
 234                                                        ifindex_t ifindex,
 235                                                        vrf_id_t nh_vrf_id);
 236 extern struct nexthop *
 237 route_entry_nexthop_blackhole_add(struct route_entry *re,
 238                                   enum blackhole_type bh_type);
 239 extern struct nexthop *route_entry_nexthop_ipv4_add(struct route_entry *re,
 240                                                     struct in_addr *ipv4,
 241                                                     struct in_addr *src,
 242                                                     vrf_id_t nh_vrf_id);
 243 extern struct nexthop *
 244 route_entry_nexthop_ipv4_ifindex_add(struct route_entry *re,
 245                                      struct in_addr *ipv4, struct in_addr *src,
 246                                      ifindex_t ifindex, vrf_id_t nh_vrf_id);
 247 extern void route_entry_nexthop_delete(struct route_entry *re,
 248                                        struct nexthop *nexthop);
 249 extern struct nexthop *route_entry_nexthop_ipv6_add(struct route_entry *re,
 250                                                     struct in6_addr *ipv6,
 251                                                     vrf_id_t nh_vrf_id);
 252 extern struct nexthop *
 253 route_entry_nexthop_ipv6_ifindex_add(struct route_entry *re,
 254                                      struct in6_addr *ipv6, ifindex_t ifindex,
 255                                      vrf_id_t nh_vrf_id);
 256 extern void route_entry_nexthop_add(struct route_entry *re,
 257                                     struct nexthop *nexthop);
 258 extern void route_entry_copy_nexthops(struct route_entry *re,
 259                                       struct nexthop *nh);
 260
 261 #define route_entry_dump(prefix, src, re) _route_entry_dump(__func__, prefix, src, re)
 262 extern void _route_entry_dump(const char *func, union prefixconstptr pp,
 263                               union prefixconstptr src_pp,
 264                               const struct route_entry *re);
 265 /* RPF lookup behaviour */
 266 enum multicast_mode {
 267         MCAST_NO_CONFIG = 0,  /* MIX_MRIB_FIRST, but no show in config write */
 268         MCAST_MRIB_ONLY,      /* MRIB only */
 269         MCAST_URIB_ONLY,      /* URIB only */
 270         MCAST_MIX_MRIB_FIRST, /* MRIB, if nothing at all then URIB */
 271         MCAST_MIX_DISTANCE,   /* MRIB & URIB, lower distance wins */
 272         MCAST_MIX_PFXLEN,     /* MRIB & URIB, longer prefix wins */
 273                               /* on equal value, MRIB wins for last 2 */
 274 };
 275
 276 extern void multicast_mode_ipv4_set(enum multicast_mode mode);
 277 extern enum multicast_mode multicast_mode_ipv4_get(void);
 278
 279 extern void rib_lookup_and_dump(struct prefix_ipv4 *p, vrf_id_t vrf_id);
 280 extern void rib_lookup_and_pushup(struct prefix_ipv4 *p, vrf_id_t vrf_id);
 281
 282 extern int rib_lookup_ipv4_route(struct prefix_ipv4 *p, union sockunion *qgate,
 283                                  vrf_id_t vrf_id);
 284 #define ZEBRA_RIB_LOOKUP_ERROR -1
 285 #define ZEBRA_RIB_FOUND_EXACT 0
 286 #define ZEBRA_RIB_FOUND_NOGATE 1
 287 #define ZEBRA_RIB_FOUND_CONNECTED 2
 288 #define ZEBRA_RIB_NOTFOUND 3
 289
 290 extern int is_zebra_valid_kernel_table(uint32_t table_id);
 291 extern int is_zebra_main_routing_table(uint32_t table_id);
 292 extern int zebra_check_addr(struct prefix *p);
 293
 294 extern void rib_addnode(struct route_node *rn, struct route_entry *re,
 295                         int process);
 296 extern void rib_delnode(struct route_node *rn, struct route_entry *re);
 297 extern void rib_install_kernel(struct route_node *rn, struct route_entry *re,
 298                                struct route_entry *old);
 299 extern void rib_uninstall_kernel(struct route_node *rn, struct route_entry *re);
 300
 301 /* NOTE:
 302  * All rib_add function will not just add prefix into RIB, but
 303  * also implicitly withdraw equal prefix of same type. */
 304 extern int rib_add(afi_t afi, safi_t safi, vrf_id_t vrf_id, int type,
 305                    unsigned short instance, int flags, struct prefix *p,
 306                    struct prefix_ipv6 *src_p, const struct nexthop *nh,
 307                    uint32_t table_id, uint32_t metric, uint32_t mtu,
 308                    uint8_t distance, route_tag_t tag);
 309
 310 extern int rib_add_multipath(afi_t afi, safi_t safi, struct prefix *p,
 311                              struct prefix_ipv6 *src_p, struct route_entry *re);
 312
 313 extern void rib_delete(afi_t afi, safi_t safi, vrf_id_t vrf_id, int type,
 314                        unsigned short instance, int flags, struct prefix *p,
 315                        struct prefix_ipv6 *src_p, const struct nexthop *nh,
 316                        uint32_t table_id, uint32_t metric, bool fromkernel,
 317                        struct ethaddr *rmac);
 318
 319 extern struct route_entry *rib_match(afi_t afi, safi_t safi, vrf_id_t vrf_id,
 320                                      union g_addr *addr,
 321                                      struct route_node **rn_out);
 322 extern struct route_entry *rib_match_ipv4_multicast(vrf_id_t vrf_id,
 323                                                     struct in_addr addr,
 324                                                     struct route_node **rn_out);
 325
 326 extern struct route_entry *rib_lookup_ipv4(struct prefix_ipv4 *p,
 327                                            vrf_id_t vrf_id);
 328
 329 extern void rib_update(vrf_id_t vrf_id, rib_update_event_t event);
 330 extern void rib_sweep_route(void);
 331 extern void rib_sweep_table(struct route_table *table);
 332 extern void rib_close_table(struct route_table *table);
 333 extern void rib_init(void);
 334 extern unsigned long rib_score_proto(uint8_t proto, unsigned short instance);
 335 extern unsigned long rib_score_proto_table(uint8_t proto,
 336                                            unsigned short instance,
 337                                            struct route_table *table);
 338 extern void rib_queue_add(struct route_node *rn);
 339 extern void meta_queue_free(struct meta_queue *mq);
 340 extern int zebra_rib_labeled_unicast(struct route_entry *re);
 341 extern struct route_table *rib_table_ipv6;
 342
 343 extern void rib_unlink(struct route_node *rn, struct route_entry *re);
 344 extern int rib_gc_dest(struct route_node *rn);
 345 extern struct route_table *rib_tables_iter_next(rib_tables_iter_t *iter);
 346
 347 extern uint8_t route_distance(int type);
 348
 349 /*
 350  * Inline functions.
 351  */
 352
 353 /*
 354  * rib_table_info
 355  */
 356 static inline rib_table_info_t *rib_table_info(struct route_table *table)
 357 {
 358         return (rib_table_info_t *)table->info;
 359 }
 360
 361 /*
 362  * rib_dest_from_rnode
 363  */
 364 static inline rib_dest_t *rib_dest_from_rnode(struct route_node *rn)
 365 {
 366         return (rib_dest_t *)rn->info;
 367 }
 368
 369 /*
 370  * rnode_to_ribs
 371  *
 372  * Returns a pointer to the list of routes corresponding to the given
 373  * route_node.
 374  */
 375 static inline struct route_entry *rnode_to_ribs(struct route_node *rn)
 376 {
 377         rib_dest_t *dest;
 378
 379         dest = rib_dest_from_rnode(rn);
 380         if (!dest)
 381                 return NULL;
 382
 383         return dest->routes;
 384 }
 385
 386 /*
 387  * rib_dest_prefix
 388  */
 389 static inline struct prefix *rib_dest_prefix(rib_dest_t *dest)
 390 {
 391         return &dest->rnode->p;
 392 }
 393
 394 /*
 395  * rib_dest_af
 396  *
 397  * Returns the address family that the destination is for.
 398  */
 399 static inline uint8_t rib_dest_af(rib_dest_t *dest)
 400 {
 401         return dest->rnode->p.family;
 402 }
 403
 404 /*
 405  * rib_dest_table
 406  */
 407 static inline struct route_table *rib_dest_table(rib_dest_t *dest)
 408 {
 409         return srcdest_rnode_table(dest->rnode);
 410 }
 411
 412 /*
 413  * rib_dest_vrf
 414  */
 415 static inline struct zebra_vrf *rib_dest_vrf(rib_dest_t *dest)
 416 {
 417         return rib_table_info(rib_dest_table(dest))->zvrf;
 418 }
 419
 420 /*
 421  * rib_tables_iter_init
 422  */
 423 static inline void rib_tables_iter_init(rib_tables_iter_t *iter)
 424
 425 {
 426         memset(iter, 0, sizeof(*iter));
 427         iter->state = RIB_TABLES_ITER_S_INIT;
 428 }
 429
 430 /*
 431  * rib_tables_iter_started
 432  *
 433  * Returns TRUE if this iterator has started iterating over the set of
 434  * tables.
 435  */
 436 static inline int rib_tables_iter_started(rib_tables_iter_t *iter)
 437 {
 438         return iter->state != RIB_TABLES_ITER_S_INIT;
 439 }
 440
 441 /*
 442  * rib_tables_iter_cleanup
 443  */
 444 static inline void rib_tables_iter_cleanup(rib_tables_iter_t *iter)
 445 {
 446         iter->state = RIB_TABLES_ITER_S_DONE;
 447 }
 448
 449 DECLARE_HOOK(rib_update, (struct route_node * rn, const char *reason),
 450              (rn, reason))
 451
 452
 453 extern void zebra_vty_init(void);
 454 extern int static_config(struct vty *vty, struct zebra_vrf *zvrf, afi_t afi,
 455                          safi_t safi, const char *cmd);
 456 extern void static_config_install_delayed_routes(struct zebra_vrf *zvrf);
 457
 458 extern pid_t pid;
 459
 460 #endif /*_ZEBRA_RIB_H */