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
)
83 result
= lu_object_header_init(&h
->coh_lu
);
85 spin_lock_init(&h
->coh_page_guard
);
86 spin_lock_init(&h
->coh_lock_guard
);
87 spin_lock_init(&h
->coh_attr_guard
);
88 lockdep_set_class(&h
->coh_page_guard
, &cl_page_guard_class
);
89 lockdep_set_class(&h
->coh_lock_guard
, &cl_lock_guard_class
);
90 lockdep_set_class(&h
->coh_attr_guard
, &cl_attr_guard_class
);
92 /* XXX hard coded GFP_* mask. */
93 INIT_RADIX_TREE(&h
->coh_tree
, GFP_ATOMIC
);
94 INIT_LIST_HEAD(&h
->coh_locks
);
95 h
->coh_page_bufsize
= ALIGN(sizeof(struct cl_page
), 8);
99 EXPORT_SYMBOL(cl_object_header_init
);
102 * Finalize cl_object_header.
104 void cl_object_header_fini(struct cl_object_header
*h
)
106 LASSERT(list_empty(&h
->coh_locks
));
107 lu_object_header_fini(&h
->coh_lu
);
109 EXPORT_SYMBOL(cl_object_header_fini
);
112 * Returns a cl_object with a given \a fid.
114 * Returns either cached or newly created object. Additional reference on the
115 * returned object is acquired.
117 * \see lu_object_find(), cl_page_find(), cl_lock_find()
119 struct cl_object
*cl_object_find(const struct lu_env
*env
,
120 struct cl_device
*cd
, const struct lu_fid
*fid
,
121 const struct cl_object_conf
*c
)
124 return lu2cl(lu_object_find_slice(env
, cl2lu_dev(cd
), fid
, &c
->coc_lu
));
126 EXPORT_SYMBOL(cl_object_find
);
129 * Releases a reference on \a o.
131 * When last reference is released object is returned to the cache, unless
132 * lu_object_header_flags::LU_OBJECT_HEARD_BANSHEE bit is set in its header.
134 * \see cl_page_put(), cl_lock_put().
136 void cl_object_put(const struct lu_env
*env
, struct cl_object
*o
)
138 lu_object_put(env
, &o
->co_lu
);
140 EXPORT_SYMBOL(cl_object_put
);
143 * Acquire an additional reference to the object \a o.
145 * This can only be used to acquire _additional_ reference, i.e., caller
146 * already has to possess at least one reference to \a o before calling this.
148 * \see cl_page_get(), cl_lock_get().
150 void cl_object_get(struct cl_object
*o
)
152 lu_object_get(&o
->co_lu
);
154 EXPORT_SYMBOL(cl_object_get
);
157 * Returns the top-object for a given \a o.
159 * \see cl_page_top(), cl_io_top()
161 struct cl_object
*cl_object_top(struct cl_object
*o
)
163 struct cl_object_header
*hdr
= cl_object_header(o
);
164 struct cl_object
*top
;
166 while (hdr
->coh_parent
!= NULL
)
167 hdr
= hdr
->coh_parent
;
169 top
= lu2cl(lu_object_top(&hdr
->coh_lu
));
170 CDEBUG(D_TRACE
, "%p -> %p\n", o
, top
);
173 EXPORT_SYMBOL(cl_object_top
);
176 * Returns pointer to the lock protecting data-attributes for the given object
179 * Data-attributes are protected by the cl_object_header::coh_attr_guard
180 * spin-lock in the top-object.
182 * \see cl_attr, cl_object_attr_lock(), cl_object_operations::coo_attr_get().
184 static spinlock_t
*cl_object_attr_guard(struct cl_object
*o
)
186 return &cl_object_header(cl_object_top(o
))->coh_attr_guard
;
190 * Locks data-attributes.
192 * Prevents data-attributes from changing, until lock is released by
193 * cl_object_attr_unlock(). This has to be called before calls to
194 * cl_object_attr_get(), cl_object_attr_set().
196 void cl_object_attr_lock(struct cl_object
*o
)
198 spin_lock(cl_object_attr_guard(o
));
200 EXPORT_SYMBOL(cl_object_attr_lock
);
203 * Releases data-attributes lock, acquired by cl_object_attr_lock().
205 void cl_object_attr_unlock(struct cl_object
*o
)
207 spin_unlock(cl_object_attr_guard(o
));
209 EXPORT_SYMBOL(cl_object_attr_unlock
);
212 * Returns data-attributes of an object \a obj.
214 * Every layer is asked (by calling cl_object_operations::coo_attr_get())
215 * top-to-bottom to fill in parts of \a attr that this layer is responsible
218 int cl_object_attr_get(const struct lu_env
*env
, struct cl_object
*obj
,
219 struct cl_attr
*attr
)
221 struct lu_object_header
*top
;
224 LASSERT(spin_is_locked(cl_object_attr_guard(obj
)));
227 top
= obj
->co_lu
.lo_header
;
229 list_for_each_entry(obj
, &top
->loh_layers
, co_lu
.lo_linkage
) {
230 if (obj
->co_ops
->coo_attr_get
!= NULL
) {
231 result
= obj
->co_ops
->coo_attr_get(env
, obj
, attr
);
241 EXPORT_SYMBOL(cl_object_attr_get
);
244 * Updates data-attributes of an object \a obj.
246 * Only attributes, mentioned in a validness bit-mask \a v are
247 * updated. Calls cl_object_operations::coo_attr_set() on every layer, bottom
250 int cl_object_attr_set(const struct lu_env
*env
, struct cl_object
*obj
,
251 const struct cl_attr
*attr
, unsigned v
)
253 struct lu_object_header
*top
;
256 LASSERT(spin_is_locked(cl_object_attr_guard(obj
)));
259 top
= obj
->co_lu
.lo_header
;
261 list_for_each_entry_reverse(obj
, &top
->loh_layers
,
263 if (obj
->co_ops
->coo_attr_set
!= NULL
) {
264 result
= obj
->co_ops
->coo_attr_set(env
, obj
, attr
, v
);
274 EXPORT_SYMBOL(cl_object_attr_set
);
277 * Notifies layers (bottom-to-top) that glimpse AST was received.
279 * Layers have to fill \a lvb fields with information that will be shipped
280 * back to glimpse issuer.
282 * \see cl_lock_operations::clo_glimpse()
284 int cl_object_glimpse(const struct lu_env
*env
, struct cl_object
*obj
,
287 struct lu_object_header
*top
;
291 top
= obj
->co_lu
.lo_header
;
293 list_for_each_entry_reverse(obj
, &top
->loh_layers
,
295 if (obj
->co_ops
->coo_glimpse
!= NULL
) {
296 result
= obj
->co_ops
->coo_glimpse(env
, obj
, lvb
);
301 LU_OBJECT_HEADER(D_DLMTRACE
, env
, lu_object_top(top
),
302 "size: "LPU64
" mtime: "LPU64
" atime: "LPU64
" "
303 "ctime: "LPU64
" blocks: "LPU64
"\n",
304 lvb
->lvb_size
, lvb
->lvb_mtime
, lvb
->lvb_atime
,
305 lvb
->lvb_ctime
, lvb
->lvb_blocks
);
308 EXPORT_SYMBOL(cl_object_glimpse
);
311 * Updates a configuration of an object \a obj.
313 int cl_conf_set(const struct lu_env
*env
, struct cl_object
*obj
,
314 const struct cl_object_conf
*conf
)
316 struct lu_object_header
*top
;
320 top
= obj
->co_lu
.lo_header
;
322 list_for_each_entry(obj
, &top
->loh_layers
, co_lu
.lo_linkage
) {
323 if (obj
->co_ops
->coo_conf_set
!= NULL
) {
324 result
= obj
->co_ops
->coo_conf_set(env
, obj
, conf
);
331 EXPORT_SYMBOL(cl_conf_set
);
334 * Helper function removing all object locks, and marking object for
335 * deletion. All object pages must have been deleted at this point.
337 * This is called by cl_inode_fini() and lov_object_delete() to destroy top-
338 * and sub- objects respectively.
340 void cl_object_kill(const struct lu_env
*env
, struct cl_object
*obj
)
342 struct cl_object_header
*hdr
;
344 hdr
= cl_object_header(obj
);
345 LASSERT(hdr
->coh_tree
.rnode
== NULL
);
346 LASSERT(hdr
->coh_pages
== 0);
348 set_bit(LU_OBJECT_HEARD_BANSHEE
, &hdr
->coh_lu
.loh_flags
);
350 * Destroy all locks. Object destruction (including cl_inode_fini())
351 * cannot cancel the locks, because in the case of a local client,
352 * where client and server share the same thread running
353 * prune_icache(), this can dead-lock with ldlm_cancel_handler()
354 * waiting on __wait_on_freeing_inode().
356 cl_locks_prune(env
, obj
, 0);
358 EXPORT_SYMBOL(cl_object_kill
);
361 * Prunes caches of pages and locks for this object.
363 void cl_object_prune(const struct lu_env
*env
, struct cl_object
*obj
)
366 cl_pages_prune(env
, obj
);
367 cl_locks_prune(env
, obj
, 1);
370 EXPORT_SYMBOL(cl_object_prune
);
373 * Check if the object has locks.
375 int cl_object_has_locks(struct cl_object
*obj
)
377 struct cl_object_header
*head
= cl_object_header(obj
);
380 spin_lock(&head
->coh_lock_guard
);
381 has
= list_empty(&head
->coh_locks
);
382 spin_unlock(&head
->coh_lock_guard
);
386 EXPORT_SYMBOL(cl_object_has_locks
);
388 void cache_stats_init(struct cache_stats
*cs
, const char *name
)
393 for (i
= 0; i
< CS_NR
; i
++)
394 atomic_set(&cs
->cs_stats
[i
], 0);
397 int cache_stats_print(const struct cache_stats
*cs
, struct seq_file
*m
, int h
)
401 * lookup hit total cached create
402 * env: ...... ...... ...... ...... ......
405 const char *names
[CS_NR
] = CS_NAMES
;
407 seq_printf(m
, "%6s", " ");
408 for (i
= 0; i
< CS_NR
; i
++)
409 seq_printf(m
, "%8s", names
[i
]);
413 seq_printf(m
, "%5.5s:", cs
->cs_name
);
414 for (i
= 0; i
< CS_NR
; i
++)
415 seq_printf(m
, "%8u", atomic_read(&cs
->cs_stats
[i
]));
420 * Initialize client site.
422 * Perform common initialization (lu_site_init()), and initialize statistical
423 * counters. Also perform global initializations on the first call.
425 int cl_site_init(struct cl_site
*s
, struct cl_device
*d
)
430 result
= lu_site_init(&s
->cs_lu
, &d
->cd_lu_dev
);
432 cache_stats_init(&s
->cs_pages
, "pages");
433 cache_stats_init(&s
->cs_locks
, "locks");
434 for (i
= 0; i
< ARRAY_SIZE(s
->cs_pages_state
); ++i
)
435 atomic_set(&s
->cs_pages_state
[0], 0);
436 for (i
= 0; i
< ARRAY_SIZE(s
->cs_locks_state
); ++i
)
437 atomic_set(&s
->cs_locks_state
[i
], 0);
441 EXPORT_SYMBOL(cl_site_init
);
444 * Finalize client site. Dual to cl_site_init().
446 void cl_site_fini(struct cl_site
*s
)
448 lu_site_fini(&s
->cs_lu
);
450 EXPORT_SYMBOL(cl_site_fini
);
452 static struct cache_stats cl_env_stats
= {
454 .cs_stats
= { ATOMIC_INIT(0), }
458 * Outputs client site statistical counters into a buffer. Suitable for
459 * ll_rd_*()-style functions.
461 int cl_site_stats_print(const struct cl_site
*site
, struct seq_file
*m
)
464 static const char *pstate
[] = {
471 static const char *lstate
[] = {
474 [CLS_ENQUEUED
] = "e",
476 [CLS_INTRANSIT
] = "t",
481 lookup hit total busy create
482 pages: ...... ...... ...... ...... ...... [...... ...... ...... ......]
483 locks: ...... ...... ...... ...... ...... [...... ...... ...... ...... ......]
484 env: ...... ...... ...... ...... ......
486 lu_site_stats_print(&site
->cs_lu
, m
);
487 cache_stats_print(&site
->cs_pages
, m
, 1);
489 for (i
= 0; i
< ARRAY_SIZE(site
->cs_pages_state
); ++i
)
490 seq_printf(m
, "%s: %u ", pstate
[i
],
491 atomic_read(&site
->cs_pages_state
[i
]));
492 seq_printf(m
, "]\n");
493 cache_stats_print(&site
->cs_locks
, m
, 0);
495 for (i
= 0; i
< ARRAY_SIZE(site
->cs_locks_state
); ++i
)
496 seq_printf(m
, "%s: %u ", lstate
[i
],
497 atomic_read(&site
->cs_locks_state
[i
]));
498 seq_printf(m
, "]\n");
499 cache_stats_print(&cl_env_stats
, m
, 0);
503 EXPORT_SYMBOL(cl_site_stats_print
);
505 /*****************************************************************************
507 * lu_env handling on client.
512 * The most efficient way is to store cl_env pointer in task specific
513 * structures. On Linux, it wont' be easy to use task_struct->journal_info
514 * because Lustre code may call into other fs which has certain assumptions
515 * about journal_info. Currently following fields in task_struct are identified
516 * can be used for this purpose:
517 * - cl_env: for liblustre.
518 * - tux_info: ony on RedHat kernel.
520 * \note As long as we use task_struct to store cl_env, we assume that once
521 * called into Lustre, we'll never call into the other part of the kernel
522 * which will use those fields in task_struct without explicitly exiting
525 * If there's no space in task_struct is available, hash will be used.
532 struct lu_context ce_ses
;
535 * This allows cl_env to be entered into cl_env_hash which implements
536 * the current thread -> client environment lookup.
538 struct hlist_node ce_node
;
540 * Owner for the current cl_env.
542 * If LL_TASK_CL_ENV is defined, this point to the owning current,
543 * only for debugging purpose ;
544 * Otherwise hash is used, and this is the key for cfs_hash.
545 * Now current thread pid is stored. Note using thread pointer would
546 * lead to unbalanced hash because of its specific allocation locality
547 * and could be varied for different platforms and OSes, even different
553 * Linkage into global list of all client environments. Used for
554 * garbage collection.
556 struct list_head ce_linkage
;
562 * Debugging field: address of the caller who made original
568 #define CL_ENV_INC(counter)
569 #define CL_ENV_DEC(counter)
571 static void cl_env_init0(struct cl_env
*cle
, void *debug
)
573 LASSERT(cle
->ce_ref
== 0);
574 LASSERT(cle
->ce_magic
== &cl_env_init0
);
575 LASSERT(cle
->ce_debug
== NULL
&& cle
->ce_owner
== NULL
);
578 cle
->ce_debug
= debug
;
584 * The implementation of using hash table to connect cl_env and thread
587 static cfs_hash_t
*cl_env_hash
;
589 static unsigned cl_env_hops_hash(cfs_hash_t
*lh
,
590 const void *key
, unsigned mask
)
592 #if BITS_PER_LONG == 64
593 return cfs_hash_u64_hash((__u64
)key
, mask
);
595 return cfs_hash_u32_hash((__u32
)key
, mask
);
599 static void *cl_env_hops_obj(struct hlist_node
*hn
)
601 struct cl_env
*cle
= hlist_entry(hn
, struct cl_env
, ce_node
);
602 LASSERT(cle
->ce_magic
== &cl_env_init0
);
606 static int cl_env_hops_keycmp(const void *key
, struct hlist_node
*hn
)
608 struct cl_env
*cle
= cl_env_hops_obj(hn
);
610 LASSERT(cle
->ce_owner
!= NULL
);
611 return (key
== cle
->ce_owner
);
614 static void cl_env_hops_noop(cfs_hash_t
*hs
, struct hlist_node
*hn
)
616 struct cl_env
*cle
= hlist_entry(hn
, struct cl_env
, ce_node
);
617 LASSERT(cle
->ce_magic
== &cl_env_init0
);
620 static cfs_hash_ops_t cl_env_hops
= {
621 .hs_hash
= cl_env_hops_hash
,
622 .hs_key
= cl_env_hops_obj
,
623 .hs_keycmp
= cl_env_hops_keycmp
,
624 .hs_object
= cl_env_hops_obj
,
625 .hs_get
= cl_env_hops_noop
,
626 .hs_put_locked
= cl_env_hops_noop
,
629 static inline struct cl_env
*cl_env_fetch(void)
633 cle
= cfs_hash_lookup(cl_env_hash
, (void *) (long) current
->pid
);
634 LASSERT(ergo(cle
, cle
->ce_magic
== &cl_env_init0
));
638 static inline void cl_env_attach(struct cl_env
*cle
)
643 LASSERT(cle
->ce_owner
== NULL
);
644 cle
->ce_owner
= (void *) (long) current
->pid
;
645 rc
= cfs_hash_add_unique(cl_env_hash
, cle
->ce_owner
,
651 static inline void cl_env_do_detach(struct cl_env
*cle
)
655 LASSERT(cle
->ce_owner
== (void *) (long) current
->pid
);
656 cookie
= cfs_hash_del(cl_env_hash
, cle
->ce_owner
,
658 LASSERT(cookie
== cle
);
659 cle
->ce_owner
= NULL
;
662 static int cl_env_store_init(void) {
663 cl_env_hash
= cfs_hash_create("cl_env",
664 HASH_CL_ENV_BITS
, HASH_CL_ENV_BITS
,
665 HASH_CL_ENV_BKT_BITS
, 0,
669 CFS_HASH_RW_BKTLOCK
);
670 return cl_env_hash
!= NULL
? 0 :-ENOMEM
;
673 static void cl_env_store_fini(void) {
674 cfs_hash_putref(cl_env_hash
);
678 static inline struct cl_env
*cl_env_detach(struct cl_env
*cle
)
681 cle
= cl_env_fetch();
683 if (cle
&& cle
->ce_owner
)
684 cl_env_do_detach(cle
);
689 static struct lu_env
*cl_env_new(__u32 ctx_tags
, __u32 ses_tags
, void *debug
)
694 OBD_SLAB_ALLOC_PTR_GFP(cle
, cl_env_kmem
, __GFP_IO
);
698 INIT_LIST_HEAD(&cle
->ce_linkage
);
699 cle
->ce_magic
= &cl_env_init0
;
701 rc
= lu_env_init(env
, LCT_CL_THREAD
|ctx_tags
);
703 rc
= lu_context_init(&cle
->ce_ses
,
704 LCT_SESSION
| ses_tags
);
706 lu_context_enter(&cle
->ce_ses
);
707 env
->le_ses
= &cle
->ce_ses
;
708 cl_env_init0(cle
, debug
);
713 OBD_SLAB_FREE_PTR(cle
, cl_env_kmem
);
720 env
= ERR_PTR(-ENOMEM
);
724 static void cl_env_fini(struct cl_env
*cle
)
727 lu_context_fini(&cle
->ce_lu
.le_ctx
);
728 lu_context_fini(&cle
->ce_ses
);
729 OBD_SLAB_FREE_PTR(cle
, cl_env_kmem
);
732 static inline struct cl_env
*cl_env_container(struct lu_env
*env
)
734 return container_of(env
, struct cl_env
, ce_lu
);
737 struct lu_env
*cl_env_peek(int *refcheck
)
744 /* check that we don't go far from untrusted pointer */
745 CLASSERT(offsetof(struct cl_env
, ce_magic
) == 0);
748 cle
= cl_env_fetch();
752 *refcheck
= ++cle
->ce_ref
;
754 CDEBUG(D_OTHER
, "%d@%p\n", cle
? cle
->ce_ref
: 0, cle
);
757 EXPORT_SYMBOL(cl_env_peek
);
760 * Returns lu_env: if there already is an environment associated with the
761 * current thread, it is returned, otherwise, new environment is allocated.
763 * \param refcheck pointer to a counter used to detect environment leaks. In
764 * the usual case cl_env_get() and cl_env_put() are called in the same lexical
765 * scope and pointer to the same integer is passed as \a refcheck. This is
766 * used to detect missed cl_env_put().
770 struct lu_env
*cl_env_get(int *refcheck
)
774 env
= cl_env_peek(refcheck
);
776 env
= cl_env_new(lu_context_tags_default
,
777 lu_session_tags_default
,
778 __builtin_return_address(0));
783 cle
= cl_env_container(env
);
785 *refcheck
= cle
->ce_ref
;
786 CDEBUG(D_OTHER
, "%d@%p\n", cle
->ce_ref
, cle
);
791 EXPORT_SYMBOL(cl_env_get
);
794 * Forces an allocation of a fresh environment with given tags.
798 struct lu_env
*cl_env_alloc(int *refcheck
, __u32 tags
)
802 LASSERT(cl_env_peek(refcheck
) == NULL
);
803 env
= cl_env_new(tags
, tags
, __builtin_return_address(0));
807 cle
= cl_env_container(env
);
808 *refcheck
= cle
->ce_ref
;
809 CDEBUG(D_OTHER
, "%d@%p\n", cle
->ce_ref
, cle
);
813 EXPORT_SYMBOL(cl_env_alloc
);
815 static void cl_env_exit(struct cl_env
*cle
)
817 LASSERT(cle
->ce_owner
== NULL
);
818 lu_context_exit(&cle
->ce_lu
.le_ctx
);
819 lu_context_exit(&cle
->ce_ses
);
823 * Release an environment.
825 * Decrement \a env reference counter. When counter drops to 0, nothing in
826 * this thread is using environment and it is returned to the allocation
827 * cache, or freed straight away, if cache is large enough.
829 void cl_env_put(struct lu_env
*env
, int *refcheck
)
833 cle
= cl_env_container(env
);
835 LASSERT(cle
->ce_ref
> 0);
836 LASSERT(ergo(refcheck
!= NULL
, cle
->ce_ref
== *refcheck
));
838 CDEBUG(D_OTHER
, "%d@%p\n", cle
->ce_ref
, cle
);
839 if (--cle
->ce_ref
== 0) {
842 cle
->ce_debug
= NULL
;
847 EXPORT_SYMBOL(cl_env_put
);
850 * Declares a point of re-entrancy.
852 * \see cl_env_reexit()
854 void *cl_env_reenter(void)
856 return cl_env_detach(NULL
);
858 EXPORT_SYMBOL(cl_env_reenter
);
863 void cl_env_reexit(void *cookie
)
866 cl_env_attach(cookie
);
868 EXPORT_SYMBOL(cl_env_reexit
);
871 * Setup user-supplied \a env as a current environment. This is to be used to
872 * guaranteed that environment exists even when cl_env_get() fails. It is up
873 * to user to ensure proper concurrency control.
875 * \see cl_env_unplant()
877 void cl_env_implant(struct lu_env
*env
, int *refcheck
)
879 struct cl_env
*cle
= cl_env_container(env
);
881 LASSERT(cle
->ce_ref
> 0);
884 cl_env_get(refcheck
);
885 CDEBUG(D_OTHER
, "%d@%p\n", cle
->ce_ref
, cle
);
887 EXPORT_SYMBOL(cl_env_implant
);
890 * Detach environment installed earlier by cl_env_implant().
892 void cl_env_unplant(struct lu_env
*env
, int *refcheck
)
894 struct cl_env
*cle
= cl_env_container(env
);
896 LASSERT(cle
->ce_ref
> 1);
898 CDEBUG(D_OTHER
, "%d@%p\n", cle
->ce_ref
, cle
);
901 cl_env_put(env
, refcheck
);
903 EXPORT_SYMBOL(cl_env_unplant
);
905 struct lu_env
*cl_env_nested_get(struct cl_env_nest
*nest
)
909 nest
->cen_cookie
= NULL
;
910 env
= cl_env_peek(&nest
->cen_refcheck
);
912 if (!cl_io_is_going(env
))
915 cl_env_put(env
, &nest
->cen_refcheck
);
916 nest
->cen_cookie
= cl_env_reenter();
919 env
= cl_env_get(&nest
->cen_refcheck
);
921 cl_env_reexit(nest
->cen_cookie
);
925 LASSERT(!cl_io_is_going(env
));
928 EXPORT_SYMBOL(cl_env_nested_get
);
930 void cl_env_nested_put(struct cl_env_nest
*nest
, struct lu_env
*env
)
932 cl_env_put(env
, &nest
->cen_refcheck
);
933 cl_env_reexit(nest
->cen_cookie
);
935 EXPORT_SYMBOL(cl_env_nested_put
);
938 * Converts struct cl_attr to struct ost_lvb.
942 void cl_attr2lvb(struct ost_lvb
*lvb
, const struct cl_attr
*attr
)
945 lvb
->lvb_size
= attr
->cat_size
;
946 lvb
->lvb_mtime
= attr
->cat_mtime
;
947 lvb
->lvb_atime
= attr
->cat_atime
;
948 lvb
->lvb_ctime
= attr
->cat_ctime
;
949 lvb
->lvb_blocks
= attr
->cat_blocks
;
952 EXPORT_SYMBOL(cl_attr2lvb
);
955 * Converts struct ost_lvb to struct cl_attr.
959 void cl_lvb2attr(struct cl_attr
*attr
, const struct ost_lvb
*lvb
)
962 attr
->cat_size
= lvb
->lvb_size
;
963 attr
->cat_mtime
= lvb
->lvb_mtime
;
964 attr
->cat_atime
= lvb
->lvb_atime
;
965 attr
->cat_ctime
= lvb
->lvb_ctime
;
966 attr
->cat_blocks
= lvb
->lvb_blocks
;
969 EXPORT_SYMBOL(cl_lvb2attr
);
971 /*****************************************************************************
973 * Temporary prototype thing: mirror obd-devices into cl devices.
977 struct cl_device
*cl_type_setup(const struct lu_env
*env
, struct lu_site
*site
,
978 struct lu_device_type
*ldt
,
979 struct lu_device
*next
)
981 const char *typename
;
984 LASSERT(ldt
!= NULL
);
986 typename
= ldt
->ldt_name
;
987 d
= ldt
->ldt_ops
->ldto_device_alloc(env
, ldt
, NULL
);
993 rc
= ldt
->ldt_ops
->ldto_device_init(env
, d
, typename
, next
);
996 lu_ref_add(&d
->ld_reference
,
997 "lu-stack", &lu_site_init
);
999 ldt
->ldt_ops
->ldto_device_free(env
, d
);
1000 CERROR("can't init device '%s', %d\n", typename
, rc
);
1004 CERROR("Cannot allocate device: '%s'\n", typename
);
1005 return lu2cl_dev(d
);
1007 EXPORT_SYMBOL(cl_type_setup
);
1010 * Finalize device stack by calling lu_stack_fini().
1012 void cl_stack_fini(const struct lu_env
*env
, struct cl_device
*cl
)
1014 lu_stack_fini(env
, cl2lu_dev(cl
));
1016 EXPORT_SYMBOL(cl_stack_fini
);
1018 int cl_lock_init(void);
1019 void cl_lock_fini(void);
1021 int cl_page_init(void);
1022 void cl_page_fini(void);
1024 static struct lu_context_key cl_key
;
1026 struct cl_thread_info
*cl_env_info(const struct lu_env
*env
)
1028 return lu_context_key_get(&env
->le_ctx
, &cl_key
);
1031 /* defines cl0_key_{init,fini}() */
1032 LU_KEY_INIT_FINI(cl0
, struct cl_thread_info
);
1034 static void *cl_key_init(const struct lu_context
*ctx
,
1035 struct lu_context_key
*key
)
1037 struct cl_thread_info
*info
;
1039 info
= cl0_key_init(ctx
, key
);
1040 if (!IS_ERR(info
)) {
1043 for (i
= 0; i
< ARRAY_SIZE(info
->clt_counters
); ++i
)
1044 lu_ref_init(&info
->clt_counters
[i
].ctc_locks_locked
);
1049 static void cl_key_fini(const struct lu_context
*ctx
,
1050 struct lu_context_key
*key
, void *data
)
1052 struct cl_thread_info
*info
;
1056 for (i
= 0; i
< ARRAY_SIZE(info
->clt_counters
); ++i
)
1057 lu_ref_fini(&info
->clt_counters
[i
].ctc_locks_locked
);
1058 cl0_key_fini(ctx
, key
, data
);
1061 static void cl_key_exit(const struct lu_context
*ctx
,
1062 struct lu_context_key
*key
, void *data
)
1064 struct cl_thread_info
*info
= data
;
1067 for (i
= 0; i
< ARRAY_SIZE(info
->clt_counters
); ++i
) {
1068 LASSERT(info
->clt_counters
[i
].ctc_nr_held
== 0);
1069 LASSERT(info
->clt_counters
[i
].ctc_nr_used
== 0);
1070 LASSERT(info
->clt_counters
[i
].ctc_nr_locks_acquired
== 0);
1071 LASSERT(info
->clt_counters
[i
].ctc_nr_locks_locked
== 0);
1072 lu_ref_fini(&info
->clt_counters
[i
].ctc_locks_locked
);
1073 lu_ref_init(&info
->clt_counters
[i
].ctc_locks_locked
);
1077 static struct lu_context_key cl_key
= {
1078 .lct_tags
= LCT_CL_THREAD
,
1079 .lct_init
= cl_key_init
,
1080 .lct_fini
= cl_key_fini
,
1081 .lct_exit
= cl_key_exit
1084 static struct lu_kmem_descr cl_object_caches
[] = {
1086 .ckd_cache
= &cl_env_kmem
,
1087 .ckd_name
= "cl_env_kmem",
1088 .ckd_size
= sizeof (struct cl_env
)
1096 * Global initialization of cl-data. Create kmem caches, register
1097 * lu_context_key's, etc.
1099 * \see cl_global_fini()
1101 int cl_global_init(void)
1105 result
= cl_env_store_init();
1109 result
= lu_kmem_init(cl_object_caches
);
1113 LU_CONTEXT_KEY_INIT(&cl_key
);
1114 result
= lu_context_key_register(&cl_key
);
1118 result
= cl_lock_init();
1122 result
= cl_page_init();
1130 lu_context_key_degister(&cl_key
);
1132 lu_kmem_fini(cl_object_caches
);
1134 cl_env_store_fini();
1139 * Finalization of global cl-data. Dual to cl_global_init().
1141 void cl_global_fini(void)
1145 lu_context_key_degister(&cl_key
);
1146 lu_kmem_fini(cl_object_caches
);
1147 cl_env_store_fini();