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