blob: a2717408c4781a5cbe5fb6c607e3aed1a03a1a8e [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>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090011#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/time.h>
13#include <linux/nfs_fs.h>
14#include <linux/sunrpc/clnt.h>
15#include <linux/sunrpc/svc.h>
16#include <linux/lockd/lockd.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);
Bryan Schumaker63185942010-09-22 09:50:35 -040044static DEFINE_SPINLOCK(nlm_blocked_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
Chuck Lever52c40442008-01-11 17:09:44 -050046/**
47 * nlmclnt_init - Set up per-NFS mount point lockd data structures
Chuck Lever883bb162008-01-15 16:04:20 -050048 * @nlm_init: pointer to arguments structure
Chuck Lever52c40442008-01-11 17:09:44 -050049 *
50 * Returns pointer to an appropriate nlm_host struct,
51 * or an ERR_PTR value.
52 */
Chuck Lever883bb162008-01-15 16:04:20 -050053struct nlm_host *nlmclnt_init(const struct nlmclnt_initdata *nlm_init)
Chuck Lever52c40442008-01-11 17:09:44 -050054{
55 struct nlm_host *host;
Chuck Lever883bb162008-01-15 16:04:20 -050056 u32 nlm_version = (nlm_init->nfs_version == 2) ? 1 : 4;
Chuck Lever52c40442008-01-11 17:09:44 -050057 int status;
58
Stanislav Kinsburskye3f70ea2012-03-29 18:54:33 +040059 status = lockd_up(nlm_init->net);
Chuck Lever52c40442008-01-11 17:09:44 -050060 if (status < 0)
61 return ERR_PTR(status);
62
Chuck Leverd7d20442008-10-03 12:50:21 -040063 host = nlmclnt_lookup_host(nlm_init->address, nlm_init->addrlen,
Chuck Lever883bb162008-01-15 16:04:20 -050064 nlm_init->protocol, nlm_version,
Stanislav Kinsbursky66697bf2012-01-31 15:08:13 +040065 nlm_init->hostname, nlm_init->noresvport,
66 nlm_init->net);
Chuck Lever52c40442008-01-11 17:09:44 -050067 if (host == NULL) {
Stanislav Kinsburskye3f70ea2012-03-29 18:54:33 +040068 lockd_down(nlm_init->net);
Chuck Lever52c40442008-01-11 17:09:44 -050069 return ERR_PTR(-ENOLCK);
70 }
71
72 return host;
73}
74EXPORT_SYMBOL_GPL(nlmclnt_init);
75
76/**
77 * nlmclnt_done - Release resources allocated by nlmclnt_init()
78 * @host: nlm_host structure reserved by nlmclnt_init()
79 *
80 */
81void nlmclnt_done(struct nlm_host *host)
82{
Stanislav Kinsburskye3f70ea2012-03-29 18:54:33 +040083 struct net *net = host->net;
84
Chuck Lever8ea6ecc2010-12-14 15:05:52 +000085 nlmclnt_release_host(host);
Stanislav Kinsburskye3f70ea2012-03-29 18:54:33 +040086 lockd_down(net);
Chuck Lever52c40442008-01-11 17:09:44 -050087}
88EXPORT_SYMBOL_GPL(nlmclnt_done);
89
Linus Torvalds1da177e2005-04-16 15:20:36 -070090/*
Trond Myklebustecdbf762005-06-22 17:16:31 +000091 * Queue up a lock for blocking so that the GRANTED request can see it
92 */
Trond Myklebust3a649b82006-03-20 13:44:44 -050093struct nlm_wait *nlmclnt_prepare_block(struct nlm_host *host, struct file_lock *fl)
Trond Myklebustecdbf762005-06-22 17:16:31 +000094{
95 struct nlm_wait *block;
96
Trond Myklebustecdbf762005-06-22 17:16:31 +000097 block = kmalloc(sizeof(*block), GFP_KERNEL);
Trond Myklebust3a649b82006-03-20 13:44:44 -050098 if (block != NULL) {
99 block->b_host = host;
100 block->b_lock = fl;
101 init_waitqueue_head(&block->b_wait);
Al Viroe8c5c042006-12-13 00:35:03 -0800102 block->b_status = nlm_lck_blocked;
Bryan Schumaker63185942010-09-22 09:50:35 -0400103
104 spin_lock(&nlm_blocked_lock);
Trond Myklebust3a649b82006-03-20 13:44:44 -0500105 list_add(&block->b_list, &nlm_blocked);
Bryan Schumaker63185942010-09-22 09:50:35 -0400106 spin_unlock(&nlm_blocked_lock);
Trond Myklebust3a649b82006-03-20 13:44:44 -0500107 }
108 return block;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000109}
110
Trond Myklebust3a649b82006-03-20 13:44:44 -0500111void nlmclnt_finish_block(struct nlm_wait *block)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000112{
Trond Myklebustecdbf762005-06-22 17:16:31 +0000113 if (block == NULL)
114 return;
Bryan Schumaker63185942010-09-22 09:50:35 -0400115 spin_lock(&nlm_blocked_lock);
Trond Myklebustecdbf762005-06-22 17:16:31 +0000116 list_del(&block->b_list);
Bryan Schumaker63185942010-09-22 09:50:35 -0400117 spin_unlock(&nlm_blocked_lock);
Trond Myklebustecdbf762005-06-22 17:16:31 +0000118 kfree(block);
119}
120
121/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 * Block on a lock
123 */
Trond Myklebust3a649b82006-03-20 13:44:44 -0500124int nlmclnt_block(struct nlm_wait *block, struct nlm_rqst *req, long timeout)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125{
Trond Myklebustecdbf762005-06-22 17:16:31 +0000126 long ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
Trond Myklebustecdbf762005-06-22 17:16:31 +0000128 /* A borken server might ask us to block even if we didn't
129 * request it. Just say no!
130 */
Trond Myklebust3a649b82006-03-20 13:44:44 -0500131 if (block == NULL)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000132 return -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
134 /* Go to sleep waiting for GRANT callback. Some servers seem
135 * to lose callbacks, however, so we're going to poll from
136 * time to time just to make sure.
137 *
138 * For now, the retry frequency is pretty high; normally
139 * a 1 minute timeout would do. See the comment before
140 * nlmclnt_lock for an explanation.
141 */
Trond Myklebustecdbf762005-06-22 17:16:31 +0000142 ret = wait_event_interruptible_timeout(block->b_wait,
Al Viroe8c5c042006-12-13 00:35:03 -0800143 block->b_status != nlm_lck_blocked,
Trond Myklebustecdbf762005-06-22 17:16:31 +0000144 timeout);
Trond Myklebust3a649b82006-03-20 13:44:44 -0500145 if (ret < 0)
146 return -ERESTARTSYS;
147 req->a_res.status = block->b_status;
148 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149}
150
151/*
152 * The server lockd has called us back to tell us the lock was granted
153 */
Chuck Leverdcff09f2008-10-03 12:50:36 -0400154__be32 nlmclnt_grant(const struct sockaddr *addr, const struct nlm_lock *lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155{
Trond Myklebust5ac5f9d2006-02-14 13:53:04 -0800156 const struct file_lock *fl = &lock->fl;
157 const struct nfs_fh *fh = &lock->fh;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 struct nlm_wait *block;
Al Viro52921e02006-10-19 23:28:46 -0700159 __be32 res = nlm_lck_denied;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
161 /*
162 * Look up blocked request based on arguments.
163 * Warning: must not use cookie to match it!
164 */
Bryan Schumaker63185942010-09-22 09:50:35 -0400165 spin_lock(&nlm_blocked_lock);
Trond Myklebust4f15e2b2005-06-22 17:16:31 +0000166 list_for_each_entry(block, &nlm_blocked, b_list) {
Trond Myklebust5ac5f9d2006-02-14 13:53:04 -0800167 struct file_lock *fl_blocked = block->b_lock;
168
Trond Myklebust7bab3772006-03-20 13:44:06 -0500169 if (fl_blocked->fl_start != fl->fl_start)
170 continue;
171 if (fl_blocked->fl_end != fl->fl_end)
172 continue;
173 /*
174 * Careful! The NLM server will return the 32-bit "pid" that
175 * we put on the wire: in this case the lockowner "pid".
176 */
177 if (fl_blocked->fl_u.nfs_fl.owner->pid != lock->svid)
Trond Myklebust5ac5f9d2006-02-14 13:53:04 -0800178 continue;
Jeff Layton4516fc02009-08-14 12:57:54 -0400179 if (!rpc_cmp_addr(nlm_addr(block->b_host), addr))
Trond Myklebust5ac5f9d2006-02-14 13:53:04 -0800180 continue;
Al Viro496ad9a2013-01-23 17:07:38 -0500181 if (nfs_compare_fh(NFS_FH(file_inode(fl_blocked->fl_file)) ,fh) != 0)
Trond Myklebust5ac5f9d2006-02-14 13:53:04 -0800182 continue;
183 /* Alright, we found a lock. Set the return status
184 * and wake up the caller
185 */
Al Viroe8c5c042006-12-13 00:35:03 -0800186 block->b_status = nlm_granted;
Trond Myklebust5ac5f9d2006-02-14 13:53:04 -0800187 wake_up(&block->b_wait);
188 res = nlm_granted;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 }
Bryan Schumaker63185942010-09-22 09:50:35 -0400190 spin_unlock(&nlm_blocked_lock);
Trond Myklebustecdbf762005-06-22 17:16:31 +0000191 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192}
193
194/*
195 * The following procedures deal with the recovery of locks after a
196 * server crash.
197 */
198
199/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 * Reclaim all locks on server host. We do this by spawning a separate
201 * reclaimer thread.
202 */
203void
Olaf Kirch5c8dd292006-10-04 02:15:55 -0700204nlmclnt_recovery(struct nlm_host *host)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205{
Jeff Laytondf94f002008-12-23 15:21:33 -0500206 struct task_struct *task;
207
Trond Myklebust28df9552006-06-09 09:40:27 -0400208 if (!host->h_reclaiming++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 nlm_get_host(host);
Jeff Laytondf94f002008-12-23 15:21:33 -0500210 task = kthread_run(reclaimer, host, "%s-reclaim", host->h_name);
211 if (IS_ERR(task))
212 printk(KERN_ERR "lockd: unable to spawn reclaimer "
213 "thread. Locks for %s won't be reclaimed! "
214 "(%ld)\n", host->h_name, PTR_ERR(task));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 }
216}
217
218static int
219reclaimer(void *ptr)
220{
221 struct nlm_host *host = (struct nlm_host *) ptr;
222 struct nlm_wait *block;
Christoph Hellwig26bcbf92006-03-20 13:44:40 -0500223 struct file_lock *fl, *next;
Trond Myklebust28df9552006-06-09 09:40:27 -0400224 u32 nsmstate;
Stanislav Kinsburskye3f70ea2012-03-29 18:54:33 +0400225 struct net *net = host->net;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 allow_signal(SIGKILL);
228
Olaf Kirch5c8dd292006-10-04 02:15:55 -0700229 down_write(&host->h_rwsem);
Stanislav Kinsburskye3f70ea2012-03-29 18:54:33 +0400230 lockd_up(net); /* note: this cannot fail as lockd is already running */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
Adrian Bunkd019bcf2007-01-29 13:19:51 -0800232 dprintk("lockd: reclaiming locks for host %s\n", host->h_name);
Olaf Kirch5c8dd292006-10-04 02:15:55 -0700233
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234restart:
Trond Myklebust28df9552006-06-09 09:40:27 -0400235 nsmstate = host->h_nsmstate;
Olaf Kirch5c8dd292006-10-04 02:15:55 -0700236
237 /* Force a portmap getport - the peer's lockd will
238 * most likely end up on a different port.
239 */
Olaf Kirch0ade0602006-10-04 02:16:04 -0700240 host->h_nextrebind = jiffies;
Olaf Kirch5c8dd292006-10-04 02:15:55 -0700241 nlm_rebind_host(host);
242
243 /* First, reclaim all locks that have been granted. */
244 list_splice_init(&host->h_granted, &host->h_reclaim);
Christoph Hellwig26bcbf92006-03-20 13:44:40 -0500245 list_for_each_entry_safe(fl, next, &host->h_reclaim, fl_u.nfs_fl.list) {
Trond Myklebust4c060b52006-03-20 13:44:41 -0500246 list_del_init(&fl->fl_u.nfs_fl.list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
Jeff Laytondf94f002008-12-23 15:21:33 -0500248 /*
249 * sending this thread a SIGKILL will result in any unreclaimed
250 * locks being removed from the h_granted list. This means that
251 * the kernel will not attempt to reclaim them again if a new
252 * reclaimer thread is spawned for this host.
253 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 if (signalled())
Trond Myklebust4c060b52006-03-20 13:44:41 -0500255 continue;
Trond Myklebust28df9552006-06-09 09:40:27 -0400256 if (nlmclnt_reclaim(host, fl) != 0)
257 continue;
258 list_add_tail(&fl->fl_u.nfs_fl.list, &host->h_granted);
259 if (host->h_nsmstate != nsmstate) {
260 /* Argh! The server rebooted again! */
Trond Myklebust28df9552006-06-09 09:40:27 -0400261 goto restart;
262 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 }
Olaf Kirch5c8dd292006-10-04 02:15:55 -0700264
265 host->h_reclaiming = 0;
266 up_write(&host->h_rwsem);
Adrian Bunkd019bcf2007-01-29 13:19:51 -0800267 dprintk("NLM: done reclaiming locks for host %s\n", host->h_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
269 /* Now, wake up all processes that sleep on a blocked lock */
Bryan Schumaker63185942010-09-22 09:50:35 -0400270 spin_lock(&nlm_blocked_lock);
Trond Myklebust4f15e2b2005-06-22 17:16:31 +0000271 list_for_each_entry(block, &nlm_blocked, b_list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 if (block->b_host == host) {
Al Viroe8c5c042006-12-13 00:35:03 -0800273 block->b_status = nlm_lck_denied_grace_period;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 wake_up(&block->b_wait);
275 }
276 }
Bryan Schumaker63185942010-09-22 09:50:35 -0400277 spin_unlock(&nlm_blocked_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
279 /* Release host handle after use */
Chuck Lever8ea6ecc2010-12-14 15:05:52 +0000280 nlmclnt_release_host(host);
Stanislav Kinsburskye3f70ea2012-03-29 18:54:33 +0400281 lockd_down(net);
Jeff Laytondf94f002008-12-23 15:21:33 -0500282 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283}