1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright (C) B.A.T.M.A.N. contributors:
4 * Marek Lindner, Simon Wunderlich
7 #include "originator.h"
10 #include <linux/atomic.h>
11 #include <linux/errno.h>
12 #include <linux/etherdevice.h>
13 #include <linux/gfp.h>
14 #include <linux/jiffies.h>
15 #include <linux/kernel.h>
16 #include <linux/kref.h>
17 #include <linux/list.h>
18 #include <linux/lockdep.h>
19 #include <linux/netdevice.h>
20 #include <linux/netlink.h>
21 #include <linux/rculist.h>
22 #include <linux/rcupdate.h>
23 #include <linux/skbuff.h>
24 #include <linux/slab.h>
25 #include <linux/spinlock.h>
26 #include <linux/stddef.h>
27 #include <linux/workqueue.h>
29 #include <uapi/linux/batadv_packet.h>
30 #include <uapi/linux/batman_adv.h>
33 #include "distributed-arp-table.h"
34 #include "fragmentation.h"
35 #include "gateway_client.h"
36 #include "hard-interface.h"
39 #include "multicast.h"
41 #include "network-coding.h"
43 #include "soft-interface.h"
44 #include "translation-table.h"
47 static struct lock_class_key batadv_orig_hash_lock_class_key;
50 * batadv_orig_hash_find() - Find and return originator from orig_hash
51 * @bat_priv: the bat priv with all the soft interface information
52 * @data: mac address of the originator
54 * Return: orig_node (with increased refcnt), NULL on errors
56 struct batadv_orig_node *
57 batadv_orig_hash_find(struct batadv_priv *bat_priv, const void *data)
59 struct batadv_hashtable *hash = bat_priv->orig_hash;
60 struct hlist_head *head;
61 struct batadv_orig_node *orig_node, *orig_node_tmp = NULL;
67 index = batadv_choose_orig(data, hash->size);
68 head = &hash->table[index];
71 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
72 if (!batadv_compare_eth(orig_node, data))
75 if (!kref_get_unless_zero(&orig_node->refcount))
78 orig_node_tmp = orig_node;
86 static void batadv_purge_orig(struct work_struct *work);
89 * batadv_compare_orig() - comparing function used in the originator hash table
90 * @node: node in the local table
91 * @data2: second object to compare the node to
93 * Return: true if they are the same originator
95 bool batadv_compare_orig(const struct hlist_node *node, const void *data2)
97 const void *data1 = container_of(node, struct batadv_orig_node,
100 return batadv_compare_eth(data1, data2);
104 * batadv_orig_node_vlan_get() - get an orig_node_vlan object
105 * @orig_node: the originator serving the VLAN
106 * @vid: the VLAN identifier
108 * Return: the vlan object identified by vid and belonging to orig_node or NULL
109 * if it does not exist.
111 struct batadv_orig_node_vlan *
112 batadv_orig_node_vlan_get(struct batadv_orig_node *orig_node,
115 struct batadv_orig_node_vlan *vlan = NULL, *tmp;
118 hlist_for_each_entry_rcu(tmp, &orig_node->vlan_list, list) {
122 if (!kref_get_unless_zero(&tmp->refcount))
135 * batadv_orig_node_vlan_new() - search and possibly create an orig_node_vlan
137 * @orig_node: the originator serving the VLAN
138 * @vid: the VLAN identifier
140 * Return: NULL in case of failure or the vlan object identified by vid and
141 * belonging to orig_node otherwise. The object is created and added to the list
142 * if it does not exist.
144 * The object is returned with refcounter increased by 1.
146 struct batadv_orig_node_vlan *
147 batadv_orig_node_vlan_new(struct batadv_orig_node *orig_node,
150 struct batadv_orig_node_vlan *vlan;
152 spin_lock_bh(&orig_node->vlan_list_lock);
154 /* first look if an object for this vid already exists */
155 vlan = batadv_orig_node_vlan_get(orig_node, vid);
159 vlan = kzalloc(sizeof(*vlan), GFP_ATOMIC);
163 kref_init(&vlan->refcount);
166 kref_get(&vlan->refcount);
167 hlist_add_head_rcu(&vlan->list, &orig_node->vlan_list);
170 spin_unlock_bh(&orig_node->vlan_list_lock);
176 * batadv_orig_node_vlan_release() - release originator-vlan object from lists
177 * and queue for free after rcu grace period
178 * @ref: kref pointer of the originator-vlan object
180 static void batadv_orig_node_vlan_release(struct kref *ref)
182 struct batadv_orig_node_vlan *orig_vlan;
184 orig_vlan = container_of(ref, struct batadv_orig_node_vlan, refcount);
186 kfree_rcu(orig_vlan, rcu);
190 * batadv_orig_node_vlan_put() - decrement the refcounter and possibly release
191 * the originator-vlan object
192 * @orig_vlan: the originator-vlan object to release
194 void batadv_orig_node_vlan_put(struct batadv_orig_node_vlan *orig_vlan)
196 kref_put(&orig_vlan->refcount, batadv_orig_node_vlan_release);
200 * batadv_originator_init() - Initialize all originator structures
201 * @bat_priv: the bat priv with all the soft interface information
203 * Return: 0 on success or negative error number in case of failure
205 int batadv_originator_init(struct batadv_priv *bat_priv)
207 if (bat_priv->orig_hash)
210 bat_priv->orig_hash = batadv_hash_new(1024);
212 if (!bat_priv->orig_hash)
215 batadv_hash_set_lock_class(bat_priv->orig_hash,
216 &batadv_orig_hash_lock_class_key);
218 INIT_DELAYED_WORK(&bat_priv->orig_work, batadv_purge_orig);
219 queue_delayed_work(batadv_event_workqueue,
220 &bat_priv->orig_work,
221 msecs_to_jiffies(BATADV_ORIG_WORK_PERIOD));
230 * batadv_neigh_ifinfo_release() - release neigh_ifinfo from lists and queue for
231 * free after rcu grace period
232 * @ref: kref pointer of the neigh_ifinfo
234 static void batadv_neigh_ifinfo_release(struct kref *ref)
236 struct batadv_neigh_ifinfo *neigh_ifinfo;
238 neigh_ifinfo = container_of(ref, struct batadv_neigh_ifinfo, refcount);
240 if (neigh_ifinfo->if_outgoing != BATADV_IF_DEFAULT)
241 batadv_hardif_put(neigh_ifinfo->if_outgoing);
243 kfree_rcu(neigh_ifinfo, rcu);
247 * batadv_neigh_ifinfo_put() - decrement the refcounter and possibly release
249 * @neigh_ifinfo: the neigh_ifinfo object to release
251 void batadv_neigh_ifinfo_put(struct batadv_neigh_ifinfo *neigh_ifinfo)
253 kref_put(&neigh_ifinfo->refcount, batadv_neigh_ifinfo_release);
257 * batadv_hardif_neigh_release() - release hardif neigh node from lists and
258 * queue for free after rcu grace period
259 * @ref: kref pointer of the neigh_node
261 static void batadv_hardif_neigh_release(struct kref *ref)
263 struct batadv_hardif_neigh_node *hardif_neigh;
265 hardif_neigh = container_of(ref, struct batadv_hardif_neigh_node,
268 spin_lock_bh(&hardif_neigh->if_incoming->neigh_list_lock);
269 hlist_del_init_rcu(&hardif_neigh->list);
270 spin_unlock_bh(&hardif_neigh->if_incoming->neigh_list_lock);
272 batadv_hardif_put(hardif_neigh->if_incoming);
273 kfree_rcu(hardif_neigh, rcu);
277 * batadv_hardif_neigh_put() - decrement the hardif neighbors refcounter
278 * and possibly release it
279 * @hardif_neigh: hardif neigh neighbor to free
281 void batadv_hardif_neigh_put(struct batadv_hardif_neigh_node *hardif_neigh)
283 kref_put(&hardif_neigh->refcount, batadv_hardif_neigh_release);
287 * batadv_neigh_node_release() - release neigh_node from lists and queue for
288 * free after rcu grace period
289 * @ref: kref pointer of the neigh_node
291 static void batadv_neigh_node_release(struct kref *ref)
293 struct hlist_node *node_tmp;
294 struct batadv_neigh_node *neigh_node;
295 struct batadv_neigh_ifinfo *neigh_ifinfo;
297 neigh_node = container_of(ref, struct batadv_neigh_node, refcount);
299 hlist_for_each_entry_safe(neigh_ifinfo, node_tmp,
300 &neigh_node->ifinfo_list, list) {
301 batadv_neigh_ifinfo_put(neigh_ifinfo);
304 batadv_hardif_neigh_put(neigh_node->hardif_neigh);
306 batadv_hardif_put(neigh_node->if_incoming);
308 kfree_rcu(neigh_node, rcu);
312 * batadv_neigh_node_put() - decrement the neighbors refcounter and possibly
314 * @neigh_node: neigh neighbor to free
316 void batadv_neigh_node_put(struct batadv_neigh_node *neigh_node)
318 kref_put(&neigh_node->refcount, batadv_neigh_node_release);
322 * batadv_orig_router_get() - router to the originator depending on iface
323 * @orig_node: the orig node for the router
324 * @if_outgoing: the interface where the payload packet has been received or
325 * the OGM should be sent to
327 * Return: the neighbor which should be the router for this orig_node/iface.
329 * The object is returned with refcounter increased by 1.
331 struct batadv_neigh_node *
332 batadv_orig_router_get(struct batadv_orig_node *orig_node,
333 const struct batadv_hard_iface *if_outgoing)
335 struct batadv_orig_ifinfo *orig_ifinfo;
336 struct batadv_neigh_node *router = NULL;
339 hlist_for_each_entry_rcu(orig_ifinfo, &orig_node->ifinfo_list, list) {
340 if (orig_ifinfo->if_outgoing != if_outgoing)
343 router = rcu_dereference(orig_ifinfo->router);
347 if (router && !kref_get_unless_zero(&router->refcount))
355 * batadv_orig_ifinfo_get() - find the ifinfo from an orig_node
356 * @orig_node: the orig node to be queried
357 * @if_outgoing: the interface for which the ifinfo should be acquired
359 * Return: the requested orig_ifinfo or NULL if not found.
361 * The object is returned with refcounter increased by 1.
363 struct batadv_orig_ifinfo *
364 batadv_orig_ifinfo_get(struct batadv_orig_node *orig_node,
365 struct batadv_hard_iface *if_outgoing)
367 struct batadv_orig_ifinfo *tmp, *orig_ifinfo = NULL;
370 hlist_for_each_entry_rcu(tmp, &orig_node->ifinfo_list,
372 if (tmp->if_outgoing != if_outgoing)
375 if (!kref_get_unless_zero(&tmp->refcount))
387 * batadv_orig_ifinfo_new() - search and possibly create an orig_ifinfo object
388 * @orig_node: the orig node to be queried
389 * @if_outgoing: the interface for which the ifinfo should be acquired
391 * Return: NULL in case of failure or the orig_ifinfo object for the if_outgoing
392 * interface otherwise. The object is created and added to the list
393 * if it does not exist.
395 * The object is returned with refcounter increased by 1.
397 struct batadv_orig_ifinfo *
398 batadv_orig_ifinfo_new(struct batadv_orig_node *orig_node,
399 struct batadv_hard_iface *if_outgoing)
401 struct batadv_orig_ifinfo *orig_ifinfo;
402 unsigned long reset_time;
404 spin_lock_bh(&orig_node->neigh_list_lock);
406 orig_ifinfo = batadv_orig_ifinfo_get(orig_node, if_outgoing);
410 orig_ifinfo = kzalloc(sizeof(*orig_ifinfo), GFP_ATOMIC);
414 if (if_outgoing != BATADV_IF_DEFAULT)
415 kref_get(&if_outgoing->refcount);
417 reset_time = jiffies - 1;
418 reset_time -= msecs_to_jiffies(BATADV_RESET_PROTECTION_MS);
419 orig_ifinfo->batman_seqno_reset = reset_time;
420 orig_ifinfo->if_outgoing = if_outgoing;
421 INIT_HLIST_NODE(&orig_ifinfo->list);
422 kref_init(&orig_ifinfo->refcount);
424 kref_get(&orig_ifinfo->refcount);
425 hlist_add_head_rcu(&orig_ifinfo->list,
426 &orig_node->ifinfo_list);
428 spin_unlock_bh(&orig_node->neigh_list_lock);
433 * batadv_neigh_ifinfo_get() - find the ifinfo from an neigh_node
434 * @neigh: the neigh node to be queried
435 * @if_outgoing: the interface for which the ifinfo should be acquired
437 * The object is returned with refcounter increased by 1.
439 * Return: the requested neigh_ifinfo or NULL if not found
441 struct batadv_neigh_ifinfo *
442 batadv_neigh_ifinfo_get(struct batadv_neigh_node *neigh,
443 struct batadv_hard_iface *if_outgoing)
445 struct batadv_neigh_ifinfo *neigh_ifinfo = NULL,
449 hlist_for_each_entry_rcu(tmp_neigh_ifinfo, &neigh->ifinfo_list,
451 if (tmp_neigh_ifinfo->if_outgoing != if_outgoing)
454 if (!kref_get_unless_zero(&tmp_neigh_ifinfo->refcount))
457 neigh_ifinfo = tmp_neigh_ifinfo;
466 * batadv_neigh_ifinfo_new() - search and possibly create an neigh_ifinfo object
467 * @neigh: the neigh node to be queried
468 * @if_outgoing: the interface for which the ifinfo should be acquired
470 * Return: NULL in case of failure or the neigh_ifinfo object for the
471 * if_outgoing interface otherwise. The object is created and added to the list
472 * if it does not exist.
474 * The object is returned with refcounter increased by 1.
476 struct batadv_neigh_ifinfo *
477 batadv_neigh_ifinfo_new(struct batadv_neigh_node *neigh,
478 struct batadv_hard_iface *if_outgoing)
480 struct batadv_neigh_ifinfo *neigh_ifinfo;
482 spin_lock_bh(&neigh->ifinfo_lock);
484 neigh_ifinfo = batadv_neigh_ifinfo_get(neigh, if_outgoing);
488 neigh_ifinfo = kzalloc(sizeof(*neigh_ifinfo), GFP_ATOMIC);
493 kref_get(&if_outgoing->refcount);
495 INIT_HLIST_NODE(&neigh_ifinfo->list);
496 kref_init(&neigh_ifinfo->refcount);
497 neigh_ifinfo->if_outgoing = if_outgoing;
499 kref_get(&neigh_ifinfo->refcount);
500 hlist_add_head_rcu(&neigh_ifinfo->list, &neigh->ifinfo_list);
503 spin_unlock_bh(&neigh->ifinfo_lock);
509 * batadv_neigh_node_get() - retrieve a neighbour from the list
510 * @orig_node: originator which the neighbour belongs to
511 * @hard_iface: the interface where this neighbour is connected to
512 * @addr: the address of the neighbour
514 * Looks for and possibly returns a neighbour belonging to this originator list
515 * which is connected through the provided hard interface.
517 * Return: neighbor when found. Otherwise NULL
519 static struct batadv_neigh_node *
520 batadv_neigh_node_get(const struct batadv_orig_node *orig_node,
521 const struct batadv_hard_iface *hard_iface,
524 struct batadv_neigh_node *tmp_neigh_node, *res = NULL;
527 hlist_for_each_entry_rcu(tmp_neigh_node, &orig_node->neigh_list, list) {
528 if (!batadv_compare_eth(tmp_neigh_node->addr, addr))
531 if (tmp_neigh_node->if_incoming != hard_iface)
534 if (!kref_get_unless_zero(&tmp_neigh_node->refcount))
537 res = tmp_neigh_node;
546 * batadv_hardif_neigh_create() - create a hardif neighbour node
547 * @hard_iface: the interface this neighbour is connected to
548 * @neigh_addr: the interface address of the neighbour to retrieve
549 * @orig_node: originator object representing the neighbour
551 * Return: the hardif neighbour node if found or created or NULL otherwise.
553 static struct batadv_hardif_neigh_node *
554 batadv_hardif_neigh_create(struct batadv_hard_iface *hard_iface,
555 const u8 *neigh_addr,
556 struct batadv_orig_node *orig_node)
558 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
559 struct batadv_hardif_neigh_node *hardif_neigh;
561 spin_lock_bh(&hard_iface->neigh_list_lock);
563 /* check if neighbor hasn't been added in the meantime */
564 hardif_neigh = batadv_hardif_neigh_get(hard_iface, neigh_addr);
568 hardif_neigh = kzalloc(sizeof(*hardif_neigh), GFP_ATOMIC);
572 kref_get(&hard_iface->refcount);
573 INIT_HLIST_NODE(&hardif_neigh->list);
574 ether_addr_copy(hardif_neigh->addr, neigh_addr);
575 ether_addr_copy(hardif_neigh->orig, orig_node->orig);
576 hardif_neigh->if_incoming = hard_iface;
577 hardif_neigh->last_seen = jiffies;
579 kref_init(&hardif_neigh->refcount);
581 if (bat_priv->algo_ops->neigh.hardif_init)
582 bat_priv->algo_ops->neigh.hardif_init(hardif_neigh);
584 hlist_add_head_rcu(&hardif_neigh->list, &hard_iface->neigh_list);
587 spin_unlock_bh(&hard_iface->neigh_list_lock);
592 * batadv_hardif_neigh_get_or_create() - retrieve or create a hardif neighbour
594 * @hard_iface: the interface this neighbour is connected to
595 * @neigh_addr: the interface address of the neighbour to retrieve
596 * @orig_node: originator object representing the neighbour
598 * Return: the hardif neighbour node if found or created or NULL otherwise.
600 static struct batadv_hardif_neigh_node *
601 batadv_hardif_neigh_get_or_create(struct batadv_hard_iface *hard_iface,
602 const u8 *neigh_addr,
603 struct batadv_orig_node *orig_node)
605 struct batadv_hardif_neigh_node *hardif_neigh;
607 /* first check without locking to avoid the overhead */
608 hardif_neigh = batadv_hardif_neigh_get(hard_iface, neigh_addr);
612 return batadv_hardif_neigh_create(hard_iface, neigh_addr, orig_node);
616 * batadv_hardif_neigh_get() - retrieve a hardif neighbour from the list
617 * @hard_iface: the interface where this neighbour is connected to
618 * @neigh_addr: the address of the neighbour
620 * Looks for and possibly returns a neighbour belonging to this hard interface.
622 * Return: neighbor when found. Otherwise NULL
624 struct batadv_hardif_neigh_node *
625 batadv_hardif_neigh_get(const struct batadv_hard_iface *hard_iface,
626 const u8 *neigh_addr)
628 struct batadv_hardif_neigh_node *tmp_hardif_neigh, *hardif_neigh = NULL;
631 hlist_for_each_entry_rcu(tmp_hardif_neigh,
632 &hard_iface->neigh_list, list) {
633 if (!batadv_compare_eth(tmp_hardif_neigh->addr, neigh_addr))
636 if (!kref_get_unless_zero(&tmp_hardif_neigh->refcount))
639 hardif_neigh = tmp_hardif_neigh;
648 * batadv_neigh_node_create() - create a neigh node object
649 * @orig_node: originator object representing the neighbour
650 * @hard_iface: the interface where the neighbour is connected to
651 * @neigh_addr: the mac address of the neighbour interface
653 * Allocates a new neigh_node object and initialises all the generic fields.
655 * Return: the neighbour node if found or created or NULL otherwise.
657 static struct batadv_neigh_node *
658 batadv_neigh_node_create(struct batadv_orig_node *orig_node,
659 struct batadv_hard_iface *hard_iface,
660 const u8 *neigh_addr)
662 struct batadv_neigh_node *neigh_node;
663 struct batadv_hardif_neigh_node *hardif_neigh = NULL;
665 spin_lock_bh(&orig_node->neigh_list_lock);
667 neigh_node = batadv_neigh_node_get(orig_node, hard_iface, neigh_addr);
671 hardif_neigh = batadv_hardif_neigh_get_or_create(hard_iface,
672 neigh_addr, orig_node);
676 neigh_node = kzalloc(sizeof(*neigh_node), GFP_ATOMIC);
680 INIT_HLIST_NODE(&neigh_node->list);
681 INIT_HLIST_HEAD(&neigh_node->ifinfo_list);
682 spin_lock_init(&neigh_node->ifinfo_lock);
684 kref_get(&hard_iface->refcount);
685 ether_addr_copy(neigh_node->addr, neigh_addr);
686 neigh_node->if_incoming = hard_iface;
687 neigh_node->orig_node = orig_node;
688 neigh_node->last_seen = jiffies;
690 /* increment unique neighbor refcount */
691 kref_get(&hardif_neigh->refcount);
692 neigh_node->hardif_neigh = hardif_neigh;
694 /* extra reference for return */
695 kref_init(&neigh_node->refcount);
697 kref_get(&neigh_node->refcount);
698 hlist_add_head_rcu(&neigh_node->list, &orig_node->neigh_list);
700 batadv_dbg(BATADV_DBG_BATMAN, orig_node->bat_priv,
701 "Creating new neighbor %pM for orig_node %pM on interface %s\n",
702 neigh_addr, orig_node->orig, hard_iface->net_dev->name);
705 spin_unlock_bh(&orig_node->neigh_list_lock);
708 batadv_hardif_neigh_put(hardif_neigh);
713 * batadv_neigh_node_get_or_create() - retrieve or create a neigh node object
714 * @orig_node: originator object representing the neighbour
715 * @hard_iface: the interface where the neighbour is connected to
716 * @neigh_addr: the mac address of the neighbour interface
718 * Return: the neighbour node if found or created or NULL otherwise.
720 struct batadv_neigh_node *
721 batadv_neigh_node_get_or_create(struct batadv_orig_node *orig_node,
722 struct batadv_hard_iface *hard_iface,
723 const u8 *neigh_addr)
725 struct batadv_neigh_node *neigh_node;
727 /* first check without locking to avoid the overhead */
728 neigh_node = batadv_neigh_node_get(orig_node, hard_iface, neigh_addr);
732 return batadv_neigh_node_create(orig_node, hard_iface, neigh_addr);
736 * batadv_hardif_neigh_dump() - Dump to netlink the neighbor infos for a
737 * specific outgoing interface
738 * @msg: message to dump into
739 * @cb: parameters for the dump
741 * Return: 0 or error value
743 int batadv_hardif_neigh_dump(struct sk_buff *msg, struct netlink_callback *cb)
745 struct net *net = sock_net(cb->skb->sk);
746 struct net_device *soft_iface;
747 struct net_device *hard_iface = NULL;
748 struct batadv_hard_iface *hardif = BATADV_IF_DEFAULT;
749 struct batadv_priv *bat_priv;
750 struct batadv_hard_iface *primary_if = NULL;
752 int ifindex, hard_ifindex;
754 ifindex = batadv_netlink_get_ifindex(cb->nlh, BATADV_ATTR_MESH_IFINDEX);
758 soft_iface = dev_get_by_index(net, ifindex);
759 if (!soft_iface || !batadv_softif_is_valid(soft_iface)) {
764 bat_priv = netdev_priv(soft_iface);
766 primary_if = batadv_primary_if_get_selected(bat_priv);
767 if (!primary_if || primary_if->if_status != BATADV_IF_ACTIVE) {
772 hard_ifindex = batadv_netlink_get_ifindex(cb->nlh,
773 BATADV_ATTR_HARD_IFINDEX);
775 hard_iface = dev_get_by_index(net, hard_ifindex);
777 hardif = batadv_hardif_get_by_netdev(hard_iface);
784 if (hardif->soft_iface != soft_iface) {
790 if (!bat_priv->algo_ops->neigh.dump) {
795 bat_priv->algo_ops->neigh.dump(msg, cb, bat_priv, hardif);
801 batadv_hardif_put(hardif);
804 batadv_hardif_put(primary_if);
811 * batadv_orig_ifinfo_release() - release orig_ifinfo from lists and queue for
812 * free after rcu grace period
813 * @ref: kref pointer of the orig_ifinfo
815 static void batadv_orig_ifinfo_release(struct kref *ref)
817 struct batadv_orig_ifinfo *orig_ifinfo;
818 struct batadv_neigh_node *router;
820 orig_ifinfo = container_of(ref, struct batadv_orig_ifinfo, refcount);
822 if (orig_ifinfo->if_outgoing != BATADV_IF_DEFAULT)
823 batadv_hardif_put(orig_ifinfo->if_outgoing);
825 /* this is the last reference to this object */
826 router = rcu_dereference_protected(orig_ifinfo->router, true);
828 batadv_neigh_node_put(router);
830 kfree_rcu(orig_ifinfo, rcu);
834 * batadv_orig_ifinfo_put() - decrement the refcounter and possibly release
836 * @orig_ifinfo: the orig_ifinfo object to release
838 void batadv_orig_ifinfo_put(struct batadv_orig_ifinfo *orig_ifinfo)
840 kref_put(&orig_ifinfo->refcount, batadv_orig_ifinfo_release);
844 * batadv_orig_node_free_rcu() - free the orig_node
845 * @rcu: rcu pointer of the orig_node
847 static void batadv_orig_node_free_rcu(struct rcu_head *rcu)
849 struct batadv_orig_node *orig_node;
851 orig_node = container_of(rcu, struct batadv_orig_node, rcu);
853 batadv_mcast_purge_orig(orig_node);
855 batadv_frag_purge_orig(orig_node, NULL);
857 kfree(orig_node->tt_buff);
862 * batadv_orig_node_release() - release orig_node from lists and queue for
863 * free after rcu grace period
864 * @ref: kref pointer of the orig_node
866 static void batadv_orig_node_release(struct kref *ref)
868 struct hlist_node *node_tmp;
869 struct batadv_neigh_node *neigh_node;
870 struct batadv_orig_node *orig_node;
871 struct batadv_orig_ifinfo *orig_ifinfo;
872 struct batadv_orig_node_vlan *vlan;
873 struct batadv_orig_ifinfo *last_candidate;
875 orig_node = container_of(ref, struct batadv_orig_node, refcount);
877 spin_lock_bh(&orig_node->neigh_list_lock);
879 /* for all neighbors towards this originator ... */
880 hlist_for_each_entry_safe(neigh_node, node_tmp,
881 &orig_node->neigh_list, list) {
882 hlist_del_rcu(&neigh_node->list);
883 batadv_neigh_node_put(neigh_node);
886 hlist_for_each_entry_safe(orig_ifinfo, node_tmp,
887 &orig_node->ifinfo_list, list) {
888 hlist_del_rcu(&orig_ifinfo->list);
889 batadv_orig_ifinfo_put(orig_ifinfo);
892 last_candidate = orig_node->last_bonding_candidate;
893 orig_node->last_bonding_candidate = NULL;
894 spin_unlock_bh(&orig_node->neigh_list_lock);
897 batadv_orig_ifinfo_put(last_candidate);
899 spin_lock_bh(&orig_node->vlan_list_lock);
900 hlist_for_each_entry_safe(vlan, node_tmp, &orig_node->vlan_list, list) {
901 hlist_del_rcu(&vlan->list);
902 batadv_orig_node_vlan_put(vlan);
904 spin_unlock_bh(&orig_node->vlan_list_lock);
907 batadv_nc_purge_orig(orig_node->bat_priv, orig_node, NULL);
909 call_rcu(&orig_node->rcu, batadv_orig_node_free_rcu);
913 * batadv_orig_node_put() - decrement the orig node refcounter and possibly
915 * @orig_node: the orig node to free
917 void batadv_orig_node_put(struct batadv_orig_node *orig_node)
919 kref_put(&orig_node->refcount, batadv_orig_node_release);
923 * batadv_originator_free() - Free all originator structures
924 * @bat_priv: the bat priv with all the soft interface information
926 void batadv_originator_free(struct batadv_priv *bat_priv)
928 struct batadv_hashtable *hash = bat_priv->orig_hash;
929 struct hlist_node *node_tmp;
930 struct hlist_head *head;
931 spinlock_t *list_lock; /* spinlock to protect write access */
932 struct batadv_orig_node *orig_node;
938 cancel_delayed_work_sync(&bat_priv->orig_work);
940 bat_priv->orig_hash = NULL;
942 for (i = 0; i < hash->size; i++) {
943 head = &hash->table[i];
944 list_lock = &hash->list_locks[i];
946 spin_lock_bh(list_lock);
947 hlist_for_each_entry_safe(orig_node, node_tmp,
949 hlist_del_rcu(&orig_node->hash_entry);
950 batadv_orig_node_put(orig_node);
952 spin_unlock_bh(list_lock);
955 batadv_hash_destroy(hash);
959 * batadv_orig_node_new() - creates a new orig_node
960 * @bat_priv: the bat priv with all the soft interface information
961 * @addr: the mac address of the originator
963 * Creates a new originator object and initialises all the generic fields.
964 * The new object is not added to the originator list.
966 * Return: the newly created object or NULL on failure.
968 struct batadv_orig_node *batadv_orig_node_new(struct batadv_priv *bat_priv,
971 struct batadv_orig_node *orig_node;
972 struct batadv_orig_node_vlan *vlan;
973 unsigned long reset_time;
976 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
977 "Creating new originator: %pM\n", addr);
979 orig_node = kzalloc(sizeof(*orig_node), GFP_ATOMIC);
983 INIT_HLIST_HEAD(&orig_node->neigh_list);
984 INIT_HLIST_HEAD(&orig_node->vlan_list);
985 INIT_HLIST_HEAD(&orig_node->ifinfo_list);
986 spin_lock_init(&orig_node->bcast_seqno_lock);
987 spin_lock_init(&orig_node->neigh_list_lock);
988 spin_lock_init(&orig_node->tt_buff_lock);
989 spin_lock_init(&orig_node->tt_lock);
990 spin_lock_init(&orig_node->vlan_list_lock);
992 batadv_nc_init_orig(orig_node);
994 /* extra reference for return */
995 kref_init(&orig_node->refcount);
997 orig_node->bat_priv = bat_priv;
998 ether_addr_copy(orig_node->orig, addr);
999 batadv_dat_init_orig_node_addr(orig_node);
1000 atomic_set(&orig_node->last_ttvn, 0);
1001 orig_node->tt_buff = NULL;
1002 orig_node->tt_buff_len = 0;
1003 orig_node->last_seen = jiffies;
1004 reset_time = jiffies - 1 - msecs_to_jiffies(BATADV_RESET_PROTECTION_MS);
1005 orig_node->bcast_seqno_reset = reset_time;
1007 #ifdef CONFIG_BATMAN_ADV_MCAST
1008 orig_node->mcast_flags = BATADV_MCAST_WANT_NO_RTR4;
1009 orig_node->mcast_flags |= BATADV_MCAST_WANT_NO_RTR6;
1010 INIT_HLIST_NODE(&orig_node->mcast_want_all_unsnoopables_node);
1011 INIT_HLIST_NODE(&orig_node->mcast_want_all_ipv4_node);
1012 INIT_HLIST_NODE(&orig_node->mcast_want_all_ipv6_node);
1013 spin_lock_init(&orig_node->mcast_handler_lock);
1016 /* create a vlan object for the "untagged" LAN */
1017 vlan = batadv_orig_node_vlan_new(orig_node, BATADV_NO_FLAGS);
1019 goto free_orig_node;
1020 /* batadv_orig_node_vlan_new() increases the refcounter.
1021 * Immediately release vlan since it is not needed anymore in this
1024 batadv_orig_node_vlan_put(vlan);
1026 for (i = 0; i < BATADV_FRAG_BUFFER_COUNT; i++) {
1027 INIT_HLIST_HEAD(&orig_node->fragments[i].fragment_list);
1028 spin_lock_init(&orig_node->fragments[i].lock);
1029 orig_node->fragments[i].size = 0;
1039 * batadv_purge_neigh_ifinfo() - purge obsolete ifinfo entries from neighbor
1040 * @bat_priv: the bat priv with all the soft interface information
1041 * @neigh: orig node which is to be checked
1044 batadv_purge_neigh_ifinfo(struct batadv_priv *bat_priv,
1045 struct batadv_neigh_node *neigh)
1047 struct batadv_neigh_ifinfo *neigh_ifinfo;
1048 struct batadv_hard_iface *if_outgoing;
1049 struct hlist_node *node_tmp;
1051 spin_lock_bh(&neigh->ifinfo_lock);
1053 /* for all ifinfo objects for this neighinator */
1054 hlist_for_each_entry_safe(neigh_ifinfo, node_tmp,
1055 &neigh->ifinfo_list, list) {
1056 if_outgoing = neigh_ifinfo->if_outgoing;
1058 /* always keep the default interface */
1059 if (if_outgoing == BATADV_IF_DEFAULT)
1062 /* don't purge if the interface is not (going) down */
1063 if (if_outgoing->if_status != BATADV_IF_INACTIVE &&
1064 if_outgoing->if_status != BATADV_IF_NOT_IN_USE &&
1065 if_outgoing->if_status != BATADV_IF_TO_BE_REMOVED)
1068 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1069 "neighbor/ifinfo purge: neighbor %pM, iface: %s\n",
1070 neigh->addr, if_outgoing->net_dev->name);
1072 hlist_del_rcu(&neigh_ifinfo->list);
1073 batadv_neigh_ifinfo_put(neigh_ifinfo);
1076 spin_unlock_bh(&neigh->ifinfo_lock);
1080 * batadv_purge_orig_ifinfo() - purge obsolete ifinfo entries from originator
1081 * @bat_priv: the bat priv with all the soft interface information
1082 * @orig_node: orig node which is to be checked
1084 * Return: true if any ifinfo entry was purged, false otherwise.
1087 batadv_purge_orig_ifinfo(struct batadv_priv *bat_priv,
1088 struct batadv_orig_node *orig_node)
1090 struct batadv_orig_ifinfo *orig_ifinfo;
1091 struct batadv_hard_iface *if_outgoing;
1092 struct hlist_node *node_tmp;
1093 bool ifinfo_purged = false;
1095 spin_lock_bh(&orig_node->neigh_list_lock);
1097 /* for all ifinfo objects for this originator */
1098 hlist_for_each_entry_safe(orig_ifinfo, node_tmp,
1099 &orig_node->ifinfo_list, list) {
1100 if_outgoing = orig_ifinfo->if_outgoing;
1102 /* always keep the default interface */
1103 if (if_outgoing == BATADV_IF_DEFAULT)
1106 /* don't purge if the interface is not (going) down */
1107 if (if_outgoing->if_status != BATADV_IF_INACTIVE &&
1108 if_outgoing->if_status != BATADV_IF_NOT_IN_USE &&
1109 if_outgoing->if_status != BATADV_IF_TO_BE_REMOVED)
1112 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1113 "router/ifinfo purge: originator %pM, iface: %s\n",
1114 orig_node->orig, if_outgoing->net_dev->name);
1116 ifinfo_purged = true;
1118 hlist_del_rcu(&orig_ifinfo->list);
1119 batadv_orig_ifinfo_put(orig_ifinfo);
1120 if (orig_node->last_bonding_candidate == orig_ifinfo) {
1121 orig_node->last_bonding_candidate = NULL;
1122 batadv_orig_ifinfo_put(orig_ifinfo);
1126 spin_unlock_bh(&orig_node->neigh_list_lock);
1128 return ifinfo_purged;
1132 * batadv_purge_orig_neighbors() - purges neighbors from originator
1133 * @bat_priv: the bat priv with all the soft interface information
1134 * @orig_node: orig node which is to be checked
1136 * Return: true if any neighbor was purged, false otherwise
1139 batadv_purge_orig_neighbors(struct batadv_priv *bat_priv,
1140 struct batadv_orig_node *orig_node)
1142 struct hlist_node *node_tmp;
1143 struct batadv_neigh_node *neigh_node;
1144 bool neigh_purged = false;
1145 unsigned long last_seen;
1146 struct batadv_hard_iface *if_incoming;
1148 spin_lock_bh(&orig_node->neigh_list_lock);
1150 /* for all neighbors towards this originator ... */
1151 hlist_for_each_entry_safe(neigh_node, node_tmp,
1152 &orig_node->neigh_list, list) {
1153 last_seen = neigh_node->last_seen;
1154 if_incoming = neigh_node->if_incoming;
1156 if (batadv_has_timed_out(last_seen, BATADV_PURGE_TIMEOUT) ||
1157 if_incoming->if_status == BATADV_IF_INACTIVE ||
1158 if_incoming->if_status == BATADV_IF_NOT_IN_USE ||
1159 if_incoming->if_status == BATADV_IF_TO_BE_REMOVED) {
1160 if (if_incoming->if_status == BATADV_IF_INACTIVE ||
1161 if_incoming->if_status == BATADV_IF_NOT_IN_USE ||
1162 if_incoming->if_status == BATADV_IF_TO_BE_REMOVED)
1163 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1164 "neighbor purge: originator %pM, neighbor: %pM, iface: %s\n",
1165 orig_node->orig, neigh_node->addr,
1166 if_incoming->net_dev->name);
1168 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1169 "neighbor timeout: originator %pM, neighbor: %pM, last_seen: %u\n",
1170 orig_node->orig, neigh_node->addr,
1171 jiffies_to_msecs(last_seen));
1173 neigh_purged = true;
1175 hlist_del_rcu(&neigh_node->list);
1176 batadv_neigh_node_put(neigh_node);
1178 /* only necessary if not the whole neighbor is to be
1179 * deleted, but some interface has been removed.
1181 batadv_purge_neigh_ifinfo(bat_priv, neigh_node);
1185 spin_unlock_bh(&orig_node->neigh_list_lock);
1186 return neigh_purged;
1190 * batadv_find_best_neighbor() - finds the best neighbor after purging
1191 * @bat_priv: the bat priv with all the soft interface information
1192 * @orig_node: orig node which is to be checked
1193 * @if_outgoing: the interface for which the metric should be compared
1195 * Return: the current best neighbor, with refcount increased.
1197 static struct batadv_neigh_node *
1198 batadv_find_best_neighbor(struct batadv_priv *bat_priv,
1199 struct batadv_orig_node *orig_node,
1200 struct batadv_hard_iface *if_outgoing)
1202 struct batadv_neigh_node *best = NULL, *neigh;
1203 struct batadv_algo_ops *bao = bat_priv->algo_ops;
1206 hlist_for_each_entry_rcu(neigh, &orig_node->neigh_list, list) {
1207 if (best && (bao->neigh.cmp(neigh, if_outgoing, best,
1211 if (!kref_get_unless_zero(&neigh->refcount))
1215 batadv_neigh_node_put(best);
1225 * batadv_purge_orig_node() - purges obsolete information from an orig_node
1226 * @bat_priv: the bat priv with all the soft interface information
1227 * @orig_node: orig node which is to be checked
1229 * This function checks if the orig_node or substructures of it have become
1230 * obsolete, and purges this information if that's the case.
1232 * Return: true if the orig_node is to be removed, false otherwise.
1234 static bool batadv_purge_orig_node(struct batadv_priv *bat_priv,
1235 struct batadv_orig_node *orig_node)
1237 struct batadv_neigh_node *best_neigh_node;
1238 struct batadv_hard_iface *hard_iface;
1239 bool changed_ifinfo, changed_neigh;
1241 if (batadv_has_timed_out(orig_node->last_seen,
1242 2 * BATADV_PURGE_TIMEOUT)) {
1243 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1244 "Originator timeout: originator %pM, last_seen %u\n",
1246 jiffies_to_msecs(orig_node->last_seen));
1249 changed_ifinfo = batadv_purge_orig_ifinfo(bat_priv, orig_node);
1250 changed_neigh = batadv_purge_orig_neighbors(bat_priv, orig_node);
1252 if (!changed_ifinfo && !changed_neigh)
1255 /* first for NULL ... */
1256 best_neigh_node = batadv_find_best_neighbor(bat_priv, orig_node,
1258 batadv_update_route(bat_priv, orig_node, BATADV_IF_DEFAULT,
1260 if (best_neigh_node)
1261 batadv_neigh_node_put(best_neigh_node);
1263 /* ... then for all other interfaces. */
1265 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
1266 if (hard_iface->if_status != BATADV_IF_ACTIVE)
1269 if (hard_iface->soft_iface != bat_priv->soft_iface)
1272 if (!kref_get_unless_zero(&hard_iface->refcount))
1275 best_neigh_node = batadv_find_best_neighbor(bat_priv,
1278 batadv_update_route(bat_priv, orig_node, hard_iface,
1280 if (best_neigh_node)
1281 batadv_neigh_node_put(best_neigh_node);
1283 batadv_hardif_put(hard_iface);
1291 * batadv_purge_orig_ref() - Purge all outdated originators
1292 * @bat_priv: the bat priv with all the soft interface information
1294 void batadv_purge_orig_ref(struct batadv_priv *bat_priv)
1296 struct batadv_hashtable *hash = bat_priv->orig_hash;
1297 struct hlist_node *node_tmp;
1298 struct hlist_head *head;
1299 spinlock_t *list_lock; /* spinlock to protect write access */
1300 struct batadv_orig_node *orig_node;
1306 /* for all origins... */
1307 for (i = 0; i < hash->size; i++) {
1308 head = &hash->table[i];
1309 list_lock = &hash->list_locks[i];
1311 spin_lock_bh(list_lock);
1312 hlist_for_each_entry_safe(orig_node, node_tmp,
1314 if (batadv_purge_orig_node(bat_priv, orig_node)) {
1315 batadv_gw_node_delete(bat_priv, orig_node);
1316 hlist_del_rcu(&orig_node->hash_entry);
1317 batadv_tt_global_del_orig(orig_node->bat_priv,
1319 "originator timed out");
1320 batadv_orig_node_put(orig_node);
1324 batadv_frag_purge_orig(orig_node,
1325 batadv_frag_check_entry);
1327 spin_unlock_bh(list_lock);
1330 batadv_gw_election(bat_priv);
1333 static void batadv_purge_orig(struct work_struct *work)
1335 struct delayed_work *delayed_work;
1336 struct batadv_priv *bat_priv;
1338 delayed_work = to_delayed_work(work);
1339 bat_priv = container_of(delayed_work, struct batadv_priv, orig_work);
1340 batadv_purge_orig_ref(bat_priv);
1341 queue_delayed_work(batadv_event_workqueue,
1342 &bat_priv->orig_work,
1343 msecs_to_jiffies(BATADV_ORIG_WORK_PERIOD));
1347 * batadv_orig_dump() - Dump to netlink the originator infos for a specific
1348 * outgoing interface
1349 * @msg: message to dump into
1350 * @cb: parameters for the dump
1352 * Return: 0 or error value
1354 int batadv_orig_dump(struct sk_buff *msg, struct netlink_callback *cb)
1356 struct net *net = sock_net(cb->skb->sk);
1357 struct net_device *soft_iface;
1358 struct net_device *hard_iface = NULL;
1359 struct batadv_hard_iface *hardif = BATADV_IF_DEFAULT;
1360 struct batadv_priv *bat_priv;
1361 struct batadv_hard_iface *primary_if = NULL;
1363 int ifindex, hard_ifindex;
1365 ifindex = batadv_netlink_get_ifindex(cb->nlh, BATADV_ATTR_MESH_IFINDEX);
1369 soft_iface = dev_get_by_index(net, ifindex);
1370 if (!soft_iface || !batadv_softif_is_valid(soft_iface)) {
1375 bat_priv = netdev_priv(soft_iface);
1377 primary_if = batadv_primary_if_get_selected(bat_priv);
1378 if (!primary_if || primary_if->if_status != BATADV_IF_ACTIVE) {
1383 hard_ifindex = batadv_netlink_get_ifindex(cb->nlh,
1384 BATADV_ATTR_HARD_IFINDEX);
1386 hard_iface = dev_get_by_index(net, hard_ifindex);
1388 hardif = batadv_hardif_get_by_netdev(hard_iface);
1395 if (hardif->soft_iface != soft_iface) {
1401 if (!bat_priv->algo_ops->orig.dump) {
1406 bat_priv->algo_ops->orig.dump(msg, cb, bat_priv, hardif);
1412 batadv_hardif_put(hardif);
1413 dev_put(hard_iface);
1415 batadv_hardif_put(primary_if);
1416 dev_put(soft_iface);