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, 2017, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  *
  31  * Client Lustre Object.
  32  *
  33  *   Author: Nikita Danilov <nikita.danilov@sun.com>
  34  *   Author: Jinshan Xiong <jinshan.xiong@intel.com>
  35  */
  36
  37 /*
  38  * Locking.
  39  *
  40  *  i_mutex
  41  *      PG_locked
  42  *          ->coh_attr_guard
  43  *          ->ls_guard
  44  */
  45
  46 #define DEBUG_SUBSYSTEM S_CLASS
  47
  48 #include <linux/list.h>
  49 #include <libcfs/libcfs.h>
  50 #include <obd_class.h>
  51 #include <obd_support.h>
  52 #include <lustre_fid.h>
  53 #include <cl_object.h>
  54 #include <lu_object.h>
  55 #include "cl_internal.h"
  56
  57 static struct kmem_cache *cl_env_kmem;
  58 struct kmem_cache *cl_dio_aio_kmem;
  59 struct kmem_cache *cl_sub_dio_kmem;
  60 struct kmem_cache *cl_page_kmem_array[16];
  61 unsigned short cl_page_kmem_size_array[16];
  62
  63 /** Lock class of cl_object_header::coh_attr_guard */
  64 static struct lock_class_key cl_attr_guard_class;
  65
  66 /**
  67  * Initialize cl_object_header.
  68  */
  69 int cl_object_header_init(struct cl_object_header *h)
  70 {
  71         int result;
  72
  73         ENTRY;
  74         result = lu_object_header_init(&h->coh_lu);
  75         if (result == 0) {
  76                 spin_lock_init(&h->coh_attr_guard);
  77                 lockdep_set_class(&h->coh_attr_guard, &cl_attr_guard_class);
  78                 h->coh_page_bufsize = 0;
  79         }
  80         RETURN(result);
  81 }
  82 EXPORT_SYMBOL(cl_object_header_init);
  83
  84 /**
  85  * Finalize cl_object_header.
  86  */
  87 void cl_object_header_fini(struct cl_object_header *h)
  88 {
  89         lu_object_header_fini(&h->coh_lu);
  90 }
  91
  92 /**
  93  * Returns a cl_object with a given \a fid.
  94  *
  95  * Returns either cached or newly created object. Additional reference on the
  96  * returned object is acquired.
  97  *
  98  * \see lu_object_find(), cl_page_find(), cl_lock_find()
  99  */
 100 struct cl_object *cl_object_find(const struct lu_env *env,
 101                                  struct cl_device *cd, const struct lu_fid *fid,
 102                                  const struct cl_object_conf *c)
 103 {
 104         might_sleep();
 105         return lu2cl(lu_object_find_slice(env, cl2lu_dev(cd), fid, &c->coc_lu));
 106 }
 107 EXPORT_SYMBOL(cl_object_find);
 108
 109 /**
 110  * Releases a reference on \a o.
 111  *
 112  * When last reference is released object is returned to the cache, unless
 113  * lu_object_header_flags::LU_OBJECT_HEARD_BANSHEE bit is set in its header.
 114  *
 115  * \see cl_page_put(), cl_lock_put().
 116  */
 117 void cl_object_put(const struct lu_env *env, struct cl_object *o)
 118 {
 119         lu_object_put(env, &o->co_lu);
 120 }
 121 EXPORT_SYMBOL(cl_object_put);
 122
 123 /**
 124  * Acquire an additional reference to the object \a o.
 125  *
 126  * This can only be used to acquire _additional_ reference, i.e., caller
 127  * already has to possess at least one reference to \a o before calling this.
 128  *
 129  * \see cl_page_get(), cl_lock_get().
 130  */
 131 void cl_object_get(struct cl_object *o)
 132 {
 133         lu_object_get(&o->co_lu);
 134 }
 135 EXPORT_SYMBOL(cl_object_get);
 136
 137 /**
 138  * Returns the top-object for a given \a o.
 139  *
 140  * \see cl_io_top()
 141  */
 142 struct cl_object *cl_object_top(struct cl_object *o)
 143 {
 144         struct cl_object_header *hdr = cl_object_header(o);
 145         struct cl_object *top;
 146
 147         while (hdr->coh_parent != NULL)
 148                 hdr = hdr->coh_parent;
 149
 150         top = lu2cl(lu_object_top(&hdr->coh_lu));
 151         CDEBUG(D_TRACE, "%p -> %p\n", o, top);
 152         return top;
 153 }
 154 EXPORT_SYMBOL(cl_object_top);
 155
 156 /**
 157  * Returns pointer to the lock protecting data-attributes for the given object
 158  * \a o.
 159  *
 160  * Data-attributes are protected by the cl_object_header::coh_attr_guard
 161  * spin-lock in the top-object.
 162  *
 163  * \see cl_attr, cl_object_attr_lock(), cl_object_operations::coo_attr_get().
 164  */
 165 static spinlock_t *cl_object_attr_guard(struct cl_object *o)
 166 {
 167         return &cl_object_header(cl_object_top(o))->coh_attr_guard;
 168 }
 169
 170 /**
 171  * Locks data-attributes.
 172  *
 173  * Prevents data-attributes from changing, until lock is released by
 174  * cl_object_attr_unlock(). This has to be called before calls to
 175  * cl_object_attr_get(), cl_object_attr_update().
 176  */
 177 void cl_object_attr_lock(struct cl_object *o)
 178 __acquires(cl_object_attr_guard(o))
 179 {
 180         spin_lock(cl_object_attr_guard(o));
 181 }
 182 EXPORT_SYMBOL(cl_object_attr_lock);
 183
 184 /**
 185  * Releases data-attributes lock, acquired by cl_object_attr_lock().
 186  */
 187 void cl_object_attr_unlock(struct cl_object *o)
 188 __releases(cl_object_attr_guard(o))
 189 {
 190         spin_unlock(cl_object_attr_guard(o));
 191 }
 192 EXPORT_SYMBOL(cl_object_attr_unlock);
 193
 194 /**
 195  * Returns data-attributes of an object \a obj.
 196  *
 197  * Every layer is asked (by calling cl_object_operations::coo_attr_get())
 198  * top-to-bottom to fill in parts of \a attr that this layer is responsible
 199  * for.
 200  */
 201 int cl_object_attr_get(const struct lu_env *env, struct cl_object *top,
 202                         struct cl_attr *attr)
 203 {
 204         struct cl_object *obj;
 205         int result = 0;
 206
 207         assert_spin_locked(cl_object_attr_guard(top));
 208         ENTRY;
 209
 210         cl_object_for_each(obj, top) {
 211                 if (obj->co_ops->coo_attr_get != NULL) {
 212                         result = obj->co_ops->coo_attr_get(env, obj, attr);
 213                         if (result != 0) {
 214                                 if (result > 0)
 215                                         result = 0;
 216                                 break;
 217                         }
 218                 }
 219         }
 220         RETURN(result);
 221 }
 222 EXPORT_SYMBOL(cl_object_attr_get);
 223
 224 /**
 225  * Updates data-attributes of an object \a obj.
 226  *
 227  * Only attributes, mentioned in a validness bit-mask \a v are
 228  * updated. Calls cl_object_operations::coo_upd_attr() on every layer, bottom
 229  * to top.
 230  */
 231 int cl_object_attr_update(const struct lu_env *env, struct cl_object *top,
 232                           const struct cl_attr *attr, unsigned v)
 233 {
 234         struct cl_object *obj;
 235         int result = 0;
 236
 237         assert_spin_locked(cl_object_attr_guard(top));
 238         ENTRY;
 239
 240         cl_object_for_each_reverse(obj, top) {
 241                 if (obj->co_ops->coo_attr_update != NULL) {
 242                         result = obj->co_ops->coo_attr_update(env, obj, attr,
 243                                                               v);
 244                         if (result != 0) {
 245                                 if (result > 0)
 246                                         result = 0;
 247                                 break;
 248                         }
 249                 }
 250         }
 251         RETURN(result);
 252 }
 253 EXPORT_SYMBOL(cl_object_attr_update);
 254
 255 /**
 256  * Notifies layers (bottom-to-top) that glimpse AST was received.
 257  *
 258  * Layers have to fill \a lvb fields with information that will be shipped
 259  * back to glimpse issuer.
 260  *
 261  * \see cl_lock_operations::clo_glimpse()
 262  */
 263 int cl_object_glimpse(const struct lu_env *env, struct cl_object *top,
 264                       struct ost_lvb *lvb)
 265 {
 266         struct cl_object *obj;
 267         int result = 0;
 268
 269         ENTRY;
 270         cl_object_for_each_reverse(obj, top) {
 271                 if (obj->co_ops->coo_glimpse != NULL) {
 272                         result = obj->co_ops->coo_glimpse(env, obj, lvb);
 273                         if (result != 0)
 274                                 break;
 275                 }
 276         }
 277         LU_OBJECT_HEADER(D_DLMTRACE, env, lu_object_top(top->co_lu.lo_header),
 278                          "size: %llu mtime: %llu atime: %llu "
 279                          "ctime: %llu blocks: %llu\n",
 280                          lvb->lvb_size, lvb->lvb_mtime, lvb->lvb_atime,
 281                          lvb->lvb_ctime, lvb->lvb_blocks);
 282         RETURN(result);
 283 }
 284 EXPORT_SYMBOL(cl_object_glimpse);
 285
 286 /**
 287  * Updates a configuration of an object \a obj.
 288  */
 289 int cl_conf_set(const struct lu_env *env, struct cl_object *top,
 290                 const struct cl_object_conf *conf)
 291 {
 292         struct cl_object *obj;
 293         int result = 0;
 294
 295         ENTRY;
 296         cl_object_for_each(obj, top) {
 297                 if (obj->co_ops->coo_conf_set != NULL) {
 298                         result = obj->co_ops->coo_conf_set(env, obj, conf);
 299                         if (result)
 300                                 break;
 301                 }
 302         }
 303         RETURN(result);
 304 }
 305 EXPORT_SYMBOL(cl_conf_set);
 306
 307 /**
 308  * Prunes caches of pages and locks for this object.
 309  */
 310 int cl_object_prune(const struct lu_env *env, struct cl_object *top)
 311 {
 312         struct cl_object *obj;
 313         int result = 0;
 314         ENTRY;
 315
 316         cl_object_for_each(obj, top) {
 317                 if (obj->co_ops->coo_prune != NULL) {
 318                         result = obj->co_ops->coo_prune(env, obj);
 319                         if (result)
 320                                 break;
 321                 }
 322         }
 323
 324         RETURN(result);
 325 }
 326 EXPORT_SYMBOL(cl_object_prune);
 327
 328 /**
 329  * Get stripe information of this object.
 330  */
 331 int cl_object_getstripe(const struct lu_env *env, struct cl_object *top,
 332                         struct lov_user_md __user *uarg, size_t size)
 333 {
 334         struct cl_object *obj;
 335         int result = 0;
 336         ENTRY;
 337
 338         cl_object_for_each(obj, top) {
 339                 if (obj->co_ops->coo_getstripe) {
 340                         result = obj->co_ops->coo_getstripe(env, obj, uarg,
 341                                                             size);
 342                         if (result)
 343                                 break;
 344                 }
 345         }
 346         RETURN(result);
 347 }
 348 EXPORT_SYMBOL(cl_object_getstripe);
 349
 350 /**
 351  * Get fiemap extents from file object.
 352  *
 353  * \param env [in]      lustre environment
 354  * \param obj [in]      file object
 355  * \param key [in]      fiemap request argument
 356  * \param fiemap [out]  fiemap extents mapping retrived
 357  * \param buflen [in]   max buffer length of @fiemap
 358  *
 359  * \retval 0    success
 360  * \retval < 0  error
 361  */
 362 int cl_object_fiemap(const struct lu_env *env, struct cl_object *top,
 363                      struct ll_fiemap_info_key *key,
 364                      struct fiemap *fiemap, size_t *buflen)
 365 {
 366         struct cl_object *obj;
 367         int result = 0;
 368         ENTRY;
 369
 370         cl_object_for_each(obj, top) {
 371                 if (obj->co_ops->coo_fiemap) {
 372                         result = obj->co_ops->coo_fiemap(env, obj, key, fiemap,
 373                                                          buflen);
 374                         if (result)
 375                                 break;
 376                 }
 377         }
 378         RETURN(result);
 379 }
 380 EXPORT_SYMBOL(cl_object_fiemap);
 381
 382 int cl_object_layout_get(const struct lu_env *env, struct cl_object *top,
 383                          struct cl_layout *cl)
 384 {
 385         struct cl_object *obj;
 386         ENTRY;
 387
 388         cl_object_for_each(obj, top) {
 389                 if (obj->co_ops->coo_layout_get)
 390                         return obj->co_ops->coo_layout_get(env, obj, cl);
 391         }
 392
 393         RETURN(-EOPNOTSUPP);
 394 }
 395 EXPORT_SYMBOL(cl_object_layout_get);
 396
 397 loff_t cl_object_maxbytes(struct cl_object *top)
 398 {
 399         struct cl_object *obj;
 400         loff_t maxbytes = LLONG_MAX;
 401         ENTRY;
 402
 403         cl_object_for_each(obj, top) {
 404                 if (obj->co_ops->coo_maxbytes)
 405                         maxbytes = min_t(loff_t, obj->co_ops->coo_maxbytes(obj),
 406                                          maxbytes);
 407         }
 408
 409         RETURN(maxbytes);
 410 }
 411 EXPORT_SYMBOL(cl_object_maxbytes);
 412
 413 int cl_object_flush(const struct lu_env *env, struct cl_object *top,
 414                          struct ldlm_lock *lock)
 415 {
 416         struct cl_object *obj;
 417         int rc = 0;
 418         ENTRY;
 419
 420         cl_object_for_each(obj, top) {
 421                 if (obj->co_ops->coo_object_flush) {
 422                         rc = obj->co_ops->coo_object_flush(env, obj, lock);
 423                         if (rc)
 424                                 break;
 425                 }
 426         }
 427         RETURN(rc);
 428 }
 429 EXPORT_SYMBOL(cl_object_flush);
 430
 431 int cl_object_inode_ops(const struct lu_env *env, struct cl_object *top,
 432                         enum coo_inode_opc opc, void *data)
 433 {
 434         struct cl_object *obj;
 435         int rc = 0;
 436
 437         ENTRY;
 438
 439         cl_object_for_each(obj, top) {
 440                 if (obj->co_ops->coo_inode_ops) {
 441                         rc = obj->co_ops->coo_inode_ops(env, obj, opc, data);
 442                         if (rc)
 443                                 break;
 444                 }
 445         }
 446         RETURN(rc);
 447 }
 448 EXPORT_SYMBOL(cl_object_inode_ops);
 449
 450 /**
 451  * Helper function removing all object locks, and marking object for
 452  * deletion. All object pages must have been deleted at this point.
 453  *
 454  * This is called by cl_inode_fini() and lov_object_delete() to destroy top-
 455  * and sub- objects respectively.
 456  */
 457 void cl_object_kill(const struct lu_env *env, struct cl_object *obj)
 458 {
 459         struct cl_object_header *hdr = cl_object_header(obj);
 460
 461         set_bit(LU_OBJECT_HEARD_BANSHEE, &hdr->coh_lu.loh_flags);
 462 }
 463 EXPORT_SYMBOL(cl_object_kill);
 464
 465 void cache_stats_init(struct cache_stats *cs, const char *name)
 466 {
 467         int i;
 468
 469         cs->cs_name = name;
 470         for (i = 0; i < CS_NR; i++)
 471                 atomic_set(&cs->cs_stats[i], 0);
 472 }
 473
 474 static int cache_stats_print(const struct cache_stats *cs,
 475                              struct seq_file *m, int h)
 476 {
 477         int i;
 478
 479         /*
 480          *   lookup    hit    total  cached create
 481          * env: ...... ...... ...... ...... ......
 482          */
 483         if (h) {
 484                 const char *names[CS_NR] = CS_NAMES;
 485
 486                 seq_printf(m, "%6s", " ");
 487                 for (i = 0; i < CS_NR; i++)
 488                         seq_printf(m, "%8s", names[i]);
 489                 seq_printf(m, "\n");
 490         }
 491
 492         seq_printf(m, "%5.5s:", cs->cs_name);
 493         for (i = 0; i < CS_NR; i++)
 494                 seq_printf(m, "%8u", atomic_read(&cs->cs_stats[i]));
 495         return 0;
 496 }
 497
 498 static void cl_env_percpu_refill(void);
 499
 500 /**
 501  * Initialize client site.
 502  *
 503  * Perform common initialization (lu_site_init()), and initialize statistical
 504  * counters. Also perform global initializations on the first call.
 505  */
 506 int cl_site_init(struct cl_site *s, struct cl_device *d)
 507 {
 508         size_t i;
 509         int result;
 510
 511         result = lu_site_init(&s->cs_lu, &d->cd_lu_dev);
 512         if (result == 0) {
 513                 cache_stats_init(&s->cs_pages, "pages");
 514                 for (i = 0; i < ARRAY_SIZE(s->cs_pages_state); ++i)
 515                         atomic_set(&s->cs_pages_state[0], 0);
 516                 cl_env_percpu_refill();
 517         }
 518         return result;
 519 }
 520 EXPORT_SYMBOL(cl_site_init);
 521
 522 /**
 523  * Finalize client site. Dual to cl_site_init().
 524  */
 525 void cl_site_fini(struct cl_site *s)
 526 {
 527         lu_site_fini(&s->cs_lu);
 528 }
 529 EXPORT_SYMBOL(cl_site_fini);
 530
 531 static struct cache_stats cl_env_stats = {
 532         .cs_name    = "envs",
 533         .cs_stats = { ATOMIC_INIT(0), }
 534 };
 535
 536 /**
 537  * Outputs client site statistical counters into a buffer. Suitable for
 538  * ll_rd_*()-style functions.
 539  */
 540 int cl_site_stats_print(const struct cl_site *site, struct seq_file *m)
 541 {
 542         static const char *const pstate[] = {
 543                 [CPS_CACHED]    = "c",
 544                 [CPS_OWNED]     = "o",
 545                 [CPS_PAGEOUT]   = "w",
 546                 [CPS_PAGEIN]    = "r",
 547                 [CPS_FREEING]   = "f"
 548         };
 549         size_t i;
 550
 551 /*
 552        lookup    hit  total   busy create
 553 pages: ...... ...... ...... ...... ...... [...... ...... ...... ......]
 554 locks: ...... ...... ...... ...... ...... [...... ...... ...... ...... ......]
 555   env: ...... ...... ...... ...... ......
 556  */
 557         lu_site_stats_seq_print(&site->cs_lu, m);
 558         cache_stats_print(&site->cs_pages, m, 1);
 559         seq_printf(m, " [");
 560         for (i = 0; i < ARRAY_SIZE(site->cs_pages_state); ++i)
 561                 seq_printf(m, "%s: %u ", pstate[i],
 562                            atomic_read(&site->cs_pages_state[i]));
 563         seq_printf(m, "]\n");
 564         cache_stats_print(&cl_env_stats, m, 0);
 565         seq_printf(m, "\n");
 566         return 0;
 567 }
 568 EXPORT_SYMBOL(cl_site_stats_print);
 569
 570 /*****************************************************************************
 571  *
 572  * lu_env handling on client.
 573  *
 574  */
 575
 576 static unsigned cl_envs_cached_max = 32; /* XXX: prototype: arbitrary limit
 577                                           * for now. */
 578 static struct cl_env_cache {
 579         rwlock_t                cec_guard;
 580         unsigned                cec_count;
 581         struct list_head        cec_envs;
 582 } *cl_envs = NULL;
 583
 584 struct cl_env {
 585         void             *ce_magic;
 586         struct lu_env     ce_lu;
 587         struct lu_context ce_ses;
 588
 589         /*
 590          * Linkage into global list of all client environments. Used for
 591          * garbage collection.
 592          */
 593         struct list_head  ce_linkage;
 594         /*
 595          *
 596          */
 597         int               ce_ref;
 598         /*
 599          * Debugging field: address of the caller who made original
 600          * allocation.
 601          */
 602         void             *ce_debug;
 603 };
 604
 605 static void cl_env_inc(enum cache_stats_item item)
 606 {
 607 #ifdef CONFIG_DEBUG_PAGESTATE_TRACKING
 608         atomic_inc(&cl_env_stats.cs_stats[item]);
 609 #endif
 610 }
 611
 612 static void cl_env_dec(enum cache_stats_item item)
 613 {
 614 #ifdef CONFIG_DEBUG_PAGESTATE_TRACKING
 615         LASSERT(atomic_read(&cl_env_stats.cs_stats[item]) > 0);
 616         atomic_dec(&cl_env_stats.cs_stats[item]);
 617 #endif
 618 }
 619
 620 static void cl_env_init0(struct cl_env *cle, void *debug)
 621 {
 622         LASSERT(cle->ce_ref == 0);
 623         LASSERT(cle->ce_magic == &cl_env_init0);
 624         LASSERT(cle->ce_debug == NULL);
 625
 626         cle->ce_ref = 1;
 627         cle->ce_debug = debug;
 628         cl_env_inc(CS_busy);
 629 }
 630
 631 static struct lu_env *cl_env_new(__u32 ctx_tags, __u32 ses_tags, void *debug)
 632 {
 633         struct lu_env *env;
 634         struct cl_env *cle;
 635
 636         OBD_SLAB_ALLOC_PTR_GFP(cle, cl_env_kmem, GFP_NOFS);
 637         if (cle != NULL) {
 638                 int rc;
 639
 640                 INIT_LIST_HEAD(&cle->ce_linkage);
 641                 cle->ce_magic = &cl_env_init0;
 642                 env = &cle->ce_lu;
 643                 rc = lu_env_init(env, LCT_CL_THREAD|ctx_tags);
 644                 if (rc == 0) {
 645                         rc = lu_context_init(&cle->ce_ses,
 646                                              LCT_SESSION | ses_tags);
 647                         if (rc == 0) {
 648                                 lu_context_enter(&cle->ce_ses);
 649                                 env->le_ses = &cle->ce_ses;
 650                                 cl_env_init0(cle, debug);
 651                         } else
 652                                 lu_env_fini(env);
 653                 }
 654                 if (rc != 0) {
 655                         OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
 656                         env = ERR_PTR(rc);
 657                 } else {
 658                         cl_env_inc(CS_create);
 659                         cl_env_inc(CS_total);
 660                 }
 661         } else
 662                 env = ERR_PTR(-ENOMEM);
 663         return env;
 664 }
 665
 666 static void cl_env_fini(struct cl_env *cle)
 667 {
 668         cl_env_dec(CS_total);
 669         lu_context_fini(&cle->ce_lu.le_ctx);
 670         lu_context_fini(&cle->ce_ses);
 671         OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
 672 }
 673
 674 /* Get a cl_env, either from the per-CPU cache for the current CPU, or by
 675  * allocating a new one.
 676  */
 677 static struct lu_env *cl_env_obtain(void *debug)
 678 {
 679         struct cl_env *cle;
 680         struct lu_env *env;
 681         int cpu = get_cpu();
 682
 683         ENTRY;
 684
 685         read_lock(&cl_envs[cpu].cec_guard);
 686         LASSERT(equi(cl_envs[cpu].cec_count == 0,
 687                 list_empty(&cl_envs[cpu].cec_envs)));
 688         if (cl_envs[cpu].cec_count > 0) {
 689                 int rc;
 690
 691                 cle = container_of(cl_envs[cpu].cec_envs.next, struct cl_env,
 692                                    ce_linkage);
 693                 list_del_init(&cle->ce_linkage);
 694                 cl_envs[cpu].cec_count--;
 695                 read_unlock(&cl_envs[cpu].cec_guard);
 696                 put_cpu();
 697
 698                 env = &cle->ce_lu;
 699                 rc = lu_env_refill(env);
 700                 if (rc == 0) {
 701                         cl_env_init0(cle, debug);
 702                         lu_context_enter(&env->le_ctx);
 703                         lu_context_enter(&cle->ce_ses);
 704                 } else {
 705                         cl_env_fini(cle);
 706                         env = ERR_PTR(rc);
 707                 }
 708         } else {
 709                 read_unlock(&cl_envs[cpu].cec_guard);
 710                 put_cpu();
 711                 env = cl_env_new(lu_context_tags_default,
 712                                  lu_session_tags_default, debug);
 713         }
 714         RETURN(env);
 715 }
 716
 717 static inline struct cl_env *cl_env_container(struct lu_env *env)
 718 {
 719         return container_of(env, struct cl_env, ce_lu);
 720 }
 721
 722 /**
 723  * Returns an lu_env.
 724  *
 725  * No link to thread, this returns an env from the cache or
 726  * allocates a new one.
 727  *
 728  * If you need to get the specific environment you created for this thread,
 729  * you must either pass the pointer directly or store it in the file/inode
 730  * private data and retrieve it from there using ll_cl_add/ll_cl_find.
 731  *
 732  * \param refcheck pointer to a counter used to detect environment leaks. In
 733  * the usual case cl_env_get() and cl_env_put() are called in the same lexical
 734  * scope and pointer to the same integer is passed as \a refcheck. This is
 735  * used to detect missed cl_env_put().
 736  *
 737  * \see cl_env_put()
 738  */
 739 struct lu_env *cl_env_get(__u16 *refcheck)
 740 {
 741         struct lu_env *env;
 742
 743         env = cl_env_obtain(__builtin_return_address(0));
 744         if (!IS_ERR(env)) {
 745                 struct cl_env *cle;
 746
 747                 cle = cl_env_container(env);
 748                 *refcheck = cle->ce_ref;
 749                 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 750         }
 751         return env;
 752 }
 753 EXPORT_SYMBOL(cl_env_get);
 754
 755 /**
 756  * Forces an allocation of a fresh environment with given tags.
 757  *
 758  * \see cl_env_get()
 759  */
 760 struct lu_env *cl_env_alloc(__u16 *refcheck, __u32 tags)
 761 {
 762         struct lu_env *env;
 763
 764         env = cl_env_new(tags, tags, __builtin_return_address(0));
 765         if (!IS_ERR(env)) {
 766                 struct cl_env *cle;
 767
 768                 cle = cl_env_container(env);
 769                 *refcheck = cle->ce_ref;
 770                 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 771         }
 772         return env;
 773 }
 774 EXPORT_SYMBOL(cl_env_alloc);
 775
 776 static void cl_env_exit(struct cl_env *cle)
 777 {
 778         lu_context_exit(&cle->ce_lu.le_ctx);
 779         lu_context_exit(&cle->ce_ses);
 780 }
 781
 782 /**
 783  * Finalizes and frees a given number of cached environments. This is done to
 784  * (1) free some memory (not currently hooked into VM), or (2) release
 785  * references to modules.
 786  */
 787 unsigned cl_env_cache_purge(unsigned nr)
 788 {
 789         struct cl_env *cle;
 790         unsigned i;
 791
 792         ENTRY;
 793         for_each_possible_cpu(i) {
 794                 write_lock(&cl_envs[i].cec_guard);
 795                 for (; !list_empty(&cl_envs[i].cec_envs) && nr > 0; --nr) {
 796                         cle = container_of(cl_envs[i].cec_envs.next,
 797                                            struct cl_env, ce_linkage);
 798                         list_del_init(&cle->ce_linkage);
 799                         LASSERT(cl_envs[i].cec_count > 0);
 800                         cl_envs[i].cec_count--;
 801                         write_unlock(&cl_envs[i].cec_guard);
 802
 803                         cl_env_fini(cle);
 804                         write_lock(&cl_envs[i].cec_guard);
 805                 }
 806                 LASSERT(equi(cl_envs[i].cec_count == 0,
 807                         list_empty(&cl_envs[i].cec_envs)));
 808                 write_unlock(&cl_envs[i].cec_guard);
 809         }
 810         RETURN(nr);
 811 }
 812 EXPORT_SYMBOL(cl_env_cache_purge);
 813
 814 /**
 815  * Release an environment.
 816  *
 817  * Decrement \a env reference counter. When counter drops to 0, nothing in
 818  * this thread is using environment and it is returned to the per-CPU cache or
 819  * freed immediately if the cache is full.
 820  */
 821 void cl_env_put(struct lu_env *env, __u16 *refcheck)
 822 {
 823         struct cl_env *cle;
 824
 825         cle = cl_env_container(env);
 826
 827         LASSERT(cle->ce_ref > 0);
 828         LASSERT(ergo(refcheck != NULL, cle->ce_ref == *refcheck));
 829
 830         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 831         if (--cle->ce_ref == 0) {
 832                 int cpu = get_cpu();
 833
 834                 cl_env_dec(CS_busy);
 835                 cle->ce_debug = NULL;
 836                 cl_env_exit(cle);
 837                 /*
 838                  * Don't bother to take a lock here.
 839                  *
 840                  * Return environment to the cache only when it was allocated
 841                  * with the standard tags.
 842                  */
 843                 if (cl_envs[cpu].cec_count < cl_envs_cached_max &&
 844                     (env->le_ctx.lc_tags & ~LCT_HAS_EXIT) == lu_context_tags_default &&
 845                     (env->le_ses->lc_tags & ~LCT_HAS_EXIT) == lu_session_tags_default) {
 846                         read_lock(&cl_envs[cpu].cec_guard);
 847                         list_add(&cle->ce_linkage, &cl_envs[cpu].cec_envs);
 848                         cl_envs[cpu].cec_count++;
 849                         read_unlock(&cl_envs[cpu].cec_guard);
 850                 } else
 851                         cl_env_fini(cle);
 852                 put_cpu();
 853         }
 854 }
 855 EXPORT_SYMBOL(cl_env_put);
 856
 857 /**
 858  * Converts struct cl_attr to struct ost_lvb.
 859  *
 860  * \see cl_lvb2attr
 861  */
 862 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr)
 863 {
 864         lvb->lvb_size   = attr->cat_size;
 865         lvb->lvb_mtime  = attr->cat_mtime;
 866         lvb->lvb_atime  = attr->cat_atime;
 867         lvb->lvb_ctime  = attr->cat_ctime;
 868         lvb->lvb_blocks = attr->cat_blocks;
 869 }
 870
 871 /**
 872  * Converts struct ost_lvb to struct cl_attr.
 873  *
 874  * \see cl_attr2lvb
 875  */
 876 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb)
 877 {
 878         attr->cat_size   = lvb->lvb_size;
 879         attr->cat_mtime  = lvb->lvb_mtime;
 880         attr->cat_atime  = lvb->lvb_atime;
 881         attr->cat_ctime  = lvb->lvb_ctime;
 882         attr->cat_blocks = lvb->lvb_blocks;
 883 }
 884 EXPORT_SYMBOL(cl_lvb2attr);
 885
 886 static struct cl_env cl_env_percpu[NR_CPUS];
 887 static DEFINE_MUTEX(cl_env_percpu_mutex);
 888
 889 static int cl_env_percpu_init(void)
 890 {
 891         struct cl_env *cle;
 892         int tags = LCT_REMEMBER | LCT_NOREF;
 893         int i, j;
 894         int rc = 0;
 895
 896         for_each_possible_cpu(i) {
 897                 struct lu_env *env;
 898
 899                 rwlock_init(&cl_envs[i].cec_guard);
 900                 INIT_LIST_HEAD(&cl_envs[i].cec_envs);
 901                 cl_envs[i].cec_count = 0;
 902
 903                 cle = &cl_env_percpu[i];
 904                 env = &cle->ce_lu;
 905
 906                 INIT_LIST_HEAD(&cle->ce_linkage);
 907                 cle->ce_magic = &cl_env_init0;
 908                 rc = lu_env_init(env, LCT_CL_THREAD | tags);
 909                 if (rc == 0) {
 910                         rc = lu_context_init(&cle->ce_ses, LCT_SESSION | tags);
 911                         if (rc == 0) {
 912                                 lu_context_enter(&cle->ce_ses);
 913                                 env->le_ses = &cle->ce_ses;
 914                         } else {
 915                                 lu_env_fini(env);
 916                         }
 917                 }
 918                 if (rc != 0)
 919                         break;
 920         }
 921         if (rc != 0) {
 922                 /* Indices 0 to i (excluding i) were correctly initialized,
 923                  * thus we must uninitialize up to i, the rest are undefined. */
 924                 for (j = 0; j < i; j++) {
 925                         cle = &cl_env_percpu[j];
 926                         lu_context_exit(&cle->ce_ses);
 927                         lu_context_fini(&cle->ce_ses);
 928                         lu_env_fini(&cle->ce_lu);
 929                 }
 930         }
 931
 932         return rc;
 933 }
 934
 935 static void cl_env_percpu_fini(void)
 936 {
 937         int i;
 938
 939         for_each_possible_cpu(i) {
 940                 struct cl_env *cle = &cl_env_percpu[i];
 941
 942                 lu_context_exit(&cle->ce_ses);
 943                 lu_context_fini(&cle->ce_ses);
 944                 lu_env_fini(&cle->ce_lu);
 945         }
 946 }
 947
 948 static void cl_env_percpu_refill(void)
 949 {
 950         int i;
 951
 952         mutex_lock(&cl_env_percpu_mutex);
 953         for_each_possible_cpu(i)
 954                 lu_env_refill(&cl_env_percpu[i].ce_lu);
 955         mutex_unlock(&cl_env_percpu_mutex);
 956 }
 957
 958 void cl_env_percpu_put(struct lu_env *env)
 959 {
 960         struct cl_env *cle;
 961         int cpu;
 962
 963         cpu = smp_processor_id();
 964         cle = cl_env_container(env);
 965         LASSERT(cle == &cl_env_percpu[cpu]);
 966
 967         cle->ce_ref--;
 968         LASSERT(cle->ce_ref == 0);
 969
 970         cl_env_dec(CS_busy);
 971         cle->ce_debug = NULL;
 972
 973         put_cpu();
 974 }
 975 EXPORT_SYMBOL(cl_env_percpu_put);
 976
 977 struct lu_env *cl_env_percpu_get(void)
 978 {
 979         struct cl_env *cle;
 980
 981         cle = &cl_env_percpu[get_cpu()];
 982         cl_env_init0(cle, __builtin_return_address(0));
 983
 984         return &cle->ce_lu;
 985 }
 986 EXPORT_SYMBOL(cl_env_percpu_get);
 987
 988 /*****************************************************************************
 989  *
 990  * Temporary prototype thing: mirror obd-devices into cl devices.
 991  *
 992  */
 993
 994 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
 995                                 struct lu_device_type *ldt,
 996                                 struct lu_device *next)
 997 {
 998         const char       *typename;
 999         struct lu_device *d;
1000
1001         LASSERT(ldt != NULL);
1002
1003         typename = ldt->ldt_name;
1004         d = ldt->ldt_ops->ldto_device_alloc(env, ldt, NULL);
1005         if (!IS_ERR(d)) {
1006                 int rc;
1007
1008                 if (site != NULL)
1009                         d->ld_site = site;
1010                 rc = ldt->ldt_ops->ldto_device_init(env, d, typename, next);
1011                 if (rc == 0) {
1012                         lu_device_get(d);
1013                         lu_ref_add(&d->ld_reference,
1014                                    "lu-stack", &lu_site_init);
1015                 } else {
1016                         ldt->ldt_ops->ldto_device_free(env, d);
1017                         CERROR("can't init device '%s', %d\n", typename, rc);
1018                         d = ERR_PTR(rc);
1019                 }
1020         } else
1021                 CERROR("Cannot allocate device: '%s'\n", typename);
1022         return lu2cl_dev(d);
1023 }
1024 EXPORT_SYMBOL(cl_type_setup);
1025
1026 /**
1027  * Finalize device stack by calling lu_stack_fini().
1028  */
1029 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl)
1030 {
1031         lu_stack_fini(env, cl2lu_dev(cl));
1032 }
1033 EXPORT_SYMBOL(cl_stack_fini);
1034
1035 static struct lu_context_key cl_key;
1036
1037 struct cl_thread_info *cl_env_info(const struct lu_env *env)
1038 {
1039         return lu_context_key_get(&env->le_ctx, &cl_key);
1040 }
1041
1042 /* defines cl_key_{init,fini}() */
1043 LU_KEY_INIT_FINI(cl, struct cl_thread_info);
1044
1045 static struct lu_context_key cl_key = {
1046         .lct_tags = LCT_CL_THREAD,
1047         .lct_init = cl_key_init,
1048         .lct_fini = cl_key_fini,
1049 };
1050
1051 static struct lu_kmem_descr cl_object_caches[] = {
1052         {
1053                 .ckd_cache = &cl_env_kmem,
1054                 .ckd_name  = "cl_env_kmem",
1055                 .ckd_size  = sizeof(struct cl_env)
1056         },
1057         {
1058                 .ckd_cache = &cl_dio_aio_kmem,
1059                 .ckd_name  = "cl_dio_aio_kmem",
1060                 .ckd_size  = sizeof(struct cl_dio_aio)
1061         },
1062         {
1063                 .ckd_cache = &cl_sub_dio_kmem,
1064                 .ckd_name  = "cl_sub_dio_kmem",
1065                 .ckd_size  = sizeof(struct cl_sub_dio)
1066         },
1067         {
1068                 .ckd_cache = NULL
1069         }
1070 };
1071
1072 /**
1073  * Global initialization of cl-data. Create kmem caches, register
1074  * lu_context_key's, etc.
1075  *
1076  * \see cl_global_fini()
1077  */
1078 int cl_global_init(void)
1079 {
1080         int result;
1081
1082         OBD_ALLOC_PTR_ARRAY(cl_envs, num_possible_cpus());
1083         if (cl_envs == NULL)
1084                 GOTO(out, result = -ENOMEM);
1085
1086         result = lu_kmem_init(cl_object_caches);
1087         if (result)
1088                 GOTO(out_envs, result);
1089
1090         LU_CONTEXT_KEY_INIT(&cl_key);
1091         result = lu_context_key_register(&cl_key);
1092         if (result)
1093                 GOTO(out_kmem, result);
1094
1095         result = cl_env_percpu_init();
1096         if (result) /* no cl_env_percpu_fini on error */
1097                 GOTO(out_keys, result);
1098
1099         return 0;
1100
1101 out_keys:
1102         lu_context_key_degister(&cl_key);
1103 out_kmem:
1104         lu_kmem_fini(cl_object_caches);
1105 out_envs:
1106         OBD_FREE_PTR_ARRAY(cl_envs, num_possible_cpus());
1107 out:
1108         return result;
1109 }
1110
1111 /**
1112  * Finalization of global cl-data. Dual to cl_global_init().
1113  */
1114 void cl_global_fini(void)
1115 {
1116         int i;
1117
1118         for (i = 0; i < ARRAY_SIZE(cl_page_kmem_array); i++) {
1119                 if (cl_page_kmem_array[i]) {
1120                         kmem_cache_destroy(cl_page_kmem_array[i]);
1121                         cl_page_kmem_array[i] = NULL;
1122                 }
1123         }
1124         cl_env_percpu_fini();
1125         lu_context_key_degister(&cl_key);
1126         lu_kmem_fini(cl_object_caches);
1127         OBD_FREE_PTR_ARRAY(cl_envs, num_possible_cpus());
1128 }