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>
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
];
46 #define vlan_grp_hashfn(IDX) ((((IDX) >> VLAN_GRP_HASH_SHIFT) ^ (IDX)) & VLAN_GRP_HASH_MASK)
48 static char vlan_fullname
[] = "802.1Q VLAN Support";
49 static char vlan_version
[] = DRV_VERSION
;
50 static char vlan_copyright
[] = "Ben Greear <greearb@candelatech.com>";
51 static char vlan_buggyright
[] = "David S. Miller <davem@redhat.com>";
53 static int vlan_device_event(struct notifier_block
*, unsigned long, void *);
54 static int vlan_ioctl_handler(struct net
*net
, void __user
*);
55 static int unregister_vlan_dev(struct net_device
*, unsigned short );
57 static struct notifier_block vlan_notifier_block
= {
58 .notifier_call
= vlan_device_event
,
61 /* These may be changed at run-time through IOCTLs */
63 /* Determines interface naming scheme. */
64 unsigned short vlan_name_type
= VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD
;
66 static struct packet_type vlan_packet_type
= {
67 .type
= __constant_htons(ETH_P_8021Q
),
68 .func
= vlan_skb_recv
, /* VLAN receive method */
71 /* End of global variables definitions. */
74 * Function vlan_proto_init (pro)
76 * Initialize VLAN protocol layer,
79 static int __init
vlan_proto_init(void)
83 printk(VLAN_INF
"%s v%s %s\n",
84 vlan_fullname
, vlan_version
, vlan_copyright
);
85 printk(VLAN_INF
"All bugs added by %s\n",
88 /* proc file system initialization */
89 err
= vlan_proc_init();
92 "%s %s: can't create entry in proc filesystem!\n",
93 __FUNCTION__
, VLAN_NAME
);
97 dev_add_pack(&vlan_packet_type
);
99 /* Register us to receive netdevice events */
100 err
= register_netdevice_notifier(&vlan_notifier_block
);
104 err
= vlan_netlink_init();
108 vlan_ioctl_set(vlan_ioctl_handler
);
112 unregister_netdevice_notifier(&vlan_notifier_block
);
115 dev_remove_pack(&vlan_packet_type
);
120 * Module 'remove' entry point.
121 * o delete /proc/net/router directory and static entries.
123 static void __exit
vlan_cleanup_module(void)
128 vlan_ioctl_set(NULL
);
130 /* Un-register us from receiving netdevice events */
131 unregister_netdevice_notifier(&vlan_notifier_block
);
133 dev_remove_pack(&vlan_packet_type
);
135 /* This table must be empty if there are no module
138 for (i
= 0; i
< VLAN_GRP_HASH_SIZE
; i
++) {
139 BUG_ON(!hlist_empty(&vlan_group_hash
[i
]));
146 module_init(vlan_proto_init
);
147 module_exit(vlan_cleanup_module
);
149 /* Must be invoked with RCU read lock (no preempt) */
150 static struct vlan_group
*__vlan_find_group(int real_dev_ifindex
)
152 struct vlan_group
*grp
;
153 struct hlist_node
*n
;
154 int hash
= vlan_grp_hashfn(real_dev_ifindex
);
156 hlist_for_each_entry_rcu(grp
, n
, &vlan_group_hash
[hash
], hlist
) {
157 if (grp
->real_dev_ifindex
== real_dev_ifindex
)
164 /* Find the protocol handler. Assumes VID < VLAN_VID_MASK.
166 * Must be invoked with RCU read lock (no preempt)
168 struct net_device
*__find_vlan_dev(struct net_device
*real_dev
,
171 struct vlan_group
*grp
= __vlan_find_group(real_dev
->ifindex
);
174 return vlan_group_get_device(grp
, VID
);
179 static void vlan_group_free(struct vlan_group
*grp
)
183 for (i
=0; i
< VLAN_GROUP_ARRAY_SPLIT_PARTS
; i
++)
184 kfree(grp
->vlan_devices_arrays
[i
]);
188 static struct vlan_group
*vlan_group_alloc(int ifindex
)
190 struct vlan_group
*grp
;
194 grp
= kzalloc(sizeof(struct vlan_group
), GFP_KERNEL
);
198 size
= sizeof(struct net_device
*) * VLAN_GROUP_ARRAY_PART_LEN
;
200 for (i
= 0; i
< VLAN_GROUP_ARRAY_SPLIT_PARTS
; i
++) {
201 grp
->vlan_devices_arrays
[i
] = kzalloc(size
, GFP_KERNEL
);
202 if (!grp
->vlan_devices_arrays
[i
])
206 grp
->real_dev_ifindex
= ifindex
;
207 hlist_add_head_rcu(&grp
->hlist
,
208 &vlan_group_hash
[vlan_grp_hashfn(ifindex
)]);
212 vlan_group_free(grp
);
216 static void vlan_rcu_free(struct rcu_head
*rcu
)
218 vlan_group_free(container_of(rcu
, struct vlan_group
, rcu
));
222 /* This returns 0 if everything went fine.
223 * It will return 1 if the group was killed as a result.
224 * A negative return indicates failure.
226 * The RTNL lock must be held.
228 static int unregister_vlan_dev(struct net_device
*real_dev
,
229 unsigned short vlan_id
)
231 struct net_device
*dev
= NULL
;
232 int real_dev_ifindex
= real_dev
->ifindex
;
233 struct vlan_group
*grp
;
237 printk(VLAN_DBG
"%s: VID: %i\n", __FUNCTION__
, vlan_id
);
241 if (vlan_id
>= VLAN_VID_MASK
)
245 grp
= __vlan_find_group(real_dev_ifindex
);
250 dev
= vlan_group_get_device(grp
, vlan_id
);
252 /* Remove proc entry */
253 vlan_proc_rem_dev(dev
);
255 /* Take it out of our own structures, but be sure to
256 * interlock with HW accelerating devices or SW vlan
257 * input packet processing.
259 if (real_dev
->features
& NETIF_F_HW_VLAN_FILTER
)
260 real_dev
->vlan_rx_kill_vid(real_dev
, vlan_id
);
262 vlan_group_set_device(grp
, vlan_id
, NULL
);
266 /* Caller unregisters (and if necessary, puts)
267 * VLAN device, but we get rid of the reference to
272 /* If the group is now empty, kill off the
275 for (i
= 0; i
< VLAN_VID_MASK
; i
++)
276 if (vlan_group_get_device(grp
, i
))
279 if (i
== VLAN_VID_MASK
) {
280 if (real_dev
->features
& NETIF_F_HW_VLAN_RX
)
281 real_dev
->vlan_rx_register(real_dev
, NULL
);
283 hlist_del_rcu(&grp
->hlist
);
285 /* Free the group, after all cpu's are done. */
286 call_rcu(&grp
->rcu
, vlan_rcu_free
);
297 int unregister_vlan_device(struct net_device
*dev
)
301 ret
= unregister_vlan_dev(VLAN_DEV_INFO(dev
)->real_dev
,
302 VLAN_DEV_INFO(dev
)->vlan_id
);
303 unregister_netdevice(dev
);
311 * vlan network devices have devices nesting below it, and are a special
312 * "super class" of normal network devices; split their locks off into a
313 * separate class since they always nest.
315 static struct lock_class_key vlan_netdev_xmit_lock_key
;
317 static int vlan_dev_init(struct net_device
*dev
)
319 struct net_device
*real_dev
= VLAN_DEV_INFO(dev
)->real_dev
;
321 /* IFF_BROADCAST|IFF_MULTICAST; ??? */
322 dev
->flags
= real_dev
->flags
& ~IFF_UP
;
323 dev
->iflink
= real_dev
->ifindex
;
324 dev
->state
= (real_dev
->state
& ((1<<__LINK_STATE_NOCARRIER
) |
325 (1<<__LINK_STATE_DORMANT
))) |
326 (1<<__LINK_STATE_PRESENT
);
328 if (is_zero_ether_addr(dev
->dev_addr
))
329 memcpy(dev
->dev_addr
, real_dev
->dev_addr
, dev
->addr_len
);
330 if (is_zero_ether_addr(dev
->broadcast
))
331 memcpy(dev
->broadcast
, real_dev
->broadcast
, dev
->addr_len
);
333 if (real_dev
->features
& NETIF_F_HW_VLAN_TX
) {
334 dev
->hard_header
= real_dev
->hard_header
;
335 dev
->hard_header_len
= real_dev
->hard_header_len
;
336 dev
->hard_start_xmit
= vlan_dev_hwaccel_hard_start_xmit
;
337 dev
->rebuild_header
= real_dev
->rebuild_header
;
339 dev
->hard_header
= vlan_dev_hard_header
;
340 dev
->hard_header_len
= real_dev
->hard_header_len
+ VLAN_HLEN
;
341 dev
->hard_start_xmit
= vlan_dev_hard_start_xmit
;
342 dev
->rebuild_header
= vlan_dev_rebuild_header
;
344 dev
->hard_header_parse
= real_dev
->hard_header_parse
;
345 dev
->hard_header_cache
= NULL
;
347 lockdep_set_class(&dev
->_xmit_lock
, &vlan_netdev_xmit_lock_key
);
351 void vlan_setup(struct net_device
*new_dev
)
353 SET_MODULE_OWNER(new_dev
);
355 ether_setup(new_dev
);
357 /* new_dev->ifindex = 0; it will be set when added to
359 * iflink is set as well.
361 new_dev
->get_stats
= vlan_dev_get_stats
;
363 /* Make this thing known as a VLAN device */
364 new_dev
->priv_flags
|= IFF_802_1Q_VLAN
;
366 /* Set us up to have no queue, as the underlying Hardware device
367 * can do all the queueing we could want.
369 new_dev
->tx_queue_len
= 0;
371 /* set up method calls */
372 new_dev
->change_mtu
= vlan_dev_change_mtu
;
373 new_dev
->init
= vlan_dev_init
;
374 new_dev
->open
= vlan_dev_open
;
375 new_dev
->stop
= vlan_dev_stop
;
376 new_dev
->set_multicast_list
= vlan_dev_set_multicast_list
;
377 new_dev
->change_rx_flags
= vlan_change_rx_flags
;
378 new_dev
->destructor
= free_netdev
;
379 new_dev
->do_ioctl
= vlan_dev_ioctl
;
381 memset(new_dev
->broadcast
, 0, ETH_ALEN
);
384 static void vlan_transfer_operstate(const struct net_device
*dev
, struct net_device
*vlandev
)
386 /* Have to respect userspace enforced dormant state
387 * of real device, also must allow supplicant running
390 if (dev
->operstate
== IF_OPER_DORMANT
)
391 netif_dormant_on(vlandev
);
393 netif_dormant_off(vlandev
);
395 if (netif_carrier_ok(dev
)) {
396 if (!netif_carrier_ok(vlandev
))
397 netif_carrier_on(vlandev
);
399 if (netif_carrier_ok(vlandev
))
400 netif_carrier_off(vlandev
);
404 int vlan_check_real_dev(struct net_device
*real_dev
, unsigned short vlan_id
)
406 if (real_dev
->features
& NETIF_F_VLAN_CHALLENGED
) {
407 printk(VLAN_DBG
"%s: VLANs not supported on %s.\n",
408 __FUNCTION__
, real_dev
->name
);
412 if ((real_dev
->features
& NETIF_F_HW_VLAN_RX
) &&
413 !real_dev
->vlan_rx_register
) {
414 printk(VLAN_DBG
"%s: Device %s has buggy VLAN hw accel.\n",
415 __FUNCTION__
, real_dev
->name
);
419 if ((real_dev
->features
& NETIF_F_HW_VLAN_FILTER
) &&
420 (!real_dev
->vlan_rx_add_vid
|| !real_dev
->vlan_rx_kill_vid
)) {
421 printk(VLAN_DBG
"%s: Device %s has buggy VLAN hw accel.\n",
422 __FUNCTION__
, real_dev
->name
);
426 /* The real device must be up and operating in order to
427 * assosciate a VLAN device with it.
429 if (!(real_dev
->flags
& IFF_UP
))
432 if (__find_vlan_dev(real_dev
, vlan_id
) != NULL
) {
433 /* was already registered. */
434 printk(VLAN_DBG
"%s: ALREADY had VLAN registered\n", __FUNCTION__
);
441 int register_vlan_dev(struct net_device
*dev
)
443 struct vlan_dev_info
*vlan
= VLAN_DEV_INFO(dev
);
444 struct net_device
*real_dev
= vlan
->real_dev
;
445 unsigned short vlan_id
= vlan
->vlan_id
;
446 struct vlan_group
*grp
, *ngrp
= NULL
;
449 grp
= __vlan_find_group(real_dev
->ifindex
);
451 ngrp
= grp
= vlan_group_alloc(real_dev
->ifindex
);
456 err
= register_netdevice(dev
);
460 /* Account for reference in struct vlan_dev_info */
463 vlan_transfer_operstate(real_dev
, dev
);
464 linkwatch_fire_event(dev
); /* _MUST_ call rfc2863_policy() */
466 /* So, got the sucker initialized, now lets place
467 * it into our local structure.
469 vlan_group_set_device(grp
, vlan_id
, dev
);
470 if (ngrp
&& real_dev
->features
& NETIF_F_HW_VLAN_RX
)
471 real_dev
->vlan_rx_register(real_dev
, ngrp
);
472 if (real_dev
->features
& NETIF_F_HW_VLAN_FILTER
)
473 real_dev
->vlan_rx_add_vid(real_dev
, vlan_id
);
475 if (vlan_proc_add_dev(dev
) < 0)
476 printk(KERN_WARNING
"VLAN: failed to add proc entry for %s\n",
482 vlan_group_free(ngrp
);
486 /* Attach a VLAN device to a mac address (ie Ethernet Card).
487 * Returns 0 if the device was created or a negative error code otherwise.
489 static int register_vlan_device(struct net_device
*real_dev
,
490 unsigned short VLAN_ID
)
492 struct net_device
*new_dev
;
497 printk(VLAN_DBG
"%s: if_name -:%s:- vid: %i\n",
498 __FUNCTION__
, eth_IF_name
, VLAN_ID
);
501 if (VLAN_ID
>= VLAN_VID_MASK
)
504 err
= vlan_check_real_dev(real_dev
, VLAN_ID
);
508 /* Gotta set up the fields for the device. */
510 printk(VLAN_DBG
"About to allocate name, vlan_name_type: %i\n",
513 switch (vlan_name_type
) {
514 case VLAN_NAME_TYPE_RAW_PLUS_VID
:
515 /* name will look like: eth1.0005 */
516 snprintf(name
, IFNAMSIZ
, "%s.%.4i", real_dev
->name
, VLAN_ID
);
518 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD
:
519 /* Put our vlan.VID in the name.
520 * Name will look like: vlan5
522 snprintf(name
, IFNAMSIZ
, "vlan%i", VLAN_ID
);
524 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD
:
525 /* Put our vlan.VID in the name.
526 * Name will look like: eth0.5
528 snprintf(name
, IFNAMSIZ
, "%s.%i", real_dev
->name
, VLAN_ID
);
530 case VLAN_NAME_TYPE_PLUS_VID
:
531 /* Put our vlan.VID in the name.
532 * Name will look like: vlan0005
535 snprintf(name
, IFNAMSIZ
, "vlan%.4i", VLAN_ID
);
538 new_dev
= alloc_netdev(sizeof(struct vlan_dev_info
), name
,
544 /* need 4 bytes for extra VLAN header info,
545 * hope the underlying device can handle it.
547 new_dev
->mtu
= real_dev
->mtu
;
550 printk(VLAN_DBG
"Allocated new name -:%s:-\n", new_dev
->name
);
551 VLAN_MEM_DBG("new_dev->priv malloc, addr: %p size: %i\n",
553 sizeof(struct vlan_dev_info
));
556 VLAN_DEV_INFO(new_dev
)->vlan_id
= VLAN_ID
; /* 1 through VLAN_VID_MASK */
557 VLAN_DEV_INFO(new_dev
)->real_dev
= real_dev
;
558 VLAN_DEV_INFO(new_dev
)->dent
= NULL
;
559 VLAN_DEV_INFO(new_dev
)->flags
= VLAN_FLAG_REORDER_HDR
;
561 new_dev
->rtnl_link_ops
= &vlan_link_ops
;
562 err
= register_vlan_dev(new_dev
);
564 goto out_free_newdev
;
567 printk(VLAN_DBG
"Allocated new device successfully, returning.\n");
572 free_netdev(new_dev
);
576 static void vlan_sync_address(struct net_device
*dev
,
577 struct net_device
*vlandev
)
579 struct vlan_dev_info
*vlan
= VLAN_DEV_INFO(vlandev
);
581 /* May be called without an actual change */
582 if (!compare_ether_addr(vlan
->real_dev_addr
, dev
->dev_addr
))
585 /* vlan address was different from the old address and is equal to
587 if (compare_ether_addr(vlandev
->dev_addr
, vlan
->real_dev_addr
) &&
588 !compare_ether_addr(vlandev
->dev_addr
, dev
->dev_addr
))
589 dev_unicast_delete(dev
, vlandev
->dev_addr
, ETH_ALEN
);
591 /* vlan address was equal to the old address and is different from
593 if (!compare_ether_addr(vlandev
->dev_addr
, vlan
->real_dev_addr
) &&
594 compare_ether_addr(vlandev
->dev_addr
, dev
->dev_addr
))
595 dev_unicast_add(dev
, vlandev
->dev_addr
, ETH_ALEN
);
597 memcpy(vlan
->real_dev_addr
, dev
->dev_addr
, ETH_ALEN
);
600 static int vlan_device_event(struct notifier_block
*unused
, unsigned long event
, void *ptr
)
602 struct net_device
*dev
= ptr
;
603 struct vlan_group
*grp
= __vlan_find_group(dev
->ifindex
);
605 struct net_device
*vlandev
;
607 if (dev
->nd_net
!= &init_net
)
613 /* It is OK that we do not hold the group lock right now,
614 * as we run under the RTNL lock.
619 /* Propagate real device state to vlan devices */
620 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
621 vlandev
= vlan_group_get_device(grp
, i
);
625 vlan_transfer_operstate(dev
, vlandev
);
629 case NETDEV_CHANGEADDR
:
630 /* Adjust unicast filters on underlying device */
631 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
632 vlandev
= vlan_group_get_device(grp
, i
);
636 vlan_sync_address(dev
, vlandev
);
641 /* Put all VLANs for this dev in the down state too. */
642 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
643 vlandev
= vlan_group_get_device(grp
, i
);
647 flgs
= vlandev
->flags
;
648 if (!(flgs
& IFF_UP
))
651 dev_change_flags(vlandev
, flgs
& ~IFF_UP
);
656 /* Put all VLANs for this dev in the up state too. */
657 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
658 vlandev
= vlan_group_get_device(grp
, i
);
662 flgs
= vlandev
->flags
;
666 dev_change_flags(vlandev
, flgs
| IFF_UP
);
670 case NETDEV_UNREGISTER
:
671 /* Delete all VLANs for this dev. */
672 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
675 vlandev
= vlan_group_get_device(grp
, i
);
679 ret
= unregister_vlan_dev(dev
,
680 VLAN_DEV_INFO(vlandev
)->vlan_id
);
682 unregister_netdevice(vlandev
);
684 /* Group was destroyed? */
696 * VLAN IOCTL handler.
697 * o execute requested action or pass command to the device driver
698 * arg is really a struct vlan_ioctl_args __user *.
700 static int vlan_ioctl_handler(struct net
*net
, void __user
*arg
)
703 unsigned short vid
= 0;
704 struct vlan_ioctl_args args
;
705 struct net_device
*dev
= NULL
;
707 if (copy_from_user(&args
, arg
, sizeof(struct vlan_ioctl_args
)))
710 /* Null terminate this sucker, just in case. */
711 args
.device1
[23] = 0;
712 args
.u
.device2
[23] = 0;
715 printk(VLAN_DBG
"%s: args.cmd: %x\n", __FUNCTION__
, args
.cmd
);
721 case SET_VLAN_INGRESS_PRIORITY_CMD
:
722 case SET_VLAN_EGRESS_PRIORITY_CMD
:
723 case SET_VLAN_FLAG_CMD
:
726 case GET_VLAN_REALDEV_NAME_CMD
:
727 case GET_VLAN_VID_CMD
:
729 dev
= __dev_get_by_name(&init_net
, args
.device1
);
734 if (args
.cmd
!= ADD_VLAN_CMD
&&
735 !(dev
->priv_flags
& IFF_802_1Q_VLAN
))
740 case SET_VLAN_INGRESS_PRIORITY_CMD
:
742 if (!capable(CAP_NET_ADMIN
))
744 vlan_dev_set_ingress_priority(dev
,
749 case SET_VLAN_EGRESS_PRIORITY_CMD
:
751 if (!capable(CAP_NET_ADMIN
))
753 err
= vlan_dev_set_egress_priority(dev
,
758 case SET_VLAN_FLAG_CMD
:
760 if (!capable(CAP_NET_ADMIN
))
762 err
= vlan_dev_set_vlan_flag(dev
,
767 case SET_VLAN_NAME_TYPE_CMD
:
769 if (!capable(CAP_NET_ADMIN
))
771 if ((args
.u
.name_type
>= 0) &&
772 (args
.u
.name_type
< VLAN_NAME_TYPE_HIGHEST
)) {
773 vlan_name_type
= args
.u
.name_type
;
782 if (!capable(CAP_NET_ADMIN
))
784 err
= register_vlan_device(dev
, args
.u
.VID
);
789 if (!capable(CAP_NET_ADMIN
))
791 err
= unregister_vlan_device(dev
);
794 case GET_VLAN_INGRESS_PRIORITY_CMD
:
796 err = vlan_dev_get_ingress_priority(args);
797 if (copy_to_user((void*)arg, &args,
798 sizeof(struct vlan_ioctl_args))) {
804 case GET_VLAN_EGRESS_PRIORITY_CMD
:
806 err = vlan_dev_get_egress_priority(args.device1, &(args.args);
807 if (copy_to_user((void*)arg, &args,
808 sizeof(struct vlan_ioctl_args))) {
814 case GET_VLAN_REALDEV_NAME_CMD
:
816 vlan_dev_get_realdev_name(dev
, args
.u
.device2
);
817 if (copy_to_user(arg
, &args
,
818 sizeof(struct vlan_ioctl_args
))) {
823 case GET_VLAN_VID_CMD
:
825 vlan_dev_get_vid(dev
, &vid
);
827 if (copy_to_user(arg
, &args
,
828 sizeof(struct vlan_ioctl_args
))) {
834 /* pass on to underlying device instead?? */
835 printk(VLAN_DBG
"%s: Unknown VLAN CMD: %x \n",
836 __FUNCTION__
, args
.cmd
);
845 MODULE_LICENSE("GPL");
846 MODULE_VERSION(DRV_VERSION
);