[linux-2.6-block.git] / include / net / switchdev.h

/*
 * include/net/switchdev.h - Switch device API
 * Copyright (c) 2014-2015 Jiri Pirko <jiri@resnulli.us>
 * Copyright (c) 2014-2015 Scott Feldman <sfeldma@gmail.com>
 *
 * This program 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 of the License, or
 * (at your option) any later version.
 */
#ifndef _LINUX_SWITCHDEV_H_
#define _LINUX_SWITCHDEV_H_

#include <linux/netdevice.h>
#include <linux/notifier.h>
#include <linux/list.h>
#include <net/ip_fib.h>

#define SWITCHDEV_F_NO_RECURSE		BIT(0)
#define SWITCHDEV_F_SKIP_EOPNOTSUPP	BIT(1)
#define SWITCHDEV_F_DEFER		BIT(2)

struct switchdev_trans_item {
	struct list_head list;
	void *data;
	void (*destructor)(const void *data);
};

struct switchdev_trans {
	struct list_head item_list;
	bool ph_prepare;
};

static inline bool switchdev_trans_ph_prepare(struct switchdev_trans *trans)
{
	return trans && trans->ph_prepare;
}

static inline bool switchdev_trans_ph_commit(struct switchdev_trans *trans)
{
	return trans && !trans->ph_prepare;
}

enum switchdev_attr_id {
	SWITCHDEV_ATTR_ID_UNDEFINED,
	SWITCHDEV_ATTR_ID_PORT_PARENT_ID,
	SWITCHDEV_ATTR_ID_PORT_STP_STATE,
	SWITCHDEV_ATTR_ID_PORT_BRIDGE_FLAGS,
	SWITCHDEV_ATTR_ID_PORT_BRIDGE_FLAGS_SUPPORT,
	SWITCHDEV_ATTR_ID_PORT_MROUTER,
	SWITCHDEV_ATTR_ID_BRIDGE_AGEING_TIME,
	SWITCHDEV_ATTR_ID_BRIDGE_VLAN_FILTERING,
	SWITCHDEV_ATTR_ID_BRIDGE_MC_DISABLED,
	SWITCHDEV_ATTR_ID_BRIDGE_MROUTER,
};

struct switchdev_attr {
	struct net_device *orig_dev;
	enum switchdev_attr_id id;
	u32 flags;
	void *complete_priv;
	void (*complete)(struct net_device *dev, int err, void *priv);
	union {
		struct netdev_phys_item_id ppid;	/* PORT_PARENT_ID */
		u8 stp_state;				/* PORT_STP_STATE */
		unsigned long brport_flags;		/* PORT_BRIDGE_FLAGS */
		unsigned long brport_flags_support;	/* PORT_BRIDGE_FLAGS_SUPPORT */
		bool mrouter;				/* PORT_MROUTER */
		clock_t ageing_time;			/* BRIDGE_AGEING_TIME */
		bool vlan_filtering;			/* BRIDGE_VLAN_FILTERING */
		bool mc_disabled;			/* MC_DISABLED */
	} u;
};

enum switchdev_obj_id {
	SWITCHDEV_OBJ_ID_UNDEFINED,
	SWITCHDEV_OBJ_ID_PORT_VLAN,
	SWITCHDEV_OBJ_ID_PORT_MDB,
	SWITCHDEV_OBJ_ID_HOST_MDB,
};

struct switchdev_obj {
	struct net_device *orig_dev;
	enum switchdev_obj_id id;
	u32 flags;
	void *complete_priv;
	void (*complete)(struct net_device *dev, int err, void *priv);
};

/* SWITCHDEV_OBJ_ID_PORT_VLAN */
struct switchdev_obj_port_vlan {
	struct switchdev_obj obj;
	u16 flags;
	u16 vid_begin;
	u16 vid_end;
};

#define SWITCHDEV_OBJ_PORT_VLAN(OBJ) \
	container_of((OBJ), struct switchdev_obj_port_vlan, obj)

/* SWITCHDEV_OBJ_ID_PORT_MDB */
struct switchdev_obj_port_mdb {
	struct switchdev_obj obj;
	unsigned char addr[ETH_ALEN];
	u16 vid;
};

