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, 2012, 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>
52 #define DEBUG_SUBSYSTEM S_CLASS
54 #include <linux/libcfs/libcfs.h>
55 /* class_put_type() */
56 #include <obd_class.h>
57 #include <obd_support.h>
58 #include <lustre_fid.h>
59 #include <linux/list.h>
60 #include <linux/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_page_guard */
67 static struct lock_class_key cl_page_guard_class
;
68 /** Lock class of cl_object_header::coh_lock_guard */
69 static struct lock_class_key cl_lock_guard_class
;
70 /** Lock class of cl_object_header::coh_attr_guard */
71 static struct lock_class_key cl_attr_guard_class
;
73 extern __u32 lu_context_tags_default
;
74 extern __u32 lu_session_tags_default
;
76 * Initialize cl_object_header.
78 int cl_object_header_init(struct cl_object_header
*h
)
82 result
= lu_object_header_init(&h
->coh_lu
);
84 spin_lock_init(&h
->coh_page_guard
);
85 spin_lock_init(&h
->coh_lock_guard
);
86 spin_lock_init(&h
->coh_attr_guard
);
87 lockdep_set_class(&h
->coh_page_guard
, &cl_page_guard_class
);
88 lockdep_set_class(&h
->coh_lock_guard
, &cl_lock_guard_class
);
89 lockdep_set_class(&h
->coh_attr_guard
, &cl_attr_guard_class
);
91 /* XXX hard coded GFP_* mask. */
92 INIT_RADIX_TREE(&h
->coh_tree
, GFP_ATOMIC
);
93 INIT_LIST_HEAD(&h
->coh_locks
);
94 h
->coh_page_bufsize
= ALIGN(sizeof(struct cl_page
), 8);
98 EXPORT_SYMBOL(cl_object_header_init
);
101 * Finalize cl_object_header.
103 void cl_object_header_fini(struct cl_object_header
*h
)
105 LASSERT(list_empty(&h
->coh_locks
));
106 lu_object_header_fini(&h
->coh_lu
);
108 EXPORT_SYMBOL(cl_object_header_fini
);
111 * Returns a cl_object with a given \a fid.
113 * Returns either cached or newly created object. Additional reference on the
114 * returned object is acquired.
116 * \see lu_object_find(), cl_page_find(), cl_lock_find()
118 struct cl_object
*cl_object_find(const struct lu_env
*env
,
119 struct cl_device
*cd
, const struct lu_fid
*fid
,
120 const struct cl_object_conf
*c
)
123 return lu2cl(lu_object_find_slice(env
, cl2lu_dev(cd
), fid
, &c
->coc_lu
));
125 EXPORT_SYMBOL(cl_object_find
);
128 * Releases a reference on \a o.
130 * When last reference is released object is returned to the cache, unless
131 * lu_object_header_flags::LU_OBJECT_HEARD_BANSHEE bit is set in its header.
133 * \see cl_page_put(), cl_lock_put().
135 void cl_object_put(const struct lu_env
*env
, struct cl_object
*o
)
137 lu_object_put(env
, &o
->co_lu
);
139 EXPORT_SYMBOL(cl_object_put
);
142 * Acquire an additional reference to the object \a o.
144 * This can only be used to acquire _additional_ reference, i.e., caller
145 * already has to possess at least one reference to \a o before calling this.
147 * \see cl_page_get(), cl_lock_get().
149 void cl_object_get(struct cl_object
*o
)
151 lu_object_get(&o
->co_lu
);
153 EXPORT_SYMBOL(cl_object_get
);
156 * Returns the top-object for a given \a o.
158 * \see cl_page_top(), cl_io_top()
160 struct cl_object
*cl_object_top(struct cl_object
*o
)
162 struct cl_object_header
*hdr
= cl_object_header(o
);
163 struct cl_object
*top
;
165 while (hdr
->coh_parent
!= NULL
)
166 hdr
= hdr
->coh_parent
;
168 top
= lu2cl(lu_object_top(&hdr
->coh_lu
));
169 CDEBUG(D_TRACE
, "%p -> %p\n", o
, top
);
172 EXPORT_SYMBOL(cl_object_top
);
175 * Returns pointer to the lock protecting data-attributes for the given object
178 * Data-attributes are protected by the cl_object_header::coh_attr_guard
179 * spin-lock in the top-object.
181 * \see cl_attr, cl_object_attr_lock(), cl_object_operations::coo_attr_get().
183 static spinlock_t
*cl_object_attr_guard(struct cl_object
*o
)
185 return &cl_object_header(cl_object_top(o
))->coh_attr_guard
;
189 * Locks data-attributes.
191 * Prevents data-attributes from changing, until lock is released by
192 * cl_object_attr_unlock(). This has to be called before calls to
193 * cl_object_attr_get(), cl_object_attr_set().
195 void cl_object_attr_lock(struct cl_object
*o
)
197 spin_lock(cl_object_attr_guard(o
));
199 EXPORT_SYMBOL(cl_object_attr_lock
);
202 * Releases data-attributes lock, acquired by cl_object_attr_lock().
204 void cl_object_attr_unlock(struct cl_object
*o
)
206 spin_unlock(cl_object_attr_guard(o
));
208 EXPORT_SYMBOL(cl_object_attr_unlock
);
211 * Returns data-attributes of an object \a obj.
213 * Every layer is asked (by calling cl_object_operations::coo_attr_get())
214 * top-to-bottom to fill in parts of \a attr that this layer is responsible
217 int cl_object_attr_get(const struct lu_env
*env
, struct cl_object
*obj
,
218 struct cl_attr
*attr
)
220 struct lu_object_header
*top
;
223 assert_spin_locked(cl_object_attr_guard(obj
));
225 top
= obj
->co_lu
.lo_header
;
227 list_for_each_entry(obj
, &top
->loh_layers
, co_lu
.lo_linkage
) {
228 if (obj
->co_ops
->coo_attr_get
!= NULL
) {
229 result
= obj
->co_ops
->coo_attr_get(env
, obj
, attr
);
239 EXPORT_SYMBOL(cl_object_attr_get
);
242 * Updates data-attributes of an object \a obj.
244 * Only attributes, mentioned in a validness bit-mask \a v are
245 * updated. Calls cl_object_operations::coo_attr_set() on every layer, bottom
248 int cl_object_attr_set(const struct lu_env
*env
, struct cl_object
*obj
,
249 const struct cl_attr
*attr
, unsigned v
)
251 struct lu_object_header
*top
;
254 assert_spin_locked(cl_object_attr_guard(obj
));
256 top
= obj
->co_lu
.lo_header
;
258 list_for_each_entry_reverse(obj
, &top
->loh_layers
,
260 if (obj
->co_ops
->coo_attr_set
!= NULL
) {
261 result
= obj
->co_ops
->coo_attr_set(env
, obj
, attr
, v
);
271 EXPORT_SYMBOL(cl_object_attr_set
);
274 * Notifies layers (bottom-to-top) that glimpse AST was received.
276 * Layers have to fill \a lvb fields with information that will be shipped
277 * back to glimpse issuer.
279 * \see cl_lock_operations::clo_glimpse()
281 int cl_object_glimpse(const struct lu_env
*env
, struct cl_object
*obj
,
284 struct lu_object_header
*top
;
287 top
= obj
->co_lu
.lo_header
;
289 list_for_each_entry_reverse(obj
, &top
->loh_layers
,
291 if (obj
->co_ops
->coo_glimpse
!= NULL
) {
292 result
= obj
->co_ops
->coo_glimpse(env
, obj
, lvb
);
297 LU_OBJECT_HEADER(D_DLMTRACE
, env
, lu_object_top(top
),
298 "size: "LPU64
" mtime: "LPU64
" atime: "LPU64
" "
299 "ctime: "LPU64
" blocks: "LPU64
"\n",
300 lvb
->lvb_size
, lvb
->lvb_mtime
, lvb
->lvb_atime
,
301 lvb
->lvb_ctime
, lvb
->lvb_blocks
);
304 EXPORT_SYMBOL(cl_object_glimpse
);
307 * Updates a configuration of an object \a obj.
309 int cl_conf_set(const struct lu_env
*env
, struct cl_object
*obj
,
310 const struct cl_object_conf
*conf
)
312 struct lu_object_header
*top
;
315 top
= obj
->co_lu
.lo_header
;
317 list_for_each_entry(obj
, &top
->loh_layers
, co_lu
.lo_linkage
) {
318 if (obj
->co_ops
->coo_conf_set
!= NULL
) {
319 result
= obj
->co_ops
->coo_conf_set(env
, obj
, conf
);
326 EXPORT_SYMBOL(cl_conf_set
);
329 * Helper function removing all object locks, and marking object for
330 * deletion. All object pages must have been deleted at this point.
332 * This is called by cl_inode_fini() and lov_object_delete() to destroy top-
333 * and sub- objects respectively.
335 void cl_object_kill(const struct lu_env
*env
, struct cl_object
*obj
)
337 struct cl_object_header
*hdr
;
339 hdr
= cl_object_header(obj
);
340 LASSERT(hdr
->coh_tree
.rnode
== NULL
);
341 LASSERT(hdr
->coh_pages
== 0);
343 set_bit(LU_OBJECT_HEARD_BANSHEE
, &hdr
->coh_lu
.loh_flags
);
345 * Destroy all locks. Object destruction (including cl_inode_fini())
346 * cannot cancel the locks, because in the case of a local client,
347 * where client and server share the same thread running
348 * prune_icache(), this can dead-lock with ldlm_cancel_handler()
349 * waiting on __wait_on_freeing_inode().
351 cl_locks_prune(env
, obj
, 0);
353 EXPORT_SYMBOL(cl_object_kill
);
356 * Prunes caches of pages and locks for this object.
358 void cl_object_prune(const struct lu_env
*env
, struct cl_object
*obj
)
360 cl_pages_prune(env
, obj
);
361 cl_locks_prune(env
, obj
, 1);
363 EXPORT_SYMBOL(cl_object_prune
);
366 * Check if the object has locks.
368 int cl_object_has_locks(struct cl_object
*obj
)
370 struct cl_object_header
*head
= cl_object_header(obj
);
373 spin_lock(&head
->coh_lock_guard
);
374 has
= list_empty(&head
->coh_locks
);
375 spin_unlock(&head
->coh_lock_guard
);
379 EXPORT_SYMBOL(cl_object_has_locks
);
381 void cache_stats_init(struct cache_stats
*cs
, const char *name
)
386 for (i
= 0; i
< CS_NR
; i
++)
387 atomic_set(&cs
->cs_stats
[i
], 0);
390 int cache_stats_print(const struct cache_stats
*cs
, struct seq_file
*m
, int h
)
394 * lookup hit total cached create
395 * env: ...... ...... ...... ...... ......
398 const char *names
[CS_NR
] = CS_NAMES
;
400 seq_printf(m
, "%6s", " ");
401 for (i
= 0; i
< CS_NR
; i
++)
402 seq_printf(m
, "%8s", names
[i
]);
406 seq_printf(m
, "%5.5s:", cs
->cs_name
);
407 for (i
= 0; i
< CS_NR
; i
++)
408 seq_printf(m
, "%8u", atomic_read(&cs
->cs_stats
[i
]));
413 * Initialize client site.
415 * Perform common initialization (lu_site_init()), and initialize statistical
416 * counters. Also perform global initializations on the first call.
418 int cl_site_init(struct cl_site
*s
, struct cl_device
*d
)
423 result
= lu_site_init(&s
->cs_lu
, &d
->cd_lu_dev
);
425 cache_stats_init(&s
->cs_pages
, "pages");
426 cache_stats_init(&s
->cs_locks
, "locks");
427 for (i
= 0; i
< ARRAY_SIZE(s
->cs_pages_state
); ++i
)
428 atomic_set(&s
->cs_pages_state
[0], 0);
429 for (i
= 0; i
< ARRAY_SIZE(s
->cs_locks_state
); ++i
)
430 atomic_set(&s
->cs_locks_state
[i
], 0);
434 EXPORT_SYMBOL(cl_site_init
);
437 * Finalize client site. Dual to cl_site_init().
439 void cl_site_fini(struct cl_site
*s
)
441 lu_site_fini(&s
->cs_lu
);
443 EXPORT_SYMBOL(cl_site_fini
);
445 static struct cache_stats cl_env_stats
= {
447 .cs_stats
= { ATOMIC_INIT(0), }
451 * Outputs client site statistical counters into a buffer. Suitable for
452 * ll_rd_*()-style functions.
454 int cl_site_stats_print(const struct cl_site
*site
, struct seq_file
*m
)
457 static const char *pstate
[] = {
464 static const char *lstate
[] = {
467 [CLS_ENQUEUED
] = "e",
469 [CLS_INTRANSIT
] = "t",
474 lookup hit total busy create
475 pages: ...... ...... ...... ...... ...... [...... ...... ...... ......]
476 locks: ...... ...... ...... ...... ...... [...... ...... ...... ...... ......]
477 env: ...... ...... ...... ...... ......
479 lu_site_stats_print(&site
->cs_lu
, m
);
480 cache_stats_print(&site
->cs_pages
, m
, 1);
482 for (i
= 0; i
< ARRAY_SIZE(site
->cs_pages_state
); ++i
)
483 seq_printf(m
, "%s: %u ", pstate
[i
],
484 atomic_read(&site
->cs_pages_state
[i
]));
485 seq_printf(m
, "]\n");
486 cache_stats_print(&site
->cs_locks
, m
, 0);
488 for (i
= 0; i
< ARRAY_SIZE(site
->cs_locks_state
); ++i
)
489 seq_printf(m
, "%s: %u ", lstate
[i
],
490 atomic_read(&site
->cs_locks_state
[i
]));
491 seq_printf(m
, "]\n");
492 cache_stats_print(&cl_env_stats
, m
, 0);
496 EXPORT_SYMBOL(cl_site_stats_print
);
498 /*****************************************************************************
500 * lu_env handling on client.
505 * The most efficient way is to store cl_env pointer in task specific
506 * structures. On Linux, it wont' be easy to use task_struct->journal_info
507 * because Lustre code may call into other fs which has certain assumptions
508 * about journal_info. Currently following fields in task_struct are identified
509 * can be used for this purpose:
510 * - cl_env: for liblustre.
511 * - tux_info: only on RedHat kernel.
513 * \note As long as we use task_struct to store cl_env, we assume that once
514 * called into Lustre, we'll never call into the other part of the kernel
515 * which will use those fields in task_struct without explicitly exiting
518 * If there's no space in task_struct is available, hash will be used.
525 struct lu_context ce_ses
;
528 * This allows cl_env to be entered into cl_env_hash which implements
529 * the current thread -> client environment lookup.
531 struct hlist_node ce_node
;
533 * Owner for the current cl_env.
535 * If LL_TASK_CL_ENV is defined, this point to the owning current,
536 * only for debugging purpose ;
537 * Otherwise hash is used, and this is the key for cfs_hash.
538 * Now current thread pid is stored. Note using thread pointer would
539 * lead to unbalanced hash because of its specific allocation locality
540 * and could be varied for different platforms and OSes, even different
546 * Linkage into global list of all client environments. Used for
547 * garbage collection.
549 struct list_head ce_linkage
;
555 * Debugging field: address of the caller who made original
561 #define CL_ENV_INC(counter)
562 #define CL_ENV_DEC(counter)
564 static void cl_env_init0(struct cl_env
*cle
, void *debug
)
566 LASSERT(cle
->ce_ref
== 0);
567 LASSERT(cle
->ce_magic
== &cl_env_init0
);
568 LASSERT(cle
->ce_debug
== NULL
&& cle
->ce_owner
== NULL
);
571 cle
->ce_debug
= debug
;
577 * The implementation of using hash table to connect cl_env and thread
580 static struct cfs_hash
*cl_env_hash
;
582 static unsigned cl_env_hops_hash(struct cfs_hash
*lh
,
583 const void *key
, unsigned mask
)
585 #if BITS_PER_LONG == 64
586 return cfs_hash_u64_hash((__u64
)key
, mask
);
588 return cfs_hash_u32_hash((__u32
)key
, mask
);
592 static void *cl_env_hops_obj(struct hlist_node
*hn
)
594 struct cl_env
*cle
= hlist_entry(hn
, struct cl_env
, ce_node
);
595 LASSERT(cle
->ce_magic
== &cl_env_init0
);
599 static int cl_env_hops_keycmp(const void *key
, struct hlist_node
*hn
)
601 struct cl_env
*cle
= cl_env_hops_obj(hn
);
603 LASSERT(cle
->ce_owner
!= NULL
);
604 return (key
== cle
->ce_owner
);
607 static void cl_env_hops_noop(struct cfs_hash
*hs
, struct hlist_node
*hn
)
609 struct cl_env
*cle
= hlist_entry(hn
, struct cl_env
, ce_node
);
610 LASSERT(cle
->ce_magic
== &cl_env_init0
);
613 static cfs_hash_ops_t cl_env_hops
= {
614 .hs_hash
= cl_env_hops_hash
,
615 .hs_key
= cl_env_hops_obj
,
616 .hs_keycmp
= cl_env_hops_keycmp
,
617 .hs_object
= cl_env_hops_obj
,
618 .hs_get
= cl_env_hops_noop
,
619 .hs_put_locked
= cl_env_hops_noop
,
622 static inline struct cl_env
*cl_env_fetch(void)
626 cle
= cfs_hash_lookup(cl_env_hash
, (void *) (long) current
->pid
);
627 LASSERT(ergo(cle
, cle
->ce_magic
== &cl_env_init0
));
631 static inline void cl_env_attach(struct cl_env
*cle
)
636 LASSERT(cle
->ce_owner
== NULL
);
637 cle
->ce_owner
= (void *) (long) current
->pid
;
638 rc
= cfs_hash_add_unique(cl_env_hash
, cle
->ce_owner
,
644 static inline void cl_env_do_detach(struct cl_env
*cle
)
648 LASSERT(cle
->ce_owner
== (void *) (long) current
->pid
);
649 cookie
= cfs_hash_del(cl_env_hash
, cle
->ce_owner
,
651 LASSERT(cookie
== cle
);
652 cle
->ce_owner
= NULL
;
655 static int cl_env_store_init(void) {
656 cl_env_hash
= cfs_hash_create("cl_env",
657 HASH_CL_ENV_BITS
, HASH_CL_ENV_BITS
,
658 HASH_CL_ENV_BKT_BITS
, 0,
662 CFS_HASH_RW_BKTLOCK
);
663 return cl_env_hash
!= NULL
? 0 :-ENOMEM
;
666 static void cl_env_store_fini(void) {
667 cfs_hash_putref(cl_env_hash
);
671 static inline struct cl_env
*cl_env_detach(struct cl_env
*cle
)
674 cle
= cl_env_fetch();
676 if (cle
&& cle
->ce_owner
)
677 cl_env_do_detach(cle
);
682 static struct lu_env
*cl_env_new(__u32 ctx_tags
, __u32 ses_tags
, void *debug
)
687 OBD_SLAB_ALLOC_PTR_GFP(cle
, cl_env_kmem
, GFP_NOFS
);
691 INIT_LIST_HEAD(&cle
->ce_linkage
);
692 cle
->ce_magic
= &cl_env_init0
;
694 rc
= lu_env_init(env
, LCT_CL_THREAD
|ctx_tags
);
696 rc
= lu_context_init(&cle
->ce_ses
,
697 LCT_SESSION
| ses_tags
);
699 lu_context_enter(&cle
->ce_ses
);
700 env
->le_ses
= &cle
->ce_ses
;
701 cl_env_init0(cle
, debug
);
706 OBD_SLAB_FREE_PTR(cle
, cl_env_kmem
);
713 env
= ERR_PTR(-ENOMEM
);
717 static void cl_env_fini(struct cl_env
*cle
)
720 lu_context_fini(&cle
->ce_lu
.le_ctx
);
721 lu_context_fini(&cle
->ce_ses
);
722 OBD_SLAB_FREE_PTR(cle
, cl_env_kmem
);
725 static inline struct cl_env
*cl_env_container(struct lu_env
*env
)
727 return container_of(env
, struct cl_env
, ce_lu
);
730 struct lu_env
*cl_env_peek(int *refcheck
)
737 /* check that we don't go far from untrusted pointer */
738 CLASSERT(offsetof(struct cl_env
, ce_magic
) == 0);
741 cle
= cl_env_fetch();
745 *refcheck
= ++cle
->ce_ref
;
747 CDEBUG(D_OTHER
, "%d@%p\n", cle
? cle
->ce_ref
: 0, cle
);
750 EXPORT_SYMBOL(cl_env_peek
);
753 * Returns lu_env: if there already is an environment associated with the
754 * current thread, it is returned, otherwise, new environment is allocated.
756 * \param refcheck pointer to a counter used to detect environment leaks. In
757 * the usual case cl_env_get() and cl_env_put() are called in the same lexical
758 * scope and pointer to the same integer is passed as \a refcheck. This is
759 * used to detect missed cl_env_put().
763 struct lu_env
*cl_env_get(int *refcheck
)
767 env
= cl_env_peek(refcheck
);
769 env
= cl_env_new(lu_context_tags_default
,
770 lu_session_tags_default
,
771 __builtin_return_address(0));
776 cle
= cl_env_container(env
);
778 *refcheck
= cle
->ce_ref
;
779 CDEBUG(D_OTHER
, "%d@%p\n", cle
->ce_ref
, cle
);
784 EXPORT_SYMBOL(cl_env_get
);
787 * Forces an allocation of a fresh environment with given tags.
791 struct lu_env
*cl_env_alloc(int *refcheck
, __u32 tags
)
795 LASSERT(cl_env_peek(refcheck
) == NULL
);
796 env
= cl_env_new(tags
, tags
, __builtin_return_address(0));
800 cle
= cl_env_container(env
);
801 *refcheck
= cle
->ce_ref
;
802 CDEBUG(D_OTHER
, "%d@%p\n", cle
->ce_ref
, cle
);
806 EXPORT_SYMBOL(cl_env_alloc
);
808 static void cl_env_exit(struct cl_env
*cle
)
810 LASSERT(cle
->ce_owner
== NULL
);
811 lu_context_exit(&cle
->ce_lu
.le_ctx
);
812 lu_context_exit(&cle
->ce_ses
);
816 * Release an environment.
818 * Decrement \a env reference counter. When counter drops to 0, nothing in
819 * this thread is using environment and it is returned to the allocation
820 * cache, or freed straight away, if cache is large enough.
822 void cl_env_put(struct lu_env
*env
, int *refcheck
)
826 cle
= cl_env_container(env
);
828 LASSERT(cle
->ce_ref
> 0);
829 LASSERT(ergo(refcheck
!= NULL
, cle
->ce_ref
== *refcheck
));
831 CDEBUG(D_OTHER
, "%d@%p\n", cle
->ce_ref
, cle
);
832 if (--cle
->ce_ref
== 0) {
835 cle
->ce_debug
= NULL
;
840 EXPORT_SYMBOL(cl_env_put
);
843 * Declares a point of re-entrancy.
845 * \see cl_env_reexit()
847 void *cl_env_reenter(void)
849 return cl_env_detach(NULL
);
851 EXPORT_SYMBOL(cl_env_reenter
);
856 void cl_env_reexit(void *cookie
)
859 cl_env_attach(cookie
);
861 EXPORT_SYMBOL(cl_env_reexit
);
864 * Setup user-supplied \a env as a current environment. This is to be used to
865 * guaranteed that environment exists even when cl_env_get() fails. It is up
866 * to user to ensure proper concurrency control.
868 * \see cl_env_unplant()
870 void cl_env_implant(struct lu_env
*env
, int *refcheck
)
872 struct cl_env
*cle
= cl_env_container(env
);
874 LASSERT(cle
->ce_ref
> 0);
877 cl_env_get(refcheck
);
878 CDEBUG(D_OTHER
, "%d@%p\n", cle
->ce_ref
, cle
);
880 EXPORT_SYMBOL(cl_env_implant
);
883 * Detach environment installed earlier by cl_env_implant().
885 void cl_env_unplant(struct lu_env
*env
, int *refcheck
)
887 struct cl_env
*cle
= cl_env_container(env
);
889 LASSERT(cle
->ce_ref
> 1);
891 CDEBUG(D_OTHER
, "%d@%p\n", cle
->ce_ref
, cle
);
894 cl_env_put(env
, refcheck
);
896 EXPORT_SYMBOL(cl_env_unplant
);
898 struct lu_env
*cl_env_nested_get(struct cl_env_nest
*nest
)
902 nest
->cen_cookie
= NULL
;
903 env
= cl_env_peek(&nest
->cen_refcheck
);
905 if (!cl_io_is_going(env
))
908 cl_env_put(env
, &nest
->cen_refcheck
);
909 nest
->cen_cookie
= cl_env_reenter();
912 env
= cl_env_get(&nest
->cen_refcheck
);
914 cl_env_reexit(nest
->cen_cookie
);
918 LASSERT(!cl_io_is_going(env
));
921 EXPORT_SYMBOL(cl_env_nested_get
);
923 void cl_env_nested_put(struct cl_env_nest
*nest
, struct lu_env
*env
)
925 cl_env_put(env
, &nest
->cen_refcheck
);
926 cl_env_reexit(nest
->cen_cookie
);
928 EXPORT_SYMBOL(cl_env_nested_put
);
931 * Converts struct cl_attr to struct ost_lvb.
935 void cl_attr2lvb(struct ost_lvb
*lvb
, const struct cl_attr
*attr
)
937 lvb
->lvb_size
= attr
->cat_size
;
938 lvb
->lvb_mtime
= attr
->cat_mtime
;
939 lvb
->lvb_atime
= attr
->cat_atime
;
940 lvb
->lvb_ctime
= attr
->cat_ctime
;
941 lvb
->lvb_blocks
= attr
->cat_blocks
;
943 EXPORT_SYMBOL(cl_attr2lvb
);
946 * Converts struct ost_lvb to struct cl_attr.
950 void cl_lvb2attr(struct cl_attr
*attr
, const struct ost_lvb
*lvb
)
952 attr
->cat_size
= lvb
->lvb_size
;
953 attr
->cat_mtime
= lvb
->lvb_mtime
;
954 attr
->cat_atime
= lvb
->lvb_atime
;
955 attr
->cat_ctime
= lvb
->lvb_ctime
;
956 attr
->cat_blocks
= lvb
->lvb_blocks
;
958 EXPORT_SYMBOL(cl_lvb2attr
);
960 /*****************************************************************************
962 * Temporary prototype thing: mirror obd-devices into cl devices.
966 struct cl_device
*cl_type_setup(const struct lu_env
*env
, struct lu_site
*site
,
967 struct lu_device_type
*ldt
,
968 struct lu_device
*next
)
970 const char *typename
;
973 LASSERT(ldt
!= NULL
);
975 typename
= ldt
->ldt_name
;
976 d
= ldt
->ldt_ops
->ldto_device_alloc(env
, ldt
, NULL
);
982 rc
= ldt
->ldt_ops
->ldto_device_init(env
, d
, typename
, next
);
985 lu_ref_add(&d
->ld_reference
,
986 "lu-stack", &lu_site_init
);
988 ldt
->ldt_ops
->ldto_device_free(env
, d
);
989 CERROR("can't init device '%s', %d\n", typename
, rc
);
993 CERROR("Cannot allocate device: '%s'\n", typename
);
996 EXPORT_SYMBOL(cl_type_setup
);
999 * Finalize device stack by calling lu_stack_fini().
1001 void cl_stack_fini(const struct lu_env
*env
, struct cl_device
*cl
)
1003 lu_stack_fini(env
, cl2lu_dev(cl
));
1005 EXPORT_SYMBOL(cl_stack_fini
);
1007 int cl_lock_init(void);
1008 void cl_lock_fini(void);
1010 int cl_page_init(void);
1011 void cl_page_fini(void);
1013 static struct lu_context_key cl_key
;
1015 struct cl_thread_info
*cl_env_info(const struct lu_env
*env
)
1017 return lu_context_key_get(&env
->le_ctx
, &cl_key
);
1020 /* defines cl0_key_{init,fini}() */
1021 LU_KEY_INIT_FINI(cl0
, struct cl_thread_info
);
1023 static void *cl_key_init(const struct lu_context
*ctx
,
1024 struct lu_context_key
*key
)
1026 struct cl_thread_info
*info
;
1028 info
= cl0_key_init(ctx
, key
);
1029 if (!IS_ERR(info
)) {
1032 for (i
= 0; i
< ARRAY_SIZE(info
->clt_counters
); ++i
)
1033 lu_ref_init(&info
->clt_counters
[i
].ctc_locks_locked
);
1038 static void cl_key_fini(const struct lu_context
*ctx
,
1039 struct lu_context_key
*key
, void *data
)
1041 struct cl_thread_info
*info
;
1045 for (i
= 0; i
< ARRAY_SIZE(info
->clt_counters
); ++i
)
1046 lu_ref_fini(&info
->clt_counters
[i
].ctc_locks_locked
);
1047 cl0_key_fini(ctx
, key
, data
);
1050 static void cl_key_exit(const struct lu_context
*ctx
,
1051 struct lu_context_key
*key
, void *data
)
1053 struct cl_thread_info
*info
= data
;
1056 for (i
= 0; i
< ARRAY_SIZE(info
->clt_counters
); ++i
) {
1057 LASSERT(info
->clt_counters
[i
].ctc_nr_held
== 0);
1058 LASSERT(info
->clt_counters
[i
].ctc_nr_used
== 0);
1059 LASSERT(info
->clt_counters
[i
].ctc_nr_locks_acquired
== 0);
1060 LASSERT(info
->clt_counters
[i
].ctc_nr_locks_locked
== 0);
1061 lu_ref_fini(&info
->clt_counters
[i
].ctc_locks_locked
);
1062 lu_ref_init(&info
->clt_counters
[i
].ctc_locks_locked
);
1066 static struct lu_context_key cl_key
= {
1067 .lct_tags
= LCT_CL_THREAD
,
1068 .lct_init
= cl_key_init
,
1069 .lct_fini
= cl_key_fini
,
1070 .lct_exit
= cl_key_exit
1073 static struct lu_kmem_descr cl_object_caches
[] = {
1075 .ckd_cache
= &cl_env_kmem
,
1076 .ckd_name
= "cl_env_kmem",
1077 .ckd_size
= sizeof (struct cl_env
)
1085 * Global initialization of cl-data. Create kmem caches, register
1086 * lu_context_key's, etc.
1088 * \see cl_global_fini()
1090 int cl_global_init(void)
1094 result
= cl_env_store_init();
1098 result
= lu_kmem_init(cl_object_caches
);
1102 LU_CONTEXT_KEY_INIT(&cl_key
);
1103 result
= lu_context_key_register(&cl_key
);
1107 result
= cl_lock_init();
1111 result
= cl_page_init();
1119 lu_context_key_degister(&cl_key
);
1121 lu_kmem_fini(cl_object_caches
);
1123 cl_env_store_fini();
1128 * Finalization of global cl-data. Dual to cl_global_init().
1130 void cl_global_fini(void)
1134 lu_context_key_degister(&cl_key
);
1135 lu_kmem_fini(cl_object_caches
);
1136 cl_env_store_fini();