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 { IFLA_VRF_UNSPEC, IFLA_VRF_TABLE, __IFLA_VRF_MAX };
  41
  42 #define IFLA_VRF_MAX (__IFLA_VRF_MAX - 1)
  43 #endif
  44
  45 #define VRF_NAMSIZ      36
  46
  47 #define VRF_DEFAULT_NAME    "Default-IP-Routing-Table"
  48
  49 /*
  50  * The command strings
  51  */
  52 #define VRF_CMD_HELP_STR    "Specify the VRF\nThe VRF name\n"
  53 #define VRF_ALL_CMD_HELP_STR    "Specify the VRF\nAll VRFs\n"
  54
  55 /*
  56  * Pass some OS specific data up through
  57  * to the daemons
  58  */
  59 struct vrf_data {
  60         union {
  61                 struct {
  62                         uint32_t table_id;
  63                 } l;
  64         };
  65 };
  66
  67 struct vrf {
  68         RB_ENTRY(vrf) id_entry, name_entry;
  69
  70         /* Identifier, same as the vector index */
  71         vrf_id_t vrf_id;
  72
  73         /* Name */
  74         char name[VRF_NAMSIZ + 1];
  75
  76         /* Zebra internal VRF status */
  77         u_char status;
  78 #define VRF_ACTIVE     (1 << 0)
  79
  80         /* Interfaces belonging to this VRF */
  81         struct if_name_head ifaces_by_name;
  82         struct if_index_head ifaces_by_index;
  83
  84         /* User data */
  85         void *info;
  86
  87         /* The table_id from the kernel */
  88         struct vrf_data data;
  89
  90         QOBJ_FIELDS
  91 };
  92 RB_HEAD(vrf_id_head, vrf);
  93 RB_PROTOTYPE(vrf_id_head, vrf, id_entry, vrf_id_compare)
  94 RB_HEAD(vrf_name_head, vrf);
  95 RB_PROTOTYPE(vrf_name_head, vrf, name_entry, vrf_name_compare)
  96 DECLARE_QOBJ_TYPE(vrf)
  97
  98
  99 extern struct vrf_id_head vrfs_by_id;
 100 extern struct vrf_name_head vrfs_by_name;
 101
 102 extern struct vrf *vrf_lookup_by_id(vrf_id_t);
 103 extern struct vrf *vrf_lookup_by_name(const char *);
 104 extern struct vrf *vrf_get(vrf_id_t, const char *);
 105 extern vrf_id_t vrf_name_to_id(const char *);
 106
 107 #define VRF_GET_ID(V, NAME)                                                    \
 108         do {                                                                   \
 109                 struct vrf *vrf;                                               \
 110                 if (!(vrf = vrf_lookup_by_name(NAME))) {                       \
 111                         vty_out(vty, "%% VRF %s not found\n", NAME);           \
 112                         return CMD_WARNING;                                    \
 113                 }                                                              \
 114                 if (vrf->vrf_id == VRF_UNKNOWN) {                              \
 115                         vty_out(vty, "%% VRF %s not active\n", NAME);          \
 116                         return CMD_WARNING;                                    \
 117                 }                                                              \
 118                 (V) = vrf->vrf_id;                                             \
 119         } while (0)
 120
 121 /*
 122  * Utilities to obtain the user data
 123  */
 124
 125 /* Get the data pointer of the specified VRF. If not found, create one. */
 126 extern void *vrf_info_get(vrf_id_t);
 127 /* Look up the data pointer of the specified VRF. */
 128 extern void *vrf_info_lookup(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 *), int (*enable)(struct vrf *),
 164                      int (*disable)(struct vrf *), int (*delete)(struct vrf *));
 165 /*
 166  * Call vrf_terminate when the protocol is being shutdown
 167  */
 168 extern void vrf_terminate(void);
 169
 170 extern void vrf_cmd_init(int (*writefunc)(struct vty *vty));
 171
 172 /*
 173  * VRF utilities
 174  */
 175
 176 /* Create a socket serving for the given VRF */
 177 extern int vrf_socket(int, int, int, vrf_id_t);
 178
 179 /*
 180  * VRF Debugging
 181  */
 182 extern void vrf_install_commands(void);
 183 #endif /*_ZEBRA_VRF_H*/