2 * Resizable, Scalable, Concurrent Hash Table
4 * Copyright (c) 2015 Herbert Xu <herbert@gondor.apana.org.au>
5 * Copyright (c) 2014-2015 Thomas Graf <tgraf@suug.ch>
6 * Copyright (c) 2008-2014 Patrick McHardy <kaber@trash.net>
8 * Code partially derived from nft_hash
9 * Rewritten with rehash code from br_multicast plus single list
10 * pointer as suggested by Josh Triplett
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.
17 #include <linux/atomic.h>
18 #include <linux/kernel.h>
19 #include <linux/init.h>
20 #include <linux/log2.h>
21 #include <linux/sched.h>
22 #include <linux/slab.h>
23 #include <linux/vmalloc.h>
25 #include <linux/jhash.h>
26 #include <linux/random.h>
27 #include <linux/rhashtable.h>
28 #include <linux/err.h>
29 #include <linux/export.h>
31 #define HASH_DEFAULT_SIZE 64UL
32 #define HASH_MIN_SIZE 4U
33 #define BUCKET_LOCKS_PER_CPU 32UL
35 static u32 head_hashfn(struct rhashtable *ht,
36 const struct bucket_table *tbl,
37 const struct rhash_head *he)
39 return rht_head_hashfn(ht, tbl, he, ht->p);
42 #ifdef CONFIG_PROVE_LOCKING
43 #define ASSERT_RHT_MUTEX(HT) BUG_ON(!lockdep_rht_mutex_is_held(HT))
45 int lockdep_rht_mutex_is_held(struct rhashtable *ht)
47 return (debug_locks) ? lockdep_is_held(&ht->mutex) : 1;
49 EXPORT_SYMBOL_GPL(lockdep_rht_mutex_is_held);
51 int lockdep_rht_bucket_is_held(const struct bucket_table *tbl, u32 hash)
53 spinlock_t *lock = rht_bucket_lock(tbl, hash);
55 return (debug_locks) ? lockdep_is_held(lock) : 1;
57 EXPORT_SYMBOL_GPL(lockdep_rht_bucket_is_held);
59 #define ASSERT_RHT_MUTEX(HT)
63 static int alloc_bucket_locks(struct rhashtable *ht, struct bucket_table *tbl,
67 #if defined(CONFIG_PROVE_LOCKING)
68 unsigned int nr_pcpus = 2;
70 unsigned int nr_pcpus = num_possible_cpus();
73 nr_pcpus = min_t(unsigned int, nr_pcpus, 64UL);
74 size = roundup_pow_of_two(nr_pcpus * ht->p.locks_mul);
76 /* Never allocate more than 0.5 locks per bucket */
77 size = min_t(unsigned int, size, tbl->size >> 1);
79 if (sizeof(spinlock_t) != 0) {
82 if (size * sizeof(spinlock_t) > PAGE_SIZE &&
84 tbl->locks = vmalloc(size * sizeof(spinlock_t));
86 if (gfp != GFP_KERNEL)
87 gfp |= __GFP_NOWARN | __GFP_NORETRY;
90 tbl->locks = kmalloc_array(size, sizeof(spinlock_t),
94 for (i = 0; i < size; i++)
95 spin_lock_init(&tbl->locks[i]);
97 tbl->locks_mask = size - 1;
102 static void bucket_table_free(const struct bucket_table *tbl)
110 static void bucket_table_free_rcu(struct rcu_head *head)
112 bucket_table_free(container_of(head, struct bucket_table, rcu));
115 static struct bucket_table *bucket_table_alloc(struct rhashtable *ht,
119 struct bucket_table *tbl = NULL;
123 size = sizeof(*tbl) + nbuckets * sizeof(tbl->buckets[0]);
124 if (size <= (PAGE_SIZE << PAGE_ALLOC_COSTLY_ORDER) ||
126 tbl = kzalloc(size, gfp | __GFP_NOWARN | __GFP_NORETRY);
127 if (tbl == NULL && gfp == GFP_KERNEL)
132 tbl->size = nbuckets;
134 if (alloc_bucket_locks(ht, tbl, gfp) < 0) {
135 bucket_table_free(tbl);
139 INIT_LIST_HEAD(&tbl->walkers);
141 get_random_bytes(&tbl->hash_rnd, sizeof(tbl->hash_rnd));
143 for (i = 0; i < nbuckets; i++)
144 INIT_RHT_NULLS_HEAD(tbl->buckets[i], ht, i);
149 static struct bucket_table *rhashtable_last_table(struct rhashtable *ht,
150 struct bucket_table *tbl)
152 struct bucket_table *new_tbl;
156 tbl = rht_dereference_rcu(tbl->future_tbl, ht);
162 static int rhashtable_rehash_one(struct rhashtable *ht, unsigned int old_hash)
164 struct bucket_table *old_tbl = rht_dereference(ht->tbl, ht);
165 struct bucket_table *new_tbl = rhashtable_last_table(ht,
166 rht_dereference_rcu(old_tbl->future_tbl, ht));
167 struct rhash_head __rcu **pprev = &old_tbl->buckets[old_hash];
169 struct rhash_head *head, *next, *entry;
170 spinlock_t *new_bucket_lock;
171 unsigned int new_hash;
173 rht_for_each(entry, old_tbl, old_hash) {
175 next = rht_dereference_bucket(entry->next, old_tbl, old_hash);
177 if (rht_is_a_nulls(next))
180 pprev = &entry->next;
186 new_hash = head_hashfn(ht, new_tbl, entry);
188 new_bucket_lock = rht_bucket_lock(new_tbl, new_hash);
190 spin_lock_nested(new_bucket_lock, SINGLE_DEPTH_NESTING);
191 head = rht_dereference_bucket(new_tbl->buckets[new_hash],
194 RCU_INIT_POINTER(entry->next, head);
196 rcu_assign_pointer(new_tbl->buckets[new_hash], entry);
197 spin_unlock(new_bucket_lock);
199 rcu_assign_pointer(*pprev, next);
205 static void rhashtable_rehash_chain(struct rhashtable *ht,
206 unsigned int old_hash)
208 struct bucket_table *old_tbl = rht_dereference(ht->tbl, ht);
209 spinlock_t *old_bucket_lock;
211 old_bucket_lock = rht_bucket_lock(old_tbl, old_hash);
213 spin_lock_bh(old_bucket_lock);
214 while (!rhashtable_rehash_one(ht, old_hash))
217 spin_unlock_bh(old_bucket_lock);
220 static int rhashtable_rehash_attach(struct rhashtable *ht,
221 struct bucket_table *old_tbl,
222 struct bucket_table *new_tbl)
224 /* Protect future_tbl using the first bucket lock. */
225 spin_lock_bh(old_tbl->locks);
227 /* Did somebody beat us to it? */
228 if (rcu_access_pointer(old_tbl->future_tbl)) {
229 spin_unlock_bh(old_tbl->locks);
233 /* Make insertions go into the new, empty table right away. Deletions
234 * and lookups will be attempted in both tables until we synchronize.
236 rcu_assign_pointer(old_tbl->future_tbl, new_tbl);
238 spin_unlock_bh(old_tbl->locks);
243 static int rhashtable_rehash_table(struct rhashtable *ht)
245 struct bucket_table *old_tbl = rht_dereference(ht->tbl, ht);
246 struct bucket_table *new_tbl;
247 struct rhashtable_walker *walker;
248 unsigned int old_hash;
250 new_tbl = rht_dereference(old_tbl->future_tbl, ht);
254 for (old_hash = 0; old_hash < old_tbl->size; old_hash++)
255 rhashtable_rehash_chain(ht, old_hash);
257 /* Publish the new table pointer. */
258 rcu_assign_pointer(ht->tbl, new_tbl);
260 spin_lock(&ht->lock);
261 list_for_each_entry(walker, &old_tbl->walkers, list)
263 spin_unlock(&ht->lock);
265 /* Wait for readers. All new readers will see the new
266 * table, and thus no references to the old table will
269 call_rcu(&old_tbl->rcu, bucket_table_free_rcu);
271 return rht_dereference(new_tbl->future_tbl, ht) ? -EAGAIN : 0;
275 * rhashtable_expand - Expand hash table while allowing concurrent lookups
276 * @ht: the hash table to expand
278 * A secondary bucket array is allocated and the hash entries are migrated.
280 * This function may only be called in a context where it is safe to call
281 * synchronize_rcu(), e.g. not within a rcu_read_lock() section.
283 * The caller must ensure that no concurrent resizing occurs by holding
286 * It is valid to have concurrent insertions and deletions protected by per
287 * bucket locks or concurrent RCU protected lookups and traversals.
289 static int rhashtable_expand(struct rhashtable *ht)
291 struct bucket_table *new_tbl, *old_tbl = rht_dereference(ht->tbl, ht);
294 ASSERT_RHT_MUTEX(ht);
296 old_tbl = rhashtable_last_table(ht, old_tbl);
298 new_tbl = bucket_table_alloc(ht, old_tbl->size * 2, GFP_KERNEL);
302 err = rhashtable_rehash_attach(ht, old_tbl, new_tbl);
304 bucket_table_free(new_tbl);
310 * rhashtable_shrink - Shrink hash table while allowing concurrent lookups
311 * @ht: the hash table to shrink
313 * This function shrinks the hash table to fit, i.e., the smallest
314 * size would not cause it to expand right away automatically.
316 * The caller must ensure that no concurrent resizing occurs by holding
319 * The caller must ensure that no concurrent table mutations take place.
320 * It is however valid to have concurrent lookups if they are RCU protected.
322 * It is valid to have concurrent insertions and deletions protected by per
323 * bucket locks or concurrent RCU protected lookups and traversals.
325 static int rhashtable_shrink(struct rhashtable *ht)
327 struct bucket_table *new_tbl, *old_tbl = rht_dereference(ht->tbl, ht);
328 unsigned int nelems = atomic_read(&ht->nelems);
329 unsigned int size = 0;
332 ASSERT_RHT_MUTEX(ht);
335 size = roundup_pow_of_two(nelems * 3 / 2);
336 if (size < ht->p.min_size)
337 size = ht->p.min_size;
339 if (old_tbl->size <= size)
342 if (rht_dereference(old_tbl->future_tbl, ht))
345 new_tbl = bucket_table_alloc(ht, size, GFP_KERNEL);
349 err = rhashtable_rehash_attach(ht, old_tbl, new_tbl);
351 bucket_table_free(new_tbl);
356 static void rht_deferred_worker(struct work_struct *work)
358 struct rhashtable *ht;
359 struct bucket_table *tbl;
362 ht = container_of(work, struct rhashtable, run_work);
363 mutex_lock(&ht->mutex);
365 tbl = rht_dereference(ht->tbl, ht);
366 tbl = rhashtable_last_table(ht, tbl);
368 if (rht_grow_above_75(ht, tbl))
369 rhashtable_expand(ht);
370 else if (ht->p.automatic_shrinking && rht_shrink_below_30(ht, tbl))
371 rhashtable_shrink(ht);
373 err = rhashtable_rehash_table(ht);
375 mutex_unlock(&ht->mutex);
378 schedule_work(&ht->run_work);
381 static int rhashtable_insert_rehash(struct rhashtable *ht,
382 struct bucket_table *tbl)
384 struct bucket_table *old_tbl;
385 struct bucket_table *new_tbl;
389 old_tbl = rht_dereference_rcu(ht->tbl, ht);
395 if (rht_grow_above_75(ht, tbl))
397 /* Do not schedule more than one rehash */
398 else if (old_tbl != tbl)
403 new_tbl = bucket_table_alloc(ht, size, GFP_ATOMIC);
407 err = rhashtable_rehash_attach(ht, tbl, new_tbl);
409 bucket_table_free(new_tbl);
413 schedule_work(&ht->run_work);
418 /* Do not fail the insert if someone else did a rehash. */
419 if (likely(rcu_dereference_raw(tbl->future_tbl)))
422 /* Schedule async rehash to retry allocation in process context. */
424 schedule_work(&ht->run_work);
429 static void *rhashtable_lookup_one(struct rhashtable *ht,
430 struct bucket_table *tbl, unsigned int hash,
431 const void *key, struct rhash_head *obj)
433 struct rhashtable_compare_arg arg = {
437 struct rhash_head __rcu **pprev;
438 struct rhash_head *head;
441 elasticity = ht->elasticity;
442 pprev = &tbl->buckets[hash];
443 rht_for_each(head, tbl, hash) {
444 struct rhlist_head *list;
445 struct rhlist_head *plist;
450 ht->p.obj_cmpfn(&arg, rht_obj(ht, head)) :
451 rhashtable_compare(&arg, rht_obj(ht, head)))) {
457 return rht_obj(ht, head);
459 list = container_of(obj, struct rhlist_head, rhead);
460 plist = container_of(head, struct rhlist_head, rhead);
462 RCU_INIT_POINTER(list->next, plist);
463 head = rht_dereference_bucket(head->next, tbl, hash);
464 RCU_INIT_POINTER(list->rhead.next, head);
465 rcu_assign_pointer(*pprev, obj);
471 return ERR_PTR(-EAGAIN);
473 return ERR_PTR(-ENOENT);
476 static struct bucket_table *rhashtable_insert_one(struct rhashtable *ht,
477 struct bucket_table *tbl,
479 struct rhash_head *obj,
482 struct bucket_table *new_tbl;
483 struct rhash_head *head;
485 if (!IS_ERR_OR_NULL(data))
486 return ERR_PTR(-EEXIST);
488 if (PTR_ERR(data) != -EAGAIN && PTR_ERR(data) != -ENOENT)
489 return ERR_CAST(data);
491 new_tbl = rcu_dereference(tbl->future_tbl);
495 if (PTR_ERR(data) != -ENOENT)
496 return ERR_CAST(data);
498 if (unlikely(rht_grow_above_max(ht, tbl)))
499 return ERR_PTR(-E2BIG);
501 if (unlikely(rht_grow_above_100(ht, tbl)))
502 return ERR_PTR(-EAGAIN);
504 head = rht_dereference_bucket(tbl->buckets[hash], tbl, hash);
506 RCU_INIT_POINTER(obj->next, head);
508 struct rhlist_head *list;
510 list = container_of(obj, struct rhlist_head, rhead);
511 RCU_INIT_POINTER(list->next, NULL);
514 rcu_assign_pointer(tbl->buckets[hash], obj);
516 atomic_inc(&ht->nelems);
517 if (rht_grow_above_75(ht, tbl))
518 schedule_work(&ht->run_work);
523 static void *rhashtable_try_insert(struct rhashtable *ht, const void *key,
524 struct rhash_head *obj)
526 struct bucket_table *new_tbl;
527 struct bucket_table *tbl;
532 tbl = rcu_dereference(ht->tbl);
534 /* All insertions must grab the oldest table containing
535 * the hashed bucket that is yet to be rehashed.
538 hash = rht_head_hashfn(ht, tbl, obj, ht->p);
539 lock = rht_bucket_lock(tbl, hash);
542 if (tbl->rehash <= hash)
545 spin_unlock_bh(lock);
546 tbl = rcu_dereference(tbl->future_tbl);
549 data = rhashtable_lookup_one(ht, tbl, hash, key, obj);
550 new_tbl = rhashtable_insert_one(ht, tbl, hash, obj, data);
551 if (PTR_ERR(new_tbl) != -EEXIST)
552 data = ERR_CAST(new_tbl);
554 while (!IS_ERR_OR_NULL(new_tbl)) {
556 hash = rht_head_hashfn(ht, tbl, obj, ht->p);
557 spin_lock_nested(rht_bucket_lock(tbl, hash),
558 SINGLE_DEPTH_NESTING);
560 data = rhashtable_lookup_one(ht, tbl, hash, key, obj);
561 new_tbl = rhashtable_insert_one(ht, tbl, hash, obj, data);
562 if (PTR_ERR(new_tbl) != -EEXIST)
563 data = ERR_CAST(new_tbl);
565 spin_unlock(rht_bucket_lock(tbl, hash));
568 spin_unlock_bh(lock);
570 if (PTR_ERR(data) == -EAGAIN)
571 data = ERR_PTR(rhashtable_insert_rehash(ht, tbl) ?:
577 void *rhashtable_insert_slow(struct rhashtable *ht, const void *key,
578 struct rhash_head *obj)
584 data = rhashtable_try_insert(ht, key, obj);
586 } while (PTR_ERR(data) == -EAGAIN);
590 EXPORT_SYMBOL_GPL(rhashtable_insert_slow);
593 * rhashtable_walk_enter - Initialise an iterator
594 * @ht: Table to walk over
595 * @iter: Hash table Iterator
597 * This function prepares a hash table walk.
599 * Note that if you restart a walk after rhashtable_walk_stop you
600 * may see the same object twice. Also, you may miss objects if
601 * there are removals in between rhashtable_walk_stop and the next
602 * call to rhashtable_walk_start.
604 * For a completely stable walk you should construct your own data
605 * structure outside the hash table.
607 * This function may sleep so you must not call it from interrupt
608 * context or with spin locks held.
610 * You must call rhashtable_walk_exit after this function returns.
612 void rhashtable_walk_enter(struct rhashtable *ht, struct rhashtable_iter *iter)
619 spin_lock(&ht->lock);
621 rcu_dereference_protected(ht->tbl, lockdep_is_held(&ht->lock));
622 list_add(&iter->walker.list, &iter->walker.tbl->walkers);
623 spin_unlock(&ht->lock);
625 EXPORT_SYMBOL_GPL(rhashtable_walk_enter);
628 * rhashtable_walk_exit - Free an iterator
629 * @iter: Hash table Iterator
631 * This function frees resources allocated by rhashtable_walk_init.
633 void rhashtable_walk_exit(struct rhashtable_iter *iter)
635 spin_lock(&iter->ht->lock);
636 if (iter->walker.tbl)
637 list_del(&iter->walker.list);
638 spin_unlock(&iter->ht->lock);
640 EXPORT_SYMBOL_GPL(rhashtable_walk_exit);
643 * rhashtable_walk_start - Start a hash table walk
644 * @iter: Hash table iterator
646 * Start a hash table walk. Note that we take the RCU lock in all
647 * cases including when we return an error. So you must always call
648 * rhashtable_walk_stop to clean up.
650 * Returns zero if successful.
652 * Returns -EAGAIN if resize event occured. Note that the iterator
653 * will rewind back to the beginning and you may use it immediately
654 * by calling rhashtable_walk_next.
656 int rhashtable_walk_start(struct rhashtable_iter *iter)
659 struct rhashtable *ht = iter->ht;
663 spin_lock(&ht->lock);
664 if (iter->walker.tbl)
665 list_del(&iter->walker.list);
666 spin_unlock(&ht->lock);
668 if (!iter->walker.tbl) {
669 iter->walker.tbl = rht_dereference_rcu(ht->tbl, ht);
675 EXPORT_SYMBOL_GPL(rhashtable_walk_start);
678 * rhashtable_walk_next - Return the next object and advance the iterator
679 * @iter: Hash table iterator
681 * Note that you must call rhashtable_walk_stop when you are finished
684 * Returns the next object or NULL when the end of the table is reached.
686 * Returns -EAGAIN if resize event occured. Note that the iterator
687 * will rewind back to the beginning and you may continue to use it.
689 void *rhashtable_walk_next(struct rhashtable_iter *iter)
691 struct bucket_table *tbl = iter->walker.tbl;
692 struct rhlist_head *list = iter->list;
693 struct rhashtable *ht = iter->ht;
694 struct rhash_head *p = iter->p;
695 bool rhlist = ht->rhlist;
698 if (!rhlist || !(list = rcu_dereference(list->next))) {
699 p = rcu_dereference(p->next);
700 list = container_of(p, struct rhlist_head, rhead);
705 for (; iter->slot < tbl->size; iter->slot++) {
706 int skip = iter->skip;
708 rht_for_each_rcu(p, tbl, iter->slot) {
710 list = container_of(p, struct rhlist_head,
716 list = rcu_dereference(list->next);
727 if (!rht_is_a_nulls(p)) {
731 return rht_obj(ht, rhlist ? &list->rhead : p);
739 /* Ensure we see any new tables. */
742 iter->walker.tbl = rht_dereference_rcu(tbl->future_tbl, ht);
743 if (iter->walker.tbl) {
746 return ERR_PTR(-EAGAIN);
751 EXPORT_SYMBOL_GPL(rhashtable_walk_next);
754 * rhashtable_walk_stop - Finish a hash table walk
755 * @iter: Hash table iterator
757 * Finish a hash table walk.
759 void rhashtable_walk_stop(struct rhashtable_iter *iter)
762 struct rhashtable *ht;
763 struct bucket_table *tbl = iter->walker.tbl;
770 spin_lock(&ht->lock);
771 if (tbl->rehash < tbl->size)
772 list_add(&iter->walker.list, &tbl->walkers);
774 iter->walker.tbl = NULL;
775 spin_unlock(&ht->lock);
782 EXPORT_SYMBOL_GPL(rhashtable_walk_stop);
784 static size_t rounded_hashtable_size(const struct rhashtable_params *params)
786 return max(roundup_pow_of_two(params->nelem_hint * 4 / 3),
787 (unsigned long)params->min_size);
790 static u32 rhashtable_jhash2(const void *key, u32 length, u32 seed)
792 return jhash2(key, length, seed);
796 * rhashtable_init - initialize a new hash table
797 * @ht: hash table to be initialized
798 * @params: configuration parameters
800 * Initializes a new hash table based on the provided configuration
801 * parameters. A table can be configured either with a variable or
804 * Configuration Example 1: Fixed length keys
808 * struct rhash_head node;
811 * struct rhashtable_params params = {
812 * .head_offset = offsetof(struct test_obj, node),
813 * .key_offset = offsetof(struct test_obj, key),
814 * .key_len = sizeof(int),
816 * .nulls_base = (1U << RHT_BASE_SHIFT),
819 * Configuration Example 2: Variable length keys
822 * struct rhash_head node;
825 * u32 my_hash_fn(const void *data, u32 len, u32 seed)
827 * struct test_obj *obj = data;
829 * return [... hash ...];
832 * struct rhashtable_params params = {
833 * .head_offset = offsetof(struct test_obj, node),
835 * .obj_hashfn = my_hash_fn,
838 int rhashtable_init(struct rhashtable *ht,
839 const struct rhashtable_params *params)
841 struct bucket_table *tbl;
844 size = HASH_DEFAULT_SIZE;
846 if ((!params->key_len && !params->obj_hashfn) ||
847 (params->obj_hashfn && !params->obj_cmpfn))
850 if (params->nulls_base && params->nulls_base < (1U << RHT_BASE_SHIFT))
853 memset(ht, 0, sizeof(*ht));
854 mutex_init(&ht->mutex);
855 spin_lock_init(&ht->lock);
856 memcpy(&ht->p, params, sizeof(*params));
858 if (params->min_size)
859 ht->p.min_size = roundup_pow_of_two(params->min_size);
861 if (params->max_size)
862 ht->p.max_size = rounddown_pow_of_two(params->max_size);
864 if (params->insecure_max_entries)
865 ht->p.insecure_max_entries =
866 rounddown_pow_of_two(params->insecure_max_entries);
868 ht->p.insecure_max_entries = ht->p.max_size * 2;
870 ht->p.min_size = max(ht->p.min_size, HASH_MIN_SIZE);
872 if (params->nelem_hint)
873 size = rounded_hashtable_size(&ht->p);
875 /* The maximum (not average) chain length grows with the
876 * size of the hash table, at a rate of (log N)/(log log N).
877 * The value of 16 is selected so that even if the hash
878 * table grew to 2^32 you would not expect the maximum
879 * chain length to exceed it unless we are under attack
880 * (or extremely unlucky).
882 * As this limit is only to detect attacks, we don't need
883 * to set it to a lower value as you'd need the chain
884 * length to vastly exceed 16 to have any real effect
887 if (!params->insecure_elasticity)
890 if (params->locks_mul)
891 ht->p.locks_mul = roundup_pow_of_two(params->locks_mul);
893 ht->p.locks_mul = BUCKET_LOCKS_PER_CPU;
895 ht->key_len = ht->p.key_len;
896 if (!params->hashfn) {
897 ht->p.hashfn = jhash;
899 if (!(ht->key_len & (sizeof(u32) - 1))) {
900 ht->key_len /= sizeof(u32);
901 ht->p.hashfn = rhashtable_jhash2;
905 tbl = bucket_table_alloc(ht, size, GFP_KERNEL);
909 atomic_set(&ht->nelems, 0);
911 RCU_INIT_POINTER(ht->tbl, tbl);
913 INIT_WORK(&ht->run_work, rht_deferred_worker);
917 EXPORT_SYMBOL_GPL(rhashtable_init);
920 * rhltable_init - initialize a new hash list table
921 * @hlt: hash list table to be initialized
922 * @params: configuration parameters
924 * Initializes a new hash list table.
926 * See documentation for rhashtable_init.
928 int rhltable_init(struct rhltable *hlt, const struct rhashtable_params *params)
932 /* No rhlist NULLs marking for now. */
933 if (params->nulls_base)
936 err = rhashtable_init(&hlt->ht, params);
937 hlt->ht.rhlist = true;
940 EXPORT_SYMBOL_GPL(rhltable_init);
942 static void rhashtable_free_one(struct rhashtable *ht, struct rhash_head *obj,
943 void (*free_fn)(void *ptr, void *arg),
946 struct rhlist_head *list;
949 free_fn(rht_obj(ht, obj), arg);
953 list = container_of(obj, struct rhlist_head, rhead);
956 list = rht_dereference(list->next, ht);
957 free_fn(rht_obj(ht, obj), arg);
962 * rhashtable_free_and_destroy - free elements and destroy hash table
963 * @ht: the hash table to destroy
964 * @free_fn: callback to release resources of element
965 * @arg: pointer passed to free_fn
967 * Stops an eventual async resize. If defined, invokes free_fn for each
968 * element to releasal resources. Please note that RCU protected
969 * readers may still be accessing the elements. Releasing of resources
970 * must occur in a compatible manner. Then frees the bucket array.
972 * This function will eventually sleep to wait for an async resize
973 * to complete. The caller is responsible that no further write operations
974 * occurs in parallel.
976 void rhashtable_free_and_destroy(struct rhashtable *ht,
977 void (*free_fn)(void *ptr, void *arg),
980 const struct bucket_table *tbl;
983 cancel_work_sync(&ht->run_work);
985 mutex_lock(&ht->mutex);
986 tbl = rht_dereference(ht->tbl, ht);
988 for (i = 0; i < tbl->size; i++) {
989 struct rhash_head *pos, *next;
991 for (pos = rht_dereference(tbl->buckets[i], ht),
992 next = !rht_is_a_nulls(pos) ?
993 rht_dereference(pos->next, ht) : NULL;
994 !rht_is_a_nulls(pos);
996 next = !rht_is_a_nulls(pos) ?
997 rht_dereference(pos->next, ht) : NULL)
998 rhashtable_free_one(ht, pos, free_fn, arg);
1002 bucket_table_free(tbl);
1003 mutex_unlock(&ht->mutex);
1005 EXPORT_SYMBOL_GPL(rhashtable_free_and_destroy);
1007 void rhashtable_destroy(struct rhashtable *ht)
1009 return rhashtable_free_and_destroy(ht, NULL, NULL);
1011 EXPORT_SYMBOL_GPL(rhashtable_destroy);