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>
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
];
47 static char vlan_fullname
[] = "802.1Q VLAN Support";
48 static char vlan_version
[] = DRV_VERSION
;
49 static char vlan_copyright
[] = "Ben Greear <greearb@candelatech.com>";
50 static char vlan_buggyright
[] = "David S. Miller <davem@redhat.com>";
52 /* Determines interface naming scheme. */
53 unsigned short vlan_name_type
= VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD
;
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(int real_dev_ifindex
)
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_ifindex
== real_dev_ifindex
)
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
->ifindex
);
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(int ifindex
)
108 struct vlan_group
*grp
;
112 grp
= kzalloc(sizeof(struct vlan_group
), GFP_KERNEL
);
116 size
= sizeof(struct net_device
*) * VLAN_GROUP_ARRAY_PART_LEN
;
118 for (i
= 0; i
< VLAN_GROUP_ARRAY_SPLIT_PARTS
; i
++) {
119 grp
->vlan_devices_arrays
[i
] = kzalloc(size
, GFP_KERNEL
);
120 if (!grp
->vlan_devices_arrays
[i
])
124 grp
->real_dev_ifindex
= ifindex
;
125 hlist_add_head_rcu(&grp
->hlist
,
126 &vlan_group_hash
[vlan_grp_hashfn(ifindex
)]);
130 vlan_group_free(grp
);
134 static void vlan_rcu_free(struct rcu_head
*rcu
)
136 vlan_group_free(container_of(rcu
, struct vlan_group
, rcu
));
139 void unregister_vlan_dev(struct net_device
*dev
)
141 struct vlan_dev_info
*vlan
= vlan_dev_info(dev
);
142 struct net_device
*real_dev
= vlan
->real_dev
;
143 struct vlan_group
*grp
;
144 unsigned short vlan_id
= vlan
->vlan_id
;
148 grp
= __vlan_find_group(real_dev
->ifindex
);
151 vlan_proc_rem_dev(dev
);
153 /* Take it out of our own structures, but be sure to interlock with
154 * HW accelerating devices or SW vlan input packet processing.
156 if (real_dev
->features
& NETIF_F_HW_VLAN_FILTER
)
157 real_dev
->vlan_rx_kill_vid(real_dev
, vlan_id
);
159 vlan_group_set_device(grp
, vlan_id
, NULL
);
164 /* If the group is now empty, kill off the group. */
165 if (grp
->nr_vlans
== 0) {
166 if (real_dev
->features
& NETIF_F_HW_VLAN_RX
)
167 real_dev
->vlan_rx_register(real_dev
, NULL
);
169 hlist_del_rcu(&grp
->hlist
);
171 /* Free the group, after all cpu's are done. */
172 call_rcu(&grp
->rcu
, vlan_rcu_free
);
175 /* Get rid of the vlan's reference to real_dev */
178 unregister_netdevice(dev
);
181 static void vlan_transfer_operstate(const struct net_device
*dev
,
182 struct net_device
*vlandev
)
184 /* Have to respect userspace enforced dormant state
185 * of real device, also must allow supplicant running
188 if (dev
->operstate
== IF_OPER_DORMANT
)
189 netif_dormant_on(vlandev
);
191 netif_dormant_off(vlandev
);
193 if (netif_carrier_ok(dev
)) {
194 if (!netif_carrier_ok(vlandev
))
195 netif_carrier_on(vlandev
);
197 if (netif_carrier_ok(vlandev
))
198 netif_carrier_off(vlandev
);
202 int vlan_check_real_dev(struct net_device
*real_dev
, unsigned short vlan_id
)
204 char *name
= real_dev
->name
;
206 if (real_dev
->features
& NETIF_F_VLAN_CHALLENGED
) {
207 pr_info("8021q: VLANs not supported on %s\n", name
);
211 if ((real_dev
->features
& NETIF_F_HW_VLAN_RX
) &&
212 !real_dev
->vlan_rx_register
) {
213 pr_info("8021q: device %s has buggy VLAN hw accel\n", name
);
217 if ((real_dev
->features
& NETIF_F_HW_VLAN_FILTER
) &&
218 (!real_dev
->vlan_rx_add_vid
|| !real_dev
->vlan_rx_kill_vid
)) {
219 pr_info("8021q: Device %s has buggy VLAN hw accel\n", name
);
223 /* The real device must be up and operating in order to
224 * assosciate a VLAN device with it.
226 if (!(real_dev
->flags
& IFF_UP
))
229 if (__find_vlan_dev(real_dev
, vlan_id
) != NULL
)
235 int register_vlan_dev(struct net_device
*dev
)
237 struct vlan_dev_info
*vlan
= vlan_dev_info(dev
);
238 struct net_device
*real_dev
= vlan
->real_dev
;
239 unsigned short vlan_id
= vlan
->vlan_id
;
240 struct vlan_group
*grp
, *ngrp
= NULL
;
243 grp
= __vlan_find_group(real_dev
->ifindex
);
245 ngrp
= grp
= vlan_group_alloc(real_dev
->ifindex
);
250 err
= register_netdevice(dev
);
254 /* Account for reference in struct vlan_dev_info */
257 vlan_transfer_operstate(real_dev
, dev
);
258 linkwatch_fire_event(dev
); /* _MUST_ call rfc2863_policy() */
260 /* So, got the sucker initialized, now lets place
261 * it into our local structure.
263 vlan_group_set_device(grp
, vlan_id
, dev
);
266 if (ngrp
&& real_dev
->features
& NETIF_F_HW_VLAN_RX
)
267 real_dev
->vlan_rx_register(real_dev
, ngrp
);
268 if (real_dev
->features
& NETIF_F_HW_VLAN_FILTER
)
269 real_dev
->vlan_rx_add_vid(real_dev
, vlan_id
);
271 if (vlan_proc_add_dev(dev
) < 0)
272 pr_warning("8021q: failed to add proc entry for %s\n",
278 vlan_group_free(ngrp
);
282 /* Attach a VLAN device to a mac address (ie Ethernet Card).
283 * Returns 0 if the device was created or a negative error code otherwise.
285 static int register_vlan_device(struct net_device
*real_dev
,
286 unsigned short VLAN_ID
)
288 struct net_device
*new_dev
;
292 if (VLAN_ID
>= VLAN_VID_MASK
)
295 err
= vlan_check_real_dev(real_dev
, VLAN_ID
);
299 /* Gotta set up the fields for the device. */
300 switch (vlan_name_type
) {
301 case VLAN_NAME_TYPE_RAW_PLUS_VID
:
302 /* name will look like: eth1.0005 */
303 snprintf(name
, IFNAMSIZ
, "%s.%.4i", real_dev
->name
, VLAN_ID
);
305 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD
:
306 /* Put our vlan.VID in the name.
307 * Name will look like: vlan5
309 snprintf(name
, IFNAMSIZ
, "vlan%i", VLAN_ID
);
311 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD
:
312 /* Put our vlan.VID in the name.
313 * Name will look like: eth0.5
315 snprintf(name
, IFNAMSIZ
, "%s.%i", real_dev
->name
, VLAN_ID
);
317 case VLAN_NAME_TYPE_PLUS_VID
:
318 /* Put our vlan.VID in the name.
319 * Name will look like: vlan0005
322 snprintf(name
, IFNAMSIZ
, "vlan%.4i", VLAN_ID
);
325 new_dev
= alloc_netdev(sizeof(struct vlan_dev_info
), name
,
331 /* need 4 bytes for extra VLAN header info,
332 * hope the underlying device can handle it.
334 new_dev
->mtu
= real_dev
->mtu
;
336 vlan_dev_info(new_dev
)->vlan_id
= VLAN_ID
; /* 1 through VLAN_VID_MASK */
337 vlan_dev_info(new_dev
)->real_dev
= real_dev
;
338 vlan_dev_info(new_dev
)->dent
= NULL
;
339 vlan_dev_info(new_dev
)->flags
= VLAN_FLAG_REORDER_HDR
;
341 new_dev
->rtnl_link_ops
= &vlan_link_ops
;
342 err
= register_vlan_dev(new_dev
);
344 goto out_free_newdev
;
349 free_netdev(new_dev
);
353 static void vlan_sync_address(struct net_device
*dev
,
354 struct net_device
*vlandev
)
356 struct vlan_dev_info
*vlan
= vlan_dev_info(vlandev
);
358 /* May be called without an actual change */
359 if (!compare_ether_addr(vlan
->real_dev_addr
, dev
->dev_addr
))
362 /* vlan address was different from the old address and is equal to
364 if (compare_ether_addr(vlandev
->dev_addr
, vlan
->real_dev_addr
) &&
365 !compare_ether_addr(vlandev
->dev_addr
, dev
->dev_addr
))
366 dev_unicast_delete(dev
, vlandev
->dev_addr
, ETH_ALEN
);
368 /* vlan address was equal to the old address and is different from
370 if (!compare_ether_addr(vlandev
->dev_addr
, vlan
->real_dev_addr
) &&
371 compare_ether_addr(vlandev
->dev_addr
, dev
->dev_addr
))
372 dev_unicast_add(dev
, vlandev
->dev_addr
, ETH_ALEN
);
374 memcpy(vlan
->real_dev_addr
, dev
->dev_addr
, ETH_ALEN
);
377 static void __vlan_device_event(struct net_device
*dev
, unsigned long event
)
380 case NETDEV_CHANGENAME
:
381 vlan_proc_rem_dev(dev
);
382 if (vlan_proc_add_dev(dev
) < 0)
383 pr_warning("8021q: failed to change proc name for %s\n",
389 static int vlan_device_event(struct notifier_block
*unused
, unsigned long event
,
392 struct net_device
*dev
= ptr
;
393 struct vlan_group
*grp
;
395 struct net_device
*vlandev
;
397 if (dev
->nd_net
!= &init_net
)
400 if (is_vlan_dev(dev
)) {
401 __vlan_device_event(dev
, event
);
405 grp
= __vlan_find_group(dev
->ifindex
);
409 /* It is OK that we do not hold the group lock right now,
410 * as we run under the RTNL lock.
415 /* Propagate real device state to vlan devices */
416 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
417 vlandev
= vlan_group_get_device(grp
, i
);
421 vlan_transfer_operstate(dev
, vlandev
);
425 case NETDEV_CHANGEADDR
:
426 /* Adjust unicast filters on underlying device */
427 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
428 vlandev
= vlan_group_get_device(grp
, i
);
432 flgs
= vlandev
->flags
;
433 if (!(flgs
& IFF_UP
))
436 vlan_sync_address(dev
, vlandev
);
441 /* Put all VLANs for this dev in the down state too. */
442 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
443 vlandev
= vlan_group_get_device(grp
, i
);
447 flgs
= vlandev
->flags
;
448 if (!(flgs
& IFF_UP
))
451 dev_change_flags(vlandev
, flgs
& ~IFF_UP
);
456 /* Put all VLANs for this dev in the up state too. */
457 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
458 vlandev
= vlan_group_get_device(grp
, i
);
462 flgs
= vlandev
->flags
;
466 dev_change_flags(vlandev
, flgs
| IFF_UP
);
470 case NETDEV_UNREGISTER
:
471 /* Delete all VLANs for this dev. */
472 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
473 vlandev
= vlan_group_get_device(grp
, i
);
477 /* unregistration of last vlan destroys group, abort
479 if (grp
->nr_vlans
== 1)
480 i
= VLAN_GROUP_ARRAY_LEN
;
482 unregister_vlan_dev(vlandev
);
491 static struct notifier_block vlan_notifier_block __read_mostly
= {
492 .notifier_call
= vlan_device_event
,
496 * VLAN IOCTL handler.
497 * o execute requested action or pass command to the device driver
498 * arg is really a struct vlan_ioctl_args __user *.
500 static int vlan_ioctl_handler(struct net
*net
, void __user
*arg
)
503 unsigned short vid
= 0;
504 struct vlan_ioctl_args args
;
505 struct net_device
*dev
= NULL
;
507 if (copy_from_user(&args
, arg
, sizeof(struct vlan_ioctl_args
)))
510 /* Null terminate this sucker, just in case. */
511 args
.device1
[23] = 0;
512 args
.u
.device2
[23] = 0;
517 case SET_VLAN_INGRESS_PRIORITY_CMD
:
518 case SET_VLAN_EGRESS_PRIORITY_CMD
:
519 case SET_VLAN_FLAG_CMD
:
522 case GET_VLAN_REALDEV_NAME_CMD
:
523 case GET_VLAN_VID_CMD
:
525 dev
= __dev_get_by_name(&init_net
, args
.device1
);
530 if (args
.cmd
!= ADD_VLAN_CMD
&&
531 !(dev
->priv_flags
& IFF_802_1Q_VLAN
))
536 case SET_VLAN_INGRESS_PRIORITY_CMD
:
538 if (!capable(CAP_NET_ADMIN
))
540 vlan_dev_set_ingress_priority(dev
,
546 case SET_VLAN_EGRESS_PRIORITY_CMD
:
548 if (!capable(CAP_NET_ADMIN
))
550 err
= vlan_dev_set_egress_priority(dev
,
555 case SET_VLAN_FLAG_CMD
:
557 if (!capable(CAP_NET_ADMIN
))
559 err
= vlan_dev_set_vlan_flag(dev
,
564 case SET_VLAN_NAME_TYPE_CMD
:
566 if (!capable(CAP_NET_ADMIN
))
568 if ((args
.u
.name_type
>= 0) &&
569 (args
.u
.name_type
< VLAN_NAME_TYPE_HIGHEST
)) {
570 vlan_name_type
= args
.u
.name_type
;
579 if (!capable(CAP_NET_ADMIN
))
581 err
= register_vlan_device(dev
, args
.u
.VID
);
586 if (!capable(CAP_NET_ADMIN
))
588 unregister_vlan_dev(dev
);
592 case GET_VLAN_REALDEV_NAME_CMD
:
594 vlan_dev_get_realdev_name(dev
, args
.u
.device2
);
595 if (copy_to_user(arg
, &args
,
596 sizeof(struct vlan_ioctl_args
)))
600 case GET_VLAN_VID_CMD
:
602 vlan_dev_get_vid(dev
, &vid
);
604 if (copy_to_user(arg
, &args
,
605 sizeof(struct vlan_ioctl_args
)))
618 static int __init
vlan_proto_init(void)
622 pr_info("%s v%s %s\n", vlan_fullname
, vlan_version
, vlan_copyright
);
623 pr_info("All bugs added by %s\n", vlan_buggyright
);
625 err
= vlan_proc_init();
629 err
= register_netdevice_notifier(&vlan_notifier_block
);
633 err
= vlan_netlink_init();
637 dev_add_pack(&vlan_packet_type
);
638 vlan_ioctl_set(vlan_ioctl_handler
);
642 unregister_netdevice_notifier(&vlan_notifier_block
);
649 static void __exit
vlan_cleanup_module(void)
653 vlan_ioctl_set(NULL
);
656 unregister_netdevice_notifier(&vlan_notifier_block
);
658 dev_remove_pack(&vlan_packet_type
);
660 /* This table must be empty if there are no module references left. */
661 for (i
= 0; i
< VLAN_GRP_HASH_SIZE
; i
++)
662 BUG_ON(!hlist_empty(&vlan_group_hash
[i
]));
669 module_init(vlan_proto_init
);
670 module_exit(vlan_cleanup_module
);
672 MODULE_LICENSE("GPL");
673 MODULE_VERSION(DRV_VERSION
);