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, 0x00,
 150                                                    0x00};
 151         unsigned int header_len = 0;
 152         int data_len = skb->len, ret;
 153         short vid __maybe_unused = -1;
 154         bool do_bcast = false;
 155         uint32_t seqno;
 156
 157         if (atomic_read(&bat_priv->mesh_state) != BATADV_MESH_ACTIVE)
 158                 goto dropped;
 159
 160         soft_iface->trans_start = jiffies;
 161
 162         switch (ntohs(ethhdr->h_proto)) {
 163         case ETH_P_8021Q:
 164                 vhdr = (struct vlan_ethhdr *)skb->data;
 165                 vid = ntohs(vhdr->h_vlan_TCI) & VLAN_VID_MASK;
 166
 167                 if (vhdr->h_vlan_encapsulated_proto != ethertype)
 168                         break;
 169
 170                 /* fall through */
 171         case BATADV_ETH_P_BATMAN:
 172                 goto dropped;
 173         }
 174
 175         if (batadv_bla_tx(bat_priv, skb, vid))
 176                 goto dropped;
 177
 178         /* Register the client MAC in the transtable */
 179         batadv_tt_local_add(soft_iface, ethhdr->h_source, skb->skb_iif);
 180
 181         /* don't accept stp packets. STP does not help in meshes.
 182          * better use the bridge loop avoidance ...
 183          */
 184         if (batadv_compare_eth(ethhdr->h_dest, stp_addr))
 185                 goto dropped;
 186
 187         if (is_multicast_ether_addr(ethhdr->h_dest)) {
 188                 do_bcast = true;
 189
 190                 switch (atomic_read(&bat_priv->gw_mode)) {
 191                 case BATADV_GW_MODE_SERVER:
 192                         /* gateway servers should not send dhcp
 193                          * requests into the mesh
 194                          */
 195                         ret = batadv_gw_is_dhcp_target(skb, &header_len);
 196                         if (ret)
 197                                 goto dropped;
 198                         break;
 199                 case BATADV_GW_MODE_CLIENT:
 200                         /* gateway clients should send dhcp requests
 201                          * via unicast to their gateway
 202                          */
 203                         ret = batadv_gw_is_dhcp_target(skb, &header_len);
 204                         if (ret)
 205                                 do_bcast = false;
 206                         break;
 207                 case BATADV_GW_MODE_OFF:
 208                 default:
 209                         break;
 210                 }
 211         }
 212
 213         /* ethernet packet should be broadcasted */
 214         if (do_bcast) {
 215                 primary_if = batadv_primary_if_get_selected(bat_priv);
 216                 if (!primary_if)
 217                         goto dropped;
 218
 219                 if (batadv_skb_head_push(skb, sizeof(*bcast_packet)) < 0)
 220                         goto dropped;
 221
 222                 bcast_packet = (struct batadv_bcast_packet *)skb->data;
 223                 bcast_packet->header.version = BATADV_COMPAT_VERSION;
 224                 bcast_packet->header.ttl = BATADV_TTL;
 225
 226                 /* batman packet type: broadcast */
 227                 bcast_packet->header.packet_type = BATADV_BCAST;
 228                 bcast_packet->reserved = 0;
 229
 230                 /* hw address of first interface is the orig mac because only
 231                  * this mac is known throughout the mesh
 232                  */
 233                 memcpy(bcast_packet->orig,
 234                        primary_if->net_dev->dev_addr, ETH_ALEN);
 235
 236                 /* set broadcast sequence number */
 237                 seqno = atomic_inc_return(&bat_priv->bcast_seqno);
 238                 bcast_packet->seqno = htonl(seqno);
 239
 240                 batadv_add_bcast_packet_to_list(bat_priv, skb, 1);
 241
 242                 /* a copy is stored in the bcast list, therefore removing
 243                  * the original skb.
 244                  */
 245                 kfree_skb(skb);
 246
 247         /* unicast packet */
 248         } else {
 249                 if (atomic_read(&bat_priv->gw_mode) != BATADV_GW_MODE_OFF) {
 250                         ret = batadv_gw_out_of_range(bat_priv, skb, ethhdr);
 251                         if (ret)
 252                                 goto dropped;
 253                 }
 254
 255                 ret = batadv_unicast_send_skb(skb, bat_priv);
 256                 if (ret != 0)
 257                         goto dropped_freed;
 258         }
 259
 260         batadv_inc_counter(bat_priv, BATADV_CNT_TX);
 261         batadv_add_counter(bat_priv, BATADV_CNT_TX_BYTES, data_len);
 262         goto end;
 263
 264 dropped:
 265         kfree_skb(skb);
 266 dropped_freed:
 267         batadv_inc_counter(bat_priv, BATADV_CNT_TX_DROPPED);
 268 end:
 269         if (primary_if)
 270                 batadv_hardif_free_ref(primary_if);
 271         return NETDEV_TX_OK;
 272 }
 273
 274 void batadv_interface_rx(struct net_device *soft_iface,
 275                          struct sk_buff *skb, struct batadv_hard_iface *recv_if,
 276                          int hdr_size, struct batadv_orig_node *orig_node)
 277 {
 278         struct batadv_priv *bat_priv = netdev_priv(soft_iface);
 279         struct ethhdr *ethhdr;
 280         struct vlan_ethhdr *vhdr;
 281         struct batadv_header *batadv_header = (struct batadv_header *)skb->data;
 282         short vid __maybe_unused = -1;
 283         __be16 ethertype = __constant_htons(BATADV_ETH_P_BATMAN);
 284         bool is_bcast;
 285
 286         is_bcast = (batadv_header->packet_type == BATADV_BCAST);
 287
 288         /* check if enough space is available for pulling, and pull */
 289         if (!pskb_may_pull(skb, hdr_size))
 290                 goto dropped;
 291
 292         skb_pull_rcsum(skb, hdr_size);
 293         skb_reset_mac_header(skb);
 294
 295         ethhdr = (struct ethhdr *)skb_mac_header(skb);
 296
 297         switch (ntohs(ethhdr->h_proto)) {
 298         case ETH_P_8021Q:
 299                 vhdr = (struct vlan_ethhdr *)skb->data;
 300                 vid = ntohs(vhdr->h_vlan_TCI) & VLAN_VID_MASK;
 301
 302                 if (vhdr->h_vlan_encapsulated_proto != ethertype)
 303                         break;
 304
 305                 /* fall through */
 306         case BATADV_ETH_P_BATMAN:
 307                 goto dropped;
 308         }
 309
 310         /* skb->dev & skb->pkt_type are set here */
 311         if (unlikely(!pskb_may_pull(skb, ETH_HLEN)))
 312                 goto dropped;
 313         skb->protocol = eth_type_trans(skb, soft_iface);
 314
 315         /* should not be necessary anymore as we use skb_pull_rcsum()
 316          * TODO: please verify this and remove this TODO
 317          * -- Dec 21st 2009, Simon Wunderlich
 318          */
 319
 320         /* skb->ip_summed = CHECKSUM_UNNECESSARY; */
 321
 322         batadv_inc_counter(bat_priv, BATADV_CNT_RX);
 323         batadv_add_counter(bat_priv, BATADV_CNT_RX_BYTES,
 324                            skb->len + ETH_HLEN);
 325
 326         soft_iface->last_rx = jiffies;
 327
 328         if (orig_node)
 329                 batadv_tt_add_temporary_global_entry(bat_priv, orig_node,
 330                                                      ethhdr->h_source);
 331
 332         if (batadv_is_ap_isolated(bat_priv, ethhdr->h_source, ethhdr->h_dest))
 333                 goto dropped;
 334
 335         /* Let the bridge loop avoidance check the packet. If will
 336          * not handle it, we can safely push it up.
 337          */
 338         if (batadv_bla_rx(bat_priv, skb, vid, is_bcast))
 339                 goto out;
 340
 341         netif_rx(skb);
 342         goto out;
 343
 344 dropped:
 345         kfree_skb(skb);
 346 out:
 347         return;
 348 }
 349
 350 static const struct net_device_ops batadv_netdev_ops = {
 351         .ndo_open = batadv_interface_open,
 352         .ndo_stop = batadv_interface_release,
 353         .ndo_get_stats = batadv_interface_stats,
 354         .ndo_set_mac_address = batadv_interface_set_mac_addr,
 355         .ndo_change_mtu = batadv_interface_change_mtu,
 356         .ndo_start_xmit = batadv_interface_tx,
 357         .ndo_validate_addr = eth_validate_addr
 358 };
 359
 360 static void batadv_interface_setup(struct net_device *dev)
 361 {
 362         struct batadv_priv *priv = netdev_priv(dev);
 363
 364         ether_setup(dev);
 365
 366         dev->netdev_ops = &batadv_netdev_ops;
 367         dev->destructor = free_netdev;
 368         dev->tx_queue_len = 0;
 369
 370         /* can't call min_mtu, because the needed variables
 371          * have not been initialized yet
 372          */
 373         dev->mtu = ETH_DATA_LEN;
 374         /* reserve more space in the skbuff for our header */
 375         dev->hard_header_len = BATADV_HEADER_LEN;
 376
 377         /* generate random address */
 378         eth_hw_addr_random(dev);
 379
 380         SET_ETHTOOL_OPS(dev, &batadv_ethtool_ops);
 381
 382         memset(priv, 0, sizeof(*priv));
 383 }
 384
 385 struct net_device *batadv_softif_create(const char *name)
 386 {
 387         struct net_device *soft_iface;
 388         struct batadv_priv *bat_priv;
 389         int ret;
 390         size_t cnt_len = sizeof(uint64_t) * BATADV_CNT_NUM;
 391
 392         soft_iface = alloc_netdev(sizeof(*bat_priv), name,
 393                                   batadv_interface_setup);
 394
 395         if (!soft_iface)
 396                 goto out;
 397
 398         bat_priv = netdev_priv(soft_iface);
 399
 400         /* batadv_interface_stats() needs to be available as soon as
 401          * register_netdevice() has been called
 402          */
 403         bat_priv->bat_counters = __alloc_percpu(cnt_len, __alignof__(uint64_t));
 404         if (!bat_priv->bat_counters)
 405                 goto free_soft_iface;
 406
 407         ret = register_netdevice(soft_iface);
 408         if (ret < 0) {
 409                 pr_err("Unable to register the batman interface '%s': %i\n",
 410                        name, ret);
 411                 goto free_bat_counters;
 412         }
 413
 414         atomic_set(&bat_priv->aggregated_ogms, 1);
 415         atomic_set(&bat_priv->bonding, 0);
 416         atomic_set(&bat_priv->bridge_loop_avoidance, 0);
 417         atomic_set(&bat_priv->ap_isolation, 0);
 418         atomic_set(&bat_priv->vis_mode, BATADV_VIS_TYPE_CLIENT_UPDATE);
 419         atomic_set(&bat_priv->gw_mode, BATADV_GW_MODE_OFF);
 420         atomic_set(&bat_priv->gw_sel_class, 20);
 421         atomic_set(&bat_priv->gw_bandwidth, 41);
 422         atomic_set(&bat_priv->orig_interval, 1000);
 423         atomic_set(&bat_priv->hop_penalty, 30);
 424         atomic_set(&bat_priv->log_level, 0);
 425         atomic_set(&bat_priv->fragmentation, 1);
 426         atomic_set(&bat_priv->bcast_queue_left, BATADV_BCAST_QUEUE_LEN);
 427         atomic_set(&bat_priv->batman_queue_left, BATADV_BATMAN_QUEUE_LEN);
 428
 429         atomic_set(&bat_priv->mesh_state, BATADV_MESH_INACTIVE);
 430         atomic_set(&bat_priv->bcast_seqno, 1);
 431         atomic_set(&bat_priv->tt.vn, 0);
 432         atomic_set(&bat_priv->tt.local_changes, 0);
 433         atomic_set(&bat_priv->tt.ogm_append_cnt, 0);
 434 #ifdef CONFIG_BATMAN_ADV_BLA
 435         atomic_set(&bat_priv->bla.num_requests, 0);
 436 #endif
 437         bat_priv->tt.last_changeset = NULL;
 438         bat_priv->tt.last_changeset_len = 0;
 439         bat_priv->tt.poss_change = false;
 440
 441         bat_priv->primary_if = NULL;
 442         bat_priv->num_ifaces = 0;
 443
 444         ret = batadv_algo_select(bat_priv, batadv_routing_algo);
 445         if (ret < 0)
 446                 goto unreg_soft_iface;
 447
 448         ret = batadv_sysfs_add_meshif(soft_iface);
 449         if (ret < 0)
 450                 goto unreg_soft_iface;
 451
 452         ret = batadv_debugfs_add_meshif(soft_iface);
 453         if (ret < 0)
 454                 goto unreg_sysfs;
 455
 456         ret = batadv_mesh_init(soft_iface);
 457         if (ret < 0)
 458                 goto unreg_debugfs;
 459
 460         return soft_iface;
 461
 462 unreg_debugfs:
 463         batadv_debugfs_del_meshif(soft_iface);
 464 unreg_sysfs:
 465         batadv_sysfs_del_meshif(soft_iface);
 466 unreg_soft_iface:
 467         free_percpu(bat_priv->bat_counters);
 468         unregister_netdevice(soft_iface);
 469         return NULL;
 470
 471 free_bat_counters:
 472         free_percpu(bat_priv->bat_counters);
 473 free_soft_iface:
 474         free_netdev(soft_iface);
 475 out:
 476         return NULL;
 477 }
 478
 479 void batadv_softif_destroy(struct net_device *soft_iface)
 480 {
 481         batadv_debugfs_del_meshif(soft_iface);
 482         batadv_sysfs_del_meshif(soft_iface);
 483         batadv_mesh_free(soft_iface);
 484         unregister_netdevice(soft_iface);
 485 }
 486
 487 int batadv_softif_is_valid(const struct net_device *net_dev)
 488 {
 489         if (net_dev->netdev_ops->ndo_start_xmit == batadv_interface_tx)
 490                 return 1;
 491
 492         return 0;
 493 }
 494
 495 /* ethtool */
 496 static int batadv_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
 497 {
 498         cmd->supported = 0;
 499         cmd->advertising = 0;
 500         ethtool_cmd_speed_set(cmd, SPEED_10);
 501         cmd->duplex = DUPLEX_FULL;
 502         cmd->port = PORT_TP;
 503         cmd->phy_address = 0;
 504         cmd->transceiver = XCVR_INTERNAL;
 505         cmd->autoneg = AUTONEG_DISABLE;
 506         cmd->maxtxpkt = 0;
 507         cmd->maxrxpkt = 0;
 508
 509         return 0;
 510 }
 511
 512 static void batadv_get_drvinfo(struct net_device *dev,
 513                                struct ethtool_drvinfo *info)
 514 {
 515         strcpy(info->driver, "B.A.T.M.A.N. advanced");
 516         strcpy(info->version, BATADV_SOURCE_VERSION);
 517         strcpy(info->fw_version, "N/A");
 518         strcpy(info->bus_info, "batman");
 519 }
 520
 521 static u32 batadv_get_msglevel(struct net_device *dev)
 522 {
 523         return -EOPNOTSUPP;
 524 }
 525
 526 static void batadv_set_msglevel(struct net_device *dev, u32 value)
 527 {
 528 }
 529
 530 static u32 batadv_get_link(struct net_device *dev)
 531 {
 532         return 1;
 533 }
 534
 535 /* Inspired by drivers/net/ethernet/dlink/sundance.c:1702
 536  * Declare each description string in struct.name[] to get fixed sized buffer
 537  * and compile time checking for strings longer than ETH_GSTRING_LEN.
 538  */
 539 static const struct {
 540         const char name[ETH_GSTRING_LEN];
 541 } batadv_counters_strings[] = {
 542         { "tx" },
 543         { "tx_bytes" },
 544         { "tx_dropped" },
 545         { "rx" },
 546         { "rx_bytes" },
 547         { "forward" },
 548         { "forward_bytes" },
 549         { "mgmt_tx" },
 550         { "mgmt_tx_bytes" },
 551         { "mgmt_rx" },
 552         { "mgmt_rx_bytes" },
 553         { "tt_request_tx" },
 554         { "tt_request_rx" },
 555         { "tt_response_tx" },
 556         { "tt_response_rx" },
 557         { "tt_roam_adv_tx" },
 558         { "tt_roam_adv_rx" },
 559 };
 560
 561 static void batadv_get_strings(struct net_device *dev, uint32_t stringset,
 562                                uint8_t *data)
 563 {
 564         if (stringset == ETH_SS_STATS)
 565                 memcpy(data, batadv_counters_strings,
 566                        sizeof(batadv_counters_strings));
 567 }
 568
 569 static void batadv_get_ethtool_stats(struct net_device *dev,
 570                                      struct ethtool_stats *stats,
 571                                      uint64_t *data)
 572 {
 573         struct batadv_priv *bat_priv = netdev_priv(dev);
 574         int i;
 575
 576         for (i = 0; i < BATADV_CNT_NUM; i++)
 577                 data[i] = batadv_sum_counter(bat_priv, i);
 578 }
 579
 580 static int batadv_get_sset_count(struct net_device *dev, int stringset)
 581 {
 582         if (stringset == ETH_SS_STATS)
 583                 return BATADV_CNT_NUM;
 584
 585         return -EOPNOTSUPP;
 586 }