#define SWITCHDEV_OBJ_PORT_MDB(OBJ) \
	container_of((OBJ), struct switchdev_obj_port_mdb, obj)

void switchdev_trans_item_enqueue(struct switchdev_trans *trans,
				  void *data, void (*destructor)(void const *),
				  struct switchdev_trans_item *tritem);
void *switchdev_trans_item_dequeue(struct switchdev_trans *trans);

typedef int switchdev_obj_dump_cb_t(struct switchdev_obj *obj);

/**
 * struct switchdev_ops - switchdev operations
 *
 * @switchdev_port_attr_get: Get a port attribute (see switchdev_attr).
 *
 * @switchdev_port_attr_set: Set a port attribute (see switchdev_attr).
 */
struct switchdev_ops {
	int	(*switchdev_port_attr_get)(struct net_device *dev,
					   struct switchdev_attr *attr);
	int	(*switchdev_port_attr_set)(struct net_device *dev,
					   const struct switchdev_attr *attr,
					   struct switchdev_trans *trans);
};

enum switchdev_notifier_type {
	SWITCHDEV_FDB_ADD_TO_BRIDGE = 1,
	SWITCHDEV_FDB_DEL_TO_BRIDGE,
	SWITCHDEV_FDB_ADD_TO_DEVICE,
	SWITCHDEV_FDB_DEL_TO_DEVICE,
	SWITCHDEV_FDB_OFFLOADED,

	SWITCHDEV_PORT_OBJ_ADD, /* Blocking. */
	SWITCHDEV_PORT_OBJ_DEL, /* Blocking. */

	SWITCHDEV_VXLAN_FDB_ADD_TO_BRIDGE,
	SWITCHDEV_VXLAN_FDB_DEL_TO_BRIDGE,
	SWITCHDEV_VXLAN_FDB_ADD_TO_DEVICE,
	SWITCHDEV_VXLAN_FDB_DEL_TO_DEVICE,
	SWITCHDEV_VXLAN_FDB_OFFLOADED,
};

struct switchdev_notifier_info {
	struct net_device *dev;
	struct netlink_ext_ack *extack;
};

struct switchdev_notifier_fdb_info {
	struct switchdev_notifier_info info; /* must be first */
	const unsigned char *addr;
	u16 vid;
	u8 added_by_user:1,
	   offloaded:1;
};

struct switchdev_notifier_port_obj_info {
	struct switchdev_notifier_info info; /* must be first */
	const struct switchdev_obj *obj;
	struct switchdev_trans *trans;
	bool handled;
};

static inline struct net_device *
switchdev_notifier_info_to_dev(const struct switchdev_notifier_info *info)
{
	return info->dev;
}

static inline struct netlink_ext_ack *
switchdev_notifier_info_to_extack(const struct switchdev_notifier_info *info)
{
	return info->extack;
}

#ifdef CONFIG_NET_SWITCHDEV

void switchdev_deferred_process(void);
int switchdev_port_attr_get(struct net_device *dev,
			    struct switchdev_attr *attr);
int switchdev_port_attr_set(struct net_device *dev,
			    const struct switchdev_attr *attr);
int switchdev_port_obj_add(struct net_device *dev,
			   const struct switchdev_obj *obj,
			   struct netlink_ext_ack *extack);
int switchdev_port_obj_del(struct net_device *dev,
			   const struct switchdev_obj *obj);

int register_switchdev_notifier(struct notifier_block *nb);
int unregister_switchdev_notifier(struct notifier_block *nb);
int call_switchdev_notifiers(unsigned long val, struct net_device *dev,
			     struct switchdev_notifier_info *info);

int register_switchdev_blocking_notifier(struct notifier_block *nb);
int unregister_switchdev_blocking_notifier(struct notifier_block *nb);
int call_switchdev_blocking_notifiers(unsigned long val, struct net_device *dev,
				      struct switchdev_notifier_info *info,
				      struct netlink_ext_ack *extack);

void switchdev_port_fwd_mark_set(struct net_device *dev,
				 struct net_device *group_dev,
				 bool joining);

bool switchdev_port_same_parent_id(struct net_device *a,
				   struct net_device *b);

