[linux.git] / net / 8021q / vlan.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __BEN_VLAN_802_1Q_INC__
#define __BEN_VLAN_802_1Q_INC__

#include <linux/if_vlan.h>
#include <linux/u64_stats_sync.h>
#include <linux/list.h>

/* if this changes, algorithm will have to be reworked because this
 * depends on completely exhausting the VLAN identifier space.  Thus
 * it gives constant time look-up, but in many cases it wastes memory.
 */
#define VLAN_GROUP_ARRAY_SPLIT_PARTS  8
#define VLAN_GROUP_ARRAY_PART_LEN     (VLAN_N_VID/VLAN_GROUP_ARRAY_SPLIT_PARTS)

enum vlan_protos {
	VLAN_PROTO_8021Q	= 0,
	VLAN_PROTO_8021AD,
	VLAN_PROTO_NUM,
};

struct vlan_group {
	unsigned int		nr_vlan_devs;
	struct hlist_node	hlist;	/* linked list */
	struct net_device **vlan_devices_arrays[VLAN_PROTO_NUM]
					       [VLAN_GROUP_ARRAY_SPLIT_PARTS];
};

struct vlan_info {
	struct net_device	*real_dev; /* The ethernet(like) device
					    * the vlan is attached to.
					    */
	struct vlan_group	grp;
	struct list_head	vid_list;
	unsigned int		nr_vids;
	struct rcu_head		rcu;
};

static inline int vlan_proto_idx(__be16 proto)
{
	switch (proto) {
	case htons(ETH_P_8021Q):
		return VLAN_PROTO_8021Q;
	case htons(ETH_P_8021AD):
		return VLAN_PROTO_8021AD;
	default:
		WARN(1, "invalid VLAN protocol: 0x%04x\n", ntohs(proto));
		return -EINVAL;
	}
}

static inline struct net_device *__vlan_group_get_device(struct vlan_group *vg,
							 unsigned int pidx,
							 u16 vlan_id)
{
	struct net_device **array;

	array = vg->vlan_devices_arrays[pidx]
				       [vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
	return array ? array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] : NULL;
}

static inline struct net_device *vlan_group_get_device(struct vlan_group *vg,
						       __be16 vlan_proto,
						       u16 vlan_id)
{
	int pidx = vlan_proto_idx(vlan_proto);

	if (pidx < 0)
		return NULL;

	return __vlan_group_get_device(vg, pidx, vlan_id);
}

static inline void vlan_group_set_device(struct vlan_group *vg,
					 __be16 vlan_proto, u16 vlan_id,
					 struct net_device *dev)
{
	int pidx = vlan_proto_idx(vlan_proto);
	struct net_device **array;

	if (!vg || pidx < 0)
		return;
	array = vg->vlan_devices_arrays[pidx]
				       [vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
	array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] = dev;
}

/* Must be invoked with rcu_read_lock or with RTNL. */
static inline struct net_device *vlan_find_dev(struct net_device *real_dev,
					       __be16 vlan_proto, u16 vlan_id)
{
	struct vlan_info *vlan_info = rcu_dereference_rtnl(real_dev->vlan_info);

	if (vlan_info)
		return vlan_group_get_device(&vlan_info->grp,
					     vlan_proto, vlan_id);

	return NULL;
}

static inline netdev_features_t vlan_tnl_features(struct net_device *real_dev)
{
	netdev_features_t ret;

	ret = real_dev->hw_enc_features &
	      (NETIF_F_CSUM_MASK | NETIF_F_ALL_TSO | NETIF_F_GSO_ENCAP_ALL);

	if ((ret & NETIF_F_GSO_ENCAP_ALL) && (ret & NETIF_F_CSUM_MASK))
		return (ret & ~NETIF_F_CSUM_MASK) | NETIF_F_HW_CSUM;
	return 0;
}

#define vlan_group_for_each_dev(grp, i, dev) \
	for ((i) = 0; i < VLAN_PROTO_NUM * VLAN_N_VID; i++) \
		if (((dev) = __vlan_group_get_device((grp), (i) / VLAN_N_VID, \
							    (i) % VLAN_N_VID)))

int vlan_filter_push_vids(struct vlan_info *vlan_info, __be16 proto);
void vlan_filter_drop_vids(struct vlan_info *vlan_info, __be16 proto);

/* found in vlan_dev.c */
void vlan_dev_set_ingress_priority(const struct net_device *dev,
				   u32 skb_prio, u16 vlan_prio);
int vlan_dev_set_egress_priority(const struct net_device *dev,
				 u32 skb_prio, u16 vlan_prio);
int vlan_dev_change_flags(const struct net_device *dev, u32 flag, u32 mask);
void vlan_dev_get_realdev_name(const struct net_device *dev, char *result);

