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