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/slab.h>
26 #include <linux/init.h>
27 #include <linux/rculist.h>
28 #include <net/p8022.h>
30 #include <linux/rtnetlink.h>
31 #include <linux/notifier.h>
32 #include <net/rtnetlink.h>
33 #include <net/net_namespace.h>
34 #include <net/netns/generic.h>
35 #include <asm/uaccess.h>
37 #include <linux/if_vlan.h>
41 #define DRV_VERSION "1.8"
43 /* Global VLAN variables */
45 int vlan_net_id __read_mostly;
47 /* Our listing of VLAN group(s) */
48 static struct hlist_head vlan_group_hash[VLAN_GRP_HASH_SIZE];
50 const char vlan_fullname[] = "802.1Q VLAN Support";
51 const char vlan_version[] = DRV_VERSION;
52 static const char vlan_copyright[] = "Ben Greear <greearb@candelatech.com>";
53 static const char vlan_buggyright[] = "David S. Miller <davem@redhat.com>";
55 static struct packet_type vlan_packet_type __read_mostly = {
56 .type = cpu_to_be16(ETH_P_8021Q),
57 .func = vlan_skb_recv, /* VLAN receive method */
60 /* End of global variables definitions. */
62 static inline unsigned int vlan_grp_hashfn(unsigned int idx)
64 return ((idx >> VLAN_GRP_HASH_SHIFT) ^ idx) & VLAN_GRP_HASH_MASK;
67 /* Must be invoked with RCU read lock (no preempt) */
68 static struct vlan_group *__vlan_find_group(struct net_device *real_dev)
70 struct vlan_group *grp;
72 int hash = vlan_grp_hashfn(real_dev->ifindex);
74 hlist_for_each_entry_rcu(grp, n, &vlan_group_hash[hash], hlist) {
75 if (grp->real_dev == real_dev)
82 /* Find the protocol handler. Assumes VID < VLAN_VID_MASK.
84 * Must be invoked with RCU read lock (no preempt)
86 struct net_device *__find_vlan_dev(struct net_device *real_dev, u16 vlan_id)
88 struct vlan_group *grp = __vlan_find_group(real_dev);
91 return vlan_group_get_device(grp, vlan_id);
96 static void vlan_group_free(struct vlan_group *grp)
100 for (i = 0; i < VLAN_GROUP_ARRAY_SPLIT_PARTS; i++)
101 kfree(grp->vlan_devices_arrays[i]);
105 static struct vlan_group *vlan_group_alloc(struct net_device *real_dev)
107 struct vlan_group *grp;
109 grp = kzalloc(sizeof(struct vlan_group), GFP_KERNEL);
113 grp->real_dev = real_dev;
114 hlist_add_head_rcu(&grp->hlist,
115 &vlan_group_hash[vlan_grp_hashfn(real_dev->ifindex)]);
119 static int vlan_group_prealloc_vid(struct vlan_group *vg, u16 vlan_id)
121 struct net_device **array;
126 array = vg->vlan_devices_arrays[vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
130 size = sizeof(struct net_device *) * VLAN_GROUP_ARRAY_PART_LEN;
131 array = kzalloc(size, GFP_KERNEL);
135 vg->vlan_devices_arrays[vlan_id / VLAN_GROUP_ARRAY_PART_LEN] = array;
139 static void vlan_rcu_free(struct rcu_head *rcu)
141 vlan_group_free(container_of(rcu, struct vlan_group, rcu));
144 void unregister_vlan_dev(struct net_device *dev, struct list_head *head)
146 struct vlan_dev_info *vlan = vlan_dev_info(dev);
147 struct net_device *real_dev = vlan->real_dev;
148 const struct net_device_ops *ops = real_dev->netdev_ops;
149 struct vlan_group *grp;
150 u16 vlan_id = vlan->vlan_id;
154 grp = __vlan_find_group(real_dev);
157 /* Take it out of our own structures, but be sure to interlock with
158 * HW accelerating devices or SW vlan input packet processing if
159 * VLAN is not 0 (leave it there for 802.1p).
161 if (vlan_id && (real_dev->features & NETIF_F_HW_VLAN_FILTER))
162 ops->ndo_vlan_rx_kill_vid(real_dev, vlan_id);
166 vlan_group_set_device(grp, vlan_id, NULL);
170 unregister_netdevice_queue(dev, head);
172 /* If the group is now empty, kill off the group. */
173 if (grp->nr_vlans == 0) {
174 vlan_gvrp_uninit_applicant(real_dev);
176 if (real_dev->features & NETIF_F_HW_VLAN_RX)
177 ops->ndo_vlan_rx_register(real_dev, NULL);
179 hlist_del_rcu(&grp->hlist);
181 /* Free the group, after all cpu's are done. */
182 call_rcu(&grp->rcu, vlan_rcu_free);
185 /* Get rid of the vlan's reference to real_dev */
189 int vlan_check_real_dev(struct net_device *real_dev, u16 vlan_id)
191 const char *name = real_dev->name;
192 const struct net_device_ops *ops = real_dev->netdev_ops;
194 if (real_dev->features & NETIF_F_VLAN_CHALLENGED) {
195 pr_info("8021q: VLANs not supported on %s\n", name);
199 if ((real_dev->features & NETIF_F_HW_VLAN_RX) && !ops->ndo_vlan_rx_register) {
200 pr_info("8021q: device %s has buggy VLAN hw accel\n", name);
204 if ((real_dev->features & NETIF_F_HW_VLAN_FILTER) &&
205 (!ops->ndo_vlan_rx_add_vid || !ops->ndo_vlan_rx_kill_vid)) {
206 pr_info("8021q: Device %s has buggy VLAN hw accel\n", name);
210 if (__find_vlan_dev(real_dev, vlan_id) != NULL)
216 int register_vlan_dev(struct net_device *dev)
218 struct vlan_dev_info *vlan = vlan_dev_info(dev);
219 struct net_device *real_dev = vlan->real_dev;
220 const struct net_device_ops *ops = real_dev->netdev_ops;
221 u16 vlan_id = vlan->vlan_id;
222 struct vlan_group *grp, *ngrp = NULL;
225 grp = __vlan_find_group(real_dev);
227 ngrp = grp = vlan_group_alloc(real_dev);
230 err = vlan_gvrp_init_applicant(real_dev);
235 err = vlan_group_prealloc_vid(grp, vlan_id);
237 goto out_uninit_applicant;
239 err = register_netdevice(dev);
241 goto out_uninit_applicant;
243 /* Account for reference in struct vlan_dev_info */
246 netif_stacked_transfer_operstate(real_dev, dev);
247 linkwatch_fire_event(dev); /* _MUST_ call rfc2863_policy() */
249 /* So, got the sucker initialized, now lets place
250 * it into our local structure.
252 vlan_group_set_device(grp, vlan_id, dev);
255 if (ngrp && real_dev->features & NETIF_F_HW_VLAN_RX)
256 ops->ndo_vlan_rx_register(real_dev, ngrp);
257 if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
258 ops->ndo_vlan_rx_add_vid(real_dev, vlan_id);
262 out_uninit_applicant:
264 vlan_gvrp_uninit_applicant(real_dev);
267 hlist_del_rcu(&ngrp->hlist);
268 /* Free the group, after all cpu's are done. */
269 call_rcu(&ngrp->rcu, vlan_rcu_free);
274 /* Attach a VLAN device to a mac address (ie Ethernet Card).
275 * Returns 0 if the device was created or a negative error code otherwise.
277 static int register_vlan_device(struct net_device *real_dev, u16 vlan_id)
279 struct net_device *new_dev;
280 struct net *net = dev_net(real_dev);
281 struct vlan_net *vn = net_generic(net, vlan_net_id);
285 if (vlan_id >= VLAN_VID_MASK)
288 err = vlan_check_real_dev(real_dev, vlan_id);
292 /* Gotta set up the fields for the device. */
293 switch (vn->name_type) {
294 case VLAN_NAME_TYPE_RAW_PLUS_VID:
295 /* name will look like: eth1.0005 */
296 snprintf(name, IFNAMSIZ, "%s.%.4i", real_dev->name, vlan_id);
298 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD:
299 /* Put our vlan.VID in the name.
300 * Name will look like: vlan5
302 snprintf(name, IFNAMSIZ, "vlan%i", vlan_id);
304 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD:
305 /* Put our vlan.VID in the name.
306 * Name will look like: eth0.5
308 snprintf(name, IFNAMSIZ, "%s.%i", real_dev->name, vlan_id);
310 case VLAN_NAME_TYPE_PLUS_VID:
311 /* Put our vlan.VID in the name.
312 * Name will look like: vlan0005
315 snprintf(name, IFNAMSIZ, "vlan%.4i", vlan_id);
318 new_dev = alloc_netdev_mq(sizeof(struct vlan_dev_info), name,
319 vlan_setup, real_dev->num_tx_queues);
324 new_dev->real_num_tx_queues = real_dev->real_num_tx_queues;
325 dev_net_set(new_dev, net);
326 /* need 4 bytes for extra VLAN header info,
327 * hope the underlying device can handle it.
329 new_dev->mtu = real_dev->mtu;
331 vlan_dev_info(new_dev)->vlan_id = vlan_id;
332 vlan_dev_info(new_dev)->real_dev = real_dev;
333 vlan_dev_info(new_dev)->dent = NULL;
334 vlan_dev_info(new_dev)->flags = VLAN_FLAG_REORDER_HDR;
336 new_dev->rtnl_link_ops = &vlan_link_ops;
337 err = register_vlan_dev(new_dev);
339 goto out_free_newdev;
344 free_netdev(new_dev);
348 static void vlan_sync_address(struct net_device *dev,
349 struct net_device *vlandev)
351 struct vlan_dev_info *vlan = vlan_dev_info(vlandev);
353 /* May be called without an actual change */
354 if (!compare_ether_addr(vlan->real_dev_addr, dev->dev_addr))
357 /* vlan address was different from the old address and is equal to
359 if (compare_ether_addr(vlandev->dev_addr, vlan->real_dev_addr) &&
360 !compare_ether_addr(vlandev->dev_addr, dev->dev_addr))
361 dev_uc_del(dev, vlandev->dev_addr);
363 /* vlan address was equal to the old address and is different from
365 if (!compare_ether_addr(vlandev->dev_addr, vlan->real_dev_addr) &&
366 compare_ether_addr(vlandev->dev_addr, dev->dev_addr))
367 dev_uc_add(dev, vlandev->dev_addr);
369 memcpy(vlan->real_dev_addr, dev->dev_addr, ETH_ALEN);
372 static void vlan_transfer_features(struct net_device *dev,
373 struct net_device *vlandev)
375 unsigned long old_features = vlandev->features;
377 vlandev->features &= ~dev->vlan_features;
378 vlandev->features |= dev->features & dev->vlan_features;
379 vlandev->gso_max_size = dev->gso_max_size;
380 #if defined(CONFIG_FCOE) || defined(CONFIG_FCOE_MODULE)
381 vlandev->fcoe_ddp_xid = dev->fcoe_ddp_xid;
383 vlandev->real_num_tx_queues = dev->real_num_tx_queues;
384 BUG_ON(vlandev->real_num_tx_queues > vlandev->num_tx_queues);
386 if (old_features != vlandev->features)
387 netdev_features_change(vlandev);
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",
399 case NETDEV_REGISTER:
400 if (vlan_proc_add_dev(dev) < 0)
401 pr_warning("8021q: failed to add proc entry for %s\n",
404 case NETDEV_UNREGISTER:
405 vlan_proc_rem_dev(dev);
410 static int vlan_device_event(struct notifier_block *unused, unsigned long event,
413 struct net_device *dev = ptr;
414 struct vlan_group *grp;
416 struct net_device *vlandev;
417 struct vlan_dev_info *vlan;
420 if (is_vlan_dev(dev))
421 __vlan_device_event(dev, event);
423 if ((event == NETDEV_UP) &&
424 (dev->features & NETIF_F_HW_VLAN_FILTER) &&
425 dev->netdev_ops->ndo_vlan_rx_add_vid) {
426 pr_info("8021q: adding VLAN 0 to HW filter on device %s\n",
428 dev->netdev_ops->ndo_vlan_rx_add_vid(dev, 0);
431 grp = __vlan_find_group(dev);
435 /* It is OK that we do not hold the group lock right now,
436 * as we run under the RTNL lock.
441 /* Propagate real device state to vlan devices */
442 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
443 vlandev = vlan_group_get_device(grp, i);
447 netif_stacked_transfer_operstate(dev, vlandev);
451 case NETDEV_CHANGEADDR:
452 /* Adjust unicast filters on underlying device */
453 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
454 vlandev = vlan_group_get_device(grp, i);
458 flgs = vlandev->flags;
459 if (!(flgs & IFF_UP))
462 vlan_sync_address(dev, vlandev);
466 case NETDEV_CHANGEMTU:
467 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
468 vlandev = vlan_group_get_device(grp, i);
472 if (vlandev->mtu <= dev->mtu)
475 dev_set_mtu(vlandev, dev->mtu);
479 case NETDEV_FEAT_CHANGE:
480 /* Propagate device features to underlying device */
481 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
482 vlandev = vlan_group_get_device(grp, i);
486 vlan_transfer_features(dev, vlandev);
492 /* Put all VLANs for this dev in the down state too. */
493 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
494 vlandev = vlan_group_get_device(grp, i);
498 flgs = vlandev->flags;
499 if (!(flgs & IFF_UP))
502 vlan = vlan_dev_info(vlandev);
503 if (!(vlan->flags & VLAN_FLAG_LOOSE_BINDING))
504 dev_change_flags(vlandev, flgs & ~IFF_UP);
505 netif_stacked_transfer_operstate(dev, vlandev);
510 /* Put all VLANs for this dev in the up state too. */
511 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
512 vlandev = vlan_group_get_device(grp, i);
516 flgs = vlandev->flags;
520 vlan = vlan_dev_info(vlandev);
521 if (!(vlan->flags & VLAN_FLAG_LOOSE_BINDING))
522 dev_change_flags(vlandev, flgs | IFF_UP);
523 netif_stacked_transfer_operstate(dev, vlandev);
527 case NETDEV_UNREGISTER:
528 /* Delete all VLANs for this dev. */
531 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
532 vlandev = vlan_group_get_device(grp, i);
536 /* unregistration of last vlan destroys group, abort
538 if (grp->nr_vlans == 1)
539 i = VLAN_GROUP_ARRAY_LEN;
541 unregister_vlan_dev(vlandev, &list);
543 unregister_netdevice_many(&list);
546 case NETDEV_PRE_TYPE_CHANGE:
547 /* Forbid underlaying device to change its type. */
555 static struct notifier_block vlan_notifier_block __read_mostly = {
556 .notifier_call = vlan_device_event,
560 * VLAN IOCTL handler.
561 * o execute requested action or pass command to the device driver
562 * arg is really a struct vlan_ioctl_args __user *.
564 static int vlan_ioctl_handler(struct net *net, void __user *arg)
567 struct vlan_ioctl_args args;
568 struct net_device *dev = NULL;
570 if (copy_from_user(&args, arg, sizeof(struct vlan_ioctl_args)))
573 /* Null terminate this sucker, just in case. */
574 args.device1[23] = 0;
575 args.u.device2[23] = 0;
580 case SET_VLAN_INGRESS_PRIORITY_CMD:
581 case SET_VLAN_EGRESS_PRIORITY_CMD:
582 case SET_VLAN_FLAG_CMD:
585 case GET_VLAN_REALDEV_NAME_CMD:
586 case GET_VLAN_VID_CMD:
588 dev = __dev_get_by_name(net, args.device1);
593 if (args.cmd != ADD_VLAN_CMD && !is_vlan_dev(dev))
598 case SET_VLAN_INGRESS_PRIORITY_CMD:
600 if (!capable(CAP_NET_ADMIN))
602 vlan_dev_set_ingress_priority(dev,
608 case SET_VLAN_EGRESS_PRIORITY_CMD:
610 if (!capable(CAP_NET_ADMIN))
612 err = vlan_dev_set_egress_priority(dev,
617 case SET_VLAN_FLAG_CMD:
619 if (!capable(CAP_NET_ADMIN))
621 err = vlan_dev_change_flags(dev,
622 args.vlan_qos ? args.u.flag : 0,
626 case SET_VLAN_NAME_TYPE_CMD:
628 if (!capable(CAP_NET_ADMIN))
630 if ((args.u.name_type >= 0) &&
631 (args.u.name_type < VLAN_NAME_TYPE_HIGHEST)) {
634 vn = net_generic(net, vlan_net_id);
635 vn->name_type = args.u.name_type;
644 if (!capable(CAP_NET_ADMIN))
646 err = register_vlan_device(dev, args.u.VID);
651 if (!capable(CAP_NET_ADMIN))
653 unregister_vlan_dev(dev, NULL);
657 case GET_VLAN_REALDEV_NAME_CMD:
659 vlan_dev_get_realdev_name(dev, args.u.device2);
660 if (copy_to_user(arg, &args,
661 sizeof(struct vlan_ioctl_args)))
665 case GET_VLAN_VID_CMD:
667 args.u.VID = vlan_dev_vlan_id(dev);
668 if (copy_to_user(arg, &args,
669 sizeof(struct vlan_ioctl_args)))
682 static int __net_init vlan_init_net(struct net *net)
684 struct vlan_net *vn = net_generic(net, vlan_net_id);
687 vn->name_type = VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD;
689 err = vlan_proc_init(net);
694 static void __net_exit vlan_exit_net(struct net *net)
696 vlan_proc_cleanup(net);
699 static struct pernet_operations vlan_net_ops = {
700 .init = vlan_init_net,
701 .exit = vlan_exit_net,
703 .size = sizeof(struct vlan_net),
706 static int __init vlan_proto_init(void)
710 pr_info("%s v%s %s\n", vlan_fullname, vlan_version, vlan_copyright);
711 pr_info("All bugs added by %s\n", vlan_buggyright);
713 err = register_pernet_subsys(&vlan_net_ops);
717 err = register_netdevice_notifier(&vlan_notifier_block);
721 err = vlan_gvrp_init();
725 err = vlan_netlink_init();
729 dev_add_pack(&vlan_packet_type);
730 vlan_ioctl_set(vlan_ioctl_handler);
736 unregister_netdevice_notifier(&vlan_notifier_block);
738 unregister_pernet_subsys(&vlan_net_ops);
743 static void __exit vlan_cleanup_module(void)
747 vlan_ioctl_set(NULL);
750 unregister_netdevice_notifier(&vlan_notifier_block);
752 dev_remove_pack(&vlan_packet_type);
754 /* This table must be empty if there are no module references left. */
755 for (i = 0; i < VLAN_GRP_HASH_SIZE; i++)
756 BUG_ON(!hlist_empty(&vlan_group_hash[i]));
758 unregister_pernet_subsys(&vlan_net_ops);
759 rcu_barrier(); /* Wait for completion of call_rcu()'s */
764 module_init(vlan_proto_init);
765 module_exit(vlan_cleanup_module);
767 MODULE_LICENSE("GPL");
768 MODULE_VERSION(DRV_VERSION);