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