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 static CFS_LIST_HEAD(cl_envs);
 523 static unsigned cl_envs_cached_nr  = 0;
 524 static unsigned cl_envs_cached_max = 128; /* XXX: prototype: arbitrary limit
 525                                            * for now. */
 526 static cfs_spinlock_t cl_envs_guard = CFS_SPIN_LOCK_UNLOCKED;
 527
 528 struct cl_env {
 529         void             *ce_magic;
 530         struct lu_env     ce_lu;
 531         struct lu_context ce_ses;
 532         /**
 533          * This allows cl_env to be entered into cl_env_hash which implements
 534          * the current thread -> client environment lookup.
 535          */
 536         cfs_hlist_node_t  ce_node;
 537         /**
 538          * Owner for the current cl_env, the key for cfs_hash.
 539          * Now current thread pid is stored. Note using thread pointer would
 540          * lead to unbalanced hash because of its specific allocation locality
 541          * and could be varied for different platforms and OSes, even different
 542          * OS versions.
 543          */
 544         void             *ce_owner;
 545         /*
 546          * Linkage into global list of all client environments. Used for
 547          * garbage collection.
 548          */
 549         cfs_list_t        ce_linkage;
 550         /*
 551          *
 552          */
 553         int               ce_ref;
 554         /*
 555          * Debugging field: address of the caller who made original
 556          * allocation.
 557          */
 558         void             *ce_debug;
 559 };
 560
 561 #define CL_ENV_INC(counter) cfs_atomic_inc(&cl_env_stats.counter)
 562
 563 #define CL_ENV_DEC(counter)                                             \
 564         do {                                                            \
 565                 LASSERT(cfs_atomic_read(&cl_env_stats.counter) > 0);    \
 566                 cfs_atomic_dec(&cl_env_stats.counter);                  \
 567         } while (0)
 568
 569 /*****************************************************************************
 570  * Routins to use cfs_hash functionality to bind the current thread
 571  * to cl_env
 572  */
 573
 574 /** lustre hash to manage the cl_env for current thread */
 575 static cfs_hash_t *cl_env_hash;
 576 static void cl_env_init0(struct cl_env *cle, void *debug);
 577
 578 static unsigned cl_env_hops_hash(cfs_hash_t *lh, void *key, unsigned mask)
 579 {
 580 #if BITS_PER_LONG == 64
 581         return cfs_hash_u64_hash((__u64)key, mask);
 582 #else
 583         return cfs_hash_u32_hash((__u32)key, mask);
 584 #endif
 585 }
 586
 587 static void *cl_env_hops_obj(cfs_hlist_node_t *hn)
 588 {
 589         struct cl_env *cle = cfs_hlist_entry(hn, struct cl_env, ce_node);
 590         LASSERT(cle->ce_magic == &cl_env_init0);
 591         return (void *)cle;
 592 }
 593
 594 static int cl_env_hops_compare(void *key, cfs_hlist_node_t *hn)
 595 {
 596         struct cl_env *cle = cl_env_hops_obj(hn);
 597
 598         LASSERT(cle->ce_owner != NULL);
 599         return (key == cle->ce_owner);
 600 }
 601
 602 static cfs_hash_ops_t cl_env_hops = {
 603         .hs_hash    = cl_env_hops_hash,
 604         .hs_compare = cl_env_hops_compare,
 605         .hs_key     = cl_env_hops_obj,
 606         .hs_get     = cl_env_hops_obj,
 607         .hs_put     = cl_env_hops_obj,
 608 };
 609
 610 static inline struct cl_env *cl_env_fetch(void)
 611 {
 612         struct cl_env *cle;
 613         cle = cfs_hash_lookup(cl_env_hash, (void *) (long) cfs_current()->pid);
 614         LASSERT(ergo(cle, cle->ce_magic == &cl_env_init0));
 615         return cle;
 616 }
 617
 618 static inline void cl_env_attach(struct cl_env *cle)
 619 {
 620         if (cle) {
 621                 int rc;
 622                 LASSERT(cle->ce_owner == NULL);
 623                 cle->ce_owner = (void *) (long) cfs_current()->pid;
 624                 rc = cfs_hash_add_unique(cl_env_hash, cle->ce_owner,
 625                                          &cle->ce_node);
 626                 LASSERT(rc == 0);
 627         }
 628 }
 629
 630 static inline struct cl_env *cl_env_detach(struct cl_env *cle)
 631 {
 632         if (cle == NULL)
 633                 cle = cl_env_fetch();
 634         if (cle && cle->ce_owner) {
 635                 void *cookie;
 636                 LASSERT(cle->ce_owner == (void *) (long) cfs_current()->pid);
 637                 cookie = cfs_hash_del(cl_env_hash, cle->ce_owner,
 638                                       &cle->ce_node);
 639                 cle->ce_owner = NULL;
 640                 LASSERT(cookie == cle);
 641         }
 642         return cle;
 643 }
 644 /* ----------------------- hash routines end ---------------------------- */
 645
 646 static void cl_env_init0(struct cl_env *cle, void *debug)
 647 {
 648         LASSERT(cle->ce_ref == 0);
 649         LASSERT(cle->ce_magic == &cl_env_init0);
 650         LASSERT(cle->ce_debug == NULL && cle->ce_owner == NULL);
 651
 652         cle->ce_ref = 1;
 653         cle->ce_debug = debug;
 654         CL_ENV_INC(cs_busy);
 655 }
 656
 657 static struct lu_env *cl_env_new(__u32 tags, void *debug)
 658 {
 659         struct lu_env *env;
 660         struct cl_env *cle;
 661
 662         OBD_SLAB_ALLOC_PTR_GFP(cle, cl_env_kmem, CFS_ALLOC_IO);
 663         if (cle != NULL) {
 664                 int rc;
 665
 666                 CFS_INIT_LIST_HEAD(&cle->ce_linkage);
 667                 cle->ce_magic = &cl_env_init0;
 668                 env = &cle->ce_lu;
 669                 rc = lu_env_init(env, LCT_CL_THREAD|tags);
 670                 if (rc == 0) {
 671                         rc = lu_context_init(&cle->ce_ses, LCT_SESSION|tags);
 672                         if (rc == 0) {
 673                                 lu_context_enter(&cle->ce_ses);
 674                                 env->le_ses = &cle->ce_ses;
 675                                 cl_env_init0(cle, debug);
 676                         } else
 677                                 lu_env_fini(env);
 678                 }
 679                 if (rc != 0) {
 680                         OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
 681                         env = ERR_PTR(rc);
 682                 } else {
 683                         CL_ENV_INC(cs_created);
 684                         CL_ENV_INC(cs_total);
 685                 }
 686         } else
 687                 env = ERR_PTR(-ENOMEM);
 688         return env;
 689 }
 690
 691 static void cl_env_fini(struct cl_env *cle)
 692 {
 693         CL_ENV_DEC(cs_total);
 694         lu_context_fini(&cle->ce_lu.le_ctx);
 695         lu_context_fini(&cle->ce_ses);
 696         OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
 697 }
 698
 699 static struct lu_env *cl_env_obtain(void *debug)
 700 {
 701         struct cl_env *cle;
 702         struct lu_env *env;
 703
 704         ENTRY;
 705         cfs_spin_lock(&cl_envs_guard);
 706         LASSERT(equi(cl_envs_cached_nr == 0, cfs_list_empty(&cl_envs)));
 707         if (cl_envs_cached_nr > 0) {
 708                 int rc;
 709
 710                 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
 711                 cfs_list_del_init(&cle->ce_linkage);
 712                 cl_envs_cached_nr--;
 713                 cfs_spin_unlock(&cl_envs_guard);
 714
 715                 env = &cle->ce_lu;
 716                 rc = lu_env_refill(env);
 717                 if (rc == 0) {
 718                         cl_env_init0(cle, debug);
 719                         lu_context_enter(&env->le_ctx);
 720                         lu_context_enter(&cle->ce_ses);
 721                 } else {
 722                         cl_env_fini(cle);
 723                         env = ERR_PTR(rc);
 724                 }
 725         } else {
 726                 cfs_spin_unlock(&cl_envs_guard);
 727                 env = cl_env_new(0, debug);
 728         }
 729         RETURN(env);
 730 }
 731
 732 static inline struct cl_env *cl_env_container(struct lu_env *env)
 733 {
 734         return container_of(env, struct cl_env, ce_lu);
 735 }
 736
 737 struct lu_env *cl_env_peek(int *refcheck)
 738 {
 739         struct lu_env *env;
 740         struct cl_env *cle;
 741
 742         CL_ENV_INC(cs_lookup);
 743
 744         /* check that we don't go far from untrusted pointer */
 745         CLASSERT(offsetof(struct cl_env, ce_magic) == 0);
 746
 747         env = NULL;
 748         cle = cl_env_fetch();
 749         if (cle != NULL) {
 750                 CL_ENV_INC(cs_hit);
 751                 env = &cle->ce_lu;
 752                 *refcheck = ++cle->ce_ref;
 753         }
 754         CDEBUG(D_OTHER, "%d@%p\n", cle ? cle->ce_ref : 0, cle);
 755         return env;
 756 }
 757 EXPORT_SYMBOL(cl_env_peek);
 758
 759 /**
 760  * Returns lu_env: if there already is an environment associated with the
 761  * current thread, it is returned, otherwise, new environment is allocated.
 762  *
 763  * Allocations are amortized through the global cache of environments.
 764  *
 765  * \param refcheck pointer to a counter used to detect environment leaks. In
 766  * the usual case cl_env_get() and cl_env_put() are called in the same lexical
 767  * scope and pointer to the same integer is passed as \a refcheck. This is
 768  * used to detect missed cl_env_put().
 769  *
 770  * \see cl_env_put()
 771  */
 772 struct lu_env *cl_env_get(int *refcheck)
 773 {
 774         struct lu_env *env;
 775
 776         env = cl_env_peek(refcheck);
 777         if (env == NULL) {
 778                 env = cl_env_obtain(__builtin_return_address(0));
 779                 if (!IS_ERR(env)) {
 780                         struct cl_env *cle;
 781
 782                         cle = cl_env_container(env);
 783                         cl_env_attach(cle);
 784                         *refcheck = cle->ce_ref;
 785                         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 786                 }
 787         }
 788         return env;
 789 }
 790 EXPORT_SYMBOL(cl_env_get);
 791
 792 /**
 793  * Forces an allocation of a fresh environment with given tags.
 794  *
 795  * \see cl_env_get()
 796  */
 797 struct lu_env *cl_env_alloc(int *refcheck, __u32 tags)
 798 {
 799         struct lu_env *env;
 800
 801         LASSERT(cl_env_peek(refcheck) == NULL);
 802         env = cl_env_new(tags, __builtin_return_address(0));
 803         if (!IS_ERR(env)) {
 804                 struct cl_env *cle;
 805
 806                 cle = cl_env_container(env);
 807                 *refcheck = cle->ce_ref;
 808                 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 809         }
 810         return env;
 811 }
 812 EXPORT_SYMBOL(cl_env_alloc);
 813
 814 static void cl_env_exit(struct cl_env *cle)
 815 {
 816         LASSERT(cle->ce_owner == NULL);
 817         lu_context_exit(&cle->ce_lu.le_ctx);
 818         lu_context_exit(&cle->ce_ses);
 819 }
 820
 821 /**
 822  * Finalizes and frees a given number of cached environments. This is done to
 823  * (1) free some memory (not currently hooked into VM), or (2) release
 824  * references to modules.
 825  */
 826 unsigned cl_env_cache_purge(unsigned nr)
 827 {
 828         struct cl_env *cle;
 829
 830         ENTRY;
 831         cfs_spin_lock(&cl_envs_guard);
 832         for (; !cfs_list_empty(&cl_envs) && nr > 0; --nr) {
 833                 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
 834                 cfs_list_del_init(&cle->ce_linkage);
 835                 LASSERT(cl_envs_cached_nr > 0);
 836                 cl_envs_cached_nr--;
 837                 cfs_spin_unlock(&cl_envs_guard);
 838
 839                 cl_env_fini(cle);
 840                 cfs_spin_lock(&cl_envs_guard);
 841         }
 842         LASSERT(equi(cl_envs_cached_nr == 0, cfs_list_empty(&cl_envs)));
 843         cfs_spin_unlock(&cl_envs_guard);
 844         RETURN(nr);
 845 }
 846 EXPORT_SYMBOL(cl_env_cache_purge);
 847
 848 /**
 849  * Release an environment.
 850  *
 851  * Decrement \a env reference counter. When counter drops to 0, nothing in
 852  * this thread is using environment and it is returned to the allocation
 853  * cache, or freed straight away, if cache is large enough.
 854  */
 855 void cl_env_put(struct lu_env *env, int *refcheck)
 856 {
 857         struct cl_env *cle;
 858
 859         cle = cl_env_container(env);
 860
 861         LASSERT(cle->ce_ref > 0);
 862         LASSERT(ergo(refcheck != NULL, cle->ce_ref == *refcheck));
 863
 864         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 865         if (--cle->ce_ref == 0) {
 866                 CL_ENV_DEC(cs_busy);
 867                 cl_env_detach(cle);
 868                 cle->ce_debug = NULL;
 869                 cl_env_exit(cle);
 870                 /*
 871                  * Don't bother to take a lock here.
 872                  *
 873                  * Return environment to the cache only when it was allocated
 874                  * with the standard tags.
 875                  */
 876                 if (cl_envs_cached_nr < cl_envs_cached_max &&
 877                     (env->le_ctx.lc_tags & ~LCT_HAS_EXIT) == LCT_CL_THREAD &&
 878                     (env->le_ses->lc_tags & ~LCT_HAS_EXIT) == LCT_SESSION) {
 879                         cfs_spin_lock(&cl_envs_guard);
 880                         cfs_list_add(&cle->ce_linkage, &cl_envs);
 881                         cl_envs_cached_nr++;
 882                         cfs_spin_unlock(&cl_envs_guard);
 883                 } else
 884                         cl_env_fini(cle);
 885         }
 886 }
 887 EXPORT_SYMBOL(cl_env_put);
 888
 889 /**
 890  * Declares a point of re-entrancy.
 891  *
 892  * \see cl_env_reexit()
 893  */
 894 void *cl_env_reenter(void)
 895 {
 896         return cl_env_detach(NULL);
 897 }
 898 EXPORT_SYMBOL(cl_env_reenter);
 899
 900 /**
 901  * Exits re-entrancy.
 902  */
 903 void cl_env_reexit(void *cookie)
 904 {
 905         cl_env_detach(NULL);
 906         cl_env_attach(cookie);
 907 }
 908 EXPORT_SYMBOL(cl_env_reexit);
 909
 910 /**
 911  * Setup user-supplied \a env as a current environment. This is to be used to
 912  * guaranteed that environment exists even when cl_env_get() fails. It is up
 913  * to user to ensure proper concurrency control.
 914  *
 915  * \see cl_env_unplant()
 916  */
 917 void cl_env_implant(struct lu_env *env, int *refcheck)
 918 {
 919         struct cl_env *cle = cl_env_container(env);
 920
 921         LASSERT(cle->ce_ref > 0);
 922
 923         cl_env_attach(cle);
 924         cl_env_get(refcheck);
 925         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 926 }
 927 EXPORT_SYMBOL(cl_env_implant);
 928
 929 /**
 930  * Detach environment installed earlier by cl_env_implant().
 931  */
 932 void cl_env_unplant(struct lu_env *env, int *refcheck)
 933 {
 934         struct cl_env *cle = cl_env_container(env);
 935
 936         LASSERT(cle->ce_ref > 1);
 937
 938         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 939
 940         cl_env_detach(cle);
 941         cl_env_put(env, refcheck);
 942 }
 943 EXPORT_SYMBOL(cl_env_unplant);
 944
 945 struct lu_env *cl_env_nested_get(struct cl_env_nest *nest)
 946 {
 947         struct lu_env *env;
 948
 949         nest->cen_cookie = NULL;
 950         env = cl_env_peek(&nest->cen_refcheck);
 951         if (env != NULL) {
 952                 if (!cl_io_is_going(env))
 953                         return env;
 954                 else {
 955                         cl_env_put(env, &nest->cen_refcheck);
 956                         nest->cen_cookie = cl_env_reenter();
 957                 }
 958         }
 959         env = cl_env_get(&nest->cen_refcheck);
 960         if (IS_ERR(env)) {
 961                 cl_env_reexit(nest->cen_cookie);
 962                 return env;
 963         }
 964
 965         LASSERT(!cl_io_is_going(env));
 966         return env;
 967 }
 968 EXPORT_SYMBOL(cl_env_nested_get);
 969
 970 void cl_env_nested_put(struct cl_env_nest *nest, struct lu_env *env)
 971 {
 972         cl_env_put(env, &nest->cen_refcheck);
 973         cl_env_reexit(nest->cen_cookie);
 974 }
 975 EXPORT_SYMBOL(cl_env_nested_put);
 976
 977 /**
 978  * Converts struct cl_attr to struct ost_lvb.
 979  *
 980  * \see cl_lvb2attr
 981  */
 982 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr)
 983 {
 984         ENTRY;
 985         lvb->lvb_size   = attr->cat_size;
 986         lvb->lvb_mtime  = attr->cat_mtime;
 987         lvb->lvb_atime  = attr->cat_atime;
 988         lvb->lvb_ctime  = attr->cat_ctime;
 989         lvb->lvb_blocks = attr->cat_blocks;
 990         EXIT;
 991 }
 992 EXPORT_SYMBOL(cl_attr2lvb);
 993
 994 /**
 995  * Converts struct ost_lvb to struct cl_attr.
 996  *
 997  * \see cl_attr2lvb
 998  */
 999 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb)
