3 * Ethernet-type device handling.
5 * Authors: Ben Greear <greearb@candelatech.com>
6 * Please send support related email to: netdev@vger.kernel.org
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 <linux/capability.h>
22 #include <linux/module.h>
23 #include <linux/netdevice.h>
24 #include <linux/skbuff.h>
25 #include <linux/slab.h>
26 #include <linux/init.h>
27 #include <linux/rculist.h>
28 #include <net/p8022.h>
30 #include <linux/rtnetlink.h>
31 #include <linux/notifier.h>
32 #include <net/rtnetlink.h>
33 #include <net/net_namespace.h>
34 #include <net/netns/generic.h>
35 #include <asm/uaccess.h>
37 #include <linux/if_vlan.h>
41 #define DRV_VERSION "1.8"
43 /* Global VLAN variables */
45 int vlan_net_id __read_mostly
;
47 /* Our listing of VLAN group(s) */
48 static struct hlist_head vlan_group_hash
[VLAN_GRP_HASH_SIZE
];
50 const char vlan_fullname
[] = "802.1Q VLAN Support";
51 const char vlan_version
[] = DRV_VERSION
;
52 static const char vlan_copyright
[] = "Ben Greear <greearb@candelatech.com>";
53 static const char vlan_buggyright
[] = "David S. Miller <davem@redhat.com>";
55 static struct packet_type vlan_packet_type __read_mostly
= {
56 .type
= cpu_to_be16(ETH_P_8021Q
),
57 .func
= vlan_skb_recv
, /* VLAN receive method */
60 /* End of global variables definitions. */
62 static inline unsigned int vlan_grp_hashfn(unsigned int idx
)
64 return ((idx
>> VLAN_GRP_HASH_SHIFT
) ^ idx
) & VLAN_GRP_HASH_MASK
;
67 /* Must be invoked with RCU read lock (no preempt) */
68 static struct vlan_group
*__vlan_find_group(struct net_device
*real_dev
)
70 struct vlan_group
*grp
;
72 int hash
= vlan_grp_hashfn(real_dev
->ifindex
);
74 hlist_for_each_entry_rcu(grp
, n
, &vlan_group_hash
[hash
], hlist
) {
75 if (grp
->real_dev
== real_dev
)
82 /* Find the protocol handler. Assumes VID < VLAN_VID_MASK.
84 * Must be invoked with RCU read lock (no preempt)
86 struct net_device
*__find_vlan_dev(struct net_device
*real_dev
, u16 vlan_id
)
88 struct vlan_group
*grp
= __vlan_find_group(real_dev
);
91 return vlan_group_get_device(grp
, vlan_id
);
96 static void vlan_group_free(struct vlan_group
*grp
)
100 for (i
= 0; i
< VLAN_GROUP_ARRAY_SPLIT_PARTS
; i
++)
101 kfree(grp
->vlan_devices_arrays
[i
]);
105 static struct vlan_group
*vlan_group_alloc(struct net_device
*real_dev
)
107 struct vlan_group
*grp
;
109 grp
= kzalloc(sizeof(struct vlan_group
), GFP_KERNEL
);
113 grp
->real_dev
= real_dev
;
114 hlist_add_head_rcu(&grp
->hlist
,
115 &vlan_group_hash
[vlan_grp_hashfn(real_dev
->ifindex
)]);
119 static int vlan_group_prealloc_vid(struct vlan_group
*vg
, u16 vlan_id
)
121 struct net_device
**array
;
126 array
= vg
->vlan_devices_arrays
[vlan_id
/ VLAN_GROUP_ARRAY_PART_LEN
];
130 size
= sizeof(struct net_device
*) * VLAN_GROUP_ARRAY_PART_LEN
;
131 array
= kzalloc(size
, GFP_KERNEL
);
135 vg
->vlan_devices_arrays
[vlan_id
/ VLAN_GROUP_ARRAY_PART_LEN
] = array
;
139 static void vlan_rcu_free(struct rcu_head
*rcu
)
141 vlan_group_free(container_of(rcu
, struct vlan_group
, rcu
));
144 void unregister_vlan_dev(struct net_device
*dev
, struct list_head
*head
)
146 struct vlan_dev_info
*vlan
= vlan_dev_info(dev
);
147 struct net_device
*real_dev
= vlan
->real_dev
;
148 const struct net_device_ops
*ops
= real_dev
->netdev_ops
;
149 struct vlan_group
*grp
;
150 u16 vlan_id
= vlan
->vlan_id
;
154 grp
= __vlan_find_group(real_dev
);
157 /* Take it out of our own structures, but be sure to interlock with
158 * HW accelerating devices or SW vlan input packet processing.
160 if (real_dev
->features
& NETIF_F_HW_VLAN_FILTER
)
161 ops
->ndo_vlan_rx_kill_vid(real_dev
, vlan_id
);
165 vlan_group_set_device(grp
, vlan_id
, NULL
);
169 unregister_netdevice_queue(dev
, head
);
171 /* If the group is now empty, kill off the group. */
172 if (grp
->nr_vlans
== 0) {
173 vlan_gvrp_uninit_applicant(real_dev
);
175 if (real_dev
->features
& NETIF_F_HW_VLAN_RX
)
176 ops
->ndo_vlan_rx_register(real_dev
, NULL
);
178 hlist_del_rcu(&grp
->hlist
);
180 /* Free the group, after all cpu's are done. */
181 call_rcu(&grp
->rcu
, vlan_rcu_free
);
184 /* Get rid of the vlan's reference to real_dev */
188 int vlan_check_real_dev(struct net_device
*real_dev
, u16 vlan_id
)
190 const char *name
= real_dev
->name
;
191 const struct net_device_ops
*ops
= real_dev
->netdev_ops
;
193 if (real_dev
->features
& NETIF_F_VLAN_CHALLENGED
) {
194 pr_info("8021q: VLANs not supported on %s\n", name
);
198 if ((real_dev
->features
& NETIF_F_HW_VLAN_RX
) && !ops
->ndo_vlan_rx_register
) {
199 pr_info("8021q: device %s has buggy VLAN hw accel\n", name
);
203 if ((real_dev
->features
& NETIF_F_HW_VLAN_FILTER
) &&
204 (!ops
->ndo_vlan_rx_add_vid
|| !ops
->ndo_vlan_rx_kill_vid
)) {
205 pr_info("8021q: Device %s has buggy VLAN hw accel\n", name
);
209 if (__find_vlan_dev(real_dev
, vlan_id
) != NULL
)
215 int register_vlan_dev(struct net_device
*dev
)
217 struct vlan_dev_info
*vlan
= vlan_dev_info(dev
);
218 struct net_device
*real_dev
= vlan
->real_dev
;
219 const struct net_device_ops
*ops
= real_dev
->netdev_ops
;
220 u16 vlan_id
= vlan
->vlan_id
;
221 struct vlan_group
*grp
, *ngrp
= NULL
;
224 grp
= __vlan_find_group(real_dev
);
226 ngrp
= grp
= vlan_group_alloc(real_dev
);
229 err
= vlan_gvrp_init_applicant(real_dev
);
234 err
= vlan_group_prealloc_vid(grp
, vlan_id
);
236 goto out_uninit_applicant
;
238 err
= register_netdevice(dev
);
240 goto out_uninit_applicant
;
242 /* Account for reference in struct vlan_dev_info */
245 netif_stacked_transfer_operstate(real_dev
, dev
);
246 linkwatch_fire_event(dev
); /* _MUST_ call rfc2863_policy() */
248 /* So, got the sucker initialized, now lets place
249 * it into our local structure.
251 vlan_group_set_device(grp
, vlan_id
, dev
);
254 if (ngrp
&& real_dev
->features
& NETIF_F_HW_VLAN_RX
)
255 ops
->ndo_vlan_rx_register(real_dev
, ngrp
);
256 if (real_dev
->features
& NETIF_F_HW_VLAN_FILTER
)
257 ops
->ndo_vlan_rx_add_vid(real_dev
, vlan_id
);
261 out_uninit_applicant
:
263 vlan_gvrp_uninit_applicant(real_dev
);
266 hlist_del_rcu(&ngrp
->hlist
);
267 /* Free the group, after all cpu's are done. */
268 call_rcu(&ngrp
->rcu
, vlan_rcu_free
);
273 /* Attach a VLAN device to a mac address (ie Ethernet Card).
274 * Returns 0 if the device was created or a negative error code otherwise.
276 static int register_vlan_device(struct net_device
*real_dev
, u16 vlan_id
)
278 struct net_device
*new_dev
;
279 struct net
*net
= dev_net(real_dev
);
280 struct vlan_net
*vn
= net_generic(net
, vlan_net_id
);
284 if (vlan_id
>= VLAN_VID_MASK
)
287 err
= vlan_check_real_dev(real_dev
, vlan_id
);
291 /* Gotta set up the fields for the device. */
292 switch (vn
->name_type
) {
293 case VLAN_NAME_TYPE_RAW_PLUS_VID
:
294 /* name will look like: eth1.0005 */
295 snprintf(name
, IFNAMSIZ
, "%s.%.4i", real_dev
->name
, vlan_id
);
297 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD
:
298 /* Put our vlan.VID in the name.
299 * Name will look like: vlan5
301 snprintf(name
, IFNAMSIZ
, "vlan%i", vlan_id
);
303 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD
:
304 /* Put our vlan.VID in the name.
305 * Name will look like: eth0.5
307 snprintf(name
, IFNAMSIZ
, "%s.%i", real_dev
->name
, vlan_id
);
309 case VLAN_NAME_TYPE_PLUS_VID
:
310 /* Put our vlan.VID in the name.
311 * Name will look like: vlan0005
314 snprintf(name
, IFNAMSIZ
, "vlan%.4i", vlan_id
);
317 new_dev
= alloc_netdev_mq(sizeof(struct vlan_dev_info
), name
,
318 vlan_setup
, real_dev
->num_tx_queues
);
323 new_dev
->real_num_tx_queues
= real_dev
->real_num_tx_queues
;
324 dev_net_set(new_dev
, net
);
325 /* need 4 bytes for extra VLAN header info,
326 * hope the underlying device can handle it.
328 new_dev
->mtu
= real_dev
->mtu
;
330 vlan_dev_info(new_dev
)->vlan_id
= vlan_id
;
331 vlan_dev_info(new_dev
)->real_dev
= real_dev
;
332 vlan_dev_info(new_dev
)->dent
= NULL
;
333 vlan_dev_info(new_dev
)->flags
= VLAN_FLAG_REORDER_HDR
;
335 new_dev
->rtnl_link_ops
= &vlan_link_ops
;
336 err
= register_vlan_dev(new_dev
);
338 goto out_free_newdev
;
343 free_netdev(new_dev
);
347 static void vlan_sync_address(struct net_device
*dev
,
348 struct net_device
*vlandev
)
350 struct vlan_dev_info
*vlan
= vlan_dev_info(vlandev
);
352 /* May be called without an actual change */
353 if (!compare_ether_addr(vlan
->real_dev_addr
, dev
->dev_addr
))
356 /* vlan address was different from the old address and is equal to
358 if (compare_ether_addr(vlandev
->dev_addr
, vlan
->real_dev_addr
) &&
359 !compare_ether_addr(vlandev
->dev_addr
, dev
->dev_addr
))
360 dev_uc_del(dev
, vlandev
->dev_addr
);
362 /* vlan address was equal to the old address and is different from
364 if (!compare_ether_addr(vlandev
->dev_addr
, vlan
->real_dev_addr
) &&
365 compare_ether_addr(vlandev
->dev_addr
, dev
->dev_addr
))
366 dev_uc_add(dev
, vlandev
->dev_addr
);
368 memcpy(vlan
->real_dev_addr
, dev
->dev_addr
, ETH_ALEN
);
371 static void vlan_transfer_features(struct net_device
*dev
,
372 struct net_device
*vlandev
)
374 unsigned long old_features
= vlandev
->features
;
376 vlandev
->features
&= ~dev
->vlan_features
;
377 vlandev
->features
|= dev
->features
& dev
->vlan_features
;
378 vlandev
->gso_max_size
= dev
->gso_max_size
;
379 #if defined(CONFIG_FCOE) || defined(CONFIG_FCOE_MODULE)
380 vlandev
->fcoe_ddp_xid
= dev
->fcoe_ddp_xid
;
382 vlandev
->real_num_tx_queues
= dev
->real_num_tx_queues
;
383 BUG_ON(vlandev
->real_num_tx_queues
> vlandev
->num_tx_queues
);
385 if (old_features
!= vlandev
->features
)
386 netdev_features_change(vlandev
);
389 static void __vlan_device_event(struct net_device
*dev
, unsigned long event
)
392 case NETDEV_CHANGENAME
:
393 vlan_proc_rem_dev(dev
);
394 if (vlan_proc_add_dev(dev
) < 0)
395 pr_warning("8021q: failed to change proc name for %s\n",
398 case NETDEV_REGISTER
:
399 if (vlan_proc_add_dev(dev
) < 0)
400 pr_warning("8021q: failed to add proc entry for %s\n",
403 case NETDEV_UNREGISTER
:
404 vlan_proc_rem_dev(dev
);
409 static int vlan_device_event(struct notifier_block
*unused
, unsigned long event
,
412 struct net_device
*dev
= ptr
;
413 struct vlan_group
*grp
;
415 struct net_device
*vlandev
;
416 struct vlan_dev_info
*vlan
;
419 if (is_vlan_dev(dev
))
420 __vlan_device_event(dev
, event
);
422 grp
= __vlan_find_group(dev
);
426 /* It is OK that we do not hold the group lock right now,
427 * as we run under the RTNL lock.
432 /* Propagate real device state to vlan devices */
433 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
434 vlandev
= vlan_group_get_device(grp
, i
);
438 netif_stacked_transfer_operstate(dev
, vlandev
);
442 case NETDEV_CHANGEADDR
:
443 /* Adjust unicast filters on underlying device */
444 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
445 vlandev
= vlan_group_get_device(grp
, i
);
449 flgs
= vlandev
->flags
;
450 if (!(flgs
& IFF_UP
))
453 vlan_sync_address(dev
, vlandev
);
457 case NETDEV_CHANGEMTU
:
458 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
459 vlandev
= vlan_group_get_device(grp
, i
);
463 if (vlandev
->mtu
<= dev
->mtu
)
466 dev_set_mtu(vlandev
, dev
->mtu
);
470 case NETDEV_FEAT_CHANGE
:
471 /* Propagate device features to underlying device */
472 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
473 vlandev
= vlan_group_get_device(grp
, i
);
477 vlan_transfer_features(dev
, vlandev
);
483 /* Put all VLANs for this dev in the down state too. */
484 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
485 vlandev
= vlan_group_get_device(grp
, i
);
489 flgs
= vlandev
->flags
;
490 if (!(flgs
& IFF_UP
))
493 vlan
= vlan_dev_info(vlandev
);
494 if (!(vlan
->flags
& VLAN_FLAG_LOOSE_BINDING
))
495 dev_change_flags(vlandev
, flgs
& ~IFF_UP
);
496 netif_stacked_transfer_operstate(dev
, vlandev
);
501 /* Put all VLANs for this dev in the up state too. */
502 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
503 vlandev
= vlan_group_get_device(grp
, i
);
507 flgs
= vlandev
->flags
;
511 vlan
= vlan_dev_info(vlandev
);
512 if (!(vlan
->flags
& VLAN_FLAG_LOOSE_BINDING
))
513 dev_change_flags(vlandev
, flgs
| IFF_UP
);
514 netif_stacked_transfer_operstate(dev
, vlandev
);
518 case NETDEV_UNREGISTER
:
519 /* Delete all VLANs for this dev. */
522 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
523 vlandev
= vlan_group_get_device(grp
, i
);
527 /* unregistration of last vlan destroys group, abort
529 if (grp
->nr_vlans
== 1)
530 i
= VLAN_GROUP_ARRAY_LEN
;
532 unregister_vlan_dev(vlandev
, &list
);
534 unregister_netdevice_many(&list
);
537 case NETDEV_PRE_TYPE_CHANGE
:
538 /* Forbid underlaying device to change its type. */
546 static struct notifier_block vlan_notifier_block __read_mostly
= {
547 .notifier_call
= vlan_device_event
,
551 * VLAN IOCTL handler.
552 * o execute requested action or pass command to the device driver
553 * arg is really a struct vlan_ioctl_args __user *.
555 static int vlan_ioctl_handler(struct net
*net
, void __user
*arg
)
558 struct vlan_ioctl_args args
;
559 struct net_device
*dev
= NULL
;
561 if (copy_from_user(&args
, arg
, sizeof(struct vlan_ioctl_args
)))
564 /* Null terminate this sucker, just in case. */
565 args
.device1
[23] = 0;
566 args
.u
.device2
[23] = 0;
571 case SET_VLAN_INGRESS_PRIORITY_CMD
:
572 case SET_VLAN_EGRESS_PRIORITY_CMD
:
573 case SET_VLAN_FLAG_CMD
:
576 case GET_VLAN_REALDEV_NAME_CMD
:
577 case GET_VLAN_VID_CMD
:
579 dev
= __dev_get_by_name(net
, args
.device1
);
584 if (args
.cmd
!= ADD_VLAN_CMD
&& !is_vlan_dev(dev
))
589 case SET_VLAN_INGRESS_PRIORITY_CMD
:
591 if (!capable(CAP_NET_ADMIN
))
593 vlan_dev_set_ingress_priority(dev
,
599 case SET_VLAN_EGRESS_PRIORITY_CMD
:
601 if (!capable(CAP_NET_ADMIN
))
603 err
= vlan_dev_set_egress_priority(dev
,
608 case SET_VLAN_FLAG_CMD
:
610 if (!capable(CAP_NET_ADMIN
))
612 err
= vlan_dev_change_flags(dev
,
613 args
.vlan_qos
? args
.u
.flag
: 0,
617 case SET_VLAN_NAME_TYPE_CMD
:
619 if (!capable(CAP_NET_ADMIN
))
621 if ((args
.u
.name_type
>= 0) &&
622 (args
.u
.name_type
< VLAN_NAME_TYPE_HIGHEST
)) {
625 vn
= net_generic(net
, vlan_net_id
);
626 vn
->name_type
= args
.u
.name_type
;
635 if (!capable(CAP_NET_ADMIN
))
637 err
= register_vlan_device(dev
, args
.u
.VID
);
642 if (!capable(CAP_NET_ADMIN
))
644 unregister_vlan_dev(dev
, NULL
);
648 case GET_VLAN_REALDEV_NAME_CMD
:
650 vlan_dev_get_realdev_name(dev
, args
.u
.device2
);
651 if (copy_to_user(arg
, &args
,
652 sizeof(struct vlan_ioctl_args
)))
656 case GET_VLAN_VID_CMD
:
658 args
.u
.VID
= vlan_dev_vlan_id(dev
);
659 if (copy_to_user(arg
, &args
,
660 sizeof(struct vlan_ioctl_args
)))
673 static int __net_init
vlan_init_net(struct net
*net
)
675 struct vlan_net
*vn
= net_generic(net
, vlan_net_id
);
678 vn
->name_type
= VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD
;
680 err
= vlan_proc_init(net
);
685 static void __net_exit
vlan_exit_net(struct net
*net
)
687 vlan_proc_cleanup(net
);
690 static struct pernet_operations vlan_net_ops
= {
691 .init
= vlan_init_net
,
692 .exit
= vlan_exit_net
,
694 .size
= sizeof(struct vlan_net
),
697 static int __init
vlan_proto_init(void)
701 pr_info("%s v%s %s\n", vlan_fullname
, vlan_version
, vlan_copyright
);
702 pr_info("All bugs added by %s\n", vlan_buggyright
);
704 err
= register_pernet_subsys(&vlan_net_ops
);
708 err
= register_netdevice_notifier(&vlan_notifier_block
);
712 err
= vlan_gvrp_init();
716 err
= vlan_netlink_init();
720 dev_add_pack(&vlan_packet_type
);
721 vlan_ioctl_set(vlan_ioctl_handler
);
727 unregister_netdevice_notifier(&vlan_notifier_block
);
729 unregister_pernet_subsys(&vlan_net_ops
);
734 static void __exit
vlan_cleanup_module(void)
738 vlan_ioctl_set(NULL
);
741 unregister_netdevice_notifier(&vlan_notifier_block
);
743 dev_remove_pack(&vlan_packet_type
);
745 /* This table must be empty if there are no module references left. */
746 for (i
= 0; i
< VLAN_GRP_HASH_SIZE
; i
++)
747 BUG_ON(!hlist_empty(&vlan_group_hash
[i
]));
749 unregister_pernet_subsys(&vlan_net_ops
);
750 rcu_barrier(); /* Wait for completion of call_rcu()'s */
755 module_init(vlan_proto_init
);
756 module_exit(vlan_cleanup_module
);
758 MODULE_LICENSE("GPL");
759 MODULE_VERSION(DRV_VERSION
);