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