blob: ea1a6940af22f4454becd8a57e84aa7f4e797a28 [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
250nlmclnt_call(struct nlm_rqst *req, u32 proc)
251{
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,
259 };
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 }
306 dprintk("lockd: server returns status %d\n", resp->status);
307 return 0; /* Okay, call complete */
308 }
309
310in_grace_period:
311 /*
312 * The server has rebooted and appears to be in the grace
313 * period during which locks are only allowed to be
314 * reclaimed.
315 * We can only back off and try again later.
316 */
317 status = nlm_wait_on_grace(&host->h_gracewait);
318 } while (status == 0);
319
320 return status;
321}
322
323/*
324 * Generic NLM call, async version.
325 */
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400326static 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 -0700327{
328 struct nlm_host *host = req->a_host;
329 struct rpc_clnt *clnt;
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400330 struct rpc_task_setup task_setup_data = {
331 .rpc_message = msg,
332 .callback_ops = tk_ops,
333 .callback_data = req,
334 .flags = RPC_TASK_ASYNC,
335 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336
337 dprintk("lockd: call procedure %d on %s (async)\n",
338 (int)proc, host->h_name);
339
340 /* If we have no RPC client yet, create one. */
Trond Myklebust92737232006-03-20 13:44:45 -0500341 clnt = nlm_bind_host(host);
342 if (clnt == NULL)
343 goto out_err;
Trond Myklebustd4716622006-03-20 13:44:45 -0500344 msg->rpc_proc = &clnt->cl_procinfo[proc];
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400345 task_setup_data.rpc_client = clnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
347 /* bootstrap and kick off the async RPC call */
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400348 return rpc_run_task(&task_setup_data);
Trond Myklebust92737232006-03-20 13:44:45 -0500349out_err:
Trond Myklebusta995e9e2007-02-02 15:37:43 -0800350 tk_ops->rpc_release(req);
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400351 return ERR_PTR(-ENOLCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352}
353
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400354static int nlm_do_async_call(struct nlm_rqst *req, u32 proc, struct rpc_message *msg, const struct rpc_call_ops *tk_ops)
355{
356 struct rpc_task *task;
357
358 task = __nlm_async_call(req, proc, msg, tk_ops);
359 if (IS_ERR(task))
360 return PTR_ERR(task);
361 rpc_put_task(task);
362 return 0;
363}
364
365/*
366 * NLM asynchronous call.
367 */
Trond Myklebustd4716622006-03-20 13:44:45 -0500368int nlm_async_call(struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops)
369{
370 struct rpc_message msg = {
371 .rpc_argp = &req->a_args,
372 .rpc_resp = &req->a_res,
373 };
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400374 return nlm_do_async_call(req, proc, &msg, tk_ops);
Trond Myklebustd4716622006-03-20 13:44:45 -0500375}
376
377int nlm_async_reply(struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops)
378{
379 struct rpc_message msg = {
380 .rpc_argp = &req->a_res,
381 };
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400382 return nlm_do_async_call(req, proc, &msg, tk_ops);
383}
384
385/*
386 * NLM client asynchronous call.
387 *
388 * Note that although the calls are asynchronous, and are therefore
389 * guaranteed to complete, we still always attempt to wait for
390 * completion in order to be able to correctly track the lock
391 * state.
392 */
393static int nlmclnt_async_call(struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops)
394{
395 struct rpc_message msg = {
396 .rpc_argp = &req->a_args,
397 .rpc_resp = &req->a_res,
398 };
399 struct rpc_task *task;
400 int err;
401
402 task = __nlm_async_call(req, proc, &msg, tk_ops);
403 if (IS_ERR(task))
404 return PTR_ERR(task);
405 err = rpc_wait_for_completion_task(task);
406 rpc_put_task(task);
407 return err;
Trond Myklebustd4716622006-03-20 13:44:45 -0500408}
409
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410/*
411 * TEST for the presence of a conflicting lock
412 */
413static int
414nlmclnt_test(struct nlm_rqst *req, struct file_lock *fl)
415{
416 int status;
417
418 status = nlmclnt_call(req, NLMPROC_TEST);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 if (status < 0)
Trond Myklebust92737232006-03-20 13:44:45 -0500420 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
Trond Myklebust92737232006-03-20 13:44:45 -0500422 switch (req->a_res.status) {
Al Viroe8c5c042006-12-13 00:35:03 -0800423 case nlm_granted:
Trond Myklebust92737232006-03-20 13:44:45 -0500424 fl->fl_type = F_UNLCK;
425 break;
Al Viroe8c5c042006-12-13 00:35:03 -0800426 case nlm_lck_denied:
Trond Myklebust92737232006-03-20 13:44:45 -0500427 /*
428 * Report the conflicting lock back to the application.
429 */
430 fl->fl_start = req->a_res.lock.fl.fl_start;
431 fl->fl_end = req->a_res.lock.fl.fl_start;
432 fl->fl_type = req->a_res.lock.fl.fl_type;
433 fl->fl_pid = 0;
434 break;
435 default:
436 status = nlm_stat_to_errno(req->a_res.status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 }
Trond Myklebust92737232006-03-20 13:44:45 -0500438out:
439 nlm_release_call(req);
440 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441}
442
443static void nlmclnt_locks_copy_lock(struct file_lock *new, struct file_lock *fl)
444{
Trond Myklebust4c060b52006-03-20 13:44:41 -0500445 new->fl_u.nfs_fl.state = fl->fl_u.nfs_fl.state;
446 new->fl_u.nfs_fl.owner = nlm_get_lockowner(fl->fl_u.nfs_fl.owner);
447 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 -0700448}
449
450static void nlmclnt_locks_release_private(struct file_lock *fl)
451{
Trond Myklebust4c060b52006-03-20 13:44:41 -0500452 list_del(&fl->fl_u.nfs_fl.list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 nlm_put_lockowner(fl->fl_u.nfs_fl.owner);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454}
455
456static struct file_lock_operations nlmclnt_lock_ops = {
457 .fl_copy_lock = nlmclnt_locks_copy_lock,
458 .fl_release_private = nlmclnt_locks_release_private,
459};
460
461static void nlmclnt_locks_init_private(struct file_lock *fl, struct nlm_host *host)
462{
463 BUG_ON(fl->fl_ops != NULL);
464 fl->fl_u.nfs_fl.state = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 fl->fl_u.nfs_fl.owner = nlm_find_lockowner(host, fl->fl_owner);
Trond Myklebust4c060b52006-03-20 13:44:41 -0500466 INIT_LIST_HEAD(&fl->fl_u.nfs_fl.list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 fl->fl_ops = &nlmclnt_lock_ops;
468}
469
Trond Myklebust9b073572006-06-29 16:38:34 -0400470static int do_vfs_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471{
472 int res = 0;
473 switch (fl->fl_flags & (FL_POSIX|FL_FLOCK)) {
474 case FL_POSIX:
475 res = posix_lock_file_wait(fl->fl_file, fl);
476 break;
477 case FL_FLOCK:
478 res = flock_lock_file_wait(fl->fl_file, fl);
479 break;
480 default:
481 BUG();
482 }
Trond Myklebust9b073572006-06-29 16:38:34 -0400483 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484}
485
486/*
487 * LOCK: Try to create a lock
488 *
489 * Programmer Harassment Alert
490 *
491 * When given a blocking lock request in a sync RPC call, the HPUX lockd
492 * will faithfully return LCK_BLOCKED but never cares to notify us when
493 * the lock could be granted. This way, our local process could hang
494 * around forever waiting for the callback.
495 *
496 * Solution A: Implement busy-waiting
497 * Solution B: Use the async version of the call (NLM_LOCK_{MSG,RES})
498 *
499 * For now I am implementing solution A, because I hate the idea of
500 * re-implementing lockd for a third time in two months. The async
501 * calls shouldn't be too hard to do, however.
502 *
503 * This is one of the lovely things about standards in the NFS area:
504 * they're so soft and squishy you can't really blame HP for doing this.
505 */
506static int
507nlmclnt_lock(struct nlm_rqst *req, struct file_lock *fl)
508{
509 struct nlm_host *host = req->a_host;
510 struct nlm_res *resp = &req->a_res;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500511 struct nlm_wait *block = NULL;
Trond Myklebust01c3b862006-06-29 16:38:39 -0400512 unsigned char fl_flags = fl->fl_flags;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500513 int status = -ENOLCK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
Olaf Kirch977faf32006-10-04 02:15:51 -0700515 if (nsm_monitor(host) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 printk(KERN_NOTICE "lockd: failed to monitor %s\n",
517 host->h_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 goto out;
519 }
Trond Myklebust01c3b862006-06-29 16:38:39 -0400520 fl->fl_flags |= FL_ACCESS;
521 status = do_vfs_lock(fl);
Trond Myklebust4a9af592008-04-01 18:57:06 -0400522 fl->fl_flags = fl_flags;
Trond Myklebust01c3b862006-06-29 16:38:39 -0400523 if (status < 0)
524 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
Trond Myklebust3a649b82006-03-20 13:44:44 -0500526 block = nlmclnt_prepare_block(host, fl);
Trond Myklebust28df9552006-06-09 09:40:27 -0400527again:
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 Myklebustecdbf762005-06-22 17:16:31 +0000531 status = nlmclnt_call(req, NLMPROC_LOCK);
532 if (status < 0)
533 goto out_unblock;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500534 if (!req->a_args.block)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000535 break;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000536 /* Did a reclaimer thread notify us of a server reboot? */
Al Viroe8c5c042006-12-13 00:35:03 -0800537 if (resp->status == nlm_lck_denied_grace_period)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000538 continue;
Al Viroe8c5c042006-12-13 00:35:03 -0800539 if (resp->status != nlm_lck_blocked)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000540 break;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500541 /* Wait on an NLM blocking lock */
542 status = nlmclnt_block(block, req, NLMCLNT_POLL_TIMEOUT);
543 /* if we were interrupted. Send a CANCEL request to the server
Trond Myklebustecdbf762005-06-22 17:16:31 +0000544 * and exit
545 */
Trond Myklebust3a649b82006-03-20 13:44:44 -0500546 if (status < 0)
547 goto out_unblock;
Al Viroe8c5c042006-12-13 00:35:03 -0800548 if (resp->status != nlm_lck_blocked)
Trond Myklebust3a649b82006-03-20 13:44:44 -0500549 break;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000550 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551
Al Viroe8c5c042006-12-13 00:35:03 -0800552 if (resp->status == nlm_granted) {
Trond Myklebust28df9552006-06-09 09:40:27 -0400553 down_read(&host->h_rwsem);
554 /* Check whether or not the server has rebooted */
555 if (fl->fl_u.nfs_fl.state != host->h_state) {
556 up_read(&host->h_rwsem);
557 goto again;
558 }
Trond Myklebust4c060b52006-03-20 13:44:41 -0500559 /* Ensure the resulting lock will get added to granted list */
Trond Myklebust4a9af592008-04-01 18:57:06 -0400560 fl->fl_flags |= FL_SLEEP;
Trond Myklebust9b073572006-06-29 16:38:34 -0400561 if (do_vfs_lock(fl) < 0)
562 printk(KERN_WARNING "%s: VFS is out of sync with lock manager!\n", __FUNCTION__);
Trond Myklebust28df9552006-06-09 09:40:27 -0400563 up_read(&host->h_rwsem);
Trond Myklebust4a9af592008-04-01 18:57:06 -0400564 fl->fl_flags = fl_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 }
566 status = nlm_stat_to_errno(resp->status);
Trond Myklebustecdbf762005-06-22 17:16:31 +0000567out_unblock:
Trond Myklebust3a649b82006-03-20 13:44:44 -0500568 nlmclnt_finish_block(block);
Trond Myklebustecdbf762005-06-22 17:16:31 +0000569 /* Cancel the blocked request if it is still pending */
Al Viroe8c5c042006-12-13 00:35:03 -0800570 if (resp->status == nlm_lck_blocked)
Trond Myklebust16fb2422006-02-01 12:18:22 -0500571 nlmclnt_cancel(host, req->a_args.block, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572out:
Trond Myklebust92737232006-03-20 13:44:45 -0500573 nlm_release_call(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 return status;
575}
576
577/*
578 * RECLAIM: Try to reclaim a lock
579 */
580int
581nlmclnt_reclaim(struct nlm_host *host, struct file_lock *fl)
582{
583 struct nlm_rqst reqst, *req;
584 int status;
585
586 req = &reqst;
587 memset(req, 0, sizeof(*req));
588 locks_init_lock(&req->a_args.lock.fl);
589 locks_init_lock(&req->a_res.lock.fl);
590 req->a_host = host;
591 req->a_flags = 0;
592
593 /* Set up the argument struct */
594 nlmclnt_setlockargs(req, fl);
595 req->a_args.reclaim = 1;
596
597 if ((status = nlmclnt_call(req, NLMPROC_LOCK)) >= 0
Al Viroe8c5c042006-12-13 00:35:03 -0800598 && req->a_res.status == nlm_granted)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 return 0;
600
601 printk(KERN_WARNING "lockd: failed to reclaim lock for pid %d "
602 "(errno %d, status %d)\n", fl->fl_pid,
Al Viroe8c5c042006-12-13 00:35:03 -0800603 status, ntohl(req->a_res.status));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604
605 /*
606 * FIXME: This is a serious failure. We can
607 *
608 * a. Ignore the problem
609 * b. Send the owning process some signal (Linux doesn't have
610 * SIGLOST, though...)
611 * c. Retry the operation
612 *
613 * Until someone comes up with a simple implementation
614 * for b or c, I'll choose option a.
615 */
616
617 return -ENOLCK;
618}
619
620/*
621 * UNLOCK: remove an existing lock
622 */
623static int
624nlmclnt_unlock(struct nlm_rqst *req, struct file_lock *fl)
625{
Trond Myklebust28df9552006-06-09 09:40:27 -0400626 struct nlm_host *host = req->a_host;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 struct nlm_res *resp = &req->a_res;
Trond Myklebust4a9af592008-04-01 18:57:06 -0400628 int status;
629 unsigned char fl_flags = fl->fl_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630
Christoph Hellwig26bcbf92006-03-20 13:44:40 -0500631 /*
Trond Myklebust30f4e202006-03-13 21:20:49 -0800632 * Note: the server is supposed to either grant us the unlock
633 * request, or to deny it with NLM_LCK_DENIED_GRACE_PERIOD. In either
634 * case, we want to unlock.
635 */
Trond Myklebust9b073572006-06-29 16:38:34 -0400636 fl->fl_flags |= FL_EXISTS;
Trond Myklebust28df9552006-06-09 09:40:27 -0400637 down_read(&host->h_rwsem);
Trond Myklebust4a9af592008-04-01 18:57:06 -0400638 status = do_vfs_lock(fl);
639 up_read(&host->h_rwsem);
640 fl->fl_flags = fl_flags;
641 if (status == -ENOENT) {
642 status = 0;
Trond Myklebust9b073572006-06-29 16:38:34 -0400643 goto out;
644 }
Trond Myklebust30f4e202006-03-13 21:20:49 -0800645
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400646 atomic_inc(&req->a_count);
647 status = nlmclnt_async_call(req, NLMPROC_UNLOCK, &nlmclnt_unlock_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 if (status < 0)
Trond Myklebust92737232006-03-20 13:44:45 -0500649 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650
Al Viroe8c5c042006-12-13 00:35:03 -0800651 if (resp->status == nlm_granted)
Trond Myklebust92737232006-03-20 13:44:45 -0500652 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
Al Viroe8c5c042006-12-13 00:35:03 -0800654 if (resp->status != nlm_lck_denied_nolocks)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 printk("lockd: unexpected unlock status: %d\n", resp->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 /* What to do now? I'm out of my depth... */
Trond Myklebust92737232006-03-20 13:44:45 -0500657 status = -ENOLCK;
658out:
659 nlm_release_call(req);
660 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661}
662
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100663static void nlmclnt_unlock_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664{
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100665 struct nlm_rqst *req = data;
Al Viroe8c5c042006-12-13 00:35:03 -0800666 u32 status = ntohl(req->a_res.status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667
668 if (RPC_ASSASSINATED(task))
669 goto die;
670
671 if (task->tk_status < 0) {
672 dprintk("lockd: unlock failed (err = %d)\n", -task->tk_status);
673 goto retry_rebind;
674 }
675 if (status == NLM_LCK_DENIED_GRACE_PERIOD) {
676 rpc_delay(task, NLMCLNT_GRACE_WAIT);
677 goto retry_unlock;
678 }
679 if (status != NLM_LCK_GRANTED)
680 printk(KERN_WARNING "lockd: unexpected unlock status: %d\n", status);
681die:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 return;
683 retry_rebind:
684 nlm_rebind_host(req->a_host);
685 retry_unlock:
686 rpc_restart_call(task);
687}
688
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100689static const struct rpc_call_ops nlmclnt_unlock_ops = {
690 .rpc_call_done = nlmclnt_unlock_callback,
Trond Myklebust92737232006-03-20 13:44:45 -0500691 .rpc_release = nlmclnt_rpc_release,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100692};
693
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694/*
695 * Cancel a blocked lock request.
696 * We always use an async RPC call for this in order not to hang a
697 * process that has been Ctrl-C'ed.
698 */
Trond Myklebust16fb2422006-02-01 12:18:22 -0500699static int nlmclnt_cancel(struct nlm_host *host, int block, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700{
701 struct nlm_rqst *req;
Trond Myklebust6b4b3a72008-04-02 14:40:53 -0400702 int status;
703
704 dprintk("lockd: blocking lock attempt was interrupted by a signal.\n"
705 " Attempting to cancel lock.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706
Trond Myklebust92737232006-03-20 13:44:45 -0500707 req = nlm_alloc_call(nlm_get_host(host));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 if (!req)
709 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 req->a_flags = RPC_TASK_ASYNC;
711
712 nlmclnt_setlockargs(req, fl);
Trond Myklebust16fb2422006-02-01 12:18:22 -0500713 req->a_args.block = block;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
Trond Myklebust6b4b3a72008-04-02 14:40:53 -0400715 atomic_inc(&req->a_count);
716 status = nlmclnt_async_call(req, NLMPROC_CANCEL, &nlmclnt_cancel_ops);
717 if (status == 0 && req->a_res.status == nlm_lck_denied)
718 status = -ENOLCK;
719 nlm_release_call(req);
720 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721}
722
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100723static void nlmclnt_cancel_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724{
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100725 struct nlm_rqst *req = data;
Al Viroe8c5c042006-12-13 00:35:03 -0800726 u32 status = ntohl(req->a_res.status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727
728 if (RPC_ASSASSINATED(task))
729 goto die;
730
731 if (task->tk_status < 0) {
732 dprintk("lockd: CANCEL call error %d, retrying.\n",
733 task->tk_status);
734 goto retry_cancel;
735 }
736
Chuck Leverc041b5f2006-12-05 16:36:03 -0500737 dprintk("lockd: cancel status %u (task %u)\n",
Al Viroe8c5c042006-12-13 00:35:03 -0800738 status, task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739
Al Viroe8c5c042006-12-13 00:35:03 -0800740 switch (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 case NLM_LCK_GRANTED:
742 case NLM_LCK_DENIED_GRACE_PERIOD:
Trond Myklebust35576cb2006-03-20 13:44:41 -0500743 case NLM_LCK_DENIED:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 /* Everything's good */
745 break;
746 case NLM_LCK_DENIED_NOLOCKS:
747 dprintk("lockd: CANCEL failed (server has no locks)\n");
748 goto retry_cancel;
749 default:
750 printk(KERN_NOTICE "lockd: weird return %d for CANCEL call\n",
Al Viroe8c5c042006-12-13 00:35:03 -0800751 status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 }
753
754die:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 return;
756
757retry_cancel:
Trond Myklebustaaaa9942006-02-01 12:18:25 -0500758 /* Don't ever retry more than 3 times */
759 if (req->a_retries++ >= NLMCLNT_MAX_RETRIES)
760 goto die;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 nlm_rebind_host(req->a_host);
762 rpc_restart_call(task);
763 rpc_delay(task, 30 * HZ);
764}
765
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100766static const struct rpc_call_ops nlmclnt_cancel_ops = {
767 .rpc_call_done = nlmclnt_cancel_callback,
Trond Myklebust92737232006-03-20 13:44:45 -0500768 .rpc_release = nlmclnt_rpc_release,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100769};
770
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771/*
772 * Convert an NLM status code to a generic kernel errno
773 */
774static int
Al Viroe8c5c042006-12-13 00:35:03 -0800775nlm_stat_to_errno(__be32 status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776{
Al Viroe8c5c042006-12-13 00:35:03 -0800777 switch(ntohl(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 case NLM_LCK_GRANTED:
779 return 0;
780 case NLM_LCK_DENIED:
781 return -EAGAIN;
782 case NLM_LCK_DENIED_NOLOCKS:
783 case NLM_LCK_DENIED_GRACE_PERIOD:
784 return -ENOLCK;
785 case NLM_LCK_BLOCKED:
786 printk(KERN_NOTICE "lockd: unexpected status NLM_BLOCKED\n");
787 return -ENOLCK;
788#ifdef CONFIG_LOCKD_V4
789 case NLM_DEADLCK:
790 return -EDEADLK;
791 case NLM_ROFS:
792 return -EROFS;
793 case NLM_STALE_FH:
794 return -ESTALE;
795 case NLM_FBIG:
796 return -EOVERFLOW;
797 case NLM_FAILED:
798 return -ENOLCK;
799#endif
800 }
801 printk(KERN_NOTICE "lockd: unexpected server status %d\n", status);
802 return -ENOLCK;
803}