1 // SPDX-License-Identifier: GPL-2.0-or-later
4 * Ethernet-type device handling.
8 * VLAN Home Page: http://www.candelatech.com/~greear/vlan.html
17 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
19 #include <linux/capability.h>
20 #include <linux/module.h>
21 #include <linux/netdevice.h>
22 #include <linux/skbuff.h>
23 #include <linux/slab.h>
24 #include <linux/init.h>
25 #include <linux/rculist.h>
26 #include <net/p8022.h>
28 #include <linux/rtnetlink.h>
29 #include <linux/notifier.h>
30 #include <net/rtnetlink.h>
31 #include <net/net_namespace.h>
32 #include <net/netns/generic.h>
33 #include <linux/uaccess.h>
35 #include <linux/if_vlan.h>
39 #define DRV_VERSION "1.8"
41 /* Global VLAN variables */
43 unsigned int vlan_net_id __read_mostly;
45 const char vlan_fullname[] = "802.1Q VLAN Support";
46 const char vlan_version[] = DRV_VERSION;
48 /* End of global variables definitions. */
50 static int vlan_group_prealloc_vid(struct vlan_group *vg,
51 __be16 vlan_proto, u16 vlan_id)
53 struct net_device **array;
54 unsigned int pidx, vidx;
59 pidx = vlan_proto_idx(vlan_proto);
60 vidx = vlan_id / VLAN_GROUP_ARRAY_PART_LEN;
61 array = vg->vlan_devices_arrays[pidx][vidx];
65 size = sizeof(struct net_device *) * VLAN_GROUP_ARRAY_PART_LEN;
66 array = kzalloc(size, GFP_KERNEL);
70 vg->vlan_devices_arrays[pidx][vidx] = array;
74 static void vlan_stacked_transfer_operstate(const struct net_device *rootdev,
75 struct net_device *dev,
76 struct vlan_dev_priv *vlan)
78 if (!(vlan->flags & VLAN_FLAG_BRIDGE_BINDING))
79 netif_stacked_transfer_operstate(rootdev, dev);
82 void unregister_vlan_dev(struct net_device *dev, struct list_head *head)
84 struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
85 struct net_device *real_dev = vlan->real_dev;
86 struct vlan_info *vlan_info;
87 struct vlan_group *grp;
88 u16 vlan_id = vlan->vlan_id;
92 vlan_info = rtnl_dereference(real_dev->vlan_info);
95 grp = &vlan_info->grp;
99 if (vlan->flags & VLAN_FLAG_MVRP)
100 vlan_mvrp_request_leave(dev);
101 if (vlan->flags & VLAN_FLAG_GVRP)
102 vlan_gvrp_request_leave(dev);
104 vlan_group_set_device(grp, vlan->vlan_proto, vlan_id, NULL);
106 netdev_upper_dev_unlink(real_dev, dev);
107 /* Because unregister_netdevice_queue() makes sure at least one rcu
108 * grace period is respected before device freeing,
109 * we dont need to call synchronize_net() here.
111 unregister_netdevice_queue(dev, head);
113 if (grp->nr_vlan_devs == 0) {
114 vlan_mvrp_uninit_applicant(real_dev);
115 vlan_gvrp_uninit_applicant(real_dev);
118 vlan_vid_del(real_dev, vlan->vlan_proto, vlan_id);
120 /* Get rid of the vlan's reference to real_dev */
124 int vlan_check_real_dev(struct net_device *real_dev,
125 __be16 protocol, u16 vlan_id,
126 struct netlink_ext_ack *extack)
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);
132 NL_SET_ERR_MSG_MOD(extack, "VLANs not supported on device");
136 if (vlan_find_dev(real_dev, protocol, vlan_id) != NULL) {
137 NL_SET_ERR_MSG_MOD(extack, "VLAN device already exists");
144 int register_vlan_dev(struct net_device *dev, struct netlink_ext_ack *extack)
146 struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
147 struct net_device *real_dev = vlan->real_dev;
148 u16 vlan_id = vlan->vlan_id;
149 struct vlan_info *vlan_info;
150 struct vlan_group *grp;
153 err = vlan_vid_add(real_dev, vlan->vlan_proto, vlan_id);
157 vlan_info = rtnl_dereference(real_dev->vlan_info);
158 /* vlan_info should be there now. vlan_vid_add took care of it */
161 grp = &vlan_info->grp;
162 if (grp->nr_vlan_devs == 0) {
163 err = vlan_gvrp_init_applicant(real_dev);
166 err = vlan_mvrp_init_applicant(real_dev);
168 goto out_uninit_gvrp;
171 err = vlan_group_prealloc_vid(grp, vlan->vlan_proto, vlan_id);
173 goto out_uninit_mvrp;
175 vlan->nest_level = dev_get_nest_level(real_dev) + 1;
176 err = register_netdevice(dev);
178 goto out_uninit_mvrp;
180 err = netdev_upper_dev_link(real_dev, dev, extack);
182 goto out_unregister_netdev;
184 /* Account for reference in struct vlan_dev_priv */
187 vlan_stacked_transfer_operstate(real_dev, dev, vlan);
188 linkwatch_fire_event(dev); /* _MUST_ call rfc2863_policy() */
190 /* So, got the sucker initialized, now lets place
191 * it into our local structure.
193 vlan_group_set_device(grp, vlan->vlan_proto, vlan_id, dev);
198 out_unregister_netdev:
199 unregister_netdevice(dev);
201 if (grp->nr_vlan_devs == 0)
202 vlan_mvrp_uninit_applicant(real_dev);
204 if (grp->nr_vlan_devs == 0)
205 vlan_gvrp_uninit_applicant(real_dev);
207 vlan_vid_del(real_dev, vlan->vlan_proto, vlan_id);
211 /* Attach a VLAN device to a mac address (ie Ethernet Card).
212 * Returns 0 if the device was created or a negative error code otherwise.
214 static int register_vlan_device(struct net_device *real_dev, u16 vlan_id)
216 struct net_device *new_dev;
217 struct vlan_dev_priv *vlan;
218 struct net *net = dev_net(real_dev);
219 struct vlan_net *vn = net_generic(net, vlan_net_id);
223 if (vlan_id >= VLAN_VID_MASK)
226 err = vlan_check_real_dev(real_dev, htons(ETH_P_8021Q), vlan_id,
231 /* Gotta set up the fields for the device. */
232 switch (vn->name_type) {
233 case VLAN_NAME_TYPE_RAW_PLUS_VID:
234 /* name will look like: eth1.0005 */
235 snprintf(name, IFNAMSIZ, "%s.%.4i", real_dev->name, vlan_id);
237 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD:
238 /* Put our vlan.VID in the name.
239 * Name will look like: vlan5
241 snprintf(name, IFNAMSIZ, "vlan%i", vlan_id);
243 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD:
244 /* Put our vlan.VID in the name.
245 * Name will look like: eth0.5
247 snprintf(name, IFNAMSIZ, "%s.%i", real_dev->name, vlan_id);
249 case VLAN_NAME_TYPE_PLUS_VID:
250 /* Put our vlan.VID in the name.
251 * Name will look like: vlan0005
254 snprintf(name, IFNAMSIZ, "vlan%.4i", vlan_id);
257 new_dev = alloc_netdev(sizeof(struct vlan_dev_priv), name,
258 NET_NAME_UNKNOWN, vlan_setup);
263 dev_net_set(new_dev, net);
264 /* need 4 bytes for extra VLAN header info,
265 * hope the underlying device can handle it.
267 new_dev->mtu = real_dev->mtu;
269 vlan = vlan_dev_priv(new_dev);
270 vlan->vlan_proto = htons(ETH_P_8021Q);
271 vlan->vlan_id = vlan_id;
272 vlan->real_dev = real_dev;
274 vlan->flags = VLAN_FLAG_REORDER_HDR;
276 new_dev->rtnl_link_ops = &vlan_link_ops;
277 err = register_vlan_dev(new_dev, NULL);
279 goto out_free_newdev;
284 if (new_dev->reg_state == NETREG_UNINITIALIZED)
285 free_netdev(new_dev);
289 static void vlan_sync_address(struct net_device *dev,
290 struct net_device *vlandev)
292 struct vlan_dev_priv *vlan = vlan_dev_priv(vlandev);
294 /* May be called without an actual change */
295 if (ether_addr_equal(vlan->real_dev_addr, dev->dev_addr))
298 /* vlan continues to inherit address of lower device */
299 if (vlan_dev_inherit_address(vlandev, dev))
302 /* vlan address was different from the old address and is equal to
304 if (!ether_addr_equal(vlandev->dev_addr, vlan->real_dev_addr) &&
305 ether_addr_equal(vlandev->dev_addr, dev->dev_addr))
306 dev_uc_del(dev, vlandev->dev_addr);
308 /* vlan address was equal to the old address and is different from
310 if (ether_addr_equal(vlandev->dev_addr, vlan->real_dev_addr) &&
311 !ether_addr_equal(vlandev->dev_addr, dev->dev_addr))
312 dev_uc_add(dev, vlandev->dev_addr);
315 ether_addr_copy(vlan->real_dev_addr, dev->dev_addr);
318 static void vlan_transfer_features(struct net_device *dev,
319 struct net_device *vlandev)
321 struct vlan_dev_priv *vlan = vlan_dev_priv(vlandev);
323 vlandev->gso_max_size = dev->gso_max_size;
324 vlandev->gso_max_segs = dev->gso_max_segs;
326 if (vlan_hw_offload_capable(dev->features, vlan->vlan_proto))
327 vlandev->hard_header_len = dev->hard_header_len;
329 vlandev->hard_header_len = dev->hard_header_len + VLAN_HLEN;
331 #if IS_ENABLED(CONFIG_FCOE)
332 vlandev->fcoe_ddp_xid = dev->fcoe_ddp_xid;
335 vlandev->priv_flags &= ~IFF_XMIT_DST_RELEASE;
336 vlandev->priv_flags |= (vlan->real_dev->priv_flags & IFF_XMIT_DST_RELEASE);
337 vlandev->hw_enc_features = vlan_tnl_features(vlan->real_dev);
339 netdev_update_features(vlandev);
342 static int __vlan_device_event(struct net_device *dev, unsigned long event)
347 case NETDEV_CHANGENAME:
348 vlan_proc_rem_dev(dev);
349 err = vlan_proc_add_dev(dev);
351 case NETDEV_REGISTER:
352 err = vlan_proc_add_dev(dev);
354 case NETDEV_UNREGISTER:
355 vlan_proc_rem_dev(dev);
362 static int vlan_device_event(struct notifier_block *unused, unsigned long event,
365 struct netlink_ext_ack *extack = netdev_notifier_info_to_extack(ptr);
366 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
367 struct vlan_group *grp;
368 struct vlan_info *vlan_info;
370 struct net_device *vlandev;
371 struct vlan_dev_priv *vlan;
376 if (is_vlan_dev(dev)) {
377 int err = __vlan_device_event(dev, event);
380 return notifier_from_errno(err);
383 if ((event == NETDEV_UP) &&
384 (dev->features & NETIF_F_HW_VLAN_CTAG_FILTER)) {
385 pr_info("adding VLAN 0 to HW filter on device %s\n",
387 vlan_vid_add(dev, htons(ETH_P_8021Q), 0);
389 if (event == NETDEV_DOWN &&
390 (dev->features & NETIF_F_HW_VLAN_CTAG_FILTER))
391 vlan_vid_del(dev, htons(ETH_P_8021Q), 0);
393 vlan_info = rtnl_dereference(dev->vlan_info);
396 grp = &vlan_info->grp;
398 /* It is OK that we do not hold the group lock right now,
399 * as we run under the RTNL lock.
404 /* Propagate real device state to vlan devices */
405 vlan_group_for_each_dev(grp, i, vlandev)
406 vlan_stacked_transfer_operstate(dev, vlandev,
407 vlan_dev_priv(vlandev));
410 case NETDEV_CHANGEADDR:
411 /* Adjust unicast filters on underlying device */
412 vlan_group_for_each_dev(grp, i, vlandev) {
413 flgs = vlandev->flags;
414 if (!(flgs & IFF_UP))
417 vlan_sync_address(dev, vlandev);
421 case NETDEV_CHANGEMTU:
422 vlan_group_for_each_dev(grp, i, vlandev) {
423 if (vlandev->mtu <= dev->mtu)
426 dev_set_mtu(vlandev, dev->mtu);
430 case NETDEV_FEAT_CHANGE:
431 /* Propagate device features to underlying device */
432 vlan_group_for_each_dev(grp, i, vlandev)
433 vlan_transfer_features(dev, vlandev);
437 struct net_device *tmp;
438 LIST_HEAD(close_list);
440 /* Put all VLANs for this dev in the down state too. */
441 vlan_group_for_each_dev(grp, i, vlandev) {
442 flgs = vlandev->flags;
443 if (!(flgs & IFF_UP))
446 vlan = vlan_dev_priv(vlandev);
447 if (!(vlan->flags & VLAN_FLAG_LOOSE_BINDING))
448 list_add(&vlandev->close_list, &close_list);
451 dev_close_many(&close_list, false);
453 list_for_each_entry_safe(vlandev, tmp, &close_list, close_list) {
454 vlan_stacked_transfer_operstate(dev, vlandev,
455 vlan_dev_priv(vlandev));
456 list_del_init(&vlandev->close_list);
458 list_del(&close_list);
462 /* Put all VLANs for this dev in the up state too. */
463 vlan_group_for_each_dev(grp, i, vlandev) {
464 flgs = dev_get_flags(vlandev);
468 vlan = vlan_dev_priv(vlandev);
469 if (!(vlan->flags & VLAN_FLAG_LOOSE_BINDING))
470 dev_change_flags(vlandev, flgs | IFF_UP,
472 vlan_stacked_transfer_operstate(dev, vlandev, vlan);
476 case NETDEV_UNREGISTER:
477 /* twiddle thumbs on netns device moves */
478 if (dev->reg_state != NETREG_UNREGISTERING)
481 vlan_group_for_each_dev(grp, i, vlandev) {
482 /* removal of last vid destroys vlan_info, abort
484 if (vlan_info->nr_vids == 1)
487 unregister_vlan_dev(vlandev, &list);
491 unregister_netdevice_many(&list);
494 case NETDEV_PRE_TYPE_CHANGE:
495 /* Forbid underlaying device to change its type. */
496 if (vlan_uses_dev(dev))
500 case NETDEV_NOTIFY_PEERS:
501 case NETDEV_BONDING_FAILOVER:
502 case NETDEV_RESEND_IGMP:
503 /* Propagate to vlan devices */
504 vlan_group_for_each_dev(grp, i, vlandev)
505 call_netdevice_notifiers(event, vlandev);
508 case NETDEV_CVLAN_FILTER_PUSH_INFO:
509 err = vlan_filter_push_vids(vlan_info, htons(ETH_P_8021Q));
511 return notifier_from_errno(err);
514 case NETDEV_CVLAN_FILTER_DROP_INFO:
515 vlan_filter_drop_vids(vlan_info, htons(ETH_P_8021Q));
518 case NETDEV_SVLAN_FILTER_PUSH_INFO:
519 err = vlan_filter_push_vids(vlan_info, htons(ETH_P_8021AD));
521 return notifier_from_errno(err);
524 case NETDEV_SVLAN_FILTER_DROP_INFO:
525 vlan_filter_drop_vids(vlan_info, htons(ETH_P_8021AD));
533 static struct notifier_block vlan_notifier_block __read_mostly = {
534 .notifier_call = vlan_device_event,
538 * VLAN IOCTL handler.
539 * o execute requested action or pass command to the device driver
540 * arg is really a struct vlan_ioctl_args __user *.
542 static int vlan_ioctl_handler(struct net *net, void __user *arg)
545 struct vlan_ioctl_args args;
546 struct net_device *dev = NULL;
548 if (copy_from_user(&args, arg, sizeof(struct vlan_ioctl_args)))
551 /* Null terminate this sucker, just in case. */
552 args.device1[sizeof(args.device1) - 1] = 0;
553 args.u.device2[sizeof(args.u.device2) - 1] = 0;
558 case SET_VLAN_INGRESS_PRIORITY_CMD:
559 case SET_VLAN_EGRESS_PRIORITY_CMD:
560 case SET_VLAN_FLAG_CMD:
563 case GET_VLAN_REALDEV_NAME_CMD:
564 case GET_VLAN_VID_CMD:
566 dev = __dev_get_by_name(net, args.device1);
571 if (args.cmd != ADD_VLAN_CMD && !is_vlan_dev(dev))
576 case SET_VLAN_INGRESS_PRIORITY_CMD:
578 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
580 vlan_dev_set_ingress_priority(dev,
586 case SET_VLAN_EGRESS_PRIORITY_CMD:
588 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
590 err = vlan_dev_set_egress_priority(dev,
595 case SET_VLAN_FLAG_CMD:
597 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
599 err = vlan_dev_change_flags(dev,
600 args.vlan_qos ? args.u.flag : 0,
604 case SET_VLAN_NAME_TYPE_CMD:
606 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
608 if (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 (!ns_capable(net->user_ns, CAP_NET_ADMIN))
623 err = register_vlan_device(dev, args.u.VID);
628 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
630 unregister_vlan_dev(dev, NULL);
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 __net_init vlan_init_net(struct net *net)
661 struct vlan_net *vn = net_generic(net, vlan_net_id);
664 vn->name_type = VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD;
666 err = vlan_proc_init(net);
671 static void __net_exit vlan_exit_net(struct net *net)
673 vlan_proc_cleanup(net);
676 static struct pernet_operations vlan_net_ops = {
677 .init = vlan_init_net,
678 .exit = vlan_exit_net,
680 .size = sizeof(struct vlan_net),
683 static int __init vlan_proto_init(void)
687 pr_info("%s v%s\n", vlan_fullname, vlan_version);
689 err = register_pernet_subsys(&vlan_net_ops);
693 err = register_netdevice_notifier(&vlan_notifier_block);
697 err = vlan_gvrp_init();
701 err = vlan_mvrp_init();
705 err = vlan_netlink_init();
709 vlan_ioctl_set(vlan_ioctl_handler);
717 unregister_netdevice_notifier(&vlan_notifier_block);
719 unregister_pernet_subsys(&vlan_net_ops);
724 static void __exit vlan_cleanup_module(void)
726 vlan_ioctl_set(NULL);
730 unregister_netdevice_notifier(&vlan_notifier_block);
732 unregister_pernet_subsys(&vlan_net_ops);
733 rcu_barrier(); /* Wait for completion of call_rcu()'s */
739 module_init(vlan_proto_init);
740 module_exit(vlan_cleanup_module);
742 MODULE_LICENSE("GPL");
743 MODULE_VERSION(DRV_VERSION);