3 * Ethernet-type device handling.
5 * Authors: Ben Greear <greearb@candelatech.com>
6 * Please send support related email to: netdev@vger.kernel.org
7 * VLAN Home Page: http://www.candelatech.com/~greear/vlan.html
10 * Fix for packet capture - Nick Eggleston <nick@dccinc.com>;
11 * Add HW acceleration hooks - David S. Miller <davem@redhat.com>;
12 * Correct all the locking - David S. Miller <davem@redhat.com>;
13 * Use hash table for VLAN groups - David S. Miller <davem@redhat.com>
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 <asm/uaccess.h>
39 #include <linux/if_vlan.h>
43 #define DRV_VERSION "1.8"
45 /* Global VLAN variables */
47 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 void unregister_vlan_dev(struct net_device *dev, struct list_head *head)
80 struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
81 struct net_device *real_dev = vlan->real_dev;
82 struct vlan_info *vlan_info;
83 struct vlan_group *grp;
84 u16 vlan_id = vlan->vlan_id;
88 vlan_info = rtnl_dereference(real_dev->vlan_info);
91 grp = &vlan_info->grp;
95 if (vlan->flags & VLAN_FLAG_MVRP)
96 vlan_mvrp_request_leave(dev);
97 if (vlan->flags & VLAN_FLAG_GVRP)
98 vlan_gvrp_request_leave(dev);
100 vlan_group_set_device(grp, vlan->vlan_proto, vlan_id, NULL);
101 /* Because unregister_netdevice_queue() makes sure at least one rcu
102 * grace period is respected before device freeing,
103 * we dont need to call synchronize_net() here.
105 unregister_netdevice_queue(dev, head);
107 netdev_upper_dev_unlink(real_dev, dev);
109 if (grp->nr_vlan_devs == 0) {
110 vlan_mvrp_uninit_applicant(real_dev);
111 vlan_gvrp_uninit_applicant(real_dev);
114 /* Take it out of our own structures, but be sure to interlock with
115 * HW accelerating devices or SW vlan input packet processing if
116 * VLAN is not 0 (leave it there for 802.1p).
119 vlan_vid_del(real_dev, vlan->vlan_proto, vlan_id);
121 /* Get rid of the vlan's reference to real_dev */
125 int vlan_check_real_dev(struct net_device *real_dev,
126 __be16 protocol, u16 vlan_id)
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);
135 if (vlan_find_dev(real_dev, protocol, vlan_id) != NULL)
141 int register_vlan_dev(struct net_device *dev)
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 = netdev_upper_dev_link(real_dev, dev);
174 goto out_uninit_mvrp;
176 err = register_netdevice(dev);
178 goto out_upper_dev_unlink;
180 /* Account for reference in struct vlan_dev_priv */
183 netif_stacked_transfer_operstate(real_dev, dev);
184 linkwatch_fire_event(dev); /* _MUST_ call rfc2863_policy() */
186 /* So, got the sucker initialized, now lets place
187 * it into our local structure.
189 vlan_group_set_device(grp, vlan->vlan_proto, vlan_id, dev);
194 out_upper_dev_unlink:
195 netdev_upper_dev_unlink(real_dev, dev);
197 if (grp->nr_vlan_devs == 0)
198 vlan_mvrp_uninit_applicant(real_dev);
200 if (grp->nr_vlan_devs == 0)
201 vlan_gvrp_uninit_applicant(real_dev);
203 vlan_vid_del(real_dev, vlan->vlan_proto, vlan_id);
207 /* Attach a VLAN device to a mac address (ie Ethernet Card).
208 * Returns 0 if the device was created or a negative error code otherwise.
210 static int register_vlan_device(struct net_device *real_dev, u16 vlan_id)
212 struct net_device *new_dev;
213 struct net *net = dev_net(real_dev);
214 struct vlan_net *vn = net_generic(net, vlan_net_id);
218 if (vlan_id >= VLAN_VID_MASK)
221 err = vlan_check_real_dev(real_dev, htons(ETH_P_8021Q), vlan_id);
225 /* Gotta set up the fields for the device. */
226 switch (vn->name_type) {
227 case VLAN_NAME_TYPE_RAW_PLUS_VID:
228 /* name will look like: eth1.0005 */
229 snprintf(name, IFNAMSIZ, "%s.%.4i", real_dev->name, vlan_id);
231 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD:
232 /* Put our vlan.VID in the name.
233 * Name will look like: vlan5
235 snprintf(name, IFNAMSIZ, "vlan%i", vlan_id);
237 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD:
238 /* Put our vlan.VID in the name.
239 * Name will look like: eth0.5
241 snprintf(name, IFNAMSIZ, "%s.%i", real_dev->name, vlan_id);
243 case VLAN_NAME_TYPE_PLUS_VID:
244 /* Put our vlan.VID in the name.
245 * Name will look like: vlan0005
248 snprintf(name, IFNAMSIZ, "vlan%.4i", vlan_id);
251 new_dev = alloc_netdev(sizeof(struct vlan_dev_priv), name, 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;
261 new_dev->priv_flags |= (real_dev->priv_flags & IFF_UNICAST_FLT);
263 vlan_dev_priv(new_dev)->vlan_proto = htons(ETH_P_8021Q);
264 vlan_dev_priv(new_dev)->vlan_id = vlan_id;
265 vlan_dev_priv(new_dev)->real_dev = real_dev;
266 vlan_dev_priv(new_dev)->dent = NULL;
267 vlan_dev_priv(new_dev)->flags = VLAN_FLAG_REORDER_HDR;
269 new_dev->rtnl_link_ops = &vlan_link_ops;
270 err = register_vlan_dev(new_dev);
272 goto out_free_newdev;
277 free_netdev(new_dev);
281 static void vlan_sync_address(struct net_device *dev,
282 struct net_device *vlandev)
284 struct vlan_dev_priv *vlan = vlan_dev_priv(vlandev);
286 /* May be called without an actual change */
287 if (ether_addr_equal(vlan->real_dev_addr, dev->dev_addr))
290 /* vlan address was different from the old address and is equal to
292 if (!ether_addr_equal(vlandev->dev_addr, vlan->real_dev_addr) &&
293 ether_addr_equal(vlandev->dev_addr, dev->dev_addr))
294 dev_uc_del(dev, vlandev->dev_addr);
296 /* vlan address was equal to the old address and is different from
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_add(dev, vlandev->dev_addr);
302 memcpy(vlan->real_dev_addr, dev->dev_addr, ETH_ALEN);
305 static void vlan_transfer_features(struct net_device *dev,
306 struct net_device *vlandev)
308 vlandev->gso_max_size = dev->gso_max_size;
310 if (dev->features & NETIF_F_HW_VLAN_CTAG_TX)
311 vlandev->hard_header_len = dev->hard_header_len;
313 vlandev->hard_header_len = dev->hard_header_len + VLAN_HLEN;
315 #if IS_ENABLED(CONFIG_FCOE)
316 vlandev->fcoe_ddp_xid = dev->fcoe_ddp_xid;
319 netdev_update_features(vlandev);
322 static void __vlan_device_event(struct net_device *dev, unsigned long event)
325 case NETDEV_CHANGENAME:
326 vlan_proc_rem_dev(dev);
327 if (vlan_proc_add_dev(dev) < 0)
328 pr_warn("failed to change proc name for %s\n",
331 case NETDEV_REGISTER:
332 if (vlan_proc_add_dev(dev) < 0)
333 pr_warn("failed to add proc entry for %s\n", dev->name);
335 case NETDEV_UNREGISTER:
336 vlan_proc_rem_dev(dev);
341 static int vlan_device_event(struct notifier_block *unused, unsigned long event,
344 struct net_device *dev = ptr;
345 struct vlan_group *grp;
346 struct vlan_info *vlan_info;
348 struct net_device *vlandev;
349 struct vlan_dev_priv *vlan;
353 if (is_vlan_dev(dev))
354 __vlan_device_event(dev, event);
356 if ((event == NETDEV_UP) &&
357 (dev->features & NETIF_F_HW_VLAN_CTAG_FILTER)) {
358 pr_info("adding VLAN 0 to HW filter on device %s\n",
360 vlan_vid_add(dev, htons(ETH_P_8021Q), 0);
363 vlan_info = rtnl_dereference(dev->vlan_info);
366 grp = &vlan_info->grp;
368 /* It is OK that we do not hold the group lock right now,
369 * as we run under the RTNL lock.
374 /* Propagate real device state to vlan devices */
375 vlan_group_for_each_dev(grp, i, vlandev)
376 netif_stacked_transfer_operstate(dev, vlandev);
379 case NETDEV_CHANGEADDR:
380 /* Adjust unicast filters on underlying device */
381 vlan_group_for_each_dev(grp, i, vlandev) {
382 flgs = vlandev->flags;
383 if (!(flgs & IFF_UP))
386 vlan_sync_address(dev, vlandev);
390 case NETDEV_CHANGEMTU:
391 vlan_group_for_each_dev(grp, i, vlandev) {
392 if (vlandev->mtu <= dev->mtu)
395 dev_set_mtu(vlandev, dev->mtu);
399 case NETDEV_FEAT_CHANGE:
400 /* Propagate device features to underlying device */
401 vlan_group_for_each_dev(grp, i, vlandev)
402 vlan_transfer_features(dev, vlandev);
406 if (dev->features & NETIF_F_HW_VLAN_CTAG_FILTER)
407 vlan_vid_del(dev, htons(ETH_P_8021Q), 0);
409 /* Put all VLANs for this dev in the down state too. */
410 vlan_group_for_each_dev(grp, i, vlandev) {
411 flgs = vlandev->flags;
412 if (!(flgs & IFF_UP))
415 vlan = vlan_dev_priv(vlandev);
416 if (!(vlan->flags & VLAN_FLAG_LOOSE_BINDING))
417 dev_change_flags(vlandev, flgs & ~IFF_UP);
418 netif_stacked_transfer_operstate(dev, vlandev);
423 /* Put all VLANs for this dev in the up state too. */
424 vlan_group_for_each_dev(grp, i, vlandev) {
425 flgs = vlandev->flags;
429 vlan = vlan_dev_priv(vlandev);
430 if (!(vlan->flags & VLAN_FLAG_LOOSE_BINDING))
431 dev_change_flags(vlandev, flgs | IFF_UP);
432 netif_stacked_transfer_operstate(dev, vlandev);
436 case NETDEV_UNREGISTER:
437 /* twiddle thumbs on netns device moves */
438 if (dev->reg_state != NETREG_UNREGISTERING)
441 vlan_group_for_each_dev(grp, i, vlandev) {
442 /* removal of last vid destroys vlan_info, abort
444 if (vlan_info->nr_vids == 1)
447 unregister_vlan_dev(vlandev, &list);
451 unregister_netdevice_many(&list);
454 case NETDEV_PRE_TYPE_CHANGE:
455 /* Forbid underlaying device to change its type. */
456 if (vlan_uses_dev(dev))
460 case NETDEV_NOTIFY_PEERS:
461 case NETDEV_BONDING_FAILOVER:
462 /* Propagate to vlan devices */
463 vlan_group_for_each_dev(grp, i, vlandev)
464 call_netdevice_notifiers(event, vlandev);
472 static struct notifier_block vlan_notifier_block __read_mostly = {
473 .notifier_call = vlan_device_event,
477 * VLAN IOCTL handler.
478 * o execute requested action or pass command to the device driver
479 * arg is really a struct vlan_ioctl_args __user *.
481 static int vlan_ioctl_handler(struct net *net, void __user *arg)
484 struct vlan_ioctl_args args;
485 struct net_device *dev = NULL;
487 if (copy_from_user(&args, arg, sizeof(struct vlan_ioctl_args)))
490 /* Null terminate this sucker, just in case. */
491 args.device1[23] = 0;
492 args.u.device2[23] = 0;
497 case SET_VLAN_INGRESS_PRIORITY_CMD:
498 case SET_VLAN_EGRESS_PRIORITY_CMD:
499 case SET_VLAN_FLAG_CMD:
502 case GET_VLAN_REALDEV_NAME_CMD:
503 case GET_VLAN_VID_CMD:
505 dev = __dev_get_by_name(net, args.device1);
510 if (args.cmd != ADD_VLAN_CMD && !is_vlan_dev(dev))
515 case SET_VLAN_INGRESS_PRIORITY_CMD:
517 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
519 vlan_dev_set_ingress_priority(dev,
525 case SET_VLAN_EGRESS_PRIORITY_CMD:
527 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
529 err = vlan_dev_set_egress_priority(dev,
534 case SET_VLAN_FLAG_CMD:
536 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
538 err = vlan_dev_change_flags(dev,
539 args.vlan_qos ? args.u.flag : 0,
543 case SET_VLAN_NAME_TYPE_CMD:
545 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
547 if ((args.u.name_type >= 0) &&
548 (args.u.name_type < VLAN_NAME_TYPE_HIGHEST)) {
551 vn = net_generic(net, vlan_net_id);
552 vn->name_type = args.u.name_type;
561 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
563 err = register_vlan_device(dev, args.u.VID);
568 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
570 unregister_vlan_dev(dev, NULL);
574 case GET_VLAN_REALDEV_NAME_CMD:
576 vlan_dev_get_realdev_name(dev, args.u.device2);
577 if (copy_to_user(arg, &args,
578 sizeof(struct vlan_ioctl_args)))
582 case GET_VLAN_VID_CMD:
584 args.u.VID = vlan_dev_vlan_id(dev);
585 if (copy_to_user(arg, &args,
586 sizeof(struct vlan_ioctl_args)))
599 static int __net_init vlan_init_net(struct net *net)
601 struct vlan_net *vn = net_generic(net, vlan_net_id);
604 vn->name_type = VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD;
606 err = vlan_proc_init(net);
611 static void __net_exit vlan_exit_net(struct net *net)
613 vlan_proc_cleanup(net);
616 static struct pernet_operations vlan_net_ops = {
617 .init = vlan_init_net,
618 .exit = vlan_exit_net,
620 .size = sizeof(struct vlan_net),
623 static int __init vlan_proto_init(void)
627 pr_info("%s v%s\n", vlan_fullname, vlan_version);
629 err = register_pernet_subsys(&vlan_net_ops);
633 err = register_netdevice_notifier(&vlan_notifier_block);
637 err = vlan_gvrp_init();
641 err = vlan_mvrp_init();
645 err = vlan_netlink_init();
649 vlan_ioctl_set(vlan_ioctl_handler);
657 unregister_netdevice_notifier(&vlan_notifier_block);
659 unregister_pernet_subsys(&vlan_net_ops);
664 static void __exit vlan_cleanup_module(void)
666 vlan_ioctl_set(NULL);
669 unregister_netdevice_notifier(&vlan_notifier_block);
671 unregister_pernet_subsys(&vlan_net_ops);
672 rcu_barrier(); /* Wait for completion of call_rcu()'s */
678 module_init(vlan_proto_init);
679 module_exit(vlan_cleanup_module);
681 MODULE_LICENSE("GPL");
682 MODULE_VERSION(DRV_VERSION);