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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2010, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * lustre/ldlm/ldlm_lock.c
34 * Author: Peter Braam <braam@clusterfs.com>
35 * Author: Phil Schwan <phil@clusterfs.com>
38 #define DEBUG_SUBSYSTEM S_LDLM
40 #include <libcfs/libcfs.h>
42 #include <lustre_swab.h>
43 #include <obd_class.h>
45 #include "ldlm_internal.h"
47 struct kmem_cache *ldlm_glimpse_work_kmem;
48 EXPORT_SYMBOL(ldlm_glimpse_work_kmem);
51 char *ldlm_lockname[] = {
59 [LCK_GROUP] = "GROUP",
62 EXPORT_SYMBOL(ldlm_lockname);
64 char *ldlm_typename[] = {
66 [LDLM_EXTENT] = "EXT",
71 static ldlm_policy_wire_to_local_t ldlm_policy_wire_to_local[] = {
72 [LDLM_PLAIN - LDLM_MIN_TYPE] = ldlm_plain_policy_wire_to_local,
73 [LDLM_EXTENT - LDLM_MIN_TYPE] = ldlm_extent_policy_wire_to_local,
74 [LDLM_FLOCK - LDLM_MIN_TYPE] = ldlm_flock_policy_wire_to_local,
75 [LDLM_IBITS - LDLM_MIN_TYPE] = ldlm_ibits_policy_wire_to_local,
78 static ldlm_policy_local_to_wire_t ldlm_policy_local_to_wire[] = {
79 [LDLM_PLAIN - LDLM_MIN_TYPE] = ldlm_plain_policy_local_to_wire,
80 [LDLM_EXTENT - LDLM_MIN_TYPE] = ldlm_extent_policy_local_to_wire,
81 [LDLM_FLOCK - LDLM_MIN_TYPE] = ldlm_flock_policy_local_to_wire,
82 [LDLM_IBITS - LDLM_MIN_TYPE] = ldlm_ibits_policy_local_to_wire,
86 * Converts lock policy from local format to on the wire lock_desc format
88 void ldlm_convert_policy_to_wire(enum ldlm_type type,
89 const union ldlm_policy_data *lpolicy,
90 union ldlm_wire_policy_data *wpolicy)
92 ldlm_policy_local_to_wire_t convert;
94 convert = ldlm_policy_local_to_wire[type - LDLM_MIN_TYPE];
96 convert(lpolicy, wpolicy);
100 * Converts lock policy from on the wire lock_desc format to local format
102 void ldlm_convert_policy_to_local(struct obd_export *exp, enum ldlm_type type,
103 const union ldlm_wire_policy_data *wpolicy,
104 union ldlm_policy_data *lpolicy)
106 ldlm_policy_wire_to_local_t convert;
108 convert = ldlm_policy_wire_to_local[type - LDLM_MIN_TYPE];
110 convert(wpolicy, lpolicy);
113 const char *ldlm_it2str(enum ldlm_intent_flags it)
120 case (IT_OPEN | IT_CREAT):
133 CERROR("Unknown intent 0x%08x\n", it);
137 EXPORT_SYMBOL(ldlm_it2str);
139 #ifdef HAVE_SERVER_SUPPORT
140 static ldlm_processing_policy ldlm_processing_policy_table[] = {
141 [LDLM_PLAIN] = ldlm_process_plain_lock,
142 [LDLM_EXTENT] = ldlm_process_extent_lock,
143 [LDLM_FLOCK] = ldlm_process_flock_lock,
144 [LDLM_IBITS] = ldlm_process_inodebits_lock,
147 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res)
149 return ldlm_processing_policy_table[res->lr_type];
151 EXPORT_SYMBOL(ldlm_get_processing_policy);
153 static ldlm_reprocessing_policy ldlm_reprocessing_policy_table[] = {
154 [LDLM_PLAIN] = ldlm_reprocess_queue,
155 [LDLM_EXTENT] = ldlm_reprocess_queue,
156 [LDLM_FLOCK] = ldlm_reprocess_queue,
157 [LDLM_IBITS] = ldlm_reprocess_inodebits_queue,
160 ldlm_reprocessing_policy ldlm_get_reprocessing_policy(struct ldlm_resource *res)
162 return ldlm_reprocessing_policy_table[res->lr_type];
165 #endif /* HAVE_SERVER_SUPPORT */
167 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg)
171 EXPORT_SYMBOL(ldlm_register_intent);
174 * REFCOUNTED LOCK OBJECTS
179 * Get a reference on a lock.
181 * Lock refcounts, during creation:
182 * - one special one for allocation, dec'd only once in destroy
183 * - one for being a lock that's in-use
184 * - one for the addref associated with a new lock
186 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock)
188 atomic_inc(&lock->l_refc);
191 EXPORT_SYMBOL(ldlm_lock_get);
194 * Release lock reference.
196 * Also frees the lock if it was last reference.
198 void ldlm_lock_put(struct ldlm_lock *lock)
202 LASSERT(lock->l_resource != LP_POISON);
203 LASSERT(atomic_read(&lock->l_refc) > 0);
204 if (atomic_dec_and_test(&lock->l_refc)) {
205 struct ldlm_resource *res;
208 "final lock_put on destroyed lock, freeing it.");
210 res = lock->l_resource;
211 LASSERT(ldlm_is_destroyed(lock));
212 LASSERT(list_empty(&lock->l_exp_list));
213 LASSERT(list_empty(&lock->l_res_link));
214 LASSERT(list_empty(&lock->l_pending_chain));
216 lprocfs_counter_decr(ldlm_res_to_ns(res)->ns_stats,
218 lu_ref_del(&res->lr_reference, "lock", lock);
219 if (lock->l_export) {
220 class_export_lock_put(lock->l_export, lock);
221 lock->l_export = NULL;
224 if (lock->l_lvb_data != NULL)
225 OBD_FREE_LARGE(lock->l_lvb_data, lock->l_lvb_len);
227 if (res->lr_type == LDLM_EXTENT) {
228 ldlm_interval_free(ldlm_interval_detach(lock));
229 } else if (res->lr_type == LDLM_IBITS) {
230 if (lock->l_ibits_node != NULL)
231 OBD_SLAB_FREE_PTR(lock->l_ibits_node,
232 ldlm_inodebits_slab);
234 ldlm_resource_putref(res);
235 lock->l_resource = NULL;
236 lu_ref_fini(&lock->l_reference);
237 OBD_FREE_RCU(lock, sizeof(*lock), &lock->l_handle);
242 EXPORT_SYMBOL(ldlm_lock_put);
245 * Removes LDLM lock \a lock from LRU. Assumes LRU is already locked.
247 int ldlm_lock_remove_from_lru_nolock(struct ldlm_lock *lock)
250 if (!list_empty(&lock->l_lru)) {
251 struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
253 LASSERT(lock->l_resource->lr_type != LDLM_FLOCK);
254 if (ns->ns_last_pos == &lock->l_lru)
255 ns->ns_last_pos = lock->l_lru.prev;
256 list_del_init(&lock->l_lru);
257 LASSERT(ns->ns_nr_unused > 0);
265 * Removes LDLM lock \a lock from LRU. Obtains the LRU lock first.
267 * If \a last_use is non-zero, it will remove the lock from LRU only if
268 * it matches lock's l_last_used.
270 * \retval 0 if \a last_use is set, the lock is not in LRU list or \a last_use
271 * doesn't match lock's l_last_used;
272 * otherwise, the lock hasn't been in the LRU list.
273 * \retval 1 the lock was in LRU list and removed.
275 int ldlm_lock_remove_from_lru_check(struct ldlm_lock *lock, ktime_t last_use)
277 struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
281 if (ldlm_is_ns_srv(lock)) {
282 LASSERT(list_empty(&lock->l_lru));
286 spin_lock(&ns->ns_lock);
287 if (!ktime_compare(last_use, ktime_set(0, 0)) ||
288 !ktime_compare(last_use, lock->l_last_used))
289 rc = ldlm_lock_remove_from_lru_nolock(lock);
290 spin_unlock(&ns->ns_lock);
296 * Adds LDLM lock \a lock to namespace LRU. Assumes LRU is already locked.
298 void ldlm_lock_add_to_lru_nolock(struct ldlm_lock *lock)
300 struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
302 lock->l_last_used = ktime_get();
303 LASSERT(list_empty(&lock->l_lru));
304 LASSERT(lock->l_resource->lr_type != LDLM_FLOCK);
305 list_add_tail(&lock->l_lru, &ns->ns_unused_list);
306 LASSERT(ns->ns_nr_unused >= 0);
311 * Adds LDLM lock \a lock to namespace LRU. Obtains necessary LRU locks
314 void ldlm_lock_add_to_lru(struct ldlm_lock *lock)
316 struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
319 spin_lock(&ns->ns_lock);
320 ldlm_lock_add_to_lru_nolock(lock);
321 spin_unlock(&ns->ns_lock);
326 * Moves LDLM lock \a lock that is already in namespace LRU to the tail of
327 * the LRU. Performs necessary LRU locking
329 void ldlm_lock_touch_in_lru(struct ldlm_lock *lock)
331 struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
334 if (ldlm_is_ns_srv(lock)) {
335 LASSERT(list_empty(&lock->l_lru));
340 spin_lock(&ns->ns_lock);
341 if (!list_empty(&lock->l_lru)) {
342 ldlm_lock_remove_from_lru_nolock(lock);
343 ldlm_lock_add_to_lru_nolock(lock);
345 spin_unlock(&ns->ns_lock);
350 * Helper to destroy a locked lock.
352 * Used by ldlm_lock_destroy and ldlm_lock_destroy_nolock
353 * Must be called with l_lock and lr_lock held.
355 * Does not actually free the lock data, but rather marks the lock as
356 * destroyed by setting l_destroyed field in the lock to 1. Destroys a
357 * handle->lock association too, so that the lock can no longer be found
358 * and removes the lock from LRU list. Actual lock freeing occurs when
359 * last lock reference goes away.
361 * Original comment (of some historical value):
362 * This used to have a 'strict' flag, which recovery would use to mark an
363 * in-use lock as needing-to-die. Lest I am ever tempted to put it back, I
364 * shall explain why it's gone: with the new hash table scheme, once you call
365 * ldlm_lock_destroy, you can never drop your final references on this lock.
366 * Because it's not in the hash table anymore. -phil
368 static int ldlm_lock_destroy_internal(struct ldlm_lock *lock)
372 if (lock->l_readers || lock->l_writers) {
373 LDLM_ERROR(lock, "lock still has references");
377 if (!list_empty(&lock->l_res_link)) {
378 LDLM_ERROR(lock, "lock still on resource");
382 if (ldlm_is_destroyed(lock)) {
383 LASSERT(list_empty(&lock->l_lru));
387 ldlm_set_destroyed(lock);
389 if (lock->l_export && lock->l_export->exp_lock_hash) {
390 /* NB: it's safe to call cfs_hash_del() even lock isn't
391 * in exp_lock_hash. */
392 /* In the function below, .hs_keycmp resolves to
393 * ldlm_export_lock_keycmp() */
394 /* coverity[overrun-buffer-val] */
395 cfs_hash_del(lock->l_export->exp_lock_hash,
396 &lock->l_remote_handle, &lock->l_exp_hash);
399 ldlm_lock_remove_from_lru(lock);
400 class_handle_unhash(&lock->l_handle);
407 * Destroys a LDLM lock \a lock. Performs necessary locking first.
409 void ldlm_lock_destroy(struct ldlm_lock *lock)
413 lock_res_and_lock(lock);
414 first = ldlm_lock_destroy_internal(lock);
415 unlock_res_and_lock(lock);
417 /* drop reference from hashtable only for first destroy */
419 lu_ref_del(&lock->l_reference, "hash", lock);
420 LDLM_LOCK_RELEASE(lock);
426 * Destroys a LDLM lock \a lock that is already locked.
428 void ldlm_lock_destroy_nolock(struct ldlm_lock *lock)
432 first = ldlm_lock_destroy_internal(lock);
433 /* drop reference from hashtable only for first destroy */
435 lu_ref_del(&lock->l_reference, "hash", lock);
436 LDLM_LOCK_RELEASE(lock);
441 /* this is called by portals_handle2object with the handle lock taken */
442 static void lock_handle_addref(void *lock)
444 LDLM_LOCK_GET((struct ldlm_lock *)lock);
447 static void lock_handle_free(void *lock, int size)
449 LASSERT(size == sizeof(struct ldlm_lock));
450 OBD_SLAB_FREE(lock, ldlm_lock_slab, size);
453 static struct portals_handle_ops lock_handle_ops = {
454 .hop_addref = lock_handle_addref,
455 .hop_free = lock_handle_free,
460 * Allocate and initialize new lock structure.
462 * usage: pass in a resource on which you have done ldlm_resource_get
463 * new lock will take over the refcount.
464 * returns: lock with refcount 2 - one for current caller and one for remote
466 static struct ldlm_lock *ldlm_lock_new(struct ldlm_resource *resource)
468 struct ldlm_lock *lock;
471 if (resource == NULL)
474 OBD_SLAB_ALLOC_PTR_GFP(lock, ldlm_lock_slab, GFP_NOFS);
478 spin_lock_init(&lock->l_lock);
479 lock->l_resource = resource;
480 lu_ref_add(&resource->lr_reference, "lock", lock);
482 atomic_set(&lock->l_refc, 2);
483 INIT_LIST_HEAD(&lock->l_res_link);
484 INIT_LIST_HEAD(&lock->l_lru);
485 INIT_LIST_HEAD(&lock->l_pending_chain);
486 INIT_LIST_HEAD(&lock->l_bl_ast);
487 INIT_LIST_HEAD(&lock->l_cp_ast);
488 INIT_LIST_HEAD(&lock->l_rk_ast);
489 init_waitqueue_head(&lock->l_waitq);
490 lock->l_blocking_lock = NULL;
491 INIT_LIST_HEAD(&lock->l_sl_mode);
492 INIT_LIST_HEAD(&lock->l_sl_policy);
493 INIT_HLIST_NODE(&lock->l_exp_hash);
494 INIT_HLIST_NODE(&lock->l_exp_flock_hash);
496 lprocfs_counter_incr(ldlm_res_to_ns(resource)->ns_stats,
498 INIT_LIST_HEAD_RCU(&lock->l_handle.h_link);
499 class_handle_hash(&lock->l_handle, &lock_handle_ops);
501 lu_ref_init(&lock->l_reference);
502 lu_ref_add(&lock->l_reference, "hash", lock);
503 lock->l_callback_timeout = 0;
504 lock->l_activity = 0;
506 #if LUSTRE_TRACKS_LOCK_EXP_REFS
507 INIT_LIST_HEAD(&lock->l_exp_refs_link);
508 lock->l_exp_refs_nr = 0;
509 lock->l_exp_refs_target = NULL;
511 INIT_LIST_HEAD(&lock->l_exp_list);
517 * Moves LDLM lock \a lock to another resource.
518 * This is used on client when server returns some other lock than requested
519 * (typically as a result of intent operation)
521 int ldlm_lock_change_resource(struct ldlm_namespace *ns, struct ldlm_lock *lock,
522 const struct ldlm_res_id *new_resid)
524 struct ldlm_resource *oldres = lock->l_resource;
525 struct ldlm_resource *newres;
529 LASSERT(ns_is_client(ns));
531 lock_res_and_lock(lock);
532 if (memcmp(new_resid, &lock->l_resource->lr_name,
533 sizeof(lock->l_resource->lr_name)) == 0) {
535 unlock_res_and_lock(lock);
539 LASSERT(new_resid->name[0] != 0);
541 /* This function assumes that the lock isn't on any lists */
542 LASSERT(list_empty(&lock->l_res_link));
544 type = oldres->lr_type;
545 unlock_res_and_lock(lock);
547 newres = ldlm_resource_get(ns, NULL, new_resid, type, 1);
549 RETURN(PTR_ERR(newres));
551 lu_ref_add(&newres->lr_reference, "lock", lock);
553 * To flip the lock from the old to the new resource, lock, oldres and
554 * newres have to be locked. Resource spin-locks are nested within
555 * lock->l_lock, and are taken in the memory address order to avoid
558 spin_lock(&lock->l_lock);
559 oldres = lock->l_resource;
560 if (oldres < newres) {
562 lock_res_nested(newres, LRT_NEW);
565 lock_res_nested(oldres, LRT_NEW);
567 LASSERT(memcmp(new_resid, &oldres->lr_name,
568 sizeof oldres->lr_name) != 0);
569 lock->l_resource = newres;
571 unlock_res_and_lock(lock);
573 /* ...and the flowers are still standing! */
574 lu_ref_del(&oldres->lr_reference, "lock", lock);
575 ldlm_resource_putref(oldres);
580 /** \defgroup ldlm_handles LDLM HANDLES
581 * Ways to get hold of locks without any addresses.
586 * Fills in handle for LDLM lock \a lock into supplied \a lockh
587 * Does not take any references.
589 void ldlm_lock2handle(const struct ldlm_lock *lock, struct lustre_handle *lockh)
591 lockh->cookie = lock->l_handle.h_cookie;
593 EXPORT_SYMBOL(ldlm_lock2handle);
596 * Obtain a lock reference by handle.
598 * if \a flags: atomically get the lock and set the flags.
599 * Return NULL if flag already set
601 struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *handle,
604 struct ldlm_lock *lock;
609 lock = class_handle2object(handle->cookie, &lock_handle_ops);
613 if (lock->l_export != NULL && lock->l_export->exp_failed) {
614 CDEBUG(D_INFO, "lock export failed: lock %p, exp %p\n",
615 lock, lock->l_export);
620 /* It's unlikely but possible that someone marked the lock as
621 * destroyed after we did handle2object on it */
622 if ((flags == 0) && !ldlm_is_destroyed(lock)) {
623 lu_ref_add(&lock->l_reference, "handle", current);
627 lock_res_and_lock(lock);
629 LASSERT(lock->l_resource != NULL);
631 lu_ref_add_atomic(&lock->l_reference, "handle", current);
632 if (unlikely(ldlm_is_destroyed(lock))) {
633 unlock_res_and_lock(lock);
634 CDEBUG(D_INFO, "lock already destroyed: lock %p\n", lock);
639 /* If we're setting flags, make sure none of them are already set. */
641 if ((lock->l_flags & flags) != 0) {
642 unlock_res_and_lock(lock);
647 lock->l_flags |= flags;
650 unlock_res_and_lock(lock);
653 EXPORT_SYMBOL(__ldlm_handle2lock);
654 /** @} ldlm_handles */
657 * Fill in "on the wire" representation for given LDLM lock into supplied
658 * lock descriptor \a desc structure.
660 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc)
662 ldlm_res2desc(lock->l_resource, &desc->l_resource);
663 desc->l_req_mode = lock->l_req_mode;
664 desc->l_granted_mode = lock->l_granted_mode;
665 ldlm_convert_policy_to_wire(lock->l_resource->lr_type,
666 &lock->l_policy_data,
667 &desc->l_policy_data);
671 * Add a lock to list of conflicting locks to send AST to.
673 * Only add if we have not sent a blocking AST to the lock yet.
675 static void ldlm_add_bl_work_item(struct ldlm_lock *lock, struct ldlm_lock *new,
676 struct list_head *work_list)
678 if (!ldlm_is_ast_sent(lock)) {
679 LDLM_DEBUG(lock, "lock incompatible; sending blocking AST.");
680 ldlm_set_ast_sent(lock);
681 /* If the enqueuing client said so, tell the AST recipient to
682 * discard dirty data, rather than writing back. */
683 if (ldlm_is_ast_discard_data(new))
684 ldlm_set_discard_data(lock);
686 /* Lock can be converted from a blocking state back to granted
687 * after lock convert or COS downgrade but still be in an
688 * older bl_list because it is controlled only by
689 * ldlm_work_bl_ast_lock(), let it be processed there.
691 if (list_empty(&lock->l_bl_ast)) {
692 list_add(&lock->l_bl_ast, work_list);
695 LASSERT(lock->l_blocking_lock == NULL);
696 lock->l_blocking_lock = LDLM_LOCK_GET(new);
701 * Add a lock to list of just granted locks to send completion AST to.
703 static void ldlm_add_cp_work_item(struct ldlm_lock *lock,
704 struct list_head *work_list)
706 if (!ldlm_is_cp_reqd(lock)) {
707 ldlm_set_cp_reqd(lock);
708 LDLM_DEBUG(lock, "lock granted; sending completion AST.");
709 LASSERT(list_empty(&lock->l_cp_ast));
710 list_add(&lock->l_cp_ast, work_list);
716 * Aggregator function to add AST work items into a list. Determines
717 * what sort of an AST work needs to be done and calls the proper
719 * Must be called with lr_lock held.
721 void ldlm_add_ast_work_item(struct ldlm_lock *lock, struct ldlm_lock *new,
722 struct list_head *work_list)
725 check_res_locked(lock->l_resource);
727 ldlm_add_bl_work_item(lock, new, work_list);
729 ldlm_add_cp_work_item(lock, work_list);
734 * Add specified reader/writer reference to LDLM lock with handle \a lockh.
735 * r/w reference type is determined by \a mode
736 * Calls ldlm_lock_addref_internal.
738 void ldlm_lock_addref(const struct lustre_handle *lockh, enum ldlm_mode mode)
740 struct ldlm_lock *lock;
742 lock = ldlm_handle2lock(lockh);
743 LASSERTF(lock != NULL, "Non-existing lock: %#llx\n", lockh->cookie);
744 ldlm_lock_addref_internal(lock, mode);
747 EXPORT_SYMBOL(ldlm_lock_addref);
751 * Add specified reader/writer reference to LDLM lock \a lock.
752 * r/w reference type is determined by \a mode
753 * Removes lock from LRU if it is there.
754 * Assumes the LDLM lock is already locked.
756 void ldlm_lock_addref_internal_nolock(struct ldlm_lock *lock,
759 ldlm_lock_remove_from_lru(lock);
760 if (mode & (LCK_NL | LCK_CR | LCK_PR)) {
762 lu_ref_add_atomic(&lock->l_reference, "reader", lock);
764 if (mode & (LCK_EX | LCK_CW | LCK_PW | LCK_GROUP | LCK_COS)) {
766 lu_ref_add_atomic(&lock->l_reference, "writer", lock);
769 lu_ref_add_atomic(&lock->l_reference, "user", lock);
770 LDLM_DEBUG(lock, "ldlm_lock_addref(%s)", ldlm_lockname[mode]);
774 * Attempts to add reader/writer reference to a lock with handle \a lockh, and
775 * fails if lock is already LDLM_FL_CBPENDING or destroyed.
777 * \retval 0 success, lock was addref-ed
779 * \retval -EAGAIN lock is being canceled.
781 int ldlm_lock_addref_try(const struct lustre_handle *lockh, enum ldlm_mode mode)
783 struct ldlm_lock *lock;
787 lock = ldlm_handle2lock(lockh);
789 lock_res_and_lock(lock);
790 if (lock->l_readers != 0 || lock->l_writers != 0 ||
791 !ldlm_is_cbpending(lock)) {
792 ldlm_lock_addref_internal_nolock(lock, mode);
795 unlock_res_and_lock(lock);
800 EXPORT_SYMBOL(ldlm_lock_addref_try);
803 * Add specified reader/writer reference to LDLM lock \a lock.
804 * Locks LDLM lock and calls ldlm_lock_addref_internal_nolock to do the work.
805 * Only called for local locks.
807 void ldlm_lock_addref_internal(struct ldlm_lock *lock, enum ldlm_mode mode)
809 lock_res_and_lock(lock);
810 ldlm_lock_addref_internal_nolock(lock, mode);
811 unlock_res_and_lock(lock);
815 * Removes reader/writer reference for LDLM lock \a lock.
816 * Assumes LDLM lock is already locked.
817 * only called in ldlm_flock_destroy and for local locks.
818 * Does NOT add lock to LRU if no r/w references left to accomodate flock locks
819 * that cannot be placed in LRU.
821 void ldlm_lock_decref_internal_nolock(struct ldlm_lock *lock,
824 LDLM_DEBUG(lock, "ldlm_lock_decref(%s)", ldlm_lockname[mode]);
825 if (mode & (LCK_NL | LCK_CR | LCK_PR)) {
826 LASSERT(lock->l_readers > 0);
827 lu_ref_del(&lock->l_reference, "reader", lock);
830 if (mode & (LCK_EX | LCK_CW | LCK_PW | LCK_GROUP | LCK_COS)) {
831 LASSERT(lock->l_writers > 0);
832 lu_ref_del(&lock->l_reference, "writer", lock);
836 lu_ref_del(&lock->l_reference, "user", lock);
837 LDLM_LOCK_RELEASE(lock); /* matches the LDLM_LOCK_GET() in addref */
841 * Removes reader/writer reference for LDLM lock \a lock.
842 * Locks LDLM lock first.
843 * If the lock is determined to be client lock on a client and r/w refcount
844 * drops to zero and the lock is not blocked, the lock is added to LRU lock
846 * For blocked LDLM locks if r/w count drops to zero, blocking_ast is called.
848 void ldlm_lock_decref_internal(struct ldlm_lock *lock, enum ldlm_mode mode)
850 struct ldlm_namespace *ns;
853 lock_res_and_lock(lock);
855 ns = ldlm_lock_to_ns(lock);
857 ldlm_lock_decref_internal_nolock(lock, mode);
859 if ((ldlm_is_local(lock) || lock->l_req_mode == LCK_GROUP) &&
860 !lock->l_readers && !lock->l_writers) {
861 /* If this is a local lock on a server namespace and this was
862 * the last reference, cancel the lock.
864 * Group locks are special:
865 * They must not go in LRU, but they are not called back
866 * like non-group locks, instead they are manually released.
867 * They have an l_writers reference which they keep until
868 * they are manually released, so we remove them when they have
869 * no more reader or writer references. - LU-6368 */
870 ldlm_set_cbpending(lock);
873 if (!lock->l_readers && !lock->l_writers && ldlm_is_cbpending(lock)) {
874 /* If we received a blocked AST and this was the last reference,
875 * run the callback. */
876 if (ldlm_is_ns_srv(lock) && lock->l_export)
877 CERROR("FL_CBPENDING set on non-local lock--just a "
880 LDLM_DEBUG(lock, "final decref done on cbpending lock");
882 LDLM_LOCK_GET(lock); /* dropped by bl thread */
883 ldlm_lock_remove_from_lru(lock);
884 unlock_res_and_lock(lock);
886 if (ldlm_is_fail_loc(lock))
887 OBD_RACE(OBD_FAIL_LDLM_CP_BL_RACE);
889 if (ldlm_is_atomic_cb(lock) ||
890 ldlm_bl_to_thread_lock(ns, NULL, lock) != 0)
891 ldlm_handle_bl_callback(ns, NULL, lock);
892 } else if (ns_is_client(ns) &&
893 !lock->l_readers && !lock->l_writers &&
894 !ldlm_is_no_lru(lock) &&
895 !ldlm_is_bl_ast(lock) &&
896 !ldlm_is_converting(lock)) {
898 LDLM_DEBUG(lock, "add lock into lru list");
900 /* If this is a client-side namespace and this was the last
901 * reference, put it on the LRU. */
902 ldlm_lock_add_to_lru(lock);
903 unlock_res_and_lock(lock);
905 if (ldlm_is_fail_loc(lock))
906 OBD_RACE(OBD_FAIL_LDLM_CP_BL_RACE);
908 /* Call ldlm_cancel_lru() only if EARLY_CANCEL and LRU RESIZE
909 * are not supported by the server, otherwise, it is done on
911 if (!exp_connect_cancelset(lock->l_conn_export) &&
912 !ns_connect_lru_resize(ns))
913 ldlm_cancel_lru(ns, 0, LCF_ASYNC, 0);
915 LDLM_DEBUG(lock, "do not add lock into lru list");
916 unlock_res_and_lock(lock);
923 * Decrease reader/writer refcount for LDLM lock with handle \a lockh
925 void ldlm_lock_decref(const struct lustre_handle *lockh, enum ldlm_mode mode)
927 struct ldlm_lock *lock = __ldlm_handle2lock(lockh, 0);
928 LASSERTF(lock != NULL, "Non-existing lock: %#llx\n", lockh->cookie);
929 ldlm_lock_decref_internal(lock, mode);
932 EXPORT_SYMBOL(ldlm_lock_decref);
935 * Decrease reader/writer refcount for LDLM lock with handle
936 * \a lockh and mark it for subsequent cancellation once r/w refcount
937 * drops to zero instead of putting into LRU.
940 void ldlm_lock_decref_and_cancel(const struct lustre_handle *lockh,
943 struct ldlm_lock *lock = __ldlm_handle2lock(lockh, 0);
946 LASSERT(lock != NULL);
948 LDLM_DEBUG(lock, "ldlm_lock_decref(%s)", ldlm_lockname[mode]);
949 lock_res_and_lock(lock);
950 ldlm_set_cbpending(lock);
951 unlock_res_and_lock(lock);
952 ldlm_lock_decref_internal(lock, mode);
955 EXPORT_SYMBOL(ldlm_lock_decref_and_cancel);
957 struct sl_insert_point {
958 struct list_head *res_link;
959 struct list_head *mode_link;
960 struct list_head *policy_link;
964 * Finds a position to insert the new lock into granted lock list.
966 * Used for locks eligible for skiplist optimization.
969 * queue [input]: the granted list where search acts on;
970 * req [input]: the lock whose position to be located;
971 * prev [output]: positions within 3 lists to insert @req to
975 * - ldlm_grant_lock_with_skiplist
977 static void search_granted_lock(struct list_head *queue,
978 struct ldlm_lock *req,
979 struct sl_insert_point *prev)
981 struct list_head *tmp;
982 struct ldlm_lock *lock, *mode_end, *policy_end;
985 list_for_each(tmp, queue) {
986 lock = list_entry(tmp, struct ldlm_lock, l_res_link);
988 mode_end = list_entry(lock->l_sl_mode.prev,
989 struct ldlm_lock, l_sl_mode);
991 if (lock->l_req_mode != req->l_req_mode) {
992 /* jump to last lock of mode group */
993 tmp = &mode_end->l_res_link;
997 /* suitable mode group is found */
998 if (lock->l_resource->lr_type == LDLM_PLAIN) {
999 /* insert point is last lock of the mode group */
1000 prev->res_link = &mode_end->l_res_link;
1001 prev->mode_link = &mode_end->l_sl_mode;
1002 prev->policy_link = &req->l_sl_policy;
1005 } else if (lock->l_resource->lr_type == LDLM_IBITS) {
1008 list_entry(lock->l_sl_policy.prev,
1012 if (lock->l_policy_data.l_inodebits.bits ==
1013 req->l_policy_data.l_inodebits.bits) {
1014 /* insert point is last lock of
1015 * the policy group */
1017 &policy_end->l_res_link;
1019 &policy_end->l_sl_mode;
1021 &policy_end->l_sl_policy;
1026 if (policy_end == mode_end)
1027 /* done with mode group */
1030 /* go to next policy group within mode group */
1031 tmp = policy_end->l_res_link.next;
1032 lock = list_entry(tmp, struct ldlm_lock,
1034 } /* loop over policy groups within the mode group */
1036 /* insert point is last lock of the mode group,
1037 * new policy group is started */
1038 prev->res_link = &mode_end->l_res_link;
1039 prev->mode_link = &mode_end->l_sl_mode;
1040 prev->policy_link = &req->l_sl_policy;
1044 LDLM_ERROR(lock,"is not LDLM_PLAIN or LDLM_IBITS lock");
1049 /* insert point is last lock on the queue,
1050 * new mode group and new policy group are started */
1051 prev->res_link = queue->prev;
1052 prev->mode_link = &req->l_sl_mode;
1053 prev->policy_link = &req->l_sl_policy;
1059 * Add a lock into resource granted list after a position described by
1062 static void ldlm_granted_list_add_lock(struct ldlm_lock *lock,
1063 struct sl_insert_point *prev)
1065 struct ldlm_resource *res = lock->l_resource;
1068 check_res_locked(res);
1070 ldlm_resource_dump(D_INFO, res);
1071 LDLM_DEBUG(lock, "About to add lock:");
1073 if (ldlm_is_destroyed(lock)) {
1074 CDEBUG(D_OTHER, "Lock destroyed, not adding to resource\n");
1078 LASSERT(list_empty(&lock->l_res_link));
1079 LASSERT(list_empty(&lock->l_sl_mode));
1080 LASSERT(list_empty(&lock->l_sl_policy));
1083 * lock->link == prev->link means lock is first starting the group.
1084 * Don't re-add to itself to suppress kernel warnings.
1086 if (&lock->l_res_link != prev->res_link)
1087 list_add(&lock->l_res_link, prev->res_link);
1088 if (&lock->l_sl_mode != prev->mode_link)
1089 list_add(&lock->l_sl_mode, prev->mode_link);
1090 if (&lock->l_sl_policy != prev->policy_link)
1091 list_add(&lock->l_sl_policy, prev->policy_link);
1097 * Add a lock to granted list on a resource maintaining skiplist
1100 void ldlm_grant_lock_with_skiplist(struct ldlm_lock *lock)
1102 struct sl_insert_point prev;
1104 LASSERT(ldlm_is_granted(lock));
1106 search_granted_lock(&lock->l_resource->lr_granted, lock, &prev);
1107 ldlm_granted_list_add_lock(lock, &prev);
1111 * Perform lock granting bookkeeping.
1113 * Includes putting the lock into granted list and updating lock mode.
1115 * - ldlm_lock_enqueue
1116 * - ldlm_reprocess_queue
1118 * must be called with lr_lock held
1120 void ldlm_grant_lock(struct ldlm_lock *lock, struct list_head *work_list)
1122 struct ldlm_resource *res = lock->l_resource;
1125 check_res_locked(res);
1127 lock->l_granted_mode = lock->l_req_mode;
1129 if (work_list && lock->l_completion_ast != NULL)
1130 ldlm_add_ast_work_item(lock, NULL, work_list);
1132 if (res->lr_type == LDLM_PLAIN || res->lr_type == LDLM_IBITS)
1133 ldlm_grant_lock_with_skiplist(lock);
1134 else if (res->lr_type == LDLM_EXTENT)
1135 ldlm_extent_add_lock(res, lock);
1136 else if (res->lr_type == LDLM_FLOCK) {
1137 /* We should not add locks to granted list in the following
1139 * - this is an UNLOCK but not a real lock;
1140 * - this is a TEST lock;
1141 * - this is a F_CANCELLK lock (async flock has req_mode == 0)
1142 * - this is a deadlock (flock cannot be granted) */
1143 if (lock->l_req_mode == 0 ||
1144 lock->l_req_mode == LCK_NL ||
1145 ldlm_is_test_lock(lock) ||
1146 ldlm_is_flock_deadlock(lock))
1148 ldlm_resource_add_lock(res, &res->lr_granted, lock);
1153 ldlm_pool_add(&ldlm_res_to_ns(res)->ns_pool, lock);
1158 * Check if the given @lock meets the criteria for a match.
1159 * A reference on the lock is taken if matched.
1161 * \param lock test-against this lock
1162 * \param data parameters
1164 static int lock_matches(struct ldlm_lock *lock, struct ldlm_match_data *data)
1166 union ldlm_policy_data *lpol = &lock->l_policy_data;
1167 enum ldlm_mode match = LCK_MINMODE;
1169 if (lock == data->lmd_old)
1170 return INTERVAL_ITER_STOP;
1172 /* Check if this lock can be matched.
1173 * Used by LU-2919(exclusive open) for open lease lock */
1174 if (ldlm_is_excl(lock))
1175 return INTERVAL_ITER_CONT;
1177 /* llite sometimes wants to match locks that will be
1178 * canceled when their users drop, but we allow it to match
1179 * if it passes in CBPENDING and the lock still has users.
1180 * this is generally only going to be used by children
1181 * whose parents already hold a lock so forward progress
1182 * can still happen. */
1183 if (ldlm_is_cbpending(lock) &&
1184 !(data->lmd_flags & LDLM_FL_CBPENDING))
1185 return INTERVAL_ITER_CONT;
1186 if (!data->lmd_unref && ldlm_is_cbpending(lock) &&
1187 lock->l_readers == 0 && lock->l_writers == 0)
1188 return INTERVAL_ITER_CONT;
1190 if (!(lock->l_req_mode & *data->lmd_mode))
1191 return INTERVAL_ITER_CONT;
1193 /* When we search for ast_data, we are not doing a traditional match,
1194 * so we don't worry about IBITS or extent matching.
1196 if (data->lmd_has_ast_data) {
1197 if (!lock->l_ast_data)
1198 return INTERVAL_ITER_CONT;
1203 match = lock->l_req_mode;
1205 switch (lock->l_resource->lr_type) {
1207 if (lpol->l_extent.start > data->lmd_policy->l_extent.start ||
1208 lpol->l_extent.end < data->lmd_policy->l_extent.end)
1209 return INTERVAL_ITER_CONT;
1211 if (unlikely(match == LCK_GROUP) &&
1212 data->lmd_policy->l_extent.gid != LDLM_GID_ANY &&
1213 lpol->l_extent.gid != data->lmd_policy->l_extent.gid)
1214 return INTERVAL_ITER_CONT;
1217 /* We match if we have existing lock with same or wider set
1219 if ((lpol->l_inodebits.bits &
1220 data->lmd_policy->l_inodebits.bits) !=
1221 data->lmd_policy->l_inodebits.bits)
1222 return INTERVAL_ITER_CONT;
1228 /* We match if we have existing lock with same or wider set
1230 if (!data->lmd_unref && LDLM_HAVE_MASK(lock, GONE))
1231 return INTERVAL_ITER_CONT;
1233 if (!equi(data->lmd_flags & LDLM_FL_LOCAL_ONLY, ldlm_is_local(lock)))
1234 return INTERVAL_ITER_CONT;
1236 /* Filter locks by skipping flags */
1237 if (data->lmd_skip_flags & lock->l_flags)
1238 return INTERVAL_ITER_CONT;
1241 if (data->lmd_flags & LDLM_FL_TEST_LOCK) {
1242 LDLM_LOCK_GET(lock);
1243 ldlm_lock_touch_in_lru(lock);
1245 ldlm_lock_addref_internal_nolock(lock, match);
1248 *data->lmd_mode = match;
1249 data->lmd_lock = lock;
1251 return INTERVAL_ITER_STOP;
1254 static unsigned int itree_overlap_cb(struct interval_node *in, void *args)
1256 struct ldlm_interval *node = to_ldlm_interval(in);
1257 struct ldlm_match_data *data = args;
1258 struct ldlm_lock *lock;
1261 list_for_each_entry(lock, &node->li_group, l_sl_policy) {
1262 rc = lock_matches(lock, data);
1263 if (rc == INTERVAL_ITER_STOP)
1264 return INTERVAL_ITER_STOP;
1266 return INTERVAL_ITER_CONT;
1270 * Search for a lock with given parameters in interval trees.
1272 * \param res search for a lock in this resource
1273 * \param data parameters
1275 * \retval a referenced lock or NULL.
1277 struct ldlm_lock *search_itree(struct ldlm_resource *res,
1278 struct ldlm_match_data *data)
1280 struct interval_node_extent ext = {
1281 .start = data->lmd_policy->l_extent.start,
1282 .end = data->lmd_policy->l_extent.end
1286 data->lmd_lock = NULL;
1288 for (idx = 0; idx < LCK_MODE_NUM; idx++) {
1289 struct ldlm_interval_tree *tree = &res->lr_itree[idx];
1291 if (tree->lit_root == NULL)
1294 if (!(tree->lit_mode & *data->lmd_mode))
1297 interval_search(tree->lit_root, &ext,
1298 itree_overlap_cb, data);
1300 return data->lmd_lock;
1305 EXPORT_SYMBOL(search_itree);
1309 * Search for a lock with given properties in a queue.
1311 * \param queue search for a lock in this queue
1312 * \param data parameters
1314 * \retval a referenced lock or NULL.
1316 static struct ldlm_lock *search_queue(struct list_head *queue,
1317 struct ldlm_match_data *data)
1319 struct ldlm_lock *lock;
1322 data->lmd_lock = NULL;
1324 list_for_each_entry(lock, queue, l_res_link) {
1325 rc = lock_matches(lock, data);
1326 if (rc == INTERVAL_ITER_STOP)
1327 return data->lmd_lock;
1333 void ldlm_lock_fail_match_locked(struct ldlm_lock *lock)
1335 if ((lock->l_flags & LDLM_FL_FAIL_NOTIFIED) == 0) {
1336 lock->l_flags |= LDLM_FL_FAIL_NOTIFIED;
1337 wake_up_all(&lock->l_waitq);
1340 EXPORT_SYMBOL(ldlm_lock_fail_match_locked);
1342 void ldlm_lock_fail_match(struct ldlm_lock *lock)
1344 lock_res_and_lock(lock);
1345 ldlm_lock_fail_match_locked(lock);
1346 unlock_res_and_lock(lock);
1350 * Mark lock as "matchable" by OST.
1352 * Used to prevent certain races in LOV/OSC where the lock is granted, but LVB
1354 * Assumes LDLM lock is already locked.
1356 void ldlm_lock_allow_match_locked(struct ldlm_lock *lock)
1358 ldlm_set_lvb_ready(lock);
1359 wake_up_all(&lock->l_waitq);
1361 EXPORT_SYMBOL(ldlm_lock_allow_match_locked);
1364 * Mark lock as "matchable" by OST.
1365 * Locks the lock and then \see ldlm_lock_allow_match_locked
1367 void ldlm_lock_allow_match(struct ldlm_lock *lock)
1369 lock_res_and_lock(lock);
1370 ldlm_lock_allow_match_locked(lock);
1371 unlock_res_and_lock(lock);
1373 EXPORT_SYMBOL(ldlm_lock_allow_match);
1376 * Attempt to find a lock with specified properties.
1378 * Typically returns a reference to matched lock unless LDLM_FL_TEST_LOCK is
1381 * Can be called in two ways:
1383 * If 'ns' is NULL, then lockh describes an existing lock that we want to look
1384 * for a duplicate of.
1386 * Otherwise, all of the fields must be filled in, to match against.
1388 * If 'flags' contains LDLM_FL_LOCAL_ONLY, then only match local locks on the
1389 * server (ie, connh is NULL)
1390 * If 'flags' contains LDLM_FL_BLOCK_GRANTED, then only locks on the granted
1391 * list will be considered
1392 * If 'flags' contains LDLM_FL_CBPENDING, then locks that have been marked
1393 * to be canceled can still be matched as long as they still have reader
1394 * or writer refernces
1395 * If 'flags' contains LDLM_FL_TEST_LOCK, then don't actually reference a lock,
1396 * just tell us if we would have matched.
1398 * \retval 1 if it finds an already-existing lock that is compatible; in this
1399 * case, lockh is filled in with a addref()ed lock
1401 * We also check security context, and if that fails we simply return 0 (to
1402 * keep caller code unchanged), the context failure will be discovered by
1403 * caller sometime later.
1405 enum ldlm_mode ldlm_lock_match_with_skip(struct ldlm_namespace *ns,
1406 __u64 flags, __u64 skip_flags,
1407 const struct ldlm_res_id *res_id,
1408 enum ldlm_type type,
1409 union ldlm_policy_data *policy,
1410 enum ldlm_mode mode,
1411 struct lustre_handle *lockh, int unref)
1413 struct ldlm_match_data data = {
1417 .lmd_policy = policy,
1419 .lmd_skip_flags = skip_flags,
1421 .lmd_has_ast_data = false,
1423 struct ldlm_resource *res;
1424 struct ldlm_lock *lock;
1430 data.lmd_old = ldlm_handle2lock(lockh);
1431 LASSERT(data.lmd_old != NULL);
1433 ns = ldlm_lock_to_ns(data.lmd_old);
1434 res_id = &data.lmd_old->l_resource->lr_name;
1435 type = data.lmd_old->l_resource->lr_type;
1436 *data.lmd_mode = data.lmd_old->l_req_mode;
1439 res = ldlm_resource_get(ns, NULL, res_id, type, 0);
1441 LASSERT(data.lmd_old == NULL);
1445 LDLM_RESOURCE_ADDREF(res);
1447 if (res->lr_type == LDLM_EXTENT)
1448 lock = search_itree(res, &data);
1450 lock = search_queue(&res->lr_granted, &data);
1451 if (!lock && !(flags & LDLM_FL_BLOCK_GRANTED))
1452 lock = search_queue(&res->lr_waiting, &data);
1453 matched = lock ? mode : 0;
1455 LDLM_RESOURCE_DELREF(res);
1456 ldlm_resource_putref(res);
1459 ldlm_lock2handle(lock, lockh);
1460 if ((flags & LDLM_FL_LVB_READY) &&
1461 (!ldlm_is_lvb_ready(lock))) {
1462 __u64 wait_flags = LDLM_FL_LVB_READY |
1463 LDLM_FL_DESTROYED | LDLM_FL_FAIL_NOTIFIED;
1464 struct l_wait_info lwi;
1466 if (lock->l_completion_ast) {
1467 int err = lock->l_completion_ast(lock,
1468 LDLM_FL_WAIT_NOREPROC,
1471 GOTO(out_fail_match, matched = 0);
1474 lwi = LWI_TIMEOUT_INTR(cfs_time_seconds(obd_timeout),
1475 NULL, LWI_ON_SIGNAL_NOOP, NULL);
1477 /* XXX FIXME see comment on CAN_MATCH in lustre_dlm.h */
1478 l_wait_event(lock->l_waitq, lock->l_flags & wait_flags,
1480 if (!ldlm_is_lvb_ready(lock))
1481 GOTO(out_fail_match, matched = 0);
1484 /* check user's security context */
1485 if (lock->l_conn_export &&
1486 sptlrpc_import_check_ctx(
1487 class_exp2cliimp(lock->l_conn_export)))
1488 GOTO(out_fail_match, matched = 0);
1490 LDLM_DEBUG(lock, "matched (%llu %llu)",
1491 (type == LDLM_PLAIN || type == LDLM_IBITS) ?
1492 res_id->name[2] : policy->l_extent.start,
1493 (type == LDLM_PLAIN || type == LDLM_IBITS) ?
1494 res_id->name[3] : policy->l_extent.end);
1497 if (flags & LDLM_FL_TEST_LOCK)
1498 LDLM_LOCK_RELEASE(lock);
1500 ldlm_lock_decref_internal(lock, mode);
1503 /* less verbose for test-only */
1504 if (!matched && !(flags & LDLM_FL_TEST_LOCK)) {
1505 LDLM_DEBUG_NOLOCK("not matched ns %p type %u mode %u res "
1506 "%llu/%llu (%llu %llu)", ns,
1507 type, mode, res_id->name[0], res_id->name[1],
1508 (type == LDLM_PLAIN || type == LDLM_IBITS) ?
1509 res_id->name[2] : policy->l_extent.start,
1510 (type == LDLM_PLAIN || type == LDLM_IBITS) ?
1511 res_id->name[3] : policy->l_extent.end);
1513 if (data.lmd_old != NULL)
1514 LDLM_LOCK_PUT(data.lmd_old);
1518 EXPORT_SYMBOL(ldlm_lock_match_with_skip);
1520 enum ldlm_mode ldlm_revalidate_lock_handle(const struct lustre_handle *lockh,
1523 struct ldlm_lock *lock;
1524 enum ldlm_mode mode = 0;
1527 lock = ldlm_handle2lock(lockh);
1529 lock_res_and_lock(lock);
1530 if (LDLM_HAVE_MASK(lock, GONE))
1533 if (ldlm_is_cbpending(lock) &&
1534 lock->l_readers == 0 && lock->l_writers == 0)
1538 *bits = lock->l_policy_data.l_inodebits.bits;
1539 mode = lock->l_granted_mode;
1540 ldlm_lock_addref_internal_nolock(lock, mode);
1547 unlock_res_and_lock(lock);
1548 LDLM_LOCK_PUT(lock);
1552 EXPORT_SYMBOL(ldlm_revalidate_lock_handle);
1554 /** The caller must guarantee that the buffer is large enough. */
1555 int ldlm_fill_lvb(struct ldlm_lock *lock, struct req_capsule *pill,
1556 enum req_location loc, void *data, int size)
1561 LASSERT(data != NULL);
1564 switch (lock->l_lvb_type) {
1566 if (size == sizeof(struct ost_lvb)) {
1567 if (loc == RCL_CLIENT)
1568 lvb = req_capsule_client_swab_get(pill,
1570 lustre_swab_ost_lvb);
1572 lvb = req_capsule_server_swab_get(pill,
1574 lustre_swab_ost_lvb);
1575 if (unlikely(lvb == NULL)) {
1576 LDLM_ERROR(lock, "no LVB");
1580 memcpy(data, lvb, size);
1581 } else if (size == sizeof(struct ost_lvb_v1)) {
1582 struct ost_lvb *olvb = data;
1584 if (loc == RCL_CLIENT)
1585 lvb = req_capsule_client_swab_get(pill,
1587 lustre_swab_ost_lvb_v1);
1589 lvb = req_capsule_server_sized_swab_get(pill,
1591 lustre_swab_ost_lvb_v1);
1592 if (unlikely(lvb == NULL)) {
1593 LDLM_ERROR(lock, "no LVB");
1597 memcpy(data, lvb, size);
1598 olvb->lvb_mtime_ns = 0;
1599 olvb->lvb_atime_ns = 0;
1600 olvb->lvb_ctime_ns = 0;
1602 LDLM_ERROR(lock, "Replied unexpected ost LVB size %d",
1608 if (size == sizeof(struct lquota_lvb)) {
1609 if (loc == RCL_CLIENT)
1610 lvb = req_capsule_client_swab_get(pill,
1612 lustre_swab_lquota_lvb);
1614 lvb = req_capsule_server_swab_get(pill,
1616 lustre_swab_lquota_lvb);
1617 if (unlikely(lvb == NULL)) {
1618 LDLM_ERROR(lock, "no LVB");
1622 memcpy(data, lvb, size);
1624 LDLM_ERROR(lock, "Replied unexpected lquota LVB size %d",
1633 if (loc == RCL_CLIENT)
1634 lvb = req_capsule_client_get(pill, &RMF_DLM_LVB);
1636 lvb = req_capsule_server_get(pill, &RMF_DLM_LVB);
1637 if (unlikely(lvb == NULL)) {
1638 LDLM_ERROR(lock, "no LVB");
1642 memcpy(data, lvb, size);
1645 LDLM_ERROR(lock, "Unknown LVB type: %d", lock->l_lvb_type);
1646 libcfs_debug_dumpstack(NULL);
1654 * Create and fill in new LDLM lock with specified properties.
1655 * Returns a referenced lock
1657 struct ldlm_lock *ldlm_lock_create(struct ldlm_namespace *ns,
1658 const struct ldlm_res_id *res_id,
1659 enum ldlm_type type,
1660 enum ldlm_mode mode,
1661 const struct ldlm_callback_suite *cbs,
1662 void *data, __u32 lvb_len,
1663 enum lvb_type lvb_type)
1665 struct ldlm_lock *lock;
1666 struct ldlm_resource *res;
1670 res = ldlm_resource_get(ns, NULL, res_id, type, 1);
1672 RETURN(ERR_CAST(res));
1674 lock = ldlm_lock_new(res);
1676 RETURN(ERR_PTR(-ENOMEM));
1678 lock->l_req_mode = mode;
1679 lock->l_ast_data = data;
1680 lock->l_pid = current_pid();
1681 if (ns_is_server(ns))
1682 ldlm_set_ns_srv(lock);
1684 lock->l_blocking_ast = cbs->lcs_blocking;
1685 lock->l_completion_ast = cbs->lcs_completion;
1686 lock->l_glimpse_ast = cbs->lcs_glimpse;
1691 rc = ldlm_extent_alloc_lock(lock);
1694 rc = ldlm_inodebits_alloc_lock(lock);
1703 lock->l_lvb_len = lvb_len;
1704 OBD_ALLOC_LARGE(lock->l_lvb_data, lvb_len);
1705 if (lock->l_lvb_data == NULL)
1706 GOTO(out, rc = -ENOMEM);
1709 lock->l_lvb_type = lvb_type;
1710 if (OBD_FAIL_CHECK(OBD_FAIL_LDLM_NEW_LOCK))
1711 GOTO(out, rc = -ENOENT);
1716 ldlm_lock_destroy(lock);
1717 LDLM_LOCK_RELEASE(lock);
1718 RETURN(ERR_PTR(rc));
1721 #ifdef HAVE_SERVER_SUPPORT
1722 static enum ldlm_error ldlm_lock_enqueue_helper(struct ldlm_lock *lock,
1725 struct ldlm_resource *res = lock->l_resource;
1726 enum ldlm_error rc = ELDLM_OK;
1727 struct list_head rpc_list = LIST_HEAD_INIT(rpc_list);
1728 ldlm_processing_policy policy;
1732 policy = ldlm_get_processing_policy(res);
1734 policy(lock, flags, LDLM_PROCESS_ENQUEUE, &rc, &rpc_list);
1735 if (rc == ELDLM_OK && lock->l_granted_mode != lock->l_req_mode &&
1736 res->lr_type != LDLM_FLOCK) {
1737 rc = ldlm_handle_conflict_lock(lock, flags, &rpc_list);
1738 if (rc == -ERESTART)
1742 if (!list_empty(&rpc_list))
1743 ldlm_discard_bl_list(&rpc_list);
1750 * Enqueue (request) a lock.
1752 * Does not block. As a result of enqueue the lock would be put
1753 * into granted or waiting list.
1755 * If namespace has intent policy sent and the lock has LDLM_FL_HAS_INTENT flag
1756 * set, skip all the enqueueing and delegate lock processing to intent policy
1759 enum ldlm_error ldlm_lock_enqueue(const struct lu_env *env,
1760 struct ldlm_namespace *ns,
1761 struct ldlm_lock **lockp,
1762 void *cookie, __u64 *flags)
1764 struct ldlm_lock *lock = *lockp;
1765 struct ldlm_resource *res = lock->l_resource;
1766 int local = ns_is_client(ldlm_res_to_ns(res));
1767 enum ldlm_error rc = ELDLM_OK;
1768 struct ldlm_interval *node = NULL;
1771 /* policies are not executed on the client or during replay */
1772 if ((*flags & (LDLM_FL_HAS_INTENT|LDLM_FL_REPLAY)) == LDLM_FL_HAS_INTENT
1773 && !local && ns->ns_policy) {
1774 rc = ns->ns_policy(env, ns, lockp, cookie, lock->l_req_mode,
1776 if (rc == ELDLM_LOCK_REPLACED) {
1777 /* The lock that was returned has already been granted,
1778 * and placed into lockp. If it's not the same as the
1779 * one we passed in, then destroy the old one and our
1780 * work here is done. */
1781 if (lock != *lockp) {
1782 ldlm_lock_destroy(lock);
1783 LDLM_LOCK_RELEASE(lock);
1785 *flags |= LDLM_FL_LOCK_CHANGED;
1787 } else if (rc != ELDLM_OK &&
1788 ldlm_is_granted(lock)) {
1789 LASSERT(*flags & LDLM_FL_RESENT);
1790 /* It may happen that ns_policy returns an error in
1791 * resend case, object may be unlinked or just some
1792 * error occurs. It is unclear if lock reached the
1793 * client in the original reply, just leave the lock on
1794 * server, not returning it again to client. Due to
1795 * LU-6529, the server will not OOM. */
1797 } else if (rc != ELDLM_OK ||
1798 (rc == ELDLM_OK && (*flags & LDLM_FL_INTENT_ONLY))) {
1799 ldlm_lock_destroy(lock);
1804 if (*flags & LDLM_FL_RESENT) {
1805 /* Reconstruct LDLM_FL_SRV_ENQ_MASK @flags for reply.
1806 * Set LOCK_CHANGED always.
1807 * Check if the lock is granted for BLOCK_GRANTED.
1808 * Take NO_TIMEOUT from the lock as it is inherited through
1809 * LDLM_FL_INHERIT_MASK */
1810 *flags |= LDLM_FL_LOCK_CHANGED;
1811 if (!ldlm_is_granted(lock))
1812 *flags |= LDLM_FL_BLOCK_GRANTED;
1813 *flags |= lock->l_flags & LDLM_FL_NO_TIMEOUT;
1817 /* For a replaying lock, it might be already in granted list. So
1818 * unlinking the lock will cause the interval node to be freed, we
1819 * have to allocate the interval node early otherwise we can't regrant
1820 * this lock in the future. - jay */
1821 if (!local && (*flags & LDLM_FL_REPLAY) && res->lr_type == LDLM_EXTENT)
1822 OBD_SLAB_ALLOC_PTR_GFP(node, ldlm_interval_slab, GFP_NOFS);
1824 lock_res_and_lock(lock);
1825 if (local && ldlm_is_granted(lock)) {
1826 /* The server returned a blocked lock, but it was granted
1827 * before we got a chance to actually enqueue it. We don't
1828 * need to do anything else. */
1829 *flags &= ~LDLM_FL_BLOCKED_MASK;
1830 GOTO(out, rc = ELDLM_OK);
1833 ldlm_resource_unlink_lock(lock);
1834 if (res->lr_type == LDLM_EXTENT && lock->l_tree_node == NULL) {
1836 ldlm_lock_destroy_nolock(lock);
1837 GOTO(out, rc = -ENOMEM);
1840 INIT_LIST_HEAD(&node->li_group);
1841 ldlm_interval_attach(node, lock);
1845 /* Some flags from the enqueue want to make it into the AST, via the
1846 * lock's l_flags. */
1847 if (*flags & LDLM_FL_AST_DISCARD_DATA)
1848 ldlm_set_ast_discard_data(lock);
1849 if (*flags & LDLM_FL_TEST_LOCK)
1850 ldlm_set_test_lock(lock);
1851 if (*flags & LDLM_FL_COS_INCOMPAT)
1852 ldlm_set_cos_incompat(lock);
1853 if (*flags & LDLM_FL_COS_ENABLED)
1854 ldlm_set_cos_enabled(lock);
1856 /* This distinction between local lock trees is very important; a client
1857 * namespace only has information about locks taken by that client, and
1858 * thus doesn't have enough information to decide for itself if it can
1859 * be granted (below). In this case, we do exactly what the server
1860 * tells us to do, as dictated by the 'flags'.
1862 * We do exactly the same thing during recovery, when the server is
1863 * more or less trusting the clients not to lie.
1865 * FIXME (bug 268): Detect obvious lies by checking compatibility in
1868 if (*flags & (LDLM_FL_BLOCK_WAIT | LDLM_FL_BLOCK_GRANTED))
1869 ldlm_resource_add_lock(res, &res->lr_waiting, lock);
1871 ldlm_grant_lock(lock, NULL);
1872 GOTO(out, rc = ELDLM_OK);
1873 #ifdef HAVE_SERVER_SUPPORT
1874 } else if (*flags & LDLM_FL_REPLAY) {
1875 if (*flags & LDLM_FL_BLOCK_WAIT) {
1876 ldlm_resource_add_lock(res, &res->lr_waiting, lock);
1877 GOTO(out, rc = ELDLM_OK);
1878 } else if (*flags & LDLM_FL_BLOCK_GRANTED) {
1879 ldlm_grant_lock(lock, NULL);
1880 GOTO(out, rc = ELDLM_OK);
1882 /* If no flags, fall through to normal enqueue path. */
1885 rc = ldlm_lock_enqueue_helper(lock, flags);
1889 CERROR("This is client-side-only module, cannot handle "
1890 "LDLM_NAMESPACE_SERVER resource type lock.\n");
1896 unlock_res_and_lock(lock);
1898 OBD_SLAB_FREE(node, ldlm_interval_slab, sizeof(*node));
1902 #ifdef HAVE_SERVER_SUPPORT
1904 * Iterate through all waiting locks on a given resource queue and attempt to
1907 * Must be called with resource lock held.
1909 int ldlm_reprocess_queue(struct ldlm_resource *res, struct list_head *queue,
1910 struct list_head *work_list,
1911 enum ldlm_process_intention intention,
1912 struct ldlm_lock *hint)
1914 struct list_head *tmp, *pos;
1915 ldlm_processing_policy policy;
1917 int rc = LDLM_ITER_CONTINUE;
1918 enum ldlm_error err;
1919 struct list_head bl_ast_list = LIST_HEAD_INIT(bl_ast_list);
1923 check_res_locked(res);
1925 policy = ldlm_get_processing_policy(res);
1927 LASSERT(intention == LDLM_PROCESS_RESCAN ||
1928 intention == LDLM_PROCESS_RECOVERY);
1931 list_for_each_safe(tmp, pos, queue) {
1932 struct ldlm_lock *pending;
1933 struct list_head rpc_list = LIST_HEAD_INIT(rpc_list);
1935 pending = list_entry(tmp, struct ldlm_lock, l_res_link);
1937 CDEBUG(D_INFO, "Reprocessing lock %p\n", pending);
1940 rc = policy(pending, &flags, intention, &err, &rpc_list);
1941 if (pending->l_granted_mode == pending->l_req_mode ||
1942 res->lr_type == LDLM_FLOCK) {
1943 list_splice(&rpc_list, work_list);
1945 list_splice(&rpc_list, &bl_ast_list);
1948 * When this is called from recovery done, we always want
1949 * to scan the whole list no matter what 'rc' is returned.
1951 if (rc != LDLM_ITER_CONTINUE &&
1952 intention == LDLM_PROCESS_RESCAN)
1956 if (!list_empty(&bl_ast_list)) {
1959 rc = ldlm_run_ast_work(ldlm_res_to_ns(res), &bl_ast_list,
1963 if (rc == -ERESTART)
1967 if (!list_empty(&bl_ast_list))
1968 ldlm_discard_bl_list(&bl_ast_list);
1970 RETURN(intention == LDLM_PROCESS_RESCAN ? rc : LDLM_ITER_CONTINUE);
1974 * Conflicting locks are detected for a lock to be enqueued, add the lock
1975 * into waiting list and send blocking ASTs to the conflicting locks.
1977 * \param[in] lock The lock to be enqueued.
1978 * \param[out] flags Lock flags for the lock to be enqueued.
1979 * \param[in] rpc_list Conflicting locks list.
1981 * \retval -ERESTART: Some lock was instantly canceled while sending
1982 * blocking ASTs, caller needs to re-check conflicting
1984 * \retval -EAGAIN: Lock was destroyed, caller should return error.
1985 * \reval 0: Lock is successfully added in waiting list.
1987 int ldlm_handle_conflict_lock(struct ldlm_lock *lock, __u64 *flags,
1988 struct list_head *rpc_list)
1990 struct ldlm_resource *res = lock->l_resource;
1994 check_res_locked(res);
1996 /* If either of the compat_queue()s returned failure, then we
1997 * have ASTs to send and must go onto the waiting list.
1999 * bug 2322: we used to unlink and re-add here, which was a
2000 * terrible folly -- if we goto restart, we could get
2001 * re-ordered! Causes deadlock, because ASTs aren't sent! */
2002 if (list_empty(&lock->l_res_link))
2003 ldlm_resource_add_lock(res, &res->lr_waiting, lock);
2006 rc = ldlm_run_ast_work(ldlm_res_to_ns(res), rpc_list,
2009 if (OBD_FAIL_CHECK(OBD_FAIL_LDLM_OST_FAIL_RACE) &&
2010 !ns_is_client(ldlm_res_to_ns(res)))
2011 class_fail_export(lock->l_export);
2014 if (rc == -ERESTART) {
2015 /* 15715: The lock was granted and destroyed after
2016 * resource lock was dropped. Interval node was freed
2017 * in ldlm_lock_destroy. Anyway, this always happens
2018 * when a client is being evicted. So it would be
2019 * ok to return an error. -jay */
2020 if (ldlm_is_destroyed(lock))
2023 /* lock was granted while resource was unlocked. */
2024 if (ldlm_is_granted(lock)) {
2025 /* bug 11300: if the lock has been granted,
2026 * break earlier because otherwise, we will go
2027 * to restart and ldlm_resource_unlink will be
2028 * called and it causes the interval node to be
2029 * freed. Then we will fail at
2030 * ldlm_extent_add_lock() */
2031 *flags &= ~LDLM_FL_BLOCKED_MASK;
2037 *flags |= LDLM_FL_BLOCK_GRANTED;
2043 * Discard all AST work items from list.
2045 * If for whatever reason we do not want to send ASTs to conflicting locks
2046 * anymore, disassemble the list with this function.
2048 void ldlm_discard_bl_list(struct list_head *bl_list)
2050 struct ldlm_lock *lock, *tmp;
2054 list_for_each_entry_safe(lock, tmp, bl_list, l_bl_ast) {
2055 LASSERT(!list_empty(&lock->l_bl_ast));
2056 list_del_init(&lock->l_bl_ast);
2057 ldlm_clear_ast_sent(lock);
2058 LASSERT(lock->l_bl_ast_run == 0);
2059 ldlm_clear_blocking_lock(lock);
2060 LDLM_LOCK_RELEASE(lock);
2066 * Process a call to blocking AST callback for a lock in ast_work list
2069 ldlm_work_bl_ast_lock(struct ptlrpc_request_set *rqset, void *opaq)
2071 struct ldlm_cb_set_arg *arg = opaq;
2072 struct ldlm_lock *lock;
2073 struct ldlm_lock_desc d;
2074 struct ldlm_bl_desc bld;
2079 if (list_empty(arg->list))
2082 lock = list_entry(arg->list->next, struct ldlm_lock, l_bl_ast);
2084 /* nobody should touch l_bl_ast but some locks in the list may become
2085 * granted after lock convert or COS downgrade, these locks should be
2086 * just skipped here and removed from the list.
2088 lock_res_and_lock(lock);
2089 list_del_init(&lock->l_bl_ast);
2091 /* lock is not blocking lock anymore, but was kept in the list because
2092 * it can managed only here.
2094 if (!ldlm_is_ast_sent(lock)) {
2095 unlock_res_and_lock(lock);
2096 LDLM_LOCK_RELEASE(lock);
2100 LASSERT(lock->l_blocking_lock);
2101 ldlm_lock2desc(lock->l_blocking_lock, &d);
2102 /* copy blocking lock ibits in cancel_bits as well,
2103 * new client may use them for lock convert and it is
2104 * important to use new field to convert locks from
2107 d.l_policy_data.l_inodebits.cancel_bits =
2108 lock->l_blocking_lock->l_policy_data.l_inodebits.bits;
2110 /* Blocking lock is being destroyed here but some information about it
2111 * may be needed inside l_blocking_ast() function below,
2112 * e.g. in mdt_blocking_ast(). So save needed data in bl_desc.
2114 bld.bl_same_client = lock->l_client_cookie ==
2115 lock->l_blocking_lock->l_client_cookie;
2116 bld.bl_cos_incompat = ldlm_is_cos_incompat(lock->l_blocking_lock);
2117 arg->bl_desc = &bld;
2119 LASSERT(ldlm_is_ast_sent(lock));
2120 LASSERT(lock->l_bl_ast_run == 0);
2121 lock->l_bl_ast_run++;
2122 ldlm_clear_blocking_lock(lock);
2123 unlock_res_and_lock(lock);
2125 rc = lock->l_blocking_ast(lock, &d, (void *)arg, LDLM_CB_BLOCKING);
2127 LDLM_LOCK_RELEASE(lock);
2133 * Process a call to revocation AST callback for a lock in ast_work list
2136 ldlm_work_revoke_ast_lock(struct ptlrpc_request_set *rqset, void *opaq)
2138 struct ldlm_cb_set_arg *arg = opaq;
2139 struct ldlm_lock_desc desc;
2141 struct ldlm_lock *lock;
2144 if (list_empty(arg->list))
2147 lock = list_entry(arg->list->next, struct ldlm_lock, l_rk_ast);
2148 list_del_init(&lock->l_rk_ast);
2150 /* the desc just pretend to exclusive */
2151 ldlm_lock2desc(lock, &desc);
2152 desc.l_req_mode = LCK_EX;
2153 desc.l_granted_mode = 0;
2155 rc = lock->l_blocking_ast(lock, &desc, (void*)arg, LDLM_CB_BLOCKING);
2156 LDLM_LOCK_RELEASE(lock);
2162 * Process a call to glimpse AST callback for a lock in ast_work list
2164 int ldlm_work_gl_ast_lock(struct ptlrpc_request_set *rqset, void *opaq)
2166 struct ldlm_cb_set_arg *arg = opaq;
2167 struct ldlm_glimpse_work *gl_work;
2168 struct ldlm_lock *lock;
2172 if (list_empty(arg->list))
2175 gl_work = list_entry(arg->list->next, struct ldlm_glimpse_work,
2177 list_del_init(&gl_work->gl_list);
2179 lock = gl_work->gl_lock;
2181 /* transfer the glimpse descriptor to ldlm_cb_set_arg */
2182 arg->gl_desc = gl_work->gl_desc;
2183 arg->gl_interpret_reply = gl_work->gl_interpret_reply;
2184 arg->gl_interpret_data = gl_work->gl_interpret_data;
2186 /* invoke the actual glimpse callback */
2187 if (lock->l_glimpse_ast(lock, (void*)arg) == 0)
2190 LDLM_LOCK_RELEASE(lock);
2191 if (gl_work->gl_flags & LDLM_GL_WORK_SLAB_ALLOCATED)
2192 OBD_SLAB_FREE_PTR(gl_work, ldlm_glimpse_work_kmem);
2194 OBD_FREE_PTR(gl_work);
2201 * Process a call to completion AST callback for a lock in ast_work list
2204 ldlm_work_cp_ast_lock(struct ptlrpc_request_set *rqset, void *opaq)
2206 struct ldlm_cb_set_arg *arg = opaq;
2207 struct ldlm_lock *lock;
2208 ldlm_completion_callback completion_callback;
2213 if (list_empty(arg->list))
2216 lock = list_entry(arg->list->next, struct ldlm_lock, l_cp_ast);
2218 /* It's possible to receive a completion AST before we've set
2219 * the l_completion_ast pointer: either because the AST arrived
2220 * before the reply, or simply because there's a small race
2221 * window between receiving the reply and finishing the local
2222 * enqueue. (bug 842)
2224 * This can't happen with the blocking_ast, however, because we
2225 * will never call the local blocking_ast until we drop our
2226 * reader/writer reference, which we won't do until we get the
2227 * reply and finish enqueueing. */
2229 /* nobody should touch l_cp_ast */
2230 lock_res_and_lock(lock);
2231 list_del_init(&lock->l_cp_ast);
2232 LASSERT(ldlm_is_cp_reqd(lock));
2233 /* save l_completion_ast since it can be changed by
2234 * mds_intent_policy(), see bug 14225 */
2235 completion_callback = lock->l_completion_ast;
2236 ldlm_clear_cp_reqd(lock);
2237 unlock_res_and_lock(lock);
2239 if (completion_callback != NULL)
2240 rc = completion_callback(lock, 0, (void *)arg);
2241 LDLM_LOCK_RELEASE(lock);
2247 * Process list of locks in need of ASTs being sent.
2249 * Used on server to send multiple ASTs together instead of sending one by
2252 int ldlm_run_ast_work(struct ldlm_namespace *ns, struct list_head *rpc_list,
2253 ldlm_desc_ast_t ast_type)
2255 struct ldlm_cb_set_arg *arg;
2256 set_producer_func work_ast_lock;
2259 if (list_empty(rpc_list))
2266 atomic_set(&arg->restart, 0);
2267 arg->list = rpc_list;
2270 case LDLM_WORK_CP_AST:
2271 arg->type = LDLM_CP_CALLBACK;
2272 work_ast_lock = ldlm_work_cp_ast_lock;
2274 #ifdef HAVE_SERVER_SUPPORT
2275 case LDLM_WORK_BL_AST:
2276 arg->type = LDLM_BL_CALLBACK;
2277 work_ast_lock = ldlm_work_bl_ast_lock;
2279 case LDLM_WORK_REVOKE_AST:
2280 arg->type = LDLM_BL_CALLBACK;
2281 work_ast_lock = ldlm_work_revoke_ast_lock;
2283 case LDLM_WORK_GL_AST:
2284 arg->type = LDLM_GL_CALLBACK;
2285 work_ast_lock = ldlm_work_gl_ast_lock;
2292 /* We create a ptlrpc request set with flow control extension.
2293 * This request set will use the work_ast_lock function to produce new
2294 * requests and will send a new request each time one completes in order
2295 * to keep the number of requests in flight to ns_max_parallel_ast */
2296 arg->set = ptlrpc_prep_fcset(ns->ns_max_parallel_ast ? : UINT_MAX,
2297 work_ast_lock, arg);
2298 if (arg->set == NULL)
2299 GOTO(out, rc = -ENOMEM);
2301 ptlrpc_set_wait(NULL, arg->set);
2302 ptlrpc_set_destroy(arg->set);
2304 rc = atomic_read(&arg->restart) ? -ERESTART : 0;
2312 * Try to grant all waiting locks on a resource.
2314 * Calls ldlm_reprocess_queue on waiting queue.
2316 * Typically called after some resource locks are cancelled to see
2317 * if anything could be granted as a result of the cancellation.
2319 static void __ldlm_reprocess_all(struct ldlm_resource *res,
2320 enum ldlm_process_intention intention,
2321 struct ldlm_lock *hint)
2323 struct list_head rpc_list;
2324 #ifdef HAVE_SERVER_SUPPORT
2325 ldlm_reprocessing_policy reprocess;
2326 struct obd_device *obd;
2331 INIT_LIST_HEAD(&rpc_list);
2332 /* Local lock trees don't get reprocessed. */
2333 if (ns_is_client(ldlm_res_to_ns(res))) {
2338 /* Disable reprocess during lock replay stage but allow during
2339 * request replay stage.
2341 obd = ldlm_res_to_ns(res)->ns_obd;
2342 if (obd->obd_recovering &&
2343 atomic_read(&obd->obd_req_replay_clients) == 0)
2347 reprocess = ldlm_get_reprocessing_policy(res);
2348 reprocess(res, &res->lr_waiting, &rpc_list, intention, hint);
2351 rc = ldlm_run_ast_work(ldlm_res_to_ns(res), &rpc_list,
2353 if (rc == -ERESTART) {
2354 LASSERT(list_empty(&rpc_list));
2360 INIT_LIST_HEAD(&rpc_list);
2361 if (!ns_is_client(ldlm_res_to_ns(res))) {
2362 CERROR("This is client-side-only module, cannot handle "
2363 "LDLM_NAMESPACE_SERVER resource type lock.\n");
2370 void ldlm_reprocess_all(struct ldlm_resource *res, struct ldlm_lock *hint)
2372 __ldlm_reprocess_all(res, LDLM_PROCESS_RESCAN, hint);
2374 EXPORT_SYMBOL(ldlm_reprocess_all);
2376 static int ldlm_reprocess_res(struct cfs_hash *hs, struct cfs_hash_bd *bd,
2377 struct hlist_node *hnode, void *arg)
2379 struct ldlm_resource *res = cfs_hash_object(hs, hnode);
2381 /* This is only called once after recovery done. LU-8306. */
2382 __ldlm_reprocess_all(res, LDLM_PROCESS_RECOVERY, NULL);
2387 * Iterate through all resources on a namespace attempting to grant waiting
2390 void ldlm_reprocess_recovery_done(struct ldlm_namespace *ns)
2395 cfs_hash_for_each_nolock(ns->ns_rs_hash,
2396 ldlm_reprocess_res, NULL, 0);
2402 * Helper function to call blocking AST for LDLM lock \a lock in a
2403 * "cancelling" mode.
2405 void ldlm_cancel_callback(struct ldlm_lock *lock)
2407 check_res_locked(lock->l_resource);
2408 if (!ldlm_is_cancel(lock)) {
2409 ldlm_set_cancel(lock);
2410 if (lock->l_blocking_ast) {
2411 unlock_res_and_lock(lock);
2412 lock->l_blocking_ast(lock, NULL, lock->l_ast_data,
2414 lock_res_and_lock(lock);
2416 LDLM_DEBUG(lock, "no blocking ast");
2419 /* only canceller can set bl_done bit */
2420 ldlm_set_bl_done(lock);
2421 wake_up_all(&lock->l_waitq);
2422 } else if (!ldlm_is_bl_done(lock)) {
2423 /* The lock is guaranteed to have been canceled once
2424 * returning from this function. */
2425 unlock_res_and_lock(lock);
2426 wait_event_idle(lock->l_waitq, is_bl_done(lock));
2427 lock_res_and_lock(lock);
2432 * Remove skiplist-enabled LDLM lock \a req from granted list
2434 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req)
2436 if (req->l_resource->lr_type != LDLM_PLAIN &&
2437 req->l_resource->lr_type != LDLM_IBITS)
2440 list_del_init(&req->l_sl_policy);
2441 list_del_init(&req->l_sl_mode);
2445 * Attempts to cancel LDLM lock \a lock that has no reader/writer references.
2447 void ldlm_lock_cancel(struct ldlm_lock *lock)
2449 struct ldlm_resource *res;
2450 struct ldlm_namespace *ns;
2453 lock_res_and_lock(lock);
2455 res = lock->l_resource;
2456 ns = ldlm_res_to_ns(res);
2458 /* Please do not, no matter how tempting, remove this LBUG without
2459 * talking to me first. -phik */
2460 if (lock->l_readers || lock->l_writers) {
2461 LDLM_ERROR(lock, "lock still has references");
2462 unlock_res_and_lock(lock);
2466 if (ldlm_is_waited(lock))
2467 ldlm_del_waiting_lock(lock);
2469 /* Releases cancel callback. */
2470 ldlm_cancel_callback(lock);
2472 /* Yes, second time, just in case it was added again while we were
2473 * running with no res lock in ldlm_cancel_callback */
2474 if (ldlm_is_waited(lock))
2475 ldlm_del_waiting_lock(lock);
2477 ldlm_resource_unlink_lock(lock);
2478 ldlm_lock_destroy_nolock(lock);
2480 if (ldlm_is_granted(lock))
2481 ldlm_pool_del(&ns->ns_pool, lock);
2483 /* Make sure we will not be called again for same lock what is possible
2484 * if not to zero out lock->l_granted_mode */
2485 lock->l_granted_mode = LCK_MINMODE;
2486 unlock_res_and_lock(lock);
2490 EXPORT_SYMBOL(ldlm_lock_cancel);
2493 * Set opaque data into the lock that only makes sense to upper layer.
2495 int ldlm_lock_set_data(const struct lustre_handle *lockh, void *data)
2497 struct ldlm_lock *lock = ldlm_handle2lock(lockh);
2502 if (lock->l_ast_data == NULL)
2503 lock->l_ast_data = data;
2504 if (lock->l_ast_data == data)
2506 LDLM_LOCK_PUT(lock);
2510 EXPORT_SYMBOL(ldlm_lock_set_data);
2512 struct export_cl_data {
2513 const struct lu_env *ecl_env;
2514 struct obd_export *ecl_exp;
2518 static void ldlm_cancel_lock_for_export(struct obd_export *exp,
2519 struct ldlm_lock *lock,
2520 struct export_cl_data *ecl)
2522 struct ldlm_resource *res;
2524 res = ldlm_resource_getref(lock->l_resource);
2526 ldlm_lvbo_update(res, lock, NULL, 1);
2527 ldlm_lock_cancel(lock);
2528 if (!exp->exp_obd->obd_stopping)
2529 ldlm_reprocess_all(res, lock);
2530 ldlm_resource_putref(res);
2533 if ((ecl->ecl_loop & -ecl->ecl_loop) == ecl->ecl_loop) {
2534 CDEBUG(D_INFO, "Export %p, %d locks cancelled.\n",
2535 exp, ecl->ecl_loop);
2540 * Iterator function for ldlm_export_cancel_locks.
2541 * Cancels passed locks.
2544 ldlm_cancel_locks_for_export_cb(struct cfs_hash *hs, struct cfs_hash_bd *bd,
2545 struct hlist_node *hnode, void *data)
2548 struct export_cl_data *ecl = (struct export_cl_data *)data;
2549 struct obd_export *exp = ecl->ecl_exp;
2550 struct ldlm_lock *lock = cfs_hash_object(hs, hnode);
2552 LDLM_LOCK_GET(lock);
2553 ldlm_cancel_lock_for_export(exp, lock, ecl);
2554 LDLM_LOCK_RELEASE(lock);
2560 * Cancel all blocked locks for given export.
2562 * Typically called on client disconnection/eviction
2564 int ldlm_export_cancel_blocked_locks(struct obd_export *exp)
2567 struct export_cl_data ecl = {
2573 rc = lu_env_init(&env, LCT_DT_THREAD);
2578 while (!list_empty(&exp->exp_bl_list)) {
2579 struct ldlm_lock *lock;
2581 spin_lock_bh(&exp->exp_bl_list_lock);
2582 if (!list_empty(&exp->exp_bl_list)) {
2583 lock = list_entry(exp->exp_bl_list.next,
2584 struct ldlm_lock, l_exp_list);
2585 LDLM_LOCK_GET(lock);
2586 list_del_init(&lock->l_exp_list);
2590 spin_unlock_bh(&exp->exp_bl_list_lock);
2595 ldlm_cancel_lock_for_export(exp, lock, &ecl);
2596 LDLM_LOCK_RELEASE(lock);
2601 CDEBUG(D_DLMTRACE, "Export %p, canceled %d locks, "
2602 "left on hash table %d.\n", exp, ecl.ecl_loop,
2603 atomic_read(&exp->exp_lock_hash->hs_count));
2605 return ecl.ecl_loop;
2609 * Cancel all locks for given export.
2611 * Typically called after client disconnection/eviction
2613 int ldlm_export_cancel_locks(struct obd_export *exp)
2615 struct export_cl_data ecl;
2619 rc = lu_env_init(&env, LCT_DT_THREAD);
2626 cfs_hash_for_each_empty(exp->exp_lock_hash,
2627 ldlm_cancel_locks_for_export_cb, &ecl);
2629 CDEBUG(D_DLMTRACE, "Export %p, canceled %d locks, "
2630 "left on hash table %d.\n", exp, ecl.ecl_loop,
2631 atomic_read(&exp->exp_lock_hash->hs_count));
2633 if (ecl.ecl_loop > 0 &&
2634 atomic_read(&exp->exp_lock_hash->hs_count) == 0 &&
2635 exp->exp_obd->obd_stopping)
2636 ldlm_reprocess_recovery_done(exp->exp_obd->obd_namespace);
2640 return ecl.ecl_loop;
2644 * Downgrade an PW/EX lock to COS | CR mode.
2646 * A lock mode convertion from PW/EX mode to less conflict mode. The
2647 * convertion may fail if lock was canceled before downgrade, but it doesn't
2648 * indicate any problem, because such lock has no reader or writer, and will
2651 * Used by Commit on Sharing (COS) code to force object changes commit in case
2652 * of conflict. Converted lock is considered as new lock and all blocking AST
2653 * things are cleared, so any pending or new blocked lock on that lock will
2654 * cause new call to blocking_ast and force resource object commit.
2656 * Also used by layout_change to replace EX lock to CR lock.
2658 * \param lock A lock to convert
2659 * \param new_mode new lock mode
2661 void ldlm_lock_mode_downgrade(struct ldlm_lock *lock, enum ldlm_mode new_mode)
2663 #ifdef HAVE_SERVER_SUPPORT
2666 LASSERT(new_mode == LCK_COS || new_mode == LCK_CR);
2668 lock_res_and_lock(lock);
2670 if (!(lock->l_granted_mode & (LCK_PW | LCK_EX))) {
2671 unlock_res_and_lock(lock);
2673 LASSERT(lock->l_granted_mode == LCK_MINMODE);
2674 LDLM_DEBUG(lock, "lock was canceled before downgrade");
2678 ldlm_resource_unlink_lock(lock);
2680 * Remove the lock from pool as it will be added again in
2681 * ldlm_grant_lock() called below.
2683 ldlm_pool_del(&ldlm_lock_to_ns(lock)->ns_pool, lock);
2685 /* Consider downgraded lock as a new lock and clear all states
2686 * related to a previous blocking AST processing.
2688 ldlm_clear_blocking_data(lock);
2690 lock->l_req_mode = new_mode;
2691 ldlm_grant_lock(lock, NULL);
2692 unlock_res_and_lock(lock);
2694 ldlm_reprocess_all(lock->l_resource, lock);
2699 EXPORT_SYMBOL(ldlm_lock_mode_downgrade);
2702 * Print lock with lock handle \a lockh description into debug log.
2704 * Used when printing all locks on a resource for debug purposes.
2706 void ldlm_lock_dump_handle(int level, const struct lustre_handle *lockh)
2708 struct ldlm_lock *lock;
2710 if (!((libcfs_debug | D_ERROR) & level))
2713 lock = ldlm_handle2lock(lockh);
2717 LDLM_DEBUG_LIMIT(level, lock, "###");
2719 LDLM_LOCK_PUT(lock);
2721 EXPORT_SYMBOL(ldlm_lock_dump_handle);
2724 * Print lock information with custom message into debug log.
2727 void _ldlm_lock_debug(struct ldlm_lock *lock,
2728 struct libcfs_debug_msg_data *msgdata,
2729 const char *fmt, ...)
2732 struct obd_export *exp = lock->l_export;
2733 struct ldlm_resource *resource = NULL;
2734 struct va_format vaf;
2735 char *nid = "local";
2737 /* on server-side resource of lock doesn't change */
2738 if ((lock->l_flags & LDLM_FL_NS_SRV) != 0) {
2739 if (lock->l_resource != NULL)
2740 resource = ldlm_resource_getref(lock->l_resource);
2741 } else if (spin_trylock(&lock->l_lock)) {
2742 if (lock->l_resource != NULL)
2743 resource = ldlm_resource_getref(lock->l_resource);
2744 spin_unlock(&lock->l_lock);
2747 va_start(args, fmt);
2751 if (exp && exp->exp_connection) {
2752 nid = obd_export_nid2str(exp);
2753 } else if (exp && exp->exp_obd != NULL) {
2754 struct obd_import *imp = exp->exp_obd->u.cli.cl_import;
2755 nid = obd_import_nid2str(imp);
2758 if (resource == NULL) {
2759 libcfs_debug_msg(msgdata,
2760 "%pV ns: \?\? lock: %p/%#llx lrc: %d/%d,%d mode: %s/%s res: \?\? rrc=\?\? type: \?\?\? flags: %#llx nid: %s remote: %#llx expref: %d pid: %u timeout: %lld lvb_type: %d\n",
2763 lock->l_handle.h_cookie,
2764 atomic_read(&lock->l_refc),
2765 lock->l_readers, lock->l_writers,
2766 ldlm_lockname[lock->l_granted_mode],
2767 ldlm_lockname[lock->l_req_mode],
2769 lock->l_remote_handle.cookie,
2770 exp ? atomic_read(&exp->exp_refcount) : -99,
2771 lock->l_pid, lock->l_callback_timeout,
2777 switch (resource->lr_type) {
2779 libcfs_debug_msg(msgdata,
2780 "%pV ns: %s lock: %p/%#llx lrc: %d/%d,%d mode: %s/%s res: " DLDLMRES " rrc: %d type: %s [%llu->%llu] (req %llu->%llu) flags: %#llx nid: %s remote: %#llx expref: %d pid: %u timeout: %lld lvb_type: %d\n",
2782 ldlm_lock_to_ns_name(lock), lock,
2783 lock->l_handle.h_cookie,
2784 atomic_read(&lock->l_refc),
2785 lock->l_readers, lock->l_writers,
2786 ldlm_lockname[lock->l_granted_mode],
2787 ldlm_lockname[lock->l_req_mode],
2789 atomic_read(&resource->lr_refcount),
2790 ldlm_typename[resource->lr_type],
2791 lock->l_policy_data.l_extent.start,
2792 lock->l_policy_data.l_extent.end,
2793 lock->l_req_extent.start, lock->l_req_extent.end,
2795 lock->l_remote_handle.cookie,
2796 exp ? atomic_read(&exp->exp_refcount) : -99,
2797 lock->l_pid, lock->l_callback_timeout,
2802 libcfs_debug_msg(msgdata,
2803 "%pV ns: %s lock: %p/%#llx lrc: %d/%d,%d mode: %s/%s res: " DLDLMRES " rrc: %d type: %s pid: %d [%llu->%llu] flags: %#llx nid: %s remote: %#llx expref: %d pid: %u timeout: %lld\n",
2805 ldlm_lock_to_ns_name(lock), lock,
2806 lock->l_handle.h_cookie,
2807 atomic_read(&lock->l_refc),
2808 lock->l_readers, lock->l_writers,
2809 ldlm_lockname[lock->l_granted_mode],
2810 ldlm_lockname[lock->l_req_mode],
2812 atomic_read(&resource->lr_refcount),
2813 ldlm_typename[resource->lr_type],
2814 lock->l_policy_data.l_flock.pid,
2815 lock->l_policy_data.l_flock.start,
2816 lock->l_policy_data.l_flock.end,
2818 lock->l_remote_handle.cookie,
2819 exp ? atomic_read(&exp->exp_refcount) : -99,
2820 lock->l_pid, lock->l_callback_timeout);
2824 libcfs_debug_msg(msgdata,
2825 "%pV ns: %s lock: %p/%#llx lrc: %d/%d,%d mode: %s/%s res: " DLDLMRES " bits %#llx/%#llx rrc: %d type: %s flags: %#llx nid: %s remote: %#llx expref: %d pid: %u timeout: %lld lvb_type: %d\n",
2827 ldlm_lock_to_ns_name(lock),
2828 lock, lock->l_handle.h_cookie,
2829 atomic_read(&lock->l_refc),
2830 lock->l_readers, lock->l_writers,
2831 ldlm_lockname[lock->l_granted_mode],
2832 ldlm_lockname[lock->l_req_mode],
2834 lock->l_policy_data.l_inodebits.bits,
2835 lock->l_policy_data.l_inodebits.try_bits,
2836 atomic_read(&resource->lr_refcount),
2837 ldlm_typename[resource->lr_type],
2839 lock->l_remote_handle.cookie,
2840 exp ? atomic_read(&exp->exp_refcount) : -99,
2841 lock->l_pid, lock->l_callback_timeout,
2846 libcfs_debug_msg(msgdata,
2847 "%pV ns: %s lock: %p/%#llx lrc: %d/%d,%d mode: %s/%s res: " DLDLMRES " rrc: %d type: %s flags: %#llx nid: %s remote: %#llx expref: %d pid: %u timeout: %lld lvb_type: %d\n",
2849 ldlm_lock_to_ns_name(lock),
2850 lock, lock->l_handle.h_cookie,
2851 atomic_read(&lock->l_refc),
2852 lock->l_readers, lock->l_writers,
2853 ldlm_lockname[lock->l_granted_mode],
2854 ldlm_lockname[lock->l_req_mode],
2856 atomic_read(&resource->lr_refcount),
2857 ldlm_typename[resource->lr_type],
2859 lock->l_remote_handle.cookie,
2860 exp ? atomic_read(&exp->exp_refcount) : -99,
2861 lock->l_pid, lock->l_callback_timeout,
2866 ldlm_resource_putref(resource);
2868 EXPORT_SYMBOL(_ldlm_lock_debug);