3 * Copyright (C) 2014 6WIND S.A.
5 * This file is part of GNU Zebra.
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.
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.
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
25 #include "openbsd-tree.h"
35 /* The default VRF ID */
36 #define VRF_UNKNOWN UINT32_MAX
38 /* Pending: May need to refine this. */
40 enum { IFLA_VRF_UNSPEC
, IFLA_VRF_TABLE
, __IFLA_VRF_MAX
};
42 #define IFLA_VRF_MAX (__IFLA_VRF_MAX - 1)
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"
55 #define FRR_VRF_XPATH "/frr-vrf:lib/vrf"
56 #define FRR_VRF_KEY_XPATH "/frr-vrf:lib/vrf[name='%s']"
59 * Pass some OS specific data up through
66 char netns_name
[NS_NAMSIZ
];
72 RB_ENTRY(vrf
) id_entry
, name_entry
;
74 /* Identifier, same as the vector index */
78 char name
[VRF_NAMSIZ
+ 1];
80 /* Zebra internal VRF status */
82 #define VRF_ACTIVE (1 << 0) /* VRF is up in kernel */
83 #define VRF_CONFIGURED (1 << 1) /* VRF has some FRR configuration */
85 /* Interfaces belonging to this VRF */
86 struct if_name_head ifaces_by_name
;
87 struct if_index_head ifaces_by_index
;
92 /* The table_id from the kernel */
95 /* Back pointer to namespace context */
100 RB_HEAD(vrf_id_head
, vrf
);
101 RB_PROTOTYPE(vrf_id_head
, vrf
, id_entry
, vrf_id_compare
)
102 RB_HEAD(vrf_name_head
, vrf
);
103 RB_PROTOTYPE(vrf_name_head
, vrf
, name_entry
, vrf_name_compare
)
104 DECLARE_QOBJ_TYPE(vrf
);
106 /* Allow VRF with netns as backend */
107 enum vrf_backend_type
{
108 VRF_BACKEND_VRF_LITE
,
114 extern struct vrf_id_head vrfs_by_id
;
115 extern struct vrf_name_head vrfs_by_name
;
117 extern struct vrf
*vrf_lookup_by_id(vrf_id_t
);
118 extern struct vrf
*vrf_lookup_by_name(const char *);
119 extern struct vrf
*vrf_get(vrf_id_t
, const char *);
120 extern struct vrf
*vrf_update(vrf_id_t new_vrf_id
, const char *name
);
121 extern const char *vrf_id_to_name(vrf_id_t vrf_id
);
123 #define VRF_LOGNAME(V) V ? V->name : "Unknown"
125 #define VRF_GET_ID(V, NAME, USE_JSON) \
128 if (!(_vrf = vrf_lookup_by_name(NAME))) { \
130 vty_out(vty, "{}\n"); \
132 vty_out(vty, "%% VRF %s not found\n", NAME); \
134 return CMD_WARNING; \
136 if (_vrf->vrf_id == VRF_UNKNOWN) { \
138 vty_out(vty, "{}\n"); \
140 vty_out(vty, "%% VRF %s not active\n", NAME); \
142 return CMD_WARNING; \
144 (V) = _vrf->vrf_id; \
148 * Check whether the VRF is enabled.
150 static inline int vrf_is_enabled(struct vrf
*vrf
)
152 return vrf
&& CHECK_FLAG(vrf
->status
, VRF_ACTIVE
);
155 /* check if the vrf is user configured */
156 static inline int vrf_is_user_cfged(struct vrf
*vrf
)
158 return vrf
&& CHECK_FLAG(vrf
->status
, VRF_CONFIGURED
);
161 static inline uint32_t vrf_interface_count(struct vrf
*vrf
)
164 struct interface
*ifp
;
166 RB_FOREACH (ifp
, if_name_head
, &vrf
->ifaces_by_name
) {
167 /* skip the l3mdev */
168 if (strncmp(ifp
->name
, vrf
->name
, VRF_NAMSIZ
) == 0)
176 * Utilities to obtain the user data
179 /* Get the data pointer of the specified VRF. If not found, create one. */
180 extern void *vrf_info_get(vrf_id_t
);
181 /* Look up the data pointer of the specified VRF. */
182 extern void *vrf_info_lookup(vrf_id_t
);
185 * VRF bit-map: maintaining flags, one bit per VRF ID
188 typedef void *vrf_bitmap_t
;
189 #define VRF_BITMAP_NULL NULL
191 extern vrf_bitmap_t
vrf_bitmap_init(void);
192 extern void vrf_bitmap_free(vrf_bitmap_t
);
193 extern void vrf_bitmap_set(vrf_bitmap_t
, vrf_id_t
);
194 extern void vrf_bitmap_unset(vrf_bitmap_t
, vrf_id_t
);
195 extern int vrf_bitmap_check(vrf_bitmap_t
, vrf_id_t
);
198 * VRF initializer/destructor
200 * create -> Called back when a new VRF is created. This
201 * can be either through these 3 options:
202 * 1) CLI mentions a vrf before OS knows about it
203 * 2) OS calls zebra and we create the vrf from OS
205 * 3) zebra calls individual protocols to notify
208 * enable -> Called back when a VRF is actually usable from
209 * an OS perspective ( 2 and 3 above )
211 * disable -> Called back when a VRF is being deleted from
212 * the system ( 2 and 3 ) above
214 * delete -> Called back when a vrf is being deleted from
215 * the system ( 2 and 3 ) above.
217 extern void vrf_init(int (*create
)(struct vrf
*vrf
), int (*enable
)(struct vrf
*vrf
),
218 int (*disable
)(struct vrf
*vrf
), int (*destroy
)(struct vrf
*vrf
),
219 int (*update
)(struct vrf
*vrf
));
222 * Call vrf_terminate when the protocol is being shutdown
224 extern void vrf_terminate(void);
227 * Utilities to create networks objects,
228 * or call network operations
232 * Create a new socket associated with a VRF.
234 * This is a wrapper that ensures correct behavior when using namespace VRFs.
235 * In the namespace case, the socket is created within the namespace. In the
236 * non-namespace case, this is equivalent to socket().
238 * If name is provided, this is provided to vrf_bind() to bind the socket to
239 * the VRF. This is only relevant when using VRF-lite.
242 * - Namespace: pass vrf_id but not name
243 * - VRF-lite: pass vrf_id and name of VRF device to bind to
244 * - VRF-lite, no binding: pass vrf_id but not name, or just use socket()
246 extern int vrf_socket(int domain
, int type
, int protocol
, vrf_id_t vrf_id
,
249 extern int vrf_sockunion_socket(const union sockunion
*su
, vrf_id_t vrf_id
,
253 * Binds a socket to an interface (ifname) in a VRF (vrf_id).
255 * If ifname is NULL or is equal to the VRF name then bind to a VRF device.
256 * Otherwise, bind to the specified interface in the specified VRF.
258 * Returns 0 on success and -1 on failure.
260 extern int vrf_bind(vrf_id_t vrf_id
, int fd
, const char *ifname
);
262 /* VRF ioctl operations */
263 extern int vrf_getaddrinfo(const char *node
, const char *service
,
264 const struct addrinfo
*hints
, struct addrinfo
**res
,
267 extern int vrf_ioctl(vrf_id_t vrf_id
, int d
, unsigned long request
, char *args
);
269 /* The default VRF ID */
270 #define VRF_DEFAULT 0
272 extern void vrf_set_default_name(const char *default_name
, bool force
);
273 extern const char *vrf_get_default_name(void);
274 #define VRF_DEFAULT_NAME vrf_get_default_name()
276 /* VRF switch from NETNS */
277 extern int vrf_switch_to_netns(vrf_id_t vrf_id
);
278 extern int vrf_switchback_to_initial(void);
281 * VRF backend routines
282 * should be called from zebra only
285 /* VRF vty command initialisation
287 extern void vrf_cmd_init(int (*writefunc
)(struct vty
*vty
));
291 extern void vrf_install_commands(void);
298 * API for configuring VRF backend
300 extern int vrf_configure_backend(enum vrf_backend_type backend
);
301 extern int vrf_get_backend(void);
302 extern int vrf_is_backend_netns(void);
304 /* used internally to enable or disable VRF.
305 * Notify a change in the VRF ID of the VRF
307 extern void vrf_disable(struct vrf
*vrf
);
308 extern int vrf_enable(struct vrf
*vrf
);
309 extern void vrf_delete(struct vrf
*vrf
);
311 extern const struct frr_yang_module_info frr_vrf_info
;
317 #endif /*_ZEBRA_VRF_H*/