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.
5 * Author: Peter Braam <braam@clusterfs.com>
6 * Author: Phil Schwan <phil@clusterfs.com>
8 * This file is part of Lustre, http://www.lustre.org.
10 * Lustre is free software; you can redistribute it and/or
11 * modify it under the terms of version 2 of the GNU General Public
12 * License as published by the Free Software Foundation.
14 * Lustre is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with Lustre; if not, write to the Free Software
21 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 #define DEBUG_SUBSYSTEM S_LDLM
27 #include <linux/module.h>
28 #include <linux/slab.h>
29 #include <linux/lustre_dlm.h>
30 #include <linux/init.h>
31 #include <linux/obd_class.h>
33 extern kmem_cache_t *ldlm_resource_slab;
34 extern kmem_cache_t *ldlm_lock_slab;
35 extern struct list_head ldlm_namespace_list;
36 extern int (*mds_reint_p)(int offset, struct ptlrpc_request *req);
37 extern int (*mds_getattr_name_p)(int offset, struct ptlrpc_request *req);
39 inline unsigned long round_timeout(unsigned long timeout)
41 return ((timeout / HZ) + 1) * HZ;
44 static void waiting_locks_callback(unsigned long unused)
46 CERROR("lock(s) expired! need to start recovery!\n");
49 static struct list_head waiting_locks_list;
50 static spinlock_t waiting_locks_spinlock;
51 static struct timer_list waiting_locks_timer;
53 * Indicate that we're waiting for a client to call us back cancelling a given
54 * lock. We add it to the pending-callback chain, and schedule the lock-timeout
55 * timer to fire appropriately. (We round up to the next second, to avoid floods
56 * of timer firings during periods of high lock contention and traffic.
58 int ldlm_add_waiting_lock(struct ldlm_lock *lock)
60 unsigned long timeout_rounded;
63 LASSERT(list_empty(&lock->l_pending_chain));
65 CERROR("waiting for lock %p\n", lock);
66 spin_lock_bh(&waiting_locks_spinlock);
67 lock->l_callback_timeout = jiffies + (obd_timeout * HZ);
69 timeout_rounded = round_timeout(lock->l_callback_timeout);
71 if (timeout_rounded < waiting_locks_timer.expires ||
72 !timer_pending(&waiting_locks_timer)) {
73 CERROR("adjusting timer! (%0lx/%0lx < %0lx)\n",
74 lock->l_callback_timeout, timeout_rounded,
75 waiting_locks_timer.expires);
76 mod_timer(&waiting_locks_timer, timeout_rounded);
78 list_add_tail(&lock->l_pending_chain, &waiting_locks_list); /* FIFO */
79 spin_unlock_bh(&waiting_locks_spinlock);
84 * Remove a lock from the pending list, likely because it had its cancellation
85 * callback arrive without incident. This adjusts the lock-timeout timer if
86 * needed. Returns 0 if the lock wasn't pending after all, 1 if it was.
88 int ldlm_del_waiting_lock(struct ldlm_lock *lock)
90 struct list_head *list_next;
94 spin_lock_bh(&waiting_locks_spinlock);
96 if (list_empty(&lock->l_pending_chain)) {
97 spin_unlock_bh(&waiting_locks_spinlock);
101 CERROR("no longer waiting for lock %p\n", lock);
103 list_next = lock->l_pending_chain.next;
104 if (lock->l_pending_chain.prev == &waiting_locks_list) {
105 /* Removing the head of the list, adjust timer. */
106 if (list_next == &waiting_locks_list) {
107 /* No more, just cancel. */
108 CERROR("no more locks waiting, stopping timer\n");
109 del_timer(&waiting_locks_timer);
111 struct ldlm_lock *next;
112 next = list_entry(list_next, struct ldlm_lock,
114 CERROR("adjusting timer (%0lx %0lx)\n",
115 waiting_locks_timer.expires,
116 round_timeout(next->l_callback_timeout));
117 mod_timer(&waiting_locks_timer,
118 round_timeout(next->l_callback_timeout));
121 list_del_init(&lock->l_pending_chain);
122 spin_unlock_bh(&waiting_locks_spinlock);
126 static int ldlm_server_blocking_ast(struct ldlm_lock *lock,
127 struct ldlm_lock_desc *desc,
128 void *data, __u32 data_len)
130 struct ldlm_request *body;
131 struct ptlrpc_request *req;
132 struct ptlrpc_client *cl;
133 int rc = 0, size = sizeof(*body);
136 cl = &lock->l_resource->lr_namespace->ns_rpc_client;
137 req = ptlrpc_prep_req(cl, lock->l_export->exp_connection,
138 LDLM_BL_CALLBACK, 1, &size, NULL);
142 body = lustre_msg_buf(req->rq_reqmsg, 0);
143 memcpy(&body->lock_handle1, &lock->l_remote_handle,
144 sizeof(body->lock_handle1));
145 memcpy(&body->lock_desc, desc, sizeof(*desc));
147 LDLM_DEBUG(lock, "server preparing blocking AST");
148 req->rq_replen = lustre_msg_size(0, NULL);
150 ldlm_add_waiting_lock(lock);
151 rc = ptlrpc_queue_wait(req);
152 rc = ptlrpc_check_status(req, rc);
153 ptlrpc_free_req(req);
158 static int ldlm_server_completion_ast(struct ldlm_lock *lock, int flags)
160 struct ldlm_request *body;
161 struct ptlrpc_request *req;
162 struct ptlrpc_client *cl;
163 int rc = 0, size = sizeof(*body);
171 cl = &lock->l_resource->lr_namespace->ns_rpc_client;
172 req = ptlrpc_prep_req(cl, lock->l_export->exp_connection,
173 LDLM_CP_CALLBACK, 1, &size, NULL);
177 body = lustre_msg_buf(req->rq_reqmsg, 0);
178 memcpy(&body->lock_handle1, &lock->l_remote_handle,
179 sizeof(body->lock_handle1));
180 body->lock_flags = flags;
181 ldlm_lock2desc(lock, &body->lock_desc);
183 LDLM_DEBUG(lock, "server preparing completion AST");
184 req->rq_replen = lustre_msg_size(0, NULL);
186 rc = ptlrpc_queue_wait(req);
187 rc = ptlrpc_check_status(req, rc);
188 ptlrpc_free_req(req);
192 int ldlm_handle_enqueue(struct ptlrpc_request *req)
194 struct obd_device *obddev = req->rq_export->exp_obd;
195 struct ldlm_reply *dlm_rep;
196 struct ldlm_request *dlm_req;
197 int rc, size = sizeof(*dlm_rep), cookielen = 0;
200 struct ldlm_lock *lock = NULL;
204 LDLM_DEBUG_NOLOCK("server-side enqueue handler START");
206 dlm_req = lustre_msg_buf(req->rq_reqmsg, 0);
207 if (dlm_req->lock_desc.l_resource.lr_type == LDLM_MDSINTENT) {
208 /* In this case, the reply buffer is allocated deep in
209 * local_lock_enqueue by the policy function. */
211 cookielen = sizeof(*req);
213 rc = lustre_pack_msg(1, &size, NULL, &req->rq_replen,
216 CERROR("out of memory\n");
219 if (dlm_req->lock_desc.l_resource.lr_type == LDLM_EXTENT) {
220 cookie = &dlm_req->lock_desc.l_extent;
221 cookielen = sizeof(struct ldlm_extent);
225 lock = ldlm_lock_create(obddev->obd_namespace,
226 &dlm_req->lock_handle2,
227 dlm_req->lock_desc.l_resource.lr_name,
228 dlm_req->lock_desc.l_resource.lr_type,
229 dlm_req->lock_desc.l_req_mode, NULL, 0);
231 GOTO(out, err = -ENOMEM);
233 memcpy(&lock->l_remote_handle, &dlm_req->lock_handle1,
234 sizeof(lock->l_remote_handle));
235 LDLM_DEBUG(lock, "server-side enqueue handler, new lock created");
237 flags = dlm_req->lock_flags;
238 err = ldlm_lock_enqueue(lock, cookie, cookielen, &flags,
239 ldlm_server_completion_ast,
240 ldlm_server_blocking_ast);
244 dlm_rep = lustre_msg_buf(req->rq_repmsg, 0);
245 dlm_rep->lock_flags = flags;
247 ldlm_lock2handle(lock, &dlm_rep->lock_handle);
248 if (dlm_req->lock_desc.l_resource.lr_type == LDLM_EXTENT)
249 memcpy(&dlm_rep->lock_extent, &lock->l_extent,
250 sizeof(lock->l_extent));
251 if (dlm_rep->lock_flags & LDLM_FL_LOCK_CHANGED) {
252 memcpy(dlm_rep->lock_resource_name, lock->l_resource->lr_name,
253 sizeof(dlm_rep->lock_resource_name));
254 dlm_rep->lock_mode = lock->l_req_mode;
257 lock->l_export = req->rq_export;
258 if (lock->l_export) {
259 l_lock(&lock->l_resource->lr_namespace->ns_lock);
260 list_add(&lock->l_export_chain,
261 &lock->l_export->exp_ldlm_data.led_held_locks);
262 l_unlock(&lock->l_resource->lr_namespace->ns_lock);
265 ptlrpc_connection_addref(req->rq_connection);
269 LDLM_DEBUG(lock, "server-side enqueue handler, sending reply"
271 req->rq_status = err;
273 if (ptlrpc_reply(req->rq_svc, req))
278 ldlm_reprocess_all(lock->l_resource);
281 LDLM_DEBUG_NOLOCK("server-side enqueue handler END (lock %p)", lock);
286 int ldlm_handle_convert(struct ptlrpc_request *req)
288 struct ldlm_request *dlm_req;
289 struct ldlm_reply *dlm_rep;
290 struct ldlm_lock *lock;
291 int rc, size = sizeof(*dlm_rep);
294 rc = lustre_pack_msg(1, &size, NULL, &req->rq_replen, &req->rq_repmsg);
296 CERROR("out of memory\n");
299 dlm_req = lustre_msg_buf(req->rq_reqmsg, 0);
300 dlm_rep = lustre_msg_buf(req->rq_repmsg, 0);
301 dlm_rep->lock_flags = dlm_req->lock_flags;
303 lock = ldlm_handle2lock(&dlm_req->lock_handle1);
305 req->rq_status = EINVAL;
307 LDLM_DEBUG(lock, "server-side convert handler START");
308 ldlm_lock_convert(lock, dlm_req->lock_desc.l_req_mode,
309 &dlm_rep->lock_flags);
310 if (ldlm_del_waiting_lock(lock))
311 CDEBUG(D_DLMTRACE, "converted waiting lock %p\n", lock);
314 if (ptlrpc_reply(req->rq_svc, req) != 0)
318 ldlm_reprocess_all(lock->l_resource);
319 LDLM_DEBUG(lock, "server-side convert handler END");
322 LDLM_DEBUG_NOLOCK("server-side convert handler END");
327 int ldlm_handle_cancel(struct ptlrpc_request *req)
329 struct ldlm_request *dlm_req;
330 struct ldlm_lock *lock;
334 rc = lustre_pack_msg(0, NULL, NULL, &req->rq_replen, &req->rq_repmsg);
336 CERROR("out of memory\n");
339 dlm_req = lustre_msg_buf(req->rq_reqmsg, 0);
341 lock = ldlm_handle2lock(&dlm_req->lock_handle1);
343 LDLM_DEBUG_NOLOCK("server-side cancel handler stale lock (lock "
344 "%p)", (void *)(unsigned long)
345 dlm_req->lock_handle1.addr);
346 req->rq_status = ESTALE;
348 LDLM_DEBUG(lock, "server-side cancel handler START");
349 ldlm_lock_cancel(lock);
350 if (ldlm_del_waiting_lock(lock))
351 CDEBUG(D_DLMTRACE, "cancelled waiting lock %p\n", lock);
355 if (ptlrpc_reply(req->rq_svc, req) != 0)
359 ldlm_reprocess_all(lock->l_resource);
360 LDLM_DEBUG(lock, "server-side cancel handler END");
367 static int ldlm_handle_bl_callback(struct ptlrpc_request *req)
369 struct ldlm_request *dlm_req;
370 struct ldlm_lock *lock;
374 OBD_FAIL_RETURN(OBD_FAIL_OSC_LOCK_BL_REPLY, 0);
376 rc = lustre_pack_msg(0, NULL, NULL, &req->rq_replen, &req->rq_repmsg);
379 rc = ptlrpc_reply(req->rq_svc, req);
383 OBD_FAIL_RETURN(OBD_FAIL_OSC_LOCK_BL_AST, 0);
385 dlm_req = lustre_msg_buf(req->rq_reqmsg, 0);
387 lock = ldlm_handle2lock(&dlm_req->lock_handle1);
389 CERROR("blocking callback on lock %Lx - lock disappeared\n",
390 dlm_req->lock_handle1.addr);
394 LDLM_DEBUG(lock, "client blocking AST callback handler START");
396 l_lock(&lock->l_resource->lr_namespace->ns_lock);
397 lock->l_flags |= LDLM_FL_CBPENDING;
398 do_ast = (!lock->l_readers && !lock->l_writers);
399 l_unlock(&lock->l_resource->lr_namespace->ns_lock);
402 LDLM_DEBUG(lock, "already unused, calling "
403 "callback (%p)", lock->l_blocking_ast);
404 if (lock->l_blocking_ast != NULL) {
405 lock->l_blocking_ast(lock, &dlm_req->lock_desc,
406 lock->l_data, lock->l_data_len);
409 LDLM_DEBUG(lock, "Lock still has references, will be"
412 LDLM_DEBUG(lock, "client blocking callback handler END");
417 static int ldlm_handle_cp_callback(struct ptlrpc_request *req)
419 struct list_head ast_list = LIST_HEAD_INIT(ast_list);
420 struct ldlm_request *dlm_req;
421 struct ldlm_lock *lock;
425 rc = lustre_pack_msg(0, NULL, NULL, &req->rq_replen, &req->rq_repmsg);
428 rc = ptlrpc_reply(req->rq_svc, req);
432 dlm_req = lustre_msg_buf(req->rq_reqmsg, 0);
434 lock = ldlm_handle2lock(&dlm_req->lock_handle1);
436 CERROR("completion callback on lock %Lx - lock disappeared\n",
437 dlm_req->lock_handle1.addr);
441 LDLM_DEBUG(lock, "client completion callback handler START");
443 l_lock(&lock->l_resource->lr_namespace->ns_lock);
445 /* If we receive the completion AST before the actual enqueue returned,
446 * then we might need to switch resources or lock modes. */
447 if (dlm_req->lock_desc.l_granted_mode != lock->l_req_mode) {
448 lock->l_req_mode = dlm_req->lock_desc.l_granted_mode;
449 LDLM_DEBUG(lock, "completion AST, new lock mode");
451 ldlm_resource_unlink_lock(lock);
452 if (memcmp(dlm_req->lock_desc.l_resource.lr_name,
453 lock->l_resource->lr_name,
454 sizeof(__u64) * RES_NAME_SIZE) != 0) {
455 ldlm_lock_change_resource(lock, dlm_req->lock_desc.l_resource.lr_name);
456 LDLM_DEBUG(lock, "completion AST, new resource");
458 lock->l_resource->lr_tmp = &ast_list;
459 ldlm_grant_lock(lock);
460 lock->l_resource->lr_tmp = NULL;
461 l_unlock(&lock->l_resource->lr_namespace->ns_lock);
462 LDLM_DEBUG(lock, "callback handler finished, about to run_ast_work");
465 ldlm_run_ast_work(&ast_list);
467 LDLM_DEBUG_NOLOCK("client completion callback handler END (lock %p)",
472 static int ldlm_callback_handler(struct ptlrpc_request *req)
477 rc = lustre_unpack_msg(req->rq_reqmsg, req->rq_reqlen);
479 CERROR("lustre_ldlm: Invalid request\n");
483 if (req->rq_reqmsg->type != PTL_RPC_MSG_REQUEST) {
484 CERROR("lustre_ldlm: wrong packet type sent %d\n",
485 req->rq_reqmsg->type);
486 GOTO(out, rc = -EINVAL);
488 switch (req->rq_reqmsg->opc) {
489 case LDLM_BL_CALLBACK:
490 CDEBUG(D_INODE, "blocking ast\n");
491 OBD_FAIL_RETURN(OBD_FAIL_LDLM_BL_CALLBACK, 0);
492 rc = ldlm_handle_bl_callback(req);
494 case LDLM_CP_CALLBACK:
495 CDEBUG(D_INODE, "completion ast\n");
496 OBD_FAIL_RETURN(OBD_FAIL_LDLM_CP_CALLBACK, 0);
497 rc = ldlm_handle_cp_callback(req);
501 rc = ptlrpc_error(req->rq_svc, req);
508 RETURN(ptlrpc_error(req->rq_svc, req));
513 static int ldlm_iocontrol(long cmd, struct lustre_handle *conn, int len,
514 void *karg, void *uarg)
516 struct obd_device *obddev = class_conn2obd(conn);
517 struct ptlrpc_connection *connection;
521 if (_IOC_TYPE(cmd) != IOC_LDLM_TYPE || _IOC_NR(cmd) < IOC_LDLM_MIN_NR ||
522 _IOC_NR(cmd) > IOC_LDLM_MAX_NR) {
523 CDEBUG(D_IOCTL, "invalid ioctl (type %ld, nr %ld, size %ld)\n",
524 _IOC_TYPE(cmd), _IOC_NR(cmd), _IOC_SIZE(cmd));
528 OBD_ALLOC(obddev->u.ldlm.ldlm_client,
529 sizeof(*obddev->u.ldlm.ldlm_client));
530 ptlrpc_init_client(NULL, NULL,
531 LDLM_REQUEST_PORTAL, LDLM_REPLY_PORTAL,
532 obddev->u.ldlm.ldlm_client);
533 connection = ptlrpc_uuid_to_connection("ldlm");
535 CERROR("No LDLM UUID found: assuming ldlm is local.\n");
539 err = ldlm_test(obddev, conn);
540 CERROR("-- done err %d\n", err);
543 ldlm_dump_all_namespaces();
546 GOTO(out, err = -EINVAL);
551 ptlrpc_put_connection(connection);
552 OBD_FREE(obddev->u.ldlm.ldlm_client,
553 sizeof(*obddev->u.ldlm.ldlm_client));
557 #define LDLM_NUM_THREADS 8
559 static int ldlm_setup(struct obd_device *obddev, obd_count len, void *buf)
561 struct ldlm_obd *ldlm = &obddev->u.ldlm;
566 rc = ldlm_proc_setup(obddev);
570 ldlm->ldlm_service = ptlrpc_init_svc(64 * 1024, LDLM_REQUEST_PORTAL,
571 LDLM_REPLY_PORTAL, "self",
572 ldlm_callback_handler, "ldlm");
573 if (!ldlm->ldlm_service)
574 GOTO(out_proc, rc = -ENOMEM);
576 for (i = 0; i < LDLM_NUM_THREADS; i++) {
578 sprintf(name, "lustre_dlm_%02d", i);
579 rc = ptlrpc_start_thread(obddev, ldlm->ldlm_service, name);
581 CERROR("cannot start LDLM thread #%d: rc %d\n", i, rc);
583 GOTO(out_thread, rc);
587 INIT_LIST_HEAD(&waiting_locks_list);
588 spin_lock_init(&waiting_locks_spinlock);
589 waiting_locks_timer.function = waiting_locks_callback;
590 waiting_locks_timer.data = 0;
591 init_timer(&waiting_locks_timer);
596 ptlrpc_stop_all_threads(ldlm->ldlm_service);
597 ptlrpc_unregister_service(ldlm->ldlm_service);
599 ldlm_proc_cleanup(obddev);
605 static int ldlm_cleanup(struct obd_device *obddev)
607 struct ldlm_obd *ldlm = &obddev->u.ldlm;
610 if (!list_empty(&ldlm_namespace_list)) {
611 CERROR("ldlm still has namespaces; clean these up first.\n");
615 ptlrpc_stop_all_threads(ldlm->ldlm_service);
616 ptlrpc_unregister_service(ldlm->ldlm_service);
617 ldlm_proc_cleanup(obddev);
623 struct obd_ops ldlm_obd_ops = {
624 o_iocontrol: ldlm_iocontrol,
626 o_cleanup: ldlm_cleanup,
627 o_connect: class_connect,
628 o_disconnect: class_disconnect
631 static int __init ldlm_init(void)
633 int rc = class_register_type(&ldlm_obd_ops, OBD_LDLM_DEVICENAME);
637 ldlm_resource_slab = kmem_cache_create("ldlm_resources",
638 sizeof(struct ldlm_resource), 0,
639 SLAB_HWCACHE_ALIGN, NULL, NULL);
640 if (ldlm_resource_slab == NULL)
643 ldlm_lock_slab = kmem_cache_create("ldlm_locks",
644 sizeof(struct ldlm_lock), 0,
645 SLAB_HWCACHE_ALIGN, NULL, NULL);
646 if (ldlm_lock_slab == NULL) {
647 kmem_cache_destroy(ldlm_resource_slab);
654 static void __exit ldlm_exit(void)
656 class_unregister_type(OBD_LDLM_DEVICENAME);
657 if (kmem_cache_destroy(ldlm_resource_slab) != 0)
658 CERROR("couldn't free ldlm resource slab\n");
659 if (kmem_cache_destroy(ldlm_lock_slab) != 0)
660 CERROR("couldn't free ldlm lock slab\n");
663 EXPORT_SYMBOL(ldlm_completion_ast);
664 EXPORT_SYMBOL(ldlm_handle_enqueue);
665 EXPORT_SYMBOL(ldlm_handle_cancel);
666 EXPORT_SYMBOL(ldlm_handle_convert);
667 EXPORT_SYMBOL(ldlm_register_intent);
668 EXPORT_SYMBOL(ldlm_unregister_intent);
669 EXPORT_SYMBOL(ldlm_lockname);
670 EXPORT_SYMBOL(ldlm_typename);
671 EXPORT_SYMBOL(ldlm_handle2lock);
672 EXPORT_SYMBOL(ldlm_lock2handle);
673 EXPORT_SYMBOL(ldlm_lock_put);
674 EXPORT_SYMBOL(ldlm_lock_match);
675 EXPORT_SYMBOL(ldlm_lock_addref);
676 EXPORT_SYMBOL(ldlm_lock_decref);
677 EXPORT_SYMBOL(ldlm_lock_change_resource);
678 EXPORT_SYMBOL(ldlm_cli_convert);
679 EXPORT_SYMBOL(ldlm_cli_enqueue);
680 EXPORT_SYMBOL(ldlm_cli_cancel);
681 EXPORT_SYMBOL(ldlm_match_or_enqueue);
682 EXPORT_SYMBOL(ldlm_it2str);
683 EXPORT_SYMBOL(ldlm_test);
684 EXPORT_SYMBOL(ldlm_regression_start);
685 EXPORT_SYMBOL(ldlm_regression_stop);
686 EXPORT_SYMBOL(ldlm_lock_dump);
687 EXPORT_SYMBOL(ldlm_namespace_new);
688 EXPORT_SYMBOL(ldlm_namespace_free);
689 EXPORT_SYMBOL(l_lock);
690 EXPORT_SYMBOL(l_unlock);
692 MODULE_AUTHOR("Cluster File Systems, Inc. <info@clusterfs.com>");
693 MODULE_DESCRIPTION("Lustre Lock Management Module v0.1");
694 MODULE_LICENSE("GPL");
696 module_init(ldlm_init);
697 module_exit(ldlm_exit);