[VLAN]: Clean up unregister_vlan_dev
[safe/jmp/linux-2.6] / net / 8021q / vlan.c
1 /*
2  * INET         802.1Q VLAN
3  *              Ethernet-type device handling.
4  *
5  * Authors:     Ben Greear <greearb@candelatech.com>
6  *              Please send support related email to: vlan@scry.wanfear.com
7  *              VLAN Home Page: http://www.candelatech.com/~greear/vlan.html
8  *
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>
14  *
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.
19  */
20
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>
35
36 #include <linux/if_vlan.h>
37 #include "vlan.h"
38 #include "vlanproc.h"
39
40 #define DRV_VERSION "1.8"
41
42 /* Global VLAN variables */
43
44 /* Our listing of VLAN group(s) */
45 static struct hlist_head vlan_group_hash[VLAN_GRP_HASH_SIZE];
46 #define vlan_grp_hashfn(IDX)    ((((IDX) >> VLAN_GRP_HASH_SHIFT) ^ (IDX)) & VLAN_GRP_HASH_MASK)
47
48 static char vlan_fullname[] = "802.1Q VLAN Support";
49 static char vlan_version[] = DRV_VERSION;
50 static char vlan_copyright[] = "Ben Greear <greearb@candelatech.com>";
51 static char vlan_buggyright[] = "David S. Miller <davem@redhat.com>";
52
53 /* Determines interface naming scheme. */
54 unsigned short vlan_name_type = VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD;
55
56 static struct packet_type vlan_packet_type = {
57         .type = __constant_htons(ETH_P_8021Q),
58         .func = vlan_skb_recv, /* VLAN receive method */
59 };
60
61 /* End of global variables definitions. */
62
63 /* Must be invoked with RCU read lock (no preempt) */
64 static struct vlan_group *__vlan_find_group(int real_dev_ifindex)
65 {
66         struct vlan_group *grp;
67         struct hlist_node *n;
68         int hash = vlan_grp_hashfn(real_dev_ifindex);
69
70         hlist_for_each_entry_rcu(grp, n, &vlan_group_hash[hash], hlist) {
71                 if (grp->real_dev_ifindex == real_dev_ifindex)
72                         return grp;
73         }
74
75         return NULL;
76 }
77
78 /*  Find the protocol handler.  Assumes VID < VLAN_VID_MASK.
79  *
80  * Must be invoked with RCU read lock (no preempt)
81  */
82 struct net_device *__find_vlan_dev(struct net_device *real_dev,
83                                    unsigned short VID)
84 {
85         struct vlan_group *grp = __vlan_find_group(real_dev->ifindex);
86
87         if (grp)
88                 return vlan_group_get_device(grp, VID);
89
90         return NULL;
91 }
92
93 static void vlan_group_free(struct vlan_group *grp)
94 {
95         int i;
96
97         for (i=0; i < VLAN_GROUP_ARRAY_SPLIT_PARTS; i++)
98                 kfree(grp->vlan_devices_arrays[i]);
99         kfree(grp);
100 }
101
102 static struct vlan_group *vlan_group_alloc(int ifindex)
103 {
104         struct vlan_group *grp;
105         unsigned int size;
106         unsigned int i;
107
108         grp = kzalloc(sizeof(struct vlan_group), GFP_KERNEL);
109         if (!grp)
110                 return NULL;
111
112         size = sizeof(struct net_device *) * VLAN_GROUP_ARRAY_PART_LEN;
113
114         for (i = 0; i < VLAN_GROUP_ARRAY_SPLIT_PARTS; i++) {
115                 grp->vlan_devices_arrays[i] = kzalloc(size, GFP_KERNEL);
116                 if (!grp->vlan_devices_arrays[i])
117                         goto err;
118         }
119
120         grp->real_dev_ifindex = ifindex;
121         hlist_add_head_rcu(&grp->hlist,
122                            &vlan_group_hash[vlan_grp_hashfn(ifindex)]);
123         return grp;
124
125 err:
126         vlan_group_free(grp);
127         return NULL;
128 }
129
130 static void vlan_rcu_free(struct rcu_head *rcu)
131 {
132         vlan_group_free(container_of(rcu, struct vlan_group, rcu));
133 }
134
135
136 /* This returns 0 if everything went fine.
137  * It will return 1 if the group was killed as a result.
138  * A negative return indicates failure.
139  *
140  * The RTNL lock must be held.
141  */
142 static int unregister_vlan_dev(struct net_device *real_dev,
143                                unsigned short vlan_id)
144 {
145         struct net_device *dev;
146         int real_dev_ifindex = real_dev->ifindex;
147         struct vlan_group *grp;
148         unsigned int i;
149         int ret;
150
151         if (vlan_id >= VLAN_VID_MASK)
152                 return -EINVAL;
153
154         ASSERT_RTNL();
155         grp = __vlan_find_group(real_dev_ifindex);
156         if (!grp)
157                 return -ENOENT;
158
159         dev = vlan_group_get_device(grp, vlan_id);
160         if (!dev)
161                 return -ENOENT;
162
163         vlan_proc_rem_dev(dev);
164
165         /* Take it out of our own structures, but be sure to interlock with
166          * HW accelerating devices or SW vlan input packet processing.
167          */
168         if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
169                 real_dev->vlan_rx_kill_vid(real_dev, vlan_id);
170
171         vlan_group_set_device(grp, vlan_id, NULL);
172         synchronize_net();
173
174         /* Caller unregisters (and if necessary, puts) VLAN device, but we
175          * get rid of the reference to real_dev here.
176          */
177         dev_put(real_dev);
178
179         /* If the group is now empty, kill off the group. */
180         ret = 0;
181         for (i = 0; i < VLAN_VID_MASK; i++)
182                 if (vlan_group_get_device(grp, i))
183                         break;
184
185         if (i == VLAN_VID_MASK) {
186                 if (real_dev->features & NETIF_F_HW_VLAN_RX)
187                         real_dev->vlan_rx_register(real_dev, NULL);
188
189                 hlist_del_rcu(&grp->hlist);
190
191                 /* Free the group, after all cpu's are done. */
192                 call_rcu(&grp->rcu, vlan_rcu_free);
193                 ret = 1;
194         }
195
196         return ret;
197 }
198
199 int unregister_vlan_device(struct net_device *dev)
200 {
201         int ret;
202
203         ret = unregister_vlan_dev(VLAN_DEV_INFO(dev)->real_dev,
204                                   VLAN_DEV_INFO(dev)->vlan_id);
205         unregister_netdevice(dev);
206
207         if (ret == 1)
208                 ret = 0;
209         return ret;
210 }
211
212 static void vlan_transfer_operstate(const struct net_device *dev, struct net_device *vlandev)
213 {
214         /* Have to respect userspace enforced dormant state
215          * of real device, also must allow supplicant running
216          * on VLAN device
217          */
218         if (dev->operstate == IF_OPER_DORMANT)
219                 netif_dormant_on(vlandev);
220         else
221                 netif_dormant_off(vlandev);
222
223         if (netif_carrier_ok(dev)) {
224                 if (!netif_carrier_ok(vlandev))
225                         netif_carrier_on(vlandev);
226         } else {
227                 if (netif_carrier_ok(vlandev))
228                         netif_carrier_off(vlandev);
229         }
230 }
231
232 int vlan_check_real_dev(struct net_device *real_dev, unsigned short vlan_id)
233 {
234         char *name = real_dev->name;
235
236         if (real_dev->features & NETIF_F_VLAN_CHALLENGED) {
237                 pr_info("8021q: VLANs not supported on %s\n", name);
238                 return -EOPNOTSUPP;
239         }
240
241         if ((real_dev->features & NETIF_F_HW_VLAN_RX) &&
242             !real_dev->vlan_rx_register) {
243                 pr_info("8021q: device %s has buggy VLAN hw accel\n", name);
244                 return -EOPNOTSUPP;
245         }
246
247         if ((real_dev->features & NETIF_F_HW_VLAN_FILTER) &&
248             (!real_dev->vlan_rx_add_vid || !real_dev->vlan_rx_kill_vid)) {
249                 pr_info("8021q: Device %s has buggy VLAN hw accel\n", name);
250                 return -EOPNOTSUPP;
251         }
252
253         /* The real device must be up and operating in order to
254          * assosciate a VLAN device with it.
255          */
256         if (!(real_dev->flags & IFF_UP))
257                 return -ENETDOWN;
258
259         if (__find_vlan_dev(real_dev, vlan_id) != NULL)
260                 return -EEXIST;
261
262         return 0;
263 }
264
265 int register_vlan_dev(struct net_device *dev)
266 {
267         struct vlan_dev_info *vlan = VLAN_DEV_INFO(dev);
268         struct net_device *real_dev = vlan->real_dev;
269         unsigned short vlan_id = vlan->vlan_id;
270         struct vlan_group *grp, *ngrp = NULL;
271         int err;
272
273         grp = __vlan_find_group(real_dev->ifindex);
274         if (!grp) {
275                 ngrp = grp = vlan_group_alloc(real_dev->ifindex);
276                 if (!grp)
277                         return -ENOBUFS;
278         }
279
280         err = register_netdevice(dev);
281         if (err < 0)
282                 goto out_free_group;
283
284         /* Account for reference in struct vlan_dev_info */
285         dev_hold(real_dev);
286
287         vlan_transfer_operstate(real_dev, dev);
288         linkwatch_fire_event(dev); /* _MUST_ call rfc2863_policy() */
289
290         /* So, got the sucker initialized, now lets place
291          * it into our local structure.
292          */
293         vlan_group_set_device(grp, vlan_id, dev);
294         if (ngrp && real_dev->features & NETIF_F_HW_VLAN_RX)
295                 real_dev->vlan_rx_register(real_dev, ngrp);
296         if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
297                 real_dev->vlan_rx_add_vid(real_dev, vlan_id);
298
299         if (vlan_proc_add_dev(dev) < 0)
300                 pr_warning("8021q: failed to add proc entry for %s\n",
301                            dev->name);
302         return 0;
303
304 out_free_group:
305         if (ngrp)
306                 vlan_group_free(ngrp);
307         return err;
308 }
309
310 /*  Attach a VLAN device to a mac address (ie Ethernet Card).
311  *  Returns 0 if the device was created or a negative error code otherwise.
312  */
313 static int register_vlan_device(struct net_device *real_dev,
314                                 unsigned short VLAN_ID)
315 {
316         struct net_device *new_dev;
317         char name[IFNAMSIZ];
318         int err;
319
320         if (VLAN_ID >= VLAN_VID_MASK)
321                 return -ERANGE;
322
323         err = vlan_check_real_dev(real_dev, VLAN_ID);
324         if (err < 0)
325                 return err;
326
327         /* Gotta set up the fields for the device. */
328         switch (vlan_name_type) {
329         case VLAN_NAME_TYPE_RAW_PLUS_VID:
330                 /* name will look like:  eth1.0005 */
331                 snprintf(name, IFNAMSIZ, "%s.%.4i", real_dev->name, VLAN_ID);
332                 break;
333         case VLAN_NAME_TYPE_PLUS_VID_NO_PAD:
334                 /* Put our vlan.VID in the name.
335                  * Name will look like:  vlan5
336                  */
337                 snprintf(name, IFNAMSIZ, "vlan%i", VLAN_ID);
338                 break;
339         case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD:
340                 /* Put our vlan.VID in the name.
341                  * Name will look like:  eth0.5
342                  */
343                 snprintf(name, IFNAMSIZ, "%s.%i", real_dev->name, VLAN_ID);
344                 break;
345         case VLAN_NAME_TYPE_PLUS_VID:
346                 /* Put our vlan.VID in the name.
347                  * Name will look like:  vlan0005
348                  */
349         default:
350                 snprintf(name, IFNAMSIZ, "vlan%.4i", VLAN_ID);
351         }
352
353         new_dev = alloc_netdev(sizeof(struct vlan_dev_info), name,
354                                vlan_setup);
355
356         if (new_dev == NULL)
357                 return -ENOBUFS;
358
359         /* need 4 bytes for extra VLAN header info,
360          * hope the underlying device can handle it.
361          */
362         new_dev->mtu = real_dev->mtu;
363
364         VLAN_DEV_INFO(new_dev)->vlan_id = VLAN_ID; /* 1 through VLAN_VID_MASK */
365         VLAN_DEV_INFO(new_dev)->real_dev = real_dev;
366         VLAN_DEV_INFO(new_dev)->dent = NULL;
367         VLAN_DEV_INFO(new_dev)->flags = VLAN_FLAG_REORDER_HDR;
368
369         new_dev->rtnl_link_ops = &vlan_link_ops;
370         err = register_vlan_dev(new_dev);
371         if (err < 0)
372                 goto out_free_newdev;
373
374         return 0;
375
376 out_free_newdev:
377         free_netdev(new_dev);
378         return err;
379 }
380
381 static void vlan_sync_address(struct net_device *dev,
382                               struct net_device *vlandev)
383 {
384         struct vlan_dev_info *vlan = VLAN_DEV_INFO(vlandev);
385
386         /* May be called without an actual change */
387         if (!compare_ether_addr(vlan->real_dev_addr, dev->dev_addr))
388                 return;
389
390         /* vlan address was different from the old address and is equal to
391          * the new address */
392         if (compare_ether_addr(vlandev->dev_addr, vlan->real_dev_addr) &&
393             !compare_ether_addr(vlandev->dev_addr, dev->dev_addr))
394                 dev_unicast_delete(dev, vlandev->dev_addr, ETH_ALEN);
395
396         /* vlan address was equal to the old address and is different from
397          * the new address */
398         if (!compare_ether_addr(vlandev->dev_addr, vlan->real_dev_addr) &&
399             compare_ether_addr(vlandev->dev_addr, dev->dev_addr))
400                 dev_unicast_add(dev, vlandev->dev_addr, ETH_ALEN);
401
402         memcpy(vlan->real_dev_addr, dev->dev_addr, ETH_ALEN);
403 }
404
405 static int vlan_device_event(struct notifier_block *unused, unsigned long event, void *ptr)
406 {
407         struct net_device *dev = ptr;
408         struct vlan_group *grp = __vlan_find_group(dev->ifindex);
409         int i, flgs;
410         struct net_device *vlandev;
411
412         if (dev->nd_net != &init_net)
413                 return NOTIFY_DONE;
414
415         if (!grp)
416                 goto out;
417
418         /* It is OK that we do not hold the group lock right now,
419          * as we run under the RTNL lock.
420          */
421
422         switch (event) {
423         case NETDEV_CHANGE:
424                 /* Propagate real device state to vlan devices */
425                 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
426                         vlandev = vlan_group_get_device(grp, i);
427                         if (!vlandev)
428                                 continue;
429
430                         vlan_transfer_operstate(dev, vlandev);
431                 }
432                 break;
433
434         case NETDEV_CHANGEADDR:
435                 /* Adjust unicast filters on underlying device */
436                 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
437                         vlandev = vlan_group_get_device(grp, i);
438                         if (!vlandev)
439                                 continue;
440
441                         flgs = vlandev->flags;
442                         if (!(flgs & IFF_UP))
443                                 continue;
444
445                         vlan_sync_address(dev, vlandev);
446                 }
447                 break;
448
449         case NETDEV_DOWN:
450                 /* Put all VLANs for this dev in the down state too.  */
451                 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
452                         vlandev = vlan_group_get_device(grp, i);
453                         if (!vlandev)
454                                 continue;
455
456                         flgs = vlandev->flags;
457                         if (!(flgs & IFF_UP))
458                                 continue;
459
460                         dev_change_flags(vlandev, flgs & ~IFF_UP);
461                 }
462                 break;
463
464         case NETDEV_UP:
465                 /* Put all VLANs for this dev in the up state too.  */
466                 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
467                         vlandev = vlan_group_get_device(grp, i);
468                         if (!vlandev)
469                                 continue;
470
471                         flgs = vlandev->flags;
472                         if (flgs & IFF_UP)
473                                 continue;
474
475                         dev_change_flags(vlandev, flgs | IFF_UP);
476                 }
477                 break;
478
479         case NETDEV_UNREGISTER:
480                 /* Delete all VLANs for this dev. */
481                 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
482                         int ret;
483
484                         vlandev = vlan_group_get_device(grp, i);
485                         if (!vlandev)
486                                 continue;
487
488                         ret = unregister_vlan_dev(dev,
489                                                   VLAN_DEV_INFO(vlandev)->vlan_id);
490
491                         unregister_netdevice(vlandev);
492
493                         /* Group was destroyed? */
494                         if (ret == 1)
495                                 break;
496                 }
497                 break;
498         }
499
500 out:
501         return NOTIFY_DONE;
502 }
503
504 static struct notifier_block vlan_notifier_block __read_mostly = {
505         .notifier_call = vlan_device_event,
506 };
507
508 /*
509  *      VLAN IOCTL handler.
510  *      o execute requested action or pass command to the device driver
511  *   arg is really a struct vlan_ioctl_args __user *.
512  */
513 static int vlan_ioctl_handler(struct net *net, void __user *arg)
514 {
515         int err;
516         unsigned short vid = 0;
517         struct vlan_ioctl_args args;
518         struct net_device *dev = NULL;
519
520         if (copy_from_user(&args, arg, sizeof(struct vlan_ioctl_args)))
521                 return -EFAULT;
522
523         /* Null terminate this sucker, just in case. */
524         args.device1[23] = 0;
525         args.u.device2[23] = 0;
526
527         rtnl_lock();
528
529         switch (args.cmd) {
530         case SET_VLAN_INGRESS_PRIORITY_CMD:
531         case SET_VLAN_EGRESS_PRIORITY_CMD:
532         case SET_VLAN_FLAG_CMD:
533         case ADD_VLAN_CMD:
534         case DEL_VLAN_CMD:
535         case GET_VLAN_REALDEV_NAME_CMD:
536         case GET_VLAN_VID_CMD:
537                 err = -ENODEV;
538                 dev = __dev_get_by_name(&init_net, args.device1);
539                 if (!dev)
540                         goto out;
541
542                 err = -EINVAL;
543                 if (args.cmd != ADD_VLAN_CMD &&
544                     !(dev->priv_flags & IFF_802_1Q_VLAN))
545                         goto out;
546         }
547
548         switch (args.cmd) {
549         case SET_VLAN_INGRESS_PRIORITY_CMD:
550                 err = -EPERM;
551                 if (!capable(CAP_NET_ADMIN))
552                         break;
553                 vlan_dev_set_ingress_priority(dev,
554                                               args.u.skb_priority,
555                                               args.vlan_qos);
556                 err = 0;
557                 break;
558
559         case SET_VLAN_EGRESS_PRIORITY_CMD:
560                 err = -EPERM;
561                 if (!capable(CAP_NET_ADMIN))
562                         break;
563                 err = vlan_dev_set_egress_priority(dev,
564                                                    args.u.skb_priority,
565                                                    args.vlan_qos);
566                 break;
567
568         case SET_VLAN_FLAG_CMD:
569                 err = -EPERM;
570                 if (!capable(CAP_NET_ADMIN))
571                         break;
572                 err = vlan_dev_set_vlan_flag(dev,
573                                              args.u.flag,
574                                              args.vlan_qos);
575                 break;
576
577         case SET_VLAN_NAME_TYPE_CMD:
578                 err = -EPERM;
579                 if (!capable(CAP_NET_ADMIN))
580                         break;
581                 if ((args.u.name_type >= 0) &&
582                     (args.u.name_type < VLAN_NAME_TYPE_HIGHEST)) {
583                         vlan_name_type = args.u.name_type;
584                         err = 0;
585                 } else {
586                         err = -EINVAL;
587                 }
588                 break;
589
590         case ADD_VLAN_CMD:
591                 err = -EPERM;
592                 if (!capable(CAP_NET_ADMIN))
593                         break;
594                 err = register_vlan_device(dev, args.u.VID);
595                 break;
596
597         case DEL_VLAN_CMD:
598                 err = -EPERM;
599                 if (!capable(CAP_NET_ADMIN))
600                         break;
601                 err = unregister_vlan_device(dev);
602                 break;
603
604         case GET_VLAN_REALDEV_NAME_CMD:
605                 err = 0;
606                 vlan_dev_get_realdev_name(dev, args.u.device2);
607                 if (copy_to_user(arg, &args,
608                                  sizeof(struct vlan_ioctl_args))) {
609                         err = -EFAULT;
610                 }
611                 break;
612
613         case GET_VLAN_VID_CMD:
614                 err = 0;
615                 vlan_dev_get_vid(dev, &vid);
616                 args.u.VID = vid;
617                 if (copy_to_user(arg, &args,
618                                  sizeof(struct vlan_ioctl_args))) {
619                       err = -EFAULT;
620                 }
621                 break;
622
623         default:
624                 err = -EOPNOTSUPP;
625                 break;
626         }
627 out:
628         rtnl_unlock();
629         return err;
630 }
631
632 static int __init vlan_proto_init(void)
633 {
634         int err;
635
636         pr_info("%s v%s %s\n", vlan_fullname, vlan_version, vlan_copyright);
637         pr_info("All bugs added by %s\n", vlan_buggyright);
638
639         err = vlan_proc_init();
640         if (err < 0)
641                 goto err1;
642
643         err = register_netdevice_notifier(&vlan_notifier_block);
644         if (err < 0)
645                 goto err2;
646
647         err = vlan_netlink_init();
648         if (err < 0)
649                 goto err3;
650
651         dev_add_pack(&vlan_packet_type);
652         vlan_ioctl_set(vlan_ioctl_handler);
653         return 0;
654
655 err3:
656         unregister_netdevice_notifier(&vlan_notifier_block);
657 err2:
658         vlan_proc_cleanup();
659 err1:
660         return err;
661 }
662
663 static void __exit vlan_cleanup_module(void)
664 {
665         unsigned int i;
666
667         vlan_ioctl_set(NULL);
668         vlan_netlink_fini();
669
670         unregister_netdevice_notifier(&vlan_notifier_block);
671
672         dev_remove_pack(&vlan_packet_type);
673
674         /* This table must be empty if there are no module references left. */
675         for (i = 0; i < VLAN_GRP_HASH_SIZE; i++)
676                 BUG_ON(!hlist_empty(&vlan_group_hash[i]));
677
678         vlan_proc_cleanup();
679
680         synchronize_net();
681 }
682
683 module_init(vlan_proto_init);
684 module_exit(vlan_cleanup_module);
685
686 MODULE_LICENSE("GPL");
687 MODULE_VERSION(DRV_VERSION);