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 cfs_hash_ops_t cl_env_hops = {
 641         .hs_hash        = cl_env_hops_hash,
 642         .hs_key         = cl_env_hops_obj,
 643         .hs_keycmp      = cl_env_hops_keycmp,
 644         .hs_object      = cl_env_hops_obj,
 645         .hs_get         = cl_env_hops_obj,
 646         .hs_put_locked  = cl_env_hops_obj,
 647 };
 648
 649 static inline struct cl_env *cl_env_fetch(void)
 650 {
 651         struct cl_env *cle;
 652
 653         cle = cfs_hash_lookup(cl_env_hash, (void *) (long) cfs_current()->pid);
 654         LASSERT(ergo(cle, cle->ce_magic == &cl_env_init0));
 655         return cle;
 656 }
 657
 658 static inline void cl_env_attach(struct cl_env *cle)
 659 {
 660         if (cle) {
 661                 int rc;
 662
 663                 LASSERT(cle->ce_owner == NULL);
 664                 cle->ce_owner = (void *) (long) cfs_current()->pid;
 665                 rc = cfs_hash_add_unique(cl_env_hash, cle->ce_owner,
 666                                          &cle->ce_node);
 667                 LASSERT(rc == 0);
 668         }
 669 }
 670
 671 static inline void cl_env_do_detach(struct cl_env *cle)
 672 {
 673         void *cookie;
 674
 675         LASSERT(cle->ce_owner == (void *) (long) cfs_current()->pid);
 676         cookie = cfs_hash_del(cl_env_hash, cle->ce_owner,
 677                               &cle->ce_node);
 678         LASSERT(cookie == cle);
 679         cle->ce_owner = NULL;
 680 }
 681
 682 static int cl_env_store_init(void) {
 683         cl_env_hash = cfs_hash_create("cl_env",
 684                                       HASH_CL_ENV_BITS, HASH_CL_ENV_BITS,
 685                                       HASH_CL_ENV_BKT_BITS, 0,
 686                                       CFS_HASH_MIN_THETA,
 687                                       CFS_HASH_MAX_THETA,
 688                                       &cl_env_hops,
 689                                       CFS_HASH_RW_BKTLOCK);
 690         return cl_env_hash != NULL ? 0 :-ENOMEM;
 691 }
 692
 693 static void cl_env_store_fini(void) {
 694         cfs_hash_putref(cl_env_hash);
 695 }
 696
 697 #else /* LL_TASK_CL_ENV */
 698 /*
 699  * The implementation of store cl_env directly in thread structure.
 700  */
 701
 702 static inline struct cl_env *cl_env_fetch(void)
 703 {
 704         struct cl_env *cle;
 705
 706         cle = cfs_current()->LL_TASK_CL_ENV;
 707         if (cle && cle->ce_magic != &cl_env_init0)
 708                 cle = NULL;
 709         return cle;
 710 }
 711
 712 static inline void cl_env_attach(struct cl_env *cle)
 713 {
 714         if (cle) {
 715                 LASSERT(cle->ce_owner == NULL);
 716                 cle->ce_owner = cfs_current();
 717                 cle->ce_prev = cfs_current()->LL_TASK_CL_ENV;
 718                 cfs_current()->LL_TASK_CL_ENV = cle;
 719         }
 720 }
 721
 722 static inline void cl_env_do_detach(struct cl_env *cle)
 723 {
 724         LASSERT(cle->ce_owner == cfs_current());
 725         LASSERT(cfs_current()->LL_TASK_CL_ENV == cle);
 726         cfs_current()->LL_TASK_CL_ENV = cle->ce_prev;
 727         cle->ce_owner = NULL;
 728 }
 729
 730 static int cl_env_store_init(void) { return 0; }
 731 static void cl_env_store_fini(void) { }
 732
 733 #endif /* LL_TASK_CL_ENV */
 734
 735 static inline struct cl_env *cl_env_detach(struct cl_env *cle)
 736 {
 737         if (cle == NULL)
 738                 cle = cl_env_fetch();
 739
 740         if (cle && cle->ce_owner)
 741                 cl_env_do_detach(cle);
 742
 743         return cle;
 744 }
 745
 746 static struct lu_env *cl_env_new(__u32 tags, void *debug)
 747 {
 748         struct lu_env *env;
 749         struct cl_env *cle;
 750
 751         OBD_SLAB_ALLOC_PTR_GFP(cle, cl_env_kmem, CFS_ALLOC_IO);
 752         if (cle != NULL) {
 753                 int rc;
 754
 755                 CFS_INIT_LIST_HEAD(&cle->ce_linkage);
 756                 cle->ce_magic = &cl_env_init0;
 757                 env = &cle->ce_lu;
 758                 rc = lu_env_init(env, LCT_CL_THREAD|tags);
 759                 if (rc == 0) {
 760                         rc = lu_context_init(&cle->ce_ses, LCT_SESSION|tags);
 761                         if (rc == 0) {
 762                                 lu_context_enter(&cle->ce_ses);
 763                                 env->le_ses = &cle->ce_ses;
 764                                 cl_env_init0(cle, debug);
 765                         } else
 766                                 lu_env_fini(env);
 767                 }
 768                 if (rc != 0) {
 769                         OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
 770                         env = ERR_PTR(rc);
 771                 } else {
 772                         CL_ENV_INC(cs_created);
 773                         CL_ENV_INC(cs_total);
 774                 }
 775         } else
 776                 env = ERR_PTR(-ENOMEM);
 777         return env;
 778 }
 779
 780 static void cl_env_fini(struct cl_env *cle)
 781 {
 782         CL_ENV_DEC(cs_total);
 783         lu_context_fini(&cle->ce_lu.le_ctx);
 784         lu_context_fini(&cle->ce_ses);
 785         OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
 786 }
 787
 788 static struct lu_env *cl_env_obtain(void *debug)
 789 {
 790         struct cl_env *cle;
 791         struct lu_env *env;
 792
 793         ENTRY;
 794         cfs_spin_lock(&cl_envs_guard);
 795         LASSERT(equi(cl_envs_cached_nr == 0, cfs_list_empty(&cl_envs)));
 796         if (cl_envs_cached_nr > 0) {
 797                 int rc;
 798
 799                 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
 800                 cfs_list_del_init(&cle->ce_linkage);
 801                 cl_envs_cached_nr--;
 802                 cfs_spin_unlock(&cl_envs_guard);
 803
 804                 env = &cle->ce_lu;
 805                 rc = lu_env_refill(env);
 806                 if (rc == 0) {
 807                         cl_env_init0(cle, debug);
 808                         lu_context_enter(&env->le_ctx);
 809                         lu_context_enter(&cle->ce_ses);
 810                 } else {
 811                         cl_env_fini(cle);
 812                         env = ERR_PTR(rc);
 813                 }
 814         } else {
 815                 cfs_spin_unlock(&cl_envs_guard);
 816                 env = cl_env_new(0, debug);
 817         }
 818         RETURN(env);
 819 }
 820
 821 static inline struct cl_env *cl_env_container(struct lu_env *env)
 822 {
 823         return container_of(env, struct cl_env, ce_lu);
 824 }
 825
 826 struct lu_env *cl_env_peek(int *refcheck)
 827 {
 828         struct lu_env *env;
 829         struct cl_env *cle;
 830
 831         CL_ENV_INC(cs_lookup);
 832
 833         /* check that we don't go far from untrusted pointer */
 834         CLASSERT(offsetof(struct cl_env, ce_magic) == 0);
 835
 836         env = NULL;
 837         cle = cl_env_fetch();
 838         if (cle != NULL) {
 839                 CL_ENV_INC(cs_hit);
 840                 env = &cle->ce_lu;
 841                 *refcheck = ++cle->ce_ref;
 842         }
 843         CDEBUG(D_OTHER, "%d@%p\n", cle ? cle->ce_ref : 0, cle);
 844         return env;
 845 }
 846 EXPORT_SYMBOL(cl_env_peek);
 847
 848 /**
 849  * Returns lu_env: if there already is an environment associated with the
 850  * current thread, it is returned, otherwise, new environment is allocated.
 851  *
 852  * Allocations are amortized through the global cache of environments.
 853  *
 854  * \param refcheck pointer to a counter used to detect environment leaks. In
 855  * the usual case cl_env_get() and cl_env_put() are called in the same lexical
 856  * scope and pointer to the same integer is passed as \a refcheck. This is
 857  * used to detect missed cl_env_put().
 858  *
 859  * \see cl_env_put()
 860  */
 861 struct lu_env *cl_env_get(int *refcheck)
 862 {
 863         struct lu_env *env;
 864
 865         env = cl_env_peek(refcheck);
 866         if (env == NULL) {
 867                 env = cl_env_obtain(__builtin_return_address(0));
 868                 if (!IS_ERR(env)) {
 869                         struct cl_env *cle;
 870
 871                         cle = cl_env_container(env);
 872                         cl_env_attach(cle);
 873                         *refcheck = cle->ce_ref;
 874                         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 875                 }
 876         }
 877         return env;
 878 }
 879 EXPORT_SYMBOL(cl_env_get);
 880
 881 /**
 882  * Forces an allocation of a fresh environment with given tags.
 883  *
 884  * \see cl_env_get()
 885  */
 886 struct lu_env *cl_env_alloc(int *refcheck, __u32 tags)
 887 {
 888         struct lu_env *env;
 889
 890         LASSERT(cl_env_peek(refcheck) == NULL);
 891         env = cl_env_new(tags, __builtin_return_address(0));
 892         if (!IS_ERR(env)) {
 893                 struct cl_env *cle;
 894
 895                 cle = cl_env_container(env);
 896                 *refcheck = cle->ce_ref;
 897                 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 898         }
 899         return env;
 900 }
 901 EXPORT_SYMBOL(cl_env_alloc);
 902
 903 static void cl_env_exit(struct cl_env *cle)
 904 {
 905         LASSERT(cle->ce_owner == NULL);
 906         lu_context_exit(&cle->ce_lu.le_ctx);
 907         lu_context_exit(&cle->ce_ses);
 908 }
 909
 910 /**
 911  * Finalizes and frees a given number of cached environments. This is done to
 912  * (1) free some memory (not currently hooked into VM), or (2) release
 913  * references to modules.
 914  */
 915 unsigned cl_env_cache_purge(unsigned nr)
 916 {
 917         struct cl_env *cle;
 918
 919         ENTRY;
 920         cfs_spin_lock(&cl_envs_guard);
 921         for (; !cfs_list_empty(&cl_envs) && nr > 0; --nr) {
 922                 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
 923                 cfs_list_del_init(&cle->ce_linkage);
 924                 LASSERT(cl_envs_cached_nr > 0);
 925                 cl_envs_cached_nr--;
 926                 cfs_spin_unlock(&cl_envs_guard);
 927
 928                 cl_env_fini(cle);
 929                 cfs_spin_lock(&cl_envs_guard);
 930         }
 931         LASSERT(equi(cl_envs_cached_nr == 0, cfs_list_empty(&cl_envs)));
 932         cfs_spin_unlock(&cl_envs_guard);
 933         RETURN(nr);
 934 }
 935 EXPORT_SYMBOL(cl_env_cache_purge);
 936
 937 /**
 938  * Release an environment.
 939  *
 940  * Decrement \a env reference counter. When counter drops to 0, nothing in
 941  * this thread is using environment and it is returned to the allocation
 942  * cache, or freed straight away, if cache is large enough.
 943  */
 944 void cl_env_put(struct lu_env *env, int *refcheck)
 945 {
 946         struct cl_env *cle;
 947
 948         cle = cl_env_container(env);
 949
 950         LASSERT(cle->ce_ref > 0);
 951         LASSERT(ergo(refcheck != NULL, cle->ce_ref == *refcheck));
 952
 953         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 954         if (--cle->ce_ref == 0) {
 955                 CL_ENV_DEC(cs_busy);
 956                 cl_env_detach(cle);
 957                 cle->ce_debug = NULL;
 958                 cl_env_exit(cle);
 959                 /*
 960                  * Don't bother to take a lock here.
 961                  *
 962                  * Return environment to the cache only when it was allocated
 963                  * with the standard tags.
 964                  */
 965                 if (cl_envs_cached_nr < cl_envs_cached_max &&
 966                     (env->le_ctx.lc_tags & ~LCT_HAS_EXIT) == LCT_CL_THREAD &&
 967                     (env->le_ses->lc_tags & ~LCT_HAS_EXIT) == LCT_SESSION) {
 968                         cfs_spin_lock(&cl_envs_guard);
 969                         cfs_list_add(&cle->ce_linkage, &cl_envs);
 970                         cl_envs_cached_nr++;
 971                         cfs_spin_unlock(&cl_envs_guard);
 972                 } else
 973                         cl_env_fini(cle);
 974         }
 975 }
 976 EXPORT_SYMBOL(cl_env_put);
 977
 978 /**
 979  * Declares a point of re-entrancy.
 980  *
 981  * \see cl_env_reexit()
 982  */
 983 void *cl_env_reenter(void)
 984 {
 985         return cl_env_detach(NULL);
 986 }
 987 EXPORT_SYMBOL(cl_env_reenter);
 988
 989 /**
 990  * Exits re-entrancy.
 991  */
 992 void cl_env_reexit(void *cookie)
 993 {
 994         cl_env_detach(NULL);
 995         cl_env_attach(cookie);
 996 }
 997 EXPORT_SYMBOL(cl_env_reexit);
 998
 999 /**
1000  * Setup user-supplied \a env as a current environment. This is to be used to
1001  * guaranteed that environment exists even when cl_env_get() fails. It is up
1002  * to user to ensure proper concurrency control.
1003  *
1004  * \see cl_env_unplant()
1005  */
1006 void cl_env_implant(struct lu_env *env, int *refcheck)
1007 {
1008         struct cl_env *cle = cl_env_container(env);
1009
1010         LASSERT(cle->ce_ref > 0);
1011
1012         cl_env_attach(cle);
1013         cl_env_get(refcheck);
1014         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1015 }
1016 EXPORT_SYMBOL(cl_env_implant);
1017
1018 /**
1019  * Detach environment installed earlier by cl_env_implant().
1020  */
1021 void cl_env_unplant(struct lu_env *env, int *refcheck)
1022 {
1023         struct cl_env *cle = cl_env_container(env);
1024
1025         LASSERT(cle->ce_ref > 1);
1026
1027         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1028
1029         cl_env_detach(cle);
1030         cl_env_put(env, refcheck);
1031 }
1032 EXPORT_SYMBOL(cl_env_unplant);
1033
1034 struct lu_env *cl_env_nested_get(struct cl_env_nest *nest)
1035 {
1036         struct lu_env *env;
1037
1038         nest->cen_cookie = NULL;
1039         env = cl_env_peek(&nest->cen_refcheck);
1040         if (env != NULL) {
1041                 if (!cl_io_is_going(env))
1042                         return env;
1043                 else {
1044                         cl_env_put(env, &nest->cen_refcheck);
1045                         nest->cen_cookie = cl_env_reenter();
1046                 }
1047         }
1048         env = cl_env_get(&nest->cen_refcheck);
1049         if (IS_ERR(env)) {
1050                 cl_env_reexit(nest->cen_cookie);
1051                 return env;
1052         }
1053
1054         LASSERT(!cl_io_is_going(env));
1055         return env;
1056 }
1057 EXPORT_SYMBOL(cl_env_nested_get);
1058
1059 void cl_env_nested_put(struct cl_env_nest *nest, struct lu_env *env)
1060 {
1061         cl_env_put(env, &nest->cen_refcheck);
1062         cl_env_reexit(nest->cen_cookie);
1063 }
1064 EXPORT_SYMBOL(cl_env_nested_put);
1065
1066 /**
1067  * Converts struct cl_attr to struct ost_lvb.
1068  *
1069  * \see cl_lvb2attr
1070  */
1071 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr)
1072 {
1073         ENTRY;
1074         lvb->lvb_size   = attr->cat_size;
1075         lvb->lvb_mtime  = attr->cat_mtime;
1076         lvb->lvb_atime  = attr->cat_atime;
1077         lvb->lvb_ctime  = attr->cat_ctime;
1078         lvb->lvb_blocks = attr->cat_blocks;
1079         EXIT;
1080 }
1081 EXPORT_SYMBOL(cl_attr2lvb);
1082
1083 /**
1084  * Converts struct ost_lvb to struct cl_attr.
1085  *
1086  * \see cl_attr2lvb
1087  */
1088 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb)
1089 {
1090         ENTRY;
1091         attr->cat_size   = lvb->lvb_size;
1092         attr->cat_mtime  = lvb->lvb_mtime;
1093         attr->cat_atime  = lvb->lvb_atime;
1094         attr->cat_ctime  = lvb->lvb_ctime;
1095         attr->cat_blocks = lvb->lvb_blocks;
1096         EXIT;
1097 }
1098 EXPORT_SYMBOL(cl_lvb2attr);
1099
1100 /*****************************************************************************
1101  *
1102  * Temporary prototype thing: mirror obd-devices into cl devices.
1103  *
1104  */
1105
1106 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
1107                                 struct lu_device_type *ldt,
1108                                 struct lu_device *next)
1109 {
1110         const char       *typename;
1111         struct lu_device *d;
1112
1113         LASSERT(ldt != NULL);
1114
1115         typename = ldt->ldt_name;
1116         d = ldt->ldt_ops->ldto_device_alloc(env, ldt, NULL);
1117         if (!IS_ERR(d)) {
1118                 int rc;
1119
1120                 if (site != NULL)
1121                         d->ld_site = site;
1122                 rc = ldt->ldt_ops->ldto_device_init(env, d, typename, next);
1123                 if (rc == 0) {
1124                         lu_device_get(d);
1125                         lu_ref_add(&d->ld_reference,
1126                                    "lu-stack", &lu_site_init);
1127                 } else {
1128                         ldt->ldt_ops->ldto_device_free(env, d);
1129                         CERROR("can't init device '%s', %d\n", typename, rc);
1130                         d = ERR_PTR(rc);
1131                 }
1132         } else
1133                 CERROR("Cannot allocate device: '%s'\n", typename);
1134         return lu2cl_dev(d);
1135 }
1136 EXPORT_SYMBOL(cl_type_setup);
1137
1138 /**
1139  * Finalize device stack by calling lu_stack_fini().
1140  */
1141 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl)
1142 {
1143         lu_stack_fini(env, cl2lu_dev(cl));
1144 }
1145 EXPORT_SYMBOL(cl_stack_fini);
1146
1147 int  cl_lock_init(void);
1148 void cl_lock_fini(void);
1149
1150 int  cl_page_init(void);
1151 void cl_page_fini(void);
1152
1153 static struct lu_context_key cl_key;
1154
1155 struct cl_thread_info *cl_env_info(const struct lu_env *env)
1156 {
1157         return lu_context_key_get(&env->le_ctx, &cl_key);
1158 }
1159
1160 /* defines cl0_key_{init,fini}() */
1161 LU_KEY_INIT_FINI(cl0, struct cl_thread_info);
1162
1163 static void *cl_key_init(const struct lu_context *ctx,
1164                          struct lu_context_key *key)
1165 {
1166         struct cl_thread_info *info;
1167
1168         info = cl0_key_init(ctx, key);
1169         if (!IS_ERR(info)) {
1170                 int i;
1171
1172                 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1173                         lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1174         }
1175         return info;
1176 }
1177
1178 static void cl_key_fini(const struct lu_context *ctx,
1179                         struct lu_context_key *key, void *data)
1180 {
1181         struct cl_thread_info *info;
1182         int i;
1183
1184         info = data;
1185         for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1186                 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1187         cl0_key_fini(ctx, key, data);
1188 }
1189
1190 static void cl_key_exit(const struct lu_context *ctx,
1191                         struct lu_context_key *key, void *data)
1192 {
1193         struct cl_thread_info *info = data;
1194         int i;
1195
1196         for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i) {
1197                 LASSERT(info->clt_counters[i].ctc_nr_held == 0);
1198                 LASSERT(info->clt_counters[i].ctc_nr_used == 0);
1199                 LASSERT(info->clt_counters[i].ctc_nr_locks_acquired == 0);
1200                 LASSERT(info->clt_counters[i].ctc_nr_locks_locked == 0);
1201                 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1202                 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1203         }
1204 }
1205
1206 static struct lu_context_key cl_key = {
1207         .lct_tags = LCT_CL_THREAD,
1208         .lct_init = cl_key_init,
1209         .lct_fini = cl_key_fini,
1210         .lct_exit = cl_key_exit
1211 };
1212
1213 static struct lu_kmem_descr cl_object_caches[] = {
1214         {
1215                 .ckd_cache = &cl_env_kmem,
1216                 .ckd_name  = "cl_env_kmem",
1217                 .ckd_size  = sizeof (struct cl_env)
1218         },
1219         {
1220                 .ckd_cache = NULL
1221         }
1222 };
1223
1224 /**
1225  * Global initialization of cl-data. Create kmem caches, register
1226  * lu_context_key's, etc.
1227  *
1228  * \see cl_global_fini()
1229  */
1230 int cl_global_init(void)
1231 {
1232         int result;
1233
1234         result = cl_env_store_init();
1235         if (result)
1236                 return result;
1237
1238         result = lu_kmem_init(cl_object_caches);
1239         if (result == 0) {
1240                 LU_CONTEXT_KEY_INIT(&cl_key);
1241                 result = lu_context_key_register(&cl_key);
1242                 if (result == 0) {
1243                         result = cl_lock_init();
1244                         if (result == 0)
1245                                 result = cl_page_init();
1246                 }
1247         }
1248         if (result)
1249                 cl_env_store_fini();
1250         return result;
1251 }
1252
1253 /**
1254  * Finalization of global cl-data. Dual to cl_global_init().
1255  */
1256 void cl_global_fini(void)
1257 {
1258         cl_lock_fini();
1259         cl_page_fini();
1260         lu_context_key_degister(&cl_key);
1261         lu_kmem_fini(cl_object_caches);
1262         cl_env_store_fini();
1263 }