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/
32 * This file contains Asynchronous System Trap (AST) handlers and related
33 * LDLM request-processing routines.
35 * An AST is a callback issued on a lock when its state is changed. There are
36 * several different types of ASTs (callbacks) registered for each lock:
38 * - completion AST: when a lock is enqueued by some process, but cannot be
39 * granted immediately due to other conflicting locks on the same resource,
40 * the completion AST is sent to notify the caller when the lock is
43 * - blocking AST: when a lock is granted to some process, if another process
44 * enqueues a conflicting (blocking) lock on a resource, a blocking AST is
45 * sent to notify the holder(s) of the lock(s) of the conflicting lock
46 * request. The lock holder(s) must release their lock(s) on that resource in
47 * a timely manner or be evicted by the server.
49 * - glimpse AST: this is used when a process wants information about a lock
50 * (i.e. the lock value block (LVB)) but does not necessarily require holding
51 * the lock. If the resource is locked, the lock holder(s) are sent glimpse
52 * ASTs and the LVB is returned to the caller, and lock holder(s) may CANCEL
53 * their lock(s) if they are idle. If the resource is not locked, the server
57 #define DEBUG_SUBSYSTEM S_LDLM
59 #include <lustre_errno.h>
60 #include <lustre_dlm.h>
61 #include <obd_class.h>
64 #include "ldlm_internal.h"
66 unsigned int ldlm_enqueue_min = OBD_TIMEOUT_DEFAULT;
67 module_param(ldlm_enqueue_min, uint, 0644);
68 MODULE_PARM_DESC(ldlm_enqueue_min, "lock enqueue timeout minimum");
69 EXPORT_SYMBOL(ldlm_enqueue_min);
71 /* in client side, whether the cached locks will be canceled before replay */
72 unsigned int ldlm_cancel_unused_locks_before_replay = 1;
74 struct lock_wait_data {
75 struct ldlm_lock *lwd_lock;
79 struct ldlm_async_args {
80 struct lustre_handle lock_handle;
84 * ldlm_request_bufsize
86 * If opcode=LDLM_ENQUEUE, 1 slot is already occupied,
87 * LDLM_LOCKREQ_HANDLE -1 slots are available.
88 * Otherwise, LDLM_LOCKREQ_HANDLE slots are available.
93 * \retval size of the request buffer
95 int ldlm_request_bufsize(int count, int type)
97 int avail = LDLM_LOCKREQ_HANDLES;
99 if (type == LDLM_ENQUEUE)
100 avail -= LDLM_ENQUEUE_CANCEL_OFF;
103 avail = (count - avail) * sizeof(struct lustre_handle);
107 return sizeof(struct ldlm_request) + avail;
110 void ldlm_expired_completion_wait(struct lock_wait_data *lwd)
112 struct ldlm_lock *lock = lwd->lwd_lock;
113 struct obd_import *imp;
114 struct obd_device *obd;
117 if (lock->l_conn_export == NULL) {
118 static time64_t next_dump, last_dump;
121 "lock timed out (enqueued at %lld, %llds ago); not entering recovery in server code, just going back to sleep",
123 ktime_get_real_seconds() - lock->l_activity);
124 if (ktime_get_seconds() > next_dump) {
125 last_dump = next_dump;
126 next_dump = ktime_get_seconds() + 300;
127 ldlm_namespace_dump(D_DLMTRACE,
128 ldlm_lock_to_ns(lock));
130 libcfs_debug_dumplog();
135 obd = lock->l_conn_export->exp_obd;
136 imp = obd->u.cli.cl_import;
137 ptlrpc_fail_import(imp, lwd->lwd_conn_cnt);
139 "lock timed out (enqueued at %lld, %llds ago), entering recovery for %s@%s",
141 ktime_get_real_seconds() - lock->l_activity,
142 obd2cli_tgt(obd), imp->imp_connection->c_remote_uuid.uuid);
147 int is_granted_or_cancelled_nolock(struct ldlm_lock *lock)
151 check_res_locked(lock->l_resource);
152 if (ldlm_is_granted(lock) && !ldlm_is_cp_reqd(lock))
154 else if (ldlm_is_failed(lock) || ldlm_is_cancel(lock))
158 EXPORT_SYMBOL(is_granted_or_cancelled_nolock);
161 * Calculate the Completion timeout (covering enqueue, BL AST, data flush,
162 * lock cancel, and their replies). Used for lock completion timeout on the
165 * \param[in] lock lock which is waiting the completion callback
167 * \retval timeout in seconds to wait for the server reply
170 * We use the same basis for both server side and client side functions
171 * from a single node.
173 static timeout_t ldlm_cp_timeout(struct ldlm_lock *lock)
181 * Wait a long time for enqueue - server may have to callback a
182 * lock from another client. Server will evict the other client if it
183 * doesn't respond reasonably, and then give us the lock.
185 timeout = at_get(ldlm_lock_to_ns_at(lock));
186 return max(3 * timeout, (timeout_t)ldlm_enqueue_min);
190 * Helper function for ldlm_completion_ast(), updating timings when lock is
193 static int ldlm_completion_tail(struct ldlm_lock *lock, void *data)
197 if (ldlm_is_destroyed(lock) || ldlm_is_failed(lock)) {
198 LDLM_DEBUG(lock, "client-side enqueue: destroyed");
200 } else if (data == NULL) {
201 LDLM_DEBUG(lock, "client-side enqueue: granted");
203 /* Take into AT only CP RPC, not immediately granted locks */
206 /* Discard negative timeouts. We should also limit the
207 * maximum value of the timeout
209 if (ktime_get_real_seconds() > lock->l_activity)
210 delay = ktime_get_real_seconds() - lock->l_activity;
212 LDLM_DEBUG(lock, "client-side enqueue: granted after %ds",
214 /* Update our time estimate */
215 at_measured(ldlm_lock_to_ns_at(lock), delay);
221 * Implementation of ->l_completion_ast() for a client, that doesn't wait
222 * until lock is granted. Suitable for locks enqueued through ptlrpcd, of
223 * other threads that cannot block for long.
225 int ldlm_completion_ast_async(struct ldlm_lock *lock, __u64 flags, void *data)
229 if (flags == LDLM_FL_WAIT_NOREPROC) {
230 LDLM_DEBUG(lock, "client-side enqueue waiting on pending lock");
234 if (!(flags & LDLM_FL_BLOCKED_MASK)) {
235 wake_up(&lock->l_waitq);
236 RETURN(ldlm_completion_tail(lock, data));
240 "client-side enqueue returned a blocked lock, going forward");
241 ldlm_reprocess_all(lock->l_resource, NULL);
244 EXPORT_SYMBOL(ldlm_completion_ast_async);
247 * Generic LDLM "completion" AST. This is called in several cases:
249 * - when a reply to an ENQUEUE RPC is received from the server
250 * (ldlm_cli_enqueue_fini()). Lock might be granted or not granted at
251 * this point (determined by flags);
253 * - when LDLM_CP_CALLBACK RPC comes to client to notify it that lock has
256 * - when ldlm_lock_match(LDLM_FL_LVB_READY) is about to wait until lock
259 * - to force all locks when resource is destroyed (cleanup_resource());
261 * If lock is not granted in the first case, this function waits until second
262 * or penultimate cases happen in some other thread.
265 int ldlm_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data)
267 /* XXX ALLOCATE - 160 bytes */
268 struct lock_wait_data lwd;
269 struct obd_device *obd;
270 struct obd_import *imp = NULL;
276 if (flags == LDLM_FL_WAIT_NOREPROC) {
277 LDLM_DEBUG(lock, "client-side enqueue waiting on pending lock");
281 if (!(flags & LDLM_FL_BLOCKED_MASK)) {
282 wake_up(&lock->l_waitq);
286 LDLM_DEBUG(lock, "client-side enqueue returned a blocked locksleeping");
290 obd = class_exp2obd(lock->l_conn_export);
292 /* if this is a local lock, then there is no import */
294 imp = obd->u.cli.cl_import;
296 timeout = ldlm_cp_timeout(lock);
299 lock->l_activity = ktime_get_real_seconds();
302 spin_lock(&imp->imp_lock);
303 lwd.lwd_conn_cnt = imp->imp_conn_cnt;
304 spin_unlock(&imp->imp_lock);
307 if (ns_is_client(ldlm_lock_to_ns(lock)) &&
308 OBD_FAIL_CHECK_RESET(OBD_FAIL_LDLM_INTR_CP_AST,
309 OBD_FAIL_LDLM_CP_BL_RACE | OBD_FAIL_ONCE)) {
310 ldlm_set_fail_loc(lock);
313 /* Go to sleep until the lock is granted or cancelled. */
314 if (ldlm_is_no_timeout(lock)) {
315 LDLM_DEBUG(lock, "waiting indefinitely because of NO_TIMEOUT");
316 rc = l_wait_event_abortable(
318 is_granted_or_cancelled(lock));
320 if (wait_event_idle_timeout(
322 is_granted_or_cancelled(lock),
323 cfs_time_seconds(timeout)) == 0) {
324 ldlm_expired_completion_wait(&lwd);
325 rc = l_wait_event_abortable(
327 is_granted_or_cancelled(lock));
333 LDLM_DEBUG(lock, "client-side enqueue waking up: failed (%d)",
338 RETURN(ldlm_completion_tail(lock, data));
340 EXPORT_SYMBOL(ldlm_completion_ast);
343 * A helper to build a blocking AST function
345 * Perform a common operation for blocking ASTs:
346 * defferred lock cancellation.
348 * \param lock the lock blocking or canceling AST was called on
350 * \see mdt_blocking_ast
351 * \see ldlm_blocking_ast
353 int ldlm_blocking_ast_nocheck(struct ldlm_lock *lock)
359 ldlm_set_cbpending(lock);
360 do_ast = (!lock->l_readers && !lock->l_writers);
361 unlock_res_and_lock(lock);
364 struct lustre_handle lockh;
367 LDLM_DEBUG(lock, "already unused, calling ldlm_cli_cancel");
368 ldlm_lock2handle(lock, &lockh);
369 rc = ldlm_cli_cancel(&lockh, LCF_ASYNC);
371 CERROR("ldlm_cli_cancel: %d\n", rc);
374 "Lock still has references, will be cancelled later");
378 EXPORT_SYMBOL(ldlm_blocking_ast_nocheck);
381 * Server blocking AST
383 * ->l_blocking_ast() callback for LDLM locks acquired by server-side
386 * \param lock the lock which blocks a request or cancelling lock
389 * \param flag indicates whether this cancelling or blocking callback
391 * \see ldlm_blocking_ast_nocheck
393 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
394 void *data, int flag)
398 if (flag == LDLM_CB_CANCELING) {
399 /* Don't need to do anything here. */
403 lock_res_and_lock(lock);
405 * Get this: if ldlm_blocking_ast is racing with intent_policy, such
406 * that ldlm_blocking_ast is called just before intent_policy method
407 * takes the lr_lock, then by the time we get the lock, we might not
408 * be the correct blocking function anymore. So check, and return
411 if (lock->l_blocking_ast != ldlm_blocking_ast) {
412 unlock_res_and_lock(lock);
415 RETURN(ldlm_blocking_ast_nocheck(lock));
417 EXPORT_SYMBOL(ldlm_blocking_ast);
420 * Implements ldlm_lock::l_glimpse_ast for extent locks acquired on the server.
422 * Returning -ELDLM_NO_LOCK_DATA actually works, but the reason for that is
423 * rather subtle: with OST-side locking, it may so happen that _all_ extent
424 * locks are held by the OST. If client wants to obtain the current file size
425 * it calls ll_glimpse_size(), and (as all locks are held only on the server),
426 * this dummy glimpse callback fires and does nothing. The client still
427 * receives the correct file size due to the following fragment of code in
428 * ldlm_cb_interpret():
430 * if (rc == -ELDLM_NO_LOCK_DATA) {
431 * LDLM_DEBUG(lock, "lost race - client has a lock but no"
433 * ldlm_res_lvbo_update(lock->l_resource, NULL, 1);
436 * That is, after the glimpse returns this error, ofd_lvbo_update() is called
437 * and returns the updated file attributes from the inode to the client.
439 * See also comment in ofd_intent_policy() on why servers must set a non-NULL
440 * l_glimpse_ast when grabbing DLM locks. Otherwise, the server will assume
441 * that the object is in the process of being destroyed.
443 * \param[in] lock DLM lock being glimpsed, unused
444 * \param[in] reqp pointer to ptlrpc_request, unused
446 * \retval -ELDLM_NO_LOCK_DATA to get attributes from disk object
448 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp)
450 return -ELDLM_NO_LOCK_DATA;
454 * Enqueue a local lock (typically on a server).
456 int ldlm_cli_enqueue_local(const struct lu_env *env,
457 struct ldlm_namespace *ns,
458 const struct ldlm_res_id *res_id,
459 enum ldlm_type type, union ldlm_policy_data *policy,
460 enum ldlm_mode mode, __u64 *flags,
461 ldlm_blocking_callback blocking,
462 ldlm_completion_callback completion,
463 ldlm_glimpse_callback glimpse,
464 void *data, __u32 lvb_len, enum lvb_type lvb_type,
465 const __u64 *client_cookie,
466 struct lustre_handle *lockh)
468 struct ldlm_lock *lock;
470 const struct ldlm_callback_suite cbs = { .lcs_completion = completion,
471 .lcs_blocking = blocking,
472 .lcs_glimpse = glimpse,
477 LASSERT(!(*flags & LDLM_FL_REPLAY));
478 if (unlikely(ns_is_client(ns))) {
479 CERROR("Trying to enqueue local lock in a shadow namespace\n");
483 lock = ldlm_lock_create(ns, res_id, type, mode, &cbs, data, lvb_len,
486 GOTO(out_nolock, err = PTR_ERR(lock));
488 err = ldlm_lvbo_init(lock->l_resource);
490 LDLM_ERROR(lock, "delayed lvb init failed (rc %d)", err);
491 ldlm_lock_destroy_nolock(lock);
495 ldlm_lock2handle(lock, lockh);
498 * NB: we don't have any lock now (lock_res_and_lock)
499 * because it's a new lock
501 ldlm_lock_addref_internal_nolock(lock, mode);
502 ldlm_set_local(lock);
503 if (*flags & LDLM_FL_ATOMIC_CB)
504 ldlm_set_atomic_cb(lock);
506 if (*flags & LDLM_FL_CANCEL_ON_BLOCK)
507 ldlm_set_cancel_on_block(lock);
510 lock->l_policy_data = *policy;
511 if (client_cookie != NULL)
512 lock->l_client_cookie = *client_cookie;
513 if (type == LDLM_EXTENT) {
514 /* extent lock without policy is a bug */
518 lock->l_req_extent = policy->l_extent;
521 err = ldlm_lock_enqueue(env, ns, &lock, policy, flags);
522 if (unlikely(err != ELDLM_OK))
526 *policy = lock->l_policy_data;
528 if (lock->l_completion_ast)
529 lock->l_completion_ast(lock, *flags, NULL);
531 LDLM_DEBUG(lock, "client-side local enqueue handler, new lock created");
534 LDLM_LOCK_RELEASE(lock);
538 EXPORT_SYMBOL(ldlm_cli_enqueue_local);
540 static void failed_lock_cleanup(struct ldlm_namespace *ns,
541 struct ldlm_lock *lock, int mode)
545 /* Set a flag to prevent us from sending a CANCEL (b=407) */
546 lock_res_and_lock(lock);
547 /* Check that lock is not granted or failed, we might race. */
548 if (!ldlm_is_granted(lock) && !ldlm_is_failed(lock)) {
550 * Make sure that this lock will not be found by raced
551 * bl_ast and -EINVAL reply is sent to server anyways.
554 lock->l_flags |= LDLM_FL_FAILED |
555 LDLM_FL_ATOMIC_CB | LDLM_FL_CBPENDING;
556 if (!(ldlm_is_bl_ast(lock) &&
557 lock->l_remote_handle.cookie != 0))
558 lock->l_flags |= LDLM_FL_LOCAL_ONLY;
561 unlock_res_and_lock(lock);
565 "setting FL_LOCAL_ONLY | LDLM_FL_FAILED | LDLM_FL_ATOMIC_CB | LDLM_FL_CBPENDING");
567 LDLM_DEBUG(lock, "lock was granted or failed in race");
570 * XXX - HACK because we shouldn't call ldlm_lock_destroy()
571 * from llite/file.c/ll_file_flock().
574 * This code makes for the fact that we do not have blocking handler on
575 * a client for flock locks. As such this is the place where we must
576 * completely kill failed locks. (interrupted and those that
577 * were waiting to be granted when server evicted us.
579 if (lock->l_resource->lr_type == LDLM_FLOCK) {
580 lock_res_and_lock(lock);
581 if (!ldlm_is_destroyed(lock)) {
582 ldlm_resource_unlink_lock(lock);
583 ldlm_lock_decref_internal_nolock(lock, mode);
584 ldlm_lock_destroy_nolock(lock);
586 unlock_res_and_lock(lock);
588 ldlm_lock_decref_internal(lock, mode);
592 static bool ldlm_request_slot_needed(struct ldlm_enqueue_info *einfo)
594 /* exclude EXTENT locks and DOM-only IBITS locks because they
595 * are asynchronous and don't wait on server being blocked.
597 return einfo->ei_type == LDLM_FLOCK ||
598 (einfo->ei_type == LDLM_IBITS &&
599 einfo->ei_inodebits != MDS_INODELOCK_DOM);
603 * Finishing portion of client lock enqueue code.
605 * Called after receiving reply from server.
607 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
608 struct ldlm_enqueue_info *einfo,
609 __u8 with_policy, __u64 *ldlm_flags, void *lvb,
610 __u32 lvb_len, const struct lustre_handle *lockh,
613 struct ldlm_namespace *ns = exp->exp_obd->obd_namespace;
614 const struct lu_env *env = NULL;
615 int is_replay = *ldlm_flags & LDLM_FL_REPLAY;
616 struct ldlm_lock *lock;
617 struct ldlm_reply *reply;
618 int cleanup_phase = 1;
622 if (ldlm_request_slot_needed(einfo))
623 obd_put_request_slot(&req->rq_import->imp_obd->u.cli);
625 ptlrpc_put_mod_rpc_slot(req);
627 if (req && req->rq_svc_thread)
628 env = req->rq_svc_thread->t_env;
630 lock = ldlm_handle2lock(lockh);
631 /* ldlm_cli_enqueue is holding a reference on this lock. */
633 LASSERT(einfo->ei_type == LDLM_FLOCK);
637 LASSERTF(ergo(lvb_len != 0, lvb_len == lock->l_lvb_len),
638 "lvb_len = %d, l_lvb_len = %d\n", lvb_len, lock->l_lvb_len);
640 if (rc != ELDLM_OK) {
642 LDLM_DEBUG(lock, "client-side enqueue END (%s)",
643 rc == ELDLM_LOCK_ABORTED ? "ABORTED" : "FAILED");
645 if (rc != ELDLM_LOCK_ABORTED)
649 /* Before we return, swab the reply */
650 reply = req_capsule_server_get(&req->rq_pill, &RMF_DLM_REP);
652 GOTO(cleanup, rc = -EPROTO);
657 size = req_capsule_get_size(&req->rq_pill, &RMF_DLM_LVB,
660 LDLM_ERROR(lock, "Fail to get lvb_len, rc = %d", size);
661 GOTO(cleanup, rc = size);
662 } else if (unlikely(size > lvb_len)) {
664 "Replied LVB is larger than expectation, expected = %d, replied = %d",
666 GOTO(cleanup, rc = -EINVAL);
671 if (rc == ELDLM_LOCK_ABORTED) {
672 if (lvb_len > 0 && lvb != NULL)
673 rc = ldlm_fill_lvb(lock, &req->rq_pill, RCL_SERVER,
675 GOTO(cleanup, rc = rc ? : ELDLM_LOCK_ABORTED);
678 /* lock enqueued on the server */
681 lock_res_and_lock(lock);
682 /* Key change rehash lock in per-export hash with new key */
683 if (exp->exp_lock_hash) {
685 * In the function below, .hs_keycmp resolves to
686 * ldlm_export_lock_keycmp()
688 /* coverity[overrun-buffer-val] */
689 cfs_hash_rehash_key(exp->exp_lock_hash,
690 &lock->l_remote_handle,
694 lock->l_remote_handle = reply->lock_handle;
697 *ldlm_flags = ldlm_flags_from_wire(reply->lock_flags);
698 lock->l_flags |= ldlm_flags_from_wire(reply->lock_flags &
699 LDLM_FL_INHERIT_MASK);
700 unlock_res_and_lock(lock);
702 CDEBUG(D_INFO, "local: %p, remote cookie: %#llx, flags: %#llx\n",
703 lock, reply->lock_handle.cookie, *ldlm_flags);
706 * If enqueue returned a blocked lock but the completion handler has
707 * already run, then it fixed up the resource and we don't need to do it
710 if ((*ldlm_flags) & LDLM_FL_LOCK_CHANGED) {
711 int newmode = reply->lock_desc.l_req_mode;
714 if (newmode && newmode != lock->l_req_mode) {
715 LDLM_DEBUG(lock, "server returned different mode %s",
716 ldlm_lockname[newmode]);
717 lock->l_req_mode = newmode;
720 if (!ldlm_res_eq(&reply->lock_desc.l_resource.lr_name,
721 &lock->l_resource->lr_name)) {
723 "remote intent success, locking "DLDLMRES", instead of "DLDLMRES"\n",
724 PLDLMRES(&reply->lock_desc.l_resource),
725 PLDLMRES(lock->l_resource));
727 rc = ldlm_lock_change_resource(ns, lock,
728 &reply->lock_desc.l_resource.lr_name);
729 if (rc || lock->l_resource == NULL)
730 GOTO(cleanup, rc = -ENOMEM);
731 LDLM_DEBUG(lock, "client-side enqueue, new resource");
735 /* We assume lock type cannot change on server*/
736 ldlm_convert_policy_to_local(exp,
737 lock->l_resource->lr_type,
738 &reply->lock_desc.l_policy_data,
739 &lock->l_policy_data);
742 if (einfo->ei_type != LDLM_PLAIN)
744 "client-side enqueue, new policy data");
747 if ((*ldlm_flags) & LDLM_FL_AST_SENT) {
748 lock_res_and_lock(lock);
749 ldlm_bl_desc2lock(&reply->lock_desc, lock);
750 lock->l_flags |= LDLM_FL_CBPENDING | LDLM_FL_BL_AST;
751 unlock_res_and_lock(lock);
752 LDLM_DEBUG(lock, "enqueue reply includes blocking AST");
756 * If the lock has already been granted by a completion AST, don't
757 * clobber the LVB with an older one.
761 * We must lock or a racing completion might update lvb without
762 * letting us know and we'll clobber the correct value.
763 * Cannot unlock after the check either, a that still leaves
764 * a tiny window for completion to get in
766 lock_res_and_lock(lock);
767 if (!ldlm_is_granted(lock))
768 rc = ldlm_fill_lvb(lock, &req->rq_pill, RCL_SERVER,
769 lock->l_lvb_data, lvb_len);
770 unlock_res_and_lock(lock);
778 rc = ldlm_lock_enqueue(env, ns, &lock, NULL, ldlm_flags);
779 if (lock->l_completion_ast != NULL) {
780 int err = lock->l_completion_ast(lock, *ldlm_flags,
790 if (lvb_len > 0 && lvb != NULL) {
792 * Copy the LVB here, and not earlier, because the completion
793 * AST (if any) can override what we got in the reply
795 memcpy(lvb, lock->l_lvb_data, lvb_len);
798 LDLM_DEBUG(lock, "client-side enqueue END");
801 if (cleanup_phase == 1 && rc)
802 failed_lock_cleanup(ns, lock, einfo->ei_mode);
803 /* Put lock 2 times, the second reference is held by ldlm_cli_enqueue */
805 LDLM_LOCK_RELEASE(lock);
808 EXPORT_SYMBOL(ldlm_cli_enqueue_fini);
811 * Estimate number of lock handles that would fit into request of given
812 * size. PAGE_SIZE-512 is to allow TCP/IP and LNET headers to fit into
813 * a single page on the send/receive side. XXX: 512 should be changed to
814 * more adequate value.
816 static inline int ldlm_req_handles_avail(int req_size, int off)
820 avail = min_t(int, LDLM_MAXREQSIZE, PAGE_SIZE - 512) - req_size;
821 if (likely(avail >= 0))
822 avail /= (int)sizeof(struct lustre_handle);
825 avail += LDLM_LOCKREQ_HANDLES - off;
830 static inline int ldlm_capsule_handles_avail(struct req_capsule *pill,
831 enum req_location loc,
834 __u32 size = req_capsule_msg_size(pill, loc);
836 return ldlm_req_handles_avail(size, off);
839 static inline int ldlm_format_handles_avail(struct obd_import *imp,
840 const struct req_format *fmt,
841 enum req_location loc, int off)
843 __u32 size = req_capsule_fmt_size(imp->imp_msg_magic, fmt, loc);
845 return ldlm_req_handles_avail(size, off);
849 * Cancel LRU locks and pack them into the enqueue request. Pack there the given
850 * \a count locks in \a cancels.
852 * This is to be called by functions preparing their own requests that
853 * might contain lists of locks to cancel in addition to actual operation
854 * that needs to be performed.
856 int ldlm_prep_elc_req(struct obd_export *exp, struct ptlrpc_request *req,
857 int version, int opc, int canceloff,
858 struct list_head *cancels, int count)
860 struct ldlm_namespace *ns = exp->exp_obd->obd_namespace;
861 struct req_capsule *pill = &req->rq_pill;
862 struct ldlm_request *dlm = NULL;
864 int avail, to_free = 0, pack = 0;
871 if (ns_connect_cancelset(ns)) {
872 /* Estimate the amount of available space in the request. */
873 req_capsule_filled_sizes(pill, RCL_CLIENT);
874 avail = ldlm_capsule_handles_avail(pill, RCL_CLIENT, canceloff);
876 /* If we have reached the limit, free +1 slot for the new one */
877 if (!ns_connect_lru_resize(ns) && opc == LDLM_ENQUEUE &&
878 ns->ns_nr_unused >= ns->ns_max_unused)
882 * Cancel LRU locks here _only_ if the server supports
883 * EARLY_CANCEL. Otherwise we have to send extra CANCEL
884 * RPC, which will make us slower.
887 count += ldlm_cancel_lru_local(ns, cancels, to_free,
889 LDLM_LRU_FLAG_NO_WAIT);
894 req_capsule_set_size(pill, &RMF_DLM_REQ, RCL_CLIENT,
895 ldlm_request_bufsize(pack, opc));
898 rc = ptlrpc_request_pack(req, version, opc);
900 ldlm_lock_list_put(cancels, l_bl_ast, count);
904 if (ns_connect_cancelset(ns)) {
906 dlm = req_capsule_client_get(pill, &RMF_DLM_REQ);
909 * Skip first lock handler in ldlm_request_pack(),
910 * this method will increment @lock_count according
911 * to the lock handle amount actually written to
914 dlm->lock_count = canceloff;
916 /* Pack into the request @pack lock handles. */
917 ldlm_cli_cancel_list(cancels, pack, req, 0);
918 /* Prepare and send separate cancel RPC for others. */
919 ldlm_cli_cancel_list(cancels, count - pack, NULL, 0);
921 ldlm_lock_list_put(cancels, l_bl_ast, count);
925 EXPORT_SYMBOL(ldlm_prep_elc_req);
927 int ldlm_prep_enqueue_req(struct obd_export *exp, struct ptlrpc_request *req,
928 struct list_head *cancels, int count)
930 return ldlm_prep_elc_req(exp, req, LUSTRE_DLM_VERSION, LDLM_ENQUEUE,
931 LDLM_ENQUEUE_CANCEL_OFF, cancels, count);
933 EXPORT_SYMBOL(ldlm_prep_enqueue_req);
935 struct ptlrpc_request *ldlm_enqueue_pack(struct obd_export *exp, int lvb_len)
937 struct ptlrpc_request *req;
942 req = ptlrpc_request_alloc(class_exp2cliimp(exp), &RQF_LDLM_ENQUEUE);
944 RETURN(ERR_PTR(-ENOMEM));
946 rc = ldlm_prep_enqueue_req(exp, req, NULL, 0);
948 ptlrpc_request_free(req);
952 req_capsule_set_size(&req->rq_pill, &RMF_DLM_LVB, RCL_SERVER, lvb_len);
953 ptlrpc_request_set_replen(req);
956 EXPORT_SYMBOL(ldlm_enqueue_pack);
959 * Client-side lock enqueue.
961 * If a request has some specific initialisation it is passed in \a reqp,
962 * otherwise it is created in ldlm_cli_enqueue.
964 * Supports sync and async requests, pass \a async flag accordingly. If a
965 * request was created in ldlm_cli_enqueue and it is the async request,
966 * pass it to the caller in \a reqp.
968 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
969 struct ldlm_enqueue_info *einfo,
970 const struct ldlm_res_id *res_id,
971 union ldlm_policy_data const *policy, __u64 *flags,
972 void *lvb, __u32 lvb_len, enum lvb_type lvb_type,
973 struct lustre_handle *lockh, int async)
975 struct ldlm_namespace *ns;
976 struct ldlm_lock *lock;
977 struct ldlm_request *body;
978 int is_replay = *flags & LDLM_FL_REPLAY;
979 int req_passed_in = 1;
981 struct ptlrpc_request *req;
985 LASSERT(exp != NULL);
987 ns = exp->exp_obd->obd_namespace;
990 * If we're replaying this lock, just check some invariants.
991 * If we're creating a new lock, get everything all setup nice.
994 lock = ldlm_handle2lock_long(lockh, 0);
995 LASSERT(lock != NULL);
996 LDLM_DEBUG(lock, "client-side enqueue START");
997 LASSERT(exp == lock->l_conn_export);
999 const struct ldlm_callback_suite cbs = {
1000 .lcs_completion = einfo->ei_cb_cp,
1001 .lcs_blocking = einfo->ei_cb_bl,
1002 .lcs_glimpse = einfo->ei_cb_gl
1004 lock = ldlm_lock_create(ns, res_id, einfo->ei_type,
1005 einfo->ei_mode, &cbs, einfo->ei_cbdata,
1008 RETURN(PTR_ERR(lock));
1010 if (einfo->ei_cb_created)
1011 einfo->ei_cb_created(lock);
1013 /* for the local lock, add the reference */
1014 ldlm_lock_addref_internal(lock, einfo->ei_mode);
1015 ldlm_lock2handle(lock, lockh);
1017 lock->l_policy_data = *policy;
1019 if (einfo->ei_type == LDLM_EXTENT) {
1020 /* extent lock without policy is a bug */
1024 lock->l_req_extent = policy->l_extent;
1026 LDLM_DEBUG(lock, "client-side enqueue START, flags %#llx",
1030 lock->l_conn_export = exp;
1031 lock->l_export = NULL;
1032 lock->l_blocking_ast = einfo->ei_cb_bl;
1033 lock->l_flags |= (*flags & (LDLM_FL_NO_LRU | LDLM_FL_EXCL |
1034 LDLM_FL_ATOMIC_CB));
1035 lock->l_activity = ktime_get_real_seconds();
1037 /* lock not sent to server yet */
1038 if (reqp == NULL || *reqp == NULL) {
1039 req = ldlm_enqueue_pack(exp, lvb_len);
1041 failed_lock_cleanup(ns, lock, einfo->ei_mode);
1042 LDLM_LOCK_RELEASE(lock);
1043 RETURN(PTR_ERR(req));
1053 len = req_capsule_get_size(&req->rq_pill, &RMF_DLM_REQ,
1055 LASSERTF(len >= sizeof(*body), "buflen[%d] = %d, not %d\n",
1056 DLM_LOCKREQ_OFF, len, (int)sizeof(*body));
1059 if (*flags & LDLM_FL_NDELAY) {
1060 DEBUG_REQ(D_DLMTRACE, req, "enqueue lock with no delay");
1061 req->rq_no_resend = req->rq_no_delay = 1;
1063 * probably set a shorter timeout value and handle ETIMEDOUT
1064 * in osc_lock_upcall() correctly
1066 /* lustre_msg_set_timeout(req, req->rq_timeout / 2); */
1069 /* Dump lock data into the request buffer */
1070 body = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
1071 ldlm_lock2desc(lock, &body->lock_desc);
1072 body->lock_flags = ldlm_flags_to_wire(*flags);
1073 body->lock_handle[0] = *lockh;
1075 /* extended LDLM opcodes in client stats */
1076 if (exp->exp_obd->obd_svc_stats != NULL) {
1077 /* glimpse is intent with no intent buffer */
1078 if (*flags & LDLM_FL_HAS_INTENT &&
1079 !req_capsule_has_field(&req->rq_pill, &RMF_LDLM_INTENT,
1081 lprocfs_counter_incr(exp->exp_obd->obd_svc_stats,
1083 LDLM_GLIMPSE_ENQUEUE);
1085 ldlm_svc_get_eopc(body, exp->exp_obd->obd_svc_stats);
1088 /* It is important to obtain modify RPC slot first (if applicable), so
1089 * that threads that are waiting for a modify RPC slot are not polluting
1090 * our rpcs in flight counter. */
1092 if (einfo->ei_enq_slot)
1093 ptlrpc_get_mod_rpc_slot(req);
1095 if (ldlm_request_slot_needed(einfo)) {
1096 rc = obd_get_request_slot(&req->rq_import->imp_obd->u.cli);
1098 if (einfo->ei_enq_slot)
1099 ptlrpc_put_mod_rpc_slot(req);
1100 failed_lock_cleanup(ns, lock, einfo->ei_mode);
1101 LDLM_LOCK_RELEASE(lock);
1103 ptlrpc_req_finished(req);
1109 LASSERT(reqp != NULL);
1113 LDLM_DEBUG(lock, "sending request");
1115 rc = ptlrpc_queue_wait(req);
1117 err = ldlm_cli_enqueue_fini(exp, req, einfo, policy ? 1 : 0, flags,
1118 lvb, lvb_len, lockh, rc);
1121 * If ldlm_cli_enqueue_fini did not find the lock, we need to free
1122 * one reference that we took
1125 LDLM_LOCK_RELEASE(lock);
1130 if (!req_passed_in && req != NULL) {
1131 ptlrpc_req_finished(req);
1138 EXPORT_SYMBOL(ldlm_cli_enqueue);
1141 * Client-side IBITS lock convert.
1143 * Inform server that lock has been converted instead of canceling.
1144 * Server finishes convert on own side and does reprocess to grant
1145 * all related waiting locks.
1147 * Since convert means only ibits downgrading, client doesn't need to
1148 * wait for server reply to finish local converting process so this request
1149 * is made asynchronous.
1152 int ldlm_cli_convert_req(struct ldlm_lock *lock, __u32 *flags, __u64 new_bits)
1154 struct ldlm_request *body;
1155 struct ptlrpc_request *req;
1156 struct obd_export *exp = lock->l_conn_export;
1160 LASSERT(exp != NULL);
1163 * this is better to check earlier and it is done so already,
1164 * but this check is kept too as final one to issue an error
1165 * if any new code will miss such check.
1167 if (!exp_connect_lock_convert(exp)) {
1168 LDLM_ERROR(lock, "server doesn't support lock convert\n");
1172 if (lock->l_resource->lr_type != LDLM_IBITS) {
1173 LDLM_ERROR(lock, "convert works with IBITS locks only.");
1177 LDLM_DEBUG(lock, "client-side convert");
1179 req = ptlrpc_request_alloc_pack(class_exp2cliimp(exp),
1180 &RQF_LDLM_CONVERT, LUSTRE_DLM_VERSION,
1185 body = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
1186 body->lock_handle[0] = lock->l_remote_handle;
1188 body->lock_desc.l_req_mode = lock->l_req_mode;
1189 body->lock_desc.l_granted_mode = lock->l_granted_mode;
1191 body->lock_desc.l_policy_data.l_inodebits.bits = new_bits;
1192 body->lock_desc.l_policy_data.l_inodebits.cancel_bits = 0;
1194 body->lock_flags = ldlm_flags_to_wire(*flags);
1195 body->lock_count = 1;
1197 ptlrpc_request_set_replen(req);
1200 * Use cancel portals for convert as well as high-priority handling.
1202 req->rq_request_portal = LDLM_CANCEL_REQUEST_PORTAL;
1203 req->rq_reply_portal = LDLM_CANCEL_REPLY_PORTAL;
1205 ptlrpc_at_set_req_timeout(req);
1207 if (exp->exp_obd->obd_svc_stats != NULL)
1208 lprocfs_counter_incr(exp->exp_obd->obd_svc_stats,
1209 LDLM_CONVERT - LDLM_FIRST_OPC);
1211 ptlrpcd_add_req(req);
1216 * Cancel locks locally.
1218 * \retval LDLM_FL_LOCAL_ONLY if there is no need for a CANCEL RPC to the server
1219 * \retval LDLM_FL_CANCELING otherwise;
1220 * \retval LDLM_FL_BL_AST if there is a need for a separate CANCEL RPC.
1222 static __u64 ldlm_cli_cancel_local(struct ldlm_lock *lock)
1224 __u64 rc = LDLM_FL_LOCAL_ONLY;
1228 if (lock->l_conn_export) {
1231 LDLM_DEBUG(lock, "client-side cancel");
1232 OBD_FAIL_TIMEOUT(OBD_FAIL_LDLM_PAUSE_CANCEL_LOCAL,
1235 /* Set this flag to prevent others from getting new references*/
1236 lock_res_and_lock(lock);
1237 ldlm_set_cbpending(lock);
1238 local_only = !!(lock->l_flags &
1239 (LDLM_FL_LOCAL_ONLY|LDLM_FL_CANCEL_ON_BLOCK));
1240 ldlm_cancel_callback(lock);
1241 rc = (ldlm_is_bl_ast(lock)) ?
1242 LDLM_FL_BL_AST : LDLM_FL_CANCELING;
1243 unlock_res_and_lock(lock);
1247 "not sending request (at caller's instruction)\n");
1248 rc = LDLM_FL_LOCAL_ONLY;
1250 ldlm_lock_cancel(lock);
1252 if (ns_is_client(ldlm_lock_to_ns(lock))) {
1253 LDLM_ERROR(lock, "Trying to cancel local lock");
1256 LDLM_DEBUG(lock, "server-side local cancel");
1257 ldlm_lock_cancel(lock);
1258 ldlm_reprocess_all(lock->l_resource, lock);
1265 * Pack \a count locks in \a head into ldlm_request buffer of request \a req.
1267 static void ldlm_cancel_pack(struct ptlrpc_request *req,
1268 struct list_head *head, int count)
1270 struct ldlm_request *dlm;
1271 struct ldlm_lock *lock;
1272 int max, packed = 0;
1276 dlm = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
1277 LASSERT(dlm != NULL);
1279 /* Check the room in the request buffer. */
1280 max = req_capsule_get_size(&req->rq_pill, &RMF_DLM_REQ, RCL_CLIENT) -
1281 sizeof(struct ldlm_request);
1282 max /= sizeof(struct lustre_handle);
1283 max += LDLM_LOCKREQ_HANDLES;
1284 LASSERT(max >= dlm->lock_count + count);
1287 * XXX: it would be better to pack lock handles grouped by resource.
1288 * so that the server cancel would call filter_lvbo_update() less
1291 list_for_each_entry(lock, head, l_bl_ast) {
1294 LASSERT(lock->l_conn_export);
1295 /* Pack the lock handle to the given request buffer. */
1296 LDLM_DEBUG(lock, "packing");
1297 dlm->lock_handle[dlm->lock_count++] = lock->l_remote_handle;
1300 CDEBUG(D_DLMTRACE, "%d locks packed\n", packed);
1305 * Prepare and send a batched cancel RPC. It will include \a count lock
1306 * handles of locks given in \a cancels list.
1308 int ldlm_cli_cancel_req(struct obd_export *exp, struct list_head *cancels,
1309 int count, enum ldlm_cancel_flags flags)
1311 struct ptlrpc_request *req = NULL;
1312 struct obd_import *imp;
1318 LASSERT(exp != NULL);
1321 CFS_FAIL_TIMEOUT(OBD_FAIL_LDLM_PAUSE_CANCEL, cfs_fail_val);
1323 if (CFS_FAIL_CHECK(OBD_FAIL_LDLM_CANCEL_RACE))
1326 free = ldlm_format_handles_avail(class_exp2cliimp(exp),
1327 &RQF_LDLM_CANCEL, RCL_CLIENT, 0);
1332 imp = class_exp2cliimp(exp);
1333 if (imp == NULL || imp->imp_invalid) {
1335 "skipping cancel on invalid import %p\n", imp);
1339 req = ptlrpc_request_alloc(imp, &RQF_LDLM_CANCEL);
1341 GOTO(out, rc = -ENOMEM);
1343 req_capsule_filled_sizes(&req->rq_pill, RCL_CLIENT);
1344 req_capsule_set_size(&req->rq_pill, &RMF_DLM_REQ, RCL_CLIENT,
1345 ldlm_request_bufsize(count, LDLM_CANCEL));
1347 rc = ptlrpc_request_pack(req, LUSTRE_DLM_VERSION, LDLM_CANCEL);
1349 ptlrpc_request_free(req);
1354 * If OSP want cancel cross-MDT lock, let's not block it in
1355 * in recovery, otherwise the lock will not released, if
1356 * the remote target is also in recovery, and it also need
1357 * this lock, it might cause deadlock.
1359 if (exp_connect_flags(exp) & OBD_CONNECT_MDS_MDS &&
1360 exp->exp_obd->obd_lu_dev != NULL &&
1361 exp->exp_obd->obd_lu_dev->ld_site != NULL) {
1362 struct lu_device *top_dev;
1364 top_dev = exp->exp_obd->obd_lu_dev->ld_site->ls_top_dev;
1365 if (top_dev != NULL &&
1366 top_dev->ld_obd->obd_recovering)
1367 req->rq_allow_replay = 1;
1370 req->rq_request_portal = LDLM_CANCEL_REQUEST_PORTAL;
1371 req->rq_reply_portal = LDLM_CANCEL_REPLY_PORTAL;
1372 ptlrpc_at_set_req_timeout(req);
1374 ldlm_cancel_pack(req, cancels, count);
1376 ptlrpc_request_set_replen(req);
1377 if (flags & LCF_ASYNC) {
1378 ptlrpcd_add_req(req);
1383 rc = ptlrpc_queue_wait(req);
1384 if (rc == LUSTRE_ESTALE) {
1386 "client/server (nid %s) out of sync -- not fatal\n",
1387 libcfs_nid2str(req->rq_import->imp_connection->c_peer.nid));
1389 } else if (rc == -ETIMEDOUT && /* check there was no reconnect*/
1390 req->rq_import_generation == imp->imp_generation) {
1391 ptlrpc_req_finished(req);
1393 } else if (rc != ELDLM_OK) {
1394 /* -ESHUTDOWN is common on umount */
1395 CDEBUG_LIMIT(rc == -ESHUTDOWN ? D_DLMTRACE : D_ERROR,
1396 "Got rc %d from cancel RPC: canceling anyway\n",
1404 ptlrpc_req_finished(req);
1407 return sent ? sent : rc;
1410 static inline struct ldlm_pool *ldlm_imp2pl(struct obd_import *imp)
1412 LASSERT(imp != NULL);
1413 return &imp->imp_obd->obd_namespace->ns_pool;
1417 * Update client's OBD pool related fields with new SLV and Limit from \a req.
1419 int ldlm_cli_update_pool(struct ptlrpc_request *req)
1421 struct ldlm_namespace *ns;
1422 struct obd_device *obd;
1423 __u64 new_slv, ratio;
1427 if (unlikely(!req->rq_import || !req->rq_import->imp_obd ||
1428 !imp_connect_lru_resize(req->rq_import)))
1429 /* Do nothing for corner cases. */
1433 * In some cases RPC may contain SLV and limit zeroed out. This
1434 * is the case when server does not support LRU resize feature.
1435 * This is also possible in some recovery cases when server-side
1436 * reqs have no reference to the OBD export and thus access to
1437 * server-side namespace is not possible.
1439 if (lustre_msg_get_slv(req->rq_repmsg) == 0 ||
1440 lustre_msg_get_limit(req->rq_repmsg) == 0) {
1441 DEBUG_REQ(D_HA, req,
1442 "Zero SLV or limit found (SLV=%llu, limit=%u)",
1443 lustre_msg_get_slv(req->rq_repmsg),
1444 lustre_msg_get_limit(req->rq_repmsg));
1448 new_limit = lustre_msg_get_limit(req->rq_repmsg);
1449 new_slv = lustre_msg_get_slv(req->rq_repmsg);
1450 obd = req->rq_import->imp_obd;
1452 read_lock(&obd->obd_pool_lock);
1453 if (obd->obd_pool_slv == new_slv &&
1454 obd->obd_pool_limit == new_limit) {
1455 read_unlock(&obd->obd_pool_lock);
1458 read_unlock(&obd->obd_pool_lock);
1461 * OBD device keeps the new pool attributes before they are handled by
1464 write_lock(&obd->obd_pool_lock);
1465 obd->obd_pool_slv = new_slv;
1466 obd->obd_pool_limit = new_limit;
1467 write_unlock(&obd->obd_pool_lock);
1470 * Check if an urgent pool recalc is needed, let it to be a change of
1471 * SLV on 10%. It is applicable to LRU resize enabled case only.
1473 ns = obd->obd_namespace;
1474 if (!ns_connect_lru_resize(ns) ||
1475 ldlm_pool_get_slv(&ns->ns_pool) < new_slv)
1478 ratio = 100 * new_slv / ldlm_pool_get_slv(&ns->ns_pool);
1479 if (100 - ratio >= ns->ns_recalc_pct &&
1480 !ns->ns_stopping && !ns->ns_rpc_recalc) {
1481 bool recalc = false;
1483 spin_lock(&ns->ns_lock);
1484 if (!ns->ns_stopping && !ns->ns_rpc_recalc) {
1485 ldlm_namespace_get(ns);
1487 ns->ns_rpc_recalc = 1;
1489 spin_unlock(&ns->ns_lock);
1491 ldlm_bl_to_thread_ns(ns);
1497 int ldlm_cli_convert(struct ldlm_lock *lock,
1498 enum ldlm_cancel_flags cancel_flags)
1502 LASSERT(!lock->l_readers && !lock->l_writers);
1503 LDLM_DEBUG(lock, "client lock convert START");
1505 if (lock->l_resource->lr_type == LDLM_IBITS) {
1506 lock_res_and_lock(lock);
1508 rc = ldlm_cli_inodebits_convert(lock, cancel_flags);
1509 } while (rc == -EAGAIN);
1510 unlock_res_and_lock(lock);
1513 LDLM_DEBUG(lock, "client lock convert END");
1516 EXPORT_SYMBOL(ldlm_cli_convert);
1519 * Client side lock cancel.
1521 * Lock must not have any readers or writers by this time.
1523 int ldlm_cli_cancel(const struct lustre_handle *lockh,
1524 enum ldlm_cancel_flags cancel_flags)
1526 struct obd_export *exp;
1527 int avail, count = 1;
1529 struct ldlm_namespace *ns;
1530 struct ldlm_lock *lock;
1535 lock = ldlm_handle2lock_long(lockh, 0);
1537 LDLM_DEBUG_NOLOCK("lock is already being destroyed");
1541 lock_res_and_lock(lock);
1542 LASSERT(!ldlm_is_converting(lock));
1544 /* Lock is being canceled and the caller doesn't want to wait */
1545 if (ldlm_is_canceling(lock)) {
1546 if (cancel_flags & LCF_ASYNC) {
1547 unlock_res_and_lock(lock);
1549 unlock_res_and_lock(lock);
1550 wait_event_idle(lock->l_waitq, is_bl_done(lock));
1552 LDLM_LOCK_RELEASE(lock);
1556 ldlm_set_canceling(lock);
1557 unlock_res_and_lock(lock);
1559 if (cancel_flags & LCF_LOCAL)
1560 OBD_FAIL_TIMEOUT(OBD_FAIL_LDLM_LOCAL_CANCEL_PAUSE,
1563 rc = ldlm_cli_cancel_local(lock);
1564 if (rc == LDLM_FL_LOCAL_ONLY || cancel_flags & LCF_LOCAL) {
1565 LDLM_LOCK_RELEASE(lock);
1569 * Even if the lock is marked as LDLM_FL_BL_AST, this is a LDLM_CANCEL
1570 * RPC which goes to canceld portal, so we can cancel other LRU locks
1571 * here and send them all as one LDLM_CANCEL RPC.
1573 LASSERT(list_empty(&lock->l_bl_ast));
1574 list_add(&lock->l_bl_ast, &cancels);
1576 exp = lock->l_conn_export;
1577 if (exp_connect_cancelset(exp)) {
1578 avail = ldlm_format_handles_avail(class_exp2cliimp(exp),
1583 ns = ldlm_lock_to_ns(lock);
1584 count += ldlm_cancel_lru_local(ns, &cancels, 0, avail - 1,
1587 ldlm_cli_cancel_list(&cancels, count, NULL, cancel_flags);
1590 EXPORT_SYMBOL(ldlm_cli_cancel);
1593 * Locally cancel up to \a count locks in list \a cancels.
1594 * Return the number of cancelled locks.
1596 int ldlm_cli_cancel_list_local(struct list_head *cancels, int count,
1597 enum ldlm_cancel_flags cancel_flags)
1600 struct ldlm_lock *lock, *next;
1601 int left = 0, bl_ast = 0;
1605 list_for_each_entry_safe(lock, next, cancels, l_bl_ast) {
1609 if (cancel_flags & LCF_LOCAL) {
1610 rc = LDLM_FL_LOCAL_ONLY;
1611 ldlm_lock_cancel(lock);
1613 rc = ldlm_cli_cancel_local(lock);
1616 * Until we have compound requests and can send LDLM_CANCEL
1617 * requests batched with generic RPCs, we need to send cancels
1618 * with the LDLM_FL_BL_AST flag in a separate RPC from
1619 * the one being generated now.
1621 if (!(cancel_flags & LCF_BL_AST) && (rc == LDLM_FL_BL_AST)) {
1622 LDLM_DEBUG(lock, "Cancel lock separately");
1623 list_move(&lock->l_bl_ast, &head);
1627 if (rc == LDLM_FL_LOCAL_ONLY) {
1628 /* CANCEL RPC should not be sent to server. */
1629 list_del_init(&lock->l_bl_ast);
1630 LDLM_LOCK_RELEASE(lock);
1636 ldlm_cli_cancel_list(&head, bl_ast, NULL, 0);
1643 * Cancel as many locks as possible w/o sending any RPCs (e.g. to write back
1644 * dirty data, to close a file, ...) or waiting for any RPCs in-flight (e.g.
1645 * readahead requests, ...)
1647 static enum ldlm_policy_res
1648 ldlm_cancel_no_wait_policy(struct ldlm_namespace *ns, struct ldlm_lock *lock,
1651 enum ldlm_policy_res result = LDLM_POLICY_CANCEL_LOCK;
1654 * don't check @added & @min since we want to process all locks
1656 * It's fine to not take lock to access lock->l_resource since
1657 * the lock has already been granted so it won't change.
1659 switch (lock->l_resource->lr_type) {
1662 if (ns->ns_cancel != NULL && ns->ns_cancel(lock) != 0)
1666 result = LDLM_POLICY_SKIP_LOCK;
1674 * Callback function for LRU-resize policy. Decides whether to keep
1675 * \a lock in LRU for \a added in current scan and \a min number of locks
1676 * to be preferably canceled.
1678 * \retval LDLM_POLICY_KEEP_LOCK keep lock in LRU in stop scanning
1680 * \retval LDLM_POLICY_CANCEL_LOCK cancel lock from LRU
1682 static enum ldlm_policy_res ldlm_cancel_lrur_policy(struct ldlm_namespace *ns,
1683 struct ldlm_lock *lock,
1686 ktime_t cur = ktime_get();
1687 struct ldlm_pool *pl = &ns->ns_pool;
1692 return LDLM_POLICY_CANCEL_LOCK;
1695 * Despite of the LV, It doesn't make sense to keep the lock which
1696 * is unused for ns_max_age time.
1698 if (ktime_after(cur, ktime_add(lock->l_last_used, ns->ns_max_age)))
1699 return LDLM_POLICY_CANCEL_LOCK;
1701 slv = ldlm_pool_get_slv(pl);
1702 lvf = ldlm_pool_get_lvf(pl);
1703 la = div_u64(ktime_to_ns(ktime_sub(cur, lock->l_last_used)),
1705 lv = lvf * la * ns->ns_nr_unused >> 8;
1707 /* Inform pool about current CLV to see it via debugfs. */
1708 ldlm_pool_set_clv(pl, lv);
1711 * Stop when SLV is not yet come from server or lv is smaller than
1714 if (slv == 0 || lv < slv)
1715 return LDLM_POLICY_KEEP_LOCK;
1717 return LDLM_POLICY_CANCEL_LOCK;
1720 static enum ldlm_policy_res
1721 ldlm_cancel_lrur_no_wait_policy(struct ldlm_namespace *ns,
1722 struct ldlm_lock *lock,
1725 enum ldlm_policy_res result;
1727 result = ldlm_cancel_lrur_policy(ns, lock, added, min);
1728 if (result == LDLM_POLICY_KEEP_LOCK)
1731 return ldlm_cancel_no_wait_policy(ns, lock, added, min);
1735 * Callback function for aged policy. Decides whether to keep
1736 * \a lock in LRU for \a added in current scan and \a min number of locks
1737 * to be preferably canceled.
1739 * \retval LDLM_POLICY_KEEP_LOCK keep lock in LRU in stop scanning
1741 * \retval LDLM_POLICY_CANCEL_LOCK cancel lock from LRU
1743 static enum ldlm_policy_res ldlm_cancel_aged_policy(struct ldlm_namespace *ns,
1744 struct ldlm_lock *lock,
1747 if ((added >= min) &&
1748 ktime_before(ktime_get(),
1749 ktime_add(lock->l_last_used, ns->ns_max_age)))
1750 return LDLM_POLICY_KEEP_LOCK;
1752 return LDLM_POLICY_CANCEL_LOCK;
1755 static enum ldlm_policy_res
1756 ldlm_cancel_aged_no_wait_policy(struct ldlm_namespace *ns,
1757 struct ldlm_lock *lock,
1760 enum ldlm_policy_res result;
1762 result = ldlm_cancel_aged_policy(ns, lock, added, min);
1763 if (result == LDLM_POLICY_KEEP_LOCK)
1766 return ldlm_cancel_no_wait_policy(ns, lock, added, min);
1769 typedef enum ldlm_policy_res
1770 (*ldlm_cancel_lru_policy_t)(struct ldlm_namespace *ns, struct ldlm_lock *lock,
1771 int added, int min);
1773 static ldlm_cancel_lru_policy_t
1774 ldlm_cancel_lru_policy(struct ldlm_namespace *ns, enum ldlm_lru_flags lru_flags)
1776 if (ns_connect_lru_resize(ns)) {
1777 if (lru_flags & LDLM_LRU_FLAG_NO_WAIT)
1778 return ldlm_cancel_lrur_no_wait_policy;
1780 return ldlm_cancel_lrur_policy;
1782 if (lru_flags & LDLM_LRU_FLAG_NO_WAIT)
1783 return ldlm_cancel_aged_no_wait_policy;
1785 return ldlm_cancel_aged_policy;
1790 * - Free space in LRU for \a min new locks,
1791 * redundant unused locks are canceled locally;
1792 * - also cancel locally unused aged locks;
1793 * - do not cancel more than \a max locks;
1794 * - if some locks are cancelled, try to cancel at least \a batch locks
1795 * - GET the found locks and add them into the \a cancels list.
1797 * A client lock can be added to the l_bl_ast list only when it is
1798 * marked LDLM_FL_CANCELING. Otherwise, somebody is already doing
1799 * CANCEL. There are the following use cases:
1800 * ldlm_cancel_resource_local(), ldlm_cancel_lru_local() and
1801 * ldlm_cli_cancel(), which check and set this flag properly. As any
1802 * attempt to cancel a lock rely on this flag, l_bl_ast list is accessed
1803 * later without any special locking.
1805 * Locks are cancelled according to the LRU resize policy (SLV from server)
1806 * if LRU resize is enabled; otherwise, the "aged policy" is used;
1809 * ----------------------------------------
1811 * flags & LDLM_LRU_FLAG_NO_WAIT - cancel locks w/o sending any RPCs or waiting
1812 * for any outstanding RPC to complete.
1814 * flags & LDLM_CANCEL_CLEANUP - when cancelling read locks, do not check for
1815 * other read locks covering the same pages, just
1816 * discard those pages.
1818 static int ldlm_prepare_lru_list(struct ldlm_namespace *ns,
1819 struct list_head *cancels,
1820 int min, int max, int batch,
1821 enum ldlm_lru_flags lru_flags)
1823 ldlm_cancel_lru_policy_t pf;
1825 int no_wait = lru_flags & LDLM_LRU_FLAG_NO_WAIT;
1829 * Let only 1 thread to proceed. However, not for those which have the
1830 * @max limit given (ELC), as LRU may be left not cleaned up in full.
1833 if (test_and_set_bit(LDLM_LRU_CANCEL, &ns->ns_flags))
1835 } else if (test_bit(LDLM_LRU_CANCEL, &ns->ns_flags))
1838 LASSERT(ergo(max, min <= max));
1839 /* No sense to give @batch for ELC */
1840 LASSERT(ergo(max, batch == 0));
1842 if (!ns_connect_lru_resize(ns))
1843 min = max_t(int, min, ns->ns_nr_unused - ns->ns_max_unused);
1845 /* If at least 1 lock is to be cancelled, cancel at least @batch locks */
1846 if (min && min < batch)
1849 pf = ldlm_cancel_lru_policy(ns, lru_flags);
1850 LASSERT(pf != NULL);
1852 /* For any flags, stop scanning if @max is reached. */
1853 while (!list_empty(&ns->ns_unused_list) && (max == 0 || added < max)) {
1854 struct ldlm_lock *lock;
1855 struct list_head *item, *next;
1856 enum ldlm_policy_res result;
1857 ktime_t last_use = ktime_set(0, 0);
1859 spin_lock(&ns->ns_lock);
1860 item = no_wait ? ns->ns_last_pos : &ns->ns_unused_list;
1861 for (item = item->next, next = item->next;
1862 item != &ns->ns_unused_list;
1863 item = next, next = item->next) {
1864 lock = list_entry(item, struct ldlm_lock, l_lru);
1866 /* No locks which got blocking requests. */
1867 LASSERT(!ldlm_is_bl_ast(lock));
1869 if (!ldlm_is_canceling(lock))
1873 * Somebody is already doing CANCEL. No need for this
1874 * lock in LRU, do not traverse it again.
1876 ldlm_lock_remove_from_lru_nolock(lock);
1878 if (item == &ns->ns_unused_list) {
1879 spin_unlock(&ns->ns_lock);
1883 last_use = lock->l_last_used;
1885 LDLM_LOCK_GET(lock);
1886 spin_unlock(&ns->ns_lock);
1887 lu_ref_add(&lock->l_reference, __FUNCTION__, current);
1890 * Pass the lock through the policy filter and see if it
1891 * should stay in LRU.
1893 * Even for shrinker policy we stop scanning if
1894 * we find a lock that should stay in the cache.
1895 * We should take into account lock age anyway
1896 * as a new lock is a valuable resource even if
1897 * it has a low weight.
1899 * That is, for shrinker policy we drop only
1900 * old locks, but additionally choose them by
1901 * their weight. Big extent locks will stay in
1904 result = pf(ns, lock, added, min);
1905 if (result == LDLM_POLICY_KEEP_LOCK) {
1906 lu_ref_del(&lock->l_reference, __func__, current);
1907 LDLM_LOCK_RELEASE(lock);
1911 if (result == LDLM_POLICY_SKIP_LOCK) {
1912 lu_ref_del(&lock->l_reference, __func__, current);
1914 spin_lock(&ns->ns_lock);
1915 if (!list_empty(&lock->l_lru) &&
1916 lock->l_lru.prev == ns->ns_last_pos)
1917 ns->ns_last_pos = &lock->l_lru;
1918 spin_unlock(&ns->ns_lock);
1921 LDLM_LOCK_RELEASE(lock);
1925 lock_res_and_lock(lock);
1926 /* Check flags again under the lock. */
1927 if (ldlm_is_canceling(lock) ||
1928 ldlm_lock_remove_from_lru_check(lock, last_use) == 0) {
1930 * Another thread is removing lock from LRU, or
1931 * somebody is already doing CANCEL, or there
1932 * is a blocking request which will send cancel
1933 * by itself, or the lock is no longer unused or
1934 * the lock has been used since the pf() call and
1935 * pages could be put under it.
1937 unlock_res_and_lock(lock);
1938 lu_ref_del(&lock->l_reference, __FUNCTION__, current);
1939 LDLM_LOCK_RELEASE(lock);
1942 LASSERT(!lock->l_readers && !lock->l_writers);
1945 * If we have chosen to cancel this lock voluntarily, we
1946 * better send cancel notification to server, so that it
1947 * frees appropriate state. This might lead to a race
1948 * where while we are doing cancel here, server is also
1949 * silently cancelling this lock.
1951 ldlm_clear_cancel_on_block(lock);
1954 * Setting the CBPENDING flag is a little misleading,
1955 * but prevents an important race; namely, once
1956 * CBPENDING is set, the lock can accumulate no more
1957 * readers/writers. Since readers and writers are
1958 * already zero here, ldlm_lock_decref() won't see
1959 * this flag and call l_blocking_ast
1961 lock->l_flags |= LDLM_FL_CBPENDING | LDLM_FL_CANCELING;
1963 if ((lru_flags & LDLM_LRU_FLAG_CLEANUP) &&
1964 (lock->l_resource->lr_type == LDLM_EXTENT ||
1965 ldlm_has_dom(lock)) && lock->l_granted_mode == LCK_PR)
1966 ldlm_set_discard_data(lock);
1969 * We can't re-add to l_lru as it confuses the
1970 * refcounting in ldlm_lock_remove_from_lru() if an AST
1971 * arrives after we drop lr_lock below. We use l_bl_ast
1972 * and can't use l_pending_chain as it is used both on
1973 * server and client nevertheless b=5666 says it is
1974 * used only on server
1976 LASSERT(list_empty(&lock->l_bl_ast));
1977 list_add(&lock->l_bl_ast, cancels);
1978 unlock_res_and_lock(lock);
1979 lu_ref_del(&lock->l_reference, __FUNCTION__, current);
1981 /* Once a lock added, batch the requested amount */
1987 clear_bit(LDLM_LRU_CANCEL, &ns->ns_flags);
1992 int ldlm_cancel_lru_local(struct ldlm_namespace *ns, struct list_head *cancels,
1994 enum ldlm_cancel_flags cancel_flags,
1995 enum ldlm_lru_flags lru_flags)
1999 added = ldlm_prepare_lru_list(ns, cancels, min, max, 0, lru_flags);
2003 return ldlm_cli_cancel_list_local(cancels, added, cancel_flags);
2007 * Cancel at least \a min locks from given namespace LRU.
2009 * When called with LCF_ASYNC the blocking callback will be handled
2010 * in a thread and this function will return after the thread has been
2011 * asked to call the callback. When called with LCF_ASYNC the blocking
2012 * callback will be performed in this function.
2014 int ldlm_cancel_lru(struct ldlm_namespace *ns, int min,
2015 enum ldlm_cancel_flags cancel_flags,
2016 enum ldlm_lru_flags lru_flags)
2024 * Just prepare the list of locks, do not actually cancel them yet.
2025 * Locks are cancelled later in a separate thread.
2027 count = ldlm_prepare_lru_list(ns, &cancels, min, 0,
2028 ns->ns_cancel_batch, lru_flags);
2029 rc = ldlm_bl_to_thread_list(ns, NULL, &cancels, count, cancel_flags);
2037 * Find and cancel locally unused locks found on resource, matched to the
2038 * given policy, mode. GET the found locks and add them into the \a cancels
2041 int ldlm_cancel_resource_local(struct ldlm_resource *res,
2042 struct list_head *cancels,
2043 union ldlm_policy_data *policy,
2044 enum ldlm_mode mode, __u64 lock_flags,
2045 enum ldlm_cancel_flags cancel_flags,
2048 struct ldlm_lock *lock;
2054 list_for_each_entry(lock, &res->lr_granted, l_res_link) {
2055 if (opaque != NULL && lock->l_ast_data != opaque) {
2056 LDLM_ERROR(lock, "data %p doesn't match opaque %p",
2057 lock->l_ast_data, opaque);
2061 if (lock->l_readers || lock->l_writers)
2065 * If somebody is already doing CANCEL, or blocking AST came
2066 * then skip this lock.
2068 if (ldlm_is_bl_ast(lock) || ldlm_is_canceling(lock))
2071 if (lockmode_compat(lock->l_granted_mode, mode))
2075 * If policy is given and this is IBITS lock, add to list only
2076 * those locks that match by policy.
2078 if (policy && (lock->l_resource->lr_type == LDLM_IBITS)) {
2079 if (!(lock->l_policy_data.l_inodebits.bits &
2080 policy->l_inodebits.bits))
2082 /* Skip locks with DoM bit if it is not set in policy
2083 * to don't flush data by side-bits. Lock convert will
2084 * drop those bits separately.
2086 if (ldlm_has_dom(lock) &&
2087 !(policy->l_inodebits.bits & MDS_INODELOCK_DOM))
2091 /* See CBPENDING comment in ldlm_cancel_lru */
2092 lock->l_flags |= LDLM_FL_CBPENDING | LDLM_FL_CANCELING |
2094 LASSERT(list_empty(&lock->l_bl_ast));
2095 list_add(&lock->l_bl_ast, cancels);
2096 LDLM_LOCK_GET(lock);
2101 RETURN(ldlm_cli_cancel_list_local(cancels, count, cancel_flags));
2103 EXPORT_SYMBOL(ldlm_cancel_resource_local);
2106 * Cancel client-side locks from a list and send/prepare cancel RPCs to the
2108 * If \a req is NULL, send CANCEL request to server with handles of locks
2109 * in the \a cancels. If EARLY_CANCEL is not supported, send CANCEL requests
2110 * separately per lock.
2111 * If \a req is not NULL, put handles of locks in \a cancels into the request
2112 * buffer at the offset \a off.
2113 * Destroy \a cancels at the end.
2115 int ldlm_cli_cancel_list(struct list_head *cancels, int count,
2116 struct ptlrpc_request *req,
2117 enum ldlm_cancel_flags flags)
2119 struct ldlm_lock *lock;
2124 if (list_empty(cancels) || count == 0)
2128 * XXX: requests (both batched and not) could be sent in parallel.
2129 * Usually it is enough to have just 1 RPC, but it is possible that
2130 * there are too many locks to be cancelled in LRU or on a resource.
2131 * It would also speed up the case when the server does not support
2135 LASSERT(!list_empty(cancels));
2136 lock = list_entry(cancels->next, struct ldlm_lock,
2138 LASSERT(lock->l_conn_export);
2140 if (exp_connect_cancelset(lock->l_conn_export)) {
2143 ldlm_cancel_pack(req, cancels, count);
2145 res = ldlm_cli_cancel_req(lock->l_conn_export,
2149 res = ldlm_cli_cancel_req(lock->l_conn_export,
2154 CDEBUG_LIMIT(res == -ESHUTDOWN ? D_DLMTRACE : D_ERROR,
2155 "ldlm_cli_cancel_list: %d\n", res);
2160 ldlm_lock_list_put(cancels, l_bl_ast, res);
2162 LASSERT(count == 0);
2165 EXPORT_SYMBOL(ldlm_cli_cancel_list);
2168 * Cancel all locks on a resource that have 0 readers/writers.
2170 * If flags & LDLM_FL_LOCAL_ONLY, throw the locks away without trying
2171 * to notify the server.
2173 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
2174 const struct ldlm_res_id *res_id,
2175 union ldlm_policy_data *policy,
2176 enum ldlm_mode mode,
2177 enum ldlm_cancel_flags flags, void *opaque)
2179 struct ldlm_resource *res;
2186 res = ldlm_resource_get(ns, NULL, res_id, 0, 0);
2188 /* This is not a problem. */
2189 CDEBUG(D_INFO, "No resource %llu\n", res_id->name[0]);
2193 LDLM_RESOURCE_ADDREF(res);
2194 count = ldlm_cancel_resource_local(res, &cancels, policy, mode,
2195 0, flags | LCF_BL_AST, opaque);
2196 rc = ldlm_cli_cancel_list(&cancels, count, NULL, flags);
2198 CERROR("canceling unused lock "DLDLMRES": rc = %d\n",
2201 LDLM_RESOURCE_DELREF(res);
2202 ldlm_resource_putref(res);
2205 EXPORT_SYMBOL(ldlm_cli_cancel_unused_resource);
2207 struct ldlm_cli_cancel_arg {
2213 ldlm_cli_hash_cancel_unused(struct cfs_hash *hs, struct cfs_hash_bd *bd,
2214 struct hlist_node *hnode, void *arg)
2216 struct ldlm_resource *res = cfs_hash_object(hs, hnode);
2217 struct ldlm_cli_cancel_arg *lc = arg;
2219 ldlm_cli_cancel_unused_resource(ldlm_res_to_ns(res), &res->lr_name,
2220 NULL, LCK_MINMODE, lc->lc_flags,
2222 /* must return 0 for hash iteration */
2227 * Cancel all locks on a namespace (or a specific resource, if given)
2228 * that have 0 readers/writers.
2230 * If flags & LCF_LOCAL, throw the locks away without trying
2231 * to notify the server.
2233 int ldlm_cli_cancel_unused(struct ldlm_namespace *ns,
2234 const struct ldlm_res_id *res_id,
2235 enum ldlm_cancel_flags flags, void *opaque)
2237 struct ldlm_cli_cancel_arg arg = {
2239 .lc_opaque = opaque,
2247 if (res_id != NULL) {
2248 RETURN(ldlm_cli_cancel_unused_resource(ns, res_id, NULL,
2252 cfs_hash_for_each_nolock(ns->ns_rs_hash,
2253 ldlm_cli_hash_cancel_unused, &arg, 0);
2258 /* Lock iterators. */
2260 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
2263 struct list_head *tmp, *next;
2264 struct ldlm_lock *lock;
2265 int rc = LDLM_ITER_CONTINUE;
2270 RETURN(LDLM_ITER_CONTINUE);
2273 list_for_each_safe(tmp, next, &res->lr_granted) {
2274 lock = list_entry(tmp, struct ldlm_lock, l_res_link);
2276 if (iter(lock, closure) == LDLM_ITER_STOP)
2277 GOTO(out, rc = LDLM_ITER_STOP);
2280 list_for_each_safe(tmp, next, &res->lr_waiting) {
2281 lock = list_entry(tmp, struct ldlm_lock, l_res_link);
2283 if (iter(lock, closure) == LDLM_ITER_STOP)
2284 GOTO(out, rc = LDLM_ITER_STOP);
2291 struct iter_helper_data {
2292 ldlm_iterator_t iter;
2296 static int ldlm_iter_helper(struct ldlm_lock *lock, void *closure)
2298 struct iter_helper_data *helper = closure;
2300 return helper->iter(lock, helper->closure);
2303 static int ldlm_res_iter_helper(struct cfs_hash *hs, struct cfs_hash_bd *bd,
2304 struct hlist_node *hnode, void *arg)
2307 struct ldlm_resource *res = cfs_hash_object(hs, hnode);
2309 return ldlm_resource_foreach(res, ldlm_iter_helper, arg) ==
2313 void ldlm_namespace_foreach(struct ldlm_namespace *ns,
2314 ldlm_iterator_t iter, void *closure)
2317 struct iter_helper_data helper = { .iter = iter, .closure = closure };
2319 cfs_hash_for_each_nolock(ns->ns_rs_hash,
2320 ldlm_res_iter_helper, &helper, 0);
2325 * non-blocking function to manipulate a lock whose cb_data is being put away.
2326 * return 0: find no resource
2327 * > 0: must be LDLM_ITER_STOP/LDLM_ITER_CONTINUE.
2330 int ldlm_resource_iterate(struct ldlm_namespace *ns,
2331 const struct ldlm_res_id *res_id,
2332 ldlm_iterator_t iter, void *data)
2334 struct ldlm_resource *res;
2339 LASSERTF(ns != NULL, "must pass in namespace\n");
2341 res = ldlm_resource_get(ns, NULL, res_id, 0, 0);
2345 LDLM_RESOURCE_ADDREF(res);
2346 rc = ldlm_resource_foreach(res, iter, data);
2347 LDLM_RESOURCE_DELREF(res);
2348 ldlm_resource_putref(res);
2351 EXPORT_SYMBOL(ldlm_resource_iterate);
2354 static int ldlm_chain_lock_for_replay(struct ldlm_lock *lock, void *closure)
2356 struct list_head *list = closure;
2358 /* we use l_pending_chain here, because it's unused on clients. */
2359 LASSERTF(list_empty(&lock->l_pending_chain),
2360 "lock %p next %p prev %p\n",
2361 lock, &lock->l_pending_chain.next,
2362 &lock->l_pending_chain.prev);
2364 * b=9573: don't replay locks left after eviction, or
2365 * b=17614: locks being actively cancelled. Get a reference
2366 * on a lock so that it does not disapear under us (e.g. due to cancel)
2368 if (!(lock->l_flags & (LDLM_FL_FAILED|LDLM_FL_BL_DONE))) {
2369 list_add(&lock->l_pending_chain, list);
2370 LDLM_LOCK_GET(lock);
2373 return LDLM_ITER_CONTINUE;
2376 static int replay_lock_interpret(const struct lu_env *env,
2377 struct ptlrpc_request *req, void *args, int rc)
2379 struct ldlm_async_args *aa = args;
2380 struct ldlm_lock *lock;
2381 struct ldlm_reply *reply;
2382 struct obd_export *exp;
2385 atomic_dec(&req->rq_import->imp_replay_inflight);
2386 wake_up(&req->rq_import->imp_replay_waitq);
2391 reply = req_capsule_server_get(&req->rq_pill, &RMF_DLM_REP);
2393 GOTO(out, rc = -EPROTO);
2395 lock = ldlm_handle2lock(&aa->lock_handle);
2397 CERROR("received replay ack for unknown local cookie %#llx remote cookie %#llx from server %s id %s\n",
2398 aa->lock_handle.cookie, reply->lock_handle.cookie,
2399 req->rq_export->exp_client_uuid.uuid,
2400 libcfs_id2str(req->rq_peer));
2401 GOTO(out, rc = -ESTALE);
2404 /* Key change rehash lock in per-export hash with new key */
2405 exp = req->rq_export;
2406 if (exp && exp->exp_lock_hash) {
2408 * In the function below, .hs_keycmp resolves to
2409 * ldlm_export_lock_keycmp()
2411 /* coverity[overrun-buffer-val] */
2412 cfs_hash_rehash_key(exp->exp_lock_hash,
2413 &lock->l_remote_handle,
2414 &reply->lock_handle,
2417 lock->l_remote_handle = reply->lock_handle;
2420 LDLM_DEBUG(lock, "replayed lock:");
2421 ptlrpc_import_recovery_state_machine(req->rq_import);
2422 LDLM_LOCK_PUT(lock);
2425 ptlrpc_connect_import(req->rq_import);
2430 static int replay_one_lock(struct obd_import *imp, struct ldlm_lock *lock)
2432 struct ptlrpc_request *req;
2433 struct ldlm_async_args *aa;
2434 struct ldlm_request *body;
2440 /* b=11974: Do not replay a lock which is actively being canceled */
2441 if (ldlm_is_bl_done(lock)) {
2442 LDLM_DEBUG(lock, "Not replaying canceled lock:");
2447 * If this is reply-less callback lock, we cannot replay it, since
2448 * server might have long dropped it, but notification of that event was
2449 * lost by network. (and server granted conflicting lock already)
2451 if (ldlm_is_cancel_on_block(lock)) {
2452 LDLM_DEBUG(lock, "Not replaying reply-less lock:");
2453 ldlm_lock_cancel(lock);
2458 * If granted mode matches the requested mode, this lock is granted.
2460 * If we haven't been granted anything and are on a resource list,
2461 * then we're blocked/waiting.
2463 * If we haven't been granted anything and we're NOT on a resource list,
2464 * then we haven't got a reply yet and don't have a known disposition.
2465 * This happens whenever a lock enqueue is the request that triggers
2468 if (ldlm_is_granted(lock))
2469 flags = LDLM_FL_REPLAY | LDLM_FL_BLOCK_GRANTED;
2470 else if (!list_empty(&lock->l_res_link))
2471 flags = LDLM_FL_REPLAY | LDLM_FL_BLOCK_WAIT;
2473 flags = LDLM_FL_REPLAY;
2475 req = ptlrpc_request_alloc_pack(imp, &RQF_LDLM_ENQUEUE,
2476 LUSTRE_DLM_VERSION, LDLM_ENQUEUE);
2480 /* We're part of recovery, so don't wait for it. */
2481 req->rq_send_state = LUSTRE_IMP_REPLAY_LOCKS;
2482 /* If the state changed while we were prepared, don't wait */
2483 req->rq_no_delay = 1;
2485 body = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
2486 ldlm_lock2desc(lock, &body->lock_desc);
2487 body->lock_flags = ldlm_flags_to_wire(flags);
2489 ldlm_lock2handle(lock, &body->lock_handle[0]);
2490 if (lock->l_lvb_len > 0)
2491 req_capsule_extend(&req->rq_pill, &RQF_LDLM_ENQUEUE_LVB);
2492 req_capsule_set_size(&req->rq_pill, &RMF_DLM_LVB, RCL_SERVER,
2494 ptlrpc_request_set_replen(req);
2496 * notify the server we've replayed all requests.
2497 * also, we mark the request to be put on a dedicated
2498 * queue to be processed after all request replayes.
2501 lustre_msg_set_flags(req->rq_reqmsg, MSG_REQ_REPLAY_DONE);
2503 LDLM_DEBUG(lock, "replaying lock:");
2505 atomic_inc(&imp->imp_replay_inflight);
2506 aa = ptlrpc_req_async_args(aa, req);
2507 aa->lock_handle = body->lock_handle[0];
2508 req->rq_interpret_reply = replay_lock_interpret;
2509 ptlrpcd_add_req(req);
2515 * Cancel as many unused locks as possible before replay. since we are
2516 * in recovery, we can't wait for any outstanding RPCs to send any RPC
2519 * Called only in recovery before replaying locks. there is no need to
2520 * replay locks that are unused. since the clients may hold thousands of
2521 * cached unused locks, dropping the unused locks can greatly reduce the
2522 * load on the servers at recovery time.
2524 static void ldlm_cancel_unused_locks_for_replay(struct ldlm_namespace *ns)
2530 "Dropping as many unused locks as possible before replay for namespace %s (%d)\n",
2531 ldlm_ns_name(ns), ns->ns_nr_unused);
2533 OBD_FAIL_TIMEOUT(OBD_FAIL_LDLM_REPLAY_PAUSE, cfs_fail_val);
2536 * We don't need to care whether or not LRU resize is enabled
2537 * because the LDLM_LRU_FLAG_NO_WAIT policy doesn't use the
2540 canceled = ldlm_cancel_lru_local(ns, &cancels, ns->ns_nr_unused, 0,
2541 LCF_LOCAL, LDLM_LRU_FLAG_NO_WAIT);
2543 CDEBUG(D_DLMTRACE, "Canceled %d unused locks from namespace %s\n",
2544 canceled, ldlm_ns_name(ns));
2547 static int lock_can_replay(struct obd_import *imp)
2549 struct client_obd *cli = &imp->imp_obd->u.cli;
2551 CDEBUG(D_HA, "check lock replay limit, inflights = %u(%u)\n",
2552 atomic_read(&imp->imp_replay_inflight) - 1,
2553 cli->cl_max_rpcs_in_flight);
2555 /* +1 due to ldlm_lock_replay() increment */
2556 return atomic_read(&imp->imp_replay_inflight) <
2557 1 + min_t(u32, cli->cl_max_rpcs_in_flight, 8);
2560 int __ldlm_replay_locks(struct obd_import *imp, bool rate_limit)
2562 struct ldlm_namespace *ns = imp->imp_obd->obd_namespace;
2564 struct ldlm_lock *lock, *next;
2569 while (atomic_read(&imp->imp_replay_inflight) != 1)
2572 /* don't replay locks if import failed recovery */
2573 if (imp->imp_vbr_failed)
2576 if (ldlm_cancel_unused_locks_before_replay)
2577 ldlm_cancel_unused_locks_for_replay(ns);
2579 ldlm_namespace_foreach(ns, ldlm_chain_lock_for_replay, &list);
2581 list_for_each_entry_safe(lock, next, &list, l_pending_chain) {
2582 list_del_init(&lock->l_pending_chain);
2583 /* If we disconnected in the middle - cleanup and let
2584 * reconnection to happen again. LU-14027 */
2585 if (rc || (imp->imp_state != LUSTRE_IMP_REPLAY_LOCKS)) {
2586 LDLM_LOCK_RELEASE(lock);
2589 rc = replay_one_lock(imp, lock);
2590 LDLM_LOCK_RELEASE(lock);
2593 wait_event_idle_exclusive(imp->imp_replay_waitq,
2594 lock_can_replay(imp));
2601 * Lock replay uses rate control and can sleep waiting so
2602 * must be in separate thread from ptlrpcd itself
2604 static int ldlm_lock_replay_thread(void *data)
2606 struct obd_import *imp = data;
2608 CDEBUG(D_HA, "lock replay thread %s to %s@%s\n",
2609 imp->imp_obd->obd_name, obd2cli_tgt(imp->imp_obd),
2610 imp->imp_connection->c_remote_uuid.uuid);
2612 __ldlm_replay_locks(imp, true);
2613 atomic_dec(&imp->imp_replay_inflight);
2614 ptlrpc_import_recovery_state_machine(imp);
2615 class_import_put(imp);
2620 int ldlm_replay_locks(struct obd_import *imp)
2622 struct task_struct *task;
2625 /* ensure this doesn't fall to 0 before all have been queued */
2626 if (atomic_inc_return(&imp->imp_replay_inflight) > 1) {
2627 atomic_dec(&imp->imp_replay_inflight);
2630 class_import_get(imp);
2632 task = kthread_run(ldlm_lock_replay_thread, imp, "ldlm_lock_replay");
2635 CDEBUG(D_HA, "can't start lock replay thread: rc = %d\n", rc);
2637 /* run lock replay without rate control */
2638 rc = __ldlm_replay_locks(imp, false);
2639 atomic_dec(&imp->imp_replay_inflight);
2640 class_import_put(imp);