lib/vrf.h

   1 /*
   2  * VRF related header.
   3  * Copyright (C) 2014 6WIND S.A.
   4  *
   5  * This file is part of GNU Zebra.
   6  *
   7  * GNU Zebra is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published
   9  * by the Free Software Foundation; either version 2, or (at your
  10  * option) any 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_VRF_H
  23 #define _ZEBRA_VRF_H
  24
  25 #include "openbsd-tree.h"
  26 #include "linklist.h"
  27 #include "qobj.h"
  28 #include "vty.h"
  29
  30 /* The default NS ID */
  31 #define NS_DEFAULT 0
  32
  33 /* The default VRF ID */
  34 #define VRF_DEFAULT 0
  35 #define VRF_UNKNOWN UINT16_MAX
  36 #define VRF_ALL UINT16_MAX - 1
  37
  38 /* Pending: May need to refine this. */
  39 #ifndef IFLA_VRF_MAX
  40 enum {
  41         IFLA_VRF_UNSPEC,
  42         IFLA_VRF_TABLE,
  43         __IFLA_VRF_MAX
  44 };
  45
  46 #define IFLA_VRF_MAX (__IFLA_VRF_MAX - 1)
  47 #endif
  48
  49 #define VRF_NAMSIZ      36
  50
  51 #define VRF_DEFAULT_NAME    "Default-IP-Routing-Table"
  52
  53 /*
  54  * The command strings
  55  */
  56 #define VRF_CMD_HELP_STR    "Specify the VRF\nThe VRF name\n"
  57 #define VRF_ALL_CMD_HELP_STR    "Specify the VRF\nAll VRFs\n"
  58
  59 struct vrf
  60 {
  61   RB_ENTRY(vrf) id_entry, name_entry;
  62
  63   /* Identifier, same as the vector index */
  64   vrf_id_t vrf_id;
  65
  66   /* Name */
  67   char name[VRF_NAMSIZ + 1];
  68
  69   /* Zebra internal VRF status */
  70   u_char status;
  71 #define VRF_ACTIVE     (1 << 0)
  72
  73   /* Master list of interfaces belonging to this VRF */
  74   struct list *iflist;
  75
  76   /* User data */
  77   void *info;
  78
  79   QOBJ_FIELDS
  80 };
  81 RB_HEAD (vrf_id_head, vrf);
  82 RB_PROTOTYPE (vrf_id_head, vrf, id_entry, vrf_id_compare)
  83 RB_HEAD (vrf_name_head, vrf);
  84 RB_PROTOTYPE (vrf_name_head, vrf, name_entry, vrf_name_compare)
  85 DECLARE_QOBJ_TYPE(vrf)
  86
  87
  88 extern struct vrf_id_head vrfs_by_id;
  89 extern struct vrf_name_head vrfs_by_name;
  90
  91 extern struct vrf *vrf_lookup_by_id (vrf_id_t);
  92 extern struct vrf *vrf_lookup_by_name (const char *);
  93 extern struct vrf *vrf_get (vrf_id_t, const char *);
  94 extern vrf_id_t vrf_name_to_id (const char *);
  95
  96 #define VRF_GET_ID(V,NAME)      \
  97   do {                          \
  98       struct vrf *vrf; \
  99       if (!(vrf = vrf_lookup_by_name(NAME))) \
 100         {                                                           \
 101           vty_out (vty, "%% VRF %s not found%s", NAME, VTY_NEWLINE);\
 102           return CMD_WARNING;                                       \
 103         }                                               \
 104       if (vrf->vrf_id == VRF_UNKNOWN) \
 105         { \
 106           vty_out (vty, "%% VRF %s not active%s", NAME, VTY_NEWLINE);\
 107           return CMD_WARNING;                                       \
 108         } \
 109       (V) = vrf->vrf_id; \
 110   } while (0)
 111
 112 /*
 113  * Utilities to obtain the user data
 114  */
 115
 116 /* Get the data pointer of the specified VRF. If not found, create one. */
 117 extern void *vrf_info_get (vrf_id_t);
 118 /* Look up the data pointer of the specified VRF. */
 119 extern void *vrf_info_lookup (vrf_id_t);
 120
 121 /*
 122  * Utilities to obtain the interface list
 123  */
 124
 125 /* Look up the interface list of the specified VRF. */
 126 extern struct list *vrf_iflist (vrf_id_t);
 127 /* Get the interface list of the specified VRF. Create one if not find. */
 128 extern struct list *vrf_iflist_get (vrf_id_t);
 129
 130 /*
 131  * VRF bit-map: maintaining flags, one bit per VRF ID
 132  */
 133
 134 typedef void *              vrf_bitmap_t;
 135 #define VRF_BITMAP_NULL     NULL
 136
 137 extern vrf_bitmap_t vrf_bitmap_init (void);
 138 extern void vrf_bitmap_free (vrf_bitmap_t);
 139 extern void vrf_bitmap_set (vrf_bitmap_t, vrf_id_t);
 140 extern void vrf_bitmap_unset (vrf_bitmap_t, vrf_id_t);
 141 extern int vrf_bitmap_check (vrf_bitmap_t, vrf_id_t);
 142
 143 /*
 144  * VRF initializer/destructor
 145  *
 146  * create -> Called back when a new VRF is created.  This
 147  *           can be either through these 3 options:
 148  *           1) CLI mentions a vrf before OS knows about it
 149  *           2) OS calls zebra and we create the vrf from OS
 150  *              callback
 151  *           3) zebra calls individual protocols to notify
 152  *              about the new vrf
 153  *
 154  * enable -> Called back when a VRF is actually usable from
 155  *           an OS perspective ( 2 and 3 above )
 156  *
 157  * disable -> Called back when a VRF is being deleted from
 158  *            the system ( 2 and 3 ) above
 159  *
 160  * delete -> Called back when a vrf is being deleted from
 161  *           the system ( 2 and 3 ) above.
 162  */
 163 extern void vrf_init (int (*create)(struct vrf *),
 164                       int (*enable)(struct vrf *),
 165                       int (*disable)(struct vrf *),
 166                       int (*delete)(struct vrf *));
 167 /*
 168  * Call vrf_terminate when the protocol is being shutdown
 169  */
 170 extern void vrf_terminate (void);
 171
 172 extern void vrf_cmd_init (int (*writefunc)(struct vty *vty));
 173
 174 /*
 175  * VRF utilities
 176  */
 177
 178 /* Create a socket serving for the given VRF */
 179 extern int vrf_socket (int, int, int, vrf_id_t);
 180
 181 /*
 182  * VRF Debugging
 183  */
 184 extern void vrf_install_commands (void);
 185 #endif /*_ZEBRA_VRF_H*/
 186