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, Whamcloud, Inc.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
38 * Author: Nikita Danilov <nikita.danilov@sun.com>
41 #define DEBUG_SUBSYSTEM S_CLASS
43 # define EXPORT_SYMTAB
46 #include <obd_class.h>
47 #include <obd_support.h>
48 #include <lustre_fid.h>
49 #include <libcfs/list.h>
50 /* lu_time_global_{init,fini}() */
53 #include <cl_object.h>
54 #include "cl_internal.h"
56 /** Lock class of cl_lock::cll_guard */
57 static cfs_lock_class_key_t cl_lock_guard_class;
58 static cfs_mem_cache_t *cl_lock_kmem;
60 static struct lu_kmem_descr cl_lock_caches[] = {
62 .ckd_cache = &cl_lock_kmem,
63 .ckd_name = "cl_lock_kmem",
64 .ckd_size = sizeof (struct cl_lock)
72 * Basic lock invariant that is maintained at all times. Caller either has a
73 * reference to \a lock, or somehow assures that \a lock cannot be freed.
75 * \see cl_lock_invariant()
77 static int cl_lock_invariant_trusted(const struct lu_env *env,
78 const struct cl_lock *lock)
80 return ergo(lock->cll_state == CLS_FREEING, lock->cll_holds == 0) &&
81 cfs_atomic_read(&lock->cll_ref) >= lock->cll_holds &&
82 lock->cll_holds >= lock->cll_users &&
83 lock->cll_holds >= 0 &&
84 lock->cll_users >= 0 &&
89 * Stronger lock invariant, checking that caller has a reference on a lock.
91 * \see cl_lock_invariant_trusted()
93 static int cl_lock_invariant(const struct lu_env *env,
94 const struct cl_lock *lock)
98 result = cfs_atomic_read(&lock->cll_ref) > 0 &&
99 cl_lock_invariant_trusted(env, lock);
100 if (!result && env != NULL)
101 CL_LOCK_DEBUG(D_ERROR, env, lock, "invariant broken");
106 * Returns lock "nesting": 0 for a top-lock and 1 for a sub-lock.
108 static enum clt_nesting_level cl_lock_nesting(const struct cl_lock *lock)
110 return cl_object_header(lock->cll_descr.cld_obj)->coh_nesting;
114 * Returns a set of counters for this lock, depending on a lock nesting.
116 static struct cl_thread_counters *cl_lock_counters(const struct lu_env *env,
117 const struct cl_lock *lock)
119 struct cl_thread_info *info;
120 enum clt_nesting_level nesting;
122 info = cl_env_info(env);
123 nesting = cl_lock_nesting(lock);
124 LASSERT(nesting < ARRAY_SIZE(info->clt_counters));
125 return &info->clt_counters[nesting];
128 static void cl_lock_trace0(int level, const struct lu_env *env,
129 const char *prefix, const struct cl_lock *lock,
130 const char *func, const int line)
132 struct cl_object_header *h = cl_object_header(lock->cll_descr.cld_obj);
133 CDEBUG(level, "%s: %p@(%d %p %d %d %d %d %d %lx)"
134 "(%p/%d/%d) at %s():%d\n",
135 prefix, lock, cfs_atomic_read(&lock->cll_ref),
136 lock->cll_guarder, lock->cll_depth,
137 lock->cll_state, lock->cll_error, lock->cll_holds,
138 lock->cll_users, lock->cll_flags,
139 env, h->coh_nesting, cl_lock_nr_mutexed(env),
142 #define cl_lock_trace(level, env, prefix, lock) \
143 cl_lock_trace0(level, env, prefix, lock, __FUNCTION__, __LINE__)
145 #define RETIP ((unsigned long)__builtin_return_address(0))
147 #ifdef CONFIG_LOCKDEP
148 static cfs_lock_class_key_t cl_lock_key;
150 static void cl_lock_lockdep_init(struct cl_lock *lock)
152 lockdep_set_class_and_name(lock, &cl_lock_key, "EXT");
155 static void cl_lock_lockdep_acquire(const struct lu_env *env,
156 struct cl_lock *lock, __u32 enqflags)
158 cl_lock_counters(env, lock)->ctc_nr_locks_acquired++;
159 #ifdef HAVE_LOCK_MAP_ACQUIRE
160 lock_map_acquire(&lock->dep_map);
161 #else /* HAVE_LOCK_MAP_ACQUIRE */
162 lock_acquire(&lock->dep_map, !!(enqflags & CEF_ASYNC),
163 /* try: */ 0, lock->cll_descr.cld_mode <= CLM_READ,
164 /* check: */ 2, RETIP);
165 #endif /* HAVE_LOCK_MAP_ACQUIRE */
168 static void cl_lock_lockdep_release(const struct lu_env *env,
169 struct cl_lock *lock)
171 cl_lock_counters(env, lock)->ctc_nr_locks_acquired--;
172 lock_release(&lock->dep_map, 0, RETIP);
175 #else /* !CONFIG_LOCKDEP */
177 static void cl_lock_lockdep_init(struct cl_lock *lock)
179 static void cl_lock_lockdep_acquire(const struct lu_env *env,
180 struct cl_lock *lock, __u32 enqflags)
182 static void cl_lock_lockdep_release(const struct lu_env *env,
183 struct cl_lock *lock)
186 #endif /* !CONFIG_LOCKDEP */
189 * Adds lock slice to the compound lock.
191 * This is called by cl_object_operations::coo_lock_init() methods to add a
192 * per-layer state to the lock. New state is added at the end of
193 * cl_lock::cll_layers list, that is, it is at the bottom of the stack.
195 * \see cl_req_slice_add(), cl_page_slice_add(), cl_io_slice_add()
197 void cl_lock_slice_add(struct cl_lock *lock, struct cl_lock_slice *slice,
198 struct cl_object *obj,
199 const struct cl_lock_operations *ops)
202 slice->cls_lock = lock;
203 cfs_list_add_tail(&slice->cls_linkage, &lock->cll_layers);
204 slice->cls_obj = obj;
205 slice->cls_ops = ops;
208 EXPORT_SYMBOL(cl_lock_slice_add);
211 * Returns true iff a lock with the mode \a has provides at least the same
212 * guarantees as a lock with the mode \a need.
214 int cl_lock_mode_match(enum cl_lock_mode has, enum cl_lock_mode need)
216 LINVRNT(need == CLM_READ || need == CLM_WRITE ||
217 need == CLM_PHANTOM || need == CLM_GROUP);
218 LINVRNT(has == CLM_READ || has == CLM_WRITE ||
219 has == CLM_PHANTOM || has == CLM_GROUP);
220 CLASSERT(CLM_PHANTOM < CLM_READ);
221 CLASSERT(CLM_READ < CLM_WRITE);
222 CLASSERT(CLM_WRITE < CLM_GROUP);
224 if (has != CLM_GROUP)
229 EXPORT_SYMBOL(cl_lock_mode_match);
232 * Returns true iff extent portions of lock descriptions match.
234 int cl_lock_ext_match(const struct cl_lock_descr *has,
235 const struct cl_lock_descr *need)
238 has->cld_start <= need->cld_start &&
239 has->cld_end >= need->cld_end &&
240 cl_lock_mode_match(has->cld_mode, need->cld_mode) &&
241 (has->cld_mode != CLM_GROUP || has->cld_gid == need->cld_gid);
243 EXPORT_SYMBOL(cl_lock_ext_match);
246 * Returns true iff a lock with the description \a has provides at least the
247 * same guarantees as a lock with the description \a need.
249 int cl_lock_descr_match(const struct cl_lock_descr *has,
250 const struct cl_lock_descr *need)
253 cl_object_same(has->cld_obj, need->cld_obj) &&
254 cl_lock_ext_match(has, need);
256 EXPORT_SYMBOL(cl_lock_descr_match);
258 static void cl_lock_free(const struct lu_env *env, struct cl_lock *lock)
260 struct cl_object *obj = lock->cll_descr.cld_obj;
262 LINVRNT(!cl_lock_is_mutexed(lock));
265 cl_lock_trace(D_DLMTRACE, env, "free lock", lock);
267 while (!cfs_list_empty(&lock->cll_layers)) {
268 struct cl_lock_slice *slice;
270 slice = cfs_list_entry(lock->cll_layers.next,
271 struct cl_lock_slice, cls_linkage);
272 cfs_list_del_init(lock->cll_layers.next);
273 slice->cls_ops->clo_fini(env, slice);
275 cfs_atomic_dec(&cl_object_site(obj)->cs_locks.cs_total);
276 cfs_atomic_dec(&cl_object_site(obj)->cs_locks_state[lock->cll_state]);
277 lu_object_ref_del_at(&obj->co_lu, lock->cll_obj_ref, "cl_lock", lock);
278 cl_object_put(env, obj);
279 lu_ref_fini(&lock->cll_reference);
280 lu_ref_fini(&lock->cll_holders);
281 cfs_mutex_destroy(&lock->cll_guard);
282 OBD_SLAB_FREE_PTR(lock, cl_lock_kmem);
287 * Releases a reference on a lock.
289 * When last reference is released, lock is returned to the cache, unless it
290 * is in cl_lock_state::CLS_FREEING state, in which case it is destroyed
293 * \see cl_object_put(), cl_page_put()
295 void cl_lock_put(const struct lu_env *env, struct cl_lock *lock)
297 struct cl_object *obj;
298 struct cl_site *site;
300 LINVRNT(cl_lock_invariant(env, lock));
302 obj = lock->cll_descr.cld_obj;
303 LINVRNT(obj != NULL);
304 site = cl_object_site(obj);
306 CDEBUG(D_TRACE, "releasing reference: %d %p %lu\n",
307 cfs_atomic_read(&lock->cll_ref), lock, RETIP);
309 if (cfs_atomic_dec_and_test(&lock->cll_ref)) {
310 if (lock->cll_state == CLS_FREEING) {
311 LASSERT(cfs_list_empty(&lock->cll_linkage));
312 cl_lock_free(env, lock);
314 cfs_atomic_dec(&site->cs_locks.cs_busy);
318 EXPORT_SYMBOL(cl_lock_put);
321 * Acquires an additional reference to a lock.
323 * This can be called only by caller already possessing a reference to \a
326 * \see cl_object_get(), cl_page_get()
328 void cl_lock_get(struct cl_lock *lock)
330 LINVRNT(cl_lock_invariant(NULL, lock));
331 CDEBUG(D_TRACE, "acquiring reference: %d %p %lu\n",
332 cfs_atomic_read(&lock->cll_ref), lock, RETIP);
333 cfs_atomic_inc(&lock->cll_ref);
335 EXPORT_SYMBOL(cl_lock_get);
338 * Acquires a reference to a lock.
340 * This is much like cl_lock_get(), except that this function can be used to
341 * acquire initial reference to the cached lock. Caller has to deal with all
342 * possible races. Use with care!
344 * \see cl_page_get_trust()
346 void cl_lock_get_trust(struct cl_lock *lock)
348 struct cl_site *site = cl_object_site(lock->cll_descr.cld_obj);
350 CDEBUG(D_TRACE, "acquiring trusted reference: %d %p %lu\n",
351 cfs_atomic_read(&lock->cll_ref), lock, RETIP);
352 if (cfs_atomic_inc_return(&lock->cll_ref) == 1)
353 cfs_atomic_inc(&site->cs_locks.cs_busy);
355 EXPORT_SYMBOL(cl_lock_get_trust);
358 * Helper function destroying the lock that wasn't completely initialized.
360 * Other threads can acquire references to the top-lock through its
361 * sub-locks. Hence, it cannot be cl_lock_free()-ed immediately.
363 static void cl_lock_finish(const struct lu_env *env, struct cl_lock *lock)
365 cl_lock_mutex_get(env, lock);
366 cl_lock_cancel(env, lock);
367 cl_lock_delete(env, lock);
368 cl_lock_mutex_put(env, lock);
369 cl_lock_put(env, lock);
372 static struct cl_lock *cl_lock_alloc(const struct lu_env *env,
373 struct cl_object *obj,
374 const struct cl_io *io,
375 const struct cl_lock_descr *descr)
377 struct cl_lock *lock;
378 struct lu_object_header *head;
379 struct cl_site *site = cl_object_site(obj);
382 OBD_SLAB_ALLOC_PTR_GFP(lock, cl_lock_kmem, CFS_ALLOC_IO);
384 cfs_atomic_set(&lock->cll_ref, 1);
385 lock->cll_descr = *descr;
386 lock->cll_state = CLS_NEW;
388 lock->cll_obj_ref = lu_object_ref_add(&obj->co_lu,
390 CFS_INIT_LIST_HEAD(&lock->cll_layers);
391 CFS_INIT_LIST_HEAD(&lock->cll_linkage);
392 CFS_INIT_LIST_HEAD(&lock->cll_inclosure);
393 lu_ref_init(&lock->cll_reference);
394 lu_ref_init(&lock->cll_holders);
395 cfs_mutex_init(&lock->cll_guard);
396 cfs_lockdep_set_class(&lock->cll_guard, &cl_lock_guard_class);
397 cfs_waitq_init(&lock->cll_wq);
398 head = obj->co_lu.lo_header;
399 cfs_atomic_inc(&site->cs_locks_state[CLS_NEW]);
400 cfs_atomic_inc(&site->cs_locks.cs_total);
401 cfs_atomic_inc(&site->cs_locks.cs_created);
402 cl_lock_lockdep_init(lock);
403 cfs_list_for_each_entry(obj, &head->loh_layers,
407 err = obj->co_ops->coo_lock_init(env, obj, lock, io);
409 cl_lock_finish(env, lock);
415 lock = ERR_PTR(-ENOMEM);
420 * Transfer the lock into INTRANSIT state and return the original state.
422 * \pre state: CLS_CACHED, CLS_HELD or CLS_ENQUEUED
423 * \post state: CLS_INTRANSIT
426 enum cl_lock_state cl_lock_intransit(const struct lu_env *env,
427 struct cl_lock *lock)
429 enum cl_lock_state state = lock->cll_state;
431 LASSERT(cl_lock_is_mutexed(lock));
432 LASSERT(state != CLS_INTRANSIT);
433 LASSERTF(state >= CLS_ENQUEUED && state <= CLS_CACHED,
434 "Malformed lock state %d.\n", state);
436 cl_lock_state_set(env, lock, CLS_INTRANSIT);
437 lock->cll_intransit_owner = cfs_current();
438 cl_lock_hold_add(env, lock, "intransit", cfs_current());
441 EXPORT_SYMBOL(cl_lock_intransit);
444 * Exit the intransit state and restore the lock state to the original state
446 void cl_lock_extransit(const struct lu_env *env, struct cl_lock *lock,
447 enum cl_lock_state state)
449 LASSERT(cl_lock_is_mutexed(lock));
450 LASSERT(lock->cll_state == CLS_INTRANSIT);
451 LASSERT(state != CLS_INTRANSIT);
452 LASSERT(lock->cll_intransit_owner == cfs_current());
454 lock->cll_intransit_owner = NULL;
455 cl_lock_state_set(env, lock, state);
456 cl_lock_unhold(env, lock, "intransit", cfs_current());
458 EXPORT_SYMBOL(cl_lock_extransit);
461 * Checking whether the lock is intransit state
463 int cl_lock_is_intransit(struct cl_lock *lock)
465 LASSERT(cl_lock_is_mutexed(lock));
466 return lock->cll_state == CLS_INTRANSIT &&
467 lock->cll_intransit_owner != cfs_current();
469 EXPORT_SYMBOL(cl_lock_is_intransit);
471 * Returns true iff lock is "suitable" for given io. E.g., locks acquired by
472 * truncate and O_APPEND cannot be reused for read/non-append-write, as they
473 * cover multiple stripes and can trigger cascading timeouts.
475 static int cl_lock_fits_into(const struct lu_env *env,
476 const struct cl_lock *lock,
477 const struct cl_lock_descr *need,
478 const struct cl_io *io)
480 const struct cl_lock_slice *slice;
482 LINVRNT(cl_lock_invariant_trusted(env, lock));
484 cfs_list_for_each_entry(slice, &lock->cll_layers, cls_linkage) {
485 if (slice->cls_ops->clo_fits_into != NULL &&
486 !slice->cls_ops->clo_fits_into(env, slice, need, io))
492 static struct cl_lock *cl_lock_lookup(const struct lu_env *env,
493 struct cl_object *obj,
494 const struct cl_io *io,
495 const struct cl_lock_descr *need)
497 struct cl_lock *lock;
498 struct cl_object_header *head;
499 struct cl_site *site;
503 head = cl_object_header(obj);
504 site = cl_object_site(obj);
505 LINVRNT_SPIN_LOCKED(&head->coh_lock_guard);
506 cfs_atomic_inc(&site->cs_locks.cs_lookup);
507 cfs_list_for_each_entry(lock, &head->coh_locks, cll_linkage) {
510 matched = cl_lock_ext_match(&lock->cll_descr, need) &&
511 lock->cll_state < CLS_FREEING &&
512 lock->cll_error == 0 &&
513 !(lock->cll_flags & CLF_CANCELLED) &&
514 cl_lock_fits_into(env, lock, need, io);
515 CDEBUG(D_DLMTRACE, "has: "DDESCR"(%d) need: "DDESCR": %d\n",
516 PDESCR(&lock->cll_descr), lock->cll_state, PDESCR(need),
519 cl_lock_get_trust(lock);
520 cfs_atomic_inc(&cl_object_site(obj)->cs_locks.cs_hit);
528 * Returns a lock matching description \a need.
530 * This is the main entry point into the cl_lock caching interface. First, a
531 * cache (implemented as a per-object linked list) is consulted. If lock is
532 * found there, it is returned immediately. Otherwise new lock is allocated
533 * and returned. In any case, additional reference to lock is acquired.
535 * \see cl_object_find(), cl_page_find()
537 static struct cl_lock *cl_lock_find(const struct lu_env *env,
538 const struct cl_io *io,
539 const struct cl_lock_descr *need)
541 struct cl_object_header *head;
542 struct cl_object *obj;
543 struct cl_lock *lock;
544 struct cl_site *site;
549 head = cl_object_header(obj);
550 site = cl_object_site(obj);
552 cfs_spin_lock(&head->coh_lock_guard);
553 lock = cl_lock_lookup(env, obj, io, need);
554 cfs_spin_unlock(&head->coh_lock_guard);
557 lock = cl_lock_alloc(env, obj, io, need);
559 struct cl_lock *ghost;
561 cfs_spin_lock(&head->coh_lock_guard);
562 ghost = cl_lock_lookup(env, obj, io, need);
564 cfs_list_add_tail(&lock->cll_linkage,
566 cfs_spin_unlock(&head->coh_lock_guard);
567 cfs_atomic_inc(&site->cs_locks.cs_busy);
569 cfs_spin_unlock(&head->coh_lock_guard);
571 * Other threads can acquire references to the
572 * top-lock through its sub-locks. Hence, it
573 * cannot be cl_lock_free()-ed immediately.
575 cl_lock_finish(env, lock);
584 * Returns existing lock matching given description. This is similar to
585 * cl_lock_find() except that no new lock is created, and returned lock is
586 * guaranteed to be in enum cl_lock_state::CLS_HELD state.
588 struct cl_lock *cl_lock_peek(const struct lu_env *env, const struct cl_io *io,
589 const struct cl_lock_descr *need,
590 const char *scope, const void *source)
592 struct cl_object_header *head;
593 struct cl_object *obj;
594 struct cl_lock *lock;
597 head = cl_object_header(obj);
599 cfs_spin_lock(&head->coh_lock_guard);
600 lock = cl_lock_lookup(env, obj, io, need);
601 cfs_spin_unlock(&head->coh_lock_guard);
606 cl_lock_mutex_get(env, lock);
607 if (lock->cll_state == CLS_INTRANSIT)
608 cl_lock_state_wait(env, lock); /* Don't care return value. */
609 if (lock->cll_state == CLS_CACHED) {
611 result = cl_use_try(env, lock, 1);
613 cl_lock_error(env, lock, result);
615 if (lock->cll_state == CLS_HELD) {
616 cl_lock_hold_add(env, lock, scope, source);
617 cl_lock_user_add(env, lock);
618 cl_lock_mutex_put(env, lock);
619 cl_lock_lockdep_acquire(env, lock, 0);
620 cl_lock_put(env, lock);
622 cl_lock_mutex_put(env, lock);
623 cl_lock_put(env, lock);
629 EXPORT_SYMBOL(cl_lock_peek);
632 * Returns a slice within a lock, corresponding to the given layer in the
637 const struct cl_lock_slice *cl_lock_at(const struct cl_lock *lock,
638 const struct lu_device_type *dtype)
640 const struct cl_lock_slice *slice;
642 LINVRNT(cl_lock_invariant_trusted(NULL, lock));
645 cfs_list_for_each_entry(slice, &lock->cll_layers, cls_linkage) {
646 if (slice->cls_obj->co_lu.lo_dev->ld_type == dtype)
651 EXPORT_SYMBOL(cl_lock_at);
653 static void cl_lock_mutex_tail(const struct lu_env *env, struct cl_lock *lock)
655 struct cl_thread_counters *counters;
657 counters = cl_lock_counters(env, lock);
659 counters->ctc_nr_locks_locked++;
660 lu_ref_add(&counters->ctc_locks_locked, "cll_guard", lock);
661 cl_lock_trace(D_TRACE, env, "got mutex", lock);
665 * Locks cl_lock object.
667 * This is used to manipulate cl_lock fields, and to serialize state
668 * transitions in the lock state machine.
670 * \post cl_lock_is_mutexed(lock)
672 * \see cl_lock_mutex_put()
674 void cl_lock_mutex_get(const struct lu_env *env, struct cl_lock *lock)
676 LINVRNT(cl_lock_invariant(env, lock));
678 if (lock->cll_guarder == cfs_current()) {
679 LINVRNT(cl_lock_is_mutexed(lock));
680 LINVRNT(lock->cll_depth > 0);
682 struct cl_object_header *hdr;
683 struct cl_thread_info *info;
686 LINVRNT(lock->cll_guarder != cfs_current());
687 hdr = cl_object_header(lock->cll_descr.cld_obj);
689 * Check that mutices are taken in the bottom-to-top order.
691 info = cl_env_info(env);
692 for (i = 0; i < hdr->coh_nesting; ++i)
693 LASSERT(info->clt_counters[i].ctc_nr_locks_locked == 0);
694 cfs_mutex_lock_nested(&lock->cll_guard, hdr->coh_nesting);
695 lock->cll_guarder = cfs_current();
696 LINVRNT(lock->cll_depth == 0);
698 cl_lock_mutex_tail(env, lock);
700 EXPORT_SYMBOL(cl_lock_mutex_get);
703 * Try-locks cl_lock object.
705 * \retval 0 \a lock was successfully locked
707 * \retval -EBUSY \a lock cannot be locked right now
709 * \post ergo(result == 0, cl_lock_is_mutexed(lock))
711 * \see cl_lock_mutex_get()
713 int cl_lock_mutex_try(const struct lu_env *env, struct cl_lock *lock)
717 LINVRNT(cl_lock_invariant_trusted(env, lock));
721 if (lock->cll_guarder == cfs_current()) {
722 LINVRNT(lock->cll_depth > 0);
723 cl_lock_mutex_tail(env, lock);
724 } else if (cfs_mutex_trylock(&lock->cll_guard)) {
725 LINVRNT(lock->cll_depth == 0);
726 lock->cll_guarder = cfs_current();
727 cl_lock_mutex_tail(env, lock);
732 EXPORT_SYMBOL(cl_lock_mutex_try);
735 {* Unlocks cl_lock object.
737 * \pre cl_lock_is_mutexed(lock)
739 * \see cl_lock_mutex_get()
741 void cl_lock_mutex_put(const struct lu_env *env, struct cl_lock *lock)
743 struct cl_thread_counters *counters;
745 LINVRNT(cl_lock_invariant(env, lock));
746 LINVRNT(cl_lock_is_mutexed(lock));
747 LINVRNT(lock->cll_guarder == cfs_current());
748 LINVRNT(lock->cll_depth > 0);
750 counters = cl_lock_counters(env, lock);
751 LINVRNT(counters->ctc_nr_locks_locked > 0);
753 cl_lock_trace(D_TRACE, env, "put mutex", lock);
754 lu_ref_del(&counters->ctc_locks_locked, "cll_guard", lock);
755 counters->ctc_nr_locks_locked--;
756 if (--lock->cll_depth == 0) {
757 lock->cll_guarder = NULL;
758 cfs_mutex_unlock(&lock->cll_guard);
761 EXPORT_SYMBOL(cl_lock_mutex_put);
764 * Returns true iff lock's mutex is owned by the current thread.
766 int cl_lock_is_mutexed(struct cl_lock *lock)
768 return lock->cll_guarder == cfs_current();
770 EXPORT_SYMBOL(cl_lock_is_mutexed);
773 * Returns number of cl_lock mutices held by the current thread (environment).
775 int cl_lock_nr_mutexed(const struct lu_env *env)
777 struct cl_thread_info *info;
782 * NOTE: if summation across all nesting levels (currently 2) proves
783 * too expensive, a summary counter can be added to
784 * struct cl_thread_info.
786 info = cl_env_info(env);
787 for (i = 0, locked = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
788 locked += info->clt_counters[i].ctc_nr_locks_locked;
791 EXPORT_SYMBOL(cl_lock_nr_mutexed);
793 static void cl_lock_cancel0(const struct lu_env *env, struct cl_lock *lock)
795 LINVRNT(cl_lock_is_mutexed(lock));
796 LINVRNT(cl_lock_invariant(env, lock));
798 if (!(lock->cll_flags & CLF_CANCELLED)) {
799 const struct cl_lock_slice *slice;
801 lock->cll_flags |= CLF_CANCELLED;
802 cfs_list_for_each_entry_reverse(slice, &lock->cll_layers,
804 if (slice->cls_ops->clo_cancel != NULL)
805 slice->cls_ops->clo_cancel(env, slice);
811 static void cl_lock_delete0(const struct lu_env *env, struct cl_lock *lock)
813 struct cl_object_header *head;
814 const struct cl_lock_slice *slice;
816 LINVRNT(cl_lock_is_mutexed(lock));
817 LINVRNT(cl_lock_invariant(env, lock));
820 if (lock->cll_state < CLS_FREEING) {
821 LASSERT(lock->cll_state != CLS_INTRANSIT);
822 cl_lock_state_set(env, lock, CLS_FREEING);
824 head = cl_object_header(lock->cll_descr.cld_obj);
826 cfs_spin_lock(&head->coh_lock_guard);
827 cfs_list_del_init(&lock->cll_linkage);
829 cfs_spin_unlock(&head->coh_lock_guard);
831 * From now on, no new references to this lock can be acquired
832 * by cl_lock_lookup().
834 cfs_list_for_each_entry_reverse(slice, &lock->cll_layers,
836 if (slice->cls_ops->clo_delete != NULL)
837 slice->cls_ops->clo_delete(env, slice);
840 * From now on, no new references to this lock can be acquired
841 * by layer-specific means (like a pointer from struct
842 * ldlm_lock in osc, or a pointer from top-lock to sub-lock in
845 * Lock will be finally freed in cl_lock_put() when last of
846 * existing references goes away.
853 * Mod(ifie)s cl_lock::cll_holds counter for a given lock. Also, for a
854 * top-lock (nesting == 0) accounts for this modification in the per-thread
855 * debugging counters. Sub-lock holds can be released by a thread different
856 * from one that acquired it.
858 static void cl_lock_hold_mod(const struct lu_env *env, struct cl_lock *lock,
861 struct cl_thread_counters *counters;
862 enum clt_nesting_level nesting;
864 lock->cll_holds += delta;
865 nesting = cl_lock_nesting(lock);
866 if (nesting == CNL_TOP) {
867 counters = &cl_env_info(env)->clt_counters[CNL_TOP];
868 counters->ctc_nr_held += delta;
869 LASSERT(counters->ctc_nr_held >= 0);
874 * Mod(ifie)s cl_lock::cll_users counter for a given lock. See
875 * cl_lock_hold_mod() for the explanation of the debugging code.
877 static void cl_lock_used_mod(const struct lu_env *env, struct cl_lock *lock,
880 struct cl_thread_counters *counters;
881 enum clt_nesting_level nesting;
883 lock->cll_users += delta;
884 nesting = cl_lock_nesting(lock);
885 if (nesting == CNL_TOP) {
886 counters = &cl_env_info(env)->clt_counters[CNL_TOP];
887 counters->ctc_nr_used += delta;
888 LASSERT(counters->ctc_nr_used >= 0);
892 static void cl_lock_hold_release(const struct lu_env *env, struct cl_lock *lock,
893 const char *scope, const void *source)
895 LINVRNT(cl_lock_is_mutexed(lock));
896 LINVRNT(cl_lock_invariant(env, lock));
897 LASSERT(lock->cll_holds > 0);
900 cl_lock_trace(D_DLMTRACE, env, "hold release lock", lock);
901 lu_ref_del(&lock->cll_holders, scope, source);
902 cl_lock_hold_mod(env, lock, -1);
903 if (lock->cll_holds == 0) {
904 if (lock->cll_descr.cld_mode == CLM_PHANTOM ||
905 lock->cll_descr.cld_mode == CLM_GROUP)
907 * If lock is still phantom or grouplock when user is
908 * done with it---destroy the lock.
910 lock->cll_flags |= CLF_CANCELPEND|CLF_DOOMED;
911 if (lock->cll_flags & CLF_CANCELPEND) {
912 lock->cll_flags &= ~CLF_CANCELPEND;
913 cl_lock_cancel0(env, lock);
915 if (lock->cll_flags & CLF_DOOMED) {
916 /* no longer doomed: it's dead... Jim. */
917 lock->cll_flags &= ~CLF_DOOMED;
918 cl_lock_delete0(env, lock);
925 * Waits until lock state is changed.
927 * This function is called with cl_lock mutex locked, atomically releases
928 * mutex and goes to sleep, waiting for a lock state change (signaled by
929 * cl_lock_signal()), and re-acquires the mutex before return.
931 * This function is used to wait until lock state machine makes some progress
932 * and to emulate synchronous operations on top of asynchronous lock
935 * \retval -EINTR wait was interrupted
937 * \retval 0 wait wasn't interrupted
939 * \pre cl_lock_is_mutexed(lock)
941 * \see cl_lock_signal()
943 int cl_lock_state_wait(const struct lu_env *env, struct cl_lock *lock)
945 cfs_waitlink_t waiter;
946 cfs_sigset_t blocked;
950 LINVRNT(cl_lock_is_mutexed(lock));
951 LINVRNT(cl_lock_invariant(env, lock));
952 LASSERT(lock->cll_depth == 1);
953 LASSERT(lock->cll_state != CLS_FREEING); /* too late to wait */
955 cl_lock_trace(D_DLMTRACE, env, "state wait lock", lock);
956 result = lock->cll_error;
958 /* To avoid being interrupted by the 'non-fatal' signals
959 * (SIGCHLD, for instance), we'd block them temporarily.
961 blocked = cfs_block_sigsinv(LUSTRE_FATAL_SIGS);
963 cfs_waitlink_init(&waiter);
964 cfs_waitq_add(&lock->cll_wq, &waiter);
965 cfs_set_current_state(CFS_TASK_INTERRUPTIBLE);
966 cl_lock_mutex_put(env, lock);
968 LASSERT(cl_lock_nr_mutexed(env) == 0);
969 cfs_waitq_wait(&waiter, CFS_TASK_INTERRUPTIBLE);
971 cl_lock_mutex_get(env, lock);
972 cfs_set_current_state(CFS_TASK_RUNNING);
973 cfs_waitq_del(&lock->cll_wq, &waiter);
974 result = cfs_signal_pending() ? -EINTR : 0;
976 /* Restore old blocked signals */
977 cfs_restore_sigs(blocked);
981 EXPORT_SYMBOL(cl_lock_state_wait);
983 static void cl_lock_state_signal(const struct lu_env *env, struct cl_lock *lock,
984 enum cl_lock_state state)
986 const struct cl_lock_slice *slice;
989 LINVRNT(cl_lock_is_mutexed(lock));
990 LINVRNT(cl_lock_invariant(env, lock));
992 cfs_list_for_each_entry(slice, &lock->cll_layers, cls_linkage)
993 if (slice->cls_ops->clo_state != NULL)
994 slice->cls_ops->clo_state(env, slice, state);
995 cfs_waitq_broadcast(&lock->cll_wq);
1000 * Notifies waiters that lock state changed.
1002 * Wakes up all waiters sleeping in cl_lock_state_wait(), also notifies all
1003 * layers about state change by calling cl_lock_operations::clo_state()
1006 void cl_lock_signal(const struct lu_env *env, struct cl_lock *lock)
1009 cl_lock_trace(D_DLMTRACE, env, "state signal lock", lock);
1010 cl_lock_state_signal(env, lock, lock->cll_state);
1013 EXPORT_SYMBOL(cl_lock_signal);
1016 * Changes lock state.
1018 * This function is invoked to notify layers that lock state changed, possible
1019 * as a result of an asynchronous event such as call-back reception.
1021 * \post lock->cll_state == state
1023 * \see cl_lock_operations::clo_state()
1025 void cl_lock_state_set(const struct lu_env *env, struct cl_lock *lock,
1026 enum cl_lock_state state)
1028 struct cl_site *site = cl_object_site(lock->cll_descr.cld_obj);
1031 LASSERT(lock->cll_state <= state ||
1032 (lock->cll_state == CLS_CACHED &&
1033 (state == CLS_HELD || /* lock found in cache */
1034 state == CLS_NEW || /* sub-lock canceled */
1035 state == CLS_INTRANSIT)) ||
1036 /* lock is in transit state */
1037 lock->cll_state == CLS_INTRANSIT);
1039 if (lock->cll_state != state) {
1040 cfs_atomic_dec(&site->cs_locks_state[lock->cll_state]);
1041 cfs_atomic_inc(&site->cs_locks_state[state]);
1043 cl_lock_state_signal(env, lock, state);
1044 lock->cll_state = state;
1048 EXPORT_SYMBOL(cl_lock_state_set);
1050 static int cl_unuse_try_internal(const struct lu_env *env, struct cl_lock *lock)
1052 const struct cl_lock_slice *slice;
1058 LINVRNT(cl_lock_is_mutexed(lock));
1059 LINVRNT(cl_lock_invariant(env, lock));
1060 LASSERT(lock->cll_state == CLS_INTRANSIT);
1063 cfs_list_for_each_entry_reverse(slice, &lock->cll_layers,
1065 if (slice->cls_ops->clo_unuse != NULL) {
1066 result = slice->cls_ops->clo_unuse(env, slice);
1071 LASSERT(result != -ENOSYS);
1072 } while (result == CLO_REPEAT);
1078 * Yanks lock from the cache (cl_lock_state::CLS_CACHED state) by calling
1079 * cl_lock_operations::clo_use() top-to-bottom to notify layers.
1080 * @atomic = 1, it must unuse the lock to recovery the lock to keep the
1081 * use process atomic
1083 int cl_use_try(const struct lu_env *env, struct cl_lock *lock, int atomic)
1085 const struct cl_lock_slice *slice;
1087 enum cl_lock_state state;
1090 cl_lock_trace(D_DLMTRACE, env, "use lock", lock);
1092 LASSERT(lock->cll_state == CLS_CACHED);
1093 if (lock->cll_error)
1094 RETURN(lock->cll_error);
1097 state = cl_lock_intransit(env, lock);
1098 cfs_list_for_each_entry(slice, &lock->cll_layers, cls_linkage) {
1099 if (slice->cls_ops->clo_use != NULL) {
1100 result = slice->cls_ops->clo_use(env, slice);
1105 LASSERT(result != -ENOSYS);
1107 LASSERTF(lock->cll_state == CLS_INTRANSIT, "Wrong state %d.\n",
1113 if (result == -ESTALE) {
1115 * ESTALE means sublock being cancelled
1116 * at this time, and set lock state to
1117 * be NEW here and ask the caller to repeat.
1120 result = CLO_REPEAT;
1123 /* @atomic means back-off-on-failure. */
1126 rc = cl_unuse_try_internal(env, lock);
1127 /* Vet the results. */
1128 if (rc < 0 && result > 0)
1133 cl_lock_extransit(env, lock, state);
1136 EXPORT_SYMBOL(cl_use_try);
1139 * Helper for cl_enqueue_try() that calls ->clo_enqueue() across all layers
1142 static int cl_enqueue_kick(const struct lu_env *env,
1143 struct cl_lock *lock,
1144 struct cl_io *io, __u32 flags)
1147 const struct cl_lock_slice *slice;
1151 cfs_list_for_each_entry(slice, &lock->cll_layers, cls_linkage) {
1152 if (slice->cls_ops->clo_enqueue != NULL) {
1153 result = slice->cls_ops->clo_enqueue(env,
1159 LASSERT(result != -ENOSYS);
1164 * Tries to enqueue a lock.
1166 * This function is called repeatedly by cl_enqueue() until either lock is
1167 * enqueued, or error occurs. This function does not block waiting for
1168 * networking communication to complete.
1170 * \post ergo(result == 0, lock->cll_state == CLS_ENQUEUED ||
1171 * lock->cll_state == CLS_HELD)
1173 * \see cl_enqueue() cl_lock_operations::clo_enqueue()
1174 * \see cl_lock_state::CLS_ENQUEUED
1176 int cl_enqueue_try(const struct lu_env *env, struct cl_lock *lock,
1177 struct cl_io *io, __u32 flags)
1182 cl_lock_trace(D_DLMTRACE, env, "enqueue lock", lock);
1186 LINVRNT(cl_lock_is_mutexed(lock));
1188 if (lock->cll_error != 0)
1190 switch (lock->cll_state) {
1192 cl_lock_state_set(env, lock, CLS_QUEUING);
1196 result = cl_enqueue_kick(env, lock, io, flags);
1198 cl_lock_state_set(env, lock, CLS_ENQUEUED);
1201 LASSERT(cl_lock_is_intransit(lock));
1205 /* yank lock from the cache. */
1206 result = cl_use_try(env, lock, 0);
1215 * impossible, only held locks with increased
1216 * ->cll_holds can be enqueued, and they cannot be
1221 } while (result == CLO_REPEAT);
1223 cl_lock_error(env, lock, result);
1224 RETURN(result ?: lock->cll_error);
1226 EXPORT_SYMBOL(cl_enqueue_try);
1229 * Cancel the conflicting lock found during previous enqueue.
1231 * \retval 0 conflicting lock has been canceled.
1232 * \retval -ve error code.
1234 int cl_lock_enqueue_wait(const struct lu_env *env,
1235 struct cl_lock *lock,
1238 struct cl_lock *conflict;
1242 LASSERT(cl_lock_is_mutexed(lock));
1243 LASSERT(lock->cll_state == CLS_QUEUING);
1244 LASSERT(lock->cll_conflict != NULL);
1246 conflict = lock->cll_conflict;
1247 lock->cll_conflict = NULL;
1249 cl_lock_mutex_put(env, lock);
1250 LASSERT(cl_lock_nr_mutexed(env) == 0);
1252 cl_lock_mutex_get(env, conflict);
1253 cl_lock_cancel(env, conflict);
1254 cl_lock_delete(env, conflict);
1256 while (conflict->cll_state != CLS_FREEING) {
1257 rc = cl_lock_state_wait(env, conflict);
1261 cl_lock_mutex_put(env, conflict);
1262 lu_ref_del(&conflict->cll_reference, "cancel-wait", lock);
1263 cl_lock_put(env, conflict);
1266 cl_lock_mutex_get(env, lock);
1271 EXPORT_SYMBOL(cl_lock_enqueue_wait);
1273 static int cl_enqueue_locked(const struct lu_env *env, struct cl_lock *lock,
1274 struct cl_io *io, __u32 enqflags)
1280 LINVRNT(cl_lock_is_mutexed(lock));
1281 LINVRNT(cl_lock_invariant(env, lock));
1282 LASSERT(lock->cll_holds > 0);
1284 cl_lock_user_add(env, lock);
1286 result = cl_enqueue_try(env, lock, io, enqflags);
1287 if (result == CLO_WAIT) {
1288 if (lock->cll_conflict != NULL)
1289 result = cl_lock_enqueue_wait(env, lock, 1);
1291 result = cl_lock_state_wait(env, lock);
1298 cl_lock_user_del(env, lock);
1299 cl_lock_error(env, lock, result);
1301 LASSERT(ergo(result == 0 && !(enqflags & CEF_AGL),
1302 lock->cll_state == CLS_ENQUEUED ||
1303 lock->cll_state == CLS_HELD));
1310 * \pre current thread or io owns a hold on lock.
1312 * \post ergo(result == 0, lock->users increased)
1313 * \post ergo(result == 0, lock->cll_state == CLS_ENQUEUED ||
1314 * lock->cll_state == CLS_HELD)
1316 int cl_enqueue(const struct lu_env *env, struct cl_lock *lock,
1317 struct cl_io *io, __u32 enqflags)
1323 cl_lock_lockdep_acquire(env, lock, enqflags);
1324 cl_lock_mutex_get(env, lock);
1325 result = cl_enqueue_locked(env, lock, io, enqflags);
1326 cl_lock_mutex_put(env, lock);
1328 cl_lock_lockdep_release(env, lock);
1329 LASSERT(ergo(result == 0, lock->cll_state == CLS_ENQUEUED ||
1330 lock->cll_state == CLS_HELD));
1333 EXPORT_SYMBOL(cl_enqueue);
1336 * Tries to unlock a lock.
1338 * This function is called repeatedly by cl_unuse() until either lock is
1339 * unlocked, or error occurs.
1340 * cl_unuse_try is a one-shot operation, so it must NOT return CLO_WAIT.
1342 * \pre lock->cll_state == CLS_HELD
1344 * \post ergo(result == 0, lock->cll_state == CLS_CACHED)
1346 * \see cl_unuse() cl_lock_operations::clo_unuse()
1347 * \see cl_lock_state::CLS_CACHED
1349 int cl_unuse_try(const struct lu_env *env, struct cl_lock *lock)
1352 enum cl_lock_state state = CLS_NEW;
1355 cl_lock_trace(D_DLMTRACE, env, "unuse lock", lock);
1357 LASSERT(lock->cll_state == CLS_HELD || lock->cll_state == CLS_ENQUEUED);
1358 if (lock->cll_users > 1) {
1359 cl_lock_user_del(env, lock);
1364 * New lock users (->cll_users) are not protecting unlocking
1365 * from proceeding. From this point, lock eventually reaches
1366 * CLS_CACHED, is reinitialized to CLS_NEW or fails into
1369 state = cl_lock_intransit(env, lock);
1371 result = cl_unuse_try_internal(env, lock);
1372 LASSERT(lock->cll_state == CLS_INTRANSIT);
1373 LASSERT(result != CLO_WAIT);
1374 cl_lock_user_del(env, lock);
1375 if (result == 0 || result == -ESTALE) {
1377 * Return lock back to the cache. This is the only
1378 * place where lock is moved into CLS_CACHED state.
1380 * If one of ->clo_unuse() methods returned -ESTALE, lock
1381 * cannot be placed into cache and has to be
1382 * re-initialized. This happens e.g., when a sub-lock was
1383 * canceled while unlocking was in progress.
1385 if (state == CLS_HELD && result == 0)
1389 cl_lock_extransit(env, lock, state);
1392 * Hide -ESTALE error.
1393 * If the lock is a glimpse lock, and it has multiple
1394 * stripes. Assuming that one of its sublock returned -ENAVAIL,
1395 * and other sublocks are matched write locks. In this case,
1396 * we can't set this lock to error because otherwise some of
1397 * its sublocks may not be canceled. This causes some dirty
1398 * pages won't be written to OSTs. -jay
1402 CERROR("result = %d, this is unlikely!\n", result);
1403 cl_lock_extransit(env, lock, state);
1406 result = result ?: lock->cll_error;
1408 cl_lock_error(env, lock, result);
1411 EXPORT_SYMBOL(cl_unuse_try);
1413 static void cl_unuse_locked(const struct lu_env *env, struct cl_lock *lock)
1418 result = cl_unuse_try(env, lock);
1420 CL_LOCK_DEBUG(D_ERROR, env, lock, "unuse return %d\n", result);
1428 void cl_unuse(const struct lu_env *env, struct cl_lock *lock)
1431 cl_lock_mutex_get(env, lock);
1432 cl_unuse_locked(env, lock);
1433 cl_lock_mutex_put(env, lock);
1434 cl_lock_lockdep_release(env, lock);
1437 EXPORT_SYMBOL(cl_unuse);
1440 * Tries to wait for a lock.
1442 * This function is called repeatedly by cl_wait() until either lock is
1443 * granted, or error occurs. This function does not block waiting for network
1444 * communication to complete.
1446 * \see cl_wait() cl_lock_operations::clo_wait()
1447 * \see cl_lock_state::CLS_HELD
1449 int cl_wait_try(const struct lu_env *env, struct cl_lock *lock)
1451 const struct cl_lock_slice *slice;
1455 cl_lock_trace(D_DLMTRACE, env, "wait lock try", lock);
1457 LINVRNT(cl_lock_is_mutexed(lock));
1458 LINVRNT(cl_lock_invariant(env, lock));
1459 LASSERT(lock->cll_state == CLS_ENQUEUED ||
1460 lock->cll_state == CLS_HELD ||
1461 lock->cll_state == CLS_INTRANSIT);
1462 LASSERT(lock->cll_users > 0);
1463 LASSERT(lock->cll_holds > 0);
1466 if (lock->cll_error != 0)
1469 if (cl_lock_is_intransit(lock)) {
1474 if (lock->cll_state == CLS_HELD)
1479 cfs_list_for_each_entry(slice, &lock->cll_layers, cls_linkage) {
1480 if (slice->cls_ops->clo_wait != NULL) {
1481 result = slice->cls_ops->clo_wait(env, slice);
1486 LASSERT(result != -ENOSYS);
1488 LASSERT(lock->cll_state != CLS_INTRANSIT);
1489 cl_lock_state_set(env, lock, CLS_HELD);
1491 } while (result == CLO_REPEAT);
1492 RETURN(result ?: lock->cll_error);
1494 EXPORT_SYMBOL(cl_wait_try);
1497 * Waits until enqueued lock is granted.
1499 * \pre current thread or io owns a hold on the lock
1500 * \pre ergo(result == 0, lock->cll_state == CLS_ENQUEUED ||
1501 * lock->cll_state == CLS_HELD)
1503 * \post ergo(result == 0, lock->cll_state == CLS_HELD)
1505 int cl_wait(const struct lu_env *env, struct cl_lock *lock)
1510 cl_lock_mutex_get(env, lock);
1512 LINVRNT(cl_lock_invariant(env, lock));
1513 LASSERTF(lock->cll_state == CLS_ENQUEUED || lock->cll_state == CLS_HELD,
1514 "Wrong state %d \n", lock->cll_state);
1515 LASSERT(lock->cll_holds > 0);
1518 result = cl_wait_try(env, lock);
1519 if (result == CLO_WAIT) {
1520 result = cl_lock_state_wait(env, lock);
1527 cl_lock_user_del(env, lock);
1528 cl_lock_error(env, lock, result);
1529 cl_lock_lockdep_release(env, lock);
1531 cl_lock_trace(D_DLMTRACE, env, "wait lock", lock);
1532 cl_lock_mutex_put(env, lock);
1533 LASSERT(ergo(result == 0, lock->cll_state == CLS_HELD));
1536 EXPORT_SYMBOL(cl_wait);
1539 * Executes cl_lock_operations::clo_weigh(), and sums results to estimate lock
1542 unsigned long cl_lock_weigh(const struct lu_env *env, struct cl_lock *lock)
1544 const struct cl_lock_slice *slice;
1545 unsigned long pound;
1546 unsigned long ounce;
1549 LINVRNT(cl_lock_is_mutexed(lock));
1550 LINVRNT(cl_lock_invariant(env, lock));
1553 cfs_list_for_each_entry_reverse(slice, &lock->cll_layers, cls_linkage) {
1554 if (slice->cls_ops->clo_weigh != NULL) {
1555 ounce = slice->cls_ops->clo_weigh(env, slice);
1557 if (pound < ounce) /* over-weight^Wflow */
1563 EXPORT_SYMBOL(cl_lock_weigh);
1566 * Notifies layers that lock description changed.
1568 * The server can grant client a lock different from one that was requested
1569 * (e.g., larger in extent). This method is called when actually granted lock
1570 * description becomes known to let layers to accommodate for changed lock
1573 * \see cl_lock_operations::clo_modify()
1575 int cl_lock_modify(const struct lu_env *env, struct cl_lock *lock,
1576 const struct cl_lock_descr *desc)
1578 const struct cl_lock_slice *slice;
1579 struct cl_object *obj = lock->cll_descr.cld_obj;
1580 struct cl_object_header *hdr = cl_object_header(obj);
1584 cl_lock_trace(D_DLMTRACE, env, "modify lock", lock);
1585 /* don't allow object to change */
1586 LASSERT(obj == desc->cld_obj);
1587 LINVRNT(cl_lock_is_mutexed(lock));
1588 LINVRNT(cl_lock_invariant(env, lock));
1590 cfs_list_for_each_entry_reverse(slice, &lock->cll_layers, cls_linkage) {
1591 if (slice->cls_ops->clo_modify != NULL) {
1592 result = slice->cls_ops->clo_modify(env, slice, desc);
1597 CL_LOCK_DEBUG(D_DLMTRACE, env, lock, " -> "DDESCR"@"DFID"\n",
1598 PDESCR(desc), PFID(lu_object_fid(&desc->cld_obj->co_lu)));
1600 * Just replace description in place. Nothing more is needed for
1601 * now. If locks were indexed according to their extent and/or mode,
1602 * that index would have to be updated here.
1604 cfs_spin_lock(&hdr->coh_lock_guard);
1605 lock->cll_descr = *desc;
1606 cfs_spin_unlock(&hdr->coh_lock_guard);
1609 EXPORT_SYMBOL(cl_lock_modify);
1612 * Initializes lock closure with a given origin.
1614 * \see cl_lock_closure
1616 void cl_lock_closure_init(const struct lu_env *env,
1617 struct cl_lock_closure *closure,
1618 struct cl_lock *origin, int wait)
1620 LINVRNT(cl_lock_is_mutexed(origin));
1621 LINVRNT(cl_lock_invariant(env, origin));
1623 CFS_INIT_LIST_HEAD(&closure->clc_list);
1624 closure->clc_origin = origin;
1625 closure->clc_wait = wait;
1626 closure->clc_nr = 0;
1628 EXPORT_SYMBOL(cl_lock_closure_init);
1631 * Builds a closure of \a lock.
1633 * Building of a closure consists of adding initial lock (\a lock) into it,
1634 * and calling cl_lock_operations::clo_closure() methods of \a lock. These
1635 * methods might call cl_lock_closure_build() recursively again, adding more
1636 * locks to the closure, etc.
1638 * \see cl_lock_closure
1640 int cl_lock_closure_build(const struct lu_env *env, struct cl_lock *lock,
1641 struct cl_lock_closure *closure)
1643 const struct cl_lock_slice *slice;
1647 LINVRNT(cl_lock_is_mutexed(closure->clc_origin));
1648 LINVRNT(cl_lock_invariant(env, closure->clc_origin));
1650 result = cl_lock_enclosure(env, lock, closure);
1652 cfs_list_for_each_entry(slice, &lock->cll_layers, cls_linkage) {
1653 if (slice->cls_ops->clo_closure != NULL) {
1654 result = slice->cls_ops->clo_closure(env, slice,
1662 cl_lock_disclosure(env, closure);
1665 EXPORT_SYMBOL(cl_lock_closure_build);
1668 * Adds new lock to a closure.
1670 * Try-locks \a lock and if succeeded, adds it to the closure (never more than
1671 * once). If try-lock failed, returns CLO_REPEAT, after optionally waiting
1672 * until next try-lock is likely to succeed.
1674 int cl_lock_enclosure(const struct lu_env *env, struct cl_lock *lock,
1675 struct cl_lock_closure *closure)
1679 cl_lock_trace(D_DLMTRACE, env, "enclosure lock", lock);
1680 if (!cl_lock_mutex_try(env, lock)) {
1682 * If lock->cll_inclosure is not empty, lock is already in
1685 if (cfs_list_empty(&lock->cll_inclosure)) {
1686 cl_lock_get_trust(lock);
1687 lu_ref_add(&lock->cll_reference, "closure", closure);
1688 cfs_list_add(&lock->cll_inclosure, &closure->clc_list);
1691 cl_lock_mutex_put(env, lock);
1694 cl_lock_disclosure(env, closure);
1695 if (closure->clc_wait) {
1696 cl_lock_get_trust(lock);
1697 lu_ref_add(&lock->cll_reference, "closure-w", closure);
1698 cl_lock_mutex_put(env, closure->clc_origin);
1700 LASSERT(cl_lock_nr_mutexed(env) == 0);
1701 cl_lock_mutex_get(env, lock);
1702 cl_lock_mutex_put(env, lock);
1704 cl_lock_mutex_get(env, closure->clc_origin);
1705 lu_ref_del(&lock->cll_reference, "closure-w", closure);
1706 cl_lock_put(env, lock);
1708 result = CLO_REPEAT;
1712 EXPORT_SYMBOL(cl_lock_enclosure);
1714 /** Releases mutices of enclosed locks. */
1715 void cl_lock_disclosure(const struct lu_env *env,
1716 struct cl_lock_closure *closure)
1718 struct cl_lock *scan;
1719 struct cl_lock *temp;
1721 cl_lock_trace(D_DLMTRACE, env, "disclosure lock", closure->clc_origin);
1722 cfs_list_for_each_entry_safe(scan, temp, &closure->clc_list,
1724 cfs_list_del_init(&scan->cll_inclosure);
1725 cl_lock_mutex_put(env, scan);
1726 lu_ref_del(&scan->cll_reference, "closure", closure);
1727 cl_lock_put(env, scan);
1730 LASSERT(closure->clc_nr == 0);
1732 EXPORT_SYMBOL(cl_lock_disclosure);
1734 /** Finalizes a closure. */
1735 void cl_lock_closure_fini(struct cl_lock_closure *closure)
1737 LASSERT(closure->clc_nr == 0);
1738 LASSERT(cfs_list_empty(&closure->clc_list));
1740 EXPORT_SYMBOL(cl_lock_closure_fini);
1743 * Destroys this lock. Notifies layers (bottom-to-top) that lock is being
1744 * destroyed, then destroy the lock. If there are holds on the lock, postpone
1745 * destruction until all holds are released. This is called when a decision is
1746 * made to destroy the lock in the future. E.g., when a blocking AST is
1747 * received on it, or fatal communication error happens.
1749 * Caller must have a reference on this lock to prevent a situation, when
1750 * deleted lock lingers in memory for indefinite time, because nobody calls
1751 * cl_lock_put() to finish it.
1753 * \pre atomic_read(&lock->cll_ref) > 0
1754 * \pre ergo(cl_lock_nesting(lock) == CNL_TOP,
1755 * cl_lock_nr_mutexed(env) == 1)
1756 * [i.e., if a top-lock is deleted, mutices of no other locks can be
1757 * held, as deletion of sub-locks might require releasing a top-lock
1760 * \see cl_lock_operations::clo_delete()
1761 * \see cl_lock::cll_holds
1763 void cl_lock_delete(const struct lu_env *env, struct cl_lock *lock)
1765 LINVRNT(cl_lock_is_mutexed(lock));
1766 LINVRNT(cl_lock_invariant(env, lock));
1767 LASSERT(ergo(cl_lock_nesting(lock) == CNL_TOP,
1768 cl_lock_nr_mutexed(env) == 1));
1771 cl_lock_trace(D_DLMTRACE, env, "delete lock", lock);
1772 if (lock->cll_holds == 0)
1773 cl_lock_delete0(env, lock);
1775 lock->cll_flags |= CLF_DOOMED;
1778 EXPORT_SYMBOL(cl_lock_delete);
1781 * Mark lock as irrecoverably failed, and mark it for destruction. This
1782 * happens when, e.g., server fails to grant a lock to us, or networking
1785 * \pre atomic_read(&lock->cll_ref) > 0
1787 * \see clo_lock_delete()
1788 * \see cl_lock::cll_holds
1790 void cl_lock_error(const struct lu_env *env, struct cl_lock *lock, int error)
1792 LINVRNT(cl_lock_is_mutexed(lock));
1793 LINVRNT(cl_lock_invariant(env, lock));
1796 cl_lock_trace(D_DLMTRACE, env, "set lock error", lock);
1797 if (lock->cll_error == 0 && error != 0) {
1798 lock->cll_error = error;
1799 cl_lock_signal(env, lock);
1800 cl_lock_cancel(env, lock);
1801 cl_lock_delete(env, lock);
1805 EXPORT_SYMBOL(cl_lock_error);
1808 * Cancels this lock. Notifies layers
1809 * (bottom-to-top) that lock is being cancelled, then destroy the lock. If
1810 * there are holds on the lock, postpone cancellation until
1811 * all holds are released.
1813 * Cancellation notification is delivered to layers at most once.
1815 * \see cl_lock_operations::clo_cancel()
1816 * \see cl_lock::cll_holds
1818 void cl_lock_cancel(const struct lu_env *env, struct cl_lock *lock)
1820 LINVRNT(cl_lock_is_mutexed(lock));
1821 LINVRNT(cl_lock_invariant(env, lock));
1824 cl_lock_trace(D_DLMTRACE, env, "cancel lock", lock);
1825 if (lock->cll_holds == 0)
1826 cl_lock_cancel0(env, lock);
1828 lock->cll_flags |= CLF_CANCELPEND;
1831 EXPORT_SYMBOL(cl_lock_cancel);
1834 * Finds an existing lock covering given page and optionally different from a
1835 * given \a except lock.
1837 struct cl_lock *cl_lock_at_page(const struct lu_env *env, struct cl_object *obj,
1838 struct cl_page *page, struct cl_lock *except,
1839 int pending, int canceld)
1841 struct cl_object_header *head;
1842 struct cl_lock *scan;
1843 struct cl_lock *lock;
1844 struct cl_lock_descr *need;
1848 head = cl_object_header(obj);
1849 need = &cl_env_info(env)->clt_descr;
1852 need->cld_mode = CLM_READ; /* CLM_READ matches both READ & WRITE, but
1854 need->cld_start = need->cld_end = page->cp_index;
1855 need->cld_enq_flags = 0;
1857 cfs_spin_lock(&head->coh_lock_guard);
1858 /* It is fine to match any group lock since there could be only one
1859 * with a uniq gid and it conflicts with all other lock modes too */
1860 cfs_list_for_each_entry(scan, &head->coh_locks, cll_linkage) {
1861 if (scan != except &&
1862 (scan->cll_descr.cld_mode == CLM_GROUP ||
1863 cl_lock_ext_match(&scan->cll_descr, need)) &&
1864 scan->cll_state >= CLS_HELD &&
1865 scan->cll_state < CLS_FREEING &&
1867 * This check is racy as the lock can be canceled right
1868 * after it is done, but this is fine, because page exists
1871 (canceld || !(scan->cll_flags & CLF_CANCELLED)) &&
1872 (pending || !(scan->cll_flags & CLF_CANCELPEND))) {
1873 /* Don't increase cs_hit here since this
1874 * is just a helper function. */
1875 cl_lock_get_trust(scan);
1880 cfs_spin_unlock(&head->coh_lock_guard);
1883 EXPORT_SYMBOL(cl_lock_at_page);
1886 * Calculate the page offset at the layer of @lock.
1887 * At the time of this writing, @page is top page and @lock is sub lock.
1889 static pgoff_t pgoff_at_lock(struct cl_page *page, struct cl_lock *lock)
1891 struct lu_device_type *dtype;
1892 const struct cl_page_slice *slice;
1894 dtype = lock->cll_descr.cld_obj->co_lu.lo_dev->ld_type;
1895 slice = cl_page_at(page, dtype);
1896 LASSERT(slice != NULL);
1897 return slice->cpl_page->cp_index;
1901 * Check if page @page is covered by an extra lock or discard it.
1903 static int check_and_discard_cb(const struct lu_env *env, struct cl_io *io,
1904 struct cl_page *page, void *cbdata)
1906 struct cl_thread_info *info = cl_env_info(env);
1907 struct cl_lock *lock = cbdata;
1908 pgoff_t index = pgoff_at_lock(page, lock);
1910 if (index >= info->clt_fn_index) {
1911 struct cl_lock *tmp;
1913 /* refresh non-overlapped index */
1914 tmp = cl_lock_at_page(env, lock->cll_descr.cld_obj, page, lock,
1917 /* Cache the first-non-overlapped index so as to skip
1918 * all pages within [index, clt_fn_index). This
1919 * is safe because if tmp lock is canceled, it will
1920 * discard these pages. */
1921 info->clt_fn_index = tmp->cll_descr.cld_end + 1;
1922 if (tmp->cll_descr.cld_end == CL_PAGE_EOF)
1923 info->clt_fn_index = CL_PAGE_EOF;
1924 cl_lock_put(env, tmp);
1925 } else if (cl_page_own(env, io, page) == 0) {
1926 /* discard the page */
1927 cl_page_unmap(env, io, page);
1928 cl_page_discard(env, io, page);
1929 cl_page_disown(env, io, page);
1931 LASSERT(page->cp_state == CPS_FREEING);
1935 info->clt_next_index = index + 1;
1936 return CLP_GANG_OKAY;
1939 static int pageout_cb(const struct lu_env *env, struct cl_io *io,
1940 struct cl_page *page, void *cbdata)
1942 struct cl_thread_info *info = cl_env_info(env);
1943 struct cl_page_list *queue = &info->clt_queue.c2_qin;
1944 struct cl_lock *lock = cbdata;
1945 typeof(cl_page_own) *page_own;
1946 int rc = CLP_GANG_OKAY;
1948 page_own = queue->pl_nr ? cl_page_own_try : cl_page_own;
1949 if (page_own(env, io, page) == 0) {
1950 cl_page_list_add(queue, page);
1951 info->clt_next_index = pgoff_at_lock(page, lock) + 1;
1952 } else if (page->cp_state != CPS_FREEING) {
1953 /* cl_page_own() won't fail unless
1954 * the page is being freed. */
1955 LASSERT(queue->pl_nr != 0);
1956 rc = CLP_GANG_AGAIN;
1963 * Invalidate pages protected by the given lock, sending them out to the
1964 * server first, if necessary.
1966 * This function does the following:
1968 * - collects a list of pages to be invalidated,
1970 * - unmaps them from the user virtual memory,
1972 * - sends dirty pages to the server,
1974 * - waits for transfer completion,
1976 * - discards pages, and throws them out of memory.
1978 * If \a discard is set, pages are discarded without sending them to the
1981 * If error happens on any step, the process continues anyway (the reasoning
1982 * behind this being that lock cancellation cannot be delayed indefinitely).
1984 int cl_lock_page_out(const struct lu_env *env, struct cl_lock *lock,
1987 struct cl_thread_info *info = cl_env_info(env);
1988 struct cl_io *io = &info->clt_io;
1989 struct cl_2queue *queue = &info->clt_queue;
1990 struct cl_lock_descr *descr = &lock->cll_descr;
1991 cl_page_gang_cb_t cb;
1996 LINVRNT(cl_lock_invariant(env, lock));
1999 io->ci_obj = cl_object_top(descr->cld_obj);
2000 result = cl_io_init(env, io, CIT_MISC, io->ci_obj);
2004 cb = descr->cld_mode == CLM_READ ? check_and_discard_cb : pageout_cb;
2005 info->clt_fn_index = info->clt_next_index = descr->cld_start;
2007 cl_2queue_init(queue);
2008 res = cl_page_gang_lookup(env, descr->cld_obj, io,
2009 info->clt_next_index, descr->cld_end,
2011 page_count = queue->c2_qin.pl_nr;
2012 if (page_count > 0) {
2013 /* must be writeback case */
2014 LASSERTF(descr->cld_mode >= CLM_WRITE, "lock mode %s\n",
2015 cl_lock_mode_name(descr->cld_mode));
2017 result = cl_page_list_unmap(env, io, &queue->c2_qin);
2019 long timeout = 600; /* 10 minutes. */
2020 /* for debug purpose, if this request can't be
2021 * finished in 10 minutes, we hope it can
2024 result = cl_io_submit_sync(env, io, CRT_WRITE,
2028 CWARN("Writing %lu pages error: %d\n",
2029 page_count, result);
2031 cl_2queue_discard(env, io, queue);
2032 cl_2queue_disown(env, io, queue);
2033 cl_2queue_fini(env, queue);
2036 if (info->clt_next_index > descr->cld_end)
2039 if (res == CLP_GANG_RESCHED)
2041 } while (res != CLP_GANG_OKAY);
2043 cl_io_fini(env, io);
2046 EXPORT_SYMBOL(cl_lock_page_out);
2049 * Eliminate all locks for a given object.
2051 * Caller has to guarantee that no lock is in active use.
2053 * \param cancel when this is set, cl_locks_prune() cancels locks before
2056 void cl_locks_prune(const struct lu_env *env, struct cl_object *obj, int cancel)
2058 struct cl_object_header *head;
2059 struct cl_lock *lock;
2062 head = cl_object_header(obj);
2064 * If locks are destroyed without cancellation, all pages must be
2065 * already destroyed (as otherwise they will be left unprotected).
2067 LASSERT(ergo(!cancel,
2068 head->coh_tree.rnode == NULL && head->coh_pages == 0));
2070 cfs_spin_lock(&head->coh_lock_guard);
2071 while (!cfs_list_empty(&head->coh_locks)) {
2072 lock = container_of(head->coh_locks.next,
2073 struct cl_lock, cll_linkage);
2074 cl_lock_get_trust(lock);
2075 cfs_spin_unlock(&head->coh_lock_guard);
2076 lu_ref_add(&lock->cll_reference, "prune", cfs_current());
2079 cl_lock_mutex_get(env, lock);
2080 if (lock->cll_state < CLS_FREEING) {
2081 LASSERT(lock->cll_holds == 0);
2082 LASSERT(lock->cll_users <= 1);
2083 if (unlikely(lock->cll_users == 1)) {
2084 struct l_wait_info lwi = { 0 };
2086 cl_lock_mutex_put(env, lock);
2087 l_wait_event(lock->cll_wq,
2088 lock->cll_users == 0,
2094 cl_lock_cancel(env, lock);
2095 cl_lock_delete(env, lock);
2097 cl_lock_mutex_put(env, lock);
2098 lu_ref_del(&lock->cll_reference, "prune", cfs_current());
2099 cl_lock_put(env, lock);
2100 cfs_spin_lock(&head->coh_lock_guard);
2102 cfs_spin_unlock(&head->coh_lock_guard);
2105 EXPORT_SYMBOL(cl_locks_prune);
2107 static struct cl_lock *cl_lock_hold_mutex(const struct lu_env *env,
2108 const struct cl_io *io,
2109 const struct cl_lock_descr *need,
2110 const char *scope, const void *source)
2112 struct cl_lock *lock;
2117 lock = cl_lock_find(env, io, need);
2120 cl_lock_mutex_get(env, lock);
2121 if (lock->cll_state < CLS_FREEING &&
2122 !(lock->cll_flags & CLF_CANCELLED)) {
2123 cl_lock_hold_mod(env, lock, +1);
2124 lu_ref_add(&lock->cll_holders, scope, source);
2125 lu_ref_add(&lock->cll_reference, scope, source);
2128 cl_lock_mutex_put(env, lock);
2129 cl_lock_put(env, lock);
2135 * Returns a lock matching \a need description with a reference and a hold on
2138 * This is much like cl_lock_find(), except that cl_lock_hold() additionally
2139 * guarantees that lock is not in the CLS_FREEING state on return.
2141 struct cl_lock *cl_lock_hold(const struct lu_env *env, const struct cl_io *io,
2142 const struct cl_lock_descr *need,
2143 const char *scope, const void *source)
2145 struct cl_lock *lock;
2149 lock = cl_lock_hold_mutex(env, io, need, scope, source);
2151 cl_lock_mutex_put(env, lock);
2154 EXPORT_SYMBOL(cl_lock_hold);
2157 * Main high-level entry point of cl_lock interface that finds existing or
2158 * enqueues new lock matching given description.
2160 struct cl_lock *cl_lock_request(const struct lu_env *env, struct cl_io *io,
2161 const struct cl_lock_descr *need,
2162 const char *scope, const void *source)
2164 struct cl_lock *lock;
2166 __u32 enqflags = need->cld_enq_flags;
2170 lock = cl_lock_hold_mutex(env, io, need, scope, source);
2174 rc = cl_enqueue_locked(env, lock, io, enqflags);
2176 if (cl_lock_fits_into(env, lock, need, io)) {
2177 if (!(enqflags & CEF_AGL)) {
2178 cl_lock_mutex_put(env, lock);
2179 cl_lock_lockdep_acquire(env, lock,
2185 cl_unuse_locked(env, lock);
2187 cl_lock_trace(D_DLMTRACE, env,
2188 rc <= 0 ? "enqueue failed" : "agl succeed", lock);
2189 cl_lock_hold_release(env, lock, scope, source);
2190 cl_lock_mutex_put(env, lock);
2191 lu_ref_del(&lock->cll_reference, scope, source);
2192 cl_lock_put(env, lock);
2194 LASSERT(enqflags & CEF_AGL);
2196 } else if (rc != 0) {
2202 EXPORT_SYMBOL(cl_lock_request);
2205 * Adds a hold to a known lock.
2207 void cl_lock_hold_add(const struct lu_env *env, struct cl_lock *lock,
2208 const char *scope, const void *source)
2210 LINVRNT(cl_lock_is_mutexed(lock));
2211 LINVRNT(cl_lock_invariant(env, lock));
2212 LASSERT(lock->cll_state != CLS_FREEING);
2215 cl_lock_hold_mod(env, lock, +1);
2217 lu_ref_add(&lock->cll_holders, scope, source);
2218 lu_ref_add(&lock->cll_reference, scope, source);
2221 EXPORT_SYMBOL(cl_lock_hold_add);
2224 * Releases a hold and a reference on a lock, on which caller acquired a
2227 void cl_lock_unhold(const struct lu_env *env, struct cl_lock *lock,
2228 const char *scope, const void *source)
2230 LINVRNT(cl_lock_invariant(env, lock));
2232 cl_lock_hold_release(env, lock, scope, source);
2233 lu_ref_del(&lock->cll_reference, scope, source);
2234 cl_lock_put(env, lock);
2237 EXPORT_SYMBOL(cl_lock_unhold);
2240 * Releases a hold and a reference on a lock, obtained by cl_lock_hold().
2242 void cl_lock_release(const struct lu_env *env, struct cl_lock *lock,
2243 const char *scope, const void *source)
2245 LINVRNT(cl_lock_invariant(env, lock));
2247 cl_lock_trace(D_DLMTRACE, env, "release lock", lock);
2248 cl_lock_mutex_get(env, lock);
2249 cl_lock_hold_release(env, lock, scope, source);
2250 cl_lock_mutex_put(env, lock);
2251 lu_ref_del(&lock->cll_reference, scope, source);
2252 cl_lock_put(env, lock);
2255 EXPORT_SYMBOL(cl_lock_release);
2257 void cl_lock_user_add(const struct lu_env *env, struct cl_lock *lock)
2259 LINVRNT(cl_lock_is_mutexed(lock));
2260 LINVRNT(cl_lock_invariant(env, lock));
2263 cl_lock_used_mod(env, lock, +1);
2266 EXPORT_SYMBOL(cl_lock_user_add);
2268 void cl_lock_user_del(const struct lu_env *env, struct cl_lock *lock)
2270 LINVRNT(cl_lock_is_mutexed(lock));
2271 LINVRNT(cl_lock_invariant(env, lock));
2272 LASSERT(lock->cll_users > 0);
2275 cl_lock_used_mod(env, lock, -1);
2276 if (lock->cll_users == 0)
2277 cfs_waitq_broadcast(&lock->cll_wq);
2280 EXPORT_SYMBOL(cl_lock_user_del);
2282 const char *cl_lock_mode_name(const enum cl_lock_mode mode)
2284 static const char *names[] = {
2285 [CLM_PHANTOM] = "P",
2290 if (0 <= mode && mode < ARRAY_SIZE(names))
2295 EXPORT_SYMBOL(cl_lock_mode_name);
2298 * Prints human readable representation of a lock description.
2300 void cl_lock_descr_print(const struct lu_env *env, void *cookie,
2301 lu_printer_t printer,
2302 const struct cl_lock_descr *descr)
2304 const struct lu_fid *fid;
2306 fid = lu_object_fid(&descr->cld_obj->co_lu);
2307 (*printer)(env, cookie, DDESCR"@"DFID, PDESCR(descr), PFID(fid));
2309 EXPORT_SYMBOL(cl_lock_descr_print);
2312 * Prints human readable representation of \a lock to the \a f.
2314 void cl_lock_print(const struct lu_env *env, void *cookie,
2315 lu_printer_t printer, const struct cl_lock *lock)
2317 const struct cl_lock_slice *slice;
2318 (*printer)(env, cookie, "lock@%p[%d %d %d %d %d %08lx] ",
2319 lock, cfs_atomic_read(&lock->cll_ref),
2320 lock->cll_state, lock->cll_error, lock->cll_holds,
2321 lock->cll_users, lock->cll_flags);
2322 cl_lock_descr_print(env, cookie, printer, &lock->cll_descr);
2323 (*printer)(env, cookie, " {\n");
2325 cfs_list_for_each_entry(slice, &lock->cll_layers, cls_linkage) {
2326 (*printer)(env, cookie, " %s@%p: ",
2327 slice->cls_obj->co_lu.lo_dev->ld_type->ldt_name,
2329 if (slice->cls_ops->clo_print != NULL)
2330 slice->cls_ops->clo_print(env, cookie, printer, slice);
2331 (*printer)(env, cookie, "\n");
2333 (*printer)(env, cookie, "} lock@%p\n", lock);
2335 EXPORT_SYMBOL(cl_lock_print);
2337 int cl_lock_init(void)
2339 return lu_kmem_init(cl_lock_caches);
2342 void cl_lock_fini(void)
2344 lu_kmem_fini(cl_lock_caches);