blob: 5df517b81f3f2a7911e1518c33021e9eb557c85e [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>
10#include <linux/types.h>
11#include <linux/errno.h>
12#include <linux/fs.h>
13#include <linux/nfs_fs.h>
14#include <linux/utsname.h>
Nigel Cunningham7dfb7102006-12-06 20:34:23 -080015#include <linux/freezer.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/sunrpc/clnt.h>
17#include <linux/sunrpc/svc.h>
18#include <linux/lockd/lockd.h>
19#include <linux/lockd/sm_inter.h>
20
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);
61 nlm_release_host(lockowner->host);
62 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;
128
129 nlmclnt_next_cookie(&argp->cookie);
130 argp->state = nsm_local_state;
Josef Sipek225a7192006-12-08 02:37:18 -0800131 memcpy(&lock->fh, NFS_FH(fl->fl_file->f_path.dentry->d_inode), sizeof(struct nfs_fh));
Serge E. Hallyne9ff3992006-10-02 02:18:11 -0700132 lock->caller = utsname()->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,
Serge E. Hallyne9ff3992006-10-02 02:18:11 -0700136 utsname()->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 Myklebust3a649b82006-03-20 13:44:44 -0500145 BUG_ON(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
Chuck Lever1093a602008-01-11 17:09:59 -0500160 nlm_get_host(host);
Trond Myklebust92737232006-03-20 13:44:45 -0500161 call = nlm_alloc_call(host);
162 if (call == NULL)
163 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
Trond Myklebust92737232006-03-20 13:44:45 -0500165 nlmclnt_locks_init_private(fl, host);
166 /* Set up the argument struct */
167 nlmclnt_setlockargs(call, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 if (IS_SETLK(cmd) || IS_SETLKW(cmd)) {
170 if (fl->fl_type != F_UNLCK) {
171 call->a_args.block = IS_SETLKW(cmd) ? 1 : 0;
172 status = nlmclnt_lock(call, fl);
173 } else
174 status = nlmclnt_unlock(call, fl);
175 } else if (IS_GETLK(cmd))
176 status = nlmclnt_test(call, fl);
177 else
178 status = -EINVAL;
179
Trond Myklebust92737232006-03-20 13:44:45 -0500180 fl->fl_ops->fl_release_private(fl);
181 fl->fl_ops = NULL;
182
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 dprintk("lockd: clnt proc returns %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 return status;
185}
Chuck Lever1093a602008-01-11 17:09:59 -0500186EXPORT_SYMBOL_GPL(nlmclnt_proc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
188/*
189 * Allocate an NLM RPC call struct
Trond Myklebust92737232006-03-20 13:44:45 -0500190 *
191 * Note: the caller must hold a reference to host. In case of failure,
192 * this reference will be released.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 */
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);
Trond Myklebust92737232006-03-20 13:44:45 -0500204 call->a_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 }
Trond Myklebust92737232006-03-20 13:44:45 -0500212 nlm_release_host(host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 return NULL;
214}
215
Trond Myklebust92737232006-03-20 13:44:45 -0500216void nlm_release_call(struct nlm_rqst *call)
217{
Trond Myklebust5e7f37a2008-04-01 18:58:49 -0400218 if (!atomic_dec_and_test(&call->a_count))
219 return;
Trond Myklebust92737232006-03-20 13:44:45 -0500220 nlm_release_host(call->a_host);
221 nlmclnt_release_lockargs(call);
222 kfree(call);
223}
224
225static void nlmclnt_rpc_release(void *data)
226{
Trond Myklebust65fdf7d2008-01-11 17:41:29 -0500227 nlm_release_call(data);
Trond Myklebust92737232006-03-20 13:44:45 -0500228}
229
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230static int nlm_wait_on_grace(wait_queue_head_t *queue)
231{
232 DEFINE_WAIT(wait);
233 int status = -EINTR;
234
235 prepare_to_wait(queue, &wait, TASK_INTERRUPTIBLE);
236 if (!signalled ()) {
237 schedule_timeout(NLMCLNT_GRACE_WAIT);
Christoph Lameter3e1d1d22005-06-24 23:13:50 -0700238 try_to_freeze();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 if (!signalled ())
240 status = 0;
241 }
242 finish_wait(queue, &wait);
243 return status;
244}
245
246/*
247 * Generic NLM call
248 */
249static int
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400250nlmclnt_call(struct rpc_cred *cred, struct nlm_rqst *req, u32 proc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251{
252 struct nlm_host *host = req->a_host;
253 struct rpc_clnt *clnt;
254 struct nlm_args *argp = &req->a_args;
255 struct nlm_res *resp = &req->a_res;
256 struct rpc_message msg = {
257 .rpc_argp = argp,
258 .rpc_resp = resp,
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400259 .rpc_cred = cred,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 };
261 int status;
262
263 dprintk("lockd: call procedure %d on %s\n",
264 (int)proc, host->h_name);
265
266 do {
267 if (host->h_reclaiming && !argp->reclaim)
268 goto in_grace_period;
269
270 /* If we have no RPC client yet, create one. */
271 if ((clnt = nlm_bind_host(host)) == NULL)
272 return -ENOLCK;
273 msg.rpc_proc = &clnt->cl_procinfo[proc];
274
275 /* Perform the RPC call. If an error occurs, try again */
276 if ((status = rpc_call_sync(clnt, &msg, 0)) < 0) {
277 dprintk("lockd: rpc_call returned error %d\n", -status);
278 switch (status) {
279 case -EPROTONOSUPPORT:
280 status = -EINVAL;
281 break;
282 case -ECONNREFUSED:
283 case -ETIMEDOUT:
284 case -ENOTCONN:
285 nlm_rebind_host(host);
286 status = -EAGAIN;
287 break;
288 case -ERESTARTSYS:
289 return signalled () ? -EINTR : status;
290 default:
291 break;
292 }
293 break;
294 } else
Al Viroe8c5c042006-12-13 00:35:03 -0800295 if (resp->status == nlm_lck_denied_grace_period) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 dprintk("lockd: server in grace period\n");
297 if (argp->reclaim) {
298 printk(KERN_WARNING
299 "lockd: spurious grace period reject?!\n");
300 return -ENOLCK;
301 }
302 } else {
303 if (!argp->reclaim) {
304 /* We appear to be out of the grace period */
305 wake_up_all(&host->h_gracewait);
306 }
307 dprintk("lockd: server returns status %d\n", resp->status);
308 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;
433 fl->fl_end = req->a_res.lock.fl.fl_start;
434 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:
441 nlm_release_call(req);
442 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{
Trond Myklebust4c060b52006-03-20 13:44:41 -0500447 new->fl_u.nfs_fl.state = fl->fl_u.nfs_fl.state;
448 new->fl_u.nfs_fl.owner = nlm_get_lockowner(fl->fl_u.nfs_fl.owner);
449 list_add_tail(&new->fl_u.nfs_fl.list, &fl->fl_u.nfs_fl.owner->host->h_granted);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450}
451
452static void nlmclnt_locks_release_private(struct file_lock *fl)
453{
Trond Myklebust4c060b52006-03-20 13:44:41 -0500454 list_del(&fl->fl_u.nfs_fl.list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 nlm_put_lockowner(fl->fl_u.nfs_fl.owner);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456}
457
458static struct file_lock_operations nlmclnt_lock_ops = {
459 .fl_copy_lock = nlmclnt_locks_copy_lock,
460 .fl_release_private = nlmclnt_locks_release_private,
461};
462
463static void nlmclnt_locks_init_private(struct file_lock *fl, struct nlm_host *host)
464{
465 BUG_ON(fl->fl_ops != NULL);
466 fl->fl_u.nfs_fl.state = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 fl->fl_u.nfs_fl.owner = nlm_find_lockowner(host, fl->fl_owner);
Trond Myklebust4c060b52006-03-20 13:44:41 -0500468 INIT_LIST_HEAD(&fl->fl_u.nfs_fl.list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 fl->fl_ops = &nlmclnt_lock_ops;
470}
471
Trond Myklebust9b073572006-06-29 16:38:34 -0400472static int do_vfs_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473{
474 int res = 0;
475 switch (fl->fl_flags & (FL_POSIX|FL_FLOCK)) {
476 case FL_POSIX:
477 res = posix_lock_file_wait(fl->fl_file, fl);
478 break;
479 case FL_FLOCK:
480 res = flock_lock_file_wait(fl->fl_file, fl);
481 break;
482 default:
483 BUG();
484 }
Trond Myklebust9b073572006-06-29 16:38:34 -0400485 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486}
487
488/*
489 * LOCK: Try to create a lock
490 *
491 * Programmer Harassment Alert
492 *
493 * When given a blocking lock request in a sync RPC call, the HPUX lockd
494 * will faithfully return LCK_BLOCKED but never cares to notify us when
495 * the lock could be granted. This way, our local process could hang
496 * around forever waiting for the callback.
497 *
498 * Solution A: Implement busy-waiting
499 * Solution B: Use the async version of the call (NLM_LOCK_{MSG,RES})
500 *
501 * For now I am implementing solution A, because I hate the idea of
502 * re-implementing lockd for a third time in two months. The async
503 * calls shouldn't be too hard to do, however.
504 *
505 * This is one of the lovely things about standards in the NFS area:
506 * they're so soft and squishy you can't really blame HP for doing this.
507 */
508static int
509nlmclnt_lock(struct nlm_rqst *req, struct file_lock *fl)
510{
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400511 struct rpc_cred *cred = nfs_file_cred(fl->fl_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 struct nlm_host *host = req->a_host;
513 struct nlm_res *resp = &req->a_res;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500514 struct nlm_wait *block = NULL;
Trond Myklebust01c3b862006-06-29 16:38:39 -0400515 unsigned char fl_flags = fl->fl_flags;
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400516 unsigned char fl_type;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500517 int status = -ENOLCK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518
Olaf Kirch977faf32006-10-04 02:15:51 -0700519 if (nsm_monitor(host) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 printk(KERN_NOTICE "lockd: failed to monitor %s\n",
521 host->h_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522 goto out;
523 }
Trond Myklebust01c3b862006-06-29 16:38:39 -0400524 fl->fl_flags |= FL_ACCESS;
525 status = do_vfs_lock(fl);
Trond Myklebust4a9af592008-04-01 18:57:06 -0400526 fl->fl_flags = fl_flags;
Trond Myklebust01c3b862006-06-29 16:38:39 -0400527 if (status < 0)
528 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529
Trond Myklebust3a649b82006-03-20 13:44:44 -0500530 block = nlmclnt_prepare_block(host, fl);
Trond Myklebust28df9552006-06-09 09:40:27 -0400531again:
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400532 /*
533 * Initialise resp->status to a valid non-zero value,
534 * since 0 == nlm_lck_granted
535 */
536 resp->status = nlm_lck_blocked;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000537 for(;;) {
Trond Myklebust28df9552006-06-09 09:40:27 -0400538 /* Reboot protection */
539 fl->fl_u.nfs_fl.state = host->h_state;
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400540 status = nlmclnt_call(cred, req, NLMPROC_LOCK);
Trond Myklebustecdbf762005-06-22 17:16:31 +0000541 if (status < 0)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000542 break;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000543 /* Did a reclaimer thread notify us of a server reboot? */
Al Viroe8c5c042006-12-13 00:35:03 -0800544 if (resp->status == nlm_lck_denied_grace_period)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000545 continue;
Al Viroe8c5c042006-12-13 00:35:03 -0800546 if (resp->status != nlm_lck_blocked)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000547 break;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500548 /* Wait on an NLM blocking lock */
549 status = nlmclnt_block(block, req, NLMCLNT_POLL_TIMEOUT);
Trond Myklebust3a649b82006-03-20 13:44:44 -0500550 if (status < 0)
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400551 break;
Al Viroe8c5c042006-12-13 00:35:03 -0800552 if (resp->status != nlm_lck_blocked)
Trond Myklebust3a649b82006-03-20 13:44:44 -0500553 break;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000554 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400556 /* if we were interrupted while blocking, then cancel the lock request
557 * and exit
558 */
559 if (resp->status == nlm_lck_blocked) {
560 if (!req->a_args.block)
561 goto out_unlock;
562 if (nlmclnt_cancel(host, req->a_args.block, fl) == 0)
563 goto out_unblock;
564 }
565
Al Viroe8c5c042006-12-13 00:35:03 -0800566 if (resp->status == nlm_granted) {
Trond Myklebust28df9552006-06-09 09:40:27 -0400567 down_read(&host->h_rwsem);
568 /* Check whether or not the server has rebooted */
569 if (fl->fl_u.nfs_fl.state != host->h_state) {
570 up_read(&host->h_rwsem);
571 goto again;
572 }
Trond Myklebust4c060b52006-03-20 13:44:41 -0500573 /* Ensure the resulting lock will get added to granted list */
Trond Myklebust4a9af592008-04-01 18:57:06 -0400574 fl->fl_flags |= FL_SLEEP;
Trond Myklebust9b073572006-06-29 16:38:34 -0400575 if (do_vfs_lock(fl) < 0)
Harvey Harrison8e24eea2008-04-30 00:55:09 -0700576 printk(KERN_WARNING "%s: VFS is out of sync with lock manager!\n", __func__);
Trond Myklebust28df9552006-06-09 09:40:27 -0400577 up_read(&host->h_rwsem);
Trond Myklebust4a9af592008-04-01 18:57:06 -0400578 fl->fl_flags = fl_flags;
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400579 status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 }
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400581 if (status < 0)
582 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 status = nlm_stat_to_errno(resp->status);
Trond Myklebustecdbf762005-06-22 17:16:31 +0000584out_unblock:
Trond Myklebust3a649b82006-03-20 13:44:44 -0500585 nlmclnt_finish_block(block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586out:
Trond Myklebust92737232006-03-20 13:44:45 -0500587 nlm_release_call(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 return status;
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400589out_unlock:
590 /* Fatal error: ensure that we remove the lock altogether */
591 dprintk("lockd: lock attempt ended in fatal error.\n"
592 " Attempting to unlock.\n");
593 nlmclnt_finish_block(block);
594 fl_type = fl->fl_type;
595 fl->fl_type = F_UNLCK;
596 down_read(&host->h_rwsem);
597 do_vfs_lock(fl);
598 up_read(&host->h_rwsem);
599 fl->fl_type = fl_type;
600 fl->fl_flags = fl_flags;
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400601 nlmclnt_async_call(cred, req, NLMPROC_UNLOCK, &nlmclnt_unlock_ops);
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400602 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603}
604
605/*
606 * RECLAIM: Try to reclaim a lock
607 */
608int
609nlmclnt_reclaim(struct nlm_host *host, struct file_lock *fl)
610{
611 struct nlm_rqst reqst, *req;
612 int status;
613
614 req = &reqst;
615 memset(req, 0, sizeof(*req));
616 locks_init_lock(&req->a_args.lock.fl);
617 locks_init_lock(&req->a_res.lock.fl);
618 req->a_host = host;
619 req->a_flags = 0;
620
621 /* Set up the argument struct */
622 nlmclnt_setlockargs(req, fl);
623 req->a_args.reclaim = 1;
624
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400625 status = nlmclnt_call(nfs_file_cred(fl->fl_file), req, NLMPROC_LOCK);
626 if (status >= 0 && req->a_res.status == nlm_granted)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 return 0;
628
629 printk(KERN_WARNING "lockd: failed to reclaim lock for pid %d "
630 "(errno %d, status %d)\n", fl->fl_pid,
Al Viroe8c5c042006-12-13 00:35:03 -0800631 status, ntohl(req->a_res.status));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632
633 /*
634 * FIXME: This is a serious failure. We can
635 *
636 * a. Ignore the problem
637 * b. Send the owning process some signal (Linux doesn't have
638 * SIGLOST, though...)
639 * c. Retry the operation
640 *
641 * Until someone comes up with a simple implementation
642 * for b or c, I'll choose option a.
643 */
644
645 return -ENOLCK;
646}
647
648/*
649 * UNLOCK: remove an existing lock
650 */
651static int
652nlmclnt_unlock(struct nlm_rqst *req, struct file_lock *fl)
653{
Trond Myklebust28df9552006-06-09 09:40:27 -0400654 struct nlm_host *host = req->a_host;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 struct nlm_res *resp = &req->a_res;
Trond Myklebust4a9af592008-04-01 18:57:06 -0400656 int status;
657 unsigned char fl_flags = fl->fl_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658
Christoph Hellwig26bcbf92006-03-20 13:44:40 -0500659 /*
Trond Myklebust30f4e202006-03-13 21:20:49 -0800660 * Note: the server is supposed to either grant us the unlock
661 * request, or to deny it with NLM_LCK_DENIED_GRACE_PERIOD. In either
662 * case, we want to unlock.
663 */
Trond Myklebust9b073572006-06-29 16:38:34 -0400664 fl->fl_flags |= FL_EXISTS;
Trond Myklebust28df9552006-06-09 09:40:27 -0400665 down_read(&host->h_rwsem);
Trond Myklebust4a9af592008-04-01 18:57:06 -0400666 status = do_vfs_lock(fl);
667 up_read(&host->h_rwsem);
668 fl->fl_flags = fl_flags;
669 if (status == -ENOENT) {
670 status = 0;
Trond Myklebust9b073572006-06-29 16:38:34 -0400671 goto out;
672 }
Trond Myklebust30f4e202006-03-13 21:20:49 -0800673
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400674 atomic_inc(&req->a_count);
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400675 status = nlmclnt_async_call(nfs_file_cred(fl->fl_file), req,
676 NLMPROC_UNLOCK, &nlmclnt_unlock_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 if (status < 0)
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_granted)
Trond Myklebust92737232006-03-20 13:44:45 -0500681 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682
Al Viroe8c5c042006-12-13 00:35:03 -0800683 if (resp->status != nlm_lck_denied_nolocks)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 printk("lockd: unexpected unlock status: %d\n", resp->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 /* What to do now? I'm out of my depth... */
Trond Myklebust92737232006-03-20 13:44:45 -0500686 status = -ENOLCK;
687out:
688 nlm_release_call(req);
689 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690}
691
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100692static void nlmclnt_unlock_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693{
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100694 struct nlm_rqst *req = data;
Al Viroe8c5c042006-12-13 00:35:03 -0800695 u32 status = ntohl(req->a_res.status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696
697 if (RPC_ASSASSINATED(task))
698 goto die;
699
700 if (task->tk_status < 0) {
701 dprintk("lockd: unlock failed (err = %d)\n", -task->tk_status);
702 goto retry_rebind;
703 }
704 if (status == NLM_LCK_DENIED_GRACE_PERIOD) {
705 rpc_delay(task, NLMCLNT_GRACE_WAIT);
706 goto retry_unlock;
707 }
708 if (status != NLM_LCK_GRANTED)
709 printk(KERN_WARNING "lockd: unexpected unlock status: %d\n", status);
710die:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 return;
712 retry_rebind:
713 nlm_rebind_host(req->a_host);
714 retry_unlock:
715 rpc_restart_call(task);
716}
717
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100718static const struct rpc_call_ops nlmclnt_unlock_ops = {
719 .rpc_call_done = nlmclnt_unlock_callback,
Trond Myklebust92737232006-03-20 13:44:45 -0500720 .rpc_release = nlmclnt_rpc_release,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100721};
722
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723/*
724 * Cancel a blocked lock request.
725 * We always use an async RPC call for this in order not to hang a
726 * process that has been Ctrl-C'ed.
727 */
Trond Myklebust16fb2422006-02-01 12:18:22 -0500728static int nlmclnt_cancel(struct nlm_host *host, int block, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729{
730 struct nlm_rqst *req;
Trond Myklebust6b4b3a72008-04-02 14:40:53 -0400731 int status;
732
733 dprintk("lockd: blocking lock attempt was interrupted by a signal.\n"
734 " Attempting to cancel lock.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735
Trond Myklebust92737232006-03-20 13:44:45 -0500736 req = nlm_alloc_call(nlm_get_host(host));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 if (!req)
738 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 req->a_flags = RPC_TASK_ASYNC;
740
741 nlmclnt_setlockargs(req, fl);
Trond Myklebust16fb2422006-02-01 12:18:22 -0500742 req->a_args.block = block;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743
Trond Myklebust6b4b3a72008-04-02 14:40:53 -0400744 atomic_inc(&req->a_count);
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400745 status = nlmclnt_async_call(nfs_file_cred(fl->fl_file), req,
746 NLMPROC_CANCEL, &nlmclnt_cancel_ops);
Trond Myklebust6b4b3a72008-04-02 14:40:53 -0400747 if (status == 0 && req->a_res.status == nlm_lck_denied)
748 status = -ENOLCK;
749 nlm_release_call(req);
750 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751}
752
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100753static void nlmclnt_cancel_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754{
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100755 struct nlm_rqst *req = data;
Al Viroe8c5c042006-12-13 00:35:03 -0800756 u32 status = ntohl(req->a_res.status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757
758 if (RPC_ASSASSINATED(task))
759 goto die;
760
761 if (task->tk_status < 0) {
762 dprintk("lockd: CANCEL call error %d, retrying.\n",
763 task->tk_status);
764 goto retry_cancel;
765 }
766
Chuck Leverc041b5f2006-12-05 16:36:03 -0500767 dprintk("lockd: cancel status %u (task %u)\n",
Al Viroe8c5c042006-12-13 00:35:03 -0800768 status, task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769
Al Viroe8c5c042006-12-13 00:35:03 -0800770 switch (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 case NLM_LCK_GRANTED:
772 case NLM_LCK_DENIED_GRACE_PERIOD:
Trond Myklebust35576cb2006-03-20 13:44:41 -0500773 case NLM_LCK_DENIED:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 /* Everything's good */
775 break;
776 case NLM_LCK_DENIED_NOLOCKS:
777 dprintk("lockd: CANCEL failed (server has no locks)\n");
778 goto retry_cancel;
779 default:
780 printk(KERN_NOTICE "lockd: weird return %d for CANCEL call\n",
Al Viroe8c5c042006-12-13 00:35:03 -0800781 status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 }
783
784die:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785 return;
786
787retry_cancel:
Trond Myklebustaaaa9942006-02-01 12:18:25 -0500788 /* Don't ever retry more than 3 times */
789 if (req->a_retries++ >= NLMCLNT_MAX_RETRIES)
790 goto die;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 nlm_rebind_host(req->a_host);
792 rpc_restart_call(task);
793 rpc_delay(task, 30 * HZ);
794}
795
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100796static const struct rpc_call_ops nlmclnt_cancel_ops = {
797 .rpc_call_done = nlmclnt_cancel_callback,
Trond Myklebust92737232006-03-20 13:44:45 -0500798 .rpc_release = nlmclnt_rpc_release,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100799};
800
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801/*
802 * Convert an NLM status code to a generic kernel errno
803 */
804static int
Al Viroe8c5c042006-12-13 00:35:03 -0800805nlm_stat_to_errno(__be32 status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806{
Al Viroe8c5c042006-12-13 00:35:03 -0800807 switch(ntohl(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 case NLM_LCK_GRANTED:
809 return 0;
810 case NLM_LCK_DENIED:
811 return -EAGAIN;
812 case NLM_LCK_DENIED_NOLOCKS:
813 case NLM_LCK_DENIED_GRACE_PERIOD:
814 return -ENOLCK;
815 case NLM_LCK_BLOCKED:
816 printk(KERN_NOTICE "lockd: unexpected status NLM_BLOCKED\n");
817 return -ENOLCK;
818#ifdef CONFIG_LOCKD_V4
819 case NLM_DEADLCK:
820 return -EDEADLK;
821 case NLM_ROFS:
822 return -EROFS;
823 case NLM_STALE_FH:
824 return -ESTALE;
825 case NLM_FBIG:
826 return -EOVERFLOW;
827 case NLM_FAILED:
828 return -ENOLCK;
829#endif
830 }
831 printk(KERN_NOTICE "lockd: unexpected server status %d\n", status);
832 return -ENOLCK;
833}