xref: /linux/net/8021q/vlan_dev.c (revision c532de5a67a70f8533d495f8f2aaa9a0491c3ad0)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* -*- linux-c -*-
3  * INET		802.1Q VLAN
4  *		Ethernet-type device handling.
5  *
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
9  *
10  * Fixes:       Mar 22 2001: Martin Bokaemper <mbokaemper@unispherenetworks.com>
11  *                - reset skb->pkt_type on incoming packets when MAC was changed
12  *                - see that changed MAC is saddr for outgoing packets
13  *              Oct 20, 2001:  Ard van Breeman:
14  *                - Fix MC-list, finally.
15  *                - Flush MC-list on VLAN destroy.
16  */
17 
18 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
19 
20 #include <linux/module.h>
21 #include <linux/slab.h>
22 #include <linux/skbuff.h>
23 #include <linux/netdevice.h>
24 #include <linux/net_tstamp.h>
25 #include <linux/etherdevice.h>
26 #include <linux/ethtool.h>
27 #include <linux/phy.h>
28 #include <net/arp.h>
29 #include <net/macsec.h>
30 
31 #include "vlan.h"
32 #include "vlanproc.h"
33 #include <linux/if_vlan.h>
34 #include <linux/netpoll.h>
35 
36 /*
37  *	Create the VLAN header for an arbitrary protocol layer
38  *
39  *	saddr=NULL	means use device source address
40  *	daddr=NULL	means leave destination address (eg unresolved arp)
41  *
42  *  This is called when the SKB is moving down the stack towards the
43  *  physical devices.
44  */
45 static int vlan_dev_hard_header(struct sk_buff *skb, struct net_device *dev,
46 				unsigned short type,
47 				const void *daddr, const void *saddr,
48 				unsigned int len)
49 {
50 	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
51 	struct vlan_hdr *vhdr;
52 	unsigned int vhdrlen = 0;
53 	u16 vlan_tci = 0;
54 	int rc;
55 
56 	if (!(vlan->flags & VLAN_FLAG_REORDER_HDR)) {
57 		vhdr = skb_push(skb, VLAN_HLEN);
58 
59 		vlan_tci = vlan->vlan_id;
60 		vlan_tci |= vlan_dev_get_egress_qos_mask(dev, skb->priority);
61 		vhdr->h_vlan_TCI = htons(vlan_tci);
62 
63 		/*
64 		 *  Set the protocol type. For a packet of type ETH_P_802_3/2 we
65 		 *  put the length in here instead.
66 		 */
67 		if (type != ETH_P_802_3 && type != ETH_P_802_2)
68 			vhdr->h_vlan_encapsulated_proto = htons(type);
69 		else
70 			vhdr->h_vlan_encapsulated_proto = htons(len);
71 
72 		skb->protocol = vlan->vlan_proto;
73 		type = ntohs(vlan->vlan_proto);
74 		vhdrlen = VLAN_HLEN;
75 	}
76 
77 	/* Before delegating work to the lower layer, enter our MAC-address */
78 	if (saddr == NULL)
79 		saddr = dev->dev_addr;
80 
81 	/* Now make the underlying real hard header */
82 	dev = vlan->real_dev;
83 	rc = dev_hard_header(skb, dev, type, daddr, saddr, len + vhdrlen);
84 	if (rc > 0)
85 		rc += vhdrlen;
86 	return rc;
87 }
88 
89 static inline netdev_tx_t vlan_netpoll_send_skb(struct vlan_dev_priv *vlan, struct sk_buff *skb)
90 {
91 #ifdef CONFIG_NET_POLL_CONTROLLER
92 	return netpoll_send_skb(vlan->netpoll, skb);
93 #else
94 	BUG();
95 	return NETDEV_TX_OK;
96 #endif
97 }
98 
99 static netdev_tx_t vlan_dev_hard_start_xmit(struct sk_buff *skb,
100 					    struct net_device *dev)
101 {
102 	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
103 	struct vlan_ethhdr *veth = (struct vlan_ethhdr *)(skb->data);
104 	unsigned int len;
105 	int ret;
106 
107 	/* Handle non-VLAN frames if they are sent to us, for example by DHCP.
108 	 *
109 	 * NOTE: THIS ASSUMES DIX ETHERNET, SPECIFICALLY NOT SUPPORTING
110 	 * OTHER THINGS LIKE FDDI/TokenRing/802.3 SNAPs...
111 	 */
112 	if (vlan->flags & VLAN_FLAG_REORDER_HDR ||
113 	    veth->h_vlan_proto != vlan->vlan_proto) {
114 		u16 vlan_tci;
115 		vlan_tci = vlan->vlan_id;
116 		vlan_tci |= vlan_dev_get_egress_qos_mask(dev, skb->priority);
117 		__vlan_hwaccel_put_tag(skb, vlan->vlan_proto, vlan_tci);
118 	}
119 
120 	skb->dev = vlan->real_dev;
121 	len = skb->len;
122 	if (unlikely(netpoll_tx_running(dev)))
123 		return vlan_netpoll_send_skb(vlan, skb);
124 
125 	ret = dev_queue_xmit(skb);
126 
127 	if (likely(ret == NET_XMIT_SUCCESS || ret == NET_XMIT_CN)) {
128 		struct vlan_pcpu_stats *stats;
129 
130 		stats = this_cpu_ptr(vlan->vlan_pcpu_stats);
131 		u64_stats_update_begin(&stats->syncp);
132 		u64_stats_inc(&stats->tx_packets);
133 		u64_stats_add(&stats->tx_bytes, len);
134 		u64_stats_update_end(&stats->syncp);
135 	} else {
136 		this_cpu_inc(vlan->vlan_pcpu_stats->tx_dropped);
137 	}
138 
139 	return ret;
140 }
141 
142 static int vlan_dev_change_mtu(struct net_device *dev, int new_mtu)
143 {
144 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
145 	unsigned int max_mtu = real_dev->mtu;
146 
147 	if (netif_reduces_vlan_mtu(real_dev))
148 		max_mtu -= VLAN_HLEN;
149 	if (max_mtu < new_mtu)
150 		return -ERANGE;
151 
152 	WRITE_ONCE(dev->mtu, new_mtu);
153 
154 	return 0;
155 }
156 
157 void vlan_dev_set_ingress_priority(const struct net_device *dev,
158 				   u32 skb_prio, u16 vlan_prio)
159 {
160 	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
161 
162 	if (vlan->ingress_priority_map[vlan_prio & 0x7] && !skb_prio)
163 		vlan->nr_ingress_mappings--;
164 	else if (!vlan->ingress_priority_map[vlan_prio & 0x7] && skb_prio)
165 		vlan->nr_ingress_mappings++;
166 
167 	vlan->ingress_priority_map[vlan_prio & 0x7] = skb_prio;
168 }
169 
170 int vlan_dev_set_egress_priority(const struct net_device *dev,
171 				 u32 skb_prio, u16 vlan_prio)
172 {
173 	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
174 	struct vlan_priority_tci_mapping *mp = NULL;
175 	struct vlan_priority_tci_mapping *np;
176 	u32 vlan_qos = (vlan_prio << VLAN_PRIO_SHIFT) & VLAN_PRIO_MASK;
177 
178 	/* See if a priority mapping exists.. */
179 	mp = vlan->egress_priority_map[skb_prio & 0xF];
180 	while (mp) {
181 		if (mp->priority == skb_prio) {
182 			if (mp->vlan_qos && !vlan_qos)
183 				vlan->nr_egress_mappings--;
184 			else if (!mp->vlan_qos && vlan_qos)
185 				vlan->nr_egress_mappings++;
186 			mp->vlan_qos = vlan_qos;
187 			return 0;
188 		}
189 		mp = mp->next;
190 	}
191 
192 	/* Create a new mapping then. */
193 	mp = vlan->egress_priority_map[skb_prio & 0xF];
194 	np = kmalloc(sizeof(struct vlan_priority_tci_mapping), GFP_KERNEL);
195 	if (!np)
196 		return -ENOBUFS;
197 
198 	np->next = mp;
199 	np->priority = skb_prio;
200 	np->vlan_qos = vlan_qos;
201 	/* Before inserting this element in hash table, make sure all its fields
202 	 * are committed to memory.
203 	 * coupled with smp_rmb() in vlan_dev_get_egress_qos_mask()
204 	 */
205 	smp_wmb();
206 	vlan->egress_priority_map[skb_prio & 0xF] = np;
207 	if (vlan_qos)
208 		vlan->nr_egress_mappings++;
209 	return 0;
210 }
211 
212 /* Flags are defined in the vlan_flags enum in
213  * include/uapi/linux/if_vlan.h file.
214  */
215 int vlan_dev_change_flags(const struct net_device *dev, u32 flags, u32 mask)
216 {
217 	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
218 	u32 old_flags = vlan->flags;
219 
220 	if (mask & ~(VLAN_FLAG_REORDER_HDR | VLAN_FLAG_GVRP |
221 		     VLAN_FLAG_LOOSE_BINDING | VLAN_FLAG_MVRP |
222 		     VLAN_FLAG_BRIDGE_BINDING))
223 		return -EINVAL;
224 
225 	vlan->flags = (old_flags & ~mask) | (flags & mask);
226 
227 	if (netif_running(dev) && (vlan->flags ^ old_flags) & VLAN_FLAG_GVRP) {
228 		if (vlan->flags & VLAN_FLAG_GVRP)
229 			vlan_gvrp_request_join(dev);
230 		else
231 			vlan_gvrp_request_leave(dev);
232 	}
233 
234 	if (netif_running(dev) && (vlan->flags ^ old_flags) & VLAN_FLAG_MVRP) {
235 		if (vlan->flags & VLAN_FLAG_MVRP)
236 			vlan_mvrp_request_join(dev);
237 		else
238 			vlan_mvrp_request_leave(dev);
239 	}
240 	return 0;
241 }
242 
243 void vlan_dev_get_realdev_name(const struct net_device *dev, char *result, size_t size)
244 {
245 	strscpy_pad(result, vlan_dev_priv(dev)->real_dev->name, size);
246 }
247 
248 bool vlan_dev_inherit_address(struct net_device *dev,
249 			      struct net_device *real_dev)
250 {
251 	if (dev->addr_assign_type != NET_ADDR_STOLEN)
252 		return false;
253 
254 	eth_hw_addr_set(dev, real_dev->dev_addr);
255 	call_netdevice_notifiers(NETDEV_CHANGEADDR, dev);
256 	return true;
257 }
258 
259 static int vlan_dev_open(struct net_device *dev)
260 {
261 	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
262 	struct net_device *real_dev = vlan->real_dev;
263 	int err;
264 
265 	if (!(real_dev->flags & IFF_UP) &&
266 	    !(vlan->flags & VLAN_FLAG_LOOSE_BINDING))
267 		return -ENETDOWN;
268 
269 	if (!ether_addr_equal(dev->dev_addr, real_dev->dev_addr) &&
270 	    !vlan_dev_inherit_address(dev, real_dev)) {
271 		err = dev_uc_add(real_dev, dev->dev_addr);
272 		if (err < 0)
273 			goto out;
274 	}
275 
276 	if (dev->flags & IFF_ALLMULTI) {
277 		err = dev_set_allmulti(real_dev, 1);
278 		if (err < 0)
279 			goto del_unicast;
280 	}
281 	if (dev->flags & IFF_PROMISC) {
282 		err = dev_set_promiscuity(real_dev, 1);
283 		if (err < 0)
284 			goto clear_allmulti;
285 	}
286 
287 	ether_addr_copy(vlan->real_dev_addr, real_dev->dev_addr);
288 
289 	if (vlan->flags & VLAN_FLAG_GVRP)
290 		vlan_gvrp_request_join(dev);
291 
292 	if (vlan->flags & VLAN_FLAG_MVRP)
293 		vlan_mvrp_request_join(dev);
294 
295 	if (netif_carrier_ok(real_dev) &&
296 	    !(vlan->flags & VLAN_FLAG_BRIDGE_BINDING))
297 		netif_carrier_on(dev);
298 	return 0;
299 
300 clear_allmulti:
301 	if (dev->flags & IFF_ALLMULTI)
302 		dev_set_allmulti(real_dev, -1);
303 del_unicast:
304 	if (!ether_addr_equal(dev->dev_addr, real_dev->dev_addr))
305 		dev_uc_del(real_dev, dev->dev_addr);
306 out:
307 	netif_carrier_off(dev);
308 	return err;
309 }
310 
311 static int vlan_dev_stop(struct net_device *dev)
312 {
313 	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
314 	struct net_device *real_dev = vlan->real_dev;
315 
316 	dev_mc_unsync(real_dev, dev);
317 	dev_uc_unsync(real_dev, dev);
318 	if (dev->flags & IFF_ALLMULTI)
319 		dev_set_allmulti(real_dev, -1);
320 	if (dev->flags & IFF_PROMISC)
321 		dev_set_promiscuity(real_dev, -1);
322 
323 	if (!ether_addr_equal(dev->dev_addr, real_dev->dev_addr))
324 		dev_uc_del(real_dev, dev->dev_addr);
325 
326 	if (!(vlan->flags & VLAN_FLAG_BRIDGE_BINDING))
327 		netif_carrier_off(dev);
328 	return 0;
329 }
330 
331 static int vlan_dev_set_mac_address(struct net_device *dev, void *p)
332 {
333 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
334 	struct sockaddr *addr = p;
335 	int err;
336 
337 	if (!is_valid_ether_addr(addr->sa_data))
338 		return -EADDRNOTAVAIL;
339 
340 	if (!(dev->flags & IFF_UP))
341 		goto out;
342 
343 	if (!ether_addr_equal(addr->sa_data, real_dev->dev_addr)) {
344 		err = dev_uc_add(real_dev, addr->sa_data);
345 		if (err < 0)
346 			return err;
347 	}
348 
349 	if (!ether_addr_equal(dev->dev_addr, real_dev->dev_addr))
350 		dev_uc_del(real_dev, dev->dev_addr);
351 
352 out:
353 	eth_hw_addr_set(dev, addr->sa_data);
354 	return 0;
355 }
356 
357 static int vlan_hwtstamp_get(struct net_device *dev,
358 			     struct kernel_hwtstamp_config *cfg)
359 {
360 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
361 
362 	return generic_hwtstamp_get_lower(real_dev, cfg);
363 }
364 
365 static int vlan_hwtstamp_set(struct net_device *dev,
366 			     struct kernel_hwtstamp_config *cfg,
367 			     struct netlink_ext_ack *extack)
368 {
369 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
370 
371 	if (!net_eq(dev_net(dev), dev_net(real_dev)))
372 		return -EOPNOTSUPP;
373 
374 	return generic_hwtstamp_set_lower(real_dev, cfg, extack);
375 }
376 
377 static int vlan_dev_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
378 {
379 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
380 	const struct net_device_ops *ops = real_dev->netdev_ops;
381 	struct ifreq ifrr;
382 	int err = -EOPNOTSUPP;
383 
384 	strscpy_pad(ifrr.ifr_name, real_dev->name, IFNAMSIZ);
385 	ifrr.ifr_ifru = ifr->ifr_ifru;
386 
387 	switch (cmd) {
388 	case SIOCGMIIPHY:
389 	case SIOCGMIIREG:
390 	case SIOCSMIIREG:
391 		if (netif_device_present(real_dev) && ops->ndo_eth_ioctl)
392 			err = ops->ndo_eth_ioctl(real_dev, &ifrr, cmd);
393 		break;
394 	}
395 
396 	if (!err)
397 		ifr->ifr_ifru = ifrr.ifr_ifru;
398 
399 	return err;
400 }
401 
402 static int vlan_dev_neigh_setup(struct net_device *dev, struct neigh_parms *pa)
403 {
404 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
405 	const struct net_device_ops *ops = real_dev->netdev_ops;
406 	int err = 0;
407 
408 	if (netif_device_present(real_dev) && ops->ndo_neigh_setup)
409 		err = ops->ndo_neigh_setup(real_dev, pa);
410 
411 	return err;
412 }
413 
414 #if IS_ENABLED(CONFIG_FCOE)
415 static int vlan_dev_fcoe_ddp_setup(struct net_device *dev, u16 xid,
416 				   struct scatterlist *sgl, unsigned int sgc)
417 {
418 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
419 	const struct net_device_ops *ops = real_dev->netdev_ops;
420 	int rc = 0;
421 
422 	if (ops->ndo_fcoe_ddp_setup)
423 		rc = ops->ndo_fcoe_ddp_setup(real_dev, xid, sgl, sgc);
424 
425 	return rc;
426 }
427 
428 static int vlan_dev_fcoe_ddp_done(struct net_device *dev, u16 xid)
429 {
430 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
431 	const struct net_device_ops *ops = real_dev->netdev_ops;
432 	int len = 0;
433 
434 	if (ops->ndo_fcoe_ddp_done)
435 		len = ops->ndo_fcoe_ddp_done(real_dev, xid);
436 
437 	return len;
438 }
439 
440 static int vlan_dev_fcoe_enable(struct net_device *dev)
441 {
442 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
443 	const struct net_device_ops *ops = real_dev->netdev_ops;
444 	int rc = -EINVAL;
445 
446 	if (ops->ndo_fcoe_enable)
447 		rc = ops->ndo_fcoe_enable(real_dev);
448 	return rc;
449 }
450 
451 static int vlan_dev_fcoe_disable(struct net_device *dev)
452 {
453 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
454 	const struct net_device_ops *ops = real_dev->netdev_ops;
455 	int rc = -EINVAL;
456 
457 	if (ops->ndo_fcoe_disable)
458 		rc = ops->ndo_fcoe_disable(real_dev);
459 	return rc;
460 }
461 
462 static int vlan_dev_fcoe_ddp_target(struct net_device *dev, u16 xid,
463 				    struct scatterlist *sgl, unsigned int sgc)
464 {
465 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
466 	const struct net_device_ops *ops = real_dev->netdev_ops;
467 	int rc = 0;
468 
469 	if (ops->ndo_fcoe_ddp_target)
470 		rc = ops->ndo_fcoe_ddp_target(real_dev, xid, sgl, sgc);
471 
472 	return rc;
473 }
474 #endif
475 
476 #ifdef NETDEV_FCOE_WWNN
477 static int vlan_dev_fcoe_get_wwn(struct net_device *dev, u64 *wwn, int type)
478 {
479 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
480 	const struct net_device_ops *ops = real_dev->netdev_ops;
481 	int rc = -EINVAL;
482 
483 	if (ops->ndo_fcoe_get_wwn)
484 		rc = ops->ndo_fcoe_get_wwn(real_dev, wwn, type);
485 	return rc;
486 }
487 #endif
488 
489 static void vlan_dev_change_rx_flags(struct net_device *dev, int change)
490 {
491 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
492 
493 	if (dev->flags & IFF_UP) {
494 		if (change & IFF_ALLMULTI)
495 			dev_set_allmulti(real_dev, dev->flags & IFF_ALLMULTI ? 1 : -1);
496 		if (change & IFF_PROMISC)
497 			dev_set_promiscuity(real_dev, dev->flags & IFF_PROMISC ? 1 : -1);
498 	}
499 }
500 
501 static void vlan_dev_set_rx_mode(struct net_device *vlan_dev)
502 {
503 	dev_mc_sync(vlan_dev_priv(vlan_dev)->real_dev, vlan_dev);
504 	dev_uc_sync(vlan_dev_priv(vlan_dev)->real_dev, vlan_dev);
505 }
506 
507 static __be16 vlan_parse_protocol(const struct sk_buff *skb)
508 {
509 	struct vlan_ethhdr *veth = (struct vlan_ethhdr *)(skb->data);
510 
511 	return __vlan_get_protocol(skb, veth->h_vlan_proto, NULL);
512 }
513 
514 static const struct header_ops vlan_header_ops = {
515 	.create	 = vlan_dev_hard_header,
516 	.parse	 = eth_header_parse,
517 	.parse_protocol = vlan_parse_protocol,
518 };
519 
520 static int vlan_passthru_hard_header(struct sk_buff *skb, struct net_device *dev,
521 				     unsigned short type,
522 				     const void *daddr, const void *saddr,
523 				     unsigned int len)
524 {
525 	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
526 	struct net_device *real_dev = vlan->real_dev;
527 
528 	if (saddr == NULL)
529 		saddr = dev->dev_addr;
530 
531 	return dev_hard_header(skb, real_dev, type, daddr, saddr, len);
532 }
533 
534 static const struct header_ops vlan_passthru_header_ops = {
535 	.create	 = vlan_passthru_hard_header,
536 	.parse	 = eth_header_parse,
537 	.parse_protocol = vlan_parse_protocol,
538 };
539 
540 static const struct device_type vlan_type = {
541 	.name	= "vlan",
542 };
543 
544 static const struct net_device_ops vlan_netdev_ops;
545 
546 static int vlan_dev_init(struct net_device *dev)
547 {
548 	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
549 	struct net_device *real_dev = vlan->real_dev;
550 
551 	netif_carrier_off(dev);
552 
553 	/* IFF_BROADCAST|IFF_MULTICAST; ??? */
554 	dev->flags  = real_dev->flags & ~(IFF_UP | IFF_PROMISC | IFF_ALLMULTI |
555 					  IFF_MASTER | IFF_SLAVE);
556 	dev->state  = (real_dev->state & ((1<<__LINK_STATE_NOCARRIER) |
557 					  (1<<__LINK_STATE_DORMANT))) |
558 		      (1<<__LINK_STATE_PRESENT);
559 
560 	if (vlan->flags & VLAN_FLAG_BRIDGE_BINDING)
561 		dev->state |= (1 << __LINK_STATE_NOCARRIER);
562 
563 	dev->hw_features = NETIF_F_HW_CSUM | NETIF_F_SG |
564 			   NETIF_F_FRAGLIST | NETIF_F_GSO_SOFTWARE |
565 			   NETIF_F_GSO_ENCAP_ALL |
566 			   NETIF_F_HIGHDMA | NETIF_F_SCTP_CRC |
567 			   NETIF_F_FCOE_CRC | NETIF_F_FSO;
568 
569 	if (real_dev->vlan_features & NETIF_F_HW_MACSEC)
570 		dev->hw_features |= NETIF_F_HW_MACSEC;
571 
572 	dev->features |= dev->hw_features;
573 	dev->lltx = true;
574 	dev->fcoe_mtu = true;
575 	netif_inherit_tso_max(dev, real_dev);
576 	if (dev->features & NETIF_F_VLAN_FEATURES)
577 		netdev_warn(real_dev, "VLAN features are set incorrectly.  Q-in-Q configurations may not work correctly.\n");
578 
579 	dev->vlan_features = real_dev->vlan_features &
580 			     ~(NETIF_F_FCOE_CRC | NETIF_F_FSO);
581 	dev->hw_enc_features = vlan_tnl_features(real_dev);
582 	dev->mpls_features = real_dev->mpls_features;
583 
584 	/* ipv6 shared card related stuff */
585 	dev->dev_id = real_dev->dev_id;
586 
587 	if (is_zero_ether_addr(dev->dev_addr)) {
588 		eth_hw_addr_set(dev, real_dev->dev_addr);
589 		dev->addr_assign_type = NET_ADDR_STOLEN;
590 	}
591 	if (is_zero_ether_addr(dev->broadcast))
592 		memcpy(dev->broadcast, real_dev->broadcast, dev->addr_len);
593 
594 #if IS_ENABLED(CONFIG_FCOE)
595 	dev->fcoe_ddp_xid = real_dev->fcoe_ddp_xid;
596 #endif
597 
598 	dev->needed_headroom = real_dev->needed_headroom;
599 	if (vlan_hw_offload_capable(real_dev->features, vlan->vlan_proto)) {
600 		dev->header_ops      = &vlan_passthru_header_ops;
601 		dev->hard_header_len = real_dev->hard_header_len;
602 	} else {
603 		dev->header_ops      = &vlan_header_ops;
604 		dev->hard_header_len = real_dev->hard_header_len + VLAN_HLEN;
605 	}
606 
607 	dev->netdev_ops = &vlan_netdev_ops;
608 
609 	SET_NETDEV_DEVTYPE(dev, &vlan_type);
610 
611 	netdev_lockdep_set_classes(dev);
612 
613 	vlan->vlan_pcpu_stats = netdev_alloc_pcpu_stats(struct vlan_pcpu_stats);
614 	if (!vlan->vlan_pcpu_stats)
615 		return -ENOMEM;
616 
617 	/* Get vlan's reference to real_dev */
618 	netdev_hold(real_dev, &vlan->dev_tracker, GFP_KERNEL);
619 
620 	return 0;
621 }
622 
623 /* Note: this function might be called multiple times for the same device. */
624 void vlan_dev_free_egress_priority(const struct net_device *dev)
625 {
626 	struct vlan_priority_tci_mapping *pm;
627 	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
628 	int i;
629 
630 	for (i = 0; i < ARRAY_SIZE(vlan->egress_priority_map); i++) {
631 		while ((pm = vlan->egress_priority_map[i]) != NULL) {
632 			vlan->egress_priority_map[i] = pm->next;
633 			kfree(pm);
634 		}
635 	}
636 }
637 
638 static void vlan_dev_uninit(struct net_device *dev)
639 {
640 	vlan_dev_free_egress_priority(dev);
641 }
642 
643 static netdev_features_t vlan_dev_fix_features(struct net_device *dev,
644 	netdev_features_t features)
645 {
646 	struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
647 	netdev_features_t old_features = features;
648 	netdev_features_t lower_features;
649 
650 	lower_features = netdev_intersect_features((real_dev->vlan_features |
651 						    NETIF_F_RXCSUM),
652 						   real_dev->features);
653 
654 	/* Add HW_CSUM setting to preserve user ability to control
655 	 * checksum offload on the vlan device.
656 	 */
657 	if (lower_features & (NETIF_F_IP_CSUM|NETIF_F_IPV6_CSUM))
658 		lower_features |= NETIF_F_HW_CSUM;
659 	features = netdev_intersect_features(features, lower_features);
660 	features |= old_features & (NETIF_F_SOFT_FEATURES | NETIF_F_GSO_SOFTWARE);
661 
662 	return features;
663 }
664 
665 static int vlan_ethtool_get_link_ksettings(struct net_device *dev,
666 					   struct ethtool_link_ksettings *cmd)
667 {
668 	const struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
669 
670 	return __ethtool_get_link_ksettings(vlan->real_dev, cmd);
671 }
672 
673 static void vlan_ethtool_get_drvinfo(struct net_device *dev,
674 				     struct ethtool_drvinfo *info)
675 {
676 	strscpy(info->driver, vlan_fullname, sizeof(info->driver));
677 	strscpy(info->version, vlan_version, sizeof(info->version));
678 	strscpy(info->fw_version, "N/A", sizeof(info->fw_version));
679 }
680 
681 static int vlan_ethtool_get_ts_info(struct net_device *dev,
682 				    struct kernel_ethtool_ts_info *info)
683 {
684 	const struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
685 	return ethtool_get_ts_info_by_layer(vlan->real_dev, info);
686 }
687 
688 static void vlan_dev_get_stats64(struct net_device *dev,
689 				 struct rtnl_link_stats64 *stats)
690 {
691 	struct vlan_pcpu_stats *p;
692 	u32 rx_errors = 0, tx_dropped = 0;
693 	int i;
694 
695 	for_each_possible_cpu(i) {
696 		u64 rxpackets, rxbytes, rxmulticast, txpackets, txbytes;
697 		unsigned int start;
698 
699 		p = per_cpu_ptr(vlan_dev_priv(dev)->vlan_pcpu_stats, i);
700 		do {
701 			start = u64_stats_fetch_begin(&p->syncp);
702 			rxpackets	= u64_stats_read(&p->rx_packets);
703 			rxbytes		= u64_stats_read(&p->rx_bytes);
704 			rxmulticast	= u64_stats_read(&p->rx_multicast);
705 			txpackets	= u64_stats_read(&p->tx_packets);
706 			txbytes		= u64_stats_read(&p->tx_bytes);
707 		} while (u64_stats_fetch_retry(&p->syncp, start));
708 
709 		stats->rx_packets	+= rxpackets;
710 		stats->rx_bytes		+= rxbytes;
711 		stats->multicast	+= rxmulticast;
712 		stats->tx_packets	+= txpackets;
713 		stats->tx_bytes		+= txbytes;
714 		/* rx_errors & tx_dropped are u32 */
715 		rx_errors	+= READ_ONCE(p->rx_errors);
716 		tx_dropped	+= READ_ONCE(p->tx_dropped);
717 	}
718 	stats->rx_errors  = rx_errors;
719 	stats->tx_dropped = tx_dropped;
720 }
721 
722 #ifdef CONFIG_NET_POLL_CONTROLLER
723 static void vlan_dev_poll_controller(struct net_device *dev)
724 {
725 	return;
726 }
727 
728 static int vlan_dev_netpoll_setup(struct net_device *dev, struct netpoll_info *npinfo)
729 {
730 	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
731 	struct net_device *real_dev = vlan->real_dev;
732 	struct netpoll *netpoll;
733 	int err = 0;
734 
735 	netpoll = kzalloc(sizeof(*netpoll), GFP_KERNEL);
736 	err = -ENOMEM;
737 	if (!netpoll)
738 		goto out;
739 
740 	err = __netpoll_setup(netpoll, real_dev);
741 	if (err) {
742 		kfree(netpoll);
743 		goto out;
744 	}
745 
746 	vlan->netpoll = netpoll;
747 
748 out:
749 	return err;
750 }
751 
752 static void vlan_dev_netpoll_cleanup(struct net_device *dev)
753 {
754 	struct vlan_dev_priv *vlan= vlan_dev_priv(dev);
755 	struct netpoll *netpoll = vlan->netpoll;
756 
757 	if (!netpoll)
758 		return;
759 
760 	vlan->netpoll = NULL;
761 	__netpoll_free(netpoll);
762 }
763 #endif /* CONFIG_NET_POLL_CONTROLLER */
764 
765 static int vlan_dev_get_iflink(const struct net_device *dev)
766 {
767 	const struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
768 
769 	return READ_ONCE(real_dev->ifindex);
770 }
771 
772 static int vlan_dev_fill_forward_path(struct net_device_path_ctx *ctx,
773 				      struct net_device_path *path)
774 {
775 	struct vlan_dev_priv *vlan = vlan_dev_priv(ctx->dev);
776 
777 	path->type = DEV_PATH_VLAN;
778 	path->encap.id = vlan->vlan_id;
779 	path->encap.proto = vlan->vlan_proto;
780 	path->dev = ctx->dev;
781 	ctx->dev = vlan->real_dev;
782 	if (ctx->num_vlans >= ARRAY_SIZE(ctx->vlan))
783 		return -ENOSPC;
784 
785 	ctx->vlan[ctx->num_vlans].id = vlan->vlan_id;
786 	ctx->vlan[ctx->num_vlans].proto = vlan->vlan_proto;
787 	ctx->num_vlans++;
788 
789 	return 0;
790 }
791 
792 #if IS_ENABLED(CONFIG_MACSEC)
793 
794 static const struct macsec_ops *vlan_get_macsec_ops(const struct macsec_context *ctx)
795 {
796 	return vlan_dev_priv(ctx->netdev)->real_dev->macsec_ops;
797 }
798 
799 static int vlan_macsec_offload(int (* const func)(struct macsec_context *),
800 			       struct macsec_context *ctx)
801 {
802 	if (unlikely(!func))
803 		return 0;
804 
805 	return (*func)(ctx);
806 }
807 
808 static int vlan_macsec_dev_open(struct macsec_context *ctx)
809 {
810 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
811 
812 	if (!ops)
813 		return -EOPNOTSUPP;
814 
815 	return vlan_macsec_offload(ops->mdo_dev_open, ctx);
816 }
817 
818 static int vlan_macsec_dev_stop(struct macsec_context *ctx)
819 {
820 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
821 
822 	if (!ops)
823 		return -EOPNOTSUPP;
824 
825 	return vlan_macsec_offload(ops->mdo_dev_stop, ctx);
826 }
827 
828 static int vlan_macsec_add_secy(struct macsec_context *ctx)
829 {
830 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
831 
832 	if (!ops)
833 		return -EOPNOTSUPP;
834 
835 	return vlan_macsec_offload(ops->mdo_add_secy, ctx);
836 }
837 
838 static int vlan_macsec_upd_secy(struct macsec_context *ctx)
839 {
840 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
841 
842 	if (!ops)
843 		return -EOPNOTSUPP;
844 
845 	return vlan_macsec_offload(ops->mdo_upd_secy, ctx);
846 }
847 
848 static int vlan_macsec_del_secy(struct macsec_context *ctx)
849 {
850 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
851 
852 	if (!ops)
853 		return -EOPNOTSUPP;
854 
855 	return vlan_macsec_offload(ops->mdo_del_secy, ctx);
856 }
857 
858 static int vlan_macsec_add_rxsc(struct macsec_context *ctx)
859 {
860 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
861 
862 	if (!ops)
863 		return -EOPNOTSUPP;
864 
865 	return vlan_macsec_offload(ops->mdo_add_rxsc, ctx);
866 }
867 
868 static int vlan_macsec_upd_rxsc(struct macsec_context *ctx)
869 {
870 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
871 
872 	if (!ops)
873 		return -EOPNOTSUPP;
874 
875 	return vlan_macsec_offload(ops->mdo_upd_rxsc, ctx);
876 }
877 
878 static int vlan_macsec_del_rxsc(struct macsec_context *ctx)
879 {
880 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
881 
882 	if (!ops)
883 		return -EOPNOTSUPP;
884 
885 	return vlan_macsec_offload(ops->mdo_del_rxsc, ctx);
886 }
887 
888 static int vlan_macsec_add_rxsa(struct macsec_context *ctx)
889 {
890 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
891 
892 	if (!ops)
893 		return -EOPNOTSUPP;
894 
895 	return vlan_macsec_offload(ops->mdo_add_rxsa, ctx);
896 }
897 
898 static int vlan_macsec_upd_rxsa(struct macsec_context *ctx)
899 {
900 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
901 
902 	if (!ops)
903 		return -EOPNOTSUPP;
904 
905 	return vlan_macsec_offload(ops->mdo_upd_rxsa, ctx);
906 }
907 
908 static int vlan_macsec_del_rxsa(struct macsec_context *ctx)
909 {
910 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
911 
912 	if (!ops)
913 		return -EOPNOTSUPP;
914 
915 	return vlan_macsec_offload(ops->mdo_del_rxsa, ctx);
916 }
917 
918 static int vlan_macsec_add_txsa(struct macsec_context *ctx)
919 {
920 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
921 
922 	if (!ops)
923 		return -EOPNOTSUPP;
924 
925 	return vlan_macsec_offload(ops->mdo_add_txsa, ctx);
926 }
927 
928 static int vlan_macsec_upd_txsa(struct macsec_context *ctx)
929 {
930 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
931 
932 	if (!ops)
933 		return -EOPNOTSUPP;
934 
935 	return vlan_macsec_offload(ops->mdo_upd_txsa, ctx);
936 }
937 
938 static int vlan_macsec_del_txsa(struct macsec_context *ctx)
939 {
940 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
941 
942 	if (!ops)
943 		return -EOPNOTSUPP;
944 
945 	return vlan_macsec_offload(ops->mdo_del_txsa, ctx);
946 }
947 
948 static int vlan_macsec_get_dev_stats(struct macsec_context *ctx)
949 {
950 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
951 
952 	if (!ops)
953 		return -EOPNOTSUPP;
954 
955 	return vlan_macsec_offload(ops->mdo_get_dev_stats, ctx);
956 }
957 
958 static int vlan_macsec_get_tx_sc_stats(struct macsec_context *ctx)
959 {
960 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
961 
962 	if (!ops)
963 		return -EOPNOTSUPP;
964 
965 	return vlan_macsec_offload(ops->mdo_get_tx_sc_stats, ctx);
966 }
967 
968 static int vlan_macsec_get_tx_sa_stats(struct macsec_context *ctx)
969 {
970 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
971 
972 	if (!ops)
973 		return -EOPNOTSUPP;
974 
975 	return vlan_macsec_offload(ops->mdo_get_tx_sa_stats, ctx);
976 }
977 
978 static int vlan_macsec_get_rx_sc_stats(struct macsec_context *ctx)
979 {
980 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
981 
982 	if (!ops)
983 		return -EOPNOTSUPP;
984 
985 	return vlan_macsec_offload(ops->mdo_get_rx_sc_stats, ctx);
986 }
987 
988 static int vlan_macsec_get_rx_sa_stats(struct macsec_context *ctx)
989 {
990 	const struct macsec_ops *ops = vlan_get_macsec_ops(ctx);
991 
992 	if (!ops)
993 		return -EOPNOTSUPP;
994 
995 	return vlan_macsec_offload(ops->mdo_get_rx_sa_stats, ctx);
996 }
997 
998 static const struct macsec_ops macsec_offload_ops = {
999 	/* Device wide */
1000 	.mdo_dev_open = vlan_macsec_dev_open,
1001 	.mdo_dev_stop = vlan_macsec_dev_stop,
1002 	/* SecY */
1003 	.mdo_add_secy = vlan_macsec_add_secy,
1004 	.mdo_upd_secy = vlan_macsec_upd_secy,
1005 	.mdo_del_secy = vlan_macsec_del_secy,
1006 	/* Security channels */
1007 	.mdo_add_rxsc = vlan_macsec_add_rxsc,
1008 	.mdo_upd_rxsc = vlan_macsec_upd_rxsc,
1009 	.mdo_del_rxsc = vlan_macsec_del_rxsc,
1010 	/* Security associations */
1011 	.mdo_add_rxsa = vlan_macsec_add_rxsa,
1012 	.mdo_upd_rxsa = vlan_macsec_upd_rxsa,
1013 	.mdo_del_rxsa = vlan_macsec_del_rxsa,
1014 	.mdo_add_txsa = vlan_macsec_add_txsa,
1015 	.mdo_upd_txsa = vlan_macsec_upd_txsa,
1016 	.mdo_del_txsa = vlan_macsec_del_txsa,
1017 	/* Statistics */
1018 	.mdo_get_dev_stats = vlan_macsec_get_dev_stats,
1019 	.mdo_get_tx_sc_stats = vlan_macsec_get_tx_sc_stats,
1020 	.mdo_get_tx_sa_stats = vlan_macsec_get_tx_sa_stats,
1021 	.mdo_get_rx_sc_stats = vlan_macsec_get_rx_sc_stats,
1022 	.mdo_get_rx_sa_stats = vlan_macsec_get_rx_sa_stats,
1023 };
1024 
1025 #endif
1026 
1027 static const struct ethtool_ops vlan_ethtool_ops = {
1028 	.get_link_ksettings	= vlan_ethtool_get_link_ksettings,
1029 	.get_drvinfo	        = vlan_ethtool_get_drvinfo,
1030 	.get_link		= ethtool_op_get_link,
1031 	.get_ts_info		= vlan_ethtool_get_ts_info,
1032 };
1033 
1034 static const struct net_device_ops vlan_netdev_ops = {
1035 	.ndo_change_mtu		= vlan_dev_change_mtu,
1036 	.ndo_init		= vlan_dev_init,
1037 	.ndo_uninit		= vlan_dev_uninit,
1038 	.ndo_open		= vlan_dev_open,
1039 	.ndo_stop		= vlan_dev_stop,
1040 	.ndo_start_xmit =  vlan_dev_hard_start_xmit,
1041 	.ndo_validate_addr	= eth_validate_addr,
1042 	.ndo_set_mac_address	= vlan_dev_set_mac_address,
1043 	.ndo_set_rx_mode	= vlan_dev_set_rx_mode,
1044 	.ndo_change_rx_flags	= vlan_dev_change_rx_flags,
1045 	.ndo_eth_ioctl		= vlan_dev_ioctl,
1046 	.ndo_neigh_setup	= vlan_dev_neigh_setup,
1047 	.ndo_get_stats64	= vlan_dev_get_stats64,
1048 #if IS_ENABLED(CONFIG_FCOE)
1049 	.ndo_fcoe_ddp_setup	= vlan_dev_fcoe_ddp_setup,
1050 	.ndo_fcoe_ddp_done	= vlan_dev_fcoe_ddp_done,
1051 	.ndo_fcoe_enable	= vlan_dev_fcoe_enable,
1052 	.ndo_fcoe_disable	= vlan_dev_fcoe_disable,
1053 	.ndo_fcoe_ddp_target	= vlan_dev_fcoe_ddp_target,
1054 #endif
1055 #ifdef NETDEV_FCOE_WWNN
1056 	.ndo_fcoe_get_wwn	= vlan_dev_fcoe_get_wwn,
1057 #endif
1058 #ifdef CONFIG_NET_POLL_CONTROLLER
1059 	.ndo_poll_controller	= vlan_dev_poll_controller,
1060 	.ndo_netpoll_setup	= vlan_dev_netpoll_setup,
1061 	.ndo_netpoll_cleanup	= vlan_dev_netpoll_cleanup,
1062 #endif
1063 	.ndo_fix_features	= vlan_dev_fix_features,
1064 	.ndo_get_iflink		= vlan_dev_get_iflink,
1065 	.ndo_fill_forward_path	= vlan_dev_fill_forward_path,
1066 	.ndo_hwtstamp_get	= vlan_hwtstamp_get,
1067 	.ndo_hwtstamp_set	= vlan_hwtstamp_set,
1068 };
1069 
1070 static void vlan_dev_free(struct net_device *dev)
1071 {
1072 	struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
1073 
1074 	free_percpu(vlan->vlan_pcpu_stats);
1075 	vlan->vlan_pcpu_stats = NULL;
1076 
1077 	/* Get rid of the vlan's reference to real_dev */
1078 	netdev_put(vlan->real_dev, &vlan->dev_tracker);
1079 }
1080 
1081 void vlan_setup(struct net_device *dev)
1082 {
1083 	ether_setup(dev);
1084 
1085 	dev->priv_flags		|= IFF_802_1Q_VLAN | IFF_NO_QUEUE;
1086 	dev->priv_flags		|= IFF_UNICAST_FLT;
1087 	dev->priv_flags		&= ~IFF_TX_SKB_SHARING;
1088 	netif_keep_dst(dev);
1089 
1090 	dev->netdev_ops		= &vlan_netdev_ops;
1091 	dev->needs_free_netdev	= true;
1092 	dev->priv_destructor	= vlan_dev_free;
1093 	dev->ethtool_ops	= &vlan_ethtool_ops;
1094 
1095 #if IS_ENABLED(CONFIG_MACSEC)
1096 	dev->macsec_ops		= &macsec_offload_ops;
1097 #endif
1098 	dev->min_mtu		= 0;
1099 	dev->max_mtu		= ETH_MAX_MTU;
1100 
1101 	eth_zero_addr(dev->broadcast);
1102 }
1103