3 * Ethernet-type device handling.
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
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>
35 #include <net/netns/generic.h>
37 #include <linux/if_vlan.h>
41 #define DRV_VERSION "1.8"
43 /* Global VLAN variables */
47 /* Our listing of VLAN group(s) */
48 static struct hlist_head vlan_group_hash[VLAN_GRP_HASH_SIZE];
50 static char vlan_fullname[] = "802.1Q VLAN Support";
51 static char vlan_version[] = DRV_VERSION;
52 static char vlan_copyright[] = "Ben Greear <greearb@candelatech.com>";
53 static char vlan_buggyright[] = "David S. Miller <davem@redhat.com>";
55 /* Determines interface naming scheme. */
56 unsigned short vlan_name_type = VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD;
58 static struct packet_type vlan_packet_type = {
59 .type = __constant_htons(ETH_P_8021Q),
60 .func = vlan_skb_recv, /* VLAN receive method */
63 /* End of global variables definitions. */
65 static inline unsigned int vlan_grp_hashfn(unsigned int idx)
67 return ((idx >> VLAN_GRP_HASH_SHIFT) ^ idx) & VLAN_GRP_HASH_MASK;
70 /* Must be invoked with RCU read lock (no preempt) */
71 static struct vlan_group *__vlan_find_group(struct net_device *real_dev)
73 struct vlan_group *grp;
75 int hash = vlan_grp_hashfn(real_dev->ifindex);
77 hlist_for_each_entry_rcu(grp, n, &vlan_group_hash[hash], hlist) {
78 if (grp->real_dev == real_dev)
85 /* Find the protocol handler. Assumes VID < VLAN_VID_MASK.
87 * Must be invoked with RCU read lock (no preempt)
89 struct net_device *__find_vlan_dev(struct net_device *real_dev,
92 struct vlan_group *grp = __vlan_find_group(real_dev);
95 return vlan_group_get_device(grp, VID);
100 static void vlan_group_free(struct vlan_group *grp)
104 for (i = 0; i < VLAN_GROUP_ARRAY_SPLIT_PARTS; i++)
105 kfree(grp->vlan_devices_arrays[i]);
109 static struct vlan_group *vlan_group_alloc(struct net_device *real_dev)
111 struct vlan_group *grp;
113 grp = kzalloc(sizeof(struct vlan_group), GFP_KERNEL);
117 grp->real_dev = real_dev;
118 hlist_add_head_rcu(&grp->hlist,
119 &vlan_group_hash[vlan_grp_hashfn(real_dev->ifindex)]);
123 static int vlan_group_prealloc_vid(struct vlan_group *vg, int vid)
125 struct net_device **array;
130 array = vg->vlan_devices_arrays[vid / VLAN_GROUP_ARRAY_PART_LEN];
134 size = sizeof(struct net_device *) * VLAN_GROUP_ARRAY_PART_LEN;
135 array = kzalloc(size, GFP_KERNEL);
139 vg->vlan_devices_arrays[vid / VLAN_GROUP_ARRAY_PART_LEN] = array;
143 static void vlan_rcu_free(struct rcu_head *rcu)
145 vlan_group_free(container_of(rcu, struct vlan_group, rcu));
148 void unregister_vlan_dev(struct net_device *dev)
150 struct vlan_dev_info *vlan = vlan_dev_info(dev);
151 struct net_device *real_dev = vlan->real_dev;
152 struct vlan_group *grp;
153 unsigned short vlan_id = vlan->vlan_id;
157 grp = __vlan_find_group(real_dev);
160 vlan_proc_rem_dev(dev);
162 /* Take it out of our own structures, but be sure to interlock with
163 * HW accelerating devices or SW vlan input packet processing.
165 if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
166 real_dev->vlan_rx_kill_vid(real_dev, vlan_id);
168 vlan_group_set_device(grp, vlan_id, NULL);
173 /* If the group is now empty, kill off the group. */
174 if (grp->nr_vlans == 0) {
175 if (real_dev->features & NETIF_F_HW_VLAN_RX)
176 real_dev->vlan_rx_register(real_dev, NULL);
178 hlist_del_rcu(&grp->hlist);
180 /* Free the group, after all cpu's are done. */
181 call_rcu(&grp->rcu, vlan_rcu_free);
184 /* Get rid of the vlan's reference to real_dev */
187 unregister_netdevice(dev);
190 static void vlan_transfer_operstate(const struct net_device *dev,
191 struct net_device *vlandev)
193 /* Have to respect userspace enforced dormant state
194 * of real device, also must allow supplicant running
197 if (dev->operstate == IF_OPER_DORMANT)
198 netif_dormant_on(vlandev);
200 netif_dormant_off(vlandev);
202 if (netif_carrier_ok(dev)) {
203 if (!netif_carrier_ok(vlandev))
204 netif_carrier_on(vlandev);
206 if (netif_carrier_ok(vlandev))
207 netif_carrier_off(vlandev);
211 int vlan_check_real_dev(struct net_device *real_dev, unsigned short vlan_id)
213 char *name = real_dev->name;
215 if (real_dev->features & NETIF_F_VLAN_CHALLENGED) {
216 pr_info("8021q: VLANs not supported on %s\n", name);
220 if ((real_dev->features & NETIF_F_HW_VLAN_RX) &&
221 !real_dev->vlan_rx_register) {
222 pr_info("8021q: device %s has buggy VLAN hw accel\n", name);
226 if ((real_dev->features & NETIF_F_HW_VLAN_FILTER) &&
227 (!real_dev->vlan_rx_add_vid || !real_dev->vlan_rx_kill_vid)) {
228 pr_info("8021q: Device %s has buggy VLAN hw accel\n", name);
232 /* The real device must be up and operating in order to
233 * assosciate a VLAN device with it.
235 if (!(real_dev->flags & IFF_UP))
238 if (__find_vlan_dev(real_dev, vlan_id) != NULL)
244 int register_vlan_dev(struct net_device *dev)
246 struct vlan_dev_info *vlan = vlan_dev_info(dev);
247 struct net_device *real_dev = vlan->real_dev;
248 unsigned short vlan_id = vlan->vlan_id;
249 struct vlan_group *grp, *ngrp = NULL;
252 grp = __vlan_find_group(real_dev);
254 ngrp = grp = vlan_group_alloc(real_dev);
259 err = vlan_group_prealloc_vid(grp, vlan_id);
263 err = register_netdevice(dev);
267 /* Account for reference in struct vlan_dev_info */
270 vlan_transfer_operstate(real_dev, dev);
271 linkwatch_fire_event(dev); /* _MUST_ call rfc2863_policy() */
273 /* So, got the sucker initialized, now lets place
274 * it into our local structure.
276 vlan_group_set_device(grp, vlan_id, dev);
279 if (ngrp && real_dev->features & NETIF_F_HW_VLAN_RX)
280 real_dev->vlan_rx_register(real_dev, ngrp);
281 if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
282 real_dev->vlan_rx_add_vid(real_dev, vlan_id);
284 if (vlan_proc_add_dev(dev) < 0)
285 pr_warning("8021q: failed to add proc entry for %s\n",
291 vlan_group_free(ngrp);
295 /* Attach a VLAN device to a mac address (ie Ethernet Card).
296 * Returns 0 if the device was created or a negative error code otherwise.
298 static int register_vlan_device(struct net_device *real_dev,
299 unsigned short VLAN_ID)
301 struct net_device *new_dev;
305 if (VLAN_ID >= VLAN_VID_MASK)
308 err = vlan_check_real_dev(real_dev, VLAN_ID);
312 /* Gotta set up the fields for the device. */
313 switch (vlan_name_type) {
314 case VLAN_NAME_TYPE_RAW_PLUS_VID:
315 /* name will look like: eth1.0005 */
316 snprintf(name, IFNAMSIZ, "%s.%.4i", real_dev->name, VLAN_ID);
318 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD:
319 /* Put our vlan.VID in the name.
320 * Name will look like: vlan5
322 snprintf(name, IFNAMSIZ, "vlan%i", VLAN_ID);
324 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD:
325 /* Put our vlan.VID in the name.
326 * Name will look like: eth0.5
328 snprintf(name, IFNAMSIZ, "%s.%i", real_dev->name, VLAN_ID);
330 case VLAN_NAME_TYPE_PLUS_VID:
331 /* Put our vlan.VID in the name.
332 * Name will look like: vlan0005
335 snprintf(name, IFNAMSIZ, "vlan%.4i", VLAN_ID);
338 new_dev = alloc_netdev(sizeof(struct vlan_dev_info), name,
344 /* need 4 bytes for extra VLAN header info,
345 * hope the underlying device can handle it.
347 new_dev->mtu = real_dev->mtu;
349 vlan_dev_info(new_dev)->vlan_id = VLAN_ID; /* 1 through VLAN_VID_MASK */
350 vlan_dev_info(new_dev)->real_dev = real_dev;
351 vlan_dev_info(new_dev)->dent = NULL;
352 vlan_dev_info(new_dev)->flags = VLAN_FLAG_REORDER_HDR;
354 new_dev->rtnl_link_ops = &vlan_link_ops;
355 err = register_vlan_dev(new_dev);
357 goto out_free_newdev;
362 free_netdev(new_dev);
366 static void vlan_sync_address(struct net_device *dev,
367 struct net_device *vlandev)
369 struct vlan_dev_info *vlan = vlan_dev_info(vlandev);
371 /* May be called without an actual change */
372 if (!compare_ether_addr(vlan->real_dev_addr, dev->dev_addr))
375 /* vlan address was different from the old address and is equal to
377 if (compare_ether_addr(vlandev->dev_addr, vlan->real_dev_addr) &&
378 !compare_ether_addr(vlandev->dev_addr, dev->dev_addr))
379 dev_unicast_delete(dev, vlandev->dev_addr, ETH_ALEN);
381 /* vlan address was equal to the old address and is different from
383 if (!compare_ether_addr(vlandev->dev_addr, vlan->real_dev_addr) &&
384 compare_ether_addr(vlandev->dev_addr, dev->dev_addr))
385 dev_unicast_add(dev, vlandev->dev_addr, ETH_ALEN);
387 memcpy(vlan->real_dev_addr, dev->dev_addr, ETH_ALEN);
390 static void __vlan_device_event(struct net_device *dev, unsigned long event)
393 case NETDEV_CHANGENAME:
394 vlan_proc_rem_dev(dev);
395 if (vlan_proc_add_dev(dev) < 0)
396 pr_warning("8021q: failed to change proc name for %s\n",
402 static int vlan_device_event(struct notifier_block *unused, unsigned long event,
405 struct net_device *dev = ptr;
406 struct vlan_group *grp;
408 struct net_device *vlandev;
410 if (dev_net(dev) != &init_net)
413 if (is_vlan_dev(dev)) {
414 __vlan_device_event(dev, event);
418 grp = __vlan_find_group(dev);
422 /* It is OK that we do not hold the group lock right now,
423 * as we run under the RTNL lock.
428 /* Propagate real device state to vlan devices */
429 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
430 vlandev = vlan_group_get_device(grp, i);
434 vlan_transfer_operstate(dev, vlandev);
438 case NETDEV_CHANGEADDR:
439 /* Adjust unicast filters on underlying device */
440 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
441 vlandev = vlan_group_get_device(grp, i);
445 flgs = vlandev->flags;
446 if (!(flgs & IFF_UP))
449 vlan_sync_address(dev, vlandev);
454 /* Put all VLANs for this dev in the down state too. */
455 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
456 vlandev = vlan_group_get_device(grp, i);
460 flgs = vlandev->flags;
461 if (!(flgs & IFF_UP))
464 dev_change_flags(vlandev, flgs & ~IFF_UP);
469 /* Put all VLANs for this dev in the up state too. */
470 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
471 vlandev = vlan_group_get_device(grp, i);
475 flgs = vlandev->flags;
479 dev_change_flags(vlandev, flgs | IFF_UP);
483 case NETDEV_UNREGISTER:
484 /* Delete all VLANs for this dev. */
485 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
486 vlandev = vlan_group_get_device(grp, i);
490 /* unregistration of last vlan destroys group, abort
492 if (grp->nr_vlans == 1)
493 i = VLAN_GROUP_ARRAY_LEN;
495 unregister_vlan_dev(vlandev);
504 static struct notifier_block vlan_notifier_block __read_mostly = {
505 .notifier_call = vlan_device_event,
509 * VLAN IOCTL handler.
510 * o execute requested action or pass command to the device driver
511 * arg is really a struct vlan_ioctl_args __user *.
513 static int vlan_ioctl_handler(struct net *net, void __user *arg)
516 unsigned short vid = 0;
517 struct vlan_ioctl_args args;
518 struct net_device *dev = NULL;
520 if (copy_from_user(&args, arg, sizeof(struct vlan_ioctl_args)))
523 /* Null terminate this sucker, just in case. */
524 args.device1[23] = 0;
525 args.u.device2[23] = 0;
530 case SET_VLAN_INGRESS_PRIORITY_CMD:
531 case SET_VLAN_EGRESS_PRIORITY_CMD:
532 case SET_VLAN_FLAG_CMD:
535 case GET_VLAN_REALDEV_NAME_CMD:
536 case GET_VLAN_VID_CMD:
538 dev = __dev_get_by_name(&init_net, args.device1);
543 if (args.cmd != ADD_VLAN_CMD &&
544 !(dev->priv_flags & IFF_802_1Q_VLAN))
549 case SET_VLAN_INGRESS_PRIORITY_CMD:
551 if (!capable(CAP_NET_ADMIN))
553 vlan_dev_set_ingress_priority(dev,
559 case SET_VLAN_EGRESS_PRIORITY_CMD:
561 if (!capable(CAP_NET_ADMIN))
563 err = vlan_dev_set_egress_priority(dev,
568 case SET_VLAN_FLAG_CMD:
570 if (!capable(CAP_NET_ADMIN))
572 err = vlan_dev_set_vlan_flag(dev,
577 case SET_VLAN_NAME_TYPE_CMD:
579 if (!capable(CAP_NET_ADMIN))
581 if ((args.u.name_type >= 0) &&
582 (args.u.name_type < VLAN_NAME_TYPE_HIGHEST)) {
583 vlan_name_type = args.u.name_type;
592 if (!capable(CAP_NET_ADMIN))
594 err = register_vlan_device(dev, args.u.VID);
599 if (!capable(CAP_NET_ADMIN))
601 unregister_vlan_dev(dev);
605 case GET_VLAN_REALDEV_NAME_CMD:
607 vlan_dev_get_realdev_name(dev, args.u.device2);
608 if (copy_to_user(arg, &args,
609 sizeof(struct vlan_ioctl_args)))
613 case GET_VLAN_VID_CMD:
615 vlan_dev_get_vid(dev, &vid);
617 if (copy_to_user(arg, &args,
618 sizeof(struct vlan_ioctl_args)))
631 static int vlan_init_net(struct net *net)
637 vn = kzalloc(sizeof(struct vlan_net), GFP_KERNEL);
641 err = net_assign_generic(net, vlan_net_id, vn);
645 err = vlan_proc_init(net);
659 static void vlan_exit_net(struct net *net)
663 vn = net_generic(net, vlan_net_id);
664 vlan_proc_cleanup(net);
668 static struct pernet_operations vlan_net_ops = {
669 .init = vlan_init_net,
670 .exit = vlan_exit_net,
673 static int __init vlan_proto_init(void)
677 pr_info("%s v%s %s\n", vlan_fullname, vlan_version, vlan_copyright);
678 pr_info("All bugs added by %s\n", vlan_buggyright);
680 err = register_pernet_gen_device(&vlan_net_id, &vlan_net_ops);
684 err = register_netdevice_notifier(&vlan_notifier_block);
688 err = vlan_netlink_init();
692 dev_add_pack(&vlan_packet_type);
693 vlan_ioctl_set(vlan_ioctl_handler);
697 unregister_netdevice_notifier(&vlan_notifier_block);
699 unregister_pernet_gen_device(vlan_net_id, &vlan_net_ops);
704 static void __exit vlan_cleanup_module(void)
708 vlan_ioctl_set(NULL);
711 unregister_netdevice_notifier(&vlan_notifier_block);
713 dev_remove_pack(&vlan_packet_type);
715 /* This table must be empty if there are no module references left. */
716 for (i = 0; i < VLAN_GRP_HASH_SIZE; i++)
717 BUG_ON(!hlist_empty(&vlan_group_hash[i]));
719 unregister_pernet_gen_device(vlan_net_id, &vlan_net_ops);
724 module_init(vlan_proto_init);
725 module_exit(vlan_cleanup_module);
727 MODULE_LICENSE("GPL");
728 MODULE_VERSION(DRV_VERSION);