xref: /openbmc/linux/net/batman-adv/originator.h (revision b8265621)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright (C) 2007-2020  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/seq_file.h>
17 #include <linux/skbuff.h>
18 #include <linux/types.h>
19 
20 bool batadv_compare_orig(const struct hlist_node *node, const void *data2);
21 int batadv_originator_init(struct batadv_priv *bat_priv);
22 void batadv_originator_free(struct batadv_priv *bat_priv);
23 void batadv_purge_orig_ref(struct batadv_priv *bat_priv);
24 void batadv_orig_node_put(struct batadv_orig_node *orig_node);
25 struct batadv_orig_node *batadv_orig_node_new(struct batadv_priv *bat_priv,
26 					      const u8 *addr);
27 struct batadv_hardif_neigh_node *
28 batadv_hardif_neigh_get(const struct batadv_hard_iface *hard_iface,
29 			const u8 *neigh_addr);
30 void
31 batadv_hardif_neigh_put(struct batadv_hardif_neigh_node *hardif_neigh);
32 struct batadv_neigh_node *
33 batadv_neigh_node_get_or_create(struct batadv_orig_node *orig_node,
34 				struct batadv_hard_iface *hard_iface,
35 				const u8 *neigh_addr);
36 void batadv_neigh_node_put(struct batadv_neigh_node *neigh_node);
37 struct batadv_neigh_node *
38 batadv_orig_router_get(struct batadv_orig_node *orig_node,
39 		       const struct batadv_hard_iface *if_outgoing);
40 struct batadv_neigh_ifinfo *
41 batadv_neigh_ifinfo_new(struct batadv_neigh_node *neigh,
42 			struct batadv_hard_iface *if_outgoing);
43 struct batadv_neigh_ifinfo *
44 batadv_neigh_ifinfo_get(struct batadv_neigh_node *neigh,
45 			struct batadv_hard_iface *if_outgoing);
46 void batadv_neigh_ifinfo_put(struct batadv_neigh_ifinfo *neigh_ifinfo);
47 
48 int batadv_hardif_neigh_dump(struct sk_buff *msg, struct netlink_callback *cb);
49 int batadv_hardif_neigh_seq_print_text(struct seq_file *seq, void *offset);
50 
51 struct batadv_orig_ifinfo *
52 batadv_orig_ifinfo_get(struct batadv_orig_node *orig_node,
53 		       struct batadv_hard_iface *if_outgoing);
54 struct batadv_orig_ifinfo *
55 batadv_orig_ifinfo_new(struct batadv_orig_node *orig_node,
56 		       struct batadv_hard_iface *if_outgoing);
57 void batadv_orig_ifinfo_put(struct batadv_orig_ifinfo *orig_ifinfo);
58 
59 int batadv_orig_seq_print_text(struct seq_file *seq, void *offset);
60 int batadv_orig_dump(struct sk_buff *msg, struct netlink_callback *cb);
61 int batadv_orig_hardif_seq_print_text(struct seq_file *seq, void *offset);
62 struct batadv_orig_node_vlan *
63 batadv_orig_node_vlan_new(struct batadv_orig_node *orig_node,
64 			  unsigned short vid);
65 struct batadv_orig_node_vlan *
66 batadv_orig_node_vlan_get(struct batadv_orig_node *orig_node,
67 			  unsigned short vid);
68 void batadv_orig_node_vlan_put(struct batadv_orig_node_vlan *orig_vlan);
69 
70 /**
71  * batadv_choose_orig() - Return the index of the orig entry in the hash table
72  * @data: mac address of the originator node
73  * @size: the size of the hash table
74  *
75  * Return: the hash index where the object represented by @data should be
76  * stored at.
77  */
78 static inline u32 batadv_choose_orig(const void *data, u32 size)
79 {
80 	u32 hash = 0;
81 
82 	hash = jhash(data, ETH_ALEN, hash);
83 	return hash % size;
84 }
85 
86 struct batadv_orig_node *
87 batadv_orig_hash_find(struct batadv_priv *bat_priv, const void *data);
88 
89 #endif /* _NET_BATMAN_ADV_ORIGINATOR_H_ */
90