[mirror_frr.git] / lib / vrf.h

/*
 * VRF related header.
 * Copyright (C) 2014 6WIND S.A.
 *
 * This file is part of GNU Zebra.
 *
 * GNU Zebra is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation; either version 2, or (at your
 * option) any later version.
 *
 * GNU Zebra is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; see the file COPYING; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef _ZEBRA_VRF_H
#define _ZEBRA_VRF_H

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

/* 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       16

#define VRF_DEFAULT_NAME    "Default-IP-Routing-Table"

/*
 * 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"

/*
 * 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 */
#define VRF_BACKEND_VRF_LITE 0
#define VRF_BACKEND_NETNS    1

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 const char *vrf_id_to_name(vrf_id_t vrf_id);
extern vrf_id_t vrf_name_to_id(const char *);

#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);   \
			}                                                      \
			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);
}

/* Mark that VRF has user configuration */
static inline void vrf_set_user_cfged(struct vrf *vrf)
{
	SET_FLAG(vrf->status, VRF_CONFIGURED);
}

/* Mark that VRF no longer has any user configuration */
static inline void vrf_reset_user_cfged(struct vrf *vrf)
{
	UNSET_FLAG(vrf->status, VRF_CONFIGURED);
}

/*
 * Utilities to obtain the user data
 */

/* Get the data pointer of the specified VRF. If not found, create one. */
extern void *vrf_info_get(vrf_id_t);
/* 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 *), int (*enable)(struct vrf *),
		     int (*disable)(struct vrf *), int (*delete)(struct 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 socket serving for the given VRF */
extern int vrf_socket(int domain, int type, int protocol, vrf_id_t vrf_id,
		      char *name);

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

extern int vrf_bind(vrf_id_t vrf_id, int fd, char *name);

/* 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);

/* function called by macro VRF_DEFAULT
 * to get the default VRF_ID
 */
extern vrf_id_t vrf_get_default_id(void);
/* The default VRF ID */
#define VRF_DEFAULT vrf_get_default_id()

/* VRF is mapped on netns or not ? */
int vrf_is_mapped_on_netns(vrf_id_t vrf_id);

/* 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),
			 struct zebra_privs_t *daemon_priv);

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

/*
 * VRF utilities
 */

/* API for configuring VRF backend
 * should be called from zebra only
 */
extern void vrf_configure_backend(int vrf_backend_netns);
extern int vrf_get_backend(void);
extern int vrf_is_backend_netns(void);


/* API to create a VRF. either from vty
 * or through discovery
 */
extern int vrf_handler_create(struct vty *vty, const char *name,
			      struct vrf **vrf);

/* API to associate a VRF with a NETNS.
 * called either from vty or through discovery
 * should be called from zebra only
 */
extern int vrf_netns_handler_create(struct vty *vty, struct vrf *vrf,
				    char *pathname, ns_id_t ext_ns_id,
				    ns_id_t ns_id);

/* 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);

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