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