[mirror_frr.git] / lib / vrf.h

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * VRF related header.
 * Copyright (C) 2014 6WIND S.A.
 */

#ifndef _ZEBRA_VRF_H
#define _ZEBRA_VRF_H

#include "openbsd-tree.h"
#include "linklist.h"
#include "qobj.h"
#include "vty.h"
#include "ns.h"

#ifdef __cplusplus
extern "C" {
#endif

/* The default VRF ID */
#define VRF_UNKNOWN UINT32_MAX

/* Pending: May need to refine this. */
#ifndef IFLA_VRF_MAX
enum { IFLA_VRF_UNSPEC, IFLA_VRF_TABLE, __IFLA_VRF_MAX };

#define IFLA_VRF_MAX (__IFLA_VRF_MAX - 1)
#endif

#define VRF_NAMSIZ      36
#define NS_NAMSIZ 36

/*
 * The command strings
 */
#define VRF_CMD_HELP_STR    "Specify the VRF\nThe VRF name\n"
#define VRF_ALL_CMD_HELP_STR    "Specify the VRF\nAll VRFs\n"
#define VRF_FULL_CMD_HELP_STR   "Specify the VRF\nThe VRF name\nAll VRFs\n"

#define FRR_VRF_XPATH "/frr-vrf:lib/vrf"
#define FRR_VRF_KEY_XPATH "/frr-vrf:lib/vrf[name='%s']"

/*
 * Pass some OS specific data up through
 * to the daemons
 */
struct vrf_data {
	union {
		struct {
			uint32_t table_id;
			char netns_name[NS_NAMSIZ];
		} l;
	};
};

struct vrf {
	RB_ENTRY(vrf) id_entry, name_entry;

	/* Identifier, same as the vector index */
	vrf_id_t vrf_id;

	/* Name */
	char name[VRF_NAMSIZ + 1];

	/* Zebra internal VRF status */
	uint8_t status;
#define VRF_ACTIVE     (1 << 0) /* VRF is up in kernel */
#define VRF_CONFIGURED (1 << 1) /* VRF has some FRR configuration */

	/* Interfaces belonging to this VRF */
	struct if_name_head ifaces_by_name;
	struct if_index_head ifaces_by_index;

	/* User data */
	void *info;

	/* The table_id from the kernel */
	struct vrf_data data;

	/* Back pointer to namespace context */
	void *ns_ctxt;

	QOBJ_FIELDS;
};
RB_HEAD(vrf_id_head, vrf);
RB_PROTOTYPE(vrf_id_head, vrf, id_entry, vrf_id_compare)
RB_HEAD(vrf_name_head, vrf);
RB_PROTOTYPE(vrf_name_head, vrf, name_entry, vrf_name_compare)
DECLARE_QOBJ_TYPE(vrf);

/* Allow VRF with netns as backend */
enum vrf_backend_type {
	VRF_BACKEND_VRF_LITE,
	VRF_BACKEND_NETNS,
	VRF_BACKEND_UNKNOWN,
	VRF_BACKEND_MAX,
};

extern struct vrf_id_head vrfs_by_id;
extern struct vrf_name_head vrfs_by_name;

extern struct vrf *vrf_lookup_by_id(vrf_id_t);
extern struct vrf *vrf_lookup_by_name(const char *);
extern struct vrf *vrf_get(vrf_id_t, const char *);
extern struct vrf *vrf_update(vrf_id_t new_vrf_id, const char *name);
extern const char *vrf_id_to_name(vrf_id_t vrf_id);

#define VRF_LOGNAME(V) V ? V->name : "Unknown"

#define VRF_GET_ID(V, NAME, USE_JSON)                                          \
	do {                                                                   \
		struct vrf *_vrf;                                              \
		if (!(_vrf = vrf_lookup_by_name(NAME))) {                      \
			if (USE_JSON) {                                        \
				vty_out(vty, "{}\n");                          \
			} else {                                               \
				vty_out(vty, "%% VRF %s not found\n", NAME);   \
			}                                                      \
			return CMD_WARNING;                                    \
		}                                                              \
		if (_vrf->vrf_id == VRF_UNKNOWN) {                             \
			if (USE_JSON) {                                        \
				vty_out(vty, "{}\n");                          \
			} else {                                               \
				vty_out(vty, "%% VRF %s not active\n", NAME);  \
			}                                                      \
			return CMD_WARNING;                                    \
		}                                                              \
		(V) = _vrf->vrf_id;                                            \
	} while (0)

/*
 * Check whether the VRF is enabled.
 */
static inline int vrf_is_enabled(struct vrf *vrf)
{
	return vrf && CHECK_FLAG(vrf->status, VRF_ACTIVE);
}

/* check if the vrf is user configured */
static inline int vrf_is_user_cfged(struct vrf *vrf)
{
	return vrf && CHECK_FLAG(vrf->status, VRF_CONFIGURED);
}

static inline uint32_t vrf_interface_count(struct vrf *vrf)
{
	uint32_t count = 0;
	struct interface *ifp;

	RB_FOREACH (ifp, if_name_head, &vrf->ifaces_by_name) {
		/* skip the l3mdev */
		if (strncmp(ifp->name, vrf->name, VRF_NAMSIZ) == 0)
			continue;
		count++;
	}
	return count;
}

/*
 * Utilities to obtain the user data
 */

/* Look up the data pointer of the specified VRF. */
extern void *vrf_info_lookup(vrf_id_t);

/*
 * VRF bit-map: maintaining flags, one bit per VRF ID
 */

typedef void *vrf_bitmap_t;
#define VRF_BITMAP_NULL     NULL

extern vrf_bitmap_t vrf_bitmap_init(void);
extern void vrf_bitmap_free(vrf_bitmap_t);
extern void vrf_bitmap_set(vrf_bitmap_t, vrf_id_t);
extern void vrf_bitmap_unset(vrf_bitmap_t, vrf_id_t);
extern int vrf_bitmap_check(vrf_bitmap_t, vrf_id_t);

/*
 * VRF initializer/destructor
 *
 * create -> Called back when a new VRF is created.  This
 *           can be either through these 3 options:
 *           1) CLI mentions a vrf before OS knows about it
 *           2) OS calls zebra and we create the vrf from OS
 *              callback
 *           3) zebra calls individual protocols to notify
 *              about the new vrf
 *
 * enable -> Called back when a VRF is actually usable from
 *           an OS perspective ( 2 and 3 above )
 *
 * disable -> Called back when a VRF is being deleted from
 *            the system ( 2 and 3 ) above
 *
 * delete -> Called back when a vrf is being deleted from
 *           the system ( 2 and 3 ) above.
 */
extern void vrf_init(int (*create)(struct vrf *vrf),
		     int (*enable)(struct vrf *vrf),
		     int (*disable)(struct vrf *vrf),
		     int (*destroy)(struct vrf *vrf));

/*
 * Call vrf_terminate when the protocol is being shutdown
 */
extern void vrf_terminate(void);

/*
 * Utilities to create networks objects,
 * or call network operations
 */

/*
 * Create a new socket associated with a VRF.
 *
 * This is a wrapper that ensures correct behavior when using namespace VRFs.
 * In the namespace case, the socket is created within the namespace. In the
 * non-namespace case, this is equivalent to socket().
 *
 * If name is provided, this is provided to vrf_bind() to bind the socket to
 * the VRF. This is only relevant when using VRF-lite.
 *
 * Summary:
 * - Namespace: pass vrf_id but not name
 * - VRF-lite: pass vrf_id and name of VRF device to bind to
 * - VRF-lite, no binding: pass vrf_id but not name, or just use socket()
 */
extern int vrf_socket(int domain, int type, int protocol, vrf_id_t vrf_id,
		      const char *name);

extern int vrf_sockunion_socket(const union sockunion *su, vrf_id_t vrf_id,
				const char *name);

/*
 * Binds a socket to an interface (ifname) in a VRF (vrf_id).
 *
 * If ifname is NULL or is equal to the VRF name then bind to a VRF device.
 * Otherwise, bind to the specified interface in the specified VRF.
 *
 * Returns 0 on success and -1 on failure.
 */
extern int vrf_bind(vrf_id_t vrf_id, int fd, const char *ifname);

/* VRF ioctl operations */
extern int vrf_getaddrinfo(const char *node, const char *service,
			   const struct addrinfo *hints, struct addrinfo **res,
			   vrf_id_t vrf_id);

extern int vrf_ioctl(vrf_id_t vrf_id, int d, unsigned long request, char *args);

/* The default VRF ID */
#define VRF_DEFAULT 0

/* Must be called only during startup, before config is read */
extern void vrf_set_default_name(const char *default_name);

extern const char *vrf_get_default_name(void);
#define VRF_DEFAULT_NAME    vrf_get_default_name()

/* VRF switch from NETNS */
extern int vrf_switch_to_netns(vrf_id_t vrf_id);
extern int vrf_switchback_to_initial(void);

/*
 * VRF backend routines
 * should be called from zebra only
 */

/* VRF vty command initialisation
 */
extern void vrf_cmd_init(int (*writefunc)(struct vty *vty));

/* VRF vty debugging
 */
extern void vrf_install_commands(void);

/*
 * VRF utilities
 */

/*
 * API for configuring VRF backend
 */
extern int vrf_configure_backend(enum vrf_backend_type backend);
extern int vrf_get_backend(void);
extern int vrf_is_backend_netns(void);

/* used internally to enable or disable VRF.
 * Notify a change in the VRF ID of the VRF
 */
extern void vrf_disable(struct vrf *vrf);
extern int vrf_enable(struct vrf *vrf);
extern void vrf_delete(struct vrf *vrf);

extern const struct frr_yang_module_info frr_vrf_info;

#ifdef __cplusplus
}
#endif

