1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (C) 2002 Cluster File Systems, Inc.
6 * This file is part of Lustre, http://www.lustre.org.
8 * Lustre is free software; you can redistribute it and/or
9 * modify it under the terms of version 2 of the GNU General Public
10 * License as published by the Free Software Foundation.
12 * Lustre is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Lustre; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 #define DEBUG_SUBSYSTEM S_LDLM
24 #include <linux/lustre_dlm.h>
25 #include <linux/obd_class.h>
26 #include <linux/obd.h>
28 static int interrupted_completion_wait(void *data)
33 static int expired_completion_wait(void *data)
35 struct ldlm_lock *lock = data;
36 struct ptlrpc_connection *conn;
37 struct obd_device *obd;
40 CERROR("NULL lock\n");
41 else if (!lock->l_connh)
42 CERROR("lock %p has NULL connh\n", lock);
43 else if (!(obd = class_conn2obd(lock->l_connh)))
44 CERROR("lock %p has NULL obd\n", lock);
45 else if (!(conn = obd->u.cli.cl_import.imp_connection))
46 CERROR("lock %p has NULL connection\n", lock);
48 class_signal_connection_failure(conn);
52 int ldlm_completion_ast(struct ldlm_lock *lock, int flags)
54 struct l_wait_info lwi =
55 LWI_TIMEOUT_INTR(obd_timeout * HZ, expired_completion_wait,
56 interrupted_completion_wait, lock);
60 if (flags == LDLM_FL_WAIT_NOREPROC)
64 wake_up(&lock->l_waitq);
68 if (!(flags & (LDLM_FL_BLOCK_WAIT | LDLM_FL_BLOCK_GRANTED |
72 LDLM_DEBUG(lock, "client-side enqueue returned a blocked lock, "
75 ldlm_reprocess_all(lock->l_resource);
78 /* Go to sleep until the lock is granted or cancelled. */
79 rc = l_wait_event(lock->l_waitq,
80 ((lock->l_req_mode == lock->l_granted_mode) ||
81 (lock->l_flags & LDLM_FL_DESTROYED)), &lwi);
83 if (lock->l_flags & LDLM_FL_DESTROYED) {
84 LDLM_DEBUG(lock, "client-side enqueue waking up: destroyed");
89 LDLM_DEBUG(lock, "client-side enqueue waking up: failed (%d)",
94 LDLM_DEBUG(lock, "client-side enqueue waking up: granted");
98 static int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
99 struct lustre_handle *parent_lockh,
102 void *cookie, int cookielen,
105 ldlm_completion_callback completion,
106 ldlm_blocking_callback blocking,
109 struct lustre_handle *lockh)
111 struct ldlm_lock *lock;
116 CERROR("Trying to enqueue local lock in a shadow namespace\n");
120 lock = ldlm_lock_create(ns, parent_lockh, res_id, type, mode, data,
123 GOTO(out_nolock, err = -ENOMEM);
124 LDLM_DEBUG(lock, "client-side local enqueue handler, new lock created");
126 ldlm_lock_addref_internal(lock, mode);
127 ldlm_lock2handle(lock, lockh);
128 lock->l_connh = NULL;
130 err = ldlm_lock_enqueue(lock, cookie, cookielen, flags, completion,
135 if (type == LDLM_EXTENT)
136 memcpy(cookie, &lock->l_extent, sizeof(lock->l_extent));
137 if ((*flags) & LDLM_FL_LOCK_CHANGED)
138 memcpy(res_id, lock->l_resource->lr_name, sizeof(*res_id));
140 LDLM_DEBUG_NOLOCK("client-side local enqueue handler END (lock %p)",
143 if (lock->l_completion_ast)
144 lock->l_completion_ast(lock, *flags);
146 LDLM_DEBUG(lock, "client-side local enqueue END");
154 int ldlm_cli_enqueue(struct lustre_handle *connh,
155 struct ptlrpc_request *req,
156 struct ldlm_namespace *ns,
157 struct lustre_handle *parent_lock_handle,
160 void *cookie, int cookielen,
163 ldlm_completion_callback completion,
164 ldlm_blocking_callback blocking,
167 struct lustre_handle *lockh)
169 struct ldlm_lock *lock;
170 struct ldlm_request *body;
171 struct ldlm_reply *reply;
172 int rc, size = sizeof(*body), req_passed_in = 1, is_replay;
175 is_replay = *flags & LDLM_FL_REPLAY;
176 LASSERT(connh != NULL || !is_replay);
179 return ldlm_cli_enqueue_local(ns, parent_lock_handle, res_id,
180 type, cookie, cookielen, mode,
181 flags, completion, blocking, data,
184 /* If we're replaying this lock, just check some invariants.
185 * If we're creating a new lock, get everything all setup nice. */
187 lock = ldlm_handle2lock(lockh);
188 LDLM_DEBUG(lock, "client-side enqueue START");
189 LASSERT(connh == lock->l_connh);
191 lock = ldlm_lock_create(ns, parent_lock_handle, res_id, type,
192 mode, data, data_len);
194 GOTO(out_nolock, rc = -ENOMEM);
195 LDLM_DEBUG(lock, "client-side enqueue START");
196 /* for the local lock, add the reference */
197 ldlm_lock_addref_internal(lock, mode);
198 ldlm_lock2handle(lock, lockh);
199 if (type == LDLM_EXTENT)
200 memcpy(&lock->l_extent, cookie,
201 sizeof(body->lock_desc.l_extent));
205 req = ptlrpc_prep_req(class_conn2cliimp(connh), LDLM_ENQUEUE, 1,
208 GOTO(out, rc = -ENOMEM);
210 } else if (req->rq_reqmsg->buflens[0] != sizeof(*body))
213 /* Dump lock data into the request buffer */
214 body = lustre_msg_buf(req->rq_reqmsg, 0);
215 ldlm_lock2desc(lock, &body->lock_desc);
216 body->lock_flags = *flags;
218 memcpy(&body->lock_handle1, lockh, sizeof(*lockh));
219 if (parent_lock_handle)
220 memcpy(&body->lock_handle2, parent_lock_handle,
221 sizeof(body->lock_handle2));
223 /* Continue as normal. */
224 if (!req_passed_in) {
225 size = sizeof(*reply);
226 req->rq_replen = lustre_msg_size(1, &size);
228 lock->l_connh = connh;
229 lock->l_export = NULL;
231 LDLM_DEBUG(lock, "sending request");
232 rc = ptlrpc_queue_wait(req);
233 rc = ptlrpc_check_status(req, rc);
235 if (rc != ELDLM_OK) {
237 LDLM_DEBUG(lock, "client-side enqueue END (%s)",
238 rc == ELDLM_LOCK_ABORTED ? "ABORTED" : "FAILED");
239 ldlm_lock_decref(lockh, mode);
240 /* FIXME: if we've already received a completion AST, this will
242 ldlm_lock_destroy(lock);
246 reply = lustre_msg_buf(req->rq_repmsg, 0);
247 memcpy(&lock->l_remote_handle, &reply->lock_handle,
248 sizeof(lock->l_remote_handle));
249 *flags = reply->lock_flags;
251 CDEBUG(D_INFO, "remote handle: %p, flags: %d\n",
252 (void *)(unsigned long)reply->lock_handle.addr, *flags);
253 if (type == LDLM_EXTENT) {
254 CDEBUG(D_INFO, "requested extent: "LPU64" -> "LPU64", got "
255 "extent "LPU64" -> "LPU64"\n",
256 body->lock_desc.l_extent.start,
257 body->lock_desc.l_extent.end,
258 reply->lock_extent.start, reply->lock_extent.end);
259 cookie = &reply->lock_extent; /* FIXME bug 267 */
260 cookielen = sizeof(reply->lock_extent);
263 /* If enqueue returned a blocked lock but the completion handler has
264 * already run, then it fixed up the resource and we don't need to do it
266 if ((*flags) & LDLM_FL_LOCK_CHANGED) {
267 int newmode = reply->lock_mode;
269 if (newmode && newmode != lock->l_req_mode) {
270 LDLM_DEBUG(lock, "server returned different mode %s",
271 ldlm_lockname[newmode]);
272 lock->l_req_mode = newmode;
275 if (reply->lock_resource_name[0] !=
276 lock->l_resource->lr_name[0]) {
277 CDEBUG(D_INFO, "remote intent success, locking %ld "
279 (long)reply->lock_resource_name[0],
280 (long)lock->l_resource->lr_name[0]);
282 ldlm_lock_change_resource(lock,
283 reply->lock_resource_name);
284 if (lock->l_resource == NULL) {
288 LDLM_DEBUG(lock, "client-side enqueue, new resource");
293 ptlrpc_req_finished(req);
296 rc = ldlm_lock_enqueue(lock, cookie, cookielen, flags,
297 completion, blocking);
298 if (lock->l_completion_ast)
299 lock->l_completion_ast(lock, *flags);
302 LDLM_DEBUG(lock, "client-side enqueue END");
310 int ldlm_match_or_enqueue(struct lustre_handle *connh,
311 struct ptlrpc_request *req,
312 struct ldlm_namespace *ns,
313 struct lustre_handle *parent_lock_handle,
316 void *cookie, int cookielen,
319 ldlm_completion_callback completion,
320 ldlm_blocking_callback blocking,
323 struct lustre_handle *lockh)
327 rc = ldlm_lock_match(ns, res_id, type, cookie, cookielen, mode, lockh);
329 rc = ldlm_cli_enqueue(connh, req, ns,
330 parent_lock_handle, res_id, type, cookie,
331 cookielen, mode, flags, completion,
332 blocking, data, data_len, lockh);
334 CERROR("ldlm_cli_enqueue: err: %d\n", rc);
340 int ldlm_cli_replay_enqueue(struct ldlm_lock *lock)
342 struct lustre_handle lockh;
343 int flags = LDLM_FL_REPLAY;
344 ldlm_lock2handle(lock, &lockh);
345 return ldlm_cli_enqueue(lock->l_connh, NULL, NULL, NULL, NULL,
346 lock->l_resource->lr_type, NULL, 0, -1, &flags,
347 NULL, NULL, NULL, 0, &lockh);
350 static int ldlm_cli_convert_local(struct ldlm_lock *lock, int new_mode,
354 if (lock->l_resource->lr_namespace->ns_client) {
355 CERROR("Trying to cancel local lock\n");
358 LDLM_DEBUG(lock, "client-side local convert");
360 ldlm_lock_convert(lock, new_mode, flags);
361 ldlm_reprocess_all(lock->l_resource);
363 LDLM_DEBUG(lock, "client-side local convert handler END");
368 /* FIXME: one of ldlm_cli_convert or the server side should reject attempted
369 * conversion of locks which are on the waiting or converting queue */
370 int ldlm_cli_convert(struct lustre_handle *lockh, int new_mode, int *flags)
372 struct ldlm_request *body;
373 struct lustre_handle *connh;
374 struct ldlm_reply *reply;
375 struct ldlm_lock *lock;
376 struct ldlm_resource *res;
377 struct ptlrpc_request *req;
378 int rc, size = sizeof(*body);
381 lock = ldlm_handle2lock(lockh);
387 connh = lock->l_connh;
390 RETURN(ldlm_cli_convert_local(lock, new_mode, flags));
392 LDLM_DEBUG(lock, "client-side convert");
394 req = ptlrpc_prep_req(class_conn2cliimp(connh), LDLM_CONVERT, 1, &size,
397 GOTO(out, rc = -ENOMEM);
399 body = lustre_msg_buf(req->rq_reqmsg, 0);
400 memcpy(&body->lock_handle1, &lock->l_remote_handle,
401 sizeof(body->lock_handle1));
403 body->lock_desc.l_req_mode = new_mode;
404 body->lock_flags = *flags;
406 size = sizeof(*reply);
407 req->rq_replen = lustre_msg_size(1, &size);
409 rc = ptlrpc_queue_wait(req);
410 rc = ptlrpc_check_status(req, rc);
414 reply = lustre_msg_buf(req->rq_repmsg, 0);
415 res = ldlm_lock_convert(lock, new_mode, &reply->lock_flags);
417 ldlm_reprocess_all(res);
418 /* Go to sleep until the lock is granted. */
419 /* FIXME: or cancelled. */
420 if (lock->l_completion_ast)
421 lock->l_completion_ast(lock, LDLM_FL_WAIT_NOREPROC);
425 ptlrpc_req_finished(req);
429 int ldlm_cli_cancel(struct lustre_handle *lockh)
431 struct ptlrpc_request *req;
432 struct ldlm_lock *lock;
433 struct ldlm_request *body;
434 int rc = 0, size = sizeof(*body);
437 lock = ldlm_handle2lock(lockh);
439 /* It's possible that the decref that we did just before this
440 * cancel was the last reader/writer, and caused a cancel before
441 * we could call this function. If we want to make this
442 * impossible (by adding a dec_and_cancel() or similar), then
443 * we can put the LBUG back. */
449 LDLM_DEBUG(lock, "client-side cancel");
450 /* Set this flag to prevent others from getting new references*/
451 l_lock(&lock->l_resource->lr_namespace->ns_lock);
452 lock->l_flags |= LDLM_FL_CBPENDING;
453 ldlm_cancel_callback(lock);
454 l_unlock(&lock->l_resource->lr_namespace->ns_lock);
456 req = ptlrpc_prep_req(class_conn2cliimp(lock->l_connh),
457 LDLM_CANCEL, 1, &size, NULL);
459 GOTO(out, rc = -ENOMEM);
461 /* XXX FIXME bug 249 */
462 req->rq_request_portal = LDLM_CANCEL_REQUEST_PORTAL;
463 req->rq_reply_portal = LDLM_CANCEL_REPLY_PORTAL;
465 body = lustre_msg_buf(req->rq_reqmsg, 0);
466 memcpy(&body->lock_handle1, &lock->l_remote_handle,
467 sizeof(body->lock_handle1));
469 req->rq_replen = lustre_msg_size(0, NULL);
471 rc = ptlrpc_queue_wait(req);
472 rc = ptlrpc_check_status(req, rc);
473 ptlrpc_req_finished(req);
477 ldlm_lock_cancel(lock);
479 LDLM_DEBUG(lock, "client-side local cancel");
480 if (lock->l_resource->lr_namespace->ns_client) {
481 CERROR("Trying to cancel local lock\n");
484 ldlm_lock_cancel(lock);
485 ldlm_reprocess_all(lock->l_resource);
486 LDLM_DEBUG(lock, "client-side local cancel handler END");
495 static int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
496 __u64 *res_id, int flags)
498 struct ldlm_resource *res;
499 struct list_head *tmp, *next, list = LIST_HEAD_INIT(list);
500 struct ldlm_ast_work *w;
503 res = ldlm_resource_get(ns, NULL, res_id, 0, 0);
505 /* This is not a problem. */
506 CDEBUG(D_INFO, "No resource "LPU64"\n", res_id[0]);
510 l_lock(&ns->ns_lock);
511 list_for_each(tmp, &res->lr_granted) {
512 struct ldlm_lock *lock;
513 lock = list_entry(tmp, struct ldlm_lock, l_res_link);
515 if (lock->l_readers || lock->l_writers)
518 /* Setting the CBPENDING flag is a little misleading, but
519 * prevents an important race; namely, once CBPENDING is set,
520 * the lock can accumulate no more readers/writers. Since
521 * readers and writers are already zero here, ldlm_lock_decref
522 * won't see this flag and call l_blocking_ast */
523 lock->l_flags |= LDLM_FL_CBPENDING;
525 OBD_ALLOC(w, sizeof(*w));
528 w->w_lock = LDLM_LOCK_GET(lock);
529 list_add(&w->w_list, &list);
531 l_unlock(&ns->ns_lock);
533 list_for_each_safe(tmp, next, &list) {
534 struct lustre_handle lockh;
536 w = list_entry(tmp, struct ldlm_ast_work, w_list);
538 /* Prevent the cancel callback from being called by setting
539 * LDLM_FL_CANCEL in the lock. Very sneaky. -p */
540 if (flags & LDLM_FL_NO_CALLBACK)
541 w->w_lock->l_flags |= LDLM_FL_CANCEL;
543 if (flags & LDLM_FL_LOCAL_ONLY) {
544 ldlm_lock_cancel(w->w_lock);
546 ldlm_lock2handle(w->w_lock, &lockh);
547 rc = ldlm_cli_cancel(&lockh);
549 CERROR("ldlm_cli_cancel: %d\n", rc);
551 LDLM_LOCK_PUT(w->w_lock);
552 list_del(&w->w_list);
553 OBD_FREE(w, sizeof(*w));
556 ldlm_resource_put(res);
561 /* Cancel all locks on a namespace (or a specific resource, if given) that have
564 * If 'local_only' is true, throw the locks away without trying to notify the
566 int ldlm_cli_cancel_unused(struct ldlm_namespace *ns, __u64 *res_id,
572 RETURN(ldlm_cli_cancel_unused_resource(ns, res_id, flags));
574 l_lock(&ns->ns_lock);
575 for (i = 0; i < RES_HASH_SIZE; i++) {
576 struct list_head *tmp, *pos;
577 list_for_each_safe(tmp, pos, &(ns->ns_hash[i])) {
579 struct ldlm_resource *res;
580 res = list_entry(tmp, struct ldlm_resource, lr_hash);
581 ldlm_resource_getref(res);
583 rc = ldlm_cli_cancel_unused_resource(ns, res->lr_name,
587 CERROR("cancel_unused_res ("LPU64"): %d\n",
588 res->lr_name[0], rc);
589 ldlm_resource_put(res);
592 l_unlock(&ns->ns_lock);