int vlan_check_real_dev(struct net_device *real_dev,
			__be16 protocol, u16 vlan_id,
			struct netlink_ext_ack *extack);
void vlan_setup(struct net_device *dev);
int register_vlan_dev(struct net_device *dev, struct netlink_ext_ack *extack);
void unregister_vlan_dev(struct net_device *dev, struct list_head *head);
void vlan_dev_uninit(struct net_device *dev);
bool vlan_dev_inherit_address(struct net_device *dev,
			      struct net_device *real_dev);

static inline u32 vlan_get_ingress_priority(struct net_device *dev,
					    u16 vlan_tci)
{
	struct vlan_dev_priv *vip = vlan_dev_priv(dev);

	return vip->ingress_priority_map[(vlan_tci >> VLAN_PRIO_SHIFT) & 0x7];
}

#ifdef CONFIG_VLAN_8021Q_GVRP
int vlan_gvrp_request_join(const struct net_device *dev);
void vlan_gvrp_request_leave(const struct net_device *dev);
int vlan_gvrp_init_applicant(struct net_device *dev);
void vlan_gvrp_uninit_applicant(struct net_device *dev);
int vlan_gvrp_init(void);
void vlan_gvrp_uninit(void);
#else
static inline int vlan_gvrp_request_join(const struct net_device *dev) { return 0; }
static inline void vlan_gvrp_request_leave(const struct net_device *dev) {}
static inline int vlan_gvrp_init_applicant(struct net_device *dev) { return 0; }
static inline void vlan_gvrp_uninit_applicant(struct net_device *dev) {}
static inline int vlan_gvrp_init(void) { return 0; }
static inline void vlan_gvrp_uninit(void) {}
#endif

#ifdef CONFIG_VLAN_8021Q_MVRP
int vlan_mvrp_request_join(const struct net_device *dev);
void vlan_mvrp_request_leave(const struct net_device *dev);
int vlan_mvrp_init_applicant(struct net_device *dev);
void vlan_mvrp_uninit_applicant(struct net_device *dev);
int vlan_mvrp_init(void);
void vlan_mvrp_uninit(void);
#else
static inline int vlan_mvrp_request_join(const struct net_device *dev) { return 0; }
static inline void vlan_mvrp_request_leave(const struct net_device *dev) {}
static inline int vlan_mvrp_init_applicant(struct net_device *dev) { return 0; }
static inline void vlan_mvrp_uninit_applicant(struct net_device *dev) {}
static inline int vlan_mvrp_init(void) { return 0; }
static inline void vlan_mvrp_uninit(void) {}
#endif

extern const char vlan_fullname[];
extern const char vlan_version[];
int vlan_netlink_init(void);
void vlan_netlink_fini(void);

extern struct rtnl_link_ops vlan_link_ops;

extern unsigned int vlan_net_id;

struct proc_dir_entry;

struct vlan_net {
	/* /proc/net/vlan */
	struct proc_dir_entry *proc_vlan_dir;
	/* /proc/net/vlan/config */
	struct proc_dir_entry *proc_vlan_conf;
	/* Determines interface naming scheme. */
	unsigned short name_type;
};

#endif /* !(__BEN_VLAN_802_1Q_INC__) */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	#ifndef __BEN_VLAN_802_1Q_INC__
	3	#define __BEN_VLAN_802_1Q_INC__
	4
	5	#include <linux/if_vlan.h>
9618e2ff	6	#include <linux/u64_stats_sync.h>
5b9ea6e0	7	#include <linux/list.h>
1da177e4	8
5b9ea6e0 JP	9	/* if this changes, algorithm will have to be reworked because this
	10	* depends on completely exhausting the VLAN identifier space. Thus
	11	* it gives constant time look-up, but in many cases it wastes memory.
	12	*/
	13	#define VLAN_GROUP_ARRAY_SPLIT_PARTS 8
	14	#define VLAN_GROUP_ARRAY_PART_LEN (VLAN_N_VID/VLAN_GROUP_ARRAY_SPLIT_PARTS)
	15
1fd9b1fc PM	16	enum vlan_protos {
1fd9b1fc PM	17	VLAN_PROTO_8021Q = 0,
8ad227ff	18	VLAN_PROTO_8021AD,
1fd9b1fc PM	19	VLAN_PROTO_NUM,
	20	};
	21
5b9ea6e0 JP	22	struct vlan_group {
	23	unsigned int nr_vlan_devs;
	24	struct hlist_node hlist; /* linked list */
1fd9b1fc PM	25	struct net_device **vlan_devices_arrays[VLAN_PROTO_NUM]
1fd9b1fc PM	26	[VLAN_GROUP_ARRAY_SPLIT_PARTS];
5b9ea6e0 JP	27	};
	28
	29	struct vlan_info {
	30	struct net_device real_dev; / The ethernet(like) device
	31	* the vlan is attached to.
	32	*/
	33	struct vlan_group grp;
	34	struct list_head vid_list;
	35	unsigned int nr_vids;
	36	struct rcu_head rcu;
	37	};
	38
