blob: a34b709006a12b8c14bf47422fe18b2e6d97d89e [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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 sigset_t oldset;
159 unsigned long flags;
Chuck Lever1093a602008-01-11 17:09:59 -0500160 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
Chuck Lever1093a602008-01-11 17:09:59 -0500162 nlm_get_host(host);
Trond Myklebust92737232006-03-20 13:44:45 -0500163 call = nlm_alloc_call(host);
164 if (call == NULL)
165 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
Trond Myklebust92737232006-03-20 13:44:45 -0500167 nlmclnt_locks_init_private(fl, host);
168 /* Set up the argument struct */
169 nlmclnt_setlockargs(call, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
171 /* Keep the old signal mask */
172 spin_lock_irqsave(&current->sighand->siglock, flags);
173 oldset = current->blocked;
174
175 /* If we're cleaning up locks because the process is exiting,
176 * perform the RPC call asynchronously. */
177 if ((IS_SETLK(cmd) || IS_SETLKW(cmd))
178 && fl->fl_type == F_UNLCK
179 && (current->flags & PF_EXITING)) {
180 sigfillset(&current->blocked); /* Mask all signals */
181 recalc_sigpending();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 call->a_flags = RPC_TASK_ASYNC;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 }
Trond Myklebust92737232006-03-20 13:44:45 -0500185 spin_unlock_irqrestore(&current->sighand->siglock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
187 if (IS_SETLK(cmd) || IS_SETLKW(cmd)) {
188 if (fl->fl_type != F_UNLCK) {
189 call->a_args.block = IS_SETLKW(cmd) ? 1 : 0;
190 status = nlmclnt_lock(call, fl);
191 } else
192 status = nlmclnt_unlock(call, fl);
193 } else if (IS_GETLK(cmd))
194 status = nlmclnt_test(call, fl);
195 else
196 status = -EINVAL;
197
Trond Myklebust92737232006-03-20 13:44:45 -0500198 fl->fl_ops->fl_release_private(fl);
199 fl->fl_ops = NULL;
200
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 spin_lock_irqsave(&current->sighand->siglock, flags);
202 current->blocked = oldset;
203 recalc_sigpending();
204 spin_unlock_irqrestore(&current->sighand->siglock, flags);
205
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 dprintk("lockd: clnt proc returns %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 return status;
208}
Chuck Lever1093a602008-01-11 17:09:59 -0500209EXPORT_SYMBOL_GPL(nlmclnt_proc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210
211/*
212 * Allocate an NLM RPC call struct
Trond Myklebust92737232006-03-20 13:44:45 -0500213 *
214 * Note: the caller must hold a reference to host. In case of failure,
215 * this reference will be released.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 */
Trond Myklebust92737232006-03-20 13:44:45 -0500217struct nlm_rqst *nlm_alloc_call(struct nlm_host *host)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218{
219 struct nlm_rqst *call;
220
Trond Myklebust36943fa2006-03-20 13:44:05 -0500221 for(;;) {
222 call = kzalloc(sizeof(*call), GFP_KERNEL);
223 if (call != NULL) {
Trond Myklebust5e7f37a2008-04-01 18:58:49 -0400224 atomic_set(&call->a_count, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 locks_init_lock(&call->a_args.lock.fl);
226 locks_init_lock(&call->a_res.lock.fl);
Trond Myklebust92737232006-03-20 13:44:45 -0500227 call->a_host = host;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 return call;
229 }
Trond Myklebust36943fa2006-03-20 13:44:05 -0500230 if (signalled())
231 break;
Trond Myklebust92737232006-03-20 13:44:45 -0500232 printk("nlm_alloc_call: failed, waiting for memory\n");
Nishanth Aravamudan041e0e32005-09-10 00:27:23 -0700233 schedule_timeout_interruptible(5*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 }
Trond Myklebust92737232006-03-20 13:44:45 -0500235 nlm_release_host(host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 return NULL;
237}
238
Trond Myklebust92737232006-03-20 13:44:45 -0500239void nlm_release_call(struct nlm_rqst *call)
240{
Trond Myklebust5e7f37a2008-04-01 18:58:49 -0400241 if (!atomic_dec_and_test(&call->a_count))
242 return;
Trond Myklebust92737232006-03-20 13:44:45 -0500243 nlm_release_host(call->a_host);
244 nlmclnt_release_lockargs(call);
245 kfree(call);
246}
247
248static void nlmclnt_rpc_release(void *data)
249{
Trond Myklebust65fdf7d2008-01-11 17:41:29 -0500250 nlm_release_call(data);
Trond Myklebust92737232006-03-20 13:44:45 -0500251}
252
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253static int nlm_wait_on_grace(wait_queue_head_t *queue)
254{
255 DEFINE_WAIT(wait);
256 int status = -EINTR;
257
258 prepare_to_wait(queue, &wait, TASK_INTERRUPTIBLE);
259 if (!signalled ()) {
260 schedule_timeout(NLMCLNT_GRACE_WAIT);
Christoph Lameter3e1d1d22005-06-24 23:13:50 -0700261 try_to_freeze();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 if (!signalled ())
263 status = 0;
264 }
265 finish_wait(queue, &wait);
266 return status;
267}
268
269/*
270 * Generic NLM call
271 */
272static int
273nlmclnt_call(struct nlm_rqst *req, u32 proc)
274{
275 struct nlm_host *host = req->a_host;
276 struct rpc_clnt *clnt;
277 struct nlm_args *argp = &req->a_args;
278 struct nlm_res *resp = &req->a_res;
279 struct rpc_message msg = {
280 .rpc_argp = argp,
281 .rpc_resp = resp,
282 };
283 int status;
284
285 dprintk("lockd: call procedure %d on %s\n",
286 (int)proc, host->h_name);
287
288 do {
289 if (host->h_reclaiming && !argp->reclaim)
290 goto in_grace_period;
291
292 /* If we have no RPC client yet, create one. */
293 if ((clnt = nlm_bind_host(host)) == NULL)
294 return -ENOLCK;
295 msg.rpc_proc = &clnt->cl_procinfo[proc];
296
297 /* Perform the RPC call. If an error occurs, try again */
298 if ((status = rpc_call_sync(clnt, &msg, 0)) < 0) {
299 dprintk("lockd: rpc_call returned error %d\n", -status);
300 switch (status) {
301 case -EPROTONOSUPPORT:
302 status = -EINVAL;
303 break;
304 case -ECONNREFUSED:
305 case -ETIMEDOUT:
306 case -ENOTCONN:
307 nlm_rebind_host(host);
308 status = -EAGAIN;
309 break;
310 case -ERESTARTSYS:
311 return signalled () ? -EINTR : status;
312 default:
313 break;
314 }
315 break;
316 } else
Al Viroe8c5c042006-12-13 00:35:03 -0800317 if (resp->status == nlm_lck_denied_grace_period) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 dprintk("lockd: server in grace period\n");
319 if (argp->reclaim) {
320 printk(KERN_WARNING
321 "lockd: spurious grace period reject?!\n");
322 return -ENOLCK;
323 }
324 } else {
325 if (!argp->reclaim) {
326 /* We appear to be out of the grace period */
327 wake_up_all(&host->h_gracewait);
328 }
329 dprintk("lockd: server returns status %d\n", resp->status);
330 return 0; /* Okay, call complete */
331 }
332
333in_grace_period:
334 /*
335 * The server has rebooted and appears to be in the grace
336 * period during which locks are only allowed to be
337 * reclaimed.
338 * We can only back off and try again later.
339 */
340 status = nlm_wait_on_grace(&host->h_gracewait);
341 } while (status == 0);
342
343 return status;
344}
345
346/*
347 * Generic NLM call, async version.
348 */
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400349static 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 -0700350{
351 struct nlm_host *host = req->a_host;
352 struct rpc_clnt *clnt;
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400353 struct rpc_task_setup task_setup_data = {
354 .rpc_message = msg,
355 .callback_ops = tk_ops,
356 .callback_data = req,
357 .flags = RPC_TASK_ASYNC,
358 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359
360 dprintk("lockd: call procedure %d on %s (async)\n",
361 (int)proc, host->h_name);
362
363 /* If we have no RPC client yet, create one. */
Trond Myklebust92737232006-03-20 13:44:45 -0500364 clnt = nlm_bind_host(host);
365 if (clnt == NULL)
366 goto out_err;
Trond Myklebustd4716622006-03-20 13:44:45 -0500367 msg->rpc_proc = &clnt->cl_procinfo[proc];
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400368 task_setup_data.rpc_client = clnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369
370 /* bootstrap and kick off the async RPC call */
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400371 return rpc_run_task(&task_setup_data);
Trond Myklebust92737232006-03-20 13:44:45 -0500372out_err:
Trond Myklebusta995e9e2007-02-02 15:37:43 -0800373 tk_ops->rpc_release(req);
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400374 return ERR_PTR(-ENOLCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375}
376
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400377static int nlm_do_async_call(struct nlm_rqst *req, u32 proc, struct rpc_message *msg, const struct rpc_call_ops *tk_ops)
378{
379 struct rpc_task *task;
380
381 task = __nlm_async_call(req, proc, msg, tk_ops);
382 if (IS_ERR(task))
383 return PTR_ERR(task);
384 rpc_put_task(task);
385 return 0;
386}
387
388/*
389 * NLM asynchronous call.
390 */
Trond Myklebustd4716622006-03-20 13:44:45 -0500391int nlm_async_call(struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops)
392{
393 struct rpc_message msg = {
394 .rpc_argp = &req->a_args,
395 .rpc_resp = &req->a_res,
396 };
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400397 return nlm_do_async_call(req, proc, &msg, tk_ops);
Trond Myklebustd4716622006-03-20 13:44:45 -0500398}
399
400int nlm_async_reply(struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops)
401{
402 struct rpc_message msg = {
403 .rpc_argp = &req->a_res,
404 };
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400405 return nlm_do_async_call(req, proc, &msg, tk_ops);
406}
407
408/*
409 * NLM client asynchronous call.
410 *
411 * Note that although the calls are asynchronous, and are therefore
412 * guaranteed to complete, we still always attempt to wait for
413 * completion in order to be able to correctly track the lock
414 * state.
415 */
416static int nlmclnt_async_call(struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops)
417{
418 struct rpc_message msg = {
419 .rpc_argp = &req->a_args,
420 .rpc_resp = &req->a_res,
421 };
422 struct rpc_task *task;
423 int err;
424
425 task = __nlm_async_call(req, proc, &msg, tk_ops);
426 if (IS_ERR(task))
427 return PTR_ERR(task);
428 err = rpc_wait_for_completion_task(task);
429 rpc_put_task(task);
430 return err;
Trond Myklebustd4716622006-03-20 13:44:45 -0500431}
432
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433/*
434 * TEST for the presence of a conflicting lock
435 */
436static int
437nlmclnt_test(struct nlm_rqst *req, struct file_lock *fl)
438{
439 int status;
440
441 status = nlmclnt_call(req, NLMPROC_TEST);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 if (status < 0)
Trond Myklebust92737232006-03-20 13:44:45 -0500443 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444
Trond Myklebust92737232006-03-20 13:44:45 -0500445 switch (req->a_res.status) {
Al Viroe8c5c042006-12-13 00:35:03 -0800446 case nlm_granted:
Trond Myklebust92737232006-03-20 13:44:45 -0500447 fl->fl_type = F_UNLCK;
448 break;
Al Viroe8c5c042006-12-13 00:35:03 -0800449 case nlm_lck_denied:
Trond Myklebust92737232006-03-20 13:44:45 -0500450 /*
451 * Report the conflicting lock back to the application.
452 */
453 fl->fl_start = req->a_res.lock.fl.fl_start;
454 fl->fl_end = req->a_res.lock.fl.fl_start;
455 fl->fl_type = req->a_res.lock.fl.fl_type;
456 fl->fl_pid = 0;
457 break;
458 default:
459 status = nlm_stat_to_errno(req->a_res.status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 }
Trond Myklebust92737232006-03-20 13:44:45 -0500461out:
462 nlm_release_call(req);
463 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464}
465
466static void nlmclnt_locks_copy_lock(struct file_lock *new, struct file_lock *fl)
467{
Trond Myklebust4c060b52006-03-20 13:44:41 -0500468 new->fl_u.nfs_fl.state = fl->fl_u.nfs_fl.state;
469 new->fl_u.nfs_fl.owner = nlm_get_lockowner(fl->fl_u.nfs_fl.owner);
470 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 -0700471}
472
473static void nlmclnt_locks_release_private(struct file_lock *fl)
474{
Trond Myklebust4c060b52006-03-20 13:44:41 -0500475 list_del(&fl->fl_u.nfs_fl.list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 nlm_put_lockowner(fl->fl_u.nfs_fl.owner);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477}
478
479static struct file_lock_operations nlmclnt_lock_ops = {
480 .fl_copy_lock = nlmclnt_locks_copy_lock,
481 .fl_release_private = nlmclnt_locks_release_private,
482};
483
484static void nlmclnt_locks_init_private(struct file_lock *fl, struct nlm_host *host)
485{
486 BUG_ON(fl->fl_ops != NULL);
487 fl->fl_u.nfs_fl.state = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 fl->fl_u.nfs_fl.owner = nlm_find_lockowner(host, fl->fl_owner);
Trond Myklebust4c060b52006-03-20 13:44:41 -0500489 INIT_LIST_HEAD(&fl->fl_u.nfs_fl.list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 fl->fl_ops = &nlmclnt_lock_ops;
491}
492
Trond Myklebust9b073572006-06-29 16:38:34 -0400493static int do_vfs_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494{
495 int res = 0;
496 switch (fl->fl_flags & (FL_POSIX|FL_FLOCK)) {
497 case FL_POSIX:
498 res = posix_lock_file_wait(fl->fl_file, fl);
499 break;
500 case FL_FLOCK:
501 res = flock_lock_file_wait(fl->fl_file, fl);
502 break;
503 default:
504 BUG();
505 }
Trond Myklebust9b073572006-06-29 16:38:34 -0400506 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507}
508
509/*
510 * LOCK: Try to create a lock
511 *
512 * Programmer Harassment Alert
513 *
514 * When given a blocking lock request in a sync RPC call, the HPUX lockd
515 * will faithfully return LCK_BLOCKED but never cares to notify us when
516 * the lock could be granted. This way, our local process could hang
517 * around forever waiting for the callback.
518 *
519 * Solution A: Implement busy-waiting
520 * Solution B: Use the async version of the call (NLM_LOCK_{MSG,RES})
521 *
522 * For now I am implementing solution A, because I hate the idea of
523 * re-implementing lockd for a third time in two months. The async
524 * calls shouldn't be too hard to do, however.
525 *
526 * This is one of the lovely things about standards in the NFS area:
527 * they're so soft and squishy you can't really blame HP for doing this.
528 */
529static int
530nlmclnt_lock(struct nlm_rqst *req, struct file_lock *fl)
531{
532 struct nlm_host *host = req->a_host;
533 struct nlm_res *resp = &req->a_res;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500534 struct nlm_wait *block = NULL;
Trond Myklebust01c3b862006-06-29 16:38:39 -0400535 unsigned char fl_flags = fl->fl_flags;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500536 int status = -ENOLCK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537
Olaf Kirch977faf32006-10-04 02:15:51 -0700538 if (nsm_monitor(host) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 printk(KERN_NOTICE "lockd: failed to monitor %s\n",
540 host->h_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 goto out;
542 }
Trond Myklebust01c3b862006-06-29 16:38:39 -0400543 fl->fl_flags |= FL_ACCESS;
544 status = do_vfs_lock(fl);
Trond Myklebust4a9af592008-04-01 18:57:06 -0400545 fl->fl_flags = fl_flags;
Trond Myklebust01c3b862006-06-29 16:38:39 -0400546 if (status < 0)
547 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548
Trond Myklebust3a649b82006-03-20 13:44:44 -0500549 block = nlmclnt_prepare_block(host, fl);
Trond Myklebust28df9552006-06-09 09:40:27 -0400550again:
Trond Myklebustecdbf762005-06-22 17:16:31 +0000551 for(;;) {
Trond Myklebust28df9552006-06-09 09:40:27 -0400552 /* Reboot protection */
553 fl->fl_u.nfs_fl.state = host->h_state;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000554 status = nlmclnt_call(req, NLMPROC_LOCK);
555 if (status < 0)
556 goto out_unblock;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500557 if (!req->a_args.block)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000558 break;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000559 /* Did a reclaimer thread notify us of a server reboot? */
Al Viroe8c5c042006-12-13 00:35:03 -0800560 if (resp->status == nlm_lck_denied_grace_period)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000561 continue;
Al Viroe8c5c042006-12-13 00:35:03 -0800562 if (resp->status != nlm_lck_blocked)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000563 break;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500564 /* Wait on an NLM blocking lock */
565 status = nlmclnt_block(block, req, NLMCLNT_POLL_TIMEOUT);
566 /* if we were interrupted. Send a CANCEL request to the server
Trond Myklebustecdbf762005-06-22 17:16:31 +0000567 * and exit
568 */
Trond Myklebust3a649b82006-03-20 13:44:44 -0500569 if (status < 0)
570 goto out_unblock;
Al Viroe8c5c042006-12-13 00:35:03 -0800571 if (resp->status != nlm_lck_blocked)
Trond Myklebust3a649b82006-03-20 13:44:44 -0500572 break;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000573 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574
Al Viroe8c5c042006-12-13 00:35:03 -0800575 if (resp->status == nlm_granted) {
Trond Myklebust28df9552006-06-09 09:40:27 -0400576 down_read(&host->h_rwsem);
577 /* Check whether or not the server has rebooted */
578 if (fl->fl_u.nfs_fl.state != host->h_state) {
579 up_read(&host->h_rwsem);
580 goto again;
581 }
Trond Myklebust4c060b52006-03-20 13:44:41 -0500582 /* Ensure the resulting lock will get added to granted list */
Trond Myklebust4a9af592008-04-01 18:57:06 -0400583 fl->fl_flags |= FL_SLEEP;
Trond Myklebust9b073572006-06-29 16:38:34 -0400584 if (do_vfs_lock(fl) < 0)
585 printk(KERN_WARNING "%s: VFS is out of sync with lock manager!\n", __FUNCTION__);
Trond Myklebust28df9552006-06-09 09:40:27 -0400586 up_read(&host->h_rwsem);
Trond Myklebust4a9af592008-04-01 18:57:06 -0400587 fl->fl_flags = fl_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 }
589 status = nlm_stat_to_errno(resp->status);
Trond Myklebustecdbf762005-06-22 17:16:31 +0000590out_unblock:
Trond Myklebust3a649b82006-03-20 13:44:44 -0500591 nlmclnt_finish_block(block);
Trond Myklebustecdbf762005-06-22 17:16:31 +0000592 /* Cancel the blocked request if it is still pending */
Al Viroe8c5c042006-12-13 00:35:03 -0800593 if (resp->status == nlm_lck_blocked)
Trond Myklebust16fb2422006-02-01 12:18:22 -0500594 nlmclnt_cancel(host, req->a_args.block, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595out:
Trond Myklebust92737232006-03-20 13:44:45 -0500596 nlm_release_call(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 return status;
598}
599
600/*
601 * RECLAIM: Try to reclaim a lock
602 */
603int
604nlmclnt_reclaim(struct nlm_host *host, struct file_lock *fl)
605{
606 struct nlm_rqst reqst, *req;
607 int status;
608
609 req = &reqst;
610 memset(req, 0, sizeof(*req));
611 locks_init_lock(&req->a_args.lock.fl);
612 locks_init_lock(&req->a_res.lock.fl);
613 req->a_host = host;
614 req->a_flags = 0;
615
616 /* Set up the argument struct */
617 nlmclnt_setlockargs(req, fl);
618 req->a_args.reclaim = 1;
619
620 if ((status = nlmclnt_call(req, NLMPROC_LOCK)) >= 0
Al Viroe8c5c042006-12-13 00:35:03 -0800621 && req->a_res.status == nlm_granted)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 return 0;
623
624 printk(KERN_WARNING "lockd: failed to reclaim lock for pid %d "
625 "(errno %d, status %d)\n", fl->fl_pid,
Al Viroe8c5c042006-12-13 00:35:03 -0800626 status, ntohl(req->a_res.status));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627
628 /*
629 * FIXME: This is a serious failure. We can
630 *
631 * a. Ignore the problem
632 * b. Send the owning process some signal (Linux doesn't have
633 * SIGLOST, though...)
634 * c. Retry the operation
635 *
636 * Until someone comes up with a simple implementation
637 * for b or c, I'll choose option a.
638 */
639
640 return -ENOLCK;
641}
642
643/*
644 * UNLOCK: remove an existing lock
645 */
646static int
647nlmclnt_unlock(struct nlm_rqst *req, struct file_lock *fl)
648{
Trond Myklebust28df9552006-06-09 09:40:27 -0400649 struct nlm_host *host = req->a_host;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 struct nlm_res *resp = &req->a_res;
Trond Myklebust4a9af592008-04-01 18:57:06 -0400651 int status;
652 unsigned char fl_flags = fl->fl_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
Christoph Hellwig26bcbf92006-03-20 13:44:40 -0500654 /*
Trond Myklebust30f4e202006-03-13 21:20:49 -0800655 * Note: the server is supposed to either grant us the unlock
656 * request, or to deny it with NLM_LCK_DENIED_GRACE_PERIOD. In either
657 * case, we want to unlock.
658 */
Trond Myklebust9b073572006-06-29 16:38:34 -0400659 fl->fl_flags |= FL_EXISTS;
Trond Myklebust28df9552006-06-09 09:40:27 -0400660 down_read(&host->h_rwsem);
Trond Myklebust4a9af592008-04-01 18:57:06 -0400661 status = do_vfs_lock(fl);
662 up_read(&host->h_rwsem);
663 fl->fl_flags = fl_flags;
664 if (status == -ENOENT) {
665 status = 0;
Trond Myklebust9b073572006-06-29 16:38:34 -0400666 goto out;
667 }
Trond Myklebust30f4e202006-03-13 21:20:49 -0800668
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400669 atomic_inc(&req->a_count);
670 status = nlmclnt_async_call(req, NLMPROC_UNLOCK, &nlmclnt_unlock_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 if (status < 0)
Trond Myklebust92737232006-03-20 13:44:45 -0500672 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673
Al Viroe8c5c042006-12-13 00:35:03 -0800674 if (resp->status == nlm_granted)
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_lck_denied_nolocks)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 printk("lockd: unexpected unlock status: %d\n", resp->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 /* What to do now? I'm out of my depth... */
Trond Myklebust92737232006-03-20 13:44:45 -0500680 status = -ENOLCK;
681out:
682 nlm_release_call(req);
683 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684}
685
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100686static void nlmclnt_unlock_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687{
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100688 struct nlm_rqst *req = data;
Al Viroe8c5c042006-12-13 00:35:03 -0800689 u32 status = ntohl(req->a_res.status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690
691 if (RPC_ASSASSINATED(task))
692 goto die;
693
694 if (task->tk_status < 0) {
695 dprintk("lockd: unlock failed (err = %d)\n", -task->tk_status);
696 goto retry_rebind;
697 }
698 if (status == NLM_LCK_DENIED_GRACE_PERIOD) {
699 rpc_delay(task, NLMCLNT_GRACE_WAIT);
700 goto retry_unlock;
701 }
702 if (status != NLM_LCK_GRANTED)
703 printk(KERN_WARNING "lockd: unexpected unlock status: %d\n", status);
704die:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 return;
706 retry_rebind:
707 nlm_rebind_host(req->a_host);
708 retry_unlock:
709 rpc_restart_call(task);
710}
711
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100712static const struct rpc_call_ops nlmclnt_unlock_ops = {
713 .rpc_call_done = nlmclnt_unlock_callback,
Trond Myklebust92737232006-03-20 13:44:45 -0500714 .rpc_release = nlmclnt_rpc_release,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100715};
716
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717/*
718 * Cancel a blocked lock request.
719 * We always use an async RPC call for this in order not to hang a
720 * process that has been Ctrl-C'ed.
721 */
Trond Myklebust16fb2422006-02-01 12:18:22 -0500722static int nlmclnt_cancel(struct nlm_host *host, int block, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723{
724 struct nlm_rqst *req;
725 unsigned long flags;
726 sigset_t oldset;
727 int status;
728
729 /* Block all signals while setting up call */
730 spin_lock_irqsave(&current->sighand->siglock, flags);
731 oldset = current->blocked;
732 sigfillset(&current->blocked);
733 recalc_sigpending();
734 spin_unlock_irqrestore(&current->sighand->siglock, flags);
735
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 Myklebustdc9d8d02008-03-28 16:04:36 -0400744 status = nlmclnt_async_call(req, NLMPROC_CANCEL, &nlmclnt_cancel_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745
746 spin_lock_irqsave(&current->sighand->siglock, flags);
747 current->blocked = oldset;
748 recalc_sigpending();
749 spin_unlock_irqrestore(&current->sighand->siglock, flags);
750
751 return status;
752}
753
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100754static void nlmclnt_cancel_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755{
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100756 struct nlm_rqst *req = data;
Al Viroe8c5c042006-12-13 00:35:03 -0800757 u32 status = ntohl(req->a_res.status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758
759 if (RPC_ASSASSINATED(task))
760 goto die;
761
762 if (task->tk_status < 0) {
763 dprintk("lockd: CANCEL call error %d, retrying.\n",
764 task->tk_status);
765 goto retry_cancel;
766 }
767
Chuck Leverc041b5f2006-12-05 16:36:03 -0500768 dprintk("lockd: cancel status %u (task %u)\n",
Al Viroe8c5c042006-12-13 00:35:03 -0800769 status, task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770
Al Viroe8c5c042006-12-13 00:35:03 -0800771 switch (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 case NLM_LCK_GRANTED:
773 case NLM_LCK_DENIED_GRACE_PERIOD:
Trond Myklebust35576cb2006-03-20 13:44:41 -0500774 case NLM_LCK_DENIED:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 /* Everything's good */
776 break;
777 case NLM_LCK_DENIED_NOLOCKS:
778 dprintk("lockd: CANCEL failed (server has no locks)\n");
779 goto retry_cancel;
780 default:
781 printk(KERN_NOTICE "lockd: weird return %d for CANCEL call\n",
Al Viroe8c5c042006-12-13 00:35:03 -0800782 status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 }
784
785die:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 return;
787
788retry_cancel:
Trond Myklebustaaaa9942006-02-01 12:18:25 -0500789 /* Don't ever retry more than 3 times */
790 if (req->a_retries++ >= NLMCLNT_MAX_RETRIES)
791 goto die;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 nlm_rebind_host(req->a_host);
793 rpc_restart_call(task);
794 rpc_delay(task, 30 * HZ);
795}
796
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100797static const struct rpc_call_ops nlmclnt_cancel_ops = {
798 .rpc_call_done = nlmclnt_cancel_callback,
Trond Myklebust92737232006-03-20 13:44:45 -0500799 .rpc_release = nlmclnt_rpc_release,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100800};
801
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802/*
803 * Convert an NLM status code to a generic kernel errno
804 */
805static int
Al Viroe8c5c042006-12-13 00:35:03 -0800806nlm_stat_to_errno(__be32 status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807{
Al Viroe8c5c042006-12-13 00:35:03 -0800808 switch(ntohl(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 case NLM_LCK_GRANTED:
810 return 0;
811 case NLM_LCK_DENIED:
812 return -EAGAIN;
813 case NLM_LCK_DENIED_NOLOCKS:
814 case NLM_LCK_DENIED_GRACE_PERIOD:
815 return -ENOLCK;
816 case NLM_LCK_BLOCKED:
817 printk(KERN_NOTICE "lockd: unexpected status NLM_BLOCKED\n");
818 return -ENOLCK;
819#ifdef CONFIG_LOCKD_V4
820 case NLM_DEADLCK:
821 return -EDEADLK;
822 case NLM_ROFS:
823 return -EROFS;
824 case NLM_STALE_FH:
825 return -ESTALE;
826 case NLM_FBIG:
827 return -EOVERFLOW;
828 case NLM_FAILED:
829 return -ENOLCK;
830#endif
831 }
832 printk(KERN_NOTICE "lockd: unexpected server status %d\n", status);
833 return -ENOLCK;
834}