blob: b05e855f1ddd4f2ea1cb0282ad754a7a50f826fe [file] [log] [blame]
Thomas Gleixner2874c5f2019-05-27 08:55:01 +02001/* SPDX-License-Identifier: GPL-2.0-or-later */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * VLAN An implementation of 802.1Q VLAN tagging.
4 *
5 * Authors: Ben Greear <greearb@candelatech.com>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07007#ifndef _LINUX_IF_VLAN_H_
8#define _LINUX_IF_VLAN_H_
9
Linus Torvalds1da177e2005-04-16 15:20:36 -070010#include <linux/netdevice.h>
Stephen Hemminger0610d112006-07-14 16:34:22 -070011#include <linux/etherdevice.h>
Jesse Gross65ac6a52010-10-20 13:56:05 +000012#include <linux/rtnetlink.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050013#include <linux/bug.h>
David Howells607ca462012-10-13 10:46:48 +010014#include <uapi/linux/if_vlan.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015
Joe Perchesa3f671b2012-03-18 17:37:56 +000016#define VLAN_HLEN 4 /* The additional bytes required by VLAN
17 * (in addition to the Ethernet header)
Linus Torvalds1da177e2005-04-16 15:20:36 -070018 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#define VLAN_ETH_HLEN 18 /* Total octets in header. */
20#define VLAN_ETH_ZLEN 64 /* Min. octets in frame sans FCS */
21
22/*
23 * According to 802.3ac, the packet can be 4 bytes longer. --Klika Jan
24 */
25#define VLAN_ETH_DATA_LEN 1500 /* Max. octets in payload */
26#define VLAN_ETH_FRAME_LEN 1518 /* Max. octets in frame sans FCS */
27
Patrick McHardy740c15d2008-01-21 00:18:53 -080028/*
29 * struct vlan_hdr - vlan header
30 * @h_vlan_TCI: priority and VLAN ID
31 * @h_vlan_encapsulated_proto: packet type ID or len
32 */
33struct vlan_hdr {
34 __be16 h_vlan_TCI;
35 __be16 h_vlan_encapsulated_proto;
36};
37
38/**
39 * struct vlan_ethhdr - vlan ethernet header (ethhdr + vlan_hdr)
40 * @h_dest: destination ethernet address
41 * @h_source: source ethernet address
Olaf Heringa7bf5802013-06-14 17:07:01 +020042 * @h_vlan_proto: ethernet protocol
Patrick McHardy740c15d2008-01-21 00:18:53 -080043 * @h_vlan_TCI: priority and VLAN ID
44 * @h_vlan_encapsulated_proto: packet type ID or len
45 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070046struct vlan_ethhdr {
Patrick McHardy740c15d2008-01-21 00:18:53 -080047 unsigned char h_dest[ETH_ALEN];
48 unsigned char h_source[ETH_ALEN];
49 __be16 h_vlan_proto;
50 __be16 h_vlan_TCI;
51 __be16 h_vlan_encapsulated_proto;
Linus Torvalds1da177e2005-04-16 15:20:36 -070052};
53
54#include <linux/skbuff.h>
55
56static inline struct vlan_ethhdr *vlan_eth_hdr(const struct sk_buff *skb)
57{
Arnaldo Carvalho de Melo98e399f2007-03-19 15:33:04 -070058 return (struct vlan_ethhdr *)skb_mac_header(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -070059}
60
Eric Dumazet05423b22009-10-26 18:40:35 -070061#define VLAN_PRIO_MASK 0xe000 /* Priority Code Point */
62#define VLAN_PRIO_SHIFT 13
Michał Mirosława2e768b2018-11-20 13:20:31 +010063#define VLAN_CFI_MASK 0x1000 /* Canonical Format Indicator / Drop Eligible Indicator */
Eric Dumazet05423b22009-10-26 18:40:35 -070064#define VLAN_VID_MASK 0x0fff /* VLAN Identifier */
Jesse Grossb7381272010-10-20 13:56:02 +000065#define VLAN_N_VID 4096
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
67/* found in socket.c */
Eric W. Biederman881d9662007-09-17 11:56:21 -070068extern void vlan_ioctl_set(int (*hook)(struct net *, void __user *));
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
Jiri Pirkob618aaa2015-12-04 15:01:31 +010070static inline bool is_vlan_dev(const struct net_device *dev)
Neil Horman6dcbbe22011-05-24 08:31:08 +000071{
72 return dev->priv_flags & IFF_802_1Q_VLAN;
73}
74
Michał Mirosław0c4b2d32018-11-10 19:58:36 +010075#define skb_vlan_tag_present(__skb) ((__skb)->vlan_present)
76#define skb_vlan_tag_get(__skb) ((__skb)->vlan_tci)
Jiri Pirkodf8a39d2015-01-13 17:13:44 +010077#define skb_vlan_tag_get_id(__skb) ((__skb)->vlan_tci & VLAN_VID_MASK)
Michał Mirosława2e768b2018-11-20 13:20:31 +010078#define skb_vlan_tag_get_cfi(__skb) (!!((__skb)->vlan_tci & VLAN_CFI_MASK))
Michał Mirosław9b319142018-11-07 18:07:03 +010079#define skb_vlan_tag_get_prio(__skb) (((__skb)->vlan_tci & VLAN_PRIO_MASK) >> VLAN_PRIO_SHIFT)
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
Gal Pressman9daae9b2018-03-28 17:46:54 +030081static inline int vlan_get_rx_ctag_filter_info(struct net_device *dev)
82{
83 ASSERT_RTNL();
84 return notifier_to_errno(call_netdevice_notifiers(NETDEV_CVLAN_FILTER_PUSH_INFO, dev));
85}
86
87static inline void vlan_drop_rx_ctag_filter_info(struct net_device *dev)
88{
89 ASSERT_RTNL();
90 call_netdevice_notifiers(NETDEV_CVLAN_FILTER_DROP_INFO, dev);
91}
92
93static inline int vlan_get_rx_stag_filter_info(struct net_device *dev)
94{
95 ASSERT_RTNL();
96 return notifier_to_errno(call_netdevice_notifiers(NETDEV_SVLAN_FILTER_PUSH_INFO, dev));
97}
98
99static inline void vlan_drop_rx_stag_filter_info(struct net_device *dev)
100{
101 ASSERT_RTNL();
102 call_netdevice_notifiers(NETDEV_SVLAN_FILTER_DROP_INFO, dev);
103}
104
David S. Millere267cb92013-11-11 00:42:07 -0500105/**
106 * struct vlan_pcpu_stats - VLAN percpu rx/tx stats
107 * @rx_packets: number of received packets
108 * @rx_bytes: number of received bytes
109 * @rx_multicast: number of received multicast packets
110 * @tx_packets: number of transmitted packets
111 * @tx_bytes: number of transmitted bytes
112 * @syncp: synchronization point for 64bit counters
113 * @rx_errors: number of rx errors
114 * @tx_dropped: number of tx drops
115 */
116struct vlan_pcpu_stats {
117 u64 rx_packets;
118 u64 rx_bytes;
119 u64 rx_multicast;
120 u64 tx_packets;
121 u64 tx_bytes;
122 struct u64_stats_sync syncp;
123 u32 rx_errors;
124 u32 tx_dropped;
125};
126
Hannes Frederic Sowa1e85c9b2014-01-06 01:41:20 +0100127#if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
128
dingtianhongf06c7f9f2014-05-09 14:58:05 +0800129extern struct net_device *__vlan_find_dev_deep_rcu(struct net_device *real_dev,
Hannes Frederic Sowa1e85c9b2014-01-06 01:41:20 +0100130 __be16 vlan_proto, u16 vlan_id);
Ivan Khoronzhuk960abf62018-11-08 22:27:55 +0200131extern int vlan_for_each(struct net_device *dev,
132 int (*action)(struct net_device *dev, int vid,
133 void *arg), void *arg);
Hannes Frederic Sowa1e85c9b2014-01-06 01:41:20 +0100134extern struct net_device *vlan_dev_real_dev(const struct net_device *dev);
135extern u16 vlan_dev_vlan_id(const struct net_device *dev);
dingtianhong71e415e2014-03-25 17:44:42 +0800136extern __be16 vlan_dev_vlan_proto(const struct net_device *dev);
Hannes Frederic Sowa1e85c9b2014-01-06 01:41:20 +0100137
138/**
139 * struct vlan_priority_tci_mapping - vlan egress priority mappings
140 * @priority: skb priority
141 * @vlan_qos: vlan priority: (skb->priority << 13) & 0xE000
142 * @next: pointer to next struct
143 */
144struct vlan_priority_tci_mapping {
145 u32 priority;
146 u16 vlan_qos;
147 struct vlan_priority_tci_mapping *next;
148};
149
David S. Millere267cb92013-11-11 00:42:07 -0500150struct proc_dir_entry;
151struct netpoll;
152
153/**
154 * struct vlan_dev_priv - VLAN private device data
155 * @nr_ingress_mappings: number of ingress priority mappings
156 * @ingress_priority_map: ingress priority mappings
157 * @nr_egress_mappings: number of egress priority mappings
158 * @egress_priority_map: hash of egress priority mappings
159 * @vlan_proto: VLAN encapsulation protocol
160 * @vlan_id: VLAN identifier
161 * @flags: device flags
162 * @real_dev: underlying netdevice
163 * @real_dev_addr: address of underlying netdevice
164 * @dent: proc dir entry
165 * @vlan_pcpu_stats: ptr to percpu rx stats
166 */
167struct vlan_dev_priv {
168 unsigned int nr_ingress_mappings;
169 u32 ingress_priority_map[8];
170 unsigned int nr_egress_mappings;
171 struct vlan_priority_tci_mapping *egress_priority_map[16];
172
173 __be16 vlan_proto;
174 u16 vlan_id;
175 u16 flags;
176
177 struct net_device *real_dev;
178 unsigned char real_dev_addr[ETH_ALEN];
179
180 struct proc_dir_entry *dent;
181 struct vlan_pcpu_stats __percpu *vlan_pcpu_stats;
182#ifdef CONFIG_NET_POLL_CONTROLLER
183 struct netpoll *netpoll;
184#endif
185};
186
187static inline struct vlan_dev_priv *vlan_dev_priv(const struct net_device *dev)
188{
189 return netdev_priv(dev);
190}
191
192static inline u16
193vlan_dev_get_egress_qos_mask(struct net_device *dev, u32 skprio)
194{
195 struct vlan_priority_tci_mapping *mp;
196
197 smp_rmb(); /* coupled with smp_wmb() in vlan_dev_set_egress_priority() */
198
199 mp = vlan_dev_priv(dev)->egress_priority_map[(skprio & 0xF)];
200 while (mp) {
201 if (mp->priority == skprio) {
202 return mp->vlan_qos; /* This should already be shifted
203 * to mask correctly with the
204 * VLAN's TCI */
205 }
206 mp = mp->next;
207 }
208 return 0;
209}
210
Florian Zumbiehl48cc32d32012-10-07 15:51:58 +0000211extern bool vlan_do_receive(struct sk_buff **skb);
Patrick McHardy9b22ea52008-11-04 14:49:57 -0800212
Patrick McHardy80d5c362013-04-19 02:04:28 +0000213extern int vlan_vid_add(struct net_device *dev, __be16 proto, u16 vid);
214extern void vlan_vid_del(struct net_device *dev, __be16 proto, u16 vid);
Jiri Pirko87002b02011-12-08 04:11:17 +0000215
Jiri Pirko348a1442011-12-08 04:11:19 +0000216extern int vlan_vids_add_by_dev(struct net_device *dev,
217 const struct net_device *by_dev);
218extern void vlan_vids_del_by_dev(struct net_device *dev,
219 const struct net_device *by_dev);
Jiri Pirko9b361c12012-08-23 03:26:52 +0000220
221extern bool vlan_uses_dev(const struct net_device *dev);
Vlad Yaseviche1618d42014-05-20 10:59:26 -0400222
Patrick McHardy7750f402008-07-08 03:23:36 -0700223#else
Jiri Pirkocec9c132011-07-20 04:54:05 +0000224static inline struct net_device *
dingtianhongf06c7f9f2014-05-09 14:58:05 +0800225__vlan_find_dev_deep_rcu(struct net_device *real_dev,
Patrick McHardy9fae27b2013-04-20 23:51:41 +0000226 __be16 vlan_proto, u16 vlan_id)
Jiri Pirkocec9c132011-07-20 04:54:05 +0000227{
228 return NULL;
229}
230
Ivan Khoronzhuk960abf62018-11-08 22:27:55 +0200231static inline int
232vlan_for_each(struct net_device *dev,
233 int (*action)(struct net_device *dev, int vid, void *arg),
234 void *arg)
235{
236 return 0;
237}
238
Patrick McHardy22d1ba72008-07-08 03:23:57 -0700239static inline struct net_device *vlan_dev_real_dev(const struct net_device *dev)
240{
241 BUG();
242 return NULL;
243}
244
245static inline u16 vlan_dev_vlan_id(const struct net_device *dev)
246{
247 BUG();
248 return 0;
249}
250
dingtianhong71e415e2014-03-25 17:44:42 +0800251static inline __be16 vlan_dev_vlan_proto(const struct net_device *dev)
252{
253 BUG();
254 return 0;
255}
256
Eyal Perryd3243532013-11-06 15:37:23 +0200257static inline u16 vlan_dev_get_egress_qos_mask(struct net_device *dev,
258 u32 skprio)
259{
260 return 0;
261}
262
Florian Zumbiehl48cc32d32012-10-07 15:51:58 +0000263static inline bool vlan_do_receive(struct sk_buff **skb)
Patrick McHardy9b22ea52008-11-04 14:49:57 -0800264{
Jesse Gross3701e512010-10-20 13:56:06 +0000265 return false;
Patrick McHardy9b22ea52008-11-04 14:49:57 -0800266}
Herbert Xue1c096e2009-01-06 10:50:09 -0800267
Patrick McHardy9fae27b2013-04-20 23:51:41 +0000268static inline int vlan_vid_add(struct net_device *dev, __be16 proto, u16 vid)
Jiri Pirko87002b02011-12-08 04:11:17 +0000269{
270 return 0;
271}
272
Patrick McHardy9fae27b2013-04-20 23:51:41 +0000273static inline void vlan_vid_del(struct net_device *dev, __be16 proto, u16 vid)
Jiri Pirko87002b02011-12-08 04:11:17 +0000274{
275}
Jiri Pirko348a1442011-12-08 04:11:19 +0000276
277static inline int vlan_vids_add_by_dev(struct net_device *dev,
278 const struct net_device *by_dev)
279{
280 return 0;
281}
282
283static inline void vlan_vids_del_by_dev(struct net_device *dev,
284 const struct net_device *by_dev)
285{
286}
Jiri Pirko9b361c12012-08-23 03:26:52 +0000287
288static inline bool vlan_uses_dev(const struct net_device *dev)
289{
290 return false;
291}
Patrick McHardy7750f402008-07-08 03:23:36 -0700292#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293
Eric Garverfe19c4f2016-09-07 12:56:58 -0400294/**
295 * eth_type_vlan - check for valid vlan ether type.
296 * @ethertype: ether type to check
297 *
298 * Returns true if the ether type is a vlan ether type.
299 */
300static inline bool eth_type_vlan(__be16 ethertype)
301{
302 switch (ethertype) {
303 case htons(ETH_P_8021Q):
304 case htons(ETH_P_8021AD):
305 return true;
306 default:
307 return false;
308 }
309}
310
Patrick McHardy86a9bad2013-04-19 02:04:30 +0000311static inline bool vlan_hw_offload_capable(netdev_features_t features,
312 __be16 proto)
313{
314 if (proto == htons(ETH_P_8021Q) && features & NETIF_F_HW_VLAN_CTAG_TX)
315 return true;
Patrick McHardy8ad227f2013-04-19 02:04:31 +0000316 if (proto == htons(ETH_P_8021AD) && features & NETIF_F_HW_VLAN_STAG_TX)
317 return true;
Patrick McHardy86a9bad2013-04-19 02:04:30 +0000318 return false;
319}
320
Patrick McHardy9bb85822008-07-08 03:24:44 -0700321/**
Toshiaki Makitacbe71282018-03-13 14:51:28 +0900322 * __vlan_insert_inner_tag - inner VLAN tag inserting
323 * @skb: skbuff to tag
324 * @vlan_proto: VLAN encapsulation protocol
325 * @vlan_tci: VLAN TCI to insert
326 * @mac_len: MAC header length including outer vlan headers
327 *
328 * Inserts the VLAN tag into @skb as part of the payload at offset mac_len
Thadeu Lima de Souza Cascardo8051ac72018-05-31 09:20:20 -0300329 * Returns error if skb_cow_head fails.
Toshiaki Makitacbe71282018-03-13 14:51:28 +0900330 *
331 * Does not change skb->protocol so this function can be used during receive.
332 */
333static inline int __vlan_insert_inner_tag(struct sk_buff *skb,
334 __be16 vlan_proto, u16 vlan_tci,
335 unsigned int mac_len)
336{
337 struct vlan_ethhdr *veth;
338
339 if (skb_cow_head(skb, VLAN_HLEN) < 0)
340 return -ENOMEM;
341
342 skb_push(skb, VLAN_HLEN);
343
344 /* Move the mac header sans proto to the beginning of the new header. */
Toshiaki Makitac769acc2018-03-29 19:05:30 +0900345 if (likely(mac_len > ETH_TLEN))
346 memmove(skb->data, skb->data + VLAN_HLEN, mac_len - ETH_TLEN);
Toshiaki Makitacbe71282018-03-13 14:51:28 +0900347 skb->mac_header -= VLAN_HLEN;
348
349 veth = (struct vlan_ethhdr *)(skb->data + mac_len - ETH_HLEN);
350
351 /* first, the ethernet type */
Toshiaki Makitac769acc2018-03-29 19:05:30 +0900352 if (likely(mac_len >= ETH_TLEN)) {
353 /* h_vlan_encapsulated_proto should already be populated, and
354 * skb->data has space for h_vlan_proto
355 */
356 veth->h_vlan_proto = vlan_proto;
357 } else {
358 /* h_vlan_encapsulated_proto should not be populated, and
359 * skb->data has no space for h_vlan_proto
360 */
361 veth->h_vlan_encapsulated_proto = skb->protocol;
362 }
Toshiaki Makitacbe71282018-03-13 14:51:28 +0900363
364 /* now, the TCI */
365 veth->h_vlan_TCI = htons(vlan_tci);
366
367 return 0;
368}
369
370/**
Jiri Pirko15255a42014-11-19 14:05:00 +0100371 * __vlan_insert_tag - regular VLAN tag inserting
372 * @skb: skbuff to tag
373 * @vlan_proto: VLAN encapsulation protocol
374 * @vlan_tci: VLAN TCI to insert
375 *
376 * Inserts the VLAN tag into @skb as part of the payload
Thadeu Lima de Souza Cascardo8051ac72018-05-31 09:20:20 -0300377 * Returns error if skb_cow_head fails.
Jiri Pirko15255a42014-11-19 14:05:00 +0100378 *
379 * Does not change skb->protocol so this function can be used during receive.
380 */
381static inline int __vlan_insert_tag(struct sk_buff *skb,
382 __be16 vlan_proto, u16 vlan_tci)
383{
Toshiaki Makitacbe71282018-03-13 14:51:28 +0900384 return __vlan_insert_inner_tag(skb, vlan_proto, vlan_tci, ETH_HLEN);
385}
Jiri Pirko15255a42014-11-19 14:05:00 +0100386
Toshiaki Makitacbe71282018-03-13 14:51:28 +0900387/**
388 * vlan_insert_inner_tag - inner VLAN tag inserting
389 * @skb: skbuff to tag
390 * @vlan_proto: VLAN encapsulation protocol
391 * @vlan_tci: VLAN TCI to insert
392 * @mac_len: MAC header length including outer vlan headers
393 *
394 * Inserts the VLAN tag into @skb as part of the payload at offset mac_len
395 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
396 *
397 * Following the skb_unshare() example, in case of error, the calling function
398 * doesn't have to worry about freeing the original skb.
399 *
400 * Does not change skb->protocol so this function can be used during receive.
401 */
402static inline struct sk_buff *vlan_insert_inner_tag(struct sk_buff *skb,
403 __be16 vlan_proto,
404 u16 vlan_tci,
405 unsigned int mac_len)
406{
407 int err;
Jiri Pirko15255a42014-11-19 14:05:00 +0100408
Toshiaki Makitacbe71282018-03-13 14:51:28 +0900409 err = __vlan_insert_inner_tag(skb, vlan_proto, vlan_tci, mac_len);
410 if (err) {
411 dev_kfree_skb_any(skb);
412 return NULL;
413 }
414 return skb;
Jiri Pirko15255a42014-11-19 14:05:00 +0100415}
416
417/**
Jiri Pirko0b5c9db2011-06-10 06:56:58 +0000418 * vlan_insert_tag - regular VLAN tag inserting
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 * @skb: skbuff to tag
Patrick McHardy86a9bad2013-04-19 02:04:30 +0000420 * @vlan_proto: VLAN encapsulation protocol
Patrick McHardy9bb85822008-07-08 03:24:44 -0700421 * @vlan_tci: VLAN TCI to insert
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 *
423 * Inserts the VLAN tag into @skb as part of the payload
424 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
Patrick McHardy9bb85822008-07-08 03:24:44 -0700425 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 * Following the skb_unshare() example, in case of error, the calling function
427 * doesn't have to worry about freeing the original skb.
Jiri Pirko0b5c9db2011-06-10 06:56:58 +0000428 *
429 * Does not change skb->protocol so this function can be used during receive.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 */
Patrick McHardy86a9bad2013-04-19 02:04:30 +0000431static inline struct sk_buff *vlan_insert_tag(struct sk_buff *skb,
432 __be16 vlan_proto, u16 vlan_tci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433{
Toshiaki Makitacbe71282018-03-13 14:51:28 +0900434 return vlan_insert_inner_tag(skb, vlan_proto, vlan_tci, ETH_HLEN);
Jiri Pirko0b5c9db2011-06-10 06:56:58 +0000435}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436
Jiri Pirko0b5c9db2011-06-10 06:56:58 +0000437/**
Jiri Pirko62749e22014-11-19 14:04:58 +0100438 * vlan_insert_tag_set_proto - regular VLAN tag inserting
Jiri Pirko0b5c9db2011-06-10 06:56:58 +0000439 * @skb: skbuff to tag
Jiri Pirko62749e22014-11-19 14:04:58 +0100440 * @vlan_proto: VLAN encapsulation protocol
Jiri Pirko0b5c9db2011-06-10 06:56:58 +0000441 * @vlan_tci: VLAN TCI to insert
442 *
443 * Inserts the VLAN tag into @skb as part of the payload
444 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
445 *
446 * Following the skb_unshare() example, in case of error, the calling function
447 * doesn't have to worry about freeing the original skb.
448 */
Jiri Pirko62749e22014-11-19 14:04:58 +0100449static inline struct sk_buff *vlan_insert_tag_set_proto(struct sk_buff *skb,
450 __be16 vlan_proto,
451 u16 vlan_tci)
Jiri Pirko0b5c9db2011-06-10 06:56:58 +0000452{
Patrick McHardy86a9bad2013-04-19 02:04:30 +0000453 skb = vlan_insert_tag(skb, vlan_proto, vlan_tci);
Jiri Pirko0b5c9db2011-06-10 06:56:58 +0000454 if (skb)
Patrick McHardy86a9bad2013-04-19 02:04:30 +0000455 skb->protocol = vlan_proto;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 return skb;
457}
458
Michał Mirosławc8accd52018-11-07 18:07:02 +0100459/**
460 * __vlan_hwaccel_clear_tag - clear hardware accelerated VLAN info
461 * @skb: skbuff to clear
462 *
463 * Clears the VLAN information from @skb
464 */
465static inline void __vlan_hwaccel_clear_tag(struct sk_buff *skb)
466{
Michał Mirosław0c4b2d32018-11-10 19:58:36 +0100467 skb->vlan_present = 0;
Michał Mirosławc8accd52018-11-07 18:07:02 +0100468}
469
Michał Mirosławe0a6b802018-11-07 18:07:02 +0100470/**
471 * __vlan_hwaccel_copy_tag - copy hardware accelerated VLAN info from another skb
472 * @dst: skbuff to copy to
473 * @src: skbuff to copy from
474 *
475 * Copies VLAN information from @src to @dst (for branchless code)
476 */
477static inline void __vlan_hwaccel_copy_tag(struct sk_buff *dst, const struct sk_buff *src)
478{
Michał Mirosław0c4b2d32018-11-10 19:58:36 +0100479 dst->vlan_present = src->vlan_present;
Michał Mirosławe0a6b802018-11-07 18:07:02 +0100480 dst->vlan_proto = src->vlan_proto;
481 dst->vlan_tci = src->vlan_tci;
482}
483
Jiri Pirko59682502014-11-19 14:04:59 +0100484/*
485 * __vlan_hwaccel_push_inside - pushes vlan tag to the payload
486 * @skb: skbuff to tag
487 *
488 * Pushes the VLAN tag from @skb->vlan_tci inside to the payload.
489 *
490 * Following the skb_unshare() example, in case of error, the calling function
491 * doesn't have to worry about freeing the original skb.
492 */
493static inline struct sk_buff *__vlan_hwaccel_push_inside(struct sk_buff *skb)
494{
495 skb = vlan_insert_tag_set_proto(skb, skb->vlan_proto,
Jiri Pirkodf8a39d2015-01-13 17:13:44 +0100496 skb_vlan_tag_get(skb));
Jiri Pirko59682502014-11-19 14:04:59 +0100497 if (likely(skb))
Michał Mirosławc8accd52018-11-07 18:07:02 +0100498 __vlan_hwaccel_clear_tag(skb);
Jiri Pirko59682502014-11-19 14:04:59 +0100499 return skb;
500}
Jiri Pirko59682502014-11-19 14:04:59 +0100501
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502/**
503 * __vlan_hwaccel_put_tag - hardware accelerated VLAN inserting
504 * @skb: skbuff to tag
Patrick McHardy86a9bad2013-04-19 02:04:30 +0000505 * @vlan_proto: VLAN encapsulation protocol
Patrick McHardy9bb85822008-07-08 03:24:44 -0700506 * @vlan_tci: VLAN TCI to insert
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 *
Patrick McHardy6aa895b2008-07-14 22:49:06 -0700508 * Puts the VLAN TCI in @skb->vlan_tci and lets the device do the rest
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 */
Jiri Pirkob960a0ac2014-11-19 14:04:56 +0100510static inline void __vlan_hwaccel_put_tag(struct sk_buff *skb,
511 __be16 vlan_proto, u16 vlan_tci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512{
Patrick McHardy86a9bad2013-04-19 02:04:30 +0000513 skb->vlan_proto = vlan_proto;
Michał Mirosław0c4b2d32018-11-10 19:58:36 +0100514 skb->vlan_tci = vlan_tci;
515 skb->vlan_present = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516}
517
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 * __vlan_get_tag - get the VLAN ID that is part of the payload
520 * @skb: skbuff to query
Vivien Didelotf4fb8742015-05-27 21:07:26 -0400521 * @vlan_tci: buffer to store value
Patrick McHardy9bb85822008-07-08 03:24:44 -0700522 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 * Returns error if the skb is not of VLAN type
524 */
Patrick McHardy9bb85822008-07-08 03:24:44 -0700525static inline int __vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526{
527 struct vlan_ethhdr *veth = (struct vlan_ethhdr *)skb->data;
528
Eric Garverfe19c4f2016-09-07 12:56:58 -0400529 if (!eth_type_vlan(veth->h_vlan_proto))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531
Patrick McHardy9bb85822008-07-08 03:24:44 -0700532 *vlan_tci = ntohs(veth->h_vlan_TCI);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 return 0;
534}
535
536/**
537 * __vlan_hwaccel_get_tag - get the VLAN ID that is in @skb->cb[]
538 * @skb: skbuff to query
Vivien Didelotf4fb8742015-05-27 21:07:26 -0400539 * @vlan_tci: buffer to store value
Patrick McHardy9bb85822008-07-08 03:24:44 -0700540 *
Patrick McHardy6aa895b2008-07-14 22:49:06 -0700541 * Returns error if @skb->vlan_tci is not set correctly
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 */
Patrick McHardy18149932008-02-05 16:20:22 -0800543static inline int __vlan_hwaccel_get_tag(const struct sk_buff *skb,
Patrick McHardy9bb85822008-07-08 03:24:44 -0700544 u16 *vlan_tci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545{
Jiri Pirkodf8a39d2015-01-13 17:13:44 +0100546 if (skb_vlan_tag_present(skb)) {
547 *vlan_tci = skb_vlan_tag_get(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 return 0;
549 } else {
Patrick McHardy9bb85822008-07-08 03:24:44 -0700550 *vlan_tci = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 return -EINVAL;
552 }
553}
554
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555/**
556 * vlan_get_tag - get the VLAN ID from the skb
557 * @skb: skbuff to query
Vivien Didelotf4fb8742015-05-27 21:07:26 -0400558 * @vlan_tci: buffer to store value
Patrick McHardy9bb85822008-07-08 03:24:44 -0700559 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 * Returns error if the skb is not VLAN tagged
561 */
Patrick McHardy9bb85822008-07-08 03:24:44 -0700562static inline int vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563{
Patrick McHardyf6469682013-04-19 02:04:27 +0000564 if (skb->dev->features & NETIF_F_HW_VLAN_CTAG_TX) {
Patrick McHardy9bb85822008-07-08 03:24:44 -0700565 return __vlan_hwaccel_get_tag(skb, vlan_tci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 } else {
Patrick McHardy9bb85822008-07-08 03:24:44 -0700567 return __vlan_get_tag(skb, vlan_tci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 }
569}
570
Hao Zheng0a85df02010-11-11 13:47:57 +0000571/**
572 * vlan_get_protocol - get protocol EtherType.
573 * @skb: skbuff to query
Toshiaki Makitad4bcef32015-01-29 20:37:07 +0900574 * @type: first vlan protocol
575 * @depth: buffer to store length of eth and vlan tags in bytes
Hao Zheng0a85df02010-11-11 13:47:57 +0000576 *
577 * Returns the EtherType of the packet, regardless of whether it is
578 * vlan encapsulated (normal or hardware accelerated) or not.
579 */
Toshiaki Makitad4bcef32015-01-29 20:37:07 +0900580static inline __be16 __vlan_get_protocol(struct sk_buff *skb, __be16 type,
581 int *depth)
Hao Zheng0a85df02010-11-11 13:47:57 +0000582{
Toshiaki Makitad4bcef32015-01-29 20:37:07 +0900583 unsigned int vlan_depth = skb->mac_len;
Hao Zheng0a85df02010-11-11 13:47:57 +0000584
Toshiaki Makitad4bcef32015-01-29 20:37:07 +0900585 /* if type is 802.1Q/AD then the header should already be
586 * present at mac_len - VLAN_HLEN (if mac_len > 0), or at
587 * ETH_HLEN otherwise
588 */
Eric Garverfe19c4f2016-09-07 12:56:58 -0400589 if (eth_type_vlan(type)) {
Toshiaki Makitad4bcef32015-01-29 20:37:07 +0900590 if (vlan_depth) {
591 if (WARN_ON(vlan_depth < VLAN_HLEN))
592 return 0;
593 vlan_depth -= VLAN_HLEN;
594 } else {
595 vlan_depth = ETH_HLEN;
596 }
597 do {
598 struct vlan_hdr *vh;
599
600 if (unlikely(!pskb_may_pull(skb,
601 vlan_depth + VLAN_HLEN)))
602 return 0;
603
604 vh = (struct vlan_hdr *)(skb->data + vlan_depth);
605 type = vh->h_vlan_encapsulated_proto;
606 vlan_depth += VLAN_HLEN;
Eric Garverfe19c4f2016-09-07 12:56:58 -0400607 } while (eth_type_vlan(type));
Hao Zheng0a85df02010-11-11 13:47:57 +0000608 }
609
Toshiaki Makitad4bcef32015-01-29 20:37:07 +0900610 if (depth)
611 *depth = vlan_depth;
612
613 return type;
614}
615
616/**
617 * vlan_get_protocol - get protocol EtherType.
618 * @skb: skbuff to query
619 *
620 * Returns the EtherType of the packet, regardless of whether it is
621 * vlan encapsulated (normal or hardware accelerated) or not.
622 */
623static inline __be16 vlan_get_protocol(struct sk_buff *skb)
624{
625 return __vlan_get_protocol(skb, skb->protocol, NULL);
Hao Zheng0a85df02010-11-11 13:47:57 +0000626}
Pravin B Shelar396cf942011-11-18 13:15:54 -0800627
628static inline void vlan_set_encap_proto(struct sk_buff *skb,
629 struct vlan_hdr *vhdr)
630{
631 __be16 proto;
Cong Wangda8c8722013-02-21 23:32:27 +0000632 unsigned short *rawp;
Pravin B Shelar396cf942011-11-18 13:15:54 -0800633
634 /*
635 * Was a VLAN packet, grab the encapsulated protocol, which the layer
636 * three protocols care about.
637 */
638
639 proto = vhdr->h_vlan_encapsulated_proto;
Alexander Duyck9545b222015-05-04 14:34:10 -0700640 if (eth_proto_is_802_3(proto)) {
Pravin B Shelar396cf942011-11-18 13:15:54 -0800641 skb->protocol = proto;
642 return;
643 }
644
Cong Wangda8c8722013-02-21 23:32:27 +0000645 rawp = (unsigned short *)(vhdr + 1);
646 if (*rawp == 0xFFFF)
Pravin B Shelar396cf942011-11-18 13:15:54 -0800647 /*
648 * This is a magic hack to spot IPX packets. Older Novell
649 * breaks the protocol design and runs IPX over 802.3 without
650 * an 802.2 LLC layer. We look for FFFF which isn't a used
651 * 802.2 SSAP/DSAP. This won't work for fault tolerant netware
652 * but does for the rest.
653 */
654 skb->protocol = htons(ETH_P_802_3);
655 else
656 /*
657 * Real 802.2 LLC
658 */
659 skb->protocol = htons(ETH_P_802_2);
660}
Vlad Yasevich44a40852014-05-16 17:20:38 -0400661
Toshiaki Makitaf5a7fb82015-03-27 14:31:11 +0900662/**
663 * skb_vlan_tagged - check if skb is vlan tagged.
664 * @skb: skbuff to query
665 *
666 * Returns true if the skb is tagged, regardless of whether it is hardware
667 * accelerated or not.
668 */
669static inline bool skb_vlan_tagged(const struct sk_buff *skb)
670{
671 if (!skb_vlan_tag_present(skb) &&
Eric Garverfe19c4f2016-09-07 12:56:58 -0400672 likely(!eth_type_vlan(skb->protocol)))
Toshiaki Makitaf5a7fb82015-03-27 14:31:11 +0900673 return false;
674
675 return true;
676}
677
678/**
679 * skb_vlan_tagged_multi - check if skb is vlan tagged with multiple headers.
680 * @skb: skbuff to query
681 *
682 * Returns true if the skb is tagged with multiple vlan headers, regardless
683 * of whether it is hardware accelerated or not.
684 */
Toshiaki Makita7ce23672018-04-17 18:46:14 +0900685static inline bool skb_vlan_tagged_multi(struct sk_buff *skb)
Toshiaki Makitaf5a7fb82015-03-27 14:31:11 +0900686{
687 __be16 protocol = skb->protocol;
688
689 if (!skb_vlan_tag_present(skb)) {
690 struct vlan_ethhdr *veh;
691
Eric Garverfe19c4f2016-09-07 12:56:58 -0400692 if (likely(!eth_type_vlan(protocol)))
Toshiaki Makitaf5a7fb82015-03-27 14:31:11 +0900693 return false;
694
Toshiaki Makita7ce23672018-04-17 18:46:14 +0900695 if (unlikely(!pskb_may_pull(skb, VLAN_ETH_HLEN)))
696 return false;
697
Toshiaki Makitaf5a7fb82015-03-27 14:31:11 +0900698 veh = (struct vlan_ethhdr *)skb->data;
699 protocol = veh->h_vlan_encapsulated_proto;
700 }
701
Eric Garverfe19c4f2016-09-07 12:56:58 -0400702 if (!eth_type_vlan(protocol))
Toshiaki Makitaf5a7fb82015-03-27 14:31:11 +0900703 return false;
704
705 return true;
706}
707
Toshiaki Makita8cb65d02015-03-27 14:31:12 +0900708/**
709 * vlan_features_check - drop unsafe features for skb with multiple tags.
710 * @skb: skbuff to query
711 * @features: features to be checked
712 *
713 * Returns features without unsafe ones if the skb has multiple tags.
714 */
Toshiaki Makita7ce23672018-04-17 18:46:14 +0900715static inline netdev_features_t vlan_features_check(struct sk_buff *skb,
Toshiaki Makita8cb65d02015-03-27 14:31:12 +0900716 netdev_features_t features)
717{
Vlad Yasevich35d2f802017-05-23 13:38:41 -0400718 if (skb_vlan_tagged_multi(skb)) {
719 /* In the case of multi-tagged packets, use a direct mask
720 * instead of using netdev_interesect_features(), to make
721 * sure that only devices supporting NETIF_F_HW_CSUM will
722 * have checksum offloading support.
723 */
724 features &= NETIF_F_SG | NETIF_F_HIGHDMA | NETIF_F_HW_CSUM |
725 NETIF_F_FRAGLIST | NETIF_F_HW_VLAN_CTAG_TX |
726 NETIF_F_HW_VLAN_STAG_TX;
727 }
Toshiaki Makita8cb65d02015-03-27 14:31:12 +0900728
729 return features;
730}
731
Toshiaki Makita66e51332015-06-01 21:55:06 +0900732/**
733 * compare_vlan_header - Compare two vlan headers
734 * @h1: Pointer to vlan header
735 * @h2: Pointer to vlan header
736 *
737 * Compare two vlan headers, returns 0 if equal.
738 *
739 * Please note that alignment of h1 & h2 are only guaranteed to be 16 bits.
740 */
741static inline unsigned long compare_vlan_header(const struct vlan_hdr *h1,
742 const struct vlan_hdr *h2)
743{
744#if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
745 return *(u32 *)h1 ^ *(u32 *)h2;
746#else
747 return ((__force u32)h1->h_vlan_TCI ^ (__force u32)h2->h_vlan_TCI) |
748 ((__force u32)h1->h_vlan_encapsulated_proto ^
749 (__force u32)h2->h_vlan_encapsulated_proto);
750#endif
751}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752#endif /* !(_LINUX_IF_VLAN_H_) */