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