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, 2014, 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);
94 EXPORT_SYMBOL(cl_object_header_fini);
97 * Returns a cl_object with a given \a fid.
99 * Returns either cached or newly created object. Additional reference on the
100 * returned object is acquired.
102 * \see lu_object_find(), cl_page_find(), cl_lock_find()
104 struct cl_object *cl_object_find(const struct lu_env *env,
105 struct cl_device *cd, const struct lu_fid *fid,
106 const struct cl_object_conf *c)
109 return lu2cl(lu_object_find_slice(env, cl2lu_dev(cd), fid, &c->coc_lu));
111 EXPORT_SYMBOL(cl_object_find);
114 * Releases a reference on \a o.
116 * When last reference is released object is returned to the cache, unless
117 * lu_object_header_flags::LU_OBJECT_HEARD_BANSHEE bit is set in its header.
119 * \see cl_page_put(), cl_lock_put().
121 void cl_object_put(const struct lu_env *env, struct cl_object *o)
123 lu_object_put(env, &o->co_lu);
125 EXPORT_SYMBOL(cl_object_put);
128 * Acquire an additional reference to the object \a o.
130 * This can only be used to acquire _additional_ reference, i.e., caller
131 * already has to possess at least one reference to \a o before calling this.
133 * \see cl_page_get(), cl_lock_get().
135 void cl_object_get(struct cl_object *o)
137 lu_object_get(&o->co_lu);
139 EXPORT_SYMBOL(cl_object_get);
142 * Returns the top-object for a given \a o.
146 struct cl_object *cl_object_top(struct cl_object *o)
148 struct cl_object_header *hdr = cl_object_header(o);
149 struct cl_object *top;
151 while (hdr->coh_parent != NULL)
152 hdr = hdr->coh_parent;
154 top = lu2cl(lu_object_top(&hdr->coh_lu));
155 CDEBUG(D_TRACE, "%p -> %p\n", o, top);
158 EXPORT_SYMBOL(cl_object_top);
161 * Returns pointer to the lock protecting data-attributes for the given object
164 * Data-attributes are protected by the cl_object_header::coh_attr_guard
165 * spin-lock in the top-object.
167 * \see cl_attr, cl_object_attr_lock(), cl_object_operations::coo_attr_get().
169 static spinlock_t *cl_object_attr_guard(struct cl_object *o)
171 return &cl_object_header(cl_object_top(o))->coh_attr_guard;
175 * Locks data-attributes.
177 * Prevents data-attributes from changing, until lock is released by
178 * cl_object_attr_unlock(). This has to be called before calls to
179 * cl_object_attr_get(), cl_object_attr_set().
181 void cl_object_attr_lock(struct cl_object *o)
182 __acquires(cl_object_attr_guard(o))
184 spin_lock(cl_object_attr_guard(o));
186 EXPORT_SYMBOL(cl_object_attr_lock);
189 * Releases data-attributes lock, acquired by cl_object_attr_lock().
191 void cl_object_attr_unlock(struct cl_object *o)
192 __releases(cl_object_attr_guard(o))
194 spin_unlock(cl_object_attr_guard(o));
196 EXPORT_SYMBOL(cl_object_attr_unlock);
199 * Returns data-attributes of an object \a obj.
201 * Every layer is asked (by calling cl_object_operations::coo_attr_get())
202 * top-to-bottom to fill in parts of \a attr that this layer is responsible
205 int cl_object_attr_get(const struct lu_env *env, struct cl_object *obj,
206 struct cl_attr *attr)
208 struct lu_object_header *top;
211 assert_spin_locked(cl_object_attr_guard(obj));
214 top = obj->co_lu.lo_header;
216 list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
217 if (obj->co_ops->coo_attr_get != NULL) {
218 result = obj->co_ops->coo_attr_get(env, obj, attr);
228 EXPORT_SYMBOL(cl_object_attr_get);
231 * Updates data-attributes of an object \a obj.
233 * Only attributes, mentioned in a validness bit-mask \a v are
234 * updated. Calls cl_object_operations::coo_attr_set() on every layer, bottom
237 int cl_object_attr_set(const struct lu_env *env, struct cl_object *obj,
238 const struct cl_attr *attr, unsigned v)
240 struct lu_object_header *top;
243 assert_spin_locked(cl_object_attr_guard(obj));
246 top = obj->co_lu.lo_header;
248 list_for_each_entry_reverse(obj, &top->loh_layers, co_lu.lo_linkage) {
249 if (obj->co_ops->coo_attr_set != NULL) {
250 result = obj->co_ops->coo_attr_set(env, obj, attr, v);
260 EXPORT_SYMBOL(cl_object_attr_set);
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 * Helper function removing all object locks, and marking object for
366 * deletion. All object pages must have been deleted at this point.
368 * This is called by cl_inode_fini() and lov_object_delete() to destroy top-
369 * and sub- objects respectively.
371 void cl_object_kill(const struct lu_env *env, struct cl_object *obj)
373 struct cl_object_header *hdr = cl_object_header(obj);
375 set_bit(LU_OBJECT_HEARD_BANSHEE, &hdr->coh_lu.loh_flags);
377 EXPORT_SYMBOL(cl_object_kill);
379 void cache_stats_init(struct cache_stats *cs, const char *name)
384 for (i = 0; i < CS_NR; i++)
385 atomic_set(&cs->cs_stats[i], 0);
388 static int cache_stats_print(const struct cache_stats *cs,
389 struct seq_file *m, int h)
394 * lookup hit total cached create
395 * env: ...... ...... ...... ...... ......
398 const char *names[CS_NR] = CS_NAMES;
400 seq_printf(m, "%6s", " ");
401 for (i = 0; i < CS_NR; i++)
402 seq_printf(m, "%8s", names[i]);
406 seq_printf(m, "%5.5s:", cs->cs_name);
407 for (i = 0; i < CS_NR; i++)
408 seq_printf(m, "%8u", atomic_read(&cs->cs_stats[i]));
412 static void cl_env_percpu_refill(void);
415 * Initialize client site.
417 * Perform common initialization (lu_site_init()), and initialize statistical
418 * counters. Also perform global initializations on the first call.
420 int cl_site_init(struct cl_site *s, struct cl_device *d)
425 result = lu_site_init(&s->cs_lu, &d->cd_lu_dev);
427 cache_stats_init(&s->cs_pages, "pages");
428 for (i = 0; i < ARRAY_SIZE(s->cs_pages_state); ++i)
429 atomic_set(&s->cs_pages_state[0], 0);
430 cl_env_percpu_refill();
434 EXPORT_SYMBOL(cl_site_init);
437 * Finalize client site. Dual to cl_site_init().
439 void cl_site_fini(struct cl_site *s)
441 lu_site_fini(&s->cs_lu);
443 EXPORT_SYMBOL(cl_site_fini);
445 static struct cache_stats cl_env_stats = {
447 .cs_stats = { ATOMIC_INIT(0), }
451 * Outputs client site statistical counters into a buffer. Suitable for
452 * ll_rd_*()-style functions.
454 int cl_site_stats_print(const struct cl_site *site, struct seq_file *m)
456 static const char *pstate[] = {
466 lookup hit total busy create
467 pages: ...... ...... ...... ...... ...... [...... ...... ...... ......]
468 locks: ...... ...... ...... ...... ...... [...... ...... ...... ...... ......]
469 env: ...... ...... ...... ...... ......
471 lu_site_stats_seq_print(&site->cs_lu, m);
472 cache_stats_print(&site->cs_pages, m, 1);
474 for (i = 0; i < ARRAY_SIZE(site->cs_pages_state); ++i)
475 seq_printf(m, "%s: %u ", pstate[i],
476 atomic_read(&site->cs_pages_state[i]));
477 seq_printf(m, "]\n");
478 cache_stats_print(&cl_env_stats, m, 0);
482 EXPORT_SYMBOL(cl_site_stats_print);
484 /*****************************************************************************
486 * lu_env handling on client.
491 * The most efficient way is to store cl_env pointer in task specific
492 * structures. On Linux, it wont' be easy to use task_struct->journal_info
493 * because Lustre code may call into other fs which has certain assumptions
494 * about journal_info. Currently following fields in task_struct are identified
495 * can be used for this purpose:
496 * - cl_env: for liblustre.
497 * - tux_info: ony on RedHat kernel.
499 * \note As long as we use task_struct to store cl_env, we assume that once
500 * called into Lustre, we'll never call into the other part of the kernel
501 * which will use those fields in task_struct without explicitly exiting
504 * If there's no space in task_struct is available, hash will be used.
508 static struct list_head cl_envs;
509 static unsigned cl_envs_cached_nr = 0;
510 static unsigned cl_envs_cached_max = 128; /* XXX: prototype: arbitrary limit
512 static DEFINE_SPINLOCK(cl_envs_guard);
517 struct lu_context ce_ses;
519 #ifdef LL_TASK_CL_ENV
523 * This allows cl_env to be entered into cl_env_hash which implements
524 * the current thread -> client environment lookup.
526 struct hlist_node ce_node;
529 * Owner for the current cl_env.
531 * If LL_TASK_CL_ENV is defined, this point to the owning current,
532 * only for debugging purpose ;
533 * Otherwise hash is used, and this is the key for cfs_hash.
534 * Now current thread pid is stored. Note using thread pointer would
535 * lead to unbalanced hash because of its specific allocation locality
536 * and could be varied for different platforms and OSes, even different
542 * Linkage into global list of all client environments. Used for
543 * garbage collection.
545 struct list_head ce_linkage;
551 * Debugging field: address of the caller who made original
557 #ifdef CONFIG_DEBUG_PAGESTATE_TRACKING
558 #define CL_ENV_INC(counter) atomic_inc(&cl_env_stats.cs_stats[CS_##counter])
560 #define CL_ENV_DEC(counter) do { \
561 LASSERT(atomic_read(&cl_env_stats.cs_stats[CS_##counter]) > 0); \
562 atomic_dec(&cl_env_stats.cs_stats[CS_##counter]); \
565 #define CL_ENV_INC(counter)
566 #define CL_ENV_DEC(counter)
569 static void cl_env_init0(struct cl_env *cle, void *debug)
571 LASSERT(cle->ce_ref == 0);
572 LASSERT(cle->ce_magic == &cl_env_init0);
573 LASSERT(cle->ce_debug == NULL && cle->ce_owner == NULL);
576 cle->ce_debug = debug;
581 #ifndef LL_TASK_CL_ENV
583 * The implementation of using hash table to connect cl_env and thread
586 static cfs_hash_t *cl_env_hash;
588 static unsigned cl_env_hops_hash(cfs_hash_t *lh,
589 const void *key, unsigned mask)
591 #if BITS_PER_LONG == 64
592 return cfs_hash_u64_hash((__u64)key, mask);
594 return cfs_hash_u32_hash((__u32)key, mask);
598 static void *cl_env_hops_obj(struct hlist_node *hn)
600 struct cl_env *cle = hlist_entry(hn, struct cl_env, ce_node);
602 LASSERT(cle->ce_magic == &cl_env_init0);
606 static int cl_env_hops_keycmp(const void *key, struct hlist_node *hn)
608 struct cl_env *cle = cl_env_hops_obj(hn);
610 LASSERT(cle->ce_owner != NULL);
611 return (key == cle->ce_owner);
614 static void cl_env_hops_noop(cfs_hash_t *hs, struct hlist_node *hn)
616 struct cl_env *cle = hlist_entry(hn, struct cl_env, ce_node);
617 LASSERT(cle->ce_magic == &cl_env_init0);
620 static cfs_hash_ops_t cl_env_hops = {
621 .hs_hash = cl_env_hops_hash,
622 .hs_key = cl_env_hops_obj,
623 .hs_keycmp = cl_env_hops_keycmp,
624 .hs_object = cl_env_hops_obj,
625 .hs_get = cl_env_hops_noop,
626 .hs_put_locked = cl_env_hops_noop,
629 static inline struct cl_env *cl_env_fetch(void)
633 cle = cfs_hash_lookup(cl_env_hash, (void *) (long) current->pid);
634 LASSERT(ergo(cle, cle->ce_magic == &cl_env_init0));
638 static inline void cl_env_attach(struct cl_env *cle)
643 LASSERT(cle->ce_owner == NULL);
644 cle->ce_owner = (void *) (long) current->pid;
645 rc = cfs_hash_add_unique(cl_env_hash, cle->ce_owner,
651 static inline void cl_env_do_detach(struct cl_env *cle)
655 LASSERT(cle->ce_owner == (void *) (long) current->pid);
656 cookie = cfs_hash_del(cl_env_hash, cle->ce_owner,
658 LASSERT(cookie == cle);
659 cle->ce_owner = NULL;
662 static int cl_env_store_init(void) {
663 cl_env_hash = cfs_hash_create("cl_env",
664 HASH_CL_ENV_BITS, HASH_CL_ENV_BITS,
665 HASH_CL_ENV_BKT_BITS, 0,
669 CFS_HASH_RW_BKTLOCK);
670 return cl_env_hash != NULL ? 0 :-ENOMEM;
673 static void cl_env_store_fini(void) {
674 cfs_hash_putref(cl_env_hash);
677 #else /* LL_TASK_CL_ENV */
679 * The implementation of store cl_env directly in thread structure.
682 static inline struct cl_env *cl_env_fetch(void)
686 cle = current->LL_TASK_CL_ENV;
687 if (cle && cle->ce_magic != &cl_env_init0)
692 static inline void cl_env_attach(struct cl_env *cle)
695 LASSERT(cle->ce_owner == NULL);
696 cle->ce_owner = current;
697 cle->ce_prev = current->LL_TASK_CL_ENV;
698 current->LL_TASK_CL_ENV = cle;
702 static inline void cl_env_do_detach(struct cl_env *cle)
704 LASSERT(cle->ce_owner == current);
705 LASSERT(current->LL_TASK_CL_ENV == cle);
706 current->LL_TASK_CL_ENV = cle->ce_prev;
707 cle->ce_owner = NULL;
710 static int cl_env_store_init(void) { return 0; }
711 static void cl_env_store_fini(void) { }
713 #endif /* LL_TASK_CL_ENV */
715 static inline struct cl_env *cl_env_detach(struct cl_env *cle)
718 cle = cl_env_fetch();
720 if (cle && cle->ce_owner)
721 cl_env_do_detach(cle);
726 static struct lu_env *cl_env_new(__u32 ctx_tags, __u32 ses_tags, void *debug)
731 OBD_SLAB_ALLOC_PTR_GFP(cle, cl_env_kmem, GFP_NOFS);
735 INIT_LIST_HEAD(&cle->ce_linkage);
736 cle->ce_magic = &cl_env_init0;
738 rc = lu_env_init(env, LCT_CL_THREAD|ctx_tags);
740 rc = lu_context_init(&cle->ce_ses,
741 LCT_SESSION | ses_tags);
743 lu_context_enter(&cle->ce_ses);
744 env->le_ses = &cle->ce_ses;
745 cl_env_init0(cle, debug);
750 OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
757 env = ERR_PTR(-ENOMEM);
761 static void cl_env_fini(struct cl_env *cle)
764 lu_context_fini(&cle->ce_lu.le_ctx);
765 lu_context_fini(&cle->ce_ses);
766 OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
769 static struct lu_env *cl_env_obtain(void *debug)
775 spin_lock(&cl_envs_guard);
776 LASSERT(equi(cl_envs_cached_nr == 0, list_empty(&cl_envs)));
777 if (cl_envs_cached_nr > 0) {
780 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
781 list_del_init(&cle->ce_linkage);
783 spin_unlock(&cl_envs_guard);
786 rc = lu_env_refill(env);
788 cl_env_init0(cle, debug);
789 lu_context_enter(&env->le_ctx);
790 lu_context_enter(&cle->ce_ses);
796 spin_unlock(&cl_envs_guard);
797 env = cl_env_new(lu_context_tags_default,
798 lu_session_tags_default, debug);
803 static inline struct cl_env *cl_env_container(struct lu_env *env)
805 return container_of(env, struct cl_env, ce_lu);
808 struct lu_env *cl_env_peek(int *refcheck)
815 /* check that we don't go far from untrusted pointer */
816 CLASSERT(offsetof(struct cl_env, ce_magic) == 0);
819 cle = cl_env_fetch();
823 *refcheck = ++cle->ce_ref;
825 CDEBUG(D_OTHER, "%d@%p\n", cle ? cle->ce_ref : 0, cle);
828 EXPORT_SYMBOL(cl_env_peek);
831 * Returns lu_env: if there already is an environment associated with the
832 * current thread, it is returned, otherwise, new environment is allocated.
834 * Allocations are amortized through the global cache of environments.
836 * \param refcheck pointer to a counter used to detect environment leaks. In
837 * the usual case cl_env_get() and cl_env_put() are called in the same lexical
838 * scope and pointer to the same integer is passed as \a refcheck. This is
839 * used to detect missed cl_env_put().
843 struct lu_env *cl_env_get(int *refcheck)
847 env = cl_env_peek(refcheck);
849 env = cl_env_obtain(__builtin_return_address(0));
853 cle = cl_env_container(env);
855 *refcheck = cle->ce_ref;
856 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
861 EXPORT_SYMBOL(cl_env_get);
864 * Forces an allocation of a fresh environment with given tags.
868 struct lu_env *cl_env_alloc(int *refcheck, __u32 tags)
872 LASSERT(cl_env_peek(refcheck) == NULL);
873 env = cl_env_new(tags, tags, __builtin_return_address(0));
877 cle = cl_env_container(env);
878 *refcheck = cle->ce_ref;
879 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
883 EXPORT_SYMBOL(cl_env_alloc);
885 static void cl_env_exit(struct cl_env *cle)
887 LASSERT(cle->ce_owner == NULL);
888 lu_context_exit(&cle->ce_lu.le_ctx);
889 lu_context_exit(&cle->ce_ses);
893 * Finalizes and frees a given number of cached environments. This is done to
894 * (1) free some memory (not currently hooked into VM), or (2) release
895 * references to modules.
897 unsigned cl_env_cache_purge(unsigned nr)
902 spin_lock(&cl_envs_guard);
903 for (; !list_empty(&cl_envs) && nr > 0; --nr) {
904 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
905 list_del_init(&cle->ce_linkage);
906 LASSERT(cl_envs_cached_nr > 0);
908 spin_unlock(&cl_envs_guard);
911 spin_lock(&cl_envs_guard);
913 LASSERT(equi(cl_envs_cached_nr == 0, list_empty(&cl_envs)));
914 spin_unlock(&cl_envs_guard);
917 EXPORT_SYMBOL(cl_env_cache_purge);
920 * Release an environment.
922 * Decrement \a env reference counter. When counter drops to 0, nothing in
923 * this thread is using environment and it is returned to the allocation
924 * cache, or freed straight away, if cache is large enough.
926 void cl_env_put(struct lu_env *env, int *refcheck)
930 cle = cl_env_container(env);
932 LASSERT(cle->ce_ref > 0);
933 LASSERT(ergo(refcheck != NULL, cle->ce_ref == *refcheck));
935 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
936 if (--cle->ce_ref == 0) {
939 cle->ce_debug = NULL;
942 * Don't bother to take a lock here.
944 * Return environment to the cache only when it was allocated
945 * with the standard tags.
947 if (cl_envs_cached_nr < cl_envs_cached_max &&
948 (env->le_ctx.lc_tags & ~LCT_HAS_EXIT) == LCT_CL_THREAD &&
949 (env->le_ses->lc_tags & ~LCT_HAS_EXIT) == LCT_SESSION) {
950 spin_lock(&cl_envs_guard);
951 list_add(&cle->ce_linkage, &cl_envs);
953 spin_unlock(&cl_envs_guard);
958 EXPORT_SYMBOL(cl_env_put);
961 * Declares a point of re-entrancy.
963 * \see cl_env_reexit()
965 void *cl_env_reenter(void)
967 return cl_env_detach(NULL);
969 EXPORT_SYMBOL(cl_env_reenter);
974 void cl_env_reexit(void *cookie)
977 cl_env_attach(cookie);
979 EXPORT_SYMBOL(cl_env_reexit);
982 * Setup user-supplied \a env as a current environment. This is to be used to
983 * guaranteed that environment exists even when cl_env_get() fails. It is up
984 * to user to ensure proper concurrency control.
986 * \see cl_env_unplant()
988 void cl_env_implant(struct lu_env *env, int *refcheck)
990 struct cl_env *cle = cl_env_container(env);
992 LASSERT(cle->ce_ref > 0);
995 cl_env_get(refcheck);
996 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
998 EXPORT_SYMBOL(cl_env_implant);
1001 * Detach environment installed earlier by cl_env_implant().
1003 void cl_env_unplant(struct lu_env *env, int *refcheck)
1005 struct cl_env *cle = cl_env_container(env);
1007 LASSERT(cle->ce_ref > 1);
1009 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1012 cl_env_put(env, refcheck);
1014 EXPORT_SYMBOL(cl_env_unplant);
1016 struct lu_env *cl_env_nested_get(struct cl_env_nest *nest)
1020 nest->cen_cookie = NULL;
1021 env = cl_env_peek(&nest->cen_refcheck);
1023 if (!cl_io_is_going(env))
1026 cl_env_put(env, &nest->cen_refcheck);
1027 nest->cen_cookie = cl_env_reenter();
1030 env = cl_env_get(&nest->cen_refcheck);
1032 cl_env_reexit(nest->cen_cookie);
1036 LASSERT(!cl_io_is_going(env));
1039 EXPORT_SYMBOL(cl_env_nested_get);
1041 void cl_env_nested_put(struct cl_env_nest *nest, struct lu_env *env)
1043 cl_env_put(env, &nest->cen_refcheck);
1044 cl_env_reexit(nest->cen_cookie);
1046 EXPORT_SYMBOL(cl_env_nested_put);
1049 * Converts struct cl_attr to struct ost_lvb.
1053 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr)
1056 lvb->lvb_size = attr->cat_size;
1057 lvb->lvb_mtime = attr->cat_mtime;
1058 lvb->lvb_atime = attr->cat_atime;
1059 lvb->lvb_ctime = attr->cat_ctime;
1060 lvb->lvb_blocks = attr->cat_blocks;
1063 EXPORT_SYMBOL(cl_attr2lvb);
1066 * Converts struct ost_lvb to struct cl_attr.
1070 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb)
1073 attr->cat_size = lvb->lvb_size;
1074 attr->cat_mtime = lvb->lvb_mtime;
1075 attr->cat_atime = lvb->lvb_atime;
1076 attr->cat_ctime = lvb->lvb_ctime;
1077 attr->cat_blocks = lvb->lvb_blocks;
1080 EXPORT_SYMBOL(cl_lvb2attr);
1082 static struct cl_env cl_env_percpu[NR_CPUS];
1084 static int cl_env_percpu_init(void)
1087 int tags = LCT_REMEMBER | LCT_NOREF;
1091 for_each_possible_cpu(i) {
1094 cle = &cl_env_percpu[i];
1097 INIT_LIST_HEAD(&cle->ce_linkage);
1098 cle->ce_magic = &cl_env_init0;
1099 rc = lu_env_init(env, LCT_CL_THREAD | tags);
1101 rc = lu_context_init(&cle->ce_ses, LCT_SESSION | tags);
1103 lu_context_enter(&cle->ce_ses);
1104 env->le_ses = &cle->ce_ses;
1113 /* Indices 0 to i (excluding i) were correctly initialized,
1114 * thus we must uninitialize up to i, the rest are undefined. */
1115 for (j = 0; j < i; j++) {
1116 cle = &cl_env_percpu[i];
1117 lu_context_exit(&cle->ce_ses);
1118 lu_context_fini(&cle->ce_ses);
1119 lu_env_fini(&cle->ce_lu);
1126 static void cl_env_percpu_fini(void)
1130 for_each_possible_cpu(i) {
1131 struct cl_env *cle = &cl_env_percpu[i];
1133 lu_context_exit(&cle->ce_ses);
1134 lu_context_fini(&cle->ce_ses);
1135 lu_env_fini(&cle->ce_lu);
1139 static void cl_env_percpu_refill(void)
1143 for_each_possible_cpu(i)
1144 lu_env_refill(&cl_env_percpu[i].ce_lu);
1147 void cl_env_percpu_put(struct lu_env *env)
1152 cpu = smp_processor_id();
1153 cle = cl_env_container(env);
1154 LASSERT(cle == &cl_env_percpu[cpu]);
1157 LASSERT(cle->ce_ref == 0);
1161 cle->ce_debug = NULL;
1165 EXPORT_SYMBOL(cl_env_percpu_put);
1167 struct lu_env *cl_env_percpu_get()
1171 cle = &cl_env_percpu[get_cpu()];
1172 cl_env_init0(cle, __builtin_return_address(0));
1177 EXPORT_SYMBOL(cl_env_percpu_get);
1179 /*****************************************************************************
1181 * Temporary prototype thing: mirror obd-devices into cl devices.
1185 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
1186 struct lu_device_type *ldt,
1187 struct lu_device *next)
1189 const char *typename;
1190 struct lu_device *d;
1192 LASSERT(ldt != NULL);
1194 typename = ldt->ldt_name;
1195 d = ldt->ldt_ops->ldto_device_alloc(env, ldt, NULL);
1201 rc = ldt->ldt_ops->ldto_device_init(env, d, typename, next);
1204 lu_ref_add(&d->ld_reference,
1205 "lu-stack", &lu_site_init);
1207 ldt->ldt_ops->ldto_device_free(env, d);
1208 CERROR("can't init device '%s', %d\n", typename, rc);
1212 CERROR("Cannot allocate device: '%s'\n", typename);
1213 return lu2cl_dev(d);
1215 EXPORT_SYMBOL(cl_type_setup);
1218 * Finalize device stack by calling lu_stack_fini().
1220 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl)
1222 lu_stack_fini(env, cl2lu_dev(cl));
1224 EXPORT_SYMBOL(cl_stack_fini);
1226 static struct lu_context_key cl_key;
1228 struct cl_thread_info *cl_env_info(const struct lu_env *env)
1230 return lu_context_key_get(&env->le_ctx, &cl_key);
1233 /* defines cl0_key_{init,fini}() */
1234 LU_KEY_INIT_FINI(cl0, struct cl_thread_info);
1236 static void *cl_key_init(const struct lu_context *ctx,
1237 struct lu_context_key *key)
1239 struct cl_thread_info *info;
1241 info = cl0_key_init(ctx, key);
1242 if (!IS_ERR(info)) {
1245 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1246 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1251 static void cl_key_fini(const struct lu_context *ctx,
1252 struct lu_context_key *key, void *data)
1254 struct cl_thread_info *info;
1258 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1259 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1260 cl0_key_fini(ctx, key, data);
1263 static void cl_key_exit(const struct lu_context *ctx,
1264 struct lu_context_key *key, void *data)
1266 struct cl_thread_info *info = data;
1269 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i) {
1270 LASSERT(info->clt_counters[i].ctc_nr_held == 0);
1271 LASSERT(info->clt_counters[i].ctc_nr_used == 0);
1272 LASSERT(info->clt_counters[i].ctc_nr_locks_acquired == 0);
1273 LASSERT(info->clt_counters[i].ctc_nr_locks_locked == 0);
1274 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1275 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1279 static struct lu_context_key cl_key = {
1280 .lct_tags = LCT_CL_THREAD,
1281 .lct_init = cl_key_init,
1282 .lct_fini = cl_key_fini,
1283 .lct_exit = cl_key_exit
1286 static struct lu_kmem_descr cl_object_caches[] = {
1288 .ckd_cache = &cl_env_kmem,
1289 .ckd_name = "cl_env_kmem",
1290 .ckd_size = sizeof (struct cl_env)
1298 * Global initialization of cl-data. Create kmem caches, register
1299 * lu_context_key's, etc.
1301 * \see cl_global_fini()
1303 int cl_global_init(void)
1307 INIT_LIST_HEAD(&cl_envs);
1309 result = cl_env_store_init();
1313 result = lu_kmem_init(cl_object_caches);
1317 LU_CONTEXT_KEY_INIT(&cl_key);
1318 result = lu_context_key_register(&cl_key);
1322 result = cl_env_percpu_init();
1324 /* no cl_env_percpu_fini on error */
1330 lu_context_key_degister(&cl_key);
1332 lu_kmem_fini(cl_object_caches);
1334 cl_env_store_fini();
1339 * Finalization of global cl-data. Dual to cl_global_init().
1341 void cl_global_fini(void)
1343 cl_env_percpu_fini();
1344 lu_context_key_degister(&cl_key);
1345 lu_kmem_fini(cl_object_caches);
1346 cl_env_store_fini();