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