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)
84 #define skb_vlan_tag_get_prio(__skb) ((__skb)->vlan_tci & VLAN_PRIO_MASK)
87 * struct vlan_pcpu_stats - VLAN percpu rx/tx stats
88 * @rx_packets: number of received packets
89 * @rx_bytes: number of received bytes
90 * @rx_multicast: number of received multicast packets
91 * @tx_packets: number of transmitted packets
92 * @tx_bytes: number of transmitted bytes
93 * @syncp: synchronization point for 64bit counters
94 * @rx_errors: number of rx errors
95 * @tx_dropped: number of tx drops
97 struct vlan_pcpu_stats
{
103 struct u64_stats_sync syncp
;
108 #if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
110 extern struct net_device
*__vlan_find_dev_deep_rcu(struct net_device
*real_dev
,
111 __be16 vlan_proto
, u16 vlan_id
);
112 extern struct net_device
*vlan_dev_real_dev(const struct net_device
*dev
);
113 extern u16
vlan_dev_vlan_id(const struct net_device
*dev
);
114 extern __be16
vlan_dev_vlan_proto(const struct net_device
*dev
);
117 * struct vlan_priority_tci_mapping - vlan egress priority mappings
118 * @priority: skb priority
119 * @vlan_qos: vlan priority: (skb->priority << 13) & 0xE000
120 * @next: pointer to next struct
122 struct vlan_priority_tci_mapping
{
125 struct vlan_priority_tci_mapping
*next
;
128 struct proc_dir_entry
;
132 * struct vlan_dev_priv - VLAN private device data
133 * @nr_ingress_mappings: number of ingress priority mappings
134 * @ingress_priority_map: ingress priority mappings
135 * @nr_egress_mappings: number of egress priority mappings
136 * @egress_priority_map: hash of egress priority mappings
137 * @vlan_proto: VLAN encapsulation protocol
138 * @vlan_id: VLAN identifier
139 * @flags: device flags
140 * @real_dev: underlying netdevice
141 * @real_dev_addr: address of underlying netdevice
142 * @dent: proc dir entry
143 * @vlan_pcpu_stats: ptr to percpu rx stats
145 struct vlan_dev_priv
{
146 unsigned int nr_ingress_mappings
;
147 u32 ingress_priority_map
[8];
148 unsigned int nr_egress_mappings
;
149 struct vlan_priority_tci_mapping
*egress_priority_map
[16];
155 struct net_device
*real_dev
;
156 unsigned char real_dev_addr
[ETH_ALEN
];
158 struct proc_dir_entry
*dent
;
159 struct vlan_pcpu_stats __percpu
*vlan_pcpu_stats
;
160 #ifdef CONFIG_NET_POLL_CONTROLLER
161 struct netpoll
*netpoll
;
163 unsigned int nest_level
;
166 static inline struct vlan_dev_priv
*vlan_dev_priv(const struct net_device
*dev
)
168 return netdev_priv(dev
);
172 vlan_dev_get_egress_qos_mask(struct net_device
*dev
, u32 skprio
)
174 struct vlan_priority_tci_mapping
*mp
;
176 smp_rmb(); /* coupled with smp_wmb() in vlan_dev_set_egress_priority() */
178 mp
= vlan_dev_priv(dev
)->egress_priority_map
[(skprio
& 0xF)];
180 if (mp
->priority
== skprio
) {
181 return mp
->vlan_qos
; /* This should already be shifted
182 * to mask correctly with the
190 extern bool vlan_do_receive(struct sk_buff
**skb
);
192 extern int vlan_vid_add(struct net_device
*dev
, __be16 proto
, u16 vid
);
193 extern void vlan_vid_del(struct net_device
*dev
, __be16 proto
, u16 vid
);
195 extern int vlan_vids_add_by_dev(struct net_device
*dev
,
196 const struct net_device
*by_dev
);
197 extern void vlan_vids_del_by_dev(struct net_device
*dev
,
198 const struct net_device
*by_dev
);
200 extern bool vlan_uses_dev(const struct net_device
*dev
);
202 static inline int vlan_get_encap_level(struct net_device
*dev
)
204 BUG_ON(!is_vlan_dev(dev
));
205 return vlan_dev_priv(dev
)->nest_level
;
208 static inline struct net_device
*
209 __vlan_find_dev_deep_rcu(struct net_device
*real_dev
,
210 __be16 vlan_proto
, u16 vlan_id
)
215 static inline struct net_device
*vlan_dev_real_dev(const struct net_device
*dev
)
221 static inline u16
vlan_dev_vlan_id(const struct net_device
*dev
)
227 static inline __be16
vlan_dev_vlan_proto(const struct net_device
*dev
)
233 static inline u16
vlan_dev_get_egress_qos_mask(struct net_device
*dev
,
239 static inline bool vlan_do_receive(struct sk_buff
**skb
)
244 static inline int vlan_vid_add(struct net_device
*dev
, __be16 proto
, u16 vid
)
249 static inline void vlan_vid_del(struct net_device
*dev
, __be16 proto
, u16 vid
)
253 static inline int vlan_vids_add_by_dev(struct net_device
*dev
,
254 const struct net_device
*by_dev
)
259 static inline void vlan_vids_del_by_dev(struct net_device
*dev
,
260 const struct net_device
*by_dev
)
264 static inline bool vlan_uses_dev(const struct net_device
*dev
)
268 static inline int vlan_get_encap_level(struct net_device
*dev
)
275 static inline bool vlan_hw_offload_capable(netdev_features_t features
,
278 if (proto
== htons(ETH_P_8021Q
) && features
& NETIF_F_HW_VLAN_CTAG_TX
)
280 if (proto
== htons(ETH_P_8021AD
) && features
& NETIF_F_HW_VLAN_STAG_TX
)
286 * __vlan_insert_tag - regular VLAN tag inserting
287 * @skb: skbuff to tag
288 * @vlan_proto: VLAN encapsulation protocol
289 * @vlan_tci: VLAN TCI to insert
291 * Inserts the VLAN tag into @skb as part of the payload
292 * Returns error if skb_cow_head failes.
294 * Does not change skb->protocol so this function can be used during receive.
296 static inline int __vlan_insert_tag(struct sk_buff
*skb
,
297 __be16 vlan_proto
, u16 vlan_tci
)
299 struct vlan_ethhdr
*veth
;
301 if (skb_cow_head(skb
, VLAN_HLEN
) < 0)
304 veth
= (struct vlan_ethhdr
*)skb_push(skb
, VLAN_HLEN
);
306 /* Move the mac addresses to the beginning of the new header. */
307 memmove(skb
->data
, skb
->data
+ VLAN_HLEN
, 2 * ETH_ALEN
);
308 skb
->mac_header
-= VLAN_HLEN
;
310 /* first, the ethernet type */
311 veth
->h_vlan_proto
= vlan_proto
;
314 veth
->h_vlan_TCI
= htons(vlan_tci
);
320 * vlan_insert_tag - regular VLAN tag inserting
321 * @skb: skbuff to tag
322 * @vlan_proto: VLAN encapsulation protocol
323 * @vlan_tci: VLAN TCI to insert
325 * Inserts the VLAN tag into @skb as part of the payload
326 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
328 * Following the skb_unshare() example, in case of error, the calling function
329 * doesn't have to worry about freeing the original skb.
331 * Does not change skb->protocol so this function can be used during receive.
333 static inline struct sk_buff
*vlan_insert_tag(struct sk_buff
*skb
,
334 __be16 vlan_proto
, u16 vlan_tci
)
338 err
= __vlan_insert_tag(skb
, vlan_proto
, vlan_tci
);
340 dev_kfree_skb_any(skb
);
347 * vlan_insert_tag_set_proto - regular VLAN tag inserting
348 * @skb: skbuff to tag
349 * @vlan_proto: VLAN encapsulation protocol
350 * @vlan_tci: VLAN TCI to insert
352 * Inserts the VLAN tag into @skb as part of the payload
353 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
355 * Following the skb_unshare() example, in case of error, the calling function
356 * doesn't have to worry about freeing the original skb.
358 static inline struct sk_buff
*vlan_insert_tag_set_proto(struct sk_buff
*skb
,
362 skb
= vlan_insert_tag(skb
, vlan_proto
, vlan_tci
);
364 skb
->protocol
= vlan_proto
;
369 * __vlan_hwaccel_push_inside - pushes vlan tag to the payload
370 * @skb: skbuff to tag
372 * Pushes the VLAN tag from @skb->vlan_tci inside to the payload.
374 * Following the skb_unshare() example, in case of error, the calling function
375 * doesn't have to worry about freeing the original skb.
377 static inline struct sk_buff
*__vlan_hwaccel_push_inside(struct sk_buff
*skb
)
379 skb
= vlan_insert_tag_set_proto(skb
, skb
->vlan_proto
,
380 skb_vlan_tag_get(skb
));
386 * vlan_hwaccel_push_inside - pushes vlan tag to the payload
387 * @skb: skbuff to tag
389 * Checks is tag is present in @skb->vlan_tci and if it is, it pushes the
390 * VLAN tag from @skb->vlan_tci inside to the payload.
392 * Following the skb_unshare() example, in case of error, the calling function
393 * doesn't have to worry about freeing the original skb.
395 static inline struct sk_buff
*vlan_hwaccel_push_inside(struct sk_buff
*skb
)
397 if (skb_vlan_tag_present(skb
))
398 skb
= __vlan_hwaccel_push_inside(skb
);
403 * __vlan_hwaccel_put_tag - hardware accelerated VLAN inserting
404 * @skb: skbuff to tag
405 * @vlan_proto: VLAN encapsulation protocol
406 * @vlan_tci: VLAN TCI to insert
408 * Puts the VLAN TCI in @skb->vlan_tci and lets the device do the rest
410 static inline void __vlan_hwaccel_put_tag(struct sk_buff
*skb
,
411 __be16 vlan_proto
, u16 vlan_tci
)
413 skb
->vlan_proto
= vlan_proto
;
414 skb
->vlan_tci
= VLAN_TAG_PRESENT
| vlan_tci
;
418 * __vlan_get_tag - get the VLAN ID that is part of the payload
419 * @skb: skbuff to query
420 * @vlan_tci: buffer to store value
422 * Returns error if the skb is not of VLAN type
424 static inline int __vlan_get_tag(const struct sk_buff
*skb
, u16
*vlan_tci
)
426 struct vlan_ethhdr
*veth
= (struct vlan_ethhdr
*)skb
->data
;
428 if (veth
->h_vlan_proto
!= htons(ETH_P_8021Q
) &&
429 veth
->h_vlan_proto
!= htons(ETH_P_8021AD
))
432 *vlan_tci
= ntohs(veth
->h_vlan_TCI
);
437 * __vlan_hwaccel_get_tag - get the VLAN ID that is in @skb->cb[]
438 * @skb: skbuff to query
439 * @vlan_tci: buffer to store value
441 * Returns error if @skb->vlan_tci is not set correctly
443 static inline int __vlan_hwaccel_get_tag(const struct sk_buff
*skb
,
446 if (skb_vlan_tag_present(skb
)) {
447 *vlan_tci
= skb_vlan_tag_get(skb
);
455 #define HAVE_VLAN_GET_TAG
458 * vlan_get_tag - get the VLAN ID from the skb
459 * @skb: skbuff to query
460 * @vlan_tci: buffer to store value
462 * Returns error if the skb is not VLAN tagged
464 static inline int vlan_get_tag(const struct sk_buff
*skb
, u16
*vlan_tci
)
466 if (skb
->dev
->features
& NETIF_F_HW_VLAN_CTAG_TX
) {
467 return __vlan_hwaccel_get_tag(skb
, vlan_tci
);
469 return __vlan_get_tag(skb
, vlan_tci
);
474 * vlan_get_protocol - get protocol EtherType.
475 * @skb: skbuff to query
476 * @type: first vlan protocol
477 * @depth: buffer to store length of eth and vlan tags in bytes
479 * Returns the EtherType of the packet, regardless of whether it is
480 * vlan encapsulated (normal or hardware accelerated) or not.
482 static inline __be16
__vlan_get_protocol(struct sk_buff
*skb
, __be16 type
,
485 unsigned int vlan_depth
= skb
->mac_len
;
487 /* if type is 802.1Q/AD then the header should already be
488 * present at mac_len - VLAN_HLEN (if mac_len > 0), or at
491 if (type
== htons(ETH_P_8021Q
) || type
== htons(ETH_P_8021AD
)) {
493 if (WARN_ON(vlan_depth
< VLAN_HLEN
))
495 vlan_depth
-= VLAN_HLEN
;
497 vlan_depth
= ETH_HLEN
;
502 if (unlikely(!pskb_may_pull(skb
,
503 vlan_depth
+ VLAN_HLEN
)))
506 vh
= (struct vlan_hdr
*)(skb
->data
+ vlan_depth
);
507 type
= vh
->h_vlan_encapsulated_proto
;
508 vlan_depth
+= VLAN_HLEN
;
509 } while (type
== htons(ETH_P_8021Q
) ||
510 type
== htons(ETH_P_8021AD
));
520 * vlan_get_protocol - get protocol EtherType.
521 * @skb: skbuff to query
523 * Returns the EtherType of the packet, regardless of whether it is
524 * vlan encapsulated (normal or hardware accelerated) or not.
526 static inline __be16
vlan_get_protocol(struct sk_buff
*skb
)
528 return __vlan_get_protocol(skb
, skb
->protocol
, NULL
);
531 static inline void vlan_set_encap_proto(struct sk_buff
*skb
,
532 struct vlan_hdr
*vhdr
)
535 unsigned short *rawp
;
538 * Was a VLAN packet, grab the encapsulated protocol, which the layer
539 * three protocols care about.
542 proto
= vhdr
->h_vlan_encapsulated_proto
;
543 if (eth_proto_is_802_3(proto
)) {
544 skb
->protocol
= proto
;
548 rawp
= (unsigned short *)(vhdr
+ 1);
551 * This is a magic hack to spot IPX packets. Older Novell
552 * breaks the protocol design and runs IPX over 802.3 without
553 * an 802.2 LLC layer. We look for FFFF which isn't a used
554 * 802.2 SSAP/DSAP. This won't work for fault tolerant netware
555 * but does for the rest.
557 skb
->protocol
= htons(ETH_P_802_3
);
562 skb
->protocol
= htons(ETH_P_802_2
);
566 * skb_vlan_tagged - check if skb is vlan tagged.
567 * @skb: skbuff to query
569 * Returns true if the skb is tagged, regardless of whether it is hardware
570 * accelerated or not.
572 static inline bool skb_vlan_tagged(const struct sk_buff
*skb
)
574 if (!skb_vlan_tag_present(skb
) &&
575 likely(skb
->protocol
!= htons(ETH_P_8021Q
) &&
576 skb
->protocol
!= htons(ETH_P_8021AD
)))
583 * skb_vlan_tagged_multi - check if skb is vlan tagged with multiple headers.
584 * @skb: skbuff to query
586 * Returns true if the skb is tagged with multiple vlan headers, regardless
587 * of whether it is hardware accelerated or not.
589 static inline bool skb_vlan_tagged_multi(const struct sk_buff
*skb
)
591 __be16 protocol
= skb
->protocol
;
593 if (!skb_vlan_tag_present(skb
)) {
594 struct vlan_ethhdr
*veh
;
596 if (likely(protocol
!= htons(ETH_P_8021Q
) &&
597 protocol
!= htons(ETH_P_8021AD
)))
600 veh
= (struct vlan_ethhdr
*)skb
->data
;
601 protocol
= veh
->h_vlan_encapsulated_proto
;
604 if (protocol
!= htons(ETH_P_8021Q
) && protocol
!= htons(ETH_P_8021AD
))
611 * vlan_features_check - drop unsafe features for skb with multiple tags.
612 * @skb: skbuff to query
613 * @features: features to be checked
615 * Returns features without unsafe ones if the skb has multiple tags.
617 static inline netdev_features_t
vlan_features_check(const struct sk_buff
*skb
,
618 netdev_features_t features
)
620 if (skb_vlan_tagged_multi(skb
))
621 features
= netdev_intersect_features(features
,
626 NETIF_F_HW_VLAN_CTAG_TX
|
627 NETIF_F_HW_VLAN_STAG_TX
);
633 * compare_vlan_header - Compare two vlan headers
634 * @h1: Pointer to vlan header
635 * @h2: Pointer to vlan header
637 * Compare two vlan headers, returns 0 if equal.
639 * Please note that alignment of h1 & h2 are only guaranteed to be 16 bits.
641 static inline unsigned long compare_vlan_header(const struct vlan_hdr
*h1
,
642 const struct vlan_hdr
*h2
)
644 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
645 return *(u32
*)h1
^ *(u32
*)h2
;
647 return ((__force u32
)h1
->h_vlan_TCI
^ (__force u32
)h2
->h_vlan_TCI
) |
648 ((__force u32
)h1
->h_vlan_encapsulated_proto
^
649 (__force u32
)h2
->h_vlan_encapsulated_proto
);
652 #endif /* !(_LINUX_IF_VLAN_H_) */