3 * Ethernet-type device handling.
5 * Authors: Ben Greear <greearb@candelatech.com>
6 * Please send support related email to: vlan@scry.wanfear.com
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>
36 #include <linux/if_vlan.h>
40 #define DRV_VERSION "1.8"
42 /* Global VLAN variables */
44 /* Our listing of VLAN group(s) */
45 static struct hlist_head vlan_group_hash[VLAN_GRP_HASH_SIZE];
46 #define vlan_grp_hashfn(IDX) ((((IDX) >> VLAN_GRP_HASH_SHIFT) ^ (IDX)) & VLAN_GRP_HASH_MASK)
48 static char vlan_fullname[] = "802.1Q VLAN Support";
49 static char vlan_version[] = DRV_VERSION;
50 static char vlan_copyright[] = "Ben Greear <greearb@candelatech.com>";
51 static char vlan_buggyright[] = "David S. Miller <davem@redhat.com>";
53 /* Determines interface naming scheme. */
54 unsigned short vlan_name_type = VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD;
56 static struct packet_type vlan_packet_type = {
57 .type = __constant_htons(ETH_P_8021Q),
58 .func = vlan_skb_recv, /* VLAN receive method */
61 /* End of global variables definitions. */
63 /* Must be invoked with RCU read lock (no preempt) */
64 static struct vlan_group *__vlan_find_group(int real_dev_ifindex)
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_ifindex == real_dev_ifindex)
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,
85 struct vlan_group *grp = __vlan_find_group(real_dev->ifindex);
88 return vlan_group_get_device(grp, VID);
93 static void vlan_group_free(struct vlan_group *grp)
97 for (i=0; i < VLAN_GROUP_ARRAY_SPLIT_PARTS; i++)
98 kfree(grp->vlan_devices_arrays[i]);
102 static struct vlan_group *vlan_group_alloc(int ifindex)
104 struct vlan_group *grp;
108 grp = kzalloc(sizeof(struct vlan_group), GFP_KERNEL);
112 size = sizeof(struct net_device *) * VLAN_GROUP_ARRAY_PART_LEN;
114 for (i = 0; i < VLAN_GROUP_ARRAY_SPLIT_PARTS; i++) {
115 grp->vlan_devices_arrays[i] = kzalloc(size, GFP_KERNEL);
116 if (!grp->vlan_devices_arrays[i])
120 grp->real_dev_ifindex = ifindex;
121 hlist_add_head_rcu(&grp->hlist,
122 &vlan_group_hash[vlan_grp_hashfn(ifindex)]);
126 vlan_group_free(grp);
130 static void vlan_rcu_free(struct rcu_head *rcu)
132 vlan_group_free(container_of(rcu, struct vlan_group, rcu));
136 /* This returns 0 if everything went fine.
137 * It will return 1 if the group was killed as a result.
138 * A negative return indicates failure.
140 * The RTNL lock must be held.
142 static int unregister_vlan_dev(struct net_device *real_dev,
143 unsigned short vlan_id)
145 struct net_device *dev = NULL;
146 int real_dev_ifindex = real_dev->ifindex;
147 struct vlan_group *grp;
151 if (vlan_id >= VLAN_VID_MASK)
155 grp = __vlan_find_group(real_dev_ifindex);
160 dev = vlan_group_get_device(grp, vlan_id);
162 /* Remove proc entry */
163 vlan_proc_rem_dev(dev);
165 /* Take it out of our own structures, but be sure to
166 * interlock with HW accelerating devices or SW vlan
167 * input packet processing.
169 if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
170 real_dev->vlan_rx_kill_vid(real_dev, vlan_id);
172 vlan_group_set_device(grp, vlan_id, NULL);
176 /* Caller unregisters (and if necessary, puts)
177 * VLAN device, but we get rid of the reference to
182 /* If the group is now empty, kill off the
185 for (i = 0; i < VLAN_VID_MASK; i++)
186 if (vlan_group_get_device(grp, i))
189 if (i == VLAN_VID_MASK) {
190 if (real_dev->features & NETIF_F_HW_VLAN_RX)
191 real_dev->vlan_rx_register(real_dev, NULL);
193 hlist_del_rcu(&grp->hlist);
195 /* Free the group, after all cpu's are done. */
196 call_rcu(&grp->rcu, vlan_rcu_free);
207 int unregister_vlan_device(struct net_device *dev)
211 ret = unregister_vlan_dev(VLAN_DEV_INFO(dev)->real_dev,
212 VLAN_DEV_INFO(dev)->vlan_id);
213 unregister_netdevice(dev);
220 static void vlan_transfer_operstate(const struct net_device *dev, struct net_device *vlandev)
222 /* Have to respect userspace enforced dormant state
223 * of real device, also must allow supplicant running
226 if (dev->operstate == IF_OPER_DORMANT)
227 netif_dormant_on(vlandev);
229 netif_dormant_off(vlandev);
231 if (netif_carrier_ok(dev)) {
232 if (!netif_carrier_ok(vlandev))
233 netif_carrier_on(vlandev);
235 if (netif_carrier_ok(vlandev))
236 netif_carrier_off(vlandev);
240 int vlan_check_real_dev(struct net_device *real_dev, unsigned short vlan_id)
242 char *name = real_dev->name;
244 if (real_dev->features & NETIF_F_VLAN_CHALLENGED) {
245 pr_info("8021q: VLANs not supported on %s\n", name);
249 if ((real_dev->features & NETIF_F_HW_VLAN_RX) &&
250 !real_dev->vlan_rx_register) {
251 pr_info("8021q: device %s has buggy VLAN hw accel\n", name);
255 if ((real_dev->features & NETIF_F_HW_VLAN_FILTER) &&
256 (!real_dev->vlan_rx_add_vid || !real_dev->vlan_rx_kill_vid)) {
257 pr_info("8021q: Device %s has buggy VLAN hw accel\n", name);
261 /* The real device must be up and operating in order to
262 * assosciate a VLAN device with it.
264 if (!(real_dev->flags & IFF_UP))
267 if (__find_vlan_dev(real_dev, vlan_id) != NULL)
273 int register_vlan_dev(struct net_device *dev)
275 struct vlan_dev_info *vlan = VLAN_DEV_INFO(dev);
276 struct net_device *real_dev = vlan->real_dev;
277 unsigned short vlan_id = vlan->vlan_id;
278 struct vlan_group *grp, *ngrp = NULL;
281 grp = __vlan_find_group(real_dev->ifindex);
283 ngrp = grp = vlan_group_alloc(real_dev->ifindex);
288 err = register_netdevice(dev);
292 /* Account for reference in struct vlan_dev_info */
295 vlan_transfer_operstate(real_dev, dev);
296 linkwatch_fire_event(dev); /* _MUST_ call rfc2863_policy() */
298 /* So, got the sucker initialized, now lets place
299 * it into our local structure.
301 vlan_group_set_device(grp, vlan_id, dev);
302 if (ngrp && real_dev->features & NETIF_F_HW_VLAN_RX)
303 real_dev->vlan_rx_register(real_dev, ngrp);
304 if (real_dev->features & NETIF_F_HW_VLAN_FILTER)
305 real_dev->vlan_rx_add_vid(real_dev, vlan_id);
307 if (vlan_proc_add_dev(dev) < 0)
308 pr_warning("8021q: failed to add proc entry for %s\n",
314 vlan_group_free(ngrp);
318 /* Attach a VLAN device to a mac address (ie Ethernet Card).
319 * Returns 0 if the device was created or a negative error code otherwise.
321 static int register_vlan_device(struct net_device *real_dev,
322 unsigned short VLAN_ID)
324 struct net_device *new_dev;
328 if (VLAN_ID >= VLAN_VID_MASK)
331 err = vlan_check_real_dev(real_dev, VLAN_ID);
335 /* Gotta set up the fields for the device. */
336 switch (vlan_name_type) {
337 case VLAN_NAME_TYPE_RAW_PLUS_VID:
338 /* name will look like: eth1.0005 */
339 snprintf(name, IFNAMSIZ, "%s.%.4i", real_dev->name, VLAN_ID);
341 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD:
342 /* Put our vlan.VID in the name.
343 * Name will look like: vlan5
345 snprintf(name, IFNAMSIZ, "vlan%i", VLAN_ID);
347 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD:
348 /* Put our vlan.VID in the name.
349 * Name will look like: eth0.5
351 snprintf(name, IFNAMSIZ, "%s.%i", real_dev->name, VLAN_ID);
353 case VLAN_NAME_TYPE_PLUS_VID:
354 /* Put our vlan.VID in the name.
355 * Name will look like: vlan0005
358 snprintf(name, IFNAMSIZ, "vlan%.4i", VLAN_ID);
361 new_dev = alloc_netdev(sizeof(struct vlan_dev_info), name,
367 /* need 4 bytes for extra VLAN header info,
368 * hope the underlying device can handle it.
370 new_dev->mtu = real_dev->mtu;
372 VLAN_DEV_INFO(new_dev)->vlan_id = VLAN_ID; /* 1 through VLAN_VID_MASK */
373 VLAN_DEV_INFO(new_dev)->real_dev = real_dev;
374 VLAN_DEV_INFO(new_dev)->dent = NULL;
375 VLAN_DEV_INFO(new_dev)->flags = VLAN_FLAG_REORDER_HDR;
377 new_dev->rtnl_link_ops = &vlan_link_ops;
378 err = register_vlan_dev(new_dev);
380 goto out_free_newdev;
385 free_netdev(new_dev);
389 static void vlan_sync_address(struct net_device *dev,
390 struct net_device *vlandev)
392 struct vlan_dev_info *vlan = VLAN_DEV_INFO(vlandev);
394 /* May be called without an actual change */
395 if (!compare_ether_addr(vlan->real_dev_addr, dev->dev_addr))
398 /* vlan address was different from the old address and is equal to
400 if (compare_ether_addr(vlandev->dev_addr, vlan->real_dev_addr) &&
401 !compare_ether_addr(vlandev->dev_addr, dev->dev_addr))
402 dev_unicast_delete(dev, vlandev->dev_addr, ETH_ALEN);
404 /* vlan address was equal to the old address and is different from
406 if (!compare_ether_addr(vlandev->dev_addr, vlan->real_dev_addr) &&
407 compare_ether_addr(vlandev->dev_addr, dev->dev_addr))
408 dev_unicast_add(dev, vlandev->dev_addr, ETH_ALEN);
410 memcpy(vlan->real_dev_addr, dev->dev_addr, ETH_ALEN);
413 static int vlan_device_event(struct notifier_block *unused, unsigned long event, void *ptr)
415 struct net_device *dev = ptr;
416 struct vlan_group *grp = __vlan_find_group(dev->ifindex);
418 struct net_device *vlandev;
420 if (dev->nd_net != &init_net)
426 /* It is OK that we do not hold the group lock right now,
427 * as we run under the RTNL lock.
432 /* Propagate real device state to vlan devices */
433 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
434 vlandev = vlan_group_get_device(grp, i);
438 vlan_transfer_operstate(dev, vlandev);
442 case NETDEV_CHANGEADDR:
443 /* Adjust unicast filters on underlying device */
444 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
445 vlandev = vlan_group_get_device(grp, i);
449 flgs = vlandev->flags;
450 if (!(flgs & IFF_UP))
453 vlan_sync_address(dev, vlandev);
458 /* Put all VLANs for this dev in the down state too. */
459 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
460 vlandev = vlan_group_get_device(grp, i);
464 flgs = vlandev->flags;
465 if (!(flgs & IFF_UP))
468 dev_change_flags(vlandev, flgs & ~IFF_UP);
473 /* Put all VLANs for this dev in the up state too. */
474 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
475 vlandev = vlan_group_get_device(grp, i);
479 flgs = vlandev->flags;
483 dev_change_flags(vlandev, flgs | IFF_UP);
487 case NETDEV_UNREGISTER:
488 /* Delete all VLANs for this dev. */
489 for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
492 vlandev = vlan_group_get_device(grp, i);
496 ret = unregister_vlan_dev(dev,
497 VLAN_DEV_INFO(vlandev)->vlan_id);
499 unregister_netdevice(vlandev);
501 /* Group was destroyed? */
512 static struct notifier_block vlan_notifier_block __read_mostly = {
513 .notifier_call = vlan_device_event,
517 * VLAN IOCTL handler.
518 * o execute requested action or pass command to the device driver
519 * arg is really a struct vlan_ioctl_args __user *.
521 static int vlan_ioctl_handler(struct net *net, void __user *arg)
524 unsigned short vid = 0;
525 struct vlan_ioctl_args args;
526 struct net_device *dev = NULL;
528 if (copy_from_user(&args, arg, sizeof(struct vlan_ioctl_args)))
531 /* Null terminate this sucker, just in case. */
532 args.device1[23] = 0;
533 args.u.device2[23] = 0;
538 case SET_VLAN_INGRESS_PRIORITY_CMD:
539 case SET_VLAN_EGRESS_PRIORITY_CMD:
540 case SET_VLAN_FLAG_CMD:
543 case GET_VLAN_REALDEV_NAME_CMD:
544 case GET_VLAN_VID_CMD:
546 dev = __dev_get_by_name(&init_net, args.device1);
551 if (args.cmd != ADD_VLAN_CMD &&
552 !(dev->priv_flags & IFF_802_1Q_VLAN))
557 case SET_VLAN_INGRESS_PRIORITY_CMD:
559 if (!capable(CAP_NET_ADMIN))
561 vlan_dev_set_ingress_priority(dev,
567 case SET_VLAN_EGRESS_PRIORITY_CMD:
569 if (!capable(CAP_NET_ADMIN))
571 err = vlan_dev_set_egress_priority(dev,
576 case SET_VLAN_FLAG_CMD:
578 if (!capable(CAP_NET_ADMIN))
580 err = vlan_dev_set_vlan_flag(dev,
585 case SET_VLAN_NAME_TYPE_CMD:
587 if (!capable(CAP_NET_ADMIN))
589 if ((args.u.name_type >= 0) &&
590 (args.u.name_type < VLAN_NAME_TYPE_HIGHEST)) {
591 vlan_name_type = args.u.name_type;
600 if (!capable(CAP_NET_ADMIN))
602 err = register_vlan_device(dev, args.u.VID);
607 if (!capable(CAP_NET_ADMIN))
609 err = unregister_vlan_device(dev);
612 case GET_VLAN_REALDEV_NAME_CMD:
614 vlan_dev_get_realdev_name(dev, args.u.device2);
615 if (copy_to_user(arg, &args,
616 sizeof(struct vlan_ioctl_args))) {
621 case GET_VLAN_VID_CMD:
623 vlan_dev_get_vid(dev, &vid);
625 if (copy_to_user(arg, &args,
626 sizeof(struct vlan_ioctl_args))) {
640 static int __init vlan_proto_init(void)
644 pr_info("%s v%s %s\n", vlan_fullname, vlan_version, vlan_copyright);
645 pr_info("All bugs added by %s\n", vlan_buggyright);
647 err = vlan_proc_init();
651 err = register_netdevice_notifier(&vlan_notifier_block);
655 err = vlan_netlink_init();
659 dev_add_pack(&vlan_packet_type);
660 vlan_ioctl_set(vlan_ioctl_handler);
664 unregister_netdevice_notifier(&vlan_notifier_block);
671 static void __exit vlan_cleanup_module(void)
675 vlan_ioctl_set(NULL);
678 unregister_netdevice_notifier(&vlan_notifier_block);
680 dev_remove_pack(&vlan_packet_type);
682 /* This table must be empty if there are no module references left. */
683 for (i = 0; i < VLAN_GRP_HASH_SIZE; i++)
684 BUG_ON(!hlist_empty(&vlan_group_hash[i]));
691 module_init(vlan_proto_init);
692 module_exit(vlan_cleanup_module);
694 MODULE_LICENSE("GPL");
695 MODULE_VERSION(DRV_VERSION);