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 2008 Sun Microsystems, Inc. All rights reserved.
30 * Use is subject to license terms.
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>
52 #define DEBUG_SUBSYSTEM S_CLASS
54 # define EXPORT_SYMTAB
57 #include <libcfs/libcfs.h>
58 /* class_put_type() */
59 #include <obd_class.h>
60 #include <obd_support.h>
61 #include <lustre_fid.h>
62 #include <libcfs/list.h>
63 #include <libcfs/libcfs_hash.h> /* for cfs_hash stuff */
64 /* lu_time_global_{init,fini}() */
67 #include <cl_object.h>
68 #include "cl_internal.h"
70 static cfs_mem_cache_t *cl_env_kmem;
72 /** Lock class of cl_object_header::coh_page_guard */
73 static struct lock_class_key cl_page_guard_class;
74 /** Lock class of cl_object_header::coh_lock_guard */
75 static struct lock_class_key cl_lock_guard_class;
76 /** Lock class of cl_object_header::coh_attr_guard */
77 static struct lock_class_key cl_attr_guard_class;
80 * Initialize cl_object_header.
82 int cl_object_header_init(struct cl_object_header *h)
87 result = lu_object_header_init(&h->coh_lu);
89 spin_lock_init(&h->coh_page_guard);
90 spin_lock_init(&h->coh_lock_guard);
91 spin_lock_init(&h->coh_attr_guard);
92 lockdep_set_class(&h->coh_attr_guard, &cl_page_guard_class);
93 lockdep_set_class(&h->coh_attr_guard, &cl_lock_guard_class);
94 lockdep_set_class(&h->coh_attr_guard, &cl_attr_guard_class);
96 /* XXX hard coded GFP_* mask. */
97 INIT_RADIX_TREE(&h->coh_tree, GFP_ATOMIC);
98 CFS_INIT_LIST_HEAD(&h->coh_locks);
102 EXPORT_SYMBOL(cl_object_header_init);
105 * Finalize cl_object_header.
107 void cl_object_header_fini(struct cl_object_header *h)
109 LASSERT(list_empty(&h->coh_locks));
110 lu_object_header_fini(&h->coh_lu);
112 EXPORT_SYMBOL(cl_object_header_fini);
115 * Returns a cl_object with a given \a fid.
117 * Returns either cached or newly created object. Additional reference on the
118 * returned object is acquired.
120 * \see lu_object_find(), cl_page_find(), cl_lock_find()
122 struct cl_object *cl_object_find(const struct lu_env *env,
123 struct cl_device *cd, const struct lu_fid *fid,
124 const struct cl_object_conf *c)
127 return lu2cl(lu_object_find_slice(env, cl2lu_dev(cd), fid, &c->coc_lu));
129 EXPORT_SYMBOL(cl_object_find);
132 * Releases a reference on \a o.
134 * When last reference is released object is returned to the cache, unless
135 * lu_object_header_flags::LU_OBJECT_HEARD_BANSHEE bit is set in its header.
137 * \see cl_page_put(), cl_lock_put().
139 void cl_object_put(const struct lu_env *env, struct cl_object *o)
141 lu_object_put(env, &o->co_lu);
143 EXPORT_SYMBOL(cl_object_put);
146 * Acquire an additional reference to the object \a o.
148 * This can only be used to acquire _additional_ reference, i.e., caller
149 * already has to possess at least one reference to \a o before calling this.
151 * \see cl_page_get(), cl_lock_get().
153 void cl_object_get(struct cl_object *o)
155 lu_object_get(&o->co_lu);
157 EXPORT_SYMBOL(cl_object_get);
160 * Returns the top-object for a given \a o.
162 * \see cl_page_top(), cl_io_top()
164 struct cl_object *cl_object_top(struct cl_object *o)
166 struct cl_object_header *hdr = cl_object_header(o);
167 struct cl_object *top;
169 while (hdr->coh_parent != NULL)
170 hdr = hdr->coh_parent;
172 top = lu2cl(lu_object_top(&hdr->coh_lu));
173 CDEBUG(D_TRACE, "%p -> %p\n", o, top);
176 EXPORT_SYMBOL(cl_object_top);
179 * Returns pointer to the lock protecting data-attributes for the given object
182 * Data-attributes are protected by the cl_object_header::coh_attr_guard
183 * spin-lock in the top-object.
185 * \see cl_attr, cl_object_attr_lock(), cl_object_operations::coo_attr_get().
187 static spinlock_t *cl_object_attr_guard(struct cl_object *o)
189 return &cl_object_header(cl_object_top(o))->coh_attr_guard;
193 * Locks data-attributes.
195 * Prevents data-attributes from changing, until lock is released by
196 * cl_object_attr_unlock(). This has to be called before calls to
197 * cl_object_attr_get(), cl_object_attr_set().
199 void cl_object_attr_lock(struct cl_object *o)
201 spin_lock(cl_object_attr_guard(o));
203 EXPORT_SYMBOL(cl_object_attr_lock);
206 * Releases data-attributes lock, acquired by cl_object_attr_lock().
208 void cl_object_attr_unlock(struct cl_object *o)
210 spin_unlock(cl_object_attr_guard(o));
212 EXPORT_SYMBOL(cl_object_attr_unlock);
215 * Returns data-attributes of an object \a obj.
217 * Every layer is asked (by calling cl_object_operations::coo_attr_get())
218 * top-to-bottom to fill in parts of \a attr that this layer is responsible
221 int cl_object_attr_get(const struct lu_env *env, struct cl_object *obj,
222 struct cl_attr *attr)
224 struct lu_object_header *top;
227 LASSERT_SPIN_LOCKED(cl_object_attr_guard(obj));
230 top = obj->co_lu.lo_header;
232 list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
233 if (obj->co_ops->coo_attr_get != NULL) {
234 result = obj->co_ops->coo_attr_get(env, obj, attr);
244 EXPORT_SYMBOL(cl_object_attr_get);
247 * Updates data-attributes of an object \a obj.
249 * Only attributes, mentioned in a validness bit-mask \a v are
250 * updated. Calls cl_object_operations::coo_attr_set() on every layer, bottom
253 int cl_object_attr_set(const struct lu_env *env, struct cl_object *obj,
254 const struct cl_attr *attr, unsigned v)
256 struct lu_object_header *top;
259 LASSERT_SPIN_LOCKED(cl_object_attr_guard(obj));
262 top = obj->co_lu.lo_header;
264 list_for_each_entry_reverse(obj, &top->loh_layers, co_lu.lo_linkage) {
265 if (obj->co_ops->coo_attr_set != NULL) {
266 result = obj->co_ops->coo_attr_set(env, obj, attr, v);
276 EXPORT_SYMBOL(cl_object_attr_set);
279 * Notifies layers (bottom-to-top) that glimpse AST was received.
281 * Layers have to fill \a lvb fields with information that will be shipped
282 * back to glimpse issuer.
284 * \see cl_lock_operations::clo_glimpse()
286 int cl_object_glimpse(const struct lu_env *env, struct cl_object *obj,
289 struct lu_object_header *top;
293 top = obj->co_lu.lo_header;
295 list_for_each_entry_reverse(obj, &top->loh_layers, co_lu.lo_linkage) {
296 if (obj->co_ops->coo_glimpse != NULL) {
297 result = obj->co_ops->coo_glimpse(env, obj, lvb);
302 LU_OBJECT_HEADER(D_DLMTRACE, env, lu_object_top(top),
303 "size: "LPU64" mtime: "LPU64" atime: "LPU64" "
304 "ctime: "LPU64" blocks: "LPU64"\n",
305 lvb->lvb_size, lvb->lvb_mtime, lvb->lvb_atime,
306 lvb->lvb_ctime, lvb->lvb_blocks);
309 EXPORT_SYMBOL(cl_object_glimpse);
312 * Updates a configuration of an object \a obj.
314 int cl_conf_set(const struct lu_env *env, struct cl_object *obj,
315 const struct cl_object_conf *conf)
317 struct lu_object_header *top;
321 top = obj->co_lu.lo_header;
323 list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
324 if (obj->co_ops->coo_conf_set != NULL) {
325 result = obj->co_ops->coo_conf_set(env, obj, conf);
332 EXPORT_SYMBOL(cl_conf_set);
335 * Helper function removing all object locks, and marking object for
336 * deletion. All object pages must have been deleted at this point.
338 * This is called by cl_inode_fini() and lov_object_delete() to destroy top-
339 * and sub- objects respectively.
341 void cl_object_kill(const struct lu_env *env, struct cl_object *obj)
343 struct cl_object_header *hdr;
345 hdr = cl_object_header(obj);
346 LASSERT(hdr->coh_tree.rnode == NULL);
347 LASSERT(hdr->coh_pages == 0);
349 set_bit(LU_OBJECT_HEARD_BANSHEE, &hdr->coh_lu.loh_flags);
351 * Destroy all locks. Object destruction (including cl_inode_fini())
352 * cannot cancel the locks, because in the case of a local client,
353 * where client and server share the same thread running
354 * prune_icache(), this can dead-lock with ldlm_cancel_handler()
355 * waiting on __wait_on_freeing_inode().
357 cl_locks_prune(env, obj, 0);
359 EXPORT_SYMBOL(cl_object_kill);
362 * Prunes caches of pages and locks for this object.
364 void cl_object_prune(const struct lu_env *env, struct cl_object *obj)
367 cl_pages_prune(env, obj);
368 cl_locks_prune(env, obj, 1);
371 EXPORT_SYMBOL(cl_object_prune);
374 * Check if the object has locks.
376 int cl_object_has_locks(struct cl_object *obj)
378 struct cl_object_header *head = cl_object_header(obj);
381 spin_lock(&head->coh_lock_guard);
382 has = list_empty(&head->coh_locks);
383 spin_unlock(&head->coh_lock_guard);
387 EXPORT_SYMBOL(cl_object_has_locks);
389 void cache_stats_init(struct cache_stats *cs, const char *name)
392 atomic_set(&cs->cs_lookup, 0);
393 atomic_set(&cs->cs_hit, 0);
394 atomic_set(&cs->cs_total, 0);
395 atomic_set(&cs->cs_busy, 0);
398 int cache_stats_print(const struct cache_stats *cs,
399 char *page, int count, int h)
403 lookup hit total cached create
404 env: ...... ...... ...... ...... ......
407 nob += snprintf(page, count,
408 " lookup hit total busy create\n");
410 nob += snprintf(page + nob, count - nob,
411 "%5.5s: %6u %6u %6u %6u %6u",
413 atomic_read(&cs->cs_lookup),
414 atomic_read(&cs->cs_hit),
415 atomic_read(&cs->cs_total),
416 atomic_read(&cs->cs_busy),
417 atomic_read(&cs->cs_created));
422 * Initialize client site.
424 * Perform common initialization (lu_site_init()), and initialize statistical
425 * counters. Also perform global initializations on the first call.
427 int cl_site_init(struct cl_site *s, struct cl_device *d)
432 result = lu_site_init(&s->cs_lu, &d->cd_lu_dev);
434 cache_stats_init(&s->cs_pages, "pages");
435 cache_stats_init(&s->cs_locks, "locks");
436 for (i = 0; i < ARRAY_SIZE(s->cs_pages_state); ++i)
437 atomic_set(&s->cs_pages_state[0], 0);
438 for (i = 0; i < ARRAY_SIZE(s->cs_locks_state); ++i)
439 atomic_set(&s->cs_locks_state[i], 0);
443 EXPORT_SYMBOL(cl_site_init);
446 * Finalize client site. Dual to cl_site_init().
448 void cl_site_fini(struct cl_site *s)
450 lu_site_fini(&s->cs_lu);
452 EXPORT_SYMBOL(cl_site_fini);
454 static struct cache_stats cl_env_stats = {
456 .cs_created = ATOMIC_INIT(0),
457 .cs_lookup = ATOMIC_INIT(0),
458 .cs_hit = ATOMIC_INIT(0),
459 .cs_total = ATOMIC_INIT(0),
460 .cs_busy = ATOMIC_INIT(0)
464 * Outputs client site statistical counters into a buffer. Suitable for
465 * ll_rd_*()-style functions.
467 int cl_site_stats_print(const struct cl_site *site, char *page, int count)
471 static const char *pstate[] = {
478 static const char *lstate[] = {
481 [CLS_ENQUEUED] = "e",
483 [CLS_INTRANSIT] = "t",
488 lookup hit total busy create
489 pages: ...... ...... ...... ...... ...... [...... ...... ...... ......]
490 locks: ...... ...... ...... ...... ...... [...... ...... ...... ...... ......]
491 env: ...... ...... ...... ...... ......
493 nob = lu_site_stats_print(&site->cs_lu, page, count);
494 nob += cache_stats_print(&site->cs_pages, page + nob, count - nob, 1);
495 nob += snprintf(page + nob, count - nob, " [");
496 for (i = 0; i < ARRAY_SIZE(site->cs_pages_state); ++i)
497 nob += snprintf(page + nob, count - nob, "%s: %u ",
499 atomic_read(&site->cs_pages_state[i]));
500 nob += snprintf(page + nob, count - nob, "]\n");
501 nob += cache_stats_print(&site->cs_locks, page + nob, count - nob, 0);
502 nob += snprintf(page + nob, count - nob, " [");
503 for (i = 0; i < ARRAY_SIZE(site->cs_locks_state); ++i)
504 nob += snprintf(page + nob, count - nob, "%s: %u ",
506 atomic_read(&site->cs_locks_state[i]));
507 nob += snprintf(page + nob, count - nob, "]\n");
508 nob += cache_stats_print(&cl_env_stats, page + nob, count - nob, 0);
509 nob += snprintf(page + nob, count - nob, "\n");
512 EXPORT_SYMBOL(cl_site_stats_print);
514 /*****************************************************************************
516 * lu_env handling on client.
520 static CFS_LIST_HEAD(cl_envs);
521 static unsigned cl_envs_cached_nr = 0;
522 static unsigned cl_envs_cached_max = 128; /* XXX: prototype: arbitrary limit
524 static spinlock_t cl_envs_guard = SPIN_LOCK_UNLOCKED;
529 struct lu_context ce_ses;
531 * This allows cl_env to be entered into cl_env_hash which implements
532 * the current thread -> client environment lookup.
534 struct hlist_node ce_node;
536 * Owner for the current cl_env, the key for cfs_hash.
537 * Now current thread pointer is stored.
541 * Linkage into global list of all client environments. Used for
542 * garbage collection.
544 struct list_head ce_linkage;
550 * Debugging field: address of the caller who made original
556 #define CL_ENV_INC(counter) atomic_inc(&cl_env_stats.counter)
558 #define CL_ENV_DEC(counter) \
560 LASSERT(atomic_read(&cl_env_stats.counter) > 0); \
561 atomic_dec(&cl_env_stats.counter); \
564 /*****************************************************************************
565 * Routins to use cfs_hash functionality to bind the current thread
569 /** lustre hash to manage the cl_env for current thread */
570 static cfs_hash_t *cl_env_hash;
571 static void cl_env_init0(struct cl_env *cle, void *debug);
573 static unsigned cl_env_hops_hash(cfs_hash_t *lh, void *key, unsigned mask)
575 #if BITS_PER_LONG == 64
576 return cfs_hash_u64_hash((__u64)key, mask);
578 return cfs_hash_u32_hash((__u32)key, mask);
582 static void *cl_env_hops_obj(struct hlist_node *hn)
584 struct cl_env *cle = hlist_entry(hn, struct cl_env, ce_node);
585 LASSERT(cle->ce_magic == &cl_env_init0);
589 static int cl_env_hops_compare(void *key, struct hlist_node *hn)
591 struct cl_env *cle = cl_env_hops_obj(hn);
593 LASSERT(cle->ce_owner != NULL);
594 return (key == cle->ce_owner);
597 static cfs_hash_ops_t cl_env_hops = {
598 .hs_hash = cl_env_hops_hash,
599 .hs_compare = cl_env_hops_compare,
600 .hs_key = cl_env_hops_obj,
601 .hs_get = cl_env_hops_obj,
602 .hs_put = cl_env_hops_obj,
605 static inline struct cl_env *cl_env_fetch(void)
608 cle = cfs_hash_lookup(cl_env_hash, cfs_current());
609 LASSERT(ergo(cle, cle->ce_magic == &cl_env_init0));
613 static inline void cl_env_attach(struct cl_env *cle)
617 LASSERT(cle->ce_owner == NULL);
618 cle->ce_owner = cfs_current();
619 rc = cfs_hash_add_unique(cl_env_hash, cle->ce_owner,
625 static inline struct cl_env *cl_env_detach(struct cl_env *cle)
628 cle = cl_env_fetch();
629 if (cle && cle->ce_owner) {
631 LASSERT(cle->ce_owner == cfs_current());
632 cookie = cfs_hash_del(cl_env_hash, cle->ce_owner,
634 cle->ce_owner = NULL;
635 LASSERT(cookie == cle);
639 /* ----------------------- hash routines end ---------------------------- */
641 static void cl_env_init0(struct cl_env *cle, void *debug)
643 LASSERT(cle->ce_ref == 0);
644 LASSERT(cle->ce_magic == &cl_env_init0);
645 LASSERT(cle->ce_debug == NULL && cle->ce_owner == NULL);
648 cle->ce_debug = debug;
652 static struct lu_env *cl_env_new(__u32 tags, void *debug)
657 OBD_SLAB_ALLOC_PTR_GFP(cle, cl_env_kmem, CFS_ALLOC_IO);
661 CFS_INIT_LIST_HEAD(&cle->ce_linkage);
662 cle->ce_magic = &cl_env_init0;
664 rc = lu_env_init(env, LCT_CL_THREAD|tags);
666 rc = lu_context_init(&cle->ce_ses, LCT_SESSION|tags);
668 lu_context_enter(&cle->ce_ses);
669 env->le_ses = &cle->ce_ses;
670 cl_env_init0(cle, debug);
675 OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
678 CL_ENV_INC(cs_created);
679 CL_ENV_INC(cs_total);
682 env = ERR_PTR(-ENOMEM);
686 static void cl_env_fini(struct cl_env *cle)
688 CL_ENV_DEC(cs_total);
689 lu_context_fini(&cle->ce_lu.le_ctx);
690 lu_context_fini(&cle->ce_ses);
691 OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
694 static struct lu_env *cl_env_obtain(void *debug)
700 spin_lock(&cl_envs_guard);
701 LASSERT(equi(cl_envs_cached_nr == 0, list_empty(&cl_envs)));
702 if (cl_envs_cached_nr > 0) {
705 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
706 list_del_init(&cle->ce_linkage);
708 spin_unlock(&cl_envs_guard);
711 rc = lu_env_refill(env);
713 cl_env_init0(cle, debug);
714 lu_context_enter(&env->le_ctx);
715 lu_context_enter(&cle->ce_ses);
721 spin_unlock(&cl_envs_guard);
722 env = cl_env_new(0, debug);
727 static inline struct cl_env *cl_env_container(struct lu_env *env)
729 return container_of(env, struct cl_env, ce_lu);
732 struct lu_env *cl_env_peek(int *refcheck)
737 CL_ENV_INC(cs_lookup);
739 /* check that we don't go far from untrusted pointer */
740 CLASSERT(offsetof(struct cl_env, ce_magic) == 0);
743 cle = cl_env_fetch();
747 *refcheck = ++cle->ce_ref;
749 CDEBUG(D_OTHER, "%i@%p\n", cle ? cle->ce_ref : 0, cle);
752 EXPORT_SYMBOL(cl_env_peek);
755 * Returns lu_env: if there already is an environment associated with the
756 * current thread, it is returned, otherwise, new environment is allocated.
758 * Allocations are amortized through the global cache of environments.
760 * \param refcheck pointer to a counter used to detect environment leaks. In
761 * the usual case cl_env_get() and cl_env_put() are called in the same lexical
762 * scope and pointer to the same integer is passed as \a refcheck. This is
763 * used to detect missed cl_env_put().
767 struct lu_env *cl_env_get(int *refcheck)
771 env = cl_env_peek(refcheck);
773 env = cl_env_obtain(__builtin_return_address(0));
777 cle = cl_env_container(env);
779 *refcheck = cle->ce_ref;
780 CDEBUG(D_OTHER, "%i@%p\n", cle->ce_ref, cle);
785 EXPORT_SYMBOL(cl_env_get);
788 * Forces an allocation of a fresh environment with given tags.
792 struct lu_env *cl_env_alloc(int *refcheck, __u32 tags)
796 LASSERT(cl_env_peek(refcheck) == NULL);
797 env = cl_env_new(tags, __builtin_return_address(0));
801 cle = cl_env_container(env);
802 *refcheck = cle->ce_ref;
803 CDEBUG(D_OTHER, "%i@%p\n", cle->ce_ref, cle);
807 EXPORT_SYMBOL(cl_env_alloc);
809 static void cl_env_exit(struct cl_env *cle)
811 LASSERT(cle->ce_owner == NULL);
812 lu_context_exit(&cle->ce_lu.le_ctx);
813 lu_context_exit(&cle->ce_ses);
817 * Finalizes and frees a given number of cached environments. This is done to
818 * (1) free some memory (not currently hooked into VM), or (2) release
819 * references to modules.
821 unsigned cl_env_cache_purge(unsigned nr)
826 spin_lock(&cl_envs_guard);
827 for (; !list_empty(&cl_envs) && nr > 0; --nr) {
828 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
829 list_del_init(&cle->ce_linkage);
830 LASSERT(cl_envs_cached_nr > 0);
832 spin_unlock(&cl_envs_guard);
835 spin_lock(&cl_envs_guard);
837 LASSERT(equi(cl_envs_cached_nr == 0, list_empty(&cl_envs)));
838 spin_unlock(&cl_envs_guard);
841 EXPORT_SYMBOL(cl_env_cache_purge);
844 * Release an environment.
846 * Decrement \a env reference counter. When counter drops to 0, nothing in
847 * this thread is using environment and it is returned to the allocation
848 * cache, or freed straight away, if cache is large enough.
850 void cl_env_put(struct lu_env *env, int *refcheck)
854 cle = cl_env_container(env);
856 LASSERT(cle->ce_ref > 0);
857 LASSERT(ergo(refcheck != NULL, cle->ce_ref == *refcheck));
859 CDEBUG(D_OTHER, "%i@%p\n", cle->ce_ref, cle);
860 if (--cle->ce_ref == 0) {
863 cle->ce_debug = NULL;
866 * Don't bother to take a lock here.
868 * Return environment to the cache only when it was allocated
869 * with the standard tags.
871 if (cl_envs_cached_nr < cl_envs_cached_max &&
872 (env->le_ctx.lc_tags & ~LCT_HAS_EXIT) == LCT_CL_THREAD &&
873 (env->le_ses->lc_tags & ~LCT_HAS_EXIT) == LCT_SESSION) {
874 spin_lock(&cl_envs_guard);
875 list_add(&cle->ce_linkage, &cl_envs);
877 spin_unlock(&cl_envs_guard);
882 EXPORT_SYMBOL(cl_env_put);
885 * Declares a point of re-entrancy.
887 * \see cl_env_reexit()
889 void *cl_env_reenter(void)
891 return cl_env_detach(NULL);
893 EXPORT_SYMBOL(cl_env_reenter);
898 void cl_env_reexit(void *cookie)
901 cl_env_attach(cookie);
903 EXPORT_SYMBOL(cl_env_reexit);
906 * Setup user-supplied \a env as a current environment. This is to be used to
907 * guaranteed that environment exists even when cl_env_get() fails. It is up
908 * to user to ensure proper concurrency control.
910 * \see cl_env_unplant()
912 void cl_env_implant(struct lu_env *env, int *refcheck)
914 struct cl_env *cle = cl_env_container(env);
916 LASSERT(cle->ce_ref > 0);
919 cl_env_get(refcheck);
920 CDEBUG(D_OTHER, "%i@%p\n", cle->ce_ref, cle);
922 EXPORT_SYMBOL(cl_env_implant);
925 * Detach environment installed earlier by cl_env_implant().
927 void cl_env_unplant(struct lu_env *env, int *refcheck)
929 struct cl_env *cle = cl_env_container(env);
931 LASSERT(cle->ce_ref > 1);
933 CDEBUG(D_OTHER, "%i@%p\n", cle->ce_ref, cle);
936 cl_env_put(env, refcheck);
938 EXPORT_SYMBOL(cl_env_unplant);
940 struct lu_env *cl_env_nested_get(struct cl_env_nest *nest)
944 nest->cen_cookie = NULL;
945 env = cl_env_peek(&nest->cen_refcheck);
947 if (!cl_io_is_going(env))
950 cl_env_put(env, &nest->cen_refcheck);
951 nest->cen_cookie = cl_env_reenter();
954 env = cl_env_get(&nest->cen_refcheck);
956 cl_env_reexit(nest->cen_cookie);
960 LASSERT(!cl_io_is_going(env));
963 EXPORT_SYMBOL(cl_env_nested_get);
965 void cl_env_nested_put(struct cl_env_nest *nest, struct lu_env *env)
967 cl_env_put(env, &nest->cen_refcheck);
968 cl_env_reexit(nest->cen_cookie);
970 EXPORT_SYMBOL(cl_env_nested_put);
973 * Converts struct cl_attr to struct ost_lvb.
977 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr)
980 lvb->lvb_size = attr->cat_size;
981 lvb->lvb_mtime = attr->cat_mtime;
982 lvb->lvb_atime = attr->cat_atime;
983 lvb->lvb_ctime = attr->cat_ctime;
984 lvb->lvb_blocks = attr->cat_blocks;
987 EXPORT_SYMBOL(cl_attr2lvb);
990 * Converts struct ost_lvb to struct cl_attr.
994 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb)
997 attr->cat_size = lvb->lvb_size;
998 attr->cat_mtime = lvb->lvb_mtime;
999 attr->cat_atime = lvb->lvb_atime;
1000 attr->cat_ctime = lvb->lvb_ctime;
1001 attr->cat_blocks = lvb->lvb_blocks;
1004 EXPORT_SYMBOL(cl_lvb2attr);
1006 /*****************************************************************************
1008 * Temporary prototype thing: mirror obd-devices into cl devices.
1012 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
1013 struct lu_device_type *ldt,
1014 struct lu_device *next)
1016 const char *typename;
1017 struct lu_device *d;
1019 LASSERT(ldt != NULL);
1021 typename = ldt->ldt_name;
1022 d = ldt->ldt_ops->ldto_device_alloc(env, ldt, NULL);
1028 rc = ldt->ldt_ops->ldto_device_init(env, d, typename, next);
1031 lu_ref_add(&d->ld_reference,
1032 "lu-stack", &lu_site_init);
1034 ldt->ldt_ops->ldto_device_free(env, d);
1035 CERROR("can't init device '%s', %d\n", typename, rc);
1039 CERROR("Cannot allocate device: '%s'\n", typename);
1040 return lu2cl_dev(d);
1042 EXPORT_SYMBOL(cl_type_setup);
1045 * Finalize device stack by calling lu_stack_fini().
1047 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl)
1049 lu_stack_fini(env, cl2lu_dev(cl));
1051 EXPORT_SYMBOL(cl_stack_fini);
1053 int cl_lock_init(void);
1054 void cl_lock_fini(void);
1056 int cl_page_init(void);
1057 void cl_page_fini(void);
1059 static struct lu_context_key cl_key;
1061 struct cl_thread_info *cl_env_info(const struct lu_env *env)
1063 return lu_context_key_get(&env->le_ctx, &cl_key);
1066 /* defines cl0_key_{init,fini}() */
1067 LU_KEY_INIT_FINI(cl0, struct cl_thread_info);
1069 static void *cl_key_init(const struct lu_context *ctx,
1070 struct lu_context_key *key)
1072 struct cl_thread_info *info;
1074 info = cl0_key_init(ctx, key);
1075 if (!IS_ERR(info)) {
1078 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1079 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1084 static void cl_key_fini(const struct lu_context *ctx,
1085 struct lu_context_key *key, void *data)
1087 struct cl_thread_info *info;
1091 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1092 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1093 cl0_key_fini(ctx, key, data);
1096 static void cl_key_exit(const struct lu_context *ctx,
1097 struct lu_context_key *key, void *data)
1099 struct cl_thread_info *info = data;
1102 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i) {
1103 LASSERT(info->clt_counters[i].ctc_nr_held == 0);
1104 LASSERT(info->clt_counters[i].ctc_nr_used == 0);
1105 LASSERT(info->clt_counters[i].ctc_nr_locks_acquired == 0);
1106 LASSERT(info->clt_counters[i].ctc_nr_locks_locked == 0);
1107 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1108 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1112 static struct lu_context_key cl_key = {
1113 .lct_tags = LCT_CL_THREAD,
1114 .lct_init = cl_key_init,
1115 .lct_fini = cl_key_fini,
1116 .lct_exit = cl_key_exit
1119 static struct lu_kmem_descr cl_object_caches[] = {
1121 .ckd_cache = &cl_env_kmem,
1122 .ckd_name = "cl_env_kmem",
1123 .ckd_size = sizeof (struct cl_env)
1131 * Global initialization of cl-data. Create kmem caches, register
1132 * lu_context_key's, etc.
1134 * \see cl_global_fini()
1136 int cl_global_init(void)
1140 cl_env_hash = cfs_hash_create("cl_env", 8, 10, &cl_env_hops,
1142 if (cl_env_hash == NULL)
1145 result = lu_kmem_init(cl_object_caches);
1147 LU_CONTEXT_KEY_INIT(&cl_key);
1148 result = lu_context_key_register(&cl_key);
1150 result = cl_lock_init();
1152 result = cl_page_init();
1156 cfs_hash_destroy(cl_env_hash);
1161 * Finalization of global cl-data. Dual to cl_global_init().
1163 void cl_global_fini(void)
1167 lu_context_key_degister(&cl_key);
1168 lu_kmem_fini(cl_object_caches);
1169 cfs_hash_destroy(cl_env_hash);