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