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 2008 Sun Microsystems, Inc.  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 <class_hash.h> /* for lustre_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 struct lock_class_key cl_page_guard_class;
  74 /** Lock class of cl_object_header::coh_lock_guard */
  75 static struct lock_class_key cl_lock_guard_class;
  76 /** Lock class of cl_object_header::coh_attr_guard */
  77 static struct lock_class_key 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                 spin_lock_init(&h->coh_page_guard);
  90                 spin_lock_init(&h->coh_lock_guard);
  91                 spin_lock_init(&h->coh_attr_guard);
  92                 lockdep_set_class(&h->coh_attr_guard, &cl_page_guard_class);
  93                 lockdep_set_class(&h->coh_attr_guard, &cl_lock_guard_class);
  94                 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(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         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 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         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         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         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         list_for_each_entry_reverse(obj, &top->loh_layers, co_lu.lo_linkage) {
 265                 if (obj->co_ops->coo_attr_set != NULL) {
 266                         result = obj->co_ops->coo_attr_set(env, obj, attr, v);
 267                         if (result != 0) {
 268                                 if (result > 0)
 269                                         result = 0;
 270                                 break;
 271                         }
 272                 }
 273         }
 274         RETURN(result);
 275 }
 276 EXPORT_SYMBOL(cl_object_attr_set);
 277
 278 /**
 279  * Notifies layers (bottom-to-top) that glimpse AST was received.
 280  *
 281  * Layers have to fill \a lvb fields with information that will be shipped
 282  * back to glimpse issuer.
 283  *
 284  * \see cl_lock_operations::clo_glimpse()
 285  */
 286 int cl_object_glimpse(const struct lu_env *env, struct cl_object *obj,
 287                       struct ost_lvb *lvb)
 288 {
 289         struct lu_object_header *top;
 290         int result;
 291
 292         ENTRY;
 293         top = obj->co_lu.lo_header;
 294         result = 0;
 295         list_for_each_entry_reverse(obj, &top->loh_layers, co_lu.lo_linkage) {
 296                 if (obj->co_ops->coo_glimpse != NULL) {
 297                         result = obj->co_ops->coo_glimpse(env, obj, lvb);
 298                         if (result != 0)
 299                                 break;
 300                 }
 301         }
 302         LU_OBJECT_HEADER(D_DLMTRACE, env, lu_object_top(top),
 303                          "size: "LPU64" mtime: "LPU64" atime: "LPU64" "
 304                          "ctime: "LPU64" blocks: "LPU64"\n",
 305                          lvb->lvb_size, lvb->lvb_mtime, lvb->lvb_atime,
 306                          lvb->lvb_ctime, lvb->lvb_blocks);
 307         RETURN(result);
 308 }
 309 EXPORT_SYMBOL(cl_object_glimpse);
 310
 311 /**
 312  * Updates a configuration of an object \a obj.
 313  */
 314 int cl_conf_set(const struct lu_env *env, struct cl_object *obj,
 315                 const struct cl_object_conf *conf)
 316 {
 317         struct lu_object_header *top;
 318         int result;
 319
 320         ENTRY;
 321         top = obj->co_lu.lo_header;
 322         result = 0;
 323         list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
 324                 if (obj->co_ops->coo_conf_set != NULL) {
 325                         result = obj->co_ops->coo_conf_set(env, obj, conf);
 326                         if (result != 0)
 327                                 break;
 328                 }
 329         }
 330         RETURN(result);
 331 }
 332 EXPORT_SYMBOL(cl_conf_set);
 333
 334 /**
 335  * Helper function removing all object locks, and marking object for
 336  * deletion. All object pages must have been deleted at this point.
 337  *
 338  * This is called by cl_inode_fini() and lov_object_delete() to destroy top-
 339  * and sub- objects respectively.
 340  */
 341 void cl_object_kill(const struct lu_env *env, struct cl_object *obj)
 342 {
 343         struct cl_object_header *hdr;
 344
 345         hdr = cl_object_header(obj);
 346         LASSERT(hdr->coh_tree.rnode == NULL);
 347         LASSERT(hdr->coh_pages == 0);
 348
 349         set_bit(LU_OBJECT_HEARD_BANSHEE, &hdr->coh_lu.loh_flags);
 350         /*
 351          * Destroy all locks. Object destruction (including cl_inode_fini())
 352          * cannot cancel the locks, because in the case of a local client,
 353          * where client and server share the same thread running
 354          * prune_icache(), this can dead-lock with ldlm_cancel_handler()
 355          * waiting on __wait_on_freeing_inode().
 356          */
 357         cl_locks_prune(env, obj, 0);
 358 }
 359 EXPORT_SYMBOL(cl_object_kill);
 360
 361 /**
 362  * Prunes caches of pages and locks for this object.
 363  */
 364 void cl_object_prune(const struct lu_env *env, struct cl_object *obj)
 365 {
 366         ENTRY;
 367         cl_pages_prune(env, obj);
 368         cl_locks_prune(env, obj, 1);
 369         EXIT;
 370 }
 371 EXPORT_SYMBOL(cl_object_prune);
 372
 373 /**
 374  * Check if the object has locks.
 375  */
 376 int cl_object_has_locks(struct cl_object *obj)
 377 {
 378         struct cl_object_header *head = cl_object_header(obj);
 379         int has;
 380
 381         spin_lock(&head->coh_lock_guard);
 382         has = list_empty(&head->coh_locks);
 383         spin_unlock(&head->coh_lock_guard);
 384
 385         return (has == 0);
 386 }
 387 EXPORT_SYMBOL(cl_object_has_locks);
 388
 389 void cache_stats_init(struct cache_stats *cs, const char *name)
 390 {
 391         cs->cs_name = name;
 392         atomic_set(&cs->cs_lookup, 0);
 393         atomic_set(&cs->cs_hit,    0);
 394         atomic_set(&cs->cs_total,  0);
 395         atomic_set(&cs->cs_busy,   0);
 396 }
 397
 398 int cache_stats_print(const struct cache_stats *cs,
 399                       char *page, int count, int h)
 400 {
 401         int nob = 0;
 402 /*
 403        lookup    hit  total cached create
 404   env: ...... ...... ...... ...... ......
 405 */
 406         if (h)
 407                 nob += snprintf(page, count,
 408                                 "       lookup    hit  total   busy create\n");
 409
 410         nob += snprintf(page + nob, count - nob,
 411                         "%5.5s: %6u %6u %6u %6u %6u",
 412                         cs->cs_name,
 413                         atomic_read(&cs->cs_lookup),
 414                         atomic_read(&cs->cs_hit),
 415                         atomic_read(&cs->cs_total),
 416                         atomic_read(&cs->cs_busy),
 417                         atomic_read(&cs->cs_created));
 418         return nob;
 419 }
 420
 421 /**
 422  * Initialize client site.
 423  *
 424  * Perform common initialization (lu_site_init()), and initialize statistical
 425  * counters. Also perform global initializations on the first call.
 426  */
 427 int cl_site_init(struct cl_site *s, struct cl_device *d)
 428 {
 429         int i;
 430         int result;
 431
 432         result = lu_site_init(&s->cs_lu, &d->cd_lu_dev);
 433         if (result == 0) {
 434                 cache_stats_init(&s->cs_pages, "pages");
 435                 cache_stats_init(&s->cs_locks, "locks");
 436                 for (i = 0; i < ARRAY_SIZE(s->cs_pages_state); ++i)
 437                         atomic_set(&s->cs_pages_state[0], 0);
 438                 for (i = 0; i < ARRAY_SIZE(s->cs_locks_state); ++i)
 439                         atomic_set(&s->cs_locks_state[i], 0);
 440         }
 441         return result;
 442 }
 443 EXPORT_SYMBOL(cl_site_init);
 444
 445 /**
 446  * Finalize client site. Dual to cl_site_init().
 447  */
 448 void cl_site_fini(struct cl_site *s)
 449 {
 450         lu_site_fini(&s->cs_lu);
 451 }
 452 EXPORT_SYMBOL(cl_site_fini);
 453
 454 static struct cache_stats cl_env_stats = {
 455         .cs_name    = "envs",
 456         .cs_created = ATOMIC_INIT(0),
 457         .cs_lookup  = ATOMIC_INIT(0),
 458         .cs_hit     = ATOMIC_INIT(0),
 459         .cs_total   = ATOMIC_INIT(0),
 460         .cs_busy    = ATOMIC_INIT(0)
 461 };
 462
 463 /**
 464  * Outputs client site statistical counters into a buffer. Suitable for
 465  * ll_rd_*()-style functions.
 466  */
 467 int cl_site_stats_print(const struct cl_site *site, char *page, int count)
 468 {
 469         int nob;
 470         int i;
 471         static const char *pstate[] = {
 472                 [CPS_CACHED]  = "c",
 473                 [CPS_OWNED]   = "o",
 474                 [CPS_PAGEOUT] = "w",
 475                 [CPS_PAGEIN]  = "r",
 476                 [CPS_FREEING] = "f"
 477         };
 478         static const char *lstate[] = {
 479                 [CLS_NEW]       = "n",
 480                 [CLS_QUEUING]   = "q",
 481                 [CLS_ENQUEUED]  = "e",
 482                 [CLS_HELD]      = "h",
 483                 [CLS_UNLOCKING] = "u",
 484                 [CLS_CACHED]    = "c",
 485                 [CLS_FREEING]   = "f"
 486         };
 487 /*
 488        lookup    hit  total   busy create
 489 pages: ...... ...... ...... ...... ...... [...... ...... ...... ......]
 490 locks: ...... ...... ...... ...... ...... [...... ...... ...... ...... ......]
 491   env: ...... ...... ...... ...... ......
 492  */
 493         nob = lu_site_stats_print(&site->cs_lu, page, count);
 494         nob += cache_stats_print(&site->cs_pages, page + nob, count - nob, 1);
 495         nob += snprintf(page + nob, count - nob, " [");
 496         for (i = 0; i < ARRAY_SIZE(site->cs_pages_state); ++i)
 497                 nob += snprintf(page + nob, count - nob, "%s: %u ",
 498                                 pstate[i],
 499                                 atomic_read(&site->cs_pages_state[i]));
 500         nob += snprintf(page + nob, count - nob, "]\n");
 501         nob += cache_stats_print(&site->cs_locks, page + nob, count - nob, 0);
 502         nob += snprintf(page + nob, count - nob, " [");
 503         for (i = 0; i < ARRAY_SIZE(site->cs_locks_state); ++i)
 504                 nob += snprintf(page + nob, count - nob, "%s: %u ",
 505                                 lstate[i],
 506                                 atomic_read(&site->cs_locks_state[i]));
 507         nob += snprintf(page + nob, count - nob, "]\n");
 508         nob += cache_stats_print(&cl_env_stats, page + nob, count - nob, 0);
 509         nob += snprintf(page + nob, count - nob, "\n");
 510         return nob;
 511 }
 512 EXPORT_SYMBOL(cl_site_stats_print);
 513
 514 /*****************************************************************************
 515  *
 516  * lu_env handling on client.
 517  *
 518  */
 519
 520 static CFS_LIST_HEAD(cl_envs);
 521 static unsigned cl_envs_cached_nr  = 0;
 522 static unsigned cl_envs_cached_max = 128; /* XXX: prototype: arbitrary limit
 523                                            * for now. */
 524 static spinlock_t cl_envs_guard = SPIN_LOCK_UNLOCKED;
 525
 526 struct cl_env {
 527         void             *ce_magic;
 528         struct lu_env     ce_lu;
 529         struct lu_context ce_ses;
 530         /**
 531          * This allows cl_env to be entered into cl_env_hash which implements
 532          * the current thread -> client environment lookup.
 533          */
 534         struct hlist_node ce_node;
 535         /**
 536          * Owner for the current cl_env, the key for lustre_hash.
 537          * Now current thread pointer is stored.
 538          */
 539         void             *ce_owner;
 540         /*
 541          * Linkage into global list of all client environments. Used for
 542          * garbage collection.
 543          */
 544         struct list_head  ce_linkage;
 545         /*
 546          *
 547          */
 548         int               ce_ref;
 549         /*
 550          * Debugging field: address of the caller who made original
 551          * allocation.
 552          */
 553         void             *ce_debug;
 554 };
 555
 556 #define CL_ENV_INC(counter) atomic_inc(&cl_env_stats.counter)
 557
 558 #define CL_ENV_DEC(counter)                                             \
 559         do {                                                            \
 560                 LASSERT(atomic_read(&cl_env_stats.counter) > 0);        \
 561                 atomic_dec(&cl_env_stats.counter);                      \
 562         } while (0)
 563
 564 /*****************************************************************************
 565  * Routins to use lustre_hash functionality to bind the current thread
 566  * to cl_env
 567  */
 568
 569 /** lustre hash to manage the cl_env for current thread */
 570 static lustre_hash_t *cl_env_hash;
 571 static void cl_env_init0(struct cl_env *cle, void *debug);
 572
 573 static unsigned cl_env_hops_hash(lustre_hash_t *lh, void *key, unsigned mask)
 574 {
 575 #if BITS_PER_LONG == 64
 576         return lh_u64_hash((__u64)key, mask);
 577 #else
 578         return lh_u32_hash((__u32)key, mask);
 579 #endif
 580 }
 581
 582 static void *cl_env_hops_obj(struct hlist_node *hn)
 583 {
 584         struct cl_env *cle = hlist_entry(hn, struct cl_env, ce_node);
 585         LASSERT(cle->ce_magic == &cl_env_init0);
 586         return (void *)cle;
 587 }
 588
 589 static int cl_env_hops_compare(void *key, struct hlist_node *hn)
 590 {
 591         struct cl_env *cle = cl_env_hops_obj(hn);
 592
 593         LASSERT(cle->ce_owner != NULL);
 594         return (key == cle->ce_owner);
 595 }
 596
 597 static lustre_hash_ops_t cl_env_hops = {
 598         .lh_hash    = cl_env_hops_hash,
 599         .lh_compare = cl_env_hops_compare,
 600         .lh_key     = cl_env_hops_obj,
 601         .lh_get     = cl_env_hops_obj,
 602         .lh_put     = cl_env_hops_obj,
 603 };
 604
 605 static inline struct cl_env *cl_env_fetch(void)
 606 {
 607         struct cl_env *cle;
 608         cle = lustre_hash_lookup(cl_env_hash, cfs_current());
 609         LASSERT(ergo(cle, cle->ce_magic == &cl_env_init0));
 610         return cle;
 611 }
 612
 613 static inline void cl_env_attach(struct cl_env *cle)
 614 {
 615         if (cle) {
 616                 int rc;
 617                 LASSERT(cle->ce_owner == NULL);
 618                 cle->ce_owner = cfs_current();
 619                 rc = lustre_hash_add_unique(cl_env_hash, cle->ce_owner,
 620                                             &cle->ce_node);
 621                 LASSERT(rc == 0);
 622         }
 623 }
 624
 625 static inline struct cl_env *cl_env_detach(struct cl_env *cle)
 626 {
 627         if (cle == NULL)
 628                 cle = cl_env_fetch();
 629         if (cle && cle->ce_owner) {
 630                 void *cookie;
 631                 LASSERT(cle->ce_owner == cfs_current());
 632                 cookie = lustre_hash_del(cl_env_hash, cle->ce_owner,
 633                                          &cle->ce_node);
 634                 cle->ce_owner = NULL;
 635                 LASSERT(cookie == cle);
 636         }
 637         return cle;
 638 }
 639 /* ----------------------- hash routines end ---------------------------- */
 640
 641 static void cl_env_init0(struct cl_env *cle, void *debug)
 642 {
 643         LASSERT(cle->ce_ref == 0);
 644         LASSERT(cle->ce_magic == &cl_env_init0);
 645         LASSERT(cle->ce_debug == NULL && cle->ce_owner == NULL);
 646
 647         cle->ce_ref = 1;
 648         cle->ce_debug = debug;
 649         CL_ENV_INC(cs_busy);
 650 }
 651
 652 static struct lu_env *cl_env_new(__u32 tags, void *debug)
 653 {
 654         struct lu_env *env;
 655         struct cl_env *cle;
 656
 657         OBD_SLAB_ALLOC_PTR_GFP(cle, cl_env_kmem, CFS_ALLOC_IO);
 658         if (cle != NULL) {
 659                 int rc;
 660
 661                 CFS_INIT_LIST_HEAD(&cle->ce_linkage);
 662                 cle->ce_magic = &cl_env_init0;
 663                 env = &cle->ce_lu;
 664                 rc = lu_env_init(env, LCT_CL_THREAD|tags);
 665                 if (rc == 0) {
 666                         rc = lu_context_init(&cle->ce_ses, LCT_SESSION|tags);
 667                         if (rc == 0) {
 668                                 lu_context_enter(&cle->ce_ses);
 669                                 env->le_ses = &cle->ce_ses;
 670                                 cl_env_init0(cle, debug);
 671                         } else
 672                                 lu_env_fini(env);
 673                 }
 674                 if (rc != 0) {
 675                         OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
 676                         env = ERR_PTR(rc);
 677                 } else {
 678                         CL_ENV_INC(cs_created);
 679                         CL_ENV_INC(cs_total);
 680                 }
 681         } else
 682                 env = ERR_PTR(-ENOMEM);
 683         return env;
 684 }
 685
 686 static void cl_env_fini(struct cl_env *cle)
 687 {
 688         CL_ENV_DEC(cs_total);
 689         lu_context_fini(&cle->ce_lu.le_ctx);
 690         lu_context_fini(&cle->ce_ses);
 691         OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
 692 }
 693
 694 static struct lu_env *cl_env_obtain(void *debug)
 695 {
 696         struct cl_env *cle;
 697         struct lu_env *env;
 698
 699         ENTRY;
 700         spin_lock(&cl_envs_guard);
 701         LASSERT(equi(cl_envs_cached_nr == 0, list_empty(&cl_envs)));
 702         if (cl_envs_cached_nr > 0) {
 703                 int rc;
 704
 705                 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
 706                 list_del_init(&cle->ce_linkage);
 707                 cl_envs_cached_nr--;
 708                 spin_unlock(&cl_envs_guard);
 709
 710                 env = &cle->ce_lu;
 711                 rc = lu_env_refill(env);
 712                 if (rc == 0) {
 713                         cl_env_init0(cle, debug);
 714                         lu_context_enter(&env->le_ctx);
 715                         lu_context_enter(&cle->ce_ses);
 716                 } else {
 717                         cl_env_fini(cle);
 718                         env = ERR_PTR(rc);
 719                 }
 720         } else {
 721                 spin_unlock(&cl_envs_guard);
 722                 env = cl_env_new(0, debug);
 723         }
 724         RETURN(env);
 725 }
 726
 727 static inline struct cl_env *cl_env_container(struct lu_env *env)
 728 {
 729         return container_of(env, struct cl_env, ce_lu);
 730 }
 731
 732 struct lu_env *cl_env_peek(int *refcheck)
 733 {
 734         struct lu_env *env;
 735         struct cl_env *cle;
 736
 737         CL_ENV_INC(cs_lookup);
 738
 739         /* check that we don't go far from untrusted pointer */
 740         CLASSERT(offsetof(struct cl_env, ce_magic) == 0);
 741
 742         env = NULL;
 743         cle = cl_env_fetch();
 744         if (cle != NULL) {
 745                 CL_ENV_INC(cs_hit);
 746                 env = &cle->ce_lu;
 747                 *refcheck = ++cle->ce_ref;
 748         }
 749         CDEBUG(D_OTHER, "%i@%p\n", cle ? cle->ce_ref : 0, cle);
 750         return env;
 751 }
 752 EXPORT_SYMBOL(cl_env_peek);
 753
 754 /**
 755  * Returns lu_env: if there already is an environment associated with the
 756  * current thread, it is returned, otherwise, new environment is allocated.
 757  *
 758  * Allocations are amortized through the global cache of environments.
 759  *
 760  * \param refcheck pointer to a counter used to detect environment leaks. In
 761  * the usual case cl_env_get() and cl_env_put() are called in the same lexical
 762  * scope and pointer to the same integer is passed as \a refcheck. This is
 763  * used to detect missed cl_env_put().
 764  *
 765  * \see cl_env_put()
 766  */
 767 struct lu_env *cl_env_get(int *refcheck)
 768 {
 769         struct lu_env *env;
 770
 771         env = cl_env_peek(refcheck);
 772         if (env == NULL) {
 773                 env = cl_env_obtain(__builtin_return_address(0));
 774                 if (!IS_ERR(env)) {
 775                         struct cl_env *cle;
 776
 777                         cle = cl_env_container(env);
 778                         cl_env_attach(cle);
 779                         *refcheck = cle->ce_ref;
 780                         CDEBUG(D_OTHER, "%i@%p\n", cle->ce_ref, cle);
 781                 }
 782         }
 783         return env;
 784 }
 785 EXPORT_SYMBOL(cl_env_get);
 786
 787 /**
 788  * Forces an allocation of a fresh environment with given tags.
 789  *
 790  * \see cl_env_get()
 791  */
 792 struct lu_env *cl_env_alloc(int *refcheck, __u32 tags)
 793 {
 794         struct lu_env *env;
 795
 796         LASSERT(cl_env_peek(refcheck) == NULL);
 797         env = cl_env_new(tags, __builtin_return_address(0));
 798         if (!IS_ERR(env)) {
 799                 struct cl_env *cle;
 800
 801                 cle = cl_env_container(env);
 802                 *refcheck = cle->ce_ref;
 803                 CDEBUG(D_OTHER, "%i@%p\n", cle->ce_ref, cle);
 804         }
 805         return env;
 806 }
 807 EXPORT_SYMBOL(cl_env_alloc);
 808
 809 static void cl_env_exit(struct cl_env *cle)
 810 {
 811         LASSERT(cle->ce_owner == NULL);
 812         lu_context_exit(&cle->ce_lu.le_ctx);
 813         lu_context_exit(&cle->ce_ses);
 814 }
 815
 816 /**
 817  * Finalizes and frees a given number of cached environments. This is done to
 818  * (1) free some memory (not currently hooked into VM), or (2) release
 819  * references to modules.
 820  */
 821 unsigned cl_env_cache_purge(unsigned nr)
 822 {
 823         struct cl_env *cle;
 824
 825         ENTRY;
 826         spin_lock(&cl_envs_guard);
 827         for (; !list_empty(&cl_envs) && nr > 0; --nr) {
 828                 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
 829                 list_del_init(&cle->ce_linkage);
 830                 LASSERT(cl_envs_cached_nr > 0);
 831                 cl_envs_cached_nr--;
 832                 spin_unlock(&cl_envs_guard);
 833
 834                 cl_env_fini(cle);
 835                 spin_lock(&cl_envs_guard);
 836         }
 837         LASSERT(equi(cl_envs_cached_nr == 0, list_empty(&cl_envs)));
 838         spin_unlock(&cl_envs_guard);
 839         RETURN(nr);
 840 }
 841 EXPORT_SYMBOL(cl_env_cache_purge);
 842
 843 /**
 844  * Release an environment.
 845  *
 846  * Decrement \a env reference counter. When counter drops to 0, nothing in
 847  * this thread is using environment and it is returned to the allocation
 848  * cache, or freed straight away, if cache is large enough.
 849  */
 850 void cl_env_put(struct lu_env *env, int *refcheck)
 851 {
 852         struct cl_env *cle;
 853
 854         cle = cl_env_container(env);
 855
 856         LASSERT(cle->ce_ref > 0);
 857         LASSERT(ergo(refcheck != NULL, cle->ce_ref == *refcheck));
 858
 859         CDEBUG(D_OTHER, "%i@%p\n", cle->ce_ref, cle);
 860         if (--cle->ce_ref == 0) {
 861                 CL_ENV_DEC(cs_busy);
 862                 cl_env_detach(cle);
 863                 cle->ce_debug = NULL;
 864                 cl_env_exit(cle);
 865                 /*
 866                  * Don't bother to take a lock here.
 867                  *
 868                  * Return environment to the cache only when it was allocated
 869                  * with the standard tags.
 870                  */
 871                 if (cl_envs_cached_nr < cl_envs_cached_max &&
 872                     (env->le_ctx.lc_tags & ~LCT_HAS_EXIT) == LCT_CL_THREAD &&
 873                     (env->le_ses->lc_tags & ~LCT_HAS_EXIT) == LCT_SESSION) {
 874                         spin_lock(&cl_envs_guard);
 875                         list_add(&cle->ce_linkage, &cl_envs);
 876                         cl_envs_cached_nr++;
 877                         spin_unlock(&cl_envs_guard);
 878                 } else
 879                         cl_env_fini(cle);
 880         }
 881 }
 882 EXPORT_SYMBOL(cl_env_put);
 883
 884 /**
 885  * Declares a point of re-entrancy.
 886  *
 887  * \see cl_env_reexit()
 888  */
 889 void *cl_env_reenter(void)
 890 {
 891         return cl_env_detach(NULL);
 892 }
 893 EXPORT_SYMBOL(cl_env_reenter);
 894
 895 /**
 896  * Exits re-entrancy.
 897  */
 898 void cl_env_reexit(void *cookie)
 899 {
 900         cl_env_detach(NULL);
 901         cl_env_attach(cookie);
 902 }
 903 EXPORT_SYMBOL(cl_env_reexit);
 904
 905 /**
 906  * Setup user-supplied \a env as a current environment. This is to be used to
 907  * guaranteed that environment exists even when cl_env_get() fails. It is up
 908  * to user to ensure proper concurrency control.
 909  *
 910  * \see cl_env_unplant()
 911  */
 912 void cl_env_implant(struct lu_env *env, int *refcheck)
 913 {
 914         struct cl_env *cle = cl_env_container(env);
 915
 916         LASSERT(cle->ce_ref > 0);
 917
 918         cl_env_attach(cle);
 919         cl_env_get(refcheck);
 920         CDEBUG(D_OTHER, "%i@%p\n", cle->ce_ref, cle);
 921 }
 922 EXPORT_SYMBOL(cl_env_implant);
 923
 924 /**
 925  * Detach environment installed earlier by cl_env_implant().
 926  */
 927 void cl_env_unplant(struct lu_env *env, int *refcheck)
 928 {
 929         struct cl_env *cle = cl_env_container(env);
 930
 931         LASSERT(cle->ce_ref > 1);
 932
 933         CDEBUG(D_OTHER, "%i@%p\n", cle->ce_ref, cle);
 934
 935         cl_env_detach(cle);
 936         cl_env_put(env, refcheck);
 937 }
 938 EXPORT_SYMBOL(cl_env_unplant);
 939
 940 struct lu_env *cl_env_nested_get(struct cl_env_nest *nest)
 941 {
 942         struct lu_env *env;
 943
 944         nest->cen_cookie = NULL;
 945         env = cl_env_peek(&nest->cen_refcheck);
 946         if (env != NULL) {
 947                 if (!cl_io_is_going(env))
 948                         return env;
 949                 else {
 950                         cl_env_put(env, &nest->cen_refcheck);
 951                         nest->cen_cookie = cl_env_reenter();
 952                 }
 953         }
 954         env = cl_env_get(&nest->cen_refcheck);
 955         if (IS_ERR(env)) {
 956                 cl_env_reexit(nest->cen_cookie);
 957                 return env;
 958         }
 959
 960         LASSERT(!cl_io_is_going(env));
 961         return env;
 962 }
 963 EXPORT_SYMBOL(cl_env_nested_get);
 964
 965 void cl_env_nested_put(struct cl_env_nest *nest, struct lu_env *env)
 966 {
 967         cl_env_put(env, &nest->cen_refcheck);
 968         cl_env_reexit(nest->cen_cookie);
 969 }
 970 EXPORT_SYMBOL(cl_env_nested_put);
 971
 972 /**
 973  * Converts struct cl_attr to struct ost_lvb.
 974  *
 975  * \see cl_lvb2attr
 976  */
 977 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr)
 978 {
 979         ENTRY;
 980         lvb->lvb_size   = attr->cat_size;
 981         lvb->lvb_mtime  = attr->cat_mtime;
 982         lvb->lvb_atime  = attr->cat_atime;
 983         lvb->lvb_ctime  = attr->cat_ctime;
 984         lvb->lvb_blocks = attr->cat_blocks;
 985         EXIT;
 986 }
 987 EXPORT_SYMBOL(cl_attr2lvb);
 988
 989 /**
 990  * Converts struct ost_lvb to struct cl_attr.
 991  *
 992  * \see cl_attr2lvb
 993  */
 994 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb)
 995 {
 996         ENTRY;
 997         attr->cat_size   = lvb->lvb_size;
 998         attr->cat_mtime  = lvb->lvb_mtime;
 999         attr->cat_atime  = lvb->lvb_atime;
1000         attr->cat_ctime  = lvb->lvb_ctime;
1001         attr->cat_blocks = lvb->lvb_blocks;
1002         EXIT;
1003 }
1004 EXPORT_SYMBOL(cl_lvb2attr);
1005
1006 /*****************************************************************************
1007  *
1008  * Temporary prototype thing: mirror obd-devices into cl devices.
1009  *
1010  */
1011
1012 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
1013                                 struct lu_device_type *ldt,
1014                                 struct lu_device *next)
1015 {
1016         const char       *typename;
1017         struct lu_device *d;
1018
1019         LASSERT(ldt != NULL);
1020
1021         typename = ldt->ldt_name;
1022         d = ldt->ldt_ops->ldto_device_alloc(env, ldt, NULL);
1023         if (!IS_ERR(d)) {
1024                 int rc;
1025
1026                 if (site != NULL)
1027                         d->ld_site = site;
1028                 rc = ldt->ldt_ops->ldto_device_init(env, d, typename, next);
1029                 if (rc == 0) {
1030                         lu_device_get(d);
1031                         lu_ref_add(&d->ld_reference,
1032                                    "lu-stack", &lu_site_init);
1033                 } else {
1034                         ldt->ldt_ops->ldto_device_free(env, d);
1035                         CERROR("can't init device '%s', %d\n", typename, rc);
1036                         d = ERR_PTR(rc);
1037                 }
1038         } else
1039                 CERROR("Cannot allocate device: '%s'\n", typename);
1040         return lu2cl_dev(d);
1041 }
1042 EXPORT_SYMBOL(cl_type_setup);
1043
1044 /**
1045  * Finalize device stack by calling lu_stack_fini().
1046  */
1047 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl)
1048 {
1049         lu_stack_fini(env, cl2lu_dev(cl));
1050 }
1051 EXPORT_SYMBOL(cl_stack_fini);
1052
1053 int  cl_lock_init(void);
1054 void cl_lock_fini(void);
1055
1056 int  cl_page_init(void);
1057 void cl_page_fini(void);
1058
1059 static struct lu_context_key cl_key;
1060
1061 struct cl_thread_info *cl_env_info(const struct lu_env *env)
1062 {
1063         return lu_context_key_get(&env->le_ctx, &cl_key);
1064 }
1065
1066 /* defines cl0_key_{init,fini}() */
1067 LU_KEY_INIT_FINI(cl0, struct cl_thread_info);
1068
1069 static void *cl_key_init(const struct lu_context *ctx,
1070                          struct lu_context_key *key)
1071 {
1072         struct cl_thread_info *info;
1073
1074         info = cl0_key_init(ctx, key);
1075         if (!IS_ERR(info)) {
1076                 int i;
1077
1078                 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1079                         lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1080         }
1081         return info;
1082 }
1083
1084 static void cl_key_fini(const struct lu_context *ctx,
1085                         struct lu_context_key *key, void *data)
1086 {
1087         struct cl_thread_info *info;
1088         int i;
1089
1090         info = data;
1091         for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1092                 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1093         cl0_key_fini(ctx, key, data);
1094 }
1095
1096 static void cl_key_exit(const struct lu_context *ctx,
1097                         struct lu_context_key *key, void *data)
1098 {
1099         struct cl_thread_info *info = data;
1100         int i;
1101
1102         for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i) {
1103                 LASSERT(info->clt_counters[i].ctc_nr_held == 0);
1104                 LASSERT(info->clt_counters[i].ctc_nr_used == 0);
1105                 LASSERT(info->clt_counters[i].ctc_nr_locks_acquired == 0);
1106                 LASSERT(info->clt_counters[i].ctc_nr_locks_locked == 0);
1107                 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1108                 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1109         }
1110 }
1111
1112 static struct lu_context_key cl_key = {
1113         .lct_tags = LCT_CL_THREAD,
1114         .lct_init = cl_key_init,
1115         .lct_fini = cl_key_fini,
1116         .lct_exit = cl_key_exit
1117 };
1118
1119 static struct lu_kmem_descr cl_object_caches[] = {
1120         {
1121                 .ckd_cache = &cl_env_kmem,
1122                 .ckd_name  = "cl_env_kmem",
1123                 .ckd_size  = sizeof (struct cl_env)
1124         },
1125         {
1126                 .ckd_cache = NULL
1127         }
1128 };
1129
1130 /**
1131  * Global initialization of cl-data. Create kmem caches, register
1132  * lu_context_key's, etc.
1133  *
1134  * \see cl_global_fini()
1135  */
1136 int cl_global_init(void)
1137 {
1138         int result;
1139
1140         cl_env_hash = lustre_hash_init("cl_env", 8, 10, &cl_env_hops, 0);
1141         if (cl_env_hash == NULL)
1142                 return -ENOMEM;
1143
1144         result = lu_kmem_init(cl_object_caches);
1145         if (result == 0) {
1146                 LU_CONTEXT_KEY_INIT(&cl_key);
1147                 result = lu_context_key_register(&cl_key);
1148                 if (result == 0) {
1149                         result = cl_lock_init();
1150                         if (result == 0)
1151                                 result = cl_page_init();
1152                 }
1153         }
1154         if (result)
1155                 lustre_hash_exit(cl_env_hash);
1156         return result;
1157 }
1158
1159 /**
1160  * Finalization of global cl-data. Dual to cl_global_init().
1161  */
1162 void cl_global_fini(void)
1163 {
1164         cl_lock_fini();
1165         cl_page_fini();
1166         lu_context_key_degister(&cl_key);
1167         lu_kmem_fini(cl_object_caches);
1168         lustre_hash_exit(cl_env_hash);
1169 }