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 <libcfs/libcfs_hash.h> /* for cfs_hash stuff */
  54 #include <cl_object.h>
  55 #include <lu_object.h>
  56 #include "cl_internal.h"
  57
  58 static struct kmem_cache *cl_env_kmem;
  59 struct kmem_cache *cl_dio_aio_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 /**
 432  * Helper function removing all object locks, and marking object for
 433  * deletion. All object pages must have been deleted at this point.
 434  *
 435  * This is called by cl_inode_fini() and lov_object_delete() to destroy top-
 436  * and sub- objects respectively.
 437  */
 438 void cl_object_kill(const struct lu_env *env, struct cl_object *obj)
 439 {
 440         struct cl_object_header *hdr = cl_object_header(obj);
 441
 442         set_bit(LU_OBJECT_HEARD_BANSHEE, &hdr->coh_lu.loh_flags);
 443 }
 444 EXPORT_SYMBOL(cl_object_kill);
 445
 446 void cache_stats_init(struct cache_stats *cs, const char *name)
 447 {
 448         int i;
 449
 450         cs->cs_name = name;
 451         for (i = 0; i < CS_NR; i++)
 452                 atomic_set(&cs->cs_stats[i], 0);
 453 }
 454
 455 static int cache_stats_print(const struct cache_stats *cs,
 456                              struct seq_file *m, int h)
 457 {
 458         int i;
 459
 460         /*
 461          *   lookup    hit    total  cached create
 462          * env: ...... ...... ...... ...... ......
 463          */
 464         if (h) {
 465                 const char *names[CS_NR] = CS_NAMES;
 466
 467                 seq_printf(m, "%6s", " ");
 468                 for (i = 0; i < CS_NR; i++)
 469                         seq_printf(m, "%8s", names[i]);
 470                 seq_printf(m, "\n");
 471         }
 472
 473         seq_printf(m, "%5.5s:", cs->cs_name);
 474         for (i = 0; i < CS_NR; i++)
 475                 seq_printf(m, "%8u", atomic_read(&cs->cs_stats[i]));
 476         return 0;
 477 }
 478
 479 static void cl_env_percpu_refill(void);
 480
 481 /**
 482  * Initialize client site.
 483  *
 484  * Perform common initialization (lu_site_init()), and initialize statistical
 485  * counters. Also perform global initializations on the first call.
 486  */
 487 int cl_site_init(struct cl_site *s, struct cl_device *d)
 488 {
 489         size_t i;
 490         int result;
 491
 492         result = lu_site_init(&s->cs_lu, &d->cd_lu_dev);
 493         if (result == 0) {
 494                 cache_stats_init(&s->cs_pages, "pages");
 495                 for (i = 0; i < ARRAY_SIZE(s->cs_pages_state); ++i)
 496                         atomic_set(&s->cs_pages_state[0], 0);
 497                 cl_env_percpu_refill();
 498         }
 499         return result;
 500 }
 501 EXPORT_SYMBOL(cl_site_init);
 502
 503 /**
 504  * Finalize client site. Dual to cl_site_init().
 505  */
 506 void cl_site_fini(struct cl_site *s)
 507 {
 508         lu_site_fini(&s->cs_lu);
 509 }
 510 EXPORT_SYMBOL(cl_site_fini);
 511
 512 static struct cache_stats cl_env_stats = {
 513         .cs_name    = "envs",
 514         .cs_stats = { ATOMIC_INIT(0), }
 515 };
 516
 517 /**
 518  * Outputs client site statistical counters into a buffer. Suitable for
 519  * ll_rd_*()-style functions.
 520  */
 521 int cl_site_stats_print(const struct cl_site *site, struct seq_file *m)
 522 {
 523         static const char *const pstate[] = {
 524                 [CPS_CACHED]    = "c",
 525                 [CPS_OWNED]     = "o",
 526                 [CPS_PAGEOUT]   = "w",
 527                 [CPS_PAGEIN]    = "r",
 528                 [CPS_FREEING]   = "f"
 529         };
 530         size_t i;
 531
 532 /*
 533        lookup    hit  total   busy create
 534 pages: ...... ...... ...... ...... ...... [...... ...... ...... ......]
 535 locks: ...... ...... ...... ...... ...... [...... ...... ...... ...... ......]
 536   env: ...... ...... ...... ...... ......
 537  */
 538         lu_site_stats_seq_print(&site->cs_lu, m);
 539         cache_stats_print(&site->cs_pages, m, 1);
 540         seq_printf(m, " [");
 541         for (i = 0; i < ARRAY_SIZE(site->cs_pages_state); ++i)
 542                 seq_printf(m, "%s: %u ", pstate[i],
 543                            atomic_read(&site->cs_pages_state[i]));
 544         seq_printf(m, "]\n");
 545         cache_stats_print(&cl_env_stats, m, 0);
 546         seq_printf(m, "\n");
 547         return 0;
 548 }
 549 EXPORT_SYMBOL(cl_site_stats_print);
 550
 551 /*****************************************************************************
 552  *
 553  * lu_env handling on client.
 554  *
 555  */
 556
 557 /**
 558  * The most efficient way is to store cl_env pointer in task specific
 559  * structures. On Linux, it isn't easy to use task_struct->journal_info
 560  * because Lustre code may call into other fs during memory reclaim, which
 561  * has certain assumptions about journal_info. There are not currently any
 562  * fields in task_struct that can be used for this purpose.
 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  * Since 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 static void cl_env_inc(enum cache_stats_item item)
 602 {
 603 #ifdef CONFIG_DEBUG_PAGESTATE_TRACKING
 604         atomic_inc(&cl_env_stats.cs_stats[item]);
 605 #endif
 606 }
 607
 608 static void cl_env_dec(enum cache_stats_item item)
 609 {
 610 #ifdef CONFIG_DEBUG_PAGESTATE_TRACKING
 611         LASSERT(atomic_read(&cl_env_stats.cs_stats[item]) > 0);
 612         atomic_dec(&cl_env_stats.cs_stats[item]);
 613 #endif
 614 }
 615
 616 static void cl_env_init0(struct cl_env *cle, void *debug)
 617 {
 618         LASSERT(cle->ce_ref == 0);
 619         LASSERT(cle->ce_magic == &cl_env_init0);
 620         LASSERT(cle->ce_debug == NULL);
 621
 622         cle->ce_ref = 1;
 623         cle->ce_debug = debug;
 624         cl_env_inc(CS_busy);
 625 }
 626
 627 static struct lu_env *cl_env_new(__u32 ctx_tags, __u32 ses_tags, void *debug)
 628 {
 629         struct lu_env *env;
 630         struct cl_env *cle;
 631
 632         OBD_SLAB_ALLOC_PTR_GFP(cle, cl_env_kmem, GFP_NOFS);
 633         if (cle != NULL) {
 634                 int rc;
 635
 636                 INIT_LIST_HEAD(&cle->ce_linkage);
 637                 cle->ce_magic = &cl_env_init0;
 638                 env = &cle->ce_lu;
 639                 rc = lu_env_init(env, LCT_CL_THREAD|ctx_tags);
 640                 if (rc == 0) {
 641                         rc = lu_context_init(&cle->ce_ses,
 642                                              LCT_SESSION | ses_tags);
 643                         if (rc == 0) {
 644                                 lu_context_enter(&cle->ce_ses);
 645                                 env->le_ses = &cle->ce_ses;
 646                                 cl_env_init0(cle, debug);
 647                         } else
 648                                 lu_env_fini(env);
 649                 }
 650                 if (rc != 0) {
 651                         OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
 652                         env = ERR_PTR(rc);
 653                 } else {
 654                         cl_env_inc(CS_create);
 655                         cl_env_inc(CS_total);
 656                 }
 657         } else
 658                 env = ERR_PTR(-ENOMEM);
 659         return env;
 660 }
 661
 662 static void cl_env_fini(struct cl_env *cle)
 663 {
 664         cl_env_dec(CS_total);
 665         lu_context_fini(&cle->ce_lu.le_ctx);
 666         lu_context_fini(&cle->ce_ses);
 667         OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
 668 }
 669
 670 static struct lu_env *cl_env_obtain(void *debug)
 671 {
 672         struct cl_env *cle;
 673         struct lu_env *env;
 674         int cpu = get_cpu();
 675
 676         ENTRY;
 677
 678         read_lock(&cl_envs[cpu].cec_guard);
 679         LASSERT(equi(cl_envs[cpu].cec_count == 0,
 680                 list_empty(&cl_envs[cpu].cec_envs)));
 681         if (cl_envs[cpu].cec_count > 0) {
 682                 int rc;
 683
 684                 cle = container_of(cl_envs[cpu].cec_envs.next, struct cl_env,
 685                                    ce_linkage);
 686                 list_del_init(&cle->ce_linkage);
 687                 cl_envs[cpu].cec_count--;
 688                 read_unlock(&cl_envs[cpu].cec_guard);
 689                 put_cpu();
 690
 691                 env = &cle->ce_lu;
 692                 rc = lu_env_refill(env);
 693                 if (rc == 0) {
 694                         cl_env_init0(cle, debug);
 695                         lu_context_enter(&env->le_ctx);
 696                         lu_context_enter(&cle->ce_ses);
 697                 } else {
 698                         cl_env_fini(cle);
 699                         env = ERR_PTR(rc);
 700                 }
 701         } else {
 702                 read_unlock(&cl_envs[cpu].cec_guard);
 703                 put_cpu();
 704                 env = cl_env_new(lu_context_tags_default,
 705                                  lu_session_tags_default, debug);
 706         }
 707         RETURN(env);
 708 }
 709
 710 static inline struct cl_env *cl_env_container(struct lu_env *env)
 711 {
 712         return container_of(env, struct cl_env, ce_lu);
 713 }
 714
 715 /**
 716  * Returns lu_env: if there already is an environment associated with the
 717  * current thread, it is returned, otherwise, new environment is allocated.
 718  *
 719  * Allocations are amortized through the global cache of environments.
 720  *
 721  * \param refcheck pointer to a counter used to detect environment leaks. In
 722  * the usual case cl_env_get() and cl_env_put() are called in the same lexical
 723  * scope and pointer to the same integer is passed as \a refcheck. This is
 724  * used to detect missed cl_env_put().
 725  *
 726  * \see cl_env_put()
 727  */
 728 struct lu_env *cl_env_get(__u16 *refcheck)
 729 {
 730         struct lu_env *env;
 731
 732         env = cl_env_obtain(__builtin_return_address(0));
 733         if (!IS_ERR(env)) {
 734                 struct cl_env *cle;
 735
 736                 cle = cl_env_container(env);
 737                 *refcheck = cle->ce_ref;
 738                 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 739         }
 740         return env;
 741 }
 742 EXPORT_SYMBOL(cl_env_get);
 743
 744 /**
 745  * Forces an allocation of a fresh environment with given tags.
 746  *
 747  * \see cl_env_get()
 748  */
 749 struct lu_env *cl_env_alloc(__u16 *refcheck, __u32 tags)
 750 {
 751         struct lu_env *env;
 752
 753         env = cl_env_new(tags, tags, __builtin_return_address(0));
 754         if (!IS_ERR(env)) {
 755                 struct cl_env *cle;
 756
 757                 cle = cl_env_container(env);
 758                 *refcheck = cle->ce_ref;
 759                 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 760         }
 761         return env;
 762 }
 763 EXPORT_SYMBOL(cl_env_alloc);
 764
 765 static void cl_env_exit(struct cl_env *cle)
 766 {
 767         lu_context_exit(&cle->ce_lu.le_ctx);
 768         lu_context_exit(&cle->ce_ses);
 769 }
 770
 771 /**
 772  * Finalizes and frees a given number of cached environments. This is done to
 773  * (1) free some memory (not currently hooked into VM), or (2) release
 774  * references to modules.
 775  */
 776 unsigned cl_env_cache_purge(unsigned nr)
 777 {
 778         struct cl_env *cle;
 779         unsigned i;
 780
 781         ENTRY;
 782         for_each_possible_cpu(i) {
 783                 write_lock(&cl_envs[i].cec_guard);
 784                 for (; !list_empty(&cl_envs[i].cec_envs) && nr > 0; --nr) {
 785                         cle = container_of(cl_envs[i].cec_envs.next,
 786                                            struct cl_env, ce_linkage);
 787                         list_del_init(&cle->ce_linkage);
 788                         LASSERT(cl_envs[i].cec_count > 0);
 789                         cl_envs[i].cec_count--;
 790                         write_unlock(&cl_envs[i].cec_guard);
 791
 792                         cl_env_fini(cle);
 793                         write_lock(&cl_envs[i].cec_guard);
 794                 }
 795                 LASSERT(equi(cl_envs[i].cec_count == 0,
 796                         list_empty(&cl_envs[i].cec_envs)));
 797                 write_unlock(&cl_envs[i].cec_guard);
 798         }
 799         RETURN(nr);
 800 }
 801 EXPORT_SYMBOL(cl_env_cache_purge);
 802
 803 /**
 804  * Release an environment.
 805  *
 806  * Decrement \a env reference counter. When counter drops to 0, nothing in
 807  * this thread is using environment and it is returned to the allocation
 808  * cache, or freed straight away, if cache is large enough.
 809  */
 810 void cl_env_put(struct lu_env *env, __u16 *refcheck)
 811 {
 812         struct cl_env *cle;
 813
 814         cle = cl_env_container(env);
 815
 816         LASSERT(cle->ce_ref > 0);
 817         LASSERT(ergo(refcheck != NULL, cle->ce_ref == *refcheck));
 818
 819         CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
 820         if (--cle->ce_ref == 0) {
 821                 int cpu = get_cpu();
 822
 823                 cl_env_dec(CS_busy);
 824                 cle->ce_debug = NULL;
 825                 cl_env_exit(cle);
 826                 /*
 827                  * Don't bother to take a lock here.
 828                  *
 829                  * Return environment to the cache only when it was allocated
 830                  * with the standard tags.
 831                  */
 832                 if (cl_envs[cpu].cec_count < cl_envs_cached_max &&
 833                     (env->le_ctx.lc_tags & ~LCT_HAS_EXIT) == lu_context_tags_default &&
 834                     (env->le_ses->lc_tags & ~LCT_HAS_EXIT) == lu_session_tags_default) {
 835                         read_lock(&cl_envs[cpu].cec_guard);
 836                         list_add(&cle->ce_linkage, &cl_envs[cpu].cec_envs);
 837                         cl_envs[cpu].cec_count++;
 838                         read_unlock(&cl_envs[cpu].cec_guard);
 839                 } else
 840                         cl_env_fini(cle);
 841                 put_cpu();
 842         }
 843 }
 844 EXPORT_SYMBOL(cl_env_put);
 845
 846 /**
 847  * Converts struct cl_attr to struct ost_lvb.
 848  *
 849  * \see cl_lvb2attr
 850  */
 851 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr)
 852 {
 853         lvb->lvb_size   = attr->cat_size;
 854         lvb->lvb_mtime  = attr->cat_mtime;
 855         lvb->lvb_atime  = attr->cat_atime;
 856         lvb->lvb_ctime  = attr->cat_ctime;
 857         lvb->lvb_blocks = attr->cat_blocks;
 858 }
 859
 860 /**
 861  * Converts struct ost_lvb to struct cl_attr.
 862  *
 863  * \see cl_attr2lvb
 864  */
 865 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb)
 866 {
 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 }
 873 EXPORT_SYMBOL(cl_lvb2attr);
 874
 875 static struct cl_env cl_env_percpu[NR_CPUS];
 876 static DEFINE_MUTEX(cl_env_percpu_mutex);
 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         mutex_lock(&cl_env_percpu_mutex);
 942         for_each_possible_cpu(i)
 943                 lu_env_refill(&cl_env_percpu[i].ce_lu);
 944         mutex_unlock(&cl_env_percpu_mutex);
 945 }
 946
 947 void cl_env_percpu_put(struct lu_env *env)
 948 {
 949         struct cl_env *cle;
 950         int cpu;
 951
 952         cpu = smp_processor_id();
 953         cle = cl_env_container(env);
 954         LASSERT(cle == &cl_env_percpu[cpu]);
 955
 956         cle->ce_ref--;
 957         LASSERT(cle->ce_ref == 0);
 958
 959         cl_env_dec(CS_busy);
 960         cle->ce_debug = NULL;
 961
 962         put_cpu();
 963 }
 964 EXPORT_SYMBOL(cl_env_percpu_put);
 965
 966 struct lu_env *cl_env_percpu_get(void)
 967 {
 968         struct cl_env *cle;
 969
 970         cle = &cl_env_percpu[get_cpu()];
 971         cl_env_init0(cle, __builtin_return_address(0));
 972
 973         return &cle->ce_lu;
 974 }
 975 EXPORT_SYMBOL(cl_env_percpu_get);
 976
 977 /*****************************************************************************
 978  *
 979  * Temporary prototype thing: mirror obd-devices into cl devices.
 980  *
 981  */
 982
 983 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
 984                                 struct lu_device_type *ldt,
 985                                 struct lu_device *next)
 986 {
 987         const char       *typename;
 988         struct lu_device *d;
 989
 990         LASSERT(ldt != NULL);
 991
 992         typename = ldt->ldt_name;
 993         d = ldt->ldt_ops->ldto_device_alloc(env, ldt, NULL);
 994         if (!IS_ERR(d)) {
 995                 int rc;
 996
 997                 if (site != NULL)
 998                         d->ld_site = site;
 999                 rc = ldt->ldt_ops->ldto_device_init(env, d, typename, next);
1000                 if (rc == 0) {
1001                         lu_device_get(d);
1002                         lu_ref_add(&d->ld_reference,
1003                                    "lu-stack", &lu_site_init);
1004                 } else {
1005                         ldt->ldt_ops->ldto_device_free(env, d);
1006                         CERROR("can't init device '%s', %d\n", typename, rc);
1007                         d = ERR_PTR(rc);
1008                 }
1009         } else
1010                 CERROR("Cannot allocate device: '%s'\n", typename);
1011         return lu2cl_dev(d);
1012 }
1013 EXPORT_SYMBOL(cl_type_setup);
1014
1015 /**
1016  * Finalize device stack by calling lu_stack_fini().
1017  */
1018 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl)
1019 {
1020         lu_stack_fini(env, cl2lu_dev(cl));
1021 }
1022 EXPORT_SYMBOL(cl_stack_fini);
1023
1024 static struct lu_context_key cl_key;
1025
1026 struct cl_thread_info *cl_env_info(const struct lu_env *env)
1027 {
1028         return lu_context_key_get(&env->le_ctx, &cl_key);
1029 }
1030
1031 /* defines cl_key_{init,fini}() */
1032 LU_KEY_INIT_FINI(cl, struct cl_thread_info);
1033
1034 static struct lu_context_key cl_key = {
1035         .lct_tags = LCT_CL_THREAD,
1036         .lct_init = cl_key_init,
1037         .lct_fini = cl_key_fini,
1038 };
1039
1040 static struct lu_kmem_descr cl_object_caches[] = {
1041         {
1042                 .ckd_cache = &cl_env_kmem,
1043                 .ckd_name  = "cl_env_kmem",
1044                 .ckd_size  = sizeof(struct cl_env)
1045         },
1046         {
1047                 .ckd_cache = &cl_dio_aio_kmem,
1048                 .ckd_name  = "cl_dio_aio_kmem",
1049                 .ckd_size  = sizeof(struct cl_dio_aio)
1050         },
1051         {
1052                 .ckd_cache = NULL
1053         }
1054 };
1055
1056 /**
1057  * Global initialization of cl-data. Create kmem caches, register
1058  * lu_context_key's, etc.
1059  *
1060  * \see cl_global_fini()
1061  */
1062 int cl_global_init(void)
1063 {
1064         int result;
1065
1066         OBD_ALLOC_PTR_ARRAY(cl_envs, num_possible_cpus());
1067         if (cl_envs == NULL)
1068                 GOTO(out, result = -ENOMEM);
1069
1070         result = lu_kmem_init(cl_object_caches);
1071         if (result)
1072                 GOTO(out_envs, result);
1073
1074         LU_CONTEXT_KEY_INIT(&cl_key);
1075         result = lu_context_key_register(&cl_key);
1076         if (result)
1077                 GOTO(out_kmem, result);
1078
1079         result = cl_env_percpu_init();
1080         if (result) /* no cl_env_percpu_fini on error */
1081                 GOTO(out_keys, result);
1082
1083         return 0;
1084
1085 out_keys:
1086         lu_context_key_degister(&cl_key);
1087 out_kmem:
1088         lu_kmem_fini(cl_object_caches);
1089 out_envs:
1090         OBD_FREE_PTR_ARRAY(cl_envs, num_possible_cpus());
1091 out:
1092         return result;
1093 }
1094
1095 /**
1096  * Finalization of global cl-data. Dual to cl_global_init().
1097  */
1098 void cl_global_fini(void)
1099 {
1100         int i;
1101
1102         for (i = 0; i < ARRAY_SIZE(cl_page_kmem_array); i++) {
1103                 if (cl_page_kmem_array[i]) {
1104                         kmem_cache_destroy(cl_page_kmem_array[i]);
1105                         cl_page_kmem_array[i] = NULL;
1106                 }
1107         }
1108         cl_env_percpu_fini();
1109         lu_context_key_degister(&cl_key);
1110         lu_kmem_fini(cl_object_caches);
1111         OBD_FREE_PTR_ARRAY(cl_envs, num_possible_cpus());
1112 }