libcfs/libcfs/hash.c

   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) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2013, 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/libcfs/hash.c
  37  *
  38  * Implement a hash class for hash process in lustre system.
  39  *
  40  * Author: YuZhangyong <yzy@clusterfs.com>
  41  *
  42  * 2008-08-15: Brian Behlendorf <behlendorf1@llnl.gov>
  43  * - Simplified API and improved documentation
  44  * - Added per-hash feature flags:
  45  *   * CFS_HASH_DEBUG additional validation
  46  *   * CFS_HASH_REHASH dynamic rehashing
  47  * - Added per-hash statistics
  48  * - General performance enhancements
  49  *
  50  * 2009-07-31: Liang Zhen <zhen.liang@sun.com>
  51  * - move all stuff to libcfs
  52  * - don't allow cur_bits != max_bits without setting of CFS_HASH_REHASH
  53  * - ignore hs_rwlock if without CFS_HASH_REHASH setting
  54  * - buckets are allocated one by one(intead of contiguous memory),
  55  *   to avoid unnecessary cacheline conflict
  56  *
  57  * 2010-03-01: Liang Zhen <zhen.liang@sun.com>
  58  * - "bucket" is a group of hlist_head now, user can speicify bucket size
  59  *   by bkt_bits of cfs_hash_create(), all hlist_heads in a bucket share
  60  *   one lock for reducing memory overhead.
  61  *
  62  * - support lockless hash, caller will take care of locks:
  63  *   avoid lock overhead for hash tables that are already protected
  64  *   by locking in the caller for another reason
  65  *
  66  * - support both spin_lock/rwlock for bucket:
  67  *   overhead of spinlock contention is lower than read/write
  68  *   contention of rwlock, so using spinlock to serialize operations on
  69  *   bucket is more reasonable for those frequently changed hash tables
  70  *
  71  * - support one-single lock mode:
  72  *   one lock to protect all hash operations to avoid overhead of
  73  *   multiple locks if hash table is always small
  74  *
  75  * - removed a lot of unnecessary addref & decref on hash element:
  76  *   addref & decref are atomic operations in many use-cases which
  77  *   are expensive.
  78  *
  79  * - support non-blocking cfs_hash_add() and cfs_hash_findadd():
  80  *   some lustre use-cases require these functions to be strictly
  81  *   non-blocking, we need to schedule required rehash on a different
  82  *   thread on those cases.
  83  *
  84  * - safer rehash on large hash table
  85  *   In old implementation, rehash function will exclusively lock the
  86  *   hash table and finish rehash in one batch, it's dangerous on SMP
  87  *   system because rehash millions of elements could take long time.
  88  *   New implemented rehash can release lock and relax CPU in middle
  89  *   of rehash, it's safe for another thread to search/change on the
  90  *   hash table even it's in rehasing.
  91  *
  92  * - support two different refcount modes
  93  *   . hash table has refcount on element
  94  *   . hash table doesn't change refcount on adding/removing element
  95  *
  96  * - support long name hash table (for param-tree)
  97  *
  98  * - fix a bug for cfs_hash_rehash_key:
  99  *   in old implementation, cfs_hash_rehash_key could screw up the
 100  *   hash-table because @key is overwritten without any protection.
 101  *   Now we need user to define hs_keycpy for those rehash enabled
 102  *   hash tables, cfs_hash_rehash_key will overwrite hash-key
 103  *   inside lock by calling hs_keycpy.
 104  *
 105  * - better hash iteration:
 106  *   Now we support both locked iteration & lockless iteration of hash
 107  *   table. Also, user can break the iteration by return 1 in callback.
 108  */
 109
 110 #include <libcfs/libcfs.h>
 111
 112 #if CFS_HASH_DEBUG_LEVEL >= CFS_HASH_DEBUG_1
 113 static unsigned int warn_on_depth = 8;
 114 CFS_MODULE_PARM(warn_on_depth, "i", uint, 0644,
 115                 "warning when hash depth is high.");
 116 #endif
 117
 118 struct cfs_wi_sched *cfs_sched_rehash;
 119
 120 static inline void
 121 cfs_hash_nl_lock(cfs_hash_lock_t *lock, int exclusive) {}
 122
 123 static inline void
 124 cfs_hash_nl_unlock(cfs_hash_lock_t *lock, int exclusive) {}
 125
 126 static inline void
 127 cfs_hash_spin_lock(cfs_hash_lock_t *lock, int exclusive)
 128 {
 129         spin_lock(&lock->spin);
 130 }
 131
 132 static inline void
 133 cfs_hash_spin_unlock(cfs_hash_lock_t *lock, int exclusive)
 134 {
 135         spin_unlock(&lock->spin);
 136 }
 137
 138 static inline void
 139 cfs_hash_rw_lock(cfs_hash_lock_t *lock, int exclusive)
 140 {
 141         if (!exclusive)
 142                 read_lock(&lock->rw);
 143         else
 144                 write_lock(&lock->rw);
 145 }
 146
 147 static inline void
 148 cfs_hash_rw_unlock(cfs_hash_lock_t *lock, int exclusive)
 149 {
 150         if (!exclusive)
 151                 read_unlock(&lock->rw);
 152         else
 153                 write_unlock(&lock->rw);
 154 }
 155
 156 /** No lock hash */
 157 static cfs_hash_lock_ops_t cfs_hash_nl_lops =
 158 {
 159         .hs_lock        = cfs_hash_nl_lock,
 160         .hs_unlock      = cfs_hash_nl_unlock,
 161         .hs_bkt_lock    = cfs_hash_nl_lock,
 162         .hs_bkt_unlock  = cfs_hash_nl_unlock,
 163 };
 164
 165 /** no bucket lock, one spinlock to protect everything */
 166 static cfs_hash_lock_ops_t cfs_hash_nbl_lops =
 167 {
 168         .hs_lock        = cfs_hash_spin_lock,
 169         .hs_unlock      = cfs_hash_spin_unlock,
 170         .hs_bkt_lock    = cfs_hash_nl_lock,
 171         .hs_bkt_unlock  = cfs_hash_nl_unlock,
 172 };
 173
 174 /** spin bucket lock, rehash is enabled */
 175 static cfs_hash_lock_ops_t cfs_hash_bkt_spin_lops =
 176 {
 177         .hs_lock        = cfs_hash_rw_lock,
 178         .hs_unlock      = cfs_hash_rw_unlock,
 179         .hs_bkt_lock    = cfs_hash_spin_lock,
 180         .hs_bkt_unlock  = cfs_hash_spin_unlock,
 181 };
 182
 183 /** rw bucket lock, rehash is enabled */
 184 static cfs_hash_lock_ops_t cfs_hash_bkt_rw_lops =
 185 {
 186         .hs_lock        = cfs_hash_rw_lock,
 187         .hs_unlock      = cfs_hash_rw_unlock,
 188         .hs_bkt_lock    = cfs_hash_rw_lock,
 189         .hs_bkt_unlock  = cfs_hash_rw_unlock,
 190 };
 191
 192 /** spin bucket lock, rehash is disabled */
 193 static cfs_hash_lock_ops_t cfs_hash_nr_bkt_spin_lops =
 194 {
 195         .hs_lock        = cfs_hash_nl_lock,
 196         .hs_unlock      = cfs_hash_nl_unlock,
 197         .hs_bkt_lock    = cfs_hash_spin_lock,
 198         .hs_bkt_unlock  = cfs_hash_spin_unlock,
 199 };
 200
 201 /** rw bucket lock, rehash is disabled */
 202 static cfs_hash_lock_ops_t cfs_hash_nr_bkt_rw_lops =
 203 {
 204         .hs_lock        = cfs_hash_nl_lock,
 205         .hs_unlock      = cfs_hash_nl_unlock,
 206         .hs_bkt_lock    = cfs_hash_rw_lock,
 207         .hs_bkt_unlock  = cfs_hash_rw_unlock,
 208 };
 209
 210 static void
 211 cfs_hash_lock_setup(cfs_hash_t *hs)
 212 {
 213         if (cfs_hash_with_no_lock(hs)) {
 214                 hs->hs_lops = &cfs_hash_nl_lops;
 215
 216         } else if (cfs_hash_with_no_bktlock(hs)) {
 217                 hs->hs_lops = &cfs_hash_nbl_lops;
 218                 spin_lock_init(&hs->hs_lock.spin);
 219
 220         } else if (cfs_hash_with_rehash(hs)) {
 221                 rwlock_init(&hs->hs_lock.rw);
 222
 223                 if (cfs_hash_with_rw_bktlock(hs))
 224                         hs->hs_lops = &cfs_hash_bkt_rw_lops;
 225                 else if (cfs_hash_with_spin_bktlock(hs))
 226                         hs->hs_lops = &cfs_hash_bkt_spin_lops;
 227                 else
 228                         LBUG();
 229         } else {
 230                 if (cfs_hash_with_rw_bktlock(hs))
 231                         hs->hs_lops = &cfs_hash_nr_bkt_rw_lops;
 232                 else if (cfs_hash_with_spin_bktlock(hs))
 233                         hs->hs_lops = &cfs_hash_nr_bkt_spin_lops;
 234                 else
 235                         LBUG();
 236         }
 237 }
 238
 239 /**
 240  * Simple hash head without depth tracking
 241  * new element is always added to head of hlist
 242  */
 243 typedef struct {
 244         struct hlist_head       hh_head;        /**< entries list */
 245 } cfs_hash_head_t;
 246
 247 static int
 248 cfs_hash_hh_hhead_size(cfs_hash_t *hs)
 249 {
 250         return sizeof(cfs_hash_head_t);
 251 }
 252
 253 static struct hlist_head *
 254 cfs_hash_hh_hhead(cfs_hash_t *hs, cfs_hash_bd_t *bd)
 255 {
 256         cfs_hash_head_t *head = (cfs_hash_head_t *)&bd->bd_bucket->hsb_head[0];
 257
 258         return &head[bd->bd_offset].hh_head;
 259 }
 260
 261 static int
 262 cfs_hash_hh_hnode_add(cfs_hash_t *hs, cfs_hash_bd_t *bd,
 263                       struct hlist_node *hnode)
 264 {
 265         hlist_add_head(hnode, cfs_hash_hh_hhead(hs, bd));
 266         return -1; /* unknown depth */
 267 }
 268
 269 static int
 270 cfs_hash_hh_hnode_del(cfs_hash_t *hs, cfs_hash_bd_t *bd,
 271                       struct hlist_node *hnode)
 272 {
 273         hlist_del_init(hnode);
 274         return -1; /* unknown depth */
 275 }
 276
 277 /**
 278  * Simple hash head with depth tracking
 279  * new element is always added to head of hlist
 280  */
 281 typedef struct {
 282         struct hlist_head       hd_head;        /**< entries list */
 283         unsigned int            hd_depth;       /**< list length */
 284 } cfs_hash_head_dep_t;
 285
 286 static int
 287 cfs_hash_hd_hhead_size(cfs_hash_t *hs)
 288 {
 289         return sizeof(cfs_hash_head_dep_t);
 290 }
 291
 292 static struct hlist_head *
 293 cfs_hash_hd_hhead(cfs_hash_t *hs, cfs_hash_bd_t *bd)
 294 {
 295         cfs_hash_head_dep_t   *head;
 296
 297         head = (cfs_hash_head_dep_t *)&bd->bd_bucket->hsb_head[0];
 298         return &head[bd->bd_offset].hd_head;
 299 }
 300
 301 static int
 302 cfs_hash_hd_hnode_add(cfs_hash_t *hs, cfs_hash_bd_t *bd,
 303                       struct hlist_node *hnode)
 304 {
 305         cfs_hash_head_dep_t *hh = container_of(cfs_hash_hd_hhead(hs, bd),
 306                                                cfs_hash_head_dep_t, hd_head);
 307         hlist_add_head(hnode, &hh->hd_head);
 308         return ++hh->hd_depth;
 309 }
 310
 311 static int
 312 cfs_hash_hd_hnode_del(cfs_hash_t *hs, cfs_hash_bd_t *bd,
 313                       struct hlist_node *hnode)
 314 {
 315         cfs_hash_head_dep_t *hh = container_of(cfs_hash_hd_hhead(hs, bd),
 316                                                cfs_hash_head_dep_t, hd_head);
 317         hlist_del_init(hnode);
 318         return --hh->hd_depth;
 319 }
 320
 321 /**
 322  * double links hash head without depth tracking
 323  * new element is always added to tail of hlist
 324  */
 325 typedef struct {
 326         struct hlist_head       dh_head;        /**< entries list */
 327         struct hlist_node       *dh_tail;       /**< the last entry */
 328 } cfs_hash_dhead_t;
 329
 330 static int
 331 cfs_hash_dh_hhead_size(cfs_hash_t *hs)
 332 {
 333         return sizeof(cfs_hash_dhead_t);
 334 }
 335
 336 static struct hlist_head *
 337 cfs_hash_dh_hhead(cfs_hash_t *hs, cfs_hash_bd_t *bd)
 338 {
 339         cfs_hash_dhead_t *head;
 340
 341         head = (cfs_hash_dhead_t *)&bd->bd_bucket->hsb_head[0];
 342         return &head[bd->bd_offset].dh_head;
 343 }
 344
 345 static int
 346 cfs_hash_dh_hnode_add(cfs_hash_t *hs, cfs_hash_bd_t *bd,
 347                       struct hlist_node *hnode)
 348 {
 349         cfs_hash_dhead_t *dh = container_of(cfs_hash_dh_hhead(hs, bd),
 350                                             cfs_hash_dhead_t, dh_head);
 351
 352         if (dh->dh_tail != NULL) /* not empty */
 353                 hlist_add_after(dh->dh_tail, hnode);
 354         else /* empty list */
 355                 hlist_add_head(hnode, &dh->dh_head);
 356         dh->dh_tail = hnode;
 357         return -1; /* unknown depth */
 358 }
 359
 360 static int
 361 cfs_hash_dh_hnode_del(cfs_hash_t *hs, cfs_hash_bd_t *bd,
 362                       struct hlist_node *hnd)
 363 {
 364         cfs_hash_dhead_t *dh = container_of(cfs_hash_dh_hhead(hs, bd),
 365                                             cfs_hash_dhead_t, dh_head);
 366
 367         if (hnd->next == NULL) { /* it's the tail */
 368                 dh->dh_tail = (hnd->pprev == &dh->dh_head.first) ? NULL :
 369                               container_of(hnd->pprev, struct hlist_node, next);
 370         }
 371         hlist_del_init(hnd);
 372         return -1; /* unknown depth */
 373 }
 374
 375 /**
 376  * double links hash head with depth tracking
 377  * new element is always added to tail of hlist
 378  */
 379 typedef struct {
 380         struct hlist_head       dd_head;        /**< entries list */
 381         struct hlist_node       *dd_tail;       /**< the last entry */
 382         unsigned int            dd_depth;       /**< list length */
 383 } cfs_hash_dhead_dep_t;
 384
 385 static int
 386 cfs_hash_dd_hhead_size(cfs_hash_t *hs)
 387 {
 388         return sizeof(cfs_hash_dhead_dep_t);
 389 }
 390
 391 static struct hlist_head *
 392 cfs_hash_dd_hhead(cfs_hash_t *hs, cfs_hash_bd_t *bd)
 393 {
 394         cfs_hash_dhead_dep_t *head;
 395
 396         head = (cfs_hash_dhead_dep_t *)&bd->bd_bucket->hsb_head[0];
 397         return &head[bd->bd_offset].dd_head;
 398 }
 399
 400 static int
 401 cfs_hash_dd_hnode_add(cfs_hash_t *hs, cfs_hash_bd_t *bd,
 402                       struct hlist_node *hnode)
 403 {
 404         cfs_hash_dhead_dep_t *dh = container_of(cfs_hash_dd_hhead(hs, bd),
 405                                                 cfs_hash_dhead_dep_t, dd_head);
 406
 407         if (dh->dd_tail != NULL) /* not empty */
 408                 hlist_add_after(dh->dd_tail, hnode);
 409         else /* empty list */
 410                 hlist_add_head(hnode, &dh->dd_head);
 411         dh->dd_tail = hnode;
 412         return ++dh->dd_depth;
 413 }
 414
 415 static int
 416 cfs_hash_dd_hnode_del(cfs_hash_t *hs, cfs_hash_bd_t *bd,
 417                       struct hlist_node *hnd)
 418 {
 419         cfs_hash_dhead_dep_t *dh = container_of(cfs_hash_dd_hhead(hs, bd),
 420                                                 cfs_hash_dhead_dep_t, dd_head);
 421
 422         if (hnd->next == NULL) { /* it's the tail */
 423                 dh->dd_tail = (hnd->pprev == &dh->dd_head.first) ? NULL :
 424                               container_of(hnd->pprev, struct hlist_node, next);
 425         }
 426         hlist_del_init(hnd);
 427         return --dh->dd_depth;
 428 }
 429
 430 static cfs_hash_hlist_ops_t cfs_hash_hh_hops = {
 431        .hop_hhead      = cfs_hash_hh_hhead,
 432        .hop_hhead_size = cfs_hash_hh_hhead_size,
 433        .hop_hnode_add  = cfs_hash_hh_hnode_add,
 434        .hop_hnode_del  = cfs_hash_hh_hnode_del,
 435 };
 436
 437 static cfs_hash_hlist_ops_t cfs_hash_hd_hops = {
 438        .hop_hhead      = cfs_hash_hd_hhead,
 439        .hop_hhead_size = cfs_hash_hd_hhead_size,
 440        .hop_hnode_add  = cfs_hash_hd_hnode_add,
 441        .hop_hnode_del  = cfs_hash_hd_hnode_del,
 442 };
 443
 444 static cfs_hash_hlist_ops_t cfs_hash_dh_hops = {
 445        .hop_hhead      = cfs_hash_dh_hhead,
 446        .hop_hhead_size = cfs_hash_dh_hhead_size,
 447        .hop_hnode_add  = cfs_hash_dh_hnode_add,
 448        .hop_hnode_del  = cfs_hash_dh_hnode_del,
 449 };
 450
 451 static cfs_hash_hlist_ops_t cfs_hash_dd_hops = {
 452        .hop_hhead      = cfs_hash_dd_hhead,
 453        .hop_hhead_size = cfs_hash_dd_hhead_size,
 454        .hop_hnode_add  = cfs_hash_dd_hnode_add,
 455        .hop_hnode_del  = cfs_hash_dd_hnode_del,
 456 };
 457
 458 static void
 459 cfs_hash_hlist_setup(cfs_hash_t *hs)
 460 {
 461         if (cfs_hash_with_add_tail(hs)) {
 462                 hs->hs_hops = cfs_hash_with_depth(hs) ?
 463                               &cfs_hash_dd_hops : &cfs_hash_dh_hops;
 464         } else {
 465                 hs->hs_hops = cfs_hash_with_depth(hs) ?
 466                               &cfs_hash_hd_hops : &cfs_hash_hh_hops;
 467         }
 468 }
 469
 470 static void
 471 cfs_hash_bd_from_key(cfs_hash_t *hs, cfs_hash_bucket_t **bkts,
 472                      unsigned int bits, const void *key, cfs_hash_bd_t *bd)
 473 {
 474         unsigned int index = cfs_hash_id(hs, key, (1U << bits) - 1);
 475
 476         LASSERT(bits == hs->hs_cur_bits || bits == hs->hs_rehash_bits);
 477
 478         bd->bd_bucket = bkts[index & ((1U << (bits - hs->hs_bkt_bits)) - 1)];
 479         bd->bd_offset = index >> (bits - hs->hs_bkt_bits);
 480 }
 481
 482 void
 483 cfs_hash_bd_get(cfs_hash_t *hs, const void *key, cfs_hash_bd_t *bd)
 484 {
 485         /* NB: caller should hold hs->hs_rwlock if REHASH is set */
 486         if (likely(hs->hs_rehash_buckets == NULL)) {
 487                 cfs_hash_bd_from_key(hs, hs->hs_buckets,
 488                                      hs->hs_cur_bits, key, bd);
 489         } else {
 490                 LASSERT(hs->hs_rehash_bits != 0);
 491                 cfs_hash_bd_from_key(hs, hs->hs_rehash_buckets,
 492                                      hs->hs_rehash_bits, key, bd);
 493         }
 494 }
 495 EXPORT_SYMBOL(cfs_hash_bd_get);
 496
 497 static inline void
 498 cfs_hash_bd_dep_record(cfs_hash_t *hs, cfs_hash_bd_t *bd, int dep_cur)
 499 {
 500         if (likely(dep_cur <= bd->bd_bucket->hsb_depmax))
 501                 return;
 502
 503         bd->bd_bucket->hsb_depmax = dep_cur;
 504 # if CFS_HASH_DEBUG_LEVEL >= CFS_HASH_DEBUG_1
 505         if (likely(warn_on_depth == 0 ||
 506                    max(warn_on_depth, hs->hs_dep_max) >= dep_cur))
 507                 return;
 508
 509         spin_lock(&hs->hs_dep_lock);
 510         hs->hs_dep_max  = dep_cur;
 511         hs->hs_dep_bkt  = bd->bd_bucket->hsb_index;
 512         hs->hs_dep_off  = bd->bd_offset;
 513         hs->hs_dep_bits = hs->hs_cur_bits;
 514         spin_unlock(&hs->hs_dep_lock);
 515
 516         cfs_wi_schedule(cfs_sched_rehash, &hs->hs_dep_wi);
 517 # endif
 518 }
 519
 520 void
 521 cfs_hash_bd_add_locked(cfs_hash_t *hs, cfs_hash_bd_t *bd,
 522                         struct hlist_node *hnode)
 523 {
 524         int rc;
 525
 526         rc = hs->hs_hops->hop_hnode_add(hs, bd, hnode);
 527         cfs_hash_bd_dep_record(hs, bd, rc);
 528         bd->bd_bucket->hsb_version++;
 529         if (unlikely(bd->bd_bucket->hsb_version == 0))
 530                 bd->bd_bucket->hsb_version++;
 531         bd->bd_bucket->hsb_count++;
 532
 533         if (cfs_hash_with_counter(hs))
 534                 atomic_inc(&hs->hs_count);
 535         if (!cfs_hash_with_no_itemref(hs))
 536                 cfs_hash_get(hs, hnode);
 537 }
 538 EXPORT_SYMBOL(cfs_hash_bd_add_locked);
 539
 540 void
 541 cfs_hash_bd_del_locked(cfs_hash_t *hs, cfs_hash_bd_t *bd,
 542                        struct hlist_node *hnode)
 543 {
 544         hs->hs_hops->hop_hnode_del(hs, bd, hnode);
 545
 546         LASSERT(bd->bd_bucket->hsb_count > 0);
 547         bd->bd_bucket->hsb_count--;
 548         bd->bd_bucket->hsb_version++;
 549         if (unlikely(bd->bd_bucket->hsb_version == 0))
 550                 bd->bd_bucket->hsb_version++;
 551
 552         if (cfs_hash_with_counter(hs)) {
 553                 LASSERT(atomic_read(&hs->hs_count) > 0);
 554                 atomic_dec(&hs->hs_count);
 555         }
 556         if (!cfs_hash_with_no_itemref(hs))
 557                 cfs_hash_put_locked(hs, hnode);
 558 }
 559 EXPORT_SYMBOL(cfs_hash_bd_del_locked);
 560
 561 void
 562 cfs_hash_bd_move_locked(cfs_hash_t *hs, cfs_hash_bd_t *bd_old,
 563                         cfs_hash_bd_t *bd_new, struct hlist_node *hnode)
 564 {
 565         cfs_hash_bucket_t *obkt = bd_old->bd_bucket;
 566         cfs_hash_bucket_t *nbkt = bd_new->bd_bucket;
 567         int                rc;
 568
 569         if (cfs_hash_bd_compare(bd_old, bd_new) == 0)
 570                 return;
 571
 572         /* use cfs_hash_bd_hnode_add/del, to avoid atomic & refcount ops
 573          * in cfs_hash_bd_del/add_locked */
 574         hs->hs_hops->hop_hnode_del(hs, bd_old, hnode);
 575         rc = hs->hs_hops->hop_hnode_add(hs, bd_new, hnode);
 576         cfs_hash_bd_dep_record(hs, bd_new, rc);
 577
 578         LASSERT(obkt->hsb_count > 0);
 579         obkt->hsb_count--;
 580         obkt->hsb_version++;
 581         if (unlikely(obkt->hsb_version == 0))
 582                 obkt->hsb_version++;
 583         nbkt->hsb_count++;
 584         nbkt->hsb_version++;
 585         if (unlikely(nbkt->hsb_version == 0))
 586                 nbkt->hsb_version++;
 587 }
 588 EXPORT_SYMBOL(cfs_hash_bd_move_locked);
 589
 590 enum {
 591         /** always set, for sanity (avoid ZERO intent) */
 592         CFS_HS_LOOKUP_MASK_FIND     = 1 << 0,
 593         /** return entry with a ref */
 594         CFS_HS_LOOKUP_MASK_REF      = 1 << 1,
 595         /** add entry if not existing */
 596         CFS_HS_LOOKUP_MASK_ADD      = 1 << 2,
 597         /** delete entry, ignore other masks */
 598         CFS_HS_LOOKUP_MASK_DEL      = 1 << 3,
 599 };
 600
 601 typedef enum cfs_hash_lookup_intent {
 602         /** return item w/o refcount */
 603         CFS_HS_LOOKUP_IT_PEEK       = CFS_HS_LOOKUP_MASK_FIND,
 604         /** return item with refcount */
 605         CFS_HS_LOOKUP_IT_FIND       = (CFS_HS_LOOKUP_MASK_FIND |
 606                                        CFS_HS_LOOKUP_MASK_REF),
 607         /** return item w/o refcount if existed, otherwise add */
 608         CFS_HS_LOOKUP_IT_ADD        = (CFS_HS_LOOKUP_MASK_FIND |
 609                                        CFS_HS_LOOKUP_MASK_ADD),
 610         /** return item with refcount if existed, otherwise add */
 611         CFS_HS_LOOKUP_IT_FINDADD    = (CFS_HS_LOOKUP_IT_FIND |
 612                                        CFS_HS_LOOKUP_MASK_ADD),
 613         /** delete if existed */
 614         CFS_HS_LOOKUP_IT_FINDDEL    = (CFS_HS_LOOKUP_MASK_FIND |
 615                                        CFS_HS_LOOKUP_MASK_DEL)
 616 } cfs_hash_lookup_intent_t;
 617
 618 static struct hlist_node *
 619 cfs_hash_bd_lookup_intent(cfs_hash_t *hs, cfs_hash_bd_t *bd,
 620                           const void *key, struct hlist_node *hnode,
 621                           cfs_hash_lookup_intent_t intent)
 622
 623 {
 624         struct hlist_head  *hhead = cfs_hash_bd_hhead(hs, bd);
 625         struct hlist_node  *ehnode;
 626         struct hlist_node  *match;
 627         int  intent_add = (intent & CFS_HS_LOOKUP_MASK_ADD) != 0;
 628
 629         /* with this function, we can avoid a lot of useless refcount ops,
 630          * which are expensive atomic operations most time. */
 631         match = intent_add ? NULL : hnode;
 632         hlist_for_each(ehnode, hhead) {
 633                 if (!cfs_hash_keycmp(hs, key, ehnode))
 634                         continue;
 635
 636                 if (match != NULL && match != ehnode) /* can't match */
 637                         continue;
 638
 639                 /* match and ... */
 640                 if ((intent & CFS_HS_LOOKUP_MASK_DEL) != 0) {
 641                         cfs_hash_bd_del_locked(hs, bd, ehnode);
 642                         return ehnode;
 643                 }
 644
 645                 /* caller wants refcount? */
 646                 if ((intent & CFS_HS_LOOKUP_MASK_REF) != 0)
 647                         cfs_hash_get(hs, ehnode);
 648                 return ehnode;
 649         }
 650         /* no match item */
 651         if (!intent_add)
 652                 return NULL;
 653
 654         LASSERT(hnode != NULL);
 655         cfs_hash_bd_add_locked(hs, bd, hnode);
 656         return hnode;
 657 }
 658
 659 struct hlist_node *
 660 cfs_hash_bd_lookup_locked(cfs_hash_t *hs, cfs_hash_bd_t *bd, const void *key)
 661 {
 662         return cfs_hash_bd_lookup_intent(hs, bd, key, NULL,
 663                                         CFS_HS_LOOKUP_IT_FIND);
 664 }
 665 EXPORT_SYMBOL(cfs_hash_bd_lookup_locked);
 666
 667 struct hlist_node *
 668 cfs_hash_bd_peek_locked(cfs_hash_t *hs, cfs_hash_bd_t *bd, const void *key)
 669 {
 670         return cfs_hash_bd_lookup_intent(hs, bd, key, NULL,
 671                                         CFS_HS_LOOKUP_IT_PEEK);
 672 }
 673 EXPORT_SYMBOL(cfs_hash_bd_peek_locked);
 674
 675 struct hlist_node *
 676 cfs_hash_bd_findadd_locked(cfs_hash_t *hs, cfs_hash_bd_t *bd,
 677                            const void *key, struct hlist_node *hnode,
 678                            int noref)
 679 {
 680         return cfs_hash_bd_lookup_intent(hs, bd, key, hnode,
 681                                         CFS_HS_LOOKUP_IT_ADD |
 682                                         (!noref * CFS_HS_LOOKUP_MASK_REF));
 683 }
 684 EXPORT_SYMBOL(cfs_hash_bd_findadd_locked);
 685
 686 struct hlist_node *
 687 cfs_hash_bd_finddel_locked(cfs_hash_t *hs, cfs_hash_bd_t *bd,
 688                            const void *key, struct hlist_node *hnode)
 689 {
 690         /* hnode can be NULL, we find the first item with @key */
 691         return cfs_hash_bd_lookup_intent(hs, bd, key, hnode,
 692                                         CFS_HS_LOOKUP_IT_FINDDEL);
 693 }
 694 EXPORT_SYMBOL(cfs_hash_bd_finddel_locked);
 695
 696 static void
 697 cfs_hash_multi_bd_lock(cfs_hash_t *hs, cfs_hash_bd_t *bds,
 698                        unsigned n, int excl)
 699 {
 700         cfs_hash_bucket_t *prev = NULL;
 701         int                i;
 702
 703         /**
 704          * bds must be ascendantly ordered by bd->bd_bucket->hsb_index.
 705          * NB: it's possible that several bds point to the same bucket but
 706          * have different bd::bd_offset, so need take care of deadlock.
 707          */
 708         cfs_hash_for_each_bd(bds, n, i) {
 709                 if (prev == bds[i].bd_bucket)
 710                         continue;
 711
 712                 LASSERT(prev == NULL ||
 713                         prev->hsb_index < bds[i].bd_bucket->hsb_index);
 714                 cfs_hash_bd_lock(hs, &bds[i], excl);
 715                 prev = bds[i].bd_bucket;
 716         }
 717 }
 718
 719 static void
 720 cfs_hash_multi_bd_unlock(cfs_hash_t *hs, cfs_hash_bd_t *bds,
 721                          unsigned n, int excl)
 722 {
 723         cfs_hash_bucket_t *prev = NULL;
 724         int                i;
 725
 726         cfs_hash_for_each_bd(bds, n, i) {
 727                 if (prev != bds[i].bd_bucket) {
 728                         cfs_hash_bd_unlock(hs, &bds[i], excl);
 729                         prev = bds[i].bd_bucket;
 730                 }
 731         }
 732 }
 733
 734 static struct hlist_node *
 735 cfs_hash_multi_bd_lookup_locked(cfs_hash_t *hs, cfs_hash_bd_t *bds,
 736                                 unsigned n, const void *key)
 737 {
 738         struct hlist_node *ehnode;
 739         unsigned          i;
 740
 741         cfs_hash_for_each_bd(bds, n, i) {
 742                 ehnode = cfs_hash_bd_lookup_intent(hs, &bds[i], key, NULL,
 743                                                         CFS_HS_LOOKUP_IT_FIND);
 744                 if (ehnode != NULL)
 745                         return ehnode;
 746         }
 747         return NULL;
 748 }
 749
 750 static struct hlist_node *
 751 cfs_hash_multi_bd_findadd_locked(cfs_hash_t *hs,
 752                                  cfs_hash_bd_t *bds, unsigned n, const void *key,
 753                                  struct hlist_node *hnode, int noref)
 754 {
 755         struct hlist_node *ehnode;
 756         int               intent;
 757         unsigned          i;
 758
 759         LASSERT(hnode != NULL);
 760         intent = CFS_HS_LOOKUP_IT_PEEK | (!noref * CFS_HS_LOOKUP_MASK_REF);
 761
 762         cfs_hash_for_each_bd(bds, n, i) {
 763                 ehnode = cfs_hash_bd_lookup_intent(hs, &bds[i], key,
 764                                                    NULL, intent);
 765                 if (ehnode != NULL)
 766                         return ehnode;
 767         }
 768
 769         if (i == 1) { /* only one bucket */
 770                 cfs_hash_bd_add_locked(hs, &bds[0], hnode);
 771         } else {
 772                 cfs_hash_bd_t      mybd;
 773
 774                 cfs_hash_bd_get(hs, key, &mybd);
 775                 cfs_hash_bd_add_locked(hs, &mybd, hnode);
 776         }
 777
 778         return hnode;
 779 }
 780
 781 static struct hlist_node *
 782 cfs_hash_multi_bd_finddel_locked(cfs_hash_t *hs, cfs_hash_bd_t *bds,
 783                                  unsigned n, const void *key,
 784                                  struct hlist_node *hnode)
 785 {
 786         struct hlist_node *ehnode;
 787         unsigned           i;
 788
 789         cfs_hash_for_each_bd(bds, n, i) {
 790                 ehnode = cfs_hash_bd_lookup_intent(hs, &bds[i], key, hnode,
 791                                                    CFS_HS_LOOKUP_IT_FINDDEL);
 792                 if (ehnode != NULL)
 793                         return ehnode;
 794         }
 795         return NULL;
 796 }
 797
 798 static void
 799 cfs_hash_bd_order(cfs_hash_bd_t *bd1, cfs_hash_bd_t *bd2)
 800 {
 801         int     rc;
 802
 803         if (bd2->bd_bucket == NULL)
 804                 return;
 805
 806         if (bd1->bd_bucket == NULL) {
 807                 *bd1 = *bd2;
 808                 bd2->bd_bucket = NULL;
 809                 return;
 810         }
 811
 812         rc = cfs_hash_bd_compare(bd1, bd2);
 813         if (rc == 0) {
 814                 bd2->bd_bucket = NULL;
 815
 816         } else if (rc > 0) { /* swab bd1 and bd2 */
 817                 cfs_hash_bd_t tmp;
 818
 819                 tmp = *bd2;
 820                 *bd2 = *bd1;
 821                 *bd1 = tmp;
 822         }
 823 }
 824
 825 void
 826 cfs_hash_dual_bd_get(cfs_hash_t *hs, const void *key, cfs_hash_bd_t *bds)
 827 {
 828         /* NB: caller should hold hs_lock.rw if REHASH is set */
 829         cfs_hash_bd_from_key(hs, hs->hs_buckets,
 830                              hs->hs_cur_bits, key, &bds[0]);
 831         if (likely(hs->hs_rehash_buckets == NULL)) {
 832                 /* no rehash or not rehashing */
 833                 bds[1].bd_bucket = NULL;
 834                 return;
 835         }
 836
 837         LASSERT(hs->hs_rehash_bits != 0);
 838         cfs_hash_bd_from_key(hs, hs->hs_rehash_buckets,
 839                              hs->hs_rehash_bits, key, &bds[1]);
 840
 841         cfs_hash_bd_order(&bds[0], &bds[1]);
 842 }
 843 EXPORT_SYMBOL(cfs_hash_dual_bd_get);
 844
 845 void
 846 cfs_hash_dual_bd_lock(cfs_hash_t *hs, cfs_hash_bd_t *bds, int excl)
 847 {
 848         cfs_hash_multi_bd_lock(hs, bds, 2, excl);
 849 }
 850 EXPORT_SYMBOL(cfs_hash_dual_bd_lock);
 851
 852 void
 853 cfs_hash_dual_bd_unlock(cfs_hash_t *hs, cfs_hash_bd_t *bds, int excl)
 854 {
 855         cfs_hash_multi_bd_unlock(hs, bds, 2, excl);
 856 }
 857 EXPORT_SYMBOL(cfs_hash_dual_bd_unlock);
 858
 859 struct hlist_node *
 860 cfs_hash_dual_bd_lookup_locked(cfs_hash_t *hs, cfs_hash_bd_t *bds,
 861                                const void *key)
 862 {
 863         return cfs_hash_multi_bd_lookup_locked(hs, bds, 2, key);
 864 }
 865 EXPORT_SYMBOL(cfs_hash_dual_bd_lookup_locked);
 866
 867 struct hlist_node *
 868 cfs_hash_dual_bd_findadd_locked(cfs_hash_t *hs, cfs_hash_bd_t *bds,
 869                                 const void *key, struct hlist_node *hnode,
 870                                 int noref)
 871 {
 872         return cfs_hash_multi_bd_findadd_locked(hs, bds, 2, key,
 873                                                 hnode, noref);
 874 }
 875 EXPORT_SYMBOL(cfs_hash_dual_bd_findadd_locked);
 876
 877 struct hlist_node *
 878 cfs_hash_dual_bd_finddel_locked(cfs_hash_t *hs, cfs_hash_bd_t *bds,
 879                                 const void *key, struct hlist_node *hnode)
 880 {
 881         return cfs_hash_multi_bd_finddel_locked(hs, bds, 2, key, hnode);
 882 }
 883 EXPORT_SYMBOL(cfs_hash_dual_bd_finddel_locked);
 884
 885 static void
 886 cfs_hash_buckets_free(cfs_hash_bucket_t **buckets,
 887                       int bkt_size, int prev_size, int size)
 888 {
 889         int     i;
 890
 891         for (i = prev_size; i < size; i++) {
 892                 if (buckets[i] != NULL)
 893                         LIBCFS_FREE(buckets[i], bkt_size);
 894         }
 895
 896         LIBCFS_FREE(buckets, sizeof(buckets[0]) * size);
 897 }
 898
 899 /*
 900  * Create or grow bucket memory. Return old_buckets if no allocation was
 901  * needed, the newly allocated buckets if allocation was needed and
 902  * successful, and NULL on error.
 903  */
 904 static cfs_hash_bucket_t **
 905 cfs_hash_buckets_realloc(cfs_hash_t *hs, cfs_hash_bucket_t **old_bkts,
 906                          unsigned int old_size, unsigned int new_size)
 907 {
 908         cfs_hash_bucket_t **new_bkts;
 909         int                 i;
 910
 911         LASSERT(old_size == 0 || old_bkts != NULL);
 912
 913         if (old_bkts != NULL && old_size == new_size)
 914                 return old_bkts;
 915
 916         LIBCFS_ALLOC(new_bkts, sizeof(new_bkts[0]) * new_size);
 917         if (new_bkts == NULL)
 918                 return NULL;
 919
 920         if (old_bkts != NULL) {
 921                 memcpy(new_bkts, old_bkts,
 922                        min(old_size, new_size) * sizeof(*old_bkts));
 923         }
 924
 925         for (i = old_size; i < new_size; i++) {
 926                 struct hlist_head *hhead;
 927                 cfs_hash_bd_t     bd;
 928
 929                 LIBCFS_ALLOC(new_bkts[i], cfs_hash_bkt_size(hs));
 930                 if (new_bkts[i] == NULL) {
 931                         cfs_hash_buckets_free(new_bkts, cfs_hash_bkt_size(hs),
 932                                               old_size, new_size);
 933                         return NULL;
 934                 }
 935
 936                 new_bkts[i]->hsb_index   = i;
 937                 new_bkts[i]->hsb_version = 1;  /* shouldn't be zero */
 938                 new_bkts[i]->hsb_depmax  = -1; /* unknown */
 939                 bd.bd_bucket = new_bkts[i];
 940                 cfs_hash_bd_for_each_hlist(hs, &bd, hhead)
 941                         INIT_HLIST_HEAD(hhead);
 942
 943                 if (cfs_hash_with_no_lock(hs) ||
 944                     cfs_hash_with_no_bktlock(hs))
 945                         continue;
 946
 947                 if (cfs_hash_with_rw_bktlock(hs))
 948                         rwlock_init(&new_bkts[i]->hsb_lock.rw);
 949                 else if (cfs_hash_with_spin_bktlock(hs))
 950                         spin_lock_init(&new_bkts[i]->hsb_lock.spin);
 951                 else
 952                         LBUG(); /* invalid use-case */
 953         }
 954         return new_bkts;
 955 }
 956
 957 /**
 958  * Initialize new libcfs hash, where:
 959  * @name     - Descriptive hash name
 960  * @cur_bits - Initial hash table size, in bits
 961  * @max_bits - Maximum allowed hash table resize, in bits
 962  * @ops      - Registered hash table operations
 963  * @flags    - CFS_HASH_REHASH enable synamic hash resizing
 964  *           - CFS_HASH_SORT enable chained hash sort
 965  */
 966 static int cfs_hash_rehash_worker(cfs_workitem_t *wi);
 967
 968 #if CFS_HASH_DEBUG_LEVEL >= CFS_HASH_DEBUG_1
 969 static int cfs_hash_dep_print(cfs_workitem_t *wi)
 970 {
 971         cfs_hash_t *hs = container_of(wi, cfs_hash_t, hs_dep_wi);
 972         int         dep;
 973         int         bkt;
 974         int         off;
 975         int         bits;
 976
 977         spin_lock(&hs->hs_dep_lock);
 978         dep  = hs->hs_dep_max;
 979         bkt  = hs->hs_dep_bkt;
 980         off  = hs->hs_dep_off;
 981         bits = hs->hs_dep_bits;
 982         spin_unlock(&hs->hs_dep_lock);
 983
 984         LCONSOLE_WARN("#### HASH %s (bits: %d): max depth %d at bucket %d/%d\n",
 985                       hs->hs_name, bits, dep, bkt, off);
 986         spin_lock(&hs->hs_dep_lock);
 987         hs->hs_dep_bits = 0; /* mark as workitem done */
 988         spin_unlock(&hs->hs_dep_lock);
 989         return 0;
 990 }
 991
 992 static void cfs_hash_depth_wi_init(cfs_hash_t *hs)
 993 {
 994         spin_lock_init(&hs->hs_dep_lock);
 995         cfs_wi_init(&hs->hs_dep_wi, hs, cfs_hash_dep_print);
 996 }
 997
 998 static void cfs_hash_depth_wi_cancel(cfs_hash_t *hs)
 999 {
1000         if (cfs_wi_deschedule(cfs_sched_rehash, &hs->hs_dep_wi))
1001                 return;
1002
1003         spin_lock(&hs->hs_dep_lock);
1004         while (hs->hs_dep_bits != 0) {
1005                 spin_unlock(&hs->hs_dep_lock);
1006                 cond_resched();
1007                 spin_lock(&hs->hs_dep_lock);
1008         }
1009         spin_unlock(&hs->hs_dep_lock);
1010 }
1011
1012 #else /* CFS_HASH_DEBUG_LEVEL < CFS_HASH_DEBUG_1 */
1013
1014 static inline void cfs_hash_depth_wi_init(cfs_hash_t *hs) {}
1015 static inline void cfs_hash_depth_wi_cancel(cfs_hash_t *hs) {}
1016
1017 #endif /* CFS_HASH_DEBUG_LEVEL >= CFS_HASH_DEBUG_1 */
1018
1019 cfs_hash_t *
1020 cfs_hash_create(char *name, unsigned cur_bits, unsigned max_bits,
1021                 unsigned bkt_bits, unsigned extra_bytes,
1022                 unsigned min_theta, unsigned max_theta,
1023                 cfs_hash_ops_t *ops, unsigned flags)
1024 {
1025         cfs_hash_t *hs;
1026         int         len;
1027
1028         ENTRY;
1029
1030         CLASSERT(CFS_HASH_THETA_BITS < 15);
1031
1032         LASSERT(name != NULL);
1033         LASSERT(ops != NULL);
1034         LASSERT(ops->hs_key);
1035         LASSERT(ops->hs_hash);
1036         LASSERT(ops->hs_object);
1037         LASSERT(ops->hs_keycmp);
1038         LASSERT(ops->hs_get != NULL);
1039         LASSERT(ops->hs_put_locked != NULL);
1040
1041         if ((flags & CFS_HASH_REHASH) != 0)
1042                 flags |= CFS_HASH_COUNTER; /* must have counter */
1043
1044         LASSERT(cur_bits > 0);
1045         LASSERT(cur_bits >= bkt_bits);
1046         LASSERT(max_bits >= cur_bits && max_bits < 31);
1047         LASSERT(ergo((flags & CFS_HASH_REHASH) == 0, cur_bits == max_bits));
1048         LASSERT(ergo((flags & CFS_HASH_REHASH) != 0,
1049                      (flags & CFS_HASH_NO_LOCK) == 0));
1050         LASSERT(ergo((flags & CFS_HASH_REHASH_KEY) != 0,
1051                       ops->hs_keycpy != NULL));
1052
1053         len = (flags & CFS_HASH_BIGNAME) == 0 ?
1054               CFS_HASH_NAME_LEN : CFS_HASH_BIGNAME_LEN;
1055         LIBCFS_ALLOC(hs, offsetof(cfs_hash_t, hs_name[len]));
1056         if (hs == NULL)
1057                 RETURN(NULL);
1058
1059         strncpy(hs->hs_name, name, len);
1060         hs->hs_name[len - 1] = '\0';
1061         hs->hs_flags = flags;
1062
1063         atomic_set(&hs->hs_refcount, 1);
1064         atomic_set(&hs->hs_count, 0);
1065
1066         cfs_hash_lock_setup(hs);
1067         cfs_hash_hlist_setup(hs);
1068
1069         hs->hs_cur_bits = (__u8)cur_bits;
1070         hs->hs_min_bits = (__u8)cur_bits;
1071         hs->hs_max_bits = (__u8)max_bits;
1072         hs->hs_bkt_bits = (__u8)bkt_bits;
1073
1074         hs->hs_ops         = ops;
1075         hs->hs_extra_bytes = extra_bytes;
1076         hs->hs_rehash_bits = 0;
1077         cfs_wi_init(&hs->hs_rehash_wi, hs, cfs_hash_rehash_worker);
1078         cfs_hash_depth_wi_init(hs);
1079
1080         if (cfs_hash_with_rehash(hs))
1081                 __cfs_hash_set_theta(hs, min_theta, max_theta);
1082
1083         hs->hs_buckets = cfs_hash_buckets_realloc(hs, NULL, 0,
1084                                                   CFS_HASH_NBKT(hs));
1085         if (hs->hs_buckets != NULL)
1086                 return hs;
1087
1088         LIBCFS_FREE(hs, offsetof(cfs_hash_t, hs_name[len]));
1089         RETURN(NULL);
1090 }
1091 EXPORT_SYMBOL(cfs_hash_create);
1092
1093 /**
1094  * Cleanup libcfs hash @hs.
1095  */
1096 static void
1097 cfs_hash_destroy(cfs_hash_t *hs)
1098 {
1099         struct hlist_node     *hnode;
1100         struct hlist_node     *pos;
1101         cfs_hash_bd_t         bd;
1102         int                   i;
1103         ENTRY;
1104
1105         LASSERT(hs != NULL);
1106         LASSERT(!cfs_hash_is_exiting(hs) &&
1107                 !cfs_hash_is_iterating(hs));
1108
1109         /**
1110          * prohibit further rehashes, don't need any lock because
1111          * I'm the only (last) one can change it.
1112          */
1113         hs->hs_exiting = 1;
1114         if (cfs_hash_with_rehash(hs))
1115                 cfs_hash_rehash_cancel(hs);
1116
1117         cfs_hash_depth_wi_cancel(hs);
1118         /* rehash should be done/canceled */
1119         LASSERT(hs->hs_buckets != NULL &&
1120                 hs->hs_rehash_buckets == NULL);
1121
1122         cfs_hash_for_each_bucket(hs, &bd, i) {
1123                 struct hlist_head *hhead;
1124
1125                 LASSERT(bd.bd_bucket != NULL);
1126                 /* no need to take this lock, just for consistent code */
1127                 cfs_hash_bd_lock(hs, &bd, 1);
1128
1129                 cfs_hash_bd_for_each_hlist(hs, &bd, hhead) {
1130                         hlist_for_each_safe(hnode, pos, hhead) {
1131                                         LASSERTF(!cfs_hash_with_assert_empty(hs),
1132                                         "hash %s bucket %u(%u) is not "
1133                                         " empty: %u items left\n",
1134                                         hs->hs_name, bd.bd_bucket->hsb_index,
1135                                         bd.bd_offset, bd.bd_bucket->hsb_count);
1136                                 /* can't assert key valicate, because we
1137                                  * can interrupt rehash */
1138                                 cfs_hash_bd_del_locked(hs, &bd, hnode);
1139                                 cfs_hash_exit(hs, hnode);
1140                         }
1141                 }
1142                 LASSERT(bd.bd_bucket->hsb_count == 0);
1143                 cfs_hash_bd_unlock(hs, &bd, 1);
1144                 cond_resched();
1145         }
1146
1147         LASSERT(atomic_read(&hs->hs_count) == 0);
1148
1149         cfs_hash_buckets_free(hs->hs_buckets, cfs_hash_bkt_size(hs),
1150                               0, CFS_HASH_NBKT(hs));
1151         i = cfs_hash_with_bigname(hs) ?
1152             CFS_HASH_BIGNAME_LEN : CFS_HASH_NAME_LEN;
1153         LIBCFS_FREE(hs, offsetof(cfs_hash_t, hs_name[i]));
1154
1155         EXIT;
1156 }
1157
1158 cfs_hash_t *cfs_hash_getref(cfs_hash_t *hs)
1159 {
1160         if (atomic_inc_not_zero(&hs->hs_refcount))
1161                 return hs;
1162         return NULL;
1163 }
1164 EXPORT_SYMBOL(cfs_hash_getref);
1165
1166 void cfs_hash_putref(cfs_hash_t *hs)
1167 {
1168         if (atomic_dec_and_test(&hs->hs_refcount))
1169                 cfs_hash_destroy(hs);
1170 }
1171 EXPORT_SYMBOL(cfs_hash_putref);
1172
1173 static inline int
1174 cfs_hash_rehash_bits(cfs_hash_t *hs)
1175 {
1176         if (cfs_hash_with_no_lock(hs) ||
1177             !cfs_hash_with_rehash(hs))
1178                 return -EOPNOTSUPP;
1179
1180         if (unlikely(cfs_hash_is_exiting(hs)))
1181                 return -ESRCH;
1182
1183         if (unlikely(cfs_hash_is_rehashing(hs)))
1184                 return -EALREADY;
1185
1186         if (unlikely(cfs_hash_is_iterating(hs)))
1187                 return -EAGAIN;
1188
1189         /* XXX: need to handle case with max_theta != 2.0
1190          *      and the case with min_theta != 0.5 */
1191         if ((hs->hs_cur_bits < hs->hs_max_bits) &&
1192             (__cfs_hash_theta(hs) > hs->hs_max_theta))
1193                 return hs->hs_cur_bits + 1;
1194
1195         if (!cfs_hash_with_shrink(hs))
1196                 return 0;
1197
1198         if ((hs->hs_cur_bits > hs->hs_min_bits) &&
1199             (__cfs_hash_theta(hs) < hs->hs_min_theta))
1200                 return hs->hs_cur_bits - 1;
1201
1202         return 0;
1203 }
1204
1205 /**
1206  * don't allow inline rehash if:
1207  * - user wants non-blocking change (add/del) on hash table
1208  * - too many elements
1209  */
1210 static inline int
1211 cfs_hash_rehash_inline(cfs_hash_t *hs)
1212 {
1213         return !cfs_hash_with_nblk_change(hs) &&
1214                atomic_read(&hs->hs_count) < CFS_HASH_LOOP_HOG;
1215 }
1216
1217 /**
1218  * Add item @hnode to libcfs hash @hs using @key.  The registered
1219  * ops->hs_get function will be called when the item is added.
1220  */
1221 void
1222 cfs_hash_add(cfs_hash_t *hs, const void *key, struct hlist_node *hnode)
1223 {
1224         cfs_hash_bd_t   bd;
1225         int             bits;
1226
1227         LASSERT(hlist_unhashed(hnode));
1228
1229         cfs_hash_lock(hs, 0);
1230         cfs_hash_bd_get_and_lock(hs, key, &bd, 1);
1231
1232         cfs_hash_key_validate(hs, key, hnode);
1233         cfs_hash_bd_add_locked(hs, &bd, hnode);
1234
1235         cfs_hash_bd_unlock(hs, &bd, 1);
1236
1237         bits = cfs_hash_rehash_bits(hs);
1238         cfs_hash_unlock(hs, 0);
1239         if (bits > 0)
1240                 cfs_hash_rehash(hs, cfs_hash_rehash_inline(hs));
1241 }
1242 EXPORT_SYMBOL(cfs_hash_add);
1243
1244 static struct hlist_node *
1245 cfs_hash_find_or_add(cfs_hash_t *hs, const void *key,
1246                      struct hlist_node *hnode, int noref)
1247 {
1248         struct hlist_node *ehnode;
1249         cfs_hash_bd_t     bds[2];
1250         int               bits = 0;
1251
1252         LASSERT(hlist_unhashed(hnode));
1253
1254         cfs_hash_lock(hs, 0);
1255         cfs_hash_dual_bd_get_and_lock(hs, key, bds, 1);
1256
1257         cfs_hash_key_validate(hs, key, hnode);
1258         ehnode = cfs_hash_dual_bd_findadd_locked(hs, bds, key,
1259                                                  hnode, noref);
1260         cfs_hash_dual_bd_unlock(hs, bds, 1);
1261
1262         if (ehnode == hnode) /* new item added */
1263                 bits = cfs_hash_rehash_bits(hs);
1264         cfs_hash_unlock(hs, 0);
1265         if (bits > 0)
1266                 cfs_hash_rehash(hs, cfs_hash_rehash_inline(hs));
1267
1268         return ehnode;
1269 }
1270
1271 /**
1272  * Add item @hnode to libcfs hash @hs using @key.  The registered
1273  * ops->hs_get function will be called if the item was added.
1274  * Returns 0 on success or -EALREADY on key collisions.
1275  */
1276 int
1277 cfs_hash_add_unique(cfs_hash_t *hs, const void *key, struct hlist_node *hnode)
1278 {
1279         return cfs_hash_find_or_add(hs, key, hnode, 1) != hnode ?
1280                -EALREADY : 0;
1281 }
1282 EXPORT_SYMBOL(cfs_hash_add_unique);
1283
1284 /**
1285  * Add item @hnode to libcfs hash @hs using @key.  If this @key
1286  * already exists in the hash then ops->hs_get will be called on the
1287  * conflicting entry and that entry will be returned to the caller.
1288  * Otherwise ops->hs_get is called on the item which was added.
1289  */
1290 void *
1291 cfs_hash_findadd_unique(cfs_hash_t *hs, const void *key,
1292                         struct hlist_node *hnode)
1293 {
1294         hnode = cfs_hash_find_or_add(hs, key, hnode, 0);
1295
1296         return cfs_hash_object(hs, hnode);
1297 }
1298 EXPORT_SYMBOL(cfs_hash_findadd_unique);
1299
1300 /**
1301  * Delete item @hnode from the libcfs hash @hs using @key.  The @key
1302  * is required to ensure the correct hash bucket is locked since there
1303  * is no direct linkage from the item to the bucket.  The object
1304  * removed from the hash will be returned and obs->hs_put is called
1305  * on the removed object.
1306  */
1307 void *
1308 cfs_hash_del(cfs_hash_t *hs, const void *key, struct hlist_node *hnode)
1309 {
1310         void           *obj  = NULL;
1311         int             bits = 0;
1312         cfs_hash_bd_t   bds[2];
1313
1314         cfs_hash_lock(hs, 0);
1315         cfs_hash_dual_bd_get_and_lock(hs, key, bds, 1);
1316
1317         /* NB: do nothing if @hnode is not in hash table */
1318         if (hnode == NULL || !hlist_unhashed(hnode)) {
1319                 if (bds[1].bd_bucket == NULL && hnode != NULL) {
1320                         cfs_hash_bd_del_locked(hs, &bds[0], hnode);
1321                 } else {
1322                         hnode = cfs_hash_dual_bd_finddel_locked(hs, bds,
1323                                                                 key, hnode);
1324                 }
1325         }
1326
1327         if (hnode != NULL) {
1328                 obj  = cfs_hash_object(hs, hnode);
1329                 bits = cfs_hash_rehash_bits(hs);
1330         }
1331
1332         cfs_hash_dual_bd_unlock(hs, bds, 1);
1333         cfs_hash_unlock(hs, 0);
1334         if (bits > 0)
1335                 cfs_hash_rehash(hs, cfs_hash_rehash_inline(hs));
1336
1337         return obj;
1338 }
1339 EXPORT_SYMBOL(cfs_hash_del);
1340
1341 /**
1342  * Delete item given @key in libcfs hash @hs.  The first @key found in
1343  * the hash will be removed, if the key exists multiple times in the hash
1344  * @hs this function must be called once per key.  The removed object
1345  * will be returned and ops->hs_put is called on the removed object.
1346  */
1347 void *
1348 cfs_hash_del_key(cfs_hash_t *hs, const void *key)
1349 {
1350         return cfs_hash_del(hs, key, NULL);
1351 }
1352 EXPORT_SYMBOL(cfs_hash_del_key);
1353
1354 /**
1355  * Lookup an item using @key in the libcfs hash @hs and return it.
1356  * If the @key is found in the hash hs->hs_get() is called and the
1357  * matching objects is returned.  It is the callers responsibility
1358  * to call the counterpart ops->hs_put using the cfs_hash_put() macro
1359  * when when finished with the object.  If the @key was not found
1360  * in the hash @hs NULL is returned.
1361  */
1362 void *
1363 cfs_hash_lookup(cfs_hash_t *hs, const void *key)
1364 {
1365         void                 *obj = NULL;
1366         struct hlist_node     *hnode;
1367         cfs_hash_bd_t         bds[2];
1368
1369         cfs_hash_lock(hs, 0);
1370         cfs_hash_dual_bd_get_and_lock(hs, key, bds, 0);
1371
1372         hnode = cfs_hash_dual_bd_lookup_locked(hs, bds, key);
1373         if (hnode != NULL)
1374                 obj = cfs_hash_object(hs, hnode);
1375
1376         cfs_hash_dual_bd_unlock(hs, bds, 0);
1377         cfs_hash_unlock(hs, 0);
1378
1379         return obj;
1380 }
1381 EXPORT_SYMBOL(cfs_hash_lookup);
1382
1383 static void
1384 cfs_hash_for_each_enter(cfs_hash_t *hs)
1385 {
1386         LASSERT(!cfs_hash_is_exiting(hs));
1387
1388         if (!cfs_hash_with_rehash(hs))
1389                 return;
1390         /*
1391          * NB: it's race on cfs_has_t::hs_iterating, but doesn't matter
1392          * because it's just an unreliable signal to rehash-thread,
1393          * rehash-thread will try to finsih rehash ASAP when seeing this.
1394          */
1395         hs->hs_iterating = 1;
1396
1397         cfs_hash_lock(hs, 1);
1398         hs->hs_iterators++;
1399
1400         /* NB: iteration is mostly called by service thread,
1401          * we tend to cancel pending rehash-requst, instead of
1402          * blocking service thread, we will relaunch rehash request
1403          * after iteration */
1404         if (cfs_hash_is_rehashing(hs))
1405                 cfs_hash_rehash_cancel_locked(hs);
1406         cfs_hash_unlock(hs, 1);
1407 }
1408
1409 static void
1410 cfs_hash_for_each_exit(cfs_hash_t *hs)
1411 {
1412         int remained;
1413         int bits;
1414
1415         if (!cfs_hash_with_rehash(hs))
1416                 return;
1417         cfs_hash_lock(hs, 1);
1418         remained = --hs->hs_iterators;
1419         bits = cfs_hash_rehash_bits(hs);
1420         cfs_hash_unlock(hs, 1);
1421         /* NB: it's race on cfs_has_t::hs_iterating, see above */
1422         if (remained == 0)
1423                 hs->hs_iterating = 0;
1424         if (bits > 0) {
1425                 cfs_hash_rehash(hs, atomic_read(&hs->hs_count) <
1426                                     CFS_HASH_LOOP_HOG);
1427         }
1428 }
1429
1430 /**
1431  * For each item in the libcfs hash @hs call the passed callback @func
1432  * and pass to it as an argument each hash item and the private @data.
1433  *
1434  * a) the function may sleep!
1435  * b) during the callback:
1436  *    . the bucket lock is held so the callback must never sleep.
1437  *    . if @removal_safe is true, use can remove current item by
1438  *      cfs_hash_bd_del_locked
1439  */
1440 static __u64
1441 cfs_hash_for_each_tight(cfs_hash_t *hs, cfs_hash_for_each_cb_t func,
1442                         void *data, int remove_safe)
1443 {
1444         struct hlist_node       *hnode;
1445         struct hlist_node       *pos;
1446         cfs_hash_bd_t           bd;
1447         __u64                   count = 0;
1448         int                     excl  = !!remove_safe;
1449         int                     loop  = 0;
1450         int                     i;
1451         ENTRY;
1452
1453         cfs_hash_for_each_enter(hs);
1454
1455         cfs_hash_lock(hs, 0);
1456         LASSERT(!cfs_hash_is_rehashing(hs));
1457
1458         cfs_hash_for_each_bucket(hs, &bd, i) {
1459                 struct hlist_head *hhead;
1460
1461                 cfs_hash_bd_lock(hs, &bd, excl);
1462                 if (func == NULL) { /* only glimpse size */
1463                         count += bd.bd_bucket->hsb_count;
1464                         cfs_hash_bd_unlock(hs, &bd, excl);
1465                         continue;
1466                 }
1467
1468                 cfs_hash_bd_for_each_hlist(hs, &bd, hhead) {
1469                         hlist_for_each_safe(hnode, pos, hhead) {
1470                                 cfs_hash_bucket_validate(hs, &bd, hnode);
1471                                 count++;
1472                                 loop++;
1473                                 if (func(hs, &bd, hnode, data)) {
1474                                         cfs_hash_bd_unlock(hs, &bd, excl);
1475                                         goto out;
1476                                 }
1477                         }
1478                 }
1479                 cfs_hash_bd_unlock(hs, &bd, excl);
1480                 if (loop < CFS_HASH_LOOP_HOG)
1481                         continue;
1482                 loop = 0;
1483                 cfs_hash_unlock(hs, 0);
1484                 cond_resched();
1485                 cfs_hash_lock(hs, 0);
1486         }
1487  out:
1488         cfs_hash_unlock(hs, 0);
1489
1490         cfs_hash_for_each_exit(hs);
1491         RETURN(count);
1492 }
1493
1494 typedef struct {
1495         cfs_hash_cond_opt_cb_t  func;
1496         void                   *arg;
1497 } cfs_hash_cond_arg_t;
1498
1499 static int
1500 cfs_hash_cond_del_locked(cfs_hash_t *hs, cfs_hash_bd_t *bd,
1501                          struct hlist_node *hnode, void *data)
1502 {
1503         cfs_hash_cond_arg_t *cond = data;
1504
1505         if (cond->func(cfs_hash_object(hs, hnode), cond->arg))
1506                 cfs_hash_bd_del_locked(hs, bd, hnode);
1507         return 0;
1508 }
1509
1510 /**
1511  * Delete item from the libcfs hash @hs when @func return true.
1512  * The write lock being hold during loop for each bucket to avoid
1513  * any object be reference.
1514  */
1515 void
1516 cfs_hash_cond_del(cfs_hash_t *hs, cfs_hash_cond_opt_cb_t func, void *data)
1517 {
1518         cfs_hash_cond_arg_t arg = {
1519                 .func   = func,
1520                 .arg    = data,
1521         };
1522
1523         cfs_hash_for_each_tight(hs, cfs_hash_cond_del_locked, &arg, 1);
1524 }
1525 EXPORT_SYMBOL(cfs_hash_cond_del);
1526
1527 void
1528 cfs_hash_for_each(cfs_hash_t *hs,
1529                   cfs_hash_for_each_cb_t func, void *data)
1530 {
1531         cfs_hash_for_each_tight(hs, func, data, 0);
1532 }
1533 EXPORT_SYMBOL(cfs_hash_for_each);
1534
1535 void
1536 cfs_hash_for_each_safe(cfs_hash_t *hs,
1537                        cfs_hash_for_each_cb_t func, void *data)
1538 {
1539         cfs_hash_for_each_tight(hs, func, data, 1);
1540 }
1541 EXPORT_SYMBOL(cfs_hash_for_each_safe);
1542
1543 static int
1544 cfs_hash_peek(cfs_hash_t *hs, cfs_hash_bd_t *bd,
1545               struct hlist_node *hnode, void *data)
1546 {
1547         *(int *)data = 0;
1548         return 1; /* return 1 to break the loop */
1549 }
1550
1551 int
1552 cfs_hash_is_empty(cfs_hash_t *hs)
1553 {
1554         int empty = 1;
1555
1556         cfs_hash_for_each_tight(hs, cfs_hash_peek, &empty, 0);
1557         return empty;
1558 }
1559 EXPORT_SYMBOL(cfs_hash_is_empty);
1560
1561 __u64
1562 cfs_hash_size_get(cfs_hash_t *hs)
1563 {
1564         return cfs_hash_with_counter(hs) ?
1565                atomic_read(&hs->hs_count) :
1566                cfs_hash_for_each_tight(hs, NULL, NULL, 0);
1567 }
1568 EXPORT_SYMBOL(cfs_hash_size_get);
1569
1570 /*
1571  * cfs_hash_for_each_relax:
1572  * Iterate the hash table and call @func on each item without
1573  * any lock. This function can't guarantee to finish iteration
1574  * if these features are enabled:
1575  *
1576  *  a. if rehash_key is enabled, an item can be moved from
1577  *     one bucket to another bucket
1578  *  b. user can remove non-zero-ref item from hash-table,
1579  *     so the item can be removed from hash-table, even worse,
1580  *     it's possible that user changed key and insert to another
1581  *     hash bucket.
1582  * there's no way for us to finish iteration correctly on previous
1583  * two cases, so iteration has to be stopped on change.
1584  */
1585 static int
1586 cfs_hash_for_each_relax(cfs_hash_t *hs, cfs_hash_for_each_cb_t func, void *data)
1587 {
1588         struct hlist_node *hnode;
1589         struct hlist_node *tmp;
1590         cfs_hash_bd_t     bd;
1591         __u32             version;
1592         int               count = 0;
1593         int               stop_on_change;
1594         int               rc;
1595         int               i;
1596         ENTRY;
1597
1598         stop_on_change = cfs_hash_with_rehash_key(hs) ||
1599                          !cfs_hash_with_no_itemref(hs) ||
1600                          CFS_HOP(hs, put_locked) == NULL;
1601         cfs_hash_lock(hs, 0);
1602         LASSERT(!cfs_hash_is_rehashing(hs));
1603
1604         cfs_hash_for_each_bucket(hs, &bd, i) {
1605                 struct hlist_head *hhead;
1606
1607                 cfs_hash_bd_lock(hs, &bd, 0);
1608                 version = cfs_hash_bd_version_get(&bd);
1609
1610                 cfs_hash_bd_for_each_hlist(hs, &bd, hhead) {
1611                         for (hnode = hhead->first; hnode != NULL;) {
1612                                 cfs_hash_bucket_validate(hs, &bd, hnode);
1613                                 cfs_hash_get(hs, hnode);
1614                                 cfs_hash_bd_unlock(hs, &bd, 0);
1615                                 cfs_hash_unlock(hs, 0);
1616
1617                                 rc = func(hs, &bd, hnode, data);
1618                                 if (stop_on_change)
1619                                         cfs_hash_put(hs, hnode);
1620                                 cond_resched();
1621                                 count++;
1622
1623                                 cfs_hash_lock(hs, 0);
1624                                 cfs_hash_bd_lock(hs, &bd, 0);
1625                                 if (!stop_on_change) {
1626                                         tmp = hnode->next;
1627                                         cfs_hash_put_locked(hs, hnode);
1628                                         hnode = tmp;
1629                                 } else { /* bucket changed? */
1630                                         if (version !=
1631                                             cfs_hash_bd_version_get(&bd))
1632                                                 break;
1633                                         /* safe to continue because no change */
1634                                         hnode = hnode->next;
1635                                 }
1636                                 if (rc) /* callback wants to break iteration */
1637                                         break;
1638                         }
1639                 }
1640                 cfs_hash_bd_unlock(hs, &bd, 0);
1641         }
1642         cfs_hash_unlock(hs, 0);
1643
1644         return count;
1645 }
1646
1647 int
1648 cfs_hash_for_each_nolock(cfs_hash_t *hs,
1649                          cfs_hash_for_each_cb_t func, void *data)
1650 {
1651         ENTRY;
1652
1653         if (cfs_hash_with_no_lock(hs) ||
1654             cfs_hash_with_rehash_key(hs) ||
1655             !cfs_hash_with_no_itemref(hs))
1656                 RETURN(-EOPNOTSUPP);
1657
1658         if (CFS_HOP(hs, get) == NULL ||
1659             (CFS_HOP(hs, put) == NULL &&
1660              CFS_HOP(hs, put_locked) == NULL))
1661                 RETURN(-EOPNOTSUPP);
1662
1663         cfs_hash_for_each_enter(hs);
1664         cfs_hash_for_each_relax(hs, func, data);
1665         cfs_hash_for_each_exit(hs);
1666
1667         RETURN(0);
1668 }
1669 EXPORT_SYMBOL(cfs_hash_for_each_nolock);
1670
1671 /**
1672  * For each hash bucket in the libcfs hash @hs call the passed callback
1673  * @func until all the hash buckets are empty.  The passed callback @func
1674  * or the previously registered callback hs->hs_put must remove the item
1675  * from the hash.  You may either use the cfs_hash_del() or hlist_del()
1676  * functions.  No rwlocks will be held during the callback @func it is
1677  * safe to sleep if needed.  This function will not terminate until the
1678  * hash is empty.  Note it is still possible to concurrently add new
1679  * items in to the hash.  It is the callers responsibility to ensure
1680  * the required locking is in place to prevent concurrent insertions.
1681  */
1682 int
1683 cfs_hash_for_each_empty(cfs_hash_t *hs,
1684                         cfs_hash_for_each_cb_t func, void *data)
1685 {
1686         unsigned  i = 0;
1687         ENTRY;
1688
1689         if (cfs_hash_with_no_lock(hs))
1690                 return -EOPNOTSUPP;
1691
1692         if (CFS_HOP(hs, get) == NULL ||
1693             (CFS_HOP(hs, put) == NULL &&
1694              CFS_HOP(hs, put_locked) == NULL))
1695                 return -EOPNOTSUPP;
1696
1697         cfs_hash_for_each_enter(hs);
1698         while (cfs_hash_for_each_relax(hs, func, data)) {
1699                 CDEBUG(D_INFO, "Try to empty hash: %s, loop: %u\n",
1700                        hs->hs_name, i++);
1701         }
1702         cfs_hash_for_each_exit(hs);
1703         RETURN(0);
1704 }
1705 EXPORT_SYMBOL(cfs_hash_for_each_empty);
1706
1707 void
1708 cfs_hash_hlist_for_each(cfs_hash_t *hs, unsigned hindex,
1709                         cfs_hash_for_each_cb_t func, void *data)
1710 {
1711         struct hlist_head *hhead;
1712         struct hlist_node *hnode;
1713         cfs_hash_bd_t      bd;
1714
1715         cfs_hash_for_each_enter(hs);
1716         cfs_hash_lock(hs, 0);
1717         if (hindex >= CFS_HASH_NHLIST(hs))
1718                 goto out;
1719
1720         cfs_hash_bd_index_set(hs, hindex, &bd);
1721
1722         cfs_hash_bd_lock(hs, &bd, 0);
1723         hhead = cfs_hash_bd_hhead(hs, &bd);
1724         hlist_for_each(hnode, hhead) {
1725                 if (func(hs, &bd, hnode, data))
1726                         break;
1727         }
1728         cfs_hash_bd_unlock(hs, &bd, 0);
1729 out:
1730         cfs_hash_unlock(hs, 0);
1731         cfs_hash_for_each_exit(hs);
1732 }
1733
1734 EXPORT_SYMBOL(cfs_hash_hlist_for_each);
1735
1736 /*
1737  * For each item in the libcfs hash @hs which matches the @key call
1738  * the passed callback @func and pass to it as an argument each hash
1739  * item and the private @data. During the callback the bucket lock
1740  * is held so the callback must never sleep.
1741    */
1742 void
1743 cfs_hash_for_each_key(cfs_hash_t *hs, const void *key,
1744                         cfs_hash_for_each_cb_t func, void *data)
1745 {
1746         struct hlist_node *hnode;
1747         cfs_hash_bd_t      bds[2];
1748         unsigned           i;
1749
1750         cfs_hash_lock(hs, 0);
1751
1752         cfs_hash_dual_bd_get_and_lock(hs, key, bds, 0);
1753
1754         cfs_hash_for_each_bd(bds, 2, i) {
1755                 struct hlist_head *hlist = cfs_hash_bd_hhead(hs, &bds[i]);
1756
1757                 hlist_for_each(hnode, hlist) {
1758                         cfs_hash_bucket_validate(hs, &bds[i], hnode);
1759
1760                         if (cfs_hash_keycmp(hs, key, hnode)) {
1761                                 if (func(hs, &bds[i], hnode, data))
1762                                         break;
1763                         }
1764                 }
1765         }
1766
1767         cfs_hash_dual_bd_unlock(hs, bds, 0);
1768         cfs_hash_unlock(hs, 0);
1769 }
1770 EXPORT_SYMBOL(cfs_hash_for_each_key);
1771
1772 /**
1773  * Rehash the libcfs hash @hs to the given @bits.  This can be used
1774  * to grow the hash size when excessive chaining is detected, or to
1775  * shrink the hash when it is larger than needed.  When the CFS_HASH_REHASH
1776  * flag is set in @hs the libcfs hash may be dynamically rehashed
1777  * during addition or removal if the hash's theta value exceeds
1778  * either the hs->hs_min_theta or hs->max_theta values.  By default
1779  * these values are tuned to keep the chained hash depth small, and
1780  * this approach assumes a reasonably uniform hashing function.  The
1781  * theta thresholds for @hs are tunable via cfs_hash_set_theta().
1782  */
1783 void
1784 cfs_hash_rehash_cancel_locked(cfs_hash_t *hs)
1785 {
1786         int     i;
1787
1788         /* need hold cfs_hash_lock(hs, 1) */
1789         LASSERT(cfs_hash_with_rehash(hs) &&
1790                 !cfs_hash_with_no_lock(hs));
1791
1792         if (!cfs_hash_is_rehashing(hs))
1793                 return;
1794
1795         if (cfs_wi_deschedule(cfs_sched_rehash, &hs->hs_rehash_wi)) {
1796                 hs->hs_rehash_bits = 0;
1797                 return;
1798         }
1799
1800         for (i = 2; cfs_hash_is_rehashing(hs); i++) {
1801                 cfs_hash_unlock(hs, 1);
1802                 /* raise console warning while waiting too long */
1803                 CDEBUG(IS_PO2(i >> 3) ? D_WARNING : D_INFO,
1804                        "hash %s is still rehashing, rescheded %d\n",
1805                        hs->hs_name, i - 1);
1806                 cond_resched();
1807                 cfs_hash_lock(hs, 1);
1808         }
1809 }
1810 EXPORT_SYMBOL(cfs_hash_rehash_cancel_locked);
1811
1812 void
1813 cfs_hash_rehash_cancel(cfs_hash_t *hs)
1814 {
1815         cfs_hash_lock(hs, 1);
1816         cfs_hash_rehash_cancel_locked(hs);
1817         cfs_hash_unlock(hs, 1);
1818 }
1819 EXPORT_SYMBOL(cfs_hash_rehash_cancel);
1820
1821 int
1822 cfs_hash_rehash(cfs_hash_t *hs, int do_rehash)
1823 {
1824         int     rc;
1825
1826         LASSERT(cfs_hash_with_rehash(hs) && !cfs_hash_with_no_lock(hs));
1827
1828         cfs_hash_lock(hs, 1);
1829
1830         rc = cfs_hash_rehash_bits(hs);
1831         if (rc <= 0) {
1832                 cfs_hash_unlock(hs, 1);
1833                 return rc;
1834         }
1835
1836         hs->hs_rehash_bits = rc;
1837         if (!do_rehash) {
1838                 /* launch and return */
1839                 cfs_wi_schedule(cfs_sched_rehash, &hs->hs_rehash_wi);
1840                 cfs_hash_unlock(hs, 1);
1841                 return 0;
1842         }
1843
1844         /* rehash right now */
1845         cfs_hash_unlock(hs, 1);
1846
1847         return cfs_hash_rehash_worker(&hs->hs_rehash_wi);
1848 }
1849 EXPORT_SYMBOL(cfs_hash_rehash);
1850
1851 static int
1852 cfs_hash_rehash_bd(cfs_hash_t *hs, cfs_hash_bd_t *old)
1853 {
1854         cfs_hash_bd_t      new;
1855         struct hlist_head *hhead;
1856         struct hlist_node *hnode;
1857         struct hlist_node *pos;
1858         void              *key;
1859         int                c = 0;
1860
1861         /* hold cfs_hash_lock(hs, 1), so don't need any bucket lock */
1862         cfs_hash_bd_for_each_hlist(hs, old, hhead) {
1863                 hlist_for_each_safe(hnode, pos, hhead) {
1864                         key = cfs_hash_key(hs, hnode);
1865                         LASSERT(key != NULL);
1866                         /* Validate hnode is in the correct bucket. */
1867                         cfs_hash_bucket_validate(hs, old, hnode);
1868                         /*
1869                          * Delete from old hash bucket; move to new bucket.
1870                          * ops->hs_key must be defined.
1871                          */
1872                         cfs_hash_bd_from_key(hs, hs->hs_rehash_buckets,
1873                                              hs->hs_rehash_bits, key, &new);
1874                         cfs_hash_bd_move_locked(hs, old, &new, hnode);
1875                         c++;
1876                 }
1877         }
1878         return c;
1879 }
1880
1881 static int
1882 cfs_hash_rehash_worker(cfs_workitem_t *wi)
1883 {
1884         cfs_hash_t         *hs = container_of(wi, cfs_hash_t, hs_rehash_wi);
1885         cfs_hash_bucket_t **bkts;
1886         cfs_hash_bd_t       bd;
1887         unsigned int        old_size;
1888         unsigned int        new_size;
1889         int                 bsize;
1890         int                 count = 0;
1891         int                 rc = 0;
1892         int                 i;
1893
1894         LASSERT (hs != NULL && cfs_hash_with_rehash(hs));
1895
1896         cfs_hash_lock(hs, 0);
1897         LASSERT(cfs_hash_is_rehashing(hs));
1898
1899         old_size = CFS_HASH_NBKT(hs);
1900         new_size = CFS_HASH_RH_NBKT(hs);
1901
1902         cfs_hash_unlock(hs, 0);
1903
1904         /*
1905          * don't need hs::hs_rwlock for hs::hs_buckets,
1906          * because nobody can change bkt-table except me.
1907          */
1908         bkts = cfs_hash_buckets_realloc(hs, hs->hs_buckets,
1909                                         old_size, new_size);
1910         cfs_hash_lock(hs, 1);
1911         if (bkts == NULL) {
1912                 rc = -ENOMEM;
1913                 goto out;
1914         }
1915
1916         if (bkts == hs->hs_buckets) {
1917                 bkts = NULL; /* do nothing */
1918                 goto out;
1919         }
1920
1921         rc = __cfs_hash_theta(hs);
1922         if ((rc >= hs->hs_min_theta) && (rc <= hs->hs_max_theta)) {
1923                 /* free the new allocated bkt-table */
1924                 old_size = new_size;
1925                 new_size = CFS_HASH_NBKT(hs);
1926                 rc = -EALREADY;
1927                 goto out;
1928         }
1929
1930         LASSERT(hs->hs_rehash_buckets == NULL);
1931         hs->hs_rehash_buckets = bkts;
1932
1933         rc = 0;
1934         cfs_hash_for_each_bucket(hs, &bd, i) {
1935                 if (cfs_hash_is_exiting(hs)) {
1936                         rc = -ESRCH;
1937                         /* someone wants to destroy the hash, abort now */
1938                         if (old_size < new_size) /* OK to free old bkt-table */
1939                                 break;
1940                         /* it's shrinking, need free new bkt-table */
1941                         hs->hs_rehash_buckets = NULL;
1942                         old_size = new_size;
1943                         new_size = CFS_HASH_NBKT(hs);
1944                         goto out;
1945                 }
1946
1947                 count += cfs_hash_rehash_bd(hs, &bd);
1948                 if (count < CFS_HASH_LOOP_HOG ||
1949                     cfs_hash_is_iterating(hs)) { /* need to finish ASAP */
1950                         continue;
1951                 }
1952
1953                 count = 0;
1954                 cfs_hash_unlock(hs, 1);
1955                 cond_resched();
1956                 cfs_hash_lock(hs, 1);
1957         }
1958
1959         hs->hs_rehash_count++;
1960
1961         bkts = hs->hs_buckets;
1962         hs->hs_buckets = hs->hs_rehash_buckets;
1963         hs->hs_rehash_buckets = NULL;
1964
1965         hs->hs_cur_bits = hs->hs_rehash_bits;
1966  out:
1967         hs->hs_rehash_bits = 0;
1968         if (rc == -ESRCH) /* never be scheduled again */
1969                 cfs_wi_exit(cfs_sched_rehash, wi);
1970         bsize = cfs_hash_bkt_size(hs);
1971         cfs_hash_unlock(hs, 1);
1972         /* can't refer to @hs anymore because it could be destroyed */
1973         if (bkts != NULL)
1974                 cfs_hash_buckets_free(bkts, bsize, new_size, old_size);
1975         if (rc != 0)
1976                 CDEBUG(D_INFO, "early quit of of rehashing: %d\n", rc);
1977         /* return 1 only if cfs_wi_exit is called */
1978         return rc == -ESRCH;
1979 }
1980
1981 /**
1982  * Rehash the object referenced by @hnode in the libcfs hash @hs.  The
1983  * @old_key must be provided to locate the objects previous location
1984  * in the hash, and the @new_key will be used to reinsert the object.
1985  * Use this function instead of a cfs_hash_add() + cfs_hash_del()
1986  * combo when it is critical that there is no window in time where the
1987  * object is missing from the hash.  When an object is being rehashed
1988  * the registered cfs_hash_get() and cfs_hash_put() functions will
1989  * not be called.
1990  */
1991 void cfs_hash_rehash_key(cfs_hash_t *hs, const void *old_key,
1992                          void *new_key, struct hlist_node *hnode)
1993 {
1994         cfs_hash_bd_t        bds[3];
1995         cfs_hash_bd_t        old_bds[2];
1996         cfs_hash_bd_t        new_bd;
1997
1998         LASSERT(!hlist_unhashed(hnode));
1999
2000         cfs_hash_lock(hs, 0);
2001
2002         cfs_hash_dual_bd_get(hs, old_key, old_bds);
2003         cfs_hash_bd_get(hs, new_key, &new_bd);
2004
2005         bds[0] = old_bds[0];
2006         bds[1] = old_bds[1];
2007         bds[2] = new_bd;
2008
2009         /* NB: bds[0] and bds[1] are ordered already */
2010         cfs_hash_bd_order(&bds[1], &bds[2]);
2011         cfs_hash_bd_order(&bds[0], &bds[1]);
2012
2013         cfs_hash_multi_bd_lock(hs, bds, 3, 1);
2014         if (likely(old_bds[1].bd_bucket == NULL)) {
2015                 cfs_hash_bd_move_locked(hs, &old_bds[0], &new_bd, hnode);
2016         } else {
2017                 cfs_hash_dual_bd_finddel_locked(hs, old_bds, old_key, hnode);
2018                 cfs_hash_bd_add_locked(hs, &new_bd, hnode);
2019         }
2020         /* overwrite key inside locks, otherwise may screw up with
2021          * other operations, i.e: rehash */
2022         cfs_hash_keycpy(hs, hnode, new_key);
2023
2024         cfs_hash_multi_bd_unlock(hs, bds, 3, 1);
2025         cfs_hash_unlock(hs, 0);
2026 }
2027 EXPORT_SYMBOL(cfs_hash_rehash_key);
2028
2029 #ifndef HAVE_ONLY_PROCFS_SEQ
2030 int cfs_hash_debug_header(char *str, int size)
2031 {
2032         return snprintf(str, size, "%-*s%6s%6s%6s%6s%6s%6s%6s%7s%8s%8s%8s%s\n",
2033                  CFS_HASH_BIGNAME_LEN,
2034                  "name", "cur", "min", "max", "theta", "t-min", "t-max",
2035                  "flags", "rehash", "count", "maxdep", "maxdepb",
2036                  " distribution");
2037 }
2038 EXPORT_SYMBOL(cfs_hash_debug_header);
2039 #endif
2040
2041 int cfs_hash_debug_header_seq(struct seq_file *m)
2042 {
2043         return seq_printf(m, "%-*s%6s%6s%6s%6s%6s%6s%6s%7s%8s%8s%8s%s\n",
2044                         CFS_HASH_BIGNAME_LEN,
2045                         "name", "cur", "min", "max", "theta", "t-min", "t-max",
2046                         "flags", "rehash", "count", "maxdep", "maxdepb",
2047                         " distribution");
2048 }
2049 EXPORT_SYMBOL(cfs_hash_debug_header_seq);
2050
2051 static cfs_hash_bucket_t **
2052 cfs_hash_full_bkts(cfs_hash_t *hs)
2053 {
2054         /* NB: caller should hold hs->hs_rwlock if REHASH is set */
2055         if (hs->hs_rehash_buckets == NULL)
2056                 return hs->hs_buckets;
2057
2058         LASSERT(hs->hs_rehash_bits != 0);
2059         return hs->hs_rehash_bits > hs->hs_cur_bits ?
2060                hs->hs_rehash_buckets : hs->hs_buckets;
2061 }
2062
2063 static unsigned int
2064 cfs_hash_full_nbkt(cfs_hash_t *hs)
2065 {
2066         /* NB: caller should hold hs->hs_rwlock if REHASH is set */
2067         if (hs->hs_rehash_buckets == NULL)
2068                 return CFS_HASH_NBKT(hs);
2069
2070         LASSERT(hs->hs_rehash_bits != 0);
2071         return hs->hs_rehash_bits > hs->hs_cur_bits ?
2072                CFS_HASH_RH_NBKT(hs) : CFS_HASH_NBKT(hs);
2073 }
2074
2075 #ifndef HAVE_ONLY_PROCFS_SEQ
2076 int cfs_hash_debug_str(cfs_hash_t *hs, char *str, int size)
2077 {
2078         int                    dist[8] = { 0, };
2079         int                    maxdep  = -1;
2080         int                    maxdepb = -1;
2081         int                    total   = 0;
2082         int                    c       = 0;
2083         int                    theta;
2084         int                    i;
2085
2086         if (str == NULL || size == 0)
2087                 return 0;
2088
2089         cfs_hash_lock(hs, 0);
2090         theta = __cfs_hash_theta(hs);
2091
2092         c += snprintf(str + c, size - c, "%-*s ",
2093                       CFS_HASH_BIGNAME_LEN, hs->hs_name);
2094         c += snprintf(str + c, size - c, "%5d ",  1 << hs->hs_cur_bits);
2095         c += snprintf(str + c, size - c, "%5d ",  1 << hs->hs_min_bits);
2096         c += snprintf(str + c, size - c, "%5d ",  1 << hs->hs_max_bits);
2097         c += snprintf(str + c, size - c, "%d.%03d ",
2098                       __cfs_hash_theta_int(theta),
2099                       __cfs_hash_theta_frac(theta));
2100         c += snprintf(str + c, size - c, "%d.%03d ",
2101                       __cfs_hash_theta_int(hs->hs_min_theta),
2102                       __cfs_hash_theta_frac(hs->hs_min_theta));
2103         c += snprintf(str + c, size - c, "%d.%03d ",
2104                       __cfs_hash_theta_int(hs->hs_max_theta),
2105                       __cfs_hash_theta_frac(hs->hs_max_theta));
2106         c += snprintf(str + c, size - c, " 0x%02x ", hs->hs_flags);
2107         c += snprintf(str + c, size - c, "%6d ", hs->hs_rehash_count);
2108
2109         /*
2110          * The distribution is a summary of the chained hash depth in
2111          * each of the libcfs hash buckets.  Each buckets hsb_count is
2112          * divided by the hash theta value and used to generate a
2113          * histogram of the hash distribution.  A uniform hash will
2114          * result in all hash buckets being close to the average thus
2115          * only the first few entries in the histogram will be non-zero.
2116          * If you hash function results in a non-uniform hash the will
2117          * be observable by outlier bucks in the distribution histogram.
2118          *
2119          * Uniform hash distribution:      128/128/0/0/0/0/0/0
2120          * Non-Uniform hash distribution:  128/125/0/0/0/0/2/1
2121          */
2122         for (i = 0; i < cfs_hash_full_nbkt(hs); i++) {
2123                 cfs_hash_bd_t  bd;
2124
2125                 bd.bd_bucket = cfs_hash_full_bkts(hs)[i];
2126                 cfs_hash_bd_lock(hs, &bd, 0);
2127                 if (maxdep < bd.bd_bucket->hsb_depmax) {
2128                         maxdep  = bd.bd_bucket->hsb_depmax;
2129 #ifdef __KERNEL__
2130                         maxdepb = ffz(~maxdep);
2131 #endif
2132                 }
2133                 total += bd.bd_bucket->hsb_count;
2134                 dist[min(fls(bd.bd_bucket->hsb_count/max(theta,1)),7)]++;
2135                 cfs_hash_bd_unlock(hs, &bd, 0);
2136         }
2137
2138         c += snprintf(str + c, size - c, "%7d ", total);
2139         c += snprintf(str + c, size - c, "%7d ", maxdep);
2140         c += snprintf(str + c, size - c, "%7d ", maxdepb);
2141         for (i = 0; i < 8; i++)
2142                 c += snprintf(str + c, size - c, "%d%c",  dist[i],
2143                               (i == 7) ? '\n' : '/');
2144
2145         cfs_hash_unlock(hs, 0);
2146
2147         return c;
2148 }
2149 EXPORT_SYMBOL(cfs_hash_debug_str);
2150 #endif
2151
2152 int cfs_hash_debug_str_seq(cfs_hash_t *hs, struct seq_file *m)
2153 {
2154         int     dist[8] = { 0, };
2155         int     maxdep  = -1;
2156         int     maxdepb = -1;
2157         int     total   = 0;
2158         int     c       = 0;
2159         int     theta;
2160         int     i;
2161
2162         cfs_hash_lock(hs, 0);
2163         theta = __cfs_hash_theta(hs);
2164
2165         c += seq_printf(m, "%-*s ", CFS_HASH_BIGNAME_LEN, hs->hs_name);
2166         c += seq_printf(m, "%5d ",  1 << hs->hs_cur_bits);
2167         c += seq_printf(m, "%5d ",  1 << hs->hs_min_bits);
2168         c += seq_printf(m, "%5d ",  1 << hs->hs_max_bits);
2169         c += seq_printf(m, "%d.%03d ", __cfs_hash_theta_int(theta),
2170                         __cfs_hash_theta_frac(theta));
2171         c += seq_printf(m, "%d.%03d ", __cfs_hash_theta_int(hs->hs_min_theta),
2172                         __cfs_hash_theta_frac(hs->hs_min_theta));
2173         c += seq_printf(m, "%d.%03d ", __cfs_hash_theta_int(hs->hs_max_theta),
2174                         __cfs_hash_theta_frac(hs->hs_max_theta));
2175         c += seq_printf(m, " 0x%02x ", hs->hs_flags);
2176         c += seq_printf(m, "%6d ", hs->hs_rehash_count);
2177
2178         /*
2179          * The distribution is a summary of the chained hash depth in
2180          * each of the libcfs hash buckets.  Each buckets hsb_count is
2181          * divided by the hash theta value and used to generate a
2182          * histogram of the hash distribution.  A uniform hash will
2183          * result in all hash buckets being close to the average thus
2184          * only the first few entries in the histogram will be non-zero.
2185          * If you hash function results in a non-uniform hash the will
2186          * be observable by outlier bucks in the distribution histogram.
2187          *
2188          * Uniform hash distribution:           128/128/0/0/0/0/0/0
2189          * Non-Uniform hash distribution:       128/125/0/0/0/0/2/1
2190          */
2191         for (i = 0; i < cfs_hash_full_nbkt(hs); i++) {
2192                 cfs_hash_bd_t bd;
2193
2194                 bd.bd_bucket = cfs_hash_full_bkts(hs)[i];
2195                 cfs_hash_bd_lock(hs, &bd, 0);
2196                 if (maxdep < bd.bd_bucket->hsb_depmax) {
2197                         maxdep  = bd.bd_bucket->hsb_depmax;
2198 #ifdef __KERNEL__
2199                         maxdepb = ffz(~maxdep);
2200 #endif
2201                 }
2202                 total += bd.bd_bucket->hsb_count;
2203                 dist[min(fls(bd.bd_bucket->hsb_count/max(theta,1)),7)]++;
2204                 cfs_hash_bd_unlock(hs, &bd, 0);
2205         }
2206
2207         c += seq_printf(m, "%7d ", total);
2208         c += seq_printf(m, "%7d ", maxdep);
2209         c += seq_printf(m, "%7d ", maxdepb);
2210         for (i = 0; i < 8; i++)
2211                 c += seq_printf(m, "%d%c",  dist[i], (i == 7) ? '\n' : '/');
2212
2213         cfs_hash_unlock(hs, 0);
2214         return c;
2215 }
2216 EXPORT_SYMBOL(cfs_hash_debug_str_seq);