1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * VLAN An implementation of 802.1Q VLAN tagging.
7 #ifndef _LINUX_IF_VLAN_H_
8 #define _LINUX_IF_VLAN_H_
10 #include <linux/netdevice.h>
11 #include <linux/etherdevice.h>
12 #include <linux/rtnetlink.h>
13 #include <linux/bug.h>
14 #include <uapi/linux/if_vlan.h>
16 #define VLAN_HLEN 4 /* The additional bytes required by VLAN
17 * (in addition to the Ethernet header)
19 #define VLAN_ETH_HLEN 18 /* Total octets in header. */
20 #define VLAN_ETH_ZLEN 64 /* Min. octets in frame sans FCS */
23 * According to 802.3ac, the packet can be 4 bytes longer. --Klika Jan
25 #define VLAN_ETH_DATA_LEN 1500 /* Max. octets in payload */
26 #define VLAN_ETH_FRAME_LEN 1518 /* Max. octets in frame sans FCS */
29 * struct vlan_hdr - vlan header
30 * @h_vlan_TCI: priority and VLAN ID
31 * @h_vlan_encapsulated_proto: packet type ID or len
35 __be16 h_vlan_encapsulated_proto;
39 * struct vlan_ethhdr - vlan ethernet header (ethhdr + vlan_hdr)
40 * @h_dest: destination ethernet address
41 * @h_source: source ethernet address
42 * @h_vlan_proto: ethernet protocol
43 * @h_vlan_TCI: priority and VLAN ID
44 * @h_vlan_encapsulated_proto: packet type ID or len
47 unsigned char h_dest[ETH_ALEN];
48 unsigned char h_source[ETH_ALEN];
51 __be16 h_vlan_encapsulated_proto;
54 #include <linux/skbuff.h>
56 static inline struct vlan_ethhdr *vlan_eth_hdr(const struct sk_buff *skb)
58 return (struct vlan_ethhdr *)skb_mac_header(skb);
61 #define VLAN_PRIO_MASK 0xe000 /* Priority Code Point */
62 #define VLAN_PRIO_SHIFT 13
63 #define VLAN_CFI_MASK 0x1000 /* Canonical Format Indicator / Drop Eligible Indicator */
64 #define VLAN_VID_MASK 0x0fff /* VLAN Identifier */
65 #define VLAN_N_VID 4096
67 /* found in socket.c */
68 extern void vlan_ioctl_set(int (*hook)(struct net *, void __user *));
70 static inline bool is_vlan_dev(const struct net_device *dev)
72 return dev->priv_flags & IFF_802_1Q_VLAN;
75 #define skb_vlan_tag_present(__skb) ((__skb)->vlan_present)
76 #define skb_vlan_tag_get(__skb) ((__skb)->vlan_tci)
77 #define skb_vlan_tag_get_id(__skb) ((__skb)->vlan_tci & VLAN_VID_MASK)
78 #define skb_vlan_tag_get_cfi(__skb) (!!((__skb)->vlan_tci & VLAN_CFI_MASK))
79 #define skb_vlan_tag_get_prio(__skb) (((__skb)->vlan_tci & VLAN_PRIO_MASK) >> VLAN_PRIO_SHIFT)
81 static inline int vlan_get_rx_ctag_filter_info(struct net_device *dev)
84 return notifier_to_errno(call_netdevice_notifiers(NETDEV_CVLAN_FILTER_PUSH_INFO, dev));
87 static inline void vlan_drop_rx_ctag_filter_info(struct net_device *dev)
90 call_netdevice_notifiers(NETDEV_CVLAN_FILTER_DROP_INFO, dev);
93 static inline int vlan_get_rx_stag_filter_info(struct net_device *dev)
96 return notifier_to_errno(call_netdevice_notifiers(NETDEV_SVLAN_FILTER_PUSH_INFO, dev));
99 static inline void vlan_drop_rx_stag_filter_info(struct net_device *dev)
102 call_netdevice_notifiers(NETDEV_SVLAN_FILTER_DROP_INFO, dev);
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
116 struct vlan_pcpu_stats {
122 struct u64_stats_sync syncp;
127 #if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
129 extern struct net_device *__vlan_find_dev_deep_rcu(struct net_device *real_dev,
130 __be16 vlan_proto, u16 vlan_id);
131 extern int vlan_for_each(struct net_device *dev,
132 int (*action)(struct net_device *dev, int vid,
133 void *arg), void *arg);
134 extern struct net_device *vlan_dev_real_dev(const struct net_device *dev);
135 extern u16 vlan_dev_vlan_id(const struct net_device *dev);
136 extern __be16 vlan_dev_vlan_proto(const struct net_device *dev);
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
144 struct vlan_priority_tci_mapping {
147 struct vlan_priority_tci_mapping *next;
150 struct proc_dir_entry;
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
167 struct 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];
177 struct net_device *real_dev;
178 unsigned char real_dev_addr[ETH_ALEN];
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;
187 static inline struct vlan_dev_priv *vlan_dev_priv(const struct net_device *dev)
189 return netdev_priv(dev);
193 vlan_dev_get_egress_qos_mask(struct net_device *dev, u32 skprio)
195 struct vlan_priority_tci_mapping *mp;
197 smp_rmb(); /* coupled with smp_wmb() in vlan_dev_set_egress_priority() */
199 mp = vlan_dev_priv(dev)->egress_priority_map[(skprio & 0xF)];
201 if (mp->priority == skprio) {
202 return mp->vlan_qos; /* This should already be shifted
203 * to mask correctly with the
211 extern bool vlan_do_receive(struct sk_buff **skb);
213 extern int vlan_vid_add(struct net_device *dev, __be16 proto, u16 vid);
214 extern void vlan_vid_del(struct net_device *dev, __be16 proto, u16 vid);
216 extern int vlan_vids_add_by_dev(struct net_device *dev,
217 const struct net_device *by_dev);
218 extern void vlan_vids_del_by_dev(struct net_device *dev,
219 const struct net_device *by_dev);
221 extern bool vlan_uses_dev(const struct net_device *dev);
224 static inline struct net_device *
225 __vlan_find_dev_deep_rcu(struct net_device *real_dev,
226 __be16 vlan_proto, u16 vlan_id)
232 vlan_for_each(struct net_device *dev,
233 int (*action)(struct net_device *dev, int vid, void *arg),
239 static inline struct net_device *vlan_dev_real_dev(const struct net_device *dev)
245 static inline u16 vlan_dev_vlan_id(const struct net_device *dev)
251 static inline __be16 vlan_dev_vlan_proto(const struct net_device *dev)
257 static inline u16 vlan_dev_get_egress_qos_mask(struct net_device *dev,
263 static inline bool vlan_do_receive(struct sk_buff **skb)
268 static inline int vlan_vid_add(struct net_device *dev, __be16 proto, u16 vid)
273 static inline void vlan_vid_del(struct net_device *dev, __be16 proto, u16 vid)
277 static inline int vlan_vids_add_by_dev(struct net_device *dev,
278 const struct net_device *by_dev)
283 static inline void vlan_vids_del_by_dev(struct net_device *dev,
284 const struct net_device *by_dev)
288 static inline bool vlan_uses_dev(const struct net_device *dev)
295 * eth_type_vlan - check for valid vlan ether type.
296 * @ethertype: ether type to check
298 * Returns true if the ether type is a vlan ether type.
300 static inline bool eth_type_vlan(__be16 ethertype)
303 case htons(ETH_P_8021Q):
304 case htons(ETH_P_8021AD):
311 static inline bool vlan_hw_offload_capable(netdev_features_t features,
314 if (proto == htons(ETH_P_8021Q) && features & NETIF_F_HW_VLAN_CTAG_TX)
316 if (proto == htons(ETH_P_8021AD) && features & NETIF_F_HW_VLAN_STAG_TX)
322 * __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
328 * Inserts the VLAN tag into @skb as part of the payload at offset mac_len
329 * Returns error if skb_cow_head fails.
331 * Does not change skb->protocol so this function can be used during receive.
333 static inline int __vlan_insert_inner_tag(struct sk_buff *skb,
334 __be16 vlan_proto, u16 vlan_tci,
335 unsigned int mac_len)
337 struct vlan_ethhdr *veth;
339 if (skb_cow_head(skb, VLAN_HLEN) < 0)
342 skb_push(skb, VLAN_HLEN);
344 /* Move the mac header sans proto to the beginning of the new header. */
345 if (likely(mac_len > ETH_TLEN))
346 memmove(skb->data, skb->data + VLAN_HLEN, mac_len - ETH_TLEN);
347 skb->mac_header -= VLAN_HLEN;
349 veth = (struct vlan_ethhdr *)(skb->data + mac_len - ETH_HLEN);
351 /* first, the ethernet type */
352 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
356 veth->h_vlan_proto = vlan_proto;
358 /* h_vlan_encapsulated_proto should not be populated, and
359 * skb->data has no space for h_vlan_proto
361 veth->h_vlan_encapsulated_proto = skb->protocol;
365 veth->h_vlan_TCI = htons(vlan_tci);
371 * __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
376 * Inserts the VLAN tag into @skb as part of the payload
377 * Returns error if skb_cow_head fails.
379 * Does not change skb->protocol so this function can be used during receive.
381 static inline int __vlan_insert_tag(struct sk_buff *skb,
382 __be16 vlan_proto, u16 vlan_tci)
384 return __vlan_insert_inner_tag(skb, vlan_proto, vlan_tci, ETH_HLEN);
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
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.
397 * Following the skb_unshare() example, in case of error, the calling function
398 * doesn't have to worry about freeing the original skb.
400 * Does not change skb->protocol so this function can be used during receive.
402 static inline struct sk_buff *vlan_insert_inner_tag(struct sk_buff *skb,
405 unsigned int mac_len)
409 err = __vlan_insert_inner_tag(skb, vlan_proto, vlan_tci, mac_len);
411 dev_kfree_skb_any(skb);
418 * vlan_insert_tag - regular VLAN tag inserting
419 * @skb: skbuff to tag
420 * @vlan_proto: VLAN encapsulation protocol
421 * @vlan_tci: VLAN TCI to insert
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.
426 * Following the skb_unshare() example, in case of error, the calling function
427 * doesn't have to worry about freeing the original skb.
429 * Does not change skb->protocol so this function can be used during receive.
431 static inline struct sk_buff *vlan_insert_tag(struct sk_buff *skb,
432 __be16 vlan_proto, u16 vlan_tci)
434 return vlan_insert_inner_tag(skb, vlan_proto, vlan_tci, ETH_HLEN);
438 * vlan_insert_tag_set_proto - regular VLAN tag inserting
439 * @skb: skbuff to tag
440 * @vlan_proto: VLAN encapsulation protocol
441 * @vlan_tci: VLAN TCI to insert
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.
446 * Following the skb_unshare() example, in case of error, the calling function
447 * doesn't have to worry about freeing the original skb.
449 static inline struct sk_buff *vlan_insert_tag_set_proto(struct sk_buff *skb,
453 skb = vlan_insert_tag(skb, vlan_proto, vlan_tci);
455 skb->protocol = vlan_proto;
460 * __vlan_hwaccel_clear_tag - clear hardware accelerated VLAN info
461 * @skb: skbuff to clear
463 * Clears the VLAN information from @skb
465 static inline void __vlan_hwaccel_clear_tag(struct sk_buff *skb)
467 skb->vlan_present = 0;
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
475 * Copies VLAN information from @src to @dst (for branchless code)
477 static inline void __vlan_hwaccel_copy_tag(struct sk_buff *dst, const struct sk_buff *src)
479 dst->vlan_present = src->vlan_present;
480 dst->vlan_proto = src->vlan_proto;
481 dst->vlan_tci = src->vlan_tci;
485 * __vlan_hwaccel_push_inside - pushes vlan tag to the payload
486 * @skb: skbuff to tag
488 * Pushes the VLAN tag from @skb->vlan_tci inside to the payload.
490 * Following the skb_unshare() example, in case of error, the calling function
491 * doesn't have to worry about freeing the original skb.
493 static inline struct sk_buff *__vlan_hwaccel_push_inside(struct sk_buff *skb)
495 skb = vlan_insert_tag_set_proto(skb, skb->vlan_proto,
496 skb_vlan_tag_get(skb));
498 __vlan_hwaccel_clear_tag(skb);
503 * __vlan_hwaccel_put_tag - hardware accelerated VLAN inserting
504 * @skb: skbuff to tag
505 * @vlan_proto: VLAN encapsulation protocol
506 * @vlan_tci: VLAN TCI to insert
508 * Puts the VLAN TCI in @skb->vlan_tci and lets the device do the rest
510 static inline void __vlan_hwaccel_put_tag(struct sk_buff *skb,
511 __be16 vlan_proto, u16 vlan_tci)
513 skb->vlan_proto = vlan_proto;
514 skb->vlan_tci = vlan_tci;
515 skb->vlan_present = 1;
519 * __vlan_get_tag - get the VLAN ID that is part of the payload
520 * @skb: skbuff to query
521 * @vlan_tci: buffer to store value
523 * Returns error if the skb is not of VLAN type
525 static inline int __vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
527 struct vlan_ethhdr *veth = (struct vlan_ethhdr *)skb->data;
529 if (!eth_type_vlan(veth->h_vlan_proto))
532 *vlan_tci = ntohs(veth->h_vlan_TCI);
537 * __vlan_hwaccel_get_tag - get the VLAN ID that is in @skb->cb[]
538 * @skb: skbuff to query
539 * @vlan_tci: buffer to store value
541 * Returns error if @skb->vlan_tci is not set correctly
543 static inline int __vlan_hwaccel_get_tag(const struct sk_buff *skb,
546 if (skb_vlan_tag_present(skb)) {
547 *vlan_tci = skb_vlan_tag_get(skb);
556 * vlan_get_tag - get the VLAN ID from the skb
557 * @skb: skbuff to query
558 * @vlan_tci: buffer to store value
560 * Returns error if the skb is not VLAN tagged
562 static inline int vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
564 if (skb->dev->features & NETIF_F_HW_VLAN_CTAG_TX) {
565 return __vlan_hwaccel_get_tag(skb, vlan_tci);
567 return __vlan_get_tag(skb, vlan_tci);
572 * vlan_get_protocol - get protocol EtherType.
573 * @skb: skbuff to query
574 * @type: first vlan protocol
575 * @depth: buffer to store length of eth and vlan tags in bytes
577 * Returns the EtherType of the packet, regardless of whether it is
578 * vlan encapsulated (normal or hardware accelerated) or not.
580 static inline __be16 __vlan_get_protocol(struct sk_buff *skb, __be16 type,
583 unsigned int vlan_depth = skb->mac_len;
585 /* 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
589 if (eth_type_vlan(type)) {
591 if (WARN_ON(vlan_depth < VLAN_HLEN))
593 vlan_depth -= VLAN_HLEN;
595 vlan_depth = ETH_HLEN;
600 if (unlikely(!pskb_may_pull(skb,
601 vlan_depth + VLAN_HLEN)))
604 vh = (struct vlan_hdr *)(skb->data + vlan_depth);
605 type = vh->h_vlan_encapsulated_proto;
606 vlan_depth += VLAN_HLEN;
607 } while (eth_type_vlan(type));
617 * vlan_get_protocol - get protocol EtherType.
618 * @skb: skbuff to query
620 * Returns the EtherType of the packet, regardless of whether it is
621 * vlan encapsulated (normal or hardware accelerated) or not.
623 static inline __be16 vlan_get_protocol(struct sk_buff *skb)
625 return __vlan_get_protocol(skb, skb->protocol, NULL);
628 static inline void vlan_set_encap_proto(struct sk_buff *skb,
629 struct vlan_hdr *vhdr)
632 unsigned short *rawp;
635 * Was a VLAN packet, grab the encapsulated protocol, which the layer
636 * three protocols care about.
639 proto = vhdr->h_vlan_encapsulated_proto;
640 if (eth_proto_is_802_3(proto)) {
641 skb->protocol = proto;
645 rawp = (unsigned short *)(vhdr + 1);
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.
654 skb->protocol = htons(ETH_P_802_3);
659 skb->protocol = htons(ETH_P_802_2);
663 * skb_vlan_tagged - check if skb is vlan tagged.
664 * @skb: skbuff to query
666 * Returns true if the skb is tagged, regardless of whether it is hardware
667 * accelerated or not.
669 static inline bool skb_vlan_tagged(const struct sk_buff *skb)
671 if (!skb_vlan_tag_present(skb) &&
672 likely(!eth_type_vlan(skb->protocol)))
679 * skb_vlan_tagged_multi - check if skb is vlan tagged with multiple headers.
680 * @skb: skbuff to query
682 * Returns true if the skb is tagged with multiple vlan headers, regardless
683 * of whether it is hardware accelerated or not.
685 static inline bool skb_vlan_tagged_multi(struct sk_buff *skb)
687 __be16 protocol = skb->protocol;
689 if (!skb_vlan_tag_present(skb)) {
690 struct vlan_ethhdr *veh;
692 if (likely(!eth_type_vlan(protocol)))
695 if (unlikely(!pskb_may_pull(skb, VLAN_ETH_HLEN)))
698 veh = (struct vlan_ethhdr *)skb->data;
699 protocol = veh->h_vlan_encapsulated_proto;
702 if (!eth_type_vlan(protocol))
709 * vlan_features_check - drop unsafe features for skb with multiple tags.
710 * @skb: skbuff to query
711 * @features: features to be checked
713 * Returns features without unsafe ones if the skb has multiple tags.
715 static inline netdev_features_t vlan_features_check(struct sk_buff *skb,
716 netdev_features_t features)
718 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.
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;
733 * compare_vlan_header - Compare two vlan headers
734 * @h1: Pointer to vlan header
735 * @h2: Pointer to vlan header
737 * Compare two vlan headers, returns 0 if equal.
739 * Please note that alignment of h1 & h2 are only guaranteed to be 16 bits.
741 static inline unsigned long compare_vlan_header(const struct vlan_hdr *h1,
742 const struct vlan_hdr *h2)
744 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
745 return *(u32 *)h1 ^ *(u32 *)h2;
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);
752 #endif /* !(_LINUX_IF_VLAN_H_) */