Add the rt linux 4.1.3-rt3 as base
[kvmfornfv.git] / kernel / net / batman-adv / originator.c
diff --git a/kernel/net/batman-adv/originator.c b/kernel/net/batman-adv/originator.c
new file mode 100644 (file)
index 0000000..90e805a
--- /dev/null
@@ -0,0 +1,1177 @@
+/* Copyright (C) 2009-2014 B.A.T.M.A.N. contributors:
+ *
+ * Marek Lindner, Simon Wunderlich
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of version 2 of the GNU General Public
+ * License as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "main.h"
+#include "distributed-arp-table.h"
+#include "originator.h"
+#include "hash.h"
+#include "translation-table.h"
+#include "routing.h"
+#include "gateway_client.h"
+#include "hard-interface.h"
+#include "soft-interface.h"
+#include "bridge_loop_avoidance.h"
+#include "network-coding.h"
+#include "fragmentation.h"
+#include "multicast.h"
+
+/* hash class keys */
+static struct lock_class_key batadv_orig_hash_lock_class_key;
+
+static void batadv_purge_orig(struct work_struct *work);
+
+/* returns 1 if they are the same originator */
+int batadv_compare_orig(const struct hlist_node *node, const void *data2)
+{
+       const void *data1 = container_of(node, struct batadv_orig_node,
+                                        hash_entry);
+
+       return batadv_compare_eth(data1, data2);
+}
+
+/**
+ * batadv_orig_node_vlan_get - get an orig_node_vlan object
+ * @orig_node: the originator serving the VLAN
+ * @vid: the VLAN identifier
+ *
+ * Returns the vlan object identified by vid and belonging to orig_node or NULL
+ * if it does not exist.
+ */
+struct batadv_orig_node_vlan *
+batadv_orig_node_vlan_get(struct batadv_orig_node *orig_node,
+                         unsigned short vid)
+{
+       struct batadv_orig_node_vlan *vlan = NULL, *tmp;
+
+       rcu_read_lock();
+       list_for_each_entry_rcu(tmp, &orig_node->vlan_list, list) {
+               if (tmp->vid != vid)
+                       continue;
+
+               if (!atomic_inc_not_zero(&tmp->refcount))
+                       continue;
+
+               vlan = tmp;
+
+               break;
+       }
+       rcu_read_unlock();
+
+       return vlan;
+}
+
+/**
+ * batadv_orig_node_vlan_new - search and possibly create an orig_node_vlan
+ *  object
+ * @orig_node: the originator serving the VLAN
+ * @vid: the VLAN identifier
+ *
+ * Returns NULL in case of failure or the vlan object identified by vid and
+ * belonging to orig_node otherwise. The object is created and added to the list
+ * if it does not exist.
+ *
+ * The object is returned with refcounter increased by 1.
+ */
+struct batadv_orig_node_vlan *
+batadv_orig_node_vlan_new(struct batadv_orig_node *orig_node,
+                         unsigned short vid)
+{
+       struct batadv_orig_node_vlan *vlan;
+
+       spin_lock_bh(&orig_node->vlan_list_lock);
+
+       /* first look if an object for this vid already exists */
+       vlan = batadv_orig_node_vlan_get(orig_node, vid);
+       if (vlan)
+               goto out;
+
+       vlan = kzalloc(sizeof(*vlan), GFP_ATOMIC);
+       if (!vlan)
+               goto out;
+
+       atomic_set(&vlan->refcount, 2);
+       vlan->vid = vid;
+
+       list_add_rcu(&vlan->list, &orig_node->vlan_list);
+
+out:
+       spin_unlock_bh(&orig_node->vlan_list_lock);
+
+       return vlan;
+}
+
+/**
+ * batadv_orig_node_vlan_free_ref - decrement the refcounter and possibly free
+ *  the originator-vlan object
+ * @orig_vlan: the originator-vlan object to release
+ */
+void batadv_orig_node_vlan_free_ref(struct batadv_orig_node_vlan *orig_vlan)
+{
+       if (atomic_dec_and_test(&orig_vlan->refcount))
+               kfree_rcu(orig_vlan, rcu);
+}
+
+int batadv_originator_init(struct batadv_priv *bat_priv)
+{
+       if (bat_priv->orig_hash)
+               return 0;
+
+       bat_priv->orig_hash = batadv_hash_new(1024);
+
+       if (!bat_priv->orig_hash)
+               goto err;
+
+       batadv_hash_set_lock_class(bat_priv->orig_hash,
+                                  &batadv_orig_hash_lock_class_key);
+
+       INIT_DELAYED_WORK(&bat_priv->orig_work, batadv_purge_orig);
+       queue_delayed_work(batadv_event_workqueue,
+                          &bat_priv->orig_work,
+                          msecs_to_jiffies(BATADV_ORIG_WORK_PERIOD));
+
+       return 0;
+
+err:
+       return -ENOMEM;
+}
+
+/**
+ * batadv_neigh_ifinfo_free_rcu - free the neigh_ifinfo object
+ * @rcu: rcu pointer of the neigh_ifinfo object
+ */
+static void batadv_neigh_ifinfo_free_rcu(struct rcu_head *rcu)
+{
+       struct batadv_neigh_ifinfo *neigh_ifinfo;
+
+       neigh_ifinfo = container_of(rcu, struct batadv_neigh_ifinfo, rcu);
+
+       if (neigh_ifinfo->if_outgoing != BATADV_IF_DEFAULT)
+               batadv_hardif_free_ref_now(neigh_ifinfo->if_outgoing);
+
+       kfree(neigh_ifinfo);
+}
+
+/**
+ * batadv_neigh_ifinfo_free_now - decrement the refcounter and possibly free
+ *  the neigh_ifinfo (without rcu callback)
+ * @neigh_ifinfo: the neigh_ifinfo object to release
+ */
+static void
+batadv_neigh_ifinfo_free_ref_now(struct batadv_neigh_ifinfo *neigh_ifinfo)
+{
+       if (atomic_dec_and_test(&neigh_ifinfo->refcount))
+               batadv_neigh_ifinfo_free_rcu(&neigh_ifinfo->rcu);
+}
+
+/**
+ * batadv_neigh_ifinfo_free_ref - decrement the refcounter and possibly free
+ *  the neigh_ifinfo
+ * @neigh_ifinfo: the neigh_ifinfo object to release
+ */
+void batadv_neigh_ifinfo_free_ref(struct batadv_neigh_ifinfo *neigh_ifinfo)
+{
+       if (atomic_dec_and_test(&neigh_ifinfo->refcount))
+               call_rcu(&neigh_ifinfo->rcu, batadv_neigh_ifinfo_free_rcu);
+}
+
+/**
+ * batadv_neigh_node_free_rcu - free the neigh_node
+ * @rcu: rcu pointer of the neigh_node
+ */
+static void batadv_neigh_node_free_rcu(struct rcu_head *rcu)
+{
+       struct hlist_node *node_tmp;
+       struct batadv_neigh_node *neigh_node;
+       struct batadv_neigh_ifinfo *neigh_ifinfo;
+
+       neigh_node = container_of(rcu, struct batadv_neigh_node, rcu);
+
+       hlist_for_each_entry_safe(neigh_ifinfo, node_tmp,
+                                 &neigh_node->ifinfo_list, list) {
+               batadv_neigh_ifinfo_free_ref_now(neigh_ifinfo);
+       }
+       batadv_hardif_free_ref_now(neigh_node->if_incoming);
+
+       kfree(neigh_node);
+}
+
+/**
+ * batadv_neigh_node_free_ref_now - decrement the neighbors refcounter
+ *  and possibly free it (without rcu callback)
+ * @neigh_node: neigh neighbor to free
+ */
+static void
+batadv_neigh_node_free_ref_now(struct batadv_neigh_node *neigh_node)
+{
+       if (atomic_dec_and_test(&neigh_node->refcount))
+               batadv_neigh_node_free_rcu(&neigh_node->rcu);
+}
+
+/**
+ * batadv_neigh_node_free_ref - decrement the neighbors refcounter
+ *  and possibly free it
+ * @neigh_node: neigh neighbor to free
+ */
+void batadv_neigh_node_free_ref(struct batadv_neigh_node *neigh_node)
+{
+       if (atomic_dec_and_test(&neigh_node->refcount))
+               call_rcu(&neigh_node->rcu, batadv_neigh_node_free_rcu);
+}
+
+/**
+ * batadv_orig_node_get_router - router to the originator depending on iface
+ * @orig_node: the orig node for the router
+ * @if_outgoing: the interface where the payload packet has been received or
+ *  the OGM should be sent to
+ *
+ * Returns the neighbor which should be router for this orig_node/iface.
+ *
+ * The object is returned with refcounter increased by 1.
+ */
+struct batadv_neigh_node *
+batadv_orig_router_get(struct batadv_orig_node *orig_node,
+                      const struct batadv_hard_iface *if_outgoing)
+{
+       struct batadv_orig_ifinfo *orig_ifinfo;
+       struct batadv_neigh_node *router = NULL;
+
+       rcu_read_lock();
+       hlist_for_each_entry_rcu(orig_ifinfo, &orig_node->ifinfo_list, list) {
+               if (orig_ifinfo->if_outgoing != if_outgoing)
+                       continue;
+
+               router = rcu_dereference(orig_ifinfo->router);
+               break;
+       }
+
+       if (router && !atomic_inc_not_zero(&router->refcount))
+               router = NULL;
+
+       rcu_read_unlock();
+       return router;
+}
+
+/**
+ * batadv_orig_ifinfo_get - find the ifinfo from an orig_node
+ * @orig_node: the orig node to be queried
+ * @if_outgoing: the interface for which the ifinfo should be acquired
+ *
+ * Returns the requested orig_ifinfo or NULL if not found.
+ *
+ * The object is returned with refcounter increased by 1.
+ */
+struct batadv_orig_ifinfo *
+batadv_orig_ifinfo_get(struct batadv_orig_node *orig_node,
+                      struct batadv_hard_iface *if_outgoing)
+{
+       struct batadv_orig_ifinfo *tmp, *orig_ifinfo = NULL;
+
+       rcu_read_lock();
+       hlist_for_each_entry_rcu(tmp, &orig_node->ifinfo_list,
+                                list) {
+               if (tmp->if_outgoing != if_outgoing)
+                       continue;
+
+               if (!atomic_inc_not_zero(&tmp->refcount))
+                       continue;
+
+               orig_ifinfo = tmp;
+               break;
+       }
+       rcu_read_unlock();
+
+       return orig_ifinfo;
+}
+
+/**
+ * batadv_orig_ifinfo_new - search and possibly create an orig_ifinfo object
+ * @orig_node: the orig node to be queried
+ * @if_outgoing: the interface for which the ifinfo should be acquired
+ *
+ * Returns NULL in case of failure or the orig_ifinfo object for the if_outgoing
+ * interface otherwise. The object is created and added to the list
+ * if it does not exist.
+ *
+ * The object is returned with refcounter increased by 1.
+ */
+struct batadv_orig_ifinfo *
+batadv_orig_ifinfo_new(struct batadv_orig_node *orig_node,
+                      struct batadv_hard_iface *if_outgoing)
+{
+       struct batadv_orig_ifinfo *orig_ifinfo = NULL;
+       unsigned long reset_time;
+
+       spin_lock_bh(&orig_node->neigh_list_lock);
+
+       orig_ifinfo = batadv_orig_ifinfo_get(orig_node, if_outgoing);
+       if (orig_ifinfo)
+               goto out;
+
+       orig_ifinfo = kzalloc(sizeof(*orig_ifinfo), GFP_ATOMIC);
+       if (!orig_ifinfo)
+               goto out;
+
+       if (if_outgoing != BATADV_IF_DEFAULT &&
+           !atomic_inc_not_zero(&if_outgoing->refcount)) {
+               kfree(orig_ifinfo);
+               orig_ifinfo = NULL;
+               goto out;
+       }
+
+       reset_time = jiffies - 1;
+       reset_time -= msecs_to_jiffies(BATADV_RESET_PROTECTION_MS);
+       orig_ifinfo->batman_seqno_reset = reset_time;
+       orig_ifinfo->if_outgoing = if_outgoing;
+       INIT_HLIST_NODE(&orig_ifinfo->list);
+       atomic_set(&orig_ifinfo->refcount, 2);
+       hlist_add_head_rcu(&orig_ifinfo->list,
+                          &orig_node->ifinfo_list);
+out:
+       spin_unlock_bh(&orig_node->neigh_list_lock);
+       return orig_ifinfo;
+}
+
+/**
+ * batadv_neigh_ifinfo_get - find the ifinfo from an neigh_node
+ * @neigh_node: the neigh node to be queried
+ * @if_outgoing: the interface for which the ifinfo should be acquired
+ *
+ * The object is returned with refcounter increased by 1.
+ *
+ * Returns the requested neigh_ifinfo or NULL if not found
+ */
+struct batadv_neigh_ifinfo *
+batadv_neigh_ifinfo_get(struct batadv_neigh_node *neigh,
+                       struct batadv_hard_iface *if_outgoing)
+{
+       struct batadv_neigh_ifinfo *neigh_ifinfo = NULL,
+                                  *tmp_neigh_ifinfo;
+
+       rcu_read_lock();
+       hlist_for_each_entry_rcu(tmp_neigh_ifinfo, &neigh->ifinfo_list,
+                                list) {
+               if (tmp_neigh_ifinfo->if_outgoing != if_outgoing)
+                       continue;
+
+               if (!atomic_inc_not_zero(&tmp_neigh_ifinfo->refcount))
+                       continue;
+
+               neigh_ifinfo = tmp_neigh_ifinfo;
+               break;
+       }
+       rcu_read_unlock();
+
+       return neigh_ifinfo;
+}
+
+/**
+ * batadv_neigh_ifinfo_new - search and possibly create an neigh_ifinfo object
+ * @neigh_node: the neigh node to be queried
+ * @if_outgoing: the interface for which the ifinfo should be acquired
+ *
+ * Returns NULL in case of failure or the neigh_ifinfo object for the
+ * if_outgoing interface otherwise. The object is created and added to the list
+ * if it does not exist.
+ *
+ * The object is returned with refcounter increased by 1.
+ */
+struct batadv_neigh_ifinfo *
+batadv_neigh_ifinfo_new(struct batadv_neigh_node *neigh,
+                       struct batadv_hard_iface *if_outgoing)
+{
+       struct batadv_neigh_ifinfo *neigh_ifinfo;
+
+       spin_lock_bh(&neigh->ifinfo_lock);
+
+       neigh_ifinfo = batadv_neigh_ifinfo_get(neigh, if_outgoing);
+       if (neigh_ifinfo)
+               goto out;
+
+       neigh_ifinfo = kzalloc(sizeof(*neigh_ifinfo), GFP_ATOMIC);
+       if (!neigh_ifinfo)
+               goto out;
+
+       if (if_outgoing && !atomic_inc_not_zero(&if_outgoing->refcount)) {
+               kfree(neigh_ifinfo);
+               neigh_ifinfo = NULL;
+               goto out;
+       }
+
+       INIT_HLIST_NODE(&neigh_ifinfo->list);
+       atomic_set(&neigh_ifinfo->refcount, 2);
+       neigh_ifinfo->if_outgoing = if_outgoing;
+
+       hlist_add_head_rcu(&neigh_ifinfo->list, &neigh->ifinfo_list);
+
+out:
+       spin_unlock_bh(&neigh->ifinfo_lock);
+
+       return neigh_ifinfo;
+}
+
+/**
+ * batadv_neigh_node_new - create and init a new neigh_node object
+ * @hard_iface: the interface where the neighbour is connected to
+ * @neigh_addr: the mac address of the neighbour interface
+ * @orig_node: originator object representing the neighbour
+ *
+ * Allocates a new neigh_node object and initialises all the generic fields.
+ * Returns the new object or NULL on failure.
+ */
+struct batadv_neigh_node *
+batadv_neigh_node_new(struct batadv_hard_iface *hard_iface,
+                     const uint8_t *neigh_addr,
+                     struct batadv_orig_node *orig_node)
+{
+       struct batadv_neigh_node *neigh_node;
+
+       neigh_node = kzalloc(sizeof(*neigh_node), GFP_ATOMIC);
+       if (!neigh_node)
+               goto out;
+
+       INIT_HLIST_NODE(&neigh_node->list);
+       INIT_HLIST_HEAD(&neigh_node->ifinfo_list);
+       spin_lock_init(&neigh_node->ifinfo_lock);
+
+       ether_addr_copy(neigh_node->addr, neigh_addr);
+       neigh_node->if_incoming = hard_iface;
+       neigh_node->orig_node = orig_node;
+
+       /* extra reference for return */
+       atomic_set(&neigh_node->refcount, 2);
+
+out:
+       return neigh_node;
+}
+
+/**
+ * batadv_neigh_node_get - retrieve a neighbour from the list
+ * @orig_node: originator which the neighbour belongs to
+ * @hard_iface: the interface where this neighbour is connected to
+ * @addr: the address of the neighbour
+ *
+ * Looks for and possibly returns a neighbour belonging to this originator list
+ * which is connected through the provided hard interface.
+ * Returns NULL if the neighbour is not found.
+ */
+struct batadv_neigh_node *
+batadv_neigh_node_get(const struct batadv_orig_node *orig_node,
+                     const struct batadv_hard_iface *hard_iface,
+                     const uint8_t *addr)
+{
+       struct batadv_neigh_node *tmp_neigh_node, *res = NULL;
+
+       rcu_read_lock();
+       hlist_for_each_entry_rcu(tmp_neigh_node, &orig_node->neigh_list, list) {
+               if (!batadv_compare_eth(tmp_neigh_node->addr, addr))
+                       continue;
+
+               if (tmp_neigh_node->if_incoming != hard_iface)
+                       continue;
+
+               if (!atomic_inc_not_zero(&tmp_neigh_node->refcount))
+                       continue;
+
+               res = tmp_neigh_node;
+               break;
+       }
+       rcu_read_unlock();
+
+       return res;
+}
+
+/**
+ * batadv_orig_ifinfo_free_rcu - free the orig_ifinfo object
+ * @rcu: rcu pointer of the orig_ifinfo object
+ */
+static void batadv_orig_ifinfo_free_rcu(struct rcu_head *rcu)
+{
+       struct batadv_orig_ifinfo *orig_ifinfo;
+       struct batadv_neigh_node *router;
+
+       orig_ifinfo = container_of(rcu, struct batadv_orig_ifinfo, rcu);
+
+       if (orig_ifinfo->if_outgoing != BATADV_IF_DEFAULT)
+               batadv_hardif_free_ref_now(orig_ifinfo->if_outgoing);
+
+       /* this is the last reference to this object */
+       router = rcu_dereference_protected(orig_ifinfo->router, true);
+       if (router)
+               batadv_neigh_node_free_ref_now(router);
+       kfree(orig_ifinfo);
+}
+
+/**
+ * batadv_orig_ifinfo_free_ref - decrement the refcounter and possibly free
+ *  the orig_ifinfo (without rcu callback)
+ * @orig_ifinfo: the orig_ifinfo object to release
+ */
+static void
+batadv_orig_ifinfo_free_ref_now(struct batadv_orig_ifinfo *orig_ifinfo)
+{
+       if (atomic_dec_and_test(&orig_ifinfo->refcount))
+               batadv_orig_ifinfo_free_rcu(&orig_ifinfo->rcu);
+}
+
+/**
+ * batadv_orig_ifinfo_free_ref - decrement the refcounter and possibly free
+ *  the orig_ifinfo
+ * @orig_ifinfo: the orig_ifinfo object to release
+ */
+void batadv_orig_ifinfo_free_ref(struct batadv_orig_ifinfo *orig_ifinfo)
+{
+       if (atomic_dec_and_test(&orig_ifinfo->refcount))
+               call_rcu(&orig_ifinfo->rcu, batadv_orig_ifinfo_free_rcu);
+}
+
+static void batadv_orig_node_free_rcu(struct rcu_head *rcu)
+{
+       struct hlist_node *node_tmp;
+       struct batadv_neigh_node *neigh_node;
+       struct batadv_orig_node *orig_node;
+       struct batadv_orig_ifinfo *orig_ifinfo;
+
+       orig_node = container_of(rcu, struct batadv_orig_node, rcu);
+
+       spin_lock_bh(&orig_node->neigh_list_lock);
+
+       /* for all neighbors towards this originator ... */
+       hlist_for_each_entry_safe(neigh_node, node_tmp,
+                                 &orig_node->neigh_list, list) {
+               hlist_del_rcu(&neigh_node->list);
+               batadv_neigh_node_free_ref_now(neigh_node);
+       }
+
+       hlist_for_each_entry_safe(orig_ifinfo, node_tmp,
+                                 &orig_node->ifinfo_list, list) {
+               hlist_del_rcu(&orig_ifinfo->list);
+               batadv_orig_ifinfo_free_ref_now(orig_ifinfo);
+       }
+       spin_unlock_bh(&orig_node->neigh_list_lock);
+
+       batadv_mcast_purge_orig(orig_node);
+
+       /* Free nc_nodes */
+       batadv_nc_purge_orig(orig_node->bat_priv, orig_node, NULL);
+
+       batadv_frag_purge_orig(orig_node, NULL);
+
+       if (orig_node->bat_priv->bat_algo_ops->bat_orig_free)
+               orig_node->bat_priv->bat_algo_ops->bat_orig_free(orig_node);
+
+       kfree(orig_node->tt_buff);
+       kfree(orig_node);
+}
+
+/**
+ * batadv_orig_node_free_ref - decrement the orig node refcounter and possibly
+ * schedule an rcu callback for freeing it
+ * @orig_node: the orig node to free
+ */
+void batadv_orig_node_free_ref(struct batadv_orig_node *orig_node)
+{
+       if (atomic_dec_and_test(&orig_node->refcount))
+               call_rcu(&orig_node->rcu, batadv_orig_node_free_rcu);
+}
+
+/**
+ * batadv_orig_node_free_ref_now - decrement the orig node refcounter and
+ * possibly free it (without rcu callback)
+ * @orig_node: the orig node to free
+ */
+void batadv_orig_node_free_ref_now(struct batadv_orig_node *orig_node)
+{
+       if (atomic_dec_and_test(&orig_node->refcount))
+               batadv_orig_node_free_rcu(&orig_node->rcu);
+}
+
+void batadv_originator_free(struct batadv_priv *bat_priv)
+{
+       struct batadv_hashtable *hash = bat_priv->orig_hash;
+       struct hlist_node *node_tmp;
+       struct hlist_head *head;
+       spinlock_t *list_lock; /* spinlock to protect write access */
+       struct batadv_orig_node *orig_node;
+       uint32_t i;
+
+       if (!hash)
+               return;
+
+       cancel_delayed_work_sync(&bat_priv->orig_work);
+
+       bat_priv->orig_hash = NULL;
+
+       for (i = 0; i < hash->size; i++) {
+               head = &hash->table[i];
+               list_lock = &hash->list_locks[i];
+
+               spin_lock_bh(list_lock);
+               hlist_for_each_entry_safe(orig_node, node_tmp,
+                                         head, hash_entry) {
+                       hlist_del_rcu(&orig_node->hash_entry);
+                       batadv_orig_node_free_ref(orig_node);
+               }
+               spin_unlock_bh(list_lock);
+       }
+
+       batadv_hash_destroy(hash);
+}
+
+/**
+ * batadv_orig_node_new - creates a new orig_node
+ * @bat_priv: the bat priv with all the soft interface information
+ * @addr: the mac address of the originator
+ *
+ * Creates a new originator object and initialise all the generic fields.
+ * The new object is not added to the originator list.
+ * Returns the newly created object or NULL on failure.
+ */
+struct batadv_orig_node *batadv_orig_node_new(struct batadv_priv *bat_priv,
+                                             const uint8_t *addr)
+{
+       struct batadv_orig_node *orig_node;
+       struct batadv_orig_node_vlan *vlan;
+       unsigned long reset_time;
+       int i;
+
+       batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
+                  "Creating new originator: %pM\n", addr);
+
+       orig_node = kzalloc(sizeof(*orig_node), GFP_ATOMIC);
+       if (!orig_node)
+               return NULL;
+
+       INIT_HLIST_HEAD(&orig_node->neigh_list);
+       INIT_LIST_HEAD(&orig_node->vlan_list);
+       INIT_HLIST_HEAD(&orig_node->ifinfo_list);
+       spin_lock_init(&orig_node->bcast_seqno_lock);
+       spin_lock_init(&orig_node->neigh_list_lock);
+       spin_lock_init(&orig_node->tt_buff_lock);
+       spin_lock_init(&orig_node->tt_lock);
+       spin_lock_init(&orig_node->vlan_list_lock);
+
+       batadv_nc_init_orig(orig_node);
+
+       /* extra reference for return */
+       atomic_set(&orig_node->refcount, 2);
+
+       orig_node->bat_priv = bat_priv;
+       ether_addr_copy(orig_node->orig, addr);
+       batadv_dat_init_orig_node_addr(orig_node);
+       atomic_set(&orig_node->last_ttvn, 0);
+       orig_node->tt_buff = NULL;
+       orig_node->tt_buff_len = 0;
+       orig_node->last_seen = jiffies;
+       reset_time = jiffies - 1 - msecs_to_jiffies(BATADV_RESET_PROTECTION_MS);
+       orig_node->bcast_seqno_reset = reset_time;
+#ifdef CONFIG_BATMAN_ADV_MCAST
+       orig_node->mcast_flags = BATADV_NO_FLAGS;
+#endif
+
+       /* create a vlan object for the "untagged" LAN */
+       vlan = batadv_orig_node_vlan_new(orig_node, BATADV_NO_FLAGS);
+       if (!vlan)
+               goto free_orig_node;
+       /* batadv_orig_node_vlan_new() increases the refcounter.
+        * Immediately release vlan since it is not needed anymore in this
+        * context
+        */
+       batadv_orig_node_vlan_free_ref(vlan);
+
+       for (i = 0; i < BATADV_FRAG_BUFFER_COUNT; i++) {
+               INIT_HLIST_HEAD(&orig_node->fragments[i].head);
+               spin_lock_init(&orig_node->fragments[i].lock);
+               orig_node->fragments[i].size = 0;
+       }
+
+       return orig_node;
+free_orig_node:
+       kfree(orig_node);
+       return NULL;
+}
+
+/**
+ * batadv_purge_neigh_ifinfo - purge obsolete ifinfo entries from neighbor
+ * @bat_priv: the bat priv with all the soft interface information
+ * @neigh: orig node which is to be checked
+ */
+static void
+batadv_purge_neigh_ifinfo(struct batadv_priv *bat_priv,
+                         struct batadv_neigh_node *neigh)
+{
+       struct batadv_neigh_ifinfo *neigh_ifinfo;
+       struct batadv_hard_iface *if_outgoing;
+       struct hlist_node *node_tmp;
+
+       spin_lock_bh(&neigh->ifinfo_lock);
+
+       /* for all ifinfo objects for this neighinator */
+       hlist_for_each_entry_safe(neigh_ifinfo, node_tmp,
+                                 &neigh->ifinfo_list, list) {
+               if_outgoing = neigh_ifinfo->if_outgoing;
+
+               /* always keep the default interface */
+               if (if_outgoing == BATADV_IF_DEFAULT)
+                       continue;
+
+               /* don't purge if the interface is not (going) down */
+               if ((if_outgoing->if_status != BATADV_IF_INACTIVE) &&
+                   (if_outgoing->if_status != BATADV_IF_NOT_IN_USE) &&
+                   (if_outgoing->if_status != BATADV_IF_TO_BE_REMOVED))
+                       continue;
+
+               batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
+                          "neighbor/ifinfo purge: neighbor %pM, iface: %s\n",
+                          neigh->addr, if_outgoing->net_dev->name);
+
+               hlist_del_rcu(&neigh_ifinfo->list);
+               batadv_neigh_ifinfo_free_ref(neigh_ifinfo);
+       }
+
+       spin_unlock_bh(&neigh->ifinfo_lock);
+}
+
+/**
+ * batadv_purge_orig_ifinfo - purge obsolete ifinfo entries from originator
+ * @bat_priv: the bat priv with all the soft interface information
+ * @orig_node: orig node which is to be checked
+ *
+ * Returns true if any ifinfo entry was purged, false otherwise.
+ */
+static bool
+batadv_purge_orig_ifinfo(struct batadv_priv *bat_priv,
+                        struct batadv_orig_node *orig_node)
+{
+       struct batadv_orig_ifinfo *orig_ifinfo;
+       struct batadv_hard_iface *if_outgoing;
+       struct hlist_node *node_tmp;
+       bool ifinfo_purged = false;
+
+       spin_lock_bh(&orig_node->neigh_list_lock);
+
+       /* for all ifinfo objects for this originator */
+       hlist_for_each_entry_safe(orig_ifinfo, node_tmp,
+                                 &orig_node->ifinfo_list, list) {
+               if_outgoing = orig_ifinfo->if_outgoing;
+
+               /* always keep the default interface */
+               if (if_outgoing == BATADV_IF_DEFAULT)
+                       continue;
+
+               /* don't purge if the interface is not (going) down */
+               if ((if_outgoing->if_status != BATADV_IF_INACTIVE) &&
+                   (if_outgoing->if_status != BATADV_IF_NOT_IN_USE) &&
+                   (if_outgoing->if_status != BATADV_IF_TO_BE_REMOVED))
+                       continue;
+
+               batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
+                          "router/ifinfo purge: originator %pM, iface: %s\n",
+                          orig_node->orig, if_outgoing->net_dev->name);
+
+               ifinfo_purged = true;
+
+               hlist_del_rcu(&orig_ifinfo->list);
+               batadv_orig_ifinfo_free_ref(orig_ifinfo);
+               if (orig_node->last_bonding_candidate == orig_ifinfo) {
+                       orig_node->last_bonding_candidate = NULL;
+                       batadv_orig_ifinfo_free_ref(orig_ifinfo);
+               }
+       }
+
+       spin_unlock_bh(&orig_node->neigh_list_lock);
+
+       return ifinfo_purged;
+}
+
+/**
+ * batadv_purge_orig_neighbors - purges neighbors from originator
+ * @bat_priv: the bat priv with all the soft interface information
+ * @orig_node: orig node which is to be checked
+ *
+ * Returns true if any neighbor was purged, false otherwise
+ */
+static bool
+batadv_purge_orig_neighbors(struct batadv_priv *bat_priv,
+                           struct batadv_orig_node *orig_node)
+{
+       struct hlist_node *node_tmp;
+       struct batadv_neigh_node *neigh_node;
+       bool neigh_purged = false;
+       unsigned long last_seen;
+       struct batadv_hard_iface *if_incoming;
+
+       spin_lock_bh(&orig_node->neigh_list_lock);
+
+       /* for all neighbors towards this originator ... */
+       hlist_for_each_entry_safe(neigh_node, node_tmp,
+                                 &orig_node->neigh_list, list) {
+               last_seen = neigh_node->last_seen;
+               if_incoming = neigh_node->if_incoming;
+
+               if ((batadv_has_timed_out(last_seen, BATADV_PURGE_TIMEOUT)) ||
+                   (if_incoming->if_status == BATADV_IF_INACTIVE) ||
+                   (if_incoming->if_status == BATADV_IF_NOT_IN_USE) ||
+                   (if_incoming->if_status == BATADV_IF_TO_BE_REMOVED)) {
+                       if ((if_incoming->if_status == BATADV_IF_INACTIVE) ||
+                           (if_incoming->if_status == BATADV_IF_NOT_IN_USE) ||
+                           (if_incoming->if_status == BATADV_IF_TO_BE_REMOVED))
+                               batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
+                                          "neighbor purge: originator %pM, neighbor: %pM, iface: %s\n",
+                                          orig_node->orig, neigh_node->addr,
+                                          if_incoming->net_dev->name);
+                       else
+                               batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
+                                          "neighbor timeout: originator %pM, neighbor: %pM, last_seen: %u\n",
+                                          orig_node->orig, neigh_node->addr,
+                                          jiffies_to_msecs(last_seen));
+
+                       neigh_purged = true;
+
+                       hlist_del_rcu(&neigh_node->list);
+                       batadv_neigh_node_free_ref(neigh_node);
+               } else {
+                       /* only necessary if not the whole neighbor is to be
+                        * deleted, but some interface has been removed.
+                        */
+                       batadv_purge_neigh_ifinfo(bat_priv, neigh_node);
+               }
+       }
+
+       spin_unlock_bh(&orig_node->neigh_list_lock);
+       return neigh_purged;
+}
+
+/**
+ * batadv_find_best_neighbor - finds the best neighbor after purging
+ * @bat_priv: the bat priv with all the soft interface information
+ * @orig_node: orig node which is to be checked
+ * @if_outgoing: the interface for which the metric should be compared
+ *
+ * Returns the current best neighbor, with refcount increased.
+ */
+static struct batadv_neigh_node *
+batadv_find_best_neighbor(struct batadv_priv *bat_priv,
+                         struct batadv_orig_node *orig_node,
+                         struct batadv_hard_iface *if_outgoing)
+{
+       struct batadv_neigh_node *best = NULL, *neigh;
+       struct batadv_algo_ops *bao = bat_priv->bat_algo_ops;
+
+       rcu_read_lock();
+       hlist_for_each_entry_rcu(neigh, &orig_node->neigh_list, list) {
+               if (best && (bao->bat_neigh_cmp(neigh, if_outgoing,
+                                               best, if_outgoing) <= 0))
+                       continue;
+
+               if (!atomic_inc_not_zero(&neigh->refcount))
+                       continue;
+
+               if (best)
+                       batadv_neigh_node_free_ref(best);
+
+               best = neigh;
+       }
+       rcu_read_unlock();
+
+       return best;
+}
+
+/**
+ * batadv_purge_orig_node - purges obsolete information from an orig_node
+ * @bat_priv: the bat priv with all the soft interface information
+ * @orig_node: orig node which is to be checked
+ *
+ * This function checks if the orig_node or substructures of it have become
+ * obsolete, and purges this information if that's the case.
+ *
+ * Returns true if the orig_node is to be removed, false otherwise.
+ */
+static bool batadv_purge_orig_node(struct batadv_priv *bat_priv,
+                                  struct batadv_orig_node *orig_node)
+{
+       struct batadv_neigh_node *best_neigh_node;
+       struct batadv_hard_iface *hard_iface;
+       bool changed_ifinfo, changed_neigh;
+
+       if (batadv_has_timed_out(orig_node->last_seen,
+                                2 * BATADV_PURGE_TIMEOUT)) {
+               batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
+                          "Originator timeout: originator %pM, last_seen %u\n",
+                          orig_node->orig,
+                          jiffies_to_msecs(orig_node->last_seen));
+               return true;
+       }
+       changed_ifinfo = batadv_purge_orig_ifinfo(bat_priv, orig_node);
+       changed_neigh = batadv_purge_orig_neighbors(bat_priv, orig_node);
+
+       if (!changed_ifinfo && !changed_neigh)
+               return false;
+
+       /* first for NULL ... */
+       best_neigh_node = batadv_find_best_neighbor(bat_priv, orig_node,
+                                                   BATADV_IF_DEFAULT);
+       batadv_update_route(bat_priv, orig_node, BATADV_IF_DEFAULT,
+                           best_neigh_node);
+       if (best_neigh_node)
+               batadv_neigh_node_free_ref(best_neigh_node);
+
+       /* ... then for all other interfaces. */
+       rcu_read_lock();
+       list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
+               if (hard_iface->if_status != BATADV_IF_ACTIVE)
+                       continue;
+
+               if (hard_iface->soft_iface != bat_priv->soft_iface)
+                       continue;
+
+               best_neigh_node = batadv_find_best_neighbor(bat_priv,
+                                                           orig_node,
+                                                           hard_iface);
+               batadv_update_route(bat_priv, orig_node, hard_iface,
+                                   best_neigh_node);
+               if (best_neigh_node)
+                       batadv_neigh_node_free_ref(best_neigh_node);
+       }
+       rcu_read_unlock();
+
+       return false;
+}
+
+static void _batadv_purge_orig(struct batadv_priv *bat_priv)
+{
+       struct batadv_hashtable *hash = bat_priv->orig_hash;
+       struct hlist_node *node_tmp;
+       struct hlist_head *head;
+       spinlock_t *list_lock; /* spinlock to protect write access */
+       struct batadv_orig_node *orig_node;
+       uint32_t i;
+
+       if (!hash)
+               return;
+
+       /* for all origins... */
+       for (i = 0; i < hash->size; i++) {
+               head = &hash->table[i];
+               list_lock = &hash->list_locks[i];
+
+               spin_lock_bh(list_lock);
+               hlist_for_each_entry_safe(orig_node, node_tmp,
+                                         head, hash_entry) {
+                       if (batadv_purge_orig_node(bat_priv, orig_node)) {
+                               batadv_gw_node_delete(bat_priv, orig_node);
+                               hlist_del_rcu(&orig_node->hash_entry);
+                               batadv_tt_global_del_orig(orig_node->bat_priv,
+                                                         orig_node, -1,
+                                                         "originator timed out");
+                               batadv_orig_node_free_ref(orig_node);
+                               continue;
+                       }
+
+                       batadv_frag_purge_orig(orig_node,
+                                              batadv_frag_check_entry);
+               }
+               spin_unlock_bh(list_lock);
+       }
+
+       batadv_gw_node_purge(bat_priv);
+       batadv_gw_election(bat_priv);
+}
+
+static void batadv_purge_orig(struct work_struct *work)
+{
+       struct delayed_work *delayed_work;
+       struct batadv_priv *bat_priv;
+
+       delayed_work = container_of(work, struct delayed_work, work);
+       bat_priv = container_of(delayed_work, struct batadv_priv, orig_work);
+       _batadv_purge_orig(bat_priv);
+       queue_delayed_work(batadv_event_workqueue,
+                          &bat_priv->orig_work,
+                          msecs_to_jiffies(BATADV_ORIG_WORK_PERIOD));
+}
+
+void batadv_purge_orig_ref(struct batadv_priv *bat_priv)
+{
+       _batadv_purge_orig(bat_priv);
+}
+
+int batadv_orig_seq_print_text(struct seq_file *seq, void *offset)
+{
+       struct net_device *net_dev = (struct net_device *)seq->private;
+       struct batadv_priv *bat_priv = netdev_priv(net_dev);
+       struct batadv_hard_iface *primary_if;
+
+       primary_if = batadv_seq_print_text_primary_if_get(seq);
+       if (!primary_if)
+               return 0;
+
+       seq_printf(seq, "[B.A.T.M.A.N. adv %s, MainIF/MAC: %s/%pM (%s %s)]\n",
+                  BATADV_SOURCE_VERSION, primary_if->net_dev->name,
+                  primary_if->net_dev->dev_addr, net_dev->name,
+                  bat_priv->bat_algo_ops->name);
+
+       batadv_hardif_free_ref(primary_if);
+
+       if (!bat_priv->bat_algo_ops->bat_orig_print) {
+               seq_puts(seq,
+                        "No printing function for this routing protocol\n");
+               return 0;
+       }
+
+       bat_priv->bat_algo_ops->bat_orig_print(bat_priv, seq,
+                                              BATADV_IF_DEFAULT);
+
+       return 0;
+}
+
+/**
+ * batadv_orig_hardif_seq_print_text - writes originator infos for a specific
+ *  outgoing interface
+ * @seq: debugfs table seq_file struct
+ * @offset: not used
+ *
+ * Returns 0
+ */
+int batadv_orig_hardif_seq_print_text(struct seq_file *seq, void *offset)
+{
+       struct net_device *net_dev = (struct net_device *)seq->private;
+       struct batadv_hard_iface *hard_iface;
+       struct batadv_priv *bat_priv;
+
+       hard_iface = batadv_hardif_get_by_netdev(net_dev);
+
+       if (!hard_iface || !hard_iface->soft_iface) {
+               seq_puts(seq, "Interface not known to B.A.T.M.A.N.\n");
+               goto out;
+       }
+
+       bat_priv = netdev_priv(hard_iface->soft_iface);
+       if (!bat_priv->bat_algo_ops->bat_orig_print) {
+               seq_puts(seq,
+                        "No printing function for this routing protocol\n");
+               goto out;
+       }
+
+       if (hard_iface->if_status != BATADV_IF_ACTIVE) {
+               seq_puts(seq, "Interface not active\n");
+               goto out;
+       }
+
+       seq_printf(seq, "[B.A.T.M.A.N. adv %s, IF/MAC: %s/%pM (%s %s)]\n",
+                  BATADV_SOURCE_VERSION, hard_iface->net_dev->name,
+                  hard_iface->net_dev->dev_addr,
+                  hard_iface->soft_iface->name, bat_priv->bat_algo_ops->name);
+
+       bat_priv->bat_algo_ops->bat_orig_print(bat_priv, seq, hard_iface);
+
+out:
+       if (hard_iface)
+               batadv_hardif_free_ref(hard_iface);
+       return 0;
+}
+
+int batadv_orig_hash_add_if(struct batadv_hard_iface *hard_iface,
+                           int max_if_num)
+{
+       struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
+       struct batadv_algo_ops *bao = bat_priv->bat_algo_ops;
+       struct batadv_hashtable *hash = bat_priv->orig_hash;
+       struct hlist_head *head;
+       struct batadv_orig_node *orig_node;
+       uint32_t i;
+       int ret;
+
+       /* resize all orig nodes because orig_node->bcast_own(_sum) depend on
+        * if_num
+        */
+       for (i = 0; i < hash->size; i++) {
+               head = &hash->table[i];
+
+               rcu_read_lock();
+               hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
+                       ret = 0;
+                       if (bao->bat_orig_add_if)
+                               ret = bao->bat_orig_add_if(orig_node,
+                                                          max_if_num);
+                       if (ret == -ENOMEM)
+                               goto err;
+               }
+               rcu_read_unlock();
+       }
+
+       return 0;
+
+err:
+       rcu_read_unlock();
+       return -ENOMEM;
+}
+
+int batadv_orig_hash_del_if(struct batadv_hard_iface *hard_iface,
+                           int max_if_num)
+{
+       struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
+       struct batadv_hashtable *hash = bat_priv->orig_hash;
+       struct hlist_head *head;
+       struct batadv_hard_iface *hard_iface_tmp;
+       struct batadv_orig_node *orig_node;
+       struct batadv_algo_ops *bao = bat_priv->bat_algo_ops;
+       uint32_t i;
+       int ret;
+
+       /* resize all orig nodes because orig_node->bcast_own(_sum) depend on
+        * if_num
+        */
+       for (i = 0; i < hash->size; i++) {
+               head = &hash->table[i];
+
+               rcu_read_lock();
+               hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
+                       ret = 0;
+                       if (bao->bat_orig_del_if)
+                               ret = bao->bat_orig_del_if(orig_node,
+                                                          max_if_num,
+                                                          hard_iface->if_num);
+                       if (ret == -ENOMEM)
+                               goto err;
+               }
+               rcu_read_unlock();
+       }
+
+       /* renumber remaining batman interfaces _inside_ of orig_hash_lock */
+       rcu_read_lock();
+       list_for_each_entry_rcu(hard_iface_tmp, &batadv_hardif_list, list) {
+               if (hard_iface_tmp->if_status == BATADV_IF_NOT_IN_USE)
+                       continue;
+
+               if (hard_iface == hard_iface_tmp)
+                       continue;
+
+               if (hard_iface->soft_iface != hard_iface_tmp->soft_iface)
+                       continue;
+
+               if (hard_iface_tmp->if_num > hard_iface->if_num)
+                       hard_iface_tmp->if_num--;
+       }
+       rcu_read_unlock();
+
+       hard_iface->if_num = -1;
+       return 0;
+
+err:
+       rcu_read_unlock();
+       return -ENOMEM;
+}