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 <linux/capability.h>
22 #include <linux/module.h>
23 #include <linux/netdevice.h>
24 #include <linux/skbuff.h>
25 #include <linux/init.h>
26 #include <linux/rculist.h>
27 #include <net/p8022.h>
29 #include <linux/rtnetlink.h>
30 #include <linux/notifier.h>
31 #include <net/rtnetlink.h>
32 #include <net/net_namespace.h>
33 #include <net/netns/generic.h>
34 #include <asm/uaccess.h>
36 #include <linux/if_vlan.h>
40 #define DRV_VERSION "1.8"
42 /* Global VLAN variables */
46 /* Our listing of VLAN group(s) */
47 static struct hlist_head vlan_group_hash[VLAN_GRP_HASH_SIZE];
49 const char vlan_fullname[] = "802.1Q VLAN Support";
50 const char vlan_version[] = DRV_VERSION;
51 static const char vlan_copyright[] = "Ben Greear <greearb@candelatech.com>";
52 static const char vlan_buggyright[] = "David S. Miller <davem@redhat.com>";
54 static struct packet_type vlan_packet_type = {
55 .type = __constant_htons(ETH_P_8021Q),
56 .func = vlan_skb_recv, /* VLAN receive method */
59 /* End of global variables definitions. */
61 static inline unsigned int vlan_grp_hashfn(unsigned int idx)
63 return ((idx >> VLAN_GRP_HASH_SHIFT) ^ idx) & VLAN_GRP_HASH_MASK;
66 /* Must be invoked with RCU read lock (no preempt) */
67 static struct vlan_group *__vlan_find_group(struct net_device *real_dev)
69 struct vlan_group *grp;
71 int hash = vlan_grp_hashfn(real_dev->ifindex);
73 hlist_for_each_entry_rcu(grp, n, &vlan_group_hash[hash], hlist) {
74 if (grp->real_dev == real_dev)
81 /* Find the protocol handler. Assumes VID < VLAN_VID_MASK.
83 * Must be invoked with RCU read lock (no preempt)
85 struct net_device *__find_vlan_dev(struct net_device *real_dev, u16 vlan_id)
87 struct vlan_group *grp = __vlan_find_group(real_dev);
90 return vlan_group_get_device(grp, vlan_id);
95 static void vlan_group_free(struct vlan_group *grp)
99 for (i = 0; i < VLAN_GROUP_ARRAY_SPLIT_PARTS; i++)
100 kfree(grp->vlan_devices_arrays[i]);
104 static struct vlan_group *vlan_group_alloc(struct net_device *real_dev)
106 struct vlan_group *grp;
108 grp = kzalloc(sizeof(struct vlan_group), GFP_KERNEL);
112 grp->real_dev = real_dev;
113 hlist_add_head_rcu(&grp->hlist,
114 &vlan_group_hash[vlan_grp_hashfn(real_dev->ifindex)]);
118 static int vlan_group_prealloc_vid(struct vlan_group *vg, u16 vlan_id)
120 struct net_device **array;
125 array = vg->vlan_devices_arrays[vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
129 size = sizeof(struct net_device *) * VLAN_GROUP_ARRAY_PART_LEN;
130 array = kzalloc(size, GFP_KERNEL);
134 vg->vlan_devices_arrays[vlan_id / VLAN_GROUP_ARRAY_PART_LEN] = array;
138 static void vlan_rcu_free(struct rcu_head *rcu)
140 vlan_group_free(container_of(rcu, struct vlan_group, rcu));
143 void unregister_vlan_dev(struct net_device *dev)
145 struct vlan_dev_info *vlan = vlan_dev_info(dev);
146 struct net_device *real_dev = vlan->real_dev;
147 struct vlan_group *grp;
148 u16 vlan_id = vlan->vlan_id;
152 grp = __vlan_find_group(real_dev);
155 /* Take it out of our own structures, but be sure to interlock with
156 * HW accelerating devices or SW vlan input packet processing.
158 if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
159 real_dev->vlan_rx_kill_vid(real_dev, vlan_id);
161 vlan_group_set_device(grp, vlan_id, NULL);
166 unregister_netdevice(dev);
168 /* If the group is now empty, kill off the group. */
169 if (grp->nr_vlans == 0) {
170 vlan_gvrp_uninit_applicant(real_dev);
172 if (real_dev->features & NETIF_F_HW_VLAN_RX)
173 real_dev->vlan_rx_register(real_dev, NULL);
175 hlist_del_rcu(&grp->hlist);
177 /* Free the group, after all cpu's are done. */
178 call_rcu(&grp->rcu, vlan_rcu_free);
181 /* Get rid of the vlan's reference to real_dev */
185 static void vlan_transfer_operstate(const struct net_device *dev,
186 struct net_device *vlandev)
188 /* Have to respect userspace enforced dormant state
189 * of real device, also must allow supplicant running
192 if (dev->operstate == IF_OPER_DORMANT)
193 netif_dormant_on(vlandev);
195 netif_dormant_off(vlandev);
197 if (netif_carrier_ok(dev)) {
198 if (!netif_carrier_ok(vlandev))
199 netif_carrier_on(vlandev);
201 if (netif_carrier_ok(vlandev))
202 netif_carrier_off(vlandev);
206 int vlan_check_real_dev(struct net_device *real_dev, u16 vlan_id)
208 char *name = real_dev->name;
210 if (real_dev->features & NETIF_F_VLAN_CHALLENGED) {
211 pr_info("8021q: VLANs not supported on %s\n", name);
215 if ((real_dev->features & NETIF_F_HW_VLAN_RX) &&
216 !real_dev->vlan_rx_register) {
217 pr_info("8021q: device %s has buggy VLAN hw accel\n", name);
221 if ((real_dev->features & NETIF_F_HW_VLAN_FILTER) &&
222 (!real_dev->vlan_rx_add_vid || !real_dev->vlan_rx_kill_vid)) {
223 pr_info("8021q: Device %s has buggy VLAN hw accel\n", name);
227 /* The real device must be up and operating in order to
228 * assosciate a VLAN device with it.
230 if (!(real_dev->flags & IFF_UP))
233 if (__find_vlan_dev(real_dev, vlan_id) != NULL)
239 int register_vlan_dev(struct net_device *dev)
241 struct vlan_dev_info *vlan = vlan_dev_info(dev);
242 struct net_device *real_dev = vlan->real_dev;
243 u16 vlan_id = vlan->vlan_id;
244 struct vlan_group *grp, *ngrp = NULL;
247 grp = __vlan_find_group(real_dev);
249 ngrp = grp = vlan_group_alloc(real_dev);
252 err = vlan_gvrp_init_applicant(real_dev);
257 err = vlan_group_prealloc_vid(grp, vlan_id);
259 goto out_uninit_applicant;
261 err = register_netdevice(dev);
263 goto out_uninit_applicant;
265 /* Account for reference in struct vlan_dev_info */
268 vlan_transfer_operstate(real_dev, dev);
269 linkwatch_fire_event(dev); /* _MUST_ call rfc2863_policy() */
271 /* So, got the sucker initialized, now lets place
272 * it into our local structure.
274 vlan_group_set_device(grp, vlan_id, dev);
277 if (ngrp && real_dev->features & NETIF_F_HW_VLAN_RX)
278 real_dev->vlan_rx_register(real_dev, ngrp);
279 if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
280 real_dev->vlan_rx_add_vid(real_dev, vlan_id);
284 out_uninit_applicant:
286 vlan_gvrp_uninit_applicant(real_dev);
289 vlan_group_free(ngrp);
293 /* Attach a VLAN device to a mac address (ie Ethernet Card).
294 * Returns 0 if the device was created or a negative error code otherwise.
296 static int register_vlan_device(struct net_device *real_dev, u16 vlan_id)
298 struct net_device *new_dev;
299 struct net *net = dev_net(real_dev);
300 struct vlan_net *vn = net_generic(net, vlan_net_id);
304 if (vlan_id >= VLAN_VID_MASK)
307 err = vlan_check_real_dev(real_dev, vlan_id);
311 /* Gotta set up the fields for the device. */
312 switch (vn->name_type) {
313 case VLAN_NAME_TYPE_RAW_PLUS_VID:
314 /* name will look like: eth1.0005 */
315 snprintf(name, IFNAMSIZ, "%s.%.4i", real_dev->name, vlan_id);
317 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD:
318 /* Put our vlan.VID in the name.
319 * Name will look like: vlan5
321 snprintf(name, IFNAMSIZ, "vlan%i", vlan_id);
323 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD:
324 /* Put our vlan.VID in the name.
325 * Name will look like: eth0.5
327 snprintf(name, IFNAMSIZ, "%s.%i", real_dev->name, vlan_id);
329 case VLAN_NAME_TYPE_PLUS_VID:
330 /* Put our vlan.VID in the name.
331 * Name will look like: vlan0005
334 snprintf(name, IFNAMSIZ, "vlan%.4i", vlan_id);
337 new_dev = alloc_netdev(sizeof(struct vlan_dev_info), name,
343 dev_net_set(new_dev, net);
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;
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_transfer_features(struct net_device *dev,
391 struct net_device *vlandev)
393 unsigned long old_features = vlandev->features;
395 vlandev->features &= ~dev->vlan_features;
396 vlandev->features |= dev->features & dev->vlan_features;
397 vlandev->gso_max_size = dev->gso_max_size;
399 if (old_features != vlandev->features)
400 netdev_features_change(vlandev);
403 static void __vlan_device_event(struct net_device *dev, unsigned long event)
406 case NETDEV_CHANGENAME:
407 vlan_proc_rem_dev(dev);
408 if (vlan_proc_add_dev(dev) < 0)
409 pr_warning("8021q: failed to change proc name for %s\n",
412 case NETDEV_REGISTER:
413 if (vlan_proc_add_dev(dev) < 0)
414 pr_warning("8021q: failed to add proc entry for %s\n",
417 case NETDEV_UNREGISTER:
418 vlan_proc_rem_dev(dev);
423 static int vlan_device_event(struct notifier_block *unused, unsigned long event,
426 struct net_device *dev = ptr;
427 struct vlan_group *grp;
429 struct net_device *vlandev;
431 if (is_vlan_dev(dev))
432 __vlan_device_event(dev, event);
434 grp = __vlan_find_group(dev);
438 /* It is OK that we do not hold the group lock right now,
439 * as we run under the RTNL lock.
444 /* Propagate real device state to vlan devices */
445 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
446 vlandev = vlan_group_get_device(grp, i);
450 vlan_transfer_operstate(dev, vlandev);
454 case NETDEV_CHANGEADDR:
455 /* Adjust unicast filters on underlying device */
456 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
457 vlandev = vlan_group_get_device(grp, i);
461 flgs = vlandev->flags;
462 if (!(flgs & IFF_UP))
465 vlan_sync_address(dev, vlandev);
469 case NETDEV_FEAT_CHANGE:
470 /* Propagate device features to underlying device */
471 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
472 vlandev = vlan_group_get_device(grp, i);
476 vlan_transfer_features(dev, vlandev);
482 /* Put all VLANs for this dev in the down state too. */
483 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
484 vlandev = vlan_group_get_device(grp, i);
488 flgs = vlandev->flags;
489 if (!(flgs & IFF_UP))
492 dev_change_flags(vlandev, flgs & ~IFF_UP);
497 /* Put all VLANs for this dev in the up state too. */
498 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
499 vlandev = vlan_group_get_device(grp, i);
503 flgs = vlandev->flags;
507 dev_change_flags(vlandev, flgs | IFF_UP);
511 case NETDEV_UNREGISTER:
512 /* Delete all VLANs for this dev. */
513 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
514 vlandev = vlan_group_get_device(grp, i);
518 /* unregistration of last vlan destroys group, abort
520 if (grp->nr_vlans == 1)
521 i = VLAN_GROUP_ARRAY_LEN;
523 unregister_vlan_dev(vlandev);
532 static struct notifier_block vlan_notifier_block __read_mostly = {
533 .notifier_call = vlan_device_event,
537 * VLAN IOCTL handler.
538 * o execute requested action or pass command to the device driver
539 * arg is really a struct vlan_ioctl_args __user *.
541 static int vlan_ioctl_handler(struct net *net, void __user *arg)
544 struct vlan_ioctl_args args;
545 struct net_device *dev = NULL;
547 if (copy_from_user(&args, arg, sizeof(struct vlan_ioctl_args)))
550 /* Null terminate this sucker, just in case. */
551 args.device1[23] = 0;
552 args.u.device2[23] = 0;
557 case SET_VLAN_INGRESS_PRIORITY_CMD:
558 case SET_VLAN_EGRESS_PRIORITY_CMD:
559 case SET_VLAN_FLAG_CMD:
562 case GET_VLAN_REALDEV_NAME_CMD:
563 case GET_VLAN_VID_CMD:
565 dev = __dev_get_by_name(net, args.device1);
570 if (args.cmd != ADD_VLAN_CMD && !is_vlan_dev(dev))
575 case SET_VLAN_INGRESS_PRIORITY_CMD:
577 if (!capable(CAP_NET_ADMIN))
579 vlan_dev_set_ingress_priority(dev,
585 case SET_VLAN_EGRESS_PRIORITY_CMD:
587 if (!capable(CAP_NET_ADMIN))
589 err = vlan_dev_set_egress_priority(dev,
594 case SET_VLAN_FLAG_CMD:
596 if (!capable(CAP_NET_ADMIN))
598 err = vlan_dev_change_flags(dev,
599 args.vlan_qos ? args.u.flag : 0,
603 case SET_VLAN_NAME_TYPE_CMD:
605 if (!capable(CAP_NET_ADMIN))
607 if ((args.u.name_type >= 0) &&
608 (args.u.name_type < VLAN_NAME_TYPE_HIGHEST)) {
611 vn = net_generic(net, vlan_net_id);
612 vn->name_type = args.u.name_type;
621 if (!capable(CAP_NET_ADMIN))
623 err = register_vlan_device(dev, args.u.VID);
628 if (!capable(CAP_NET_ADMIN))
630 unregister_vlan_dev(dev);
634 case GET_VLAN_REALDEV_NAME_CMD:
636 vlan_dev_get_realdev_name(dev, args.u.device2);
637 if (copy_to_user(arg, &args,
638 sizeof(struct vlan_ioctl_args)))
642 case GET_VLAN_VID_CMD:
644 args.u.VID = vlan_dev_vlan_id(dev);
645 if (copy_to_user(arg, &args,
646 sizeof(struct vlan_ioctl_args)))
659 static int vlan_init_net(struct net *net)
665 vn = kzalloc(sizeof(struct vlan_net), GFP_KERNEL);
669 err = net_assign_generic(net, vlan_net_id, vn);
673 vn->name_type = VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD;
675 err = vlan_proc_init(net);
689 static void vlan_exit_net(struct net *net)
693 vn = net_generic(net, vlan_net_id);
694 rtnl_kill_links(net, &vlan_link_ops);
695 vlan_proc_cleanup(net);
699 static struct pernet_operations vlan_net_ops = {
700 .init = vlan_init_net,
701 .exit = vlan_exit_net,
704 static int __init vlan_proto_init(void)
708 pr_info("%s v%s %s\n", vlan_fullname, vlan_version, vlan_copyright);
709 pr_info("All bugs added by %s\n", vlan_buggyright);
711 err = register_pernet_gen_device(&vlan_net_id, &vlan_net_ops);
715 err = register_netdevice_notifier(&vlan_notifier_block);
719 err = vlan_gvrp_init();
723 err = vlan_netlink_init();
727 dev_add_pack(&vlan_packet_type);
728 vlan_ioctl_set(vlan_ioctl_handler);
734 unregister_netdevice_notifier(&vlan_notifier_block);
736 unregister_pernet_gen_device(vlan_net_id, &vlan_net_ops);
741 static void __exit vlan_cleanup_module(void)
745 vlan_ioctl_set(NULL);
748 unregister_netdevice_notifier(&vlan_notifier_block);
750 dev_remove_pack(&vlan_packet_type);
752 /* This table must be empty if there are no module references left. */
753 for (i = 0; i < VLAN_GRP_HASH_SIZE; i++)
754 BUG_ON(!hlist_empty(&vlan_group_hash[i]));
756 unregister_pernet_gen_device(vlan_net_id, &vlan_net_ops);
762 module_init(vlan_proto_init);
763 module_exit(vlan_cleanup_module);
765 MODULE_LICENSE("GPL");
766 MODULE_VERSION(DRV_VERSION);