4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2013, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * Client Lustre Object.
38 * Author: Nikita Danilov <nikita.danilov@sun.com>
39 * Author: Jinshan Xiong <jinshan.xiong@intel.com>
52 #define DEBUG_SUBSYSTEM S_CLASS
54 #include <libcfs/libcfs.h>
55 /* class_put_type() */
56 #include <obd_class.h>
57 #include <obd_support.h>
58 #include <lustre_fid.h>
59 #include <libcfs/list.h>
60 #include <libcfs/libcfs_hash.h> /* for cfs_hash stuff */
61 #include <cl_object.h>
62 #include "cl_internal.h"
64 static struct kmem_cache *cl_env_kmem;
66 /** Lock class of cl_object_header::coh_lock_guard */
67 static struct lock_class_key cl_lock_guard_class;
68 /** Lock class of cl_object_header::coh_attr_guard */
69 static struct lock_class_key cl_attr_guard_class;
71 extern __u32 lu_context_tags_default;
72 extern __u32 lu_session_tags_default;
74 * Initialize cl_object_header.
76 int cl_object_header_init(struct cl_object_header *h)
81 result = lu_object_header_init(&h->coh_lu);
83 spin_lock_init(&h->coh_lock_guard);
84 spin_lock_init(&h->coh_attr_guard);
85 lockdep_set_class(&h->coh_lock_guard, &cl_lock_guard_class);
86 lockdep_set_class(&h->coh_attr_guard, &cl_attr_guard_class);
87 CFS_INIT_LIST_HEAD(&h->coh_locks);
88 h->coh_page_bufsize = ALIGN(sizeof(struct cl_page), 8);
92 EXPORT_SYMBOL(cl_object_header_init);
95 * Finalize cl_object_header.
97 void cl_object_header_fini(struct cl_object_header *h)
99 LASSERT(cfs_list_empty(&h->coh_locks));
100 lu_object_header_fini(&h->coh_lu);
102 EXPORT_SYMBOL(cl_object_header_fini);
105 * Returns a cl_object with a given \a fid.
107 * Returns either cached or newly created object. Additional reference on the
108 * returned object is acquired.
110 * \see lu_object_find(), cl_page_find(), cl_lock_find()
112 struct cl_object *cl_object_find(const struct lu_env *env,
113 struct cl_device *cd, const struct lu_fid *fid,
114 const struct cl_object_conf *c)
117 return lu2cl(lu_object_find_slice(env, cl2lu_dev(cd), fid, &c->coc_lu));
119 EXPORT_SYMBOL(cl_object_find);
122 * Releases a reference on \a o.
124 * When last reference is released object is returned to the cache, unless
125 * lu_object_header_flags::LU_OBJECT_HEARD_BANSHEE bit is set in its header.
127 * \see cl_page_put(), cl_lock_put().
129 void cl_object_put(const struct lu_env *env, struct cl_object *o)
131 lu_object_put(env, &o->co_lu);
133 EXPORT_SYMBOL(cl_object_put);
136 * Acquire an additional reference to the object \a o.
138 * This can only be used to acquire _additional_ reference, i.e., caller
139 * already has to possess at least one reference to \a o before calling this.
141 * \see cl_page_get(), cl_lock_get().
143 void cl_object_get(struct cl_object *o)
145 lu_object_get(&o->co_lu);
147 EXPORT_SYMBOL(cl_object_get);
150 * Returns the top-object for a given \a o.
152 * \see cl_page_top(), cl_io_top()
154 struct cl_object *cl_object_top(struct cl_object *o)
156 struct cl_object_header *hdr = cl_object_header(o);
157 struct cl_object *top;
159 while (hdr->coh_parent != NULL)
160 hdr = hdr->coh_parent;
162 top = lu2cl(lu_object_top(&hdr->coh_lu));
163 CDEBUG(D_TRACE, "%p -> %p\n", o, top);
166 EXPORT_SYMBOL(cl_object_top);
169 * Returns pointer to the lock protecting data-attributes for the given object
172 * Data-attributes are protected by the cl_object_header::coh_attr_guard
173 * spin-lock in the top-object.
175 * \see cl_attr, cl_object_attr_lock(), cl_object_operations::coo_attr_get().
177 static spinlock_t *cl_object_attr_guard(struct cl_object *o)
179 return &cl_object_header(cl_object_top(o))->coh_attr_guard;
183 * Locks data-attributes.
185 * Prevents data-attributes from changing, until lock is released by
186 * cl_object_attr_unlock(). This has to be called before calls to
187 * cl_object_attr_get(), cl_object_attr_set().
189 void cl_object_attr_lock(struct cl_object *o)
191 spin_lock(cl_object_attr_guard(o));
193 EXPORT_SYMBOL(cl_object_attr_lock);
196 * Releases data-attributes lock, acquired by cl_object_attr_lock().
198 void cl_object_attr_unlock(struct cl_object *o)
200 spin_unlock(cl_object_attr_guard(o));
202 EXPORT_SYMBOL(cl_object_attr_unlock);
205 * Returns data-attributes of an object \a obj.
207 * Every layer is asked (by calling cl_object_operations::coo_attr_get())
208 * top-to-bottom to fill in parts of \a attr that this layer is responsible
211 int cl_object_attr_get(const struct lu_env *env, struct cl_object *obj,
212 struct cl_attr *attr)
214 struct lu_object_header *top;
217 LASSERT(spin_is_locked(cl_object_attr_guard(obj)));
220 top = obj->co_lu.lo_header;
222 cfs_list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
223 if (obj->co_ops->coo_attr_get != NULL) {
224 result = obj->co_ops->coo_attr_get(env, obj, attr);
234 EXPORT_SYMBOL(cl_object_attr_get);
237 * Updates data-attributes of an object \a obj.
239 * Only attributes, mentioned in a validness bit-mask \a v are
240 * updated. Calls cl_object_operations::coo_attr_set() on every layer, bottom
243 int cl_object_attr_set(const struct lu_env *env, struct cl_object *obj,
244 const struct cl_attr *attr, unsigned v)
246 struct lu_object_header *top;
249 LASSERT(spin_is_locked(cl_object_attr_guard(obj)));
252 top = obj->co_lu.lo_header;
254 cfs_list_for_each_entry_reverse(obj, &top->loh_layers,
256 if (obj->co_ops->coo_attr_set != NULL) {
257 result = obj->co_ops->coo_attr_set(env, obj, attr, v);
267 EXPORT_SYMBOL(cl_object_attr_set);
270 * Notifies layers (bottom-to-top) that glimpse AST was received.
272 * Layers have to fill \a lvb fields with information that will be shipped
273 * back to glimpse issuer.
275 * \see cl_lock_operations::clo_glimpse()
277 int cl_object_glimpse(const struct lu_env *env, struct cl_object *obj,
280 struct lu_object_header *top;
284 top = obj->co_lu.lo_header;
286 cfs_list_for_each_entry_reverse(obj, &top->loh_layers,
288 if (obj->co_ops->coo_glimpse != NULL) {
289 result = obj->co_ops->coo_glimpse(env, obj, lvb);
294 LU_OBJECT_HEADER(D_DLMTRACE, env, lu_object_top(top),
295 "size: "LPU64" mtime: "LPU64" atime: "LPU64" "
296 "ctime: "LPU64" blocks: "LPU64"\n",
297 lvb->lvb_size, lvb->lvb_mtime, lvb->lvb_atime,
298 lvb->lvb_ctime, lvb->lvb_blocks);
301 EXPORT_SYMBOL(cl_object_glimpse);
304 * Updates a configuration of an object \a obj.
306 int cl_conf_set(const struct lu_env *env, struct cl_object *obj,
307 const struct cl_object_conf *conf)
309 struct lu_object_header *top;
313 top = obj->co_lu.lo_header;
315 cfs_list_for_each_entry(obj, &top->loh_layers, co_lu.lo_linkage) {
316 if (obj->co_ops->coo_conf_set != NULL) {
317 result = obj->co_ops->coo_conf_set(env, obj, conf);
324 EXPORT_SYMBOL(cl_conf_set);
327 * Prunes caches of pages and locks for this object.
329 void cl_object_prune(const struct lu_env *env, struct cl_object *obj)
331 struct lu_object_header *top;
336 top = obj->co_lu.lo_header;
338 cfs_list_for_each_entry(o, &top->loh_layers, co_lu.lo_linkage) {
339 if (o->co_ops->coo_prune != NULL) {
340 result = o->co_ops->coo_prune(env, o);
346 /* TODO: pruning locks will be moved into layers after cl_lock
347 * simplification is done */
348 cl_locks_prune(env, obj, 1);
351 EXPORT_SYMBOL(cl_object_prune);
354 * Helper function removing all object locks, and marking object for
355 * deletion. All object pages must have been deleted at this point.
357 * This is called by cl_inode_fini() and lov_object_delete() to destroy top-
358 * and sub- objects respectively.
360 void cl_object_kill(const struct lu_env *env, struct cl_object *obj)
362 struct cl_object_header *hdr;
364 hdr = cl_object_header(obj);
366 set_bit(LU_OBJECT_HEARD_BANSHEE, &hdr->coh_lu.loh_flags);
368 * Destroy all locks. Object destruction (including cl_inode_fini())
369 * cannot cancel the locks, because in the case of a local client,
370 * where client and server share the same thread running
371 * prune_icache(), this can dead-lock with ldlm_cancel_handler()
372 * waiting on __wait_on_freeing_inode().
374 cl_locks_prune(env, obj, 0);
376 EXPORT_SYMBOL(cl_object_kill);
379 * Check if the object has locks.
381 int cl_object_has_locks(struct cl_object *obj)
383 struct cl_object_header *head = cl_object_header(obj);
386 spin_lock(&head->coh_lock_guard);
387 has = cfs_list_empty(&head->coh_locks);
388 spin_unlock(&head->coh_lock_guard);
392 EXPORT_SYMBOL(cl_object_has_locks);
394 void cache_stats_init(struct cache_stats *cs, const char *name)
399 for (i = 0; i < CS_NR; i++)
400 cfs_atomic_set(&cs->cs_stats[i], 0);
403 int cache_stats_print(const struct cache_stats *cs,
404 char *page, int count, int h)
409 * lookup hit total cached create
410 * env: ...... ...... ...... ...... ......
413 const char *names[CS_NR] = CS_NAMES;
415 nob += snprintf(page + nob, count - nob, "%6s", " ");
416 for (i = 0; i < CS_NR; i++)
417 nob += snprintf(page + nob, count - nob,
419 nob += snprintf(page + nob, count - nob, "\n");
422 nob += snprintf(page + nob, count - nob, "%5.5s:", cs->cs_name);
423 for (i = 0; i < CS_NR; i++)
424 nob += snprintf(page + nob, count - nob, "%8u",
425 cfs_atomic_read(&cs->cs_stats[i]));
429 static void cl_env_percpu_refill(void);
432 * Initialize client site.
434 * Perform common initialization (lu_site_init()), and initialize statistical
435 * counters. Also perform global initializations on the first call.
437 int cl_site_init(struct cl_site *s, struct cl_device *d)
442 result = lu_site_init(&s->cs_lu, &d->cd_lu_dev);
444 cache_stats_init(&s->cs_pages, "pages");
445 cache_stats_init(&s->cs_locks, "locks");
446 for (i = 0; i < ARRAY_SIZE(s->cs_pages_state); ++i)
447 cfs_atomic_set(&s->cs_pages_state[0], 0);
448 for (i = 0; i < ARRAY_SIZE(s->cs_locks_state); ++i)
449 cfs_atomic_set(&s->cs_locks_state[i], 0);
450 cl_env_percpu_refill();
454 EXPORT_SYMBOL(cl_site_init);
457 * Finalize client site. Dual to cl_site_init().
459 void cl_site_fini(struct cl_site *s)
461 lu_site_fini(&s->cs_lu);
463 EXPORT_SYMBOL(cl_site_fini);
465 static struct cache_stats cl_env_stats = {
467 .cs_stats = { CFS_ATOMIC_INIT(0), }
471 * Outputs client site statistical counters into a buffer. Suitable for
472 * ll_rd_*()-style functions.
474 int cl_site_stats_print(const struct cl_site *site, char *page, int count)
478 static const char *pstate[] = {
485 static const char *lstate[] = {
488 [CLS_ENQUEUED] = "e",
490 [CLS_INTRANSIT] = "t",
495 lookup hit total busy create
496 pages: ...... ...... ...... ...... ...... [...... ...... ...... ......]
497 locks: ...... ...... ...... ...... ...... [...... ...... ...... ...... ......]
498 env: ...... ...... ...... ...... ......
500 nob = lu_site_stats_print(&site->cs_lu, page, count);
501 nob += cache_stats_print(&site->cs_pages, page + nob, count - nob, 1);
502 nob += snprintf(page + nob, count - nob, " [");
503 for (i = 0; i < ARRAY_SIZE(site->cs_pages_state); ++i)
504 nob += snprintf(page + nob, count - nob, "%s: %u ",
506 cfs_atomic_read(&site->cs_pages_state[i]));
507 nob += snprintf(page + nob, count - nob, "]\n");
508 nob += cache_stats_print(&site->cs_locks, page + nob, count - nob, 0);
509 nob += snprintf(page + nob, count - nob, " [");
510 for (i = 0; i < ARRAY_SIZE(site->cs_locks_state); ++i)
511 nob += snprintf(page + nob, count - nob, "%s: %u ",
513 cfs_atomic_read(&site->cs_locks_state[i]));
514 nob += snprintf(page + nob, count - nob, "]\n");
515 nob += cache_stats_print(&cl_env_stats, page + nob, count - nob, 0);
516 nob += snprintf(page + nob, count - nob, "\n");
519 EXPORT_SYMBOL(cl_site_stats_print);
521 /*****************************************************************************
523 * lu_env handling on client.
528 * The most efficient way is to store cl_env pointer in task specific
529 * structures. On Linux, it wont' be easy to use task_struct->journal_info
530 * because Lustre code may call into other fs which has certain assumptions
531 * about journal_info. Currently following fields in task_struct are identified
532 * can be used for this purpose:
533 * - cl_env: for liblustre.
534 * - tux_info: ony on RedHat kernel.
536 * \note As long as we use task_struct to store cl_env, we assume that once
537 * called into Lustre, we'll never call into the other part of the kernel
538 * which will use those fields in task_struct without explicitly exiting
541 * If there's no space in task_struct is available, hash will be used.
545 static CFS_LIST_HEAD(cl_envs);
546 static unsigned cl_envs_cached_nr = 0;
547 static unsigned cl_envs_cached_max = 128; /* XXX: prototype: arbitrary limit
549 static DEFINE_SPINLOCK(cl_envs_guard);
554 struct lu_context ce_ses;
556 #ifdef LL_TASK_CL_ENV
560 * This allows cl_env to be entered into cl_env_hash which implements
561 * the current thread -> client environment lookup.
563 cfs_hlist_node_t ce_node;
566 * Owner for the current cl_env.
568 * If LL_TASK_CL_ENV is defined, this point to the owning current,
569 * only for debugging purpose ;
570 * Otherwise hash is used, and this is the key for cfs_hash.
571 * Now current thread pid is stored. Note using thread pointer would
572 * lead to unbalanced hash because of its specific allocation locality
573 * and could be varied for different platforms and OSes, even different
579 * Linkage into global list of all client environments. Used for
580 * garbage collection.
582 cfs_list_t ce_linkage;
588 * Debugging field: address of the caller who made original
594 #ifdef CONFIG_DEBUG_PAGESTATE_TRACKING
595 #define CL_ENV_INC(counter) cfs_atomic_inc(&cl_env_stats.cs_stats[CS_##counter])
597 #define CL_ENV_DEC(counter) do { \
598 LASSERT(cfs_atomic_read(&cl_env_stats.cs_stats[CS_##counter]) > 0); \
599 cfs_atomic_dec(&cl_env_stats.cs_stats[CS_##counter]); \
602 #define CL_ENV_INC(counter)
603 #define CL_ENV_DEC(counter)
606 static void cl_env_init0(struct cl_env *cle, void *debug)
608 LASSERT(cle->ce_ref == 0);
609 LASSERT(cle->ce_magic == &cl_env_init0);
610 LASSERT(cle->ce_debug == NULL && cle->ce_owner == NULL);
613 cle->ce_debug = debug;
618 #ifndef LL_TASK_CL_ENV
620 * The implementation of using hash table to connect cl_env and thread
623 static cfs_hash_t *cl_env_hash;
625 static unsigned cl_env_hops_hash(cfs_hash_t *lh,
626 const void *key, unsigned mask)
628 #if BITS_PER_LONG == 64
629 return cfs_hash_u64_hash((__u64)key, mask);
631 return cfs_hash_u32_hash((__u32)key, mask);
635 static void *cl_env_hops_obj(cfs_hlist_node_t *hn)
637 struct cl_env *cle = cfs_hlist_entry(hn, struct cl_env, ce_node);
638 LASSERT(cle->ce_magic == &cl_env_init0);
642 static int cl_env_hops_keycmp(const void *key, cfs_hlist_node_t *hn)
644 struct cl_env *cle = cl_env_hops_obj(hn);
646 LASSERT(cle->ce_owner != NULL);
647 return (key == cle->ce_owner);
650 static void cl_env_hops_noop(cfs_hash_t *hs, cfs_hlist_node_t *hn)
652 struct cl_env *cle = cfs_hlist_entry(hn, struct cl_env, ce_node);
653 LASSERT(cle->ce_magic == &cl_env_init0);
656 static cfs_hash_ops_t cl_env_hops = {
657 .hs_hash = cl_env_hops_hash,
658 .hs_key = cl_env_hops_obj,
659 .hs_keycmp = cl_env_hops_keycmp,
660 .hs_object = cl_env_hops_obj,
661 .hs_get = cl_env_hops_noop,
662 .hs_put_locked = cl_env_hops_noop,
665 static inline struct cl_env *cl_env_fetch(void)
669 cle = cfs_hash_lookup(cl_env_hash, (void *) (long) current->pid);
670 LASSERT(ergo(cle, cle->ce_magic == &cl_env_init0));
674 static inline void cl_env_attach(struct cl_env *cle)
679 LASSERT(cle->ce_owner == NULL);
680 cle->ce_owner = (void *) (long) current->pid;
681 rc = cfs_hash_add_unique(cl_env_hash, cle->ce_owner,
687 static inline void cl_env_do_detach(struct cl_env *cle)
691 LASSERT(cle->ce_owner == (void *) (long) current->pid);
692 cookie = cfs_hash_del(cl_env_hash, cle->ce_owner,
694 LASSERT(cookie == cle);
695 cle->ce_owner = NULL;
698 static int cl_env_store_init(void) {
699 cl_env_hash = cfs_hash_create("cl_env",
700 HASH_CL_ENV_BITS, HASH_CL_ENV_BITS,
701 HASH_CL_ENV_BKT_BITS, 0,
705 CFS_HASH_RW_BKTLOCK);
706 return cl_env_hash != NULL ? 0 :-ENOMEM;
709 static void cl_env_store_fini(void) {
710 cfs_hash_putref(cl_env_hash);
713 #else /* LL_TASK_CL_ENV */
715 * The implementation of store cl_env directly in thread structure.
718 static inline struct cl_env *cl_env_fetch(void)
722 cle = current->LL_TASK_CL_ENV;
723 if (cle && cle->ce_magic != &cl_env_init0)
728 static inline void cl_env_attach(struct cl_env *cle)
731 LASSERT(cle->ce_owner == NULL);
732 cle->ce_owner = current;
733 cle->ce_prev = current->LL_TASK_CL_ENV;
734 current->LL_TASK_CL_ENV = cle;
738 static inline void cl_env_do_detach(struct cl_env *cle)
740 LASSERT(cle->ce_owner == current);
741 LASSERT(current->LL_TASK_CL_ENV == cle);
742 current->LL_TASK_CL_ENV = cle->ce_prev;
743 cle->ce_owner = NULL;
746 static int cl_env_store_init(void) { return 0; }
747 static void cl_env_store_fini(void) { }
749 #endif /* LL_TASK_CL_ENV */
751 static inline struct cl_env *cl_env_detach(struct cl_env *cle)
754 cle = cl_env_fetch();
756 if (cle && cle->ce_owner)
757 cl_env_do_detach(cle);
762 static struct lu_env *cl_env_new(__u32 ctx_tags, __u32 ses_tags, void *debug)
767 OBD_SLAB_ALLOC_PTR_GFP(cle, cl_env_kmem, __GFP_IO);
771 CFS_INIT_LIST_HEAD(&cle->ce_linkage);
772 cle->ce_magic = &cl_env_init0;
774 rc = lu_env_init(env, LCT_CL_THREAD|ctx_tags);
776 rc = lu_context_init(&cle->ce_ses,
777 LCT_SESSION | ses_tags);
779 lu_context_enter(&cle->ce_ses);
780 env->le_ses = &cle->ce_ses;
781 cl_env_init0(cle, debug);
786 OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
793 env = ERR_PTR(-ENOMEM);
797 static void cl_env_fini(struct cl_env *cle)
800 lu_context_fini(&cle->ce_lu.le_ctx);
801 lu_context_fini(&cle->ce_ses);
802 OBD_SLAB_FREE_PTR(cle, cl_env_kmem);
805 static struct lu_env *cl_env_obtain(void *debug)
811 spin_lock(&cl_envs_guard);
812 LASSERT(equi(cl_envs_cached_nr == 0, cfs_list_empty(&cl_envs)));
813 if (cl_envs_cached_nr > 0) {
816 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
817 cfs_list_del_init(&cle->ce_linkage);
819 spin_unlock(&cl_envs_guard);
822 rc = lu_env_refill(env);
824 cl_env_init0(cle, debug);
825 lu_context_enter(&env->le_ctx);
826 lu_context_enter(&cle->ce_ses);
832 spin_unlock(&cl_envs_guard);
833 env = cl_env_new(lu_context_tags_default,
834 lu_session_tags_default, debug);
839 static inline struct cl_env *cl_env_container(struct lu_env *env)
841 return container_of(env, struct cl_env, ce_lu);
844 struct lu_env *cl_env_peek(int *refcheck)
851 /* check that we don't go far from untrusted pointer */
852 CLASSERT(offsetof(struct cl_env, ce_magic) == 0);
855 cle = cl_env_fetch();
859 *refcheck = ++cle->ce_ref;
861 CDEBUG(D_OTHER, "%d@%p\n", cle ? cle->ce_ref : 0, cle);
864 EXPORT_SYMBOL(cl_env_peek);
867 * Returns lu_env: if there already is an environment associated with the
868 * current thread, it is returned, otherwise, new environment is allocated.
870 * Allocations are amortized through the global cache of environments.
872 * \param refcheck pointer to a counter used to detect environment leaks. In
873 * the usual case cl_env_get() and cl_env_put() are called in the same lexical
874 * scope and pointer to the same integer is passed as \a refcheck. This is
875 * used to detect missed cl_env_put().
879 struct lu_env *cl_env_get(int *refcheck)
883 env = cl_env_peek(refcheck);
885 env = cl_env_obtain(__builtin_return_address(0));
889 cle = cl_env_container(env);
891 *refcheck = cle->ce_ref;
892 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
897 EXPORT_SYMBOL(cl_env_get);
900 * Forces an allocation of a fresh environment with given tags.
904 struct lu_env *cl_env_alloc(int *refcheck, __u32 tags)
908 LASSERT(cl_env_peek(refcheck) == NULL);
909 env = cl_env_new(tags, tags, __builtin_return_address(0));
913 cle = cl_env_container(env);
914 *refcheck = cle->ce_ref;
915 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
919 EXPORT_SYMBOL(cl_env_alloc);
921 static void cl_env_exit(struct cl_env *cle)
923 LASSERT(cle->ce_owner == NULL);
924 lu_context_exit(&cle->ce_lu.le_ctx);
925 lu_context_exit(&cle->ce_ses);
929 * Finalizes and frees a given number of cached environments. This is done to
930 * (1) free some memory (not currently hooked into VM), or (2) release
931 * references to modules.
933 unsigned cl_env_cache_purge(unsigned nr)
938 spin_lock(&cl_envs_guard);
939 for (; !cfs_list_empty(&cl_envs) && nr > 0; --nr) {
940 cle = container_of(cl_envs.next, struct cl_env, ce_linkage);
941 cfs_list_del_init(&cle->ce_linkage);
942 LASSERT(cl_envs_cached_nr > 0);
944 spin_unlock(&cl_envs_guard);
947 spin_lock(&cl_envs_guard);
949 LASSERT(equi(cl_envs_cached_nr == 0, cfs_list_empty(&cl_envs)));
950 spin_unlock(&cl_envs_guard);
953 EXPORT_SYMBOL(cl_env_cache_purge);
956 * Release an environment.
958 * Decrement \a env reference counter. When counter drops to 0, nothing in
959 * this thread is using environment and it is returned to the allocation
960 * cache, or freed straight away, if cache is large enough.
962 void cl_env_put(struct lu_env *env, int *refcheck)
966 cle = cl_env_container(env);
968 LASSERT(cle->ce_ref > 0);
969 LASSERT(ergo(refcheck != NULL, cle->ce_ref == *refcheck));
971 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
972 if (--cle->ce_ref == 0) {
975 cle->ce_debug = NULL;
978 * Don't bother to take a lock here.
980 * Return environment to the cache only when it was allocated
981 * with the standard tags.
983 if (cl_envs_cached_nr < cl_envs_cached_max &&
984 (env->le_ctx.lc_tags & ~LCT_HAS_EXIT) == LCT_CL_THREAD &&
985 (env->le_ses->lc_tags & ~LCT_HAS_EXIT) == LCT_SESSION) {
986 spin_lock(&cl_envs_guard);
987 cfs_list_add(&cle->ce_linkage, &cl_envs);
989 spin_unlock(&cl_envs_guard);
994 EXPORT_SYMBOL(cl_env_put);
997 * Declares a point of re-entrancy.
999 * \see cl_env_reexit()
1001 void *cl_env_reenter(void)
1003 return cl_env_detach(NULL);
1005 EXPORT_SYMBOL(cl_env_reenter);
1008 * Exits re-entrancy.
1010 void cl_env_reexit(void *cookie)
1012 cl_env_detach(NULL);
1013 cl_env_attach(cookie);
1015 EXPORT_SYMBOL(cl_env_reexit);
1018 * Setup user-supplied \a env as a current environment. This is to be used to
1019 * guaranteed that environment exists even when cl_env_get() fails. It is up
1020 * to user to ensure proper concurrency control.
1022 * \see cl_env_unplant()
1024 void cl_env_implant(struct lu_env *env, int *refcheck)
1026 struct cl_env *cle = cl_env_container(env);
1028 LASSERT(cle->ce_ref > 0);
1031 cl_env_get(refcheck);
1032 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1034 EXPORT_SYMBOL(cl_env_implant);
1037 * Detach environment installed earlier by cl_env_implant().
1039 void cl_env_unplant(struct lu_env *env, int *refcheck)
1041 struct cl_env *cle = cl_env_container(env);
1043 LASSERT(cle->ce_ref > 1);
1045 CDEBUG(D_OTHER, "%d@%p\n", cle->ce_ref, cle);
1048 cl_env_put(env, refcheck);
1050 EXPORT_SYMBOL(cl_env_unplant);
1052 struct lu_env *cl_env_nested_get(struct cl_env_nest *nest)
1056 nest->cen_cookie = NULL;
1057 env = cl_env_peek(&nest->cen_refcheck);
1059 if (!cl_io_is_going(env))
1062 cl_env_put(env, &nest->cen_refcheck);
1063 nest->cen_cookie = cl_env_reenter();
1066 env = cl_env_get(&nest->cen_refcheck);
1068 cl_env_reexit(nest->cen_cookie);
1072 LASSERT(!cl_io_is_going(env));
1075 EXPORT_SYMBOL(cl_env_nested_get);
1077 void cl_env_nested_put(struct cl_env_nest *nest, struct lu_env *env)
1079 cl_env_put(env, &nest->cen_refcheck);
1080 cl_env_reexit(nest->cen_cookie);
1082 EXPORT_SYMBOL(cl_env_nested_put);
1085 * Converts struct cl_attr to struct ost_lvb.
1089 void cl_attr2lvb(struct ost_lvb *lvb, const struct cl_attr *attr)
1092 lvb->lvb_size = attr->cat_size;
1093 lvb->lvb_mtime = attr->cat_mtime;
1094 lvb->lvb_atime = attr->cat_atime;
1095 lvb->lvb_ctime = attr->cat_ctime;
1096 lvb->lvb_blocks = attr->cat_blocks;
1099 EXPORT_SYMBOL(cl_attr2lvb);
1102 * Converts struct ost_lvb to struct cl_attr.
1106 void cl_lvb2attr(struct cl_attr *attr, const struct ost_lvb *lvb)
1109 attr->cat_size = lvb->lvb_size;
1110 attr->cat_mtime = lvb->lvb_mtime;
1111 attr->cat_atime = lvb->lvb_atime;
1112 attr->cat_ctime = lvb->lvb_ctime;
1113 attr->cat_blocks = lvb->lvb_blocks;
1116 EXPORT_SYMBOL(cl_lvb2attr);
1118 static struct cl_env cl_env_percpu[NR_CPUS];
1120 static int cl_env_percpu_init(void)
1123 int tags = LCT_REMEMBER | LCT_NOREF;
1127 for_each_possible_cpu(i) {
1130 cle = &cl_env_percpu[i];
1133 CFS_INIT_LIST_HEAD(&cle->ce_linkage);
1134 cle->ce_magic = &cl_env_init0;
1135 rc = lu_env_init(env, LCT_CL_THREAD | tags);
1137 rc = lu_context_init(&cle->ce_ses, LCT_SESSION | tags);
1139 lu_context_enter(&cle->ce_ses);
1140 env->le_ses = &cle->ce_ses;
1149 /* Indices 0 to i (excluding i) were correctly initialized,
1150 * thus we must uninitialize up to i, the rest are undefined. */
1151 for (j = 0; j < i; j++) {
1152 cle = &cl_env_percpu[i];
1153 lu_context_exit(&cle->ce_ses);
1154 lu_context_fini(&cle->ce_ses);
1155 lu_env_fini(&cle->ce_lu);
1162 static void cl_env_percpu_fini(void)
1166 for_each_possible_cpu(i) {
1167 struct cl_env *cle = &cl_env_percpu[i];
1169 lu_context_exit(&cle->ce_ses);
1170 lu_context_fini(&cle->ce_ses);
1171 lu_env_fini(&cle->ce_lu);
1175 static void cl_env_percpu_refill(void)
1179 for_each_possible_cpu(i)
1180 lu_env_refill(&cl_env_percpu[i].ce_lu);
1183 void cl_env_percpu_put(struct lu_env *env)
1188 cpu = smp_processor_id();
1189 cle = cl_env_container(env);
1190 LASSERT(cle == &cl_env_percpu[cpu]);
1193 LASSERT(cle->ce_ref == 0);
1197 cle->ce_debug = NULL;
1201 EXPORT_SYMBOL(cl_env_percpu_put);
1203 struct lu_env *cl_env_percpu_get()
1207 cle = &cl_env_percpu[get_cpu()];
1208 cl_env_init0(cle, __builtin_return_address(0));
1213 EXPORT_SYMBOL(cl_env_percpu_get);
1215 /*****************************************************************************
1217 * Temporary prototype thing: mirror obd-devices into cl devices.
1221 struct cl_device *cl_type_setup(const struct lu_env *env, struct lu_site *site,
1222 struct lu_device_type *ldt,
1223 struct lu_device *next)
1225 const char *typename;
1226 struct lu_device *d;
1228 LASSERT(ldt != NULL);
1230 typename = ldt->ldt_name;
1231 d = ldt->ldt_ops->ldto_device_alloc(env, ldt, NULL);
1237 rc = ldt->ldt_ops->ldto_device_init(env, d, typename, next);
1240 lu_ref_add(&d->ld_reference,
1241 "lu-stack", &lu_site_init);
1243 ldt->ldt_ops->ldto_device_free(env, d);
1244 CERROR("can't init device '%s', %d\n", typename, rc);
1248 CERROR("Cannot allocate device: '%s'\n", typename);
1249 return lu2cl_dev(d);
1251 EXPORT_SYMBOL(cl_type_setup);
1254 * Finalize device stack by calling lu_stack_fini().
1256 void cl_stack_fini(const struct lu_env *env, struct cl_device *cl)
1258 lu_stack_fini(env, cl2lu_dev(cl));
1260 EXPORT_SYMBOL(cl_stack_fini);
1262 int cl_lock_init(void);
1263 void cl_lock_fini(void);
1265 int cl_page_init(void);
1266 void cl_page_fini(void);
1268 static struct lu_context_key cl_key;
1270 struct cl_thread_info *cl_env_info(const struct lu_env *env)
1272 return lu_context_key_get(&env->le_ctx, &cl_key);
1275 /* defines cl0_key_{init,fini}() */
1276 LU_KEY_INIT_FINI(cl0, struct cl_thread_info);
1278 static void *cl_key_init(const struct lu_context *ctx,
1279 struct lu_context_key *key)
1281 struct cl_thread_info *info;
1283 info = cl0_key_init(ctx, key);
1284 if (!IS_ERR(info)) {
1287 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1288 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1293 static void cl_key_fini(const struct lu_context *ctx,
1294 struct lu_context_key *key, void *data)
1296 struct cl_thread_info *info;
1300 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
1301 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1302 cl0_key_fini(ctx, key, data);
1305 static void cl_key_exit(const struct lu_context *ctx,
1306 struct lu_context_key *key, void *data)
1308 struct cl_thread_info *info = data;
1311 for (i = 0; i < ARRAY_SIZE(info->clt_counters); ++i) {
1312 LASSERT(info->clt_counters[i].ctc_nr_held == 0);
1313 LASSERT(info->clt_counters[i].ctc_nr_used == 0);
1314 LASSERT(info->clt_counters[i].ctc_nr_locks_acquired == 0);
1315 LASSERT(info->clt_counters[i].ctc_nr_locks_locked == 0);
1316 lu_ref_fini(&info->clt_counters[i].ctc_locks_locked);
1317 lu_ref_init(&info->clt_counters[i].ctc_locks_locked);
1321 static struct lu_context_key cl_key = {
1322 .lct_tags = LCT_CL_THREAD,
1323 .lct_init = cl_key_init,
1324 .lct_fini = cl_key_fini,
1325 .lct_exit = cl_key_exit
1328 static struct lu_kmem_descr cl_object_caches[] = {
1330 .ckd_cache = &cl_env_kmem,
1331 .ckd_name = "cl_env_kmem",
1332 .ckd_size = sizeof (struct cl_env)
1340 * Global initialization of cl-data. Create kmem caches, register
1341 * lu_context_key's, etc.
1343 * \see cl_global_fini()
1345 int cl_global_init(void)
1349 result = cl_env_store_init();
1353 result = lu_kmem_init(cl_object_caches);
1357 LU_CONTEXT_KEY_INIT(&cl_key);
1358 result = lu_context_key_register(&cl_key);
1362 result = cl_lock_init();
1366 result = cl_page_init();
1370 result = cl_env_percpu_init();
1372 /* no cl_env_percpu_fini on error */
1379 lu_context_key_degister(&cl_key);
1381 lu_kmem_fini(cl_object_caches);
1383 cl_env_store_fini();
1388 * Finalization of global cl-data. Dual to cl_global_init().
1390 void cl_global_fini(void)
1392 cl_env_percpu_fini();
1395 lu_context_key_degister(&cl_key);
1396 lu_kmem_fini(cl_object_caches);
1397 cl_env_store_fini();