1 // SPDX-License-Identifier: GPL-2.0-or-later
4 * Ethernet-type device handling.
6 * Authors: Ben Greear <greearb@candelatech.com>
7 * Please send support related email to: netdev@vger.kernel.org
8 * VLAN Home Page: http://www.candelatech.com/~greear/vlan.html
11 * Fix for packet capture - Nick Eggleston <nick@dccinc.com>;
12 * Add HW acceleration hooks - David S. Miller <davem@redhat.com>;
13 * Correct all the locking - David S. Miller <davem@redhat.com>;
14 * Use hash table for VLAN groups - David S. Miller <davem@redhat.com>
17 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
19 #include <linux/capability.h>
20 #include <linux/module.h>
21 #include <linux/netdevice.h>
22 #include <linux/skbuff.h>
23 #include <linux/slab.h>
24 #include <linux/init.h>
25 #include <linux/rculist.h>
26 #include <net/p8022.h>
28 #include <linux/rtnetlink.h>
29 #include <linux/notifier.h>
30 #include <net/rtnetlink.h>
31 #include <net/net_namespace.h>
32 #include <net/netns/generic.h>
33 #include <linux/uaccess.h>
35 #include <linux/if_vlan.h>
39 #define DRV_VERSION "1.8"
41 /* Global VLAN variables */
43 unsigned int vlan_net_id __read_mostly
;
45 const char vlan_fullname
[] = "802.1Q VLAN Support";
46 const char vlan_version
[] = DRV_VERSION
;
48 /* End of global variables definitions. */
50 static int vlan_group_prealloc_vid(struct vlan_group
*vg
,
51 __be16 vlan_proto
, u16 vlan_id
)
53 struct net_device
**array
;
54 unsigned int pidx
, vidx
;
59 pidx
= vlan_proto_idx(vlan_proto
);
60 vidx
= vlan_id
/ VLAN_GROUP_ARRAY_PART_LEN
;
61 array
= vg
->vlan_devices_arrays
[pidx
][vidx
];
65 size
= sizeof(struct net_device
*) * VLAN_GROUP_ARRAY_PART_LEN
;
66 array
= kzalloc(size
, GFP_KERNEL
);
70 vg
->vlan_devices_arrays
[pidx
][vidx
] = array
;
74 static void vlan_stacked_transfer_operstate(const struct net_device
*rootdev
,
75 struct net_device
*dev
,
76 struct vlan_dev_priv
*vlan
)
78 if (!(vlan
->flags
& VLAN_FLAG_BRIDGE_BINDING
))
79 netif_stacked_transfer_operstate(rootdev
, dev
);
82 void unregister_vlan_dev(struct net_device
*dev
, struct list_head
*head
)
84 struct vlan_dev_priv
*vlan
= vlan_dev_priv(dev
);
85 struct net_device
*real_dev
= vlan
->real_dev
;
86 struct vlan_info
*vlan_info
;
87 struct vlan_group
*grp
;
88 u16 vlan_id
= vlan
->vlan_id
;
92 vlan_info
= rtnl_dereference(real_dev
->vlan_info
);
95 grp
= &vlan_info
->grp
;
99 if (vlan
->flags
& VLAN_FLAG_MVRP
)
100 vlan_mvrp_request_leave(dev
);
101 if (vlan
->flags
& VLAN_FLAG_GVRP
)
102 vlan_gvrp_request_leave(dev
);
104 vlan_group_set_device(grp
, vlan
->vlan_proto
, vlan_id
, NULL
);
106 netdev_upper_dev_unlink(real_dev
, dev
);
107 /* Because unregister_netdevice_queue() makes sure at least one rcu
108 * grace period is respected before device freeing,
109 * we dont need to call synchronize_net() here.
111 unregister_netdevice_queue(dev
, head
);
113 if (grp
->nr_vlan_devs
== 0) {
114 vlan_mvrp_uninit_applicant(real_dev
);
115 vlan_gvrp_uninit_applicant(real_dev
);
118 vlan_vid_del(real_dev
, vlan
->vlan_proto
, vlan_id
);
120 /* Get rid of the vlan's reference to real_dev */
124 int vlan_check_real_dev(struct net_device
*real_dev
,
125 __be16 protocol
, u16 vlan_id
,
126 struct netlink_ext_ack
*extack
)
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
);
132 NL_SET_ERR_MSG_MOD(extack
, "VLANs not supported on device");
136 if (vlan_find_dev(real_dev
, protocol
, vlan_id
) != NULL
) {
137 NL_SET_ERR_MSG_MOD(extack
, "VLAN device already exists");
144 int register_vlan_dev(struct net_device
*dev
, struct netlink_ext_ack
*extack
)
146 struct vlan_dev_priv
*vlan
= vlan_dev_priv(dev
);
147 struct net_device
*real_dev
= vlan
->real_dev
;
148 u16 vlan_id
= vlan
->vlan_id
;
149 struct vlan_info
*vlan_info
;
150 struct vlan_group
*grp
;
153 err
= vlan_vid_add(real_dev
, vlan
->vlan_proto
, vlan_id
);
157 vlan_info
= rtnl_dereference(real_dev
->vlan_info
);
158 /* vlan_info should be there now. vlan_vid_add took care of it */
161 grp
= &vlan_info
->grp
;
162 if (grp
->nr_vlan_devs
== 0) {
163 err
= vlan_gvrp_init_applicant(real_dev
);
166 err
= vlan_mvrp_init_applicant(real_dev
);
168 goto out_uninit_gvrp
;
171 err
= vlan_group_prealloc_vid(grp
, vlan
->vlan_proto
, vlan_id
);
173 goto out_uninit_mvrp
;
175 err
= register_netdevice(dev
);
177 goto out_uninit_mvrp
;
179 err
= netdev_upper_dev_link(real_dev
, dev
, extack
);
181 goto out_unregister_netdev
;
183 /* Account for reference in struct vlan_dev_priv */
186 vlan_stacked_transfer_operstate(real_dev
, dev
, vlan
);
187 linkwatch_fire_event(dev
); /* _MUST_ call rfc2863_policy() */
189 /* So, got the sucker initialized, now lets place
190 * it into our local structure.
192 vlan_group_set_device(grp
, vlan
->vlan_proto
, vlan_id
, dev
);
197 out_unregister_netdev
:
198 unregister_netdevice(dev
);
200 if (grp
->nr_vlan_devs
== 0)
201 vlan_mvrp_uninit_applicant(real_dev
);
203 if (grp
->nr_vlan_devs
== 0)
204 vlan_gvrp_uninit_applicant(real_dev
);
206 vlan_vid_del(real_dev
, vlan
->vlan_proto
, vlan_id
);
210 /* Attach a VLAN device to a mac address (ie Ethernet Card).
211 * Returns 0 if the device was created or a negative error code otherwise.
213 static int register_vlan_device(struct net_device
*real_dev
, u16 vlan_id
)
215 struct net_device
*new_dev
;
216 struct vlan_dev_priv
*vlan
;
217 struct net
*net
= dev_net(real_dev
);
218 struct vlan_net
*vn
= net_generic(net
, vlan_net_id
);
222 if (vlan_id
>= VLAN_VID_MASK
)
225 err
= vlan_check_real_dev(real_dev
, htons(ETH_P_8021Q
), vlan_id
,
230 /* Gotta set up the fields for the device. */
231 switch (vn
->name_type
) {
232 case VLAN_NAME_TYPE_RAW_PLUS_VID
:
233 /* name will look like: eth1.0005 */
234 snprintf(name
, IFNAMSIZ
, "%s.%.4i", real_dev
->name
, vlan_id
);
236 case VLAN_NAME_TYPE_PLUS_VID_NO_PAD
:
237 /* Put our vlan.VID in the name.
238 * Name will look like: vlan5
240 snprintf(name
, IFNAMSIZ
, "vlan%i", vlan_id
);
242 case VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD
:
243 /* Put our vlan.VID in the name.
244 * Name will look like: eth0.5
246 snprintf(name
, IFNAMSIZ
, "%s.%i", real_dev
->name
, vlan_id
);
248 case VLAN_NAME_TYPE_PLUS_VID
:
249 /* Put our vlan.VID in the name.
250 * Name will look like: vlan0005
253 snprintf(name
, IFNAMSIZ
, "vlan%.4i", vlan_id
);
256 new_dev
= alloc_netdev(sizeof(struct vlan_dev_priv
), name
,
257 NET_NAME_UNKNOWN
, vlan_setup
);
262 dev_net_set(new_dev
, net
);
263 /* need 4 bytes for extra VLAN header info,
264 * hope the underlying device can handle it.
266 new_dev
->mtu
= real_dev
->mtu
;
268 vlan
= vlan_dev_priv(new_dev
);
269 vlan
->vlan_proto
= htons(ETH_P_8021Q
);
270 vlan
->vlan_id
= vlan_id
;
271 vlan
->real_dev
= real_dev
;
273 vlan
->flags
= VLAN_FLAG_REORDER_HDR
;
275 new_dev
->rtnl_link_ops
= &vlan_link_ops
;
276 err
= register_vlan_dev(new_dev
, NULL
);
278 goto out_free_newdev
;
283 if (new_dev
->reg_state
== NETREG_UNINITIALIZED
)
284 free_netdev(new_dev
);
288 static void vlan_sync_address(struct net_device
*dev
,
289 struct net_device
*vlandev
)
291 struct vlan_dev_priv
*vlan
= vlan_dev_priv(vlandev
);
293 /* May be called without an actual change */
294 if (ether_addr_equal(vlan
->real_dev_addr
, dev
->dev_addr
))
297 /* vlan continues to inherit address of lower device */
298 if (vlan_dev_inherit_address(vlandev
, dev
))
301 /* vlan address was different from the old address and is equal to
303 if (!ether_addr_equal(vlandev
->dev_addr
, vlan
->real_dev_addr
) &&
304 ether_addr_equal(vlandev
->dev_addr
, dev
->dev_addr
))
305 dev_uc_del(dev
, vlandev
->dev_addr
);
307 /* vlan address was equal to the old address and is different from
309 if (ether_addr_equal(vlandev
->dev_addr
, vlan
->real_dev_addr
) &&
310 !ether_addr_equal(vlandev
->dev_addr
, dev
->dev_addr
))
311 dev_uc_add(dev
, vlandev
->dev_addr
);
314 ether_addr_copy(vlan
->real_dev_addr
, dev
->dev_addr
);
317 static void vlan_transfer_features(struct net_device
*dev
,
318 struct net_device
*vlandev
)
320 struct vlan_dev_priv
*vlan
= vlan_dev_priv(vlandev
);
322 vlandev
->gso_max_size
= dev
->gso_max_size
;
323 vlandev
->gso_max_segs
= dev
->gso_max_segs
;
325 if (vlan_hw_offload_capable(dev
->features
, vlan
->vlan_proto
))
326 vlandev
->hard_header_len
= dev
->hard_header_len
;
328 vlandev
->hard_header_len
= dev
->hard_header_len
+ VLAN_HLEN
;
330 #if IS_ENABLED(CONFIG_FCOE)
331 vlandev
->fcoe_ddp_xid
= dev
->fcoe_ddp_xid
;
334 vlandev
->priv_flags
&= ~IFF_XMIT_DST_RELEASE
;
335 vlandev
->priv_flags
|= (vlan
->real_dev
->priv_flags
& IFF_XMIT_DST_RELEASE
);
336 vlandev
->hw_enc_features
= vlan_tnl_features(vlan
->real_dev
);
338 netdev_update_features(vlandev
);
341 static int __vlan_device_event(struct net_device
*dev
, unsigned long event
)
346 case NETDEV_CHANGENAME
:
347 vlan_proc_rem_dev(dev
);
348 err
= vlan_proc_add_dev(dev
);
350 case NETDEV_REGISTER
:
351 err
= vlan_proc_add_dev(dev
);
353 case NETDEV_UNREGISTER
:
354 vlan_proc_rem_dev(dev
);
361 static int vlan_device_event(struct notifier_block
*unused
, unsigned long event
,
364 struct netlink_ext_ack
*extack
= netdev_notifier_info_to_extack(ptr
);
365 struct net_device
*dev
= netdev_notifier_info_to_dev(ptr
);
366 struct vlan_group
*grp
;
367 struct vlan_info
*vlan_info
;
369 struct net_device
*vlandev
;
370 struct vlan_dev_priv
*vlan
;
375 if (is_vlan_dev(dev
)) {
376 int err
= __vlan_device_event(dev
, event
);
379 return notifier_from_errno(err
);
382 if ((event
== NETDEV_UP
) &&
383 (dev
->features
& NETIF_F_HW_VLAN_CTAG_FILTER
)) {
384 pr_info("adding VLAN 0 to HW filter on device %s\n",
386 vlan_vid_add(dev
, htons(ETH_P_8021Q
), 0);
388 if (event
== NETDEV_DOWN
&&
389 (dev
->features
& NETIF_F_HW_VLAN_CTAG_FILTER
))
390 vlan_vid_del(dev
, htons(ETH_P_8021Q
), 0);
392 vlan_info
= rtnl_dereference(dev
->vlan_info
);
395 grp
= &vlan_info
->grp
;
397 /* It is OK that we do not hold the group lock right now,
398 * as we run under the RTNL lock.
403 /* Propagate real device state to vlan devices */
404 vlan_group_for_each_dev(grp
, i
, vlandev
)
405 vlan_stacked_transfer_operstate(dev
, vlandev
,
406 vlan_dev_priv(vlandev
));
409 case NETDEV_CHANGEADDR
:
410 /* Adjust unicast filters on underlying device */
411 vlan_group_for_each_dev(grp
, i
, vlandev
) {
412 flgs
= vlandev
->flags
;
413 if (!(flgs
& IFF_UP
))
416 vlan_sync_address(dev
, vlandev
);
420 case NETDEV_CHANGEMTU
:
421 vlan_group_for_each_dev(grp
, i
, vlandev
) {
422 if (vlandev
->mtu
<= dev
->mtu
)
425 dev_set_mtu(vlandev
, dev
->mtu
);
429 case NETDEV_FEAT_CHANGE
:
430 /* Propagate device features to underlying device */
431 vlan_group_for_each_dev(grp
, i
, vlandev
)
432 vlan_transfer_features(dev
, vlandev
);
436 struct net_device
*tmp
;
437 LIST_HEAD(close_list
);
439 /* Put all VLANs for this dev in the down state too. */
440 vlan_group_for_each_dev(grp
, i
, vlandev
) {
441 flgs
= vlandev
->flags
;
442 if (!(flgs
& IFF_UP
))
445 vlan
= vlan_dev_priv(vlandev
);
446 if (!(vlan
->flags
& VLAN_FLAG_LOOSE_BINDING
))
447 list_add(&vlandev
->close_list
, &close_list
);
450 dev_close_many(&close_list
, false);
452 list_for_each_entry_safe(vlandev
, tmp
, &close_list
, close_list
) {
453 vlan_stacked_transfer_operstate(dev
, vlandev
,
454 vlan_dev_priv(vlandev
));
455 list_del_init(&vlandev
->close_list
);
457 list_del(&close_list
);
461 /* Put all VLANs for this dev in the up state too. */
462 vlan_group_for_each_dev(grp
, i
, vlandev
) {
463 flgs
= dev_get_flags(vlandev
);
467 vlan
= vlan_dev_priv(vlandev
);
468 if (!(vlan
->flags
& VLAN_FLAG_LOOSE_BINDING
))
469 dev_change_flags(vlandev
, flgs
| IFF_UP
,
471 vlan_stacked_transfer_operstate(dev
, vlandev
, vlan
);
475 case NETDEV_UNREGISTER
:
476 /* twiddle thumbs on netns device moves */
477 if (dev
->reg_state
!= NETREG_UNREGISTERING
)
480 vlan_group_for_each_dev(grp
, i
, vlandev
) {
481 /* removal of last vid destroys vlan_info, abort
483 if (vlan_info
->nr_vids
== 1)
486 unregister_vlan_dev(vlandev
, &list
);
490 unregister_netdevice_many(&list
);
493 case NETDEV_PRE_TYPE_CHANGE
:
494 /* Forbid underlaying device to change its type. */
495 if (vlan_uses_dev(dev
))
499 case NETDEV_NOTIFY_PEERS
:
500 case NETDEV_BONDING_FAILOVER
:
501 case NETDEV_RESEND_IGMP
:
502 /* Propagate to vlan devices */
503 vlan_group_for_each_dev(grp
, i
, vlandev
)
504 call_netdevice_notifiers(event
, vlandev
);
507 case NETDEV_CVLAN_FILTER_PUSH_INFO
:
508 err
= vlan_filter_push_vids(vlan_info
, htons(ETH_P_8021Q
));
510 return notifier_from_errno(err
);
513 case NETDEV_CVLAN_FILTER_DROP_INFO
:
514 vlan_filter_drop_vids(vlan_info
, htons(ETH_P_8021Q
));
517 case NETDEV_SVLAN_FILTER_PUSH_INFO
:
518 err
= vlan_filter_push_vids(vlan_info
, htons(ETH_P_8021AD
));
520 return notifier_from_errno(err
);
523 case NETDEV_SVLAN_FILTER_DROP_INFO
:
524 vlan_filter_drop_vids(vlan_info
, htons(ETH_P_8021AD
));
532 static struct notifier_block vlan_notifier_block __read_mostly
= {
533 .notifier_call
= vlan_device_event
,
537 * VLAN IOCTL handler.
538 * o execute requested action or pass command to the device driver
539 * arg is really a struct vlan_ioctl_args __user *.
541 static int vlan_ioctl_handler(struct net
*net
, void __user
*arg
)
544 struct vlan_ioctl_args args
;
545 struct net_device
*dev
= NULL
;
547 if (copy_from_user(&args
, arg
, sizeof(struct vlan_ioctl_args
)))
550 /* Null terminate this sucker, just in case. */
551 args
.device1
[sizeof(args
.device1
) - 1] = 0;
552 args
.u
.device2
[sizeof(args
.u
.device2
) - 1] = 0;
557 case SET_VLAN_INGRESS_PRIORITY_CMD
:
558 case SET_VLAN_EGRESS_PRIORITY_CMD
:
559 case SET_VLAN_FLAG_CMD
:
562 case GET_VLAN_REALDEV_NAME_CMD
:
563 case GET_VLAN_VID_CMD
:
565 dev
= __dev_get_by_name(net
, args
.device1
);
570 if (args
.cmd
!= ADD_VLAN_CMD
&& !is_vlan_dev(dev
))
575 case SET_VLAN_INGRESS_PRIORITY_CMD
:
577 if (!ns_capable(net
->user_ns
, CAP_NET_ADMIN
))
579 vlan_dev_set_ingress_priority(dev
,
585 case SET_VLAN_EGRESS_PRIORITY_CMD
:
587 if (!ns_capable(net
->user_ns
, CAP_NET_ADMIN
))
589 err
= vlan_dev_set_egress_priority(dev
,
594 case SET_VLAN_FLAG_CMD
:
596 if (!ns_capable(net
->user_ns
, CAP_NET_ADMIN
))
598 err
= vlan_dev_change_flags(dev
,
599 args
.vlan_qos
? args
.u
.flag
: 0,
603 case SET_VLAN_NAME_TYPE_CMD
:
605 if (!ns_capable(net
->user_ns
, CAP_NET_ADMIN
))
607 if (args
.u
.name_type
< VLAN_NAME_TYPE_HIGHEST
) {
610 vn
= net_generic(net
, vlan_net_id
);
611 vn
->name_type
= args
.u
.name_type
;
620 if (!ns_capable(net
->user_ns
, CAP_NET_ADMIN
))
622 err
= register_vlan_device(dev
, args
.u
.VID
);
627 if (!ns_capable(net
->user_ns
, CAP_NET_ADMIN
))
629 unregister_vlan_dev(dev
, NULL
);
633 case GET_VLAN_REALDEV_NAME_CMD
:
635 vlan_dev_get_realdev_name(dev
, args
.u
.device2
);
636 if (copy_to_user(arg
, &args
,
637 sizeof(struct vlan_ioctl_args
)))
641 case GET_VLAN_VID_CMD
:
643 args
.u
.VID
= vlan_dev_vlan_id(dev
);
644 if (copy_to_user(arg
, &args
,
645 sizeof(struct vlan_ioctl_args
)))
658 static int __net_init
vlan_init_net(struct net
*net
)
660 struct vlan_net
*vn
= net_generic(net
, vlan_net_id
);
663 vn
->name_type
= VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD
;
665 err
= vlan_proc_init(net
);
670 static void __net_exit
vlan_exit_net(struct net
*net
)
672 vlan_proc_cleanup(net
);
675 static struct pernet_operations vlan_net_ops
= {
676 .init
= vlan_init_net
,
677 .exit
= vlan_exit_net
,
679 .size
= sizeof(struct vlan_net
),
682 static int __init
vlan_proto_init(void)
686 pr_info("%s v%s\n", vlan_fullname
, vlan_version
);
688 err
= register_pernet_subsys(&vlan_net_ops
);
692 err
= register_netdevice_notifier(&vlan_notifier_block
);
696 err
= vlan_gvrp_init();
700 err
= vlan_mvrp_init();
704 err
= vlan_netlink_init();
708 vlan_ioctl_set(vlan_ioctl_handler
);
716 unregister_netdevice_notifier(&vlan_notifier_block
);
718 unregister_pernet_subsys(&vlan_net_ops
);
723 static void __exit
vlan_cleanup_module(void)
725 vlan_ioctl_set(NULL
);
729 unregister_netdevice_notifier(&vlan_notifier_block
);
731 unregister_pernet_subsys(&vlan_net_ops
);
732 rcu_barrier(); /* Wait for completion of call_rcu()'s */
738 module_init(vlan_proto_init
);
739 module_exit(vlan_cleanup_module
);
741 MODULE_LICENSE("GPL");
742 MODULE_VERSION(DRV_VERSION
);