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         static const u8 stp_addr[ETH_ALEN] = {0x01, 0x80, 0xC2, 0x00,
 190                                               0x00, 0x00};
 191         static const u8 ectp_addr[ETH_ALEN] = {0xCF, 0x00, 0x00, 0x00,
 192                                                0x00, 0x00};
 193         enum batadv_dhcp_recipient dhcp_rcp = BATADV_DHCP_NO;
 194         u8 *dst_hint = NULL, chaddr[ETH_ALEN];
 195         struct vlan_ethhdr *vhdr;
 196         unsigned int header_len = 0;
 197         int data_len = skb->len, ret;
 198         unsigned long brd_delay = 1;
 199         bool do_bcast = false, client_added;
 200         unsigned short vid;
 201         u32 seqno;
 202         int gw_mode;
 203         enum batadv_forw_mode forw_mode;
 204         struct batadv_orig_node *mcast_single_orig = NULL;
 205         int network_offset = ETH_HLEN;
 206
 207         if (atomic_read(&bat_priv->mesh_state) != BATADV_MESH_ACTIVE)
 208                 goto dropped;
 209
 210         netif_trans_update(soft_iface);
 211         vid = batadv_get_vid(skb, 0);
 212         ethhdr = eth_hdr(skb);
 213
 214         switch (ntohs(ethhdr->h_proto)) {
 215         case ETH_P_8021Q:
 216                 vhdr = vlan_eth_hdr(skb);
 217
 218                 /* drop batman-in-batman packets to prevent loops */
 219                 if (vhdr->h_vlan_encapsulated_proto != htons(ETH_P_BATMAN)) {
 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 /**
 385  * batadv_interface_rx - receive ethernet frame on local batman-adv interface
 386  * @soft_iface: local interface which will receive the ethernet frame
 387  * @skb: ethernet frame for @soft_iface
 388  * @hdr_size: size of already parsed batman-adv header
 389  * @orig_node: originator from which the batman-adv packet was sent
 390  *
 391  * Sends a ethernet frame to the receive path of the local @soft_iface.
 392  * skb->data has still point to the batman-adv header with the size @hdr_size.
 393  * The caller has to have parsed this header already and made sure that at least
 394  * @hdr_size bytes are still available for pull in @skb.
 395  *
 396  * The packet may still get dropped. This can happen when the encapsulated
 397  * ethernet frame is invalid or contains again an batman-adv packet. Also
 398  * unicast packets will be dropped directly when it was sent between two
 399  * isolated clients.
 400  */
 401 void batadv_interface_rx(struct net_device *soft_iface,
 402                          struct sk_buff *skb, int hdr_size,
 403                          struct batadv_orig_node *orig_node)
 404 {
 405         struct batadv_bcast_packet *batadv_bcast_packet;
 406         struct batadv_priv *bat_priv = netdev_priv(soft_iface);
 407         struct vlan_ethhdr *vhdr;
 408         struct ethhdr *ethhdr;
 409         unsigned short vid;
 410         bool is_bcast;
 411
 412         batadv_bcast_packet = (struct batadv_bcast_packet *)skb->data;
 413         is_bcast = (batadv_bcast_packet->packet_type == BATADV_BCAST);
 414
 415         skb_pull_rcsum(skb, hdr_size);
 416         skb_reset_mac_header(skb);
 417
 418         /* clean the netfilter state now that the batman-adv header has been
 419          * removed
 420          */
 421         nf_reset(skb);
 422
 423         if (unlikely(!pskb_may_pull(skb, ETH_HLEN)))
 424                 goto dropped;
 425
 426         vid = batadv_get_vid(skb, 0);
 427         ethhdr = eth_hdr(skb);
 428
 429         switch (ntohs(ethhdr->h_proto)) {
 430         case ETH_P_8021Q:
 431                 if (!pskb_may_pull(skb, VLAN_ETH_HLEN))
 432                         goto dropped;
 433
 434                 vhdr = (struct vlan_ethhdr *)skb->data;
 435
 436                 /* drop batman-in-batman packets to prevent loops */
 437                 if (vhdr->h_vlan_encapsulated_proto != htons(ETH_P_BATMAN))
 438                         break;
 439
 440                 /* fall through */
 441         case ETH_P_BATMAN:
 442                 goto dropped;
 443         }
 444
 445         /* skb->dev & skb->pkt_type are set here */
 446         skb->protocol = eth_type_trans(skb, soft_iface);
 447
 448         /* should not be necessary anymore as we use skb_pull_rcsum()
 449          * TODO: please verify this and remove this TODO
 450          * -- Dec 21st 2009, Simon Wunderlich
 451          */
 452
 453         /* skb->ip_summed = CHECKSUM_UNNECESSARY; */
 454
 455         batadv_inc_counter(bat_priv, BATADV_CNT_RX);
 456         batadv_add_counter(bat_priv, BATADV_CNT_RX_BYTES,
 457                            skb->len + ETH_HLEN);
 458
 459         soft_iface->last_rx = jiffies;
 460
 461         /* Let the bridge loop avoidance check the packet. If will
 462          * not handle it, we can safely push it up.
 463          */
 464         if (batadv_bla_rx(bat_priv, skb, vid, is_bcast))
 465                 goto out;
 466
 467         if (orig_node)
 468                 batadv_tt_add_temporary_global_entry(bat_priv, orig_node,
 469                                                      ethhdr->h_source, vid);
 470
 471         if (is_multicast_ether_addr(ethhdr->h_dest)) {
 472                 /* set the mark on broadcast packets if AP isolation is ON and
 473                  * the packet is coming from an "isolated" client
 474                  */
 475                 if (batadv_vlan_ap_isola_get(bat_priv, vid) &&
 476                     batadv_tt_global_is_isolated(bat_priv, ethhdr->h_source,
 477                                                  vid)) {
 478                         /* save bits in skb->mark not covered by the mask and
 479                          * apply the mark on the rest
 480                          */
 481                         skb->mark &= ~bat_priv->isolation_mark_mask;
 482                         skb->mark |= bat_priv->isolation_mark;
 483                 }
 484         } else if (batadv_is_ap_isolated(bat_priv, ethhdr->h_source,
 485                                          ethhdr->h_dest, vid)) {
 486                 goto dropped;
 487         }
 488
 489         netif_rx(skb);
 490         goto out;
 491
 492 dropped:
 493         kfree_skb(skb);
 494 out:
 495         return;
 496 }
 497
 498 /**
 499  * batadv_softif_vlan_release - release vlan from lists and queue for free after
 500  *  rcu grace period
 501  * @ref: kref pointer of the vlan object
 502  */
 503 static void batadv_softif_vlan_release(struct kref *ref)
 504 {
 505         struct batadv_softif_vlan *vlan;
 506
 507         vlan = container_of(ref, struct batadv_softif_vlan, refcount);
 508
 509         spin_lock_bh(&vlan->bat_priv->softif_vlan_list_lock);
 510         hlist_del_rcu(&vlan->list);
 511         spin_unlock_bh(&vlan->bat_priv->softif_vlan_list_lock);
 512
 513         kfree_rcu(vlan, rcu);
 514 }
 515
 516 /**
 517  * batadv_softif_vlan_put - decrease the vlan object refcounter and
 518  *  possibly release it
 519  * @vlan: the vlan object to release
 520  */
 521 void batadv_softif_vlan_put(struct batadv_softif_vlan *vlan)
 522 {
 523         if (!vlan)
 524                 return;
 525
 526         kref_put(&vlan->refcount, batadv_softif_vlan_release);
 527 }
 528
 529 /**
 530  * batadv_softif_vlan_get - get the vlan object for a specific vid
 531  * @bat_priv: the bat priv with all the soft interface information
 532  * @vid: the identifier of the vlan object to retrieve
 533  *
 534  * Return: the private data of the vlan matching the vid passed as argument or
 535  * NULL otherwise. The refcounter of the returned object is incremented by 1.
 536  */
 537 struct batadv_softif_vlan *batadv_softif_vlan_get(struct batadv_priv *bat_priv,
 538                                                   unsigned short vid)
 539 {
 540         struct batadv_softif_vlan *vlan_tmp, *vlan = NULL;
 541
 542         rcu_read_lock();
 543         hlist_for_each_entry_rcu(vlan_tmp, &bat_priv->softif_vlan_list, list) {
 544                 if (vlan_tmp->vid != vid)
 545                         continue;
 546
 547                 if (!kref_get_unless_zero(&vlan_tmp->refcount))
 548                         continue;
 549
 550                 vlan = vlan_tmp;
 551                 break;
 552         }
 553         rcu_read_unlock();
 554
 555         return vlan;
 556 }
 557
 558 /**
 559  * batadv_softif_create_vlan - allocate the needed resources for a new vlan
 560  * @bat_priv: the bat priv with all the soft interface information
 561  * @vid: the VLAN identifier
 562  *
 563  * Return: 0 on success, a negative error otherwise.
 564  */
 565 int batadv_softif_create_vlan(struct batadv_priv *bat_priv, unsigned short vid)
 566 {
 567         struct batadv_softif_vlan *vlan;
 568         int err;
 569
 570         vlan = batadv_softif_vlan_get(bat_priv, vid);
 571         if (vlan) {
 572                 batadv_softif_vlan_put(vlan);
 573                 return -EEXIST;
 574         }
 575
 576         vlan = kzalloc(sizeof(*vlan), GFP_ATOMIC);
 577         if (!vlan)
 578                 return -ENOMEM;
 579
 580         vlan->bat_priv = bat_priv;
 581         vlan->vid = vid;
 582         kref_init(&vlan->refcount);
 583
 584         atomic_set(&vlan->ap_isolation, 0);
 585
 586         err = batadv_sysfs_add_vlan(bat_priv->soft_iface, vlan);
 587         if (err) {
 588                 kfree(vlan);
 589                 return err;
 590         }
 591
 592         spin_lock_bh(&bat_priv->softif_vlan_list_lock);
 593         hlist_add_head_rcu(&vlan->list, &bat_priv->softif_vlan_list);
 594         spin_unlock_bh(&bat_priv->softif_vlan_list_lock);
 595
 596         /* add a new TT local entry. This one will be marked with the NOPURGE
 597          * flag
 598          */
 599         batadv_tt_local_add(bat_priv->soft_iface,
 600                             bat_priv->soft_iface->dev_addr, vid,
 601                             BATADV_NULL_IFINDEX, BATADV_NO_MARK);
 602
 603         return 0;
 604 }
 605
 606 /**
 607  * batadv_softif_destroy_vlan - remove and destroy a softif_vlan object
 608  * @bat_priv: the bat priv with all the soft interface information
 609  * @vlan: the object to remove
 610  */
 611 static void batadv_softif_destroy_vlan(struct batadv_priv *bat_priv,
 612                                        struct batadv_softif_vlan *vlan)
 613 {
 614         /* explicitly remove the associated TT local entry because it is marked
 615          * with the NOPURGE flag
 616          */
 617         batadv_tt_local_remove(bat_priv, bat_priv->soft_iface->dev_addr,
 618                                vlan->vid, "vlan interface destroyed", false);
 619
 620         batadv_sysfs_del_vlan(bat_priv, vlan);
 621         batadv_softif_vlan_put(vlan);
 622 }
 623
 624 /**
 625  * batadv_interface_add_vid - ndo_add_vid API implementation
 626  * @dev: the netdev of the mesh interface
 627  * @proto: protocol of the the vlan id
 628  * @vid: identifier of the new vlan
 629  *
 630  * Set up all the internal structures for handling the new vlan on top of the
 631  * mesh interface
 632  *
 633  * Return: 0 on success or a negative error code in case of failure.
 634  */
 635 static int batadv_interface_add_vid(struct net_device *dev, __be16 proto,
 636                                     unsigned short vid)
 637 {
 638         struct batadv_priv *bat_priv = netdev_priv(dev);
 639         struct batadv_softif_vlan *vlan;
 640         int ret;
 641
 642         /* only 802.1Q vlans are supported.
 643          * batman-adv does not know how to handle other types
 644          */
 645         if (proto != htons(ETH_P_8021Q))
 646                 return -EINVAL;
 647
 648         vid |= BATADV_VLAN_HAS_TAG;
 649
 650         /* if a new vlan is getting created and it already exists, it means that
 651          * it was not deleted yet. batadv_softif_vlan_get() increases the
 652          * refcount in order to revive the object.
 653          *
 654          * if it does not exist then create it.
 655          */
 656         vlan = batadv_softif_vlan_get(bat_priv, vid);
 657         if (!vlan)
 658                 return batadv_softif_create_vlan(bat_priv, vid);
 659
 660         /* recreate the sysfs object if it was already destroyed (and it should
 661          * be since we received a kill_vid() for this vlan
 662          */
 663         if (!vlan->kobj) {
 664                 ret = batadv_sysfs_add_vlan(bat_priv->soft_iface, vlan);
 665                 if (ret) {
 666                         batadv_softif_vlan_put(vlan);
 667                         return ret;
 668                 }
 669         }
 670
 671         /* add a new TT local entry. This one will be marked with the NOPURGE
 672          * flag. This must be added again, even if the vlan object already
 673          * exists, because the entry was deleted by kill_vid()
 674          */
 675         batadv_tt_local_add(bat_priv->soft_iface,
 676                             bat_priv->soft_iface->dev_addr, vid,
 677                             BATADV_NULL_IFINDEX, BATADV_NO_MARK);
 678
 679         return 0;
 680 }
 681
 682 /**
 683  * batadv_interface_kill_vid - ndo_kill_vid API implementation
 684  * @dev: the netdev of the mesh interface
 685  * @proto: protocol of the the vlan id
 686  * @vid: identifier of the deleted vlan
 687  *
 688  * Destroy all the internal structures used to handle the vlan identified by vid
 689  * on top of the mesh interface
 690  *
 691  * Return: 0 on success, -EINVAL if the specified prototype is not ETH_P_8021Q
 692  * or -ENOENT if the specified vlan id wasn't registered.
 693  */
 694 static int batadv_interface_kill_vid(struct net_device *dev, __be16 proto,
 695                                      unsigned short vid)
 696 {
 697         struct batadv_priv *bat_priv = netdev_priv(dev);
 698         struct batadv_softif_vlan *vlan;
 699
 700         /* only 802.1Q vlans are supported. batman-adv does not know how to
 701          * handle other types
 702          */
 703         if (proto != htons(ETH_P_8021Q))
 704                 return -EINVAL;
 705
 706         vlan = batadv_softif_vlan_get(bat_priv, vid | BATADV_VLAN_HAS_TAG);
 707         if (!vlan)
 708                 return -ENOENT;
 709
 710         batadv_softif_destroy_vlan(bat_priv, vlan);
 711
 712         /* finally free the vlan object */
 713         batadv_softif_vlan_put(vlan);
 714
 715         return 0;
 716 }
 717
 718 /* batman-adv network devices have devices nesting below it and are a special
 719  * "super class" of normal network devices; split their locks off into a
 720  * separate class since they always nest.
 721  */
 722 static struct lock_class_key batadv_netdev_xmit_lock_key;
 723 static struct lock_class_key batadv_netdev_addr_lock_key;
 724
 725 /**
 726  * batadv_set_lockdep_class_one - Set lockdep class for a single tx queue
 727  * @dev: device which owns the tx queue
 728  * @txq: tx queue to modify
 729  * @_unused: always NULL
 730  */
 731 static void batadv_set_lockdep_class_one(struct net_device *dev,
 732                                          struct netdev_queue *txq,
 733                                          void *_unused)
 734 {
 735         lockdep_set_class(&txq->_xmit_lock, &batadv_netdev_xmit_lock_key);
 736 }
 737
 738 /**
 739  * batadv_set_lockdep_class - Set txq and addr_list lockdep class
 740  * @dev: network device to modify
 741  */
 742 static void batadv_set_lockdep_class(struct net_device *dev)
 743 {
 744         lockdep_set_class(&dev->addr_list_lock, &batadv_netdev_addr_lock_key);
 745         netdev_for_each_tx_queue(dev, batadv_set_lockdep_class_one, NULL);
 746 }
 747
 748 /**
 749  * batadv_softif_destroy_finish - cleans up the remains of a softif
 750  * @work: work queue item
 751  *
 752  * Free the parts of the soft interface which can not be removed under
 753  * rtnl lock (to prevent deadlock situations).
 754  */
 755 static void batadv_softif_destroy_finish(struct work_struct *work)
 756 {
 757         struct batadv_softif_vlan *vlan;
 758         struct batadv_priv *bat_priv;
 759         struct net_device *soft_iface;
 760
 761         bat_priv = container_of(work, struct batadv_priv,
 762                                 cleanup_work);
 763         soft_iface = bat_priv->soft_iface;
 764
 765         /* destroy the "untagged" VLAN */
 766         vlan = batadv_softif_vlan_get(bat_priv, BATADV_NO_FLAGS);
 767         if (vlan) {
 768                 batadv_softif_destroy_vlan(bat_priv, vlan);
 769                 batadv_softif_vlan_put(vlan);
 770         }
 771
 772         batadv_sysfs_del_meshif(soft_iface);
 773         unregister_netdev(soft_iface);
 774 }
 775
 776 /**
 777  * batadv_softif_init_late - late stage initialization of soft interface
 778  * @dev: registered network device to modify
 779  *
 780  * Return: error code on failures
 781  */
 782 static int batadv_softif_init_late(struct net_device *dev)
 783 {
 784         struct batadv_priv *bat_priv;
 785         u32 random_seqno;
 786         int ret;
 787         size_t cnt_len = sizeof(u64) * BATADV_CNT_NUM;
 788
 789         batadv_set_lockdep_class(dev);
 790
 791         bat_priv = netdev_priv(dev);
 792         bat_priv->soft_iface = dev;
 793         INIT_WORK(&bat_priv->cleanup_work, batadv_softif_destroy_finish);
 794
 795         /* batadv_interface_stats() needs to be available as soon as
 796          * register_netdevice() has been called
 797          */
 798         bat_priv->bat_counters = __alloc_percpu(cnt_len, __alignof__(u64));
 799         if (!bat_priv->bat_counters)
 800                 return -ENOMEM;
 801
 802         atomic_set(&bat_priv->aggregated_ogms, 1);
 803         atomic_set(&bat_priv->bonding, 0);
 804 #ifdef CONFIG_BATMAN_ADV_BLA
 805         atomic_set(&bat_priv->bridge_loop_avoidance, 1);
 806 #endif
 807 #ifdef CONFIG_BATMAN_ADV_DAT
 808         atomic_set(&bat_priv->distributed_arp_table, 1);
 809 #endif
 810 #ifdef CONFIG_BATMAN_ADV_MCAST
 811         bat_priv->mcast.flags = BATADV_NO_FLAGS;
 812         atomic_set(&bat_priv->multicast_mode, 1);
 813         atomic_set(&bat_priv->mcast.num_disabled, 0);
 814         atomic_set(&bat_priv->mcast.num_want_all_unsnoopables, 0);
 815         atomic_set(&bat_priv->mcast.num_want_all_ipv4, 0);
 816         atomic_set(&bat_priv->mcast.num_want_all_ipv6, 0);
 817 #endif
 818         atomic_set(&bat_priv->gw_mode, BATADV_GW_MODE_OFF);
 819         atomic_set(&bat_priv->gw_sel_class, 20);
 820         atomic_set(&bat_priv->gw.bandwidth_down, 100);
 821         atomic_set(&bat_priv->gw.bandwidth_up, 20);
 822         atomic_set(&bat_priv->orig_interval, 1000);
 823         atomic_set(&bat_priv->hop_penalty, 30);
 824 #ifdef CONFIG_BATMAN_ADV_DEBUG
 825         atomic_set(&bat_priv->log_level, 0);
 826 #endif
 827         atomic_set(&bat_priv->fragmentation, 1);
 828         atomic_set(&bat_priv->packet_size_max, ETH_DATA_LEN);
 829         atomic_set(&bat_priv->bcast_queue_left, BATADV_BCAST_QUEUE_LEN);
 830         atomic_set(&bat_priv->batman_queue_left, BATADV_BATMAN_QUEUE_LEN);
 831
 832         atomic_set(&bat_priv->mesh_state, BATADV_MESH_INACTIVE);
 833         atomic_set(&bat_priv->bcast_seqno, 1);
 834         atomic_set(&bat_priv->tt.vn, 0);
 835         atomic_set(&bat_priv->tt.local_changes, 0);
 836         atomic_set(&bat_priv->tt.ogm_append_cnt, 0);
 837 #ifdef CONFIG_BATMAN_ADV_BLA
 838         atomic_set(&bat_priv->bla.num_requests, 0);
 839 #endif
 840         bat_priv->tt.last_changeset = NULL;
 841         bat_priv->tt.last_changeset_len = 0;
 842         bat_priv->isolation_mark = 0;
 843         bat_priv->isolation_mark_mask = 0;
 844
 845         /* randomize initial seqno to avoid collision */
 846         get_random_bytes(&random_seqno, sizeof(random_seqno));
 847         atomic_set(&bat_priv->frag_seqno, random_seqno);
 848
 849         bat_priv->primary_if = NULL;
 850         bat_priv->num_ifaces = 0;
 851
 852         batadv_nc_init_bat_priv(bat_priv);
 853
 854         ret = batadv_algo_select(bat_priv, batadv_routing_algo);
 855         if (ret < 0)
 856                 goto free_bat_counters;
 857
 858         ret = batadv_debugfs_add_meshif(dev);
 859         if (ret < 0)
 860                 goto free_bat_counters;
 861
 862         ret = batadv_mesh_init(dev);
 863         if (ret < 0)
 864                 goto unreg_debugfs;
 865
 866         return 0;
 867
 868 unreg_debugfs:
 869         batadv_debugfs_del_meshif(dev);
 870 free_bat_counters:
 871         free_percpu(bat_priv->bat_counters);
 872         bat_priv->bat_counters = NULL;
 873
 874         return ret;
 875 }
 876
 877 /**
 878  * batadv_softif_slave_add - Add a slave interface to a batadv_soft_interface
 879  * @dev: batadv_soft_interface used as master interface
 880  * @slave_dev: net_device which should become the slave interface
 881  *
 882  * Return: 0 if successful or error otherwise.
 883  */
 884 static int batadv_softif_slave_add(struct net_device *dev,
 885                                    struct net_device *slave_dev)
 886 {
 887         struct batadv_hard_iface *hard_iface;
 888         struct net *net = dev_net(dev);
 889         int ret = -EINVAL;
 890
 891         hard_iface = batadv_hardif_get_by_netdev(slave_dev);
 892         if (!hard_iface || hard_iface->soft_iface)
 893                 goto out;
 894
 895         ret = batadv_hardif_enable_interface(hard_iface, net, dev->name);
 896
 897 out:
 898         if (hard_iface)
 899                 batadv_hardif_put(hard_iface);
 900         return ret;
 901 }
 902
 903 /**
 904  * batadv_softif_slave_del - Delete a slave iface from a batadv_soft_interface
 905  * @dev: batadv_soft_interface used as master interface
 906  * @slave_dev: net_device which should be removed from the master interface
 907  *
 908  * Return: 0 if successful or error otherwise.
 909  */
 910 static int batadv_softif_slave_del(struct net_device *dev,
 911                                    struct net_device *slave_dev)
 912 {
 913         struct batadv_hard_iface *hard_iface;
 914         int ret = -EINVAL;
 915
 916         hard_iface = batadv_hardif_get_by_netdev(slave_dev);
 917
 918         if (!hard_iface || hard_iface->soft_iface != dev)
 919                 goto out;
 920
 921         batadv_hardif_disable_interface(hard_iface, BATADV_IF_CLEANUP_KEEP);
 922         ret = 0;
 923
 924 out:
 925         if (hard_iface)
 926                 batadv_hardif_put(hard_iface);
 927         return ret;
 928 }
 929
 930 static const struct net_device_ops batadv_netdev_ops = {
 931         .ndo_init = batadv_softif_init_late,
 932         .ndo_open = batadv_interface_open,
 933         .ndo_stop = batadv_interface_release,
 934         .ndo_get_stats = batadv_interface_stats,
 935         .ndo_vlan_rx_add_vid = batadv_interface_add_vid,
 936         .ndo_vlan_rx_kill_vid = batadv_interface_kill_vid,
 937         .ndo_set_mac_address = batadv_interface_set_mac_addr,
 938         .ndo_change_mtu = batadv_interface_change_mtu,
 939         .ndo_set_rx_mode = batadv_interface_set_rx_mode,
 940         .ndo_start_xmit = batadv_interface_tx,
 941         .ndo_validate_addr = eth_validate_addr,
 942         .ndo_add_slave = batadv_softif_slave_add,
 943         .ndo_del_slave = batadv_softif_slave_del,
 944 };
 945
 946 /**
 947  * batadv_softif_free - Deconstructor of batadv_soft_interface
 948  * @dev: Device to cleanup and remove
 949  */
 950 static void batadv_softif_free(struct net_device *dev)
 951 {
 952         batadv_debugfs_del_meshif(dev);
 953         batadv_mesh_free(dev);
 954
 955         /* some scheduled RCU callbacks need the bat_priv struct to accomplish
 956          * their tasks. Wait for them all to be finished before freeing the
 957          * netdev and its private data (bat_priv)
 958          */
 959         rcu_barrier();
 960
 961         free_netdev(dev);
 962 }
 963
 964 /**
 965  * batadv_softif_init_early - early stage initialization of soft interface
 966  * @dev: registered network device to modify
 967  */
 968 static void batadv_softif_init_early(struct net_device *dev)
 969 {
 970         struct batadv_priv *priv = netdev_priv(dev);
 971
 972         ether_setup(dev);
 973
 974         dev->netdev_ops = &batadv_netdev_ops;
 975         dev->destructor = batadv_softif_free;
 976         dev->features |= NETIF_F_HW_VLAN_CTAG_FILTER | NETIF_F_NETNS_LOCAL;
 977         dev->priv_flags |= IFF_NO_QUEUE;
 978
 979         /* can't call min_mtu, because the needed variables
 980          * have not been initialized yet
 981          */
 982         dev->mtu = ETH_DATA_LEN;
 983
 984         /* generate random address */
 985         eth_hw_addr_random(dev);
 986
 987         dev->ethtool_ops = &batadv_ethtool_ops;
 988
 989         memset(priv, 0, sizeof(*priv));
 990 }
 991
 992 struct net_device *batadv_softif_create(struct net *net, const char *name)
 993 {
 994         struct net_device *soft_iface;
 995         int ret;
 996
 997         soft_iface = alloc_netdev(sizeof(struct batadv_priv), name,
 998                                   NET_NAME_UNKNOWN, batadv_softif_init_early);
 999         if (!soft_iface)
1000                 return NULL;
1001
1002         dev_net_set(soft_iface, net);
1003
1004         soft_iface->rtnl_link_ops = &batadv_link_ops;
1005
1006         ret = register_netdevice(soft_iface);
1007         if (ret < 0) {
1008                 pr_err("Unable to register the batman interface '%s': %i\n",
1009                        name, ret);
1010                 free_netdev(soft_iface);
1011                 return NULL;
1012         }
1013
1014         return soft_iface;
1015 }
1016
1017 /**
1018  * batadv_softif_destroy_sysfs - deletion of batadv_soft_interface via sysfs
1019  * @soft_iface: the to-be-removed batman-adv interface
1020  */
1021 void batadv_softif_destroy_sysfs(struct net_device *soft_iface)
1022 {
1023         struct batadv_priv *bat_priv = netdev_priv(soft_iface);
1024
1025         queue_work(batadv_event_workqueue, &bat_priv->cleanup_work);
1026 }
1027
1028 /**
1029  * batadv_softif_destroy_netlink - deletion of batadv_soft_interface via netlink
1030  * @soft_iface: the to-be-removed batman-adv interface
1031  * @head: list pointer
1032  */
1033 static void batadv_softif_destroy_netlink(struct net_device *soft_iface,
1034                                           struct list_head *head)
1035 {
1036         struct batadv_hard_iface *hard_iface;
1037
1038         list_for_each_entry(hard_iface, &batadv_hardif_list, list) {
1039                 if (hard_iface->soft_iface == soft_iface)
1040                         batadv_hardif_disable_interface(hard_iface,
1041                                                         BATADV_IF_CLEANUP_KEEP);
1042         }
1043
1044         batadv_sysfs_del_meshif(soft_iface);
1045         unregister_netdevice_queue(soft_iface, head);
1046 }
1047
1048 bool batadv_softif_is_valid(const struct net_device *net_dev)
1049 {
1050         if (net_dev->netdev_ops->ndo_start_xmit == batadv_interface_tx)
1051                 return true;
1052
1053         return false;
1054 }
1055
1056 struct rtnl_link_ops batadv_link_ops __read_mostly = {
1057         .kind           = "batadv",
1058         .priv_size      = sizeof(struct batadv_priv),
1059         .setup          = batadv_softif_init_early,
1060         .dellink        = batadv_softif_destroy_netlink,
1061 };
1062
1063 /* ethtool */
1064 static int batadv_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
1065 {
1066         cmd->supported = 0;
1067         cmd->advertising = 0;
1068         ethtool_cmd_speed_set(cmd, SPEED_10);
1069         cmd->duplex = DUPLEX_FULL;
1070         cmd->port = PORT_TP;
1071         cmd->phy_address = 0;
1072         cmd->transceiver = XCVR_INTERNAL;
1073         cmd->autoneg = AUTONEG_DISABLE;
1074         cmd->maxtxpkt = 0;
1075         cmd->maxrxpkt = 0;
1076
1077         return 0;
1078 }
1079
1080 static void batadv_get_drvinfo(struct net_device *dev,
1081                                struct ethtool_drvinfo *info)
1082 {
1083         strlcpy(info->driver, "B.A.T.M.A.N. advanced", sizeof(info->driver));
1084         strlcpy(info->version, BATADV_SOURCE_VERSION, sizeof(info->version));
1085         strlcpy(info->fw_version, "N/A", sizeof(info->fw_version));
1086         strlcpy(info->bus_info, "batman", sizeof(info->bus_info));
1087 }
1088
1089 static u32 batadv_get_msglevel(struct net_device *dev)
1090 {
1091         return -EOPNOTSUPP;
1092 }
1093
1094 static void batadv_set_msglevel(struct net_device *dev, u32 value)
1095 {
1096 }
1097
1098 static u32 batadv_get_link(struct net_device *dev)
1099 {
1100         return 1;
1101 }
1102
1103 /* Inspired by drivers/net/ethernet/dlink/sundance.c:1702
1104  * Declare each description string in struct.name[] to get fixed sized buffer
1105  * and compile time checking for strings longer than ETH_GSTRING_LEN.
1106  */
1107 static const struct {
1108         const char name[ETH_GSTRING_LEN];
1109 } batadv_counters_strings[] = {
1110         { "tx" },
1111         { "tx_bytes" },
1112         { "tx_dropped" },
1113         { "rx" },
1114         { "rx_bytes" },
1115         { "forward" },
1116         { "forward_bytes" },
1117         { "mgmt_tx" },
1118         { "mgmt_tx_bytes" },
1119         { "mgmt_rx" },
1120         { "mgmt_rx_bytes" },
1121         { "frag_tx" },
1122         { "frag_tx_bytes" },
1123         { "frag_rx" },
1124         { "frag_rx_bytes" },
1125         { "frag_fwd" },
1126         { "frag_fwd_bytes" },
1127         { "tt_request_tx" },
1128         { "tt_request_rx" },
1129         { "tt_response_tx" },
1130         { "tt_response_rx" },
1131         { "tt_roam_adv_tx" },
1132         { "tt_roam_adv_rx" },
1133 #ifdef CONFIG_BATMAN_ADV_DAT
1134         { "dat_get_tx" },
1135         { "dat_get_rx" },
1136         { "dat_put_tx" },
1137         { "dat_put_rx" },
1138         { "dat_cached_reply_tx" },
1139 #endif
1140 #ifdef CONFIG_BATMAN_ADV_NC
1141         { "nc_code" },
1142         { "nc_code_bytes" },
1143         { "nc_recode" },
1144         { "nc_recode_bytes" },
1145         { "nc_buffer" },
1146         { "nc_decode" },
1147         { "nc_decode_bytes" },
1148         { "nc_decode_failed" },
1149         { "nc_sniffed" },
1150 #endif
1151 };
1152
1153 static void batadv_get_strings(struct net_device *dev, u32 stringset, u8 *data)
1154 {
1155         if (stringset == ETH_SS_STATS)
1156                 memcpy(data, batadv_counters_strings,
1157                        sizeof(batadv_counters_strings));
1158 }
1159
1160 static void batadv_get_ethtool_stats(struct net_device *dev,
1161                                      struct ethtool_stats *stats, u64 *data)
1162 {
1163         struct batadv_priv *bat_priv = netdev_priv(dev);
1164         int i;
1165
1166         for (i = 0; i < BATADV_CNT_NUM; i++)
1167                 data[i] = batadv_sum_counter(bat_priv, i);
1168 }
1169
1170 static int batadv_get_sset_count(struct net_device *dev, int stringset)
1171 {
1172         if (stringset == ETH_SS_STATS)
1173                 return BATADV_CNT_NUM;
1174
1175         return -EOPNOTSUPP;
1176 }