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 <linux/capability.h>
22 #include <linux/module.h>
23 #include <linux/netdevice.h>
24 #include <linux/skbuff.h>
25 #include <linux/init.h>
26 #include <linux/rtnetlink.h>
27 #include <linux/notifier.h>
28 #include <net/rtnetlink.h>
29 #include <net/net_namespace.h>
30 #include <net/netns/generic.h>
31 #include <asm/uaccess.h>
33 #include <linux/if_vlan.h>
37 #define DRV_VERSION "1.8"
39 /* Global VLAN variables */
43 /* Our listing of VLAN group(s) */
44 static struct hlist_head vlan_group_hash[VLAN_GRP_HASH_SIZE];
46 static char vlan_fullname[] = "802.1Q VLAN Support";
47 static char vlan_version[] = DRV_VERSION;
48 static char vlan_copyright[] = "Ben Greear <greearb@candelatech.com>";
49 static char vlan_buggyright[] = "David S. Miller <davem@redhat.com>";
51 static struct packet_type vlan_packet_type = {
52 .type = __constant_htons(ETH_P_8021Q),
53 .func = vlan_skb_recv, /* VLAN receive method */
56 /* End of global variables definitions. */
58 static inline unsigned int vlan_grp_hashfn(unsigned int idx)
60 return ((idx >> VLAN_GRP_HASH_SHIFT) ^ idx) & VLAN_GRP_HASH_MASK;
63 /* Must be invoked with RCU read lock (no preempt) */
64 static struct vlan_group *__vlan_find_group(struct net_device *real_dev)
66 struct vlan_group *grp;
68 int hash = vlan_grp_hashfn(real_dev->ifindex);
70 hlist_for_each_entry_rcu(grp, n, &vlan_group_hash[hash], hlist) {
71 if (grp->real_dev == real_dev)
78 /* Find the protocol handler. Assumes VID < VLAN_VID_MASK.
80 * Must be invoked with RCU read lock (no preempt)
82 struct net_device *__find_vlan_dev(struct net_device *real_dev, u16 vlan_id)
84 struct vlan_group *grp = __vlan_find_group(real_dev);
87 return vlan_group_get_device(grp, vlan_id);
92 static void vlan_group_free(struct vlan_group *grp)
96 for (i = 0; i < VLAN_GROUP_ARRAY_SPLIT_PARTS; i++)
97 kfree(grp->vlan_devices_arrays[i]);
101 static struct vlan_group *vlan_group_alloc(struct net_device *real_dev)
103 struct vlan_group *grp;
105 grp = kzalloc(sizeof(struct vlan_group), GFP_KERNEL);
109 grp->real_dev = real_dev;
110 hlist_add_head_rcu(&grp->hlist,
111 &vlan_group_hash[vlan_grp_hashfn(real_dev->ifindex)]);
115 static int vlan_group_prealloc_vid(struct vlan_group *vg, u16 vlan_id)
117 struct net_device **array;
122 array = vg->vlan_devices_arrays[vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
126 size = sizeof(struct net_device *) * VLAN_GROUP_ARRAY_PART_LEN;
127 array = kzalloc(size, GFP_KERNEL);
131 vg->vlan_devices_arrays[vlan_id / VLAN_GROUP_ARRAY_PART_LEN] = array;
135 static void vlan_rcu_free(struct rcu_head *rcu)
137 vlan_group_free(container_of(rcu, struct vlan_group, rcu));
140 void unregister_vlan_dev(struct net_device *dev)
142 struct vlan_dev_info *vlan = vlan_dev_info(dev);
143 struct net_device *real_dev = vlan->real_dev;
144 struct vlan_group *grp;
145 u16 vlan_id = vlan->vlan_id;
149 grp = __vlan_find_group(real_dev);
152 /* Take it out of our own structures, but be sure to interlock with
153 * HW accelerating devices or SW vlan input packet processing.
155 if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
156 real_dev->vlan_rx_kill_vid(real_dev, vlan_id);
158 vlan_group_set_device(grp, vlan_id, NULL);
163 unregister_netdevice(dev);
165 /* If the group is now empty, kill off the group. */
166 if (grp->nr_vlans == 0) {
167 vlan_gvrp_uninit_applicant(real_dev);
169 if (real_dev->features & NETIF_F_HW_VLAN_RX)
170 real_dev->vlan_rx_register(real_dev, NULL);
172 hlist_del_rcu(&grp->hlist);
174 /* Free the group, after all cpu's are done. */
175 call_rcu(&grp->rcu, vlan_rcu_free);
178 /* Get rid of the vlan's reference to real_dev */
182 static void vlan_transfer_operstate(const struct net_device *dev,
183 struct net_device *vlandev)
185 /* Have to respect userspace enforced dormant state
186 * of real device, also must allow supplicant running
189 if (dev->operstate == IF_OPER_DORMANT)
190 netif_dormant_on(vlandev);
192 netif_dormant_off(vlandev);
194 if (netif_carrier_ok(dev)) {
195 if (!netif_carrier_ok(vlandev))
196 netif_carrier_on(vlandev);
198 if (netif_carrier_ok(vlandev))
199 netif_carrier_off(vlandev);
203 int vlan_check_real_dev(struct net_device *real_dev, u16 vlan_id)
205 char *name = real_dev->name;
207 if (real_dev->features & NETIF_F_VLAN_CHALLENGED) {
208 pr_info("8021q: VLANs not supported on %s\n", name);
212 if ((real_dev->features & NETIF_F_HW_VLAN_RX) &&
213 !real_dev->vlan_rx_register) {
214 pr_info("8021q: device %s has buggy VLAN hw accel\n", name);
218 if ((real_dev->features & NETIF_F_HW_VLAN_FILTER) &&
219 (!real_dev->vlan_rx_add_vid || !real_dev->vlan_rx_kill_vid)) {
220 pr_info("8021q: Device %s has buggy VLAN hw accel\n", name);
224 /* The real device must be up and operating in order to
225 * assosciate a VLAN device with it.
227 if (!(real_dev->flags & IFF_UP))
230 if (__find_vlan_dev(real_dev, vlan_id) != NULL)
236 int register_vlan_dev(struct net_device *dev)
238 struct vlan_dev_info *vlan = vlan_dev_info(dev);
239 struct net_device *real_dev = vlan->real_dev;
240 u16 vlan_id = vlan->vlan_id;
241 struct vlan_group *grp, *ngrp = NULL;
244 grp = __vlan_find_group(real_dev);
246 ngrp = grp = vlan_group_alloc(real_dev);
249 err = vlan_gvrp_init_applicant(real_dev);
254 err = vlan_group_prealloc_vid(grp, vlan_id);
256 goto out_uninit_applicant;
258 err = register_netdevice(dev);
260 goto out_uninit_applicant;
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);
281 out_uninit_applicant:
283 vlan_gvrp_uninit_applicant(real_dev);
286 vlan_group_free(ngrp);
290 /* Attach a VLAN device to a mac address (ie Ethernet Card).
291 * Returns 0 if the device was created or a negative error code otherwise.
293 static int register_vlan_device(struct net_device *real_dev, u16 vlan_id)
295 struct net_device *new_dev;
296 struct net *net = dev_net(real_dev);
297 struct vlan_net *vn = net_generic(net, vlan_net_id);
301 if (vlan_id >= VLAN_VID_MASK)
304 err = vlan_check_real_dev(real_dev, vlan_id);
308 /* Gotta set up the fields for the device. */
309 switch (vn->name_type) {
310 case VLAN_NAME_TYPE_RAW_PLUS_VID:
311 /* name will look like: eth1.0005 */
312 snprintf(name, IFNAMSIZ, "%s.%.4i", real_dev->name, vlan_id);
314 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD:
315 /* Put our vlan.VID in the name.
316 * Name will look like: vlan5
318 snprintf(name, IFNAMSIZ, "vlan%i", vlan_id);
320 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD:
321 /* Put our vlan.VID in the name.
322 * Name will look like: eth0.5
324 snprintf(name, IFNAMSIZ, "%s.%i", real_dev->name, vlan_id);
326 case VLAN_NAME_TYPE_PLUS_VID:
327 /* Put our vlan.VID in the name.
328 * Name will look like: vlan0005
331 snprintf(name, IFNAMSIZ, "vlan%.4i", vlan_id);
334 new_dev = alloc_netdev(sizeof(struct vlan_dev_info), name,
340 dev_net_set(new_dev, net);
341 /* need 4 bytes for extra VLAN header info,
342 * hope the underlying device can handle it.
344 new_dev->mtu = real_dev->mtu;
346 vlan_dev_info(new_dev)->vlan_id = vlan_id;
347 vlan_dev_info(new_dev)->real_dev = real_dev;
348 vlan_dev_info(new_dev)->dent = NULL;
349 vlan_dev_info(new_dev)->flags = VLAN_FLAG_REORDER_HDR;
351 new_dev->rtnl_link_ops = &vlan_link_ops;
352 err = register_vlan_dev(new_dev);
354 goto out_free_newdev;
359 free_netdev(new_dev);
363 static void vlan_sync_address(struct net_device *dev,
364 struct net_device *vlandev)
366 struct vlan_dev_info *vlan = vlan_dev_info(vlandev);
368 /* May be called without an actual change */
369 if (!compare_ether_addr(vlan->real_dev_addr, dev->dev_addr))
372 /* vlan address was different from the old address and is equal to
374 if (compare_ether_addr(vlandev->dev_addr, vlan->real_dev_addr) &&
375 !compare_ether_addr(vlandev->dev_addr, dev->dev_addr))
376 dev_unicast_delete(dev, vlandev->dev_addr, ETH_ALEN);
378 /* vlan address was equal to the old address and is different from
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_add(dev, vlandev->dev_addr, ETH_ALEN);
384 memcpy(vlan->real_dev_addr, dev->dev_addr, ETH_ALEN);
387 static void vlan_transfer_features(struct net_device *dev,
388 struct net_device *vlandev)
390 unsigned long old_features = vlandev->features;
392 vlandev->features &= ~dev->vlan_features;
393 vlandev->features |= dev->features & dev->vlan_features;
395 if (old_features != vlandev->features)
396 netdev_features_change(vlandev);
399 static void __vlan_device_event(struct net_device *dev, unsigned long event)
402 case NETDEV_CHANGENAME:
403 vlan_proc_rem_dev(dev);
404 if (vlan_proc_add_dev(dev) < 0)
405 pr_warning("8021q: failed to change proc name for %s\n",
408 case NETDEV_REGISTER:
409 if (vlan_proc_add_dev(dev) < 0)
410 pr_warning("8021q: failed to add proc entry for %s\n",
413 case NETDEV_UNREGISTER:
414 vlan_proc_rem_dev(dev);
419 static int vlan_device_event(struct notifier_block *unused, unsigned long event,
422 struct net_device *dev = ptr;
423 struct vlan_group *grp;
425 struct net_device *vlandev;
427 if (is_vlan_dev(dev))
428 __vlan_device_event(dev, event);
430 grp = __vlan_find_group(dev);
434 /* It is OK that we do not hold the group lock right now,
435 * as we run under the RTNL lock.
440 /* Propagate real device state to vlan devices */
441 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
442 vlandev = vlan_group_get_device(grp, i);
446 vlan_transfer_operstate(dev, vlandev);
450 case NETDEV_CHANGEADDR:
451 /* Adjust unicast filters on underlying device */
452 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
453 vlandev = vlan_group_get_device(grp, i);
457 flgs = vlandev->flags;
458 if (!(flgs & IFF_UP))
461 vlan_sync_address(dev, vlandev);
465 case NETDEV_FEAT_CHANGE:
466 /* Propagate device features to underlying device */
467 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
468 vlandev = vlan_group_get_device(grp, i);
472 vlan_transfer_features(dev, vlandev);
478 /* Put all VLANs for this dev in the down state too. */
479 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
480 vlandev = vlan_group_get_device(grp, i);
484 flgs = vlandev->flags;
485 if (!(flgs & IFF_UP))
488 dev_change_flags(vlandev, flgs & ~IFF_UP);
493 /* Put all VLANs for this dev in the up state too. */
494 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
495 vlandev = vlan_group_get_device(grp, i);
499 flgs = vlandev->flags;
503 dev_change_flags(vlandev, flgs | IFF_UP);
507 case NETDEV_UNREGISTER:
508 /* Delete all VLANs for this dev. */
509 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
510 vlandev = vlan_group_get_device(grp, i);
514 /* unregistration of last vlan destroys group, abort
516 if (grp->nr_vlans == 1)
517 i = VLAN_GROUP_ARRAY_LEN;
519 unregister_vlan_dev(vlandev);
528 static struct notifier_block vlan_notifier_block __read_mostly = {
529 .notifier_call = vlan_device_event,
533 * VLAN IOCTL handler.
534 * o execute requested action or pass command to the device driver
535 * arg is really a struct vlan_ioctl_args __user *.
537 static int vlan_ioctl_handler(struct net *net, void __user *arg)
540 struct vlan_ioctl_args args;
541 struct net_device *dev = NULL;
543 if (copy_from_user(&args, arg, sizeof(struct vlan_ioctl_args)))
546 /* Null terminate this sucker, just in case. */
547 args.device1[23] = 0;
548 args.u.device2[23] = 0;
553 case SET_VLAN_INGRESS_PRIORITY_CMD:
554 case SET_VLAN_EGRESS_PRIORITY_CMD:
555 case SET_VLAN_FLAG_CMD:
558 case GET_VLAN_REALDEV_NAME_CMD:
559 case GET_VLAN_VID_CMD:
561 dev = __dev_get_by_name(net, args.device1);
566 if (args.cmd != ADD_VLAN_CMD && !is_vlan_dev(dev))
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_change_flags(dev,
595 args.vlan_qos ? args.u.flag : 0,
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 args.u.VID = vlan_dev_vlan_id(dev);
641 if (copy_to_user(arg, &args,
642 sizeof(struct vlan_ioctl_args)))
655 static int vlan_init_net(struct net *net)
661 vn = kzalloc(sizeof(struct vlan_net), GFP_KERNEL);
665 err = net_assign_generic(net, vlan_net_id, vn);
669 vn->name_type = VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD;
671 err = vlan_proc_init(net);
685 static void vlan_exit_net(struct net *net)
689 vn = net_generic(net, vlan_net_id);
690 rtnl_kill_links(net, &vlan_link_ops);
691 vlan_proc_cleanup(net);
695 static struct pernet_operations vlan_net_ops = {
696 .init = vlan_init_net,
697 .exit = vlan_exit_net,
700 static int __init vlan_proto_init(void)
704 pr_info("%s v%s %s\n", vlan_fullname, vlan_version, vlan_copyright);
705 pr_info("All bugs added by %s\n", vlan_buggyright);
707 err = register_pernet_gen_device(&vlan_net_id, &vlan_net_ops);
711 err = register_netdevice_notifier(&vlan_notifier_block);
715 err = vlan_gvrp_init();
719 err = vlan_netlink_init();
723 dev_add_pack(&vlan_packet_type);
724 vlan_ioctl_set(vlan_ioctl_handler);
730 unregister_netdevice_notifier(&vlan_notifier_block);
732 unregister_pernet_gen_device(vlan_net_id, &vlan_net_ops);
737 static void __exit vlan_cleanup_module(void)
741 vlan_ioctl_set(NULL);
744 unregister_netdevice_notifier(&vlan_notifier_block);
746 dev_remove_pack(&vlan_packet_type);
748 /* This table must be empty if there are no module references left. */
749 for (i = 0; i < VLAN_GRP_HASH_SIZE; i++)
750 BUG_ON(!hlist_empty(&vlan_group_hash[i]));
752 unregister_pernet_gen_device(vlan_net_id, &vlan_net_ops);
758 module_init(vlan_proto_init);
759 module_exit(vlan_cleanup_module);
761 MODULE_LICENSE("GPL");
762 MODULE_VERSION(DRV_VERSION);