2 * VLAN An implementation of 802.1Q VLAN tagging.
4 * Authors: Ben Greear <greearb@candelatech.com>
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.
12 #ifndef _LINUX_IF_VLAN_H_
13 #define _LINUX_IF_VLAN_H_
15 #include <linux/netdevice.h>
16 #include <linux/etherdevice.h>
17 #include <linux/rtnetlink.h>
18 #include <linux/bug.h>
19 #include <uapi/linux/if_vlan.h>
21 #define VLAN_HLEN 4 /* The additional bytes required by VLAN
22 * (in addition to the Ethernet header)
24 #define VLAN_ETH_HLEN 18 /* Total octets in header. */
25 #define VLAN_ETH_ZLEN 64 /* Min. octets in frame sans FCS */
28 * According to 802.3ac, the packet can be 4 bytes longer. --Klika Jan
30 #define VLAN_ETH_DATA_LEN 1500 /* Max. octets in payload */
31 #define VLAN_ETH_FRAME_LEN 1518 /* Max. octets in frame sans FCS */
33 #define VLAN_MAX_DEPTH 8 /* Max. number of nested VLAN tags parsed */
36 * struct vlan_hdr - vlan header
37 * @h_vlan_TCI: priority and VLAN ID
38 * @h_vlan_encapsulated_proto: packet type ID or len
42 __be16 h_vlan_encapsulated_proto;
46 * struct vlan_ethhdr - vlan ethernet header (ethhdr + vlan_hdr)
47 * @h_dest: destination ethernet address
48 * @h_source: source ethernet address
49 * @h_vlan_proto: ethernet protocol
50 * @h_vlan_TCI: priority and VLAN ID
51 * @h_vlan_encapsulated_proto: packet type ID or len
54 unsigned char h_dest[ETH_ALEN];
55 unsigned char h_source[ETH_ALEN];
58 __be16 h_vlan_encapsulated_proto;
61 #include <linux/skbuff.h>
63 static inline struct vlan_ethhdr *vlan_eth_hdr(const struct sk_buff *skb)
65 return (struct vlan_ethhdr *)skb_mac_header(skb);
68 #define VLAN_PRIO_MASK 0xe000 /* Priority Code Point */
69 #define VLAN_PRIO_SHIFT 13
70 #define VLAN_CFI_MASK 0x1000 /* Canonical Format Indicator */
71 #define VLAN_TAG_PRESENT VLAN_CFI_MASK
72 #define VLAN_VID_MASK 0x0fff /* VLAN Identifier */
73 #define VLAN_N_VID 4096
75 /* found in socket.c */
76 extern void vlan_ioctl_set(int (*hook)(struct net *, void __user *));
78 static inline bool is_vlan_dev(const struct net_device *dev)
80 return dev->priv_flags & IFF_802_1Q_VLAN;
83 #define skb_vlan_tag_present(__skb) ((__skb)->vlan_tci & VLAN_TAG_PRESENT)
84 #define skb_vlan_tag_get(__skb) ((__skb)->vlan_tci & ~VLAN_TAG_PRESENT)
85 #define skb_vlan_tag_get_id(__skb) ((__skb)->vlan_tci & VLAN_VID_MASK)
86 #define skb_vlan_tag_get_prio(__skb) ((__skb)->vlan_tci & VLAN_PRIO_MASK)
89 * struct vlan_pcpu_stats - VLAN percpu rx/tx stats
90 * @rx_packets: number of received packets
91 * @rx_bytes: number of received bytes
92 * @rx_multicast: number of received multicast packets
93 * @tx_packets: number of transmitted packets
94 * @tx_bytes: number of transmitted bytes
95 * @syncp: synchronization point for 64bit counters
96 * @rx_errors: number of rx errors
97 * @tx_dropped: number of tx drops
99 struct vlan_pcpu_stats {
105 struct u64_stats_sync syncp;
110 #if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
112 extern struct net_device *__vlan_find_dev_deep_rcu(struct net_device *real_dev,
113 __be16 vlan_proto, u16 vlan_id);
114 extern struct net_device *vlan_dev_real_dev(const struct net_device *dev);
115 extern u16 vlan_dev_vlan_id(const struct net_device *dev);
116 extern __be16 vlan_dev_vlan_proto(const struct net_device *dev);
119 * struct vlan_priority_tci_mapping - vlan egress priority mappings
120 * @priority: skb priority
121 * @vlan_qos: vlan priority: (skb->priority << 13) & 0xE000
122 * @next: pointer to next struct
124 struct vlan_priority_tci_mapping {
127 struct vlan_priority_tci_mapping *next;
130 struct proc_dir_entry;
134 * struct vlan_dev_priv - VLAN private device data
135 * @nr_ingress_mappings: number of ingress priority mappings
136 * @ingress_priority_map: ingress priority mappings
137 * @nr_egress_mappings: number of egress priority mappings
138 * @egress_priority_map: hash of egress priority mappings
139 * @vlan_proto: VLAN encapsulation protocol
140 * @vlan_id: VLAN identifier
141 * @flags: device flags
142 * @real_dev: underlying netdevice
143 * @real_dev_addr: address of underlying netdevice
144 * @dent: proc dir entry
145 * @vlan_pcpu_stats: ptr to percpu rx stats
147 struct vlan_dev_priv {
148 unsigned int nr_ingress_mappings;
149 u32 ingress_priority_map[8];
150 unsigned int nr_egress_mappings;
151 struct vlan_priority_tci_mapping *egress_priority_map[16];
157 struct net_device *real_dev;
158 unsigned char real_dev_addr[ETH_ALEN];
160 struct proc_dir_entry *dent;
161 struct vlan_pcpu_stats __percpu *vlan_pcpu_stats;
162 #ifdef CONFIG_NET_POLL_CONTROLLER
163 struct netpoll *netpoll;
165 unsigned int nest_level;
168 static inline struct vlan_dev_priv *vlan_dev_priv(const struct net_device *dev)
170 return netdev_priv(dev);
174 vlan_dev_get_egress_qos_mask(struct net_device *dev, u32 skprio)
176 struct vlan_priority_tci_mapping *mp;
178 smp_rmb(); /* coupled with smp_wmb() in vlan_dev_set_egress_priority() */
180 mp = vlan_dev_priv(dev)->egress_priority_map[(skprio & 0xF)];
182 if (mp->priority == skprio) {
183 return mp->vlan_qos; /* This should already be shifted
184 * to mask correctly with the
192 extern bool vlan_do_receive(struct sk_buff **skb);
194 extern int vlan_vid_add(struct net_device *dev, __be16 proto, u16 vid);
195 extern void vlan_vid_del(struct net_device *dev, __be16 proto, u16 vid);
197 extern int vlan_vids_add_by_dev(struct net_device *dev,
198 const struct net_device *by_dev);
199 extern void vlan_vids_del_by_dev(struct net_device *dev,
200 const struct net_device *by_dev);
202 extern bool vlan_uses_dev(const struct net_device *dev);
204 static inline int vlan_get_encap_level(struct net_device *dev)
206 BUG_ON(!is_vlan_dev(dev));
207 return vlan_dev_priv(dev)->nest_level;
210 static inline struct net_device *
211 __vlan_find_dev_deep_rcu(struct net_device *real_dev,
212 __be16 vlan_proto, u16 vlan_id)
217 static inline struct net_device *vlan_dev_real_dev(const struct net_device *dev)
223 static inline u16 vlan_dev_vlan_id(const struct net_device *dev)
229 static inline __be16 vlan_dev_vlan_proto(const struct net_device *dev)
235 static inline u16 vlan_dev_get_egress_qos_mask(struct net_device *dev,
241 static inline bool vlan_do_receive(struct sk_buff **skb)
246 static inline int vlan_vid_add(struct net_device *dev, __be16 proto, u16 vid)
251 static inline void vlan_vid_del(struct net_device *dev, __be16 proto, u16 vid)
255 static inline int vlan_vids_add_by_dev(struct net_device *dev,
256 const struct net_device *by_dev)
261 static inline void vlan_vids_del_by_dev(struct net_device *dev,
262 const struct net_device *by_dev)
266 static inline bool vlan_uses_dev(const struct net_device *dev)
270 static inline int vlan_get_encap_level(struct net_device *dev)
278 * eth_type_vlan - check for valid vlan ether type.
279 * @ethertype: ether type to check
281 * Returns true if the ether type is a vlan ether type.
283 static inline bool eth_type_vlan(__be16 ethertype)
286 case htons(ETH_P_8021Q):
287 case htons(ETH_P_8021AD):
294 static inline bool vlan_hw_offload_capable(netdev_features_t features,
297 if (proto == htons(ETH_P_8021Q) && features & NETIF_F_HW_VLAN_CTAG_TX)
299 if (proto == htons(ETH_P_8021AD) && features & NETIF_F_HW_VLAN_STAG_TX)
305 * __vlan_insert_inner_tag - inner VLAN tag inserting
306 * @skb: skbuff to tag
307 * @vlan_proto: VLAN encapsulation protocol
308 * @vlan_tci: VLAN TCI to insert
309 * @mac_len: MAC header length including outer vlan headers
311 * Inserts the VLAN tag into @skb as part of the payload at offset mac_len
312 * Returns error if skb_cow_head failes.
314 * Does not change skb->protocol so this function can be used during receive.
316 static inline int __vlan_insert_inner_tag(struct sk_buff *skb,
317 __be16 vlan_proto, u16 vlan_tci,
318 unsigned int mac_len)
320 struct vlan_ethhdr *veth;
322 if (skb_cow_head(skb, VLAN_HLEN) < 0)
325 skb_push(skb, VLAN_HLEN);
327 /* Move the mac header sans proto to the beginning of the new header. */
328 if (likely(mac_len > ETH_TLEN))
329 memmove(skb->data, skb->data + VLAN_HLEN, mac_len - ETH_TLEN);
330 skb->mac_header -= VLAN_HLEN;
332 veth = (struct vlan_ethhdr *)(skb->data + mac_len - ETH_HLEN);
334 /* first, the ethernet type */
335 if (likely(mac_len >= ETH_TLEN)) {
336 /* h_vlan_encapsulated_proto should already be populated, and
337 * skb->data has space for h_vlan_proto
339 veth->h_vlan_proto = vlan_proto;
341 /* h_vlan_encapsulated_proto should not be populated, and
342 * skb->data has no space for h_vlan_proto
344 veth->h_vlan_encapsulated_proto = skb->protocol;
348 veth->h_vlan_TCI = htons(vlan_tci);
354 * __vlan_insert_tag - regular VLAN tag inserting
355 * @skb: skbuff to tag
356 * @vlan_proto: VLAN encapsulation protocol
357 * @vlan_tci: VLAN TCI to insert
359 * Inserts the VLAN tag into @skb as part of the payload
360 * Returns error if skb_cow_head failes.
362 * Does not change skb->protocol so this function can be used during receive.
364 static inline int __vlan_insert_tag(struct sk_buff *skb,
365 __be16 vlan_proto, u16 vlan_tci)
367 return __vlan_insert_inner_tag(skb, vlan_proto, vlan_tci, ETH_HLEN);
371 * vlan_insert_inner_tag - inner VLAN tag inserting
372 * @skb: skbuff to tag
373 * @vlan_proto: VLAN encapsulation protocol
374 * @vlan_tci: VLAN TCI to insert
375 * @mac_len: MAC header length including outer vlan headers
377 * Inserts the VLAN tag into @skb as part of the payload at offset mac_len
378 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
380 * Following the skb_unshare() example, in case of error, the calling function
381 * doesn't have to worry about freeing the original skb.
383 * Does not change skb->protocol so this function can be used during receive.
385 static inline struct sk_buff *vlan_insert_inner_tag(struct sk_buff *skb,
388 unsigned int mac_len)
392 err = __vlan_insert_inner_tag(skb, vlan_proto, vlan_tci, mac_len);
394 dev_kfree_skb_any(skb);
401 * vlan_insert_tag - regular VLAN tag inserting
402 * @skb: skbuff to tag
403 * @vlan_proto: VLAN encapsulation protocol
404 * @vlan_tci: VLAN TCI to insert
406 * Inserts the VLAN tag into @skb as part of the payload
407 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
409 * Following the skb_unshare() example, in case of error, the calling function
410 * doesn't have to worry about freeing the original skb.
412 * Does not change skb->protocol so this function can be used during receive.
414 static inline struct sk_buff *vlan_insert_tag(struct sk_buff *skb,
415 __be16 vlan_proto, u16 vlan_tci)
417 return vlan_insert_inner_tag(skb, vlan_proto, vlan_tci, ETH_HLEN);
421 * vlan_insert_tag_set_proto - regular VLAN tag inserting
422 * @skb: skbuff to tag
423 * @vlan_proto: VLAN encapsulation protocol
424 * @vlan_tci: VLAN TCI to insert
426 * Inserts the VLAN tag into @skb as part of the payload
427 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
429 * Following the skb_unshare() example, in case of error, the calling function
430 * doesn't have to worry about freeing the original skb.
432 static inline struct sk_buff *vlan_insert_tag_set_proto(struct sk_buff *skb,
436 skb = vlan_insert_tag(skb, vlan_proto, vlan_tci);
438 skb->protocol = vlan_proto;
443 * __vlan_hwaccel_push_inside - pushes vlan tag to the payload
444 * @skb: skbuff to tag
446 * Pushes the VLAN tag from @skb->vlan_tci inside to the payload.
448 * Following the skb_unshare() example, in case of error, the calling function
449 * doesn't have to worry about freeing the original skb.
451 static inline struct sk_buff *__vlan_hwaccel_push_inside(struct sk_buff *skb)
453 skb = vlan_insert_tag_set_proto(skb, skb->vlan_proto,
454 skb_vlan_tag_get(skb));
461 * __vlan_hwaccel_put_tag - hardware accelerated VLAN inserting
462 * @skb: skbuff to tag
463 * @vlan_proto: VLAN encapsulation protocol
464 * @vlan_tci: VLAN TCI to insert
466 * Puts the VLAN TCI in @skb->vlan_tci and lets the device do the rest
468 static inline void __vlan_hwaccel_put_tag(struct sk_buff *skb,
469 __be16 vlan_proto, u16 vlan_tci)
471 skb->vlan_proto = vlan_proto;
472 skb->vlan_tci = VLAN_TAG_PRESENT | vlan_tci;
476 * __vlan_get_tag - get the VLAN ID that is part of the payload
477 * @skb: skbuff to query
478 * @vlan_tci: buffer to store value
480 * Returns error if the skb is not of VLAN type
482 static inline int __vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
484 struct vlan_ethhdr *veth = (struct vlan_ethhdr *)skb->data;
486 if (!eth_type_vlan(veth->h_vlan_proto))
489 *vlan_tci = ntohs(veth->h_vlan_TCI);
494 * __vlan_hwaccel_get_tag - get the VLAN ID that is in @skb->cb[]
495 * @skb: skbuff to query
496 * @vlan_tci: buffer to store value
498 * Returns error if @skb->vlan_tci is not set correctly
500 static inline int __vlan_hwaccel_get_tag(const struct sk_buff *skb,
503 if (skb_vlan_tag_present(skb)) {
504 *vlan_tci = skb_vlan_tag_get(skb);
512 #define HAVE_VLAN_GET_TAG
515 * vlan_get_tag - get the VLAN ID from the skb
516 * @skb: skbuff to query
517 * @vlan_tci: buffer to store value
519 * Returns error if the skb is not VLAN tagged
521 static inline int vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
523 if (skb->dev->features & NETIF_F_HW_VLAN_CTAG_TX) {
524 return __vlan_hwaccel_get_tag(skb, vlan_tci);
526 return __vlan_get_tag(skb, vlan_tci);
531 * vlan_get_protocol - get protocol EtherType.
532 * @skb: skbuff to query
533 * @type: first vlan protocol
534 * @depth: buffer to store length of eth and vlan tags in bytes
536 * Returns the EtherType of the packet, regardless of whether it is
537 * vlan encapsulated (normal or hardware accelerated) or not.
539 static inline __be16 __vlan_get_protocol(const struct sk_buff *skb, __be16 type,
542 unsigned int vlan_depth = skb->mac_len, parse_depth = VLAN_MAX_DEPTH;
544 /* if type is 802.1Q/AD then the header should already be
545 * present at mac_len - VLAN_HLEN (if mac_len > 0), or at
548 if (eth_type_vlan(type)) {
550 if (WARN_ON(vlan_depth < VLAN_HLEN))
552 vlan_depth -= VLAN_HLEN;
554 vlan_depth = ETH_HLEN;
557 struct vlan_hdr vhdr, *vh;
559 vh = skb_header_pointer(skb, vlan_depth, sizeof(vhdr), &vhdr);
560 if (unlikely(!vh || !--parse_depth))
563 type = vh->h_vlan_encapsulated_proto;
564 vlan_depth += VLAN_HLEN;
565 } while (eth_type_vlan(type));
575 * vlan_get_protocol - get protocol EtherType.
576 * @skb: skbuff to query
578 * Returns the EtherType of the packet, regardless of whether it is
579 * vlan encapsulated (normal or hardware accelerated) or not.
581 static inline __be16 vlan_get_protocol(const struct sk_buff *skb)
583 return __vlan_get_protocol(skb, skb->protocol, NULL);
586 /* A getter for the SKB protocol field which will handle VLAN tags consistently
587 * whether VLAN acceleration is enabled or not.
589 static inline __be16 skb_protocol(const struct sk_buff *skb, bool skip_vlan)
592 /* VLAN acceleration strips the VLAN header from the skb and
593 * moves it to skb->vlan_proto
595 return skb_vlan_tag_present(skb) ? skb->vlan_proto : skb->protocol;
597 return vlan_get_protocol(skb);
600 static inline void vlan_set_encap_proto(struct sk_buff *skb,
601 struct vlan_hdr *vhdr)
604 unsigned short *rawp;
607 * Was a VLAN packet, grab the encapsulated protocol, which the layer
608 * three protocols care about.
611 proto = vhdr->h_vlan_encapsulated_proto;
612 if (eth_proto_is_802_3(proto)) {
613 skb->protocol = proto;
617 rawp = (unsigned short *)(vhdr + 1);
620 * This is a magic hack to spot IPX packets. Older Novell
621 * breaks the protocol design and runs IPX over 802.3 without
622 * an 802.2 LLC layer. We look for FFFF which isn't a used
623 * 802.2 SSAP/DSAP. This won't work for fault tolerant netware
624 * but does for the rest.
626 skb->protocol = htons(ETH_P_802_3);
631 skb->protocol = htons(ETH_P_802_2);
635 * skb_vlan_tagged - check if skb is vlan tagged.
636 * @skb: skbuff to query
638 * Returns true if the skb is tagged, regardless of whether it is hardware
639 * accelerated or not.
641 static inline bool skb_vlan_tagged(const struct sk_buff *skb)
643 if (!skb_vlan_tag_present(skb) &&
644 likely(!eth_type_vlan(skb->protocol)))
651 * skb_vlan_tagged_multi - check if skb is vlan tagged with multiple headers.
652 * @skb: skbuff to query
654 * Returns true if the skb is tagged with multiple vlan headers, regardless
655 * of whether it is hardware accelerated or not.
657 static inline bool skb_vlan_tagged_multi(struct sk_buff *skb)
659 __be16 protocol = skb->protocol;
661 if (!skb_vlan_tag_present(skb)) {
662 struct vlan_ethhdr *veh;
664 if (likely(!eth_type_vlan(protocol)))
667 if (unlikely(!pskb_may_pull(skb, VLAN_ETH_HLEN)))
670 veh = (struct vlan_ethhdr *)skb->data;
671 protocol = veh->h_vlan_encapsulated_proto;
674 if (!eth_type_vlan(protocol))
681 * vlan_features_check - drop unsafe features for skb with multiple tags.
682 * @skb: skbuff to query
683 * @features: features to be checked
685 * Returns features without unsafe ones if the skb has multiple tags.
687 static inline netdev_features_t vlan_features_check(struct sk_buff *skb,
688 netdev_features_t features)
690 if (skb_vlan_tagged_multi(skb)) {
691 /* In the case of multi-tagged packets, use a direct mask
692 * instead of using netdev_interesect_features(), to make
693 * sure that only devices supporting NETIF_F_HW_CSUM will
694 * have checksum offloading support.
696 features &= NETIF_F_SG | NETIF_F_HIGHDMA | NETIF_F_HW_CSUM |
697 NETIF_F_FRAGLIST | NETIF_F_HW_VLAN_CTAG_TX |
698 NETIF_F_HW_VLAN_STAG_TX;
705 * compare_vlan_header - Compare two vlan headers
706 * @h1: Pointer to vlan header
707 * @h2: Pointer to vlan header
709 * Compare two vlan headers, returns 0 if equal.
711 * Please note that alignment of h1 & h2 are only guaranteed to be 16 bits.
713 static inline unsigned long compare_vlan_header(const struct vlan_hdr *h1,
714 const struct vlan_hdr *h2)
716 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
717 return *(u32 *)h1 ^ *(u32 *)h2;
719 return ((__force u32)h1->h_vlan_TCI ^ (__force u32)h2->h_vlan_TCI) |
720 ((__force u32)h1->h_vlan_encapsulated_proto ^
721 (__force u32)h2->h_vlan_encapsulated_proto);
724 #endif /* !(_LINUX_IF_VLAN_H_) */