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/module.h>
23 #include <linux/netdevice.h>
24 #include <linux/skbuff.h>
25 #include <net/datalink.h>
28 #include <linux/init.h>
29 #include <net/p8022.h>
31 #include <linux/rtnetlink.h>
32 #include <linux/notifier.h>
34 #include <linux/if_vlan.h>
38 #define DRV_VERSION "1.8"
40 /* Global VLAN variables */
42 /* Our listing of VLAN group(s) */
43 static struct hlist_head vlan_group_hash
[VLAN_GRP_HASH_SIZE
];
44 #define vlan_grp_hashfn(IDX) ((((IDX) >> VLAN_GRP_HASH_SHIFT) ^ (IDX)) & VLAN_GRP_HASH_MASK)
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 int vlan_device_event(struct notifier_block
*, unsigned long, void *);
52 static int vlan_ioctl_handler(void __user
*);
53 static int unregister_vlan_dev(struct net_device
*, unsigned short );
55 static struct notifier_block vlan_notifier_block
= {
56 .notifier_call
= vlan_device_event
,
59 /* These may be changed at run-time through IOCTLs */
61 /* Determines interface naming scheme. */
62 unsigned short vlan_name_type
= VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD
;
64 static struct packet_type vlan_packet_type
= {
65 .type
= __constant_htons(ETH_P_8021Q
),
66 .func
= vlan_skb_recv
, /* VLAN receive method */
69 /* Bits of netdev state that are propagated from real device to virtual */
70 #define VLAN_LINK_STATE_MASK \
71 ((1<<__LINK_STATE_PRESENT)|(1<<__LINK_STATE_NOCARRIER))
73 /* End of global variables definitions. */
76 * Function vlan_proto_init (pro)
78 * Initialize VLAN protocol layer,
81 static int __init
vlan_proto_init(void)
85 printk(VLAN_INF
"%s v%s %s\n",
86 vlan_fullname
, vlan_version
, vlan_copyright
);
87 printk(VLAN_INF
"All bugs added by %s\n",
90 /* proc file system initialization */
91 err
= vlan_proc_init();
94 "%s %s: can't create entry in proc filesystem!\n",
95 __FUNCTION__
, VLAN_NAME
);
99 dev_add_pack(&vlan_packet_type
);
101 /* Register us to receive netdevice events */
102 err
= register_netdevice_notifier(&vlan_notifier_block
);
104 dev_remove_pack(&vlan_packet_type
);
109 vlan_ioctl_set(vlan_ioctl_handler
);
114 /* Cleanup all vlan devices
115 * Note: devices that have been registered that but not
116 * brought up will exist but have no module ref count.
118 static void __exit
vlan_cleanup_devices(void)
120 struct net_device
*dev
, *nxt
;
123 for (dev
= dev_base
; dev
; dev
= nxt
) {
125 if (dev
->priv_flags
& IFF_802_1Q_VLAN
) {
126 unregister_vlan_dev(VLAN_DEV_INFO(dev
)->real_dev
,
127 VLAN_DEV_INFO(dev
)->vlan_id
);
129 unregister_netdevice(dev
);
136 * Module 'remove' entry point.
137 * o delete /proc/net/router directory and static entries.
139 static void __exit
vlan_cleanup_module(void)
143 vlan_ioctl_set(NULL
);
145 /* Un-register us from receiving netdevice events */
146 unregister_netdevice_notifier(&vlan_notifier_block
);
148 dev_remove_pack(&vlan_packet_type
);
149 vlan_cleanup_devices();
151 /* This table must be empty if there are no module
154 for (i
= 0; i
< VLAN_GRP_HASH_SIZE
; i
++) {
155 BUG_ON(!hlist_empty(&vlan_group_hash
[i
]));
162 module_init(vlan_proto_init
);
163 module_exit(vlan_cleanup_module
);
165 /* Must be invoked with RCU read lock (no preempt) */
166 static struct vlan_group
*__vlan_find_group(int real_dev_ifindex
)
168 struct vlan_group
*grp
;
169 struct hlist_node
*n
;
170 int hash
= vlan_grp_hashfn(real_dev_ifindex
);
172 hlist_for_each_entry_rcu(grp
, n
, &vlan_group_hash
[hash
], hlist
) {
173 if (grp
->real_dev_ifindex
== real_dev_ifindex
)
180 /* Find the protocol handler. Assumes VID < VLAN_VID_MASK.
182 * Must be invoked with RCU read lock (no preempt)
184 struct net_device
*__find_vlan_dev(struct net_device
*real_dev
,
187 struct vlan_group
*grp
= __vlan_find_group(real_dev
->ifindex
);
190 return grp
->vlan_devices
[VID
];
195 static void vlan_rcu_free(struct rcu_head
*rcu
)
197 kfree(container_of(rcu
, struct vlan_group
, rcu
));
201 /* This returns 0 if everything went fine.
202 * It will return 1 if the group was killed as a result.
203 * A negative return indicates failure.
205 * The RTNL lock must be held.
207 static int unregister_vlan_dev(struct net_device
*real_dev
,
208 unsigned short vlan_id
)
210 struct net_device
*dev
= NULL
;
211 int real_dev_ifindex
= real_dev
->ifindex
;
212 struct vlan_group
*grp
;
216 printk(VLAN_DBG
"%s: VID: %i\n", __FUNCTION__
, vlan_id
);
220 if (vlan_id
>= VLAN_VID_MASK
)
224 grp
= __vlan_find_group(real_dev_ifindex
);
229 dev
= grp
->vlan_devices
[vlan_id
];
231 /* Remove proc entry */
232 vlan_proc_rem_dev(dev
);
234 /* Take it out of our own structures, but be sure to
235 * interlock with HW accelerating devices or SW vlan
236 * input packet processing.
238 if (real_dev
->features
&
239 (NETIF_F_HW_VLAN_RX
| NETIF_F_HW_VLAN_FILTER
)) {
240 real_dev
->vlan_rx_kill_vid(real_dev
, vlan_id
);
243 grp
->vlan_devices
[vlan_id
] = NULL
;
247 /* Caller unregisters (and if necessary, puts)
248 * VLAN device, but we get rid of the reference to
253 /* If the group is now empty, kill off the
256 for (i
= 0; i
< VLAN_VID_MASK
; i
++)
257 if (grp
->vlan_devices
[i
])
260 if (i
== VLAN_VID_MASK
) {
261 if (real_dev
->features
& NETIF_F_HW_VLAN_RX
)
262 real_dev
->vlan_rx_register(real_dev
, NULL
);
264 hlist_del_rcu(&grp
->hlist
);
266 /* Free the group, after all cpu's are done. */
267 call_rcu(&grp
->rcu
, vlan_rcu_free
);
278 static int unregister_vlan_device(const char *vlan_IF_name
)
280 struct net_device
*dev
= NULL
;
284 dev
= dev_get_by_name(vlan_IF_name
);
287 if (dev
->priv_flags
& IFF_802_1Q_VLAN
) {
290 ret
= unregister_vlan_dev(VLAN_DEV_INFO(dev
)->real_dev
,
291 VLAN_DEV_INFO(dev
)->vlan_id
);
294 unregister_netdevice(dev
);
302 "%s: ERROR: Tried to remove a non-vlan device "
303 "with VLAN code, name: %s priv_flags: %hX\n",
304 __FUNCTION__
, dev
->name
, dev
->priv_flags
);
310 printk(VLAN_DBG
"%s: WARNING: Could not find dev.\n", __FUNCTION__
);
318 static void vlan_setup(struct net_device
*new_dev
)
320 SET_MODULE_OWNER(new_dev
);
322 /* new_dev->ifindex = 0; it will be set when added to
324 * iflink is set as well.
326 new_dev
->get_stats
= vlan_dev_get_stats
;
328 /* Make this thing known as a VLAN device */
329 new_dev
->priv_flags
|= IFF_802_1Q_VLAN
;
331 /* Set us up to have no queue, as the underlying Hardware device
332 * can do all the queueing we could want.
334 new_dev
->tx_queue_len
= 0;
336 /* set up method calls */
337 new_dev
->change_mtu
= vlan_dev_change_mtu
;
338 new_dev
->open
= vlan_dev_open
;
339 new_dev
->stop
= vlan_dev_stop
;
340 new_dev
->set_mac_address
= vlan_dev_set_mac_address
;
341 new_dev
->set_multicast_list
= vlan_dev_set_multicast_list
;
342 new_dev
->destructor
= free_netdev
;
343 new_dev
->do_ioctl
= vlan_dev_ioctl
;
346 /* Attach a VLAN device to a mac address (ie Ethernet Card).
347 * Returns the device that was created, or NULL if there was
348 * an error of some kind.
350 static struct net_device
*register_vlan_device(const char *eth_IF_name
,
351 unsigned short VLAN_ID
)
353 struct vlan_group
*grp
;
354 struct net_device
*new_dev
;
355 struct net_device
*real_dev
; /* the ethernet device */
359 printk(VLAN_DBG
"%s: if_name -:%s:- vid: %i\n",
360 __FUNCTION__
, eth_IF_name
, VLAN_ID
);
363 if (VLAN_ID
>= VLAN_VID_MASK
)
366 /* find the device relating to eth_IF_name. */
367 real_dev
= dev_get_by_name(eth_IF_name
);
371 if (real_dev
->features
& NETIF_F_VLAN_CHALLENGED
) {
372 printk(VLAN_DBG
"%s: VLANs not supported on %s.\n",
373 __FUNCTION__
, real_dev
->name
);
377 if ((real_dev
->features
& NETIF_F_HW_VLAN_RX
) &&
378 (real_dev
->vlan_rx_register
== NULL
||
379 real_dev
->vlan_rx_kill_vid
== NULL
)) {
380 printk(VLAN_DBG
"%s: Device %s has buggy VLAN hw accel.\n",
381 __FUNCTION__
, real_dev
->name
);
385 if ((real_dev
->features
& NETIF_F_HW_VLAN_FILTER
) &&
386 (real_dev
->vlan_rx_add_vid
== NULL
||
387 real_dev
->vlan_rx_kill_vid
== NULL
)) {
388 printk(VLAN_DBG
"%s: Device %s has buggy VLAN hw accel.\n",
389 __FUNCTION__
, real_dev
->name
);
393 /* From this point on, all the data structures must remain
398 /* The real device must be up and operating in order to
399 * assosciate a VLAN device with it.
401 if (!(real_dev
->flags
& IFF_UP
))
404 if (__find_vlan_dev(real_dev
, VLAN_ID
) != NULL
) {
405 /* was already registered. */
406 printk(VLAN_DBG
"%s: ALREADY had VLAN registered\n", __FUNCTION__
);
410 /* Gotta set up the fields for the device. */
412 printk(VLAN_DBG
"About to allocate name, vlan_name_type: %i\n",
415 switch (vlan_name_type
) {
416 case VLAN_NAME_TYPE_RAW_PLUS_VID
:
417 /* name will look like: eth1.0005 */
418 snprintf(name
, IFNAMSIZ
, "%s.%.4i", real_dev
->name
, VLAN_ID
);
420 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD
:
421 /* Put our vlan.VID in the name.
422 * Name will look like: vlan5
424 snprintf(name
, IFNAMSIZ
, "vlan%i", VLAN_ID
);
426 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD
:
427 /* Put our vlan.VID in the name.
428 * Name will look like: eth0.5
430 snprintf(name
, IFNAMSIZ
, "%s.%i", real_dev
->name
, VLAN_ID
);
432 case VLAN_NAME_TYPE_PLUS_VID
:
433 /* Put our vlan.VID in the name.
434 * Name will look like: vlan0005
437 snprintf(name
, IFNAMSIZ
, "vlan%.4i", VLAN_ID
);
440 new_dev
= alloc_netdev(sizeof(struct vlan_dev_info
), name
,
446 printk(VLAN_DBG
"Allocated new name -:%s:-\n", new_dev
->name
);
448 /* IFF_BROADCAST|IFF_MULTICAST; ??? */
449 new_dev
->flags
= real_dev
->flags
;
450 new_dev
->flags
&= ~IFF_UP
;
452 new_dev
->state
= real_dev
->state
& VLAN_LINK_STATE_MASK
;
454 /* need 4 bytes for extra VLAN header info,
455 * hope the underlying device can handle it.
457 new_dev
->mtu
= real_dev
->mtu
;
459 /* TODO: maybe just assign it to be ETHERNET? */
460 new_dev
->type
= real_dev
->type
;
462 new_dev
->hard_header_len
= real_dev
->hard_header_len
;
463 if (!(real_dev
->features
& NETIF_F_HW_VLAN_TX
)) {
464 /* Regular ethernet + 4 bytes (18 total). */
465 new_dev
->hard_header_len
+= VLAN_HLEN
;
468 VLAN_MEM_DBG("new_dev->priv malloc, addr: %p size: %i\n",
470 sizeof(struct vlan_dev_info
));
472 memcpy(new_dev
->broadcast
, real_dev
->broadcast
, real_dev
->addr_len
);
473 memcpy(new_dev
->dev_addr
, real_dev
->dev_addr
, real_dev
->addr_len
);
474 new_dev
->addr_len
= real_dev
->addr_len
;
476 if (real_dev
->features
& NETIF_F_HW_VLAN_TX
) {
477 new_dev
->hard_header
= real_dev
->hard_header
;
478 new_dev
->hard_start_xmit
= vlan_dev_hwaccel_hard_start_xmit
;
479 new_dev
->rebuild_header
= real_dev
->rebuild_header
;
481 new_dev
->hard_header
= vlan_dev_hard_header
;
482 new_dev
->hard_start_xmit
= vlan_dev_hard_start_xmit
;
483 new_dev
->rebuild_header
= vlan_dev_rebuild_header
;
485 new_dev
->hard_header_parse
= real_dev
->hard_header_parse
;
487 VLAN_DEV_INFO(new_dev
)->vlan_id
= VLAN_ID
; /* 1 through VLAN_VID_MASK */
488 VLAN_DEV_INFO(new_dev
)->real_dev
= real_dev
;
489 VLAN_DEV_INFO(new_dev
)->dent
= NULL
;
490 VLAN_DEV_INFO(new_dev
)->flags
= 1;
493 printk(VLAN_DBG
"About to go find the group for idx: %i\n",
497 if (register_netdevice(new_dev
))
498 goto out_free_newdev
;
500 /* So, got the sucker initialized, now lets place
501 * it into our local structure.
503 grp
= __vlan_find_group(real_dev
->ifindex
);
505 /* Note, we are running under the RTNL semaphore
506 * so it cannot "appear" on us.
508 if (!grp
) { /* need to add a new group */
509 grp
= kmalloc(sizeof(struct vlan_group
), GFP_KERNEL
);
511 goto out_free_unregister
;
513 /* printk(KERN_ALERT "VLAN REGISTER: Allocated new group.\n"); */
514 memset(grp
, 0, sizeof(struct vlan_group
));
515 grp
->real_dev_ifindex
= real_dev
->ifindex
;
517 hlist_add_head_rcu(&grp
->hlist
,
518 &vlan_group_hash
[vlan_grp_hashfn(real_dev
->ifindex
)]);
520 if (real_dev
->features
& NETIF_F_HW_VLAN_RX
)
521 real_dev
->vlan_rx_register(real_dev
, grp
);
524 grp
->vlan_devices
[VLAN_ID
] = new_dev
;
526 if (vlan_proc_add_dev(new_dev
)<0)/* create it's proc entry */
527 printk(KERN_WARNING
"VLAN: failed to add proc entry for %s\n",
530 if (real_dev
->features
& NETIF_F_HW_VLAN_FILTER
)
531 real_dev
->vlan_rx_add_vid(real_dev
, VLAN_ID
);
537 printk(VLAN_DBG
"Allocated new device successfully, returning.\n");
542 unregister_netdev(new_dev
);
546 free_netdev(new_dev
);
558 static int vlan_device_event(struct notifier_block
*unused
, unsigned long event
, void *ptr
)
560 struct net_device
*dev
= ptr
;
561 struct vlan_group
*grp
= __vlan_find_group(dev
->ifindex
);
563 struct net_device
*vlandev
;
568 /* It is OK that we do not hold the group lock right now,
569 * as we run under the RTNL lock.
574 /* Propagate real device state to vlan devices */
575 flgs
= dev
->state
& VLAN_LINK_STATE_MASK
;
576 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
577 vlandev
= grp
->vlan_devices
[i
];
581 if (netif_carrier_ok(dev
)) {
582 if (!netif_carrier_ok(vlandev
))
583 netif_carrier_on(vlandev
);
585 if (netif_carrier_ok(vlandev
))
586 netif_carrier_off(vlandev
);
589 if ((vlandev
->state
& VLAN_LINK_STATE_MASK
) != flgs
) {
590 vlandev
->state
= (vlandev
->state
&~ VLAN_LINK_STATE_MASK
)
592 netdev_state_change(vlandev
);
598 /* Put all VLANs for this dev in the down state too. */
599 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
600 vlandev
= grp
->vlan_devices
[i
];
604 flgs
= vlandev
->flags
;
605 if (!(flgs
& IFF_UP
))
608 dev_change_flags(vlandev
, flgs
& ~IFF_UP
);
613 /* Put all VLANs for this dev in the up state too. */
614 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
615 vlandev
= grp
->vlan_devices
[i
];
619 flgs
= vlandev
->flags
;
623 dev_change_flags(vlandev
, flgs
| IFF_UP
);
627 case NETDEV_UNREGISTER
:
628 /* Delete all VLANs for this dev. */
629 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
632 vlandev
= grp
->vlan_devices
[i
];
636 ret
= unregister_vlan_dev(dev
,
637 VLAN_DEV_INFO(vlandev
)->vlan_id
);
639 unregister_netdevice(vlandev
);
641 /* Group was destroyed? */
653 * VLAN IOCTL handler.
654 * o execute requested action or pass command to the device driver
655 * arg is really a struct vlan_ioctl_args __user *.
657 static int vlan_ioctl_handler(void __user
*arg
)
660 unsigned short vid
= 0;
661 struct vlan_ioctl_args args
;
663 if (copy_from_user(&args
, arg
, sizeof(struct vlan_ioctl_args
)))
666 /* Null terminate this sucker, just in case. */
667 args
.device1
[23] = 0;
668 args
.u
.device2
[23] = 0;
671 printk(VLAN_DBG
"%s: args.cmd: %x\n", __FUNCTION__
, args
.cmd
);
675 case SET_VLAN_INGRESS_PRIORITY_CMD
:
676 if (!capable(CAP_NET_ADMIN
))
678 err
= vlan_dev_set_ingress_priority(args
.device1
,
683 case SET_VLAN_EGRESS_PRIORITY_CMD
:
684 if (!capable(CAP_NET_ADMIN
))
686 err
= vlan_dev_set_egress_priority(args
.device1
,
691 case SET_VLAN_FLAG_CMD
:
692 if (!capable(CAP_NET_ADMIN
))
694 err
= vlan_dev_set_vlan_flag(args
.device1
,
699 case SET_VLAN_NAME_TYPE_CMD
:
700 if (!capable(CAP_NET_ADMIN
))
702 if ((args
.u
.name_type
>= 0) &&
703 (args
.u
.name_type
< VLAN_NAME_TYPE_HIGHEST
)) {
704 vlan_name_type
= args
.u
.name_type
;
712 if (!capable(CAP_NET_ADMIN
))
714 /* we have been given the name of the Ethernet Device we want to
715 * talk to: args.dev1 We also have the
716 * VLAN ID: args.u.VID
718 if (register_vlan_device(args
.device1
, args
.u
.VID
)) {
726 if (!capable(CAP_NET_ADMIN
))
728 /* Here, the args.dev1 is the actual VLAN we want
731 err
= unregister_vlan_device(args
.device1
);
734 case GET_VLAN_INGRESS_PRIORITY_CMD
:
736 err = vlan_dev_get_ingress_priority(args);
737 if (copy_to_user((void*)arg, &args,
738 sizeof(struct vlan_ioctl_args))) {
744 case GET_VLAN_EGRESS_PRIORITY_CMD
:
746 err = vlan_dev_get_egress_priority(args.device1, &(args.args);
747 if (copy_to_user((void*)arg, &args,
748 sizeof(struct vlan_ioctl_args))) {
754 case GET_VLAN_REALDEV_NAME_CMD
:
755 err
= vlan_dev_get_realdev_name(args
.device1
, args
.u
.device2
);
758 if (copy_to_user(arg
, &args
,
759 sizeof(struct vlan_ioctl_args
))) {
764 case GET_VLAN_VID_CMD
:
765 err
= vlan_dev_get_vid(args
.device1
, &vid
);
769 if (copy_to_user(arg
, &args
,
770 sizeof(struct vlan_ioctl_args
))) {
776 /* pass on to underlying device instead?? */
777 printk(VLAN_DBG
"%s: Unknown VLAN CMD: %x \n",
778 __FUNCTION__
, args
.cmd
);
785 MODULE_LICENSE("GPL");
786 MODULE_VERSION(DRV_VERSION
);