1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright (C) 2009-2018 B.A.T.M.A.N. contributors:
4 * Marek Lindner, Simon Wunderlich
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of version 2 of the GNU General Public
8 * License as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, see <http://www.gnu.org/licenses/>.
19 #include "originator.h"
22 #include <linux/atomic.h>
23 #include <linux/errno.h>
24 #include <linux/etherdevice.h>
25 #include <linux/gfp.h>
26 #include <linux/jiffies.h>
27 #include <linux/kernel.h>
28 #include <linux/kref.h>
29 #include <linux/list.h>
30 #include <linux/lockdep.h>
31 #include <linux/netdevice.h>
32 #include <linux/netlink.h>
33 #include <linux/rculist.h>
34 #include <linux/rcupdate.h>
35 #include <linux/seq_file.h>
36 #include <linux/skbuff.h>
37 #include <linux/slab.h>
38 #include <linux/spinlock.h>
39 #include <linux/stddef.h>
40 #include <linux/workqueue.h>
42 #include <uapi/linux/batman_adv.h>
45 #include "distributed-arp-table.h"
46 #include "fragmentation.h"
47 #include "gateway_client.h"
48 #include "hard-interface.h"
51 #include "multicast.h"
53 #include "network-coding.h"
55 #include "soft-interface.h"
56 #include "translation-table.h"
59 static struct lock_class_key batadv_orig_hash_lock_class_key;
62 * batadv_orig_hash_find() - Find and return originator from orig_hash
63 * @bat_priv: the bat priv with all the soft interface information
64 * @data: mac address of the originator
66 * Return: orig_node (with increased refcnt), NULL on errors
68 struct batadv_orig_node *
69 batadv_orig_hash_find(struct batadv_priv *bat_priv, const void *data)
71 struct batadv_hashtable *hash = bat_priv->orig_hash;
72 struct hlist_head *head;
73 struct batadv_orig_node *orig_node, *orig_node_tmp = NULL;
79 index = batadv_choose_orig(data, hash->size);
80 head = &hash->table[index];
83 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
84 if (!batadv_compare_eth(orig_node, data))
87 if (!kref_get_unless_zero(&orig_node->refcount))
90 orig_node_tmp = orig_node;
98 static void batadv_purge_orig(struct work_struct *work);
101 * batadv_compare_orig() - comparing function used in the originator hash table
102 * @node: node in the local table
103 * @data2: second object to compare the node to
105 * Return: true if they are the same originator
107 bool batadv_compare_orig(const struct hlist_node *node, const void *data2)
109 const void *data1 = container_of(node, struct batadv_orig_node,
112 return batadv_compare_eth(data1, data2);
116 * batadv_orig_node_vlan_get() - get an orig_node_vlan object
117 * @orig_node: the originator serving the VLAN
118 * @vid: the VLAN identifier
120 * Return: the vlan object identified by vid and belonging to orig_node or NULL
121 * if it does not exist.
123 struct batadv_orig_node_vlan *
124 batadv_orig_node_vlan_get(struct batadv_orig_node *orig_node,
127 struct batadv_orig_node_vlan *vlan = NULL, *tmp;
130 hlist_for_each_entry_rcu(tmp, &orig_node->vlan_list, list) {
134 if (!kref_get_unless_zero(&tmp->refcount))
147 * batadv_orig_node_vlan_new() - search and possibly create an orig_node_vlan
149 * @orig_node: the originator serving the VLAN
150 * @vid: the VLAN identifier
152 * Return: NULL in case of failure or the vlan object identified by vid and
153 * belonging to orig_node otherwise. The object is created and added to the list
154 * if it does not exist.
156 * The object is returned with refcounter increased by 1.
158 struct batadv_orig_node_vlan *
159 batadv_orig_node_vlan_new(struct batadv_orig_node *orig_node,
162 struct batadv_orig_node_vlan *vlan;
164 spin_lock_bh(&orig_node->vlan_list_lock);
166 /* first look if an object for this vid already exists */
167 vlan = batadv_orig_node_vlan_get(orig_node, vid);
171 vlan = kzalloc(sizeof(*vlan), GFP_ATOMIC);
175 kref_init(&vlan->refcount);
178 kref_get(&vlan->refcount);
179 hlist_add_head_rcu(&vlan->list, &orig_node->vlan_list);
182 spin_unlock_bh(&orig_node->vlan_list_lock);
188 * batadv_orig_node_vlan_release() - release originator-vlan object from lists
189 * and queue for free after rcu grace period
190 * @ref: kref pointer of the originator-vlan object
192 static void batadv_orig_node_vlan_release(struct kref *ref)
194 struct batadv_orig_node_vlan *orig_vlan;
196 orig_vlan = container_of(ref, struct batadv_orig_node_vlan, refcount);
198 kfree_rcu(orig_vlan, rcu);
202 * batadv_orig_node_vlan_put() - decrement the refcounter and possibly release
203 * the originator-vlan object
204 * @orig_vlan: the originator-vlan object to release
206 void batadv_orig_node_vlan_put(struct batadv_orig_node_vlan *orig_vlan)
208 kref_put(&orig_vlan->refcount, batadv_orig_node_vlan_release);
212 * batadv_originator_init() - Initialize all originator structures
213 * @bat_priv: the bat priv with all the soft interface information
215 * Return: 0 on success or negative error number in case of failure
217 int batadv_originator_init(struct batadv_priv *bat_priv)
219 if (bat_priv->orig_hash)
222 bat_priv->orig_hash = batadv_hash_new(1024);
224 if (!bat_priv->orig_hash)
227 batadv_hash_set_lock_class(bat_priv->orig_hash,
228 &batadv_orig_hash_lock_class_key);
230 INIT_DELAYED_WORK(&bat_priv->orig_work, batadv_purge_orig);
231 queue_delayed_work(batadv_event_workqueue,
232 &bat_priv->orig_work,
233 msecs_to_jiffies(BATADV_ORIG_WORK_PERIOD));
242 * batadv_neigh_ifinfo_release() - release neigh_ifinfo from lists and queue for
243 * free after rcu grace period
244 * @ref: kref pointer of the neigh_ifinfo
246 static void batadv_neigh_ifinfo_release(struct kref *ref)
248 struct batadv_neigh_ifinfo *neigh_ifinfo;
250 neigh_ifinfo = container_of(ref, struct batadv_neigh_ifinfo, refcount);
252 if (neigh_ifinfo->if_outgoing != BATADV_IF_DEFAULT)
253 batadv_hardif_put(neigh_ifinfo->if_outgoing);
255 kfree_rcu(neigh_ifinfo, rcu);
259 * batadv_neigh_ifinfo_put() - decrement the refcounter and possibly release
261 * @neigh_ifinfo: the neigh_ifinfo object to release
263 void batadv_neigh_ifinfo_put(struct batadv_neigh_ifinfo *neigh_ifinfo)
265 kref_put(&neigh_ifinfo->refcount, batadv_neigh_ifinfo_release);
269 * batadv_hardif_neigh_release() - release hardif neigh node from lists and
270 * queue for free after rcu grace period
271 * @ref: kref pointer of the neigh_node
273 static void batadv_hardif_neigh_release(struct kref *ref)
275 struct batadv_hardif_neigh_node *hardif_neigh;
277 hardif_neigh = container_of(ref, struct batadv_hardif_neigh_node,
280 spin_lock_bh(&hardif_neigh->if_incoming->neigh_list_lock);
281 hlist_del_init_rcu(&hardif_neigh->list);
282 spin_unlock_bh(&hardif_neigh->if_incoming->neigh_list_lock);
284 batadv_hardif_put(hardif_neigh->if_incoming);
285 kfree_rcu(hardif_neigh, rcu);
289 * batadv_hardif_neigh_put() - decrement the hardif neighbors refcounter
290 * and possibly release it
291 * @hardif_neigh: hardif neigh neighbor to free
293 void batadv_hardif_neigh_put(struct batadv_hardif_neigh_node *hardif_neigh)
295 kref_put(&hardif_neigh->refcount, batadv_hardif_neigh_release);
299 * batadv_neigh_node_release() - release neigh_node from lists and queue for
300 * free after rcu grace period
301 * @ref: kref pointer of the neigh_node
303 static void batadv_neigh_node_release(struct kref *ref)
305 struct hlist_node *node_tmp;
306 struct batadv_neigh_node *neigh_node;
307 struct batadv_neigh_ifinfo *neigh_ifinfo;
309 neigh_node = container_of(ref, struct batadv_neigh_node, refcount);
311 hlist_for_each_entry_safe(neigh_ifinfo, node_tmp,
312 &neigh_node->ifinfo_list, list) {
313 batadv_neigh_ifinfo_put(neigh_ifinfo);
316 batadv_hardif_neigh_put(neigh_node->hardif_neigh);
318 batadv_hardif_put(neigh_node->if_incoming);
320 kfree_rcu(neigh_node, rcu);
324 * batadv_neigh_node_put() - decrement the neighbors refcounter and possibly
326 * @neigh_node: neigh neighbor to free
328 void batadv_neigh_node_put(struct batadv_neigh_node *neigh_node)
330 kref_put(&neigh_node->refcount, batadv_neigh_node_release);
334 * batadv_orig_router_get() - router to the originator depending on iface
335 * @orig_node: the orig node for the router
336 * @if_outgoing: the interface where the payload packet has been received or
337 * the OGM should be sent to
339 * Return: the neighbor which should be router for this orig_node/iface.
341 * The object is returned with refcounter increased by 1.
343 struct batadv_neigh_node *
344 batadv_orig_router_get(struct batadv_orig_node *orig_node,
345 const struct batadv_hard_iface *if_outgoing)
347 struct batadv_orig_ifinfo *orig_ifinfo;
348 struct batadv_neigh_node *router = NULL;
351 hlist_for_each_entry_rcu(orig_ifinfo, &orig_node->ifinfo_list, list) {
352 if (orig_ifinfo->if_outgoing != if_outgoing)
355 router = rcu_dereference(orig_ifinfo->router);
359 if (router && !kref_get_unless_zero(&router->refcount))
367 * batadv_orig_ifinfo_get() - find the ifinfo from an orig_node
368 * @orig_node: the orig node to be queried
369 * @if_outgoing: the interface for which the ifinfo should be acquired
371 * Return: the requested orig_ifinfo or NULL if not found.
373 * The object is returned with refcounter increased by 1.
375 struct batadv_orig_ifinfo *
376 batadv_orig_ifinfo_get(struct batadv_orig_node *orig_node,
377 struct batadv_hard_iface *if_outgoing)
379 struct batadv_orig_ifinfo *tmp, *orig_ifinfo = NULL;
382 hlist_for_each_entry_rcu(tmp, &orig_node->ifinfo_list,
384 if (tmp->if_outgoing != if_outgoing)
387 if (!kref_get_unless_zero(&tmp->refcount))
399 * batadv_orig_ifinfo_new() - search and possibly create an orig_ifinfo object
400 * @orig_node: the orig node to be queried
401 * @if_outgoing: the interface for which the ifinfo should be acquired
403 * Return: NULL in case of failure or the orig_ifinfo object for the if_outgoing
404 * interface otherwise. The object is created and added to the list
405 * if it does not exist.
407 * The object is returned with refcounter increased by 1.
409 struct batadv_orig_ifinfo *
410 batadv_orig_ifinfo_new(struct batadv_orig_node *orig_node,
411 struct batadv_hard_iface *if_outgoing)
413 struct batadv_orig_ifinfo *orig_ifinfo;
414 unsigned long reset_time;
416 spin_lock_bh(&orig_node->neigh_list_lock);
418 orig_ifinfo = batadv_orig_ifinfo_get(orig_node, if_outgoing);
422 orig_ifinfo = kzalloc(sizeof(*orig_ifinfo), GFP_ATOMIC);
426 if (if_outgoing != BATADV_IF_DEFAULT)
427 kref_get(&if_outgoing->refcount);
429 reset_time = jiffies - 1;
430 reset_time -= msecs_to_jiffies(BATADV_RESET_PROTECTION_MS);
431 orig_ifinfo->batman_seqno_reset = reset_time;
432 orig_ifinfo->if_outgoing = if_outgoing;
433 INIT_HLIST_NODE(&orig_ifinfo->list);
434 kref_init(&orig_ifinfo->refcount);
436 kref_get(&orig_ifinfo->refcount);
437 hlist_add_head_rcu(&orig_ifinfo->list,
438 &orig_node->ifinfo_list);
440 spin_unlock_bh(&orig_node->neigh_list_lock);
445 * batadv_neigh_ifinfo_get() - find the ifinfo from an neigh_node
446 * @neigh: the neigh node to be queried
447 * @if_outgoing: the interface for which the ifinfo should be acquired
449 * The object is returned with refcounter increased by 1.
451 * Return: the requested neigh_ifinfo or NULL if not found
453 struct batadv_neigh_ifinfo *
454 batadv_neigh_ifinfo_get(struct batadv_neigh_node *neigh,
455 struct batadv_hard_iface *if_outgoing)
457 struct batadv_neigh_ifinfo *neigh_ifinfo = NULL,
461 hlist_for_each_entry_rcu(tmp_neigh_ifinfo, &neigh->ifinfo_list,
463 if (tmp_neigh_ifinfo->if_outgoing != if_outgoing)
466 if (!kref_get_unless_zero(&tmp_neigh_ifinfo->refcount))
469 neigh_ifinfo = tmp_neigh_ifinfo;
478 * batadv_neigh_ifinfo_new() - search and possibly create an neigh_ifinfo object
479 * @neigh: the neigh node to be queried
480 * @if_outgoing: the interface for which the ifinfo should be acquired
482 * Return: NULL in case of failure or the neigh_ifinfo object for the
483 * if_outgoing interface otherwise. The object is created and added to the list
484 * if it does not exist.
486 * The object is returned with refcounter increased by 1.
488 struct batadv_neigh_ifinfo *
489 batadv_neigh_ifinfo_new(struct batadv_neigh_node *neigh,
490 struct batadv_hard_iface *if_outgoing)
492 struct batadv_neigh_ifinfo *neigh_ifinfo;
494 spin_lock_bh(&neigh->ifinfo_lock);
496 neigh_ifinfo = batadv_neigh_ifinfo_get(neigh, if_outgoing);
500 neigh_ifinfo = kzalloc(sizeof(*neigh_ifinfo), GFP_ATOMIC);
505 kref_get(&if_outgoing->refcount);
507 INIT_HLIST_NODE(&neigh_ifinfo->list);
508 kref_init(&neigh_ifinfo->refcount);
509 neigh_ifinfo->if_outgoing = if_outgoing;
511 kref_get(&neigh_ifinfo->refcount);
512 hlist_add_head_rcu(&neigh_ifinfo->list, &neigh->ifinfo_list);
515 spin_unlock_bh(&neigh->ifinfo_lock);
521 * batadv_neigh_node_get() - retrieve a neighbour from the list
522 * @orig_node: originator which the neighbour belongs to
523 * @hard_iface: the interface where this neighbour is connected to
524 * @addr: the address of the neighbour
526 * Looks for and possibly returns a neighbour belonging to this originator list
527 * which is connected through the provided hard interface.
529 * Return: neighbor when found. Othwerwise NULL
531 static struct batadv_neigh_node *
532 batadv_neigh_node_get(const struct batadv_orig_node *orig_node,
533 const struct batadv_hard_iface *hard_iface,
536 struct batadv_neigh_node *tmp_neigh_node, *res = NULL;
539 hlist_for_each_entry_rcu(tmp_neigh_node, &orig_node->neigh_list, list) {
540 if (!batadv_compare_eth(tmp_neigh_node->addr, addr))
543 if (tmp_neigh_node->if_incoming != hard_iface)
546 if (!kref_get_unless_zero(&tmp_neigh_node->refcount))
549 res = tmp_neigh_node;
558 * batadv_hardif_neigh_create() - create a hardif neighbour node
559 * @hard_iface: the interface this neighbour is connected to
560 * @neigh_addr: the interface address of the neighbour to retrieve
561 * @orig_node: originator object representing the neighbour
563 * Return: the hardif neighbour node if found or created or NULL otherwise.
565 static struct batadv_hardif_neigh_node *
566 batadv_hardif_neigh_create(struct batadv_hard_iface *hard_iface,
567 const u8 *neigh_addr,
568 struct batadv_orig_node *orig_node)
570 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
571 struct batadv_hardif_neigh_node *hardif_neigh;
573 spin_lock_bh(&hard_iface->neigh_list_lock);
575 /* check if neighbor hasn't been added in the meantime */
576 hardif_neigh = batadv_hardif_neigh_get(hard_iface, neigh_addr);
580 hardif_neigh = kzalloc(sizeof(*hardif_neigh), GFP_ATOMIC);
584 kref_get(&hard_iface->refcount);
585 INIT_HLIST_NODE(&hardif_neigh->list);
586 ether_addr_copy(hardif_neigh->addr, neigh_addr);
587 ether_addr_copy(hardif_neigh->orig, orig_node->orig);
588 hardif_neigh->if_incoming = hard_iface;
589 hardif_neigh->last_seen = jiffies;
591 kref_init(&hardif_neigh->refcount);
593 if (bat_priv->algo_ops->neigh.hardif_init)
594 bat_priv->algo_ops->neigh.hardif_init(hardif_neigh);
596 hlist_add_head_rcu(&hardif_neigh->list, &hard_iface->neigh_list);
599 spin_unlock_bh(&hard_iface->neigh_list_lock);
604 * batadv_hardif_neigh_get_or_create() - retrieve or create a hardif neighbour
606 * @hard_iface: the interface this neighbour is connected to
607 * @neigh_addr: the interface address of the neighbour to retrieve
608 * @orig_node: originator object representing the neighbour
610 * Return: the hardif neighbour node if found or created or NULL otherwise.
612 static struct batadv_hardif_neigh_node *
613 batadv_hardif_neigh_get_or_create(struct batadv_hard_iface *hard_iface,
614 const u8 *neigh_addr,
615 struct batadv_orig_node *orig_node)
617 struct batadv_hardif_neigh_node *hardif_neigh;
619 /* first check without locking to avoid the overhead */
620 hardif_neigh = batadv_hardif_neigh_get(hard_iface, neigh_addr);
624 return batadv_hardif_neigh_create(hard_iface, neigh_addr, orig_node);
628 * batadv_hardif_neigh_get() - retrieve a hardif neighbour from the list
629 * @hard_iface: the interface where this neighbour is connected to
630 * @neigh_addr: the address of the neighbour
632 * Looks for and possibly returns a neighbour belonging to this hard interface.
634 * Return: neighbor when found. Othwerwise NULL
636 struct batadv_hardif_neigh_node *
637 batadv_hardif_neigh_get(const struct batadv_hard_iface *hard_iface,
638 const u8 *neigh_addr)
640 struct batadv_hardif_neigh_node *tmp_hardif_neigh, *hardif_neigh = NULL;
643 hlist_for_each_entry_rcu(tmp_hardif_neigh,
644 &hard_iface->neigh_list, list) {
645 if (!batadv_compare_eth(tmp_hardif_neigh->addr, neigh_addr))
648 if (!kref_get_unless_zero(&tmp_hardif_neigh->refcount))
651 hardif_neigh = tmp_hardif_neigh;
660 * batadv_neigh_node_create() - create a neigh node object
661 * @orig_node: originator object representing the neighbour
662 * @hard_iface: the interface where the neighbour is connected to
663 * @neigh_addr: the mac address of the neighbour interface
665 * Allocates a new neigh_node object and initialises all the generic fields.
667 * Return: the neighbour node if found or created or NULL otherwise.
669 static struct batadv_neigh_node *
670 batadv_neigh_node_create(struct batadv_orig_node *orig_node,
671 struct batadv_hard_iface *hard_iface,
672 const u8 *neigh_addr)
674 struct batadv_neigh_node *neigh_node;
675 struct batadv_hardif_neigh_node *hardif_neigh = NULL;
677 spin_lock_bh(&orig_node->neigh_list_lock);
679 neigh_node = batadv_neigh_node_get(orig_node, hard_iface, neigh_addr);
683 hardif_neigh = batadv_hardif_neigh_get_or_create(hard_iface,
684 neigh_addr, orig_node);
688 neigh_node = kzalloc(sizeof(*neigh_node), GFP_ATOMIC);
692 INIT_HLIST_NODE(&neigh_node->list);
693 INIT_HLIST_HEAD(&neigh_node->ifinfo_list);
694 spin_lock_init(&neigh_node->ifinfo_lock);
696 kref_get(&hard_iface->refcount);
697 ether_addr_copy(neigh_node->addr, neigh_addr);
698 neigh_node->if_incoming = hard_iface;
699 neigh_node->orig_node = orig_node;
700 neigh_node->last_seen = jiffies;
702 /* increment unique neighbor refcount */
703 kref_get(&hardif_neigh->refcount);
704 neigh_node->hardif_neigh = hardif_neigh;
706 /* extra reference for return */
707 kref_init(&neigh_node->refcount);
709 kref_get(&neigh_node->refcount);
710 hlist_add_head_rcu(&neigh_node->list, &orig_node->neigh_list);
712 batadv_dbg(BATADV_DBG_BATMAN, orig_node->bat_priv,
713 "Creating new neighbor %pM for orig_node %pM on interface %s\n",
714 neigh_addr, orig_node->orig, hard_iface->net_dev->name);
717 spin_unlock_bh(&orig_node->neigh_list_lock);
720 batadv_hardif_neigh_put(hardif_neigh);
725 * batadv_neigh_node_get_or_create() - retrieve or create a neigh node object
726 * @orig_node: originator object representing the neighbour
727 * @hard_iface: the interface where the neighbour is connected to
728 * @neigh_addr: the mac address of the neighbour interface
730 * Return: the neighbour node if found or created or NULL otherwise.
732 struct batadv_neigh_node *
733 batadv_neigh_node_get_or_create(struct batadv_orig_node *orig_node,
734 struct batadv_hard_iface *hard_iface,
735 const u8 *neigh_addr)
737 struct batadv_neigh_node *neigh_node;
739 /* first check without locking to avoid the overhead */
740 neigh_node = batadv_neigh_node_get(orig_node, hard_iface, neigh_addr);
744 return batadv_neigh_node_create(orig_node, hard_iface, neigh_addr);
747 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
749 * batadv_hardif_neigh_seq_print_text() - print the single hop neighbour list
750 * @seq: neighbour table seq_file struct
755 int batadv_hardif_neigh_seq_print_text(struct seq_file *seq, void *offset)
757 struct net_device *net_dev = (struct net_device *)seq->private;
758 struct batadv_priv *bat_priv = netdev_priv(net_dev);
759 struct batadv_hard_iface *primary_if;
761 primary_if = batadv_seq_print_text_primary_if_get(seq);
765 seq_printf(seq, "[B.A.T.M.A.N. adv %s, MainIF/MAC: %s/%pM (%s %s)]\n",
766 BATADV_SOURCE_VERSION, primary_if->net_dev->name,
767 primary_if->net_dev->dev_addr, net_dev->name,
768 bat_priv->algo_ops->name);
770 batadv_hardif_put(primary_if);
772 if (!bat_priv->algo_ops->neigh.print) {
774 "No printing function for this routing protocol\n");
778 bat_priv->algo_ops->neigh.print(bat_priv, seq);
784 * batadv_hardif_neigh_dump() - Dump to netlink the neighbor infos for a
785 * specific outgoing interface
786 * @msg: message to dump into
787 * @cb: parameters for the dump
789 * Return: 0 or error value
791 int batadv_hardif_neigh_dump(struct sk_buff *msg, struct netlink_callback *cb)
793 struct net *net = sock_net(cb->skb->sk);
794 struct net_device *soft_iface;
795 struct net_device *hard_iface = NULL;
796 struct batadv_hard_iface *hardif = BATADV_IF_DEFAULT;
797 struct batadv_priv *bat_priv;
798 struct batadv_hard_iface *primary_if = NULL;
800 int ifindex, hard_ifindex;
802 ifindex = batadv_netlink_get_ifindex(cb->nlh, BATADV_ATTR_MESH_IFINDEX);
806 soft_iface = dev_get_by_index(net, ifindex);
807 if (!soft_iface || !batadv_softif_is_valid(soft_iface)) {
812 bat_priv = netdev_priv(soft_iface);
814 primary_if = batadv_primary_if_get_selected(bat_priv);
815 if (!primary_if || primary_if->if_status != BATADV_IF_ACTIVE) {
820 hard_ifindex = batadv_netlink_get_ifindex(cb->nlh,
821 BATADV_ATTR_HARD_IFINDEX);
823 hard_iface = dev_get_by_index(net, hard_ifindex);
825 hardif = batadv_hardif_get_by_netdev(hard_iface);
832 if (hardif->soft_iface != soft_iface) {
838 if (!bat_priv->algo_ops->neigh.dump) {
843 bat_priv->algo_ops->neigh.dump(msg, cb, bat_priv, hardif);
849 batadv_hardif_put(hardif);
853 batadv_hardif_put(primary_if);
861 * batadv_orig_ifinfo_release() - release orig_ifinfo from lists and queue for
862 * free after rcu grace period
863 * @ref: kref pointer of the orig_ifinfo
865 static void batadv_orig_ifinfo_release(struct kref *ref)
867 struct batadv_orig_ifinfo *orig_ifinfo;
868 struct batadv_neigh_node *router;
870 orig_ifinfo = container_of(ref, struct batadv_orig_ifinfo, refcount);
872 if (orig_ifinfo->if_outgoing != BATADV_IF_DEFAULT)
873 batadv_hardif_put(orig_ifinfo->if_outgoing);
875 /* this is the last reference to this object */
876 router = rcu_dereference_protected(orig_ifinfo->router, true);
878 batadv_neigh_node_put(router);
880 kfree_rcu(orig_ifinfo, rcu);
884 * batadv_orig_ifinfo_put() - decrement the refcounter and possibly release
886 * @orig_ifinfo: the orig_ifinfo object to release
888 void batadv_orig_ifinfo_put(struct batadv_orig_ifinfo *orig_ifinfo)
890 kref_put(&orig_ifinfo->refcount, batadv_orig_ifinfo_release);
894 * batadv_orig_node_free_rcu() - free the orig_node
895 * @rcu: rcu pointer of the orig_node
897 static void batadv_orig_node_free_rcu(struct rcu_head *rcu)
899 struct batadv_orig_node *orig_node;
901 orig_node = container_of(rcu, struct batadv_orig_node, rcu);
903 batadv_mcast_purge_orig(orig_node);
905 batadv_frag_purge_orig(orig_node, NULL);
907 kfree(orig_node->tt_buff);
912 * batadv_orig_node_release() - release orig_node from lists and queue for
913 * free after rcu grace period
914 * @ref: kref pointer of the orig_node
916 static void batadv_orig_node_release(struct kref *ref)
918 struct hlist_node *node_tmp;
919 struct batadv_neigh_node *neigh_node;
920 struct batadv_orig_node *orig_node;
921 struct batadv_orig_ifinfo *orig_ifinfo;
922 struct batadv_orig_node_vlan *vlan;
923 struct batadv_orig_ifinfo *last_candidate;
925 orig_node = container_of(ref, struct batadv_orig_node, refcount);
927 spin_lock_bh(&orig_node->neigh_list_lock);
929 /* for all neighbors towards this originator ... */
930 hlist_for_each_entry_safe(neigh_node, node_tmp,
931 &orig_node->neigh_list, list) {
932 hlist_del_rcu(&neigh_node->list);
933 batadv_neigh_node_put(neigh_node);
936 hlist_for_each_entry_safe(orig_ifinfo, node_tmp,
937 &orig_node->ifinfo_list, list) {
938 hlist_del_rcu(&orig_ifinfo->list);
939 batadv_orig_ifinfo_put(orig_ifinfo);
942 last_candidate = orig_node->last_bonding_candidate;
943 orig_node->last_bonding_candidate = NULL;
944 spin_unlock_bh(&orig_node->neigh_list_lock);
947 batadv_orig_ifinfo_put(last_candidate);
949 spin_lock_bh(&orig_node->vlan_list_lock);
950 hlist_for_each_entry_safe(vlan, node_tmp, &orig_node->vlan_list, list) {
951 hlist_del_rcu(&vlan->list);
952 batadv_orig_node_vlan_put(vlan);
954 spin_unlock_bh(&orig_node->vlan_list_lock);
957 batadv_nc_purge_orig(orig_node->bat_priv, orig_node, NULL);
959 call_rcu(&orig_node->rcu, batadv_orig_node_free_rcu);
963 * batadv_orig_node_put() - decrement the orig node refcounter and possibly
965 * @orig_node: the orig node to free
967 void batadv_orig_node_put(struct batadv_orig_node *orig_node)
969 kref_put(&orig_node->refcount, batadv_orig_node_release);
973 * batadv_originator_free() - Free all originator structures
974 * @bat_priv: the bat priv with all the soft interface information
976 void batadv_originator_free(struct batadv_priv *bat_priv)
978 struct batadv_hashtable *hash = bat_priv->orig_hash;
979 struct hlist_node *node_tmp;
980 struct hlist_head *head;
981 spinlock_t *list_lock; /* spinlock to protect write access */
982 struct batadv_orig_node *orig_node;
988 cancel_delayed_work_sync(&bat_priv->orig_work);
990 bat_priv->orig_hash = NULL;
992 for (i = 0; i < hash->size; i++) {
993 head = &hash->table[i];
994 list_lock = &hash->list_locks[i];
996 spin_lock_bh(list_lock);
997 hlist_for_each_entry_safe(orig_node, node_tmp,
999 hlist_del_rcu(&orig_node->hash_entry);
1000 batadv_orig_node_put(orig_node);
1002 spin_unlock_bh(list_lock);
1005 batadv_hash_destroy(hash);
1009 * batadv_orig_node_new() - creates a new orig_node
1010 * @bat_priv: the bat priv with all the soft interface information
1011 * @addr: the mac address of the originator
1013 * Creates a new originator object and initialise all the generic fields.
1014 * The new object is not added to the originator list.
1016 * Return: the newly created object or NULL on failure.
1018 struct batadv_orig_node *batadv_orig_node_new(struct batadv_priv *bat_priv,
1021 struct batadv_orig_node *orig_node;
1022 struct batadv_orig_node_vlan *vlan;
1023 unsigned long reset_time;
1026 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1027 "Creating new originator: %pM\n", addr);
1029 orig_node = kzalloc(sizeof(*orig_node), GFP_ATOMIC);
1033 INIT_HLIST_HEAD(&orig_node->neigh_list);
1034 INIT_HLIST_HEAD(&orig_node->vlan_list);
1035 INIT_HLIST_HEAD(&orig_node->ifinfo_list);
1036 spin_lock_init(&orig_node->bcast_seqno_lock);
1037 spin_lock_init(&orig_node->neigh_list_lock);
1038 spin_lock_init(&orig_node->tt_buff_lock);
1039 spin_lock_init(&orig_node->tt_lock);
1040 spin_lock_init(&orig_node->vlan_list_lock);
1042 batadv_nc_init_orig(orig_node);
1044 /* extra reference for return */
1045 kref_init(&orig_node->refcount);
1047 orig_node->bat_priv = bat_priv;
1048 ether_addr_copy(orig_node->orig, addr);
1049 batadv_dat_init_orig_node_addr(orig_node);
1050 atomic_set(&orig_node->last_ttvn, 0);
1051 orig_node->tt_buff = NULL;
1052 orig_node->tt_buff_len = 0;
1053 orig_node->last_seen = jiffies;
1054 reset_time = jiffies - 1 - msecs_to_jiffies(BATADV_RESET_PROTECTION_MS);
1055 orig_node->bcast_seqno_reset = reset_time;
1057 #ifdef CONFIG_BATMAN_ADV_MCAST
1058 orig_node->mcast_flags = BATADV_NO_FLAGS;
1059 INIT_HLIST_NODE(&orig_node->mcast_want_all_unsnoopables_node);
1060 INIT_HLIST_NODE(&orig_node->mcast_want_all_ipv4_node);
1061 INIT_HLIST_NODE(&orig_node->mcast_want_all_ipv6_node);
1062 spin_lock_init(&orig_node->mcast_handler_lock);
1065 /* create a vlan object for the "untagged" LAN */
1066 vlan = batadv_orig_node_vlan_new(orig_node, BATADV_NO_FLAGS);
1068 goto free_orig_node;
1069 /* batadv_orig_node_vlan_new() increases the refcounter.
1070 * Immediately release vlan since it is not needed anymore in this
1073 batadv_orig_node_vlan_put(vlan);
1075 for (i = 0; i < BATADV_FRAG_BUFFER_COUNT; i++) {
1076 INIT_HLIST_HEAD(&orig_node->fragments[i].fragment_list);
1077 spin_lock_init(&orig_node->fragments[i].lock);
1078 orig_node->fragments[i].size = 0;
1088 * batadv_purge_neigh_ifinfo() - purge obsolete ifinfo entries from neighbor
1089 * @bat_priv: the bat priv with all the soft interface information
1090 * @neigh: orig node which is to be checked
1093 batadv_purge_neigh_ifinfo(struct batadv_priv *bat_priv,
1094 struct batadv_neigh_node *neigh)
1096 struct batadv_neigh_ifinfo *neigh_ifinfo;
1097 struct batadv_hard_iface *if_outgoing;
1098 struct hlist_node *node_tmp;
1100 spin_lock_bh(&neigh->ifinfo_lock);
1102 /* for all ifinfo objects for this neighinator */
1103 hlist_for_each_entry_safe(neigh_ifinfo, node_tmp,
1104 &neigh->ifinfo_list, list) {
1105 if_outgoing = neigh_ifinfo->if_outgoing;
1107 /* always keep the default interface */
1108 if (if_outgoing == BATADV_IF_DEFAULT)
1111 /* don't purge if the interface is not (going) down */
1112 if (if_outgoing->if_status != BATADV_IF_INACTIVE &&
1113 if_outgoing->if_status != BATADV_IF_NOT_IN_USE &&
1114 if_outgoing->if_status != BATADV_IF_TO_BE_REMOVED)
1117 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1118 "neighbor/ifinfo purge: neighbor %pM, iface: %s\n",
1119 neigh->addr, if_outgoing->net_dev->name);
1121 hlist_del_rcu(&neigh_ifinfo->list);
1122 batadv_neigh_ifinfo_put(neigh_ifinfo);
1125 spin_unlock_bh(&neigh->ifinfo_lock);
1129 * batadv_purge_orig_ifinfo() - purge obsolete ifinfo entries from originator
1130 * @bat_priv: the bat priv with all the soft interface information
1131 * @orig_node: orig node which is to be checked
1133 * Return: true if any ifinfo entry was purged, false otherwise.
1136 batadv_purge_orig_ifinfo(struct batadv_priv *bat_priv,
1137 struct batadv_orig_node *orig_node)
1139 struct batadv_orig_ifinfo *orig_ifinfo;
1140 struct batadv_hard_iface *if_outgoing;
1141 struct hlist_node *node_tmp;
1142 bool ifinfo_purged = false;
1144 spin_lock_bh(&orig_node->neigh_list_lock);
1146 /* for all ifinfo objects for this originator */
1147 hlist_for_each_entry_safe(orig_ifinfo, node_tmp,
1148 &orig_node->ifinfo_list, list) {
1149 if_outgoing = orig_ifinfo->if_outgoing;
1151 /* always keep the default interface */
1152 if (if_outgoing == BATADV_IF_DEFAULT)
1155 /* don't purge if the interface is not (going) down */
1156 if (if_outgoing->if_status != BATADV_IF_INACTIVE &&
1157 if_outgoing->if_status != BATADV_IF_NOT_IN_USE &&
1158 if_outgoing->if_status != BATADV_IF_TO_BE_REMOVED)
1161 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1162 "router/ifinfo purge: originator %pM, iface: %s\n",
1163 orig_node->orig, if_outgoing->net_dev->name);
1165 ifinfo_purged = true;
1167 hlist_del_rcu(&orig_ifinfo->list);
1168 batadv_orig_ifinfo_put(orig_ifinfo);
1169 if (orig_node->last_bonding_candidate == orig_ifinfo) {
1170 orig_node->last_bonding_candidate = NULL;
1171 batadv_orig_ifinfo_put(orig_ifinfo);
1175 spin_unlock_bh(&orig_node->neigh_list_lock);
1177 return ifinfo_purged;
1181 * batadv_purge_orig_neighbors() - purges neighbors from originator
1182 * @bat_priv: the bat priv with all the soft interface information
1183 * @orig_node: orig node which is to be checked
1185 * Return: true if any neighbor was purged, false otherwise
1188 batadv_purge_orig_neighbors(struct batadv_priv *bat_priv,
1189 struct batadv_orig_node *orig_node)
1191 struct hlist_node *node_tmp;
1192 struct batadv_neigh_node *neigh_node;
1193 bool neigh_purged = false;
1194 unsigned long last_seen;
1195 struct batadv_hard_iface *if_incoming;
1197 spin_lock_bh(&orig_node->neigh_list_lock);
1199 /* for all neighbors towards this originator ... */
1200 hlist_for_each_entry_safe(neigh_node, node_tmp,
1201 &orig_node->neigh_list, list) {
1202 last_seen = neigh_node->last_seen;
1203 if_incoming = neigh_node->if_incoming;
1205 if (batadv_has_timed_out(last_seen, BATADV_PURGE_TIMEOUT) ||
1206 if_incoming->if_status == BATADV_IF_INACTIVE ||
1207 if_incoming->if_status == BATADV_IF_NOT_IN_USE ||
1208 if_incoming->if_status == BATADV_IF_TO_BE_REMOVED) {
1209 if (if_incoming->if_status == BATADV_IF_INACTIVE ||
1210 if_incoming->if_status == BATADV_IF_NOT_IN_USE ||
1211 if_incoming->if_status == BATADV_IF_TO_BE_REMOVED)
1212 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1213 "neighbor purge: originator %pM, neighbor: %pM, iface: %s\n",
1214 orig_node->orig, neigh_node->addr,
1215 if_incoming->net_dev->name);
1217 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1218 "neighbor timeout: originator %pM, neighbor: %pM, last_seen: %u\n",
1219 orig_node->orig, neigh_node->addr,
1220 jiffies_to_msecs(last_seen));
1222 neigh_purged = true;
1224 hlist_del_rcu(&neigh_node->list);
1225 batadv_neigh_node_put(neigh_node);
1227 /* only necessary if not the whole neighbor is to be
1228 * deleted, but some interface has been removed.
1230 batadv_purge_neigh_ifinfo(bat_priv, neigh_node);
1234 spin_unlock_bh(&orig_node->neigh_list_lock);
1235 return neigh_purged;
1239 * batadv_find_best_neighbor() - finds the best neighbor after purging
1240 * @bat_priv: the bat priv with all the soft interface information
1241 * @orig_node: orig node which is to be checked
1242 * @if_outgoing: the interface for which the metric should be compared
1244 * Return: the current best neighbor, with refcount increased.
1246 static struct batadv_neigh_node *
1247 batadv_find_best_neighbor(struct batadv_priv *bat_priv,
1248 struct batadv_orig_node *orig_node,
1249 struct batadv_hard_iface *if_outgoing)
1251 struct batadv_neigh_node *best = NULL, *neigh;
1252 struct batadv_algo_ops *bao = bat_priv->algo_ops;
1255 hlist_for_each_entry_rcu(neigh, &orig_node->neigh_list, list) {
1256 if (best && (bao->neigh.cmp(neigh, if_outgoing, best,
1260 if (!kref_get_unless_zero(&neigh->refcount))
1264 batadv_neigh_node_put(best);
1274 * batadv_purge_orig_node() - purges obsolete information from an orig_node
1275 * @bat_priv: the bat priv with all the soft interface information
1276 * @orig_node: orig node which is to be checked
1278 * This function checks if the orig_node or substructures of it have become
1279 * obsolete, and purges this information if that's the case.
1281 * Return: true if the orig_node is to be removed, false otherwise.
1283 static bool batadv_purge_orig_node(struct batadv_priv *bat_priv,
1284 struct batadv_orig_node *orig_node)
1286 struct batadv_neigh_node *best_neigh_node;
1287 struct batadv_hard_iface *hard_iface;
1288 bool changed_ifinfo, changed_neigh;
1290 if (batadv_has_timed_out(orig_node->last_seen,
1291 2 * BATADV_PURGE_TIMEOUT)) {
1292 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
1293 "Originator timeout: originator %pM, last_seen %u\n",
1295 jiffies_to_msecs(orig_node->last_seen));
1298 changed_ifinfo = batadv_purge_orig_ifinfo(bat_priv, orig_node);
1299 changed_neigh = batadv_purge_orig_neighbors(bat_priv, orig_node);
1301 if (!changed_ifinfo && !changed_neigh)
1304 /* first for NULL ... */
1305 best_neigh_node = batadv_find_best_neighbor(bat_priv, orig_node,
1307 batadv_update_route(bat_priv, orig_node, BATADV_IF_DEFAULT,
1309 if (best_neigh_node)
1310 batadv_neigh_node_put(best_neigh_node);
1312 /* ... then for all other interfaces. */
1314 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
1315 if (hard_iface->if_status != BATADV_IF_ACTIVE)
1318 if (hard_iface->soft_iface != bat_priv->soft_iface)
1321 if (!kref_get_unless_zero(&hard_iface->refcount))
1324 best_neigh_node = batadv_find_best_neighbor(bat_priv,
1327 batadv_update_route(bat_priv, orig_node, hard_iface,
1329 if (best_neigh_node)
1330 batadv_neigh_node_put(best_neigh_node);
1332 batadv_hardif_put(hard_iface);
1340 * batadv_purge_orig_ref() - Purge all outdated originators
1341 * @bat_priv: the bat priv with all the soft interface information
1343 void batadv_purge_orig_ref(struct batadv_priv *bat_priv)
1345 struct batadv_hashtable *hash = bat_priv->orig_hash;
1346 struct hlist_node *node_tmp;
1347 struct hlist_head *head;
1348 spinlock_t *list_lock; /* spinlock to protect write access */
1349 struct batadv_orig_node *orig_node;
1355 /* for all origins... */
1356 for (i = 0; i < hash->size; i++) {
1357 head = &hash->table[i];
1358 list_lock = &hash->list_locks[i];
1360 spin_lock_bh(list_lock);
1361 hlist_for_each_entry_safe(orig_node, node_tmp,
1363 if (batadv_purge_orig_node(bat_priv, orig_node)) {
1364 batadv_gw_node_delete(bat_priv, orig_node);
1365 hlist_del_rcu(&orig_node->hash_entry);
1366 batadv_tt_global_del_orig(orig_node->bat_priv,
1368 "originator timed out");
1369 batadv_orig_node_put(orig_node);
1373 batadv_frag_purge_orig(orig_node,
1374 batadv_frag_check_entry);
1376 spin_unlock_bh(list_lock);
1379 batadv_gw_election(bat_priv);
1382 static void batadv_purge_orig(struct work_struct *work)
1384 struct delayed_work *delayed_work;
1385 struct batadv_priv *bat_priv;
1387 delayed_work = to_delayed_work(work);
1388 bat_priv = container_of(delayed_work, struct batadv_priv, orig_work);
1389 batadv_purge_orig_ref(bat_priv);
1390 queue_delayed_work(batadv_event_workqueue,
1391 &bat_priv->orig_work,
1392 msecs_to_jiffies(BATADV_ORIG_WORK_PERIOD));
1395 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
1398 * batadv_orig_seq_print_text() - Print the originator table in a seq file
1399 * @seq: seq file to print on
1404 int batadv_orig_seq_print_text(struct seq_file *seq, void *offset)
1406 struct net_device *net_dev = (struct net_device *)seq->private;
1407 struct batadv_priv *bat_priv = netdev_priv(net_dev);
1408 struct batadv_hard_iface *primary_if;
1410 primary_if = batadv_seq_print_text_primary_if_get(seq);
1414 seq_printf(seq, "[B.A.T.M.A.N. adv %s, MainIF/MAC: %s/%pM (%s %s)]\n",
1415 BATADV_SOURCE_VERSION, primary_if->net_dev->name,
1416 primary_if->net_dev->dev_addr, net_dev->name,
1417 bat_priv->algo_ops->name);
1419 batadv_hardif_put(primary_if);
1421 if (!bat_priv->algo_ops->orig.print) {
1423 "No printing function for this routing protocol\n");
1427 bat_priv->algo_ops->orig.print(bat_priv, seq, BATADV_IF_DEFAULT);
1433 * batadv_orig_hardif_seq_print_text() - writes originator infos for a specific
1434 * outgoing interface
1435 * @seq: debugfs table seq_file struct
1440 int batadv_orig_hardif_seq_print_text(struct seq_file *seq, void *offset)
1442 struct net_device *net_dev = (struct net_device *)seq->private;
1443 struct batadv_hard_iface *hard_iface;
1444 struct batadv_priv *bat_priv;
1446 hard_iface = batadv_hardif_get_by_netdev(net_dev);
1448 if (!hard_iface || !hard_iface->soft_iface) {
1449 seq_puts(seq, "Interface not known to B.A.T.M.A.N.\n");
1453 bat_priv = netdev_priv(hard_iface->soft_iface);
1454 if (!bat_priv->algo_ops->orig.print) {
1456 "No printing function for this routing protocol\n");
1460 if (hard_iface->if_status != BATADV_IF_ACTIVE) {
1461 seq_puts(seq, "Interface not active\n");
1465 seq_printf(seq, "[B.A.T.M.A.N. adv %s, IF/MAC: %s/%pM (%s %s)]\n",
1466 BATADV_SOURCE_VERSION, hard_iface->net_dev->name,
1467 hard_iface->net_dev->dev_addr,
1468 hard_iface->soft_iface->name, bat_priv->algo_ops->name);
1470 bat_priv->algo_ops->orig.print(bat_priv, seq, hard_iface);
1474 batadv_hardif_put(hard_iface);
1480 * batadv_orig_dump() - Dump to netlink the originator infos for a specific
1481 * outgoing interface
1482 * @msg: message to dump into
1483 * @cb: parameters for the dump
1485 * Return: 0 or error value
1487 int batadv_orig_dump(struct sk_buff *msg, struct netlink_callback *cb)
1489 struct net *net = sock_net(cb->skb->sk);
1490 struct net_device *soft_iface;
1491 struct net_device *hard_iface = NULL;
1492 struct batadv_hard_iface *hardif = BATADV_IF_DEFAULT;
1493 struct batadv_priv *bat_priv;
1494 struct batadv_hard_iface *primary_if = NULL;
1496 int ifindex, hard_ifindex;
1498 ifindex = batadv_netlink_get_ifindex(cb->nlh, BATADV_ATTR_MESH_IFINDEX);
1502 soft_iface = dev_get_by_index(net, ifindex);
1503 if (!soft_iface || !batadv_softif_is_valid(soft_iface)) {
1508 bat_priv = netdev_priv(soft_iface);
1510 primary_if = batadv_primary_if_get_selected(bat_priv);
1511 if (!primary_if || primary_if->if_status != BATADV_IF_ACTIVE) {
1516 hard_ifindex = batadv_netlink_get_ifindex(cb->nlh,
1517 BATADV_ATTR_HARD_IFINDEX);
1519 hard_iface = dev_get_by_index(net, hard_ifindex);
1521 hardif = batadv_hardif_get_by_netdev(hard_iface);
1528 if (hardif->soft_iface != soft_iface) {
1534 if (!bat_priv->algo_ops->orig.dump) {
1539 bat_priv->algo_ops->orig.dump(msg, cb, bat_priv, hardif);
1545 batadv_hardif_put(hardif);
1547 dev_put(hard_iface);
1549 batadv_hardif_put(primary_if);
1551 dev_put(soft_iface);