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 */
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 */
69 #define VLAN_TAG_PRESENT VLAN_CFI_MASK
70 #define VLAN_VID_MASK 0x0fff /* VLAN Identifier */
71 #define VLAN_N_VID 4096
73 /* found in socket.c */
74 extern void vlan_ioctl_set(int (*hook)(struct net *, void __user *));
76 static inline bool is_vlan_dev(const struct net_device *dev)
78 return dev->priv_flags & IFF_802_1Q_VLAN;
81 #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)
86 * struct vlan_pcpu_stats - VLAN percpu rx/tx stats
87 * @rx_packets: number of received packets
88 * @rx_bytes: number of received bytes
89 * @rx_multicast: number of received multicast packets
90 * @tx_packets: number of transmitted packets
91 * @tx_bytes: number of transmitted bytes
92 * @syncp: synchronization point for 64bit counters
93 * @rx_errors: number of rx errors
94 * @tx_dropped: number of tx drops
96 struct vlan_pcpu_stats {
102 struct u64_stats_sync syncp;
107 #if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
109 extern struct net_device *__vlan_find_dev_deep_rcu(struct net_device *real_dev,
110 __be16 vlan_proto, u16 vlan_id);
111 extern struct net_device *vlan_dev_real_dev(const struct net_device *dev);
112 extern u16 vlan_dev_vlan_id(const struct net_device *dev);
113 extern __be16 vlan_dev_vlan_proto(const struct net_device *dev);
116 * struct vlan_priority_tci_mapping - vlan egress priority mappings
117 * @priority: skb priority
118 * @vlan_qos: vlan priority: (skb->priority << 13) & 0xE000
119 * @next: pointer to next struct
121 struct vlan_priority_tci_mapping {
124 struct vlan_priority_tci_mapping *next;
127 struct proc_dir_entry;
131 * struct vlan_dev_priv - VLAN private device data
132 * @nr_ingress_mappings: number of ingress priority mappings
133 * @ingress_priority_map: ingress priority mappings
134 * @nr_egress_mappings: number of egress priority mappings
135 * @egress_priority_map: hash of egress priority mappings
136 * @vlan_proto: VLAN encapsulation protocol
137 * @vlan_id: VLAN identifier
138 * @flags: device flags
139 * @real_dev: underlying netdevice
140 * @real_dev_addr: address of underlying netdevice
141 * @dent: proc dir entry
142 * @vlan_pcpu_stats: ptr to percpu rx stats
144 struct vlan_dev_priv {
145 unsigned int nr_ingress_mappings;
146 u32 ingress_priority_map[8];
147 unsigned int nr_egress_mappings;
148 struct vlan_priority_tci_mapping *egress_priority_map[16];
154 struct net_device *real_dev;
155 unsigned char real_dev_addr[ETH_ALEN];
157 struct proc_dir_entry *dent;
158 struct vlan_pcpu_stats __percpu *vlan_pcpu_stats;
159 #ifdef CONFIG_NET_POLL_CONTROLLER
160 struct netpoll *netpoll;
162 unsigned int nest_level;
165 static inline struct vlan_dev_priv *vlan_dev_priv(const struct net_device *dev)
167 return netdev_priv(dev);
171 vlan_dev_get_egress_qos_mask(struct net_device *dev, u32 skprio)
173 struct vlan_priority_tci_mapping *mp;
175 smp_rmb(); /* coupled with smp_wmb() in vlan_dev_set_egress_priority() */
177 mp = vlan_dev_priv(dev)->egress_priority_map[(skprio & 0xF)];
179 if (mp->priority == skprio) {
180 return mp->vlan_qos; /* This should already be shifted
181 * to mask correctly with the
189 extern bool vlan_do_receive(struct sk_buff **skb);
191 extern int vlan_vid_add(struct net_device *dev, __be16 proto, u16 vid);
192 extern void vlan_vid_del(struct net_device *dev, __be16 proto, u16 vid);
194 extern int vlan_vids_add_by_dev(struct net_device *dev,
195 const struct net_device *by_dev);
196 extern void vlan_vids_del_by_dev(struct net_device *dev,
197 const struct net_device *by_dev);
199 extern bool vlan_uses_dev(const struct net_device *dev);
201 static inline int vlan_get_encap_level(struct net_device *dev)
203 BUG_ON(!is_vlan_dev(dev));
204 return vlan_dev_priv(dev)->nest_level;
207 static inline struct net_device *
208 __vlan_find_dev_deep_rcu(struct net_device *real_dev,
209 __be16 vlan_proto, u16 vlan_id)
214 static inline struct net_device *vlan_dev_real_dev(const struct net_device *dev)
220 static inline u16 vlan_dev_vlan_id(const struct net_device *dev)
226 static inline __be16 vlan_dev_vlan_proto(const struct net_device *dev)
232 static inline u16 vlan_dev_get_egress_qos_mask(struct net_device *dev,
238 static inline bool vlan_do_receive(struct sk_buff **skb)
243 static inline int vlan_vid_add(struct net_device *dev, __be16 proto, u16 vid)
248 static inline void vlan_vid_del(struct net_device *dev, __be16 proto, u16 vid)
252 static inline int vlan_vids_add_by_dev(struct net_device *dev,
253 const struct net_device *by_dev)
258 static inline void vlan_vids_del_by_dev(struct net_device *dev,
259 const struct net_device *by_dev)
263 static inline bool vlan_uses_dev(const struct net_device *dev)
267 static inline int vlan_get_encap_level(struct net_device *dev)
274 static inline bool vlan_hw_offload_capable(netdev_features_t features,
277 if (proto == htons(ETH_P_8021Q) && features & NETIF_F_HW_VLAN_CTAG_TX)
279 if (proto == htons(ETH_P_8021AD) && features & NETIF_F_HW_VLAN_STAG_TX)
285 * __vlan_insert_tag - regular VLAN tag inserting
286 * @skb: skbuff to tag
287 * @vlan_proto: VLAN encapsulation protocol
288 * @vlan_tci: VLAN TCI to insert
290 * Inserts the VLAN tag into @skb as part of the payload
291 * Returns error if skb_cow_head failes.
293 * Does not change skb->protocol so this function can be used during receive.
295 static inline int __vlan_insert_tag(struct sk_buff *skb,
296 __be16 vlan_proto, u16 vlan_tci)
298 struct vlan_ethhdr *veth;
300 if (skb_cow_head(skb, VLAN_HLEN) < 0)
303 veth = (struct vlan_ethhdr *)skb_push(skb, VLAN_HLEN);
305 /* Move the mac addresses to the beginning of the new header. */
306 memmove(skb->data, skb->data + VLAN_HLEN, 2 * ETH_ALEN);
307 skb->mac_header -= VLAN_HLEN;
309 /* first, the ethernet type */
310 veth->h_vlan_proto = vlan_proto;
313 veth->h_vlan_TCI = htons(vlan_tci);
319 * vlan_insert_tag - regular VLAN tag inserting
320 * @skb: skbuff to tag
321 * @vlan_proto: VLAN encapsulation protocol
322 * @vlan_tci: VLAN TCI to insert
324 * Inserts the VLAN tag into @skb as part of the payload
325 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
327 * Following the skb_unshare() example, in case of error, the calling function
328 * doesn't have to worry about freeing the original skb.
330 * Does not change skb->protocol so this function can be used during receive.
332 static inline struct sk_buff *vlan_insert_tag(struct sk_buff *skb,
333 __be16 vlan_proto, u16 vlan_tci)
337 err = __vlan_insert_tag(skb, vlan_proto, vlan_tci);
339 dev_kfree_skb_any(skb);
346 * vlan_insert_tag_set_proto - regular VLAN tag inserting
347 * @skb: skbuff to tag
348 * @vlan_proto: VLAN encapsulation protocol
349 * @vlan_tci: VLAN TCI to insert
351 * Inserts the VLAN tag into @skb as part of the payload
352 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
354 * Following the skb_unshare() example, in case of error, the calling function
355 * doesn't have to worry about freeing the original skb.
357 static inline struct sk_buff *vlan_insert_tag_set_proto(struct sk_buff *skb,
361 skb = vlan_insert_tag(skb, vlan_proto, vlan_tci);
363 skb->protocol = vlan_proto;
368 * __vlan_hwaccel_push_inside - pushes vlan tag to the payload
369 * @skb: skbuff to tag
371 * Pushes the VLAN tag from @skb->vlan_tci inside to the payload.
373 * Following the skb_unshare() example, in case of error, the calling function
374 * doesn't have to worry about freeing the original skb.
376 static inline struct sk_buff *__vlan_hwaccel_push_inside(struct sk_buff *skb)
378 skb = vlan_insert_tag_set_proto(skb, skb->vlan_proto,
379 skb_vlan_tag_get(skb));
385 * vlan_hwaccel_push_inside - pushes vlan tag to the payload
386 * @skb: skbuff to tag
388 * Checks is tag is present in @skb->vlan_tci and if it is, it pushes the
389 * VLAN tag from @skb->vlan_tci inside to the payload.
391 * Following the skb_unshare() example, in case of error, the calling function
392 * doesn't have to worry about freeing the original skb.
394 static inline struct sk_buff *vlan_hwaccel_push_inside(struct sk_buff *skb)
396 if (skb_vlan_tag_present(skb))
397 skb = __vlan_hwaccel_push_inside(skb);
402 * __vlan_hwaccel_put_tag - hardware accelerated VLAN inserting
403 * @skb: skbuff to tag
404 * @vlan_proto: VLAN encapsulation protocol
405 * @vlan_tci: VLAN TCI to insert
407 * Puts the VLAN TCI in @skb->vlan_tci and lets the device do the rest
409 static inline void __vlan_hwaccel_put_tag(struct sk_buff *skb,
410 __be16 vlan_proto, u16 vlan_tci)
412 skb->vlan_proto = vlan_proto;
413 skb->vlan_tci = VLAN_TAG_PRESENT | vlan_tci;
417 * __vlan_get_tag - get the VLAN ID that is part of the payload
418 * @skb: skbuff to query
419 * @vlan_tci: buffer to store value
421 * Returns error if the skb is not of VLAN type
423 static inline int __vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
425 struct vlan_ethhdr *veth = (struct vlan_ethhdr *)skb->data;
427 if (veth->h_vlan_proto != htons(ETH_P_8021Q) &&
428 veth->h_vlan_proto != htons(ETH_P_8021AD))
431 *vlan_tci = ntohs(veth->h_vlan_TCI);
436 * __vlan_hwaccel_get_tag - get the VLAN ID that is in @skb->cb[]
437 * @skb: skbuff to query
438 * @vlan_tci: buffer to store value
440 * Returns error if @skb->vlan_tci is not set correctly
442 static inline int __vlan_hwaccel_get_tag(const struct sk_buff *skb,
445 if (skb_vlan_tag_present(skb)) {
446 *vlan_tci = skb_vlan_tag_get(skb);
454 #define HAVE_VLAN_GET_TAG
457 * vlan_get_tag - get the VLAN ID from the skb
458 * @skb: skbuff to query
459 * @vlan_tci: buffer to store value
461 * Returns error if the skb is not VLAN tagged
463 static inline int vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
465 if (skb->dev->features & NETIF_F_HW_VLAN_CTAG_TX) {
466 return __vlan_hwaccel_get_tag(skb, vlan_tci);
468 return __vlan_get_tag(skb, vlan_tci);
473 * vlan_get_protocol - get protocol EtherType.
474 * @skb: skbuff to query
475 * @type: first vlan protocol
476 * @depth: buffer to store length of eth and vlan tags in bytes
478 * Returns the EtherType of the packet, regardless of whether it is
479 * vlan encapsulated (normal or hardware accelerated) or not.
481 static inline __be16 __vlan_get_protocol(struct sk_buff *skb, __be16 type,
484 unsigned int vlan_depth = skb->mac_len;
486 /* if type is 802.1Q/AD then the header should already be
487 * present at mac_len - VLAN_HLEN (if mac_len > 0), or at
490 if (type == htons(ETH_P_8021Q) || type == htons(ETH_P_8021AD)) {
492 if (WARN_ON(vlan_depth < VLAN_HLEN))
494 vlan_depth -= VLAN_HLEN;
496 vlan_depth = ETH_HLEN;
501 if (unlikely(!pskb_may_pull(skb,
502 vlan_depth + VLAN_HLEN)))
505 vh = (struct vlan_hdr *)(skb->data + vlan_depth);
506 type = vh->h_vlan_encapsulated_proto;
507 vlan_depth += VLAN_HLEN;
508 } while (type == htons(ETH_P_8021Q) ||
509 type == htons(ETH_P_8021AD));
519 * vlan_get_protocol - get protocol EtherType.
520 * @skb: skbuff to query
522 * Returns the EtherType of the packet, regardless of whether it is
523 * vlan encapsulated (normal or hardware accelerated) or not.
525 static inline __be16 vlan_get_protocol(struct sk_buff *skb)
527 return __vlan_get_protocol(skb, skb->protocol, NULL);
530 static inline void vlan_set_encap_proto(struct sk_buff *skb,
531 struct vlan_hdr *vhdr)
534 unsigned short *rawp;
537 * Was a VLAN packet, grab the encapsulated protocol, which the layer
538 * three protocols care about.
541 proto = vhdr->h_vlan_encapsulated_proto;
542 if (eth_proto_is_802_3(proto)) {
543 skb->protocol = proto;
547 rawp = (unsigned short *)(vhdr + 1);
550 * This is a magic hack to spot IPX packets. Older Novell
551 * breaks the protocol design and runs IPX over 802.3 without
552 * an 802.2 LLC layer. We look for FFFF which isn't a used
553 * 802.2 SSAP/DSAP. This won't work for fault tolerant netware
554 * but does for the rest.
556 skb->protocol = htons(ETH_P_802_3);
561 skb->protocol = htons(ETH_P_802_2);
565 * skb_vlan_tagged - check if skb is vlan tagged.
566 * @skb: skbuff to query
568 * Returns true if the skb is tagged, regardless of whether it is hardware
569 * accelerated or not.
571 static inline bool skb_vlan_tagged(const struct sk_buff *skb)
573 if (!skb_vlan_tag_present(skb) &&
574 likely(skb->protocol != htons(ETH_P_8021Q) &&
575 skb->protocol != htons(ETH_P_8021AD)))
582 * skb_vlan_tagged_multi - check if skb is vlan tagged with multiple headers.
583 * @skb: skbuff to query
585 * Returns true if the skb is tagged with multiple vlan headers, regardless
586 * of whether it is hardware accelerated or not.
588 static inline bool skb_vlan_tagged_multi(const struct sk_buff *skb)
590 __be16 protocol = skb->protocol;
592 if (!skb_vlan_tag_present(skb)) {
593 struct vlan_ethhdr *veh;
595 if (likely(protocol != htons(ETH_P_8021Q) &&
596 protocol != htons(ETH_P_8021AD)))
599 veh = (struct vlan_ethhdr *)skb->data;
600 protocol = veh->h_vlan_encapsulated_proto;
603 if (protocol != htons(ETH_P_8021Q) && protocol != htons(ETH_P_8021AD))
610 * vlan_features_check - drop unsafe features for skb with multiple tags.
611 * @skb: skbuff to query
612 * @features: features to be checked
614 * Returns features without unsafe ones if the skb has multiple tags.
616 static inline netdev_features_t vlan_features_check(const struct sk_buff *skb,
617 netdev_features_t features)
619 if (skb_vlan_tagged_multi(skb))
620 features = netdev_intersect_features(features,
625 NETIF_F_HW_VLAN_CTAG_TX |
626 NETIF_F_HW_VLAN_STAG_TX);
632 * compare_vlan_header - Compare two vlan headers
633 * @h1: Pointer to vlan header
634 * @h2: Pointer to vlan header
636 * Compare two vlan headers, returns 0 if equal.
638 * Please note that alignment of h1 & h2 are only guaranteed to be 16 bits.
640 static inline unsigned long compare_vlan_header(const struct vlan_hdr *h1,
641 const struct vlan_hdr *h2)
643 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
644 return *(u32 *)h1 ^ *(u32 *)h2;
646 return ((__force u32)h1->h_vlan_TCI ^ (__force u32)h2->h_vlan_TCI) |
647 ((__force u32)h1->h_vlan_encapsulated_proto ^
648 (__force u32)h2->h_vlan_encapsulated_proto);
651 #endif /* !(_LINUX_IF_VLAN_H_) */