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 /* If the group is now empty, kill off the group. */
169 if (grp->nr_vlans == 0) {
170 if (real_dev->features & NETIF_F_HW_VLAN_RX)
171 real_dev->vlan_rx_register(real_dev, NULL);
173 hlist_del_rcu(&grp->hlist);
175 /* Free the group, after all cpu's are done. */
176 call_rcu(&grp->rcu, vlan_rcu_free);
179 /* Get rid of the vlan's reference to real_dev */
182 unregister_netdevice(dev);
185 static void vlan_transfer_operstate(const struct net_device *dev,
186 struct net_device *vlandev)
188 /* Have to respect userspace enforced dormant state
189 * of real device, also must allow supplicant running
192 if (dev->operstate == IF_OPER_DORMANT)
193 netif_dormant_on(vlandev);
195 netif_dormant_off(vlandev);
197 if (netif_carrier_ok(dev)) {
198 if (!netif_carrier_ok(vlandev))
199 netif_carrier_on(vlandev);
201 if (netif_carrier_ok(vlandev))
202 netif_carrier_off(vlandev);
206 int vlan_check_real_dev(struct net_device *real_dev, unsigned short vlan_id)
208 char *name = real_dev->name;
210 if (real_dev->features & NETIF_F_VLAN_CHALLENGED) {
211 pr_info("8021q: VLANs not supported on %s\n", name);
215 if ((real_dev->features & NETIF_F_HW_VLAN_RX) &&
216 !real_dev->vlan_rx_register) {
217 pr_info("8021q: device %s has buggy VLAN hw accel\n", name);
221 if ((real_dev->features & NETIF_F_HW_VLAN_FILTER) &&
222 (!real_dev->vlan_rx_add_vid || !real_dev->vlan_rx_kill_vid)) {
223 pr_info("8021q: Device %s has buggy VLAN hw accel\n", name);
227 /* The real device must be up and operating in order to
228 * assosciate a VLAN device with it.
230 if (!(real_dev->flags & IFF_UP))
233 if (__find_vlan_dev(real_dev, vlan_id) != NULL)
239 int register_vlan_dev(struct net_device *dev)
241 struct vlan_dev_info *vlan = vlan_dev_info(dev);
242 struct net_device *real_dev = vlan->real_dev;
243 unsigned short vlan_id = vlan->vlan_id;
244 struct vlan_group *grp, *ngrp = NULL;
247 grp = __vlan_find_group(real_dev);
249 ngrp = grp = vlan_group_alloc(real_dev);
254 err = vlan_group_prealloc_vid(grp, vlan_id);
258 err = register_netdevice(dev);
262 /* Account for reference in struct vlan_dev_info */
265 vlan_transfer_operstate(real_dev, dev);
266 linkwatch_fire_event(dev); /* _MUST_ call rfc2863_policy() */
268 /* So, got the sucker initialized, now lets place
269 * it into our local structure.
271 vlan_group_set_device(grp, vlan_id, dev);
274 if (ngrp && real_dev->features & NETIF_F_HW_VLAN_RX)
275 real_dev->vlan_rx_register(real_dev, ngrp);
276 if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
277 real_dev->vlan_rx_add_vid(real_dev, vlan_id);
283 vlan_group_free(ngrp);
287 /* Attach a VLAN device to a mac address (ie Ethernet Card).
288 * Returns 0 if the device was created or a negative error code otherwise.
290 static int register_vlan_device(struct net_device *real_dev,
291 unsigned short VLAN_ID)
293 struct net_device *new_dev;
294 struct net *net = dev_net(real_dev);
295 struct vlan_net *vn = net_generic(net, vlan_net_id);
299 if (VLAN_ID >= VLAN_VID_MASK)
302 err = vlan_check_real_dev(real_dev, VLAN_ID);
306 /* Gotta set up the fields for the device. */
307 switch (vn->name_type) {
308 case VLAN_NAME_TYPE_RAW_PLUS_VID:
309 /* name will look like: eth1.0005 */
310 snprintf(name, IFNAMSIZ, "%s.%.4i", real_dev->name, VLAN_ID);
312 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD:
313 /* Put our vlan.VID in the name.
314 * Name will look like: vlan5
316 snprintf(name, IFNAMSIZ, "vlan%i", VLAN_ID);
318 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD:
319 /* Put our vlan.VID in the name.
320 * Name will look like: eth0.5
322 snprintf(name, IFNAMSIZ, "%s.%i", real_dev->name, VLAN_ID);
324 case VLAN_NAME_TYPE_PLUS_VID:
325 /* Put our vlan.VID in the name.
326 * Name will look like: vlan0005
329 snprintf(name, IFNAMSIZ, "vlan%.4i", VLAN_ID);
332 new_dev = alloc_netdev(sizeof(struct vlan_dev_info), name,
338 dev_net_set(new_dev, net);
339 /* need 4 bytes for extra VLAN header info,
340 * hope the underlying device can handle it.
342 new_dev->mtu = real_dev->mtu;
344 vlan_dev_info(new_dev)->vlan_id = VLAN_ID; /* 1 through VLAN_VID_MASK */
345 vlan_dev_info(new_dev)->real_dev = real_dev;
346 vlan_dev_info(new_dev)->dent = NULL;
347 vlan_dev_info(new_dev)->flags = VLAN_FLAG_REORDER_HDR;
349 new_dev->rtnl_link_ops = &vlan_link_ops;
350 err = register_vlan_dev(new_dev);
352 goto out_free_newdev;
357 free_netdev(new_dev);
361 static void vlan_sync_address(struct net_device *dev,
362 struct net_device *vlandev)
364 struct vlan_dev_info *vlan = vlan_dev_info(vlandev);
366 /* May be called without an actual change */
367 if (!compare_ether_addr(vlan->real_dev_addr, dev->dev_addr))
370 /* vlan address was different from the old address and is equal to
372 if (compare_ether_addr(vlandev->dev_addr, vlan->real_dev_addr) &&
373 !compare_ether_addr(vlandev->dev_addr, dev->dev_addr))
374 dev_unicast_delete(dev, vlandev->dev_addr, ETH_ALEN);
376 /* vlan address was equal to the old address and is different from
378 if (!compare_ether_addr(vlandev->dev_addr, vlan->real_dev_addr) &&
379 compare_ether_addr(vlandev->dev_addr, dev->dev_addr))
380 dev_unicast_add(dev, vlandev->dev_addr, ETH_ALEN);
382 memcpy(vlan->real_dev_addr, dev->dev_addr, ETH_ALEN);
385 static void vlan_transfer_features(struct net_device *dev,
386 struct net_device *vlandev)
388 unsigned long old_features = vlandev->features;
390 vlandev->features &= ~dev->vlan_features;
391 vlandev->features |= dev->features & dev->vlan_features;
393 if (old_features != vlandev->features)
394 netdev_features_change(vlandev);
397 static void __vlan_device_event(struct net_device *dev, unsigned long event)
400 case NETDEV_CHANGENAME:
401 vlan_proc_rem_dev(dev);
402 if (vlan_proc_add_dev(dev) < 0)
403 pr_warning("8021q: failed to change proc name for %s\n",
406 case NETDEV_REGISTER:
407 if (vlan_proc_add_dev(dev) < 0)
408 pr_warning("8021q: failed to add proc entry for %s\n",
411 case NETDEV_UNREGISTER:
412 vlan_proc_rem_dev(dev);
417 static int vlan_device_event(struct notifier_block *unused, unsigned long event,
420 struct net_device *dev = ptr;
421 struct vlan_group *grp;
423 struct net_device *vlandev;
425 if (is_vlan_dev(dev))
426 __vlan_device_event(dev, event);
428 grp = __vlan_find_group(dev);
432 /* It is OK that we do not hold the group lock right now,
433 * as we run under the RTNL lock.
438 /* Propagate real device state to vlan devices */
439 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
440 vlandev = vlan_group_get_device(grp, i);
444 vlan_transfer_operstate(dev, vlandev);
448 case NETDEV_CHANGEADDR:
449 /* Adjust unicast filters on underlying device */
450 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
451 vlandev = vlan_group_get_device(grp, i);
455 flgs = vlandev->flags;
456 if (!(flgs & IFF_UP))
459 vlan_sync_address(dev, vlandev);
463 case NETDEV_FEAT_CHANGE:
464 /* Propagate device features to underlying device */
465 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
466 vlandev = vlan_group_get_device(grp, i);
470 vlan_transfer_features(dev, vlandev);
476 /* Put all VLANs for this dev in the down state too. */
477 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
478 vlandev = vlan_group_get_device(grp, i);
482 flgs = vlandev->flags;
483 if (!(flgs & IFF_UP))
486 dev_change_flags(vlandev, flgs & ~IFF_UP);
491 /* Put all VLANs for this dev in the up state too. */
492 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
493 vlandev = vlan_group_get_device(grp, i);
497 flgs = vlandev->flags;
501 dev_change_flags(vlandev, flgs | IFF_UP);
505 case NETDEV_UNREGISTER:
506 /* Delete all VLANs for this dev. */
507 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
508 vlandev = vlan_group_get_device(grp, i);
512 /* unregistration of last vlan destroys group, abort
514 if (grp->nr_vlans == 1)
515 i = VLAN_GROUP_ARRAY_LEN;
517 unregister_vlan_dev(vlandev);
526 static struct notifier_block vlan_notifier_block __read_mostly = {
527 .notifier_call = vlan_device_event,
531 * VLAN IOCTL handler.
532 * o execute requested action or pass command to the device driver
533 * arg is really a struct vlan_ioctl_args __user *.
535 static int vlan_ioctl_handler(struct net *net, void __user *arg)
538 unsigned short vid = 0;
539 struct vlan_ioctl_args args;
540 struct net_device *dev = NULL;
542 if (copy_from_user(&args, arg, sizeof(struct vlan_ioctl_args)))
545 /* Null terminate this sucker, just in case. */
546 args.device1[23] = 0;
547 args.u.device2[23] = 0;
552 case SET_VLAN_INGRESS_PRIORITY_CMD:
553 case SET_VLAN_EGRESS_PRIORITY_CMD:
554 case SET_VLAN_FLAG_CMD:
557 case GET_VLAN_REALDEV_NAME_CMD:
558 case GET_VLAN_VID_CMD:
560 dev = __dev_get_by_name(net, args.device1);
565 if (args.cmd != ADD_VLAN_CMD &&
566 !(dev->priv_flags & IFF_802_1Q_VLAN))
571 case SET_VLAN_INGRESS_PRIORITY_CMD:
573 if (!capable(CAP_NET_ADMIN))
575 vlan_dev_set_ingress_priority(dev,
581 case SET_VLAN_EGRESS_PRIORITY_CMD:
583 if (!capable(CAP_NET_ADMIN))
585 err = vlan_dev_set_egress_priority(dev,
590 case SET_VLAN_FLAG_CMD:
592 if (!capable(CAP_NET_ADMIN))
594 err = vlan_dev_set_vlan_flag(dev,
599 case SET_VLAN_NAME_TYPE_CMD:
601 if (!capable(CAP_NET_ADMIN))
603 if ((args.u.name_type >= 0) &&
604 (args.u.name_type < VLAN_NAME_TYPE_HIGHEST)) {
607 vn = net_generic(net, vlan_net_id);
608 vn->name_type = args.u.name_type;
617 if (!capable(CAP_NET_ADMIN))
619 err = register_vlan_device(dev, args.u.VID);
624 if (!capable(CAP_NET_ADMIN))
626 unregister_vlan_dev(dev);
630 case GET_VLAN_REALDEV_NAME_CMD:
632 vlan_dev_get_realdev_name(dev, args.u.device2);
633 if (copy_to_user(arg, &args,
634 sizeof(struct vlan_ioctl_args)))
638 case GET_VLAN_VID_CMD:
640 vlan_dev_get_vid(dev, &vid);
642 if (copy_to_user(arg, &args,
643 sizeof(struct vlan_ioctl_args)))
656 static int vlan_init_net(struct net *net)
662 vn = kzalloc(sizeof(struct vlan_net), GFP_KERNEL);
666 err = net_assign_generic(net, vlan_net_id, vn);
670 vn->name_type = VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD;
672 err = vlan_proc_init(net);
686 static void vlan_exit_net(struct net *net)
690 vn = net_generic(net, vlan_net_id);
691 rtnl_kill_links(net, &vlan_link_ops);
692 vlan_proc_cleanup(net);
696 static struct pernet_operations vlan_net_ops = {
697 .init = vlan_init_net,
698 .exit = vlan_exit_net,
701 static int __init vlan_proto_init(void)
705 pr_info("%s v%s %s\n", vlan_fullname, vlan_version, vlan_copyright);
706 pr_info("All bugs added by %s\n", vlan_buggyright);
708 err = register_pernet_gen_device(&vlan_net_id, &vlan_net_ops);
712 err = register_netdevice_notifier(&vlan_notifier_block);
716 err = vlan_netlink_init();
720 dev_add_pack(&vlan_packet_type);
721 vlan_ioctl_set(vlan_ioctl_handler);
725 unregister_netdevice_notifier(&vlan_notifier_block);
727 unregister_pernet_gen_device(vlan_net_id, &vlan_net_ops);
732 static void __exit vlan_cleanup_module(void)
736 vlan_ioctl_set(NULL);
739 unregister_netdevice_notifier(&vlan_notifier_block);
741 dev_remove_pack(&vlan_packet_type);
743 /* This table must be empty if there are no module references left. */
744 for (i = 0; i < VLAN_GRP_HASH_SIZE; i++)
745 BUG_ON(!hlist_empty(&vlan_group_hash[i]));
747 unregister_pernet_gen_device(vlan_net_id, &vlan_net_ops);
752 module_init(vlan_proto_init);
753 module_exit(vlan_cleanup_module);
755 MODULE_LICENSE("GPL");
756 MODULE_VERSION(DRV_VERSION);