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 __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)
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);
162 vlan_group_set_device(grp, vlan_id, NULL);
167 unregister_netdevice(dev);
169 /* If the group is now empty, kill off the group. */
170 if (grp->nr_vlans == 0) {
171 vlan_gvrp_uninit_applicant(real_dev);
173 if (real_dev->features & NETIF_F_HW_VLAN_RX)
174 ops->ndo_vlan_rx_register(real_dev, NULL);
176 hlist_del_rcu(&grp->hlist);
178 /* Free the group, after all cpu's are done. */
179 call_rcu(&grp->rcu, vlan_rcu_free);
182 /* Get rid of the vlan's reference to real_dev */
186 static void vlan_transfer_operstate(const struct net_device *dev,
187 struct net_device *vlandev)
189 /* Have to respect userspace enforced dormant state
190 * of real device, also must allow supplicant running
193 if (dev->operstate == IF_OPER_DORMANT)
194 netif_dormant_on(vlandev);
196 netif_dormant_off(vlandev);
198 if (netif_carrier_ok(dev)) {
199 if (!netif_carrier_ok(vlandev))
200 netif_carrier_on(vlandev);
202 if (netif_carrier_ok(vlandev))
203 netif_carrier_off(vlandev);
207 int vlan_check_real_dev(struct net_device *real_dev, u16 vlan_id)
209 const char *name = real_dev->name;
210 const struct net_device_ops *ops = real_dev->netdev_ops;
212 if (real_dev->features & NETIF_F_VLAN_CHALLENGED) {
213 pr_info("8021q: VLANs not supported on %s\n", name);
217 if ((real_dev->features & NETIF_F_HW_VLAN_RX) && !ops->ndo_vlan_rx_register) {
218 pr_info("8021q: device %s has buggy VLAN hw accel\n", name);
222 if ((real_dev->features & NETIF_F_HW_VLAN_FILTER) &&
223 (!ops->ndo_vlan_rx_add_vid || !ops->ndo_vlan_rx_kill_vid)) {
224 pr_info("8021q: Device %s has buggy VLAN hw accel\n", name);
228 if (__find_vlan_dev(real_dev, vlan_id) != NULL)
234 int register_vlan_dev(struct net_device *dev)
236 struct vlan_dev_info *vlan = vlan_dev_info(dev);
237 struct net_device *real_dev = vlan->real_dev;
238 const struct net_device_ops *ops = real_dev->netdev_ops;
239 u16 vlan_id = vlan->vlan_id;
240 struct vlan_group *grp, *ngrp = NULL;
243 grp = __vlan_find_group(real_dev);
245 ngrp = grp = vlan_group_alloc(real_dev);
248 err = vlan_gvrp_init_applicant(real_dev);
253 err = vlan_group_prealloc_vid(grp, vlan_id);
255 goto out_uninit_applicant;
257 err = register_netdevice(dev);
259 goto out_uninit_applicant;
261 /* Account for reference in struct vlan_dev_info */
264 vlan_transfer_operstate(real_dev, dev);
265 linkwatch_fire_event(dev); /* _MUST_ call rfc2863_policy() */
267 /* So, got the sucker initialized, now lets place
268 * it into our local structure.
270 vlan_group_set_device(grp, vlan_id, dev);
273 if (ngrp && real_dev->features & NETIF_F_HW_VLAN_RX)
274 ops->ndo_vlan_rx_register(real_dev, ngrp);
275 if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
276 ops->ndo_vlan_rx_add_vid(real_dev, vlan_id);
280 out_uninit_applicant:
282 vlan_gvrp_uninit_applicant(real_dev);
285 hlist_del_rcu(&ngrp->hlist);
286 /* Free the group, after all cpu's are done. */
287 call_rcu(&ngrp->rcu, vlan_rcu_free);
292 /* Attach a VLAN device to a mac address (ie Ethernet Card).
293 * Returns 0 if the device was created or a negative error code otherwise.
295 static int register_vlan_device(struct net_device *real_dev, u16 vlan_id)
297 struct net_device *new_dev;
298 struct net *net = dev_net(real_dev);
299 struct vlan_net *vn = net_generic(net, vlan_net_id);
303 if (vlan_id >= VLAN_VID_MASK)
306 err = vlan_check_real_dev(real_dev, vlan_id);
310 /* Gotta set up the fields for the device. */
311 switch (vn->name_type) {
312 case VLAN_NAME_TYPE_RAW_PLUS_VID:
313 /* name will look like: eth1.0005 */
314 snprintf(name, IFNAMSIZ, "%s.%.4i", real_dev->name, vlan_id);
316 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD:
317 /* Put our vlan.VID in the name.
318 * Name will look like: vlan5
320 snprintf(name, IFNAMSIZ, "vlan%i", vlan_id);
322 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD:
323 /* Put our vlan.VID in the name.
324 * Name will look like: eth0.5
326 snprintf(name, IFNAMSIZ, "%s.%i", real_dev->name, vlan_id);
328 case VLAN_NAME_TYPE_PLUS_VID:
329 /* Put our vlan.VID in the name.
330 * Name will look like: vlan0005
333 snprintf(name, IFNAMSIZ, "vlan%.4i", vlan_id);
336 new_dev = alloc_netdev_mq(sizeof(struct vlan_dev_info), name,
337 vlan_setup, real_dev->num_tx_queues);
342 new_dev->real_num_tx_queues = real_dev->real_num_tx_queues;
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);
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);
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;
398 #if defined(CONFIG_FCOE) || defined(CONFIG_FCOE_MODULE)
399 vlandev->fcoe_ddp_xid = dev->fcoe_ddp_xid;
402 if (old_features != vlandev->features)
403 netdev_features_change(vlandev);
406 static void __vlan_device_event(struct net_device *dev, unsigned long event)
409 case NETDEV_CHANGENAME:
410 vlan_proc_rem_dev(dev);
411 if (vlan_proc_add_dev(dev) < 0)
412 pr_warning("8021q: failed to change proc name for %s\n",
415 case NETDEV_REGISTER:
416 if (vlan_proc_add_dev(dev) < 0)
417 pr_warning("8021q: failed to add proc entry for %s\n",
420 case NETDEV_UNREGISTER:
421 vlan_proc_rem_dev(dev);
426 static int vlan_device_event(struct notifier_block *unused, unsigned long event,
429 struct net_device *dev = ptr;
430 struct vlan_group *grp;
432 struct net_device *vlandev;
434 if (is_vlan_dev(dev))
435 __vlan_device_event(dev, event);
437 grp = __vlan_find_group(dev);
441 /* It is OK that we do not hold the group lock right now,
442 * as we run under the RTNL lock.
447 /* Propagate real device state to vlan devices */
448 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
449 vlandev = vlan_group_get_device(grp, i);
453 vlan_transfer_operstate(dev, vlandev);
457 case NETDEV_CHANGEADDR:
458 /* Adjust unicast filters on underlying device */
459 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
460 vlandev = vlan_group_get_device(grp, i);
464 flgs = vlandev->flags;
465 if (!(flgs & IFF_UP))
468 vlan_sync_address(dev, vlandev);
472 case NETDEV_CHANGEMTU:
473 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
474 vlandev = vlan_group_get_device(grp, i);
478 if (vlandev->mtu <= dev->mtu)
481 dev_set_mtu(vlandev, dev->mtu);
485 case NETDEV_FEAT_CHANGE:
486 /* Propagate device features to underlying device */
487 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
488 vlandev = vlan_group_get_device(grp, i);
492 vlan_transfer_features(dev, vlandev);
498 /* Put all VLANs for this dev in the down state too. */
499 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
500 vlandev = vlan_group_get_device(grp, i);
504 flgs = vlandev->flags;
505 if (!(flgs & IFF_UP))
508 dev_change_flags(vlandev, flgs & ~IFF_UP);
509 vlan_transfer_operstate(dev, vlandev);
514 /* Put all VLANs for this dev in the up state too. */
515 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
516 vlandev = vlan_group_get_device(grp, i);
520 flgs = vlandev->flags;
524 dev_change_flags(vlandev, flgs | IFF_UP);
525 vlan_transfer_operstate(dev, vlandev);
529 case NETDEV_UNREGISTER:
530 /* 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);
550 static struct notifier_block vlan_notifier_block __read_mostly = {
551 .notifier_call = vlan_device_event,
555 * VLAN IOCTL handler.
556 * o execute requested action or pass command to the device driver
557 * arg is really a struct vlan_ioctl_args __user *.
559 static int vlan_ioctl_handler(struct net *net, void __user *arg)
562 struct vlan_ioctl_args args;
563 struct net_device *dev = NULL;
565 if (copy_from_user(&args, arg, sizeof(struct vlan_ioctl_args)))
568 /* Null terminate this sucker, just in case. */
569 args.device1[23] = 0;
570 args.u.device2[23] = 0;
575 case SET_VLAN_INGRESS_PRIORITY_CMD:
576 case SET_VLAN_EGRESS_PRIORITY_CMD:
577 case SET_VLAN_FLAG_CMD:
580 case GET_VLAN_REALDEV_NAME_CMD:
581 case GET_VLAN_VID_CMD:
583 dev = __dev_get_by_name(net, args.device1);
588 if (args.cmd != ADD_VLAN_CMD && !is_vlan_dev(dev))
593 case SET_VLAN_INGRESS_PRIORITY_CMD:
595 if (!capable(CAP_NET_ADMIN))
597 vlan_dev_set_ingress_priority(dev,
603 case SET_VLAN_EGRESS_PRIORITY_CMD:
605 if (!capable(CAP_NET_ADMIN))
607 err = vlan_dev_set_egress_priority(dev,
612 case SET_VLAN_FLAG_CMD:
614 if (!capable(CAP_NET_ADMIN))
616 err = vlan_dev_change_flags(dev,
617 args.vlan_qos ? args.u.flag : 0,
621 case SET_VLAN_NAME_TYPE_CMD:
623 if (!capable(CAP_NET_ADMIN))
625 if ((args.u.name_type >= 0) &&
626 (args.u.name_type < VLAN_NAME_TYPE_HIGHEST)) {
629 vn = net_generic(net, vlan_net_id);
630 vn->name_type = args.u.name_type;
639 if (!capable(CAP_NET_ADMIN))
641 err = register_vlan_device(dev, args.u.VID);
646 if (!capable(CAP_NET_ADMIN))
648 unregister_vlan_dev(dev);
652 case GET_VLAN_REALDEV_NAME_CMD:
654 vlan_dev_get_realdev_name(dev, args.u.device2);
655 if (copy_to_user(arg, &args,
656 sizeof(struct vlan_ioctl_args)))
660 case GET_VLAN_VID_CMD:
662 args.u.VID = vlan_dev_vlan_id(dev);
663 if (copy_to_user(arg, &args,
664 sizeof(struct vlan_ioctl_args)))
677 static int vlan_init_net(struct net *net)
683 vn = kzalloc(sizeof(struct vlan_net), GFP_KERNEL);
687 err = net_assign_generic(net, vlan_net_id, vn);
691 vn->name_type = VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD;
693 err = vlan_proc_init(net);
707 static void vlan_exit_net(struct net *net)
711 vn = net_generic(net, vlan_net_id);
712 rtnl_kill_links(net, &vlan_link_ops);
713 vlan_proc_cleanup(net);
717 static struct pernet_operations vlan_net_ops = {
718 .init = vlan_init_net,
719 .exit = vlan_exit_net,
722 static int __init vlan_proto_init(void)
726 pr_info("%s v%s %s\n", vlan_fullname, vlan_version, vlan_copyright);
727 pr_info("All bugs added by %s\n", vlan_buggyright);
729 err = register_pernet_gen_device(&vlan_net_id, &vlan_net_ops);
733 err = register_netdevice_notifier(&vlan_notifier_block);
737 err = vlan_gvrp_init();
741 err = vlan_netlink_init();
745 dev_add_pack(&vlan_packet_type);
746 vlan_ioctl_set(vlan_ioctl_handler);
752 unregister_netdevice_notifier(&vlan_notifier_block);
754 unregister_pernet_gen_device(vlan_net_id, &vlan_net_ops);
759 static void __exit vlan_cleanup_module(void)
763 vlan_ioctl_set(NULL);
766 unregister_netdevice_notifier(&vlan_notifier_block);
768 dev_remove_pack(&vlan_packet_type);
770 /* This table must be empty if there are no module references left. */
771 for (i = 0; i < VLAN_GRP_HASH_SIZE; i++)
772 BUG_ON(!hlist_empty(&vlan_group_hash[i]));
774 unregister_pernet_gen_device(vlan_net_id, &vlan_net_ops);
775 rcu_barrier(); /* Wait for completion of call_rcu()'s */
780 module_init(vlan_proto_init);
781 module_exit(vlan_cleanup_module);
783 MODULE_LICENSE("GPL");
784 MODULE_VERSION(DRV_VERSION);