blob: dd7957064a8ce31cd54f880ff038dec73e2a9717 [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019
20#define NLMDBG_FACILITY NLMDBG_CLIENT
21#define NLMCLNT_GRACE_WAIT (5*HZ)
Trond Myklebustecdbf762005-06-22 17:16:31 +000022#define NLMCLNT_POLL_TIMEOUT (30*HZ)
Trond Myklebustaaaa9942006-02-01 12:18:25 -050023#define NLMCLNT_MAX_RETRIES 3
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
25static int nlmclnt_test(struct nlm_rqst *, struct file_lock *);
26static int nlmclnt_lock(struct nlm_rqst *, struct file_lock *);
27static int nlmclnt_unlock(struct nlm_rqst *, struct file_lock *);
Al Viroe8c5c042006-12-13 00:35:03 -080028static int nlm_stat_to_errno(__be32 stat);
Linus Torvalds1da177e2005-04-16 15:20:36 -070029static void nlmclnt_locks_init_private(struct file_lock *fl, struct nlm_host *host);
Trond Myklebust16fb2422006-02-01 12:18:22 -050030static int nlmclnt_cancel(struct nlm_host *, int , struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
Trond Myklebust963d8fe2006-01-03 09:55:04 +010032static const struct rpc_call_ops nlmclnt_unlock_ops;
33static const struct rpc_call_ops nlmclnt_cancel_ops;
34
Linus Torvalds1da177e2005-04-16 15:20:36 -070035/*
36 * Cookie counter for NLM requests
37 */
Olaf Kirch031d8692006-10-04 02:16:02 -070038static atomic_t nlm_cookie = ATOMIC_INIT(0x1234);
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
Olaf Kirch031d8692006-10-04 02:16:02 -070040void nlmclnt_next_cookie(struct nlm_cookie *c)
Linus Torvalds1da177e2005-04-16 15:20:36 -070041{
Olaf Kirch031d8692006-10-04 02:16:02 -070042 u32 cookie = atomic_inc_return(&nlm_cookie);
43
44 memcpy(c->data, &cookie, 4);
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 c->len=4;
Linus Torvalds1da177e2005-04-16 15:20:36 -070046}
47
48static struct nlm_lockowner *nlm_get_lockowner(struct nlm_lockowner *lockowner)
49{
50 atomic_inc(&lockowner->count);
51 return lockowner;
52}
53
54static void nlm_put_lockowner(struct nlm_lockowner *lockowner)
55{
56 if (!atomic_dec_and_lock(&lockowner->count, &lockowner->host->h_lock))
57 return;
58 list_del(&lockowner->list);
59 spin_unlock(&lockowner->host->h_lock);
60 nlm_release_host(lockowner->host);
61 kfree(lockowner);
62}
63
64static inline int nlm_pidbusy(struct nlm_host *host, uint32_t pid)
65{
66 struct nlm_lockowner *lockowner;
67 list_for_each_entry(lockowner, &host->h_lockowners, list) {
68 if (lockowner->pid == pid)
69 return -EBUSY;
70 }
71 return 0;
72}
73
74static inline uint32_t __nlm_alloc_pid(struct nlm_host *host)
75{
76 uint32_t res;
77 do {
78 res = host->h_pidcount++;
79 } while (nlm_pidbusy(host, res) < 0);
80 return res;
81}
82
83static struct nlm_lockowner *__nlm_find_lockowner(struct nlm_host *host, fl_owner_t owner)
84{
85 struct nlm_lockowner *lockowner;
86 list_for_each_entry(lockowner, &host->h_lockowners, list) {
87 if (lockowner->owner != owner)
88 continue;
89 return nlm_get_lockowner(lockowner);
90 }
91 return NULL;
92}
93
94static struct nlm_lockowner *nlm_find_lockowner(struct nlm_host *host, fl_owner_t owner)
95{
96 struct nlm_lockowner *res, *new = NULL;
97
98 spin_lock(&host->h_lock);
99 res = __nlm_find_lockowner(host, owner);
100 if (res == NULL) {
101 spin_unlock(&host->h_lock);
Panagiotis Issarisf52720c2006-09-27 01:49:39 -0700102 new = kmalloc(sizeof(*new), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 spin_lock(&host->h_lock);
104 res = __nlm_find_lockowner(host, owner);
105 if (res == NULL && new != NULL) {
106 res = new;
107 atomic_set(&new->count, 1);
108 new->owner = owner;
109 new->pid = __nlm_alloc_pid(host);
110 new->host = nlm_get_host(host);
111 list_add(&new->list, &host->h_lockowners);
112 new = NULL;
113 }
114 }
115 spin_unlock(&host->h_lock);
Jesper Juhlf99d49a2005-11-07 01:01:34 -0800116 kfree(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 return res;
118}
119
120/*
121 * Initialize arguments for TEST/LOCK/UNLOCK/CANCEL calls
122 */
123static void nlmclnt_setlockargs(struct nlm_rqst *req, struct file_lock *fl)
124{
125 struct nlm_args *argp = &req->a_args;
126 struct nlm_lock *lock = &argp->lock;
127
128 nlmclnt_next_cookie(&argp->cookie);
129 argp->state = nsm_local_state;
Josef Sipek225a7192006-12-08 02:37:18 -0800130 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 -0700131 lock->caller = utsname()->nodename;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 lock->oh.data = req->a_owner;
Trond Myklebust7bab3772006-03-20 13:44:06 -0500133 lock->oh.len = snprintf(req->a_owner, sizeof(req->a_owner), "%u@%s",
134 (unsigned int)fl->fl_u.nfs_fl.owner->pid,
Serge E. Hallyne9ff3992006-10-02 02:18:11 -0700135 utsname()->nodename);
Trond Myklebust7bab3772006-03-20 13:44:06 -0500136 lock->svid = fl->fl_u.nfs_fl.owner->pid;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500137 lock->fl.fl_start = fl->fl_start;
138 lock->fl.fl_end = fl->fl_end;
139 lock->fl.fl_type = fl->fl_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140}
141
142static void nlmclnt_release_lockargs(struct nlm_rqst *req)
143{
Trond Myklebust3a649b82006-03-20 13:44:44 -0500144 BUG_ON(req->a_args.lock.fl.fl_ops != NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145}
146
Chuck Lever1093a602008-01-11 17:09:59 -0500147/**
148 * nlmclnt_proc - Perform a single client-side lock request
149 * @host: address of a valid nlm_host context representing the NLM server
150 * @cmd: fcntl-style file lock operation to perform
151 * @fl: address of arguments for the lock operation
152 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 */
Chuck Lever1093a602008-01-11 17:09:59 -0500154int nlmclnt_proc(struct nlm_host *host, int cmd, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155{
Trond Myklebust92737232006-03-20 13:44:45 -0500156 struct nlm_rqst *call;
Chuck Lever1093a602008-01-11 17:09:59 -0500157 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
Chuck Lever1093a602008-01-11 17:09:59 -0500159 nlm_get_host(host);
Trond Myklebust92737232006-03-20 13:44:45 -0500160 call = nlm_alloc_call(host);
161 if (call == NULL)
162 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
Trond Myklebust92737232006-03-20 13:44:45 -0500164 nlmclnt_locks_init_private(fl, host);
165 /* Set up the argument struct */
166 nlmclnt_setlockargs(call, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168 if (IS_SETLK(cmd) || IS_SETLKW(cmd)) {
169 if (fl->fl_type != F_UNLCK) {
170 call->a_args.block = IS_SETLKW(cmd) ? 1 : 0;
171 status = nlmclnt_lock(call, fl);
172 } else
173 status = nlmclnt_unlock(call, fl);
174 } else if (IS_GETLK(cmd))
175 status = nlmclnt_test(call, fl);
176 else
177 status = -EINVAL;
178
Trond Myklebust92737232006-03-20 13:44:45 -0500179 fl->fl_ops->fl_release_private(fl);
180 fl->fl_ops = NULL;
181
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 dprintk("lockd: clnt proc returns %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 return status;
184}
Chuck Lever1093a602008-01-11 17:09:59 -0500185EXPORT_SYMBOL_GPL(nlmclnt_proc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
187/*
188 * Allocate an NLM RPC call struct
Trond Myklebust92737232006-03-20 13:44:45 -0500189 *
190 * Note: the caller must hold a reference to host. In case of failure,
191 * this reference will be released.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 */
Trond Myklebust92737232006-03-20 13:44:45 -0500193struct nlm_rqst *nlm_alloc_call(struct nlm_host *host)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194{
195 struct nlm_rqst *call;
196
Trond Myklebust36943fa2006-03-20 13:44:05 -0500197 for(;;) {
198 call = kzalloc(sizeof(*call), GFP_KERNEL);
199 if (call != NULL) {
Trond Myklebust5e7f37a2008-04-01 18:58:49 -0400200 atomic_set(&call->a_count, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 locks_init_lock(&call->a_args.lock.fl);
202 locks_init_lock(&call->a_res.lock.fl);
Trond Myklebust92737232006-03-20 13:44:45 -0500203 call->a_host = host;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 return call;
205 }
Trond Myklebust36943fa2006-03-20 13:44:05 -0500206 if (signalled())
207 break;
Trond Myklebust92737232006-03-20 13:44:45 -0500208 printk("nlm_alloc_call: failed, waiting for memory\n");
Nishanth Aravamudan041e0e32005-09-10 00:27:23 -0700209 schedule_timeout_interruptible(5*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 }
Trond Myklebust92737232006-03-20 13:44:45 -0500211 nlm_release_host(host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 return NULL;
213}
214
Trond Myklebust92737232006-03-20 13:44:45 -0500215void nlm_release_call(struct nlm_rqst *call)
216{
Trond Myklebust5e7f37a2008-04-01 18:58:49 -0400217 if (!atomic_dec_and_test(&call->a_count))
218 return;
Trond Myklebust92737232006-03-20 13:44:45 -0500219 nlm_release_host(call->a_host);
220 nlmclnt_release_lockargs(call);
221 kfree(call);
222}
223
224static void nlmclnt_rpc_release(void *data)
225{
Trond Myklebusta86dc492008-06-11 13:37:09 -0400226 lock_kernel();
Trond Myklebust65fdf7d2008-01-11 17:41:29 -0500227 nlm_release_call(data);
Trond Myklebusta86dc492008-06-11 13:37:09 -0400228 unlock_kernel();
Trond Myklebust92737232006-03-20 13:44:45 -0500229}
230
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231static int nlm_wait_on_grace(wait_queue_head_t *queue)
232{
233 DEFINE_WAIT(wait);
234 int status = -EINTR;
235
236 prepare_to_wait(queue, &wait, TASK_INTERRUPTIBLE);
237 if (!signalled ()) {
238 schedule_timeout(NLMCLNT_GRACE_WAIT);
Christoph Lameter3e1d1d22005-06-24 23:13:50 -0700239 try_to_freeze();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 if (!signalled ())
241 status = 0;
242 }
243 finish_wait(queue, &wait);
244 return status;
245}
246
247/*
248 * Generic NLM call
249 */
250static int
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400251nlmclnt_call(struct rpc_cred *cred, struct nlm_rqst *req, u32 proc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252{
253 struct nlm_host *host = req->a_host;
254 struct rpc_clnt *clnt;
255 struct nlm_args *argp = &req->a_args;
256 struct nlm_res *resp = &req->a_res;
257 struct rpc_message msg = {
258 .rpc_argp = argp,
259 .rpc_resp = resp,
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400260 .rpc_cred = cred,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 };
262 int status;
263
264 dprintk("lockd: call procedure %d on %s\n",
265 (int)proc, host->h_name);
266
267 do {
268 if (host->h_reclaiming && !argp->reclaim)
269 goto in_grace_period;
270
271 /* If we have no RPC client yet, create one. */
272 if ((clnt = nlm_bind_host(host)) == NULL)
273 return -ENOLCK;
274 msg.rpc_proc = &clnt->cl_procinfo[proc];
275
276 /* Perform the RPC call. If an error occurs, try again */
277 if ((status = rpc_call_sync(clnt, &msg, 0)) < 0) {
278 dprintk("lockd: rpc_call returned error %d\n", -status);
279 switch (status) {
280 case -EPROTONOSUPPORT:
281 status = -EINVAL;
282 break;
283 case -ECONNREFUSED:
284 case -ETIMEDOUT:
285 case -ENOTCONN:
286 nlm_rebind_host(host);
287 status = -EAGAIN;
288 break;
289 case -ERESTARTSYS:
290 return signalled () ? -EINTR : status;
291 default:
292 break;
293 }
294 break;
295 } else
Al Viroe8c5c042006-12-13 00:35:03 -0800296 if (resp->status == nlm_lck_denied_grace_period) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 dprintk("lockd: server in grace period\n");
298 if (argp->reclaim) {
299 printk(KERN_WARNING
300 "lockd: spurious grace period reject?!\n");
301 return -ENOLCK;
302 }
303 } else {
304 if (!argp->reclaim) {
305 /* We appear to be out of the grace period */
306 wake_up_all(&host->h_gracewait);
307 }
308 dprintk("lockd: server returns status %d\n", resp->status);
309 return 0; /* Okay, call complete */
310 }
311
312in_grace_period:
313 /*
314 * The server has rebooted and appears to be in the grace
315 * period during which locks are only allowed to be
316 * reclaimed.
317 * We can only back off and try again later.
318 */
319 status = nlm_wait_on_grace(&host->h_gracewait);
320 } while (status == 0);
321
322 return status;
323}
324
325/*
326 * Generic NLM call, async version.
327 */
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400328static 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 -0700329{
330 struct nlm_host *host = req->a_host;
331 struct rpc_clnt *clnt;
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400332 struct rpc_task_setup task_setup_data = {
333 .rpc_message = msg,
334 .callback_ops = tk_ops,
335 .callback_data = req,
336 .flags = RPC_TASK_ASYNC,
337 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338
339 dprintk("lockd: call procedure %d on %s (async)\n",
340 (int)proc, host->h_name);
341
342 /* If we have no RPC client yet, create one. */
Trond Myklebust92737232006-03-20 13:44:45 -0500343 clnt = nlm_bind_host(host);
344 if (clnt == NULL)
345 goto out_err;
Trond Myklebustd4716622006-03-20 13:44:45 -0500346 msg->rpc_proc = &clnt->cl_procinfo[proc];
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400347 task_setup_data.rpc_client = clnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
349 /* bootstrap and kick off the async RPC call */
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400350 return rpc_run_task(&task_setup_data);
Trond Myklebust92737232006-03-20 13:44:45 -0500351out_err:
Trond Myklebusta995e9e2007-02-02 15:37:43 -0800352 tk_ops->rpc_release(req);
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400353 return ERR_PTR(-ENOLCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354}
355
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400356static int nlm_do_async_call(struct nlm_rqst *req, u32 proc, struct rpc_message *msg, const struct rpc_call_ops *tk_ops)
357{
358 struct rpc_task *task;
359
360 task = __nlm_async_call(req, proc, msg, tk_ops);
361 if (IS_ERR(task))
362 return PTR_ERR(task);
363 rpc_put_task(task);
364 return 0;
365}
366
367/*
368 * NLM asynchronous call.
369 */
Trond Myklebustd4716622006-03-20 13:44:45 -0500370int nlm_async_call(struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops)
371{
372 struct rpc_message msg = {
373 .rpc_argp = &req->a_args,
374 .rpc_resp = &req->a_res,
375 };
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400376 return nlm_do_async_call(req, proc, &msg, tk_ops);
Trond Myklebustd4716622006-03-20 13:44:45 -0500377}
378
379int nlm_async_reply(struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops)
380{
381 struct rpc_message msg = {
382 .rpc_argp = &req->a_res,
383 };
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400384 return nlm_do_async_call(req, proc, &msg, tk_ops);
385}
386
387/*
388 * NLM client asynchronous call.
389 *
390 * Note that although the calls are asynchronous, and are therefore
391 * guaranteed to complete, we still always attempt to wait for
392 * completion in order to be able to correctly track the lock
393 * state.
394 */
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400395static int nlmclnt_async_call(struct rpc_cred *cred, struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops)
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400396{
397 struct rpc_message msg = {
398 .rpc_argp = &req->a_args,
399 .rpc_resp = &req->a_res,
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400400 .rpc_cred = cred,
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400401 };
402 struct rpc_task *task;
403 int err;
404
405 task = __nlm_async_call(req, proc, &msg, tk_ops);
406 if (IS_ERR(task))
407 return PTR_ERR(task);
408 err = rpc_wait_for_completion_task(task);
409 rpc_put_task(task);
410 return err;
Trond Myklebustd4716622006-03-20 13:44:45 -0500411}
412
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413/*
414 * TEST for the presence of a conflicting lock
415 */
416static int
417nlmclnt_test(struct nlm_rqst *req, struct file_lock *fl)
418{
419 int status;
420
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400421 status = nlmclnt_call(nfs_file_cred(fl->fl_file), req, NLMPROC_TEST);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 if (status < 0)
Trond Myklebust92737232006-03-20 13:44:45 -0500423 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
Trond Myklebust92737232006-03-20 13:44:45 -0500425 switch (req->a_res.status) {
Al Viroe8c5c042006-12-13 00:35:03 -0800426 case nlm_granted:
Trond Myklebust92737232006-03-20 13:44:45 -0500427 fl->fl_type = F_UNLCK;
428 break;
Al Viroe8c5c042006-12-13 00:35:03 -0800429 case nlm_lck_denied:
Trond Myklebust92737232006-03-20 13:44:45 -0500430 /*
431 * Report the conflicting lock back to the application.
432 */
433 fl->fl_start = req->a_res.lock.fl.fl_start;
Felix Blyakherd67d1c72008-07-15 12:40:22 -0500434 fl->fl_end = req->a_res.lock.fl.fl_end;
Trond Myklebust92737232006-03-20 13:44:45 -0500435 fl->fl_type = req->a_res.lock.fl.fl_type;
436 fl->fl_pid = 0;
437 break;
438 default:
439 status = nlm_stat_to_errno(req->a_res.status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 }
Trond Myklebust92737232006-03-20 13:44:45 -0500441out:
442 nlm_release_call(req);
443 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444}
445
446static void nlmclnt_locks_copy_lock(struct file_lock *new, struct file_lock *fl)
447{
Trond Myklebust4c060b52006-03-20 13:44:41 -0500448 new->fl_u.nfs_fl.state = fl->fl_u.nfs_fl.state;
449 new->fl_u.nfs_fl.owner = nlm_get_lockowner(fl->fl_u.nfs_fl.owner);
450 list_add_tail(&new->fl_u.nfs_fl.list, &fl->fl_u.nfs_fl.owner->host->h_granted);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451}
452
453static void nlmclnt_locks_release_private(struct file_lock *fl)
454{
Trond Myklebust4c060b52006-03-20 13:44:41 -0500455 list_del(&fl->fl_u.nfs_fl.list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 nlm_put_lockowner(fl->fl_u.nfs_fl.owner);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457}
458
459static struct file_lock_operations nlmclnt_lock_ops = {
460 .fl_copy_lock = nlmclnt_locks_copy_lock,
461 .fl_release_private = nlmclnt_locks_release_private,
462};
463
464static void nlmclnt_locks_init_private(struct file_lock *fl, struct nlm_host *host)
465{
466 BUG_ON(fl->fl_ops != NULL);
467 fl->fl_u.nfs_fl.state = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 fl->fl_u.nfs_fl.owner = nlm_find_lockowner(host, fl->fl_owner);
Trond Myklebust4c060b52006-03-20 13:44:41 -0500469 INIT_LIST_HEAD(&fl->fl_u.nfs_fl.list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 fl->fl_ops = &nlmclnt_lock_ops;
471}
472
Trond Myklebust9b073572006-06-29 16:38:34 -0400473static int do_vfs_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474{
475 int res = 0;
476 switch (fl->fl_flags & (FL_POSIX|FL_FLOCK)) {
477 case FL_POSIX:
478 res = posix_lock_file_wait(fl->fl_file, fl);
479 break;
480 case FL_FLOCK:
481 res = flock_lock_file_wait(fl->fl_file, fl);
482 break;
483 default:
484 BUG();
485 }
Trond Myklebust9b073572006-06-29 16:38:34 -0400486 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487}
488
489/*
490 * LOCK: Try to create a lock
491 *
492 * Programmer Harassment Alert
493 *
494 * When given a blocking lock request in a sync RPC call, the HPUX lockd
495 * will faithfully return LCK_BLOCKED but never cares to notify us when
496 * the lock could be granted. This way, our local process could hang
497 * around forever waiting for the callback.
498 *
499 * Solution A: Implement busy-waiting
500 * Solution B: Use the async version of the call (NLM_LOCK_{MSG,RES})
501 *
502 * For now I am implementing solution A, because I hate the idea of
503 * re-implementing lockd for a third time in two months. The async
504 * calls shouldn't be too hard to do, however.
505 *
506 * This is one of the lovely things about standards in the NFS area:
507 * they're so soft and squishy you can't really blame HP for doing this.
508 */
509static int
510nlmclnt_lock(struct nlm_rqst *req, struct file_lock *fl)
511{
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400512 struct rpc_cred *cred = nfs_file_cred(fl->fl_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 struct nlm_host *host = req->a_host;
514 struct nlm_res *resp = &req->a_res;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500515 struct nlm_wait *block = NULL;
Trond Myklebust01c3b862006-06-29 16:38:39 -0400516 unsigned char fl_flags = fl->fl_flags;
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400517 unsigned char fl_type;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500518 int status = -ENOLCK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519
Chuck Lever501c1ed2008-12-04 14:21:01 -0500520 if (nsm_monitor(host) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 goto out;
Chuck Lever501c1ed2008-12-04 14:21:01 -0500522
Trond Myklebust01c3b862006-06-29 16:38:39 -0400523 fl->fl_flags |= FL_ACCESS;
524 status = do_vfs_lock(fl);
Trond Myklebust4a9af592008-04-01 18:57:06 -0400525 fl->fl_flags = fl_flags;
Trond Myklebust01c3b862006-06-29 16:38:39 -0400526 if (status < 0)
527 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528
Trond Myklebust3a649b82006-03-20 13:44:44 -0500529 block = nlmclnt_prepare_block(host, fl);
Trond Myklebust28df9552006-06-09 09:40:27 -0400530again:
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400531 /*
532 * Initialise resp->status to a valid non-zero value,
533 * since 0 == nlm_lck_granted
534 */
535 resp->status = nlm_lck_blocked;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000536 for(;;) {
Trond Myklebust28df9552006-06-09 09:40:27 -0400537 /* Reboot protection */
538 fl->fl_u.nfs_fl.state = host->h_state;
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400539 status = nlmclnt_call(cred, req, NLMPROC_LOCK);
Trond Myklebustecdbf762005-06-22 17:16:31 +0000540 if (status < 0)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000541 break;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000542 /* Did a reclaimer thread notify us of a server reboot? */
Al Viroe8c5c042006-12-13 00:35:03 -0800543 if (resp->status == nlm_lck_denied_grace_period)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000544 continue;
Al Viroe8c5c042006-12-13 00:35:03 -0800545 if (resp->status != nlm_lck_blocked)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000546 break;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500547 /* Wait on an NLM blocking lock */
548 status = nlmclnt_block(block, req, NLMCLNT_POLL_TIMEOUT);
Trond Myklebust3a649b82006-03-20 13:44:44 -0500549 if (status < 0)
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400550 break;
Al Viroe8c5c042006-12-13 00:35:03 -0800551 if (resp->status != nlm_lck_blocked)
Trond Myklebust3a649b82006-03-20 13:44:44 -0500552 break;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000553 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400555 /* if we were interrupted while blocking, then cancel the lock request
556 * and exit
557 */
558 if (resp->status == nlm_lck_blocked) {
559 if (!req->a_args.block)
560 goto out_unlock;
561 if (nlmclnt_cancel(host, req->a_args.block, fl) == 0)
562 goto out_unblock;
563 }
564
Al Viroe8c5c042006-12-13 00:35:03 -0800565 if (resp->status == nlm_granted) {
Trond Myklebust28df9552006-06-09 09:40:27 -0400566 down_read(&host->h_rwsem);
567 /* Check whether or not the server has rebooted */
568 if (fl->fl_u.nfs_fl.state != host->h_state) {
569 up_read(&host->h_rwsem);
570 goto again;
571 }
Trond Myklebust4c060b52006-03-20 13:44:41 -0500572 /* Ensure the resulting lock will get added to granted list */
Trond Myklebust4a9af592008-04-01 18:57:06 -0400573 fl->fl_flags |= FL_SLEEP;
Trond Myklebust9b073572006-06-29 16:38:34 -0400574 if (do_vfs_lock(fl) < 0)
Harvey Harrison8e24eea2008-04-30 00:55:09 -0700575 printk(KERN_WARNING "%s: VFS is out of sync with lock manager!\n", __func__);
Trond Myklebust28df9552006-06-09 09:40:27 -0400576 up_read(&host->h_rwsem);
Trond Myklebust4a9af592008-04-01 18:57:06 -0400577 fl->fl_flags = fl_flags;
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400578 status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 }
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400580 if (status < 0)
581 goto out_unlock;
Miklos Szeredicc77b152008-07-25 01:48:55 -0700582 /*
583 * EAGAIN doesn't make sense for sleeping locks, and in some
584 * cases NLM_LCK_DENIED is returned for a permanent error. So
585 * turn it into an ENOLCK.
586 */
587 if (resp->status == nlm_lck_denied && (fl_flags & FL_SLEEP))
588 status = -ENOLCK;
589 else
590 status = nlm_stat_to_errno(resp->status);
Trond Myklebustecdbf762005-06-22 17:16:31 +0000591out_unblock:
Trond Myklebust3a649b82006-03-20 13:44:44 -0500592 nlmclnt_finish_block(block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593out:
Trond Myklebust92737232006-03-20 13:44:45 -0500594 nlm_release_call(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 return status;
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400596out_unlock:
597 /* Fatal error: ensure that we remove the lock altogether */
598 dprintk("lockd: lock attempt ended in fatal error.\n"
599 " Attempting to unlock.\n");
600 nlmclnt_finish_block(block);
601 fl_type = fl->fl_type;
602 fl->fl_type = F_UNLCK;
603 down_read(&host->h_rwsem);
604 do_vfs_lock(fl);
605 up_read(&host->h_rwsem);
606 fl->fl_type = fl_type;
607 fl->fl_flags = fl_flags;
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400608 nlmclnt_async_call(cred, req, NLMPROC_UNLOCK, &nlmclnt_unlock_ops);
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400609 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610}
611
612/*
613 * RECLAIM: Try to reclaim a lock
614 */
615int
616nlmclnt_reclaim(struct nlm_host *host, struct file_lock *fl)
617{
618 struct nlm_rqst reqst, *req;
619 int status;
620
621 req = &reqst;
622 memset(req, 0, sizeof(*req));
623 locks_init_lock(&req->a_args.lock.fl);
624 locks_init_lock(&req->a_res.lock.fl);
625 req->a_host = host;
626 req->a_flags = 0;
627
628 /* Set up the argument struct */
629 nlmclnt_setlockargs(req, fl);
630 req->a_args.reclaim = 1;
631
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400632 status = nlmclnt_call(nfs_file_cred(fl->fl_file), req, NLMPROC_LOCK);
633 if (status >= 0 && req->a_res.status == nlm_granted)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 return 0;
635
636 printk(KERN_WARNING "lockd: failed to reclaim lock for pid %d "
637 "(errno %d, status %d)\n", fl->fl_pid,
Al Viroe8c5c042006-12-13 00:35:03 -0800638 status, ntohl(req->a_res.status));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639
640 /*
641 * FIXME: This is a serious failure. We can
642 *
643 * a. Ignore the problem
644 * b. Send the owning process some signal (Linux doesn't have
645 * SIGLOST, though...)
646 * c. Retry the operation
647 *
648 * Until someone comes up with a simple implementation
649 * for b or c, I'll choose option a.
650 */
651
652 return -ENOLCK;
653}
654
655/*
656 * UNLOCK: remove an existing lock
657 */
658static int
659nlmclnt_unlock(struct nlm_rqst *req, struct file_lock *fl)
660{
Trond Myklebust28df9552006-06-09 09:40:27 -0400661 struct nlm_host *host = req->a_host;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 struct nlm_res *resp = &req->a_res;
Trond Myklebust4a9af592008-04-01 18:57:06 -0400663 int status;
664 unsigned char fl_flags = fl->fl_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665
Christoph Hellwig26bcbf92006-03-20 13:44:40 -0500666 /*
Trond Myklebust30f4e202006-03-13 21:20:49 -0800667 * Note: the server is supposed to either grant us the unlock
668 * request, or to deny it with NLM_LCK_DENIED_GRACE_PERIOD. In either
669 * case, we want to unlock.
670 */
Trond Myklebust9b073572006-06-29 16:38:34 -0400671 fl->fl_flags |= FL_EXISTS;
Trond Myklebust28df9552006-06-09 09:40:27 -0400672 down_read(&host->h_rwsem);
Trond Myklebust4a9af592008-04-01 18:57:06 -0400673 status = do_vfs_lock(fl);
674 up_read(&host->h_rwsem);
675 fl->fl_flags = fl_flags;
676 if (status == -ENOENT) {
677 status = 0;
Trond Myklebust9b073572006-06-29 16:38:34 -0400678 goto out;
679 }
Trond Myklebust30f4e202006-03-13 21:20:49 -0800680
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400681 atomic_inc(&req->a_count);
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400682 status = nlmclnt_async_call(nfs_file_cred(fl->fl_file), req,
683 NLMPROC_UNLOCK, &nlmclnt_unlock_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 if (status < 0)
Trond Myklebust92737232006-03-20 13:44:45 -0500685 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686
Al Viroe8c5c042006-12-13 00:35:03 -0800687 if (resp->status == nlm_granted)
Trond Myklebust92737232006-03-20 13:44:45 -0500688 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689
Al Viroe8c5c042006-12-13 00:35:03 -0800690 if (resp->status != nlm_lck_denied_nolocks)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 printk("lockd: unexpected unlock status: %d\n", resp->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692 /* What to do now? I'm out of my depth... */
Trond Myklebust92737232006-03-20 13:44:45 -0500693 status = -ENOLCK;
694out:
695 nlm_release_call(req);
696 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697}
698
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100699static void nlmclnt_unlock_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700{
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100701 struct nlm_rqst *req = data;
Al Viroe8c5c042006-12-13 00:35:03 -0800702 u32 status = ntohl(req->a_res.status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703
704 if (RPC_ASSASSINATED(task))
705 goto die;
706
707 if (task->tk_status < 0) {
708 dprintk("lockd: unlock failed (err = %d)\n", -task->tk_status);
709 goto retry_rebind;
710 }
711 if (status == NLM_LCK_DENIED_GRACE_PERIOD) {
712 rpc_delay(task, NLMCLNT_GRACE_WAIT);
713 goto retry_unlock;
714 }
715 if (status != NLM_LCK_GRANTED)
716 printk(KERN_WARNING "lockd: unexpected unlock status: %d\n", status);
717die:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 return;
719 retry_rebind:
Trond Myklebusta86dc492008-06-11 13:37:09 -0400720 lock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 nlm_rebind_host(req->a_host);
Trond Myklebusta86dc492008-06-11 13:37:09 -0400722 unlock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 retry_unlock:
724 rpc_restart_call(task);
725}
726
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100727static const struct rpc_call_ops nlmclnt_unlock_ops = {
728 .rpc_call_done = nlmclnt_unlock_callback,
Trond Myklebust92737232006-03-20 13:44:45 -0500729 .rpc_release = nlmclnt_rpc_release,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100730};
731
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732/*
733 * Cancel a blocked lock request.
734 * We always use an async RPC call for this in order not to hang a
735 * process that has been Ctrl-C'ed.
736 */
Trond Myklebust16fb2422006-02-01 12:18:22 -0500737static int nlmclnt_cancel(struct nlm_host *host, int block, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738{
739 struct nlm_rqst *req;
Trond Myklebust6b4b3a72008-04-02 14:40:53 -0400740 int status;
741
742 dprintk("lockd: blocking lock attempt was interrupted by a signal.\n"
743 " Attempting to cancel lock.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744
Trond Myklebust92737232006-03-20 13:44:45 -0500745 req = nlm_alloc_call(nlm_get_host(host));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 if (!req)
747 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 req->a_flags = RPC_TASK_ASYNC;
749
750 nlmclnt_setlockargs(req, fl);
Trond Myklebust16fb2422006-02-01 12:18:22 -0500751 req->a_args.block = block;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752
Trond Myklebust6b4b3a72008-04-02 14:40:53 -0400753 atomic_inc(&req->a_count);
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400754 status = nlmclnt_async_call(nfs_file_cred(fl->fl_file), req,
755 NLMPROC_CANCEL, &nlmclnt_cancel_ops);
Trond Myklebust6b4b3a72008-04-02 14:40:53 -0400756 if (status == 0 && req->a_res.status == nlm_lck_denied)
757 status = -ENOLCK;
758 nlm_release_call(req);
759 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760}
761
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100762static void nlmclnt_cancel_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763{
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100764 struct nlm_rqst *req = data;
Al Viroe8c5c042006-12-13 00:35:03 -0800765 u32 status = ntohl(req->a_res.status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766
767 if (RPC_ASSASSINATED(task))
768 goto die;
769
770 if (task->tk_status < 0) {
771 dprintk("lockd: CANCEL call error %d, retrying.\n",
772 task->tk_status);
773 goto retry_cancel;
774 }
775
Chuck Leverc041b5f2006-12-05 16:36:03 -0500776 dprintk("lockd: cancel status %u (task %u)\n",
Al Viroe8c5c042006-12-13 00:35:03 -0800777 status, task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778
Al Viroe8c5c042006-12-13 00:35:03 -0800779 switch (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 case NLM_LCK_GRANTED:
781 case NLM_LCK_DENIED_GRACE_PERIOD:
Trond Myklebust35576cb2006-03-20 13:44:41 -0500782 case NLM_LCK_DENIED:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 /* Everything's good */
784 break;
785 case NLM_LCK_DENIED_NOLOCKS:
786 dprintk("lockd: CANCEL failed (server has no locks)\n");
787 goto retry_cancel;
788 default:
789 printk(KERN_NOTICE "lockd: weird return %d for CANCEL call\n",
Al Viroe8c5c042006-12-13 00:35:03 -0800790 status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 }
792
793die:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 return;
795
796retry_cancel:
Trond Myklebustaaaa9942006-02-01 12:18:25 -0500797 /* Don't ever retry more than 3 times */
798 if (req->a_retries++ >= NLMCLNT_MAX_RETRIES)
799 goto die;
Trond Myklebusta86dc492008-06-11 13:37:09 -0400800 lock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 nlm_rebind_host(req->a_host);
Trond Myklebusta86dc492008-06-11 13:37:09 -0400802 unlock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803 rpc_restart_call(task);
804 rpc_delay(task, 30 * HZ);
805}
806
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100807static const struct rpc_call_ops nlmclnt_cancel_ops = {
808 .rpc_call_done = nlmclnt_cancel_callback,
Trond Myklebust92737232006-03-20 13:44:45 -0500809 .rpc_release = nlmclnt_rpc_release,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100810};
811
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812/*
813 * Convert an NLM status code to a generic kernel errno
814 */
815static int
Al Viroe8c5c042006-12-13 00:35:03 -0800816nlm_stat_to_errno(__be32 status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817{
Al Viroe8c5c042006-12-13 00:35:03 -0800818 switch(ntohl(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 case NLM_LCK_GRANTED:
820 return 0;
821 case NLM_LCK_DENIED:
822 return -EAGAIN;
823 case NLM_LCK_DENIED_NOLOCKS:
824 case NLM_LCK_DENIED_GRACE_PERIOD:
825 return -ENOLCK;
826 case NLM_LCK_BLOCKED:
827 printk(KERN_NOTICE "lockd: unexpected status NLM_BLOCKED\n");
828 return -ENOLCK;
829#ifdef CONFIG_LOCKD_V4
830 case NLM_DEADLCK:
831 return -EDEADLK;
832 case NLM_ROFS:
833 return -EROFS;
834 case NLM_STALE_FH:
835 return -ESTALE;
836 case NLM_FBIG:
837 return -EOVERFLOW;
838 case NLM_FAILED:
839 return -ENOLCK;
840#endif
841 }
842 printk(KERN_NOTICE "lockd: unexpected server status %d\n", status);
843 return -ENOLCK;
844}