4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
27 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2012, Whamcloud, Inc.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * Client Lustre Object.
38 * Author: Nikita Danilov <nikita.danilov@sun.com>
52 #define DEBUG_SUBSYSTEM S_CLASS
54 # define EXPORT_SYMTAB
57 #include <libcfs/libcfs.h>
58 /* class_put_type() */
59 #include <obd_class.h>
60 #include <obd_support.h>
61 #include <lustre_fid.h>
62 #include <libcfs/list.h>
63 #include <libcfs/libcfs_hash.h> /* for cfs_hash stuff */
64 /* lu_time_global_{init,fini}() */
67 #include <cl_object.h>
68 #include "cl_internal.h"
70 static cfs_mem_cache_t *cl_env_kmem;
72 /** Lock class of cl_object_header::coh_page_guard */
73 static cfs_lock_class_key_t cl_page_guard_class;
74 /** Lock class of cl_object_header::coh_lock_guard */
75 static cfs_lock_class_key_t cl_lock_guard_class;
76 /** Lock class of cl_object_header::coh_attr_guard */
77 static cfs_lock_class_key_t cl_attr_guard_class;
79 extern __u32 lu_context_tags_default;
80 extern __u32 lu_session_tags_default;
82 * Initialize cl_object_header.
84 int cl_object_header_init(struct cl_object_header *h)
89 result = lu_object_header_init(&h->coh_lu);
91 cfs_spin_lock_init(&h->coh_page_guard);
92 cfs_spin_lock_init(&h->coh_lock_guard);
93 cfs_spin_lock_init(&h->coh_attr_guard);
94 cfs_lockdep_set_class(&h->coh_attr_guard, &cl_page_guard_class);
95 cfs_lockdep_set_class(&h->coh_attr_guard, &cl_lock_guard_class);
96 cfs_lockdep_set_class(&h->coh_attr_guard, &cl_attr_guard_class);
98 /* XXX hard coded GFP_* mask. */
99 INIT_RADIX_TREE(&h->coh_tree, GFP_ATOMIC);
100 CFS_INIT_LIST_HEAD(&h->coh_locks);
104 EXPORT_SYMBOL(cl_object_header_init);
107 * Finalize cl_object_header.
109 void cl_object_header_fini(struct cl_object_header *h)
111 LASSERT(cfs_list_empty(&h->coh_locks));
112 lu_object_header_fini(&h->coh_lu);
114 EXPORT_SYMBOL(cl_object_header_fini);
117 * Returns a cl_object with a given \a fid.
119 * Returns either cached or newly created object. Additional reference on the
120 * returned object is acquired.
122 * \see lu_object_find(), cl_page_find(), cl_lock_find()
124 struct cl_object *cl_object_find(const struct lu_env *env,
125 struct cl_device *cd, const struct lu_fid *fid,
126 const struct cl_object_conf *c)
129 return lu2cl(lu_object_find_slice(env, cl2lu_dev(cd), fid, &c->coc_lu));
131 EXPORT_SYMBOL(cl_object_find);
134 * Releases a reference on \a o.
136 * When last reference is released object is returned to the cache, unless
137 * lu_object_header_flags::LU_OBJECT_HEARD_BANSHEE bit is set in its header.
139 * \see cl_page_put(), cl_lock_put().
141 void cl_object_put(const struct lu_env *env, struct cl_object *o)
143 lu_object_put(env, &o->co_lu);
145 EXPORT_SYMBOL(cl_object_put);
148 * Acquire an additional reference to the object \a o.
150 * This can only be used to acquire _additional_ reference, i.e., caller
151 * already has to possess at least one reference to \a o before calling this.
153 * \see cl_page_get(), cl_lock_get().
155 void cl_object_get(struct cl_object *o)
157 lu_object_get(&o->co_lu);
159 EXPORT_SYMBOL(cl_object_get);
162 * Returns the top-object for a given \a o.
164 * \see cl_page_top(), cl_io_top()
166 struct cl_object *cl_object_top(struct cl_object *o)
168 struct cl_object_header *hdr = cl_object_header(o);
169 struct cl_object *top;
171 while (hdr->coh_parent != NULL)
172 hdr = hdr->coh_parent;
174 top = lu2cl(lu_object_top(&hdr->coh_lu));
175 CDEBUG(D_TRACE, "%p -> %p\n", o, top);
178 EXPORT_SYMBOL(cl_object_top);
181 * Returns pointer to the lock protecting data-attributes for the given object
184 * Data-attributes are protected by the cl_object_header::coh_attr_guard
185 * spin-lock in the top-object.
187 * \see cl_attr, cl_object_attr_lock(), cl_object_operations::coo_attr_get().
189 static cfs_spinlock_t *cl_object_attr_guard(struct cl_object *o)
191 return &cl_object_header(cl_object_top(o))->coh_attr_guard;
195 * Locks data-attributes.
197 * Prevents data-attributes from changing, until lock is released by
198 * cl_object_attr_unlock(). This has to be called before calls to
199 * cl_object_attr_get(), cl_object_attr_set().
201 void cl_object_attr_lock(struct cl_object *o)
203 cfs_spin_lock(cl_object_attr_guard(o));
205 EXPORT_SYMBOL(cl_object_attr_lock);
208 * Releases data-attributes lock, acquired by cl_object_attr_lock().
210 void cl_object_attr_unlock(struct cl_object *o)
212 cfs_spin_unlock(cl_object_attr_guard(o));
214 EXPORT_SYMBOL(cl_object_attr_unlock);
217 * Returns data-attributes of an object \a obj.
219 * Every layer is asked (by calling cl_object_operations::coo_attr_get())
220 * top-to-bottom to fill in parts of \a attr that this layer is responsible
223 int cl_object_attr_get(const struct lu_env *env, struct cl_object *obj,
224 struct cl_attr *attr)
226 struct lu_object_header *top;
229 LASSERT_SPIN_LOCKED(cl_object_attr_guard(obj));
232 top = obj->co_lu.lo_header;
234 cfs_list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
235 if (obj->co_ops->coo_attr_get != NULL) {
236 result = obj->co_ops->coo_attr_get(env, obj, attr);
246 EXPORT_SYMBOL(cl_object_attr_get);
249 * Updates data-attributes of an object \a obj.
251 * Only attributes, mentioned in a validness bit-mask \a v are
252 * updated. Calls cl_object_operations::coo_attr_set() on every layer, bottom
255 int cl_object_attr_set(const struct lu_env *env, struct cl_object *obj,
256 const struct cl_attr *attr, unsigned v)
258 struct lu_object_header *top;
261 LASSERT_SPIN_LOCKED(cl_object_attr_guard(obj));
264 top = obj->co_lu.lo_header;
266 cfs_list_for_each_entry_reverse(obj, &top->loh_layers,
268 if (obj->co_ops->coo_attr_set != NULL) {
269 result = obj->co_ops->coo_attr_set(env, obj, attr, v);
279 EXPORT_SYMBOL(cl_object_attr_set);
282 * Notifies layers (bottom-to-top) that glimpse AST was received.
284 * Layers have to fill \a lvb fields with information that will be shipped
285 * back to glimpse issuer.
287 * \see cl_lock_operations::clo_glimpse()
289 int cl_object_glimpse(const struct lu_env *env, struct cl_object *obj,
292 struct lu_object_header *top;
296 top = obj->co_lu.lo_header;
298 cfs_list_for_each_entry_reverse(obj, &top->loh_layers,
300 if (obj->co_ops->coo_glimpse != NULL) {
301 result = obj->co_ops->coo_glimpse(env, obj, lvb);
306 LU_OBJECT_HEADER(D_DLMTRACE, env, lu_object_top(top),
307 "size: "LPU64" mtime: "LPU64" atime: "LPU64" "
308 "ctime: "LPU64" blocks: "LPU64"\n",
309 lvb->lvb_size, lvb->lvb_mtime, lvb->lvb_atime,
310 lvb->lvb_ctime, lvb->lvb_blocks);
313 EXPORT_SYMBOL(cl_object_glimpse);
316 * Updates a configuration of an object \a obj.
318 int cl_conf_set(const struct lu_env *env, struct cl_object *obj,
319 const struct cl_object_conf *conf)
321 struct lu_object_header *top;
325 top = obj->co_lu.lo_header;
327 cfs_list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
328 if (obj->co_ops->coo_conf_set != NULL) {
329 result = obj->co_ops->coo_conf_set(env, obj, conf);
336 EXPORT_SYMBOL(cl_conf_set);
339 * Helper function removing all object locks, and marking object for
340 * deletion. All object pages must have been deleted at this point.
342 * This is called by cl_inode_fini() and lov_object_delete() to destroy top-
343 * and sub- objects respectively.
345 void cl_object_kill(const struct lu_env *env, struct cl_object *obj)
347 struct cl_object_header *hdr;
349 hdr = cl_object_header(obj);
350 LASSERT(hdr->coh_tree.rnode == NULL);
351 LASSERT(hdr->coh_pages == 0);
353 cfs_set_bit(LU_OBJECT_HEARD_BANSHEE, &hdr->coh_lu.loh_flags);
355 * Destroy all locks. Object destruction (including cl_inode_fini())
356 * cannot cancel the locks, because in the case of a local client,
357 * where client and server share the same thread running
358 * prune_icache(), this can dead-lock with ldlm_cancel_handler()
359 * waiting on __wait_on_freeing_inode().
361 cl_locks_prune(env, obj, 0);
363 EXPORT_SYMBOL(cl_object_kill);
366 * Prunes caches of pages and locks for this object.
368 void cl_object_prune(const struct lu_env *env, struct cl_object *obj)
371 cl_pages_prune(env, obj);
372 cl_locks_prune(env, obj, 1);
375 EXPORT_SYMBOL(cl_object_prune);
378 * Check if the object has locks.
380 int cl_object_has_locks(struct cl_object *obj)
382 struct cl_object_header *head = cl_object_header(obj);
385 cfs_spin_lock(&head->coh_lock_guard);
386 has = cfs_list_empty(&head->coh_locks);
387 cfs_spin_unlock(&head->coh_lock_guard);
391 EXPORT_SYMBOL(cl_object_has_locks);
393 void cache_stats_init(struct cache_stats *cs, const char *name)
396 cfs_atomic_set(&cs->cs_lookup, 0);
397 cfs_atomic_set(&cs->cs_hit, 0);
398 cfs_atomic_set(&cs->cs_total, 0);
399 cfs_atomic_set(&cs->cs_busy, 0);
402 int cache_stats_print(const struct cache_stats *cs,
403 char *page, int count, int h)
407 lookup hit total cached create
408 env: ...... ...... ...... ...... ......
411 nob += snprintf(page, count,
412 " lookup hit total busy create\n");
414 nob += snprintf(page + nob, count - nob,
415 "%5.5s: %6u %6u %6u %6u %6u",
417 cfs_atomic_read(&cs->cs_lookup),
418 cfs_atomic_read(&cs->cs_hit),
419 cfs_atomic_read(&cs->cs_total),
420 cfs_atomic_read(&cs->cs_busy),
421 cfs_atomic_read(&cs->cs_created));
426 * Initialize client site.
428 * Perform common initialization (lu_site_init()), and initialize statistical
429 * counters. Also perform global initializations on the first call.
431 int cl_site_init(struct cl_site *s, struct cl_device *d)
436 result = lu_site_init(&s->cs_lu, &d->cd_lu_dev);
438 cache_stats_init(&s->cs_pages, "pages");
439 cache_stats_init(&s->cs_locks, "locks");
440 for (i = 0; i < ARRAY_SIZE(s->cs_pages_state); ++i)
441 cfs_atomic_set(&s->cs_pages_state[0], 0);
442 for (i = 0; i < ARRAY_SIZE(s->cs_locks_state); ++i)
443 cfs_atomic_set(&s->cs_locks_state[i], 0);
447 EXPORT_SYMBOL(cl_site_init);
450 * Finalize client site. Dual to cl_site_init().
452 void cl_site_fini(struct cl_site *s)
454 lu_site_fini(&s->cs_lu);
456 EXPORT_SYMBOL(cl_site_fini);
458 static struct cache_stats cl_env_stats = {
460 .cs_created = CFS_ATOMIC_INIT(0),
461 .cs_lookup = CFS_ATOMIC_INIT(0),
462 .cs_hit = CFS_ATOMIC_INIT(0),
463 .cs_total = CFS_ATOMIC_INIT(0),
464 .cs_busy = CFS_ATOMIC_INIT(0)
468 * Outputs client site statistical counters into a buffer. Suitable for
469 * ll_rd_*()-style functions.
471 int cl_site_stats_print(const struct cl_site *site, char *page, int count)
475 static const char *pstate[] = {
482 static const char *lstate[] = {
485 [CLS_ENQUEUED] = "e",
487 [CLS_INTRANSIT] = "t",
492 lookup hit total busy create
493 pages: ...... ...... ...... ...... ...... [...... ...... ...... ......]
494 locks: ...... ...... ...... ...... ...... [...... ...... ...... ...... ......]
495 env: ...... ...... ...... ...... ......
497 nob = lu_site_stats_print(&site->cs_lu, page, count);
498 nob += cache_stats_print(&site->cs_pages, page + nob, count - nob, 1);
499 nob += snprintf(page + nob, count - nob, " [");
500 for (i = 0; i < ARRAY_SIZE(site->cs_pages_state); ++i)
501 nob += snprintf(page + nob, count - nob, "%s: %u ",
503 cfs_atomic_read(&site->cs_pages_state[i]));
504 nob += snprintf(page + nob, count - nob, "]\n");
505 nob += cache_stats_print(&site->cs_locks, page + nob, count - nob, 0);
506 nob += snprintf(page + nob, count - nob, " [");
507 for (i = 0; i < ARRAY_SIZE(site->cs_locks_state); ++i)
508 nob += snprintf(page + nob, count - nob, "%s: %u ",
510 cfs_atomic_read(&site->cs_locks_state[i]));
511 nob += snprintf(page + nob, count - nob, "]\n");
512 nob += cache_stats_print(&cl_env_stats, page + nob, count - nob, 0);
513 nob += snprintf(page + nob, count - nob, "\n");
516 EXPORT_SYMBOL(cl_site_stats_print);
518 /*****************************************************************************
520 * lu_env handling on client.
525 * The most efficient way is to store cl_env pointer in task specific
526 * structures. On Linux, it wont' be easy to use task_struct->journal_info
527 * because Lustre code may call into other fs which has certain assumptions
528 * about journal_info. Currently following fields in task_struct are identified
529 * can be used for this purpose:
530 * - cl_env: for liblustre.
531 * - tux_info: ony on RedHat kernel.
533 * \note As long as we use task_struct to store cl_env, we assume that once
534 * called into Lustre, we'll never call into the other part of the kernel
535 * which will use those fields in task_struct without explicitly exiting
538 * If there's no space in task_struct is available, hash will be used.
542 static CFS_LIST_HEAD(cl_envs);
543 static unsigned cl_envs_cached_nr = 0;
544 static unsigned cl_envs_cached_max = 128; /* XXX: prototype: arbitrary limit
546 static cfs_spinlock_t cl_envs_guard = CFS_SPIN_LOCK_UNLOCKED;
551 struct lu_context ce_ses;
553 #ifdef LL_TASK_CL_ENV
557 * This allows cl_env to be entered into cl_env_hash which implements
558 * the current thread -> client environment lookup.
560 cfs_hlist_node_t ce_node;
563 * Owner for the current cl_env.
565 * If LL_TASK_CL_ENV is defined, this point to the owning cfs_current(),
566 * only for debugging purpose ;
567 * Otherwise hash is used, and this is the key for cfs_hash.
568 * Now current thread pid is stored. Note using thread pointer would
569 * lead to unbalanced hash because of its specific allocation locality
570 * and could be varied for different platforms and OSes, even different
576 * Linkage into global list of all client environments. Used for
577 * garbage collection.
579 cfs_list_t ce_linkage;
585 * Debugging field: address of the caller who made original
591 #define CL_ENV_INC(counter) cfs_atomic_inc(&cl_env_stats.counter)
593 #define CL_ENV_DEC(counter) \
595 LASSERT(cfs_atomic_read(&cl_env_stats.counter) > 0); \
596 cfs_atomic_dec(&cl_env_stats.counter); \
599 static void cl_env_init0(struct cl_env *cle, void *debug)
601 LASSERT(cle->ce_ref == 0);
602 LASSERT(cle->ce_magic == &cl_env_init0);
603 LASSERT(cle->ce_debug == NULL && cle->ce_owner == NULL);
606 cle->ce_debug = debug;
611 #ifndef LL_TASK_CL_ENV
613 * The implementation of using hash table to connect cl_env and thread
616 static cfs_hash_t *cl_env_hash;
618 static unsigned cl_env_hops_hash(cfs_hash_t *lh,
619 const void *key, unsigned mask)
621 #if BITS_PER_LONG == 64
622 return cfs_hash_u64_hash((__u64)key, mask);
624 return cfs_hash_u32_hash((__u32)key, mask);
628 static void *cl_env_hops_obj(cfs_hlist_node_t *hn)
630 struct cl_env *cle = cfs_hlist_entry(hn, struct cl_env, ce_node);
631 LASSERT(cle->ce_magic == &cl_env_init0);
635 static int cl_env_hops_keycmp(const void *key, cfs_hlist_node_t *hn)
637 struct cl_env *cle = cl_env_hops_obj(hn);
639 LASSERT(cle->ce_owner != NULL);
640 return (key == cle->ce_owner);
643 static void cl_env_hops_noop(cfs_hash_t *hs, cfs_hlist_node_t *hn)
645 struct cl_env *cle = cfs_hlist_entry(hn, struct cl_env, ce_node);
646 LASSERT(cle->ce_magic == &cl_env_init0);
649 static cfs_hash_ops_t cl_env_hops = {
650 .hs_hash = cl_env_hops_hash,
651 .hs_key = cl_env_hops_obj,
652 .hs_keycmp = cl_env_hops_keycmp,
653 .hs_object = cl_env_hops_obj,
654 .hs_get = cl_env_hops_noop,
655 .hs_put_locked = cl_env_hops_noop,
658 static inline struct cl_env *cl_env_fetch(void)
662 cle = cfs_hash_lookup(cl_env_hash, (void *) (long) cfs_current()->pid);
663 LASSERT(ergo(cle, cle->ce_magic == &cl_env_init0));
667 static inline void cl_env_attach(struct cl_env *cle)
672 LASSERT(cle->ce_owner == NULL);
673 cle->ce_owner = (void *) (long) cfs_current()->pid;
674 rc = cfs_hash_add_unique(cl_env_hash, cle->ce_owner,
680 static inline void cl_env_do_detach(struct cl_env *cle)
684 LASSERT(cle->ce_owner == (void *) (long) cfs_current()->pid);
685 cookie = cfs_hash_del(cl_env_hash, cle->ce_owner,
687 LASSERT(cookie == cle);
688 cle->ce_owner = NULL;
691 static int cl_env_store_init(void) {
692 cl_env_hash = cfs_hash_create("cl_env",
693 HASH_CL_ENV_BITS, HASH_CL_ENV_BITS,
694 HASH_CL_ENV_BKT_BITS, 0,
698 CFS_HASH_RW_BKTLOCK);
699 return cl_env_hash != NULL ? 0 :-ENOMEM;
702 static void cl_env_store_fini(void) {
703 cfs_hash_putref(cl_env_hash);
706 #else /* LL_TASK_CL_ENV */
708 * The implementation of store cl_env directly in thread structure.
711 static inline struct cl_env *cl_env_fetch(void)
715 cle = cfs_current()->LL_TASK_CL_ENV;
716 if (cle && cle->ce_magic != &cl_env_init0)
721 static inline void cl_env_attach(struct cl_env *cle)
724 LASSERT(cle->ce_owner == NULL);
725 cle->ce_owner = cfs_current();
726 cle->ce_prev = cfs_current()->LL_TASK_CL_ENV;
727 cfs_current()->LL_TASK_CL_ENV = cle;
731 static inline void cl_env_do_detach(struct cl_env *cle)
733 LASSERT(cle->ce_owner == cfs_current());
734 LASSERT(cfs_current()->LL_TASK_CL_ENV == cle);
735 cfs_current()->LL_TASK_CL_ENV = cle->ce_prev;
736 cle->ce_owner = NULL;
739 static int cl_env_store_init(void) { return 0; }
740 static void cl_env_store_fini(void) { }
742 #endif /* LL_TASK_CL_ENV */
744 static inline struct cl_env *cl_env_detach(struct cl_env *cle)
747 cle = cl_env_fetch();
749 if (cle && cle->ce_owner)
750 cl_env_do_detach(cle);
755 static struct lu_env *cl_env_new(__u32 ctx_tags, __u32 ses_tags, void *debug)
760 OBD_SLAB_ALLOC_PTR_GFP(cle, cl_env_kmem, CFS_ALLOC_IO);
764 CFS_INIT_LIST_HEAD(&cle->ce_linkage);
765 cle->ce_magic = &cl_env_init0;
767 rc = lu_env_init(env, LCT_CL_THREAD|ctx_tags);
769 rc = lu_context_init(&cle->ce_ses,
770 LCT_SESSION | ses_tags);
772 lu_context_enter(&cle->ce_ses);
773 env->le_ses = &cle->ce_ses;
774 cl_env_init0(cle, debug);
779 OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
782 CL_ENV_INC(cs_created);
783 CL_ENV_INC(cs_total);
786 env = ERR_PTR(-ENOMEM);
790 static void cl_env_fini(struct cl_env *cle)
792 CL_ENV_DEC(cs_total);
793 lu_context_fini(&cle->ce_lu.le_ctx);
794 lu_context_fini(&cle->ce_ses);
795 OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
798 static struct lu_env *cl_env_obtain(void *debug)
804 cfs_spin_lock(&cl_envs_guard);
805 LASSERT(equi(cl_envs_cached_nr == 0, cfs_list_empty(&cl_envs)));
806 if (cl_envs_cached_nr > 0) {
809 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
810 cfs_list_del_init(&cle->ce_linkage);
812 cfs_spin_unlock(&cl_envs_guard);
815 rc = lu_env_refill(env);
817 cl_env_init0(cle, debug);
818 lu_context_enter(&env->le_ctx);
819 lu_context_enter(&cle->ce_ses);
825 cfs_spin_unlock(&cl_envs_guard);
826 env = cl_env_new(lu_context_tags_default,
827 lu_session_tags_default, debug);
832 static inline struct cl_env *cl_env_container(struct lu_env *env)
834 return container_of(env, struct cl_env, ce_lu);
837 struct lu_env *cl_env_peek(int *refcheck)
842 CL_ENV_INC(cs_lookup);
844 /* check that we don't go far from untrusted pointer */
845 CLASSERT(offsetof(struct cl_env, ce_magic) == 0);
848 cle = cl_env_fetch();
852 *refcheck = ++cle->ce_ref;
854 CDEBUG(D_OTHER, "%d@%p\n", cle ? cle->ce_ref : 0, cle);
857 EXPORT_SYMBOL(cl_env_peek);
860 * Returns lu_env: if there already is an environment associated with the
861 * current thread, it is returned, otherwise, new environment is allocated.
863 * Allocations are amortized through the global cache of environments.
865 * \param refcheck pointer to a counter used to detect environment leaks. In
866 * the usual case cl_env_get() and cl_env_put() are called in the same lexical
867 * scope and pointer to the same integer is passed as \a refcheck. This is
868 * used to detect missed cl_env_put().
872 struct lu_env *cl_env_get(int *refcheck)
876 env = cl_env_peek(refcheck);
878 env = cl_env_obtain(__builtin_return_address(0));
882 cle = cl_env_container(env);
884 *refcheck = cle->ce_ref;
885 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
890 EXPORT_SYMBOL(cl_env_get);
893 * Forces an allocation of a fresh environment with given tags.
897 struct lu_env *cl_env_alloc(int *refcheck, __u32 tags)
901 LASSERT(cl_env_peek(refcheck) == NULL);
902 env = cl_env_new(tags, tags, __builtin_return_address(0));
906 cle = cl_env_container(env);
907 *refcheck = cle->ce_ref;
908 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
912 EXPORT_SYMBOL(cl_env_alloc);
914 static void cl_env_exit(struct cl_env *cle)
916 LASSERT(cle->ce_owner == NULL);
917 lu_context_exit(&cle->ce_lu.le_ctx);
918 lu_context_exit(&cle->ce_ses);
922 * Finalizes and frees a given number of cached environments. This is done to
923 * (1) free some memory (not currently hooked into VM), or (2) release
924 * references to modules.
926 unsigned cl_env_cache_purge(unsigned nr)
931 cfs_spin_lock(&cl_envs_guard);
932 for (; !cfs_list_empty(&cl_envs) && nr > 0; --nr) {
933 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
934 cfs_list_del_init(&cle->ce_linkage);
935 LASSERT(cl_envs_cached_nr > 0);
937 cfs_spin_unlock(&cl_envs_guard);
940 cfs_spin_lock(&cl_envs_guard);
942 LASSERT(equi(cl_envs_cached_nr == 0, cfs_list_empty(&cl_envs)));
943 cfs_spin_unlock(&cl_envs_guard);
946 EXPORT_SYMBOL(cl_env_cache_purge);
949 * Release an environment.
951 * Decrement \a env reference counter. When counter drops to 0, nothing in
952 * this thread is using environment and it is returned to the allocation
953 * cache, or freed straight away, if cache is large enough.
955 void cl_env_put(struct lu_env *env, int *refcheck)
959 cle = cl_env_container(env);
961 LASSERT(cle->ce_ref > 0);
962 LASSERT(ergo(refcheck != NULL, cle->ce_ref == *refcheck));
964 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
965 if (--cle->ce_ref == 0) {
968 cle->ce_debug = NULL;
971 * Don't bother to take a lock here.
973 * Return environment to the cache only when it was allocated
974 * with the standard tags.
976 if (cl_envs_cached_nr < cl_envs_cached_max &&
977 (env->le_ctx.lc_tags & ~LCT_HAS_EXIT) == LCT_CL_THREAD &&
978 (env->le_ses->lc_tags & ~LCT_HAS_EXIT) == LCT_SESSION) {
979 cfs_spin_lock(&cl_envs_guard);
980 cfs_list_add(&cle->ce_linkage, &cl_envs);
982 cfs_spin_unlock(&cl_envs_guard);
987 EXPORT_SYMBOL(cl_env_put);
990 * Declares a point of re-entrancy.
992 * \see cl_env_reexit()
994 void *cl_env_reenter(void)
996 return cl_env_detach(NULL);
998 EXPORT_SYMBOL(cl_env_reenter);
1001 * Exits re-entrancy.
1003 void cl_env_reexit(void *cookie)
1005 cl_env_detach(NULL);
1006 cl_env_attach(cookie);
1008 EXPORT_SYMBOL(cl_env_reexit);
1011 * Setup user-supplied \a env as a current environment. This is to be used to
1012 * guaranteed that environment exists even when cl_env_get() fails. It is up
1013 * to user to ensure proper concurrency control.
1015 * \see cl_env_unplant()
1017 void cl_env_implant(struct lu_env *env, int *refcheck)
1019 struct cl_env *cle = cl_env_container(env);
1021 LASSERT(cle->ce_ref > 0);
1024 cl_env_get(refcheck);
1025 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1027 EXPORT_SYMBOL(cl_env_implant);
1030 * Detach environment installed earlier by cl_env_implant().
1032 void cl_env_unplant(struct lu_env *env, int *refcheck)
1034 struct cl_env *cle = cl_env_container(env);
1036 LASSERT(cle->ce_ref > 1);
1038 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1041 cl_env_put(env, refcheck);
1043 EXPORT_SYMBOL(cl_env_unplant);
1045 struct lu_env *cl_env_nested_get(struct cl_env_nest *nest)
1049 nest->cen_cookie = NULL;
1050 env = cl_env_peek(&nest->cen_refcheck);
1052 if (!cl_io_is_going(env))
1055 cl_env_put(env, &nest->cen_refcheck);
1056 nest->cen_cookie = cl_env_reenter();
1059 env = cl_env_get(&nest->cen_refcheck);
1061 cl_env_reexit(nest->cen_cookie);
1065 LASSERT(!cl_io_is_going(env));
1068 EXPORT_SYMBOL(cl_env_nested_get);
1070 void cl_env_nested_put(struct cl_env_nest *nest, struct lu_env *env)
1072 cl_env_put(env, &nest->cen_refcheck);
1073 cl_env_reexit(nest->cen_cookie);
1075 EXPORT_SYMBOL(cl_env_nested_put);
1078 * Converts struct cl_attr to struct ost_lvb.
1082 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr)
1085 lvb->lvb_size = attr->cat_size;
1086 lvb->lvb_mtime = attr->cat_mtime;
1087 lvb->lvb_atime = attr->cat_atime;
1088 lvb->lvb_ctime = attr->cat_ctime;
1089 lvb->lvb_blocks = attr->cat_blocks;
1092 EXPORT_SYMBOL(cl_attr2lvb);
1095 * Converts struct ost_lvb to struct cl_attr.
1099 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb)
1102 attr->cat_size = lvb->lvb_size;
1103 attr->cat_mtime = lvb->lvb_mtime;
1104 attr->cat_atime = lvb->lvb_atime;
1105 attr->cat_ctime = lvb->lvb_ctime;
1106 attr->cat_blocks = lvb->lvb_blocks;
1109 EXPORT_SYMBOL(cl_lvb2attr);
1111 /*****************************************************************************
1113 * Temporary prototype thing: mirror obd-devices into cl devices.
1117 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
1118 struct lu_device_type *ldt,
1119 struct lu_device *next)
1121 const char *typename;
1122 struct lu_device *d;
1124 LASSERT(ldt != NULL);
1126 typename = ldt->ldt_name;
1127 d = ldt->ldt_ops->ldto_device_alloc(env, ldt, NULL);
1133 rc = ldt->ldt_ops->ldto_device_init(env, d, typename, next);
1136 lu_ref_add(&d->ld_reference,
1137 "lu-stack", &lu_site_init);
1139 ldt->ldt_ops->ldto_device_free(env, d);
1140 CERROR("can't init device '%s', %d\n", typename, rc);
1144 CERROR("Cannot allocate device: '%s'\n", typename);
1145 return lu2cl_dev(d);
1147 EXPORT_SYMBOL(cl_type_setup);
1150 * Finalize device stack by calling lu_stack_fini().
1152 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl)
1154 lu_stack_fini(env, cl2lu_dev(cl));
1156 EXPORT_SYMBOL(cl_stack_fini);
1158 int cl_lock_init(void);
1159 void cl_lock_fini(void);
1161 int cl_page_init(void);
1162 void cl_page_fini(void);
1164 static struct lu_context_key cl_key;
1166 struct cl_thread_info *cl_env_info(const struct lu_env *env)
1168 return lu_context_key_get(&env->le_ctx, &cl_key);
1171 /* defines cl0_key_{init,fini}() */
1172 LU_KEY_INIT_FINI(cl0, struct cl_thread_info);
1174 static void *cl_key_init(const struct lu_context *ctx,
1175 struct lu_context_key *key)
1177 struct cl_thread_info *info;
1179 info = cl0_key_init(ctx, key);
1180 if (!IS_ERR(info)) {
1183 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1184 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1189 static void cl_key_fini(const struct lu_context *ctx,
1190 struct lu_context_key *key, void *data)
1192 struct cl_thread_info *info;
1196 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1197 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1198 cl0_key_fini(ctx, key, data);
1201 static void cl_key_exit(const struct lu_context *ctx,
1202 struct lu_context_key *key, void *data)
1204 struct cl_thread_info *info = data;
1207 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i) {
1208 LASSERT(info->clt_counters[i].ctc_nr_held == 0);
1209 LASSERT(info->clt_counters[i].ctc_nr_used == 0);
1210 LASSERT(info->clt_counters[i].ctc_nr_locks_acquired == 0);
1211 LASSERT(info->clt_counters[i].ctc_nr_locks_locked == 0);
1212 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1213 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1217 static struct lu_context_key cl_key = {
1218 .lct_tags = LCT_CL_THREAD,
1219 .lct_init = cl_key_init,
1220 .lct_fini = cl_key_fini,
1221 .lct_exit = cl_key_exit
1224 static struct lu_kmem_descr cl_object_caches[] = {
1226 .ckd_cache = &cl_env_kmem,
1227 .ckd_name = "cl_env_kmem",
1228 .ckd_size = sizeof (struct cl_env)
1236 * Global initialization of cl-data. Create kmem caches, register
1237 * lu_context_key's, etc.
1239 * \see cl_global_fini()
1241 int cl_global_init(void)
1245 result = cl_env_store_init();
1249 result = lu_kmem_init(cl_object_caches);
1253 LU_CONTEXT_KEY_INIT(&cl_key);
1254 result = lu_context_key_register(&cl_key);
1258 result = cl_lock_init();
1262 result = cl_page_init();
1270 lu_context_key_degister(&cl_key);
1272 lu_kmem_fini(cl_object_caches);
1274 cl_env_store_fini();
1279 * Finalization of global cl-data. Dual to cl_global_init().
1281 void cl_global_fini(void)
1285 lu_context_key_degister(&cl_key);
1286 lu_kmem_fini(cl_object_caches);
1287 cl_env_store_fini();