Linux kernel & device driver programming

Cross-Referenced Linux and Device Driver Code

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