xref: /linux/net/8021q/vlan.h (revision cd1c188db1091991fc1d7f565824d077d659425b)
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 
16 enum vlan_protos {
17 	VLAN_PROTO_8021Q	= 0,
18 	VLAN_PROTO_8021AD,
19 	VLAN_PROTO_NUM,
20 };
21 
22 struct 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 
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 	bool			auto_vid0;
37 	struct rcu_head		rcu;
38 };
39 
40 static 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 
53 static 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 
68 static 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 
80 static 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. */
95 static 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 
107 static 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 
125 int vlan_filter_push_vids(struct vlan_info *vlan_info, __be16 proto);
126 void vlan_filter_drop_vids(struct vlan_info *vlan_info, __be16 proto);
127 
128 /* netdev_work events propagated from the real device, see vlan_dev_work(). */
129 enum {
130 	VLAN_WORK_LINK_STATE	= BIT(0), /* sync up/down with real_dev */
131 	VLAN_WORK_MTU		= BIT(1), /* clamp mtu to real_dev's */
132 	VLAN_WORK_FEATURES	= BIT(2), /* re-inherit real_dev features */
133 };
134 
135 void vlan_stacked_transfer_operstate(const struct net_device *rootdev,
136 				     struct net_device *dev,
137 				     struct vlan_dev_priv *vlan);
138 
139 /* found in vlan_dev.c */
140 void vlan_dev_set_ingress_priority(const struct net_device *dev,
141 				   u32 skb_prio, u16 vlan_prio);
142 int vlan_dev_set_egress_priority(const struct net_device *dev,
143 				 u32 skb_prio, u16 vlan_prio);
144 void vlan_dev_free_egress_priority(const struct net_device *dev);
145 int vlan_dev_change_flags(const struct net_device *dev, u32 flag, u32 mask);
146 void vlan_dev_get_realdev_name(const struct net_device *dev, char *result,
147 			       size_t size);
148 
149 int vlan_check_real_dev(struct net_device *real_dev,
150 			__be16 protocol, u16 vlan_id,
151 			struct netlink_ext_ack *extack);
152 void vlan_setup(struct net_device *dev);
153 int register_vlan_dev(struct net_device *dev, struct netlink_ext_ack *extack);
154 void unregister_vlan_dev(struct net_device *dev, struct list_head *head);
155 bool vlan_dev_inherit_address(struct net_device *dev,
156 			      struct net_device *real_dev);
157 
158 static inline u32 vlan_get_ingress_priority(struct net_device *dev,
159 					    u16 vlan_tci)
160 {
161 	struct vlan_dev_priv *vip = vlan_dev_priv(dev);
162 
163 	return vip->ingress_priority_map[(vlan_tci >> VLAN_PRIO_SHIFT) & 0x7];
164 }
165 
166 #ifdef CONFIG_VLAN_8021Q_GVRP
167 int vlan_gvrp_request_join(const struct net_device *dev);
168 void vlan_gvrp_request_leave(const struct net_device *dev);
169 int vlan_gvrp_init_applicant(struct net_device *dev);
170 void vlan_gvrp_uninit_applicant(struct net_device *dev);
171 int vlan_gvrp_init(void);
172 void vlan_gvrp_uninit(void);
173 #else
174 static inline int vlan_gvrp_request_join(const struct net_device *dev) { return 0; }
175 static inline void vlan_gvrp_request_leave(const struct net_device *dev) {}
176 static inline int vlan_gvrp_init_applicant(struct net_device *dev) { return 0; }
177 static inline void vlan_gvrp_uninit_applicant(struct net_device *dev) {}
178 static inline int vlan_gvrp_init(void) { return 0; }
179 static inline void vlan_gvrp_uninit(void) {}
180 #endif
181 
182 #ifdef CONFIG_VLAN_8021Q_MVRP
183 int vlan_mvrp_request_join(const struct net_device *dev);
184 void vlan_mvrp_request_leave(const struct net_device *dev);
185 int vlan_mvrp_init_applicant(struct net_device *dev);
186 void vlan_mvrp_uninit_applicant(struct net_device *dev);
187 int vlan_mvrp_init(void);
188 void vlan_mvrp_uninit(void);
189 #else
190 static inline int vlan_mvrp_request_join(const struct net_device *dev) { return 0; }
191 static inline void vlan_mvrp_request_leave(const struct net_device *dev) {}
192 static inline int vlan_mvrp_init_applicant(struct net_device *dev) { return 0; }
193 static inline void vlan_mvrp_uninit_applicant(struct net_device *dev) {}
194 static inline int vlan_mvrp_init(void) { return 0; }
195 static inline void vlan_mvrp_uninit(void) {}
196 #endif
197 
198 extern const char vlan_fullname[];
199 extern const char vlan_version[];
200 int vlan_netlink_init(void);
201 void vlan_netlink_fini(void);
202 
203 extern struct rtnl_link_ops vlan_link_ops;
204 
205 extern unsigned int vlan_net_id;
206 
207 struct proc_dir_entry;
208 
209 struct vlan_net {
210 	/* /proc/net/vlan */
211 	struct proc_dir_entry *proc_vlan_dir;
212 	/* /proc/net/vlan/config */
213 	struct proc_dir_entry *proc_vlan_conf;
214 	/* Determines interface naming scheme. */
215 	unsigned short name_type;
216 };
217 
218 #endif /* !(__BEN_VLAN_802_1Q_INC__) */
219