]>
Commit | Line | Data |
---|---|---|
7e1e7763 TG |
1 | /* |
2 | * Resizable, Scalable, Concurrent Hash Table | |
3 | * | |
02fd97c3 | 4 | * Copyright (c) 2015 Herbert Xu <herbert@gondor.apana.org.au> |
a5ec68e3 | 5 | * Copyright (c) 2014-2015 Thomas Graf <tgraf@suug.ch> |
7e1e7763 TG |
6 | * Copyright (c) 2008-2014 Patrick McHardy <kaber@trash.net> |
7 | * | |
7e1e7763 | 8 | * Code partially derived from nft_hash |
02fd97c3 HX |
9 | * Rewritten with rehash code from br_multicast plus single list |
10 | * pointer as suggested by Josh Triplett | |
7e1e7763 TG |
11 | * |
12 | * This program is free software; you can redistribute it and/or modify | |
13 | * it under the terms of the GNU General Public License version 2 as | |
14 | * published by the Free Software Foundation. | |
15 | */ | |
16 | ||
07ee0722 | 17 | #include <linux/atomic.h> |
7e1e7763 TG |
18 | #include <linux/kernel.h> |
19 | #include <linux/init.h> | |
20 | #include <linux/log2.h> | |
5beb5c90 | 21 | #include <linux/sched.h> |
7e1e7763 TG |
22 | #include <linux/slab.h> |
23 | #include <linux/vmalloc.h> | |
24 | #include <linux/mm.h> | |
87545899 | 25 | #include <linux/jhash.h> |
7e1e7763 TG |
26 | #include <linux/random.h> |
27 | #include <linux/rhashtable.h> | |
61d7b097 | 28 | #include <linux/err.h> |
6d795413 | 29 | #include <linux/export.h> |
7e1e7763 TG |
30 | |
31 | #define HASH_DEFAULT_SIZE 64UL | |
c2e213cf | 32 | #define HASH_MIN_SIZE 4U |
4cf0b354 | 33 | #define BUCKET_LOCKS_PER_CPU 32UL |
97defe1e | 34 | |
988dfbd7 | 35 | static u32 head_hashfn(struct rhashtable *ht, |
8d24c0b4 TG |
36 | const struct bucket_table *tbl, |
37 | const struct rhash_head *he) | |
7e1e7763 | 38 | { |
02fd97c3 | 39 | return rht_head_hashfn(ht, tbl, he, ht->p); |
7e1e7763 TG |
40 | } |
41 | ||
a03eaec0 | 42 | #ifdef CONFIG_PROVE_LOCKING |
a03eaec0 | 43 | #define ASSERT_RHT_MUTEX(HT) BUG_ON(!lockdep_rht_mutex_is_held(HT)) |
a03eaec0 TG |
44 | |
45 | int lockdep_rht_mutex_is_held(struct rhashtable *ht) | |
46 | { | |
47 | return (debug_locks) ? lockdep_is_held(&ht->mutex) : 1; | |
48 | } | |
49 | EXPORT_SYMBOL_GPL(lockdep_rht_mutex_is_held); | |
50 | ||
51 | int lockdep_rht_bucket_is_held(const struct bucket_table *tbl, u32 hash) | |
52 | { | |
02fd97c3 | 53 | spinlock_t *lock = rht_bucket_lock(tbl, hash); |
a03eaec0 TG |
54 | |
55 | return (debug_locks) ? lockdep_is_held(lock) : 1; | |
56 | } | |
57 | EXPORT_SYMBOL_GPL(lockdep_rht_bucket_is_held); | |
58 | #else | |
59 | #define ASSERT_RHT_MUTEX(HT) | |
a03eaec0 TG |
60 | #endif |
61 | ||
62 | ||
b9ecfdaa HX |
63 | static int alloc_bucket_locks(struct rhashtable *ht, struct bucket_table *tbl, |
64 | gfp_t gfp) | |
97defe1e TG |
65 | { |
66 | unsigned int i, size; | |
67 | #if defined(CONFIG_PROVE_LOCKING) | |
68 | unsigned int nr_pcpus = 2; | |
69 | #else | |
70 | unsigned int nr_pcpus = num_possible_cpus(); | |
71 | #endif | |
72 | ||
4cf0b354 | 73 | nr_pcpus = min_t(unsigned int, nr_pcpus, 64UL); |
97defe1e TG |
74 | size = roundup_pow_of_two(nr_pcpus * ht->p.locks_mul); |
75 | ||
a5ec68e3 TG |
76 | /* Never allocate more than 0.5 locks per bucket */ |
77 | size = min_t(unsigned int, size, tbl->size >> 1); | |
97defe1e TG |
78 | |
79 | if (sizeof(spinlock_t) != 0) { | |
80 | #ifdef CONFIG_NUMA | |
b9ecfdaa HX |
81 | if (size * sizeof(spinlock_t) > PAGE_SIZE && |
82 | gfp == GFP_KERNEL) | |
97defe1e TG |
83 | tbl->locks = vmalloc(size * sizeof(spinlock_t)); |
84 | else | |
85 | #endif | |
4cf0b354 FW |
86 | if (gfp != GFP_KERNEL) |
87 | gfp |= __GFP_NOWARN | __GFP_NORETRY; | |
88 | ||
97defe1e | 89 | tbl->locks = kmalloc_array(size, sizeof(spinlock_t), |
b9ecfdaa | 90 | gfp); |
97defe1e TG |
91 | if (!tbl->locks) |
92 | return -ENOMEM; | |
93 | for (i = 0; i < size; i++) | |
94 | spin_lock_init(&tbl->locks[i]); | |
95 | } | |
96 | tbl->locks_mask = size - 1; | |
97 | ||
98 | return 0; | |
99 | } | |
100 | ||
101 | static void bucket_table_free(const struct bucket_table *tbl) | |
102 | { | |
103 | if (tbl) | |
104 | kvfree(tbl->locks); | |
105 | ||
106 | kvfree(tbl); | |
107 | } | |
108 | ||
9d901bc0 HX |
109 | static void bucket_table_free_rcu(struct rcu_head *head) |
110 | { | |
111 | bucket_table_free(container_of(head, struct bucket_table, rcu)); | |
112 | } | |
113 | ||
97defe1e | 114 | static struct bucket_table *bucket_table_alloc(struct rhashtable *ht, |
b9ecfdaa HX |
115 | size_t nbuckets, |
116 | gfp_t gfp) | |
7e1e7763 | 117 | { |
eb6d1abf | 118 | struct bucket_table *tbl = NULL; |
7e1e7763 | 119 | size_t size; |
f89bd6f8 | 120 | int i; |
7e1e7763 TG |
121 | |
122 | size = sizeof(*tbl) + nbuckets * sizeof(tbl->buckets[0]); | |
b9ecfdaa HX |
123 | if (size <= (PAGE_SIZE << PAGE_ALLOC_COSTLY_ORDER) || |
124 | gfp != GFP_KERNEL) | |
125 | tbl = kzalloc(size, gfp | __GFP_NOWARN | __GFP_NORETRY); | |
126 | if (tbl == NULL && gfp == GFP_KERNEL) | |
7e1e7763 | 127 | tbl = vzalloc(size); |
7e1e7763 TG |
128 | if (tbl == NULL) |
129 | return NULL; | |
130 | ||
131 | tbl->size = nbuckets; | |
132 | ||
b9ecfdaa | 133 | if (alloc_bucket_locks(ht, tbl, gfp) < 0) { |
97defe1e TG |
134 | bucket_table_free(tbl); |
135 | return NULL; | |
136 | } | |
7e1e7763 | 137 | |
eddee5ba HX |
138 | INIT_LIST_HEAD(&tbl->walkers); |
139 | ||
5269b53d HX |
140 | get_random_bytes(&tbl->hash_rnd, sizeof(tbl->hash_rnd)); |
141 | ||
f89bd6f8 TG |
142 | for (i = 0; i < nbuckets; i++) |
143 | INIT_RHT_NULLS_HEAD(tbl->buckets[i], ht, i); | |
144 | ||
97defe1e | 145 | return tbl; |
7e1e7763 TG |
146 | } |
147 | ||
b824478b HX |
148 | static struct bucket_table *rhashtable_last_table(struct rhashtable *ht, |
149 | struct bucket_table *tbl) | |
150 | { | |
151 | struct bucket_table *new_tbl; | |
152 | ||
153 | do { | |
154 | new_tbl = tbl; | |
155 | tbl = rht_dereference_rcu(tbl->future_tbl, ht); | |
156 | } while (tbl); | |
157 | ||
158 | return new_tbl; | |
159 | } | |
160 | ||
299e5c32 | 161 | static int rhashtable_rehash_one(struct rhashtable *ht, unsigned int old_hash) |
a5ec68e3 | 162 | { |
aa34a6cb | 163 | struct bucket_table *old_tbl = rht_dereference(ht->tbl, ht); |
b824478b HX |
164 | struct bucket_table *new_tbl = rhashtable_last_table(ht, |
165 | rht_dereference_rcu(old_tbl->future_tbl, ht)); | |
aa34a6cb HX |
166 | struct rhash_head __rcu **pprev = &old_tbl->buckets[old_hash]; |
167 | int err = -ENOENT; | |
168 | struct rhash_head *head, *next, *entry; | |
169 | spinlock_t *new_bucket_lock; | |
299e5c32 | 170 | unsigned int new_hash; |
aa34a6cb HX |
171 | |
172 | rht_for_each(entry, old_tbl, old_hash) { | |
173 | err = 0; | |
174 | next = rht_dereference_bucket(entry->next, old_tbl, old_hash); | |
175 | ||
176 | if (rht_is_a_nulls(next)) | |
177 | break; | |
a5ec68e3 | 178 | |
aa34a6cb HX |
179 | pprev = &entry->next; |
180 | } | |
a5ec68e3 | 181 | |
aa34a6cb HX |
182 | if (err) |
183 | goto out; | |
97defe1e | 184 | |
aa34a6cb | 185 | new_hash = head_hashfn(ht, new_tbl, entry); |
7e1e7763 | 186 | |
02fd97c3 | 187 | new_bucket_lock = rht_bucket_lock(new_tbl, new_hash); |
7e1e7763 | 188 | |
8f2484bd | 189 | spin_lock_nested(new_bucket_lock, SINGLE_DEPTH_NESTING); |
aa34a6cb HX |
190 | head = rht_dereference_bucket(new_tbl->buckets[new_hash], |
191 | new_tbl, new_hash); | |
97defe1e | 192 | |
7def0f95 | 193 | RCU_INIT_POINTER(entry->next, head); |
a5ec68e3 | 194 | |
aa34a6cb HX |
195 | rcu_assign_pointer(new_tbl->buckets[new_hash], entry); |
196 | spin_unlock(new_bucket_lock); | |
97defe1e | 197 | |
aa34a6cb | 198 | rcu_assign_pointer(*pprev, next); |
7e1e7763 | 199 | |
aa34a6cb HX |
200 | out: |
201 | return err; | |
202 | } | |
97defe1e | 203 | |
299e5c32 TG |
204 | static void rhashtable_rehash_chain(struct rhashtable *ht, |
205 | unsigned int old_hash) | |
aa34a6cb HX |
206 | { |
207 | struct bucket_table *old_tbl = rht_dereference(ht->tbl, ht); | |
208 | spinlock_t *old_bucket_lock; | |
209 | ||
02fd97c3 | 210 | old_bucket_lock = rht_bucket_lock(old_tbl, old_hash); |
a5ec68e3 | 211 | |
aa34a6cb HX |
212 | spin_lock_bh(old_bucket_lock); |
213 | while (!rhashtable_rehash_one(ht, old_hash)) | |
214 | ; | |
63d512d0 | 215 | old_tbl->rehash++; |
aa34a6cb | 216 | spin_unlock_bh(old_bucket_lock); |
97defe1e TG |
217 | } |
218 | ||
b824478b HX |
219 | static int rhashtable_rehash_attach(struct rhashtable *ht, |
220 | struct bucket_table *old_tbl, | |
221 | struct bucket_table *new_tbl) | |
97defe1e | 222 | { |
b824478b HX |
223 | /* Protect future_tbl using the first bucket lock. */ |
224 | spin_lock_bh(old_tbl->locks); | |
225 | ||
226 | /* Did somebody beat us to it? */ | |
227 | if (rcu_access_pointer(old_tbl->future_tbl)) { | |
228 | spin_unlock_bh(old_tbl->locks); | |
229 | return -EEXIST; | |
230 | } | |
7cd10db8 | 231 | |
aa34a6cb HX |
232 | /* Make insertions go into the new, empty table right away. Deletions |
233 | * and lookups will be attempted in both tables until we synchronize. | |
aa34a6cb | 234 | */ |
c4db8848 | 235 | rcu_assign_pointer(old_tbl->future_tbl, new_tbl); |
aa34a6cb | 236 | |
b824478b HX |
237 | spin_unlock_bh(old_tbl->locks); |
238 | ||
239 | return 0; | |
240 | } | |
241 | ||
242 | static int rhashtable_rehash_table(struct rhashtable *ht) | |
243 | { | |
244 | struct bucket_table *old_tbl = rht_dereference(ht->tbl, ht); | |
245 | struct bucket_table *new_tbl; | |
246 | struct rhashtable_walker *walker; | |
299e5c32 | 247 | unsigned int old_hash; |
b824478b HX |
248 | |
249 | new_tbl = rht_dereference(old_tbl->future_tbl, ht); | |
250 | if (!new_tbl) | |
251 | return 0; | |
252 | ||
aa34a6cb HX |
253 | for (old_hash = 0; old_hash < old_tbl->size; old_hash++) |
254 | rhashtable_rehash_chain(ht, old_hash); | |
255 | ||
256 | /* Publish the new table pointer. */ | |
257 | rcu_assign_pointer(ht->tbl, new_tbl); | |
258 | ||
ba7c95ea | 259 | spin_lock(&ht->lock); |
eddee5ba HX |
260 | list_for_each_entry(walker, &old_tbl->walkers, list) |
261 | walker->tbl = NULL; | |
ba7c95ea | 262 | spin_unlock(&ht->lock); |
eddee5ba | 263 | |
aa34a6cb HX |
264 | /* Wait for readers. All new readers will see the new |
265 | * table, and thus no references to the old table will | |
266 | * remain. | |
267 | */ | |
9d901bc0 | 268 | call_rcu(&old_tbl->rcu, bucket_table_free_rcu); |
b824478b HX |
269 | |
270 | return rht_dereference(new_tbl->future_tbl, ht) ? -EAGAIN : 0; | |
7e1e7763 TG |
271 | } |
272 | ||
273 | /** | |
274 | * rhashtable_expand - Expand hash table while allowing concurrent lookups | |
275 | * @ht: the hash table to expand | |
7e1e7763 | 276 | * |
aa34a6cb | 277 | * A secondary bucket array is allocated and the hash entries are migrated. |
7e1e7763 TG |
278 | * |
279 | * This function may only be called in a context where it is safe to call | |
280 | * synchronize_rcu(), e.g. not within a rcu_read_lock() section. | |
281 | * | |
97defe1e TG |
282 | * The caller must ensure that no concurrent resizing occurs by holding |
283 | * ht->mutex. | |
284 | * | |
285 | * It is valid to have concurrent insertions and deletions protected by per | |
286 | * bucket locks or concurrent RCU protected lookups and traversals. | |
7e1e7763 | 287 | */ |
b824478b | 288 | static int rhashtable_expand(struct rhashtable *ht) |
7e1e7763 TG |
289 | { |
290 | struct bucket_table *new_tbl, *old_tbl = rht_dereference(ht->tbl, ht); | |
b824478b | 291 | int err; |
7e1e7763 TG |
292 | |
293 | ASSERT_RHT_MUTEX(ht); | |
294 | ||
b824478b HX |
295 | old_tbl = rhashtable_last_table(ht, old_tbl); |
296 | ||
b9ecfdaa | 297 | new_tbl = bucket_table_alloc(ht, old_tbl->size * 2, GFP_KERNEL); |
7e1e7763 TG |
298 | if (new_tbl == NULL) |
299 | return -ENOMEM; | |
300 | ||
b824478b HX |
301 | err = rhashtable_rehash_attach(ht, old_tbl, new_tbl); |
302 | if (err) | |
303 | bucket_table_free(new_tbl); | |
304 | ||
305 | return err; | |
7e1e7763 | 306 | } |
7e1e7763 TG |
307 | |
308 | /** | |
309 | * rhashtable_shrink - Shrink hash table while allowing concurrent lookups | |
310 | * @ht: the hash table to shrink | |
7e1e7763 | 311 | * |
18093d1c HX |
312 | * This function shrinks the hash table to fit, i.e., the smallest |
313 | * size would not cause it to expand right away automatically. | |
7e1e7763 | 314 | * |
97defe1e TG |
315 | * The caller must ensure that no concurrent resizing occurs by holding |
316 | * ht->mutex. | |
317 | * | |
7e1e7763 TG |
318 | * The caller must ensure that no concurrent table mutations take place. |
319 | * It is however valid to have concurrent lookups if they are RCU protected. | |
97defe1e TG |
320 | * |
321 | * It is valid to have concurrent insertions and deletions protected by per | |
322 | * bucket locks or concurrent RCU protected lookups and traversals. | |
7e1e7763 | 323 | */ |
b824478b | 324 | static int rhashtable_shrink(struct rhashtable *ht) |
7e1e7763 | 325 | { |
a5b6846f | 326 | struct bucket_table *new_tbl, *old_tbl = rht_dereference(ht->tbl, ht); |
12311959 VN |
327 | unsigned int nelems = atomic_read(&ht->nelems); |
328 | unsigned int size = 0; | |
b824478b | 329 | int err; |
7e1e7763 TG |
330 | |
331 | ASSERT_RHT_MUTEX(ht); | |
332 | ||
12311959 VN |
333 | if (nelems) |
334 | size = roundup_pow_of_two(nelems * 3 / 2); | |
18093d1c HX |
335 | if (size < ht->p.min_size) |
336 | size = ht->p.min_size; | |
337 | ||
338 | if (old_tbl->size <= size) | |
339 | return 0; | |
340 | ||
b824478b HX |
341 | if (rht_dereference(old_tbl->future_tbl, ht)) |
342 | return -EEXIST; | |
343 | ||
b9ecfdaa | 344 | new_tbl = bucket_table_alloc(ht, size, GFP_KERNEL); |
97defe1e | 345 | if (new_tbl == NULL) |
7e1e7763 TG |
346 | return -ENOMEM; |
347 | ||
b824478b HX |
348 | err = rhashtable_rehash_attach(ht, old_tbl, new_tbl); |
349 | if (err) | |
350 | bucket_table_free(new_tbl); | |
351 | ||
352 | return err; | |
7e1e7763 | 353 | } |
7e1e7763 | 354 | |
97defe1e TG |
355 | static void rht_deferred_worker(struct work_struct *work) |
356 | { | |
357 | struct rhashtable *ht; | |
358 | struct bucket_table *tbl; | |
b824478b | 359 | int err = 0; |
97defe1e | 360 | |
57699a40 | 361 | ht = container_of(work, struct rhashtable, run_work); |
97defe1e | 362 | mutex_lock(&ht->mutex); |
28134a53 | 363 | |
97defe1e | 364 | tbl = rht_dereference(ht->tbl, ht); |
b824478b | 365 | tbl = rhashtable_last_table(ht, tbl); |
97defe1e | 366 | |
a5b6846f | 367 | if (rht_grow_above_75(ht, tbl)) |
97defe1e | 368 | rhashtable_expand(ht); |
b5e2c150 | 369 | else if (ht->p.automatic_shrinking && rht_shrink_below_30(ht, tbl)) |
97defe1e | 370 | rhashtable_shrink(ht); |
b824478b HX |
371 | |
372 | err = rhashtable_rehash_table(ht); | |
373 | ||
97defe1e | 374 | mutex_unlock(&ht->mutex); |
b824478b HX |
375 | |
376 | if (err) | |
377 | schedule_work(&ht->run_work); | |
97defe1e TG |
378 | } |
379 | ||
ccd57b1b HX |
380 | static bool rhashtable_check_elasticity(struct rhashtable *ht, |
381 | struct bucket_table *tbl, | |
299e5c32 | 382 | unsigned int hash) |
ccd57b1b | 383 | { |
299e5c32 | 384 | unsigned int elasticity = ht->elasticity; |
ccd57b1b HX |
385 | struct rhash_head *head; |
386 | ||
387 | rht_for_each(head, tbl, hash) | |
388 | if (!--elasticity) | |
389 | return true; | |
390 | ||
391 | return false; | |
392 | } | |
393 | ||
3cf92222 HX |
394 | int rhashtable_insert_rehash(struct rhashtable *ht, |
395 | struct bucket_table *tbl) | |
ccd57b1b HX |
396 | { |
397 | struct bucket_table *old_tbl; | |
398 | struct bucket_table *new_tbl; | |
ccd57b1b HX |
399 | unsigned int size; |
400 | int err; | |
401 | ||
402 | old_tbl = rht_dereference_rcu(ht->tbl, ht); | |
ccd57b1b HX |
403 | |
404 | size = tbl->size; | |
405 | ||
3cf92222 HX |
406 | err = -EBUSY; |
407 | ||
ccd57b1b HX |
408 | if (rht_grow_above_75(ht, tbl)) |
409 | size *= 2; | |
a87b9ebf TG |
410 | /* Do not schedule more than one rehash */ |
411 | else if (old_tbl != tbl) | |
3cf92222 HX |
412 | goto fail; |
413 | ||
414 | err = -ENOMEM; | |
ccd57b1b HX |
415 | |
416 | new_tbl = bucket_table_alloc(ht, size, GFP_ATOMIC); | |
3cf92222 HX |
417 | if (new_tbl == NULL) |
418 | goto fail; | |
ccd57b1b HX |
419 | |
420 | err = rhashtable_rehash_attach(ht, tbl, new_tbl); | |
421 | if (err) { | |
422 | bucket_table_free(new_tbl); | |
423 | if (err == -EEXIST) | |
424 | err = 0; | |
425 | } else | |
426 | schedule_work(&ht->run_work); | |
427 | ||
428 | return err; | |
3cf92222 HX |
429 | |
430 | fail: | |
431 | /* Do not fail the insert if someone else did a rehash. */ | |
432 | if (likely(rcu_dereference_raw(tbl->future_tbl))) | |
433 | return 0; | |
434 | ||
435 | /* Schedule async rehash to retry allocation in process context. */ | |
436 | if (err == -ENOMEM) | |
437 | schedule_work(&ht->run_work); | |
438 | ||
439 | return err; | |
ccd57b1b HX |
440 | } |
441 | EXPORT_SYMBOL_GPL(rhashtable_insert_rehash); | |
442 | ||
3cf92222 HX |
443 | struct bucket_table *rhashtable_insert_slow(struct rhashtable *ht, |
444 | const void *key, | |
445 | struct rhash_head *obj, | |
446 | struct bucket_table *tbl) | |
02fd97c3 HX |
447 | { |
448 | struct rhash_head *head; | |
299e5c32 | 449 | unsigned int hash; |
ccd57b1b | 450 | int err; |
02fd97c3 | 451 | |
b824478b | 452 | tbl = rhashtable_last_table(ht, tbl); |
02fd97c3 HX |
453 | hash = head_hashfn(ht, tbl, obj); |
454 | spin_lock_nested(rht_bucket_lock(tbl, hash), SINGLE_DEPTH_NESTING); | |
455 | ||
ccd57b1b | 456 | err = -EEXIST; |
02fd97c3 HX |
457 | if (key && rhashtable_lookup_fast(ht, key, ht->p)) |
458 | goto exit; | |
459 | ||
07ee0722 HX |
460 | err = -E2BIG; |
461 | if (unlikely(rht_grow_above_max(ht, tbl))) | |
462 | goto exit; | |
463 | ||
ccd57b1b HX |
464 | err = -EAGAIN; |
465 | if (rhashtable_check_elasticity(ht, tbl, hash) || | |
466 | rht_grow_above_100(ht, tbl)) | |
467 | goto exit; | |
468 | ||
02fd97c3 HX |
469 | err = 0; |
470 | ||
471 | head = rht_dereference_bucket(tbl->buckets[hash], tbl, hash); | |
472 | ||
473 | RCU_INIT_POINTER(obj->next, head); | |
474 | ||
475 | rcu_assign_pointer(tbl->buckets[hash], obj); | |
476 | ||
477 | atomic_inc(&ht->nelems); | |
478 | ||
479 | exit: | |
480 | spin_unlock(rht_bucket_lock(tbl, hash)); | |
481 | ||
3cf92222 HX |
482 | if (err == 0) |
483 | return NULL; | |
484 | else if (err == -EAGAIN) | |
485 | return tbl; | |
486 | else | |
487 | return ERR_PTR(err); | |
02fd97c3 HX |
488 | } |
489 | EXPORT_SYMBOL_GPL(rhashtable_insert_slow); | |
490 | ||
f2dba9c6 HX |
491 | /** |
492 | * rhashtable_walk_init - Initialise an iterator | |
493 | * @ht: Table to walk over | |
494 | * @iter: Hash table Iterator | |
8f6fd83c | 495 | * @gfp: GFP flags for allocations |
f2dba9c6 HX |
496 | * |
497 | * This function prepares a hash table walk. | |
498 | * | |
499 | * Note that if you restart a walk after rhashtable_walk_stop you | |
500 | * may see the same object twice. Also, you may miss objects if | |
501 | * there are removals in between rhashtable_walk_stop and the next | |
502 | * call to rhashtable_walk_start. | |
503 | * | |
504 | * For a completely stable walk you should construct your own data | |
505 | * structure outside the hash table. | |
506 | * | |
507 | * This function may sleep so you must not call it from interrupt | |
508 | * context or with spin locks held. | |
509 | * | |
510 | * You must call rhashtable_walk_exit if this function returns | |
511 | * successfully. | |
512 | */ | |
8f6fd83c BC |
513 | int rhashtable_walk_init(struct rhashtable *ht, struct rhashtable_iter *iter, |
514 | gfp_t gfp) | |
f2dba9c6 HX |
515 | { |
516 | iter->ht = ht; | |
517 | iter->p = NULL; | |
518 | iter->slot = 0; | |
519 | iter->skip = 0; | |
520 | ||
8f6fd83c | 521 | iter->walker = kmalloc(sizeof(*iter->walker), gfp); |
f2dba9c6 HX |
522 | if (!iter->walker) |
523 | return -ENOMEM; | |
524 | ||
c6ff5268 | 525 | spin_lock(&ht->lock); |
179ccc0a HX |
526 | iter->walker->tbl = |
527 | rcu_dereference_protected(ht->tbl, lockdep_is_held(&ht->lock)); | |
eddee5ba | 528 | list_add(&iter->walker->list, &iter->walker->tbl->walkers); |
c6ff5268 | 529 | spin_unlock(&ht->lock); |
f2dba9c6 HX |
530 | |
531 | return 0; | |
532 | } | |
533 | EXPORT_SYMBOL_GPL(rhashtable_walk_init); | |
534 | ||
535 | /** | |
536 | * rhashtable_walk_exit - Free an iterator | |
537 | * @iter: Hash table Iterator | |
538 | * | |
539 | * This function frees resources allocated by rhashtable_walk_init. | |
540 | */ | |
541 | void rhashtable_walk_exit(struct rhashtable_iter *iter) | |
542 | { | |
c6ff5268 | 543 | spin_lock(&iter->ht->lock); |
eddee5ba HX |
544 | if (iter->walker->tbl) |
545 | list_del(&iter->walker->list); | |
c6ff5268 | 546 | spin_unlock(&iter->ht->lock); |
f2dba9c6 HX |
547 | kfree(iter->walker); |
548 | } | |
549 | EXPORT_SYMBOL_GPL(rhashtable_walk_exit); | |
550 | ||
551 | /** | |
552 | * rhashtable_walk_start - Start a hash table walk | |
553 | * @iter: Hash table iterator | |
554 | * | |
555 | * Start a hash table walk. Note that we take the RCU lock in all | |
556 | * cases including when we return an error. So you must always call | |
557 | * rhashtable_walk_stop to clean up. | |
558 | * | |
559 | * Returns zero if successful. | |
560 | * | |
561 | * Returns -EAGAIN if resize event occured. Note that the iterator | |
562 | * will rewind back to the beginning and you may use it immediately | |
563 | * by calling rhashtable_walk_next. | |
564 | */ | |
565 | int rhashtable_walk_start(struct rhashtable_iter *iter) | |
db4374f4 | 566 | __acquires(RCU) |
f2dba9c6 | 567 | { |
eddee5ba HX |
568 | struct rhashtable *ht = iter->ht; |
569 | ||
c6ff5268 | 570 | rcu_read_lock(); |
eddee5ba | 571 | |
c6ff5268 | 572 | spin_lock(&ht->lock); |
eddee5ba HX |
573 | if (iter->walker->tbl) |
574 | list_del(&iter->walker->list); | |
c6ff5268 | 575 | spin_unlock(&ht->lock); |
eddee5ba HX |
576 | |
577 | if (!iter->walker->tbl) { | |
578 | iter->walker->tbl = rht_dereference_rcu(ht->tbl, ht); | |
f2dba9c6 HX |
579 | return -EAGAIN; |
580 | } | |
581 | ||
582 | return 0; | |
583 | } | |
584 | EXPORT_SYMBOL_GPL(rhashtable_walk_start); | |
585 | ||
586 | /** | |
587 | * rhashtable_walk_next - Return the next object and advance the iterator | |
588 | * @iter: Hash table iterator | |
589 | * | |
590 | * Note that you must call rhashtable_walk_stop when you are finished | |
591 | * with the walk. | |
592 | * | |
593 | * Returns the next object or NULL when the end of the table is reached. | |
594 | * | |
595 | * Returns -EAGAIN if resize event occured. Note that the iterator | |
596 | * will rewind back to the beginning and you may continue to use it. | |
597 | */ | |
598 | void *rhashtable_walk_next(struct rhashtable_iter *iter) | |
599 | { | |
eddee5ba | 600 | struct bucket_table *tbl = iter->walker->tbl; |
f2dba9c6 HX |
601 | struct rhashtable *ht = iter->ht; |
602 | struct rhash_head *p = iter->p; | |
f2dba9c6 | 603 | |
f2dba9c6 HX |
604 | if (p) { |
605 | p = rht_dereference_bucket_rcu(p->next, tbl, iter->slot); | |
606 | goto next; | |
607 | } | |
608 | ||
609 | for (; iter->slot < tbl->size; iter->slot++) { | |
610 | int skip = iter->skip; | |
611 | ||
612 | rht_for_each_rcu(p, tbl, iter->slot) { | |
613 | if (!skip) | |
614 | break; | |
615 | skip--; | |
616 | } | |
617 | ||
618 | next: | |
619 | if (!rht_is_a_nulls(p)) { | |
620 | iter->skip++; | |
621 | iter->p = p; | |
c936a79f | 622 | return rht_obj(ht, p); |
f2dba9c6 HX |
623 | } |
624 | ||
625 | iter->skip = 0; | |
626 | } | |
627 | ||
142b942a PS |
628 | iter->p = NULL; |
629 | ||
d88252f9 HX |
630 | /* Ensure we see any new tables. */ |
631 | smp_rmb(); | |
632 | ||
c4db8848 HX |
633 | iter->walker->tbl = rht_dereference_rcu(tbl->future_tbl, ht); |
634 | if (iter->walker->tbl) { | |
f2dba9c6 HX |
635 | iter->slot = 0; |
636 | iter->skip = 0; | |
f2dba9c6 HX |
637 | return ERR_PTR(-EAGAIN); |
638 | } | |
639 | ||
c936a79f | 640 | return NULL; |
f2dba9c6 HX |
641 | } |
642 | EXPORT_SYMBOL_GPL(rhashtable_walk_next); | |
643 | ||
644 | /** | |
645 | * rhashtable_walk_stop - Finish a hash table walk | |
646 | * @iter: Hash table iterator | |
647 | * | |
648 | * Finish a hash table walk. | |
649 | */ | |
650 | void rhashtable_walk_stop(struct rhashtable_iter *iter) | |
db4374f4 | 651 | __releases(RCU) |
f2dba9c6 | 652 | { |
eddee5ba HX |
653 | struct rhashtable *ht; |
654 | struct bucket_table *tbl = iter->walker->tbl; | |
655 | ||
eddee5ba | 656 | if (!tbl) |
963ecbd4 | 657 | goto out; |
eddee5ba HX |
658 | |
659 | ht = iter->ht; | |
660 | ||
ba7c95ea | 661 | spin_lock(&ht->lock); |
c4db8848 | 662 | if (tbl->rehash < tbl->size) |
eddee5ba HX |
663 | list_add(&iter->walker->list, &tbl->walkers); |
664 | else | |
665 | iter->walker->tbl = NULL; | |
ba7c95ea | 666 | spin_unlock(&ht->lock); |
eddee5ba | 667 | |
f2dba9c6 | 668 | iter->p = NULL; |
963ecbd4 HX |
669 | |
670 | out: | |
671 | rcu_read_unlock(); | |
f2dba9c6 HX |
672 | } |
673 | EXPORT_SYMBOL_GPL(rhashtable_walk_stop); | |
674 | ||
488fb86e | 675 | static size_t rounded_hashtable_size(const struct rhashtable_params *params) |
7e1e7763 | 676 | { |
94000176 | 677 | return max(roundup_pow_of_two(params->nelem_hint * 4 / 3), |
e2e21c1c | 678 | (unsigned long)params->min_size); |
7e1e7763 TG |
679 | } |
680 | ||
31ccde2d HX |
681 | static u32 rhashtable_jhash2(const void *key, u32 length, u32 seed) |
682 | { | |
683 | return jhash2(key, length, seed); | |
684 | } | |
685 | ||
7e1e7763 TG |
686 | /** |
687 | * rhashtable_init - initialize a new hash table | |
688 | * @ht: hash table to be initialized | |
689 | * @params: configuration parameters | |
690 | * | |
691 | * Initializes a new hash table based on the provided configuration | |
692 | * parameters. A table can be configured either with a variable or | |
693 | * fixed length key: | |
694 | * | |
695 | * Configuration Example 1: Fixed length keys | |
696 | * struct test_obj { | |
697 | * int key; | |
698 | * void * my_member; | |
699 | * struct rhash_head node; | |
700 | * }; | |
701 | * | |
702 | * struct rhashtable_params params = { | |
703 | * .head_offset = offsetof(struct test_obj, node), | |
704 | * .key_offset = offsetof(struct test_obj, key), | |
705 | * .key_len = sizeof(int), | |
87545899 | 706 | * .hashfn = jhash, |
f89bd6f8 | 707 | * .nulls_base = (1U << RHT_BASE_SHIFT), |
7e1e7763 TG |
708 | * }; |
709 | * | |
710 | * Configuration Example 2: Variable length keys | |
711 | * struct test_obj { | |
712 | * [...] | |
713 | * struct rhash_head node; | |
714 | * }; | |
715 | * | |
49f7b33e | 716 | * u32 my_hash_fn(const void *data, u32 len, u32 seed) |
7e1e7763 TG |
717 | * { |
718 | * struct test_obj *obj = data; | |
719 | * | |
720 | * return [... hash ...]; | |
721 | * } | |
722 | * | |
723 | * struct rhashtable_params params = { | |
724 | * .head_offset = offsetof(struct test_obj, node), | |
87545899 | 725 | * .hashfn = jhash, |
7e1e7763 | 726 | * .obj_hashfn = my_hash_fn, |
7e1e7763 TG |
727 | * }; |
728 | */ | |
488fb86e HX |
729 | int rhashtable_init(struct rhashtable *ht, |
730 | const struct rhashtable_params *params) | |
7e1e7763 TG |
731 | { |
732 | struct bucket_table *tbl; | |
733 | size_t size; | |
734 | ||
735 | size = HASH_DEFAULT_SIZE; | |
736 | ||
31ccde2d | 737 | if ((!params->key_len && !params->obj_hashfn) || |
02fd97c3 | 738 | (params->obj_hashfn && !params->obj_cmpfn)) |
7e1e7763 TG |
739 | return -EINVAL; |
740 | ||
f89bd6f8 TG |
741 | if (params->nulls_base && params->nulls_base < (1U << RHT_BASE_SHIFT)) |
742 | return -EINVAL; | |
743 | ||
97defe1e TG |
744 | memset(ht, 0, sizeof(*ht)); |
745 | mutex_init(&ht->mutex); | |
ba7c95ea | 746 | spin_lock_init(&ht->lock); |
97defe1e TG |
747 | memcpy(&ht->p, params, sizeof(*params)); |
748 | ||
a998f712 TG |
749 | if (params->min_size) |
750 | ht->p.min_size = roundup_pow_of_two(params->min_size); | |
751 | ||
752 | if (params->max_size) | |
753 | ht->p.max_size = rounddown_pow_of_two(params->max_size); | |
754 | ||
07ee0722 HX |
755 | if (params->insecure_max_entries) |
756 | ht->p.insecure_max_entries = | |
757 | rounddown_pow_of_two(params->insecure_max_entries); | |
758 | else | |
759 | ht->p.insecure_max_entries = ht->p.max_size * 2; | |
760 | ||
488fb86e | 761 | ht->p.min_size = max(ht->p.min_size, HASH_MIN_SIZE); |
a998f712 | 762 | |
3a324606 HX |
763 | if (params->nelem_hint) |
764 | size = rounded_hashtable_size(&ht->p); | |
765 | ||
27ed44a5 HX |
766 | /* The maximum (not average) chain length grows with the |
767 | * size of the hash table, at a rate of (log N)/(log log N). | |
768 | * The value of 16 is selected so that even if the hash | |
769 | * table grew to 2^32 you would not expect the maximum | |
770 | * chain length to exceed it unless we are under attack | |
771 | * (or extremely unlucky). | |
772 | * | |
773 | * As this limit is only to detect attacks, we don't need | |
774 | * to set it to a lower value as you'd need the chain | |
775 | * length to vastly exceed 16 to have any real effect | |
776 | * on the system. | |
777 | */ | |
ccd57b1b HX |
778 | if (!params->insecure_elasticity) |
779 | ht->elasticity = 16; | |
780 | ||
97defe1e TG |
781 | if (params->locks_mul) |
782 | ht->p.locks_mul = roundup_pow_of_two(params->locks_mul); | |
783 | else | |
784 | ht->p.locks_mul = BUCKET_LOCKS_PER_CPU; | |
785 | ||
31ccde2d HX |
786 | ht->key_len = ht->p.key_len; |
787 | if (!params->hashfn) { | |
788 | ht->p.hashfn = jhash; | |
789 | ||
790 | if (!(ht->key_len & (sizeof(u32) - 1))) { | |
791 | ht->key_len /= sizeof(u32); | |
792 | ht->p.hashfn = rhashtable_jhash2; | |
793 | } | |
794 | } | |
795 | ||
b9ecfdaa | 796 | tbl = bucket_table_alloc(ht, size, GFP_KERNEL); |
7e1e7763 TG |
797 | if (tbl == NULL) |
798 | return -ENOMEM; | |
799 | ||
545a148e | 800 | atomic_set(&ht->nelems, 0); |
a5b6846f | 801 | |
7e1e7763 TG |
802 | RCU_INIT_POINTER(ht->tbl, tbl); |
803 | ||
4c4b52d9 | 804 | INIT_WORK(&ht->run_work, rht_deferred_worker); |
97defe1e | 805 | |
7e1e7763 TG |
806 | return 0; |
807 | } | |
808 | EXPORT_SYMBOL_GPL(rhashtable_init); | |
809 | ||
810 | /** | |
6b6f302c | 811 | * rhashtable_free_and_destroy - free elements and destroy hash table |
7e1e7763 | 812 | * @ht: the hash table to destroy |
6b6f302c TG |
813 | * @free_fn: callback to release resources of element |
814 | * @arg: pointer passed to free_fn | |
7e1e7763 | 815 | * |
6b6f302c TG |
816 | * Stops an eventual async resize. If defined, invokes free_fn for each |
817 | * element to releasal resources. Please note that RCU protected | |
818 | * readers may still be accessing the elements. Releasing of resources | |
819 | * must occur in a compatible manner. Then frees the bucket array. | |
820 | * | |
821 | * This function will eventually sleep to wait for an async resize | |
822 | * to complete. The caller is responsible that no further write operations | |
823 | * occurs in parallel. | |
7e1e7763 | 824 | */ |
6b6f302c TG |
825 | void rhashtable_free_and_destroy(struct rhashtable *ht, |
826 | void (*free_fn)(void *ptr, void *arg), | |
827 | void *arg) | |
7e1e7763 | 828 | { |
6b6f302c TG |
829 | const struct bucket_table *tbl; |
830 | unsigned int i; | |
97defe1e | 831 | |
4c4b52d9 | 832 | cancel_work_sync(&ht->run_work); |
97defe1e | 833 | |
57699a40 | 834 | mutex_lock(&ht->mutex); |
6b6f302c TG |
835 | tbl = rht_dereference(ht->tbl, ht); |
836 | if (free_fn) { | |
837 | for (i = 0; i < tbl->size; i++) { | |
838 | struct rhash_head *pos, *next; | |
839 | ||
840 | for (pos = rht_dereference(tbl->buckets[i], ht), | |
841 | next = !rht_is_a_nulls(pos) ? | |
842 | rht_dereference(pos->next, ht) : NULL; | |
843 | !rht_is_a_nulls(pos); | |
844 | pos = next, | |
845 | next = !rht_is_a_nulls(pos) ? | |
846 | rht_dereference(pos->next, ht) : NULL) | |
847 | free_fn(rht_obj(ht, pos), arg); | |
848 | } | |
849 | } | |
850 | ||
851 | bucket_table_free(tbl); | |
97defe1e | 852 | mutex_unlock(&ht->mutex); |
7e1e7763 | 853 | } |
6b6f302c TG |
854 | EXPORT_SYMBOL_GPL(rhashtable_free_and_destroy); |
855 | ||
856 | void rhashtable_destroy(struct rhashtable *ht) | |
857 | { | |
858 | return rhashtable_free_and_destroy(ht, NULL, NULL); | |
859 | } | |
7e1e7763 | 860 | EXPORT_SYMBOL_GPL(rhashtable_destroy); |