net/batman-adv/soft-interface.c

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