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);
101 dev_remove_pack(&vlan_packet_type);
106 vlan_ioctl_set(vlan_ioctl_handler);
111 /* Cleanup all vlan devices
112 * Note: devices that have been registered that but not
113 * brought up will exist but have no module ref count.
115 static void __exit vlan_cleanup_devices(void)
117 struct net_device *dev, *nxt;
120 for_each_netdev_safe(dev, nxt) {
121 if (dev->priv_flags & IFF_802_1Q_VLAN) {
122 unregister_vlan_dev(VLAN_DEV_INFO(dev)->real_dev,
123 VLAN_DEV_INFO(dev)->vlan_id);
125 unregister_netdevice(dev);
132 * Module 'remove' entry point.
133 * o delete /proc/net/router directory and static entries.
135 static void __exit vlan_cleanup_module(void)
139 vlan_ioctl_set(NULL);
141 /* Un-register us from receiving netdevice events */
142 unregister_netdevice_notifier(&vlan_notifier_block);
144 dev_remove_pack(&vlan_packet_type);
145 vlan_cleanup_devices();
147 /* This table must be empty if there are no module
150 for (i = 0; i < VLAN_GRP_HASH_SIZE; i++) {
151 BUG_ON(!hlist_empty(&vlan_group_hash[i]));
158 module_init(vlan_proto_init);
159 module_exit(vlan_cleanup_module);
161 /* Must be invoked with RCU read lock (no preempt) */
162 static struct vlan_group *__vlan_find_group(int real_dev_ifindex)
164 struct vlan_group *grp;
165 struct hlist_node *n;
166 int hash = vlan_grp_hashfn(real_dev_ifindex);
168 hlist_for_each_entry_rcu(grp, n, &vlan_group_hash[hash], hlist) {
169 if (grp->real_dev_ifindex == real_dev_ifindex)
176 /* Find the protocol handler. Assumes VID < VLAN_VID_MASK.
178 * Must be invoked with RCU read lock (no preempt)
180 struct net_device *__find_vlan_dev(struct net_device *real_dev,
183 struct vlan_group *grp = __vlan_find_group(real_dev->ifindex);
186 return vlan_group_get_device(grp, VID);
191 static void vlan_group_free(struct vlan_group *grp)
195 for (i=0; i < VLAN_GROUP_ARRAY_SPLIT_PARTS; i++)
196 kfree(grp->vlan_devices_arrays[i]);
200 static void vlan_rcu_free(struct rcu_head *rcu)
202 vlan_group_free(container_of(rcu, struct vlan_group, rcu));
206 /* This returns 0 if everything went fine.
207 * It will return 1 if the group was killed as a result.
208 * A negative return indicates failure.
210 * The RTNL lock must be held.
212 static int unregister_vlan_dev(struct net_device *real_dev,
213 unsigned short vlan_id)
215 struct net_device *dev = NULL;
216 int real_dev_ifindex = real_dev->ifindex;
217 struct vlan_group *grp;
221 printk(VLAN_DBG "%s: VID: %i\n", __FUNCTION__, vlan_id);
225 if (vlan_id >= VLAN_VID_MASK)
229 grp = __vlan_find_group(real_dev_ifindex);
234 dev = vlan_group_get_device(grp, vlan_id);
236 /* Remove proc entry */
237 vlan_proc_rem_dev(dev);
239 /* Take it out of our own structures, but be sure to
240 * interlock with HW accelerating devices or SW vlan
241 * input packet processing.
243 if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
244 real_dev->vlan_rx_kill_vid(real_dev, vlan_id);
246 vlan_group_set_device(grp, vlan_id, NULL);
250 /* Caller unregisters (and if necessary, puts)
251 * VLAN device, but we get rid of the reference to
256 /* If the group is now empty, kill off the
259 for (i = 0; i < VLAN_VID_MASK; i++)
260 if (vlan_group_get_device(grp, i))
263 if (i == VLAN_VID_MASK) {
264 if (real_dev->features & NETIF_F_HW_VLAN_RX)
265 real_dev->vlan_rx_register(real_dev, NULL);
267 hlist_del_rcu(&grp->hlist);
269 /* Free the group, after all cpu's are done. */
270 call_rcu(&grp->rcu, vlan_rcu_free);
281 static int unregister_vlan_device(struct net_device *dev)
285 ret = unregister_vlan_dev(VLAN_DEV_INFO(dev)->real_dev,
286 VLAN_DEV_INFO(dev)->vlan_id);
287 unregister_netdevice(dev);
295 * vlan network devices have devices nesting below it, and are a special
296 * "super class" of normal network devices; split their locks off into a
297 * separate class since they always nest.
299 static struct lock_class_key vlan_netdev_xmit_lock_key;
301 static int vlan_dev_init(struct net_device *dev)
303 struct net_device *real_dev = VLAN_DEV_INFO(dev)->real_dev;
305 /* IFF_BROADCAST|IFF_MULTICAST; ??? */
306 dev->flags = real_dev->flags & ~IFF_UP;
307 dev->iflink = real_dev->ifindex;
308 dev->state = (real_dev->state & ((1<<__LINK_STATE_NOCARRIER) |
309 (1<<__LINK_STATE_DORMANT))) |
310 (1<<__LINK_STATE_PRESENT);
312 /* TODO: maybe just assign it to be ETHERNET? */
313 dev->type = real_dev->type;
315 memcpy(dev->broadcast, real_dev->broadcast, real_dev->addr_len);
316 memcpy(dev->dev_addr, real_dev->dev_addr, real_dev->addr_len);
317 dev->addr_len = real_dev->addr_len;
319 if (real_dev->features & NETIF_F_HW_VLAN_TX) {
320 dev->hard_header = real_dev->hard_header;
321 dev->hard_header_len = real_dev->hard_header_len;
322 dev->hard_start_xmit = vlan_dev_hwaccel_hard_start_xmit;
323 dev->rebuild_header = real_dev->rebuild_header;
325 dev->hard_header = vlan_dev_hard_header;
326 dev->hard_header_len = real_dev->hard_header_len + VLAN_HLEN;
327 dev->hard_start_xmit = vlan_dev_hard_start_xmit;
328 dev->rebuild_header = vlan_dev_rebuild_header;
330 dev->hard_header_parse = real_dev->hard_header_parse;
332 lockdep_set_class(&dev->_xmit_lock, &vlan_netdev_xmit_lock_key);
336 static void vlan_setup(struct net_device *new_dev)
338 SET_MODULE_OWNER(new_dev);
340 /* new_dev->ifindex = 0; it will be set when added to
342 * iflink is set as well.
344 new_dev->get_stats = vlan_dev_get_stats;
346 /* Make this thing known as a VLAN device */
347 new_dev->priv_flags |= IFF_802_1Q_VLAN;
349 /* Set us up to have no queue, as the underlying Hardware device
350 * can do all the queueing we could want.
352 new_dev->tx_queue_len = 0;
354 /* set up method calls */
355 new_dev->change_mtu = vlan_dev_change_mtu;
356 new_dev->init = vlan_dev_init;
357 new_dev->open = vlan_dev_open;
358 new_dev->stop = vlan_dev_stop;
359 new_dev->set_mac_address = vlan_dev_set_mac_address;
360 new_dev->set_multicast_list = vlan_dev_set_multicast_list;
361 new_dev->destructor = free_netdev;
362 new_dev->do_ioctl = vlan_dev_ioctl;
365 static void vlan_transfer_operstate(const struct net_device *dev, struct net_device *vlandev)
367 /* Have to respect userspace enforced dormant state
368 * of real device, also must allow supplicant running
371 if (dev->operstate == IF_OPER_DORMANT)
372 netif_dormant_on(vlandev);
374 netif_dormant_off(vlandev);
376 if (netif_carrier_ok(dev)) {
377 if (!netif_carrier_ok(vlandev))
378 netif_carrier_on(vlandev);
380 if (netif_carrier_ok(vlandev))
381 netif_carrier_off(vlandev);
385 /* Attach a VLAN device to a mac address (ie Ethernet Card).
386 * Returns the device that was created, or NULL if there was
387 * an error of some kind.
389 static struct net_device *register_vlan_device(struct net_device *real_dev,
390 unsigned short VLAN_ID)
392 struct vlan_group *grp;
393 struct net_device *new_dev;
398 printk(VLAN_DBG "%s: if_name -:%s:- vid: %i\n",
399 __FUNCTION__, eth_IF_name, VLAN_ID);
402 if (VLAN_ID >= VLAN_VID_MASK)
405 if (real_dev->features & NETIF_F_VLAN_CHALLENGED) {
406 printk(VLAN_DBG "%s: VLANs not supported on %s.\n",
407 __FUNCTION__, real_dev->name);
411 if ((real_dev->features & NETIF_F_HW_VLAN_RX) &&
412 !real_dev->vlan_rx_register) {
413 printk(VLAN_DBG "%s: Device %s has buggy VLAN hw accel.\n",
414 __FUNCTION__, real_dev->name);
418 if ((real_dev->features & NETIF_F_HW_VLAN_FILTER) &&
419 (!real_dev->vlan_rx_add_vid || !real_dev->vlan_rx_kill_vid)) {
420 printk(VLAN_DBG "%s: Device %s has buggy VLAN hw accel.\n",
421 __FUNCTION__, real_dev->name);
425 /* The real device must be up and operating in order to
426 * assosciate a VLAN device with it.
428 if (!(real_dev->flags & IFF_UP))
431 if (__find_vlan_dev(real_dev, VLAN_ID) != NULL) {
432 /* was already registered. */
433 printk(VLAN_DBG "%s: ALREADY had VLAN registered\n", __FUNCTION__);
437 /* Gotta set up the fields for the device. */
439 printk(VLAN_DBG "About to allocate name, vlan_name_type: %i\n",
442 switch (vlan_name_type) {
443 case VLAN_NAME_TYPE_RAW_PLUS_VID:
444 /* name will look like: eth1.0005 */
445 snprintf(name, IFNAMSIZ, "%s.%.4i", real_dev->name, VLAN_ID);
447 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD:
448 /* Put our vlan.VID in the name.
449 * Name will look like: vlan5
451 snprintf(name, IFNAMSIZ, "vlan%i", VLAN_ID);
453 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD:
454 /* Put our vlan.VID in the name.
455 * Name will look like: eth0.5
457 snprintf(name, IFNAMSIZ, "%s.%i", real_dev->name, VLAN_ID);
459 case VLAN_NAME_TYPE_PLUS_VID:
460 /* Put our vlan.VID in the name.
461 * Name will look like: vlan0005
464 snprintf(name, IFNAMSIZ, "vlan%.4i", VLAN_ID);
467 new_dev = alloc_netdev(sizeof(struct vlan_dev_info), name,
473 /* need 4 bytes for extra VLAN header info,
474 * hope the underlying device can handle it.
476 new_dev->mtu = real_dev->mtu;
479 printk(VLAN_DBG "Allocated new name -:%s:-\n", new_dev->name);
480 VLAN_MEM_DBG("new_dev->priv malloc, addr: %p size: %i\n",
482 sizeof(struct vlan_dev_info));
485 VLAN_DEV_INFO(new_dev)->vlan_id = VLAN_ID; /* 1 through VLAN_VID_MASK */
486 VLAN_DEV_INFO(new_dev)->real_dev = real_dev;
487 VLAN_DEV_INFO(new_dev)->dent = NULL;
488 VLAN_DEV_INFO(new_dev)->flags = 1;
491 printk(VLAN_DBG "About to go find the group for idx: %i\n",
495 if (register_netdevice(new_dev))
496 goto out_free_newdev;
498 vlan_transfer_operstate(real_dev, new_dev);
499 linkwatch_fire_event(new_dev); /* _MUST_ call rfc2863_policy() */
501 /* So, got the sucker initialized, now lets place
502 * it into our local structure.
504 grp = __vlan_find_group(real_dev->ifindex);
506 /* Note, we are running under the RTNL semaphore
507 * so it cannot "appear" on us.
509 if (!grp) { /* need to add a new group */
510 grp = kzalloc(sizeof(struct vlan_group), GFP_KERNEL);
512 goto out_free_unregister;
514 for (i=0; i < VLAN_GROUP_ARRAY_SPLIT_PARTS; i++) {
515 grp->vlan_devices_arrays[i] = kzalloc(
516 sizeof(struct net_device *)*VLAN_GROUP_ARRAY_PART_LEN,
519 if (!grp->vlan_devices_arrays[i])
520 goto out_free_arrays;
523 /* printk(KERN_ALERT "VLAN REGISTER: Allocated new group.\n"); */
524 grp->real_dev_ifindex = real_dev->ifindex;
526 hlist_add_head_rcu(&grp->hlist,
527 &vlan_group_hash[vlan_grp_hashfn(real_dev->ifindex)]);
529 if (real_dev->features & NETIF_F_HW_VLAN_RX)
530 real_dev->vlan_rx_register(real_dev, grp);
533 vlan_group_set_device(grp, VLAN_ID, new_dev);
535 if (vlan_proc_add_dev(new_dev)<0)/* create it's proc entry */
536 printk(KERN_WARNING "VLAN: failed to add proc entry for %s\n",
539 if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
540 real_dev->vlan_rx_add_vid(real_dev, VLAN_ID);
542 /* Account for reference in struct vlan_dev_info */
545 printk(VLAN_DBG "Allocated new device successfully, returning.\n");
550 vlan_group_free(grp);
553 unregister_netdev(new_dev);
557 free_netdev(new_dev);
563 static int vlan_device_event(struct notifier_block *unused, unsigned long event, void *ptr)
565 struct net_device *dev = ptr;
566 struct vlan_group *grp = __vlan_find_group(dev->ifindex);
568 struct net_device *vlandev;
573 /* It is OK that we do not hold the group lock right now,
574 * as we run under the RTNL lock.
579 /* Propagate real device state to vlan devices */
580 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
581 vlandev = vlan_group_get_device(grp, i);
585 vlan_transfer_operstate(dev, vlandev);
590 /* Put all VLANs for this dev in the down state too. */
591 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
592 vlandev = vlan_group_get_device(grp, i);
596 flgs = vlandev->flags;
597 if (!(flgs & IFF_UP))
600 dev_change_flags(vlandev, flgs & ~IFF_UP);
605 /* Put all VLANs for this dev in the up state too. */
606 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
607 vlandev = vlan_group_get_device(grp, i);
611 flgs = vlandev->flags;
615 dev_change_flags(vlandev, flgs | IFF_UP);
619 case NETDEV_UNREGISTER:
620 /* Delete all VLANs for this dev. */
621 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
624 vlandev = vlan_group_get_device(grp, i);
628 ret = unregister_vlan_dev(dev,
629 VLAN_DEV_INFO(vlandev)->vlan_id);
631 unregister_netdevice(vlandev);
633 /* Group was destroyed? */
645 * VLAN IOCTL handler.
646 * o execute requested action or pass command to the device driver
647 * arg is really a struct vlan_ioctl_args __user *.
649 static int vlan_ioctl_handler(void __user *arg)
652 unsigned short vid = 0;
653 struct vlan_ioctl_args args;
654 struct net_device *dev = NULL;
656 if (copy_from_user(&args, arg, sizeof(struct vlan_ioctl_args)))
659 /* Null terminate this sucker, just in case. */
660 args.device1[23] = 0;
661 args.u.device2[23] = 0;
664 printk(VLAN_DBG "%s: args.cmd: %x\n", __FUNCTION__, args.cmd);
670 case SET_VLAN_INGRESS_PRIORITY_CMD:
671 case SET_VLAN_EGRESS_PRIORITY_CMD:
672 case SET_VLAN_FLAG_CMD:
675 case GET_VLAN_REALDEV_NAME_CMD:
676 case GET_VLAN_VID_CMD:
678 dev = __dev_get_by_name(args.device1);
683 if (args.cmd != ADD_VLAN_CMD &&
684 !(dev->priv_flags & IFF_802_1Q_VLAN))
689 case SET_VLAN_INGRESS_PRIORITY_CMD:
691 if (!capable(CAP_NET_ADMIN))
693 vlan_dev_set_ingress_priority(dev,
698 case SET_VLAN_EGRESS_PRIORITY_CMD:
700 if (!capable(CAP_NET_ADMIN))
702 err = vlan_dev_set_egress_priority(dev,
707 case SET_VLAN_FLAG_CMD:
709 if (!capable(CAP_NET_ADMIN))
711 err = vlan_dev_set_vlan_flag(dev,
716 case SET_VLAN_NAME_TYPE_CMD:
718 if (!capable(CAP_NET_ADMIN))
720 if ((args.u.name_type >= 0) &&
721 (args.u.name_type < VLAN_NAME_TYPE_HIGHEST)) {
722 vlan_name_type = args.u.name_type;
731 if (!capable(CAP_NET_ADMIN))
733 if (register_vlan_device(dev, args.u.VID)) {
742 if (!capable(CAP_NET_ADMIN))
744 err = unregister_vlan_device(dev);
747 case GET_VLAN_INGRESS_PRIORITY_CMD:
749 err = vlan_dev_get_ingress_priority(args);
750 if (copy_to_user((void*)arg, &args,
751 sizeof(struct vlan_ioctl_args))) {
757 case GET_VLAN_EGRESS_PRIORITY_CMD:
759 err = vlan_dev_get_egress_priority(args.device1, &(args.args);
760 if (copy_to_user((void*)arg, &args,
761 sizeof(struct vlan_ioctl_args))) {
767 case GET_VLAN_REALDEV_NAME_CMD:
768 vlan_dev_get_realdev_name(dev, args.u.device2);
769 if (copy_to_user(arg, &args,
770 sizeof(struct vlan_ioctl_args))) {
775 case GET_VLAN_VID_CMD:
776 vlan_dev_get_vid(dev, &vid);
778 if (copy_to_user(arg, &args,
779 sizeof(struct vlan_ioctl_args))) {
785 /* pass on to underlying device instead?? */
786 printk(VLAN_DBG "%s: Unknown VLAN CMD: %x \n",
787 __FUNCTION__, args.cmd);
796 MODULE_LICENSE("GPL");
797 MODULE_VERSION(DRV_VERSION);