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