net: rename reference+tracking helpers
[linux-2.6-microblaze.git] / net / 8021q / vlan_dev.c
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
30 #include "vlan.h"
31 #include "vlanproc.h"
32 #include <linux/if_vlan.h>
33 #include <linux/netpoll.h>
34
35 /*
36  *      Create the VLAN header for an arbitrary protocol layer
37  *
38  *      saddr=NULL      means use device source address
39  *      daddr=NULL      means leave destination address (eg unresolved arp)
40  *
41  *  This is called when the SKB is moving down the stack towards the
42  *  physical devices.
43  */
44 static int vlan_dev_hard_header(struct sk_buff *skb, struct net_device *dev,
45                                 unsigned short type,
46                                 const void *daddr, const void *saddr,
47                                 unsigned int len)
48 {
49         struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
50         struct vlan_hdr *vhdr;
51         unsigned int vhdrlen = 0;
52         u16 vlan_tci = 0;
53         int rc;
54
55         if (!(vlan->flags & VLAN_FLAG_REORDER_HDR)) {
56                 vhdr = skb_push(skb, VLAN_HLEN);
57
58                 vlan_tci = vlan->vlan_id;
59                 vlan_tci |= vlan_dev_get_egress_qos_mask(dev, skb->priority);
60                 vhdr->h_vlan_TCI = htons(vlan_tci);
61
62                 /*
63                  *  Set the protocol type. For a packet of type ETH_P_802_3/2 we
64                  *  put the length in here instead.
65                  */
66                 if (type != ETH_P_802_3 && type != ETH_P_802_2)
67                         vhdr->h_vlan_encapsulated_proto = htons(type);
68                 else
69                         vhdr->h_vlan_encapsulated_proto = htons(len);
70
71                 skb->protocol = vlan->vlan_proto;
72                 type = ntohs(vlan->vlan_proto);
73                 vhdrlen = VLAN_HLEN;
74         }
75
76         /* Before delegating work to the lower layer, enter our MAC-address */
77         if (saddr == NULL)
78                 saddr = dev->dev_addr;
79
80         /* Now make the underlying real hard header */
81         dev = vlan->real_dev;
82         rc = dev_hard_header(skb, dev, type, daddr, saddr, len + vhdrlen);
83         if (rc > 0)
84                 rc += vhdrlen;
85         return rc;
86 }
87
88 static inline netdev_tx_t vlan_netpoll_send_skb(struct vlan_dev_priv *vlan, struct sk_buff *skb)
89 {
90 #ifdef CONFIG_NET_POLL_CONTROLLER
91         return netpoll_send_skb(vlan->netpoll, skb);
92 #else
93         BUG();
94         return NETDEV_TX_OK;
95 #endif
96 }
97
98 static netdev_tx_t vlan_dev_hard_start_xmit(struct sk_buff *skb,
99                                             struct net_device *dev)
100 {
101         struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
102         struct vlan_ethhdr *veth = (struct vlan_ethhdr *)(skb->data);
103         unsigned int len;
104         int ret;
105
106         /* Handle non-VLAN frames if they are sent to us, for example by DHCP.
107          *
108          * NOTE: THIS ASSUMES DIX ETHERNET, SPECIFICALLY NOT SUPPORTING
109          * OTHER THINGS LIKE FDDI/TokenRing/802.3 SNAPs...
110          */
111         if (veth->h_vlan_proto != vlan->vlan_proto ||
112             vlan->flags & VLAN_FLAG_REORDER_HDR) {
113                 u16 vlan_tci;
114                 vlan_tci = vlan->vlan_id;
115                 vlan_tci |= vlan_dev_get_egress_qos_mask(dev, skb->priority);
116                 __vlan_hwaccel_put_tag(skb, vlan->vlan_proto, vlan_tci);
117         }
118
119         skb->dev = vlan->real_dev;
120         len = skb->len;
121         if (unlikely(netpoll_tx_running(dev)))
122                 return vlan_netpoll_send_skb(vlan, skb);
123
124         ret = dev_queue_xmit(skb);
125
126         if (likely(ret == NET_XMIT_SUCCESS || ret == NET_XMIT_CN)) {
127                 struct vlan_pcpu_stats *stats;
128
129                 stats = this_cpu_ptr(vlan->vlan_pcpu_stats);
130                 u64_stats_update_begin(&stats->syncp);
131                 stats->tx_packets++;
132                 stats->tx_bytes += len;
133                 u64_stats_update_end(&stats->syncp);
134         } else {
135                 this_cpu_inc(vlan->vlan_pcpu_stats->tx_dropped);
136         }
137
138         return ret;
139 }
140
141 static int vlan_dev_change_mtu(struct net_device *dev, int new_mtu)
142 {
143         struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
144         unsigned int max_mtu = real_dev->mtu;
145
146         if (netif_reduces_vlan_mtu(real_dev))
147                 max_mtu -= VLAN_HLEN;
148         if (max_mtu < new_mtu)
149                 return -ERANGE;
150
151         dev->mtu = new_mtu;
152
153         return 0;
154 }
155
156 void vlan_dev_set_ingress_priority(const struct net_device *dev,
157                                    u32 skb_prio, u16 vlan_prio)
158 {
159         struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
160
161         if (vlan->ingress_priority_map[vlan_prio & 0x7] && !skb_prio)
162                 vlan->nr_ingress_mappings--;
163         else if (!vlan->ingress_priority_map[vlan_prio & 0x7] && skb_prio)
164                 vlan->nr_ingress_mappings++;
165
166         vlan->ingress_priority_map[vlan_prio & 0x7] = skb_prio;
167 }
168
169 int vlan_dev_set_egress_priority(const struct net_device *dev,
170                                  u32 skb_prio, u16 vlan_prio)
171 {
172         struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
173         struct vlan_priority_tci_mapping *mp = NULL;
174         struct vlan_priority_tci_mapping *np;
175         u32 vlan_qos = (vlan_prio << VLAN_PRIO_SHIFT) & VLAN_PRIO_MASK;
176
177         /* See if a priority mapping exists.. */
178         mp = vlan->egress_priority_map[skb_prio & 0xF];
179         while (mp) {
180                 if (mp->priority == skb_prio) {
181                         if (mp->vlan_qos && !vlan_qos)
182                                 vlan->nr_egress_mappings--;
183                         else if (!mp->vlan_qos && vlan_qos)
184                                 vlan->nr_egress_mappings++;
185                         mp->vlan_qos = vlan_qos;
186                         return 0;
187                 }
188                 mp = mp->next;
189         }
190
191         /* Create a new mapping then. */
192         mp = vlan->egress_priority_map[skb_prio & 0xF];
193         np = kmalloc(sizeof(struct vlan_priority_tci_mapping), GFP_KERNEL);
194         if (!np)
195                 return -ENOBUFS;
196
197         np->next = mp;
198         np->priority = skb_prio;
199         np->vlan_qos = vlan_qos;
200         /* Before inserting this element in hash table, make sure all its fields
201          * are committed to memory.
202          * coupled with smp_rmb() in vlan_dev_get_egress_qos_mask()
203          */
204         smp_wmb();
205         vlan->egress_priority_map[skb_prio & 0xF] = np;
206         if (vlan_qos)
207                 vlan->nr_egress_mappings++;
208         return 0;
209 }
210
211 /* Flags are defined in the vlan_flags enum in
212  * include/uapi/linux/if_vlan.h file.
213  */
214 int vlan_dev_change_flags(const struct net_device *dev, u32 flags, u32 mask)
215 {
216         struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
217         u32 old_flags = vlan->flags;
218
219         if (mask & ~(VLAN_FLAG_REORDER_HDR | VLAN_FLAG_GVRP |
220                      VLAN_FLAG_LOOSE_BINDING | VLAN_FLAG_MVRP |
221                      VLAN_FLAG_BRIDGE_BINDING))
222                 return -EINVAL;
223
224         vlan->flags = (old_flags & ~mask) | (flags & mask);
225
226         if (netif_running(dev) && (vlan->flags ^ old_flags) & VLAN_FLAG_GVRP) {
227                 if (vlan->flags & VLAN_FLAG_GVRP)
228                         vlan_gvrp_request_join(dev);
229                 else
230                         vlan_gvrp_request_leave(dev);
231         }
232
233         if (netif_running(dev) && (vlan->flags ^ old_flags) & VLAN_FLAG_MVRP) {
234                 if (vlan->flags & VLAN_FLAG_MVRP)
235                         vlan_mvrp_request_join(dev);
236                 else
237                         vlan_mvrp_request_leave(dev);
238         }
239         return 0;
240 }
241
242 void vlan_dev_get_realdev_name(const struct net_device *dev, char *result, size_t size)
243 {
244         strscpy_pad(result, vlan_dev_priv(dev)->real_dev->name, size);
245 }
246
247 bool vlan_dev_inherit_address(struct net_device *dev,
248                               struct net_device *real_dev)
249 {
250         if (dev->addr_assign_type != NET_ADDR_STOLEN)
251                 return false;
252
253         eth_hw_addr_set(dev, real_dev->dev_addr);
254         call_netdevice_notifiers(NETDEV_CHANGEADDR, dev);
255         return true;
256 }
257
258 static int vlan_dev_open(struct net_device *dev)
259 {
260         struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
261         struct net_device *real_dev = vlan->real_dev;
262         int err;
263
264         if (!(real_dev->flags & IFF_UP) &&
265             !(vlan->flags & VLAN_FLAG_LOOSE_BINDING))
266                 return -ENETDOWN;
267
268         if (!ether_addr_equal(dev->dev_addr, real_dev->dev_addr) &&
269             !vlan_dev_inherit_address(dev, real_dev)) {
270                 err = dev_uc_add(real_dev, dev->dev_addr);
271                 if (err < 0)
272                         goto out;
273         }
274
275         if (dev->flags & IFF_ALLMULTI) {
276                 err = dev_set_allmulti(real_dev, 1);
277                 if (err < 0)
278                         goto del_unicast;
279         }
280         if (dev->flags & IFF_PROMISC) {
281                 err = dev_set_promiscuity(real_dev, 1);
282                 if (err < 0)
283                         goto clear_allmulti;
284         }
285
286         ether_addr_copy(vlan->real_dev_addr, real_dev->dev_addr);
287
288         if (vlan->flags & VLAN_FLAG_GVRP)
289                 vlan_gvrp_request_join(dev);
290
291         if (vlan->flags & VLAN_FLAG_MVRP)
292                 vlan_mvrp_request_join(dev);
293
294         if (netif_carrier_ok(real_dev) &&
295             !(vlan->flags & VLAN_FLAG_BRIDGE_BINDING))
296                 netif_carrier_on(dev);
297         return 0;
298
299 clear_allmulti:
300         if (dev->flags & IFF_ALLMULTI)
301                 dev_set_allmulti(real_dev, -1);
302 del_unicast:
303         if (!ether_addr_equal(dev->dev_addr, real_dev->dev_addr))
304                 dev_uc_del(real_dev, dev->dev_addr);
305 out:
306         netif_carrier_off(dev);
307         return err;
308 }
309
310 static int vlan_dev_stop(struct net_device *dev)
311 {
312         struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
313         struct net_device *real_dev = vlan->real_dev;
314
315         dev_mc_unsync(real_dev, dev);
316         dev_uc_unsync(real_dev, dev);
317         if (dev->flags & IFF_ALLMULTI)
318                 dev_set_allmulti(real_dev, -1);
319         if (dev->flags & IFF_PROMISC)
320                 dev_set_promiscuity(real_dev, -1);
321
322         if (!ether_addr_equal(dev->dev_addr, real_dev->dev_addr))
323                 dev_uc_del(real_dev, dev->dev_addr);
324
325         if (!(vlan->flags & VLAN_FLAG_BRIDGE_BINDING))
326                 netif_carrier_off(dev);
327         return 0;
328 }
329
330 static int vlan_dev_set_mac_address(struct net_device *dev, void *p)
331 {
332         struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
333         struct sockaddr *addr = p;
334         int err;
335
336         if (!is_valid_ether_addr(addr->sa_data))
337                 return -EADDRNOTAVAIL;
338
339         if (!(dev->flags & IFF_UP))
340                 goto out;
341
342         if (!ether_addr_equal(addr->sa_data, real_dev->dev_addr)) {
343                 err = dev_uc_add(real_dev, addr->sa_data);
344                 if (err < 0)
345                         return err;
346         }
347
348         if (!ether_addr_equal(dev->dev_addr, real_dev->dev_addr))
349                 dev_uc_del(real_dev, dev->dev_addr);
350
351 out:
352         eth_hw_addr_set(dev, addr->sa_data);
353         return 0;
354 }
355
356 static int vlan_dev_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
357 {
358         struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
359         const struct net_device_ops *ops = real_dev->netdev_ops;
360         struct ifreq ifrr;
361         int err = -EOPNOTSUPP;
362
363         strscpy_pad(ifrr.ifr_name, real_dev->name, IFNAMSIZ);
364         ifrr.ifr_ifru = ifr->ifr_ifru;
365
366         switch (cmd) {
367         case SIOCSHWTSTAMP:
368                 if (!net_eq(dev_net(dev), &init_net))
369                         break;
370                 fallthrough;
371         case SIOCGMIIPHY:
372         case SIOCGMIIREG:
373         case SIOCSMIIREG:
374         case SIOCGHWTSTAMP:
375                 if (netif_device_present(real_dev) && ops->ndo_eth_ioctl)
376                         err = ops->ndo_eth_ioctl(real_dev, &ifrr, cmd);
377                 break;
378         }
379
380         if (!err)
381                 ifr->ifr_ifru = ifrr.ifr_ifru;
382
383         return err;
384 }
385
386 static int vlan_dev_neigh_setup(struct net_device *dev, struct neigh_parms *pa)
387 {
388         struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
389         const struct net_device_ops *ops = real_dev->netdev_ops;
390         int err = 0;
391
392         if (netif_device_present(real_dev) && ops->ndo_neigh_setup)
393                 err = ops->ndo_neigh_setup(real_dev, pa);
394
395         return err;
396 }
397
398 #if IS_ENABLED(CONFIG_FCOE)
399 static int vlan_dev_fcoe_ddp_setup(struct net_device *dev, u16 xid,
400                                    struct scatterlist *sgl, unsigned int sgc)
401 {
402         struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
403         const struct net_device_ops *ops = real_dev->netdev_ops;
404         int rc = 0;
405
406         if (ops->ndo_fcoe_ddp_setup)
407                 rc = ops->ndo_fcoe_ddp_setup(real_dev, xid, sgl, sgc);
408
409         return rc;
410 }
411
412 static int vlan_dev_fcoe_ddp_done(struct net_device *dev, u16 xid)
413 {
414         struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
415         const struct net_device_ops *ops = real_dev->netdev_ops;
416         int len = 0;
417
418         if (ops->ndo_fcoe_ddp_done)
419                 len = ops->ndo_fcoe_ddp_done(real_dev, xid);
420
421         return len;
422 }
423
424 static int vlan_dev_fcoe_enable(struct net_device *dev)
425 {
426         struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
427         const struct net_device_ops *ops = real_dev->netdev_ops;
428         int rc = -EINVAL;
429
430         if (ops->ndo_fcoe_enable)
431                 rc = ops->ndo_fcoe_enable(real_dev);
432         return rc;
433 }
434
435 static int vlan_dev_fcoe_disable(struct net_device *dev)
436 {
437         struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
438         const struct net_device_ops *ops = real_dev->netdev_ops;
439         int rc = -EINVAL;
440
441         if (ops->ndo_fcoe_disable)
442                 rc = ops->ndo_fcoe_disable(real_dev);
443         return rc;
444 }
445
446 static int vlan_dev_fcoe_ddp_target(struct net_device *dev, u16 xid,
447                                     struct scatterlist *sgl, unsigned int sgc)
448 {
449         struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
450         const struct net_device_ops *ops = real_dev->netdev_ops;
451         int rc = 0;
452
453         if (ops->ndo_fcoe_ddp_target)
454                 rc = ops->ndo_fcoe_ddp_target(real_dev, xid, sgl, sgc);
455
456         return rc;
457 }
458 #endif
459
460 #ifdef NETDEV_FCOE_WWNN
461 static int vlan_dev_fcoe_get_wwn(struct net_device *dev, u64 *wwn, int type)
462 {
463         struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
464         const struct net_device_ops *ops = real_dev->netdev_ops;
465         int rc = -EINVAL;
466
467         if (ops->ndo_fcoe_get_wwn)
468                 rc = ops->ndo_fcoe_get_wwn(real_dev, wwn, type);
469         return rc;
470 }
471 #endif
472
473 static void vlan_dev_change_rx_flags(struct net_device *dev, int change)
474 {
475         struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
476
477         if (dev->flags & IFF_UP) {
478                 if (change & IFF_ALLMULTI)
479                         dev_set_allmulti(real_dev, dev->flags & IFF_ALLMULTI ? 1 : -1);
480                 if (change & IFF_PROMISC)
481                         dev_set_promiscuity(real_dev, dev->flags & IFF_PROMISC ? 1 : -1);
482         }
483 }
484
485 static void vlan_dev_set_rx_mode(struct net_device *vlan_dev)
486 {
487         dev_mc_sync(vlan_dev_priv(vlan_dev)->real_dev, vlan_dev);
488         dev_uc_sync(vlan_dev_priv(vlan_dev)->real_dev, vlan_dev);
489 }
490
491 /*
492  * vlan network devices have devices nesting below it, and are a special
493  * "super class" of normal network devices; split their locks off into a
494  * separate class since they always nest.
495  */
496 static struct lock_class_key vlan_netdev_xmit_lock_key;
497 static struct lock_class_key vlan_netdev_addr_lock_key;
498
499 static void vlan_dev_set_lockdep_one(struct net_device *dev,
500                                      struct netdev_queue *txq,
501                                      void *unused)
502 {
503         lockdep_set_class(&txq->_xmit_lock, &vlan_netdev_xmit_lock_key);
504 }
505
506 static void vlan_dev_set_lockdep_class(struct net_device *dev)
507 {
508         lockdep_set_class(&dev->addr_list_lock,
509                           &vlan_netdev_addr_lock_key);
510         netdev_for_each_tx_queue(dev, vlan_dev_set_lockdep_one, NULL);
511 }
512
513 static __be16 vlan_parse_protocol(const struct sk_buff *skb)
514 {
515         struct vlan_ethhdr *veth = (struct vlan_ethhdr *)(skb->data);
516
517         return __vlan_get_protocol(skb, veth->h_vlan_proto, NULL);
518 }
519
520 static const struct header_ops vlan_header_ops = {
521         .create  = vlan_dev_hard_header,
522         .parse   = eth_header_parse,
523         .parse_protocol = vlan_parse_protocol,
524 };
525
526 static int vlan_passthru_hard_header(struct sk_buff *skb, struct net_device *dev,
527                                      unsigned short type,
528                                      const void *daddr, const void *saddr,
529                                      unsigned int len)
530 {
531         struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
532         struct net_device *real_dev = vlan->real_dev;
533
534         if (saddr == NULL)
535                 saddr = dev->dev_addr;
536
537         return dev_hard_header(skb, real_dev, type, daddr, saddr, len);
538 }
539
540 static const struct header_ops vlan_passthru_header_ops = {
541         .create  = vlan_passthru_hard_header,
542         .parse   = eth_header_parse,
543         .parse_protocol = vlan_parse_protocol,
544 };
545
546 static struct device_type vlan_type = {
547         .name   = "vlan",
548 };
549
550 static const struct net_device_ops vlan_netdev_ops;
551
552 static int vlan_dev_init(struct net_device *dev)
553 {
554         struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
555         struct net_device *real_dev = vlan->real_dev;
556
557         netif_carrier_off(dev);
558
559         /* IFF_BROADCAST|IFF_MULTICAST; ??? */
560         dev->flags  = real_dev->flags & ~(IFF_UP | IFF_PROMISC | IFF_ALLMULTI |
561                                           IFF_MASTER | IFF_SLAVE);
562         dev->state  = (real_dev->state & ((1<<__LINK_STATE_NOCARRIER) |
563                                           (1<<__LINK_STATE_DORMANT))) |
564                       (1<<__LINK_STATE_PRESENT);
565
566         if (vlan->flags & VLAN_FLAG_BRIDGE_BINDING)
567                 dev->state |= (1 << __LINK_STATE_NOCARRIER);
568
569         dev->hw_features = NETIF_F_HW_CSUM | NETIF_F_SG |
570                            NETIF_F_FRAGLIST | NETIF_F_GSO_SOFTWARE |
571                            NETIF_F_GSO_ENCAP_ALL |
572                            NETIF_F_HIGHDMA | NETIF_F_SCTP_CRC |
573                            NETIF_F_ALL_FCOE;
574
575         dev->features |= dev->hw_features | NETIF_F_LLTX;
576         netif_inherit_tso_max(dev, real_dev);
577         if (dev->features & NETIF_F_VLAN_FEATURES)
578                 netdev_warn(real_dev, "VLAN features are set incorrectly.  Q-in-Q configurations may not work correctly.\n");
579
580         dev->vlan_features = real_dev->vlan_features & ~NETIF_F_ALL_FCOE;
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         vlan_dev_set_lockdep_class(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         features |= NETIF_F_LLTX;
662
663         return features;
664 }
665
666 static int vlan_ethtool_get_link_ksettings(struct net_device *dev,
667                                            struct ethtool_link_ksettings *cmd)
668 {
669         const struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
670
671         return __ethtool_get_link_ksettings(vlan->real_dev, cmd);
672 }
673
674 static void vlan_ethtool_get_drvinfo(struct net_device *dev,
675                                      struct ethtool_drvinfo *info)
676 {
677         strlcpy(info->driver, vlan_fullname, sizeof(info->driver));
678         strlcpy(info->version, vlan_version, sizeof(info->version));
679         strlcpy(info->fw_version, "N/A", sizeof(info->fw_version));
680 }
681
682 static int vlan_ethtool_get_ts_info(struct net_device *dev,
683                                     struct ethtool_ts_info *info)
684 {
685         const struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
686         const struct ethtool_ops *ops = vlan->real_dev->ethtool_ops;
687         struct phy_device *phydev = vlan->real_dev->phydev;
688
689         if (phy_has_tsinfo(phydev)) {
690                 return phy_ts_info(phydev, info);
691         } else if (ops->get_ts_info) {
692                 return ops->get_ts_info(vlan->real_dev, info);
693         } else {
694                 info->so_timestamping = SOF_TIMESTAMPING_RX_SOFTWARE |
695                         SOF_TIMESTAMPING_SOFTWARE;
696                 info->phc_index = -1;
697         }
698
699         return 0;
700 }
701
702 static void vlan_dev_get_stats64(struct net_device *dev,
703                                  struct rtnl_link_stats64 *stats)
704 {
705         struct vlan_pcpu_stats *p;
706         u32 rx_errors = 0, tx_dropped = 0;
707         int i;
708
709         for_each_possible_cpu(i) {
710                 u64 rxpackets, rxbytes, rxmulticast, txpackets, txbytes;
711                 unsigned int start;
712
713                 p = per_cpu_ptr(vlan_dev_priv(dev)->vlan_pcpu_stats, i);
714                 do {
715                         start = u64_stats_fetch_begin_irq(&p->syncp);
716                         rxpackets       = p->rx_packets;
717                         rxbytes         = p->rx_bytes;
718                         rxmulticast     = p->rx_multicast;
719                         txpackets       = p->tx_packets;
720                         txbytes         = p->tx_bytes;
721                 } while (u64_stats_fetch_retry_irq(&p->syncp, start));
722
723                 stats->rx_packets       += rxpackets;
724                 stats->rx_bytes         += rxbytes;
725                 stats->multicast        += rxmulticast;
726                 stats->tx_packets       += txpackets;
727                 stats->tx_bytes         += txbytes;
728                 /* rx_errors & tx_dropped are u32 */
729                 rx_errors       += p->rx_errors;
730                 tx_dropped      += p->tx_dropped;
731         }
732         stats->rx_errors  = rx_errors;
733         stats->tx_dropped = tx_dropped;
734 }
735
736 #ifdef CONFIG_NET_POLL_CONTROLLER
737 static void vlan_dev_poll_controller(struct net_device *dev)
738 {
739         return;
740 }
741
742 static int vlan_dev_netpoll_setup(struct net_device *dev, struct netpoll_info *npinfo)
743 {
744         struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
745         struct net_device *real_dev = vlan->real_dev;
746         struct netpoll *netpoll;
747         int err = 0;
748
749         netpoll = kzalloc(sizeof(*netpoll), GFP_KERNEL);
750         err = -ENOMEM;
751         if (!netpoll)
752                 goto out;
753
754         err = __netpoll_setup(netpoll, real_dev);
755         if (err) {
756                 kfree(netpoll);
757                 goto out;
758         }
759
760         vlan->netpoll = netpoll;
761
762 out:
763         return err;
764 }
765
766 static void vlan_dev_netpoll_cleanup(struct net_device *dev)
767 {
768         struct vlan_dev_priv *vlan= vlan_dev_priv(dev);
769         struct netpoll *netpoll = vlan->netpoll;
770
771         if (!netpoll)
772                 return;
773
774         vlan->netpoll = NULL;
775         __netpoll_free(netpoll);
776 }
777 #endif /* CONFIG_NET_POLL_CONTROLLER */
778
779 static int vlan_dev_get_iflink(const struct net_device *dev)
780 {
781         struct net_device *real_dev = vlan_dev_priv(dev)->real_dev;
782
783         return real_dev->ifindex;
784 }
785
786 static int vlan_dev_fill_forward_path(struct net_device_path_ctx *ctx,
787                                       struct net_device_path *path)
788 {
789         struct vlan_dev_priv *vlan = vlan_dev_priv(ctx->dev);
790
791         path->type = DEV_PATH_VLAN;
792         path->encap.id = vlan->vlan_id;
793         path->encap.proto = vlan->vlan_proto;
794         path->dev = ctx->dev;
795         ctx->dev = vlan->real_dev;
796         if (ctx->num_vlans >= ARRAY_SIZE(ctx->vlan))
797                 return -ENOSPC;
798
799         ctx->vlan[ctx->num_vlans].id = vlan->vlan_id;
800         ctx->vlan[ctx->num_vlans].proto = vlan->vlan_proto;
801         ctx->num_vlans++;
802
803         return 0;
804 }
805
806 static const struct ethtool_ops vlan_ethtool_ops = {
807         .get_link_ksettings     = vlan_ethtool_get_link_ksettings,
808         .get_drvinfo            = vlan_ethtool_get_drvinfo,
809         .get_link               = ethtool_op_get_link,
810         .get_ts_info            = vlan_ethtool_get_ts_info,
811 };
812
813 static const struct net_device_ops vlan_netdev_ops = {
814         .ndo_change_mtu         = vlan_dev_change_mtu,
815         .ndo_init               = vlan_dev_init,
816         .ndo_uninit             = vlan_dev_uninit,
817         .ndo_open               = vlan_dev_open,
818         .ndo_stop               = vlan_dev_stop,
819         .ndo_start_xmit =  vlan_dev_hard_start_xmit,
820         .ndo_validate_addr      = eth_validate_addr,
821         .ndo_set_mac_address    = vlan_dev_set_mac_address,
822         .ndo_set_rx_mode        = vlan_dev_set_rx_mode,
823         .ndo_change_rx_flags    = vlan_dev_change_rx_flags,
824         .ndo_eth_ioctl          = vlan_dev_ioctl,
825         .ndo_neigh_setup        = vlan_dev_neigh_setup,
826         .ndo_get_stats64        = vlan_dev_get_stats64,
827 #if IS_ENABLED(CONFIG_FCOE)
828         .ndo_fcoe_ddp_setup     = vlan_dev_fcoe_ddp_setup,
829         .ndo_fcoe_ddp_done      = vlan_dev_fcoe_ddp_done,
830         .ndo_fcoe_enable        = vlan_dev_fcoe_enable,
831         .ndo_fcoe_disable       = vlan_dev_fcoe_disable,
832         .ndo_fcoe_ddp_target    = vlan_dev_fcoe_ddp_target,
833 #endif
834 #ifdef NETDEV_FCOE_WWNN
835         .ndo_fcoe_get_wwn       = vlan_dev_fcoe_get_wwn,
836 #endif
837 #ifdef CONFIG_NET_POLL_CONTROLLER
838         .ndo_poll_controller    = vlan_dev_poll_controller,
839         .ndo_netpoll_setup      = vlan_dev_netpoll_setup,
840         .ndo_netpoll_cleanup    = vlan_dev_netpoll_cleanup,
841 #endif
842         .ndo_fix_features       = vlan_dev_fix_features,
843         .ndo_get_iflink         = vlan_dev_get_iflink,
844         .ndo_fill_forward_path  = vlan_dev_fill_forward_path,
845 };
846
847 static void vlan_dev_free(struct net_device *dev)
848 {
849         struct vlan_dev_priv *vlan = vlan_dev_priv(dev);
850
851         free_percpu(vlan->vlan_pcpu_stats);
852         vlan->vlan_pcpu_stats = NULL;
853
854         /* Get rid of the vlan's reference to real_dev */
855         netdev_put(vlan->real_dev, &vlan->dev_tracker);
856 }
857
858 void vlan_setup(struct net_device *dev)
859 {
860         ether_setup(dev);
861
862         dev->priv_flags         |= IFF_802_1Q_VLAN | IFF_NO_QUEUE;
863         dev->priv_flags         |= IFF_UNICAST_FLT;
864         dev->priv_flags         &= ~IFF_TX_SKB_SHARING;
865         netif_keep_dst(dev);
866
867         dev->netdev_ops         = &vlan_netdev_ops;
868         dev->needs_free_netdev  = true;
869         dev->priv_destructor    = vlan_dev_free;
870         dev->ethtool_ops        = &vlan_ethtool_ops;
871
872         dev->min_mtu            = 0;
873         dev->max_mtu            = ETH_MAX_MTU;
874
875         eth_zero_addr(dev->broadcast);
876 }