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