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