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/init.h>
26 #include <linux/rculist.h>
27 #include <net/p8022.h>
29 #include <linux/rtnetlink.h>
30 #include <linux/notifier.h>
31 #include <net/rtnetlink.h>
32 #include <net/net_namespace.h>
33 #include <net/netns/generic.h>
34 #include <asm/uaccess.h>
36 #include <linux/if_vlan.h>
40 #define DRV_VERSION "1.8"
42 /* Global VLAN variables */
44 int vlan_net_id __read_mostly
;
46 /* Our listing of VLAN group(s) */
47 static struct hlist_head vlan_group_hash
[VLAN_GRP_HASH_SIZE
];
49 const char vlan_fullname
[] = "802.1Q VLAN Support";
50 const char vlan_version
[] = DRV_VERSION
;
51 static const char vlan_copyright
[] = "Ben Greear <greearb@candelatech.com>";
52 static const char vlan_buggyright
[] = "David S. Miller <davem@redhat.com>";
54 static struct packet_type vlan_packet_type __read_mostly
= {
55 .type
= cpu_to_be16(ETH_P_8021Q
),
56 .func
= vlan_skb_recv
, /* VLAN receive method */
59 /* End of global variables definitions. */
61 static inline unsigned int vlan_grp_hashfn(unsigned int idx
)
63 return ((idx
>> VLAN_GRP_HASH_SHIFT
) ^ idx
) & VLAN_GRP_HASH_MASK
;
66 /* Must be invoked with RCU read lock (no preempt) */
67 static struct vlan_group
*__vlan_find_group(struct net_device
*real_dev
)
69 struct vlan_group
*grp
;
71 int hash
= vlan_grp_hashfn(real_dev
->ifindex
);
73 hlist_for_each_entry_rcu(grp
, n
, &vlan_group_hash
[hash
], hlist
) {
74 if (grp
->real_dev
== real_dev
)
81 /* Find the protocol handler. Assumes VID < VLAN_VID_MASK.
83 * Must be invoked with RCU read lock (no preempt)
85 struct net_device
*__find_vlan_dev(struct net_device
*real_dev
, u16 vlan_id
)
87 struct vlan_group
*grp
= __vlan_find_group(real_dev
);
90 return vlan_group_get_device(grp
, vlan_id
);
95 static void vlan_group_free(struct vlan_group
*grp
)
99 for (i
= 0; i
< VLAN_GROUP_ARRAY_SPLIT_PARTS
; i
++)
100 kfree(grp
->vlan_devices_arrays
[i
]);
104 static struct vlan_group
*vlan_group_alloc(struct net_device
*real_dev
)
106 struct vlan_group
*grp
;
108 grp
= kzalloc(sizeof(struct vlan_group
), GFP_KERNEL
);
112 grp
->real_dev
= real_dev
;
113 hlist_add_head_rcu(&grp
->hlist
,
114 &vlan_group_hash
[vlan_grp_hashfn(real_dev
->ifindex
)]);
118 static int vlan_group_prealloc_vid(struct vlan_group
*vg
, u16 vlan_id
)
120 struct net_device
**array
;
125 array
= vg
->vlan_devices_arrays
[vlan_id
/ VLAN_GROUP_ARRAY_PART_LEN
];
129 size
= sizeof(struct net_device
*) * VLAN_GROUP_ARRAY_PART_LEN
;
130 array
= kzalloc(size
, GFP_KERNEL
);
134 vg
->vlan_devices_arrays
[vlan_id
/ VLAN_GROUP_ARRAY_PART_LEN
] = array
;
138 static void vlan_rcu_free(struct rcu_head
*rcu
)
140 vlan_group_free(container_of(rcu
, struct vlan_group
, rcu
));
143 void unregister_vlan_dev(struct net_device
*dev
, struct list_head
*head
)
145 struct vlan_dev_info
*vlan
= vlan_dev_info(dev
);
146 struct net_device
*real_dev
= vlan
->real_dev
;
147 const struct net_device_ops
*ops
= real_dev
->netdev_ops
;
148 struct vlan_group
*grp
;
149 u16 vlan_id
= vlan
->vlan_id
;
153 grp
= __vlan_find_group(real_dev
);
156 /* Take it out of our own structures, but be sure to interlock with
157 * HW accelerating devices or SW vlan input packet processing.
159 if (real_dev
->features
& NETIF_F_HW_VLAN_FILTER
)
160 ops
->ndo_vlan_rx_kill_vid(real_dev
, vlan_id
);
164 vlan_group_set_device(grp
, vlan_id
, NULL
);
168 unregister_netdevice_queue(dev
, head
);
170 /* If the group is now empty, kill off the group. */
171 if (grp
->nr_vlans
== 0) {
172 vlan_gvrp_uninit_applicant(real_dev
);
174 if (real_dev
->features
& NETIF_F_HW_VLAN_RX
)
175 ops
->ndo_vlan_rx_register(real_dev
, NULL
);
177 hlist_del_rcu(&grp
->hlist
);
179 /* Free the group, after all cpu's are done. */
180 call_rcu(&grp
->rcu
, vlan_rcu_free
);
183 /* Get rid of the vlan's reference to real_dev */
187 int vlan_check_real_dev(struct net_device
*real_dev
, u16 vlan_id
)
189 const char *name
= real_dev
->name
;
190 const struct net_device_ops
*ops
= real_dev
->netdev_ops
;
192 if (real_dev
->features
& NETIF_F_VLAN_CHALLENGED
) {
193 pr_info("8021q: VLANs not supported on %s\n", name
);
197 if ((real_dev
->features
& NETIF_F_HW_VLAN_RX
) && !ops
->ndo_vlan_rx_register
) {
198 pr_info("8021q: device %s has buggy VLAN hw accel\n", name
);
202 if ((real_dev
->features
& NETIF_F_HW_VLAN_FILTER
) &&
203 (!ops
->ndo_vlan_rx_add_vid
|| !ops
->ndo_vlan_rx_kill_vid
)) {
204 pr_info("8021q: Device %s has buggy VLAN hw accel\n", name
);
208 if (__find_vlan_dev(real_dev
, vlan_id
) != NULL
)
214 int register_vlan_dev(struct net_device
*dev
)
216 struct vlan_dev_info
*vlan
= vlan_dev_info(dev
);
217 struct net_device
*real_dev
= vlan
->real_dev
;
218 const struct net_device_ops
*ops
= real_dev
->netdev_ops
;
219 u16 vlan_id
= vlan
->vlan_id
;
220 struct vlan_group
*grp
, *ngrp
= NULL
;
223 grp
= __vlan_find_group(real_dev
);
225 ngrp
= grp
= vlan_group_alloc(real_dev
);
228 err
= vlan_gvrp_init_applicant(real_dev
);
233 err
= vlan_group_prealloc_vid(grp
, vlan_id
);
235 goto out_uninit_applicant
;
237 err
= register_netdevice(dev
);
239 goto out_uninit_applicant
;
241 /* Account for reference in struct vlan_dev_info */
244 netif_stacked_transfer_operstate(real_dev
, dev
);
245 linkwatch_fire_event(dev
); /* _MUST_ call rfc2863_policy() */
247 /* So, got the sucker initialized, now lets place
248 * it into our local structure.
250 vlan_group_set_device(grp
, vlan_id
, dev
);
253 if (ngrp
&& real_dev
->features
& NETIF_F_HW_VLAN_RX
)
254 ops
->ndo_vlan_rx_register(real_dev
, ngrp
);
255 if (real_dev
->features
& NETIF_F_HW_VLAN_FILTER
)
256 ops
->ndo_vlan_rx_add_vid(real_dev
, vlan_id
);
260 out_uninit_applicant
:
262 vlan_gvrp_uninit_applicant(real_dev
);
265 hlist_del_rcu(&ngrp
->hlist
);
266 /* Free the group, after all cpu's are done. */
267 call_rcu(&ngrp
->rcu
, vlan_rcu_free
);
272 /* Attach a VLAN device to a mac address (ie Ethernet Card).
273 * Returns 0 if the device was created or a negative error code otherwise.
275 static int register_vlan_device(struct net_device
*real_dev
, u16 vlan_id
)
277 struct net_device
*new_dev
;
278 struct net
*net
= dev_net(real_dev
);
279 struct vlan_net
*vn
= net_generic(net
, vlan_net_id
);
283 if (vlan_id
>= VLAN_VID_MASK
)
286 err
= vlan_check_real_dev(real_dev
, vlan_id
);
290 /* Gotta set up the fields for the device. */
291 switch (vn
->name_type
) {
292 case VLAN_NAME_TYPE_RAW_PLUS_VID
:
293 /* name will look like: eth1.0005 */
294 snprintf(name
, IFNAMSIZ
, "%s.%.4i", real_dev
->name
, vlan_id
);
296 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD
:
297 /* Put our vlan.VID in the name.
298 * Name will look like: vlan5
300 snprintf(name
, IFNAMSIZ
, "vlan%i", vlan_id
);
302 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD
:
303 /* Put our vlan.VID in the name.
304 * Name will look like: eth0.5
306 snprintf(name
, IFNAMSIZ
, "%s.%i", real_dev
->name
, vlan_id
);
308 case VLAN_NAME_TYPE_PLUS_VID
:
309 /* Put our vlan.VID in the name.
310 * Name will look like: vlan0005
313 snprintf(name
, IFNAMSIZ
, "vlan%.4i", vlan_id
);
316 new_dev
= alloc_netdev_mq(sizeof(struct vlan_dev_info
), name
,
317 vlan_setup
, real_dev
->num_tx_queues
);
322 new_dev
->real_num_tx_queues
= real_dev
->real_num_tx_queues
;
323 dev_net_set(new_dev
, net
);
324 /* need 4 bytes for extra VLAN header info,
325 * hope the underlying device can handle it.
327 new_dev
->mtu
= real_dev
->mtu
;
329 vlan_dev_info(new_dev
)->vlan_id
= vlan_id
;
330 vlan_dev_info(new_dev
)->real_dev
= real_dev
;
331 vlan_dev_info(new_dev
)->dent
= NULL
;
332 vlan_dev_info(new_dev
)->flags
= VLAN_FLAG_REORDER_HDR
;
334 new_dev
->rtnl_link_ops
= &vlan_link_ops
;
335 err
= register_vlan_dev(new_dev
);
337 goto out_free_newdev
;
342 free_netdev(new_dev
);
346 static void vlan_sync_address(struct net_device
*dev
,
347 struct net_device
*vlandev
)
349 struct vlan_dev_info
*vlan
= vlan_dev_info(vlandev
);
351 /* May be called without an actual change */
352 if (!compare_ether_addr(vlan
->real_dev_addr
, dev
->dev_addr
))
355 /* vlan address was different from the old address and is equal to
357 if (compare_ether_addr(vlandev
->dev_addr
, vlan
->real_dev_addr
) &&
358 !compare_ether_addr(vlandev
->dev_addr
, dev
->dev_addr
))
359 dev_uc_del(dev
, vlandev
->dev_addr
);
361 /* vlan address was equal to the old address and is different from
363 if (!compare_ether_addr(vlandev
->dev_addr
, vlan
->real_dev_addr
) &&
364 compare_ether_addr(vlandev
->dev_addr
, dev
->dev_addr
))
365 dev_uc_add(dev
, vlandev
->dev_addr
);
367 memcpy(vlan
->real_dev_addr
, dev
->dev_addr
, ETH_ALEN
);
370 static void vlan_transfer_features(struct net_device
*dev
,
371 struct net_device
*vlandev
)
373 unsigned long old_features
= vlandev
->features
;
375 vlandev
->features
&= ~dev
->vlan_features
;
376 vlandev
->features
|= dev
->features
& dev
->vlan_features
;
377 vlandev
->gso_max_size
= dev
->gso_max_size
;
378 #if defined(CONFIG_FCOE) || defined(CONFIG_FCOE_MODULE)
379 vlandev
->fcoe_ddp_xid
= dev
->fcoe_ddp_xid
;
382 if (old_features
!= vlandev
->features
)
383 netdev_features_change(vlandev
);
386 static void __vlan_device_event(struct net_device
*dev
, unsigned long event
)
389 case NETDEV_CHANGENAME
:
390 vlan_proc_rem_dev(dev
);
391 if (vlan_proc_add_dev(dev
) < 0)
392 pr_warning("8021q: failed to change proc name for %s\n",
395 case NETDEV_REGISTER
:
396 if (vlan_proc_add_dev(dev
) < 0)
397 pr_warning("8021q: failed to add proc entry for %s\n",
400 case NETDEV_UNREGISTER
:
401 vlan_proc_rem_dev(dev
);
406 static int vlan_device_event(struct notifier_block
*unused
, unsigned long event
,
409 struct net_device
*dev
= ptr
;
410 struct vlan_group
*grp
;
412 struct net_device
*vlandev
;
413 struct vlan_dev_info
*vlan
;
416 if (is_vlan_dev(dev
))
417 __vlan_device_event(dev
, event
);
419 grp
= __vlan_find_group(dev
);
423 /* It is OK that we do not hold the group lock right now,
424 * as we run under the RTNL lock.
429 /* Propagate real device state to vlan devices */
430 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
431 vlandev
= vlan_group_get_device(grp
, i
);
435 netif_stacked_transfer_operstate(dev
, vlandev
);
439 case NETDEV_CHANGEADDR
:
440 /* Adjust unicast filters on underlying device */
441 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
442 vlandev
= vlan_group_get_device(grp
, i
);
446 flgs
= vlandev
->flags
;
447 if (!(flgs
& IFF_UP
))
450 vlan_sync_address(dev
, vlandev
);
454 case NETDEV_CHANGEMTU
:
455 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
456 vlandev
= vlan_group_get_device(grp
, i
);
460 if (vlandev
->mtu
<= dev
->mtu
)
463 dev_set_mtu(vlandev
, dev
->mtu
);
467 case NETDEV_FEAT_CHANGE
:
468 /* Propagate device features to underlying device */
469 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
470 vlandev
= vlan_group_get_device(grp
, i
);
474 vlan_transfer_features(dev
, vlandev
);
480 /* Put all VLANs for this dev in the down state too. */
481 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
482 vlandev
= vlan_group_get_device(grp
, i
);
486 flgs
= vlandev
->flags
;
487 if (!(flgs
& IFF_UP
))
490 vlan
= vlan_dev_info(vlandev
);
491 if (!(vlan
->flags
& VLAN_FLAG_LOOSE_BINDING
))
492 dev_change_flags(vlandev
, flgs
& ~IFF_UP
);
493 netif_stacked_transfer_operstate(dev
, vlandev
);
498 /* Put all VLANs for this dev in the up state too. */
499 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
500 vlandev
= vlan_group_get_device(grp
, i
);
504 flgs
= vlandev
->flags
;
508 vlan
= vlan_dev_info(vlandev
);
509 if (!(vlan
->flags
& VLAN_FLAG_LOOSE_BINDING
))
510 dev_change_flags(vlandev
, flgs
| IFF_UP
);
511 netif_stacked_transfer_operstate(dev
, vlandev
);
515 case NETDEV_UNREGISTER
:
516 /* Delete all VLANs for this dev. */
519 for (i
= 0; i
< VLAN_GROUP_ARRAY_LEN
; i
++) {
520 vlandev
= vlan_group_get_device(grp
, i
);
524 /* unregistration of last vlan destroys group, abort
526 if (grp
->nr_vlans
== 1)
527 i
= VLAN_GROUP_ARRAY_LEN
;
529 unregister_vlan_dev(vlandev
, &list
);
531 unregister_netdevice_many(&list
);
534 case NETDEV_PRE_TYPE_CHANGE
:
535 /* Forbid underlaying device to change its type. */
543 static struct notifier_block vlan_notifier_block __read_mostly
= {
544 .notifier_call
= vlan_device_event
,
548 * VLAN IOCTL handler.
549 * o execute requested action or pass command to the device driver
550 * arg is really a struct vlan_ioctl_args __user *.
552 static int vlan_ioctl_handler(struct net
*net
, void __user
*arg
)
555 struct vlan_ioctl_args args
;
556 struct net_device
*dev
= NULL
;
558 if (copy_from_user(&args
, arg
, sizeof(struct vlan_ioctl_args
)))
561 /* Null terminate this sucker, just in case. */
562 args
.device1
[23] = 0;
563 args
.u
.device2
[23] = 0;
568 case SET_VLAN_INGRESS_PRIORITY_CMD
:
569 case SET_VLAN_EGRESS_PRIORITY_CMD
:
570 case SET_VLAN_FLAG_CMD
:
573 case GET_VLAN_REALDEV_NAME_CMD
:
574 case GET_VLAN_VID_CMD
:
576 dev
= __dev_get_by_name(net
, args
.device1
);
581 if (args
.cmd
!= ADD_VLAN_CMD
&& !is_vlan_dev(dev
))
586 case SET_VLAN_INGRESS_PRIORITY_CMD
:
588 if (!capable(CAP_NET_ADMIN
))
590 vlan_dev_set_ingress_priority(dev
,
596 case SET_VLAN_EGRESS_PRIORITY_CMD
:
598 if (!capable(CAP_NET_ADMIN
))
600 err
= vlan_dev_set_egress_priority(dev
,
605 case SET_VLAN_FLAG_CMD
:
607 if (!capable(CAP_NET_ADMIN
))
609 err
= vlan_dev_change_flags(dev
,
610 args
.vlan_qos
? args
.u
.flag
: 0,
614 case SET_VLAN_NAME_TYPE_CMD
:
616 if (!capable(CAP_NET_ADMIN
))
618 if ((args
.u
.name_type
>= 0) &&
619 (args
.u
.name_type
< VLAN_NAME_TYPE_HIGHEST
)) {
622 vn
= net_generic(net
, vlan_net_id
);
623 vn
->name_type
= args
.u
.name_type
;
632 if (!capable(CAP_NET_ADMIN
))
634 err
= register_vlan_device(dev
, args
.u
.VID
);
639 if (!capable(CAP_NET_ADMIN
))
641 unregister_vlan_dev(dev
, NULL
);
645 case GET_VLAN_REALDEV_NAME_CMD
:
647 vlan_dev_get_realdev_name(dev
, args
.u
.device2
);
648 if (copy_to_user(arg
, &args
,
649 sizeof(struct vlan_ioctl_args
)))
653 case GET_VLAN_VID_CMD
:
655 args
.u
.VID
= vlan_dev_vlan_id(dev
);
656 if (copy_to_user(arg
, &args
,
657 sizeof(struct vlan_ioctl_args
)))
670 static int __net_init
vlan_init_net(struct net
*net
)
672 struct vlan_net
*vn
= net_generic(net
, vlan_net_id
);
675 vn
->name_type
= VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD
;
677 err
= vlan_proc_init(net
);
682 static void __net_exit
vlan_exit_net(struct net
*net
)
684 vlan_proc_cleanup(net
);
687 static struct pernet_operations vlan_net_ops
= {
688 .init
= vlan_init_net
,
689 .exit
= vlan_exit_net
,
691 .size
= sizeof(struct vlan_net
),
694 static int __init
vlan_proto_init(void)
698 pr_info("%s v%s %s\n", vlan_fullname
, vlan_version
, vlan_copyright
);
699 pr_info("All bugs added by %s\n", vlan_buggyright
);
701 err
= register_pernet_subsys(&vlan_net_ops
);
705 err
= register_netdevice_notifier(&vlan_notifier_block
);
709 err
= vlan_gvrp_init();
713 err
= vlan_netlink_init();
717 dev_add_pack(&vlan_packet_type
);
718 vlan_ioctl_set(vlan_ioctl_handler
);
724 unregister_netdevice_notifier(&vlan_notifier_block
);
726 unregister_pernet_subsys(&vlan_net_ops
);
731 static void __exit
vlan_cleanup_module(void)
735 vlan_ioctl_set(NULL
);
738 unregister_netdevice_notifier(&vlan_notifier_block
);
740 dev_remove_pack(&vlan_packet_type
);
742 /* This table must be empty if there are no module references left. */
743 for (i
= 0; i
< VLAN_GRP_HASH_SIZE
; i
++)
744 BUG_ON(!hlist_empty(&vlan_group_hash
[i
]));
746 unregister_pernet_subsys(&vlan_net_ops
);
747 rcu_barrier(); /* Wait for completion of call_rcu()'s */
752 module_init(vlan_proto_init
);
753 module_exit(vlan_cleanup_module
);
755 MODULE_LICENSE("GPL");
756 MODULE_VERSION(DRV_VERSION
);