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