[VLAN]: Simplify vlan unregistration
[deliverable/linux.git] / include / linux / if_vlan.h
CommitLineData
1da177e4
LT
1/*
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__
17
18/* externally defined structs */
1da177e4
LT
19struct hlist_node;
20
1da177e4 21#include <linux/netdevice.h>
0610d11b 22#include <linux/etherdevice.h>
1da177e4
LT
23
24#define VLAN_HLEN 4 /* The additional bytes (on top of the Ethernet header)
25 * that VLAN requires.
26 */
27#define VLAN_ETH_ALEN 6 /* Octets in one ethernet addr */
28#define VLAN_ETH_HLEN 18 /* Total octets in header. */
29#define VLAN_ETH_ZLEN 64 /* Min. octets in frame sans FCS */
30
31/*
32 * According to 802.3ac, the packet can be 4 bytes longer. --Klika Jan
33 */
34#define VLAN_ETH_DATA_LEN 1500 /* Max. octets in payload */
35#define VLAN_ETH_FRAME_LEN 1518 /* Max. octets in frame sans FCS */
36
740c15d0
PM
37/*
38 * struct vlan_hdr - vlan header
39 * @h_vlan_TCI: priority and VLAN ID
40 * @h_vlan_encapsulated_proto: packet type ID or len
41 */
42struct vlan_hdr {
43 __be16 h_vlan_TCI;
44 __be16 h_vlan_encapsulated_proto;
45};
46
47/**
48 * struct vlan_ethhdr - vlan ethernet header (ethhdr + vlan_hdr)
49 * @h_dest: destination ethernet address
50 * @h_source: source ethernet address
51 * @h_vlan_proto: ethernet protocol (always 0x8100)
52 * @h_vlan_TCI: priority and VLAN ID
53 * @h_vlan_encapsulated_proto: packet type ID or len
54 */
1da177e4 55struct vlan_ethhdr {
740c15d0
PM
56 unsigned char h_dest[ETH_ALEN];
57 unsigned char h_source[ETH_ALEN];
58 __be16 h_vlan_proto;
59 __be16 h_vlan_TCI;
60 __be16 h_vlan_encapsulated_proto;
1da177e4
LT
61};
62
63#include <linux/skbuff.h>
64
65static inline struct vlan_ethhdr *vlan_eth_hdr(const struct sk_buff *skb)
66{
98e399f8 67 return (struct vlan_ethhdr *)skb_mac_header(skb);
1da177e4
LT
68}
69
1da177e4
LT
70#define VLAN_VID_MASK 0xfff
71
72/* found in socket.c */
881d966b 73extern void vlan_ioctl_set(int (*hook)(struct net *, void __user *));
1da177e4 74
1da177e4
LT
75/* if this changes, algorithm will have to be reworked because this
76 * depends on completely exhausting the VLAN identifier space. Thus
77 * it gives constant time look-up, but in many cases it wastes memory.
78 */
5c15bdec
DA
79#define VLAN_GROUP_ARRAY_LEN 4096
80#define VLAN_GROUP_ARRAY_SPLIT_PARTS 8
81#define VLAN_GROUP_ARRAY_PART_LEN (VLAN_GROUP_ARRAY_LEN/VLAN_GROUP_ARRAY_SPLIT_PARTS)
1da177e4
LT
82
83struct vlan_group {
84 int real_dev_ifindex; /* The ifindex of the ethernet(like) device the vlan is attached to. */
af301517 85 unsigned int nr_vlans;
1da177e4 86 struct hlist_node hlist; /* linked list */
5c15bdec 87 struct net_device **vlan_devices_arrays[VLAN_GROUP_ARRAY_SPLIT_PARTS];
1da177e4
LT
88 struct rcu_head rcu;
89};
90
f0b5a0dc
ED
91static inline struct net_device *vlan_group_get_device(struct vlan_group *vg,
92 unsigned int vlan_id)
5c15bdec
DA
93{
94 struct net_device **array;
95 array = vg->vlan_devices_arrays[vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
96 return array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN];
97}
98
f0b5a0dc
ED
99static inline void vlan_group_set_device(struct vlan_group *vg,
100 unsigned int vlan_id,
5c15bdec
DA
101 struct net_device *dev)
102{
103 struct net_device **array;
104 if (!vg)
105 return;
106 array = vg->vlan_devices_arrays[vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
107 array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] = dev;
108}
109
1da177e4 110struct vlan_priority_tci_mapping {
734423cf 111 u32 priority;
1da177e4
LT
112 unsigned short vlan_qos; /* This should be shifted when first set, so we only do it
113 * at provisioning time.
114 * ((skb->priority << 13) & 0xE000)
115 */
116 struct vlan_priority_tci_mapping *next;
117};
118
119/* Holds information that makes sense if this device is a VLAN device. */
120struct vlan_dev_info {
121 /** This will be the mapping that correlates skb->priority to
122 * 3 bits of VLAN QOS tags...
123 */
b020cb48 124 unsigned int nr_ingress_mappings;
734423cf 125 u32 ingress_priority_map[8];
b020cb48
PM
126
127 unsigned int nr_egress_mappings;
1da177e4
LT
128 struct vlan_priority_tci_mapping *egress_priority_map[16]; /* hash table */
129
130 unsigned short vlan_id; /* The VLAN Identifier for this interface. */
131 unsigned short flags; /* (1 << 0) re_order_header This option will cause the
132 * VLAN code to move around the ethernet header on
133 * ingress to make the skb look **exactly** like it
134 * came in from an ethernet port. This destroys some of
135 * the VLAN information in the skb, but it fixes programs
136 * like DHCP that use packet-filtering and don't understand
137 * 802.1Q
138 */
1da177e4 139 struct net_device *real_dev; /* the underlying device/interface */
8c979c26 140 unsigned char real_dev_addr[ETH_ALEN];
1da177e4
LT
141 struct proc_dir_entry *dent; /* Holds the proc data */
142 unsigned long cnt_inc_headroom_on_tx; /* How many times did we have to grow the skb on TX. */
143 unsigned long cnt_encap_on_xmit; /* How many times did we have to encapsulate the skb on TX. */
1da177e4
LT
144};
145
146#define VLAN_DEV_INFO(x) ((struct vlan_dev_info *)(x->priv))
147
148/* inline functions */
1da177e4
LT
149static inline __u32 vlan_get_ingress_priority(struct net_device *dev,
150 unsigned short vlan_tag)
151{
152 struct vlan_dev_info *vip = VLAN_DEV_INFO(dev);
153
154 return vip->ingress_priority_map[(vlan_tag >> 13) & 0x7];
155}
156
157/* VLAN tx hw acceleration helpers. */
158struct vlan_skb_tx_cookie {
159 u32 magic;
160 u32 vlan_tag;
161};
162
163#define VLAN_TX_COOKIE_MAGIC 0x564c414e /* "VLAN" in ascii. */
164#define VLAN_TX_SKB_CB(__skb) ((struct vlan_skb_tx_cookie *)&((__skb)->cb[0]))
165#define vlan_tx_tag_present(__skb) \
166 (VLAN_TX_SKB_CB(__skb)->magic == VLAN_TX_COOKIE_MAGIC)
167#define vlan_tx_tag_get(__skb) (VLAN_TX_SKB_CB(__skb)->vlan_tag)
168
169/* VLAN rx hw acceleration helper. This acts like netif_{rx,receive_skb}(). */
170static inline int __vlan_hwaccel_rx(struct sk_buff *skb,
171 struct vlan_group *grp,
172 unsigned short vlan_tag, int polling)
173{
174 struct net_device_stats *stats;
175
7ea49ed7
DM
176 if (skb_bond_should_drop(skb)) {
177 dev_kfree_skb_any(skb);
178 return NET_RX_DROP;
179 }
180
5c15bdec 181 skb->dev = vlan_group_get_device(grp, vlan_tag & VLAN_VID_MASK);
1da177e4
LT
182 if (skb->dev == NULL) {
183 dev_kfree_skb_any(skb);
184
185 /* Not NET_RX_DROP, this is not being dropped
186 * due to congestion.
187 */
188 return 0;
189 }
190
191 skb->dev->last_rx = jiffies;
192
7bd38d77 193 stats = &skb->dev->stats;
1da177e4
LT
194 stats->rx_packets++;
195 stats->rx_bytes += skb->len;
196
197 skb->priority = vlan_get_ingress_priority(skb->dev, vlan_tag);
198 switch (skb->pkt_type) {
199 case PACKET_BROADCAST:
200 break;
201
202 case PACKET_MULTICAST:
203 stats->multicast++;
204 break;
205
206 case PACKET_OTHERHOST:
207 /* Our lower layer thinks this is not local, let's make sure.
208 * This allows the VLAN to have a different MAC than the underlying
209 * device, and still route correctly.
210 */
0610d11b
SH
211 if (!compare_ether_addr(eth_hdr(skb)->h_dest,
212 skb->dev->dev_addr))
1da177e4
LT
213 skb->pkt_type = PACKET_HOST;
214 break;
215 };
216
217 return (polling ? netif_receive_skb(skb) : netif_rx(skb));
218}
219
220static inline int vlan_hwaccel_rx(struct sk_buff *skb,
221 struct vlan_group *grp,
222 unsigned short vlan_tag)
223{
224 return __vlan_hwaccel_rx(skb, grp, vlan_tag, 0);
225}
226
227static inline int vlan_hwaccel_receive_skb(struct sk_buff *skb,
228 struct vlan_group *grp,
229 unsigned short vlan_tag)
230{
231 return __vlan_hwaccel_rx(skb, grp, vlan_tag, 1);
232}
233
234/**
235 * __vlan_put_tag - regular VLAN tag inserting
236 * @skb: skbuff to tag
237 * @tag: VLAN tag to insert
238 *
239 * Inserts the VLAN tag into @skb as part of the payload
240 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
241 *
242 * Following the skb_unshare() example, in case of error, the calling function
243 * doesn't have to worry about freeing the original skb.
244 */
245static inline struct sk_buff *__vlan_put_tag(struct sk_buff *skb, unsigned short tag)
246{
247 struct vlan_ethhdr *veth;
248
249 if (skb_headroom(skb) < VLAN_HLEN) {
250 struct sk_buff *sk_tmp = skb;
251 skb = skb_realloc_headroom(sk_tmp, VLAN_HLEN);
252 kfree_skb(sk_tmp);
253 if (!skb) {
254 printk(KERN_ERR "vlan: failed to realloc headroom\n");
255 return NULL;
256 }
257 } else {
258 skb = skb_unshare(skb, GFP_ATOMIC);
259 if (!skb) {
260 printk(KERN_ERR "vlan: failed to unshare skbuff\n");
261 return NULL;
262 }
263 }
264
265 veth = (struct vlan_ethhdr *)skb_push(skb, VLAN_HLEN);
266
267 /* Move the mac addresses to the beginning of the new header. */
268 memmove(skb->data, skb->data + VLAN_HLEN, 2 * VLAN_ETH_ALEN);
269
270 /* first, the ethernet type */
271 veth->h_vlan_proto = __constant_htons(ETH_P_8021Q);
272
273 /* now, the tag */
274 veth->h_vlan_TCI = htons(tag);
275
276 skb->protocol = __constant_htons(ETH_P_8021Q);
b0e380b1
ACM
277 skb->mac_header -= VLAN_HLEN;
278 skb->network_header -= VLAN_HLEN;
1da177e4
LT
279
280 return skb;
281}
282
283/**
284 * __vlan_hwaccel_put_tag - hardware accelerated VLAN inserting
285 * @skb: skbuff to tag
286 * @tag: VLAN tag to insert
287 *
288 * Puts the VLAN tag in @skb->cb[] and lets the device do the rest
289 */
290static inline struct sk_buff *__vlan_hwaccel_put_tag(struct sk_buff *skb, unsigned short tag)
291{
292 struct vlan_skb_tx_cookie *cookie;
293
294 cookie = VLAN_TX_SKB_CB(skb);
295 cookie->magic = VLAN_TX_COOKIE_MAGIC;
296 cookie->vlan_tag = tag;
297
298 return skb;
299}
300
301#define HAVE_VLAN_PUT_TAG
302
303/**
304 * vlan_put_tag - inserts VLAN tag according to device features
305 * @skb: skbuff to tag
306 * @tag: VLAN tag to insert
307 *
308 * Assumes skb->dev is the target that will xmit this frame.
309 * Returns a VLAN tagged skb.
310 */
311static inline struct sk_buff *vlan_put_tag(struct sk_buff *skb, unsigned short tag)
312{
313 if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
314 return __vlan_hwaccel_put_tag(skb, tag);
315 } else {
316 return __vlan_put_tag(skb, tag);
317 }
318}
319
320/**
321 * __vlan_get_tag - get the VLAN ID that is part of the payload
322 * @skb: skbuff to query
323 * @tag: buffer to store vlaue
324 *
325 * Returns error if the skb is not of VLAN type
326 */
327static inline int __vlan_get_tag(struct sk_buff *skb, unsigned short *tag)
328{
329 struct vlan_ethhdr *veth = (struct vlan_ethhdr *)skb->data;
330
331 if (veth->h_vlan_proto != __constant_htons(ETH_P_8021Q)) {
332 return -EINVAL;
333 }
334
335 *tag = ntohs(veth->h_vlan_TCI);
336
337 return 0;
338}
339
340/**
341 * __vlan_hwaccel_get_tag - get the VLAN ID that is in @skb->cb[]
342 * @skb: skbuff to query
343 * @tag: buffer to store vlaue
344 *
345 * Returns error if @skb->cb[] is not set correctly
346 */
347static inline int __vlan_hwaccel_get_tag(struct sk_buff *skb, unsigned short *tag)
348{
349 struct vlan_skb_tx_cookie *cookie;
350
351 cookie = VLAN_TX_SKB_CB(skb);
352 if (cookie->magic == VLAN_TX_COOKIE_MAGIC) {
353 *tag = cookie->vlan_tag;
354 return 0;
355 } else {
356 *tag = 0;
357 return -EINVAL;
358 }
359}
360
361#define HAVE_VLAN_GET_TAG
362
363/**
364 * vlan_get_tag - get the VLAN ID from the skb
365 * @skb: skbuff to query
366 * @tag: buffer to store vlaue
367 *
368 * Returns error if the skb is not VLAN tagged
369 */
370static inline int vlan_get_tag(struct sk_buff *skb, unsigned short *tag)
371{
372 if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
373 return __vlan_hwaccel_get_tag(skb, tag);
374 } else {
375 return __vlan_get_tag(skb, tag);
376 }
377}
378
379#endif /* __KERNEL__ */
380
381/* VLAN IOCTLs are found in sockios.h */
382
383/* Passed in vlan_ioctl_args structure to determine behaviour. */
384enum vlan_ioctl_cmds {
385 ADD_VLAN_CMD,
386 DEL_VLAN_CMD,
387 SET_VLAN_INGRESS_PRIORITY_CMD,
388 SET_VLAN_EGRESS_PRIORITY_CMD,
389 GET_VLAN_INGRESS_PRIORITY_CMD,
390 GET_VLAN_EGRESS_PRIORITY_CMD,
391 SET_VLAN_NAME_TYPE_CMD,
392 SET_VLAN_FLAG_CMD,
393 GET_VLAN_REALDEV_NAME_CMD, /* If this works, you know it's a VLAN device, btw */
394 GET_VLAN_VID_CMD /* Get the VID of this VLAN (specified by name) */
395};
396
a4bf3af4
PM
397enum vlan_flags {
398 VLAN_FLAG_REORDER_HDR = 0x1,
399};
400
1da177e4
LT
401enum vlan_name_types {
402 VLAN_NAME_TYPE_PLUS_VID, /* Name will look like: vlan0005 */
403 VLAN_NAME_TYPE_RAW_PLUS_VID, /* name will look like: eth1.0005 */
404 VLAN_NAME_TYPE_PLUS_VID_NO_PAD, /* Name will look like: vlan5 */
405 VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD, /* Name will look like: eth0.5 */
406 VLAN_NAME_TYPE_HIGHEST
407};
408
409struct vlan_ioctl_args {
410 int cmd; /* Should be one of the vlan_ioctl_cmds enum above. */
411 char device1[24];
412
413 union {
414 char device2[24];
415 int VID;
416 unsigned int skb_priority;
417 unsigned int name_type;
418 unsigned int bind_type;
419 unsigned int flag; /* Matches vlan_dev_info flags */
420 } u;
421
422 short vlan_qos;
423};
424
425#endif /* !(_LINUX_IF_VLAN_H_) */
This page took 0.569396 seconds and 5 git commands to generate.