Commit | Line | Data |
---|---|---|
7e1e7763 TG |
1 | /* |
2 | * Resizable, Scalable, Concurrent Hash Table | |
3 | * | |
4 | * Copyright (c) 2014 Thomas Graf <tgraf@suug.ch> | |
5 | * Copyright (c) 2008-2014 Patrick McHardy <kaber@trash.net> | |
6 | * | |
7 | * Based on the following paper by Josh Triplett, Paul E. McKenney | |
8 | * and Jonathan Walpole: | |
9 | * https://www.usenix.org/legacy/event/atc11/tech/final_files/Triplett.pdf | |
10 | * | |
11 | * Code partially derived from nft_hash | |
12 | * | |
13 | * This program is free software; you can redistribute it and/or modify | |
14 | * it under the terms of the GNU General Public License version 2 as | |
15 | * published by the Free Software Foundation. | |
16 | */ | |
17 | ||
18 | #ifndef _LINUX_RHASHTABLE_H | |
19 | #define _LINUX_RHASHTABLE_H | |
20 | ||
f2dba9c6 | 21 | #include <linux/compiler.h> |
f89bd6f8 | 22 | #include <linux/list_nulls.h> |
97defe1e | 23 | #include <linux/workqueue.h> |
86b35b64 | 24 | #include <linux/mutex.h> |
7e1e7763 | 25 | |
f89bd6f8 TG |
26 | /* |
27 | * The end of the chain is marked with a special nulls marks which has | |
28 | * the following format: | |
29 | * | |
30 | * +-------+-----------------------------------------------------+-+ | |
31 | * | Base | Hash |1| | |
32 | * +-------+-----------------------------------------------------+-+ | |
33 | * | |
34 | * Base (4 bits) : Reserved to distinguish between multiple tables. | |
35 | * Specified via &struct rhashtable_params.nulls_base. | |
36 | * Hash (27 bits): Full hash (unmasked) of first element added to bucket | |
37 | * 1 (1 bit) : Nulls marker (always set) | |
38 | * | |
39 | * The remaining bits of the next pointer remain unused for now. | |
40 | */ | |
41 | #define RHT_BASE_BITS 4 | |
42 | #define RHT_HASH_BITS 27 | |
43 | #define RHT_BASE_SHIFT RHT_HASH_BITS | |
44 | ||
7e1e7763 | 45 | struct rhash_head { |
5300fdcb | 46 | struct rhash_head __rcu *next; |
7e1e7763 TG |
47 | }; |
48 | ||
97defe1e TG |
49 | /** |
50 | * struct bucket_table - Table of hash buckets | |
51 | * @size: Number of hash buckets | |
988dfbd7 | 52 | * @hash_rnd: Random seed to fold into hash |
a5b6846f | 53 | * @shift: Current size (1 << shift) |
97defe1e TG |
54 | * @locks_mask: Mask to apply before accessing locks[] |
55 | * @locks: Array of spinlocks protecting individual buckets | |
eddee5ba | 56 | * @walkers: List of active walkers |
9d901bc0 | 57 | * @rcu: RCU structure for freeing the table |
97defe1e TG |
58 | * @buckets: size * hash buckets |
59 | */ | |
7e1e7763 | 60 | struct bucket_table { |
b9ebafbe | 61 | size_t size; |
988dfbd7 | 62 | u32 hash_rnd; |
a5b6846f | 63 | u32 shift; |
b9ebafbe ED |
64 | unsigned int locks_mask; |
65 | spinlock_t *locks; | |
eddee5ba | 66 | struct list_head walkers; |
9d901bc0 | 67 | struct rcu_head rcu; |
b9ebafbe ED |
68 | |
69 | struct rhash_head __rcu *buckets[] ____cacheline_aligned_in_smp; | |
7e1e7763 TG |
70 | }; |
71 | ||
72 | typedef u32 (*rht_hashfn_t)(const void *data, u32 len, u32 seed); | |
73 | typedef u32 (*rht_obj_hashfn_t)(const void *data, u32 seed); | |
74 | ||
75 | struct rhashtable; | |
76 | ||
77 | /** | |
78 | * struct rhashtable_params - Hash table construction parameters | |
79 | * @nelem_hint: Hint on number of elements, should be 75% of desired size | |
80 | * @key_len: Length of key | |
81 | * @key_offset: Offset of key in struct to be hashed | |
82 | * @head_offset: Offset of rhash_head in struct to be hashed | |
7e1e7763 | 83 | * @max_shift: Maximum number of shifts while expanding |
94000176 | 84 | * @min_shift: Minimum number of shifts while shrinking |
f89bd6f8 | 85 | * @nulls_base: Base value to generate nulls marker |
97defe1e | 86 | * @locks_mul: Number of bucket locks to allocate per cpu (default: 128) |
7e1e7763 TG |
87 | * @hashfn: Function to hash key |
88 | * @obj_hashfn: Function to hash object | |
7e1e7763 TG |
89 | */ |
90 | struct rhashtable_params { | |
91 | size_t nelem_hint; | |
92 | size_t key_len; | |
93 | size_t key_offset; | |
94 | size_t head_offset; | |
7e1e7763 | 95 | size_t max_shift; |
94000176 | 96 | size_t min_shift; |
f89bd6f8 | 97 | u32 nulls_base; |
97defe1e | 98 | size_t locks_mul; |
7e1e7763 TG |
99 | rht_hashfn_t hashfn; |
100 | rht_obj_hashfn_t obj_hashfn; | |
7e1e7763 TG |
101 | }; |
102 | ||
103 | /** | |
104 | * struct rhashtable - Hash table handle | |
105 | * @tbl: Bucket table | |
97defe1e | 106 | * @future_tbl: Table under construction during expansion/shrinking |
7e1e7763 | 107 | * @nelems: Number of elements in table |
7e1e7763 | 108 | * @p: Configuration parameters |
97defe1e TG |
109 | * @run_work: Deferred worker to expand/shrink asynchronously |
110 | * @mutex: Mutex to protect current/future table swapping | |
111 | * @being_destroyed: True if table is set up for destruction | |
7e1e7763 TG |
112 | */ |
113 | struct rhashtable { | |
114 | struct bucket_table __rcu *tbl; | |
97defe1e TG |
115 | struct bucket_table __rcu *future_tbl; |
116 | atomic_t nelems; | |
a5b6846f | 117 | bool being_destroyed; |
7e1e7763 | 118 | struct rhashtable_params p; |
57699a40 | 119 | struct work_struct run_work; |
97defe1e | 120 | struct mutex mutex; |
7e1e7763 TG |
121 | }; |
122 | ||
f2dba9c6 HX |
123 | /** |
124 | * struct rhashtable_walker - Hash table walker | |
125 | * @list: List entry on list of walkers | |
eddee5ba | 126 | * @tbl: The table that we were walking over |
f2dba9c6 HX |
127 | */ |
128 | struct rhashtable_walker { | |
129 | struct list_head list; | |
eddee5ba | 130 | struct bucket_table *tbl; |
f2dba9c6 HX |
131 | }; |
132 | ||
133 | /** | |
134 | * struct rhashtable_iter - Hash table iterator, fits into netlink cb | |
135 | * @ht: Table to iterate through | |
136 | * @p: Current pointer | |
137 | * @walker: Associated rhashtable walker | |
138 | * @slot: Current slot | |
139 | * @skip: Number of entries to skip in slot | |
140 | */ | |
141 | struct rhashtable_iter { | |
142 | struct rhashtable *ht; | |
143 | struct rhash_head *p; | |
144 | struct rhashtable_walker *walker; | |
145 | unsigned int slot; | |
146 | unsigned int skip; | |
147 | }; | |
148 | ||
f89bd6f8 TG |
149 | static inline unsigned long rht_marker(const struct rhashtable *ht, u32 hash) |
150 | { | |
151 | return NULLS_MARKER(ht->p.nulls_base + hash); | |
152 | } | |
153 | ||
154 | #define INIT_RHT_NULLS_HEAD(ptr, ht, hash) \ | |
155 | ((ptr) = (typeof(ptr)) rht_marker(ht, hash)) | |
156 | ||
157 | static inline bool rht_is_a_nulls(const struct rhash_head *ptr) | |
158 | { | |
159 | return ((unsigned long) ptr & 1); | |
160 | } | |
161 | ||
162 | static inline unsigned long rht_get_nulls_value(const struct rhash_head *ptr) | |
163 | { | |
164 | return ((unsigned long) ptr) >> 1; | |
165 | } | |
166 | ||
7e1e7763 | 167 | #ifdef CONFIG_PROVE_LOCKING |
97defe1e | 168 | int lockdep_rht_mutex_is_held(struct rhashtable *ht); |
88d6ed15 | 169 | int lockdep_rht_bucket_is_held(const struct bucket_table *tbl, u32 hash); |
7e1e7763 | 170 | #else |
97defe1e | 171 | static inline int lockdep_rht_mutex_is_held(struct rhashtable *ht) |
7e1e7763 TG |
172 | { |
173 | return 1; | |
174 | } | |
88d6ed15 TG |
175 | |
176 | static inline int lockdep_rht_bucket_is_held(const struct bucket_table *tbl, | |
177 | u32 hash) | |
178 | { | |
179 | return 1; | |
180 | } | |
7e1e7763 TG |
181 | #endif /* CONFIG_PROVE_LOCKING */ |
182 | ||
183 | int rhashtable_init(struct rhashtable *ht, struct rhashtable_params *params); | |
184 | ||
6eba8224 TG |
185 | void rhashtable_insert(struct rhashtable *ht, struct rhash_head *node); |
186 | bool rhashtable_remove(struct rhashtable *ht, struct rhash_head *node); | |
7e1e7763 | 187 | |
6eba8224 TG |
188 | int rhashtable_expand(struct rhashtable *ht); |
189 | int rhashtable_shrink(struct rhashtable *ht); | |
7e1e7763 | 190 | |
97defe1e TG |
191 | void *rhashtable_lookup(struct rhashtable *ht, const void *key); |
192 | void *rhashtable_lookup_compare(struct rhashtable *ht, const void *key, | |
7e1e7763 | 193 | bool (*compare)(void *, void *), void *arg); |
7a868d1e | 194 | |
db304854 | 195 | bool rhashtable_lookup_insert(struct rhashtable *ht, struct rhash_head *obj); |
7a868d1e YX |
196 | bool rhashtable_lookup_compare_insert(struct rhashtable *ht, |
197 | struct rhash_head *obj, | |
198 | bool (*compare)(void *, void *), | |
199 | void *arg); | |
7e1e7763 | 200 | |
f2dba9c6 HX |
201 | int rhashtable_walk_init(struct rhashtable *ht, struct rhashtable_iter *iter); |
202 | void rhashtable_walk_exit(struct rhashtable_iter *iter); | |
203 | int rhashtable_walk_start(struct rhashtable_iter *iter) __acquires(RCU); | |
204 | void *rhashtable_walk_next(struct rhashtable_iter *iter); | |
205 | void rhashtable_walk_stop(struct rhashtable_iter *iter) __releases(RCU); | |
206 | ||
97defe1e | 207 | void rhashtable_destroy(struct rhashtable *ht); |
7e1e7763 TG |
208 | |
209 | #define rht_dereference(p, ht) \ | |
210 | rcu_dereference_protected(p, lockdep_rht_mutex_is_held(ht)) | |
211 | ||
212 | #define rht_dereference_rcu(p, ht) \ | |
213 | rcu_dereference_check(p, lockdep_rht_mutex_is_held(ht)) | |
214 | ||
88d6ed15 TG |
215 | #define rht_dereference_bucket(p, tbl, hash) \ |
216 | rcu_dereference_protected(p, lockdep_rht_bucket_is_held(tbl, hash)) | |
7e1e7763 | 217 | |
88d6ed15 TG |
218 | #define rht_dereference_bucket_rcu(p, tbl, hash) \ |
219 | rcu_dereference_check(p, lockdep_rht_bucket_is_held(tbl, hash)) | |
220 | ||
221 | #define rht_entry(tpos, pos, member) \ | |
222 | ({ tpos = container_of(pos, typeof(*tpos), member); 1; }) | |
7e1e7763 TG |
223 | |
224 | /** | |
88d6ed15 TG |
225 | * rht_for_each_continue - continue iterating over hash chain |
226 | * @pos: the &struct rhash_head to use as a loop cursor. | |
227 | * @head: the previous &struct rhash_head to continue from | |
228 | * @tbl: the &struct bucket_table | |
229 | * @hash: the hash value / bucket index | |
7e1e7763 | 230 | */ |
88d6ed15 TG |
231 | #define rht_for_each_continue(pos, head, tbl, hash) \ |
232 | for (pos = rht_dereference_bucket(head, tbl, hash); \ | |
f89bd6f8 | 233 | !rht_is_a_nulls(pos); \ |
88d6ed15 TG |
234 | pos = rht_dereference_bucket((pos)->next, tbl, hash)) |
235 | ||
236 | /** | |
237 | * rht_for_each - iterate over hash chain | |
238 | * @pos: the &struct rhash_head to use as a loop cursor. | |
239 | * @tbl: the &struct bucket_table | |
240 | * @hash: the hash value / bucket index | |
241 | */ | |
242 | #define rht_for_each(pos, tbl, hash) \ | |
243 | rht_for_each_continue(pos, (tbl)->buckets[hash], tbl, hash) | |
244 | ||
245 | /** | |
246 | * rht_for_each_entry_continue - continue iterating over hash chain | |
247 | * @tpos: the type * to use as a loop cursor. | |
248 | * @pos: the &struct rhash_head to use as a loop cursor. | |
249 | * @head: the previous &struct rhash_head to continue from | |
250 | * @tbl: the &struct bucket_table | |
251 | * @hash: the hash value / bucket index | |
252 | * @member: name of the &struct rhash_head within the hashable struct. | |
253 | */ | |
254 | #define rht_for_each_entry_continue(tpos, pos, head, tbl, hash, member) \ | |
255 | for (pos = rht_dereference_bucket(head, tbl, hash); \ | |
f89bd6f8 | 256 | (!rht_is_a_nulls(pos)) && rht_entry(tpos, pos, member); \ |
88d6ed15 | 257 | pos = rht_dereference_bucket((pos)->next, tbl, hash)) |
7e1e7763 TG |
258 | |
259 | /** | |
260 | * rht_for_each_entry - iterate over hash chain of given type | |
88d6ed15 TG |
261 | * @tpos: the type * to use as a loop cursor. |
262 | * @pos: the &struct rhash_head to use as a loop cursor. | |
263 | * @tbl: the &struct bucket_table | |
264 | * @hash: the hash value / bucket index | |
265 | * @member: name of the &struct rhash_head within the hashable struct. | |
7e1e7763 | 266 | */ |
88d6ed15 TG |
267 | #define rht_for_each_entry(tpos, pos, tbl, hash, member) \ |
268 | rht_for_each_entry_continue(tpos, pos, (tbl)->buckets[hash], \ | |
269 | tbl, hash, member) | |
7e1e7763 TG |
270 | |
271 | /** | |
272 | * rht_for_each_entry_safe - safely iterate over hash chain of given type | |
88d6ed15 TG |
273 | * @tpos: the type * to use as a loop cursor. |
274 | * @pos: the &struct rhash_head to use as a loop cursor. | |
275 | * @next: the &struct rhash_head to use as next in loop cursor. | |
276 | * @tbl: the &struct bucket_table | |
277 | * @hash: the hash value / bucket index | |
278 | * @member: name of the &struct rhash_head within the hashable struct. | |
7e1e7763 TG |
279 | * |
280 | * This hash chain list-traversal primitive allows for the looped code to | |
281 | * remove the loop cursor from the list. | |
282 | */ | |
88d6ed15 TG |
283 | #define rht_for_each_entry_safe(tpos, pos, next, tbl, hash, member) \ |
284 | for (pos = rht_dereference_bucket((tbl)->buckets[hash], tbl, hash), \ | |
f89bd6f8 TG |
285 | next = !rht_is_a_nulls(pos) ? \ |
286 | rht_dereference_bucket(pos->next, tbl, hash) : NULL; \ | |
287 | (!rht_is_a_nulls(pos)) && rht_entry(tpos, pos, member); \ | |
607954b0 PM |
288 | pos = next, \ |
289 | next = !rht_is_a_nulls(pos) ? \ | |
290 | rht_dereference_bucket(pos->next, tbl, hash) : NULL) | |
88d6ed15 TG |
291 | |
292 | /** | |
293 | * rht_for_each_rcu_continue - continue iterating over rcu hash chain | |
294 | * @pos: the &struct rhash_head to use as a loop cursor. | |
295 | * @head: the previous &struct rhash_head to continue from | |
296 | * @tbl: the &struct bucket_table | |
297 | * @hash: the hash value / bucket index | |
298 | * | |
299 | * This hash chain list-traversal primitive may safely run concurrently with | |
300 | * the _rcu mutation primitives such as rhashtable_insert() as long as the | |
301 | * traversal is guarded by rcu_read_lock(). | |
302 | */ | |
303 | #define rht_for_each_rcu_continue(pos, head, tbl, hash) \ | |
304 | for (({barrier(); }), \ | |
305 | pos = rht_dereference_bucket_rcu(head, tbl, hash); \ | |
f89bd6f8 | 306 | !rht_is_a_nulls(pos); \ |
88d6ed15 | 307 | pos = rcu_dereference_raw(pos->next)) |
7e1e7763 TG |
308 | |
309 | /** | |
310 | * rht_for_each_rcu - iterate over rcu hash chain | |
88d6ed15 TG |
311 | * @pos: the &struct rhash_head to use as a loop cursor. |
312 | * @tbl: the &struct bucket_table | |
313 | * @hash: the hash value / bucket index | |
7e1e7763 TG |
314 | * |
315 | * This hash chain list-traversal primitive may safely run concurrently with | |
88d6ed15 | 316 | * the _rcu mutation primitives such as rhashtable_insert() as long as the |
7e1e7763 TG |
317 | * traversal is guarded by rcu_read_lock(). |
318 | */ | |
88d6ed15 TG |
319 | #define rht_for_each_rcu(pos, tbl, hash) \ |
320 | rht_for_each_rcu_continue(pos, (tbl)->buckets[hash], tbl, hash) | |
321 | ||
322 | /** | |
323 | * rht_for_each_entry_rcu_continue - continue iterating over rcu hash chain | |
324 | * @tpos: the type * to use as a loop cursor. | |
325 | * @pos: the &struct rhash_head to use as a loop cursor. | |
326 | * @head: the previous &struct rhash_head to continue from | |
327 | * @tbl: the &struct bucket_table | |
328 | * @hash: the hash value / bucket index | |
329 | * @member: name of the &struct rhash_head within the hashable struct. | |
330 | * | |
331 | * This hash chain list-traversal primitive may safely run concurrently with | |
332 | * the _rcu mutation primitives such as rhashtable_insert() as long as the | |
333 | * traversal is guarded by rcu_read_lock(). | |
334 | */ | |
335 | #define rht_for_each_entry_rcu_continue(tpos, pos, head, tbl, hash, member) \ | |
336 | for (({barrier(); }), \ | |
337 | pos = rht_dereference_bucket_rcu(head, tbl, hash); \ | |
f89bd6f8 | 338 | (!rht_is_a_nulls(pos)) && rht_entry(tpos, pos, member); \ |
88d6ed15 | 339 | pos = rht_dereference_bucket_rcu(pos->next, tbl, hash)) |
7e1e7763 TG |
340 | |
341 | /** | |
342 | * rht_for_each_entry_rcu - iterate over rcu hash chain of given type | |
88d6ed15 TG |
343 | * @tpos: the type * to use as a loop cursor. |
344 | * @pos: the &struct rhash_head to use as a loop cursor. | |
345 | * @tbl: the &struct bucket_table | |
346 | * @hash: the hash value / bucket index | |
347 | * @member: name of the &struct rhash_head within the hashable struct. | |
7e1e7763 TG |
348 | * |
349 | * This hash chain list-traversal primitive may safely run concurrently with | |
88d6ed15 | 350 | * the _rcu mutation primitives such as rhashtable_insert() as long as the |
7e1e7763 TG |
351 | * traversal is guarded by rcu_read_lock(). |
352 | */ | |
88d6ed15 TG |
353 | #define rht_for_each_entry_rcu(tpos, pos, tbl, hash, member) \ |
354 | rht_for_each_entry_rcu_continue(tpos, pos, (tbl)->buckets[hash],\ | |
355 | tbl, hash, member) | |
7e1e7763 TG |
356 | |
357 | #endif /* _LINUX_RHASHTABLE_H */ |