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 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 /* The default VRF ID */
  36 #define VRF_UNKNOWN UINT32_MAX
  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 #define NS_NAMSIZ 36
  47
  48 /*
  49  * The command strings
  50  */
  51 #define VRF_CMD_HELP_STR    "Specify the VRF\nThe VRF name\n"
  52 #define VRF_ALL_CMD_HELP_STR    "Specify the VRF\nAll VRFs\n"
  53 #define VRF_FULL_CMD_HELP_STR   "Specify the VRF\nThe VRF name\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                         char netns_name[NS_NAMSIZ];
  64                 } l;
  65         };
  66 };
  67
  68 struct vrf {
  69         RB_ENTRY(vrf) id_entry, name_entry;
  70
  71         /* Identifier, same as the vector index */
  72         vrf_id_t vrf_id;
  73
  74         /* Name */
  75         char name[VRF_NAMSIZ + 1];
  76
  77         /* Zebra internal VRF status */
  78         uint8_t status;
  79 #define VRF_ACTIVE     (1 << 0) /* VRF is up in kernel */
  80 #define VRF_CONFIGURED (1 << 1) /* VRF has some FRR configuration */
  81
  82         /* Interfaces belonging to this VRF */
  83         struct if_name_head ifaces_by_name;
  84         struct if_index_head ifaces_by_index;
  85
  86         /* User data */
  87         void *info;
  88
  89         /* The table_id from the kernel */
  90         struct vrf_data data;
  91
  92         /* Back pointer to namespace context */
  93         void *ns_ctxt;
  94
  95         QOBJ_FIELDS
  96 };
  97 RB_HEAD(vrf_id_head, vrf);
  98 RB_PROTOTYPE(vrf_id_head, vrf, id_entry, vrf_id_compare)
  99 RB_HEAD(vrf_name_head, vrf);
 100 RB_PROTOTYPE(vrf_name_head, vrf, name_entry, vrf_name_compare)
 101 DECLARE_QOBJ_TYPE(vrf)
 102
 103 /* Allow VRF with netns as backend */
 104 enum vrf_backend_type {
 105         VRF_BACKEND_VRF_LITE,
 106         VRF_BACKEND_NETNS,
 107         VRF_BACKEND_UNKNOWN,
 108         VRF_BACKEND_MAX,
 109 };
 110
 111 extern struct vrf_id_head vrfs_by_id;
 112 extern struct vrf_name_head vrfs_by_name;
 113
 114 extern struct vrf *vrf_lookup_by_id(vrf_id_t);
 115 extern struct vrf *vrf_lookup_by_name(const char *);
 116 extern struct vrf *vrf_get(vrf_id_t, const char *);
 117 extern const char *vrf_id_to_name(vrf_id_t vrf_id);
 118 extern vrf_id_t vrf_name_to_id(const char *);
 119
 120 #define VRF_LOGNAME(V) V ? V->name : "Unknown"
 121
 122 #define VRF_GET_ID(V, NAME, USE_JSON)                                          \
 123         do {                                                                   \
 124                 struct vrf *_vrf;                                              \
 125                 if (!(_vrf = vrf_lookup_by_name(NAME))) {                      \
 126                         if (USE_JSON) {                                        \
 127                                 vty_out(vty, "{}\n");                          \
 128                         } else {                                               \
 129                                 vty_out(vty, "%% VRF %s not found\n", NAME);   \
 130                         }                                                      \
 131                         return CMD_WARNING;                                    \
 132                 }                                                              \
 133                 if (_vrf->vrf_id == VRF_UNKNOWN) {                             \
 134                         if (USE_JSON) {                                        \
 135                                 vty_out(vty, "{}\n");                          \
 136                         } else {                                               \
 137                                 vty_out(vty, "%% VRF %s not active\n", NAME);  \
 138                         }                                                      \
 139                         return CMD_WARNING;                                    \
 140                 }                                                              \
 141                 (V) = _vrf->vrf_id;                                            \
 142         } while (0)
 143
 144 /*
 145  * Check whether the VRF is enabled.
 146  */
 147 static inline int vrf_is_enabled(struct vrf *vrf)
 148 {
 149         return vrf && CHECK_FLAG(vrf->status, VRF_ACTIVE);
 150 }
 151
 152 /* check if the vrf is user configured */
 153 static inline int vrf_is_user_cfged(struct vrf *vrf)
 154 {
 155         return vrf && CHECK_FLAG(vrf->status, VRF_CONFIGURED);
 156 }
 157
 158 /* Mark that VRF has user configuration */
 159 static inline void vrf_set_user_cfged(struct vrf *vrf)
 160 {
 161         SET_FLAG(vrf->status, VRF_CONFIGURED);
 162 }
 163
 164 /* Mark that VRF no longer has any user configuration */
 165 static inline void vrf_reset_user_cfged(struct vrf *vrf)
 166 {
 167         UNSET_FLAG(vrf->status, VRF_CONFIGURED);
 168 }
 169
 170 /*
 171  * Utilities to obtain the user data
 172  */
 173
 174 /* Get the data pointer of the specified VRF. If not found, create one. */
 175 extern void *vrf_info_get(vrf_id_t);
 176 /* Look up the data pointer of the specified VRF. */
 177 extern void *vrf_info_lookup(vrf_id_t);
 178
 179 /*
 180  * VRF bit-map: maintaining flags, one bit per VRF ID
 181  */
 182
 183 typedef void *vrf_bitmap_t;
 184 #define VRF_BITMAP_NULL     NULL
 185
 186 extern vrf_bitmap_t vrf_bitmap_init(void);
 187 extern void vrf_bitmap_free(vrf_bitmap_t);
 188 extern void vrf_bitmap_set(vrf_bitmap_t, vrf_id_t);
 189 extern void vrf_bitmap_unset(vrf_bitmap_t, vrf_id_t);
 190 extern int vrf_bitmap_check(vrf_bitmap_t, vrf_id_t);
 191
 192 /*
 193  * VRF initializer/destructor
 194  *
 195  * create -> Called back when a new VRF is created.  This
 196  *           can be either through these 3 options:
 197  *           1) CLI mentions a vrf before OS knows about it
 198  *           2) OS calls zebra and we create the vrf from OS
 199  *              callback
 200  *           3) zebra calls individual protocols to notify
 201  *              about the new vrf
 202  *
 203  * enable -> Called back when a VRF is actually usable from
 204  *           an OS perspective ( 2 and 3 above )
 205  *
 206  * disable -> Called back when a VRF is being deleted from
 207  *            the system ( 2 and 3 ) above
 208  *
 209  * delete -> Called back when a vrf is being deleted from
 210  *           the system ( 2 and 3 ) above.
 211  */
 212 extern void vrf_init(int (*create)(struct vrf *vrf), int (*enable)(struct vrf *vrf),
 213                      int (*disable)(struct vrf *vrf), int (*destroy)(struct vrf *vrf),
 214                      int (*update)(struct vrf *vrf));
 215
 216 /*
 217  * Call vrf_terminate when the protocol is being shutdown
 218  */
 219 extern void vrf_terminate(void);
 220
 221 /*
 222  * Utilities to create networks objects,
 223  * or call network operations
 224  */
 225
 226 /*
 227  * Create a new socket associated with a VRF.
 228  *
 229  * This is a wrapper that ensures correct behavior when using namespace VRFs.
 230  * In the namespace case, the socket is created within the namespace. In the
 231  * non-namespace case, this is equivalent to socket().
 232  *
 233  * If name is provided, this is provided to vrf_bind() to bind the socket to
 234  * the VRF. This is only relevant when using VRF-lite.
 235  *
 236  * Summary:
 237  * - Namespace: pass vrf_id but not name
 238  * - VRF-lite: pass vrf_id and name of VRF device to bind to
 239  * - VRF-lite, no binding: pass vrf_id but not name, or just use socket()
 240  */
 241 extern int vrf_socket(int domain, int type, int protocol, vrf_id_t vrf_id,
 242                       const char *name);
 243
 244 extern int vrf_sockunion_socket(const union sockunion *su, vrf_id_t vrf_id,
 245                                 const char *name);
 246
 247 /*
 248  * Binds a socket to a VRF device.
 249  *
 250  * If name is null, the socket is not bound, irrespective of any other
 251  * arguments.
 252  *
 253  * name should be the name of the VRF device. vrf_id should be the
 254  * corresponding vrf_id (the ifindex of the device).
 255  */
 256 extern int vrf_bind(vrf_id_t vrf_id, int fd, const char *name);
 257
 258 /* VRF ioctl operations */
 259 extern int vrf_getaddrinfo(const char *node, const char *service,
 260                            const struct addrinfo *hints, struct addrinfo **res,
 261                            vrf_id_t vrf_id);
 262
 263 extern int vrf_ioctl(vrf_id_t vrf_id, int d, unsigned long request, char *args);
 264
 265 /* The default VRF ID */
 266 #define VRF_DEFAULT 0
 267
 268 extern void vrf_set_default_name(const char *default_name, bool force);
 269 extern const char *vrf_get_default_name(void);
 270 #define VRF_DEFAULT_NAME    vrf_get_default_name()
 271
 272 /* VRF switch from NETNS */
 273 extern int vrf_switch_to_netns(vrf_id_t vrf_id);
 274 extern int vrf_switchback_to_initial(void);
 275
 276 /*
 277  * VRF backend routines
 278  * should be called from zebra only
 279  */
 280
 281 /* VRF vty command initialisation
 282  */
 283 extern void vrf_cmd_init(int (*writefunc)(struct vty *vty),
 284                          struct zebra_privs_t *daemon_priv);
 285
 286 /* VRF vty debugging
 287  */
 288 extern void vrf_install_commands(void);
 289
 290 /*
 291  * VRF utilities
 292  */
 293
 294 /*
 295  * API for configuring VRF backend
 296  */
 297 extern int vrf_configure_backend(enum vrf_backend_type backend);
 298 extern int vrf_get_backend(void);
 299 extern int vrf_is_backend_netns(void);
 300
 301
 302 /* API to create a VRF. either from vty
 303  * or through discovery
 304  */
 305 extern int vrf_handler_create(struct vty *vty, const char *name,
 306                               struct vrf **vrf);
 307
 308 /* API to associate a VRF with a NETNS.
 309  * called either from vty or through discovery
 310  * should be called from zebra only
 311  */
 312 extern int vrf_netns_handler_create(struct vty *vty, struct vrf *vrf,
 313                                     char *pathname, ns_id_t ext_ns_id,
 314                                     ns_id_t ns_id, ns_id_t rel_def_ns_id);
 315
 316 /* used internally to enable or disable VRF.
 317  * Notify a change in the VRF ID of the VRF
 318  */
 319 extern void vrf_disable(struct vrf *vrf);
 320 extern int vrf_enable(struct vrf *vrf);
 321 extern void vrf_delete(struct vrf *vrf);
 322 extern vrf_id_t vrf_generate_id(void);
 323
 324 extern const struct frr_yang_module_info frr_vrf_info;
 325
 326 #ifdef __cplusplus
 327 }
 328 #endif
 329
 330 #endif /*_ZEBRA_VRF_H*/