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>
35 #include <linux/if_vlan.h>
39 #define DRV_VERSION "1.8"
41 /* Global VLAN variables */
43 /* Our listing of VLAN group(s) */
44 static struct hlist_head vlan_group_hash
[VLAN_GRP_HASH_SIZE
];
45 #define vlan_grp_hashfn(IDX) ((((IDX) >> VLAN_GRP_HASH_SHIFT) ^ (IDX)) & VLAN_GRP_HASH_MASK)
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 static int vlan_device_event(struct notifier_block
*, unsigned long, void *);
53 static int vlan_ioctl_handler(void __user
*);
54 static int unregister_vlan_dev(struct net_device
*, unsigned short );
56 static struct notifier_block vlan_notifier_block
= {
57 .notifier_call
= vlan_device_event
,
60 /* These may be changed at run-time through IOCTLs */
62 /* Determines interface naming scheme. */
63 unsigned short vlan_name_type
= VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD
;
65 static struct packet_type vlan_packet_type
= {
66 .type
= __constant_htons(ETH_P_8021Q
),
67 .func
= vlan_skb_recv
, /* VLAN receive method */
70 /* End of global variables definitions. */
73 * Function vlan_proto_init (pro)
75 * Initialize VLAN protocol layer,
78 static int __init
vlan_proto_init(void)
82 printk(VLAN_INF
"%s v%s %s\n",
83 vlan_fullname
, vlan_version
, vlan_copyright
);
84 printk(VLAN_INF
"All bugs added by %s\n",
87 /* proc file system initialization */
88 err
= vlan_proc_init();
91 "%s %s: can't create entry in proc filesystem!\n",
92 __FUNCTION__
, VLAN_NAME
);
96 dev_add_pack(&vlan_packet_type
);
98 /* Register us to receive netdevice events */
99 err
= register_netdevice_notifier(&vlan_notifier_block
);
101 dev_remove_pack(&vlan_packet_type
);
106 vlan_ioctl_set(vlan_ioctl_handler
);
111 /* Cleanup all vlan devices
112 * Note: devices that have been registered that but not
113 * brought up will exist but have no module ref count.
115 static void __exit
vlan_cleanup_devices(void)
117 struct net_device
*dev
, *nxt
;
120 for_each_netdev_safe(dev
, nxt
) {
121 if (dev
->priv_flags
& IFF_802_1Q_VLAN
) {
122 unregister_vlan_dev(VLAN_DEV_INFO(dev
)->real_dev
,
123 VLAN_DEV_INFO(dev
)->vlan_id
);
125 unregister_netdevice(dev
);
132 * Module 'remove' entry point.
133 * o delete /proc/net/router directory and static entries.
135 static void __exit
vlan_cleanup_module(void)
139 vlan_ioctl_set(NULL
);
141 /* Un-register us from receiving netdevice events */
142 unregister_netdevice_notifier(&vlan_notifier_block
);
144 dev_remove_pack(&vlan_packet_type
);
145 vlan_cleanup_devices();
147 /* This table must be empty if there are no module
150 for (i
= 0; i
< VLAN_GRP_HASH_SIZE
; i
++) {
151 BUG_ON(!hlist_empty(&vlan_group_hash
[i
]));
158 module_init(vlan_proto_init
);
159 module_exit(vlan_cleanup_module
);
161 /* Must be invoked with RCU read lock (no preempt) */
162 static struct vlan_group
*__vlan_find_group(int real_dev_ifindex
)
164 struct vlan_group
*grp
;
165 struct hlist_node
*n
;
166 int hash
= vlan_grp_hashfn(real_dev_ifindex
);
168 hlist_for_each_entry_rcu(grp
, n
, &vlan_group_hash
[hash
], hlist
) {
169 if (grp
->real_dev_ifindex
== real_dev_ifindex
)
176 /* Find the protocol handler. Assumes VID < VLAN_VID_MASK.
178 * Must be invoked with RCU read lock (no preempt)
180 struct net_device
*__find_vlan_dev(struct net_device
*real_dev
,
183 struct vlan_group
*grp
= __vlan_find_group(real_dev
->ifindex
);
186 return vlan_group_get_device(grp
, VID
);
191 static void vlan_group_free(struct vlan_group
*grp
)
195 for (i
=0; i
< VLAN_GROUP_ARRAY_SPLIT_PARTS
; i
++)
196 kfree(grp
->vlan_devices_arrays
[i
]);
200 static struct vlan_group
*vlan_group_alloc(int ifindex
)
202 struct vlan_group
*grp
;
206 grp
= kzalloc(sizeof(struct vlan_group
), GFP_KERNEL
);
210 size
= sizeof(struct net_device
*) * VLAN_GROUP_ARRAY_PART_LEN
;
212 for (i
= 0; i
< VLAN_GROUP_ARRAY_SPLIT_PARTS
; i
++) {
213 grp
->vlan_devices_arrays
[i
] = kzalloc(size
, GFP_KERNEL
);
214 if (!grp
->vlan_devices_arrays
[i
])
218 grp
->real_dev_ifindex
= ifindex
;
219 hlist_add_head_rcu(&grp
->hlist
,
220 &vlan_group_hash
[vlan_grp_hashfn(ifindex
)]);
224 vlan_group_free(grp
);
228 static void vlan_rcu_free(struct rcu_head
*rcu
)
230 vlan_group_free(container_of(rcu
, struct vlan_group
, rcu
));
234 /* This returns 0 if everything went fine.
235 * It will return 1 if the group was killed as a result.
236 * A negative return indicates failure.
238 * The RTNL lock must be held.
240 static int unregister_vlan_dev(struct net_device
*real_dev
,
241 unsigned short vlan_id
)
243 struct net_device
*dev
= NULL
;
244 int real_dev_ifindex
= real_dev
->ifindex
;
245 struct vlan_group
*grp
;
249 printk(VLAN_DBG
"%s: VID: %i\n", __FUNCTION__
, vlan_id
);
253 if (vlan_id
>= VLAN_VID_MASK
)
257 grp
= __vlan_find_group(real_dev_ifindex
);
262 dev
= vlan_group_get_device(grp
, vlan_id
);
264 /* Remove proc entry */
265 vlan_proc_rem_dev(dev
);
267 /* Take it out of our own structures, but be sure to
268 * interlock with HW accelerating devices or SW vlan
269 * input packet processing.
271 if (real_dev
->features
& NETIF_F_HW_VLAN_FILTER
)
272 real_dev
->vlan_rx_kill_vid(real_dev
, vlan_id
);
274 vlan_group_set_device(grp
, vlan_id
, NULL
);
278 /* Caller unregisters (and if necessary, puts)
279 * VLAN device, but we get rid of the reference to
284 /* If the group is now empty, kill off the
287 for (i
= 0; i
< VLAN_VID_MASK
; i
++)
288 if (vlan_group_get_device(grp
, i
))
291 if (i
== VLAN_VID_MASK
) {
292 if (real_dev
->features
& NETIF_F_HW_VLAN_RX
)
293 real_dev
->vlan_rx_register(real_dev
, NULL
);
295 hlist_del_rcu(&grp
->hlist
);
297 /* Free the group, after all cpu's are done. */
298 call_rcu(&grp
->rcu
, vlan_rcu_free
);
309 static int unregister_vlan_device(struct net_device
*dev
)
313 ret
= unregister_vlan_dev(VLAN_DEV_INFO(dev
)->real_dev
,
314 VLAN_DEV_INFO(dev
)->vlan_id
);
315 unregister_netdevice(dev
);
323 * vlan network devices have devices nesting below it, and are a special
324 * "super class" of normal network devices; split their locks off into a
325 * separate class since they always nest.
327 static struct lock_class_key vlan_netdev_xmit_lock_key
;
329 static int vlan_dev_init(struct net_device
*dev
)
331 struct net_device
*real_dev
= VLAN_DEV_INFO(dev
)->real_dev
;
333 /* IFF_BROADCAST|IFF_MULTICAST; ??? */
334 dev
->flags
= real_dev
->flags
& ~IFF_UP
;
335 dev
->iflink
= real_dev
->ifindex
;
336 dev
->state
= (real_dev
->state
& ((1<<__LINK_STATE_NOCARRIER
) |
337 (1<<__LINK_STATE_DORMANT
))) |
338 (1<<__LINK_STATE_PRESENT
);
340 /* TODO: maybe just assign it to be ETHERNET? */
341 dev
->type
= real_dev
->type
;
343 memcpy(dev
->broadcast
, real_dev
->broadcast
, real_dev
->addr_len
);
344 memcpy(dev
->dev_addr
, real_dev
->dev_addr
, real_dev
->addr_len
);
345 dev
->addr_len
= real_dev
->addr_len
;
347 if (real_dev
->features
& NETIF_F_HW_VLAN_TX
) {
348 dev
->hard_header
= real_dev
->hard_header
;
349 dev
->hard_header_len
= real_dev
->hard_header_len
;
350 dev
->hard_start_xmit
= vlan_dev_hwaccel_hard_start_xmit
;
351 dev
->rebuild_header
= real_dev
->rebuild_header
;
353 dev
->hard_header
= vlan_dev_hard_header
;
354 dev
->hard_header_len
= real_dev
->hard_header_len
+ VLAN_HLEN
;
355 dev
->hard_start_xmit
= vlan_dev_hard_start_xmit
;
356 dev
->rebuild_header
= vlan_dev_rebuild_header
;
358 dev
->hard_header_parse
= real_dev
->hard_header_parse
;
360 lockdep_set_class(&dev
->_xmit_lock
, &vlan_netdev_xmit_lock_key
);
364 static void vlan_setup(struct net_device
*new_dev
)
366 SET_MODULE_OWNER(new_dev
);
368 /* new_dev->ifindex = 0; it will be set when added to
370 * iflink is set as well.
372 new_dev
->get_stats
= vlan_dev_get_stats
;
374 /* Make this thing known as a VLAN device */
375 new_dev
->priv_flags
|= IFF_802_1Q_VLAN
;
377 /* Set us up to have no queue, as the underlying Hardware device
378 * can do all the queueing we could want.
380 new_dev
->tx_queue_len
= 0;
382 /* set up method calls */
383 new_dev
->change_mtu
= vlan_dev_change_mtu
;
384 new_dev
->init
= vlan_dev_init
;
385 new_dev
->open
= vlan_dev_open
;
386 new_dev
->stop
= vlan_dev_stop
;
387 new_dev
->set_mac_address
= vlan_dev_set_mac_address
;
388 new_dev
->set_multicast_list
= vlan_dev_set_multicast_list
;
389 new_dev
->destructor
= free_netdev
;
390 new_dev
->do_ioctl
= vlan_dev_ioctl
;
393 static void vlan_transfer_operstate(const struct net_device
*dev
, struct net_device
*vlandev
)
395 /* Have to respect userspace enforced dormant state
396 * of real device, also must allow supplicant running
399 if (dev
->operstate
== IF_OPER_DORMANT
)
400 netif_dormant_on(vlandev
);
402 netif_dormant_off(vlandev
);
404 if (netif_carrier_ok(dev
)) {
405 if (!netif_carrier_ok(vlandev
))
406 netif_carrier_on(vlandev
);
408 if (netif_carrier_ok(vlandev
))
409 netif_carrier_off(vlandev
);
413 /* Attach a VLAN device to a mac address (ie Ethernet Card).
414 * Returns the device that was created, or NULL if there was
415 * an error of some kind.
417 static struct net_device
*register_vlan_device(struct net_device
*real_dev
,
418 unsigned short VLAN_ID
)
420 struct vlan_group
*grp
, *ngrp
= NULL
;
421 struct net_device
*new_dev
;
425 printk(VLAN_DBG
"%s: if_name -:%s:- vid: %i\n",
426 __FUNCTION__
, eth_IF_name
, VLAN_ID
);
429 if (VLAN_ID
>= VLAN_VID_MASK
)
432 if (real_dev
->features
& NETIF_F_VLAN_CHALLENGED
) {
433 printk(VLAN_DBG
"%s: VLANs not supported on %s.\n",
434 __FUNCTION__
, real_dev
->name
);
438 if ((real_dev
->features
& NETIF_F_HW_VLAN_RX
) &&
439 !real_dev
->vlan_rx_register
) {
440 printk(VLAN_DBG
"%s: Device %s has buggy VLAN hw accel.\n",
441 __FUNCTION__
, real_dev
->name
);
445 if ((real_dev
->features
& NETIF_F_HW_VLAN_FILTER
) &&
446 (!real_dev
->vlan_rx_add_vid
|| !real_dev
->vlan_rx_kill_vid
)) {
447 printk(VLAN_DBG
"%s: Device %s has buggy VLAN hw accel.\n",
448 __FUNCTION__
, real_dev
->name
);
452 /* The real device must be up and operating in order to
453 * assosciate a VLAN device with it.
455 if (!(real_dev
->flags
& IFF_UP
))
458 if (__find_vlan_dev(real_dev
, VLAN_ID
) != NULL
) {
459 /* was already registered. */
460 printk(VLAN_DBG
"%s: ALREADY had VLAN registered\n", __FUNCTION__
);
464 /* Gotta set up the fields for the device. */
466 printk(VLAN_DBG
"About to allocate name, vlan_name_type: %i\n",
469 switch (vlan_name_type
) {
470 case VLAN_NAME_TYPE_RAW_PLUS_VID
:
471 /* name will look like: eth1.0005 */
472 snprintf(name
, IFNAMSIZ
, "%s.%.4i", real_dev
->name
, VLAN_ID
);
474 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD
:
475 /* Put our vlan.VID in the name.
476 * Name will look like: vlan5
478 snprintf(name
, IFNAMSIZ
, "vlan%i", VLAN_ID
);
480 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD
:
481 /* Put our vlan.VID in the name.
482 * Name will look like: eth0.5
484 snprintf(name
, IFNAMSIZ
, "%s.%i", real_dev
->name
, VLAN_ID
);
486 case VLAN_NAME_TYPE_PLUS_VID
:
487 /* Put our vlan.VID in the name.
488 * Name will look like: vlan0005
491 snprintf(name
, IFNAMSIZ
, "vlan%.4i", VLAN_ID
);
494 new_dev
= alloc_netdev(sizeof(struct vlan_dev_info
), name
,
500 /* need 4 bytes for extra VLAN header info,
501 * hope the underlying device can handle it.
503 new_dev
->mtu
= real_dev
->mtu
;
506 printk(VLAN_DBG
"Allocated new name -:%s:-\n", new_dev
->name
);
507 VLAN_MEM_DBG("new_dev->priv malloc, addr: %p size: %i\n",
509 sizeof(struct vlan_dev_info
));
512 VLAN_DEV_INFO(new_dev
)->vlan_id
= VLAN_ID
; /* 1 through VLAN_VID_MASK */
513 VLAN_DEV_INFO(new_dev
)->real_dev
= real_dev
;
514 VLAN_DEV_INFO(new_dev
)->dent
= NULL
;
515 VLAN_DEV_INFO(new_dev
)->flags
= 1;
518 printk(VLAN_DBG
"About to go find the group for idx: %i\n",
521 grp
= __vlan_find_group(real_dev
->ifindex
);
523 ngrp
= grp
= vlan_group_alloc(real_dev
->ifindex
);
525 goto out_free_newdev
;
528 if (register_netdevice(new_dev
))
531 vlan_transfer_operstate(real_dev
, new_dev
);
532 linkwatch_fire_event(new_dev
); /* _MUST_ call rfc2863_policy() */
534 /* So, got the sucker initialized, now lets place
535 * it into our local structure.
537 if (ngrp
&& real_dev
->features
& NETIF_F_HW_VLAN_RX
)
538 real_dev
->vlan_rx_register(real_dev
, ngrp
);
540 vlan_group_set_device(grp
, VLAN_ID
, new_dev
);
542 if (vlan_proc_add_dev(new_dev
)<0)/* create it's proc entry */
543 printk(KERN_WARNING
"VLAN: failed to add proc entry for %s\n",
546 if (real_dev
->features
& NETIF_F_HW_VLAN_FILTER
)
547 real_dev
->vlan_rx_add_vid(real_dev
, VLAN_ID
);
549 /* Account for reference in struct vlan_dev_info */
552 printk(VLAN_DBG
"Allocated new device successfully, returning.\n");
558 vlan_group_free(ngrp
);
561 free_netdev(new_dev
);
567 static int vlan_device_event(struct notifier_block
*unused
, unsigned long event
, void *ptr
)
569 struct net_device
*dev
= ptr
;
570 struct vlan_group
*grp
= __vlan_find_group(dev
->ifindex
);
572 struct net_device
*vlandev
;
577 /* It is OK that we do not hold the group lock right now,
578 * as we run under the RTNL lock.
583 /* Propagate real device state to vlan devices */
584 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
585 vlandev
= vlan_group_get_device(grp
, i
);
589 vlan_transfer_operstate(dev
, vlandev
);
594 /* Put all VLANs for this dev in the down state too. */
595 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
596 vlandev
= vlan_group_get_device(grp
, i
);
600 flgs
= vlandev
->flags
;
601 if (!(flgs
& IFF_UP
))
604 dev_change_flags(vlandev
, flgs
& ~IFF_UP
);
609 /* Put all VLANs for this dev in the up state too. */
610 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
611 vlandev
= vlan_group_get_device(grp
, i
);
615 flgs
= vlandev
->flags
;
619 dev_change_flags(vlandev
, flgs
| IFF_UP
);
623 case NETDEV_UNREGISTER
:
624 /* Delete all VLANs for this dev. */
625 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
628 vlandev
= vlan_group_get_device(grp
, i
);
632 ret
= unregister_vlan_dev(dev
,
633 VLAN_DEV_INFO(vlandev
)->vlan_id
);
635 unregister_netdevice(vlandev
);
637 /* Group was destroyed? */
649 * VLAN IOCTL handler.
650 * o execute requested action or pass command to the device driver
651 * arg is really a struct vlan_ioctl_args __user *.
653 static int vlan_ioctl_handler(void __user
*arg
)
656 unsigned short vid
= 0;
657 struct vlan_ioctl_args args
;
658 struct net_device
*dev
= NULL
;
660 if (copy_from_user(&args
, arg
, sizeof(struct vlan_ioctl_args
)))
663 /* Null terminate this sucker, just in case. */
664 args
.device1
[23] = 0;
665 args
.u
.device2
[23] = 0;
668 printk(VLAN_DBG
"%s: args.cmd: %x\n", __FUNCTION__
, args
.cmd
);
674 case SET_VLAN_INGRESS_PRIORITY_CMD
:
675 case SET_VLAN_EGRESS_PRIORITY_CMD
:
676 case SET_VLAN_FLAG_CMD
:
679 case GET_VLAN_REALDEV_NAME_CMD
:
680 case GET_VLAN_VID_CMD
:
682 dev
= __dev_get_by_name(args
.device1
);
687 if (args
.cmd
!= ADD_VLAN_CMD
&&
688 !(dev
->priv_flags
& IFF_802_1Q_VLAN
))
693 case SET_VLAN_INGRESS_PRIORITY_CMD
:
695 if (!capable(CAP_NET_ADMIN
))
697 vlan_dev_set_ingress_priority(dev
,
702 case SET_VLAN_EGRESS_PRIORITY_CMD
:
704 if (!capable(CAP_NET_ADMIN
))
706 err
= vlan_dev_set_egress_priority(dev
,
711 case SET_VLAN_FLAG_CMD
:
713 if (!capable(CAP_NET_ADMIN
))
715 err
= vlan_dev_set_vlan_flag(dev
,
720 case SET_VLAN_NAME_TYPE_CMD
:
722 if (!capable(CAP_NET_ADMIN
))
724 if ((args
.u
.name_type
>= 0) &&
725 (args
.u
.name_type
< VLAN_NAME_TYPE_HIGHEST
)) {
726 vlan_name_type
= args
.u
.name_type
;
735 if (!capable(CAP_NET_ADMIN
))
737 if (register_vlan_device(dev
, args
.u
.VID
)) {
746 if (!capable(CAP_NET_ADMIN
))
748 err
= unregister_vlan_device(dev
);
751 case GET_VLAN_INGRESS_PRIORITY_CMD
:
753 err = vlan_dev_get_ingress_priority(args);
754 if (copy_to_user((void*)arg, &args,
755 sizeof(struct vlan_ioctl_args))) {
761 case GET_VLAN_EGRESS_PRIORITY_CMD
:
763 err = vlan_dev_get_egress_priority(args.device1, &(args.args);
764 if (copy_to_user((void*)arg, &args,
765 sizeof(struct vlan_ioctl_args))) {
771 case GET_VLAN_REALDEV_NAME_CMD
:
772 vlan_dev_get_realdev_name(dev
, args
.u
.device2
);
773 if (copy_to_user(arg
, &args
,
774 sizeof(struct vlan_ioctl_args
))) {
779 case GET_VLAN_VID_CMD
:
780 vlan_dev_get_vid(dev
, &vid
);
782 if (copy_to_user(arg
, &args
,
783 sizeof(struct vlan_ioctl_args
))) {
789 /* pass on to underlying device instead?? */
790 printk(VLAN_DBG
"%s: Unknown VLAN CMD: %x \n",
791 __FUNCTION__
, args
.cmd
);
800 MODULE_LICENSE("GPL");
801 MODULE_VERSION(DRV_VERSION
);