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
  18  * along with GNU Zebra; see the file COPYING.  If not, write to the Free
  19  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  20  * 02111-1307, USA.
  21  */
  22
  23 #ifndef _ZEBRA_RIB_H
  24 #define _ZEBRA_RIB_H
  25
  26 #include "prefix.h"
  27
  28 #define DISTANCE_INFINITY  255
  29
  30 /* Routing information base. */
  31
  32 union g_addr {
  33   struct in_addr ipv4;
  34 #ifdef HAVE_IPV6
  35   struct in6_addr ipv6;
  36 #endif /* HAVE_IPV6 */
  37 };
  38
  39 struct rib
  40 {
  41   /* Status Flags for the *route_node*, but kept in the head RIB.. */
  42   u_char rn_status;
  43 #define RIB_ROUTE_QUEUED        (1 << 0)
  44
  45   /* Link list. */
  46   struct rib *next;
  47   struct rib *prev;
  48
  49   /* Nexthop structure */
  50   struct nexthop *nexthop;
  51
  52   /* Refrence count. */
  53   unsigned long refcnt;
  54
  55   /* Uptime. */
  56   time_t uptime;
  57
  58   /* Type fo this route. */
  59   int type;
  60
  61   /* Which routing table */
  62   int table;
  63
  64   /* Metric */
  65   u_int32_t metric;
  66
  67   /* Distance. */
  68   u_char distance;
  69
  70   /* Flags of this route.
  71    * This flag's definition is in lib/zebra.h ZEBRA_FLAG_* and is exposed
  72    * to clients via Zserv
  73    */
  74   u_char flags;
  75
  76   /* RIB internal status */
  77   u_char status;
  78 #define RIB_ENTRY_REMOVED       (1 << 0)
  79
  80   /* Nexthop information. */
  81   u_char nexthop_num;
  82   u_char nexthop_active_num;
  83   u_char nexthop_fib_num;
  84 };
  85
  86 /* Static route information. */
  87 struct static_ipv4
  88 {
  89   /* For linked list. */
  90   struct static_ipv4 *prev;
  91   struct static_ipv4 *next;
  92
  93   /* Administrative distance. */
  94   u_char distance;
  95
  96   /* Flag for this static route's type. */
  97   u_char type;
  98 #define STATIC_IPV4_GATEWAY     1
  99 #define STATIC_IPV4_IFNAME      2
 100 #define STATIC_IPV4_BLACKHOLE   3
 101
 102   /* Nexthop value. */
 103   union
 104   {
 105     struct in_addr ipv4;
 106     char *ifname;
 107   } gate;
 108
 109   /* bit flags */
 110   u_char flags;
 111 /*
 112  see ZEBRA_FLAG_REJECT
 113      ZEBRA_FLAG_BLACKHOLE
 114  */
 115 };
 116
 117 #ifdef HAVE_IPV6
 118 /* Static route information. */
 119 struct static_ipv6
 120 {
 121   /* For linked list. */
 122   struct static_ipv6 *prev;
 123   struct static_ipv6 *next;
 124
 125   /* Administrative distance. */
 126   u_char distance;
 127
 128   /* Flag for this static route's type. */
 129   u_char type;
 130 #define STATIC_IPV6_GATEWAY          1
 131 #define STATIC_IPV6_GATEWAY_IFNAME   2
 132 #define STATIC_IPV6_IFNAME           3
 133
 134   /* Nexthop value. */
 135   struct in6_addr ipv6;
 136   char *ifname;
 137
 138   /* bit flags */
 139   u_char flags;
 140 /*
 141  see ZEBRA_FLAG_REJECT
 142      ZEBRA_FLAG_BLACKHOLE
 143  */
 144 };
 145 #endif /* HAVE_IPV6 */
 146
 147 enum nexthop_types_t
 148 {
 149   NEXTHOP_TYPE_IFINDEX = 1,      /* Directly connected.  */
 150   NEXTHOP_TYPE_IFNAME,           /* Interface route.  */
 151   NEXTHOP_TYPE_IPV4,             /* IPv4 nexthop.  */
 152   NEXTHOP_TYPE_IPV4_IFINDEX,     /* IPv4 nexthop with ifindex.  */
 153   NEXTHOP_TYPE_IPV4_IFNAME,      /* IPv4 nexthop with ifname.  */
 154   NEXTHOP_TYPE_IPV6,             /* IPv6 nexthop.  */
 155   NEXTHOP_TYPE_IPV6_IFINDEX,     /* IPv6 nexthop with ifindex.  */
 156   NEXTHOP_TYPE_IPV6_IFNAME,      /* IPv6 nexthop with ifname.  */
 157   NEXTHOP_TYPE_BLACKHOLE,        /* Null0 nexthop.  */
 158 };
 159
 160 /* Nexthop structure. */
 161 struct nexthop
 162 {
 163   struct nexthop *next;
 164   struct nexthop *prev;
 165
 166   /* Interface index. */
 167   char *ifname;
 168   unsigned int ifindex;
 169
 170   enum nexthop_types_t type;
 171
 172   u_char flags;
 173 #define NEXTHOP_FLAG_ACTIVE     (1 << 0) /* This nexthop is alive. */
 174 #define NEXTHOP_FLAG_FIB        (1 << 1) /* FIB nexthop. */
 175 #define NEXTHOP_FLAG_RECURSIVE  (1 << 2) /* Recursive nexthop. */
 176
 177   /* Nexthop address or interface name. */
 178   union g_addr gate;
 179
 180   /* Recursive lookup nexthop. */
 181   u_char rtype;
 182   unsigned int rifindex;
 183   union g_addr rgate;
 184   union g_addr src;
 185 };
 186
 187 /* Routing table instance.  */
 188 struct vrf
 189 {
 190   /* Identifier.  This is same as routing table vector index.  */
 191   u_int32_t id;
 192
 193   /* Routing table name.  */
 194   char *name;
 195
 196   /* Description.  */
 197   char *desc;
 198
 199   /* FIB identifier.  */
 200   u_char fib_id;
 201
 202   /* Routing table.  */
 203   struct route_table *table[AFI_MAX][SAFI_MAX];
 204
 205   /* Static route configuration.  */
 206   struct route_table *stable[AFI_MAX][SAFI_MAX];
 207 };
 208
 209 extern struct nexthop *nexthop_ifindex_add (struct rib *, unsigned int);
 210 extern struct nexthop *nexthop_ifname_add (struct rib *, char *);
 211 extern struct nexthop *nexthop_blackhole_add (struct rib *);
 212 extern struct nexthop *nexthop_ipv4_add (struct rib *, struct in_addr *,
 213                                          struct in_addr *);
 214 extern void rib_lookup_and_dump (struct prefix_ipv4 *);
 215 extern void rib_dump (const char *, const struct prefix_ipv4 *, const struct rib *);
 216 extern int rib_lookup_ipv4_route (struct prefix_ipv4 *, union sockunion *);
 217 #define ZEBRA_RIB_LOOKUP_ERROR -1
 218 #define ZEBRA_RIB_FOUND_EXACT 0
 219 #define ZEBRA_RIB_FOUND_NOGATE 1
 220 #define ZEBRA_RIB_FOUND_CONNECTED 2
 221 #define ZEBRA_RIB_NOTFOUND 3
 222
 223 #ifdef HAVE_IPV6
 224 extern struct nexthop *nexthop_ipv6_add (struct rib *, struct in6_addr *);
 225 #endif /* HAVE_IPV6 */
 226
 227 extern struct vrf *vrf_lookup (u_int32_t);
 228 extern struct route_table *vrf_table (afi_t afi, safi_t safi, u_int32_t id);
 229 extern struct route_table *vrf_static_table (afi_t afi, safi_t safi, u_int32_t id);
 230
 231 /* NOTE:
 232  * All rib_add_ipv[46]* functions will not just add prefix into RIB, but
 233  * also implicitly withdraw equal prefix of same type. */
 234 extern int rib_add_ipv4 (int type, int flags, struct prefix_ipv4 *p,
 235                          struct in_addr *gate, struct in_addr *src,
 236                          unsigned int ifindex, u_int32_t vrf_id,
 237                          u_int32_t, u_char);
 238
 239 extern int rib_add_ipv4_multipath (struct prefix_ipv4 *, struct rib *);
 240
 241 extern int rib_delete_ipv4 (int type, int flags, struct prefix_ipv4 *p,
 242                             struct in_addr *gate, unsigned int ifindex,
 243                             u_int32_t);
 244
 245 extern struct rib *rib_match_ipv4 (struct in_addr);
 246
 247 extern struct rib *rib_lookup_ipv4 (struct prefix_ipv4 *);
 248
 249 extern void rib_update (void);
 250 extern void rib_weed_tables (void);
 251 extern void rib_sweep_route (void);
 252 extern void rib_close (void);
 253 extern void rib_init (void);
 254
 255 extern int
 256 static_add_ipv4 (struct prefix *p, struct in_addr *gate, const char *ifname,
 257        u_char flags, u_char distance, u_int32_t vrf_id);
 258
 259 extern int
 260 static_delete_ipv4 (struct prefix *p, struct in_addr *gate, const char *ifname,
 261                     u_char distance, u_int32_t vrf_id);
 262
 263 #ifdef HAVE_IPV6
 264 extern int
 265 rib_add_ipv6 (int type, int flags, struct prefix_ipv6 *p,
 266               struct in6_addr *gate, unsigned int ifindex, u_int32_t vrf_id,
 267               u_int32_t metric, u_char distance);
 268
 269 extern int
 270 rib_delete_ipv6 (int type, int flags, struct prefix_ipv6 *p,
 271                  struct in6_addr *gate, unsigned int ifindex, u_int32_t vrf_id);
 272
 273 extern struct rib *rib_lookup_ipv6 (struct in6_addr *);
 274
 275 extern struct rib *rib_match_ipv6 (struct in6_addr *);
 276
 277 extern struct route_table *rib_table_ipv6;
 278
 279 extern int
 280 static_add_ipv6 (struct prefix *p, u_char type, struct in6_addr *gate,
 281                  const char *ifname, u_char flags, u_char distance,
 282                  u_int32_t vrf_id);
 283
 284 extern int
 285 static_delete_ipv6 (struct prefix *p, u_char type, struct in6_addr *gate,
 286                     const char *ifname, u_char distance, u_int32_t vrf_id);
 287
 288 #endif /* HAVE_IPV6 */
 289
 290 #endif /*_ZEBRA_RIB_H */