]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/linux/if_vlan.h
tipc: Optimization to multicast name lookup algorithm
[mirror_ubuntu-artful-kernel.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__
1da177e4 17#include <linux/netdevice.h>
0610d11b 18#include <linux/etherdevice.h>
1da177e4
LT
19
20#define VLAN_HLEN 4 /* The additional bytes (on top of the Ethernet header)
21 * that VLAN requires.
22 */
23#define VLAN_ETH_ALEN 6 /* Octets in one ethernet addr */
24#define VLAN_ETH_HLEN 18 /* Total octets in header. */
25#define VLAN_ETH_ZLEN 64 /* Min. octets in frame sans FCS */
26
27/*
28 * According to 802.3ac, the packet can be 4 bytes longer. --Klika Jan
29 */
30#define VLAN_ETH_DATA_LEN 1500 /* Max. octets in payload */
31#define VLAN_ETH_FRAME_LEN 1518 /* Max. octets in frame sans FCS */
32
740c15d0
PM
33/*
34 * struct vlan_hdr - vlan header
35 * @h_vlan_TCI: priority and VLAN ID
36 * @h_vlan_encapsulated_proto: packet type ID or len
37 */
38struct vlan_hdr {
39 __be16 h_vlan_TCI;
40 __be16 h_vlan_encapsulated_proto;
41};
42
43/**
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 (always 0x8100)
48 * @h_vlan_TCI: priority and VLAN ID
49 * @h_vlan_encapsulated_proto: packet type ID or len
50 */
1da177e4 51struct vlan_ethhdr {
740c15d0
PM
52 unsigned char h_dest[ETH_ALEN];
53 unsigned char h_source[ETH_ALEN];
54 __be16 h_vlan_proto;
55 __be16 h_vlan_TCI;
56 __be16 h_vlan_encapsulated_proto;
1da177e4
LT
57};
58
59#include <linux/skbuff.h>
60
61static inline struct vlan_ethhdr *vlan_eth_hdr(const struct sk_buff *skb)
62{
98e399f8 63 return (struct vlan_ethhdr *)skb_mac_header(skb);
1da177e4
LT
64}
65
1da177e4
LT
66#define VLAN_VID_MASK 0xfff
67
68/* found in socket.c */
881d966b 69extern void vlan_ioctl_set(int (*hook)(struct net *, void __user *));
1da177e4 70
1da177e4
LT
71/* if this changes, algorithm will have to be reworked because this
72 * depends on completely exhausting the VLAN identifier space. Thus
73 * it gives constant time look-up, but in many cases it wastes memory.
74 */
5c15bdec
DA
75#define VLAN_GROUP_ARRAY_LEN 4096
76#define VLAN_GROUP_ARRAY_SPLIT_PARTS 8
77#define VLAN_GROUP_ARRAY_PART_LEN (VLAN_GROUP_ARRAY_LEN/VLAN_GROUP_ARRAY_SPLIT_PARTS)
1da177e4
LT
78
79struct vlan_group {
a9fde260
PE
80 struct net_device *real_dev; /* The ethernet(like) device
81 * the vlan is attached to.
82 */
af301517 83 unsigned int nr_vlans;
1da177e4 84 struct hlist_node hlist; /* linked list */
5c15bdec 85 struct net_device **vlan_devices_arrays[VLAN_GROUP_ARRAY_SPLIT_PARTS];
1da177e4
LT
86 struct rcu_head rcu;
87};
88
f0b5a0dc 89static inline struct net_device *vlan_group_get_device(struct vlan_group *vg,
9bb8582e 90 u16 vlan_id)
5c15bdec
DA
91{
92 struct net_device **array;
93 array = vg->vlan_devices_arrays[vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
67727184 94 return array ? array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] : NULL;
5c15bdec
DA
95}
96
f0b5a0dc 97static inline void vlan_group_set_device(struct vlan_group *vg,
9bb8582e 98 u16 vlan_id,
5c15bdec
DA
99 struct net_device *dev)
100{
101 struct net_device **array;
102 if (!vg)
103 return;
104 array = vg->vlan_devices_arrays[vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
105 array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] = dev;
106}
107
1da177e4
LT
108/* VLAN tx hw acceleration helpers. */
109struct vlan_skb_tx_cookie {
110 u32 magic;
111 u32 vlan_tag;
112};
113
114#define VLAN_TX_COOKIE_MAGIC 0x564c414e /* "VLAN" in ascii. */
115#define VLAN_TX_SKB_CB(__skb) ((struct vlan_skb_tx_cookie *)&((__skb)->cb[0]))
116#define vlan_tx_tag_present(__skb) \
117 (VLAN_TX_SKB_CB(__skb)->magic == VLAN_TX_COOKIE_MAGIC)
118#define vlan_tx_tag_get(__skb) (VLAN_TX_SKB_CB(__skb)->vlan_tag)
119
7750f403 120#if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
22d1ba74
PM
121extern struct net_device *vlan_dev_real_dev(const struct net_device *dev);
122extern u16 vlan_dev_vlan_id(const struct net_device *dev);
123
7750f403 124extern int __vlan_hwaccel_rx(struct sk_buff *skb, struct vlan_group *grp,
9bb8582e 125 u16 vlan_tci, int polling);
7750f403 126#else
22d1ba74
PM
127static inline struct net_device *vlan_dev_real_dev(const struct net_device *dev)
128{
129 BUG();
130 return NULL;
131}
132
133static inline u16 vlan_dev_vlan_id(const struct net_device *dev)
134{
135 BUG();
136 return 0;
137}
138
7750f403 139static inline int __vlan_hwaccel_rx(struct sk_buff *skb, struct vlan_group *grp,
9bb8582e 140 u16 vlan_tci, int polling)
1da177e4 141{
7750f403
PM
142 BUG();
143 return NET_XMIT_SUCCESS;
1da177e4 144}
7750f403 145#endif
1da177e4 146
9bb8582e
PM
147/**
148 * vlan_hwaccel_rx - netif_rx wrapper for VLAN RX acceleration
149 * @skb: buffer
150 * @grp: vlan group
151 * @vlan_tci: VLAN TCI as received from the card
152 */
1da177e4
LT
153static inline int vlan_hwaccel_rx(struct sk_buff *skb,
154 struct vlan_group *grp,
9bb8582e 155 u16 vlan_tci)
1da177e4 156{
9bb8582e 157 return __vlan_hwaccel_rx(skb, grp, vlan_tci, 0);
1da177e4
LT
158}
159
9bb8582e
PM
160/**
161 * vlan_hwaccel_receive_skb - netif_receive_skb wrapper for VLAN RX acceleration
162 * @skb: buffer
163 * @grp: vlan group
164 * @vlan_tci: VLAN TCI as received from the card
165 */
1da177e4
LT
166static inline int vlan_hwaccel_receive_skb(struct sk_buff *skb,
167 struct vlan_group *grp,
9bb8582e 168 u16 vlan_tci)
1da177e4 169{
9bb8582e 170 return __vlan_hwaccel_rx(skb, grp, vlan_tci, 1);
1da177e4
LT
171}
172
173/**
174 * __vlan_put_tag - regular VLAN tag inserting
175 * @skb: skbuff to tag
9bb8582e 176 * @vlan_tci: VLAN TCI to insert
1da177e4
LT
177 *
178 * Inserts the VLAN tag into @skb as part of the payload
179 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
9bb8582e 180 *
1da177e4
LT
181 * Following the skb_unshare() example, in case of error, the calling function
182 * doesn't have to worry about freeing the original skb.
183 */
9bb8582e 184static inline struct sk_buff *__vlan_put_tag(struct sk_buff *skb, u16 vlan_tci)
1da177e4
LT
185{
186 struct vlan_ethhdr *veth;
187
11a100f8
PM
188 if (skb_cow_head(skb, VLAN_HLEN) < 0) {
189 kfree_skb(skb);
190 return NULL;
1da177e4 191 }
1da177e4
LT
192 veth = (struct vlan_ethhdr *)skb_push(skb, VLAN_HLEN);
193
194 /* Move the mac addresses to the beginning of the new header. */
195 memmove(skb->data, skb->data + VLAN_HLEN, 2 * VLAN_ETH_ALEN);
196
197 /* first, the ethernet type */
57d3ae84 198 veth->h_vlan_proto = htons(ETH_P_8021Q);
1da177e4 199
9bb8582e
PM
200 /* now, the TCI */
201 veth->h_vlan_TCI = htons(vlan_tci);
1da177e4 202
57d3ae84 203 skb->protocol = htons(ETH_P_8021Q);
1da177e4
LT
204
205 return skb;
206}
207
208/**
209 * __vlan_hwaccel_put_tag - hardware accelerated VLAN inserting
210 * @skb: skbuff to tag
9bb8582e 211 * @vlan_tci: VLAN TCI to insert
1da177e4 212 *
9bb8582e 213 * Puts the VLAN TCI in @skb->cb[] and lets the device do the rest
1da177e4 214 */
9bb8582e
PM
215static inline struct sk_buff *__vlan_hwaccel_put_tag(struct sk_buff *skb,
216 u16 vlan_tci)
1da177e4
LT
217{
218 struct vlan_skb_tx_cookie *cookie;
219
220 cookie = VLAN_TX_SKB_CB(skb);
221 cookie->magic = VLAN_TX_COOKIE_MAGIC;
9bb8582e 222 cookie->vlan_tag = vlan_tci;
1da177e4
LT
223
224 return skb;
225}
226
227#define HAVE_VLAN_PUT_TAG
228
229/**
230 * vlan_put_tag - inserts VLAN tag according to device features
231 * @skb: skbuff to tag
9bb8582e 232 * @vlan_tci: VLAN TCI to insert
1da177e4
LT
233 *
234 * Assumes skb->dev is the target that will xmit this frame.
235 * Returns a VLAN tagged skb.
236 */
9bb8582e 237static inline struct sk_buff *vlan_put_tag(struct sk_buff *skb, u16 vlan_tci)
1da177e4
LT
238{
239 if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
9bb8582e 240 return __vlan_hwaccel_put_tag(skb, vlan_tci);
1da177e4 241 } else {
9bb8582e 242 return __vlan_put_tag(skb, vlan_tci);
1da177e4
LT
243 }
244}
245
246/**
247 * __vlan_get_tag - get the VLAN ID that is part of the payload
248 * @skb: skbuff to query
9bb8582e
PM
249 * @vlan_tci: buffer to store vlaue
250 *
1da177e4
LT
251 * Returns error if the skb is not of VLAN type
252 */
9bb8582e 253static inline int __vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
1da177e4
LT
254{
255 struct vlan_ethhdr *veth = (struct vlan_ethhdr *)skb->data;
256
57d3ae84 257 if (veth->h_vlan_proto != htons(ETH_P_8021Q)) {
1da177e4
LT
258 return -EINVAL;
259 }
260
9bb8582e 261 *vlan_tci = ntohs(veth->h_vlan_TCI);
1da177e4
LT
262 return 0;
263}
264
265/**
266 * __vlan_hwaccel_get_tag - get the VLAN ID that is in @skb->cb[]
267 * @skb: skbuff to query
9bb8582e
PM
268 * @vlan_tci: buffer to store vlaue
269 *
1da177e4
LT
270 * Returns error if @skb->cb[] is not set correctly
271 */
18149935 272static inline int __vlan_hwaccel_get_tag(const struct sk_buff *skb,
9bb8582e 273 u16 *vlan_tci)
1da177e4
LT
274{
275 struct vlan_skb_tx_cookie *cookie;
276
277 cookie = VLAN_TX_SKB_CB(skb);
278 if (cookie->magic == VLAN_TX_COOKIE_MAGIC) {
9bb8582e 279 *vlan_tci = cookie->vlan_tag;
1da177e4
LT
280 return 0;
281 } else {
9bb8582e 282 *vlan_tci = 0;
1da177e4
LT
283 return -EINVAL;
284 }
285}
286
287#define HAVE_VLAN_GET_TAG
288
289/**
290 * vlan_get_tag - get the VLAN ID from the skb
291 * @skb: skbuff to query
9bb8582e
PM
292 * @vlan_tci: buffer to store vlaue
293 *
1da177e4
LT
294 * Returns error if the skb is not VLAN tagged
295 */
9bb8582e 296static inline int vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
1da177e4
LT
297{
298 if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
9bb8582e 299 return __vlan_hwaccel_get_tag(skb, vlan_tci);
1da177e4 300 } else {
9bb8582e 301 return __vlan_get_tag(skb, vlan_tci);
1da177e4
LT
302 }
303}
304
305#endif /* __KERNEL__ */
306
307/* VLAN IOCTLs are found in sockios.h */
308
309/* Passed in vlan_ioctl_args structure to determine behaviour. */
310enum vlan_ioctl_cmds {
311 ADD_VLAN_CMD,
312 DEL_VLAN_CMD,
313 SET_VLAN_INGRESS_PRIORITY_CMD,
314 SET_VLAN_EGRESS_PRIORITY_CMD,
315 GET_VLAN_INGRESS_PRIORITY_CMD,
316 GET_VLAN_EGRESS_PRIORITY_CMD,
317 SET_VLAN_NAME_TYPE_CMD,
318 SET_VLAN_FLAG_CMD,
319 GET_VLAN_REALDEV_NAME_CMD, /* If this works, you know it's a VLAN device, btw */
320 GET_VLAN_VID_CMD /* Get the VID of this VLAN (specified by name) */
321};
322
a4bf3af4
PM
323enum vlan_flags {
324 VLAN_FLAG_REORDER_HDR = 0x1,
70c03b49 325 VLAN_FLAG_GVRP = 0x2,
a4bf3af4
PM
326};
327
1da177e4
LT
328enum vlan_name_types {
329 VLAN_NAME_TYPE_PLUS_VID, /* Name will look like: vlan0005 */
330 VLAN_NAME_TYPE_RAW_PLUS_VID, /* name will look like: eth1.0005 */
331 VLAN_NAME_TYPE_PLUS_VID_NO_PAD, /* Name will look like: vlan5 */
332 VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD, /* Name will look like: eth0.5 */
333 VLAN_NAME_TYPE_HIGHEST
334};
335
336struct vlan_ioctl_args {
337 int cmd; /* Should be one of the vlan_ioctl_cmds enum above. */
338 char device1[24];
339
340 union {
341 char device2[24];
342 int VID;
343 unsigned int skb_priority;
344 unsigned int name_type;
345 unsigned int bind_type;
346 unsigned int flag; /* Matches vlan_dev_info flags */
347 } u;
348
349 short vlan_qos;
350};
351
352#endif /* !(_LINUX_IF_VLAN_H_) */