blob: 13aff1e2183baeb7b2493b6d50cc75184d908ef1 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * VLAN An implementation of 802.1Q VLAN tagging.
3 *
4 * Authors: Ben Greear <greearb@candelatech.com>
5 *
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.
10 *
11 */
12
13#ifndef _LINUX_IF_VLAN_H_
14#define _LINUX_IF_VLAN_H_
15
16#ifdef __KERNEL__
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/netdevice.h>
Stephen Hemminger0610d112006-07-14 16:34:22 -070018#include <linux/etherdevice.h>
Jesse Gross65ac6a52010-10-20 13:56:05 +000019#include <linux/rtnetlink.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21#define VLAN_HLEN 4 /* The additional bytes (on top of the Ethernet header)
22 * that VLAN requires.
23 */
24#define VLAN_ETH_ALEN 6 /* Octets in one ethernet addr */
25#define VLAN_ETH_HLEN 18 /* Total octets in header. */
26#define VLAN_ETH_ZLEN 64 /* Min. octets in frame sans FCS */
27
28/*
29 * According to 802.3ac, the packet can be 4 bytes longer. --Klika Jan
30 */
31#define VLAN_ETH_DATA_LEN 1500 /* Max. octets in payload */
32#define VLAN_ETH_FRAME_LEN 1518 /* Max. octets in frame sans FCS */
33
Patrick McHardy740c15d2008-01-21 00:18:53 -080034/*
35 * struct vlan_hdr - vlan header
36 * @h_vlan_TCI: priority and VLAN ID
37 * @h_vlan_encapsulated_proto: packet type ID or len
38 */
39struct vlan_hdr {
40 __be16 h_vlan_TCI;
41 __be16 h_vlan_encapsulated_proto;
42};
43
44/**
45 * struct vlan_ethhdr - vlan ethernet header (ethhdr + vlan_hdr)
46 * @h_dest: destination ethernet address
47 * @h_source: source ethernet address
48 * @h_vlan_proto: ethernet protocol (always 0x8100)
49 * @h_vlan_TCI: priority and VLAN ID
50 * @h_vlan_encapsulated_proto: packet type ID or len
51 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070052struct vlan_ethhdr {
Patrick McHardy740c15d2008-01-21 00:18:53 -080053 unsigned char h_dest[ETH_ALEN];
54 unsigned char h_source[ETH_ALEN];
55 __be16 h_vlan_proto;
56 __be16 h_vlan_TCI;
57 __be16 h_vlan_encapsulated_proto;
Linus Torvalds1da177e2005-04-16 15:20:36 -070058};
59
60#include <linux/skbuff.h>
61
62static inline struct vlan_ethhdr *vlan_eth_hdr(const struct sk_buff *skb)
63{
Arnaldo Carvalho de Melo98e399f2007-03-19 15:33:04 -070064 return (struct vlan_ethhdr *)skb_mac_header(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -070065}
66
Eric Dumazet05423b22009-10-26 18:40:35 -070067#define VLAN_PRIO_MASK 0xe000 /* Priority Code Point */
68#define VLAN_PRIO_SHIFT 13
69#define VLAN_CFI_MASK 0x1000 /* Canonical Format Indicator */
70#define VLAN_TAG_PRESENT VLAN_CFI_MASK
71#define VLAN_VID_MASK 0x0fff /* VLAN Identifier */
Jesse Grossb7381272010-10-20 13:56:02 +000072#define VLAN_N_VID 4096
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
74/* found in socket.c */
Eric W. Biederman881d9662007-09-17 11:56:21 -070075extern void vlan_ioctl_set(int (*hook)(struct net *, void __user *));
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
Jiri Pirko5b9ea6e2011-12-08 04:11:18 +000077struct vlan_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Neil Horman6dcbbe22011-05-24 08:31:08 +000079static inline int is_vlan_dev(struct net_device *dev)
80{
81 return dev->priv_flags & IFF_802_1Q_VLAN;
82}
83
Eric Dumazet05423b22009-10-26 18:40:35 -070084#define vlan_tx_tag_present(__skb) ((__skb)->vlan_tci & VLAN_TAG_PRESENT)
85#define vlan_tx_tag_get(__skb) ((__skb)->vlan_tci & ~VLAN_TAG_PRESENT)
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
Patrick McHardy7750f402008-07-08 03:23:36 -070087#if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
Jesse Gross65ac6a52010-10-20 13:56:05 +000088
Jiri Pirkocec9c132011-07-20 04:54:05 +000089extern struct net_device *__vlan_find_dev_deep(struct net_device *real_dev,
90 u16 vlan_id);
Patrick McHardy22d1ba72008-07-08 03:23:57 -070091extern struct net_device *vlan_dev_real_dev(const struct net_device *dev);
92extern u16 vlan_dev_vlan_id(const struct net_device *dev);
93
Eric Dumazet6a32e4f2011-10-29 06:13:39 +000094extern bool vlan_do_receive(struct sk_buff **skb, bool last_handler);
Jiri Pirkobcc6d472011-04-07 19:48:33 +000095extern struct sk_buff *vlan_untag(struct sk_buff *skb);
Patrick McHardy9b22ea52008-11-04 14:49:57 -080096
Jiri Pirko87002b02011-12-08 04:11:17 +000097extern int vlan_vid_add(struct net_device *dev, unsigned short vid);
98extern void vlan_vid_del(struct net_device *dev, unsigned short vid);
99
Jiri Pirko348a1442011-12-08 04:11:19 +0000100extern int vlan_vids_add_by_dev(struct net_device *dev,
101 const struct net_device *by_dev);
102extern void vlan_vids_del_by_dev(struct net_device *dev,
103 const struct net_device *by_dev);
Patrick McHardy7750f402008-07-08 03:23:36 -0700104#else
Jiri Pirkocec9c132011-07-20 04:54:05 +0000105static inline struct net_device *
106__vlan_find_dev_deep(struct net_device *real_dev, u16 vlan_id)
107{
108 return NULL;
109}
110
Patrick McHardy22d1ba72008-07-08 03:23:57 -0700111static inline struct net_device *vlan_dev_real_dev(const struct net_device *dev)
112{
113 BUG();
114 return NULL;
115}
116
117static inline u16 vlan_dev_vlan_id(const struct net_device *dev)
118{
119 BUG();
120 return 0;
121}
122
Eric Dumazet6a32e4f2011-10-29 06:13:39 +0000123static inline bool vlan_do_receive(struct sk_buff **skb, bool last_handler)
Patrick McHardy9b22ea52008-11-04 14:49:57 -0800124{
Eric Dumazet6a32e4f2011-10-29 06:13:39 +0000125 if (((*skb)->vlan_tci & VLAN_VID_MASK) && last_handler)
Jesse Gross0988c4c2010-10-21 11:30:42 +0000126 (*skb)->pkt_type = PACKET_OTHERHOST;
Jesse Gross3701e512010-10-20 13:56:06 +0000127 return false;
Patrick McHardy9b22ea52008-11-04 14:49:57 -0800128}
Herbert Xue1c096e2009-01-06 10:50:09 -0800129
David S. Miller6139e752011-04-12 19:27:51 -0700130static inline struct sk_buff *vlan_untag(struct sk_buff *skb)
Jiri Pirkobcc6d472011-04-07 19:48:33 +0000131{
132 return skb;
133}
Jiri Pirko87002b02011-12-08 04:11:17 +0000134
135static inline int vlan_vid_add(struct net_device *dev, unsigned short vid)
136{
137 return 0;
138}
139
140static inline void vlan_vid_del(struct net_device *dev, unsigned short vid)
141{
142}
Jiri Pirko348a1442011-12-08 04:11:19 +0000143
144static inline int vlan_vids_add_by_dev(struct net_device *dev,
145 const struct net_device *by_dev)
146{
147 return 0;
148}
149
150static inline void vlan_vids_del_by_dev(struct net_device *dev,
151 const struct net_device *by_dev)
152{
153}
Patrick McHardy7750f402008-07-08 03:23:36 -0700154#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
Patrick McHardy9bb85822008-07-08 03:24:44 -0700156/**
Jiri Pirko0b5c9db2011-06-10 06:56:58 +0000157 * vlan_insert_tag - regular VLAN tag inserting
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 * @skb: skbuff to tag
Patrick McHardy9bb85822008-07-08 03:24:44 -0700159 * @vlan_tci: VLAN TCI to insert
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 *
161 * Inserts the VLAN tag into @skb as part of the payload
162 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
Patrick McHardy9bb85822008-07-08 03:24:44 -0700163 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 * Following the skb_unshare() example, in case of error, the calling function
165 * doesn't have to worry about freeing the original skb.
Jiri Pirko0b5c9db2011-06-10 06:56:58 +0000166 *
167 * Does not change skb->protocol so this function can be used during receive.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168 */
Jiri Pirko0b5c9db2011-06-10 06:56:58 +0000169static inline struct sk_buff *vlan_insert_tag(struct sk_buff *skb, u16 vlan_tci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170{
171 struct vlan_ethhdr *veth;
172
Patrick McHardy11a100f2008-07-08 15:36:57 -0700173 if (skb_cow_head(skb, VLAN_HLEN) < 0) {
174 kfree_skb(skb);
175 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 veth = (struct vlan_ethhdr *)skb_push(skb, VLAN_HLEN);
178
179 /* Move the mac addresses to the beginning of the new header. */
180 memmove(skb->data, skb->data + VLAN_HLEN, 2 * VLAN_ETH_ALEN);
Jarek Poplawskie4dd6182009-02-18 23:31:11 -0800181 skb->mac_header -= VLAN_HLEN;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
183 /* first, the ethernet type */
Patrick McHardy57d3ae82008-01-21 00:26:25 -0800184 veth->h_vlan_proto = htons(ETH_P_8021Q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
Patrick McHardy9bb85822008-07-08 03:24:44 -0700186 /* now, the TCI */
187 veth->h_vlan_TCI = htons(vlan_tci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
Jiri Pirko0b5c9db2011-06-10 06:56:58 +0000189 return skb;
190}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
Jiri Pirko0b5c9db2011-06-10 06:56:58 +0000192/**
193 * __vlan_put_tag - regular VLAN tag inserting
194 * @skb: skbuff to tag
195 * @vlan_tci: VLAN TCI to insert
196 *
197 * Inserts the VLAN tag into @skb as part of the payload
198 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
199 *
200 * Following the skb_unshare() example, in case of error, the calling function
201 * doesn't have to worry about freeing the original skb.
202 */
203static inline struct sk_buff *__vlan_put_tag(struct sk_buff *skb, u16 vlan_tci)
204{
205 skb = vlan_insert_tag(skb, vlan_tci);
206 if (skb)
207 skb->protocol = htons(ETH_P_8021Q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 return skb;
209}
210
211/**
212 * __vlan_hwaccel_put_tag - hardware accelerated VLAN inserting
213 * @skb: skbuff to tag
Patrick McHardy9bb85822008-07-08 03:24:44 -0700214 * @vlan_tci: VLAN TCI to insert
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 *
Patrick McHardy6aa895b2008-07-14 22:49:06 -0700216 * Puts the VLAN TCI in @skb->vlan_tci and lets the device do the rest
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217 */
Patrick McHardy9bb85822008-07-08 03:24:44 -0700218static inline struct sk_buff *__vlan_hwaccel_put_tag(struct sk_buff *skb,
219 u16 vlan_tci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220{
Eric Dumazet05423b22009-10-26 18:40:35 -0700221 skb->vlan_tci = VLAN_TAG_PRESENT | vlan_tci;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 return skb;
223}
224
225#define HAVE_VLAN_PUT_TAG
226
227/**
228 * vlan_put_tag - inserts VLAN tag according to device features
229 * @skb: skbuff to tag
Patrick McHardy9bb85822008-07-08 03:24:44 -0700230 * @vlan_tci: VLAN TCI to insert
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 *
232 * Assumes skb->dev is the target that will xmit this frame.
233 * Returns a VLAN tagged skb.
234 */
Patrick McHardy9bb85822008-07-08 03:24:44 -0700235static inline struct sk_buff *vlan_put_tag(struct sk_buff *skb, u16 vlan_tci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236{
237 if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
Patrick McHardy9bb85822008-07-08 03:24:44 -0700238 return __vlan_hwaccel_put_tag(skb, vlan_tci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 } else {
Patrick McHardy9bb85822008-07-08 03:24:44 -0700240 return __vlan_put_tag(skb, vlan_tci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 }
242}
243
244/**
245 * __vlan_get_tag - get the VLAN ID that is part of the payload
246 * @skb: skbuff to query
Patrick McHardy9bb85822008-07-08 03:24:44 -0700247 * @vlan_tci: buffer to store vlaue
248 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 * Returns error if the skb is not of VLAN type
250 */
Patrick McHardy9bb85822008-07-08 03:24:44 -0700251static inline int __vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252{
253 struct vlan_ethhdr *veth = (struct vlan_ethhdr *)skb->data;
254
Patrick McHardy57d3ae82008-01-21 00:26:25 -0800255 if (veth->h_vlan_proto != htons(ETH_P_8021Q)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 return -EINVAL;
257 }
258
Patrick McHardy9bb85822008-07-08 03:24:44 -0700259 *vlan_tci = ntohs(veth->h_vlan_TCI);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 return 0;
261}
262
263/**
264 * __vlan_hwaccel_get_tag - get the VLAN ID that is in @skb->cb[]
265 * @skb: skbuff to query
Patrick McHardy9bb85822008-07-08 03:24:44 -0700266 * @vlan_tci: buffer to store vlaue
267 *
Patrick McHardy6aa895b2008-07-14 22:49:06 -0700268 * Returns error if @skb->vlan_tci is not set correctly
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 */
Patrick McHardy18149932008-02-05 16:20:22 -0800270static inline int __vlan_hwaccel_get_tag(const struct sk_buff *skb,
Patrick McHardy9bb85822008-07-08 03:24:44 -0700271 u16 *vlan_tci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272{
Patrick McHardy6aa895b2008-07-14 22:49:06 -0700273 if (vlan_tx_tag_present(skb)) {
Eric Dumazet05423b22009-10-26 18:40:35 -0700274 *vlan_tci = vlan_tx_tag_get(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 return 0;
276 } else {
Patrick McHardy9bb85822008-07-08 03:24:44 -0700277 *vlan_tci = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 return -EINVAL;
279 }
280}
281
282#define HAVE_VLAN_GET_TAG
283
284/**
285 * vlan_get_tag - get the VLAN ID from the skb
286 * @skb: skbuff to query
Patrick McHardy9bb85822008-07-08 03:24:44 -0700287 * @vlan_tci: buffer to store vlaue
288 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 * Returns error if the skb is not VLAN tagged
290 */
Patrick McHardy9bb85822008-07-08 03:24:44 -0700291static inline int vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292{
293 if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
Patrick McHardy9bb85822008-07-08 03:24:44 -0700294 return __vlan_hwaccel_get_tag(skb, vlan_tci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 } else {
Patrick McHardy9bb85822008-07-08 03:24:44 -0700296 return __vlan_get_tag(skb, vlan_tci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 }
298}
299
Hao Zheng0a85df02010-11-11 13:47:57 +0000300/**
301 * vlan_get_protocol - get protocol EtherType.
302 * @skb: skbuff to query
303 *
304 * Returns the EtherType of the packet, regardless of whether it is
305 * vlan encapsulated (normal or hardware accelerated) or not.
306 */
307static inline __be16 vlan_get_protocol(const struct sk_buff *skb)
308{
309 __be16 protocol = 0;
310
311 if (vlan_tx_tag_present(skb) ||
312 skb->protocol != cpu_to_be16(ETH_P_8021Q))
313 protocol = skb->protocol;
314 else {
315 __be16 proto, *protop;
316 protop = skb_header_pointer(skb, offsetof(struct vlan_ethhdr,
317 h_vlan_encapsulated_proto),
318 sizeof(proto), &proto);
319 if (likely(protop))
320 protocol = *protop;
321 }
322
323 return protocol;
324}
Pravin B Shelar396cf942011-11-18 13:15:54 -0800325
326static inline void vlan_set_encap_proto(struct sk_buff *skb,
327 struct vlan_hdr *vhdr)
328{
329 __be16 proto;
330 unsigned char *rawp;
331
332 /*
333 * Was a VLAN packet, grab the encapsulated protocol, which the layer
334 * three protocols care about.
335 */
336
337 proto = vhdr->h_vlan_encapsulated_proto;
338 if (ntohs(proto) >= 1536) {
339 skb->protocol = proto;
340 return;
341 }
342
343 rawp = skb->data;
344 if (*(unsigned short *) rawp == 0xFFFF)
345 /*
346 * This is a magic hack to spot IPX packets. Older Novell
347 * breaks the protocol design and runs IPX over 802.3 without
348 * an 802.2 LLC layer. We look for FFFF which isn't a used
349 * 802.2 SSAP/DSAP. This won't work for fault tolerant netware
350 * but does for the rest.
351 */
352 skb->protocol = htons(ETH_P_802_3);
353 else
354 /*
355 * Real 802.2 LLC
356 */
357 skb->protocol = htons(ETH_P_802_2);
358}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359#endif /* __KERNEL__ */
360
361/* VLAN IOCTLs are found in sockios.h */
362
363/* Passed in vlan_ioctl_args structure to determine behaviour. */
364enum vlan_ioctl_cmds {
365 ADD_VLAN_CMD,
366 DEL_VLAN_CMD,
367 SET_VLAN_INGRESS_PRIORITY_CMD,
368 SET_VLAN_EGRESS_PRIORITY_CMD,
369 GET_VLAN_INGRESS_PRIORITY_CMD,
370 GET_VLAN_EGRESS_PRIORITY_CMD,
371 SET_VLAN_NAME_TYPE_CMD,
372 SET_VLAN_FLAG_CMD,
373 GET_VLAN_REALDEV_NAME_CMD, /* If this works, you know it's a VLAN device, btw */
374 GET_VLAN_VID_CMD /* Get the VID of this VLAN (specified by name) */
375};
376
Patrick McHardya4bf3af42007-06-13 12:07:37 -0700377enum vlan_flags {
378 VLAN_FLAG_REORDER_HDR = 0x1,
Patrick McHardy70c03b42008-07-05 21:26:57 -0700379 VLAN_FLAG_GVRP = 0x2,
Patrick McHardy5e756592009-11-25 07:54:54 +0000380 VLAN_FLAG_LOOSE_BINDING = 0x4,
Patrick McHardya4bf3af42007-06-13 12:07:37 -0700381};
382
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383enum vlan_name_types {
384 VLAN_NAME_TYPE_PLUS_VID, /* Name will look like: vlan0005 */
385 VLAN_NAME_TYPE_RAW_PLUS_VID, /* name will look like: eth1.0005 */
386 VLAN_NAME_TYPE_PLUS_VID_NO_PAD, /* Name will look like: vlan5 */
387 VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD, /* Name will look like: eth0.5 */
388 VLAN_NAME_TYPE_HIGHEST
389};
390
391struct vlan_ioctl_args {
392 int cmd; /* Should be one of the vlan_ioctl_cmds enum above. */
393 char device1[24];
394
395 union {
396 char device2[24];
397 int VID;
398 unsigned int skb_priority;
399 unsigned int name_type;
400 unsigned int bind_type;
Jiri Pirko7da82c02011-12-08 04:11:15 +0000401 unsigned int flag; /* Matches vlan_dev_priv flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 } u;
403
404 short vlan_qos;
405};
406
407#endif /* !(_LINUX_IF_VLAN_H_) */