Linux 5.1.15
[linux/fpc-iii.git] / net / 8021q / vlan.c
blobdc4411165e437a2f6e962d7466612eec9706631d
1 /*
2 * INET 802.1Q VLAN
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
9 * Fixes:
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>
31 #include <net/arp.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>
40 #include "vlan.h"
41 #include "vlanproc.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;
59 unsigned int size;
61 ASSERT_RTNL();
63 pidx = vlan_proto_idx(vlan_proto);
64 vidx = vlan_id / VLAN_GROUP_ARRAY_PART_LEN;
65 array = vg->vlan_devices_arrays[pidx][vidx];
66 if (array != NULL)
67 return 0;
69 size = sizeof(struct net_device *) * VLAN_GROUP_ARRAY_PART_LEN;
70 array = kzalloc(size, GFP_KERNEL);
71 if (array == NULL)
72 return -ENOBUFS;
74 vg->vlan_devices_arrays[pidx][vidx] = array;
75 return 0;
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;
86 ASSERT_RTNL();
88 vlan_info = rtnl_dereference(real_dev->vlan_info);
89 BUG_ON(!vlan_info);
91 grp = &vlan_info->grp;
93 grp->nr_vlan_devs--;
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);
102 netdev_upper_dev_unlink(real_dev, dev);
103 /* Because unregister_netdevice_queue() makes sure at least one rcu
104 * grace period is respected before device freeing,
105 * we dont need to call synchronize_net() here.
107 unregister_netdevice_queue(dev, head);
109 if (grp->nr_vlan_devs == 0) {
110 vlan_mvrp_uninit_applicant(real_dev);
111 vlan_gvrp_uninit_applicant(real_dev);
114 vlan_vid_del(real_dev, vlan->vlan_proto, vlan_id);
116 /* Get rid of the vlan's reference to real_dev */
117 dev_put(real_dev);
120 int vlan_check_real_dev(struct net_device *real_dev,
121 __be16 protocol, u16 vlan_id,
122 struct netlink_ext_ack *extack)
124 const char *name = real_dev->name;
126 if (real_dev->features & NETIF_F_VLAN_CHALLENGED) {
127 pr_info("VLANs not supported on %s\n", name);
128 NL_SET_ERR_MSG_MOD(extack, "VLANs not supported on device");
129 return -EOPNOTSUPP;
132 if (vlan_find_dev(real_dev, protocol, vlan_id) != NULL) {
133 NL_SET_ERR_MSG_MOD(extack, "VLAN device already exists");
134 return -EEXIST;
137 return 0;
140 int register_vlan_dev(struct net_device *dev, struct netlink_ext_ack *extack)
142 struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
143 struct net_device *real_dev = vlan->real_dev;
144 u16 vlan_id = vlan->vlan_id;
145 struct vlan_info *vlan_info;
146 struct vlan_group *grp;
147 int err;
149 err = vlan_vid_add(real_dev, vlan->vlan_proto, vlan_id);
150 if (err)
151 return err;
153 vlan_info = rtnl_dereference(real_dev->vlan_info);
154 /* vlan_info should be there now. vlan_vid_add took care of it */
155 BUG_ON(!vlan_info);
157 grp = &vlan_info->grp;
158 if (grp->nr_vlan_devs == 0) {
159 err = vlan_gvrp_init_applicant(real_dev);
160 if (err < 0)
161 goto out_vid_del;
162 err = vlan_mvrp_init_applicant(real_dev);
163 if (err < 0)
164 goto out_uninit_gvrp;
167 err = vlan_group_prealloc_vid(grp, vlan->vlan_proto, vlan_id);
168 if (err < 0)
169 goto out_uninit_mvrp;
171 vlan->nest_level = dev_get_nest_level(real_dev) + 1;
172 err = register_netdevice(dev);
173 if (err < 0)
174 goto out_uninit_mvrp;
176 err = netdev_upper_dev_link(real_dev, dev, extack);
177 if (err)
178 goto out_unregister_netdev;
180 /* Account for reference in struct vlan_dev_priv */
181 dev_hold(real_dev);
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);
190 grp->nr_vlan_devs++;
192 return 0;
194 out_unregister_netdev:
195 unregister_netdevice(dev);
196 out_uninit_mvrp:
197 if (grp->nr_vlan_devs == 0)
198 vlan_mvrp_uninit_applicant(real_dev);
199 out_uninit_gvrp:
200 if (grp->nr_vlan_devs == 0)
201 vlan_gvrp_uninit_applicant(real_dev);
202 out_vid_del:
203 vlan_vid_del(real_dev, vlan->vlan_proto, vlan_id);
204 return err;
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 vlan_dev_priv *vlan;
214 struct net *net = dev_net(real_dev);
215 struct vlan_net *vn = net_generic(net, vlan_net_id);
216 char name[IFNAMSIZ];
217 int err;
219 if (vlan_id >= VLAN_VID_MASK)
220 return -ERANGE;
222 err = vlan_check_real_dev(real_dev, htons(ETH_P_8021Q), vlan_id,
223 NULL);
224 if (err < 0)
225 return err;
227 /* Gotta set up the fields for the device. */
228 switch (vn->name_type) {
229 case VLAN_NAME_TYPE_RAW_PLUS_VID:
230 /* name will look like: eth1.0005 */
231 snprintf(name, IFNAMSIZ, "%s.%.4i", real_dev->name, vlan_id);
232 break;
233 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD:
234 /* Put our vlan.VID in the name.
235 * Name will look like: vlan5
237 snprintf(name, IFNAMSIZ, "vlan%i", vlan_id);
238 break;
239 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD:
240 /* Put our vlan.VID in the name.
241 * Name will look like: eth0.5
243 snprintf(name, IFNAMSIZ, "%s.%i", real_dev->name, vlan_id);
244 break;
245 case VLAN_NAME_TYPE_PLUS_VID:
246 /* Put our vlan.VID in the name.
247 * Name will look like: vlan0005
249 default:
250 snprintf(name, IFNAMSIZ, "vlan%.4i", vlan_id);
253 new_dev = alloc_netdev(sizeof(struct vlan_dev_priv), name,
254 NET_NAME_UNKNOWN, vlan_setup);
256 if (new_dev == NULL)
257 return -ENOBUFS;
259 dev_net_set(new_dev, net);
260 /* need 4 bytes for extra VLAN header info,
261 * hope the underlying device can handle it.
263 new_dev->mtu = real_dev->mtu;
265 vlan = vlan_dev_priv(new_dev);
266 vlan->vlan_proto = htons(ETH_P_8021Q);
267 vlan->vlan_id = vlan_id;
268 vlan->real_dev = real_dev;
269 vlan->dent = NULL;
270 vlan->flags = VLAN_FLAG_REORDER_HDR;
272 new_dev->rtnl_link_ops = &vlan_link_ops;
273 err = register_vlan_dev(new_dev, NULL);
274 if (err < 0)
275 goto out_free_newdev;
277 return 0;
279 out_free_newdev:
280 if (new_dev->reg_state == NETREG_UNINITIALIZED)
281 free_netdev(new_dev);
282 return err;
285 static void vlan_sync_address(struct net_device *dev,
286 struct net_device *vlandev)
288 struct vlan_dev_priv *vlan = vlan_dev_priv(vlandev);
290 /* May be called without an actual change */
291 if (ether_addr_equal(vlan->real_dev_addr, dev->dev_addr))
292 return;
294 /* vlan continues to inherit address of lower device */
295 if (vlan_dev_inherit_address(vlandev, dev))
296 goto out;
298 /* vlan address was different from the old address and is equal to
299 * the new address */
300 if (!ether_addr_equal(vlandev->dev_addr, vlan->real_dev_addr) &&
301 ether_addr_equal(vlandev->dev_addr, dev->dev_addr))
302 dev_uc_del(dev, vlandev->dev_addr);
304 /* vlan address was equal to the old address and is different from
305 * the new address */
306 if (ether_addr_equal(vlandev->dev_addr, vlan->real_dev_addr) &&
307 !ether_addr_equal(vlandev->dev_addr, dev->dev_addr))
308 dev_uc_add(dev, vlandev->dev_addr);
310 out:
311 ether_addr_copy(vlan->real_dev_addr, dev->dev_addr);
314 static void vlan_transfer_features(struct net_device *dev,
315 struct net_device *vlandev)
317 struct vlan_dev_priv *vlan = vlan_dev_priv(vlandev);
319 vlandev->gso_max_size = dev->gso_max_size;
320 vlandev->gso_max_segs = dev->gso_max_segs;
322 if (vlan_hw_offload_capable(dev->features, vlan->vlan_proto))
323 vlandev->hard_header_len = dev->hard_header_len;
324 else
325 vlandev->hard_header_len = dev->hard_header_len + VLAN_HLEN;
327 #if IS_ENABLED(CONFIG_FCOE)
328 vlandev->fcoe_ddp_xid = dev->fcoe_ddp_xid;
329 #endif
331 vlandev->priv_flags &= ~IFF_XMIT_DST_RELEASE;
332 vlandev->priv_flags |= (vlan->real_dev->priv_flags & IFF_XMIT_DST_RELEASE);
333 vlandev->hw_enc_features = vlan_tnl_features(vlan->real_dev);
335 netdev_update_features(vlandev);
338 static int __vlan_device_event(struct net_device *dev, unsigned long event)
340 int err = 0;
342 switch (event) {
343 case NETDEV_CHANGENAME:
344 vlan_proc_rem_dev(dev);
345 err = vlan_proc_add_dev(dev);
346 break;
347 case NETDEV_REGISTER:
348 err = vlan_proc_add_dev(dev);
349 break;
350 case NETDEV_UNREGISTER:
351 vlan_proc_rem_dev(dev);
352 break;
355 return err;
358 static int vlan_device_event(struct notifier_block *unused, unsigned long event,
359 void *ptr)
361 struct netlink_ext_ack *extack = netdev_notifier_info_to_extack(ptr);
362 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
363 struct vlan_group *grp;
364 struct vlan_info *vlan_info;
365 int i, flgs;
366 struct net_device *vlandev;
367 struct vlan_dev_priv *vlan;
368 bool last = false;
369 LIST_HEAD(list);
370 int err;
372 if (is_vlan_dev(dev)) {
373 int err = __vlan_device_event(dev, event);
375 if (err)
376 return notifier_from_errno(err);
379 if ((event == NETDEV_UP) &&
380 (dev->features & NETIF_F_HW_VLAN_CTAG_FILTER)) {
381 pr_info("adding VLAN 0 to HW filter on device %s\n",
382 dev->name);
383 vlan_vid_add(dev, htons(ETH_P_8021Q), 0);
385 if (event == NETDEV_DOWN &&
386 (dev->features & NETIF_F_HW_VLAN_CTAG_FILTER))
387 vlan_vid_del(dev, htons(ETH_P_8021Q), 0);
389 vlan_info = rtnl_dereference(dev->vlan_info);
390 if (!vlan_info)
391 goto out;
392 grp = &vlan_info->grp;
394 /* It is OK that we do not hold the group lock right now,
395 * as we run under the RTNL lock.
398 switch (event) {
399 case NETDEV_CHANGE:
400 /* Propagate real device state to vlan devices */
401 vlan_group_for_each_dev(grp, i, vlandev)
402 netif_stacked_transfer_operstate(dev, vlandev);
403 break;
405 case NETDEV_CHANGEADDR:
406 /* Adjust unicast filters on underlying device */
407 vlan_group_for_each_dev(grp, i, vlandev) {
408 flgs = vlandev->flags;
409 if (!(flgs & IFF_UP))
410 continue;
412 vlan_sync_address(dev, vlandev);
414 break;
416 case NETDEV_CHANGEMTU:
417 vlan_group_for_each_dev(grp, i, vlandev) {
418 if (vlandev->mtu <= dev->mtu)
419 continue;
421 dev_set_mtu(vlandev, dev->mtu);
423 break;
425 case NETDEV_FEAT_CHANGE:
426 /* Propagate device features to underlying device */
427 vlan_group_for_each_dev(grp, i, vlandev)
428 vlan_transfer_features(dev, vlandev);
429 break;
431 case NETDEV_DOWN: {
432 struct net_device *tmp;
433 LIST_HEAD(close_list);
435 /* Put all VLANs for this dev in the down state too. */
436 vlan_group_for_each_dev(grp, i, vlandev) {
437 flgs = vlandev->flags;
438 if (!(flgs & IFF_UP))
439 continue;
441 vlan = vlan_dev_priv(vlandev);
442 if (!(vlan->flags & VLAN_FLAG_LOOSE_BINDING))
443 list_add(&vlandev->close_list, &close_list);
446 dev_close_many(&close_list, false);
448 list_for_each_entry_safe(vlandev, tmp, &close_list, close_list) {
449 netif_stacked_transfer_operstate(dev, vlandev);
450 list_del_init(&vlandev->close_list);
452 list_del(&close_list);
453 break;
455 case NETDEV_UP:
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);
459 if (flgs & IFF_UP)
460 continue;
462 vlan = vlan_dev_priv(vlandev);
463 if (!(vlan->flags & VLAN_FLAG_LOOSE_BINDING))
464 dev_change_flags(vlandev, flgs | IFF_UP,
465 extack);
466 netif_stacked_transfer_operstate(dev, vlandev);
468 break;
470 case NETDEV_UNREGISTER:
471 /* twiddle thumbs on netns device moves */
472 if (dev->reg_state != NETREG_UNREGISTERING)
473 break;
475 vlan_group_for_each_dev(grp, i, vlandev) {
476 /* removal of last vid destroys vlan_info, abort
477 * afterwards */
478 if (vlan_info->nr_vids == 1)
479 last = true;
481 unregister_vlan_dev(vlandev, &list);
482 if (last)
483 break;
485 unregister_netdevice_many(&list);
486 break;
488 case NETDEV_PRE_TYPE_CHANGE:
489 /* Forbid underlaying device to change its type. */
490 if (vlan_uses_dev(dev))
491 return NOTIFY_BAD;
492 break;
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);
500 break;
502 case NETDEV_CVLAN_FILTER_PUSH_INFO:
503 err = vlan_filter_push_vids(vlan_info, htons(ETH_P_8021Q));
504 if (err)
505 return notifier_from_errno(err);
506 break;
508 case NETDEV_CVLAN_FILTER_DROP_INFO:
509 vlan_filter_drop_vids(vlan_info, htons(ETH_P_8021Q));
510 break;
512 case NETDEV_SVLAN_FILTER_PUSH_INFO:
513 err = vlan_filter_push_vids(vlan_info, htons(ETH_P_8021AD));
514 if (err)
515 return notifier_from_errno(err);
516 break;
518 case NETDEV_SVLAN_FILTER_DROP_INFO:
519 vlan_filter_drop_vids(vlan_info, htons(ETH_P_8021AD));
520 break;
523 out:
524 return NOTIFY_DONE;
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)
538 int err;
539 struct vlan_ioctl_args args;
540 struct net_device *dev = NULL;
542 if (copy_from_user(&args, arg, sizeof(struct vlan_ioctl_args)))
543 return -EFAULT;
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;
549 rtnl_lock();
551 switch (args.cmd) {
552 case SET_VLAN_INGRESS_PRIORITY_CMD:
553 case SET_VLAN_EGRESS_PRIORITY_CMD:
554 case SET_VLAN_FLAG_CMD:
555 case ADD_VLAN_CMD:
556 case DEL_VLAN_CMD:
557 case GET_VLAN_REALDEV_NAME_CMD:
558 case GET_VLAN_VID_CMD:
559 err = -ENODEV;
560 dev = __dev_get_by_name(net, args.device1);
561 if (!dev)
562 goto out;
564 err = -EINVAL;
565 if (args.cmd != ADD_VLAN_CMD && !is_vlan_dev(dev))
566 goto out;
569 switch (args.cmd) {
570 case SET_VLAN_INGRESS_PRIORITY_CMD:
571 err = -EPERM;
572 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
573 break;
574 vlan_dev_set_ingress_priority(dev,
575 args.u.skb_priority,
576 args.vlan_qos);
577 err = 0;
578 break;
580 case SET_VLAN_EGRESS_PRIORITY_CMD:
581 err = -EPERM;
582 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
583 break;
584 err = vlan_dev_set_egress_priority(dev,
585 args.u.skb_priority,
586 args.vlan_qos);
587 break;
589 case SET_VLAN_FLAG_CMD:
590 err = -EPERM;
591 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
592 break;
593 err = vlan_dev_change_flags(dev,
594 args.vlan_qos ? args.u.flag : 0,
595 args.u.flag);
596 break;
598 case SET_VLAN_NAME_TYPE_CMD:
599 err = -EPERM;
600 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
601 break;
602 if (args.u.name_type < VLAN_NAME_TYPE_HIGHEST) {
603 struct vlan_net *vn;
605 vn = net_generic(net, vlan_net_id);
606 vn->name_type = args.u.name_type;
607 err = 0;
608 } else {
609 err = -EINVAL;
611 break;
613 case ADD_VLAN_CMD:
614 err = -EPERM;
615 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
616 break;
617 err = register_vlan_device(dev, args.u.VID);
618 break;
620 case DEL_VLAN_CMD:
621 err = -EPERM;
622 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
623 break;
624 unregister_vlan_dev(dev, NULL);
625 err = 0;
626 break;
628 case GET_VLAN_REALDEV_NAME_CMD:
629 err = 0;
630 vlan_dev_get_realdev_name(dev, args.u.device2);
631 if (copy_to_user(arg, &args,
632 sizeof(struct vlan_ioctl_args)))
633 err = -EFAULT;
634 break;
636 case GET_VLAN_VID_CMD:
637 err = 0;
638 args.u.VID = vlan_dev_vlan_id(dev);
639 if (copy_to_user(arg, &args,
640 sizeof(struct vlan_ioctl_args)))
641 err = -EFAULT;
642 break;
644 default:
645 err = -EOPNOTSUPP;
646 break;
648 out:
649 rtnl_unlock();
650 return err;
653 static int __net_init vlan_init_net(struct net *net)
655 struct vlan_net *vn = net_generic(net, vlan_net_id);
656 int err;
658 vn->name_type = VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD;
660 err = vlan_proc_init(net);
662 return err;
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,
673 .id = &vlan_net_id,
674 .size = sizeof(struct vlan_net),
677 static int __init vlan_proto_init(void)
679 int err;
681 pr_info("%s v%s\n", vlan_fullname, vlan_version);
683 err = register_pernet_subsys(&vlan_net_ops);
684 if (err < 0)
685 goto err0;
687 err = register_netdevice_notifier(&vlan_notifier_block);
688 if (err < 0)
689 goto err2;
691 err = vlan_gvrp_init();
692 if (err < 0)
693 goto err3;
695 err = vlan_mvrp_init();
696 if (err < 0)
697 goto err4;
699 err = vlan_netlink_init();
700 if (err < 0)
701 goto err5;
703 vlan_ioctl_set(vlan_ioctl_handler);
704 return 0;
706 err5:
707 vlan_mvrp_uninit();
708 err4:
709 vlan_gvrp_uninit();
710 err3:
711 unregister_netdevice_notifier(&vlan_notifier_block);
712 err2:
713 unregister_pernet_subsys(&vlan_net_ops);
714 err0:
715 return err;
718 static void __exit vlan_cleanup_module(void)
720 vlan_ioctl_set(NULL);
722 vlan_netlink_fini();
724 unregister_netdevice_notifier(&vlan_notifier_block);
726 unregister_pernet_subsys(&vlan_net_ops);
727 rcu_barrier(); /* Wait for completion of call_rcu()'s */
729 vlan_mvrp_uninit();
730 vlan_gvrp_uninit();
733 module_init(vlan_proto_init);
734 module_exit(vlan_cleanup_module);
736 MODULE_LICENSE("GPL");
737 MODULE_VERSION(DRV_VERSION);