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