lustre/obdclass/cl_object.c

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