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