net/batman-adv/soft-interface.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /* Copyright (C) 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/container_of.h>
  15 #include <linux/cpumask.h>
  16 #include <linux/errno.h>
  17 #include <linux/etherdevice.h>
  18 #include <linux/ethtool.h>
  19 #include <linux/gfp.h>
  20 #include <linux/if_ether.h>
  21 #include <linux/if_vlan.h>
  22 #include <linux/jiffies.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/random.h>
  30 #include <linux/rculist.h>
  31 #include <linux/rcupdate.h>
  32 #include <linux/skbuff.h>
  33 #include <linux/slab.h>
  34 #include <linux/socket.h>
  35 #include <linux/spinlock.h>
  36 #include <linux/stddef.h>
  37 #include <linux/string.h>
  38 #include <linux/types.h>
  39 #include <net/net_namespace.h>
  40 #include <net/netlink.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 "distributed-arp-table.h"
  47 #include "gateway_client.h"
  48 #include "hard-interface.h"
  49 #include "multicast.h"
  50 #include "network-coding.h"
  51 #include "send.h"
  52 #include "translation-table.h"
  53
  54 /**
  55  * batadv_skb_head_push() - Increase header size and move (push) head pointer
  56  * @skb: packet buffer which should be modified
  57  * @len: number of bytes to add
  58  *
  59  * Return: 0 on success or negative error number in case of failure
  60  */
  61 int batadv_skb_head_push(struct sk_buff *skb, unsigned int len)
  62 {
  63         int result;
  64
  65         /* TODO: We must check if we can release all references to non-payload
  66          * data using __skb_header_release in our skbs to allow skb_cow_header
  67          * to work optimally. This means that those skbs are not allowed to read
  68          * or write any data which is before the current position of skb->data
  69          * after that call and thus allow other skbs with the same data buffer
  70          * to write freely in that area.
  71          */
  72         result = skb_cow_head(skb, len);
  73         if (result < 0)
  74                 return result;
  75
  76         skb_push(skb, len);
  77         return 0;
  78 }
  79
  80 static int batadv_interface_open(struct net_device *dev)
  81 {
  82         netif_start_queue(dev);
  83         return 0;
  84 }
  85
  86 static int batadv_interface_release(struct net_device *dev)
  87 {
  88         netif_stop_queue(dev);
  89         return 0;
  90 }
  91
  92 /**
  93  * batadv_sum_counter() - Sum the cpu-local counters for index 'idx'
  94  * @bat_priv: the bat priv with all the soft interface information
  95  * @idx: index of counter to sum up
  96  *
  97  * Return: sum of all cpu-local counters
  98  */
  99 static u64 batadv_sum_counter(struct batadv_priv *bat_priv,  size_t idx)
 100 {
 101         u64 *counters, sum = 0;
 102         int cpu;
 103
 104         for_each_possible_cpu(cpu) {
 105                 counters = per_cpu_ptr(bat_priv->bat_counters, cpu);
 106                 sum += counters[idx];
 107         }
 108
 109         return sum;
 110 }
 111
 112 static struct net_device_stats *batadv_interface_stats(struct net_device *dev)
 113 {
 114         struct batadv_priv *bat_priv = netdev_priv(dev);
 115         struct net_device_stats *stats = &dev->stats;
 116
 117         stats->tx_packets = batadv_sum_counter(bat_priv, BATADV_CNT_TX);
 118         stats->tx_bytes = batadv_sum_counter(bat_priv, BATADV_CNT_TX_BYTES);
 119         stats->tx_dropped = batadv_sum_counter(bat_priv, BATADV_CNT_TX_DROPPED);
 120         stats->rx_packets = batadv_sum_counter(bat_priv, BATADV_CNT_RX);
 121         stats->rx_bytes = batadv_sum_counter(bat_priv, BATADV_CNT_RX_BYTES);
 122         return stats;
 123 }
 124
 125 static int batadv_interface_set_mac_addr(struct net_device *dev, void *p)
 126 {
 127         struct batadv_priv *bat_priv = netdev_priv(dev);
 128         struct batadv_softif_vlan *vlan;
 129         struct sockaddr *addr = p;
 130         u8 old_addr[ETH_ALEN];
 131
 132         if (!is_valid_ether_addr(addr->sa_data))
 133                 return -EADDRNOTAVAIL;
 134
 135         ether_addr_copy(old_addr, dev->dev_addr);
 136         eth_hw_addr_set(dev, addr->sa_data);
 137
 138         /* only modify transtable if it has been initialized before */
 139         if (atomic_read(&bat_priv->mesh_state) != BATADV_MESH_ACTIVE)
 140                 return 0;
 141
 142         rcu_read_lock();
 143         hlist_for_each_entry_rcu(vlan, &bat_priv->softif_vlan_list, list) {
 144                 batadv_tt_local_remove(bat_priv, old_addr, vlan->vid,
 145                                        "mac address changed", false);
 146                 batadv_tt_local_add(dev, addr->sa_data, vlan->vid,
 147                                     BATADV_NULL_IFINDEX, BATADV_NO_MARK);
 148         }
 149         rcu_read_unlock();
 150
 151         return 0;
 152 }
 153
 154 static int batadv_interface_change_mtu(struct net_device *dev, int new_mtu)
 155 {
 156         struct batadv_priv *bat_priv = netdev_priv(dev);
 157
 158         /* check ranges */
 159         if (new_mtu < ETH_MIN_MTU || new_mtu > batadv_hardif_min_mtu(dev))
 160                 return -EINVAL;
 161
 162         WRITE_ONCE(dev->mtu, new_mtu);
 163         bat_priv->mtu_set_by_user = 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 = 0;
 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_BCAST;
 202         int mcast_is_routable = 0;
 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, vid,
 305                                                            &mcast_is_routable);
 306                         switch (forw_mode) {
 307                         case BATADV_FORW_BCAST:
 308                                 break;
 309                         case BATADV_FORW_UCASTS:
 310                         case BATADV_FORW_MCAST:
 311                                 do_bcast = false;
 312                                 break;
 313                         case BATADV_FORW_NONE:
 314                                 fallthrough;
 315                         default:
 316                                 goto dropped;
 317                         }
 318                 }
 319         }
 320
 321         batadv_skb_set_priority(skb, 0);
 322
 323         /* ethernet packet should be broadcasted */
 324         if (do_bcast) {
 325                 primary_if = batadv_primary_if_get_selected(bat_priv);
 326                 if (!primary_if)
 327                         goto dropped;
 328
 329                 /* in case of ARP request, we do not immediately broadcasti the
 330                  * packet, instead we first wait for DAT to try to retrieve the
 331                  * correct ARP entry
 332                  */
 333                 if (batadv_dat_snoop_outgoing_arp_request(bat_priv, skb))
 334                         brd_delay = msecs_to_jiffies(ARP_REQ_DELAY);
 335
 336                 if (batadv_skb_head_push(skb, sizeof(*bcast_packet)) < 0)
 337                         goto dropped;
 338
 339                 bcast_packet = (struct batadv_bcast_packet *)skb->data;
 340                 bcast_packet->version = BATADV_COMPAT_VERSION;
 341                 bcast_packet->ttl = BATADV_TTL - 1;
 342
 343                 /* batman packet type: broadcast */
 344                 bcast_packet->packet_type = BATADV_BCAST;
 345                 bcast_packet->reserved = 0;
 346
 347                 /* hw address of first interface is the orig mac because only
 348                  * this mac is known throughout the mesh
 349                  */
 350                 ether_addr_copy(bcast_packet->orig,
 351                                 primary_if->net_dev->dev_addr);
 352
 353                 /* set broadcast sequence number */
 354                 seqno = atomic_inc_return(&bat_priv->bcast_seqno);
 355                 bcast_packet->seqno = htonl(seqno);
 356
 357                 batadv_send_bcast_packet(bat_priv, skb, brd_delay, true);
 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 (forw_mode == BATADV_FORW_UCASTS) {
 367                         ret = batadv_mcast_forw_send(bat_priv, skb, vid,
 368                                                      mcast_is_routable);
 369                 } else if (forw_mode == BATADV_FORW_MCAST) {
 370                         ret = batadv_mcast_forw_mcsend(bat_priv, skb);
 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         batadv_hardif_put(primary_if);
 395         return NETDEV_TX_OK;
 396 }
 397
 398 /**
 399  * batadv_interface_rx() - receive ethernet frame on local batman-adv interface
 400  * @soft_iface: local interface which will receive the ethernet frame
 401  * @skb: ethernet frame for @soft_iface
 402  * @hdr_size: size of already parsed batman-adv header
 403  * @orig_node: originator from which the batman-adv packet was sent
 404  *
 405  * Sends an ethernet frame to the receive path of the local @soft_iface.
 406  * skb->data has still point to the batman-adv header with the size @hdr_size.
 407  * The caller has to have parsed this header already and made sure that at least
 408  * @hdr_size bytes are still available for pull in @skb.
 409  *
 410  * The packet may still get dropped. This can happen when the encapsulated
 411  * ethernet frame is invalid or contains again an batman-adv packet. Also
 412  * unicast packets will be dropped directly when it was sent between two
 413  * isolated clients.
 414  */
 415 void batadv_interface_rx(struct net_device *soft_iface,
 416                          struct sk_buff *skb, int hdr_size,
 417                          struct batadv_orig_node *orig_node)
 418 {
 419         struct batadv_bcast_packet *batadv_bcast_packet;
 420         struct batadv_priv *bat_priv = netdev_priv(soft_iface);
 421         struct vlan_ethhdr *vhdr;
 422         struct ethhdr *ethhdr;
 423         unsigned short vid;
 424         int packet_type;
 425
 426         batadv_bcast_packet = (struct batadv_bcast_packet *)skb->data;
 427         packet_type = batadv_bcast_packet->packet_type;
 428
 429         skb_pull_rcsum(skb, hdr_size);
 430         skb_reset_mac_header(skb);
 431
 432         /* clean the netfilter state now that the batman-adv header has been
 433          * removed
 434          */
 435         nf_reset_ct(skb);
 436
 437         if (unlikely(!pskb_may_pull(skb, ETH_HLEN)))
 438                 goto dropped;
 439
 440         vid = batadv_get_vid(skb, 0);
 441         ethhdr = eth_hdr(skb);
 442
 443         switch (ntohs(ethhdr->h_proto)) {
 444         case ETH_P_8021Q:
 445                 if (!pskb_may_pull(skb, VLAN_ETH_HLEN))
 446                         goto dropped;
 447
 448                 vhdr = skb_vlan_eth_hdr(skb);
 449
 450                 /* drop batman-in-batman packets to prevent loops */
 451                 if (vhdr->h_vlan_encapsulated_proto != htons(ETH_P_BATMAN))
 452                         break;
 453
 454                 fallthrough;
 455         case ETH_P_BATMAN:
 456                 goto dropped;
 457         }
 458
 459         /* skb->dev & skb->pkt_type are set here */
 460         skb->protocol = eth_type_trans(skb, soft_iface);
 461         skb_postpull_rcsum(skb, eth_hdr(skb), ETH_HLEN);
 462
 463         batadv_inc_counter(bat_priv, BATADV_CNT_RX);
 464         batadv_add_counter(bat_priv, BATADV_CNT_RX_BYTES,
 465                            skb->len + ETH_HLEN);
 466
 467         /* Let the bridge loop avoidance check the packet. If will
 468          * not handle it, we can safely push it up.
 469          */
 470         if (batadv_bla_rx(bat_priv, skb, vid, packet_type))
 471                 goto out;
 472
 473         if (orig_node)
 474                 batadv_tt_add_temporary_global_entry(bat_priv, orig_node,
 475                                                      ethhdr->h_source, vid);
 476
 477         if (is_multicast_ether_addr(ethhdr->h_dest)) {
 478                 /* set the mark on broadcast packets if AP isolation is ON and
 479                  * the packet is coming from an "isolated" client
 480                  */
 481                 if (batadv_vlan_ap_isola_get(bat_priv, vid) &&
 482                     batadv_tt_global_is_isolated(bat_priv, ethhdr->h_source,
 483                                                  vid)) {
 484                         /* save bits in skb->mark not covered by the mask and
 485                          * apply the mark on the rest
 486                          */
 487                         skb->mark &= ~bat_priv->isolation_mark_mask;
 488                         skb->mark |= bat_priv->isolation_mark;
 489                 }
 490         } else if (batadv_is_ap_isolated(bat_priv, ethhdr->h_source,
 491                                          ethhdr->h_dest, vid)) {
 492                 goto dropped;
 493         }
 494
 495         netif_rx(skb);
 496         goto out;
 497
 498 dropped:
 499         kfree_skb(skb);
 500 out:
 501         return;
 502 }
 503
 504 /**
 505  * batadv_softif_vlan_release() - release vlan from lists and queue for free
 506  *  after rcu grace period
 507  * @ref: kref pointer of the vlan object
 508  */
 509 void batadv_softif_vlan_release(struct kref *ref)
 510 {
 511         struct batadv_softif_vlan *vlan;
 512
 513         vlan = container_of(ref, struct batadv_softif_vlan, refcount);
 514
 515         spin_lock_bh(&vlan->bat_priv->softif_vlan_list_lock);
 516         hlist_del_rcu(&vlan->list);
 517         spin_unlock_bh(&vlan->bat_priv->softif_vlan_list_lock);
 518
 519         kfree_rcu(vlan, rcu);
 520 }
 521
 522 /**
 523  * batadv_softif_vlan_get() - get the vlan object for a specific vid
 524  * @bat_priv: the bat priv with all the soft interface information
 525  * @vid: the identifier of the vlan object to retrieve
 526  *
 527  * Return: the private data of the vlan matching the vid passed as argument or
 528  * NULL otherwise. The refcounter of the returned object is incremented by 1.
 529  */
 530 struct batadv_softif_vlan *batadv_softif_vlan_get(struct batadv_priv *bat_priv,
 531                                                   unsigned short vid)
 532 {
 533         struct batadv_softif_vlan *vlan_tmp, *vlan = NULL;
 534
 535         rcu_read_lock();
 536         hlist_for_each_entry_rcu(vlan_tmp, &bat_priv->softif_vlan_list, list) {
 537                 if (vlan_tmp->vid != vid)
 538                         continue;
 539
 540                 if (!kref_get_unless_zero(&vlan_tmp->refcount))
 541                         continue;
 542
 543                 vlan = vlan_tmp;
 544                 break;
 545         }
 546         rcu_read_unlock();
 547
 548         return vlan;
 549 }
 550
 551 /**
 552  * batadv_softif_create_vlan() - allocate the needed resources for a new vlan
 553  * @bat_priv: the bat priv with all the soft interface information
 554  * @vid: the VLAN identifier
 555  *
 556  * Return: 0 on success, a negative error otherwise.
 557  */
 558 int batadv_softif_create_vlan(struct batadv_priv *bat_priv, unsigned short vid)
 559 {
 560         struct batadv_softif_vlan *vlan;
 561
 562         spin_lock_bh(&bat_priv->softif_vlan_list_lock);
 563
 564         vlan = batadv_softif_vlan_get(bat_priv, vid);
 565         if (vlan) {
 566                 batadv_softif_vlan_put(vlan);
 567                 spin_unlock_bh(&bat_priv->softif_vlan_list_lock);
 568                 return -EEXIST;
 569         }
 570
 571         vlan = kzalloc(sizeof(*vlan), GFP_ATOMIC);
 572         if (!vlan) {
 573                 spin_unlock_bh(&bat_priv->softif_vlan_list_lock);
 574                 return -ENOMEM;
 575         }
 576
 577         vlan->bat_priv = bat_priv;
 578         vlan->vid = vid;
 579         kref_init(&vlan->refcount);
 580
 581         atomic_set(&vlan->ap_isolation, 0);
 582
 583         kref_get(&vlan->refcount);
 584         hlist_add_head_rcu(&vlan->list, &bat_priv->softif_vlan_list);
 585         spin_unlock_bh(&bat_priv->softif_vlan_list_lock);
 586
 587         /* add a new TT local entry. This one will be marked with the NOPURGE
 588          * flag
 589          */
 590         batadv_tt_local_add(bat_priv->soft_iface,
 591                             bat_priv->soft_iface->dev_addr, vid,
 592                             BATADV_NULL_IFINDEX, BATADV_NO_MARK);
 593
 594         /* don't return reference to new softif_vlan */
 595         batadv_softif_vlan_put(vlan);
 596
 597         return 0;
 598 }
 599
 600 /**
 601  * batadv_softif_destroy_vlan() - remove and destroy a softif_vlan object
 602  * @bat_priv: the bat priv with all the soft interface information
 603  * @vlan: the object to remove
 604  */
 605 static void batadv_softif_destroy_vlan(struct batadv_priv *bat_priv,
 606                                        struct batadv_softif_vlan *vlan)
 607 {
 608         /* explicitly remove the associated TT local entry because it is marked
 609          * with the NOPURGE flag
 610          */
 611         batadv_tt_local_remove(bat_priv, bat_priv->soft_iface->dev_addr,
 612                                vlan->vid, "vlan interface destroyed", false);
 613
 614         batadv_softif_vlan_put(vlan);
 615 }
 616
 617 /**
 618  * batadv_interface_add_vid() - ndo_add_vid API implementation
 619  * @dev: the netdev of the mesh interface
 620  * @proto: protocol of the vlan id
 621  * @vid: identifier of the new vlan
 622  *
 623  * Set up all the internal structures for handling the new vlan on top of the
 624  * mesh interface
 625  *
 626  * Return: 0 on success or a negative error code in case of failure.
 627  */
 628 static int batadv_interface_add_vid(struct net_device *dev, __be16 proto,
 629                                     unsigned short vid)
 630 {
 631         struct batadv_priv *bat_priv = netdev_priv(dev);
 632         struct batadv_softif_vlan *vlan;
 633
 634         /* only 802.1Q vlans are supported.
 635          * batman-adv does not know how to handle other types
 636          */
 637         if (proto != htons(ETH_P_8021Q))
 638                 return -EINVAL;
 639
 640         /* VID 0 is only used to indicate "priority tag" frames which only
 641          * contain priority information and no VID. No management structures
 642          * should be created for this VID and it should be handled like an
 643          * untagged frame.
 644          */
 645         if (vid == 0)
 646                 return 0;
 647
 648         vid |= BATADV_VLAN_HAS_TAG;
 649
 650         /* if a new vlan is getting created and it already exists, it means that
 651          * it was not deleted yet. batadv_softif_vlan_get() increases the
 652          * refcount in order to revive the object.
 653          *
 654          * if it does not exist then create it.
 655          */
 656         vlan = batadv_softif_vlan_get(bat_priv, vid);
 657         if (!vlan)
 658                 return batadv_softif_create_vlan(bat_priv, vid);
 659
 660         /* add a new TT local entry. This one will be marked with the NOPURGE
 661          * flag. This must be added again, even if the vlan object already
 662          * exists, because the entry was deleted by kill_vid()
 663          */
 664         batadv_tt_local_add(bat_priv->soft_iface,
 665                             bat_priv->soft_iface->dev_addr, vid,
 666                             BATADV_NULL_IFINDEX, BATADV_NO_MARK);
 667
 668         return 0;
 669 }
 670
 671 /**
 672  * batadv_interface_kill_vid() - ndo_kill_vid API implementation
 673  * @dev: the netdev of the mesh interface
 674  * @proto: protocol of the vlan id
 675  * @vid: identifier of the deleted vlan
 676  *
 677  * Destroy all the internal structures used to handle the vlan identified by vid
 678  * on top of the mesh interface
 679  *
 680  * Return: 0 on success, -EINVAL if the specified prototype is not ETH_P_8021Q
 681  * or -ENOENT if the specified vlan id wasn't registered.
 682  */
 683 static int batadv_interface_kill_vid(struct net_device *dev, __be16 proto,
 684                                      unsigned short vid)
 685 {
 686         struct batadv_priv *bat_priv = netdev_priv(dev);
 687         struct batadv_softif_vlan *vlan;
 688
 689         /* only 802.1Q vlans are supported. batman-adv does not know how to
 690          * handle other types
 691          */
 692         if (proto != htons(ETH_P_8021Q))
 693                 return -EINVAL;
 694
 695         /* "priority tag" frames are handled like "untagged" frames
 696          * and no softif_vlan needs to be destroyed
 697          */
 698         if (vid == 0)
 699                 return 0;
 700
 701         vlan = batadv_softif_vlan_get(bat_priv, vid | BATADV_VLAN_HAS_TAG);
 702         if (!vlan)
 703                 return -ENOENT;
 704
 705         batadv_softif_destroy_vlan(bat_priv, vlan);
 706
 707         /* finally free the vlan object */
 708         batadv_softif_vlan_put(vlan);
 709
 710         return 0;
 711 }
 712
 713 /* batman-adv network devices have devices nesting below it and are a special
 714  * "super class" of normal network devices; split their locks off into a
 715  * separate class since they always nest.
 716  */
 717 static struct lock_class_key batadv_netdev_xmit_lock_key;
 718 static struct lock_class_key batadv_netdev_addr_lock_key;
 719
 720 /**
 721  * batadv_set_lockdep_class_one() - Set lockdep class for a single tx queue
 722  * @dev: device which owns the tx queue
 723  * @txq: tx queue to modify
 724  * @_unused: always NULL
 725  */
 726 static void batadv_set_lockdep_class_one(struct net_device *dev,
 727                                          struct netdev_queue *txq,
 728                                          void *_unused)
 729 {
 730         lockdep_set_class(&txq->_xmit_lock, &batadv_netdev_xmit_lock_key);
 731 }
 732
 733 /**
 734  * batadv_set_lockdep_class() - Set txq and addr_list lockdep class
 735  * @dev: network device to modify
 736  */
 737 static void batadv_set_lockdep_class(struct net_device *dev)
 738 {
 739         lockdep_set_class(&dev->addr_list_lock, &batadv_netdev_addr_lock_key);
 740         netdev_for_each_tx_queue(dev, batadv_set_lockdep_class_one, NULL);
 741 }
 742
 743 /**
 744  * batadv_softif_init_late() - late stage initialization of soft interface
 745  * @dev: registered network device to modify
 746  *
 747  * Return: error code on failures
 748  */
 749 static int batadv_softif_init_late(struct net_device *dev)
 750 {
 751         struct batadv_priv *bat_priv;
 752         u32 random_seqno;
 753         int ret;
 754         size_t cnt_len = sizeof(u64) * BATADV_CNT_NUM;
 755
 756         batadv_set_lockdep_class(dev);
 757
 758         bat_priv = netdev_priv(dev);
 759         bat_priv->soft_iface = dev;
 760
 761         /* batadv_interface_stats() needs to be available as soon as
 762          * register_netdevice() has been called
 763          */
 764         bat_priv->bat_counters = __alloc_percpu(cnt_len, __alignof__(u64));
 765         if (!bat_priv->bat_counters)
 766                 return -ENOMEM;
 767
 768         atomic_set(&bat_priv->aggregated_ogms, 1);
 769         atomic_set(&bat_priv->bonding, 0);
 770 #ifdef CONFIG_BATMAN_ADV_BLA
 771         atomic_set(&bat_priv->bridge_loop_avoidance, 1);
 772 #endif
 773 #ifdef CONFIG_BATMAN_ADV_DAT
 774         atomic_set(&bat_priv->distributed_arp_table, 1);
 775 #endif
 776 #ifdef CONFIG_BATMAN_ADV_MCAST
 777         atomic_set(&bat_priv->multicast_mode, 1);
 778         atomic_set(&bat_priv->multicast_fanout, 16);
 779         atomic_set(&bat_priv->mcast.num_want_all_unsnoopables, 0);
 780         atomic_set(&bat_priv->mcast.num_want_all_ipv4, 0);
 781         atomic_set(&bat_priv->mcast.num_want_all_ipv6, 0);
 782         atomic_set(&bat_priv->mcast.num_no_mc_ptype_capa, 0);
 783 #endif
 784         atomic_set(&bat_priv->gw.mode, BATADV_GW_MODE_OFF);
 785         atomic_set(&bat_priv->gw.bandwidth_down, 100);
 786         atomic_set(&bat_priv->gw.bandwidth_up, 20);
 787         atomic_set(&bat_priv->orig_interval, 1000);
 788         atomic_set(&bat_priv->hop_penalty, 30);
 789 #ifdef CONFIG_BATMAN_ADV_DEBUG
 790         atomic_set(&bat_priv->log_level, 0);
 791 #endif
 792         atomic_set(&bat_priv->fragmentation, 1);
 793         atomic_set(&bat_priv->packet_size_max, ETH_DATA_LEN);
 794         atomic_set(&bat_priv->bcast_queue_left, BATADV_BCAST_QUEUE_LEN);
 795         atomic_set(&bat_priv->batman_queue_left, BATADV_BATMAN_QUEUE_LEN);
 796
 797         atomic_set(&bat_priv->mesh_state, BATADV_MESH_INACTIVE);
 798         atomic_set(&bat_priv->bcast_seqno, 1);
 799         atomic_set(&bat_priv->tt.vn, 0);
 800         atomic_set(&bat_priv->tt.ogm_append_cnt, 0);
 801 #ifdef CONFIG_BATMAN_ADV_BLA
 802         atomic_set(&bat_priv->bla.num_requests, 0);
 803 #endif
 804         atomic_set(&bat_priv->tp_num, 0);
 805
 806         WRITE_ONCE(bat_priv->tt.local_changes, 0);
 807         bat_priv->tt.last_changeset = NULL;
 808         bat_priv->tt.last_changeset_len = 0;
 809         bat_priv->isolation_mark = 0;
 810         bat_priv->isolation_mark_mask = 0;
 811
 812         /* randomize initial seqno to avoid collision */
 813         get_random_bytes(&random_seqno, sizeof(random_seqno));
 814         atomic_set(&bat_priv->frag_seqno, random_seqno);
 815
 816         bat_priv->primary_if = NULL;
 817
 818         batadv_nc_init_bat_priv(bat_priv);
 819
 820         if (!bat_priv->algo_ops) {
 821                 ret = batadv_algo_select(bat_priv, batadv_routing_algo);
 822                 if (ret < 0)
 823                         goto free_bat_counters;
 824         }
 825
 826         ret = batadv_mesh_init(dev);
 827         if (ret < 0)
 828                 goto free_bat_counters;
 829
 830         return 0;
 831
 832 free_bat_counters:
 833         free_percpu(bat_priv->bat_counters);
 834         bat_priv->bat_counters = NULL;
 835
 836         return ret;
 837 }
 838
 839 /**
 840  * batadv_softif_slave_add() - Add a slave interface to a batadv_soft_interface
 841  * @dev: batadv_soft_interface used as master interface
 842  * @slave_dev: net_device which should become the slave interface
 843  * @extack: extended ACK report struct
 844  *
 845  * Return: 0 if successful or error otherwise.
 846  */
 847 static int batadv_softif_slave_add(struct net_device *dev,
 848                                    struct net_device *slave_dev,
 849                                    struct netlink_ext_ack *extack)
 850 {
 851         struct batadv_hard_iface *hard_iface;
 852         int ret = -EINVAL;
 853
 854         hard_iface = batadv_hardif_get_by_netdev(slave_dev);
 855         if (!hard_iface || hard_iface->soft_iface)
 856                 goto out;
 857
 858         ret = batadv_hardif_enable_interface(hard_iface, dev);
 859
 860 out:
 861         batadv_hardif_put(hard_iface);
 862         return ret;
 863 }
 864
 865 /**
 866  * batadv_softif_slave_del() - Delete a slave iface from a batadv_soft_interface
 867  * @dev: batadv_soft_interface used as master interface
 868  * @slave_dev: net_device which should be removed from the master interface
 869  *
 870  * Return: 0 if successful or error otherwise.
 871  */
 872 static int batadv_softif_slave_del(struct net_device *dev,
 873                                    struct net_device *slave_dev)
 874 {
 875         struct batadv_hard_iface *hard_iface;
 876         int ret = -EINVAL;
 877
 878         hard_iface = batadv_hardif_get_by_netdev(slave_dev);
 879
 880         if (!hard_iface || hard_iface->soft_iface != dev)
 881                 goto out;
 882
 883         batadv_hardif_disable_interface(hard_iface);
 884         ret = 0;
 885
 886 out:
 887         batadv_hardif_put(hard_iface);
 888         return ret;
 889 }
 890
 891 static const struct net_device_ops batadv_netdev_ops = {
 892         .ndo_init = batadv_softif_init_late,
 893         .ndo_open = batadv_interface_open,
 894         .ndo_stop = batadv_interface_release,
 895         .ndo_get_stats = batadv_interface_stats,
 896         .ndo_vlan_rx_add_vid = batadv_interface_add_vid,
 897         .ndo_vlan_rx_kill_vid = batadv_interface_kill_vid,
 898         .ndo_set_mac_address = batadv_interface_set_mac_addr,
 899         .ndo_change_mtu = batadv_interface_change_mtu,
 900         .ndo_set_rx_mode = batadv_interface_set_rx_mode,
 901         .ndo_start_xmit = batadv_interface_tx,
 902         .ndo_validate_addr = eth_validate_addr,
 903         .ndo_add_slave = batadv_softif_slave_add,
 904         .ndo_del_slave = batadv_softif_slave_del,
 905 };
 906
 907 static void batadv_get_drvinfo(struct net_device *dev,
 908                                struct ethtool_drvinfo *info)
 909 {
 910         strscpy(info->driver, "B.A.T.M.A.N. advanced", sizeof(info->driver));
 911         strscpy(info->version, BATADV_SOURCE_VERSION, sizeof(info->version));
 912         strscpy(info->fw_version, "N/A", sizeof(info->fw_version));
 913         strscpy(info->bus_info, "batman", sizeof(info->bus_info));
 914 }
 915
 916 /* Inspired by drivers/net/ethernet/dlink/sundance.c:1702
 917  * Declare each description string in struct.name[] to get fixed sized buffer
 918  * and compile time checking for strings longer than ETH_GSTRING_LEN.
 919  */
 920 static const struct {
 921         const char name[ETH_GSTRING_LEN];
 922 } batadv_counters_strings[] = {
 923         { "tx" },
 924         { "tx_bytes" },
 925         { "tx_dropped" },
 926         { "rx" },
 927         { "rx_bytes" },
 928         { "forward" },
 929         { "forward_bytes" },
 930         { "mgmt_tx" },
 931         { "mgmt_tx_bytes" },
 932         { "mgmt_rx" },
 933         { "mgmt_rx_bytes" },
 934         { "frag_tx" },
 935         { "frag_tx_bytes" },
 936         { "frag_rx" },
 937         { "frag_rx_bytes" },
 938         { "frag_fwd" },
 939         { "frag_fwd_bytes" },
 940         { "tt_request_tx" },
 941         { "tt_request_rx" },
 942         { "tt_response_tx" },
 943         { "tt_response_rx" },
 944         { "tt_roam_adv_tx" },
 945         { "tt_roam_adv_rx" },
 946 #ifdef CONFIG_BATMAN_ADV_MCAST
 947         { "mcast_tx" },
 948         { "mcast_tx_bytes" },
 949         { "mcast_tx_local" },
 950         { "mcast_tx_local_bytes" },
 951         { "mcast_rx" },
 952         { "mcast_rx_bytes" },
 953         { "mcast_rx_local" },
 954         { "mcast_rx_local_bytes" },
 955         { "mcast_fwd" },
 956         { "mcast_fwd_bytes" },
 957 #endif
 958 #ifdef CONFIG_BATMAN_ADV_DAT
 959         { "dat_get_tx" },
 960         { "dat_get_rx" },
 961         { "dat_put_tx" },
 962         { "dat_put_rx" },
 963         { "dat_cached_reply_tx" },
 964 #endif
 965 #ifdef CONFIG_BATMAN_ADV_NC
 966         { "nc_code" },
 967         { "nc_code_bytes" },
 968         { "nc_recode" },
 969         { "nc_recode_bytes" },
 970         { "nc_buffer" },
 971         { "nc_decode" },
 972         { "nc_decode_bytes" },
 973         { "nc_decode_failed" },
 974         { "nc_sniffed" },
 975 #endif
 976 };
 977
 978 static void batadv_get_strings(struct net_device *dev, u32 stringset, u8 *data)
 979 {
 980         if (stringset == ETH_SS_STATS)
 981                 memcpy(data, batadv_counters_strings,
 982                        sizeof(batadv_counters_strings));
 983 }
 984
 985 static void batadv_get_ethtool_stats(struct net_device *dev,
 986                                      struct ethtool_stats *stats, u64 *data)
 987 {
 988         struct batadv_priv *bat_priv = netdev_priv(dev);
 989         int i;
 990
 991         for (i = 0; i < BATADV_CNT_NUM; i++)
 992                 data[i] = batadv_sum_counter(bat_priv, i);
 993 }
 994
 995 static int batadv_get_sset_count(struct net_device *dev, int stringset)
 996 {
 997         if (stringset == ETH_SS_STATS)
 998                 return BATADV_CNT_NUM;
 999
1000         return -EOPNOTSUPP;
1001 }
1002
1003 static const struct ethtool_ops batadv_ethtool_ops = {
1004         .get_drvinfo = batadv_get_drvinfo,
1005         .get_link = ethtool_op_get_link,
1006         .get_strings = batadv_get_strings,
1007         .get_ethtool_stats = batadv_get_ethtool_stats,
1008         .get_sset_count = batadv_get_sset_count,
1009 };
1010
1011 /**
1012  * batadv_softif_free() - Deconstructor of batadv_soft_interface
1013  * @dev: Device to cleanup and remove
1014  */
1015 static void batadv_softif_free(struct net_device *dev)
1016 {
1017         batadv_mesh_free(dev);
1018
1019         /* some scheduled RCU callbacks need the bat_priv struct to accomplish
1020          * their tasks. Wait for them all to be finished before freeing the
1021          * netdev and its private data (bat_priv)
1022          */
1023         rcu_barrier();
1024 }
1025
1026 /**
1027  * batadv_softif_init_early() - early stage initialization of soft interface
1028  * @dev: registered network device to modify
1029  */
1030 static void batadv_softif_init_early(struct net_device *dev)
1031 {
1032         ether_setup(dev);
1033
1034         dev->netdev_ops = &batadv_netdev_ops;
1035         dev->needs_free_netdev = true;
1036         dev->priv_destructor = batadv_softif_free;
1037         dev->features |= NETIF_F_HW_VLAN_CTAG_FILTER;
1038         dev->priv_flags |= IFF_NO_QUEUE;
1039         dev->lltx = true;
1040         dev->netns_local = true;
1041
1042         /* can't call min_mtu, because the needed variables
1043          * have not been initialized yet
1044          */
1045         dev->mtu = ETH_DATA_LEN;
1046
1047         /* generate random address */
1048         eth_hw_addr_random(dev);
1049
1050         dev->ethtool_ops = &batadv_ethtool_ops;
1051 }
1052
1053 /**
1054  * batadv_softif_validate() - validate configuration of new batadv link
1055  * @tb: IFLA_INFO_DATA netlink attributes
1056  * @data: enum batadv_ifla_attrs attributes
1057  * @extack: extended ACK report struct
1058  *
1059  * Return: 0 if successful or error otherwise.
1060  */
1061 static int batadv_softif_validate(struct nlattr *tb[], struct nlattr *data[],
1062                                   struct netlink_ext_ack *extack)
1063 {
1064         struct batadv_algo_ops *algo_ops;
1065
1066         if (!data)
1067                 return 0;
1068
1069         if (data[IFLA_BATADV_ALGO_NAME]) {
1070                 algo_ops = batadv_algo_get(nla_data(data[IFLA_BATADV_ALGO_NAME]));
1071                 if (!algo_ops)
1072                         return -EINVAL;
1073         }
1074
1075         return 0;
1076 }
1077
1078 /**
1079  * batadv_softif_newlink() - pre-initialize and register new batadv link
1080  * @src_net: the applicable net namespace
1081  * @dev: network device to register
1082  * @tb: IFLA_INFO_DATA netlink attributes
1083  * @data: enum batadv_ifla_attrs attributes
1084  * @extack: extended ACK report struct
1085  *
1086  * Return: 0 if successful or error otherwise.
1087  */
1088 static int batadv_softif_newlink(struct net *src_net, struct net_device *dev,
1089                                  struct nlattr *tb[], struct nlattr *data[],
1090                                  struct netlink_ext_ack *extack)
1091 {
1092         struct batadv_priv *bat_priv = netdev_priv(dev);
1093         const char *algo_name;
1094         int err;
1095
1096         if (data && data[IFLA_BATADV_ALGO_NAME]) {
1097                 algo_name = nla_data(data[IFLA_BATADV_ALGO_NAME]);
1098                 err = batadv_algo_select(bat_priv, algo_name);
1099                 if (err)
1100                         return -EINVAL;
1101         }
1102
1103         return register_netdevice(dev);
1104 }
1105
1106 /**
1107  * batadv_softif_destroy_netlink() - deletion of batadv_soft_interface via
1108  *  netlink
1109  * @soft_iface: the to-be-removed batman-adv interface
1110  * @head: list pointer
1111  */
1112 static void batadv_softif_destroy_netlink(struct net_device *soft_iface,
1113                                           struct list_head *head)
1114 {
1115         struct batadv_priv *bat_priv = netdev_priv(soft_iface);
1116         struct batadv_hard_iface *hard_iface;
1117         struct batadv_softif_vlan *vlan;
1118
1119         list_for_each_entry(hard_iface, &batadv_hardif_list, list) {
1120                 if (hard_iface->soft_iface == soft_iface)
1121                         batadv_hardif_disable_interface(hard_iface);
1122         }
1123
1124         /* destroy the "untagged" VLAN */
1125         vlan = batadv_softif_vlan_get(bat_priv, BATADV_NO_FLAGS);
1126         if (vlan) {
1127                 batadv_softif_destroy_vlan(bat_priv, vlan);
1128                 batadv_softif_vlan_put(vlan);
1129         }
1130
1131         unregister_netdevice_queue(soft_iface, head);
1132 }
1133
1134 /**
1135  * batadv_softif_is_valid() - Check whether device is a batadv soft interface
1136  * @net_dev: device which should be checked
1137  *
1138  * Return: true when net_dev is a batman-adv interface, false otherwise
1139  */
1140 bool batadv_softif_is_valid(const struct net_device *net_dev)
1141 {
1142         if (net_dev->netdev_ops->ndo_start_xmit == batadv_interface_tx)
1143                 return true;
1144
1145         return false;
1146 }
1147
1148 static const struct nla_policy batadv_ifla_policy[IFLA_BATADV_MAX + 1] = {
1149         [IFLA_BATADV_ALGO_NAME] = { .type = NLA_NUL_STRING },
1150 };
1151
1152 struct rtnl_link_ops batadv_link_ops __read_mostly = {
1153         .kind           = "batadv",
1154         .priv_size      = sizeof(struct batadv_priv),
1155         .setup          = batadv_softif_init_early,
1156         .maxtype        = IFLA_BATADV_MAX,
1157         .policy         = batadv_ifla_policy,
1158         .validate       = batadv_softif_validate,
1159         .newlink        = batadv_softif_newlink,
1160         .dellink        = batadv_softif_destroy_netlink,
1161 };