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