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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2016, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * Client Lustre Object.
  33  *
  34  *   Author: Nikita Danilov <nikita.danilov@sun.com>
  35  *   Author: Jinshan Xiong <jinshan.xiong@intel.com>
  36  */
  37
  38 /*
  39  * Locking.
  40  *
  41  *  i_mutex
  42  *      PG_locked
  43  *          ->coh_attr_guard
  44  *          ->ls_guard
  45  */
  46
  47 #define DEBUG_SUBSYSTEM S_CLASS
  48
  49 #include <linux/list.h>
  50 #include <libcfs/libcfs.h>
  51 /* class_put_type() */
  52 #include <obd_class.h>
  53 #include <obd_support.h>
  54 #include <lustre_fid.h>
  55 #include <libcfs/libcfs_hash.h> /* for cfs_hash stuff */
  56 #include <cl_object.h>
  57 #include <lu_object.h>
  58 #include "cl_internal.h"
  59
  60 static struct kmem_cache *cl_env_kmem;
  61
  62 /** Lock class of cl_object_header::coh_attr_guard */
  63 static struct lock_class_key cl_attr_guard_class;
  64
  65 /**
  66  * Initialize cl_object_header.
  67  */
  68 int cl_object_header_init(struct cl_object_header *h)
  69 {
  70         int result;
  71
  72         ENTRY;
  73         result = lu_object_header_init(&h->coh_lu);
  74         if (result == 0) {
  75                 spin_lock_init(&h->coh_attr_guard);
  76                 lockdep_set_class(&h->coh_attr_guard, &cl_attr_guard_class);
  77                 h->coh_page_bufsize = 0;
  78         }
  79         RETURN(result);
  80 }
  81 EXPORT_SYMBOL(cl_object_header_init);
  82
  83 /**
  84  * Finalize cl_object_header.
  85  */
  86 void cl_object_header_fini(struct cl_object_header *h)
  87 {
  88         lu_object_header_fini(&h->coh_lu);
  89 }
  90
  91 /**
  92  * Returns a cl_object with a given \a fid.
  93  *
  94  * Returns either cached or newly created object. Additional reference on the
  95  * returned object is acquired.
  96  *
  97  * \see lu_object_find(), cl_page_find(), cl_lock_find()
  98  */
  99 struct cl_object *cl_object_find(const struct lu_env *env,
 100                                  struct cl_device *cd, const struct lu_fid *fid,
 101                                  const struct cl_object_conf *c)
 102 {
 103         might_sleep();
 104         return lu2cl(lu_object_find_slice(env, cl2lu_dev(cd), fid, &c->coc_lu));
 105 }
 106 EXPORT_SYMBOL(cl_object_find);
 107
 108 /**
 109  * Releases a reference on \a o.
 110  *
 111  * When last reference is released object is returned to the cache, unless
 112  * lu_object_header_flags::LU_OBJECT_HEARD_BANSHEE bit is set in its header.
 113  *
 114  * \see cl_page_put(), cl_lock_put().
 115  */
 116 void cl_object_put(const struct lu_env *env, struct cl_object *o)
 117 {
 118         lu_object_put(env, &o->co_lu);
 119 }
 120 EXPORT_SYMBOL(cl_object_put);
 121
 122 /**
 123  * Acquire an additional reference to the object \a o.
 124  *
 125  * This can only be used to acquire _additional_ reference, i.e., caller
 126  * already has to possess at least one reference to \a o before calling this.
 127  *
 128  * \see cl_page_get(), cl_lock_get().
 129  */
 130 void cl_object_get(struct cl_object *o)
 131 {
 132         lu_object_get(&o->co_lu);
 133 }
 134 EXPORT_SYMBOL(cl_object_get);
 135
 136 /**
 137  * Returns the top-object for a given \a o.
 138  *
 139  * \see cl_io_top()
 140  */
 141 struct cl_object *cl_object_top(struct cl_object *o)
 142 {
 143         struct cl_object_header *hdr = cl_object_header(o);
 144         struct cl_object *top;
 145
 146         while (hdr->coh_parent != NULL)
 147                 hdr = hdr->coh_parent;
 148
 149         top = lu2cl(lu_object_top(&hdr->coh_lu));
 150         CDEBUG(D_TRACE, "%p -> %p\n", o, top);
 151         return top;
 152 }
 153 EXPORT_SYMBOL(cl_object_top);
 154
 155 /**
 156  * Returns pointer to the lock protecting data-attributes for the given object
 157  * \a o.
 158  *
 159  * Data-attributes are protected by the cl_object_header::coh_attr_guard
 160  * spin-lock in the top-object.
 161  *
 162  * \see cl_attr, cl_object_attr_lock(), cl_object_operations::coo_attr_get().
 163  */
 164 static spinlock_t *cl_object_attr_guard(struct cl_object *o)
 165 {
 166         return &cl_object_header(cl_object_top(o))->coh_attr_guard;
 167 }
 168
 169 /**
 170  * Locks data-attributes.
 171  *
 172  * Prevents data-attributes from changing, until lock is released by
 173  * cl_object_attr_unlock(). This has to be called before calls to
 174  * cl_object_attr_get(), cl_object_attr_update().
 175  */
 176 void cl_object_attr_lock(struct cl_object *o)
 177 __acquires(cl_object_attr_guard(o))
 178 {
 179         spin_lock(cl_object_attr_guard(o));
 180 }
 181 EXPORT_SYMBOL(cl_object_attr_lock);
 182
 183 /**
 184  * Releases data-attributes lock, acquired by cl_object_attr_lock().
 185  */
 186 void cl_object_attr_unlock(struct cl_object *o)
 187 __releases(cl_object_attr_guard(o))
 188 {
 189         spin_unlock(cl_object_attr_guard(o));
 190 }
 191 EXPORT_SYMBOL(cl_object_attr_unlock);
 192
 193 /**
 194  * Returns data-attributes of an object \a obj.
 195  *
 196  * Every layer is asked (by calling cl_object_operations::coo_attr_get())
 197  * top-to-bottom to fill in parts of \a attr that this layer is responsible
 198  * for.
 199  */
 200 int cl_object_attr_get(const struct lu_env *env, struct cl_object *obj,
 201                         struct cl_attr *attr)
 202 {
 203         struct lu_object_header *top;
 204         int result;
 205
 206         assert_spin_locked(cl_object_attr_guard(obj));
 207         ENTRY;
 208
 209         top = obj->co_lu.lo_header;
 210         result = 0;
 211         list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
 212                 if (obj->co_ops->coo_attr_get != NULL) {
 213                         result = obj->co_ops->coo_attr_get(env, obj, attr);
 214                         if (result != 0) {
 215                                 if (result > 0)
 216                                         result = 0;
 217                                 break;
 218                         }
 219                 }
 220         }
 221         RETURN(result);
 222 }
 223 EXPORT_SYMBOL(cl_object_attr_get);
 224
 225 /**
 226  * Updates data-attributes of an object \a obj.
 227  *
 228  * Only attributes, mentioned in a validness bit-mask \a v are
 229  * updated. Calls cl_object_operations::coo_upd_attr() on every layer, bottom
 230  * to top.
 231  */
 232 int cl_object_attr_update(const struct lu_env *env, struct cl_object *obj,
 233                           const struct cl_attr *attr, unsigned v)
 234 {
 235         struct lu_object_header *top;
 236         int result;
 237
 238         assert_spin_locked(cl_object_attr_guard(obj));
 239         ENTRY;
 240
 241         top = obj->co_lu.lo_header;
 242         result = 0;
 243         list_for_each_entry_reverse(obj, &top->loh_layers, co_lu.lo_linkage) {
 244                 if (obj->co_ops->coo_attr_update != NULL) {
 245                         result = obj->co_ops->coo_attr_update(env, obj, attr,
 246                                                               v);
 247                         if (result != 0) {
 248                                 if (result > 0)
 249                                         result = 0;
 250                                 break;
 251                         }
 252                 }
 253         }
 254         RETURN(result);
 255 }
 256 EXPORT_SYMBOL(cl_object_attr_update);
 257
 258 /**
 259  * Notifies layers (bottom-to-top) that glimpse AST was received.
 260  *
 261  * Layers have to fill \a lvb fields with information that will be shipped
 262  * back to glimpse issuer.
 263  *
 264  * \see cl_lock_operations::clo_glimpse()
 265  */
 266 int cl_object_glimpse(const struct lu_env *env, struct cl_object *obj,
 267                       struct ost_lvb *lvb)
 268 {
 269         struct lu_object_header *top;
 270         int result;
 271
 272         ENTRY;
 273         top = obj->co_lu.lo_header;
 274         result = 0;
 275         list_for_each_entry_reverse(obj, &top->loh_layers, co_lu.lo_linkage) {
 276                 if (obj->co_ops->coo_glimpse != NULL) {
 277                         result = obj->co_ops->coo_glimpse(env, obj, lvb);
 278                         if (result != 0)
 279                                 break;
 280                 }
 281         }
 282         LU_OBJECT_HEADER(D_DLMTRACE, env, lu_object_top(top),
 283                          "size: %llu mtime: %llu atime: %llu "
 284                          "ctime: %llu blocks: %llu\n",
 285                          lvb->lvb_size, lvb->lvb_mtime, lvb->lvb_atime,
 286                          lvb->lvb_ctime, lvb->lvb_blocks);
 287         RETURN(result);
 288 }
 289 EXPORT_SYMBOL(cl_object_glimpse);
 290
 291 /**
 292  * Updates a configuration of an object \a obj.
 293  */
 294 int cl_conf_set(const struct lu_env *env, struct cl_object *obj,
 295                 const struct cl_object_conf *conf)
 296 {
 297         struct lu_object_header *top;
 298         int result;
 299
 300         ENTRY;
 301         top = obj->co_lu.lo_header;
 302         result = 0;
 303         list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
 304                 if (obj->co_ops->coo_conf_set != NULL) {
 305                         result = obj->co_ops->coo_conf_set(env, obj, conf);
 306                         if (result != 0)
 307                                 break;
 308                 }
 309         }
 310         RETURN(result);
 311 }
 312 EXPORT_SYMBOL(cl_conf_set);
 313
 314 /**
 315  * Prunes caches of pages and locks for this object.
 316  */
 317 int cl_object_prune(const struct lu_env *env, struct cl_object *obj)
 318 {
 319         struct lu_object_header *top;
 320         struct cl_object *o;
 321         int result;
 322         ENTRY;
 323
 324         top = obj->co_lu.lo_header;
 325         result = 0;
 326         list_for_each_entry(o, &top->loh_layers, co_lu.lo_linkage) {
 327                 if (o->co_ops->coo_prune != NULL) {
 328                         result = o->co_ops->coo_prune(env, o);
 329                         if (result != 0)
 330                                 break;
 331                 }
 332         }
 333
 334         RETURN(result);
 335 }
 336 EXPORT_SYMBOL(cl_object_prune);
 337
 338 /**
 339  * Get stripe information of this object.
 340  */
 341 int cl_object_getstripe(const struct lu_env *env, struct cl_object *obj,
 342                         struct lov_user_md __user *uarg, size_t size)
 343 {
 344         struct lu_object_header *top;
 345         int                     result = 0;
 346         ENTRY;
 347
 348         top = obj->co_lu.lo_header;
 349         list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
 350                 if (obj->co_ops->coo_getstripe != NULL) {
 351                         result = obj->co_ops->coo_getstripe(env, obj, uarg,
 352                                                             size);
 353                         if (result != 0)
 354                                 break;
 355                 }
 356         }
 357         RETURN(result);
 358 }
 359 EXPORT_SYMBOL(cl_object_getstripe);
 360
 361 /**
 362  * Get fiemap extents from file object.
 363  *
 364  * \param env [in]      lustre environment
 365  * \param obj [in]      file object
 366  * \param key [in]      fiemap request argument
 367  * \param fiemap [out]  fiemap extents mapping retrived
 368  * \param buflen [in]   max buffer length of @fiemap
 369  *
 370  * \retval 0    success
 371  * \retval < 0  error
 372  */
 373 int cl_object_fiemap(const struct lu_env *env, struct cl_object *obj,
 374                      struct ll_fiemap_info_key *key,
 375                      struct fiemap *fiemap, size_t *buflen)
 376 {
 377         struct lu_object_header *top;
 378         int                     result = 0;
 379         ENTRY;
 380
 381         top = obj->co_lu.lo_header;
 382         list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
 383                 if (obj->co_ops->coo_fiemap != NULL) {
 384                         result = obj->co_ops->coo_fiemap(env, obj, key, fiemap,
 385                                                          buflen);
 386                         if (result != 0)
 387                                 break;
 388                 }
 389         }
 390         RETURN(result);
 391 }
 392 EXPORT_SYMBOL(cl_object_fiemap);
 393
 394 int cl_object_layout_get(const struct lu_env *env, struct cl_object *obj,
 395                          struct cl_layout *cl)
 396 {
 397         struct lu_object_header *top = obj->co_lu.lo_header;
 398         ENTRY;
 399
 400         list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
 401                 if (obj->co_ops->coo_layout_get != NULL)
 402                         return obj->co_ops->coo_layout_get(env, obj, cl);
 403         }
 404
 405         RETURN(-EOPNOTSUPP);
 406 }
 407 EXPORT_SYMBOL(cl_object_layout_get);
 408
 409 loff_t cl_object_maxbytes(struct cl_object *obj)
 410 {
 411         struct lu_object_header *top = obj->co_lu.lo_header;
 412         loff_t maxbytes = LLONG_MAX;
 413         ENTRY;
 414
 415         list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
 416                 if (obj->co_ops->coo_maxbytes != NULL)
 417                         maxbytes = min_t(loff_t, obj->co_ops->coo_maxbytes(obj),
 418                                          maxbytes);
 419         }
 420
 421         RETURN(maxbytes);
 422 }
 423 EXPORT_SYMBOL(cl_object_maxbytes);
 424
 425 /**
 426  * Helper function removing all object locks, and marking object for
 427  * deletion. All object pages must have been deleted at this point.
 428  *
 429  * This is called by cl_inode_fini() and lov_object_delete() to destroy top-
 430  * and sub- objects respectively.
 431  */
 432 void cl_object_kill(const struct lu_env *env, struct cl_object *obj)
 433 {
 434         struct cl_object_header *hdr = cl_object_header(obj);
 435
 436         set_bit(LU_OBJECT_HEARD_BANSHEE, &hdr->coh_lu.loh_flags);
 437 }
 438 EXPORT_SYMBOL(cl_object_kill);
 439
 440 void cache_stats_init(struct cache_stats *cs, const char *name)
 441 {
 442         int i;
 443
 444         cs->cs_name = name;
 445         for (i = 0; i < CS_NR; i++)
 446                 atomic_set(&cs->cs_stats[i], 0);
 447 }
 448
 449 static int cache_stats_print(const struct cache_stats *cs,
 450                              struct seq_file *m, int h)
 451 {
 452         int i;
 453
 454         /*
 455          *   lookup    hit    total  cached create
 456          * env: ...... ...... ...... ...... ......
 457          */
 458         if (h) {
 459                 const char *names[CS_NR] = CS_NAMES;
 460
 461                 seq_printf(m, "%6s", " ");
 462                 for (i = 0; i < CS_NR; i++)
 463                         seq_printf(m, "%8s", names[i]);
 464                 seq_printf(m, "\n");
 465         }
 466
 467         seq_printf(m, "%5.5s:", cs->cs_name);
 468         for (i = 0; i < CS_NR; i++)
 469                 seq_printf(m, "%8u", atomic_read(&cs->cs_stats[i]));
 470         return 0;
 471 }
 472
 473 static void cl_env_percpu_refill(void);
 474
 475 /**
 476  * Initialize client site.
 477  *
 478  * Perform common initialization (lu_site_init()), and initialize statistical
 479  * counters. Also perform global initializations on the first call.
 480  */
 481 int cl_site_init(struct cl_site *s, struct cl_device *d)
 482 {
 483         size_t i;
 484         int result;
 485
 486         result = lu_site_init(&s->cs_lu, &d->cd_lu_dev);
 487         if (result == 0) {
 488                 cache_stats_init(&s->cs_pages, "pages");
 489                 for (i = 0; i < ARRAY_SIZE(s->cs_pages_state); ++i)
 490                         atomic_set(&s->cs_pages_state[0], 0);
 491                 cl_env_percpu_refill();
 492         }
 493         return result;
 494 }
 495 EXPORT_SYMBOL(cl_site_init);
 496
 497 /**
 498  * Finalize client site. Dual to cl_site_init().
 499  */
 500 void cl_site_fini(struct cl_site *s)
 501 {
 502         lu_site_fini(&s->cs_lu);
 503 }
 504 EXPORT_SYMBOL(cl_site_fini);
 505
 506 static struct cache_stats cl_env_stats = {
 507         .cs_name    = "envs",
 508         .cs_stats = { ATOMIC_INIT(0), }
 509 };
 510
 511 /**
 512  * Outputs client site statistical counters into a buffer. Suitable for
 513  * ll_rd_*()-style functions.
 514  */
 515 int cl_site_stats_print(const struct cl_site *site, struct seq_file *m)
 516 {
 517         static const char *pstate[] = {
 518                 [CPS_CACHED]    = "c",
 519                 [CPS_OWNED]     = "o",
 520                 [CPS_PAGEOUT]   = "w",
 521                 [CPS_PAGEIN]    = "r",
 522                 [CPS_FREEING]   = "f"
 523         };
 524         size_t i;
 525
 526 /*
 527        lookup    hit  total   busy create
 528 pages: ...... ...... ...... ...... ...... [...... ...... ...... ......]
 529 locks: ...... ...... ...... ...... ...... [...... ...... ...... ...... ......]
 530   env: ...... ...... ...... ...... ......
 531  */
 532         lu_site_stats_seq_print(&site->cs_lu, m);
 533         cache_stats_print(&site->cs_pages, m, 1);
 534         seq_printf(m, " [");
 535         for (i = 0; i < ARRAY_SIZE(site->cs_pages_state); ++i)
 536                 seq_printf(m, "%s: %u ", pstate[i],
 537                            atomic_read(&site->cs_pages_state[i]));
 538         seq_printf(m, "]\n");
 539         cache_stats_print(&cl_env_stats, m, 0);
 540         seq_printf(m, "\n");
 541         return 0;
 542 }
 543 EXPORT_SYMBOL(cl_site_stats_print);
 544
 545 /*****************************************************************************
 546  *
 547  * lu_env handling on client.
 548  *
 549  */
 550
 551 /**
 552  * The most efficient way is to store cl_env pointer in task specific
 553  * structures. On Linux, it wont' be easy to use task_struct->journal_info
 554  * because Lustre code may call into other fs which has certain assumptions
 555  * about journal_info. Currently following fields in task_struct are identified
 556  * can be used for this purpose:
 557  *  - cl_env: for liblustre.
 558  *  - tux_info: ony on RedHat kernel.
 559  *  - ...
 560  * \note As long as we use task_struct to store cl_env, we assume that once
 561  * called into Lustre, we'll never call into the other part of the kernel
 562  * which will use those fields in task_struct without explicitly exiting
 563  * Lustre.
 564  *
 565  * If there's no space in task_struct is available, hash will be used.
 566  * bz20044, bz22683.
 567  */
 568
 569 static unsigned cl_envs_cached_max = 32; /* XXX: prototype: arbitrary limit
 570                                           * for now. */
 571 static struct cl_env_cache {
 572         rwlock_t                cec_guard;
 573         unsigned                cec_count;
 574         struct list_head        cec_envs;
 575 } *cl_envs = NULL;
 576
 577 struct cl_env {
 578         void             *ce_magic;
 579         struct lu_env     ce_lu;
 580         struct lu_context ce_ses;
 581
 582         /*
 583          * Linkage into global list of all client environments. Used for
 584          * garbage collection.
 585          */
 586         struct list_head  ce_linkage;
 587         /*
 588          *
 589          */
 590         int               ce_ref;
 591         /*
 592          * Debugging field: address of the caller who made original
 593          * allocation.
 594          */
 595         void             *ce_debug;
 596 };
 597
 598 static void cl_env_inc(enum cache_stats_item item)
 599 {
 600 #ifdef CONFIG_DEBUG_PAGESTATE_TRACKING
 601         atomic_inc(&cl_env_stats.cs_stats[item]);
 602 #endif
 603 }
 604
 605 static void cl_env_dec(enum cache_stats_item item)
 606 {
 607 #ifdef CONFIG_DEBUG_PAGESTATE_TRACKING
 608         LASSERT(atomic_read(&cl_env_stats.cs_stats[item]) > 0);
 609         atomic_dec(&cl_env_stats.cs_stats[item]);
 610 #endif
 611 }
 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(CS_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(CS_create);
 652                         cl_env_inc(CS_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(CS_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(CS_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[j];
 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(CS_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 cl_key_{init,fini}() */
1030 LU_KEY_INIT_FINI(cl, struct cl_thread_info);
1031
1032 static struct lu_context_key cl_key = {
1033         .lct_tags = LCT_CL_THREAD,
1034         .lct_init = cl_key_init,
1035         .lct_fini = cl_key_fini,
1036 };
1037
1038 static struct lu_kmem_descr cl_object_caches[] = {
1039         {
1040                 .ckd_cache = &cl_env_kmem,
1041                 .ckd_name  = "cl_env_kmem",
1042                 .ckd_size  = sizeof (struct cl_env)
1043         },
1044         {
1045                 .ckd_cache = NULL
1046         }
1047 };
1048
1049 struct cfs_ptask_engine *cl_io_engine;
1050
1051 /**
1052  * Global initialization of cl-data. Create kmem caches, register
1053  * lu_context_key's, etc.
1054  *
1055  * \see cl_global_fini()
1056  */
1057 int cl_global_init(void)
1058 {
1059         int result;
1060
1061         OBD_ALLOC(cl_envs, sizeof(*cl_envs) * num_possible_cpus());
1062         if (cl_envs == NULL)
1063                 GOTO(out, result = -ENOMEM);
1064
1065         result = lu_kmem_init(cl_object_caches);
1066         if (result)
1067                 GOTO(out_envs, result);
1068
1069         LU_CONTEXT_KEY_INIT(&cl_key);
1070         result = lu_context_key_register(&cl_key);
1071         if (result)
1072                 GOTO(out_kmem, result);
1073
1074         result = cl_env_percpu_init();
1075         if (result) /* no cl_env_percpu_fini on error */
1076                 GOTO(out_keys, result);
1077
1078         cl_io_engine = cfs_ptengine_init("clio", cpu_online_mask);
1079         if (IS_ERR(cl_io_engine)) {
1080                 result = PTR_ERR(cl_io_engine);
1081                 cl_io_engine = NULL;
1082                 GOTO(out_percpu, result);
1083         }
1084
1085         return 0;
1086
1087 out_percpu:
1088         cl_env_percpu_fini();
1089 out_keys:
1090         lu_context_key_degister(&cl_key);
1091 out_kmem:
1092         lu_kmem_fini(cl_object_caches);
1093 out_envs:
1094         OBD_FREE(cl_envs, sizeof(*cl_envs) * num_possible_cpus());
1095 out:
1096         return result;
1097 }
1098
1099 /**
1100  * Finalization of global cl-data. Dual to cl_global_init().
1101  */
1102 void cl_global_fini(void)
1103 {
1104         cfs_ptengine_fini(cl_io_engine);
1105         cl_io_engine = NULL;
1106         cl_env_percpu_fini();
1107         lu_context_key_degister(&cl_key);
1108         lu_kmem_fini(cl_object_caches);
1109         OBD_FREE(cl_envs, sizeof(*cl_envs) * num_possible_cpus());
1110 }