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>
35 #include <linux/if_vlan.h>
39 #define DRV_VERSION "1.8"
41 /* Global VLAN variables */
43 /* Our listing of VLAN group(s) */
44 static struct hlist_head vlan_group_hash[VLAN_GRP_HASH_SIZE];
45 #define vlan_grp_hashfn(IDX) ((((IDX) >> VLAN_GRP_HASH_SHIFT) ^ (IDX)) & VLAN_GRP_HASH_MASK)
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 static int vlan_device_event(struct notifier_block *, unsigned long, void *);
53 static int vlan_ioctl_handler(void __user *);
54 static int unregister_vlan_dev(struct net_device *, unsigned short );
56 static struct notifier_block vlan_notifier_block = {
57 .notifier_call = vlan_device_event,
60 /* These may be changed at run-time through IOCTLs */
62 /* Determines interface naming scheme. */
63 unsigned short vlan_name_type = VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD;
65 static struct packet_type vlan_packet_type = {
66 .type = __constant_htons(ETH_P_8021Q),
67 .func = vlan_skb_recv, /* VLAN receive method */
70 /* End of global variables definitions. */
73 * Function vlan_proto_init (pro)
75 * Initialize VLAN protocol layer,
78 static int __init vlan_proto_init(void)
82 printk(VLAN_INF "%s v%s %s\n",
83 vlan_fullname, vlan_version, vlan_copyright);
84 printk(VLAN_INF "All bugs added by %s\n",
87 /* proc file system initialization */
88 err = vlan_proc_init();
91 "%s %s: can't create entry in proc filesystem!\n",
92 __FUNCTION__, VLAN_NAME);
96 dev_add_pack(&vlan_packet_type);
98 /* Register us to receive netdevice events */
99 err = register_netdevice_notifier(&vlan_notifier_block);
103 err = vlan_netlink_init();
107 vlan_ioctl_set(vlan_ioctl_handler);
111 unregister_netdevice_notifier(&vlan_notifier_block);
114 dev_remove_pack(&vlan_packet_type);
119 * Module 'remove' entry point.
120 * o delete /proc/net/router directory and static entries.
122 static void __exit vlan_cleanup_module(void)
127 vlan_ioctl_set(NULL);
129 /* Un-register us from receiving netdevice events */
130 unregister_netdevice_notifier(&vlan_notifier_block);
132 dev_remove_pack(&vlan_packet_type);
134 /* This table must be empty if there are no module
137 for (i = 0; i < VLAN_GRP_HASH_SIZE; i++) {
138 BUG_ON(!hlist_empty(&vlan_group_hash[i]));
145 module_init(vlan_proto_init);
146 module_exit(vlan_cleanup_module);
148 /* Must be invoked with RCU read lock (no preempt) */
149 static struct vlan_group *__vlan_find_group(int real_dev_ifindex)
151 struct vlan_group *grp;
152 struct hlist_node *n;
153 int hash = vlan_grp_hashfn(real_dev_ifindex);
155 hlist_for_each_entry_rcu(grp, n, &vlan_group_hash[hash], hlist) {
156 if (grp->real_dev_ifindex == real_dev_ifindex)
163 /* Find the protocol handler. Assumes VID < VLAN_VID_MASK.
165 * Must be invoked with RCU read lock (no preempt)
167 struct net_device *__find_vlan_dev(struct net_device *real_dev,
170 struct vlan_group *grp = __vlan_find_group(real_dev->ifindex);
173 return vlan_group_get_device(grp, VID);
178 static void vlan_group_free(struct vlan_group *grp)
182 for (i=0; i < VLAN_GROUP_ARRAY_SPLIT_PARTS; i++)
183 kfree(grp->vlan_devices_arrays[i]);
187 static struct vlan_group *vlan_group_alloc(int ifindex)
189 struct vlan_group *grp;
193 grp = kzalloc(sizeof(struct vlan_group), GFP_KERNEL);
197 size = sizeof(struct net_device *) * VLAN_GROUP_ARRAY_PART_LEN;
199 for (i = 0; i < VLAN_GROUP_ARRAY_SPLIT_PARTS; i++) {
200 grp->vlan_devices_arrays[i] = kzalloc(size, GFP_KERNEL);
201 if (!grp->vlan_devices_arrays[i])
205 grp->real_dev_ifindex = ifindex;
206 hlist_add_head_rcu(&grp->hlist,
207 &vlan_group_hash[vlan_grp_hashfn(ifindex)]);
211 vlan_group_free(grp);
215 static void vlan_rcu_free(struct rcu_head *rcu)
217 vlan_group_free(container_of(rcu, struct vlan_group, rcu));
221 /* This returns 0 if everything went fine.
222 * It will return 1 if the group was killed as a result.
223 * A negative return indicates failure.
225 * The RTNL lock must be held.
227 static int unregister_vlan_dev(struct net_device *real_dev,
228 unsigned short vlan_id)
230 struct net_device *dev = NULL;
231 int real_dev_ifindex = real_dev->ifindex;
232 struct vlan_group *grp;
236 printk(VLAN_DBG "%s: VID: %i\n", __FUNCTION__, vlan_id);
240 if (vlan_id >= VLAN_VID_MASK)
244 grp = __vlan_find_group(real_dev_ifindex);
249 dev = vlan_group_get_device(grp, vlan_id);
251 /* Remove proc entry */
252 vlan_proc_rem_dev(dev);
254 /* Take it out of our own structures, but be sure to
255 * interlock with HW accelerating devices or SW vlan
256 * input packet processing.
258 if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
259 real_dev->vlan_rx_kill_vid(real_dev, vlan_id);
261 vlan_group_set_device(grp, vlan_id, NULL);
265 /* Caller unregisters (and if necessary, puts)
266 * VLAN device, but we get rid of the reference to
271 /* If the group is now empty, kill off the
274 for (i = 0; i < VLAN_VID_MASK; i++)
275 if (vlan_group_get_device(grp, i))
278 if (i == VLAN_VID_MASK) {
279 if (real_dev->features & NETIF_F_HW_VLAN_RX)
280 real_dev->vlan_rx_register(real_dev, NULL);
282 hlist_del_rcu(&grp->hlist);
284 /* Free the group, after all cpu's are done. */
285 call_rcu(&grp->rcu, vlan_rcu_free);
296 int unregister_vlan_device(struct net_device *dev)
300 ret = unregister_vlan_dev(VLAN_DEV_INFO(dev)->real_dev,
301 VLAN_DEV_INFO(dev)->vlan_id);
302 unregister_netdevice(dev);
310 * vlan network devices have devices nesting below it, and are a special
311 * "super class" of normal network devices; split their locks off into a
312 * separate class since they always nest.
314 static struct lock_class_key vlan_netdev_xmit_lock_key;
316 static int vlan_dev_init(struct net_device *dev)
318 struct net_device *real_dev = VLAN_DEV_INFO(dev)->real_dev;
320 /* IFF_BROADCAST|IFF_MULTICAST; ??? */
321 dev->flags = real_dev->flags & ~IFF_UP;
322 dev->iflink = real_dev->ifindex;
323 dev->state = (real_dev->state & ((1<<__LINK_STATE_NOCARRIER) |
324 (1<<__LINK_STATE_DORMANT))) |
325 (1<<__LINK_STATE_PRESENT);
327 if (is_zero_ether_addr(dev->dev_addr))
328 memcpy(dev->dev_addr, real_dev->dev_addr, dev->addr_len);
329 if (is_zero_ether_addr(dev->broadcast))
330 memcpy(dev->broadcast, real_dev->broadcast, dev->addr_len);
332 if (real_dev->features & NETIF_F_HW_VLAN_TX) {
333 dev->hard_header = real_dev->hard_header;
334 dev->hard_header_len = real_dev->hard_header_len;
335 dev->hard_start_xmit = vlan_dev_hwaccel_hard_start_xmit;
336 dev->rebuild_header = real_dev->rebuild_header;
338 dev->hard_header = vlan_dev_hard_header;
339 dev->hard_header_len = real_dev->hard_header_len + VLAN_HLEN;
340 dev->hard_start_xmit = vlan_dev_hard_start_xmit;
341 dev->rebuild_header = vlan_dev_rebuild_header;
343 dev->hard_header_parse = real_dev->hard_header_parse;
344 dev->hard_header_cache = NULL;
346 lockdep_set_class(&dev->_xmit_lock, &vlan_netdev_xmit_lock_key);
350 void vlan_setup(struct net_device *new_dev)
352 SET_MODULE_OWNER(new_dev);
354 ether_setup(new_dev);
356 /* new_dev->ifindex = 0; it will be set when added to
358 * iflink is set as well.
360 new_dev->get_stats = vlan_dev_get_stats;
362 /* Make this thing known as a VLAN device */
363 new_dev->priv_flags |= IFF_802_1Q_VLAN;
365 /* Set us up to have no queue, as the underlying Hardware device
366 * can do all the queueing we could want.
368 new_dev->tx_queue_len = 0;
370 /* set up method calls */
371 new_dev->change_mtu = vlan_dev_change_mtu;
372 new_dev->init = vlan_dev_init;
373 new_dev->open = vlan_dev_open;
374 new_dev->stop = vlan_dev_stop;
375 new_dev->set_multicast_list = vlan_dev_set_multicast_list;
376 new_dev->destructor = free_netdev;
377 new_dev->do_ioctl = vlan_dev_ioctl;
379 memset(new_dev->broadcast, 0, sizeof(ETH_ALEN));
382 static void vlan_transfer_operstate(const struct net_device *dev, struct net_device *vlandev)
384 /* Have to respect userspace enforced dormant state
385 * of real device, also must allow supplicant running
388 if (dev->operstate == IF_OPER_DORMANT)
389 netif_dormant_on(vlandev);
391 netif_dormant_off(vlandev);
393 if (netif_carrier_ok(dev)) {
394 if (!netif_carrier_ok(vlandev))
395 netif_carrier_on(vlandev);
397 if (netif_carrier_ok(vlandev))
398 netif_carrier_off(vlandev);
402 int vlan_check_real_dev(struct net_device *real_dev, unsigned short vlan_id)
404 if (real_dev->features & NETIF_F_VLAN_CHALLENGED) {
405 printk(VLAN_DBG "%s: VLANs not supported on %s.\n",
406 __FUNCTION__, real_dev->name);
410 if ((real_dev->features & NETIF_F_HW_VLAN_RX) &&
411 !real_dev->vlan_rx_register) {
412 printk(VLAN_DBG "%s: Device %s has buggy VLAN hw accel.\n",
413 __FUNCTION__, real_dev->name);
417 if ((real_dev->features & NETIF_F_HW_VLAN_FILTER) &&
418 (!real_dev->vlan_rx_add_vid || !real_dev->vlan_rx_kill_vid)) {
419 printk(VLAN_DBG "%s: Device %s has buggy VLAN hw accel.\n",
420 __FUNCTION__, real_dev->name);
424 /* The real device must be up and operating in order to
425 * assosciate a VLAN device with it.
427 if (!(real_dev->flags & IFF_UP))
430 if (__find_vlan_dev(real_dev, vlan_id) != NULL) {
431 /* was already registered. */
432 printk(VLAN_DBG "%s: ALREADY had VLAN registered\n", __FUNCTION__);
439 int register_vlan_dev(struct net_device *dev)
441 struct vlan_dev_info *vlan = VLAN_DEV_INFO(dev);
442 struct net_device *real_dev = vlan->real_dev;
443 unsigned short vlan_id = vlan->vlan_id;
444 struct vlan_group *grp, *ngrp = NULL;
447 grp = __vlan_find_group(real_dev->ifindex);
449 ngrp = grp = vlan_group_alloc(real_dev->ifindex);
454 err = register_netdevice(dev);
458 /* Account for reference in struct vlan_dev_info */
461 vlan_transfer_operstate(real_dev, dev);
462 linkwatch_fire_event(dev); /* _MUST_ call rfc2863_policy() */
464 /* So, got the sucker initialized, now lets place
465 * it into our local structure.
467 vlan_group_set_device(grp, vlan_id, dev);
468 if (ngrp && real_dev->features & NETIF_F_HW_VLAN_RX)
469 real_dev->vlan_rx_register(real_dev, ngrp);
470 if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
471 real_dev->vlan_rx_add_vid(real_dev, vlan_id);
473 if (vlan_proc_add_dev(dev) < 0)
474 printk(KERN_WARNING "VLAN: failed to add proc entry for %s\n",
480 vlan_group_free(ngrp);
484 /* Attach a VLAN device to a mac address (ie Ethernet Card).
485 * Returns 0 if the device was created or a negative error code otherwise.
487 static int register_vlan_device(struct net_device *real_dev,
488 unsigned short VLAN_ID)
490 struct net_device *new_dev;
495 printk(VLAN_DBG "%s: if_name -:%s:- vid: %i\n",
496 __FUNCTION__, eth_IF_name, VLAN_ID);
499 if (VLAN_ID >= VLAN_VID_MASK)
502 err = vlan_check_real_dev(real_dev, VLAN_ID);
506 /* Gotta set up the fields for the device. */
508 printk(VLAN_DBG "About to allocate name, vlan_name_type: %i\n",
511 switch (vlan_name_type) {
512 case VLAN_NAME_TYPE_RAW_PLUS_VID:
513 /* name will look like: eth1.0005 */
514 snprintf(name, IFNAMSIZ, "%s.%.4i", real_dev->name, VLAN_ID);
516 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD:
517 /* Put our vlan.VID in the name.
518 * Name will look like: vlan5
520 snprintf(name, IFNAMSIZ, "vlan%i", VLAN_ID);
522 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD:
523 /* Put our vlan.VID in the name.
524 * Name will look like: eth0.5
526 snprintf(name, IFNAMSIZ, "%s.%i", real_dev->name, VLAN_ID);
528 case VLAN_NAME_TYPE_PLUS_VID:
529 /* Put our vlan.VID in the name.
530 * Name will look like: vlan0005
533 snprintf(name, IFNAMSIZ, "vlan%.4i", VLAN_ID);
536 new_dev = alloc_netdev(sizeof(struct vlan_dev_info), name,
542 /* need 4 bytes for extra VLAN header info,
543 * hope the underlying device can handle it.
545 new_dev->mtu = real_dev->mtu;
548 printk(VLAN_DBG "Allocated new name -:%s:-\n", new_dev->name);
549 VLAN_MEM_DBG("new_dev->priv malloc, addr: %p size: %i\n",
551 sizeof(struct vlan_dev_info));
554 VLAN_DEV_INFO(new_dev)->vlan_id = VLAN_ID; /* 1 through VLAN_VID_MASK */
555 VLAN_DEV_INFO(new_dev)->real_dev = real_dev;
556 VLAN_DEV_INFO(new_dev)->dent = NULL;
557 VLAN_DEV_INFO(new_dev)->flags = VLAN_FLAG_REORDER_HDR;
559 new_dev->rtnl_link_ops = &vlan_link_ops;
560 err = register_vlan_dev(new_dev);
562 goto out_free_newdev;
564 /* Account for reference in struct vlan_dev_info */
567 printk(VLAN_DBG "Allocated new device successfully, returning.\n");
572 free_netdev(new_dev);
576 static void vlan_sync_address(struct net_device *dev,
577 struct net_device *vlandev)
579 struct vlan_dev_info *vlan = VLAN_DEV_INFO(vlandev);
581 /* May be called without an actual change */
582 if (!compare_ether_addr(vlan->real_dev_addr, dev->dev_addr))
585 /* vlan address was different from the old address and is equal to
587 if (compare_ether_addr(vlandev->dev_addr, vlan->real_dev_addr) &&
588 !compare_ether_addr(vlandev->dev_addr, dev->dev_addr))
589 dev_unicast_delete(dev, vlandev->dev_addr, ETH_ALEN);
591 /* vlan address was equal to the old address and is different from
593 if (!compare_ether_addr(vlandev->dev_addr, vlan->real_dev_addr) &&
594 compare_ether_addr(vlandev->dev_addr, dev->dev_addr))
595 dev_unicast_add(dev, vlandev->dev_addr, ETH_ALEN);
597 memcpy(vlan->real_dev_addr, dev->dev_addr, ETH_ALEN);
600 static int vlan_device_event(struct notifier_block *unused, unsigned long event, void *ptr)
602 struct net_device *dev = ptr;
603 struct vlan_group *grp = __vlan_find_group(dev->ifindex);
605 struct net_device *vlandev;
610 /* It is OK that we do not hold the group lock right now,
611 * as we run under the RTNL lock.
616 /* Propagate real device state to vlan devices */
617 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
618 vlandev = vlan_group_get_device(grp, i);
622 vlan_transfer_operstate(dev, vlandev);
626 case NETDEV_CHANGEADDR:
627 /* Adjust unicast filters on underlying device */
628 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
629 vlandev = vlan_group_get_device(grp, i);
633 vlan_sync_address(dev, vlandev);
638 /* Put all VLANs for this dev in the down state too. */
639 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
640 vlandev = vlan_group_get_device(grp, i);
644 flgs = vlandev->flags;
645 if (!(flgs & IFF_UP))
648 dev_change_flags(vlandev, flgs & ~IFF_UP);
653 /* Put all VLANs for this dev in the up state too. */
654 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
655 vlandev = vlan_group_get_device(grp, i);
659 flgs = vlandev->flags;
663 dev_change_flags(vlandev, flgs | IFF_UP);
667 case NETDEV_UNREGISTER:
668 /* Delete all VLANs for this dev. */
669 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
672 vlandev = vlan_group_get_device(grp, i);
676 ret = unregister_vlan_dev(dev,
677 VLAN_DEV_INFO(vlandev)->vlan_id);
679 unregister_netdevice(vlandev);
681 /* Group was destroyed? */
693 * VLAN IOCTL handler.
694 * o execute requested action or pass command to the device driver
695 * arg is really a struct vlan_ioctl_args __user *.
697 static int vlan_ioctl_handler(void __user *arg)
700 unsigned short vid = 0;
701 struct vlan_ioctl_args args;
702 struct net_device *dev = NULL;
704 if (copy_from_user(&args, arg, sizeof(struct vlan_ioctl_args)))
707 /* Null terminate this sucker, just in case. */
708 args.device1[23] = 0;
709 args.u.device2[23] = 0;
712 printk(VLAN_DBG "%s: args.cmd: %x\n", __FUNCTION__, args.cmd);
718 case SET_VLAN_INGRESS_PRIORITY_CMD:
719 case SET_VLAN_EGRESS_PRIORITY_CMD:
720 case SET_VLAN_FLAG_CMD:
723 case GET_VLAN_REALDEV_NAME_CMD:
724 case GET_VLAN_VID_CMD:
726 dev = __dev_get_by_name(args.device1);
731 if (args.cmd != ADD_VLAN_CMD &&
732 !(dev->priv_flags & IFF_802_1Q_VLAN))
737 case SET_VLAN_INGRESS_PRIORITY_CMD:
739 if (!capable(CAP_NET_ADMIN))
741 vlan_dev_set_ingress_priority(dev,
746 case SET_VLAN_EGRESS_PRIORITY_CMD:
748 if (!capable(CAP_NET_ADMIN))
750 err = vlan_dev_set_egress_priority(dev,
755 case SET_VLAN_FLAG_CMD:
757 if (!capable(CAP_NET_ADMIN))
759 err = vlan_dev_set_vlan_flag(dev,
764 case SET_VLAN_NAME_TYPE_CMD:
766 if (!capable(CAP_NET_ADMIN))
768 if ((args.u.name_type >= 0) &&
769 (args.u.name_type < VLAN_NAME_TYPE_HIGHEST)) {
770 vlan_name_type = args.u.name_type;
779 if (!capable(CAP_NET_ADMIN))
781 err = register_vlan_device(dev, args.u.VID);
786 if (!capable(CAP_NET_ADMIN))
788 err = unregister_vlan_device(dev);
791 case GET_VLAN_INGRESS_PRIORITY_CMD:
793 err = vlan_dev_get_ingress_priority(args);
794 if (copy_to_user((void*)arg, &args,
795 sizeof(struct vlan_ioctl_args))) {
801 case GET_VLAN_EGRESS_PRIORITY_CMD:
803 err = vlan_dev_get_egress_priority(args.device1, &(args.args);
804 if (copy_to_user((void*)arg, &args,
805 sizeof(struct vlan_ioctl_args))) {
811 case GET_VLAN_REALDEV_NAME_CMD:
812 vlan_dev_get_realdev_name(dev, args.u.device2);
813 if (copy_to_user(arg, &args,
814 sizeof(struct vlan_ioctl_args))) {
819 case GET_VLAN_VID_CMD:
820 vlan_dev_get_vid(dev, &vid);
822 if (copy_to_user(arg, &args,
823 sizeof(struct vlan_ioctl_args))) {
829 /* pass on to underlying device instead?? */
830 printk(VLAN_DBG "%s: Unknown VLAN CMD: %x \n",
831 __FUNCTION__, args.cmd);
840 MODULE_LICENSE("GPL");
841 MODULE_VERSION(DRV_VERSION);