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