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, 2011, Whamcloud, Inc.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
37 #define DEBUG_SUBSYSTEM S_LDLM
40 #include <liblustre.h>
43 #include <lustre_dlm.h>
44 #include <obd_class.h>
47 #include "ldlm_internal.h"
49 int ldlm_enqueue_min = OBD_TIMEOUT_DEFAULT;
50 CFS_MODULE_PARM(ldlm_enqueue_min, "i", int, 0644,
51 "lock enqueue timeout minimum");
53 /* in client side, whether the cached locks will be canceled before replay */
54 unsigned int ldlm_cancel_unused_locks_before_replay = 1;
56 static void interrupted_completion_wait(void *data)
60 struct lock_wait_data {
61 struct ldlm_lock *lwd_lock;
65 struct ldlm_async_args {
66 struct lustre_handle lock_handle;
69 int ldlm_expired_completion_wait(void *data)
71 struct lock_wait_data *lwd = data;
72 struct ldlm_lock *lock = lwd->lwd_lock;
73 struct obd_import *imp;
74 struct obd_device *obd;
77 if (lock->l_conn_export == NULL) {
78 static cfs_time_t next_dump = 0, last_dump = 0;
80 if (ptlrpc_check_suspend())
83 LDLM_ERROR(lock, "lock timed out (enqueued at "CFS_TIME_T", "
84 CFS_DURATION_T"s ago); not entering recovery in "
85 "server code, just going back to sleep",
86 lock->l_last_activity,
87 cfs_time_sub(cfs_time_current_sec(),
88 lock->l_last_activity));
89 if (cfs_time_after(cfs_time_current(), next_dump)) {
90 last_dump = next_dump;
91 next_dump = cfs_time_shift(300);
92 ldlm_namespace_dump(D_DLMTRACE,
93 ldlm_lock_to_ns(lock));
95 libcfs_debug_dumplog();
100 obd = lock->l_conn_export->exp_obd;
101 imp = obd->u.cli.cl_import;
102 ptlrpc_fail_import(imp, lwd->lwd_conn_cnt);
103 LDLM_ERROR(lock, "lock timed out (enqueued at "CFS_TIME_T", "
104 CFS_DURATION_T"s ago), entering recovery for %s@%s",
105 lock->l_last_activity,
106 cfs_time_sub(cfs_time_current_sec(), lock->l_last_activity),
107 obd2cli_tgt(obd), imp->imp_connection->c_remote_uuid.uuid);
112 /* We use the same basis for both server side and client side functions
113 from a single node. */
114 int ldlm_get_enq_timeout(struct ldlm_lock *lock)
116 int timeout = at_get(ldlm_lock_to_ns_at(lock));
118 return obd_timeout / 2;
119 /* Since these are non-updating timeouts, we should be conservative.
120 It would be nice to have some kind of "early reply" mechanism for
121 lock callbacks too... */
122 timeout = min_t(int, at_max, timeout + (timeout >> 1)); /* 150% */
123 return max(timeout, ldlm_enqueue_min);
125 EXPORT_SYMBOL(ldlm_get_enq_timeout);
128 * Helper function for ldlm_completion_ast(), updating timings when lock is
131 static int ldlm_completion_tail(struct ldlm_lock *lock)
136 if (lock->l_destroyed || lock->l_flags & LDLM_FL_FAILED) {
137 LDLM_DEBUG(lock, "client-side enqueue: destroyed");
140 delay = cfs_time_sub(cfs_time_current_sec(),
141 lock->l_last_activity);
142 LDLM_DEBUG(lock, "client-side enqueue: granted after "
143 CFS_DURATION_T"s", delay);
145 /* Update our time estimate */
146 at_measured(ldlm_lock_to_ns_at(lock),
154 * Implementation of ->l_completion_ast() for a client, that doesn't wait
155 * until lock is granted. Suitable for locks enqueued through ptlrpcd, of
156 * other threads that cannot block for long.
158 int ldlm_completion_ast_async(struct ldlm_lock *lock, int flags, void *data)
162 if (flags == LDLM_FL_WAIT_NOREPROC) {
163 LDLM_DEBUG(lock, "client-side enqueue waiting on pending lock");
167 if (!(flags & (LDLM_FL_BLOCK_WAIT | LDLM_FL_BLOCK_GRANTED |
168 LDLM_FL_BLOCK_CONV))) {
169 cfs_waitq_signal(&lock->l_waitq);
170 RETURN(ldlm_completion_tail(lock));
173 LDLM_DEBUG(lock, "client-side enqueue returned a blocked lock, "
175 ldlm_reprocess_all(lock->l_resource);
180 * Client side LDLM "completion" AST. This is called in several cases:
182 * - when a reply to an ENQUEUE rpc is received from the server
183 * (ldlm_cli_enqueue_fini()). Lock might be granted or not granted at
184 * this point (determined by flags);
186 * - when LDLM_CP_CALLBACK rpc comes to client to notify it that lock has
189 * - when ldlm_lock_match(LDLM_FL_LVB_READY) is about to wait until lock
192 * - to force all locks when resource is destroyed (cleanup_resource());
194 * - during lock conversion (not used currently).
196 * If lock is not granted in the first case, this function waits until second
197 * or penultimate cases happen in some other thread.
200 int ldlm_completion_ast(struct ldlm_lock *lock, int flags, void *data)
202 /* XXX ALLOCATE - 160 bytes */
203 struct lock_wait_data lwd;
204 struct obd_device *obd;
205 struct obd_import *imp = NULL;
206 struct l_wait_info lwi;
211 if (flags == LDLM_FL_WAIT_NOREPROC) {
212 LDLM_DEBUG(lock, "client-side enqueue waiting on pending lock");
216 if (!(flags & (LDLM_FL_BLOCK_WAIT | LDLM_FL_BLOCK_GRANTED |
217 LDLM_FL_BLOCK_CONV))) {
218 cfs_waitq_signal(&lock->l_waitq);
222 LDLM_DEBUG(lock, "client-side enqueue returned a blocked lock, "
227 obd = class_exp2obd(lock->l_conn_export);
229 /* if this is a local lock, then there is no import */
231 imp = obd->u.cli.cl_import;
234 /* Wait a long time for enqueue - server may have to callback a
235 lock from another client. Server will evict the other client if it
236 doesn't respond reasonably, and then give us the lock. */
237 timeout = ldlm_get_enq_timeout(lock) * 2;
241 if (lock->l_flags & LDLM_FL_NO_TIMEOUT) {
242 LDLM_DEBUG(lock, "waiting indefinitely because of NO_TIMEOUT");
243 lwi = LWI_INTR(interrupted_completion_wait, &lwd);
245 lwi = LWI_TIMEOUT_INTR(cfs_time_seconds(timeout),
246 ldlm_expired_completion_wait,
247 interrupted_completion_wait, &lwd);
251 cfs_spin_lock(&imp->imp_lock);
252 lwd.lwd_conn_cnt = imp->imp_conn_cnt;
253 cfs_spin_unlock(&imp->imp_lock);
256 if (ns_is_client(ldlm_lock_to_ns(lock)) &&
257 OBD_FAIL_CHECK_RESET(OBD_FAIL_LDLM_INTR_CP_AST,
258 OBD_FAIL_LDLM_CP_BL_RACE | OBD_FAIL_ONCE)) {
259 lock->l_flags |= LDLM_FL_FAIL_LOC;
262 /* Go to sleep until the lock is granted or cancelled. */
263 rc = l_wait_event(lock->l_waitq,
264 is_granted_or_cancelled(lock), &lwi);
268 LDLM_DEBUG(lock, "client-side enqueue waking up: failed (%d)",
273 RETURN(ldlm_completion_tail(lock));
277 * A helper to build a blocking ast function
279 * Perform a common operation for blocking asts:
280 * defferred lock cancellation.
282 * \param lock the lock blocking or canceling ast was called on
284 * \see mdt_blocking_ast
285 * \see ldlm_blocking_ast
287 int ldlm_blocking_ast_nocheck(struct ldlm_lock *lock)
292 lock->l_flags |= LDLM_FL_CBPENDING;
293 do_ast = (!lock->l_readers && !lock->l_writers);
294 unlock_res_and_lock(lock);
297 struct lustre_handle lockh;
300 LDLM_DEBUG(lock, "already unused, calling ldlm_cli_cancel");
301 ldlm_lock2handle(lock, &lockh);
302 rc = ldlm_cli_cancel(&lockh);
304 CERROR("ldlm_cli_cancel: %d\n", rc);
306 LDLM_DEBUG(lock, "Lock still has references, will be "
313 * Server blocking AST
315 * ->l_blocking_ast() callback for LDLM locks acquired by server-side
318 * \param lock the lock which blocks a request or cancelling lock
321 * \param flag indicates whether this cancelling or blocking callback
323 * \see ldlm_blocking_ast_nocheck
325 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
326 void *data, int flag)
330 if (flag == LDLM_CB_CANCELING) {
331 /* Don't need to do anything here. */
335 lock_res_and_lock(lock);
336 /* Get this: if ldlm_blocking_ast is racing with intent_policy, such
337 * that ldlm_blocking_ast is called just before intent_policy method
338 * takes the lr_lock, then by the time we get the lock, we might not
339 * be the correct blocking function anymore. So check, and return
341 if (lock->l_blocking_ast != ldlm_blocking_ast) {
342 unlock_res_and_lock(lock);
345 RETURN(ldlm_blocking_ast_nocheck(lock));
349 * ->l_glimpse_ast() for DLM extent locks acquired on the server-side. See
350 * comment in filter_intent_policy() on why you may need this.
352 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp)
355 * Returning -ELDLM_NO_LOCK_DATA actually works, but the reason for
356 * that is rather subtle: with OST-side locking, it may so happen that
357 * _all_ extent locks are held by the OST. If client wants to obtain
358 * current file size it calls ll{,u}_glimpse_size(), and (as locks are
359 * on the server), dummy glimpse callback fires and does
360 * nothing. Client still receives correct file size due to the
361 * following fragment in filter_intent_policy():
363 * rc = l->l_glimpse_ast(l, NULL); // this will update the LVB
364 * if (rc != 0 && res->lr_namespace->ns_lvbo &&
365 * res->lr_namespace->ns_lvbo->lvbo_update) {
366 * res->lr_namespace->ns_lvbo->lvbo_update(res, NULL, 0, 1);
369 * that is, after glimpse_ast() fails, filter_lvbo_update() runs, and
370 * returns correct file size to the client.
372 return -ELDLM_NO_LOCK_DATA;
375 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
376 const struct ldlm_res_id *res_id,
377 ldlm_type_t type, ldlm_policy_data_t *policy,
378 ldlm_mode_t mode, int *flags,
379 ldlm_blocking_callback blocking,
380 ldlm_completion_callback completion,
381 ldlm_glimpse_callback glimpse,
382 void *data, __u32 lvb_len,
383 const __u64 *client_cookie,
384 struct lustre_handle *lockh)
386 struct ldlm_lock *lock;
388 const struct ldlm_callback_suite cbs = { .lcs_completion = completion,
389 .lcs_blocking = blocking,
390 .lcs_glimpse = glimpse,
394 LASSERT(!(*flags & LDLM_FL_REPLAY));
395 if (unlikely(ns_is_client(ns))) {
396 CERROR("Trying to enqueue local lock in a shadow namespace\n");
400 lock = ldlm_lock_create(ns, res_id, type, mode, &cbs, data, lvb_len);
402 GOTO(out_nolock, err = -ENOMEM);
404 ldlm_lock2handle(lock, lockh);
406 /* NB: we don't have any lock now (lock_res_and_lock)
407 * because it's a new lock */
408 ldlm_lock_addref_internal_nolock(lock, mode);
409 lock->l_flags |= LDLM_FL_LOCAL;
410 if (*flags & LDLM_FL_ATOMIC_CB)
411 lock->l_flags |= LDLM_FL_ATOMIC_CB;
414 lock->l_policy_data = *policy;
415 if (client_cookie != NULL)
416 lock->l_client_cookie = *client_cookie;
417 if (type == LDLM_EXTENT)
418 lock->l_req_extent = policy->l_extent;
420 err = ldlm_lock_enqueue(ns, &lock, policy, flags);
421 if (unlikely(err != ELDLM_OK))
425 *policy = lock->l_policy_data;
427 if (lock->l_completion_ast)
428 lock->l_completion_ast(lock, *flags, NULL);
430 LDLM_DEBUG(lock, "client-side local enqueue handler, new lock created");
433 LDLM_LOCK_RELEASE(lock);
438 static void failed_lock_cleanup(struct ldlm_namespace *ns,
439 struct ldlm_lock *lock, int mode)
443 /* Set a flag to prevent us from sending a CANCEL (bug 407) */
444 lock_res_and_lock(lock);
445 /* Check that lock is not granted or failed, we might race. */
446 if ((lock->l_req_mode != lock->l_granted_mode) &&
447 !(lock->l_flags & LDLM_FL_FAILED)) {
448 /* Make sure that this lock will not be found by raced
449 * bl_ast and -EINVAL reply is sent to server anyways.
451 lock->l_flags |= LDLM_FL_LOCAL_ONLY | LDLM_FL_FAILED |
452 LDLM_FL_ATOMIC_CB | LDLM_FL_CBPENDING;
455 unlock_res_and_lock(lock);
459 "setting FL_LOCAL_ONLY | LDLM_FL_FAILED | "
460 "LDLM_FL_ATOMIC_CB | LDLM_FL_CBPENDING");
462 LDLM_DEBUG(lock, "lock was granted or failed in race");
464 ldlm_lock_decref_internal(lock, mode);
466 /* XXX - HACK because we shouldn't call ldlm_lock_destroy()
467 * from llite/file.c/ll_file_flock(). */
468 /* This code makes for the fact that we do not have blocking handler on
469 * a client for flock locks. As such this is the place where we must
470 * completely kill failed locks. (interrupted and those that
471 * were waiting to be granted when server evicted us. */
472 if (lock->l_resource->lr_type == LDLM_FLOCK) {
473 lock_res_and_lock(lock);
474 ldlm_resource_unlink_lock(lock);
475 ldlm_lock_destroy_nolock(lock);
476 unlock_res_and_lock(lock);
480 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
481 ldlm_type_t type, __u8 with_policy, ldlm_mode_t mode,
482 int *flags, void *lvb, __u32 lvb_len,
483 struct lustre_handle *lockh,int rc)
485 struct ldlm_namespace *ns = exp->exp_obd->obd_namespace;
486 int is_replay = *flags & LDLM_FL_REPLAY;
487 struct ldlm_lock *lock;
488 struct ldlm_reply *reply;
489 struct ost_lvb *tmplvb;
490 int cleanup_phase = 1;
493 lock = ldlm_handle2lock(lockh);
494 /* ldlm_cli_enqueue is holding a reference on this lock. */
496 LASSERT(type == LDLM_FLOCK);
500 if (rc != ELDLM_OK) {
502 LDLM_DEBUG(lock, "client-side enqueue END (%s)",
503 rc == ELDLM_LOCK_ABORTED ? "ABORTED" : "FAILED");
504 if (rc == ELDLM_LOCK_ABORTED) {
505 /* Before we return, swab the reply */
506 reply = req_capsule_server_get(&req->rq_pill,
512 req_capsule_set_size(&req->rq_pill,
513 &RMF_DLM_LVB, RCL_SERVER,
515 tmplvb = req_capsule_server_get(&req->rq_pill,
518 GOTO(cleanup, rc = -EPROTO);
520 memcpy(lvb, tmplvb, lvb_len);
526 reply = req_capsule_server_get(&req->rq_pill, &RMF_DLM_REP);
528 GOTO(cleanup, rc = -EPROTO);
530 /* lock enqueued on the server */
533 lock_res_and_lock(lock);
534 /* Key change rehash lock in per-export hash with new key */
535 if (exp->exp_lock_hash) {
536 /* In the function below, .hs_keycmp resolves to
537 * ldlm_export_lock_keycmp() */
538 /* coverity[overrun-buffer-val] */
539 cfs_hash_rehash_key(exp->exp_lock_hash,
540 &lock->l_remote_handle,
544 lock->l_remote_handle = reply->lock_handle;
547 *flags = reply->lock_flags;
548 lock->l_flags |= reply->lock_flags & LDLM_INHERIT_FLAGS;
549 /* move NO_TIMEOUT flag to the lock to force ldlm_lock_match()
550 * to wait with no timeout as well */
551 lock->l_flags |= reply->lock_flags & LDLM_FL_NO_TIMEOUT;
552 unlock_res_and_lock(lock);
554 CDEBUG(D_INFO, "local: %p, remote cookie: "LPX64", flags: 0x%x\n",
555 lock, reply->lock_handle.cookie, *flags);
557 /* If enqueue returned a blocked lock but the completion handler has
558 * already run, then it fixed up the resource and we don't need to do it
560 if ((*flags) & LDLM_FL_LOCK_CHANGED) {
561 int newmode = reply->lock_desc.l_req_mode;
563 if (newmode && newmode != lock->l_req_mode) {
564 LDLM_DEBUG(lock, "server returned different mode %s",
565 ldlm_lockname[newmode]);
566 lock->l_req_mode = newmode;
569 if (memcmp(reply->lock_desc.l_resource.lr_name.name,
570 lock->l_resource->lr_name.name,
571 sizeof(struct ldlm_res_id))) {
572 CDEBUG(D_INFO, "remote intent success, locking "
573 "(%ld,%ld,%ld) instead of "
575 (long)reply->lock_desc.l_resource.lr_name.name[0],
576 (long)reply->lock_desc.l_resource.lr_name.name[1],
577 (long)reply->lock_desc.l_resource.lr_name.name[2],
578 (long)lock->l_resource->lr_name.name[0],
579 (long)lock->l_resource->lr_name.name[1],
580 (long)lock->l_resource->lr_name.name[2]);
582 rc = ldlm_lock_change_resource(ns, lock,
583 &reply->lock_desc.l_resource.lr_name);
584 if (rc || lock->l_resource == NULL)
585 GOTO(cleanup, rc = -ENOMEM);
586 LDLM_DEBUG(lock, "client-side enqueue, new resource");
589 if (!(type == LDLM_IBITS && !(exp->exp_connect_flags &
591 /* We assume lock type cannot change on server*/
592 ldlm_convert_policy_to_local(exp,
593 lock->l_resource->lr_type,
594 &reply->lock_desc.l_policy_data,
595 &lock->l_policy_data);
596 if (type != LDLM_PLAIN)
597 LDLM_DEBUG(lock,"client-side enqueue, new policy data");
600 if ((*flags) & LDLM_FL_AST_SENT ||
601 /* Cancel extent locks as soon as possible on a liblustre client,
602 * because it cannot handle asynchronous ASTs robustly (see
604 (LIBLUSTRE_CLIENT && type == LDLM_EXTENT)) {
605 lock_res_and_lock(lock);
606 lock->l_flags |= LDLM_FL_CBPENDING | LDLM_FL_BL_AST;
607 unlock_res_and_lock(lock);
608 LDLM_DEBUG(lock, "enqueue reply includes blocking AST");
611 /* If the lock has already been granted by a completion AST, don't
612 * clobber the LVB with an older one. */
614 /* We must lock or a racing completion might update lvb
615 without letting us know and we'll clobber the correct value.
616 Cannot unlock after the check either, a that still leaves
617 a tiny window for completion to get in */
618 lock_res_and_lock(lock);
619 if (lock->l_req_mode != lock->l_granted_mode) {
621 req_capsule_set_size(&req->rq_pill, &RMF_DLM_LVB,
622 RCL_SERVER, lvb_len);
623 tmplvb = req_capsule_server_get(&req->rq_pill,
625 if (tmplvb == NULL) {
626 unlock_res_and_lock(lock);
627 GOTO(cleanup, rc = -EPROTO);
629 memcpy(lock->l_lvb_data, tmplvb, lvb_len);
631 unlock_res_and_lock(lock);
635 rc = ldlm_lock_enqueue(ns, &lock, NULL, flags);
636 if (lock->l_completion_ast != NULL) {
637 int err = lock->l_completion_ast(lock, *flags, NULL);
645 if (lvb_len && lvb != NULL) {
646 /* Copy the LVB here, and not earlier, because the completion
647 * AST (if any) can override what we got in the reply */
648 memcpy(lvb, lock->l_lvb_data, lvb_len);
651 LDLM_DEBUG(lock, "client-side enqueue END");
654 if (cleanup_phase == 1 && rc)
655 failed_lock_cleanup(ns, lock, mode);
656 /* Put lock 2 times, the second reference is held by ldlm_cli_enqueue */
658 LDLM_LOCK_RELEASE(lock);
662 /* PAGE_SIZE-512 is to allow TCP/IP and LNET headers to fit into
663 * a single page on the send/receive side. XXX: 512 should be changed
664 * to more adequate value. */
665 static inline int ldlm_req_handles_avail(int req_size, int off)
669 avail = min_t(int, LDLM_MAXREQSIZE, CFS_PAGE_SIZE - 512) - req_size;
670 if (likely(avail >= 0))
671 avail /= (int)sizeof(struct lustre_handle);
674 avail += LDLM_LOCKREQ_HANDLES - off;
679 static inline int ldlm_capsule_handles_avail(struct req_capsule *pill,
680 enum req_location loc,
683 int size = req_capsule_msg_size(pill, loc);
684 return ldlm_req_handles_avail(size, off);
687 static inline int ldlm_format_handles_avail(struct obd_import *imp,
688 const struct req_format *fmt,
689 enum req_location loc, int off)
691 int size = req_capsule_fmt_size(imp->imp_msg_magic, fmt, loc);
692 return ldlm_req_handles_avail(size, off);
695 /* Cancel lru locks and pack them into the enqueue request. Pack there the given
696 * @count locks in @cancels. */
697 int ldlm_prep_elc_req(struct obd_export *exp, struct ptlrpc_request *req,
698 int version, int opc, int canceloff,
699 cfs_list_t *cancels, int count)
701 struct ldlm_namespace *ns = exp->exp_obd->obd_namespace;
702 struct req_capsule *pill = &req->rq_pill;
703 struct ldlm_request *dlm = NULL;
704 int flags, avail, to_free, pack = 0;
711 if (exp_connect_cancelset(exp)) {
712 /* Estimate the amount of available space in the request. */
713 req_capsule_filled_sizes(pill, RCL_CLIENT);
714 avail = ldlm_capsule_handles_avail(pill, RCL_CLIENT, canceloff);
716 flags = ns_connect_lru_resize(ns) ?
717 LDLM_CANCEL_LRUR : LDLM_CANCEL_AGED;
718 to_free = !ns_connect_lru_resize(ns) &&
719 opc == LDLM_ENQUEUE ? 1 : 0;
721 /* Cancel lru locks here _only_ if the server supports
722 * EARLY_CANCEL. Otherwise we have to send extra CANCEL
723 * rpc, what will make us slower. */
725 count += ldlm_cancel_lru_local(ns, cancels, to_free,
726 avail - count, 0, flags);
731 req_capsule_set_size(pill, &RMF_DLM_REQ, RCL_CLIENT,
732 ldlm_request_bufsize(pack, opc));
735 rc = ptlrpc_request_pack(req, version, opc);
737 ldlm_lock_list_put(cancels, l_bl_ast, count);
741 if (exp_connect_cancelset(exp)) {
743 dlm = req_capsule_client_get(pill, &RMF_DLM_REQ);
745 /* Skip first lock handler in ldlm_request_pack(),
746 * this method will incrment @lock_count according
747 * to the lock handle amount actually written to
749 dlm->lock_count = canceloff;
751 /* Pack into the request @pack lock handles. */
752 ldlm_cli_cancel_list(cancels, pack, req, 0);
753 /* Prepare and send separate cancel rpc for others. */
754 ldlm_cli_cancel_list(cancels, count - pack, NULL, 0);
756 ldlm_lock_list_put(cancels, l_bl_ast, count);
761 int ldlm_prep_enqueue_req(struct obd_export *exp, struct ptlrpc_request *req,
762 cfs_list_t *cancels, int count)
764 return ldlm_prep_elc_req(exp, req, LUSTRE_DLM_VERSION, LDLM_ENQUEUE,
765 LDLM_ENQUEUE_CANCEL_OFF, cancels, count);
768 /* If a request has some specific initialisation it is passed in @reqp,
769 * otherwise it is created in ldlm_cli_enqueue.
771 * Supports sync and async requests, pass @async flag accordingly. If a
772 * request was created in ldlm_cli_enqueue and it is the async request,
773 * pass it to the caller in @reqp. */
774 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
775 struct ldlm_enqueue_info *einfo,
776 const struct ldlm_res_id *res_id,
777 ldlm_policy_data_t const *policy, int *flags,
778 void *lvb, __u32 lvb_len, struct lustre_handle *lockh,
781 struct ldlm_namespace *ns = exp->exp_obd->obd_namespace;
782 struct ldlm_lock *lock;
783 struct ldlm_request *body;
784 int is_replay = *flags & LDLM_FL_REPLAY;
785 int req_passed_in = 1;
787 struct ptlrpc_request *req;
790 LASSERT(exp != NULL);
792 /* If we're replaying this lock, just check some invariants.
793 * If we're creating a new lock, get everything all setup nice. */
795 lock = ldlm_handle2lock_long(lockh, 0);
796 LASSERT(lock != NULL);
797 LDLM_DEBUG(lock, "client-side enqueue START");
798 LASSERT(exp == lock->l_conn_export);
800 const struct ldlm_callback_suite cbs = {
801 .lcs_completion = einfo->ei_cb_cp,
802 .lcs_blocking = einfo->ei_cb_bl,
803 .lcs_glimpse = einfo->ei_cb_gl,
804 .lcs_weigh = einfo->ei_cb_wg
806 lock = ldlm_lock_create(ns, res_id, einfo->ei_type,
807 einfo->ei_mode, &cbs, einfo->ei_cbdata,
811 /* for the local lock, add the reference */
812 ldlm_lock_addref_internal(lock, einfo->ei_mode);
813 ldlm_lock2handle(lock, lockh);
814 if (policy != NULL) {
815 /* INODEBITS_INTEROP: If the server does not support
816 * inodebits, we will request a plain lock in the
817 * descriptor (ldlm_lock2desc() below) but use an
818 * inodebits lock internally with both bits set.
820 if (einfo->ei_type == LDLM_IBITS &&
821 !(exp->exp_connect_flags & OBD_CONNECT_IBITS))
822 lock->l_policy_data.l_inodebits.bits =
823 MDS_INODELOCK_LOOKUP |
824 MDS_INODELOCK_UPDATE;
826 lock->l_policy_data = *policy;
829 if (einfo->ei_type == LDLM_EXTENT)
830 lock->l_req_extent = policy->l_extent;
831 LDLM_DEBUG(lock, "client-side enqueue START");
834 lock->l_conn_export = exp;
835 lock->l_export = NULL;
836 lock->l_blocking_ast = einfo->ei_cb_bl;
837 lock->l_flags |= (*flags & LDLM_FL_NO_LRU);
839 /* lock not sent to server yet */
841 if (reqp == NULL || *reqp == NULL) {
842 req = ptlrpc_request_alloc_pack(class_exp2cliimp(exp),
847 failed_lock_cleanup(ns, lock, einfo->ei_mode);
848 LDLM_LOCK_RELEASE(lock);
858 len = req_capsule_get_size(&req->rq_pill, &RMF_DLM_REQ,
860 LASSERTF(len >= sizeof(*body), "buflen[%d] = %d, not %d\n",
861 DLM_LOCKREQ_OFF, len, (int)sizeof(*body));
864 /* Dump lock data into the request buffer */
865 body = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
866 ldlm_lock2desc(lock, &body->lock_desc);
867 body->lock_flags = *flags;
868 body->lock_handle[0] = *lockh;
870 /* Continue as normal. */
871 if (!req_passed_in) {
873 req_capsule_extend(&req->rq_pill,
874 &RQF_LDLM_ENQUEUE_LVB);
875 req_capsule_set_size(&req->rq_pill, &RMF_DLM_LVB,
876 RCL_SERVER, lvb_len);
878 ptlrpc_request_set_replen(req);
882 * Liblustre client doesn't get extent locks, except for O_APPEND case
883 * where [0, OBD_OBJECT_EOF] lock is taken, or truncate, where
884 * [i_size, OBD_OBJECT_EOF] lock is taken.
886 LASSERT(ergo(LIBLUSTRE_CLIENT, einfo->ei_type != LDLM_EXTENT ||
887 policy->l_extent.end == OBD_OBJECT_EOF));
890 LASSERT(reqp != NULL);
894 LDLM_DEBUG(lock, "sending request");
896 rc = ptlrpc_queue_wait(req);
898 err = ldlm_cli_enqueue_fini(exp, req, einfo->ei_type, policy ? 1 : 0,
899 einfo->ei_mode, flags, lvb, lvb_len,
902 /* If ldlm_cli_enqueue_fini did not find the lock, we need to free
903 * one reference that we took */
905 LDLM_LOCK_RELEASE(lock);
909 if (!req_passed_in && req != NULL) {
910 ptlrpc_req_finished(req);
918 static int ldlm_cli_convert_local(struct ldlm_lock *lock, int new_mode,
921 struct ldlm_resource *res;
924 if (ns_is_client(ldlm_lock_to_ns(lock))) {
925 CERROR("Trying to cancel local lock\n");
928 LDLM_DEBUG(lock, "client-side local convert");
930 res = ldlm_lock_convert(lock, new_mode, flags);
932 ldlm_reprocess_all(res);
937 LDLM_DEBUG(lock, "client-side local convert handler END");
942 /* FIXME: one of ldlm_cli_convert or the server side should reject attempted
943 * conversion of locks which are on the waiting or converting queue */
944 /* Caller of this code is supposed to take care of lock readers/writers
946 int ldlm_cli_convert(struct lustre_handle *lockh, int new_mode, __u32 *flags)
948 struct ldlm_request *body;
949 struct ldlm_reply *reply;
950 struct ldlm_lock *lock;
951 struct ldlm_resource *res;
952 struct ptlrpc_request *req;
956 lock = ldlm_handle2lock(lockh);
963 if (lock->l_conn_export == NULL)
964 RETURN(ldlm_cli_convert_local(lock, new_mode, flags));
966 LDLM_DEBUG(lock, "client-side convert");
968 req = ptlrpc_request_alloc_pack(class_exp2cliimp(lock->l_conn_export),
969 &RQF_LDLM_CONVERT, LUSTRE_DLM_VERSION,
976 body = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
977 body->lock_handle[0] = lock->l_remote_handle;
979 body->lock_desc.l_req_mode = new_mode;
980 body->lock_flags = *flags;
983 ptlrpc_request_set_replen(req);
984 rc = ptlrpc_queue_wait(req);
988 reply = req_capsule_server_get(&req->rq_pill, &RMF_DLM_REP);
990 GOTO(out, rc = -EPROTO);
993 GOTO(out, rc = req->rq_status);
995 res = ldlm_lock_convert(lock, new_mode, &reply->lock_flags);
997 ldlm_reprocess_all(res);
998 /* Go to sleep until the lock is granted. */
999 /* FIXME: or cancelled. */
1000 if (lock->l_completion_ast) {
1001 rc = lock->l_completion_ast(lock, LDLM_FL_WAIT_NOREPROC,
1011 LDLM_LOCK_PUT(lock);
1012 ptlrpc_req_finished(req);
1016 /* Cancel locks locally.
1018 * LDLM_FL_LOCAL_ONLY if tere is no need in a CANCEL rpc to the server;
1019 * LDLM_FL_CANCELING otherwise;
1020 * LDLM_FL_BL_AST if there is a need in a separate CANCEL rpc. */
1021 static int ldlm_cli_cancel_local(struct ldlm_lock *lock)
1023 int rc = LDLM_FL_LOCAL_ONLY;
1026 if (lock->l_conn_export) {
1029 LDLM_DEBUG(lock, "client-side cancel");
1030 /* Set this flag to prevent others from getting new references*/
1031 lock_res_and_lock(lock);
1032 lock->l_flags |= LDLM_FL_CBPENDING;
1033 local_only = (lock->l_flags &
1034 (LDLM_FL_LOCAL_ONLY|LDLM_FL_CANCEL_ON_BLOCK));
1035 ldlm_cancel_callback(lock);
1036 rc = (lock->l_flags & LDLM_FL_BL_AST) ?
1037 LDLM_FL_BL_AST : LDLM_FL_CANCELING;
1038 unlock_res_and_lock(lock);
1041 CDEBUG(D_DLMTRACE, "not sending request (at caller's "
1043 rc = LDLM_FL_LOCAL_ONLY;
1045 ldlm_lock_cancel(lock);
1047 if (ns_is_client(ldlm_lock_to_ns(lock))) {
1048 LDLM_ERROR(lock, "Trying to cancel local lock");
1051 LDLM_DEBUG(lock, "server-side local cancel");
1052 ldlm_lock_cancel(lock);
1053 ldlm_reprocess_all(lock->l_resource);
1059 /* Pack @count locks in @head into ldlm_request buffer at the offset @off,
1060 of the request @req. */
1061 static void ldlm_cancel_pack(struct ptlrpc_request *req,
1062 cfs_list_t *head, int count)
1064 struct ldlm_request *dlm;
1065 struct ldlm_lock *lock;
1066 int max, packed = 0;
1069 dlm = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
1070 LASSERT(dlm != NULL);
1072 /* Check the room in the request buffer. */
1073 max = req_capsule_get_size(&req->rq_pill, &RMF_DLM_REQ, RCL_CLIENT) -
1074 sizeof(struct ldlm_request);
1075 max /= sizeof(struct lustre_handle);
1076 max += LDLM_LOCKREQ_HANDLES;
1077 LASSERT(max >= dlm->lock_count + count);
1079 /* XXX: it would be better to pack lock handles grouped by resource.
1080 * so that the server cancel would call filter_lvbo_update() less
1082 cfs_list_for_each_entry(lock, head, l_bl_ast) {
1085 LASSERT(lock->l_conn_export);
1086 /* Pack the lock handle to the given request buffer. */
1087 LDLM_DEBUG(lock, "packing");
1088 dlm->lock_handle[dlm->lock_count++] = lock->l_remote_handle;
1091 CDEBUG(D_DLMTRACE, "%d locks packed\n", packed);
1095 /* Prepare and send a batched cancel rpc, it will include count lock handles
1096 * of locks given in @head. */
1097 int ldlm_cli_cancel_req(struct obd_export *exp, cfs_list_t *cancels,
1098 int count, ldlm_cancel_flags_t flags)
1100 struct ptlrpc_request *req = NULL;
1101 struct obd_import *imp;
1106 LASSERT(exp != NULL);
1109 CFS_FAIL_TIMEOUT(OBD_FAIL_LDLM_PAUSE_CANCEL, cfs_fail_val);
1111 if (CFS_FAIL_CHECK(OBD_FAIL_LDLM_CANCEL_RACE))
1114 free = ldlm_format_handles_avail(class_exp2cliimp(exp),
1115 &RQF_LDLM_CANCEL, RCL_CLIENT, 0);
1120 imp = class_exp2cliimp(exp);
1121 if (imp == NULL || imp->imp_invalid) {
1123 "skipping cancel on invalid import %p\n", imp);
1127 req = ptlrpc_request_alloc(imp, &RQF_LDLM_CANCEL);
1129 GOTO(out, rc = -ENOMEM);
1131 req_capsule_filled_sizes(&req->rq_pill, RCL_CLIENT);
1132 req_capsule_set_size(&req->rq_pill, &RMF_DLM_REQ, RCL_CLIENT,
1133 ldlm_request_bufsize(count, LDLM_CANCEL));
1135 rc = ptlrpc_request_pack(req, LUSTRE_DLM_VERSION, LDLM_CANCEL);
1137 ptlrpc_request_free(req);
1140 req->rq_no_resend = 1;
1141 req->rq_no_delay = 1;
1143 req->rq_request_portal = LDLM_CANCEL_REQUEST_PORTAL;
1144 req->rq_reply_portal = LDLM_CANCEL_REPLY_PORTAL;
1145 ptlrpc_at_set_req_timeout(req);
1147 ldlm_cancel_pack(req, cancels, count);
1149 ptlrpc_request_set_replen(req);
1150 if (flags & LCF_ASYNC) {
1151 ptlrpcd_add_req(req, PDL_POLICY_LOCAL, -1);
1155 rc = ptlrpc_queue_wait(req);
1158 CDEBUG(D_DLMTRACE, "client/server (nid %s) "
1159 "out of sync -- not fatal\n",
1160 libcfs_nid2str(req->rq_import->
1161 imp_connection->c_peer.nid));
1163 } else if (rc == -ETIMEDOUT && /* check there was no reconnect*/
1164 req->rq_import_generation == imp->imp_generation) {
1165 ptlrpc_req_finished(req);
1167 } else if (rc != ELDLM_OK) {
1168 CERROR("Got rc %d from cancel RPC: canceling "
1176 ptlrpc_req_finished(req);
1179 return sent ? sent : rc;
1182 static inline struct ldlm_pool *ldlm_imp2pl(struct obd_import *imp)
1184 LASSERT(imp != NULL);
1185 return &imp->imp_obd->obd_namespace->ns_pool;
1189 * Update client's obd pool related fields with new SLV and Limit from \a req.
1191 int ldlm_cli_update_pool(struct ptlrpc_request *req)
1193 struct obd_device *obd;
1197 if (unlikely(!req->rq_import || !req->rq_import->imp_obd ||
1198 !imp_connect_lru_resize(req->rq_import)))
1201 * Do nothing for corner cases.
1207 * In some cases RPC may contain slv and limit zeroed out. This is
1208 * the case when server does not support lru resize feature. This is
1209 * also possible in some recovery cases when server side reqs have no
1210 * ref to obd export and thus access to server side namespace is no
1213 if (lustre_msg_get_slv(req->rq_repmsg) == 0 ||
1214 lustre_msg_get_limit(req->rq_repmsg) == 0) {
1215 DEBUG_REQ(D_HA, req, "Zero SLV or Limit found "
1216 "(SLV: "LPU64", Limit: %u)",
1217 lustre_msg_get_slv(req->rq_repmsg),
1218 lustre_msg_get_limit(req->rq_repmsg));
1222 new_limit = lustre_msg_get_limit(req->rq_repmsg);
1223 new_slv = lustre_msg_get_slv(req->rq_repmsg);
1224 obd = req->rq_import->imp_obd;
1227 * Set new SLV and Limit to obd fields to make accessible for pool
1228 * thread. We do not access obd_namespace and pool directly here
1229 * as there is no reliable way to make sure that they are still
1230 * alive in cleanup time. Evil races are possible which may cause
1231 * oops in that time.
1233 cfs_write_lock(&obd->obd_pool_lock);
1234 obd->obd_pool_slv = new_slv;
1235 obd->obd_pool_limit = new_limit;
1236 cfs_write_unlock(&obd->obd_pool_lock);
1240 EXPORT_SYMBOL(ldlm_cli_update_pool);
1242 int ldlm_cli_cancel(struct lustre_handle *lockh)
1244 struct obd_export *exp;
1245 int avail, flags, count = 1, rc = 0;
1246 struct ldlm_namespace *ns;
1247 struct ldlm_lock *lock;
1248 CFS_LIST_HEAD(cancels);
1251 /* concurrent cancels on the same handle can happen */
1252 lock = ldlm_handle2lock_long(lockh, LDLM_FL_CANCELING);
1254 LDLM_DEBUG_NOLOCK("lock is already being destroyed\n");
1258 rc = ldlm_cli_cancel_local(lock);
1259 if (rc < 0 || rc == LDLM_FL_LOCAL_ONLY) {
1260 LDLM_LOCK_RELEASE(lock);
1261 RETURN(rc < 0 ? rc : 0);
1263 /* Even if the lock is marked as LDLM_FL_BL_AST, this is a LDLM_CANCEL
1264 * rpc which goes to canceld portal, so we can cancel other lru locks
1265 * here and send them all as one LDLM_CANCEL rpc. */
1266 LASSERT(cfs_list_empty(&lock->l_bl_ast));
1267 cfs_list_add(&lock->l_bl_ast, &cancels);
1269 exp = lock->l_conn_export;
1270 if (exp_connect_cancelset(exp)) {
1271 avail = ldlm_format_handles_avail(class_exp2cliimp(exp),
1276 ns = ldlm_lock_to_ns(lock);
1277 flags = ns_connect_lru_resize(ns) ?
1278 LDLM_CANCEL_LRUR : LDLM_CANCEL_AGED;
1279 count += ldlm_cancel_lru_local(ns, &cancels, 0, avail - 1,
1282 ldlm_cli_cancel_list(&cancels, count, NULL, 0);
1286 /* XXX until we will have compound requests and can cut cancels from generic rpc
1287 * we need send cancels with LDLM_FL_BL_AST flag as separate rpc */
1288 int ldlm_cli_cancel_list_local(cfs_list_t *cancels, int count,
1289 ldlm_cancel_flags_t flags)
1291 CFS_LIST_HEAD(head);
1292 struct ldlm_lock *lock, *next;
1293 int left = 0, bl_ast = 0, rc;
1296 cfs_list_for_each_entry_safe(lock, next, cancels, l_bl_ast) {
1300 if (flags & LCF_LOCAL) {
1301 rc = LDLM_FL_LOCAL_ONLY;
1302 ldlm_lock_cancel(lock);
1304 rc = ldlm_cli_cancel_local(lock);
1306 if (!(flags & LCF_BL_AST) && (rc == LDLM_FL_BL_AST)) {
1307 LDLM_DEBUG(lock, "Cancel lock separately");
1308 cfs_list_del_init(&lock->l_bl_ast);
1309 cfs_list_add(&lock->l_bl_ast, &head);
1313 if (rc == LDLM_FL_LOCAL_ONLY) {
1314 /* CANCEL RPC should not be sent to server. */
1315 cfs_list_del_init(&lock->l_bl_ast);
1316 LDLM_LOCK_RELEASE(lock);
1323 ldlm_cli_cancel_list(&head, bl_ast, NULL, 0);
1330 * Cancel as many locks as possible w/o sending any rpcs (e.g. to write back
1331 * dirty data, to close a file, ...) or waiting for any rpcs in-flight (e.g.
1332 * readahead requests, ...)
1334 static ldlm_policy_res_t ldlm_cancel_no_wait_policy(struct ldlm_namespace *ns,
1335 struct ldlm_lock *lock,
1336 int unused, int added,
1339 ldlm_policy_res_t result = LDLM_POLICY_CANCEL_LOCK;
1340 ldlm_cancel_for_recovery cb = ns->ns_cancel_for_recovery;
1341 lock_res_and_lock(lock);
1343 /* don't check added & count since we want to process all locks
1344 * from unused list */
1345 switch (lock->l_resource->lr_type) {
1351 result = LDLM_POLICY_SKIP_LOCK;
1352 lock->l_flags |= LDLM_FL_SKIPPED;
1356 unlock_res_and_lock(lock);
1361 * Callback function for lru-resize policy. Makes decision whether to keep
1362 * \a lock in LRU for current \a LRU size \a unused, added in current scan
1363 * \a added and number of locks to be preferably canceled \a count.
1365 * \retval LDLM_POLICY_KEEP_LOCK keep lock in LRU in stop scanning
1367 * \retval LDLM_POLICY_CANCEL_LOCK cancel lock from LRU
1369 static ldlm_policy_res_t ldlm_cancel_lrur_policy(struct ldlm_namespace *ns,
1370 struct ldlm_lock *lock,
1371 int unused, int added,
1374 cfs_time_t cur = cfs_time_current();
1375 struct ldlm_pool *pl = &ns->ns_pool;
1380 * Stop lru processing when we reached passed @count or checked all
1383 if (count && added >= count)
1384 return LDLM_POLICY_KEEP_LOCK;
1386 slv = ldlm_pool_get_slv(pl);
1387 lvf = ldlm_pool_get_lvf(pl);
1388 la = cfs_duration_sec(cfs_time_sub(cur,
1389 lock->l_last_used));
1392 * Stop when slv is not yet come from server or lv is smaller than
1395 lv = lvf * la * unused;
1398 * Inform pool about current CLV to see it via proc.
1400 ldlm_pool_set_clv(pl, lv);
1401 return (slv == 0 || lv < slv) ?
1402 LDLM_POLICY_KEEP_LOCK : LDLM_POLICY_CANCEL_LOCK;
1406 * Callback function for proc used policy. Makes decision whether to keep
1407 * \a lock in LRU for current \a LRU size \a unused, added in current scan
1408 * \a added and number of locks to be preferably canceled \a count.
1410 * \retval LDLM_POLICY_KEEP_LOCK keep lock in LRU in stop scanning
1412 * \retval LDLM_POLICY_CANCEL_LOCK cancel lock from LRU
1414 static ldlm_policy_res_t ldlm_cancel_passed_policy(struct ldlm_namespace *ns,
1415 struct ldlm_lock *lock,
1416 int unused, int added,
1420 * Stop lru processing when we reached passed @count or checked all
1423 return (added >= count) ?
1424 LDLM_POLICY_KEEP_LOCK : LDLM_POLICY_CANCEL_LOCK;
1428 * Callback function for aged policy. Makes decision whether to keep
1429 * \a lock in LRU for current \a LRU size \a unused, added in current scan
1430 * \a added and number of locks to be preferably canceled \a count.
1432 * \retval LDLM_POLICY_KEEP_LOCK keep lock in LRU in stop scanning
1434 * \retval LDLM_POLICY_CANCEL_LOCK cancel lock from LRU
1436 static ldlm_policy_res_t ldlm_cancel_aged_policy(struct ldlm_namespace *ns,
1437 struct ldlm_lock *lock,
1438 int unused, int added,
1442 * Stop lru processing if young lock is found and we reached passed
1445 return ((added >= count) &&
1446 cfs_time_before(cfs_time_current(),
1447 cfs_time_add(lock->l_last_used,
1449 LDLM_POLICY_KEEP_LOCK : LDLM_POLICY_CANCEL_LOCK;
1453 * Callback function for default policy. Makes decision whether to keep
1454 * \a lock in LRU for current \a LRU size \a unused, added in current scan
1455 * \a added and number of locks to be preferably canceled \a count.
1457 * \retval LDLM_POLICY_KEEP_LOCK keep lock in LRU in stop scanning
1459 * \retval LDLM_POLICY_CANCEL_LOCK cancel lock from LRU
1461 static ldlm_policy_res_t ldlm_cancel_default_policy(struct ldlm_namespace *ns,
1462 struct ldlm_lock *lock,
1463 int unused, int added,
1467 * Stop lru processing when we reached passed @count or checked all
1470 return (added >= count) ?
1471 LDLM_POLICY_KEEP_LOCK : LDLM_POLICY_CANCEL_LOCK;
1474 typedef ldlm_policy_res_t (*ldlm_cancel_lru_policy_t)(struct ldlm_namespace *,
1475 struct ldlm_lock *, int,
1478 static ldlm_cancel_lru_policy_t
1479 ldlm_cancel_lru_policy(struct ldlm_namespace *ns, int flags)
1481 if (flags & LDLM_CANCEL_NO_WAIT)
1482 return ldlm_cancel_no_wait_policy;
1484 if (ns_connect_lru_resize(ns)) {
1485 if (flags & LDLM_CANCEL_SHRINK)
1486 /* We kill passed number of old locks. */
1487 return ldlm_cancel_passed_policy;
1488 else if (flags & LDLM_CANCEL_LRUR)
1489 return ldlm_cancel_lrur_policy;
1490 else if (flags & LDLM_CANCEL_PASSED)
1491 return ldlm_cancel_passed_policy;
1493 if (flags & LDLM_CANCEL_AGED)
1494 return ldlm_cancel_aged_policy;
1497 return ldlm_cancel_default_policy;
1500 /* - Free space in lru for @count new locks,
1501 * redundant unused locks are canceled locally;
1502 * - also cancel locally unused aged locks;
1503 * - do not cancel more than @max locks;
1504 * - GET the found locks and add them into the @cancels list.
1506 * A client lock can be added to the l_bl_ast list only when it is
1507 * marked LDLM_FL_CANCELING. Otherwise, somebody is already doing CANCEL.
1508 * There are the following use cases: ldlm_cancel_resource_local(),
1509 * ldlm_cancel_lru_local() and ldlm_cli_cancel(), which check&set this
1510 * flag properly. As any attempt to cancel a lock rely on this flag,
1511 * l_bl_ast list is accessed later without any special locking.
1513 * Calling policies for enabled lru resize:
1514 * ----------------------------------------
1515 * flags & LDLM_CANCEL_LRUR - use lru resize policy (SLV from server) to
1516 * cancel not more than @count locks;
1518 * flags & LDLM_CANCEL_PASSED - cancel @count number of old locks (located at
1519 * the beginning of lru list);
1521 * flags & LDLM_CANCEL_SHRINK - cancel not more than @count locks according to
1522 * memory pressre policy function;
1524 * flags & LDLM_CANCEL_AGED - cancel alocks according to "aged policy".
1526 * flags & LDLM_CANCEL_NO_WAIT - cancel as many unused locks as possible
1527 * (typically before replaying locks) w/o
1528 * sending any rpcs or waiting for any
1529 * outstanding rpc to complete.
1531 static int ldlm_prepare_lru_list(struct ldlm_namespace *ns, cfs_list_t *cancels,
1532 int count, int max, int flags)
1534 ldlm_cancel_lru_policy_t pf;
1535 struct ldlm_lock *lock, *next;
1536 int added = 0, unused, remained;
1539 cfs_spin_lock(&ns->ns_lock);
1540 unused = ns->ns_nr_unused;
1543 if (!ns_connect_lru_resize(ns))
1544 count += unused - ns->ns_max_unused;
1546 pf = ldlm_cancel_lru_policy(ns, flags);
1547 LASSERT(pf != NULL);
1549 while (!cfs_list_empty(&ns->ns_unused_list)) {
1550 ldlm_policy_res_t result;
1552 /* all unused locks */
1553 if (remained-- <= 0)
1556 /* For any flags, stop scanning if @max is reached. */
1557 if (max && added >= max)
1560 cfs_list_for_each_entry_safe(lock, next, &ns->ns_unused_list,
1562 /* No locks which got blocking requests. */
1563 LASSERT(!(lock->l_flags & LDLM_FL_BL_AST));
1565 if (flags & LDLM_CANCEL_NO_WAIT &&
1566 lock->l_flags & LDLM_FL_SKIPPED)
1567 /* already processed */
1570 /* Somebody is already doing CANCEL. No need in this
1571 * lock in lru, do not traverse it again. */
1572 if (!(lock->l_flags & LDLM_FL_CANCELING))
1575 ldlm_lock_remove_from_lru_nolock(lock);
1577 if (&lock->l_lru == &ns->ns_unused_list)
1580 LDLM_LOCK_GET(lock);
1581 cfs_spin_unlock(&ns->ns_lock);
1582 lu_ref_add(&lock->l_reference, __FUNCTION__, cfs_current());
1584 /* Pass the lock through the policy filter and see if it
1585 * should stay in lru.
1587 * Even for shrinker policy we stop scanning if
1588 * we find a lock that should stay in the cache.
1589 * We should take into account lock age anyway
1590 * as new lock even if it is small of weight is
1591 * valuable resource.
1593 * That is, for shrinker policy we drop only
1594 * old locks, but additionally chose them by
1595 * their weight. Big extent locks will stay in
1597 result = pf(ns, lock, unused, added, count);
1598 if (result == LDLM_POLICY_KEEP_LOCK) {
1599 lu_ref_del(&lock->l_reference,
1600 __FUNCTION__, cfs_current());
1601 LDLM_LOCK_RELEASE(lock);
1602 cfs_spin_lock(&ns->ns_lock);
1605 if (result == LDLM_POLICY_SKIP_LOCK) {
1606 lu_ref_del(&lock->l_reference,
1607 __FUNCTION__, cfs_current());
1608 LDLM_LOCK_RELEASE(lock);
1609 cfs_spin_lock(&ns->ns_lock);
1613 lock_res_and_lock(lock);
1614 /* Check flags again under the lock. */
1615 if ((lock->l_flags & LDLM_FL_CANCELING) ||
1616 (ldlm_lock_remove_from_lru(lock) == 0)) {
1617 /* other thread is removing lock from lru or
1618 * somebody is already doing CANCEL or
1619 * there is a blocking request which will send
1620 * cancel by itseft or the lock is matched
1621 * is already not unused. */
1622 unlock_res_and_lock(lock);
1623 lu_ref_del(&lock->l_reference,
1624 __FUNCTION__, cfs_current());
1625 LDLM_LOCK_RELEASE(lock);
1626 cfs_spin_lock(&ns->ns_lock);
1629 LASSERT(!lock->l_readers && !lock->l_writers);
1631 /* If we have chosen to cancel this lock voluntarily, we
1632 * better send cancel notification to server, so that it
1633 * frees appropriate state. This might lead to a race
1634 * where while we are doing cancel here, server is also
1635 * silently cancelling this lock. */
1636 lock->l_flags &= ~LDLM_FL_CANCEL_ON_BLOCK;
1638 /* Setting the CBPENDING flag is a little misleading,
1639 * but prevents an important race; namely, once
1640 * CBPENDING is set, the lock can accumulate no more
1641 * readers/writers. Since readers and writers are
1642 * already zero here, ldlm_lock_decref() won't see
1643 * this flag and call l_blocking_ast */
1644 lock->l_flags |= LDLM_FL_CBPENDING | LDLM_FL_CANCELING;
1646 /* We can't re-add to l_lru as it confuses the
1647 * refcounting in ldlm_lock_remove_from_lru() if an AST
1648 * arrives after we drop lr_lock below. We use l_bl_ast
1649 * and can't use l_pending_chain as it is used both on
1650 * server and client nevertheless bug 5666 says it is
1651 * used only on server */
1652 LASSERT(cfs_list_empty(&lock->l_bl_ast));
1653 cfs_list_add(&lock->l_bl_ast, cancels);
1654 unlock_res_and_lock(lock);
1655 lu_ref_del(&lock->l_reference, __FUNCTION__, cfs_current());
1656 cfs_spin_lock(&ns->ns_lock);
1660 cfs_spin_unlock(&ns->ns_lock);
1664 int ldlm_cancel_lru_local(struct ldlm_namespace *ns, cfs_list_t *cancels,
1665 int count, int max, ldlm_cancel_flags_t cancel_flags,
1669 added = ldlm_prepare_lru_list(ns, cancels, count, max, flags);
1672 return ldlm_cli_cancel_list_local(cancels, added, cancel_flags);
1675 /* when called with LDLM_ASYNC the blocking callback will be handled
1676 * in a thread and this function will return after the thread has been
1677 * asked to call the callback. when called with LDLM_SYNC the blocking
1678 * callback will be performed in this function. */
1679 int ldlm_cancel_lru(struct ldlm_namespace *ns, int nr, ldlm_sync_t mode,
1682 CFS_LIST_HEAD(cancels);
1687 mode = LDLM_SYNC; /* force to be sync in user space */
1689 /* Just prepare the list of locks, do not actually cancel them yet.
1690 * Locks are cancelled later in a separate thread. */
1691 count = ldlm_prepare_lru_list(ns, &cancels, nr, 0, flags);
1692 rc = ldlm_bl_to_thread_list(ns, NULL, &cancels, count, mode);
1699 /* Find and cancel locally unused locks found on resource, matched to the
1700 * given policy, mode. GET the found locks and add them into the @cancels
1702 int ldlm_cancel_resource_local(struct ldlm_resource *res,
1703 cfs_list_t *cancels,
1704 ldlm_policy_data_t *policy,
1705 ldlm_mode_t mode, int lock_flags,
1706 ldlm_cancel_flags_t cancel_flags, void *opaque)
1708 struct ldlm_lock *lock;
1713 cfs_list_for_each_entry(lock, &res->lr_granted, l_res_link) {
1714 if (opaque != NULL && lock->l_ast_data != opaque) {
1715 LDLM_ERROR(lock, "data %p doesn't match opaque %p",
1716 lock->l_ast_data, opaque);
1721 if (lock->l_readers || lock->l_writers)
1724 /* If somebody is already doing CANCEL, or blocking ast came,
1725 * skip this lock. */
1726 if (lock->l_flags & LDLM_FL_BL_AST ||
1727 lock->l_flags & LDLM_FL_CANCELING)
1730 if (lockmode_compat(lock->l_granted_mode, mode))
1733 /* If policy is given and this is IBITS lock, add to list only
1734 * those locks that match by policy. */
1735 if (policy && (lock->l_resource->lr_type == LDLM_IBITS) &&
1736 !(lock->l_policy_data.l_inodebits.bits &
1737 policy->l_inodebits.bits))
1740 /* See CBPENDING comment in ldlm_cancel_lru */
1741 lock->l_flags |= LDLM_FL_CBPENDING | LDLM_FL_CANCELING |
1744 LASSERT(cfs_list_empty(&lock->l_bl_ast));
1745 cfs_list_add(&lock->l_bl_ast, cancels);
1746 LDLM_LOCK_GET(lock);
1751 RETURN(ldlm_cli_cancel_list_local(cancels, count, cancel_flags));
1754 /* If @req is NULL, send CANCEL request to server with handles of locks
1755 * in the @cancels. If EARLY_CANCEL is not supported, send CANCEL requests
1756 * separately per lock.
1757 * If @req is not NULL, put handles of locks in @cancels into the request
1758 * buffer at the offset @off.
1759 * Destroy @cancels at the end. */
1760 int ldlm_cli_cancel_list(cfs_list_t *cancels, int count,
1761 struct ptlrpc_request *req, ldlm_cancel_flags_t flags)
1763 struct ldlm_lock *lock;
1767 if (cfs_list_empty(cancels) || count == 0)
1770 /* XXX: requests (both batched and not) could be sent in parallel.
1771 * Usually it is enough to have just 1 RPC, but it is possible that
1772 * there are to many locks to be cancelled in LRU or on a resource.
1773 * It would also speed up the case when the server does not support
1776 LASSERT(!cfs_list_empty(cancels));
1777 lock = cfs_list_entry(cancels->next, struct ldlm_lock,
1779 LASSERT(lock->l_conn_export);
1781 if (exp_connect_cancelset(lock->l_conn_export)) {
1784 ldlm_cancel_pack(req, cancels, count);
1786 res = ldlm_cli_cancel_req(lock->l_conn_export,
1790 res = ldlm_cli_cancel_req(lock->l_conn_export,
1795 CERROR("ldlm_cli_cancel_list: %d\n", res);
1800 ldlm_lock_list_put(cancels, l_bl_ast, res);
1802 LASSERT(count == 0);
1806 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
1807 const struct ldlm_res_id *res_id,
1808 ldlm_policy_data_t *policy,
1810 ldlm_cancel_flags_t flags,
1813 struct ldlm_resource *res;
1814 CFS_LIST_HEAD(cancels);
1819 res = ldlm_resource_get(ns, NULL, res_id, 0, 0);
1821 /* This is not a problem. */
1822 CDEBUG(D_INFO, "No resource "LPU64"\n", res_id->name[0]);
1826 LDLM_RESOURCE_ADDREF(res);
1827 count = ldlm_cancel_resource_local(res, &cancels, policy, mode,
1828 0, flags | LCF_BL_AST, opaque);
1829 rc = ldlm_cli_cancel_list(&cancels, count, NULL, flags);
1831 CERROR("ldlm_cli_cancel_unused_resource: %d\n", rc);
1833 LDLM_RESOURCE_DELREF(res);
1834 ldlm_resource_putref(res);
1838 struct ldlm_cli_cancel_arg {
1843 static int ldlm_cli_hash_cancel_unused(cfs_hash_t *hs, cfs_hash_bd_t *bd,
1844 cfs_hlist_node_t *hnode, void *arg)
1846 struct ldlm_resource *res = cfs_hash_object(hs, hnode);
1847 struct ldlm_cli_cancel_arg *lc = arg;
1850 rc = ldlm_cli_cancel_unused_resource(ldlm_res_to_ns(res), &res->lr_name,
1852 lc->lc_flags, lc->lc_opaque);
1854 CERROR("ldlm_cli_cancel_unused ("LPU64"): %d\n",
1855 res->lr_name.name[0], rc);
1857 /* must return 0 for hash iteration */
1861 /* Cancel all locks on a namespace (or a specific resource, if given)
1862 * that have 0 readers/writers.
1864 * If flags & LCF_LOCAL, throw the locks away without trying
1865 * to notify the server. */
1866 int ldlm_cli_cancel_unused(struct ldlm_namespace *ns,
1867 const struct ldlm_res_id *res_id,
1868 ldlm_cancel_flags_t flags, void *opaque)
1870 struct ldlm_cli_cancel_arg arg = {
1872 .lc_opaque = opaque,
1880 if (res_id != NULL) {
1881 RETURN(ldlm_cli_cancel_unused_resource(ns, res_id, NULL,
1885 cfs_hash_for_each_nolock(ns->ns_rs_hash,
1886 ldlm_cli_hash_cancel_unused, &arg);
1891 /* Lock iterators. */
1893 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
1896 cfs_list_t *tmp, *next;
1897 struct ldlm_lock *lock;
1898 int rc = LDLM_ITER_CONTINUE;
1903 RETURN(LDLM_ITER_CONTINUE);
1906 cfs_list_for_each_safe(tmp, next, &res->lr_granted) {
1907 lock = cfs_list_entry(tmp, struct ldlm_lock, l_res_link);
1909 if (iter(lock, closure) == LDLM_ITER_STOP)
1910 GOTO(out, rc = LDLM_ITER_STOP);
1913 cfs_list_for_each_safe(tmp, next, &res->lr_converting) {
1914 lock = cfs_list_entry(tmp, struct ldlm_lock, l_res_link);
1916 if (iter(lock, closure) == LDLM_ITER_STOP)
1917 GOTO(out, rc = LDLM_ITER_STOP);
1920 cfs_list_for_each_safe(tmp, next, &res->lr_waiting) {
1921 lock = cfs_list_entry(tmp, struct ldlm_lock, l_res_link);
1923 if (iter(lock, closure) == LDLM_ITER_STOP)
1924 GOTO(out, rc = LDLM_ITER_STOP);
1931 struct iter_helper_data {
1932 ldlm_iterator_t iter;
1936 static int ldlm_iter_helper(struct ldlm_lock *lock, void *closure)
1938 struct iter_helper_data *helper = closure;
1939 return helper->iter(lock, helper->closure);
1942 static int ldlm_res_iter_helper(cfs_hash_t *hs, cfs_hash_bd_t *bd,
1943 cfs_hlist_node_t *hnode, void *arg)
1946 struct ldlm_resource *res = cfs_hash_object(hs, hnode);
1948 return ldlm_resource_foreach(res, ldlm_iter_helper, arg) ==
1952 void ldlm_namespace_foreach(struct ldlm_namespace *ns,
1953 ldlm_iterator_t iter, void *closure)
1956 struct iter_helper_data helper = { iter: iter, closure: closure };
1958 cfs_hash_for_each_nolock(ns->ns_rs_hash,
1959 ldlm_res_iter_helper, &helper);
1963 /* non-blocking function to manipulate a lock whose cb_data is being put away.
1964 * return 0: find no resource
1965 * > 0: must be LDLM_ITER_STOP/LDLM_ITER_CONTINUE.
1968 int ldlm_resource_iterate(struct ldlm_namespace *ns,
1969 const struct ldlm_res_id *res_id,
1970 ldlm_iterator_t iter, void *data)
1972 struct ldlm_resource *res;
1977 CERROR("must pass in namespace\n");
1981 res = ldlm_resource_get(ns, NULL, res_id, 0, 0);
1985 LDLM_RESOURCE_ADDREF(res);
1986 rc = ldlm_resource_foreach(res, iter, data);
1987 LDLM_RESOURCE_DELREF(res);
1988 ldlm_resource_putref(res);
1994 static int ldlm_chain_lock_for_replay(struct ldlm_lock *lock, void *closure)
1996 cfs_list_t *list = closure;
1998 /* we use l_pending_chain here, because it's unused on clients. */
1999 LASSERTF(cfs_list_empty(&lock->l_pending_chain),
2000 "lock %p next %p prev %p\n",
2001 lock, &lock->l_pending_chain.next,&lock->l_pending_chain.prev);
2002 /* bug 9573: don't replay locks left after eviction, or
2003 * bug 17614: locks being actively cancelled. Get a reference
2004 * on a lock so that it does not disapear under us (e.g. due to cancel)
2006 if (!(lock->l_flags & (LDLM_FL_FAILED|LDLM_FL_CANCELING))) {
2007 cfs_list_add(&lock->l_pending_chain, list);
2008 LDLM_LOCK_GET(lock);
2011 return LDLM_ITER_CONTINUE;
2014 static int replay_lock_interpret(const struct lu_env *env,
2015 struct ptlrpc_request *req,
2016 struct ldlm_async_args *aa, int rc)
2018 struct ldlm_lock *lock;
2019 struct ldlm_reply *reply;
2020 struct obd_export *exp;
2023 cfs_atomic_dec(&req->rq_import->imp_replay_inflight);
2028 reply = req_capsule_server_get(&req->rq_pill, &RMF_DLM_REP);
2030 GOTO(out, rc = -EPROTO);
2032 lock = ldlm_handle2lock(&aa->lock_handle);
2034 CERROR("received replay ack for unknown local cookie "LPX64
2035 " remote cookie "LPX64 " from server %s id %s\n",
2036 aa->lock_handle.cookie, reply->lock_handle.cookie,
2037 req->rq_export->exp_client_uuid.uuid,
2038 libcfs_id2str(req->rq_peer));
2039 GOTO(out, rc = -ESTALE);
2042 /* Key change rehash lock in per-export hash with new key */
2043 exp = req->rq_export;
2044 if (exp && exp->exp_lock_hash) {
2045 /* In the function below, .hs_keycmp resolves to
2046 * ldlm_export_lock_keycmp() */
2047 /* coverity[overrun-buffer-val] */
2048 cfs_hash_rehash_key(exp->exp_lock_hash,
2049 &lock->l_remote_handle,
2050 &reply->lock_handle,
2053 lock->l_remote_handle = reply->lock_handle;
2056 LDLM_DEBUG(lock, "replayed lock:");
2057 ptlrpc_import_recovery_state_machine(req->rq_import);
2058 LDLM_LOCK_PUT(lock);
2061 ptlrpc_connect_import(req->rq_import);
2066 static int replay_one_lock(struct obd_import *imp, struct ldlm_lock *lock)
2068 struct ptlrpc_request *req;
2069 struct ldlm_async_args *aa;
2070 struct ldlm_request *body;
2075 /* Bug 11974: Do not replay a lock which is actively being canceled */
2076 if (lock->l_flags & LDLM_FL_CANCELING) {
2077 LDLM_DEBUG(lock, "Not replaying canceled lock:");
2081 /* If this is reply-less callback lock, we cannot replay it, since
2082 * server might have long dropped it, but notification of that event was
2083 * lost by network. (and server granted conflicting lock already) */
2084 if (lock->l_flags & LDLM_FL_CANCEL_ON_BLOCK) {
2085 LDLM_DEBUG(lock, "Not replaying reply-less lock:");
2086 ldlm_lock_cancel(lock);
2090 * If granted mode matches the requested mode, this lock is granted.
2092 * If they differ, but we have a granted mode, then we were granted
2093 * one mode and now want another: ergo, converting.
2095 * If we haven't been granted anything and are on a resource list,
2096 * then we're blocked/waiting.
2098 * If we haven't been granted anything and we're NOT on a resource list,
2099 * then we haven't got a reply yet and don't have a known disposition.
2100 * This happens whenever a lock enqueue is the request that triggers
2103 if (lock->l_granted_mode == lock->l_req_mode)
2104 flags = LDLM_FL_REPLAY | LDLM_FL_BLOCK_GRANTED;
2105 else if (lock->l_granted_mode)
2106 flags = LDLM_FL_REPLAY | LDLM_FL_BLOCK_CONV;
2107 else if (!cfs_list_empty(&lock->l_res_link))
2108 flags = LDLM_FL_REPLAY | LDLM_FL_BLOCK_WAIT;
2110 flags = LDLM_FL_REPLAY;
2112 req = ptlrpc_request_alloc_pack(imp, &RQF_LDLM_ENQUEUE,
2113 LUSTRE_DLM_VERSION, LDLM_ENQUEUE);
2117 /* We're part of recovery, so don't wait for it. */
2118 req->rq_send_state = LUSTRE_IMP_REPLAY_LOCKS;
2120 body = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
2121 ldlm_lock2desc(lock, &body->lock_desc);
2122 body->lock_flags = flags;
2124 ldlm_lock2handle(lock, &body->lock_handle[0]);
2125 if (lock->l_lvb_len != 0) {
2126 req_capsule_extend(&req->rq_pill, &RQF_LDLM_ENQUEUE_LVB);
2127 req_capsule_set_size(&req->rq_pill, &RMF_DLM_LVB, RCL_SERVER,
2130 ptlrpc_request_set_replen(req);
2131 /* notify the server we've replayed all requests.
2132 * also, we mark the request to be put on a dedicated
2133 * queue to be processed after all request replayes.
2135 lustre_msg_set_flags(req->rq_reqmsg, MSG_REQ_REPLAY_DONE);
2137 LDLM_DEBUG(lock, "replaying lock:");
2139 cfs_atomic_inc(&req->rq_import->imp_replay_inflight);
2140 CLASSERT(sizeof(*aa) <= sizeof(req->rq_async_args));
2141 aa = ptlrpc_req_async_args(req);
2142 aa->lock_handle = body->lock_handle[0];
2143 req->rq_interpret_reply = (ptlrpc_interpterer_t)replay_lock_interpret;
2144 ptlrpcd_add_req(req, PDL_POLICY_LOCAL, -1);
2150 * Cancel as many unused locks as possible before replay. since we are
2151 * in recovery, we can't wait for any outstanding RPCs to send any RPC
2154 * Called only in recovery before replaying locks. there is no need to
2155 * replay locks that are unused. since the clients may hold thousands of
2156 * cached unused locks, dropping the unused locks can greatly reduce the
2157 * load on the servers at recovery time.
2159 static void ldlm_cancel_unused_locks_for_replay(struct ldlm_namespace *ns)
2162 CFS_LIST_HEAD(cancels);
2164 CDEBUG(D_DLMTRACE, "Dropping as many unused locks as possible before"
2165 "replay for namespace %s (%d)\n",
2166 ldlm_ns_name(ns), ns->ns_nr_unused);
2168 /* We don't need to care whether or not LRU resize is enabled
2169 * because the LDLM_CANCEL_NO_WAIT policy doesn't use the
2170 * count parameter */
2171 canceled = ldlm_cancel_lru_local(ns, &cancels, ns->ns_nr_unused, 0,
2172 LCF_LOCAL, LDLM_CANCEL_NO_WAIT);
2174 CDEBUG(D_DLMTRACE, "Canceled %d unused locks from namespace %s\n",
2175 canceled, ldlm_ns_name(ns));
2178 int ldlm_replay_locks(struct obd_import *imp)
2180 struct ldlm_namespace *ns = imp->imp_obd->obd_namespace;
2181 CFS_LIST_HEAD(list);
2182 struct ldlm_lock *lock, *next;
2187 LASSERT(cfs_atomic_read(&imp->imp_replay_inflight) == 0);
2189 /* don't replay locks if import failed recovery */
2190 if (imp->imp_vbr_failed)
2193 /* ensure this doesn't fall to 0 before all have been queued */
2194 cfs_atomic_inc(&imp->imp_replay_inflight);
2196 if (ldlm_cancel_unused_locks_before_replay)
2197 ldlm_cancel_unused_locks_for_replay(ns);
2199 ldlm_namespace_foreach(ns, ldlm_chain_lock_for_replay, &list);
2201 cfs_list_for_each_entry_safe(lock, next, &list, l_pending_chain) {
2202 cfs_list_del_init(&lock->l_pending_chain);
2204 LDLM_LOCK_RELEASE(lock);
2205 continue; /* or try to do the rest? */
2207 rc = replay_one_lock(imp, lock);
2208 LDLM_LOCK_RELEASE(lock);
2211 cfs_atomic_dec(&imp->imp_replay_inflight);