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 /*
  60  * Pass some OS specific data up through
  61  * to the daemons
  62  */
  63 struct vrf_data
  64 {
  65   union
  66   {
  67     struct {
  68       uint32_t table_id;
  69     } l;
  70   };
  71 };
  72
  73 struct vrf
  74 {
  75   RB_ENTRY(vrf) id_entry, name_entry;
  76
  77   /* Identifier, same as the vector index */
  78   vrf_id_t vrf_id;
  79
  80   /* Name */
  81   char name[VRF_NAMSIZ + 1];
  82
  83   /* Zebra internal VRF status */
  84   u_char status;
  85 #define VRF_ACTIVE     (1 << 0)
  86
  87   /* Master list of interfaces belonging to this VRF */
  88   struct list *iflist;
  89
  90   /* User data */
  91   void *info;
  92
  93   /* The table_id from the kernel */
  94   struct vrf_data data;
  95
  96   QOBJ_FIELDS
  97 };
  98 RB_HEAD (vrf_id_head, vrf);
  99 RB_PROTOTYPE (vrf_id_head, vrf, id_entry, vrf_id_compare)
 100 RB_HEAD (vrf_name_head, vrf);
 101 RB_PROTOTYPE (vrf_name_head, vrf, name_entry, vrf_name_compare)
 102 DECLARE_QOBJ_TYPE(vrf)
 103
 104
 105 extern struct vrf_id_head vrfs_by_id;
 106 extern struct vrf_name_head vrfs_by_name;
 107
 108 extern struct vrf *vrf_lookup_by_id (vrf_id_t);
 109 extern struct vrf *vrf_lookup_by_name (const char *);
 110 extern struct vrf *vrf_get (vrf_id_t, const char *);
 111 extern vrf_id_t vrf_name_to_id (const char *);
 112
 113 #define VRF_GET_ID(V,NAME)      \
 114   do {                          \
 115       struct vrf *vrf; \
 116       if (!(vrf = vrf_lookup_by_name(NAME))) \
 117         {                                                           \
 118           vty_out (vty, "%% VRF %s not found%s", NAME, VTY_NEWLINE);\
 119           return CMD_WARNING;                                       \
 120         }                                               \
 121       if (vrf->vrf_id == VRF_UNKNOWN) \
 122         { \
 123           vty_out (vty, "%% VRF %s not active%s", NAME, VTY_NEWLINE);\
 124           return CMD_WARNING;                                       \
 125         } \
 126       (V) = vrf->vrf_id; \
 127   } while (0)
 128
 129 /*
 130  * Utilities to obtain the user data
 131  */
 132
 133 /* Get the data pointer of the specified VRF. If not found, create one. */
 134 extern void *vrf_info_get (vrf_id_t);
 135 /* Look up the data pointer of the specified VRF. */
 136 extern void *vrf_info_lookup (vrf_id_t);
 137
 138 /*
 139  * Utilities to obtain the interface list
 140  */
 141
 142 /* Look up the interface list of the specified VRF. */
 143 extern struct list *vrf_iflist (vrf_id_t);
 144 /* Get the interface list of the specified VRF. Create one if not find. */
 145 extern struct list *vrf_iflist_get (vrf_id_t);
 146
 147 /*
 148  * VRF bit-map: maintaining flags, one bit per VRF ID
 149  */
 150
 151 typedef void *              vrf_bitmap_t;
 152 #define VRF_BITMAP_NULL     NULL
 153
 154 extern vrf_bitmap_t vrf_bitmap_init (void);
 155 extern void vrf_bitmap_free (vrf_bitmap_t);
 156 extern void vrf_bitmap_set (vrf_bitmap_t, vrf_id_t);
 157 extern void vrf_bitmap_unset (vrf_bitmap_t, vrf_id_t);
 158 extern int vrf_bitmap_check (vrf_bitmap_t, vrf_id_t);
 159
 160 /*
 161  * VRF initializer/destructor
 162  *
 163  * create -> Called back when a new VRF is created.  This
 164  *           can be either through these 3 options:
 165  *           1) CLI mentions a vrf before OS knows about it
 166  *           2) OS calls zebra and we create the vrf from OS
 167  *              callback
 168  *           3) zebra calls individual protocols to notify
 169  *              about the new vrf
 170  *
 171  * enable -> Called back when a VRF is actually usable from
 172  *           an OS perspective ( 2 and 3 above )
 173  *
 174  * disable -> Called back when a VRF is being deleted from
 175  *            the system ( 2 and 3 ) above
 176  *
 177  * delete -> Called back when a vrf is being deleted from
 178  *           the system ( 2 and 3 ) above.
 179  */
 180 extern void vrf_init (int (*create)(struct vrf *),
 181                       int (*enable)(struct vrf *),
 182                       int (*disable)(struct vrf *),
 183                       int (*delete)(struct vrf *));
 184 /*
 185  * Call vrf_terminate when the protocol is being shutdown
 186  */
 187 extern void vrf_terminate (void);
 188
 189 extern void vrf_cmd_init (int (*writefunc)(struct vty *vty));
 190
 191 /*
 192  * VRF utilities
 193  */
 194
 195 /* Create a socket serving for the given VRF */
 196 extern int vrf_socket (int, int, int, vrf_id_t);
 197
 198 /*
 199  * VRF Debugging
 200  */
 201 extern void vrf_install_commands (void);
 202 #endif /*_ZEBRA_VRF_H*/
 203