lustre/obdclass/cl_object.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * Client Lustre Object.
  37  *
  38  *   Author: Nikita Danilov <nikita.danilov@sun.com>
  39  */
  40
  41 /*
  42  * Locking.
  43  *
  44  *  i_mutex
  45  *      PG_locked
  46  *          ->coh_page_guard
  47  *          ->coh_lock_guard
  48  *          ->coh_attr_guard
  49  *          ->ls_guard
  50  */
  51
  52 #define DEBUG_SUBSYSTEM S_CLASS
  53 #ifndef EXPORT_SYMTAB
  54 # define EXPORT_SYMTAB
  55 #endif
  56
  57 #include <libcfs/libcfs.h>
  58 /* class_put_type() */
  59 #include <obd_class.h>
  60 #include <obd_support.h>
  61 #include <lustre_fid.h>
  62 #include <libcfs/list.h>
  63 #include <libcfs/libcfs_hash.h> /* for cfs_hash stuff */
  64 /* lu_time_global_{init,fini}() */
  65 #include <lu_time.h>
  66
  67 #include <cl_object.h>
  68 #include "cl_internal.h"
  69
  70 static cfs_mem_cache_t *cl_env_kmem;
  71
  72 /** Lock class of cl_object_header::coh_page_guard */
  73 static cfs_lock_class_key_t cl_page_guard_class;
  74 /** Lock class of cl_object_header::coh_lock_guard */
  75 static cfs_lock_class_key_t cl_lock_guard_class;
  76 /** Lock class of cl_object_header::coh_attr_guard */
  77 static cfs_lock_class_key_t cl_attr_guard_class;
  78
  79 /**
  80  * Initialize cl_object_header.
  81  */
  82 int cl_object_header_init(struct cl_object_header *h)
  83 {
  84         int result;
  85
  86         ENTRY;
  87         result = lu_object_header_init(&h->coh_lu);
  88         if (result == 0) {
  89                 cfs_spin_lock_init(&h->coh_page_guard);
  90                 cfs_spin_lock_init(&h->coh_lock_guard);
  91                 cfs_spin_lock_init(&h->coh_attr_guard);
  92                 cfs_lockdep_set_class(&h->coh_attr_guard, &cl_page_guard_class);
  93                 cfs_lockdep_set_class(&h->coh_attr_guard, &cl_lock_guard_class);
  94                 cfs_lockdep_set_class(&h->coh_attr_guard, &cl_attr_guard_class);
  95                 h->coh_pages = 0;
  96                 /* XXX hard coded GFP_* mask. */
  97                 INIT_RADIX_TREE(&h->coh_tree, GFP_ATOMIC);
  98                 CFS_INIT_LIST_HEAD(&h->coh_locks);
  99         }
 100         RETURN(result);
 101 }
 102 EXPORT_SYMBOL(cl_object_header_init);
 103
 104 /**
 105  * Finalize cl_object_header.
 106  */
 107 void cl_object_header_fini(struct cl_object_header *h)
 108 {
 109         LASSERT(cfs_list_empty(&h->coh_locks));
 110         lu_object_header_fini(&h->coh_lu);
 111 }
 112 EXPORT_SYMBOL(cl_object_header_fini);
 113
 114 /**
 115  * Returns a cl_object with a given \a fid.
 116  *
 117  * Returns either cached or newly created object. Additional reference on the
 118  * returned object is acquired.
 119  *
 120  * \see lu_object_find(), cl_page_find(), cl_lock_find()
 121  */
 122 struct cl_object *cl_object_find(const struct lu_env *env,
 123                                  struct cl_device *cd, const struct lu_fid *fid,
 124                                  const struct cl_object_conf *c)
 125 {
 126         cfs_might_sleep();
 127         return lu2cl(lu_object_find_slice(env, cl2lu_dev(cd), fid, &c->coc_lu));
 128 }
 129 EXPORT_SYMBOL(cl_object_find);
 130
 131 /**
 132  * Releases a reference on \a o.
 133  *
 134  * When last reference is released object is returned to the cache, unless
 135  * lu_object_header_flags::LU_OBJECT_HEARD_BANSHEE bit is set in its header.
 136  *
 137  * \see cl_page_put(), cl_lock_put().
 138  */
 139 void cl_object_put(const struct lu_env *env, struct cl_object *o)
 140 {
 141         lu_object_put(env, &o->co_lu);
 142 }
 143 EXPORT_SYMBOL(cl_object_put);
 144
 145 /**
 146  * Acquire an additional reference to the object \a o.
 147  *
 148  * This can only be used to acquire _additional_ reference, i.e., caller
 149  * already has to possess at least one reference to \a o before calling this.
 150  *
 151  * \see cl_page_get(), cl_lock_get().
 152  */
 153 void cl_object_get(struct cl_object *o)
 154 {
 155         lu_object_get(&o->co_lu);
 156 }
 157 EXPORT_SYMBOL(cl_object_get);
 158
 159 /**
 160  * Returns the top-object for a given \a o.
 161  *
 162  * \see cl_page_top(), cl_io_top()
 163  */
 164 struct cl_object *cl_object_top(struct cl_object *o)
 165 {
 166         struct cl_object_header *hdr = cl_object_header(o);
 167         struct cl_object *top;
 168
 169         while (hdr->coh_parent != NULL)
 170                 hdr = hdr->coh_parent;
 171
 172         top = lu2cl(lu_object_top(&hdr->coh_lu));
 173         CDEBUG(D_TRACE, "%p -> %p\n", o, top);
 174         return top;
 175 }
 176 EXPORT_SYMBOL(cl_object_top);
 177
 178 /**
 179  * Returns pointer to the lock protecting data-attributes for the given object
 180  * \a o.
 181  *
 182  * Data-attributes are protected by the cl_object_header::coh_attr_guard
 183  * spin-lock in the top-object.
 184  *
 185  * \see cl_attr, cl_object_attr_lock(), cl_object_operations::coo_attr_get().
 186  */
 187 static cfs_spinlock_t *cl_object_attr_guard(struct cl_object *o)
 188 {
 189         return &cl_object_header(cl_object_top(o))->coh_attr_guard;
 190 }
 191
 192 /**
 193  * Locks data-attributes.
 194  *
 195  * Prevents data-attributes from changing, until lock is released by
 196  * cl_object_attr_unlock(). This has to be called before calls to
 197  * cl_object_attr_get(), cl_object_attr_set().
 198  */
 199 void cl_object_attr_lock(struct cl_object *o)
 200 {
 201         cfs_spin_lock(cl_object_attr_guard(o));
 202 }
 203 EXPORT_SYMBOL(cl_object_attr_lock);
 204
 205 /**
 206  * Releases data-attributes lock, acquired by cl_object_attr_lock().
 207  */
 208 void cl_object_attr_unlock(struct cl_object *o)
 209 {
 210         cfs_spin_unlock(cl_object_attr_guard(o));
 211 }
 212 EXPORT_SYMBOL(cl_object_attr_unlock);
 213
 214 /**
 215  * Returns data-attributes of an object \a obj.
 216  *
 217  * Every layer is asked (by calling cl_object_operations::coo_attr_get())
 218  * top-to-bottom to fill in parts of \a attr that this layer is responsible
 219  * for.
 220  */
 221 int cl_object_attr_get(const struct lu_env *env, struct cl_object *obj,
 222                        struct cl_attr *attr)
 223 {
 224         struct lu_object_header *top;
 225         int result;
 226
 227         LASSERT_SPIN_LOCKED(cl_object_attr_guard(obj));
 228         ENTRY;
 229
 230         top = obj->co_lu.lo_header;
 231         result = 0;
 232         cfs_list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
 233                 if (obj->co_ops->coo_attr_get != NULL) {
 234                         result = obj->co_ops->coo_attr_get(env, obj, attr);
 235                         if (result != 0) {
 236                                 if (result > 0)
 237                                         result = 0;
 238                                 break;
 239                         }
 240                 }
 241         }
 242         RETURN(result);
 243 }
 244 EXPORT_SYMBOL(cl_object_attr_get);
 245
 246 /**
 247  * Updates data-attributes of an object \a obj.
 248  *
 249  * Only attributes, mentioned in a validness bit-mask \a v are
 250  * updated. Calls cl_object_operations::coo_attr_set() on every layer, bottom
 251  * to top.
 252  */
 253 int cl_object_attr_set(const struct lu_env *env, struct cl_object *obj,
 254                        const struct cl_attr *attr, unsigned v)
 255 {
 256         struct lu_object_header *top;
 257         int result;
 258
 259         LASSERT_SPIN_LOCKED(cl_object_attr_guard(obj));
 260         ENTRY;
 261
 262         top = obj->co_lu.lo_header;
 263         result = 0;
 264         cfs_list_for_each_entry_reverse(obj, &top->loh_layers,
 265                                         co_lu.lo_linkage) {
 266                 if (obj->co_ops->coo_attr_set != NULL) {
 267                         result = obj->co_ops->coo_attr_set(env, obj, attr, v);
 268                         if (result != 0) {
 269                                 if (result > 0)
 270                                         result = 0;
 271                                 break;
 272                         }
 273                 }
 274         }
 275         RETURN(result);
 276 }
 277 EXPORT_SYMBOL(cl_object_attr_set);
 278
 279 /**
 280  * Notifies layers (bottom-to-top) that glimpse AST was received.
 281  *
 282  * Layers have to fill \a lvb fields with information that will be shipped
 283  * back to glimpse issuer.
 284  *
 285  * \see cl_lock_operations::clo_glimpse()
 286  */
 287 int cl_object_glimpse(const struct lu_env *env, struct cl_object *obj,
 288                       struct ost_lvb *lvb)
 289 {
 290         struct lu_object_header *top;
 291         int result;
 292
 293         ENTRY;
 294         top = obj->co_lu.lo_header;
 295         result = 0;
 296         cfs_list_for_each_entry_reverse(obj, &top->loh_layers,
 297                                         co_lu.lo_linkage) {
 298                 if (obj->co_ops->coo_glimpse != NULL) {
 299                         result = obj->co_ops->coo_glimpse(env, obj, lvb);
 300                         if (result != 0)
 301                                 break;
 302                 }
 303         }
 304         LU_OBJECT_HEADER(D_DLMTRACE, env, lu_object_top(top),
 305                          "size: "LPU64" mtime: "LPU64" atime: "LPU64" "
 306                          "ctime: "LPU64" blocks: "LPU64"\n",
 307                          lvb->lvb_size, lvb->lvb_mtime, lvb->lvb_atime,
 308                          lvb->lvb_ctime, lvb->lvb_blocks);
 309         RETURN(result);
 310 }
 311 EXPORT_SYMBOL(cl_object_glimpse);
 312
 313 /**
 314  * Updates a configuration of an object \a obj.
 315  */
 316 int cl_conf_set(const struct lu_env *env, struct cl_object *obj,
 317                 const struct cl_object_conf *conf)
 318 {
 319         struct lu_object_header *top;
 320         int result;
 321
 322         ENTRY;
 323         top = obj->co_lu.lo_header;
 324         result = 0;
 325         cfs_list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
 326                 if (obj->co_ops->coo_conf_set != NULL) {
 327                         result = obj->co_ops->coo_conf_set(env, obj, conf);
 328                         if (result != 0)
 329                                 break;
 330                 }
 331         }
 332         RETURN(result);
 333 }
 334 EXPORT_SYMBOL(cl_conf_set);
 335
 336 /**
 337  * Helper function removing all object locks, and marking object for
 338  * deletion. All object pages must have been deleted at this point.
 339  *
 340  * This is called by cl_inode_fini() and lov_object_delete() to destroy top-
 341  * and sub- objects respectively.
 342  */
 343 void cl_object_kill(const struct lu_env *env, struct cl_object *obj)
 344 {
 345         struct cl_object_header *hdr;
 346
 347         hdr = cl_object_header(obj);
 348         LASSERT(hdr->coh_tree.rnode == NULL);
 349         LASSERT(hdr->coh_pages == 0);
 350
 351         cfs_set_bit(LU_OBJECT_HEARD_BANSHEE, &hdr->coh_lu.loh_flags);
 352         /*
 353          * Destroy all locks. Object destruction (including cl_inode_fini())
 354          * cannot cancel the locks, because in the case of a local client,
 355          * where client and server share the same thread running
 356          * prune_icache(), this can dead-lock with ldlm_cancel_handler()
 357          * waiting on __wait_on_freeing_inode().
 358          */
 359         cl_locks_prune(env, obj, 0);
 360 }
 361 EXPORT_SYMBOL(cl_object_kill);
 362
 363 /**
 364  * Prunes caches of pages and locks for this object.
 365  */
 366 void cl_object_prune(const struct lu_env *env, struct cl_object *obj)
 367 {
 368         ENTRY;
 369         cl_pages_prune(env, obj);
 370         cl_locks_prune(env, obj, 1);
 371         EXIT;
 372 }
 373 EXPORT_SYMBOL(cl_object_prune);
 374
 375 /**
 376  * Check if the object has locks.
 377  */
 378 int cl_object_has_locks(struct cl_object *obj)
 379 {
 380         struct cl_object_header *head = cl_object_header(obj);
 381         int has;
 382
 383         cfs_spin_lock(&head->coh_lock_guard);
 384         has = cfs_list_empty(&head->coh_locks);
 385         cfs_spin_unlock(&head->coh_lock_guard);
 386
 387         return (has == 0);
 388 }
 389 EXPORT_SYMBOL(cl_object_has_locks);
 390
 391 void cache_stats_init(struct cache_stats *cs, const char *name)
 392 {
 393         cs->cs_name = name;
 394         cfs_atomic_set(&cs->cs_lookup, 0);
 395         cfs_atomic_set(&cs->cs_hit,    0);
 396         cfs_atomic_set(&cs->cs_total,  0);
 397         cfs_atomic_set(&cs->cs_busy,   0);
 398 }
 399
 400 int cache_stats_print(const struct cache_stats *cs,
 401                       char *page, int count, int h)
 402 {
 403         int nob = 0;
 404 /*
 405        lookup    hit  total cached create
 406   env: ...... ...... ...... ...... ......
 407 */
 408         if (h)
 409                 nob += snprintf(page, count,
 410                                 "       lookup    hit  total   busy create\n");
 411
 412         nob += snprintf(page + nob, count - nob,
 413                         "%5.5s: %6u %6u %6u %6u %6u",
 414                         cs->cs_name,
 415                         cfs_atomic_read(&cs->cs_lookup),
 416                         cfs_atomic_read(&cs->cs_hit),
 417                         cfs_atomic_read(&cs->cs_total),
 418                         cfs_atomic_read(&cs->cs_busy),
 419                         cfs_atomic_read(&cs->cs_created));
 420         return nob;
 421 }
 422
 423 /**
 424  * Initialize client site.
 425  *
 426  * Perform common initialization (lu_site_init()), and initialize statistical
 427  * counters. Also perform global initializations on the first call.
 428  */
 429 int cl_site_init(struct cl_site *s, struct cl_device *d)
 430 {
 431         int i;
 432         int result;
 433
 434         result = lu_site_init(&s->cs_lu, &d->cd_lu_dev);
 435         if (result == 0) {
 436                 cache_stats_init(&s->cs_pages, "pages");
 437                 cache_stats_init(&s->cs_locks, "locks");
 438                 for (i = 0; i < ARRAY_SIZE(s->cs_pages_state); ++i)
 439                         cfs_atomic_set(&s->cs_pages_state[0], 0);
 440                 for (i = 0; i < ARRAY_SIZE(s->cs_locks_state); ++i)
 441                         cfs_atomic_set(&s->cs_locks_state[i], 0);
 442         }
 443         return result;
 444 }
 445 EXPORT_SYMBOL(cl_site_init);
 446
 447 /**
 448  * Finalize client site. Dual to cl_site_init().
 449  */
 450 void cl_site_fini(struct cl_site *s)
 451 {
 452         lu_site_fini(&s->cs_lu);
 453 }
 454 EXPORT_SYMBOL(cl_site_fini);
 455
 456 static struct cache_stats cl_env_stats = {
 457         .cs_name    = "envs",
 458         .cs_created = CFS_ATOMIC_INIT(0),
 459         .cs_lookup  = CFS_ATOMIC_INIT(0),
 460         .cs_hit     = CFS_ATOMIC_INIT(0),
 461         .cs_total   = CFS_ATOMIC_INIT(0),
 462         .cs_busy    = CFS_ATOMIC_INIT(0)
 463 };
 464
 465 /**
 466  * Outputs client site statistical counters into a buffer. Suitable for
 467  * ll_rd_*()-style functions.
 468  */
 469 int cl_site_stats_print(const struct cl_site *site, char *page, int count)
 470 {
 471         int nob;
 472         int i;
 473         static const char *pstate[] = {
 474                 [CPS_CACHED]  = "c",
 475                 [CPS_OWNED]   = "o",
 476                 [CPS_PAGEOUT] = "w",
 477                 [CPS_PAGEIN]  = "r",
 478                 [CPS_FREEING] = "f"
 479         };
 480         static const char *lstate[] = {
 481                 [CLS_NEW]       = "n",
 482                 [CLS_QUEUING]   = "q",
 483                 [CLS_ENQUEUED]  = "e",
 484                 [CLS_HELD]      = "h",
 485                 [CLS_INTRANSIT] = "t",
 486                 [CLS_CACHED]    = "c",
 487                 [CLS_FREEING]   = "f"
 488         };
 489 /*
 490        lookup    hit  total   busy create
 491 pages: ...... ...... ...... ...... ...... [...... ...... ...... ......]
 492 locks: ...... ...... ...... ...... ...... [...... ...... ...... ...... ......]
 493   env: ...... ...... ...... ...... ......
 494  */
 495         nob = lu_site_stats_print(&site->cs_lu, page, count);
 496         nob += cache_stats_print(&site->cs_pages, page + nob, count - nob, 1);
 497         nob += snprintf(page + nob, count - nob, " [");
 498         for (i = 0; i < ARRAY_SIZE(site->cs_pages_state); ++i)
 499                 nob += snprintf(page + nob, count - nob, "%s: %u ",
 500                                 pstate[i],
 501                                 cfs_atomic_read(&site->cs_pages_state[i]));
 502         nob += snprintf(page + nob, count - nob, "]\n");
 503         nob += cache_stats_print(&site->cs_locks, page + nob, count - nob, 0);
 504         nob += snprintf(page + nob, count - nob, " [");
 505         for (i = 0; i < ARRAY_SIZE(site->cs_locks_state); ++i)
 506                 nob += snprintf(page + nob, count - nob, "%s: %u ",
 507                                 lstate[i],
 508                                 cfs_atomic_read(&site->cs_locks_state[i]));
 509         nob += snprintf(page + nob, count - nob, "]\n");
 510         nob += cache_stats_print(&cl_env_stats, page + nob, count - nob, 0);
 511         nob += snprintf(page + nob, count - nob, "\n");
 512         return nob;
 513 }
 514 EXPORT_SYMBOL(cl_site_stats_print);
 515
 516 /*****************************************************************************
 517  *
 518  * lu_env handling on client.
 519  *
 520  */
 521
 522 /**
 523  * The most efficient way is to store cl_env pointer in task specific
 524  * structures. On Linux, it wont' be easy to use task_struct->journal_info
 525  * because Lustre code may call into other fs which has certain assumptions
 526  * about journal_info. Currently following fields in task_struct are identified
 527  * can be used for this purpose:
 528  *  - cl_env: for liblustre.
 529  *  - tux_info: ony on RedHat kernel.
 530  *  - ...
 531  * \note As long as we use task_struct to store cl_env, we assume that once
 532  * called into Lustre, we'll never call into the other part of the kernel
 533  * which will use those fields in task_struct without explicitly exiting
 534  * Lustre.
 535  *
 536  * If there's no space in task_struct is available, hash will be used.
 537  * bz20044, bz22683.
 538  */
 539
 540 static CFS_LIST_HEAD(cl_envs);
 541 static unsigned cl_envs_cached_nr  = 0;
 542 static unsigned cl_envs_cached_max = 128; /* XXX: prototype: arbitrary limit
 543                                            * for now. */
 544 static cfs_spinlock_t cl_envs_guard = CFS_SPIN_LOCK_UNLOCKED;
 545
 546 struct cl_env {
 547         void             *ce_magic;
 548         struct lu_env     ce_lu;
 549         struct lu_context ce_ses;
 550
 551 #ifdef LL_TASK_CL_ENV
 552         void             *ce_prev;
 553 #else
 554         /**
 555          * This allows cl_env to be entered into cl_env_hash which implements
 556          * the current thread -> client environment lookup.
 557          */
 558         cfs_hlist_node_t  ce_node;
 559 #endif
 560         /**
 561          * Owner for the current cl_env.
 562          *
 563          * If LL_TASK_CL_ENV is defined, this point to the owning cfs_current(),
 564          * only for debugging purpose ;
 565          * Otherwise hash is used, and this is the key for cfs_hash.
 566          * Now current thread pid is stored. Note using thread pointer would
 567          * lead to unbalanced hash because of its specific allocation locality
 568          * and could be varied for different platforms and OSes, even different
 569          * OS versions.
 570          */
 571         void             *ce_owner;
 572
 573         /*
 574          * Linkage into global list of all client environments. Used for
 575          * garbage collection.
 576          */
 577         cfs_list_t        ce_linkage;
 578         /*
 579          *
 580          */
 581         int               ce_ref;
 582         /*
 583          * Debugging field: address of the caller who made original
 584          * allocation.
 585          */
 586         void             *ce_debug;
 587 };
 588
 589 #define CL_ENV_INC(counter) cfs_atomic_inc(&cl_env_stats.counter)
 590
 591 #define CL_ENV_DEC(counter)                                             \
 592         do {                                                            \
 593                 LASSERT(cfs_atomic_read(&cl_env_stats.counter) > 0);    \
 594                 cfs_atomic_dec(&cl_env_stats.counter);                  \
 595         } while (0)
 596
 597 static void cl_env_init0(struct cl_env *cle, void *debug)
 598 {
 599         LASSERT(cle->ce_ref == 0);
 600         LASSERT(cle->ce_magic == &cl_env_init0);
 601         LASSERT(cle->ce_debug == NULL && cle->ce_owner == NULL);
 602
 603         cle->ce_ref = 1;
 604         cle->ce_debug = debug;
 605         CL_ENV_INC(cs_busy);
 606 }
 607
 608
 609 #ifndef LL_TASK_CL_ENV
 610 /*
 611  * The implementation of using hash table to connect cl_env and thread
 612  */
 613
 614 static cfs_hash_t *cl_env_hash;
 615
 616 static unsigned cl_env_hops_hash(cfs_hash_t *lh, void *key, unsigned mask)
 617 {
 618 #if BITS_PER_LONG == 64
 619         return cfs_hash_u64_hash((__u64)key, mask);
 620 #else
 621         return cfs_hash_u32_hash((__u32)key, mask);
 622 #endif
 623 }
 624
 625 static void *cl_env_hops_obj(cfs_hlist_node_t *hn)
 626 {
 627         struct cl_env *cle = cfs_hlist_entry(hn, struct cl_env, ce_node);
 628         LASSERT(cle->ce_magic == &cl_env_init0);
 629         return (void *)cle;
 630 }
 631
 632 static int cl_env_hops_keycmp(void *key, cfs_hlist_node_t *hn)
 633 {
 634         struct cl_env *cle = cl_env_hops_obj(hn);
 635
 636         LASSERT(cle->ce_owner != NULL);
 637         return (key == cle->ce_owner);
 638 }
 639
 640 static void cl_env_hops_noop(cfs_hash_t *hs, cfs_hlist_node_t *hn)
 641 {
 642         struct cl_env *cle = cfs_hlist_entry(hn, struct cl_env, ce_node);
 643         LASSERT(cle->ce_magic == &cl_env_init0);
 644 }
 645
 646 static cfs_hash_ops_t cl_env_hops = {
 647         .hs_hash        = cl_env_hops_hash,
 648         .hs_key         = cl_env_hops_obj,
 649         .hs_keycmp      = cl_env_hops_keycmp,
 650         .hs_object      = cl_env_hops_obj,
 651         .hs_get         = cl_env_hops_noop,
 652         .hs_put_locked  = cl_env_hops_noop,
 653 };
 654
 655 static inline struct cl_env *cl_env_fetch(void)
 656 {
 657         struct cl_env *cle;
 658
 659         cle = cfs_hash_lookup(cl_env_hash, (void *) (long) cfs_current()->pid);
 660         LASSERT(ergo(cle, cle->ce_magic == &cl_env_init0));
 661         return cle;
 662 }
 663
 664 static inline void cl_env_attach(struct cl_env *cle)
 665 {
 666         if (cle) {
 667                 int rc;
 668
 669                 LASSERT(cle->ce_owner == NULL);
 670                 cle->ce_owner = (void *) (long) cfs_current()->pid;
 671                 rc = cfs_hash_add_unique(cl_env_hash, cle->ce_owner,
 672                                          &cle->ce_node);
 673                 LASSERT(rc == 0);
 674         }
 675 }
 676
 677 static inline void cl_env_do_detach(struct cl_env *cle)
 678 {
 679         void *cookie;
 680
 681         LASSERT(cle->ce_owner == (void *) (long) cfs_current()->pid);
 682         cookie = cfs_hash_del(cl_env_hash, cle->ce_owner,
 683                               &cle->ce_node);
 684         LASSERT(cookie == cle);
 685         cle->ce_owner = NULL;
 686 }
 687
 688 static int cl_env_store_init(void) {
 689         cl_env_hash = cfs_hash_create("cl_env",
 690                                       HASH_CL_ENV_BITS, HASH_CL_ENV_BITS,
 691                                       HASH_CL_ENV_BKT_BITS, 0,
 692                                       CFS_HASH_MIN_THETA,
 693                                       CFS_HASH_MAX_THETA,
 694                                       &cl_env_hops,
 695                                       CFS_HASH_RW_BKTLOCK);
 696         return cl_env_hash != NULL ? 0 :-ENOMEM;
 697 }
 698
 699 static void cl_env_store_fini(void) {
 700         cfs_hash_putref(cl_env_hash);
 701 }
 702
 703 #else /* LL_TASK_CL_ENV */
 704 /*
 705  * The implementation of store cl_env directly in thread structure.
 706  */
 707
 708 static inline struct cl_env *cl_env_fetch(void)
 709 {
 710         struct cl_env *cle;
 711
 712         cle = cfs_current()->LL_TASK_CL_ENV;
 713         if (cle && cle->ce_magic != &cl_env_init0)
 714                 cle = NULL;
 715         return cle;
 716 }
 717
 718 static inline void cl_env_attach(struct cl_env *cle)
 719 {
 720         if (cle) {
 721                 LASSERT(cle->ce_owner == NULL);
 722                 cle->ce_owner = cfs_current();
 723                 cle->ce_prev = cfs_current()->LL_TASK_CL_ENV;
 724                 cfs_current()->LL_TASK_CL_ENV = cle;
 725         }
 726 }
 727
 728 static inline void cl_env_do_detach(struct cl_env *cle)
 729 {
 730         LASSERT(cle->ce_owner == cfs_current());
 731         LASSERT(cfs_current()->LL_TASK_CL_ENV == cle);
 732         cfs_current()->LL_TASK_CL_ENV = cle->ce_prev;
 733         cle->ce_owner = NULL;
 734 }
 735
 736 static int cl_env_store_init(void) { return 0; }
 737 static void cl_env_store_fini(void) { }
 738
 739 #endif /* LL_TASK_CL_ENV */
 740
 741 static inline struct cl_env *cl_env_detach(struct cl_env *cle)
 742 {
 743         if (cle == NULL)
 744                 cle = cl_env_fetch();
 745
 746         if (cle && cle->ce_owner)
 747                 cl_env_do_detach(cle);
 748
 749         return cle;
 750 }
 751
 752 static struct lu_env *cl_env_new(__u32 tags, void *debug)
 753 {
 754         struct lu_env *env;
 755         struct cl_env *cle;
 756
 757         OBD_SLAB_ALLOC_PTR_GFP(cle, cl_env_kmem, CFS_ALLOC_IO);
 758         if (cle != NULL) {
 759                 int rc;
 760
 761                 CFS_INIT_LIST_HEAD(&cle->ce_linkage);
 762                 cle->ce_magic = &cl_env_init0;
 763                 env = &cle->ce_lu;
 764                 rc = lu_env_init(env, LCT_CL_THREAD|tags);
 765                 if (rc == 0) {
 766                         rc = lu_context_init(&cle->ce_ses, LCT_SESSION|tags);
 767                         if (rc == 0) {
 768                                 lu_context_enter(&cle->ce_ses);
 769                                 env->le_ses = &cle->ce_ses;
 770                                 cl_env_init0(cle, debug);
 771                         } else
 772                                 lu_env_fini(env);
 773                 }
 774                 if (rc != 0) {
 775                         OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
 776                         env = ERR_PTR(rc);
 777                 } else {
 778                         CL_ENV_INC(cs_created);
 779                         CL_ENV_INC(cs_total);
 780                 }
 781         } else
 782                 env = ERR_PTR(-ENOMEM);
 783         return env;
 784 }
 785
 786 static void cl_env_fini(struct cl_env *cle)
 787 {
 788         CL_ENV_DEC(cs_total);
 789         lu_context_fini(&cle->ce_lu.le_ctx);
 790         lu_context_fini(&cle->ce_ses);
 791         OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
 792 }
 793
 794 static struct lu_env *cl_env_obtain(void *debug)
 795 {
 796         struct cl_env *cle;
 797         struct lu_env *env;
 798
 799         ENTRY;
 800         cfs_spin_lock(&cl_envs_guard);
 801         LASSERT(equi(cl_envs_cached_nr == 0, cfs_list_empty(&cl_envs)));
 802         if (cl_envs_cached_nr > 0) {
 803                 int rc;
 804
 805                 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
 806                 cfs_list_del_init(&cle->ce_linkage);
 807                 cl_envs_cached_nr--;
 808                 cfs_spin_unlock(&cl_envs_guard);
 809
 810                 env = &cle->ce_lu;
 811                 rc = lu_env_refill(env);
 812                 if (rc == 0) {
 813                         cl_env_init0(cle, debug);
 814                         lu_context_enter(&env->le_ctx);
 815                         lu_context_enter(&cle->ce_ses);
 816                 } else {
 817                         cl_env_fini(cle);
 818                         env = ERR_PTR(rc);
 819                 }
 820         } else {
 821                 cfs_spin_unlock(&cl_envs_guard);
 822                 env = cl_env_new(0, debug);
 823         }
 824         RETURN(env);
 825 }
 826
 827 static inline struct cl_env *cl_env_container(struct lu_env *env)
 828 {
 829         return container_of(env, struct cl_env, ce_lu);
 830 }
 831
 832 struct lu_env *cl_env_peek(int *refcheck)
 833 {
 834         struct lu_env *env;
 835         struct cl_env *cle;
 836
 837         CL_ENV_INC(cs_lookup);
 838
 839         /* check that we don't go far from untrusted pointer */
 840         CLASSERT(offsetof(struct cl_env, ce_magic) == 0);
 841
 842         env = NULL;
 843         cle = cl_env_fetch();
 844         if (cle != NULL) {
 845                 CL_ENV_INC(cs_hit);
 846                 env = &cle->ce_lu;
 847                 *refcheck = ++cle->ce_ref;
 848         }
 849         CDEBUG(D_OTHER, "%d@%p\n", cle ? cle->ce_ref : 0, cle);
 850         return env;
 851 }
 852 EXPORT_SYMBOL(cl_env_peek);
 853
 854 /**
 855  * Returns lu_env: if there already is an environment associated with the
 856  * current thread, it is returned, otherwise, new environment is allocated.
 857  *
 858  * Allocations are amortized through the global cache of environments.
 859  *
 860  * \param refcheck pointer to a counter used to detect environment leaks. In
 861  * the usual case cl_env_get() and cl_env_put() are called in the same lexical
 862  * scope and pointer to the same integer is passed as \a refcheck. This is
 863  * used to detect missed cl_env_put().
 864  *
 865  * \see cl_env_put()
 866  */
 867 struct lu_env *cl_env_get(int *refcheck)
 868 {
 869         struct lu_env *env;
 870
 871         env = cl_env_peek(refcheck);
 872         if (env == NULL) {
 873                 env = cl_env_obtain(__builtin_return_address(0));
 874                 if (!IS_ERR(env)) {
 875                         struct cl_env *cle;
 876
 877                         cle = cl_env_container(env);
 878                         cl_env_attach(cle);
 879                         *refcheck = cle->ce_ref;
 880                         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 881                 }
 882         }
 883         return env;
 884 }
 885 EXPORT_SYMBOL(cl_env_get);
 886
 887 /**
 888  * Forces an allocation of a fresh environment with given tags.
 889  *
 890  * \see cl_env_get()
 891  */
 892 struct lu_env *cl_env_alloc(int *refcheck, __u32 tags)
 893 {
 894         struct lu_env *env;
 895
 896         LASSERT(cl_env_peek(refcheck) == NULL);
 897         env = cl_env_new(tags, __builtin_return_address(0));
 898         if (!IS_ERR(env)) {
 899                 struct cl_env *cle;
 900
 901                 cle = cl_env_container(env);
 902                 *refcheck = cle->ce_ref;
 903                 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 904         }
 905         return env;
 906 }
 907 EXPORT_SYMBOL(cl_env_alloc);
 908
 909 static void cl_env_exit(struct cl_env *cle)
 910 {
 911         LASSERT(cle->ce_owner == NULL);
 912         lu_context_exit(&cle->ce_lu.le_ctx);
 913         lu_context_exit(&cle->ce_ses);
 914 }
 915
 916 /**
 917  * Finalizes and frees a given number of cached environments. This is done to
 918  * (1) free some memory (not currently hooked into VM), or (2) release
 919  * references to modules.
 920  */
 921 unsigned cl_env_cache_purge(unsigned nr)
 922 {
 923         struct cl_env *cle;
 924
 925         ENTRY;
 926         cfs_spin_lock(&cl_envs_guard);
 927         for (; !cfs_list_empty(&cl_envs) && nr > 0; --nr) {
 928                 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
 929                 cfs_list_del_init(&cle->ce_linkage);
 930                 LASSERT(cl_envs_cached_nr > 0);
 931                 cl_envs_cached_nr--;
 932                 cfs_spin_unlock(&cl_envs_guard);
 933
 934                 cl_env_fini(cle);
 935                 cfs_spin_lock(&cl_envs_guard);
 936         }
 937         LASSERT(equi(cl_envs_cached_nr == 0, cfs_list_empty(&cl_envs)));
 938         cfs_spin_unlock(&cl_envs_guard);
 939         RETURN(nr);
 940 }
 941 EXPORT_SYMBOL(cl_env_cache_purge);
 942
 943 /**
 944  * Release an environment.
 945  *
 946  * Decrement \a env reference counter. When counter drops to 0, nothing in
 947  * this thread is using environment and it is returned to the allocation
 948  * cache, or freed straight away, if cache is large enough.
 949  */
 950 void cl_env_put(struct lu_env *env, int *refcheck)
 951 {
 952         struct cl_env *cle;
 953
 954         cle = cl_env_container(env);
 955
 956         LASSERT(cle->ce_ref > 0);
 957         LASSERT(ergo(refcheck != NULL, cle->ce_ref == *refcheck));
 958
 959         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 960         if (--cle->ce_ref == 0) {
 961                 CL_ENV_DEC(cs_busy);
 962                 cl_env_detach(cle);
 963                 cle->ce_debug = NULL;
 964                 cl_env_exit(cle);
 965                 /*
 966                  * Don't bother to take a lock here.
 967                  *
 968                  * Return environment to the cache only when it was allocated
 969                  * with the standard tags.
 970                  */
 971                 if (cl_envs_cached_nr < cl_envs_cached_max &&
 972                     (env->le_ctx.lc_tags & ~LCT_HAS_EXIT) == LCT_CL_THREAD &&
 973                     (env->le_ses->lc_tags & ~LCT_HAS_EXIT) == LCT_SESSION) {
 974                         cfs_spin_lock(&cl_envs_guard);
 975                         cfs_list_add(&cle->ce_linkage, &cl_envs);
 976                         cl_envs_cached_nr++;
 977                         cfs_spin_unlock(&cl_envs_guard);
 978                 } else
 979                         cl_env_fini(cle);
 980         }
 981 }
 982 EXPORT_SYMBOL(cl_env_put);
 983
 984 /**
 985  * Declares a point of re-entrancy.
 986  *
 987  * \see cl_env_reexit()
 988  */
 989 void *cl_env_reenter(void)
 990 {
 991         return cl_env_detach(NULL);
 992 }
 993 EXPORT_SYMBOL(cl_env_reenter);
 994
 995 /**
 996  * Exits re-entrancy.
 997  */
 998 void cl_env_reexit(void *cookie)
 999 {
1000         cl_env_detach(NULL);
1001         cl_env_attach(cookie);
1002 }
1003 EXPORT_SYMBOL(cl_env_reexit);
1004
1005 /**
1006  * Setup user-supplied \a env as a current environment. This is to be used to
1007  * guaranteed that environment exists even when cl_env_get() fails. It is up
1008  * to user to ensure proper concurrency control.
1009  *
1010  * \see cl_env_unplant()
1011  */
1012 void cl_env_implant(struct lu_env *env, int *refcheck)
1013 {
1014         struct cl_env *cle = cl_env_container(env);
1015
1016         LASSERT(cle->ce_ref > 0);
1017
1018         cl_env_attach(cle);
1019         cl_env_get(refcheck);
1020         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1021 }
1022 EXPORT_SYMBOL(cl_env_implant);
1023
1024 /**
1025  * Detach environment installed earlier by cl_env_implant().
1026  */
1027 void cl_env_unplant(struct lu_env *env, int *refcheck)
1028 {
1029         struct cl_env *cle = cl_env_container(env);
1030
1031         LASSERT(cle->ce_ref > 1);
1032
1033         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1034
1035         cl_env_detach(cle);
1036         cl_env_put(env, refcheck);
1037 }
1038 EXPORT_SYMBOL(cl_env_unplant);
1039
1040 struct lu_env *cl_env_nested_get(struct cl_env_nest *nest)
1041 {
1042         struct lu_env *env;
1043
1044         nest->cen_cookie = NULL;
1045         env = cl_env_peek(&nest->cen_refcheck);
1046         if (env != NULL) {
1047                 if (!cl_io_is_going(env))
1048                         return env;
1049                 else {
1050                         cl_env_put(env, &nest->cen_refcheck);
1051                         nest->cen_cookie = cl_env_reenter();
1052                 }
1053         }
1054         env = cl_env_get(&nest->cen_refcheck);
1055         if (IS_ERR(env)) {
1056                 cl_env_reexit(nest->cen_cookie);
1057                 return env;
1058         }
1059
1060         LASSERT(!cl_io_is_going(env));
1061         return env;
1062 }
1063 EXPORT_SYMBOL(cl_env_nested_get);
1064
1065 void cl_env_nested_put(struct cl_env_nest *nest, struct lu_env *env)
1066 {
1067         cl_env_put(env, &nest->cen_refcheck);
1068         cl_env_reexit(nest->cen_cookie);
1069 }
1070 EXPORT_SYMBOL(cl_env_nested_put);
1071
1072 /**
1073  * Converts struct cl_attr to struct ost_lvb.
1074  *
1075  * \see cl_lvb2attr
1076  */
1077 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr)
1078 {
1079         ENTRY;
1080         lvb->lvb_size   = attr->cat_size;
1081         lvb->lvb_mtime  = attr->cat_mtime;
1082         lvb->lvb_atime  = attr->cat_atime;
1083         lvb->lvb_ctime  = attr->cat_ctime;
1084         lvb->lvb_blocks = attr->cat_blocks;
1085         EXIT;
1086 }
1087 EXPORT_SYMBOL(cl_attr2lvb);
1088
1089 /**
1090  * Converts struct ost_lvb to struct cl_attr.
1091  *
1092  * \see cl_attr2lvb
1093  */
1094 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb)
1095 {
1096         ENTRY;
1097         attr->cat_size   = lvb->lvb_size;
1098         attr->cat_mtime  = lvb->lvb_mtime;
1099         attr->cat_atime  = lvb->lvb_atime;
1100         attr->cat_ctime  = lvb->lvb_ctime;
1101         attr->cat_blocks = lvb->lvb_blocks;
1102         EXIT;
1103 }
1104 EXPORT_SYMBOL(cl_lvb2attr);
1105
1106 /*****************************************************************************
1107  *
1108  * Temporary prototype thing: mirror obd-devices into cl devices.
1109  *
1110  */
1111
1112 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
1113                                 struct lu_device_type *ldt,
1114                                 struct lu_device *next)
1115 {
1116         const char       *typename;
1117         struct lu_device *d;
1118
1119         LASSERT(ldt != NULL);
1120
1121         typename = ldt->ldt_name;
1122         d = ldt->ldt_ops->ldto_device_alloc(env, ldt, NULL);
1123         if (!IS_ERR(d)) {
1124                 int rc;
1125
1126                 if (site != NULL)
1127                         d->ld_site = site;
1128                 rc = ldt->ldt_ops->ldto_device_init(env, d, typename, next);
1129                 if (rc == 0) {
1130                         lu_device_get(d);
1131                         lu_ref_add(&d->ld_reference,
1132                                    "lu-stack", &lu_site_init);
1133                 } else {
1134                         ldt->ldt_ops->ldto_device_free(env, d);
1135                         CERROR("can't init device '%s', %d\n", typename, rc);
1136                         d = ERR_PTR(rc);
1137                 }
1138         } else
1139                 CERROR("Cannot allocate device: '%s'\n", typename);
1140         return lu2cl_dev(d);
1141 }
1142 EXPORT_SYMBOL(cl_type_setup);
1143
1144 /**
1145  * Finalize device stack by calling lu_stack_fini().
1146  */
1147 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl)
1148 {
1149         lu_stack_fini(env, cl2lu_dev(cl));
1150 }
1151 EXPORT_SYMBOL(cl_stack_fini);
1152
1153 int  cl_lock_init(void);
1154 void cl_lock_fini(void);
1155
1156 int  cl_page_init(void);
1157 void cl_page_fini(void);
1158
1159 static struct lu_context_key cl_key;
1160
1161 struct cl_thread_info *cl_env_info(const struct lu_env *env)
1162 {
1163         return lu_context_key_get(&env->le_ctx, &cl_key);
1164 }
1165
1166 /* defines cl0_key_{init,fini}() */
1167 LU_KEY_INIT_FINI(cl0, struct cl_thread_info);
1168
1169 static void *cl_key_init(const struct lu_context *ctx,
1170                          struct lu_context_key *key)
1171 {
1172         struct cl_thread_info *info;
1173
1174         info = cl0_key_init(ctx, key);
1175         if (!IS_ERR(info)) {
1176                 int i;
1177
1178                 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1179                         lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1180         }
1181         return info;
1182 }
1183
1184 static void cl_key_fini(const struct lu_context *ctx,
1185                         struct lu_context_key *key, void *data)
1186 {
1187         struct cl_thread_info *info;
1188         int i;
1189
1190         info = data;
1191         for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1192                 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1193         cl0_key_fini(ctx, key, data);
1194 }
1195
1196 static void cl_key_exit(const struct lu_context *ctx,
1197                         struct lu_context_key *key, void *data)
1198 {
1199         struct cl_thread_info *info = data;
1200         int i;
1201
1202         for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i) {
1203                 LASSERT(info->clt_counters[i].ctc_nr_held == 0);
1204                 LASSERT(info->clt_counters[i].ctc_nr_used == 0);
1205                 LASSERT(info->clt_counters[i].ctc_nr_locks_acquired == 0);
1206                 LASSERT(info->clt_counters[i].ctc_nr_locks_locked == 0);
1207                 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1208                 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1209         }
1210 }
1211
1212 static struct lu_context_key cl_key = {
1213         .lct_tags = LCT_CL_THREAD,
1214         .lct_init = cl_key_init,
1215         .lct_fini = cl_key_fini,
1216         .lct_exit = cl_key_exit
1217 };
1218
1219 static struct lu_kmem_descr cl_object_caches[] = {
1220         {
1221                 .ckd_cache = &cl_env_kmem,
1222                 .ckd_name  = "cl_env_kmem",
1223                 .ckd_size  = sizeof (struct cl_env)
1224         },
1225         {
1226                 .ckd_cache = NULL
1227         }
1228 };
1229
1230 /**
1231  * Global initialization of cl-data. Create kmem caches, register
1232  * lu_context_key's, etc.
1233  *
1234  * \see cl_global_fini()
1235  */
1236 int cl_global_init(void)
1237 {
1238         int result;
1239
1240         result = cl_env_store_init();
1241         if (result)
1242                 return result;
1243
1244         result = lu_kmem_init(cl_object_caches);
1245         if (result == 0) {
1246                 LU_CONTEXT_KEY_INIT(&cl_key);
1247                 result = lu_context_key_register(&cl_key);
1248                 if (result == 0) {
1249                         result = cl_lock_init();
1250                         if (result == 0)
1251                                 result = cl_page_init();
1252                 }
1253         }
1254         if (result)
1255                 cl_env_store_fini();
1256         return result;
1257 }
1258
1259 /**
1260  * Finalization of global cl-data. Dual to cl_global_init().
1261  */
1262 void cl_global_fini(void)
1263 {
1264         cl_lock_fini();
1265         cl_page_fini();
1266         lu_context_key_degister(&cl_key);
1267         lu_kmem_fini(cl_object_caches);
1268         cl_env_store_fini();
1269 }