include/linux/rhashtable.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Resizable, Scalable, Concurrent Hash Table
   4  *
   5  * Copyright (c) 2015-2016 Herbert Xu <herbert@gondor.apana.org.au>
   6  * Copyright (c) 2014-2015 Thomas Graf <tgraf@suug.ch>
   7  * Copyright (c) 2008-2014 Patrick McHardy <kaber@trash.net>
   8  *
   9  * Code partially derived from nft_hash
  10  * Rewritten with rehash code from br_multicast plus single list
  11  * pointer as suggested by Josh Triplett
  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
  21 #include <linux/err.h>
  22 #include <linux/errno.h>
  23 #include <linux/jhash.h>
  24 #include <linux/list_nulls.h>
  25 #include <linux/workqueue.h>
  26 #include <linux/rculist.h>
  27
  28 #include <linux/rhashtable-types.h>
  29 /*
  30  * The end of the chain is marked with a special nulls marks which has
  31  * the least significant bit set.
  32  */
  33
  34 /* Maximum chain length before rehash
  35  *
  36  * The maximum (not average) chain length grows with the size of the hash
  37  * table, at a rate of (log N)/(log log N).
  38  *
  39  * The value of 16 is selected so that even if the hash table grew to
  40  * 2^32 you would not expect the maximum chain length to exceed it
  41  * unless we are under attack (or extremely unlucky).
  42  *
  43  * As this limit is only to detect attacks, we don't need to set it to a
  44  * lower value as you'd need the chain length to vastly exceed 16 to have
  45  * any real effect on the system.
  46  */
  47 #define RHT_ELASTICITY  16u
  48
  49 /**
  50  * struct bucket_table - Table of hash buckets
  51  * @size: Number of hash buckets
  52  * @nest: Number of bits of first-level nested table.
  53  * @rehash: Current bucket being rehashed
  54  * @hash_rnd: Random seed to fold into hash
  55  * @locks_mask: Mask to apply before accessing locks[]
  56  * @locks: Array of spinlocks protecting individual buckets
  57  * @walkers: List of active walkers
  58  * @rcu: RCU structure for freeing the table
  59  * @future_tbl: Table under construction during rehashing
  60  * @ntbl: Nested table used when out of memory.
  61  * @buckets: size * hash buckets
  62  */
  63 struct bucket_table {
  64         unsigned int            size;
  65         unsigned int            nest;
  66         u32                     hash_rnd;
  67         unsigned int            locks_mask;
  68         spinlock_t              *locks;
  69         struct list_head        walkers;
  70         struct rcu_head         rcu;
  71
  72         struct bucket_table __rcu *future_tbl;
  73
  74         struct rhash_head __rcu *buckets[] ____cacheline_aligned_in_smp;
  75 };
  76
  77 /*
  78  * NULLS_MARKER() expects a hash value with the low
  79  * bits mostly likely to be significant, and it discards
  80  * the msb.
  81  * We git it an address, in which the bottom 2 bits are
  82  * always 0, and the msb might be significant.
  83  * So we shift the address down one bit to align with
  84  * expectations and avoid losing a significant bit.
  85  */
  86 #define RHT_NULLS_MARKER(ptr)   \
  87         ((void *)NULLS_MARKER(((unsigned long) (ptr)) >> 1))
  88 #define INIT_RHT_NULLS_HEAD(ptr)        \
  89         ((ptr) = RHT_NULLS_MARKER(&(ptr)))
  90
  91 static inline bool rht_is_a_nulls(const struct rhash_head *ptr)
  92 {
  93         return ((unsigned long) ptr & 1);
  94 }
  95
  96 static inline void *rht_obj(const struct rhashtable *ht,
  97                             const struct rhash_head *he)
  98 {
  99         return (char *)he - ht->p.head_offset;
 100 }
 101
 102 static inline unsigned int rht_bucket_index(const struct bucket_table *tbl,
 103                                             unsigned int hash)
 104 {
 105         return hash & (tbl->size - 1);
 106 }
 107
 108 static inline unsigned int rht_key_get_hash(struct rhashtable *ht,
 109         const void *key, const struct rhashtable_params params,
 110         unsigned int hash_rnd)
 111 {
 112         unsigned int hash;
 113
 114         /* params must be equal to ht->p if it isn't constant. */
 115         if (!__builtin_constant_p(params.key_len))
 116                 hash = ht->p.hashfn(key, ht->key_len, hash_rnd);
 117         else if (params.key_len) {
 118                 unsigned int key_len = params.key_len;
 119
 120                 if (params.hashfn)
 121                         hash = params.hashfn(key, key_len, hash_rnd);
 122                 else if (key_len & (sizeof(u32) - 1))
 123                         hash = jhash(key, key_len, hash_rnd);
 124                 else
 125                         hash = jhash2(key, key_len / sizeof(u32), hash_rnd);
 126         } else {
 127                 unsigned int key_len = ht->p.key_len;
 128
 129                 if (params.hashfn)
 130                         hash = params.hashfn(key, key_len, hash_rnd);
 131                 else
 132                         hash = jhash(key, key_len, hash_rnd);
 133         }
 134
 135         return hash;
 136 }
 137
 138 static inline unsigned int rht_key_hashfn(
 139         struct rhashtable *ht, const struct bucket_table *tbl,
 140         const void *key, const struct rhashtable_params params)
 141 {
 142         unsigned int hash = rht_key_get_hash(ht, key, params, tbl->hash_rnd);
 143
 144         return rht_bucket_index(tbl, hash);
 145 }
 146
 147 static inline unsigned int rht_head_hashfn(
 148         struct rhashtable *ht, const struct bucket_table *tbl,
 149         const struct rhash_head *he, const struct rhashtable_params params)
 150 {
 151         const char *ptr = rht_obj(ht, he);
 152
 153         return likely(params.obj_hashfn) ?
 154                rht_bucket_index(tbl, params.obj_hashfn(ptr, params.key_len ?:
 155                                                             ht->p.key_len,
 156                                                        tbl->hash_rnd)) :
 157                rht_key_hashfn(ht, tbl, ptr + params.key_offset, params);
 158 }
 159
 160 /**
 161  * rht_grow_above_75 - returns true if nelems > 0.75 * table-size
 162  * @ht:         hash table
 163  * @tbl:        current table
 164  */
 165 static inline bool rht_grow_above_75(const struct rhashtable *ht,
 166                                      const struct bucket_table *tbl)
 167 {
 168         /* Expand table when exceeding 75% load */
 169         return atomic_read(&ht->nelems) > (tbl->size / 4 * 3) &&
 170                (!ht->p.max_size || tbl->size < ht->p.max_size);
 171 }
 172
 173 /**
 174  * rht_shrink_below_30 - returns true if nelems < 0.3 * table-size
 175  * @ht:         hash table
 176  * @tbl:        current table
 177  */
 178 static inline bool rht_shrink_below_30(const struct rhashtable *ht,
 179                                        const struct bucket_table *tbl)
 180 {
 181         /* Shrink table beneath 30% load */
 182         return atomic_read(&ht->nelems) < (tbl->size * 3 / 10) &&
 183                tbl->size > ht->p.min_size;
 184 }
 185
 186 /**
 187  * rht_grow_above_100 - returns true if nelems > table-size
 188  * @ht:         hash table
 189  * @tbl:        current table
 190  */
 191 static inline bool rht_grow_above_100(const struct rhashtable *ht,
 192                                       const struct bucket_table *tbl)
 193 {
 194         return atomic_read(&ht->nelems) > tbl->size &&
 195                 (!ht->p.max_size || tbl->size < ht->p.max_size);
 196 }
 197
 198 /**
 199  * rht_grow_above_max - returns true if table is above maximum
 200  * @ht:         hash table
 201  * @tbl:        current table
 202  */
 203 static inline bool rht_grow_above_max(const struct rhashtable *ht,
 204                                       const struct bucket_table *tbl)
 205 {
 206         return atomic_read(&ht->nelems) >= ht->max_elems;
 207 }
 208
 209 /* The bucket lock is selected based on the hash and protects mutations
 210  * on a group of hash buckets.
 211  *
 212  * A maximum of tbl->size/2 bucket locks is allocated. This ensures that
 213  * a single lock always covers both buckets which may both contains
 214  * entries which link to the same bucket of the old table during resizing.
 215  * This allows to simplify the locking as locking the bucket in both
 216  * tables during resize always guarantee protection.
 217  *
 218  * IMPORTANT: When holding the bucket lock of both the old and new table
 219  * during expansions and shrinking, the old bucket lock must always be
 220  * acquired first.
 221  */
 222 static inline spinlock_t *rht_bucket_lock(const struct bucket_table *tbl,
 223                                           unsigned int hash)
 224 {
 225         return &tbl->locks[hash & tbl->locks_mask];
 226 }
 227
 228 #ifdef CONFIG_PROVE_LOCKING
 229 int lockdep_rht_mutex_is_held(struct rhashtable *ht);
 230 int lockdep_rht_bucket_is_held(const struct bucket_table *tbl, u32 hash);
 231 #else
 232 static inline int lockdep_rht_mutex_is_held(struct rhashtable *ht)
 233 {
 234         return 1;
 235 }
 236
 237 static inline int lockdep_rht_bucket_is_held(const struct bucket_table *tbl,
 238                                              u32 hash)
 239 {
 240         return 1;
 241 }
 242 #endif /* CONFIG_PROVE_LOCKING */
 243
 244 void *rhashtable_insert_slow(struct rhashtable *ht, const void *key,
 245                              struct rhash_head *obj);
 246
 247 void rhashtable_walk_enter(struct rhashtable *ht,
 248                            struct rhashtable_iter *iter);
 249 void rhashtable_walk_exit(struct rhashtable_iter *iter);
 250 int rhashtable_walk_start_check(struct rhashtable_iter *iter) __acquires(RCU);
 251
 252 static inline void rhashtable_walk_start(struct rhashtable_iter *iter)
 253 {
 254         (void)rhashtable_walk_start_check(iter);
 255 }
 256
 257 void *rhashtable_walk_next(struct rhashtable_iter *iter);
 258 void *rhashtable_walk_peek(struct rhashtable_iter *iter);
 259 void rhashtable_walk_stop(struct rhashtable_iter *iter) __releases(RCU);
 260
 261 void rhashtable_free_and_destroy(struct rhashtable *ht,
 262                                  void (*free_fn)(void *ptr, void *arg),
 263                                  void *arg);
 264 void rhashtable_destroy(struct rhashtable *ht);
 265
 266 struct rhash_head __rcu **rht_bucket_nested(const struct bucket_table *tbl,
 267                                             unsigned int hash);
 268 struct rhash_head __rcu **rht_bucket_nested_insert(struct rhashtable *ht,
 269                                                    struct bucket_table *tbl,
 270                                                    unsigned int hash);
 271
 272 #define rht_dereference(p, ht) \
 273         rcu_dereference_protected(p, lockdep_rht_mutex_is_held(ht))
 274
 275 #define rht_dereference_rcu(p, ht) \
 276         rcu_dereference_check(p, lockdep_rht_mutex_is_held(ht))
 277
 278 #define rht_dereference_bucket(p, tbl, hash) \
 279         rcu_dereference_protected(p, lockdep_rht_bucket_is_held(tbl, hash))
 280
 281 #define rht_dereference_bucket_rcu(p, tbl, hash) \
 282         rcu_dereference_check(p, lockdep_rht_bucket_is_held(tbl, hash))
 283
 284 #define rht_entry(tpos, pos, member) \
 285         ({ tpos = container_of(pos, typeof(*tpos), member); 1; })
 286
 287 static inline struct rhash_head __rcu *const *rht_bucket(
 288         const struct bucket_table *tbl, unsigned int hash)
 289 {
 290         return unlikely(tbl->nest) ? rht_bucket_nested(tbl, hash) :
 291                                      &tbl->buckets[hash];
 292 }
 293
 294 static inline struct rhash_head __rcu **rht_bucket_var(
 295         struct bucket_table *tbl, unsigned int hash)
 296 {
 297         return unlikely(tbl->nest) ? rht_bucket_nested(tbl, hash) :
 298                                      &tbl->buckets[hash];
 299 }
 300
 301 static inline struct rhash_head __rcu **rht_bucket_insert(
 302         struct rhashtable *ht, struct bucket_table *tbl, unsigned int hash)
 303 {
 304         return unlikely(tbl->nest) ? rht_bucket_nested_insert(ht, tbl, hash) :
 305                                      &tbl->buckets[hash];
 306 }
 307
 308 /**
 309  * rht_for_each_from - iterate over hash chain from given head
 310  * @pos:        the &struct rhash_head to use as a loop cursor.
 311  * @head:       the &struct rhash_head to start from
 312  * @tbl:        the &struct bucket_table
 313  * @hash:       the hash value / bucket index
 314  */
 315 #define rht_for_each_from(pos, head, tbl, hash) \
 316         for (pos = rht_dereference_bucket(head, tbl, hash); \
 317              !rht_is_a_nulls(pos); \
 318              pos = rht_dereference_bucket((pos)->next, tbl, hash))
 319
 320 /**
 321  * rht_for_each - iterate over hash chain
 322  * @pos:        the &struct rhash_head to use as a loop cursor.
 323  * @tbl:        the &struct bucket_table
 324  * @hash:       the hash value / bucket index
 325  */
 326 #define rht_for_each(pos, tbl, hash) \
 327         rht_for_each_from(pos, *rht_bucket(tbl, hash), tbl, hash)
 328
 329 /**
 330  * rht_for_each_entry_from - iterate over hash chain from given head
 331  * @tpos:       the type * to use as a loop cursor.
 332  * @pos:        the &struct rhash_head to use as a loop cursor.
 333  * @head:       the &struct rhash_head to start from
 334  * @tbl:        the &struct bucket_table
 335  * @hash:       the hash value / bucket index
 336  * @member:     name of the &struct rhash_head within the hashable struct.
 337  */
 338 #define rht_for_each_entry_from(tpos, pos, head, tbl, hash, member)     \
 339         for (pos = rht_dereference_bucket(head, tbl, hash);             \
 340              (!rht_is_a_nulls(pos)) && rht_entry(tpos, pos, member);    \
 341              pos = rht_dereference_bucket((pos)->next, tbl, hash))
 342
 343 /**
 344  * rht_for_each_entry - iterate over hash chain of given type
 345  * @tpos:       the type * to use as a loop cursor.
 346  * @pos:        the &struct rhash_head to use as a loop cursor.
 347  * @tbl:        the &struct bucket_table
 348  * @hash:       the hash value / bucket index
 349  * @member:     name of the &struct rhash_head within the hashable struct.
 350  */
 351 #define rht_for_each_entry(tpos, pos, tbl, hash, member)                \
 352         rht_for_each_entry_from(tpos, pos, *rht_bucket(tbl, hash),      \
 353                                     tbl, hash, member)
 354
 355 /**
 356  * rht_for_each_entry_safe - safely iterate over hash chain of given type
 357  * @tpos:       the type * to use as a loop cursor.
 358  * @pos:        the &struct rhash_head to use as a loop cursor.
 359  * @next:       the &struct rhash_head to use as next in loop cursor.
 360  * @tbl:        the &struct bucket_table
 361  * @hash:       the hash value / bucket index
 362  * @member:     name of the &struct rhash_head within the hashable struct.
 363  *
 364  * This hash chain list-traversal primitive allows for the looped code to
 365  * remove the loop cursor from the list.
 366  */
 367 #define rht_for_each_entry_safe(tpos, pos, next, tbl, hash, member)           \
 368         for (pos = rht_dereference_bucket(*rht_bucket(tbl, hash), tbl, hash), \
 369              next = !rht_is_a_nulls(pos) ?                                    \
 370                        rht_dereference_bucket(pos->next, tbl, hash) : NULL;   \
 371              (!rht_is_a_nulls(pos)) && rht_entry(tpos, pos, member);          \
 372              pos = next,                                                      \
 373              next = !rht_is_a_nulls(pos) ?                                    \
 374                        rht_dereference_bucket(pos->next, tbl, hash) : NULL)
 375
 376 /**
 377  * rht_for_each_rcu_from - iterate over rcu hash chain from given head
 378  * @pos:        the &struct rhash_head to use as a loop cursor.
 379  * @head:       the &struct rhash_head to start from
 380  * @tbl:        the &struct bucket_table
 381  * @hash:       the hash value / bucket index
 382  *
 383  * This hash chain list-traversal primitive may safely run concurrently with
 384  * the _rcu mutation primitives such as rhashtable_insert() as long as the
 385  * traversal is guarded by rcu_read_lock().
 386  */
 387 #define rht_for_each_rcu_from(pos, head, tbl, hash)                     \
 388         for (({barrier(); }),                                           \
 389              pos = rht_dereference_bucket_rcu(head, tbl, hash);         \
 390              !rht_is_a_nulls(pos);                                      \
 391              pos = rcu_dereference_raw(pos->next))
 392
 393 /**
 394  * rht_for_each_rcu - iterate over rcu hash chain
 395  * @pos:        the &struct rhash_head to use as a loop cursor.
 396  * @tbl:        the &struct bucket_table
 397  * @hash:       the hash value / bucket index
 398  *
 399  * This hash chain list-traversal primitive may safely run concurrently with
 400  * the _rcu mutation primitives such as rhashtable_insert() as long as the
 401  * traversal is guarded by rcu_read_lock().
 402  */
 403 #define rht_for_each_rcu(pos, tbl, hash)                                \
 404         rht_for_each_rcu_from(pos, *rht_bucket(tbl, hash), tbl, hash)
 405
 406 /**
 407  * rht_for_each_entry_rcu_from - iterated over rcu hash chain from given head
 408  * @tpos:       the type * to use as a loop cursor.
 409  * @pos:        the &struct rhash_head to use as a loop cursor.
 410  * @head:       the &struct rhash_head to start from
 411  * @tbl:        the &struct bucket_table
 412  * @hash:       the hash value / bucket index
 413  * @member:     name of the &struct rhash_head within the hashable struct.
 414  *
 415  * This hash chain list-traversal primitive may safely run concurrently with
 416  * the _rcu mutation primitives such as rhashtable_insert() as long as the
 417  * traversal is guarded by rcu_read_lock().
 418  */
 419 #define rht_for_each_entry_rcu_from(tpos, pos, head, tbl, hash, member) \
 420         for (({barrier(); }),                                               \
 421              pos = rht_dereference_bucket_rcu(head, tbl, hash);             \
 422              (!rht_is_a_nulls(pos)) && rht_entry(tpos, pos, member);        \
 423              pos = rht_dereference_bucket_rcu(pos->next, tbl, hash))
 424
 425 /**
 426  * rht_for_each_entry_rcu - iterate over rcu hash chain of given type
 427  * @tpos:       the type * to use as a loop cursor.
 428  * @pos:        the &struct rhash_head to use as a loop cursor.
 429  * @tbl:        the &struct bucket_table
 430  * @hash:       the hash value / bucket index
 431  * @member:     name of the &struct rhash_head within the hashable struct.
 432  *
 433  * This hash chain list-traversal primitive may safely run concurrently with
 434  * the _rcu mutation primitives such as rhashtable_insert() as long as the
 435  * traversal is guarded by rcu_read_lock().
 436  */
 437 #define rht_for_each_entry_rcu(tpos, pos, tbl, hash, member)               \
 438         rht_for_each_entry_rcu_from(tpos, pos, *rht_bucket(tbl, hash), \
 439                                         tbl, hash, member)
 440
 441 /**
 442  * rhl_for_each_rcu - iterate over rcu hash table list
 443  * @pos:        the &struct rlist_head to use as a loop cursor.
 444  * @list:       the head of the list
 445  *
 446  * This hash chain list-traversal primitive should be used on the
 447  * list returned by rhltable_lookup.
 448  */
 449 #define rhl_for_each_rcu(pos, list)                                     \
 450         for (pos = list; pos; pos = rcu_dereference_raw(pos->next))
 451
 452 /**
 453  * rhl_for_each_entry_rcu - iterate over rcu hash table list of given type
 454  * @tpos:       the type * to use as a loop cursor.
 455  * @pos:        the &struct rlist_head to use as a loop cursor.
 456  * @list:       the head of the list
 457  * @member:     name of the &struct rlist_head within the hashable struct.
 458  *
 459  * This hash chain list-traversal primitive should be used on the
 460  * list returned by rhltable_lookup.
 461  */
 462 #define rhl_for_each_entry_rcu(tpos, pos, list, member)                 \
 463         for (pos = list; pos && rht_entry(tpos, pos, member);           \
 464              pos = rcu_dereference_raw(pos->next))
 465
 466 static inline int rhashtable_compare(struct rhashtable_compare_arg *arg,
 467                                      const void *obj)
 468 {
 469         struct rhashtable *ht = arg->ht;
 470         const char *ptr = obj;
 471
 472         return memcmp(ptr + ht->p.key_offset, arg->key, ht->p.key_len);
 473 }
 474
 475 /* Internal function, do not use. */
 476 static inline struct rhash_head *__rhashtable_lookup(
 477         struct rhashtable *ht, const void *key,
 478         const struct rhashtable_params params)
 479 {
 480         struct rhashtable_compare_arg arg = {
 481                 .ht = ht,
 482                 .key = key,
 483         };
 484         struct rhash_head __rcu * const *head;
 485         struct bucket_table *tbl;
 486         struct rhash_head *he;
 487         unsigned int hash;
 488
 489         tbl = rht_dereference_rcu(ht->tbl, ht);
 490 restart:
 491         hash = rht_key_hashfn(ht, tbl, key, params);
 492         head = rht_bucket(tbl, hash);
 493         do {
 494                 rht_for_each_rcu_from(he, *head, tbl, hash) {
 495                         if (params.obj_cmpfn ?
 496                             params.obj_cmpfn(&arg, rht_obj(ht, he)) :
 497                             rhashtable_compare(&arg, rht_obj(ht, he)))
 498                                 continue;
 499                         return he;
 500                 }
 501                 /* An object might have been moved to a different hash chain,
 502                  * while we walk along it - better check and retry.
 503                  */
 504         } while (he != RHT_NULLS_MARKER(head));
 505
 506         /* Ensure we see any new tables. */
 507         smp_rmb();
 508
 509         tbl = rht_dereference_rcu(tbl->future_tbl, ht);
 510         if (unlikely(tbl))
 511                 goto restart;
 512
 513         return NULL;
 514 }
 515
 516 /**
 517  * rhashtable_lookup - search hash table
 518  * @ht:         hash table
 519  * @key:        the pointer to the key
 520  * @params:     hash table parameters
 521  *
 522  * Computes the hash value for the key and traverses the bucket chain looking
 523  * for a entry with an identical key. The first matching entry is returned.
 524  *
 525  * This must only be called under the RCU read lock.
 526  *
 527  * Returns the first entry on which the compare function returned true.
 528  */
 529 static inline void *rhashtable_lookup(
 530         struct rhashtable *ht, const void *key,
 531         const struct rhashtable_params params)
 532 {
 533         struct rhash_head *he = __rhashtable_lookup(ht, key, params);
 534
 535         return he ? rht_obj(ht, he) : NULL;
 536 }
 537
 538 /**
 539  * rhashtable_lookup_fast - search hash table, without RCU read lock
 540  * @ht:         hash table
 541  * @key:        the pointer to the key
 542  * @params:     hash table parameters
 543  *
 544  * Computes the hash value for the key and traverses the bucket chain looking
 545  * for a entry with an identical key. The first matching entry is returned.
 546  *
 547  * Only use this function when you have other mechanisms guaranteeing
 548  * that the object won't go away after the RCU read lock is released.
 549  *
 550  * Returns the first entry on which the compare function returned true.
 551  */
 552 static inline void *rhashtable_lookup_fast(
 553         struct rhashtable *ht, const void *key,
 554         const struct rhashtable_params params)
 555 {
 556         void *obj;
 557
 558         rcu_read_lock();
 559         obj = rhashtable_lookup(ht, key, params);
 560         rcu_read_unlock();
 561
 562         return obj;
 563 }
 564
 565 /**
 566  * rhltable_lookup - search hash list table
 567  * @hlt:        hash table
 568  * @key:        the pointer to the key
 569  * @params:     hash table parameters
 570  *
 571  * Computes the hash value for the key and traverses the bucket chain looking
 572  * for a entry with an identical key.  All matching entries are returned
 573  * in a list.
 574  *
 575  * This must only be called under the RCU read lock.
 576  *
 577  * Returns the list of entries that match the given key.
 578  */
 579 static inline struct rhlist_head *rhltable_lookup(
 580         struct rhltable *hlt, const void *key,
 581         const struct rhashtable_params params)
 582 {
 583         struct rhash_head *he = __rhashtable_lookup(&hlt->ht, key, params);
 584
 585         return he ? container_of(he, struct rhlist_head, rhead) : NULL;
 586 }
 587
 588 /* Internal function, please use rhashtable_insert_fast() instead. This
 589  * function returns the existing element already in hashes in there is a clash,
 590  * otherwise it returns an error via ERR_PTR().
 591  */
 592 static inline void *__rhashtable_insert_fast(
 593         struct rhashtable *ht, const void *key, struct rhash_head *obj,
 594         const struct rhashtable_params params, bool rhlist)
 595 {
 596         struct rhashtable_compare_arg arg = {
 597                 .ht = ht,
 598                 .key = key,
 599         };
 600         struct rhash_head __rcu **pprev;
 601         struct bucket_table *tbl;
 602         struct rhash_head *head;
 603         spinlock_t *lock;
 604         unsigned int hash;
 605         int elasticity;
 606         void *data;
 607
 608         rcu_read_lock();
 609
 610         tbl = rht_dereference_rcu(ht->tbl, ht);
 611         hash = rht_head_hashfn(ht, tbl, obj, params);
 612         lock = rht_bucket_lock(tbl, hash);
 613         spin_lock_bh(lock);
 614
 615         if (unlikely(rcu_access_pointer(tbl->future_tbl))) {
 616 slow_path:
 617                 spin_unlock_bh(lock);
 618                 rcu_read_unlock();
 619                 return rhashtable_insert_slow(ht, key, obj);
 620         }
 621
 622         elasticity = RHT_ELASTICITY;
 623         pprev = rht_bucket_insert(ht, tbl, hash);
 624         data = ERR_PTR(-ENOMEM);
 625         if (!pprev)
 626                 goto out;
 627
 628         rht_for_each_from(head, *pprev, tbl, hash) {
 629                 struct rhlist_head *plist;
 630                 struct rhlist_head *list;
 631
 632                 elasticity--;
 633                 if (!key ||
 634                     (params.obj_cmpfn ?
 635                      params.obj_cmpfn(&arg, rht_obj(ht, head)) :
 636                      rhashtable_compare(&arg, rht_obj(ht, head)))) {
 637                         pprev = &head->next;
 638                         continue;
 639                 }
 640
 641                 data = rht_obj(ht, head);
 642
 643                 if (!rhlist)
 644                         goto out;
 645
 646
 647                 list = container_of(obj, struct rhlist_head, rhead);
 648                 plist = container_of(head, struct rhlist_head, rhead);
 649
 650                 RCU_INIT_POINTER(list->next, plist);
 651                 head = rht_dereference_bucket(head->next, tbl, hash);
 652                 RCU_INIT_POINTER(list->rhead.next, head);
 653                 rcu_assign_pointer(*pprev, obj);
 654
 655                 goto good;
 656         }
 657
 658         if (elasticity <= 0)
 659                 goto slow_path;
 660
 661         data = ERR_PTR(-E2BIG);
 662         if (unlikely(rht_grow_above_max(ht, tbl)))
 663                 goto out;
 664
 665         if (unlikely(rht_grow_above_100(ht, tbl)))
 666                 goto slow_path;
 667
 668         head = rht_dereference_bucket(*pprev, tbl, hash);
 669
 670         RCU_INIT_POINTER(obj->next, head);
 671         if (rhlist) {
 672                 struct rhlist_head *list;
 673
 674                 list = container_of(obj, struct rhlist_head, rhead);
 675                 RCU_INIT_POINTER(list->next, NULL);
 676         }
 677
 678         rcu_assign_pointer(*pprev, obj);
 679
 680         atomic_inc(&ht->nelems);
 681         if (rht_grow_above_75(ht, tbl))
 682                 schedule_work(&ht->run_work);
 683
 684 good:
 685         data = NULL;
 686
 687 out:
 688         spin_unlock_bh(lock);
 689         rcu_read_unlock();
 690
 691         return data;
 692 }
 693
 694 /**
 695  * rhashtable_insert_fast - insert object into hash table
 696  * @ht:         hash table
 697  * @obj:        pointer to hash head inside object
 698  * @params:     hash table parameters
 699  *
 700  * Will take a per bucket spinlock to protect against mutual mutations
 701  * on the same bucket. Multiple insertions may occur in parallel unless
 702  * they map to the same bucket lock.
 703  *
 704  * It is safe to call this function from atomic context.
 705  *
 706  * Will trigger an automatic deferred table resizing if residency in the
 707  * table grows beyond 70%.
 708  */
 709 static inline int rhashtable_insert_fast(
 710         struct rhashtable *ht, struct rhash_head *obj,
 711         const struct rhashtable_params params)
 712 {
 713         void *ret;
 714
 715         ret = __rhashtable_insert_fast(ht, NULL, obj, params, false);
 716         if (IS_ERR(ret))
 717                 return PTR_ERR(ret);
 718
 719         return ret == NULL ? 0 : -EEXIST;
 720 }
 721
 722 /**
 723  * rhltable_insert_key - insert object into hash list table
 724  * @hlt:        hash list table
 725  * @key:        the pointer to the key
 726  * @list:       pointer to hash list head inside object
 727  * @params:     hash table parameters
 728  *
 729  * Will take a per bucket spinlock to protect against mutual mutations
 730  * on the same bucket. Multiple insertions may occur in parallel unless
 731  * they map to the same bucket lock.
 732  *
 733  * It is safe to call this function from atomic context.
 734  *
 735  * Will trigger an automatic deferred table resizing if residency in the
 736  * table grows beyond 70%.
 737  */
 738 static inline int rhltable_insert_key(
 739         struct rhltable *hlt, const void *key, struct rhlist_head *list,
 740         const struct rhashtable_params params)
 741 {
 742         return PTR_ERR(__rhashtable_insert_fast(&hlt->ht, key, &list->rhead,
 743                                                 params, true));
 744 }
 745
 746 /**
 747  * rhltable_insert - insert object into hash list table
 748  * @hlt:        hash list table
 749  * @list:       pointer to hash list head inside object
 750  * @params:     hash table parameters
 751  *
 752  * Will take a per bucket spinlock to protect against mutual mutations
 753  * on the same bucket. Multiple insertions may occur in parallel unless
 754  * they map to the same bucket lock.
 755  *
 756  * It is safe to call this function from atomic context.
 757  *
 758  * Will trigger an automatic deferred table resizing if residency in the
 759  * table grows beyond 70%.
 760  */
 761 static inline int rhltable_insert(
 762         struct rhltable *hlt, struct rhlist_head *list,
 763         const struct rhashtable_params params)
 764 {
 765         const char *key = rht_obj(&hlt->ht, &list->rhead);
 766
 767         key += params.key_offset;
 768
 769         return rhltable_insert_key(hlt, key, list, params);
 770 }
 771
 772 /**
 773  * rhashtable_lookup_insert_fast - lookup and insert object into hash table
 774  * @ht:         hash table
 775  * @obj:        pointer to hash head inside object
 776  * @params:     hash table parameters
 777  *
 778  * This lookup function may only be used for fixed key hash table (key_len
 779  * parameter set). It will BUG() if used inappropriately.
 780  *
 781  * It is safe to call this function from atomic context.
 782  *
 783  * Will trigger an automatic deferred table resizing if residency in the
 784  * table grows beyond 70%.
 785  */
 786 static inline int rhashtable_lookup_insert_fast(
 787         struct rhashtable *ht, struct rhash_head *obj,
 788         const struct rhashtable_params params)
 789 {
 790         const char *key = rht_obj(ht, obj);
 791         void *ret;
 792
 793         BUG_ON(ht->p.obj_hashfn);
 794
 795         ret = __rhashtable_insert_fast(ht, key + ht->p.key_offset, obj, params,
 796                                        false);
 797         if (IS_ERR(ret))
 798                 return PTR_ERR(ret);
 799
 800         return ret == NULL ? 0 : -EEXIST;
 801 }
 802
 803 /**
 804  * rhashtable_lookup_get_insert_fast - lookup and insert object into hash table
 805  * @ht:         hash table
 806  * @obj:        pointer to hash head inside object
 807  * @params:     hash table parameters
 808  *
 809  * Just like rhashtable_lookup_insert_fast(), but this function returns the
 810  * object if it exists, NULL if it did not and the insertion was successful,
 811  * and an ERR_PTR otherwise.
 812  */
 813 static inline void *rhashtable_lookup_get_insert_fast(
 814         struct rhashtable *ht, struct rhash_head *obj,
 815         const struct rhashtable_params params)
 816 {
 817         const char *key = rht_obj(ht, obj);
 818
 819         BUG_ON(ht->p.obj_hashfn);
 820
 821         return __rhashtable_insert_fast(ht, key + ht->p.key_offset, obj, params,
 822                                         false);
 823 }
 824
 825 /**
 826  * rhashtable_lookup_insert_key - search and insert object to hash table
 827  *                                with explicit key
 828  * @ht:         hash table
 829  * @key:        key
 830  * @obj:        pointer to hash head inside object
 831  * @params:     hash table parameters
 832  *
 833  * Lookups may occur in parallel with hashtable mutations and resizing.
 834  *
 835  * Will trigger an automatic deferred table resizing if residency in the
 836  * table grows beyond 70%.
 837  *
 838  * Returns zero on success.
 839  */
 840 static inline int rhashtable_lookup_insert_key(
 841         struct rhashtable *ht, const void *key, struct rhash_head *obj,
 842         const struct rhashtable_params params)
 843 {
 844         void *ret;
 845
 846         BUG_ON(!ht->p.obj_hashfn || !key);
 847
 848         ret = __rhashtable_insert_fast(ht, key, obj, params, false);
 849         if (IS_ERR(ret))
 850                 return PTR_ERR(ret);
 851
 852         return ret == NULL ? 0 : -EEXIST;
 853 }
 854
 855 /**
 856  * rhashtable_lookup_get_insert_key - lookup and insert object into hash table
 857  * @ht:         hash table
 858  * @obj:        pointer to hash head inside object
 859  * @params:     hash table parameters
 860  * @data:       pointer to element data already in hashes
 861  *
 862  * Just like rhashtable_lookup_insert_key(), but this function returns the
 863  * object if it exists, NULL if it does not and the insertion was successful,
 864  * and an ERR_PTR otherwise.
 865  */
 866 static inline void *rhashtable_lookup_get_insert_key(
 867         struct rhashtable *ht, const void *key, struct rhash_head *obj,
 868         const struct rhashtable_params params)
 869 {
 870         BUG_ON(!ht->p.obj_hashfn || !key);
 871
 872         return __rhashtable_insert_fast(ht, key, obj, params, false);
 873 }
 874
 875 /* Internal function, please use rhashtable_remove_fast() instead */
 876 static inline int __rhashtable_remove_fast_one(
 877         struct rhashtable *ht, struct bucket_table *tbl,
 878         struct rhash_head *obj, const struct rhashtable_params params,
 879         bool rhlist)
 880 {
 881         struct rhash_head __rcu **pprev;
 882         struct rhash_head *he;
 883         spinlock_t * lock;
 884         unsigned int hash;
 885         int err = -ENOENT;
 886
 887         hash = rht_head_hashfn(ht, tbl, obj, params);
 888         lock = rht_bucket_lock(tbl, hash);
 889
 890         spin_lock_bh(lock);
 891
 892         pprev = rht_bucket_var(tbl, hash);
 893         rht_for_each_from(he, *pprev, tbl, hash) {
 894                 struct rhlist_head *list;
 895
 896                 list = container_of(he, struct rhlist_head, rhead);
 897
 898                 if (he != obj) {
 899                         struct rhlist_head __rcu **lpprev;
 900
 901                         pprev = &he->next;
 902
 903                         if (!rhlist)
 904                                 continue;
 905
 906                         do {
 907                                 lpprev = &list->next;
 908                                 list = rht_dereference_bucket(list->next,
 909                                                               tbl, hash);
 910                         } while (list && obj != &list->rhead);
 911
 912                         if (!list)
 913                                 continue;
 914
 915                         list = rht_dereference_bucket(list->next, tbl, hash);
 916                         RCU_INIT_POINTER(*lpprev, list);
 917                         err = 0;
 918                         break;
 919                 }
 920
 921                 obj = rht_dereference_bucket(obj->next, tbl, hash);
 922                 err = 1;
 923
 924                 if (rhlist) {
 925                         list = rht_dereference_bucket(list->next, tbl, hash);
 926                         if (list) {
 927                                 RCU_INIT_POINTER(list->rhead.next, obj);
 928                                 obj = &list->rhead;
 929                                 err = 0;
 930                         }
 931                 }
 932
 933                 rcu_assign_pointer(*pprev, obj);
 934                 break;
 935         }
 936
 937         spin_unlock_bh(lock);
 938
 939         if (err > 0) {
 940                 atomic_dec(&ht->nelems);
 941                 if (unlikely(ht->p.automatic_shrinking &&
 942                              rht_shrink_below_30(ht, tbl)))
 943                         schedule_work(&ht->run_work);
 944                 err = 0;
 945         }
 946
 947         return err;
 948 }
 949
 950 /* Internal function, please use rhashtable_remove_fast() instead */
 951 static inline int __rhashtable_remove_fast(
 952         struct rhashtable *ht, struct rhash_head *obj,
 953         const struct rhashtable_params params, bool rhlist)
 954 {
 955         struct bucket_table *tbl;
 956         int err;
 957
 958         rcu_read_lock();
 959
 960         tbl = rht_dereference_rcu(ht->tbl, ht);
 961
 962         /* Because we have already taken (and released) the bucket
 963          * lock in old_tbl, if we find that future_tbl is not yet
 964          * visible then that guarantees the entry to still be in
 965          * the old tbl if it exists.
 966          */
 967         while ((err = __rhashtable_remove_fast_one(ht, tbl, obj, params,
 968                                                    rhlist)) &&
 969                (tbl = rht_dereference_rcu(tbl->future_tbl, ht)))
 970                 ;
 971
 972         rcu_read_unlock();
 973
 974         return err;
 975 }
 976
 977 /**
 978  * rhashtable_remove_fast - remove object from hash table
 979  * @ht:         hash table
 980  * @obj:        pointer to hash head inside object
 981  * @params:     hash table parameters
 982  *
 983  * Since the hash chain is single linked, the removal operation needs to
 984  * walk the bucket chain upon removal. The removal operation is thus
 985  * considerable slow if the hash table is not correctly sized.
 986  *
 987  * Will automatically shrink the table if permitted when residency drops
 988  * below 30%.
 989  *
 990  * Returns zero on success, -ENOENT if the entry could not be found.
 991  */
 992 static inline int rhashtable_remove_fast(
 993         struct rhashtable *ht, struct rhash_head *obj,
 994         const struct rhashtable_params params)
 995 {
 996         return __rhashtable_remove_fast(ht, obj, params, false);
 997 }
 998
 999 /**
1000  * rhltable_remove - remove object from hash list table
1001  * @hlt:        hash list table
1002  * @list:       pointer to hash list head inside object
1003  * @params:     hash table parameters
1004  *
1005  * Since the hash chain is single linked, the removal operation needs to
1006  * walk the bucket chain upon removal. The removal operation is thus
1007  * considerable slow if the hash table is not correctly sized.
1008  *
1009  * Will automatically shrink the table if permitted when residency drops
1010  * below 30%
1011  *
1012  * Returns zero on success, -ENOENT if the entry could not be found.
1013  */
1014 static inline int rhltable_remove(
1015         struct rhltable *hlt, struct rhlist_head *list,
1016         const struct rhashtable_params params)
1017 {
1018         return __rhashtable_remove_fast(&hlt->ht, &list->rhead, params, true);
1019 }
1020
1021 /* Internal function, please use rhashtable_replace_fast() instead */
1022 static inline int __rhashtable_replace_fast(
1023         struct rhashtable *ht, struct bucket_table *tbl,
1024         struct rhash_head *obj_old, struct rhash_head *obj_new,
1025         const struct rhashtable_params params)
1026 {
1027         struct rhash_head __rcu **pprev;
1028         struct rhash_head *he;
1029         spinlock_t *lock;
1030         unsigned int hash;
1031         int err = -ENOENT;
1032
1033         /* Minimally, the old and new objects must have same hash
1034          * (which should mean identifiers are the same).
1035          */
1036         hash = rht_head_hashfn(ht, tbl, obj_old, params);
1037         if (hash != rht_head_hashfn(ht, tbl, obj_new, params))
1038                 return -EINVAL;
1039
1040         lock = rht_bucket_lock(tbl, hash);
1041
1042         spin_lock_bh(lock);
1043
1044         pprev = rht_bucket_var(tbl, hash);
1045         rht_for_each_from(he, *pprev, tbl, hash) {
1046                 if (he != obj_old) {
1047                         pprev = &he->next;
1048                         continue;
1049                 }
1050
1051                 rcu_assign_pointer(obj_new->next, obj_old->next);
1052                 rcu_assign_pointer(*pprev, obj_new);
1053                 err = 0;
1054                 break;
1055         }
1056
1057         spin_unlock_bh(lock);
1058
1059         return err;
1060 }
1061
1062 /**
1063  * rhashtable_replace_fast - replace an object in hash table
1064  * @ht:         hash table
1065  * @obj_old:    pointer to hash head inside object being replaced
1066  * @obj_new:    pointer to hash head inside object which is new
1067  * @params:     hash table parameters
1068  *
1069  * Replacing an object doesn't affect the number of elements in the hash table
1070  * or bucket, so we don't need to worry about shrinking or expanding the
1071  * table here.
1072  *
1073  * Returns zero on success, -ENOENT if the entry could not be found,
1074  * -EINVAL if hash is not the same for the old and new objects.
1075  */
1076 static inline int rhashtable_replace_fast(
1077         struct rhashtable *ht, struct rhash_head *obj_old,
1078         struct rhash_head *obj_new,
1079         const struct rhashtable_params params)
1080 {
1081         struct bucket_table *tbl;
1082         int err;
1083
1084         rcu_read_lock();
1085
1086         tbl = rht_dereference_rcu(ht->tbl, ht);
1087
1088         /* Because we have already taken (and released) the bucket
1089          * lock in old_tbl, if we find that future_tbl is not yet
1090          * visible then that guarantees the entry to still be in
1091          * the old tbl if it exists.
1092          */
1093         while ((err = __rhashtable_replace_fast(ht, tbl, obj_old,
1094                                                 obj_new, params)) &&
1095                (tbl = rht_dereference_rcu(tbl->future_tbl, ht)))
1096                 ;
1097
1098         rcu_read_unlock();
1099
1100         return err;
1101 }
1102
1103 /**
1104  * rhltable_walk_enter - Initialise an iterator
1105  * @hlt:        Table to walk over
1106  * @iter:       Hash table Iterator
1107  *
1108  * This function prepares a hash table walk.
1109  *
1110  * Note that if you restart a walk after rhashtable_walk_stop you
1111  * may see the same object twice.  Also, you may miss objects if
1112  * there are removals in between rhashtable_walk_stop and the next
1113  * call to rhashtable_walk_start.
1114  *
1115  * For a completely stable walk you should construct your own data
1116  * structure outside the hash table.
1117  *
1118  * This function may be called from any process context, including
1119  * non-preemptable context, but cannot be called from softirq or
1120  * hardirq context.
1121  *
1122  * You must call rhashtable_walk_exit after this function returns.
1123  */
1124 static inline void rhltable_walk_enter(struct rhltable *hlt,
1125                                        struct rhashtable_iter *iter)
1126 {
1127         return rhashtable_walk_enter(&hlt->ht, iter);
1128 }
1129
1130 /**
1131  * rhltable_free_and_destroy - free elements and destroy hash list table
1132  * @hlt:        the hash list table to destroy
1133  * @free_fn:    callback to release resources of element
1134  * @arg:        pointer passed to free_fn
1135  *
1136  * See documentation for rhashtable_free_and_destroy.
1137  */
1138 static inline void rhltable_free_and_destroy(struct rhltable *hlt,
1139                                              void (*free_fn)(void *ptr,
1140                                                              void *arg),
1141                                              void *arg)
1142 {
1143         return rhashtable_free_and_destroy(&hlt->ht, free_fn, arg);
1144 }
1145
1146 static inline void rhltable_destroy(struct rhltable *hlt)
1147 {
1148         return rhltable_free_and_destroy(hlt, NULL, NULL);
1149 }
1150
1151 #endif /* _LINUX_RHASHTABLE_H */