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);
477 loff_t cl_object_maxbytes(struct cl_object *obj)
479 struct lu_object_header *top = obj->co_lu.lo_header;
480 loff_t maxbytes = LLONG_MAX;
483 list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
484 if (obj->co_ops->coo_maxbytes != NULL)
485 maxbytes = min_t(loff_t, obj->co_ops->coo_maxbytes(obj),
491 EXPORT_SYMBOL(cl_object_maxbytes);
494 * Helper function removing all object locks, and marking object for
495 * deletion. All object pages must have been deleted at this point.
497 * This is called by cl_inode_fini() and lov_object_delete() to destroy top-
498 * and sub- objects respectively.
500 void cl_object_kill(const struct lu_env *env, struct cl_object *obj)
502 struct cl_object_header *hdr = cl_object_header(obj);
504 set_bit(LU_OBJECT_HEARD_BANSHEE, &hdr->coh_lu.loh_flags);
506 EXPORT_SYMBOL(cl_object_kill);
508 void cache_stats_init(struct cache_stats *cs, const char *name)
513 for (i = 0; i < CS_NR; i++)
514 atomic_set(&cs->cs_stats[i], 0);
517 static int cache_stats_print(const struct cache_stats *cs,
518 struct seq_file *m, int h)
523 * lookup hit total cached create
524 * env: ...... ...... ...... ...... ......
527 const char *names[CS_NR] = CS_NAMES;
529 seq_printf(m, "%6s", " ");
530 for (i = 0; i < CS_NR; i++)
531 seq_printf(m, "%8s", names[i]);
535 seq_printf(m, "%5.5s:", cs->cs_name);
536 for (i = 0; i < CS_NR; i++)
537 seq_printf(m, "%8u", atomic_read(&cs->cs_stats[i]));
541 static void cl_env_percpu_refill(void);
544 * Initialize client site.
546 * Perform common initialization (lu_site_init()), and initialize statistical
547 * counters. Also perform global initializations on the first call.
549 int cl_site_init(struct cl_site *s, struct cl_device *d)
554 result = lu_site_init(&s->cs_lu, &d->cd_lu_dev);
556 cache_stats_init(&s->cs_pages, "pages");
557 for (i = 0; i < ARRAY_SIZE(s->cs_pages_state); ++i)
558 atomic_set(&s->cs_pages_state[0], 0);
559 cl_env_percpu_refill();
563 EXPORT_SYMBOL(cl_site_init);
566 * Finalize client site. Dual to cl_site_init().
568 void cl_site_fini(struct cl_site *s)
570 lu_site_fini(&s->cs_lu);
572 EXPORT_SYMBOL(cl_site_fini);
574 static struct cache_stats cl_env_stats = {
576 .cs_stats = { ATOMIC_INIT(0), }
580 * Outputs client site statistical counters into a buffer. Suitable for
581 * ll_rd_*()-style functions.
583 int cl_site_stats_print(const struct cl_site *site, struct seq_file *m)
585 static const char *pstate[] = {
595 lookup hit total busy create
596 pages: ...... ...... ...... ...... ...... [...... ...... ...... ......]
597 locks: ...... ...... ...... ...... ...... [...... ...... ...... ...... ......]
598 env: ...... ...... ...... ...... ......
600 lu_site_stats_seq_print(&site->cs_lu, m);
601 cache_stats_print(&site->cs_pages, m, 1);
603 for (i = 0; i < ARRAY_SIZE(site->cs_pages_state); ++i)
604 seq_printf(m, "%s: %u ", pstate[i],
605 atomic_read(&site->cs_pages_state[i]));
606 seq_printf(m, "]\n");
607 cache_stats_print(&cl_env_stats, m, 0);
611 EXPORT_SYMBOL(cl_site_stats_print);
613 /*****************************************************************************
615 * lu_env handling on client.
620 * The most efficient way is to store cl_env pointer in task specific
621 * structures. On Linux, it wont' be easy to use task_struct->journal_info
622 * because Lustre code may call into other fs which has certain assumptions
623 * about journal_info. Currently following fields in task_struct are identified
624 * can be used for this purpose:
625 * - cl_env: for liblustre.
626 * - tux_info: ony on RedHat kernel.
628 * \note As long as we use task_struct to store cl_env, we assume that once
629 * called into Lustre, we'll never call into the other part of the kernel
630 * which will use those fields in task_struct without explicitly exiting
633 * If there's no space in task_struct is available, hash will be used.
637 static struct list_head cl_envs;
638 static unsigned cl_envs_cached_nr = 0;
639 static unsigned cl_envs_cached_max = 128; /* XXX: prototype: arbitrary limit
641 static DEFINE_SPINLOCK(cl_envs_guard);
646 struct lu_context ce_ses;
648 #ifdef LL_TASK_CL_ENV
652 * This allows cl_env to be entered into cl_env_hash which implements
653 * the current thread -> client environment lookup.
655 struct hlist_node ce_node;
658 * Owner for the current cl_env.
660 * If LL_TASK_CL_ENV is defined, this point to the owning current,
661 * only for debugging purpose ;
662 * Otherwise hash is used, and this is the key for cfs_hash.
663 * Now current thread pid is stored. Note using thread pointer would
664 * lead to unbalanced hash because of its specific allocation locality
665 * and could be varied for different platforms and OSes, even different
671 * Linkage into global list of all client environments. Used for
672 * garbage collection.
674 struct list_head ce_linkage;
680 * Debugging field: address of the caller who made original
686 #ifdef CONFIG_DEBUG_PAGESTATE_TRACKING
687 #define CL_ENV_INC(counter) atomic_inc(&cl_env_stats.cs_stats[CS_##counter])
689 #define CL_ENV_DEC(counter) do { \
690 LASSERT(atomic_read(&cl_env_stats.cs_stats[CS_##counter]) > 0); \
691 atomic_dec(&cl_env_stats.cs_stats[CS_##counter]); \
694 #define CL_ENV_INC(counter)
695 #define CL_ENV_DEC(counter)
698 static void cl_env_init0(struct cl_env *cle, void *debug)
700 LASSERT(cle->ce_ref == 0);
701 LASSERT(cle->ce_magic == &cl_env_init0);
702 LASSERT(cle->ce_debug == NULL && cle->ce_owner == NULL);
705 cle->ce_debug = debug;
710 #ifndef LL_TASK_CL_ENV
712 * The implementation of using hash table to connect cl_env and thread
715 static cfs_hash_t *cl_env_hash;
717 static unsigned cl_env_hops_hash(cfs_hash_t *lh,
718 const void *key, unsigned mask)
720 #if BITS_PER_LONG == 64
721 return cfs_hash_u64_hash((__u64)key, mask);
723 return cfs_hash_u32_hash((__u32)key, mask);
727 static void *cl_env_hops_obj(struct hlist_node *hn)
729 struct cl_env *cle = hlist_entry(hn, struct cl_env, ce_node);
731 LASSERT(cle->ce_magic == &cl_env_init0);
735 static int cl_env_hops_keycmp(const void *key, struct hlist_node *hn)
737 struct cl_env *cle = cl_env_hops_obj(hn);
739 LASSERT(cle->ce_owner != NULL);
740 return (key == cle->ce_owner);
743 static void cl_env_hops_noop(cfs_hash_t *hs, struct hlist_node *hn)
745 struct cl_env *cle = hlist_entry(hn, struct cl_env, ce_node);
746 LASSERT(cle->ce_magic == &cl_env_init0);
749 static cfs_hash_ops_t cl_env_hops = {
750 .hs_hash = cl_env_hops_hash,
751 .hs_key = cl_env_hops_obj,
752 .hs_keycmp = cl_env_hops_keycmp,
753 .hs_object = cl_env_hops_obj,
754 .hs_get = cl_env_hops_noop,
755 .hs_put_locked = cl_env_hops_noop,
758 static inline struct cl_env *cl_env_fetch(void)
762 cle = cfs_hash_lookup(cl_env_hash, (void *) (long) current->pid);
763 LASSERT(ergo(cle, cle->ce_magic == &cl_env_init0));
767 static inline void cl_env_attach(struct cl_env *cle)
772 LASSERT(cle->ce_owner == NULL);
773 cle->ce_owner = (void *) (long) current->pid;
774 rc = cfs_hash_add_unique(cl_env_hash, cle->ce_owner,
780 static inline void cl_env_do_detach(struct cl_env *cle)
784 LASSERT(cle->ce_owner == (void *) (long) current->pid);
785 cookie = cfs_hash_del(cl_env_hash, cle->ce_owner,
787 LASSERT(cookie == cle);
788 cle->ce_owner = NULL;
791 static int cl_env_store_init(void) {
792 cl_env_hash = cfs_hash_create("cl_env",
793 HASH_CL_ENV_BITS, HASH_CL_ENV_BITS,
794 HASH_CL_ENV_BKT_BITS, 0,
798 CFS_HASH_RW_BKTLOCK);
799 return cl_env_hash != NULL ? 0 :-ENOMEM;
802 static void cl_env_store_fini(void) {
803 cfs_hash_putref(cl_env_hash);
806 #else /* LL_TASK_CL_ENV */
808 * The implementation of store cl_env directly in thread structure.
811 static inline struct cl_env *cl_env_fetch(void)
815 cle = current->LL_TASK_CL_ENV;
816 if (cle && cle->ce_magic != &cl_env_init0)
821 static inline void cl_env_attach(struct cl_env *cle)
824 LASSERT(cle->ce_owner == NULL);
825 cle->ce_owner = current;
826 cle->ce_prev = current->LL_TASK_CL_ENV;
827 current->LL_TASK_CL_ENV = cle;
831 static inline void cl_env_do_detach(struct cl_env *cle)
833 LASSERT(cle->ce_owner == current);
834 LASSERT(current->LL_TASK_CL_ENV == cle);
835 current->LL_TASK_CL_ENV = cle->ce_prev;
836 cle->ce_owner = NULL;
839 static int cl_env_store_init(void) { return 0; }
840 static void cl_env_store_fini(void) { }
842 #endif /* LL_TASK_CL_ENV */
844 static inline struct cl_env *cl_env_detach(struct cl_env *cle)
847 cle = cl_env_fetch();
849 if (cle && cle->ce_owner)
850 cl_env_do_detach(cle);
855 static struct lu_env *cl_env_new(__u32 ctx_tags, __u32 ses_tags, void *debug)
860 OBD_SLAB_ALLOC_PTR_GFP(cle, cl_env_kmem, GFP_NOFS);
864 INIT_LIST_HEAD(&cle->ce_linkage);
865 cle->ce_magic = &cl_env_init0;
867 rc = lu_env_init(env, LCT_CL_THREAD|ctx_tags);
869 rc = lu_context_init(&cle->ce_ses,
870 LCT_SESSION | ses_tags);
872 lu_context_enter(&cle->ce_ses);
873 env->le_ses = &cle->ce_ses;
874 cl_env_init0(cle, debug);
879 OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
886 env = ERR_PTR(-ENOMEM);
890 static void cl_env_fini(struct cl_env *cle)
893 lu_context_fini(&cle->ce_lu.le_ctx);
894 lu_context_fini(&cle->ce_ses);
895 OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
898 static struct lu_env *cl_env_obtain(void *debug)
904 spin_lock(&cl_envs_guard);
905 LASSERT(equi(cl_envs_cached_nr == 0, list_empty(&cl_envs)));
906 if (cl_envs_cached_nr > 0) {
909 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
910 list_del_init(&cle->ce_linkage);
912 spin_unlock(&cl_envs_guard);
915 rc = lu_env_refill(env);
917 cl_env_init0(cle, debug);
918 lu_context_enter(&env->le_ctx);
919 lu_context_enter(&cle->ce_ses);
925 spin_unlock(&cl_envs_guard);
926 env = cl_env_new(lu_context_tags_default,
927 lu_session_tags_default, debug);
932 static inline struct cl_env *cl_env_container(struct lu_env *env)
934 return container_of(env, struct cl_env, ce_lu);
937 struct lu_env *cl_env_peek(int *refcheck)
944 /* check that we don't go far from untrusted pointer */
945 CLASSERT(offsetof(struct cl_env, ce_magic) == 0);
948 cle = cl_env_fetch();
952 *refcheck = ++cle->ce_ref;
954 CDEBUG(D_OTHER, "%d@%p\n", cle ? cle->ce_ref : 0, cle);
959 * Returns lu_env: if there already is an environment associated with the
960 * current thread, it is returned, otherwise, new environment is allocated.
962 * Allocations are amortized through the global cache of environments.
964 * \param refcheck pointer to a counter used to detect environment leaks. In
965 * the usual case cl_env_get() and cl_env_put() are called in the same lexical
966 * scope and pointer to the same integer is passed as \a refcheck. This is
967 * used to detect missed cl_env_put().
971 struct lu_env *cl_env_get(int *refcheck)
975 env = cl_env_peek(refcheck);
977 env = cl_env_obtain(__builtin_return_address(0));
981 cle = cl_env_container(env);
983 *refcheck = cle->ce_ref;
984 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
989 EXPORT_SYMBOL(cl_env_get);
992 * Forces an allocation of a fresh environment with given tags.
996 struct lu_env *cl_env_alloc(int *refcheck, __u32 tags)
1000 LASSERT(cl_env_peek(refcheck) == NULL);
1001 env = cl_env_new(tags, tags, __builtin_return_address(0));
1005 cle = cl_env_container(env);
1006 *refcheck = cle->ce_ref;
1007 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1011 EXPORT_SYMBOL(cl_env_alloc);
1013 static void cl_env_exit(struct cl_env *cle)
1015 LASSERT(cle->ce_owner == NULL);
1016 lu_context_exit(&cle->ce_lu.le_ctx);
1017 lu_context_exit(&cle->ce_ses);
1021 * Finalizes and frees a given number of cached environments. This is done to
1022 * (1) free some memory (not currently hooked into VM), or (2) release
1023 * references to modules.
1025 unsigned cl_env_cache_purge(unsigned nr)
1030 spin_lock(&cl_envs_guard);
1031 for (; !list_empty(&cl_envs) && nr > 0; --nr) {
1032 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
1033 list_del_init(&cle->ce_linkage);
1034 LASSERT(cl_envs_cached_nr > 0);
1035 cl_envs_cached_nr--;
1036 spin_unlock(&cl_envs_guard);
1039 spin_lock(&cl_envs_guard);
1041 LASSERT(equi(cl_envs_cached_nr == 0, list_empty(&cl_envs)));
1042 spin_unlock(&cl_envs_guard);
1045 EXPORT_SYMBOL(cl_env_cache_purge);
1048 * Release an environment.
1050 * Decrement \a env reference counter. When counter drops to 0, nothing in
1051 * this thread is using environment and it is returned to the allocation
1052 * cache, or freed straight away, if cache is large enough.
1054 void cl_env_put(struct lu_env *env, int *refcheck)
1058 cle = cl_env_container(env);
1060 LASSERT(cle->ce_ref > 0);
1061 LASSERT(ergo(refcheck != NULL, cle->ce_ref == *refcheck));
1063 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1064 if (--cle->ce_ref == 0) {
1067 cle->ce_debug = NULL;
1070 * Don't bother to take a lock here.
1072 * Return environment to the cache only when it was allocated
1073 * with the standard tags.
1075 if (cl_envs_cached_nr < cl_envs_cached_max &&
1076 (env->le_ctx.lc_tags & ~LCT_HAS_EXIT) == LCT_CL_THREAD &&
1077 (env->le_ses->lc_tags & ~LCT_HAS_EXIT) == LCT_SESSION) {
1078 spin_lock(&cl_envs_guard);
1079 list_add(&cle->ce_linkage, &cl_envs);
1080 cl_envs_cached_nr++;
1081 spin_unlock(&cl_envs_guard);
1086 EXPORT_SYMBOL(cl_env_put);
1089 * Declares a point of re-entrancy.
1091 * \see cl_env_reexit()
1093 void *cl_env_reenter(void)
1095 return cl_env_detach(NULL);
1097 EXPORT_SYMBOL(cl_env_reenter);
1100 * Exits re-entrancy.
1102 void cl_env_reexit(void *cookie)
1104 cl_env_detach(NULL);
1105 cl_env_attach(cookie);
1107 EXPORT_SYMBOL(cl_env_reexit);
1110 * Setup user-supplied \a env as a current environment. This is to be used to
1111 * guaranteed that environment exists even when cl_env_get() fails. It is up
1112 * to user to ensure proper concurrency control.
1114 * \see cl_env_unplant()
1116 void cl_env_implant(struct lu_env *env, int *refcheck)
1118 struct cl_env *cle = cl_env_container(env);
1120 LASSERT(cle->ce_ref > 0);
1123 cl_env_get(refcheck);
1124 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1126 EXPORT_SYMBOL(cl_env_implant);
1129 * Detach environment installed earlier by cl_env_implant().
1131 void cl_env_unplant(struct lu_env *env, int *refcheck)
1133 struct cl_env *cle = cl_env_container(env);
1135 LASSERT(cle->ce_ref > 1);
1137 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1140 cl_env_put(env, refcheck);
1142 EXPORT_SYMBOL(cl_env_unplant);
1144 struct lu_env *cl_env_nested_get(struct cl_env_nest *nest)
1148 nest->cen_cookie = NULL;
1149 env = cl_env_peek(&nest->cen_refcheck);
1151 if (!cl_io_is_going(env))
1154 cl_env_put(env, &nest->cen_refcheck);
1155 nest->cen_cookie = cl_env_reenter();
1158 env = cl_env_get(&nest->cen_refcheck);
1160 cl_env_reexit(nest->cen_cookie);
1164 LASSERT(!cl_io_is_going(env));
1167 EXPORT_SYMBOL(cl_env_nested_get);
1169 void cl_env_nested_put(struct cl_env_nest *nest, struct lu_env *env)
1171 cl_env_put(env, &nest->cen_refcheck);
1172 cl_env_reexit(nest->cen_cookie);
1174 EXPORT_SYMBOL(cl_env_nested_put);
1177 * Converts struct cl_attr to struct ost_lvb.
1181 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr)
1184 lvb->lvb_size = attr->cat_size;
1185 lvb->lvb_mtime = attr->cat_mtime;
1186 lvb->lvb_atime = attr->cat_atime;
1187 lvb->lvb_ctime = attr->cat_ctime;
1188 lvb->lvb_blocks = attr->cat_blocks;
1193 * Converts struct ost_lvb to struct cl_attr.
1197 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb)
1200 attr->cat_size = lvb->lvb_size;
1201 attr->cat_mtime = lvb->lvb_mtime;
1202 attr->cat_atime = lvb->lvb_atime;
1203 attr->cat_ctime = lvb->lvb_ctime;
1204 attr->cat_blocks = lvb->lvb_blocks;
1207 EXPORT_SYMBOL(cl_lvb2attr);
1209 static struct cl_env cl_env_percpu[NR_CPUS];
1211 static int cl_env_percpu_init(void)
1214 int tags = LCT_REMEMBER | LCT_NOREF;
1218 for_each_possible_cpu(i) {
1221 cle = &cl_env_percpu[i];
1224 INIT_LIST_HEAD(&cle->ce_linkage);
1225 cle->ce_magic = &cl_env_init0;
1226 rc = lu_env_init(env, LCT_CL_THREAD | tags);
1228 rc = lu_context_init(&cle->ce_ses, LCT_SESSION | tags);
1230 lu_context_enter(&cle->ce_ses);
1231 env->le_ses = &cle->ce_ses;
1240 /* Indices 0 to i (excluding i) were correctly initialized,
1241 * thus we must uninitialize up to i, the rest are undefined. */
1242 for (j = 0; j < i; j++) {
1243 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);
1253 static void cl_env_percpu_fini(void)
1257 for_each_possible_cpu(i) {
1258 struct cl_env *cle = &cl_env_percpu[i];
1260 lu_context_exit(&cle->ce_ses);
1261 lu_context_fini(&cle->ce_ses);
1262 lu_env_fini(&cle->ce_lu);
1266 static void cl_env_percpu_refill(void)
1270 for_each_possible_cpu(i)
1271 lu_env_refill(&cl_env_percpu[i].ce_lu);
1274 void cl_env_percpu_put(struct lu_env *env)
1279 cpu = smp_processor_id();
1280 cle = cl_env_container(env);
1281 LASSERT(cle == &cl_env_percpu[cpu]);
1284 LASSERT(cle->ce_ref == 0);
1288 cle->ce_debug = NULL;
1292 EXPORT_SYMBOL(cl_env_percpu_put);
1294 struct lu_env *cl_env_percpu_get()
1298 cle = &cl_env_percpu[get_cpu()];
1299 cl_env_init0(cle, __builtin_return_address(0));
1304 EXPORT_SYMBOL(cl_env_percpu_get);
1306 /*****************************************************************************
1308 * Temporary prototype thing: mirror obd-devices into cl devices.
1312 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
1313 struct lu_device_type *ldt,
1314 struct lu_device *next)
1316 const char *typename;
1317 struct lu_device *d;
1319 LASSERT(ldt != NULL);
1321 typename = ldt->ldt_name;
1322 d = ldt->ldt_ops->ldto_device_alloc(env, ldt, NULL);
1328 rc = ldt->ldt_ops->ldto_device_init(env, d, typename, next);
1331 lu_ref_add(&d->ld_reference,
1332 "lu-stack", &lu_site_init);
1334 ldt->ldt_ops->ldto_device_free(env, d);
1335 CERROR("can't init device '%s', %d\n", typename, rc);
1339 CERROR("Cannot allocate device: '%s'\n", typename);
1340 return lu2cl_dev(d);
1342 EXPORT_SYMBOL(cl_type_setup);
1345 * Finalize device stack by calling lu_stack_fini().
1347 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl)
1349 lu_stack_fini(env, cl2lu_dev(cl));
1351 EXPORT_SYMBOL(cl_stack_fini);
1353 static struct lu_context_key cl_key;
1355 struct cl_thread_info *cl_env_info(const struct lu_env *env)
1357 return lu_context_key_get(&env->le_ctx, &cl_key);
1360 /* defines cl0_key_{init,fini}() */
1361 LU_KEY_INIT_FINI(cl0, struct cl_thread_info);
1363 static void *cl_key_init(const struct lu_context *ctx,
1364 struct lu_context_key *key)
1366 struct cl_thread_info *info;
1368 info = cl0_key_init(ctx, key);
1369 if (!IS_ERR(info)) {
1372 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1373 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1378 static void cl_key_fini(const struct lu_context *ctx,
1379 struct lu_context_key *key, void *data)
1381 struct cl_thread_info *info;
1385 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1386 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1387 cl0_key_fini(ctx, key, data);
1390 static void cl_key_exit(const struct lu_context *ctx,
1391 struct lu_context_key *key, void *data)
1393 struct cl_thread_info *info = data;
1396 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i) {
1397 LASSERT(info->clt_counters[i].ctc_nr_held == 0);
1398 LASSERT(info->clt_counters[i].ctc_nr_used == 0);
1399 LASSERT(info->clt_counters[i].ctc_nr_locks_acquired == 0);
1400 LASSERT(info->clt_counters[i].ctc_nr_locks_locked == 0);
1401 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1402 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1406 static struct lu_context_key cl_key = {
1407 .lct_tags = LCT_CL_THREAD,
1408 .lct_init = cl_key_init,
1409 .lct_fini = cl_key_fini,
1410 .lct_exit = cl_key_exit
1413 static struct lu_kmem_descr cl_object_caches[] = {
1415 .ckd_cache = &cl_env_kmem,
1416 .ckd_name = "cl_env_kmem",
1417 .ckd_size = sizeof (struct cl_env)
1425 * Global initialization of cl-data. Create kmem caches, register
1426 * lu_context_key's, etc.
1428 * \see cl_global_fini()
1430 int cl_global_init(void)
1434 INIT_LIST_HEAD(&cl_envs);
1436 result = cl_env_store_init();
1440 result = lu_kmem_init(cl_object_caches);
1444 LU_CONTEXT_KEY_INIT(&cl_key);
1445 result = lu_context_key_register(&cl_key);
1449 result = cl_env_percpu_init();
1451 /* no cl_env_percpu_fini on error */
1457 lu_context_key_degister(&cl_key);
1459 lu_kmem_fini(cl_object_caches);
1461 cl_env_store_fini();
1466 * Finalization of global cl-data. Dual to cl_global_init().
1468 void cl_global_fini(void)
1470 cl_env_percpu_fini();
1471 lu_context_key_degister(&cl_key);
1472 lu_kmem_fini(cl_object_caches);
1473 cl_env_store_fini();