2 * linux/fs/lockd/clntproc.c
4 * RPC procedures for the client side NLM implementation
6 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
9 #include <linux/module.h>
10 #include <linux/types.h>
11 #include <linux/errno.h>
13 #include <linux/nfs_fs.h>
14 #include <linux/utsname.h>
15 #include <linux/freezer.h>
16 #include <linux/sunrpc/clnt.h>
17 #include <linux/sunrpc/svc.h>
18 #include <linux/lockd/lockd.h>
19 #include <linux/lockd/sm_inter.h>
21 #define NLMDBG_FACILITY NLMDBG_CLIENT
22 #define NLMCLNT_GRACE_WAIT (5*HZ)
23 #define NLMCLNT_POLL_TIMEOUT (30*HZ)
24 #define NLMCLNT_MAX_RETRIES 3
26 static int nlmclnt_test(struct nlm_rqst *, struct file_lock *);
27 static int nlmclnt_lock(struct nlm_rqst *, struct file_lock *);
28 static int nlmclnt_unlock(struct nlm_rqst *, struct file_lock *);
29 static int nlm_stat_to_errno(__be32 stat);
30 static void nlmclnt_locks_init_private(struct file_lock *fl, struct nlm_host *host);
31 static int nlmclnt_cancel(struct nlm_host *, int , struct file_lock *);
33 static const struct rpc_call_ops nlmclnt_unlock_ops;
34 static const struct rpc_call_ops nlmclnt_cancel_ops;
37 * Cookie counter for NLM requests
39 static atomic_t nlm_cookie = ATOMIC_INIT(0x1234);
41 void nlmclnt_next_cookie(struct nlm_cookie *c)
43 u32 cookie = atomic_inc_return(&nlm_cookie);
45 memcpy(c->data, &cookie, 4);
49 static struct nlm_lockowner *nlm_get_lockowner(struct nlm_lockowner *lockowner)
51 atomic_inc(&lockowner->count);
55 static void nlm_put_lockowner(struct nlm_lockowner *lockowner)
57 if (!atomic_dec_and_lock(&lockowner->count, &lockowner->host->h_lock))
59 list_del(&lockowner->list);
60 spin_unlock(&lockowner->host->h_lock);
61 nlm_release_host(lockowner->host);
65 static inline int nlm_pidbusy(struct nlm_host *host, uint32_t pid)
67 struct nlm_lockowner *lockowner;
68 list_for_each_entry(lockowner, &host->h_lockowners, list) {
69 if (lockowner->pid == pid)
75 static inline uint32_t __nlm_alloc_pid(struct nlm_host *host)
79 res = host->h_pidcount++;
80 } while (nlm_pidbusy(host, res) < 0);
84 static struct nlm_lockowner *__nlm_find_lockowner(struct nlm_host *host, fl_owner_t owner)
86 struct nlm_lockowner *lockowner;
87 list_for_each_entry(lockowner, &host->h_lockowners, list) {
88 if (lockowner->owner != owner)
90 return nlm_get_lockowner(lockowner);
95 static struct nlm_lockowner *nlm_find_lockowner(struct nlm_host *host, fl_owner_t owner)
97 struct nlm_lockowner *res, *new = NULL;
99 spin_lock(&host->h_lock);
100 res = __nlm_find_lockowner(host, owner);
102 spin_unlock(&host->h_lock);
103 new = kmalloc(sizeof(*new), GFP_KERNEL);
104 spin_lock(&host->h_lock);
105 res = __nlm_find_lockowner(host, owner);
106 if (res == NULL && new != NULL) {
108 atomic_set(&new->count, 1);
110 new->pid = __nlm_alloc_pid(host);
111 new->host = nlm_get_host(host);
112 list_add(&new->list, &host->h_lockowners);
116 spin_unlock(&host->h_lock);
122 * Initialize arguments for TEST/LOCK/UNLOCK/CANCEL calls
124 static void nlmclnt_setlockargs(struct nlm_rqst *req, struct file_lock *fl)
126 struct nlm_args *argp = &req->a_args;
127 struct nlm_lock *lock = &argp->lock;
129 nlmclnt_next_cookie(&argp->cookie);
130 argp->state = nsm_local_state;
131 memcpy(&lock->fh, NFS_FH(fl->fl_file->f_path.dentry->d_inode), sizeof(struct nfs_fh));
132 lock->caller = utsname()->nodename;
133 lock->oh.data = req->a_owner;
134 lock->oh.len = snprintf(req->a_owner, sizeof(req->a_owner), "%u@%s",
135 (unsigned int)fl->fl_u.nfs_fl.owner->pid,
136 utsname()->nodename);
137 lock->svid = fl->fl_u.nfs_fl.owner->pid;
138 lock->fl.fl_start = fl->fl_start;
139 lock->fl.fl_end = fl->fl_end;
140 lock->fl.fl_type = fl->fl_type;
143 static void nlmclnt_release_lockargs(struct nlm_rqst *req)
145 BUG_ON(req->a_args.lock.fl.fl_ops != NULL);
149 * nlmclnt_proc - Perform a single client-side lock request
150 * @host: address of a valid nlm_host context representing the NLM server
151 * @cmd: fcntl-style file lock operation to perform
152 * @fl: address of arguments for the lock operation
155 int nlmclnt_proc(struct nlm_host *host, int cmd, struct file_lock *fl)
157 struct nlm_rqst *call;
163 call = nlm_alloc_call(host);
167 nlmclnt_locks_init_private(fl, host);
168 /* Set up the argument struct */
169 nlmclnt_setlockargs(call, fl);
171 /* Keep the old signal mask */
172 spin_lock_irqsave(¤t->sighand->siglock, flags);
173 oldset = current->blocked;
175 /* If we're cleaning up locks because the process is exiting,
176 * perform the RPC call asynchronously. */
177 if ((IS_SETLK(cmd) || IS_SETLKW(cmd))
178 && fl->fl_type == F_UNLCK
179 && (current->flags & PF_EXITING)) {
180 sigfillset(¤t->blocked); /* Mask all signals */
183 call->a_flags = RPC_TASK_ASYNC;
185 spin_unlock_irqrestore(¤t->sighand->siglock, flags);
187 if (IS_SETLK(cmd) || IS_SETLKW(cmd)) {
188 if (fl->fl_type != F_UNLCK) {
189 call->a_args.block = IS_SETLKW(cmd) ? 1 : 0;
190 status = nlmclnt_lock(call, fl);
192 status = nlmclnt_unlock(call, fl);
193 } else if (IS_GETLK(cmd))
194 status = nlmclnt_test(call, fl);
198 fl->fl_ops->fl_release_private(fl);
201 spin_lock_irqsave(¤t->sighand->siglock, flags);
202 current->blocked = oldset;
204 spin_unlock_irqrestore(¤t->sighand->siglock, flags);
206 dprintk("lockd: clnt proc returns %d\n", status);
209 EXPORT_SYMBOL_GPL(nlmclnt_proc);
212 * Allocate an NLM RPC call struct
214 * Note: the caller must hold a reference to host. In case of failure,
215 * this reference will be released.
217 struct nlm_rqst *nlm_alloc_call(struct nlm_host *host)
219 struct nlm_rqst *call;
222 call = kzalloc(sizeof(*call), GFP_KERNEL);
224 atomic_set(&call->a_count, 1);
225 locks_init_lock(&call->a_args.lock.fl);
226 locks_init_lock(&call->a_res.lock.fl);
232 printk("nlm_alloc_call: failed, waiting for memory\n");
233 schedule_timeout_interruptible(5*HZ);
235 nlm_release_host(host);
239 void nlm_release_call(struct nlm_rqst *call)
241 if (!atomic_dec_and_test(&call->a_count))
243 nlm_release_host(call->a_host);
244 nlmclnt_release_lockargs(call);
248 static void nlmclnt_rpc_release(void *data)
250 nlm_release_call(data);
253 static int nlm_wait_on_grace(wait_queue_head_t *queue)
258 prepare_to_wait(queue, &wait, TASK_INTERRUPTIBLE);
260 schedule_timeout(NLMCLNT_GRACE_WAIT);
265 finish_wait(queue, &wait);
273 nlmclnt_call(struct nlm_rqst *req, u32 proc)
275 struct nlm_host *host = req->a_host;
276 struct rpc_clnt *clnt;
277 struct nlm_args *argp = &req->a_args;
278 struct nlm_res *resp = &req->a_res;
279 struct rpc_message msg = {
285 dprintk("lockd: call procedure %d on %s\n",
286 (int)proc, host->h_name);
289 if (host->h_reclaiming && !argp->reclaim)
290 goto in_grace_period;
292 /* If we have no RPC client yet, create one. */
293 if ((clnt = nlm_bind_host(host)) == NULL)
295 msg.rpc_proc = &clnt->cl_procinfo[proc];
297 /* Perform the RPC call. If an error occurs, try again */
298 if ((status = rpc_call_sync(clnt, &msg, 0)) < 0) {
299 dprintk("lockd: rpc_call returned error %d\n", -status);
301 case -EPROTONOSUPPORT:
307 nlm_rebind_host(host);
311 return signalled () ? -EINTR : status;
317 if (resp->status == nlm_lck_denied_grace_period) {
318 dprintk("lockd: server in grace period\n");
321 "lockd: spurious grace period reject?!\n");
325 if (!argp->reclaim) {
326 /* We appear to be out of the grace period */
327 wake_up_all(&host->h_gracewait);
329 dprintk("lockd: server returns status %d\n", resp->status);
330 return 0; /* Okay, call complete */
335 * The server has rebooted and appears to be in the grace
336 * period during which locks are only allowed to be
338 * We can only back off and try again later.
340 status = nlm_wait_on_grace(&host->h_gracewait);
341 } while (status == 0);
347 * Generic NLM call, async version.
349 static struct rpc_task *__nlm_async_call(struct nlm_rqst *req, u32 proc, struct rpc_message *msg, const struct rpc_call_ops *tk_ops)
351 struct nlm_host *host = req->a_host;
352 struct rpc_clnt *clnt;
353 struct rpc_task_setup task_setup_data = {
355 .callback_ops = tk_ops,
356 .callback_data = req,
357 .flags = RPC_TASK_ASYNC,
360 dprintk("lockd: call procedure %d on %s (async)\n",
361 (int)proc, host->h_name);
363 /* If we have no RPC client yet, create one. */
364 clnt = nlm_bind_host(host);
367 msg->rpc_proc = &clnt->cl_procinfo[proc];
368 task_setup_data.rpc_client = clnt;
370 /* bootstrap and kick off the async RPC call */
371 return rpc_run_task(&task_setup_data);
373 tk_ops->rpc_release(req);
374 return ERR_PTR(-ENOLCK);
377 static int nlm_do_async_call(struct nlm_rqst *req, u32 proc, struct rpc_message *msg, const struct rpc_call_ops *tk_ops)
379 struct rpc_task *task;
381 task = __nlm_async_call(req, proc, msg, tk_ops);
383 return PTR_ERR(task);
389 * NLM asynchronous call.
391 int nlm_async_call(struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops)
393 struct rpc_message msg = {
394 .rpc_argp = &req->a_args,
395 .rpc_resp = &req->a_res,
397 return nlm_do_async_call(req, proc, &msg, tk_ops);
400 int nlm_async_reply(struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops)
402 struct rpc_message msg = {
403 .rpc_argp = &req->a_res,
405 return nlm_do_async_call(req, proc, &msg, tk_ops);
409 * NLM client asynchronous call.
411 * Note that although the calls are asynchronous, and are therefore
412 * guaranteed to complete, we still always attempt to wait for
413 * completion in order to be able to correctly track the lock
416 static int nlmclnt_async_call(struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops)
418 struct rpc_message msg = {
419 .rpc_argp = &req->a_args,
420 .rpc_resp = &req->a_res,
422 struct rpc_task *task;
425 task = __nlm_async_call(req, proc, &msg, tk_ops);
427 return PTR_ERR(task);
428 err = rpc_wait_for_completion_task(task);
434 * TEST for the presence of a conflicting lock
437 nlmclnt_test(struct nlm_rqst *req, struct file_lock *fl)
441 status = nlmclnt_call(req, NLMPROC_TEST);
445 switch (req->a_res.status) {
447 fl->fl_type = F_UNLCK;
451 * Report the conflicting lock back to the application.
453 fl->fl_start = req->a_res.lock.fl.fl_start;
454 fl->fl_end = req->a_res.lock.fl.fl_start;
455 fl->fl_type = req->a_res.lock.fl.fl_type;
459 status = nlm_stat_to_errno(req->a_res.status);
462 nlm_release_call(req);
466 static void nlmclnt_locks_copy_lock(struct file_lock *new, struct file_lock *fl)
468 new->fl_u.nfs_fl.state = fl->fl_u.nfs_fl.state;
469 new->fl_u.nfs_fl.owner = nlm_get_lockowner(fl->fl_u.nfs_fl.owner);
470 list_add_tail(&new->fl_u.nfs_fl.list, &fl->fl_u.nfs_fl.owner->host->h_granted);
473 static void nlmclnt_locks_release_private(struct file_lock *fl)
475 list_del(&fl->fl_u.nfs_fl.list);
476 nlm_put_lockowner(fl->fl_u.nfs_fl.owner);
479 static struct file_lock_operations nlmclnt_lock_ops = {
480 .fl_copy_lock = nlmclnt_locks_copy_lock,
481 .fl_release_private = nlmclnt_locks_release_private,
484 static void nlmclnt_locks_init_private(struct file_lock *fl, struct nlm_host *host)
486 BUG_ON(fl->fl_ops != NULL);
487 fl->fl_u.nfs_fl.state = 0;
488 fl->fl_u.nfs_fl.owner = nlm_find_lockowner(host, fl->fl_owner);
489 INIT_LIST_HEAD(&fl->fl_u.nfs_fl.list);
490 fl->fl_ops = &nlmclnt_lock_ops;
493 static int do_vfs_lock(struct file_lock *fl)
496 switch (fl->fl_flags & (FL_POSIX|FL_FLOCK)) {
498 res = posix_lock_file_wait(fl->fl_file, fl);
501 res = flock_lock_file_wait(fl->fl_file, fl);
510 * LOCK: Try to create a lock
512 * Programmer Harassment Alert
514 * When given a blocking lock request in a sync RPC call, the HPUX lockd
515 * will faithfully return LCK_BLOCKED but never cares to notify us when
516 * the lock could be granted. This way, our local process could hang
517 * around forever waiting for the callback.
519 * Solution A: Implement busy-waiting
520 * Solution B: Use the async version of the call (NLM_LOCK_{MSG,RES})
522 * For now I am implementing solution A, because I hate the idea of
523 * re-implementing lockd for a third time in two months. The async
524 * calls shouldn't be too hard to do, however.
526 * This is one of the lovely things about standards in the NFS area:
527 * they're so soft and squishy you can't really blame HP for doing this.
530 nlmclnt_lock(struct nlm_rqst *req, struct file_lock *fl)
532 struct nlm_host *host = req->a_host;
533 struct nlm_res *resp = &req->a_res;
534 struct nlm_wait *block = NULL;
535 unsigned char fl_flags = fl->fl_flags;
536 int status = -ENOLCK;
538 if (nsm_monitor(host) < 0) {
539 printk(KERN_NOTICE "lockd: failed to monitor %s\n",
543 fl->fl_flags |= FL_ACCESS;
544 status = do_vfs_lock(fl);
545 fl->fl_flags = fl_flags;
549 block = nlmclnt_prepare_block(host, fl);
552 /* Reboot protection */
553 fl->fl_u.nfs_fl.state = host->h_state;
554 status = nlmclnt_call(req, NLMPROC_LOCK);
557 if (!req->a_args.block)
559 /* Did a reclaimer thread notify us of a server reboot? */
560 if (resp->status == nlm_lck_denied_grace_period)
562 if (resp->status != nlm_lck_blocked)
564 /* Wait on an NLM blocking lock */
565 status = nlmclnt_block(block, req, NLMCLNT_POLL_TIMEOUT);
566 /* if we were interrupted. Send a CANCEL request to the server
571 if (resp->status != nlm_lck_blocked)
575 if (resp->status == nlm_granted) {
576 down_read(&host->h_rwsem);
577 /* Check whether or not the server has rebooted */
578 if (fl->fl_u.nfs_fl.state != host->h_state) {
579 up_read(&host->h_rwsem);
582 /* Ensure the resulting lock will get added to granted list */
583 fl->fl_flags |= FL_SLEEP;
584 if (do_vfs_lock(fl) < 0)
585 printk(KERN_WARNING "%s: VFS is out of sync with lock manager!\n", __FUNCTION__);
586 up_read(&host->h_rwsem);
587 fl->fl_flags = fl_flags;
589 status = nlm_stat_to_errno(resp->status);
591 nlmclnt_finish_block(block);
592 /* Cancel the blocked request if it is still pending */
593 if (resp->status == nlm_lck_blocked)
594 nlmclnt_cancel(host, req->a_args.block, fl);
596 nlm_release_call(req);
601 * RECLAIM: Try to reclaim a lock
604 nlmclnt_reclaim(struct nlm_host *host, struct file_lock *fl)
606 struct nlm_rqst reqst, *req;
610 memset(req, 0, sizeof(*req));
611 locks_init_lock(&req->a_args.lock.fl);
612 locks_init_lock(&req->a_res.lock.fl);
616 /* Set up the argument struct */
617 nlmclnt_setlockargs(req, fl);
618 req->a_args.reclaim = 1;
620 if ((status = nlmclnt_call(req, NLMPROC_LOCK)) >= 0
621 && req->a_res.status == nlm_granted)
624 printk(KERN_WARNING "lockd: failed to reclaim lock for pid %d "
625 "(errno %d, status %d)\n", fl->fl_pid,
626 status, ntohl(req->a_res.status));
629 * FIXME: This is a serious failure. We can
631 * a. Ignore the problem
632 * b. Send the owning process some signal (Linux doesn't have
633 * SIGLOST, though...)
634 * c. Retry the operation
636 * Until someone comes up with a simple implementation
637 * for b or c, I'll choose option a.
644 * UNLOCK: remove an existing lock
647 nlmclnt_unlock(struct nlm_rqst *req, struct file_lock *fl)
649 struct nlm_host *host = req->a_host;
650 struct nlm_res *resp = &req->a_res;
652 unsigned char fl_flags = fl->fl_flags;
655 * Note: the server is supposed to either grant us the unlock
656 * request, or to deny it with NLM_LCK_DENIED_GRACE_PERIOD. In either
657 * case, we want to unlock.
659 fl->fl_flags |= FL_EXISTS;
660 down_read(&host->h_rwsem);
661 status = do_vfs_lock(fl);
662 up_read(&host->h_rwsem);
663 fl->fl_flags = fl_flags;
664 if (status == -ENOENT) {
669 atomic_inc(&req->a_count);
670 status = nlmclnt_async_call(req, NLMPROC_UNLOCK, &nlmclnt_unlock_ops);
674 if (resp->status == nlm_granted)
677 if (resp->status != nlm_lck_denied_nolocks)
678 printk("lockd: unexpected unlock status: %d\n", resp->status);
679 /* What to do now? I'm out of my depth... */
682 nlm_release_call(req);
686 static void nlmclnt_unlock_callback(struct rpc_task *task, void *data)
688 struct nlm_rqst *req = data;
689 u32 status = ntohl(req->a_res.status);
691 if (RPC_ASSASSINATED(task))
694 if (task->tk_status < 0) {
695 dprintk("lockd: unlock failed (err = %d)\n", -task->tk_status);
698 if (status == NLM_LCK_DENIED_GRACE_PERIOD) {
699 rpc_delay(task, NLMCLNT_GRACE_WAIT);
702 if (status != NLM_LCK_GRANTED)
703 printk(KERN_WARNING "lockd: unexpected unlock status: %d\n", status);
707 nlm_rebind_host(req->a_host);
709 rpc_restart_call(task);
712 static const struct rpc_call_ops nlmclnt_unlock_ops = {
713 .rpc_call_done = nlmclnt_unlock_callback,
714 .rpc_release = nlmclnt_rpc_release,
718 * Cancel a blocked lock request.
719 * We always use an async RPC call for this in order not to hang a
720 * process that has been Ctrl-C'ed.
722 static int nlmclnt_cancel(struct nlm_host *host, int block, struct file_lock *fl)
724 struct nlm_rqst *req;
729 /* Block all signals while setting up call */
730 spin_lock_irqsave(¤t->sighand->siglock, flags);
731 oldset = current->blocked;
732 sigfillset(¤t->blocked);
734 spin_unlock_irqrestore(¤t->sighand->siglock, flags);
736 req = nlm_alloc_call(nlm_get_host(host));
739 req->a_flags = RPC_TASK_ASYNC;
741 nlmclnt_setlockargs(req, fl);
742 req->a_args.block = block;
744 status = nlmclnt_async_call(req, NLMPROC_CANCEL, &nlmclnt_cancel_ops);
746 spin_lock_irqsave(¤t->sighand->siglock, flags);
747 current->blocked = oldset;
749 spin_unlock_irqrestore(¤t->sighand->siglock, flags);
754 static void nlmclnt_cancel_callback(struct rpc_task *task, void *data)
756 struct nlm_rqst *req = data;
757 u32 status = ntohl(req->a_res.status);
759 if (RPC_ASSASSINATED(task))
762 if (task->tk_status < 0) {
763 dprintk("lockd: CANCEL call error %d, retrying.\n",
768 dprintk("lockd: cancel status %u (task %u)\n",
769 status, task->tk_pid);
772 case NLM_LCK_GRANTED:
773 case NLM_LCK_DENIED_GRACE_PERIOD:
775 /* Everything's good */
777 case NLM_LCK_DENIED_NOLOCKS:
778 dprintk("lockd: CANCEL failed (server has no locks)\n");
781 printk(KERN_NOTICE "lockd: weird return %d for CANCEL call\n",
789 /* Don't ever retry more than 3 times */
790 if (req->a_retries++ >= NLMCLNT_MAX_RETRIES)
792 nlm_rebind_host(req->a_host);
793 rpc_restart_call(task);
794 rpc_delay(task, 30 * HZ);
797 static const struct rpc_call_ops nlmclnt_cancel_ops = {
798 .rpc_call_done = nlmclnt_cancel_callback,
799 .rpc_release = nlmclnt_rpc_release,
803 * Convert an NLM status code to a generic kernel errno
806 nlm_stat_to_errno(__be32 status)
808 switch(ntohl(status)) {
809 case NLM_LCK_GRANTED:
813 case NLM_LCK_DENIED_NOLOCKS:
814 case NLM_LCK_DENIED_GRACE_PERIOD:
816 case NLM_LCK_BLOCKED:
817 printk(KERN_NOTICE "lockd: unexpected status NLM_BLOCKED\n");
819 #ifdef CONFIG_LOCKD_V4
832 printk(KERN_NOTICE "lockd: unexpected server status %d\n", status);