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 #include "ns.h"
  30
  31 /* The default VRF ID */
  32 #define VRF_UNKNOWN UINT32_MAX
  33
  34 /* Pending: May need to refine this. */
  35 #ifndef IFLA_VRF_MAX
  36 enum { IFLA_VRF_UNSPEC, IFLA_VRF_TABLE, __IFLA_VRF_MAX };
  37
  38 #define IFLA_VRF_MAX (__IFLA_VRF_MAX - 1)
  39 #endif
  40
  41 #define VRF_NAMSIZ      36
  42 #define NS_NAMSIZ       16
  43
  44 #define VRF_DEFAULT_NAME    "Default-IP-Routing-Table"
  45
  46 /*
  47  * The command strings
  48  */
  49 #define VRF_CMD_HELP_STR    "Specify the VRF\nThe VRF name\n"
  50 #define VRF_ALL_CMD_HELP_STR    "Specify the VRF\nAll VRFs\n"
  51 #define VRF_FULL_CMD_HELP_STR   "Specify the VRF\nThe VRF name\nAll VRFs\n"
  52
  53 /*
  54  * Pass some OS specific data up through
  55  * to the daemons
  56  */
  57 struct vrf_data {
  58         union {
  59                 struct {
  60                         uint32_t table_id;
  61                         char netns_name[NS_NAMSIZ];
  62                 } l;
  63         };
  64 };
  65
  66 struct vrf {
  67         RB_ENTRY(vrf) id_entry, name_entry;
  68
  69         /* Identifier, same as the vector index */
  70         vrf_id_t vrf_id;
  71
  72         /* Name */
  73         char name[VRF_NAMSIZ + 1];
  74
  75         /* Zebra internal VRF status */
  76         uint8_t status;
  77 #define VRF_ACTIVE     (1 << 0) /* VRF is up in kernel */
  78 #define VRF_CONFIGURED (1 << 1) /* VRF has some FRR configuration */
  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         /* Back pointer to namespace context */
  91         void *ns_ctxt;
  92
  93         QOBJ_FIELDS
  94 };
  95 RB_HEAD(vrf_id_head, vrf);
  96 RB_PROTOTYPE(vrf_id_head, vrf, id_entry, vrf_id_compare)
  97 RB_HEAD(vrf_name_head, vrf);
  98 RB_PROTOTYPE(vrf_name_head, vrf, name_entry, vrf_name_compare)
  99 DECLARE_QOBJ_TYPE(vrf)
 100
 101 /* Allow VRF with netns as backend */
 102 #define VRF_BACKEND_VRF_LITE 0
 103 #define VRF_BACKEND_NETNS    1
 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 const char *vrf_id_to_name(vrf_id_t vrf_id);
 112 extern vrf_id_t vrf_name_to_id(const char *);
 113
 114 #define VRF_GET_ID(V, NAME, USE_JSON)                                          \
 115         do {                                                                   \
 116                 struct vrf *vrf;                                               \
 117                 if (!(vrf = vrf_lookup_by_name(NAME))) {                       \
 118                         if (USE_JSON) {                                        \
 119                                 vty_out(vty, "{}\n");                          \
 120                         } else {                                               \
 121                                 vty_out(vty, "%% VRF %s not found\n", NAME);   \
 122                         }                                                      \
 123                         return CMD_WARNING;                                    \
 124                 }                                                              \
 125                 if (vrf->vrf_id == VRF_UNKNOWN) {                              \
 126                         if (USE_JSON) {                                        \
 127                                 vty_out(vty, "{}\n");                          \
 128                         } else {                                               \
 129                                 vty_out(vty, "%% VRF %s not active\n", NAME);  \
 130                         }                                                      \
 131                         return CMD_WARNING;                                    \
 132                 }                                                              \
 133                 (V) = vrf->vrf_id;                                             \
 134         } while (0)
 135
 136 /*
 137  * Check whether the VRF is enabled.
 138  */
 139 static inline int vrf_is_enabled(struct vrf *vrf)
 140 {
 141         return vrf && CHECK_FLAG(vrf->status, VRF_ACTIVE);
 142 }
 143
 144 /* check if the vrf is user configured */
 145 static inline int vrf_is_user_cfged(struct vrf *vrf)
 146 {
 147         return vrf && CHECK_FLAG(vrf->status, VRF_CONFIGURED);
 148 }
 149
 150 /* Mark that VRF has user configuration */
 151 static inline void vrf_set_user_cfged(struct vrf *vrf)
 152 {
 153         SET_FLAG(vrf->status, VRF_CONFIGURED);
 154 }
 155
 156 /* Mark that VRF no longer has any user configuration */
 157 static inline void vrf_reset_user_cfged(struct vrf *vrf)
 158 {
 159         UNSET_FLAG(vrf->status, VRF_CONFIGURED);
 160 }
 161
 162 /*
 163  * Utilities to obtain the user data
 164  */
 165
 166 /* Get the data pointer of the specified VRF. If not found, create one. */
 167 extern void *vrf_info_get(vrf_id_t);
 168 /* Look up the data pointer of the specified VRF. */
 169 extern void *vrf_info_lookup(vrf_id_t);
 170
 171 /*
 172  * VRF bit-map: maintaining flags, one bit per VRF ID
 173  */
 174
 175 typedef void *vrf_bitmap_t;
 176 #define VRF_BITMAP_NULL     NULL
 177
 178 extern vrf_bitmap_t vrf_bitmap_init(void);
 179 extern void vrf_bitmap_free(vrf_bitmap_t);
 180 extern void vrf_bitmap_set(vrf_bitmap_t, vrf_id_t);
 181 extern void vrf_bitmap_unset(vrf_bitmap_t, vrf_id_t);
 182 extern int vrf_bitmap_check(vrf_bitmap_t, vrf_id_t);
 183
 184 /*
 185  * VRF initializer/destructor
 186  *
 187  * create -> Called back when a new VRF is created.  This
 188  *           can be either through these 3 options:
 189  *           1) CLI mentions a vrf before OS knows about it
 190  *           2) OS calls zebra and we create the vrf from OS
 191  *              callback
 192  *           3) zebra calls individual protocols to notify
 193  *              about the new vrf
 194  *
 195  * enable -> Called back when a VRF is actually usable from
 196  *           an OS perspective ( 2 and 3 above )
 197  *
 198  * disable -> Called back when a VRF is being deleted from
 199  *            the system ( 2 and 3 ) above
 200  *
 201  * delete -> Called back when a vrf is being deleted from
 202  *           the system ( 2 and 3 ) above.
 203  */
 204 extern void vrf_init(int (*create)(struct vrf *), int (*enable)(struct vrf *),
 205                      int (*disable)(struct vrf *), int (*delete)(struct vrf *));
 206 /*
 207  * Call vrf_terminate when the protocol is being shutdown
 208  */
 209 extern void vrf_terminate(void);
 210
 211 /*
 212  * Utilities to create networks objects,
 213  * or call network operations
 214  */
 215
 216 /* Create a socket serving for the given VRF */
 217 extern int vrf_socket(int domain, int type, int protocol, vrf_id_t vrf_id,
 218                       char *name);
 219
 220 extern int vrf_sockunion_socket(const union sockunion *su, vrf_id_t vrf_id,
 221                                 char *name);
 222
 223 extern int vrf_bind(vrf_id_t vrf_id, int fd, char *name);
 224
 225 /* VRF ioctl operations */
 226 extern int vrf_getaddrinfo(const char *node, const char *service,
 227                            const struct addrinfo *hints, struct addrinfo **res,
 228                            vrf_id_t vrf_id);
 229
 230 extern int vrf_ioctl(vrf_id_t vrf_id, int d, unsigned long request, char *args);
 231
 232 /* function called by macro VRF_DEFAULT
 233  * to get the default VRF_ID
 234  */
 235 extern vrf_id_t vrf_get_default_id(void);
 236 /* The default VRF ID */
 237 #define VRF_DEFAULT vrf_get_default_id()
 238
 239 /* VRF is mapped on netns or not ? */
 240 int vrf_is_mapped_on_netns(struct vrf *vrf);
 241
 242 /* VRF switch from NETNS */
 243 extern int vrf_switch_to_netns(vrf_id_t vrf_id);
 244 extern int vrf_switchback_to_initial(void);
 245
 246 /*
 247  * VRF backend routines
 248  * should be called from zebra only
 249  */
 250
 251 /* VRF vty command initialisation
 252  */
 253 extern void vrf_cmd_init(int (*writefunc)(struct vty *vty),
 254                          struct zebra_privs_t *daemon_priv);
 255
 256 /* VRF vty debugging
 257  */
 258 extern void vrf_install_commands(void);
 259
 260 /*
 261  * VRF utilities
 262  */
 263
 264 /* API for configuring VRF backend
 265  * should be called from zebra only
 266  */
 267 extern void vrf_configure_backend(int vrf_backend_netns);
 268 extern int vrf_get_backend(void);
 269 extern int vrf_is_backend_netns(void);
 270
 271
 272 /* API to create a VRF. either from vty
 273  * or through discovery
 274  */
 275 extern int vrf_handler_create(struct vty *vty, const char *name,
 276                               struct vrf **vrf);
 277
 278 /* API to associate a VRF with a NETNS.
 279  * called either from vty or through discovery
 280  * should be called from zebra only
 281  */
 282 extern int vrf_netns_handler_create(struct vty *vty, struct vrf *vrf,
 283                                     char *pathname, ns_id_t ext_ns_id,
 284                                     ns_id_t ns_id);
 285
 286 /* used internally to enable or disable VRF.
 287  * Notify a change in the VRF ID of the VRF
 288  */
 289 extern void vrf_disable(struct vrf *vrf);
 290 extern int vrf_enable(struct vrf *vrf);
 291 extern void vrf_delete(struct vrf *vrf);
 292
 293 #endif /*_ZEBRA_VRF_H*/