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)
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 void nlmclnt_unlock_callback(struct rpc_task *);
30 static void nlmclnt_cancel_callback(struct rpc_task *);
31 static int nlm_stat_to_errno(u32 stat);
32 static void nlmclnt_locks_init_private(struct file_lock *fl, struct nlm_host *host);
35 * Cookie counter for NLM requests
37 static u32 nlm_cookie = 0x1234;
39 static inline void nlmclnt_next_cookie(struct nlm_cookie *c)
41 memcpy(c->data, &nlm_cookie, 4);
42 memset(c->data+4, 0, 4);
47 static struct nlm_lockowner *nlm_get_lockowner(struct nlm_lockowner *lockowner)
49 atomic_inc(&lockowner->count);
53 static void nlm_put_lockowner(struct nlm_lockowner *lockowner)
55 if (!atomic_dec_and_lock(&lockowner->count, &lockowner->host->h_lock))
57 list_del(&lockowner->list);
58 spin_unlock(&lockowner->host->h_lock);
59 nlm_release_host(lockowner->host);
63 static inline int nlm_pidbusy(struct nlm_host *host, uint32_t pid)
65 struct nlm_lockowner *lockowner;
66 list_for_each_entry(lockowner, &host->h_lockowners, list) {
67 if (lockowner->pid == pid)
73 static inline uint32_t __nlm_alloc_pid(struct nlm_host *host)
77 res = host->h_pidcount++;
78 } while (nlm_pidbusy(host, res) < 0);
82 static struct nlm_lockowner *__nlm_find_lockowner(struct nlm_host *host, fl_owner_t owner)
84 struct nlm_lockowner *lockowner;
85 list_for_each_entry(lockowner, &host->h_lockowners, list) {
86 if (lockowner->owner != owner)
88 return nlm_get_lockowner(lockowner);
93 static struct nlm_lockowner *nlm_find_lockowner(struct nlm_host *host, fl_owner_t owner)
95 struct nlm_lockowner *res, *new = NULL;
97 spin_lock(&host->h_lock);
98 res = __nlm_find_lockowner(host, owner);
100 spin_unlock(&host->h_lock);
101 new = (struct nlm_lockowner *)kmalloc(sizeof(*new), GFP_KERNEL);
102 spin_lock(&host->h_lock);
103 res = __nlm_find_lockowner(host, owner);
104 if (res == NULL && new != NULL) {
106 atomic_set(&new->count, 1);
108 new->pid = __nlm_alloc_pid(host);
109 new->host = nlm_get_host(host);
110 list_add(&new->list, &host->h_lockowners);
114 spin_unlock(&host->h_lock);
121 * Initialize arguments for TEST/LOCK/UNLOCK/CANCEL calls
123 static void nlmclnt_setlockargs(struct nlm_rqst *req, struct file_lock *fl)
125 struct nlm_args *argp = &req->a_args;
126 struct nlm_lock *lock = &argp->lock;
128 nlmclnt_next_cookie(&argp->cookie);
129 argp->state = nsm_local_state;
130 memcpy(&lock->fh, NFS_FH(fl->fl_file->f_dentry->d_inode), sizeof(struct nfs_fh));
131 lock->caller = system_utsname.nodename;
132 lock->oh.data = req->a_owner;
133 lock->oh.len = sprintf(req->a_owner, "%d@%s",
134 current->pid, system_utsname.nodename);
135 locks_copy_lock(&lock->fl, fl);
138 static void nlmclnt_release_lockargs(struct nlm_rqst *req)
140 struct file_lock *fl = &req->a_args.lock.fl;
142 if (fl->fl_ops && fl->fl_ops->fl_release_private)
143 fl->fl_ops->fl_release_private(fl);
147 * Initialize arguments for GRANTED call. The nlm_rqst structure
148 * has been cleared already.
151 nlmclnt_setgrantargs(struct nlm_rqst *call, struct nlm_lock *lock)
153 locks_copy_lock(&call->a_args.lock.fl, &lock->fl);
154 memcpy(&call->a_args.lock.fh, &lock->fh, sizeof(call->a_args.lock.fh));
155 call->a_args.lock.caller = system_utsname.nodename;
156 call->a_args.lock.oh.len = lock->oh.len;
158 /* set default data area */
159 call->a_args.lock.oh.data = call->a_owner;
161 if (lock->oh.len > NLMCLNT_OHSIZE) {
162 void *data = kmalloc(lock->oh.len, GFP_KERNEL);
164 nlmclnt_freegrantargs(call);
167 call->a_args.lock.oh.data = (u8 *) data;
170 memcpy(call->a_args.lock.oh.data, lock->oh.data, lock->oh.len);
175 nlmclnt_freegrantargs(struct nlm_rqst *call)
177 struct file_lock *fl = &call->a_args.lock.fl;
179 * Check whether we allocated memory for the owner.
181 if (call->a_args.lock.oh.data != (u8 *) call->a_owner) {
182 kfree(call->a_args.lock.oh.data);
184 if (fl->fl_ops && fl->fl_ops->fl_release_private)
185 fl->fl_ops->fl_release_private(fl);
189 * This is the main entry point for the NLM client.
192 nlmclnt_proc(struct inode *inode, int cmd, struct file_lock *fl)
194 struct nfs_server *nfssrv = NFS_SERVER(inode);
195 struct nlm_host *host;
196 struct nlm_rqst reqst, *call = &reqst;
199 int status, proto, vers;
201 vers = (NFS_PROTO(inode)->version == 3) ? 4 : 1;
202 if (NFS_PROTO(inode)->version > 3) {
203 printk(KERN_NOTICE "NFSv4 file locking not implemented!\n");
207 /* Retrieve transport protocol from NFS client */
208 proto = NFS_CLIENT(inode)->cl_xprt->prot;
210 if (!(host = nlmclnt_lookup_host(NFS_ADDR(inode), proto, vers)))
213 /* Create RPC client handle if not there, and copy soft
214 * and intr flags from NFS client. */
215 if (host->h_rpcclnt == NULL) {
216 struct rpc_clnt *clnt;
218 /* Bind an rpc client to this host handle (does not
219 * perform a portmapper lookup) */
220 if (!(clnt = nlm_bind_host(host))) {
224 clnt->cl_softrtry = nfssrv->client->cl_softrtry;
225 clnt->cl_intr = nfssrv->client->cl_intr;
226 clnt->cl_chatty = nfssrv->client->cl_chatty;
229 /* Keep the old signal mask */
230 spin_lock_irqsave(¤t->sighand->siglock, flags);
231 oldset = current->blocked;
233 /* If we're cleaning up locks because the process is exiting,
234 * perform the RPC call asynchronously. */
235 if ((IS_SETLK(cmd) || IS_SETLKW(cmd))
236 && fl->fl_type == F_UNLCK
237 && (current->flags & PF_EXITING)) {
238 sigfillset(¤t->blocked); /* Mask all signals */
240 spin_unlock_irqrestore(¤t->sighand->siglock, flags);
242 call = nlmclnt_alloc_call();
247 call->a_flags = RPC_TASK_ASYNC;
249 spin_unlock_irqrestore(¤t->sighand->siglock, flags);
250 memset(call, 0, sizeof(*call));
251 locks_init_lock(&call->a_args.lock.fl);
252 locks_init_lock(&call->a_res.lock.fl);
256 nlmclnt_locks_init_private(fl, host);
258 /* Set up the argument struct */
259 nlmclnt_setlockargs(call, fl);
261 if (IS_SETLK(cmd) || IS_SETLKW(cmd)) {
262 if (fl->fl_type != F_UNLCK) {
263 call->a_args.block = IS_SETLKW(cmd) ? 1 : 0;
264 status = nlmclnt_lock(call, fl);
266 status = nlmclnt_unlock(call, fl);
267 } else if (IS_GETLK(cmd))
268 status = nlmclnt_test(call, fl);
273 spin_lock_irqsave(¤t->sighand->siglock, flags);
274 current->blocked = oldset;
276 spin_unlock_irqrestore(¤t->sighand->siglock, flags);
279 dprintk("lockd: clnt proc returns %d\n", status);
280 nlm_release_host(host);
283 EXPORT_SYMBOL(nlmclnt_proc);
286 * Allocate an NLM RPC call struct
289 nlmclnt_alloc_call(void)
291 struct nlm_rqst *call;
293 while (!signalled()) {
294 call = (struct nlm_rqst *) kmalloc(sizeof(struct nlm_rqst), GFP_KERNEL);
296 memset(call, 0, sizeof(*call));
297 locks_init_lock(&call->a_args.lock.fl);
298 locks_init_lock(&call->a_res.lock.fl);
301 printk("nlmclnt_alloc_call: failed, waiting for memory\n");
302 current->state = TASK_INTERRUPTIBLE;
303 schedule_timeout(5*HZ);
308 static int nlm_wait_on_grace(wait_queue_head_t *queue)
313 prepare_to_wait(queue, &wait, TASK_INTERRUPTIBLE);
315 schedule_timeout(NLMCLNT_GRACE_WAIT);
320 finish_wait(queue, &wait);
328 nlmclnt_call(struct nlm_rqst *req, u32 proc)
330 struct nlm_host *host = req->a_host;
331 struct rpc_clnt *clnt;
332 struct nlm_args *argp = &req->a_args;
333 struct nlm_res *resp = &req->a_res;
334 struct rpc_message msg = {
340 dprintk("lockd: call procedure %d on %s\n",
341 (int)proc, host->h_name);
344 if (host->h_reclaiming && !argp->reclaim)
345 goto in_grace_period;
347 /* If we have no RPC client yet, create one. */
348 if ((clnt = nlm_bind_host(host)) == NULL)
350 msg.rpc_proc = &clnt->cl_procinfo[proc];
352 /* Perform the RPC call. If an error occurs, try again */
353 if ((status = rpc_call_sync(clnt, &msg, 0)) < 0) {
354 dprintk("lockd: rpc_call returned error %d\n", -status);
356 case -EPROTONOSUPPORT:
362 nlm_rebind_host(host);
366 return signalled () ? -EINTR : status;
372 if (resp->status == NLM_LCK_DENIED_GRACE_PERIOD) {
373 dprintk("lockd: server in grace period\n");
376 "lockd: spurious grace period reject?!\n");
380 if (!argp->reclaim) {
381 /* We appear to be out of the grace period */
382 wake_up_all(&host->h_gracewait);
384 dprintk("lockd: server returns status %d\n", resp->status);
385 return 0; /* Okay, call complete */
390 * The server has rebooted and appears to be in the grace
391 * period during which locks are only allowed to be
393 * We can only back off and try again later.
395 status = nlm_wait_on_grace(&host->h_gracewait);
396 } while (status == 0);
402 * Generic NLM call, async version.
405 nlmsvc_async_call(struct nlm_rqst *req, u32 proc, rpc_action callback)
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, callback, req);
430 nlmclnt_async_call(struct nlm_rqst *req, u32 proc, rpc_action callback)
432 struct nlm_host *host = req->a_host;
433 struct rpc_clnt *clnt;
434 struct nlm_args *argp = &req->a_args;
435 struct nlm_res *resp = &req->a_res;
436 struct rpc_message msg = {
442 dprintk("lockd: call procedure %d on %s (async)\n",
443 (int)proc, host->h_name);
445 /* If we have no RPC client yet, create one. */
446 if ((clnt = nlm_bind_host(host)) == NULL)
448 msg.rpc_proc = &clnt->cl_procinfo[proc];
450 /* Increment host refcount */
452 /* bootstrap and kick off the async RPC call */
453 status = rpc_call_async(clnt, &msg, RPC_TASK_ASYNC, callback, req);
455 nlm_release_host(host);
460 * TEST for the presence of a conflicting lock
463 nlmclnt_test(struct nlm_rqst *req, struct file_lock *fl)
467 status = nlmclnt_call(req, NLMPROC_TEST);
468 nlmclnt_release_lockargs(req);
472 status = req->a_res.status;
473 if (status == NLM_LCK_GRANTED) {
474 fl->fl_type = F_UNLCK;
475 } if (status == NLM_LCK_DENIED) {
477 * Report the conflicting lock back to the application.
479 locks_copy_lock(fl, &req->a_res.lock.fl);
482 return nlm_stat_to_errno(req->a_res.status);
488 static void nlmclnt_locks_copy_lock(struct file_lock *new, struct file_lock *fl)
490 memcpy(&new->fl_u.nfs_fl, &fl->fl_u.nfs_fl, sizeof(new->fl_u.nfs_fl));
491 nlm_get_lockowner(new->fl_u.nfs_fl.owner);
494 static void nlmclnt_locks_release_private(struct file_lock *fl)
496 nlm_put_lockowner(fl->fl_u.nfs_fl.owner);
500 static struct file_lock_operations nlmclnt_lock_ops = {
501 .fl_copy_lock = nlmclnt_locks_copy_lock,
502 .fl_release_private = nlmclnt_locks_release_private,
505 static void nlmclnt_locks_init_private(struct file_lock *fl, struct nlm_host *host)
507 BUG_ON(fl->fl_ops != NULL);
508 fl->fl_u.nfs_fl.state = 0;
509 fl->fl_u.nfs_fl.flags = 0;
510 fl->fl_u.nfs_fl.owner = nlm_find_lockowner(host, fl->fl_owner);
511 fl->fl_ops = &nlmclnt_lock_ops;
514 static void do_vfs_lock(struct file_lock *fl)
517 switch (fl->fl_flags & (FL_POSIX|FL_FLOCK)) {
519 res = posix_lock_file_wait(fl->fl_file, fl);
522 res = flock_lock_file_wait(fl->fl_file, fl);
528 printk(KERN_WARNING "%s: VFS is out of sync with lock manager!\n",
533 * LOCK: Try to create a lock
535 * Programmer Harassment Alert
537 * When given a blocking lock request in a sync RPC call, the HPUX lockd
538 * will faithfully return LCK_BLOCKED but never cares to notify us when
539 * the lock could be granted. This way, our local process could hang
540 * around forever waiting for the callback.
542 * Solution A: Implement busy-waiting
543 * Solution B: Use the async version of the call (NLM_LOCK_{MSG,RES})
545 * For now I am implementing solution A, because I hate the idea of
546 * re-implementing lockd for a third time in two months. The async
547 * calls shouldn't be too hard to do, however.
549 * This is one of the lovely things about standards in the NFS area:
550 * they're so soft and squishy you can't really blame HP for doing this.
553 nlmclnt_lock(struct nlm_rqst *req, struct file_lock *fl)
555 struct nlm_host *host = req->a_host;
556 struct nlm_res *resp = &req->a_res;
560 if (!host->h_monitored && nsm_monitor(host) < 0) {
561 printk(KERN_NOTICE "lockd: failed to monitor %s\n",
567 if (req->a_args.block) {
568 status = nlmclnt_prepare_block(req, host, fl);
573 status = nlmclnt_call(req, NLMPROC_LOCK);
576 if (resp->status != NLM_LCK_BLOCKED)
578 /* Wait on an NLM blocking lock */
579 timeout = nlmclnt_block(req, NLMCLNT_POLL_TIMEOUT);
580 /* Did a reclaimer thread notify us of a server reboot? */
581 if (resp->status == NLM_LCK_DENIED_GRACE_PERIOD)
583 if (resp->status != NLM_LCK_BLOCKED)
587 /* We were interrupted. Send a CANCEL request to the server
590 status = (int)timeout;
594 if (resp->status == NLM_LCK_GRANTED) {
595 fl->fl_u.nfs_fl.state = host->h_state;
596 fl->fl_u.nfs_fl.flags |= NFS_LCK_GRANTED;
597 fl->fl_flags |= FL_SLEEP;
600 status = nlm_stat_to_errno(resp->status);
602 nlmclnt_finish_block(req);
603 /* Cancel the blocked request if it is still pending */
604 if (resp->status == NLM_LCK_BLOCKED)
605 nlmclnt_cancel(host, fl);
607 nlmclnt_release_lockargs(req);
612 * RECLAIM: Try to reclaim a lock
615 nlmclnt_reclaim(struct nlm_host *host, struct file_lock *fl)
617 struct nlm_rqst reqst, *req;
621 memset(req, 0, sizeof(*req));
622 locks_init_lock(&req->a_args.lock.fl);
623 locks_init_lock(&req->a_res.lock.fl);
627 /* Set up the argument struct */
628 nlmclnt_setlockargs(req, fl);
629 req->a_args.reclaim = 1;
631 if ((status = nlmclnt_call(req, NLMPROC_LOCK)) >= 0
632 && req->a_res.status == NLM_LCK_GRANTED)
635 printk(KERN_WARNING "lockd: failed to reclaim lock for pid %d "
636 "(errno %d, status %d)\n", fl->fl_pid,
637 status, req->a_res.status);
640 * FIXME: This is a serious failure. We can
642 * a. Ignore the problem
643 * b. Send the owning process some signal (Linux doesn't have
644 * SIGLOST, though...)
645 * c. Retry the operation
647 * Until someone comes up with a simple implementation
648 * for b or c, I'll choose option a.
655 * UNLOCK: remove an existing lock
658 nlmclnt_unlock(struct nlm_rqst *req, struct file_lock *fl)
660 struct nlm_res *resp = &req->a_res;
663 /* Clean the GRANTED flag now so the lock doesn't get
664 * reclaimed while we're stuck in the unlock call. */
665 fl->fl_u.nfs_fl.flags &= ~NFS_LCK_GRANTED;
667 if (req->a_flags & RPC_TASK_ASYNC) {
668 status = nlmclnt_async_call(req, NLMPROC_UNLOCK,
669 nlmclnt_unlock_callback);
670 /* Hrmf... Do the unlock early since locks_remove_posix()
671 * really expects us to free the lock synchronously */
674 nlmclnt_release_lockargs(req);
680 status = nlmclnt_call(req, NLMPROC_UNLOCK);
681 nlmclnt_release_lockargs(req);
686 if (resp->status == NLM_LCK_GRANTED)
689 if (resp->status != NLM_LCK_DENIED_NOLOCKS)
690 printk("lockd: unexpected unlock status: %d\n", resp->status);
692 /* What to do now? I'm out of my depth... */
698 nlmclnt_unlock_callback(struct rpc_task *task)
700 struct nlm_rqst *req = (struct nlm_rqst *) task->tk_calldata;
701 int status = req->a_res.status;
703 if (RPC_ASSASSINATED(task))
706 if (task->tk_status < 0) {
707 dprintk("lockd: unlock failed (err = %d)\n", -task->tk_status);
710 if (status == NLM_LCK_DENIED_GRACE_PERIOD) {
711 rpc_delay(task, NLMCLNT_GRACE_WAIT);
714 if (status != NLM_LCK_GRANTED)
715 printk(KERN_WARNING "lockd: unexpected unlock status: %d\n", status);
717 nlm_release_host(req->a_host);
718 nlmclnt_release_lockargs(req);
722 nlm_rebind_host(req->a_host);
724 rpc_restart_call(task);
728 * Cancel a blocked lock request.
729 * We always use an async RPC call for this in order not to hang a
730 * process that has been Ctrl-C'ed.
733 nlmclnt_cancel(struct nlm_host *host, struct file_lock *fl)
735 struct nlm_rqst *req;
740 /* Block all signals while setting up call */
741 spin_lock_irqsave(¤t->sighand->siglock, flags);
742 oldset = current->blocked;
743 sigfillset(¤t->blocked);
745 spin_unlock_irqrestore(¤t->sighand->siglock, flags);
747 req = nlmclnt_alloc_call();
751 req->a_flags = RPC_TASK_ASYNC;
753 nlmclnt_setlockargs(req, fl);
755 status = nlmclnt_async_call(req, NLMPROC_CANCEL,
756 nlmclnt_cancel_callback);
758 nlmclnt_release_lockargs(req);
762 spin_lock_irqsave(¤t->sighand->siglock, flags);
763 current->blocked = oldset;
765 spin_unlock_irqrestore(¤t->sighand->siglock, flags);
771 nlmclnt_cancel_callback(struct rpc_task *task)
773 struct nlm_rqst *req = (struct nlm_rqst *) task->tk_calldata;
775 if (RPC_ASSASSINATED(task))
778 if (task->tk_status < 0) {
779 dprintk("lockd: CANCEL call error %d, retrying.\n",
784 dprintk("lockd: cancel status %d (task %d)\n",
785 req->a_res.status, task->tk_pid);
787 switch (req->a_res.status) {
788 case NLM_LCK_GRANTED:
789 case NLM_LCK_DENIED_GRACE_PERIOD:
790 /* Everything's good */
792 case NLM_LCK_DENIED_NOLOCKS:
793 dprintk("lockd: CANCEL failed (server has no locks)\n");
796 printk(KERN_NOTICE "lockd: weird return %d for CANCEL call\n",
801 nlm_release_host(req->a_host);
802 nlmclnt_release_lockargs(req);
807 nlm_rebind_host(req->a_host);
808 rpc_restart_call(task);
809 rpc_delay(task, 30 * HZ);
813 * Convert an NLM status code to a generic kernel errno
816 nlm_stat_to_errno(u32 status)
819 case NLM_LCK_GRANTED:
823 case NLM_LCK_DENIED_NOLOCKS:
824 case NLM_LCK_DENIED_GRACE_PERIOD:
826 case NLM_LCK_BLOCKED:
827 printk(KERN_NOTICE "lockd: unexpected status NLM_BLOCKED\n");
829 #ifdef CONFIG_LOCKD_V4
842 printk(KERN_NOTICE "lockd: unexpected server status %d\n", status);