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