xref: /linux/net/batman-adv/originator.h (revision 02680c23d7b3febe45ea3d4f9818c2b2dc89020a)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright (C) B.A.T.M.A.N. contributors:
3  *
4  * Marek Lindner, Simon Wunderlich
5  */
6 
7 #ifndef _NET_BATMAN_ADV_ORIGINATOR_H_
8 #define _NET_BATMAN_ADV_ORIGINATOR_H_
9 
10 #include "main.h"
11 
12 #include <linux/compiler.h>
13 #include <linux/if_ether.h>
14 #include <linux/jhash.h>
15 #include <linux/netlink.h>
16 #include <linux/skbuff.h>
17 #include <linux/types.h>
18 
19 bool batadv_compare_orig(const struct hlist_node *node, const void *data2);
20 int batadv_originator_init(struct batadv_priv *bat_priv);
21 void batadv_originator_free(struct batadv_priv *bat_priv);
22 void batadv_purge_orig_ref(struct batadv_priv *bat_priv);
23 void batadv_orig_node_put(struct batadv_orig_node *orig_node);
24 struct batadv_orig_node *batadv_orig_node_new(struct batadv_priv *bat_priv,
25 					      const u8 *addr);
26 struct batadv_hardif_neigh_node *
27 batadv_hardif_neigh_get(const struct batadv_hard_iface *hard_iface,
28 			const u8 *neigh_addr);
29 void
30 batadv_hardif_neigh_put(struct batadv_hardif_neigh_node *hardif_neigh);
31 struct batadv_neigh_node *
32 batadv_neigh_node_get_or_create(struct batadv_orig_node *orig_node,
33 				struct batadv_hard_iface *hard_iface,
34 				const u8 *neigh_addr);
35 void batadv_neigh_node_put(struct batadv_neigh_node *neigh_node);
36 struct batadv_neigh_node *
37 batadv_orig_router_get(struct batadv_orig_node *orig_node,
38 		       const struct batadv_hard_iface *if_outgoing);
39 struct batadv_neigh_ifinfo *
40 batadv_neigh_ifinfo_new(struct batadv_neigh_node *neigh,
41 			struct batadv_hard_iface *if_outgoing);
42 struct batadv_neigh_ifinfo *
43 batadv_neigh_ifinfo_get(struct batadv_neigh_node *neigh,
44 			struct batadv_hard_iface *if_outgoing);
45 void batadv_neigh_ifinfo_put(struct batadv_neigh_ifinfo *neigh_ifinfo);
46 
47 int batadv_hardif_neigh_dump(struct sk_buff *msg, struct netlink_callback *cb);
48 
49 struct batadv_orig_ifinfo *
50 batadv_orig_ifinfo_get(struct batadv_orig_node *orig_node,
51 		       struct batadv_hard_iface *if_outgoing);
52 struct batadv_orig_ifinfo *
53 batadv_orig_ifinfo_new(struct batadv_orig_node *orig_node,
54 		       struct batadv_hard_iface *if_outgoing);
55 void batadv_orig_ifinfo_put(struct batadv_orig_ifinfo *orig_ifinfo);
56 
57 int batadv_orig_dump(struct sk_buff *msg, struct netlink_callback *cb);
58 struct batadv_orig_node_vlan *
59 batadv_orig_node_vlan_new(struct batadv_orig_node *orig_node,
60 			  unsigned short vid);
61 struct batadv_orig_node_vlan *
62 batadv_orig_node_vlan_get(struct batadv_orig_node *orig_node,
63 			  unsigned short vid);
64 void batadv_orig_node_vlan_put(struct batadv_orig_node_vlan *orig_vlan);
65 
66 /**
67  * batadv_choose_orig() - Return the index of the orig entry in the hash table
68  * @data: mac address of the originator node
69  * @size: the size of the hash table
70  *
71  * Return: the hash index where the object represented by @data should be
72  * stored at.
73  */
74 static inline u32 batadv_choose_orig(const void *data, u32 size)
75 {
76 	u32 hash = 0;
77 
78 	hash = jhash(data, ETH_ALEN, hash);
79 	return hash % size;
80 }
81 
82 struct batadv_orig_node *
83 batadv_orig_hash_find(struct batadv_priv *bat_priv, const void *data);
84 
85 #endif /* _NET_BATMAN_ADV_ORIGINATOR_H_ */
86