xref: /openbmc/linux/net/batman-adv/originator.h (revision 4f6cce39)
1 /* Copyright (C) 2007-2017  B.A.T.M.A.N. contributors:
2  *
3  * Marek Lindner, Simon Wunderlich
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of version 2 of the GNU General Public
7  * License as published by the Free Software Foundation.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, see <http://www.gnu.org/licenses/>.
16  */
17 
18 #ifndef _NET_BATMAN_ADV_ORIGINATOR_H_
19 #define _NET_BATMAN_ADV_ORIGINATOR_H_
20 
21 #include "main.h"
22 
23 #include <linux/compiler.h>
24 #include <linux/if_ether.h>
25 #include <linux/jhash.h>
26 #include <linux/kref.h>
27 #include <linux/rculist.h>
28 #include <linux/rcupdate.h>
29 #include <linux/stddef.h>
30 #include <linux/types.h>
31 
32 #include "hash.h"
33 
34 struct netlink_callback;
35 struct seq_file;
36 struct sk_buff;
37 
38 bool batadv_compare_orig(const struct hlist_node *node, const void *data2);
39 int batadv_originator_init(struct batadv_priv *bat_priv);
40 void batadv_originator_free(struct batadv_priv *bat_priv);
41 void batadv_purge_orig_ref(struct batadv_priv *bat_priv);
42 void batadv_orig_node_put(struct batadv_orig_node *orig_node);
43 struct batadv_orig_node *batadv_orig_node_new(struct batadv_priv *bat_priv,
44 					      const u8 *addr);
45 struct batadv_hardif_neigh_node *
46 batadv_hardif_neigh_get(const struct batadv_hard_iface *hard_iface,
47 			const u8 *neigh_addr);
48 void
49 batadv_hardif_neigh_put(struct batadv_hardif_neigh_node *hardif_neigh);
50 struct batadv_neigh_node *
51 batadv_neigh_node_get_or_create(struct batadv_orig_node *orig_node,
52 				struct batadv_hard_iface *hard_iface,
53 				const u8 *neigh_addr);
54 void batadv_neigh_node_put(struct batadv_neigh_node *neigh_node);
55 struct batadv_neigh_node *
56 batadv_orig_router_get(struct batadv_orig_node *orig_node,
57 		       const struct batadv_hard_iface *if_outgoing);
58 struct batadv_neigh_ifinfo *
59 batadv_neigh_ifinfo_new(struct batadv_neigh_node *neigh,
60 			struct batadv_hard_iface *if_outgoing);
61 struct batadv_neigh_ifinfo *
62 batadv_neigh_ifinfo_get(struct batadv_neigh_node *neigh,
63 			struct batadv_hard_iface *if_outgoing);
64 void batadv_neigh_ifinfo_put(struct batadv_neigh_ifinfo *neigh_ifinfo);
65 
66 int batadv_hardif_neigh_dump(struct sk_buff *msg, struct netlink_callback *cb);
67 int batadv_hardif_neigh_seq_print_text(struct seq_file *seq, void *offset);
68 
69 struct batadv_orig_ifinfo *
70 batadv_orig_ifinfo_get(struct batadv_orig_node *orig_node,
71 		       struct batadv_hard_iface *if_outgoing);
72 struct batadv_orig_ifinfo *
73 batadv_orig_ifinfo_new(struct batadv_orig_node *orig_node,
74 		       struct batadv_hard_iface *if_outgoing);
75 void batadv_orig_ifinfo_put(struct batadv_orig_ifinfo *orig_ifinfo);
76 
77 int batadv_orig_seq_print_text(struct seq_file *seq, void *offset);
78 int batadv_orig_dump(struct sk_buff *msg, struct netlink_callback *cb);
79 int batadv_orig_hardif_seq_print_text(struct seq_file *seq, void *offset);
80 int batadv_orig_hash_add_if(struct batadv_hard_iface *hard_iface,
81 			    int max_if_num);
82 int batadv_orig_hash_del_if(struct batadv_hard_iface *hard_iface,
83 			    int max_if_num);
84 struct batadv_orig_node_vlan *
85 batadv_orig_node_vlan_new(struct batadv_orig_node *orig_node,
86 			  unsigned short vid);
87 struct batadv_orig_node_vlan *
88 batadv_orig_node_vlan_get(struct batadv_orig_node *orig_node,
89 			  unsigned short vid);
90 void batadv_orig_node_vlan_put(struct batadv_orig_node_vlan *orig_vlan);
91 
92 /* hashfunction to choose an entry in a hash table of given size
93  * hash algorithm from http://en.wikipedia.org/wiki/Hash_table
94  */
95 static inline u32 batadv_choose_orig(const void *data, u32 size)
96 {
97 	u32 hash = 0;
98 
99 	hash = jhash(data, ETH_ALEN, hash);
100 	return hash % size;
101 }
102 
103 static inline struct batadv_orig_node *
104 batadv_orig_hash_find(struct batadv_priv *bat_priv, const void *data)
105 {
106 	struct batadv_hashtable *hash = bat_priv->orig_hash;
107 	struct hlist_head *head;
108 	struct batadv_orig_node *orig_node, *orig_node_tmp = NULL;
109 	int index;
110 
111 	if (!hash)
112 		return NULL;
113 
114 	index = batadv_choose_orig(data, hash->size);
115 	head = &hash->table[index];
116 
117 	rcu_read_lock();
118 	hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
119 		if (!batadv_compare_eth(orig_node, data))
120 			continue;
121 
122 		if (!kref_get_unless_zero(&orig_node->refcount))
123 			continue;
124 
125 		orig_node_tmp = orig_node;
126 		break;
127 	}
128 	rcu_read_unlock();
129 
130 	return orig_node_tmp;
131 }
132 
133 #endif /* _NET_BATMAN_ADV_ORIGINATOR_H_ */
134