1 // SPDX-License-Identifier: GPL-2.0-or-later
4 * Ethernet-type device handling.
6 * Authors: Ben Greear <greearb@candelatech.com>
7 * Please send support related email to: netdev@vger.kernel.org
8 * VLAN Home Page: http://www.candelatech.com/~greear/vlan.html
11 * Fix for packet capture - Nick Eggleston <nick@dccinc.com>;
12 * Add HW acceleration hooks - David S. Miller <davem@redhat.com>;
13 * Correct all the locking - David S. Miller <davem@redhat.com>;
14 * Use hash table for VLAN groups - David S. Miller <davem@redhat.com>
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);
121 int vlan_check_real_dev(struct net_device *real_dev,
122 __be16 protocol, u16 vlan_id,
123 struct netlink_ext_ack *extack)
125 const char *name = real_dev->name;
127 if (real_dev->features & NETIF_F_VLAN_CHALLENGED) {
128 pr_info("VLANs not supported on %s\n", name);
129 NL_SET_ERR_MSG_MOD(extack, "VLANs not supported on device");
133 if (vlan_find_dev(real_dev, protocol, vlan_id) != NULL) {
134 NL_SET_ERR_MSG_MOD(extack, "VLAN device already exists");
141 int register_vlan_dev(struct net_device *dev, struct netlink_ext_ack *extack)
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 err = register_netdevice(dev);
174 goto out_uninit_mvrp;
176 err = netdev_upper_dev_link(real_dev, dev, extack);
178 goto out_unregister_netdev;
180 vlan_stacked_transfer_operstate(real_dev, dev, vlan);
181 linkwatch_fire_event(dev); /* _MUST_ call rfc2863_policy() */
183 /* So, got the sucker initialized, now lets place
184 * it into our local structure.
186 vlan_group_set_device(grp, vlan->vlan_proto, vlan_id, dev);
191 out_unregister_netdev:
192 unregister_netdevice(dev);
194 if (grp->nr_vlan_devs == 0)
195 vlan_mvrp_uninit_applicant(real_dev);
197 if (grp->nr_vlan_devs == 0)
198 vlan_gvrp_uninit_applicant(real_dev);
200 vlan_vid_del(real_dev, vlan->vlan_proto, vlan_id);
204 /* Attach a VLAN device to a mac address (ie Ethernet Card).
205 * Returns 0 if the device was created or a negative error code otherwise.
207 static int register_vlan_device(struct net_device *real_dev, u16 vlan_id)
209 struct net_device *new_dev;
210 struct vlan_dev_priv *vlan;
211 struct net *net = dev_net(real_dev);
212 struct vlan_net *vn = net_generic(net, vlan_net_id);
216 if (vlan_id >= VLAN_VID_MASK)
219 err = vlan_check_real_dev(real_dev, htons(ETH_P_8021Q), vlan_id,
224 /* Gotta set up the fields for the device. */
225 switch (vn->name_type) {
226 case VLAN_NAME_TYPE_RAW_PLUS_VID:
227 /* name will look like: eth1.0005 */
228 snprintf(name, IFNAMSIZ, "%s.%.4i", real_dev->name, vlan_id);
230 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD:
231 /* Put our vlan.VID in the name.
232 * Name will look like: vlan5
234 snprintf(name, IFNAMSIZ, "vlan%i", vlan_id);
236 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD:
237 /* Put our vlan.VID in the name.
238 * Name will look like: eth0.5
240 snprintf(name, IFNAMSIZ, "%s.%i", real_dev->name, vlan_id);
242 case VLAN_NAME_TYPE_PLUS_VID:
243 /* Put our vlan.VID in the name.
244 * Name will look like: vlan0005
247 snprintf(name, IFNAMSIZ, "vlan%.4i", vlan_id);
250 new_dev = alloc_netdev(sizeof(struct vlan_dev_priv), name,
251 NET_NAME_UNKNOWN, vlan_setup);
256 dev_net_set(new_dev, net);
257 /* need 4 bytes for extra VLAN header info,
258 * hope the underlying device can handle it.
260 new_dev->mtu = real_dev->mtu;
262 vlan = vlan_dev_priv(new_dev);
263 vlan->vlan_proto = htons(ETH_P_8021Q);
264 vlan->vlan_id = vlan_id;
265 vlan->real_dev = real_dev;
267 vlan->flags = VLAN_FLAG_REORDER_HDR;
269 new_dev->rtnl_link_ops = &vlan_link_ops;
270 err = register_vlan_dev(new_dev, NULL);
272 goto out_free_newdev;
277 if (new_dev->reg_state == NETREG_UNINITIALIZED ||
278 new_dev->reg_state == NETREG_UNREGISTERED)
279 free_netdev(new_dev);
283 static void vlan_sync_address(struct net_device *dev,
284 struct net_device *vlandev)
286 struct vlan_dev_priv *vlan = vlan_dev_priv(vlandev);
288 /* May be called without an actual change */
289 if (ether_addr_equal(vlan->real_dev_addr, dev->dev_addr))
292 /* vlan continues to inherit address of lower device */
293 if (vlan_dev_inherit_address(vlandev, dev))
296 /* vlan address was different from the old address and is equal to
298 if (!ether_addr_equal(vlandev->dev_addr, vlan->real_dev_addr) &&
299 ether_addr_equal(vlandev->dev_addr, dev->dev_addr))
300 dev_uc_del(dev, vlandev->dev_addr);
302 /* vlan address was equal to the old address and is different from
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_add(dev, vlandev->dev_addr);
309 ether_addr_copy(vlan->real_dev_addr, dev->dev_addr);
312 static void vlan_transfer_features(struct net_device *dev,
313 struct net_device *vlandev)
315 struct vlan_dev_priv *vlan = vlan_dev_priv(vlandev);
317 vlandev->gso_max_size = dev->gso_max_size;
318 vlandev->gso_max_segs = dev->gso_max_segs;
320 if (vlan_hw_offload_capable(dev->features, vlan->vlan_proto))
321 vlandev->hard_header_len = dev->hard_header_len;
323 vlandev->hard_header_len = dev->hard_header_len + VLAN_HLEN;
325 #if IS_ENABLED(CONFIG_FCOE)
326 vlandev->fcoe_ddp_xid = dev->fcoe_ddp_xid;
329 vlandev->priv_flags &= ~IFF_XMIT_DST_RELEASE;
330 vlandev->priv_flags |= (vlan->real_dev->priv_flags & IFF_XMIT_DST_RELEASE);
331 vlandev->hw_enc_features = vlan_tnl_features(vlan->real_dev);
333 netdev_update_features(vlandev);
336 static int __vlan_device_event(struct net_device *dev, unsigned long event)
341 case NETDEV_CHANGENAME:
342 vlan_proc_rem_dev(dev);
343 err = vlan_proc_add_dev(dev);
345 case NETDEV_REGISTER:
346 err = vlan_proc_add_dev(dev);
348 case NETDEV_UNREGISTER:
349 vlan_proc_rem_dev(dev);
356 static int vlan_device_event(struct notifier_block *unused, unsigned long event,
359 struct netlink_ext_ack *extack = netdev_notifier_info_to_extack(ptr);
360 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
361 struct vlan_group *grp;
362 struct vlan_info *vlan_info;
364 struct net_device *vlandev;
365 struct vlan_dev_priv *vlan;
370 if (is_vlan_dev(dev)) {
371 int err = __vlan_device_event(dev, event);
374 return notifier_from_errno(err);
377 if ((event == NETDEV_UP) &&
378 (dev->features & NETIF_F_HW_VLAN_CTAG_FILTER)) {
379 pr_info("adding VLAN 0 to HW filter on device %s\n",
381 vlan_vid_add(dev, htons(ETH_P_8021Q), 0);
383 if (event == NETDEV_DOWN &&
384 (dev->features & NETIF_F_HW_VLAN_CTAG_FILTER))
385 vlan_vid_del(dev, htons(ETH_P_8021Q), 0);
387 vlan_info = rtnl_dereference(dev->vlan_info);
390 grp = &vlan_info->grp;
392 /* It is OK that we do not hold the group lock right now,
393 * as we run under the RTNL lock.
398 /* Propagate real device state to vlan devices */
399 vlan_group_for_each_dev(grp, i, vlandev)
400 vlan_stacked_transfer_operstate(dev, vlandev,
401 vlan_dev_priv(vlandev));
404 case NETDEV_CHANGEADDR:
405 /* Adjust unicast filters on underlying device */
406 vlan_group_for_each_dev(grp, i, vlandev) {
407 flgs = vlandev->flags;
408 if (!(flgs & IFF_UP))
411 vlan_sync_address(dev, vlandev);
415 case NETDEV_CHANGEMTU:
416 vlan_group_for_each_dev(grp, i, vlandev) {
417 if (vlandev->mtu <= dev->mtu)
420 dev_set_mtu(vlandev, dev->mtu);
424 case NETDEV_FEAT_CHANGE:
425 /* Propagate device features to underlying device */
426 vlan_group_for_each_dev(grp, i, vlandev)
427 vlan_transfer_features(dev, vlandev);
431 struct net_device *tmp;
432 LIST_HEAD(close_list);
434 /* Put all VLANs for this dev in the down state too. */
435 vlan_group_for_each_dev(grp, i, vlandev) {
436 flgs = vlandev->flags;
437 if (!(flgs & IFF_UP))
440 vlan = vlan_dev_priv(vlandev);
441 if (!(vlan->flags & VLAN_FLAG_LOOSE_BINDING))
442 list_add(&vlandev->close_list, &close_list);
445 dev_close_many(&close_list, false);
447 list_for_each_entry_safe(vlandev, tmp, &close_list, close_list) {
448 vlan_stacked_transfer_operstate(dev, vlandev,
449 vlan_dev_priv(vlandev));
450 list_del_init(&vlandev->close_list);
452 list_del(&close_list);
456 /* Put all VLANs for this dev in the up state too. */
457 vlan_group_for_each_dev(grp, i, vlandev) {
458 flgs = dev_get_flags(vlandev);
462 vlan = vlan_dev_priv(vlandev);
463 if (!(vlan->flags & VLAN_FLAG_LOOSE_BINDING))
464 dev_change_flags(vlandev, flgs | IFF_UP,
466 vlan_stacked_transfer_operstate(dev, vlandev, vlan);
470 case NETDEV_UNREGISTER:
471 /* twiddle thumbs on netns device moves */
472 if (dev->reg_state != NETREG_UNREGISTERING)
475 vlan_group_for_each_dev(grp, i, vlandev) {
476 /* removal of last vid destroys vlan_info, abort
478 if (vlan_info->nr_vids == 1)
481 unregister_vlan_dev(vlandev, &list);
485 unregister_netdevice_many(&list);
488 case NETDEV_PRE_TYPE_CHANGE:
489 /* Forbid underlaying device to change its type. */
490 if (vlan_uses_dev(dev))
494 case NETDEV_NOTIFY_PEERS:
495 case NETDEV_BONDING_FAILOVER:
496 case NETDEV_RESEND_IGMP:
497 /* Propagate to vlan devices */
498 vlan_group_for_each_dev(grp, i, vlandev)
499 call_netdevice_notifiers(event, vlandev);
502 case NETDEV_CVLAN_FILTER_PUSH_INFO:
503 err = vlan_filter_push_vids(vlan_info, htons(ETH_P_8021Q));
505 return notifier_from_errno(err);
508 case NETDEV_CVLAN_FILTER_DROP_INFO:
509 vlan_filter_drop_vids(vlan_info, htons(ETH_P_8021Q));
512 case NETDEV_SVLAN_FILTER_PUSH_INFO:
513 err = vlan_filter_push_vids(vlan_info, htons(ETH_P_8021AD));
515 return notifier_from_errno(err);
518 case NETDEV_SVLAN_FILTER_DROP_INFO:
519 vlan_filter_drop_vids(vlan_info, htons(ETH_P_8021AD));
527 static struct notifier_block vlan_notifier_block __read_mostly = {
528 .notifier_call = vlan_device_event,
532 * VLAN IOCTL handler.
533 * o execute requested action or pass command to the device driver
534 * arg is really a struct vlan_ioctl_args __user *.
536 static int vlan_ioctl_handler(struct net *net, void __user *arg)
539 struct vlan_ioctl_args args;
540 struct net_device *dev = NULL;
542 if (copy_from_user(&args, arg, sizeof(struct vlan_ioctl_args)))
545 /* Null terminate this sucker, just in case. */
546 args.device1[sizeof(args.device1) - 1] = 0;
547 args.u.device2[sizeof(args.u.device2) - 1] = 0;
552 case SET_VLAN_INGRESS_PRIORITY_CMD:
553 case SET_VLAN_EGRESS_PRIORITY_CMD:
554 case SET_VLAN_FLAG_CMD:
557 case GET_VLAN_REALDEV_NAME_CMD:
558 case GET_VLAN_VID_CMD:
560 dev = __dev_get_by_name(net, args.device1);
565 if (args.cmd != ADD_VLAN_CMD && !is_vlan_dev(dev))
570 case SET_VLAN_INGRESS_PRIORITY_CMD:
572 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
574 vlan_dev_set_ingress_priority(dev,
580 case SET_VLAN_EGRESS_PRIORITY_CMD:
582 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
584 err = vlan_dev_set_egress_priority(dev,
589 case SET_VLAN_FLAG_CMD:
591 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
593 err = vlan_dev_change_flags(dev,
594 args.vlan_qos ? args.u.flag : 0,
598 case SET_VLAN_NAME_TYPE_CMD:
600 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
602 if (args.u.name_type < VLAN_NAME_TYPE_HIGHEST) {
605 vn = net_generic(net, vlan_net_id);
606 vn->name_type = args.u.name_type;
615 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
617 err = register_vlan_device(dev, args.u.VID);
622 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
624 unregister_vlan_dev(dev, NULL);
628 case GET_VLAN_REALDEV_NAME_CMD:
630 vlan_dev_get_realdev_name(dev, args.u.device2);
631 if (copy_to_user(arg, &args,
632 sizeof(struct vlan_ioctl_args)))
636 case GET_VLAN_VID_CMD:
638 args.u.VID = vlan_dev_vlan_id(dev);
639 if (copy_to_user(arg, &args,
640 sizeof(struct vlan_ioctl_args)))
653 static int __net_init vlan_init_net(struct net *net)
655 struct vlan_net *vn = net_generic(net, vlan_net_id);
658 vn->name_type = VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD;
660 err = vlan_proc_init(net);
665 static void __net_exit vlan_exit_net(struct net *net)
667 vlan_proc_cleanup(net);
670 static struct pernet_operations vlan_net_ops = {
671 .init = vlan_init_net,
672 .exit = vlan_exit_net,
674 .size = sizeof(struct vlan_net),
677 static int __init vlan_proto_init(void)
681 pr_info("%s v%s\n", vlan_fullname, vlan_version);
683 err = register_pernet_subsys(&vlan_net_ops);
687 err = register_netdevice_notifier(&vlan_notifier_block);
691 err = vlan_gvrp_init();
695 err = vlan_mvrp_init();
699 err = vlan_netlink_init();
703 vlan_ioctl_set(vlan_ioctl_handler);
711 unregister_netdevice_notifier(&vlan_notifier_block);
713 unregister_pernet_subsys(&vlan_net_ops);
718 static void __exit vlan_cleanup_module(void)
720 vlan_ioctl_set(NULL);
724 unregister_netdevice_notifier(&vlan_notifier_block);
726 unregister_pernet_subsys(&vlan_net_ops);
727 rcu_barrier(); /* Wait for completion of call_rcu()'s */
733 module_init(vlan_proto_init);
734 module_exit(vlan_cleanup_module);
736 MODULE_LICENSE("GPL");
737 MODULE_VERSION(DRV_VERSION);