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, Intel Corporation.
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 #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"
64 static cfs_mem_cache_t *cl_env_kmem;
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;
73 extern __u32 lu_context_tags_default;
74 extern __u32 lu_session_tags_default;
76 * Initialize cl_object_header.
78 int cl_object_header_init(struct cl_object_header *h)
83 result = lu_object_header_init(&h->coh_lu);
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);
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);
99 EXPORT_SYMBOL(cl_object_header_init);
102 * Finalize cl_object_header.
104 void cl_object_header_fini(struct cl_object_header *h)
106 LASSERT(cfs_list_empty(&h->coh_locks));
107 lu_object_header_fini(&h->coh_lu);
109 EXPORT_SYMBOL(cl_object_header_fini);
112 * Returns a cl_object with a given \a fid.
114 * Returns either cached or newly created object. Additional reference on the
115 * returned object is acquired.
117 * \see lu_object_find(), cl_page_find(), cl_lock_find()
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)
124 return lu2cl(lu_object_find_slice(env, cl2lu_dev(cd), fid, &c->coc_lu));
126 EXPORT_SYMBOL(cl_object_find);
129 * Releases a reference on \a o.
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.
134 * \see cl_page_put(), cl_lock_put().
136 void cl_object_put(const struct lu_env *env, struct cl_object *o)
138 lu_object_put(env, &o->co_lu);
140 EXPORT_SYMBOL(cl_object_put);
143 * Acquire an additional reference to the object \a o.
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.
148 * \see cl_page_get(), cl_lock_get().
150 void cl_object_get(struct cl_object *o)
152 lu_object_get(&o->co_lu);
154 EXPORT_SYMBOL(cl_object_get);
157 * Returns the top-object for a given \a o.
159 * \see cl_page_top(), cl_io_top()
161 struct cl_object *cl_object_top(struct cl_object *o)
163 struct cl_object_header *hdr = cl_object_header(o);
164 struct cl_object *top;
166 while (hdr->coh_parent != NULL)
167 hdr = hdr->coh_parent;
169 top = lu2cl(lu_object_top(&hdr->coh_lu));
170 CDEBUG(D_TRACE, "%p -> %p\n", o, top);
173 EXPORT_SYMBOL(cl_object_top);
176 * Returns pointer to the lock protecting data-attributes for the given object
179 * Data-attributes are protected by the cl_object_header::coh_attr_guard
180 * spin-lock in the top-object.
182 * \see cl_attr, cl_object_attr_lock(), cl_object_operations::coo_attr_get().
184 static spinlock_t *cl_object_attr_guard(struct cl_object *o)
186 return &cl_object_header(cl_object_top(o))->coh_attr_guard;
190 * Locks data-attributes.
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().
196 void cl_object_attr_lock(struct cl_object *o)
198 spin_lock(cl_object_attr_guard(o));
200 EXPORT_SYMBOL(cl_object_attr_lock);
203 * Releases data-attributes lock, acquired by cl_object_attr_lock().
205 void cl_object_attr_unlock(struct cl_object *o)
207 spin_unlock(cl_object_attr_guard(o));
209 EXPORT_SYMBOL(cl_object_attr_unlock);
212 * Returns data-attributes of an object \a obj.
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
218 int cl_object_attr_get(const struct lu_env *env, struct cl_object *obj,
219 struct cl_attr *attr)
221 struct lu_object_header *top;
224 LASSERT_SPIN_LOCKED(cl_object_attr_guard(obj));
227 top = obj->co_lu.lo_header;
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);
241 EXPORT_SYMBOL(cl_object_attr_get);
244 * Updates data-attributes of an object \a obj.
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
250 int cl_object_attr_set(const struct lu_env *env, struct cl_object *obj,
251 const struct cl_attr *attr, unsigned v)
253 struct lu_object_header *top;
256 LASSERT_SPIN_LOCKED(cl_object_attr_guard(obj));
259 top = obj->co_lu.lo_header;
261 cfs_list_for_each_entry_reverse(obj, &top->loh_layers,
263 if (obj->co_ops->coo_attr_set != NULL) {
264 result = obj->co_ops->coo_attr_set(env, obj, attr, v);
274 EXPORT_SYMBOL(cl_object_attr_set);
277 * Notifies layers (bottom-to-top) that glimpse AST was received.
279 * Layers have to fill \a lvb fields with information that will be shipped
280 * back to glimpse issuer.
282 * \see cl_lock_operations::clo_glimpse()
284 int cl_object_glimpse(const struct lu_env *env, struct cl_object *obj,
287 struct lu_object_header *top;
291 top = obj->co_lu.lo_header;
293 cfs_list_for_each_entry_reverse(obj, &top->loh_layers,
295 if (obj->co_ops->coo_glimpse != NULL) {
296 result = obj->co_ops->coo_glimpse(env, obj, lvb);
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);
308 EXPORT_SYMBOL(cl_object_glimpse);
311 * Updates a configuration of an object \a obj.
313 int cl_conf_set(const struct lu_env *env, struct cl_object *obj,
314 const struct cl_object_conf *conf)
316 struct lu_object_header *top;
320 top = obj->co_lu.lo_header;
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);
331 EXPORT_SYMBOL(cl_conf_set);
334 * Helper function removing all object locks, and marking object for
335 * deletion. All object pages must have been deleted at this point.
337 * This is called by cl_inode_fini() and lov_object_delete() to destroy top-
338 * and sub- objects respectively.
340 void cl_object_kill(const struct lu_env *env, struct cl_object *obj)
342 struct cl_object_header *hdr;
344 hdr = cl_object_header(obj);
345 LASSERT(hdr->coh_tree.rnode == NULL);
346 LASSERT(hdr->coh_pages == 0);
348 set_bit(LU_OBJECT_HEARD_BANSHEE, &hdr->coh_lu.loh_flags);
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().
356 cl_locks_prune(env, obj, 0);
358 EXPORT_SYMBOL(cl_object_kill);
361 * Prunes caches of pages and locks for this object.
363 void cl_object_prune(const struct lu_env *env, struct cl_object *obj)
366 cl_pages_prune(env, obj);
367 cl_locks_prune(env, obj, 1);
370 EXPORT_SYMBOL(cl_object_prune);
373 * Check if the object has locks.
375 int cl_object_has_locks(struct cl_object *obj)
377 struct cl_object_header *head = cl_object_header(obj);
380 spin_lock(&head->coh_lock_guard);
381 has = cfs_list_empty(&head->coh_locks);
382 spin_unlock(&head->coh_lock_guard);
386 EXPORT_SYMBOL(cl_object_has_locks);
388 void cache_stats_init(struct cache_stats *cs, const char *name)
393 for (i = 0; i < CS_NR; i++)
394 cfs_atomic_set(&cs->cs_stats[i], 0);
397 int cache_stats_print(const struct cache_stats *cs,
398 char *page, int count, int h)
403 * lookup hit total cached create
404 * env: ...... ...... ...... ...... ......
407 const char *names[CS_NR] = CS_NAMES;
409 nob += snprintf(page + nob, count - nob, "%6s", " ");
410 for (i = 0; i < CS_NR; i++)
411 nob += snprintf(page + nob, count - nob,
413 nob += snprintf(page + nob, count - nob, "\n");
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]));
424 * Initialize client site.
426 * Perform common initialization (lu_site_init()), and initialize statistical
427 * counters. Also perform global initializations on the first call.
429 int cl_site_init(struct cl_site *s, struct cl_device *d)
434 result = lu_site_init(&s->cs_lu, &d->cd_lu_dev);
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);
445 EXPORT_SYMBOL(cl_site_init);
448 * Finalize client site. Dual to cl_site_init().
450 void cl_site_fini(struct cl_site *s)
452 lu_site_fini(&s->cs_lu);
454 EXPORT_SYMBOL(cl_site_fini);
456 static struct cache_stats cl_env_stats = {
458 .cs_stats = { CFS_ATOMIC_INIT(0), }
462 * Outputs client site statistical counters into a buffer. Suitable for
463 * ll_rd_*()-style functions.
465 int cl_site_stats_print(const struct cl_site *site, char *page, int count)
469 static const char *pstate[] = {
476 static const char *lstate[] = {
479 [CLS_ENQUEUED] = "e",
481 [CLS_INTRANSIT] = "t",
486 lookup hit total busy create
487 pages: ...... ...... ...... ...... ...... [...... ...... ...... ......]
488 locks: ...... ...... ...... ...... ...... [...... ...... ...... ...... ......]
489 env: ...... ...... ...... ...... ......
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 ",
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 ",
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");
510 EXPORT_SYMBOL(cl_site_stats_print);
512 /*****************************************************************************
514 * lu_env handling on client.
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.
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
532 * If there's no space in task_struct is available, hash will be used.
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
540 static DEFINE_SPINLOCK(cl_envs_guard);
545 struct lu_context ce_ses;
547 #ifdef LL_TASK_CL_ENV
551 * This allows cl_env to be entered into cl_env_hash which implements
552 * the current thread -> client environment lookup.
554 cfs_hlist_node_t ce_node;
557 * Owner for the current cl_env.
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
570 * Linkage into global list of all client environments. Used for
571 * garbage collection.
573 cfs_list_t ce_linkage;
579 * Debugging field: address of the caller who made original
585 #ifdef CONFIG_DEBUG_PAGESTATE_TRACKING
586 #define CL_ENV_INC(counter) cfs_atomic_inc(&cl_env_stats.cs_stats[CS_##counter])
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]); \
593 #define CL_ENV_INC(counter)
594 #define CL_ENV_DEC(counter)
597 static void cl_env_init0(struct cl_env *cle, void *debug)
599 LASSERT(cle->ce_ref == 0);
600 LASSERT(cle->ce_magic == &cl_env_init0);
601 LASSERT(cle->ce_debug == NULL && cle->ce_owner == NULL);
604 cle->ce_debug = debug;
609 #ifndef LL_TASK_CL_ENV
611 * The implementation of using hash table to connect cl_env and thread
614 static cfs_hash_t *cl_env_hash;
616 static unsigned cl_env_hops_hash(cfs_hash_t *lh,
617 const void *key, unsigned mask)
619 #if BITS_PER_LONG == 64
620 return cfs_hash_u64_hash((__u64)key, mask);
622 return cfs_hash_u32_hash((__u32)key, mask);
626 static void *cl_env_hops_obj(cfs_hlist_node_t *hn)
628 struct cl_env *cle = cfs_hlist_entry(hn, struct cl_env, ce_node);
629 LASSERT(cle->ce_magic == &cl_env_init0);
633 static int cl_env_hops_keycmp(const void *key, cfs_hlist_node_t *hn)
635 struct cl_env *cle = cl_env_hops_obj(hn);
637 LASSERT(cle->ce_owner != NULL);
638 return (key == cle->ce_owner);
641 static void cl_env_hops_noop(cfs_hash_t *hs, cfs_hlist_node_t *hn)
643 struct cl_env *cle = cfs_hlist_entry(hn, struct cl_env, ce_node);
644 LASSERT(cle->ce_magic == &cl_env_init0);
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,
656 static inline struct cl_env *cl_env_fetch(void)
660 cle = cfs_hash_lookup(cl_env_hash, (void *) (long) cfs_current()->pid);
661 LASSERT(ergo(cle, cle->ce_magic == &cl_env_init0));
665 static inline void cl_env_attach(struct cl_env *cle)
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,
678 static inline void cl_env_do_detach(struct cl_env *cle)
682 LASSERT(cle->ce_owner == (void *) (long) cfs_current()->pid);
683 cookie = cfs_hash_del(cl_env_hash, cle->ce_owner,
685 LASSERT(cookie == cle);
686 cle->ce_owner = NULL;
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,
696 CFS_HASH_RW_BKTLOCK);
697 return cl_env_hash != NULL ? 0 :-ENOMEM;
700 static void cl_env_store_fini(void) {
701 cfs_hash_putref(cl_env_hash);
704 #else /* LL_TASK_CL_ENV */
706 * The implementation of store cl_env directly in thread structure.
709 static inline struct cl_env *cl_env_fetch(void)
713 cle = cfs_current()->LL_TASK_CL_ENV;
714 if (cle && cle->ce_magic != &cl_env_init0)
719 static inline void cl_env_attach(struct cl_env *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;
729 static inline void cl_env_do_detach(struct cl_env *cle)
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;
737 static int cl_env_store_init(void) { return 0; }
738 static void cl_env_store_fini(void) { }
740 #endif /* LL_TASK_CL_ENV */
742 static inline struct cl_env *cl_env_detach(struct cl_env *cle)
745 cle = cl_env_fetch();
747 if (cle && cle->ce_owner)
748 cl_env_do_detach(cle);
753 static struct lu_env *cl_env_new(__u32 ctx_tags, __u32 ses_tags, void *debug)
758 OBD_SLAB_ALLOC_PTR_GFP(cle, cl_env_kmem, CFS_ALLOC_IO);
762 CFS_INIT_LIST_HEAD(&cle->ce_linkage);
763 cle->ce_magic = &cl_env_init0;
765 rc = lu_env_init(env, LCT_CL_THREAD|ctx_tags);
767 rc = lu_context_init(&cle->ce_ses,
768 LCT_SESSION | ses_tags);
770 lu_context_enter(&cle->ce_ses);
771 env->le_ses = &cle->ce_ses;
772 cl_env_init0(cle, debug);
777 OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
784 env = ERR_PTR(-ENOMEM);
788 static void cl_env_fini(struct cl_env *cle)
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);
796 static struct lu_env *cl_env_obtain(void *debug)
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) {
807 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
808 cfs_list_del_init(&cle->ce_linkage);
810 spin_unlock(&cl_envs_guard);
813 rc = lu_env_refill(env);
815 cl_env_init0(cle, debug);
816 lu_context_enter(&env->le_ctx);
817 lu_context_enter(&cle->ce_ses);
823 spin_unlock(&cl_envs_guard);
824 env = cl_env_new(lu_context_tags_default,
825 lu_session_tags_default, debug);
830 static inline struct cl_env *cl_env_container(struct lu_env *env)
832 return container_of(env, struct cl_env, ce_lu);
835 struct lu_env *cl_env_peek(int *refcheck)
842 /* check that we don't go far from untrusted pointer */
843 CLASSERT(offsetof(struct cl_env, ce_magic) == 0);
846 cle = cl_env_fetch();
850 *refcheck = ++cle->ce_ref;
852 CDEBUG(D_OTHER, "%d@%p\n", cle ? cle->ce_ref : 0, cle);
855 EXPORT_SYMBOL(cl_env_peek);
858 * Returns lu_env: if there already is an environment associated with the
859 * current thread, it is returned, otherwise, new environment is allocated.
861 * Allocations are amortized through the global cache of environments.
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().
870 struct lu_env *cl_env_get(int *refcheck)
874 env = cl_env_peek(refcheck);
876 env = cl_env_obtain(__builtin_return_address(0));
880 cle = cl_env_container(env);
882 *refcheck = cle->ce_ref;
883 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
888 EXPORT_SYMBOL(cl_env_get);
891 * Forces an allocation of a fresh environment with given tags.
895 struct lu_env *cl_env_alloc(int *refcheck, __u32 tags)
899 LASSERT(cl_env_peek(refcheck) == NULL);
900 env = cl_env_new(tags, tags, __builtin_return_address(0));
904 cle = cl_env_container(env);
905 *refcheck = cle->ce_ref;
906 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
910 EXPORT_SYMBOL(cl_env_alloc);
912 static void cl_env_exit(struct cl_env *cle)
914 LASSERT(cle->ce_owner == NULL);
915 lu_context_exit(&cle->ce_lu.le_ctx);
916 lu_context_exit(&cle->ce_ses);
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.
924 unsigned cl_env_cache_purge(unsigned nr)
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);
935 spin_unlock(&cl_envs_guard);
938 spin_lock(&cl_envs_guard);
940 LASSERT(equi(cl_envs_cached_nr == 0, cfs_list_empty(&cl_envs)));
941 spin_unlock(&cl_envs_guard);
944 EXPORT_SYMBOL(cl_env_cache_purge);
947 * Release an environment.
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.
953 void cl_env_put(struct lu_env *env, int *refcheck)
957 cle = cl_env_container(env);
959 LASSERT(cle->ce_ref > 0);
960 LASSERT(ergo(refcheck != NULL, cle->ce_ref == *refcheck));
962 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
963 if (--cle->ce_ref == 0) {
966 cle->ce_debug = NULL;
969 * Don't bother to take a lock here.
971 * Return environment to the cache only when it was allocated
972 * with the standard tags.
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);
980 spin_unlock(&cl_envs_guard);
985 EXPORT_SYMBOL(cl_env_put);
988 * Declares a point of re-entrancy.
990 * \see cl_env_reexit()
992 void *cl_env_reenter(void)
994 return cl_env_detach(NULL);
996 EXPORT_SYMBOL(cl_env_reenter);
1001 void cl_env_reexit(void *cookie)
1003 cl_env_detach(NULL);
1004 cl_env_attach(cookie);
1006 EXPORT_SYMBOL(cl_env_reexit);
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.
1013 * \see cl_env_unplant()
1015 void cl_env_implant(struct lu_env *env, int *refcheck)
1017 struct cl_env *cle = cl_env_container(env);
1019 LASSERT(cle->ce_ref > 0);
1022 cl_env_get(refcheck);
1023 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1025 EXPORT_SYMBOL(cl_env_implant);
1028 * Detach environment installed earlier by cl_env_implant().
1030 void cl_env_unplant(struct lu_env *env, int *refcheck)
1032 struct cl_env *cle = cl_env_container(env);
1034 LASSERT(cle->ce_ref > 1);
1036 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1039 cl_env_put(env, refcheck);
1041 EXPORT_SYMBOL(cl_env_unplant);
1043 struct lu_env *cl_env_nested_get(struct cl_env_nest *nest)
1047 nest->cen_cookie = NULL;
1048 env = cl_env_peek(&nest->cen_refcheck);
1050 if (!cl_io_is_going(env))
1053 cl_env_put(env, &nest->cen_refcheck);
1054 nest->cen_cookie = cl_env_reenter();
1057 env = cl_env_get(&nest->cen_refcheck);
1059 cl_env_reexit(nest->cen_cookie);
1063 LASSERT(!cl_io_is_going(env));
1066 EXPORT_SYMBOL(cl_env_nested_get);
1068 void cl_env_nested_put(struct cl_env_nest *nest, struct lu_env *env)
1070 cl_env_put(env, &nest->cen_refcheck);
1071 cl_env_reexit(nest->cen_cookie);
1073 EXPORT_SYMBOL(cl_env_nested_put);
1076 * Converts struct cl_attr to struct ost_lvb.
1080 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr)
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;
1090 EXPORT_SYMBOL(cl_attr2lvb);
1093 * Converts struct ost_lvb to struct cl_attr.
1097 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb)
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;
1107 EXPORT_SYMBOL(cl_lvb2attr);
1109 /*****************************************************************************
1111 * Temporary prototype thing: mirror obd-devices into cl devices.
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)
1119 const char *typename;
1120 struct lu_device *d;
1122 LASSERT(ldt != NULL);
1124 typename = ldt->ldt_name;
1125 d = ldt->ldt_ops->ldto_device_alloc(env, ldt, NULL);
1131 rc = ldt->ldt_ops->ldto_device_init(env, d, typename, next);
1134 lu_ref_add(&d->ld_reference,
1135 "lu-stack", &lu_site_init);
1137 ldt->ldt_ops->ldto_device_free(env, d);
1138 CERROR("can't init device '%s', %d\n", typename, rc);
1142 CERROR("Cannot allocate device: '%s'\n", typename);
1143 return lu2cl_dev(d);
1145 EXPORT_SYMBOL(cl_type_setup);
1148 * Finalize device stack by calling lu_stack_fini().
1150 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl)
1152 lu_stack_fini(env, cl2lu_dev(cl));
1154 EXPORT_SYMBOL(cl_stack_fini);
1156 int cl_lock_init(void);
1157 void cl_lock_fini(void);
1159 int cl_page_init(void);
1160 void cl_page_fini(void);
1162 static struct lu_context_key cl_key;
1164 struct cl_thread_info *cl_env_info(const struct lu_env *env)
1166 return lu_context_key_get(&env->le_ctx, &cl_key);
1169 /* defines cl0_key_{init,fini}() */
1170 LU_KEY_INIT_FINI(cl0, struct cl_thread_info);
1172 static void *cl_key_init(const struct lu_context *ctx,
1173 struct lu_context_key *key)
1175 struct cl_thread_info *info;
1177 info = cl0_key_init(ctx, key);
1178 if (!IS_ERR(info)) {
1181 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1182 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1187 static void cl_key_fini(const struct lu_context *ctx,
1188 struct lu_context_key *key, void *data)
1190 struct cl_thread_info *info;
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);
1199 static void cl_key_exit(const struct lu_context *ctx,
1200 struct lu_context_key *key, void *data)
1202 struct cl_thread_info *info = data;
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);
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
1222 static struct lu_kmem_descr cl_object_caches[] = {
1224 .ckd_cache = &cl_env_kmem,
1225 .ckd_name = "cl_env_kmem",
1226 .ckd_size = sizeof (struct cl_env)
1234 * Global initialization of cl-data. Create kmem caches, register
1235 * lu_context_key's, etc.
1237 * \see cl_global_fini()
1239 int cl_global_init(void)
1243 result = cl_env_store_init();
1247 result = lu_kmem_init(cl_object_caches);
1251 LU_CONTEXT_KEY_INIT(&cl_key);
1252 result = lu_context_key_register(&cl_key);
1256 result = cl_lock_init();
1260 result = cl_page_init();
1268 lu_context_key_degister(&cl_key);
1270 lu_kmem_fini(cl_object_caches);
1272 cl_env_store_fini();
1277 * Finalization of global cl-data. Dual to cl_global_init().
1279 void cl_global_fini(void)
1283 lu_context_key_degister(&cl_key);
1284 lu_kmem_fini(cl_object_caches);
1285 cl_env_store_fini();