Commit | Line | Data |
---|---|---|
9f6446c7 | 1 | /* Copyright (C) 2006-2015 B.A.T.M.A.N. contributors: |
c6c8fea2 SE |
2 | * |
3 | * Simon Wunderlich, Marek Lindner | |
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 | |
ebf38fb7 | 15 | * along with this program; if not, see <http://www.gnu.org/licenses/>. |
c6c8fea2 SE |
16 | */ |
17 | ||
18 | #ifndef _NET_BATMAN_ADV_HASH_H_ | |
19 | #define _NET_BATMAN_ADV_HASH_H_ | |
20 | ||
21 | #include <linux/list.h> | |
22 | ||
9cfc7bd6 SE |
23 | /* callback to a compare function. should compare 2 element datas for their |
24 | * keys, return 0 if same and not 0 if not same | |
25 | */ | |
5bf74e9c SE |
26 | typedef int (*batadv_hashdata_compare_cb)(const struct hlist_node *, |
27 | const void *); | |
c6c8fea2 SE |
28 | |
29 | /* the hashfunction, should return an index | |
30 | * based on the key in the data of the first | |
9cfc7bd6 SE |
31 | * argument and the size the second |
32 | */ | |
5bf74e9c SE |
33 | typedef uint32_t (*batadv_hashdata_choose_cb)(const void *, uint32_t); |
34 | typedef void (*batadv_hashdata_free_cb)(struct hlist_node *, void *); | |
c6c8fea2 | 35 | |
5bf74e9c | 36 | struct batadv_hashtable { |
fb778ea1 ML |
37 | struct hlist_head *table; /* the hashtable itself with the buckets */ |
38 | spinlock_t *list_locks; /* spinlock for each hash list entry */ | |
c90681b8 | 39 | uint32_t size; /* size of hashtable */ |
c6c8fea2 SE |
40 | }; |
41 | ||
42 | /* allocates and clears the hash */ | |
5bf74e9c | 43 | struct batadv_hashtable *batadv_hash_new(uint32_t size); |
c6c8fea2 | 44 | |
5d52dad2 | 45 | /* set class key for all locks */ |
5bf74e9c | 46 | void batadv_hash_set_lock_class(struct batadv_hashtable *hash, |
5d52dad2 SE |
47 | struct lock_class_key *key); |
48 | ||
c6c8fea2 | 49 | /* free only the hashtable and the hash itself. */ |
5bf74e9c | 50 | void batadv_hash_destroy(struct batadv_hashtable *hash); |
c6c8fea2 SE |
51 | |
52 | /* remove the hash structure. if hashdata_free_cb != NULL, this function will be | |
53 | * called to remove the elements inside of the hash. if you don't remove the | |
9cfc7bd6 SE |
54 | * elements, memory might be leaked. |
55 | */ | |
5bf74e9c SE |
56 | static inline void batadv_hash_delete(struct batadv_hashtable *hash, |
57 | batadv_hashdata_free_cb free_cb, | |
58 | void *arg) | |
c6c8fea2 SE |
59 | { |
60 | struct hlist_head *head; | |
7aadf889 | 61 | struct hlist_node *node, *node_tmp; |
fb778ea1 | 62 | spinlock_t *list_lock; /* spinlock to protect write access */ |
c90681b8 | 63 | uint32_t i; |
c6c8fea2 SE |
64 | |
65 | for (i = 0; i < hash->size; i++) { | |
66 | head = &hash->table[i]; | |
fb778ea1 | 67 | list_lock = &hash->list_locks[i]; |
c6c8fea2 | 68 | |
fb778ea1 | 69 | spin_lock_bh(list_lock); |
7aadf889 ML |
70 | hlist_for_each_safe(node, node_tmp, head) { |
71 | hlist_del_rcu(node); | |
c6c8fea2 | 72 | |
7aadf889 ML |
73 | if (free_cb) |
74 | free_cb(node, arg); | |
c6c8fea2 | 75 | } |
fb778ea1 | 76 | spin_unlock_bh(list_lock); |
c6c8fea2 SE |
77 | } |
78 | ||
1a8eaf07 | 79 | batadv_hash_destroy(hash); |
c6c8fea2 SE |
80 | } |
81 | ||
2c53040f BH |
82 | /** |
83 | * batadv_hash_add - adds data to the hashtable | |
1a1f37d9 AQ |
84 | * @hash: storage hash table |
85 | * @compare: callback to determine if 2 hash elements are identical | |
86 | * @choose: callback calculating the hash index | |
87 | * @data: data passed to the aforementioned callbacks as argument | |
88 | * @data_node: to be added element | |
89 | * | |
90 | * Returns 0 on success, 1 if the element already is in the hash | |
91 | * and -1 on error. | |
92 | */ | |
5bf74e9c SE |
93 | static inline int batadv_hash_add(struct batadv_hashtable *hash, |
94 | batadv_hashdata_compare_cb compare, | |
95 | batadv_hashdata_choose_cb choose, | |
c0a55929 SE |
96 | const void *data, |
97 | struct hlist_node *data_node) | |
c6c8fea2 | 98 | { |
c90681b8 AQ |
99 | uint32_t index; |
100 | int ret = -1; | |
c6c8fea2 | 101 | struct hlist_head *head; |
7aadf889 | 102 | struct hlist_node *node; |
fb778ea1 | 103 | spinlock_t *list_lock; /* spinlock to protect write access */ |
c6c8fea2 SE |
104 | |
105 | if (!hash) | |
1a1f37d9 | 106 | goto out; |
c6c8fea2 SE |
107 | |
108 | index = choose(data, hash->size); | |
109 | head = &hash->table[index]; | |
fb778ea1 | 110 | list_lock = &hash->list_locks[index]; |
c6c8fea2 | 111 | |
75c5a2e7 MS |
112 | spin_lock_bh(list_lock); |
113 | ||
114 | hlist_for_each(node, head) { | |
7aadf889 ML |
115 | if (!compare(node, data)) |
116 | continue; | |
117 | ||
1a1f37d9 | 118 | ret = 1; |
75c5a2e7 | 119 | goto unlock; |
c6c8fea2 SE |
120 | } |
121 | ||
122 | /* no duplicate found in list, add new element */ | |
7aadf889 | 123 | hlist_add_head_rcu(data_node, head); |
c6c8fea2 | 124 | |
1a1f37d9 | 125 | ret = 0; |
fb778ea1 | 126 | |
75c5a2e7 MS |
127 | unlock: |
128 | spin_unlock_bh(list_lock); | |
1a1f37d9 AQ |
129 | out: |
130 | return ret; | |
c6c8fea2 SE |
131 | } |
132 | ||
133 | /* removes data from hash, if found. returns pointer do data on success, so you | |
134 | * can remove the used structure yourself, or NULL on error . data could be the | |
135 | * structure you use with just the key filled, we just need the key for | |
9cfc7bd6 SE |
136 | * comparing. |
137 | */ | |
5bf74e9c SE |
138 | static inline void *batadv_hash_remove(struct batadv_hashtable *hash, |
139 | batadv_hashdata_compare_cb compare, | |
140 | batadv_hashdata_choose_cb choose, | |
141 | void *data) | |
c6c8fea2 | 142 | { |
c90681b8 | 143 | uint32_t index; |
7aadf889 | 144 | struct hlist_node *node; |
c6c8fea2 | 145 | struct hlist_head *head; |
fb778ea1 | 146 | void *data_save = NULL; |
c6c8fea2 SE |
147 | |
148 | index = choose(data, hash->size); | |
149 | head = &hash->table[index]; | |
150 | ||
fb778ea1 | 151 | spin_lock_bh(&hash->list_locks[index]); |
7aadf889 ML |
152 | hlist_for_each(node, head) { |
153 | if (!compare(node, data)) | |
154 | continue; | |
155 | ||
156 | data_save = node; | |
157 | hlist_del_rcu(node); | |
158 | break; | |
c6c8fea2 | 159 | } |
fb778ea1 | 160 | spin_unlock_bh(&hash->list_locks[index]); |
c6c8fea2 | 161 | |
fb778ea1 | 162 | return data_save; |
c6c8fea2 SE |
163 | } |
164 | ||
c6c8fea2 | 165 | #endif /* _NET_BATMAN_ADV_HASH_H_ */ |