blob: fc9032dc8862df3408a56e7208aef0fb446e3a5e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/fs/lockd/clntlock.c
3 *
4 * Lock handling for the client side NLM implementation
5 *
6 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
7 */
8
9#include <linux/module.h>
10#include <linux/types.h>
11#include <linux/time.h>
12#include <linux/nfs_fs.h>
13#include <linux/sunrpc/clnt.h>
14#include <linux/sunrpc/svc.h>
15#include <linux/lockd/lockd.h>
16#include <linux/smp_lock.h>
Jeff Laytondf94f002008-12-23 15:21:33 -050017#include <linux/kthread.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018
19#define NLMDBG_FACILITY NLMDBG_CLIENT
20
21/*
22 * Local function prototypes
23 */
24static int reclaimer(void *ptr);
25
26/*
27 * The following functions handle blocking and granting from the
28 * client perspective.
29 */
30
31/*
32 * This is the representation of a blocked client lock.
33 */
34struct nlm_wait {
Trond Myklebust4f15e2b2005-06-22 17:16:31 +000035 struct list_head b_list; /* linked list */
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 wait_queue_head_t b_wait; /* where to wait on */
37 struct nlm_host * b_host;
38 struct file_lock * b_lock; /* local file lock */
39 unsigned short b_reclaim; /* got to reclaim lock */
Al Viroe8c5c042006-12-13 00:35:03 -080040 __be32 b_status; /* grant callback status */
Linus Torvalds1da177e2005-04-16 15:20:36 -070041};
42
Trond Myklebust4f15e2b2005-06-22 17:16:31 +000043static LIST_HEAD(nlm_blocked);
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Chuck Lever52c40442008-01-11 17:09:44 -050045/**
46 * nlmclnt_init - Set up per-NFS mount point lockd data structures
Chuck Lever883bb162008-01-15 16:04:20 -050047 * @nlm_init: pointer to arguments structure
Chuck Lever52c40442008-01-11 17:09:44 -050048 *
49 * Returns pointer to an appropriate nlm_host struct,
50 * or an ERR_PTR value.
51 */
Chuck Lever883bb162008-01-15 16:04:20 -050052struct nlm_host *nlmclnt_init(const struct nlmclnt_initdata *nlm_init)
Chuck Lever52c40442008-01-11 17:09:44 -050053{
54 struct nlm_host *host;
Chuck Lever883bb162008-01-15 16:04:20 -050055 u32 nlm_version = (nlm_init->nfs_version == 2) ? 1 : 4;
Chuck Lever52c40442008-01-11 17:09:44 -050056 int status;
57
Chuck Lever26a41402008-10-03 17:15:30 -040058 status = lockd_up();
Chuck Lever52c40442008-01-11 17:09:44 -050059 if (status < 0)
60 return ERR_PTR(status);
61
Chuck Leverd7d20442008-10-03 12:50:21 -040062 host = nlmclnt_lookup_host(nlm_init->address, nlm_init->addrlen,
Chuck Lever883bb162008-01-15 16:04:20 -050063 nlm_init->protocol, nlm_version,
Chuck Lever0cb26592008-12-23 15:21:38 -050064 nlm_init->hostname, nlm_init->noresvport);
Chuck Lever52c40442008-01-11 17:09:44 -050065 if (host == NULL) {
66 lockd_down();
67 return ERR_PTR(-ENOLCK);
68 }
69
70 return host;
71}
72EXPORT_SYMBOL_GPL(nlmclnt_init);
73
74/**
75 * nlmclnt_done - Release resources allocated by nlmclnt_init()
76 * @host: nlm_host structure reserved by nlmclnt_init()
77 *
78 */
79void nlmclnt_done(struct nlm_host *host)
80{
81 nlm_release_host(host);
82 lockd_down();
83}
84EXPORT_SYMBOL_GPL(nlmclnt_done);
85
Linus Torvalds1da177e2005-04-16 15:20:36 -070086/*
Trond Myklebustecdbf762005-06-22 17:16:31 +000087 * Queue up a lock for blocking so that the GRANTED request can see it
88 */
Trond Myklebust3a649b82006-03-20 13:44:44 -050089struct nlm_wait *nlmclnt_prepare_block(struct nlm_host *host, struct file_lock *fl)
Trond Myklebustecdbf762005-06-22 17:16:31 +000090{
91 struct nlm_wait *block;
92
Trond Myklebustecdbf762005-06-22 17:16:31 +000093 block = kmalloc(sizeof(*block), GFP_KERNEL);
Trond Myklebust3a649b82006-03-20 13:44:44 -050094 if (block != NULL) {
95 block->b_host = host;
96 block->b_lock = fl;
97 init_waitqueue_head(&block->b_wait);
Al Viroe8c5c042006-12-13 00:35:03 -080098 block->b_status = nlm_lck_blocked;
Trond Myklebust3a649b82006-03-20 13:44:44 -050099 list_add(&block->b_list, &nlm_blocked);
100 }
101 return block;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000102}
103
Trond Myklebust3a649b82006-03-20 13:44:44 -0500104void nlmclnt_finish_block(struct nlm_wait *block)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000105{
Trond Myklebustecdbf762005-06-22 17:16:31 +0000106 if (block == NULL)
107 return;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000108 list_del(&block->b_list);
109 kfree(block);
110}
111
112/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 * Block on a lock
114 */
Trond Myklebust3a649b82006-03-20 13:44:44 -0500115int nlmclnt_block(struct nlm_wait *block, struct nlm_rqst *req, long timeout)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116{
Trond Myklebustecdbf762005-06-22 17:16:31 +0000117 long ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
Trond Myklebustecdbf762005-06-22 17:16:31 +0000119 /* A borken server might ask us to block even if we didn't
120 * request it. Just say no!
121 */
Trond Myklebust3a649b82006-03-20 13:44:44 -0500122 if (block == NULL)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000123 return -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
125 /* Go to sleep waiting for GRANT callback. Some servers seem
126 * to lose callbacks, however, so we're going to poll from
127 * time to time just to make sure.
128 *
129 * For now, the retry frequency is pretty high; normally
130 * a 1 minute timeout would do. See the comment before
131 * nlmclnt_lock for an explanation.
132 */
Trond Myklebustecdbf762005-06-22 17:16:31 +0000133 ret = wait_event_interruptible_timeout(block->b_wait,
Al Viroe8c5c042006-12-13 00:35:03 -0800134 block->b_status != nlm_lck_blocked,
Trond Myklebustecdbf762005-06-22 17:16:31 +0000135 timeout);
Trond Myklebust3a649b82006-03-20 13:44:44 -0500136 if (ret < 0)
137 return -ERESTARTSYS;
138 req->a_res.status = block->b_status;
139 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140}
141
142/*
143 * The server lockd has called us back to tell us the lock was granted
144 */
Chuck Leverdcff09f2008-10-03 12:50:36 -0400145__be32 nlmclnt_grant(const struct sockaddr *addr, const struct nlm_lock *lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146{
Trond Myklebust5ac5f9d2006-02-14 13:53:04 -0800147 const struct file_lock *fl = &lock->fl;
148 const struct nfs_fh *fh = &lock->fh;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 struct nlm_wait *block;
Al Viro52921e02006-10-19 23:28:46 -0700150 __be32 res = nlm_lck_denied;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
152 /*
153 * Look up blocked request based on arguments.
154 * Warning: must not use cookie to match it!
155 */
Trond Myklebust4f15e2b2005-06-22 17:16:31 +0000156 list_for_each_entry(block, &nlm_blocked, b_list) {
Trond Myklebust5ac5f9d2006-02-14 13:53:04 -0800157 struct file_lock *fl_blocked = block->b_lock;
158
Trond Myklebust7bab3772006-03-20 13:44:06 -0500159 if (fl_blocked->fl_start != fl->fl_start)
160 continue;
161 if (fl_blocked->fl_end != fl->fl_end)
162 continue;
163 /*
164 * Careful! The NLM server will return the 32-bit "pid" that
165 * we put on the wire: in this case the lockowner "pid".
166 */
167 if (fl_blocked->fl_u.nfs_fl.owner->pid != lock->svid)
Trond Myklebust5ac5f9d2006-02-14 13:53:04 -0800168 continue;
Jeff Layton4516fc02009-08-14 12:57:54 -0400169 if (!rpc_cmp_addr(nlm_addr(block->b_host), addr))
Trond Myklebust5ac5f9d2006-02-14 13:53:04 -0800170 continue;
Josef Sipek225a7192006-12-08 02:37:18 -0800171 if (nfs_compare_fh(NFS_FH(fl_blocked->fl_file->f_path.dentry->d_inode) ,fh) != 0)
Trond Myklebust5ac5f9d2006-02-14 13:53:04 -0800172 continue;
173 /* Alright, we found a lock. Set the return status
174 * and wake up the caller
175 */
Al Viroe8c5c042006-12-13 00:35:03 -0800176 block->b_status = nlm_granted;
Trond Myklebust5ac5f9d2006-02-14 13:53:04 -0800177 wake_up(&block->b_wait);
178 res = nlm_granted;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 }
Trond Myklebustecdbf762005-06-22 17:16:31 +0000180 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181}
182
183/*
184 * The following procedures deal with the recovery of locks after a
185 * server crash.
186 */
187
188/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 * Reclaim all locks on server host. We do this by spawning a separate
190 * reclaimer thread.
191 */
192void
Olaf Kirch5c8dd292006-10-04 02:15:55 -0700193nlmclnt_recovery(struct nlm_host *host)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194{
Jeff Laytondf94f002008-12-23 15:21:33 -0500195 struct task_struct *task;
196
Trond Myklebust28df9552006-06-09 09:40:27 -0400197 if (!host->h_reclaiming++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 nlm_get_host(host);
Jeff Laytondf94f002008-12-23 15:21:33 -0500199 task = kthread_run(reclaimer, host, "%s-reclaim", host->h_name);
200 if (IS_ERR(task))
201 printk(KERN_ERR "lockd: unable to spawn reclaimer "
202 "thread. Locks for %s won't be reclaimed! "
203 "(%ld)\n", host->h_name, PTR_ERR(task));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 }
205}
206
207static int
208reclaimer(void *ptr)
209{
210 struct nlm_host *host = (struct nlm_host *) ptr;
211 struct nlm_wait *block;
Christoph Hellwig26bcbf92006-03-20 13:44:40 -0500212 struct file_lock *fl, *next;
Trond Myklebust28df9552006-06-09 09:40:27 -0400213 u32 nsmstate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 allow_signal(SIGKILL);
216
Olaf Kirch5c8dd292006-10-04 02:15:55 -0700217 down_write(&host->h_rwsem);
218
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 /* This one ensures that our parent doesn't terminate while the
220 * reclaim is in progress */
221 lock_kernel();
Chuck Lever26a41402008-10-03 17:15:30 -0400222 lockd_up(); /* note: this cannot fail as lockd is already running */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223
Adrian Bunkd019bcf2007-01-29 13:19:51 -0800224 dprintk("lockd: reclaiming locks for host %s\n", host->h_name);
Olaf Kirch5c8dd292006-10-04 02:15:55 -0700225
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226restart:
Trond Myklebust28df9552006-06-09 09:40:27 -0400227 nsmstate = host->h_nsmstate;
Olaf Kirch5c8dd292006-10-04 02:15:55 -0700228
229 /* Force a portmap getport - the peer's lockd will
230 * most likely end up on a different port.
231 */
Olaf Kirch0ade0602006-10-04 02:16:04 -0700232 host->h_nextrebind = jiffies;
Olaf Kirch5c8dd292006-10-04 02:15:55 -0700233 nlm_rebind_host(host);
234
235 /* First, reclaim all locks that have been granted. */
236 list_splice_init(&host->h_granted, &host->h_reclaim);
Christoph Hellwig26bcbf92006-03-20 13:44:40 -0500237 list_for_each_entry_safe(fl, next, &host->h_reclaim, fl_u.nfs_fl.list) {
Trond Myklebust4c060b52006-03-20 13:44:41 -0500238 list_del_init(&fl->fl_u.nfs_fl.list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239
Jeff Laytondf94f002008-12-23 15:21:33 -0500240 /*
241 * sending this thread a SIGKILL will result in any unreclaimed
242 * locks being removed from the h_granted list. This means that
243 * the kernel will not attempt to reclaim them again if a new
244 * reclaimer thread is spawned for this host.
245 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 if (signalled())
Trond Myklebust4c060b52006-03-20 13:44:41 -0500247 continue;
Trond Myklebust28df9552006-06-09 09:40:27 -0400248 if (nlmclnt_reclaim(host, fl) != 0)
249 continue;
250 list_add_tail(&fl->fl_u.nfs_fl.list, &host->h_granted);
251 if (host->h_nsmstate != nsmstate) {
252 /* Argh! The server rebooted again! */
Trond Myklebust28df9552006-06-09 09:40:27 -0400253 goto restart;
254 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 }
Olaf Kirch5c8dd292006-10-04 02:15:55 -0700256
257 host->h_reclaiming = 0;
258 up_write(&host->h_rwsem);
Adrian Bunkd019bcf2007-01-29 13:19:51 -0800259 dprintk("NLM: done reclaiming locks for host %s\n", host->h_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260
261 /* Now, wake up all processes that sleep on a blocked lock */
Trond Myklebust4f15e2b2005-06-22 17:16:31 +0000262 list_for_each_entry(block, &nlm_blocked, b_list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 if (block->b_host == host) {
Al Viroe8c5c042006-12-13 00:35:03 -0800264 block->b_status = nlm_lck_denied_grace_period;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 wake_up(&block->b_wait);
266 }
267 }
268
269 /* Release host handle after use */
270 nlm_release_host(host);
271 lockd_down();
272 unlock_kernel();
Jeff Laytondf94f002008-12-23 15:21:33 -0500273 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274}