1000 {
1001         ENTRY;
1002         attr->cat_size   = lvb->lvb_size;
1003         attr->cat_mtime  = lvb->lvb_mtime;
1004         attr->cat_atime  = lvb->lvb_atime;
1005         attr->cat_ctime  = lvb->lvb_ctime;
1006         attr->cat_blocks = lvb->lvb_blocks;
1007         EXIT;
1008 }
1009 EXPORT_SYMBOL(cl_lvb2attr);
1010
1011 /*****************************************************************************
1012  *
1013  * Temporary prototype thing: mirror obd-devices into cl devices.
1014  *
1015  */
1016
1017 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
1018                                 struct lu_device_type *ldt,
1019                                 struct lu_device *next)
1020 {
1021         const char       *typename;
1022         struct lu_device *d;
1023
1024         LASSERT(ldt != NULL);
1025
1026         typename = ldt->ldt_name;
1027         d = ldt->ldt_ops->ldto_device_alloc(env, ldt, NULL);
1028         if (!IS_ERR(d)) {
1029                 int rc;
1030
1031                 if (site != NULL)
1032                         d->ld_site = site;
1033                 rc = ldt->ldt_ops->ldto_device_init(env, d, typename, next);
1034                 if (rc == 0) {
1035                         lu_device_get(d);
1036                         lu_ref_add(&d->ld_reference,
1037                                    "lu-stack", &lu_site_init);
1038                 } else {
1039                         ldt->ldt_ops->ldto_device_free(env, d);
1040                         CERROR("can't init device '%s', %d\n", typename, rc);
1041                         d = ERR_PTR(rc);
1042                 }
1043         } else
1044                 CERROR("Cannot allocate device: '%s'\n", typename);
1045         return lu2cl_dev(d);
1046 }
1047 EXPORT_SYMBOL(cl_type_setup);
1048
1049 /**
1050  * Finalize device stack by calling lu_stack_fini().
1051  */
1052 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl)
1053 {
1054         lu_stack_fini(env, cl2lu_dev(cl));
1055 }
1056 EXPORT_SYMBOL(cl_stack_fini);
1057
1058 int  cl_lock_init(void);
1059 void cl_lock_fini(void);
1060
1061 int  cl_page_init(void);
1062 void cl_page_fini(void);
1063
1064 static struct lu_context_key cl_key;
1065
1066 struct cl_thread_info *cl_env_info(const struct lu_env *env)
1067 {
1068         return lu_context_key_get(&env->le_ctx, &cl_key);
1069 }
1070
1071 /* defines cl0_key_{init,fini}() */
1072 LU_KEY_INIT_FINI(cl0, struct cl_thread_info);
1073
1074 static void *cl_key_init(const struct lu_context *ctx,
1075                          struct lu_context_key *key)
1076 {
1077         struct cl_thread_info *info;
1078
1079         info = cl0_key_init(ctx, key);
1080         if (!IS_ERR(info)) {
1081                 int i;
1082
1083                 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1084                         lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1085         }
1086         return info;
1087 }
1088
1089 static void cl_key_fini(const struct lu_context *ctx,
1090                         struct lu_context_key *key, void *data)
1091 {
1092         struct cl_thread_info *info;
1093         int i;
1094
1095         info = data;
1096         for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1097                 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1098         cl0_key_fini(ctx, key, data);
1099 }
1100
1101 static void cl_key_exit(const struct lu_context *ctx,
1102                         struct lu_context_key *key, void *data)
1103 {
1104         struct cl_thread_info *info = data;
1105         int i;
1106
1107         for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i) {
1108                 LASSERT(info->clt_counters[i].ctc_nr_held == 0);
1109                 LASSERT(info->clt_counters[i].ctc_nr_used == 0);
1110                 LASSERT(info->clt_counters[i].ctc_nr_locks_acquired == 0);
1111                 LASSERT(info->clt_counters[i].ctc_nr_locks_locked == 0);
1112                 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1113                 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1114         }
1115 }
1116
1117 static struct lu_context_key cl_key = {
1118         .lct_tags = LCT_CL_THREAD,
1119         .lct_init = cl_key_init,
1120         .lct_fini = cl_key_fini,
1121         .lct_exit = cl_key_exit
1122 };
1123
1124 static struct lu_kmem_descr cl_object_caches[] = {
1125         {
1126                 .ckd_cache = &cl_env_kmem,
1127                 .ckd_name  = "cl_env_kmem",
1128                 .ckd_size  = sizeof (struct cl_env)
1129         },
1130         {
1131                 .ckd_cache = NULL
1132         }
1133 };
1134
1135 /**
1136  * Global initialization of cl-data. Create kmem caches, register
1137  * lu_context_key's, etc.
1138  *
1139  * \see cl_global_fini()
1140  */
1141 int cl_global_init(void)
1142 {
1143         int result;
1144
1145         cl_env_hash = cfs_hash_create("cl_env", 8, 10, &cl_env_hops,
1146                                       CFS_HASH_REHASH);
1147         if (cl_env_hash == NULL)
1148                 return -ENOMEM;
1149
1150         result = lu_kmem_init(cl_object_caches);
1151         if (result == 0) {
1152                 LU_CONTEXT_KEY_INIT(&cl_key);
1153                 result = lu_context_key_register(&cl_key);
1154                 if (result == 0) {
1155                         result = cl_lock_init();
1156                         if (result == 0)
1157                                 result = cl_page_init();
1158                 }
1159         }
1160         if (result)
1161                 cfs_hash_putref(cl_env_hash);
1162         return result;
1163 }
1164
1165 /**
1166  * Finalization of global cl-data. Dual to cl_global_init().
1167  */
1168 void cl_global_fini(void)
1169 {
1170         cl_lock_fini();
1171         cl_page_fini();
1172         lu_context_key_degister(&cl_key);
1173         lu_kmem_fini(cl_object_caches);
1174         cfs_hash_putref(cl_env_hash);
1175 }