lustre/obdclass/cl_object.c

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