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/module.h>
23 #include <linux/netdevice.h>
24 #include <linux/skbuff.h>
25 #include <net/datalink.h>
28 #include <linux/init.h>
29 #include <net/p8022.h>
31 #include <linux/rtnetlink.h>
32 #include <linux/notifier.h>
34 #include <linux/if_vlan.h>
38 #define DRV_VERSION "1.8"
40 /* Global VLAN variables */
42 /* Our listing of VLAN group(s) */
43 struct hlist_head vlan_group_hash[VLAN_GRP_HASH_SIZE];
44 #define vlan_grp_hashfn(IDX) ((((IDX) >> VLAN_GRP_HASH_SHIFT) ^ (IDX)) & VLAN_GRP_HASH_MASK)
46 static char vlan_fullname[] = "802.1Q VLAN Support";
47 static char vlan_version[] = DRV_VERSION;
48 static char vlan_copyright[] = "Ben Greear <greearb@candelatech.com>";
49 static char vlan_buggyright[] = "David S. Miller <davem@redhat.com>";
51 static int vlan_device_event(struct notifier_block *, unsigned long, void *);
52 static int vlan_ioctl_handler(void __user *);
53 static int unregister_vlan_dev(struct net_device *, unsigned short );
55 struct notifier_block vlan_notifier_block = {
56 .notifier_call = vlan_device_event,
59 /* These may be changed at run-time through IOCTLs */
61 /* Determines interface naming scheme. */
62 unsigned short vlan_name_type = VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD;
64 /* DO reorder the header by default */
65 unsigned short vlan_default_dev_flags = 1;
67 static struct packet_type vlan_packet_type = {
68 .type = __constant_htons(ETH_P_8021Q),
69 .func = vlan_skb_recv, /* VLAN receive method */
72 /* Bits of netdev state that are propagated from real device to virtual */
73 #define VLAN_LINK_STATE_MASK \
74 ((1<<__LINK_STATE_PRESENT)|(1<<__LINK_STATE_NOCARRIER))
76 /* End of global variables definitions. */
79 * Function vlan_proto_init (pro)
81 * Initialize VLAN protocol layer,
84 static int __init vlan_proto_init(void)
88 printk(VLAN_INF "%s v%s %s\n",
89 vlan_fullname, vlan_version, vlan_copyright);
90 printk(VLAN_INF "All bugs added by %s\n",
93 /* proc file system initialization */
94 err = vlan_proc_init();
97 "%s %s: can't create entry in proc filesystem!\n",
98 __FUNCTION__, VLAN_NAME);
102 dev_add_pack(&vlan_packet_type);
104 /* Register us to receive netdevice events */
105 err = register_netdevice_notifier(&vlan_notifier_block);
107 dev_remove_pack(&vlan_packet_type);
112 vlan_ioctl_set(vlan_ioctl_handler);
117 /* Cleanup all vlan devices
118 * Note: devices that have been registered that but not
119 * brought up will exist but have no module ref count.
121 static void __exit vlan_cleanup_devices(void)
123 struct net_device *dev, *nxt;
126 for (dev = dev_base; dev; dev = nxt) {
128 if (dev->priv_flags & IFF_802_1Q_VLAN) {
129 unregister_vlan_dev(VLAN_DEV_INFO(dev)->real_dev,
130 VLAN_DEV_INFO(dev)->vlan_id);
132 unregister_netdevice(dev);
139 * Module 'remove' entry point.
140 * o delete /proc/net/router directory and static entries.
142 static void __exit vlan_cleanup_module(void)
146 vlan_ioctl_set(NULL);
148 /* Un-register us from receiving netdevice events */
149 unregister_netdevice_notifier(&vlan_notifier_block);
151 dev_remove_pack(&vlan_packet_type);
152 vlan_cleanup_devices();
154 /* This table must be empty if there are no module
157 for (i = 0; i < VLAN_GRP_HASH_SIZE; i++) {
158 BUG_ON(!hlist_empty(&vlan_group_hash[i]));
165 module_init(vlan_proto_init);
166 module_exit(vlan_cleanup_module);
168 /* Must be invoked with RCU read lock (no preempt) */
169 static struct vlan_group *__vlan_find_group(int real_dev_ifindex)
171 struct vlan_group *grp;
172 struct hlist_node *n;
173 int hash = vlan_grp_hashfn(real_dev_ifindex);
175 hlist_for_each_entry_rcu(grp, n, &vlan_group_hash[hash], hlist) {
176 if (grp->real_dev_ifindex == real_dev_ifindex)
183 /* Find the protocol handler. Assumes VID < VLAN_VID_MASK.
185 * Must be invoked with RCU read lock (no preempt)
187 struct net_device *__find_vlan_dev(struct net_device *real_dev,
190 struct vlan_group *grp = __vlan_find_group(real_dev->ifindex);
193 return grp->vlan_devices[VID];
198 static void vlan_rcu_free(struct rcu_head *rcu)
200 kfree(container_of(rcu, struct vlan_group, rcu));
204 /* This returns 0 if everything went fine.
205 * It will return 1 if the group was killed as a result.
206 * A negative return indicates failure.
208 * The RTNL lock must be held.
210 static int unregister_vlan_dev(struct net_device *real_dev,
211 unsigned short vlan_id)
213 struct net_device *dev = NULL;
214 int real_dev_ifindex = real_dev->ifindex;
215 struct vlan_group *grp;
219 printk(VLAN_DBG "%s: VID: %i\n", __FUNCTION__, vlan_id);
223 if (vlan_id >= VLAN_VID_MASK)
227 grp = __vlan_find_group(real_dev_ifindex);
232 dev = grp->vlan_devices[vlan_id];
234 /* Remove proc entry */
235 vlan_proc_rem_dev(dev);
237 /* Take it out of our own structures, but be sure to
238 * interlock with HW accelerating devices or SW vlan
239 * input packet processing.
241 if (real_dev->features &
242 (NETIF_F_HW_VLAN_RX | NETIF_F_HW_VLAN_FILTER)) {
243 real_dev->vlan_rx_kill_vid(real_dev, vlan_id);
246 grp->vlan_devices[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 (grp->vlan_devices[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(const char *vlan_IF_name)
283 struct net_device *dev = NULL;
287 dev = dev_get_by_name(vlan_IF_name);
290 if (dev->priv_flags & IFF_802_1Q_VLAN) {
293 ret = unregister_vlan_dev(VLAN_DEV_INFO(dev)->real_dev,
294 VLAN_DEV_INFO(dev)->vlan_id);
297 unregister_netdevice(dev);
305 "%s: ERROR: Tried to remove a non-vlan device "
306 "with VLAN code, name: %s priv_flags: %hX\n",
307 __FUNCTION__, dev->name, dev->priv_flags);
313 printk(VLAN_DBG "%s: WARNING: Could not find dev.\n", __FUNCTION__);
321 static void vlan_setup(struct net_device *new_dev)
323 SET_MODULE_OWNER(new_dev);
325 /* new_dev->ifindex = 0; it will be set when added to
327 * iflink is set as well.
329 new_dev->get_stats = vlan_dev_get_stats;
331 /* Make this thing known as a VLAN device */
332 new_dev->priv_flags |= IFF_802_1Q_VLAN;
334 /* Set us up to have no queue, as the underlying Hardware device
335 * can do all the queueing we could want.
337 new_dev->tx_queue_len = 0;
339 /* set up method calls */
340 new_dev->change_mtu = vlan_dev_change_mtu;
341 new_dev->open = vlan_dev_open;
342 new_dev->stop = vlan_dev_stop;
343 new_dev->set_mac_address = vlan_dev_set_mac_address;
344 new_dev->set_multicast_list = vlan_dev_set_multicast_list;
345 new_dev->destructor = free_netdev;
346 new_dev->do_ioctl = vlan_dev_ioctl;
349 /* Attach a VLAN device to a mac address (ie Ethernet Card).
350 * Returns the device that was created, or NULL if there was
351 * an error of some kind.
353 static struct net_device *register_vlan_device(const char *eth_IF_name,
354 unsigned short VLAN_ID)
356 struct vlan_group *grp;
357 struct net_device *new_dev;
358 struct net_device *real_dev; /* the ethernet device */
362 printk(VLAN_DBG "%s: if_name -:%s:- vid: %i\n",
363 __FUNCTION__, eth_IF_name, VLAN_ID);
366 if (VLAN_ID >= VLAN_VID_MASK)
369 /* find the device relating to eth_IF_name. */
370 real_dev = dev_get_by_name(eth_IF_name);
374 if (real_dev->features & NETIF_F_VLAN_CHALLENGED) {
375 printk(VLAN_DBG "%s: VLANs not supported on %s.\n",
376 __FUNCTION__, real_dev->name);
380 if ((real_dev->features & NETIF_F_HW_VLAN_RX) &&
381 (real_dev->vlan_rx_register == NULL ||
382 real_dev->vlan_rx_kill_vid == NULL)) {
383 printk(VLAN_DBG "%s: Device %s has buggy VLAN hw accel.\n",
384 __FUNCTION__, real_dev->name);
388 if ((real_dev->features & NETIF_F_HW_VLAN_FILTER) &&
389 (real_dev->vlan_rx_add_vid == NULL ||
390 real_dev->vlan_rx_kill_vid == NULL)) {
391 printk(VLAN_DBG "%s: Device %s has buggy VLAN hw accel.\n",
392 __FUNCTION__, real_dev->name);
396 /* From this point on, all the data structures must remain
401 /* The real device must be up and operating in order to
402 * assosciate a VLAN device with it.
404 if (!(real_dev->flags & IFF_UP))
407 if (__find_vlan_dev(real_dev, VLAN_ID) != NULL) {
408 /* was already registered. */
409 printk(VLAN_DBG "%s: ALREADY had VLAN registered\n", __FUNCTION__);
413 /* Gotta set up the fields for the device. */
415 printk(VLAN_DBG "About to allocate name, vlan_name_type: %i\n",
418 switch (vlan_name_type) {
419 case VLAN_NAME_TYPE_RAW_PLUS_VID:
420 /* name will look like: eth1.0005 */
421 snprintf(name, IFNAMSIZ, "%s.%.4i", real_dev->name, VLAN_ID);
423 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD:
424 /* Put our vlan.VID in the name.
425 * Name will look like: vlan5
427 snprintf(name, IFNAMSIZ, "vlan%i", VLAN_ID);
429 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD:
430 /* Put our vlan.VID in the name.
431 * Name will look like: eth0.5
433 snprintf(name, IFNAMSIZ, "%s.%i", real_dev->name, VLAN_ID);
435 case VLAN_NAME_TYPE_PLUS_VID:
436 /* Put our vlan.VID in the name.
437 * Name will look like: vlan0005
440 snprintf(name, IFNAMSIZ, "vlan%.4i", VLAN_ID);
443 new_dev = alloc_netdev(sizeof(struct vlan_dev_info), name,
449 printk(VLAN_DBG "Allocated new name -:%s:-\n", new_dev->name);
451 /* IFF_BROADCAST|IFF_MULTICAST; ??? */
452 new_dev->flags = real_dev->flags;
453 new_dev->flags &= ~IFF_UP;
455 new_dev->state = real_dev->state & VLAN_LINK_STATE_MASK;
457 /* need 4 bytes for extra VLAN header info,
458 * hope the underlying device can handle it.
460 new_dev->mtu = real_dev->mtu;
462 /* TODO: maybe just assign it to be ETHERNET? */
463 new_dev->type = real_dev->type;
465 new_dev->hard_header_len = real_dev->hard_header_len;
466 if (!(real_dev->features & NETIF_F_HW_VLAN_TX)) {
467 /* Regular ethernet + 4 bytes (18 total). */
468 new_dev->hard_header_len += VLAN_HLEN;
471 VLAN_MEM_DBG("new_dev->priv malloc, addr: %p size: %i\n",
473 sizeof(struct vlan_dev_info));
475 memcpy(new_dev->broadcast, real_dev->broadcast, real_dev->addr_len);
476 memcpy(new_dev->dev_addr, real_dev->dev_addr, real_dev->addr_len);
477 new_dev->addr_len = real_dev->addr_len;
479 if (real_dev->features & NETIF_F_HW_VLAN_TX) {
480 new_dev->hard_header = real_dev->hard_header;
481 new_dev->hard_start_xmit = vlan_dev_hwaccel_hard_start_xmit;
482 new_dev->rebuild_header = real_dev->rebuild_header;
484 new_dev->hard_header = vlan_dev_hard_header;
485 new_dev->hard_start_xmit = vlan_dev_hard_start_xmit;
486 new_dev->rebuild_header = vlan_dev_rebuild_header;
488 new_dev->hard_header_parse = real_dev->hard_header_parse;
490 VLAN_DEV_INFO(new_dev)->vlan_id = VLAN_ID; /* 1 through VLAN_VID_MASK */
491 VLAN_DEV_INFO(new_dev)->real_dev = real_dev;
492 VLAN_DEV_INFO(new_dev)->dent = NULL;
493 VLAN_DEV_INFO(new_dev)->flags = vlan_default_dev_flags;
496 printk(VLAN_DBG "About to go find the group for idx: %i\n",
500 if (register_netdevice(new_dev))
501 goto out_free_newdev;
503 /* So, got the sucker initialized, now lets place
504 * it into our local structure.
506 grp = __vlan_find_group(real_dev->ifindex);
508 /* Note, we are running under the RTNL semaphore
509 * so it cannot "appear" on us.
511 if (!grp) { /* need to add a new group */
512 grp = kmalloc(sizeof(struct vlan_group), GFP_KERNEL);
514 goto out_free_unregister;
516 /* printk(KERN_ALERT "VLAN REGISTER: Allocated new group.\n"); */
517 memset(grp, 0, sizeof(struct vlan_group));
518 grp->real_dev_ifindex = real_dev->ifindex;
520 hlist_add_head_rcu(&grp->hlist,
521 &vlan_group_hash[vlan_grp_hashfn(real_dev->ifindex)]);
523 if (real_dev->features & NETIF_F_HW_VLAN_RX)
524 real_dev->vlan_rx_register(real_dev, grp);
527 grp->vlan_devices[VLAN_ID] = new_dev;
529 if (vlan_proc_add_dev(new_dev)<0)/* create it's proc entry */
530 printk(KERN_WARNING "VLAN: failed to add proc entry for %s\n",
533 if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
534 real_dev->vlan_rx_add_vid(real_dev, VLAN_ID);
540 printk(VLAN_DBG "Allocated new device successfully, returning.\n");
545 unregister_netdev(new_dev);
549 free_netdev(new_dev);
561 static int vlan_device_event(struct notifier_block *unused, unsigned long event, void *ptr)
563 struct net_device *dev = ptr;
564 struct vlan_group *grp = __vlan_find_group(dev->ifindex);
566 struct net_device *vlandev;
571 /* It is OK that we do not hold the group lock right now,
572 * as we run under the RTNL lock.
577 /* Propagate real device state to vlan devices */
578 flgs = dev->state & VLAN_LINK_STATE_MASK;
579 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
580 vlandev = grp->vlan_devices[i];
584 if ((vlandev->state & VLAN_LINK_STATE_MASK) != flgs) {
585 vlandev->state = (vlandev->state &~ VLAN_LINK_STATE_MASK)
587 netdev_state_change(vlandev);
593 /* Put all VLANs for this dev in the down state too. */
594 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
595 vlandev = grp->vlan_devices[i];
599 flgs = vlandev->flags;
600 if (!(flgs & IFF_UP))
603 dev_change_flags(vlandev, flgs & ~IFF_UP);
608 /* Put all VLANs for this dev in the up state too. */
609 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
610 vlandev = grp->vlan_devices[i];
614 flgs = vlandev->flags;
618 dev_change_flags(vlandev, flgs | IFF_UP);
622 case NETDEV_UNREGISTER:
623 /* Delete all VLANs for this dev. */
624 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
627 vlandev = grp->vlan_devices[i];
631 ret = unregister_vlan_dev(dev,
632 VLAN_DEV_INFO(vlandev)->vlan_id);
634 unregister_netdevice(vlandev);
636 /* Group was destroyed? */
648 * VLAN IOCTL handler.
649 * o execute requested action or pass command to the device driver
650 * arg is really a struct vlan_ioctl_args __user *.
652 static int vlan_ioctl_handler(void __user *arg)
655 unsigned short vid = 0;
656 struct vlan_ioctl_args args;
658 if (copy_from_user(&args, arg, sizeof(struct vlan_ioctl_args)))
661 /* Null terminate this sucker, just in case. */
662 args.device1[23] = 0;
663 args.u.device2[23] = 0;
666 printk(VLAN_DBG "%s: args.cmd: %x\n", __FUNCTION__, args.cmd);
670 case SET_VLAN_INGRESS_PRIORITY_CMD:
671 if (!capable(CAP_NET_ADMIN))
673 err = vlan_dev_set_ingress_priority(args.device1,
678 case SET_VLAN_EGRESS_PRIORITY_CMD:
679 if (!capable(CAP_NET_ADMIN))
681 err = vlan_dev_set_egress_priority(args.device1,
686 case SET_VLAN_FLAG_CMD:
687 if (!capable(CAP_NET_ADMIN))
689 err = vlan_dev_set_vlan_flag(args.device1,
694 case SET_VLAN_NAME_TYPE_CMD:
695 if (!capable(CAP_NET_ADMIN))
697 if ((args.u.name_type >= 0) &&
698 (args.u.name_type < VLAN_NAME_TYPE_HIGHEST)) {
699 vlan_name_type = args.u.name_type;
707 if (!capable(CAP_NET_ADMIN))
709 /* we have been given the name of the Ethernet Device we want to
710 * talk to: args.dev1 We also have the
711 * VLAN ID: args.u.VID
713 if (register_vlan_device(args.device1, args.u.VID)) {
721 if (!capable(CAP_NET_ADMIN))
723 /* Here, the args.dev1 is the actual VLAN we want
726 err = unregister_vlan_device(args.device1);
729 case GET_VLAN_INGRESS_PRIORITY_CMD:
731 err = vlan_dev_get_ingress_priority(args);
732 if (copy_to_user((void*)arg, &args,
733 sizeof(struct vlan_ioctl_args))) {
739 case GET_VLAN_EGRESS_PRIORITY_CMD:
741 err = vlan_dev_get_egress_priority(args.device1, &(args.args);
742 if (copy_to_user((void*)arg, &args,
743 sizeof(struct vlan_ioctl_args))) {
749 case GET_VLAN_REALDEV_NAME_CMD:
750 err = vlan_dev_get_realdev_name(args.device1, args.u.device2);
751 if (copy_to_user(arg, &args,
752 sizeof(struct vlan_ioctl_args))) {
757 case GET_VLAN_VID_CMD:
758 err = vlan_dev_get_vid(args.device1, &vid);
760 if (copy_to_user(arg, &args,
761 sizeof(struct vlan_ioctl_args))) {
767 /* pass on to underlying device instead?? */
768 printk(VLAN_DBG "%s: Unknown VLAN CMD: %x \n",
769 __FUNCTION__, args.cmd);
776 MODULE_LICENSE("GPL");
777 MODULE_VERSION(DRV_VERSION);