xref: /openbmc/linux/net/8021q/vlan.h (revision d9fd5a71)
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 	struct rcu_head		rcu;
37 };
38 
39 static inline int vlan_proto_idx(__be16 proto)
40 {
41 	switch (proto) {
42 	case htons(ETH_P_8021Q):
43 		return VLAN_PROTO_8021Q;
44 	case htons(ETH_P_8021AD):
45 		return VLAN_PROTO_8021AD;
46 	default:
47 		WARN(1, "invalid VLAN protocol: 0x%04x\n", ntohs(proto));
48 		return -EINVAL;
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)
55 {
56 	struct net_device **array;
57 
58 	array = vg->vlan_devices_arrays[pidx]
59 				       [vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
60 	return array ? array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] : NULL;
61 }
62 
63 static inline struct net_device *vlan_group_get_device(struct vlan_group *vg,
64 						       __be16 vlan_proto,
65 						       u16 vlan_id)
66 {
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);
73 }
74 
75 static inline void vlan_group_set_device(struct vlan_group *vg,
76 					 __be16 vlan_proto, u16 vlan_id,
77 					 struct net_device *dev)
78 {
79 	int pidx = vlan_proto_idx(vlan_proto);
80 	struct net_device **array;
81 
82 	if (!vg || pidx < 0)
83 		return;
84 	array = vg->vlan_devices_arrays[pidx]
85 				       [vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
86 	array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] = dev;
87 }
88 
89 /* Must be invoked with rcu_read_lock or with RTNL. */
90 static inline struct net_device *vlan_find_dev(struct net_device *real_dev,
91 					       __be16 vlan_proto, u16 vlan_id)
92 {
93 	struct vlan_info *vlan_info = rcu_dereference_rtnl(real_dev->vlan_info);
94 
95 	if (vlan_info)
96 		return vlan_group_get_device(&vlan_info->grp,
97 					     vlan_proto, vlan_id);
98 
99 	return NULL;
100 }
101 
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 
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 
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 
122 /* found in vlan_dev.c */
123 void vlan_dev_set_ingress_priority(const struct net_device *dev,
124 				   u32 skb_prio, u16 vlan_prio);
125 int vlan_dev_set_egress_priority(const struct net_device *dev,
126 				 u32 skb_prio, u16 vlan_prio);
127 int vlan_dev_change_flags(const struct net_device *dev, u32 flag, u32 mask);
128 void vlan_dev_get_realdev_name(const struct net_device *dev, char *result);
129 
130 int vlan_check_real_dev(struct net_device *real_dev,
131 			__be16 protocol, u16 vlan_id,
132 			struct netlink_ext_ack *extack);
133 void vlan_setup(struct net_device *dev);
134 int register_vlan_dev(struct net_device *dev, struct netlink_ext_ack *extack);
135 void unregister_vlan_dev(struct net_device *dev, struct list_head *head);
136 void vlan_dev_uninit(struct net_device *dev);
137 bool vlan_dev_inherit_address(struct net_device *dev,
138 			      struct net_device *real_dev);
139 
140 static inline u32 vlan_get_ingress_priority(struct net_device *dev,
141 					    u16 vlan_tci)
142 {
143 	struct vlan_dev_priv *vip = vlan_dev_priv(dev);
144 
145 	return vip->ingress_priority_map[(vlan_tci >> VLAN_PRIO_SHIFT) & 0x7];
146 }
147 
148 #ifdef CONFIG_VLAN_8021Q_GVRP
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);
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 
164 #ifdef CONFIG_VLAN_8021Q_MVRP
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);
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 
180 extern const char vlan_fullname[];
181 extern const char vlan_version[];
182 int vlan_netlink_init(void);
183 void vlan_netlink_fini(void);
184 
185 extern struct rtnl_link_ops vlan_link_ops;
186 
187 extern unsigned int vlan_net_id;
188 
189 struct proc_dir_entry;
190 
191 struct vlan_net {
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;
196 	/* Determines interface naming scheme. */
197 	unsigned short name_type;
198 };
199 
200 #endif /* !(__BEN_VLAN_802_1Q_INC__) */
201