3 * Ethernet-type device handling.
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
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>
29 #include <linux/init.h>
30 #include <net/p8022.h>
32 #include <linux/rtnetlink.h>
33 #include <linux/notifier.h>
34 #include <net/net_namespace.h>
36 #include <linux/if_vlan.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];
46 #define vlan_grp_hashfn(IDX) ((((IDX) >> VLAN_GRP_HASH_SHIFT) ^ (IDX)) & VLAN_GRP_HASH_MASK)
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>";
53 static int vlan_device_event(struct notifier_block *, unsigned long, void *);
54 static int vlan_ioctl_handler(struct net *net, void __user *);
55 static int unregister_vlan_dev(struct net_device *, unsigned short );
57 static struct notifier_block vlan_notifier_block = {
58 .notifier_call = vlan_device_event,
61 /* These may be changed at run-time through IOCTLs */
63 /* Determines interface naming scheme. */
64 unsigned short vlan_name_type = VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD;
66 static struct packet_type vlan_packet_type = {
67 .type = __constant_htons(ETH_P_8021Q),
68 .func = vlan_skb_recv, /* VLAN receive method */
71 /* End of global variables definitions. */
74 * Function vlan_proto_init (pro)
76 * Initialize VLAN protocol layer,
79 static int __init vlan_proto_init(void)
83 pr_info("%s v%s %s\n", vlan_fullname, vlan_version, vlan_copyright);
84 pr_info("All bugs added by %s\n", vlan_buggyright);
86 /* proc file system initialization */
87 err = vlan_proc_init();
89 pr_err("%s: can't create entry in proc filesystem!\n",
94 dev_add_pack(&vlan_packet_type);
96 /* Register us to receive netdevice events */
97 err = register_netdevice_notifier(&vlan_notifier_block);
101 err = vlan_netlink_init();
105 vlan_ioctl_set(vlan_ioctl_handler);
109 unregister_netdevice_notifier(&vlan_notifier_block);
112 dev_remove_pack(&vlan_packet_type);
117 * Module 'remove' entry point.
118 * o delete /proc/net/router directory and static entries.
120 static void __exit vlan_cleanup_module(void)
124 vlan_ioctl_set(NULL);
127 /* Un-register us from receiving netdevice events */
128 unregister_netdevice_notifier(&vlan_notifier_block);
130 dev_remove_pack(&vlan_packet_type);
132 /* This table must be empty if there are no module
135 for (i = 0; i < VLAN_GRP_HASH_SIZE; i++) {
136 BUG_ON(!hlist_empty(&vlan_group_hash[i]));
143 module_init(vlan_proto_init);
144 module_exit(vlan_cleanup_module);
146 /* Must be invoked with RCU read lock (no preempt) */
147 static struct vlan_group *__vlan_find_group(int real_dev_ifindex)
149 struct vlan_group *grp;
150 struct hlist_node *n;
151 int hash = vlan_grp_hashfn(real_dev_ifindex);
153 hlist_for_each_entry_rcu(grp, n, &vlan_group_hash[hash], hlist) {
154 if (grp->real_dev_ifindex == real_dev_ifindex)
161 /* Find the protocol handler. Assumes VID < VLAN_VID_MASK.
163 * Must be invoked with RCU read lock (no preempt)
165 struct net_device *__find_vlan_dev(struct net_device *real_dev,
168 struct vlan_group *grp = __vlan_find_group(real_dev->ifindex);
171 return vlan_group_get_device(grp, VID);
176 static void vlan_group_free(struct vlan_group *grp)
180 for (i=0; i < VLAN_GROUP_ARRAY_SPLIT_PARTS; i++)
181 kfree(grp->vlan_devices_arrays[i]);
185 static struct vlan_group *vlan_group_alloc(int ifindex)
187 struct vlan_group *grp;
191 grp = kzalloc(sizeof(struct vlan_group), GFP_KERNEL);
195 size = sizeof(struct net_device *) * VLAN_GROUP_ARRAY_PART_LEN;
197 for (i = 0; i < VLAN_GROUP_ARRAY_SPLIT_PARTS; i++) {
198 grp->vlan_devices_arrays[i] = kzalloc(size, GFP_KERNEL);
199 if (!grp->vlan_devices_arrays[i])
203 grp->real_dev_ifindex = ifindex;
204 hlist_add_head_rcu(&grp->hlist,
205 &vlan_group_hash[vlan_grp_hashfn(ifindex)]);
209 vlan_group_free(grp);
213 static void vlan_rcu_free(struct rcu_head *rcu)
215 vlan_group_free(container_of(rcu, struct vlan_group, rcu));
219 /* This returns 0 if everything went fine.
220 * It will return 1 if the group was killed as a result.
221 * A negative return indicates failure.
223 * The RTNL lock must be held.
225 static int unregister_vlan_dev(struct net_device *real_dev,
226 unsigned short vlan_id)
228 struct net_device *dev = NULL;
229 int real_dev_ifindex = real_dev->ifindex;
230 struct vlan_group *grp;
234 if (vlan_id >= VLAN_VID_MASK)
238 grp = __vlan_find_group(real_dev_ifindex);
243 dev = vlan_group_get_device(grp, vlan_id);
245 /* Remove proc entry */
246 vlan_proc_rem_dev(dev);
248 /* Take it out of our own structures, but be sure to
249 * interlock with HW accelerating devices or SW vlan
250 * input packet processing.
252 if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
253 real_dev->vlan_rx_kill_vid(real_dev, vlan_id);
255 vlan_group_set_device(grp, vlan_id, NULL);
259 /* Caller unregisters (and if necessary, puts)
260 * VLAN device, but we get rid of the reference to
265 /* If the group is now empty, kill off the
268 for (i = 0; i < VLAN_VID_MASK; i++)
269 if (vlan_group_get_device(grp, i))
272 if (i == VLAN_VID_MASK) {
273 if (real_dev->features & NETIF_F_HW_VLAN_RX)
274 real_dev->vlan_rx_register(real_dev, NULL);
276 hlist_del_rcu(&grp->hlist);
278 /* Free the group, after all cpu's are done. */
279 call_rcu(&grp->rcu, vlan_rcu_free);
290 int unregister_vlan_device(struct net_device *dev)
294 ret = unregister_vlan_dev(VLAN_DEV_INFO(dev)->real_dev,
295 VLAN_DEV_INFO(dev)->vlan_id);
296 unregister_netdevice(dev);
303 static void vlan_transfer_operstate(const struct net_device *dev, struct net_device *vlandev)
305 /* Have to respect userspace enforced dormant state
306 * of real device, also must allow supplicant running
309 if (dev->operstate == IF_OPER_DORMANT)
310 netif_dormant_on(vlandev);
312 netif_dormant_off(vlandev);
314 if (netif_carrier_ok(dev)) {
315 if (!netif_carrier_ok(vlandev))
316 netif_carrier_on(vlandev);
318 if (netif_carrier_ok(vlandev))
319 netif_carrier_off(vlandev);
323 int vlan_check_real_dev(struct net_device *real_dev, unsigned short vlan_id)
325 char *name = real_dev->name;
327 if (real_dev->features & NETIF_F_VLAN_CHALLENGED) {
328 pr_info("8021q: VLANs not supported on %s\n", name);
332 if ((real_dev->features & NETIF_F_HW_VLAN_RX) &&
333 !real_dev->vlan_rx_register) {
334 pr_info("8021q: device %s has buggy VLAN hw accel\n", name);
338 if ((real_dev->features & NETIF_F_HW_VLAN_FILTER) &&
339 (!real_dev->vlan_rx_add_vid || !real_dev->vlan_rx_kill_vid)) {
340 pr_info("8021q: Device %s has buggy VLAN hw accel\n", name);
344 /* The real device must be up and operating in order to
345 * assosciate a VLAN device with it.
347 if (!(real_dev->flags & IFF_UP))
350 if (__find_vlan_dev(real_dev, vlan_id) != NULL)
356 int register_vlan_dev(struct net_device *dev)
358 struct vlan_dev_info *vlan = VLAN_DEV_INFO(dev);
359 struct net_device *real_dev = vlan->real_dev;
360 unsigned short vlan_id = vlan->vlan_id;
361 struct vlan_group *grp, *ngrp = NULL;
364 grp = __vlan_find_group(real_dev->ifindex);
366 ngrp = grp = vlan_group_alloc(real_dev->ifindex);
371 err = register_netdevice(dev);
375 /* Account for reference in struct vlan_dev_info */
378 vlan_transfer_operstate(real_dev, dev);
379 linkwatch_fire_event(dev); /* _MUST_ call rfc2863_policy() */
381 /* So, got the sucker initialized, now lets place
382 * it into our local structure.
384 vlan_group_set_device(grp, vlan_id, dev);
385 if (ngrp && real_dev->features & NETIF_F_HW_VLAN_RX)
386 real_dev->vlan_rx_register(real_dev, ngrp);
387 if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
388 real_dev->vlan_rx_add_vid(real_dev, vlan_id);
390 if (vlan_proc_add_dev(dev) < 0)
391 pr_warning("8021q: failed to add proc entry for %s\n",
397 vlan_group_free(ngrp);
401 /* Attach a VLAN device to a mac address (ie Ethernet Card).
402 * Returns 0 if the device was created or a negative error code otherwise.
404 static int register_vlan_device(struct net_device *real_dev,
405 unsigned short VLAN_ID)
407 struct net_device *new_dev;
411 if (VLAN_ID >= VLAN_VID_MASK)
414 err = vlan_check_real_dev(real_dev, VLAN_ID);
418 /* Gotta set up the fields for the device. */
419 switch (vlan_name_type) {
420 case VLAN_NAME_TYPE_RAW_PLUS_VID:
421 /* name will look like: eth1.0005 */
422 snprintf(name, IFNAMSIZ, "%s.%.4i", real_dev->name, VLAN_ID);
424 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD:
425 /* Put our vlan.VID in the name.
426 * Name will look like: vlan5
428 snprintf(name, IFNAMSIZ, "vlan%i", VLAN_ID);
430 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD:
431 /* Put our vlan.VID in the name.
432 * Name will look like: eth0.5
434 snprintf(name, IFNAMSIZ, "%s.%i", real_dev->name, VLAN_ID);
436 case VLAN_NAME_TYPE_PLUS_VID:
437 /* Put our vlan.VID in the name.
438 * Name will look like: vlan0005
441 snprintf(name, IFNAMSIZ, "vlan%.4i", VLAN_ID);
444 new_dev = alloc_netdev(sizeof(struct vlan_dev_info), name,
450 /* need 4 bytes for extra VLAN header info,
451 * hope the underlying device can handle it.
453 new_dev->mtu = real_dev->mtu;
455 VLAN_DEV_INFO(new_dev)->vlan_id = VLAN_ID; /* 1 through VLAN_VID_MASK */
456 VLAN_DEV_INFO(new_dev)->real_dev = real_dev;
457 VLAN_DEV_INFO(new_dev)->dent = NULL;
458 VLAN_DEV_INFO(new_dev)->flags = VLAN_FLAG_REORDER_HDR;
460 new_dev->rtnl_link_ops = &vlan_link_ops;
461 err = register_vlan_dev(new_dev);
463 goto out_free_newdev;
468 free_netdev(new_dev);
472 static void vlan_sync_address(struct net_device *dev,
473 struct net_device *vlandev)
475 struct vlan_dev_info *vlan = VLAN_DEV_INFO(vlandev);
477 /* May be called without an actual change */
478 if (!compare_ether_addr(vlan->real_dev_addr, dev->dev_addr))
481 /* vlan address was different from the old address and is equal to
483 if (compare_ether_addr(vlandev->dev_addr, vlan->real_dev_addr) &&
484 !compare_ether_addr(vlandev->dev_addr, dev->dev_addr))
485 dev_unicast_delete(dev, vlandev->dev_addr, ETH_ALEN);
487 /* vlan address was equal to the old address and is different from
489 if (!compare_ether_addr(vlandev->dev_addr, vlan->real_dev_addr) &&
490 compare_ether_addr(vlandev->dev_addr, dev->dev_addr))
491 dev_unicast_add(dev, vlandev->dev_addr, ETH_ALEN);
493 memcpy(vlan->real_dev_addr, dev->dev_addr, ETH_ALEN);
496 static int vlan_device_event(struct notifier_block *unused, unsigned long event, void *ptr)
498 struct net_device *dev = ptr;
499 struct vlan_group *grp = __vlan_find_group(dev->ifindex);
501 struct net_device *vlandev;
503 if (dev->nd_net != &init_net)
509 /* It is OK that we do not hold the group lock right now,
510 * as we run under the RTNL lock.
515 /* Propagate real device state to vlan devices */
516 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
517 vlandev = vlan_group_get_device(grp, i);
521 vlan_transfer_operstate(dev, vlandev);
525 case NETDEV_CHANGEADDR:
526 /* Adjust unicast filters on underlying device */
527 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
528 vlandev = vlan_group_get_device(grp, i);
532 flgs = vlandev->flags;
533 if (!(flgs & IFF_UP))
536 vlan_sync_address(dev, vlandev);
541 /* Put all VLANs for this dev in the down state too. */
542 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
543 vlandev = vlan_group_get_device(grp, i);
547 flgs = vlandev->flags;
548 if (!(flgs & IFF_UP))
551 dev_change_flags(vlandev, flgs & ~IFF_UP);
556 /* Put all VLANs for this dev in the up state too. */
557 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
558 vlandev = vlan_group_get_device(grp, i);
562 flgs = vlandev->flags;
566 dev_change_flags(vlandev, flgs | IFF_UP);
570 case NETDEV_UNREGISTER:
571 /* Delete all VLANs for this dev. */
572 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
575 vlandev = vlan_group_get_device(grp, i);
579 ret = unregister_vlan_dev(dev,
580 VLAN_DEV_INFO(vlandev)->vlan_id);
582 unregister_netdevice(vlandev);
584 /* Group was destroyed? */
596 * VLAN IOCTL handler.
597 * o execute requested action or pass command to the device driver
598 * arg is really a struct vlan_ioctl_args __user *.
600 static int vlan_ioctl_handler(struct net *net, void __user *arg)
603 unsigned short vid = 0;
604 struct vlan_ioctl_args args;
605 struct net_device *dev = NULL;
607 if (copy_from_user(&args, arg, sizeof(struct vlan_ioctl_args)))
610 /* Null terminate this sucker, just in case. */
611 args.device1[23] = 0;
612 args.u.device2[23] = 0;
617 case SET_VLAN_INGRESS_PRIORITY_CMD:
618 case SET_VLAN_EGRESS_PRIORITY_CMD:
619 case SET_VLAN_FLAG_CMD:
622 case GET_VLAN_REALDEV_NAME_CMD:
623 case GET_VLAN_VID_CMD:
625 dev = __dev_get_by_name(&init_net, args.device1);
630 if (args.cmd != ADD_VLAN_CMD &&
631 !(dev->priv_flags & IFF_802_1Q_VLAN))
636 case SET_VLAN_INGRESS_PRIORITY_CMD:
638 if (!capable(CAP_NET_ADMIN))
640 vlan_dev_set_ingress_priority(dev,
646 case SET_VLAN_EGRESS_PRIORITY_CMD:
648 if (!capable(CAP_NET_ADMIN))
650 err = vlan_dev_set_egress_priority(dev,
655 case SET_VLAN_FLAG_CMD:
657 if (!capable(CAP_NET_ADMIN))
659 err = vlan_dev_set_vlan_flag(dev,
664 case SET_VLAN_NAME_TYPE_CMD:
666 if (!capable(CAP_NET_ADMIN))
668 if ((args.u.name_type >= 0) &&
669 (args.u.name_type < VLAN_NAME_TYPE_HIGHEST)) {
670 vlan_name_type = args.u.name_type;
679 if (!capable(CAP_NET_ADMIN))
681 err = register_vlan_device(dev, args.u.VID);
686 if (!capable(CAP_NET_ADMIN))
688 err = unregister_vlan_device(dev);
691 case GET_VLAN_INGRESS_PRIORITY_CMD:
693 err = vlan_dev_get_ingress_priority(args);
694 if (copy_to_user((void*)arg, &args,
695 sizeof(struct vlan_ioctl_args))) {
701 case GET_VLAN_EGRESS_PRIORITY_CMD:
703 err = vlan_dev_get_egress_priority(args.device1, &(args.args);
704 if (copy_to_user((void*)arg, &args,
705 sizeof(struct vlan_ioctl_args))) {
711 case GET_VLAN_REALDEV_NAME_CMD:
713 vlan_dev_get_realdev_name(dev, args.u.device2);
714 if (copy_to_user(arg, &args,
715 sizeof(struct vlan_ioctl_args))) {
720 case GET_VLAN_VID_CMD:
722 vlan_dev_get_vid(dev, &vid);
724 if (copy_to_user(arg, &args,
725 sizeof(struct vlan_ioctl_args))) {
731 /* pass on to underlying device instead?? */
740 MODULE_LICENSE("GPL");
741 MODULE_VERSION(DRV_VERSION);