3 * Ethernet-type device handling.
7 * VLAN Home Page: http://www.candelatech.com/~greear/vlan.html
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 <linux/uaccess.h>
39 #include <linux/if_vlan.h>
43 #define DRV_VERSION "1.8"
45 /* Global VLAN variables */
47 unsigned 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 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 vlan->nest_level = dev_get_nest_level(real_dev) + 1;
180 err = register_netdevice(dev);
182 goto out_uninit_mvrp;
184 err = netdev_upper_dev_link(real_dev, dev, extack);
186 goto out_unregister_netdev;
188 /* Account for reference in struct vlan_dev_priv */
191 vlan_stacked_transfer_operstate(real_dev, dev, vlan);
192 linkwatch_fire_event(dev); /* _MUST_ call rfc2863_policy() */
194 /* So, got the sucker initialized, now lets place
195 * it into our local structure.
197 vlan_group_set_device(grp, vlan->vlan_proto, vlan_id, dev);
202 out_unregister_netdev:
203 unregister_netdevice(dev);
205 if (grp->nr_vlan_devs == 0)
206 vlan_mvrp_uninit_applicant(real_dev);
208 if (grp->nr_vlan_devs == 0)
209 vlan_gvrp_uninit_applicant(real_dev);
211 vlan_vid_del(real_dev, vlan->vlan_proto, vlan_id);
215 /* Attach a VLAN device to a mac address (ie Ethernet Card).
216 * Returns 0 if the device was created or a negative error code otherwise.
218 static int register_vlan_device(struct net_device *real_dev, u16 vlan_id)
220 struct net_device *new_dev;
221 struct vlan_dev_priv *vlan;
222 struct net *net = dev_net(real_dev);
223 struct vlan_net *vn = net_generic(net, vlan_net_id);
227 if (vlan_id >= VLAN_VID_MASK)
230 err = vlan_check_real_dev(real_dev, htons(ETH_P_8021Q), vlan_id,
235 /* Gotta set up the fields for the device. */
236 switch (vn->name_type) {
237 case VLAN_NAME_TYPE_RAW_PLUS_VID:
238 /* name will look like: eth1.0005 */
239 snprintf(name, IFNAMSIZ, "%s.%.4i", real_dev->name, vlan_id);
241 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD:
242 /* Put our vlan.VID in the name.
243 * Name will look like: vlan5
245 snprintf(name, IFNAMSIZ, "vlan%i", vlan_id);
247 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD:
248 /* Put our vlan.VID in the name.
249 * Name will look like: eth0.5
251 snprintf(name, IFNAMSIZ, "%s.%i", real_dev->name, vlan_id);
253 case VLAN_NAME_TYPE_PLUS_VID:
254 /* Put our vlan.VID in the name.
255 * Name will look like: vlan0005
258 snprintf(name, IFNAMSIZ, "vlan%.4i", vlan_id);
261 new_dev = alloc_netdev(sizeof(struct vlan_dev_priv), name,
262 NET_NAME_UNKNOWN, vlan_setup);
267 dev_net_set(new_dev, net);
268 /* need 4 bytes for extra VLAN header info,
269 * hope the underlying device can handle it.
271 new_dev->mtu = real_dev->mtu;
273 vlan = vlan_dev_priv(new_dev);
274 vlan->vlan_proto = htons(ETH_P_8021Q);
275 vlan->vlan_id = vlan_id;
276 vlan->real_dev = real_dev;
278 vlan->flags = VLAN_FLAG_REORDER_HDR;
280 new_dev->rtnl_link_ops = &vlan_link_ops;
281 err = register_vlan_dev(new_dev, NULL);
283 goto out_free_newdev;
288 if (new_dev->reg_state == NETREG_UNINITIALIZED)
289 free_netdev(new_dev);
293 static void vlan_sync_address(struct net_device *dev,
294 struct net_device *vlandev)
296 struct vlan_dev_priv *vlan = vlan_dev_priv(vlandev);
298 /* May be called without an actual change */
299 if (ether_addr_equal(vlan->real_dev_addr, dev->dev_addr))
302 /* vlan continues to inherit address of lower device */
303 if (vlan_dev_inherit_address(vlandev, dev))
306 /* vlan address was different from the old address and is equal to
308 if (!ether_addr_equal(vlandev->dev_addr, vlan->real_dev_addr) &&
309 ether_addr_equal(vlandev->dev_addr, dev->dev_addr))
310 dev_uc_del(dev, vlandev->dev_addr);
312 /* vlan address was equal to the old address and is different from
314 if (ether_addr_equal(vlandev->dev_addr, vlan->real_dev_addr) &&
315 !ether_addr_equal(vlandev->dev_addr, dev->dev_addr))
316 dev_uc_add(dev, vlandev->dev_addr);
319 ether_addr_copy(vlan->real_dev_addr, dev->dev_addr);
322 static void vlan_transfer_features(struct net_device *dev,
323 struct net_device *vlandev)
325 struct vlan_dev_priv *vlan = vlan_dev_priv(vlandev);
327 vlandev->gso_max_size = dev->gso_max_size;
328 vlandev->gso_max_segs = dev->gso_max_segs;
330 if (vlan_hw_offload_capable(dev->features, vlan->vlan_proto))
331 vlandev->hard_header_len = dev->hard_header_len;
333 vlandev->hard_header_len = dev->hard_header_len + VLAN_HLEN;
335 #if IS_ENABLED(CONFIG_FCOE)
336 vlandev->fcoe_ddp_xid = dev->fcoe_ddp_xid;
339 vlandev->priv_flags &= ~IFF_XMIT_DST_RELEASE;
340 vlandev->priv_flags |= (vlan->real_dev->priv_flags & IFF_XMIT_DST_RELEASE);
341 vlandev->hw_enc_features = vlan_tnl_features(vlan->real_dev);
343 netdev_update_features(vlandev);
346 static int __vlan_device_event(struct net_device *dev, unsigned long event)
351 case NETDEV_CHANGENAME:
352 vlan_proc_rem_dev(dev);
353 err = vlan_proc_add_dev(dev);
355 case NETDEV_REGISTER:
356 err = vlan_proc_add_dev(dev);
358 case NETDEV_UNREGISTER:
359 vlan_proc_rem_dev(dev);
366 static int vlan_device_event(struct notifier_block *unused, unsigned long event,
369 struct netlink_ext_ack *extack = netdev_notifier_info_to_extack(ptr);
370 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
371 struct vlan_group *grp;
372 struct vlan_info *vlan_info;
374 struct net_device *vlandev;
375 struct vlan_dev_priv *vlan;
380 if (is_vlan_dev(dev)) {
381 int err = __vlan_device_event(dev, event);
384 return notifier_from_errno(err);
387 if ((event == NETDEV_UP) &&
388 (dev->features & NETIF_F_HW_VLAN_CTAG_FILTER)) {
389 pr_info("adding VLAN 0 to HW filter on device %s\n",
391 vlan_vid_add(dev, htons(ETH_P_8021Q), 0);
393 if (event == NETDEV_DOWN &&
394 (dev->features & NETIF_F_HW_VLAN_CTAG_FILTER))
395 vlan_vid_del(dev, htons(ETH_P_8021Q), 0);
397 vlan_info = rtnl_dereference(dev->vlan_info);
400 grp = &vlan_info->grp;
402 /* It is OK that we do not hold the group lock right now,
403 * as we run under the RTNL lock.
408 /* Propagate real device state to vlan devices */
409 vlan_group_for_each_dev(grp, i, vlandev)
410 vlan_stacked_transfer_operstate(dev, vlandev,
411 vlan_dev_priv(vlandev));
414 case NETDEV_CHANGEADDR:
415 /* Adjust unicast filters on underlying device */
416 vlan_group_for_each_dev(grp, i, vlandev) {
417 flgs = vlandev->flags;
418 if (!(flgs & IFF_UP))
421 vlan_sync_address(dev, vlandev);
425 case NETDEV_CHANGEMTU:
426 vlan_group_for_each_dev(grp, i, vlandev) {
427 if (vlandev->mtu <= dev->mtu)
430 dev_set_mtu(vlandev, dev->mtu);
434 case NETDEV_FEAT_CHANGE:
435 /* Propagate device features to underlying device */
436 vlan_group_for_each_dev(grp, i, vlandev)
437 vlan_transfer_features(dev, vlandev);
441 struct net_device *tmp;
442 LIST_HEAD(close_list);
444 /* Put all VLANs for this dev in the down state too. */
445 vlan_group_for_each_dev(grp, i, vlandev) {
446 flgs = vlandev->flags;
447 if (!(flgs & IFF_UP))
450 vlan = vlan_dev_priv(vlandev);
451 if (!(vlan->flags & VLAN_FLAG_LOOSE_BINDING))
452 list_add(&vlandev->close_list, &close_list);
455 dev_close_many(&close_list, false);
457 list_for_each_entry_safe(vlandev, tmp, &close_list, close_list) {
458 vlan_stacked_transfer_operstate(dev, vlandev,
459 vlan_dev_priv(vlandev));
460 list_del_init(&vlandev->close_list);
462 list_del(&close_list);
466 /* Put all VLANs for this dev in the up state too. */
467 vlan_group_for_each_dev(grp, i, vlandev) {
468 flgs = dev_get_flags(vlandev);
472 vlan = vlan_dev_priv(vlandev);
473 if (!(vlan->flags & VLAN_FLAG_LOOSE_BINDING))
474 dev_change_flags(vlandev, flgs | IFF_UP,
476 vlan_stacked_transfer_operstate(dev, vlandev, vlan);
480 case NETDEV_UNREGISTER:
481 /* twiddle thumbs on netns device moves */
482 if (dev->reg_state != NETREG_UNREGISTERING)
485 vlan_group_for_each_dev(grp, i, vlandev) {
486 /* removal of last vid destroys vlan_info, abort
488 if (vlan_info->nr_vids == 1)
491 unregister_vlan_dev(vlandev, &list);
495 unregister_netdevice_many(&list);
498 case NETDEV_PRE_TYPE_CHANGE:
499 /* Forbid underlaying device to change its type. */
500 if (vlan_uses_dev(dev))
504 case NETDEV_NOTIFY_PEERS:
505 case NETDEV_BONDING_FAILOVER:
506 case NETDEV_RESEND_IGMP:
507 /* Propagate to vlan devices */
508 vlan_group_for_each_dev(grp, i, vlandev)
509 call_netdevice_notifiers(event, vlandev);
512 case NETDEV_CVLAN_FILTER_PUSH_INFO:
513 err = vlan_filter_push_vids(vlan_info, htons(ETH_P_8021Q));
515 return notifier_from_errno(err);
518 case NETDEV_CVLAN_FILTER_DROP_INFO:
519 vlan_filter_drop_vids(vlan_info, htons(ETH_P_8021Q));
522 case NETDEV_SVLAN_FILTER_PUSH_INFO:
523 err = vlan_filter_push_vids(vlan_info, htons(ETH_P_8021AD));
525 return notifier_from_errno(err);
528 case NETDEV_SVLAN_FILTER_DROP_INFO:
529 vlan_filter_drop_vids(vlan_info, htons(ETH_P_8021AD));
537 static struct notifier_block vlan_notifier_block __read_mostly = {
538 .notifier_call = vlan_device_event,
542 * VLAN IOCTL handler.
543 * o execute requested action or pass command to the device driver
544 * arg is really a struct vlan_ioctl_args __user *.
546 static int vlan_ioctl_handler(struct net *net, void __user *arg)
549 struct vlan_ioctl_args args;
550 struct net_device *dev = NULL;
552 if (copy_from_user(&args, arg, sizeof(struct vlan_ioctl_args)))
555 /* Null terminate this sucker, just in case. */
556 args.device1[sizeof(args.device1) - 1] = 0;
557 args.u.device2[sizeof(args.u.device2) - 1] = 0;
562 case SET_VLAN_INGRESS_PRIORITY_CMD:
563 case SET_VLAN_EGRESS_PRIORITY_CMD:
564 case SET_VLAN_FLAG_CMD:
567 case GET_VLAN_REALDEV_NAME_CMD:
568 case GET_VLAN_VID_CMD:
570 dev = __dev_get_by_name(net, args.device1);
575 if (args.cmd != ADD_VLAN_CMD && !is_vlan_dev(dev))
580 case SET_VLAN_INGRESS_PRIORITY_CMD:
582 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
584 vlan_dev_set_ingress_priority(dev,
590 case SET_VLAN_EGRESS_PRIORITY_CMD:
592 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
594 err = vlan_dev_set_egress_priority(dev,
599 case SET_VLAN_FLAG_CMD:
601 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
603 err = vlan_dev_change_flags(dev,
604 args.vlan_qos ? args.u.flag : 0,
608 case SET_VLAN_NAME_TYPE_CMD:
610 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
612 if (args.u.name_type < VLAN_NAME_TYPE_HIGHEST) {
615 vn = net_generic(net, vlan_net_id);
616 vn->name_type = args.u.name_type;
625 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
627 err = register_vlan_device(dev, args.u.VID);
632 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
634 unregister_vlan_dev(dev, NULL);
638 case GET_VLAN_REALDEV_NAME_CMD:
640 vlan_dev_get_realdev_name(dev, args.u.device2);
641 if (copy_to_user(arg, &args,
642 sizeof(struct vlan_ioctl_args)))
646 case GET_VLAN_VID_CMD:
648 args.u.VID = vlan_dev_vlan_id(dev);
649 if (copy_to_user(arg, &args,
650 sizeof(struct vlan_ioctl_args)))
663 static int __net_init vlan_init_net(struct net *net)
665 struct vlan_net *vn = net_generic(net, vlan_net_id);
668 vn->name_type = VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD;
670 err = vlan_proc_init(net);
675 static void __net_exit vlan_exit_net(struct net *net)
677 vlan_proc_cleanup(net);
680 static struct pernet_operations vlan_net_ops = {
681 .init = vlan_init_net,
682 .exit = vlan_exit_net,
684 .size = sizeof(struct vlan_net),
687 static int __init vlan_proto_init(void)
691 pr_info("%s v%s\n", vlan_fullname, vlan_version);
693 err = register_pernet_subsys(&vlan_net_ops);
697 err = register_netdevice_notifier(&vlan_notifier_block);
701 err = vlan_gvrp_init();
705 err = vlan_mvrp_init();
709 err = vlan_netlink_init();
713 vlan_ioctl_set(vlan_ioctl_handler);
721 unregister_netdevice_notifier(&vlan_notifier_block);
723 unregister_pernet_subsys(&vlan_net_ops);
728 static void __exit vlan_cleanup_module(void)
730 vlan_ioctl_set(NULL);
734 unregister_netdevice_notifier(&vlan_notifier_block);
736 unregister_pernet_subsys(&vlan_net_ops);
737 rcu_barrier(); /* Wait for completion of call_rcu()'s */
743 module_init(vlan_proto_init);
744 module_exit(vlan_cleanup_module);
746 MODULE_LICENSE("GPL");
747 MODULE_VERSION(DRV_VERSION);