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>
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 "cl_internal.h"
63 static struct kmem_cache *cl_env_kmem;
65 /** Lock class of cl_object_header::coh_attr_guard */
66 static struct lock_class_key cl_attr_guard_class;
68 extern __u32 lu_context_tags_default;
69 extern __u32 lu_session_tags_default;
71 * Initialize cl_object_header.
73 int cl_object_header_init(struct cl_object_header *h)
78 result = lu_object_header_init(&h->coh_lu);
80 spin_lock_init(&h->coh_attr_guard);
81 lockdep_set_class(&h->coh_attr_guard, &cl_attr_guard_class);
82 h->coh_page_bufsize = 0;
86 EXPORT_SYMBOL(cl_object_header_init);
89 * Finalize cl_object_header.
91 void cl_object_header_fini(struct cl_object_header *h)
93 lu_object_header_fini(&h->coh_lu);
95 EXPORT_SYMBOL(cl_object_header_fini);
98 * Returns a cl_object with a given \a fid.
100 * Returns either cached or newly created object. Additional reference on the
101 * returned object is acquired.
103 * \see lu_object_find(), cl_page_find(), cl_lock_find()
105 struct cl_object *cl_object_find(const struct lu_env *env,
106 struct cl_device *cd, const struct lu_fid *fid,
107 const struct cl_object_conf *c)
110 return lu2cl(lu_object_find_slice(env, cl2lu_dev(cd), fid, &c->coc_lu));
112 EXPORT_SYMBOL(cl_object_find);
115 * Releases a reference on \a o.
117 * When last reference is released object is returned to the cache, unless
118 * lu_object_header_flags::LU_OBJECT_HEARD_BANSHEE bit is set in its header.
120 * \see cl_page_put(), cl_lock_put().
122 void cl_object_put(const struct lu_env *env, struct cl_object *o)
124 lu_object_put(env, &o->co_lu);
126 EXPORT_SYMBOL(cl_object_put);
129 * Acquire an additional reference to the object \a o.
131 * This can only be used to acquire _additional_ reference, i.e., caller
132 * already has to possess at least one reference to \a o before calling this.
134 * \see cl_page_get(), cl_lock_get().
136 void cl_object_get(struct cl_object *o)
138 lu_object_get(&o->co_lu);
140 EXPORT_SYMBOL(cl_object_get);
143 * Returns the top-object for a given \a o.
147 struct cl_object *cl_object_top(struct cl_object *o)
149 struct cl_object_header *hdr = cl_object_header(o);
150 struct cl_object *top;
152 while (hdr->coh_parent != NULL)
153 hdr = hdr->coh_parent;
155 top = lu2cl(lu_object_top(&hdr->coh_lu));
156 CDEBUG(D_TRACE, "%p -> %p\n", o, top);
159 EXPORT_SYMBOL(cl_object_top);
162 * Returns pointer to the lock protecting data-attributes for the given object
165 * Data-attributes are protected by the cl_object_header::coh_attr_guard
166 * spin-lock in the top-object.
168 * \see cl_attr, cl_object_attr_lock(), cl_object_operations::coo_attr_get().
170 static spinlock_t *cl_object_attr_guard(struct cl_object *o)
172 return &cl_object_header(cl_object_top(o))->coh_attr_guard;
176 * Locks data-attributes.
178 * Prevents data-attributes from changing, until lock is released by
179 * cl_object_attr_unlock(). This has to be called before calls to
180 * cl_object_attr_get(), cl_object_attr_set().
182 void cl_object_attr_lock(struct cl_object *o)
183 __acquires(cl_object_attr_guard(o))
185 spin_lock(cl_object_attr_guard(o));
187 EXPORT_SYMBOL(cl_object_attr_lock);
190 * Releases data-attributes lock, acquired by cl_object_attr_lock().
192 void cl_object_attr_unlock(struct cl_object *o)
193 __releases(cl_object_attr_guard(o))
195 spin_unlock(cl_object_attr_guard(o));
197 EXPORT_SYMBOL(cl_object_attr_unlock);
200 * Returns data-attributes of an object \a obj.
202 * Every layer is asked (by calling cl_object_operations::coo_attr_get())
203 * top-to-bottom to fill in parts of \a attr that this layer is responsible
206 int cl_object_attr_get(const struct lu_env *env, struct cl_object *obj,
207 struct cl_attr *attr)
209 struct lu_object_header *top;
212 assert_spin_locked(cl_object_attr_guard(obj));
215 top = obj->co_lu.lo_header;
217 list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
218 if (obj->co_ops->coo_attr_get != NULL) {
219 result = obj->co_ops->coo_attr_get(env, obj, attr);
229 EXPORT_SYMBOL(cl_object_attr_get);
232 * Updates data-attributes of an object \a obj.
234 * Only attributes, mentioned in a validness bit-mask \a v are
235 * updated. Calls cl_object_operations::coo_attr_set() on every layer, bottom
238 int cl_object_attr_set(const struct lu_env *env, struct cl_object *obj,
239 const struct cl_attr *attr, unsigned v)
241 struct lu_object_header *top;
244 assert_spin_locked(cl_object_attr_guard(obj));
247 top = obj->co_lu.lo_header;
249 list_for_each_entry_reverse(obj, &top->loh_layers, co_lu.lo_linkage) {
250 if (obj->co_ops->coo_attr_set != NULL) {
251 result = obj->co_ops->coo_attr_set(env, obj, attr, v);
261 EXPORT_SYMBOL(cl_object_attr_set);
264 * Notifies layers (bottom-to-top) that glimpse AST was received.
266 * Layers have to fill \a lvb fields with information that will be shipped
267 * back to glimpse issuer.
269 * \see cl_lock_operations::clo_glimpse()
271 int cl_object_glimpse(const struct lu_env *env, struct cl_object *obj,
274 struct lu_object_header *top;
278 top = obj->co_lu.lo_header;
280 list_for_each_entry_reverse(obj, &top->loh_layers, co_lu.lo_linkage) {
281 if (obj->co_ops->coo_glimpse != NULL) {
282 result = obj->co_ops->coo_glimpse(env, obj, lvb);
287 LU_OBJECT_HEADER(D_DLMTRACE, env, lu_object_top(top),
288 "size: "LPU64" mtime: "LPU64" atime: "LPU64" "
289 "ctime: "LPU64" blocks: "LPU64"\n",
290 lvb->lvb_size, lvb->lvb_mtime, lvb->lvb_atime,
291 lvb->lvb_ctime, lvb->lvb_blocks);
294 EXPORT_SYMBOL(cl_object_glimpse);
297 * Updates a configuration of an object \a obj.
299 int cl_conf_set(const struct lu_env *env, struct cl_object *obj,
300 const struct cl_object_conf *conf)
302 struct lu_object_header *top;
306 top = obj->co_lu.lo_header;
308 list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
309 if (obj->co_ops->coo_conf_set != NULL) {
310 result = obj->co_ops->coo_conf_set(env, obj, conf);
317 EXPORT_SYMBOL(cl_conf_set);
320 * Prunes caches of pages and locks for this object.
322 int cl_object_prune(const struct lu_env *env, struct cl_object *obj)
324 struct lu_object_header *top;
329 top = obj->co_lu.lo_header;
331 list_for_each_entry(o, &top->loh_layers, co_lu.lo_linkage) {
332 if (o->co_ops->coo_prune != NULL) {
333 result = o->co_ops->coo_prune(env, o);
341 EXPORT_SYMBOL(cl_object_prune);
344 * Helper function removing all object locks, and marking object for
345 * deletion. All object pages must have been deleted at this point.
347 * This is called by cl_inode_fini() and lov_object_delete() to destroy top-
348 * and sub- objects respectively.
350 void cl_object_kill(const struct lu_env *env, struct cl_object *obj)
352 struct cl_object_header *hdr = cl_object_header(obj);
354 set_bit(LU_OBJECT_HEARD_BANSHEE, &hdr->coh_lu.loh_flags);
356 EXPORT_SYMBOL(cl_object_kill);
358 void cache_stats_init(struct cache_stats *cs, const char *name)
363 for (i = 0; i < CS_NR; i++)
364 atomic_set(&cs->cs_stats[i], 0);
367 int cache_stats_print(const struct cache_stats *cs, struct seq_file *m, int h)
372 * lookup hit total cached create
373 * env: ...... ...... ...... ...... ......
376 const char *names[CS_NR] = CS_NAMES;
378 seq_printf(m, "%6s", " ");
379 for (i = 0; i < CS_NR; i++)
380 seq_printf(m, "%8s", names[i]);
384 seq_printf(m, "%5.5s:", cs->cs_name);
385 for (i = 0; i < CS_NR; i++)
386 seq_printf(m, "%8u", atomic_read(&cs->cs_stats[i]));
390 static void cl_env_percpu_refill(void);
393 * Initialize client site.
395 * Perform common initialization (lu_site_init()), and initialize statistical
396 * counters. Also perform global initializations on the first call.
398 int cl_site_init(struct cl_site *s, struct cl_device *d)
403 result = lu_site_init(&s->cs_lu, &d->cd_lu_dev);
405 cache_stats_init(&s->cs_pages, "pages");
406 for (i = 0; i < ARRAY_SIZE(s->cs_pages_state); ++i)
407 atomic_set(&s->cs_pages_state[0], 0);
408 cl_env_percpu_refill();
412 EXPORT_SYMBOL(cl_site_init);
415 * Finalize client site. Dual to cl_site_init().
417 void cl_site_fini(struct cl_site *s)
419 lu_site_fini(&s->cs_lu);
421 EXPORT_SYMBOL(cl_site_fini);
423 static struct cache_stats cl_env_stats = {
425 .cs_stats = { ATOMIC_INIT(0), }
429 * Outputs client site statistical counters into a buffer. Suitable for
430 * ll_rd_*()-style functions.
432 int cl_site_stats_print(const struct cl_site *site, struct seq_file *m)
434 static const char *pstate[] = {
444 lookup hit total busy create
445 pages: ...... ...... ...... ...... ...... [...... ...... ...... ......]
446 locks: ...... ...... ...... ...... ...... [...... ...... ...... ...... ......]
447 env: ...... ...... ...... ...... ......
449 lu_site_stats_seq_print(&site->cs_lu, m);
450 cache_stats_print(&site->cs_pages, m, 1);
452 for (i = 0; i < ARRAY_SIZE(site->cs_pages_state); ++i)
453 seq_printf(m, "%s: %u ", pstate[i],
454 atomic_read(&site->cs_pages_state[i]));
455 seq_printf(m, "]\n");
456 cache_stats_print(&cl_env_stats, m, 0);
460 EXPORT_SYMBOL(cl_site_stats_print);
462 /*****************************************************************************
464 * lu_env handling on client.
469 * The most efficient way is to store cl_env pointer in task specific
470 * structures. On Linux, it wont' be easy to use task_struct->journal_info
471 * because Lustre code may call into other fs which has certain assumptions
472 * about journal_info. Currently following fields in task_struct are identified
473 * can be used for this purpose:
474 * - cl_env: for liblustre.
475 * - tux_info: ony on RedHat kernel.
477 * \note As long as we use task_struct to store cl_env, we assume that once
478 * called into Lustre, we'll never call into the other part of the kernel
479 * which will use those fields in task_struct without explicitly exiting
482 * If there's no space in task_struct is available, hash will be used.
486 static struct list_head cl_envs;
487 static unsigned cl_envs_cached_nr = 0;
488 static unsigned cl_envs_cached_max = 128; /* XXX: prototype: arbitrary limit
490 static DEFINE_SPINLOCK(cl_envs_guard);
495 struct lu_context ce_ses;
497 #ifdef LL_TASK_CL_ENV
501 * This allows cl_env to be entered into cl_env_hash which implements
502 * the current thread -> client environment lookup.
504 struct hlist_node ce_node;
507 * Owner for the current cl_env.
509 * If LL_TASK_CL_ENV is defined, this point to the owning current,
510 * only for debugging purpose ;
511 * Otherwise hash is used, and this is the key for cfs_hash.
512 * Now current thread pid is stored. Note using thread pointer would
513 * lead to unbalanced hash because of its specific allocation locality
514 * and could be varied for different platforms and OSes, even different
520 * Linkage into global list of all client environments. Used for
521 * garbage collection.
523 struct list_head ce_linkage;
529 * Debugging field: address of the caller who made original
535 #ifdef CONFIG_DEBUG_PAGESTATE_TRACKING
536 #define CL_ENV_INC(counter) atomic_inc(&cl_env_stats.cs_stats[CS_##counter])
538 #define CL_ENV_DEC(counter) do { \
539 LASSERT(atomic_read(&cl_env_stats.cs_stats[CS_##counter]) > 0); \
540 atomic_dec(&cl_env_stats.cs_stats[CS_##counter]); \
543 #define CL_ENV_INC(counter)
544 #define CL_ENV_DEC(counter)
547 static void cl_env_init0(struct cl_env *cle, void *debug)
549 LASSERT(cle->ce_ref == 0);
550 LASSERT(cle->ce_magic == &cl_env_init0);
551 LASSERT(cle->ce_debug == NULL && cle->ce_owner == NULL);
554 cle->ce_debug = debug;
559 #ifndef LL_TASK_CL_ENV
561 * The implementation of using hash table to connect cl_env and thread
564 static cfs_hash_t *cl_env_hash;
566 static unsigned cl_env_hops_hash(cfs_hash_t *lh,
567 const void *key, unsigned mask)
569 #if BITS_PER_LONG == 64
570 return cfs_hash_u64_hash((__u64)key, mask);
572 return cfs_hash_u32_hash((__u32)key, mask);
576 static void *cl_env_hops_obj(struct hlist_node *hn)
578 struct cl_env *cle = hlist_entry(hn, struct cl_env, ce_node);
580 LASSERT(cle->ce_magic == &cl_env_init0);
584 static int cl_env_hops_keycmp(const void *key, struct hlist_node *hn)
586 struct cl_env *cle = cl_env_hops_obj(hn);
588 LASSERT(cle->ce_owner != NULL);
589 return (key == cle->ce_owner);
592 static void cl_env_hops_noop(cfs_hash_t *hs, struct hlist_node *hn)
594 struct cl_env *cle = hlist_entry(hn, struct cl_env, ce_node);
595 LASSERT(cle->ce_magic == &cl_env_init0);
598 static cfs_hash_ops_t cl_env_hops = {
599 .hs_hash = cl_env_hops_hash,
600 .hs_key = cl_env_hops_obj,
601 .hs_keycmp = cl_env_hops_keycmp,
602 .hs_object = cl_env_hops_obj,
603 .hs_get = cl_env_hops_noop,
604 .hs_put_locked = cl_env_hops_noop,
607 static inline struct cl_env *cl_env_fetch(void)
611 cle = cfs_hash_lookup(cl_env_hash, (void *) (long) current->pid);
612 LASSERT(ergo(cle, cle->ce_magic == &cl_env_init0));
616 static inline void cl_env_attach(struct cl_env *cle)
621 LASSERT(cle->ce_owner == NULL);
622 cle->ce_owner = (void *) (long) current->pid;
623 rc = cfs_hash_add_unique(cl_env_hash, cle->ce_owner,
629 static inline void cl_env_do_detach(struct cl_env *cle)
633 LASSERT(cle->ce_owner == (void *) (long) current->pid);
634 cookie = cfs_hash_del(cl_env_hash, cle->ce_owner,
636 LASSERT(cookie == cle);
637 cle->ce_owner = NULL;
640 static int cl_env_store_init(void) {
641 cl_env_hash = cfs_hash_create("cl_env",
642 HASH_CL_ENV_BITS, HASH_CL_ENV_BITS,
643 HASH_CL_ENV_BKT_BITS, 0,
647 CFS_HASH_RW_BKTLOCK);
648 return cl_env_hash != NULL ? 0 :-ENOMEM;
651 static void cl_env_store_fini(void) {
652 cfs_hash_putref(cl_env_hash);
655 #else /* LL_TASK_CL_ENV */
657 * The implementation of store cl_env directly in thread structure.
660 static inline struct cl_env *cl_env_fetch(void)
664 cle = current->LL_TASK_CL_ENV;
665 if (cle && cle->ce_magic != &cl_env_init0)
670 static inline void cl_env_attach(struct cl_env *cle)
673 LASSERT(cle->ce_owner == NULL);
674 cle->ce_owner = current;
675 cle->ce_prev = current->LL_TASK_CL_ENV;
676 current->LL_TASK_CL_ENV = cle;
680 static inline void cl_env_do_detach(struct cl_env *cle)
682 LASSERT(cle->ce_owner == current);
683 LASSERT(current->LL_TASK_CL_ENV == cle);
684 current->LL_TASK_CL_ENV = cle->ce_prev;
685 cle->ce_owner = NULL;
688 static int cl_env_store_init(void) { return 0; }
689 static void cl_env_store_fini(void) { }
691 #endif /* LL_TASK_CL_ENV */
693 static inline struct cl_env *cl_env_detach(struct cl_env *cle)
696 cle = cl_env_fetch();
698 if (cle && cle->ce_owner)
699 cl_env_do_detach(cle);
704 static struct lu_env *cl_env_new(__u32 ctx_tags, __u32 ses_tags, void *debug)
709 OBD_SLAB_ALLOC_PTR_GFP(cle, cl_env_kmem, GFP_NOFS);
713 INIT_LIST_HEAD(&cle->ce_linkage);
714 cle->ce_magic = &cl_env_init0;
716 rc = lu_env_init(env, LCT_CL_THREAD|ctx_tags);
718 rc = lu_context_init(&cle->ce_ses,
719 LCT_SESSION | ses_tags);
721 lu_context_enter(&cle->ce_ses);
722 env->le_ses = &cle->ce_ses;
723 cl_env_init0(cle, debug);
728 OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
735 env = ERR_PTR(-ENOMEM);
739 static void cl_env_fini(struct cl_env *cle)
742 lu_context_fini(&cle->ce_lu.le_ctx);
743 lu_context_fini(&cle->ce_ses);
744 OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
747 static struct lu_env *cl_env_obtain(void *debug)
753 spin_lock(&cl_envs_guard);
754 LASSERT(equi(cl_envs_cached_nr == 0, list_empty(&cl_envs)));
755 if (cl_envs_cached_nr > 0) {
758 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
759 list_del_init(&cle->ce_linkage);
761 spin_unlock(&cl_envs_guard);
764 rc = lu_env_refill(env);
766 cl_env_init0(cle, debug);
767 lu_context_enter(&env->le_ctx);
768 lu_context_enter(&cle->ce_ses);
774 spin_unlock(&cl_envs_guard);
775 env = cl_env_new(lu_context_tags_default,
776 lu_session_tags_default, debug);
781 static inline struct cl_env *cl_env_container(struct lu_env *env)
783 return container_of(env, struct cl_env, ce_lu);
786 struct lu_env *cl_env_peek(int *refcheck)
793 /* check that we don't go far from untrusted pointer */
794 CLASSERT(offsetof(struct cl_env, ce_magic) == 0);
797 cle = cl_env_fetch();
801 *refcheck = ++cle->ce_ref;
803 CDEBUG(D_OTHER, "%d@%p\n", cle ? cle->ce_ref : 0, cle);
806 EXPORT_SYMBOL(cl_env_peek);
809 * Returns lu_env: if there already is an environment associated with the
810 * current thread, it is returned, otherwise, new environment is allocated.
812 * Allocations are amortized through the global cache of environments.
814 * \param refcheck pointer to a counter used to detect environment leaks. In
815 * the usual case cl_env_get() and cl_env_put() are called in the same lexical
816 * scope and pointer to the same integer is passed as \a refcheck. This is
817 * used to detect missed cl_env_put().
821 struct lu_env *cl_env_get(int *refcheck)
825 env = cl_env_peek(refcheck);
827 env = cl_env_obtain(__builtin_return_address(0));
831 cle = cl_env_container(env);
833 *refcheck = cle->ce_ref;
834 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
839 EXPORT_SYMBOL(cl_env_get);
842 * Forces an allocation of a fresh environment with given tags.
846 struct lu_env *cl_env_alloc(int *refcheck, __u32 tags)
850 LASSERT(cl_env_peek(refcheck) == NULL);
851 env = cl_env_new(tags, tags, __builtin_return_address(0));
855 cle = cl_env_container(env);
856 *refcheck = cle->ce_ref;
857 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
861 EXPORT_SYMBOL(cl_env_alloc);
863 static void cl_env_exit(struct cl_env *cle)
865 LASSERT(cle->ce_owner == NULL);
866 lu_context_exit(&cle->ce_lu.le_ctx);
867 lu_context_exit(&cle->ce_ses);
871 * Finalizes and frees a given number of cached environments. This is done to
872 * (1) free some memory (not currently hooked into VM), or (2) release
873 * references to modules.
875 unsigned cl_env_cache_purge(unsigned nr)
880 spin_lock(&cl_envs_guard);
881 for (; !list_empty(&cl_envs) && nr > 0; --nr) {
882 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
883 list_del_init(&cle->ce_linkage);
884 LASSERT(cl_envs_cached_nr > 0);
886 spin_unlock(&cl_envs_guard);
889 spin_lock(&cl_envs_guard);
891 LASSERT(equi(cl_envs_cached_nr == 0, list_empty(&cl_envs)));
892 spin_unlock(&cl_envs_guard);
895 EXPORT_SYMBOL(cl_env_cache_purge);
898 * Release an environment.
900 * Decrement \a env reference counter. When counter drops to 0, nothing in
901 * this thread is using environment and it is returned to the allocation
902 * cache, or freed straight away, if cache is large enough.
904 void cl_env_put(struct lu_env *env, int *refcheck)
908 cle = cl_env_container(env);
910 LASSERT(cle->ce_ref > 0);
911 LASSERT(ergo(refcheck != NULL, cle->ce_ref == *refcheck));
913 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
914 if (--cle->ce_ref == 0) {
917 cle->ce_debug = NULL;
920 * Don't bother to take a lock here.
922 * Return environment to the cache only when it was allocated
923 * with the standard tags.
925 if (cl_envs_cached_nr < cl_envs_cached_max &&
926 (env->le_ctx.lc_tags & ~LCT_HAS_EXIT) == LCT_CL_THREAD &&
927 (env->le_ses->lc_tags & ~LCT_HAS_EXIT) == LCT_SESSION) {
928 spin_lock(&cl_envs_guard);
929 list_add(&cle->ce_linkage, &cl_envs);
931 spin_unlock(&cl_envs_guard);
936 EXPORT_SYMBOL(cl_env_put);
939 * Declares a point of re-entrancy.
941 * \see cl_env_reexit()
943 void *cl_env_reenter(void)
945 return cl_env_detach(NULL);
947 EXPORT_SYMBOL(cl_env_reenter);
952 void cl_env_reexit(void *cookie)
955 cl_env_attach(cookie);
957 EXPORT_SYMBOL(cl_env_reexit);
960 * Setup user-supplied \a env as a current environment. This is to be used to
961 * guaranteed that environment exists even when cl_env_get() fails. It is up
962 * to user to ensure proper concurrency control.
964 * \see cl_env_unplant()
966 void cl_env_implant(struct lu_env *env, int *refcheck)
968 struct cl_env *cle = cl_env_container(env);
970 LASSERT(cle->ce_ref > 0);
973 cl_env_get(refcheck);
974 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
976 EXPORT_SYMBOL(cl_env_implant);
979 * Detach environment installed earlier by cl_env_implant().
981 void cl_env_unplant(struct lu_env *env, int *refcheck)
983 struct cl_env *cle = cl_env_container(env);
985 LASSERT(cle->ce_ref > 1);
987 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
990 cl_env_put(env, refcheck);
992 EXPORT_SYMBOL(cl_env_unplant);
994 struct lu_env *cl_env_nested_get(struct cl_env_nest *nest)
998 nest->cen_cookie = NULL;
999 env = cl_env_peek(&nest->cen_refcheck);
1001 if (!cl_io_is_going(env))
1004 cl_env_put(env, &nest->cen_refcheck);
1005 nest->cen_cookie = cl_env_reenter();
1008 env = cl_env_get(&nest->cen_refcheck);
1010 cl_env_reexit(nest->cen_cookie);
1014 LASSERT(!cl_io_is_going(env));
1017 EXPORT_SYMBOL(cl_env_nested_get);
1019 void cl_env_nested_put(struct cl_env_nest *nest, struct lu_env *env)
1021 cl_env_put(env, &nest->cen_refcheck);
1022 cl_env_reexit(nest->cen_cookie);
1024 EXPORT_SYMBOL(cl_env_nested_put);
1027 * Converts struct cl_attr to struct ost_lvb.
1031 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr)
1034 lvb->lvb_size = attr->cat_size;
1035 lvb->lvb_mtime = attr->cat_mtime;
1036 lvb->lvb_atime = attr->cat_atime;
1037 lvb->lvb_ctime = attr->cat_ctime;
1038 lvb->lvb_blocks = attr->cat_blocks;
1041 EXPORT_SYMBOL(cl_attr2lvb);
1044 * Converts struct ost_lvb to struct cl_attr.
1048 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb)
1051 attr->cat_size = lvb->lvb_size;
1052 attr->cat_mtime = lvb->lvb_mtime;
1053 attr->cat_atime = lvb->lvb_atime;
1054 attr->cat_ctime = lvb->lvb_ctime;
1055 attr->cat_blocks = lvb->lvb_blocks;
1058 EXPORT_SYMBOL(cl_lvb2attr);
1060 static struct cl_env cl_env_percpu[NR_CPUS];
1062 static int cl_env_percpu_init(void)
1065 int tags = LCT_REMEMBER | LCT_NOREF;
1069 for_each_possible_cpu(i) {
1072 cle = &cl_env_percpu[i];
1075 INIT_LIST_HEAD(&cle->ce_linkage);
1076 cle->ce_magic = &cl_env_init0;
1077 rc = lu_env_init(env, LCT_CL_THREAD | tags);
1079 rc = lu_context_init(&cle->ce_ses, LCT_SESSION | tags);
1081 lu_context_enter(&cle->ce_ses);
1082 env->le_ses = &cle->ce_ses;
1091 /* Indices 0 to i (excluding i) were correctly initialized,
1092 * thus we must uninitialize up to i, the rest are undefined. */
1093 for (j = 0; j < i; j++) {
1094 cle = &cl_env_percpu[i];
1095 lu_context_exit(&cle->ce_ses);
1096 lu_context_fini(&cle->ce_ses);
1097 lu_env_fini(&cle->ce_lu);
1104 static void cl_env_percpu_fini(void)
1108 for_each_possible_cpu(i) {
1109 struct cl_env *cle = &cl_env_percpu[i];
1111 lu_context_exit(&cle->ce_ses);
1112 lu_context_fini(&cle->ce_ses);
1113 lu_env_fini(&cle->ce_lu);
1117 static void cl_env_percpu_refill(void)
1121 for_each_possible_cpu(i)
1122 lu_env_refill(&cl_env_percpu[i].ce_lu);
1125 void cl_env_percpu_put(struct lu_env *env)
1130 cpu = smp_processor_id();
1131 cle = cl_env_container(env);
1132 LASSERT(cle == &cl_env_percpu[cpu]);
1135 LASSERT(cle->ce_ref == 0);
1139 cle->ce_debug = NULL;
1143 EXPORT_SYMBOL(cl_env_percpu_put);
1145 struct lu_env *cl_env_percpu_get()
1149 cle = &cl_env_percpu[get_cpu()];
1150 cl_env_init0(cle, __builtin_return_address(0));
1155 EXPORT_SYMBOL(cl_env_percpu_get);
1157 /*****************************************************************************
1159 * Temporary prototype thing: mirror obd-devices into cl devices.
1163 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
1164 struct lu_device_type *ldt,
1165 struct lu_device *next)
1167 const char *typename;
1168 struct lu_device *d;
1170 LASSERT(ldt != NULL);
1172 typename = ldt->ldt_name;
1173 d = ldt->ldt_ops->ldto_device_alloc(env, ldt, NULL);
1179 rc = ldt->ldt_ops->ldto_device_init(env, d, typename, next);
1182 lu_ref_add(&d->ld_reference,
1183 "lu-stack", &lu_site_init);
1185 ldt->ldt_ops->ldto_device_free(env, d);
1186 CERROR("can't init device '%s', %d\n", typename, rc);
1190 CERROR("Cannot allocate device: '%s'\n", typename);
1191 return lu2cl_dev(d);
1193 EXPORT_SYMBOL(cl_type_setup);
1196 * Finalize device stack by calling lu_stack_fini().
1198 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl)
1200 lu_stack_fini(env, cl2lu_dev(cl));
1202 EXPORT_SYMBOL(cl_stack_fini);
1204 static struct lu_context_key cl_key;
1206 struct cl_thread_info *cl_env_info(const struct lu_env *env)
1208 return lu_context_key_get(&env->le_ctx, &cl_key);
1211 /* defines cl0_key_{init,fini}() */
1212 LU_KEY_INIT_FINI(cl0, struct cl_thread_info);
1214 static void *cl_key_init(const struct lu_context *ctx,
1215 struct lu_context_key *key)
1217 struct cl_thread_info *info;
1219 info = cl0_key_init(ctx, key);
1220 if (!IS_ERR(info)) {
1223 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1224 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1229 static void cl_key_fini(const struct lu_context *ctx,
1230 struct lu_context_key *key, void *data)
1232 struct cl_thread_info *info;
1236 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1237 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1238 cl0_key_fini(ctx, key, data);
1241 static void cl_key_exit(const struct lu_context *ctx,
1242 struct lu_context_key *key, void *data)
1244 struct cl_thread_info *info = data;
1247 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i) {
1248 LASSERT(info->clt_counters[i].ctc_nr_held == 0);
1249 LASSERT(info->clt_counters[i].ctc_nr_used == 0);
1250 LASSERT(info->clt_counters[i].ctc_nr_locks_acquired == 0);
1251 LASSERT(info->clt_counters[i].ctc_nr_locks_locked == 0);
1252 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1253 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1257 static struct lu_context_key cl_key = {
1258 .lct_tags = LCT_CL_THREAD,
1259 .lct_init = cl_key_init,
1260 .lct_fini = cl_key_fini,
1261 .lct_exit = cl_key_exit
1264 static struct lu_kmem_descr cl_object_caches[] = {
1266 .ckd_cache = &cl_env_kmem,
1267 .ckd_name = "cl_env_kmem",
1268 .ckd_size = sizeof (struct cl_env)
1276 * Global initialization of cl-data. Create kmem caches, register
1277 * lu_context_key's, etc.
1279 * \see cl_global_fini()
1281 int cl_global_init(void)
1285 INIT_LIST_HEAD(&cl_envs);
1287 result = cl_env_store_init();
1291 result = lu_kmem_init(cl_object_caches);
1295 LU_CONTEXT_KEY_INIT(&cl_key);
1296 result = lu_context_key_register(&cl_key);
1300 result = cl_env_percpu_init();
1302 /* no cl_env_percpu_fini on error */
1308 lu_context_key_degister(&cl_key);
1310 lu_kmem_fini(cl_object_caches);
1312 cl_env_store_fini();
1317 * Finalization of global cl-data. Dual to cl_global_init().
1319 void cl_global_fini(void)
1321 cl_env_percpu_fini();
1322 lu_context_key_degister(&cl_key);
1323 lu_kmem_fini(cl_object_caches);
1324 cl_env_store_fini();