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 "memory.h"
  27 #include "hook.h"
  28 #include "typesafe.h"
  29 #include "linklist.h"
  30 #include "prefix.h"
  31 #include "table.h"
  32 #include "queue.h"
  33 #include "nexthop.h"
  34 #include "nexthop_group.h"
  35 #include "vrf.h"
  36 #include "if.h"
  37 #include "mpls.h"
  38 #include "srcdest_table.h"
  39 #include "zebra/zebra_nhg.h"
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 DECLARE_MGROUP(ZEBRA);
  46
  47 DECLARE_MTYPE(RE);
  48
  49 enum rnh_type { RNH_NEXTHOP_TYPE, RNH_IMPORT_CHECK_TYPE };
  50
  51 PREDECL_LIST(rnh_list);
  52
  53 /* Nexthop structure. */
  54 struct rnh {
  55         uint8_t flags;
  56
  57 #define ZEBRA_NHT_CONNECTED 0x1
  58 #define ZEBRA_NHT_DELETED 0x2
  59 #define ZEBRA_NHT_EXACT_MATCH 0x4
  60 #define ZEBRA_NHT_RESOLVE_VIA_DEFAULT 0x8
  61
  62         /* VRF identifier. */
  63         vrf_id_t vrf_id;
  64
  65         afi_t afi;
  66
  67         enum rnh_type type;
  68
  69         uint32_t seqno;
  70
  71         struct route_entry *state;
  72         struct prefix resolved_route;
  73         struct list *client_list;
  74
  75         /* pseudowires dependent on this nh */
  76         struct list *zebra_pseudowire_list;
  77
  78         struct route_node *node;
  79
  80         /*
  81          * if this has been filtered for the client
  82          */
  83         int filtered[ZEBRA_ROUTE_MAX];
  84
  85         struct rnh_list_item rnh_list_item;
  86 };
  87
  88 #define DISTANCE_INFINITY  255
  89 #define ZEBRA_KERNEL_TABLE_MAX 252 /* support for no more than this rt tables */
  90
  91 PREDECL_LIST(re_list);
  92
  93 struct opaque {
  94         uint16_t length;
  95         uint8_t data[];
  96 };
  97
  98 struct route_entry {
  99         /* Link list. */
 100         struct re_list_item next;
 101
 102         /* Nexthop group, shared/refcounted, based on the nexthop(s)
 103          * provided by the owner of the route
 104          */
 105         struct nhg_hash_entry *nhe;
 106
 107         /* Nexthop group from FIB (optional), reflecting what is actually
 108          * installed in the FIB if that differs. The 'backup' group is used
 109          * when backup nexthops are present in the route's nhg.
 110          */
 111         struct nexthop_group fib_ng;
 112         struct nexthop_group fib_backup_ng;
 113
 114         /* Nexthop group hash entry ID */
 115         uint32_t nhe_id;
 116
 117         /* Tag */
 118         route_tag_t tag;
 119
 120         /* Uptime. */
 121         time_t uptime;
 122
 123         /* Type of this route. */
 124         int type;
 125
 126         /* VRF identifier. */
 127         vrf_id_t vrf_id;
 128
 129         /* Which routing table */
 130         uint32_t table;
 131
 132         /* Metric */
 133         uint32_t metric;
 134
 135         /* MTU */
 136         uint32_t mtu;
 137         uint32_t nexthop_mtu;
 138
 139         /* Flags of this route.
 140          * This flag's definition is in lib/zebra.h ZEBRA_FLAG_* and is exposed
 141          * to clients via Zserv
 142          */
 143         uint32_t flags;
 144
 145         /* RIB internal status */
 146         uint32_t status;
 147 #define ROUTE_ENTRY_REMOVED          0x1
 148 /* The Route Entry has changed */
 149 #define ROUTE_ENTRY_CHANGED          0x2
 150 /* The Label has changed on the Route entry */
 151 #define ROUTE_ENTRY_LABELS_CHANGED   0x4
 152 /* Route is queued for Installation into the Data Plane */
 153 #define ROUTE_ENTRY_QUEUED   0x8
 154 /* Route is installed into the Data Plane */
 155 #define ROUTE_ENTRY_INSTALLED        0x10
 156 /* Route has Failed installation into the Data Plane in some manner */
 157 #define ROUTE_ENTRY_FAILED           0x20
 158 /* Route has a 'fib' set of nexthops, probably because the installed set
 159  * differs from the rib/normal set of nexthops.
 160  */
 161 #define ROUTE_ENTRY_USE_FIB_NHG      0x40
 162
 163         /* Sequence value incremented for each dataplane operation */
 164         uint32_t dplane_sequence;
 165
 166         /* Source protocol instance */
 167         uint16_t instance;
 168
 169         /* Distance. */
 170         uint8_t distance;
 171
 172         struct opaque *opaque;
 173 };
 174
 175 #define RIB_SYSTEM_ROUTE(R) RSYSTEM_ROUTE((R)->type)
 176
 177 #define RIB_KERNEL_ROUTE(R) RKERNEL_ROUTE((R)->type)
 178
 179 /* meta-queue structure:
 180  * sub-queue 0: nexthop group objects
 181  * sub-queue 1: EVPN/VxLAN objects
 182  * sub-queue 2: connected
 183  * sub-queue 3: kernel
 184  * sub-queue 4: static
 185  * sub-queue 5: RIP, RIPng, OSPF, OSPF6, IS-IS, EIGRP, NHRP
 186  * sub-queue 6: iBGP, eBGP
 187  * sub-queue 7: any other origin (if any) typically those that
 188  *              don't generate routes
 189  */
 190 #define MQ_SIZE 8
 191 struct meta_queue {
 192         struct list *subq[MQ_SIZE];
 193         uint32_t size; /* sum of lengths of all subqueues */
 194 };
 195
 196 /*
 197  * Structure that represents a single destination (prefix).
 198  */
 199 typedef struct rib_dest_t_ {
 200
 201         /*
 202          * Back pointer to the route node for this destination. This helps
 203          * us get to the prefix that this structure is for.
 204          */
 205         struct route_node *rnode;
 206
 207         /*
 208          * Doubly-linked list of routes for this prefix.
 209          */
 210         struct re_list_head routes;
 211
 212         struct route_entry *selected_fib;
 213
 214         /*
 215          * Flags, see below.
 216          */
 217         uint32_t flags;
 218
 219         /*
 220          * The list of nht prefixes that have ended up
 221          * depending on this route node.
 222          * After route processing is returned from
 223          * the data plane we will run evaluate_rnh
 224          * on these prefixes.
 225          */
 226         struct rnh_list_head nht;
 227
 228         /*
 229          * Linkage to put dest on the FPM processing queue.
 230          */
 231         TAILQ_ENTRY(rib_dest_t_) fpm_q_entries;
 232
 233 } rib_dest_t;
 234
 235 DECLARE_LIST(rnh_list, struct rnh, rnh_list_item);
 236 DECLARE_LIST(re_list, struct route_entry, next);
 237
 238 #define RIB_ROUTE_QUEUED(x)     (1 << (x))
 239 // If MQ_SIZE is modified this value needs to be updated.
 240 #define RIB_ROUTE_ANY_QUEUED 0x3F
 241
 242 /*
 243  * The maximum qindex that can be used.
 244  */
 245 #define ZEBRA_MAX_QINDEX        (MQ_SIZE - 1)
 246
 247 /*
 248  * This flag indicates that a given prefix has been 'advertised' to
 249  * the FPM to be installed in the forwarding plane.
 250  */
 251 #define RIB_DEST_SENT_TO_FPM   (1 << (ZEBRA_MAX_QINDEX + 1))
 252
 253 /*
 254  * This flag is set when we need to send an update to the FPM about a
 255  * dest.
 256  */
 257 #define RIB_DEST_UPDATE_FPM    (1 << (ZEBRA_MAX_QINDEX + 2))
 258
 259 #define RIB_DEST_UPDATE_LSPS   (1 << (ZEBRA_MAX_QINDEX + 3))
 260
 261 /*
 262  * Macro to iterate over each route for a destination (prefix).
 263  */
 264 #define RE_DEST_FOREACH_ROUTE(dest, re)                                        \
 265         for ((re) = (dest) ? re_list_first(&((dest)->routes)) : NULL; (re);    \
 266              (re) = re_list_next(&((dest)->routes), (re)))
 267
 268 /*
 269  * Same as above, but allows the current node to be unlinked.
 270  */
 271 #define RE_DEST_FOREACH_ROUTE_SAFE(dest, re, next)                             \
 272         for ((re) = (dest) ? re_list_first(&((dest)->routes)) : NULL;          \
 273              (re) && ((next) = re_list_next(&((dest)->routes), (re)), 1);      \
 274              (re) = (next))
 275
 276 #define RE_DEST_FIRST_ROUTE(dest, re)                                          \
 277         ((re) = (dest) ? re_list_first(&((dest)->routes)) : NULL)
 278
 279 #define RE_DEST_NEXT_ROUTE(dest, re)                                           \
 280         ((re) = (dest) ? re_list_next(&((dest)->routes), (re)) : NULL)
 281
 282 #define RNODE_FOREACH_RE(rn, re)                                               \
 283         RE_DEST_FOREACH_ROUTE (rib_dest_from_rnode(rn), re)
 284
 285 #define RNODE_FOREACH_RE_SAFE(rn, re, next)                                    \
 286         RE_DEST_FOREACH_ROUTE_SAFE (rib_dest_from_rnode(rn), re, next)
 287
 288 #define RNODE_FIRST_RE(rn, re) RE_DEST_FIRST_ROUTE(rib_dest_from_rnode(rn), re)
 289
 290 #define RNODE_NEXT_RE(rn, re) RE_DEST_NEXT_ROUTE(rib_dest_from_rnode(rn), re)
 291
 292 #if defined(HAVE_RTADV)
 293 PREDECL_SORTLIST_UNIQ(adv_if_list);
 294 /* Structure which hold status of router advertisement. */
 295 struct rtadv {
 296         int sock;
 297
 298         struct adv_if_list_head adv_if;
 299         struct adv_if_list_head adv_msec_if;
 300
 301         struct thread *ra_read;
 302         struct thread *ra_timer;
 303 };
 304
 305 /* adv list node */
 306 struct adv_if {
 307         char name[INTERFACE_NAMSIZ];
 308         struct adv_if_list_item list_item;
 309 };
 310
 311 static int adv_if_cmp(const struct adv_if *a, const struct adv_if *b)
 312 {
 313         return if_cmp_name_func(a->name, b->name);
 314 }
 315
 316 DECLARE_SORTLIST_UNIQ(adv_if_list, struct adv_if, list_item, adv_if_cmp);
 317 #endif /* HAVE_RTADV */
 318
 319 /*
 320  * rib_table_info_t
 321  *
 322  * Structure that is hung off of a route_table that holds information about
 323  * the table.
 324  */
 325 struct rib_table_info {
 326
 327         /*
 328          * Back pointer to zebra_vrf.
 329          */
 330         struct zebra_vrf *zvrf;
 331         afi_t afi;
 332         safi_t safi;
 333         uint32_t table_id;
 334 };
 335
 336 enum rib_tables_iter_state {
 337         RIB_TABLES_ITER_S_INIT,
 338         RIB_TABLES_ITER_S_ITERATING,
 339         RIB_TABLES_ITER_S_DONE
 340 };
 341
 342 /*
 343  * Structure that holds state for iterating over all tables in the
 344  * Routing Information Base.
 345  */
 346 typedef struct rib_tables_iter_t_ {
 347         vrf_id_t vrf_id;
 348         int afi_safi_ix;
 349
 350         enum rib_tables_iter_state state;
 351 } rib_tables_iter_t;
 352
 353 /* Events/reasons triggering a RIB update. */
 354 enum rib_update_event {
 355         RIB_UPDATE_KERNEL,
 356         RIB_UPDATE_RMAP_CHANGE,
 357         RIB_UPDATE_OTHER,
 358         RIB_UPDATE_MAX
 359 };
 360
 361 extern void route_entry_copy_nexthops(struct route_entry *re,
 362                                       struct nexthop *nh);
 363 int route_entry_update_nhe(struct route_entry *re,
 364                            struct nhg_hash_entry *new_nhghe);
 365
 366 /* NHG replace has happend, we have to update route_entry pointers to new one */
 367 void rib_handle_nhg_replace(struct nhg_hash_entry *old_entry,
 368                             struct nhg_hash_entry *new_entry);
 369
 370 #define route_entry_dump(prefix, src, re) _route_entry_dump(__func__, prefix, src, re)
 371 extern void _route_entry_dump(const char *func, union prefixconstptr pp,
 372                               union prefixconstptr src_pp,
 373                               const struct route_entry *re);
 374
 375 #define ZEBRA_RIB_LOOKUP_ERROR -1
 376 #define ZEBRA_RIB_FOUND_EXACT 0
 377 #define ZEBRA_RIB_FOUND_NOGATE 1
 378 #define ZEBRA_RIB_FOUND_CONNECTED 2
 379 #define ZEBRA_RIB_NOTFOUND 3
 380
 381 extern int is_zebra_valid_kernel_table(uint32_t table_id);
 382 extern int is_zebra_main_routing_table(uint32_t table_id);
 383 extern int zebra_check_addr(const struct prefix *p);
 384
 385 extern void rib_delnode(struct route_node *rn, struct route_entry *re);
 386 extern void rib_install_kernel(struct route_node *rn, struct route_entry *re,
 387                                struct route_entry *old);
 388 extern void rib_uninstall_kernel(struct route_node *rn, struct route_entry *re);
 389
 390 /* NOTE:
 391  * All rib_add function will not just add prefix into RIB, but
 392  * also implicitly withdraw equal prefix of same type. */
 393 extern int rib_add(afi_t afi, safi_t safi, vrf_id_t vrf_id, int type,
 394                    unsigned short instance, uint32_t flags, struct prefix *p,
 395                    struct prefix_ipv6 *src_p, const struct nexthop *nh,
 396                    uint32_t nhe_id, uint32_t table_id, uint32_t metric,
 397                    uint32_t mtu, uint8_t distance, route_tag_t tag);
 398 /*
 399  * Multipath route apis.
 400  */
 401 extern int rib_add_multipath(afi_t afi, safi_t safi, struct prefix *p,
 402                              struct prefix_ipv6 *src_p, struct route_entry *re,
 403                              struct nexthop_group *ng);
 404 /*
 405  * -1 -> some sort of error
 406  *  0 -> an add
 407  *  1 -> an update
 408  */
 409 extern int rib_add_multipath_nhe(afi_t afi, safi_t safi, struct prefix *p,
 410                                  struct prefix_ipv6 *src_p,
 411                                  struct route_entry *re,
 412                                  struct nhg_hash_entry *nhe);
 413
 414 extern void rib_delete(afi_t afi, safi_t safi, vrf_id_t vrf_id, int type,
 415                        unsigned short instance, uint32_t flags,
 416                        struct prefix *p, struct prefix_ipv6 *src_p,
 417                        const struct nexthop *nh, uint32_t nhe_id,
 418                        uint32_t table_id, uint32_t metric, uint8_t distance,
 419                        bool fromkernel);
 420
 421 extern struct route_entry *rib_match(afi_t afi, safi_t safi, vrf_id_t vrf_id,
 422                                      const union g_addr *addr,
 423                                      struct route_node **rn_out);
 424 extern struct route_entry *rib_match_ipv4_multicast(vrf_id_t vrf_id,
 425                                                     struct in_addr addr,
 426                                                     struct route_node **rn_out);
 427
 428 extern struct route_entry *rib_lookup_ipv4(struct prefix_ipv4 *p,
 429                                            vrf_id_t vrf_id);
 430
 431 extern void rib_update(enum rib_update_event event);
 432 extern void rib_update_table(struct route_table *table,
 433                              enum rib_update_event event, int rtype);
 434 extern int rib_sweep_route(struct thread *t);
 435 extern void rib_sweep_table(struct route_table *table);
 436 extern void rib_close_table(struct route_table *table);
 437 extern void rib_init(void);
 438 extern unsigned long rib_score_proto(uint8_t proto, unsigned short instance);
 439 extern unsigned long rib_score_proto_table(uint8_t proto,
 440                                            unsigned short instance,
 441                                            struct route_table *table);
 442
 443 extern int rib_queue_add(struct route_node *rn);
 444
 445 struct nhg_ctx; /* Forward declaration */
 446
 447 /* Enqueue incoming nhg from OS for processing */
 448 extern int rib_queue_nhg_ctx_add(struct nhg_ctx *ctx);
 449
 450 /* Enqueue incoming nhg from proto daemon for processing */
 451 extern int rib_queue_nhe_add(struct nhg_hash_entry *nhe);
 452
 453 /* Enqueue evpn route for processing */
 454 int zebra_rib_queue_evpn_route_add(vrf_id_t vrf_id, const struct ethaddr *rmac,
 455                                    const struct ipaddr *vtep_ip,
 456                                    const struct prefix *host_prefix);
 457 int zebra_rib_queue_evpn_route_del(vrf_id_t vrf_id,
 458                                    const struct ipaddr *vtep_ip,
 459                                    const struct prefix *host_prefix);
 460 /* Enqueue EVPN remote ES for processing */
 461 int zebra_rib_queue_evpn_rem_es_add(const esi_t *esi,
 462                                     const struct in_addr *vtep_ip,
 463                                     bool esr_rxed, uint8_t df_alg,
 464                                     uint16_t df_pref);
 465 int zebra_rib_queue_evpn_rem_es_del(const esi_t *esi,
 466                                     const struct in_addr *vtep_ip);
 467 /* Enqueue EVPN remote macip update for processing */
 468 int zebra_rib_queue_evpn_rem_macip_del(vni_t vni, const struct ethaddr *macaddr,
 469                                        const struct ipaddr *ip,
 470                                        struct in_addr vtep_ip);
 471 int zebra_rib_queue_evpn_rem_macip_add(vni_t vni, const struct ethaddr *macaddr,
 472                                        const struct ipaddr *ipaddr,
 473                                        uint8_t flags, uint32_t seq,
 474                                        struct in_addr vtep_ip,
 475                                        const esi_t *esi);
 476 /* Enqueue VXLAN remote vtep update for processing */
 477 int zebra_rib_queue_evpn_rem_vtep_add(vrf_id_t vrf_id, vni_t vni,
 478                                       struct in_addr vtep_ip,
 479                                       int flood_control);
 480 int zebra_rib_queue_evpn_rem_vtep_del(vrf_id_t vrf_id, vni_t vni,
 481                                       struct in_addr vtep_ip);
 482
 483 extern void meta_queue_free(struct meta_queue *mq);
 484 extern int zebra_rib_labeled_unicast(struct route_entry *re);
 485 extern struct route_table *rib_table_ipv6;
 486
 487 extern void rib_unlink(struct route_node *rn, struct route_entry *re);
 488 extern int rib_gc_dest(struct route_node *rn);
 489 extern struct route_table *rib_tables_iter_next(rib_tables_iter_t *iter);
 490
 491 extern uint8_t route_distance(int type);
 492
 493 extern void zebra_rib_evaluate_rn_nexthops(struct route_node *rn, uint32_t seq);
 494
 495 /*
 496  * Inline functions.
 497  */
 498
 499 /*
 500  * rib_table_info
 501  */
 502 static inline struct rib_table_info *rib_table_info(struct route_table *table)
 503 {
 504         return (struct rib_table_info *)route_table_get_info(table);
 505 }
 506
 507 /*
 508  * rib_dest_from_rnode
 509  */
 510 static inline rib_dest_t *rib_dest_from_rnode(struct route_node *rn)
 511 {
 512         return (rib_dest_t *)rn->info;
 513 }
 514
 515 /*
 516  * rnode_to_ribs
 517  *
 518  * Returns a pointer to the list of routes corresponding to the given
 519  * route_node.
 520  */
 521 static inline struct route_entry *rnode_to_ribs(struct route_node *rn)
 522 {
 523         rib_dest_t *dest;
 524
 525         dest = rib_dest_from_rnode(rn);
 526         if (!dest)
 527                 return NULL;
 528
 529         return re_list_first(&dest->routes);
 530 }
 531
 532 /*
 533  * rib_dest_prefix
 534  */
 535 static inline struct prefix *rib_dest_prefix(rib_dest_t *dest)
 536 {
 537         return &dest->rnode->p;
 538 }
 539
 540 /*
 541  * rib_dest_af
 542  *
 543  * Returns the address family that the destination is for.
 544  */
 545 static inline uint8_t rib_dest_af(rib_dest_t *dest)
 546 {
 547         return dest->rnode->p.family;
 548 }
 549
 550 /*
 551  * rib_dest_table
 552  */
 553 static inline struct route_table *rib_dest_table(rib_dest_t *dest)
 554 {
 555         return srcdest_rnode_table(dest->rnode);
 556 }
 557
 558 /*
 559  * rib_dest_vrf
 560  */
 561 static inline struct zebra_vrf *rib_dest_vrf(rib_dest_t *dest)
 562 {
 563         return rib_table_info(rib_dest_table(dest))->zvrf;
 564 }
 565
 566 /*
 567  * Create the rib_dest_t and attach it to the specified node
 568  */
 569 extern rib_dest_t *zebra_rib_create_dest(struct route_node *rn);
 570
 571 /*
 572  * rib_tables_iter_init
 573  */
 574 static inline void rib_tables_iter_init(rib_tables_iter_t *iter)
 575
 576 {
 577         memset(iter, 0, sizeof(*iter));
 578         iter->state = RIB_TABLES_ITER_S_INIT;
 579 }
 580
 581 /*
 582  * rib_tables_iter_started
 583  *
 584  * Returns true if this iterator has started iterating over the set of
 585  * tables.
 586  */
 587 static inline int rib_tables_iter_started(rib_tables_iter_t *iter)
 588 {
 589         return iter->state != RIB_TABLES_ITER_S_INIT;
 590 }
 591
 592 /*
 593  * rib_tables_iter_cleanup
 594  */
 595 static inline void rib_tables_iter_cleanup(rib_tables_iter_t *iter)
 596 {
 597         iter->state = RIB_TABLES_ITER_S_DONE;
 598 }
 599
 600 DECLARE_HOOK(rib_update, (struct route_node * rn, const char *reason),
 601              (rn, reason));
 602
 603 /*
 604  * Access installed/fib nexthops, which may be a subset of the
 605  * rib nexthops.
 606  */
 607 static inline struct nexthop_group *rib_get_fib_nhg(struct route_entry *re)
 608 {
 609         /* If the fib set is a subset of the active rib set,
 610          * use the dedicated fib list.
 611          */
 612         if (CHECK_FLAG(re->status, ROUTE_ENTRY_USE_FIB_NHG))
 613                 return &(re->fib_ng);
 614         else
 615                 return &(re->nhe->nhg);
 616 }
 617
 618 /*
 619  * Access backup nexthop-group that represents the installed backup nexthops;
 620  * any installed backup will be on the fib list.
 621  */
 622 static inline struct nexthop_group *rib_get_fib_backup_nhg(
 623         struct route_entry *re)
 624 {
 625         return &(re->fib_backup_ng);
 626 }
 627
 628 extern void zebra_vty_init(void);
 629
 630 extern pid_t pid;
 631
 632 extern bool v6_rr_semantics;
 633
 634 #ifdef __cplusplus
 635 }
 636 #endif
 637
 638 #endif /*_ZEBRA_RIB_H */