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 (dev
= dev_base
; dev
; dev
= nxt
) {
122 if (dev
->priv_flags
& IFF_802_1Q_VLAN
) {
123 unregister_vlan_dev(VLAN_DEV_INFO(dev
)->real_dev
,
124 VLAN_DEV_INFO(dev
)->vlan_id
);
126 unregister_netdevice(dev
);
133 * Module 'remove' entry point.
134 * o delete /proc/net/router directory and static entries.
136 static void __exit
vlan_cleanup_module(void)
140 vlan_ioctl_set(NULL
);
142 /* Un-register us from receiving netdevice events */
143 unregister_netdevice_notifier(&vlan_notifier_block
);
145 dev_remove_pack(&vlan_packet_type
);
146 vlan_cleanup_devices();
148 /* This table must be empty if there are no module
151 for (i
= 0; i
< VLAN_GRP_HASH_SIZE
; i
++) {
152 BUG_ON(!hlist_empty(&vlan_group_hash
[i
]));
159 module_init(vlan_proto_init
);
160 module_exit(vlan_cleanup_module
);
162 /* Must be invoked with RCU read lock (no preempt) */
163 static struct vlan_group
*__vlan_find_group(int real_dev_ifindex
)
165 struct vlan_group
*grp
;
166 struct hlist_node
*n
;
167 int hash
= vlan_grp_hashfn(real_dev_ifindex
);
169 hlist_for_each_entry_rcu(grp
, n
, &vlan_group_hash
[hash
], hlist
) {
170 if (grp
->real_dev_ifindex
== real_dev_ifindex
)
177 /* Find the protocol handler. Assumes VID < VLAN_VID_MASK.
179 * Must be invoked with RCU read lock (no preempt)
181 struct net_device
*__find_vlan_dev(struct net_device
*real_dev
,
184 struct vlan_group
*grp
= __vlan_find_group(real_dev
->ifindex
);
187 return grp
->vlan_devices
[VID
];
192 static void vlan_rcu_free(struct rcu_head
*rcu
)
194 kfree(container_of(rcu
, struct vlan_group
, rcu
));
198 /* This returns 0 if everything went fine.
199 * It will return 1 if the group was killed as a result.
200 * A negative return indicates failure.
202 * The RTNL lock must be held.
204 static int unregister_vlan_dev(struct net_device
*real_dev
,
205 unsigned short vlan_id
)
207 struct net_device
*dev
= NULL
;
208 int real_dev_ifindex
= real_dev
->ifindex
;
209 struct vlan_group
*grp
;
213 printk(VLAN_DBG
"%s: VID: %i\n", __FUNCTION__
, vlan_id
);
217 if (vlan_id
>= VLAN_VID_MASK
)
221 grp
= __vlan_find_group(real_dev_ifindex
);
226 dev
= grp
->vlan_devices
[vlan_id
];
228 /* Remove proc entry */
229 vlan_proc_rem_dev(dev
);
231 /* Take it out of our own structures, but be sure to
232 * interlock with HW accelerating devices or SW vlan
233 * input packet processing.
235 if (real_dev
->features
&
236 (NETIF_F_HW_VLAN_RX
| NETIF_F_HW_VLAN_FILTER
)) {
237 real_dev
->vlan_rx_kill_vid(real_dev
, vlan_id
);
240 grp
->vlan_devices
[vlan_id
] = NULL
;
244 /* Caller unregisters (and if necessary, puts)
245 * VLAN device, but we get rid of the reference to
250 /* If the group is now empty, kill off the
253 for (i
= 0; i
< VLAN_VID_MASK
; i
++)
254 if (grp
->vlan_devices
[i
])
257 if (i
== VLAN_VID_MASK
) {
258 if (real_dev
->features
& NETIF_F_HW_VLAN_RX
)
259 real_dev
->vlan_rx_register(real_dev
, NULL
);
261 hlist_del_rcu(&grp
->hlist
);
263 /* Free the group, after all cpu's are done. */
264 call_rcu(&grp
->rcu
, vlan_rcu_free
);
275 static int unregister_vlan_device(const char *vlan_IF_name
)
277 struct net_device
*dev
= NULL
;
281 dev
= dev_get_by_name(vlan_IF_name
);
284 if (dev
->priv_flags
& IFF_802_1Q_VLAN
) {
287 ret
= unregister_vlan_dev(VLAN_DEV_INFO(dev
)->real_dev
,
288 VLAN_DEV_INFO(dev
)->vlan_id
);
291 unregister_netdevice(dev
);
299 "%s: ERROR: Tried to remove a non-vlan device "
300 "with VLAN code, name: %s priv_flags: %hX\n",
301 __FUNCTION__
, dev
->name
, dev
->priv_flags
);
307 printk(VLAN_DBG
"%s: WARNING: Could not find dev.\n", __FUNCTION__
);
315 static void vlan_setup(struct net_device
*new_dev
)
317 SET_MODULE_OWNER(new_dev
);
319 /* new_dev->ifindex = 0; it will be set when added to
321 * iflink is set as well.
323 new_dev
->get_stats
= vlan_dev_get_stats
;
325 /* Make this thing known as a VLAN device */
326 new_dev
->priv_flags
|= IFF_802_1Q_VLAN
;
328 /* Set us up to have no queue, as the underlying Hardware device
329 * can do all the queueing we could want.
331 new_dev
->tx_queue_len
= 0;
333 /* set up method calls */
334 new_dev
->change_mtu
= vlan_dev_change_mtu
;
335 new_dev
->open
= vlan_dev_open
;
336 new_dev
->stop
= vlan_dev_stop
;
337 new_dev
->set_mac_address
= vlan_dev_set_mac_address
;
338 new_dev
->set_multicast_list
= vlan_dev_set_multicast_list
;
339 new_dev
->destructor
= free_netdev
;
340 new_dev
->do_ioctl
= vlan_dev_ioctl
;
343 static void vlan_transfer_operstate(const struct net_device
*dev
, struct net_device
*vlandev
)
345 /* Have to respect userspace enforced dormant state
346 * of real device, also must allow supplicant running
349 if (dev
->operstate
== IF_OPER_DORMANT
)
350 netif_dormant_on(vlandev
);
352 netif_dormant_off(vlandev
);
354 if (netif_carrier_ok(dev
)) {
355 if (!netif_carrier_ok(vlandev
))
356 netif_carrier_on(vlandev
);
358 if (netif_carrier_ok(vlandev
))
359 netif_carrier_off(vlandev
);
364 * vlan network devices have devices nesting below it, and are a special
365 * "super class" of normal network devices; split their locks off into a
366 * separate class since they always nest.
368 static struct lock_class_key vlan_netdev_xmit_lock_key
;
371 /* Attach a VLAN device to a mac address (ie Ethernet Card).
372 * Returns the device that was created, or NULL if there was
373 * an error of some kind.
375 static struct net_device
*register_vlan_device(const char *eth_IF_name
,
376 unsigned short VLAN_ID
)
378 struct vlan_group
*grp
;
379 struct net_device
*new_dev
;
380 struct net_device
*real_dev
; /* the ethernet device */
384 printk(VLAN_DBG
"%s: if_name -:%s:- vid: %i\n",
385 __FUNCTION__
, eth_IF_name
, VLAN_ID
);
388 if (VLAN_ID
>= VLAN_VID_MASK
)
391 /* find the device relating to eth_IF_name. */
392 real_dev
= dev_get_by_name(eth_IF_name
);
396 if (real_dev
->features
& NETIF_F_VLAN_CHALLENGED
) {
397 printk(VLAN_DBG
"%s: VLANs not supported on %s.\n",
398 __FUNCTION__
, real_dev
->name
);
402 if ((real_dev
->features
& NETIF_F_HW_VLAN_RX
) &&
403 (real_dev
->vlan_rx_register
== NULL
||
404 real_dev
->vlan_rx_kill_vid
== NULL
)) {
405 printk(VLAN_DBG
"%s: Device %s has buggy VLAN hw accel.\n",
406 __FUNCTION__
, real_dev
->name
);
410 if ((real_dev
->features
& NETIF_F_HW_VLAN_FILTER
) &&
411 (real_dev
->vlan_rx_add_vid
== NULL
||
412 real_dev
->vlan_rx_kill_vid
== NULL
)) {
413 printk(VLAN_DBG
"%s: Device %s has buggy VLAN hw accel.\n",
414 __FUNCTION__
, real_dev
->name
);
418 /* From this point on, all the data structures must remain
423 /* The real device must be up and operating in order to
424 * assosciate a VLAN device with it.
426 if (!(real_dev
->flags
& IFF_UP
))
429 if (__find_vlan_dev(real_dev
, VLAN_ID
) != NULL
) {
430 /* was already registered. */
431 printk(VLAN_DBG
"%s: ALREADY had VLAN registered\n", __FUNCTION__
);
435 /* Gotta set up the fields for the device. */
437 printk(VLAN_DBG
"About to allocate name, vlan_name_type: %i\n",
440 switch (vlan_name_type
) {
441 case VLAN_NAME_TYPE_RAW_PLUS_VID
:
442 /* name will look like: eth1.0005 */
443 snprintf(name
, IFNAMSIZ
, "%s.%.4i", real_dev
->name
, VLAN_ID
);
445 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD
:
446 /* Put our vlan.VID in the name.
447 * Name will look like: vlan5
449 snprintf(name
, IFNAMSIZ
, "vlan%i", VLAN_ID
);
451 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD
:
452 /* Put our vlan.VID in the name.
453 * Name will look like: eth0.5
455 snprintf(name
, IFNAMSIZ
, "%s.%i", real_dev
->name
, VLAN_ID
);
457 case VLAN_NAME_TYPE_PLUS_VID
:
458 /* Put our vlan.VID in the name.
459 * Name will look like: vlan0005
462 snprintf(name
, IFNAMSIZ
, "vlan%.4i", VLAN_ID
);
465 new_dev
= alloc_netdev(sizeof(struct vlan_dev_info
), name
,
472 printk(VLAN_DBG
"Allocated new name -:%s:-\n", new_dev
->name
);
474 /* IFF_BROADCAST|IFF_MULTICAST; ??? */
475 new_dev
->flags
= real_dev
->flags
;
476 new_dev
->flags
&= ~IFF_UP
;
478 new_dev
->state
= (real_dev
->state
& ((1<<__LINK_STATE_NOCARRIER
) |
479 (1<<__LINK_STATE_DORMANT
))) |
480 (1<<__LINK_STATE_PRESENT
);
482 /* need 4 bytes for extra VLAN header info,
483 * hope the underlying device can handle it.
485 new_dev
->mtu
= real_dev
->mtu
;
487 /* TODO: maybe just assign it to be ETHERNET? */
488 new_dev
->type
= real_dev
->type
;
490 new_dev
->hard_header_len
= real_dev
->hard_header_len
;
491 if (!(real_dev
->features
& NETIF_F_HW_VLAN_TX
)) {
492 /* Regular ethernet + 4 bytes (18 total). */
493 new_dev
->hard_header_len
+= VLAN_HLEN
;
496 VLAN_MEM_DBG("new_dev->priv malloc, addr: %p size: %i\n",
498 sizeof(struct vlan_dev_info
));
500 memcpy(new_dev
->broadcast
, real_dev
->broadcast
, real_dev
->addr_len
);
501 memcpy(new_dev
->dev_addr
, real_dev
->dev_addr
, real_dev
->addr_len
);
502 new_dev
->addr_len
= real_dev
->addr_len
;
504 if (real_dev
->features
& NETIF_F_HW_VLAN_TX
) {
505 new_dev
->hard_header
= real_dev
->hard_header
;
506 new_dev
->hard_start_xmit
= vlan_dev_hwaccel_hard_start_xmit
;
507 new_dev
->rebuild_header
= real_dev
->rebuild_header
;
509 new_dev
->hard_header
= vlan_dev_hard_header
;
510 new_dev
->hard_start_xmit
= vlan_dev_hard_start_xmit
;
511 new_dev
->rebuild_header
= vlan_dev_rebuild_header
;
513 new_dev
->hard_header_parse
= real_dev
->hard_header_parse
;
515 VLAN_DEV_INFO(new_dev
)->vlan_id
= VLAN_ID
; /* 1 through VLAN_VID_MASK */
516 VLAN_DEV_INFO(new_dev
)->real_dev
= real_dev
;
517 VLAN_DEV_INFO(new_dev
)->dent
= NULL
;
518 VLAN_DEV_INFO(new_dev
)->flags
= 1;
521 printk(VLAN_DBG
"About to go find the group for idx: %i\n",
525 if (register_netdevice(new_dev
))
526 goto out_free_newdev
;
528 lockdep_set_class(&new_dev
->_xmit_lock
, &vlan_netdev_xmit_lock_key
);
530 new_dev
->iflink
= real_dev
->ifindex
;
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 grp
= __vlan_find_group(real_dev
->ifindex
);
539 /* Note, we are running under the RTNL semaphore
540 * so it cannot "appear" on us.
542 if (!grp
) { /* need to add a new group */
543 grp
= kzalloc(sizeof(struct vlan_group
), GFP_KERNEL
);
545 goto out_free_unregister
;
547 /* printk(KERN_ALERT "VLAN REGISTER: Allocated new group.\n"); */
548 grp
->real_dev_ifindex
= real_dev
->ifindex
;
550 hlist_add_head_rcu(&grp
->hlist
,
551 &vlan_group_hash
[vlan_grp_hashfn(real_dev
->ifindex
)]);
553 if (real_dev
->features
& NETIF_F_HW_VLAN_RX
)
554 real_dev
->vlan_rx_register(real_dev
, grp
);
557 grp
->vlan_devices
[VLAN_ID
] = new_dev
;
559 if (vlan_proc_add_dev(new_dev
)<0)/* create it's proc entry */
560 printk(KERN_WARNING
"VLAN: failed to add proc entry for %s\n",
563 if (real_dev
->features
& NETIF_F_HW_VLAN_FILTER
)
564 real_dev
->vlan_rx_add_vid(real_dev
, VLAN_ID
);
570 printk(VLAN_DBG
"Allocated new device successfully, returning.\n");
575 unregister_netdev(new_dev
);
579 free_netdev(new_dev
);
591 static int vlan_device_event(struct notifier_block
*unused
, unsigned long event
, void *ptr
)
593 struct net_device
*dev
= ptr
;
594 struct vlan_group
*grp
= __vlan_find_group(dev
->ifindex
);
596 struct net_device
*vlandev
;
601 /* It is OK that we do not hold the group lock right now,
602 * as we run under the RTNL lock.
607 /* Propagate real device state to vlan devices */
608 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
609 vlandev
= grp
->vlan_devices
[i
];
613 vlan_transfer_operstate(dev
, vlandev
);
618 /* Put all VLANs for this dev in the down state too. */
619 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
620 vlandev
= grp
->vlan_devices
[i
];
624 flgs
= vlandev
->flags
;
625 if (!(flgs
& IFF_UP
))
628 dev_change_flags(vlandev
, flgs
& ~IFF_UP
);
633 /* Put all VLANs for this dev in the up state too. */
634 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
635 vlandev
= grp
->vlan_devices
[i
];
639 flgs
= vlandev
->flags
;
643 dev_change_flags(vlandev
, flgs
| IFF_UP
);
647 case NETDEV_UNREGISTER
:
648 /* Delete all VLANs for this dev. */
649 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
652 vlandev
= grp
->vlan_devices
[i
];
656 ret
= unregister_vlan_dev(dev
,
657 VLAN_DEV_INFO(vlandev
)->vlan_id
);
659 unregister_netdevice(vlandev
);
661 /* Group was destroyed? */
673 * VLAN IOCTL handler.
674 * o execute requested action or pass command to the device driver
675 * arg is really a struct vlan_ioctl_args __user *.
677 static int vlan_ioctl_handler(void __user
*arg
)
680 unsigned short vid
= 0;
681 struct vlan_ioctl_args args
;
683 if (copy_from_user(&args
, arg
, sizeof(struct vlan_ioctl_args
)))
686 /* Null terminate this sucker, just in case. */
687 args
.device1
[23] = 0;
688 args
.u
.device2
[23] = 0;
691 printk(VLAN_DBG
"%s: args.cmd: %x\n", __FUNCTION__
, args
.cmd
);
695 case SET_VLAN_INGRESS_PRIORITY_CMD
:
696 if (!capable(CAP_NET_ADMIN
))
698 err
= vlan_dev_set_ingress_priority(args
.device1
,
703 case SET_VLAN_EGRESS_PRIORITY_CMD
:
704 if (!capable(CAP_NET_ADMIN
))
706 err
= vlan_dev_set_egress_priority(args
.device1
,
711 case SET_VLAN_FLAG_CMD
:
712 if (!capable(CAP_NET_ADMIN
))
714 err
= vlan_dev_set_vlan_flag(args
.device1
,
719 case SET_VLAN_NAME_TYPE_CMD
:
720 if (!capable(CAP_NET_ADMIN
))
722 if ((args
.u
.name_type
>= 0) &&
723 (args
.u
.name_type
< VLAN_NAME_TYPE_HIGHEST
)) {
724 vlan_name_type
= args
.u
.name_type
;
732 if (!capable(CAP_NET_ADMIN
))
734 /* we have been given the name of the Ethernet Device we want to
735 * talk to: args.dev1 We also have the
736 * VLAN ID: args.u.VID
738 if (register_vlan_device(args
.device1
, args
.u
.VID
)) {
746 if (!capable(CAP_NET_ADMIN
))
748 /* Here, the args.dev1 is the actual VLAN we want
751 err
= unregister_vlan_device(args
.device1
);
754 case GET_VLAN_INGRESS_PRIORITY_CMD
:
756 err = vlan_dev_get_ingress_priority(args);
757 if (copy_to_user((void*)arg, &args,
758 sizeof(struct vlan_ioctl_args))) {
764 case GET_VLAN_EGRESS_PRIORITY_CMD
:
766 err = vlan_dev_get_egress_priority(args.device1, &(args.args);
767 if (copy_to_user((void*)arg, &args,
768 sizeof(struct vlan_ioctl_args))) {
774 case GET_VLAN_REALDEV_NAME_CMD
:
775 err
= vlan_dev_get_realdev_name(args
.device1
, args
.u
.device2
);
778 if (copy_to_user(arg
, &args
,
779 sizeof(struct vlan_ioctl_args
))) {
784 case GET_VLAN_VID_CMD
:
785 err
= vlan_dev_get_vid(args
.device1
, &vid
);
789 if (copy_to_user(arg
, &args
,
790 sizeof(struct vlan_ioctl_args
))) {
796 /* pass on to underlying device instead?? */
797 printk(VLAN_DBG
"%s: Unknown VLAN CMD: %x \n",
798 __FUNCTION__
, args
.cmd
);
805 MODULE_LICENSE("GPL");
806 MODULE_VERSION(DRV_VERSION
);