3 * Ethernet-type device handling.
7 * VLAN Home Page: http://www.candelatech.com/~greear/vlan.html
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 */
44 int vlan_net_id __read_mostly;
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;
54 static struct packet_type vlan_packet_type __read_mostly = {
55 .type = cpu_to_be16(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, struct list_head *head)
145 struct vlan_dev_info *vlan = vlan_dev_info(dev);
146 struct net_device *real_dev = vlan->real_dev;
147 const struct net_device_ops *ops = real_dev->netdev_ops;
148 struct vlan_group *grp;
149 u16 vlan_id = vlan->vlan_id;
153 grp = __vlan_find_group(real_dev);
156 /* Take it out of our own structures, but be sure to interlock with
157 * HW accelerating devices or SW vlan input packet processing.
159 if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
160 ops->ndo_vlan_rx_kill_vid(real_dev, vlan_id);
164 vlan_group_set_device(grp, vlan_id, NULL);
168 unregister_netdevice_queue(dev, head);
170 /* If the group is now empty, kill off the group. */
171 if (grp->nr_vlans == 0) {
172 vlan_gvrp_uninit_applicant(real_dev);
174 if (real_dev->features & NETIF_F_HW_VLAN_RX)
175 ops->ndo_vlan_rx_register(real_dev, NULL);
177 hlist_del_rcu(&grp->hlist);
179 /* Free the group, after all cpu's are done. */
180 call_rcu(&grp->rcu, vlan_rcu_free);
183 /* Get rid of the vlan's reference to real_dev */
187 static void vlan_transfer_operstate(const struct net_device *dev,
188 struct net_device *vlandev)
190 /* Have to respect userspace enforced dormant state
191 * of real device, also must allow supplicant running
194 if (dev->operstate == IF_OPER_DORMANT)
195 netif_dormant_on(vlandev);
197 netif_dormant_off(vlandev);
199 if (netif_carrier_ok(dev)) {
200 if (!netif_carrier_ok(vlandev))
201 netif_carrier_on(vlandev);
203 if (netif_carrier_ok(vlandev))
204 netif_carrier_off(vlandev);
208 int vlan_check_real_dev(struct net_device *real_dev, u16 vlan_id)
210 const char *name = real_dev->name;
211 const struct net_device_ops *ops = real_dev->netdev_ops;
213 if (real_dev->features & NETIF_F_VLAN_CHALLENGED) {
214 pr_info("8021q: VLANs not supported on %s\n", name);
218 if ((real_dev->features & NETIF_F_HW_VLAN_RX) && !ops->ndo_vlan_rx_register) {
219 pr_info("8021q: device %s has buggy VLAN hw accel\n", name);
223 if ((real_dev->features & NETIF_F_HW_VLAN_FILTER) &&
224 (!ops->ndo_vlan_rx_add_vid || !ops->ndo_vlan_rx_kill_vid)) {
225 pr_info("8021q: Device %s has buggy VLAN hw accel\n", name);
229 if (__find_vlan_dev(real_dev, vlan_id) != NULL)
235 int register_vlan_dev(struct net_device *dev)
237 struct vlan_dev_info *vlan = vlan_dev_info(dev);
238 struct net_device *real_dev = vlan->real_dev;
239 const struct net_device_ops *ops = real_dev->netdev_ops;
240 u16 vlan_id = vlan->vlan_id;
241 struct vlan_group *grp, *ngrp = NULL;
244 grp = __vlan_find_group(real_dev);
246 ngrp = grp = vlan_group_alloc(real_dev);
249 err = vlan_gvrp_init_applicant(real_dev);
254 err = vlan_group_prealloc_vid(grp, vlan_id);
256 goto out_uninit_applicant;
258 err = register_netdevice(dev);
260 goto out_uninit_applicant;
262 /* Account for reference in struct vlan_dev_info */
265 vlan_transfer_operstate(real_dev, dev);
266 linkwatch_fire_event(dev); /* _MUST_ call rfc2863_policy() */
268 /* So, got the sucker initialized, now lets place
269 * it into our local structure.
271 vlan_group_set_device(grp, vlan_id, dev);
274 if (ngrp && real_dev->features & NETIF_F_HW_VLAN_RX)
275 ops->ndo_vlan_rx_register(real_dev, ngrp);
276 if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
277 ops->ndo_vlan_rx_add_vid(real_dev, vlan_id);
281 out_uninit_applicant:
283 vlan_gvrp_uninit_applicant(real_dev);
286 hlist_del_rcu(&ngrp->hlist);
287 /* Free the group, after all cpu's are done. */
288 call_rcu(&ngrp->rcu, vlan_rcu_free);
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_mq(sizeof(struct vlan_dev_info), name,
338 vlan_setup, real_dev->num_tx_queues);
343 new_dev->real_num_tx_queues = real_dev->real_num_tx_queues;
344 dev_net_set(new_dev, net);
345 /* need 4 bytes for extra VLAN header info,
346 * hope the underlying device can handle it.
348 new_dev->mtu = real_dev->mtu;
350 vlan_dev_info(new_dev)->vlan_id = vlan_id;
351 vlan_dev_info(new_dev)->real_dev = real_dev;
352 vlan_dev_info(new_dev)->dent = NULL;
353 vlan_dev_info(new_dev)->flags = VLAN_FLAG_REORDER_HDR;
355 new_dev->rtnl_link_ops = &vlan_link_ops;
356 err = register_vlan_dev(new_dev);
358 goto out_free_newdev;
363 free_netdev(new_dev);
367 static void vlan_sync_address(struct net_device *dev,
368 struct net_device *vlandev)
370 struct vlan_dev_info *vlan = vlan_dev_info(vlandev);
372 /* May be called without an actual change */
373 if (!compare_ether_addr(vlan->real_dev_addr, dev->dev_addr))
376 /* vlan address was different from the old address and is equal to
378 if (compare_ether_addr(vlandev->dev_addr, vlan->real_dev_addr) &&
379 !compare_ether_addr(vlandev->dev_addr, dev->dev_addr))
380 dev_unicast_delete(dev, vlandev->dev_addr);
382 /* vlan address was equal to the old address and is different from
384 if (!compare_ether_addr(vlandev->dev_addr, vlan->real_dev_addr) &&
385 compare_ether_addr(vlandev->dev_addr, dev->dev_addr))
386 dev_unicast_add(dev, vlandev->dev_addr);
388 memcpy(vlan->real_dev_addr, dev->dev_addr, ETH_ALEN);
391 static void vlan_transfer_features(struct net_device *dev,
392 struct net_device *vlandev)
394 unsigned long old_features = vlandev->features;
396 vlandev->features &= ~dev->vlan_features;
397 vlandev->features |= dev->features & dev->vlan_features;
398 vlandev->gso_max_size = dev->gso_max_size;
399 #if defined(CONFIG_FCOE) || defined(CONFIG_FCOE_MODULE)
400 vlandev->fcoe_ddp_xid = dev->fcoe_ddp_xid;
403 if (old_features != vlandev->features)
404 netdev_features_change(vlandev);
407 static void __vlan_device_event(struct net_device *dev, unsigned long event)
410 case NETDEV_CHANGENAME:
411 vlan_proc_rem_dev(dev);
412 if (vlan_proc_add_dev(dev) < 0)
413 pr_warning("8021q: failed to change proc name for %s\n",
416 case NETDEV_REGISTER:
417 if (vlan_proc_add_dev(dev) < 0)
418 pr_warning("8021q: failed to add proc entry for %s\n",
421 case NETDEV_UNREGISTER:
422 vlan_proc_rem_dev(dev);
427 static int vlan_device_event(struct notifier_block *unused, unsigned long event,
430 struct net_device *dev = ptr;
431 struct vlan_group *grp;
433 struct net_device *vlandev;
436 if (is_vlan_dev(dev))
437 __vlan_device_event(dev, event);
439 grp = __vlan_find_group(dev);
443 /* It is OK that we do not hold the group lock right now,
444 * as we run under the RTNL lock.
449 /* Propagate real device state to vlan devices */
450 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
451 vlandev = vlan_group_get_device(grp, i);
455 vlan_transfer_operstate(dev, vlandev);
459 case NETDEV_CHANGEADDR:
460 /* Adjust unicast filters on underlying device */
461 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
462 vlandev = vlan_group_get_device(grp, i);
466 flgs = vlandev->flags;
467 if (!(flgs & IFF_UP))
470 vlan_sync_address(dev, vlandev);
474 case NETDEV_CHANGEMTU:
475 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
476 vlandev = vlan_group_get_device(grp, i);
480 if (vlandev->mtu <= dev->mtu)
483 dev_set_mtu(vlandev, dev->mtu);
487 case NETDEV_FEAT_CHANGE:
488 /* Propagate device features to underlying device */
489 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
490 vlandev = vlan_group_get_device(grp, i);
494 vlan_transfer_features(dev, vlandev);
500 /* Put all VLANs for this dev in the down state too. */
501 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
502 vlandev = vlan_group_get_device(grp, i);
506 flgs = vlandev->flags;
507 if (!(flgs & IFF_UP))
510 dev_change_flags(vlandev, flgs & ~IFF_UP);
511 vlan_transfer_operstate(dev, vlandev);
516 /* Put all VLANs for this dev in the up state too. */
517 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
518 vlandev = vlan_group_get_device(grp, i);
522 flgs = vlandev->flags;
526 dev_change_flags(vlandev, flgs | IFF_UP);
527 vlan_transfer_operstate(dev, vlandev);
531 case NETDEV_UNREGISTER:
532 /* Delete all VLANs for this dev. */
535 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
536 vlandev = vlan_group_get_device(grp, i);
540 /* unregistration of last vlan destroys group, abort
542 if (grp->nr_vlans == 1)
543 i = VLAN_GROUP_ARRAY_LEN;
545 unregister_vlan_dev(vlandev, &list);
547 unregister_netdevice_many(&list);
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 vlan_init_net(struct net *net)
688 vn = kzalloc(sizeof(struct vlan_net), GFP_KERNEL);
692 err = net_assign_generic(net, vlan_net_id, vn);
696 vn->name_type = VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD;
698 err = vlan_proc_init(net);
712 static void vlan_exit_net(struct net *net)
716 vn = net_generic(net, vlan_net_id);
717 rtnl_kill_links(net, &vlan_link_ops);
718 vlan_proc_cleanup(net);
722 static struct pernet_operations vlan_net_ops = {
723 .init = vlan_init_net,
724 .exit = vlan_exit_net,
727 static int __init vlan_proto_init(void)
731 pr_info("%s v%s %s\n", vlan_fullname, vlan_version, vlan_copyright);
732 pr_info("All bugs added by %s\n", vlan_buggyright);
734 err = register_pernet_gen_device(&vlan_net_id, &vlan_net_ops);
738 err = register_netdevice_notifier(&vlan_notifier_block);
742 err = vlan_gvrp_init();
746 err = vlan_netlink_init();
750 dev_add_pack(&vlan_packet_type);
751 vlan_ioctl_set(vlan_ioctl_handler);
757 unregister_netdevice_notifier(&vlan_notifier_block);
759 unregister_pernet_gen_device(vlan_net_id, &vlan_net_ops);
764 static void __exit vlan_cleanup_module(void)
768 vlan_ioctl_set(NULL);
771 unregister_netdevice_notifier(&vlan_notifier_block);
773 dev_remove_pack(&vlan_packet_type);
775 /* This table must be empty if there are no module references left. */
776 for (i = 0; i < VLAN_GRP_HASH_SIZE; i++)
777 BUG_ON(!hlist_empty(&vlan_group_hash[i]));
779 unregister_pernet_gen_device(vlan_net_id, &vlan_net_ops);
780 rcu_barrier(); /* Wait for completion of call_rcu()'s */
785 module_init(vlan_proto_init);
786 module_exit(vlan_cleanup_module);
788 MODULE_LICENSE("GPL");
789 MODULE_VERSION(DRV_VERSION);