int switchdev_handle_port_obj_add(struct net_device *dev,
			struct switchdev_notifier_port_obj_info *port_obj_info,
			bool (*check_cb)(const struct net_device *dev),
			int (*add_cb)(struct net_device *dev,
				      const struct switchdev_obj *obj,
				      struct switchdev_trans *trans,
				      struct netlink_ext_ack *extack));
int switchdev_handle_port_obj_del(struct net_device *dev,
			struct switchdev_notifier_port_obj_info *port_obj_info,
			bool (*check_cb)(const struct net_device *dev),
			int (*del_cb)(struct net_device *dev,
				      const struct switchdev_obj *obj));

#define SWITCHDEV_SET_OPS(netdev, ops) ((netdev)->switchdev_ops = (ops))
#else

static inline void switchdev_deferred_process(void)
{
}

static inline int switchdev_port_attr_get(struct net_device *dev,
					  struct switchdev_attr *attr)
{
	return -EOPNOTSUPP;
}

static inline int switchdev_port_attr_set(struct net_device *dev,
					  const struct switchdev_attr *attr)
{
	return -EOPNOTSUPP;
}

static inline int switchdev_port_obj_add(struct net_device *dev,
					 const struct switchdev_obj *obj,
					 struct netlink_ext_ack *extack)
{
	return -EOPNOTSUPP;
}

static inline int switchdev_port_obj_del(struct net_device *dev,
					 const struct switchdev_obj *obj)
{
	return -EOPNOTSUPP;
}

static inline int register_switchdev_notifier(struct notifier_block *nb)
{
	return 0;
}

static inline int unregister_switchdev_notifier(struct notifier_block *nb)
{
	return 0;
}

static inline int call_switchdev_notifiers(unsigned long val,
					   struct net_device *dev,
					   struct switchdev_notifier_info *info)
{
	return NOTIFY_DONE;
}

static inline int
register_switchdev_blocking_notifier(struct notifier_block *nb)
{
	return 0;
}

static inline int
unregister_switchdev_blocking_notifier(struct notifier_block *nb)
{
	return 0;
}

static inline int
call_switchdev_blocking_notifiers(unsigned long val,
				  struct net_device *dev,
				  struct switchdev_notifier_info *info,
				  struct netlink_ext_ack *extack)
{
	return NOTIFY_DONE;
}

static inline bool switchdev_port_same_parent_id(struct net_device *a,
						 struct net_device *b)
{
	return false;
}

static inline int
switchdev_handle_port_obj_add(struct net_device *dev,
			struct switchdev_notifier_port_obj_info *port_obj_info,
			bool (*check_cb)(const struct net_device *dev),
			int (*add_cb)(struct net_device *dev,
				      const struct switchdev_obj *obj,
				      struct switchdev_trans *trans,
				      struct netlink_ext_ack *extack))
{
	return 0;
}

static inline int
switchdev_handle_port_obj_del(struct net_device *dev,
			struct switchdev_notifier_port_obj_info *port_obj_info,
			bool (*check_cb)(const struct net_device *dev),
			int (*del_cb)(struct net_device *dev,
				      const struct switchdev_obj *obj))
{
	return 0;
}

#define SWITCHDEV_SET_OPS(netdev, ops) do {} while (0)

#endif

