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          * Linkage to put dest on the FPM processing queue.
 149          */
 150         TAILQ_ENTRY(rib_dest_t_) fpm_q_entries;
 151
 152 } rib_dest_t;
 153
 154 #define RIB_ROUTE_QUEUED(x)     (1 << (x))
 155 // If MQ_SIZE is modified this value needs to be updated.
 156 #define RIB_ROUTE_ANY_QUEUED    0x1F
 157
 158 /*
 159  * The maximum qindex that can be used.
 160  */
 161 #define ZEBRA_MAX_QINDEX        (MQ_SIZE - 1)
 162
 163 /*
 164  * This flag indicates that a given prefix has been 'advertised' to
 165  * the FPM to be installed in the forwarding plane.
 166  */
 167 #define RIB_DEST_SENT_TO_FPM   (1 << (ZEBRA_MAX_QINDEX + 1))
 168
 169 /*
 170  * This flag is set when we need to send an update to the FPM about a
 171  * dest.
 172  */
 173 #define RIB_DEST_UPDATE_FPM    (1 << (ZEBRA_MAX_QINDEX + 2))
 174
 175 /*
 176  * Macro to iterate over each route for a destination (prefix).
 177  */
 178 #define RE_DEST_FOREACH_ROUTE(dest, re)                                        \
 179         for ((re) = (dest) ? (dest)->routes : NULL; (re); (re) = (re)->next)
 180
 181 /*
 182  * Same as above, but allows the current node to be unlinked.
 183  */
 184 #define RE_DEST_FOREACH_ROUTE_SAFE(dest, re, next)                             \
 185         for ((re) = (dest) ? (dest)->routes : NULL;                            \
 186              (re) && ((next) = (re)->next, 1); (re) = (next))
 187
 188 #define RNODE_FOREACH_RE(rn, re)                                               \
 189         RE_DEST_FOREACH_ROUTE (rib_dest_from_rnode(rn), re)
 190
 191 #define RNODE_FOREACH_RE_SAFE(rn, re, next)                                    \
 192         RE_DEST_FOREACH_ROUTE_SAFE (rib_dest_from_rnode(rn), re, next)
 193
 194 #if defined(HAVE_RTADV)
 195 /* Structure which hold status of router advertisement. */
 196 struct rtadv {
 197         int sock;
 198
 199         int adv_if_count;
 200         int adv_msec_if_count;
 201
 202         struct thread *ra_read;
 203         struct thread *ra_timer;
 204 };
 205 #endif /* HAVE_RTADV */
 206
 207 /*
 208  * rib_table_info_t
 209  *
 210  * Structure that is hung off of a route_table that holds information about
 211  * the table.
 212  */
 213 typedef struct rib_table_info_t_ {
 214
 215         /*
 216          * Back pointer to zebra_vrf.
 217          */
 218         struct zebra_vrf *zvrf;
 219         afi_t afi;
 220         safi_t safi;
 221
 222 } rib_table_info_t;
 223
 224 typedef enum {
 225         RIB_TABLES_ITER_S_INIT,
 226         RIB_TABLES_ITER_S_ITERATING,
 227         RIB_TABLES_ITER_S_DONE
 228 } rib_tables_iter_state_t;
 229
 230 /*
 231  * Structure that holds state for iterating over all tables in the
 232  * Routing Information Base.
 233  */
 234 typedef struct rib_tables_iter_t_ {
 235         vrf_id_t vrf_id;
 236         int afi_safi_ix;
 237
 238         rib_tables_iter_state_t state;
 239 } rib_tables_iter_t;
 240
 241 /* Events/reasons triggering a RIB update. */
 242 typedef enum {
 243         RIB_UPDATE_IF_CHANGE,
 244         RIB_UPDATE_RMAP_CHANGE,
 245         RIB_UPDATE_OTHER
 246 } rib_update_event_t;
 247
 248 extern struct nexthop *route_entry_nexthop_ifindex_add(struct route_entry *re,
 249                                                        ifindex_t ifindex,
 250                                                        vrf_id_t nh_vrf_id);
 251 extern struct nexthop *
 252 route_entry_nexthop_blackhole_add(struct route_entry *re,
 253                                   enum blackhole_type bh_type);
 254 extern struct nexthop *route_entry_nexthop_ipv4_add(struct route_entry *re,
 255                                                     struct in_addr *ipv4,
 256                                                     struct in_addr *src,
 257                                                     vrf_id_t nh_vrf_id);
 258 extern struct nexthop *
 259 route_entry_nexthop_ipv4_ifindex_add(struct route_entry *re,
 260                                      struct in_addr *ipv4, struct in_addr *src,
 261                                      ifindex_t ifindex, vrf_id_t nh_vrf_id);
 262 extern void route_entry_nexthop_delete(struct route_entry *re,
 263                                        struct nexthop *nexthop);
 264 extern struct nexthop *route_entry_nexthop_ipv6_add(struct route_entry *re,
 265                                                     struct in6_addr *ipv6,
 266                                                     vrf_id_t nh_vrf_id);
 267 extern struct nexthop *
 268 route_entry_nexthop_ipv6_ifindex_add(struct route_entry *re,
 269                                      struct in6_addr *ipv6, ifindex_t ifindex,
 270                                      vrf_id_t nh_vrf_id);
 271 extern void route_entry_nexthop_add(struct route_entry *re,
 272                                     struct nexthop *nexthop);
 273 extern void route_entry_copy_nexthops(struct route_entry *re,
 274                                       struct nexthop *nh);
 275
 276 #define route_entry_dump(prefix, src, re) _route_entry_dump(__func__, prefix, src, re)
 277 extern void _route_entry_dump(const char *func, union prefixconstptr pp,
 278                               union prefixconstptr src_pp,
 279                               const struct route_entry *re);
 280 /* RPF lookup behaviour */
 281 enum multicast_mode {
 282         MCAST_NO_CONFIG = 0,  /* MIX_MRIB_FIRST, but no show in config write */
 283         MCAST_MRIB_ONLY,      /* MRIB only */
 284         MCAST_URIB_ONLY,      /* URIB only */
 285         MCAST_MIX_MRIB_FIRST, /* MRIB, if nothing at all then URIB */
 286         MCAST_MIX_DISTANCE,   /* MRIB & URIB, lower distance wins */
 287         MCAST_MIX_PFXLEN,     /* MRIB & URIB, longer prefix wins */
 288                               /* on equal value, MRIB wins for last 2 */
 289 };
 290
 291 extern void multicast_mode_ipv4_set(enum multicast_mode mode);
 292 extern enum multicast_mode multicast_mode_ipv4_get(void);
 293
 294 extern void rib_lookup_and_dump(struct prefix_ipv4 *p, vrf_id_t vrf_id);
 295 extern void rib_lookup_and_pushup(struct prefix_ipv4 *p, vrf_id_t vrf_id);
 296
 297 #define ZEBRA_RIB_LOOKUP_ERROR -1
 298 #define ZEBRA_RIB_FOUND_EXACT 0
 299 #define ZEBRA_RIB_FOUND_NOGATE 1
 300 #define ZEBRA_RIB_FOUND_CONNECTED 2
 301 #define ZEBRA_RIB_NOTFOUND 3
 302
 303 extern int is_zebra_valid_kernel_table(uint32_t table_id);
 304 extern int is_zebra_main_routing_table(uint32_t table_id);
 305 extern int zebra_check_addr(const struct prefix *p);
 306
 307 extern void rib_delnode(struct route_node *rn, struct route_entry *re);
 308 extern void rib_install_kernel(struct route_node *rn, struct route_entry *re,
 309                                struct route_entry *old);
 310 extern void rib_uninstall_kernel(struct route_node *rn, struct route_entry *re);
 311
 312 /* NOTE:
 313  * All rib_add function will not just add prefix into RIB, but
 314  * also implicitly withdraw equal prefix of same type. */
 315 extern int rib_add(afi_t afi, safi_t safi, vrf_id_t vrf_id, int type,
 316                    unsigned short instance, int flags, struct prefix *p,
 317                    struct prefix_ipv6 *src_p, const struct nexthop *nh,
 318                    uint32_t table_id, uint32_t metric, uint32_t mtu,
 319                    uint8_t distance, route_tag_t tag);
 320
 321 extern int rib_add_multipath(afi_t afi, safi_t safi, struct prefix *p,
 322                              struct prefix_ipv6 *src_p, struct route_entry *re);
 323
 324 extern void rib_delete(afi_t afi, safi_t safi, vrf_id_t vrf_id, int type,
 325                        unsigned short instance, int flags, struct prefix *p,
 326                        struct prefix_ipv6 *src_p, const struct nexthop *nh,
 327                        uint32_t table_id, uint32_t metric, uint8_t distance,
 328                        bool fromkernel);
 329
 330 extern struct route_entry *rib_match(afi_t afi, safi_t safi, vrf_id_t vrf_id,
 331                                      union g_addr *addr,
 332                                      struct route_node **rn_out);
 333 extern struct route_entry *rib_match_ipv4_multicast(vrf_id_t vrf_id,
 334                                                     struct in_addr addr,
 335                                                     struct route_node **rn_out);
 336
 337 extern struct route_entry *rib_lookup_ipv4(struct prefix_ipv4 *p,
 338                                            vrf_id_t vrf_id);
 339
 340 extern void rib_update(vrf_id_t vrf_id, rib_update_event_t event);
 341 extern void rib_update_table(struct route_table *table,
 342                              rib_update_event_t event);
 343 extern void rib_sweep_route(void);
 344 extern void rib_sweep_table(struct route_table *table);
 345 extern void rib_close_table(struct route_table *table);
 346 extern void rib_init(void);
 347 extern unsigned long rib_score_proto(uint8_t proto, unsigned short instance);
 348 extern unsigned long rib_score_proto_table(uint8_t proto,
 349                                            unsigned short instance,
 350                                            struct route_table *table);
 351 extern void rib_queue_add(struct route_node *rn);
 352 extern void meta_queue_free(struct meta_queue *mq);
 353 extern int zebra_rib_labeled_unicast(struct route_entry *re);
 354 extern struct route_table *rib_table_ipv6;
 355
 356 extern void rib_unlink(struct route_node *rn, struct route_entry *re);
 357 extern int rib_gc_dest(struct route_node *rn);
 358 extern struct route_table *rib_tables_iter_next(rib_tables_iter_t *iter);
 359
 360 extern uint8_t route_distance(int type);
 361
 362 /*
 363  * Inline functions.
 364  */
 365
 366 /*
 367  * rib_table_info
 368  */
 369 static inline rib_table_info_t *rib_table_info(struct route_table *table)
 370 {
 371         return (rib_table_info_t *)route_table_get_info(table);
 372 }
 373
 374 /*
 375  * rib_dest_from_rnode
 376  */
 377 static inline rib_dest_t *rib_dest_from_rnode(struct route_node *rn)
 378 {
 379         return (rib_dest_t *)rn->info;
 380 }
 381
 382 /*
 383  * rnode_to_ribs
 384  *
 385  * Returns a pointer to the list of routes corresponding to the given
 386  * route_node.
 387  */
 388 static inline struct route_entry *rnode_to_ribs(struct route_node *rn)
 389 {
 390         rib_dest_t *dest;
 391
 392         dest = rib_dest_from_rnode(rn);
 393         if (!dest)
 394                 return NULL;
 395
 396         return dest->routes;
 397 }
 398
 399 /*
 400  * rib_dest_prefix
 401  */
 402 static inline struct prefix *rib_dest_prefix(rib_dest_t *dest)
 403 {
 404         return &dest->rnode->p;
 405 }
 406
 407 /*
 408  * rib_dest_af
 409  *
 410  * Returns the address family that the destination is for.
 411  */
 412 static inline uint8_t rib_dest_af(rib_dest_t *dest)
 413 {
 414         return dest->rnode->p.family;
 415 }
 416
 417 /*
 418  * rib_dest_table
 419  */
 420 static inline struct route_table *rib_dest_table(rib_dest_t *dest)
 421 {
 422         return srcdest_rnode_table(dest->rnode);
 423 }
 424
 425 /*
 426  * rib_dest_vrf
 427  */
 428 static inline struct zebra_vrf *rib_dest_vrf(rib_dest_t *dest)
 429 {
 430         return rib_table_info(rib_dest_table(dest))->zvrf;
 431 }
 432
 433 /*
 434  * rib_tables_iter_init
 435  */
 436 static inline void rib_tables_iter_init(rib_tables_iter_t *iter)
 437
 438 {
 439         memset(iter, 0, sizeof(*iter));
 440         iter->state = RIB_TABLES_ITER_S_INIT;
 441 }
 442
 443 /*
 444  * rib_tables_iter_started
 445  *
 446  * Returns TRUE if this iterator has started iterating over the set of
 447  * tables.
 448  */
 449 static inline int rib_tables_iter_started(rib_tables_iter_t *iter)
 450 {
 451         return iter->state != RIB_TABLES_ITER_S_INIT;
 452 }
 453
 454 /*
 455  * rib_tables_iter_cleanup
 456  */
 457 static inline void rib_tables_iter_cleanup(rib_tables_iter_t *iter)
 458 {
 459         iter->state = RIB_TABLES_ITER_S_DONE;
 460 }
 461
 462 DECLARE_HOOK(rib_update, (struct route_node * rn, const char *reason),
 463              (rn, reason))
 464
 465
 466 extern void zebra_vty_init(void);
 467
 468 extern pid_t pid;
 469
 470 extern bool v6_rr_semantics;
 471
 472 #ifdef __cplusplus
 473 }
 474 #endif
 475
 476 #endif /*_ZEBRA_RIB_H */