vlan.h

  1/* SPDX-License-Identifier: GPL-2.0 */
  2#ifndef __BEN_VLAN_802_1Q_INC__
  3#define __BEN_VLAN_802_1Q_INC__
  4
  5#include <linux/if_vlan.h>
  6#include <linux/u64_stats_sync.h>
  7#include <linux/list.h>
  8
  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
 16enum vlan_protos {
 17	VLAN_PROTO_8021Q	= 0,
 18	VLAN_PROTO_8021AD,
 19	VLAN_PROTO_NUM,
 20};
 21
 22struct vlan_group {
 23	unsigned int		nr_vlan_devs;
 24	struct hlist_node	hlist;	/* linked list */
 25	struct net_device **vlan_devices_arrays[VLAN_PROTO_NUM]
 26					       [VLAN_GROUP_ARRAY_SPLIT_PARTS];
 27};
 28
 29struct 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	bool			auto_vid0;
 37	struct rcu_head		rcu;
 38};
 39
 40static inline int vlan_proto_idx(__be16 proto)
 41{
 42	switch (proto) {
 43	case htons(ETH_P_8021Q):
 44		return VLAN_PROTO_8021Q;
 45	case htons(ETH_P_8021AD):
 46		return VLAN_PROTO_8021AD;
 47	default:
 48		WARN(1, "invalid VLAN protocol: 0x%04x\n", ntohs(proto));
 49		return -EINVAL;
 50	}
 51}
 52
 53static inline struct net_device *__vlan_group_get_device(struct vlan_group *vg,
 54							 unsigned int pidx,
 55							 u16 vlan_id)
 56{
 57	struct net_device **array;
 58
 59	array = vg->vlan_devices_arrays[pidx]
 60				       [vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
 61
 62	/* paired with smp_wmb() in vlan_group_prealloc_vid() */
 63	smp_rmb();
 64
 65	return array ? array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] : NULL;
 66}
 67
 68static inline struct net_device *vlan_group_get_device(struct vlan_group *vg,
 69						       __be16 vlan_proto,
 70						       u16 vlan_id)
 71{
 72	int pidx = vlan_proto_idx(vlan_proto);
 73
 74	if (pidx < 0)
 75		return NULL;
 76
 77	return __vlan_group_get_device(vg, pidx, vlan_id);
 78}
 79
 80static inline void vlan_group_set_device(struct vlan_group *vg,
 81					 __be16 vlan_proto, u16 vlan_id,
 82					 struct net_device *dev)
 83{
 84	int pidx = vlan_proto_idx(vlan_proto);
 85	struct net_device **array;
 86
 87	if (!vg || pidx < 0)
 88		return;
 89	array = vg->vlan_devices_arrays[pidx]
 90				       [vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
 91	array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] = dev;
 92}
 93
 94/* Must be invoked with rcu_read_lock or with RTNL. */
 95static inline struct net_device *vlan_find_dev(struct net_device *real_dev,
 96					       __be16 vlan_proto, u16 vlan_id)
 97{
 98	struct vlan_info *vlan_info = rcu_dereference_rtnl(real_dev->vlan_info);
 99
100	if (vlan_info)
101		return vlan_group_get_device(&vlan_info->grp,
102					     vlan_proto, vlan_id);
103
104	return NULL;
105}
106
107static inline netdev_features_t vlan_tnl_features(struct net_device *real_dev)
108{
109	netdev_features_t ret;
110
111	ret = real_dev->hw_enc_features &
112	      (NETIF_F_CSUM_MASK | NETIF_F_GSO_SOFTWARE |
113	       NETIF_F_GSO_ENCAP_ALL);
114
115	if ((ret & NETIF_F_GSO_ENCAP_ALL) && (ret & NETIF_F_CSUM_MASK))
116		return (ret & ~NETIF_F_CSUM_MASK) | NETIF_F_HW_CSUM;
117	return 0;
118}
119
120#define vlan_group_for_each_dev(grp, i, dev) \
121	for ((i) = 0; i < VLAN_PROTO_NUM * VLAN_N_VID; i++) \
122		if (((dev) = __vlan_group_get_device((grp), (i) / VLAN_N_VID, \
123							    (i) % VLAN_N_VID)))
124
125int vlan_filter_push_vids(struct vlan_info *vlan_info, __be16 proto);
126void vlan_filter_drop_vids(struct vlan_info *vlan_info, __be16 proto);
127
128/* found in vlan_dev.c */
129void vlan_dev_set_ingress_priority(const struct net_device *dev,
130				   u32 skb_prio, u16 vlan_prio);
131int vlan_dev_set_egress_priority(const struct net_device *dev,
132				 u32 skb_prio, u16 vlan_prio);
133void vlan_dev_free_egress_priority(const struct net_device *dev);
134int vlan_dev_change_flags(const struct net_device *dev, u32 flag, u32 mask);
135void vlan_dev_get_realdev_name(const struct net_device *dev, char *result,
136			       size_t size);
137
138int vlan_check_real_dev(struct net_device *real_dev,
139			__be16 protocol, u16 vlan_id,
140			struct netlink_ext_ack *extack);
141void vlan_setup(struct net_device *dev);
142int register_vlan_dev(struct net_device *dev, struct netlink_ext_ack *extack);
143void unregister_vlan_dev(struct net_device *dev, struct list_head *head);
144bool vlan_dev_inherit_address(struct net_device *dev,
145			      struct net_device *real_dev);
146
147static inline u32 vlan_get_ingress_priority(struct net_device *dev,
148					    u16 vlan_tci)
149{
150	struct vlan_dev_priv *vip = vlan_dev_priv(dev);
151
152	return vip->ingress_priority_map[(vlan_tci >> VLAN_PRIO_SHIFT) & 0x7];
153}
154
155#ifdef CONFIG_VLAN_8021Q_GVRP
156int vlan_gvrp_request_join(const struct net_device *dev);
157void vlan_gvrp_request_leave(const struct net_device *dev);
158int vlan_gvrp_init_applicant(struct net_device *dev);
159void vlan_gvrp_uninit_applicant(struct net_device *dev);
160int vlan_gvrp_init(void);
161void vlan_gvrp_uninit(void);
162#else
163static inline int vlan_gvrp_request_join(const struct net_device *dev) { return 0; }
164static inline void vlan_gvrp_request_leave(const struct net_device *dev) {}
165static inline int vlan_gvrp_init_applicant(struct net_device *dev) { return 0; }
166static inline void vlan_gvrp_uninit_applicant(struct net_device *dev) {}
167static inline int vlan_gvrp_init(void) { return 0; }
168static inline void vlan_gvrp_uninit(void) {}
169#endif
170
171#ifdef CONFIG_VLAN_8021Q_MVRP
172int vlan_mvrp_request_join(const struct net_device *dev);
173void vlan_mvrp_request_leave(const struct net_device *dev);
174int vlan_mvrp_init_applicant(struct net_device *dev);
175void vlan_mvrp_uninit_applicant(struct net_device *dev);
176int vlan_mvrp_init(void);
177void vlan_mvrp_uninit(void);
178#else
179static inline int vlan_mvrp_request_join(const struct net_device *dev) { return 0; }
180static inline void vlan_mvrp_request_leave(const struct net_device *dev) {}
181static inline int vlan_mvrp_init_applicant(struct net_device *dev) { return 0; }
182static inline void vlan_mvrp_uninit_applicant(struct net_device *dev) {}
183static inline int vlan_mvrp_init(void) { return 0; }
184static inline void vlan_mvrp_uninit(void) {}
185#endif
186
187extern const char vlan_fullname[];
188extern const char vlan_version[];
189int vlan_netlink_init(void);
190void vlan_netlink_fini(void);
191
192extern struct rtnl_link_ops vlan_link_ops;
193
194extern unsigned int vlan_net_id;
195
196struct proc_dir_entry;
197
198struct vlan_net {
199	/* /proc/net/vlan */
200	struct proc_dir_entry *proc_vlan_dir;
201	/* /proc/net/vlan/config */
202	struct proc_dir_entry *proc_vlan_conf;
203	/* Determines interface naming scheme. */
204	unsigned short name_type;
205};
206
207#endif /* !(__BEN_VLAN_802_1Q_INC__) */