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/config.h>
10 #include <linux/module.h>
11 #include <linux/types.h>
12 #include <linux/errno.h>
14 #include <linux/nfs_fs.h>
15 #include <linux/utsname.h>
16 #include <linux/smp_lock.h>
17 #include <linux/sunrpc/clnt.h>
18 #include <linux/sunrpc/svc.h>
19 #include <linux/lockd/lockd.h>
20 #include <linux/lockd/sm_inter.h>
22 #define NLMDBG_FACILITY NLMDBG_CLIENT
23 #define NLMCLNT_GRACE_WAIT (5*HZ)
24 #define NLMCLNT_POLL_TIMEOUT (30*HZ)
25 #define NLMCLNT_MAX_RETRIES 3
27 static int nlmclnt_test(struct nlm_rqst *, struct file_lock *);
28 static int nlmclnt_lock(struct nlm_rqst *, struct file_lock *);
29 static int nlmclnt_unlock(struct nlm_rqst *, struct file_lock *);
30 static int nlm_stat_to_errno(u32 stat);
31 static void nlmclnt_locks_init_private(struct file_lock *fl, struct nlm_host *host);
32 static int nlmclnt_cancel(struct nlm_host *, int , struct file_lock *);
34 static const struct rpc_call_ops nlmclnt_unlock_ops;
35 static const struct rpc_call_ops nlmclnt_cancel_ops;
38 * Cookie counter for NLM requests
40 static u32 nlm_cookie = 0x1234;
42 static inline void nlmclnt_next_cookie(struct nlm_cookie *c)
44 memcpy(c->data, &nlm_cookie, 4);
45 memset(c->data+4, 0, 4);
50 static struct nlm_lockowner *nlm_get_lockowner(struct nlm_lockowner *lockowner)
52 atomic_inc(&lockowner->count);
56 static void nlm_put_lockowner(struct nlm_lockowner *lockowner)
58 if (!atomic_dec_and_lock(&lockowner->count, &lockowner->host->h_lock))
60 list_del(&lockowner->list);
61 spin_unlock(&lockowner->host->h_lock);
62 nlm_release_host(lockowner->host);
66 static inline int nlm_pidbusy(struct nlm_host *host, uint32_t pid)
68 struct nlm_lockowner *lockowner;
69 list_for_each_entry(lockowner, &host->h_lockowners, list) {
70 if (lockowner->pid == pid)
76 static inline uint32_t __nlm_alloc_pid(struct nlm_host *host)
80 res = host->h_pidcount++;
81 } while (nlm_pidbusy(host, res) < 0);
85 static struct nlm_lockowner *__nlm_find_lockowner(struct nlm_host *host, fl_owner_t owner)
87 struct nlm_lockowner *lockowner;
88 list_for_each_entry(lockowner, &host->h_lockowners, list) {
89 if (lockowner->owner != owner)
91 return nlm_get_lockowner(lockowner);
96 static struct nlm_lockowner *nlm_find_lockowner(struct nlm_host *host, fl_owner_t owner)
98 struct nlm_lockowner *res, *new = NULL;
100 spin_lock(&host->h_lock);
101 res = __nlm_find_lockowner(host, owner);
103 spin_unlock(&host->h_lock);
104 new = (struct nlm_lockowner *)kmalloc(sizeof(*new), GFP_KERNEL);
105 spin_lock(&host->h_lock);
106 res = __nlm_find_lockowner(host, owner);
107 if (res == NULL && new != NULL) {
109 atomic_set(&new->count, 1);
111 new->pid = __nlm_alloc_pid(host);
112 new->host = nlm_get_host(host);
113 list_add(&new->list, &host->h_lockowners);
117 spin_unlock(&host->h_lock);
123 * Initialize arguments for TEST/LOCK/UNLOCK/CANCEL calls
125 static void nlmclnt_setlockargs(struct nlm_rqst *req, struct file_lock *fl)
127 struct nlm_args *argp = &req->a_args;
128 struct nlm_lock *lock = &argp->lock;
130 nlmclnt_next_cookie(&argp->cookie);
131 argp->state = nsm_local_state;
132 memcpy(&lock->fh, NFS_FH(fl->fl_file->f_dentry->d_inode), sizeof(struct nfs_fh));
133 lock->caller = system_utsname.nodename;
134 lock->oh.data = req->a_owner;
135 lock->oh.len = sprintf(req->a_owner, "%d@%s",
136 current->pid, system_utsname.nodename);
137 locks_copy_lock(&lock->fl, fl);
140 static void nlmclnt_release_lockargs(struct nlm_rqst *req)
142 struct file_lock *fl = &req->a_args.lock.fl;
144 if (fl->fl_ops && fl->fl_ops->fl_release_private)
145 fl->fl_ops->fl_release_private(fl);
149 * Initialize arguments for GRANTED call. The nlm_rqst structure
150 * has been cleared already.
153 nlmclnt_setgrantargs(struct nlm_rqst *call, struct nlm_lock *lock)
155 locks_copy_lock(&call->a_args.lock.fl, &lock->fl);
156 memcpy(&call->a_args.lock.fh, &lock->fh, sizeof(call->a_args.lock.fh));
157 call->a_args.lock.caller = system_utsname.nodename;
158 call->a_args.lock.oh.len = lock->oh.len;
160 /* set default data area */
161 call->a_args.lock.oh.data = call->a_owner;
163 if (lock->oh.len > NLMCLNT_OHSIZE) {
164 void *data = kmalloc(lock->oh.len, GFP_KERNEL);
166 nlmclnt_freegrantargs(call);
169 call->a_args.lock.oh.data = (u8 *) data;
172 memcpy(call->a_args.lock.oh.data, lock->oh.data, lock->oh.len);
177 nlmclnt_freegrantargs(struct nlm_rqst *call)
179 struct file_lock *fl = &call->a_args.lock.fl;
181 * Check whether we allocated memory for the owner.
183 if (call->a_args.lock.oh.data != (u8 *) call->a_owner) {
184 kfree(call->a_args.lock.oh.data);
186 if (fl->fl_ops && fl->fl_ops->fl_release_private)
187 fl->fl_ops->fl_release_private(fl);
191 * This is the main entry point for the NLM client.
194 nlmclnt_proc(struct inode *inode, int cmd, struct file_lock *fl)
196 struct nfs_server *nfssrv = NFS_SERVER(inode);
197 struct nlm_host *host;
198 struct nlm_rqst reqst, *call = &reqst;
201 int status, proto, vers;
203 vers = (NFS_PROTO(inode)->version == 3) ? 4 : 1;
204 if (NFS_PROTO(inode)->version > 3) {
205 printk(KERN_NOTICE "NFSv4 file locking not implemented!\n");
209 /* Retrieve transport protocol from NFS client */
210 proto = NFS_CLIENT(inode)->cl_xprt->prot;
212 if (!(host = nlmclnt_lookup_host(NFS_ADDR(inode), proto, vers)))
215 /* Create RPC client handle if not there, and copy soft
216 * and intr flags from NFS client. */
217 if (host->h_rpcclnt == NULL) {
218 struct rpc_clnt *clnt;
220 /* Bind an rpc client to this host handle (does not
221 * perform a portmapper lookup) */
222 if (!(clnt = nlm_bind_host(host))) {
226 clnt->cl_softrtry = nfssrv->client->cl_softrtry;
227 clnt->cl_intr = nfssrv->client->cl_intr;
230 /* Keep the old signal mask */
231 spin_lock_irqsave(¤t->sighand->siglock, flags);
232 oldset = current->blocked;
234 /* If we're cleaning up locks because the process is exiting,
235 * perform the RPC call asynchronously. */
236 if ((IS_SETLK(cmd) || IS_SETLKW(cmd))
237 && fl->fl_type == F_UNLCK
238 && (current->flags & PF_EXITING)) {
239 sigfillset(¤t->blocked); /* Mask all signals */
241 spin_unlock_irqrestore(¤t->sighand->siglock, flags);
243 call = nlmclnt_alloc_call();
248 call->a_flags = RPC_TASK_ASYNC;
250 spin_unlock_irqrestore(¤t->sighand->siglock, flags);
251 memset(call, 0, sizeof(*call));
252 locks_init_lock(&call->a_args.lock.fl);
253 locks_init_lock(&call->a_res.lock.fl);
257 nlmclnt_locks_init_private(fl, host);
259 /* Set up the argument struct */
260 nlmclnt_setlockargs(call, fl);
262 if (IS_SETLK(cmd) || IS_SETLKW(cmd)) {
263 if (fl->fl_type != F_UNLCK) {
264 call->a_args.block = IS_SETLKW(cmd) ? 1 : 0;
265 status = nlmclnt_lock(call, fl);
267 status = nlmclnt_unlock(call, fl);
268 } else if (IS_GETLK(cmd))
269 status = nlmclnt_test(call, fl);
274 spin_lock_irqsave(¤t->sighand->siglock, flags);
275 current->blocked = oldset;
277 spin_unlock_irqrestore(¤t->sighand->siglock, flags);
280 dprintk("lockd: clnt proc returns %d\n", status);
281 nlm_release_host(host);
284 EXPORT_SYMBOL(nlmclnt_proc);
287 * Allocate an NLM RPC call struct
290 nlmclnt_alloc_call(void)
292 struct nlm_rqst *call;
295 call = kzalloc(sizeof(*call), GFP_KERNEL);
297 locks_init_lock(&call->a_args.lock.fl);
298 locks_init_lock(&call->a_res.lock.fl);
303 printk("nlmclnt_alloc_call: failed, waiting for memory\n");
304 schedule_timeout_interruptible(5*HZ);
309 static int nlm_wait_on_grace(wait_queue_head_t *queue)
314 prepare_to_wait(queue, &wait, TASK_INTERRUPTIBLE);
316 schedule_timeout(NLMCLNT_GRACE_WAIT);
321 finish_wait(queue, &wait);
329 nlmclnt_call(struct nlm_rqst *req, u32 proc)
331 struct nlm_host *host = req->a_host;
332 struct rpc_clnt *clnt;
333 struct nlm_args *argp = &req->a_args;
334 struct nlm_res *resp = &req->a_res;
335 struct rpc_message msg = {
341 dprintk("lockd: call procedure %d on %s\n",
342 (int)proc, host->h_name);
345 if (host->h_reclaiming && !argp->reclaim)
346 goto in_grace_period;
348 /* If we have no RPC client yet, create one. */
349 if ((clnt = nlm_bind_host(host)) == NULL)
351 msg.rpc_proc = &clnt->cl_procinfo[proc];
353 /* Perform the RPC call. If an error occurs, try again */
354 if ((status = rpc_call_sync(clnt, &msg, 0)) < 0) {
355 dprintk("lockd: rpc_call returned error %d\n", -status);
357 case -EPROTONOSUPPORT:
363 nlm_rebind_host(host);
367 return signalled () ? -EINTR : status;
373 if (resp->status == NLM_LCK_DENIED_GRACE_PERIOD) {
374 dprintk("lockd: server in grace period\n");
377 "lockd: spurious grace period reject?!\n");
381 if (!argp->reclaim) {
382 /* We appear to be out of the grace period */
383 wake_up_all(&host->h_gracewait);
385 dprintk("lockd: server returns status %d\n", resp->status);
386 return 0; /* Okay, call complete */
391 * The server has rebooted and appears to be in the grace
392 * period during which locks are only allowed to be
394 * We can only back off and try again later.
396 status = nlm_wait_on_grace(&host->h_gracewait);
397 } while (status == 0);
403 * Generic NLM call, async version.
405 int nlmsvc_async_call(struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops)
407 struct nlm_host *host = req->a_host;
408 struct rpc_clnt *clnt;
409 struct rpc_message msg = {
410 .rpc_argp = &req->a_args,
411 .rpc_resp = &req->a_res,
415 dprintk("lockd: call procedure %d on %s (async)\n",
416 (int)proc, host->h_name);
418 /* If we have no RPC client yet, create one. */
419 if ((clnt = nlm_bind_host(host)) == NULL)
421 msg.rpc_proc = &clnt->cl_procinfo[proc];
423 /* bootstrap and kick off the async RPC call */
424 status = rpc_call_async(clnt, &msg, RPC_TASK_ASYNC, tk_ops, req);
429 static int nlmclnt_async_call(struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops)
431 struct nlm_host *host = req->a_host;
432 struct rpc_clnt *clnt;
433 struct nlm_args *argp = &req->a_args;
434 struct nlm_res *resp = &req->a_res;
435 struct rpc_message msg = {
441 dprintk("lockd: call procedure %d on %s (async)\n",
442 (int)proc, host->h_name);
444 /* If we have no RPC client yet, create one. */
445 if ((clnt = nlm_bind_host(host)) == NULL)
447 msg.rpc_proc = &clnt->cl_procinfo[proc];
449 /* Increment host refcount */
451 /* bootstrap and kick off the async RPC call */
452 status = rpc_call_async(clnt, &msg, RPC_TASK_ASYNC, tk_ops, req);
454 nlm_release_host(host);
459 * TEST for the presence of a conflicting lock
462 nlmclnt_test(struct nlm_rqst *req, struct file_lock *fl)
466 status = nlmclnt_call(req, NLMPROC_TEST);
467 nlmclnt_release_lockargs(req);
471 status = req->a_res.status;
472 if (status == NLM_LCK_GRANTED) {
473 fl->fl_type = F_UNLCK;
474 } if (status == NLM_LCK_DENIED) {
476 * Report the conflicting lock back to the application.
478 locks_copy_lock(fl, &req->a_res.lock.fl);
481 return nlm_stat_to_errno(req->a_res.status);
487 static void nlmclnt_locks_copy_lock(struct file_lock *new, struct file_lock *fl)
489 memcpy(&new->fl_u.nfs_fl, &fl->fl_u.nfs_fl, sizeof(new->fl_u.nfs_fl));
490 nlm_get_lockowner(new->fl_u.nfs_fl.owner);
493 static void nlmclnt_locks_release_private(struct file_lock *fl)
495 nlm_put_lockowner(fl->fl_u.nfs_fl.owner);
499 static struct file_lock_operations nlmclnt_lock_ops = {
500 .fl_copy_lock = nlmclnt_locks_copy_lock,
501 .fl_release_private = nlmclnt_locks_release_private,
504 static void nlmclnt_locks_init_private(struct file_lock *fl, struct nlm_host *host)
506 BUG_ON(fl->fl_ops != NULL);
507 fl->fl_u.nfs_fl.state = 0;
508 fl->fl_u.nfs_fl.flags = 0;
509 fl->fl_u.nfs_fl.owner = nlm_find_lockowner(host, fl->fl_owner);
510 fl->fl_ops = &nlmclnt_lock_ops;
513 static void do_vfs_lock(struct file_lock *fl)
516 switch (fl->fl_flags & (FL_POSIX|FL_FLOCK)) {
518 res = posix_lock_file_wait(fl->fl_file, fl);
521 res = flock_lock_file_wait(fl->fl_file, fl);
527 printk(KERN_WARNING "%s: VFS is out of sync with lock manager!\n",
532 * LOCK: Try to create a lock
534 * Programmer Harassment Alert
536 * When given a blocking lock request in a sync RPC call, the HPUX lockd
537 * will faithfully return LCK_BLOCKED but never cares to notify us when
538 * the lock could be granted. This way, our local process could hang
539 * around forever waiting for the callback.
541 * Solution A: Implement busy-waiting
542 * Solution B: Use the async version of the call (NLM_LOCK_{MSG,RES})
544 * For now I am implementing solution A, because I hate the idea of
545 * re-implementing lockd for a third time in two months. The async
546 * calls shouldn't be too hard to do, however.
548 * This is one of the lovely things about standards in the NFS area:
549 * they're so soft and squishy you can't really blame HP for doing this.
552 nlmclnt_lock(struct nlm_rqst *req, struct file_lock *fl)
554 struct nlm_host *host = req->a_host;
555 struct nlm_res *resp = &req->a_res;
559 if (!host->h_monitored && nsm_monitor(host) < 0) {
560 printk(KERN_NOTICE "lockd: failed to monitor %s\n",
566 if (req->a_args.block) {
567 status = nlmclnt_prepare_block(req, host, fl);
572 status = nlmclnt_call(req, NLMPROC_LOCK);
575 if (resp->status != NLM_LCK_BLOCKED)
577 /* Wait on an NLM blocking lock */
578 timeout = nlmclnt_block(req, NLMCLNT_POLL_TIMEOUT);
579 /* Did a reclaimer thread notify us of a server reboot? */
580 if (resp->status == NLM_LCK_DENIED_GRACE_PERIOD)
582 if (resp->status != NLM_LCK_BLOCKED)
586 /* We were interrupted. Send a CANCEL request to the server
589 status = (int)timeout;
593 if (resp->status == NLM_LCK_GRANTED) {
594 fl->fl_u.nfs_fl.state = host->h_state;
595 fl->fl_u.nfs_fl.flags |= NFS_LCK_GRANTED;
596 fl->fl_flags |= FL_SLEEP;
599 status = nlm_stat_to_errno(resp->status);
601 nlmclnt_finish_block(req);
602 /* Cancel the blocked request if it is still pending */
603 if (resp->status == NLM_LCK_BLOCKED)
604 nlmclnt_cancel(host, req->a_args.block, fl);
606 nlmclnt_release_lockargs(req);
611 * RECLAIM: Try to reclaim a lock
614 nlmclnt_reclaim(struct nlm_host *host, struct file_lock *fl)
616 struct nlm_rqst reqst, *req;
620 memset(req, 0, sizeof(*req));
621 locks_init_lock(&req->a_args.lock.fl);
622 locks_init_lock(&req->a_res.lock.fl);
626 /* Set up the argument struct */
627 nlmclnt_setlockargs(req, fl);
628 req->a_args.reclaim = 1;
630 if ((status = nlmclnt_call(req, NLMPROC_LOCK)) >= 0
631 && req->a_res.status == NLM_LCK_GRANTED)
634 printk(KERN_WARNING "lockd: failed to reclaim lock for pid %d "
635 "(errno %d, status %d)\n", fl->fl_pid,
636 status, req->a_res.status);
639 * FIXME: This is a serious failure. We can
641 * a. Ignore the problem
642 * b. Send the owning process some signal (Linux doesn't have
643 * SIGLOST, though...)
644 * c. Retry the operation
646 * Until someone comes up with a simple implementation
647 * for b or c, I'll choose option a.
654 * UNLOCK: remove an existing lock
657 nlmclnt_unlock(struct nlm_rqst *req, struct file_lock *fl)
659 struct nlm_res *resp = &req->a_res;
662 /* Clean the GRANTED flag now so the lock doesn't get
663 * reclaimed while we're stuck in the unlock call. */
664 fl->fl_u.nfs_fl.flags &= ~NFS_LCK_GRANTED;
667 * Note: the server is supposed to either grant us the unlock
668 * request, or to deny it with NLM_LCK_DENIED_GRACE_PERIOD. In either
669 * case, we want to unlock.
673 if (req->a_flags & RPC_TASK_ASYNC) {
674 status = nlmclnt_async_call(req, NLMPROC_UNLOCK,
675 &nlmclnt_unlock_ops);
676 /* Hrmf... Do the unlock early since locks_remove_posix()
677 * really expects us to free the lock synchronously */
679 nlmclnt_release_lockargs(req);
685 status = nlmclnt_call(req, NLMPROC_UNLOCK);
686 nlmclnt_release_lockargs(req);
690 if (resp->status == NLM_LCK_GRANTED)
693 if (resp->status != NLM_LCK_DENIED_NOLOCKS)
694 printk("lockd: unexpected unlock status: %d\n", resp->status);
696 /* What to do now? I'm out of my depth... */
701 static void nlmclnt_unlock_callback(struct rpc_task *task, void *data)
703 struct nlm_rqst *req = data;
704 int status = req->a_res.status;
706 if (RPC_ASSASSINATED(task))
709 if (task->tk_status < 0) {
710 dprintk("lockd: unlock failed (err = %d)\n", -task->tk_status);
713 if (status == NLM_LCK_DENIED_GRACE_PERIOD) {
714 rpc_delay(task, NLMCLNT_GRACE_WAIT);
717 if (status != NLM_LCK_GRANTED)
718 printk(KERN_WARNING "lockd: unexpected unlock status: %d\n", status);
720 nlm_release_host(req->a_host);
721 nlmclnt_release_lockargs(req);
725 nlm_rebind_host(req->a_host);
727 rpc_restart_call(task);
730 static const struct rpc_call_ops nlmclnt_unlock_ops = {
731 .rpc_call_done = nlmclnt_unlock_callback,
735 * Cancel a blocked lock request.
736 * We always use an async RPC call for this in order not to hang a
737 * process that has been Ctrl-C'ed.
739 static int nlmclnt_cancel(struct nlm_host *host, int block, struct file_lock *fl)
741 struct nlm_rqst *req;
746 /* Block all signals while setting up call */
747 spin_lock_irqsave(¤t->sighand->siglock, flags);
748 oldset = current->blocked;
749 sigfillset(¤t->blocked);
751 spin_unlock_irqrestore(¤t->sighand->siglock, flags);
753 req = nlmclnt_alloc_call();
757 req->a_flags = RPC_TASK_ASYNC;
759 nlmclnt_setlockargs(req, fl);
760 req->a_args.block = block;
762 status = nlmclnt_async_call(req, NLMPROC_CANCEL, &nlmclnt_cancel_ops);
764 nlmclnt_release_lockargs(req);
768 spin_lock_irqsave(¤t->sighand->siglock, flags);
769 current->blocked = oldset;
771 spin_unlock_irqrestore(¤t->sighand->siglock, flags);
776 static void nlmclnt_cancel_callback(struct rpc_task *task, void *data)
778 struct nlm_rqst *req = data;
780 if (RPC_ASSASSINATED(task))
783 if (task->tk_status < 0) {
784 dprintk("lockd: CANCEL call error %d, retrying.\n",
789 dprintk("lockd: cancel status %d (task %d)\n",
790 req->a_res.status, task->tk_pid);
792 switch (req->a_res.status) {
793 case NLM_LCK_GRANTED:
794 case NLM_LCK_DENIED_GRACE_PERIOD:
795 /* Everything's good */
797 case NLM_LCK_DENIED_NOLOCKS:
798 dprintk("lockd: CANCEL failed (server has no locks)\n");
801 printk(KERN_NOTICE "lockd: weird return %d for CANCEL call\n",
806 nlm_release_host(req->a_host);
807 nlmclnt_release_lockargs(req);
812 /* Don't ever retry more than 3 times */
813 if (req->a_retries++ >= NLMCLNT_MAX_RETRIES)
815 nlm_rebind_host(req->a_host);
816 rpc_restart_call(task);
817 rpc_delay(task, 30 * HZ);
820 static const struct rpc_call_ops nlmclnt_cancel_ops = {
821 .rpc_call_done = nlmclnt_cancel_callback,
825 * Convert an NLM status code to a generic kernel errno
828 nlm_stat_to_errno(u32 status)
831 case NLM_LCK_GRANTED:
835 case NLM_LCK_DENIED_NOLOCKS:
836 case NLM_LCK_DENIED_GRACE_PERIOD:
838 case NLM_LCK_BLOCKED:
839 printk(KERN_NOTICE "lockd: unexpected status NLM_BLOCKED\n");
841 #ifdef CONFIG_LOCKD_V4
854 printk(KERN_NOTICE "lockd: unexpected server status %d\n", status);