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);
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 * Find whether there is any callback data (ldlm lock) attached upon this
368 int cl_object_find_cbdata(const struct lu_env *env, struct cl_object *obj,
369 ldlm_iterator_t iter, void *data)
371 struct lu_object_header *top;
375 top = obj->co_lu.lo_header;
376 list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
377 if (obj->co_ops->coo_find_cbdata != NULL) {
378 result = obj->co_ops->coo_find_cbdata(env, obj, iter,
386 EXPORT_SYMBOL(cl_object_find_cbdata);
389 * Get fiemap extents from file object.
391 * \param env [in] lustre environment
392 * \param obj [in] file object
393 * \param key [in] fiemap request argument
394 * \param fiemap [out] fiemap extents mapping retrived
395 * \param buflen [in] max buffer length of @fiemap
400 int cl_object_fiemap(const struct lu_env *env, struct cl_object *obj,
401 struct ll_fiemap_info_key *key,
402 struct fiemap *fiemap, size_t *buflen)
404 struct lu_object_header *top;
408 top = obj->co_lu.lo_header;
409 list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
410 if (obj->co_ops->coo_fiemap != NULL) {
411 result = obj->co_ops->coo_fiemap(env, obj, key, fiemap,
419 EXPORT_SYMBOL(cl_object_fiemap);
421 int cl_object_obd_info_get(const struct lu_env *env, struct cl_object *obj,
422 struct obd_info *oinfo,
423 struct ptlrpc_request_set *set)
425 struct lu_object_header *top;
429 top = obj->co_lu.lo_header;
430 list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
431 if (obj->co_ops->coo_obd_info_get != NULL) {
432 result = obj->co_ops->coo_obd_info_get(env, obj, oinfo,
440 EXPORT_SYMBOL(cl_object_obd_info_get);
442 int cl_object_data_version(const struct lu_env *env, struct cl_object *obj,
443 __u64 *data_version, int flags)
445 struct lu_object_header *top;
449 top = obj->co_lu.lo_header;
450 list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
451 if (obj->co_ops->coo_data_version != NULL) {
452 result = obj->co_ops->coo_data_version(env, obj,
453 data_version, flags);
460 EXPORT_SYMBOL(cl_object_data_version);
462 int cl_object_layout_get(const struct lu_env *env, struct cl_object *obj,
463 struct cl_layout *cl)
465 struct lu_object_header *top = obj->co_lu.lo_header;
468 list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
469 if (obj->co_ops->coo_layout_get != NULL)
470 return obj->co_ops->coo_layout_get(env, obj, cl);
475 EXPORT_SYMBOL(cl_object_layout_get);
478 * Helper function removing all object locks, and marking object for
479 * deletion. All object pages must have been deleted at this point.
481 * This is called by cl_inode_fini() and lov_object_delete() to destroy top-
482 * and sub- objects respectively.
484 void cl_object_kill(const struct lu_env *env, struct cl_object *obj)
486 struct cl_object_header *hdr = cl_object_header(obj);
488 set_bit(LU_OBJECT_HEARD_BANSHEE, &hdr->coh_lu.loh_flags);
490 EXPORT_SYMBOL(cl_object_kill);
492 void cache_stats_init(struct cache_stats *cs, const char *name)
497 for (i = 0; i < CS_NR; i++)
498 atomic_set(&cs->cs_stats[i], 0);
501 static int cache_stats_print(const struct cache_stats *cs,
502 struct seq_file *m, int h)
507 * lookup hit total cached create
508 * env: ...... ...... ...... ...... ......
511 const char *names[CS_NR] = CS_NAMES;
513 seq_printf(m, "%6s", " ");
514 for (i = 0; i < CS_NR; i++)
515 seq_printf(m, "%8s", names[i]);
519 seq_printf(m, "%5.5s:", cs->cs_name);
520 for (i = 0; i < CS_NR; i++)
521 seq_printf(m, "%8u", atomic_read(&cs->cs_stats[i]));
525 static void cl_env_percpu_refill(void);
528 * Initialize client site.
530 * Perform common initialization (lu_site_init()), and initialize statistical
531 * counters. Also perform global initializations on the first call.
533 int cl_site_init(struct cl_site *s, struct cl_device *d)
538 result = lu_site_init(&s->cs_lu, &d->cd_lu_dev);
540 cache_stats_init(&s->cs_pages, "pages");
541 for (i = 0; i < ARRAY_SIZE(s->cs_pages_state); ++i)
542 atomic_set(&s->cs_pages_state[0], 0);
543 cl_env_percpu_refill();
547 EXPORT_SYMBOL(cl_site_init);
550 * Finalize client site. Dual to cl_site_init().
552 void cl_site_fini(struct cl_site *s)
554 lu_site_fini(&s->cs_lu);
556 EXPORT_SYMBOL(cl_site_fini);
558 static struct cache_stats cl_env_stats = {
560 .cs_stats = { ATOMIC_INIT(0), }
564 * Outputs client site statistical counters into a buffer. Suitable for
565 * ll_rd_*()-style functions.
567 int cl_site_stats_print(const struct cl_site *site, struct seq_file *m)
569 static const char *pstate[] = {
579 lookup hit total busy create
580 pages: ...... ...... ...... ...... ...... [...... ...... ...... ......]
581 locks: ...... ...... ...... ...... ...... [...... ...... ...... ...... ......]
582 env: ...... ...... ...... ...... ......
584 lu_site_stats_seq_print(&site->cs_lu, m);
585 cache_stats_print(&site->cs_pages, m, 1);
587 for (i = 0; i < ARRAY_SIZE(site->cs_pages_state); ++i)
588 seq_printf(m, "%s: %u ", pstate[i],
589 atomic_read(&site->cs_pages_state[i]));
590 seq_printf(m, "]\n");
591 cache_stats_print(&cl_env_stats, m, 0);
595 EXPORT_SYMBOL(cl_site_stats_print);
597 /*****************************************************************************
599 * lu_env handling on client.
604 * The most efficient way is to store cl_env pointer in task specific
605 * structures. On Linux, it wont' be easy to use task_struct->journal_info
606 * because Lustre code may call into other fs which has certain assumptions
607 * about journal_info. Currently following fields in task_struct are identified
608 * can be used for this purpose:
609 * - cl_env: for liblustre.
610 * - tux_info: ony on RedHat kernel.
612 * \note As long as we use task_struct to store cl_env, we assume that once
613 * called into Lustre, we'll never call into the other part of the kernel
614 * which will use those fields in task_struct without explicitly exiting
617 * If there's no space in task_struct is available, hash will be used.
621 static struct list_head cl_envs;
622 static unsigned cl_envs_cached_nr = 0;
623 static unsigned cl_envs_cached_max = 128; /* XXX: prototype: arbitrary limit
625 static DEFINE_SPINLOCK(cl_envs_guard);
630 struct lu_context ce_ses;
632 #ifdef LL_TASK_CL_ENV
636 * This allows cl_env to be entered into cl_env_hash which implements
637 * the current thread -> client environment lookup.
639 struct hlist_node ce_node;
642 * Owner for the current cl_env.
644 * If LL_TASK_CL_ENV is defined, this point to the owning current,
645 * only for debugging purpose ;
646 * Otherwise hash is used, and this is the key for cfs_hash.
647 * Now current thread pid is stored. Note using thread pointer would
648 * lead to unbalanced hash because of its specific allocation locality
649 * and could be varied for different platforms and OSes, even different
655 * Linkage into global list of all client environments. Used for
656 * garbage collection.
658 struct list_head ce_linkage;
664 * Debugging field: address of the caller who made original
670 #ifdef CONFIG_DEBUG_PAGESTATE_TRACKING
671 #define CL_ENV_INC(counter) atomic_inc(&cl_env_stats.cs_stats[CS_##counter])
673 #define CL_ENV_DEC(counter) do { \
674 LASSERT(atomic_read(&cl_env_stats.cs_stats[CS_##counter]) > 0); \
675 atomic_dec(&cl_env_stats.cs_stats[CS_##counter]); \
678 #define CL_ENV_INC(counter)
679 #define CL_ENV_DEC(counter)
682 static void cl_env_init0(struct cl_env *cle, void *debug)
684 LASSERT(cle->ce_ref == 0);
685 LASSERT(cle->ce_magic == &cl_env_init0);
686 LASSERT(cle->ce_debug == NULL && cle->ce_owner == NULL);
689 cle->ce_debug = debug;
694 #ifndef LL_TASK_CL_ENV
696 * The implementation of using hash table to connect cl_env and thread
699 static cfs_hash_t *cl_env_hash;
701 static unsigned cl_env_hops_hash(cfs_hash_t *lh,
702 const void *key, unsigned mask)
704 #if BITS_PER_LONG == 64
705 return cfs_hash_u64_hash((__u64)key, mask);
707 return cfs_hash_u32_hash((__u32)key, mask);
711 static void *cl_env_hops_obj(struct hlist_node *hn)
713 struct cl_env *cle = hlist_entry(hn, struct cl_env, ce_node);
715 LASSERT(cle->ce_magic == &cl_env_init0);
719 static int cl_env_hops_keycmp(const void *key, struct hlist_node *hn)
721 struct cl_env *cle = cl_env_hops_obj(hn);
723 LASSERT(cle->ce_owner != NULL);
724 return (key == cle->ce_owner);
727 static void cl_env_hops_noop(cfs_hash_t *hs, struct hlist_node *hn)
729 struct cl_env *cle = hlist_entry(hn, struct cl_env, ce_node);
730 LASSERT(cle->ce_magic == &cl_env_init0);
733 static cfs_hash_ops_t cl_env_hops = {
734 .hs_hash = cl_env_hops_hash,
735 .hs_key = cl_env_hops_obj,
736 .hs_keycmp = cl_env_hops_keycmp,
737 .hs_object = cl_env_hops_obj,
738 .hs_get = cl_env_hops_noop,
739 .hs_put_locked = cl_env_hops_noop,
742 static inline struct cl_env *cl_env_fetch(void)
746 cle = cfs_hash_lookup(cl_env_hash, (void *) (long) current->pid);
747 LASSERT(ergo(cle, cle->ce_magic == &cl_env_init0));
751 static inline void cl_env_attach(struct cl_env *cle)
756 LASSERT(cle->ce_owner == NULL);
757 cle->ce_owner = (void *) (long) current->pid;
758 rc = cfs_hash_add_unique(cl_env_hash, cle->ce_owner,
764 static inline void cl_env_do_detach(struct cl_env *cle)
768 LASSERT(cle->ce_owner == (void *) (long) current->pid);
769 cookie = cfs_hash_del(cl_env_hash, cle->ce_owner,
771 LASSERT(cookie == cle);
772 cle->ce_owner = NULL;
775 static int cl_env_store_init(void) {
776 cl_env_hash = cfs_hash_create("cl_env",
777 HASH_CL_ENV_BITS, HASH_CL_ENV_BITS,
778 HASH_CL_ENV_BKT_BITS, 0,
782 CFS_HASH_RW_BKTLOCK);
783 return cl_env_hash != NULL ? 0 :-ENOMEM;
786 static void cl_env_store_fini(void) {
787 cfs_hash_putref(cl_env_hash);
790 #else /* LL_TASK_CL_ENV */
792 * The implementation of store cl_env directly in thread structure.
795 static inline struct cl_env *cl_env_fetch(void)
799 cle = current->LL_TASK_CL_ENV;
800 if (cle && cle->ce_magic != &cl_env_init0)
805 static inline void cl_env_attach(struct cl_env *cle)
808 LASSERT(cle->ce_owner == NULL);
809 cle->ce_owner = current;
810 cle->ce_prev = current->LL_TASK_CL_ENV;
811 current->LL_TASK_CL_ENV = cle;
815 static inline void cl_env_do_detach(struct cl_env *cle)
817 LASSERT(cle->ce_owner == current);
818 LASSERT(current->LL_TASK_CL_ENV == cle);
819 current->LL_TASK_CL_ENV = cle->ce_prev;
820 cle->ce_owner = NULL;
823 static int cl_env_store_init(void) { return 0; }
824 static void cl_env_store_fini(void) { }
826 #endif /* LL_TASK_CL_ENV */
828 static inline struct cl_env *cl_env_detach(struct cl_env *cle)
831 cle = cl_env_fetch();
833 if (cle && cle->ce_owner)
834 cl_env_do_detach(cle);
839 static struct lu_env *cl_env_new(__u32 ctx_tags, __u32 ses_tags, void *debug)
844 OBD_SLAB_ALLOC_PTR_GFP(cle, cl_env_kmem, GFP_NOFS);
848 INIT_LIST_HEAD(&cle->ce_linkage);
849 cle->ce_magic = &cl_env_init0;
851 rc = lu_env_init(env, LCT_CL_THREAD|ctx_tags);
853 rc = lu_context_init(&cle->ce_ses,
854 LCT_SESSION | ses_tags);
856 lu_context_enter(&cle->ce_ses);
857 env->le_ses = &cle->ce_ses;
858 cl_env_init0(cle, debug);
863 OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
870 env = ERR_PTR(-ENOMEM);
874 static void cl_env_fini(struct cl_env *cle)
877 lu_context_fini(&cle->ce_lu.le_ctx);
878 lu_context_fini(&cle->ce_ses);
879 OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
882 static struct lu_env *cl_env_obtain(void *debug)
888 spin_lock(&cl_envs_guard);
889 LASSERT(equi(cl_envs_cached_nr == 0, list_empty(&cl_envs)));
890 if (cl_envs_cached_nr > 0) {
893 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
894 list_del_init(&cle->ce_linkage);
896 spin_unlock(&cl_envs_guard);
899 rc = lu_env_refill(env);
901 cl_env_init0(cle, debug);
902 lu_context_enter(&env->le_ctx);
903 lu_context_enter(&cle->ce_ses);
909 spin_unlock(&cl_envs_guard);
910 env = cl_env_new(lu_context_tags_default,
911 lu_session_tags_default, debug);
916 static inline struct cl_env *cl_env_container(struct lu_env *env)
918 return container_of(env, struct cl_env, ce_lu);
921 struct lu_env *cl_env_peek(int *refcheck)
928 /* check that we don't go far from untrusted pointer */
929 CLASSERT(offsetof(struct cl_env, ce_magic) == 0);
932 cle = cl_env_fetch();
936 *refcheck = ++cle->ce_ref;
938 CDEBUG(D_OTHER, "%d@%p\n", cle ? cle->ce_ref : 0, cle);
943 * Returns lu_env: if there already is an environment associated with the
944 * current thread, it is returned, otherwise, new environment is allocated.
946 * Allocations are amortized through the global cache of environments.
948 * \param refcheck pointer to a counter used to detect environment leaks. In
949 * the usual case cl_env_get() and cl_env_put() are called in the same lexical
950 * scope and pointer to the same integer is passed as \a refcheck. This is
951 * used to detect missed cl_env_put().
955 struct lu_env *cl_env_get(int *refcheck)
959 env = cl_env_peek(refcheck);
961 env = cl_env_obtain(__builtin_return_address(0));
965 cle = cl_env_container(env);
967 *refcheck = cle->ce_ref;
968 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
973 EXPORT_SYMBOL(cl_env_get);
976 * Forces an allocation of a fresh environment with given tags.
980 struct lu_env *cl_env_alloc(int *refcheck, __u32 tags)
984 LASSERT(cl_env_peek(refcheck) == NULL);
985 env = cl_env_new(tags, tags, __builtin_return_address(0));
989 cle = cl_env_container(env);
990 *refcheck = cle->ce_ref;
991 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
995 EXPORT_SYMBOL(cl_env_alloc);
997 static void cl_env_exit(struct cl_env *cle)
999 LASSERT(cle->ce_owner == NULL);
1000 lu_context_exit(&cle->ce_lu.le_ctx);
1001 lu_context_exit(&cle->ce_ses);
1005 * Finalizes and frees a given number of cached environments. This is done to
1006 * (1) free some memory (not currently hooked into VM), or (2) release
1007 * references to modules.
1009 unsigned cl_env_cache_purge(unsigned nr)
1014 spin_lock(&cl_envs_guard);
1015 for (; !list_empty(&cl_envs) && nr > 0; --nr) {
1016 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
1017 list_del_init(&cle->ce_linkage);
1018 LASSERT(cl_envs_cached_nr > 0);
1019 cl_envs_cached_nr--;
1020 spin_unlock(&cl_envs_guard);
1023 spin_lock(&cl_envs_guard);
1025 LASSERT(equi(cl_envs_cached_nr == 0, list_empty(&cl_envs)));
1026 spin_unlock(&cl_envs_guard);
1029 EXPORT_SYMBOL(cl_env_cache_purge);
1032 * Release an environment.
1034 * Decrement \a env reference counter. When counter drops to 0, nothing in
1035 * this thread is using environment and it is returned to the allocation
1036 * cache, or freed straight away, if cache is large enough.
1038 void cl_env_put(struct lu_env *env, int *refcheck)
1042 cle = cl_env_container(env);
1044 LASSERT(cle->ce_ref > 0);
1045 LASSERT(ergo(refcheck != NULL, cle->ce_ref == *refcheck));
1047 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1048 if (--cle->ce_ref == 0) {
1051 cle->ce_debug = NULL;
1054 * Don't bother to take a lock here.
1056 * Return environment to the cache only when it was allocated
1057 * with the standard tags.
1059 if (cl_envs_cached_nr < cl_envs_cached_max &&
1060 (env->le_ctx.lc_tags & ~LCT_HAS_EXIT) == LCT_CL_THREAD &&
1061 (env->le_ses->lc_tags & ~LCT_HAS_EXIT) == LCT_SESSION) {
1062 spin_lock(&cl_envs_guard);
1063 list_add(&cle->ce_linkage, &cl_envs);
1064 cl_envs_cached_nr++;
1065 spin_unlock(&cl_envs_guard);
1070 EXPORT_SYMBOL(cl_env_put);
1073 * Declares a point of re-entrancy.
1075 * \see cl_env_reexit()
1077 void *cl_env_reenter(void)
1079 return cl_env_detach(NULL);
1081 EXPORT_SYMBOL(cl_env_reenter);
1084 * Exits re-entrancy.
1086 void cl_env_reexit(void *cookie)
1088 cl_env_detach(NULL);
1089 cl_env_attach(cookie);
1091 EXPORT_SYMBOL(cl_env_reexit);
1094 * Setup user-supplied \a env as a current environment. This is to be used to
1095 * guaranteed that environment exists even when cl_env_get() fails. It is up
1096 * to user to ensure proper concurrency control.
1098 * \see cl_env_unplant()
1100 void cl_env_implant(struct lu_env *env, int *refcheck)
1102 struct cl_env *cle = cl_env_container(env);
1104 LASSERT(cle->ce_ref > 0);
1107 cl_env_get(refcheck);
1108 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1110 EXPORT_SYMBOL(cl_env_implant);
1113 * Detach environment installed earlier by cl_env_implant().
1115 void cl_env_unplant(struct lu_env *env, int *refcheck)
1117 struct cl_env *cle = cl_env_container(env);
1119 LASSERT(cle->ce_ref > 1);
1121 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1124 cl_env_put(env, refcheck);
1126 EXPORT_SYMBOL(cl_env_unplant);
1128 struct lu_env *cl_env_nested_get(struct cl_env_nest *nest)
1132 nest->cen_cookie = NULL;
1133 env = cl_env_peek(&nest->cen_refcheck);
1135 if (!cl_io_is_going(env))
1138 cl_env_put(env, &nest->cen_refcheck);
1139 nest->cen_cookie = cl_env_reenter();
1142 env = cl_env_get(&nest->cen_refcheck);
1144 cl_env_reexit(nest->cen_cookie);
1148 LASSERT(!cl_io_is_going(env));
1151 EXPORT_SYMBOL(cl_env_nested_get);
1153 void cl_env_nested_put(struct cl_env_nest *nest, struct lu_env *env)
1155 cl_env_put(env, &nest->cen_refcheck);
1156 cl_env_reexit(nest->cen_cookie);
1158 EXPORT_SYMBOL(cl_env_nested_put);
1161 * Converts struct cl_attr to struct ost_lvb.
1165 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr)
1168 lvb->lvb_size = attr->cat_size;
1169 lvb->lvb_mtime = attr->cat_mtime;
1170 lvb->lvb_atime = attr->cat_atime;
1171 lvb->lvb_ctime = attr->cat_ctime;
1172 lvb->lvb_blocks = attr->cat_blocks;
1177 * Converts struct ost_lvb to struct cl_attr.
1181 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb)
1184 attr->cat_size = lvb->lvb_size;
1185 attr->cat_mtime = lvb->lvb_mtime;
1186 attr->cat_atime = lvb->lvb_atime;
1187 attr->cat_ctime = lvb->lvb_ctime;
1188 attr->cat_blocks = lvb->lvb_blocks;
1191 EXPORT_SYMBOL(cl_lvb2attr);
1193 static struct cl_env cl_env_percpu[NR_CPUS];
1195 static int cl_env_percpu_init(void)
1198 int tags = LCT_REMEMBER | LCT_NOREF;
1202 for_each_possible_cpu(i) {
1205 cle = &cl_env_percpu[i];
1208 INIT_LIST_HEAD(&cle->ce_linkage);
1209 cle->ce_magic = &cl_env_init0;
1210 rc = lu_env_init(env, LCT_CL_THREAD | tags);
1212 rc = lu_context_init(&cle->ce_ses, LCT_SESSION | tags);
1214 lu_context_enter(&cle->ce_ses);
1215 env->le_ses = &cle->ce_ses;
1224 /* Indices 0 to i (excluding i) were correctly initialized,
1225 * thus we must uninitialize up to i, the rest are undefined. */
1226 for (j = 0; j < i; j++) {
1227 cle = &cl_env_percpu[i];
1228 lu_context_exit(&cle->ce_ses);
1229 lu_context_fini(&cle->ce_ses);
1230 lu_env_fini(&cle->ce_lu);
1237 static void cl_env_percpu_fini(void)
1241 for_each_possible_cpu(i) {
1242 struct cl_env *cle = &cl_env_percpu[i];
1244 lu_context_exit(&cle->ce_ses);
1245 lu_context_fini(&cle->ce_ses);
1246 lu_env_fini(&cle->ce_lu);
1250 static void cl_env_percpu_refill(void)
1254 for_each_possible_cpu(i)
1255 lu_env_refill(&cl_env_percpu[i].ce_lu);
1258 void cl_env_percpu_put(struct lu_env *env)
1263 cpu = smp_processor_id();
1264 cle = cl_env_container(env);
1265 LASSERT(cle == &cl_env_percpu[cpu]);
1268 LASSERT(cle->ce_ref == 0);
1272 cle->ce_debug = NULL;
1276 EXPORT_SYMBOL(cl_env_percpu_put);
1278 struct lu_env *cl_env_percpu_get()
1282 cle = &cl_env_percpu[get_cpu()];
1283 cl_env_init0(cle, __builtin_return_address(0));
1288 EXPORT_SYMBOL(cl_env_percpu_get);
1290 /*****************************************************************************
1292 * Temporary prototype thing: mirror obd-devices into cl devices.
1296 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
1297 struct lu_device_type *ldt,
1298 struct lu_device *next)
1300 const char *typename;
1301 struct lu_device *d;
1303 LASSERT(ldt != NULL);
1305 typename = ldt->ldt_name;
1306 d = ldt->ldt_ops->ldto_device_alloc(env, ldt, NULL);
1312 rc = ldt->ldt_ops->ldto_device_init(env, d, typename, next);
1315 lu_ref_add(&d->ld_reference,
1316 "lu-stack", &lu_site_init);
1318 ldt->ldt_ops->ldto_device_free(env, d);
1319 CERROR("can't init device '%s', %d\n", typename, rc);
1323 CERROR("Cannot allocate device: '%s'\n", typename);
1324 return lu2cl_dev(d);
1326 EXPORT_SYMBOL(cl_type_setup);
1329 * Finalize device stack by calling lu_stack_fini().
1331 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl)
1333 lu_stack_fini(env, cl2lu_dev(cl));
1335 EXPORT_SYMBOL(cl_stack_fini);
1337 static struct lu_context_key cl_key;
1339 struct cl_thread_info *cl_env_info(const struct lu_env *env)
1341 return lu_context_key_get(&env->le_ctx, &cl_key);
1344 /* defines cl0_key_{init,fini}() */
1345 LU_KEY_INIT_FINI(cl0, struct cl_thread_info);
1347 static void *cl_key_init(const struct lu_context *ctx,
1348 struct lu_context_key *key)
1350 struct cl_thread_info *info;
1352 info = cl0_key_init(ctx, key);
1353 if (!IS_ERR(info)) {
1356 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1357 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1362 static void cl_key_fini(const struct lu_context *ctx,
1363 struct lu_context_key *key, void *data)
1365 struct cl_thread_info *info;
1369 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1370 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1371 cl0_key_fini(ctx, key, data);
1374 static void cl_key_exit(const struct lu_context *ctx,
1375 struct lu_context_key *key, void *data)
1377 struct cl_thread_info *info = data;
1380 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i) {
1381 LASSERT(info->clt_counters[i].ctc_nr_held == 0);
1382 LASSERT(info->clt_counters[i].ctc_nr_used == 0);
1383 LASSERT(info->clt_counters[i].ctc_nr_locks_acquired == 0);
1384 LASSERT(info->clt_counters[i].ctc_nr_locks_locked == 0);
1385 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1386 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1390 static struct lu_context_key cl_key = {
1391 .lct_tags = LCT_CL_THREAD,
1392 .lct_init = cl_key_init,
1393 .lct_fini = cl_key_fini,
1394 .lct_exit = cl_key_exit
1397 static struct lu_kmem_descr cl_object_caches[] = {
1399 .ckd_cache = &cl_env_kmem,
1400 .ckd_name = "cl_env_kmem",
1401 .ckd_size = sizeof (struct cl_env)
1409 * Global initialization of cl-data. Create kmem caches, register
1410 * lu_context_key's, etc.
1412 * \see cl_global_fini()
1414 int cl_global_init(void)
1418 INIT_LIST_HEAD(&cl_envs);
1420 result = cl_env_store_init();
1424 result = lu_kmem_init(cl_object_caches);
1428 LU_CONTEXT_KEY_INIT(&cl_key);
1429 result = lu_context_key_register(&cl_key);
1433 result = cl_env_percpu_init();
1435 /* no cl_env_percpu_fini on error */
1441 lu_context_key_degister(&cl_key);
1443 lu_kmem_fini(cl_object_caches);
1445 cl_env_store_fini();
1450 * Finalization of global cl-data. Dual to cl_global_init().
1452 void cl_global_fini(void)
1454 cl_env_percpu_fini();
1455 lu_context_key_degister(&cl_key);
1456 lu_kmem_fini(cl_object_caches);
1457 cl_env_store_fini();