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