blob: b14bf87999aa0df62cb4cc2abd39f5b0b4893b3b [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * VLAN An implementation of 802.1Q VLAN tagging.
3 *
4 * Authors: Ben Greear <greearb@candelatech.com>
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 *
11 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#ifndef _LINUX_IF_VLAN_H_
13#define _LINUX_IF_VLAN_H_
14
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/netdevice.h>
Stephen Hemminger0610d112006-07-14 16:34:22 -070016#include <linux/etherdevice.h>
Jesse Gross65ac6a52010-10-20 13:56:05 +000017#include <linux/rtnetlink.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050018#include <linux/bug.h>
David Howells607ca462012-10-13 10:46:48 +010019#include <uapi/linux/if_vlan.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
Joe Perchesa3f671b2012-03-18 17:37:56 +000021#define VLAN_HLEN 4 /* The additional bytes required by VLAN
22 * (in addition to the Ethernet header)
Linus Torvalds1da177e2005-04-16 15:20:36 -070023 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#define VLAN_ETH_HLEN 18 /* Total octets in header. */
25#define VLAN_ETH_ZLEN 64 /* Min. octets in frame sans FCS */
26
27/*
28 * According to 802.3ac, the packet can be 4 bytes longer. --Klika Jan
29 */
30#define VLAN_ETH_DATA_LEN 1500 /* Max. octets in payload */
31#define VLAN_ETH_FRAME_LEN 1518 /* Max. octets in frame sans FCS */
32
Patrick McHardy740c15d2008-01-21 00:18:53 -080033/*
34 * struct vlan_hdr - vlan header
35 * @h_vlan_TCI: priority and VLAN ID
36 * @h_vlan_encapsulated_proto: packet type ID or len
37 */
38struct vlan_hdr {
39 __be16 h_vlan_TCI;
40 __be16 h_vlan_encapsulated_proto;
41};
42
43/**
44 * struct vlan_ethhdr - vlan ethernet header (ethhdr + vlan_hdr)
45 * @h_dest: destination ethernet address
46 * @h_source: source ethernet address
Olaf Heringa7bf5802013-06-14 17:07:01 +020047 * @h_vlan_proto: ethernet protocol
Patrick McHardy740c15d2008-01-21 00:18:53 -080048 * @h_vlan_TCI: priority and VLAN ID
49 * @h_vlan_encapsulated_proto: packet type ID or len
50 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070051struct vlan_ethhdr {
Patrick McHardy740c15d2008-01-21 00:18:53 -080052 unsigned char h_dest[ETH_ALEN];
53 unsigned char h_source[ETH_ALEN];
54 __be16 h_vlan_proto;
55 __be16 h_vlan_TCI;
56 __be16 h_vlan_encapsulated_proto;
Linus Torvalds1da177e2005-04-16 15:20:36 -070057};
58
59#include <linux/skbuff.h>
60
61static inline struct vlan_ethhdr *vlan_eth_hdr(const struct sk_buff *skb)
62{
Arnaldo Carvalho de Melo98e399f2007-03-19 15:33:04 -070063 return (struct vlan_ethhdr *)skb_mac_header(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064}
65
Eric Dumazet05423b22009-10-26 18:40:35 -070066#define VLAN_PRIO_MASK 0xe000 /* Priority Code Point */
67#define VLAN_PRIO_SHIFT 13
68#define VLAN_CFI_MASK 0x1000 /* Canonical Format Indicator */
69#define VLAN_TAG_PRESENT VLAN_CFI_MASK
70#define VLAN_VID_MASK 0x0fff /* VLAN Identifier */
Jesse Grossb7381272010-10-20 13:56:02 +000071#define VLAN_N_VID 4096
Linus Torvalds1da177e2005-04-16 15:20:36 -070072
73/* found in socket.c */
Eric W. Biederman881d9662007-09-17 11:56:21 -070074extern void vlan_ioctl_set(int (*hook)(struct net *, void __user *));
Linus Torvalds1da177e2005-04-16 15:20:36 -070075
Jiri Pirkob618aaa2015-12-04 15:01:31 +010076static inline bool is_vlan_dev(const struct net_device *dev)
Neil Horman6dcbbe22011-05-24 08:31:08 +000077{
78 return dev->priv_flags & IFF_802_1Q_VLAN;
79}
80
Jiri Pirkodf8a39d2015-01-13 17:13:44 +010081#define skb_vlan_tag_present(__skb) ((__skb)->vlan_tci & VLAN_TAG_PRESENT)
82#define skb_vlan_tag_get(__skb) ((__skb)->vlan_tci & ~VLAN_TAG_PRESENT)
83#define skb_vlan_tag_get_id(__skb) ((__skb)->vlan_tci & VLAN_VID_MASK)
Michał Mirosław9b319142018-11-07 18:07:03 +010084#define skb_vlan_tag_get_prio(__skb) (((__skb)->vlan_tci & VLAN_PRIO_MASK) >> VLAN_PRIO_SHIFT)
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Gal Pressman9daae9b2018-03-28 17:46:54 +030086static inline int vlan_get_rx_ctag_filter_info(struct net_device *dev)
87{
88 ASSERT_RTNL();
89 return notifier_to_errno(call_netdevice_notifiers(NETDEV_CVLAN_FILTER_PUSH_INFO, dev));
90}
91
92static inline void vlan_drop_rx_ctag_filter_info(struct net_device *dev)
93{
94 ASSERT_RTNL();
95 call_netdevice_notifiers(NETDEV_CVLAN_FILTER_DROP_INFO, dev);
96}
97
98static inline int vlan_get_rx_stag_filter_info(struct net_device *dev)
99{
100 ASSERT_RTNL();
101 return notifier_to_errno(call_netdevice_notifiers(NETDEV_SVLAN_FILTER_PUSH_INFO, dev));
102}
103
104static inline void vlan_drop_rx_stag_filter_info(struct net_device *dev)
105{
106 ASSERT_RTNL();
107 call_netdevice_notifiers(NETDEV_SVLAN_FILTER_DROP_INFO, dev);
108}
109
David S. Millere267cb92013-11-11 00:42:07 -0500110/**
111 * struct vlan_pcpu_stats - VLAN percpu rx/tx stats
112 * @rx_packets: number of received packets
113 * @rx_bytes: number of received bytes
114 * @rx_multicast: number of received multicast packets
115 * @tx_packets: number of transmitted packets
116 * @tx_bytes: number of transmitted bytes
117 * @syncp: synchronization point for 64bit counters
118 * @rx_errors: number of rx errors
119 * @tx_dropped: number of tx drops
120 */
121struct vlan_pcpu_stats {
122 u64 rx_packets;
123 u64 rx_bytes;
124 u64 rx_multicast;
125 u64 tx_packets;
126 u64 tx_bytes;
127 struct u64_stats_sync syncp;
128 u32 rx_errors;
129 u32 tx_dropped;
130};
131
Hannes Frederic Sowa1e85c9b2014-01-06 01:41:20 +0100132#if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
133
dingtianhongf06c7f9f2014-05-09 14:58:05 +0800134extern struct net_device *__vlan_find_dev_deep_rcu(struct net_device *real_dev,
Hannes Frederic Sowa1e85c9b2014-01-06 01:41:20 +0100135 __be16 vlan_proto, u16 vlan_id);
136extern struct net_device *vlan_dev_real_dev(const struct net_device *dev);
137extern u16 vlan_dev_vlan_id(const struct net_device *dev);
dingtianhong71e415e2014-03-25 17:44:42 +0800138extern __be16 vlan_dev_vlan_proto(const struct net_device *dev);
Hannes Frederic Sowa1e85c9b2014-01-06 01:41:20 +0100139
140/**
141 * struct vlan_priority_tci_mapping - vlan egress priority mappings
142 * @priority: skb priority
143 * @vlan_qos: vlan priority: (skb->priority << 13) & 0xE000
144 * @next: pointer to next struct
145 */
146struct vlan_priority_tci_mapping {
147 u32 priority;
148 u16 vlan_qos;
149 struct vlan_priority_tci_mapping *next;
150};
151
David S. Millere267cb92013-11-11 00:42:07 -0500152struct proc_dir_entry;
153struct netpoll;
154
155/**
156 * struct vlan_dev_priv - VLAN private device data
157 * @nr_ingress_mappings: number of ingress priority mappings
158 * @ingress_priority_map: ingress priority mappings
159 * @nr_egress_mappings: number of egress priority mappings
160 * @egress_priority_map: hash of egress priority mappings
161 * @vlan_proto: VLAN encapsulation protocol
162 * @vlan_id: VLAN identifier
163 * @flags: device flags
164 * @real_dev: underlying netdevice
165 * @real_dev_addr: address of underlying netdevice
166 * @dent: proc dir entry
167 * @vlan_pcpu_stats: ptr to percpu rx stats
168 */
169struct vlan_dev_priv {
170 unsigned int nr_ingress_mappings;
171 u32 ingress_priority_map[8];
172 unsigned int nr_egress_mappings;
173 struct vlan_priority_tci_mapping *egress_priority_map[16];
174
175 __be16 vlan_proto;
176 u16 vlan_id;
177 u16 flags;
178
179 struct net_device *real_dev;
180 unsigned char real_dev_addr[ETH_ALEN];
181
182 struct proc_dir_entry *dent;
183 struct vlan_pcpu_stats __percpu *vlan_pcpu_stats;
184#ifdef CONFIG_NET_POLL_CONTROLLER
185 struct netpoll *netpoll;
186#endif
Vlad Yasevichd38569a2014-05-16 17:04:55 -0400187 unsigned int nest_level;
David S. Millere267cb92013-11-11 00:42:07 -0500188};
189
190static inline struct vlan_dev_priv *vlan_dev_priv(const struct net_device *dev)
191{
192 return netdev_priv(dev);
193}
194
195static inline u16
196vlan_dev_get_egress_qos_mask(struct net_device *dev, u32 skprio)
197{
198 struct vlan_priority_tci_mapping *mp;
199
200 smp_rmb(); /* coupled with smp_wmb() in vlan_dev_set_egress_priority() */
201
202 mp = vlan_dev_priv(dev)->egress_priority_map[(skprio & 0xF)];
203 while (mp) {
204 if (mp->priority == skprio) {
205 return mp->vlan_qos; /* This should already be shifted
206 * to mask correctly with the
207 * VLAN's TCI */
208 }
209 mp = mp->next;
210 }
211 return 0;
212}
213
Florian Zumbiehl48cc32d32012-10-07 15:51:58 +0000214extern bool vlan_do_receive(struct sk_buff **skb);
Patrick McHardy9b22ea52008-11-04 14:49:57 -0800215
Patrick McHardy80d5c362013-04-19 02:04:28 +0000216extern int vlan_vid_add(struct net_device *dev, __be16 proto, u16 vid);
217extern void vlan_vid_del(struct net_device *dev, __be16 proto, u16 vid);
Jiri Pirko87002b02011-12-08 04:11:17 +0000218
Jiri Pirko348a1442011-12-08 04:11:19 +0000219extern int vlan_vids_add_by_dev(struct net_device *dev,
220 const struct net_device *by_dev);
221extern void vlan_vids_del_by_dev(struct net_device *dev,
222 const struct net_device *by_dev);
Jiri Pirko9b361c12012-08-23 03:26:52 +0000223
224extern bool vlan_uses_dev(const struct net_device *dev);
Vlad Yaseviche1618d42014-05-20 10:59:26 -0400225
226static inline int vlan_get_encap_level(struct net_device *dev)
227{
228 BUG_ON(!is_vlan_dev(dev));
229 return vlan_dev_priv(dev)->nest_level;
230}
Patrick McHardy7750f402008-07-08 03:23:36 -0700231#else
Jiri Pirkocec9c132011-07-20 04:54:05 +0000232static inline struct net_device *
dingtianhongf06c7f9f2014-05-09 14:58:05 +0800233__vlan_find_dev_deep_rcu(struct net_device *real_dev,
Patrick McHardy9fae27b2013-04-20 23:51:41 +0000234 __be16 vlan_proto, u16 vlan_id)
Jiri Pirkocec9c132011-07-20 04:54:05 +0000235{
236 return NULL;
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}
Vlad Yaseviche1618d42014-05-20 10:59:26 -0400292static inline int vlan_get_encap_level(struct net_device *dev)
293{
294 BUG();
295 return 0;
296}
Patrick McHardy7750f402008-07-08 03:23:36 -0700297#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298
Eric Garverfe19c4f2016-09-07 12:56:58 -0400299/**
300 * eth_type_vlan - check for valid vlan ether type.
301 * @ethertype: ether type to check
302 *
303 * Returns true if the ether type is a vlan ether type.
304 */
305static inline bool eth_type_vlan(__be16 ethertype)
306{
307 switch (ethertype) {
308 case htons(ETH_P_8021Q):
309 case htons(ETH_P_8021AD):
310 return true;
311 default:
312 return false;
313 }
314}
315
Patrick McHardy86a9bad2013-04-19 02:04:30 +0000316static inline bool vlan_hw_offload_capable(netdev_features_t features,
317 __be16 proto)
318{
319 if (proto == htons(ETH_P_8021Q) && features & NETIF_F_HW_VLAN_CTAG_TX)
320 return true;
Patrick McHardy8ad227f2013-04-19 02:04:31 +0000321 if (proto == htons(ETH_P_8021AD) && features & NETIF_F_HW_VLAN_STAG_TX)
322 return true;
Patrick McHardy86a9bad2013-04-19 02:04:30 +0000323 return false;
324}
325
Patrick McHardy9bb85822008-07-08 03:24:44 -0700326/**
Toshiaki Makitacbe71282018-03-13 14:51:28 +0900327 * __vlan_insert_inner_tag - inner VLAN tag inserting
328 * @skb: skbuff to tag
329 * @vlan_proto: VLAN encapsulation protocol
330 * @vlan_tci: VLAN TCI to insert
331 * @mac_len: MAC header length including outer vlan headers
332 *
333 * 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 -0300334 * Returns error if skb_cow_head fails.
Toshiaki Makitacbe71282018-03-13 14:51:28 +0900335 *
336 * Does not change skb->protocol so this function can be used during receive.
337 */
338static inline int __vlan_insert_inner_tag(struct sk_buff *skb,
339 __be16 vlan_proto, u16 vlan_tci,
340 unsigned int mac_len)
341{
342 struct vlan_ethhdr *veth;
343
344 if (skb_cow_head(skb, VLAN_HLEN) < 0)
345 return -ENOMEM;
346
347 skb_push(skb, VLAN_HLEN);
348
349 /* Move the mac header sans proto to the beginning of the new header. */
Toshiaki Makitac769acc2018-03-29 19:05:30 +0900350 if (likely(mac_len > ETH_TLEN))
351 memmove(skb->data, skb->data + VLAN_HLEN, mac_len - ETH_TLEN);
Toshiaki Makitacbe71282018-03-13 14:51:28 +0900352 skb->mac_header -= VLAN_HLEN;
353
354 veth = (struct vlan_ethhdr *)(skb->data + mac_len - ETH_HLEN);
355
356 /* first, the ethernet type */
Toshiaki Makitac769acc2018-03-29 19:05:30 +0900357 if (likely(mac_len >= ETH_TLEN)) {
358 /* h_vlan_encapsulated_proto should already be populated, and
359 * skb->data has space for h_vlan_proto
360 */
361 veth->h_vlan_proto = vlan_proto;
362 } else {
363 /* h_vlan_encapsulated_proto should not be populated, and
364 * skb->data has no space for h_vlan_proto
365 */
366 veth->h_vlan_encapsulated_proto = skb->protocol;
367 }
Toshiaki Makitacbe71282018-03-13 14:51:28 +0900368
369 /* now, the TCI */
370 veth->h_vlan_TCI = htons(vlan_tci);
371
372 return 0;
373}
374
375/**
Jiri Pirko15255a42014-11-19 14:05:00 +0100376 * __vlan_insert_tag - regular VLAN tag inserting
377 * @skb: skbuff to tag
378 * @vlan_proto: VLAN encapsulation protocol
379 * @vlan_tci: VLAN TCI to insert
380 *
381 * Inserts the VLAN tag into @skb as part of the payload
Thadeu Lima de Souza Cascardo8051ac72018-05-31 09:20:20 -0300382 * Returns error if skb_cow_head fails.
Jiri Pirko15255a42014-11-19 14:05:00 +0100383 *
384 * Does not change skb->protocol so this function can be used during receive.
385 */
386static inline int __vlan_insert_tag(struct sk_buff *skb,
387 __be16 vlan_proto, u16 vlan_tci)
388{
Toshiaki Makitacbe71282018-03-13 14:51:28 +0900389 return __vlan_insert_inner_tag(skb, vlan_proto, vlan_tci, ETH_HLEN);
390}
Jiri Pirko15255a42014-11-19 14:05:00 +0100391
Toshiaki Makitacbe71282018-03-13 14:51:28 +0900392/**
393 * vlan_insert_inner_tag - inner VLAN tag inserting
394 * @skb: skbuff to tag
395 * @vlan_proto: VLAN encapsulation protocol
396 * @vlan_tci: VLAN TCI to insert
397 * @mac_len: MAC header length including outer vlan headers
398 *
399 * Inserts the VLAN tag into @skb as part of the payload at offset mac_len
400 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
401 *
402 * Following the skb_unshare() example, in case of error, the calling function
403 * doesn't have to worry about freeing the original skb.
404 *
405 * Does not change skb->protocol so this function can be used during receive.
406 */
407static inline struct sk_buff *vlan_insert_inner_tag(struct sk_buff *skb,
408 __be16 vlan_proto,
409 u16 vlan_tci,
410 unsigned int mac_len)
411{
412 int err;
Jiri Pirko15255a42014-11-19 14:05:00 +0100413
Toshiaki Makitacbe71282018-03-13 14:51:28 +0900414 err = __vlan_insert_inner_tag(skb, vlan_proto, vlan_tci, mac_len);
415 if (err) {
416 dev_kfree_skb_any(skb);
417 return NULL;
418 }
419 return skb;
Jiri Pirko15255a42014-11-19 14:05:00 +0100420}
421
422/**
Jiri Pirko0b5c9db2011-06-10 06:56:58 +0000423 * vlan_insert_tag - regular VLAN tag inserting
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 * @skb: skbuff to tag
Patrick McHardy86a9bad2013-04-19 02:04:30 +0000425 * @vlan_proto: VLAN encapsulation protocol
Patrick McHardy9bb85822008-07-08 03:24:44 -0700426 * @vlan_tci: VLAN TCI to insert
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 *
428 * Inserts the VLAN tag into @skb as part of the payload
429 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
Patrick McHardy9bb85822008-07-08 03:24:44 -0700430 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 * Following the skb_unshare() example, in case of error, the calling function
432 * doesn't have to worry about freeing the original skb.
Jiri Pirko0b5c9db2011-06-10 06:56:58 +0000433 *
434 * Does not change skb->protocol so this function can be used during receive.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 */
Patrick McHardy86a9bad2013-04-19 02:04:30 +0000436static inline struct sk_buff *vlan_insert_tag(struct sk_buff *skb,
437 __be16 vlan_proto, u16 vlan_tci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438{
Toshiaki Makitacbe71282018-03-13 14:51:28 +0900439 return vlan_insert_inner_tag(skb, vlan_proto, vlan_tci, ETH_HLEN);
Jiri Pirko0b5c9db2011-06-10 06:56:58 +0000440}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441
Jiri Pirko0b5c9db2011-06-10 06:56:58 +0000442/**
Jiri Pirko62749e22014-11-19 14:04:58 +0100443 * vlan_insert_tag_set_proto - regular VLAN tag inserting
Jiri Pirko0b5c9db2011-06-10 06:56:58 +0000444 * @skb: skbuff to tag
Jiri Pirko62749e22014-11-19 14:04:58 +0100445 * @vlan_proto: VLAN encapsulation protocol
Jiri Pirko0b5c9db2011-06-10 06:56:58 +0000446 * @vlan_tci: VLAN TCI to insert
447 *
448 * Inserts the VLAN tag into @skb as part of the payload
449 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
450 *
451 * Following the skb_unshare() example, in case of error, the calling function
452 * doesn't have to worry about freeing the original skb.
453 */
Jiri Pirko62749e22014-11-19 14:04:58 +0100454static inline struct sk_buff *vlan_insert_tag_set_proto(struct sk_buff *skb,
455 __be16 vlan_proto,
456 u16 vlan_tci)
Jiri Pirko0b5c9db2011-06-10 06:56:58 +0000457{
Patrick McHardy86a9bad2013-04-19 02:04:30 +0000458 skb = vlan_insert_tag(skb, vlan_proto, vlan_tci);
Jiri Pirko0b5c9db2011-06-10 06:56:58 +0000459 if (skb)
Patrick McHardy86a9bad2013-04-19 02:04:30 +0000460 skb->protocol = vlan_proto;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 return skb;
462}
463
Michał Mirosławc8accd52018-11-07 18:07:02 +0100464/**
465 * __vlan_hwaccel_clear_tag - clear hardware accelerated VLAN info
466 * @skb: skbuff to clear
467 *
468 * Clears the VLAN information from @skb
469 */
470static inline void __vlan_hwaccel_clear_tag(struct sk_buff *skb)
471{
472 skb->vlan_tci = 0;
473}
474
Michał Mirosławe0a6b802018-11-07 18:07:02 +0100475/**
476 * __vlan_hwaccel_copy_tag - copy hardware accelerated VLAN info from another skb
477 * @dst: skbuff to copy to
478 * @src: skbuff to copy from
479 *
480 * Copies VLAN information from @src to @dst (for branchless code)
481 */
482static inline void __vlan_hwaccel_copy_tag(struct sk_buff *dst, const struct sk_buff *src)
483{
484 dst->vlan_proto = src->vlan_proto;
485 dst->vlan_tci = src->vlan_tci;
486}
487
Jiri Pirko59682502014-11-19 14:04:59 +0100488/*
489 * __vlan_hwaccel_push_inside - pushes vlan tag to the payload
490 * @skb: skbuff to tag
491 *
492 * Pushes the VLAN tag from @skb->vlan_tci inside to the payload.
493 *
494 * Following the skb_unshare() example, in case of error, the calling function
495 * doesn't have to worry about freeing the original skb.
496 */
497static inline struct sk_buff *__vlan_hwaccel_push_inside(struct sk_buff *skb)
498{
499 skb = vlan_insert_tag_set_proto(skb, skb->vlan_proto,
Jiri Pirkodf8a39d2015-01-13 17:13:44 +0100500 skb_vlan_tag_get(skb));
Jiri Pirko59682502014-11-19 14:04:59 +0100501 if (likely(skb))
Michał Mirosławc8accd52018-11-07 18:07:02 +0100502 __vlan_hwaccel_clear_tag(skb);
Jiri Pirko59682502014-11-19 14:04:59 +0100503 return skb;
504}
Jiri Pirko59682502014-11-19 14:04:59 +0100505
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506/**
507 * __vlan_hwaccel_put_tag - hardware accelerated VLAN inserting
508 * @skb: skbuff to tag
Patrick McHardy86a9bad2013-04-19 02:04:30 +0000509 * @vlan_proto: VLAN encapsulation protocol
Patrick McHardy9bb85822008-07-08 03:24:44 -0700510 * @vlan_tci: VLAN TCI to insert
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 *
Patrick McHardy6aa895b2008-07-14 22:49:06 -0700512 * Puts the VLAN TCI in @skb->vlan_tci and lets the device do the rest
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 */
Jiri Pirkob960a0ac2014-11-19 14:04:56 +0100514static inline void __vlan_hwaccel_put_tag(struct sk_buff *skb,
515 __be16 vlan_proto, u16 vlan_tci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516{
Patrick McHardy86a9bad2013-04-19 02:04:30 +0000517 skb->vlan_proto = vlan_proto;
Eric Dumazet05423b22009-10-26 18:40:35 -0700518 skb->vlan_tci = VLAN_TAG_PRESENT | vlan_tci;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519}
520
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522 * __vlan_get_tag - get the VLAN ID that is part of the payload
523 * @skb: skbuff to query
Vivien Didelotf4fb8742015-05-27 21:07:26 -0400524 * @vlan_tci: buffer to store value
Patrick McHardy9bb85822008-07-08 03:24:44 -0700525 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 * Returns error if the skb is not of VLAN type
527 */
Patrick McHardy9bb85822008-07-08 03:24:44 -0700528static inline int __vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529{
530 struct vlan_ethhdr *veth = (struct vlan_ethhdr *)skb->data;
531
Eric Garverfe19c4f2016-09-07 12:56:58 -0400532 if (!eth_type_vlan(veth->h_vlan_proto))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534
Patrick McHardy9bb85822008-07-08 03:24:44 -0700535 *vlan_tci = ntohs(veth->h_vlan_TCI);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 return 0;
537}
538
539/**
540 * __vlan_hwaccel_get_tag - get the VLAN ID that is in @skb->cb[]
541 * @skb: skbuff to query
Vivien Didelotf4fb8742015-05-27 21:07:26 -0400542 * @vlan_tci: buffer to store value
Patrick McHardy9bb85822008-07-08 03:24:44 -0700543 *
Patrick McHardy6aa895b2008-07-14 22:49:06 -0700544 * Returns error if @skb->vlan_tci is not set correctly
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 */
Patrick McHardy18149932008-02-05 16:20:22 -0800546static inline int __vlan_hwaccel_get_tag(const struct sk_buff *skb,
Patrick McHardy9bb85822008-07-08 03:24:44 -0700547 u16 *vlan_tci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548{
Jiri Pirkodf8a39d2015-01-13 17:13:44 +0100549 if (skb_vlan_tag_present(skb)) {
550 *vlan_tci = skb_vlan_tag_get(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 return 0;
552 } else {
Patrick McHardy9bb85822008-07-08 03:24:44 -0700553 *vlan_tci = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 return -EINVAL;
555 }
556}
557
558#define HAVE_VLAN_GET_TAG
559
560/**
561 * vlan_get_tag - get the VLAN ID from the skb
562 * @skb: skbuff to query
Vivien Didelotf4fb8742015-05-27 21:07:26 -0400563 * @vlan_tci: buffer to store value
Patrick McHardy9bb85822008-07-08 03:24:44 -0700564 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 * Returns error if the skb is not VLAN tagged
566 */
Patrick McHardy9bb85822008-07-08 03:24:44 -0700567static inline int vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568{
Patrick McHardyf6469682013-04-19 02:04:27 +0000569 if (skb->dev->features & NETIF_F_HW_VLAN_CTAG_TX) {
Patrick McHardy9bb85822008-07-08 03:24:44 -0700570 return __vlan_hwaccel_get_tag(skb, vlan_tci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 } else {
Patrick McHardy9bb85822008-07-08 03:24:44 -0700572 return __vlan_get_tag(skb, vlan_tci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 }
574}
575
Hao Zheng0a85df02010-11-11 13:47:57 +0000576/**
577 * vlan_get_protocol - get protocol EtherType.
578 * @skb: skbuff to query
Toshiaki Makitad4bcef32015-01-29 20:37:07 +0900579 * @type: first vlan protocol
580 * @depth: buffer to store length of eth and vlan tags in bytes
Hao Zheng0a85df02010-11-11 13:47:57 +0000581 *
582 * Returns the EtherType of the packet, regardless of whether it is
583 * vlan encapsulated (normal or hardware accelerated) or not.
584 */
Toshiaki Makitad4bcef32015-01-29 20:37:07 +0900585static inline __be16 __vlan_get_protocol(struct sk_buff *skb, __be16 type,
586 int *depth)
Hao Zheng0a85df02010-11-11 13:47:57 +0000587{
Toshiaki Makitad4bcef32015-01-29 20:37:07 +0900588 unsigned int vlan_depth = skb->mac_len;
Hao Zheng0a85df02010-11-11 13:47:57 +0000589
Toshiaki Makitad4bcef32015-01-29 20:37:07 +0900590 /* if type is 802.1Q/AD then the header should already be
591 * present at mac_len - VLAN_HLEN (if mac_len > 0), or at
592 * ETH_HLEN otherwise
593 */
Eric Garverfe19c4f2016-09-07 12:56:58 -0400594 if (eth_type_vlan(type)) {
Toshiaki Makitad4bcef32015-01-29 20:37:07 +0900595 if (vlan_depth) {
596 if (WARN_ON(vlan_depth < VLAN_HLEN))
597 return 0;
598 vlan_depth -= VLAN_HLEN;
599 } else {
600 vlan_depth = ETH_HLEN;
601 }
602 do {
603 struct vlan_hdr *vh;
604
605 if (unlikely(!pskb_may_pull(skb,
606 vlan_depth + VLAN_HLEN)))
607 return 0;
608
609 vh = (struct vlan_hdr *)(skb->data + vlan_depth);
610 type = vh->h_vlan_encapsulated_proto;
611 vlan_depth += VLAN_HLEN;
Eric Garverfe19c4f2016-09-07 12:56:58 -0400612 } while (eth_type_vlan(type));
Hao Zheng0a85df02010-11-11 13:47:57 +0000613 }
614
Toshiaki Makitad4bcef32015-01-29 20:37:07 +0900615 if (depth)
616 *depth = vlan_depth;
617
618 return type;
619}
620
621/**
622 * vlan_get_protocol - get protocol EtherType.
623 * @skb: skbuff to query
624 *
625 * Returns the EtherType of the packet, regardless of whether it is
626 * vlan encapsulated (normal or hardware accelerated) or not.
627 */
628static inline __be16 vlan_get_protocol(struct sk_buff *skb)
629{
630 return __vlan_get_protocol(skb, skb->protocol, NULL);
Hao Zheng0a85df02010-11-11 13:47:57 +0000631}
Pravin B Shelar396cf942011-11-18 13:15:54 -0800632
633static inline void vlan_set_encap_proto(struct sk_buff *skb,
634 struct vlan_hdr *vhdr)
635{
636 __be16 proto;
Cong Wangda8c8722013-02-21 23:32:27 +0000637 unsigned short *rawp;
Pravin B Shelar396cf942011-11-18 13:15:54 -0800638
639 /*
640 * Was a VLAN packet, grab the encapsulated protocol, which the layer
641 * three protocols care about.
642 */
643
644 proto = vhdr->h_vlan_encapsulated_proto;
Alexander Duyck9545b222015-05-04 14:34:10 -0700645 if (eth_proto_is_802_3(proto)) {
Pravin B Shelar396cf942011-11-18 13:15:54 -0800646 skb->protocol = proto;
647 return;
648 }
649
Cong Wangda8c8722013-02-21 23:32:27 +0000650 rawp = (unsigned short *)(vhdr + 1);
651 if (*rawp == 0xFFFF)
Pravin B Shelar396cf942011-11-18 13:15:54 -0800652 /*
653 * This is a magic hack to spot IPX packets. Older Novell
654 * breaks the protocol design and runs IPX over 802.3 without
655 * an 802.2 LLC layer. We look for FFFF which isn't a used
656 * 802.2 SSAP/DSAP. This won't work for fault tolerant netware
657 * but does for the rest.
658 */
659 skb->protocol = htons(ETH_P_802_3);
660 else
661 /*
662 * Real 802.2 LLC
663 */
664 skb->protocol = htons(ETH_P_802_2);
665}
Vlad Yasevich44a40852014-05-16 17:20:38 -0400666
Toshiaki Makitaf5a7fb82015-03-27 14:31:11 +0900667/**
668 * skb_vlan_tagged - check if skb is vlan tagged.
669 * @skb: skbuff to query
670 *
671 * Returns true if the skb is tagged, regardless of whether it is hardware
672 * accelerated or not.
673 */
674static inline bool skb_vlan_tagged(const struct sk_buff *skb)
675{
676 if (!skb_vlan_tag_present(skb) &&
Eric Garverfe19c4f2016-09-07 12:56:58 -0400677 likely(!eth_type_vlan(skb->protocol)))
Toshiaki Makitaf5a7fb82015-03-27 14:31:11 +0900678 return false;
679
680 return true;
681}
682
683/**
684 * skb_vlan_tagged_multi - check if skb is vlan tagged with multiple headers.
685 * @skb: skbuff to query
686 *
687 * Returns true if the skb is tagged with multiple vlan headers, regardless
688 * of whether it is hardware accelerated or not.
689 */
Toshiaki Makita7ce23672018-04-17 18:46:14 +0900690static inline bool skb_vlan_tagged_multi(struct sk_buff *skb)
Toshiaki Makitaf5a7fb82015-03-27 14:31:11 +0900691{
692 __be16 protocol = skb->protocol;
693
694 if (!skb_vlan_tag_present(skb)) {
695 struct vlan_ethhdr *veh;
696
Eric Garverfe19c4f2016-09-07 12:56:58 -0400697 if (likely(!eth_type_vlan(protocol)))
Toshiaki Makitaf5a7fb82015-03-27 14:31:11 +0900698 return false;
699
Toshiaki Makita7ce23672018-04-17 18:46:14 +0900700 if (unlikely(!pskb_may_pull(skb, VLAN_ETH_HLEN)))
701 return false;
702
Toshiaki Makitaf5a7fb82015-03-27 14:31:11 +0900703 veh = (struct vlan_ethhdr *)skb->data;
704 protocol = veh->h_vlan_encapsulated_proto;
705 }
706
Eric Garverfe19c4f2016-09-07 12:56:58 -0400707 if (!eth_type_vlan(protocol))
Toshiaki Makitaf5a7fb82015-03-27 14:31:11 +0900708 return false;
709
710 return true;
711}
712
Toshiaki Makita8cb65d02015-03-27 14:31:12 +0900713/**
714 * vlan_features_check - drop unsafe features for skb with multiple tags.
715 * @skb: skbuff to query
716 * @features: features to be checked
717 *
718 * Returns features without unsafe ones if the skb has multiple tags.
719 */
Toshiaki Makita7ce23672018-04-17 18:46:14 +0900720static inline netdev_features_t vlan_features_check(struct sk_buff *skb,
Toshiaki Makita8cb65d02015-03-27 14:31:12 +0900721 netdev_features_t features)
722{
Vlad Yasevich35d2f802017-05-23 13:38:41 -0400723 if (skb_vlan_tagged_multi(skb)) {
724 /* In the case of multi-tagged packets, use a direct mask
725 * instead of using netdev_interesect_features(), to make
726 * sure that only devices supporting NETIF_F_HW_CSUM will
727 * have checksum offloading support.
728 */
729 features &= NETIF_F_SG | NETIF_F_HIGHDMA | NETIF_F_HW_CSUM |
730 NETIF_F_FRAGLIST | NETIF_F_HW_VLAN_CTAG_TX |
731 NETIF_F_HW_VLAN_STAG_TX;
732 }
Toshiaki Makita8cb65d02015-03-27 14:31:12 +0900733
734 return features;
735}
736
Toshiaki Makita66e51332015-06-01 21:55:06 +0900737/**
738 * compare_vlan_header - Compare two vlan headers
739 * @h1: Pointer to vlan header
740 * @h2: Pointer to vlan header
741 *
742 * Compare two vlan headers, returns 0 if equal.
743 *
744 * Please note that alignment of h1 & h2 are only guaranteed to be 16 bits.
745 */
746static inline unsigned long compare_vlan_header(const struct vlan_hdr *h1,
747 const struct vlan_hdr *h2)
748{
749#if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
750 return *(u32 *)h1 ^ *(u32 *)h2;
751#else
752 return ((__force u32)h1->h_vlan_TCI ^ (__force u32)h2->h_vlan_TCI) |
753 ((__force u32)h1->h_vlan_encapsulated_proto ^
754 (__force u32)h2->h_vlan_encapsulated_proto);
755#endif
756}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757#endif /* !(_LINUX_IF_VLAN_H_) */