2 * VLAN An implementation of 802.1Q VLAN tagging.
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 */
34 * struct vlan_hdr - vlan header
35 * @h_vlan_TCI: priority and VLAN ID
36 * @h_vlan_encapsulated_proto: packet type ID or len
40 __be16 h_vlan_encapsulated_proto;
44 * struct vlan_ethhdr - vlan ethernet header (ethhdr + vlan_hdr)
45 * @h_dest: destination ethernet address
46 * @h_source: source ethernet address
47 * @h_vlan_proto: ethernet protocol
48 * @h_vlan_TCI: priority and VLAN ID
49 * @h_vlan_encapsulated_proto: packet type ID or len
52 unsigned char h_dest[ETH_ALEN];
53 unsigned char h_source[ETH_ALEN];
56 __be16 h_vlan_encapsulated_proto;
59 #include <linux/skbuff.h>
61 static inline struct vlan_ethhdr *vlan_eth_hdr(const struct sk_buff *skb)
63 return (struct vlan_ethhdr *)skb_mac_header(skb);
66 #define VLAN_PRIO_MASK 0xe000 /* Priority Code Point */
67 #define VLAN_PRIO_SHIFT 13
68 #define VLAN_CFI_MASK 0x1000 /* Canonical Format Indicator / Drop Eligible Indicator */
69 #define VLAN_VID_MASK 0x0fff /* VLAN Identifier */
70 #define VLAN_N_VID 4096
72 /* found in socket.c */
73 extern void vlan_ioctl_set(int (*hook)(struct net *, void __user *));
75 static inline bool is_vlan_dev(const struct net_device *dev)
77 return dev->priv_flags & IFF_802_1Q_VLAN;
80 #define skb_vlan_tag_present(__skb) ((__skb)->vlan_present)
81 #define skb_vlan_tag_get(__skb) ((__skb)->vlan_tci)
82 #define skb_vlan_tag_get_id(__skb) ((__skb)->vlan_tci & VLAN_VID_MASK)
83 #define skb_vlan_tag_get_cfi(__skb) (!!((__skb)->vlan_tci & VLAN_CFI_MASK))
84 #define skb_vlan_tag_get_prio(__skb) (((__skb)->vlan_tci & VLAN_PRIO_MASK) >> VLAN_PRIO_SHIFT)
86 static inline int vlan_get_rx_ctag_filter_info(struct net_device *dev)
89 return notifier_to_errno(call_netdevice_notifiers(NETDEV_CVLAN_FILTER_PUSH_INFO, dev));
92 static inline void vlan_drop_rx_ctag_filter_info(struct net_device *dev)
95 call_netdevice_notifiers(NETDEV_CVLAN_FILTER_DROP_INFO, dev);
98 static inline int vlan_get_rx_stag_filter_info(struct net_device *dev)
101 return notifier_to_errno(call_netdevice_notifiers(NETDEV_SVLAN_FILTER_PUSH_INFO, dev));
104 static inline void vlan_drop_rx_stag_filter_info(struct net_device *dev)
107 call_netdevice_notifiers(NETDEV_SVLAN_FILTER_DROP_INFO, dev);
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
121 struct vlan_pcpu_stats {
127 struct u64_stats_sync syncp;
132 #if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
134 extern struct net_device *__vlan_find_dev_deep_rcu(struct net_device *real_dev,
135 __be16 vlan_proto, u16 vlan_id);
136 extern int vlan_for_each(struct net_device *dev,
137 int (*action)(struct net_device *dev, int vid,
138 void *arg), void *arg);
139 extern struct net_device *vlan_dev_real_dev(const struct net_device *dev);
140 extern u16 vlan_dev_vlan_id(const struct net_device *dev);
141 extern __be16 vlan_dev_vlan_proto(const struct net_device *dev);
144 * struct vlan_priority_tci_mapping - vlan egress priority mappings
145 * @priority: skb priority
146 * @vlan_qos: vlan priority: (skb->priority << 13) & 0xE000
147 * @next: pointer to next struct
149 struct vlan_priority_tci_mapping {
152 struct vlan_priority_tci_mapping *next;
155 struct proc_dir_entry;
159 * struct vlan_dev_priv - VLAN private device data
160 * @nr_ingress_mappings: number of ingress priority mappings
161 * @ingress_priority_map: ingress priority mappings
162 * @nr_egress_mappings: number of egress priority mappings
163 * @egress_priority_map: hash of egress priority mappings
164 * @vlan_proto: VLAN encapsulation protocol
165 * @vlan_id: VLAN identifier
166 * @flags: device flags
167 * @real_dev: underlying netdevice
168 * @real_dev_addr: address of underlying netdevice
169 * @dent: proc dir entry
170 * @vlan_pcpu_stats: ptr to percpu rx stats
172 struct vlan_dev_priv {
173 unsigned int nr_ingress_mappings;
174 u32 ingress_priority_map[8];
175 unsigned int nr_egress_mappings;
176 struct vlan_priority_tci_mapping *egress_priority_map[16];
182 struct net_device *real_dev;
183 unsigned char real_dev_addr[ETH_ALEN];
185 struct proc_dir_entry *dent;
186 struct vlan_pcpu_stats __percpu *vlan_pcpu_stats;
187 #ifdef CONFIG_NET_POLL_CONTROLLER
188 struct netpoll *netpoll;
190 unsigned int nest_level;
193 static inline struct vlan_dev_priv *vlan_dev_priv(const struct net_device *dev)
195 return netdev_priv(dev);
199 vlan_dev_get_egress_qos_mask(struct net_device *dev, u32 skprio)
201 struct vlan_priority_tci_mapping *mp;
203 smp_rmb(); /* coupled with smp_wmb() in vlan_dev_set_egress_priority() */
205 mp = vlan_dev_priv(dev)->egress_priority_map[(skprio & 0xF)];
207 if (mp->priority == skprio) {
208 return mp->vlan_qos; /* This should already be shifted
209 * to mask correctly with the
217 extern bool vlan_do_receive(struct sk_buff **skb);
219 extern int vlan_vid_add(struct net_device *dev, __be16 proto, u16 vid);
220 extern void vlan_vid_del(struct net_device *dev, __be16 proto, u16 vid);
222 extern int vlan_vids_add_by_dev(struct net_device *dev,
223 const struct net_device *by_dev);
224 extern void vlan_vids_del_by_dev(struct net_device *dev,
225 const struct net_device *by_dev);
227 extern bool vlan_uses_dev(const struct net_device *dev);
229 static inline int vlan_get_encap_level(struct net_device *dev)
231 BUG_ON(!is_vlan_dev(dev));
232 return vlan_dev_priv(dev)->nest_level;
235 static inline struct net_device *
236 __vlan_find_dev_deep_rcu(struct net_device *real_dev,
237 __be16 vlan_proto, u16 vlan_id)
243 vlan_for_each(struct net_device *dev,
244 int (*action)(struct net_device *dev, int vid, void *arg),
250 static inline struct net_device *vlan_dev_real_dev(const struct net_device *dev)
256 static inline u16 vlan_dev_vlan_id(const struct net_device *dev)
262 static inline __be16 vlan_dev_vlan_proto(const struct net_device *dev)
268 static inline u16 vlan_dev_get_egress_qos_mask(struct net_device *dev,
274 static inline bool vlan_do_receive(struct sk_buff **skb)
279 static inline int vlan_vid_add(struct net_device *dev, __be16 proto, u16 vid)
284 static inline void vlan_vid_del(struct net_device *dev, __be16 proto, u16 vid)
288 static inline int vlan_vids_add_by_dev(struct net_device *dev,
289 const struct net_device *by_dev)
294 static inline void vlan_vids_del_by_dev(struct net_device *dev,
295 const struct net_device *by_dev)
299 static inline bool vlan_uses_dev(const struct net_device *dev)
303 static inline int vlan_get_encap_level(struct net_device *dev)
311 * eth_type_vlan - check for valid vlan ether type.
312 * @ethertype: ether type to check
314 * Returns true if the ether type is a vlan ether type.
316 static inline bool eth_type_vlan(__be16 ethertype)
319 case htons(ETH_P_8021Q):
320 case htons(ETH_P_8021AD):
327 static inline bool vlan_hw_offload_capable(netdev_features_t features,
330 if (proto == htons(ETH_P_8021Q) && features & NETIF_F_HW_VLAN_CTAG_TX)
332 if (proto == htons(ETH_P_8021AD) && features & NETIF_F_HW_VLAN_STAG_TX)
338 * __vlan_insert_inner_tag - inner VLAN tag inserting
339 * @skb: skbuff to tag
340 * @vlan_proto: VLAN encapsulation protocol
341 * @vlan_tci: VLAN TCI to insert
342 * @mac_len: MAC header length including outer vlan headers
344 * Inserts the VLAN tag into @skb as part of the payload at offset mac_len
345 * Returns error if skb_cow_head fails.
347 * Does not change skb->protocol so this function can be used during receive.
349 static inline int __vlan_insert_inner_tag(struct sk_buff *skb,
350 __be16 vlan_proto, u16 vlan_tci,
351 unsigned int mac_len)
353 struct vlan_ethhdr *veth;
355 if (skb_cow_head(skb, VLAN_HLEN) < 0)
358 skb_push(skb, VLAN_HLEN);
360 /* Move the mac header sans proto to the beginning of the new header. */
361 if (likely(mac_len > ETH_TLEN))
362 memmove(skb->data, skb->data + VLAN_HLEN, mac_len - ETH_TLEN);
363 skb->mac_header -= VLAN_HLEN;
365 veth = (struct vlan_ethhdr *)(skb->data + mac_len - ETH_HLEN);
367 /* first, the ethernet type */
368 if (likely(mac_len >= ETH_TLEN)) {
369 /* h_vlan_encapsulated_proto should already be populated, and
370 * skb->data has space for h_vlan_proto
372 veth->h_vlan_proto = vlan_proto;
374 /* h_vlan_encapsulated_proto should not be populated, and
375 * skb->data has no space for h_vlan_proto
377 veth->h_vlan_encapsulated_proto = skb->protocol;
381 veth->h_vlan_TCI = htons(vlan_tci);
387 * __vlan_insert_tag - regular VLAN tag inserting
388 * @skb: skbuff to tag
389 * @vlan_proto: VLAN encapsulation protocol
390 * @vlan_tci: VLAN TCI to insert
392 * Inserts the VLAN tag into @skb as part of the payload
393 * Returns error if skb_cow_head fails.
395 * Does not change skb->protocol so this function can be used during receive.
397 static inline int __vlan_insert_tag(struct sk_buff *skb,
398 __be16 vlan_proto, u16 vlan_tci)
400 return __vlan_insert_inner_tag(skb, vlan_proto, vlan_tci, ETH_HLEN);
404 * vlan_insert_inner_tag - inner VLAN tag inserting
405 * @skb: skbuff to tag
406 * @vlan_proto: VLAN encapsulation protocol
407 * @vlan_tci: VLAN TCI to insert
408 * @mac_len: MAC header length including outer vlan headers
410 * Inserts the VLAN tag into @skb as part of the payload at offset mac_len
411 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
413 * Following the skb_unshare() example, in case of error, the calling function
414 * doesn't have to worry about freeing the original skb.
416 * Does not change skb->protocol so this function can be used during receive.
418 static inline struct sk_buff *vlan_insert_inner_tag(struct sk_buff *skb,
421 unsigned int mac_len)
425 err = __vlan_insert_inner_tag(skb, vlan_proto, vlan_tci, mac_len);
427 dev_kfree_skb_any(skb);
434 * vlan_insert_tag - regular VLAN tag inserting
435 * @skb: skbuff to tag
436 * @vlan_proto: VLAN encapsulation protocol
437 * @vlan_tci: VLAN TCI to insert
439 * Inserts the VLAN tag into @skb as part of the payload
440 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
442 * Following the skb_unshare() example, in case of error, the calling function
443 * doesn't have to worry about freeing the original skb.
445 * Does not change skb->protocol so this function can be used during receive.
447 static inline struct sk_buff *vlan_insert_tag(struct sk_buff *skb,
448 __be16 vlan_proto, u16 vlan_tci)
450 return vlan_insert_inner_tag(skb, vlan_proto, vlan_tci, ETH_HLEN);
454 * vlan_insert_tag_set_proto - regular VLAN tag inserting
455 * @skb: skbuff to tag
456 * @vlan_proto: VLAN encapsulation protocol
457 * @vlan_tci: VLAN TCI to insert
459 * Inserts the VLAN tag into @skb as part of the payload
460 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
462 * Following the skb_unshare() example, in case of error, the calling function
463 * doesn't have to worry about freeing the original skb.
465 static inline struct sk_buff *vlan_insert_tag_set_proto(struct sk_buff *skb,
469 skb = vlan_insert_tag(skb, vlan_proto, vlan_tci);
471 skb->protocol = vlan_proto;
476 * __vlan_hwaccel_clear_tag - clear hardware accelerated VLAN info
477 * @skb: skbuff to clear
479 * Clears the VLAN information from @skb
481 static inline void __vlan_hwaccel_clear_tag(struct sk_buff *skb)
483 skb->vlan_present = 0;
487 * __vlan_hwaccel_copy_tag - copy hardware accelerated VLAN info from another skb
488 * @dst: skbuff to copy to
489 * @src: skbuff to copy from
491 * Copies VLAN information from @src to @dst (for branchless code)
493 static inline void __vlan_hwaccel_copy_tag(struct sk_buff *dst, const struct sk_buff *src)
495 dst->vlan_present = src->vlan_present;
496 dst->vlan_proto = src->vlan_proto;
497 dst->vlan_tci = src->vlan_tci;
501 * __vlan_hwaccel_push_inside - pushes vlan tag to the payload
502 * @skb: skbuff to tag
504 * Pushes the VLAN tag from @skb->vlan_tci inside to the payload.
506 * Following the skb_unshare() example, in case of error, the calling function
507 * doesn't have to worry about freeing the original skb.
509 static inline struct sk_buff *__vlan_hwaccel_push_inside(struct sk_buff *skb)
511 skb = vlan_insert_tag_set_proto(skb, skb->vlan_proto,
512 skb_vlan_tag_get(skb));
514 __vlan_hwaccel_clear_tag(skb);
519 * __vlan_hwaccel_put_tag - hardware accelerated VLAN inserting
520 * @skb: skbuff to tag
521 * @vlan_proto: VLAN encapsulation protocol
522 * @vlan_tci: VLAN TCI to insert
524 * Puts the VLAN TCI in @skb->vlan_tci and lets the device do the rest
526 static inline void __vlan_hwaccel_put_tag(struct sk_buff *skb,
527 __be16 vlan_proto, u16 vlan_tci)
529 skb->vlan_proto = vlan_proto;
530 skb->vlan_tci = vlan_tci;
531 skb->vlan_present = 1;
535 * __vlan_get_tag - get the VLAN ID that is part of the payload
536 * @skb: skbuff to query
537 * @vlan_tci: buffer to store value
539 * Returns error if the skb is not of VLAN type
541 static inline int __vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
543 struct vlan_ethhdr *veth = (struct vlan_ethhdr *)skb->data;
545 if (!eth_type_vlan(veth->h_vlan_proto))
548 *vlan_tci = ntohs(veth->h_vlan_TCI);
553 * __vlan_hwaccel_get_tag - get the VLAN ID that is in @skb->cb[]
554 * @skb: skbuff to query
555 * @vlan_tci: buffer to store value
557 * Returns error if @skb->vlan_tci is not set correctly
559 static inline int __vlan_hwaccel_get_tag(const struct sk_buff *skb,
562 if (skb_vlan_tag_present(skb)) {
563 *vlan_tci = skb_vlan_tag_get(skb);
572 * vlan_get_tag - get the VLAN ID from the skb
573 * @skb: skbuff to query
574 * @vlan_tci: buffer to store value
576 * Returns error if the skb is not VLAN tagged
578 static inline int vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
580 if (skb->dev->features & NETIF_F_HW_VLAN_CTAG_TX) {
581 return __vlan_hwaccel_get_tag(skb, vlan_tci);
583 return __vlan_get_tag(skb, vlan_tci);
588 * vlan_get_protocol - get protocol EtherType.
589 * @skb: skbuff to query
590 * @type: first vlan protocol
591 * @depth: buffer to store length of eth and vlan tags in bytes
593 * Returns the EtherType of the packet, regardless of whether it is
594 * vlan encapsulated (normal or hardware accelerated) or not.
596 static inline __be16 __vlan_get_protocol(struct sk_buff *skb, __be16 type,
599 unsigned int vlan_depth = skb->mac_len;
601 /* if type is 802.1Q/AD then the header should already be
602 * present at mac_len - VLAN_HLEN (if mac_len > 0), or at
605 if (eth_type_vlan(type)) {
607 if (WARN_ON(vlan_depth < VLAN_HLEN))
609 vlan_depth -= VLAN_HLEN;
611 vlan_depth = ETH_HLEN;
616 if (unlikely(!pskb_may_pull(skb,
617 vlan_depth + VLAN_HLEN)))
620 vh = (struct vlan_hdr *)(skb->data + vlan_depth);
621 type = vh->h_vlan_encapsulated_proto;
622 vlan_depth += VLAN_HLEN;
623 } while (eth_type_vlan(type));
633 * vlan_get_protocol - get protocol EtherType.
634 * @skb: skbuff to query
636 * Returns the EtherType of the packet, regardless of whether it is
637 * vlan encapsulated (normal or hardware accelerated) or not.
639 static inline __be16 vlan_get_protocol(struct sk_buff *skb)
641 return __vlan_get_protocol(skb, skb->protocol, NULL);
644 static inline void vlan_set_encap_proto(struct sk_buff *skb,
645 struct vlan_hdr *vhdr)
648 unsigned short *rawp;
651 * Was a VLAN packet, grab the encapsulated protocol, which the layer
652 * three protocols care about.
655 proto = vhdr->h_vlan_encapsulated_proto;
656 if (eth_proto_is_802_3(proto)) {
657 skb->protocol = proto;
661 rawp = (unsigned short *)(vhdr + 1);
664 * This is a magic hack to spot IPX packets. Older Novell
665 * breaks the protocol design and runs IPX over 802.3 without
666 * an 802.2 LLC layer. We look for FFFF which isn't a used
667 * 802.2 SSAP/DSAP. This won't work for fault tolerant netware
668 * but does for the rest.
670 skb->protocol = htons(ETH_P_802_3);
675 skb->protocol = htons(ETH_P_802_2);
679 * skb_vlan_tagged - check if skb is vlan tagged.
680 * @skb: skbuff to query
682 * Returns true if the skb is tagged, regardless of whether it is hardware
683 * accelerated or not.
685 static inline bool skb_vlan_tagged(const struct sk_buff *skb)
687 if (!skb_vlan_tag_present(skb) &&
688 likely(!eth_type_vlan(skb->protocol)))
695 * skb_vlan_tagged_multi - check if skb is vlan tagged with multiple headers.
696 * @skb: skbuff to query
698 * Returns true if the skb is tagged with multiple vlan headers, regardless
699 * of whether it is hardware accelerated or not.
701 static inline bool skb_vlan_tagged_multi(struct sk_buff *skb)
703 __be16 protocol = skb->protocol;
705 if (!skb_vlan_tag_present(skb)) {
706 struct vlan_ethhdr *veh;
708 if (likely(!eth_type_vlan(protocol)))
711 if (unlikely(!pskb_may_pull(skb, VLAN_ETH_HLEN)))
714 veh = (struct vlan_ethhdr *)skb->data;
715 protocol = veh->h_vlan_encapsulated_proto;
718 if (!eth_type_vlan(protocol))
725 * vlan_features_check - drop unsafe features for skb with multiple tags.
726 * @skb: skbuff to query
727 * @features: features to be checked
729 * Returns features without unsafe ones if the skb has multiple tags.
731 static inline netdev_features_t vlan_features_check(struct sk_buff *skb,
732 netdev_features_t features)
734 if (skb_vlan_tagged_multi(skb)) {
735 /* In the case of multi-tagged packets, use a direct mask
736 * instead of using netdev_interesect_features(), to make
737 * sure that only devices supporting NETIF_F_HW_CSUM will
738 * have checksum offloading support.
740 features &= NETIF_F_SG | NETIF_F_HIGHDMA | NETIF_F_HW_CSUM |
741 NETIF_F_FRAGLIST | NETIF_F_HW_VLAN_CTAG_TX |
742 NETIF_F_HW_VLAN_STAG_TX;
749 * compare_vlan_header - Compare two vlan headers
750 * @h1: Pointer to vlan header
751 * @h2: Pointer to vlan header
753 * Compare two vlan headers, returns 0 if equal.
755 * Please note that alignment of h1 & h2 are only guaranteed to be 16 bits.
757 static inline unsigned long compare_vlan_header(const struct vlan_hdr *h1,
758 const struct vlan_hdr *h2)
760 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
761 return *(u32 *)h1 ^ *(u32 *)h2;
763 return ((__force u32)h1->h_vlan_TCI ^ (__force u32)h2->h_vlan_TCI) |
764 ((__force u32)h1->h_vlan_encapsulated_proto ^
765 (__force u32)h2->h_vlan_encapsulated_proto);
768 #endif /* !(_LINUX_IF_VLAN_H_) */