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;
60 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 static void vlan_stacked_transfer_operstate(const struct net_device *rootdev,
79 struct net_device *dev,
80 struct vlan_dev_priv *vlan)
82 if (!(vlan->flags & VLAN_FLAG_BRIDGE_BINDING))
83 netif_stacked_transfer_operstate(rootdev, dev);
86 void unregister_vlan_dev(struct net_device *dev, struct list_head *head)
88 struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
89 struct net_device *real_dev = vlan->real_dev;
90 struct vlan_info *vlan_info;
91 struct vlan_group *grp;
92 u16 vlan_id = vlan->vlan_id;
96 vlan_info = rtnl_dereference(real_dev->vlan_info);
99 grp = &vlan_info->grp;
103 if (vlan->flags & VLAN_FLAG_MVRP)
104 vlan_mvrp_request_leave(dev);
105 if (vlan->flags & VLAN_FLAG_GVRP)
106 vlan_gvrp_request_leave(dev);
108 vlan_group_set_device(grp, vlan->vlan_proto, vlan_id, NULL);
110 netdev_upper_dev_unlink(real_dev, dev);
111 /* Because unregister_netdevice_queue() makes sure at least one rcu
112 * grace period is respected before device freeing,
113 * we dont need to call synchronize_net() here.
115 unregister_netdevice_queue(dev, head);
117 if (grp->nr_vlan_devs == 0) {
118 vlan_mvrp_uninit_applicant(real_dev);
119 vlan_gvrp_uninit_applicant(real_dev);
122 vlan_vid_del(real_dev, vlan->vlan_proto, vlan_id);
124 /* Get rid of the vlan's reference to real_dev */
128 int vlan_check_real_dev(struct net_device *real_dev,
129 __be16 protocol, u16 vlan_id,
130 struct netlink_ext_ack *extack)
132 const char *name = real_dev->name;
134 if (real_dev->features & NETIF_F_VLAN_CHALLENGED) {
135 pr_info("VLANs not supported on %s\n", name);
136 NL_SET_ERR_MSG_MOD(extack, "VLANs not supported on device");
140 if (vlan_find_dev(real_dev, protocol, vlan_id) != NULL) {
141 NL_SET_ERR_MSG_MOD(extack, "VLAN device already exists");
148 int register_vlan_dev(struct net_device *dev, struct netlink_ext_ack *extack)
150 struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
151 struct net_device *real_dev = vlan->real_dev;
152 u16 vlan_id = vlan->vlan_id;
153 struct vlan_info *vlan_info;
154 struct vlan_group *grp;
157 err = vlan_vid_add(real_dev, vlan->vlan_proto, vlan_id);
161 vlan_info = rtnl_dereference(real_dev->vlan_info);
162 /* vlan_info should be there now. vlan_vid_add took care of it */
165 grp = &vlan_info->grp;
166 if (grp->nr_vlan_devs == 0) {
167 err = vlan_gvrp_init_applicant(real_dev);
170 err = vlan_mvrp_init_applicant(real_dev);
172 goto out_uninit_gvrp;
175 err = vlan_group_prealloc_vid(grp, vlan->vlan_proto, vlan_id);
177 goto out_uninit_mvrp;
179 err = register_netdevice(dev);
181 goto out_uninit_mvrp;
183 err = netdev_upper_dev_link(real_dev, dev, extack);
185 goto out_unregister_netdev;
187 /* Account for reference in struct vlan_dev_priv */
190 vlan_stacked_transfer_operstate(real_dev, dev, vlan);
191 linkwatch_fire_event(dev); /* _MUST_ call rfc2863_policy() */
193 /* So, got the sucker initialized, now lets place
194 * it into our local structure.
196 vlan_group_set_device(grp, vlan->vlan_proto, vlan_id, dev);
201 out_unregister_netdev:
202 unregister_netdevice(dev);
204 if (grp->nr_vlan_devs == 0)
205 vlan_mvrp_uninit_applicant(real_dev);
207 if (grp->nr_vlan_devs == 0)
208 vlan_gvrp_uninit_applicant(real_dev);
210 vlan_vid_del(real_dev, vlan->vlan_proto, vlan_id);
214 /* Attach a VLAN device to a mac address (ie Ethernet Card).
215 * Returns 0 if the device was created or a negative error code otherwise.
217 static int register_vlan_device(struct net_device *real_dev, u16 vlan_id)
219 struct net_device *new_dev;
220 struct vlan_dev_priv *vlan;
221 struct net *net = dev_net(real_dev);
222 struct vlan_net *vn = net_generic(net, vlan_net_id);
226 if (vlan_id >= VLAN_VID_MASK)
229 err = vlan_check_real_dev(real_dev, htons(ETH_P_8021Q), vlan_id,
234 /* Gotta set up the fields for the device. */
235 switch (vn->name_type) {
236 case VLAN_NAME_TYPE_RAW_PLUS_VID:
237 /* name will look like: eth1.0005 */
238 snprintf(name, IFNAMSIZ, "%s.%.4i", real_dev->name, vlan_id);
240 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD:
241 /* Put our vlan.VID in the name.
242 * Name will look like: vlan5
244 snprintf(name, IFNAMSIZ, "vlan%i", vlan_id);
246 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD:
247 /* Put our vlan.VID in the name.
248 * Name will look like: eth0.5
250 snprintf(name, IFNAMSIZ, "%s.%i", real_dev->name, vlan_id);
252 case VLAN_NAME_TYPE_PLUS_VID:
253 /* Put our vlan.VID in the name.
254 * Name will look like: vlan0005
257 snprintf(name, IFNAMSIZ, "vlan%.4i", vlan_id);
260 new_dev = alloc_netdev(sizeof(struct vlan_dev_priv), name,
261 NET_NAME_UNKNOWN, vlan_setup);
266 dev_net_set(new_dev, net);
267 /* need 4 bytes for extra VLAN header info,
268 * hope the underlying device can handle it.
270 new_dev->mtu = real_dev->mtu;
272 vlan = vlan_dev_priv(new_dev);
273 vlan->vlan_proto = htons(ETH_P_8021Q);
274 vlan->vlan_id = vlan_id;
275 vlan->real_dev = real_dev;
277 vlan->flags = VLAN_FLAG_REORDER_HDR;
279 new_dev->rtnl_link_ops = &vlan_link_ops;
280 err = register_vlan_dev(new_dev, NULL);
282 goto out_free_newdev;
287 if (new_dev->reg_state == NETREG_UNINITIALIZED)
288 free_netdev(new_dev);
292 static void vlan_sync_address(struct net_device *dev,
293 struct net_device *vlandev)
295 struct vlan_dev_priv *vlan = vlan_dev_priv(vlandev);
297 /* May be called without an actual change */
298 if (ether_addr_equal(vlan->real_dev_addr, dev->dev_addr))
301 /* vlan continues to inherit address of lower device */
302 if (vlan_dev_inherit_address(vlandev, dev))
305 /* vlan address was different from the old address and is equal to
307 if (!ether_addr_equal(vlandev->dev_addr, vlan->real_dev_addr) &&
308 ether_addr_equal(vlandev->dev_addr, dev->dev_addr))
309 dev_uc_del(dev, vlandev->dev_addr);
311 /* vlan address was equal to the old address and is different from
313 if (ether_addr_equal(vlandev->dev_addr, vlan->real_dev_addr) &&
314 !ether_addr_equal(vlandev->dev_addr, dev->dev_addr))
315 dev_uc_add(dev, vlandev->dev_addr);
318 ether_addr_copy(vlan->real_dev_addr, dev->dev_addr);
321 static void vlan_transfer_features(struct net_device *dev,
322 struct net_device *vlandev)
324 struct vlan_dev_priv *vlan = vlan_dev_priv(vlandev);
326 vlandev->gso_max_size = dev->gso_max_size;
327 vlandev->gso_max_segs = dev->gso_max_segs;
329 if (vlan_hw_offload_capable(dev->features, vlan->vlan_proto))
330 vlandev->hard_header_len = dev->hard_header_len;
332 vlandev->hard_header_len = dev->hard_header_len + VLAN_HLEN;
334 #if IS_ENABLED(CONFIG_FCOE)
335 vlandev->fcoe_ddp_xid = dev->fcoe_ddp_xid;
338 vlandev->priv_flags &= ~IFF_XMIT_DST_RELEASE;
339 vlandev->priv_flags |= (vlan->real_dev->priv_flags & IFF_XMIT_DST_RELEASE);
340 vlandev->hw_enc_features = vlan_tnl_features(vlan->real_dev);
342 netdev_update_features(vlandev);
345 static int __vlan_device_event(struct net_device *dev, unsigned long event)
350 case NETDEV_CHANGENAME:
351 vlan_proc_rem_dev(dev);
352 err = vlan_proc_add_dev(dev);
354 case NETDEV_REGISTER:
355 err = vlan_proc_add_dev(dev);
357 case NETDEV_UNREGISTER:
358 vlan_proc_rem_dev(dev);
365 static int vlan_device_event(struct notifier_block *unused, unsigned long event,
368 struct netlink_ext_ack *extack = netdev_notifier_info_to_extack(ptr);
369 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
370 struct vlan_group *grp;
371 struct vlan_info *vlan_info;
373 struct net_device *vlandev;
374 struct vlan_dev_priv *vlan;
379 if (is_vlan_dev(dev)) {
380 int err = __vlan_device_event(dev, event);
383 return notifier_from_errno(err);
386 if ((event == NETDEV_UP) &&
387 (dev->features & NETIF_F_HW_VLAN_CTAG_FILTER)) {
388 pr_info("adding VLAN 0 to HW filter on device %s\n",
390 vlan_vid_add(dev, htons(ETH_P_8021Q), 0);
392 if (event == NETDEV_DOWN &&
393 (dev->features & NETIF_F_HW_VLAN_CTAG_FILTER))
394 vlan_vid_del(dev, htons(ETH_P_8021Q), 0);
396 vlan_info = rtnl_dereference(dev->vlan_info);
399 grp = &vlan_info->grp;
401 /* It is OK that we do not hold the group lock right now,
402 * as we run under the RTNL lock.
407 /* Propagate real device state to vlan devices */
408 vlan_group_for_each_dev(grp, i, vlandev)
409 vlan_stacked_transfer_operstate(dev, vlandev,
410 vlan_dev_priv(vlandev));
413 case NETDEV_CHANGEADDR:
414 /* Adjust unicast filters on underlying device */
415 vlan_group_for_each_dev(grp, i, vlandev) {
416 flgs = vlandev->flags;
417 if (!(flgs & IFF_UP))
420 vlan_sync_address(dev, vlandev);
424 case NETDEV_CHANGEMTU:
425 vlan_group_for_each_dev(grp, i, vlandev) {
426 if (vlandev->mtu <= dev->mtu)
429 dev_set_mtu(vlandev, dev->mtu);
433 case NETDEV_FEAT_CHANGE:
434 /* Propagate device features to underlying device */
435 vlan_group_for_each_dev(grp, i, vlandev)
436 vlan_transfer_features(dev, vlandev);
440 struct net_device *tmp;
441 LIST_HEAD(close_list);
443 /* Put all VLANs for this dev in the down state too. */
444 vlan_group_for_each_dev(grp, i, vlandev) {
445 flgs = vlandev->flags;
446 if (!(flgs & IFF_UP))
449 vlan = vlan_dev_priv(vlandev);
450 if (!(vlan->flags & VLAN_FLAG_LOOSE_BINDING))
451 list_add(&vlandev->close_list, &close_list);
454 dev_close_many(&close_list, false);
456 list_for_each_entry_safe(vlandev, tmp, &close_list, close_list) {
457 vlan_stacked_transfer_operstate(dev, vlandev,
458 vlan_dev_priv(vlandev));
459 list_del_init(&vlandev->close_list);
461 list_del(&close_list);
465 /* Put all VLANs for this dev in the up state too. */
466 vlan_group_for_each_dev(grp, i, vlandev) {
467 flgs = dev_get_flags(vlandev);
471 vlan = vlan_dev_priv(vlandev);
472 if (!(vlan->flags & VLAN_FLAG_LOOSE_BINDING))
473 dev_change_flags(vlandev, flgs | IFF_UP,
475 vlan_stacked_transfer_operstate(dev, vlandev, vlan);
479 case NETDEV_UNREGISTER:
480 /* twiddle thumbs on netns device moves */
481 if (dev->reg_state != NETREG_UNREGISTERING)
484 vlan_group_for_each_dev(grp, i, vlandev) {
485 /* removal of last vid destroys vlan_info, abort
487 if (vlan_info->nr_vids == 1)
490 unregister_vlan_dev(vlandev, &list);
494 unregister_netdevice_many(&list);
497 case NETDEV_PRE_TYPE_CHANGE:
498 /* Forbid underlaying device to change its type. */
499 if (vlan_uses_dev(dev))
503 case NETDEV_NOTIFY_PEERS:
504 case NETDEV_BONDING_FAILOVER:
505 case NETDEV_RESEND_IGMP:
506 /* Propagate to vlan devices */
507 vlan_group_for_each_dev(grp, i, vlandev)
508 call_netdevice_notifiers(event, vlandev);
511 case NETDEV_CVLAN_FILTER_PUSH_INFO:
512 err = vlan_filter_push_vids(vlan_info, htons(ETH_P_8021Q));
514 return notifier_from_errno(err);
517 case NETDEV_CVLAN_FILTER_DROP_INFO:
518 vlan_filter_drop_vids(vlan_info, htons(ETH_P_8021Q));
521 case NETDEV_SVLAN_FILTER_PUSH_INFO:
522 err = vlan_filter_push_vids(vlan_info, htons(ETH_P_8021AD));
524 return notifier_from_errno(err);
527 case NETDEV_SVLAN_FILTER_DROP_INFO:
528 vlan_filter_drop_vids(vlan_info, htons(ETH_P_8021AD));
536 static struct notifier_block vlan_notifier_block __read_mostly = {
537 .notifier_call = vlan_device_event,
541 * VLAN IOCTL handler.
542 * o execute requested action or pass command to the device driver
543 * arg is really a struct vlan_ioctl_args __user *.
545 static int vlan_ioctl_handler(struct net *net, void __user *arg)
548 struct vlan_ioctl_args args;
549 struct net_device *dev = NULL;
551 if (copy_from_user(&args, arg, sizeof(struct vlan_ioctl_args)))
554 /* Null terminate this sucker, just in case. */
555 args.device1[sizeof(args.device1) - 1] = 0;
556 args.u.device2[sizeof(args.u.device2) - 1] = 0;
561 case SET_VLAN_INGRESS_PRIORITY_CMD:
562 case SET_VLAN_EGRESS_PRIORITY_CMD:
563 case SET_VLAN_FLAG_CMD:
566 case GET_VLAN_REALDEV_NAME_CMD:
567 case GET_VLAN_VID_CMD:
569 dev = __dev_get_by_name(net, args.device1);
574 if (args.cmd != ADD_VLAN_CMD && !is_vlan_dev(dev))
579 case SET_VLAN_INGRESS_PRIORITY_CMD:
581 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
583 vlan_dev_set_ingress_priority(dev,
589 case SET_VLAN_EGRESS_PRIORITY_CMD:
591 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
593 err = vlan_dev_set_egress_priority(dev,
598 case SET_VLAN_FLAG_CMD:
600 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
602 err = vlan_dev_change_flags(dev,
603 args.vlan_qos ? args.u.flag : 0,
607 case SET_VLAN_NAME_TYPE_CMD:
609 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
611 if (args.u.name_type < VLAN_NAME_TYPE_HIGHEST) {
614 vn = net_generic(net, vlan_net_id);
615 vn->name_type = args.u.name_type;
624 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
626 err = register_vlan_device(dev, args.u.VID);
631 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
633 unregister_vlan_dev(dev, NULL);
637 case GET_VLAN_REALDEV_NAME_CMD:
639 vlan_dev_get_realdev_name(dev, args.u.device2);
640 if (copy_to_user(arg, &args,
641 sizeof(struct vlan_ioctl_args)))
645 case GET_VLAN_VID_CMD:
647 args.u.VID = vlan_dev_vlan_id(dev);
648 if (copy_to_user(arg, &args,
649 sizeof(struct vlan_ioctl_args)))
662 static int __net_init vlan_init_net(struct net *net)
664 struct vlan_net *vn = net_generic(net, vlan_net_id);
667 vn->name_type = VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD;
669 err = vlan_proc_init(net);
674 static void __net_exit vlan_exit_net(struct net *net)
676 vlan_proc_cleanup(net);
679 static struct pernet_operations vlan_net_ops = {
680 .init = vlan_init_net,
681 .exit = vlan_exit_net,
683 .size = sizeof(struct vlan_net),
686 static int __init vlan_proto_init(void)
690 pr_info("%s v%s\n", vlan_fullname, vlan_version);
692 err = register_pernet_subsys(&vlan_net_ops);
696 err = register_netdevice_notifier(&vlan_notifier_block);
700 err = vlan_gvrp_init();
704 err = vlan_mvrp_init();
708 err = vlan_netlink_init();
712 vlan_ioctl_set(vlan_ioctl_handler);
720 unregister_netdevice_notifier(&vlan_notifier_block);
722 unregister_pernet_subsys(&vlan_net_ops);
727 static void __exit vlan_cleanup_module(void)
729 vlan_ioctl_set(NULL);
733 unregister_netdevice_notifier(&vlan_notifier_block);
735 unregister_pernet_subsys(&vlan_net_ops);
736 rcu_barrier(); /* Wait for completion of call_rcu()'s */
742 module_init(vlan_proto_init);
743 module_exit(vlan_cleanup_module);
745 MODULE_LICENSE("GPL");
746 MODULE_VERSION(DRV_VERSION);