1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
30 * Use is subject to license terms.
32 * Copyright (c) 2011, 2012, Whamcloud, Inc.
35 * This file is part of Lustre, http://www.lustre.org/
36 * Lustre is a trademark of Sun Microsystems, Inc.
38 * Client Lustre Object.
40 * Author: Nikita Danilov <nikita.danilov@sun.com>
54 #define DEBUG_SUBSYSTEM S_CLASS
56 # define EXPORT_SYMTAB
59 #include <libcfs/libcfs.h>
60 /* class_put_type() */
61 #include <obd_class.h>
62 #include <obd_support.h>
63 #include <lustre_fid.h>
64 #include <libcfs/list.h>
65 #include <libcfs/libcfs_hash.h> /* for cfs_hash stuff */
66 /* lu_time_global_{init,fini}() */
69 #include <cl_object.h>
70 #include "cl_internal.h"
72 static cfs_mem_cache_t *cl_env_kmem;
74 /** Lock class of cl_object_header::coh_page_guard */
75 static cfs_lock_class_key_t cl_page_guard_class;
76 /** Lock class of cl_object_header::coh_lock_guard */
77 static cfs_lock_class_key_t cl_lock_guard_class;
78 /** Lock class of cl_object_header::coh_attr_guard */
79 static cfs_lock_class_key_t cl_attr_guard_class;
81 extern __u32 lu_context_tags_default;
82 extern __u32 lu_session_tags_default;
84 * Initialize cl_object_header.
86 int cl_object_header_init(struct cl_object_header *h)
91 result = lu_object_header_init(&h->coh_lu);
93 cfs_spin_lock_init(&h->coh_page_guard);
94 cfs_spin_lock_init(&h->coh_lock_guard);
95 cfs_spin_lock_init(&h->coh_attr_guard);
96 cfs_lockdep_set_class(&h->coh_attr_guard, &cl_page_guard_class);
97 cfs_lockdep_set_class(&h->coh_attr_guard, &cl_lock_guard_class);
98 cfs_lockdep_set_class(&h->coh_attr_guard, &cl_attr_guard_class);
100 /* XXX hard coded GFP_* mask. */
101 INIT_RADIX_TREE(&h->coh_tree, GFP_ATOMIC);
102 CFS_INIT_LIST_HEAD(&h->coh_locks);
106 EXPORT_SYMBOL(cl_object_header_init);
109 * Finalize cl_object_header.
111 void cl_object_header_fini(struct cl_object_header *h)
113 LASSERT(cfs_list_empty(&h->coh_locks));
114 lu_object_header_fini(&h->coh_lu);
116 EXPORT_SYMBOL(cl_object_header_fini);
119 * Returns a cl_object with a given \a fid.
121 * Returns either cached or newly created object. Additional reference on the
122 * returned object is acquired.
124 * \see lu_object_find(), cl_page_find(), cl_lock_find()
126 struct cl_object *cl_object_find(const struct lu_env *env,
127 struct cl_device *cd, const struct lu_fid *fid,
128 const struct cl_object_conf *c)
131 return lu2cl(lu_object_find_slice(env, cl2lu_dev(cd), fid, &c->coc_lu));
133 EXPORT_SYMBOL(cl_object_find);
136 * Releases a reference on \a o.
138 * When last reference is released object is returned to the cache, unless
139 * lu_object_header_flags::LU_OBJECT_HEARD_BANSHEE bit is set in its header.
141 * \see cl_page_put(), cl_lock_put().
143 void cl_object_put(const struct lu_env *env, struct cl_object *o)
145 lu_object_put(env, &o->co_lu);
147 EXPORT_SYMBOL(cl_object_put);
150 * Acquire an additional reference to the object \a o.
152 * This can only be used to acquire _additional_ reference, i.e., caller
153 * already has to possess at least one reference to \a o before calling this.
155 * \see cl_page_get(), cl_lock_get().
157 void cl_object_get(struct cl_object *o)
159 lu_object_get(&o->co_lu);
161 EXPORT_SYMBOL(cl_object_get);
164 * Returns the top-object for a given \a o.
166 * \see cl_page_top(), cl_io_top()
168 struct cl_object *cl_object_top(struct cl_object *o)
170 struct cl_object_header *hdr = cl_object_header(o);
171 struct cl_object *top;
173 while (hdr->coh_parent != NULL)
174 hdr = hdr->coh_parent;
176 top = lu2cl(lu_object_top(&hdr->coh_lu));
177 CDEBUG(D_TRACE, "%p -> %p\n", o, top);
180 EXPORT_SYMBOL(cl_object_top);
183 * Returns pointer to the lock protecting data-attributes for the given object
186 * Data-attributes are protected by the cl_object_header::coh_attr_guard
187 * spin-lock in the top-object.
189 * \see cl_attr, cl_object_attr_lock(), cl_object_operations::coo_attr_get().
191 static cfs_spinlock_t *cl_object_attr_guard(struct cl_object *o)
193 return &cl_object_header(cl_object_top(o))->coh_attr_guard;
197 * Locks data-attributes.
199 * Prevents data-attributes from changing, until lock is released by
200 * cl_object_attr_unlock(). This has to be called before calls to
201 * cl_object_attr_get(), cl_object_attr_set().
203 void cl_object_attr_lock(struct cl_object *o)
205 cfs_spin_lock(cl_object_attr_guard(o));
207 EXPORT_SYMBOL(cl_object_attr_lock);
210 * Releases data-attributes lock, acquired by cl_object_attr_lock().
212 void cl_object_attr_unlock(struct cl_object *o)
214 cfs_spin_unlock(cl_object_attr_guard(o));
216 EXPORT_SYMBOL(cl_object_attr_unlock);
219 * Returns data-attributes of an object \a obj.
221 * Every layer is asked (by calling cl_object_operations::coo_attr_get())
222 * top-to-bottom to fill in parts of \a attr that this layer is responsible
225 int cl_object_attr_get(const struct lu_env *env, struct cl_object *obj,
226 struct cl_attr *attr)
228 struct lu_object_header *top;
231 LASSERT_SPIN_LOCKED(cl_object_attr_guard(obj));
234 top = obj->co_lu.lo_header;
236 cfs_list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
237 if (obj->co_ops->coo_attr_get != NULL) {
238 result = obj->co_ops->coo_attr_get(env, obj, attr);
248 EXPORT_SYMBOL(cl_object_attr_get);
251 * Updates data-attributes of an object \a obj.
253 * Only attributes, mentioned in a validness bit-mask \a v are
254 * updated. Calls cl_object_operations::coo_attr_set() on every layer, bottom
257 int cl_object_attr_set(const struct lu_env *env, struct cl_object *obj,
258 const struct cl_attr *attr, unsigned v)
260 struct lu_object_header *top;
263 LASSERT_SPIN_LOCKED(cl_object_attr_guard(obj));
266 top = obj->co_lu.lo_header;
268 cfs_list_for_each_entry_reverse(obj, &top->loh_layers,
270 if (obj->co_ops->coo_attr_set != NULL) {
271 result = obj->co_ops->coo_attr_set(env, obj, attr, v);
281 EXPORT_SYMBOL(cl_object_attr_set);
284 * Notifies layers (bottom-to-top) that glimpse AST was received.
286 * Layers have to fill \a lvb fields with information that will be shipped
287 * back to glimpse issuer.
289 * \see cl_lock_operations::clo_glimpse()
291 int cl_object_glimpse(const struct lu_env *env, struct cl_object *obj,
294 struct lu_object_header *top;
298 top = obj->co_lu.lo_header;
300 cfs_list_for_each_entry_reverse(obj, &top->loh_layers,
302 if (obj->co_ops->coo_glimpse != NULL) {
303 result = obj->co_ops->coo_glimpse(env, obj, lvb);
308 LU_OBJECT_HEADER(D_DLMTRACE, env, lu_object_top(top),
309 "size: "LPU64" mtime: "LPU64" atime: "LPU64" "
310 "ctime: "LPU64" blocks: "LPU64"\n",
311 lvb->lvb_size, lvb->lvb_mtime, lvb->lvb_atime,
312 lvb->lvb_ctime, lvb->lvb_blocks);
315 EXPORT_SYMBOL(cl_object_glimpse);
318 * Updates a configuration of an object \a obj.
320 int cl_conf_set(const struct lu_env *env, struct cl_object *obj,
321 const struct cl_object_conf *conf)
323 struct lu_object_header *top;
327 top = obj->co_lu.lo_header;
329 cfs_list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
330 if (obj->co_ops->coo_conf_set != NULL) {
331 result = obj->co_ops->coo_conf_set(env, obj, conf);
338 EXPORT_SYMBOL(cl_conf_set);
341 * Helper function removing all object locks, and marking object for
342 * deletion. All object pages must have been deleted at this point.
344 * This is called by cl_inode_fini() and lov_object_delete() to destroy top-
345 * and sub- objects respectively.
347 void cl_object_kill(const struct lu_env *env, struct cl_object *obj)
349 struct cl_object_header *hdr;
351 hdr = cl_object_header(obj);
352 LASSERT(hdr->coh_tree.rnode == NULL);
353 LASSERT(hdr->coh_pages == 0);
355 cfs_set_bit(LU_OBJECT_HEARD_BANSHEE, &hdr->coh_lu.loh_flags);
357 * Destroy all locks. Object destruction (including cl_inode_fini())
358 * cannot cancel the locks, because in the case of a local client,
359 * where client and server share the same thread running
360 * prune_icache(), this can dead-lock with ldlm_cancel_handler()
361 * waiting on __wait_on_freeing_inode().
363 cl_locks_prune(env, obj, 0);
365 EXPORT_SYMBOL(cl_object_kill);
368 * Prunes caches of pages and locks for this object.
370 void cl_object_prune(const struct lu_env *env, struct cl_object *obj)
373 cl_pages_prune(env, obj);
374 cl_locks_prune(env, obj, 1);
377 EXPORT_SYMBOL(cl_object_prune);
380 * Check if the object has locks.
382 int cl_object_has_locks(struct cl_object *obj)
384 struct cl_object_header *head = cl_object_header(obj);
387 cfs_spin_lock(&head->coh_lock_guard);
388 has = cfs_list_empty(&head->coh_locks);
389 cfs_spin_unlock(&head->coh_lock_guard);
393 EXPORT_SYMBOL(cl_object_has_locks);
395 void cache_stats_init(struct cache_stats *cs, const char *name)
398 cfs_atomic_set(&cs->cs_lookup, 0);
399 cfs_atomic_set(&cs->cs_hit, 0);
400 cfs_atomic_set(&cs->cs_total, 0);
401 cfs_atomic_set(&cs->cs_busy, 0);
404 int cache_stats_print(const struct cache_stats *cs,
405 char *page, int count, int h)
409 lookup hit total cached create
410 env: ...... ...... ...... ...... ......
413 nob += snprintf(page, count,
414 " lookup hit total busy create\n");
416 nob += snprintf(page + nob, count - nob,
417 "%5.5s: %6u %6u %6u %6u %6u",
419 cfs_atomic_read(&cs->cs_lookup),
420 cfs_atomic_read(&cs->cs_hit),
421 cfs_atomic_read(&cs->cs_total),
422 cfs_atomic_read(&cs->cs_busy),
423 cfs_atomic_read(&cs->cs_created));
428 * Initialize client site.
430 * Perform common initialization (lu_site_init()), and initialize statistical
431 * counters. Also perform global initializations on the first call.
433 int cl_site_init(struct cl_site *s, struct cl_device *d)
438 result = lu_site_init(&s->cs_lu, &d->cd_lu_dev);
440 cache_stats_init(&s->cs_pages, "pages");
441 cache_stats_init(&s->cs_locks, "locks");
442 for (i = 0; i < ARRAY_SIZE(s->cs_pages_state); ++i)
443 cfs_atomic_set(&s->cs_pages_state[0], 0);
444 for (i = 0; i < ARRAY_SIZE(s->cs_locks_state); ++i)
445 cfs_atomic_set(&s->cs_locks_state[i], 0);
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_created = CFS_ATOMIC_INIT(0),
463 .cs_lookup = CFS_ATOMIC_INIT(0),
464 .cs_hit = CFS_ATOMIC_INIT(0),
465 .cs_total = CFS_ATOMIC_INIT(0),
466 .cs_busy = CFS_ATOMIC_INIT(0)
470 * Outputs client site statistical counters into a buffer. Suitable for
471 * ll_rd_*()-style functions.
473 int cl_site_stats_print(const struct cl_site *site, char *page, int count)
477 static const char *pstate[] = {
484 static const char *lstate[] = {
487 [CLS_ENQUEUED] = "e",
489 [CLS_INTRANSIT] = "t",
494 lookup hit total busy create
495 pages: ...... ...... ...... ...... ...... [...... ...... ...... ......]
496 locks: ...... ...... ...... ...... ...... [...... ...... ...... ...... ......]
497 env: ...... ...... ...... ...... ......
499 nob = lu_site_stats_print(&site->cs_lu, page, count);
500 nob += cache_stats_print(&site->cs_pages, page + nob, count - nob, 1);
501 nob += snprintf(page + nob, count - nob, " [");
502 for (i = 0; i < ARRAY_SIZE(site->cs_pages_state); ++i)
503 nob += snprintf(page + nob, count - nob, "%s: %u ",
505 cfs_atomic_read(&site->cs_pages_state[i]));
506 nob += snprintf(page + nob, count - nob, "]\n");
507 nob += cache_stats_print(&site->cs_locks, page + nob, count - nob, 0);
508 nob += snprintf(page + nob, count - nob, " [");
509 for (i = 0; i < ARRAY_SIZE(site->cs_locks_state); ++i)
510 nob += snprintf(page + nob, count - nob, "%s: %u ",
512 cfs_atomic_read(&site->cs_locks_state[i]));
513 nob += snprintf(page + nob, count - nob, "]\n");
514 nob += cache_stats_print(&cl_env_stats, page + nob, count - nob, 0);
515 nob += snprintf(page + nob, count - nob, "\n");
518 EXPORT_SYMBOL(cl_site_stats_print);
520 /*****************************************************************************
522 * lu_env handling on client.
527 * The most efficient way is to store cl_env pointer in task specific
528 * structures. On Linux, it wont' be easy to use task_struct->journal_info
529 * because Lustre code may call into other fs which has certain assumptions
530 * about journal_info. Currently following fields in task_struct are identified
531 * can be used for this purpose:
532 * - cl_env: for liblustre.
533 * - tux_info: ony on RedHat kernel.
535 * \note As long as we use task_struct to store cl_env, we assume that once
536 * called into Lustre, we'll never call into the other part of the kernel
537 * which will use those fields in task_struct without explicitly exiting
540 * If there's no space in task_struct is available, hash will be used.
544 static CFS_LIST_HEAD(cl_envs);
545 static unsigned cl_envs_cached_nr = 0;
546 static unsigned cl_envs_cached_max = 128; /* XXX: prototype: arbitrary limit
548 static cfs_spinlock_t cl_envs_guard = CFS_SPIN_LOCK_UNLOCKED;
553 struct lu_context ce_ses;
555 #ifdef LL_TASK_CL_ENV
559 * This allows cl_env to be entered into cl_env_hash which implements
560 * the current thread -> client environment lookup.
562 cfs_hlist_node_t ce_node;
565 * Owner for the current cl_env.
567 * If LL_TASK_CL_ENV is defined, this point to the owning cfs_current(),
568 * only for debugging purpose ;
569 * Otherwise hash is used, and this is the key for cfs_hash.
570 * Now current thread pid is stored. Note using thread pointer would
571 * lead to unbalanced hash because of its specific allocation locality
572 * and could be varied for different platforms and OSes, even different
578 * Linkage into global list of all client environments. Used for
579 * garbage collection.
581 cfs_list_t ce_linkage;
587 * Debugging field: address of the caller who made original
593 #define CL_ENV_INC(counter) cfs_atomic_inc(&cl_env_stats.counter)
595 #define CL_ENV_DEC(counter) \
597 LASSERT(cfs_atomic_read(&cl_env_stats.counter) > 0); \
598 cfs_atomic_dec(&cl_env_stats.counter); \
601 static void cl_env_init0(struct cl_env *cle, void *debug)
603 LASSERT(cle->ce_ref == 0);
604 LASSERT(cle->ce_magic == &cl_env_init0);
605 LASSERT(cle->ce_debug == NULL && cle->ce_owner == NULL);
608 cle->ce_debug = debug;
613 #ifndef LL_TASK_CL_ENV
615 * The implementation of using hash table to connect cl_env and thread
618 static cfs_hash_t *cl_env_hash;
620 static unsigned cl_env_hops_hash(cfs_hash_t *lh,
621 const void *key, unsigned mask)
623 #if BITS_PER_LONG == 64
624 return cfs_hash_u64_hash((__u64)key, mask);
626 return cfs_hash_u32_hash((__u32)key, mask);
630 static void *cl_env_hops_obj(cfs_hlist_node_t *hn)
632 struct cl_env *cle = cfs_hlist_entry(hn, struct cl_env, ce_node);
633 LASSERT(cle->ce_magic == &cl_env_init0);
637 static int cl_env_hops_keycmp(const void *key, cfs_hlist_node_t *hn)
639 struct cl_env *cle = cl_env_hops_obj(hn);
641 LASSERT(cle->ce_owner != NULL);
642 return (key == cle->ce_owner);
645 static void cl_env_hops_noop(cfs_hash_t *hs, cfs_hlist_node_t *hn)
647 struct cl_env *cle = cfs_hlist_entry(hn, struct cl_env, ce_node);
648 LASSERT(cle->ce_magic == &cl_env_init0);
651 static cfs_hash_ops_t cl_env_hops = {
652 .hs_hash = cl_env_hops_hash,
653 .hs_key = cl_env_hops_obj,
654 .hs_keycmp = cl_env_hops_keycmp,
655 .hs_object = cl_env_hops_obj,
656 .hs_get = cl_env_hops_noop,
657 .hs_put_locked = cl_env_hops_noop,
660 static inline struct cl_env *cl_env_fetch(void)
664 cle = cfs_hash_lookup(cl_env_hash, (void *) (long) cfs_current()->pid);
665 LASSERT(ergo(cle, cle->ce_magic == &cl_env_init0));
669 static inline void cl_env_attach(struct cl_env *cle)
674 LASSERT(cle->ce_owner == NULL);
675 cle->ce_owner = (void *) (long) cfs_current()->pid;
676 rc = cfs_hash_add_unique(cl_env_hash, cle->ce_owner,
682 static inline void cl_env_do_detach(struct cl_env *cle)
686 LASSERT(cle->ce_owner == (void *) (long) cfs_current()->pid);
687 cookie = cfs_hash_del(cl_env_hash, cle->ce_owner,
689 LASSERT(cookie == cle);
690 cle->ce_owner = NULL;
693 static int cl_env_store_init(void) {
694 cl_env_hash = cfs_hash_create("cl_env",
695 HASH_CL_ENV_BITS, HASH_CL_ENV_BITS,
696 HASH_CL_ENV_BKT_BITS, 0,
700 CFS_HASH_RW_BKTLOCK);
701 return cl_env_hash != NULL ? 0 :-ENOMEM;
704 static void cl_env_store_fini(void) {
705 cfs_hash_putref(cl_env_hash);
708 #else /* LL_TASK_CL_ENV */
710 * The implementation of store cl_env directly in thread structure.
713 static inline struct cl_env *cl_env_fetch(void)
717 cle = cfs_current()->LL_TASK_CL_ENV;
718 if (cle && cle->ce_magic != &cl_env_init0)
723 static inline void cl_env_attach(struct cl_env *cle)
726 LASSERT(cle->ce_owner == NULL);
727 cle->ce_owner = cfs_current();
728 cle->ce_prev = cfs_current()->LL_TASK_CL_ENV;
729 cfs_current()->LL_TASK_CL_ENV = cle;
733 static inline void cl_env_do_detach(struct cl_env *cle)
735 LASSERT(cle->ce_owner == cfs_current());
736 LASSERT(cfs_current()->LL_TASK_CL_ENV == cle);
737 cfs_current()->LL_TASK_CL_ENV = cle->ce_prev;
738 cle->ce_owner = NULL;
741 static int cl_env_store_init(void) { return 0; }
742 static void cl_env_store_fini(void) { }
744 #endif /* LL_TASK_CL_ENV */
746 static inline struct cl_env *cl_env_detach(struct cl_env *cle)
749 cle = cl_env_fetch();
751 if (cle && cle->ce_owner)
752 cl_env_do_detach(cle);
757 static struct lu_env *cl_env_new(__u32 ctx_tags, __u32 ses_tags, void *debug)
762 OBD_SLAB_ALLOC_PTR_GFP(cle, cl_env_kmem, CFS_ALLOC_IO);
766 CFS_INIT_LIST_HEAD(&cle->ce_linkage);
767 cle->ce_magic = &cl_env_init0;
769 rc = lu_env_init(env, LCT_CL_THREAD|ctx_tags);
771 rc = lu_context_init(&cle->ce_ses,
772 LCT_SESSION | ses_tags);
774 lu_context_enter(&cle->ce_ses);
775 env->le_ses = &cle->ce_ses;
776 cl_env_init0(cle, debug);
781 OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
784 CL_ENV_INC(cs_created);
785 CL_ENV_INC(cs_total);
788 env = ERR_PTR(-ENOMEM);
792 static void cl_env_fini(struct cl_env *cle)
794 CL_ENV_DEC(cs_total);
795 lu_context_fini(&cle->ce_lu.le_ctx);
796 lu_context_fini(&cle->ce_ses);
797 OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
800 static struct lu_env *cl_env_obtain(void *debug)
806 cfs_spin_lock(&cl_envs_guard);
807 LASSERT(equi(cl_envs_cached_nr == 0, cfs_list_empty(&cl_envs)));
808 if (cl_envs_cached_nr > 0) {
811 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
812 cfs_list_del_init(&cle->ce_linkage);
814 cfs_spin_unlock(&cl_envs_guard);
817 rc = lu_env_refill(env);
819 cl_env_init0(cle, debug);
820 lu_context_enter(&env->le_ctx);
821 lu_context_enter(&cle->ce_ses);
827 cfs_spin_unlock(&cl_envs_guard);
828 env = cl_env_new(lu_context_tags_default,
829 lu_session_tags_default, debug);
834 static inline struct cl_env *cl_env_container(struct lu_env *env)
836 return container_of(env, struct cl_env, ce_lu);
839 struct lu_env *cl_env_peek(int *refcheck)
844 CL_ENV_INC(cs_lookup);
846 /* check that we don't go far from untrusted pointer */
847 CLASSERT(offsetof(struct cl_env, ce_magic) == 0);
850 cle = cl_env_fetch();
854 *refcheck = ++cle->ce_ref;
856 CDEBUG(D_OTHER, "%d@%p\n", cle ? cle->ce_ref : 0, cle);
859 EXPORT_SYMBOL(cl_env_peek);
862 * Returns lu_env: if there already is an environment associated with the
863 * current thread, it is returned, otherwise, new environment is allocated.
865 * Allocations are amortized through the global cache of environments.
867 * \param refcheck pointer to a counter used to detect environment leaks. In
868 * the usual case cl_env_get() and cl_env_put() are called in the same lexical
869 * scope and pointer to the same integer is passed as \a refcheck. This is
870 * used to detect missed cl_env_put().
874 struct lu_env *cl_env_get(int *refcheck)
878 env = cl_env_peek(refcheck);
880 env = cl_env_obtain(__builtin_return_address(0));
884 cle = cl_env_container(env);
886 *refcheck = cle->ce_ref;
887 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
892 EXPORT_SYMBOL(cl_env_get);
895 * Forces an allocation of a fresh environment with given tags.
899 struct lu_env *cl_env_alloc(int *refcheck, __u32 tags)
903 LASSERT(cl_env_peek(refcheck) == NULL);
904 env = cl_env_new(tags, tags, __builtin_return_address(0));
908 cle = cl_env_container(env);
909 *refcheck = cle->ce_ref;
910 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
914 EXPORT_SYMBOL(cl_env_alloc);
916 static void cl_env_exit(struct cl_env *cle)
918 LASSERT(cle->ce_owner == NULL);
919 lu_context_exit(&cle->ce_lu.le_ctx);
920 lu_context_exit(&cle->ce_ses);
924 * Finalizes and frees a given number of cached environments. This is done to
925 * (1) free some memory (not currently hooked into VM), or (2) release
926 * references to modules.
928 unsigned cl_env_cache_purge(unsigned nr)
933 cfs_spin_lock(&cl_envs_guard);
934 for (; !cfs_list_empty(&cl_envs) && nr > 0; --nr) {
935 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
936 cfs_list_del_init(&cle->ce_linkage);
937 LASSERT(cl_envs_cached_nr > 0);
939 cfs_spin_unlock(&cl_envs_guard);
942 cfs_spin_lock(&cl_envs_guard);
944 LASSERT(equi(cl_envs_cached_nr == 0, cfs_list_empty(&cl_envs)));
945 cfs_spin_unlock(&cl_envs_guard);
948 EXPORT_SYMBOL(cl_env_cache_purge);
951 * Release an environment.
953 * Decrement \a env reference counter. When counter drops to 0, nothing in
954 * this thread is using environment and it is returned to the allocation
955 * cache, or freed straight away, if cache is large enough.
957 void cl_env_put(struct lu_env *env, int *refcheck)
961 cle = cl_env_container(env);
963 LASSERT(cle->ce_ref > 0);
964 LASSERT(ergo(refcheck != NULL, cle->ce_ref == *refcheck));
966 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
967 if (--cle->ce_ref == 0) {
970 cle->ce_debug = NULL;
973 * Don't bother to take a lock here.
975 * Return environment to the cache only when it was allocated
976 * with the standard tags.
978 if (cl_envs_cached_nr < cl_envs_cached_max &&
979 (env->le_ctx.lc_tags & ~LCT_HAS_EXIT) == LCT_CL_THREAD &&
980 (env->le_ses->lc_tags & ~LCT_HAS_EXIT) == LCT_SESSION) {
981 cfs_spin_lock(&cl_envs_guard);
982 cfs_list_add(&cle->ce_linkage, &cl_envs);
984 cfs_spin_unlock(&cl_envs_guard);
989 EXPORT_SYMBOL(cl_env_put);
992 * Declares a point of re-entrancy.
994 * \see cl_env_reexit()
996 void *cl_env_reenter(void)
998 return cl_env_detach(NULL);
1000 EXPORT_SYMBOL(cl_env_reenter);
1003 * Exits re-entrancy.
1005 void cl_env_reexit(void *cookie)
1007 cl_env_detach(NULL);
1008 cl_env_attach(cookie);
1010 EXPORT_SYMBOL(cl_env_reexit);
1013 * Setup user-supplied \a env as a current environment. This is to be used to
1014 * guaranteed that environment exists even when cl_env_get() fails. It is up
1015 * to user to ensure proper concurrency control.
1017 * \see cl_env_unplant()
1019 void cl_env_implant(struct lu_env *env, int *refcheck)
1021 struct cl_env *cle = cl_env_container(env);
1023 LASSERT(cle->ce_ref > 0);
1026 cl_env_get(refcheck);
1027 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1029 EXPORT_SYMBOL(cl_env_implant);
1032 * Detach environment installed earlier by cl_env_implant().
1034 void cl_env_unplant(struct lu_env *env, int *refcheck)
1036 struct cl_env *cle = cl_env_container(env);
1038 LASSERT(cle->ce_ref > 1);
1040 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1043 cl_env_put(env, refcheck);
1045 EXPORT_SYMBOL(cl_env_unplant);
1047 struct lu_env *cl_env_nested_get(struct cl_env_nest *nest)
1051 nest->cen_cookie = NULL;
1052 env = cl_env_peek(&nest->cen_refcheck);
1054 if (!cl_io_is_going(env))
1057 cl_env_put(env, &nest->cen_refcheck);
1058 nest->cen_cookie = cl_env_reenter();
1061 env = cl_env_get(&nest->cen_refcheck);
1063 cl_env_reexit(nest->cen_cookie);
1067 LASSERT(!cl_io_is_going(env));
1070 EXPORT_SYMBOL(cl_env_nested_get);
1072 void cl_env_nested_put(struct cl_env_nest *nest, struct lu_env *env)
1074 cl_env_put(env, &nest->cen_refcheck);
1075 cl_env_reexit(nest->cen_cookie);
1077 EXPORT_SYMBOL(cl_env_nested_put);
1080 * Converts struct cl_attr to struct ost_lvb.
1084 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr)
1087 lvb->lvb_size = attr->cat_size;
1088 lvb->lvb_mtime = attr->cat_mtime;
1089 lvb->lvb_atime = attr->cat_atime;
1090 lvb->lvb_ctime = attr->cat_ctime;
1091 lvb->lvb_blocks = attr->cat_blocks;
1094 EXPORT_SYMBOL(cl_attr2lvb);
1097 * Converts struct ost_lvb to struct cl_attr.
1101 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb)
1104 attr->cat_size = lvb->lvb_size;
1105 attr->cat_mtime = lvb->lvb_mtime;
1106 attr->cat_atime = lvb->lvb_atime;
1107 attr->cat_ctime = lvb->lvb_ctime;
1108 attr->cat_blocks = lvb->lvb_blocks;
1111 EXPORT_SYMBOL(cl_lvb2attr);
1113 /*****************************************************************************
1115 * Temporary prototype thing: mirror obd-devices into cl devices.
1119 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
1120 struct lu_device_type *ldt,
1121 struct lu_device *next)
1123 const char *typename;
1124 struct lu_device *d;
1126 LASSERT(ldt != NULL);
1128 typename = ldt->ldt_name;
1129 d = ldt->ldt_ops->ldto_device_alloc(env, ldt, NULL);
1135 rc = ldt->ldt_ops->ldto_device_init(env, d, typename, next);
1138 lu_ref_add(&d->ld_reference,
1139 "lu-stack", &lu_site_init);
1141 ldt->ldt_ops->ldto_device_free(env, d);
1142 CERROR("can't init device '%s', %d\n", typename, rc);
1146 CERROR("Cannot allocate device: '%s'\n", typename);
1147 return lu2cl_dev(d);
1149 EXPORT_SYMBOL(cl_type_setup);
1152 * Finalize device stack by calling lu_stack_fini().
1154 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl)
1156 lu_stack_fini(env, cl2lu_dev(cl));
1158 EXPORT_SYMBOL(cl_stack_fini);
1160 int cl_lock_init(void);
1161 void cl_lock_fini(void);
1163 int cl_page_init(void);
1164 void cl_page_fini(void);
1166 static struct lu_context_key cl_key;
1168 struct cl_thread_info *cl_env_info(const struct lu_env *env)
1170 return lu_context_key_get(&env->le_ctx, &cl_key);
1173 /* defines cl0_key_{init,fini}() */
1174 LU_KEY_INIT_FINI(cl0, struct cl_thread_info);
1176 static void *cl_key_init(const struct lu_context *ctx,
1177 struct lu_context_key *key)
1179 struct cl_thread_info *info;
1181 info = cl0_key_init(ctx, key);
1182 if (!IS_ERR(info)) {
1185 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1186 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1191 static void cl_key_fini(const struct lu_context *ctx,
1192 struct lu_context_key *key, void *data)
1194 struct cl_thread_info *info;
1198 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1199 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1200 cl0_key_fini(ctx, key, data);
1203 static void cl_key_exit(const struct lu_context *ctx,
1204 struct lu_context_key *key, void *data)
1206 struct cl_thread_info *info = data;
1209 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i) {
1210 LASSERT(info->clt_counters[i].ctc_nr_held == 0);
1211 LASSERT(info->clt_counters[i].ctc_nr_used == 0);
1212 LASSERT(info->clt_counters[i].ctc_nr_locks_acquired == 0);
1213 LASSERT(info->clt_counters[i].ctc_nr_locks_locked == 0);
1214 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1215 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1219 static struct lu_context_key cl_key = {
1220 .lct_tags = LCT_CL_THREAD,
1221 .lct_init = cl_key_init,
1222 .lct_fini = cl_key_fini,
1223 .lct_exit = cl_key_exit
1226 static struct lu_kmem_descr cl_object_caches[] = {
1228 .ckd_cache = &cl_env_kmem,
1229 .ckd_name = "cl_env_kmem",
1230 .ckd_size = sizeof (struct cl_env)
1238 * Global initialization of cl-data. Create kmem caches, register
1239 * lu_context_key's, etc.
1241 * \see cl_global_fini()
1243 int cl_global_init(void)
1247 result = cl_env_store_init();
1251 result = lu_kmem_init(cl_object_caches);
1255 LU_CONTEXT_KEY_INIT(&cl_key);
1256 result = lu_context_key_register(&cl_key);
1260 result = cl_lock_init();
1264 result = cl_page_init();
1272 lu_context_key_degister(&cl_key);
1274 lu_kmem_fini(cl_object_caches);
1276 cl_env_store_fini();
1281 * Finalization of global cl-data. Dual to cl_global_init().
1283 void cl_global_fini(void)
1287 lu_context_key_degister(&cl_key);
1288 lu_kmem_fini(cl_object_caches);
1289 cl_env_store_fini();