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