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, 2015, 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>
39 * Author: Jinshan Xiong <jinshan.xiong@intel.com>
51 #define DEBUG_SUBSYSTEM S_CLASS
53 #include <libcfs/libcfs.h>
54 /* class_put_type() */
55 #include <obd_class.h>
56 #include <obd_support.h>
57 #include <lustre_fid.h>
58 #include <libcfs/list.h>
59 #include <libcfs/libcfs_hash.h> /* for cfs_hash stuff */
60 #include <cl_object.h>
61 #include <lu_object.h>
62 #include "cl_internal.h"
64 static struct kmem_cache *cl_env_kmem;
66 /** Lock class of cl_object_header::coh_attr_guard */
67 static struct lock_class_key cl_attr_guard_class;
70 * Initialize cl_object_header.
72 int cl_object_header_init(struct cl_object_header *h)
77 result = lu_object_header_init(&h->coh_lu);
79 spin_lock_init(&h->coh_attr_guard);
80 lockdep_set_class(&h->coh_attr_guard, &cl_attr_guard_class);
81 h->coh_page_bufsize = 0;
85 EXPORT_SYMBOL(cl_object_header_init);
88 * Finalize cl_object_header.
90 void cl_object_header_fini(struct cl_object_header *h)
92 lu_object_header_fini(&h->coh_lu);
96 * Returns a cl_object with a given \a fid.
98 * Returns either cached or newly created object. Additional reference on the
99 * returned object is acquired.
101 * \see lu_object_find(), cl_page_find(), cl_lock_find()
103 struct cl_object *cl_object_find(const struct lu_env *env,
104 struct cl_device *cd, const struct lu_fid *fid,
105 const struct cl_object_conf *c)
108 return lu2cl(lu_object_find_slice(env, cl2lu_dev(cd), fid, &c->coc_lu));
110 EXPORT_SYMBOL(cl_object_find);
113 * Releases a reference on \a o.
115 * When last reference is released object is returned to the cache, unless
116 * lu_object_header_flags::LU_OBJECT_HEARD_BANSHEE bit is set in its header.
118 * \see cl_page_put(), cl_lock_put().
120 void cl_object_put(const struct lu_env *env, struct cl_object *o)
122 lu_object_put(env, &o->co_lu);
124 EXPORT_SYMBOL(cl_object_put);
127 * Acquire an additional reference to the object \a o.
129 * This can only be used to acquire _additional_ reference, i.e., caller
130 * already has to possess at least one reference to \a o before calling this.
132 * \see cl_page_get(), cl_lock_get().
134 void cl_object_get(struct cl_object *o)
136 lu_object_get(&o->co_lu);
138 EXPORT_SYMBOL(cl_object_get);
141 * Returns the top-object for a given \a o.
145 struct cl_object *cl_object_top(struct cl_object *o)
147 struct cl_object_header *hdr = cl_object_header(o);
148 struct cl_object *top;
150 while (hdr->coh_parent != NULL)
151 hdr = hdr->coh_parent;
153 top = lu2cl(lu_object_top(&hdr->coh_lu));
154 CDEBUG(D_TRACE, "%p -> %p\n", o, top);
157 EXPORT_SYMBOL(cl_object_top);
160 * Returns pointer to the lock protecting data-attributes for the given object
163 * Data-attributes are protected by the cl_object_header::coh_attr_guard
164 * spin-lock in the top-object.
166 * \see cl_attr, cl_object_attr_lock(), cl_object_operations::coo_attr_get().
168 static spinlock_t *cl_object_attr_guard(struct cl_object *o)
170 return &cl_object_header(cl_object_top(o))->coh_attr_guard;
174 * Locks data-attributes.
176 * Prevents data-attributes from changing, until lock is released by
177 * cl_object_attr_unlock(). This has to be called before calls to
178 * cl_object_attr_get(), cl_object_attr_update().
180 void cl_object_attr_lock(struct cl_object *o)
181 __acquires(cl_object_attr_guard(o))
183 spin_lock(cl_object_attr_guard(o));
185 EXPORT_SYMBOL(cl_object_attr_lock);
188 * Releases data-attributes lock, acquired by cl_object_attr_lock().
190 void cl_object_attr_unlock(struct cl_object *o)
191 __releases(cl_object_attr_guard(o))
193 spin_unlock(cl_object_attr_guard(o));
195 EXPORT_SYMBOL(cl_object_attr_unlock);
198 * Returns data-attributes of an object \a obj.
200 * Every layer is asked (by calling cl_object_operations::coo_attr_get())
201 * top-to-bottom to fill in parts of \a attr that this layer is responsible
204 int cl_object_attr_get(const struct lu_env *env, struct cl_object *obj,
205 struct cl_attr *attr)
207 struct lu_object_header *top;
210 assert_spin_locked(cl_object_attr_guard(obj));
213 top = obj->co_lu.lo_header;
215 list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
216 if (obj->co_ops->coo_attr_get != NULL) {
217 result = obj->co_ops->coo_attr_get(env, obj, attr);
227 EXPORT_SYMBOL(cl_object_attr_get);
230 * Updates data-attributes of an object \a obj.
232 * Only attributes, mentioned in a validness bit-mask \a v are
233 * updated. Calls cl_object_operations::coo_upd_attr() on every layer, bottom
236 int cl_object_attr_update(const struct lu_env *env, struct cl_object *obj,
237 const struct cl_attr *attr, unsigned v)
239 struct lu_object_header *top;
242 assert_spin_locked(cl_object_attr_guard(obj));
245 top = obj->co_lu.lo_header;
247 list_for_each_entry_reverse(obj, &top->loh_layers, co_lu.lo_linkage) {
248 if (obj->co_ops->coo_attr_update != NULL) {
249 result = obj->co_ops->coo_attr_update(env, obj, attr,
260 EXPORT_SYMBOL(cl_object_attr_update);
263 * Notifies layers (bottom-to-top) that glimpse AST was received.
265 * Layers have to fill \a lvb fields with information that will be shipped
266 * back to glimpse issuer.
268 * \see cl_lock_operations::clo_glimpse()
270 int cl_object_glimpse(const struct lu_env *env, struct cl_object *obj,
273 struct lu_object_header *top;
277 top = obj->co_lu.lo_header;
279 list_for_each_entry_reverse(obj, &top->loh_layers, co_lu.lo_linkage) {
280 if (obj->co_ops->coo_glimpse != NULL) {
281 result = obj->co_ops->coo_glimpse(env, obj, lvb);
286 LU_OBJECT_HEADER(D_DLMTRACE, env, lu_object_top(top),
287 "size: "LPU64" mtime: "LPU64" atime: "LPU64" "
288 "ctime: "LPU64" blocks: "LPU64"\n",
289 lvb->lvb_size, lvb->lvb_mtime, lvb->lvb_atime,
290 lvb->lvb_ctime, lvb->lvb_blocks);
293 EXPORT_SYMBOL(cl_object_glimpse);
296 * Updates a configuration of an object \a obj.
298 int cl_conf_set(const struct lu_env *env, struct cl_object *obj,
299 const struct cl_object_conf *conf)
301 struct lu_object_header *top;
305 top = obj->co_lu.lo_header;
307 list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
308 if (obj->co_ops->coo_conf_set != NULL) {
309 result = obj->co_ops->coo_conf_set(env, obj, conf);
316 EXPORT_SYMBOL(cl_conf_set);
319 * Prunes caches of pages and locks for this object.
321 int cl_object_prune(const struct lu_env *env, struct cl_object *obj)
323 struct lu_object_header *top;
328 top = obj->co_lu.lo_header;
330 list_for_each_entry(o, &top->loh_layers, co_lu.lo_linkage) {
331 if (o->co_ops->coo_prune != NULL) {
332 result = o->co_ops->coo_prune(env, o);
340 EXPORT_SYMBOL(cl_object_prune);
343 * Get stripe information of this object.
345 int cl_object_getstripe(const struct lu_env *env, struct cl_object *obj,
346 struct lov_user_md __user *uarg)
348 struct lu_object_header *top;
352 top = obj->co_lu.lo_header;
353 list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
354 if (obj->co_ops->coo_getstripe != NULL) {
355 result = obj->co_ops->coo_getstripe(env, obj, uarg);
362 EXPORT_SYMBOL(cl_object_getstripe);
365 * Get fiemap extents from file object.
367 * \param env [in] lustre environment
368 * \param obj [in] file object
369 * \param key [in] fiemap request argument
370 * \param fiemap [out] fiemap extents mapping retrived
371 * \param buflen [in] max buffer length of @fiemap
376 int cl_object_fiemap(const struct lu_env *env, struct cl_object *obj,
377 struct ll_fiemap_info_key *key,
378 struct fiemap *fiemap, size_t *buflen)
380 struct lu_object_header *top;
384 top = obj->co_lu.lo_header;
385 list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
386 if (obj->co_ops->coo_fiemap != NULL) {
387 result = obj->co_ops->coo_fiemap(env, obj, key, fiemap,
395 EXPORT_SYMBOL(cl_object_fiemap);
397 int cl_object_layout_get(const struct lu_env *env, struct cl_object *obj,
398 struct cl_layout *cl)
400 struct lu_object_header *top = obj->co_lu.lo_header;
403 list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
404 if (obj->co_ops->coo_layout_get != NULL)
405 return obj->co_ops->coo_layout_get(env, obj, cl);
410 EXPORT_SYMBOL(cl_object_layout_get);
412 loff_t cl_object_maxbytes(struct cl_object *obj)
414 struct lu_object_header *top = obj->co_lu.lo_header;
415 loff_t maxbytes = LLONG_MAX;
418 list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
419 if (obj->co_ops->coo_maxbytes != NULL)
420 maxbytes = min_t(loff_t, obj->co_ops->coo_maxbytes(obj),
426 EXPORT_SYMBOL(cl_object_maxbytes);
429 * Helper function removing all object locks, and marking object for
430 * deletion. All object pages must have been deleted at this point.
432 * This is called by cl_inode_fini() and lov_object_delete() to destroy top-
433 * and sub- objects respectively.
435 void cl_object_kill(const struct lu_env *env, struct cl_object *obj)
437 struct cl_object_header *hdr = cl_object_header(obj);
439 set_bit(LU_OBJECT_HEARD_BANSHEE, &hdr->coh_lu.loh_flags);
441 EXPORT_SYMBOL(cl_object_kill);
443 void cache_stats_init(struct cache_stats *cs, const char *name)
448 for (i = 0; i < CS_NR; i++)
449 atomic_set(&cs->cs_stats[i], 0);
452 static int cache_stats_print(const struct cache_stats *cs,
453 struct seq_file *m, int h)
458 * lookup hit total cached create
459 * env: ...... ...... ...... ...... ......
462 const char *names[CS_NR] = CS_NAMES;
464 seq_printf(m, "%6s", " ");
465 for (i = 0; i < CS_NR; i++)
466 seq_printf(m, "%8s", names[i]);
470 seq_printf(m, "%5.5s:", cs->cs_name);
471 for (i = 0; i < CS_NR; i++)
472 seq_printf(m, "%8u", atomic_read(&cs->cs_stats[i]));
476 static void cl_env_percpu_refill(void);
479 * Initialize client site.
481 * Perform common initialization (lu_site_init()), and initialize statistical
482 * counters. Also perform global initializations on the first call.
484 int cl_site_init(struct cl_site *s, struct cl_device *d)
489 result = lu_site_init(&s->cs_lu, &d->cd_lu_dev);
491 cache_stats_init(&s->cs_pages, "pages");
492 for (i = 0; i < ARRAY_SIZE(s->cs_pages_state); ++i)
493 atomic_set(&s->cs_pages_state[0], 0);
494 cl_env_percpu_refill();
498 EXPORT_SYMBOL(cl_site_init);
501 * Finalize client site. Dual to cl_site_init().
503 void cl_site_fini(struct cl_site *s)
505 lu_site_fini(&s->cs_lu);
507 EXPORT_SYMBOL(cl_site_fini);
509 static struct cache_stats cl_env_stats = {
511 .cs_stats = { ATOMIC_INIT(0), }
515 * Outputs client site statistical counters into a buffer. Suitable for
516 * ll_rd_*()-style functions.
518 int cl_site_stats_print(const struct cl_site *site, struct seq_file *m)
520 static const char *pstate[] = {
530 lookup hit total busy create
531 pages: ...... ...... ...... ...... ...... [...... ...... ...... ......]
532 locks: ...... ...... ...... ...... ...... [...... ...... ...... ...... ......]
533 env: ...... ...... ...... ...... ......
535 lu_site_stats_seq_print(&site->cs_lu, m);
536 cache_stats_print(&site->cs_pages, m, 1);
538 for (i = 0; i < ARRAY_SIZE(site->cs_pages_state); ++i)
539 seq_printf(m, "%s: %u ", pstate[i],
540 atomic_read(&site->cs_pages_state[i]));
541 seq_printf(m, "]\n");
542 cache_stats_print(&cl_env_stats, m, 0);
546 EXPORT_SYMBOL(cl_site_stats_print);
548 /*****************************************************************************
550 * lu_env handling on client.
555 * The most efficient way is to store cl_env pointer in task specific
556 * structures. On Linux, it wont' be easy to use task_struct->journal_info
557 * because Lustre code may call into other fs which has certain assumptions
558 * about journal_info. Currently following fields in task_struct are identified
559 * can be used for this purpose:
560 * - cl_env: for liblustre.
561 * - tux_info: ony on RedHat kernel.
563 * \note As long as we use task_struct to store cl_env, we assume that once
564 * called into Lustre, we'll never call into the other part of the kernel
565 * which will use those fields in task_struct without explicitly exiting
568 * If there's no space in task_struct is available, hash will be used.
572 static struct list_head cl_envs;
573 static unsigned cl_envs_cached_nr = 0;
574 static unsigned cl_envs_cached_max = 128; /* XXX: prototype: arbitrary limit
576 static DEFINE_SPINLOCK(cl_envs_guard);
581 struct lu_context ce_ses;
583 #ifdef LL_TASK_CL_ENV
587 * This allows cl_env to be entered into cl_env_hash which implements
588 * the current thread -> client environment lookup.
590 struct hlist_node ce_node;
593 * Owner for the current cl_env.
595 * If LL_TASK_CL_ENV is defined, this point to the owning current,
596 * only for debugging purpose ;
597 * Otherwise hash is used, and this is the key for cfs_hash.
598 * Now current thread pid is stored. Note using thread pointer would
599 * lead to unbalanced hash because of its specific allocation locality
600 * and could be varied for different platforms and OSes, even different
606 * Linkage into global list of all client environments. Used for
607 * garbage collection.
609 struct list_head ce_linkage;
615 * Debugging field: address of the caller who made original
621 #ifdef CONFIG_DEBUG_PAGESTATE_TRACKING
622 #define CL_ENV_INC(counter) atomic_inc(&cl_env_stats.cs_stats[CS_##counter])
624 #define CL_ENV_DEC(counter) do { \
625 LASSERT(atomic_read(&cl_env_stats.cs_stats[CS_##counter]) > 0); \
626 atomic_dec(&cl_env_stats.cs_stats[CS_##counter]); \
629 #define CL_ENV_INC(counter)
630 #define CL_ENV_DEC(counter)
633 static void cl_env_init0(struct cl_env *cle, void *debug)
635 LASSERT(cle->ce_ref == 0);
636 LASSERT(cle->ce_magic == &cl_env_init0);
637 LASSERT(cle->ce_debug == NULL && cle->ce_owner == NULL);
640 cle->ce_debug = debug;
645 #ifndef LL_TASK_CL_ENV
647 * The implementation of using hash table to connect cl_env and thread
650 static struct cfs_hash *cl_env_hash;
652 static unsigned cl_env_hops_hash(struct cfs_hash *lh,
653 const void *key, unsigned mask)
655 #if BITS_PER_LONG == 64
656 return cfs_hash_u64_hash((__u64)key, mask);
658 return cfs_hash_u32_hash((__u32)key, mask);
662 static void *cl_env_hops_obj(struct hlist_node *hn)
664 struct cl_env *cle = hlist_entry(hn, struct cl_env, ce_node);
666 LASSERT(cle->ce_magic == &cl_env_init0);
670 static int cl_env_hops_keycmp(const void *key, struct hlist_node *hn)
672 struct cl_env *cle = cl_env_hops_obj(hn);
674 LASSERT(cle->ce_owner != NULL);
675 return (key == cle->ce_owner);
678 static void cl_env_hops_noop(struct cfs_hash *hs, struct hlist_node *hn)
680 struct cl_env *cle = hlist_entry(hn, struct cl_env, ce_node);
681 LASSERT(cle->ce_magic == &cl_env_init0);
684 static struct cfs_hash_ops cl_env_hops = {
685 .hs_hash = cl_env_hops_hash,
686 .hs_key = cl_env_hops_obj,
687 .hs_keycmp = cl_env_hops_keycmp,
688 .hs_object = cl_env_hops_obj,
689 .hs_get = cl_env_hops_noop,
690 .hs_put_locked = cl_env_hops_noop,
693 static inline struct cl_env *cl_env_fetch(void)
697 cle = cfs_hash_lookup(cl_env_hash, (void *) (long) current->pid);
698 LASSERT(ergo(cle, cle->ce_magic == &cl_env_init0));
702 static inline void cl_env_attach(struct cl_env *cle)
707 LASSERT(cle->ce_owner == NULL);
708 cle->ce_owner = (void *) (long) current->pid;
709 rc = cfs_hash_add_unique(cl_env_hash, cle->ce_owner,
715 static inline void cl_env_do_detach(struct cl_env *cle)
719 LASSERT(cle->ce_owner == (void *) (long) current->pid);
720 cookie = cfs_hash_del(cl_env_hash, cle->ce_owner,
722 LASSERT(cookie == cle);
723 cle->ce_owner = NULL;
726 static int cl_env_store_init(void) {
727 cl_env_hash = cfs_hash_create("cl_env",
728 HASH_CL_ENV_BITS, HASH_CL_ENV_BITS,
729 HASH_CL_ENV_BKT_BITS, 0,
733 CFS_HASH_RW_BKTLOCK);
734 return cl_env_hash != NULL ? 0 :-ENOMEM;
737 static void cl_env_store_fini(void) {
738 cfs_hash_putref(cl_env_hash);
741 #else /* LL_TASK_CL_ENV */
743 * The implementation of store cl_env directly in thread structure.
746 static inline struct cl_env *cl_env_fetch(void)
750 cle = current->LL_TASK_CL_ENV;
751 if (cle && cle->ce_magic != &cl_env_init0)
756 static inline void cl_env_attach(struct cl_env *cle)
759 LASSERT(cle->ce_owner == NULL);
760 cle->ce_owner = current;
761 cle->ce_prev = current->LL_TASK_CL_ENV;
762 current->LL_TASK_CL_ENV = cle;
766 static inline void cl_env_do_detach(struct cl_env *cle)
768 LASSERT(cle->ce_owner == current);
769 LASSERT(current->LL_TASK_CL_ENV == cle);
770 current->LL_TASK_CL_ENV = cle->ce_prev;
771 cle->ce_owner = NULL;
774 static int cl_env_store_init(void) { return 0; }
775 static void cl_env_store_fini(void) { }
777 #endif /* LL_TASK_CL_ENV */
779 static inline struct cl_env *cl_env_detach(struct cl_env *cle)
782 cle = cl_env_fetch();
784 if (cle && cle->ce_owner)
785 cl_env_do_detach(cle);
790 static struct lu_env *cl_env_new(__u32 ctx_tags, __u32 ses_tags, void *debug)
795 OBD_SLAB_ALLOC_PTR_GFP(cle, cl_env_kmem, GFP_NOFS);
799 INIT_LIST_HEAD(&cle->ce_linkage);
800 cle->ce_magic = &cl_env_init0;
802 rc = lu_env_init(env, LCT_CL_THREAD|ctx_tags);
804 rc = lu_context_init(&cle->ce_ses,
805 LCT_SESSION | ses_tags);
807 lu_context_enter(&cle->ce_ses);
808 env->le_ses = &cle->ce_ses;
809 cl_env_init0(cle, debug);
814 OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
821 env = ERR_PTR(-ENOMEM);
825 static void cl_env_fini(struct cl_env *cle)
828 lu_context_fini(&cle->ce_lu.le_ctx);
829 lu_context_fini(&cle->ce_ses);
830 OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
833 static struct lu_env *cl_env_obtain(void *debug)
839 spin_lock(&cl_envs_guard);
840 LASSERT(equi(cl_envs_cached_nr == 0, list_empty(&cl_envs)));
841 if (cl_envs_cached_nr > 0) {
844 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
845 list_del_init(&cle->ce_linkage);
847 spin_unlock(&cl_envs_guard);
850 rc = lu_env_refill(env);
852 cl_env_init0(cle, debug);
853 lu_context_enter(&env->le_ctx);
854 lu_context_enter(&cle->ce_ses);
860 spin_unlock(&cl_envs_guard);
861 env = cl_env_new(lu_context_tags_default,
862 lu_session_tags_default, debug);
867 static inline struct cl_env *cl_env_container(struct lu_env *env)
869 return container_of(env, struct cl_env, ce_lu);
872 struct lu_env *cl_env_peek(__u16 *refcheck)
879 /* check that we don't go far from untrusted pointer */
880 CLASSERT(offsetof(struct cl_env, ce_magic) == 0);
883 cle = cl_env_fetch();
887 *refcheck = ++cle->ce_ref;
889 CDEBUG(D_OTHER, "%d@%p\n", cle ? cle->ce_ref : 0, cle);
894 * Returns lu_env: if there already is an environment associated with the
895 * current thread, it is returned, otherwise, new environment is allocated.
897 * Allocations are amortized through the global cache of environments.
899 * \param refcheck pointer to a counter used to detect environment leaks. In
900 * the usual case cl_env_get() and cl_env_put() are called in the same lexical
901 * scope and pointer to the same integer is passed as \a refcheck. This is
902 * used to detect missed cl_env_put().
906 struct lu_env *cl_env_get(__u16 *refcheck)
910 env = cl_env_peek(refcheck);
912 env = cl_env_obtain(__builtin_return_address(0));
916 cle = cl_env_container(env);
918 *refcheck = cle->ce_ref;
919 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
924 EXPORT_SYMBOL(cl_env_get);
927 * Forces an allocation of a fresh environment with given tags.
931 struct lu_env *cl_env_alloc(__u16 *refcheck, __u32 tags)
935 LASSERT(cl_env_peek(refcheck) == NULL);
936 env = cl_env_new(tags, tags, __builtin_return_address(0));
940 cle = cl_env_container(env);
941 *refcheck = cle->ce_ref;
942 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
946 EXPORT_SYMBOL(cl_env_alloc);
948 static void cl_env_exit(struct cl_env *cle)
950 LASSERT(cle->ce_owner == NULL);
951 lu_context_exit(&cle->ce_lu.le_ctx);
952 lu_context_exit(&cle->ce_ses);
956 * Finalizes and frees a given number of cached environments. This is done to
957 * (1) free some memory (not currently hooked into VM), or (2) release
958 * references to modules.
960 unsigned cl_env_cache_purge(unsigned nr)
965 spin_lock(&cl_envs_guard);
966 for (; !list_empty(&cl_envs) && nr > 0; --nr) {
967 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
968 list_del_init(&cle->ce_linkage);
969 LASSERT(cl_envs_cached_nr > 0);
971 spin_unlock(&cl_envs_guard);
974 spin_lock(&cl_envs_guard);
976 LASSERT(equi(cl_envs_cached_nr == 0, list_empty(&cl_envs)));
977 spin_unlock(&cl_envs_guard);
980 EXPORT_SYMBOL(cl_env_cache_purge);
983 * Release an environment.
985 * Decrement \a env reference counter. When counter drops to 0, nothing in
986 * this thread is using environment and it is returned to the allocation
987 * cache, or freed straight away, if cache is large enough.
989 void cl_env_put(struct lu_env *env, __u16 *refcheck)
993 cle = cl_env_container(env);
995 LASSERT(cle->ce_ref > 0);
996 LASSERT(ergo(refcheck != NULL, cle->ce_ref == *refcheck));
998 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
999 if (--cle->ce_ref == 0) {
1002 cle->ce_debug = NULL;
1005 * Don't bother to take a lock here.
1007 * Return environment to the cache only when it was allocated
1008 * with the standard tags.
1010 if (cl_envs_cached_nr < cl_envs_cached_max &&
1011 (env->le_ctx.lc_tags & ~LCT_HAS_EXIT) == LCT_CL_THREAD &&
1012 (env->le_ses->lc_tags & ~LCT_HAS_EXIT) == LCT_SESSION) {
1013 spin_lock(&cl_envs_guard);
1014 list_add(&cle->ce_linkage, &cl_envs);
1015 cl_envs_cached_nr++;
1016 spin_unlock(&cl_envs_guard);
1021 EXPORT_SYMBOL(cl_env_put);
1024 * Declares a point of re-entrancy.
1026 * \see cl_env_reexit()
1028 void *cl_env_reenter(void)
1030 return cl_env_detach(NULL);
1032 EXPORT_SYMBOL(cl_env_reenter);
1035 * Exits re-entrancy.
1037 void cl_env_reexit(void *cookie)
1039 cl_env_detach(NULL);
1040 cl_env_attach(cookie);
1042 EXPORT_SYMBOL(cl_env_reexit);
1045 * Setup user-supplied \a env as a current environment. This is to be used to
1046 * guaranteed that environment exists even when cl_env_get() fails. It is up
1047 * to user to ensure proper concurrency control.
1049 * \see cl_env_unplant()
1051 void cl_env_implant(struct lu_env *env, __u16 *refcheck)
1053 struct cl_env *cle = cl_env_container(env);
1055 LASSERT(cle->ce_ref > 0);
1058 cl_env_get(refcheck);
1059 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1061 EXPORT_SYMBOL(cl_env_implant);
1064 * Detach environment installed earlier by cl_env_implant().
1066 void cl_env_unplant(struct lu_env *env, __u16 *refcheck)
1068 struct cl_env *cle = cl_env_container(env);
1070 LASSERT(cle->ce_ref > 1);
1072 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1075 cl_env_put(env, refcheck);
1077 EXPORT_SYMBOL(cl_env_unplant);
1079 struct lu_env *cl_env_nested_get(struct cl_env_nest *nest)
1083 nest->cen_cookie = NULL;
1084 env = cl_env_peek(&nest->cen_refcheck);
1086 if (!cl_io_is_going(env))
1089 cl_env_put(env, &nest->cen_refcheck);
1090 nest->cen_cookie = cl_env_reenter();
1093 env = cl_env_get(&nest->cen_refcheck);
1095 cl_env_reexit(nest->cen_cookie);
1099 LASSERT(!cl_io_is_going(env));
1102 EXPORT_SYMBOL(cl_env_nested_get);
1104 void cl_env_nested_put(struct cl_env_nest *nest, struct lu_env *env)
1106 cl_env_put(env, &nest->cen_refcheck);
1107 cl_env_reexit(nest->cen_cookie);
1109 EXPORT_SYMBOL(cl_env_nested_put);
1112 * Converts struct cl_attr to struct ost_lvb.
1116 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr)
1119 lvb->lvb_size = attr->cat_size;
1120 lvb->lvb_mtime = attr->cat_mtime;
1121 lvb->lvb_atime = attr->cat_atime;
1122 lvb->lvb_ctime = attr->cat_ctime;
1123 lvb->lvb_blocks = attr->cat_blocks;
1128 * Converts struct ost_lvb to struct cl_attr.
1132 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb)
1135 attr->cat_size = lvb->lvb_size;
1136 attr->cat_mtime = lvb->lvb_mtime;
1137 attr->cat_atime = lvb->lvb_atime;
1138 attr->cat_ctime = lvb->lvb_ctime;
1139 attr->cat_blocks = lvb->lvb_blocks;
1142 EXPORT_SYMBOL(cl_lvb2attr);
1144 static struct cl_env cl_env_percpu[NR_CPUS];
1146 static int cl_env_percpu_init(void)
1149 int tags = LCT_REMEMBER | LCT_NOREF;
1153 for_each_possible_cpu(i) {
1156 cle = &cl_env_percpu[i];
1159 INIT_LIST_HEAD(&cle->ce_linkage);
1160 cle->ce_magic = &cl_env_init0;
1161 rc = lu_env_init(env, LCT_CL_THREAD | tags);
1163 rc = lu_context_init(&cle->ce_ses, LCT_SESSION | tags);
1165 lu_context_enter(&cle->ce_ses);
1166 env->le_ses = &cle->ce_ses;
1175 /* Indices 0 to i (excluding i) were correctly initialized,
1176 * thus we must uninitialize up to i, the rest are undefined. */
1177 for (j = 0; j < i; j++) {
1178 cle = &cl_env_percpu[i];
1179 lu_context_exit(&cle->ce_ses);
1180 lu_context_fini(&cle->ce_ses);
1181 lu_env_fini(&cle->ce_lu);
1188 static void cl_env_percpu_fini(void)
1192 for_each_possible_cpu(i) {
1193 struct cl_env *cle = &cl_env_percpu[i];
1195 lu_context_exit(&cle->ce_ses);
1196 lu_context_fini(&cle->ce_ses);
1197 lu_env_fini(&cle->ce_lu);
1201 static void cl_env_percpu_refill(void)
1205 for_each_possible_cpu(i)
1206 lu_env_refill(&cl_env_percpu[i].ce_lu);
1209 void cl_env_percpu_put(struct lu_env *env)
1214 cpu = smp_processor_id();
1215 cle = cl_env_container(env);
1216 LASSERT(cle == &cl_env_percpu[cpu]);
1219 LASSERT(cle->ce_ref == 0);
1223 cle->ce_debug = NULL;
1227 EXPORT_SYMBOL(cl_env_percpu_put);
1229 struct lu_env *cl_env_percpu_get()
1233 cle = &cl_env_percpu[get_cpu()];
1234 cl_env_init0(cle, __builtin_return_address(0));
1239 EXPORT_SYMBOL(cl_env_percpu_get);
1241 /*****************************************************************************
1243 * Temporary prototype thing: mirror obd-devices into cl devices.
1247 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
1248 struct lu_device_type *ldt,
1249 struct lu_device *next)
1251 const char *typename;
1252 struct lu_device *d;
1254 LASSERT(ldt != NULL);
1256 typename = ldt->ldt_name;
1257 d = ldt->ldt_ops->ldto_device_alloc(env, ldt, NULL);
1263 rc = ldt->ldt_ops->ldto_device_init(env, d, typename, next);
1266 lu_ref_add(&d->ld_reference,
1267 "lu-stack", &lu_site_init);
1269 ldt->ldt_ops->ldto_device_free(env, d);
1270 CERROR("can't init device '%s', %d\n", typename, rc);
1274 CERROR("Cannot allocate device: '%s'\n", typename);
1275 return lu2cl_dev(d);
1277 EXPORT_SYMBOL(cl_type_setup);
1280 * Finalize device stack by calling lu_stack_fini().
1282 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl)
1284 lu_stack_fini(env, cl2lu_dev(cl));
1286 EXPORT_SYMBOL(cl_stack_fini);
1288 static struct lu_context_key cl_key;
1290 struct cl_thread_info *cl_env_info(const struct lu_env *env)
1292 return lu_context_key_get(&env->le_ctx, &cl_key);
1295 /* defines cl0_key_{init,fini}() */
1296 LU_KEY_INIT_FINI(cl0, struct cl_thread_info);
1298 static void *cl_key_init(const struct lu_context *ctx,
1299 struct lu_context_key *key)
1301 struct cl_thread_info *info;
1303 info = cl0_key_init(ctx, key);
1304 if (!IS_ERR(info)) {
1307 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1308 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1313 static void cl_key_fini(const struct lu_context *ctx,
1314 struct lu_context_key *key, void *data)
1316 struct cl_thread_info *info;
1320 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1321 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1322 cl0_key_fini(ctx, key, data);
1325 static void cl_key_exit(const struct lu_context *ctx,
1326 struct lu_context_key *key, void *data)
1328 struct cl_thread_info *info = data;
1331 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i) {
1332 LASSERT(info->clt_counters[i].ctc_nr_held == 0);
1333 LASSERT(info->clt_counters[i].ctc_nr_used == 0);
1334 LASSERT(info->clt_counters[i].ctc_nr_locks_acquired == 0);
1335 LASSERT(info->clt_counters[i].ctc_nr_locks_locked == 0);
1336 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1337 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1341 static struct lu_context_key cl_key = {
1342 .lct_tags = LCT_CL_THREAD,
1343 .lct_init = cl_key_init,
1344 .lct_fini = cl_key_fini,
1345 .lct_exit = cl_key_exit
1348 static struct lu_kmem_descr cl_object_caches[] = {
1350 .ckd_cache = &cl_env_kmem,
1351 .ckd_name = "cl_env_kmem",
1352 .ckd_size = sizeof (struct cl_env)
1360 * Global initialization of cl-data. Create kmem caches, register
1361 * lu_context_key's, etc.
1363 * \see cl_global_fini()
1365 int cl_global_init(void)
1369 INIT_LIST_HEAD(&cl_envs);
1371 result = cl_env_store_init();
1375 result = lu_kmem_init(cl_object_caches);
1379 LU_CONTEXT_KEY_INIT(&cl_key);
1380 result = lu_context_key_register(&cl_key);
1384 result = cl_env_percpu_init();
1386 /* no cl_env_percpu_fini on error */
1392 lu_context_key_degister(&cl_key);
1394 lu_kmem_fini(cl_object_caches);
1396 cl_env_store_fini();
1401 * Finalization of global cl-data. Dual to cl_global_init().
1403 void cl_global_fini(void)
1405 cl_env_percpu_fini();
1406 lu_context_key_degister(&cl_key);
1407 lu_kmem_fini(cl_object_caches);
1408 cl_env_store_fini();