d0186842	39	static inline int vlan_proto_idx(__be16 proto)
1fd9b1fc PM	40	{
1fd9b1fc PM	41	switch (proto) {
f0e78826	42	case htons(ETH_P_8021Q):
1fd9b1fc	43	return VLAN_PROTO_8021Q;
f0e78826	44	case htons(ETH_P_8021AD):
8ad227ff	45	return VLAN_PROTO_8021AD;
1fd9b1fc	46	default:
d0186842 FF	47	WARN(1, "invalid VLAN protocol: 0x%04x\n", ntohs(proto));
d0186842 FF	48	return -EINVAL;
1fd9b1fc PM	49	}
	50	}
	51
	52	static inline struct net_device __vlan_group_get_device(struct vlan_group vg,
	53	unsigned int pidx,
	54	u16 vlan_id)
536d1d4a JP	55	{
536d1d4a JP	56	struct net_device **array;
1fd9b1fc PM	57
	58	array = vg->vlan_devices_arrays[pidx]
	59	[vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
536d1d4a JP	60	return array ? array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] : NULL;
	61	}
	62
1fd9b1fc PM	63	static inline struct net_device vlan_group_get_device(struct vlan_group vg,
	64	__be16 vlan_proto,
	65	u16 vlan_id)
	66	{
d0186842 FF	67	int pidx = vlan_proto_idx(vlan_proto);
	68
	69	if (pidx < 0)
	70	return NULL;
	71
	72	return __vlan_group_get_device(vg, pidx, vlan_id);
1fd9b1fc PM	73	}
1fd9b1fc PM	74
536d1d4a	75	static inline void vlan_group_set_device(struct vlan_group *vg,
1fd9b1fc	76	__be16 vlan_proto, u16 vlan_id,
536d1d4a JP	77	struct net_device *dev)
536d1d4a JP	78	{
d0186842	79	int pidx = vlan_proto_idx(vlan_proto);
536d1d4a	80	struct net_device **array;
d0186842 FF	81
d0186842 FF	82	if (!vg \|\| pidx < 0)
536d1d4a	83	return;
d0186842	84	array = vg->vlan_devices_arrays[pidx]
1fd9b1fc	85	[vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
536d1d4a JP	86	array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] = dev;
	87	}
	88
69ecca86 DL	89	/* Must be invoked with rcu_read_lock or with RTNL. */
69ecca86 DL	90	static inline struct net_device vlan_find_dev(struct net_device real_dev,
1fd9b1fc	91	__be16 vlan_proto, u16 vlan_id)
69ecca86	92	{
5b9ea6e0	93	struct vlan_info *vlan_info = rcu_dereference_rtnl(real_dev->vlan_info);
69ecca86	94
5b9ea6e0	95	if (vlan_info)
1fd9b1fc PM	96	return vlan_group_get_device(&vlan_info->grp,
1fd9b1fc PM	97	vlan_proto, vlan_id);
69ecca86 DL	98
	99	return NULL;
	100	}
	101
7dad9937 DC	102	static inline netdev_features_t vlan_tnl_features(struct net_device *real_dev)
	103	{
	104	netdev_features_t ret;
	105
	106	ret = real_dev->hw_enc_features &
	107	(NETIF_F_CSUM_MASK \| NETIF_F_ALL_TSO \| NETIF_F_GSO_ENCAP_ALL);
	108
	109	if ((ret & NETIF_F_GSO_ENCAP_ALL) && (ret & NETIF_F_CSUM_MASK))
	110	return (ret & ~NETIF_F_CSUM_MASK) \| NETIF_F_HW_CSUM;
	111	return 0;
	112	}
	113
1fd9b1fc PM	114	#define vlan_group_for_each_dev(grp, i, dev) \
	115	for ((i) = 0; i < VLAN_PROTO_NUM * VLAN_N_VID; i++) \
	116	if (((dev) = __vlan_group_get_device((grp), (i) / VLAN_N_VID, \
	117	(i) % VLAN_N_VID)))
	118
9daae9bd GP	119	int vlan_filter_push_vids(struct vlan_info *vlan_info, __be16 proto);
	120	void vlan_filter_drop_vids(struct vlan_info *vlan_info, __be16 proto);
	121
