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