net/batman-adv/soft-interface.c

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