drivers/staging/lustre/include/linux/libcfs/libcfs_hash.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2012, 2015 Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * libcfs/include/libcfs/libcfs_hash.h
  33  *
  34  * Hashing routines
  35  *
  36  */
  37
  38 #ifndef __LIBCFS_HASH_H__
  39 #define __LIBCFS_HASH_H__
  40
  41 #include <linux/hash.h>
  42
  43 /*
  44  * Knuth recommends primes in approximately golden ratio to the maximum
  45  * integer representable by a machine word for multiplicative hashing.
  46  * Chuck Lever verified the effectiveness of this technique:
  47  * http://www.citi.umich.edu/techreports/reports/citi-tr-00-1.pdf
  48  *
  49  * These primes are chosen to be bit-sparse, that is operations on
  50  * them can use shifts and additions instead of multiplications for
  51  * machines where multiplications are slow.
  52  */
  53 /* 2^31 + 2^29 - 2^25 + 2^22 - 2^19 - 2^16 + 1 */
  54 #define CFS_GOLDEN_RATIO_PRIME_32 0x9e370001UL
  55 /*  2^63 + 2^61 - 2^57 + 2^54 - 2^51 - 2^18 + 1 */
  56 #define CFS_GOLDEN_RATIO_PRIME_64 0x9e37fffffffc0001ULL
  57
  58 /** disable debug */
  59 #define CFS_HASH_DEBUG_NONE     0
  60 /** record hash depth and output to console when it's too deep,
  61  *  computing overhead is low but consume more memory */
  62 #define CFS_HASH_DEBUG_1        1
  63 /** expensive, check key validation */
  64 #define CFS_HASH_DEBUG_2        2
  65
  66 #define CFS_HASH_DEBUG_LEVEL    CFS_HASH_DEBUG_NONE
  67
  68 struct cfs_hash_ops;
  69 struct cfs_hash_lock_ops;
  70 struct cfs_hash_hlist_ops;
  71
  72 union cfs_hash_lock {
  73         rwlock_t                rw;             /**< rwlock */
  74         spinlock_t              spin;           /**< spinlock */
  75 };
  76
  77 /**
  78  * cfs_hash_bucket is a container of:
  79  * - lock, counter ...
  80  * - array of hash-head starting from hsb_head[0], hash-head can be one of
  81  *   . struct cfs_hash_head
  82  *   . struct cfs_hash_head_dep
  83  *   . struct cfs_hash_dhead
  84  *   . struct cfs_hash_dhead_dep
  85  *   which depends on requirement of user
  86  * - some extra bytes (caller can require it while creating hash)
  87  */
  88 struct cfs_hash_bucket {
  89         union cfs_hash_lock     hsb_lock;       /**< bucket lock */
  90         __u32                   hsb_count;      /**< current entries */
  91         __u32                   hsb_version;    /**< change version */
  92         unsigned int            hsb_index;      /**< index of bucket */
  93         int                     hsb_depmax;     /**< max depth on bucket */
  94         long                    hsb_head[0];    /**< hash-head array */
  95 };
  96
  97 /**
  98  * cfs_hash bucket descriptor, it's normally in stack of caller
  99  */
 100 struct cfs_hash_bd {
 101         /* address of bucket */
 102         struct cfs_hash_bucket  *bd_bucket;
 103         /* offset in bucket */
 104         unsigned int             bd_offset;
 105 };
 106
 107 #define CFS_HASH_NAME_LEN       16      /**< default name length */
 108 #define CFS_HASH_BIGNAME_LEN    64      /**< bigname for param tree */
 109
 110 #define CFS_HASH_BKT_BITS       3       /**< default bits of bucket */
 111 #define CFS_HASH_BITS_MAX       30      /**< max bits of bucket */
 112 #define CFS_HASH_BITS_MIN       CFS_HASH_BKT_BITS
 113
 114 /**
 115  * common hash attributes.
 116  */
 117 enum cfs_hash_tag {
 118         /**
 119          * don't need any lock, caller will protect operations with it's
 120          * own lock. With this flag:
 121          *  . CFS_HASH_NO_BKTLOCK, CFS_HASH_RW_BKTLOCK, CFS_HASH_SPIN_BKTLOCK
 122          *    will be ignored.
 123          *  . Some functions will be disabled with this flag, i.e:
 124          *    cfs_hash_for_each_empty, cfs_hash_rehash
 125          */
 126         CFS_HASH_NO_LOCK        = 1 << 0,
 127         /** no bucket lock, use one spinlock to protect the whole hash */
 128         CFS_HASH_NO_BKTLOCK     = 1 << 1,
 129         /** rwlock to protect bucket */
 130         CFS_HASH_RW_BKTLOCK     = 1 << 2,
 131         /** spinlock to protect bucket */
 132         CFS_HASH_SPIN_BKTLOCK   = 1 << 3,
 133         /** always add new item to tail */
 134         CFS_HASH_ADD_TAIL       = 1 << 4,
 135         /** hash-table doesn't have refcount on item */
 136         CFS_HASH_NO_ITEMREF     = 1 << 5,
 137         /** big name for param-tree */
 138         CFS_HASH_BIGNAME        = 1 << 6,
 139         /** track global count */
 140         CFS_HASH_COUNTER        = 1 << 7,
 141         /** rehash item by new key */
 142         CFS_HASH_REHASH_KEY     = 1 << 8,
 143         /** Enable dynamic hash resizing */
 144         CFS_HASH_REHASH         = 1 << 9,
 145         /** can shrink hash-size */
 146         CFS_HASH_SHRINK         = 1 << 10,
 147         /** assert hash is empty on exit */
 148         CFS_HASH_ASSERT_EMPTY   = 1 << 11,
 149         /** record hlist depth */
 150         CFS_HASH_DEPTH          = 1 << 12,
 151         /**
 152          * rehash is always scheduled in a different thread, so current
 153          * change on hash table is non-blocking
 154          */
 155         CFS_HASH_NBLK_CHANGE    = 1 << 13,
 156         /** NB, we typed hs_flags as  __u16, please change it
 157          * if you need to extend >=16 flags */
 158 };
 159
 160 /** most used attributes */
 161 #define CFS_HASH_DEFAULT        (CFS_HASH_RW_BKTLOCK | \
 162                                  CFS_HASH_COUNTER | CFS_HASH_REHASH)
 163
 164 /**
 165  * cfs_hash is a hash-table implementation for general purpose, it can support:
 166  *    . two refcount modes
 167  *      hash-table with & without refcount
 168  *    . four lock modes
 169  *      nolock, one-spinlock, rw-bucket-lock, spin-bucket-lock
 170  *    . general operations
 171  *      lookup, add(add_tail or add_head), delete
 172  *    . rehash
 173  *      grows or shrink
 174  *    . iteration
 175  *      locked iteration and unlocked iteration
 176  *    . bigname
 177  *      support long name hash
 178  *    . debug
 179  *      trace max searching depth
 180  *
 181  * Rehash:
 182  * When the htable grows or shrinks, a separate task (cfs_hash_rehash_worker)
 183  * is spawned to handle the rehash in the background, it's possible that other
 184  * processes can concurrently perform additions, deletions, and lookups
 185  * without being blocked on rehash completion, because rehash will release
 186  * the global wrlock for each bucket.
 187  *
 188  * rehash and iteration can't run at the same time because it's too tricky
 189  * to keep both of them safe and correct.
 190  * As they are relatively rare operations, so:
 191  *   . if iteration is in progress while we try to launch rehash, then
 192  *     it just giveup, iterator will launch rehash at the end.
 193  *   . if rehash is in progress while we try to iterate the hash table,
 194  *     then we just wait (shouldn't be very long time), anyway, nobody
 195  *     should expect iteration of whole hash-table to be non-blocking.
 196  *
 197  * During rehashing, a (key,object) pair may be in one of two buckets,
 198  * depending on whether the worker task has yet to transfer the object
 199  * to its new location in the table. Lookups and deletions need to search both
 200  * locations; additions must take care to only insert into the new bucket.
 201  */
 202
 203 struct cfs_hash {
 204         /** serialize with rehash, or serialize all operations if
 205          * the hash-table has CFS_HASH_NO_BKTLOCK */
 206         union cfs_hash_lock             hs_lock;
 207         /** hash operations */
 208         struct cfs_hash_ops             *hs_ops;
 209         /** hash lock operations */
 210         struct cfs_hash_lock_ops        *hs_lops;
 211         /** hash list operations */
 212         struct cfs_hash_hlist_ops       *hs_hops;
 213         /** hash buckets-table */
 214         struct cfs_hash_bucket          **hs_buckets;
 215         /** total number of items on this hash-table */
 216         atomic_t                        hs_count;
 217         /** hash flags, see cfs_hash_tag for detail */
 218         __u16                           hs_flags;
 219         /** # of extra-bytes for bucket, for user saving extended attributes */
 220         __u16                           hs_extra_bytes;
 221         /** wants to iterate */
 222         __u8                            hs_iterating;
 223         /** hash-table is dying */
 224         __u8                            hs_exiting;
 225         /** current hash bits */
 226         __u8                            hs_cur_bits;
 227         /** min hash bits */
 228         __u8                            hs_min_bits;
 229         /** max hash bits */
 230         __u8                            hs_max_bits;
 231         /** bits for rehash */
 232         __u8                            hs_rehash_bits;
 233         /** bits for each bucket */
 234         __u8                            hs_bkt_bits;
 235         /** resize min threshold */
 236         __u16                           hs_min_theta;
 237         /** resize max threshold */
 238         __u16                           hs_max_theta;
 239         /** resize count */
 240         __u32                           hs_rehash_count;
 241         /** # of iterators (caller of cfs_hash_for_each_*) */
 242         __u32                           hs_iterators;
 243         /** rehash workitem */
 244         struct cfs_workitem             hs_rehash_wi;
 245         /** refcount on this hash table */
 246         atomic_t                        hs_refcount;
 247         /** rehash buckets-table */
 248         struct cfs_hash_bucket          **hs_rehash_buckets;
 249 #if CFS_HASH_DEBUG_LEVEL >= CFS_HASH_DEBUG_1
 250         /** serialize debug members */
 251         spinlock_t                      hs_dep_lock;
 252         /** max depth */
 253         unsigned int                    hs_dep_max;
 254         /** id of the deepest bucket */
 255         unsigned int                    hs_dep_bkt;
 256         /** offset in the deepest bucket */
 257         unsigned int                    hs_dep_off;
 258         /** bits when we found the max depth */
 259         unsigned int                    hs_dep_bits;
 260         /** workitem to output max depth */
 261         struct cfs_workitem             hs_dep_wi;
 262 #endif
 263         /** name of htable */
 264         char                            hs_name[0];
 265 };
 266
 267 struct cfs_hash_lock_ops {
 268         /** lock the hash table */
 269         void    (*hs_lock)(union cfs_hash_lock *lock, int exclusive);
 270         /** unlock the hash table */
 271         void    (*hs_unlock)(union cfs_hash_lock *lock, int exclusive);
 272         /** lock the hash bucket */
 273         void    (*hs_bkt_lock)(union cfs_hash_lock *lock, int exclusive);
 274         /** unlock the hash bucket */
 275         void    (*hs_bkt_unlock)(union cfs_hash_lock *lock, int exclusive);
 276 };
 277
 278 struct cfs_hash_hlist_ops {
 279         /** return hlist_head of hash-head of @bd */
 280         struct hlist_head *(*hop_hhead)(struct cfs_hash *hs,
 281                                         struct cfs_hash_bd *bd);
 282         /** return hash-head size */
 283         int (*hop_hhead_size)(struct cfs_hash *hs);
 284         /** add @hnode to hash-head of @bd */
 285         int (*hop_hnode_add)(struct cfs_hash *hs, struct cfs_hash_bd *bd,
 286                              struct hlist_node *hnode);
 287         /** remove @hnode from hash-head of @bd */
 288         int (*hop_hnode_del)(struct cfs_hash *hs, struct cfs_hash_bd *bd,
 289                              struct hlist_node *hnode);
 290 };
 291
 292 struct cfs_hash_ops {
 293         /** return hashed value from @key */
 294         unsigned (*hs_hash)(struct cfs_hash *hs, const void *key,
 295                             unsigned mask);
 296         /** return key address of @hnode */
 297         void *   (*hs_key)(struct hlist_node *hnode);
 298         /** copy key from @hnode to @key */
 299         void     (*hs_keycpy)(struct hlist_node *hnode, void *key);
 300         /**
 301          *  compare @key with key of @hnode
 302          *  returns 1 on a match
 303          */
 304         int      (*hs_keycmp)(const void *key, struct hlist_node *hnode);
 305         /** return object address of @hnode, i.e: container_of(...hnode) */
 306         void *   (*hs_object)(struct hlist_node *hnode);
 307         /** get refcount of item, always called with holding bucket-lock */
 308         void     (*hs_get)(struct cfs_hash *hs, struct hlist_node *hnode);
 309         /** release refcount of item */
 310         void     (*hs_put)(struct cfs_hash *hs, struct hlist_node *hnode);
 311         /** release refcount of item, always called with holding bucket-lock */
 312         void     (*hs_put_locked)(struct cfs_hash *hs,
 313                                   struct hlist_node *hnode);
 314         /** it's called before removing of @hnode */
 315         void     (*hs_exit)(struct cfs_hash *hs, struct hlist_node *hnode);
 316 };
 317
 318 /** total number of buckets in @hs */
 319 #define CFS_HASH_NBKT(hs)       \
 320         (1U << ((hs)->hs_cur_bits - (hs)->hs_bkt_bits))
 321
 322 /** total number of buckets in @hs while rehashing */
 323 #define CFS_HASH_RH_NBKT(hs)    \
 324         (1U << ((hs)->hs_rehash_bits - (hs)->hs_bkt_bits))
 325
 326 /** number of hlist for in bucket */
 327 #define CFS_HASH_BKT_NHLIST(hs) (1U << (hs)->hs_bkt_bits)
 328
 329 /** total number of hlist in @hs */
 330 #define CFS_HASH_NHLIST(hs)     (1U << (hs)->hs_cur_bits)
 331
 332 /** total number of hlist in @hs while rehashing */
 333 #define CFS_HASH_RH_NHLIST(hs)  (1U << (hs)->hs_rehash_bits)
 334
 335 static inline int
 336 cfs_hash_with_no_lock(struct cfs_hash *hs)
 337 {
 338         /* caller will serialize all operations for this hash-table */
 339         return (hs->hs_flags & CFS_HASH_NO_LOCK) != 0;
 340 }
 341
 342 static inline int
 343 cfs_hash_with_no_bktlock(struct cfs_hash *hs)
 344 {
 345         /* no bucket lock, one single lock to protect the hash-table */
 346         return (hs->hs_flags & CFS_HASH_NO_BKTLOCK) != 0;
 347 }
 348
 349 static inline int
 350 cfs_hash_with_rw_bktlock(struct cfs_hash *hs)
 351 {
 352         /* rwlock to protect hash bucket */
 353         return (hs->hs_flags & CFS_HASH_RW_BKTLOCK) != 0;
 354 }
 355
 356 static inline int
 357 cfs_hash_with_spin_bktlock(struct cfs_hash *hs)
 358 {
 359         /* spinlock to protect hash bucket */
 360         return (hs->hs_flags & CFS_HASH_SPIN_BKTLOCK) != 0;
 361 }
 362
 363 static inline int
 364 cfs_hash_with_add_tail(struct cfs_hash *hs)
 365 {
 366         return (hs->hs_flags & CFS_HASH_ADD_TAIL) != 0;
 367 }
 368
 369 static inline int
 370 cfs_hash_with_no_itemref(struct cfs_hash *hs)
 371 {
 372         /* hash-table doesn't keep refcount on item,
 373          * item can't be removed from hash unless it's
 374          * ZERO refcount */
 375         return (hs->hs_flags & CFS_HASH_NO_ITEMREF) != 0;
 376 }
 377
 378 static inline int
 379 cfs_hash_with_bigname(struct cfs_hash *hs)
 380 {
 381         return (hs->hs_flags & CFS_HASH_BIGNAME) != 0;
 382 }
 383
 384 static inline int
 385 cfs_hash_with_counter(struct cfs_hash *hs)
 386 {
 387         return (hs->hs_flags & CFS_HASH_COUNTER) != 0;
 388 }
 389
 390 static inline int
 391 cfs_hash_with_rehash(struct cfs_hash *hs)
 392 {
 393         return (hs->hs_flags & CFS_HASH_REHASH) != 0;
 394 }
 395
 396 static inline int
 397 cfs_hash_with_rehash_key(struct cfs_hash *hs)
 398 {
 399         return (hs->hs_flags & CFS_HASH_REHASH_KEY) != 0;
 400 }
 401
 402 static inline int
 403 cfs_hash_with_shrink(struct cfs_hash *hs)
 404 {
 405         return (hs->hs_flags & CFS_HASH_SHRINK) != 0;
 406 }
 407
 408 static inline int
 409 cfs_hash_with_assert_empty(struct cfs_hash *hs)
 410 {
 411         return (hs->hs_flags & CFS_HASH_ASSERT_EMPTY) != 0;
 412 }
 413
 414 static inline int
 415 cfs_hash_with_depth(struct cfs_hash *hs)
 416 {
 417         return (hs->hs_flags & CFS_HASH_DEPTH) != 0;
 418 }
 419
 420 static inline int
 421 cfs_hash_with_nblk_change(struct cfs_hash *hs)
 422 {
 423         return (hs->hs_flags & CFS_HASH_NBLK_CHANGE) != 0;
 424 }
 425
 426 static inline int
 427 cfs_hash_is_exiting(struct cfs_hash *hs)
 428 {
 429         /* cfs_hash_destroy is called */
 430         return hs->hs_exiting;
 431 }
 432
 433 static inline int
 434 cfs_hash_is_rehashing(struct cfs_hash *hs)
 435 {
 436         /* rehash is launched */
 437         return hs->hs_rehash_bits != 0;
 438 }
 439
 440 static inline int
 441 cfs_hash_is_iterating(struct cfs_hash *hs)
 442 {
 443         /* someone is calling cfs_hash_for_each_* */
 444         return hs->hs_iterating || hs->hs_iterators != 0;
 445 }
 446
 447 static inline int
 448 cfs_hash_bkt_size(struct cfs_hash *hs)
 449 {
 450         return offsetof(struct cfs_hash_bucket, hsb_head[0]) +
 451                hs->hs_hops->hop_hhead_size(hs) * CFS_HASH_BKT_NHLIST(hs) +
 452                hs->hs_extra_bytes;
 453 }
 454
 455 static inline unsigned
 456 cfs_hash_id(struct cfs_hash *hs, const void *key, unsigned mask)
 457 {
 458         return hs->hs_ops->hs_hash(hs, key, mask);
 459 }
 460
 461 static inline void *
 462 cfs_hash_key(struct cfs_hash *hs, struct hlist_node *hnode)
 463 {
 464         return hs->hs_ops->hs_key(hnode);
 465 }
 466
 467 static inline void
 468 cfs_hash_keycpy(struct cfs_hash *hs, struct hlist_node *hnode, void *key)
 469 {
 470         if (hs->hs_ops->hs_keycpy)
 471                 hs->hs_ops->hs_keycpy(hnode, key);
 472 }
 473
 474 /**
 475  * Returns 1 on a match,
 476  */
 477 static inline int
 478 cfs_hash_keycmp(struct cfs_hash *hs, const void *key, struct hlist_node *hnode)
 479 {
 480         return hs->hs_ops->hs_keycmp(key, hnode);
 481 }
 482
 483 static inline void *
 484 cfs_hash_object(struct cfs_hash *hs, struct hlist_node *hnode)
 485 {
 486         return hs->hs_ops->hs_object(hnode);
 487 }
 488
 489 static inline void
 490 cfs_hash_get(struct cfs_hash *hs, struct hlist_node *hnode)
 491 {
 492         return hs->hs_ops->hs_get(hs, hnode);
 493 }
 494
 495 static inline void
 496 cfs_hash_put_locked(struct cfs_hash *hs, struct hlist_node *hnode)
 497 {
 498         return hs->hs_ops->hs_put_locked(hs, hnode);
 499 }
 500
 501 static inline void
 502 cfs_hash_put(struct cfs_hash *hs, struct hlist_node *hnode)
 503 {
 504         return hs->hs_ops->hs_put(hs, hnode);
 505 }
 506
 507 static inline void
 508 cfs_hash_exit(struct cfs_hash *hs, struct hlist_node *hnode)
 509 {
 510         if (hs->hs_ops->hs_exit)
 511                 hs->hs_ops->hs_exit(hs, hnode);
 512 }
 513
 514 static inline void cfs_hash_lock(struct cfs_hash *hs, int excl)
 515 {
 516         hs->hs_lops->hs_lock(&hs->hs_lock, excl);
 517 }
 518
 519 static inline void cfs_hash_unlock(struct cfs_hash *hs, int excl)
 520 {
 521         hs->hs_lops->hs_unlock(&hs->hs_lock, excl);
 522 }
 523
 524 static inline int cfs_hash_dec_and_lock(struct cfs_hash *hs,
 525                                         atomic_t *condition)
 526 {
 527         LASSERT(cfs_hash_with_no_bktlock(hs));
 528         return atomic_dec_and_lock(condition, &hs->hs_lock.spin);
 529 }
 530
 531 static inline void cfs_hash_bd_lock(struct cfs_hash *hs,
 532                                     struct cfs_hash_bd *bd, int excl)
 533 {
 534         hs->hs_lops->hs_bkt_lock(&bd->bd_bucket->hsb_lock, excl);
 535 }
 536
 537 static inline void cfs_hash_bd_unlock(struct cfs_hash *hs,
 538                                       struct cfs_hash_bd *bd, int excl)
 539 {
 540         hs->hs_lops->hs_bkt_unlock(&bd->bd_bucket->hsb_lock, excl);
 541 }
 542
 543 /**
 544  * operations on cfs_hash bucket (bd: bucket descriptor),
 545  * they are normally for hash-table without rehash
 546  */
 547 void cfs_hash_bd_get(struct cfs_hash *hs, const void *key,
 548                      struct cfs_hash_bd *bd);
 549
 550 static inline void
 551 cfs_hash_bd_get_and_lock(struct cfs_hash *hs, const void *key,
 552                          struct cfs_hash_bd *bd, int excl)
 553 {
 554         cfs_hash_bd_get(hs, key, bd);
 555         cfs_hash_bd_lock(hs, bd, excl);
 556 }
 557
 558 static inline unsigned
 559 cfs_hash_bd_index_get(struct cfs_hash *hs, struct cfs_hash_bd *bd)
 560 {
 561         return bd->bd_offset | (bd->bd_bucket->hsb_index << hs->hs_bkt_bits);
 562 }
 563
 564 static inline void
 565 cfs_hash_bd_index_set(struct cfs_hash *hs, unsigned index,
 566                       struct cfs_hash_bd *bd)
 567 {
 568         bd->bd_bucket = hs->hs_buckets[index >> hs->hs_bkt_bits];
 569         bd->bd_offset = index & (CFS_HASH_BKT_NHLIST(hs) - 1U);
 570 }
 571
 572 static inline void *
 573 cfs_hash_bd_extra_get(struct cfs_hash *hs, struct cfs_hash_bd *bd)
 574 {
 575         return (void *)bd->bd_bucket +
 576                cfs_hash_bkt_size(hs) - hs->hs_extra_bytes;
 577 }
 578
 579 static inline __u32
 580 cfs_hash_bd_version_get(struct cfs_hash_bd *bd)
 581 {
 582         /* need hold cfs_hash_bd_lock */
 583         return bd->bd_bucket->hsb_version;
 584 }
 585
 586 static inline __u32
 587 cfs_hash_bd_count_get(struct cfs_hash_bd *bd)
 588 {
 589         /* need hold cfs_hash_bd_lock */
 590         return bd->bd_bucket->hsb_count;
 591 }
 592
 593 static inline int
 594 cfs_hash_bd_depmax_get(struct cfs_hash_bd *bd)
 595 {
 596         return bd->bd_bucket->hsb_depmax;
 597 }
 598
 599 static inline int
 600 cfs_hash_bd_compare(struct cfs_hash_bd *bd1, struct cfs_hash_bd *bd2)
 601 {
 602         if (bd1->bd_bucket->hsb_index != bd2->bd_bucket->hsb_index)
 603                 return bd1->bd_bucket->hsb_index - bd2->bd_bucket->hsb_index;
 604
 605         if (bd1->bd_offset != bd2->bd_offset)
 606                 return bd1->bd_offset - bd2->bd_offset;
 607
 608         return 0;
 609 }
 610
 611 void cfs_hash_bd_add_locked(struct cfs_hash *hs, struct cfs_hash_bd *bd,
 612                             struct hlist_node *hnode);
 613 void cfs_hash_bd_del_locked(struct cfs_hash *hs, struct cfs_hash_bd *bd,
 614                             struct hlist_node *hnode);
 615 void cfs_hash_bd_move_locked(struct cfs_hash *hs, struct cfs_hash_bd *bd_old,
 616                              struct cfs_hash_bd *bd_new,
 617                              struct hlist_node *hnode);
 618
 619 static inline int
 620 cfs_hash_bd_dec_and_lock(struct cfs_hash *hs, struct cfs_hash_bd *bd,
 621                          atomic_t *condition)
 622 {
 623         LASSERT(cfs_hash_with_spin_bktlock(hs));
 624         return atomic_dec_and_lock(condition, &bd->bd_bucket->hsb_lock.spin);
 625 }
 626
 627 static inline struct hlist_head *
 628 cfs_hash_bd_hhead(struct cfs_hash *hs, struct cfs_hash_bd *bd)
 629 {
 630         return hs->hs_hops->hop_hhead(hs, bd);
 631 }
 632
 633 struct hlist_node *
 634 cfs_hash_bd_lookup_locked(struct cfs_hash *hs, struct cfs_hash_bd *bd,
 635                           const void *key);
 636 struct hlist_node *
 637 cfs_hash_bd_peek_locked(struct cfs_hash *hs, struct cfs_hash_bd *bd,
 638                         const void *key);
 639
 640 /**
 641  * operations on cfs_hash bucket (bd: bucket descriptor),
 642  * they are safe for hash-table with rehash
 643  */
 644 void cfs_hash_dual_bd_get(struct cfs_hash *hs, const void *key,
 645                           struct cfs_hash_bd *bds);
 646 void cfs_hash_dual_bd_lock(struct cfs_hash *hs, struct cfs_hash_bd *bds,
 647                            int excl);
 648 void cfs_hash_dual_bd_unlock(struct cfs_hash *hs, struct cfs_hash_bd *bds,
 649                              int excl);
 650
 651 static inline void
 652 cfs_hash_dual_bd_get_and_lock(struct cfs_hash *hs, const void *key,
 653                               struct cfs_hash_bd *bds, int excl)
 654 {
 655         cfs_hash_dual_bd_get(hs, key, bds);
 656         cfs_hash_dual_bd_lock(hs, bds, excl);
 657 }
 658
 659 struct hlist_node *
 660 cfs_hash_dual_bd_lookup_locked(struct cfs_hash *hs, struct cfs_hash_bd *bds,
 661                                const void *key);
 662 struct hlist_node *
 663 cfs_hash_dual_bd_findadd_locked(struct cfs_hash *hs, struct cfs_hash_bd *bds,
 664                                 const void *key, struct hlist_node *hnode,
 665                                 int insist_add);
 666 struct hlist_node *
 667 cfs_hash_dual_bd_finddel_locked(struct cfs_hash *hs, struct cfs_hash_bd *bds,
 668                                 const void *key, struct hlist_node *hnode);
 669
 670 /* Hash init/cleanup functions */
 671 struct cfs_hash *
 672 cfs_hash_create(char *name, unsigned cur_bits, unsigned max_bits,
 673                 unsigned bkt_bits, unsigned extra_bytes,
 674                 unsigned min_theta, unsigned max_theta,
 675                 struct cfs_hash_ops *ops, unsigned flags);
 676
 677 struct cfs_hash *cfs_hash_getref(struct cfs_hash *hs);
 678 void cfs_hash_putref(struct cfs_hash *hs);
 679
 680 /* Hash addition functions */
 681 void cfs_hash_add(struct cfs_hash *hs, const void *key,
 682                   struct hlist_node *hnode);
 683 int cfs_hash_add_unique(struct cfs_hash *hs, const void *key,
 684                         struct hlist_node *hnode);
 685 void *cfs_hash_findadd_unique(struct cfs_hash *hs, const void *key,
 686                               struct hlist_node *hnode);
 687
 688 /* Hash deletion functions */
 689 void *cfs_hash_del(struct cfs_hash *hs, const void *key,
 690                    struct hlist_node *hnode);
 691 void *cfs_hash_del_key(struct cfs_hash *hs, const void *key);
 692
 693 /* Hash lookup/for_each functions */
 694 #define CFS_HASH_LOOP_HOG       1024
 695
 696 typedef int (*cfs_hash_for_each_cb_t)(struct cfs_hash *hs,
 697                                       struct cfs_hash_bd *bd,
 698                                       struct hlist_node *node,
 699                                       void *data);
 700 void *
 701 cfs_hash_lookup(struct cfs_hash *hs, const void *key);
 702 void
 703 cfs_hash_for_each(struct cfs_hash *hs, cfs_hash_for_each_cb_t, void *data);
 704 void
 705 cfs_hash_for_each_safe(struct cfs_hash *hs, cfs_hash_for_each_cb_t, void *data);
 706 int
 707 cfs_hash_for_each_nolock(struct cfs_hash *hs, cfs_hash_for_each_cb_t,
 708                          void *data);
 709 int
 710 cfs_hash_for_each_empty(struct cfs_hash *hs, cfs_hash_for_each_cb_t,
 711                         void *data);
 712 void
 713 cfs_hash_for_each_key(struct cfs_hash *hs, const void *key,
 714                       cfs_hash_for_each_cb_t, void *data);
 715 typedef int (*cfs_hash_cond_opt_cb_t)(void *obj, void *data);
 716 void
 717 cfs_hash_cond_del(struct cfs_hash *hs, cfs_hash_cond_opt_cb_t, void *data);
 718
 719 void
 720 cfs_hash_hlist_for_each(struct cfs_hash *hs, unsigned hindex,
 721                         cfs_hash_for_each_cb_t, void *data);
 722 int  cfs_hash_is_empty(struct cfs_hash *hs);
 723 __u64 cfs_hash_size_get(struct cfs_hash *hs);
 724
 725 /*
 726  * Rehash - Theta is calculated to be the average chained
 727  * hash depth assuming a perfectly uniform hash function.
 728  */
 729 void cfs_hash_rehash_cancel_locked(struct cfs_hash *hs);
 730 void cfs_hash_rehash_cancel(struct cfs_hash *hs);
 731 int  cfs_hash_rehash(struct cfs_hash *hs, int do_rehash);
 732 void cfs_hash_rehash_key(struct cfs_hash *hs, const void *old_key,
 733                          void *new_key, struct hlist_node *hnode);
 734
 735 #if CFS_HASH_DEBUG_LEVEL > CFS_HASH_DEBUG_1
 736 /* Validate hnode references the correct key */
 737 static inline void
 738 cfs_hash_key_validate(struct cfs_hash *hs, const void *key,
 739                       struct hlist_node *hnode)
 740 {
 741         LASSERT(cfs_hash_keycmp(hs, key, hnode));
 742 }
 743
 744 /* Validate hnode is in the correct bucket */
 745 static inline void
 746 cfs_hash_bucket_validate(struct cfs_hash *hs, struct cfs_hash_bd *bd,
 747                          struct hlist_node *hnode)
 748 {
 749         struct cfs_hash_bd bds[2];
 750
 751         cfs_hash_dual_bd_get(hs, cfs_hash_key(hs, hnode), bds);
 752         LASSERT(bds[0].bd_bucket == bd->bd_bucket ||
 753                 bds[1].bd_bucket == bd->bd_bucket);
 754 }
 755
 756 #else /* CFS_HASH_DEBUG_LEVEL > CFS_HASH_DEBUG_1 */
 757
 758 static inline void
 759 cfs_hash_key_validate(struct cfs_hash *hs, const void *key,
 760                       struct hlist_node *hnode) {}
 761
 762 static inline void
 763 cfs_hash_bucket_validate(struct cfs_hash *hs, struct cfs_hash_bd *bd,
 764                          struct hlist_node *hnode) {}
 765
 766 #endif /* CFS_HASH_DEBUG_LEVEL */
 767
 768 #define CFS_HASH_THETA_BITS     10
 769 #define CFS_HASH_MIN_THETA      (1U << (CFS_HASH_THETA_BITS - 1))
 770 #define CFS_HASH_MAX_THETA      (1U << (CFS_HASH_THETA_BITS + 1))
 771
 772 /* Return integer component of theta */
 773 static inline int __cfs_hash_theta_int(int theta)
 774 {
 775         return (theta >> CFS_HASH_THETA_BITS);
 776 }
 777
 778 /* Return a fractional value between 0 and 999 */
 779 static inline int __cfs_hash_theta_frac(int theta)
 780 {
 781         return ((theta * 1000) >> CFS_HASH_THETA_BITS) -
 782                (__cfs_hash_theta_int(theta) * 1000);
 783 }
 784
 785 static inline int __cfs_hash_theta(struct cfs_hash *hs)
 786 {
 787         return (atomic_read(&hs->hs_count) <<
 788                 CFS_HASH_THETA_BITS) >> hs->hs_cur_bits;
 789 }
 790
 791 static inline void
 792 __cfs_hash_set_theta(struct cfs_hash *hs, int min, int max)
 793 {
 794         LASSERT(min < max);
 795         hs->hs_min_theta = (__u16)min;
 796         hs->hs_max_theta = (__u16)max;
 797 }
 798
 799 /* Generic debug formatting routines mainly for proc handler */
 800 struct seq_file;
 801 void cfs_hash_debug_header(struct seq_file *m);
 802 void cfs_hash_debug_str(struct cfs_hash *hs, struct seq_file *m);
 803
 804 /*
 805  * Generic djb2 hash algorithm for character arrays.
 806  */
 807 static inline unsigned
 808 cfs_hash_djb2_hash(const void *key, size_t size, unsigned mask)
 809 {
 810         unsigned i, hash = 5381;
 811
 812         LASSERT(key != NULL);
 813
 814         for (i = 0; i < size; i++)
 815                 hash = hash * 33 + ((char *)key)[i];
 816
 817         return (hash & mask);
 818 }
 819
 820 /*
 821  * Generic u32 hash algorithm.
 822  */
 823 static inline unsigned
 824 cfs_hash_u32_hash(const __u32 key, unsigned mask)
 825 {
 826         return ((key * CFS_GOLDEN_RATIO_PRIME_32) & mask);
 827 }
 828
 829 /*
 830  * Generic u64 hash algorithm.
 831  */
 832 static inline unsigned
 833 cfs_hash_u64_hash(const __u64 key, unsigned mask)
 834 {
 835         return ((unsigned)(key * CFS_GOLDEN_RATIO_PRIME_64) & mask);
 836 }
 837
 838 /** iterate over all buckets in @bds (array of struct cfs_hash_bd) */
 839 #define cfs_hash_for_each_bd(bds, n, i) \
 840         for (i = 0; i < n && (bds)[i].bd_bucket != NULL; i++)
 841
 842 /** iterate over all buckets of @hs */
 843 #define cfs_hash_for_each_bucket(hs, bd, pos)                   \
 844         for (pos = 0;                                           \
 845              pos < CFS_HASH_NBKT(hs) &&                         \
 846              ((bd)->bd_bucket = (hs)->hs_buckets[pos]) != NULL; pos++)
 847
 848 /** iterate over all hlist of bucket @bd */
 849 #define cfs_hash_bd_for_each_hlist(hs, bd, hlist)               \
 850         for ((bd)->bd_offset = 0;                               \
 851              (bd)->bd_offset < CFS_HASH_BKT_NHLIST(hs) &&       \
 852              (hlist = cfs_hash_bd_hhead(hs, bd)) != NULL;       \
 853              (bd)->bd_offset++)
 854
 855 /* !__LIBCFS__HASH_H__ */
 856 #endif