#endif /*_ZEBRA_VRF_H*/
Commit	Line	Data
	1	// SPDX-License-Identifier: GPL-2.0-or-later
	2	/*
	3	* VRF related header.
	4	* Copyright (C) 2014 6WIND S.A.
	5	*/
	6
	7	#ifndef _ZEBRA_VRF_H
	8	#define _ZEBRA_VRF_H
	9
	10	#include "openbsd-tree.h"
	11	#include "linklist.h"
	12	#include "qobj.h"
	13	#include "vty.h"
	14	#include "ns.h"
	15
	16	#ifdef __cplusplus
	17	extern "C" {
	18	#endif
	19
	20	/* The default VRF ID */
	21	#define VRF_UNKNOWN UINT32_MAX
	22
	23	/* Pending: May need to refine this. */
	24	#ifndef IFLA_VRF_MAX
	25	enum { IFLA_VRF_UNSPEC, IFLA_VRF_TABLE, __IFLA_VRF_MAX };
	26
	27	#define IFLA_VRF_MAX (__IFLA_VRF_MAX - 1)
	28	#endif
	29
	30	#define VRF_NAMSIZ 36
	31	#define NS_NAMSIZ 36
	32
	33	/*
	34	* The command strings
	35	*/
	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"
	39
	40	#define FRR_VRF_XPATH "/frr-vrf:lib/vrf"
	41	#define FRR_VRF_KEY_XPATH "/frr-vrf:lib/vrf[name='%s']"
	42
	43	/*
	44	* Pass some OS specific data up through
	45	* to the daemons
	46	*/
	47	struct vrf_data {
	48	union {
	49	struct {
	50	uint32_t table_id;
	51	char netns_name[NS_NAMSIZ];
	52	} l;
	53	};
	54	};
	55
	56	struct vrf {
	57	RB_ENTRY(vrf) id_entry, name_entry;
	58
	59	/* Identifier, same as the vector index */
	60	vrf_id_t vrf_id;
	61
	62	/* Name */
	63	char name[VRF_NAMSIZ + 1];
	64
	65	/* Zebra internal VRF status */
	66	uint8_t status;
	67	#define VRF_ACTIVE (1 << 0) /* VRF is up in kernel */
	68	#define VRF_CONFIGURED (1 << 1) /* VRF has some FRR configuration */
	69
	70	/* Interfaces belonging to this VRF */
	71	struct if_name_head ifaces_by_name;
	72	struct if_index_head ifaces_by_index;
	73
	74	/* User data */
	75	void *info;
	76
	77	/* The table_id from the kernel */
	78	struct vrf_data data;
	79
	80	/* Back pointer to namespace context */
	81	void *ns_ctxt;
	82
	83	QOBJ_FIELDS;
	84	};
	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);
	90
	91	/* Allow VRF with netns as backend */
	92	enum vrf_backend_type {
	93	VRF_BACKEND_VRF_LITE,
	94	VRF_BACKEND_NETNS,
	95	VRF_BACKEND_UNKNOWN,
	96	VRF_BACKEND_MAX,
	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 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);
	107
	108	#define VRF_LOGNAME(V) V ? V->name : "Unknown"
	109
	110	#define VRF_GET_ID(V, NAME, USE_JSON) \
	111	do { \
	112	struct vrf *_vrf; \
	113	if (!(_vrf = vrf_lookup_by_name(NAME))) { \
	114	if (USE_JSON) { \
	115	vty_out(vty, "{}\n"); \
	116	} else { \
	117	vty_out(vty, "%% VRF %s not found\n", NAME); \
	118	} \
	119	return CMD_WARNING; \
	120	} \
	121	if (_vrf->vrf_id == VRF_UNKNOWN) { \
	122	if (USE_JSON) { \
	123	vty_out(vty, "{}\n"); \
	124	} else { \
	125	vty_out(vty, "%% VRF %s not active\n", NAME); \
	126	} \
	127	return CMD_WARNING; \
	128	} \
	129	(V) = _vrf->vrf_id; \
	130	} while (0)
	131
	132	/*
	133	* Check whether the VRF is enabled.
	134	*/
	135	static inline int vrf_is_enabled(struct vrf *vrf)
	136	{
	137	return vrf && CHECK_FLAG(vrf->status, VRF_ACTIVE);
	138	}
	139
	140	/* check if the vrf is user configured */
	141	static inline int vrf_is_user_cfged(struct vrf *vrf)
	142	{
	143	return vrf && CHECK_FLAG(vrf->status, VRF_CONFIGURED);
	144	}
	145
	146	static inline uint32_t vrf_interface_count(struct vrf *vrf)
	147	{
	148	uint32_t count = 0;
	149	struct interface *ifp;
	150
	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)
	154	continue;
	155	count++;
	156	}
	157	return count;
	158	}
	159
	160	/*
	161	* Utilities to obtain the user data
	162	*/
	163
	164	/* Look up the data pointer of the specified VRF. */
	165	extern void *vrf_info_lookup(vrf_id_t);
	166
	167	/*
	168	* VRF bit-map: maintaining flags, one bit per VRF ID
	169	*/
	170
	171	typedef void *vrf_bitmap_t;
	172	#define VRF_BITMAP_NULL NULL
	173
	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);
	179
	180	/*
	181	* VRF initializer/destructor
	182	*
	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
	187	* callback
	188	* 3) zebra calls individual protocols to notify
	189	* about the new vrf
	190	*
	191	* enable -> Called back when a VRF is actually usable from
	192	* an OS perspective ( 2 and 3 above )
	193	*
	194	* disable -> Called back when a VRF is being deleted from
	195	* the system ( 2 and 3 ) above
	196	*
	197	* delete -> Called back when a vrf is being deleted from
	198	* the system ( 2 and 3 ) above.
	199	*/
	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));
	204
	205	/*
	206	* Call vrf_terminate when the protocol is being shutdown
	207	*/
	208	extern void vrf_terminate(void);
	209
	210	/*
	211	* Utilities to create networks objects,
	212	* or call network operations
	213	*/
	214
	215	/*
	216	* Create a new socket associated with a VRF.
	217	*
	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().
	221	*
	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.
	224	*
	225	* Summary:
	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()
	229	*/
	230	extern int vrf_socket(int domain, int type, int protocol, vrf_id_t vrf_id,
	231	const char *name);
	232
	233	extern int vrf_sockunion_socket(const union sockunion *su, vrf_id_t vrf_id,
	234	const char *name);
	235
	236	/*
	237	* Binds a socket to an interface (ifname) in a VRF (vrf_id).
	238	*
	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.
	241	*
	242	* Returns 0 on success and -1 on failure.
	243	*/
	244	extern int vrf_bind(vrf_id_t vrf_id, int fd, const char *ifname);
	245
	246	/* VRF ioctl operations */
	247	extern int vrf_getaddrinfo(const char node, const char service,
	248	const struct addrinfo hints, struct addrinfo *res,
	249	vrf_id_t vrf_id);
	250
	251	extern int vrf_ioctl(vrf_id_t vrf_id, int d, unsigned long request, char *args);
	252
	253	/* The default VRF ID */
	254	#define VRF_DEFAULT 0
	255
	256	/* Must be called only during startup, before config is read */
	257	extern void vrf_set_default_name(const char *default_name);
	258
	259	extern const char *vrf_get_default_name(void);
	260	#define VRF_DEFAULT_NAME vrf_get_default_name()
	261
	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);
	265
	266	/*
	267	* VRF backend routines
	268	* should be called from zebra only
	269	*/
	270
	271	/* VRF vty command initialisation
	272	*/
	273	extern void vrf_cmd_init(int (writefunc)(struct vty vty));
	274
	275	/* VRF vty debugging
	276	*/
	277	extern void vrf_install_commands(void);
	278
	279	/*
	280	* VRF utilities
	281	*/
	282
	283	/*
	284	* API for configuring VRF backend
	285	*/
	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);
	289
	290	/* used internally to enable or disable VRF.
	291	* Notify a change in the VRF ID of the VRF
	292	*/
	293	extern void vrf_disable(struct vrf *vrf);
	294	extern int vrf_enable(struct vrf *vrf);
	295	extern void vrf_delete(struct vrf *vrf);
	296
	297	extern const struct frr_yang_module_info frr_vrf_info;
	298
	299	#ifdef __cplusplus
	300	}
	301	#endif
	302
	303	#endif /_ZEBRA_VRF_H/