#endif /* _LINUX_SWITCHDEV_H_ */
Commit	Line	Data
	1	/*
	2	* include/net/switchdev.h - Switch device API
	3	* Copyright (c) 2014-2015 Jiri Pirko <jiri@resnulli.us>
	4	* Copyright (c) 2014-2015 Scott Feldman <sfeldma@gmail.com>
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*/
	11	#ifndef _LINUX_SWITCHDEV_H_
	12	#define _LINUX_SWITCHDEV_H_
	13
	14	#include <linux/netdevice.h>
	15	#include <linux/notifier.h>
	16	#include <linux/list.h>
	17	#include <net/ip_fib.h>
	18
	19	#define SWITCHDEV_F_NO_RECURSE BIT(0)
	20	#define SWITCHDEV_F_SKIP_EOPNOTSUPP BIT(1)
	21	#define SWITCHDEV_F_DEFER BIT(2)
	22
	23	struct switchdev_trans_item {
	24	struct list_head list;
	25	void *data;
	26	void (destructor)(const void data);
	27	};
	28
	29	struct switchdev_trans {
	30	struct list_head item_list;
	31	bool ph_prepare;
	32	};
	33
	34	static inline bool switchdev_trans_ph_prepare(struct switchdev_trans *trans)
	35	{
	36	return trans && trans->ph_prepare;
	37	}
	38
	39	static inline bool switchdev_trans_ph_commit(struct switchdev_trans *trans)
	40	{
	41	return trans && !trans->ph_prepare;
	42	}
	43
	44	enum switchdev_attr_id {
	45	SWITCHDEV_ATTR_ID_UNDEFINED,
	46	SWITCHDEV_ATTR_ID_PORT_PARENT_ID,
	47	SWITCHDEV_ATTR_ID_PORT_STP_STATE,
	48	SWITCHDEV_ATTR_ID_PORT_BRIDGE_FLAGS,
	49	SWITCHDEV_ATTR_ID_PORT_BRIDGE_FLAGS_SUPPORT,
	50	SWITCHDEV_ATTR_ID_PORT_MROUTER,
	51	SWITCHDEV_ATTR_ID_BRIDGE_AGEING_TIME,
	52	SWITCHDEV_ATTR_ID_BRIDGE_VLAN_FILTERING,
	53	SWITCHDEV_ATTR_ID_BRIDGE_MC_DISABLED,
	54	SWITCHDEV_ATTR_ID_BRIDGE_MROUTER,
	55	};
	56
	57	struct switchdev_attr {
	58	struct net_device *orig_dev;
	59	enum switchdev_attr_id id;
	60	u32 flags;
	61	void *complete_priv;
	62	void (complete)(struct net_device dev, int err, void *priv);
	63	union {
	64	struct netdev_phys_item_id ppid; /* PORT_PARENT_ID */
	65	u8 stp_state; /* PORT_STP_STATE */
	66	unsigned long brport_flags; /* PORT_BRIDGE_FLAGS */
	67	unsigned long brport_flags_support; /* PORT_BRIDGE_FLAGS_SUPPORT */
	68	bool mrouter; /* PORT_MROUTER */
	69	clock_t ageing_time; /* BRIDGE_AGEING_TIME */
	70	bool vlan_filtering; /* BRIDGE_VLAN_FILTERING */
	71	bool mc_disabled; /* MC_DISABLED */
	72	} u;
	73	};
	74
	75	enum switchdev_obj_id {
	76	SWITCHDEV_OBJ_ID_UNDEFINED,
	77	SWITCHDEV_OBJ_ID_PORT_VLAN,
	78	SWITCHDEV_OBJ_ID_PORT_MDB,
	79	SWITCHDEV_OBJ_ID_HOST_MDB,
	80	};
	81
	82	struct switchdev_obj {
	83	struct net_device *orig_dev;
	84	enum switchdev_obj_id id;
	85	u32 flags;
	86	void *complete_priv;
	87	void (complete)(struct net_device dev, int err, void *priv);
	88	};
	89
	90	/* SWITCHDEV_OBJ_ID_PORT_VLAN */
	91	struct switchdev_obj_port_vlan {
	92	struct switchdev_obj obj;
	93	u16 flags;
	94	u16 vid_begin;
	95	u16 vid_end;
	96	};
	97
	98	#define SWITCHDEV_OBJ_PORT_VLAN(OBJ) \
	99	container_of((OBJ), struct switchdev_obj_port_vlan, obj)
	100
	101	/* SWITCHDEV_OBJ_ID_PORT_MDB */
	102	struct switchdev_obj_port_mdb {
	103	struct switchdev_obj obj;
	104	unsigned char addr[ETH_ALEN];
	105	u16 vid;
	106	};
	107
	108	#define SWITCHDEV_OBJ_PORT_MDB(OBJ) \
	109	container_of((OBJ), struct switchdev_obj_port_mdb, obj)
	110
	111	void switchdev_trans_item_enqueue(struct switchdev_trans *trans,
	112	void data, void (destructor)(void const *),
	113	struct switchdev_trans_item *tritem);
	114	void switchdev_trans_item_dequeue(struct switchdev_trans trans);
	115
	116	typedef int switchdev_obj_dump_cb_t(struct switchdev_obj *obj);
	117
	118	/**
	119	* struct switchdev_ops - switchdev operations
	120	*
	121	* @switchdev_port_attr_get: Get a port attribute (see switchdev_attr).
	122	*
	123	* @switchdev_port_attr_set: Set a port attribute (see switchdev_attr).
	124	*/
	125	struct switchdev_ops {
	126	int (switchdev_port_attr_get)(struct net_device dev,
	127	struct switchdev_attr *attr);
	128	int (switchdev_port_attr_set)(struct net_device dev,
	129	const struct switchdev_attr *attr,
	130	struct switchdev_trans *trans);
	131	};
	132
	133	enum switchdev_notifier_type {
	134	SWITCHDEV_FDB_ADD_TO_BRIDGE = 1,
	135	SWITCHDEV_FDB_DEL_TO_BRIDGE,
	136	SWITCHDEV_FDB_ADD_TO_DEVICE,
	137	SWITCHDEV_FDB_DEL_TO_DEVICE,
	138	SWITCHDEV_FDB_OFFLOADED,
	139
	140	SWITCHDEV_PORT_OBJ_ADD, /* Blocking. */
	141	SWITCHDEV_PORT_OBJ_DEL, /* Blocking. */
	142
	143	SWITCHDEV_VXLAN_FDB_ADD_TO_BRIDGE,
	144	SWITCHDEV_VXLAN_FDB_DEL_TO_BRIDGE,
	145	SWITCHDEV_VXLAN_FDB_ADD_TO_DEVICE,
	146	SWITCHDEV_VXLAN_FDB_DEL_TO_DEVICE,
	147	SWITCHDEV_VXLAN_FDB_OFFLOADED,
	148	};
	149
	150	struct switchdev_notifier_info {
	151	struct net_device *dev;
	152	struct netlink_ext_ack *extack;
	153	};
	154
	155	struct switchdev_notifier_fdb_info {
	156	struct switchdev_notifier_info info; /* must be first */
	157	const unsigned char *addr;
	158	u16 vid;
	159	u8 added_by_user:1,
	160	offloaded:1;
	161	};
	162
	163	struct switchdev_notifier_port_obj_info {
	164	struct switchdev_notifier_info info; /* must be first */
	165	const struct switchdev_obj *obj;
	166	struct switchdev_trans *trans;
	167	bool handled;
	168	};
	169
	170	static inline struct net_device *
	171	switchdev_notifier_info_to_dev(const struct switchdev_notifier_info *info)
	172	{
	173	return info->dev;
	174	}
	175
	176	static inline struct netlink_ext_ack *
	177	switchdev_notifier_info_to_extack(const struct switchdev_notifier_info *info)
	178	{
	179	return info->extack;
	180	}
	181
	182	#ifdef CONFIG_NET_SWITCHDEV
	183
	184	void switchdev_deferred_process(void);
	185	int switchdev_port_attr_get(struct net_device *dev,
	186	struct switchdev_attr *attr);
	187	int switchdev_port_attr_set(struct net_device *dev,
	188	const struct switchdev_attr *attr);
	189	int switchdev_port_obj_add(struct net_device *dev,
	190	const struct switchdev_obj *obj,
	191	struct netlink_ext_ack *extack);
	192	int switchdev_port_obj_del(struct net_device *dev,
	193	const struct switchdev_obj *obj);
	194
	195	int register_switchdev_notifier(struct notifier_block *nb);
	196	int unregister_switchdev_notifier(struct notifier_block *nb);
	197	int call_switchdev_notifiers(unsigned long val, struct net_device *dev,
	198	struct switchdev_notifier_info *info);
	199
	200	int register_switchdev_blocking_notifier(struct notifier_block *nb);
	201	int unregister_switchdev_blocking_notifier(struct notifier_block *nb);
	202	int call_switchdev_blocking_notifiers(unsigned long val, struct net_device *dev,
	203	struct switchdev_notifier_info *info,
	204	struct netlink_ext_ack *extack);
	205
	206	void switchdev_port_fwd_mark_set(struct net_device *dev,
	207	struct net_device *group_dev,
	208	bool joining);
	209
	210	bool switchdev_port_same_parent_id(struct net_device *a,
	211	struct net_device *b);
	212
	213	int switchdev_handle_port_obj_add(struct net_device *dev,
	214	struct switchdev_notifier_port_obj_info *port_obj_info,
	215	bool (check_cb)(const struct net_device dev),
	216	int (add_cb)(struct net_device dev,
	217	const struct switchdev_obj *obj,
	218	struct switchdev_trans *trans,
	219	struct netlink_ext_ack *extack));
	220	int switchdev_handle_port_obj_del(struct net_device *dev,
	221	struct switchdev_notifier_port_obj_info *port_obj_info,
	222	bool (check_cb)(const struct net_device dev),
	223	int (del_cb)(struct net_device dev,
	224	const struct switchdev_obj *obj));
	225
	226	#define SWITCHDEV_SET_OPS(netdev, ops) ((netdev)->switchdev_ops = (ops))
	227	#else
	228
	229	static inline void switchdev_deferred_process(void)
	230	{
	231	}
	232
	233	static inline int switchdev_port_attr_get(struct net_device *dev,
	234	struct switchdev_attr *attr)
	235	{
	236	return -EOPNOTSUPP;
	237	}
	238
	239	static inline int switchdev_port_attr_set(struct net_device *dev,
	240	const struct switchdev_attr *attr)
	241	{
	242	return -EOPNOTSUPP;
	243	}
	244
	245	static inline int switchdev_port_obj_add(struct net_device *dev,
	246	const struct switchdev_obj *obj,
	247	struct netlink_ext_ack *extack)
	248	{
	249	return -EOPNOTSUPP;
	250	}
	251
	252	static inline int switchdev_port_obj_del(struct net_device *dev,
	253	const struct switchdev_obj *obj)
	254	{
	255	return -EOPNOTSUPP;
	256	}
	257
	258	static inline int register_switchdev_notifier(struct notifier_block *nb)
	259	{
	260	return 0;
	261	}
	262
	263	static inline int unregister_switchdev_notifier(struct notifier_block *nb)
	264	{
	265	return 0;
	266	}
	267
	268	static inline int call_switchdev_notifiers(unsigned long val,
	269	struct net_device *dev,
	270	struct switchdev_notifier_info *info)
	271	{
	272	return NOTIFY_DONE;
	273	}
	274
	275	static inline int
	276	register_switchdev_blocking_notifier(struct notifier_block *nb)
	277	{
	278	return 0;
	279	}
	280
	281	static inline int
	282	unregister_switchdev_blocking_notifier(struct notifier_block *nb)
	283	{
	284	return 0;
	285	}
	286
	287	static inline int
	288	call_switchdev_blocking_notifiers(unsigned long val,
	289	struct net_device *dev,
	290	struct switchdev_notifier_info *info,
	291	struct netlink_ext_ack *extack)
	292	{
	293	return NOTIFY_DONE;
	294	}
	295
	296	static inline bool switchdev_port_same_parent_id(struct net_device *a,
	297	struct net_device *b)
	298	{
	299	return false;
	300	}
	301
	302	static inline int
	303	switchdev_handle_port_obj_add(struct net_device *dev,
	304	struct switchdev_notifier_port_obj_info *port_obj_info,
	305	bool (check_cb)(const struct net_device dev),
	306	int (add_cb)(struct net_device dev,
	307	const struct switchdev_obj *obj,
	308	struct switchdev_trans *trans,
	309	struct netlink_ext_ack *extack))
	310	{
	311	return 0;
	312	}
	313
	314	static inline int
	315	switchdev_handle_port_obj_del(struct net_device *dev,
	316	struct switchdev_notifier_port_obj_info *port_obj_info,
	317	bool (check_cb)(const struct net_device dev),
	318	int (del_cb)(struct net_device dev,
	319	const struct switchdev_obj *obj))
	320	{
	321	return 0;
	322	}
	323
	324	#define SWITCHDEV_SET_OPS(netdev, ops) do {} while (0)
	325
	326	#endif
	327
	328	#endif /* _LINUX_SWITCHDEV_H_ */