1da177e4	122	/* found in vlan_dev.c */
c17d8874	123	void vlan_dev_set_ingress_priority(const struct net_device *dev,
9bb8582e	124	u32 skb_prio, u16 vlan_prio);
c17d8874	125	int vlan_dev_set_egress_priority(const struct net_device *dev,
9bb8582e	126	u32 skb_prio, u16 vlan_prio);
b3ce0325	127	int vlan_dev_change_flags(const struct net_device *dev, u32 flag, u32 mask);
c17d8874	128	void vlan_dev_get_realdev_name(const struct net_device dev, char result);
1da177e4	129
1fd9b1fc	130	int vlan_check_real_dev(struct net_device *real_dev,
33fa3823 DA	131	__be16 protocol, u16 vlan_id,
33fa3823 DA	132	struct netlink_ext_ack *extack);
07b5b17e	133	void vlan_setup(struct net_device *dev);
42ab19ee	134	int register_vlan_dev(struct net_device dev, struct netlink_ext_ack extack);
23289a37	135	void unregister_vlan_dev(struct net_device dev, struct list_head head);
9bbd917e	136	void vlan_dev_uninit(struct net_device *dev);
308453aa MM	137	bool vlan_dev_inherit_address(struct net_device *dev,
308453aa MM	138	struct net_device *real_dev);
07b5b17e	139
7750f403	140	static inline u32 vlan_get_ingress_priority(struct net_device *dev,
9bb8582e	141	u16 vlan_tci)
7750f403	142	{
7da82c06	143	struct vlan_dev_priv *vip = vlan_dev_priv(dev);
7750f403	144
05423b24	145	return vip->ingress_priority_map[(vlan_tci >> VLAN_PRIO_SHIFT) & 0x7];
7750f403 PM	146	}
7750f403 PM	147
70c03b49	148	#ifdef CONFIG_VLAN_8021Q_GVRP
348662a1 JP	149	int vlan_gvrp_request_join(const struct net_device *dev);
	150	void vlan_gvrp_request_leave(const struct net_device *dev);
	151	int vlan_gvrp_init_applicant(struct net_device *dev);
	152	void vlan_gvrp_uninit_applicant(struct net_device *dev);
	153	int vlan_gvrp_init(void);
	154	void vlan_gvrp_uninit(void);
70c03b49 PM	155	#else
	156	static inline int vlan_gvrp_request_join(const struct net_device *dev) { return 0; }
	157	static inline void vlan_gvrp_request_leave(const struct net_device *dev) {}
	158	static inline int vlan_gvrp_init_applicant(struct net_device *dev) { return 0; }
	159	static inline void vlan_gvrp_uninit_applicant(struct net_device *dev) {}
	160	static inline int vlan_gvrp_init(void) { return 0; }
	161	static inline void vlan_gvrp_uninit(void) {}
	162	#endif
	163
86fbe9bb	164	#ifdef CONFIG_VLAN_8021Q_MVRP
348662a1 JP	165	int vlan_mvrp_request_join(const struct net_device *dev);
	166	void vlan_mvrp_request_leave(const struct net_device *dev);
	167	int vlan_mvrp_init_applicant(struct net_device *dev);
	168	void vlan_mvrp_uninit_applicant(struct net_device *dev);
	169	int vlan_mvrp_init(void);
	170	void vlan_mvrp_uninit(void);
86fbe9bb DW	171	#else
	172	static inline int vlan_mvrp_request_join(const struct net_device *dev) { return 0; }
	173	static inline void vlan_mvrp_request_leave(const struct net_device *dev) {}
	174	static inline int vlan_mvrp_init_applicant(struct net_device *dev) { return 0; }
	175	static inline void vlan_mvrp_uninit_applicant(struct net_device *dev) {}
	176	static inline int vlan_mvrp_init(void) { return 0; }
	177	static inline void vlan_mvrp_uninit(void) {}
	178	#endif
	179
b3020061 SH	180	extern const char vlan_fullname[];
b3020061 SH	181	extern const char vlan_version[];
348662a1 JP	182	int vlan_netlink_init(void);
348662a1 JP	183	void vlan_netlink_fini(void);
07b5b17e PM	184
	185	extern struct rtnl_link_ops vlan_link_ops;
	186
c7d03a00	187	extern unsigned int vlan_net_id;
d9ed0f0e	188
a59a8c1c PE	189	struct proc_dir_entry;
a59a8c1c PE	190
d9ed0f0e	191	struct vlan_net {
a59a8c1c PE	192	/* /proc/net/vlan */
	193	struct proc_dir_entry *proc_vlan_dir;
	194	/* /proc/net/vlan/config */
	195	struct proc_dir_entry *proc_vlan_conf;
7a17a2f7 PE	196	/* Determines interface naming scheme. */
7a17a2f7 PE	197	unsigned short name_type;
d9ed0f0e PE	198	};
d9ed0f0e PE	199
1da177e4	200	#endif /* !(__BEN_VLAN_802_1Q_INC__) */