1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
30 * Use is subject to license terms.
32 * Copyright (c) 2011, 2012, Intel Corporation.
36 * This file is part of Lustre, http://www.lustre.org/
37 * Lustre is a trademark of Sun Microsystems, Inc.
41 * Author: Nikita Danilov <nikita.danilov@sun.com>
44 #define DEBUG_SUBSYSTEM S_CLASS
46 # define EXPORT_SYMTAB
49 #include <obd_class.h>
50 #include <obd_support.h>
51 #include <lustre_fid.h>
52 #include <libcfs/list.h>
53 /* lu_time_global_{init,fini}() */
56 #include <cl_object.h>
57 #include "cl_internal.h"
59 /** Lock class of cl_lock::cll_guard */
60 static cfs_lock_class_key_t cl_lock_guard_class;
61 static cfs_mem_cache_t *cl_lock_kmem;
63 static struct lu_kmem_descr cl_lock_caches[] = {
65 .ckd_cache = &cl_lock_kmem,
66 .ckd_name = "cl_lock_kmem",
67 .ckd_size = sizeof (struct cl_lock)
75 * Basic lock invariant that is maintained at all times. Caller either has a
76 * reference to \a lock, or somehow assures that \a lock cannot be freed.
78 * \see cl_lock_invariant()
80 static int cl_lock_invariant_trusted(const struct lu_env *env,
81 const struct cl_lock *lock)
83 return ergo(lock->cll_state == CLS_FREEING, lock->cll_holds == 0) &&
84 cfs_atomic_read(&lock->cll_ref) >= lock->cll_holds &&
85 lock->cll_holds >= lock->cll_users &&
86 lock->cll_holds >= 0 &&
87 lock->cll_users >= 0 &&
92 * Stronger lock invariant, checking that caller has a reference on a lock.
94 * \see cl_lock_invariant_trusted()
96 static int cl_lock_invariant(const struct lu_env *env,
97 const struct cl_lock *lock)
101 result = cfs_atomic_read(&lock->cll_ref) > 0 &&
102 cl_lock_invariant_trusted(env, lock);
103 if (!result && env != NULL)
104 CL_LOCK_DEBUG(D_ERROR, env, lock, "invariant broken");
109 * Returns lock "nesting": 0 for a top-lock and 1 for a sub-lock.
111 static enum clt_nesting_level cl_lock_nesting(const struct cl_lock *lock)
113 return cl_object_header(lock->cll_descr.cld_obj)->coh_nesting;
117 * Returns a set of counters for this lock, depending on a lock nesting.
119 static struct cl_thread_counters *cl_lock_counters(const struct lu_env *env,
120 const struct cl_lock *lock)
122 struct cl_thread_info *info;
123 enum clt_nesting_level nesting;
125 info = cl_env_info(env);
126 nesting = cl_lock_nesting(lock);
127 LASSERT(nesting < ARRAY_SIZE(info->clt_counters));
128 return &info->clt_counters[nesting];
131 static void cl_lock_trace0(int level, const struct lu_env *env,
132 const char *prefix, const struct cl_lock *lock,
133 const char *func, const int line)
135 struct cl_object_header *h = cl_object_header(lock->cll_descr.cld_obj);
136 CDEBUG(level, "%s: %p@(%d %p %d %d %d %d %d %lx)"
137 "(%p/%d/%d) at %s():%d\n",
138 prefix, lock, cfs_atomic_read(&lock->cll_ref),
139 lock->cll_guarder, lock->cll_depth,
140 lock->cll_state, lock->cll_error, lock->cll_holds,
141 lock->cll_users, lock->cll_flags,
142 env, h->coh_nesting, cl_lock_nr_mutexed(env),
145 #define cl_lock_trace(level, env, prefix, lock) \
146 cl_lock_trace0(level, env, prefix, lock, __FUNCTION__, __LINE__)
148 #define RETIP ((unsigned long)__builtin_return_address(0))
150 #ifdef CONFIG_LOCKDEP
151 static cfs_lock_class_key_t cl_lock_key;
153 static void cl_lock_lockdep_init(struct cl_lock *lock)
155 lockdep_set_class_and_name(lock, &cl_lock_key, "EXT");
158 static void cl_lock_lockdep_acquire(const struct lu_env *env,
159 struct cl_lock *lock, __u32 enqflags)
161 cl_lock_counters(env, lock)->ctc_nr_locks_acquired++;
162 #ifdef HAVE_LOCK_MAP_ACQUIRE
163 lock_map_acquire(&lock->dep_map);
164 #else /* HAVE_LOCK_MAP_ACQUIRE */
165 lock_acquire(&lock->dep_map, !!(enqflags & CEF_ASYNC),
166 /* try: */ 0, lock->cll_descr.cld_mode <= CLM_READ,
167 /* check: */ 2, RETIP);
168 #endif /* HAVE_LOCK_MAP_ACQUIRE */
171 static void cl_lock_lockdep_release(const struct lu_env *env,
172 struct cl_lock *lock)
174 cl_lock_counters(env, lock)->ctc_nr_locks_acquired--;
175 lock_release(&lock->dep_map, 0, RETIP);
178 #else /* !CONFIG_LOCKDEP */
180 static void cl_lock_lockdep_init(struct cl_lock *lock)
182 static void cl_lock_lockdep_acquire(const struct lu_env *env,
183 struct cl_lock *lock, __u32 enqflags)
185 static void cl_lock_lockdep_release(const struct lu_env *env,
186 struct cl_lock *lock)
189 #endif /* !CONFIG_LOCKDEP */
192 * Adds lock slice to the compound lock.
194 * This is called by cl_object_operations::coo_lock_init() methods to add a
195 * per-layer state to the lock. New state is added at the end of
196 * cl_lock::cll_layers list, that is, it is at the bottom of the stack.
198 * \see cl_req_slice_add(), cl_page_slice_add(), cl_io_slice_add()
200 void cl_lock_slice_add(struct cl_lock *lock, struct cl_lock_slice *slice,
201 struct cl_object *obj,
202 const struct cl_lock_operations *ops)
205 slice->cls_lock = lock;
206 cfs_list_add_tail(&slice->cls_linkage, &lock->cll_layers);
207 slice->cls_obj = obj;
208 slice->cls_ops = ops;
211 EXPORT_SYMBOL(cl_lock_slice_add);
214 * Returns true iff a lock with the mode \a has provides at least the same
215 * guarantees as a lock with the mode \a need.
217 int cl_lock_mode_match(enum cl_lock_mode has, enum cl_lock_mode need)
219 LINVRNT(need == CLM_READ || need == CLM_WRITE ||
220 need == CLM_PHANTOM || need == CLM_GROUP);
221 LINVRNT(has == CLM_READ || has == CLM_WRITE ||
222 has == CLM_PHANTOM || has == CLM_GROUP);
223 CLASSERT(CLM_PHANTOM < CLM_READ);
224 CLASSERT(CLM_READ < CLM_WRITE);
225 CLASSERT(CLM_WRITE < CLM_GROUP);
227 if (has != CLM_GROUP)
232 EXPORT_SYMBOL(cl_lock_mode_match);
235 * Returns true iff extent portions of lock descriptions match.
237 int cl_lock_ext_match(const struct cl_lock_descr *has,
238 const struct cl_lock_descr *need)
241 has->cld_start <= need->cld_start &&
242 has->cld_end >= need->cld_end &&
243 cl_lock_mode_match(has->cld_mode, need->cld_mode) &&
244 (has->cld_mode != CLM_GROUP || has->cld_gid == need->cld_gid);
246 EXPORT_SYMBOL(cl_lock_ext_match);
249 * Returns true iff a lock with the description \a has provides at least the
250 * same guarantees as a lock with the description \a need.
252 int cl_lock_descr_match(const struct cl_lock_descr *has,
253 const struct cl_lock_descr *need)
256 cl_object_same(has->cld_obj, need->cld_obj) &&
257 cl_lock_ext_match(has, need);
259 EXPORT_SYMBOL(cl_lock_descr_match);
261 static void cl_lock_free(const struct lu_env *env, struct cl_lock *lock)
263 struct cl_object *obj = lock->cll_descr.cld_obj;
265 LINVRNT(!cl_lock_is_mutexed(lock));
268 cl_lock_trace(D_DLMTRACE, env, "free lock", lock);
270 while (!cfs_list_empty(&lock->cll_layers)) {
271 struct cl_lock_slice *slice;
273 slice = cfs_list_entry(lock->cll_layers.next,
274 struct cl_lock_slice, cls_linkage);
275 cfs_list_del_init(lock->cll_layers.next);
276 slice->cls_ops->clo_fini(env, slice);
278 cfs_atomic_dec(&cl_object_site(obj)->cs_locks.cs_total);
279 cfs_atomic_dec(&cl_object_site(obj)->cs_locks_state[lock->cll_state]);
280 lu_object_ref_del_at(&obj->co_lu, lock->cll_obj_ref, "cl_lock", lock);
281 cl_object_put(env, obj);
282 lu_ref_fini(&lock->cll_reference);
283 lu_ref_fini(&lock->cll_holders);
284 cfs_mutex_destroy(&lock->cll_guard);
285 OBD_SLAB_FREE_PTR(lock, cl_lock_kmem);
290 * Releases a reference on a lock.
292 * When last reference is released, lock is returned to the cache, unless it
293 * is in cl_lock_state::CLS_FREEING state, in which case it is destroyed
296 * \see cl_object_put(), cl_page_put()
298 void cl_lock_put(const struct lu_env *env, struct cl_lock *lock)
300 struct cl_object *obj;
301 struct cl_object_header *head;
302 struct cl_site *site;
304 LINVRNT(cl_lock_invariant(env, lock));
306 obj = lock->cll_descr.cld_obj;
307 LINVRNT(obj != NULL);
308 head = cl_object_header(obj);
309 site = cl_object_site(obj);
311 CDEBUG(D_TRACE, "releasing reference: %d %p %lu\n",
312 cfs_atomic_read(&lock->cll_ref), lock, RETIP);
314 if (cfs_atomic_dec_and_test(&lock->cll_ref)) {
315 if (lock->cll_state == CLS_FREEING) {
316 LASSERT(cfs_list_empty(&lock->cll_linkage));
317 cl_lock_free(env, lock);
319 cfs_atomic_dec(&site->cs_locks.cs_busy);
323 EXPORT_SYMBOL(cl_lock_put);
326 * Acquires an additional reference to a lock.
328 * This can be called only by caller already possessing a reference to \a
331 * \see cl_object_get(), cl_page_get()
333 void cl_lock_get(struct cl_lock *lock)
335 LINVRNT(cl_lock_invariant(NULL, lock));
336 CDEBUG(D_TRACE, "acquiring reference: %d %p %lu\n",
337 cfs_atomic_read(&lock->cll_ref), lock, RETIP);
338 cfs_atomic_inc(&lock->cll_ref);
340 EXPORT_SYMBOL(cl_lock_get);
343 * Acquires a reference to a lock.
345 * This is much like cl_lock_get(), except that this function can be used to
346 * acquire initial reference to the cached lock. Caller has to deal with all
347 * possible races. Use with care!
349 * \see cl_page_get_trust()
351 void cl_lock_get_trust(struct cl_lock *lock)
353 struct cl_site *site = cl_object_site(lock->cll_descr.cld_obj);
355 CDEBUG(D_TRACE, "acquiring trusted reference: %d %p %lu\n",
356 cfs_atomic_read(&lock->cll_ref), lock, RETIP);
357 if (cfs_atomic_inc_return(&lock->cll_ref) == 1)
358 cfs_atomic_inc(&site->cs_locks.cs_busy);
360 EXPORT_SYMBOL(cl_lock_get_trust);
363 * Helper function destroying the lock that wasn't completely initialized.
365 * Other threads can acquire references to the top-lock through its
366 * sub-locks. Hence, it cannot be cl_lock_free()-ed immediately.
368 static void cl_lock_finish(const struct lu_env *env, struct cl_lock *lock)
370 cl_lock_mutex_get(env, lock);
371 cl_lock_cancel(env, lock);
372 cl_lock_delete(env, lock);
373 cl_lock_mutex_put(env, lock);
374 cl_lock_put(env, lock);
377 static struct cl_lock *cl_lock_alloc(const struct lu_env *env,
378 struct cl_object *obj,
379 const struct cl_io *io,
380 const struct cl_lock_descr *descr)
382 struct cl_lock *lock;
383 struct lu_object_header *head;
384 struct cl_site *site = cl_object_site(obj);
387 OBD_SLAB_ALLOC_PTR_GFP(lock, cl_lock_kmem, CFS_ALLOC_IO);
389 cfs_atomic_set(&lock->cll_ref, 1);
390 lock->cll_descr = *descr;
391 lock->cll_state = CLS_NEW;
393 lock->cll_obj_ref = lu_object_ref_add(&obj->co_lu,
395 CFS_INIT_LIST_HEAD(&lock->cll_layers);
396 CFS_INIT_LIST_HEAD(&lock->cll_linkage);
397 CFS_INIT_LIST_HEAD(&lock->cll_inclosure);
398 lu_ref_init(&lock->cll_reference);
399 lu_ref_init(&lock->cll_holders);
400 cfs_mutex_init(&lock->cll_guard);
401 cfs_lockdep_set_class(&lock->cll_guard, &cl_lock_guard_class);
402 cfs_waitq_init(&lock->cll_wq);
403 head = obj->co_lu.lo_header;
404 cfs_atomic_inc(&site->cs_locks_state[CLS_NEW]);
405 cfs_atomic_inc(&site->cs_locks.cs_total);
406 cfs_atomic_inc(&site->cs_locks.cs_created);
407 cl_lock_lockdep_init(lock);
408 cfs_list_for_each_entry(obj, &head->loh_layers,
412 err = obj->co_ops->coo_lock_init(env, obj, lock, io);
414 cl_lock_finish(env, lock);
420 lock = ERR_PTR(-ENOMEM);
425 * Transfer the lock into INTRANSIT state and return the original state.
427 * \pre state: CLS_CACHED, CLS_HELD or CLS_ENQUEUED
428 * \post state: CLS_INTRANSIT
431 enum cl_lock_state cl_lock_intransit(const struct lu_env *env,
432 struct cl_lock *lock)
434 enum cl_lock_state state = lock->cll_state;
436 LASSERT(cl_lock_is_mutexed(lock));
437 LASSERT(state != CLS_INTRANSIT);
438 LASSERTF(state >= CLS_ENQUEUED && state <= CLS_CACHED,
439 "Malformed lock state %d.\n", state);
441 cl_lock_state_set(env, lock, CLS_INTRANSIT);
442 lock->cll_intransit_owner = cfs_current();
443 cl_lock_hold_add(env, lock, "intransit", cfs_current());
446 EXPORT_SYMBOL(cl_lock_intransit);
449 * Exit the intransit state and restore the lock state to the original state
451 void cl_lock_extransit(const struct lu_env *env, struct cl_lock *lock,
452 enum cl_lock_state state)
454 LASSERT(cl_lock_is_mutexed(lock));
455 LASSERT(lock->cll_state == CLS_INTRANSIT);
456 LASSERT(state != CLS_INTRANSIT);
457 LASSERT(lock->cll_intransit_owner == cfs_current());
459 lock->cll_intransit_owner = NULL;
460 cl_lock_state_set(env, lock, state);
461 cl_lock_unhold(env, lock, "intransit", cfs_current());
463 EXPORT_SYMBOL(cl_lock_extransit);
466 * Checking whether the lock is intransit state
468 int cl_lock_is_intransit(struct cl_lock *lock)
470 LASSERT(cl_lock_is_mutexed(lock));
471 return lock->cll_state == CLS_INTRANSIT &&
472 lock->cll_intransit_owner != cfs_current();
474 EXPORT_SYMBOL(cl_lock_is_intransit);
476 * Returns true iff lock is "suitable" for given io. E.g., locks acquired by
477 * truncate and O_APPEND cannot be reused for read/non-append-write, as they
478 * cover multiple stripes and can trigger cascading timeouts.
480 static int cl_lock_fits_into(const struct lu_env *env,
481 const struct cl_lock *lock,
482 const struct cl_lock_descr *need,
483 const struct cl_io *io)
485 const struct cl_lock_slice *slice;
487 LINVRNT(cl_lock_invariant_trusted(env, lock));
489 cfs_list_for_each_entry(slice, &lock->cll_layers, cls_linkage) {
490 if (slice->cls_ops->clo_fits_into != NULL &&
491 !slice->cls_ops->clo_fits_into(env, slice, need, io))
497 static struct cl_lock *cl_lock_lookup(const struct lu_env *env,
498 struct cl_object *obj,
499 const struct cl_io *io,
500 const struct cl_lock_descr *need)
502 struct cl_lock *lock;
503 struct cl_object_header *head;
504 struct cl_site *site;
508 head = cl_object_header(obj);
509 site = cl_object_site(obj);
510 LINVRNT_SPIN_LOCKED(&head->coh_lock_guard);
511 cfs_atomic_inc(&site->cs_locks.cs_lookup);
512 cfs_list_for_each_entry(lock, &head->coh_locks, cll_linkage) {
515 matched = cl_lock_ext_match(&lock->cll_descr, need) &&
516 lock->cll_state < CLS_FREEING &&
517 lock->cll_error == 0 &&
518 !(lock->cll_flags & CLF_CANCELLED) &&
519 cl_lock_fits_into(env, lock, need, io);
520 CDEBUG(D_DLMTRACE, "has: "DDESCR"(%d) need: "DDESCR": %d\n",
521 PDESCR(&lock->cll_descr), lock->cll_state, PDESCR(need),
524 cl_lock_get_trust(lock);
525 cfs_atomic_inc(&cl_object_site(obj)->cs_locks.cs_hit);
533 * Returns a lock matching description \a need.
535 * This is the main entry point into the cl_lock caching interface. First, a
536 * cache (implemented as a per-object linked list) is consulted. If lock is
537 * found there, it is returned immediately. Otherwise new lock is allocated
538 * and returned. In any case, additional reference to lock is acquired.
540 * \see cl_object_find(), cl_page_find()
542 static struct cl_lock *cl_lock_find(const struct lu_env *env,
543 const struct cl_io *io,
544 const struct cl_lock_descr *need)
546 struct cl_object_header *head;
547 struct cl_object *obj;
548 struct cl_lock *lock;
549 struct cl_site *site;
554 head = cl_object_header(obj);
555 site = cl_object_site(obj);
557 cfs_spin_lock(&head->coh_lock_guard);
558 lock = cl_lock_lookup(env, obj, io, need);
559 cfs_spin_unlock(&head->coh_lock_guard);
562 lock = cl_lock_alloc(env, obj, io, need);
564 struct cl_lock *ghost;
566 cfs_spin_lock(&head->coh_lock_guard);
567 ghost = cl_lock_lookup(env, obj, io, need);
569 cfs_list_add_tail(&lock->cll_linkage,
571 cfs_spin_unlock(&head->coh_lock_guard);
572 cfs_atomic_inc(&site->cs_locks.cs_busy);
574 cfs_spin_unlock(&head->coh_lock_guard);
576 * Other threads can acquire references to the
577 * top-lock through its sub-locks. Hence, it
578 * cannot be cl_lock_free()-ed immediately.
580 cl_lock_finish(env, lock);
589 * Returns existing lock matching given description. This is similar to
590 * cl_lock_find() except that no new lock is created, and returned lock is
591 * guaranteed to be in enum cl_lock_state::CLS_HELD state.
593 struct cl_lock *cl_lock_peek(const struct lu_env *env, const struct cl_io *io,
594 const struct cl_lock_descr *need,
595 const char *scope, const void *source)
597 struct cl_object_header *head;
598 struct cl_object *obj;
599 struct cl_lock *lock;
602 head = cl_object_header(obj);
604 cfs_spin_lock(&head->coh_lock_guard);
605 lock = cl_lock_lookup(env, obj, io, need);
606 cfs_spin_unlock(&head->coh_lock_guard);
611 cl_lock_mutex_get(env, lock);
612 if (lock->cll_state == CLS_INTRANSIT)
613 cl_lock_state_wait(env, lock); /* Don't care return value. */
614 cl_lock_hold_add(env, lock, scope, source);
615 cl_lock_user_add(env, lock);
616 if (lock->cll_state == CLS_CACHED)
617 cl_use_try(env, lock, 1);
618 if (lock->cll_state == CLS_HELD) {
619 cl_lock_mutex_put(env, lock);
620 cl_lock_lockdep_acquire(env, lock, 0);
621 cl_lock_put(env, lock);
623 cl_unuse_try(env, lock);
624 cl_lock_unhold(env, lock, scope, source);
625 cl_lock_mutex_put(env, lock);
626 cl_lock_put(env, lock);
632 EXPORT_SYMBOL(cl_lock_peek);
635 * Returns a slice within a lock, corresponding to the given layer in the
640 const struct cl_lock_slice *cl_lock_at(const struct cl_lock *lock,
641 const struct lu_device_type *dtype)
643 const struct cl_lock_slice *slice;
645 LINVRNT(cl_lock_invariant_trusted(NULL, lock));
648 cfs_list_for_each_entry(slice, &lock->cll_layers, cls_linkage) {
649 if (slice->cls_obj->co_lu.lo_dev->ld_type == dtype)
654 EXPORT_SYMBOL(cl_lock_at);
656 static void cl_lock_mutex_tail(const struct lu_env *env, struct cl_lock *lock)
658 struct cl_thread_counters *counters;
660 counters = cl_lock_counters(env, lock);
662 counters->ctc_nr_locks_locked++;
663 lu_ref_add(&counters->ctc_locks_locked, "cll_guard", lock);
664 cl_lock_trace(D_TRACE, env, "got mutex", lock);
668 * Locks cl_lock object.
670 * This is used to manipulate cl_lock fields, and to serialize state
671 * transitions in the lock state machine.
673 * \post cl_lock_is_mutexed(lock)
675 * \see cl_lock_mutex_put()
677 void cl_lock_mutex_get(const struct lu_env *env, struct cl_lock *lock)
679 LINVRNT(cl_lock_invariant(env, lock));
681 if (lock->cll_guarder == cfs_current()) {
682 LINVRNT(cl_lock_is_mutexed(lock));
683 LINVRNT(lock->cll_depth > 0);
685 struct cl_object_header *hdr;
686 struct cl_thread_info *info;
689 LINVRNT(lock->cll_guarder != cfs_current());
690 hdr = cl_object_header(lock->cll_descr.cld_obj);
692 * Check that mutices are taken in the bottom-to-top order.
694 info = cl_env_info(env);
695 for (i = 0; i < hdr->coh_nesting; ++i)
696 LASSERT(info->clt_counters[i].ctc_nr_locks_locked == 0);
697 cfs_mutex_lock_nested(&lock->cll_guard, hdr->coh_nesting);
698 lock->cll_guarder = cfs_current();
699 LINVRNT(lock->cll_depth == 0);
701 cl_lock_mutex_tail(env, lock);
703 EXPORT_SYMBOL(cl_lock_mutex_get);
706 * Try-locks cl_lock object.
708 * \retval 0 \a lock was successfully locked
710 * \retval -EBUSY \a lock cannot be locked right now
712 * \post ergo(result == 0, cl_lock_is_mutexed(lock))
714 * \see cl_lock_mutex_get()
716 int cl_lock_mutex_try(const struct lu_env *env, struct cl_lock *lock)
720 LINVRNT(cl_lock_invariant_trusted(env, lock));
724 if (lock->cll_guarder == cfs_current()) {
725 LINVRNT(lock->cll_depth > 0);
726 cl_lock_mutex_tail(env, lock);
727 } else if (cfs_mutex_trylock(&lock->cll_guard)) {
728 LINVRNT(lock->cll_depth == 0);
729 lock->cll_guarder = cfs_current();
730 cl_lock_mutex_tail(env, lock);
735 EXPORT_SYMBOL(cl_lock_mutex_try);
738 {* Unlocks cl_lock object.
740 * \pre cl_lock_is_mutexed(lock)
742 * \see cl_lock_mutex_get()
744 void cl_lock_mutex_put(const struct lu_env *env, struct cl_lock *lock)
746 struct cl_thread_counters *counters;
748 LINVRNT(cl_lock_invariant(env, lock));
749 LINVRNT(cl_lock_is_mutexed(lock));
750 LINVRNT(lock->cll_guarder == cfs_current());
751 LINVRNT(lock->cll_depth > 0);
753 counters = cl_lock_counters(env, lock);
754 LINVRNT(counters->ctc_nr_locks_locked > 0);
756 cl_lock_trace(D_TRACE, env, "put mutex", lock);
757 lu_ref_del(&counters->ctc_locks_locked, "cll_guard", lock);
758 counters->ctc_nr_locks_locked--;
759 if (--lock->cll_depth == 0) {
760 lock->cll_guarder = NULL;
761 cfs_mutex_unlock(&lock->cll_guard);
764 EXPORT_SYMBOL(cl_lock_mutex_put);
767 * Returns true iff lock's mutex is owned by the current thread.
769 int cl_lock_is_mutexed(struct cl_lock *lock)
771 return lock->cll_guarder == cfs_current();
773 EXPORT_SYMBOL(cl_lock_is_mutexed);
776 * Returns number of cl_lock mutices held by the current thread (environment).
778 int cl_lock_nr_mutexed(const struct lu_env *env)
780 struct cl_thread_info *info;
785 * NOTE: if summation across all nesting levels (currently 2) proves
786 * too expensive, a summary counter can be added to
787 * struct cl_thread_info.
789 info = cl_env_info(env);
790 for (i = 0, locked = 0; i < ARRAY_SIZE(info->clt_counters); ++i)
791 locked += info->clt_counters[i].ctc_nr_locks_locked;
794 EXPORT_SYMBOL(cl_lock_nr_mutexed);
796 static void cl_lock_cancel0(const struct lu_env *env, struct cl_lock *lock)
798 LINVRNT(cl_lock_is_mutexed(lock));
799 LINVRNT(cl_lock_invariant(env, lock));
801 if (!(lock->cll_flags & CLF_CANCELLED)) {
802 const struct cl_lock_slice *slice;
804 lock->cll_flags |= CLF_CANCELLED;
805 cfs_list_for_each_entry_reverse(slice, &lock->cll_layers,
807 if (slice->cls_ops->clo_cancel != NULL)
808 slice->cls_ops->clo_cancel(env, slice);
814 static void cl_lock_delete0(const struct lu_env *env, struct cl_lock *lock)
816 struct cl_object_header *head;
817 const struct cl_lock_slice *slice;
819 LINVRNT(cl_lock_is_mutexed(lock));
820 LINVRNT(cl_lock_invariant(env, lock));
823 if (lock->cll_state < CLS_FREEING) {
824 LASSERT(lock->cll_state != CLS_INTRANSIT);
825 cl_lock_state_set(env, lock, CLS_FREEING);
827 head = cl_object_header(lock->cll_descr.cld_obj);
829 cfs_spin_lock(&head->coh_lock_guard);
830 cfs_list_del_init(&lock->cll_linkage);
832 cfs_spin_unlock(&head->coh_lock_guard);
834 * From now on, no new references to this lock can be acquired
835 * by cl_lock_lookup().
837 cfs_list_for_each_entry_reverse(slice, &lock->cll_layers,
839 if (slice->cls_ops->clo_delete != NULL)
840 slice->cls_ops->clo_delete(env, slice);
843 * From now on, no new references to this lock can be acquired
844 * by layer-specific means (like a pointer from struct
845 * ldlm_lock in osc, or a pointer from top-lock to sub-lock in
848 * Lock will be finally freed in cl_lock_put() when last of
849 * existing references goes away.
856 * Mod(ifie)s cl_lock::cll_holds counter for a given lock. Also, for a
857 * top-lock (nesting == 0) accounts for this modification in the per-thread
858 * debugging counters. Sub-lock holds can be released by a thread different
859 * from one that acquired it.
861 static void cl_lock_hold_mod(const struct lu_env *env, struct cl_lock *lock,
864 struct cl_thread_counters *counters;
865 enum clt_nesting_level nesting;
867 lock->cll_holds += delta;
868 nesting = cl_lock_nesting(lock);
869 if (nesting == CNL_TOP) {
870 counters = &cl_env_info(env)->clt_counters[CNL_TOP];
871 counters->ctc_nr_held += delta;
872 LASSERT(counters->ctc_nr_held >= 0);
877 * Mod(ifie)s cl_lock::cll_users counter for a given lock. See
878 * cl_lock_hold_mod() for the explanation of the debugging code.
880 static void cl_lock_used_mod(const struct lu_env *env, struct cl_lock *lock,
883 struct cl_thread_counters *counters;
884 enum clt_nesting_level nesting;
886 lock->cll_users += delta;
887 nesting = cl_lock_nesting(lock);
888 if (nesting == CNL_TOP) {
889 counters = &cl_env_info(env)->clt_counters[CNL_TOP];
890 counters->ctc_nr_used += delta;
891 LASSERT(counters->ctc_nr_used >= 0);
895 static void cl_lock_hold_release(const struct lu_env *env, struct cl_lock *lock,
896 const char *scope, const void *source)
898 LINVRNT(cl_lock_is_mutexed(lock));
899 LINVRNT(cl_lock_invariant(env, lock));
900 LASSERT(lock->cll_holds > 0);
903 cl_lock_trace(D_DLMTRACE, env, "hold release lock", lock);
904 lu_ref_del(&lock->cll_holders, scope, source);
905 cl_lock_hold_mod(env, lock, -1);
906 if (lock->cll_holds == 0) {
907 CL_LOCK_ASSERT(lock->cll_state != CLS_HELD, env, lock);
908 if (lock->cll_descr.cld_mode == CLM_PHANTOM ||
909 lock->cll_descr.cld_mode == CLM_GROUP ||
910 lock->cll_state != CLS_CACHED)
912 * If lock is still phantom or grouplock when user is
913 * done with it---destroy the lock.
915 lock->cll_flags |= CLF_CANCELPEND|CLF_DOOMED;
916 if (lock->cll_flags & CLF_CANCELPEND) {
917 lock->cll_flags &= ~CLF_CANCELPEND;
918 cl_lock_cancel0(env, lock);
920 if (lock->cll_flags & CLF_DOOMED) {
921 /* no longer doomed: it's dead... Jim. */
922 lock->cll_flags &= ~CLF_DOOMED;
923 cl_lock_delete0(env, lock);
931 * Waits until lock state is changed.
933 * This function is called with cl_lock mutex locked, atomically releases
934 * mutex and goes to sleep, waiting for a lock state change (signaled by
935 * cl_lock_signal()), and re-acquires the mutex before return.
937 * This function is used to wait until lock state machine makes some progress
938 * and to emulate synchronous operations on top of asynchronous lock
941 * \retval -EINTR wait was interrupted
943 * \retval 0 wait wasn't interrupted
945 * \pre cl_lock_is_mutexed(lock)
947 * \see cl_lock_signal()
949 int cl_lock_state_wait(const struct lu_env *env, struct cl_lock *lock)
951 cfs_waitlink_t waiter;
952 cfs_sigset_t blocked;
956 LINVRNT(cl_lock_is_mutexed(lock));
957 LINVRNT(cl_lock_invariant(env, lock));
958 LASSERT(lock->cll_depth == 1);
959 LASSERT(lock->cll_state != CLS_FREEING); /* too late to wait */
961 cl_lock_trace(D_DLMTRACE, env, "state wait lock", lock);
962 result = lock->cll_error;
964 /* To avoid being interrupted by the 'non-fatal' signals
965 * (SIGCHLD, for instance), we'd block them temporarily.
967 blocked = cfs_block_sigsinv(LUSTRE_FATAL_SIGS);
969 cfs_waitlink_init(&waiter);
970 cfs_waitq_add(&lock->cll_wq, &waiter);
971 cfs_set_current_state(CFS_TASK_INTERRUPTIBLE);
972 cl_lock_mutex_put(env, lock);
974 LASSERT(cl_lock_nr_mutexed(env) == 0);
977 if (likely(!OBD_FAIL_CHECK(OBD_FAIL_LOCK_STATE_WAIT_INTR))) {
978 cfs_waitq_wait(&waiter, CFS_TASK_INTERRUPTIBLE);
979 if (!cfs_signal_pending())
983 cl_lock_mutex_get(env, lock);
984 cfs_set_current_state(CFS_TASK_RUNNING);
985 cfs_waitq_del(&lock->cll_wq, &waiter);
987 /* Restore old blocked signals */
988 cfs_restore_sigs(blocked);
992 EXPORT_SYMBOL(cl_lock_state_wait);
994 static void cl_lock_state_signal(const struct lu_env *env, struct cl_lock *lock,
995 enum cl_lock_state state)
997 const struct cl_lock_slice *slice;
1000 LINVRNT(cl_lock_is_mutexed(lock));
1001 LINVRNT(cl_lock_invariant(env, lock));
1003 cfs_list_for_each_entry(slice, &lock->cll_layers, cls_linkage)
1004 if (slice->cls_ops->clo_state != NULL)
1005 slice->cls_ops->clo_state(env, slice, state);
1006 cfs_waitq_broadcast(&lock->cll_wq);
1011 * Notifies waiters that lock state changed.
1013 * Wakes up all waiters sleeping in cl_lock_state_wait(), also notifies all
1014 * layers about state change by calling cl_lock_operations::clo_state()
1017 void cl_lock_signal(const struct lu_env *env, struct cl_lock *lock)
1020 cl_lock_trace(D_DLMTRACE, env, "state signal lock", lock);
1021 cl_lock_state_signal(env, lock, lock->cll_state);
1024 EXPORT_SYMBOL(cl_lock_signal);
1027 * Changes lock state.
1029 * This function is invoked to notify layers that lock state changed, possible
1030 * as a result of an asynchronous event such as call-back reception.
1032 * \post lock->cll_state == state
1034 * \see cl_lock_operations::clo_state()
1036 void cl_lock_state_set(const struct lu_env *env, struct cl_lock *lock,
1037 enum cl_lock_state state)
1039 struct cl_site *site = cl_object_site(lock->cll_descr.cld_obj);
1042 LASSERT(lock->cll_state <= state ||
1043 (lock->cll_state == CLS_CACHED &&
1044 (state == CLS_HELD || /* lock found in cache */
1045 state == CLS_NEW || /* sub-lock canceled */
1046 state == CLS_INTRANSIT)) ||
1047 /* lock is in transit state */
1048 lock->cll_state == CLS_INTRANSIT);
1050 if (lock->cll_state != state) {
1051 cfs_atomic_dec(&site->cs_locks_state[lock->cll_state]);
1052 cfs_atomic_inc(&site->cs_locks_state[state]);
1054 cl_lock_state_signal(env, lock, state);
1055 lock->cll_state = state;
1059 EXPORT_SYMBOL(cl_lock_state_set);
1061 static int cl_unuse_try_internal(const struct lu_env *env, struct cl_lock *lock)
1063 const struct cl_lock_slice *slice;
1069 LINVRNT(cl_lock_is_mutexed(lock));
1070 LINVRNT(cl_lock_invariant(env, lock));
1071 LASSERT(lock->cll_state == CLS_INTRANSIT);
1074 cfs_list_for_each_entry_reverse(slice, &lock->cll_layers,
1076 if (slice->cls_ops->clo_unuse != NULL) {
1077 result = slice->cls_ops->clo_unuse(env, slice);
1082 LASSERT(result != -ENOSYS);
1083 } while (result == CLO_REPEAT);
1089 * Yanks lock from the cache (cl_lock_state::CLS_CACHED state) by calling
1090 * cl_lock_operations::clo_use() top-to-bottom to notify layers.
1091 * @atomic = 1, it must unuse the lock to recovery the lock to keep the
1092 * use process atomic
1094 int cl_use_try(const struct lu_env *env, struct cl_lock *lock, int atomic)
1096 const struct cl_lock_slice *slice;
1098 enum cl_lock_state state;
1101 cl_lock_trace(D_DLMTRACE, env, "use lock", lock);
1103 LASSERT(lock->cll_state == CLS_CACHED);
1104 if (lock->cll_error)
1105 RETURN(lock->cll_error);
1108 state = cl_lock_intransit(env, lock);
1109 cfs_list_for_each_entry(slice, &lock->cll_layers, cls_linkage) {
1110 if (slice->cls_ops->clo_use != NULL) {
1111 result = slice->cls_ops->clo_use(env, slice);
1116 LASSERT(result != -ENOSYS);
1118 LASSERTF(lock->cll_state == CLS_INTRANSIT, "Wrong state %d.\n",
1124 if (result == -ESTALE) {
1126 * ESTALE means sublock being cancelled
1127 * at this time, and set lock state to
1128 * be NEW here and ask the caller to repeat.
1131 result = CLO_REPEAT;
1134 /* @atomic means back-off-on-failure. */
1137 rc = cl_unuse_try_internal(env, lock);
1138 /* Vet the results. */
1139 if (rc < 0 && result > 0)
1144 cl_lock_extransit(env, lock, state);
1147 EXPORT_SYMBOL(cl_use_try);
1150 * Helper for cl_enqueue_try() that calls ->clo_enqueue() across all layers
1153 static int cl_enqueue_kick(const struct lu_env *env,
1154 struct cl_lock *lock,
1155 struct cl_io *io, __u32 flags)
1158 const struct cl_lock_slice *slice;
1162 cfs_list_for_each_entry(slice, &lock->cll_layers, cls_linkage) {
1163 if (slice->cls_ops->clo_enqueue != NULL) {
1164 result = slice->cls_ops->clo_enqueue(env,
1170 LASSERT(result != -ENOSYS);
1175 * Tries to enqueue a lock.
1177 * This function is called repeatedly by cl_enqueue() until either lock is
1178 * enqueued, or error occurs. This function does not block waiting for
1179 * networking communication to complete.
1181 * \post ergo(result == 0, lock->cll_state == CLS_ENQUEUED ||
1182 * lock->cll_state == CLS_HELD)
1184 * \see cl_enqueue() cl_lock_operations::clo_enqueue()
1185 * \see cl_lock_state::CLS_ENQUEUED
1187 int cl_enqueue_try(const struct lu_env *env, struct cl_lock *lock,
1188 struct cl_io *io, __u32 flags)
1193 cl_lock_trace(D_DLMTRACE, env, "enqueue lock", lock);
1195 LINVRNT(cl_lock_is_mutexed(lock));
1197 result = lock->cll_error;
1201 switch (lock->cll_state) {
1203 cl_lock_state_set(env, lock, CLS_QUEUING);
1207 result = cl_enqueue_kick(env, lock, io, flags);
1209 cl_lock_state_set(env, lock, CLS_ENQUEUED);
1212 LASSERT(cl_lock_is_intransit(lock));
1216 /* yank lock from the cache. */
1217 result = cl_use_try(env, lock, 0);
1226 * impossible, only held locks with increased
1227 * ->cll_holds can be enqueued, and they cannot be
1232 } while (result == CLO_REPEAT);
1235 EXPORT_SYMBOL(cl_enqueue_try);
1238 * Cancel the conflicting lock found during previous enqueue.
1240 * \retval 0 conflicting lock has been canceled.
1241 * \retval -ve error code.
1243 int cl_lock_enqueue_wait(const struct lu_env *env,
1244 struct cl_lock *lock,
1247 struct cl_lock *conflict;
1251 LASSERT(cl_lock_is_mutexed(lock));
1252 LASSERT(lock->cll_state == CLS_QUEUING);
1253 LASSERT(lock->cll_conflict != NULL);
1255 conflict = lock->cll_conflict;
1256 lock->cll_conflict = NULL;
1258 cl_lock_mutex_put(env, lock);
1259 LASSERT(cl_lock_nr_mutexed(env) == 0);
1261 cl_lock_mutex_get(env, conflict);
1262 cl_lock_trace(D_DLMTRACE, env, "enqueue wait", conflict);
1263 cl_lock_cancel(env, conflict);
1264 cl_lock_delete(env, conflict);
1266 while (conflict->cll_state != CLS_FREEING) {
1267 rc = cl_lock_state_wait(env, conflict);
1271 cl_lock_mutex_put(env, conflict);
1272 lu_ref_del(&conflict->cll_reference, "cancel-wait", lock);
1273 cl_lock_put(env, conflict);
1276 cl_lock_mutex_get(env, lock);
1281 EXPORT_SYMBOL(cl_lock_enqueue_wait);
1283 static int cl_enqueue_locked(const struct lu_env *env, struct cl_lock *lock,
1284 struct cl_io *io, __u32 enqflags)
1290 LINVRNT(cl_lock_is_mutexed(lock));
1291 LINVRNT(cl_lock_invariant(env, lock));
1292 LASSERT(lock->cll_holds > 0);
1294 cl_lock_user_add(env, lock);
1296 result = cl_enqueue_try(env, lock, io, enqflags);
1297 if (result == CLO_WAIT) {
1298 if (lock->cll_conflict != NULL)
1299 result = cl_lock_enqueue_wait(env, lock, 1);
1301 result = cl_lock_state_wait(env, lock);
1308 cl_unuse_try(env, lock);
1309 LASSERT(ergo(result == 0, lock->cll_state == CLS_ENQUEUED ||
1310 lock->cll_state == CLS_HELD));
1317 * \pre current thread or io owns a hold on lock.
1319 * \post ergo(result == 0, lock->users increased)
1320 * \post ergo(result == 0, lock->cll_state == CLS_ENQUEUED ||
1321 * lock->cll_state == CLS_HELD)
1323 int cl_enqueue(const struct lu_env *env, struct cl_lock *lock,
1324 struct cl_io *io, __u32 enqflags)
1330 cl_lock_lockdep_acquire(env, lock, enqflags);
1331 cl_lock_mutex_get(env, lock);
1332 result = cl_enqueue_locked(env, lock, io, enqflags);
1333 cl_lock_mutex_put(env, lock);
1335 cl_lock_lockdep_release(env, lock);
1336 LASSERT(ergo(result == 0, lock->cll_state == CLS_ENQUEUED ||
1337 lock->cll_state == CLS_HELD));
1340 EXPORT_SYMBOL(cl_enqueue);
1343 * Tries to unlock a lock.
1345 * This function is called to release underlying resource:
1346 * 1. for top lock, the resource is sublocks it held;
1347 * 2. for sublock, the resource is the reference to dlmlock.
1349 * cl_unuse_try is a one-shot operation, so it must NOT return CLO_WAIT.
1351 * \see cl_unuse() cl_lock_operations::clo_unuse()
1352 * \see cl_lock_state::CLS_CACHED
1354 int cl_unuse_try(const struct lu_env *env, struct cl_lock *lock)
1357 enum cl_lock_state state = CLS_NEW;
1360 cl_lock_trace(D_DLMTRACE, env, "unuse lock", lock);
1362 if (lock->cll_users > 1) {
1363 cl_lock_user_del(env, lock);
1367 /* Only if the lock is in CLS_HELD or CLS_ENQUEUED state, it can hold
1368 * underlying resources. */
1369 if (!(lock->cll_state == CLS_HELD || lock->cll_state == CLS_ENQUEUED)) {
1370 cl_lock_user_del(env, lock);
1375 * New lock users (->cll_users) are not protecting unlocking
1376 * from proceeding. From this point, lock eventually reaches
1377 * CLS_CACHED, is reinitialized to CLS_NEW or fails into
1380 state = cl_lock_intransit(env, lock);
1382 result = cl_unuse_try_internal(env, lock);
1383 LASSERT(lock->cll_state == CLS_INTRANSIT);
1384 LASSERT(result != CLO_WAIT);
1385 cl_lock_user_del(env, lock);
1386 if (result == 0 || result == -ESTALE) {
1388 * Return lock back to the cache. This is the only
1389 * place where lock is moved into CLS_CACHED state.
1391 * If one of ->clo_unuse() methods returned -ESTALE, lock
1392 * cannot be placed into cache and has to be
1393 * re-initialized. This happens e.g., when a sub-lock was
1394 * canceled while unlocking was in progress.
1396 if (state == CLS_HELD && result == 0)
1400 cl_lock_extransit(env, lock, state);
1403 * Hide -ESTALE error.
1404 * If the lock is a glimpse lock, and it has multiple
1405 * stripes. Assuming that one of its sublock returned -ENAVAIL,
1406 * and other sublocks are matched write locks. In this case,
1407 * we can't set this lock to error because otherwise some of
1408 * its sublocks may not be canceled. This causes some dirty
1409 * pages won't be written to OSTs. -jay
1413 CL_LOCK_DEBUG(D_ERROR, env, lock, "unuse return %d\n", result);
1414 /* Set the lock state to CLS_NEW so it will be destroyed.
1415 * In lov_lock_unuse() it will release sublocks even if error
1417 cl_lock_extransit(env, lock, CLS_NEW);
1419 RETURN(result ?: lock->cll_error);
1421 EXPORT_SYMBOL(cl_unuse_try);
1426 void cl_unuse(const struct lu_env *env, struct cl_lock *lock)
1429 cl_lock_mutex_get(env, lock);
1430 cl_unuse_try(env, lock);
1431 cl_lock_mutex_put(env, lock);
1432 cl_lock_lockdep_release(env, lock);
1435 EXPORT_SYMBOL(cl_unuse);
1438 * Tries to wait for a lock.
1440 * This function is called repeatedly by cl_wait() until either lock is
1441 * granted, or error occurs. This function does not block waiting for network
1442 * communication to complete.
1444 * \see cl_wait() cl_lock_operations::clo_wait()
1445 * \see cl_lock_state::CLS_HELD
1447 int cl_wait_try(const struct lu_env *env, struct cl_lock *lock)
1449 const struct cl_lock_slice *slice;
1453 cl_lock_trace(D_DLMTRACE, env, "wait lock try", lock);
1455 LINVRNT(cl_lock_is_mutexed(lock));
1456 LINVRNT(cl_lock_invariant(env, lock));
1457 LASSERT(lock->cll_state == CLS_ENQUEUED ||
1458 lock->cll_state == CLS_HELD ||
1459 lock->cll_state == CLS_INTRANSIT);
1460 LASSERT(lock->cll_users > 0);
1461 LASSERT(lock->cll_holds > 0);
1463 result = lock->cll_error;
1467 if (cl_lock_is_intransit(lock)) {
1472 if (lock->cll_state == CLS_HELD)
1477 cfs_list_for_each_entry(slice, &lock->cll_layers, cls_linkage) {
1478 if (slice->cls_ops->clo_wait != NULL) {
1479 result = slice->cls_ops->clo_wait(env, slice);
1484 LASSERT(result != -ENOSYS);
1486 LASSERT(lock->cll_state != CLS_INTRANSIT);
1487 cl_lock_state_set(env, lock, CLS_HELD);
1489 } while (result == CLO_REPEAT);
1492 EXPORT_SYMBOL(cl_wait_try);
1495 * Waits until enqueued lock is granted.
1497 * \pre current thread or io owns a hold on the lock
1498 * \pre ergo(result == 0, lock->cll_state == CLS_ENQUEUED ||
1499 * lock->cll_state == CLS_HELD)
1501 * \post ergo(result == 0, lock->cll_state == CLS_HELD)
1503 int cl_wait(const struct lu_env *env, struct cl_lock *lock)
1508 cl_lock_mutex_get(env, lock);
1510 LINVRNT(cl_lock_invariant(env, lock));
1511 LASSERTF(lock->cll_state == CLS_ENQUEUED || lock->cll_state == CLS_HELD,
1512 "Wrong state %d \n", lock->cll_state);
1513 LASSERT(lock->cll_holds > 0);
1516 result = cl_wait_try(env, lock);
1517 if (result == CLO_WAIT) {
1518 result = cl_lock_state_wait(env, lock);
1525 cl_unuse_try(env, lock);
1526 cl_lock_lockdep_release(env, lock);
1528 cl_lock_trace(D_DLMTRACE, env, "wait lock", lock);
1529 cl_lock_mutex_put(env, lock);
1530 LASSERT(ergo(result == 0, lock->cll_state == CLS_HELD));
1533 EXPORT_SYMBOL(cl_wait);
1536 * Executes cl_lock_operations::clo_weigh(), and sums results to estimate lock
1539 unsigned long cl_lock_weigh(const struct lu_env *env, struct cl_lock *lock)
1541 const struct cl_lock_slice *slice;
1542 unsigned long pound;
1543 unsigned long ounce;
1546 LINVRNT(cl_lock_is_mutexed(lock));
1547 LINVRNT(cl_lock_invariant(env, lock));
1550 cfs_list_for_each_entry_reverse(slice, &lock->cll_layers, cls_linkage) {
1551 if (slice->cls_ops->clo_weigh != NULL) {
1552 ounce = slice->cls_ops->clo_weigh(env, slice);
1554 if (pound < ounce) /* over-weight^Wflow */
1560 EXPORT_SYMBOL(cl_lock_weigh);
1563 * Notifies layers that lock description changed.
1565 * The server can grant client a lock different from one that was requested
1566 * (e.g., larger in extent). This method is called when actually granted lock
1567 * description becomes known to let layers to accommodate for changed lock
1570 * \see cl_lock_operations::clo_modify()
1572 int cl_lock_modify(const struct lu_env *env, struct cl_lock *lock,
1573 const struct cl_lock_descr *desc)
1575 const struct cl_lock_slice *slice;
1576 struct cl_object *obj = lock->cll_descr.cld_obj;
1577 struct cl_object_header *hdr = cl_object_header(obj);
1581 cl_lock_trace(D_DLMTRACE, env, "modify lock", lock);
1582 /* don't allow object to change */
1583 LASSERT(obj == desc->cld_obj);
1584 LINVRNT(cl_lock_is_mutexed(lock));
1585 LINVRNT(cl_lock_invariant(env, lock));
1587 cfs_list_for_each_entry_reverse(slice, &lock->cll_layers, cls_linkage) {
1588 if (slice->cls_ops->clo_modify != NULL) {
1589 result = slice->cls_ops->clo_modify(env, slice, desc);
1594 CL_LOCK_DEBUG(D_DLMTRACE, env, lock, " -> "DDESCR"@"DFID"\n",
1595 PDESCR(desc), PFID(lu_object_fid(&desc->cld_obj->co_lu)));
1597 * Just replace description in place. Nothing more is needed for
1598 * now. If locks were indexed according to their extent and/or mode,
1599 * that index would have to be updated here.
1601 cfs_spin_lock(&hdr->coh_lock_guard);
1602 lock->cll_descr = *desc;
1603 cfs_spin_unlock(&hdr->coh_lock_guard);
1606 EXPORT_SYMBOL(cl_lock_modify);
1609 * Initializes lock closure with a given origin.
1611 * \see cl_lock_closure
1613 void cl_lock_closure_init(const struct lu_env *env,
1614 struct cl_lock_closure *closure,
1615 struct cl_lock *origin, int wait)
1617 LINVRNT(cl_lock_is_mutexed(origin));
1618 LINVRNT(cl_lock_invariant(env, origin));
1620 CFS_INIT_LIST_HEAD(&closure->clc_list);
1621 closure->clc_origin = origin;
1622 closure->clc_wait = wait;
1623 closure->clc_nr = 0;
1625 EXPORT_SYMBOL(cl_lock_closure_init);
1628 * Builds a closure of \a lock.
1630 * Building of a closure consists of adding initial lock (\a lock) into it,
1631 * and calling cl_lock_operations::clo_closure() methods of \a lock. These
1632 * methods might call cl_lock_closure_build() recursively again, adding more
1633 * locks to the closure, etc.
1635 * \see cl_lock_closure
1637 int cl_lock_closure_build(const struct lu_env *env, struct cl_lock *lock,
1638 struct cl_lock_closure *closure)
1640 const struct cl_lock_slice *slice;
1644 LINVRNT(cl_lock_is_mutexed(closure->clc_origin));
1645 LINVRNT(cl_lock_invariant(env, closure->clc_origin));
1647 result = cl_lock_enclosure(env, lock, closure);
1649 cfs_list_for_each_entry(slice, &lock->cll_layers, cls_linkage) {
1650 if (slice->cls_ops->clo_closure != NULL) {
1651 result = slice->cls_ops->clo_closure(env, slice,
1659 cl_lock_disclosure(env, closure);
1662 EXPORT_SYMBOL(cl_lock_closure_build);
1665 * Adds new lock to a closure.
1667 * Try-locks \a lock and if succeeded, adds it to the closure (never more than
1668 * once). If try-lock failed, returns CLO_REPEAT, after optionally waiting
1669 * until next try-lock is likely to succeed.
1671 int cl_lock_enclosure(const struct lu_env *env, struct cl_lock *lock,
1672 struct cl_lock_closure *closure)
1676 cl_lock_trace(D_DLMTRACE, env, "enclosure lock", lock);
1677 if (!cl_lock_mutex_try(env, lock)) {
1679 * If lock->cll_inclosure is not empty, lock is already in
1682 if (cfs_list_empty(&lock->cll_inclosure)) {
1683 cl_lock_get_trust(lock);
1684 lu_ref_add(&lock->cll_reference, "closure", closure);
1685 cfs_list_add(&lock->cll_inclosure, &closure->clc_list);
1688 cl_lock_mutex_put(env, lock);
1691 cl_lock_disclosure(env, closure);
1692 if (closure->clc_wait) {
1693 cl_lock_get_trust(lock);
1694 lu_ref_add(&lock->cll_reference, "closure-w", closure);
1695 cl_lock_mutex_put(env, closure->clc_origin);
1697 LASSERT(cl_lock_nr_mutexed(env) == 0);
1698 cl_lock_mutex_get(env, lock);
1699 cl_lock_mutex_put(env, lock);
1701 cl_lock_mutex_get(env, closure->clc_origin);
1702 lu_ref_del(&lock->cll_reference, "closure-w", closure);
1703 cl_lock_put(env, lock);
1705 result = CLO_REPEAT;
1709 EXPORT_SYMBOL(cl_lock_enclosure);
1711 /** Releases mutices of enclosed locks. */
1712 void cl_lock_disclosure(const struct lu_env *env,
1713 struct cl_lock_closure *closure)
1715 struct cl_lock *scan;
1716 struct cl_lock *temp;
1718 cl_lock_trace(D_DLMTRACE, env, "disclosure lock", closure->clc_origin);
1719 cfs_list_for_each_entry_safe(scan, temp, &closure->clc_list,
1721 cfs_list_del_init(&scan->cll_inclosure);
1722 cl_lock_mutex_put(env, scan);
1723 lu_ref_del(&scan->cll_reference, "closure", closure);
1724 cl_lock_put(env, scan);
1727 LASSERT(closure->clc_nr == 0);
1729 EXPORT_SYMBOL(cl_lock_disclosure);
1731 /** Finalizes a closure. */
1732 void cl_lock_closure_fini(struct cl_lock_closure *closure)
1734 LASSERT(closure->clc_nr == 0);
1735 LASSERT(cfs_list_empty(&closure->clc_list));
1737 EXPORT_SYMBOL(cl_lock_closure_fini);
1740 * Destroys this lock. Notifies layers (bottom-to-top) that lock is being
1741 * destroyed, then destroy the lock. If there are holds on the lock, postpone
1742 * destruction until all holds are released. This is called when a decision is
1743 * made to destroy the lock in the future. E.g., when a blocking AST is
1744 * received on it, or fatal communication error happens.
1746 * Caller must have a reference on this lock to prevent a situation, when
1747 * deleted lock lingers in memory for indefinite time, because nobody calls
1748 * cl_lock_put() to finish it.
1750 * \pre atomic_read(&lock->cll_ref) > 0
1751 * \pre ergo(cl_lock_nesting(lock) == CNL_TOP,
1752 * cl_lock_nr_mutexed(env) == 1)
1753 * [i.e., if a top-lock is deleted, mutices of no other locks can be
1754 * held, as deletion of sub-locks might require releasing a top-lock
1757 * \see cl_lock_operations::clo_delete()
1758 * \see cl_lock::cll_holds
1760 void cl_lock_delete(const struct lu_env *env, struct cl_lock *lock)
1762 LINVRNT(cl_lock_is_mutexed(lock));
1763 LINVRNT(cl_lock_invariant(env, lock));
1764 LASSERT(ergo(cl_lock_nesting(lock) == CNL_TOP,
1765 cl_lock_nr_mutexed(env) == 1));
1768 cl_lock_trace(D_DLMTRACE, env, "delete lock", lock);
1769 if (lock->cll_holds == 0)
1770 cl_lock_delete0(env, lock);
1772 lock->cll_flags |= CLF_DOOMED;
1775 EXPORT_SYMBOL(cl_lock_delete);
1778 * Mark lock as irrecoverably failed, and mark it for destruction. This
1779 * happens when, e.g., server fails to grant a lock to us, or networking
1782 * \pre atomic_read(&lock->cll_ref) > 0
1784 * \see clo_lock_delete()
1785 * \see cl_lock::cll_holds
1787 void cl_lock_error(const struct lu_env *env, struct cl_lock *lock, int error)
1789 LINVRNT(cl_lock_is_mutexed(lock));
1790 LINVRNT(cl_lock_invariant(env, lock));
1793 if (lock->cll_error == 0 && error != 0) {
1794 cl_lock_trace(D_DLMTRACE, env, "set lock error", lock);
1795 lock->cll_error = error;
1796 cl_lock_signal(env, lock);
1797 cl_lock_cancel(env, lock);
1798 cl_lock_delete(env, lock);
1802 EXPORT_SYMBOL(cl_lock_error);
1805 * Cancels this lock. Notifies layers
1806 * (bottom-to-top) that lock is being cancelled, then destroy the lock. If
1807 * there are holds on the lock, postpone cancellation until
1808 * all holds are released.
1810 * Cancellation notification is delivered to layers at most once.
1812 * \see cl_lock_operations::clo_cancel()
1813 * \see cl_lock::cll_holds
1815 void cl_lock_cancel(const struct lu_env *env, struct cl_lock *lock)
1817 LINVRNT(cl_lock_is_mutexed(lock));
1818 LINVRNT(cl_lock_invariant(env, lock));
1821 cl_lock_trace(D_DLMTRACE, env, "cancel lock", lock);
1822 if (lock->cll_holds == 0)
1823 cl_lock_cancel0(env, lock);
1825 lock->cll_flags |= CLF_CANCELPEND;
1828 EXPORT_SYMBOL(cl_lock_cancel);
1831 * Finds an existing lock covering given page and optionally different from a
1832 * given \a except lock.
1834 struct cl_lock *cl_lock_at_pgoff(const struct lu_env *env, struct cl_object *obj,
1835 pgoff_t index, struct cl_lock *except,
1836 int pending, int canceld)
1838 struct cl_object_header *head;
1839 struct cl_lock *scan;
1840 struct cl_lock *lock;
1841 struct cl_lock_descr *need;
1845 head = cl_object_header(obj);
1846 need = &cl_env_info(env)->clt_descr;
1849 need->cld_mode = CLM_READ; /* CLM_READ matches both READ & WRITE, but
1851 need->cld_start = need->cld_end = index;
1852 need->cld_enq_flags = 0;
1854 cfs_spin_lock(&head->coh_lock_guard);
1855 /* It is fine to match any group lock since there could be only one
1856 * with a uniq gid and it conflicts with all other lock modes too */
1857 cfs_list_for_each_entry(scan, &head->coh_locks, cll_linkage) {
1858 if (scan != except &&
1859 (scan->cll_descr.cld_mode == CLM_GROUP ||
1860 cl_lock_ext_match(&scan->cll_descr, need)) &&
1861 scan->cll_state >= CLS_HELD &&
1862 scan->cll_state < CLS_FREEING &&
1864 * This check is racy as the lock can be canceled right
1865 * after it is done, but this is fine, because page exists
1868 (canceld || !(scan->cll_flags & CLF_CANCELLED)) &&
1869 (pending || !(scan->cll_flags & CLF_CANCELPEND))) {
1870 /* Don't increase cs_hit here since this
1871 * is just a helper function. */
1872 cl_lock_get_trust(scan);
1877 cfs_spin_unlock(&head->coh_lock_guard);
1880 EXPORT_SYMBOL(cl_lock_at_pgoff);
1883 * Calculate the page offset at the layer of @lock.
1884 * At the time of this writing, @page is top page and @lock is sub lock.
1886 static pgoff_t pgoff_at_lock(struct cl_page *page, struct cl_lock *lock)
1888 struct lu_device_type *dtype;
1889 const struct cl_page_slice *slice;
1891 dtype = lock->cll_descr.cld_obj->co_lu.lo_dev->ld_type;
1892 slice = cl_page_at(page, dtype);
1893 LASSERT(slice != NULL);
1894 return slice->cpl_page->cp_index;
1898 * Check if page @page is covered by an extra lock or discard it.
1900 static int check_and_discard_cb(const struct lu_env *env, struct cl_io *io,
1901 struct cl_page *page, void *cbdata)
1903 struct cl_thread_info *info = cl_env_info(env);
1904 struct cl_lock *lock = cbdata;
1905 pgoff_t index = pgoff_at_lock(page, lock);
1907 if (index >= info->clt_fn_index) {
1908 struct cl_lock *tmp;
1910 /* refresh non-overlapped index */
1911 tmp = cl_lock_at_pgoff(env, lock->cll_descr.cld_obj, index, lock,
1914 /* Cache the first-non-overlapped index so as to skip
1915 * all pages within [index, clt_fn_index). This
1916 * is safe because if tmp lock is canceled, it will
1917 * discard these pages. */
1918 info->clt_fn_index = tmp->cll_descr.cld_end + 1;
1919 if (tmp->cll_descr.cld_end == CL_PAGE_EOF)
1920 info->clt_fn_index = CL_PAGE_EOF;
1921 cl_lock_put(env, tmp);
1922 } else if (cl_page_own(env, io, page) == 0) {
1923 /* discard the page */
1924 cl_page_unmap(env, io, page);
1925 cl_page_discard(env, io, page);
1926 cl_page_disown(env, io, page);
1928 LASSERT(page->cp_state == CPS_FREEING);
1932 info->clt_next_index = index + 1;
1933 return CLP_GANG_OKAY;
1936 static int pageout_cb(const struct lu_env *env, struct cl_io *io,
1937 struct cl_page *page, void *cbdata)
1939 struct cl_thread_info *info = cl_env_info(env);
1940 struct cl_page_list *queue = &info->clt_queue.c2_qin;
1941 struct cl_lock *lock = cbdata;
1942 typeof(cl_page_own) *page_own;
1943 int rc = CLP_GANG_OKAY;
1945 page_own = queue->pl_nr ? cl_page_own_try : cl_page_own;
1946 if (page_own(env, io, page) == 0) {
1947 cl_page_list_add(queue, page);
1948 info->clt_next_index = pgoff_at_lock(page, lock) + 1;
1949 } else if (page->cp_state != CPS_FREEING) {
1950 /* cl_page_own() won't fail unless
1951 * the page is being freed. */
1952 LASSERT(queue->pl_nr != 0);
1953 rc = CLP_GANG_AGAIN;
1960 * Invalidate pages protected by the given lock, sending them out to the
1961 * server first, if necessary.
1963 * This function does the following:
1965 * - collects a list of pages to be invalidated,
1967 * - unmaps them from the user virtual memory,
1969 * - sends dirty pages to the server,
1971 * - waits for transfer completion,
1973 * - discards pages, and throws them out of memory.
1975 * If \a discard is set, pages are discarded without sending them to the
1978 * If error happens on any step, the process continues anyway (the reasoning
1979 * behind this being that lock cancellation cannot be delayed indefinitely).
1981 int cl_lock_page_out(const struct lu_env *env, struct cl_lock *lock,
1984 struct cl_thread_info *info = cl_env_info(env);
1985 struct cl_io *io = &info->clt_io;
1986 struct cl_2queue *queue = &info->clt_queue;
1987 struct cl_lock_descr *descr = &lock->cll_descr;
1988 cl_page_gang_cb_t cb;
1993 LINVRNT(cl_lock_invariant(env, lock));
1996 io->ci_obj = cl_object_top(descr->cld_obj);
1997 result = cl_io_init(env, io, CIT_MISC, io->ci_obj);
2001 cb = descr->cld_mode == CLM_READ ? check_and_discard_cb : pageout_cb;
2002 info->clt_fn_index = info->clt_next_index = descr->cld_start;
2004 cl_2queue_init(queue);
2005 res = cl_page_gang_lookup(env, descr->cld_obj, io,
2006 info->clt_next_index, descr->cld_end,
2008 page_count = queue->c2_qin.pl_nr;
2009 if (page_count > 0) {
2010 /* must be writeback case */
2011 LASSERTF(descr->cld_mode >= CLM_WRITE, "lock mode %s\n",
2012 cl_lock_mode_name(descr->cld_mode));
2014 result = cl_page_list_unmap(env, io, &queue->c2_qin);
2016 long timeout = 600; /* 10 minutes. */
2017 /* for debug purpose, if this request can't be
2018 * finished in 10 minutes, we hope it can
2021 result = cl_io_submit_sync(env, io, CRT_WRITE,
2025 CWARN("Writing %lu pages error: %d\n",
2026 page_count, result);
2028 cl_2queue_discard(env, io, queue);
2029 cl_2queue_disown(env, io, queue);
2030 cl_2queue_fini(env, queue);
2033 if (info->clt_next_index > descr->cld_end)
2036 if (res == CLP_GANG_RESCHED)
2038 } while (res != CLP_GANG_OKAY);
2040 cl_io_fini(env, io);
2043 EXPORT_SYMBOL(cl_lock_page_out);
2046 * Eliminate all locks for a given object.
2048 * Caller has to guarantee that no lock is in active use.
2050 * \param cancel when this is set, cl_locks_prune() cancels locks before
2053 void cl_locks_prune(const struct lu_env *env, struct cl_object *obj, int cancel)
2055 struct cl_object_header *head;
2056 struct cl_lock *lock;
2059 head = cl_object_header(obj);
2061 * If locks are destroyed without cancellation, all pages must be
2062 * already destroyed (as otherwise they will be left unprotected).
2064 LASSERT(ergo(!cancel,
2065 head->coh_tree.rnode == NULL && head->coh_pages == 0));
2067 cfs_spin_lock(&head->coh_lock_guard);
2068 while (!cfs_list_empty(&head->coh_locks)) {
2069 lock = container_of(head->coh_locks.next,
2070 struct cl_lock, cll_linkage);
2071 cl_lock_get_trust(lock);
2072 cfs_spin_unlock(&head->coh_lock_guard);
2073 lu_ref_add(&lock->cll_reference, "prune", cfs_current());
2074 cl_lock_mutex_get(env, lock);
2075 if (lock->cll_state < CLS_FREEING) {
2076 LASSERT(lock->cll_holds == 0);
2077 LASSERT(lock->cll_users == 0);
2079 cl_lock_cancel(env, lock);
2080 cl_lock_delete(env, lock);
2082 cl_lock_mutex_put(env, lock);
2083 lu_ref_del(&lock->cll_reference, "prune", cfs_current());
2084 cl_lock_put(env, lock);
2085 cfs_spin_lock(&head->coh_lock_guard);
2087 cfs_spin_unlock(&head->coh_lock_guard);
2090 EXPORT_SYMBOL(cl_locks_prune);
2092 static struct cl_lock *cl_lock_hold_mutex(const struct lu_env *env,
2093 const struct cl_io *io,
2094 const struct cl_lock_descr *need,
2095 const char *scope, const void *source)
2097 struct cl_lock *lock;
2102 lock = cl_lock_find(env, io, need);
2105 cl_lock_mutex_get(env, lock);
2106 if (lock->cll_state < CLS_FREEING &&
2107 !(lock->cll_flags & CLF_CANCELLED)) {
2108 cl_lock_hold_mod(env, lock, +1);
2109 lu_ref_add(&lock->cll_holders, scope, source);
2110 lu_ref_add(&lock->cll_reference, scope, source);
2113 cl_lock_mutex_put(env, lock);
2114 cl_lock_put(env, lock);
2120 * Returns a lock matching \a need description with a reference and a hold on
2123 * This is much like cl_lock_find(), except that cl_lock_hold() additionally
2124 * guarantees that lock is not in the CLS_FREEING state on return.
2126 struct cl_lock *cl_lock_hold(const struct lu_env *env, const struct cl_io *io,
2127 const struct cl_lock_descr *need,
2128 const char *scope, const void *source)
2130 struct cl_lock *lock;
2134 lock = cl_lock_hold_mutex(env, io, need, scope, source);
2136 cl_lock_mutex_put(env, lock);
2139 EXPORT_SYMBOL(cl_lock_hold);
2142 * Main high-level entry point of cl_lock interface that finds existing or
2143 * enqueues new lock matching given description.
2145 struct cl_lock *cl_lock_request(const struct lu_env *env, struct cl_io *io,
2146 const struct cl_lock_descr *need,
2147 const char *scope, const void *source)
2149 struct cl_lock *lock;
2151 __u32 enqflags = need->cld_enq_flags;
2155 lock = cl_lock_hold_mutex(env, io, need, scope, source);
2156 if (!IS_ERR(lock)) {
2157 rc = cl_enqueue_locked(env, lock, io, enqflags);
2159 if (cl_lock_fits_into(env, lock, need, io)) {
2160 cl_lock_mutex_put(env, lock);
2161 cl_lock_lockdep_acquire(env,
2165 cl_unuse_try(env, lock);
2167 cl_lock_trace(D_DLMTRACE, env, "enqueue failed", lock);
2168 cl_lock_hold_release(env, lock, scope, source);
2169 cl_lock_mutex_put(env, lock);
2170 lu_ref_del(&lock->cll_reference, scope, source);
2171 cl_lock_put(env, lock);
2178 EXPORT_SYMBOL(cl_lock_request);
2181 * Adds a hold to a known lock.
2183 void cl_lock_hold_add(const struct lu_env *env, struct cl_lock *lock,
2184 const char *scope, const void *source)
2186 LINVRNT(cl_lock_is_mutexed(lock));
2187 LINVRNT(cl_lock_invariant(env, lock));
2188 LASSERT(lock->cll_state != CLS_FREEING);
2191 cl_lock_hold_mod(env, lock, +1);
2193 lu_ref_add(&lock->cll_holders, scope, source);
2194 lu_ref_add(&lock->cll_reference, scope, source);
2197 EXPORT_SYMBOL(cl_lock_hold_add);
2200 * Releases a hold and a reference on a lock, on which caller acquired a
2203 void cl_lock_unhold(const struct lu_env *env, struct cl_lock *lock,
2204 const char *scope, const void *source)
2206 LINVRNT(cl_lock_invariant(env, lock));
2208 cl_lock_hold_release(env, lock, scope, source);
2209 lu_ref_del(&lock->cll_reference, scope, source);
2210 cl_lock_put(env, lock);
2213 EXPORT_SYMBOL(cl_lock_unhold);
2216 * Releases a hold and a reference on a lock, obtained by cl_lock_hold().
2218 void cl_lock_release(const struct lu_env *env, struct cl_lock *lock,
2219 const char *scope, const void *source)
2221 LINVRNT(cl_lock_invariant(env, lock));
2223 cl_lock_trace(D_DLMTRACE, env, "release lock", lock);
2224 cl_lock_mutex_get(env, lock);
2225 cl_lock_hold_release(env, lock, scope, source);
2226 cl_lock_mutex_put(env, lock);
2227 lu_ref_del(&lock->cll_reference, scope, source);
2228 cl_lock_put(env, lock);
2231 EXPORT_SYMBOL(cl_lock_release);
2233 void cl_lock_user_add(const struct lu_env *env, struct cl_lock *lock)
2235 LINVRNT(cl_lock_is_mutexed(lock));
2236 LINVRNT(cl_lock_invariant(env, lock));
2239 cl_lock_used_mod(env, lock, +1);
2242 EXPORT_SYMBOL(cl_lock_user_add);
2244 int cl_lock_user_del(const struct lu_env *env, struct cl_lock *lock)
2246 LINVRNT(cl_lock_is_mutexed(lock));
2247 LINVRNT(cl_lock_invariant(env, lock));
2248 LASSERT(lock->cll_users > 0);
2251 cl_lock_used_mod(env, lock, -1);
2252 RETURN(lock->cll_users == 0);
2254 EXPORT_SYMBOL(cl_lock_user_del);
2256 const char *cl_lock_mode_name(const enum cl_lock_mode mode)
2258 static const char *names[] = {
2259 [CLM_PHANTOM] = "P",
2264 if (0 <= mode && mode < ARRAY_SIZE(names))
2269 EXPORT_SYMBOL(cl_lock_mode_name);
2272 * Prints human readable representation of a lock description.
2274 void cl_lock_descr_print(const struct lu_env *env, void *cookie,
2275 lu_printer_t printer,
2276 const struct cl_lock_descr *descr)
2278 const struct lu_fid *fid;
2280 fid = lu_object_fid(&descr->cld_obj->co_lu);
2281 (*printer)(env, cookie, DDESCR"@"DFID, PDESCR(descr), PFID(fid));
2283 EXPORT_SYMBOL(cl_lock_descr_print);
2286 * Prints human readable representation of \a lock to the \a f.
2288 void cl_lock_print(const struct lu_env *env, void *cookie,
2289 lu_printer_t printer, const struct cl_lock *lock)
2291 const struct cl_lock_slice *slice;
2292 (*printer)(env, cookie, "lock@%p[%d %d %d %d %d %08lx] ",
2293 lock, cfs_atomic_read(&lock->cll_ref),
2294 lock->cll_state, lock->cll_error, lock->cll_holds,
2295 lock->cll_users, lock->cll_flags);
2296 cl_lock_descr_print(env, cookie, printer, &lock->cll_descr);
2297 (*printer)(env, cookie, " {\n");
2299 cfs_list_for_each_entry(slice, &lock->cll_layers, cls_linkage) {
2300 (*printer)(env, cookie, " %s@%p: ",
2301 slice->cls_obj->co_lu.lo_dev->ld_type->ldt_name,
2303 if (slice->cls_ops->clo_print != NULL)
2304 slice->cls_ops->clo_print(env, cookie, printer, slice);
2305 (*printer)(env, cookie, "\n");
2307 (*printer)(env, cookie, "} lock@%p\n", lock);
2309 EXPORT_SYMBOL(cl_lock_print);
2311 int cl_lock_init(void)
2313 return lu_kmem_init(cl_lock_caches);
2316 void cl_lock_fini(void)
2318 lu_kmem_fini(cl_lock_caches);