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