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/smp_lock.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(u32 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 u32 nlm_cookie
= 0x1234;
41 static inline void nlmclnt_next_cookie(struct nlm_cookie
*c
)
43 memcpy(c
->data
, &nlm_cookie
, 4);
44 memset(c
->data
+4, 0, 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 = (struct nlm_lockowner
*)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_dentry
->d_inode
), sizeof(struct nfs_fh
));
132 lock
->caller
= system_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 system_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 * This is the main entry point for the NLM client.
152 nlmclnt_proc(struct inode
*inode
, int cmd
, struct file_lock
*fl
)
154 struct nlm_host
*host
;
155 struct nlm_rqst
*call
;
158 int status
, proto
, vers
;
160 vers
= (NFS_PROTO(inode
)->version
== 3) ? 4 : 1;
161 if (NFS_PROTO(inode
)->version
> 3) {
162 printk(KERN_NOTICE
"NFSv4 file locking not implemented!\n");
166 /* Retrieve transport protocol from NFS client */
167 proto
= NFS_CLIENT(inode
)->cl_xprt
->prot
;
169 host
= nlmclnt_lookup_host(NFS_ADDR(inode
), proto
, vers
);
173 call
= nlm_alloc_call(host
);
177 nlmclnt_locks_init_private(fl
, host
);
178 /* Set up the argument struct */
179 nlmclnt_setlockargs(call
, fl
);
181 /* Keep the old signal mask */
182 spin_lock_irqsave(¤t
->sighand
->siglock
, flags
);
183 oldset
= current
->blocked
;
185 /* If we're cleaning up locks because the process is exiting,
186 * perform the RPC call asynchronously. */
187 if ((IS_SETLK(cmd
) || IS_SETLKW(cmd
))
188 && fl
->fl_type
== F_UNLCK
189 && (current
->flags
& PF_EXITING
)) {
190 sigfillset(¤t
->blocked
); /* Mask all signals */
193 call
->a_flags
= RPC_TASK_ASYNC
;
195 spin_unlock_irqrestore(¤t
->sighand
->siglock
, flags
);
197 if (IS_SETLK(cmd
) || IS_SETLKW(cmd
)) {
198 if (fl
->fl_type
!= F_UNLCK
) {
199 call
->a_args
.block
= IS_SETLKW(cmd
) ? 1 : 0;
200 status
= nlmclnt_lock(call
, fl
);
202 status
= nlmclnt_unlock(call
, fl
);
203 } else if (IS_GETLK(cmd
))
204 status
= nlmclnt_test(call
, fl
);
208 fl
->fl_ops
->fl_release_private(fl
);
211 spin_lock_irqsave(¤t
->sighand
->siglock
, flags
);
212 current
->blocked
= oldset
;
214 spin_unlock_irqrestore(¤t
->sighand
->siglock
, flags
);
216 dprintk("lockd: clnt proc returns %d\n", status
);
219 EXPORT_SYMBOL(nlmclnt_proc
);
222 * Allocate an NLM RPC call struct
224 * Note: the caller must hold a reference to host. In case of failure,
225 * this reference will be released.
227 struct nlm_rqst
*nlm_alloc_call(struct nlm_host
*host
)
229 struct nlm_rqst
*call
;
232 call
= kzalloc(sizeof(*call
), GFP_KERNEL
);
234 locks_init_lock(&call
->a_args
.lock
.fl
);
235 locks_init_lock(&call
->a_res
.lock
.fl
);
241 printk("nlm_alloc_call: failed, waiting for memory\n");
242 schedule_timeout_interruptible(5*HZ
);
244 nlm_release_host(host
);
248 void nlm_release_call(struct nlm_rqst
*call
)
250 nlm_release_host(call
->a_host
);
251 nlmclnt_release_lockargs(call
);
255 static void nlmclnt_rpc_release(void *data
)
257 return nlm_release_call(data
);
260 static int nlm_wait_on_grace(wait_queue_head_t
*queue
)
265 prepare_to_wait(queue
, &wait
, TASK_INTERRUPTIBLE
);
267 schedule_timeout(NLMCLNT_GRACE_WAIT
);
272 finish_wait(queue
, &wait
);
280 nlmclnt_call(struct nlm_rqst
*req
, u32 proc
)
282 struct nlm_host
*host
= req
->a_host
;
283 struct rpc_clnt
*clnt
;
284 struct nlm_args
*argp
= &req
->a_args
;
285 struct nlm_res
*resp
= &req
->a_res
;
286 struct rpc_message msg
= {
292 dprintk("lockd: call procedure %d on %s\n",
293 (int)proc
, host
->h_name
);
296 if (host
->h_reclaiming
&& !argp
->reclaim
)
297 goto in_grace_period
;
299 /* If we have no RPC client yet, create one. */
300 if ((clnt
= nlm_bind_host(host
)) == NULL
)
302 msg
.rpc_proc
= &clnt
->cl_procinfo
[proc
];
304 /* Perform the RPC call. If an error occurs, try again */
305 if ((status
= rpc_call_sync(clnt
, &msg
, 0)) < 0) {
306 dprintk("lockd: rpc_call returned error %d\n", -status
);
308 case -EPROTONOSUPPORT
:
314 nlm_rebind_host(host
);
318 return signalled () ? -EINTR
: status
;
324 if (resp
->status
== NLM_LCK_DENIED_GRACE_PERIOD
) {
325 dprintk("lockd: server in grace period\n");
328 "lockd: spurious grace period reject?!\n");
332 if (!argp
->reclaim
) {
333 /* We appear to be out of the grace period */
334 wake_up_all(&host
->h_gracewait
);
336 dprintk("lockd: server returns status %d\n", resp
->status
);
337 return 0; /* Okay, call complete */
342 * The server has rebooted and appears to be in the grace
343 * period during which locks are only allowed to be
345 * We can only back off and try again later.
347 status
= nlm_wait_on_grace(&host
->h_gracewait
);
348 } while (status
== 0);
354 * Generic NLM call, async version.
356 static int __nlm_async_call(struct nlm_rqst
*req
, u32 proc
, struct rpc_message
*msg
, const struct rpc_call_ops
*tk_ops
)
358 struct nlm_host
*host
= req
->a_host
;
359 struct rpc_clnt
*clnt
;
360 int status
= -ENOLCK
;
362 dprintk("lockd: call procedure %d on %s (async)\n",
363 (int)proc
, host
->h_name
);
365 /* If we have no RPC client yet, create one. */
366 clnt
= nlm_bind_host(host
);
369 msg
->rpc_proc
= &clnt
->cl_procinfo
[proc
];
371 /* bootstrap and kick off the async RPC call */
372 status
= rpc_call_async(clnt
, msg
, RPC_TASK_ASYNC
, tk_ops
, req
);
376 nlm_release_call(req
);
380 int nlm_async_call(struct nlm_rqst
*req
, u32 proc
, const struct rpc_call_ops
*tk_ops
)
382 struct rpc_message msg
= {
383 .rpc_argp
= &req
->a_args
,
384 .rpc_resp
= &req
->a_res
,
386 return __nlm_async_call(req
, proc
, &msg
, tk_ops
);
389 int nlm_async_reply(struct nlm_rqst
*req
, u32 proc
, const struct rpc_call_ops
*tk_ops
)
391 struct rpc_message msg
= {
392 .rpc_argp
= &req
->a_res
,
394 return __nlm_async_call(req
, proc
, &msg
, tk_ops
);
398 * TEST for the presence of a conflicting lock
401 nlmclnt_test(struct nlm_rqst
*req
, struct file_lock
*fl
)
405 status
= nlmclnt_call(req
, NLMPROC_TEST
);
409 switch (req
->a_res
.status
) {
410 case NLM_LCK_GRANTED
:
411 fl
->fl_type
= F_UNLCK
;
415 * Report the conflicting lock back to the application.
417 fl
->fl_start
= req
->a_res
.lock
.fl
.fl_start
;
418 fl
->fl_end
= req
->a_res
.lock
.fl
.fl_start
;
419 fl
->fl_type
= req
->a_res
.lock
.fl
.fl_type
;
423 status
= nlm_stat_to_errno(req
->a_res
.status
);
426 nlm_release_call(req
);
430 static void nlmclnt_locks_copy_lock(struct file_lock
*new, struct file_lock
*fl
)
432 new->fl_u
.nfs_fl
.state
= fl
->fl_u
.nfs_fl
.state
;
433 new->fl_u
.nfs_fl
.owner
= nlm_get_lockowner(fl
->fl_u
.nfs_fl
.owner
);
434 list_add_tail(&new->fl_u
.nfs_fl
.list
, &fl
->fl_u
.nfs_fl
.owner
->host
->h_granted
);
437 static void nlmclnt_locks_release_private(struct file_lock
*fl
)
439 list_del(&fl
->fl_u
.nfs_fl
.list
);
440 nlm_put_lockowner(fl
->fl_u
.nfs_fl
.owner
);
443 static struct file_lock_operations nlmclnt_lock_ops
= {
444 .fl_copy_lock
= nlmclnt_locks_copy_lock
,
445 .fl_release_private
= nlmclnt_locks_release_private
,
448 static void nlmclnt_locks_init_private(struct file_lock
*fl
, struct nlm_host
*host
)
450 BUG_ON(fl
->fl_ops
!= NULL
);
451 fl
->fl_u
.nfs_fl
.state
= 0;
452 fl
->fl_u
.nfs_fl
.owner
= nlm_find_lockowner(host
, fl
->fl_owner
);
453 INIT_LIST_HEAD(&fl
->fl_u
.nfs_fl
.list
);
454 fl
->fl_ops
= &nlmclnt_lock_ops
;
457 static int do_vfs_lock(struct file_lock
*fl
)
460 switch (fl
->fl_flags
& (FL_POSIX
|FL_FLOCK
)) {
462 res
= posix_lock_file_wait(fl
->fl_file
, fl
);
465 res
= flock_lock_file_wait(fl
->fl_file
, fl
);
474 * LOCK: Try to create a lock
476 * Programmer Harassment Alert
478 * When given a blocking lock request in a sync RPC call, the HPUX lockd
479 * will faithfully return LCK_BLOCKED but never cares to notify us when
480 * the lock could be granted. This way, our local process could hang
481 * around forever waiting for the callback.
483 * Solution A: Implement busy-waiting
484 * Solution B: Use the async version of the call (NLM_LOCK_{MSG,RES})
486 * For now I am implementing solution A, because I hate the idea of
487 * re-implementing lockd for a third time in two months. The async
488 * calls shouldn't be too hard to do, however.
490 * This is one of the lovely things about standards in the NFS area:
491 * they're so soft and squishy you can't really blame HP for doing this.
494 nlmclnt_lock(struct nlm_rqst
*req
, struct file_lock
*fl
)
496 struct nlm_host
*host
= req
->a_host
;
497 struct nlm_res
*resp
= &req
->a_res
;
498 struct nlm_wait
*block
= NULL
;
499 unsigned char fl_flags
= fl
->fl_flags
;
500 int status
= -ENOLCK
;
502 if (!host
->h_monitored
&& nsm_monitor(host
) < 0) {
503 printk(KERN_NOTICE
"lockd: failed to monitor %s\n",
507 fl
->fl_flags
|= FL_ACCESS
;
508 status
= do_vfs_lock(fl
);
512 block
= nlmclnt_prepare_block(host
, fl
);
515 /* Reboot protection */
516 fl
->fl_u
.nfs_fl
.state
= host
->h_state
;
517 status
= nlmclnt_call(req
, NLMPROC_LOCK
);
520 if (!req
->a_args
.block
)
522 /* Did a reclaimer thread notify us of a server reboot? */
523 if (resp
->status
== NLM_LCK_DENIED_GRACE_PERIOD
)
525 if (resp
->status
!= NLM_LCK_BLOCKED
)
527 /* Wait on an NLM blocking lock */
528 status
= nlmclnt_block(block
, req
, NLMCLNT_POLL_TIMEOUT
);
529 /* if we were interrupted. Send a CANCEL request to the server
534 if (resp
->status
!= NLM_LCK_BLOCKED
)
538 if (resp
->status
== NLM_LCK_GRANTED
) {
539 down_read(&host
->h_rwsem
);
540 /* Check whether or not the server has rebooted */
541 if (fl
->fl_u
.nfs_fl
.state
!= host
->h_state
) {
542 up_read(&host
->h_rwsem
);
545 /* Ensure the resulting lock will get added to granted list */
546 fl
->fl_flags
= fl_flags
| FL_SLEEP
;
547 if (do_vfs_lock(fl
) < 0)
548 printk(KERN_WARNING
"%s: VFS is out of sync with lock manager!\n", __FUNCTION__
);
549 up_read(&host
->h_rwsem
);
551 status
= nlm_stat_to_errno(resp
->status
);
553 nlmclnt_finish_block(block
);
554 /* Cancel the blocked request if it is still pending */
555 if (resp
->status
== NLM_LCK_BLOCKED
)
556 nlmclnt_cancel(host
, req
->a_args
.block
, fl
);
558 nlm_release_call(req
);
559 fl
->fl_flags
= fl_flags
;
564 * RECLAIM: Try to reclaim a lock
567 nlmclnt_reclaim(struct nlm_host
*host
, struct file_lock
*fl
)
569 struct nlm_rqst reqst
, *req
;
573 memset(req
, 0, sizeof(*req
));
574 locks_init_lock(&req
->a_args
.lock
.fl
);
575 locks_init_lock(&req
->a_res
.lock
.fl
);
579 /* Set up the argument struct */
580 nlmclnt_setlockargs(req
, fl
);
581 req
->a_args
.reclaim
= 1;
583 if ((status
= nlmclnt_call(req
, NLMPROC_LOCK
)) >= 0
584 && req
->a_res
.status
== NLM_LCK_GRANTED
)
587 printk(KERN_WARNING
"lockd: failed to reclaim lock for pid %d "
588 "(errno %d, status %d)\n", fl
->fl_pid
,
589 status
, req
->a_res
.status
);
592 * FIXME: This is a serious failure. We can
594 * a. Ignore the problem
595 * b. Send the owning process some signal (Linux doesn't have
596 * SIGLOST, though...)
597 * c. Retry the operation
599 * Until someone comes up with a simple implementation
600 * for b or c, I'll choose option a.
607 * UNLOCK: remove an existing lock
610 nlmclnt_unlock(struct nlm_rqst
*req
, struct file_lock
*fl
)
612 struct nlm_host
*host
= req
->a_host
;
613 struct nlm_res
*resp
= &req
->a_res
;
617 * Note: the server is supposed to either grant us the unlock
618 * request, or to deny it with NLM_LCK_DENIED_GRACE_PERIOD. In either
619 * case, we want to unlock.
621 fl
->fl_flags
|= FL_EXISTS
;
622 down_read(&host
->h_rwsem
);
623 if (do_vfs_lock(fl
) == -ENOENT
) {
624 up_read(&host
->h_rwsem
);
627 up_read(&host
->h_rwsem
);
629 if (req
->a_flags
& RPC_TASK_ASYNC
)
630 return nlm_async_call(req
, NLMPROC_UNLOCK
, &nlmclnt_unlock_ops
);
632 status
= nlmclnt_call(req
, NLMPROC_UNLOCK
);
636 if (resp
->status
== NLM_LCK_GRANTED
)
639 if (resp
->status
!= NLM_LCK_DENIED_NOLOCKS
)
640 printk("lockd: unexpected unlock status: %d\n", resp
->status
);
641 /* What to do now? I'm out of my depth... */
644 nlm_release_call(req
);
648 static void nlmclnt_unlock_callback(struct rpc_task
*task
, void *data
)
650 struct nlm_rqst
*req
= data
;
651 int status
= req
->a_res
.status
;
653 if (RPC_ASSASSINATED(task
))
656 if (task
->tk_status
< 0) {
657 dprintk("lockd: unlock failed (err = %d)\n", -task
->tk_status
);
660 if (status
== NLM_LCK_DENIED_GRACE_PERIOD
) {
661 rpc_delay(task
, NLMCLNT_GRACE_WAIT
);
664 if (status
!= NLM_LCK_GRANTED
)
665 printk(KERN_WARNING
"lockd: unexpected unlock status: %d\n", status
);
669 nlm_rebind_host(req
->a_host
);
671 rpc_restart_call(task
);
674 static const struct rpc_call_ops nlmclnt_unlock_ops
= {
675 .rpc_call_done
= nlmclnt_unlock_callback
,
676 .rpc_release
= nlmclnt_rpc_release
,
680 * Cancel a blocked lock request.
681 * We always use an async RPC call for this in order not to hang a
682 * process that has been Ctrl-C'ed.
684 static int nlmclnt_cancel(struct nlm_host
*host
, int block
, struct file_lock
*fl
)
686 struct nlm_rqst
*req
;
691 /* Block all signals while setting up call */
692 spin_lock_irqsave(¤t
->sighand
->siglock
, flags
);
693 oldset
= current
->blocked
;
694 sigfillset(¤t
->blocked
);
696 spin_unlock_irqrestore(¤t
->sighand
->siglock
, flags
);
698 req
= nlm_alloc_call(nlm_get_host(host
));
701 req
->a_flags
= RPC_TASK_ASYNC
;
703 nlmclnt_setlockargs(req
, fl
);
704 req
->a_args
.block
= block
;
706 status
= nlm_async_call(req
, NLMPROC_CANCEL
, &nlmclnt_cancel_ops
);
708 spin_lock_irqsave(¤t
->sighand
->siglock
, flags
);
709 current
->blocked
= oldset
;
711 spin_unlock_irqrestore(¤t
->sighand
->siglock
, flags
);
716 static void nlmclnt_cancel_callback(struct rpc_task
*task
, void *data
)
718 struct nlm_rqst
*req
= data
;
720 if (RPC_ASSASSINATED(task
))
723 if (task
->tk_status
< 0) {
724 dprintk("lockd: CANCEL call error %d, retrying.\n",
729 dprintk("lockd: cancel status %d (task %d)\n",
730 req
->a_res
.status
, task
->tk_pid
);
732 switch (req
->a_res
.status
) {
733 case NLM_LCK_GRANTED
:
734 case NLM_LCK_DENIED_GRACE_PERIOD
:
736 /* Everything's good */
738 case NLM_LCK_DENIED_NOLOCKS
:
739 dprintk("lockd: CANCEL failed (server has no locks)\n");
742 printk(KERN_NOTICE
"lockd: weird return %d for CANCEL call\n",
750 /* Don't ever retry more than 3 times */
751 if (req
->a_retries
++ >= NLMCLNT_MAX_RETRIES
)
753 nlm_rebind_host(req
->a_host
);
754 rpc_restart_call(task
);
755 rpc_delay(task
, 30 * HZ
);
758 static const struct rpc_call_ops nlmclnt_cancel_ops
= {
759 .rpc_call_done
= nlmclnt_cancel_callback
,
760 .rpc_release
= nlmclnt_rpc_release
,
764 * Convert an NLM status code to a generic kernel errno
767 nlm_stat_to_errno(u32 status
)
770 case NLM_LCK_GRANTED
:
774 case NLM_LCK_DENIED_NOLOCKS
:
775 case NLM_LCK_DENIED_GRACE_PERIOD
:
777 case NLM_LCK_BLOCKED
:
778 printk(KERN_NOTICE
"lockd: unexpected status NLM_BLOCKED\n");
780 #ifdef CONFIG_LOCKD_V4
793 printk(KERN_NOTICE
"lockd: unexpected server status %d\n", status
);