blob: b6b74a60e1ebb8cb18cfb4935e23c5ba9a6bfc02 [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) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 locks_init_lock(&call->a_args.lock.fl);
225 locks_init_lock(&call->a_res.lock.fl);
Trond Myklebust92737232006-03-20 13:44:45 -0500226 call->a_host = host;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 return call;
228 }
Trond Myklebust36943fa2006-03-20 13:44:05 -0500229 if (signalled())
230 break;
Trond Myklebust92737232006-03-20 13:44:45 -0500231 printk("nlm_alloc_call: failed, waiting for memory\n");
Nishanth Aravamudan041e0e32005-09-10 00:27:23 -0700232 schedule_timeout_interruptible(5*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 }
Trond Myklebust92737232006-03-20 13:44:45 -0500234 nlm_release_host(host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 return NULL;
236}
237
Trond Myklebust92737232006-03-20 13:44:45 -0500238void nlm_release_call(struct nlm_rqst *call)
239{
240 nlm_release_host(call->a_host);
241 nlmclnt_release_lockargs(call);
242 kfree(call);
243}
244
245static void nlmclnt_rpc_release(void *data)
246{
Trond Myklebust65fdf7d2008-01-11 17:41:29 -0500247 nlm_release_call(data);
Trond Myklebust92737232006-03-20 13:44:45 -0500248}
249
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250static int nlm_wait_on_grace(wait_queue_head_t *queue)
251{
252 DEFINE_WAIT(wait);
253 int status = -EINTR;
254
255 prepare_to_wait(queue, &wait, TASK_INTERRUPTIBLE);
256 if (!signalled ()) {
257 schedule_timeout(NLMCLNT_GRACE_WAIT);
Christoph Lameter3e1d1d22005-06-24 23:13:50 -0700258 try_to_freeze();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 if (!signalled ())
260 status = 0;
261 }
262 finish_wait(queue, &wait);
263 return status;
264}
265
266/*
267 * Generic NLM call
268 */
269static int
270nlmclnt_call(struct nlm_rqst *req, u32 proc)
271{
272 struct nlm_host *host = req->a_host;
273 struct rpc_clnt *clnt;
274 struct nlm_args *argp = &req->a_args;
275 struct nlm_res *resp = &req->a_res;
276 struct rpc_message msg = {
277 .rpc_argp = argp,
278 .rpc_resp = resp,
279 };
280 int status;
281
282 dprintk("lockd: call procedure %d on %s\n",
283 (int)proc, host->h_name);
284
285 do {
286 if (host->h_reclaiming && !argp->reclaim)
287 goto in_grace_period;
288
289 /* If we have no RPC client yet, create one. */
290 if ((clnt = nlm_bind_host(host)) == NULL)
291 return -ENOLCK;
292 msg.rpc_proc = &clnt->cl_procinfo[proc];
293
294 /* Perform the RPC call. If an error occurs, try again */
295 if ((status = rpc_call_sync(clnt, &msg, 0)) < 0) {
296 dprintk("lockd: rpc_call returned error %d\n", -status);
297 switch (status) {
298 case -EPROTONOSUPPORT:
299 status = -EINVAL;
300 break;
301 case -ECONNREFUSED:
302 case -ETIMEDOUT:
303 case -ENOTCONN:
304 nlm_rebind_host(host);
305 status = -EAGAIN;
306 break;
307 case -ERESTARTSYS:
308 return signalled () ? -EINTR : status;
309 default:
310 break;
311 }
312 break;
313 } else
Al Viroe8c5c042006-12-13 00:35:03 -0800314 if (resp->status == nlm_lck_denied_grace_period) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 dprintk("lockd: server in grace period\n");
316 if (argp->reclaim) {
317 printk(KERN_WARNING
318 "lockd: spurious grace period reject?!\n");
319 return -ENOLCK;
320 }
321 } else {
322 if (!argp->reclaim) {
323 /* We appear to be out of the grace period */
324 wake_up_all(&host->h_gracewait);
325 }
326 dprintk("lockd: server returns status %d\n", resp->status);
327 return 0; /* Okay, call complete */
328 }
329
330in_grace_period:
331 /*
332 * The server has rebooted and appears to be in the grace
333 * period during which locks are only allowed to be
334 * reclaimed.
335 * We can only back off and try again later.
336 */
337 status = nlm_wait_on_grace(&host->h_gracewait);
338 } while (status == 0);
339
340 return status;
341}
342
343/*
344 * Generic NLM call, async version.
345 */
Trond Myklebustd4716622006-03-20 13:44:45 -0500346static int __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 -0700347{
348 struct nlm_host *host = req->a_host;
349 struct rpc_clnt *clnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350
351 dprintk("lockd: call procedure %d on %s (async)\n",
352 (int)proc, host->h_name);
353
354 /* If we have no RPC client yet, create one. */
Trond Myklebust92737232006-03-20 13:44:45 -0500355 clnt = nlm_bind_host(host);
356 if (clnt == NULL)
357 goto out_err;
Trond Myklebustd4716622006-03-20 13:44:45 -0500358 msg->rpc_proc = &clnt->cl_procinfo[proc];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359
360 /* bootstrap and kick off the async RPC call */
Trond Myklebusta995e9e2007-02-02 15:37:43 -0800361 return rpc_call_async(clnt, msg, RPC_TASK_ASYNC, tk_ops, req);
Trond Myklebust92737232006-03-20 13:44:45 -0500362out_err:
Trond Myklebusta995e9e2007-02-02 15:37:43 -0800363 tk_ops->rpc_release(req);
364 return -ENOLCK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365}
366
Trond Myklebustd4716622006-03-20 13:44:45 -0500367int nlm_async_call(struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops)
368{
369 struct rpc_message msg = {
370 .rpc_argp = &req->a_args,
371 .rpc_resp = &req->a_res,
372 };
373 return __nlm_async_call(req, proc, &msg, tk_ops);
374}
375
376int nlm_async_reply(struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops)
377{
378 struct rpc_message msg = {
379 .rpc_argp = &req->a_res,
380 };
381 return __nlm_async_call(req, proc, &msg, tk_ops);
382}
383
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384/*
385 * TEST for the presence of a conflicting lock
386 */
387static int
388nlmclnt_test(struct nlm_rqst *req, struct file_lock *fl)
389{
390 int status;
391
392 status = nlmclnt_call(req, NLMPROC_TEST);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 if (status < 0)
Trond Myklebust92737232006-03-20 13:44:45 -0500394 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395
Trond Myklebust92737232006-03-20 13:44:45 -0500396 switch (req->a_res.status) {
Al Viroe8c5c042006-12-13 00:35:03 -0800397 case nlm_granted:
Trond Myklebust92737232006-03-20 13:44:45 -0500398 fl->fl_type = F_UNLCK;
399 break;
Al Viroe8c5c042006-12-13 00:35:03 -0800400 case nlm_lck_denied:
Trond Myklebust92737232006-03-20 13:44:45 -0500401 /*
402 * Report the conflicting lock back to the application.
403 */
404 fl->fl_start = req->a_res.lock.fl.fl_start;
405 fl->fl_end = req->a_res.lock.fl.fl_start;
406 fl->fl_type = req->a_res.lock.fl.fl_type;
407 fl->fl_pid = 0;
408 break;
409 default:
410 status = nlm_stat_to_errno(req->a_res.status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 }
Trond Myklebust92737232006-03-20 13:44:45 -0500412out:
413 nlm_release_call(req);
414 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415}
416
417static void nlmclnt_locks_copy_lock(struct file_lock *new, struct file_lock *fl)
418{
Trond Myklebust4c060b52006-03-20 13:44:41 -0500419 new->fl_u.nfs_fl.state = fl->fl_u.nfs_fl.state;
420 new->fl_u.nfs_fl.owner = nlm_get_lockowner(fl->fl_u.nfs_fl.owner);
421 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 -0700422}
423
424static void nlmclnt_locks_release_private(struct file_lock *fl)
425{
Trond Myklebust4c060b52006-03-20 13:44:41 -0500426 list_del(&fl->fl_u.nfs_fl.list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 nlm_put_lockowner(fl->fl_u.nfs_fl.owner);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428}
429
430static struct file_lock_operations nlmclnt_lock_ops = {
431 .fl_copy_lock = nlmclnt_locks_copy_lock,
432 .fl_release_private = nlmclnt_locks_release_private,
433};
434
435static void nlmclnt_locks_init_private(struct file_lock *fl, struct nlm_host *host)
436{
437 BUG_ON(fl->fl_ops != NULL);
438 fl->fl_u.nfs_fl.state = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 fl->fl_u.nfs_fl.owner = nlm_find_lockowner(host, fl->fl_owner);
Trond Myklebust4c060b52006-03-20 13:44:41 -0500440 INIT_LIST_HEAD(&fl->fl_u.nfs_fl.list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 fl->fl_ops = &nlmclnt_lock_ops;
442}
443
Trond Myklebust9b073572006-06-29 16:38:34 -0400444static int do_vfs_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445{
446 int res = 0;
447 switch (fl->fl_flags & (FL_POSIX|FL_FLOCK)) {
448 case FL_POSIX:
449 res = posix_lock_file_wait(fl->fl_file, fl);
450 break;
451 case FL_FLOCK:
452 res = flock_lock_file_wait(fl->fl_file, fl);
453 break;
454 default:
455 BUG();
456 }
Trond Myklebust9b073572006-06-29 16:38:34 -0400457 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458}
459
460/*
461 * LOCK: Try to create a lock
462 *
463 * Programmer Harassment Alert
464 *
465 * When given a blocking lock request in a sync RPC call, the HPUX lockd
466 * will faithfully return LCK_BLOCKED but never cares to notify us when
467 * the lock could be granted. This way, our local process could hang
468 * around forever waiting for the callback.
469 *
470 * Solution A: Implement busy-waiting
471 * Solution B: Use the async version of the call (NLM_LOCK_{MSG,RES})
472 *
473 * For now I am implementing solution A, because I hate the idea of
474 * re-implementing lockd for a third time in two months. The async
475 * calls shouldn't be too hard to do, however.
476 *
477 * This is one of the lovely things about standards in the NFS area:
478 * they're so soft and squishy you can't really blame HP for doing this.
479 */
480static int
481nlmclnt_lock(struct nlm_rqst *req, struct file_lock *fl)
482{
483 struct nlm_host *host = req->a_host;
484 struct nlm_res *resp = &req->a_res;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500485 struct nlm_wait *block = NULL;
Trond Myklebust01c3b862006-06-29 16:38:39 -0400486 unsigned char fl_flags = fl->fl_flags;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500487 int status = -ENOLCK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488
Olaf Kirch977faf32006-10-04 02:15:51 -0700489 if (nsm_monitor(host) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 printk(KERN_NOTICE "lockd: failed to monitor %s\n",
491 host->h_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 goto out;
493 }
Trond Myklebust01c3b862006-06-29 16:38:39 -0400494 fl->fl_flags |= FL_ACCESS;
495 status = do_vfs_lock(fl);
496 if (status < 0)
497 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498
Trond Myklebust3a649b82006-03-20 13:44:44 -0500499 block = nlmclnt_prepare_block(host, fl);
Trond Myklebust28df9552006-06-09 09:40:27 -0400500again:
Trond Myklebustecdbf762005-06-22 17:16:31 +0000501 for(;;) {
Trond Myklebust28df9552006-06-09 09:40:27 -0400502 /* Reboot protection */
503 fl->fl_u.nfs_fl.state = host->h_state;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000504 status = nlmclnt_call(req, NLMPROC_LOCK);
505 if (status < 0)
506 goto out_unblock;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500507 if (!req->a_args.block)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000508 break;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000509 /* Did a reclaimer thread notify us of a server reboot? */
Al Viroe8c5c042006-12-13 00:35:03 -0800510 if (resp->status == nlm_lck_denied_grace_period)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000511 continue;
Al Viroe8c5c042006-12-13 00:35:03 -0800512 if (resp->status != nlm_lck_blocked)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000513 break;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500514 /* Wait on an NLM blocking lock */
515 status = nlmclnt_block(block, req, NLMCLNT_POLL_TIMEOUT);
516 /* if we were interrupted. Send a CANCEL request to the server
Trond Myklebustecdbf762005-06-22 17:16:31 +0000517 * and exit
518 */
Trond Myklebust3a649b82006-03-20 13:44:44 -0500519 if (status < 0)
520 goto out_unblock;
Al Viroe8c5c042006-12-13 00:35:03 -0800521 if (resp->status != nlm_lck_blocked)
Trond Myklebust3a649b82006-03-20 13:44:44 -0500522 break;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000523 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524
Al Viroe8c5c042006-12-13 00:35:03 -0800525 if (resp->status == nlm_granted) {
Trond Myklebust28df9552006-06-09 09:40:27 -0400526 down_read(&host->h_rwsem);
527 /* Check whether or not the server has rebooted */
528 if (fl->fl_u.nfs_fl.state != host->h_state) {
529 up_read(&host->h_rwsem);
530 goto again;
531 }
Trond Myklebust4c060b52006-03-20 13:44:41 -0500532 /* Ensure the resulting lock will get added to granted list */
Trond Myklebust01c3b862006-06-29 16:38:39 -0400533 fl->fl_flags = fl_flags | FL_SLEEP;
Trond Myklebust9b073572006-06-29 16:38:34 -0400534 if (do_vfs_lock(fl) < 0)
535 printk(KERN_WARNING "%s: VFS is out of sync with lock manager!\n", __FUNCTION__);
Trond Myklebust28df9552006-06-09 09:40:27 -0400536 up_read(&host->h_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 }
538 status = nlm_stat_to_errno(resp->status);
Trond Myklebustecdbf762005-06-22 17:16:31 +0000539out_unblock:
Trond Myklebust3a649b82006-03-20 13:44:44 -0500540 nlmclnt_finish_block(block);
Trond Myklebustecdbf762005-06-22 17:16:31 +0000541 /* Cancel the blocked request if it is still pending */
Al Viroe8c5c042006-12-13 00:35:03 -0800542 if (resp->status == nlm_lck_blocked)
Trond Myklebust16fb2422006-02-01 12:18:22 -0500543 nlmclnt_cancel(host, req->a_args.block, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544out:
Trond Myklebust92737232006-03-20 13:44:45 -0500545 nlm_release_call(req);
Trond Myklebust01c3b862006-06-29 16:38:39 -0400546 fl->fl_flags = fl_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547 return status;
548}
549
550/*
551 * RECLAIM: Try to reclaim a lock
552 */
553int
554nlmclnt_reclaim(struct nlm_host *host, struct file_lock *fl)
555{
556 struct nlm_rqst reqst, *req;
557 int status;
558
559 req = &reqst;
560 memset(req, 0, sizeof(*req));
561 locks_init_lock(&req->a_args.lock.fl);
562 locks_init_lock(&req->a_res.lock.fl);
563 req->a_host = host;
564 req->a_flags = 0;
565
566 /* Set up the argument struct */
567 nlmclnt_setlockargs(req, fl);
568 req->a_args.reclaim = 1;
569
570 if ((status = nlmclnt_call(req, NLMPROC_LOCK)) >= 0
Al Viroe8c5c042006-12-13 00:35:03 -0800571 && req->a_res.status == nlm_granted)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 return 0;
573
574 printk(KERN_WARNING "lockd: failed to reclaim lock for pid %d "
575 "(errno %d, status %d)\n", fl->fl_pid,
Al Viroe8c5c042006-12-13 00:35:03 -0800576 status, ntohl(req->a_res.status));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577
578 /*
579 * FIXME: This is a serious failure. We can
580 *
581 * a. Ignore the problem
582 * b. Send the owning process some signal (Linux doesn't have
583 * SIGLOST, though...)
584 * c. Retry the operation
585 *
586 * Until someone comes up with a simple implementation
587 * for b or c, I'll choose option a.
588 */
589
590 return -ENOLCK;
591}
592
593/*
594 * UNLOCK: remove an existing lock
595 */
596static int
597nlmclnt_unlock(struct nlm_rqst *req, struct file_lock *fl)
598{
Trond Myklebust28df9552006-06-09 09:40:27 -0400599 struct nlm_host *host = req->a_host;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 struct nlm_res *resp = &req->a_res;
Trond Myklebust9b073572006-06-29 16:38:34 -0400601 int status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602
Christoph Hellwig26bcbf92006-03-20 13:44:40 -0500603 /*
Trond Myklebust30f4e202006-03-13 21:20:49 -0800604 * Note: the server is supposed to either grant us the unlock
605 * request, or to deny it with NLM_LCK_DENIED_GRACE_PERIOD. In either
606 * case, we want to unlock.
607 */
Trond Myklebust9b073572006-06-29 16:38:34 -0400608 fl->fl_flags |= FL_EXISTS;
Trond Myklebust28df9552006-06-09 09:40:27 -0400609 down_read(&host->h_rwsem);
Trond Myklebust9b073572006-06-29 16:38:34 -0400610 if (do_vfs_lock(fl) == -ENOENT) {
611 up_read(&host->h_rwsem);
612 goto out;
613 }
Trond Myklebust28df9552006-06-09 09:40:27 -0400614 up_read(&host->h_rwsem);
Trond Myklebust30f4e202006-03-13 21:20:49 -0800615
Trond Myklebust92737232006-03-20 13:44:45 -0500616 if (req->a_flags & RPC_TASK_ASYNC)
617 return nlm_async_call(req, NLMPROC_UNLOCK, &nlmclnt_unlock_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618
619 status = nlmclnt_call(req, NLMPROC_UNLOCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 if (status < 0)
Trond Myklebust92737232006-03-20 13:44:45 -0500621 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622
Al Viroe8c5c042006-12-13 00:35:03 -0800623 if (resp->status == nlm_granted)
Trond Myklebust92737232006-03-20 13:44:45 -0500624 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625
Al Viroe8c5c042006-12-13 00:35:03 -0800626 if (resp->status != nlm_lck_denied_nolocks)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 printk("lockd: unexpected unlock status: %d\n", resp->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 /* What to do now? I'm out of my depth... */
Trond Myklebust92737232006-03-20 13:44:45 -0500629 status = -ENOLCK;
630out:
631 nlm_release_call(req);
632 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633}
634
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100635static void nlmclnt_unlock_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636{
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100637 struct nlm_rqst *req = data;
Al Viroe8c5c042006-12-13 00:35:03 -0800638 u32 status = ntohl(req->a_res.status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639
640 if (RPC_ASSASSINATED(task))
641 goto die;
642
643 if (task->tk_status < 0) {
644 dprintk("lockd: unlock failed (err = %d)\n", -task->tk_status);
645 goto retry_rebind;
646 }
647 if (status == NLM_LCK_DENIED_GRACE_PERIOD) {
648 rpc_delay(task, NLMCLNT_GRACE_WAIT);
649 goto retry_unlock;
650 }
651 if (status != NLM_LCK_GRANTED)
652 printk(KERN_WARNING "lockd: unexpected unlock status: %d\n", status);
653die:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 return;
655 retry_rebind:
656 nlm_rebind_host(req->a_host);
657 retry_unlock:
658 rpc_restart_call(task);
659}
660
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100661static const struct rpc_call_ops nlmclnt_unlock_ops = {
662 .rpc_call_done = nlmclnt_unlock_callback,
Trond Myklebust92737232006-03-20 13:44:45 -0500663 .rpc_release = nlmclnt_rpc_release,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100664};
665
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666/*
667 * Cancel a blocked lock request.
668 * We always use an async RPC call for this in order not to hang a
669 * process that has been Ctrl-C'ed.
670 */
Trond Myklebust16fb2422006-02-01 12:18:22 -0500671static int nlmclnt_cancel(struct nlm_host *host, int block, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672{
673 struct nlm_rqst *req;
674 unsigned long flags;
675 sigset_t oldset;
676 int status;
677
678 /* Block all signals while setting up call */
679 spin_lock_irqsave(&current->sighand->siglock, flags);
680 oldset = current->blocked;
681 sigfillset(&current->blocked);
682 recalc_sigpending();
683 spin_unlock_irqrestore(&current->sighand->siglock, flags);
684
Trond Myklebust92737232006-03-20 13:44:45 -0500685 req = nlm_alloc_call(nlm_get_host(host));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 if (!req)
687 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 req->a_flags = RPC_TASK_ASYNC;
689
690 nlmclnt_setlockargs(req, fl);
Trond Myklebust16fb2422006-02-01 12:18:22 -0500691 req->a_args.block = block;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692
Trond Myklebust92737232006-03-20 13:44:45 -0500693 status = nlm_async_call(req, NLMPROC_CANCEL, &nlmclnt_cancel_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694
695 spin_lock_irqsave(&current->sighand->siglock, flags);
696 current->blocked = oldset;
697 recalc_sigpending();
698 spin_unlock_irqrestore(&current->sighand->siglock, flags);
699
700 return status;
701}
702
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100703static void nlmclnt_cancel_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704{
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100705 struct nlm_rqst *req = data;
Al Viroe8c5c042006-12-13 00:35:03 -0800706 u32 status = ntohl(req->a_res.status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707
708 if (RPC_ASSASSINATED(task))
709 goto die;
710
711 if (task->tk_status < 0) {
712 dprintk("lockd: CANCEL call error %d, retrying.\n",
713 task->tk_status);
714 goto retry_cancel;
715 }
716
Chuck Leverc041b5f2006-12-05 16:36:03 -0500717 dprintk("lockd: cancel status %u (task %u)\n",
Al Viroe8c5c042006-12-13 00:35:03 -0800718 status, task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719
Al Viroe8c5c042006-12-13 00:35:03 -0800720 switch (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 case NLM_LCK_GRANTED:
722 case NLM_LCK_DENIED_GRACE_PERIOD:
Trond Myklebust35576cb2006-03-20 13:44:41 -0500723 case NLM_LCK_DENIED:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 /* Everything's good */
725 break;
726 case NLM_LCK_DENIED_NOLOCKS:
727 dprintk("lockd: CANCEL failed (server has no locks)\n");
728 goto retry_cancel;
729 default:
730 printk(KERN_NOTICE "lockd: weird return %d for CANCEL call\n",
Al Viroe8c5c042006-12-13 00:35:03 -0800731 status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 }
733
734die:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 return;
736
737retry_cancel:
Trond Myklebustaaaa9942006-02-01 12:18:25 -0500738 /* Don't ever retry more than 3 times */
739 if (req->a_retries++ >= NLMCLNT_MAX_RETRIES)
740 goto die;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 nlm_rebind_host(req->a_host);
742 rpc_restart_call(task);
743 rpc_delay(task, 30 * HZ);
744}
745
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100746static const struct rpc_call_ops nlmclnt_cancel_ops = {
747 .rpc_call_done = nlmclnt_cancel_callback,
Trond Myklebust92737232006-03-20 13:44:45 -0500748 .rpc_release = nlmclnt_rpc_release,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100749};
750
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751/*
752 * Convert an NLM status code to a generic kernel errno
753 */
754static int
Al Viroe8c5c042006-12-13 00:35:03 -0800755nlm_stat_to_errno(__be32 status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756{
Al Viroe8c5c042006-12-13 00:35:03 -0800757 switch(ntohl(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 case NLM_LCK_GRANTED:
759 return 0;
760 case NLM_LCK_DENIED:
761 return -EAGAIN;
762 case NLM_LCK_DENIED_NOLOCKS:
763 case NLM_LCK_DENIED_GRACE_PERIOD:
764 return -ENOLCK;
765 case NLM_LCK_BLOCKED:
766 printk(KERN_NOTICE "lockd: unexpected status NLM_BLOCKED\n");
767 return -ENOLCK;
768#ifdef CONFIG_LOCKD_V4
769 case NLM_DEADLCK:
770 return -EDEADLK;
771 case NLM_ROFS:
772 return -EROFS;
773 case NLM_STALE_FH:
774 return -ESTALE;
775 case NLM_FBIG:
776 return -EOVERFLOW;
777 case NLM_FAILED:
778 return -ENOLCK;
779#endif
780 }
781 printk(KERN_NOTICE "lockd: unexpected server status %d\n", status);
782 return -ENOLCK;
783}