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.
33 * This file contains Asynchronous System Trap (AST) handlers and related
34 * LDLM request-processing routines.
36 * An AST is a callback issued on a lock when its state is changed. There are
37 * several different types of ASTs (callbacks) registered for each lock:
39 * - completion AST: when a lock is enqueued by some process, but cannot be
40 * granted immediately due to other conflicting locks on the same resource,
41 * the completion AST is sent to notify the caller when the lock is
44 * - blocking AST: when a lock is granted to some process, if another process
45 * enqueues a conflicting (blocking) lock on a resource, a blocking AST is
46 * sent to notify the holder(s) of the lock(s) of the conflicting lock
47 * request. The lock holder(s) must release their lock(s) on that resource in
48 * a timely manner or be evicted by the server.
50 * - glimpse AST: this is used when a process wants information about a lock
51 * (i.e. the lock value block (LVB)) but does not necessarily require holding
52 * the lock. If the resource is locked, the lock holder(s) are sent glimpse
53 * ASTs and the LVB is returned to the caller, and lock holder(s) may CANCEL
54 * their lock(s) if they are idle. If the resource is not locked, the server
58 #define DEBUG_SUBSYSTEM S_LDLM
60 #include <lustre_errno.h>
61 #include <lustre_dlm.h>
62 #include <obd_class.h>
65 #include "ldlm_internal.h"
67 unsigned int ldlm_enqueue_min = OBD_TIMEOUT_DEFAULT;
68 module_param(ldlm_enqueue_min, uint, 0644);
69 MODULE_PARM_DESC(ldlm_enqueue_min, "lock enqueue timeout minimum");
70 EXPORT_SYMBOL(ldlm_enqueue_min);
72 /* in client side, whether the cached locks will be canceled before replay */
73 unsigned int ldlm_cancel_unused_locks_before_replay = 1;
75 struct lock_wait_data {
76 struct ldlm_lock *lwd_lock;
80 struct ldlm_async_args {
81 struct lustre_handle lock_handle;
85 * ldlm_request_bufsize
87 * If opcode=LDLM_ENQUEUE, 1 slot is already occupied,
88 * LDLM_LOCKREQ_HANDLE -1 slots are available.
89 * Otherwise, LDLM_LOCKREQ_HANDLE slots are available.
94 * \retval size of the request buffer
96 int ldlm_request_bufsize(int count, int type)
98 int avail = LDLM_LOCKREQ_HANDLES;
100 if (type == LDLM_ENQUEUE)
101 avail -= LDLM_ENQUEUE_CANCEL_OFF;
104 avail = (count - avail) * sizeof(struct lustre_handle);
108 return sizeof(struct ldlm_request) + avail;
111 void ldlm_expired_completion_wait(struct lock_wait_data *lwd)
113 struct ldlm_lock *lock = lwd->lwd_lock;
114 struct obd_import *imp;
115 struct obd_device *obd;
118 if (lock->l_conn_export == NULL) {
119 static time64_t next_dump, last_dump;
122 "lock timed out (enqueued at %lld, %llds ago); not entering recovery in server code, just going back to sleep",
124 ktime_get_real_seconds() - lock->l_activity);
125 if (ktime_get_seconds() > next_dump) {
126 last_dump = next_dump;
127 next_dump = ktime_get_seconds() + 300;
128 ldlm_namespace_dump(D_DLMTRACE,
129 ldlm_lock_to_ns(lock));
131 libcfs_debug_dumplog();
136 obd = lock->l_conn_export->exp_obd;
137 imp = obd->u.cli.cl_import;
138 ptlrpc_fail_import(imp, lwd->lwd_conn_cnt);
140 "lock timed out (enqueued at %lld, %llds ago), entering recovery for %s@%s",
142 ktime_get_real_seconds() - lock->l_activity,
143 obd2cli_tgt(obd), imp->imp_connection->c_remote_uuid.uuid);
148 int is_granted_or_cancelled_nolock(struct ldlm_lock *lock)
152 check_res_locked(lock->l_resource);
153 if (ldlm_is_granted(lock) && !ldlm_is_cp_reqd(lock))
155 else if (ldlm_is_failed(lock) || ldlm_is_cancel(lock))
159 EXPORT_SYMBOL(is_granted_or_cancelled_nolock);
162 * Calculate the Completion timeout (covering enqueue, BL AST, data flush,
163 * lock cancel, and their replies). Used for lock completion timeout on the
166 * \param[in] lock lock which is waiting the completion callback
168 * \retval timeout in seconds to wait for the server reply
171 * We use the same basis for both server side and client side functions
172 * from a single node.
174 static timeout_t ldlm_cp_timeout(struct ldlm_lock *lock)
182 * Wait a long time for enqueue - server may have to callback a
183 * lock from another client. Server will evict the other client if it
184 * doesn't respond reasonably, and then give us the lock.
186 timeout = at_get(ldlm_lock_to_ns_at(lock));
187 return max(3 * timeout, (timeout_t)ldlm_enqueue_min);
191 * Helper function for ldlm_completion_ast(), updating timings when lock is
194 static int ldlm_completion_tail(struct ldlm_lock *lock, void *data)
198 if (ldlm_is_destroyed(lock) || ldlm_is_failed(lock)) {
199 LDLM_DEBUG(lock, "client-side enqueue: destroyed");
201 } else if (data == NULL) {
202 LDLM_DEBUG(lock, "client-side enqueue: granted");
204 /* Take into AT only CP RPC, not immediately granted locks */
207 /* Discard negative timeouts. We should also limit the
208 * maximum value of the timeout
210 if (ktime_get_real_seconds() > lock->l_activity)
211 delay = ktime_get_real_seconds() - lock->l_activity;
213 LDLM_DEBUG(lock, "client-side enqueue: granted after %ds",
215 /* Update our time estimate */
216 at_measured(ldlm_lock_to_ns_at(lock), delay);
222 * Implementation of ->l_completion_ast() for a client, that doesn't wait
223 * until lock is granted. Suitable for locks enqueued through ptlrpcd, of
224 * other threads that cannot block for long.
226 int ldlm_completion_ast_async(struct ldlm_lock *lock, __u64 flags, void *data)
230 if (flags == LDLM_FL_WAIT_NOREPROC) {
231 LDLM_DEBUG(lock, "client-side enqueue waiting on pending lock");
235 if (!(flags & LDLM_FL_BLOCKED_MASK)) {
236 wake_up(&lock->l_waitq);
237 RETURN(ldlm_completion_tail(lock, data));
241 "client-side enqueue returned a blocked lock, going forward");
242 ldlm_reprocess_all(lock->l_resource, NULL);
245 EXPORT_SYMBOL(ldlm_completion_ast_async);
248 * Generic LDLM "completion" AST. This is called in several cases:
250 * - when a reply to an ENQUEUE RPC is received from the server
251 * (ldlm_cli_enqueue_fini()). Lock might be granted or not granted at
252 * this point (determined by flags);
254 * - when LDLM_CP_CALLBACK RPC comes to client to notify it that lock has
257 * - when ldlm_lock_match(LDLM_FL_LVB_READY) is about to wait until lock
260 * - to force all locks when resource is destroyed (cleanup_resource());
262 * If lock is not granted in the first case, this function waits until second
263 * or penultimate cases happen in some other thread.
266 int ldlm_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data)
268 /* XXX ALLOCATE - 160 bytes */
269 struct lock_wait_data lwd;
270 struct obd_device *obd;
271 struct obd_import *imp = NULL;
277 if (flags == LDLM_FL_WAIT_NOREPROC) {
278 LDLM_DEBUG(lock, "client-side enqueue waiting on pending lock");
282 if (!(flags & LDLM_FL_BLOCKED_MASK)) {
283 wake_up(&lock->l_waitq);
287 LDLM_DEBUG(lock, "client-side enqueue returned a blocked locksleeping");
291 obd = class_exp2obd(lock->l_conn_export);
293 /* if this is a local lock, then there is no import */
295 imp = obd->u.cli.cl_import;
297 timeout = ldlm_cp_timeout(lock);
300 lock->l_activity = ktime_get_real_seconds();
303 spin_lock(&imp->imp_lock);
304 lwd.lwd_conn_cnt = imp->imp_conn_cnt;
305 spin_unlock(&imp->imp_lock);
308 if (ns_is_client(ldlm_lock_to_ns(lock)) &&
309 OBD_FAIL_CHECK_RESET(OBD_FAIL_LDLM_INTR_CP_AST,
310 OBD_FAIL_LDLM_CP_BL_RACE | OBD_FAIL_ONCE)) {
311 ldlm_set_fail_loc(lock);
314 /* Go to sleep until the lock is granted or cancelled. */
315 if (ldlm_is_no_timeout(lock)) {
316 LDLM_DEBUG(lock, "waiting indefinitely because of NO_TIMEOUT");
317 rc = l_wait_event_abortable(
319 is_granted_or_cancelled(lock));
321 if (wait_event_idle_timeout(
323 is_granted_or_cancelled(lock),
324 cfs_time_seconds(timeout)) == 0) {
325 ldlm_expired_completion_wait(&lwd);
326 rc = l_wait_event_abortable(
328 is_granted_or_cancelled(lock));
334 LDLM_DEBUG(lock, "client-side enqueue waking up: failed (%d)",
339 RETURN(ldlm_completion_tail(lock, data));
341 EXPORT_SYMBOL(ldlm_completion_ast);
344 * A helper to build a blocking AST function
346 * Perform a common operation for blocking ASTs:
347 * defferred lock cancellation.
349 * \param lock the lock blocking or canceling AST was called on
351 * \see mdt_blocking_ast
352 * \see ldlm_blocking_ast
354 int ldlm_blocking_ast_nocheck(struct ldlm_lock *lock)
360 ldlm_set_cbpending(lock);
361 do_ast = (!lock->l_readers && !lock->l_writers);
362 unlock_res_and_lock(lock);
365 struct lustre_handle lockh;
368 LDLM_DEBUG(lock, "already unused, calling ldlm_cli_cancel");
369 ldlm_lock2handle(lock, &lockh);
370 rc = ldlm_cli_cancel(&lockh, LCF_ASYNC);
372 CERROR("ldlm_cli_cancel: %d\n", rc);
375 "Lock still has references, will be cancelled later");
379 EXPORT_SYMBOL(ldlm_blocking_ast_nocheck);
382 * Server blocking AST
384 * ->l_blocking_ast() callback for LDLM locks acquired by server-side
387 * \param lock the lock which blocks a request or cancelling lock
390 * \param flag indicates whether this cancelling or blocking callback
392 * \see ldlm_blocking_ast_nocheck
394 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
395 void *data, int flag)
399 if (flag == LDLM_CB_CANCELING) {
400 /* Don't need to do anything here. */
404 lock_res_and_lock(lock);
406 * Get this: if ldlm_blocking_ast is racing with intent_policy, such
407 * that ldlm_blocking_ast is called just before intent_policy method
408 * takes the lr_lock, then by the time we get the lock, we might not
409 * be the correct blocking function anymore. So check, and return
412 if (lock->l_blocking_ast != ldlm_blocking_ast) {
413 unlock_res_and_lock(lock);
416 RETURN(ldlm_blocking_ast_nocheck(lock));
418 EXPORT_SYMBOL(ldlm_blocking_ast);
421 * Implements ldlm_lock::l_glimpse_ast for extent locks acquired on the server.
423 * Returning -ELDLM_NO_LOCK_DATA actually works, but the reason for that is
424 * rather subtle: with OST-side locking, it may so happen that _all_ extent
425 * locks are held by the OST. If client wants to obtain the current file size
426 * it calls ll_glimpse_size(), and (as all locks are held only on the server),
427 * this dummy glimpse callback fires and does nothing. The client still
428 * receives the correct file size due to the following fragment of code in
429 * ldlm_cb_interpret():
431 * if (rc == -ELDLM_NO_LOCK_DATA) {
432 * LDLM_DEBUG(lock, "lost race - client has a lock but no"
434 * ldlm_res_lvbo_update(lock->l_resource, NULL, 1);
437 * That is, after the glimpse returns this error, ofd_lvbo_update() is called
438 * and returns the updated file attributes from the inode to the client.
440 * See also comment in ofd_intent_policy() on why servers must set a non-NULL
441 * l_glimpse_ast when grabbing DLM locks. Otherwise, the server will assume
442 * that the object is in the process of being destroyed.
444 * \param[in] lock DLM lock being glimpsed, unused
445 * \param[in] reqp pointer to ptlrpc_request, unused
447 * \retval -ELDLM_NO_LOCK_DATA to get attributes from disk object
449 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp)
451 return -ELDLM_NO_LOCK_DATA;
455 * Enqueue a local lock (typically on a server).
457 int ldlm_cli_enqueue_local(const struct lu_env *env,
458 struct ldlm_namespace *ns,
459 const struct ldlm_res_id *res_id,
460 enum ldlm_type type, union ldlm_policy_data *policy,
461 enum ldlm_mode mode, __u64 *flags,
462 ldlm_blocking_callback blocking,
463 ldlm_completion_callback completion,
464 ldlm_glimpse_callback glimpse,
465 void *data, __u32 lvb_len, enum lvb_type lvb_type,
466 const __u64 *client_cookie,
467 struct lustre_handle *lockh)
469 struct ldlm_lock *lock;
471 const struct ldlm_callback_suite cbs = { .lcs_completion = completion,
472 .lcs_blocking = blocking,
473 .lcs_glimpse = glimpse,
478 LASSERT(!(*flags & LDLM_FL_REPLAY));
479 if (unlikely(ns_is_client(ns))) {
480 CERROR("Trying to enqueue local lock in a shadow namespace\n");
484 lock = ldlm_lock_create(ns, res_id, type, mode, &cbs, data, lvb_len,
487 GOTO(out_nolock, err = PTR_ERR(lock));
489 err = ldlm_lvbo_init(lock->l_resource);
491 LDLM_ERROR(lock, "delayed lvb init failed (rc %d)", err);
492 ldlm_lock_destroy_nolock(lock);
496 ldlm_lock2handle(lock, lockh);
499 * NB: we don't have any lock now (lock_res_and_lock)
500 * because it's a new lock
502 ldlm_lock_addref_internal_nolock(lock, mode);
503 ldlm_set_local(lock);
504 if (*flags & LDLM_FL_ATOMIC_CB)
505 ldlm_set_atomic_cb(lock);
507 if (*flags & LDLM_FL_CANCEL_ON_BLOCK)
508 ldlm_set_cancel_on_block(lock);
511 lock->l_policy_data = *policy;
512 if (client_cookie != NULL)
513 lock->l_client_cookie = *client_cookie;
514 if (type == LDLM_EXTENT) {
515 /* extent lock without policy is a bug */
519 lock->l_req_extent = policy->l_extent;
522 err = ldlm_lock_enqueue(env, ns, &lock, policy, flags);
523 if (unlikely(err != ELDLM_OK))
527 *policy = lock->l_policy_data;
529 if (lock->l_completion_ast)
530 lock->l_completion_ast(lock, *flags, NULL);
532 LDLM_DEBUG(lock, "client-side local enqueue handler, new lock created");
535 LDLM_LOCK_RELEASE(lock);
539 EXPORT_SYMBOL(ldlm_cli_enqueue_local);
541 static void failed_lock_cleanup(struct ldlm_namespace *ns,
542 struct ldlm_lock *lock, int mode)
546 /* Set a flag to prevent us from sending a CANCEL (b=407) */
547 lock_res_and_lock(lock);
548 /* Check that lock is not granted or failed, we might race. */
549 if (!ldlm_is_granted(lock) && !ldlm_is_failed(lock)) {
551 * Make sure that this lock will not be found by raced
552 * bl_ast and -EINVAL reply is sent to server anyways.
555 lock->l_flags |= LDLM_FL_FAILED |
556 LDLM_FL_ATOMIC_CB | LDLM_FL_CBPENDING;
557 if (!(ldlm_is_bl_ast(lock) &&
558 lock->l_remote_handle.cookie != 0))
559 lock->l_flags |= LDLM_FL_LOCAL_ONLY;
562 unlock_res_and_lock(lock);
566 "setting FL_LOCAL_ONLY | LDLM_FL_FAILED | LDLM_FL_ATOMIC_CB | LDLM_FL_CBPENDING");
568 LDLM_DEBUG(lock, "lock was granted or failed in race");
571 * XXX - HACK because we shouldn't call ldlm_lock_destroy()
572 * from llite/file.c/ll_file_flock().
575 * This code makes for the fact that we do not have blocking handler on
576 * a client for flock locks. As such this is the place where we must
577 * completely kill failed locks. (interrupted and those that
578 * were waiting to be granted when server evicted us.
580 if (lock->l_resource->lr_type == LDLM_FLOCK) {
581 lock_res_and_lock(lock);
582 if (!ldlm_is_destroyed(lock)) {
583 ldlm_resource_unlink_lock(lock);
584 ldlm_lock_decref_internal_nolock(lock, mode);
585 ldlm_lock_destroy_nolock(lock);
587 unlock_res_and_lock(lock);
589 ldlm_lock_decref_internal(lock, mode);
593 static bool ldlm_request_slot_needed(struct ldlm_enqueue_info *einfo)
595 /* exclude EXTENT locks and DOM-only IBITS locks because they
596 * are asynchronous and don't wait on server being blocked.
598 return einfo->ei_type == LDLM_FLOCK ||
599 (einfo->ei_type == LDLM_IBITS &&
600 einfo->ei_inodebits != MDS_INODELOCK_DOM);
604 * Finishing portion of client lock enqueue code.
606 * Called after receiving reply from server.
608 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
609 struct ldlm_enqueue_info *einfo,
610 __u8 with_policy, __u64 *ldlm_flags, void *lvb,
611 __u32 lvb_len, const struct lustre_handle *lockh,
614 struct ldlm_namespace *ns = exp->exp_obd->obd_namespace;
615 const struct lu_env *env = NULL;
616 int is_replay = *ldlm_flags & LDLM_FL_REPLAY;
617 struct ldlm_lock *lock;
618 struct ldlm_reply *reply;
619 int cleanup_phase = 1;
623 if (ldlm_request_slot_needed(einfo))
624 obd_put_request_slot(&req->rq_import->imp_obd->u.cli);
626 ptlrpc_put_mod_rpc_slot(req);
628 if (req && req->rq_svc_thread)
629 env = req->rq_svc_thread->t_env;
631 lock = ldlm_handle2lock(lockh);
632 /* ldlm_cli_enqueue is holding a reference on this lock. */
634 LASSERT(einfo->ei_type == LDLM_FLOCK);
638 LASSERTF(ergo(lvb_len != 0, lvb_len == lock->l_lvb_len),
639 "lvb_len = %d, l_lvb_len = %d\n", lvb_len, lock->l_lvb_len);
641 if (rc != ELDLM_OK) {
643 LDLM_DEBUG(lock, "client-side enqueue END (%s)",
644 rc == ELDLM_LOCK_ABORTED ? "ABORTED" : "FAILED");
646 if (rc != ELDLM_LOCK_ABORTED)
650 /* Before we return, swab the reply */
651 reply = req_capsule_server_get(&req->rq_pill, &RMF_DLM_REP);
653 GOTO(cleanup, rc = -EPROTO);
658 size = req_capsule_get_size(&req->rq_pill, &RMF_DLM_LVB,
661 LDLM_ERROR(lock, "Fail to get lvb_len, rc = %d", size);
662 GOTO(cleanup, rc = size);
663 } else if (unlikely(size > lvb_len)) {
665 "Replied LVB is larger than expectation, expected = %d, replied = %d",
667 GOTO(cleanup, rc = -EINVAL);
672 if (rc == ELDLM_LOCK_ABORTED) {
673 if (lvb_len > 0 && lvb != NULL)
674 rc = ldlm_fill_lvb(lock, &req->rq_pill, RCL_SERVER,
676 GOTO(cleanup, rc = rc ? : ELDLM_LOCK_ABORTED);
679 /* lock enqueued on the server */
682 lock_res_and_lock(lock);
683 /* Key change rehash lock in per-export hash with new key */
684 if (exp->exp_lock_hash) {
686 * In the function below, .hs_keycmp resolves to
687 * ldlm_export_lock_keycmp()
689 /* coverity[overrun-buffer-val] */
690 cfs_hash_rehash_key(exp->exp_lock_hash,
691 &lock->l_remote_handle,
695 lock->l_remote_handle = reply->lock_handle;
698 *ldlm_flags = ldlm_flags_from_wire(reply->lock_flags);
699 lock->l_flags |= ldlm_flags_from_wire(reply->lock_flags &
700 LDLM_FL_INHERIT_MASK);
701 unlock_res_and_lock(lock);
703 CDEBUG(D_INFO, "local: %p, remote cookie: %#llx, flags: %#llx\n",
704 lock, reply->lock_handle.cookie, *ldlm_flags);
707 * If enqueue returned a blocked lock but the completion handler has
708 * already run, then it fixed up the resource and we don't need to do it
711 if ((*ldlm_flags) & LDLM_FL_LOCK_CHANGED) {
712 int newmode = reply->lock_desc.l_req_mode;
715 if (newmode && newmode != lock->l_req_mode) {
716 LDLM_DEBUG(lock, "server returned different mode %s",
717 ldlm_lockname[newmode]);
718 lock->l_req_mode = newmode;
721 if (!ldlm_res_eq(&reply->lock_desc.l_resource.lr_name,
722 &lock->l_resource->lr_name)) {
724 "remote intent success, locking "DLDLMRES", instead of "DLDLMRES"\n",
725 PLDLMRES(&reply->lock_desc.l_resource),
726 PLDLMRES(lock->l_resource));
728 rc = ldlm_lock_change_resource(ns, lock,
729 &reply->lock_desc.l_resource.lr_name);
730 if (rc || lock->l_resource == NULL)
731 GOTO(cleanup, rc = -ENOMEM);
732 LDLM_DEBUG(lock, "client-side enqueue, new resource");
736 /* We assume lock type cannot change on server*/
737 ldlm_convert_policy_to_local(exp,
738 lock->l_resource->lr_type,
739 &reply->lock_desc.l_policy_data,
740 &lock->l_policy_data);
743 if (einfo->ei_type != LDLM_PLAIN)
745 "client-side enqueue, new policy data");
748 if ((*ldlm_flags) & LDLM_FL_AST_SENT) {
749 lock_res_and_lock(lock);
750 ldlm_bl_desc2lock(&reply->lock_desc, lock);
751 lock->l_flags |= LDLM_FL_CBPENDING | LDLM_FL_BL_AST;
752 unlock_res_and_lock(lock);
753 LDLM_DEBUG(lock, "enqueue reply includes blocking AST");
757 * If the lock has already been granted by a completion AST, don't
758 * clobber the LVB with an older one.
762 * We must lock or a racing completion might update lvb without
763 * letting us know and we'll clobber the correct value.
764 * Cannot unlock after the check either, a that still leaves
765 * a tiny window for completion to get in
767 lock_res_and_lock(lock);
768 if (!ldlm_is_granted(lock))
769 rc = ldlm_fill_lvb(lock, &req->rq_pill, RCL_SERVER,
770 lock->l_lvb_data, lvb_len);
771 unlock_res_and_lock(lock);
779 rc = ldlm_lock_enqueue(env, ns, &lock, NULL, ldlm_flags);
780 if (lock->l_completion_ast != NULL) {
781 int err = lock->l_completion_ast(lock, *ldlm_flags,
791 if (lvb_len > 0 && lvb != NULL) {
793 * Copy the LVB here, and not earlier, because the completion
794 * AST (if any) can override what we got in the reply
796 memcpy(lvb, lock->l_lvb_data, lvb_len);
799 LDLM_DEBUG(lock, "client-side enqueue END");
802 if (cleanup_phase == 1 && rc)
803 failed_lock_cleanup(ns, lock, einfo->ei_mode);
804 /* Put lock 2 times, the second reference is held by ldlm_cli_enqueue */
806 LDLM_LOCK_RELEASE(lock);
809 EXPORT_SYMBOL(ldlm_cli_enqueue_fini);
812 * Estimate number of lock handles that would fit into request of given
813 * size. PAGE_SIZE-512 is to allow TCP/IP and LNET headers to fit into
814 * a single page on the send/receive side. XXX: 512 should be changed to
815 * more adequate value.
817 static inline int ldlm_req_handles_avail(int req_size, int off)
821 avail = min_t(int, LDLM_MAXREQSIZE, PAGE_SIZE - 512) - req_size;
822 if (likely(avail >= 0))
823 avail /= (int)sizeof(struct lustre_handle);
826 avail += LDLM_LOCKREQ_HANDLES - off;
831 static inline int ldlm_capsule_handles_avail(struct req_capsule *pill,
832 enum req_location loc,
835 __u32 size = req_capsule_msg_size(pill, loc);
837 return ldlm_req_handles_avail(size, off);
840 static inline int ldlm_format_handles_avail(struct obd_import *imp,
841 const struct req_format *fmt,
842 enum req_location loc, int off)
844 __u32 size = req_capsule_fmt_size(imp->imp_msg_magic, fmt, loc);
846 return ldlm_req_handles_avail(size, off);
850 * Cancel LRU locks and pack them into the enqueue request. Pack there the given
851 * \a count locks in \a cancels.
853 * This is to be called by functions preparing their own requests that
854 * might contain lists of locks to cancel in addition to actual operation
855 * that needs to be performed.
857 int ldlm_prep_elc_req(struct obd_export *exp, struct ptlrpc_request *req,
858 int version, int opc, int canceloff,
859 struct list_head *cancels, int count)
861 struct ldlm_namespace *ns = exp->exp_obd->obd_namespace;
862 struct req_capsule *pill = &req->rq_pill;
863 struct ldlm_request *dlm = NULL;
865 int avail, to_free = 0, pack = 0;
872 if (ns_connect_cancelset(ns)) {
873 /* Estimate the amount of available space in the request. */
874 req_capsule_filled_sizes(pill, RCL_CLIENT);
875 avail = ldlm_capsule_handles_avail(pill, RCL_CLIENT, canceloff);
877 /* If we have reached the limit, free +1 slot for the new one */
878 if (!ns_connect_lru_resize(ns) && opc == LDLM_ENQUEUE &&
879 ns->ns_nr_unused >= ns->ns_max_unused)
883 * Cancel LRU locks here _only_ if the server supports
884 * EARLY_CANCEL. Otherwise we have to send extra CANCEL
885 * RPC, which will make us slower.
888 count += ldlm_cancel_lru_local(ns, cancels, to_free,
890 LDLM_LRU_FLAG_NO_WAIT);
895 req_capsule_set_size(pill, &RMF_DLM_REQ, RCL_CLIENT,
896 ldlm_request_bufsize(pack, opc));
899 rc = ptlrpc_request_pack(req, version, opc);
901 ldlm_lock_list_put(cancels, l_bl_ast, count);
905 if (ns_connect_cancelset(ns)) {
907 dlm = req_capsule_client_get(pill, &RMF_DLM_REQ);
910 * Skip first lock handler in ldlm_request_pack(),
911 * this method will increment @lock_count according
912 * to the lock handle amount actually written to
915 dlm->lock_count = canceloff;
917 /* Pack into the request @pack lock handles. */
918 ldlm_cli_cancel_list(cancels, pack, req, 0);
919 /* Prepare and send separate cancel RPC for others. */
920 ldlm_cli_cancel_list(cancels, count - pack, NULL, 0);
922 ldlm_lock_list_put(cancels, l_bl_ast, count);
926 EXPORT_SYMBOL(ldlm_prep_elc_req);
928 int ldlm_prep_enqueue_req(struct obd_export *exp, struct ptlrpc_request *req,
929 struct list_head *cancels, int count)
931 return ldlm_prep_elc_req(exp, req, LUSTRE_DLM_VERSION, LDLM_ENQUEUE,
932 LDLM_ENQUEUE_CANCEL_OFF, cancels, count);
934 EXPORT_SYMBOL(ldlm_prep_enqueue_req);
936 struct ptlrpc_request *ldlm_enqueue_pack(struct obd_export *exp, int lvb_len)
938 struct ptlrpc_request *req;
943 req = ptlrpc_request_alloc(class_exp2cliimp(exp), &RQF_LDLM_ENQUEUE);
945 RETURN(ERR_PTR(-ENOMEM));
947 rc = ldlm_prep_enqueue_req(exp, req, NULL, 0);
949 ptlrpc_request_free(req);
953 req_capsule_set_size(&req->rq_pill, &RMF_DLM_LVB, RCL_SERVER, lvb_len);
954 ptlrpc_request_set_replen(req);
957 EXPORT_SYMBOL(ldlm_enqueue_pack);
960 * Client-side lock enqueue.
962 * If a request has some specific initialisation it is passed in \a reqp,
963 * otherwise it is created in ldlm_cli_enqueue.
965 * Supports sync and async requests, pass \a async flag accordingly. If a
966 * request was created in ldlm_cli_enqueue and it is the async request,
967 * pass it to the caller in \a reqp.
969 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
970 struct ldlm_enqueue_info *einfo,
971 const struct ldlm_res_id *res_id,
972 union ldlm_policy_data const *policy, __u64 *flags,
973 void *lvb, __u32 lvb_len, enum lvb_type lvb_type,
974 struct lustre_handle *lockh, int async)
976 struct ldlm_namespace *ns;
977 struct ldlm_lock *lock;
978 struct ldlm_request *body;
979 int is_replay = *flags & LDLM_FL_REPLAY;
980 int req_passed_in = 1;
982 struct ptlrpc_request *req;
986 LASSERT(exp != NULL);
988 ns = exp->exp_obd->obd_namespace;
991 * If we're replaying this lock, just check some invariants.
992 * If we're creating a new lock, get everything all setup nice.
995 lock = ldlm_handle2lock_long(lockh, 0);
996 LASSERT(lock != NULL);
997 LDLM_DEBUG(lock, "client-side enqueue START");
998 LASSERT(exp == lock->l_conn_export);
1000 const struct ldlm_callback_suite cbs = {
1001 .lcs_completion = einfo->ei_cb_cp,
1002 .lcs_blocking = einfo->ei_cb_bl,
1003 .lcs_glimpse = einfo->ei_cb_gl
1005 lock = ldlm_lock_create(ns, res_id, einfo->ei_type,
1006 einfo->ei_mode, &cbs, einfo->ei_cbdata,
1009 RETURN(PTR_ERR(lock));
1011 if (einfo->ei_cb_created)
1012 einfo->ei_cb_created(lock);
1014 /* for the local lock, add the reference */
1015 ldlm_lock_addref_internal(lock, einfo->ei_mode);
1016 ldlm_lock2handle(lock, lockh);
1018 lock->l_policy_data = *policy;
1020 if (einfo->ei_type == LDLM_EXTENT) {
1021 /* extent lock without policy is a bug */
1025 lock->l_req_extent = policy->l_extent;
1027 LDLM_DEBUG(lock, "client-side enqueue START, flags %#llx",
1031 lock->l_conn_export = exp;
1032 lock->l_export = NULL;
1033 lock->l_blocking_ast = einfo->ei_cb_bl;
1034 lock->l_flags |= (*flags & (LDLM_FL_NO_LRU | LDLM_FL_EXCL |
1035 LDLM_FL_ATOMIC_CB));
1036 lock->l_activity = ktime_get_real_seconds();
1038 /* lock not sent to server yet */
1039 if (reqp == NULL || *reqp == NULL) {
1040 req = ldlm_enqueue_pack(exp, lvb_len);
1042 failed_lock_cleanup(ns, lock, einfo->ei_mode);
1043 LDLM_LOCK_RELEASE(lock);
1044 RETURN(PTR_ERR(req));
1054 len = req_capsule_get_size(&req->rq_pill, &RMF_DLM_REQ,
1056 LASSERTF(len >= sizeof(*body), "buflen[%d] = %d, not %d\n",
1057 DLM_LOCKREQ_OFF, len, (int)sizeof(*body));
1060 if (*flags & LDLM_FL_NDELAY) {
1061 DEBUG_REQ(D_DLMTRACE, req, "enqueue lock with no delay");
1062 req->rq_no_resend = req->rq_no_delay = 1;
1064 * probably set a shorter timeout value and handle ETIMEDOUT
1065 * in osc_lock_upcall() correctly
1067 /* lustre_msg_set_timeout(req, req->rq_timeout / 2); */
1070 /* Dump lock data into the request buffer */
1071 body = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
1072 ldlm_lock2desc(lock, &body->lock_desc);
1073 body->lock_flags = ldlm_flags_to_wire(*flags);
1074 body->lock_handle[0] = *lockh;
1076 /* extended LDLM opcodes in client stats */
1077 if (exp->exp_obd->obd_svc_stats != NULL) {
1078 /* glimpse is intent with no intent buffer */
1079 if (*flags & LDLM_FL_HAS_INTENT &&
1080 !req_capsule_has_field(&req->rq_pill, &RMF_LDLM_INTENT,
1082 lprocfs_counter_incr(exp->exp_obd->obd_svc_stats,
1084 LDLM_GLIMPSE_ENQUEUE);
1086 ldlm_svc_get_eopc(body, exp->exp_obd->obd_svc_stats);
1089 /* It is important to obtain modify RPC slot first (if applicable), so
1090 * that threads that are waiting for a modify RPC slot are not polluting
1091 * our rpcs in flight counter. */
1093 if (einfo->ei_enq_slot)
1094 ptlrpc_get_mod_rpc_slot(req);
1096 if (ldlm_request_slot_needed(einfo)) {
1097 rc = obd_get_request_slot(&req->rq_import->imp_obd->u.cli);
1099 if (einfo->ei_enq_slot)
1100 ptlrpc_put_mod_rpc_slot(req);
1101 failed_lock_cleanup(ns, lock, einfo->ei_mode);
1102 LDLM_LOCK_RELEASE(lock);
1108 LASSERT(reqp != NULL);
1112 LDLM_DEBUG(lock, "sending request");
1114 rc = ptlrpc_queue_wait(req);
1116 err = ldlm_cli_enqueue_fini(exp, req, einfo, policy ? 1 : 0, flags,
1117 lvb, lvb_len, lockh, rc);
1120 * If ldlm_cli_enqueue_fini did not find the lock, we need to free
1121 * one reference that we took
1124 LDLM_LOCK_RELEASE(lock);
1129 if (!req_passed_in && req != NULL) {
1130 ptlrpc_req_finished(req);
1137 EXPORT_SYMBOL(ldlm_cli_enqueue);
1140 * Client-side IBITS lock convert.
1142 * Inform server that lock has been converted instead of canceling.
1143 * Server finishes convert on own side and does reprocess to grant
1144 * all related waiting locks.
1146 * Since convert means only ibits downgrading, client doesn't need to
1147 * wait for server reply to finish local converting process so this request
1148 * is made asynchronous.
1151 int ldlm_cli_convert_req(struct ldlm_lock *lock, __u32 *flags, __u64 new_bits)
1153 struct ldlm_request *body;
1154 struct ptlrpc_request *req;
1155 struct obd_export *exp = lock->l_conn_export;
1159 LASSERT(exp != NULL);
1162 * this is better to check earlier and it is done so already,
1163 * but this check is kept too as final one to issue an error
1164 * if any new code will miss such check.
1166 if (!exp_connect_lock_convert(exp)) {
1167 LDLM_ERROR(lock, "server doesn't support lock convert\n");
1171 if (lock->l_resource->lr_type != LDLM_IBITS) {
1172 LDLM_ERROR(lock, "convert works with IBITS locks only.");
1176 LDLM_DEBUG(lock, "client-side convert");
1178 req = ptlrpc_request_alloc_pack(class_exp2cliimp(exp),
1179 &RQF_LDLM_CONVERT, LUSTRE_DLM_VERSION,
1184 body = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
1185 body->lock_handle[0] = lock->l_remote_handle;
1187 body->lock_desc.l_req_mode = lock->l_req_mode;
1188 body->lock_desc.l_granted_mode = lock->l_granted_mode;
1190 body->lock_desc.l_policy_data.l_inodebits.bits = new_bits;
1191 body->lock_desc.l_policy_data.l_inodebits.cancel_bits = 0;
1193 body->lock_flags = ldlm_flags_to_wire(*flags);
1194 body->lock_count = 1;
1196 ptlrpc_request_set_replen(req);
1199 * Use cancel portals for convert as well as high-priority handling.
1201 req->rq_request_portal = LDLM_CANCEL_REQUEST_PORTAL;
1202 req->rq_reply_portal = LDLM_CANCEL_REPLY_PORTAL;
1204 ptlrpc_at_set_req_timeout(req);
1206 if (exp->exp_obd->obd_svc_stats != NULL)
1207 lprocfs_counter_incr(exp->exp_obd->obd_svc_stats,
1208 LDLM_CONVERT - LDLM_FIRST_OPC);
1210 ptlrpcd_add_req(req);
1215 * Cancel locks locally.
1217 * \retval LDLM_FL_LOCAL_ONLY if there is no need for a CANCEL RPC to the server
1218 * \retval LDLM_FL_CANCELING otherwise;
1219 * \retval LDLM_FL_BL_AST if there is a need for a separate CANCEL RPC.
1221 static __u64 ldlm_cli_cancel_local(struct ldlm_lock *lock)
1223 __u64 rc = LDLM_FL_LOCAL_ONLY;
1227 if (lock->l_conn_export) {
1230 LDLM_DEBUG(lock, "client-side cancel");
1231 OBD_FAIL_TIMEOUT(OBD_FAIL_LDLM_PAUSE_CANCEL_LOCAL,
1234 /* Set this flag to prevent others from getting new references*/
1235 lock_res_and_lock(lock);
1236 ldlm_set_cbpending(lock);
1237 local_only = !!(lock->l_flags &
1238 (LDLM_FL_LOCAL_ONLY|LDLM_FL_CANCEL_ON_BLOCK));
1239 ldlm_cancel_callback(lock);
1240 rc = (ldlm_is_bl_ast(lock)) ?
1241 LDLM_FL_BL_AST : LDLM_FL_CANCELING;
1242 unlock_res_and_lock(lock);
1246 "not sending request (at caller's instruction)\n");
1247 rc = LDLM_FL_LOCAL_ONLY;
1249 ldlm_lock_cancel(lock);
1251 if (ns_is_client(ldlm_lock_to_ns(lock))) {
1252 LDLM_ERROR(lock, "Trying to cancel local lock");
1255 LDLM_DEBUG(lock, "server-side local cancel");
1256 ldlm_lock_cancel(lock);
1257 ldlm_reprocess_all(lock->l_resource, lock);
1264 * Pack \a count locks in \a head into ldlm_request buffer of request \a req.
1266 static void ldlm_cancel_pack(struct ptlrpc_request *req,
1267 struct list_head *head, int count)
1269 struct ldlm_request *dlm;
1270 struct ldlm_lock *lock;
1271 int max, packed = 0;
1275 dlm = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
1276 LASSERT(dlm != NULL);
1278 /* Check the room in the request buffer. */
1279 max = req_capsule_get_size(&req->rq_pill, &RMF_DLM_REQ, RCL_CLIENT) -
1280 sizeof(struct ldlm_request);
1281 max /= sizeof(struct lustre_handle);
1282 max += LDLM_LOCKREQ_HANDLES;
1283 LASSERT(max >= dlm->lock_count + count);
1286 * XXX: it would be better to pack lock handles grouped by resource.
1287 * so that the server cancel would call filter_lvbo_update() less
1290 list_for_each_entry(lock, head, l_bl_ast) {
1293 LASSERT(lock->l_conn_export);
1294 /* Pack the lock handle to the given request buffer. */
1295 LDLM_DEBUG(lock, "packing");
1296 dlm->lock_handle[dlm->lock_count++] = lock->l_remote_handle;
1299 CDEBUG(D_DLMTRACE, "%d locks packed\n", packed);
1304 * Prepare and send a batched cancel RPC. It will include \a count lock
1305 * handles of locks given in \a cancels list.
1307 int ldlm_cli_cancel_req(struct obd_export *exp, struct list_head *cancels,
1308 int count, enum ldlm_cancel_flags flags)
1310 struct ptlrpc_request *req = NULL;
1311 struct obd_import *imp;
1317 LASSERT(exp != NULL);
1320 CFS_FAIL_TIMEOUT(OBD_FAIL_LDLM_PAUSE_CANCEL, cfs_fail_val);
1322 if (CFS_FAIL_CHECK(OBD_FAIL_LDLM_CANCEL_RACE))
1325 free = ldlm_format_handles_avail(class_exp2cliimp(exp),
1326 &RQF_LDLM_CANCEL, RCL_CLIENT, 0);
1331 imp = class_exp2cliimp(exp);
1332 if (imp == NULL || imp->imp_invalid) {
1334 "skipping cancel on invalid import %p\n", imp);
1338 req = ptlrpc_request_alloc(imp, &RQF_LDLM_CANCEL);
1340 GOTO(out, rc = -ENOMEM);
1342 req_capsule_filled_sizes(&req->rq_pill, RCL_CLIENT);
1343 req_capsule_set_size(&req->rq_pill, &RMF_DLM_REQ, RCL_CLIENT,
1344 ldlm_request_bufsize(count, LDLM_CANCEL));
1346 rc = ptlrpc_request_pack(req, LUSTRE_DLM_VERSION, LDLM_CANCEL);
1348 ptlrpc_request_free(req);
1353 * If OSP want cancel cross-MDT lock, let's not block it in
1354 * in recovery, otherwise the lock will not released, if
1355 * the remote target is also in recovery, and it also need
1356 * this lock, it might cause deadlock.
1358 if (exp_connect_flags(exp) & OBD_CONNECT_MDS_MDS &&
1359 exp->exp_obd->obd_lu_dev != NULL &&
1360 exp->exp_obd->obd_lu_dev->ld_site != NULL) {
1361 struct lu_device *top_dev;
1363 top_dev = exp->exp_obd->obd_lu_dev->ld_site->ls_top_dev;
1364 if (top_dev != NULL &&
1365 top_dev->ld_obd->obd_recovering)
1366 req->rq_allow_replay = 1;
1369 req->rq_request_portal = LDLM_CANCEL_REQUEST_PORTAL;
1370 req->rq_reply_portal = LDLM_CANCEL_REPLY_PORTAL;
1371 ptlrpc_at_set_req_timeout(req);
1373 ldlm_cancel_pack(req, cancels, count);
1375 ptlrpc_request_set_replen(req);
1376 if (flags & LCF_ASYNC) {
1377 ptlrpcd_add_req(req);
1382 rc = ptlrpc_queue_wait(req);
1383 if (rc == LUSTRE_ESTALE) {
1385 "client/server (nid %s) out of sync -- not fatal\n",
1386 libcfs_nid2str(req->rq_import->imp_connection->c_peer.nid));
1388 } else if (rc == -ETIMEDOUT && /* check there was no reconnect*/
1389 req->rq_import_generation == imp->imp_generation) {
1390 ptlrpc_req_finished(req);
1392 } else if (rc != ELDLM_OK) {
1393 /* -ESHUTDOWN is common on umount */
1394 CDEBUG_LIMIT(rc == -ESHUTDOWN ? D_DLMTRACE : D_ERROR,
1395 "Got rc %d from cancel RPC: canceling anyway\n",
1403 ptlrpc_req_finished(req);
1406 return sent ? sent : rc;
1409 static inline struct ldlm_pool *ldlm_imp2pl(struct obd_import *imp)
1411 LASSERT(imp != NULL);
1412 return &imp->imp_obd->obd_namespace->ns_pool;
1416 * Update client's OBD pool related fields with new SLV and Limit from \a req.
1418 int ldlm_cli_update_pool(struct ptlrpc_request *req)
1420 struct ldlm_namespace *ns;
1421 struct obd_device *obd;
1422 __u64 new_slv, ratio;
1426 if (unlikely(!req->rq_import || !req->rq_import->imp_obd ||
1427 !imp_connect_lru_resize(req->rq_import)))
1428 /* Do nothing for corner cases. */
1432 * In some cases RPC may contain SLV and limit zeroed out. This
1433 * is the case when server does not support LRU resize feature.
1434 * This is also possible in some recovery cases when server-side
1435 * reqs have no reference to the OBD export and thus access to
1436 * server-side namespace is not possible.
1438 if (lustre_msg_get_slv(req->rq_repmsg) == 0 ||
1439 lustre_msg_get_limit(req->rq_repmsg) == 0) {
1440 DEBUG_REQ(D_HA, req,
1441 "Zero SLV or limit found (SLV=%llu, limit=%u)",
1442 lustre_msg_get_slv(req->rq_repmsg),
1443 lustre_msg_get_limit(req->rq_repmsg));
1447 new_limit = lustre_msg_get_limit(req->rq_repmsg);
1448 new_slv = lustre_msg_get_slv(req->rq_repmsg);
1449 obd = req->rq_import->imp_obd;
1451 read_lock(&obd->obd_pool_lock);
1452 if (obd->obd_pool_slv == new_slv &&
1453 obd->obd_pool_limit == new_limit) {
1454 read_unlock(&obd->obd_pool_lock);
1457 read_unlock(&obd->obd_pool_lock);
1460 * OBD device keeps the new pool attributes before they are handled by
1463 write_lock(&obd->obd_pool_lock);
1464 obd->obd_pool_slv = new_slv;
1465 obd->obd_pool_limit = new_limit;
1466 write_unlock(&obd->obd_pool_lock);
1469 * Check if an urgent pool recalc is needed, let it to be a change of
1470 * SLV on 10%. It is applicable to LRU resize enabled case only.
1472 ns = obd->obd_namespace;
1473 if (!ns_connect_lru_resize(ns) ||
1474 ldlm_pool_get_slv(&ns->ns_pool) < new_slv)
1477 ratio = 100 * new_slv / ldlm_pool_get_slv(&ns->ns_pool);
1478 if (100 - ratio >= ns->ns_recalc_pct &&
1479 !ns->ns_stopping && !ns->ns_rpc_recalc) {
1480 bool recalc = false;
1482 spin_lock(&ns->ns_lock);
1483 if (!ns->ns_stopping && !ns->ns_rpc_recalc) {
1484 ldlm_namespace_get(ns);
1486 ns->ns_rpc_recalc = 1;
1488 spin_unlock(&ns->ns_lock);
1490 ldlm_bl_to_thread_ns(ns);
1496 int ldlm_cli_convert(struct ldlm_lock *lock,
1497 enum ldlm_cancel_flags cancel_flags)
1501 LASSERT(!lock->l_readers && !lock->l_writers);
1502 LDLM_DEBUG(lock, "client lock convert START");
1504 if (lock->l_resource->lr_type == LDLM_IBITS) {
1505 lock_res_and_lock(lock);
1507 rc = ldlm_cli_inodebits_convert(lock, cancel_flags);
1508 } while (rc == -EAGAIN);
1509 unlock_res_and_lock(lock);
1512 LDLM_DEBUG(lock, "client lock convert END");
1515 EXPORT_SYMBOL(ldlm_cli_convert);
1518 * Client side lock cancel.
1520 * Lock must not have any readers or writers by this time.
1522 int ldlm_cli_cancel(const struct lustre_handle *lockh,
1523 enum ldlm_cancel_flags cancel_flags)
1525 struct obd_export *exp;
1526 int avail, count = 1;
1528 struct ldlm_namespace *ns;
1529 struct ldlm_lock *lock;
1534 lock = ldlm_handle2lock_long(lockh, 0);
1536 LDLM_DEBUG_NOLOCK("lock is already being destroyed");
1540 lock_res_and_lock(lock);
1541 LASSERT(!ldlm_is_converting(lock));
1543 /* Lock is being canceled and the caller doesn't want to wait */
1544 if (ldlm_is_canceling(lock)) {
1545 if (cancel_flags & LCF_ASYNC) {
1546 unlock_res_and_lock(lock);
1548 unlock_res_and_lock(lock);
1549 wait_event_idle(lock->l_waitq, is_bl_done(lock));
1551 LDLM_LOCK_RELEASE(lock);
1555 ldlm_set_canceling(lock);
1556 unlock_res_and_lock(lock);
1558 if (cancel_flags & LCF_LOCAL)
1559 OBD_FAIL_TIMEOUT(OBD_FAIL_LDLM_LOCAL_CANCEL_PAUSE,
1562 rc = ldlm_cli_cancel_local(lock);
1563 if (rc == LDLM_FL_LOCAL_ONLY || cancel_flags & LCF_LOCAL) {
1564 LDLM_LOCK_RELEASE(lock);
1568 * Even if the lock is marked as LDLM_FL_BL_AST, this is a LDLM_CANCEL
1569 * RPC which goes to canceld portal, so we can cancel other LRU locks
1570 * here and send them all as one LDLM_CANCEL RPC.
1572 LASSERT(list_empty(&lock->l_bl_ast));
1573 list_add(&lock->l_bl_ast, &cancels);
1575 exp = lock->l_conn_export;
1576 if (exp_connect_cancelset(exp)) {
1577 avail = ldlm_format_handles_avail(class_exp2cliimp(exp),
1582 ns = ldlm_lock_to_ns(lock);
1583 count += ldlm_cancel_lru_local(ns, &cancels, 0, avail - 1,
1586 ldlm_cli_cancel_list(&cancels, count, NULL, cancel_flags);
1589 EXPORT_SYMBOL(ldlm_cli_cancel);
1592 * Locally cancel up to \a count locks in list \a cancels.
1593 * Return the number of cancelled locks.
1595 int ldlm_cli_cancel_list_local(struct list_head *cancels, int count,
1596 enum ldlm_cancel_flags cancel_flags)
1599 struct ldlm_lock *lock, *next;
1600 int left = 0, bl_ast = 0;
1604 list_for_each_entry_safe(lock, next, cancels, l_bl_ast) {
1608 if (cancel_flags & LCF_LOCAL) {
1609 rc = LDLM_FL_LOCAL_ONLY;
1610 ldlm_lock_cancel(lock);
1612 rc = ldlm_cli_cancel_local(lock);
1615 * Until we have compound requests and can send LDLM_CANCEL
1616 * requests batched with generic RPCs, we need to send cancels
1617 * with the LDLM_FL_BL_AST flag in a separate RPC from
1618 * the one being generated now.
1620 if (!(cancel_flags & LCF_BL_AST) && (rc == LDLM_FL_BL_AST)) {
1621 LDLM_DEBUG(lock, "Cancel lock separately");
1622 list_move(&lock->l_bl_ast, &head);
1626 if (rc == LDLM_FL_LOCAL_ONLY) {
1627 /* CANCEL RPC should not be sent to server. */
1628 list_del_init(&lock->l_bl_ast);
1629 LDLM_LOCK_RELEASE(lock);
1635 ldlm_cli_cancel_list(&head, bl_ast, NULL, 0);
1642 * Cancel as many locks as possible w/o sending any RPCs (e.g. to write back
1643 * dirty data, to close a file, ...) or waiting for any RPCs in-flight (e.g.
1644 * readahead requests, ...)
1646 static enum ldlm_policy_res
1647 ldlm_cancel_no_wait_policy(struct ldlm_namespace *ns, struct ldlm_lock *lock,
1650 enum ldlm_policy_res result = LDLM_POLICY_CANCEL_LOCK;
1653 * don't check @added & @min since we want to process all locks
1655 * It's fine to not take lock to access lock->l_resource since
1656 * the lock has already been granted so it won't change.
1658 switch (lock->l_resource->lr_type) {
1661 if (ns->ns_cancel != NULL && ns->ns_cancel(lock) != 0)
1665 result = LDLM_POLICY_SKIP_LOCK;
1673 * Callback function for LRU-resize policy. Decides whether to keep
1674 * \a lock in LRU for \a added in current scan and \a min number of locks
1675 * to be preferably canceled.
1677 * \retval LDLM_POLICY_KEEP_LOCK keep lock in LRU in stop scanning
1679 * \retval LDLM_POLICY_CANCEL_LOCK cancel lock from LRU
1681 static enum ldlm_policy_res ldlm_cancel_lrur_policy(struct ldlm_namespace *ns,
1682 struct ldlm_lock *lock,
1685 ktime_t cur = ktime_get();
1686 struct ldlm_pool *pl = &ns->ns_pool;
1691 return LDLM_POLICY_CANCEL_LOCK;
1694 * Despite of the LV, It doesn't make sense to keep the lock which
1695 * is unused for ns_max_age time.
1697 if (ktime_after(cur, ktime_add(lock->l_last_used, ns->ns_max_age)))
1698 return LDLM_POLICY_CANCEL_LOCK;
1700 slv = ldlm_pool_get_slv(pl);
1701 lvf = ldlm_pool_get_lvf(pl);
1702 la = div_u64(ktime_to_ns(ktime_sub(cur, lock->l_last_used)),
1704 lv = lvf * la * ns->ns_nr_unused >> 8;
1706 /* Inform pool about current CLV to see it via debugfs. */
1707 ldlm_pool_set_clv(pl, lv);
1710 * Stop when SLV is not yet come from server or lv is smaller than
1713 if (slv == 0 || lv < slv)
1714 return LDLM_POLICY_KEEP_LOCK;
1716 return LDLM_POLICY_CANCEL_LOCK;
1719 static enum ldlm_policy_res
1720 ldlm_cancel_lrur_no_wait_policy(struct ldlm_namespace *ns,
1721 struct ldlm_lock *lock,
1724 enum ldlm_policy_res result;
1726 result = ldlm_cancel_lrur_policy(ns, lock, added, min);
1727 if (result == LDLM_POLICY_KEEP_LOCK)
1730 return ldlm_cancel_no_wait_policy(ns, lock, added, min);
1734 * Callback function for aged policy. Decides whether to keep
1735 * \a lock in LRU for \a added in current scan and \a min number of locks
1736 * to be preferably canceled.
1738 * \retval LDLM_POLICY_KEEP_LOCK keep lock in LRU in stop scanning
1740 * \retval LDLM_POLICY_CANCEL_LOCK cancel lock from LRU
1742 static enum ldlm_policy_res ldlm_cancel_aged_policy(struct ldlm_namespace *ns,
1743 struct ldlm_lock *lock,
1746 if ((added >= min) &&
1747 ktime_before(ktime_get(),
1748 ktime_add(lock->l_last_used, ns->ns_max_age)))
1749 return LDLM_POLICY_KEEP_LOCK;
1751 return LDLM_POLICY_CANCEL_LOCK;
1754 static enum ldlm_policy_res
1755 ldlm_cancel_aged_no_wait_policy(struct ldlm_namespace *ns,
1756 struct ldlm_lock *lock,
1759 enum ldlm_policy_res result;
1761 result = ldlm_cancel_aged_policy(ns, lock, added, min);
1762 if (result == LDLM_POLICY_KEEP_LOCK)
1765 return ldlm_cancel_no_wait_policy(ns, lock, added, min);
1768 typedef enum ldlm_policy_res
1769 (*ldlm_cancel_lru_policy_t)(struct ldlm_namespace *ns, struct ldlm_lock *lock,
1770 int added, int min);
1772 static ldlm_cancel_lru_policy_t
1773 ldlm_cancel_lru_policy(struct ldlm_namespace *ns, enum ldlm_lru_flags lru_flags)
1775 if (ns_connect_lru_resize(ns)) {
1776 if (lru_flags & LDLM_LRU_FLAG_NO_WAIT)
1777 return ldlm_cancel_lrur_no_wait_policy;
1779 return ldlm_cancel_lrur_policy;
1781 if (lru_flags & LDLM_LRU_FLAG_NO_WAIT)
1782 return ldlm_cancel_aged_no_wait_policy;
1784 return ldlm_cancel_aged_policy;
1789 * - Free space in LRU for \a min new locks,
1790 * redundant unused locks are canceled locally;
1791 * - also cancel locally unused aged locks;
1792 * - do not cancel more than \a max locks;
1793 * - if some locks are cancelled, try to cancel at least \a batch locks
1794 * - GET the found locks and add them into the \a cancels list.
1796 * A client lock can be added to the l_bl_ast list only when it is
1797 * marked LDLM_FL_CANCELING. Otherwise, somebody is already doing
1798 * CANCEL. There are the following use cases:
1799 * ldlm_cancel_resource_local(), ldlm_cancel_lru_local() and
1800 * ldlm_cli_cancel(), which check and set this flag properly. As any
1801 * attempt to cancel a lock rely on this flag, l_bl_ast list is accessed
1802 * later without any special locking.
1804 * Locks are cancelled according to the LRU resize policy (SLV from server)
1805 * if LRU resize is enabled; otherwise, the "aged policy" is used;
1808 * ----------------------------------------
1810 * flags & LDLM_LRU_FLAG_NO_WAIT - cancel locks w/o sending any RPCs or waiting
1811 * for any outstanding RPC to complete.
1813 * flags & LDLM_CANCEL_CLEANUP - when cancelling read locks, do not check for
1814 * other read locks covering the same pages, just
1815 * discard those pages.
1817 static int ldlm_prepare_lru_list(struct ldlm_namespace *ns,
1818 struct list_head *cancels,
1819 int min, int max, int batch,
1820 enum ldlm_lru_flags lru_flags)
1822 ldlm_cancel_lru_policy_t pf;
1824 int no_wait = lru_flags & LDLM_LRU_FLAG_NO_WAIT;
1828 * Let only 1 thread to proceed. However, not for those which have the
1829 * @max limit given (ELC), as LRU may be left not cleaned up in full.
1832 if (test_and_set_bit(LDLM_LRU_CANCEL, &ns->ns_flags))
1834 } else if (test_bit(LDLM_LRU_CANCEL, &ns->ns_flags))
1837 LASSERT(ergo(max, min <= max));
1838 /* No sense to give @batch for ELC */
1839 LASSERT(ergo(max, batch == 0));
1841 if (!ns_connect_lru_resize(ns))
1842 min = max_t(int, min, ns->ns_nr_unused - ns->ns_max_unused);
1844 /* If at least 1 lock is to be cancelled, cancel at least @batch locks */
1845 if (min && min < batch)
1848 pf = ldlm_cancel_lru_policy(ns, lru_flags);
1849 LASSERT(pf != NULL);
1851 /* For any flags, stop scanning if @max is reached. */
1852 while (!list_empty(&ns->ns_unused_list) && (max == 0 || added < max)) {
1853 struct ldlm_lock *lock;
1854 struct list_head *item, *next;
1855 enum ldlm_policy_res result;
1856 ktime_t last_use = ktime_set(0, 0);
1858 spin_lock(&ns->ns_lock);
1859 item = no_wait ? ns->ns_last_pos : &ns->ns_unused_list;
1860 for (item = item->next, next = item->next;
1861 item != &ns->ns_unused_list;
1862 item = next, next = item->next) {
1863 lock = list_entry(item, struct ldlm_lock, l_lru);
1865 /* No locks which got blocking requests. */
1866 LASSERT(!ldlm_is_bl_ast(lock));
1868 if (!ldlm_is_canceling(lock))
1872 * Somebody is already doing CANCEL. No need for this
1873 * lock in LRU, do not traverse it again.
1875 ldlm_lock_remove_from_lru_nolock(lock);
1877 if (item == &ns->ns_unused_list) {
1878 spin_unlock(&ns->ns_lock);
1882 last_use = lock->l_last_used;
1884 LDLM_LOCK_GET(lock);
1885 spin_unlock(&ns->ns_lock);
1886 lu_ref_add(&lock->l_reference, __FUNCTION__, current);
1889 * Pass the lock through the policy filter and see if it
1890 * should stay in LRU.
1892 * Even for shrinker policy we stop scanning if
1893 * we find a lock that should stay in the cache.
1894 * We should take into account lock age anyway
1895 * as a new lock is a valuable resource even if
1896 * it has a low weight.
1898 * That is, for shrinker policy we drop only
1899 * old locks, but additionally choose them by
1900 * their weight. Big extent locks will stay in
1903 result = pf(ns, lock, added, min);
1904 if (result == LDLM_POLICY_KEEP_LOCK) {
1905 lu_ref_del(&lock->l_reference, __func__, current);
1906 LDLM_LOCK_RELEASE(lock);
1910 if (result == LDLM_POLICY_SKIP_LOCK) {
1911 lu_ref_del(&lock->l_reference, __func__, current);
1913 spin_lock(&ns->ns_lock);
1914 if (!list_empty(&lock->l_lru) &&
1915 lock->l_lru.prev == ns->ns_last_pos)
1916 ns->ns_last_pos = &lock->l_lru;
1917 spin_unlock(&ns->ns_lock);
1920 LDLM_LOCK_RELEASE(lock);
1924 lock_res_and_lock(lock);
1925 /* Check flags again under the lock. */
1926 if (ldlm_is_canceling(lock) ||
1927 ldlm_lock_remove_from_lru_check(lock, last_use) == 0) {
1929 * Another thread is removing lock from LRU, or
1930 * somebody is already doing CANCEL, or there
1931 * is a blocking request which will send cancel
1932 * by itself, or the lock is no longer unused or
1933 * the lock has been used since the pf() call and
1934 * pages could be put under it.
1936 unlock_res_and_lock(lock);
1937 lu_ref_del(&lock->l_reference, __FUNCTION__, current);
1938 LDLM_LOCK_RELEASE(lock);
1941 LASSERT(!lock->l_readers && !lock->l_writers);
1944 * If we have chosen to cancel this lock voluntarily, we
1945 * better send cancel notification to server, so that it
1946 * frees appropriate state. This might lead to a race
1947 * where while we are doing cancel here, server is also
1948 * silently cancelling this lock.
1950 ldlm_clear_cancel_on_block(lock);
1953 * Setting the CBPENDING flag is a little misleading,
1954 * but prevents an important race; namely, once
1955 * CBPENDING is set, the lock can accumulate no more
1956 * readers/writers. Since readers and writers are
1957 * already zero here, ldlm_lock_decref() won't see
1958 * this flag and call l_blocking_ast
1960 lock->l_flags |= LDLM_FL_CBPENDING | LDLM_FL_CANCELING;
1962 if ((lru_flags & LDLM_LRU_FLAG_CLEANUP) &&
1963 (lock->l_resource->lr_type == LDLM_EXTENT ||
1964 ldlm_has_dom(lock)) && lock->l_granted_mode == LCK_PR)
1965 ldlm_set_discard_data(lock);
1968 * We can't re-add to l_lru as it confuses the
1969 * refcounting in ldlm_lock_remove_from_lru() if an AST
1970 * arrives after we drop lr_lock below. We use l_bl_ast
1971 * and can't use l_pending_chain as it is used both on
1972 * server and client nevertheless b=5666 says it is
1973 * used only on server
1975 LASSERT(list_empty(&lock->l_bl_ast));
1976 list_add(&lock->l_bl_ast, cancels);
1977 unlock_res_and_lock(lock);
1978 lu_ref_del(&lock->l_reference, __FUNCTION__, current);
1980 /* Once a lock added, batch the requested amount */
1986 clear_bit(LDLM_LRU_CANCEL, &ns->ns_flags);
1991 int ldlm_cancel_lru_local(struct ldlm_namespace *ns, struct list_head *cancels,
1993 enum ldlm_cancel_flags cancel_flags,
1994 enum ldlm_lru_flags lru_flags)
1998 added = ldlm_prepare_lru_list(ns, cancels, min, max, 0, lru_flags);
2002 return ldlm_cli_cancel_list_local(cancels, added, cancel_flags);
2006 * Cancel at least \a min locks from given namespace LRU.
2008 * When called with LCF_ASYNC the blocking callback will be handled
2009 * in a thread and this function will return after the thread has been
2010 * asked to call the callback. When called with LCF_ASYNC the blocking
2011 * callback will be performed in this function.
2013 int ldlm_cancel_lru(struct ldlm_namespace *ns, int min,
2014 enum ldlm_cancel_flags cancel_flags,
2015 enum ldlm_lru_flags lru_flags)
2023 * Just prepare the list of locks, do not actually cancel them yet.
2024 * Locks are cancelled later in a separate thread.
2026 count = ldlm_prepare_lru_list(ns, &cancels, min, 0,
2027 ns->ns_cancel_batch, lru_flags);
2028 rc = ldlm_bl_to_thread_list(ns, NULL, &cancels, count, cancel_flags);
2036 * Find and cancel locally unused locks found on resource, matched to the
2037 * given policy, mode. GET the found locks and add them into the \a cancels
2040 int ldlm_cancel_resource_local(struct ldlm_resource *res,
2041 struct list_head *cancels,
2042 union ldlm_policy_data *policy,
2043 enum ldlm_mode mode, __u64 lock_flags,
2044 enum ldlm_cancel_flags cancel_flags,
2047 struct ldlm_lock *lock;
2053 list_for_each_entry(lock, &res->lr_granted, l_res_link) {
2054 if (opaque != NULL && lock->l_ast_data != opaque) {
2055 LDLM_ERROR(lock, "data %p doesn't match opaque %p",
2056 lock->l_ast_data, opaque);
2060 if (lock->l_readers || lock->l_writers)
2064 * If somebody is already doing CANCEL, or blocking AST came
2065 * then skip this lock.
2067 if (ldlm_is_bl_ast(lock) || ldlm_is_canceling(lock))
2070 if (lockmode_compat(lock->l_granted_mode, mode))
2074 * If policy is given and this is IBITS lock, add to list only
2075 * those locks that match by policy.
2077 if (policy && (lock->l_resource->lr_type == LDLM_IBITS)) {
2078 if (!(lock->l_policy_data.l_inodebits.bits &
2079 policy->l_inodebits.bits))
2081 /* Skip locks with DoM bit if it is not set in policy
2082 * to don't flush data by side-bits. Lock convert will
2083 * drop those bits separately.
2085 if (ldlm_has_dom(lock) &&
2086 !(policy->l_inodebits.bits & MDS_INODELOCK_DOM))
2090 /* See CBPENDING comment in ldlm_cancel_lru */
2091 lock->l_flags |= LDLM_FL_CBPENDING | LDLM_FL_CANCELING |
2093 LASSERT(list_empty(&lock->l_bl_ast));
2094 list_add(&lock->l_bl_ast, cancels);
2095 LDLM_LOCK_GET(lock);
2100 RETURN(ldlm_cli_cancel_list_local(cancels, count, cancel_flags));
2102 EXPORT_SYMBOL(ldlm_cancel_resource_local);
2105 * Cancel client-side locks from a list and send/prepare cancel RPCs to the
2107 * If \a req is NULL, send CANCEL request to server with handles of locks
2108 * in the \a cancels. If EARLY_CANCEL is not supported, send CANCEL requests
2109 * separately per lock.
2110 * If \a req is not NULL, put handles of locks in \a cancels into the request
2111 * buffer at the offset \a off.
2112 * Destroy \a cancels at the end.
2114 int ldlm_cli_cancel_list(struct list_head *cancels, int count,
2115 struct ptlrpc_request *req,
2116 enum ldlm_cancel_flags flags)
2118 struct ldlm_lock *lock;
2123 if (list_empty(cancels) || count == 0)
2127 * XXX: requests (both batched and not) could be sent in parallel.
2128 * Usually it is enough to have just 1 RPC, but it is possible that
2129 * there are too many locks to be cancelled in LRU or on a resource.
2130 * It would also speed up the case when the server does not support
2134 LASSERT(!list_empty(cancels));
2135 lock = list_entry(cancels->next, struct ldlm_lock,
2137 LASSERT(lock->l_conn_export);
2139 if (exp_connect_cancelset(lock->l_conn_export)) {
2142 ldlm_cancel_pack(req, cancels, count);
2144 res = ldlm_cli_cancel_req(lock->l_conn_export,
2148 res = ldlm_cli_cancel_req(lock->l_conn_export,
2153 CDEBUG_LIMIT(res == -ESHUTDOWN ? D_DLMTRACE : D_ERROR,
2154 "ldlm_cli_cancel_list: %d\n", res);
2159 ldlm_lock_list_put(cancels, l_bl_ast, res);
2161 LASSERT(count == 0);
2164 EXPORT_SYMBOL(ldlm_cli_cancel_list);
2167 * Cancel all locks on a resource that have 0 readers/writers.
2169 * If flags & LDLM_FL_LOCAL_ONLY, throw the locks away without trying
2170 * to notify the server.
2172 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
2173 const struct ldlm_res_id *res_id,
2174 union ldlm_policy_data *policy,
2175 enum ldlm_mode mode,
2176 enum ldlm_cancel_flags flags, void *opaque)
2178 struct ldlm_resource *res;
2185 res = ldlm_resource_get(ns, NULL, res_id, 0, 0);
2187 /* This is not a problem. */
2188 CDEBUG(D_INFO, "No resource %llu\n", res_id->name[0]);
2192 LDLM_RESOURCE_ADDREF(res);
2193 count = ldlm_cancel_resource_local(res, &cancels, policy, mode,
2194 0, flags | LCF_BL_AST, opaque);
2195 rc = ldlm_cli_cancel_list(&cancels, count, NULL, flags);
2197 CERROR("canceling unused lock "DLDLMRES": rc = %d\n",
2200 LDLM_RESOURCE_DELREF(res);
2201 ldlm_resource_putref(res);
2204 EXPORT_SYMBOL(ldlm_cli_cancel_unused_resource);
2206 struct ldlm_cli_cancel_arg {
2212 ldlm_cli_hash_cancel_unused(struct cfs_hash *hs, struct cfs_hash_bd *bd,
2213 struct hlist_node *hnode, void *arg)
2215 struct ldlm_resource *res = cfs_hash_object(hs, hnode);
2216 struct ldlm_cli_cancel_arg *lc = arg;
2218 ldlm_cli_cancel_unused_resource(ldlm_res_to_ns(res), &res->lr_name,
2219 NULL, LCK_MINMODE, lc->lc_flags,
2221 /* must return 0 for hash iteration */
2226 * Cancel all locks on a namespace (or a specific resource, if given)
2227 * that have 0 readers/writers.
2229 * If flags & LCF_LOCAL, throw the locks away without trying
2230 * to notify the server.
2232 int ldlm_cli_cancel_unused(struct ldlm_namespace *ns,
2233 const struct ldlm_res_id *res_id,
2234 enum ldlm_cancel_flags flags, void *opaque)
2236 struct ldlm_cli_cancel_arg arg = {
2238 .lc_opaque = opaque,
2246 if (res_id != NULL) {
2247 RETURN(ldlm_cli_cancel_unused_resource(ns, res_id, NULL,
2251 cfs_hash_for_each_nolock(ns->ns_rs_hash,
2252 ldlm_cli_hash_cancel_unused, &arg, 0);
2257 /* Lock iterators. */
2259 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
2262 struct list_head *tmp, *next;
2263 struct ldlm_lock *lock;
2264 int rc = LDLM_ITER_CONTINUE;
2269 RETURN(LDLM_ITER_CONTINUE);
2272 list_for_each_safe(tmp, next, &res->lr_granted) {
2273 lock = list_entry(tmp, struct ldlm_lock, l_res_link);
2275 if (iter(lock, closure) == LDLM_ITER_STOP)
2276 GOTO(out, rc = LDLM_ITER_STOP);
2279 list_for_each_safe(tmp, next, &res->lr_waiting) {
2280 lock = list_entry(tmp, struct ldlm_lock, l_res_link);
2282 if (iter(lock, closure) == LDLM_ITER_STOP)
2283 GOTO(out, rc = LDLM_ITER_STOP);
2290 struct iter_helper_data {
2291 ldlm_iterator_t iter;
2295 static int ldlm_iter_helper(struct ldlm_lock *lock, void *closure)
2297 struct iter_helper_data *helper = closure;
2299 return helper->iter(lock, helper->closure);
2302 static int ldlm_res_iter_helper(struct cfs_hash *hs, struct cfs_hash_bd *bd,
2303 struct hlist_node *hnode, void *arg)
2306 struct ldlm_resource *res = cfs_hash_object(hs, hnode);
2308 return ldlm_resource_foreach(res, ldlm_iter_helper, arg) ==
2312 void ldlm_namespace_foreach(struct ldlm_namespace *ns,
2313 ldlm_iterator_t iter, void *closure)
2316 struct iter_helper_data helper = { .iter = iter, .closure = closure };
2318 cfs_hash_for_each_nolock(ns->ns_rs_hash,
2319 ldlm_res_iter_helper, &helper, 0);
2324 * non-blocking function to manipulate a lock whose cb_data is being put away.
2325 * return 0: find no resource
2326 * > 0: must be LDLM_ITER_STOP/LDLM_ITER_CONTINUE.
2329 int ldlm_resource_iterate(struct ldlm_namespace *ns,
2330 const struct ldlm_res_id *res_id,
2331 ldlm_iterator_t iter, void *data)
2333 struct ldlm_resource *res;
2338 LASSERTF(ns != NULL, "must pass in namespace\n");
2340 res = ldlm_resource_get(ns, NULL, res_id, 0, 0);
2344 LDLM_RESOURCE_ADDREF(res);
2345 rc = ldlm_resource_foreach(res, iter, data);
2346 LDLM_RESOURCE_DELREF(res);
2347 ldlm_resource_putref(res);
2350 EXPORT_SYMBOL(ldlm_resource_iterate);
2353 static int ldlm_chain_lock_for_replay(struct ldlm_lock *lock, void *closure)
2355 struct list_head *list = closure;
2357 /* we use l_pending_chain here, because it's unused on clients. */
2358 LASSERTF(list_empty(&lock->l_pending_chain),
2359 "lock %p next %p prev %p\n",
2360 lock, &lock->l_pending_chain.next,
2361 &lock->l_pending_chain.prev);
2363 * b=9573: don't replay locks left after eviction, or
2364 * b=17614: locks being actively cancelled. Get a reference
2365 * on a lock so that it does not disapear under us (e.g. due to cancel)
2367 if (!(lock->l_flags & (LDLM_FL_FAILED|LDLM_FL_BL_DONE))) {
2368 list_add(&lock->l_pending_chain, list);
2369 LDLM_LOCK_GET(lock);
2372 return LDLM_ITER_CONTINUE;
2375 static int replay_lock_interpret(const struct lu_env *env,
2376 struct ptlrpc_request *req, void *args, int rc)
2378 struct ldlm_async_args *aa = args;
2379 struct ldlm_lock *lock;
2380 struct ldlm_reply *reply;
2381 struct obd_export *exp;
2384 atomic_dec(&req->rq_import->imp_replay_inflight);
2385 wake_up(&req->rq_import->imp_replay_waitq);
2390 reply = req_capsule_server_get(&req->rq_pill, &RMF_DLM_REP);
2392 GOTO(out, rc = -EPROTO);
2394 lock = ldlm_handle2lock(&aa->lock_handle);
2396 CERROR("received replay ack for unknown local cookie %#llx remote cookie %#llx from server %s id %s\n",
2397 aa->lock_handle.cookie, reply->lock_handle.cookie,
2398 req->rq_export->exp_client_uuid.uuid,
2399 libcfs_id2str(req->rq_peer));
2400 GOTO(out, rc = -ESTALE);
2403 /* Key change rehash lock in per-export hash with new key */
2404 exp = req->rq_export;
2405 if (exp && exp->exp_lock_hash) {
2407 * In the function below, .hs_keycmp resolves to
2408 * ldlm_export_lock_keycmp()
2410 /* coverity[overrun-buffer-val] */
2411 cfs_hash_rehash_key(exp->exp_lock_hash,
2412 &lock->l_remote_handle,
2413 &reply->lock_handle,
2416 lock->l_remote_handle = reply->lock_handle;
2419 LDLM_DEBUG(lock, "replayed lock:");
2420 ptlrpc_import_recovery_state_machine(req->rq_import);
2421 LDLM_LOCK_PUT(lock);
2424 ptlrpc_connect_import(req->rq_import);
2429 static int replay_one_lock(struct obd_import *imp, struct ldlm_lock *lock)
2431 struct ptlrpc_request *req;
2432 struct ldlm_async_args *aa;
2433 struct ldlm_request *body;
2439 /* b=11974: Do not replay a lock which is actively being canceled */
2440 if (ldlm_is_bl_done(lock)) {
2441 LDLM_DEBUG(lock, "Not replaying canceled lock:");
2446 * If this is reply-less callback lock, we cannot replay it, since
2447 * server might have long dropped it, but notification of that event was
2448 * lost by network. (and server granted conflicting lock already)
2450 if (ldlm_is_cancel_on_block(lock)) {
2451 LDLM_DEBUG(lock, "Not replaying reply-less lock:");
2452 ldlm_lock_cancel(lock);
2457 * If granted mode matches the requested mode, this lock is granted.
2459 * If we haven't been granted anything and are on a resource list,
2460 * then we're blocked/waiting.
2462 * If we haven't been granted anything and we're NOT on a resource list,
2463 * then we haven't got a reply yet and don't have a known disposition.
2464 * This happens whenever a lock enqueue is the request that triggers
2467 if (ldlm_is_granted(lock))
2468 flags = LDLM_FL_REPLAY | LDLM_FL_BLOCK_GRANTED;
2469 else if (!list_empty(&lock->l_res_link))
2470 flags = LDLM_FL_REPLAY | LDLM_FL_BLOCK_WAIT;
2472 flags = LDLM_FL_REPLAY;
2474 req = ptlrpc_request_alloc_pack(imp, &RQF_LDLM_ENQUEUE,
2475 LUSTRE_DLM_VERSION, LDLM_ENQUEUE);
2479 /* We're part of recovery, so don't wait for it. */
2480 req->rq_send_state = LUSTRE_IMP_REPLAY_LOCKS;
2481 /* If the state changed while we were prepared, don't wait */
2482 req->rq_no_delay = 1;
2484 body = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
2485 ldlm_lock2desc(lock, &body->lock_desc);
2486 body->lock_flags = ldlm_flags_to_wire(flags);
2488 ldlm_lock2handle(lock, &body->lock_handle[0]);
2489 if (lock->l_lvb_len > 0)
2490 req_capsule_extend(&req->rq_pill, &RQF_LDLM_ENQUEUE_LVB);
2491 req_capsule_set_size(&req->rq_pill, &RMF_DLM_LVB, RCL_SERVER,
2493 ptlrpc_request_set_replen(req);
2495 * notify the server we've replayed all requests.
2496 * also, we mark the request to be put on a dedicated
2497 * queue to be processed after all request replayes.
2500 lustre_msg_set_flags(req->rq_reqmsg, MSG_REQ_REPLAY_DONE);
2502 LDLM_DEBUG(lock, "replaying lock:");
2504 atomic_inc(&imp->imp_replay_inflight);
2505 aa = ptlrpc_req_async_args(aa, req);
2506 aa->lock_handle = body->lock_handle[0];
2507 req->rq_interpret_reply = replay_lock_interpret;
2508 ptlrpcd_add_req(req);
2514 * Cancel as many unused locks as possible before replay. since we are
2515 * in recovery, we can't wait for any outstanding RPCs to send any RPC
2518 * Called only in recovery before replaying locks. there is no need to
2519 * replay locks that are unused. since the clients may hold thousands of
2520 * cached unused locks, dropping the unused locks can greatly reduce the
2521 * load on the servers at recovery time.
2523 static void ldlm_cancel_unused_locks_for_replay(struct ldlm_namespace *ns)
2529 "Dropping as many unused locks as possible before replay for namespace %s (%d)\n",
2530 ldlm_ns_name(ns), ns->ns_nr_unused);
2533 * We don't need to care whether or not LRU resize is enabled
2534 * because the LDLM_LRU_FLAG_NO_WAIT policy doesn't use the
2537 canceled = ldlm_cancel_lru_local(ns, &cancels, ns->ns_nr_unused, 0,
2538 LCF_LOCAL, LDLM_LRU_FLAG_NO_WAIT);
2540 CDEBUG(D_DLMTRACE, "Canceled %d unused locks from namespace %s\n",
2541 canceled, ldlm_ns_name(ns));
2544 static int lock_can_replay(struct obd_import *imp)
2546 struct client_obd *cli = &imp->imp_obd->u.cli;
2548 CDEBUG(D_HA, "check lock replay limit, inflights = %u(%u)\n",
2549 atomic_read(&imp->imp_replay_inflight) - 1,
2550 cli->cl_max_rpcs_in_flight);
2552 /* +1 due to ldlm_lock_replay() increment */
2553 return atomic_read(&imp->imp_replay_inflight) <
2554 1 + min_t(u32, cli->cl_max_rpcs_in_flight, 8);
2557 int __ldlm_replay_locks(struct obd_import *imp, bool rate_limit)
2559 struct ldlm_namespace *ns = imp->imp_obd->obd_namespace;
2561 struct ldlm_lock *lock, *next;
2566 LASSERT(atomic_read(&imp->imp_replay_inflight) == 1);
2568 /* don't replay locks if import failed recovery */
2569 if (imp->imp_vbr_failed)
2572 if (ldlm_cancel_unused_locks_before_replay)
2573 ldlm_cancel_unused_locks_for_replay(ns);
2575 ldlm_namespace_foreach(ns, ldlm_chain_lock_for_replay, &list);
2577 list_for_each_entry_safe(lock, next, &list, l_pending_chain) {
2578 list_del_init(&lock->l_pending_chain);
2579 /* If we disconnected in the middle - cleanup and let
2580 * reconnection to happen again. LU-14027 */
2581 if (rc || (imp->imp_state != LUSTRE_IMP_REPLAY_LOCKS)) {
2582 LDLM_LOCK_RELEASE(lock);
2585 rc = replay_one_lock(imp, lock);
2586 LDLM_LOCK_RELEASE(lock);
2589 wait_event_idle_exclusive(imp->imp_replay_waitq,
2590 lock_can_replay(imp));
2597 * Lock replay uses rate control and can sleep waiting so
2598 * must be in separate thread from ptlrpcd itself
2600 static int ldlm_lock_replay_thread(void *data)
2602 struct obd_import *imp = data;
2604 CDEBUG(D_HA, "lock replay thread %s to %s@%s\n",
2605 imp->imp_obd->obd_name, obd2cli_tgt(imp->imp_obd),
2606 imp->imp_connection->c_remote_uuid.uuid);
2608 __ldlm_replay_locks(imp, true);
2609 atomic_dec(&imp->imp_replay_inflight);
2610 ptlrpc_import_recovery_state_machine(imp);
2611 class_import_put(imp);
2616 int ldlm_replay_locks(struct obd_import *imp)
2618 struct task_struct *task;
2621 class_import_get(imp);
2622 /* ensure this doesn't fall to 0 before all have been queued */
2623 atomic_inc(&imp->imp_replay_inflight);
2625 task = kthread_run(ldlm_lock_replay_thread, imp, "ldlm_lock_replay");
2628 CDEBUG(D_HA, "can't start lock replay thread: rc = %d\n", rc);
2630 /* run lock replay without rate control */
2631 rc = __ldlm_replay_locks(imp, false);
2632 atomic_dec(&imp->imp_replay_inflight);
2633 class_import_put(imp);