1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright 2008 Sun Microsystems, Inc. All rights reserved
30 * Use is subject to license terms.
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 static void interrupted_completion_wait(void *data)
57 struct lock_wait_data {
58 struct ldlm_lock *lwd_lock;
62 struct ldlm_async_args {
63 struct lustre_handle lock_handle;
66 int ldlm_expired_completion_wait(void *data)
68 struct lock_wait_data *lwd = data;
69 struct ldlm_lock *lock = lwd->lwd_lock;
70 struct obd_import *imp;
71 struct obd_device *obd;
74 if (lock->l_conn_export == NULL) {
75 static cfs_time_t next_dump = 0, last_dump = 0;
77 if (ptlrpc_check_suspend())
80 LDLM_ERROR(lock, "lock timed out (enqueued at "CFS_TIME_T", "
81 CFS_DURATION_T"s ago); not entering recovery in "
82 "server code, just going back to sleep",
83 lock->l_last_activity,
84 cfs_time_sub(cfs_time_current_sec(),
85 lock->l_last_activity));
86 if (cfs_time_after(cfs_time_current(), next_dump)) {
87 last_dump = next_dump;
88 next_dump = cfs_time_shift(300);
89 ldlm_namespace_dump(D_DLMTRACE,
90 lock->l_resource->lr_namespace);
92 libcfs_debug_dumplog();
97 obd = lock->l_conn_export->exp_obd;
98 imp = obd->u.cli.cl_import;
99 ptlrpc_fail_import(imp, lwd->lwd_conn_cnt);
100 LDLM_ERROR(lock, "lock timed out (enqueued at "CFS_TIME_T", "
101 CFS_DURATION_T"s ago), entering recovery for %s@%s",
102 lock->l_last_activity,
103 cfs_time_sub(cfs_time_current_sec(), lock->l_last_activity),
104 obd2cli_tgt(obd), imp->imp_connection->c_remote_uuid.uuid);
109 /* We use the same basis for both server side and client side functions
110 from a single node. */
111 int ldlm_get_enq_timeout(struct ldlm_lock *lock)
113 int timeout = at_get(&lock->l_resource->lr_namespace->ns_at_estimate);
115 return obd_timeout / 2;
116 /* Since these are non-updating timeouts, we should be conservative.
117 It would be nice to have some kind of "early reply" mechanism for
118 lock callbacks too... */
119 timeout = min_t(int, at_max, timeout + (timeout >> 1)); /* 150% */
120 return max(timeout, ldlm_enqueue_min);
122 EXPORT_SYMBOL(ldlm_get_enq_timeout);
125 * Helper function for ldlm_completion_ast(), updating timings when lock is
128 static int ldlm_completion_tail(struct ldlm_lock *lock)
133 if (lock->l_destroyed || lock->l_flags & LDLM_FL_FAILED) {
134 LDLM_DEBUG(lock, "client-side enqueue: destroyed");
137 delay = cfs_time_sub(cfs_time_current_sec(),
138 lock->l_last_activity);
139 LDLM_DEBUG(lock, "client-side enqueue: granted after "
140 CFS_DURATION_T"s", delay);
142 /* Update our time estimate */
143 at_add(&lock->l_resource->lr_namespace->ns_at_estimate, delay);
150 * Implementation of ->l_completion_ast() for a client, that doesn't wait
151 * until lock is granted. Suitable for locks enqueued through ptlrpcd, of
152 * other threads that cannot block for long.
154 int ldlm_completion_ast_async(struct ldlm_lock *lock, int flags, void *data)
158 if (flags == LDLM_FL_WAIT_NOREPROC) {
159 LDLM_DEBUG(lock, "client-side enqueue waiting on pending lock");
163 if (!(flags & (LDLM_FL_BLOCK_WAIT | LDLM_FL_BLOCK_GRANTED |
164 LDLM_FL_BLOCK_CONV))) {
165 cfs_waitq_signal(&lock->l_waitq);
166 RETURN(ldlm_completion_tail(lock));
169 LDLM_DEBUG(lock, "client-side enqueue returned a blocked lock, "
171 ldlm_lock_dump(D_OTHER, lock, 0);
172 ldlm_reprocess_all(lock->l_resource);
177 * Client side LDLM "completion" AST. This is called in several cases:
179 * - when a reply to an ENQUEUE rpc is received from the server
180 * (ldlm_cli_enqueue_fini()). Lock might be granted or not granted at
181 * this point (determined by flags);
183 * - when LDLM_CP_CALLBACK rpc comes to client to notify it that lock has
186 * - when ldlm_lock_match(LDLM_FL_LVB_READY) is about to wait until lock
189 * - to force all locks when resource is destroyed (cleanup_resource());
191 * - during lock conversion (not used currently).
193 * If lock is not granted in the first case, this function waits until second
194 * or penultimate cases happen in some other thread.
197 int ldlm_completion_ast(struct ldlm_lock *lock, int flags, void *data)
199 /* XXX ALLOCATE - 160 bytes */
200 struct lock_wait_data lwd;
201 struct obd_device *obd;
202 struct obd_import *imp = NULL;
203 struct l_wait_info lwi;
208 if (flags == LDLM_FL_WAIT_NOREPROC) {
209 LDLM_DEBUG(lock, "client-side enqueue waiting on pending lock");
213 if (!(flags & (LDLM_FL_BLOCK_WAIT | LDLM_FL_BLOCK_GRANTED |
214 LDLM_FL_BLOCK_CONV))) {
215 cfs_waitq_signal(&lock->l_waitq);
219 LDLM_DEBUG(lock, "client-side enqueue returned a blocked lock, "
221 ldlm_lock_dump(D_OTHER, lock, 0);
225 obd = class_exp2obd(lock->l_conn_export);
227 /* if this is a local lock, then there is no import */
229 imp = obd->u.cli.cl_import;
232 /* Wait a long time for enqueue - server may have to callback a
233 lock from another client. Server will evict the other client if it
234 doesn't respond reasonably, and then give us the lock. */
235 timeout = ldlm_get_enq_timeout(lock) * 2;
239 if (lock->l_flags & LDLM_FL_NO_TIMEOUT) {
240 LDLM_DEBUG(lock, "waiting indefinitely because of NO_TIMEOUT");
241 lwi = LWI_INTR(interrupted_completion_wait, &lwd);
243 lwi = LWI_TIMEOUT_INTR(cfs_time_seconds(timeout),
244 ldlm_expired_completion_wait,
245 interrupted_completion_wait, &lwd);
249 spin_lock(&imp->imp_lock);
250 lwd.lwd_conn_cnt = imp->imp_conn_cnt;
251 spin_unlock(&imp->imp_lock);
254 if (ns_is_client(lock->l_resource->lr_namespace) &&
255 OBD_FAIL_CHECK_RESET(OBD_FAIL_LDLM_INTR_CP_AST,
256 OBD_FAIL_LDLM_CP_BL_RACE | OBD_FAIL_ONCE)) {
257 lock->l_flags |= LDLM_FL_FAIL_LOC;
260 /* Go to sleep until the lock is granted or cancelled. */
261 rc = l_wait_event(lock->l_waitq,
262 is_granted_or_cancelled(lock), &lwi);
266 LDLM_DEBUG(lock, "client-side enqueue waking up: failed (%d)",
271 RETURN(ldlm_completion_tail(lock));
275 * A helper to build a blocking ast function
277 * Perform a common operation for blocking asts:
278 * defferred lock cancellation.
280 * \param lock the lock blocking or canceling ast was called on
282 * \see mdt_blocking_ast
283 * \see ldlm_blocking_ast
285 int ldlm_blocking_ast_nocheck(struct ldlm_lock *lock)
290 lock->l_flags |= LDLM_FL_CBPENDING;
291 do_ast = (!lock->l_readers && !lock->l_writers);
292 unlock_res_and_lock(lock);
295 struct lustre_handle lockh;
298 LDLM_DEBUG(lock, "already unused, calling ldlm_cli_cancel");
299 ldlm_lock2handle(lock, &lockh);
300 rc = ldlm_cli_cancel(&lockh);
302 CERROR("ldlm_cli_cancel: %d\n", rc);
304 LDLM_DEBUG(lock, "Lock still has references, will be "
311 * Server blocking AST
313 * ->l_blocking_ast() callback for LDLM locks acquired by server-side
316 * \param lock the lock which blocks a request or cancelling lock
319 * \param flag indicates whether this cancelling or blocking callback
321 * \see ldlm_blocking_ast_nocheck
323 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
324 void *data, int flag)
328 if (flag == LDLM_CB_CANCELING) {
329 /* Don't need to do anything here. */
333 lock_res_and_lock(lock);
334 /* Get this: if ldlm_blocking_ast is racing with intent_policy, such
335 * that ldlm_blocking_ast is called just before intent_policy method
336 * takes the ns_lock, then by the time we get the lock, we might not
337 * be the correct blocking function anymore. So check, and return
339 if (lock->l_blocking_ast != ldlm_blocking_ast) {
340 unlock_res_and_lock(lock);
343 RETURN(ldlm_blocking_ast_nocheck(lock));
347 * ->l_glimpse_ast() for DLM extent locks acquired on the server-side. See
348 * comment in filter_intent_policy() on why you may need this.
350 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp)
353 * Returning -ELDLM_NO_LOCK_DATA actually works, but the reason for
354 * that is rather subtle: with OST-side locking, it may so happen that
355 * _all_ extent locks are held by the OST. If client wants to obtain
356 * current file size it calls ll{,u}_glimpse_size(), and (as locks are
357 * on the server), dummy glimpse callback fires and does
358 * nothing. Client still receives correct file size due to the
359 * following fragment in filter_intent_policy():
361 * rc = l->l_glimpse_ast(l, NULL); // this will update the LVB
362 * if (rc != 0 && res->lr_namespace->ns_lvbo &&
363 * res->lr_namespace->ns_lvbo->lvbo_update) {
364 * res->lr_namespace->ns_lvbo->lvbo_update(res, NULL, 0, 1);
367 * that is, after glimpse_ast() fails, filter_lvbo_update() runs, and
368 * returns correct file size to the client.
370 return -ELDLM_NO_LOCK_DATA;
373 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
374 const struct ldlm_res_id *res_id,
375 ldlm_type_t type, ldlm_policy_data_t *policy,
376 ldlm_mode_t mode, int *flags,
377 ldlm_blocking_callback blocking,
378 ldlm_completion_callback completion,
379 ldlm_glimpse_callback glimpse,
380 void *data, __u32 lvb_len,
381 const __u64 *client_cookie,
382 struct lustre_handle *lockh)
384 struct ldlm_lock *lock;
386 const struct ldlm_callback_suite cbs = { .lcs_completion = completion,
387 .lcs_blocking = blocking,
388 .lcs_glimpse = glimpse,
392 LASSERT(!(*flags & LDLM_FL_REPLAY));
393 if (unlikely(ns_is_client(ns))) {
394 CERROR("Trying to enqueue local lock in a shadow namespace\n");
398 lock = ldlm_lock_create(ns, res_id, type, mode, &cbs, data, lvb_len);
400 GOTO(out_nolock, err = -ENOMEM);
402 ldlm_lock_addref_internal(lock, mode);
403 ldlm_lock2handle(lock, lockh);
404 lock_res_and_lock(lock);
405 lock->l_flags |= LDLM_FL_LOCAL;
406 if (*flags & LDLM_FL_ATOMIC_CB)
407 lock->l_flags |= LDLM_FL_ATOMIC_CB;
408 unlock_res_and_lock(lock);
410 lock->l_policy_data = *policy;
411 if (client_cookie != NULL)
412 lock->l_client_cookie = *client_cookie;
413 if (type == LDLM_EXTENT)
414 lock->l_req_extent = policy->l_extent;
416 err = ldlm_lock_enqueue(ns, &lock, policy, flags);
417 if (unlikely(err != ELDLM_OK))
421 *policy = lock->l_policy_data;
423 if (lock->l_completion_ast)
424 lock->l_completion_ast(lock, *flags, NULL);
426 LDLM_DEBUG(lock, "client-side local enqueue handler, new lock created");
429 LDLM_LOCK_RELEASE(lock);
434 static void failed_lock_cleanup(struct ldlm_namespace *ns,
435 struct ldlm_lock *lock,
436 struct lustre_handle *lockh, int mode)
440 /* Set a flag to prevent us from sending a CANCEL (bug 407) */
441 lock_res_and_lock(lock);
442 /* Check that lock is not granted or failed, we might race. */
443 if ((lock->l_req_mode != lock->l_granted_mode) &&
444 !(lock->l_flags & LDLM_FL_FAILED)) {
445 /* Make sure that this lock will not be found by raced
446 * bl_ast and -EINVAL reply is sent to server anyways.
448 lock->l_flags |= LDLM_FL_LOCAL_ONLY | LDLM_FL_FAILED |
452 unlock_res_and_lock(lock);
456 "setting FL_LOCAL_ONLY | LDLM_FL_FAILED | "
457 "LDLM_FL_ATOMIC_CB");
458 ldlm_lock_decref_and_cancel(lockh, mode);
460 LDLM_DEBUG(lock, "lock was granted or failed in race");
461 ldlm_lock_decref(lockh, mode);
464 /* XXX - HACK because we shouldn't call ldlm_lock_destroy()
465 * from llite/file.c/ll_file_flock(). */
466 if (lock->l_resource->lr_type == LDLM_FLOCK) {
467 ldlm_lock_destroy(lock);
471 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
472 ldlm_type_t type, __u8 with_policy, ldlm_mode_t mode,
473 int *flags, void *lvb, __u32 lvb_len,
474 struct lustre_handle *lockh,int rc)
476 struct ldlm_namespace *ns = exp->exp_obd->obd_namespace;
477 int is_replay = *flags & LDLM_FL_REPLAY;
478 struct lustre_handle old_hash_key;
479 struct ldlm_lock *lock;
480 struct ldlm_reply *reply;
481 int cleanup_phase = 1;
484 lock = ldlm_handle2lock(lockh);
485 /* ldlm_cli_enqueue is holding a reference on this lock. */
487 LASSERT(type == LDLM_FLOCK);
491 if (rc != ELDLM_OK) {
493 LDLM_DEBUG(lock, "client-side enqueue END (%s)",
494 rc == ELDLM_LOCK_ABORTED ? "ABORTED" : "FAILED");
495 if (rc == ELDLM_LOCK_ABORTED) {
496 /* Before we return, swab the reply */
497 reply = req_capsule_server_get(&req->rq_pill,
502 struct ost_lvb *tmplvb;
504 req_capsule_set_size(&req->rq_pill,
505 &RMF_DLM_LVB, RCL_SERVER,
507 tmplvb = req_capsule_server_get(&req->rq_pill,
510 GOTO(cleanup, rc = -EPROTO);
512 memcpy(lvb, tmplvb, lvb_len);
518 reply = req_capsule_server_get(&req->rq_pill, &RMF_DLM_REP);
520 GOTO(cleanup, rc = -EPROTO);
522 /* lock enqueued on the server */
525 lock_res_and_lock(lock);
526 old_hash_key = lock->l_remote_handle;
527 lock->l_remote_handle = reply->lock_handle;
529 /* Key change rehash lock in per-export hash with new key */
530 if (exp->exp_lock_hash)
531 cfs_hash_rehash_key(exp->exp_lock_hash, &old_hash_key,
532 &lock->l_remote_handle,
535 *flags = reply->lock_flags;
536 lock->l_flags |= reply->lock_flags & LDLM_INHERIT_FLAGS;
537 /* move NO_TIMEOUT flag to the lock to force ldlm_lock_match()
538 * to wait with no timeout as well */
539 lock->l_flags |= reply->lock_flags & LDLM_FL_NO_TIMEOUT;
540 unlock_res_and_lock(lock);
542 CDEBUG(D_INFO, "local: %p, remote cookie: "LPX64", flags: 0x%x\n",
543 lock, reply->lock_handle.cookie, *flags);
545 /* If enqueue returned a blocked lock but the completion handler has
546 * already run, then it fixed up the resource and we don't need to do it
548 if ((*flags) & LDLM_FL_LOCK_CHANGED) {
549 int newmode = reply->lock_desc.l_req_mode;
551 if (newmode && newmode != lock->l_req_mode) {
552 LDLM_DEBUG(lock, "server returned different mode %s",
553 ldlm_lockname[newmode]);
554 lock->l_req_mode = newmode;
557 if (memcmp(reply->lock_desc.l_resource.lr_name.name,
558 lock->l_resource->lr_name.name,
559 sizeof(struct ldlm_res_id))) {
560 CDEBUG(D_INFO, "remote intent success, locking "
561 "(%ld,%ld,%ld) instead of "
563 (long)reply->lock_desc.l_resource.lr_name.name[0],
564 (long)reply->lock_desc.l_resource.lr_name.name[1],
565 (long)reply->lock_desc.l_resource.lr_name.name[2],
566 (long)lock->l_resource->lr_name.name[0],
567 (long)lock->l_resource->lr_name.name[1],
568 (long)lock->l_resource->lr_name.name[2]);
570 rc = ldlm_lock_change_resource(ns, lock,
571 &reply->lock_desc.l_resource.lr_name);
572 if (rc || lock->l_resource == NULL)
573 GOTO(cleanup, rc = -ENOMEM);
574 LDLM_DEBUG(lock, "client-side enqueue, new resource");
577 if (!(type == LDLM_IBITS && !(exp->exp_connect_flags &
579 lock->l_policy_data =
580 reply->lock_desc.l_policy_data;
581 if (type != LDLM_PLAIN)
582 LDLM_DEBUG(lock,"client-side enqueue, new policy data");
585 if ((*flags) & LDLM_FL_AST_SENT ||
586 /* Cancel extent locks as soon as possible on a liblustre client,
587 * because it cannot handle asynchronous ASTs robustly (see
589 (LIBLUSTRE_CLIENT && type == LDLM_EXTENT)) {
590 lock_res_and_lock(lock);
591 lock->l_flags |= LDLM_FL_CBPENDING | LDLM_FL_BL_AST;
592 unlock_res_and_lock(lock);
593 LDLM_DEBUG(lock, "enqueue reply includes blocking AST");
596 /* If the lock has already been granted by a completion AST, don't
597 * clobber the LVB with an older one. */
598 if (lvb_len && (lock->l_req_mode != lock->l_granted_mode)) {
601 req_capsule_set_size(&req->rq_pill, &RMF_DLM_LVB, RCL_SERVER,
603 tmplvb = req_capsule_server_get(&req->rq_pill,
606 GOTO(cleanup, rc = -EPROTO);
607 memcpy(lock->l_lvb_data, tmplvb, lvb_len);
611 rc = ldlm_lock_enqueue(ns, &lock, NULL, flags);
612 if (lock->l_completion_ast != NULL) {
613 int err = lock->l_completion_ast(lock, *flags, NULL);
616 if (rc && type != LDLM_FLOCK) /* bug 9425, bug 10250 */
621 if (lvb_len && lvb != NULL) {
622 /* Copy the LVB here, and not earlier, because the completion
623 * AST (if any) can override what we got in the reply */
624 memcpy(lvb, lock->l_lvb_data, lvb_len);
627 LDLM_DEBUG(lock, "client-side enqueue END");
630 if (cleanup_phase == 1 && rc)
631 failed_lock_cleanup(ns, lock, lockh, mode);
632 /* Put lock 2 times, the second reference is held by ldlm_cli_enqueue */
634 LDLM_LOCK_RELEASE(lock);
638 /* PAGE_SIZE-512 is to allow TCP/IP and LNET headers to fit into
639 * a single page on the send/receive side. XXX: 512 should be changed
640 * to more adequate value. */
641 static inline int ldlm_req_handles_avail(int req_size, int off)
645 avail = min_t(int, LDLM_MAXREQSIZE, CFS_PAGE_SIZE - 512) - req_size;
646 if (likely(avail >= 0))
647 avail /= (int)sizeof(struct lustre_handle);
650 avail += LDLM_LOCKREQ_HANDLES - off;
655 static inline int ldlm_capsule_handles_avail(struct req_capsule *pill,
656 enum req_location loc,
659 int size = req_capsule_msg_size(pill, loc);
660 return ldlm_req_handles_avail(size, off);
663 static inline int ldlm_format_handles_avail(struct obd_import *imp,
664 const struct req_format *fmt,
665 enum req_location loc, int off)
667 int size = req_capsule_fmt_size(imp->imp_msg_magic, fmt, loc);
668 return ldlm_req_handles_avail(size, off);
671 /* Cancel lru locks and pack them into the enqueue request. Pack there the given
672 * @count locks in @cancels. */
673 int ldlm_prep_elc_req(struct obd_export *exp, struct ptlrpc_request *req,
674 int version, int opc, int canceloff,
675 struct list_head *cancels, int count)
677 struct ldlm_namespace *ns = exp->exp_obd->obd_namespace;
678 struct req_capsule *pill = &req->rq_pill;
679 struct ldlm_request *dlm = NULL;
680 int flags, avail, to_free, bufcount, pack = 0;
687 if (exp_connect_cancelset(exp)) {
688 /* Estimate the amount of available space in the request. */
689 bufcount = req_capsule_filled_sizes(pill, RCL_CLIENT);
690 avail = ldlm_capsule_handles_avail(pill, RCL_CLIENT, canceloff);
692 flags = ns_connect_lru_resize(ns) ?
693 LDLM_CANCEL_LRUR : LDLM_CANCEL_AGED;
694 to_free = !ns_connect_lru_resize(ns) &&
695 opc == LDLM_ENQUEUE ? 1 : 0;
697 /* Cancel lru locks here _only_ if the server supports
698 * EARLY_CANCEL. Otherwise we have to send extra CANCEL
699 * rpc, what will make us slower. */
701 count += ldlm_cancel_lru_local(ns, cancels, to_free,
702 avail - count, 0, flags);
707 req_capsule_set_size(pill, &RMF_DLM_REQ, RCL_CLIENT,
708 ldlm_request_bufsize(pack, opc));
711 rc = ptlrpc_request_pack(req, version, opc);
713 ldlm_lock_list_put(cancels, l_bl_ast, count);
717 if (exp_connect_cancelset(exp)) {
719 dlm = req_capsule_client_get(pill, &RMF_DLM_REQ);
721 /* Skip first lock handler in ldlm_request_pack(),
722 * this method will incrment @lock_count according
723 * to the lock handle amount actually written to
725 dlm->lock_count = canceloff;
727 /* Pack into the request @pack lock handles. */
728 ldlm_cli_cancel_list(cancels, pack, req, 0);
729 /* Prepare and send separate cancel rpc for others. */
730 ldlm_cli_cancel_list(cancels, count - pack, NULL, 0);
732 ldlm_lock_list_put(cancels, l_bl_ast, count);
737 int ldlm_prep_enqueue_req(struct obd_export *exp, struct ptlrpc_request *req,
738 struct list_head *cancels, int count)
740 return ldlm_prep_elc_req(exp, req, LUSTRE_DLM_VERSION, LDLM_ENQUEUE,
741 LDLM_ENQUEUE_CANCEL_OFF, cancels, count);
744 /* If a request has some specific initialisation it is passed in @reqp,
745 * otherwise it is created in ldlm_cli_enqueue.
747 * Supports sync and async requests, pass @async flag accordingly. If a
748 * request was created in ldlm_cli_enqueue and it is the async request,
749 * pass it to the caller in @reqp. */
750 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
751 struct ldlm_enqueue_info *einfo,
752 const struct ldlm_res_id *res_id,
753 ldlm_policy_data_t *policy, int *flags,
754 void *lvb, __u32 lvb_len, struct lustre_handle *lockh,
757 struct ldlm_namespace *ns = exp->exp_obd->obd_namespace;
758 struct ldlm_lock *lock;
759 struct ldlm_request *body;
760 int is_replay = *flags & LDLM_FL_REPLAY;
761 int req_passed_in = 1;
763 struct ptlrpc_request *req;
766 LASSERT(exp != NULL);
768 /* If we're replaying this lock, just check some invariants.
769 * If we're creating a new lock, get everything all setup nice. */
771 lock = ldlm_handle2lock_long(lockh, 0);
772 LASSERT(lock != NULL);
773 LDLM_DEBUG(lock, "client-side enqueue START");
774 LASSERT(exp == lock->l_conn_export);
776 const struct ldlm_callback_suite cbs = {
777 .lcs_completion = einfo->ei_cb_cp,
778 .lcs_blocking = einfo->ei_cb_bl,
779 .lcs_glimpse = einfo->ei_cb_gl,
780 .lcs_weigh = einfo->ei_cb_wg
782 lock = ldlm_lock_create(ns, res_id, einfo->ei_type,
783 einfo->ei_mode, &cbs, einfo->ei_cbdata,
787 /* for the local lock, add the reference */
788 ldlm_lock_addref_internal(lock, einfo->ei_mode);
789 ldlm_lock2handle(lock, lockh);
790 if (policy != NULL) {
791 /* INODEBITS_INTEROP: If the server does not support
792 * inodebits, we will request a plain lock in the
793 * descriptor (ldlm_lock2desc() below) but use an
794 * inodebits lock internally with both bits set.
796 if (einfo->ei_type == LDLM_IBITS &&
797 !(exp->exp_connect_flags & OBD_CONNECT_IBITS))
798 lock->l_policy_data.l_inodebits.bits =
799 MDS_INODELOCK_LOOKUP |
800 MDS_INODELOCK_UPDATE;
802 lock->l_policy_data = *policy;
805 if (einfo->ei_type == LDLM_EXTENT)
806 lock->l_req_extent = policy->l_extent;
807 LDLM_DEBUG(lock, "client-side enqueue START");
810 /* lock not sent to server yet */
812 if (reqp == NULL || *reqp == NULL) {
813 req = ptlrpc_request_alloc_pack(class_exp2cliimp(exp),
818 failed_lock_cleanup(ns, lock, lockh, einfo->ei_mode);
819 LDLM_LOCK_RELEASE(lock);
829 len = req_capsule_get_size(&req->rq_pill, &RMF_DLM_REQ,
831 LASSERTF(len >= sizeof(*body), "buflen[%d] = %d, not %d\n",
832 DLM_LOCKREQ_OFF, len, (int)sizeof(*body));
835 lock->l_conn_export = exp;
836 lock->l_export = NULL;
837 lock->l_blocking_ast = einfo->ei_cb_bl;
839 /* Dump lock data into the request buffer */
840 body = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
841 ldlm_lock2desc(lock, &body->lock_desc);
842 body->lock_flags = *flags;
843 body->lock_handle[0] = *lockh;
845 /* Continue as normal. */
846 if (!req_passed_in) {
848 req_capsule_extend(&req->rq_pill,
849 &RQF_LDLM_ENQUEUE_LVB);
850 req_capsule_set_size(&req->rq_pill, &RMF_DLM_LVB,
851 RCL_SERVER, lvb_len);
853 ptlrpc_request_set_replen(req);
857 * Liblustre client doesn't get extent locks, except for O_APPEND case
858 * where [0, OBD_OBJECT_EOF] lock is taken, or truncate, where
859 * [i_size, OBD_OBJECT_EOF] lock is taken.
861 LASSERT(ergo(LIBLUSTRE_CLIENT, einfo->ei_type != LDLM_EXTENT ||
862 policy->l_extent.end == OBD_OBJECT_EOF));
865 LASSERT(reqp != NULL);
869 LDLM_DEBUG(lock, "sending request");
871 rc = ptlrpc_queue_wait(req);
873 err = ldlm_cli_enqueue_fini(exp, req, einfo->ei_type, policy ? 1 : 0,
874 einfo->ei_mode, flags, lvb, lvb_len,
877 /* If ldlm_cli_enqueue_fini did not find the lock, we need to free
878 * one reference that we took */
880 LDLM_LOCK_RELEASE(lock);
884 if (!req_passed_in && req != NULL) {
885 ptlrpc_req_finished(req);
893 static int ldlm_cli_convert_local(struct ldlm_lock *lock, int new_mode,
896 struct ldlm_resource *res;
899 if (ns_is_client(lock->l_resource->lr_namespace)) {
900 CERROR("Trying to cancel local lock\n");
903 LDLM_DEBUG(lock, "client-side local convert");
905 res = ldlm_lock_convert(lock, new_mode, flags);
907 ldlm_reprocess_all(res);
912 LDLM_DEBUG(lock, "client-side local convert handler END");
917 /* FIXME: one of ldlm_cli_convert or the server side should reject attempted
918 * conversion of locks which are on the waiting or converting queue */
919 /* Caller of this code is supposed to take care of lock readers/writers
921 int ldlm_cli_convert(struct lustre_handle *lockh, int new_mode, __u32 *flags)
923 struct ldlm_request *body;
924 struct ldlm_reply *reply;
925 struct ldlm_lock *lock;
926 struct ldlm_resource *res;
927 struct ptlrpc_request *req;
931 lock = ldlm_handle2lock(lockh);
938 if (lock->l_conn_export == NULL)
939 RETURN(ldlm_cli_convert_local(lock, new_mode, flags));
941 LDLM_DEBUG(lock, "client-side convert");
943 req = ptlrpc_request_alloc_pack(class_exp2cliimp(lock->l_conn_export),
944 &RQF_LDLM_CONVERT, LUSTRE_DLM_VERSION,
951 body = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
952 body->lock_handle[0] = lock->l_remote_handle;
954 body->lock_desc.l_req_mode = new_mode;
955 body->lock_flags = *flags;
958 ptlrpc_request_set_replen(req);
959 rc = ptlrpc_queue_wait(req);
963 reply = req_capsule_server_get(&req->rq_pill, &RMF_DLM_REP);
965 GOTO(out, rc = -EPROTO);
968 GOTO(out, rc = req->rq_status);
970 res = ldlm_lock_convert(lock, new_mode, &reply->lock_flags);
972 ldlm_reprocess_all(res);
973 /* Go to sleep until the lock is granted. */
974 /* FIXME: or cancelled. */
975 if (lock->l_completion_ast) {
976 rc = lock->l_completion_ast(lock, LDLM_FL_WAIT_NOREPROC,
987 ptlrpc_req_finished(req);
991 /* Cancel locks locally.
993 * LDLM_FL_LOCAL_ONLY if tere is no need in a CANCEL rpc to the server;
994 * LDLM_FL_CANCELING otherwise;
995 * LDLM_FL_BL_AST if there is a need in a separate CANCEL rpc. */
996 static int ldlm_cli_cancel_local(struct ldlm_lock *lock)
998 int rc = LDLM_FL_LOCAL_ONLY;
1001 if (lock->l_conn_export) {
1004 LDLM_DEBUG(lock, "client-side cancel");
1005 /* Set this flag to prevent others from getting new references*/
1006 lock_res_and_lock(lock);
1007 lock->l_flags |= LDLM_FL_CBPENDING;
1008 local_only = (lock->l_flags &
1009 (LDLM_FL_LOCAL_ONLY|LDLM_FL_CANCEL_ON_BLOCK));
1010 ldlm_cancel_callback(lock);
1011 rc = (lock->l_flags & LDLM_FL_BL_AST) ?
1012 LDLM_FL_BL_AST : LDLM_FL_CANCELING;
1013 unlock_res_and_lock(lock);
1016 CDEBUG(D_DLMTRACE, "not sending request (at caller's "
1018 rc = LDLM_FL_LOCAL_ONLY;
1020 ldlm_lock_cancel(lock);
1022 if (ns_is_client(lock->l_resource->lr_namespace)) {
1023 LDLM_ERROR(lock, "Trying to cancel local lock");
1026 LDLM_DEBUG(lock, "server-side local cancel");
1027 ldlm_lock_cancel(lock);
1028 ldlm_reprocess_all(lock->l_resource);
1034 /* Pack @count locks in @head into ldlm_request buffer at the offset @off,
1035 of the request @req. */
1036 static void ldlm_cancel_pack(struct ptlrpc_request *req,
1037 struct list_head *head, int count)
1039 struct ldlm_request *dlm;
1040 struct ldlm_lock *lock;
1041 int max, packed = 0;
1044 dlm = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
1045 LASSERT(dlm != NULL);
1047 /* Check the room in the request buffer. */
1048 max = req_capsule_get_size(&req->rq_pill, &RMF_DLM_REQ, RCL_CLIENT) -
1049 sizeof(struct ldlm_request);
1050 max /= sizeof(struct lustre_handle);
1051 max += LDLM_LOCKREQ_HANDLES;
1052 LASSERT(max >= dlm->lock_count + count);
1054 /* XXX: it would be better to pack lock handles grouped by resource.
1055 * so that the server cancel would call filter_lvbo_update() less
1057 list_for_each_entry(lock, head, l_bl_ast) {
1060 LASSERT(lock->l_conn_export);
1061 /* Pack the lock handle to the given request buffer. */
1062 LDLM_DEBUG(lock, "packing");
1063 dlm->lock_handle[dlm->lock_count++] = lock->l_remote_handle;
1066 CDEBUG(D_DLMTRACE, "%d locks packed\n", packed);
1070 /* Prepare and send a batched cancel rpc, it will include count lock handles
1071 * of locks given in @head. */
1072 int ldlm_cli_cancel_req(struct obd_export *exp, struct list_head *cancels,
1073 int count, int flags)
1075 struct ptlrpc_request *req = NULL;
1076 struct obd_import *imp;
1081 LASSERT(exp != NULL);
1084 OBD_FAIL_TIMEOUT(OBD_FAIL_LDLM_PAUSE_CANCEL, obd_fail_val);
1086 if (OBD_FAIL_CHECK(OBD_FAIL_LDLM_CANCEL_RACE))
1089 free = ldlm_format_handles_avail(class_exp2cliimp(exp),
1090 &RQF_LDLM_CANCEL, RCL_CLIENT, 0);
1097 imp = class_exp2cliimp(exp);
1098 if (imp == NULL || imp->imp_invalid) {
1100 "skipping cancel on invalid import %p\n", imp);
1104 req = ptlrpc_request_alloc(imp, &RQF_LDLM_CANCEL);
1106 GOTO(out, rc = -ENOMEM);
1108 bufcount = req_capsule_filled_sizes(&req->rq_pill, RCL_CLIENT);
1109 req_capsule_set_size(&req->rq_pill, &RMF_DLM_REQ, RCL_CLIENT,
1110 ldlm_request_bufsize(count, LDLM_CANCEL));
1112 rc = ptlrpc_request_pack(req, LUSTRE_DLM_VERSION, LDLM_CANCEL);
1114 ptlrpc_request_free(req);
1117 req->rq_no_resend = 1;
1118 req->rq_no_delay = 1;
1120 req->rq_request_portal = LDLM_CANCEL_REQUEST_PORTAL;
1121 req->rq_reply_portal = LDLM_CANCEL_REPLY_PORTAL;
1122 ptlrpc_at_set_req_timeout(req);
1124 ldlm_cancel_pack(req, cancels, count);
1126 ptlrpc_request_set_replen(req);
1127 if (flags & LDLM_FL_ASYNC) {
1128 ptlrpcd_add_req(req, PSCOPE_OTHER);
1132 rc = ptlrpc_queue_wait(req);
1135 CDEBUG(D_DLMTRACE, "client/server (nid %s) "
1136 "out of sync -- not fatal\n",
1137 libcfs_nid2str(req->rq_import->
1138 imp_connection->c_peer.nid));
1140 } else if (rc == -ETIMEDOUT && /* check there was no reconnect*/
1141 req->rq_import_generation == imp->imp_generation) {
1142 ptlrpc_req_finished(req);
1144 } else if (rc != ELDLM_OK) {
1145 CERROR("Got rc %d from cancel RPC: canceling "
1153 ptlrpc_req_finished(req);
1156 return sent ? sent : rc;
1159 static inline struct ldlm_pool *ldlm_imp2pl(struct obd_import *imp)
1161 LASSERT(imp != NULL);
1162 return &imp->imp_obd->obd_namespace->ns_pool;
1166 * Update client's obd pool related fields with new SLV and Limit from \a req.
1168 int ldlm_cli_update_pool(struct ptlrpc_request *req)
1170 struct obd_device *obd;
1171 __u64 old_slv, new_slv;
1174 if (unlikely(!req->rq_import || !req->rq_import->imp_obd ||
1175 !imp_connect_lru_resize(req->rq_import)))
1178 * Do nothing for corner cases.
1184 * In some cases RPC may contain slv and limit zeroed out. This is
1185 * the case when server does not support lru resize feature. This is
1186 * also possible in some recovery cases when server side reqs have no
1187 * ref to obd export and thus access to server side namespace is no
1190 if (lustre_msg_get_slv(req->rq_repmsg) == 0 ||
1191 lustre_msg_get_limit(req->rq_repmsg) == 0) {
1192 DEBUG_REQ(D_HA, req, "Zero SLV or Limit found "
1193 "(SLV: "LPU64", Limit: %u)",
1194 lustre_msg_get_slv(req->rq_repmsg),
1195 lustre_msg_get_limit(req->rq_repmsg));
1199 new_limit = lustre_msg_get_limit(req->rq_repmsg);
1200 new_slv = lustre_msg_get_slv(req->rq_repmsg);
1201 obd = req->rq_import->imp_obd;
1204 * Set new SLV and Limit to obd fields to make accessible for pool
1205 * thread. We do not access obd_namespace and pool directly here
1206 * as there is no reliable way to make sure that they are still
1207 * alive in cleanup time. Evil races are possible which may cause
1208 * oops in that time.
1210 write_lock(&obd->obd_pool_lock);
1211 old_slv = obd->obd_pool_slv;
1212 obd->obd_pool_slv = new_slv;
1213 obd->obd_pool_limit = new_limit;
1214 write_unlock(&obd->obd_pool_lock);
1218 EXPORT_SYMBOL(ldlm_cli_update_pool);
1220 int ldlm_cli_cancel(struct lustre_handle *lockh)
1222 struct obd_export *exp;
1223 int avail, flags, count = 1, rc = 0;
1224 struct ldlm_namespace *ns;
1225 struct ldlm_lock *lock;
1226 CFS_LIST_HEAD(cancels);
1229 /* concurrent cancels on the same handle can happen */
1230 lock = ldlm_handle2lock_long(lockh, LDLM_FL_CANCELING);
1232 LDLM_DEBUG_NOLOCK("lock is already being destroyed\n");
1236 rc = ldlm_cli_cancel_local(lock);
1237 if (rc < 0 || rc == LDLM_FL_LOCAL_ONLY) {
1238 LDLM_LOCK_RELEASE(lock);
1239 RETURN(rc < 0 ? rc : 0);
1241 /* Even if the lock is marked as LDLM_FL_BL_AST, this is a LDLM_CANCEL
1242 * rpc which goes to canceld portal, so we can cancel other lru locks
1243 * here and send them all as one LDLM_CANCEL rpc. */
1244 LASSERT(list_empty(&lock->l_bl_ast));
1245 list_add(&lock->l_bl_ast, &cancels);
1247 exp = lock->l_conn_export;
1248 if (exp_connect_cancelset(exp)) {
1249 avail = ldlm_format_handles_avail(class_exp2cliimp(exp),
1254 ns = lock->l_resource->lr_namespace;
1255 flags = ns_connect_lru_resize(ns) ?
1256 LDLM_CANCEL_LRUR : LDLM_CANCEL_AGED;
1257 count += ldlm_cancel_lru_local(ns, &cancels, 0, avail - 1,
1258 LDLM_FL_BL_AST, flags);
1260 ldlm_cli_cancel_list(&cancels, count, NULL, 0);
1264 /* XXX until we will have compound requests and can cut cancels from generic rpc
1265 * we need send cancels with LDLM_FL_BL_AST flag as separate rpc */
1266 static int ldlm_cancel_list(struct list_head *cancels, int count, int flags)
1268 CFS_LIST_HEAD(head);
1269 struct ldlm_lock *lock, *next;
1270 int left = 0, bl_ast = 0, rc;
1273 list_for_each_entry_safe(lock, next, cancels, l_bl_ast) {
1277 if (flags & LDLM_FL_LOCAL_ONLY) {
1278 rc = LDLM_FL_LOCAL_ONLY;
1279 ldlm_lock_cancel(lock);
1281 rc = ldlm_cli_cancel_local(lock);
1283 if (!(flags & LDLM_FL_BL_AST) && (rc == LDLM_FL_BL_AST)) {
1284 LDLM_DEBUG(lock, "Cancel lock separately");
1285 list_del_init(&lock->l_bl_ast);
1286 list_add(&lock->l_bl_ast, &head);
1290 if (rc == LDLM_FL_LOCAL_ONLY) {
1291 /* CANCEL RPC should not be sent to server. */
1292 list_del_init(&lock->l_bl_ast);
1293 LDLM_LOCK_RELEASE(lock);
1300 ldlm_cli_cancel_list(&head, bl_ast, NULL, 0);
1307 * Callback function for lru-resize policy. Makes decision whether to keep
1308 * \a lock in LRU for current \a LRU size \a unused, added in current scan
1309 * \a added and number of locks to be preferably canceled \a count.
1311 * \retval LDLM_POLICY_KEEP_LOCK keep lock in LRU in stop scanning
1313 * \retval LDLM_POLICY_CANCEL_LOCK cancel lock from LRU
1315 static ldlm_policy_res_t ldlm_cancel_lrur_policy(struct ldlm_namespace *ns,
1316 struct ldlm_lock *lock,
1317 int unused, int added,
1320 cfs_time_t cur = cfs_time_current();
1321 struct ldlm_pool *pl = &ns->ns_pool;
1326 * Stop lru processing when we reached passed @count or checked all
1329 if (count && added >= count)
1330 return LDLM_POLICY_KEEP_LOCK;
1332 slv = ldlm_pool_get_slv(pl);
1333 lvf = ldlm_pool_get_lvf(pl);
1334 la = cfs_duration_sec(cfs_time_sub(cur,
1335 lock->l_last_used));
1338 * Stop when slv is not yet come from server or lv is smaller than
1341 lv = lvf * la * unused;
1344 * Inform pool about current CLV to see it via proc.
1346 ldlm_pool_set_clv(pl, lv);
1347 return (slv == 1 || lv < slv) ?
1348 LDLM_POLICY_KEEP_LOCK : LDLM_POLICY_CANCEL_LOCK;
1352 * Callback function for proc used policy. Makes decision whether to keep
1353 * \a lock in LRU for current \a LRU size \a unused, added in current scan
1354 * \a added and number of locks to be preferably canceled \a count.
1356 * \retval LDLM_POLICY_KEEP_LOCK keep lock in LRU in stop scanning
1358 * \retval LDLM_POLICY_CANCEL_LOCK cancel lock from LRU
1360 static ldlm_policy_res_t ldlm_cancel_passed_policy(struct ldlm_namespace *ns,
1361 struct ldlm_lock *lock,
1362 int unused, int added,
1366 * Stop lru processing when we reached passed @count or checked all
1369 return (added >= count) ?
1370 LDLM_POLICY_KEEP_LOCK : LDLM_POLICY_CANCEL_LOCK;
1374 * Callback function for aged policy. Makes decision whether to keep
1375 * \a lock in LRU for current \a LRU size \a unused, added in current scan
1376 * \a added and number of locks to be preferably canceled \a count.
1378 * \retval LDLM_POLICY_KEEP_LOCK keep lock in LRU in stop scanning
1380 * \retval LDLM_POLICY_CANCEL_LOCK cancel lock from LRU
1382 static ldlm_policy_res_t ldlm_cancel_aged_policy(struct ldlm_namespace *ns,
1383 struct ldlm_lock *lock,
1384 int unused, int added,
1388 * Stop lru processing if young lock is found and we reached passed
1391 return ((added >= count) &&
1392 cfs_time_before(cfs_time_current(),
1393 cfs_time_add(lock->l_last_used,
1395 LDLM_POLICY_KEEP_LOCK : LDLM_POLICY_CANCEL_LOCK;
1399 * Callback function for default policy. Makes decision whether to keep
1400 * \a lock in LRU for current \a LRU size \a unused, added in current scan
1401 * \a added and number of locks to be preferably canceled \a count.
1403 * \retval LDLM_POLICY_KEEP_LOCK keep lock in LRU in stop scanning
1405 * \retval LDLM_POLICY_CANCEL_LOCK cancel lock from LRU
1407 static ldlm_policy_res_t ldlm_cancel_default_policy(struct ldlm_namespace *ns,
1408 struct ldlm_lock *lock,
1409 int unused, int added,
1413 * Stop lru processing when we reached passed @count or checked all
1416 return (added >= count) ?
1417 LDLM_POLICY_KEEP_LOCK : LDLM_POLICY_CANCEL_LOCK;
1420 typedef ldlm_policy_res_t (*ldlm_cancel_lru_policy_t)(struct ldlm_namespace *,
1421 struct ldlm_lock *, int,
1424 static ldlm_cancel_lru_policy_t
1425 ldlm_cancel_lru_policy(struct ldlm_namespace *ns, int flags)
1427 if (ns_connect_lru_resize(ns)) {
1428 if (flags & LDLM_CANCEL_SHRINK)
1429 /* We kill passed number of old locks. */
1430 return ldlm_cancel_passed_policy;
1431 else if (flags & LDLM_CANCEL_LRUR)
1432 return ldlm_cancel_lrur_policy;
1433 else if (flags & LDLM_CANCEL_PASSED)
1434 return ldlm_cancel_passed_policy;
1436 if (flags & LDLM_CANCEL_AGED)
1437 return ldlm_cancel_aged_policy;
1440 return ldlm_cancel_default_policy;
1443 /* - Free space in lru for @count new locks,
1444 * redundant unused locks are canceled locally;
1445 * - also cancel locally unused aged locks;
1446 * - do not cancel more than @max locks;
1447 * - GET the found locks and add them into the @cancels list.
1449 * A client lock can be added to the l_bl_ast list only when it is
1450 * marked LDLM_FL_CANCELING. Otherwise, somebody is already doing CANCEL.
1451 * There are the following use cases: ldlm_cancel_resource_local(),
1452 * ldlm_cancel_lru_local() and ldlm_cli_cancel(), which check&set this
1453 * flag properly. As any attempt to cancel a lock rely on this flag,
1454 * l_bl_ast list is accessed later without any special locking.
1456 * Calling policies for enabled lru resize:
1457 * ----------------------------------------
1458 * flags & LDLM_CANCEL_LRUR - use lru resize policy (SLV from server) to
1459 * cancel not more than @count locks;
1461 * flags & LDLM_CANCEL_PASSED - cancel @count number of old locks (located at
1462 * the beginning of lru list);
1464 * flags & LDLM_CANCEL_SHRINK - cancel not more than @count locks according to
1465 * memory pressre policy function;
1467 * flags & LDLM_CANCEL_AGED - cancel alocks according to "aged policy".
1469 int ldlm_cancel_lru_local(struct ldlm_namespace *ns, struct list_head *cancels,
1470 int count, int max, int cancel_flags, int flags)
1472 ldlm_cancel_lru_policy_t pf;
1473 struct ldlm_lock *lock, *next;
1474 int added = 0, unused;
1477 spin_lock(&ns->ns_unused_lock);
1478 unused = ns->ns_nr_unused;
1480 if (!ns_connect_lru_resize(ns))
1481 count += unused - ns->ns_max_unused;
1483 pf = ldlm_cancel_lru_policy(ns, flags);
1484 LASSERT(pf != NULL);
1486 while (!list_empty(&ns->ns_unused_list)) {
1487 /* For any flags, stop scanning if @max is reached. */
1488 if (max && added >= max)
1491 list_for_each_entry_safe(lock, next, &ns->ns_unused_list, l_lru){
1492 /* No locks which got blocking requests. */
1493 LASSERT(!(lock->l_flags & LDLM_FL_BL_AST));
1495 /* Somebody is already doing CANCEL. No need in this
1496 * lock in lru, do not traverse it again. */
1497 if (!(lock->l_flags & LDLM_FL_CANCELING))
1500 ldlm_lock_remove_from_lru_nolock(lock);
1502 if (&lock->l_lru == &ns->ns_unused_list)
1505 LDLM_LOCK_GET(lock);
1506 spin_unlock(&ns->ns_unused_lock);
1507 lu_ref_add(&lock->l_reference, __FUNCTION__, cfs_current());
1509 /* Pass the lock through the policy filter and see if it
1510 * should stay in lru.
1512 * Even for shrinker policy we stop scanning if
1513 * we find a lock that should stay in the cache.
1514 * We should take into account lock age anyway
1515 * as new lock even if it is small of weight is
1516 * valuable resource.
1518 * That is, for shrinker policy we drop only
1519 * old locks, but additionally chose them by
1520 * their weight. Big extent locks will stay in
1522 if (pf(ns, lock, unused, added, count) ==
1523 LDLM_POLICY_KEEP_LOCK) {
1524 lu_ref_del(&lock->l_reference,
1525 __FUNCTION__, cfs_current());
1526 LDLM_LOCK_RELEASE(lock);
1527 spin_lock(&ns->ns_unused_lock);
1531 lock_res_and_lock(lock);
1532 /* Check flags again under the lock. */
1533 if ((lock->l_flags & LDLM_FL_CANCELING) ||
1534 (ldlm_lock_remove_from_lru(lock) == 0)) {
1535 /* other thread is removing lock from lru or
1536 * somebody is already doing CANCEL or
1537 * there is a blocking request which will send
1538 * cancel by itseft or the lock is matched
1539 * is already not unused. */
1540 unlock_res_and_lock(lock);
1541 lu_ref_del(&lock->l_reference,
1542 __FUNCTION__, cfs_current());
1543 LDLM_LOCK_RELEASE(lock);
1544 spin_lock(&ns->ns_unused_lock);
1547 LASSERT(!lock->l_readers && !lock->l_writers);
1549 /* If we have chosen to cancel this lock voluntarily, we
1550 * better send cancel notification to server, so that it
1551 * frees appropriate state. This might lead to a race
1552 * where while we are doing cancel here, server is also
1553 * silently cancelling this lock. */
1554 lock->l_flags &= ~LDLM_FL_CANCEL_ON_BLOCK;
1556 /* Setting the CBPENDING flag is a little misleading,
1557 * but prevents an important race; namely, once
1558 * CBPENDING is set, the lock can accumulate no more
1559 * readers/writers. Since readers and writers are
1560 * already zero here, ldlm_lock_decref() won't see
1561 * this flag and call l_blocking_ast */
1562 lock->l_flags |= LDLM_FL_CBPENDING | LDLM_FL_CANCELING;
1564 /* We can't re-add to l_lru as it confuses the
1565 * refcounting in ldlm_lock_remove_from_lru() if an AST
1566 * arrives after we drop ns_lock below. We use l_bl_ast
1567 * and can't use l_pending_chain as it is used both on
1568 * server and client nevertheless bug 5666 says it is
1569 * used only on server */
1570 LASSERT(list_empty(&lock->l_bl_ast));
1571 list_add(&lock->l_bl_ast, cancels);
1572 unlock_res_and_lock(lock);
1573 lu_ref_del(&lock->l_reference, __FUNCTION__, cfs_current());
1574 spin_lock(&ns->ns_unused_lock);
1578 spin_unlock(&ns->ns_unused_lock);
1579 RETURN(ldlm_cancel_list(cancels, added, cancel_flags));
1582 /* when called with LDLM_ASYNC the blocking callback will be handled
1583 * in a thread and this function will return after the thread has been
1584 * asked to call the callback. when called with LDLM_SYNC the blocking
1585 * callback will be performed in this function. */
1586 int ldlm_cancel_lru(struct ldlm_namespace *ns, int nr, ldlm_sync_t sync,
1589 CFS_LIST_HEAD(cancels);
1594 sync = LDLM_SYNC; /* force to be sync in user space */
1596 count = ldlm_cancel_lru_local(ns, &cancels, nr, 0, 0, flags);
1597 if (sync == LDLM_ASYNC) {
1598 rc = ldlm_bl_to_thread_list(ns, NULL, &cancels, count);
1603 /* If an error occured in ASYNC mode, or this is SYNC mode,
1604 * cancel the list. */
1605 ldlm_cli_cancel_list(&cancels, count, NULL, 0);
1609 /* Find and cancel locally unused locks found on resource, matched to the
1610 * given policy, mode. GET the found locks and add them into the @cancels
1612 int ldlm_cancel_resource_local(struct ldlm_resource *res,
1613 struct list_head *cancels,
1614 ldlm_policy_data_t *policy,
1615 ldlm_mode_t mode, int lock_flags,
1616 int cancel_flags, void *opaque)
1618 struct ldlm_lock *lock;
1623 list_for_each_entry(lock, &res->lr_granted, l_res_link) {
1624 if (opaque != NULL && lock->l_ast_data != opaque) {
1625 LDLM_ERROR(lock, "data %p doesn't match opaque %p",
1626 lock->l_ast_data, opaque);
1631 if (lock->l_readers || lock->l_writers) {
1632 if (cancel_flags & LDLM_FL_WARN) {
1633 LDLM_ERROR(lock, "lock in use");
1639 /* If somebody is already doing CANCEL, or blocking ast came,
1640 * skip this lock. */
1641 if (lock->l_flags & LDLM_FL_BL_AST ||
1642 lock->l_flags & LDLM_FL_CANCELING)
1645 if (lockmode_compat(lock->l_granted_mode, mode))
1648 /* If policy is given and this is IBITS lock, add to list only
1649 * those locks that match by policy. */
1650 if (policy && (lock->l_resource->lr_type == LDLM_IBITS) &&
1651 !(lock->l_policy_data.l_inodebits.bits &
1652 policy->l_inodebits.bits))
1655 /* See CBPENDING comment in ldlm_cancel_lru */
1656 lock->l_flags |= LDLM_FL_CBPENDING | LDLM_FL_CANCELING |
1659 LASSERT(list_empty(&lock->l_bl_ast));
1660 list_add(&lock->l_bl_ast, cancels);
1661 LDLM_LOCK_GET(lock);
1666 RETURN(ldlm_cancel_list(cancels, count, cancel_flags));
1669 /* If @req is NULL, send CANCEL request to server with handles of locks
1670 * in the @cancels. If EARLY_CANCEL is not supported, send CANCEL requests
1671 * separately per lock.
1672 * If @req is not NULL, put handles of locks in @cancels into the request
1673 * buffer at the offset @off.
1674 * Destroy @cancels at the end. */
1675 int ldlm_cli_cancel_list(struct list_head *cancels, int count,
1676 struct ptlrpc_request *req, int flags)
1678 struct ldlm_lock *lock;
1682 if (list_empty(cancels) || count == 0)
1685 /* XXX: requests (both batched and not) could be sent in parallel.
1686 * Usually it is enough to have just 1 RPC, but it is possible that
1687 * there are to many locks to be cancelled in LRU or on a resource.
1688 * It would also speed up the case when the server does not support
1691 LASSERT(!list_empty(cancels));
1692 lock = list_entry(cancels->next, struct ldlm_lock, l_bl_ast);
1693 LASSERT(lock->l_conn_export);
1695 if (exp_connect_cancelset(lock->l_conn_export)) {
1698 ldlm_cancel_pack(req, cancels, count);
1700 res = ldlm_cli_cancel_req(lock->l_conn_export,
1704 res = ldlm_cli_cancel_req(lock->l_conn_export,
1709 CERROR("ldlm_cli_cancel_list: %d\n", res);
1714 ldlm_lock_list_put(cancels, l_bl_ast, res);
1716 LASSERT(count == 0);
1720 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
1721 const struct ldlm_res_id *res_id,
1722 ldlm_policy_data_t *policy,
1723 ldlm_mode_t mode, int flags, void *opaque)
1725 struct ldlm_resource *res;
1726 CFS_LIST_HEAD(cancels);
1731 res = ldlm_resource_get(ns, NULL, res_id, 0, 0);
1733 /* This is not a problem. */
1734 CDEBUG(D_INFO, "No resource "LPU64"\n", res_id->name[0]);
1738 LDLM_RESOURCE_ADDREF(res);
1739 count = ldlm_cancel_resource_local(res, &cancels, policy, mode,
1741 rc = ldlm_cli_cancel_list(&cancels, count, NULL, flags);
1743 CERROR("ldlm_cli_cancel_unused_resource: %d\n", rc);
1745 LDLM_RESOURCE_DELREF(res);
1746 ldlm_resource_putref(res);
1750 static inline int have_no_nsresource(struct ldlm_namespace *ns)
1752 int no_resource = 0;
1754 spin_lock(&ns->ns_hash_lock);
1755 if (ns->ns_resources == 0)
1757 spin_unlock(&ns->ns_hash_lock);
1759 RETURN(no_resource);
1762 /* Cancel all locks on a namespace (or a specific resource, if given)
1763 * that have 0 readers/writers.
1765 * If flags & LDLM_FL_LOCAL_ONLY, throw the locks away without trying
1766 * to notify the server. */
1767 int ldlm_cli_cancel_unused(struct ldlm_namespace *ns,
1768 const struct ldlm_res_id *res_id,
1769 int flags, void *opaque)
1778 RETURN(ldlm_cli_cancel_unused_resource(ns, res_id, NULL,
1782 spin_lock(&ns->ns_hash_lock);
1783 for (i = 0; i < RES_HASH_SIZE; i++) {
1784 struct list_head *tmp;
1785 tmp = ns->ns_hash[i].next;
1786 while (tmp != &(ns->ns_hash[i])) {
1787 struct ldlm_resource *res;
1790 res = list_entry(tmp, struct ldlm_resource, lr_hash);
1791 ldlm_resource_getref(res);
1792 spin_unlock(&ns->ns_hash_lock);
1794 LDLM_RESOURCE_ADDREF(res);
1795 rc = ldlm_cli_cancel_unused_resource(ns, &res->lr_name,
1800 CERROR("ldlm_cli_cancel_unused ("LPU64"): %d\n",
1801 res->lr_name.name[0], rc);
1803 LDLM_RESOURCE_DELREF(res);
1804 spin_lock(&ns->ns_hash_lock);
1806 ldlm_resource_putref_locked(res);
1809 spin_unlock(&ns->ns_hash_lock);
1814 /* Lock iterators. */
1816 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
1819 struct list_head *tmp, *next;
1820 struct ldlm_lock *lock;
1821 int rc = LDLM_ITER_CONTINUE;
1826 RETURN(LDLM_ITER_CONTINUE);
1829 list_for_each_safe(tmp, next, &res->lr_granted) {
1830 lock = list_entry(tmp, struct ldlm_lock, l_res_link);
1832 if (iter(lock, closure) == LDLM_ITER_STOP)
1833 GOTO(out, rc = LDLM_ITER_STOP);
1836 list_for_each_safe(tmp, next, &res->lr_converting) {
1837 lock = list_entry(tmp, struct ldlm_lock, l_res_link);
1839 if (iter(lock, closure) == LDLM_ITER_STOP)
1840 GOTO(out, rc = LDLM_ITER_STOP);
1843 list_for_each_safe(tmp, next, &res->lr_waiting) {
1844 lock = list_entry(tmp, struct ldlm_lock, l_res_link);
1846 if (iter(lock, closure) == LDLM_ITER_STOP)
1847 GOTO(out, rc = LDLM_ITER_STOP);
1854 struct iter_helper_data {
1855 ldlm_iterator_t iter;
1859 static int ldlm_iter_helper(struct ldlm_lock *lock, void *closure)
1861 struct iter_helper_data *helper = closure;
1862 return helper->iter(lock, helper->closure);
1865 static int ldlm_res_iter_helper(struct ldlm_resource *res, void *closure)
1867 return ldlm_resource_foreach(res, ldlm_iter_helper, closure);
1870 int ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
1873 struct iter_helper_data helper = { iter: iter, closure: closure };
1874 return ldlm_namespace_foreach_res(ns, ldlm_res_iter_helper, &helper);
1877 int ldlm_namespace_foreach_res(struct ldlm_namespace *ns,
1878 ldlm_res_iterator_t iter, void *closure)
1880 int i, rc = LDLM_ITER_CONTINUE;
1881 struct ldlm_resource *res;
1882 struct list_head *tmp;
1885 spin_lock(&ns->ns_hash_lock);
1886 for (i = 0; i < RES_HASH_SIZE; i++) {
1887 tmp = ns->ns_hash[i].next;
1888 while (tmp != &(ns->ns_hash[i])) {
1889 res = list_entry(tmp, struct ldlm_resource, lr_hash);
1890 ldlm_resource_getref(res);
1891 spin_unlock(&ns->ns_hash_lock);
1892 LDLM_RESOURCE_ADDREF(res);
1894 rc = iter(res, closure);
1896 LDLM_RESOURCE_DELREF(res);
1897 spin_lock(&ns->ns_hash_lock);
1899 ldlm_resource_putref_locked(res);
1900 if (rc == LDLM_ITER_STOP)
1905 spin_unlock(&ns->ns_hash_lock);
1909 /* non-blocking function to manipulate a lock whose cb_data is being put away.*/
1910 void ldlm_resource_iterate(struct ldlm_namespace *ns,
1911 const struct ldlm_res_id *res_id,
1912 ldlm_iterator_t iter, void *data)
1914 struct ldlm_resource *res;
1918 CERROR("must pass in namespace\n");
1922 res = ldlm_resource_get(ns, NULL, res_id, 0, 0);
1928 LDLM_RESOURCE_ADDREF(res);
1929 ldlm_resource_foreach(res, iter, data);
1930 LDLM_RESOURCE_DELREF(res);
1931 ldlm_resource_putref(res);
1937 static int ldlm_chain_lock_for_replay(struct ldlm_lock *lock, void *closure)
1939 struct list_head *list = closure;
1941 /* we use l_pending_chain here, because it's unused on clients. */
1942 LASSERTF(list_empty(&lock->l_pending_chain),"lock %p next %p prev %p\n",
1943 lock, &lock->l_pending_chain.next,&lock->l_pending_chain.prev);
1944 /* bug 9573: don't replay locks left after eviction, or
1945 * bug 17614: locks being actively cancelled. Get a reference
1946 * on a lock so that it does not disapear under us (e.g. due to cancel)
1948 if (!(lock->l_flags & (LDLM_FL_FAILED|LDLM_FL_CANCELING))) {
1949 list_add(&lock->l_pending_chain, list);
1950 LDLM_LOCK_GET(lock);
1953 return LDLM_ITER_CONTINUE;
1956 static int replay_lock_interpret(const struct lu_env *env,
1957 struct ptlrpc_request *req,
1958 struct ldlm_async_args *aa, int rc)
1960 struct lustre_handle old_hash_key;
1961 struct ldlm_lock *lock;
1962 struct ldlm_reply *reply;
1963 struct obd_export *exp;
1966 atomic_dec(&req->rq_import->imp_replay_inflight);
1971 reply = req_capsule_server_get(&req->rq_pill, &RMF_DLM_REP);
1973 GOTO(out, rc = -EPROTO);
1975 lock = ldlm_handle2lock(&aa->lock_handle);
1977 CERROR("received replay ack for unknown local cookie "LPX64
1978 " remote cookie "LPX64 " from server %s id %s\n",
1979 aa->lock_handle.cookie, reply->lock_handle.cookie,
1980 req->rq_export->exp_client_uuid.uuid,
1981 libcfs_id2str(req->rq_peer));
1982 GOTO(out, rc = -ESTALE);
1985 old_hash_key = lock->l_remote_handle;
1986 lock->l_remote_handle = reply->lock_handle;
1988 /* Key change rehash lock in per-export hash with new key */
1989 exp = req->rq_export;
1990 if (exp && exp->exp_lock_hash)
1991 cfs_hash_rehash_key(exp->exp_lock_hash, &old_hash_key,
1992 &lock->l_remote_handle,
1995 LDLM_DEBUG(lock, "replayed lock:");
1996 ptlrpc_import_recovery_state_machine(req->rq_import);
1997 LDLM_LOCK_PUT(lock);
2000 ptlrpc_connect_import(req->rq_import, NULL);
2005 static int replay_one_lock(struct obd_import *imp, struct ldlm_lock *lock)
2007 struct ptlrpc_request *req;
2008 struct ldlm_async_args *aa;
2009 struct ldlm_request *body;
2014 /* Bug 11974: Do not replay a lock which is actively being canceled */
2015 if (lock->l_flags & LDLM_FL_CANCELING) {
2016 LDLM_DEBUG(lock, "Not replaying canceled lock:");
2020 /* If this is reply-less callback lock, we cannot replay it, since
2021 * server might have long dropped it, but notification of that event was
2022 * lost by network. (and server granted conflicting lock already) */
2023 if (lock->l_flags & LDLM_FL_CANCEL_ON_BLOCK) {
2024 LDLM_DEBUG(lock, "Not replaying reply-less lock:");
2025 ldlm_lock_cancel(lock);
2029 * If granted mode matches the requested mode, this lock is granted.
2031 * If they differ, but we have a granted mode, then we were granted
2032 * one mode and now want another: ergo, converting.
2034 * If we haven't been granted anything and are on a resource list,
2035 * then we're blocked/waiting.
2037 * If we haven't been granted anything and we're NOT on a resource list,
2038 * then we haven't got a reply yet and don't have a known disposition.
2039 * This happens whenever a lock enqueue is the request that triggers
2042 if (lock->l_granted_mode == lock->l_req_mode)
2043 flags = LDLM_FL_REPLAY | LDLM_FL_BLOCK_GRANTED;
2044 else if (lock->l_granted_mode)
2045 flags = LDLM_FL_REPLAY | LDLM_FL_BLOCK_CONV;
2046 else if (!list_empty(&lock->l_res_link))
2047 flags = LDLM_FL_REPLAY | LDLM_FL_BLOCK_WAIT;
2049 flags = LDLM_FL_REPLAY;
2051 req = ptlrpc_request_alloc_pack(imp, &RQF_LDLM_ENQUEUE,
2052 LUSTRE_DLM_VERSION, LDLM_ENQUEUE);
2056 /* We're part of recovery, so don't wait for it. */
2057 req->rq_send_state = LUSTRE_IMP_REPLAY_LOCKS;
2059 body = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
2060 ldlm_lock2desc(lock, &body->lock_desc);
2061 body->lock_flags = flags;
2063 ldlm_lock2handle(lock, &body->lock_handle[0]);
2064 if (lock->l_lvb_len != 0) {
2065 req_capsule_extend(&req->rq_pill, &RQF_LDLM_ENQUEUE_LVB);
2066 req_capsule_set_size(&req->rq_pill, &RMF_DLM_LVB, RCL_SERVER,
2069 ptlrpc_request_set_replen(req);
2070 /* notify the server we've replayed all requests.
2071 * also, we mark the request to be put on a dedicated
2072 * queue to be processed after all request replayes.
2074 lustre_msg_set_flags(req->rq_reqmsg, MSG_REQ_REPLAY_DONE);
2076 LDLM_DEBUG(lock, "replaying lock:");
2078 atomic_inc(&req->rq_import->imp_replay_inflight);
2079 CLASSERT(sizeof(*aa) <= sizeof(req->rq_async_args));
2080 aa = ptlrpc_req_async_args(req);
2081 aa->lock_handle = body->lock_handle[0];
2082 req->rq_interpret_reply = (ptlrpc_interpterer_t)replay_lock_interpret;
2083 ptlrpcd_add_req(req, PSCOPE_OTHER);
2088 int ldlm_replay_locks(struct obd_import *imp)
2090 struct ldlm_namespace *ns = imp->imp_obd->obd_namespace;
2091 CFS_LIST_HEAD(list);
2092 struct ldlm_lock *lock, *next;
2097 LASSERT(atomic_read(&imp->imp_replay_inflight) == 0);
2099 /* ensure this doesn't fall to 0 before all have been queued */
2100 atomic_inc(&imp->imp_replay_inflight);
2102 (void)ldlm_namespace_foreach(ns, ldlm_chain_lock_for_replay, &list);
2104 list_for_each_entry_safe(lock, next, &list, l_pending_chain) {
2105 list_del_init(&lock->l_pending_chain);
2107 LDLM_LOCK_PUT(lock);
2108 continue; /* or try to do the rest? */
2110 rc = replay_one_lock(imp, lock);
2111 LDLM_LOCK_PUT(lock);
2114 atomic_dec(&imp->imp_replay_inflight);