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