net/batman-adv/soft-interface.c

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