4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2010, 2013, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
37 * This file contains Asynchronous System Trap (AST) handlers and related
38 * LDLM request-processing routines.
40 * An AST is a callback issued on a lock when its state is changed. There are
41 * several different types of ASTs (callbacks) registered for each lock:
43 * - completion AST: when a lock is enqueued by some process, but cannot be
44 * granted immediately due to other conflicting locks on the same resource,
45 * the completion AST is sent to notify the caller when the lock is
48 * - blocking AST: when a lock is granted to some process, if another process
49 * enqueues a conflicting (blocking) lock on a resource, a blocking AST is
50 * sent to notify the holder(s) of the lock(s) of the conflicting lock
51 * request. The lock holder(s) must release their lock(s) on that resource in
52 * a timely manner or be evicted by the server.
54 * - glimpse AST: this is used when a process wants information about a lock
55 * (i.e. the lock value block (LVB)) but does not necessarily require holding
56 * the lock. If the resource is locked, the lock holder(s) are sent glimpse
57 * ASTs and the LVB is returned to the caller, and lock holder(s) may CANCEL
58 * their lock(s) if they are idle. If the resource is not locked, the server
62 #define DEBUG_SUBSYSTEM S_LDLM
65 #include <liblustre.h>
68 #include <lustre_dlm.h>
69 #include <obd_class.h>
72 #include "ldlm_internal.h"
74 int ldlm_enqueue_min = OBD_TIMEOUT_DEFAULT;
75 CFS_MODULE_PARM(ldlm_enqueue_min, "i", int, 0644,
76 "lock enqueue timeout minimum");
78 /* in client side, whether the cached locks will be canceled before replay */
79 unsigned int ldlm_cancel_unused_locks_before_replay = 1;
81 static void interrupted_completion_wait(void *data)
85 struct lock_wait_data {
86 struct ldlm_lock *lwd_lock;
90 struct ldlm_async_args {
91 struct lustre_handle lock_handle;
94 int ldlm_expired_completion_wait(void *data)
96 struct lock_wait_data *lwd = data;
97 struct ldlm_lock *lock = lwd->lwd_lock;
98 struct obd_import *imp;
99 struct obd_device *obd;
102 if (lock->l_conn_export == NULL) {
103 static cfs_time_t next_dump = 0, last_dump = 0;
105 LCONSOLE_WARN("lock timed out (enqueued at "CFS_TIME_T", "
106 CFS_DURATION_T"s ago)\n",
107 lock->l_last_activity,
108 cfs_time_sub(cfs_time_current_sec(),
109 lock->l_last_activity));
110 LDLM_DEBUG(lock, "lock timed out (enqueued at "CFS_TIME_T", "
111 CFS_DURATION_T"s ago); not entering recovery in "
112 "server code, just going back to sleep",
113 lock->l_last_activity,
114 cfs_time_sub(cfs_time_current_sec(),
115 lock->l_last_activity));
116 if (cfs_time_after(cfs_time_current(), next_dump)) {
117 last_dump = next_dump;
118 next_dump = cfs_time_shift(300);
119 ldlm_namespace_dump(D_DLMTRACE,
120 ldlm_lock_to_ns(lock));
122 libcfs_debug_dumplog();
127 obd = lock->l_conn_export->exp_obd;
128 imp = obd->u.cli.cl_import;
129 ptlrpc_fail_import(imp, lwd->lwd_conn_cnt);
130 LDLM_ERROR(lock, "lock timed out (enqueued at "CFS_TIME_T", "
131 CFS_DURATION_T"s ago), entering recovery for %s@%s",
132 lock->l_last_activity,
133 cfs_time_sub(cfs_time_current_sec(), lock->l_last_activity),
134 obd2cli_tgt(obd), imp->imp_connection->c_remote_uuid.uuid);
138 EXPORT_SYMBOL(ldlm_expired_completion_wait);
140 /* We use the same basis for both server side and client side functions
141 from a single node. */
142 int ldlm_get_enq_timeout(struct ldlm_lock *lock)
144 int timeout = at_get(ldlm_lock_to_ns_at(lock));
146 return obd_timeout / 2;
147 /* Since these are non-updating timeouts, we should be conservative.
148 It would be nice to have some kind of "early reply" mechanism for
149 lock callbacks too... */
150 timeout = min_t(int, at_max, timeout + (timeout >> 1)); /* 150% */
151 return max(timeout, ldlm_enqueue_min);
153 EXPORT_SYMBOL(ldlm_get_enq_timeout);
156 * Helper function for ldlm_completion_ast(), updating timings when lock is
159 static int ldlm_completion_tail(struct ldlm_lock *lock)
164 if (lock->l_flags & (LDLM_FL_DESTROYED | LDLM_FL_FAILED)) {
165 LDLM_DEBUG(lock, "client-side enqueue: destroyed");
168 delay = cfs_time_sub(cfs_time_current_sec(),
169 lock->l_last_activity);
170 LDLM_DEBUG(lock, "client-side enqueue: granted after "
171 CFS_DURATION_T"s", delay);
173 /* Update our time estimate */
174 at_measured(ldlm_lock_to_ns_at(lock),
182 * Implementation of ->l_completion_ast() for a client, that doesn't wait
183 * until lock is granted. Suitable for locks enqueued through ptlrpcd, of
184 * other threads that cannot block for long.
186 int ldlm_completion_ast_async(struct ldlm_lock *lock, __u64 flags, void *data)
190 if (flags == LDLM_FL_WAIT_NOREPROC) {
191 LDLM_DEBUG(lock, "client-side enqueue waiting on pending lock");
195 if (!(flags & (LDLM_FL_BLOCK_WAIT | LDLM_FL_BLOCK_GRANTED |
196 LDLM_FL_BLOCK_CONV))) {
197 cfs_waitq_signal(&lock->l_waitq);
198 RETURN(ldlm_completion_tail(lock));
201 LDLM_DEBUG(lock, "client-side enqueue returned a blocked lock, "
203 ldlm_reprocess_all(lock->l_resource);
206 EXPORT_SYMBOL(ldlm_completion_ast_async);
209 * Generic LDLM "completion" AST. This is called in several cases:
211 * - when a reply to an ENQUEUE RPC is received from the server
212 * (ldlm_cli_enqueue_fini()). Lock might be granted or not granted at
213 * this point (determined by flags);
215 * - when LDLM_CP_CALLBACK RPC comes to client to notify it that lock has
218 * - when ldlm_lock_match(LDLM_FL_LVB_READY) is about to wait until lock
221 * - to force all locks when resource is destroyed (cleanup_resource());
223 * - during lock conversion (not used currently).
225 * If lock is not granted in the first case, this function waits until second
226 * or penultimate cases happen in some other thread.
229 int ldlm_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data)
231 /* XXX ALLOCATE - 160 bytes */
232 struct lock_wait_data lwd;
233 struct obd_device *obd;
234 struct obd_import *imp = NULL;
235 struct l_wait_info lwi;
240 if (flags == LDLM_FL_WAIT_NOREPROC) {
241 LDLM_DEBUG(lock, "client-side enqueue waiting on pending lock");
245 if (!(flags & (LDLM_FL_BLOCK_WAIT | LDLM_FL_BLOCK_GRANTED |
246 LDLM_FL_BLOCK_CONV))) {
247 cfs_waitq_signal(&lock->l_waitq);
251 LDLM_DEBUG(lock, "client-side enqueue returned a blocked lock, "
256 obd = class_exp2obd(lock->l_conn_export);
258 /* if this is a local lock, then there is no import */
260 imp = obd->u.cli.cl_import;
263 /* Wait a long time for enqueue - server may have to callback a
264 lock from another client. Server will evict the other client if it
265 doesn't respond reasonably, and then give us the lock. */
266 timeout = ldlm_get_enq_timeout(lock) * 2;
270 if (lock->l_flags & LDLM_FL_NO_TIMEOUT) {
271 LDLM_DEBUG(lock, "waiting indefinitely because of NO_TIMEOUT");
272 lwi = LWI_INTR(interrupted_completion_wait, &lwd);
274 lwi = LWI_TIMEOUT_INTR(cfs_time_seconds(timeout),
275 ldlm_expired_completion_wait,
276 interrupted_completion_wait, &lwd);
280 spin_lock(&imp->imp_lock);
281 lwd.lwd_conn_cnt = imp->imp_conn_cnt;
282 spin_unlock(&imp->imp_lock);
285 if (ns_is_client(ldlm_lock_to_ns(lock)) &&
286 OBD_FAIL_CHECK_RESET(OBD_FAIL_LDLM_INTR_CP_AST,
287 OBD_FAIL_LDLM_CP_BL_RACE | OBD_FAIL_ONCE)) {
288 lock->l_flags |= LDLM_FL_FAIL_LOC;
291 /* Go to sleep until the lock is granted or cancelled. */
292 rc = l_wait_event(lock->l_waitq,
293 is_granted_or_cancelled(lock), &lwi);
297 LDLM_DEBUG(lock, "client-side enqueue waking up: failed (%d)",
302 RETURN(ldlm_completion_tail(lock));
304 EXPORT_SYMBOL(ldlm_completion_ast);
307 * A helper to build a blocking AST function
309 * Perform a common operation for blocking ASTs:
310 * defferred lock cancellation.
312 * \param lock the lock blocking or canceling AST was called on
314 * \see mdt_blocking_ast
315 * \see ldlm_blocking_ast
317 int ldlm_blocking_ast_nocheck(struct ldlm_lock *lock)
322 lock->l_flags |= LDLM_FL_CBPENDING;
323 do_ast = (!lock->l_readers && !lock->l_writers);
324 unlock_res_and_lock(lock);
327 struct lustre_handle lockh;
330 LDLM_DEBUG(lock, "already unused, calling ldlm_cli_cancel");
331 ldlm_lock2handle(lock, &lockh);
332 rc = ldlm_cli_cancel(&lockh, LCF_ASYNC);
334 CERROR("ldlm_cli_cancel: %d\n", rc);
336 LDLM_DEBUG(lock, "Lock still has references, will be "
341 EXPORT_SYMBOL(ldlm_blocking_ast_nocheck);
344 * Server blocking AST
346 * ->l_blocking_ast() callback for LDLM locks acquired by server-side
349 * \param lock the lock which blocks a request or cancelling lock
352 * \param flag indicates whether this cancelling or blocking callback
354 * \see ldlm_blocking_ast_nocheck
356 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
357 void *data, int flag)
361 if (flag == LDLM_CB_CANCELING) {
362 /* Don't need to do anything here. */
366 lock_res_and_lock(lock);
367 /* Get this: if ldlm_blocking_ast is racing with intent_policy, such
368 * that ldlm_blocking_ast is called just before intent_policy method
369 * takes the lr_lock, then by the time we get the lock, we might not
370 * be the correct blocking function anymore. So check, and return
372 if (lock->l_blocking_ast != ldlm_blocking_ast) {
373 unlock_res_and_lock(lock);
376 RETURN(ldlm_blocking_ast_nocheck(lock));
378 EXPORT_SYMBOL(ldlm_blocking_ast);
381 * ->l_glimpse_ast() for DLM extent locks acquired on the server-side. See
382 * comment in filter_intent_policy() on why you may need this.
384 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp)
387 * Returning -ELDLM_NO_LOCK_DATA actually works, but the reason for
388 * that is rather subtle: with OST-side locking, it may so happen that
389 * _all_ extent locks are held by the OST. If client wants to obtain
390 * current file size it calls ll{,u}_glimpse_size(), and (as locks are
391 * on the server), dummy glimpse callback fires and does
392 * nothing. Client still receives correct file size due to the
393 * following fragment in filter_intent_policy():
395 * rc = l->l_glimpse_ast(l, NULL); // this will update the LVB
396 * if (rc != 0 && res->lr_namespace->ns_lvbo &&
397 * res->lr_namespace->ns_lvbo->lvbo_update) {
398 * res->lr_namespace->ns_lvbo->lvbo_update(res, NULL, 0, 1);
401 * that is, after glimpse_ast() fails, filter_lvbo_update() runs, and
402 * returns correct file size to the client.
404 return -ELDLM_NO_LOCK_DATA;
406 EXPORT_SYMBOL(ldlm_glimpse_ast);
409 * Enqueue a local lock (typically on a server).
411 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
412 const struct ldlm_res_id *res_id,
413 ldlm_type_t type, ldlm_policy_data_t *policy,
414 ldlm_mode_t mode, __u64 *flags,
415 ldlm_blocking_callback blocking,
416 ldlm_completion_callback completion,
417 ldlm_glimpse_callback glimpse,
418 void *data, __u32 lvb_len, enum lvb_type lvb_type,
419 const __u64 *client_cookie,
420 struct lustre_handle *lockh)
422 struct ldlm_lock *lock;
424 const struct ldlm_callback_suite cbs = { .lcs_completion = completion,
425 .lcs_blocking = blocking,
426 .lcs_glimpse = glimpse,
430 LASSERT(!(*flags & LDLM_FL_REPLAY));
431 if (unlikely(ns_is_client(ns))) {
432 CERROR("Trying to enqueue local lock in a shadow namespace\n");
436 lock = ldlm_lock_create(ns, res_id, type, mode, &cbs, data, lvb_len,
439 GOTO(out_nolock, err = -ENOMEM);
441 ldlm_lock2handle(lock, lockh);
443 /* NB: we don't have any lock now (lock_res_and_lock)
444 * because it's a new lock */
445 ldlm_lock_addref_internal_nolock(lock, mode);
446 lock->l_flags |= LDLM_FL_LOCAL;
447 if (*flags & LDLM_FL_ATOMIC_CB)
448 lock->l_flags |= LDLM_FL_ATOMIC_CB;
451 lock->l_policy_data = *policy;
452 if (client_cookie != NULL)
453 lock->l_client_cookie = *client_cookie;
454 if (type == LDLM_EXTENT)
455 lock->l_req_extent = policy->l_extent;
457 err = ldlm_lock_enqueue(ns, &lock, policy, flags);
458 if (unlikely(err != ELDLM_OK))
462 *policy = lock->l_policy_data;
464 if (lock->l_completion_ast)
465 lock->l_completion_ast(lock, *flags, NULL);
467 LDLM_DEBUG(lock, "client-side local enqueue handler, new lock created");
470 LDLM_LOCK_RELEASE(lock);
474 EXPORT_SYMBOL(ldlm_cli_enqueue_local);
476 static void failed_lock_cleanup(struct ldlm_namespace *ns,
477 struct ldlm_lock *lock, int mode)
481 /* Set a flag to prevent us from sending a CANCEL (bug 407) */
482 lock_res_and_lock(lock);
483 /* Check that lock is not granted or failed, we might race. */
484 if ((lock->l_req_mode != lock->l_granted_mode) &&
485 !(lock->l_flags & LDLM_FL_FAILED)) {
486 /* Make sure that this lock will not be found by raced
487 * bl_ast and -EINVAL reply is sent to server anyways.
489 lock->l_flags |= LDLM_FL_LOCAL_ONLY | LDLM_FL_FAILED |
490 LDLM_FL_ATOMIC_CB | LDLM_FL_CBPENDING;
493 unlock_res_and_lock(lock);
497 "setting FL_LOCAL_ONLY | LDLM_FL_FAILED | "
498 "LDLM_FL_ATOMIC_CB | LDLM_FL_CBPENDING");
500 LDLM_DEBUG(lock, "lock was granted or failed in race");
502 ldlm_lock_decref_internal(lock, mode);
504 /* XXX - HACK because we shouldn't call ldlm_lock_destroy()
505 * from llite/file.c/ll_file_flock(). */
506 /* This code makes for the fact that we do not have blocking handler on
507 * a client for flock locks. As such this is the place where we must
508 * completely kill failed locks. (interrupted and those that
509 * were waiting to be granted when server evicted us. */
510 if (lock->l_resource->lr_type == LDLM_FLOCK) {
511 lock_res_and_lock(lock);
512 ldlm_resource_unlink_lock(lock);
513 ldlm_lock_destroy_nolock(lock);
514 unlock_res_and_lock(lock);
519 * Finishing portion of client lock enqueue code.
521 * Called after receiving reply from server.
523 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
524 ldlm_type_t type, __u8 with_policy, ldlm_mode_t mode,
525 __u64 *flags, void *lvb, __u32 lvb_len,
526 struct lustre_handle *lockh,int rc)
528 struct ldlm_namespace *ns = exp->exp_obd->obd_namespace;
529 int is_replay = *flags & LDLM_FL_REPLAY;
530 struct ldlm_lock *lock;
531 struct ldlm_reply *reply;
532 int cleanup_phase = 1;
536 lock = ldlm_handle2lock(lockh);
537 /* ldlm_cli_enqueue is holding a reference on this lock. */
539 LASSERT(type == LDLM_FLOCK);
543 LASSERTF(ergo(lvb_len != 0, lvb_len == lock->l_lvb_len),
544 "lvb_len = %d, l_lvb_len = %d\n", lvb_len, lock->l_lvb_len);
546 if (rc != ELDLM_OK) {
548 LDLM_DEBUG(lock, "client-side enqueue END (%s)",
549 rc == ELDLM_LOCK_ABORTED ? "ABORTED" : "FAILED");
551 if (rc != ELDLM_LOCK_ABORTED)
555 /* Before we return, swab the reply */
556 reply = req_capsule_server_get(&req->rq_pill, &RMF_DLM_REP);
558 GOTO(cleanup, rc = -EPROTO);
561 LASSERT(lvb != NULL);
563 size = req_capsule_get_size(&req->rq_pill, &RMF_DLM_LVB,
566 LDLM_ERROR(lock, "Fail to get lvb_len, rc = %d", size);
567 GOTO(cleanup, rc = size);
568 } else if (unlikely(size > lvb_len)) {
569 LDLM_ERROR(lock, "Replied LVB is larger than "
570 "expectation, expected = %d, replied = %d",
572 GOTO(cleanup, rc = -EINVAL);
576 if (rc == ELDLM_LOCK_ABORTED) {
578 rc = ldlm_fill_lvb(lock, &req->rq_pill, RCL_SERVER,
580 GOTO(cleanup, rc = (rc != 0 ? rc : ELDLM_LOCK_ABORTED));
583 /* lock enqueued on the server */
586 lock_res_and_lock(lock);
587 /* Key change rehash lock in per-export hash with new key */
588 if (exp->exp_lock_hash) {
589 /* In the function below, .hs_keycmp resolves to
590 * ldlm_export_lock_keycmp() */
591 /* coverity[overrun-buffer-val] */
592 cfs_hash_rehash_key(exp->exp_lock_hash,
593 &lock->l_remote_handle,
597 lock->l_remote_handle = reply->lock_handle;
600 *flags = ldlm_flags_from_wire(reply->lock_flags);
601 lock->l_flags |= ldlm_flags_from_wire(reply->lock_flags &
603 /* move NO_TIMEOUT flag to the lock to force ldlm_lock_match()
604 * to wait with no timeout as well */
605 lock->l_flags |= ldlm_flags_from_wire(reply->lock_flags &
607 unlock_res_and_lock(lock);
609 CDEBUG(D_INFO, "local: %p, remote cookie: "LPX64", flags: 0x%llx\n",
610 lock, reply->lock_handle.cookie, *flags);
612 /* If enqueue returned a blocked lock but the completion handler has
613 * already run, then it fixed up the resource and we don't need to do it
615 if ((*flags) & LDLM_FL_LOCK_CHANGED) {
616 int newmode = reply->lock_desc.l_req_mode;
618 if (newmode && newmode != lock->l_req_mode) {
619 LDLM_DEBUG(lock, "server returned different mode %s",
620 ldlm_lockname[newmode]);
621 lock->l_req_mode = newmode;
624 if (!ldlm_res_eq(&reply->lock_desc.l_resource.lr_name,
625 &lock->l_resource->lr_name)) {
626 CDEBUG(D_INFO, "remote intent success, locking "DLDLMRES
627 " instead of "DLDLMRES"\n",
628 PLDLMRES(&reply->lock_desc.l_resource),
629 PLDLMRES(lock->l_resource));
631 rc = ldlm_lock_change_resource(ns, lock,
632 &reply->lock_desc.l_resource.lr_name);
633 if (rc || lock->l_resource == NULL)
634 GOTO(cleanup, rc = -ENOMEM);
635 LDLM_DEBUG(lock, "client-side enqueue, new resource");
638 if (!(type == LDLM_IBITS &&
639 !(exp_connect_flags(exp) & OBD_CONNECT_IBITS)))
640 /* We assume lock type cannot change on server*/
641 ldlm_convert_policy_to_local(exp,
642 lock->l_resource->lr_type,
643 &reply->lock_desc.l_policy_data,
644 &lock->l_policy_data);
645 if (type != LDLM_PLAIN)
646 LDLM_DEBUG(lock,"client-side enqueue, new policy data");
649 if ((*flags) & LDLM_FL_AST_SENT ||
650 /* Cancel extent locks as soon as possible on a liblustre client,
651 * because it cannot handle asynchronous ASTs robustly (see
653 (LIBLUSTRE_CLIENT && type == LDLM_EXTENT)) {
654 lock_res_and_lock(lock);
655 lock->l_flags |= LDLM_FL_CBPENDING | LDLM_FL_BL_AST;
656 unlock_res_and_lock(lock);
657 LDLM_DEBUG(lock, "enqueue reply includes blocking AST");
660 /* If the lock has already been granted by a completion AST, don't
661 * clobber the LVB with an older one. */
663 /* We must lock or a racing completion might update lvb without
664 * letting us know and we'll clobber the correct value.
665 * Cannot unlock after the check either, a that still leaves
666 * a tiny window for completion to get in */
667 lock_res_and_lock(lock);
668 if (lock->l_req_mode != lock->l_granted_mode)
669 rc = ldlm_fill_lvb(lock, &req->rq_pill, RCL_SERVER,
670 lock->l_lvb_data, size);
671 unlock_res_and_lock(lock);
679 rc = ldlm_lock_enqueue(ns, &lock, NULL, flags);
680 if (lock->l_completion_ast != NULL) {
681 int err = lock->l_completion_ast(lock, *flags, NULL);
689 if (lvb_len && lvb != NULL) {
690 /* Copy the LVB here, and not earlier, because the completion
691 * AST (if any) can override what we got in the reply */
692 memcpy(lvb, lock->l_lvb_data, lvb_len);
695 LDLM_DEBUG(lock, "client-side enqueue END");
698 if (cleanup_phase == 1 && rc)
699 failed_lock_cleanup(ns, lock, mode);
700 /* Put lock 2 times, the second reference is held by ldlm_cli_enqueue */
702 LDLM_LOCK_RELEASE(lock);
705 EXPORT_SYMBOL(ldlm_cli_enqueue_fini);
708 * Estimate number of lock handles that would fit into request of given
709 * size. PAGE_SIZE-512 is to allow TCP/IP and LNET headers to fit into
710 * a single page on the send/receive side. XXX: 512 should be changed to
711 * more adequate value.
713 static inline int ldlm_req_handles_avail(int req_size, int off)
717 avail = min_t(int, LDLM_MAXREQSIZE, PAGE_CACHE_SIZE - 512) - req_size;
718 if (likely(avail >= 0))
719 avail /= (int)sizeof(struct lustre_handle);
722 avail += LDLM_LOCKREQ_HANDLES - off;
727 static inline int ldlm_capsule_handles_avail(struct req_capsule *pill,
728 enum req_location loc,
731 int size = req_capsule_msg_size(pill, loc);
732 return ldlm_req_handles_avail(size, off);
735 static inline int ldlm_format_handles_avail(struct obd_import *imp,
736 const struct req_format *fmt,
737 enum req_location loc, int off)
739 int size = req_capsule_fmt_size(imp->imp_msg_magic, fmt, loc);
740 return ldlm_req_handles_avail(size, off);
744 * Cancel LRU locks and pack them into the enqueue request. Pack there the given
745 * \a count locks in \a cancels.
747 * This is to be called by functions preparing their own requests that
748 * might contain lists of locks to cancel in addition to actual operation
749 * that needs to be performed.
751 int ldlm_prep_elc_req(struct obd_export *exp, struct ptlrpc_request *req,
752 int version, int opc, int canceloff,
753 cfs_list_t *cancels, int count)
755 struct ldlm_namespace *ns = exp->exp_obd->obd_namespace;
756 struct req_capsule *pill = &req->rq_pill;
757 struct ldlm_request *dlm = NULL;
758 int flags, avail, to_free, pack = 0;
765 if (ns_connect_cancelset(ns)) {
766 /* Estimate the amount of available space in the request. */
767 req_capsule_filled_sizes(pill, RCL_CLIENT);
768 avail = ldlm_capsule_handles_avail(pill, RCL_CLIENT, canceloff);
770 flags = ns_connect_lru_resize(ns) ?
771 LDLM_CANCEL_LRUR : LDLM_CANCEL_AGED;
772 to_free = !ns_connect_lru_resize(ns) &&
773 opc == LDLM_ENQUEUE ? 1 : 0;
775 /* Cancel LRU locks here _only_ if the server supports
776 * EARLY_CANCEL. Otherwise we have to send extra CANCEL
777 * RPC, which will make us slower. */
779 count += ldlm_cancel_lru_local(ns, cancels, to_free,
780 avail - count, 0, flags);
785 req_capsule_set_size(pill, &RMF_DLM_REQ, RCL_CLIENT,
786 ldlm_request_bufsize(pack, opc));
789 rc = ptlrpc_request_pack(req, version, opc);
791 ldlm_lock_list_put(cancels, l_bl_ast, count);
795 if (ns_connect_cancelset(ns)) {
797 dlm = req_capsule_client_get(pill, &RMF_DLM_REQ);
799 /* Skip first lock handler in ldlm_request_pack(),
800 * this method will incrment @lock_count according
801 * to the lock handle amount actually written to
803 dlm->lock_count = canceloff;
805 /* Pack into the request @pack lock handles. */
806 ldlm_cli_cancel_list(cancels, pack, req, 0);
807 /* Prepare and send separate cancel RPC for others. */
808 ldlm_cli_cancel_list(cancels, count - pack, NULL, 0);
810 ldlm_lock_list_put(cancels, l_bl_ast, count);
814 EXPORT_SYMBOL(ldlm_prep_elc_req);
816 int ldlm_prep_enqueue_req(struct obd_export *exp, struct ptlrpc_request *req,
817 cfs_list_t *cancels, int count)
819 return ldlm_prep_elc_req(exp, req, LUSTRE_DLM_VERSION, LDLM_ENQUEUE,
820 LDLM_ENQUEUE_CANCEL_OFF, cancels, count);
822 EXPORT_SYMBOL(ldlm_prep_enqueue_req);
824 struct ptlrpc_request *ldlm_enqueue_pack(struct obd_export *exp, int lvb_len)
826 struct ptlrpc_request *req;
830 req = ptlrpc_request_alloc(class_exp2cliimp(exp), &RQF_LDLM_ENQUEUE);
832 RETURN(ERR_PTR(-ENOMEM));
834 rc = ldlm_prep_enqueue_req(exp, req, NULL, 0);
836 ptlrpc_request_free(req);
840 req_capsule_set_size(&req->rq_pill, &RMF_DLM_LVB, RCL_SERVER, lvb_len);
841 ptlrpc_request_set_replen(req);
844 EXPORT_SYMBOL(ldlm_enqueue_pack);
847 * Client-side lock enqueue.
849 * If a request has some specific initialisation it is passed in \a reqp,
850 * otherwise it is created in ldlm_cli_enqueue.
852 * Supports sync and async requests, pass \a async flag accordingly. If a
853 * request was created in ldlm_cli_enqueue and it is the async request,
854 * pass it to the caller in \a reqp.
856 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
857 struct ldlm_enqueue_info *einfo,
858 const struct ldlm_res_id *res_id,
859 ldlm_policy_data_t const *policy, __u64 *flags,
860 void *lvb, __u32 lvb_len, enum lvb_type lvb_type,
861 struct lustre_handle *lockh, int async)
863 struct ldlm_namespace *ns;
864 struct ldlm_lock *lock;
865 struct ldlm_request *body;
866 int is_replay = *flags & LDLM_FL_REPLAY;
867 int req_passed_in = 1;
869 struct ptlrpc_request *req;
872 LASSERT(exp != NULL);
874 ns = exp->exp_obd->obd_namespace;
876 /* If we're replaying this lock, just check some invariants.
877 * If we're creating a new lock, get everything all setup nice. */
879 lock = ldlm_handle2lock_long(lockh, 0);
880 LASSERT(lock != NULL);
881 LDLM_DEBUG(lock, "client-side enqueue START");
882 LASSERT(exp == lock->l_conn_export);
884 const struct ldlm_callback_suite cbs = {
885 .lcs_completion = einfo->ei_cb_cp,
886 .lcs_blocking = einfo->ei_cb_bl,
887 .lcs_glimpse = einfo->ei_cb_gl
889 lock = ldlm_lock_create(ns, res_id, einfo->ei_type,
890 einfo->ei_mode, &cbs, einfo->ei_cbdata,
894 /* for the local lock, add the reference */
895 ldlm_lock_addref_internal(lock, einfo->ei_mode);
896 ldlm_lock2handle(lock, lockh);
897 if (policy != NULL) {
898 /* INODEBITS_INTEROP: If the server does not support
899 * inodebits, we will request a plain lock in the
900 * descriptor (ldlm_lock2desc() below) but use an
901 * inodebits lock internally with both bits set.
903 if (einfo->ei_type == LDLM_IBITS &&
904 !(exp_connect_flags(exp) &
906 lock->l_policy_data.l_inodebits.bits =
907 MDS_INODELOCK_LOOKUP |
908 MDS_INODELOCK_UPDATE;
910 lock->l_policy_data = *policy;
913 if (einfo->ei_type == LDLM_EXTENT)
914 lock->l_req_extent = policy->l_extent;
915 LDLM_DEBUG(lock, "client-side enqueue START, flags %llx\n",
919 lock->l_conn_export = exp;
920 lock->l_export = NULL;
921 lock->l_blocking_ast = einfo->ei_cb_bl;
922 lock->l_flags |= (*flags & (LDLM_FL_NO_LRU | LDLM_FL_EXCL));
924 /* lock not sent to server yet */
926 if (reqp == NULL || *reqp == NULL) {
927 req = ptlrpc_request_alloc_pack(class_exp2cliimp(exp),
932 failed_lock_cleanup(ns, lock, einfo->ei_mode);
933 LDLM_LOCK_RELEASE(lock);
943 len = req_capsule_get_size(&req->rq_pill, &RMF_DLM_REQ,
945 LASSERTF(len >= sizeof(*body), "buflen[%d] = %d, not %d\n",
946 DLM_LOCKREQ_OFF, len, (int)sizeof(*body));
949 /* Dump lock data into the request buffer */
950 body = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
951 ldlm_lock2desc(lock, &body->lock_desc);
952 body->lock_flags = ldlm_flags_to_wire(*flags);
953 body->lock_handle[0] = *lockh;
955 /* Continue as normal. */
956 if (!req_passed_in) {
958 req_capsule_extend(&req->rq_pill,
959 &RQF_LDLM_ENQUEUE_LVB);
960 req_capsule_set_size(&req->rq_pill, &RMF_DLM_LVB, RCL_SERVER,
962 ptlrpc_request_set_replen(req);
966 * Liblustre client doesn't get extent locks, except for O_APPEND case
967 * where [0, OBD_OBJECT_EOF] lock is taken, or truncate, where
968 * [i_size, OBD_OBJECT_EOF] lock is taken.
970 LASSERT(ergo(LIBLUSTRE_CLIENT, einfo->ei_type != LDLM_EXTENT ||
971 policy->l_extent.end == OBD_OBJECT_EOF));
974 LASSERT(reqp != NULL);
978 LDLM_DEBUG(lock, "sending request");
980 rc = ptlrpc_queue_wait(req);
982 err = ldlm_cli_enqueue_fini(exp, req, einfo->ei_type, policy ? 1 : 0,
983 einfo->ei_mode, flags, lvb, lvb_len,
986 /* If ldlm_cli_enqueue_fini did not find the lock, we need to free
987 * one reference that we took */
989 LDLM_LOCK_RELEASE(lock);
993 if (!req_passed_in && req != NULL) {
994 ptlrpc_req_finished(req);
1001 EXPORT_SYMBOL(ldlm_cli_enqueue);
1003 static int ldlm_cli_convert_local(struct ldlm_lock *lock, int new_mode,
1006 struct ldlm_resource *res;
1009 if (ns_is_client(ldlm_lock_to_ns(lock))) {
1010 CERROR("Trying to cancel local lock\n");
1013 LDLM_DEBUG(lock, "client-side local convert");
1015 res = ldlm_lock_convert(lock, new_mode, flags);
1017 ldlm_reprocess_all(res);
1020 rc = LUSTRE_EDEADLK;
1022 LDLM_DEBUG(lock, "client-side local convert handler END");
1023 LDLM_LOCK_PUT(lock);
1027 /* FIXME: one of ldlm_cli_convert or the server side should reject attempted
1028 * conversion of locks which are on the waiting or converting queue */
1029 /* Caller of this code is supposed to take care of lock readers/writers
1031 int ldlm_cli_convert(struct lustre_handle *lockh, int new_mode, __u32 *flags)
1033 struct ldlm_request *body;
1034 struct ldlm_reply *reply;
1035 struct ldlm_lock *lock;
1036 struct ldlm_resource *res;
1037 struct ptlrpc_request *req;
1041 lock = ldlm_handle2lock(lockh);
1048 if (lock->l_conn_export == NULL)
1049 RETURN(ldlm_cli_convert_local(lock, new_mode, flags));
1051 LDLM_DEBUG(lock, "client-side convert");
1053 req = ptlrpc_request_alloc_pack(class_exp2cliimp(lock->l_conn_export),
1054 &RQF_LDLM_CONVERT, LUSTRE_DLM_VERSION,
1057 LDLM_LOCK_PUT(lock);
1061 body = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
1062 body->lock_handle[0] = lock->l_remote_handle;
1064 body->lock_desc.l_req_mode = new_mode;
1065 body->lock_flags = ldlm_flags_to_wire(*flags);
1068 ptlrpc_request_set_replen(req);
1069 rc = ptlrpc_queue_wait(req);
1073 reply = req_capsule_server_get(&req->rq_pill, &RMF_DLM_REP);
1075 GOTO(out, rc = -EPROTO);
1078 GOTO(out, rc = req->rq_status);
1080 res = ldlm_lock_convert(lock, new_mode, &reply->lock_flags);
1082 ldlm_reprocess_all(res);
1083 /* Go to sleep until the lock is granted. */
1084 /* FIXME: or cancelled. */
1085 if (lock->l_completion_ast) {
1086 rc = lock->l_completion_ast(lock, LDLM_FL_WAIT_NOREPROC,
1092 rc = LUSTRE_EDEADLK;
1096 LDLM_LOCK_PUT(lock);
1097 ptlrpc_req_finished(req);
1100 EXPORT_SYMBOL(ldlm_cli_convert);
1103 * Cancel locks locally.
1105 * \retval LDLM_FL_LOCAL_ONLY if there is no need for a CANCEL RPC to the server
1106 * \retval LDLM_FL_CANCELING otherwise;
1107 * \retval LDLM_FL_BL_AST if there is a need for a separate CANCEL RPC.
1109 static __u64 ldlm_cli_cancel_local(struct ldlm_lock *lock)
1111 __u64 rc = LDLM_FL_LOCAL_ONLY;
1114 if (lock->l_conn_export) {
1117 LDLM_DEBUG(lock, "client-side cancel");
1118 /* Set this flag to prevent others from getting new references*/
1119 lock_res_and_lock(lock);
1120 lock->l_flags |= LDLM_FL_CBPENDING;
1121 local_only = !!(lock->l_flags &
1122 (LDLM_FL_LOCAL_ONLY|LDLM_FL_CANCEL_ON_BLOCK));
1123 ldlm_cancel_callback(lock);
1124 rc = (lock->l_flags & LDLM_FL_BL_AST) ?
1125 LDLM_FL_BL_AST : LDLM_FL_CANCELING;
1126 unlock_res_and_lock(lock);
1129 CDEBUG(D_DLMTRACE, "not sending request (at caller's "
1131 rc = LDLM_FL_LOCAL_ONLY;
1133 ldlm_lock_cancel(lock);
1135 if (ns_is_client(ldlm_lock_to_ns(lock))) {
1136 LDLM_ERROR(lock, "Trying to cancel local lock");
1139 LDLM_DEBUG(lock, "server-side local cancel");
1140 ldlm_lock_cancel(lock);
1141 ldlm_reprocess_all(lock->l_resource);
1148 * Pack \a count locks in \a head into ldlm_request buffer of request \a req.
1150 static void ldlm_cancel_pack(struct ptlrpc_request *req,
1151 cfs_list_t *head, int count)
1153 struct ldlm_request *dlm;
1154 struct ldlm_lock *lock;
1155 int max, packed = 0;
1158 dlm = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
1159 LASSERT(dlm != NULL);
1161 /* Check the room in the request buffer. */
1162 max = req_capsule_get_size(&req->rq_pill, &RMF_DLM_REQ, RCL_CLIENT) -
1163 sizeof(struct ldlm_request);
1164 max /= sizeof(struct lustre_handle);
1165 max += LDLM_LOCKREQ_HANDLES;
1166 LASSERT(max >= dlm->lock_count + count);
1168 /* XXX: it would be better to pack lock handles grouped by resource.
1169 * so that the server cancel would call filter_lvbo_update() less
1171 cfs_list_for_each_entry(lock, head, l_bl_ast) {
1174 LASSERT(lock->l_conn_export);
1175 /* Pack the lock handle to the given request buffer. */
1176 LDLM_DEBUG(lock, "packing");
1177 dlm->lock_handle[dlm->lock_count++] = lock->l_remote_handle;
1180 CDEBUG(D_DLMTRACE, "%d locks packed\n", packed);
1185 * Prepare and send a batched cancel RPC. It will include \a count lock
1186 * handles of locks given in \a cancels list. */
1187 int ldlm_cli_cancel_req(struct obd_export *exp, cfs_list_t *cancels,
1188 int count, ldlm_cancel_flags_t flags)
1190 struct ptlrpc_request *req = NULL;
1191 struct obd_import *imp;
1196 LASSERT(exp != NULL);
1199 CFS_FAIL_TIMEOUT(OBD_FAIL_LDLM_PAUSE_CANCEL, cfs_fail_val);
1201 if (CFS_FAIL_CHECK(OBD_FAIL_LDLM_CANCEL_RACE))
1204 free = ldlm_format_handles_avail(class_exp2cliimp(exp),
1205 &RQF_LDLM_CANCEL, RCL_CLIENT, 0);
1210 imp = class_exp2cliimp(exp);
1211 if (imp == NULL || imp->imp_invalid) {
1213 "skipping cancel on invalid import %p\n", imp);
1217 req = ptlrpc_request_alloc(imp, &RQF_LDLM_CANCEL);
1219 GOTO(out, rc = -ENOMEM);
1221 req_capsule_filled_sizes(&req->rq_pill, RCL_CLIENT);
1222 req_capsule_set_size(&req->rq_pill, &RMF_DLM_REQ, RCL_CLIENT,
1223 ldlm_request_bufsize(count, LDLM_CANCEL));
1225 rc = ptlrpc_request_pack(req, LUSTRE_DLM_VERSION, LDLM_CANCEL);
1227 ptlrpc_request_free(req);
1231 req->rq_request_portal = LDLM_CANCEL_REQUEST_PORTAL;
1232 req->rq_reply_portal = LDLM_CANCEL_REPLY_PORTAL;
1233 ptlrpc_at_set_req_timeout(req);
1235 ldlm_cancel_pack(req, cancels, count);
1237 ptlrpc_request_set_replen(req);
1238 if (flags & LCF_ASYNC) {
1239 ptlrpcd_add_req(req, PDL_POLICY_LOCAL, -1);
1243 rc = ptlrpc_queue_wait(req);
1245 if (rc == LUSTRE_ESTALE) {
1246 CDEBUG(D_DLMTRACE, "client/server (nid %s) "
1247 "out of sync -- not fatal\n",
1248 libcfs_nid2str(req->rq_import->
1249 imp_connection->c_peer.nid));
1251 } else if (rc == -ETIMEDOUT && /* check there was no reconnect*/
1252 req->rq_import_generation == imp->imp_generation) {
1253 ptlrpc_req_finished(req);
1255 } else if (rc != ELDLM_OK) {
1256 /* -ESHUTDOWN is common on umount */
1257 CDEBUG_LIMIT(rc == -ESHUTDOWN ? D_DLMTRACE : D_ERROR,
1258 "Got rc %d from cancel RPC: "
1259 "canceling anyway\n", rc);
1266 ptlrpc_req_finished(req);
1269 return sent ? sent : rc;
1271 EXPORT_SYMBOL(ldlm_cli_cancel_req);
1273 static inline struct ldlm_pool *ldlm_imp2pl(struct obd_import *imp)
1275 LASSERT(imp != NULL);
1276 return &imp->imp_obd->obd_namespace->ns_pool;
1280 * Update client's OBD pool related fields with new SLV and Limit from \a req.
1282 int ldlm_cli_update_pool(struct ptlrpc_request *req)
1284 struct obd_device *obd;
1288 if (unlikely(!req->rq_import || !req->rq_import->imp_obd ||
1289 !imp_connect_lru_resize(req->rq_import)))
1292 * Do nothing for corner cases.
1297 /* In some cases RPC may contain SLV and limit zeroed out. This
1298 * is the case when server does not support LRU resize feature.
1299 * This is also possible in some recovery cases when server-side
1300 * reqs have no reference to the OBD export and thus access to
1301 * server-side namespace is not possible. */
1302 if (lustre_msg_get_slv(req->rq_repmsg) == 0 ||
1303 lustre_msg_get_limit(req->rq_repmsg) == 0) {
1304 DEBUG_REQ(D_HA, req, "Zero SLV or Limit found "
1305 "(SLV: "LPU64", Limit: %u)",
1306 lustre_msg_get_slv(req->rq_repmsg),
1307 lustre_msg_get_limit(req->rq_repmsg));
1311 new_limit = lustre_msg_get_limit(req->rq_repmsg);
1312 new_slv = lustre_msg_get_slv(req->rq_repmsg);
1313 obd = req->rq_import->imp_obd;
1315 /* Set new SLV and limit in OBD fields to make them accessible
1316 * to the pool thread. We do not access obd_namespace and pool
1317 * directly here as there is no reliable way to make sure that
1318 * they are still alive at cleanup time. Evil races are possible
1319 * which may cause Oops at that time. */
1320 write_lock(&obd->obd_pool_lock);
1321 obd->obd_pool_slv = new_slv;
1322 obd->obd_pool_limit = new_limit;
1323 write_unlock(&obd->obd_pool_lock);
1327 EXPORT_SYMBOL(ldlm_cli_update_pool);
1330 * Client side lock cancel.
1332 * Lock must not have any readers or writers by this time.
1334 int ldlm_cli_cancel(struct lustre_handle *lockh,
1335 ldlm_cancel_flags_t cancel_flags)
1337 struct obd_export *exp;
1338 int avail, flags, count = 1;
1340 struct ldlm_namespace *ns;
1341 struct ldlm_lock *lock;
1342 CFS_LIST_HEAD(cancels);
1345 /* concurrent cancels on the same handle can happen */
1346 lock = ldlm_handle2lock_long(lockh, LDLM_FL_CANCELING);
1348 LDLM_DEBUG_NOLOCK("lock is already being destroyed\n");
1352 rc = ldlm_cli_cancel_local(lock);
1353 if (rc == LDLM_FL_LOCAL_ONLY || cancel_flags & LCF_LOCAL) {
1354 LDLM_LOCK_RELEASE(lock);
1357 /* Even if the lock is marked as LDLM_FL_BL_AST, this is a LDLM_CANCEL
1358 * RPC which goes to canceld portal, so we can cancel other LRU locks
1359 * here and send them all as one LDLM_CANCEL RPC. */
1360 LASSERT(cfs_list_empty(&lock->l_bl_ast));
1361 cfs_list_add(&lock->l_bl_ast, &cancels);
1363 exp = lock->l_conn_export;
1364 if (exp_connect_cancelset(exp)) {
1365 avail = ldlm_format_handles_avail(class_exp2cliimp(exp),
1370 ns = ldlm_lock_to_ns(lock);
1371 flags = ns_connect_lru_resize(ns) ?
1372 LDLM_CANCEL_LRUR : LDLM_CANCEL_AGED;
1373 count += ldlm_cancel_lru_local(ns, &cancels, 0, avail - 1,
1376 ldlm_cli_cancel_list(&cancels, count, NULL, cancel_flags);
1379 EXPORT_SYMBOL(ldlm_cli_cancel);
1382 * Locally cancel up to \a count locks in list \a cancels.
1383 * Return the number of cancelled locks.
1385 int ldlm_cli_cancel_list_local(cfs_list_t *cancels, int count,
1386 ldlm_cancel_flags_t flags)
1388 CFS_LIST_HEAD(head);
1389 struct ldlm_lock *lock, *next;
1390 int left = 0, bl_ast = 0;
1394 cfs_list_for_each_entry_safe(lock, next, cancels, l_bl_ast) {
1398 if (flags & LCF_LOCAL) {
1399 rc = LDLM_FL_LOCAL_ONLY;
1400 ldlm_lock_cancel(lock);
1402 rc = ldlm_cli_cancel_local(lock);
1404 /* Until we have compound requests and can send LDLM_CANCEL
1405 * requests batched with generic RPCs, we need to send cancels
1406 * with the LDLM_FL_BL_AST flag in a separate RPC from
1407 * the one being generated now. */
1408 if (!(flags & LCF_BL_AST) && (rc == LDLM_FL_BL_AST)) {
1409 LDLM_DEBUG(lock, "Cancel lock separately");
1410 cfs_list_del_init(&lock->l_bl_ast);
1411 cfs_list_add(&lock->l_bl_ast, &head);
1415 if (rc == LDLM_FL_LOCAL_ONLY) {
1416 /* CANCEL RPC should not be sent to server. */
1417 cfs_list_del_init(&lock->l_bl_ast);
1418 LDLM_LOCK_RELEASE(lock);
1424 ldlm_cli_cancel_list(&head, bl_ast, NULL, 0);
1429 EXPORT_SYMBOL(ldlm_cli_cancel_list_local);
1432 * Cancel as many locks as possible w/o sending any RPCs (e.g. to write back
1433 * dirty data, to close a file, ...) or waiting for any RPCs in-flight (e.g.
1434 * readahead requests, ...)
1436 static ldlm_policy_res_t ldlm_cancel_no_wait_policy(struct ldlm_namespace *ns,
1437 struct ldlm_lock *lock,
1438 int unused, int added,
1441 ldlm_policy_res_t result = LDLM_POLICY_CANCEL_LOCK;
1442 ldlm_cancel_for_recovery cb = ns->ns_cancel_for_recovery;
1443 lock_res_and_lock(lock);
1445 /* don't check added & count since we want to process all locks
1446 * from unused list */
1447 switch (lock->l_resource->lr_type) {
1453 result = LDLM_POLICY_SKIP_LOCK;
1454 lock->l_flags |= LDLM_FL_SKIPPED;
1458 unlock_res_and_lock(lock);
1463 * Callback function for LRU-resize policy. Decides whether to keep
1464 * \a lock in LRU for current \a LRU size \a unused, added in current
1465 * scan \a added and number of locks to be preferably canceled \a count.
1467 * \retval LDLM_POLICY_KEEP_LOCK keep lock in LRU in stop scanning
1469 * \retval LDLM_POLICY_CANCEL_LOCK cancel lock from LRU
1471 static ldlm_policy_res_t ldlm_cancel_lrur_policy(struct ldlm_namespace *ns,
1472 struct ldlm_lock *lock,
1473 int unused, int added,
1476 cfs_time_t cur = cfs_time_current();
1477 struct ldlm_pool *pl = &ns->ns_pool;
1481 /* Stop LRU processing when we reach past @count or have checked all
1483 if (count && added >= count)
1484 return LDLM_POLICY_KEEP_LOCK;
1486 slv = ldlm_pool_get_slv(pl);
1487 lvf = ldlm_pool_get_lvf(pl);
1488 la = cfs_duration_sec(cfs_time_sub(cur,
1489 lock->l_last_used));
1490 lv = lvf * la * unused;
1492 /* Inform pool about current CLV to see it via proc. */
1493 ldlm_pool_set_clv(pl, lv);
1495 /* Stop when SLV is not yet come from server or lv is smaller than
1497 return (slv == 0 || lv < slv) ?
1498 LDLM_POLICY_KEEP_LOCK : LDLM_POLICY_CANCEL_LOCK;
1502 * Callback function for proc used policy. Makes decision whether to keep
1503 * \a lock in LRU for current \a LRU size \a unused, added in current scan \a
1504 * added and number of locks to be preferably canceled \a count.
1506 * \retval LDLM_POLICY_KEEP_LOCK keep lock in LRU in stop scanning
1508 * \retval LDLM_POLICY_CANCEL_LOCK cancel lock from LRU
1510 static ldlm_policy_res_t ldlm_cancel_passed_policy(struct ldlm_namespace *ns,
1511 struct ldlm_lock *lock,
1512 int unused, int added,
1515 /* Stop LRU processing when we reach past @count or have checked all
1517 return (added >= count) ?
1518 LDLM_POLICY_KEEP_LOCK : LDLM_POLICY_CANCEL_LOCK;
1522 * Callback function for aged policy. Makes decision whether to keep \a lock in
1523 * LRU for current LRU size \a unused, added in current scan \a added and
1524 * number of locks to be preferably canceled \a count.
1526 * \retval LDLM_POLICY_KEEP_LOCK keep lock in LRU in stop scanning
1528 * \retval LDLM_POLICY_CANCEL_LOCK cancel lock from LRU
1530 static ldlm_policy_res_t ldlm_cancel_aged_policy(struct ldlm_namespace *ns,
1531 struct ldlm_lock *lock,
1532 int unused, int added,
1535 /* Stop LRU processing if young lock is found and we reach past count */
1536 return ((added >= count) &&
1537 cfs_time_before(cfs_time_current(),
1538 cfs_time_add(lock->l_last_used,
1540 LDLM_POLICY_KEEP_LOCK : LDLM_POLICY_CANCEL_LOCK;
1544 * Callback function for default policy. Makes decision whether to keep \a lock
1545 * in LRU for current LRU size \a unused, added in current scan \a added and
1546 * number of locks to be preferably canceled \a count.
1548 * \retval LDLM_POLICY_KEEP_LOCK keep lock in LRU in stop scanning
1550 * \retval LDLM_POLICY_CANCEL_LOCK cancel lock from LRU
1552 static ldlm_policy_res_t ldlm_cancel_default_policy(struct ldlm_namespace *ns,
1553 struct ldlm_lock *lock,
1554 int unused, int added,
1557 /* Stop LRU processing when we reach past count or have checked all
1559 return (added >= count) ?
1560 LDLM_POLICY_KEEP_LOCK : LDLM_POLICY_CANCEL_LOCK;
1563 typedef ldlm_policy_res_t (*ldlm_cancel_lru_policy_t)(struct ldlm_namespace *,
1564 struct ldlm_lock *, int,
1567 static ldlm_cancel_lru_policy_t
1568 ldlm_cancel_lru_policy(struct ldlm_namespace *ns, int flags)
1570 if (flags & LDLM_CANCEL_NO_WAIT)
1571 return ldlm_cancel_no_wait_policy;
1573 if (ns_connect_lru_resize(ns)) {
1574 if (flags & LDLM_CANCEL_SHRINK)
1575 /* We kill passed number of old locks. */
1576 return ldlm_cancel_passed_policy;
1577 else if (flags & LDLM_CANCEL_LRUR)
1578 return ldlm_cancel_lrur_policy;
1579 else if (flags & LDLM_CANCEL_PASSED)
1580 return ldlm_cancel_passed_policy;
1582 if (flags & LDLM_CANCEL_AGED)
1583 return ldlm_cancel_aged_policy;
1586 return ldlm_cancel_default_policy;
1590 * - Free space in LRU for \a count new locks,
1591 * redundant unused locks are canceled locally;
1592 * - also cancel locally unused aged locks;
1593 * - do not cancel more than \a max locks;
1594 * - GET the found locks and add them into the \a cancels list.
1596 * A client lock can be added to the l_bl_ast list only when it is
1597 * marked LDLM_FL_CANCELING. Otherwise, somebody is already doing
1598 * CANCEL. There are the following use cases:
1599 * ldlm_cancel_resource_local(), ldlm_cancel_lru_local() and
1600 * ldlm_cli_cancel(), which check and set this flag properly. As any
1601 * attempt to cancel a lock rely on this flag, l_bl_ast list is accessed
1602 * later without any special locking.
1604 * Calling policies for enabled LRU resize:
1605 * ----------------------------------------
1606 * flags & LDLM_CANCEL_LRUR - use LRU resize policy (SLV from server) to
1607 * cancel not more than \a count locks;
1609 * flags & LDLM_CANCEL_PASSED - cancel \a count number of old locks (located at
1610 * the beginning of LRU list);
1612 * flags & LDLM_CANCEL_SHRINK - cancel not more than \a count locks according to
1613 * memory pressre policy function;
1615 * flags & LDLM_CANCEL_AGED - cancel \a count locks according to "aged policy".
1617 * flags & LDLM_CANCEL_NO_WAIT - cancel as many unused locks as possible
1618 * (typically before replaying locks) w/o
1619 * sending any RPCs or waiting for any
1620 * outstanding RPC to complete.
1622 static int ldlm_prepare_lru_list(struct ldlm_namespace *ns, cfs_list_t *cancels,
1623 int count, int max, int flags)
1625 ldlm_cancel_lru_policy_t pf;
1626 struct ldlm_lock *lock, *next;
1627 int added = 0, unused, remained;
1630 spin_lock(&ns->ns_lock);
1631 unused = ns->ns_nr_unused;
1634 if (!ns_connect_lru_resize(ns))
1635 count += unused - ns->ns_max_unused;
1637 pf = ldlm_cancel_lru_policy(ns, flags);
1638 LASSERT(pf != NULL);
1640 while (!cfs_list_empty(&ns->ns_unused_list)) {
1641 ldlm_policy_res_t result;
1643 /* all unused locks */
1644 if (remained-- <= 0)
1647 /* For any flags, stop scanning if @max is reached. */
1648 if (max && added >= max)
1651 cfs_list_for_each_entry_safe(lock, next, &ns->ns_unused_list,
1653 /* No locks which got blocking requests. */
1654 LASSERT(!(lock->l_flags & LDLM_FL_BL_AST));
1656 if (flags & LDLM_CANCEL_NO_WAIT &&
1657 lock->l_flags & LDLM_FL_SKIPPED)
1658 /* already processed */
1661 /* Somebody is already doing CANCEL. No need for this
1662 * lock in LRU, do not traverse it again. */
1663 if (!(lock->l_flags & LDLM_FL_CANCELING))
1666 ldlm_lock_remove_from_lru_nolock(lock);
1668 if (&lock->l_lru == &ns->ns_unused_list)
1671 LDLM_LOCK_GET(lock);
1672 spin_unlock(&ns->ns_lock);
1673 lu_ref_add(&lock->l_reference, __FUNCTION__, cfs_current());
1675 /* Pass the lock through the policy filter and see if it
1676 * should stay in LRU.
1678 * Even for shrinker policy we stop scanning if
1679 * we find a lock that should stay in the cache.
1680 * We should take into account lock age anyway
1681 * as a new lock is a valuable resource even if
1682 * it has a low weight.
1684 * That is, for shrinker policy we drop only
1685 * old locks, but additionally choose them by
1686 * their weight. Big extent locks will stay in
1688 result = pf(ns, lock, unused, added, count);
1689 if (result == LDLM_POLICY_KEEP_LOCK) {
1690 lu_ref_del(&lock->l_reference,
1691 __FUNCTION__, cfs_current());
1692 LDLM_LOCK_RELEASE(lock);
1693 spin_lock(&ns->ns_lock);
1696 if (result == LDLM_POLICY_SKIP_LOCK) {
1697 lu_ref_del(&lock->l_reference,
1698 __func__, cfs_current());
1699 LDLM_LOCK_RELEASE(lock);
1700 spin_lock(&ns->ns_lock);
1704 lock_res_and_lock(lock);
1705 /* Check flags again under the lock. */
1706 if ((lock->l_flags & LDLM_FL_CANCELING) ||
1707 (ldlm_lock_remove_from_lru(lock) == 0)) {
1708 /* Another thread is removing lock from LRU, or
1709 * somebody is already doing CANCEL, or there
1710 * is a blocking request which will send cancel
1711 * by itself, or the lock is no longer unused. */
1712 unlock_res_and_lock(lock);
1713 lu_ref_del(&lock->l_reference,
1714 __FUNCTION__, cfs_current());
1715 LDLM_LOCK_RELEASE(lock);
1716 spin_lock(&ns->ns_lock);
1719 LASSERT(!lock->l_readers && !lock->l_writers);
1721 /* If we have chosen to cancel this lock voluntarily, we
1722 * better send cancel notification to server, so that it
1723 * frees appropriate state. This might lead to a race
1724 * where while we are doing cancel here, server is also
1725 * silently cancelling this lock. */
1726 lock->l_flags &= ~LDLM_FL_CANCEL_ON_BLOCK;
1728 /* Setting the CBPENDING flag is a little misleading,
1729 * but prevents an important race; namely, once
1730 * CBPENDING is set, the lock can accumulate no more
1731 * readers/writers. Since readers and writers are
1732 * already zero here, ldlm_lock_decref() won't see
1733 * this flag and call l_blocking_ast */
1734 lock->l_flags |= LDLM_FL_CBPENDING | LDLM_FL_CANCELING;
1736 /* We can't re-add to l_lru as it confuses the
1737 * refcounting in ldlm_lock_remove_from_lru() if an AST
1738 * arrives after we drop lr_lock below. We use l_bl_ast
1739 * and can't use l_pending_chain as it is used both on
1740 * server and client nevertheless bug 5666 says it is
1741 * used only on server */
1742 LASSERT(cfs_list_empty(&lock->l_bl_ast));
1743 cfs_list_add(&lock->l_bl_ast, cancels);
1744 unlock_res_and_lock(lock);
1745 lu_ref_del(&lock->l_reference, __FUNCTION__, cfs_current());
1746 spin_lock(&ns->ns_lock);
1750 spin_unlock(&ns->ns_lock);
1754 int ldlm_cancel_lru_local(struct ldlm_namespace *ns, cfs_list_t *cancels,
1755 int count, int max, ldlm_cancel_flags_t cancel_flags,
1759 added = ldlm_prepare_lru_list(ns, cancels, count, max, flags);
1762 return ldlm_cli_cancel_list_local(cancels, added, cancel_flags);
1766 * Cancel at least \a nr locks from given namespace LRU.
1768 * When called with LCF_ASYNC the blocking callback will be handled
1769 * in a thread and this function will return after the thread has been
1770 * asked to call the callback. When called with LCF_ASYNC the blocking
1771 * callback will be performed in this function.
1773 int ldlm_cancel_lru(struct ldlm_namespace *ns, int nr,
1774 ldlm_cancel_flags_t cancel_flags,
1777 CFS_LIST_HEAD(cancels);
1782 cancel_flags &= ~LCF_ASYNC; /* force to be sync in user space */
1784 /* Just prepare the list of locks, do not actually cancel them yet.
1785 * Locks are cancelled later in a separate thread. */
1786 count = ldlm_prepare_lru_list(ns, &cancels, nr, 0, flags);
1787 rc = ldlm_bl_to_thread_list(ns, NULL, &cancels, count, cancel_flags);
1795 * Find and cancel locally unused locks found on resource, matched to the
1796 * given policy, mode. GET the found locks and add them into the \a cancels
1799 int ldlm_cancel_resource_local(struct ldlm_resource *res,
1800 cfs_list_t *cancels,
1801 ldlm_policy_data_t *policy,
1802 ldlm_mode_t mode, int lock_flags,
1803 ldlm_cancel_flags_t cancel_flags, void *opaque)
1805 struct ldlm_lock *lock;
1810 cfs_list_for_each_entry(lock, &res->lr_granted, l_res_link) {
1811 if (opaque != NULL && lock->l_ast_data != opaque) {
1812 LDLM_ERROR(lock, "data %p doesn't match opaque %p",
1813 lock->l_ast_data, opaque);
1818 if (lock->l_readers || lock->l_writers)
1821 /* If somebody is already doing CANCEL, or blocking AST came,
1822 * skip this lock. */
1823 if (lock->l_flags & LDLM_FL_BL_AST ||
1824 lock->l_flags & LDLM_FL_CANCELING)
1827 if (lockmode_compat(lock->l_granted_mode, mode))
1830 /* If policy is given and this is IBITS lock, add to list only
1831 * those locks that match by policy. */
1832 if (policy && (lock->l_resource->lr_type == LDLM_IBITS) &&
1833 !(lock->l_policy_data.l_inodebits.bits &
1834 policy->l_inodebits.bits))
1837 /* See CBPENDING comment in ldlm_cancel_lru */
1838 lock->l_flags |= LDLM_FL_CBPENDING | LDLM_FL_CANCELING |
1841 LASSERT(cfs_list_empty(&lock->l_bl_ast));
1842 cfs_list_add(&lock->l_bl_ast, cancels);
1843 LDLM_LOCK_GET(lock);
1848 RETURN(ldlm_cli_cancel_list_local(cancels, count, cancel_flags));
1850 EXPORT_SYMBOL(ldlm_cancel_resource_local);
1853 * Cancel client-side locks from a list and send/prepare cancel RPCs to the
1855 * If \a req is NULL, send CANCEL request to server with handles of locks
1856 * in the \a cancels. If EARLY_CANCEL is not supported, send CANCEL requests
1857 * separately per lock.
1858 * If \a req is not NULL, put handles of locks in \a cancels into the request
1859 * buffer at the offset \a off.
1860 * Destroy \a cancels at the end.
1862 int ldlm_cli_cancel_list(cfs_list_t *cancels, int count,
1863 struct ptlrpc_request *req, ldlm_cancel_flags_t flags)
1865 struct ldlm_lock *lock;
1869 if (cfs_list_empty(cancels) || count == 0)
1872 /* XXX: requests (both batched and not) could be sent in parallel.
1873 * Usually it is enough to have just 1 RPC, but it is possible that
1874 * there are too many locks to be cancelled in LRU or on a resource.
1875 * It would also speed up the case when the server does not support
1878 LASSERT(!cfs_list_empty(cancels));
1879 lock = cfs_list_entry(cancels->next, struct ldlm_lock,
1881 LASSERT(lock->l_conn_export);
1883 if (exp_connect_cancelset(lock->l_conn_export)) {
1886 ldlm_cancel_pack(req, cancels, count);
1888 res = ldlm_cli_cancel_req(lock->l_conn_export,
1892 res = ldlm_cli_cancel_req(lock->l_conn_export,
1897 CDEBUG_LIMIT(res == -ESHUTDOWN ? D_DLMTRACE : D_ERROR,
1898 "ldlm_cli_cancel_list: %d\n", res);
1903 ldlm_lock_list_put(cancels, l_bl_ast, res);
1905 LASSERT(count == 0);
1908 EXPORT_SYMBOL(ldlm_cli_cancel_list);
1911 * Cancel all locks on a resource that have 0 readers/writers.
1913 * If flags & LDLM_FL_LOCAL_ONLY, throw the locks away without trying
1914 * to notify the server. */
1915 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
1916 const struct ldlm_res_id *res_id,
1917 ldlm_policy_data_t *policy,
1919 ldlm_cancel_flags_t flags,
1922 struct ldlm_resource *res;
1923 CFS_LIST_HEAD(cancels);
1928 res = ldlm_resource_get(ns, NULL, res_id, 0, 0);
1930 /* This is not a problem. */
1931 CDEBUG(D_INFO, "No resource "LPU64"\n", res_id->name[0]);
1935 LDLM_RESOURCE_ADDREF(res);
1936 count = ldlm_cancel_resource_local(res, &cancels, policy, mode,
1937 0, flags | LCF_BL_AST, opaque);
1938 rc = ldlm_cli_cancel_list(&cancels, count, NULL, flags);
1940 CERROR("canceling unused lock "DLDLMRES": rc = %d\n",
1943 LDLM_RESOURCE_DELREF(res);
1944 ldlm_resource_putref(res);
1947 EXPORT_SYMBOL(ldlm_cli_cancel_unused_resource);
1949 struct ldlm_cli_cancel_arg {
1954 static int ldlm_cli_hash_cancel_unused(cfs_hash_t *hs, cfs_hash_bd_t *bd,
1955 cfs_hlist_node_t *hnode, void *arg)
1957 struct ldlm_resource *res = cfs_hash_object(hs, hnode);
1958 struct ldlm_cli_cancel_arg *lc = arg;
1960 ldlm_cli_cancel_unused_resource(ldlm_res_to_ns(res), &res->lr_name,
1961 NULL, LCK_MINMODE, lc->lc_flags,
1963 /* must return 0 for hash iteration */
1968 * Cancel all locks on a namespace (or a specific resource, if given)
1969 * that have 0 readers/writers.
1971 * If flags & LCF_LOCAL, throw the locks away without trying
1972 * to notify the server. */
1973 int ldlm_cli_cancel_unused(struct ldlm_namespace *ns,
1974 const struct ldlm_res_id *res_id,
1975 ldlm_cancel_flags_t flags, void *opaque)
1977 struct ldlm_cli_cancel_arg arg = {
1979 .lc_opaque = opaque,
1987 if (res_id != NULL) {
1988 RETURN(ldlm_cli_cancel_unused_resource(ns, res_id, NULL,
1992 cfs_hash_for_each_nolock(ns->ns_rs_hash,
1993 ldlm_cli_hash_cancel_unused, &arg);
1997 EXPORT_SYMBOL(ldlm_cli_cancel_unused);
1999 /* Lock iterators. */
2001 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
2004 cfs_list_t *tmp, *next;
2005 struct ldlm_lock *lock;
2006 int rc = LDLM_ITER_CONTINUE;
2011 RETURN(LDLM_ITER_CONTINUE);
2014 cfs_list_for_each_safe(tmp, next, &res->lr_granted) {
2015 lock = cfs_list_entry(tmp, struct ldlm_lock, l_res_link);
2017 if (iter(lock, closure) == LDLM_ITER_STOP)
2018 GOTO(out, rc = LDLM_ITER_STOP);
2021 cfs_list_for_each_safe(tmp, next, &res->lr_converting) {
2022 lock = cfs_list_entry(tmp, struct ldlm_lock, l_res_link);
2024 if (iter(lock, closure) == LDLM_ITER_STOP)
2025 GOTO(out, rc = LDLM_ITER_STOP);
2028 cfs_list_for_each_safe(tmp, next, &res->lr_waiting) {
2029 lock = cfs_list_entry(tmp, struct ldlm_lock, l_res_link);
2031 if (iter(lock, closure) == LDLM_ITER_STOP)
2032 GOTO(out, rc = LDLM_ITER_STOP);
2038 EXPORT_SYMBOL(ldlm_resource_foreach);
2040 struct iter_helper_data {
2041 ldlm_iterator_t iter;
2045 static int ldlm_iter_helper(struct ldlm_lock *lock, void *closure)
2047 struct iter_helper_data *helper = closure;
2048 return helper->iter(lock, helper->closure);
2051 static int ldlm_res_iter_helper(cfs_hash_t *hs, cfs_hash_bd_t *bd,
2052 cfs_hlist_node_t *hnode, void *arg)
2055 struct ldlm_resource *res = cfs_hash_object(hs, hnode);
2057 return ldlm_resource_foreach(res, ldlm_iter_helper, arg) ==
2061 void ldlm_namespace_foreach(struct ldlm_namespace *ns,
2062 ldlm_iterator_t iter, void *closure)
2065 struct iter_helper_data helper = { iter: iter, closure: closure };
2067 cfs_hash_for_each_nolock(ns->ns_rs_hash,
2068 ldlm_res_iter_helper, &helper);
2071 EXPORT_SYMBOL(ldlm_namespace_foreach);
2073 /* non-blocking function to manipulate a lock whose cb_data is being put away.
2074 * return 0: find no resource
2075 * > 0: must be LDLM_ITER_STOP/LDLM_ITER_CONTINUE.
2078 int ldlm_resource_iterate(struct ldlm_namespace *ns,
2079 const struct ldlm_res_id *res_id,
2080 ldlm_iterator_t iter, void *data)
2082 struct ldlm_resource *res;
2087 CERROR("must pass in namespace\n");
2091 res = ldlm_resource_get(ns, NULL, res_id, 0, 0);
2095 LDLM_RESOURCE_ADDREF(res);
2096 rc = ldlm_resource_foreach(res, iter, data);
2097 LDLM_RESOURCE_DELREF(res);
2098 ldlm_resource_putref(res);
2101 EXPORT_SYMBOL(ldlm_resource_iterate);
2105 static int ldlm_chain_lock_for_replay(struct ldlm_lock *lock, void *closure)
2107 cfs_list_t *list = closure;
2109 /* we use l_pending_chain here, because it's unused on clients. */
2110 LASSERTF(cfs_list_empty(&lock->l_pending_chain),
2111 "lock %p next %p prev %p\n",
2112 lock, &lock->l_pending_chain.next,&lock->l_pending_chain.prev);
2113 /* bug 9573: don't replay locks left after eviction, or
2114 * bug 17614: locks being actively cancelled. Get a reference
2115 * on a lock so that it does not disapear under us (e.g. due to cancel)
2117 if (!(lock->l_flags & (LDLM_FL_FAILED|LDLM_FL_CANCELING))) {
2118 cfs_list_add(&lock->l_pending_chain, list);
2119 LDLM_LOCK_GET(lock);
2122 return LDLM_ITER_CONTINUE;
2125 static int replay_lock_interpret(const struct lu_env *env,
2126 struct ptlrpc_request *req,
2127 struct ldlm_async_args *aa, int rc)
2129 struct ldlm_lock *lock;
2130 struct ldlm_reply *reply;
2131 struct obd_export *exp;
2134 cfs_atomic_dec(&req->rq_import->imp_replay_inflight);
2139 reply = req_capsule_server_get(&req->rq_pill, &RMF_DLM_REP);
2141 GOTO(out, rc = -EPROTO);
2143 lock = ldlm_handle2lock(&aa->lock_handle);
2145 CERROR("received replay ack for unknown local cookie "LPX64
2146 " remote cookie "LPX64 " from server %s id %s\n",
2147 aa->lock_handle.cookie, reply->lock_handle.cookie,
2148 req->rq_export->exp_client_uuid.uuid,
2149 libcfs_id2str(req->rq_peer));
2150 GOTO(out, rc = -ESTALE);
2153 /* Key change rehash lock in per-export hash with new key */
2154 exp = req->rq_export;
2155 if (exp && exp->exp_lock_hash) {
2156 /* In the function below, .hs_keycmp resolves to
2157 * ldlm_export_lock_keycmp() */
2158 /* coverity[overrun-buffer-val] */
2159 cfs_hash_rehash_key(exp->exp_lock_hash,
2160 &lock->l_remote_handle,
2161 &reply->lock_handle,
2164 lock->l_remote_handle = reply->lock_handle;
2167 LDLM_DEBUG(lock, "replayed lock:");
2168 ptlrpc_import_recovery_state_machine(req->rq_import);
2169 LDLM_LOCK_PUT(lock);
2172 ptlrpc_connect_import(req->rq_import);
2177 static int replay_one_lock(struct obd_import *imp, struct ldlm_lock *lock)
2179 struct ptlrpc_request *req;
2180 struct ldlm_async_args *aa;
2181 struct ldlm_request *body;
2186 /* Bug 11974: Do not replay a lock which is actively being canceled */
2187 if (lock->l_flags & LDLM_FL_CANCELING) {
2188 LDLM_DEBUG(lock, "Not replaying canceled lock:");
2192 /* If this is reply-less callback lock, we cannot replay it, since
2193 * server might have long dropped it, but notification of that event was
2194 * lost by network. (and server granted conflicting lock already) */
2195 if (lock->l_flags & LDLM_FL_CANCEL_ON_BLOCK) {
2196 LDLM_DEBUG(lock, "Not replaying reply-less lock:");
2197 ldlm_lock_cancel(lock);
2202 * If granted mode matches the requested mode, this lock is granted.
2204 * If they differ, but we have a granted mode, then we were granted
2205 * one mode and now want another: ergo, converting.
2207 * If we haven't been granted anything and are on a resource list,
2208 * then we're blocked/waiting.
2210 * If we haven't been granted anything and we're NOT on a resource list,
2211 * then we haven't got a reply yet and don't have a known disposition.
2212 * This happens whenever a lock enqueue is the request that triggers
2215 if (lock->l_granted_mode == lock->l_req_mode)
2216 flags = LDLM_FL_REPLAY | LDLM_FL_BLOCK_GRANTED;
2217 else if (lock->l_granted_mode)
2218 flags = LDLM_FL_REPLAY | LDLM_FL_BLOCK_CONV;
2219 else if (!cfs_list_empty(&lock->l_res_link))
2220 flags = LDLM_FL_REPLAY | LDLM_FL_BLOCK_WAIT;
2222 flags = LDLM_FL_REPLAY;
2224 req = ptlrpc_request_alloc_pack(imp, &RQF_LDLM_ENQUEUE,
2225 LUSTRE_DLM_VERSION, LDLM_ENQUEUE);
2229 /* We're part of recovery, so don't wait for it. */
2230 req->rq_send_state = LUSTRE_IMP_REPLAY_LOCKS;
2232 body = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
2233 ldlm_lock2desc(lock, &body->lock_desc);
2234 body->lock_flags = ldlm_flags_to_wire(flags);
2236 ldlm_lock2handle(lock, &body->lock_handle[0]);
2237 if (lock->l_lvb_len > 0)
2238 req_capsule_extend(&req->rq_pill, &RQF_LDLM_ENQUEUE_LVB);
2239 req_capsule_set_size(&req->rq_pill, &RMF_DLM_LVB, RCL_SERVER,
2241 ptlrpc_request_set_replen(req);
2242 /* notify the server we've replayed all requests.
2243 * also, we mark the request to be put on a dedicated
2244 * queue to be processed after all request replayes.
2246 lustre_msg_set_flags(req->rq_reqmsg, MSG_REQ_REPLAY_DONE);
2248 LDLM_DEBUG(lock, "replaying lock:");
2250 cfs_atomic_inc(&req->rq_import->imp_replay_inflight);
2251 CLASSERT(sizeof(*aa) <= sizeof(req->rq_async_args));
2252 aa = ptlrpc_req_async_args(req);
2253 aa->lock_handle = body->lock_handle[0];
2254 req->rq_interpret_reply = (ptlrpc_interpterer_t)replay_lock_interpret;
2255 ptlrpcd_add_req(req, PDL_POLICY_LOCAL, -1);
2261 * Cancel as many unused locks as possible before replay. since we are
2262 * in recovery, we can't wait for any outstanding RPCs to send any RPC
2265 * Called only in recovery before replaying locks. there is no need to
2266 * replay locks that are unused. since the clients may hold thousands of
2267 * cached unused locks, dropping the unused locks can greatly reduce the
2268 * load on the servers at recovery time.
2270 static void ldlm_cancel_unused_locks_for_replay(struct ldlm_namespace *ns)
2273 CFS_LIST_HEAD(cancels);
2275 CDEBUG(D_DLMTRACE, "Dropping as many unused locks as possible before"
2276 "replay for namespace %s (%d)\n",
2277 ldlm_ns_name(ns), ns->ns_nr_unused);
2279 /* We don't need to care whether or not LRU resize is enabled
2280 * because the LDLM_CANCEL_NO_WAIT policy doesn't use the
2281 * count parameter */
2282 canceled = ldlm_cancel_lru_local(ns, &cancels, ns->ns_nr_unused, 0,
2283 LCF_LOCAL, LDLM_CANCEL_NO_WAIT);
2285 CDEBUG(D_DLMTRACE, "Canceled %d unused locks from namespace %s\n",
2286 canceled, ldlm_ns_name(ns));
2289 int ldlm_replay_locks(struct obd_import *imp)
2291 struct ldlm_namespace *ns = imp->imp_obd->obd_namespace;
2292 CFS_LIST_HEAD(list);
2293 struct ldlm_lock *lock, *next;
2298 LASSERT(cfs_atomic_read(&imp->imp_replay_inflight) == 0);
2300 /* don't replay locks if import failed recovery */
2301 if (imp->imp_vbr_failed)
2304 /* ensure this doesn't fall to 0 before all have been queued */
2305 cfs_atomic_inc(&imp->imp_replay_inflight);
2307 if (ldlm_cancel_unused_locks_before_replay)
2308 ldlm_cancel_unused_locks_for_replay(ns);
2310 ldlm_namespace_foreach(ns, ldlm_chain_lock_for_replay, &list);
2312 cfs_list_for_each_entry_safe(lock, next, &list, l_pending_chain) {
2313 cfs_list_del_init(&lock->l_pending_chain);
2315 LDLM_LOCK_RELEASE(lock);
2316 continue; /* or try to do the rest? */
2318 rc = replay_one_lock(imp, lock);
2319 LDLM_LOCK_RELEASE(lock);
2322 cfs_atomic_dec(&imp->imp_replay_inflight);
2326 EXPORT_SYMBOL(ldlm_replay_locks);