net/batman-adv/send.c

   1 /* Copyright (C) 2007-2017  B.A.T.M.A.N. contributors:
   2  *
   3  * Marek Lindner, Simon Wunderlich
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of version 2 of the GNU General Public
   7  * License as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #include "send.h"
  19 #include "main.h"
  20
  21 #include <linux/atomic.h>
  22 #include <linux/bug.h>
  23 #include <linux/byteorder/generic.h>
  24 #include <linux/errno.h>
  25 #include <linux/etherdevice.h>
  26 #include <linux/fs.h>
  27 #include <linux/if.h>
  28 #include <linux/if_ether.h>
  29 #include <linux/jiffies.h>
  30 #include <linux/kernel.h>
  31 #include <linux/kref.h>
  32 #include <linux/list.h>
  33 #include <linux/netdevice.h>
  34 #include <linux/printk.h>
  35 #include <linux/rculist.h>
  36 #include <linux/rcupdate.h>
  37 #include <linux/skbuff.h>
  38 #include <linux/slab.h>
  39 #include <linux/spinlock.h>
  40 #include <linux/stddef.h>
  41 #include <linux/workqueue.h>
  42
  43 #include "distributed-arp-table.h"
  44 #include "fragmentation.h"
  45 #include "gateway_client.h"
  46 #include "hard-interface.h"
  47 #include "log.h"
  48 #include "network-coding.h"
  49 #include "originator.h"
  50 #include "routing.h"
  51 #include "soft-interface.h"
  52 #include "translation-table.h"
  53
  54 static void batadv_send_outstanding_bcast_packet(struct work_struct *work);
  55
  56 /**
  57  * batadv_send_skb_packet - send an already prepared packet
  58  * @skb: the packet to send
  59  * @hard_iface: the interface to use to send the broadcast packet
  60  * @dst_addr: the payload destination
  61  *
  62  * Send out an already prepared packet to the given neighbor or broadcast it
  63  * using the specified interface. Either hard_iface or neigh_node must be not
  64  * NULL.
  65  * If neigh_node is NULL, then the packet is broadcasted using hard_iface,
  66  * otherwise it is sent as unicast to the given neighbor.
  67  *
  68  * Regardless of the return value, the skb is consumed.
  69  *
  70  * Return: A negative errno code is returned on a failure. A success does not
  71  * guarantee the frame will be transmitted as it may be dropped due
  72  * to congestion or traffic shaping.
  73  */
  74 int batadv_send_skb_packet(struct sk_buff *skb,
  75                            struct batadv_hard_iface *hard_iface,
  76                            const u8 *dst_addr)
  77 {
  78         struct batadv_priv *bat_priv;
  79         struct ethhdr *ethhdr;
  80         int ret;
  81
  82         bat_priv = netdev_priv(hard_iface->soft_iface);
  83
  84         if (hard_iface->if_status != BATADV_IF_ACTIVE)
  85                 goto send_skb_err;
  86
  87         if (unlikely(!hard_iface->net_dev))
  88                 goto send_skb_err;
  89
  90         if (!(hard_iface->net_dev->flags & IFF_UP)) {
  91                 pr_warn("Interface %s is not up - can't send packet via that interface!\n",
  92                         hard_iface->net_dev->name);
  93                 goto send_skb_err;
  94         }
  95
  96         /* push to the ethernet header. */
  97         if (batadv_skb_head_push(skb, ETH_HLEN) < 0)
  98                 goto send_skb_err;
  99
 100         skb_reset_mac_header(skb);
 101
 102         ethhdr = eth_hdr(skb);
 103         ether_addr_copy(ethhdr->h_source, hard_iface->net_dev->dev_addr);
 104         ether_addr_copy(ethhdr->h_dest, dst_addr);
 105         ethhdr->h_proto = htons(ETH_P_BATMAN);
 106
 107         skb_set_network_header(skb, ETH_HLEN);
 108         skb->protocol = htons(ETH_P_BATMAN);
 109
 110         skb->dev = hard_iface->net_dev;
 111
 112         /* Save a clone of the skb to use when decoding coded packets */
 113         batadv_nc_skb_store_for_decoding(bat_priv, skb);
 114
 115         /* dev_queue_xmit() returns a negative result on error.  However on
 116          * congestion and traffic shaping, it drops and returns NET_XMIT_DROP
 117          * (which is > 0). This will not be treated as an error.
 118          */
 119         ret = dev_queue_xmit(skb);
 120         return net_xmit_eval(ret);
 121 send_skb_err:
 122         kfree_skb(skb);
 123         return NET_XMIT_DROP;
 124 }
 125
 126 int batadv_send_broadcast_skb(struct sk_buff *skb,
 127                               struct batadv_hard_iface *hard_iface)
 128 {
 129         return batadv_send_skb_packet(skb, hard_iface, batadv_broadcast_addr);
 130 }
 131
 132 int batadv_send_unicast_skb(struct sk_buff *skb,
 133                             struct batadv_neigh_node *neigh)
 134 {
 135 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
 136         struct batadv_hardif_neigh_node *hardif_neigh;
 137 #endif
 138         int ret;
 139
 140         ret = batadv_send_skb_packet(skb, neigh->if_incoming, neigh->addr);
 141
 142 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
 143         hardif_neigh = batadv_hardif_neigh_get(neigh->if_incoming, neigh->addr);
 144
 145         if ((hardif_neigh) && (ret != NET_XMIT_DROP))
 146                 hardif_neigh->bat_v.last_unicast_tx = jiffies;
 147
 148         if (hardif_neigh)
 149                 batadv_hardif_neigh_put(hardif_neigh);
 150 #endif
 151
 152         return ret;
 153 }
 154
 155 /**
 156  * batadv_send_skb_to_orig - Lookup next-hop and transmit skb.
 157  * @skb: Packet to be transmitted.
 158  * @orig_node: Final destination of the packet.
 159  * @recv_if: Interface used when receiving the packet (can be NULL).
 160  *
 161  * Looks up the best next-hop towards the passed originator and passes the
 162  * skb on for preparation of MAC header. If the packet originated from this
 163  * host, NULL can be passed as recv_if and no interface alternating is
 164  * attempted.
 165  *
 166  * Return: negative errno code on a failure, -EINPROGRESS if the skb is
 167  * buffered for later transmit or the NET_XMIT status returned by the
 168  * lower routine if the packet has been passed down.
 169  */
 170 int batadv_send_skb_to_orig(struct sk_buff *skb,
 171                             struct batadv_orig_node *orig_node,
 172                             struct batadv_hard_iface *recv_if)
 173 {
 174         struct batadv_priv *bat_priv = orig_node->bat_priv;
 175         struct batadv_neigh_node *neigh_node;
 176         int ret;
 177
 178         /* batadv_find_router() increases neigh_nodes refcount if found. */
 179         neigh_node = batadv_find_router(bat_priv, orig_node, recv_if);
 180         if (!neigh_node) {
 181                 ret = -EINVAL;
 182                 goto free_skb;
 183         }
 184
 185         /* Check if the skb is too large to send in one piece and fragment
 186          * it if needed.
 187          */
 188         if (atomic_read(&bat_priv->fragmentation) &&
 189             skb->len > neigh_node->if_incoming->net_dev->mtu) {
 190                 /* Fragment and send packet. */
 191                 ret = batadv_frag_send_packet(skb, orig_node, neigh_node);
 192                 /* skb was consumed */
 193                 skb = NULL;
 194
 195                 goto put_neigh_node;
 196         }
 197
 198         /* try to network code the packet, if it is received on an interface
 199          * (i.e. being forwarded). If the packet originates from this node or if
 200          * network coding fails, then send the packet as usual.
 201          */
 202         if (recv_if && batadv_nc_skb_forward(skb, neigh_node))
 203                 ret = -EINPROGRESS;
 204         else
 205                 ret = batadv_send_unicast_skb(skb, neigh_node);
 206
 207         /* skb was consumed */
 208         skb = NULL;
 209
 210 put_neigh_node:
 211         batadv_neigh_node_put(neigh_node);
 212 free_skb:
 213         kfree_skb(skb);
 214
 215         return ret;
 216 }
 217
 218 /**
 219  * batadv_send_skb_push_fill_unicast - extend the buffer and initialize the
 220  *  common fields for unicast packets
 221  * @skb: the skb carrying the unicast header to initialize
 222  * @hdr_size: amount of bytes to push at the beginning of the skb
 223  * @orig_node: the destination node
 224  *
 225  * Return: false if the buffer extension was not possible or true otherwise.
 226  */
 227 static bool
 228 batadv_send_skb_push_fill_unicast(struct sk_buff *skb, int hdr_size,
 229                                   struct batadv_orig_node *orig_node)
 230 {
 231         struct batadv_unicast_packet *unicast_packet;
 232         u8 ttvn = (u8)atomic_read(&orig_node->last_ttvn);
 233
 234         if (batadv_skb_head_push(skb, hdr_size) < 0)
 235                 return false;
 236
 237         unicast_packet = (struct batadv_unicast_packet *)skb->data;
 238         unicast_packet->version = BATADV_COMPAT_VERSION;
 239         /* batman packet type: unicast */
 240         unicast_packet->packet_type = BATADV_UNICAST;
 241         /* set unicast ttl */
 242         unicast_packet->ttl = BATADV_TTL;
 243         /* copy the destination for faster routing */
 244         ether_addr_copy(unicast_packet->dest, orig_node->orig);
 245         /* set the destination tt version number */
 246         unicast_packet->ttvn = ttvn;
 247
 248         return true;
 249 }
 250
 251 /**
 252  * batadv_send_skb_prepare_unicast - encapsulate an skb with a unicast header
 253  * @skb: the skb containing the payload to encapsulate
 254  * @orig_node: the destination node
 255  *
 256  * Return: false if the payload could not be encapsulated or true otherwise.
 257  */
 258 static bool batadv_send_skb_prepare_unicast(struct sk_buff *skb,
 259                                             struct batadv_orig_node *orig_node)
 260 {
 261         size_t uni_size = sizeof(struct batadv_unicast_packet);
 262
 263         return batadv_send_skb_push_fill_unicast(skb, uni_size, orig_node);
 264 }
 265
 266 /**
 267  * batadv_send_skb_prepare_unicast_4addr - encapsulate an skb with a
 268  *  unicast 4addr header
 269  * @bat_priv: the bat priv with all the soft interface information
 270  * @skb: the skb containing the payload to encapsulate
 271  * @orig: the destination node
 272  * @packet_subtype: the unicast 4addr packet subtype to use
 273  *
 274  * Return: false if the payload could not be encapsulated or true otherwise.
 275  */
 276 bool batadv_send_skb_prepare_unicast_4addr(struct batadv_priv *bat_priv,
 277                                            struct sk_buff *skb,
 278                                            struct batadv_orig_node *orig,
 279                                            int packet_subtype)
 280 {
 281         struct batadv_hard_iface *primary_if;
 282         struct batadv_unicast_4addr_packet *uc_4addr_packet;
 283         bool ret = false;
 284
 285         primary_if = batadv_primary_if_get_selected(bat_priv);
 286         if (!primary_if)
 287                 goto out;
 288
 289         /* Pull the header space and fill the unicast_packet substructure.
 290          * We can do that because the first member of the uc_4addr_packet
 291          * is of type struct unicast_packet
 292          */
 293         if (!batadv_send_skb_push_fill_unicast(skb, sizeof(*uc_4addr_packet),
 294                                                orig))
 295                 goto out;
 296
 297         uc_4addr_packet = (struct batadv_unicast_4addr_packet *)skb->data;
 298         uc_4addr_packet->u.packet_type = BATADV_UNICAST_4ADDR;
 299         ether_addr_copy(uc_4addr_packet->src, primary_if->net_dev->dev_addr);
 300         uc_4addr_packet->subtype = packet_subtype;
 301         uc_4addr_packet->reserved = 0;
 302
 303         ret = true;
 304 out:
 305         if (primary_if)
 306                 batadv_hardif_put(primary_if);
 307         return ret;
 308 }
 309
 310 /**
 311  * batadv_send_skb_unicast - encapsulate and send an skb via unicast
 312  * @bat_priv: the bat priv with all the soft interface information
 313  * @skb: payload to send
 314  * @packet_type: the batman unicast packet type to use
 315  * @packet_subtype: the unicast 4addr packet subtype (only relevant for unicast
 316  *  4addr packets)
 317  * @orig_node: the originator to send the packet to
 318  * @vid: the vid to be used to search the translation table
 319  *
 320  * Wrap the given skb into a batman-adv unicast or unicast-4addr header
 321  * depending on whether BATADV_UNICAST or BATADV_UNICAST_4ADDR was supplied
 322  * as packet_type. Then send this frame to the given orig_node.
 323  *
 324  * Return: NET_XMIT_DROP in case of error or NET_XMIT_SUCCESS otherwise.
 325  */
 326 int batadv_send_skb_unicast(struct batadv_priv *bat_priv,
 327                             struct sk_buff *skb, int packet_type,
 328                             int packet_subtype,
 329                             struct batadv_orig_node *orig_node,
 330                             unsigned short vid)
 331 {
 332         struct batadv_unicast_packet *unicast_packet;
 333         struct ethhdr *ethhdr;
 334         int ret = NET_XMIT_DROP;
 335
 336         if (!orig_node)
 337                 goto out;
 338
 339         switch (packet_type) {
 340         case BATADV_UNICAST:
 341                 if (!batadv_send_skb_prepare_unicast(skb, orig_node))
 342                         goto out;
 343                 break;
 344         case BATADV_UNICAST_4ADDR:
 345                 if (!batadv_send_skb_prepare_unicast_4addr(bat_priv, skb,
 346                                                            orig_node,
 347                                                            packet_subtype))
 348                         goto out;
 349                 break;
 350         default:
 351                 /* this function supports UNICAST and UNICAST_4ADDR only. It
 352                  * should never be invoked with any other packet type
 353                  */
 354                 goto out;
 355         }
 356
 357         /* skb->data might have been reallocated by
 358          * batadv_send_skb_prepare_unicast{,_4addr}()
 359          */
 360         ethhdr = eth_hdr(skb);
 361         unicast_packet = (struct batadv_unicast_packet *)skb->data;
 362
 363         /* inform the destination node that we are still missing a correct route
 364          * for this client. The destination will receive this packet and will
 365          * try to reroute it because the ttvn contained in the header is less
 366          * than the current one
 367          */
 368         if (batadv_tt_global_client_is_roaming(bat_priv, ethhdr->h_dest, vid))
 369                 unicast_packet->ttvn = unicast_packet->ttvn - 1;
 370
 371         ret = batadv_send_skb_to_orig(skb, orig_node, NULL);
 372          /* skb was consumed */
 373         skb = NULL;
 374
 375 out:
 376         kfree_skb(skb);
 377         return ret;
 378 }
 379
 380 /**
 381  * batadv_send_skb_via_tt_generic - send an skb via TT lookup
 382  * @bat_priv: the bat priv with all the soft interface information
 383  * @skb: payload to send
 384  * @packet_type: the batman unicast packet type to use
 385  * @packet_subtype: the unicast 4addr packet subtype (only relevant for unicast
 386  *  4addr packets)
 387  * @dst_hint: can be used to override the destination contained in the skb
 388  * @vid: the vid to be used to search the translation table
 389  *
 390  * Look up the recipient node for the destination address in the ethernet
 391  * header via the translation table. Wrap the given skb into a batman-adv
 392  * unicast or unicast-4addr header depending on whether BATADV_UNICAST or
 393  * BATADV_UNICAST_4ADDR was supplied as packet_type. Then send this frame
 394  * to the according destination node.
 395  *
 396  * Return: NET_XMIT_DROP in case of error or NET_XMIT_SUCCESS otherwise.
 397  */
 398 int batadv_send_skb_via_tt_generic(struct batadv_priv *bat_priv,
 399                                    struct sk_buff *skb, int packet_type,
 400                                    int packet_subtype, u8 *dst_hint,
 401                                    unsigned short vid)
 402 {
 403         struct ethhdr *ethhdr = (struct ethhdr *)skb->data;
 404         struct batadv_orig_node *orig_node;
 405         u8 *src, *dst;
 406         int ret;
 407
 408         src = ethhdr->h_source;
 409         dst = ethhdr->h_dest;
 410
 411         /* if we got an hint! let's send the packet to this client (if any) */
 412         if (dst_hint) {
 413                 src = NULL;
 414                 dst = dst_hint;
 415         }
 416         orig_node = batadv_transtable_search(bat_priv, src, dst, vid);
 417
 418         ret = batadv_send_skb_unicast(bat_priv, skb, packet_type,
 419                                       packet_subtype, orig_node, vid);
 420
 421         if (orig_node)
 422                 batadv_orig_node_put(orig_node);
 423
 424         return ret;
 425 }
 426
 427 /**
 428  * batadv_send_skb_via_gw - send an skb via gateway lookup
 429  * @bat_priv: the bat priv with all the soft interface information
 430  * @skb: payload to send
 431  * @vid: the vid to be used to search the translation table
 432  *
 433  * Look up the currently selected gateway. Wrap the given skb into a batman-adv
 434  * unicast header and send this frame to this gateway node.
 435  *
 436  * Return: NET_XMIT_DROP in case of error or NET_XMIT_SUCCESS otherwise.
 437  */
 438 int batadv_send_skb_via_gw(struct batadv_priv *bat_priv, struct sk_buff *skb,
 439                            unsigned short vid)
 440 {
 441         struct batadv_orig_node *orig_node;
 442         int ret;
 443
 444         orig_node = batadv_gw_get_selected_orig(bat_priv);
 445         ret = batadv_send_skb_unicast(bat_priv, skb, BATADV_UNICAST_4ADDR,
 446                                       BATADV_P_DATA, orig_node, vid);
 447
 448         if (orig_node)
 449                 batadv_orig_node_put(orig_node);
 450
 451         return ret;
 452 }
 453
 454 /**
 455  * batadv_forw_packet_free - free a forwarding packet
 456  * @forw_packet: The packet to free
 457  * @dropped: whether the packet is freed because is is dropped
 458  *
 459  * This frees a forwarding packet and releases any resources it might
 460  * have claimed.
 461  */
 462 void batadv_forw_packet_free(struct batadv_forw_packet *forw_packet,
 463                              bool dropped)
 464 {
 465         if (dropped)
 466                 kfree_skb(forw_packet->skb);
 467         else
 468                 consume_skb(forw_packet->skb);
 469
 470         if (forw_packet->if_incoming)
 471                 batadv_hardif_put(forw_packet->if_incoming);
 472         if (forw_packet->if_outgoing)
 473                 batadv_hardif_put(forw_packet->if_outgoing);
 474         if (forw_packet->queue_left)
 475                 atomic_inc(forw_packet->queue_left);
 476         kfree(forw_packet);
 477 }
 478
 479 /**
 480  * batadv_forw_packet_alloc - allocate a forwarding packet
 481  * @if_incoming: The (optional) if_incoming to be grabbed
 482  * @if_outgoing: The (optional) if_outgoing to be grabbed
 483  * @queue_left: The (optional) queue counter to decrease
 484  * @bat_priv: The bat_priv for the mesh of this forw_packet
 485  *
 486  * Allocates a forwarding packet and tries to get a reference to the
 487  * (optional) if_incoming, if_outgoing and queue_left. If queue_left
 488  * is NULL then bat_priv is optional, too.
 489  *
 490  * Return: An allocated forwarding packet on success, NULL otherwise.
 491  */
 492 struct batadv_forw_packet *
 493 batadv_forw_packet_alloc(struct batadv_hard_iface *if_incoming,
 494                          struct batadv_hard_iface *if_outgoing,
 495                          atomic_t *queue_left,
 496                          struct batadv_priv *bat_priv)
 497 {
 498         struct batadv_forw_packet *forw_packet;
 499         const char *qname;
 500
 501         if (queue_left && !batadv_atomic_dec_not_zero(queue_left)) {
 502                 qname = "unknown";
 503
 504                 if (queue_left == &bat_priv->bcast_queue_left)
 505                         qname = "bcast";
 506
 507                 if (queue_left == &bat_priv->batman_queue_left)
 508                         qname = "batman";
 509
 510                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
 511                            "%s queue is full\n", qname);
 512
 513                 return NULL;
 514         }
 515
 516         forw_packet = kmalloc(sizeof(*forw_packet), GFP_ATOMIC);
 517         if (!forw_packet)
 518                 goto err;
 519
 520         if (if_incoming)
 521                 kref_get(&if_incoming->refcount);
 522
 523         if (if_outgoing)
 524                 kref_get(&if_outgoing->refcount);
 525
 526         INIT_HLIST_NODE(&forw_packet->list);
 527         INIT_HLIST_NODE(&forw_packet->cleanup_list);
 528         forw_packet->skb = NULL;
 529         forw_packet->queue_left = queue_left;
 530         forw_packet->if_incoming = if_incoming;
 531         forw_packet->if_outgoing = if_outgoing;
 532         forw_packet->num_packets = 0;
 533
 534         return forw_packet;
 535
 536 err:
 537         if (queue_left)
 538                 atomic_inc(queue_left);
 539
 540         return NULL;
 541 }
 542
 543 /**
 544  * batadv_forw_packet_was_stolen - check whether someone stole this packet
 545  * @forw_packet: the forwarding packet to check
 546  *
 547  * This function checks whether the given forwarding packet was claimed by
 548  * someone else for free().
 549  *
 550  * Return: True if someone stole it, false otherwise.
 551  */
 552 static bool
 553 batadv_forw_packet_was_stolen(struct batadv_forw_packet *forw_packet)
 554 {
 555         return !hlist_unhashed(&forw_packet->cleanup_list);
 556 }
 557
 558 /**
 559  * batadv_forw_packet_steal - claim a forw_packet for free()
 560  * @forw_packet: the forwarding packet to steal
 561  * @lock: a key to the store to steal from (e.g. forw_{bat,bcast}_list_lock)
 562  *
 563  * This function tries to steal a specific forw_packet from global
 564  * visibility for the purpose of getting it for free(). That means
 565  * the caller is *not* allowed to requeue it afterwards.
 566  *
 567  * Return: True if stealing was successful. False if someone else stole it
 568  * before us.
 569  */
 570 bool batadv_forw_packet_steal(struct batadv_forw_packet *forw_packet,
 571                               spinlock_t *lock)
 572 {
 573         /* did purging routine steal it earlier? */
 574         spin_lock_bh(lock);
 575         if (batadv_forw_packet_was_stolen(forw_packet)) {
 576                 spin_unlock_bh(lock);
 577                 return false;
 578         }
 579
 580         hlist_del_init(&forw_packet->list);
 581
 582         /* Just to spot misuse of this function */
 583         hlist_add_fake(&forw_packet->cleanup_list);
 584
 585         spin_unlock_bh(lock);
 586         return true;
 587 }
 588
 589 /**
 590  * batadv_forw_packet_list_steal - claim a list of forward packets for free()
 591  * @forw_list: the to be stolen forward packets
 592  * @cleanup_list: a backup pointer, to be able to dispose the packet later
 593  * @hard_iface: the interface to steal forward packets from
 594  *
 595  * This function claims responsibility to free any forw_packet queued on the
 596  * given hard_iface. If hard_iface is NULL forwarding packets on all hard
 597  * interfaces will be claimed.
 598  *
 599  * The packets are being moved from the forw_list to the cleanup_list and
 600  * by that allows already running threads to notice the claiming.
 601  */
 602 static void
 603 batadv_forw_packet_list_steal(struct hlist_head *forw_list,
 604                               struct hlist_head *cleanup_list,
 605                               const struct batadv_hard_iface *hard_iface)
 606 {
 607         struct batadv_forw_packet *forw_packet;
 608         struct hlist_node *safe_tmp_node;
 609
 610         hlist_for_each_entry_safe(forw_packet, safe_tmp_node,
 611                                   forw_list, list) {
 612                 /* if purge_outstanding_packets() was called with an argument
 613                  * we delete only packets belonging to the given interface
 614                  */
 615                 if (hard_iface &&
 616                     (forw_packet->if_incoming != hard_iface) &&
 617                     (forw_packet->if_outgoing != hard_iface))
 618                         continue;
 619
 620                 hlist_del(&forw_packet->list);
 621                 hlist_add_head(&forw_packet->cleanup_list, cleanup_list);
 622         }
 623 }
 624
 625 /**
 626  * batadv_forw_packet_list_free - free a list of forward packets
 627  * @head: a list of to be freed forw_packets
 628  *
 629  * This function cancels the scheduling of any packet in the provided list,
 630  * waits for any possibly running packet forwarding thread to finish and
 631  * finally, safely frees this forward packet.
 632  *
 633  * This function might sleep.
 634  */
 635 static void batadv_forw_packet_list_free(struct hlist_head *head)
 636 {
 637         struct batadv_forw_packet *forw_packet;
 638         struct hlist_node *safe_tmp_node;
 639
 640         hlist_for_each_entry_safe(forw_packet, safe_tmp_node, head,
 641                                   cleanup_list) {
 642                 cancel_delayed_work_sync(&forw_packet->delayed_work);
 643
 644                 hlist_del(&forw_packet->cleanup_list);
 645                 batadv_forw_packet_free(forw_packet, true);
 646         }
 647 }
 648
 649 /**
 650  * batadv_forw_packet_queue - try to queue a forwarding packet
 651  * @forw_packet: the forwarding packet to queue
 652  * @lock: a key to the store (e.g. forw_{bat,bcast}_list_lock)
 653  * @head: the shelve to queue it on (e.g. forw_{bat,bcast}_list)
 654  * @send_time: timestamp (jiffies) when the packet is to be sent
 655  *
 656  * This function tries to (re)queue a forwarding packet. Requeuing
 657  * is prevented if the according interface is shutting down
 658  * (e.g. if batadv_forw_packet_list_steal() was called for this
 659  * packet earlier).
 660  *
 661  * Calling batadv_forw_packet_queue() after a call to
 662  * batadv_forw_packet_steal() is forbidden!
 663  *
 664  * Caller needs to ensure that forw_packet->delayed_work was initialized.
 665  */
 666 static void batadv_forw_packet_queue(struct batadv_forw_packet *forw_packet,
 667                                      spinlock_t *lock, struct hlist_head *head,
 668                                      unsigned long send_time)
 669 {
 670         spin_lock_bh(lock);
 671
 672         /* did purging routine steal it from us? */
 673         if (batadv_forw_packet_was_stolen(forw_packet)) {
 674                 /* If you got it for free() without trouble, then
 675                  * don't get back into the queue after stealing...
 676                  */
 677                 WARN_ONCE(hlist_fake(&forw_packet->cleanup_list),
 678                           "Requeuing after batadv_forw_packet_steal() not allowed!\n");
 679
 680                 spin_unlock_bh(lock);
 681                 return;
 682         }
 683
 684         hlist_del_init(&forw_packet->list);
 685         hlist_add_head(&forw_packet->list, head);
 686
 687         queue_delayed_work(batadv_event_workqueue,
 688                            &forw_packet->delayed_work,
 689                            send_time - jiffies);
 690         spin_unlock_bh(lock);
 691 }
 692
 693 /**
 694  * batadv_forw_packet_bcast_queue - try to queue a broadcast packet
 695  * @bat_priv: the bat priv with all the soft interface information
 696  * @forw_packet: the forwarding packet to queue
 697  * @send_time: timestamp (jiffies) when the packet is to be sent
 698  *
 699  * This function tries to (re)queue a broadcast packet.
 700  *
 701  * Caller needs to ensure that forw_packet->delayed_work was initialized.
 702  */
 703 static void
 704 batadv_forw_packet_bcast_queue(struct batadv_priv *bat_priv,
 705                                struct batadv_forw_packet *forw_packet,
 706                                unsigned long send_time)
 707 {
 708         batadv_forw_packet_queue(forw_packet, &bat_priv->forw_bcast_list_lock,
 709                                  &bat_priv->forw_bcast_list, send_time);
 710 }
 711
 712 /**
 713  * batadv_forw_packet_ogmv1_queue - try to queue an OGMv1 packet
 714  * @bat_priv: the bat priv with all the soft interface information
 715  * @forw_packet: the forwarding packet to queue
 716  * @send_time: timestamp (jiffies) when the packet is to be sent
 717  *
 718  * This function tries to (re)queue an OGMv1 packet.
 719  *
 720  * Caller needs to ensure that forw_packet->delayed_work was initialized.
 721  */
 722 void batadv_forw_packet_ogmv1_queue(struct batadv_priv *bat_priv,
 723                                     struct batadv_forw_packet *forw_packet,
 724                                     unsigned long send_time)
 725 {
 726         batadv_forw_packet_queue(forw_packet, &bat_priv->forw_bat_list_lock,
 727                                  &bat_priv->forw_bat_list, send_time);
 728 }
 729
 730 /**
 731  * batadv_add_bcast_packet_to_list - queue broadcast packet for multiple sends
 732  * @bat_priv: the bat priv with all the soft interface information
 733  * @skb: broadcast packet to add
 734  * @delay: number of jiffies to wait before sending
 735  * @own_packet: true if it is a self-generated broadcast packet
 736  *
 737  * add a broadcast packet to the queue and setup timers. broadcast packets
 738  * are sent multiple times to increase probability for being received.
 739  *
 740  * The skb is not consumed, so the caller should make sure that the
 741  * skb is freed.
 742  *
 743  * Return: NETDEV_TX_OK on success and NETDEV_TX_BUSY on errors.
 744  */
 745 int batadv_add_bcast_packet_to_list(struct batadv_priv *bat_priv,
 746                                     const struct sk_buff *skb,
 747                                     unsigned long delay,
 748                                     bool own_packet)
 749 {
 750         struct batadv_hard_iface *primary_if;
 751         struct batadv_forw_packet *forw_packet;
 752         struct batadv_bcast_packet *bcast_packet;
 753         struct sk_buff *newskb;
 754
 755         primary_if = batadv_primary_if_get_selected(bat_priv);
 756         if (!primary_if)
 757                 goto err;
 758
 759         forw_packet = batadv_forw_packet_alloc(primary_if, NULL,
 760                                                &bat_priv->bcast_queue_left,
 761                                                bat_priv);
 762         batadv_hardif_put(primary_if);
 763         if (!forw_packet)
 764                 goto err;
 765
 766         newskb = skb_copy(skb, GFP_ATOMIC);
 767         if (!newskb)
 768                 goto err_packet_free;
 769
 770         /* as we have a copy now, it is safe to decrease the TTL */
 771         bcast_packet = (struct batadv_bcast_packet *)newskb->data;
 772         bcast_packet->ttl--;
 773
 774         forw_packet->skb = newskb;
 775         forw_packet->own = own_packet;
 776
 777         INIT_DELAYED_WORK(&forw_packet->delayed_work,
 778                           batadv_send_outstanding_bcast_packet);
 779
 780         batadv_forw_packet_bcast_queue(bat_priv, forw_packet, jiffies + delay);
 781         return NETDEV_TX_OK;
 782
 783 err_packet_free:
 784         batadv_forw_packet_free(forw_packet, true);
 785 err:
 786         return NETDEV_TX_BUSY;
 787 }
 788
 789 static void batadv_send_outstanding_bcast_packet(struct work_struct *work)
 790 {
 791         struct batadv_hard_iface *hard_iface;
 792         struct batadv_hardif_neigh_node *neigh_node;
 793         struct delayed_work *delayed_work;
 794         struct batadv_forw_packet *forw_packet;
 795         struct batadv_bcast_packet *bcast_packet;
 796         struct sk_buff *skb1;
 797         struct net_device *soft_iface;
 798         struct batadv_priv *bat_priv;
 799         unsigned long send_time = jiffies + msecs_to_jiffies(5);
 800         bool dropped = false;
 801         u8 *neigh_addr;
 802         u8 *orig_neigh;
 803         int ret = 0;
 804
 805         delayed_work = to_delayed_work(work);
 806         forw_packet = container_of(delayed_work, struct batadv_forw_packet,
 807                                    delayed_work);
 808         soft_iface = forw_packet->if_incoming->soft_iface;
 809         bat_priv = netdev_priv(soft_iface);
 810
 811         if (atomic_read(&bat_priv->mesh_state) == BATADV_MESH_DEACTIVATING) {
 812                 dropped = true;
 813                 goto out;
 814         }
 815
 816         if (batadv_dat_drop_broadcast_packet(bat_priv, forw_packet)) {
 817                 dropped = true;
 818                 goto out;
 819         }
 820
 821         bcast_packet = (struct batadv_bcast_packet *)forw_packet->skb->data;
 822
 823         /* rebroadcast packet */
 824         rcu_read_lock();
 825         list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
 826                 if (hard_iface->soft_iface != soft_iface)
 827                         continue;
 828
 829                 if (forw_packet->num_packets >= hard_iface->num_bcasts)
 830                         continue;
 831
 832                 if (forw_packet->own) {
 833                         neigh_node = NULL;
 834                 } else {
 835                         neigh_addr = eth_hdr(forw_packet->skb)->h_source;
 836                         neigh_node = batadv_hardif_neigh_get(hard_iface,
 837                                                              neigh_addr);
 838                 }
 839
 840                 orig_neigh = neigh_node ? neigh_node->orig : NULL;
 841
 842                 ret = batadv_hardif_no_broadcast(hard_iface, bcast_packet->orig,
 843                                                  orig_neigh);
 844
 845                 if (ret) {
 846                         char *type;
 847
 848                         switch (ret) {
 849                         case BATADV_HARDIF_BCAST_NORECIPIENT:
 850                                 type = "no neighbor";
 851                                 break;
 852                         case BATADV_HARDIF_BCAST_DUPFWD:
 853                                 type = "single neighbor is source";
 854                                 break;
 855                         case BATADV_HARDIF_BCAST_DUPORIG:
 856                                 type = "single neighbor is originator";
 857                                 break;
 858                         default:
 859                                 type = "unknown";
 860                         }
 861
 862                         batadv_dbg(BATADV_DBG_BATMAN, bat_priv, "BCAST packet from orig %pM on %s surpressed: %s\n",
 863                                    bcast_packet->orig,
 864                                    hard_iface->net_dev->name, type);
 865
 866                         if (neigh_node)
 867                                 batadv_hardif_neigh_put(neigh_node);
 868
 869                         continue;
 870                 }
 871
 872                 if (neigh_node)
 873                         batadv_hardif_neigh_put(neigh_node);
 874
 875                 if (!kref_get_unless_zero(&hard_iface->refcount))
 876                         continue;
 877
 878                 /* send a copy of the saved skb */
 879                 skb1 = skb_clone(forw_packet->skb, GFP_ATOMIC);
 880                 if (skb1)
 881                         batadv_send_broadcast_skb(skb1, hard_iface);
 882
 883                 batadv_hardif_put(hard_iface);
 884         }
 885         rcu_read_unlock();
 886
 887         forw_packet->num_packets++;
 888
 889         /* if we still have some more bcasts to send */
 890         if (forw_packet->num_packets < BATADV_NUM_BCASTS_MAX) {
 891                 batadv_forw_packet_bcast_queue(bat_priv, forw_packet,
 892                                                send_time);
 893                 return;
 894         }
 895
 896 out:
 897         /* do we get something for free()? */
 898         if (batadv_forw_packet_steal(forw_packet,
 899                                      &bat_priv->forw_bcast_list_lock))
 900                 batadv_forw_packet_free(forw_packet, dropped);
 901 }
 902
 903 /**
 904  * batadv_purge_outstanding_packets - stop/purge scheduled bcast/OGMv1 packets
 905  * @bat_priv: the bat priv with all the soft interface information
 906  * @hard_iface: the hard interface to cancel and purge bcast/ogm packets on
 907  *
 908  * This method cancels and purges any broadcast and OGMv1 packet on the given
 909  * hard_iface. If hard_iface is NULL, broadcast and OGMv1 packets on all hard
 910  * interfaces will be canceled and purged.
 911  *
 912  * This function might sleep.
 913  */
 914 void
 915 batadv_purge_outstanding_packets(struct batadv_priv *bat_priv,
 916                                  const struct batadv_hard_iface *hard_iface)
 917 {
 918         struct hlist_head head = HLIST_HEAD_INIT;
 919
 920         if (hard_iface)
 921                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
 922                            "purge_outstanding_packets(): %s\n",
 923                            hard_iface->net_dev->name);
 924         else
 925                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
 926                            "purge_outstanding_packets()\n");
 927
 928         /* claim bcast list for free() */
 929         spin_lock_bh(&bat_priv->forw_bcast_list_lock);
 930         batadv_forw_packet_list_steal(&bat_priv->forw_bcast_list, &head,
 931                                       hard_iface);
 932         spin_unlock_bh(&bat_priv->forw_bcast_list_lock);
 933
 934         /* claim batman packet list for free() */
 935         spin_lock_bh(&bat_priv->forw_bat_list_lock);
 936         batadv_forw_packet_list_steal(&bat_priv->forw_bat_list, &head,
 937                                       hard_iface);
 938         spin_unlock_bh(&bat_priv->forw_bat_list_lock);
 939
 940         /* then cancel or wait for packet workers to finish and free */
 941         batadv_forw_packet_list_free(&head);
 942 }