1 // SPDX-License-Identifier: GPL-2.0-or-later
4 * Copyright (C) 2014 6WIND S.A.
10 #include "openbsd-tree.h"
20 /* The default VRF ID */
21 #define VRF_UNKNOWN UINT32_MAX
23 /* Pending: May need to refine this. */
25 enum { IFLA_VRF_UNSPEC
, IFLA_VRF_TABLE
, __IFLA_VRF_MAX
};
27 #define IFLA_VRF_MAX (__IFLA_VRF_MAX - 1)
36 #define VRF_CMD_HELP_STR "Specify the VRF\nThe VRF name\n"
37 #define VRF_ALL_CMD_HELP_STR "Specify the VRF\nAll VRFs\n"
38 #define VRF_FULL_CMD_HELP_STR "Specify the VRF\nThe VRF name\nAll VRFs\n"
40 #define FRR_VRF_XPATH "/frr-vrf:lib/vrf"
41 #define FRR_VRF_KEY_XPATH "/frr-vrf:lib/vrf[name='%s']"
44 * Pass some OS specific data up through
51 char netns_name
[NS_NAMSIZ
];
57 RB_ENTRY(vrf
) id_entry
, name_entry
;
59 /* Identifier, same as the vector index */
63 char name
[VRF_NAMSIZ
+ 1];
65 /* Zebra internal VRF status */
67 #define VRF_ACTIVE (1 << 0) /* VRF is up in kernel */
68 #define VRF_CONFIGURED (1 << 1) /* VRF has some FRR configuration */
70 /* Interfaces belonging to this VRF */
71 struct if_name_head ifaces_by_name
;
72 struct if_index_head ifaces_by_index
;
77 /* The table_id from the kernel */
80 /* Back pointer to namespace context */
85 RB_HEAD(vrf_id_head
, vrf
);
86 RB_PROTOTYPE(vrf_id_head
, vrf
, id_entry
, vrf_id_compare
)
87 RB_HEAD(vrf_name_head
, vrf
);
88 RB_PROTOTYPE(vrf_name_head
, vrf
, name_entry
, vrf_name_compare
)
89 DECLARE_QOBJ_TYPE(vrf
);
91 /* Allow VRF with netns as backend */
92 enum vrf_backend_type
{
99 extern struct vrf_id_head vrfs_by_id
;
100 extern struct vrf_name_head vrfs_by_name
;
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 struct vrf
*vrf_update(vrf_id_t new_vrf_id
, const char *name
);
106 extern const char *vrf_id_to_name(vrf_id_t vrf_id
);
108 #define VRF_LOGNAME(V) V ? V->name : "Unknown"
110 #define VRF_GET_ID(V, NAME, USE_JSON) \
113 if (!(_vrf = vrf_lookup_by_name(NAME))) { \
115 vty_out(vty, "{}\n"); \
117 vty_out(vty, "%% VRF %s not found\n", NAME); \
119 return CMD_WARNING; \
121 if (_vrf->vrf_id == VRF_UNKNOWN) { \
123 vty_out(vty, "{}\n"); \
125 vty_out(vty, "%% VRF %s not active\n", NAME); \
127 return CMD_WARNING; \
129 (V) = _vrf->vrf_id; \
133 * Check whether the VRF is enabled.
135 static inline int vrf_is_enabled(struct vrf
*vrf
)
137 return vrf
&& CHECK_FLAG(vrf
->status
, VRF_ACTIVE
);
140 /* check if the vrf is user configured */
141 static inline int vrf_is_user_cfged(struct vrf
*vrf
)
143 return vrf
&& CHECK_FLAG(vrf
->status
, VRF_CONFIGURED
);
146 static inline uint32_t vrf_interface_count(struct vrf
*vrf
)
149 struct interface
*ifp
;
151 RB_FOREACH (ifp
, if_name_head
, &vrf
->ifaces_by_name
) {
152 /* skip the l3mdev */
153 if (strncmp(ifp
->name
, vrf
->name
, VRF_NAMSIZ
) == 0)
161 * Utilities to obtain the user data
164 /* Look up the data pointer of the specified VRF. */
165 extern void *vrf_info_lookup(vrf_id_t
);
168 * VRF bit-map: maintaining flags, one bit per VRF ID
171 typedef void *vrf_bitmap_t
;
172 #define VRF_BITMAP_NULL NULL
174 extern vrf_bitmap_t
vrf_bitmap_init(void);
175 extern void vrf_bitmap_free(vrf_bitmap_t
);
176 extern void vrf_bitmap_set(vrf_bitmap_t
, vrf_id_t
);
177 extern void vrf_bitmap_unset(vrf_bitmap_t
, vrf_id_t
);
178 extern int vrf_bitmap_check(vrf_bitmap_t
, vrf_id_t
);
181 * VRF initializer/destructor
183 * create -> Called back when a new VRF is created. This
184 * can be either through these 3 options:
185 * 1) CLI mentions a vrf before OS knows about it
186 * 2) OS calls zebra and we create the vrf from OS
188 * 3) zebra calls individual protocols to notify
191 * enable -> Called back when a VRF is actually usable from
192 * an OS perspective ( 2 and 3 above )
194 * disable -> Called back when a VRF is being deleted from
195 * the system ( 2 and 3 ) above
197 * delete -> Called back when a vrf is being deleted from
198 * the system ( 2 and 3 ) above.
200 extern void vrf_init(int (*create
)(struct vrf
*vrf
),
201 int (*enable
)(struct vrf
*vrf
),
202 int (*disable
)(struct vrf
*vrf
),
203 int (*destroy
)(struct vrf
*vrf
));
206 * Call vrf_terminate when the protocol is being shutdown
208 extern void vrf_terminate(void);
211 * Utilities to create networks objects,
212 * or call network operations
216 * Create a new socket associated with a VRF.
218 * This is a wrapper that ensures correct behavior when using namespace VRFs.
219 * In the namespace case, the socket is created within the namespace. In the
220 * non-namespace case, this is equivalent to socket().
222 * If name is provided, this is provided to vrf_bind() to bind the socket to
223 * the VRF. This is only relevant when using VRF-lite.
226 * - Namespace: pass vrf_id but not name
227 * - VRF-lite: pass vrf_id and name of VRF device to bind to
228 * - VRF-lite, no binding: pass vrf_id but not name, or just use socket()
230 extern int vrf_socket(int domain
, int type
, int protocol
, vrf_id_t vrf_id
,
233 extern int vrf_sockunion_socket(const union sockunion
*su
, vrf_id_t vrf_id
,
237 * Binds a socket to an interface (ifname) in a VRF (vrf_id).
239 * If ifname is NULL or is equal to the VRF name then bind to a VRF device.
240 * Otherwise, bind to the specified interface in the specified VRF.
242 * Returns 0 on success and -1 on failure.
244 extern int vrf_bind(vrf_id_t vrf_id
, int fd
, const char *ifname
);
246 /* VRF ioctl operations */
247 extern int vrf_getaddrinfo(const char *node
, const char *service
,
248 const struct addrinfo
*hints
, struct addrinfo
**res
,
251 extern int vrf_ioctl(vrf_id_t vrf_id
, int d
, unsigned long request
, char *args
);
253 /* The default VRF ID */
254 #define VRF_DEFAULT 0
256 /* Must be called only during startup, before config is read */
257 extern void vrf_set_default_name(const char *default_name
);
259 extern const char *vrf_get_default_name(void);
260 #define VRF_DEFAULT_NAME vrf_get_default_name()
262 /* VRF switch from NETNS */
263 extern int vrf_switch_to_netns(vrf_id_t vrf_id
);
264 extern int vrf_switchback_to_initial(void);
267 * VRF backend routines
268 * should be called from zebra only
271 /* VRF vty command initialisation
273 extern void vrf_cmd_init(int (*writefunc
)(struct vty
*vty
));
277 extern void vrf_install_commands(void);
284 * API for configuring VRF backend
286 extern int vrf_configure_backend(enum vrf_backend_type backend
);
287 extern int vrf_get_backend(void);
288 extern int vrf_is_backend_netns(void);
290 /* used internally to enable or disable VRF.
291 * Notify a change in the VRF ID of the VRF
293 extern void vrf_disable(struct vrf
*vrf
);
294 extern int vrf_enable(struct vrf
*vrf
);
295 extern void vrf_delete(struct vrf
*vrf
);
297 extern const struct frr_yang_module_info frr_vrf_info
;
303 #endif /*_ZEBRA_VRF_H*/