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 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
23 #include <linux/capability.h>
24 #include <linux/module.h>
25 #include <linux/netdevice.h>
26 #include <linux/skbuff.h>
27 #include <linux/slab.h>
28 #include <linux/init.h>
29 #include <linux/rculist.h>
30 #include <net/p8022.h>
32 #include <linux/rtnetlink.h>
33 #include <linux/notifier.h>
34 #include <net/rtnetlink.h>
35 #include <net/net_namespace.h>
36 #include <net/netns/generic.h>
37 #include <asm/uaccess.h>
39 #include <linux/if_vlan.h>
43 #define DRV_VERSION "1.8"
45 /* Global VLAN variables */
47 int vlan_net_id __read_mostly;
49 const char vlan_fullname[] = "802.1Q VLAN Support";
50 const char vlan_version[] = DRV_VERSION;
52 /* End of global variables definitions. */
54 static int vlan_group_prealloc_vid(struct vlan_group *vg,
55 __be16 vlan_proto, u16 vlan_id)
57 struct net_device **array;
58 unsigned int pidx, vidx;
63 pidx = vlan_proto_idx(vlan_proto);
64 vidx = vlan_id / VLAN_GROUP_ARRAY_PART_LEN;
65 array = vg->vlan_devices_arrays[pidx][vidx];
69 size = sizeof(struct net_device *) * VLAN_GROUP_ARRAY_PART_LEN;
70 array = kzalloc(size, GFP_KERNEL);
74 vg->vlan_devices_arrays[pidx][vidx] = array;
78 void unregister_vlan_dev(struct net_device *dev, struct list_head *head)
80 struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
81 struct net_device *real_dev = vlan->real_dev;
82 struct vlan_info *vlan_info;
83 struct vlan_group *grp;
84 u16 vlan_id = vlan->vlan_id;
88 vlan_info = rtnl_dereference(real_dev->vlan_info);
91 grp = &vlan_info->grp;
95 if (vlan->flags & VLAN_FLAG_MVRP)
96 vlan_mvrp_request_leave(dev);
97 if (vlan->flags & VLAN_FLAG_GVRP)
98 vlan_gvrp_request_leave(dev);
100 vlan_group_set_device(grp, vlan->vlan_proto, vlan_id, NULL);
102 netdev_upper_dev_unlink(real_dev, dev);
103 /* Because unregister_netdevice_queue() makes sure at least one rcu
104 * grace period is respected before device freeing,
105 * we dont need to call synchronize_net() here.
107 unregister_netdevice_queue(dev, head);
109 if (grp->nr_vlan_devs == 0) {
110 vlan_mvrp_uninit_applicant(real_dev);
111 vlan_gvrp_uninit_applicant(real_dev);
114 /* Take it out of our own structures, but be sure to interlock with
115 * HW accelerating devices or SW vlan input packet processing if
116 * VLAN is not 0 (leave it there for 802.1p).
119 vlan_vid_del(real_dev, vlan->vlan_proto, vlan_id);
121 /* Get rid of the vlan's reference to real_dev */
125 int vlan_check_real_dev(struct net_device *real_dev,
126 __be16 protocol, u16 vlan_id)
128 const char *name = real_dev->name;
130 if (real_dev->features & NETIF_F_VLAN_CHALLENGED) {
131 pr_info("VLANs not supported on %s\n", name);
135 if (vlan_find_dev(real_dev, protocol, vlan_id) != NULL)
141 int register_vlan_dev(struct net_device *dev)
143 struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
144 struct net_device *real_dev = vlan->real_dev;
145 u16 vlan_id = vlan->vlan_id;
146 struct vlan_info *vlan_info;
147 struct vlan_group *grp;
150 err = vlan_vid_add(real_dev, vlan->vlan_proto, vlan_id);
154 vlan_info = rtnl_dereference(real_dev->vlan_info);
155 /* vlan_info should be there now. vlan_vid_add took care of it */
158 grp = &vlan_info->grp;
159 if (grp->nr_vlan_devs == 0) {
160 err = vlan_gvrp_init_applicant(real_dev);
163 err = vlan_mvrp_init_applicant(real_dev);
165 goto out_uninit_gvrp;
168 err = vlan_group_prealloc_vid(grp, vlan->vlan_proto, vlan_id);
170 goto out_uninit_mvrp;
172 vlan->nest_level = dev_get_nest_level(real_dev, is_vlan_dev) + 1;
173 err = register_netdevice(dev);
175 goto out_uninit_mvrp;
177 err = netdev_upper_dev_link(real_dev, dev);
179 goto out_unregister_netdev;
181 /* Account for reference in struct vlan_dev_priv */
184 netif_stacked_transfer_operstate(real_dev, dev);
185 linkwatch_fire_event(dev); /* _MUST_ call rfc2863_policy() */
187 /* So, got the sucker initialized, now lets place
188 * it into our local structure.
190 vlan_group_set_device(grp, vlan->vlan_proto, vlan_id, dev);
195 out_unregister_netdev:
196 unregister_netdevice(dev);
198 if (grp->nr_vlan_devs == 0)
199 vlan_mvrp_uninit_applicant(real_dev);
201 if (grp->nr_vlan_devs == 0)
202 vlan_gvrp_uninit_applicant(real_dev);
204 vlan_vid_del(real_dev, vlan->vlan_proto, vlan_id);
208 /* Attach a VLAN device to a mac address (ie Ethernet Card).
209 * Returns 0 if the device was created or a negative error code otherwise.
211 static int register_vlan_device(struct net_device *real_dev, u16 vlan_id)
213 struct net_device *new_dev;
214 struct vlan_dev_priv *vlan;
215 struct net *net = dev_net(real_dev);
216 struct vlan_net *vn = net_generic(net, vlan_net_id);
220 if (vlan_id >= VLAN_VID_MASK)
223 err = vlan_check_real_dev(real_dev, htons(ETH_P_8021Q), vlan_id);
227 /* Gotta set up the fields for the device. */
228 switch (vn->name_type) {
229 case VLAN_NAME_TYPE_RAW_PLUS_VID:
230 /* name will look like: eth1.0005 */
231 snprintf(name, IFNAMSIZ, "%s.%.4i", real_dev->name, vlan_id);
233 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD:
234 /* Put our vlan.VID in the name.
235 * Name will look like: vlan5
237 snprintf(name, IFNAMSIZ, "vlan%i", vlan_id);
239 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD:
240 /* Put our vlan.VID in the name.
241 * Name will look like: eth0.5
243 snprintf(name, IFNAMSIZ, "%s.%i", real_dev->name, vlan_id);
245 case VLAN_NAME_TYPE_PLUS_VID:
246 /* Put our vlan.VID in the name.
247 * Name will look like: vlan0005
250 snprintf(name, IFNAMSIZ, "vlan%.4i", vlan_id);
253 new_dev = alloc_netdev(sizeof(struct vlan_dev_priv), name,
254 NET_NAME_UNKNOWN, vlan_setup);
259 dev_net_set(new_dev, net);
260 /* need 4 bytes for extra VLAN header info,
261 * hope the underlying device can handle it.
263 new_dev->mtu = real_dev->mtu;
264 new_dev->priv_flags |= (real_dev->priv_flags & IFF_UNICAST_FLT);
266 vlan = vlan_dev_priv(new_dev);
267 vlan->vlan_proto = htons(ETH_P_8021Q);
268 vlan->vlan_id = vlan_id;
269 vlan->real_dev = real_dev;
271 vlan->flags = VLAN_FLAG_REORDER_HDR;
273 new_dev->rtnl_link_ops = &vlan_link_ops;
274 err = register_vlan_dev(new_dev);
276 goto out_free_newdev;
281 free_netdev(new_dev);
285 static void vlan_sync_address(struct net_device *dev,
286 struct net_device *vlandev)
288 struct vlan_dev_priv *vlan = vlan_dev_priv(vlandev);
290 /* May be called without an actual change */
291 if (ether_addr_equal(vlan->real_dev_addr, dev->dev_addr))
294 /* vlan address was different from the old address and is equal to
296 if (!ether_addr_equal(vlandev->dev_addr, vlan->real_dev_addr) &&
297 ether_addr_equal(vlandev->dev_addr, dev->dev_addr))
298 dev_uc_del(dev, vlandev->dev_addr);
300 /* vlan address was equal to the old address and is different from
302 if (ether_addr_equal(vlandev->dev_addr, vlan->real_dev_addr) &&
303 !ether_addr_equal(vlandev->dev_addr, dev->dev_addr))
304 dev_uc_add(dev, vlandev->dev_addr);
306 ether_addr_copy(vlan->real_dev_addr, dev->dev_addr);
309 static void vlan_transfer_features(struct net_device *dev,
310 struct net_device *vlandev)
312 struct vlan_dev_priv *vlan = vlan_dev_priv(vlandev);
314 vlandev->gso_max_size = dev->gso_max_size;
316 if (vlan_hw_offload_capable(dev->features, vlan->vlan_proto))
317 vlandev->hard_header_len = dev->hard_header_len;
319 vlandev->hard_header_len = dev->hard_header_len + VLAN_HLEN;
321 #if IS_ENABLED(CONFIG_FCOE)
322 vlandev->fcoe_ddp_xid = dev->fcoe_ddp_xid;
325 netdev_update_features(vlandev);
328 static int __vlan_device_event(struct net_device *dev, unsigned long event)
333 case NETDEV_CHANGENAME:
334 vlan_proc_rem_dev(dev);
335 err = vlan_proc_add_dev(dev);
337 case NETDEV_REGISTER:
338 err = vlan_proc_add_dev(dev);
340 case NETDEV_UNREGISTER:
341 vlan_proc_rem_dev(dev);
348 static int vlan_device_event(struct notifier_block *unused, unsigned long event,
351 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
352 struct vlan_group *grp;
353 struct vlan_info *vlan_info;
355 struct net_device *vlandev;
356 struct vlan_dev_priv *vlan;
360 if (is_vlan_dev(dev)) {
361 int err = __vlan_device_event(dev, event);
364 return notifier_from_errno(err);
367 if ((event == NETDEV_UP) &&
368 (dev->features & NETIF_F_HW_VLAN_CTAG_FILTER)) {
369 pr_info("adding VLAN 0 to HW filter on device %s\n",
371 vlan_vid_add(dev, htons(ETH_P_8021Q), 0);
374 vlan_info = rtnl_dereference(dev->vlan_info);
377 grp = &vlan_info->grp;
379 /* It is OK that we do not hold the group lock right now,
380 * as we run under the RTNL lock.
385 /* Propagate real device state to vlan devices */
386 vlan_group_for_each_dev(grp, i, vlandev)
387 netif_stacked_transfer_operstate(dev, vlandev);
390 case NETDEV_CHANGEADDR:
391 /* Adjust unicast filters on underlying device */
392 vlan_group_for_each_dev(grp, i, vlandev) {
393 flgs = vlandev->flags;
394 if (!(flgs & IFF_UP))
397 vlan_sync_address(dev, vlandev);
401 case NETDEV_CHANGEMTU:
402 vlan_group_for_each_dev(grp, i, vlandev) {
403 if (vlandev->mtu <= dev->mtu)
406 dev_set_mtu(vlandev, dev->mtu);
410 case NETDEV_FEAT_CHANGE:
411 /* Propagate device features to underlying device */
412 vlan_group_for_each_dev(grp, i, vlandev)
413 vlan_transfer_features(dev, vlandev);
417 struct net_device *tmp;
418 LIST_HEAD(close_list);
420 if (dev->features & NETIF_F_HW_VLAN_CTAG_FILTER)
421 vlan_vid_del(dev, htons(ETH_P_8021Q), 0);
423 /* Put all VLANs for this dev in the down state too. */
424 vlan_group_for_each_dev(grp, i, vlandev) {
425 flgs = vlandev->flags;
426 if (!(flgs & IFF_UP))
429 vlan = vlan_dev_priv(vlandev);
430 if (!(vlan->flags & VLAN_FLAG_LOOSE_BINDING))
431 list_add(&vlandev->close_list, &close_list);
434 dev_close_many(&close_list, false);
436 list_for_each_entry_safe(vlandev, tmp, &close_list, close_list) {
437 netif_stacked_transfer_operstate(dev, vlandev);
438 list_del_init(&vlandev->close_list);
440 list_del(&close_list);
444 /* Put all VLANs for this dev in the up state too. */
445 vlan_group_for_each_dev(grp, i, vlandev) {
446 flgs = dev_get_flags(vlandev);
450 vlan = vlan_dev_priv(vlandev);
451 if (!(vlan->flags & VLAN_FLAG_LOOSE_BINDING))
452 dev_change_flags(vlandev, flgs | IFF_UP);
453 netif_stacked_transfer_operstate(dev, vlandev);
457 case NETDEV_UNREGISTER:
458 /* twiddle thumbs on netns device moves */
459 if (dev->reg_state != NETREG_UNREGISTERING)
462 vlan_group_for_each_dev(grp, i, vlandev) {
463 /* removal of last vid destroys vlan_info, abort
465 if (vlan_info->nr_vids == 1)
468 unregister_vlan_dev(vlandev, &list);
472 unregister_netdevice_many(&list);
475 case NETDEV_PRE_TYPE_CHANGE:
476 /* Forbid underlaying device to change its type. */
477 if (vlan_uses_dev(dev))
481 case NETDEV_NOTIFY_PEERS:
482 case NETDEV_BONDING_FAILOVER:
483 case NETDEV_RESEND_IGMP:
484 /* Propagate to vlan devices */
485 vlan_group_for_each_dev(grp, i, vlandev)
486 call_netdevice_notifiers(event, vlandev);
494 static struct notifier_block vlan_notifier_block __read_mostly = {
495 .notifier_call = vlan_device_event,
499 * VLAN IOCTL handler.
500 * o execute requested action or pass command to the device driver
501 * arg is really a struct vlan_ioctl_args __user *.
503 static int vlan_ioctl_handler(struct net *net, void __user *arg)
506 struct vlan_ioctl_args args;
507 struct net_device *dev = NULL;
509 if (copy_from_user(&args, arg, sizeof(struct vlan_ioctl_args)))
512 /* Null terminate this sucker, just in case. */
513 args.device1[23] = 0;
514 args.u.device2[23] = 0;
519 case SET_VLAN_INGRESS_PRIORITY_CMD:
520 case SET_VLAN_EGRESS_PRIORITY_CMD:
521 case SET_VLAN_FLAG_CMD:
524 case GET_VLAN_REALDEV_NAME_CMD:
525 case GET_VLAN_VID_CMD:
527 dev = __dev_get_by_name(net, args.device1);
532 if (args.cmd != ADD_VLAN_CMD && !is_vlan_dev(dev))
537 case SET_VLAN_INGRESS_PRIORITY_CMD:
539 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
541 vlan_dev_set_ingress_priority(dev,
547 case SET_VLAN_EGRESS_PRIORITY_CMD:
549 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
551 err = vlan_dev_set_egress_priority(dev,
556 case SET_VLAN_FLAG_CMD:
558 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
560 err = vlan_dev_change_flags(dev,
561 args.vlan_qos ? args.u.flag : 0,
565 case SET_VLAN_NAME_TYPE_CMD:
567 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
569 if ((args.u.name_type >= 0) &&
570 (args.u.name_type < VLAN_NAME_TYPE_HIGHEST)) {
573 vn = net_generic(net, vlan_net_id);
574 vn->name_type = args.u.name_type;
583 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
585 err = register_vlan_device(dev, args.u.VID);
590 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
592 unregister_vlan_dev(dev, NULL);
596 case GET_VLAN_REALDEV_NAME_CMD:
598 vlan_dev_get_realdev_name(dev, args.u.device2);
599 if (copy_to_user(arg, &args,
600 sizeof(struct vlan_ioctl_args)))
604 case GET_VLAN_VID_CMD:
606 args.u.VID = vlan_dev_vlan_id(dev);
607 if (copy_to_user(arg, &args,
608 sizeof(struct vlan_ioctl_args)))
621 static struct sk_buff **vlan_gro_receive(struct sk_buff **head,
624 struct sk_buff *p, **pp = NULL;
625 struct vlan_hdr *vhdr;
626 unsigned int hlen, off_vlan;
627 const struct packet_offload *ptype;
631 off_vlan = skb_gro_offset(skb);
632 hlen = off_vlan + sizeof(*vhdr);
633 vhdr = skb_gro_header_fast(skb, off_vlan);
634 if (skb_gro_header_hard(skb, hlen)) {
635 vhdr = skb_gro_header_slow(skb, hlen, off_vlan);
640 type = vhdr->h_vlan_encapsulated_proto;
643 ptype = gro_find_receive_by_type(type);
649 for (p = *head; p; p = p->next) {
650 struct vlan_hdr *vhdr2;
652 if (!NAPI_GRO_CB(p)->same_flow)
655 vhdr2 = (struct vlan_hdr *)(p->data + off_vlan);
656 if (compare_vlan_header(vhdr, vhdr2))
657 NAPI_GRO_CB(p)->same_flow = 0;
660 skb_gro_pull(skb, sizeof(*vhdr));
661 skb_gro_postpull_rcsum(skb, vhdr, sizeof(*vhdr));
662 pp = ptype->callbacks.gro_receive(head, skb);
667 NAPI_GRO_CB(skb)->flush |= flush;
672 static int vlan_gro_complete(struct sk_buff *skb, int nhoff)
674 struct vlan_hdr *vhdr = (struct vlan_hdr *)(skb->data + nhoff);
675 __be16 type = vhdr->h_vlan_encapsulated_proto;
676 struct packet_offload *ptype;
680 ptype = gro_find_complete_by_type(type);
682 err = ptype->callbacks.gro_complete(skb, nhoff + sizeof(*vhdr));
688 static struct packet_offload vlan_packet_offloads[] __read_mostly = {
690 .type = cpu_to_be16(ETH_P_8021Q),
693 .gro_receive = vlan_gro_receive,
694 .gro_complete = vlan_gro_complete,
698 .type = cpu_to_be16(ETH_P_8021AD),
701 .gro_receive = vlan_gro_receive,
702 .gro_complete = vlan_gro_complete,
707 static int __net_init vlan_init_net(struct net *net)
709 struct vlan_net *vn = net_generic(net, vlan_net_id);
712 vn->name_type = VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD;
714 err = vlan_proc_init(net);
719 static void __net_exit vlan_exit_net(struct net *net)
721 vlan_proc_cleanup(net);
724 static struct pernet_operations vlan_net_ops = {
725 .init = vlan_init_net,
726 .exit = vlan_exit_net,
728 .size = sizeof(struct vlan_net),
731 static int __init vlan_proto_init(void)
736 pr_info("%s v%s\n", vlan_fullname, vlan_version);
738 err = register_pernet_subsys(&vlan_net_ops);
742 err = register_netdevice_notifier(&vlan_notifier_block);
746 err = vlan_gvrp_init();
750 err = vlan_mvrp_init();
754 err = vlan_netlink_init();
758 for (i = 0; i < ARRAY_SIZE(vlan_packet_offloads); i++)
759 dev_add_offload(&vlan_packet_offloads[i]);
761 vlan_ioctl_set(vlan_ioctl_handler);
769 unregister_netdevice_notifier(&vlan_notifier_block);
771 unregister_pernet_subsys(&vlan_net_ops);
776 static void __exit vlan_cleanup_module(void)
780 vlan_ioctl_set(NULL);
782 for (i = 0; i < ARRAY_SIZE(vlan_packet_offloads); i++)
783 dev_remove_offload(&vlan_packet_offloads[i]);
787 unregister_netdevice_notifier(&vlan_notifier_block);
789 unregister_pernet_subsys(&vlan_net_ops);
790 rcu_barrier(); /* Wait for completion of call_rcu()'s */
796 module_init(vlan_proto_init);
797 module_exit(vlan_cleanup_module);
799 MODULE_LICENSE("GPL");
800 MODULE_VERSION(DRV_VERSION);