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 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
23 #include <linux/capability.h>
24 #include <linux/module.h>
25 #include <linux/netdevice.h>
26 #include <linux/skbuff.h>
27 #include <linux/slab.h>
28 #include <linux/init.h>
29 #include <linux/rculist.h>
30 #include <net/p8022.h>
32 #include <linux/rtnetlink.h>
33 #include <linux/notifier.h>
34 #include <net/rtnetlink.h>
35 #include <net/net_namespace.h>
36 #include <net/netns/generic.h>
37 #include <asm/uaccess.h>
39 #include <linux/if_vlan.h>
43 #define DRV_VERSION "1.8"
45 /* Global VLAN variables */
47 int vlan_net_id __read_mostly
;
49 const char vlan_fullname
[] = "802.1Q VLAN Support";
50 const char vlan_version
[] = DRV_VERSION
;
52 /* End of global variables definitions. */
54 static int vlan_group_prealloc_vid(struct vlan_group
*vg
,
55 __be16 vlan_proto
, u16 vlan_id
)
57 struct net_device
**array
;
58 unsigned int pidx
, vidx
;
63 pidx
= vlan_proto_idx(vlan_proto
);
64 vidx
= vlan_id
/ VLAN_GROUP_ARRAY_PART_LEN
;
65 array
= vg
->vlan_devices_arrays
[pidx
][vidx
];
69 size
= sizeof(struct net_device
*) * VLAN_GROUP_ARRAY_PART_LEN
;
70 array
= kzalloc(size
, GFP_KERNEL
);
74 vg
->vlan_devices_arrays
[pidx
][vidx
] = array
;
78 void unregister_vlan_dev(struct net_device
*dev
, struct list_head
*head
)
80 struct vlan_dev_priv
*vlan
= vlan_dev_priv(dev
);
81 struct net_device
*real_dev
= vlan
->real_dev
;
82 struct vlan_info
*vlan_info
;
83 struct vlan_group
*grp
;
84 u16 vlan_id
= vlan
->vlan_id
;
88 vlan_info
= rtnl_dereference(real_dev
->vlan_info
);
91 grp
= &vlan_info
->grp
;
95 if (vlan
->flags
& VLAN_FLAG_MVRP
)
96 vlan_mvrp_request_leave(dev
);
97 if (vlan
->flags
& VLAN_FLAG_GVRP
)
98 vlan_gvrp_request_leave(dev
);
100 vlan_group_set_device(grp
, vlan
->vlan_proto
, vlan_id
, NULL
);
102 netdev_upper_dev_unlink(real_dev
, dev
);
103 /* Because unregister_netdevice_queue() makes sure at least one rcu
104 * grace period is respected before device freeing,
105 * we dont need to call synchronize_net() here.
107 unregister_netdevice_queue(dev
, head
);
109 if (grp
->nr_vlan_devs
== 0) {
110 vlan_mvrp_uninit_applicant(real_dev
);
111 vlan_gvrp_uninit_applicant(real_dev
);
114 /* Take it out of our own structures, but be sure to interlock with
115 * HW accelerating devices or SW vlan input packet processing if
116 * VLAN is not 0 (leave it there for 802.1p).
119 vlan_vid_del(real_dev
, vlan
->vlan_proto
, vlan_id
);
121 /* Get rid of the vlan's reference to real_dev */
125 int vlan_check_real_dev(struct net_device
*real_dev
,
126 __be16 protocol
, u16 vlan_id
)
128 const char *name
= real_dev
->name
;
130 if (real_dev
->features
& NETIF_F_VLAN_CHALLENGED
) {
131 pr_info("VLANs not supported on %s\n", name
);
135 if (vlan_find_dev(real_dev
, protocol
, vlan_id
) != NULL
)
141 int register_vlan_dev(struct net_device
*dev
)
143 struct vlan_dev_priv
*vlan
= vlan_dev_priv(dev
);
144 struct net_device
*real_dev
= vlan
->real_dev
;
145 u16 vlan_id
= vlan
->vlan_id
;
146 struct vlan_info
*vlan_info
;
147 struct vlan_group
*grp
;
150 err
= vlan_vid_add(real_dev
, vlan
->vlan_proto
, vlan_id
);
154 vlan_info
= rtnl_dereference(real_dev
->vlan_info
);
155 /* vlan_info should be there now. vlan_vid_add took care of it */
158 grp
= &vlan_info
->grp
;
159 if (grp
->nr_vlan_devs
== 0) {
160 err
= vlan_gvrp_init_applicant(real_dev
);
163 err
= vlan_mvrp_init_applicant(real_dev
);
165 goto out_uninit_gvrp
;
168 err
= vlan_group_prealloc_vid(grp
, vlan
->vlan_proto
, vlan_id
);
170 goto out_uninit_mvrp
;
172 vlan
->nest_level
= dev_get_nest_level(real_dev
, is_vlan_dev
) + 1;
173 err
= register_netdevice(dev
);
175 goto out_uninit_mvrp
;
177 err
= netdev_upper_dev_link(real_dev
, dev
);
179 goto out_unregister_netdev
;
181 /* Account for reference in struct vlan_dev_priv */
184 netif_stacked_transfer_operstate(real_dev
, dev
);
185 linkwatch_fire_event(dev
); /* _MUST_ call rfc2863_policy() */
187 /* So, got the sucker initialized, now lets place
188 * it into our local structure.
190 vlan_group_set_device(grp
, vlan
->vlan_proto
, vlan_id
, dev
);
195 out_unregister_netdev
:
196 unregister_netdevice(dev
);
198 if (grp
->nr_vlan_devs
== 0)
199 vlan_mvrp_uninit_applicant(real_dev
);
201 if (grp
->nr_vlan_devs
== 0)
202 vlan_gvrp_uninit_applicant(real_dev
);
204 vlan_vid_del(real_dev
, vlan
->vlan_proto
, vlan_id
);
208 /* Attach a VLAN device to a mac address (ie Ethernet Card).
209 * Returns 0 if the device was created or a negative error code otherwise.
211 static int register_vlan_device(struct net_device
*real_dev
, u16 vlan_id
)
213 struct net_device
*new_dev
;
214 struct vlan_dev_priv
*vlan
;
215 struct net
*net
= dev_net(real_dev
);
216 struct vlan_net
*vn
= net_generic(net
, vlan_net_id
);
220 if (vlan_id
>= VLAN_VID_MASK
)
223 err
= vlan_check_real_dev(real_dev
, htons(ETH_P_8021Q
), vlan_id
);
227 /* Gotta set up the fields for the device. */
228 switch (vn
->name_type
) {
229 case VLAN_NAME_TYPE_RAW_PLUS_VID
:
230 /* name will look like: eth1.0005 */
231 snprintf(name
, IFNAMSIZ
, "%s.%.4i", real_dev
->name
, vlan_id
);
233 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD
:
234 /* Put our vlan.VID in the name.
235 * Name will look like: vlan5
237 snprintf(name
, IFNAMSIZ
, "vlan%i", vlan_id
);
239 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD
:
240 /* Put our vlan.VID in the name.
241 * Name will look like: eth0.5
243 snprintf(name
, IFNAMSIZ
, "%s.%i", real_dev
->name
, vlan_id
);
245 case VLAN_NAME_TYPE_PLUS_VID
:
246 /* Put our vlan.VID in the name.
247 * Name will look like: vlan0005
250 snprintf(name
, IFNAMSIZ
, "vlan%.4i", vlan_id
);
253 new_dev
= alloc_netdev(sizeof(struct vlan_dev_priv
), name
,
254 NET_NAME_UNKNOWN
, vlan_setup
);
259 dev_net_set(new_dev
, net
);
260 /* need 4 bytes for extra VLAN header info,
261 * hope the underlying device can handle it.
263 new_dev
->mtu
= real_dev
->mtu
;
265 vlan
= vlan_dev_priv(new_dev
);
266 vlan
->vlan_proto
= htons(ETH_P_8021Q
);
267 vlan
->vlan_id
= vlan_id
;
268 vlan
->real_dev
= real_dev
;
270 vlan
->flags
= VLAN_FLAG_REORDER_HDR
;
272 new_dev
->rtnl_link_ops
= &vlan_link_ops
;
273 err
= register_vlan_dev(new_dev
);
275 goto out_free_newdev
;
280 free_netdev(new_dev
);
284 static void vlan_sync_address(struct net_device
*dev
,
285 struct net_device
*vlandev
)
287 struct vlan_dev_priv
*vlan
= vlan_dev_priv(vlandev
);
289 /* May be called without an actual change */
290 if (ether_addr_equal(vlan
->real_dev_addr
, dev
->dev_addr
))
293 /* vlan address was different from the old address and is equal to
295 if (!ether_addr_equal(vlandev
->dev_addr
, vlan
->real_dev_addr
) &&
296 ether_addr_equal(vlandev
->dev_addr
, dev
->dev_addr
))
297 dev_uc_del(dev
, vlandev
->dev_addr
);
299 /* vlan address was equal to the old address and is different from
301 if (ether_addr_equal(vlandev
->dev_addr
, vlan
->real_dev_addr
) &&
302 !ether_addr_equal(vlandev
->dev_addr
, dev
->dev_addr
))
303 dev_uc_add(dev
, vlandev
->dev_addr
);
305 ether_addr_copy(vlan
->real_dev_addr
, dev
->dev_addr
);
308 static void vlan_transfer_features(struct net_device
*dev
,
309 struct net_device
*vlandev
)
311 struct vlan_dev_priv
*vlan
= vlan_dev_priv(vlandev
);
313 vlandev
->gso_max_size
= dev
->gso_max_size
;
315 if (vlan_hw_offload_capable(dev
->features
, vlan
->vlan_proto
))
316 vlandev
->hard_header_len
= dev
->hard_header_len
;
318 vlandev
->hard_header_len
= dev
->hard_header_len
+ VLAN_HLEN
;
320 #if IS_ENABLED(CONFIG_FCOE)
321 vlandev
->fcoe_ddp_xid
= dev
->fcoe_ddp_xid
;
324 netdev_update_features(vlandev
);
327 static int __vlan_device_event(struct net_device
*dev
, unsigned long event
)
332 case NETDEV_CHANGENAME
:
333 vlan_proc_rem_dev(dev
);
334 err
= vlan_proc_add_dev(dev
);
336 case NETDEV_REGISTER
:
337 err
= vlan_proc_add_dev(dev
);
339 case NETDEV_UNREGISTER
:
340 vlan_proc_rem_dev(dev
);
347 static int vlan_device_event(struct notifier_block
*unused
, unsigned long event
,
350 struct net_device
*dev
= netdev_notifier_info_to_dev(ptr
);
351 struct vlan_group
*grp
;
352 struct vlan_info
*vlan_info
;
354 struct net_device
*vlandev
;
355 struct vlan_dev_priv
*vlan
;
359 if (is_vlan_dev(dev
)) {
360 int err
= __vlan_device_event(dev
, event
);
363 return notifier_from_errno(err
);
366 if ((event
== NETDEV_UP
) &&
367 (dev
->features
& NETIF_F_HW_VLAN_CTAG_FILTER
)) {
368 pr_info("adding VLAN 0 to HW filter on device %s\n",
370 vlan_vid_add(dev
, htons(ETH_P_8021Q
), 0);
373 vlan_info
= rtnl_dereference(dev
->vlan_info
);
376 grp
= &vlan_info
->grp
;
378 /* It is OK that we do not hold the group lock right now,
379 * as we run under the RTNL lock.
384 /* Propagate real device state to vlan devices */
385 vlan_group_for_each_dev(grp
, i
, vlandev
)
386 netif_stacked_transfer_operstate(dev
, vlandev
);
389 case NETDEV_CHANGEADDR
:
390 /* Adjust unicast filters on underlying device */
391 vlan_group_for_each_dev(grp
, i
, vlandev
) {
392 flgs
= vlandev
->flags
;
393 if (!(flgs
& IFF_UP
))
396 vlan_sync_address(dev
, vlandev
);
400 case NETDEV_CHANGEMTU
:
401 vlan_group_for_each_dev(grp
, i
, vlandev
) {
402 if (vlandev
->mtu
<= dev
->mtu
)
405 dev_set_mtu(vlandev
, dev
->mtu
);
409 case NETDEV_FEAT_CHANGE
:
410 /* Propagate device features to underlying device */
411 vlan_group_for_each_dev(grp
, i
, vlandev
)
412 vlan_transfer_features(dev
, vlandev
);
416 struct net_device
*tmp
;
417 LIST_HEAD(close_list
);
419 if (dev
->features
& NETIF_F_HW_VLAN_CTAG_FILTER
)
420 vlan_vid_del(dev
, htons(ETH_P_8021Q
), 0);
422 /* Put all VLANs for this dev in the down state too. */
423 vlan_group_for_each_dev(grp
, i
, vlandev
) {
424 flgs
= vlandev
->flags
;
425 if (!(flgs
& IFF_UP
))
428 vlan
= vlan_dev_priv(vlandev
);
429 if (!(vlan
->flags
& VLAN_FLAG_LOOSE_BINDING
))
430 list_add(&vlandev
->close_list
, &close_list
);
433 dev_close_many(&close_list
, false);
435 list_for_each_entry_safe(vlandev
, tmp
, &close_list
, close_list
) {
436 netif_stacked_transfer_operstate(dev
, vlandev
);
437 list_del_init(&vlandev
->close_list
);
439 list_del(&close_list
);
443 /* Put all VLANs for this dev in the up state too. */
444 vlan_group_for_each_dev(grp
, i
, vlandev
) {
445 flgs
= dev_get_flags(vlandev
);
449 vlan
= vlan_dev_priv(vlandev
);
450 if (!(vlan
->flags
& VLAN_FLAG_LOOSE_BINDING
))
451 dev_change_flags(vlandev
, flgs
| IFF_UP
);
452 netif_stacked_transfer_operstate(dev
, vlandev
);
456 case NETDEV_UNREGISTER
:
457 /* twiddle thumbs on netns device moves */
458 if (dev
->reg_state
!= NETREG_UNREGISTERING
)
461 vlan_group_for_each_dev(grp
, i
, vlandev
) {
462 /* removal of last vid destroys vlan_info, abort
464 if (vlan_info
->nr_vids
== 1)
467 unregister_vlan_dev(vlandev
, &list
);
471 unregister_netdevice_many(&list
);
474 case NETDEV_PRE_TYPE_CHANGE
:
475 /* Forbid underlaying device to change its type. */
476 if (vlan_uses_dev(dev
))
480 case NETDEV_NOTIFY_PEERS
:
481 case NETDEV_BONDING_FAILOVER
:
482 case NETDEV_RESEND_IGMP
:
483 /* Propagate to vlan devices */
484 vlan_group_for_each_dev(grp
, i
, vlandev
)
485 call_netdevice_notifiers(event
, vlandev
);
493 static struct notifier_block vlan_notifier_block __read_mostly
= {
494 .notifier_call
= vlan_device_event
,
498 * VLAN IOCTL handler.
499 * o execute requested action or pass command to the device driver
500 * arg is really a struct vlan_ioctl_args __user *.
502 static int vlan_ioctl_handler(struct net
*net
, void __user
*arg
)
505 struct vlan_ioctl_args args
;
506 struct net_device
*dev
= NULL
;
508 if (copy_from_user(&args
, arg
, sizeof(struct vlan_ioctl_args
)))
511 /* Null terminate this sucker, just in case. */
512 args
.device1
[23] = 0;
513 args
.u
.device2
[23] = 0;
518 case SET_VLAN_INGRESS_PRIORITY_CMD
:
519 case SET_VLAN_EGRESS_PRIORITY_CMD
:
520 case SET_VLAN_FLAG_CMD
:
523 case GET_VLAN_REALDEV_NAME_CMD
:
524 case GET_VLAN_VID_CMD
:
526 dev
= __dev_get_by_name(net
, args
.device1
);
531 if (args
.cmd
!= ADD_VLAN_CMD
&& !is_vlan_dev(dev
))
536 case SET_VLAN_INGRESS_PRIORITY_CMD
:
538 if (!ns_capable(net
->user_ns
, CAP_NET_ADMIN
))
540 vlan_dev_set_ingress_priority(dev
,
546 case SET_VLAN_EGRESS_PRIORITY_CMD
:
548 if (!ns_capable(net
->user_ns
, CAP_NET_ADMIN
))
550 err
= vlan_dev_set_egress_priority(dev
,
555 case SET_VLAN_FLAG_CMD
:
557 if (!ns_capable(net
->user_ns
, CAP_NET_ADMIN
))
559 err
= vlan_dev_change_flags(dev
,
560 args
.vlan_qos
? args
.u
.flag
: 0,
564 case SET_VLAN_NAME_TYPE_CMD
:
566 if (!ns_capable(net
->user_ns
, CAP_NET_ADMIN
))
568 if ((args
.u
.name_type
>= 0) &&
569 (args
.u
.name_type
< VLAN_NAME_TYPE_HIGHEST
)) {
572 vn
= net_generic(net
, vlan_net_id
);
573 vn
->name_type
= args
.u
.name_type
;
582 if (!ns_capable(net
->user_ns
, CAP_NET_ADMIN
))
584 err
= register_vlan_device(dev
, args
.u
.VID
);
589 if (!ns_capable(net
->user_ns
, CAP_NET_ADMIN
))
591 unregister_vlan_dev(dev
, NULL
);
595 case GET_VLAN_REALDEV_NAME_CMD
:
597 vlan_dev_get_realdev_name(dev
, args
.u
.device2
);
598 if (copy_to_user(arg
, &args
,
599 sizeof(struct vlan_ioctl_args
)))
603 case GET_VLAN_VID_CMD
:
605 args
.u
.VID
= vlan_dev_vlan_id(dev
);
606 if (copy_to_user(arg
, &args
,
607 sizeof(struct vlan_ioctl_args
)))
620 static struct sk_buff
**vlan_gro_receive(struct sk_buff
**head
,
623 struct sk_buff
*p
, **pp
= NULL
;
624 struct vlan_hdr
*vhdr
;
625 unsigned int hlen
, off_vlan
;
626 const struct packet_offload
*ptype
;
630 off_vlan
= skb_gro_offset(skb
);
631 hlen
= off_vlan
+ sizeof(*vhdr
);
632 vhdr
= skb_gro_header_fast(skb
, off_vlan
);
633 if (skb_gro_header_hard(skb
, hlen
)) {
634 vhdr
= skb_gro_header_slow(skb
, hlen
, off_vlan
);
639 type
= vhdr
->h_vlan_encapsulated_proto
;
642 ptype
= gro_find_receive_by_type(type
);
648 for (p
= *head
; p
; p
= p
->next
) {
649 struct vlan_hdr
*vhdr2
;
651 if (!NAPI_GRO_CB(p
)->same_flow
)
654 vhdr2
= (struct vlan_hdr
*)(p
->data
+ off_vlan
);
655 if (compare_vlan_header(vhdr
, vhdr2
))
656 NAPI_GRO_CB(p
)->same_flow
= 0;
659 skb_gro_pull(skb
, sizeof(*vhdr
));
660 skb_gro_postpull_rcsum(skb
, vhdr
, sizeof(*vhdr
));
661 pp
= ptype
->callbacks
.gro_receive(head
, skb
);
666 NAPI_GRO_CB(skb
)->flush
|= flush
;
671 static int vlan_gro_complete(struct sk_buff
*skb
, int nhoff
)
673 struct vlan_hdr
*vhdr
= (struct vlan_hdr
*)(skb
->data
+ nhoff
);
674 __be16 type
= vhdr
->h_vlan_encapsulated_proto
;
675 struct packet_offload
*ptype
;
679 ptype
= gro_find_complete_by_type(type
);
681 err
= ptype
->callbacks
.gro_complete(skb
, nhoff
+ sizeof(*vhdr
));
687 static struct packet_offload vlan_packet_offloads
[] __read_mostly
= {
689 .type
= cpu_to_be16(ETH_P_8021Q
),
692 .gro_receive
= vlan_gro_receive
,
693 .gro_complete
= vlan_gro_complete
,
697 .type
= cpu_to_be16(ETH_P_8021AD
),
700 .gro_receive
= vlan_gro_receive
,
701 .gro_complete
= vlan_gro_complete
,
706 static int __net_init
vlan_init_net(struct net
*net
)
708 struct vlan_net
*vn
= net_generic(net
, vlan_net_id
);
711 vn
->name_type
= VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD
;
713 err
= vlan_proc_init(net
);
718 static void __net_exit
vlan_exit_net(struct net
*net
)
720 vlan_proc_cleanup(net
);
723 static struct pernet_operations vlan_net_ops
= {
724 .init
= vlan_init_net
,
725 .exit
= vlan_exit_net
,
727 .size
= sizeof(struct vlan_net
),
730 static int __init
vlan_proto_init(void)
735 pr_info("%s v%s\n", vlan_fullname
, vlan_version
);
737 err
= register_pernet_subsys(&vlan_net_ops
);
741 err
= register_netdevice_notifier(&vlan_notifier_block
);
745 err
= vlan_gvrp_init();
749 err
= vlan_mvrp_init();
753 err
= vlan_netlink_init();
757 for (i
= 0; i
< ARRAY_SIZE(vlan_packet_offloads
); i
++)
758 dev_add_offload(&vlan_packet_offloads
[i
]);
760 vlan_ioctl_set(vlan_ioctl_handler
);
768 unregister_netdevice_notifier(&vlan_notifier_block
);
770 unregister_pernet_subsys(&vlan_net_ops
);
775 static void __exit
vlan_cleanup_module(void)
779 vlan_ioctl_set(NULL
);
781 for (i
= 0; i
< ARRAY_SIZE(vlan_packet_offloads
); i
++)
782 dev_remove_offload(&vlan_packet_offloads
[i
]);
786 unregister_netdevice_notifier(&vlan_notifier_block
);
788 unregister_pernet_subsys(&vlan_net_ops
);
789 rcu_barrier(); /* Wait for completion of call_rcu()'s */
795 module_init(vlan_proto_init
);
796 module_exit(vlan_cleanup_module
);
798 MODULE_LICENSE("GPL");
799 MODULE_VERSION(DRV_VERSION
);