lib/rhashtable.c

   1 /*
   2  * Resizable, Scalable, Concurrent Hash Table
   3  *
   4  * Copyright (c) 2014-2015 Thomas Graf <tgraf@suug.ch>
   5  * Copyright (c) 2008-2014 Patrick McHardy <kaber@trash.net>
   6  *
   7  * Based on the following paper:
   8  * https://www.usenix.org/legacy/event/atc11/tech/final_files/Triplett.pdf
   9  *
  10  * Code partially derived from nft_hash
  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
  17 #include <linux/kernel.h>
  18 #include <linux/init.h>
  19 #include <linux/log2.h>
  20 #include <linux/sched.h>
  21 #include <linux/slab.h>
  22 #include <linux/vmalloc.h>
  23 #include <linux/mm.h>
  24 #include <linux/jhash.h>
  25 #include <linux/random.h>
  26 #include <linux/rhashtable.h>
  27 #include <linux/err.h>
  28
  29 #define HASH_DEFAULT_SIZE       64UL
  30 #define HASH_MIN_SIZE           4UL
  31 #define BUCKET_LOCKS_PER_CPU   128UL
  32
  33 /* Base bits plus 1 bit for nulls marker */
  34 #define HASH_RESERVED_SPACE     (RHT_BASE_BITS + 1)
  35
  36 enum {
  37         RHT_LOCK_NORMAL,
  38         RHT_LOCK_NESTED,
  39 };
  40
  41 /* The bucket lock is selected based on the hash and protects mutations
  42  * on a group of hash buckets.
  43  *
  44  * A maximum of tbl->size/2 bucket locks is allocated. This ensures that
  45  * a single lock always covers both buckets which may both contains
  46  * entries which link to the same bucket of the old table during resizing.
  47  * This allows to simplify the locking as locking the bucket in both
  48  * tables during resize always guarantee protection.
  49  *
  50  * IMPORTANT: When holding the bucket lock of both the old and new table
  51  * during expansions and shrinking, the old bucket lock must always be
  52  * acquired first.
  53  */
  54 static spinlock_t *bucket_lock(const struct bucket_table *tbl, u32 hash)
  55 {
  56         return &tbl->locks[hash & tbl->locks_mask];
  57 }
  58
  59 static void *rht_obj(const struct rhashtable *ht, const struct rhash_head *he)
  60 {
  61         return (void *) he - ht->p.head_offset;
  62 }
  63
  64 static u32 rht_bucket_index(const struct bucket_table *tbl, u32 hash)
  65 {
  66         return (hash >> HASH_RESERVED_SPACE) & (tbl->size - 1);
  67 }
  68
  69 static u32 key_hashfn(struct rhashtable *ht, const struct bucket_table *tbl,
  70                       const void *key)
  71 {
  72         return rht_bucket_index(tbl, ht->p.hashfn(key, ht->p.key_len,
  73                                                   tbl->hash_rnd));
  74 }
  75
  76 static u32 head_hashfn(struct rhashtable *ht,
  77                        const struct bucket_table *tbl,
  78                        const struct rhash_head *he)
  79 {
  80         const char *ptr = rht_obj(ht, he);
  81
  82         return likely(ht->p.key_len) ?
  83                key_hashfn(ht, tbl, ptr + ht->p.key_offset) :
  84                rht_bucket_index(tbl, ht->p.obj_hashfn(ptr, tbl->hash_rnd));
  85 }
  86
  87 #ifdef CONFIG_PROVE_LOCKING
  88 #define ASSERT_RHT_MUTEX(HT) BUG_ON(!lockdep_rht_mutex_is_held(HT))
  89
  90 int lockdep_rht_mutex_is_held(struct rhashtable *ht)
  91 {
  92         return (debug_locks) ? lockdep_is_held(&ht->mutex) : 1;
  93 }
  94 EXPORT_SYMBOL_GPL(lockdep_rht_mutex_is_held);
  95
  96 int lockdep_rht_bucket_is_held(const struct bucket_table *tbl, u32 hash)
  97 {
  98         spinlock_t *lock = bucket_lock(tbl, hash);
  99
 100         return (debug_locks) ? lockdep_is_held(lock) : 1;
 101 }
 102 EXPORT_SYMBOL_GPL(lockdep_rht_bucket_is_held);
 103 #else
 104 #define ASSERT_RHT_MUTEX(HT)
 105 #endif
 106
 107
 108 static int alloc_bucket_locks(struct rhashtable *ht, struct bucket_table *tbl)
 109 {
 110         unsigned int i, size;
 111 #if defined(CONFIG_PROVE_LOCKING)
 112         unsigned int nr_pcpus = 2;
 113 #else
 114         unsigned int nr_pcpus = num_possible_cpus();
 115 #endif
 116
 117         nr_pcpus = min_t(unsigned int, nr_pcpus, 32UL);
 118         size = roundup_pow_of_two(nr_pcpus * ht->p.locks_mul);
 119
 120         /* Never allocate more than 0.5 locks per bucket */
 121         size = min_t(unsigned int, size, tbl->size >> 1);
 122
 123         if (sizeof(spinlock_t) != 0) {
 124 #ifdef CONFIG_NUMA
 125                 if (size * sizeof(spinlock_t) > PAGE_SIZE)
 126                         tbl->locks = vmalloc(size * sizeof(spinlock_t));
 127                 else
 128 #endif
 129                 tbl->locks = kmalloc_array(size, sizeof(spinlock_t),
 130                                            GFP_KERNEL);
 131                 if (!tbl->locks)
 132                         return -ENOMEM;
 133                 for (i = 0; i < size; i++)
 134                         spin_lock_init(&tbl->locks[i]);
 135         }
 136         tbl->locks_mask = size - 1;
 137
 138         return 0;
 139 }
 140
 141 static void bucket_table_free(const struct bucket_table *tbl)
 142 {
 143         if (tbl)
 144                 kvfree(tbl->locks);
 145
 146         kvfree(tbl);
 147 }
 148
 149 static struct bucket_table *bucket_table_alloc(struct rhashtable *ht,
 150                                                size_t nbuckets, u32 hash_rnd)
 151 {
 152         struct bucket_table *tbl = NULL;
 153         size_t size;
 154         int i;
 155
 156         size = sizeof(*tbl) + nbuckets * sizeof(tbl->buckets[0]);
 157         if (size <= (PAGE_SIZE << PAGE_ALLOC_COSTLY_ORDER))
 158                 tbl = kzalloc(size, GFP_KERNEL | __GFP_NOWARN | __GFP_NORETRY);
 159         if (tbl == NULL)
 160                 tbl = vzalloc(size);
 161         if (tbl == NULL)
 162                 return NULL;
 163
 164         tbl->size = nbuckets;
 165         tbl->shift = ilog2(nbuckets);
 166         tbl->hash_rnd = hash_rnd;
 167
 168         if (alloc_bucket_locks(ht, tbl) < 0) {
 169                 bucket_table_free(tbl);
 170                 return NULL;
 171         }
 172
 173         INIT_LIST_HEAD(&tbl->walkers);
 174
 175         for (i = 0; i < nbuckets; i++)
 176                 INIT_RHT_NULLS_HEAD(tbl->buckets[i], ht, i);
 177
 178         return tbl;
 179 }
 180
 181 /**
 182  * rht_grow_above_75 - returns true if nelems > 0.75 * table-size
 183  * @ht:         hash table
 184  * @tbl:        current table
 185  */
 186 static bool rht_grow_above_75(const struct rhashtable *ht,
 187                               const struct bucket_table *tbl)
 188 {
 189         /* Expand table when exceeding 75% load */
 190         return atomic_read(&ht->nelems) > (tbl->size / 4 * 3) &&
 191                (!ht->p.max_shift || tbl->shift < ht->p.max_shift);
 192 }
 193
 194 /**
 195  * rht_shrink_below_30 - returns true if nelems < 0.3 * table-size
 196  * @ht:         hash table
 197  * @tbl:        current table
 198  */
 199 static bool rht_shrink_below_30(const struct rhashtable *ht,
 200                                 const struct bucket_table *tbl)
 201 {
 202         /* Shrink table beneath 30% load */
 203         return atomic_read(&ht->nelems) < (tbl->size * 3 / 10) &&
 204                tbl->shift > ht->p.min_shift;
 205 }
 206
 207 static int rhashtable_rehash_one(struct rhashtable *ht, unsigned old_hash)
 208 {
 209         struct bucket_table *new_tbl = rht_dereference(ht->future_tbl, ht);
 210         struct bucket_table *old_tbl = rht_dereference(ht->tbl, ht);
 211         struct rhash_head __rcu **pprev = &old_tbl->buckets[old_hash];
 212         int err = -ENOENT;
 213         struct rhash_head *head, *next, *entry;
 214         spinlock_t *new_bucket_lock;
 215         unsigned new_hash;
 216
 217         rht_for_each(entry, old_tbl, old_hash) {
 218                 err = 0;
 219                 next = rht_dereference_bucket(entry->next, old_tbl, old_hash);
 220
 221                 if (rht_is_a_nulls(next))
 222                         break;
 223
 224                 pprev = &entry->next;
 225         }
 226
 227         if (err)
 228                 goto out;
 229
 230         new_hash = head_hashfn(ht, new_tbl, entry);
 231
 232         new_bucket_lock = bucket_lock(new_tbl, new_hash);
 233
 234         spin_lock_nested(new_bucket_lock, RHT_LOCK_NESTED);
 235         head = rht_dereference_bucket(new_tbl->buckets[new_hash],
 236                                       new_tbl, new_hash);
 237
 238         if (rht_is_a_nulls(head))
 239                 INIT_RHT_NULLS_HEAD(entry->next, ht, new_hash);
 240         else
 241                 RCU_INIT_POINTER(entry->next, head);
 242
 243         rcu_assign_pointer(new_tbl->buckets[new_hash], entry);
 244         spin_unlock(new_bucket_lock);
 245
 246         rcu_assign_pointer(*pprev, next);
 247
 248 out:
 249         return err;
 250 }
 251
 252 static void rhashtable_rehash_chain(struct rhashtable *ht, unsigned old_hash)
 253 {
 254         struct bucket_table *old_tbl = rht_dereference(ht->tbl, ht);
 255         spinlock_t *old_bucket_lock;
 256
 257         old_bucket_lock = bucket_lock(old_tbl, old_hash);
 258
 259         spin_lock_bh(old_bucket_lock);
 260         while (!rhashtable_rehash_one(ht, old_hash))
 261                 ;
 262         spin_unlock_bh(old_bucket_lock);
 263 }
 264
 265 static void rhashtable_rehash(struct rhashtable *ht,
 266                               struct bucket_table *new_tbl)
 267 {
 268         struct bucket_table *old_tbl = rht_dereference(ht->tbl, ht);
 269         struct rhashtable_walker *walker;
 270         unsigned old_hash;
 271
 272         get_random_bytes(&new_tbl->hash_rnd, sizeof(new_tbl->hash_rnd));
 273
 274         /* Make insertions go into the new, empty table right away. Deletions
 275          * and lookups will be attempted in both tables until we synchronize.
 276          * The synchronize_rcu() guarantees for the new table to be picked up
 277          * so no new additions go into the old table while we relink.
 278          */
 279         rcu_assign_pointer(ht->future_tbl, new_tbl);
 280
 281         /* Ensure the new table is visible to readers. */
 282         smp_wmb();
 283
 284         for (old_hash = 0; old_hash < old_tbl->size; old_hash++)
 285                 rhashtable_rehash_chain(ht, old_hash);
 286
 287         /* Publish the new table pointer. */
 288         rcu_assign_pointer(ht->tbl, new_tbl);
 289
 290         list_for_each_entry(walker, &old_tbl->walkers, list)
 291                 walker->tbl = NULL;
 292
 293         /* Wait for readers. All new readers will see the new
 294          * table, and thus no references to the old table will
 295          * remain.
 296          */
 297         synchronize_rcu();
 298
 299         bucket_table_free(old_tbl);
 300 }
 301
 302 /**
 303  * rhashtable_expand - Expand hash table while allowing concurrent lookups
 304  * @ht:         the hash table to expand
 305  *
 306  * A secondary bucket array is allocated and the hash entries are migrated.
 307  *
 308  * This function may only be called in a context where it is safe to call
 309  * synchronize_rcu(), e.g. not within a rcu_read_lock() section.
 310  *
 311  * The caller must ensure that no concurrent resizing occurs by holding
 312  * ht->mutex.
 313  *
 314  * It is valid to have concurrent insertions and deletions protected by per
 315  * bucket locks or concurrent RCU protected lookups and traversals.
 316  */
 317 int rhashtable_expand(struct rhashtable *ht)
 318 {
 319         struct bucket_table *new_tbl, *old_tbl = rht_dereference(ht->tbl, ht);
 320
 321         ASSERT_RHT_MUTEX(ht);
 322
 323         new_tbl = bucket_table_alloc(ht, old_tbl->size * 2, old_tbl->hash_rnd);
 324         if (new_tbl == NULL)
 325                 return -ENOMEM;
 326
 327         rhashtable_rehash(ht, new_tbl);
 328         return 0;
 329 }
 330 EXPORT_SYMBOL_GPL(rhashtable_expand);
 331
 332 /**
 333  * rhashtable_shrink - Shrink hash table while allowing concurrent lookups
 334  * @ht:         the hash table to shrink
 335  *
 336  * This function may only be called in a context where it is safe to call
 337  * synchronize_rcu(), e.g. not within a rcu_read_lock() section.
 338  *
 339  * The caller must ensure that no concurrent resizing occurs by holding
 340  * ht->mutex.
 341  *
 342  * The caller must ensure that no concurrent table mutations take place.
 343  * It is however valid to have concurrent lookups if they are RCU protected.
 344  *
 345  * It is valid to have concurrent insertions and deletions protected by per
 346  * bucket locks or concurrent RCU protected lookups and traversals.
 347  */
 348 int rhashtable_shrink(struct rhashtable *ht)
 349 {
 350         struct bucket_table *new_tbl, *old_tbl = rht_dereference(ht->tbl, ht);
 351
 352         ASSERT_RHT_MUTEX(ht);
 353
 354         new_tbl = bucket_table_alloc(ht, old_tbl->size / 2, old_tbl->hash_rnd);
 355         if (new_tbl == NULL)
 356                 return -ENOMEM;
 357
 358         rhashtable_rehash(ht, new_tbl);
 359         return 0;
 360 }
 361 EXPORT_SYMBOL_GPL(rhashtable_shrink);
 362
 363 static void rht_deferred_worker(struct work_struct *work)
 364 {
 365         struct rhashtable *ht;
 366         struct bucket_table *tbl;
 367
 368         ht = container_of(work, struct rhashtable, run_work);
 369         mutex_lock(&ht->mutex);
 370         if (ht->being_destroyed)
 371                 goto unlock;
 372
 373         tbl = rht_dereference(ht->tbl, ht);
 374
 375         if (rht_grow_above_75(ht, tbl))
 376                 rhashtable_expand(ht);
 377         else if (rht_shrink_below_30(ht, tbl))
 378                 rhashtable_shrink(ht);
 379 unlock:
 380         mutex_unlock(&ht->mutex);
 381 }
 382
 383 static bool __rhashtable_insert(struct rhashtable *ht, struct rhash_head *obj,
 384                                 bool (*compare)(void *, void *), void *arg)
 385 {
 386         struct bucket_table *tbl, *old_tbl;
 387         struct rhash_head *head;
 388         bool no_resize_running;
 389         unsigned hash;
 390         bool success = true;
 391
 392         rcu_read_lock();
 393
 394         old_tbl = rht_dereference_rcu(ht->tbl, ht);
 395         hash = head_hashfn(ht, old_tbl, obj);
 396
 397         spin_lock_bh(bucket_lock(old_tbl, hash));
 398
 399         /* Because we have already taken the bucket lock in old_tbl,
 400          * if we find that future_tbl is not yet visible then that
 401          * guarantees all other insertions of the same entry will
 402          * also grab the bucket lock in old_tbl because until the
 403          * rehash completes ht->tbl won't be changed.
 404          */
 405         tbl = rht_dereference_rcu(ht->future_tbl, ht);
 406         if (tbl != old_tbl) {
 407                 hash = head_hashfn(ht, tbl, obj);
 408                 spin_lock_nested(bucket_lock(tbl, hash), RHT_LOCK_NESTED);
 409         }
 410
 411         if (compare &&
 412             rhashtable_lookup_compare(ht, rht_obj(ht, obj) + ht->p.key_offset,
 413                                       compare, arg)) {
 414                 success = false;
 415                 goto exit;
 416         }
 417
 418         no_resize_running = tbl == old_tbl;
 419
 420         head = rht_dereference_bucket(tbl->buckets[hash], tbl, hash);
 421
 422         if (rht_is_a_nulls(head))
 423                 INIT_RHT_NULLS_HEAD(obj->next, ht, hash);
 424         else
 425                 RCU_INIT_POINTER(obj->next, head);
 426
 427         rcu_assign_pointer(tbl->buckets[hash], obj);
 428
 429         atomic_inc(&ht->nelems);
 430         if (no_resize_running && rht_grow_above_75(ht, tbl))
 431                 schedule_work(&ht->run_work);
 432
 433 exit:
 434         if (tbl != old_tbl) {
 435                 hash = head_hashfn(ht, tbl, obj);
 436                 spin_unlock(bucket_lock(tbl, hash));
 437         }
 438
 439         hash = head_hashfn(ht, old_tbl, obj);
 440         spin_unlock_bh(bucket_lock(old_tbl, hash));
 441
 442         rcu_read_unlock();
 443
 444         return success;
 445 }
 446
 447 /**
 448  * rhashtable_insert - insert object into hash table
 449  * @ht:         hash table
 450  * @obj:        pointer to hash head inside object
 451  *
 452  * Will take a per bucket spinlock to protect against mutual mutations
 453  * on the same bucket. Multiple insertions may occur in parallel unless
 454  * they map to the same bucket lock.
 455  *
 456  * It is safe to call this function from atomic context.
 457  *
 458  * Will trigger an automatic deferred table resizing if the size grows
 459  * beyond the watermark indicated by grow_decision() which can be passed
 460  * to rhashtable_init().
 461  */
 462 void rhashtable_insert(struct rhashtable *ht, struct rhash_head *obj)
 463 {
 464         __rhashtable_insert(ht, obj, NULL, NULL);
 465 }
 466 EXPORT_SYMBOL_GPL(rhashtable_insert);
 467
 468 static bool __rhashtable_remove(struct rhashtable *ht,
 469                                 struct bucket_table *tbl,
 470                                 struct rhash_head *obj)
 471 {
 472         struct rhash_head __rcu **pprev;
 473         struct rhash_head *he;
 474         spinlock_t * lock;
 475         unsigned hash;
 476         bool ret = false;
 477
 478         hash = head_hashfn(ht, tbl, obj);
 479         lock = bucket_lock(tbl, hash);
 480
 481         spin_lock_bh(lock);
 482
 483         pprev = &tbl->buckets[hash];
 484         rht_for_each(he, tbl, hash) {
 485                 if (he != obj) {
 486                         pprev = &he->next;
 487                         continue;
 488                 }
 489
 490                 rcu_assign_pointer(*pprev, obj->next);
 491                 ret = true;
 492                 break;
 493         }
 494
 495         spin_unlock_bh(lock);
 496
 497         return ret;
 498 }
 499
 500 /**
 501  * rhashtable_remove - remove object from hash table
 502  * @ht:         hash table
 503  * @obj:        pointer to hash head inside object
 504  *
 505  * Since the hash chain is single linked, the removal operation needs to
 506  * walk the bucket chain upon removal. The removal operation is thus
 507  * considerable slow if the hash table is not correctly sized.
 508  *
 509  * Will automatically shrink the table via rhashtable_expand() if the
 510  * shrink_decision function specified at rhashtable_init() returns true.
 511  *
 512  * The caller must ensure that no concurrent table mutations occur. It is
 513  * however valid to have concurrent lookups if they are RCU protected.
 514  */
 515 bool rhashtable_remove(struct rhashtable *ht, struct rhash_head *obj)
 516 {
 517         struct bucket_table *tbl, *old_tbl;
 518         bool ret;
 519
 520         rcu_read_lock();
 521
 522         old_tbl = rht_dereference_rcu(ht->tbl, ht);
 523         ret = __rhashtable_remove(ht, old_tbl, obj);
 524
 525         /* Because we have already taken (and released) the bucket
 526          * lock in old_tbl, if we find that future_tbl is not yet
 527          * visible then that guarantees the entry to still be in
 528          * old_tbl if it exists.
 529          */
 530         tbl = rht_dereference_rcu(ht->future_tbl, ht);
 531         if (!ret && old_tbl != tbl)
 532                 ret = __rhashtable_remove(ht, tbl, obj);
 533
 534         if (ret) {
 535                 bool no_resize_running = tbl == old_tbl;
 536
 537                 atomic_dec(&ht->nelems);
 538                 if (no_resize_running && rht_shrink_below_30(ht, tbl))
 539                         schedule_work(&ht->run_work);
 540         }
 541
 542         rcu_read_unlock();
 543
 544         return ret;
 545 }
 546 EXPORT_SYMBOL_GPL(rhashtable_remove);
 547
 548 struct rhashtable_compare_arg {
 549         struct rhashtable *ht;
 550         const void *key;
 551 };
 552
 553 static bool rhashtable_compare(void *ptr, void *arg)
 554 {
 555         struct rhashtable_compare_arg *x = arg;
 556         struct rhashtable *ht = x->ht;
 557
 558         return !memcmp(ptr + ht->p.key_offset, x->key, ht->p.key_len);
 559 }
 560
 561 /**
 562  * rhashtable_lookup - lookup key in hash table
 563  * @ht:         hash table
 564  * @key:        pointer to key
 565  *
 566  * Computes the hash value for the key and traverses the bucket chain looking
 567  * for a entry with an identical key. The first matching entry is returned.
 568  *
 569  * This lookup function may only be used for fixed key hash table (key_len
 570  * parameter set). It will BUG() if used inappropriately.
 571  *
 572  * Lookups may occur in parallel with hashtable mutations and resizing.
 573  */
 574 void *rhashtable_lookup(struct rhashtable *ht, const void *key)
 575 {
 576         struct rhashtable_compare_arg arg = {
 577                 .ht = ht,
 578                 .key = key,
 579         };
 580
 581         BUG_ON(!ht->p.key_len);
 582
 583         return rhashtable_lookup_compare(ht, key, &rhashtable_compare, &arg);
 584 }
 585 EXPORT_SYMBOL_GPL(rhashtable_lookup);
 586
 587 /**
 588  * rhashtable_lookup_compare - search hash table with compare function
 589  * @ht:         hash table
 590  * @key:        the pointer to the key
 591  * @compare:    compare function, must return true on match
 592  * @arg:        argument passed on to compare function
 593  *
 594  * Traverses the bucket chain behind the provided hash value and calls the
 595  * specified compare function for each entry.
 596  *
 597  * Lookups may occur in parallel with hashtable mutations and resizing.
 598  *
 599  * Returns the first entry on which the compare function returned true.
 600  */
 601 void *rhashtable_lookup_compare(struct rhashtable *ht, const void *key,
 602                                 bool (*compare)(void *, void *), void *arg)
 603 {
 604         const struct bucket_table *tbl, *old_tbl;
 605         struct rhash_head *he;
 606         u32 hash;
 607
 608         rcu_read_lock();
 609
 610         tbl = rht_dereference_rcu(ht->tbl, ht);
 611 restart:
 612         hash = key_hashfn(ht, tbl, key);
 613         rht_for_each_rcu(he, tbl, hash) {
 614                 if (!compare(rht_obj(ht, he), arg))
 615                         continue;
 616                 rcu_read_unlock();
 617                 return rht_obj(ht, he);
 618         }
 619
 620         /* Ensure we see any new tables. */
 621         smp_rmb();
 622
 623         old_tbl = tbl;
 624         tbl = rht_dereference_rcu(ht->future_tbl, ht);
 625         if (unlikely(tbl != old_tbl))
 626                 goto restart;
 627         rcu_read_unlock();
 628
 629         return NULL;
 630 }
 631 EXPORT_SYMBOL_GPL(rhashtable_lookup_compare);
 632
 633 /**
 634  * rhashtable_lookup_insert - lookup and insert object into hash table
 635  * @ht:         hash table
 636  * @obj:        pointer to hash head inside object
 637  *
 638  * Locks down the bucket chain in both the old and new table if a resize
 639  * is in progress to ensure that writers can't remove from the old table
 640  * and can't insert to the new table during the atomic operation of search
 641  * and insertion. Searches for duplicates in both the old and new table if
 642  * a resize is in progress.
 643  *
 644  * This lookup function may only be used for fixed key hash table (key_len
 645  * parameter set). It will BUG() if used inappropriately.
 646  *
 647  * It is safe to call this function from atomic context.
 648  *
 649  * Will trigger an automatic deferred table resizing if the size grows
 650  * beyond the watermark indicated by grow_decision() which can be passed
 651  * to rhashtable_init().
 652  */
 653 bool rhashtable_lookup_insert(struct rhashtable *ht, struct rhash_head *obj)
 654 {
 655         struct rhashtable_compare_arg arg = {
 656                 .ht = ht,
 657                 .key = rht_obj(ht, obj) + ht->p.key_offset,
 658         };
 659
 660         BUG_ON(!ht->p.key_len);
 661
 662         return rhashtable_lookup_compare_insert(ht, obj, &rhashtable_compare,
 663                                                 &arg);
 664 }
 665 EXPORT_SYMBOL_GPL(rhashtable_lookup_insert);
 666
 667 /**
 668  * rhashtable_lookup_compare_insert - search and insert object to hash table
 669  *                                    with compare function
 670  * @ht:         hash table
 671  * @obj:        pointer to hash head inside object
 672  * @compare:    compare function, must return true on match
 673  * @arg:        argument passed on to compare function
 674  *
 675  * Locks down the bucket chain in both the old and new table if a resize
 676  * is in progress to ensure that writers can't remove from the old table
 677  * and can't insert to the new table during the atomic operation of search
 678  * and insertion. Searches for duplicates in both the old and new table if
 679  * a resize is in progress.
 680  *
 681  * Lookups may occur in parallel with hashtable mutations and resizing.
 682  *
 683  * Will trigger an automatic deferred table resizing if the size grows
 684  * beyond the watermark indicated by grow_decision() which can be passed
 685  * to rhashtable_init().
 686  */
 687 bool rhashtable_lookup_compare_insert(struct rhashtable *ht,
 688                                       struct rhash_head *obj,
 689                                       bool (*compare)(void *, void *),
 690                                       void *arg)
 691 {
 692         BUG_ON(!ht->p.key_len);
 693
 694         return __rhashtable_insert(ht, obj, compare, arg);
 695 }
 696 EXPORT_SYMBOL_GPL(rhashtable_lookup_compare_insert);
 697
 698 /**
 699  * rhashtable_walk_init - Initialise an iterator
 700  * @ht:         Table to walk over
 701  * @iter:       Hash table Iterator
 702  *
 703  * This function prepares a hash table walk.
 704  *
 705  * Note that if you restart a walk after rhashtable_walk_stop you
 706  * may see the same object twice.  Also, you may miss objects if
 707  * there are removals in between rhashtable_walk_stop and the next
 708  * call to rhashtable_walk_start.
 709  *
 710  * For a completely stable walk you should construct your own data
 711  * structure outside the hash table.
 712  *
 713  * This function may sleep so you must not call it from interrupt
 714  * context or with spin locks held.
 715  *
 716  * You must call rhashtable_walk_exit if this function returns
 717  * successfully.
 718  */
 719 int rhashtable_walk_init(struct rhashtable *ht, struct rhashtable_iter *iter)
 720 {
 721         iter->ht = ht;
 722         iter->p = NULL;
 723         iter->slot = 0;
 724         iter->skip = 0;
 725
 726         iter->walker = kmalloc(sizeof(*iter->walker), GFP_KERNEL);
 727         if (!iter->walker)
 728                 return -ENOMEM;
 729
 730         mutex_lock(&ht->mutex);
 731         iter->walker->tbl = rht_dereference(ht->tbl, ht);
 732         list_add(&iter->walker->list, &iter->walker->tbl->walkers);
 733         mutex_unlock(&ht->mutex);
 734
 735         return 0;
 736 }
 737 EXPORT_SYMBOL_GPL(rhashtable_walk_init);
 738
 739 /**
 740  * rhashtable_walk_exit - Free an iterator
 741  * @iter:       Hash table Iterator
 742  *
 743  * This function frees resources allocated by rhashtable_walk_init.
 744  */
 745 void rhashtable_walk_exit(struct rhashtable_iter *iter)
 746 {
 747         mutex_lock(&iter->ht->mutex);
 748         if (iter->walker->tbl)
 749                 list_del(&iter->walker->list);
 750         mutex_unlock(&iter->ht->mutex);
 751         kfree(iter->walker);
 752 }
 753 EXPORT_SYMBOL_GPL(rhashtable_walk_exit);
 754
 755 /**
 756  * rhashtable_walk_start - Start a hash table walk
 757  * @iter:       Hash table iterator
 758  *
 759  * Start a hash table walk.  Note that we take the RCU lock in all
 760  * cases including when we return an error.  So you must always call
 761  * rhashtable_walk_stop to clean up.
 762  *
 763  * Returns zero if successful.
 764  *
 765  * Returns -EAGAIN if resize event occured.  Note that the iterator
 766  * will rewind back to the beginning and you may use it immediately
 767  * by calling rhashtable_walk_next.
 768  */
 769 int rhashtable_walk_start(struct rhashtable_iter *iter)
 770 {
 771         struct rhashtable *ht = iter->ht;
 772
 773         mutex_lock(&ht->mutex);
 774
 775         if (iter->walker->tbl)
 776                 list_del(&iter->walker->list);
 777
 778         rcu_read_lock();
 779
 780         mutex_unlock(&ht->mutex);
 781
 782         if (!iter->walker->tbl) {
 783                 iter->walker->tbl = rht_dereference_rcu(ht->tbl, ht);
 784                 return -EAGAIN;
 785         }
 786
 787         return 0;
 788 }
 789 EXPORT_SYMBOL_GPL(rhashtable_walk_start);
 790
 791 /**
 792  * rhashtable_walk_next - Return the next object and advance the iterator
 793  * @iter:       Hash table iterator
 794  *
 795  * Note that you must call rhashtable_walk_stop when you are finished
 796  * with the walk.
 797  *
 798  * Returns the next object or NULL when the end of the table is reached.
 799  *
 800  * Returns -EAGAIN if resize event occured.  Note that the iterator
 801  * will rewind back to the beginning and you may continue to use it.
 802  */
 803 void *rhashtable_walk_next(struct rhashtable_iter *iter)
 804 {
 805         struct bucket_table *tbl = iter->walker->tbl;
 806         struct rhashtable *ht = iter->ht;
 807         struct rhash_head *p = iter->p;
 808         void *obj = NULL;
 809
 810         if (p) {
 811                 p = rht_dereference_bucket_rcu(p->next, tbl, iter->slot);
 812                 goto next;
 813         }
 814
 815         for (; iter->slot < tbl->size; iter->slot++) {
 816                 int skip = iter->skip;
 817
 818                 rht_for_each_rcu(p, tbl, iter->slot) {
 819                         if (!skip)
 820                                 break;
 821                         skip--;
 822                 }
 823
 824 next:
 825                 if (!rht_is_a_nulls(p)) {
 826                         iter->skip++;
 827                         iter->p = p;
 828                         obj = rht_obj(ht, p);
 829                         goto out;
 830                 }
 831
 832                 iter->skip = 0;
 833         }
 834
 835         iter->walker->tbl = rht_dereference_rcu(ht->future_tbl, ht);
 836         if (iter->walker->tbl != tbl) {
 837                 iter->slot = 0;
 838                 iter->skip = 0;
 839                 return ERR_PTR(-EAGAIN);
 840         }
 841
 842         iter->walker->tbl = NULL;
 843         iter->p = NULL;
 844
 845 out:
 846
 847         return obj;
 848 }
 849 EXPORT_SYMBOL_GPL(rhashtable_walk_next);
 850
 851 /**
 852  * rhashtable_walk_stop - Finish a hash table walk
 853  * @iter:       Hash table iterator
 854  *
 855  * Finish a hash table walk.
 856  */
 857 void rhashtable_walk_stop(struct rhashtable_iter *iter)
 858 {
 859         struct rhashtable *ht;
 860         struct bucket_table *tbl = iter->walker->tbl;
 861
 862         rcu_read_unlock();
 863
 864         if (!tbl)
 865                 return;
 866
 867         ht = iter->ht;
 868
 869         mutex_lock(&ht->mutex);
 870         if (rht_dereference(ht->tbl, ht) == tbl ||
 871             rht_dereference(ht->future_tbl, ht) == tbl)
 872                 list_add(&iter->walker->list, &tbl->walkers);
 873         else
 874                 iter->walker->tbl = NULL;
 875         mutex_unlock(&ht->mutex);
 876
 877         iter->p = NULL;
 878 }
 879 EXPORT_SYMBOL_GPL(rhashtable_walk_stop);
 880
 881 static size_t rounded_hashtable_size(struct rhashtable_params *params)
 882 {
 883         return max(roundup_pow_of_two(params->nelem_hint * 4 / 3),
 884                    1UL << params->min_shift);
 885 }
 886
 887 /**
 888  * rhashtable_init - initialize a new hash table
 889  * @ht:         hash table to be initialized
 890  * @params:     configuration parameters
 891  *
 892  * Initializes a new hash table based on the provided configuration
 893  * parameters. A table can be configured either with a variable or
 894  * fixed length key:
 895  *
 896  * Configuration Example 1: Fixed length keys
 897  * struct test_obj {
 898  *      int                     key;
 899  *      void *                  my_member;
 900  *      struct rhash_head       node;
 901  * };
 902  *
 903  * struct rhashtable_params params = {
 904  *      .head_offset = offsetof(struct test_obj, node),
 905  *      .key_offset = offsetof(struct test_obj, key),
 906  *      .key_len = sizeof(int),
 907  *      .hashfn = jhash,
 908  *      .nulls_base = (1U << RHT_BASE_SHIFT),
 909  * };
 910  *
 911  * Configuration Example 2: Variable length keys
 912  * struct test_obj {
 913  *      [...]
 914  *      struct rhash_head       node;
 915  * };
 916  *
 917  * u32 my_hash_fn(const void *data, u32 seed)
 918  * {
 919  *      struct test_obj *obj = data;
 920  *
 921  *      return [... hash ...];
 922  * }
 923  *
 924  * struct rhashtable_params params = {
 925  *      .head_offset = offsetof(struct test_obj, node),
 926  *      .hashfn = jhash,
 927  *      .obj_hashfn = my_hash_fn,
 928  * };
 929  */
 930 int rhashtable_init(struct rhashtable *ht, struct rhashtable_params *params)
 931 {
 932         struct bucket_table *tbl;
 933         size_t size;
 934         u32 hash_rnd;
 935
 936         size = HASH_DEFAULT_SIZE;
 937
 938         if ((params->key_len && !params->hashfn) ||
 939             (!params->key_len && !params->obj_hashfn))
 940                 return -EINVAL;
 941
 942         if (params->nulls_base && params->nulls_base < (1U << RHT_BASE_SHIFT))
 943                 return -EINVAL;
 944
 945         params->min_shift = max_t(size_t, params->min_shift,
 946                                   ilog2(HASH_MIN_SIZE));
 947
 948         if (params->nelem_hint)
 949                 size = rounded_hashtable_size(params);
 950
 951         memset(ht, 0, sizeof(*ht));
 952         mutex_init(&ht->mutex);
 953         memcpy(&ht->p, params, sizeof(*params));
 954
 955         if (params->locks_mul)
 956                 ht->p.locks_mul = roundup_pow_of_two(params->locks_mul);
 957         else
 958                 ht->p.locks_mul = BUCKET_LOCKS_PER_CPU;
 959
 960         get_random_bytes(&hash_rnd, sizeof(hash_rnd));
 961
 962         tbl = bucket_table_alloc(ht, size, hash_rnd);
 963         if (tbl == NULL)
 964                 return -ENOMEM;
 965
 966         atomic_set(&ht->nelems, 0);
 967
 968         RCU_INIT_POINTER(ht->tbl, tbl);
 969         RCU_INIT_POINTER(ht->future_tbl, tbl);
 970
 971         INIT_WORK(&ht->run_work, rht_deferred_worker);
 972
 973         return 0;
 974 }
 975 EXPORT_SYMBOL_GPL(rhashtable_init);
 976
 977 /**
 978  * rhashtable_destroy - destroy hash table
 979  * @ht:         the hash table to destroy
 980  *
 981  * Frees the bucket array. This function is not rcu safe, therefore the caller
 982  * has to make sure that no resizing may happen by unpublishing the hashtable
 983  * and waiting for the quiescent cycle before releasing the bucket array.
 984  */
 985 void rhashtable_destroy(struct rhashtable *ht)
 986 {
 987         ht->being_destroyed = true;
 988
 989         cancel_work_sync(&ht->run_work);
 990
 991         mutex_lock(&ht->mutex);
 992         bucket_table_free(rht_dereference(ht->tbl, ht));
 993         mutex_unlock(&ht->mutex);
 994 }
 995 EXPORT_SYMBOL_GPL(rhashtable_destroy);