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 <linux/list.h>
  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/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: %llu mtime: %llu atime: %llu "
 288                          "ctime: %llu blocks: %llu\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 unsigned cl_envs_cached_max = 32; /* XXX: prototype: arbitrary limit
 573                                           * for now. */
 574 static struct cl_env_cache {
 575         rwlock_t                cec_guard;
 576         unsigned                cec_count;
 577         struct list_head        cec_envs;
 578 } *cl_envs = NULL;
 579
 580 struct cl_env {
 581         void             *ce_magic;
 582         struct lu_env     ce_lu;
 583         struct lu_context ce_ses;
 584
 585         /*
 586          * Linkage into global list of all client environments. Used for
 587          * garbage collection.
 588          */
 589         struct list_head  ce_linkage;
 590         /*
 591          *
 592          */
 593         int               ce_ref;
 594         /*
 595          * Debugging field: address of the caller who made original
 596          * allocation.
 597          */
 598         void             *ce_debug;
 599 };
 600
 601 #ifdef CONFIG_DEBUG_PAGESTATE_TRACKING
 602 #define CL_ENV_INC(counter) atomic_inc(&cl_env_stats.cs_stats[CS_##counter])
 603
 604 #define CL_ENV_DEC(counter) do {                                              \
 605         LASSERT(atomic_read(&cl_env_stats.cs_stats[CS_##counter]) > 0);   \
 606         atomic_dec(&cl_env_stats.cs_stats[CS_##counter]);                 \
 607 } while (0)
 608 #else
 609 #define CL_ENV_INC(counter)
 610 #define CL_ENV_DEC(counter)
 611 #endif
 612
 613 static void cl_env_init0(struct cl_env *cle, void *debug)
 614 {
 615         LASSERT(cle->ce_ref == 0);
 616         LASSERT(cle->ce_magic == &cl_env_init0);
 617         LASSERT(cle->ce_debug == NULL);
 618
 619         cle->ce_ref = 1;
 620         cle->ce_debug = debug;
 621         CL_ENV_INC(busy);
 622 }
 623
 624 static struct lu_env *cl_env_new(__u32 ctx_tags, __u32 ses_tags, void *debug)
 625 {
 626         struct lu_env *env;
 627         struct cl_env *cle;
 628
 629         OBD_SLAB_ALLOC_PTR_GFP(cle, cl_env_kmem, GFP_NOFS);
 630         if (cle != NULL) {
 631                 int rc;
 632
 633                 INIT_LIST_HEAD(&cle->ce_linkage);
 634                 cle->ce_magic = &cl_env_init0;
 635                 env = &cle->ce_lu;
 636                 rc = lu_env_init(env, LCT_CL_THREAD|ctx_tags);
 637                 if (rc == 0) {
 638                         rc = lu_context_init(&cle->ce_ses,
 639                                              LCT_SESSION | ses_tags);
 640                         if (rc == 0) {
 641                                 lu_context_enter(&cle->ce_ses);
 642                                 env->le_ses = &cle->ce_ses;
 643                                 cl_env_init0(cle, debug);
 644                         } else
 645                                 lu_env_fini(env);
 646                 }
 647                 if (rc != 0) {
 648                         OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
 649                         env = ERR_PTR(rc);
 650                 } else {
 651                         CL_ENV_INC(create);
 652                         CL_ENV_INC(total);
 653                 }
 654         } else
 655                 env = ERR_PTR(-ENOMEM);
 656         return env;
 657 }
 658
 659 static void cl_env_fini(struct cl_env *cle)
 660 {
 661         CL_ENV_DEC(total);
 662         lu_context_fini(&cle->ce_lu.le_ctx);
 663         lu_context_fini(&cle->ce_ses);
 664         OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
 665 }
 666
 667 static struct lu_env *cl_env_obtain(void *debug)
 668 {
 669         struct cl_env *cle;
 670         struct lu_env *env;
 671         int cpu = get_cpu();
 672
 673         ENTRY;
 674
 675         read_lock(&cl_envs[cpu].cec_guard);
 676         LASSERT(equi(cl_envs[cpu].cec_count == 0,
 677                 list_empty(&cl_envs[cpu].cec_envs)));
 678         if (cl_envs[cpu].cec_count > 0) {
 679                 int rc;
 680
 681                 cle = container_of(cl_envs[cpu].cec_envs.next, struct cl_env,
 682                                    ce_linkage);
 683                 list_del_init(&cle->ce_linkage);
 684                 cl_envs[cpu].cec_count--;
 685                 read_unlock(&cl_envs[cpu].cec_guard);
 686                 put_cpu();
 687
 688                 env = &cle->ce_lu;
 689                 rc = lu_env_refill(env);
 690                 if (rc == 0) {
 691                         cl_env_init0(cle, debug);
 692                         lu_context_enter(&env->le_ctx);
 693                         lu_context_enter(&cle->ce_ses);
 694                 } else {
 695                         cl_env_fini(cle);
 696                         env = ERR_PTR(rc);
 697                 }
 698         } else {
 699                 read_unlock(&cl_envs[cpu].cec_guard);
 700                 put_cpu();
 701                 env = cl_env_new(lu_context_tags_default,
 702                                  lu_session_tags_default, debug);
 703         }
 704         RETURN(env);
 705 }
 706
 707 static inline struct cl_env *cl_env_container(struct lu_env *env)
 708 {
 709         return container_of(env, struct cl_env, ce_lu);
 710 }
 711
 712 /**
 713  * Returns lu_env: if there already is an environment associated with the
 714  * current thread, it is returned, otherwise, new environment is allocated.
 715  *
 716  * Allocations are amortized through the global cache of environments.
 717  *
 718  * \param refcheck pointer to a counter used to detect environment leaks. In
 719  * the usual case cl_env_get() and cl_env_put() are called in the same lexical
 720  * scope and pointer to the same integer is passed as \a refcheck. This is
 721  * used to detect missed cl_env_put().
 722  *
 723  * \see cl_env_put()
 724  */
 725 struct lu_env *cl_env_get(__u16 *refcheck)
 726 {
 727         struct lu_env *env;
 728
 729         env = cl_env_obtain(__builtin_return_address(0));
 730         if (!IS_ERR(env)) {
 731                 struct cl_env *cle;
 732
 733                 cle = cl_env_container(env);
 734                 *refcheck = cle->ce_ref;
 735                 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 736         }
 737         return env;
 738 }
 739 EXPORT_SYMBOL(cl_env_get);
 740
 741 /**
 742  * Forces an allocation of a fresh environment with given tags.
 743  *
 744  * \see cl_env_get()
 745  */
 746 struct lu_env *cl_env_alloc(__u16 *refcheck, __u32 tags)
 747 {
 748         struct lu_env *env;
 749
 750         env = cl_env_new(tags, tags, __builtin_return_address(0));
 751         if (!IS_ERR(env)) {
 752                 struct cl_env *cle;
 753
 754                 cle = cl_env_container(env);
 755                 *refcheck = cle->ce_ref;
 756                 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 757         }
 758         return env;
 759 }
 760 EXPORT_SYMBOL(cl_env_alloc);
 761
 762 static void cl_env_exit(struct cl_env *cle)
 763 {
 764         lu_context_exit(&cle->ce_lu.le_ctx);
 765         lu_context_exit(&cle->ce_ses);
 766 }
 767
 768 /**
 769  * Finalizes and frees a given number of cached environments. This is done to
 770  * (1) free some memory (not currently hooked into VM), or (2) release
 771  * references to modules.
 772  */
 773 unsigned cl_env_cache_purge(unsigned nr)
 774 {
 775         struct cl_env *cle;
 776         unsigned i;
 777
 778         ENTRY;
 779         for_each_possible_cpu(i) {
 780                 write_lock(&cl_envs[i].cec_guard);
 781                 for (; !list_empty(&cl_envs[i].cec_envs) && nr > 0; --nr) {
 782                         cle = container_of(cl_envs[i].cec_envs.next,
 783                                            struct cl_env, ce_linkage);
 784                         list_del_init(&cle->ce_linkage);
 785                         LASSERT(cl_envs[i].cec_count > 0);
 786                         cl_envs[i].cec_count--;
 787                         write_unlock(&cl_envs[i].cec_guard);
 788
 789                         cl_env_fini(cle);
 790                         write_lock(&cl_envs[i].cec_guard);
 791                 }
 792                 LASSERT(equi(cl_envs[i].cec_count == 0,
 793                         list_empty(&cl_envs[i].cec_envs)));
 794                 write_unlock(&cl_envs[i].cec_guard);
 795         }
 796         RETURN(nr);
 797 }
 798 EXPORT_SYMBOL(cl_env_cache_purge);
 799
 800 /**
 801  * Release an environment.
 802  *
 803  * Decrement \a env reference counter. When counter drops to 0, nothing in
 804  * this thread is using environment and it is returned to the allocation
 805  * cache, or freed straight away, if cache is large enough.
 806  */
 807 void cl_env_put(struct lu_env *env, __u16 *refcheck)
 808 {
 809         struct cl_env *cle;
 810
 811         cle = cl_env_container(env);
 812
 813         LASSERT(cle->ce_ref > 0);
 814         LASSERT(ergo(refcheck != NULL, cle->ce_ref == *refcheck));
 815
 816         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 817         if (--cle->ce_ref == 0) {
 818                 int cpu = get_cpu();
 819
 820                 CL_ENV_DEC(busy);
 821                 cle->ce_debug = NULL;
 822                 cl_env_exit(cle);
 823                 /*
 824                  * Don't bother to take a lock here.
 825                  *
 826                  * Return environment to the cache only when it was allocated
 827                  * with the standard tags.
 828                  */
 829                 if (cl_envs[cpu].cec_count < cl_envs_cached_max &&
 830                     (env->le_ctx.lc_tags & ~LCT_HAS_EXIT) == LCT_CL_THREAD &&
 831                     (env->le_ses->lc_tags & ~LCT_HAS_EXIT) == LCT_SESSION) {
 832                         read_lock(&cl_envs[cpu].cec_guard);
 833                         list_add(&cle->ce_linkage, &cl_envs[cpu].cec_envs);
 834                         cl_envs[cpu].cec_count++;
 835                         read_unlock(&cl_envs[cpu].cec_guard);
 836                 } else
 837                         cl_env_fini(cle);
 838                 put_cpu();
 839         }
 840 }
 841 EXPORT_SYMBOL(cl_env_put);
 842
 843 /**
 844  * Converts struct cl_attr to struct ost_lvb.
 845  *
 846  * \see cl_lvb2attr
 847  */
 848 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr)
 849 {
 850         ENTRY;
 851         lvb->lvb_size   = attr->cat_size;
 852         lvb->lvb_mtime  = attr->cat_mtime;
 853         lvb->lvb_atime  = attr->cat_atime;
 854         lvb->lvb_ctime  = attr->cat_ctime;
 855         lvb->lvb_blocks = attr->cat_blocks;
 856         EXIT;
 857 }
 858
 859 /**
 860  * Converts struct ost_lvb to struct cl_attr.
 861  *
 862  * \see cl_attr2lvb
 863  */
 864 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb)
 865 {
 866         ENTRY;
 867         attr->cat_size   = lvb->lvb_size;
 868         attr->cat_mtime  = lvb->lvb_mtime;
 869         attr->cat_atime  = lvb->lvb_atime;
 870         attr->cat_ctime  = lvb->lvb_ctime;
 871         attr->cat_blocks = lvb->lvb_blocks;
 872         EXIT;
 873 }
 874 EXPORT_SYMBOL(cl_lvb2attr);
 875
 876 static struct cl_env cl_env_percpu[NR_CPUS];
 877
 878 static int cl_env_percpu_init(void)
 879 {
 880         struct cl_env *cle;
 881         int tags = LCT_REMEMBER | LCT_NOREF;
 882         int i, j;
 883         int rc = 0;
 884
 885         for_each_possible_cpu(i) {
 886                 struct lu_env *env;
 887
 888                 rwlock_init(&cl_envs[i].cec_guard);
 889                 INIT_LIST_HEAD(&cl_envs[i].cec_envs);
 890                 cl_envs[i].cec_count = 0;
 891
 892                 cle = &cl_env_percpu[i];
 893                 env = &cle->ce_lu;
 894
 895                 INIT_LIST_HEAD(&cle->ce_linkage);
 896                 cle->ce_magic = &cl_env_init0;
 897                 rc = lu_env_init(env, LCT_CL_THREAD | tags);
 898                 if (rc == 0) {
 899                         rc = lu_context_init(&cle->ce_ses, LCT_SESSION | tags);
 900                         if (rc == 0) {
 901                                 lu_context_enter(&cle->ce_ses);
 902                                 env->le_ses = &cle->ce_ses;
 903                         } else {
 904                                 lu_env_fini(env);
 905                         }
 906                 }
 907                 if (rc != 0)
 908                         break;
 909         }
 910         if (rc != 0) {
 911                 /* Indices 0 to i (excluding i) were correctly initialized,
 912                  * thus we must uninitialize up to i, the rest are undefined. */
 913                 for (j = 0; j < i; j++) {
 914                         cle = &cl_env_percpu[i];
 915                         lu_context_exit(&cle->ce_ses);
 916                         lu_context_fini(&cle->ce_ses);
 917                         lu_env_fini(&cle->ce_lu);
 918                 }
 919         }
 920
 921         return rc;
 922 }
 923
 924 static void cl_env_percpu_fini(void)
 925 {
 926         int i;
 927
 928         for_each_possible_cpu(i) {
 929                 struct cl_env *cle = &cl_env_percpu[i];
 930
 931                 lu_context_exit(&cle->ce_ses);
 932                 lu_context_fini(&cle->ce_ses);
 933                 lu_env_fini(&cle->ce_lu);
 934         }
 935 }
 936
 937 static void cl_env_percpu_refill(void)
 938 {
 939         int i;
 940
 941         for_each_possible_cpu(i)
 942                 lu_env_refill(&cl_env_percpu[i].ce_lu);
 943 }
 944
 945 void cl_env_percpu_put(struct lu_env *env)
 946 {
 947         struct cl_env *cle;
 948         int cpu;
 949
 950         cpu = smp_processor_id();
 951         cle = cl_env_container(env);
 952         LASSERT(cle == &cl_env_percpu[cpu]);
 953
 954         cle->ce_ref--;
 955         LASSERT(cle->ce_ref == 0);
 956
 957         CL_ENV_DEC(busy);
 958         cle->ce_debug = NULL;
 959
 960         put_cpu();
 961 }
 962 EXPORT_SYMBOL(cl_env_percpu_put);
 963
 964 struct lu_env *cl_env_percpu_get()
 965 {
 966         struct cl_env *cle;
 967
 968         cle = &cl_env_percpu[get_cpu()];
 969         cl_env_init0(cle, __builtin_return_address(0));
 970
 971         return &cle->ce_lu;
 972 }
 973 EXPORT_SYMBOL(cl_env_percpu_get);
 974
 975 /*****************************************************************************
 976  *
 977  * Temporary prototype thing: mirror obd-devices into cl devices.
 978  *
 979  */
 980
 981 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
 982                                 struct lu_device_type *ldt,
 983                                 struct lu_device *next)
 984 {
 985         const char       *typename;
 986         struct lu_device *d;
 987
 988         LASSERT(ldt != NULL);
 989
 990         typename = ldt->ldt_name;
 991         d = ldt->ldt_ops->ldto_device_alloc(env, ldt, NULL);
 992         if (!IS_ERR(d)) {
 993                 int rc;
 994
 995                 if (site != NULL)
 996                         d->ld_site = site;
 997                 rc = ldt->ldt_ops->ldto_device_init(env, d, typename, next);
 998                 if (rc == 0) {
 999                         lu_device_get(d);
1000                         lu_ref_add(&d->ld_reference,
1001                                    "lu-stack", &lu_site_init);
1002                 } else {
1003                         ldt->ldt_ops->ldto_device_free(env, d);
1004                         CERROR("can't init device '%s', %d\n", typename, rc);
1005                         d = ERR_PTR(rc);
1006                 }
1007         } else
1008                 CERROR("Cannot allocate device: '%s'\n", typename);
1009         return lu2cl_dev(d);
1010 }
1011 EXPORT_SYMBOL(cl_type_setup);
1012
1013 /**
1014  * Finalize device stack by calling lu_stack_fini().
1015  */
1016 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl)
1017 {
1018         lu_stack_fini(env, cl2lu_dev(cl));
1019 }
1020 EXPORT_SYMBOL(cl_stack_fini);
1021
1022 static struct lu_context_key cl_key;
1023
1024 struct cl_thread_info *cl_env_info(const struct lu_env *env)
1025 {
1026         return lu_context_key_get(&env->le_ctx, &cl_key);
1027 }
1028
1029 /* defines cl0_key_{init,fini}() */
1030 LU_KEY_INIT_FINI(cl0, struct cl_thread_info);
1031
1032 static void *cl_key_init(const struct lu_context *ctx,
1033                          struct lu_context_key *key)
1034 {
1035         return cl0_key_init(ctx, key);
1036 }
1037
1038 static void cl_key_fini(const struct lu_context *ctx,
1039                         struct lu_context_key *key, void *data)
1040 {
1041         cl0_key_fini(ctx, key, data);
1042 }
1043
1044 static struct lu_context_key cl_key = {
1045         .lct_tags = LCT_CL_THREAD,
1046         .lct_init = cl_key_init,
1047         .lct_fini = cl_key_fini,
1048 };
1049
1050 static struct lu_kmem_descr cl_object_caches[] = {
1051         {
1052                 .ckd_cache = &cl_env_kmem,
1053                 .ckd_name  = "cl_env_kmem",
1054                 .ckd_size  = sizeof (struct cl_env)
1055         },
1056         {
1057                 .ckd_cache = NULL
1058         }
1059 };
1060
1061 /**
1062  * Global initialization of cl-data. Create kmem caches, register
1063  * lu_context_key's, etc.
1064  *
1065  * \see cl_global_fini()
1066  */
1067 int cl_global_init(void)
1068 {
1069         int result;
1070
1071         OBD_ALLOC(cl_envs, sizeof(*cl_envs) * num_possible_cpus());
1072         if (cl_envs == NULL)
1073                 GOTO(out, result = -ENOMEM);
1074
1075         result = lu_kmem_init(cl_object_caches);
1076         if (result)
1077                 GOTO(out_envs, result);
1078
1079         LU_CONTEXT_KEY_INIT(&cl_key);
1080         result = lu_context_key_register(&cl_key);
1081         if (result)
1082                 GOTO(out_kmem, result);
1083
1084         result = cl_env_percpu_init();
1085         if (result) /* no cl_env_percpu_fini on error */
1086                 GOTO(out_keys, result);
1087
1088         return 0;
1089
1090 out_keys:
1091         lu_context_key_degister(&cl_key);
1092 out_kmem:
1093         lu_kmem_fini(cl_object_caches);
1094 out_envs:
1095         OBD_FREE(cl_envs, sizeof(*cl_envs) * num_possible_cpus());
1096 out:
1097         return result;
1098 }
1099
1100 /**
1101  * Finalization of global cl-data. Dual to cl_global_init().
1102  */
1103 void cl_global_fini(void)
1104 {
1105         cl_env_percpu_fini();
1106         lu_context_key_degister(&cl_key);
1107         lu_kmem_fini(cl_object_caches);
1108         OBD_FREE(cl_envs, sizeof(*cl_envs) * num_possible_cpus());
1109 }