drm/amdgpu/vg20:Restruct uvd to support multiple uvds
[muen/linux.git] / net / batman-adv / soft-interface.c
1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright (C) 2007-2018  B.A.T.M.A.N. contributors:
3  *
4  * Marek Lindner, Simon Wunderlich
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of version 2 of the GNU General Public
8  * License as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, see <http://www.gnu.org/licenses/>.
17  */
18
19 #include "soft-interface.h"
20 #include "main.h"
21
22 #include <linux/atomic.h>
23 #include <linux/byteorder/generic.h>
24 #include <linux/cache.h>
25 #include <linux/compiler.h>
26 #include <linux/cpumask.h>
27 #include <linux/errno.h>
28 #include <linux/etherdevice.h>
29 #include <linux/ethtool.h>
30 #include <linux/gfp.h>
31 #include <linux/if_ether.h>
32 #include <linux/if_vlan.h>
33 #include <linux/jiffies.h>
34 #include <linux/kernel.h>
35 #include <linux/kref.h>
36 #include <linux/list.h>
37 #include <linux/lockdep.h>
38 #include <linux/netdevice.h>
39 #include <linux/percpu.h>
40 #include <linux/printk.h>
41 #include <linux/random.h>
42 #include <linux/rculist.h>
43 #include <linux/rcupdate.h>
44 #include <linux/rtnetlink.h>
45 #include <linux/skbuff.h>
46 #include <linux/slab.h>
47 #include <linux/socket.h>
48 #include <linux/spinlock.h>
49 #include <linux/stddef.h>
50 #include <linux/string.h>
51 #include <linux/types.h>
52 #include <uapi/linux/batadv_packet.h>
53
54 #include "bat_algo.h"
55 #include "bridge_loop_avoidance.h"
56 #include "debugfs.h"
57 #include "distributed-arp-table.h"
58 #include "gateway_client.h"
59 #include "gateway_common.h"
60 #include "hard-interface.h"
61 #include "multicast.h"
62 #include "network-coding.h"
63 #include "originator.h"
64 #include "send.h"
65 #include "sysfs.h"
66 #include "translation-table.h"
67
68 /**
69  * batadv_skb_head_push() - Increase header size and move (push) head pointer
70  * @skb: packet buffer which should be modified
71  * @len: number of bytes to add
72  *
73  * Return: 0 on success or negative error number in case of failure
74  */
75 int batadv_skb_head_push(struct sk_buff *skb, unsigned int len)
76 {
77         int result;
78
79         /* TODO: We must check if we can release all references to non-payload
80          * data using __skb_header_release in our skbs to allow skb_cow_header
81          * to work optimally. This means that those skbs are not allowed to read
82          * or write any data which is before the current position of skb->data
83          * after that call and thus allow other skbs with the same data buffer
84          * to write freely in that area.
85          */
86         result = skb_cow_head(skb, len);
87         if (result < 0)
88                 return result;
89
90         skb_push(skb, len);
91         return 0;
92 }
93
94 static int batadv_interface_open(struct net_device *dev)
95 {
96         netif_start_queue(dev);
97         return 0;
98 }
99
100 static int batadv_interface_release(struct net_device *dev)
101 {
102         netif_stop_queue(dev);
103         return 0;
104 }
105
106 /**
107  * batadv_sum_counter() - Sum the cpu-local counters for index 'idx'
108  * @bat_priv: the bat priv with all the soft interface information
109  * @idx: index of counter to sum up
110  *
111  * Return: sum of all cpu-local counters
112  */
113 static u64 batadv_sum_counter(struct batadv_priv *bat_priv,  size_t idx)
114 {
115         u64 *counters, sum = 0;
116         int cpu;
117
118         for_each_possible_cpu(cpu) {
119                 counters = per_cpu_ptr(bat_priv->bat_counters, cpu);
120                 sum += counters[idx];
121         }
122
123         return sum;
124 }
125
126 static struct net_device_stats *batadv_interface_stats(struct net_device *dev)
127 {
128         struct batadv_priv *bat_priv = netdev_priv(dev);
129         struct net_device_stats *stats = &dev->stats;
130
131         stats->tx_packets = batadv_sum_counter(bat_priv, BATADV_CNT_TX);
132         stats->tx_bytes = batadv_sum_counter(bat_priv, BATADV_CNT_TX_BYTES);
133         stats->tx_dropped = batadv_sum_counter(bat_priv, BATADV_CNT_TX_DROPPED);
134         stats->rx_packets = batadv_sum_counter(bat_priv, BATADV_CNT_RX);
135         stats->rx_bytes = batadv_sum_counter(bat_priv, BATADV_CNT_RX_BYTES);
136         return stats;
137 }
138
139 static int batadv_interface_set_mac_addr(struct net_device *dev, void *p)
140 {
141         struct batadv_priv *bat_priv = netdev_priv(dev);
142         struct batadv_softif_vlan *vlan;
143         struct sockaddr *addr = p;
144         u8 old_addr[ETH_ALEN];
145
146         if (!is_valid_ether_addr(addr->sa_data))
147                 return -EADDRNOTAVAIL;
148
149         ether_addr_copy(old_addr, dev->dev_addr);
150         ether_addr_copy(dev->dev_addr, addr->sa_data);
151
152         /* only modify transtable if it has been initialized before */
153         if (atomic_read(&bat_priv->mesh_state) != BATADV_MESH_ACTIVE)
154                 return 0;
155
156         rcu_read_lock();
157         hlist_for_each_entry_rcu(vlan, &bat_priv->softif_vlan_list, list) {
158                 batadv_tt_local_remove(bat_priv, old_addr, vlan->vid,
159                                        "mac address changed", false);
160                 batadv_tt_local_add(dev, addr->sa_data, vlan->vid,
161                                     BATADV_NULL_IFINDEX, BATADV_NO_MARK);
162         }
163         rcu_read_unlock();
164
165         return 0;
166 }
167
168 static int batadv_interface_change_mtu(struct net_device *dev, int new_mtu)
169 {
170         /* check ranges */
171         if (new_mtu < 68 || new_mtu > batadv_hardif_min_mtu(dev))
172                 return -EINVAL;
173
174         dev->mtu = new_mtu;
175
176         return 0;
177 }
178
179 /**
180  * batadv_interface_set_rx_mode() - set the rx mode of a device
181  * @dev: registered network device to modify
182  *
183  * We do not actually need to set any rx filters for the virtual batman
184  * soft interface. However a dummy handler enables a user to set static
185  * multicast listeners for instance.
186  */
187 static void batadv_interface_set_rx_mode(struct net_device *dev)
188 {
189 }
190
191 static int batadv_interface_tx(struct sk_buff *skb,
192                                struct net_device *soft_iface)
193 {
194         struct ethhdr *ethhdr;
195         struct batadv_priv *bat_priv = netdev_priv(soft_iface);
196         struct batadv_hard_iface *primary_if = NULL;
197         struct batadv_bcast_packet *bcast_packet;
198         static const u8 stp_addr[ETH_ALEN] = {0x01, 0x80, 0xC2, 0x00,
199                                               0x00, 0x00};
200         static const u8 ectp_addr[ETH_ALEN] = {0xCF, 0x00, 0x00, 0x00,
201                                                0x00, 0x00};
202         enum batadv_dhcp_recipient dhcp_rcp = BATADV_DHCP_NO;
203         u8 *dst_hint = NULL, chaddr[ETH_ALEN];
204         struct vlan_ethhdr *vhdr;
205         unsigned int header_len = 0;
206         int data_len = skb->len, ret;
207         unsigned long brd_delay = 1;
208         bool do_bcast = false, client_added;
209         unsigned short vid;
210         u32 seqno;
211         int gw_mode;
212         enum batadv_forw_mode forw_mode;
213         struct batadv_orig_node *mcast_single_orig = NULL;
214         int network_offset = ETH_HLEN;
215
216         if (atomic_read(&bat_priv->mesh_state) != BATADV_MESH_ACTIVE)
217                 goto dropped;
218
219         /* reset control block to avoid left overs from previous users */
220         memset(skb->cb, 0, sizeof(struct batadv_skb_cb));
221
222         netif_trans_update(soft_iface);
223         vid = batadv_get_vid(skb, 0);
224         ethhdr = eth_hdr(skb);
225
226         switch (ntohs(ethhdr->h_proto)) {
227         case ETH_P_8021Q:
228                 vhdr = vlan_eth_hdr(skb);
229
230                 /* drop batman-in-batman packets to prevent loops */
231                 if (vhdr->h_vlan_encapsulated_proto != htons(ETH_P_BATMAN)) {
232                         network_offset += VLAN_HLEN;
233                         break;
234                 }
235
236                 /* fall through */
237         case ETH_P_BATMAN:
238                 goto dropped;
239         }
240
241         skb_set_network_header(skb, network_offset);
242
243         if (batadv_bla_tx(bat_priv, skb, vid))
244                 goto dropped;
245
246         /* skb->data might have been reallocated by batadv_bla_tx() */
247         ethhdr = eth_hdr(skb);
248
249         /* Register the client MAC in the transtable */
250         if (!is_multicast_ether_addr(ethhdr->h_source) &&
251             !batadv_bla_is_loopdetect_mac(ethhdr->h_source)) {
252                 client_added = batadv_tt_local_add(soft_iface, ethhdr->h_source,
253                                                    vid, skb->skb_iif,
254                                                    skb->mark);
255                 if (!client_added)
256                         goto dropped;
257         }
258
259         /* don't accept stp packets. STP does not help in meshes.
260          * better use the bridge loop avoidance ...
261          *
262          * The same goes for ECTP sent at least by some Cisco Switches,
263          * it might confuse the mesh when used with bridge loop avoidance.
264          */
265         if (batadv_compare_eth(ethhdr->h_dest, stp_addr))
266                 goto dropped;
267
268         if (batadv_compare_eth(ethhdr->h_dest, ectp_addr))
269                 goto dropped;
270
271         gw_mode = atomic_read(&bat_priv->gw.mode);
272         if (is_multicast_ether_addr(ethhdr->h_dest)) {
273                 /* if gw mode is off, broadcast every packet */
274                 if (gw_mode == BATADV_GW_MODE_OFF) {
275                         do_bcast = true;
276                         goto send;
277                 }
278
279                 dhcp_rcp = batadv_gw_dhcp_recipient_get(skb, &header_len,
280                                                         chaddr);
281                 /* skb->data may have been modified by
282                  * batadv_gw_dhcp_recipient_get()
283                  */
284                 ethhdr = eth_hdr(skb);
285                 /* if gw_mode is on, broadcast any non-DHCP message.
286                  * All the DHCP packets are going to be sent as unicast
287                  */
288                 if (dhcp_rcp == BATADV_DHCP_NO) {
289                         do_bcast = true;
290                         goto send;
291                 }
292
293                 if (dhcp_rcp == BATADV_DHCP_TO_CLIENT)
294                         dst_hint = chaddr;
295                 else if ((gw_mode == BATADV_GW_MODE_SERVER) &&
296                          (dhcp_rcp == BATADV_DHCP_TO_SERVER))
297                         /* gateways should not forward any DHCP message if
298                          * directed to a DHCP server
299                          */
300                         goto dropped;
301
302 send:
303                 if (do_bcast && !is_broadcast_ether_addr(ethhdr->h_dest)) {
304                         forw_mode = batadv_mcast_forw_mode(bat_priv, skb,
305                                                            &mcast_single_orig);
306                         if (forw_mode == BATADV_FORW_NONE)
307                                 goto dropped;
308
309                         if (forw_mode == BATADV_FORW_SINGLE)
310                                 do_bcast = false;
311                 }
312         }
313
314         batadv_skb_set_priority(skb, 0);
315
316         /* ethernet packet should be broadcasted */
317         if (do_bcast) {
318                 primary_if = batadv_primary_if_get_selected(bat_priv);
319                 if (!primary_if)
320                         goto dropped;
321
322                 /* in case of ARP request, we do not immediately broadcasti the
323                  * packet, instead we first wait for DAT to try to retrieve the
324                  * correct ARP entry
325                  */
326                 if (batadv_dat_snoop_outgoing_arp_request(bat_priv, skb))
327                         brd_delay = msecs_to_jiffies(ARP_REQ_DELAY);
328
329                 if (batadv_skb_head_push(skb, sizeof(*bcast_packet)) < 0)
330                         goto dropped;
331
332                 bcast_packet = (struct batadv_bcast_packet *)skb->data;
333                 bcast_packet->version = BATADV_COMPAT_VERSION;
334                 bcast_packet->ttl = BATADV_TTL;
335
336                 /* batman packet type: broadcast */
337                 bcast_packet->packet_type = BATADV_BCAST;
338                 bcast_packet->reserved = 0;
339
340                 /* hw address of first interface is the orig mac because only
341                  * this mac is known throughout the mesh
342                  */
343                 ether_addr_copy(bcast_packet->orig,
344                                 primary_if->net_dev->dev_addr);
345
346                 /* set broadcast sequence number */
347                 seqno = atomic_inc_return(&bat_priv->bcast_seqno);
348                 bcast_packet->seqno = htonl(seqno);
349
350                 batadv_add_bcast_packet_to_list(bat_priv, skb, brd_delay, true);
351
352                 /* a copy is stored in the bcast list, therefore removing
353                  * the original skb.
354                  */
355                 consume_skb(skb);
356
357         /* unicast packet */
358         } else {
359                 /* DHCP packets going to a server will use the GW feature */
360                 if (dhcp_rcp == BATADV_DHCP_TO_SERVER) {
361                         ret = batadv_gw_out_of_range(bat_priv, skb);
362                         if (ret)
363                                 goto dropped;
364                         ret = batadv_send_skb_via_gw(bat_priv, skb, vid);
365                 } else if (mcast_single_orig) {
366                         ret = batadv_send_skb_unicast(bat_priv, skb,
367                                                       BATADV_UNICAST, 0,
368                                                       mcast_single_orig, vid);
369                 } else {
370                         if (batadv_dat_snoop_outgoing_arp_request(bat_priv,
371                                                                   skb))
372                                 goto dropped;
373
374                         batadv_dat_snoop_outgoing_arp_reply(bat_priv, skb);
375
376                         ret = batadv_send_skb_via_tt(bat_priv, skb, dst_hint,
377                                                      vid);
378                 }
379                 if (ret != NET_XMIT_SUCCESS)
380                         goto dropped_freed;
381         }
382
383         batadv_inc_counter(bat_priv, BATADV_CNT_TX);
384         batadv_add_counter(bat_priv, BATADV_CNT_TX_BYTES, data_len);
385         goto end;
386
387 dropped:
388         kfree_skb(skb);
389 dropped_freed:
390         batadv_inc_counter(bat_priv, BATADV_CNT_TX_DROPPED);
391 end:
392         if (mcast_single_orig)
393                 batadv_orig_node_put(mcast_single_orig);
394         if (primary_if)
395                 batadv_hardif_put(primary_if);
396         return NETDEV_TX_OK;
397 }
398
399 /**
400  * batadv_interface_rx() - receive ethernet frame on local batman-adv interface
401  * @soft_iface: local interface which will receive the ethernet frame
402  * @skb: ethernet frame for @soft_iface
403  * @hdr_size: size of already parsed batman-adv header
404  * @orig_node: originator from which the batman-adv packet was sent
405  *
406  * Sends a ethernet frame to the receive path of the local @soft_iface.
407  * skb->data has still point to the batman-adv header with the size @hdr_size.
408  * The caller has to have parsed this header already and made sure that at least
409  * @hdr_size bytes are still available for pull in @skb.
410  *
411  * The packet may still get dropped. This can happen when the encapsulated
412  * ethernet frame is invalid or contains again an batman-adv packet. Also
413  * unicast packets will be dropped directly when it was sent between two
414  * isolated clients.
415  */
416 void batadv_interface_rx(struct net_device *soft_iface,
417                          struct sk_buff *skb, int hdr_size,
418                          struct batadv_orig_node *orig_node)
419 {
420         struct batadv_bcast_packet *batadv_bcast_packet;
421         struct batadv_priv *bat_priv = netdev_priv(soft_iface);
422         struct vlan_ethhdr *vhdr;
423         struct ethhdr *ethhdr;
424         unsigned short vid;
425         bool is_bcast;
426
427         batadv_bcast_packet = (struct batadv_bcast_packet *)skb->data;
428         is_bcast = (batadv_bcast_packet->packet_type == BATADV_BCAST);
429
430         skb_pull_rcsum(skb, hdr_size);
431         skb_reset_mac_header(skb);
432
433         /* clean the netfilter state now that the batman-adv header has been
434          * removed
435          */
436         nf_reset(skb);
437
438         if (unlikely(!pskb_may_pull(skb, ETH_HLEN)))
439                 goto dropped;
440
441         vid = batadv_get_vid(skb, 0);
442         ethhdr = eth_hdr(skb);
443
444         switch (ntohs(ethhdr->h_proto)) {
445         case ETH_P_8021Q:
446                 if (!pskb_may_pull(skb, VLAN_ETH_HLEN))
447                         goto dropped;
448
449                 vhdr = (struct vlan_ethhdr *)skb->data;
450
451                 /* drop batman-in-batman packets to prevent loops */
452                 if (vhdr->h_vlan_encapsulated_proto != htons(ETH_P_BATMAN))
453                         break;
454
455                 /* fall through */
456         case ETH_P_BATMAN:
457                 goto dropped;
458         }
459
460         /* skb->dev & skb->pkt_type are set here */
461         skb->protocol = eth_type_trans(skb, soft_iface);
462         skb_postpull_rcsum(skb, eth_hdr(skb), ETH_HLEN);
463
464         batadv_inc_counter(bat_priv, BATADV_CNT_RX);
465         batadv_add_counter(bat_priv, BATADV_CNT_RX_BYTES,
466                            skb->len + ETH_HLEN);
467
468         /* Let the bridge loop avoidance check the packet. If will
469          * not handle it, we can safely push it up.
470          */
471         if (batadv_bla_rx(bat_priv, skb, vid, is_bcast))
472                 goto out;
473
474         if (orig_node)
475                 batadv_tt_add_temporary_global_entry(bat_priv, orig_node,
476                                                      ethhdr->h_source, vid);
477
478         if (is_multicast_ether_addr(ethhdr->h_dest)) {
479                 /* set the mark on broadcast packets if AP isolation is ON and
480                  * the packet is coming from an "isolated" client
481                  */
482                 if (batadv_vlan_ap_isola_get(bat_priv, vid) &&
483                     batadv_tt_global_is_isolated(bat_priv, ethhdr->h_source,
484                                                  vid)) {
485                         /* save bits in skb->mark not covered by the mask and
486                          * apply the mark on the rest
487                          */
488                         skb->mark &= ~bat_priv->isolation_mark_mask;
489                         skb->mark |= bat_priv->isolation_mark;
490                 }
491         } else if (batadv_is_ap_isolated(bat_priv, ethhdr->h_source,
492                                          ethhdr->h_dest, vid)) {
493                 goto dropped;
494         }
495
496         netif_rx(skb);
497         goto out;
498
499 dropped:
500         kfree_skb(skb);
501 out:
502         return;
503 }
504
505 /**
506  * batadv_softif_vlan_release() - release vlan from lists and queue for free
507  *  after rcu grace period
508  * @ref: kref pointer of the vlan object
509  */
510 static void batadv_softif_vlan_release(struct kref *ref)
511 {
512         struct batadv_softif_vlan *vlan;
513
514         vlan = container_of(ref, struct batadv_softif_vlan, refcount);
515
516         spin_lock_bh(&vlan->bat_priv->softif_vlan_list_lock);
517         hlist_del_rcu(&vlan->list);
518         spin_unlock_bh(&vlan->bat_priv->softif_vlan_list_lock);
519
520         kfree_rcu(vlan, rcu);
521 }
522
523 /**
524  * batadv_softif_vlan_put() - decrease the vlan object refcounter and
525  *  possibly release it
526  * @vlan: the vlan object to release
527  */
528 void batadv_softif_vlan_put(struct batadv_softif_vlan *vlan)
529 {
530         if (!vlan)
531                 return;
532
533         kref_put(&vlan->refcount, batadv_softif_vlan_release);
534 }
535
536 /**
537  * batadv_softif_vlan_get() - get the vlan object for a specific vid
538  * @bat_priv: the bat priv with all the soft interface information
539  * @vid: the identifier of the vlan object to retrieve
540  *
541  * Return: the private data of the vlan matching the vid passed as argument or
542  * NULL otherwise. The refcounter of the returned object is incremented by 1.
543  */
544 struct batadv_softif_vlan *batadv_softif_vlan_get(struct batadv_priv *bat_priv,
545                                                   unsigned short vid)
546 {
547         struct batadv_softif_vlan *vlan_tmp, *vlan = NULL;
548
549         rcu_read_lock();
550         hlist_for_each_entry_rcu(vlan_tmp, &bat_priv->softif_vlan_list, list) {
551                 if (vlan_tmp->vid != vid)
552                         continue;
553
554                 if (!kref_get_unless_zero(&vlan_tmp->refcount))
555                         continue;
556
557                 vlan = vlan_tmp;
558                 break;
559         }
560         rcu_read_unlock();
561
562         return vlan;
563 }
564
565 /**
566  * batadv_softif_create_vlan() - allocate the needed resources for a new vlan
567  * @bat_priv: the bat priv with all the soft interface information
568  * @vid: the VLAN identifier
569  *
570  * Return: 0 on success, a negative error otherwise.
571  */
572 int batadv_softif_create_vlan(struct batadv_priv *bat_priv, unsigned short vid)
573 {
574         struct batadv_softif_vlan *vlan;
575         int err;
576
577         vlan = batadv_softif_vlan_get(bat_priv, vid);
578         if (vlan) {
579                 batadv_softif_vlan_put(vlan);
580                 return -EEXIST;
581         }
582
583         vlan = kzalloc(sizeof(*vlan), GFP_ATOMIC);
584         if (!vlan)
585                 return -ENOMEM;
586
587         vlan->bat_priv = bat_priv;
588         vlan->vid = vid;
589         kref_init(&vlan->refcount);
590
591         atomic_set(&vlan->ap_isolation, 0);
592
593         err = batadv_sysfs_add_vlan(bat_priv->soft_iface, vlan);
594         if (err) {
595                 kfree(vlan);
596                 return err;
597         }
598
599         spin_lock_bh(&bat_priv->softif_vlan_list_lock);
600         kref_get(&vlan->refcount);
601         hlist_add_head_rcu(&vlan->list, &bat_priv->softif_vlan_list);
602         spin_unlock_bh(&bat_priv->softif_vlan_list_lock);
603
604         /* add a new TT local entry. This one will be marked with the NOPURGE
605          * flag
606          */
607         batadv_tt_local_add(bat_priv->soft_iface,
608                             bat_priv->soft_iface->dev_addr, vid,
609                             BATADV_NULL_IFINDEX, BATADV_NO_MARK);
610
611         /* don't return reference to new softif_vlan */
612         batadv_softif_vlan_put(vlan);
613
614         return 0;
615 }
616
617 /**
618  * batadv_softif_destroy_vlan() - remove and destroy a softif_vlan object
619  * @bat_priv: the bat priv with all the soft interface information
620  * @vlan: the object to remove
621  */
622 static void batadv_softif_destroy_vlan(struct batadv_priv *bat_priv,
623                                        struct batadv_softif_vlan *vlan)
624 {
625         /* explicitly remove the associated TT local entry because it is marked
626          * with the NOPURGE flag
627          */
628         batadv_tt_local_remove(bat_priv, bat_priv->soft_iface->dev_addr,
629                                vlan->vid, "vlan interface destroyed", false);
630
631         batadv_sysfs_del_vlan(bat_priv, vlan);
632         batadv_softif_vlan_put(vlan);
633 }
634
635 /**
636  * batadv_interface_add_vid() - ndo_add_vid API implementation
637  * @dev: the netdev of the mesh interface
638  * @proto: protocol of the the vlan id
639  * @vid: identifier of the new vlan
640  *
641  * Set up all the internal structures for handling the new vlan on top of the
642  * mesh interface
643  *
644  * Return: 0 on success or a negative error code in case of failure.
645  */
646 static int batadv_interface_add_vid(struct net_device *dev, __be16 proto,
647                                     unsigned short vid)
648 {
649         struct batadv_priv *bat_priv = netdev_priv(dev);
650         struct batadv_softif_vlan *vlan;
651         int ret;
652
653         /* only 802.1Q vlans are supported.
654          * batman-adv does not know how to handle other types
655          */
656         if (proto != htons(ETH_P_8021Q))
657                 return -EINVAL;
658
659         vid |= BATADV_VLAN_HAS_TAG;
660
661         /* if a new vlan is getting created and it already exists, it means that
662          * it was not deleted yet. batadv_softif_vlan_get() increases the
663          * refcount in order to revive the object.
664          *
665          * if it does not exist then create it.
666          */
667         vlan = batadv_softif_vlan_get(bat_priv, vid);
668         if (!vlan)
669                 return batadv_softif_create_vlan(bat_priv, vid);
670
671         /* recreate the sysfs object if it was already destroyed (and it should
672          * be since we received a kill_vid() for this vlan
673          */
674         if (!vlan->kobj) {
675                 ret = batadv_sysfs_add_vlan(bat_priv->soft_iface, vlan);
676                 if (ret) {
677                         batadv_softif_vlan_put(vlan);
678                         return ret;
679                 }
680         }
681
682         /* add a new TT local entry. This one will be marked with the NOPURGE
683          * flag. This must be added again, even if the vlan object already
684          * exists, because the entry was deleted by kill_vid()
685          */
686         batadv_tt_local_add(bat_priv->soft_iface,
687                             bat_priv->soft_iface->dev_addr, vid,
688                             BATADV_NULL_IFINDEX, BATADV_NO_MARK);
689
690         return 0;
691 }
692
693 /**
694  * batadv_interface_kill_vid() - ndo_kill_vid API implementation
695  * @dev: the netdev of the mesh interface
696  * @proto: protocol of the the vlan id
697  * @vid: identifier of the deleted vlan
698  *
699  * Destroy all the internal structures used to handle the vlan identified by vid
700  * on top of the mesh interface
701  *
702  * Return: 0 on success, -EINVAL if the specified prototype is not ETH_P_8021Q
703  * or -ENOENT if the specified vlan id wasn't registered.
704  */
705 static int batadv_interface_kill_vid(struct net_device *dev, __be16 proto,
706                                      unsigned short vid)
707 {
708         struct batadv_priv *bat_priv = netdev_priv(dev);
709         struct batadv_softif_vlan *vlan;
710
711         /* only 802.1Q vlans are supported. batman-adv does not know how to
712          * handle other types
713          */
714         if (proto != htons(ETH_P_8021Q))
715                 return -EINVAL;
716
717         vlan = batadv_softif_vlan_get(bat_priv, vid | BATADV_VLAN_HAS_TAG);
718         if (!vlan)
719                 return -ENOENT;
720
721         batadv_softif_destroy_vlan(bat_priv, vlan);
722
723         /* finally free the vlan object */
724         batadv_softif_vlan_put(vlan);
725
726         return 0;
727 }
728
729 /* batman-adv network devices have devices nesting below it and are a special
730  * "super class" of normal network devices; split their locks off into a
731  * separate class since they always nest.
732  */
733 static struct lock_class_key batadv_netdev_xmit_lock_key;
734 static struct lock_class_key batadv_netdev_addr_lock_key;
735
736 /**
737  * batadv_set_lockdep_class_one() - Set lockdep class for a single tx queue
738  * @dev: device which owns the tx queue
739  * @txq: tx queue to modify
740  * @_unused: always NULL
741  */
742 static void batadv_set_lockdep_class_one(struct net_device *dev,
743                                          struct netdev_queue *txq,
744                                          void *_unused)
745 {
746         lockdep_set_class(&txq->_xmit_lock, &batadv_netdev_xmit_lock_key);
747 }
748
749 /**
750  * batadv_set_lockdep_class() - Set txq and addr_list lockdep class
751  * @dev: network device to modify
752  */
753 static void batadv_set_lockdep_class(struct net_device *dev)
754 {
755         lockdep_set_class(&dev->addr_list_lock, &batadv_netdev_addr_lock_key);
756         netdev_for_each_tx_queue(dev, batadv_set_lockdep_class_one, NULL);
757 }
758
759 /**
760  * batadv_softif_init_late() - late stage initialization of soft interface
761  * @dev: registered network device to modify
762  *
763  * Return: error code on failures
764  */
765 static int batadv_softif_init_late(struct net_device *dev)
766 {
767         struct batadv_priv *bat_priv;
768         u32 random_seqno;
769         int ret;
770         size_t cnt_len = sizeof(u64) * BATADV_CNT_NUM;
771
772         batadv_set_lockdep_class(dev);
773
774         bat_priv = netdev_priv(dev);
775         bat_priv->soft_iface = dev;
776
777         /* batadv_interface_stats() needs to be available as soon as
778          * register_netdevice() has been called
779          */
780         bat_priv->bat_counters = __alloc_percpu(cnt_len, __alignof__(u64));
781         if (!bat_priv->bat_counters)
782                 return -ENOMEM;
783
784         atomic_set(&bat_priv->aggregated_ogms, 1);
785         atomic_set(&bat_priv->bonding, 0);
786 #ifdef CONFIG_BATMAN_ADV_BLA
787         atomic_set(&bat_priv->bridge_loop_avoidance, 1);
788 #endif
789 #ifdef CONFIG_BATMAN_ADV_DAT
790         atomic_set(&bat_priv->distributed_arp_table, 1);
791 #endif
792 #ifdef CONFIG_BATMAN_ADV_MCAST
793         bat_priv->mcast.querier_ipv4.exists = false;
794         bat_priv->mcast.querier_ipv4.shadowing = false;
795         bat_priv->mcast.querier_ipv6.exists = false;
796         bat_priv->mcast.querier_ipv6.shadowing = false;
797         bat_priv->mcast.flags = BATADV_NO_FLAGS;
798         atomic_set(&bat_priv->multicast_mode, 1);
799         atomic_set(&bat_priv->mcast.num_disabled, 0);
800         atomic_set(&bat_priv->mcast.num_want_all_unsnoopables, 0);
801         atomic_set(&bat_priv->mcast.num_want_all_ipv4, 0);
802         atomic_set(&bat_priv->mcast.num_want_all_ipv6, 0);
803 #endif
804         atomic_set(&bat_priv->gw.mode, BATADV_GW_MODE_OFF);
805         atomic_set(&bat_priv->gw.bandwidth_down, 100);
806         atomic_set(&bat_priv->gw.bandwidth_up, 20);
807         atomic_set(&bat_priv->orig_interval, 1000);
808         atomic_set(&bat_priv->hop_penalty, 30);
809 #ifdef CONFIG_BATMAN_ADV_DEBUG
810         atomic_set(&bat_priv->log_level, 0);
811 #endif
812         atomic_set(&bat_priv->fragmentation, 1);
813         atomic_set(&bat_priv->packet_size_max, ETH_DATA_LEN);
814         atomic_set(&bat_priv->bcast_queue_left, BATADV_BCAST_QUEUE_LEN);
815         atomic_set(&bat_priv->batman_queue_left, BATADV_BATMAN_QUEUE_LEN);
816
817         atomic_set(&bat_priv->mesh_state, BATADV_MESH_INACTIVE);
818         atomic_set(&bat_priv->bcast_seqno, 1);
819         atomic_set(&bat_priv->tt.vn, 0);
820         atomic_set(&bat_priv->tt.local_changes, 0);
821         atomic_set(&bat_priv->tt.ogm_append_cnt, 0);
822 #ifdef CONFIG_BATMAN_ADV_BLA
823         atomic_set(&bat_priv->bla.num_requests, 0);
824 #endif
825         atomic_set(&bat_priv->tp_num, 0);
826
827         bat_priv->tt.last_changeset = NULL;
828         bat_priv->tt.last_changeset_len = 0;
829         bat_priv->isolation_mark = 0;
830         bat_priv->isolation_mark_mask = 0;
831
832         /* randomize initial seqno to avoid collision */
833         get_random_bytes(&random_seqno, sizeof(random_seqno));
834         atomic_set(&bat_priv->frag_seqno, random_seqno);
835
836         bat_priv->primary_if = NULL;
837         bat_priv->num_ifaces = 0;
838
839         batadv_nc_init_bat_priv(bat_priv);
840
841         ret = batadv_algo_select(bat_priv, batadv_routing_algo);
842         if (ret < 0)
843                 goto free_bat_counters;
844
845         ret = batadv_debugfs_add_meshif(dev);
846         if (ret < 0)
847                 goto free_bat_counters;
848
849         ret = batadv_mesh_init(dev);
850         if (ret < 0)
851                 goto unreg_debugfs;
852
853         return 0;
854
855 unreg_debugfs:
856         batadv_debugfs_del_meshif(dev);
857 free_bat_counters:
858         free_percpu(bat_priv->bat_counters);
859         bat_priv->bat_counters = NULL;
860
861         return ret;
862 }
863
864 /**
865  * batadv_softif_slave_add() - Add a slave interface to a batadv_soft_interface
866  * @dev: batadv_soft_interface used as master interface
867  * @slave_dev: net_device which should become the slave interface
868  * @extack: extended ACK report struct
869  *
870  * Return: 0 if successful or error otherwise.
871  */
872 static int batadv_softif_slave_add(struct net_device *dev,
873                                    struct net_device *slave_dev,
874                                    struct netlink_ext_ack *extack)
875 {
876         struct batadv_hard_iface *hard_iface;
877         struct net *net = dev_net(dev);
878         int ret = -EINVAL;
879
880         hard_iface = batadv_hardif_get_by_netdev(slave_dev);
881         if (!hard_iface || hard_iface->soft_iface)
882                 goto out;
883
884         ret = batadv_hardif_enable_interface(hard_iface, net, dev->name);
885
886 out:
887         if (hard_iface)
888                 batadv_hardif_put(hard_iface);
889         return ret;
890 }
891
892 /**
893  * batadv_softif_slave_del() - Delete a slave iface from a batadv_soft_interface
894  * @dev: batadv_soft_interface used as master interface
895  * @slave_dev: net_device which should be removed from the master interface
896  *
897  * Return: 0 if successful or error otherwise.
898  */
899 static int batadv_softif_slave_del(struct net_device *dev,
900                                    struct net_device *slave_dev)
901 {
902         struct batadv_hard_iface *hard_iface;
903         int ret = -EINVAL;
904
905         hard_iface = batadv_hardif_get_by_netdev(slave_dev);
906
907         if (!hard_iface || hard_iface->soft_iface != dev)
908                 goto out;
909
910         batadv_hardif_disable_interface(hard_iface, BATADV_IF_CLEANUP_KEEP);
911         ret = 0;
912
913 out:
914         if (hard_iface)
915                 batadv_hardif_put(hard_iface);
916         return ret;
917 }
918
919 static const struct net_device_ops batadv_netdev_ops = {
920         .ndo_init = batadv_softif_init_late,
921         .ndo_open = batadv_interface_open,
922         .ndo_stop = batadv_interface_release,
923         .ndo_get_stats = batadv_interface_stats,
924         .ndo_vlan_rx_add_vid = batadv_interface_add_vid,
925         .ndo_vlan_rx_kill_vid = batadv_interface_kill_vid,
926         .ndo_set_mac_address = batadv_interface_set_mac_addr,
927         .ndo_change_mtu = batadv_interface_change_mtu,
928         .ndo_set_rx_mode = batadv_interface_set_rx_mode,
929         .ndo_start_xmit = batadv_interface_tx,
930         .ndo_validate_addr = eth_validate_addr,
931         .ndo_add_slave = batadv_softif_slave_add,
932         .ndo_del_slave = batadv_softif_slave_del,
933 };
934
935 static void batadv_get_drvinfo(struct net_device *dev,
936                                struct ethtool_drvinfo *info)
937 {
938         strlcpy(info->driver, "B.A.T.M.A.N. advanced", sizeof(info->driver));
939         strlcpy(info->version, BATADV_SOURCE_VERSION, sizeof(info->version));
940         strlcpy(info->fw_version, "N/A", sizeof(info->fw_version));
941         strlcpy(info->bus_info, "batman", sizeof(info->bus_info));
942 }
943
944 /* Inspired by drivers/net/ethernet/dlink/sundance.c:1702
945  * Declare each description string in struct.name[] to get fixed sized buffer
946  * and compile time checking for strings longer than ETH_GSTRING_LEN.
947  */
948 static const struct {
949         const char name[ETH_GSTRING_LEN];
950 } batadv_counters_strings[] = {
951         { "tx" },
952         { "tx_bytes" },
953         { "tx_dropped" },
954         { "rx" },
955         { "rx_bytes" },
956         { "forward" },
957         { "forward_bytes" },
958         { "mgmt_tx" },
959         { "mgmt_tx_bytes" },
960         { "mgmt_rx" },
961         { "mgmt_rx_bytes" },
962         { "frag_tx" },
963         { "frag_tx_bytes" },
964         { "frag_rx" },
965         { "frag_rx_bytes" },
966         { "frag_fwd" },
967         { "frag_fwd_bytes" },
968         { "tt_request_tx" },
969         { "tt_request_rx" },
970         { "tt_response_tx" },
971         { "tt_response_rx" },
972         { "tt_roam_adv_tx" },
973         { "tt_roam_adv_rx" },
974 #ifdef CONFIG_BATMAN_ADV_DAT
975         { "dat_get_tx" },
976         { "dat_get_rx" },
977         { "dat_put_tx" },
978         { "dat_put_rx" },
979         { "dat_cached_reply_tx" },
980 #endif
981 #ifdef CONFIG_BATMAN_ADV_NC
982         { "nc_code" },
983         { "nc_code_bytes" },
984         { "nc_recode" },
985         { "nc_recode_bytes" },
986         { "nc_buffer" },
987         { "nc_decode" },
988         { "nc_decode_bytes" },
989         { "nc_decode_failed" },
990         { "nc_sniffed" },
991 #endif
992 };
993
994 static void batadv_get_strings(struct net_device *dev, u32 stringset, u8 *data)
995 {
996         if (stringset == ETH_SS_STATS)
997                 memcpy(data, batadv_counters_strings,
998                        sizeof(batadv_counters_strings));
999 }
1000
1001 static void batadv_get_ethtool_stats(struct net_device *dev,
1002                                      struct ethtool_stats *stats, u64 *data)
1003 {
1004         struct batadv_priv *bat_priv = netdev_priv(dev);
1005         int i;
1006
1007         for (i = 0; i < BATADV_CNT_NUM; i++)
1008                 data[i] = batadv_sum_counter(bat_priv, i);
1009 }
1010
1011 static int batadv_get_sset_count(struct net_device *dev, int stringset)
1012 {
1013         if (stringset == ETH_SS_STATS)
1014                 return BATADV_CNT_NUM;
1015
1016         return -EOPNOTSUPP;
1017 }
1018
1019 static const struct ethtool_ops batadv_ethtool_ops = {
1020         .get_drvinfo = batadv_get_drvinfo,
1021         .get_link = ethtool_op_get_link,
1022         .get_strings = batadv_get_strings,
1023         .get_ethtool_stats = batadv_get_ethtool_stats,
1024         .get_sset_count = batadv_get_sset_count,
1025 };
1026
1027 /**
1028  * batadv_softif_free() - Deconstructor of batadv_soft_interface
1029  * @dev: Device to cleanup and remove
1030  */
1031 static void batadv_softif_free(struct net_device *dev)
1032 {
1033         batadv_debugfs_del_meshif(dev);
1034         batadv_mesh_free(dev);
1035
1036         /* some scheduled RCU callbacks need the bat_priv struct to accomplish
1037          * their tasks. Wait for them all to be finished before freeing the
1038          * netdev and its private data (bat_priv)
1039          */
1040         rcu_barrier();
1041 }
1042
1043 /**
1044  * batadv_softif_init_early() - early stage initialization of soft interface
1045  * @dev: registered network device to modify
1046  */
1047 static void batadv_softif_init_early(struct net_device *dev)
1048 {
1049         ether_setup(dev);
1050
1051         dev->netdev_ops = &batadv_netdev_ops;
1052         dev->needs_free_netdev = true;
1053         dev->priv_destructor = batadv_softif_free;
1054         dev->features |= NETIF_F_HW_VLAN_CTAG_FILTER | NETIF_F_NETNS_LOCAL;
1055         dev->priv_flags |= IFF_NO_QUEUE;
1056
1057         /* can't call min_mtu, because the needed variables
1058          * have not been initialized yet
1059          */
1060         dev->mtu = ETH_DATA_LEN;
1061
1062         /* generate random address */
1063         eth_hw_addr_random(dev);
1064
1065         dev->ethtool_ops = &batadv_ethtool_ops;
1066 }
1067
1068 /**
1069  * batadv_softif_create() - Create and register soft interface
1070  * @net: the applicable net namespace
1071  * @name: name of the new soft interface
1072  *
1073  * Return: newly allocated soft_interface, NULL on errors
1074  */
1075 struct net_device *batadv_softif_create(struct net *net, const char *name)
1076 {
1077         struct net_device *soft_iface;
1078         int ret;
1079
1080         soft_iface = alloc_netdev(sizeof(struct batadv_priv), name,
1081                                   NET_NAME_UNKNOWN, batadv_softif_init_early);
1082         if (!soft_iface)
1083                 return NULL;
1084
1085         dev_net_set(soft_iface, net);
1086
1087         soft_iface->rtnl_link_ops = &batadv_link_ops;
1088
1089         ret = register_netdevice(soft_iface);
1090         if (ret < 0) {
1091                 pr_err("Unable to register the batman interface '%s': %i\n",
1092                        name, ret);
1093                 free_netdev(soft_iface);
1094                 return NULL;
1095         }
1096
1097         return soft_iface;
1098 }
1099
1100 /**
1101  * batadv_softif_destroy_sysfs() - deletion of batadv_soft_interface via sysfs
1102  * @soft_iface: the to-be-removed batman-adv interface
1103  */
1104 void batadv_softif_destroy_sysfs(struct net_device *soft_iface)
1105 {
1106         struct batadv_priv *bat_priv = netdev_priv(soft_iface);
1107         struct batadv_softif_vlan *vlan;
1108
1109         ASSERT_RTNL();
1110
1111         /* destroy the "untagged" VLAN */
1112         vlan = batadv_softif_vlan_get(bat_priv, BATADV_NO_FLAGS);
1113         if (vlan) {
1114                 batadv_softif_destroy_vlan(bat_priv, vlan);
1115                 batadv_softif_vlan_put(vlan);
1116         }
1117
1118         batadv_sysfs_del_meshif(soft_iface);
1119         unregister_netdevice(soft_iface);
1120 }
1121
1122 /**
1123  * batadv_softif_destroy_netlink() - deletion of batadv_soft_interface via
1124  *  netlink
1125  * @soft_iface: the to-be-removed batman-adv interface
1126  * @head: list pointer
1127  */
1128 static void batadv_softif_destroy_netlink(struct net_device *soft_iface,
1129                                           struct list_head *head)
1130 {
1131         struct batadv_priv *bat_priv = netdev_priv(soft_iface);
1132         struct batadv_hard_iface *hard_iface;
1133         struct batadv_softif_vlan *vlan;
1134
1135         list_for_each_entry(hard_iface, &batadv_hardif_list, list) {
1136                 if (hard_iface->soft_iface == soft_iface)
1137                         batadv_hardif_disable_interface(hard_iface,
1138                                                         BATADV_IF_CLEANUP_KEEP);
1139         }
1140
1141         /* destroy the "untagged" VLAN */
1142         vlan = batadv_softif_vlan_get(bat_priv, BATADV_NO_FLAGS);
1143         if (vlan) {
1144                 batadv_softif_destroy_vlan(bat_priv, vlan);
1145                 batadv_softif_vlan_put(vlan);
1146         }
1147
1148         batadv_sysfs_del_meshif(soft_iface);
1149         unregister_netdevice_queue(soft_iface, head);
1150 }
1151
1152 /**
1153  * batadv_softif_is_valid() - Check whether device is a batadv soft interface
1154  * @net_dev: device which should be checked
1155  *
1156  * Return: true when net_dev is a batman-adv interface, false otherwise
1157  */
1158 bool batadv_softif_is_valid(const struct net_device *net_dev)
1159 {
1160         if (net_dev->netdev_ops->ndo_start_xmit == batadv_interface_tx)
1161                 return true;
1162
1163         return false;
1164 }
1165
1166 struct rtnl_link_ops batadv_link_ops __read_mostly = {
1167         .kind           = "batadv",
1168         .priv_size      = sizeof(struct batadv_priv),
1169         .setup          = batadv_softif_init_early,
1170         .dellink        = batadv_softif_destroy_netlink,
1171 };