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 <linux/rculist.h>
31 #include <net/p8022.h>
33 #include <linux/rtnetlink.h>
34 #include <linux/notifier.h>
35 #include <net/net_namespace.h>
36 #include <net/netns/generic.h>
38 #include <linux/if_vlan.h>
42 #define DRV_VERSION "1.8"
44 /* Global VLAN variables */
48 /* Our listing of VLAN group(s) */
49 static struct hlist_head vlan_group_hash
[VLAN_GRP_HASH_SIZE
];
51 static char vlan_fullname
[] = "802.1Q VLAN Support";
52 static char vlan_version
[] = DRV_VERSION
;
53 static char vlan_copyright
[] = "Ben Greear <greearb@candelatech.com>";
54 static char vlan_buggyright
[] = "David S. Miller <davem@redhat.com>";
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 static inline unsigned int vlan_grp_hashfn(unsigned int idx
)
65 return ((idx
>> VLAN_GRP_HASH_SHIFT
) ^ idx
) & VLAN_GRP_HASH_MASK
;
68 /* Must be invoked with RCU read lock (no preempt) */
69 static struct vlan_group
*__vlan_find_group(struct net_device
*real_dev
)
71 struct vlan_group
*grp
;
73 int hash
= vlan_grp_hashfn(real_dev
->ifindex
);
75 hlist_for_each_entry_rcu(grp
, n
, &vlan_group_hash
[hash
], hlist
) {
76 if (grp
->real_dev
== real_dev
)
83 /* Find the protocol handler. Assumes VID < VLAN_VID_MASK.
85 * Must be invoked with RCU read lock (no preempt)
87 struct net_device
*__find_vlan_dev(struct net_device
*real_dev
,
90 struct vlan_group
*grp
= __vlan_find_group(real_dev
);
93 return vlan_group_get_device(grp
, VID
);
98 static void vlan_group_free(struct vlan_group
*grp
)
102 for (i
= 0; i
< VLAN_GROUP_ARRAY_SPLIT_PARTS
; i
++)
103 kfree(grp
->vlan_devices_arrays
[i
]);
107 static struct vlan_group
*vlan_group_alloc(struct net_device
*real_dev
)
109 struct vlan_group
*grp
;
111 grp
= kzalloc(sizeof(struct vlan_group
), GFP_KERNEL
);
115 grp
->real_dev
= real_dev
;
116 hlist_add_head_rcu(&grp
->hlist
,
117 &vlan_group_hash
[vlan_grp_hashfn(real_dev
->ifindex
)]);
121 static int vlan_group_prealloc_vid(struct vlan_group
*vg
, int vid
)
123 struct net_device
**array
;
128 array
= vg
->vlan_devices_arrays
[vid
/ VLAN_GROUP_ARRAY_PART_LEN
];
132 size
= sizeof(struct net_device
*) * VLAN_GROUP_ARRAY_PART_LEN
;
133 array
= kzalloc(size
, GFP_KERNEL
);
137 vg
->vlan_devices_arrays
[vid
/ VLAN_GROUP_ARRAY_PART_LEN
] = array
;
141 static void vlan_rcu_free(struct rcu_head
*rcu
)
143 vlan_group_free(container_of(rcu
, struct vlan_group
, rcu
));
146 void unregister_vlan_dev(struct net_device
*dev
)
148 struct vlan_dev_info
*vlan
= vlan_dev_info(dev
);
149 struct net_device
*real_dev
= vlan
->real_dev
;
150 struct vlan_group
*grp
;
151 unsigned short vlan_id
= vlan
->vlan_id
;
155 grp
= __vlan_find_group(real_dev
);
158 /* Take it out of our own structures, but be sure to interlock with
159 * HW accelerating devices or SW vlan input packet processing.
161 if (real_dev
->features
& NETIF_F_HW_VLAN_FILTER
)
162 real_dev
->vlan_rx_kill_vid(real_dev
, vlan_id
);
164 vlan_group_set_device(grp
, vlan_id
, NULL
);
169 /* If the group is now empty, kill off the group. */
170 if (grp
->nr_vlans
== 0) {
171 if (real_dev
->features
& NETIF_F_HW_VLAN_RX
)
172 real_dev
->vlan_rx_register(real_dev
, NULL
);
174 hlist_del_rcu(&grp
->hlist
);
176 /* Free the group, after all cpu's are done. */
177 call_rcu(&grp
->rcu
, vlan_rcu_free
);
180 /* Get rid of the vlan's reference to real_dev */
183 unregister_netdevice(dev
);
186 static void vlan_transfer_operstate(const struct net_device
*dev
,
187 struct net_device
*vlandev
)
189 /* Have to respect userspace enforced dormant state
190 * of real device, also must allow supplicant running
193 if (dev
->operstate
== IF_OPER_DORMANT
)
194 netif_dormant_on(vlandev
);
196 netif_dormant_off(vlandev
);
198 if (netif_carrier_ok(dev
)) {
199 if (!netif_carrier_ok(vlandev
))
200 netif_carrier_on(vlandev
);
202 if (netif_carrier_ok(vlandev
))
203 netif_carrier_off(vlandev
);
207 int vlan_check_real_dev(struct net_device
*real_dev
, unsigned short vlan_id
)
209 char *name
= real_dev
->name
;
211 if (real_dev
->features
& NETIF_F_VLAN_CHALLENGED
) {
212 pr_info("8021q: VLANs not supported on %s\n", name
);
216 if ((real_dev
->features
& NETIF_F_HW_VLAN_RX
) &&
217 !real_dev
->vlan_rx_register
) {
218 pr_info("8021q: device %s has buggy VLAN hw accel\n", name
);
222 if ((real_dev
->features
& NETIF_F_HW_VLAN_FILTER
) &&
223 (!real_dev
->vlan_rx_add_vid
|| !real_dev
->vlan_rx_kill_vid
)) {
224 pr_info("8021q: Device %s has buggy VLAN hw accel\n", name
);
228 /* The real device must be up and operating in order to
229 * assosciate a VLAN device with it.
231 if (!(real_dev
->flags
& IFF_UP
))
234 if (__find_vlan_dev(real_dev
, vlan_id
) != NULL
)
240 int register_vlan_dev(struct net_device
*dev
)
242 struct vlan_dev_info
*vlan
= vlan_dev_info(dev
);
243 struct net_device
*real_dev
= vlan
->real_dev
;
244 unsigned short vlan_id
= vlan
->vlan_id
;
245 struct vlan_group
*grp
, *ngrp
= NULL
;
248 grp
= __vlan_find_group(real_dev
);
250 ngrp
= grp
= vlan_group_alloc(real_dev
);
255 err
= vlan_group_prealloc_vid(grp
, vlan_id
);
259 err
= register_netdevice(dev
);
263 /* Account for reference in struct vlan_dev_info */
266 vlan_transfer_operstate(real_dev
, dev
);
267 linkwatch_fire_event(dev
); /* _MUST_ call rfc2863_policy() */
269 /* So, got the sucker initialized, now lets place
270 * it into our local structure.
272 vlan_group_set_device(grp
, vlan_id
, dev
);
275 if (ngrp
&& real_dev
->features
& NETIF_F_HW_VLAN_RX
)
276 real_dev
->vlan_rx_register(real_dev
, ngrp
);
277 if (real_dev
->features
& NETIF_F_HW_VLAN_FILTER
)
278 real_dev
->vlan_rx_add_vid(real_dev
, vlan_id
);
284 vlan_group_free(ngrp
);
288 /* Attach a VLAN device to a mac address (ie Ethernet Card).
289 * Returns 0 if the device was created or a negative error code otherwise.
291 static int register_vlan_device(struct net_device
*real_dev
,
292 unsigned short VLAN_ID
)
294 struct net_device
*new_dev
;
295 struct net
*net
= dev_net(real_dev
);
296 struct vlan_net
*vn
= net_generic(net
, vlan_net_id
);
300 if (VLAN_ID
>= VLAN_VID_MASK
)
303 err
= vlan_check_real_dev(real_dev
, VLAN_ID
);
307 /* Gotta set up the fields for the device. */
308 switch (vn
->name_type
) {
309 case VLAN_NAME_TYPE_RAW_PLUS_VID
:
310 /* name will look like: eth1.0005 */
311 snprintf(name
, IFNAMSIZ
, "%s.%.4i", real_dev
->name
, VLAN_ID
);
313 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD
:
314 /* Put our vlan.VID in the name.
315 * Name will look like: vlan5
317 snprintf(name
, IFNAMSIZ
, "vlan%i", VLAN_ID
);
319 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD
:
320 /* Put our vlan.VID in the name.
321 * Name will look like: eth0.5
323 snprintf(name
, IFNAMSIZ
, "%s.%i", real_dev
->name
, VLAN_ID
);
325 case VLAN_NAME_TYPE_PLUS_VID
:
326 /* Put our vlan.VID in the name.
327 * Name will look like: vlan0005
330 snprintf(name
, IFNAMSIZ
, "vlan%.4i", VLAN_ID
);
333 new_dev
= alloc_netdev(sizeof(struct vlan_dev_info
), name
,
339 dev_net_set(new_dev
, net
);
340 /* need 4 bytes for extra VLAN header info,
341 * hope the underlying device can handle it.
343 new_dev
->mtu
= real_dev
->mtu
;
345 vlan_dev_info(new_dev
)->vlan_id
= VLAN_ID
; /* 1 through VLAN_VID_MASK */
346 vlan_dev_info(new_dev
)->real_dev
= real_dev
;
347 vlan_dev_info(new_dev
)->dent
= NULL
;
348 vlan_dev_info(new_dev
)->flags
= VLAN_FLAG_REORDER_HDR
;
350 new_dev
->rtnl_link_ops
= &vlan_link_ops
;
351 err
= register_vlan_dev(new_dev
);
353 goto out_free_newdev
;
358 free_netdev(new_dev
);
362 static void vlan_sync_address(struct net_device
*dev
,
363 struct net_device
*vlandev
)
365 struct vlan_dev_info
*vlan
= vlan_dev_info(vlandev
);
367 /* May be called without an actual change */
368 if (!compare_ether_addr(vlan
->real_dev_addr
, dev
->dev_addr
))
371 /* vlan address was different from the old address and is equal to
373 if (compare_ether_addr(vlandev
->dev_addr
, vlan
->real_dev_addr
) &&
374 !compare_ether_addr(vlandev
->dev_addr
, dev
->dev_addr
))
375 dev_unicast_delete(dev
, vlandev
->dev_addr
, ETH_ALEN
);
377 /* vlan address was equal to the old address and is different from
379 if (!compare_ether_addr(vlandev
->dev_addr
, vlan
->real_dev_addr
) &&
380 compare_ether_addr(vlandev
->dev_addr
, dev
->dev_addr
))
381 dev_unicast_add(dev
, vlandev
->dev_addr
, ETH_ALEN
);
383 memcpy(vlan
->real_dev_addr
, dev
->dev_addr
, ETH_ALEN
);
386 static void vlan_transfer_features(struct net_device
*dev
,
387 struct net_device
*vlandev
)
389 unsigned long old_features
= vlandev
->features
;
391 vlandev
->features
&= ~dev
->vlan_features
;
392 vlandev
->features
|= dev
->features
& dev
->vlan_features
;
394 if (old_features
!= vlandev
->features
)
395 netdev_features_change(vlandev
);
398 static void __vlan_device_event(struct net_device
*dev
, unsigned long event
)
401 case NETDEV_CHANGENAME
:
402 vlan_proc_rem_dev(dev
);
403 if (vlan_proc_add_dev(dev
) < 0)
404 pr_warning("8021q: failed to change proc name for %s\n",
407 case NETDEV_REGISTER
:
408 if (vlan_proc_add_dev(dev
) < 0)
409 pr_warning("8021q: failed to add proc entry for %s\n",
412 case NETDEV_UNREGISTER
:
413 vlan_proc_rem_dev(dev
);
418 static int vlan_device_event(struct notifier_block
*unused
, unsigned long event
,
421 struct net_device
*dev
= ptr
;
422 struct vlan_group
*grp
;
424 struct net_device
*vlandev
;
426 if (is_vlan_dev(dev
))
427 __vlan_device_event(dev
, event
);
429 grp
= __vlan_find_group(dev
);
433 /* It is OK that we do not hold the group lock right now,
434 * as we run under the RTNL lock.
439 /* Propagate real device state to vlan devices */
440 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
441 vlandev
= vlan_group_get_device(grp
, i
);
445 vlan_transfer_operstate(dev
, vlandev
);
449 case NETDEV_CHANGEADDR
:
450 /* Adjust unicast filters on underlying device */
451 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
452 vlandev
= vlan_group_get_device(grp
, i
);
456 flgs
= vlandev
->flags
;
457 if (!(flgs
& IFF_UP
))
460 vlan_sync_address(dev
, vlandev
);
464 case NETDEV_FEAT_CHANGE
:
465 /* Propagate device features to underlying device */
466 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
467 vlandev
= vlan_group_get_device(grp
, i
);
471 vlan_transfer_features(dev
, vlandev
);
477 /* Put all VLANs for this dev in the down state too. */
478 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
479 vlandev
= vlan_group_get_device(grp
, i
);
483 flgs
= vlandev
->flags
;
484 if (!(flgs
& IFF_UP
))
487 dev_change_flags(vlandev
, flgs
& ~IFF_UP
);
492 /* Put all VLANs for this dev in the up state too. */
493 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
494 vlandev
= vlan_group_get_device(grp
, i
);
498 flgs
= vlandev
->flags
;
502 dev_change_flags(vlandev
, flgs
| IFF_UP
);
506 case NETDEV_UNREGISTER
:
507 /* Delete all VLANs for this dev. */
508 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
509 vlandev
= vlan_group_get_device(grp
, i
);
513 /* unregistration of last vlan destroys group, abort
515 if (grp
->nr_vlans
== 1)
516 i
= VLAN_GROUP_ARRAY_LEN
;
518 unregister_vlan_dev(vlandev
);
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
)
539 unsigned short vid
= 0;
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
&&
567 !(dev
->priv_flags
& IFF_802_1Q_VLAN
))
572 case SET_VLAN_INGRESS_PRIORITY_CMD
:
574 if (!capable(CAP_NET_ADMIN
))
576 vlan_dev_set_ingress_priority(dev
,
582 case SET_VLAN_EGRESS_PRIORITY_CMD
:
584 if (!capable(CAP_NET_ADMIN
))
586 err
= vlan_dev_set_egress_priority(dev
,
591 case SET_VLAN_FLAG_CMD
:
593 if (!capable(CAP_NET_ADMIN
))
595 err
= vlan_dev_set_vlan_flag(dev
,
600 case SET_VLAN_NAME_TYPE_CMD
:
602 if (!capable(CAP_NET_ADMIN
))
604 if ((args
.u
.name_type
>= 0) &&
605 (args
.u
.name_type
< VLAN_NAME_TYPE_HIGHEST
)) {
608 vn
= net_generic(net
, vlan_net_id
);
609 vn
->name_type
= args
.u
.name_type
;
618 if (!capable(CAP_NET_ADMIN
))
620 err
= register_vlan_device(dev
, args
.u
.VID
);
625 if (!capable(CAP_NET_ADMIN
))
627 unregister_vlan_dev(dev
);
631 case GET_VLAN_REALDEV_NAME_CMD
:
633 vlan_dev_get_realdev_name(dev
, args
.u
.device2
);
634 if (copy_to_user(arg
, &args
,
635 sizeof(struct vlan_ioctl_args
)))
639 case GET_VLAN_VID_CMD
:
641 vlan_dev_get_vid(dev
, &vid
);
643 if (copy_to_user(arg
, &args
,
644 sizeof(struct vlan_ioctl_args
)))
657 static int vlan_init_net(struct net
*net
)
663 vn
= kzalloc(sizeof(struct vlan_net
), GFP_KERNEL
);
667 err
= net_assign_generic(net
, vlan_net_id
, vn
);
671 vn
->name_type
= VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD
;
673 err
= vlan_proc_init(net
);
687 static void vlan_exit_net(struct net
*net
)
691 vn
= net_generic(net
, vlan_net_id
);
692 rtnl_kill_links(net
, &vlan_link_ops
);
693 vlan_proc_cleanup(net
);
697 static struct pernet_operations vlan_net_ops
= {
698 .init
= vlan_init_net
,
699 .exit
= vlan_exit_net
,
702 static int __init
vlan_proto_init(void)
706 pr_info("%s v%s %s\n", vlan_fullname
, vlan_version
, vlan_copyright
);
707 pr_info("All bugs added by %s\n", vlan_buggyright
);
709 err
= register_pernet_gen_device(&vlan_net_id
, &vlan_net_ops
);
713 err
= register_netdevice_notifier(&vlan_notifier_block
);
717 err
= vlan_netlink_init();
721 dev_add_pack(&vlan_packet_type
);
722 vlan_ioctl_set(vlan_ioctl_handler
);
726 unregister_netdevice_notifier(&vlan_notifier_block
);
728 unregister_pernet_gen_device(vlan_net_id
, &vlan_net_ops
);
733 static void __exit
vlan_cleanup_module(void)
737 vlan_ioctl_set(NULL
);
740 unregister_netdevice_notifier(&vlan_notifier_block
);
742 dev_remove_pack(&vlan_packet_type
);
744 /* This table must be empty if there are no module references left. */
745 for (i
= 0; i
< VLAN_GRP_HASH_SIZE
; i
++)
746 BUG_ON(!hlist_empty(&vlan_group_hash
[i
]));
748 unregister_pernet_gen_device(vlan_net_id
, &vlan_net_ops
);
753 module_init(vlan_proto_init
);
754 module_exit(vlan_cleanup_module
);
756 MODULE_LICENSE("GPL");
757 MODULE_VERSION(DRV_VERSION
);