vlan: introduce __vlan_find_dev_deep()
[linux-2.6.git] / include / linux / if_vlan.h
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 #include <linux/netdevice.h>
18 #include <linux/etherdevice.h>
19 #include <linux/rtnetlink.h>
20
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
34 /*
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  */
39 struct 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  */
52 struct vlan_ethhdr {
53         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;
58 };
59
60 #include <linux/skbuff.h>
61
62 static inline struct vlan_ethhdr *vlan_eth_hdr(const struct sk_buff *skb)
63 {
64         return (struct vlan_ethhdr *)skb_mac_header(skb);
65 }
66
67 #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 */
72 #define VLAN_N_VID              4096
73
74 /* found in socket.c */
75 extern void vlan_ioctl_set(int (*hook)(struct net *, void __user *));
76
77 /* if this changes, algorithm will have to be reworked because this
78  * depends on completely exhausting the VLAN identifier space.  Thus
79  * it gives constant time look-up, but in many cases it wastes memory.
80  */
81 #define VLAN_GROUP_ARRAY_SPLIT_PARTS  8
82 #define VLAN_GROUP_ARRAY_PART_LEN     (VLAN_N_VID/VLAN_GROUP_ARRAY_SPLIT_PARTS)
83
84 struct vlan_group {
85         struct net_device       *real_dev; /* The ethernet(like) device
86                                             * the vlan is attached to.
87                                             */
88         unsigned int            nr_vlans;
89         struct hlist_node       hlist;  /* linked list */
90         struct net_device **vlan_devices_arrays[VLAN_GROUP_ARRAY_SPLIT_PARTS];
91         struct rcu_head         rcu;
92 };
93
94 static inline struct net_device *vlan_group_get_device(struct vlan_group *vg,
95                                                        u16 vlan_id)
96 {
97         struct net_device **array;
98         array = vg->vlan_devices_arrays[vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
99         return array ? array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] : NULL;
100 }
101
102 static inline void vlan_group_set_device(struct vlan_group *vg,
103                                          u16 vlan_id,
104                                          struct net_device *dev)
105 {
106         struct net_device **array;
107         if (!vg)
108                 return;
109         array = vg->vlan_devices_arrays[vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
110         array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] = dev;
111 }
112
113 static inline int is_vlan_dev(struct net_device *dev)
114 {
115         return dev->priv_flags & IFF_802_1Q_VLAN;
116 }
117
118 #define vlan_tx_tag_present(__skb)      ((__skb)->vlan_tci & VLAN_TAG_PRESENT)
119 #define vlan_tx_tag_get(__skb)          ((__skb)->vlan_tci & ~VLAN_TAG_PRESENT)
120
121 #if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
122
123 extern struct net_device *__vlan_find_dev_deep(struct net_device *real_dev,
124                                                u16 vlan_id);
125 extern struct net_device *vlan_dev_real_dev(const struct net_device *dev);
126 extern u16 vlan_dev_vlan_id(const struct net_device *dev);
127
128 extern int __vlan_hwaccel_rx(struct sk_buff *skb, struct vlan_group *grp,
129                              u16 vlan_tci, int polling);
130 extern bool vlan_do_receive(struct sk_buff **skb);
131 extern struct sk_buff *vlan_untag(struct sk_buff *skb);
132 extern gro_result_t
133 vlan_gro_receive(struct napi_struct *napi, struct vlan_group *grp,
134                  unsigned int vlan_tci, struct sk_buff *skb);
135 extern gro_result_t
136 vlan_gro_frags(struct napi_struct *napi, struct vlan_group *grp,
137                unsigned int vlan_tci);
138
139 #else
140 static inline struct net_device *
141 __vlan_find_dev_deep(struct net_device *real_dev, u16 vlan_id)
142 {
143         return NULL;
144 }
145
146 static inline struct net_device *vlan_dev_real_dev(const struct net_device *dev)
147 {
148         BUG();
149         return NULL;
150 }
151
152 static inline u16 vlan_dev_vlan_id(const struct net_device *dev)
153 {
154         BUG();
155         return 0;
156 }
157
158 static inline int __vlan_hwaccel_rx(struct sk_buff *skb, struct vlan_group *grp,
159                                     u16 vlan_tci, int polling)
160 {
161         BUG();
162         return NET_XMIT_SUCCESS;
163 }
164
165 static inline bool vlan_do_receive(struct sk_buff **skb)
166 {
167         if ((*skb)->vlan_tci & VLAN_VID_MASK)
168                 (*skb)->pkt_type = PACKET_OTHERHOST;
169         return false;
170 }
171
172 static inline struct sk_buff *vlan_untag(struct sk_buff *skb)
173 {
174         return skb;
175 }
176
177 static inline gro_result_t
178 vlan_gro_receive(struct napi_struct *napi, struct vlan_group *grp,
179                  unsigned int vlan_tci, struct sk_buff *skb)
180 {
181         return GRO_DROP;
182 }
183
184 static inline gro_result_t
185 vlan_gro_frags(struct napi_struct *napi, struct vlan_group *grp,
186                unsigned int vlan_tci)
187 {
188         return GRO_DROP;
189 }
190 #endif
191
192 /**
193  * vlan_hwaccel_rx - netif_rx wrapper for VLAN RX acceleration
194  * @skb: buffer
195  * @grp: vlan group
196  * @vlan_tci: VLAN TCI as received from the card
197  */
198 static inline int vlan_hwaccel_rx(struct sk_buff *skb,
199                                   struct vlan_group *grp,
200                                   u16 vlan_tci)
201 {
202         return __vlan_hwaccel_rx(skb, grp, vlan_tci, 0);
203 }
204
205 /**
206  * vlan_hwaccel_receive_skb - netif_receive_skb wrapper for VLAN RX acceleration
207  * @skb: buffer
208  * @grp: vlan group
209  * @vlan_tci: VLAN TCI as received from the card
210  */
211 static inline int vlan_hwaccel_receive_skb(struct sk_buff *skb,
212                                            struct vlan_group *grp,
213                                            u16 vlan_tci)
214 {
215         return __vlan_hwaccel_rx(skb, grp, vlan_tci, 1);
216 }
217
218 /**
219  * vlan_insert_tag - regular VLAN tag inserting
220  * @skb: skbuff to tag
221  * @vlan_tci: VLAN TCI to insert
222  *
223  * Inserts the VLAN tag into @skb as part of the payload
224  * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
225  *
226  * Following the skb_unshare() example, in case of error, the calling function
227  * doesn't have to worry about freeing the original skb.
228  *
229  * Does not change skb->protocol so this function can be used during receive.
230  */
231 static inline struct sk_buff *vlan_insert_tag(struct sk_buff *skb, u16 vlan_tci)
232 {
233         struct vlan_ethhdr *veth;
234
235         if (skb_cow_head(skb, VLAN_HLEN) < 0) {
236                 kfree_skb(skb);
237                 return NULL;
238         }
239         veth = (struct vlan_ethhdr *)skb_push(skb, VLAN_HLEN);
240
241         /* Move the mac addresses to the beginning of the new header. */
242         memmove(skb->data, skb->data + VLAN_HLEN, 2 * VLAN_ETH_ALEN);
243         skb->mac_header -= VLAN_HLEN;
244
245         /* first, the ethernet type */
246         veth->h_vlan_proto = htons(ETH_P_8021Q);
247
248         /* now, the TCI */
249         veth->h_vlan_TCI = htons(vlan_tci);
250
251         return skb;
252 }
253
254 /**
255  * __vlan_put_tag - regular VLAN tag inserting
256  * @skb: skbuff to tag
257  * @vlan_tci: VLAN TCI to insert
258  *
259  * Inserts the VLAN tag into @skb as part of the payload
260  * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
261  *
262  * Following the skb_unshare() example, in case of error, the calling function
263  * doesn't have to worry about freeing the original skb.
264  */
265 static inline struct sk_buff *__vlan_put_tag(struct sk_buff *skb, u16 vlan_tci)
266 {
267         skb = vlan_insert_tag(skb, vlan_tci);
268         if (skb)
269                 skb->protocol = htons(ETH_P_8021Q);
270         return skb;
271 }
272
273 /**
274  * __vlan_hwaccel_put_tag - hardware accelerated VLAN inserting
275  * @skb: skbuff to tag
276  * @vlan_tci: VLAN TCI to insert
277  *
278  * Puts the VLAN TCI in @skb->vlan_tci and lets the device do the rest
279  */
280 static inline struct sk_buff *__vlan_hwaccel_put_tag(struct sk_buff *skb,
281                                                      u16 vlan_tci)
282 {
283         skb->vlan_tci = VLAN_TAG_PRESENT | vlan_tci;
284         return skb;
285 }
286
287 #define HAVE_VLAN_PUT_TAG
288
289 /**
290  * vlan_put_tag - inserts VLAN tag according to device features
291  * @skb: skbuff to tag
292  * @vlan_tci: VLAN TCI to insert
293  *
294  * Assumes skb->dev is the target that will xmit this frame.
295  * Returns a VLAN tagged skb.
296  */
297 static inline struct sk_buff *vlan_put_tag(struct sk_buff *skb, u16 vlan_tci)
298 {
299         if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
300                 return __vlan_hwaccel_put_tag(skb, vlan_tci);
301         } else {
302                 return __vlan_put_tag(skb, vlan_tci);
303         }
304 }
305
306 /**
307  * __vlan_get_tag - get the VLAN ID that is part of the payload
308  * @skb: skbuff to query
309  * @vlan_tci: buffer to store vlaue
310  *
311  * Returns error if the skb is not of VLAN type
312  */
313 static inline int __vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
314 {
315         struct vlan_ethhdr *veth = (struct vlan_ethhdr *)skb->data;
316
317         if (veth->h_vlan_proto != htons(ETH_P_8021Q)) {
318                 return -EINVAL;
319         }
320
321         *vlan_tci = ntohs(veth->h_vlan_TCI);
322         return 0;
323 }
324
325 /**
326  * __vlan_hwaccel_get_tag - get the VLAN ID that is in @skb->cb[]
327  * @skb: skbuff to query
328  * @vlan_tci: buffer to store vlaue
329  *
330  * Returns error if @skb->vlan_tci is not set correctly
331  */
332 static inline int __vlan_hwaccel_get_tag(const struct sk_buff *skb,
333                                          u16 *vlan_tci)
334 {
335         if (vlan_tx_tag_present(skb)) {
336                 *vlan_tci = vlan_tx_tag_get(skb);
337                 return 0;
338         } else {
339                 *vlan_tci = 0;
340                 return -EINVAL;
341         }
342 }
343
344 #define HAVE_VLAN_GET_TAG
345
346 /**
347  * vlan_get_tag - get the VLAN ID from the skb
348  * @skb: skbuff to query
349  * @vlan_tci: buffer to store vlaue
350  *
351  * Returns error if the skb is not VLAN tagged
352  */
353 static inline int vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
354 {
355         if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
356                 return __vlan_hwaccel_get_tag(skb, vlan_tci);
357         } else {
358                 return __vlan_get_tag(skb, vlan_tci);
359         }
360 }
361
362 /**
363  * vlan_get_protocol - get protocol EtherType.
364  * @skb: skbuff to query
365  *
366  * Returns the EtherType of the packet, regardless of whether it is
367  * vlan encapsulated (normal or hardware accelerated) or not.
368  */
369 static inline __be16 vlan_get_protocol(const struct sk_buff *skb)
370 {
371         __be16 protocol = 0;
372
373         if (vlan_tx_tag_present(skb) ||
374              skb->protocol != cpu_to_be16(ETH_P_8021Q))
375                 protocol = skb->protocol;
376         else {
377                 __be16 proto, *protop;
378                 protop = skb_header_pointer(skb, offsetof(struct vlan_ethhdr,
379                                                 h_vlan_encapsulated_proto),
380                                                 sizeof(proto), &proto);
381                 if (likely(protop))
382                         protocol = *protop;
383         }
384
385         return protocol;
386 }
387 #endif /* __KERNEL__ */
388
389 /* VLAN IOCTLs are found in sockios.h */
390
391 /* Passed in vlan_ioctl_args structure to determine behaviour. */
392 enum vlan_ioctl_cmds {
393         ADD_VLAN_CMD,
394         DEL_VLAN_CMD,
395         SET_VLAN_INGRESS_PRIORITY_CMD,
396         SET_VLAN_EGRESS_PRIORITY_CMD,
397         GET_VLAN_INGRESS_PRIORITY_CMD,
398         GET_VLAN_EGRESS_PRIORITY_CMD,
399         SET_VLAN_NAME_TYPE_CMD,
400         SET_VLAN_FLAG_CMD,
401         GET_VLAN_REALDEV_NAME_CMD, /* If this works, you know it's a VLAN device, btw */
402         GET_VLAN_VID_CMD /* Get the VID of this VLAN (specified by name) */
403 };
404
405 enum vlan_flags {
406         VLAN_FLAG_REORDER_HDR   = 0x1,
407         VLAN_FLAG_GVRP          = 0x2,
408         VLAN_FLAG_LOOSE_BINDING = 0x4,
409 };
410
411 enum vlan_name_types {
412         VLAN_NAME_TYPE_PLUS_VID, /* Name will look like:  vlan0005 */
413         VLAN_NAME_TYPE_RAW_PLUS_VID, /* name will look like:  eth1.0005 */
414         VLAN_NAME_TYPE_PLUS_VID_NO_PAD, /* Name will look like:  vlan5 */
415         VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD, /* Name will look like:  eth0.5 */
416         VLAN_NAME_TYPE_HIGHEST
417 };
418
419 struct vlan_ioctl_args {
420         int cmd; /* Should be one of the vlan_ioctl_cmds enum above. */
421         char device1[24];
422
423         union {
424                 char device2[24];
425                 int VID;
426                 unsigned int skb_priority;
427                 unsigned int name_type;
428                 unsigned int bind_type;
429                 unsigned int flag; /* Matches vlan_dev_info flags */
430         } u;
431
432         short vlan_qos;   
433 };
434
435 #endif /* !(_LINUX_IF_VLAN_H_) */