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, 2013, 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>
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 struct kmem_cache *cl_env_kmem;
66 /** Lock class of cl_object_header::coh_lock_guard */
67 static struct lock_class_key cl_lock_guard_class;
68 /** Lock class of cl_object_header::coh_attr_guard */
69 static struct lock_class_key cl_attr_guard_class;
71 extern __u32 lu_context_tags_default;
72 extern __u32 lu_session_tags_default;
74 * Initialize cl_object_header.
76 int cl_object_header_init(struct cl_object_header *h)
81 result = lu_object_header_init(&h->coh_lu);
83 spin_lock_init(&h->coh_lock_guard);
84 spin_lock_init(&h->coh_attr_guard);
85 lockdep_set_class(&h->coh_lock_guard, &cl_lock_guard_class);
86 lockdep_set_class(&h->coh_attr_guard, &cl_attr_guard_class);
87 INIT_LIST_HEAD(&h->coh_locks);
88 h->coh_page_bufsize = 0;
92 EXPORT_SYMBOL(cl_object_header_init);
95 * Finalize cl_object_header.
97 void cl_object_header_fini(struct cl_object_header *h)
99 LASSERT(list_empty(&h->coh_locks));
100 lu_object_header_fini(&h->coh_lu);
102 EXPORT_SYMBOL(cl_object_header_fini);
105 * Returns a cl_object with a given \a fid.
107 * Returns either cached or newly created object. Additional reference on the
108 * returned object is acquired.
110 * \see lu_object_find(), cl_page_find(), cl_lock_find()
112 struct cl_object *cl_object_find(const struct lu_env *env,
113 struct cl_device *cd, const struct lu_fid *fid,
114 const struct cl_object_conf *c)
117 return lu2cl(lu_object_find_slice(env, cl2lu_dev(cd), fid, &c->coc_lu));
119 EXPORT_SYMBOL(cl_object_find);
122 * Releases a reference on \a o.
124 * When last reference is released object is returned to the cache, unless
125 * lu_object_header_flags::LU_OBJECT_HEARD_BANSHEE bit is set in its header.
127 * \see cl_page_put(), cl_lock_put().
129 void cl_object_put(const struct lu_env *env, struct cl_object *o)
131 lu_object_put(env, &o->co_lu);
133 EXPORT_SYMBOL(cl_object_put);
136 * Acquire an additional reference to the object \a o.
138 * This can only be used to acquire _additional_ reference, i.e., caller
139 * already has to possess at least one reference to \a o before calling this.
141 * \see cl_page_get(), cl_lock_get().
143 void cl_object_get(struct cl_object *o)
145 lu_object_get(&o->co_lu);
147 EXPORT_SYMBOL(cl_object_get);
150 * Returns the top-object for a given \a o.
154 struct cl_object *cl_object_top(struct cl_object *o)
156 struct cl_object_header *hdr = cl_object_header(o);
157 struct cl_object *top;
159 while (hdr->coh_parent != NULL)
160 hdr = hdr->coh_parent;
162 top = lu2cl(lu_object_top(&hdr->coh_lu));
163 CDEBUG(D_TRACE, "%p -> %p\n", o, top);
166 EXPORT_SYMBOL(cl_object_top);
169 * Returns pointer to the lock protecting data-attributes for the given object
172 * Data-attributes are protected by the cl_object_header::coh_attr_guard
173 * spin-lock in the top-object.
175 * \see cl_attr, cl_object_attr_lock(), cl_object_operations::coo_attr_get().
177 static spinlock_t *cl_object_attr_guard(struct cl_object *o)
179 return &cl_object_header(cl_object_top(o))->coh_attr_guard;
183 * Locks data-attributes.
185 * Prevents data-attributes from changing, until lock is released by
186 * cl_object_attr_unlock(). This has to be called before calls to
187 * cl_object_attr_get(), cl_object_attr_set().
189 void cl_object_attr_lock(struct cl_object *o)
191 spin_lock(cl_object_attr_guard(o));
193 EXPORT_SYMBOL(cl_object_attr_lock);
196 * Releases data-attributes lock, acquired by cl_object_attr_lock().
198 void cl_object_attr_unlock(struct cl_object *o)
200 spin_unlock(cl_object_attr_guard(o));
202 EXPORT_SYMBOL(cl_object_attr_unlock);
205 * Returns data-attributes of an object \a obj.
207 * Every layer is asked (by calling cl_object_operations::coo_attr_get())
208 * top-to-bottom to fill in parts of \a attr that this layer is responsible
211 int cl_object_attr_get(const struct lu_env *env, struct cl_object *obj,
212 struct cl_attr *attr)
214 struct lu_object_header *top;
217 assert_spin_locked(cl_object_attr_guard(obj));
220 top = obj->co_lu.lo_header;
222 list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
223 if (obj->co_ops->coo_attr_get != NULL) {
224 result = obj->co_ops->coo_attr_get(env, obj, attr);
234 EXPORT_SYMBOL(cl_object_attr_get);
237 * Updates data-attributes of an object \a obj.
239 * Only attributes, mentioned in a validness bit-mask \a v are
240 * updated. Calls cl_object_operations::coo_attr_set() on every layer, bottom
243 int cl_object_attr_set(const struct lu_env *env, struct cl_object *obj,
244 const struct cl_attr *attr, unsigned v)
246 struct lu_object_header *top;
249 assert_spin_locked(cl_object_attr_guard(obj));
252 top = obj->co_lu.lo_header;
254 list_for_each_entry_reverse(obj, &top->loh_layers, co_lu.lo_linkage) {
255 if (obj->co_ops->coo_attr_set != NULL) {
256 result = obj->co_ops->coo_attr_set(env, obj, attr, v);
266 EXPORT_SYMBOL(cl_object_attr_set);
269 * Notifies layers (bottom-to-top) that glimpse AST was received.
271 * Layers have to fill \a lvb fields with information that will be shipped
272 * back to glimpse issuer.
274 * \see cl_lock_operations::clo_glimpse()
276 int cl_object_glimpse(const struct lu_env *env, struct cl_object *obj,
279 struct lu_object_header *top;
283 top = obj->co_lu.lo_header;
285 list_for_each_entry_reverse(obj, &top->loh_layers, co_lu.lo_linkage) {
286 if (obj->co_ops->coo_glimpse != NULL) {
287 result = obj->co_ops->coo_glimpse(env, obj, lvb);
292 LU_OBJECT_HEADER(D_DLMTRACE, env, lu_object_top(top),
293 "size: "LPU64" mtime: "LPU64" atime: "LPU64" "
294 "ctime: "LPU64" blocks: "LPU64"\n",
295 lvb->lvb_size, lvb->lvb_mtime, lvb->lvb_atime,
296 lvb->lvb_ctime, lvb->lvb_blocks);
299 EXPORT_SYMBOL(cl_object_glimpse);
302 * Updates a configuration of an object \a obj.
304 int cl_conf_set(const struct lu_env *env, struct cl_object *obj,
305 const struct cl_object_conf *conf)
307 struct lu_object_header *top;
311 top = obj->co_lu.lo_header;
313 list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
314 if (obj->co_ops->coo_conf_set != NULL) {
315 result = obj->co_ops->coo_conf_set(env, obj, conf);
322 EXPORT_SYMBOL(cl_conf_set);
325 * Prunes caches of pages and locks for this object.
327 void cl_object_prune(const struct lu_env *env, struct cl_object *obj)
329 struct lu_object_header *top;
334 top = obj->co_lu.lo_header;
336 list_for_each_entry(o, &top->loh_layers, co_lu.lo_linkage) {
337 if (o->co_ops->coo_prune != NULL) {
338 result = o->co_ops->coo_prune(env, o);
344 /* TODO: pruning locks will be moved into layers after cl_lock
345 * simplification is done */
346 cl_locks_prune(env, obj, 1);
349 EXPORT_SYMBOL(cl_object_prune);
352 * Helper function removing all object locks, and marking object for
353 * deletion. All object pages must have been deleted at this point.
355 * This is called by cl_inode_fini() and lov_object_delete() to destroy top-
356 * and sub- objects respectively.
358 void cl_object_kill(const struct lu_env *env, struct cl_object *obj)
360 struct cl_object_header *hdr;
362 hdr = cl_object_header(obj);
364 set_bit(LU_OBJECT_HEARD_BANSHEE, &hdr->coh_lu.loh_flags);
366 * Destroy all locks. Object destruction (including cl_inode_fini())
367 * cannot cancel the locks, because in the case of a local client,
368 * where client and server share the same thread running
369 * prune_icache(), this can dead-lock with ldlm_cancel_handler()
370 * waiting on __wait_on_freeing_inode().
372 cl_locks_prune(env, obj, 0);
374 EXPORT_SYMBOL(cl_object_kill);
377 * Check if the object has locks.
379 int cl_object_has_locks(struct cl_object *obj)
381 struct cl_object_header *head = cl_object_header(obj);
384 spin_lock(&head->coh_lock_guard);
385 has = list_empty(&head->coh_locks);
386 spin_unlock(&head->coh_lock_guard);
390 EXPORT_SYMBOL(cl_object_has_locks);
392 void cache_stats_init(struct cache_stats *cs, const char *name)
397 for (i = 0; i < CS_NR; i++)
398 atomic_set(&cs->cs_stats[i], 0);
401 int cache_stats_print(const struct cache_stats *cs, struct seq_file *m, int h)
406 * lookup hit total cached create
407 * env: ...... ...... ...... ...... ......
410 const char *names[CS_NR] = CS_NAMES;
412 seq_printf(m, "%6s", " ");
413 for (i = 0; i < CS_NR; i++)
414 seq_printf(m, "%8s", names[i]);
418 seq_printf(m, "%5.5s:", cs->cs_name);
419 for (i = 0; i < CS_NR; i++)
420 seq_printf(m, "%8u", atomic_read(&cs->cs_stats[i]));
424 static void cl_env_percpu_refill(void);
427 * Initialize client site.
429 * Perform common initialization (lu_site_init()), and initialize statistical
430 * counters. Also perform global initializations on the first call.
432 int cl_site_init(struct cl_site *s, struct cl_device *d)
437 result = lu_site_init(&s->cs_lu, &d->cd_lu_dev);
439 cache_stats_init(&s->cs_pages, "pages");
440 cache_stats_init(&s->cs_locks, "locks");
441 for (i = 0; i < ARRAY_SIZE(s->cs_pages_state); ++i)
442 atomic_set(&s->cs_pages_state[0], 0);
443 for (i = 0; i < ARRAY_SIZE(s->cs_locks_state); ++i)
444 atomic_set(&s->cs_locks_state[i], 0);
445 cl_env_percpu_refill();
449 EXPORT_SYMBOL(cl_site_init);
452 * Finalize client site. Dual to cl_site_init().
454 void cl_site_fini(struct cl_site *s)
456 lu_site_fini(&s->cs_lu);
458 EXPORT_SYMBOL(cl_site_fini);
460 static struct cache_stats cl_env_stats = {
462 .cs_stats = { ATOMIC_INIT(0), }
466 * Outputs client site statistical counters into a buffer. Suitable for
467 * ll_rd_*()-style functions.
469 int cl_site_stats_print(const struct cl_site *site, struct seq_file *m)
471 static const char *pstate[] = {
478 static const char *lstate[] = {
481 [CLS_ENQUEUED] = "e",
483 [CLS_INTRANSIT] = "t",
490 lookup hit total busy create
491 pages: ...... ...... ...... ...... ...... [...... ...... ...... ......]
492 locks: ...... ...... ...... ...... ...... [...... ...... ...... ...... ......]
493 env: ...... ...... ...... ...... ......
495 lu_site_stats_seq_print(&site->cs_lu, m);
496 cache_stats_print(&site->cs_pages, m, 1);
498 for (i = 0; i < ARRAY_SIZE(site->cs_pages_state); ++i)
499 seq_printf(m, "%s: %u ", pstate[i],
500 atomic_read(&site->cs_pages_state[i]));
501 seq_printf(m, "]\n");
502 cache_stats_print(&site->cs_locks, m, 0);
504 for (i = 0; i < ARRAY_SIZE(site->cs_locks_state); ++i)
505 seq_printf(m, "%s: %u ", lstate[i],
506 atomic_read(&site->cs_locks_state[i]));
507 seq_printf(m, "]\n");
508 cache_stats_print(&cl_env_stats, m, 0);
512 EXPORT_SYMBOL(cl_site_stats_print);
514 /*****************************************************************************
516 * lu_env handling on client.
521 * The most efficient way is to store cl_env pointer in task specific
522 * structures. On Linux, it wont' be easy to use task_struct->journal_info
523 * because Lustre code may call into other fs which has certain assumptions
524 * about journal_info. Currently following fields in task_struct are identified
525 * can be used for this purpose:
526 * - cl_env: for liblustre.
527 * - tux_info: ony on RedHat kernel.
529 * \note As long as we use task_struct to store cl_env, we assume that once
530 * called into Lustre, we'll never call into the other part of the kernel
531 * which will use those fields in task_struct without explicitly exiting
534 * If there's no space in task_struct is available, hash will be used.
538 static struct list_head cl_envs;
539 static unsigned cl_envs_cached_nr = 0;
540 static unsigned cl_envs_cached_max = 128; /* XXX: prototype: arbitrary limit
542 static DEFINE_SPINLOCK(cl_envs_guard);
547 struct lu_context ce_ses;
549 #ifdef LL_TASK_CL_ENV
553 * This allows cl_env to be entered into cl_env_hash which implements
554 * the current thread -> client environment lookup.
556 struct hlist_node ce_node;
559 * Owner for the current cl_env.
561 * If LL_TASK_CL_ENV is defined, this point to the owning current,
562 * only for debugging purpose ;
563 * Otherwise hash is used, and this is the key for cfs_hash.
564 * Now current thread pid is stored. Note using thread pointer would
565 * lead to unbalanced hash because of its specific allocation locality
566 * and could be varied for different platforms and OSes, even different
572 * Linkage into global list of all client environments. Used for
573 * garbage collection.
575 struct list_head ce_linkage;
581 * Debugging field: address of the caller who made original
587 #ifdef CONFIG_DEBUG_PAGESTATE_TRACKING
588 #define CL_ENV_INC(counter) atomic_inc(&cl_env_stats.cs_stats[CS_##counter])
590 #define CL_ENV_DEC(counter) do { \
591 LASSERT(atomic_read(&cl_env_stats.cs_stats[CS_##counter]) > 0); \
592 atomic_dec(&cl_env_stats.cs_stats[CS_##counter]); \
595 #define CL_ENV_INC(counter)
596 #define CL_ENV_DEC(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(struct hlist_node *hn)
630 struct cl_env *cle = hlist_entry(hn, struct cl_env, ce_node);
632 LASSERT(cle->ce_magic == &cl_env_init0);
636 static int cl_env_hops_keycmp(const void *key, struct hlist_node *hn)
638 struct cl_env *cle = cl_env_hops_obj(hn);
640 LASSERT(cle->ce_owner != NULL);
641 return (key == cle->ce_owner);
644 static void cl_env_hops_noop(cfs_hash_t *hs, struct hlist_node *hn)
646 struct cl_env *cle = hlist_entry(hn, struct cl_env, ce_node);
647 LASSERT(cle->ce_magic == &cl_env_init0);
650 static cfs_hash_ops_t cl_env_hops = {
651 .hs_hash = cl_env_hops_hash,
652 .hs_key = cl_env_hops_obj,
653 .hs_keycmp = cl_env_hops_keycmp,
654 .hs_object = cl_env_hops_obj,
655 .hs_get = cl_env_hops_noop,
656 .hs_put_locked = cl_env_hops_noop,
659 static inline struct cl_env *cl_env_fetch(void)
663 cle = cfs_hash_lookup(cl_env_hash, (void *) (long) current->pid);
664 LASSERT(ergo(cle, cle->ce_magic == &cl_env_init0));
668 static inline void cl_env_attach(struct cl_env *cle)
673 LASSERT(cle->ce_owner == NULL);
674 cle->ce_owner = (void *) (long) current->pid;
675 rc = cfs_hash_add_unique(cl_env_hash, cle->ce_owner,
681 static inline void cl_env_do_detach(struct cl_env *cle)
685 LASSERT(cle->ce_owner == (void *) (long) current->pid);
686 cookie = cfs_hash_del(cl_env_hash, cle->ce_owner,
688 LASSERT(cookie == cle);
689 cle->ce_owner = NULL;
692 static int cl_env_store_init(void) {
693 cl_env_hash = cfs_hash_create("cl_env",
694 HASH_CL_ENV_BITS, HASH_CL_ENV_BITS,
695 HASH_CL_ENV_BKT_BITS, 0,
699 CFS_HASH_RW_BKTLOCK);
700 return cl_env_hash != NULL ? 0 :-ENOMEM;
703 static void cl_env_store_fini(void) {
704 cfs_hash_putref(cl_env_hash);
707 #else /* LL_TASK_CL_ENV */
709 * The implementation of store cl_env directly in thread structure.
712 static inline struct cl_env *cl_env_fetch(void)
716 cle = current->LL_TASK_CL_ENV;
717 if (cle && cle->ce_magic != &cl_env_init0)
722 static inline void cl_env_attach(struct cl_env *cle)
725 LASSERT(cle->ce_owner == NULL);
726 cle->ce_owner = current;
727 cle->ce_prev = current->LL_TASK_CL_ENV;
728 current->LL_TASK_CL_ENV = cle;
732 static inline void cl_env_do_detach(struct cl_env *cle)
734 LASSERT(cle->ce_owner == current);
735 LASSERT(current->LL_TASK_CL_ENV == cle);
736 current->LL_TASK_CL_ENV = cle->ce_prev;
737 cle->ce_owner = NULL;
740 static int cl_env_store_init(void) { return 0; }
741 static void cl_env_store_fini(void) { }
743 #endif /* LL_TASK_CL_ENV */
745 static inline struct cl_env *cl_env_detach(struct cl_env *cle)
748 cle = cl_env_fetch();
750 if (cle && cle->ce_owner)
751 cl_env_do_detach(cle);
756 static struct lu_env *cl_env_new(__u32 ctx_tags, __u32 ses_tags, void *debug)
761 OBD_SLAB_ALLOC_PTR_GFP(cle, cl_env_kmem, GFP_NOFS);
765 INIT_LIST_HEAD(&cle->ce_linkage);
766 cle->ce_magic = &cl_env_init0;
768 rc = lu_env_init(env, LCT_CL_THREAD|ctx_tags);
770 rc = lu_context_init(&cle->ce_ses,
771 LCT_SESSION | ses_tags);
773 lu_context_enter(&cle->ce_ses);
774 env->le_ses = &cle->ce_ses;
775 cl_env_init0(cle, debug);
780 OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
787 env = ERR_PTR(-ENOMEM);
791 static void cl_env_fini(struct cl_env *cle)
794 lu_context_fini(&cle->ce_lu.le_ctx);
795 lu_context_fini(&cle->ce_ses);
796 OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
799 static struct lu_env *cl_env_obtain(void *debug)
805 spin_lock(&cl_envs_guard);
806 LASSERT(equi(cl_envs_cached_nr == 0, list_empty(&cl_envs)));
807 if (cl_envs_cached_nr > 0) {
810 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
811 list_del_init(&cle->ce_linkage);
813 spin_unlock(&cl_envs_guard);
816 rc = lu_env_refill(env);
818 cl_env_init0(cle, debug);
819 lu_context_enter(&env->le_ctx);
820 lu_context_enter(&cle->ce_ses);
826 spin_unlock(&cl_envs_guard);
827 env = cl_env_new(lu_context_tags_default,
828 lu_session_tags_default, debug);
833 static inline struct cl_env *cl_env_container(struct lu_env *env)
835 return container_of(env, struct cl_env, ce_lu);
838 struct lu_env *cl_env_peek(int *refcheck)
845 /* check that we don't go far from untrusted pointer */
846 CLASSERT(offsetof(struct cl_env, ce_magic) == 0);
849 cle = cl_env_fetch();
853 *refcheck = ++cle->ce_ref;
855 CDEBUG(D_OTHER, "%d@%p\n", cle ? cle->ce_ref : 0, cle);
858 EXPORT_SYMBOL(cl_env_peek);
861 * Returns lu_env: if there already is an environment associated with the
862 * current thread, it is returned, otherwise, new environment is allocated.
864 * Allocations are amortized through the global cache of environments.
866 * \param refcheck pointer to a counter used to detect environment leaks. In
867 * the usual case cl_env_get() and cl_env_put() are called in the same lexical
868 * scope and pointer to the same integer is passed as \a refcheck. This is
869 * used to detect missed cl_env_put().
873 struct lu_env *cl_env_get(int *refcheck)
877 env = cl_env_peek(refcheck);
879 env = cl_env_obtain(__builtin_return_address(0));
883 cle = cl_env_container(env);
885 *refcheck = cle->ce_ref;
886 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
891 EXPORT_SYMBOL(cl_env_get);
894 * Forces an allocation of a fresh environment with given tags.
898 struct lu_env *cl_env_alloc(int *refcheck, __u32 tags)
902 LASSERT(cl_env_peek(refcheck) == NULL);
903 env = cl_env_new(tags, tags, __builtin_return_address(0));
907 cle = cl_env_container(env);
908 *refcheck = cle->ce_ref;
909 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
913 EXPORT_SYMBOL(cl_env_alloc);
915 static void cl_env_exit(struct cl_env *cle)
917 LASSERT(cle->ce_owner == NULL);
918 lu_context_exit(&cle->ce_lu.le_ctx);
919 lu_context_exit(&cle->ce_ses);
923 * Finalizes and frees a given number of cached environments. This is done to
924 * (1) free some memory (not currently hooked into VM), or (2) release
925 * references to modules.
927 unsigned cl_env_cache_purge(unsigned nr)
932 spin_lock(&cl_envs_guard);
933 for (; !list_empty(&cl_envs) && nr > 0; --nr) {
934 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
935 list_del_init(&cle->ce_linkage);
936 LASSERT(cl_envs_cached_nr > 0);
938 spin_unlock(&cl_envs_guard);
941 spin_lock(&cl_envs_guard);
943 LASSERT(equi(cl_envs_cached_nr == 0, list_empty(&cl_envs)));
944 spin_unlock(&cl_envs_guard);
947 EXPORT_SYMBOL(cl_env_cache_purge);
950 * Release an environment.
952 * Decrement \a env reference counter. When counter drops to 0, nothing in
953 * this thread is using environment and it is returned to the allocation
954 * cache, or freed straight away, if cache is large enough.
956 void cl_env_put(struct lu_env *env, int *refcheck)
960 cle = cl_env_container(env);
962 LASSERT(cle->ce_ref > 0);
963 LASSERT(ergo(refcheck != NULL, cle->ce_ref == *refcheck));
965 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
966 if (--cle->ce_ref == 0) {
969 cle->ce_debug = NULL;
972 * Don't bother to take a lock here.
974 * Return environment to the cache only when it was allocated
975 * with the standard tags.
977 if (cl_envs_cached_nr < cl_envs_cached_max &&
978 (env->le_ctx.lc_tags & ~LCT_HAS_EXIT) == LCT_CL_THREAD &&
979 (env->le_ses->lc_tags & ~LCT_HAS_EXIT) == LCT_SESSION) {
980 spin_lock(&cl_envs_guard);
981 list_add(&cle->ce_linkage, &cl_envs);
983 spin_unlock(&cl_envs_guard);
988 EXPORT_SYMBOL(cl_env_put);
991 * Declares a point of re-entrancy.
993 * \see cl_env_reexit()
995 void *cl_env_reenter(void)
997 return cl_env_detach(NULL);
999 EXPORT_SYMBOL(cl_env_reenter);
1002 * Exits re-entrancy.
1004 void cl_env_reexit(void *cookie)
1006 cl_env_detach(NULL);
1007 cl_env_attach(cookie);
1009 EXPORT_SYMBOL(cl_env_reexit);
1012 * Setup user-supplied \a env as a current environment. This is to be used to
1013 * guaranteed that environment exists even when cl_env_get() fails. It is up
1014 * to user to ensure proper concurrency control.
1016 * \see cl_env_unplant()
1018 void cl_env_implant(struct lu_env *env, int *refcheck)
1020 struct cl_env *cle = cl_env_container(env);
1022 LASSERT(cle->ce_ref > 0);
1025 cl_env_get(refcheck);
1026 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1028 EXPORT_SYMBOL(cl_env_implant);
1031 * Detach environment installed earlier by cl_env_implant().
1033 void cl_env_unplant(struct lu_env *env, int *refcheck)
1035 struct cl_env *cle = cl_env_container(env);
1037 LASSERT(cle->ce_ref > 1);
1039 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1042 cl_env_put(env, refcheck);
1044 EXPORT_SYMBOL(cl_env_unplant);
1046 struct lu_env *cl_env_nested_get(struct cl_env_nest *nest)
1050 nest->cen_cookie = NULL;
1051 env = cl_env_peek(&nest->cen_refcheck);
1053 if (!cl_io_is_going(env))
1056 cl_env_put(env, &nest->cen_refcheck);
1057 nest->cen_cookie = cl_env_reenter();
1060 env = cl_env_get(&nest->cen_refcheck);
1062 cl_env_reexit(nest->cen_cookie);
1066 LASSERT(!cl_io_is_going(env));
1069 EXPORT_SYMBOL(cl_env_nested_get);
1071 void cl_env_nested_put(struct cl_env_nest *nest, struct lu_env *env)
1073 cl_env_put(env, &nest->cen_refcheck);
1074 cl_env_reexit(nest->cen_cookie);
1076 EXPORT_SYMBOL(cl_env_nested_put);
1079 * Converts struct cl_attr to struct ost_lvb.
1083 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr)
1086 lvb->lvb_size = attr->cat_size;
1087 lvb->lvb_mtime = attr->cat_mtime;
1088 lvb->lvb_atime = attr->cat_atime;
1089 lvb->lvb_ctime = attr->cat_ctime;
1090 lvb->lvb_blocks = attr->cat_blocks;
1093 EXPORT_SYMBOL(cl_attr2lvb);
1096 * Converts struct ost_lvb to struct cl_attr.
1100 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb)
1103 attr->cat_size = lvb->lvb_size;
1104 attr->cat_mtime = lvb->lvb_mtime;
1105 attr->cat_atime = lvb->lvb_atime;
1106 attr->cat_ctime = lvb->lvb_ctime;
1107 attr->cat_blocks = lvb->lvb_blocks;
1110 EXPORT_SYMBOL(cl_lvb2attr);
1112 static struct cl_env cl_env_percpu[NR_CPUS];
1114 static int cl_env_percpu_init(void)
1117 int tags = LCT_REMEMBER | LCT_NOREF;
1121 for_each_possible_cpu(i) {
1124 cle = &cl_env_percpu[i];
1127 INIT_LIST_HEAD(&cle->ce_linkage);
1128 cle->ce_magic = &cl_env_init0;
1129 rc = lu_env_init(env, LCT_CL_THREAD | tags);
1131 rc = lu_context_init(&cle->ce_ses, LCT_SESSION | tags);
1133 lu_context_enter(&cle->ce_ses);
1134 env->le_ses = &cle->ce_ses;
1143 /* Indices 0 to i (excluding i) were correctly initialized,
1144 * thus we must uninitialize up to i, the rest are undefined. */
1145 for (j = 0; j < i; j++) {
1146 cle = &cl_env_percpu[i];
1147 lu_context_exit(&cle->ce_ses);
1148 lu_context_fini(&cle->ce_ses);
1149 lu_env_fini(&cle->ce_lu);
1156 static void cl_env_percpu_fini(void)
1160 for_each_possible_cpu(i) {
1161 struct cl_env *cle = &cl_env_percpu[i];
1163 lu_context_exit(&cle->ce_ses);
1164 lu_context_fini(&cle->ce_ses);
1165 lu_env_fini(&cle->ce_lu);
1169 static void cl_env_percpu_refill(void)
1173 for_each_possible_cpu(i)
1174 lu_env_refill(&cl_env_percpu[i].ce_lu);
1177 void cl_env_percpu_put(struct lu_env *env)
1182 cpu = smp_processor_id();
1183 cle = cl_env_container(env);
1184 LASSERT(cle == &cl_env_percpu[cpu]);
1187 LASSERT(cle->ce_ref == 0);
1191 cle->ce_debug = NULL;
1195 EXPORT_SYMBOL(cl_env_percpu_put);
1197 struct lu_env *cl_env_percpu_get()
1201 cle = &cl_env_percpu[get_cpu()];
1202 cl_env_init0(cle, __builtin_return_address(0));
1207 EXPORT_SYMBOL(cl_env_percpu_get);
1209 /*****************************************************************************
1211 * Temporary prototype thing: mirror obd-devices into cl devices.
1215 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
1216 struct lu_device_type *ldt,
1217 struct lu_device *next)
1219 const char *typename;
1220 struct lu_device *d;
1222 LASSERT(ldt != NULL);
1224 typename = ldt->ldt_name;
1225 d = ldt->ldt_ops->ldto_device_alloc(env, ldt, NULL);
1231 rc = ldt->ldt_ops->ldto_device_init(env, d, typename, next);
1234 lu_ref_add(&d->ld_reference,
1235 "lu-stack", &lu_site_init);
1237 ldt->ldt_ops->ldto_device_free(env, d);
1238 CERROR("can't init device '%s', %d\n", typename, rc);
1242 CERROR("Cannot allocate device: '%s'\n", typename);
1243 return lu2cl_dev(d);
1245 EXPORT_SYMBOL(cl_type_setup);
1248 * Finalize device stack by calling lu_stack_fini().
1250 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl)
1252 lu_stack_fini(env, cl2lu_dev(cl));
1254 EXPORT_SYMBOL(cl_stack_fini);
1256 int cl_lock_init(void);
1257 void cl_lock_fini(void);
1259 int cl_page_init(void);
1260 void cl_page_fini(void);
1262 static struct lu_context_key cl_key;
1264 struct cl_thread_info *cl_env_info(const struct lu_env *env)
1266 return lu_context_key_get(&env->le_ctx, &cl_key);
1269 /* defines cl0_key_{init,fini}() */
1270 LU_KEY_INIT_FINI(cl0, struct cl_thread_info);
1272 static void *cl_key_init(const struct lu_context *ctx,
1273 struct lu_context_key *key)
1275 struct cl_thread_info *info;
1277 info = cl0_key_init(ctx, key);
1278 if (!IS_ERR(info)) {
1281 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1282 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1287 static void cl_key_fini(const struct lu_context *ctx,
1288 struct lu_context_key *key, void *data)
1290 struct cl_thread_info *info;
1294 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1295 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1296 cl0_key_fini(ctx, key, data);
1299 static void cl_key_exit(const struct lu_context *ctx,
1300 struct lu_context_key *key, void *data)
1302 struct cl_thread_info *info = data;
1305 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i) {
1306 LASSERT(info->clt_counters[i].ctc_nr_held == 0);
1307 LASSERT(info->clt_counters[i].ctc_nr_used == 0);
1308 LASSERT(info->clt_counters[i].ctc_nr_locks_acquired == 0);
1309 LASSERT(info->clt_counters[i].ctc_nr_locks_locked == 0);
1310 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1311 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1315 static struct lu_context_key cl_key = {
1316 .lct_tags = LCT_CL_THREAD,
1317 .lct_init = cl_key_init,
1318 .lct_fini = cl_key_fini,
1319 .lct_exit = cl_key_exit
1322 static struct lu_kmem_descr cl_object_caches[] = {
1324 .ckd_cache = &cl_env_kmem,
1325 .ckd_name = "cl_env_kmem",
1326 .ckd_size = sizeof (struct cl_env)
1334 * Global initialization of cl-data. Create kmem caches, register
1335 * lu_context_key's, etc.
1337 * \see cl_global_fini()
1339 int cl_global_init(void)
1343 INIT_LIST_HEAD(&cl_envs);
1345 result = cl_env_store_init();
1349 result = lu_kmem_init(cl_object_caches);
1353 LU_CONTEXT_KEY_INIT(&cl_key);
1354 result = lu_context_key_register(&cl_key);
1358 result = cl_lock_init();
1362 result = cl_page_init();
1366 result = cl_env_percpu_init();
1368 /* no cl_env_percpu_fini on error */
1375 lu_context_key_degister(&cl_key);
1377 lu_kmem_fini(cl_object_caches);
1379 cl_env_store_fini();
1384 * Finalization of global cl-data. Dual to cl_global_init().
1386 void cl_global_fini(void)
1388 cl_env_percpu_fini();
1391 lu_context_key_degister(&cl_key);
1392 lu_kmem_fini(cl_object_caches);
1393 cl_env_store_fini();