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 #include <asm/uaccess.h> /* for copy_from_user */
22 #include <linux/capability.h>
23 #include <linux/module.h>
24 #include <linux/netdevice.h>
25 #include <linux/skbuff.h>
26 #include <net/datalink.h>
29 #include <linux/init.h>
30 #include <net/p8022.h>
32 #include <linux/rtnetlink.h>
33 #include <linux/notifier.h>
34 #include <net/net_namespace.h>
35 #include <net/netns/generic.h>
37 #include <linux/if_vlan.h>
41 #define DRV_VERSION "1.8"
43 /* Global VLAN variables */
47 /* Our listing of VLAN group(s) */
48 static struct hlist_head vlan_group_hash[VLAN_GRP_HASH_SIZE];
50 static char vlan_fullname[] = "802.1Q VLAN Support";
51 static char vlan_version[] = DRV_VERSION;
52 static char vlan_copyright[] = "Ben Greear <greearb@candelatech.com>";
53 static char vlan_buggyright[] = "David S. Miller <davem@redhat.com>";
55 static struct packet_type vlan_packet_type = {
56 .type = __constant_htons(ETH_P_8021Q),
57 .func = vlan_skb_recv, /* VLAN receive method */
60 /* End of global variables definitions. */
62 static inline unsigned int vlan_grp_hashfn(unsigned int idx)
64 return ((idx >> VLAN_GRP_HASH_SHIFT) ^ idx) & VLAN_GRP_HASH_MASK;
67 /* Must be invoked with RCU read lock (no preempt) */
68 static struct vlan_group *__vlan_find_group(struct net_device *real_dev)
70 struct vlan_group *grp;
72 int hash = vlan_grp_hashfn(real_dev->ifindex);
74 hlist_for_each_entry_rcu(grp, n, &vlan_group_hash[hash], hlist) {
75 if (grp->real_dev == real_dev)
82 /* Find the protocol handler. Assumes VID < VLAN_VID_MASK.
84 * Must be invoked with RCU read lock (no preempt)
86 struct net_device *__find_vlan_dev(struct net_device *real_dev,
89 struct vlan_group *grp = __vlan_find_group(real_dev);
92 return vlan_group_get_device(grp, VID);
97 static void vlan_group_free(struct vlan_group *grp)
101 for (i = 0; i < VLAN_GROUP_ARRAY_SPLIT_PARTS; i++)
102 kfree(grp->vlan_devices_arrays[i]);
106 static struct vlan_group *vlan_group_alloc(struct net_device *real_dev)
108 struct vlan_group *grp;
110 grp = kzalloc(sizeof(struct vlan_group), GFP_KERNEL);
114 grp->real_dev = real_dev;
115 hlist_add_head_rcu(&grp->hlist,
116 &vlan_group_hash[vlan_grp_hashfn(real_dev->ifindex)]);
120 static int vlan_group_prealloc_vid(struct vlan_group *vg, int vid)
122 struct net_device **array;
127 array = vg->vlan_devices_arrays[vid / VLAN_GROUP_ARRAY_PART_LEN];
131 size = sizeof(struct net_device *) * VLAN_GROUP_ARRAY_PART_LEN;
132 array = kzalloc(size, GFP_KERNEL);
136 vg->vlan_devices_arrays[vid / VLAN_GROUP_ARRAY_PART_LEN] = array;
140 static void vlan_rcu_free(struct rcu_head *rcu)
142 vlan_group_free(container_of(rcu, struct vlan_group, rcu));
145 void unregister_vlan_dev(struct net_device *dev)
147 struct vlan_dev_info *vlan = vlan_dev_info(dev);
148 struct net_device *real_dev = vlan->real_dev;
149 struct vlan_group *grp;
150 unsigned short vlan_id = vlan->vlan_id;
154 grp = __vlan_find_group(real_dev);
157 /* Take it out of our own structures, but be sure to interlock with
158 * HW accelerating devices or SW vlan input packet processing.
160 if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
161 real_dev->vlan_rx_kill_vid(real_dev, vlan_id);
163 vlan_group_set_device(grp, vlan_id, NULL);
168 unregister_netdevice(dev);
170 /* If the group is now empty, kill off the group. */
171 if (grp->nr_vlans == 0) {
172 vlan_gvrp_uninit_applicant(real_dev);
174 if (real_dev->features & NETIF_F_HW_VLAN_RX)
175 real_dev->vlan_rx_register(real_dev, NULL);
177 hlist_del_rcu(&grp->hlist);
179 /* Free the group, after all cpu's are done. */
180 call_rcu(&grp->rcu, vlan_rcu_free);
183 /* Get rid of the vlan's reference to real_dev */
187 static void vlan_transfer_operstate(const struct net_device *dev,
188 struct net_device *vlandev)
190 /* Have to respect userspace enforced dormant state
191 * of real device, also must allow supplicant running
194 if (dev->operstate == IF_OPER_DORMANT)
195 netif_dormant_on(vlandev);
197 netif_dormant_off(vlandev);
199 if (netif_carrier_ok(dev)) {
200 if (!netif_carrier_ok(vlandev))
201 netif_carrier_on(vlandev);
203 if (netif_carrier_ok(vlandev))
204 netif_carrier_off(vlandev);
208 int vlan_check_real_dev(struct net_device *real_dev, unsigned short vlan_id)
210 char *name = real_dev->name;
212 if (real_dev->features & NETIF_F_VLAN_CHALLENGED) {
213 pr_info("8021q: VLANs not supported on %s\n", name);
217 if ((real_dev->features & NETIF_F_HW_VLAN_RX) &&
218 !real_dev->vlan_rx_register) {
219 pr_info("8021q: device %s has buggy VLAN hw accel\n", name);
223 if ((real_dev->features & NETIF_F_HW_VLAN_FILTER) &&
224 (!real_dev->vlan_rx_add_vid || !real_dev->vlan_rx_kill_vid)) {
225 pr_info("8021q: Device %s has buggy VLAN hw accel\n", name);
229 /* The real device must be up and operating in order to
230 * assosciate a VLAN device with it.
232 if (!(real_dev->flags & IFF_UP))
235 if (__find_vlan_dev(real_dev, vlan_id) != NULL)
241 int register_vlan_dev(struct net_device *dev)
243 struct vlan_dev_info *vlan = vlan_dev_info(dev);
244 struct net_device *real_dev = vlan->real_dev;
245 unsigned short vlan_id = vlan->vlan_id;
246 struct vlan_group *grp, *ngrp = NULL;
249 grp = __vlan_find_group(real_dev);
251 ngrp = grp = vlan_group_alloc(real_dev);
254 err = vlan_gvrp_init_applicant(real_dev);
259 err = vlan_group_prealloc_vid(grp, vlan_id);
261 goto out_uninit_applicant;
263 err = register_netdevice(dev);
265 goto out_uninit_applicant;
267 /* Account for reference in struct vlan_dev_info */
270 vlan_transfer_operstate(real_dev, dev);
271 linkwatch_fire_event(dev); /* _MUST_ call rfc2863_policy() */
273 /* So, got the sucker initialized, now lets place
274 * it into our local structure.
276 vlan_group_set_device(grp, vlan_id, dev);
279 if (ngrp && real_dev->features & NETIF_F_HW_VLAN_RX)
280 real_dev->vlan_rx_register(real_dev, ngrp);
281 if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
282 real_dev->vlan_rx_add_vid(real_dev, vlan_id);
286 out_uninit_applicant:
288 vlan_gvrp_uninit_applicant(real_dev);
291 vlan_group_free(ngrp);
295 /* Attach a VLAN device to a mac address (ie Ethernet Card).
296 * Returns 0 if the device was created or a negative error code otherwise.
298 static int register_vlan_device(struct net_device *real_dev,
299 unsigned short VLAN_ID)
301 struct net_device *new_dev;
302 struct net *net = dev_net(real_dev);
303 struct vlan_net *vn = net_generic(net, vlan_net_id);
307 if (VLAN_ID >= VLAN_VID_MASK)
310 err = vlan_check_real_dev(real_dev, VLAN_ID);
314 /* Gotta set up the fields for the device. */
315 switch (vn->name_type) {
316 case VLAN_NAME_TYPE_RAW_PLUS_VID:
317 /* name will look like: eth1.0005 */
318 snprintf(name, IFNAMSIZ, "%s.%.4i", real_dev->name, VLAN_ID);
320 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD:
321 /* Put our vlan.VID in the name.
322 * Name will look like: vlan5
324 snprintf(name, IFNAMSIZ, "vlan%i", VLAN_ID);
326 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD:
327 /* Put our vlan.VID in the name.
328 * Name will look like: eth0.5
330 snprintf(name, IFNAMSIZ, "%s.%i", real_dev->name, VLAN_ID);
332 case VLAN_NAME_TYPE_PLUS_VID:
333 /* Put our vlan.VID in the name.
334 * Name will look like: vlan0005
337 snprintf(name, IFNAMSIZ, "vlan%.4i", VLAN_ID);
340 new_dev = alloc_netdev(sizeof(struct vlan_dev_info), name,
346 dev_net_set(new_dev, net);
347 /* need 4 bytes for extra VLAN header info,
348 * hope the underlying device can handle it.
350 new_dev->mtu = real_dev->mtu;
352 vlan_dev_info(new_dev)->vlan_id = VLAN_ID; /* 1 through VLAN_VID_MASK */
353 vlan_dev_info(new_dev)->real_dev = real_dev;
354 vlan_dev_info(new_dev)->dent = NULL;
355 vlan_dev_info(new_dev)->flags = VLAN_FLAG_REORDER_HDR;
357 new_dev->rtnl_link_ops = &vlan_link_ops;
358 err = register_vlan_dev(new_dev);
360 goto out_free_newdev;
365 free_netdev(new_dev);
369 static void vlan_sync_address(struct net_device *dev,
370 struct net_device *vlandev)
372 struct vlan_dev_info *vlan = vlan_dev_info(vlandev);
374 /* May be called without an actual change */
375 if (!compare_ether_addr(vlan->real_dev_addr, dev->dev_addr))
378 /* vlan address was different from the old address and is equal to
380 if (compare_ether_addr(vlandev->dev_addr, vlan->real_dev_addr) &&
381 !compare_ether_addr(vlandev->dev_addr, dev->dev_addr))
382 dev_unicast_delete(dev, vlandev->dev_addr, ETH_ALEN);
384 /* vlan address was equal to the old address and is different from
386 if (!compare_ether_addr(vlandev->dev_addr, vlan->real_dev_addr) &&
387 compare_ether_addr(vlandev->dev_addr, dev->dev_addr))
388 dev_unicast_add(dev, vlandev->dev_addr, ETH_ALEN);
390 memcpy(vlan->real_dev_addr, dev->dev_addr, ETH_ALEN);
393 static void vlan_transfer_features(struct net_device *dev,
394 struct net_device *vlandev)
396 unsigned long old_features = vlandev->features;
398 vlandev->features &= ~dev->vlan_features;
399 vlandev->features |= dev->features & dev->vlan_features;
401 if (old_features != vlandev->features)
402 netdev_features_change(vlandev);
405 static void __vlan_device_event(struct net_device *dev, unsigned long event)
408 case NETDEV_CHANGENAME:
409 vlan_proc_rem_dev(dev);
410 if (vlan_proc_add_dev(dev) < 0)
411 pr_warning("8021q: failed to change proc name for %s\n",
414 case NETDEV_REGISTER:
415 if (vlan_proc_add_dev(dev) < 0)
416 pr_warning("8021q: failed to add proc entry for %s\n",
419 case NETDEV_UNREGISTER:
420 vlan_proc_rem_dev(dev);
425 static int vlan_device_event(struct notifier_block *unused, unsigned long event,
428 struct net_device *dev = ptr;
429 struct vlan_group *grp;
431 struct net_device *vlandev;
433 if (is_vlan_dev(dev))
434 __vlan_device_event(dev, event);
436 grp = __vlan_find_group(dev);
440 /* It is OK that we do not hold the group lock right now,
441 * as we run under the RTNL lock.
446 /* Propagate real device state to vlan devices */
447 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
448 vlandev = vlan_group_get_device(grp, i);
452 vlan_transfer_operstate(dev, vlandev);
456 case NETDEV_CHANGEADDR:
457 /* Adjust unicast filters on underlying device */
458 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
459 vlandev = vlan_group_get_device(grp, i);
463 flgs = vlandev->flags;
464 if (!(flgs & IFF_UP))
467 vlan_sync_address(dev, vlandev);
471 case NETDEV_FEAT_CHANGE:
472 /* Propagate device features to underlying device */
473 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
474 vlandev = vlan_group_get_device(grp, i);
478 vlan_transfer_features(dev, vlandev);
484 /* Put all VLANs for this dev in the down state too. */
485 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
486 vlandev = vlan_group_get_device(grp, i);
490 flgs = vlandev->flags;
491 if (!(flgs & IFF_UP))
494 dev_change_flags(vlandev, flgs & ~IFF_UP);
499 /* Put all VLANs for this dev in the up state too. */
500 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
501 vlandev = vlan_group_get_device(grp, i);
505 flgs = vlandev->flags;
509 dev_change_flags(vlandev, flgs | IFF_UP);
513 case NETDEV_UNREGISTER:
514 /* Delete all VLANs for this dev. */
515 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
516 vlandev = vlan_group_get_device(grp, i);
520 /* unregistration of last vlan destroys group, abort
522 if (grp->nr_vlans == 1)
523 i = VLAN_GROUP_ARRAY_LEN;
525 unregister_vlan_dev(vlandev);
534 static struct notifier_block vlan_notifier_block __read_mostly = {
535 .notifier_call = vlan_device_event,
539 * VLAN IOCTL handler.
540 * o execute requested action or pass command to the device driver
541 * arg is really a struct vlan_ioctl_args __user *.
543 static int vlan_ioctl_handler(struct net *net, void __user *arg)
546 unsigned short vid = 0;
547 struct vlan_ioctl_args args;
548 struct net_device *dev = NULL;
550 if (copy_from_user(&args, arg, sizeof(struct vlan_ioctl_args)))
553 /* Null terminate this sucker, just in case. */
554 args.device1[23] = 0;
555 args.u.device2[23] = 0;
560 case SET_VLAN_INGRESS_PRIORITY_CMD:
561 case SET_VLAN_EGRESS_PRIORITY_CMD:
562 case SET_VLAN_FLAG_CMD:
565 case GET_VLAN_REALDEV_NAME_CMD:
566 case GET_VLAN_VID_CMD:
568 dev = __dev_get_by_name(net, args.device1);
573 if (args.cmd != ADD_VLAN_CMD && !is_vlan_dev(dev))
578 case SET_VLAN_INGRESS_PRIORITY_CMD:
580 if (!capable(CAP_NET_ADMIN))
582 vlan_dev_set_ingress_priority(dev,
588 case SET_VLAN_EGRESS_PRIORITY_CMD:
590 if (!capable(CAP_NET_ADMIN))
592 err = vlan_dev_set_egress_priority(dev,
597 case SET_VLAN_FLAG_CMD:
599 if (!capable(CAP_NET_ADMIN))
601 err = vlan_dev_change_flags(dev,
602 args.vlan_qos ? args.u.flag : 0,
606 case SET_VLAN_NAME_TYPE_CMD:
608 if (!capable(CAP_NET_ADMIN))
610 if ((args.u.name_type >= 0) &&
611 (args.u.name_type < VLAN_NAME_TYPE_HIGHEST)) {
614 vn = net_generic(net, vlan_net_id);
615 vn->name_type = args.u.name_type;
624 if (!capable(CAP_NET_ADMIN))
626 err = register_vlan_device(dev, args.u.VID);
631 if (!capable(CAP_NET_ADMIN))
633 unregister_vlan_dev(dev);
637 case GET_VLAN_REALDEV_NAME_CMD:
639 vlan_dev_get_realdev_name(dev, args.u.device2);
640 if (copy_to_user(arg, &args,
641 sizeof(struct vlan_ioctl_args)))
645 case GET_VLAN_VID_CMD:
647 vlan_dev_get_vid(dev, &vid);
649 if (copy_to_user(arg, &args,
650 sizeof(struct vlan_ioctl_args)))
663 static int vlan_init_net(struct net *net)
669 vn = kzalloc(sizeof(struct vlan_net), GFP_KERNEL);
673 err = net_assign_generic(net, vlan_net_id, vn);
677 vn->name_type = VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD;
679 err = vlan_proc_init(net);
693 static void vlan_exit_net(struct net *net)
697 vn = net_generic(net, vlan_net_id);
698 rtnl_kill_links(net, &vlan_link_ops);
699 vlan_proc_cleanup(net);
703 static struct pernet_operations vlan_net_ops = {
704 .init = vlan_init_net,
705 .exit = vlan_exit_net,
708 static int __init vlan_proto_init(void)
712 pr_info("%s v%s %s\n", vlan_fullname, vlan_version, vlan_copyright);
713 pr_info("All bugs added by %s\n", vlan_buggyright);
715 err = register_pernet_gen_device(&vlan_net_id, &vlan_net_ops);
719 err = register_netdevice_notifier(&vlan_notifier_block);
723 err = vlan_gvrp_init();
727 err = vlan_netlink_init();
731 dev_add_pack(&vlan_packet_type);
732 vlan_ioctl_set(vlan_ioctl_handler);
738 unregister_netdevice_notifier(&vlan_notifier_block);
740 unregister_pernet_gen_device(vlan_net_id, &vlan_net_ops);
745 static void __exit vlan_cleanup_module(void)
749 vlan_ioctl_set(NULL);
752 unregister_netdevice_notifier(&vlan_notifier_block);
754 dev_remove_pack(&vlan_packet_type);
756 /* This table must be empty if there are no module references left. */
757 for (i = 0; i < VLAN_GRP_HASH_SIZE; i++)
758 BUG_ON(!hlist_empty(&vlan_group_hash[i]));
760 unregister_pernet_gen_device(vlan_net_id, &vlan_net_ops);
766 module_init(vlan_proto_init);
767 module_exit(vlan_cleanup_module);
769 MODULE_LICENSE("GPL");
770 MODULE_VERSION(DRV_VERSION);