Merge tag 'batman-adv-for-davem' of git://git.open-mesh.org/linux-merge
[firefly-linux-kernel-4.4.55.git] / net / batman-adv / soft-interface.c
1 /* Copyright (C) 2007-2012 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, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17  * 02110-1301, USA
18  */
19
20 #include "main.h"
21 #include "soft-interface.h"
22 #include "hard-interface.h"
23 #include "routing.h"
24 #include "send.h"
25 #include "debugfs.h"
26 #include "translation-table.h"
27 #include "hash.h"
28 #include "gateway_common.h"
29 #include "gateway_client.h"
30 #include "sysfs.h"
31 #include "originator.h"
32 #include <linux/slab.h>
33 #include <linux/ethtool.h>
34 #include <linux/etherdevice.h>
35 #include <linux/if_vlan.h>
36 #include "unicast.h"
37 #include "bridge_loop_avoidance.h"
38
39
40 static int batadv_get_settings(struct net_device *dev, struct ethtool_cmd *cmd);
41 static void batadv_get_drvinfo(struct net_device *dev,
42                                struct ethtool_drvinfo *info);
43 static u32 batadv_get_msglevel(struct net_device *dev);
44 static void batadv_set_msglevel(struct net_device *dev, u32 value);
45 static u32 batadv_get_link(struct net_device *dev);
46 static void batadv_get_strings(struct net_device *dev, u32 stringset, u8 *data);
47 static void batadv_get_ethtool_stats(struct net_device *dev,
48                                      struct ethtool_stats *stats, u64 *data);
49 static int batadv_get_sset_count(struct net_device *dev, int stringset);
50
51 static const struct ethtool_ops batadv_ethtool_ops = {
52         .get_settings = batadv_get_settings,
53         .get_drvinfo = batadv_get_drvinfo,
54         .get_msglevel = batadv_get_msglevel,
55         .set_msglevel = batadv_set_msglevel,
56         .get_link = batadv_get_link,
57         .get_strings = batadv_get_strings,
58         .get_ethtool_stats = batadv_get_ethtool_stats,
59         .get_sset_count = batadv_get_sset_count,
60 };
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 to
68          * 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 static struct net_device_stats *batadv_interface_stats(struct net_device *dev)
94 {
95         struct batadv_priv *bat_priv = netdev_priv(dev);
96         struct net_device_stats *stats = &bat_priv->stats;
97
98         stats->tx_packets = batadv_sum_counter(bat_priv, BATADV_CNT_TX);
99         stats->tx_bytes = batadv_sum_counter(bat_priv, BATADV_CNT_TX_BYTES);
100         stats->tx_dropped = batadv_sum_counter(bat_priv, BATADV_CNT_TX_DROPPED);
101         stats->rx_packets = batadv_sum_counter(bat_priv, BATADV_CNT_RX);
102         stats->rx_bytes = batadv_sum_counter(bat_priv, BATADV_CNT_RX_BYTES);
103         return stats;
104 }
105
106 static int batadv_interface_set_mac_addr(struct net_device *dev, void *p)
107 {
108         struct batadv_priv *bat_priv = netdev_priv(dev);
109         struct sockaddr *addr = p;
110         uint8_t old_addr[ETH_ALEN];
111
112         if (!is_valid_ether_addr(addr->sa_data))
113                 return -EADDRNOTAVAIL;
114
115         memcpy(old_addr, dev->dev_addr, ETH_ALEN);
116         memcpy(dev->dev_addr, addr->sa_data, ETH_ALEN);
117
118         /* only modify transtable if it has been initialized before */
119         if (atomic_read(&bat_priv->mesh_state) == BATADV_MESH_ACTIVE) {
120                 batadv_tt_local_remove(bat_priv, old_addr,
121                                        "mac address changed", false);
122                 batadv_tt_local_add(dev, addr->sa_data, BATADV_NULL_IFINDEX);
123         }
124
125         dev->addr_assign_type &= ~NET_ADDR_RANDOM;
126         return 0;
127 }
128
129 static int batadv_interface_change_mtu(struct net_device *dev, int new_mtu)
130 {
131         /* check ranges */
132         if ((new_mtu < 68) || (new_mtu > batadv_hardif_min_mtu(dev)))
133                 return -EINVAL;
134
135         dev->mtu = new_mtu;
136
137         return 0;
138 }
139
140 static int batadv_interface_tx(struct sk_buff *skb,
141                                struct net_device *soft_iface)
142 {
143         struct ethhdr *ethhdr = (struct ethhdr *)skb->data;
144         struct batadv_priv *bat_priv = netdev_priv(soft_iface);
145         struct batadv_hard_iface *primary_if = NULL;
146         struct batadv_bcast_packet *bcast_packet;
147         struct vlan_ethhdr *vhdr;
148         __be16 ethertype = __constant_htons(BATADV_ETH_P_BATMAN);
149         static const uint8_t stp_addr[ETH_ALEN] = {0x01, 0x80, 0xC2, 0x00,
150                                                    0x00, 0x00};
151         static const uint8_t ectp_addr[ETH_ALEN] = {0xCF, 0x00, 0x00, 0x00,
152                                                     0x00, 0x00};
153         unsigned int header_len = 0;
154         int data_len = skb->len, ret;
155         short vid __maybe_unused = -1;
156         bool do_bcast = false;
157         uint32_t seqno;
158
159         if (atomic_read(&bat_priv->mesh_state) != BATADV_MESH_ACTIVE)
160                 goto dropped;
161
162         soft_iface->trans_start = jiffies;
163
164         switch (ntohs(ethhdr->h_proto)) {
165         case ETH_P_8021Q:
166                 vhdr = (struct vlan_ethhdr *)skb->data;
167                 vid = ntohs(vhdr->h_vlan_TCI) & VLAN_VID_MASK;
168
169                 if (vhdr->h_vlan_encapsulated_proto != ethertype)
170                         break;
171
172                 /* fall through */
173         case BATADV_ETH_P_BATMAN:
174                 goto dropped;
175         }
176
177         if (batadv_bla_tx(bat_priv, skb, vid))
178                 goto dropped;
179
180         /* Register the client MAC in the transtable */
181         batadv_tt_local_add(soft_iface, ethhdr->h_source, skb->skb_iif);
182
183         /* don't accept stp packets. STP does not help in meshes.
184          * better use the bridge loop avoidance ...
185          *
186          * The same goes for ECTP sent at least by some Cisco Switches,
187          * it might confuse the mesh when used with bridge loop avoidance.
188          */
189         if (batadv_compare_eth(ethhdr->h_dest, stp_addr))
190                 goto dropped;
191
192         if (batadv_compare_eth(ethhdr->h_dest, ectp_addr))
193                 goto dropped;
194
195         if (is_multicast_ether_addr(ethhdr->h_dest)) {
196                 do_bcast = true;
197
198                 switch (atomic_read(&bat_priv->gw_mode)) {
199                 case BATADV_GW_MODE_SERVER:
200                         /* gateway servers should not send dhcp
201                          * requests into the mesh
202                          */
203                         ret = batadv_gw_is_dhcp_target(skb, &header_len);
204                         if (ret)
205                                 goto dropped;
206                         break;
207                 case BATADV_GW_MODE_CLIENT:
208                         /* gateway clients should send dhcp requests
209                          * via unicast to their gateway
210                          */
211                         ret = batadv_gw_is_dhcp_target(skb, &header_len);
212                         if (ret)
213                                 do_bcast = false;
214                         break;
215                 case BATADV_GW_MODE_OFF:
216                 default:
217                         break;
218                 }
219         }
220
221         /* ethernet packet should be broadcasted */
222         if (do_bcast) {
223                 primary_if = batadv_primary_if_get_selected(bat_priv);
224                 if (!primary_if)
225                         goto dropped;
226
227                 if (batadv_skb_head_push(skb, sizeof(*bcast_packet)) < 0)
228                         goto dropped;
229
230                 bcast_packet = (struct batadv_bcast_packet *)skb->data;
231                 bcast_packet->header.version = BATADV_COMPAT_VERSION;
232                 bcast_packet->header.ttl = BATADV_TTL;
233
234                 /* batman packet type: broadcast */
235                 bcast_packet->header.packet_type = BATADV_BCAST;
236                 bcast_packet->reserved = 0;
237
238                 /* hw address of first interface is the orig mac because only
239                  * this mac is known throughout the mesh
240                  */
241                 memcpy(bcast_packet->orig,
242                        primary_if->net_dev->dev_addr, ETH_ALEN);
243
244                 /* set broadcast sequence number */
245                 seqno = atomic_inc_return(&bat_priv->bcast_seqno);
246                 bcast_packet->seqno = htonl(seqno);
247
248                 batadv_add_bcast_packet_to_list(bat_priv, skb, 1);
249
250                 /* a copy is stored in the bcast list, therefore removing
251                  * the original skb.
252                  */
253                 kfree_skb(skb);
254
255         /* unicast packet */
256         } else {
257                 if (atomic_read(&bat_priv->gw_mode) != BATADV_GW_MODE_OFF) {
258                         ret = batadv_gw_out_of_range(bat_priv, skb, ethhdr);
259                         if (ret)
260                                 goto dropped;
261                 }
262
263                 ret = batadv_unicast_send_skb(skb, bat_priv);
264                 if (ret != 0)
265                         goto dropped_freed;
266         }
267
268         batadv_inc_counter(bat_priv, BATADV_CNT_TX);
269         batadv_add_counter(bat_priv, BATADV_CNT_TX_BYTES, data_len);
270         goto end;
271
272 dropped:
273         kfree_skb(skb);
274 dropped_freed:
275         batadv_inc_counter(bat_priv, BATADV_CNT_TX_DROPPED);
276 end:
277         if (primary_if)
278                 batadv_hardif_free_ref(primary_if);
279         return NETDEV_TX_OK;
280 }
281
282 void batadv_interface_rx(struct net_device *soft_iface,
283                          struct sk_buff *skb, struct batadv_hard_iface *recv_if,
284                          int hdr_size, struct batadv_orig_node *orig_node)
285 {
286         struct batadv_priv *bat_priv = netdev_priv(soft_iface);
287         struct ethhdr *ethhdr;
288         struct vlan_ethhdr *vhdr;
289         struct batadv_header *batadv_header = (struct batadv_header *)skb->data;
290         short vid __maybe_unused = -1;
291         __be16 ethertype = __constant_htons(BATADV_ETH_P_BATMAN);
292         bool is_bcast;
293
294         is_bcast = (batadv_header->packet_type == BATADV_BCAST);
295
296         /* check if enough space is available for pulling, and pull */
297         if (!pskb_may_pull(skb, hdr_size))
298                 goto dropped;
299
300         skb_pull_rcsum(skb, hdr_size);
301         skb_reset_mac_header(skb);
302
303         ethhdr = (struct ethhdr *)skb_mac_header(skb);
304
305         switch (ntohs(ethhdr->h_proto)) {
306         case ETH_P_8021Q:
307                 vhdr = (struct vlan_ethhdr *)skb->data;
308                 vid = ntohs(vhdr->h_vlan_TCI) & VLAN_VID_MASK;
309
310                 if (vhdr->h_vlan_encapsulated_proto != ethertype)
311                         break;
312
313                 /* fall through */
314         case BATADV_ETH_P_BATMAN:
315                 goto dropped;
316         }
317
318         /* skb->dev & skb->pkt_type are set here */
319         if (unlikely(!pskb_may_pull(skb, ETH_HLEN)))
320                 goto dropped;
321         skb->protocol = eth_type_trans(skb, soft_iface);
322
323         /* should not be necessary anymore as we use skb_pull_rcsum()
324          * TODO: please verify this and remove this TODO
325          * -- Dec 21st 2009, Simon Wunderlich
326          */
327
328         /* skb->ip_summed = CHECKSUM_UNNECESSARY; */
329
330         batadv_inc_counter(bat_priv, BATADV_CNT_RX);
331         batadv_add_counter(bat_priv, BATADV_CNT_RX_BYTES,
332                            skb->len + ETH_HLEN);
333
334         soft_iface->last_rx = jiffies;
335
336         if (orig_node)
337                 batadv_tt_add_temporary_global_entry(bat_priv, orig_node,
338                                                      ethhdr->h_source);
339
340         if (batadv_is_ap_isolated(bat_priv, ethhdr->h_source, ethhdr->h_dest))
341                 goto dropped;
342
343         /* Let the bridge loop avoidance check the packet. If will
344          * not handle it, we can safely push it up.
345          */
346         if (batadv_bla_rx(bat_priv, skb, vid, is_bcast))
347                 goto out;
348
349         netif_rx(skb);
350         goto out;
351
352 dropped:
353         kfree_skb(skb);
354 out:
355         return;
356 }
357
358 /* batman-adv network devices have devices nesting below it and are a special
359  * "super class" of normal network devices; split their locks off into a
360  * separate class since they always nest.
361  */
362 static struct lock_class_key batadv_netdev_xmit_lock_key;
363 static struct lock_class_key batadv_netdev_addr_lock_key;
364
365 /**
366  * batadv_set_lockdep_class_one - Set lockdep class for a single tx queue
367  * @dev: device which owns the tx queue
368  * @txq: tx queue to modify
369  * @_unused: always NULL
370  */
371 static void batadv_set_lockdep_class_one(struct net_device *dev,
372                                          struct netdev_queue *txq,
373                                          void *_unused)
374 {
375         lockdep_set_class(&txq->_xmit_lock, &batadv_netdev_xmit_lock_key);
376 }
377
378 /**
379  * batadv_set_lockdep_class - Set txq and addr_list lockdep class
380  * @dev: network device to modify
381  */
382 static void batadv_set_lockdep_class(struct net_device *dev)
383 {
384         lockdep_set_class(&dev->addr_list_lock, &batadv_netdev_addr_lock_key);
385         netdev_for_each_tx_queue(dev, batadv_set_lockdep_class_one, NULL);
386 }
387
388 /**
389  * batadv_softif_init - Late stage initialization of soft interface
390  * @dev: registered network device to modify
391  *
392  * Returns error code on failures
393  */
394 static int batadv_softif_init(struct net_device *dev)
395 {
396         batadv_set_lockdep_class(dev);
397
398         return 0;
399 }
400
401 static const struct net_device_ops batadv_netdev_ops = {
402         .ndo_init = batadv_softif_init,
403         .ndo_open = batadv_interface_open,
404         .ndo_stop = batadv_interface_release,
405         .ndo_get_stats = batadv_interface_stats,
406         .ndo_set_mac_address = batadv_interface_set_mac_addr,
407         .ndo_change_mtu = batadv_interface_change_mtu,
408         .ndo_start_xmit = batadv_interface_tx,
409         .ndo_validate_addr = eth_validate_addr
410 };
411
412 static void batadv_interface_setup(struct net_device *dev)
413 {
414         struct batadv_priv *priv = netdev_priv(dev);
415
416         ether_setup(dev);
417
418         dev->netdev_ops = &batadv_netdev_ops;
419         dev->destructor = free_netdev;
420         dev->tx_queue_len = 0;
421
422         /* can't call min_mtu, because the needed variables
423          * have not been initialized yet
424          */
425         dev->mtu = ETH_DATA_LEN;
426         /* reserve more space in the skbuff for our header */
427         dev->hard_header_len = BATADV_HEADER_LEN;
428
429         /* generate random address */
430         eth_hw_addr_random(dev);
431
432         SET_ETHTOOL_OPS(dev, &batadv_ethtool_ops);
433
434         memset(priv, 0, sizeof(*priv));
435 }
436
437 struct net_device *batadv_softif_create(const char *name)
438 {
439         struct net_device *soft_iface;
440         struct batadv_priv *bat_priv;
441         int ret;
442         size_t cnt_len = sizeof(uint64_t) * BATADV_CNT_NUM;
443
444         soft_iface = alloc_netdev(sizeof(*bat_priv), name,
445                                   batadv_interface_setup);
446
447         if (!soft_iface)
448                 goto out;
449
450         bat_priv = netdev_priv(soft_iface);
451
452         /* batadv_interface_stats() needs to be available as soon as
453          * register_netdevice() has been called
454          */
455         bat_priv->bat_counters = __alloc_percpu(cnt_len, __alignof__(uint64_t));
456         if (!bat_priv->bat_counters)
457                 goto free_soft_iface;
458
459         ret = register_netdevice(soft_iface);
460         if (ret < 0) {
461                 pr_err("Unable to register the batman interface '%s': %i\n",
462                        name, ret);
463                 goto free_bat_counters;
464         }
465
466         atomic_set(&bat_priv->aggregated_ogms, 1);
467         atomic_set(&bat_priv->bonding, 0);
468         atomic_set(&bat_priv->bridge_loop_avoidance, 0);
469         atomic_set(&bat_priv->ap_isolation, 0);
470         atomic_set(&bat_priv->vis_mode, BATADV_VIS_TYPE_CLIENT_UPDATE);
471         atomic_set(&bat_priv->gw_mode, BATADV_GW_MODE_OFF);
472         atomic_set(&bat_priv->gw_sel_class, 20);
473         atomic_set(&bat_priv->gw_bandwidth, 41);
474         atomic_set(&bat_priv->orig_interval, 1000);
475         atomic_set(&bat_priv->hop_penalty, 30);
476         atomic_set(&bat_priv->log_level, 0);
477         atomic_set(&bat_priv->fragmentation, 1);
478         atomic_set(&bat_priv->bcast_queue_left, BATADV_BCAST_QUEUE_LEN);
479         atomic_set(&bat_priv->batman_queue_left, BATADV_BATMAN_QUEUE_LEN);
480
481         atomic_set(&bat_priv->mesh_state, BATADV_MESH_INACTIVE);
482         atomic_set(&bat_priv->bcast_seqno, 1);
483         atomic_set(&bat_priv->tt.vn, 0);
484         atomic_set(&bat_priv->tt.local_changes, 0);
485         atomic_set(&bat_priv->tt.ogm_append_cnt, 0);
486 #ifdef CONFIG_BATMAN_ADV_BLA
487         atomic_set(&bat_priv->bla.num_requests, 0);
488 #endif
489         bat_priv->tt.last_changeset = NULL;
490         bat_priv->tt.last_changeset_len = 0;
491         bat_priv->tt.poss_change = false;
492
493         bat_priv->primary_if = NULL;
494         bat_priv->num_ifaces = 0;
495
496         ret = batadv_algo_select(bat_priv, batadv_routing_algo);
497         if (ret < 0)
498                 goto unreg_soft_iface;
499
500         ret = batadv_sysfs_add_meshif(soft_iface);
501         if (ret < 0)
502                 goto unreg_soft_iface;
503
504         ret = batadv_debugfs_add_meshif(soft_iface);
505         if (ret < 0)
506                 goto unreg_sysfs;
507
508         ret = batadv_mesh_init(soft_iface);
509         if (ret < 0)
510                 goto unreg_debugfs;
511
512         return soft_iface;
513
514 unreg_debugfs:
515         batadv_debugfs_del_meshif(soft_iface);
516 unreg_sysfs:
517         batadv_sysfs_del_meshif(soft_iface);
518 unreg_soft_iface:
519         free_percpu(bat_priv->bat_counters);
520         unregister_netdevice(soft_iface);
521         return NULL;
522
523 free_bat_counters:
524         free_percpu(bat_priv->bat_counters);
525 free_soft_iface:
526         free_netdev(soft_iface);
527 out:
528         return NULL;
529 }
530
531 void batadv_softif_destroy(struct net_device *soft_iface)
532 {
533         batadv_debugfs_del_meshif(soft_iface);
534         batadv_sysfs_del_meshif(soft_iface);
535         batadv_mesh_free(soft_iface);
536         unregister_netdevice(soft_iface);
537 }
538
539 int batadv_softif_is_valid(const struct net_device *net_dev)
540 {
541         if (net_dev->netdev_ops->ndo_start_xmit == batadv_interface_tx)
542                 return 1;
543
544         return 0;
545 }
546
547 /* ethtool */
548 static int batadv_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
549 {
550         cmd->supported = 0;
551         cmd->advertising = 0;
552         ethtool_cmd_speed_set(cmd, SPEED_10);
553         cmd->duplex = DUPLEX_FULL;
554         cmd->port = PORT_TP;
555         cmd->phy_address = 0;
556         cmd->transceiver = XCVR_INTERNAL;
557         cmd->autoneg = AUTONEG_DISABLE;
558         cmd->maxtxpkt = 0;
559         cmd->maxrxpkt = 0;
560
561         return 0;
562 }
563
564 static void batadv_get_drvinfo(struct net_device *dev,
565                                struct ethtool_drvinfo *info)
566 {
567         strcpy(info->driver, "B.A.T.M.A.N. advanced");
568         strcpy(info->version, BATADV_SOURCE_VERSION);
569         strcpy(info->fw_version, "N/A");
570         strcpy(info->bus_info, "batman");
571 }
572
573 static u32 batadv_get_msglevel(struct net_device *dev)
574 {
575         return -EOPNOTSUPP;
576 }
577
578 static void batadv_set_msglevel(struct net_device *dev, u32 value)
579 {
580 }
581
582 static u32 batadv_get_link(struct net_device *dev)
583 {
584         return 1;
585 }
586
587 /* Inspired by drivers/net/ethernet/dlink/sundance.c:1702
588  * Declare each description string in struct.name[] to get fixed sized buffer
589  * and compile time checking for strings longer than ETH_GSTRING_LEN.
590  */
591 static const struct {
592         const char name[ETH_GSTRING_LEN];
593 } batadv_counters_strings[] = {
594         { "tx" },
595         { "tx_bytes" },
596         { "tx_dropped" },
597         { "rx" },
598         { "rx_bytes" },
599         { "forward" },
600         { "forward_bytes" },
601         { "mgmt_tx" },
602         { "mgmt_tx_bytes" },
603         { "mgmt_rx" },
604         { "mgmt_rx_bytes" },
605         { "tt_request_tx" },
606         { "tt_request_rx" },
607         { "tt_response_tx" },
608         { "tt_response_rx" },
609         { "tt_roam_adv_tx" },
610         { "tt_roam_adv_rx" },
611 };
612
613 static void batadv_get_strings(struct net_device *dev, uint32_t stringset,
614                                uint8_t *data)
615 {
616         if (stringset == ETH_SS_STATS)
617                 memcpy(data, batadv_counters_strings,
618                        sizeof(batadv_counters_strings));
619 }
620
621 static void batadv_get_ethtool_stats(struct net_device *dev,
622                                      struct ethtool_stats *stats,
623                                      uint64_t *data)
624 {
625         struct batadv_priv *bat_priv = netdev_priv(dev);
626         int i;
627
628         for (i = 0; i < BATADV_CNT_NUM; i++)
629                 data[i] = batadv_sum_counter(bat_priv, i);
630 }
631
632 static int batadv_get_sset_count(struct net_device *dev, int stringset)
633 {
634         if (stringset == ETH_SS_STATS)
635                 return BATADV_CNT_NUM;
636
637         return -EOPNOTSUPP;
638 }