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                 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(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 __acquires(cl_object_attr_guard(o))
 191 {
 192         spin_lock(cl_object_attr_guard(o));
 193 }
 194 EXPORT_SYMBOL(cl_object_attr_lock);
 195
 196 /**
 197  * Releases data-attributes lock, acquired by cl_object_attr_lock().
 198  */
 199 void cl_object_attr_unlock(struct cl_object *o)
 200 __releases(cl_object_attr_guard(o))
 201 {
 202         spin_unlock(cl_object_attr_guard(o));
 203 }
 204 EXPORT_SYMBOL(cl_object_attr_unlock);
 205
 206 /**
 207  * Returns data-attributes of an object \a obj.
 208  *
 209  * Every layer is asked (by calling cl_object_operations::coo_attr_get())
 210  * top-to-bottom to fill in parts of \a attr that this layer is responsible
 211  * for.
 212  */
 213 int cl_object_attr_get(const struct lu_env *env, struct cl_object *obj,
 214                        struct cl_attr *attr)
 215 {
 216         struct lu_object_header *top;
 217         int result;
 218
 219         assert_spin_locked(cl_object_attr_guard(obj));
 220         ENTRY;
 221
 222         top = obj->co_lu.lo_header;
 223         result = 0;
 224         list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
 225                 if (obj->co_ops->coo_attr_get != NULL) {
 226                         result = obj->co_ops->coo_attr_get(env, obj, attr);
 227                         if (result != 0) {
 228                                 if (result > 0)
 229                                         result = 0;
 230                                 break;
 231                         }
 232                 }
 233         }
 234         RETURN(result);
 235 }
 236 EXPORT_SYMBOL(cl_object_attr_get);
 237
 238 /**
 239  * Updates data-attributes of an object \a obj.
 240  *
 241  * Only attributes, mentioned in a validness bit-mask \a v are
 242  * updated. Calls cl_object_operations::coo_attr_set() on every layer, bottom
 243  * to top.
 244  */
 245 int cl_object_attr_set(const struct lu_env *env, struct cl_object *obj,
 246                        const struct cl_attr *attr, unsigned v)
 247 {
 248         struct lu_object_header *top;
 249         int result;
 250
 251         assert_spin_locked(cl_object_attr_guard(obj));
 252         ENTRY;
 253
 254         top = obj->co_lu.lo_header;
 255         result = 0;
 256         list_for_each_entry_reverse(obj, &top->loh_layers, co_lu.lo_linkage) {
 257                 if (obj->co_ops->coo_attr_set != NULL) {
 258                         result = obj->co_ops->coo_attr_set(env, obj, attr, v);
 259                         if (result != 0) {
 260                                 if (result > 0)
 261                                         result = 0;
 262                                 break;
 263                         }
 264                 }
 265         }
 266         RETURN(result);
 267 }
 268 EXPORT_SYMBOL(cl_object_attr_set);
 269
 270 /**
 271  * Notifies layers (bottom-to-top) that glimpse AST was received.
 272  *
 273  * Layers have to fill \a lvb fields with information that will be shipped
 274  * back to glimpse issuer.
 275  *
 276  * \see cl_lock_operations::clo_glimpse()
 277  */
 278 int cl_object_glimpse(const struct lu_env *env, struct cl_object *obj,
 279                       struct ost_lvb *lvb)
 280 {
 281         struct lu_object_header *top;
 282         int result;
 283
 284         ENTRY;
 285         top = obj->co_lu.lo_header;
 286         result = 0;
 287         list_for_each_entry_reverse(obj, &top->loh_layers, 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         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         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 = 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 struct 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         struct hlist_node  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         struct list_head  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(struct hlist_node *hn)
 631 {
 632         struct cl_env *cle = hlist_entry(hn, struct cl_env, ce_node);
 633
 634         LASSERT(cle->ce_magic == &cl_env_init0);
 635         return (void *)cle;
 636 }
 637
 638 static int cl_env_hops_keycmp(const void *key, struct hlist_node *hn)
 639 {
 640         struct cl_env *cle = cl_env_hops_obj(hn);
 641
 642         LASSERT(cle->ce_owner != NULL);
 643         return (key == cle->ce_owner);
 644 }
 645
 646 static void cl_env_hops_noop(cfs_hash_t *hs, struct hlist_node *hn)
 647 {
 648         struct cl_env *cle = hlist_entry(hn, struct cl_env, ce_node);
 649         LASSERT(cle->ce_magic == &cl_env_init0);
 650 }
 651
 652 static cfs_hash_ops_t cl_env_hops = {
 653         .hs_hash        = cl_env_hops_hash,
 654         .hs_key         = cl_env_hops_obj,
 655         .hs_keycmp      = cl_env_hops_keycmp,
 656         .hs_object      = cl_env_hops_obj,
 657         .hs_get         = cl_env_hops_noop,
 658         .hs_put_locked  = cl_env_hops_noop,
 659 };
 660
 661 static inline struct cl_env *cl_env_fetch(void)
 662 {
 663         struct cl_env *cle;
 664
 665         cle = cfs_hash_lookup(cl_env_hash, (void *) (long) current->pid);
 666         LASSERT(ergo(cle, cle->ce_magic == &cl_env_init0));
 667         return cle;
 668 }
 669
 670 static inline void cl_env_attach(struct cl_env *cle)
 671 {
 672         if (cle) {
 673                 int rc;
 674
 675                 LASSERT(cle->ce_owner == NULL);
 676                 cle->ce_owner = (void *) (long) current->pid;
 677                 rc = cfs_hash_add_unique(cl_env_hash, cle->ce_owner,
 678                                          &cle->ce_node);
 679                 LASSERT(rc == 0);
 680         }
 681 }
 682
 683 static inline void cl_env_do_detach(struct cl_env *cle)
 684 {
 685         void *cookie;
 686
 687         LASSERT(cle->ce_owner == (void *) (long) current->pid);
 688         cookie = cfs_hash_del(cl_env_hash, cle->ce_owner,
 689                               &cle->ce_node);
 690         LASSERT(cookie == cle);
 691         cle->ce_owner = NULL;
 692 }
 693
 694 static int cl_env_store_init(void) {
 695         cl_env_hash = cfs_hash_create("cl_env",
 696                                       HASH_CL_ENV_BITS, HASH_CL_ENV_BITS,
 697                                       HASH_CL_ENV_BKT_BITS, 0,
 698                                       CFS_HASH_MIN_THETA,
 699                                       CFS_HASH_MAX_THETA,
 700                                       &cl_env_hops,
 701                                       CFS_HASH_RW_BKTLOCK);
 702         return cl_env_hash != NULL ? 0 :-ENOMEM;
 703 }
 704
 705 static void cl_env_store_fini(void) {
 706         cfs_hash_putref(cl_env_hash);
 707 }
 708
 709 #else /* LL_TASK_CL_ENV */
 710 /*
 711  * The implementation of store cl_env directly in thread structure.
 712  */
 713
 714 static inline struct cl_env *cl_env_fetch(void)
 715 {
 716         struct cl_env *cle;
 717
 718         cle = current->LL_TASK_CL_ENV;
 719         if (cle && cle->ce_magic != &cl_env_init0)
 720                 cle = NULL;
 721         return cle;
 722 }
 723
 724 static inline void cl_env_attach(struct cl_env *cle)
 725 {
 726         if (cle) {
 727                 LASSERT(cle->ce_owner == NULL);
 728                 cle->ce_owner = current;
 729                 cle->ce_prev = current->LL_TASK_CL_ENV;
 730                 current->LL_TASK_CL_ENV = cle;
 731         }
 732 }
 733
 734 static inline void cl_env_do_detach(struct cl_env *cle)
 735 {
 736         LASSERT(cle->ce_owner == current);
 737         LASSERT(current->LL_TASK_CL_ENV == cle);
 738         current->LL_TASK_CL_ENV = cle->ce_prev;
 739         cle->ce_owner = NULL;
 740 }
 741
 742 static int cl_env_store_init(void) { return 0; }
 743 static void cl_env_store_fini(void) { }
 744
 745 #endif /* LL_TASK_CL_ENV */
 746
 747 static inline struct cl_env *cl_env_detach(struct cl_env *cle)
 748 {
 749         if (cle == NULL)
 750                 cle = cl_env_fetch();
 751
 752         if (cle && cle->ce_owner)
 753                 cl_env_do_detach(cle);
 754
 755         return cle;
 756 }
 757
 758 static struct lu_env *cl_env_new(__u32 ctx_tags, __u32 ses_tags, void *debug)
 759 {
 760         struct lu_env *env;
 761         struct cl_env *cle;
 762
 763         OBD_SLAB_ALLOC_PTR_GFP(cle, cl_env_kmem, GFP_NOFS);
 764         if (cle != NULL) {
 765                 int rc;
 766
 767                 INIT_LIST_HEAD(&cle->ce_linkage);
 768                 cle->ce_magic = &cl_env_init0;
 769                 env = &cle->ce_lu;
 770                 rc = lu_env_init(env, LCT_CL_THREAD|ctx_tags);
 771                 if (rc == 0) {
 772                         rc = lu_context_init(&cle->ce_ses,
 773                                              LCT_SESSION | ses_tags);
 774                         if (rc == 0) {
 775                                 lu_context_enter(&cle->ce_ses);
 776                                 env->le_ses = &cle->ce_ses;
 777                                 cl_env_init0(cle, debug);
 778                         } else
 779                                 lu_env_fini(env);
 780                 }
 781                 if (rc != 0) {
 782                         OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
 783                         env = ERR_PTR(rc);
 784                 } else {
 785                         CL_ENV_INC(create);
 786                         CL_ENV_INC(total);
 787                 }
 788         } else
 789                 env = ERR_PTR(-ENOMEM);
 790         return env;
 791 }
 792
 793 static void cl_env_fini(struct cl_env *cle)
 794 {
 795         CL_ENV_DEC(total);
 796         lu_context_fini(&cle->ce_lu.le_ctx);
 797         lu_context_fini(&cle->ce_ses);
 798         OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
 799 }
 800
 801 static struct lu_env *cl_env_obtain(void *debug)
 802 {
 803         struct cl_env *cle;
 804         struct lu_env *env;
 805
 806         ENTRY;
 807         spin_lock(&cl_envs_guard);
 808         LASSERT(equi(cl_envs_cached_nr == 0, list_empty(&cl_envs)));
 809         if (cl_envs_cached_nr > 0) {
 810                 int rc;
 811
 812                 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
 813                 list_del_init(&cle->ce_linkage);
 814                 cl_envs_cached_nr--;
 815                 spin_unlock(&cl_envs_guard);
 816
 817                 env = &cle->ce_lu;
 818                 rc = lu_env_refill(env);
 819                 if (rc == 0) {
 820                         cl_env_init0(cle, debug);
 821                         lu_context_enter(&env->le_ctx);
 822                         lu_context_enter(&cle->ce_ses);
 823                 } else {
 824                         cl_env_fini(cle);
 825                         env = ERR_PTR(rc);
 826                 }
 827         } else {
 828                 spin_unlock(&cl_envs_guard);
 829                 env = cl_env_new(lu_context_tags_default,
 830                                  lu_session_tags_default, debug);
 831         }
 832         RETURN(env);
 833 }
 834
 835 static inline struct cl_env *cl_env_container(struct lu_env *env)
 836 {
 837         return container_of(env, struct cl_env, ce_lu);
 838 }
 839
 840 struct lu_env *cl_env_peek(int *refcheck)
 841 {
 842         struct lu_env *env;
 843         struct cl_env *cle;
 844
 845         CL_ENV_INC(lookup);
 846
 847         /* check that we don't go far from untrusted pointer */
 848         CLASSERT(offsetof(struct cl_env, ce_magic) == 0);
 849
 850         env = NULL;
 851         cle = cl_env_fetch();
 852         if (cle != NULL) {
 853                 CL_ENV_INC(hit);
 854                 env = &cle->ce_lu;
 855                 *refcheck = ++cle->ce_ref;
 856         }
 857         CDEBUG(D_OTHER, "%d@%p\n", cle ? cle->ce_ref : 0, cle);
 858         return env;
 859 }
 860 EXPORT_SYMBOL(cl_env_peek);
 861
 862 /**
 863  * Returns lu_env: if there already is an environment associated with the
 864  * current thread, it is returned, otherwise, new environment is allocated.
 865  *
 866  * Allocations are amortized through the global cache of environments.
 867  *
 868  * \param refcheck pointer to a counter used to detect environment leaks. In
 869  * the usual case cl_env_get() and cl_env_put() are called in the same lexical
 870  * scope and pointer to the same integer is passed as \a refcheck. This is
 871  * used to detect missed cl_env_put().
 872  *
 873  * \see cl_env_put()
 874  */
 875 struct lu_env *cl_env_get(int *refcheck)
 876 {
 877         struct lu_env *env;
 878
 879         env = cl_env_peek(refcheck);
 880         if (env == NULL) {
 881                 env = cl_env_obtain(__builtin_return_address(0));
 882                 if (!IS_ERR(env)) {
 883                         struct cl_env *cle;
 884
 885                         cle = cl_env_container(env);
 886                         cl_env_attach(cle);
 887                         *refcheck = cle->ce_ref;
 888                         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 889                 }
 890         }
 891         return env;
 892 }
 893 EXPORT_SYMBOL(cl_env_get);
 894
 895 /**
 896  * Forces an allocation of a fresh environment with given tags.
 897  *
 898  * \see cl_env_get()
 899  */
 900 struct lu_env *cl_env_alloc(int *refcheck, __u32 tags)
 901 {
 902         struct lu_env *env;
 903
 904         LASSERT(cl_env_peek(refcheck) == NULL);
 905         env = cl_env_new(tags, tags, __builtin_return_address(0));
 906         if (!IS_ERR(env)) {
 907                 struct cl_env *cle;
 908
 909                 cle = cl_env_container(env);
 910                 *refcheck = cle->ce_ref;
 911                 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 912         }
 913         return env;
 914 }
 915 EXPORT_SYMBOL(cl_env_alloc);
 916
 917 static void cl_env_exit(struct cl_env *cle)
 918 {
 919         LASSERT(cle->ce_owner == NULL);
 920         lu_context_exit(&cle->ce_lu.le_ctx);
 921         lu_context_exit(&cle->ce_ses);
 922 }
 923
 924 /**
 925  * Finalizes and frees a given number of cached environments. This is done to
 926  * (1) free some memory (not currently hooked into VM), or (2) release
 927  * references to modules.
 928  */
 929 unsigned cl_env_cache_purge(unsigned nr)
 930 {
 931         struct cl_env *cle;
 932
 933         ENTRY;
 934         spin_lock(&cl_envs_guard);
 935         for (; !list_empty(&cl_envs) && nr > 0; --nr) {
 936                 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
 937                 list_del_init(&cle->ce_linkage);
 938                 LASSERT(cl_envs_cached_nr > 0);
 939                 cl_envs_cached_nr--;
 940                 spin_unlock(&cl_envs_guard);
 941
 942                 cl_env_fini(cle);
 943                 spin_lock(&cl_envs_guard);
 944         }
 945         LASSERT(equi(cl_envs_cached_nr == 0, list_empty(&cl_envs)));
 946         spin_unlock(&cl_envs_guard);
 947         RETURN(nr);
 948 }
 949 EXPORT_SYMBOL(cl_env_cache_purge);
 950
 951 /**
 952  * Release an environment.
 953  *
 954  * Decrement \a env reference counter. When counter drops to 0, nothing in
 955  * this thread is using environment and it is returned to the allocation
 956  * cache, or freed straight away, if cache is large enough.
 957  */
 958 void cl_env_put(struct lu_env *env, int *refcheck)
 959 {
 960         struct cl_env *cle;
 961
 962         cle = cl_env_container(env);
 963
 964         LASSERT(cle->ce_ref > 0);
 965         LASSERT(ergo(refcheck != NULL, cle->ce_ref == *refcheck));
 966
 967         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 968         if (--cle->ce_ref == 0) {
 969                 CL_ENV_DEC(busy);
 970                 cl_env_detach(cle);
 971                 cle->ce_debug = NULL;
 972                 cl_env_exit(cle);
 973                 /*
 974                  * Don't bother to take a lock here.
 975                  *
 976                  * Return environment to the cache only when it was allocated
 977                  * with the standard tags.
 978                  */
 979                 if (cl_envs_cached_nr < cl_envs_cached_max &&
 980                     (env->le_ctx.lc_tags & ~LCT_HAS_EXIT) == LCT_CL_THREAD &&
 981                     (env->le_ses->lc_tags & ~LCT_HAS_EXIT) == LCT_SESSION) {
 982                         spin_lock(&cl_envs_guard);
 983                         list_add(&cle->ce_linkage, &cl_envs);
 984                         cl_envs_cached_nr++;
 985                         spin_unlock(&cl_envs_guard);
 986                 } else
 987                         cl_env_fini(cle);
 988         }
 989 }
 990 EXPORT_SYMBOL(cl_env_put);
 991
 992 /**
 993  * Declares a point of re-entrancy.
 994  *
 995  * \see cl_env_reexit()
 996  */
 997 void *cl_env_reenter(void)
 998 {
 999         return cl_env_detach(NULL);
1000 }
1001 EXPORT_SYMBOL(cl_env_reenter);
1002
1003 /**
1004  * Exits re-entrancy.
1005  */
1006 void cl_env_reexit(void *cookie)
1007 {
1008         cl_env_detach(NULL);
1009         cl_env_attach(cookie);
1010 }
1011 EXPORT_SYMBOL(cl_env_reexit);
1012
1013 /**
1014  * Setup user-supplied \a env as a current environment. This is to be used to
1015  * guaranteed that environment exists even when cl_env_get() fails. It is up
1016  * to user to ensure proper concurrency control.
1017  *
1018  * \see cl_env_unplant()
1019  */
1020 void cl_env_implant(struct lu_env *env, int *refcheck)
1021 {
1022         struct cl_env *cle = cl_env_container(env);
1023
1024         LASSERT(cle->ce_ref > 0);
1025
1026         cl_env_attach(cle);
1027         cl_env_get(refcheck);
1028         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1029 }
1030 EXPORT_SYMBOL(cl_env_implant);
1031
1032 /**
1033  * Detach environment installed earlier by cl_env_implant().
1034  */
1035 void cl_env_unplant(struct lu_env *env, int *refcheck)
1036 {
1037         struct cl_env *cle = cl_env_container(env);
1038
1039         LASSERT(cle->ce_ref > 1);
1040
1041         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1042
1043         cl_env_detach(cle);
1044         cl_env_put(env, refcheck);
1045 }
1046 EXPORT_SYMBOL(cl_env_unplant);
1047
1048 struct lu_env *cl_env_nested_get(struct cl_env_nest *nest)
1049 {
1050         struct lu_env *env;
1051
1052         nest->cen_cookie = NULL;
1053         env = cl_env_peek(&nest->cen_refcheck);
1054         if (env != NULL) {
1055                 if (!cl_io_is_going(env))
1056                         return env;
1057                 else {
1058                         cl_env_put(env, &nest->cen_refcheck);
1059                         nest->cen_cookie = cl_env_reenter();
1060                 }
1061         }
1062         env = cl_env_get(&nest->cen_refcheck);
1063         if (IS_ERR(env)) {
1064                 cl_env_reexit(nest->cen_cookie);
1065                 return env;
1066         }
1067
1068         LASSERT(!cl_io_is_going(env));
1069         return env;
1070 }
1071 EXPORT_SYMBOL(cl_env_nested_get);
1072
1073 void cl_env_nested_put(struct cl_env_nest *nest, struct lu_env *env)
1074 {
1075         cl_env_put(env, &nest->cen_refcheck);
1076         cl_env_reexit(nest->cen_cookie);
1077 }
1078 EXPORT_SYMBOL(cl_env_nested_put);
1079
1080 /**
1081  * Converts struct cl_attr to struct ost_lvb.
1082  *
1083  * \see cl_lvb2attr
1084  */
1085 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr)
1086 {
1087         ENTRY;
1088         lvb->lvb_size   = attr->cat_size;
1089         lvb->lvb_mtime  = attr->cat_mtime;
1090         lvb->lvb_atime  = attr->cat_atime;
1091         lvb->lvb_ctime  = attr->cat_ctime;
1092         lvb->lvb_blocks = attr->cat_blocks;
1093         EXIT;
1094 }
1095 EXPORT_SYMBOL(cl_attr2lvb);
1096
1097 /**
1098  * Converts struct ost_lvb to struct cl_attr.
1099  *
1100  * \see cl_attr2lvb
1101  */
1102 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb)
1103 {
1104         ENTRY;
1105         attr->cat_size   = lvb->lvb_size;
1106         attr->cat_mtime  = lvb->lvb_mtime;
1107         attr->cat_atime  = lvb->lvb_atime;
1108         attr->cat_ctime  = lvb->lvb_ctime;
1109         attr->cat_blocks = lvb->lvb_blocks;
1110         EXIT;
1111 }
1112 EXPORT_SYMBOL(cl_lvb2attr);
1113
1114 static struct cl_env cl_env_percpu[NR_CPUS];
1115
1116 static int cl_env_percpu_init(void)
1117 {
1118         struct cl_env *cle;
1119         int tags = LCT_REMEMBER | LCT_NOREF;
1120         int i, j;
1121         int rc = 0;
1122
1123         for_each_possible_cpu(i) {
1124                 struct lu_env *env;
1125
1126                 cle = &cl_env_percpu[i];
1127                 env = &cle->ce_lu;
1128
1129                 INIT_LIST_HEAD(&cle->ce_linkage);
1130                 cle->ce_magic = &cl_env_init0;
1131                 rc = lu_env_init(env, LCT_CL_THREAD | tags);
1132                 if (rc == 0) {
1133                         rc = lu_context_init(&cle->ce_ses, LCT_SESSION | tags);
1134                         if (rc == 0) {
1135                                 lu_context_enter(&cle->ce_ses);
1136                                 env->le_ses = &cle->ce_ses;
1137                         } else {
1138                                 lu_env_fini(env);
1139                         }
1140                 }
1141                 if (rc != 0)
1142                         break;
1143         }
1144         if (rc != 0) {
1145                 /* Indices 0 to i (excluding i) were correctly initialized,
1146                  * thus we must uninitialize up to i, the rest are undefined. */
1147                 for (j = 0; j < i; j++) {
1148                         cle = &cl_env_percpu[i];
1149                         lu_context_exit(&cle->ce_ses);
1150                         lu_context_fini(&cle->ce_ses);
1151                         lu_env_fini(&cle->ce_lu);
1152                 }
1153         }
1154
1155         return rc;
1156 }
1157
1158 static void cl_env_percpu_fini(void)
1159 {
1160         int i;
1161
1162         for_each_possible_cpu(i) {
1163                 struct cl_env *cle = &cl_env_percpu[i];
1164
1165                 lu_context_exit(&cle->ce_ses);
1166                 lu_context_fini(&cle->ce_ses);
1167                 lu_env_fini(&cle->ce_lu);
1168         }
1169 }
1170
1171 static void cl_env_percpu_refill(void)
1172 {
1173         int i;
1174
1175         for_each_possible_cpu(i)
1176                 lu_env_refill(&cl_env_percpu[i].ce_lu);
1177 }
1178
1179 void cl_env_percpu_put(struct lu_env *env)
1180 {
1181         struct cl_env *cle;
1182         int cpu;
1183
1184         cpu = smp_processor_id();
1185         cle = cl_env_container(env);
1186         LASSERT(cle == &cl_env_percpu[cpu]);
1187
1188         cle->ce_ref--;
1189         LASSERT(cle->ce_ref == 0);
1190
1191         CL_ENV_DEC(busy);
1192         cl_env_detach(cle);
1193         cle->ce_debug = NULL;
1194
1195         put_cpu();
1196 }
1197 EXPORT_SYMBOL(cl_env_percpu_put);
1198
1199 struct lu_env *cl_env_percpu_get()
1200 {
1201         struct cl_env *cle;
1202
1203         cle = &cl_env_percpu[get_cpu()];
1204         cl_env_init0(cle, __builtin_return_address(0));
1205
1206         cl_env_attach(cle);
1207         return &cle->ce_lu;
1208 }
1209 EXPORT_SYMBOL(cl_env_percpu_get);
1210
1211 /*****************************************************************************
1212  *
1213  * Temporary prototype thing: mirror obd-devices into cl devices.
1214  *
1215  */
1216
1217 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
1218                                 struct lu_device_type *ldt,
1219                                 struct lu_device *next)
1220 {
1221         const char       *typename;
1222         struct lu_device *d;
1223
1224         LASSERT(ldt != NULL);
1225
1226         typename = ldt->ldt_name;
1227         d = ldt->ldt_ops->ldto_device_alloc(env, ldt, NULL);
1228         if (!IS_ERR(d)) {
1229                 int rc;
1230
1231                 if (site != NULL)
1232                         d->ld_site = site;
1233                 rc = ldt->ldt_ops->ldto_device_init(env, d, typename, next);
1234                 if (rc == 0) {
1235                         lu_device_get(d);
1236                         lu_ref_add(&d->ld_reference,
1237                                    "lu-stack", &lu_site_init);
1238                 } else {
1239                         ldt->ldt_ops->ldto_device_free(env, d);
1240                         CERROR("can't init device '%s', %d\n", typename, rc);
1241                         d = ERR_PTR(rc);
1242                 }
1243         } else
1244                 CERROR("Cannot allocate device: '%s'\n", typename);
1245         return lu2cl_dev(d);
1246 }
1247 EXPORT_SYMBOL(cl_type_setup);
1248
1249 /**
1250  * Finalize device stack by calling lu_stack_fini().
1251  */
1252 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl)
1253 {
1254         lu_stack_fini(env, cl2lu_dev(cl));
1255 }
1256 EXPORT_SYMBOL(cl_stack_fini);
1257
1258 int  cl_lock_init(void);
1259 void cl_lock_fini(void);
1260
1261 int  cl_page_init(void);
1262 void cl_page_fini(void);
1263
1264 static struct lu_context_key cl_key;
1265
1266 struct cl_thread_info *cl_env_info(const struct lu_env *env)
1267 {
1268         return lu_context_key_get(&env->le_ctx, &cl_key);
1269 }
1270
1271 /* defines cl0_key_{init,fini}() */
1272 LU_KEY_INIT_FINI(cl0, struct cl_thread_info);
1273
1274 static void *cl_key_init(const struct lu_context *ctx,
1275                          struct lu_context_key *key)
1276 {
1277         struct cl_thread_info *info;
1278
1279         info = cl0_key_init(ctx, key);
1280         if (!IS_ERR(info)) {
1281                 int i;
1282
1283                 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1284                         lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1285         }
1286         return info;
1287 }
1288
1289 static void cl_key_fini(const struct lu_context *ctx,
1290                         struct lu_context_key *key, void *data)
1291 {
1292         struct cl_thread_info *info;
1293         int i;
1294
1295         info = data;
1296         for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1297                 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1298         cl0_key_fini(ctx, key, data);
1299 }
1300
1301 static void cl_key_exit(const struct lu_context *ctx,
1302                         struct lu_context_key *key, void *data)
1303 {
1304         struct cl_thread_info *info = data;
1305         int i;
1306
1307         for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i) {
1308                 LASSERT(info->clt_counters[i].ctc_nr_held == 0);
1309                 LASSERT(info->clt_counters[i].ctc_nr_used == 0);
1310                 LASSERT(info->clt_counters[i].ctc_nr_locks_acquired == 0);
1311                 LASSERT(info->clt_counters[i].ctc_nr_locks_locked == 0);
1312                 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1313                 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1314         }
1315 }
1316
1317 static struct lu_context_key cl_key = {
1318         .lct_tags = LCT_CL_THREAD,
1319         .lct_init = cl_key_init,
1320         .lct_fini = cl_key_fini,
1321         .lct_exit = cl_key_exit
1322 };
1323
1324 static struct lu_kmem_descr cl_object_caches[] = {
1325         {
1326                 .ckd_cache = &cl_env_kmem,
1327                 .ckd_name  = "cl_env_kmem",
1328                 .ckd_size  = sizeof (struct cl_env)
1329         },
1330         {
1331                 .ckd_cache = NULL
1332         }
1333 };
1334
1335 /**
1336  * Global initialization of cl-data. Create kmem caches, register
1337  * lu_context_key's, etc.
1338  *
1339  * \see cl_global_fini()
1340  */
1341 int cl_global_init(void)
1342 {
1343         int result;
1344
1345         INIT_LIST_HEAD(&cl_envs);
1346
1347         result = cl_env_store_init();
1348         if (result)
1349                 return result;
1350
1351         result = lu_kmem_init(cl_object_caches);
1352         if (result)
1353                 goto out_store;
1354
1355         LU_CONTEXT_KEY_INIT(&cl_key);
1356         result = lu_context_key_register(&cl_key);
1357         if (result)
1358                 goto out_kmem;
1359
1360         result = cl_lock_init();
1361         if (result)
1362                 goto out_context;
1363
1364         result = cl_page_init();
1365         if (result)
1366                 goto out_lock;
1367
1368         result = cl_env_percpu_init();
1369         if (result)
1370                 /* no cl_env_percpu_fini on error */
1371                 goto out_lock;
1372
1373         return 0;
1374 out_lock:
1375         cl_lock_fini();
1376 out_context:
1377         lu_context_key_degister(&cl_key);
1378 out_kmem:
1379         lu_kmem_fini(cl_object_caches);
1380 out_store:
1381         cl_env_store_fini();
1382         return result;
1383 }
1384
1385 /**
1386  * Finalization of global cl-data. Dual to cl_global_init().
1387  */
1388 void cl_global_fini(void)
1389 {
1390         cl_env_percpu_fini();
1391         cl_lock_fini();
1392         cl_page_fini();
1393         lu_context_key_degister(&cl_key);
1394         lu_kmem_fini(cl_object_caches);
1395         cl_env_store_fini();
1396 }