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 /* Bits of netdev state that are propagated from real device to virtual */
71 #define VLAN_LINK_STATE_MASK \
72 ((1<<__LINK_STATE_PRESENT)|(1<<__LINK_STATE_NOCARRIER)|(1<<__LINK_STATE_DORMANT))
74 /* End of global variables definitions. */
77 * Function vlan_proto_init (pro)
79 * Initialize VLAN protocol layer,
82 static int __init
vlan_proto_init(void)
86 printk(VLAN_INF
"%s v%s %s\n",
87 vlan_fullname
, vlan_version
, vlan_copyright
);
88 printk(VLAN_INF
"All bugs added by %s\n",
91 /* proc file system initialization */
92 err
= vlan_proc_init();
95 "%s %s: can't create entry in proc filesystem!\n",
96 __FUNCTION__
, VLAN_NAME
);
100 dev_add_pack(&vlan_packet_type
);
102 /* Register us to receive netdevice events */
103 err
= register_netdevice_notifier(&vlan_notifier_block
);
105 dev_remove_pack(&vlan_packet_type
);
110 vlan_ioctl_set(vlan_ioctl_handler
);
115 /* Cleanup all vlan devices
116 * Note: devices that have been registered that but not
117 * brought up will exist but have no module ref count.
119 static void __exit
vlan_cleanup_devices(void)
121 struct net_device
*dev
, *nxt
;
124 for (dev
= dev_base
; dev
; dev
= nxt
) {
126 if (dev
->priv_flags
& IFF_802_1Q_VLAN
) {
127 unregister_vlan_dev(VLAN_DEV_INFO(dev
)->real_dev
,
128 VLAN_DEV_INFO(dev
)->vlan_id
);
130 unregister_netdevice(dev
);
137 * Module 'remove' entry point.
138 * o delete /proc/net/router directory and static entries.
140 static void __exit
vlan_cleanup_module(void)
144 vlan_ioctl_set(NULL
);
146 /* Un-register us from receiving netdevice events */
147 unregister_netdevice_notifier(&vlan_notifier_block
);
149 dev_remove_pack(&vlan_packet_type
);
150 vlan_cleanup_devices();
152 /* This table must be empty if there are no module
155 for (i
= 0; i
< VLAN_GRP_HASH_SIZE
; i
++) {
156 BUG_ON(!hlist_empty(&vlan_group_hash
[i
]));
163 module_init(vlan_proto_init
);
164 module_exit(vlan_cleanup_module
);
166 /* Must be invoked with RCU read lock (no preempt) */
167 static struct vlan_group
*__vlan_find_group(int real_dev_ifindex
)
169 struct vlan_group
*grp
;
170 struct hlist_node
*n
;
171 int hash
= vlan_grp_hashfn(real_dev_ifindex
);
173 hlist_for_each_entry_rcu(grp
, n
, &vlan_group_hash
[hash
], hlist
) {
174 if (grp
->real_dev_ifindex
== real_dev_ifindex
)
181 /* Find the protocol handler. Assumes VID < VLAN_VID_MASK.
183 * Must be invoked with RCU read lock (no preempt)
185 struct net_device
*__find_vlan_dev(struct net_device
*real_dev
,
188 struct vlan_group
*grp
= __vlan_find_group(real_dev
->ifindex
);
191 return grp
->vlan_devices
[VID
];
196 static void vlan_rcu_free(struct rcu_head
*rcu
)
198 kfree(container_of(rcu
, struct vlan_group
, rcu
));
202 /* This returns 0 if everything went fine.
203 * It will return 1 if the group was killed as a result.
204 * A negative return indicates failure.
206 * The RTNL lock must be held.
208 static int unregister_vlan_dev(struct net_device
*real_dev
,
209 unsigned short vlan_id
)
211 struct net_device
*dev
= NULL
;
212 int real_dev_ifindex
= real_dev
->ifindex
;
213 struct vlan_group
*grp
;
217 printk(VLAN_DBG
"%s: VID: %i\n", __FUNCTION__
, vlan_id
);
221 if (vlan_id
>= VLAN_VID_MASK
)
225 grp
= __vlan_find_group(real_dev_ifindex
);
230 dev
= grp
->vlan_devices
[vlan_id
];
232 /* Remove proc entry */
233 vlan_proc_rem_dev(dev
);
235 /* Take it out of our own structures, but be sure to
236 * interlock with HW accelerating devices or SW vlan
237 * input packet processing.
239 if (real_dev
->features
&
240 (NETIF_F_HW_VLAN_RX
| NETIF_F_HW_VLAN_FILTER
)) {
241 real_dev
->vlan_rx_kill_vid(real_dev
, vlan_id
);
244 grp
->vlan_devices
[vlan_id
] = NULL
;
248 /* Caller unregisters (and if necessary, puts)
249 * VLAN device, but we get rid of the reference to
254 /* If the group is now empty, kill off the
257 for (i
= 0; i
< VLAN_VID_MASK
; i
++)
258 if (grp
->vlan_devices
[i
])
261 if (i
== VLAN_VID_MASK
) {
262 if (real_dev
->features
& NETIF_F_HW_VLAN_RX
)
263 real_dev
->vlan_rx_register(real_dev
, NULL
);
265 hlist_del_rcu(&grp
->hlist
);
267 /* Free the group, after all cpu's are done. */
268 call_rcu(&grp
->rcu
, vlan_rcu_free
);
279 static int unregister_vlan_device(const char *vlan_IF_name
)
281 struct net_device
*dev
= NULL
;
285 dev
= dev_get_by_name(vlan_IF_name
);
288 if (dev
->priv_flags
& IFF_802_1Q_VLAN
) {
291 ret
= unregister_vlan_dev(VLAN_DEV_INFO(dev
)->real_dev
,
292 VLAN_DEV_INFO(dev
)->vlan_id
);
295 unregister_netdevice(dev
);
303 "%s: ERROR: Tried to remove a non-vlan device "
304 "with VLAN code, name: %s priv_flags: %hX\n",
305 __FUNCTION__
, dev
->name
, dev
->priv_flags
);
311 printk(VLAN_DBG
"%s: WARNING: Could not find dev.\n", __FUNCTION__
);
319 static void vlan_setup(struct net_device
*new_dev
)
321 SET_MODULE_OWNER(new_dev
);
323 /* new_dev->ifindex = 0; it will be set when added to
325 * iflink is set as well.
327 new_dev
->get_stats
= vlan_dev_get_stats
;
329 /* Make this thing known as a VLAN device */
330 new_dev
->priv_flags
|= IFF_802_1Q_VLAN
;
332 /* Set us up to have no queue, as the underlying Hardware device
333 * can do all the queueing we could want.
335 new_dev
->tx_queue_len
= 0;
337 /* set up method calls */
338 new_dev
->change_mtu
= vlan_dev_change_mtu
;
339 new_dev
->open
= vlan_dev_open
;
340 new_dev
->stop
= vlan_dev_stop
;
341 new_dev
->set_mac_address
= vlan_dev_set_mac_address
;
342 new_dev
->set_multicast_list
= vlan_dev_set_multicast_list
;
343 new_dev
->destructor
= free_netdev
;
344 new_dev
->do_ioctl
= vlan_dev_ioctl
;
347 static void vlan_transfer_operstate(const struct net_device
*dev
, struct net_device
*vlandev
)
349 /* Have to respect userspace enforced dormant state
350 * of real device, also must allow supplicant running
353 if (dev
->operstate
== IF_OPER_DORMANT
)
354 netif_dormant_on(vlandev
);
356 netif_dormant_off(vlandev
);
358 if (netif_carrier_ok(dev
)) {
359 if (!netif_carrier_ok(vlandev
))
360 netif_carrier_on(vlandev
);
362 if (netif_carrier_ok(vlandev
))
363 netif_carrier_off(vlandev
);
368 * vlan network devices have devices nesting below it, and are a special
369 * "super class" of normal network devices; split their locks off into a
370 * separate class since they always nest.
372 static struct lock_class_key vlan_netdev_xmit_lock_key
;
375 /* Attach a VLAN device to a mac address (ie Ethernet Card).
376 * Returns the device that was created, or NULL if there was
377 * an error of some kind.
379 static struct net_device
*register_vlan_device(const char *eth_IF_name
,
380 unsigned short VLAN_ID
)
382 struct vlan_group
*grp
;
383 struct net_device
*new_dev
;
384 struct net_device
*real_dev
; /* the ethernet device */
388 printk(VLAN_DBG
"%s: if_name -:%s:- vid: %i\n",
389 __FUNCTION__
, eth_IF_name
, VLAN_ID
);
392 if (VLAN_ID
>= VLAN_VID_MASK
)
395 /* find the device relating to eth_IF_name. */
396 real_dev
= dev_get_by_name(eth_IF_name
);
400 if (real_dev
->features
& NETIF_F_VLAN_CHALLENGED
) {
401 printk(VLAN_DBG
"%s: VLANs not supported on %s.\n",
402 __FUNCTION__
, real_dev
->name
);
406 if ((real_dev
->features
& NETIF_F_HW_VLAN_RX
) &&
407 (real_dev
->vlan_rx_register
== NULL
||
408 real_dev
->vlan_rx_kill_vid
== NULL
)) {
409 printk(VLAN_DBG
"%s: Device %s has buggy VLAN hw accel.\n",
410 __FUNCTION__
, real_dev
->name
);
414 if ((real_dev
->features
& NETIF_F_HW_VLAN_FILTER
) &&
415 (real_dev
->vlan_rx_add_vid
== NULL
||
416 real_dev
->vlan_rx_kill_vid
== NULL
)) {
417 printk(VLAN_DBG
"%s: Device %s has buggy VLAN hw accel.\n",
418 __FUNCTION__
, real_dev
->name
);
422 /* From this point on, all the data structures must remain
427 /* The real device must be up and operating in order to
428 * assosciate a VLAN device with it.
430 if (!(real_dev
->flags
& IFF_UP
))
433 if (__find_vlan_dev(real_dev
, VLAN_ID
) != NULL
) {
434 /* was already registered. */
435 printk(VLAN_DBG
"%s: ALREADY had VLAN registered\n", __FUNCTION__
);
439 /* Gotta set up the fields for the device. */
441 printk(VLAN_DBG
"About to allocate name, vlan_name_type: %i\n",
444 switch (vlan_name_type
) {
445 case VLAN_NAME_TYPE_RAW_PLUS_VID
:
446 /* name will look like: eth1.0005 */
447 snprintf(name
, IFNAMSIZ
, "%s.%.4i", real_dev
->name
, VLAN_ID
);
449 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD
:
450 /* Put our vlan.VID in the name.
451 * Name will look like: vlan5
453 snprintf(name
, IFNAMSIZ
, "vlan%i", VLAN_ID
);
455 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD
:
456 /* Put our vlan.VID in the name.
457 * Name will look like: eth0.5
459 snprintf(name
, IFNAMSIZ
, "%s.%i", real_dev
->name
, VLAN_ID
);
461 case VLAN_NAME_TYPE_PLUS_VID
:
462 /* Put our vlan.VID in the name.
463 * Name will look like: vlan0005
466 snprintf(name
, IFNAMSIZ
, "vlan%.4i", VLAN_ID
);
469 new_dev
= alloc_netdev(sizeof(struct vlan_dev_info
), name
,
476 printk(VLAN_DBG
"Allocated new name -:%s:-\n", new_dev
->name
);
478 /* IFF_BROADCAST|IFF_MULTICAST; ??? */
479 new_dev
->flags
= real_dev
->flags
;
480 new_dev
->flags
&= ~IFF_UP
;
482 new_dev
->state
= real_dev
->state
& ~(1<<__LINK_STATE_START
);
484 /* need 4 bytes for extra VLAN header info,
485 * hope the underlying device can handle it.
487 new_dev
->mtu
= real_dev
->mtu
;
489 /* TODO: maybe just assign it to be ETHERNET? */
490 new_dev
->type
= real_dev
->type
;
492 new_dev
->hard_header_len
= real_dev
->hard_header_len
;
493 if (!(real_dev
->features
& NETIF_F_HW_VLAN_TX
)) {
494 /* Regular ethernet + 4 bytes (18 total). */
495 new_dev
->hard_header_len
+= VLAN_HLEN
;
498 VLAN_MEM_DBG("new_dev->priv malloc, addr: %p size: %i\n",
500 sizeof(struct vlan_dev_info
));
502 memcpy(new_dev
->broadcast
, real_dev
->broadcast
, real_dev
->addr_len
);
503 memcpy(new_dev
->dev_addr
, real_dev
->dev_addr
, real_dev
->addr_len
);
504 new_dev
->addr_len
= real_dev
->addr_len
;
506 if (real_dev
->features
& NETIF_F_HW_VLAN_TX
) {
507 new_dev
->hard_header
= real_dev
->hard_header
;
508 new_dev
->hard_start_xmit
= vlan_dev_hwaccel_hard_start_xmit
;
509 new_dev
->rebuild_header
= real_dev
->rebuild_header
;
511 new_dev
->hard_header
= vlan_dev_hard_header
;
512 new_dev
->hard_start_xmit
= vlan_dev_hard_start_xmit
;
513 new_dev
->rebuild_header
= vlan_dev_rebuild_header
;
515 new_dev
->hard_header_parse
= real_dev
->hard_header_parse
;
517 VLAN_DEV_INFO(new_dev
)->vlan_id
= VLAN_ID
; /* 1 through VLAN_VID_MASK */
518 VLAN_DEV_INFO(new_dev
)->real_dev
= real_dev
;
519 VLAN_DEV_INFO(new_dev
)->dent
= NULL
;
520 VLAN_DEV_INFO(new_dev
)->flags
= 1;
523 printk(VLAN_DBG
"About to go find the group for idx: %i\n",
527 if (register_netdevice(new_dev
))
528 goto out_free_newdev
;
530 lockdep_set_class(&new_dev
->_xmit_lock
, &vlan_netdev_xmit_lock_key
);
532 new_dev
->iflink
= real_dev
->ifindex
;
533 vlan_transfer_operstate(real_dev
, new_dev
);
534 linkwatch_fire_event(new_dev
); /* _MUST_ call rfc2863_policy() */
536 /* So, got the sucker initialized, now lets place
537 * it into our local structure.
539 grp
= __vlan_find_group(real_dev
->ifindex
);
541 /* Note, we are running under the RTNL semaphore
542 * so it cannot "appear" on us.
544 if (!grp
) { /* need to add a new group */
545 grp
= kzalloc(sizeof(struct vlan_group
), GFP_KERNEL
);
547 goto out_free_unregister
;
549 /* printk(KERN_ALERT "VLAN REGISTER: Allocated new group.\n"); */
550 grp
->real_dev_ifindex
= real_dev
->ifindex
;
552 hlist_add_head_rcu(&grp
->hlist
,
553 &vlan_group_hash
[vlan_grp_hashfn(real_dev
->ifindex
)]);
555 if (real_dev
->features
& NETIF_F_HW_VLAN_RX
)
556 real_dev
->vlan_rx_register(real_dev
, grp
);
559 grp
->vlan_devices
[VLAN_ID
] = new_dev
;
561 if (vlan_proc_add_dev(new_dev
)<0)/* create it's proc entry */
562 printk(KERN_WARNING
"VLAN: failed to add proc entry for %s\n",
565 if (real_dev
->features
& NETIF_F_HW_VLAN_FILTER
)
566 real_dev
->vlan_rx_add_vid(real_dev
, VLAN_ID
);
572 printk(VLAN_DBG
"Allocated new device successfully, returning.\n");
577 unregister_netdev(new_dev
);
581 free_netdev(new_dev
);
593 static int vlan_device_event(struct notifier_block
*unused
, unsigned long event
, void *ptr
)
595 struct net_device
*dev
= ptr
;
596 struct vlan_group
*grp
= __vlan_find_group(dev
->ifindex
);
598 struct net_device
*vlandev
;
603 /* It is OK that we do not hold the group lock right now,
604 * as we run under the RTNL lock.
609 /* Propagate real device state to vlan devices */
610 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
611 vlandev
= grp
->vlan_devices
[i
];
615 vlan_transfer_operstate(dev
, vlandev
);
620 /* Put all VLANs for this dev in the down state too. */
621 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
622 vlandev
= grp
->vlan_devices
[i
];
626 flgs
= vlandev
->flags
;
627 if (!(flgs
& IFF_UP
))
630 dev_change_flags(vlandev
, flgs
& ~IFF_UP
);
635 /* Put all VLANs for this dev in the up state too. */
636 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
637 vlandev
= grp
->vlan_devices
[i
];
641 flgs
= vlandev
->flags
;
645 dev_change_flags(vlandev
, flgs
| IFF_UP
);
649 case NETDEV_UNREGISTER
:
650 /* Delete all VLANs for this dev. */
651 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
654 vlandev
= grp
->vlan_devices
[i
];
658 ret
= unregister_vlan_dev(dev
,
659 VLAN_DEV_INFO(vlandev
)->vlan_id
);
661 unregister_netdevice(vlandev
);
663 /* Group was destroyed? */
675 * VLAN IOCTL handler.
676 * o execute requested action or pass command to the device driver
677 * arg is really a struct vlan_ioctl_args __user *.
679 static int vlan_ioctl_handler(void __user
*arg
)
682 unsigned short vid
= 0;
683 struct vlan_ioctl_args args
;
685 if (copy_from_user(&args
, arg
, sizeof(struct vlan_ioctl_args
)))
688 /* Null terminate this sucker, just in case. */
689 args
.device1
[23] = 0;
690 args
.u
.device2
[23] = 0;
693 printk(VLAN_DBG
"%s: args.cmd: %x\n", __FUNCTION__
, args
.cmd
);
697 case SET_VLAN_INGRESS_PRIORITY_CMD
:
698 if (!capable(CAP_NET_ADMIN
))
700 err
= vlan_dev_set_ingress_priority(args
.device1
,
705 case SET_VLAN_EGRESS_PRIORITY_CMD
:
706 if (!capable(CAP_NET_ADMIN
))
708 err
= vlan_dev_set_egress_priority(args
.device1
,
713 case SET_VLAN_FLAG_CMD
:
714 if (!capable(CAP_NET_ADMIN
))
716 err
= vlan_dev_set_vlan_flag(args
.device1
,
721 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
;
734 if (!capable(CAP_NET_ADMIN
))
736 /* we have been given the name of the Ethernet Device we want to
737 * talk to: args.dev1 We also have the
738 * VLAN ID: args.u.VID
740 if (register_vlan_device(args
.device1
, args
.u
.VID
)) {
748 if (!capable(CAP_NET_ADMIN
))
750 /* Here, the args.dev1 is the actual VLAN we want
753 err
= unregister_vlan_device(args
.device1
);
756 case GET_VLAN_INGRESS_PRIORITY_CMD
:
758 err = vlan_dev_get_ingress_priority(args);
759 if (copy_to_user((void*)arg, &args,
760 sizeof(struct vlan_ioctl_args))) {
766 case GET_VLAN_EGRESS_PRIORITY_CMD
:
768 err = vlan_dev_get_egress_priority(args.device1, &(args.args);
769 if (copy_to_user((void*)arg, &args,
770 sizeof(struct vlan_ioctl_args))) {
776 case GET_VLAN_REALDEV_NAME_CMD
:
777 err
= vlan_dev_get_realdev_name(args
.device1
, args
.u
.device2
);
780 if (copy_to_user(arg
, &args
,
781 sizeof(struct vlan_ioctl_args
))) {
786 case GET_VLAN_VID_CMD
:
787 err
= vlan_dev_get_vid(args
.device1
, &vid
);
791 if (copy_to_user(arg
, &args
,
792 sizeof(struct vlan_ioctl_args
))) {
798 /* pass on to underlying device instead?? */
799 printk(VLAN_DBG
"%s: Unknown VLAN CMD: %x \n",
800 __FUNCTION__
, args
.cmd
);
807 MODULE_LICENSE("GPL");
808 MODULE_VERSION(DRV_VERSION
);