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;
47 static int ldlm_already_setup = 0;
49 static void waiting_locks_callback(unsigned long unused)
51 struct list_head *liter, *n;
53 spin_lock_bh(&waiting_locks_spinlock);
54 list_for_each_safe(liter, n, &waiting_locks_list) {
55 struct ldlm_lock *l = list_entry(liter, struct ldlm_lock,
57 if (l->l_callback_timeout > jiffies)
59 LDLM_DEBUG(l, "timer expired, recovering conn %p\n",
60 l->l_export->exp_connection);
61 recovd_conn_fail(l->l_export->exp_connection);
63 spin_unlock_bh(&waiting_locks_spinlock);
67 * Indicate that we're waiting for a client to call us back cancelling a given
68 * lock. We add it to the pending-callback chain, and schedule the lock-timeout
69 * timer to fire appropriately. (We round up to the next second, to avoid
70 * floods of timer firings during periods of high lock contention and traffic).
72 static int ldlm_add_waiting_lock(struct ldlm_lock *lock)
74 unsigned long timeout_rounded;
77 LASSERT(list_empty(&lock->l_pending_chain));
79 spin_lock_bh(&waiting_locks_spinlock);
80 lock->l_callback_timeout = jiffies + (obd_timeout * HZ);
82 timeout_rounded = round_timeout(lock->l_callback_timeout);
84 if (timeout_rounded < waiting_locks_timer.expires ||
85 !timer_pending(&waiting_locks_timer)) {
86 mod_timer(&waiting_locks_timer, timeout_rounded);
88 list_add_tail(&lock->l_pending_chain, &waiting_locks_list); /* FIFO */
89 spin_unlock_bh(&waiting_locks_spinlock);
94 * Remove a lock from the pending list, likely because it had its cancellation
95 * callback arrive without incident. This adjusts the lock-timeout timer if
96 * needed. Returns 0 if the lock wasn't pending after all, 1 if it was.
98 int ldlm_del_waiting_lock(struct ldlm_lock *lock)
100 struct list_head *list_next;
104 spin_lock_bh(&waiting_locks_spinlock);
106 if (list_empty(&lock->l_pending_chain)) {
107 spin_unlock_bh(&waiting_locks_spinlock);
111 list_next = lock->l_pending_chain.next;
112 if (lock->l_pending_chain.prev == &waiting_locks_list) {
113 /* Removing the head of the list, adjust timer. */
114 if (list_next == &waiting_locks_list) {
115 /* No more, just cancel. */
116 del_timer(&waiting_locks_timer);
118 struct ldlm_lock *next;
119 next = list_entry(list_next, struct ldlm_lock,
121 mod_timer(&waiting_locks_timer,
122 round_timeout(next->l_callback_timeout));
125 list_del_init(&lock->l_pending_chain);
126 spin_unlock_bh(&waiting_locks_spinlock);
130 static int ldlm_server_blocking_ast(struct ldlm_lock *lock,
131 struct ldlm_lock_desc *desc,
132 void *data, __u32 data_len, int flag)
134 struct ldlm_request *body;
135 struct ptlrpc_request *req;
136 int rc = 0, size = sizeof(*body);
139 if (flag == LDLM_CB_CANCELING) {
140 /* Don't need to do anything here. */
144 req = ptlrpc_prep_req(&lock->l_export->exp_ldlm_data.led_import,
145 LDLM_BL_CALLBACK, 1, &size, NULL);
149 body = lustre_msg_buf(req->rq_reqmsg, 0);
150 memcpy(&body->lock_handle1, &lock->l_remote_handle,
151 sizeof(body->lock_handle1));
152 memcpy(&body->lock_desc, desc, sizeof(*desc));
154 LDLM_DEBUG(lock, "server preparing blocking AST");
155 req->rq_replen = 0; /* no reply needed */
157 ldlm_add_waiting_lock(lock);
158 (void)ptl_send_rpc(req);
160 /* no commit, and no waiting for reply, so 2x decref now */
161 ptlrpc_req_finished(req);
162 ptlrpc_req_finished(req);
167 static int ldlm_server_completion_ast(struct ldlm_lock *lock, int flags)
169 struct ldlm_request *body;
170 struct ptlrpc_request *req;
171 int rc = 0, size = sizeof(*body);
179 req = ptlrpc_prep_req(&lock->l_export->exp_ldlm_data.led_import,
180 LDLM_CP_CALLBACK, 1, &size, NULL);
184 body = lustre_msg_buf(req->rq_reqmsg, 0);
185 memcpy(&body->lock_handle1, &lock->l_remote_handle,
186 sizeof(body->lock_handle1));
187 body->lock_flags = flags;
188 ldlm_lock2desc(lock, &body->lock_desc);
190 LDLM_DEBUG(lock, "server preparing completion AST");
191 req->rq_replen = 0; /* no reply needed */
193 (void)ptl_send_rpc(req);
194 /* no commit, and no waiting for reply, so 2x decref now */
195 ptlrpc_req_finished(req);
196 ptlrpc_req_finished(req);
201 int ldlm_handle_enqueue(struct ptlrpc_request *req)
203 struct obd_device *obddev = req->rq_export->exp_obd;
204 struct ldlm_reply *dlm_rep;
205 struct ldlm_request *dlm_req;
206 int rc, size = sizeof(*dlm_rep), cookielen = 0;
209 struct ldlm_lock *lock = NULL;
213 LDLM_DEBUG_NOLOCK("server-side enqueue handler START");
215 dlm_req = lustre_msg_buf(req->rq_reqmsg, 0);
216 if (dlm_req->lock_desc.l_resource.lr_type == LDLM_MDSINTENT) {
217 /* In this case, the reply buffer is allocated deep in
218 * local_lock_enqueue by the policy function. */
220 cookielen = sizeof(*req);
222 rc = lustre_pack_msg(1, &size, NULL, &req->rq_replen,
225 CERROR("out of memory\n");
228 if (dlm_req->lock_desc.l_resource.lr_type == LDLM_EXTENT) {
229 cookie = &dlm_req->lock_desc.l_extent;
230 cookielen = sizeof(struct ldlm_extent);
234 /* XXX notice that this lock has no callback data: of course the
235 export would be exactly what we may want to use here... */
236 lock = ldlm_lock_create(obddev->obd_namespace,
237 &dlm_req->lock_handle2,
238 dlm_req->lock_desc.l_resource.lr_name,
239 dlm_req->lock_desc.l_resource.lr_type,
240 dlm_req->lock_desc.l_req_mode, NULL, 0);
242 GOTO(out, err = -ENOMEM);
244 memcpy(&lock->l_remote_handle, &dlm_req->lock_handle1,
245 sizeof(lock->l_remote_handle));
246 LDLM_DEBUG(lock, "server-side enqueue handler, new lock created");
248 flags = dlm_req->lock_flags;
249 err = ldlm_lock_enqueue(lock, cookie, cookielen, &flags,
250 ldlm_server_completion_ast,
251 ldlm_server_blocking_ast);
255 dlm_rep = lustre_msg_buf(req->rq_repmsg, 0);
256 dlm_rep->lock_flags = flags;
258 ldlm_lock2handle(lock, &dlm_rep->lock_handle);
259 if (dlm_req->lock_desc.l_resource.lr_type == LDLM_EXTENT)
260 memcpy(&dlm_rep->lock_extent, &lock->l_extent,
261 sizeof(lock->l_extent));
262 if (dlm_rep->lock_flags & LDLM_FL_LOCK_CHANGED) {
263 memcpy(dlm_rep->lock_resource_name, lock->l_resource->lr_name,
264 sizeof(dlm_rep->lock_resource_name));
265 dlm_rep->lock_mode = lock->l_req_mode;
268 lock->l_export = req->rq_export;
269 if (lock->l_export) {
270 l_lock(&lock->l_resource->lr_namespace->ns_lock);
271 list_add(&lock->l_export_chain,
272 &lock->l_export->exp_ldlm_data.led_held_locks);
273 l_unlock(&lock->l_resource->lr_namespace->ns_lock);
276 ptlrpc_connection_addref(req->rq_connection);
280 LDLM_DEBUG(lock, "server-side enqueue handler, sending reply"
282 req->rq_status = err;
284 if (ptlrpc_reply(req->rq_svc, req))
289 ldlm_reprocess_all(lock->l_resource);
292 LDLM_DEBUG_NOLOCK("server-side enqueue handler END (lock %p)", lock);
297 int ldlm_handle_convert(struct ptlrpc_request *req)
299 struct ldlm_request *dlm_req;
300 struct ldlm_reply *dlm_rep;
301 struct ldlm_lock *lock;
302 int rc, size = sizeof(*dlm_rep);
305 rc = lustre_pack_msg(1, &size, NULL, &req->rq_replen, &req->rq_repmsg);
307 CERROR("out of memory\n");
310 dlm_req = lustre_msg_buf(req->rq_reqmsg, 0);
311 dlm_rep = lustre_msg_buf(req->rq_repmsg, 0);
312 dlm_rep->lock_flags = dlm_req->lock_flags;
314 lock = ldlm_handle2lock(&dlm_req->lock_handle1);
316 req->rq_status = EINVAL;
318 LDLM_DEBUG(lock, "server-side convert handler START");
319 ldlm_lock_convert(lock, dlm_req->lock_desc.l_req_mode,
320 &dlm_rep->lock_flags);
321 if (ldlm_del_waiting_lock(lock))
322 CDEBUG(D_DLMTRACE, "converted waiting lock %p\n", lock);
325 if (ptlrpc_reply(req->rq_svc, req) != 0)
329 ldlm_reprocess_all(lock->l_resource);
330 LDLM_DEBUG(lock, "server-side convert handler END");
333 LDLM_DEBUG_NOLOCK("server-side convert handler END");
338 int ldlm_handle_cancel(struct ptlrpc_request *req)
340 struct ldlm_request *dlm_req;
341 struct ldlm_lock *lock;
345 rc = lustre_pack_msg(0, NULL, NULL, &req->rq_replen, &req->rq_repmsg);
347 CERROR("out of memory\n");
350 dlm_req = lustre_msg_buf(req->rq_reqmsg, 0);
352 CERROR("bad request buffer for cancel\n");
356 lock = ldlm_handle2lock(&dlm_req->lock_handle1);
358 CERROR("bad lock handle\n");
359 LDLM_DEBUG_NOLOCK("server-side cancel handler stale lock (lock "
360 "%p)", (void *)(unsigned long)
361 dlm_req->lock_handle1.addr);
362 req->rq_status = ESTALE;
364 LDLM_DEBUG(lock, "server-side cancel handler START");
365 ldlm_lock_cancel(lock);
366 if (ldlm_del_waiting_lock(lock))
367 CDEBUG(D_DLMTRACE, "cancelled waiting lock %p\n", lock);
371 if (ptlrpc_reply(req->rq_svc, req) != 0)
375 ldlm_reprocess_all(lock->l_resource);
376 LDLM_DEBUG(lock, "server-side cancel handler END");
383 static int ldlm_handle_bl_callback(struct ptlrpc_request *req)
385 struct ldlm_request *dlm_req;
386 struct ldlm_lock *lock;
390 OBD_FAIL_RETURN(OBD_FAIL_OSC_LOCK_BL_AST, 0);
392 dlm_req = lustre_msg_buf(req->rq_reqmsg, 0);
394 lock = ldlm_handle2lock(&dlm_req->lock_handle1);
396 CERROR("blocking callback on lock "LPX64" - lock disappeared\n",
397 dlm_req->lock_handle1.addr);
401 LDLM_DEBUG(lock, "client blocking AST callback handler START");
403 l_lock(&lock->l_resource->lr_namespace->ns_lock);
404 lock->l_flags |= LDLM_FL_CBPENDING;
405 do_ast = (!lock->l_readers && !lock->l_writers);
406 l_unlock(&lock->l_resource->lr_namespace->ns_lock);
409 LDLM_DEBUG(lock, "already unused, calling "
410 "callback (%p)", lock->l_blocking_ast);
411 if (lock->l_blocking_ast != NULL) {
412 lock->l_blocking_ast(lock, &dlm_req->lock_desc,
413 lock->l_data, lock->l_data_len,
417 LDLM_DEBUG(lock, "Lock still has references, will be"
420 LDLM_DEBUG(lock, "client blocking callback handler END");
425 static int ldlm_handle_cp_callback(struct ptlrpc_request *req)
427 struct list_head ast_list = LIST_HEAD_INIT(ast_list);
428 struct ldlm_request *dlm_req;
429 struct ldlm_lock *lock;
432 OBD_FAIL_RETURN(OBD_FAIL_OSC_LOCK_CP_AST, 0);
434 dlm_req = lustre_msg_buf(req->rq_reqmsg, 0);
436 lock = ldlm_handle2lock(&dlm_req->lock_handle1);
438 CERROR("completion callback on lock "LPX64" - lock "
439 "disappeared\n", dlm_req->lock_handle1.addr);
443 LDLM_DEBUG(lock, "client completion callback handler START");
445 l_lock(&lock->l_resource->lr_namespace->ns_lock);
447 /* If we receive the completion AST before the actual enqueue returned,
448 * then we might need to switch lock modes, resources, or extents. */
449 if (dlm_req->lock_desc.l_granted_mode != lock->l_req_mode) {
450 lock->l_req_mode = dlm_req->lock_desc.l_granted_mode;
451 LDLM_DEBUG(lock, "completion AST, new lock mode");
453 if (lock->l_resource->lr_type == LDLM_EXTENT)
454 memcpy(&lock->l_extent, &dlm_req->lock_desc.l_extent,
455 sizeof(lock->l_extent));
456 ldlm_resource_unlink_lock(lock);
457 if (memcmp(dlm_req->lock_desc.l_resource.lr_name,
458 lock->l_resource->lr_name,
459 sizeof(__u64) * RES_NAME_SIZE) != 0) {
460 ldlm_lock_change_resource(lock, dlm_req->lock_desc.l_resource.lr_name);
461 LDLM_DEBUG(lock, "completion AST, new resource");
463 lock->l_resource->lr_tmp = &ast_list;
464 ldlm_grant_lock(lock);
465 lock->l_resource->lr_tmp = NULL;
466 l_unlock(&lock->l_resource->lr_namespace->ns_lock);
467 LDLM_DEBUG(lock, "callback handler finished, about to run_ast_work");
470 ldlm_run_ast_work(&ast_list);
472 LDLM_DEBUG_NOLOCK("client completion callback handler END (lock %p)",
477 static int ldlm_callback_handler(struct ptlrpc_request *req)
482 rc = lustre_unpack_msg(req->rq_reqmsg, req->rq_reqlen);
484 CERROR("lustre_ldlm: Invalid request: %d\n", rc);
488 if (req->rq_export == NULL) {
489 CERROR("lustre_dlm: operation %d with missing/invalid export\n",
490 req->rq_reqmsg->opc);
494 switch (req->rq_reqmsg->opc) {
495 case LDLM_BL_CALLBACK:
496 CDEBUG(D_INODE, "blocking ast\n");
497 OBD_FAIL_RETURN(OBD_FAIL_LDLM_BL_CALLBACK, 0);
498 rc = ldlm_handle_bl_callback(req);
500 case LDLM_CP_CALLBACK:
501 CDEBUG(D_INODE, "completion ast\n");
502 OBD_FAIL_RETURN(OBD_FAIL_LDLM_CP_CALLBACK, 0);
503 rc = ldlm_handle_cp_callback(req);
506 CERROR("invalid opcode %d\n", req->rq_reqmsg->opc);
514 static int ldlm_iocontrol(long cmd, struct lustre_handle *conn, int len,
515 void *karg, void *uarg)
517 struct obd_device *obddev = class_conn2obd(conn);
518 struct ptlrpc_connection *connection;
522 if (_IOC_TYPE(cmd) != IOC_LDLM_TYPE || _IOC_NR(cmd) < IOC_LDLM_MIN_NR ||
523 _IOC_NR(cmd) > IOC_LDLM_MAX_NR) {
524 CDEBUG(D_IOCTL, "invalid ioctl (type %ld, nr %ld, size %ld)\n",
525 _IOC_TYPE(cmd), _IOC_NR(cmd), _IOC_SIZE(cmd));
529 OBD_ALLOC(obddev->u.ldlm.ldlm_client,
530 sizeof(*obddev->u.ldlm.ldlm_client));
531 connection = ptlrpc_uuid_to_connection("ldlm");
533 CERROR("No LDLM UUID found: assuming ldlm is local.\n");
536 ptlrpc_init_client(LDLM_REQUEST_PORTAL, LDLM_REPLY_PORTAL,
537 obddev->u.ldlm.ldlm_client, connection);
542 err = ldlm_test(obddev, conn);
543 CERROR("-- done err %d\n", err);
546 ldlm_dump_all_namespaces();
549 GOTO(out, err = -EINVAL);
554 ptlrpc_put_connection(connection);
555 OBD_FREE(obddev->u.ldlm.ldlm_client,
556 sizeof(*obddev->u.ldlm.ldlm_client));
560 #define LDLM_NUM_THREADS 8
562 static int ldlm_setup(struct obd_device *obddev, obd_count len, void *buf)
564 struct ldlm_obd *ldlm = &obddev->u.ldlm;
568 if (ldlm_already_setup)
573 rc = ldlm_proc_setup(obddev);
578 ptlrpc_init_svc(LDLM_NEVENTS, LDLM_NBUFS, LDLM_BUFSIZE,
579 LDLM_MAXREQSIZE, LDLM_REQUEST_PORTAL,
580 LDLM_REPLY_PORTAL, "self",
581 ldlm_callback_handler, "ldlm");
582 if (!ldlm->ldlm_service)
583 GOTO(out_dec, rc = -ENOMEM);
585 for (i = 0; i < LDLM_NUM_THREADS; i++) {
587 sprintf(name, "lustre_dlm_%02d", i);
588 rc = ptlrpc_start_thread(obddev, ldlm->ldlm_service, name);
590 CERROR("cannot start LDLM thread #%d: rc %d\n", i, rc);
592 GOTO(out_thread, rc);
596 INIT_LIST_HEAD(&waiting_locks_list);
597 spin_lock_init(&waiting_locks_spinlock);
598 waiting_locks_timer.function = waiting_locks_callback;
599 waiting_locks_timer.data = 0;
600 init_timer(&waiting_locks_timer);
602 ldlm_already_setup = 1;
607 ptlrpc_stop_all_threads(ldlm->ldlm_service);
608 ptlrpc_unregister_service(ldlm->ldlm_service);
612 ldlm_proc_cleanup(obddev);
619 static int ldlm_cleanup(struct obd_device *obddev)
621 struct ldlm_obd *ldlm = &obddev->u.ldlm;
624 if (!list_empty(&ldlm_namespace_list)) {
625 CERROR("ldlm still has namespaces; clean these up first.\n");
629 ptlrpc_stop_all_threads(ldlm->ldlm_service);
630 ptlrpc_unregister_service(ldlm->ldlm_service);
631 /* ldlm_proc_cleanup(obddev); */
633 ldlm_already_setup = 0;
638 static int ldlm_connect(struct lustre_handle *conn, struct obd_device *src,
639 obd_uuid_t cluuid, struct recovd_obd *recovd,
640 ptlrpc_recovery_cb_t recover)
642 return class_connect(conn, src, cluuid);
645 struct obd_ops ldlm_obd_ops = {
646 o_iocontrol: ldlm_iocontrol,
648 o_cleanup: ldlm_cleanup,
649 o_connect: ldlm_connect,
650 o_disconnect: class_disconnect
653 static int __init ldlm_init(void)
655 int rc = class_register_type(&ldlm_obd_ops, OBD_LDLM_DEVICENAME);
659 ldlm_resource_slab = kmem_cache_create("ldlm_resources",
660 sizeof(struct ldlm_resource), 0,
661 SLAB_HWCACHE_ALIGN, NULL, NULL);
662 if (ldlm_resource_slab == NULL)
665 ldlm_lock_slab = kmem_cache_create("ldlm_locks",
666 sizeof(struct ldlm_lock), 0,
667 SLAB_HWCACHE_ALIGN, NULL, NULL);
668 if (ldlm_lock_slab == NULL) {
669 kmem_cache_destroy(ldlm_resource_slab);
676 static void __exit ldlm_exit(void)
678 class_unregister_type(OBD_LDLM_DEVICENAME);
679 if (kmem_cache_destroy(ldlm_resource_slab) != 0)
680 CERROR("couldn't free ldlm resource slab\n");
681 if (kmem_cache_destroy(ldlm_lock_slab) != 0)
682 CERROR("couldn't free ldlm lock slab\n");
685 EXPORT_SYMBOL(ldlm_completion_ast);
686 EXPORT_SYMBOL(ldlm_handle_enqueue);
687 EXPORT_SYMBOL(ldlm_handle_cancel);
688 EXPORT_SYMBOL(ldlm_handle_convert);
689 EXPORT_SYMBOL(ldlm_register_intent);
690 EXPORT_SYMBOL(ldlm_unregister_intent);
691 EXPORT_SYMBOL(ldlm_lockname);
692 EXPORT_SYMBOL(ldlm_typename);
693 EXPORT_SYMBOL(ldlm_handle2lock);
694 EXPORT_SYMBOL(ldlm_lock2handle);
695 EXPORT_SYMBOL(ldlm_lock_put);
696 EXPORT_SYMBOL(ldlm_lock_match);
697 EXPORT_SYMBOL(ldlm_lock_addref);
698 EXPORT_SYMBOL(ldlm_lock_decref);
699 EXPORT_SYMBOL(ldlm_lock_change_resource);
700 EXPORT_SYMBOL(ldlm_cli_convert);
701 EXPORT_SYMBOL(ldlm_cli_enqueue);
702 EXPORT_SYMBOL(ldlm_cli_cancel);
703 EXPORT_SYMBOL(ldlm_cli_cancel_unused);
704 EXPORT_SYMBOL(ldlm_match_or_enqueue);
705 EXPORT_SYMBOL(ldlm_it2str);
706 EXPORT_SYMBOL(ldlm_test);
707 EXPORT_SYMBOL(ldlm_regression_start);
708 EXPORT_SYMBOL(ldlm_regression_stop);
709 EXPORT_SYMBOL(ldlm_lock_dump);
710 EXPORT_SYMBOL(ldlm_namespace_new);
711 EXPORT_SYMBOL(ldlm_namespace_free);
712 EXPORT_SYMBOL(ldlm_cancel_locks_for_export);
713 EXPORT_SYMBOL(l_lock);
714 EXPORT_SYMBOL(l_unlock);
716 MODULE_AUTHOR("Cluster File Systems, Inc. <info@clusterfs.com>");
717 MODULE_DESCRIPTION("Lustre Lock Management Module v0.1");
718 MODULE_LICENSE("GPL");
720 module_init(ldlm_init);
721 module_exit(ldlm_exit);