blob: 112952037933b79fa36dbea67579c576ee19be58 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/fs/lockd/clntproc.c
3 *
4 * RPC procedures for the client side NLM implementation
5 *
6 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
7 */
8
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/module.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090010#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/types.h>
12#include <linux/errno.h>
13#include <linux/fs.h>
14#include <linux/nfs_fs.h>
15#include <linux/utsname.h>
Nigel Cunningham7dfb7102006-12-06 20:34:23 -080016#include <linux/freezer.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/sunrpc/clnt.h>
18#include <linux/sunrpc/svc.h>
19#include <linux/lockd/lockd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21#define NLMDBG_FACILITY NLMDBG_CLIENT
22#define NLMCLNT_GRACE_WAIT (5*HZ)
Trond Myklebustecdbf762005-06-22 17:16:31 +000023#define NLMCLNT_POLL_TIMEOUT (30*HZ)
Trond Myklebustaaaa9942006-02-01 12:18:25 -050024#define NLMCLNT_MAX_RETRIES 3
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
26static int nlmclnt_test(struct nlm_rqst *, struct file_lock *);
27static int nlmclnt_lock(struct nlm_rqst *, struct file_lock *);
28static int nlmclnt_unlock(struct nlm_rqst *, struct file_lock *);
Al Viroe8c5c042006-12-13 00:35:03 -080029static int nlm_stat_to_errno(__be32 stat);
Linus Torvalds1da177e2005-04-16 15:20:36 -070030static void nlmclnt_locks_init_private(struct file_lock *fl, struct nlm_host *host);
Trond Myklebust16fb2422006-02-01 12:18:22 -050031static int nlmclnt_cancel(struct nlm_host *, int , struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070032
Trond Myklebust963d8fe2006-01-03 09:55:04 +010033static const struct rpc_call_ops nlmclnt_unlock_ops;
34static const struct rpc_call_ops nlmclnt_cancel_ops;
35
Linus Torvalds1da177e2005-04-16 15:20:36 -070036/*
37 * Cookie counter for NLM requests
38 */
Olaf Kirch031d8692006-10-04 02:16:02 -070039static atomic_t nlm_cookie = ATOMIC_INIT(0x1234);
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
Olaf Kirch031d8692006-10-04 02:16:02 -070041void nlmclnt_next_cookie(struct nlm_cookie *c)
Linus Torvalds1da177e2005-04-16 15:20:36 -070042{
Olaf Kirch031d8692006-10-04 02:16:02 -070043 u32 cookie = atomic_inc_return(&nlm_cookie);
44
45 memcpy(c->data, &cookie, 4);
Linus Torvalds1da177e2005-04-16 15:20:36 -070046 c->len=4;
Linus Torvalds1da177e2005-04-16 15:20:36 -070047}
48
49static struct nlm_lockowner *nlm_get_lockowner(struct nlm_lockowner *lockowner)
50{
51 atomic_inc(&lockowner->count);
52 return lockowner;
53}
54
55static void nlm_put_lockowner(struct nlm_lockowner *lockowner)
56{
57 if (!atomic_dec_and_lock(&lockowner->count, &lockowner->host->h_lock))
58 return;
59 list_del(&lockowner->list);
60 spin_unlock(&lockowner->host->h_lock);
Chuck Lever8ea6ecc2010-12-14 15:05:52 +000061 nlmclnt_release_host(lockowner->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 kfree(lockowner);
63}
64
65static inline int nlm_pidbusy(struct nlm_host *host, uint32_t pid)
66{
67 struct nlm_lockowner *lockowner;
68 list_for_each_entry(lockowner, &host->h_lockowners, list) {
69 if (lockowner->pid == pid)
70 return -EBUSY;
71 }
72 return 0;
73}
74
75static inline uint32_t __nlm_alloc_pid(struct nlm_host *host)
76{
77 uint32_t res;
78 do {
79 res = host->h_pidcount++;
80 } while (nlm_pidbusy(host, res) < 0);
81 return res;
82}
83
84static struct nlm_lockowner *__nlm_find_lockowner(struct nlm_host *host, fl_owner_t owner)
85{
86 struct nlm_lockowner *lockowner;
87 list_for_each_entry(lockowner, &host->h_lockowners, list) {
88 if (lockowner->owner != owner)
89 continue;
90 return nlm_get_lockowner(lockowner);
91 }
92 return NULL;
93}
94
95static struct nlm_lockowner *nlm_find_lockowner(struct nlm_host *host, fl_owner_t owner)
96{
97 struct nlm_lockowner *res, *new = NULL;
98
99 spin_lock(&host->h_lock);
100 res = __nlm_find_lockowner(host, owner);
101 if (res == NULL) {
102 spin_unlock(&host->h_lock);
Panagiotis Issarisf52720c2006-09-27 01:49:39 -0700103 new = kmalloc(sizeof(*new), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 spin_lock(&host->h_lock);
105 res = __nlm_find_lockowner(host, owner);
106 if (res == NULL && new != NULL) {
107 res = new;
108 atomic_set(&new->count, 1);
109 new->owner = owner;
110 new->pid = __nlm_alloc_pid(host);
111 new->host = nlm_get_host(host);
112 list_add(&new->list, &host->h_lockowners);
113 new = NULL;
114 }
115 }
116 spin_unlock(&host->h_lock);
Jesper Juhlf99d49a2005-11-07 01:01:34 -0800117 kfree(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 return res;
119}
120
121/*
122 * Initialize arguments for TEST/LOCK/UNLOCK/CANCEL calls
123 */
124static void nlmclnt_setlockargs(struct nlm_rqst *req, struct file_lock *fl)
125{
126 struct nlm_args *argp = &req->a_args;
127 struct nlm_lock *lock = &argp->lock;
Trond Myklebust9a1b6bf2013-08-05 12:06:12 -0400128 char *nodename = req->a_host->h_rpcclnt->cl_nodename;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
130 nlmclnt_next_cookie(&argp->cookie);
Al Viro496ad9a2013-01-23 17:07:38 -0500131 memcpy(&lock->fh, NFS_FH(file_inode(fl->fl_file)), sizeof(struct nfs_fh));
Trond Myklebust9a1b6bf2013-08-05 12:06:12 -0400132 lock->caller = nodename;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 lock->oh.data = req->a_owner;
Trond Myklebust7bab3772006-03-20 13:44:06 -0500134 lock->oh.len = snprintf(req->a_owner, sizeof(req->a_owner), "%u@%s",
135 (unsigned int)fl->fl_u.nfs_fl.owner->pid,
Trond Myklebust9a1b6bf2013-08-05 12:06:12 -0400136 nodename);
Trond Myklebust7bab3772006-03-20 13:44:06 -0500137 lock->svid = fl->fl_u.nfs_fl.owner->pid;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500138 lock->fl.fl_start = fl->fl_start;
139 lock->fl.fl_end = fl->fl_end;
140 lock->fl.fl_type = fl->fl_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141}
142
143static void nlmclnt_release_lockargs(struct nlm_rqst *req)
144{
Trond Myklebust26269342012-10-15 17:28:45 -0400145 WARN_ON_ONCE(req->a_args.lock.fl.fl_ops != NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146}
147
Chuck Lever1093a602008-01-11 17:09:59 -0500148/**
149 * nlmclnt_proc - Perform a single client-side lock request
150 * @host: address of a valid nlm_host context representing the NLM server
151 * @cmd: fcntl-style file lock operation to perform
152 * @fl: address of arguments for the lock operation
153 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 */
Chuck Lever1093a602008-01-11 17:09:59 -0500155int nlmclnt_proc(struct nlm_host *host, int cmd, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156{
Trond Myklebust92737232006-03-20 13:44:45 -0500157 struct nlm_rqst *call;
Chuck Lever1093a602008-01-11 17:09:59 -0500158 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
Trond Myklebust92737232006-03-20 13:44:45 -0500160 call = nlm_alloc_call(host);
161 if (call == NULL)
162 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
Trond Myklebust92737232006-03-20 13:44:45 -0500164 nlmclnt_locks_init_private(fl, host);
Al Virobf884892012-07-29 23:17:39 +0400165 if (!fl->fl_u.nfs_fl.owner) {
166 /* lockowner allocation has failed */
167 nlmclnt_release_call(call);
168 return -ENOMEM;
169 }
Trond Myklebust92737232006-03-20 13:44:45 -0500170 /* Set up the argument struct */
171 nlmclnt_setlockargs(call, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 if (IS_SETLK(cmd) || IS_SETLKW(cmd)) {
174 if (fl->fl_type != F_UNLCK) {
175 call->a_args.block = IS_SETLKW(cmd) ? 1 : 0;
176 status = nlmclnt_lock(call, fl);
177 } else
178 status = nlmclnt_unlock(call, fl);
179 } else if (IS_GETLK(cmd))
180 status = nlmclnt_test(call, fl);
181 else
182 status = -EINVAL;
Trond Myklebust92737232006-03-20 13:44:45 -0500183 fl->fl_ops->fl_release_private(fl);
184 fl->fl_ops = NULL;
185
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 dprintk("lockd: clnt proc returns %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 return status;
188}
Chuck Lever1093a602008-01-11 17:09:59 -0500189EXPORT_SYMBOL_GPL(nlmclnt_proc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190
191/*
192 * Allocate an NLM RPC call struct
193 */
Trond Myklebust92737232006-03-20 13:44:45 -0500194struct nlm_rqst *nlm_alloc_call(struct nlm_host *host)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195{
196 struct nlm_rqst *call;
197
Trond Myklebust36943fa2006-03-20 13:44:05 -0500198 for(;;) {
199 call = kzalloc(sizeof(*call), GFP_KERNEL);
200 if (call != NULL) {
Trond Myklebust5e7f37a2008-04-01 18:58:49 -0400201 atomic_set(&call->a_count, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 locks_init_lock(&call->a_args.lock.fl);
203 locks_init_lock(&call->a_res.lock.fl);
Al Viro446945a2012-07-26 00:39:50 +0400204 call->a_host = nlm_get_host(host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 return call;
206 }
Trond Myklebust36943fa2006-03-20 13:44:05 -0500207 if (signalled())
208 break;
Trond Myklebust92737232006-03-20 13:44:45 -0500209 printk("nlm_alloc_call: failed, waiting for memory\n");
Nishanth Aravamudan041e0e32005-09-10 00:27:23 -0700210 schedule_timeout_interruptible(5*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 }
212 return NULL;
213}
214
Chuck Lever7db836d2010-12-14 15:05:42 +0000215void nlmclnt_release_call(struct nlm_rqst *call)
Trond Myklebust92737232006-03-20 13:44:45 -0500216{
Trond Myklebust5e7f37a2008-04-01 18:58:49 -0400217 if (!atomic_dec_and_test(&call->a_count))
218 return;
Chuck Lever8ea6ecc2010-12-14 15:05:52 +0000219 nlmclnt_release_host(call->a_host);
Trond Myklebust92737232006-03-20 13:44:45 -0500220 nlmclnt_release_lockargs(call);
221 kfree(call);
222}
223
224static void nlmclnt_rpc_release(void *data)
225{
Chuck Lever7db836d2010-12-14 15:05:42 +0000226 nlmclnt_release_call(data);
Trond Myklebust92737232006-03-20 13:44:45 -0500227}
228
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229static int nlm_wait_on_grace(wait_queue_head_t *queue)
230{
231 DEFINE_WAIT(wait);
232 int status = -EINTR;
233
234 prepare_to_wait(queue, &wait, TASK_INTERRUPTIBLE);
235 if (!signalled ()) {
236 schedule_timeout(NLMCLNT_GRACE_WAIT);
Christoph Lameter3e1d1d22005-06-24 23:13:50 -0700237 try_to_freeze();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 if (!signalled ())
239 status = 0;
240 }
241 finish_wait(queue, &wait);
242 return status;
243}
244
245/*
246 * Generic NLM call
247 */
248static int
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400249nlmclnt_call(struct rpc_cred *cred, struct nlm_rqst *req, u32 proc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250{
251 struct nlm_host *host = req->a_host;
252 struct rpc_clnt *clnt;
253 struct nlm_args *argp = &req->a_args;
254 struct nlm_res *resp = &req->a_res;
255 struct rpc_message msg = {
256 .rpc_argp = argp,
257 .rpc_resp = resp,
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400258 .rpc_cred = cred,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 };
260 int status;
261
262 dprintk("lockd: call procedure %d on %s\n",
263 (int)proc, host->h_name);
264
265 do {
266 if (host->h_reclaiming && !argp->reclaim)
267 goto in_grace_period;
268
269 /* If we have no RPC client yet, create one. */
270 if ((clnt = nlm_bind_host(host)) == NULL)
271 return -ENOLCK;
272 msg.rpc_proc = &clnt->cl_procinfo[proc];
273
274 /* Perform the RPC call. If an error occurs, try again */
275 if ((status = rpc_call_sync(clnt, &msg, 0)) < 0) {
276 dprintk("lockd: rpc_call returned error %d\n", -status);
277 switch (status) {
278 case -EPROTONOSUPPORT:
279 status = -EINVAL;
280 break;
281 case -ECONNREFUSED:
282 case -ETIMEDOUT:
283 case -ENOTCONN:
284 nlm_rebind_host(host);
285 status = -EAGAIN;
286 break;
287 case -ERESTARTSYS:
288 return signalled () ? -EINTR : status;
289 default:
290 break;
291 }
292 break;
293 } else
Al Viroe8c5c042006-12-13 00:35:03 -0800294 if (resp->status == nlm_lck_denied_grace_period) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 dprintk("lockd: server in grace period\n");
296 if (argp->reclaim) {
297 printk(KERN_WARNING
298 "lockd: spurious grace period reject?!\n");
299 return -ENOLCK;
300 }
301 } else {
302 if (!argp->reclaim) {
303 /* We appear to be out of the grace period */
304 wake_up_all(&host->h_gracewait);
305 }
Vasily Averin82c2c8b2011-06-01 16:54:32 +0400306 dprintk("lockd: server returns status %d\n",
307 ntohl(resp->status));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 return 0; /* Okay, call complete */
309 }
310
311in_grace_period:
312 /*
313 * The server has rebooted and appears to be in the grace
314 * period during which locks are only allowed to be
315 * reclaimed.
316 * We can only back off and try again later.
317 */
318 status = nlm_wait_on_grace(&host->h_gracewait);
319 } while (status == 0);
320
321 return status;
322}
323
324/*
325 * Generic NLM call, async version.
326 */
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400327static struct rpc_task *__nlm_async_call(struct nlm_rqst *req, u32 proc, struct rpc_message *msg, const struct rpc_call_ops *tk_ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328{
329 struct nlm_host *host = req->a_host;
330 struct rpc_clnt *clnt;
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400331 struct rpc_task_setup task_setup_data = {
332 .rpc_message = msg,
333 .callback_ops = tk_ops,
334 .callback_data = req,
335 .flags = RPC_TASK_ASYNC,
336 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337
338 dprintk("lockd: call procedure %d on %s (async)\n",
339 (int)proc, host->h_name);
340
341 /* If we have no RPC client yet, create one. */
Trond Myklebust92737232006-03-20 13:44:45 -0500342 clnt = nlm_bind_host(host);
343 if (clnt == NULL)
344 goto out_err;
Trond Myklebustd4716622006-03-20 13:44:45 -0500345 msg->rpc_proc = &clnt->cl_procinfo[proc];
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400346 task_setup_data.rpc_client = clnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
348 /* bootstrap and kick off the async RPC call */
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400349 return rpc_run_task(&task_setup_data);
Trond Myklebust92737232006-03-20 13:44:45 -0500350out_err:
Trond Myklebusta995e9e2007-02-02 15:37:43 -0800351 tk_ops->rpc_release(req);
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400352 return ERR_PTR(-ENOLCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353}
354
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400355static int nlm_do_async_call(struct nlm_rqst *req, u32 proc, struct rpc_message *msg, const struct rpc_call_ops *tk_ops)
356{
357 struct rpc_task *task;
358
359 task = __nlm_async_call(req, proc, msg, tk_ops);
360 if (IS_ERR(task))
361 return PTR_ERR(task);
362 rpc_put_task(task);
363 return 0;
364}
365
366/*
367 * NLM asynchronous call.
368 */
Trond Myklebustd4716622006-03-20 13:44:45 -0500369int nlm_async_call(struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops)
370{
371 struct rpc_message msg = {
372 .rpc_argp = &req->a_args,
373 .rpc_resp = &req->a_res,
374 };
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400375 return nlm_do_async_call(req, proc, &msg, tk_ops);
Trond Myklebustd4716622006-03-20 13:44:45 -0500376}
377
378int nlm_async_reply(struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops)
379{
380 struct rpc_message msg = {
381 .rpc_argp = &req->a_res,
382 };
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400383 return nlm_do_async_call(req, proc, &msg, tk_ops);
384}
385
386/*
387 * NLM client asynchronous call.
388 *
389 * Note that although the calls are asynchronous, and are therefore
390 * guaranteed to complete, we still always attempt to wait for
391 * completion in order to be able to correctly track the lock
392 * state.
393 */
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400394static int nlmclnt_async_call(struct rpc_cred *cred, struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops)
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400395{
396 struct rpc_message msg = {
397 .rpc_argp = &req->a_args,
398 .rpc_resp = &req->a_res,
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400399 .rpc_cred = cred,
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400400 };
401 struct rpc_task *task;
402 int err;
403
404 task = __nlm_async_call(req, proc, &msg, tk_ops);
405 if (IS_ERR(task))
406 return PTR_ERR(task);
407 err = rpc_wait_for_completion_task(task);
408 rpc_put_task(task);
409 return err;
Trond Myklebustd4716622006-03-20 13:44:45 -0500410}
411
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412/*
413 * TEST for the presence of a conflicting lock
414 */
415static int
416nlmclnt_test(struct nlm_rqst *req, struct file_lock *fl)
417{
418 int status;
419
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400420 status = nlmclnt_call(nfs_file_cred(fl->fl_file), req, NLMPROC_TEST);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 if (status < 0)
Trond Myklebust92737232006-03-20 13:44:45 -0500422 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423
Trond Myklebust92737232006-03-20 13:44:45 -0500424 switch (req->a_res.status) {
Al Viroe8c5c042006-12-13 00:35:03 -0800425 case nlm_granted:
Trond Myklebust92737232006-03-20 13:44:45 -0500426 fl->fl_type = F_UNLCK;
427 break;
Al Viroe8c5c042006-12-13 00:35:03 -0800428 case nlm_lck_denied:
Trond Myklebust92737232006-03-20 13:44:45 -0500429 /*
430 * Report the conflicting lock back to the application.
431 */
432 fl->fl_start = req->a_res.lock.fl.fl_start;
Felix Blyakherd67d1c72008-07-15 12:40:22 -0500433 fl->fl_end = req->a_res.lock.fl.fl_end;
Trond Myklebust92737232006-03-20 13:44:45 -0500434 fl->fl_type = req->a_res.lock.fl.fl_type;
435 fl->fl_pid = 0;
436 break;
437 default:
438 status = nlm_stat_to_errno(req->a_res.status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 }
Trond Myklebust92737232006-03-20 13:44:45 -0500440out:
Chuck Lever7db836d2010-12-14 15:05:42 +0000441 nlmclnt_release_call(req);
Trond Myklebust92737232006-03-20 13:44:45 -0500442 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443}
444
445static void nlmclnt_locks_copy_lock(struct file_lock *new, struct file_lock *fl)
446{
Bryan Schumaker63185942010-09-22 09:50:35 -0400447 spin_lock(&fl->fl_u.nfs_fl.owner->host->h_lock);
Trond Myklebust4c060b52006-03-20 13:44:41 -0500448 new->fl_u.nfs_fl.state = fl->fl_u.nfs_fl.state;
449 new->fl_u.nfs_fl.owner = nlm_get_lockowner(fl->fl_u.nfs_fl.owner);
450 list_add_tail(&new->fl_u.nfs_fl.list, &fl->fl_u.nfs_fl.owner->host->h_granted);
Bryan Schumaker63185942010-09-22 09:50:35 -0400451 spin_unlock(&fl->fl_u.nfs_fl.owner->host->h_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452}
453
454static void nlmclnt_locks_release_private(struct file_lock *fl)
455{
Bryan Schumaker63185942010-09-22 09:50:35 -0400456 spin_lock(&fl->fl_u.nfs_fl.owner->host->h_lock);
Trond Myklebust4c060b52006-03-20 13:44:41 -0500457 list_del(&fl->fl_u.nfs_fl.list);
Bryan Schumaker63185942010-09-22 09:50:35 -0400458 spin_unlock(&fl->fl_u.nfs_fl.owner->host->h_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 nlm_put_lockowner(fl->fl_u.nfs_fl.owner);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460}
461
Alexey Dobriyan6aed6282009-09-21 17:01:11 -0700462static const struct file_lock_operations nlmclnt_lock_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 .fl_copy_lock = nlmclnt_locks_copy_lock,
464 .fl_release_private = nlmclnt_locks_release_private,
465};
466
467static void nlmclnt_locks_init_private(struct file_lock *fl, struct nlm_host *host)
468{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 fl->fl_u.nfs_fl.state = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 fl->fl_u.nfs_fl.owner = nlm_find_lockowner(host, fl->fl_owner);
Trond Myklebust4c060b52006-03-20 13:44:41 -0500471 INIT_LIST_HEAD(&fl->fl_u.nfs_fl.list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 fl->fl_ops = &nlmclnt_lock_ops;
473}
474
Trond Myklebust9b073572006-06-29 16:38:34 -0400475static int do_vfs_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476{
Benjamin Coddington4f656362015-10-22 13:38:14 -0400477 return locks_lock_file_wait(fl->fl_file, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478}
479
480/*
481 * LOCK: Try to create a lock
482 *
483 * Programmer Harassment Alert
484 *
485 * When given a blocking lock request in a sync RPC call, the HPUX lockd
486 * will faithfully return LCK_BLOCKED but never cares to notify us when
487 * the lock could be granted. This way, our local process could hang
488 * around forever waiting for the callback.
489 *
490 * Solution A: Implement busy-waiting
491 * Solution B: Use the async version of the call (NLM_LOCK_{MSG,RES})
492 *
493 * For now I am implementing solution A, because I hate the idea of
494 * re-implementing lockd for a third time in two months. The async
495 * calls shouldn't be too hard to do, however.
496 *
497 * This is one of the lovely things about standards in the NFS area:
498 * they're so soft and squishy you can't really blame HP for doing this.
499 */
500static int
501nlmclnt_lock(struct nlm_rqst *req, struct file_lock *fl)
502{
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400503 struct rpc_cred *cred = nfs_file_cred(fl->fl_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 struct nlm_host *host = req->a_host;
505 struct nlm_res *resp = &req->a_res;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500506 struct nlm_wait *block = NULL;
Trond Myklebust01c3b862006-06-29 16:38:39 -0400507 unsigned char fl_flags = fl->fl_flags;
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400508 unsigned char fl_type;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500509 int status = -ENOLCK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510
Chuck Lever501c1ed2008-12-04 14:21:01 -0500511 if (nsm_monitor(host) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 goto out;
Chuck Lever6c9dc4252009-06-17 18:02:10 -0700513 req->a_args.state = nsm_local_state;
Chuck Lever501c1ed2008-12-04 14:21:01 -0500514
Trond Myklebust01c3b862006-06-29 16:38:39 -0400515 fl->fl_flags |= FL_ACCESS;
516 status = do_vfs_lock(fl);
Trond Myklebust4a9af592008-04-01 18:57:06 -0400517 fl->fl_flags = fl_flags;
Trond Myklebust01c3b862006-06-29 16:38:39 -0400518 if (status < 0)
519 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520
Trond Myklebust3a649b82006-03-20 13:44:44 -0500521 block = nlmclnt_prepare_block(host, fl);
Trond Myklebust28df9552006-06-09 09:40:27 -0400522again:
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400523 /*
524 * Initialise resp->status to a valid non-zero value,
525 * since 0 == nlm_lck_granted
526 */
527 resp->status = nlm_lck_blocked;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000528 for(;;) {
Trond Myklebust28df9552006-06-09 09:40:27 -0400529 /* Reboot protection */
530 fl->fl_u.nfs_fl.state = host->h_state;
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400531 status = nlmclnt_call(cred, req, NLMPROC_LOCK);
Trond Myklebustecdbf762005-06-22 17:16:31 +0000532 if (status < 0)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000533 break;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000534 /* Did a reclaimer thread notify us of a server reboot? */
Al Viroe8c5c042006-12-13 00:35:03 -0800535 if (resp->status == nlm_lck_denied_grace_period)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000536 continue;
Al Viroe8c5c042006-12-13 00:35:03 -0800537 if (resp->status != nlm_lck_blocked)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000538 break;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500539 /* Wait on an NLM blocking lock */
540 status = nlmclnt_block(block, req, NLMCLNT_POLL_TIMEOUT);
Trond Myklebust3a649b82006-03-20 13:44:44 -0500541 if (status < 0)
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400542 break;
Al Viroe8c5c042006-12-13 00:35:03 -0800543 if (resp->status != nlm_lck_blocked)
Trond Myklebust3a649b82006-03-20 13:44:44 -0500544 break;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000545 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400547 /* if we were interrupted while blocking, then cancel the lock request
548 * and exit
549 */
550 if (resp->status == nlm_lck_blocked) {
551 if (!req->a_args.block)
552 goto out_unlock;
553 if (nlmclnt_cancel(host, req->a_args.block, fl) == 0)
554 goto out_unblock;
555 }
556
Al Viroe8c5c042006-12-13 00:35:03 -0800557 if (resp->status == nlm_granted) {
Trond Myklebust28df9552006-06-09 09:40:27 -0400558 down_read(&host->h_rwsem);
559 /* Check whether or not the server has rebooted */
560 if (fl->fl_u.nfs_fl.state != host->h_state) {
561 up_read(&host->h_rwsem);
562 goto again;
563 }
Trond Myklebust4c060b52006-03-20 13:44:41 -0500564 /* Ensure the resulting lock will get added to granted list */
Trond Myklebust4a9af592008-04-01 18:57:06 -0400565 fl->fl_flags |= FL_SLEEP;
Trond Myklebust9b073572006-06-29 16:38:34 -0400566 if (do_vfs_lock(fl) < 0)
Harvey Harrison8e24eea2008-04-30 00:55:09 -0700567 printk(KERN_WARNING "%s: VFS is out of sync with lock manager!\n", __func__);
Trond Myklebust28df9552006-06-09 09:40:27 -0400568 up_read(&host->h_rwsem);
Trond Myklebust4a9af592008-04-01 18:57:06 -0400569 fl->fl_flags = fl_flags;
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400570 status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 }
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400572 if (status < 0)
573 goto out_unlock;
Miklos Szeredicc77b152008-07-25 01:48:55 -0700574 /*
575 * EAGAIN doesn't make sense for sleeping locks, and in some
576 * cases NLM_LCK_DENIED is returned for a permanent error. So
577 * turn it into an ENOLCK.
578 */
579 if (resp->status == nlm_lck_denied && (fl_flags & FL_SLEEP))
580 status = -ENOLCK;
581 else
582 status = nlm_stat_to_errno(resp->status);
Trond Myklebustecdbf762005-06-22 17:16:31 +0000583out_unblock:
Trond Myklebust3a649b82006-03-20 13:44:44 -0500584 nlmclnt_finish_block(block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585out:
Chuck Lever7db836d2010-12-14 15:05:42 +0000586 nlmclnt_release_call(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 return status;
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400588out_unlock:
589 /* Fatal error: ensure that we remove the lock altogether */
590 dprintk("lockd: lock attempt ended in fatal error.\n"
591 " Attempting to unlock.\n");
592 nlmclnt_finish_block(block);
593 fl_type = fl->fl_type;
594 fl->fl_type = F_UNLCK;
595 down_read(&host->h_rwsem);
596 do_vfs_lock(fl);
597 up_read(&host->h_rwsem);
598 fl->fl_type = fl_type;
599 fl->fl_flags = fl_flags;
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400600 nlmclnt_async_call(cred, req, NLMPROC_UNLOCK, &nlmclnt_unlock_ops);
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400601 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602}
603
604/*
605 * RECLAIM: Try to reclaim a lock
606 */
607int
Tim Gardnerf25cc712013-02-13 08:40:16 -0700608nlmclnt_reclaim(struct nlm_host *host, struct file_lock *fl,
609 struct nlm_rqst *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 int status;
612
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 memset(req, 0, sizeof(*req));
614 locks_init_lock(&req->a_args.lock.fl);
615 locks_init_lock(&req->a_res.lock.fl);
616 req->a_host = host;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617
618 /* Set up the argument struct */
619 nlmclnt_setlockargs(req, fl);
620 req->a_args.reclaim = 1;
621
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400622 status = nlmclnt_call(nfs_file_cred(fl->fl_file), req, NLMPROC_LOCK);
623 if (status >= 0 && req->a_res.status == nlm_granted)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 return 0;
625
626 printk(KERN_WARNING "lockd: failed to reclaim lock for pid %d "
627 "(errno %d, status %d)\n", fl->fl_pid,
Al Viroe8c5c042006-12-13 00:35:03 -0800628 status, ntohl(req->a_res.status));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629
630 /*
631 * FIXME: This is a serious failure. We can
632 *
633 * a. Ignore the problem
634 * b. Send the owning process some signal (Linux doesn't have
635 * SIGLOST, though...)
636 * c. Retry the operation
637 *
638 * Until someone comes up with a simple implementation
639 * for b or c, I'll choose option a.
640 */
641
642 return -ENOLCK;
643}
644
645/*
646 * UNLOCK: remove an existing lock
647 */
648static int
649nlmclnt_unlock(struct nlm_rqst *req, struct file_lock *fl)
650{
Trond Myklebust28df9552006-06-09 09:40:27 -0400651 struct nlm_host *host = req->a_host;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 struct nlm_res *resp = &req->a_res;
Trond Myklebust4a9af592008-04-01 18:57:06 -0400653 int status;
654 unsigned char fl_flags = fl->fl_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655
Christoph Hellwig26bcbf92006-03-20 13:44:40 -0500656 /*
Trond Myklebust30f4e202006-03-13 21:20:49 -0800657 * Note: the server is supposed to either grant us the unlock
658 * request, or to deny it with NLM_LCK_DENIED_GRACE_PERIOD. In either
659 * case, we want to unlock.
660 */
Trond Myklebust9b073572006-06-29 16:38:34 -0400661 fl->fl_flags |= FL_EXISTS;
Trond Myklebust28df9552006-06-09 09:40:27 -0400662 down_read(&host->h_rwsem);
Trond Myklebust4a9af592008-04-01 18:57:06 -0400663 status = do_vfs_lock(fl);
664 up_read(&host->h_rwsem);
665 fl->fl_flags = fl_flags;
666 if (status == -ENOENT) {
667 status = 0;
Trond Myklebust9b073572006-06-29 16:38:34 -0400668 goto out;
669 }
Trond Myklebust30f4e202006-03-13 21:20:49 -0800670
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400671 atomic_inc(&req->a_count);
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400672 status = nlmclnt_async_call(nfs_file_cred(fl->fl_file), req,
673 NLMPROC_UNLOCK, &nlmclnt_unlock_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 if (status < 0)
Trond Myklebust92737232006-03-20 13:44:45 -0500675 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676
Al Viroe8c5c042006-12-13 00:35:03 -0800677 if (resp->status == nlm_granted)
Trond Myklebust92737232006-03-20 13:44:45 -0500678 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679
Al Viroe8c5c042006-12-13 00:35:03 -0800680 if (resp->status != nlm_lck_denied_nolocks)
Vasily Averin82c2c8b2011-06-01 16:54:32 +0400681 printk("lockd: unexpected unlock status: %d\n",
682 ntohl(resp->status));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 /* What to do now? I'm out of my depth... */
Trond Myklebust92737232006-03-20 13:44:45 -0500684 status = -ENOLCK;
685out:
Chuck Lever7db836d2010-12-14 15:05:42 +0000686 nlmclnt_release_call(req);
Trond Myklebust92737232006-03-20 13:44:45 -0500687 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688}
689
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100690static void nlmclnt_unlock_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691{
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100692 struct nlm_rqst *req = data;
Al Viroe8c5c042006-12-13 00:35:03 -0800693 u32 status = ntohl(req->a_res.status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694
695 if (RPC_ASSASSINATED(task))
696 goto die;
697
698 if (task->tk_status < 0) {
699 dprintk("lockd: unlock failed (err = %d)\n", -task->tk_status);
Trond Myklebust0b760112011-05-31 15:15:34 -0400700 switch (task->tk_status) {
701 case -EACCES:
702 case -EIO:
703 goto die;
704 default:
705 goto retry_rebind;
706 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707 }
708 if (status == NLM_LCK_DENIED_GRACE_PERIOD) {
709 rpc_delay(task, NLMCLNT_GRACE_WAIT);
710 goto retry_unlock;
711 }
712 if (status != NLM_LCK_GRANTED)
713 printk(KERN_WARNING "lockd: unexpected unlock status: %d\n", status);
714die:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 return;
716 retry_rebind:
717 nlm_rebind_host(req->a_host);
718 retry_unlock:
719 rpc_restart_call(task);
720}
721
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100722static const struct rpc_call_ops nlmclnt_unlock_ops = {
723 .rpc_call_done = nlmclnt_unlock_callback,
Trond Myklebust92737232006-03-20 13:44:45 -0500724 .rpc_release = nlmclnt_rpc_release,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100725};
726
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727/*
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.
731 */
Trond Myklebust16fb2422006-02-01 12:18:22 -0500732static int nlmclnt_cancel(struct nlm_host *host, int block, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733{
734 struct nlm_rqst *req;
Trond Myklebust6b4b3a72008-04-02 14:40:53 -0400735 int status;
736
737 dprintk("lockd: blocking lock attempt was interrupted by a signal.\n"
738 " Attempting to cancel lock.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739
Al Viro446945a2012-07-26 00:39:50 +0400740 req = nlm_alloc_call(host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 if (!req)
742 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 req->a_flags = RPC_TASK_ASYNC;
744
745 nlmclnt_setlockargs(req, fl);
Trond Myklebust16fb2422006-02-01 12:18:22 -0500746 req->a_args.block = block;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747
Trond Myklebust6b4b3a72008-04-02 14:40:53 -0400748 atomic_inc(&req->a_count);
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400749 status = nlmclnt_async_call(nfs_file_cred(fl->fl_file), req,
750 NLMPROC_CANCEL, &nlmclnt_cancel_ops);
Trond Myklebust6b4b3a72008-04-02 14:40:53 -0400751 if (status == 0 && req->a_res.status == nlm_lck_denied)
752 status = -ENOLCK;
Chuck Lever7db836d2010-12-14 15:05:42 +0000753 nlmclnt_release_call(req);
Trond Myklebust6b4b3a72008-04-02 14:40:53 -0400754 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755}
756
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100757static void nlmclnt_cancel_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758{
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100759 struct nlm_rqst *req = data;
Al Viroe8c5c042006-12-13 00:35:03 -0800760 u32 status = ntohl(req->a_res.status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761
762 if (RPC_ASSASSINATED(task))
763 goto die;
764
765 if (task->tk_status < 0) {
766 dprintk("lockd: CANCEL call error %d, retrying.\n",
767 task->tk_status);
768 goto retry_cancel;
769 }
770
Chuck Leverc041b5f2006-12-05 16:36:03 -0500771 dprintk("lockd: cancel status %u (task %u)\n",
Al Viroe8c5c042006-12-13 00:35:03 -0800772 status, task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773
Al Viroe8c5c042006-12-13 00:35:03 -0800774 switch (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 case NLM_LCK_GRANTED:
776 case NLM_LCK_DENIED_GRACE_PERIOD:
Trond Myklebust35576cb2006-03-20 13:44:41 -0500777 case NLM_LCK_DENIED:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 /* Everything's good */
779 break;
780 case NLM_LCK_DENIED_NOLOCKS:
781 dprintk("lockd: CANCEL failed (server has no locks)\n");
782 goto retry_cancel;
783 default:
784 printk(KERN_NOTICE "lockd: weird return %d for CANCEL call\n",
Al Viroe8c5c042006-12-13 00:35:03 -0800785 status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 }
787
788die:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 return;
790
791retry_cancel:
Trond Myklebustaaaa9942006-02-01 12:18:25 -0500792 /* Don't ever retry more than 3 times */
793 if (req->a_retries++ >= NLMCLNT_MAX_RETRIES)
794 goto die;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 nlm_rebind_host(req->a_host);
796 rpc_restart_call(task);
797 rpc_delay(task, 30 * HZ);
798}
799
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100800static const struct rpc_call_ops nlmclnt_cancel_ops = {
801 .rpc_call_done = nlmclnt_cancel_callback,
Trond Myklebust92737232006-03-20 13:44:45 -0500802 .rpc_release = nlmclnt_rpc_release,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100803};
804
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805/*
806 * Convert an NLM status code to a generic kernel errno
807 */
808static int
Al Viroe8c5c042006-12-13 00:35:03 -0800809nlm_stat_to_errno(__be32 status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810{
Al Viroe8c5c042006-12-13 00:35:03 -0800811 switch(ntohl(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 case NLM_LCK_GRANTED:
813 return 0;
814 case NLM_LCK_DENIED:
815 return -EAGAIN;
816 case NLM_LCK_DENIED_NOLOCKS:
817 case NLM_LCK_DENIED_GRACE_PERIOD:
818 return -ENOLCK;
819 case NLM_LCK_BLOCKED:
820 printk(KERN_NOTICE "lockd: unexpected status NLM_BLOCKED\n");
821 return -ENOLCK;
822#ifdef CONFIG_LOCKD_V4
823 case NLM_DEADLCK:
824 return -EDEADLK;
825 case NLM_ROFS:
826 return -EROFS;
827 case NLM_STALE_FH:
828 return -ESTALE;
829 case NLM_FBIG:
830 return -EOVERFLOW;
831 case NLM_FAILED:
832 return -ENOLCK;
833#endif
834 }
Vasily Averin82c2c8b2011-06-01 16:54:32 +0400835 printk(KERN_NOTICE "lockd: unexpected server status %d\n",
836 ntohl(status));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 return -ENOLCK;
838}