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