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 "typesafe.h"
  28 #include "linklist.h"
  29 #include "prefix.h"
  30 #include "table.h"
  31 #include "queue.h"
  32 #include "nexthop.h"
  33 #include "nexthop_group.h"
  34 #include "vrf.h"
  35 #include "if.h"
  36 #include "mpls.h"
  37 #include "srcdest_table.h"
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 typedef enum { RNH_NEXTHOP_TYPE, RNH_IMPORT_CHECK_TYPE } rnh_type_t;
  44
  45 PREDECL_LIST(rnh_list)
  46
  47 /* Nexthop structure. */
  48 struct rnh {
  49         uint8_t flags;
  50
  51 #define ZEBRA_NHT_CONNECTED     0x1
  52 #define ZEBRA_NHT_DELETED       0x2
  53 #define ZEBRA_NHT_EXACT_MATCH   0x4
  54
  55         /* VRF identifier. */
  56         vrf_id_t vrf_id;
  57
  58         afi_t afi;
  59
  60         rnh_type_t type;
  61
  62         uint32_t seqno;
  63
  64         struct route_entry *state;
  65         struct prefix resolved_route;
  66         struct list *client_list;
  67
  68         /* pseudowires dependent on this nh */
  69         struct list *zebra_pseudowire_list;
  70
  71         struct route_node *node;
  72
  73         /*
  74          * if this has been filtered for the client
  75          */
  76         int filtered[ZEBRA_ROUTE_MAX];
  77
  78         struct rnh_list_item rnh_list_item;
  79 };
  80
  81 #define DISTANCE_INFINITY  255
  82 #define ZEBRA_KERNEL_TABLE_MAX 252 /* support for no more than this rt tables */
  83
  84 PREDECL_LIST(re_list)
  85
  86 struct route_entry {
  87         /* Link list. */
  88         struct re_list_item next;
  89
  90         /* Nexthop structure (from RIB) */
  91         struct nexthop_group ng;
  92
  93         /* Nexthop group from FIB (optional) */
  94         struct nexthop_group fib_ng;
  95
  96         /* Tag */
  97         route_tag_t tag;
  98
  99         /* Uptime. */
 100         time_t uptime;
 101
 102         /* Type fo this route. */
 103         int type;
 104
 105         /* VRF identifier. */
 106         vrf_id_t vrf_id;
 107
 108         /* Which routing table */
 109         uint32_t table;
 110
 111         /* Metric */
 112         uint32_t metric;
 113
 114         /* MTU */
 115         uint32_t mtu;
 116         uint32_t nexthop_mtu;
 117
 118         /* Flags of this route.
 119          * This flag's definition is in lib/zebra.h ZEBRA_FLAG_* and is exposed
 120          * to clients via Zserv
 121          */
 122         uint32_t flags;
 123
 124         /* RIB internal status */
 125         uint32_t status;
 126 #define ROUTE_ENTRY_REMOVED          0x1
 127 /* to simplify NHT logic when NHs change, instead of doing a NH by NH cmp */
 128 #define ROUTE_ENTRY_NEXTHOPS_CHANGED 0x2
 129 /* The Route Entry has changed */
 130 #define ROUTE_ENTRY_CHANGED          0x4
 131 /* The Label has changed on the Route entry */
 132 #define ROUTE_ENTRY_LABELS_CHANGED   0x8
 133 /* Route is queued for Installation into the Data Plane */
 134 #define ROUTE_ENTRY_QUEUED   0x10
 135 /* Route is installed into the Data Plane */
 136 #define ROUTE_ENTRY_INSTALLED        0x20
 137 /* Route has Failed installation into the Data Plane in some manner */
 138 #define ROUTE_ENTRY_FAILED           0x40
 139
 140         /* Nexthop information. */
 141         uint8_t nexthop_num;
 142         uint8_t nexthop_active_num;
 143
 144         /* Sequence value incremented for each dataplane operation */
 145         uint32_t dplane_sequence;
 146
 147         /* Source protocol instance */
 148         uint16_t instance;
 149
 150         /* Distance. */
 151         uint8_t distance;
 152 };
 153
 154 #define RIB_SYSTEM_ROUTE(R) RSYSTEM_ROUTE((R)->type)
 155
 156 #define RIB_KERNEL_ROUTE(R) RKERNEL_ROUTE((R)->type)
 157
 158 /* meta-queue structure:
 159  * sub-queue 0: connected, kernel
 160  * sub-queue 1: static
 161  * sub-queue 2: RIP, RIPng, OSPF, OSPF6, IS-IS, EIGRP, NHRP
 162  * sub-queue 3: iBGP, eBGP
 163  * sub-queue 4: any other origin (if any)
 164  */
 165 #define MQ_SIZE 5
 166 struct meta_queue {
 167         struct list *subq[MQ_SIZE];
 168         uint32_t size; /* sum of lengths of all subqueues */
 169 };
 170
 171 /*
 172  * Structure that represents a single destination (prefix).
 173  */
 174 typedef struct rib_dest_t_ {
 175
 176         /*
 177          * Back pointer to the route node for this destination. This helps
 178          * us get to the prefix that this structure is for.
 179          */
 180         struct route_node *rnode;
 181
 182         /*
 183          * Doubly-linked list of routes for this prefix.
 184          */
 185         struct re_list_head routes;
 186
 187         struct route_entry *selected_fib;
 188
 189         /*
 190          * Flags, see below.
 191          */
 192         uint32_t flags;
 193
 194         /*
 195          * The list of nht prefixes that have ended up
 196          * depending on this route node.
 197          * After route processing is returned from
 198          * the data plane we will run evaluate_rnh
 199          * on these prefixes.
 200          */
 201         struct rnh_list_head nht;
 202
 203         /*
 204          * Linkage to put dest on the FPM processing queue.
 205          */
 206         TAILQ_ENTRY(rib_dest_t_) fpm_q_entries;
 207
 208 } rib_dest_t;
 209
 210 DECLARE_LIST(rnh_list, struct rnh, rnh_list_item);
 211 DECLARE_LIST(re_list, struct route_entry, next);
 212
 213 #define RIB_ROUTE_QUEUED(x)     (1 << (x))
 214 // If MQ_SIZE is modified this value needs to be updated.
 215 #define RIB_ROUTE_ANY_QUEUED    0x1F
 216
 217 /*
 218  * The maximum qindex that can be used.
 219  */
 220 #define ZEBRA_MAX_QINDEX        (MQ_SIZE - 1)
 221
 222 /*
 223  * This flag indicates that a given prefix has been 'advertised' to
 224  * the FPM to be installed in the forwarding plane.
 225  */
 226 #define RIB_DEST_SENT_TO_FPM   (1 << (ZEBRA_MAX_QINDEX + 1))
 227
 228 /*
 229  * This flag is set when we need to send an update to the FPM about a
 230  * dest.
 231  */
 232 #define RIB_DEST_UPDATE_FPM    (1 << (ZEBRA_MAX_QINDEX + 2))
 233
 234 #define RIB_DEST_UPDATE_LSPS   (1 << (ZEBRA_MAX_QINDEX + 3))
 235
 236 /*
 237  * Macro to iterate over each route for a destination (prefix).
 238  */
 239 #define RE_DEST_FOREACH_ROUTE(dest, re)                                        \
 240         for ((re) = (dest) ? re_list_first(&((dest)->routes)) : NULL; (re);    \
 241              (re) = re_list_next(&((dest)->routes), (re)))
 242
 243 /*
 244  * Same as above, but allows the current node to be unlinked.
 245  */
 246 #define RE_DEST_FOREACH_ROUTE_SAFE(dest, re, next)                             \
 247         for ((re) = (dest) ? re_list_first(&((dest)->routes)) : NULL;          \
 248              (re) && ((next) = re_list_next(&((dest)->routes), (re)), 1);      \
 249              (re) = (next))
 250
 251 #define RNODE_FOREACH_RE(rn, re)                                               \
 252         RE_DEST_FOREACH_ROUTE (rib_dest_from_rnode(rn), re)
 253
 254 #define RNODE_FOREACH_RE_SAFE(rn, re, next)                                    \
 255         RE_DEST_FOREACH_ROUTE_SAFE (rib_dest_from_rnode(rn), re, next)
 256
 257 #if defined(HAVE_RTADV)
 258 /* Structure which hold status of router advertisement. */
 259 struct rtadv {
 260         int sock;
 261
 262         int adv_if_count;
 263         int adv_msec_if_count;
 264
 265         struct thread *ra_read;
 266         struct thread *ra_timer;
 267 };
 268 #endif /* HAVE_RTADV */
 269
 270 /*
 271  * rib_table_info_t
 272  *
 273  * Structure that is hung off of a route_table that holds information about
 274  * the table.
 275  */
 276 typedef struct rib_table_info_t_ {
 277
 278         /*
 279          * Back pointer to zebra_vrf.
 280          */
 281         struct zebra_vrf *zvrf;
 282         afi_t afi;
 283         safi_t safi;
 284
 285 } rib_table_info_t;
 286
 287 typedef enum {
 288         RIB_TABLES_ITER_S_INIT,
 289         RIB_TABLES_ITER_S_ITERATING,
 290         RIB_TABLES_ITER_S_DONE
 291 } rib_tables_iter_state_t;
 292
 293 /*
 294  * Structure that holds state for iterating over all tables in the
 295  * Routing Information Base.
 296  */
 297 typedef struct rib_tables_iter_t_ {
 298         vrf_id_t vrf_id;
 299         int afi_safi_ix;
 300
 301         rib_tables_iter_state_t state;
 302 } rib_tables_iter_t;
 303
 304 /* Events/reasons triggering a RIB update. */
 305 typedef enum {
 306         RIB_UPDATE_IF_CHANGE,
 307         RIB_UPDATE_RMAP_CHANGE,
 308         RIB_UPDATE_OTHER
 309 } rib_update_event_t;
 310
 311 extern struct nexthop *route_entry_nexthop_ifindex_add(struct route_entry *re,
 312                                                        ifindex_t ifindex,
 313                                                        vrf_id_t nh_vrf_id);
 314 extern struct nexthop *
 315 route_entry_nexthop_blackhole_add(struct route_entry *re,
 316                                   enum blackhole_type bh_type);
 317 extern struct nexthop *route_entry_nexthop_ipv4_add(struct route_entry *re,
 318                                                     struct in_addr *ipv4,
 319                                                     struct in_addr *src,
 320                                                     vrf_id_t nh_vrf_id);
 321 extern struct nexthop *
 322 route_entry_nexthop_ipv4_ifindex_add(struct route_entry *re,
 323                                      struct in_addr *ipv4, struct in_addr *src,
 324                                      ifindex_t ifindex, vrf_id_t nh_vrf_id);
 325 extern void route_entry_nexthop_delete(struct route_entry *re,
 326                                        struct nexthop *nexthop);
 327 extern struct nexthop *route_entry_nexthop_ipv6_add(struct route_entry *re,
 328                                                     struct in6_addr *ipv6,
 329                                                     vrf_id_t nh_vrf_id);
 330 extern struct nexthop *
 331 route_entry_nexthop_ipv6_ifindex_add(struct route_entry *re,
 332                                      struct in6_addr *ipv6, ifindex_t ifindex,
 333                                      vrf_id_t nh_vrf_id);
 334 extern void route_entry_nexthop_add(struct route_entry *re,
 335                                     struct nexthop *nexthop);
 336 extern void route_entry_copy_nexthops(struct route_entry *re,
 337                                       struct nexthop *nh);
 338
 339 #define route_entry_dump(prefix, src, re) _route_entry_dump(__func__, prefix, src, re)
 340 extern void _route_entry_dump(const char *func, union prefixconstptr pp,
 341                               union prefixconstptr src_pp,
 342                               const struct route_entry *re);
 343 /* RPF lookup behaviour */
 344 enum multicast_mode {
 345         MCAST_NO_CONFIG = 0,  /* MIX_MRIB_FIRST, but no show in config write */
 346         MCAST_MRIB_ONLY,      /* MRIB only */
 347         MCAST_URIB_ONLY,      /* URIB only */
 348         MCAST_MIX_MRIB_FIRST, /* MRIB, if nothing at all then URIB */
 349         MCAST_MIX_DISTANCE,   /* MRIB & URIB, lower distance wins */
 350         MCAST_MIX_PFXLEN,     /* MRIB & URIB, longer prefix wins */
 351                               /* on equal value, MRIB wins for last 2 */
 352 };
 353
 354 extern void multicast_mode_ipv4_set(enum multicast_mode mode);
 355 extern enum multicast_mode multicast_mode_ipv4_get(void);
 356
 357 extern void rib_lookup_and_dump(struct prefix_ipv4 *p, vrf_id_t vrf_id);
 358 extern void rib_lookup_and_pushup(struct prefix_ipv4 *p, vrf_id_t vrf_id);
 359
 360 #define ZEBRA_RIB_LOOKUP_ERROR -1
 361 #define ZEBRA_RIB_FOUND_EXACT 0
 362 #define ZEBRA_RIB_FOUND_NOGATE 1
 363 #define ZEBRA_RIB_FOUND_CONNECTED 2
 364 #define ZEBRA_RIB_NOTFOUND 3
 365
 366 extern int is_zebra_valid_kernel_table(uint32_t table_id);
 367 extern int is_zebra_main_routing_table(uint32_t table_id);
 368 extern int zebra_check_addr(const struct prefix *p);
 369
 370 extern void rib_delnode(struct route_node *rn, struct route_entry *re);
 371 extern void rib_install_kernel(struct route_node *rn, struct route_entry *re,
 372                                struct route_entry *old);
 373 extern void rib_uninstall_kernel(struct route_node *rn, struct route_entry *re);
 374
 375 /* NOTE:
 376  * All rib_add function will not just add prefix into RIB, but
 377  * also implicitly withdraw equal prefix of same type. */
 378 extern int rib_add(afi_t afi, safi_t safi, vrf_id_t vrf_id, int type,
 379                    unsigned short instance, int flags, struct prefix *p,
 380                    struct prefix_ipv6 *src_p, const struct nexthop *nh,
 381                    uint32_t table_id, uint32_t metric, uint32_t mtu,
 382                    uint8_t distance, route_tag_t tag);
 383
 384 extern int rib_add_multipath(afi_t afi, safi_t safi, struct prefix *p,
 385                              struct prefix_ipv6 *src_p, struct route_entry *re);
 386
 387 extern void rib_delete(afi_t afi, safi_t safi, vrf_id_t vrf_id, int type,
 388                        unsigned short instance, int flags, struct prefix *p,
 389                        struct prefix_ipv6 *src_p, const struct nexthop *nh,
 390                        uint32_t table_id, uint32_t metric, uint8_t distance,
 391                        bool fromkernel);
 392
 393 extern struct route_entry *rib_match(afi_t afi, safi_t safi, vrf_id_t vrf_id,
 394                                      union g_addr *addr,
 395                                      struct route_node **rn_out);
 396 extern struct route_entry *rib_match_ipv4_multicast(vrf_id_t vrf_id,
 397                                                     struct in_addr addr,
 398                                                     struct route_node **rn_out);
 399
 400 extern struct route_entry *rib_lookup_ipv4(struct prefix_ipv4 *p,
 401                                            vrf_id_t vrf_id);
 402
 403 extern void rib_update(vrf_id_t vrf_id, rib_update_event_t event);
 404 extern void rib_update_table(struct route_table *table,
 405                              rib_update_event_t event);
 406 extern int rib_sweep_route(struct thread *t);
 407 extern void rib_sweep_table(struct route_table *table);
 408 extern void rib_close_table(struct route_table *table);
 409 extern void rib_init(void);
 410 extern unsigned long rib_score_proto(uint8_t proto, unsigned short instance);
 411 extern unsigned long rib_score_proto_table(uint8_t proto,
 412                                            unsigned short instance,
 413                                            struct route_table *table);
 414 extern void rib_queue_add(struct route_node *rn);
 415 extern void meta_queue_free(struct meta_queue *mq);
 416 extern int zebra_rib_labeled_unicast(struct route_entry *re);
 417 extern struct route_table *rib_table_ipv6;
 418
 419 extern void rib_unlink(struct route_node *rn, struct route_entry *re);
 420 extern int rib_gc_dest(struct route_node *rn);
 421 extern struct route_table *rib_tables_iter_next(rib_tables_iter_t *iter);
 422
 423 extern uint8_t route_distance(int type);
 424
 425 extern void zebra_rib_evaluate_rn_nexthops(struct route_node *rn, uint32_t seq);
 426
 427 /*
 428  * Inline functions.
 429  */
 430
 431 /*
 432  * rib_table_info
 433  */
 434 static inline rib_table_info_t *rib_table_info(struct route_table *table)
 435 {
 436         return (rib_table_info_t *)route_table_get_info(table);
 437 }
 438
 439 /*
 440  * rib_dest_from_rnode
 441  */
 442 static inline rib_dest_t *rib_dest_from_rnode(struct route_node *rn)
 443 {
 444         return (rib_dest_t *)rn->info;
 445 }
 446
 447 /*
 448  * rnode_to_ribs
 449  *
 450  * Returns a pointer to the list of routes corresponding to the given
 451  * route_node.
 452  */
 453 static inline struct route_entry *rnode_to_ribs(struct route_node *rn)
 454 {
 455         rib_dest_t *dest;
 456
 457         dest = rib_dest_from_rnode(rn);
 458         if (!dest)
 459                 return NULL;
 460
 461         return re_list_first(&dest->routes);
 462 }
 463
 464 /*
 465  * rib_dest_prefix
 466  */
 467 static inline struct prefix *rib_dest_prefix(rib_dest_t *dest)
 468 {
 469         return &dest->rnode->p;
 470 }
 471
 472 /*
 473  * rib_dest_af
 474  *
 475  * Returns the address family that the destination is for.
 476  */
 477 static inline uint8_t rib_dest_af(rib_dest_t *dest)
 478 {
 479         return dest->rnode->p.family;
 480 }
 481
 482 /*
 483  * rib_dest_table
 484  */
 485 static inline struct route_table *rib_dest_table(rib_dest_t *dest)
 486 {
 487         return srcdest_rnode_table(dest->rnode);
 488 }
 489
 490 /*
 491  * rib_dest_vrf
 492  */
 493 static inline struct zebra_vrf *rib_dest_vrf(rib_dest_t *dest)
 494 {
 495         return rib_table_info(rib_dest_table(dest))->zvrf;
 496 }
 497
 498 /*
 499  * Create the rib_dest_t and attach it to the specified node
 500  */
 501 extern rib_dest_t *zebra_rib_create_dest(struct route_node *rn);
 502
 503 /*
 504  * rib_tables_iter_init
 505  */
 506 static inline void rib_tables_iter_init(rib_tables_iter_t *iter)
 507
 508 {
 509         memset(iter, 0, sizeof(*iter));
 510         iter->state = RIB_TABLES_ITER_S_INIT;
 511 }
 512
 513 /*
 514  * rib_tables_iter_started
 515  *
 516  * Returns TRUE if this iterator has started iterating over the set of
 517  * tables.
 518  */
 519 static inline int rib_tables_iter_started(rib_tables_iter_t *iter)
 520 {
 521         return iter->state != RIB_TABLES_ITER_S_INIT;
 522 }
 523
 524 /*
 525  * rib_tables_iter_cleanup
 526  */
 527 static inline void rib_tables_iter_cleanup(rib_tables_iter_t *iter)
 528 {
 529         iter->state = RIB_TABLES_ITER_S_DONE;
 530 }
 531
 532 DECLARE_HOOK(rib_update, (struct route_node * rn, const char *reason),
 533              (rn, reason))
 534
 535 /*
 536  * Access active nexthop-group, either RIB or FIB version
 537  */
 538 static inline struct nexthop_group *rib_active_nhg(struct route_entry *re)
 539 {
 540         if (re->fib_ng.nexthop)
 541                 return &(re->fib_ng);
 542         else
 543                 return &(re->ng);
 544 }
 545
 546 extern void zebra_vty_init(void);
 547
 548 extern pid_t pid;
 549
 550 extern bool v6_rr_semantics;
 551
 552 #ifdef __cplusplus
 553 }
 554 #endif
 555
 556 #endif /*_ZEBRA_RIB_H */