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 struct list_head waiting_locks_list;
45 static spinlock_t waiting_locks_spinlock;
46 static struct timer_list waiting_locks_timer;
48 static void waiting_locks_callback(unsigned long unused)
50 struct list_head *liter, *n;
52 spin_lock_bh(&waiting_locks_spinlock);
53 list_for_each_safe(liter, n, &waiting_locks_list) {
54 struct ldlm_lock *l = list_entry(liter, struct ldlm_lock,
56 if (l->l_callback_timeout > jiffies)
58 LDLM_DEBUG(l, "timer expired, recovering conn %p\n",
59 l->l_export->exp_connection);
60 recovd_conn_fail(l->l_export->exp_connection);
62 spin_unlock_bh(&waiting_locks_spinlock);
66 * Indicate that we're waiting for a client to call us back cancelling a given
67 * lock. We add it to the pending-callback chain, and schedule the lock-timeout
68 * timer to fire appropriately. (We round up to the next second, to avoid
69 * floods of timer firings during periods of high lock contention and traffic).
71 static int ldlm_add_waiting_lock(struct ldlm_lock *lock)
73 unsigned long timeout_rounded;
76 LASSERT(list_empty(&lock->l_pending_chain));
78 spin_lock_bh(&waiting_locks_spinlock);
79 lock->l_callback_timeout = jiffies + (obd_timeout * HZ);
81 timeout_rounded = round_timeout(lock->l_callback_timeout);
83 if (timeout_rounded < waiting_locks_timer.expires ||
84 !timer_pending(&waiting_locks_timer)) {
85 mod_timer(&waiting_locks_timer, timeout_rounded);
87 list_add_tail(&lock->l_pending_chain, &waiting_locks_list); /* FIFO */
88 spin_unlock_bh(&waiting_locks_spinlock);
93 * Remove a lock from the pending list, likely because it had its cancellation
94 * callback arrive without incident. This adjusts the lock-timeout timer if
95 * needed. Returns 0 if the lock wasn't pending after all, 1 if it was.
97 int ldlm_del_waiting_lock(struct ldlm_lock *lock)
99 struct list_head *list_next;
103 spin_lock_bh(&waiting_locks_spinlock);
105 if (list_empty(&lock->l_pending_chain)) {
106 spin_unlock_bh(&waiting_locks_spinlock);
110 list_next = lock->l_pending_chain.next;
111 if (lock->l_pending_chain.prev == &waiting_locks_list) {
112 /* Removing the head of the list, adjust timer. */
113 if (list_next == &waiting_locks_list) {
114 /* No more, just cancel. */
115 del_timer(&waiting_locks_timer);
117 struct ldlm_lock *next;
118 next = list_entry(list_next, struct ldlm_lock,
120 mod_timer(&waiting_locks_timer,
121 round_timeout(next->l_callback_timeout));
124 list_del_init(&lock->l_pending_chain);
125 spin_unlock_bh(&waiting_locks_spinlock);
129 static int ldlm_server_blocking_ast(struct ldlm_lock *lock,
130 struct ldlm_lock_desc *desc,
131 void *data, __u32 data_len, int flag)
133 struct ldlm_request *body;
134 struct ptlrpc_request *req;
135 int rc = 0, size = sizeof(*body);
138 if (flag == LDLM_CB_CANCELING) {
139 /* Don't need to do anything here. */
143 req = ptlrpc_prep_req(&lock->l_export->exp_ldlm_data.led_import,
144 LDLM_BL_CALLBACK, 1, &size, NULL);
148 body = lustre_msg_buf(req->rq_reqmsg, 0);
149 memcpy(&body->lock_handle1, &lock->l_remote_handle,
150 sizeof(body->lock_handle1));
151 memcpy(&body->lock_desc, desc, sizeof(*desc));
153 LDLM_DEBUG(lock, "server preparing blocking AST");
154 req->rq_replen = 0; /* no reply needed */
156 ldlm_add_waiting_lock(lock);
157 (void)ptl_send_rpc(req);
159 /* no commit, and no waiting for reply, so 2x decref now */
160 ptlrpc_req_finished(req);
161 ptlrpc_req_finished(req);
166 static int ldlm_server_completion_ast(struct ldlm_lock *lock, int flags)
168 struct ldlm_request *body;
169 struct ptlrpc_request *req;
170 int rc = 0, size = sizeof(*body);
178 req = ptlrpc_prep_req(&lock->l_export->exp_ldlm_data.led_import,
179 LDLM_CP_CALLBACK, 1, &size, NULL);
183 body = lustre_msg_buf(req->rq_reqmsg, 0);
184 memcpy(&body->lock_handle1, &lock->l_remote_handle,
185 sizeof(body->lock_handle1));
186 body->lock_flags = flags;
187 ldlm_lock2desc(lock, &body->lock_desc);
189 LDLM_DEBUG(lock, "server preparing completion AST");
190 req->rq_replen = 0; /* no reply needed */
192 (void)ptl_send_rpc(req);
193 /* no commit, and no waiting for reply, so 2x decref now */
194 ptlrpc_req_finished(req);
195 ptlrpc_req_finished(req);
200 int ldlm_handle_enqueue(struct ptlrpc_request *req)
202 struct obd_device *obddev = req->rq_export->exp_obd;
203 struct ldlm_reply *dlm_rep;
204 struct ldlm_request *dlm_req;
205 int rc, size = sizeof(*dlm_rep), cookielen = 0;
208 struct ldlm_lock *lock = NULL;
212 LDLM_DEBUG_NOLOCK("server-side enqueue handler START");
214 dlm_req = lustre_msg_buf(req->rq_reqmsg, 0);
215 if (dlm_req->lock_desc.l_resource.lr_type == LDLM_MDSINTENT) {
216 /* In this case, the reply buffer is allocated deep in
217 * local_lock_enqueue by the policy function. */
219 cookielen = sizeof(*req);
221 rc = lustre_pack_msg(1, &size, NULL, &req->rq_replen,
224 CERROR("out of memory\n");
227 if (dlm_req->lock_desc.l_resource.lr_type == LDLM_EXTENT) {
228 cookie = &dlm_req->lock_desc.l_extent;
229 cookielen = sizeof(struct ldlm_extent);
233 /* XXX notice that this lock has no callback data: of course the
234 export would be exactly what we may want to use here... */
235 lock = ldlm_lock_create(obddev->obd_namespace,
236 &dlm_req->lock_handle2,
237 dlm_req->lock_desc.l_resource.lr_name,
238 dlm_req->lock_desc.l_resource.lr_type,
239 dlm_req->lock_desc.l_req_mode, NULL, 0);
241 GOTO(out, err = -ENOMEM);
243 memcpy(&lock->l_remote_handle, &dlm_req->lock_handle1,
244 sizeof(lock->l_remote_handle));
245 LDLM_DEBUG(lock, "server-side enqueue handler, new lock created");
247 flags = dlm_req->lock_flags;
248 err = ldlm_lock_enqueue(lock, cookie, cookielen, &flags,
249 ldlm_server_completion_ast,
250 ldlm_server_blocking_ast);
254 dlm_rep = lustre_msg_buf(req->rq_repmsg, 0);
255 dlm_rep->lock_flags = flags;
257 ldlm_lock2handle(lock, &dlm_rep->lock_handle);
258 if (dlm_req->lock_desc.l_resource.lr_type == LDLM_EXTENT)
259 memcpy(&dlm_rep->lock_extent, &lock->l_extent,
260 sizeof(lock->l_extent));
261 if (dlm_rep->lock_flags & LDLM_FL_LOCK_CHANGED) {
262 memcpy(dlm_rep->lock_resource_name, lock->l_resource->lr_name,
263 sizeof(dlm_rep->lock_resource_name));
264 dlm_rep->lock_mode = lock->l_req_mode;
267 lock->l_export = req->rq_export;
268 if (lock->l_export) {
269 l_lock(&lock->l_resource->lr_namespace->ns_lock);
270 list_add(&lock->l_export_chain,
271 &lock->l_export->exp_ldlm_data.led_held_locks);
272 l_unlock(&lock->l_resource->lr_namespace->ns_lock);
275 ptlrpc_connection_addref(req->rq_connection);
279 LDLM_DEBUG(lock, "server-side enqueue handler, sending reply"
281 req->rq_status = err;
283 if (ptlrpc_reply(req->rq_svc, req))
288 ldlm_reprocess_all(lock->l_resource);
291 LDLM_DEBUG_NOLOCK("server-side enqueue handler END (lock %p)", lock);
296 int ldlm_handle_convert(struct ptlrpc_request *req)
298 struct ldlm_request *dlm_req;
299 struct ldlm_reply *dlm_rep;
300 struct ldlm_lock *lock;
301 int rc, size = sizeof(*dlm_rep);
304 rc = lustre_pack_msg(1, &size, NULL, &req->rq_replen, &req->rq_repmsg);
306 CERROR("out of memory\n");
309 dlm_req = lustre_msg_buf(req->rq_reqmsg, 0);
310 dlm_rep = lustre_msg_buf(req->rq_repmsg, 0);
311 dlm_rep->lock_flags = dlm_req->lock_flags;
313 lock = ldlm_handle2lock(&dlm_req->lock_handle1);
315 req->rq_status = EINVAL;
317 LDLM_DEBUG(lock, "server-side convert handler START");
318 ldlm_lock_convert(lock, dlm_req->lock_desc.l_req_mode,
319 &dlm_rep->lock_flags);
320 if (ldlm_del_waiting_lock(lock))
321 CDEBUG(D_DLMTRACE, "converted waiting lock %p\n", lock);
324 if (ptlrpc_reply(req->rq_svc, req) != 0)
328 ldlm_reprocess_all(lock->l_resource);
329 LDLM_DEBUG(lock, "server-side convert handler END");
332 LDLM_DEBUG_NOLOCK("server-side convert handler END");
337 int ldlm_handle_cancel(struct ptlrpc_request *req)
339 struct ldlm_request *dlm_req;
340 struct ldlm_lock *lock;
344 rc = lustre_pack_msg(0, NULL, NULL, &req->rq_replen, &req->rq_repmsg);
346 CERROR("out of memory\n");
349 dlm_req = lustre_msg_buf(req->rq_reqmsg, 0);
351 CERROR("bad request buffer for cancel\n");
355 lock = ldlm_handle2lock(&dlm_req->lock_handle1);
357 LDLM_DEBUG_NOLOCK("server-side cancel handler stale lock (lock "
358 "%p)", (void *)(unsigned long)
359 dlm_req->lock_handle1.addr);
360 req->rq_status = ESTALE;
362 LDLM_DEBUG(lock, "server-side cancel handler START");
363 ldlm_lock_cancel(lock);
364 if (ldlm_del_waiting_lock(lock))
365 CDEBUG(D_DLMTRACE, "cancelled waiting lock %p\n", lock);
369 if (ptlrpc_reply(req->rq_svc, req) != 0)
373 ldlm_reprocess_all(lock->l_resource);
374 LDLM_DEBUG(lock, "server-side cancel handler END");
381 static int ldlm_handle_bl_callback(struct ptlrpc_request *req)
383 struct ldlm_request *dlm_req;
384 struct ldlm_lock *lock;
388 OBD_FAIL_RETURN(OBD_FAIL_OSC_LOCK_BL_AST, 0);
390 dlm_req = lustre_msg_buf(req->rq_reqmsg, 0);
392 lock = ldlm_handle2lock(&dlm_req->lock_handle1);
394 CERROR("blocking callback on lock "LPX64" - lock disappeared\n",
395 dlm_req->lock_handle1.addr);
399 LDLM_DEBUG(lock, "client blocking AST callback handler START");
401 l_lock(&lock->l_resource->lr_namespace->ns_lock);
402 lock->l_flags |= LDLM_FL_CBPENDING;
403 do_ast = (!lock->l_readers && !lock->l_writers);
404 l_unlock(&lock->l_resource->lr_namespace->ns_lock);
407 LDLM_DEBUG(lock, "already unused, calling "
408 "callback (%p)", lock->l_blocking_ast);
409 if (lock->l_blocking_ast != NULL) {
410 lock->l_blocking_ast(lock, &dlm_req->lock_desc,
411 lock->l_data, lock->l_data_len,
415 LDLM_DEBUG(lock, "Lock still has references, will be"
418 LDLM_DEBUG(lock, "client blocking callback handler END");
423 static int ldlm_handle_cp_callback(struct ptlrpc_request *req)
425 struct list_head ast_list = LIST_HEAD_INIT(ast_list);
426 struct ldlm_request *dlm_req;
427 struct ldlm_lock *lock;
430 OBD_FAIL_RETURN(OBD_FAIL_OSC_LOCK_CP_AST, 0);
432 dlm_req = lustre_msg_buf(req->rq_reqmsg, 0);
434 lock = ldlm_handle2lock(&dlm_req->lock_handle1);
436 CERROR("completion callback on lock "LPX64" - lock "
437 "disappeared\n", 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 lock modes, resources, or extents. */
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 if (lock->l_resource->lr_type == LDLM_EXTENT)
452 memcpy(&lock->l_extent, &dlm_req->lock_desc.l_extent,
453 sizeof(lock->l_extent));
454 ldlm_resource_unlink_lock(lock);
455 if (memcmp(dlm_req->lock_desc.l_resource.lr_name,
456 lock->l_resource->lr_name,
457 sizeof(__u64) * RES_NAME_SIZE) != 0) {
458 ldlm_lock_change_resource(lock, dlm_req->lock_desc.l_resource.lr_name);
459 LDLM_DEBUG(lock, "completion AST, new resource");
461 lock->l_resource->lr_tmp = &ast_list;
462 ldlm_grant_lock(lock);
463 lock->l_resource->lr_tmp = NULL;
464 l_unlock(&lock->l_resource->lr_namespace->ns_lock);
465 LDLM_DEBUG(lock, "callback handler finished, about to run_ast_work");
468 ldlm_run_ast_work(&ast_list);
470 LDLM_DEBUG_NOLOCK("client completion callback handler END (lock %p)",
475 static int ldlm_callback_handler(struct ptlrpc_request *req)
480 rc = lustre_unpack_msg(req->rq_reqmsg, req->rq_reqlen);
482 CERROR("lustre_ldlm: Invalid request: %d\n", rc);
486 if (req->rq_export == NULL) {
487 CERROR("lustre_dlm: operation %d with missing/invalid export\n",
488 req->rq_reqmsg->opc);
492 switch (req->rq_reqmsg->opc) {
493 case LDLM_BL_CALLBACK:
494 CDEBUG(D_INODE, "blocking ast\n");
495 OBD_FAIL_RETURN(OBD_FAIL_LDLM_BL_CALLBACK, 0);
496 rc = ldlm_handle_bl_callback(req);
498 case LDLM_CP_CALLBACK:
499 CDEBUG(D_INODE, "completion ast\n");
500 OBD_FAIL_RETURN(OBD_FAIL_LDLM_CP_CALLBACK, 0);
501 rc = ldlm_handle_cp_callback(req);
504 CERROR("invalid opcode %d\n", req->rq_reqmsg->opc);
512 static int ldlm_iocontrol(long cmd, struct lustre_handle *conn, int len,
513 void *karg, void *uarg)
515 struct obd_device *obddev = class_conn2obd(conn);
516 struct ptlrpc_connection *connection;
520 if (_IOC_TYPE(cmd) != IOC_LDLM_TYPE || _IOC_NR(cmd) < IOC_LDLM_MIN_NR ||
521 _IOC_NR(cmd) > IOC_LDLM_MAX_NR) {
522 CDEBUG(D_IOCTL, "invalid ioctl (type %ld, nr %ld, size %ld)\n",
523 _IOC_TYPE(cmd), _IOC_NR(cmd), _IOC_SIZE(cmd));
527 OBD_ALLOC(obddev->u.ldlm.ldlm_client,
528 sizeof(*obddev->u.ldlm.ldlm_client));
529 connection = ptlrpc_uuid_to_connection("ldlm");
531 CERROR("No LDLM UUID found: assuming ldlm is local.\n");
534 ptlrpc_init_client(LDLM_REQUEST_PORTAL, LDLM_REPLY_PORTAL,
535 obddev->u.ldlm.ldlm_client, connection);
540 err = ldlm_test(obddev, conn);
541 CERROR("-- done err %d\n", err);
544 ldlm_dump_all_namespaces();
547 GOTO(out, err = -EINVAL);
552 ptlrpc_put_connection(connection);
553 OBD_FREE(obddev->u.ldlm.ldlm_client,
554 sizeof(*obddev->u.ldlm.ldlm_client));
558 #define LDLM_NUM_THREADS 8
560 static int ldlm_setup(struct obd_device *obddev, obd_count len, void *buf)
562 struct ldlm_obd *ldlm = &obddev->u.ldlm;
568 rc = ldlm_proc_setup(obddev);
573 ptlrpc_init_svc(LDLM_NEVENTS, LDLM_NBUFS, LDLM_BUFSIZE,
574 LDLM_MAXREQSIZE, LDLM_REQUEST_PORTAL,
575 LDLM_REPLY_PORTAL, "self",
576 ldlm_callback_handler, "ldlm");
577 if (!ldlm->ldlm_service)
578 GOTO(out_dec, rc = -ENOMEM);
580 for (i = 0; i < LDLM_NUM_THREADS; i++) {
582 sprintf(name, "lustre_dlm_%02d", i);
583 rc = ptlrpc_start_thread(obddev, ldlm->ldlm_service, name);
585 CERROR("cannot start LDLM thread #%d: rc %d\n", i, rc);
587 GOTO(out_thread, rc);
591 INIT_LIST_HEAD(&waiting_locks_list);
592 spin_lock_init(&waiting_locks_spinlock);
593 waiting_locks_timer.function = waiting_locks_callback;
594 waiting_locks_timer.data = 0;
595 init_timer(&waiting_locks_timer);
600 ptlrpc_stop_all_threads(ldlm->ldlm_service);
601 ptlrpc_unregister_service(ldlm->ldlm_service);
605 ldlm_proc_cleanup(obddev);
612 static int ldlm_cleanup(struct obd_device *obddev)
614 struct ldlm_obd *ldlm = &obddev->u.ldlm;
617 if (!list_empty(&ldlm_namespace_list)) {
618 CERROR("ldlm still has namespaces; clean these up first.\n");
622 ptlrpc_stop_all_threads(ldlm->ldlm_service);
623 ptlrpc_unregister_service(ldlm->ldlm_service);
624 /* ldlm_proc_cleanup(obddev); */
630 struct obd_ops ldlm_obd_ops = {
631 o_iocontrol: ldlm_iocontrol,
633 o_cleanup: ldlm_cleanup,
634 o_connect: class_connect,
635 o_disconnect: class_disconnect
638 static int __init ldlm_init(void)
640 int rc = class_register_type(&ldlm_obd_ops, OBD_LDLM_DEVICENAME);
644 ldlm_resource_slab = kmem_cache_create("ldlm_resources",
645 sizeof(struct ldlm_resource), 0,
646 SLAB_HWCACHE_ALIGN, NULL, NULL);
647 if (ldlm_resource_slab == NULL)
650 ldlm_lock_slab = kmem_cache_create("ldlm_locks",
651 sizeof(struct ldlm_lock), 0,
652 SLAB_HWCACHE_ALIGN, NULL, NULL);
653 if (ldlm_lock_slab == NULL) {
654 kmem_cache_destroy(ldlm_resource_slab);
661 static void __exit ldlm_exit(void)
663 class_unregister_type(OBD_LDLM_DEVICENAME);
664 if (kmem_cache_destroy(ldlm_resource_slab) != 0)
665 CERROR("couldn't free ldlm resource slab\n");
666 if (kmem_cache_destroy(ldlm_lock_slab) != 0)
667 CERROR("couldn't free ldlm lock slab\n");
670 EXPORT_SYMBOL(ldlm_completion_ast);
671 EXPORT_SYMBOL(ldlm_handle_enqueue);
672 EXPORT_SYMBOL(ldlm_handle_cancel);
673 EXPORT_SYMBOL(ldlm_handle_convert);
674 EXPORT_SYMBOL(ldlm_register_intent);
675 EXPORT_SYMBOL(ldlm_unregister_intent);
676 EXPORT_SYMBOL(ldlm_lockname);
677 EXPORT_SYMBOL(ldlm_typename);
678 EXPORT_SYMBOL(ldlm_handle2lock);
679 EXPORT_SYMBOL(ldlm_lock2handle);
680 EXPORT_SYMBOL(ldlm_lock_put);
681 EXPORT_SYMBOL(ldlm_lock_match);
682 EXPORT_SYMBOL(ldlm_lock_addref);
683 EXPORT_SYMBOL(ldlm_lock_decref);
684 EXPORT_SYMBOL(ldlm_lock_change_resource);
685 EXPORT_SYMBOL(ldlm_cli_convert);
686 EXPORT_SYMBOL(ldlm_cli_enqueue);
687 EXPORT_SYMBOL(ldlm_cli_cancel);
688 EXPORT_SYMBOL(ldlm_cli_cancel_unused);
689 EXPORT_SYMBOL(ldlm_match_or_enqueue);
690 EXPORT_SYMBOL(ldlm_it2str);
691 EXPORT_SYMBOL(ldlm_test);
692 EXPORT_SYMBOL(ldlm_regression_start);
693 EXPORT_SYMBOL(ldlm_regression_stop);
694 EXPORT_SYMBOL(ldlm_lock_dump);
695 EXPORT_SYMBOL(ldlm_namespace_new);
696 EXPORT_SYMBOL(ldlm_namespace_free);
697 EXPORT_SYMBOL(ldlm_cancel_locks_for_export);
698 EXPORT_SYMBOL(l_lock);
699 EXPORT_SYMBOL(l_unlock);
701 MODULE_AUTHOR("Cluster File Systems, Inc. <info@clusterfs.com>");
702 MODULE_DESCRIPTION("Lustre Lock Management Module v0.1");
703 MODULE_LICENSE("GPL");
705 module_init(ldlm_init);
706 module_exit(ldlm_exit);