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