xref: /openbmc/linux/net/batman-adv/originator.h (revision 53ddcc68)
1 /* Copyright (C) 2007-2016  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 seq_file;
35 
36 bool batadv_compare_orig(const struct hlist_node *node, const void *data2);
37 int batadv_originator_init(struct batadv_priv *bat_priv);
38 void batadv_originator_free(struct batadv_priv *bat_priv);
39 void batadv_purge_orig_ref(struct batadv_priv *bat_priv);
40 void batadv_orig_node_put(struct batadv_orig_node *orig_node);
41 struct batadv_orig_node *batadv_orig_node_new(struct batadv_priv *bat_priv,
42 					      const u8 *addr);
43 struct batadv_hardif_neigh_node *
44 batadv_hardif_neigh_get(const struct batadv_hard_iface *hard_iface,
45 			const u8 *neigh_addr);
46 void
47 batadv_hardif_neigh_put(struct batadv_hardif_neigh_node *hardif_neigh);
48 struct batadv_neigh_node *
49 batadv_neigh_node_new(struct batadv_orig_node *orig_node,
50 		      struct batadv_hard_iface *hard_iface,
51 		      const u8 *neigh_addr);
52 void batadv_neigh_node_put(struct batadv_neigh_node *neigh_node);
53 struct batadv_neigh_node *
54 batadv_orig_router_get(struct batadv_orig_node *orig_node,
55 		       const struct batadv_hard_iface *if_outgoing);
56 struct batadv_neigh_ifinfo *
57 batadv_neigh_ifinfo_new(struct batadv_neigh_node *neigh,
58 			struct batadv_hard_iface *if_outgoing);
59 struct batadv_neigh_ifinfo *
60 batadv_neigh_ifinfo_get(struct batadv_neigh_node *neigh,
61 			struct batadv_hard_iface *if_outgoing);
62 void batadv_neigh_ifinfo_put(struct batadv_neigh_ifinfo *neigh_ifinfo);
63 
64 int batadv_hardif_neigh_seq_print_text(struct seq_file *seq, void *offset);
65 
66 struct batadv_orig_ifinfo *
67 batadv_orig_ifinfo_get(struct batadv_orig_node *orig_node,
68 		       struct batadv_hard_iface *if_outgoing);
69 struct batadv_orig_ifinfo *
70 batadv_orig_ifinfo_new(struct batadv_orig_node *orig_node,
71 		       struct batadv_hard_iface *if_outgoing);
72 void batadv_orig_ifinfo_put(struct batadv_orig_ifinfo *orig_ifinfo);
73 
74 int batadv_orig_seq_print_text(struct seq_file *seq, void *offset);
75 int batadv_orig_hardif_seq_print_text(struct seq_file *seq, void *offset);
76 int batadv_orig_hash_add_if(struct batadv_hard_iface *hard_iface,
77 			    int max_if_num);
78 int batadv_orig_hash_del_if(struct batadv_hard_iface *hard_iface,
79 			    int max_if_num);
80 struct batadv_orig_node_vlan *
81 batadv_orig_node_vlan_new(struct batadv_orig_node *orig_node,
82 			  unsigned short vid);
83 struct batadv_orig_node_vlan *
84 batadv_orig_node_vlan_get(struct batadv_orig_node *orig_node,
85 			  unsigned short vid);
86 void batadv_orig_node_vlan_put(struct batadv_orig_node_vlan *orig_vlan);
87 
88 /* hashfunction to choose an entry in a hash table of given size
89  * hash algorithm from http://en.wikipedia.org/wiki/Hash_table
90  */
91 static inline u32 batadv_choose_orig(const void *data, u32 size)
92 {
93 	u32 hash = 0;
94 
95 	hash = jhash(data, ETH_ALEN, hash);
96 	return hash % size;
97 }
98 
99 static inline struct batadv_orig_node *
100 batadv_orig_hash_find(struct batadv_priv *bat_priv, const void *data)
101 {
102 	struct batadv_hashtable *hash = bat_priv->orig_hash;
103 	struct hlist_head *head;
104 	struct batadv_orig_node *orig_node, *orig_node_tmp = NULL;
105 	int index;
106 
107 	if (!hash)
108 		return NULL;
109 
110 	index = batadv_choose_orig(data, hash->size);
111 	head = &hash->table[index];
112 
113 	rcu_read_lock();
114 	hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
115 		if (!batadv_compare_eth(orig_node, data))
116 			continue;
117 
118 		if (!kref_get_unless_zero(&orig_node->refcount))
119 			continue;
120 
121 		orig_node_tmp = orig_node;
122 		break;
123 	}
124 	rcu_read_unlock();
125 
126 	return orig_node_tmp;
127 }
128 
129 #endif /* _NET_BATMAN_ADV_ORIGINATOR_H_ */
130