[VLAN]: Tag vlan_group_device with net device, not ifindex.
[linux-2.6/cjktty.git] / net / 8021q / vlan.c
blobcf8d810a130d27cb4f146daf85720cf17ab9c9c1
1 /*
2 * INET 802.1Q VLAN
3 * Ethernet-type device handling.
5 * Authors: Ben Greear <greearb@candelatech.com>
6 * Please send support related email to: netdev@vger.kernel.org
7 * VLAN Home Page: http://www.candelatech.com/~greear/vlan.html
9 * Fixes:
10 * Fix for packet capture - Nick Eggleston <nick@dccinc.com>;
11 * Add HW acceleration hooks - David S. Miller <davem@redhat.com>;
12 * Correct all the locking - David S. Miller <davem@redhat.com>;
13 * Use hash table for VLAN groups - David S. Miller <davem@redhat.com>
15 * This program is free software; you can redistribute it and/or
16 * modify it under the terms of the GNU General Public License
17 * as published by the Free Software Foundation; either version
18 * 2 of the License, or (at your option) any later version.
21 #include <asm/uaccess.h> /* for copy_from_user */
22 #include <linux/capability.h>
23 #include <linux/module.h>
24 #include <linux/netdevice.h>
25 #include <linux/skbuff.h>
26 #include <net/datalink.h>
27 #include <linux/mm.h>
28 #include <linux/in.h>
29 #include <linux/init.h>
30 #include <net/p8022.h>
31 #include <net/arp.h>
32 #include <linux/rtnetlink.h>
33 #include <linux/notifier.h>
34 #include <net/net_namespace.h>
36 #include <linux/if_vlan.h>
37 #include "vlan.h"
38 #include "vlanproc.h"
40 #define DRV_VERSION "1.8"
42 /* Global VLAN variables */
44 /* Our listing of VLAN group(s) */
45 static struct hlist_head vlan_group_hash[VLAN_GRP_HASH_SIZE];
47 static char vlan_fullname[] = "802.1Q VLAN Support";
48 static char vlan_version[] = DRV_VERSION;
49 static char vlan_copyright[] = "Ben Greear <greearb@candelatech.com>";
50 static char vlan_buggyright[] = "David S. Miller <davem@redhat.com>";
52 /* Determines interface naming scheme. */
53 unsigned short vlan_name_type = VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD;
55 static struct packet_type vlan_packet_type = {
56 .type = __constant_htons(ETH_P_8021Q),
57 .func = vlan_skb_recv, /* VLAN receive method */
60 /* End of global variables definitions. */
62 static inline unsigned int vlan_grp_hashfn(unsigned int idx)
64 return ((idx >> VLAN_GRP_HASH_SHIFT) ^ idx) & VLAN_GRP_HASH_MASK;
67 /* Must be invoked with RCU read lock (no preempt) */
68 static struct vlan_group *__vlan_find_group(struct net_device *real_dev)
70 struct vlan_group *grp;
71 struct hlist_node *n;
72 int hash = vlan_grp_hashfn(real_dev->ifindex);
74 hlist_for_each_entry_rcu(grp, n, &vlan_group_hash[hash], hlist) {
75 if (grp->real_dev == real_dev)
76 return grp;
79 return NULL;
82 /* Find the protocol handler. Assumes VID < VLAN_VID_MASK.
84 * Must be invoked with RCU read lock (no preempt)
86 struct net_device *__find_vlan_dev(struct net_device *real_dev,
87 unsigned short VID)
89 struct vlan_group *grp = __vlan_find_group(real_dev);
91 if (grp)
92 return vlan_group_get_device(grp, VID);
94 return NULL;
97 static void vlan_group_free(struct vlan_group *grp)
99 int i;
101 for (i = 0; i < VLAN_GROUP_ARRAY_SPLIT_PARTS; i++)
102 kfree(grp->vlan_devices_arrays[i]);
103 kfree(grp);
106 static struct vlan_group *vlan_group_alloc(struct net_device *real_dev)
108 struct vlan_group *grp;
110 grp = kzalloc(sizeof(struct vlan_group), GFP_KERNEL);
111 if (!grp)
112 return NULL;
114 grp->real_dev = real_dev;
115 hlist_add_head_rcu(&grp->hlist,
116 &vlan_group_hash[vlan_grp_hashfn(real_dev->ifindex)]);
117 return grp;
120 static int vlan_group_prealloc_vid(struct vlan_group *vg, int vid)
122 struct net_device **array;
123 unsigned int size;
125 ASSERT_RTNL();
127 array = vg->vlan_devices_arrays[vid / VLAN_GROUP_ARRAY_PART_LEN];
128 if (array != NULL)
129 return 0;
131 size = sizeof(struct net_device *) * VLAN_GROUP_ARRAY_PART_LEN;
132 array = kzalloc(size, GFP_KERNEL);
133 if (array == NULL)
134 return -ENOBUFS;
136 vg->vlan_devices_arrays[vid / VLAN_GROUP_ARRAY_PART_LEN] = array;
137 return 0;
140 static void vlan_rcu_free(struct rcu_head *rcu)
142 vlan_group_free(container_of(rcu, struct vlan_group, rcu));
145 void unregister_vlan_dev(struct net_device *dev)
147 struct vlan_dev_info *vlan = vlan_dev_info(dev);
148 struct net_device *real_dev = vlan->real_dev;
149 struct vlan_group *grp;
150 unsigned short vlan_id = vlan->vlan_id;
152 ASSERT_RTNL();
154 grp = __vlan_find_group(real_dev);
155 BUG_ON(!grp);
157 vlan_proc_rem_dev(dev);
159 /* Take it out of our own structures, but be sure to interlock with
160 * HW accelerating devices or SW vlan input packet processing.
162 if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
163 real_dev->vlan_rx_kill_vid(real_dev, vlan_id);
165 vlan_group_set_device(grp, vlan_id, NULL);
166 grp->nr_vlans--;
168 synchronize_net();
170 /* If the group is now empty, kill off the group. */
171 if (grp->nr_vlans == 0) {
172 if (real_dev->features & NETIF_F_HW_VLAN_RX)
173 real_dev->vlan_rx_register(real_dev, NULL);
175 hlist_del_rcu(&grp->hlist);
177 /* Free the group, after all cpu's are done. */
178 call_rcu(&grp->rcu, vlan_rcu_free);
181 /* Get rid of the vlan's reference to real_dev */
182 dev_put(real_dev);
184 unregister_netdevice(dev);
187 static void vlan_transfer_operstate(const struct net_device *dev,
188 struct net_device *vlandev)
190 /* Have to respect userspace enforced dormant state
191 * of real device, also must allow supplicant running
192 * on VLAN device
194 if (dev->operstate == IF_OPER_DORMANT)
195 netif_dormant_on(vlandev);
196 else
197 netif_dormant_off(vlandev);
199 if (netif_carrier_ok(dev)) {
200 if (!netif_carrier_ok(vlandev))
201 netif_carrier_on(vlandev);
202 } else {
203 if (netif_carrier_ok(vlandev))
204 netif_carrier_off(vlandev);
208 int vlan_check_real_dev(struct net_device *real_dev, unsigned short vlan_id)
210 char *name = real_dev->name;
212 if (real_dev->features & NETIF_F_VLAN_CHALLENGED) {
213 pr_info("8021q: VLANs not supported on %s\n", name);
214 return -EOPNOTSUPP;
217 if ((real_dev->features & NETIF_F_HW_VLAN_RX) &&
218 !real_dev->vlan_rx_register) {
219 pr_info("8021q: device %s has buggy VLAN hw accel\n", name);
220 return -EOPNOTSUPP;
223 if ((real_dev->features & NETIF_F_HW_VLAN_FILTER) &&
224 (!real_dev->vlan_rx_add_vid || !real_dev->vlan_rx_kill_vid)) {
225 pr_info("8021q: Device %s has buggy VLAN hw accel\n", name);
226 return -EOPNOTSUPP;
229 /* The real device must be up and operating in order to
230 * assosciate a VLAN device with it.
232 if (!(real_dev->flags & IFF_UP))
233 return -ENETDOWN;
235 if (__find_vlan_dev(real_dev, vlan_id) != NULL)
236 return -EEXIST;
238 return 0;
241 int register_vlan_dev(struct net_device *dev)
243 struct vlan_dev_info *vlan = vlan_dev_info(dev);
244 struct net_device *real_dev = vlan->real_dev;
245 unsigned short vlan_id = vlan->vlan_id;
246 struct vlan_group *grp, *ngrp = NULL;
247 int err;
249 grp = __vlan_find_group(real_dev);
250 if (!grp) {
251 ngrp = grp = vlan_group_alloc(real_dev);
252 if (!grp)
253 return -ENOBUFS;
256 err = vlan_group_prealloc_vid(grp, vlan_id);
257 if (err < 0)
258 goto out_free_group;
260 err = register_netdevice(dev);
261 if (err < 0)
262 goto out_free_group;
264 /* Account for reference in struct vlan_dev_info */
265 dev_hold(real_dev);
267 vlan_transfer_operstate(real_dev, dev);
268 linkwatch_fire_event(dev); /* _MUST_ call rfc2863_policy() */
270 /* So, got the sucker initialized, now lets place
271 * it into our local structure.
273 vlan_group_set_device(grp, vlan_id, dev);
274 grp->nr_vlans++;
276 if (ngrp && real_dev->features & NETIF_F_HW_VLAN_RX)
277 real_dev->vlan_rx_register(real_dev, ngrp);
278 if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
279 real_dev->vlan_rx_add_vid(real_dev, vlan_id);
281 if (vlan_proc_add_dev(dev) < 0)
282 pr_warning("8021q: failed to add proc entry for %s\n",
283 dev->name);
284 return 0;
286 out_free_group:
287 if (ngrp)
288 vlan_group_free(ngrp);
289 return err;
292 /* Attach a VLAN device to a mac address (ie Ethernet Card).
293 * Returns 0 if the device was created or a negative error code otherwise.
295 static int register_vlan_device(struct net_device *real_dev,
296 unsigned short VLAN_ID)
298 struct net_device *new_dev;
299 char name[IFNAMSIZ];
300 int err;
302 if (VLAN_ID >= VLAN_VID_MASK)
303 return -ERANGE;
305 err = vlan_check_real_dev(real_dev, VLAN_ID);
306 if (err < 0)
307 return err;
309 /* Gotta set up the fields for the device. */
310 switch (vlan_name_type) {
311 case VLAN_NAME_TYPE_RAW_PLUS_VID:
312 /* name will look like: eth1.0005 */
313 snprintf(name, IFNAMSIZ, "%s.%.4i", real_dev->name, VLAN_ID);
314 break;
315 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD:
316 /* Put our vlan.VID in the name.
317 * Name will look like: vlan5
319 snprintf(name, IFNAMSIZ, "vlan%i", VLAN_ID);
320 break;
321 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD:
322 /* Put our vlan.VID in the name.
323 * Name will look like: eth0.5
325 snprintf(name, IFNAMSIZ, "%s.%i", real_dev->name, VLAN_ID);
326 break;
327 case VLAN_NAME_TYPE_PLUS_VID:
328 /* Put our vlan.VID in the name.
329 * Name will look like: vlan0005
331 default:
332 snprintf(name, IFNAMSIZ, "vlan%.4i", VLAN_ID);
335 new_dev = alloc_netdev(sizeof(struct vlan_dev_info), name,
336 vlan_setup);
338 if (new_dev == NULL)
339 return -ENOBUFS;
341 /* need 4 bytes for extra VLAN header info,
342 * hope the underlying device can handle it.
344 new_dev->mtu = real_dev->mtu;
346 vlan_dev_info(new_dev)->vlan_id = VLAN_ID; /* 1 through VLAN_VID_MASK */
347 vlan_dev_info(new_dev)->real_dev = real_dev;
348 vlan_dev_info(new_dev)->dent = NULL;
349 vlan_dev_info(new_dev)->flags = VLAN_FLAG_REORDER_HDR;
351 new_dev->rtnl_link_ops = &vlan_link_ops;
352 err = register_vlan_dev(new_dev);
353 if (err < 0)
354 goto out_free_newdev;
356 return 0;
358 out_free_newdev:
359 free_netdev(new_dev);
360 return err;
363 static void vlan_sync_address(struct net_device *dev,
364 struct net_device *vlandev)
366 struct vlan_dev_info *vlan = vlan_dev_info(vlandev);
368 /* May be called without an actual change */
369 if (!compare_ether_addr(vlan->real_dev_addr, dev->dev_addr))
370 return;
372 /* vlan address was different from the old address and is equal to
373 * the new address */
374 if (compare_ether_addr(vlandev->dev_addr, vlan->real_dev_addr) &&
375 !compare_ether_addr(vlandev->dev_addr, dev->dev_addr))
376 dev_unicast_delete(dev, vlandev->dev_addr, ETH_ALEN);
378 /* vlan address was equal to the old address and is different from
379 * the new address */
380 if (!compare_ether_addr(vlandev->dev_addr, vlan->real_dev_addr) &&
381 compare_ether_addr(vlandev->dev_addr, dev->dev_addr))
382 dev_unicast_add(dev, vlandev->dev_addr, ETH_ALEN);
384 memcpy(vlan->real_dev_addr, dev->dev_addr, ETH_ALEN);
387 static void __vlan_device_event(struct net_device *dev, unsigned long event)
389 switch (event) {
390 case NETDEV_CHANGENAME:
391 vlan_proc_rem_dev(dev);
392 if (vlan_proc_add_dev(dev) < 0)
393 pr_warning("8021q: failed to change proc name for %s\n",
394 dev->name);
395 break;
399 static int vlan_device_event(struct notifier_block *unused, unsigned long event,
400 void *ptr)
402 struct net_device *dev = ptr;
403 struct vlan_group *grp;
404 int i, flgs;
405 struct net_device *vlandev;
407 if (dev_net(dev) != &init_net)
408 return NOTIFY_DONE;
410 if (is_vlan_dev(dev)) {
411 __vlan_device_event(dev, event);
412 goto out;
415 grp = __vlan_find_group(dev);
416 if (!grp)
417 goto out;
419 /* It is OK that we do not hold the group lock right now,
420 * as we run under the RTNL lock.
423 switch (event) {
424 case NETDEV_CHANGE:
425 /* Propagate real device state to vlan devices */
426 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
427 vlandev = vlan_group_get_device(grp, i);
428 if (!vlandev)
429 continue;
431 vlan_transfer_operstate(dev, vlandev);
433 break;
435 case NETDEV_CHANGEADDR:
436 /* Adjust unicast filters on underlying device */
437 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
438 vlandev = vlan_group_get_device(grp, i);
439 if (!vlandev)
440 continue;
442 flgs = vlandev->flags;
443 if (!(flgs & IFF_UP))
444 continue;
446 vlan_sync_address(dev, vlandev);
448 break;
450 case NETDEV_DOWN:
451 /* Put all VLANs for this dev in the down state too. */
452 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
453 vlandev = vlan_group_get_device(grp, i);
454 if (!vlandev)
455 continue;
457 flgs = vlandev->flags;
458 if (!(flgs & IFF_UP))
459 continue;
461 dev_change_flags(vlandev, flgs & ~IFF_UP);
463 break;
465 case NETDEV_UP:
466 /* Put all VLANs for this dev in the up state too. */
467 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
468 vlandev = vlan_group_get_device(grp, i);
469 if (!vlandev)
470 continue;
472 flgs = vlandev->flags;
473 if (flgs & IFF_UP)
474 continue;
476 dev_change_flags(vlandev, flgs | IFF_UP);
478 break;
480 case NETDEV_UNREGISTER:
481 /* Delete all VLANs for this dev. */
482 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
483 vlandev = vlan_group_get_device(grp, i);
484 if (!vlandev)
485 continue;
487 /* unregistration of last vlan destroys group, abort
488 * afterwards */
489 if (grp->nr_vlans == 1)
490 i = VLAN_GROUP_ARRAY_LEN;
492 unregister_vlan_dev(vlandev);
494 break;
497 out:
498 return NOTIFY_DONE;
501 static struct notifier_block vlan_notifier_block __read_mostly = {
502 .notifier_call = vlan_device_event,
506 * VLAN IOCTL handler.
507 * o execute requested action or pass command to the device driver
508 * arg is really a struct vlan_ioctl_args __user *.
510 static int vlan_ioctl_handler(struct net *net, void __user *arg)
512 int err;
513 unsigned short vid = 0;
514 struct vlan_ioctl_args args;
515 struct net_device *dev = NULL;
517 if (copy_from_user(&args, arg, sizeof(struct vlan_ioctl_args)))
518 return -EFAULT;
520 /* Null terminate this sucker, just in case. */
521 args.device1[23] = 0;
522 args.u.device2[23] = 0;
524 rtnl_lock();
526 switch (args.cmd) {
527 case SET_VLAN_INGRESS_PRIORITY_CMD:
528 case SET_VLAN_EGRESS_PRIORITY_CMD:
529 case SET_VLAN_FLAG_CMD:
530 case ADD_VLAN_CMD:
531 case DEL_VLAN_CMD:
532 case GET_VLAN_REALDEV_NAME_CMD:
533 case GET_VLAN_VID_CMD:
534 err = -ENODEV;
535 dev = __dev_get_by_name(&init_net, args.device1);
536 if (!dev)
537 goto out;
539 err = -EINVAL;
540 if (args.cmd != ADD_VLAN_CMD &&
541 !(dev->priv_flags & IFF_802_1Q_VLAN))
542 goto out;
545 switch (args.cmd) {
546 case SET_VLAN_INGRESS_PRIORITY_CMD:
547 err = -EPERM;
548 if (!capable(CAP_NET_ADMIN))
549 break;
550 vlan_dev_set_ingress_priority(dev,
551 args.u.skb_priority,
552 args.vlan_qos);
553 err = 0;
554 break;
556 case SET_VLAN_EGRESS_PRIORITY_CMD:
557 err = -EPERM;
558 if (!capable(CAP_NET_ADMIN))
559 break;
560 err = vlan_dev_set_egress_priority(dev,
561 args.u.skb_priority,
562 args.vlan_qos);
563 break;
565 case SET_VLAN_FLAG_CMD:
566 err = -EPERM;
567 if (!capable(CAP_NET_ADMIN))
568 break;
569 err = vlan_dev_set_vlan_flag(dev,
570 args.u.flag,
571 args.vlan_qos);
572 break;
574 case SET_VLAN_NAME_TYPE_CMD:
575 err = -EPERM;
576 if (!capable(CAP_NET_ADMIN))
577 break;
578 if ((args.u.name_type >= 0) &&
579 (args.u.name_type < VLAN_NAME_TYPE_HIGHEST)) {
580 vlan_name_type = args.u.name_type;
581 err = 0;
582 } else {
583 err = -EINVAL;
585 break;
587 case ADD_VLAN_CMD:
588 err = -EPERM;
589 if (!capable(CAP_NET_ADMIN))
590 break;
591 err = register_vlan_device(dev, args.u.VID);
592 break;
594 case DEL_VLAN_CMD:
595 err = -EPERM;
596 if (!capable(CAP_NET_ADMIN))
597 break;
598 unregister_vlan_dev(dev);
599 err = 0;
600 break;
602 case GET_VLAN_REALDEV_NAME_CMD:
603 err = 0;
604 vlan_dev_get_realdev_name(dev, args.u.device2);
605 if (copy_to_user(arg, &args,
606 sizeof(struct vlan_ioctl_args)))
607 err = -EFAULT;
608 break;
610 case GET_VLAN_VID_CMD:
611 err = 0;
612 vlan_dev_get_vid(dev, &vid);
613 args.u.VID = vid;
614 if (copy_to_user(arg, &args,
615 sizeof(struct vlan_ioctl_args)))
616 err = -EFAULT;
617 break;
619 default:
620 err = -EOPNOTSUPP;
621 break;
623 out:
624 rtnl_unlock();
625 return err;
628 static int __init vlan_proto_init(void)
630 int err;
632 pr_info("%s v%s %s\n", vlan_fullname, vlan_version, vlan_copyright);
633 pr_info("All bugs added by %s\n", vlan_buggyright);
635 err = vlan_proc_init();
636 if (err < 0)
637 goto err1;
639 err = register_netdevice_notifier(&vlan_notifier_block);
640 if (err < 0)
641 goto err2;
643 err = vlan_netlink_init();
644 if (err < 0)
645 goto err3;
647 dev_add_pack(&vlan_packet_type);
648 vlan_ioctl_set(vlan_ioctl_handler);
649 return 0;
651 err3:
652 unregister_netdevice_notifier(&vlan_notifier_block);
653 err2:
654 vlan_proc_cleanup();
655 err1:
656 return err;
659 static void __exit vlan_cleanup_module(void)
661 unsigned int i;
663 vlan_ioctl_set(NULL);
664 vlan_netlink_fini();
666 unregister_netdevice_notifier(&vlan_notifier_block);
668 dev_remove_pack(&vlan_packet_type);
670 /* This table must be empty if there are no module references left. */
671 for (i = 0; i < VLAN_GRP_HASH_SIZE; i++)
672 BUG_ON(!hlist_empty(&vlan_group_hash[i]));
674 vlan_proc_cleanup();
676 synchronize_net();
679 module_init(vlan_proto_init);
680 module_exit(vlan_cleanup_module);
682 MODULE_LICENSE("GPL");
683 MODULE_VERSION(DRV_VERSION);