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;
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_ACCOUNT);
74 /* paired with smp_rmb() in __vlan_group_get_device() */
77 vg->vlan_devices_arrays[pidx][vidx] = array;
81 static void vlan_stacked_transfer_operstate(const struct net_device *rootdev,
82 struct net_device *dev,
83 struct vlan_dev_priv *vlan)
85 if (!(vlan->flags & VLAN_FLAG_BRIDGE_BINDING))
86 netif_stacked_transfer_operstate(rootdev, dev);
89 void unregister_vlan_dev(struct net_device *dev, struct list_head *head)
91 struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
92 struct net_device *real_dev = vlan->real_dev;
93 struct vlan_info *vlan_info;
94 struct vlan_group *grp;
95 u16 vlan_id = vlan->vlan_id;
99 vlan_info = rtnl_dereference(real_dev->vlan_info);
102 grp = &vlan_info->grp;
106 if (vlan->flags & VLAN_FLAG_MVRP)
107 vlan_mvrp_request_leave(dev);
108 if (vlan->flags & VLAN_FLAG_GVRP)
109 vlan_gvrp_request_leave(dev);
111 vlan_group_set_device(grp, vlan->vlan_proto, vlan_id, NULL);
113 netdev_upper_dev_unlink(real_dev, dev);
114 /* Because unregister_netdevice_queue() makes sure at least one rcu
115 * grace period is respected before device freeing,
116 * we dont need to call synchronize_net() here.
118 unregister_netdevice_queue(dev, head);
120 if (grp->nr_vlan_devs == 0) {
121 vlan_mvrp_uninit_applicant(real_dev);
122 vlan_gvrp_uninit_applicant(real_dev);
125 vlan_vid_del(real_dev, vlan->vlan_proto, vlan_id);
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 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 free_netdev(new_dev);
288 static void vlan_sync_address(struct net_device *dev,
289 struct net_device *vlandev)
291 struct vlan_dev_priv *vlan = vlan_dev_priv(vlandev);
293 /* May be called without an actual change */
294 if (ether_addr_equal(vlan->real_dev_addr, dev->dev_addr))
297 /* vlan continues to inherit address of lower device */
298 if (vlan_dev_inherit_address(vlandev, dev))
301 /* vlan address was different from the old address and is equal to
303 if (!ether_addr_equal(vlandev->dev_addr, vlan->real_dev_addr) &&
304 ether_addr_equal(vlandev->dev_addr, dev->dev_addr))
305 dev_uc_del(dev, vlandev->dev_addr);
307 /* vlan address was equal to the old address and is different from
309 if (ether_addr_equal(vlandev->dev_addr, vlan->real_dev_addr) &&
310 !ether_addr_equal(vlandev->dev_addr, dev->dev_addr))
311 dev_uc_add(dev, vlandev->dev_addr);
314 ether_addr_copy(vlan->real_dev_addr, dev->dev_addr);
317 static void vlan_transfer_features(struct net_device *dev,
318 struct net_device *vlandev)
320 struct vlan_dev_priv *vlan = vlan_dev_priv(vlandev);
322 netif_inherit_tso_max(vlandev, dev);
324 if (vlan_hw_offload_capable(dev->features, vlan->vlan_proto))
325 vlandev->hard_header_len = dev->hard_header_len;
327 vlandev->hard_header_len = dev->hard_header_len + VLAN_HLEN;
329 #if IS_ENABLED(CONFIG_FCOE)
330 vlandev->fcoe_ddp_xid = dev->fcoe_ddp_xid;
333 vlandev->priv_flags &= ~IFF_XMIT_DST_RELEASE;
334 vlandev->priv_flags |= (vlan->real_dev->priv_flags & IFF_XMIT_DST_RELEASE);
335 vlandev->hw_enc_features = vlan_tnl_features(vlan->real_dev);
337 netdev_update_features(vlandev);
340 static int __vlan_device_event(struct net_device *dev, unsigned long event)
345 case NETDEV_CHANGENAME:
346 vlan_proc_rem_dev(dev);
347 err = vlan_proc_add_dev(dev);
349 case NETDEV_REGISTER:
350 err = vlan_proc_add_dev(dev);
352 case NETDEV_UNREGISTER:
353 vlan_proc_rem_dev(dev);
360 static int vlan_device_event(struct notifier_block *unused, unsigned long event,
363 struct netlink_ext_ack *extack = netdev_notifier_info_to_extack(ptr);
364 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
365 struct vlan_group *grp;
366 struct vlan_info *vlan_info;
368 struct net_device *vlandev;
369 struct vlan_dev_priv *vlan;
374 if (is_vlan_dev(dev)) {
375 int err = __vlan_device_event(dev, event);
378 return notifier_from_errno(err);
381 if ((event == NETDEV_UP) &&
382 (dev->features & NETIF_F_HW_VLAN_CTAG_FILTER)) {
383 pr_info("adding VLAN 0 to HW filter on device %s\n",
385 vlan_vid_add(dev, htons(ETH_P_8021Q), 0);
387 if (event == NETDEV_DOWN &&
388 (dev->features & NETIF_F_HW_VLAN_CTAG_FILTER))
389 vlan_vid_del(dev, htons(ETH_P_8021Q), 0);
391 vlan_info = rtnl_dereference(dev->vlan_info);
394 grp = &vlan_info->grp;
396 /* It is OK that we do not hold the group lock right now,
397 * as we run under the RTNL lock.
402 /* Propagate real device state to vlan devices */
403 vlan_group_for_each_dev(grp, i, vlandev)
404 vlan_stacked_transfer_operstate(dev, vlandev,
405 vlan_dev_priv(vlandev));
408 case NETDEV_CHANGEADDR:
409 /* Adjust unicast filters on underlying device */
410 vlan_group_for_each_dev(grp, i, vlandev) {
411 flgs = vlandev->flags;
412 if (!(flgs & IFF_UP))
415 vlan_sync_address(dev, vlandev);
419 case NETDEV_CHANGEMTU:
420 vlan_group_for_each_dev(grp, i, vlandev) {
421 if (vlandev->mtu <= dev->mtu)
424 dev_set_mtu(vlandev, dev->mtu);
428 case NETDEV_FEAT_CHANGE:
429 /* Propagate device features to underlying device */
430 vlan_group_for_each_dev(grp, i, vlandev)
431 vlan_transfer_features(dev, vlandev);
435 struct net_device *tmp;
436 LIST_HEAD(close_list);
438 /* Put all VLANs for this dev in the down state too. */
439 vlan_group_for_each_dev(grp, i, vlandev) {
440 flgs = vlandev->flags;
441 if (!(flgs & IFF_UP))
444 vlan = vlan_dev_priv(vlandev);
445 if (!(vlan->flags & VLAN_FLAG_LOOSE_BINDING))
446 list_add(&vlandev->close_list, &close_list);
449 dev_close_many(&close_list, false);
451 list_for_each_entry_safe(vlandev, tmp, &close_list, close_list) {
452 vlan_stacked_transfer_operstate(dev, vlandev,
453 vlan_dev_priv(vlandev));
454 list_del_init(&vlandev->close_list);
456 list_del(&close_list);
460 /* Put all VLANs for this dev in the up state too. */
461 vlan_group_for_each_dev(grp, i, vlandev) {
462 flgs = dev_get_flags(vlandev);
466 vlan = vlan_dev_priv(vlandev);
467 if (!(vlan->flags & VLAN_FLAG_LOOSE_BINDING))
468 dev_change_flags(vlandev, flgs | IFF_UP,
470 vlan_stacked_transfer_operstate(dev, vlandev, vlan);
474 case NETDEV_UNREGISTER:
475 /* twiddle thumbs on netns device moves */
476 if (dev->reg_state != NETREG_UNREGISTERING)
479 vlan_group_for_each_dev(grp, i, vlandev) {
480 /* removal of last vid destroys vlan_info, abort
482 if (vlan_info->nr_vids == 1)
485 unregister_vlan_dev(vlandev, &list);
489 unregister_netdevice_many(&list);
492 case NETDEV_PRE_TYPE_CHANGE:
493 /* Forbid underlaying device to change its type. */
494 if (vlan_uses_dev(dev))
498 case NETDEV_NOTIFY_PEERS:
499 case NETDEV_BONDING_FAILOVER:
500 case NETDEV_RESEND_IGMP:
501 /* Propagate to vlan devices */
502 vlan_group_for_each_dev(grp, i, vlandev)
503 call_netdevice_notifiers(event, vlandev);
506 case NETDEV_CVLAN_FILTER_PUSH_INFO:
507 err = vlan_filter_push_vids(vlan_info, htons(ETH_P_8021Q));
509 return notifier_from_errno(err);
512 case NETDEV_CVLAN_FILTER_DROP_INFO:
513 vlan_filter_drop_vids(vlan_info, htons(ETH_P_8021Q));
516 case NETDEV_SVLAN_FILTER_PUSH_INFO:
517 err = vlan_filter_push_vids(vlan_info, htons(ETH_P_8021AD));
519 return notifier_from_errno(err);
522 case NETDEV_SVLAN_FILTER_DROP_INFO:
523 vlan_filter_drop_vids(vlan_info, htons(ETH_P_8021AD));
531 static struct notifier_block vlan_notifier_block __read_mostly = {
532 .notifier_call = vlan_device_event,
536 * VLAN IOCTL handler.
537 * o execute requested action or pass command to the device driver
538 * arg is really a struct vlan_ioctl_args __user *.
540 static int vlan_ioctl_handler(struct net *net, void __user *arg)
543 struct vlan_ioctl_args args;
544 struct net_device *dev = NULL;
546 if (copy_from_user(&args, arg, sizeof(struct vlan_ioctl_args)))
549 /* Null terminate this sucker, just in case. */
550 args.device1[sizeof(args.device1) - 1] = 0;
551 args.u.device2[sizeof(args.u.device2) - 1] = 0;
556 case SET_VLAN_INGRESS_PRIORITY_CMD:
557 case SET_VLAN_EGRESS_PRIORITY_CMD:
558 case SET_VLAN_FLAG_CMD:
561 case GET_VLAN_REALDEV_NAME_CMD:
562 case GET_VLAN_VID_CMD:
564 dev = __dev_get_by_name(net, args.device1);
569 if (args.cmd != ADD_VLAN_CMD && !is_vlan_dev(dev))
574 case SET_VLAN_INGRESS_PRIORITY_CMD:
576 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
578 vlan_dev_set_ingress_priority(dev,
584 case SET_VLAN_EGRESS_PRIORITY_CMD:
586 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
588 err = vlan_dev_set_egress_priority(dev,
593 case SET_VLAN_FLAG_CMD:
595 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
597 err = vlan_dev_change_flags(dev,
598 args.vlan_qos ? args.u.flag : 0,
602 case SET_VLAN_NAME_TYPE_CMD:
604 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
606 if (args.u.name_type < VLAN_NAME_TYPE_HIGHEST) {
609 vn = net_generic(net, vlan_net_id);
610 vn->name_type = args.u.name_type;
619 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
621 err = register_vlan_device(dev, args.u.VID);
626 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
628 unregister_vlan_dev(dev, NULL);
632 case GET_VLAN_REALDEV_NAME_CMD:
634 vlan_dev_get_realdev_name(dev, args.u.device2,
635 sizeof(args.u.device2));
636 if (copy_to_user(arg, &args,
637 sizeof(struct vlan_ioctl_args)))
641 case GET_VLAN_VID_CMD:
643 args.u.VID = vlan_dev_vlan_id(dev);
644 if (copy_to_user(arg, &args,
645 sizeof(struct vlan_ioctl_args)))
658 static int __net_init vlan_init_net(struct net *net)
660 struct vlan_net *vn = net_generic(net, vlan_net_id);
663 vn->name_type = VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD;
665 err = vlan_proc_init(net);
670 static void __net_exit vlan_exit_net(struct net *net)
672 vlan_proc_cleanup(net);
675 static struct pernet_operations vlan_net_ops = {
676 .init = vlan_init_net,
677 .exit = vlan_exit_net,
679 .size = sizeof(struct vlan_net),
682 static int __init vlan_proto_init(void)
686 pr_info("%s v%s\n", vlan_fullname, vlan_version);
688 err = register_pernet_subsys(&vlan_net_ops);
692 err = register_netdevice_notifier(&vlan_notifier_block);
696 err = vlan_gvrp_init();
700 err = vlan_mvrp_init();
704 err = vlan_netlink_init();
708 vlan_ioctl_set(vlan_ioctl_handler);
716 unregister_netdevice_notifier(&vlan_notifier_block);
718 unregister_pernet_subsys(&vlan_net_ops);
723 static void __exit vlan_cleanup_module(void)
725 vlan_ioctl_set(NULL);
729 unregister_netdevice_notifier(&vlan_notifier_block);
731 unregister_pernet_subsys(&vlan_net_ops);
732 rcu_barrier(); /* Wait for completion of call_rcu()'s */
738 module_init(vlan_proto_init);
739 module_exit(vlan_cleanup_module);
741 MODULE_LICENSE("GPL");
742 MODULE_VERSION(DRV_VERSION);