lustre/obdclass/cl_object.c

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