blob: 7932c399fab41421095fbb0f98f0b21819e96514 [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>
Alexey Dobriyan405f5572009-07-11 22:08:37 +040010#include <linux/smp_lock.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090011#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/types.h>
13#include <linux/errno.h>
14#include <linux/fs.h>
15#include <linux/nfs_fs.h>
16#include <linux/utsname.h>
Nigel Cunningham7dfb7102006-12-06 20:34:23 -080017#include <linux/freezer.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/sunrpc/clnt.h>
19#include <linux/sunrpc/svc.h>
20#include <linux/lockd/lockd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
22#define NLMDBG_FACILITY NLMDBG_CLIENT
23#define NLMCLNT_GRACE_WAIT (5*HZ)
Trond Myklebustecdbf762005-06-22 17:16:31 +000024#define NLMCLNT_POLL_TIMEOUT (30*HZ)
Trond Myklebustaaaa9942006-02-01 12:18:25 -050025#define NLMCLNT_MAX_RETRIES 3
Linus Torvalds1da177e2005-04-16 15:20:36 -070026
27static int nlmclnt_test(struct nlm_rqst *, struct file_lock *);
28static int nlmclnt_lock(struct nlm_rqst *, struct file_lock *);
29static int nlmclnt_unlock(struct nlm_rqst *, struct file_lock *);
Al Viroe8c5c042006-12-13 00:35:03 -080030static int nlm_stat_to_errno(__be32 stat);
Linus Torvalds1da177e2005-04-16 15:20:36 -070031static void nlmclnt_locks_init_private(struct file_lock *fl, struct nlm_host *host);
Trond Myklebust16fb2422006-02-01 12:18:22 -050032static int nlmclnt_cancel(struct nlm_host *, int , struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
Trond Myklebust963d8fe2006-01-03 09:55:04 +010034static const struct rpc_call_ops nlmclnt_unlock_ops;
35static const struct rpc_call_ops nlmclnt_cancel_ops;
36
Linus Torvalds1da177e2005-04-16 15:20:36 -070037/*
38 * Cookie counter for NLM requests
39 */
Olaf Kirch031d8692006-10-04 02:16:02 -070040static atomic_t nlm_cookie = ATOMIC_INIT(0x1234);
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Olaf Kirch031d8692006-10-04 02:16:02 -070042void nlmclnt_next_cookie(struct nlm_cookie *c)
Linus Torvalds1da177e2005-04-16 15:20:36 -070043{
Olaf Kirch031d8692006-10-04 02:16:02 -070044 u32 cookie = atomic_inc_return(&nlm_cookie);
45
46 memcpy(c->data, &cookie, 4);
Linus Torvalds1da177e2005-04-16 15:20:36 -070047 c->len=4;
Linus Torvalds1da177e2005-04-16 15:20:36 -070048}
49
50static struct nlm_lockowner *nlm_get_lockowner(struct nlm_lockowner *lockowner)
51{
52 atomic_inc(&lockowner->count);
53 return lockowner;
54}
55
56static void nlm_put_lockowner(struct nlm_lockowner *lockowner)
57{
58 if (!atomic_dec_and_lock(&lockowner->count, &lockowner->host->h_lock))
59 return;
60 list_del(&lockowner->list);
61 spin_unlock(&lockowner->host->h_lock);
62 nlm_release_host(lockowner->host);
63 kfree(lockowner);
64}
65
66static inline int nlm_pidbusy(struct nlm_host *host, uint32_t pid)
67{
68 struct nlm_lockowner *lockowner;
69 list_for_each_entry(lockowner, &host->h_lockowners, list) {
70 if (lockowner->pid == pid)
71 return -EBUSY;
72 }
73 return 0;
74}
75
76static inline uint32_t __nlm_alloc_pid(struct nlm_host *host)
77{
78 uint32_t res;
79 do {
80 res = host->h_pidcount++;
81 } while (nlm_pidbusy(host, res) < 0);
82 return res;
83}
84
85static struct nlm_lockowner *__nlm_find_lockowner(struct nlm_host *host, fl_owner_t owner)
86{
87 struct nlm_lockowner *lockowner;
88 list_for_each_entry(lockowner, &host->h_lockowners, list) {
89 if (lockowner->owner != owner)
90 continue;
91 return nlm_get_lockowner(lockowner);
92 }
93 return NULL;
94}
95
96static struct nlm_lockowner *nlm_find_lockowner(struct nlm_host *host, fl_owner_t owner)
97{
98 struct nlm_lockowner *res, *new = NULL;
99
100 spin_lock(&host->h_lock);
101 res = __nlm_find_lockowner(host, owner);
102 if (res == NULL) {
103 spin_unlock(&host->h_lock);
Panagiotis Issarisf52720c2006-09-27 01:49:39 -0700104 new = kmalloc(sizeof(*new), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 spin_lock(&host->h_lock);
106 res = __nlm_find_lockowner(host, owner);
107 if (res == NULL && new != NULL) {
108 res = new;
109 atomic_set(&new->count, 1);
110 new->owner = owner;
111 new->pid = __nlm_alloc_pid(host);
112 new->host = nlm_get_host(host);
113 list_add(&new->list, &host->h_lockowners);
114 new = NULL;
115 }
116 }
117 spin_unlock(&host->h_lock);
Jesper Juhlf99d49a2005-11-07 01:01:34 -0800118 kfree(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 return res;
120}
121
122/*
123 * Initialize arguments for TEST/LOCK/UNLOCK/CANCEL calls
124 */
125static void nlmclnt_setlockargs(struct nlm_rqst *req, struct file_lock *fl)
126{
127 struct nlm_args *argp = &req->a_args;
128 struct nlm_lock *lock = &argp->lock;
129
130 nlmclnt_next_cookie(&argp->cookie);
Josef Sipek225a7192006-12-08 02:37:18 -0800131 memcpy(&lock->fh, NFS_FH(fl->fl_file->f_path.dentry->d_inode), sizeof(struct nfs_fh));
Serge E. Hallyne9ff3992006-10-02 02:18:11 -0700132 lock->caller = utsname()->nodename;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 lock->oh.data = req->a_owner;
Trond Myklebust7bab3772006-03-20 13:44:06 -0500134 lock->oh.len = snprintf(req->a_owner, sizeof(req->a_owner), "%u@%s",
135 (unsigned int)fl->fl_u.nfs_fl.owner->pid,
Serge E. Hallyne9ff3992006-10-02 02:18:11 -0700136 utsname()->nodename);
Trond Myklebust7bab3772006-03-20 13:44:06 -0500137 lock->svid = fl->fl_u.nfs_fl.owner->pid;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500138 lock->fl.fl_start = fl->fl_start;
139 lock->fl.fl_end = fl->fl_end;
140 lock->fl.fl_type = fl->fl_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141}
142
143static void nlmclnt_release_lockargs(struct nlm_rqst *req)
144{
Trond Myklebust3a649b82006-03-20 13:44:44 -0500145 BUG_ON(req->a_args.lock.fl.fl_ops != NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146}
147
Chuck Lever1093a602008-01-11 17:09:59 -0500148/**
149 * nlmclnt_proc - Perform a single client-side lock request
150 * @host: address of a valid nlm_host context representing the NLM server
151 * @cmd: fcntl-style file lock operation to perform
152 * @fl: address of arguments for the lock operation
153 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 */
Chuck Lever1093a602008-01-11 17:09:59 -0500155int nlmclnt_proc(struct nlm_host *host, int cmd, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156{
Trond Myklebust92737232006-03-20 13:44:45 -0500157 struct nlm_rqst *call;
Chuck Lever1093a602008-01-11 17:09:59 -0500158 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
Chuck Lever1093a602008-01-11 17:09:59 -0500160 nlm_get_host(host);
Trond Myklebust92737232006-03-20 13:44:45 -0500161 call = nlm_alloc_call(host);
162 if (call == NULL)
163 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
Trond Myklebust92737232006-03-20 13:44:45 -0500165 nlmclnt_locks_init_private(fl, host);
166 /* Set up the argument struct */
167 nlmclnt_setlockargs(call, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
Trond Myklebust5cd973c2009-06-17 13:23:01 -0700169 lock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 if (IS_SETLK(cmd) || IS_SETLKW(cmd)) {
171 if (fl->fl_type != F_UNLCK) {
172 call->a_args.block = IS_SETLKW(cmd) ? 1 : 0;
173 status = nlmclnt_lock(call, fl);
174 } else
175 status = nlmclnt_unlock(call, fl);
176 } else if (IS_GETLK(cmd))
177 status = nlmclnt_test(call, fl);
178 else
179 status = -EINVAL;
180
Trond Myklebust92737232006-03-20 13:44:45 -0500181 fl->fl_ops->fl_release_private(fl);
182 fl->fl_ops = NULL;
Trond Myklebust5cd973c2009-06-17 13:23:01 -0700183 unlock_kernel();
Trond Myklebust92737232006-03-20 13:44:45 -0500184
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 dprintk("lockd: clnt proc returns %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 return status;
187}
Chuck Lever1093a602008-01-11 17:09:59 -0500188EXPORT_SYMBOL_GPL(nlmclnt_proc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189
190/*
191 * Allocate an NLM RPC call struct
Trond Myklebust92737232006-03-20 13:44:45 -0500192 *
193 * Note: the caller must hold a reference to host. In case of failure,
194 * this reference will be released.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 */
Trond Myklebust92737232006-03-20 13:44:45 -0500196struct nlm_rqst *nlm_alloc_call(struct nlm_host *host)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197{
198 struct nlm_rqst *call;
199
Trond Myklebust36943fa2006-03-20 13:44:05 -0500200 for(;;) {
201 call = kzalloc(sizeof(*call), GFP_KERNEL);
202 if (call != NULL) {
Trond Myklebust5e7f37a2008-04-01 18:58:49 -0400203 atomic_set(&call->a_count, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 locks_init_lock(&call->a_args.lock.fl);
205 locks_init_lock(&call->a_res.lock.fl);
Trond Myklebust92737232006-03-20 13:44:45 -0500206 call->a_host = host;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 return call;
208 }
Trond Myklebust36943fa2006-03-20 13:44:05 -0500209 if (signalled())
210 break;
Trond Myklebust92737232006-03-20 13:44:45 -0500211 printk("nlm_alloc_call: failed, waiting for memory\n");
Nishanth Aravamudan041e0e32005-09-10 00:27:23 -0700212 schedule_timeout_interruptible(5*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 }
Trond Myklebust92737232006-03-20 13:44:45 -0500214 nlm_release_host(host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 return NULL;
216}
217
Trond Myklebust92737232006-03-20 13:44:45 -0500218void nlm_release_call(struct nlm_rqst *call)
219{
Trond Myklebust5e7f37a2008-04-01 18:58:49 -0400220 if (!atomic_dec_and_test(&call->a_count))
221 return;
Trond Myklebust92737232006-03-20 13:44:45 -0500222 nlm_release_host(call->a_host);
223 nlmclnt_release_lockargs(call);
224 kfree(call);
225}
226
227static void nlmclnt_rpc_release(void *data)
228{
Trond Myklebusta86dc492008-06-11 13:37:09 -0400229 lock_kernel();
Trond Myklebust65fdf7d2008-01-11 17:41:29 -0500230 nlm_release_call(data);
Trond Myklebusta86dc492008-06-11 13:37:09 -0400231 unlock_kernel();
Trond Myklebust92737232006-03-20 13:44:45 -0500232}
233
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234static int nlm_wait_on_grace(wait_queue_head_t *queue)
235{
236 DEFINE_WAIT(wait);
237 int status = -EINTR;
238
239 prepare_to_wait(queue, &wait, TASK_INTERRUPTIBLE);
240 if (!signalled ()) {
241 schedule_timeout(NLMCLNT_GRACE_WAIT);
Christoph Lameter3e1d1d22005-06-24 23:13:50 -0700242 try_to_freeze();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 if (!signalled ())
244 status = 0;
245 }
246 finish_wait(queue, &wait);
247 return status;
248}
249
250/*
251 * Generic NLM call
252 */
253static int
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400254nlmclnt_call(struct rpc_cred *cred, struct nlm_rqst *req, u32 proc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255{
256 struct nlm_host *host = req->a_host;
257 struct rpc_clnt *clnt;
258 struct nlm_args *argp = &req->a_args;
259 struct nlm_res *resp = &req->a_res;
260 struct rpc_message msg = {
261 .rpc_argp = argp,
262 .rpc_resp = resp,
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400263 .rpc_cred = cred,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 };
265 int status;
266
267 dprintk("lockd: call procedure %d on %s\n",
268 (int)proc, host->h_name);
269
270 do {
271 if (host->h_reclaiming && !argp->reclaim)
272 goto in_grace_period;
273
274 /* If we have no RPC client yet, create one. */
275 if ((clnt = nlm_bind_host(host)) == NULL)
276 return -ENOLCK;
277 msg.rpc_proc = &clnt->cl_procinfo[proc];
278
279 /* Perform the RPC call. If an error occurs, try again */
280 if ((status = rpc_call_sync(clnt, &msg, 0)) < 0) {
281 dprintk("lockd: rpc_call returned error %d\n", -status);
282 switch (status) {
283 case -EPROTONOSUPPORT:
284 status = -EINVAL;
285 break;
286 case -ECONNREFUSED:
287 case -ETIMEDOUT:
288 case -ENOTCONN:
289 nlm_rebind_host(host);
290 status = -EAGAIN;
291 break;
292 case -ERESTARTSYS:
293 return signalled () ? -EINTR : status;
294 default:
295 break;
296 }
297 break;
298 } else
Al Viroe8c5c042006-12-13 00:35:03 -0800299 if (resp->status == nlm_lck_denied_grace_period) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 dprintk("lockd: server in grace period\n");
301 if (argp->reclaim) {
302 printk(KERN_WARNING
303 "lockd: spurious grace period reject?!\n");
304 return -ENOLCK;
305 }
306 } else {
307 if (!argp->reclaim) {
308 /* We appear to be out of the grace period */
309 wake_up_all(&host->h_gracewait);
310 }
311 dprintk("lockd: server returns status %d\n", resp->status);
312 return 0; /* Okay, call complete */
313 }
314
315in_grace_period:
316 /*
317 * The server has rebooted and appears to be in the grace
318 * period during which locks are only allowed to be
319 * reclaimed.
320 * We can only back off and try again later.
321 */
322 status = nlm_wait_on_grace(&host->h_gracewait);
323 } while (status == 0);
324
325 return status;
326}
327
328/*
329 * Generic NLM call, async version.
330 */
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400331static 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 -0700332{
333 struct nlm_host *host = req->a_host;
334 struct rpc_clnt *clnt;
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400335 struct rpc_task_setup task_setup_data = {
336 .rpc_message = msg,
337 .callback_ops = tk_ops,
338 .callback_data = req,
339 .flags = RPC_TASK_ASYNC,
340 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341
342 dprintk("lockd: call procedure %d on %s (async)\n",
343 (int)proc, host->h_name);
344
345 /* If we have no RPC client yet, create one. */
Trond Myklebust92737232006-03-20 13:44:45 -0500346 clnt = nlm_bind_host(host);
347 if (clnt == NULL)
348 goto out_err;
Trond Myklebustd4716622006-03-20 13:44:45 -0500349 msg->rpc_proc = &clnt->cl_procinfo[proc];
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400350 task_setup_data.rpc_client = clnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351
352 /* bootstrap and kick off the async RPC call */
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400353 return rpc_run_task(&task_setup_data);
Trond Myklebust92737232006-03-20 13:44:45 -0500354out_err:
Trond Myklebusta995e9e2007-02-02 15:37:43 -0800355 tk_ops->rpc_release(req);
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400356 return ERR_PTR(-ENOLCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357}
358
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400359static int nlm_do_async_call(struct nlm_rqst *req, u32 proc, struct rpc_message *msg, const struct rpc_call_ops *tk_ops)
360{
361 struct rpc_task *task;
362
363 task = __nlm_async_call(req, proc, msg, tk_ops);
364 if (IS_ERR(task))
365 return PTR_ERR(task);
366 rpc_put_task(task);
367 return 0;
368}
369
370/*
371 * NLM asynchronous call.
372 */
Trond Myklebustd4716622006-03-20 13:44:45 -0500373int nlm_async_call(struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops)
374{
375 struct rpc_message msg = {
376 .rpc_argp = &req->a_args,
377 .rpc_resp = &req->a_res,
378 };
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400379 return nlm_do_async_call(req, proc, &msg, tk_ops);
Trond Myklebustd4716622006-03-20 13:44:45 -0500380}
381
382int nlm_async_reply(struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops)
383{
384 struct rpc_message msg = {
385 .rpc_argp = &req->a_res,
386 };
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400387 return nlm_do_async_call(req, proc, &msg, tk_ops);
388}
389
390/*
391 * NLM client asynchronous call.
392 *
393 * Note that although the calls are asynchronous, and are therefore
394 * guaranteed to complete, we still always attempt to wait for
395 * completion in order to be able to correctly track the lock
396 * state.
397 */
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400398static 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 -0400399{
400 struct rpc_message msg = {
401 .rpc_argp = &req->a_args,
402 .rpc_resp = &req->a_res,
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400403 .rpc_cred = cred,
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400404 };
405 struct rpc_task *task;
406 int err;
407
408 task = __nlm_async_call(req, proc, &msg, tk_ops);
409 if (IS_ERR(task))
410 return PTR_ERR(task);
411 err = rpc_wait_for_completion_task(task);
412 rpc_put_task(task);
413 return err;
Trond Myklebustd4716622006-03-20 13:44:45 -0500414}
415
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416/*
417 * TEST for the presence of a conflicting lock
418 */
419static int
420nlmclnt_test(struct nlm_rqst *req, struct file_lock *fl)
421{
422 int status;
423
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400424 status = nlmclnt_call(nfs_file_cred(fl->fl_file), req, NLMPROC_TEST);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 if (status < 0)
Trond Myklebust92737232006-03-20 13:44:45 -0500426 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427
Trond Myklebust92737232006-03-20 13:44:45 -0500428 switch (req->a_res.status) {
Al Viroe8c5c042006-12-13 00:35:03 -0800429 case nlm_granted:
Trond Myklebust92737232006-03-20 13:44:45 -0500430 fl->fl_type = F_UNLCK;
431 break;
Al Viroe8c5c042006-12-13 00:35:03 -0800432 case nlm_lck_denied:
Trond Myklebust92737232006-03-20 13:44:45 -0500433 /*
434 * Report the conflicting lock back to the application.
435 */
436 fl->fl_start = req->a_res.lock.fl.fl_start;
Felix Blyakherd67d1c72008-07-15 12:40:22 -0500437 fl->fl_end = req->a_res.lock.fl.fl_end;
Trond Myklebust92737232006-03-20 13:44:45 -0500438 fl->fl_type = req->a_res.lock.fl.fl_type;
439 fl->fl_pid = 0;
440 break;
441 default:
442 status = nlm_stat_to_errno(req->a_res.status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 }
Trond Myklebust92737232006-03-20 13:44:45 -0500444out:
445 nlm_release_call(req);
446 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447}
448
449static void nlmclnt_locks_copy_lock(struct file_lock *new, struct file_lock *fl)
450{
Trond Myklebust4c060b52006-03-20 13:44:41 -0500451 new->fl_u.nfs_fl.state = fl->fl_u.nfs_fl.state;
452 new->fl_u.nfs_fl.owner = nlm_get_lockowner(fl->fl_u.nfs_fl.owner);
453 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 -0700454}
455
456static void nlmclnt_locks_release_private(struct file_lock *fl)
457{
Trond Myklebust4c060b52006-03-20 13:44:41 -0500458 list_del(&fl->fl_u.nfs_fl.list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 nlm_put_lockowner(fl->fl_u.nfs_fl.owner);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460}
461
Alexey Dobriyan6aed6282009-09-21 17:01:11 -0700462static const struct file_lock_operations nlmclnt_lock_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 .fl_copy_lock = nlmclnt_locks_copy_lock,
464 .fl_release_private = nlmclnt_locks_release_private,
465};
466
467static void nlmclnt_locks_init_private(struct file_lock *fl, struct nlm_host *host)
468{
469 BUG_ON(fl->fl_ops != NULL);
470 fl->fl_u.nfs_fl.state = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 fl->fl_u.nfs_fl.owner = nlm_find_lockowner(host, fl->fl_owner);
Trond Myklebust4c060b52006-03-20 13:44:41 -0500472 INIT_LIST_HEAD(&fl->fl_u.nfs_fl.list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 fl->fl_ops = &nlmclnt_lock_ops;
474}
475
Trond Myklebust9b073572006-06-29 16:38:34 -0400476static int do_vfs_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477{
478 int res = 0;
479 switch (fl->fl_flags & (FL_POSIX|FL_FLOCK)) {
480 case FL_POSIX:
481 res = posix_lock_file_wait(fl->fl_file, fl);
482 break;
483 case FL_FLOCK:
484 res = flock_lock_file_wait(fl->fl_file, fl);
485 break;
486 default:
487 BUG();
488 }
Trond Myklebust9b073572006-06-29 16:38:34 -0400489 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490}
491
492/*
493 * LOCK: Try to create a lock
494 *
495 * Programmer Harassment Alert
496 *
497 * When given a blocking lock request in a sync RPC call, the HPUX lockd
498 * will faithfully return LCK_BLOCKED but never cares to notify us when
499 * the lock could be granted. This way, our local process could hang
500 * around forever waiting for the callback.
501 *
502 * Solution A: Implement busy-waiting
503 * Solution B: Use the async version of the call (NLM_LOCK_{MSG,RES})
504 *
505 * For now I am implementing solution A, because I hate the idea of
506 * re-implementing lockd for a third time in two months. The async
507 * calls shouldn't be too hard to do, however.
508 *
509 * This is one of the lovely things about standards in the NFS area:
510 * they're so soft and squishy you can't really blame HP for doing this.
511 */
512static int
513nlmclnt_lock(struct nlm_rqst *req, struct file_lock *fl)
514{
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400515 struct rpc_cred *cred = nfs_file_cred(fl->fl_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 struct nlm_host *host = req->a_host;
517 struct nlm_res *resp = &req->a_res;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500518 struct nlm_wait *block = NULL;
Trond Myklebust01c3b862006-06-29 16:38:39 -0400519 unsigned char fl_flags = fl->fl_flags;
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400520 unsigned char fl_type;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500521 int status = -ENOLCK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522
Chuck Lever501c1ed2008-12-04 14:21:01 -0500523 if (nsm_monitor(host) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 goto out;
Chuck Lever6c9dc4252009-06-17 18:02:10 -0700525 req->a_args.state = nsm_local_state;
Chuck Lever501c1ed2008-12-04 14:21:01 -0500526
Trond Myklebust01c3b862006-06-29 16:38:39 -0400527 fl->fl_flags |= FL_ACCESS;
528 status = do_vfs_lock(fl);
Trond Myklebust4a9af592008-04-01 18:57:06 -0400529 fl->fl_flags = fl_flags;
Trond Myklebust01c3b862006-06-29 16:38:39 -0400530 if (status < 0)
531 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532
Trond Myklebust3a649b82006-03-20 13:44:44 -0500533 block = nlmclnt_prepare_block(host, fl);
Trond Myklebust28df9552006-06-09 09:40:27 -0400534again:
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400535 /*
536 * Initialise resp->status to a valid non-zero value,
537 * since 0 == nlm_lck_granted
538 */
539 resp->status = nlm_lck_blocked;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000540 for(;;) {
Trond Myklebust28df9552006-06-09 09:40:27 -0400541 /* Reboot protection */
542 fl->fl_u.nfs_fl.state = host->h_state;
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400543 status = nlmclnt_call(cred, req, NLMPROC_LOCK);
Trond Myklebustecdbf762005-06-22 17:16:31 +0000544 if (status < 0)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000545 break;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000546 /* Did a reclaimer thread notify us of a server reboot? */
Al Viroe8c5c042006-12-13 00:35:03 -0800547 if (resp->status == nlm_lck_denied_grace_period)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000548 continue;
Al Viroe8c5c042006-12-13 00:35:03 -0800549 if (resp->status != nlm_lck_blocked)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000550 break;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500551 /* Wait on an NLM blocking lock */
552 status = nlmclnt_block(block, req, NLMCLNT_POLL_TIMEOUT);
Trond Myklebust3a649b82006-03-20 13:44:44 -0500553 if (status < 0)
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400554 break;
Al Viroe8c5c042006-12-13 00:35:03 -0800555 if (resp->status != nlm_lck_blocked)
Trond Myklebust3a649b82006-03-20 13:44:44 -0500556 break;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000557 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400559 /* if we were interrupted while blocking, then cancel the lock request
560 * and exit
561 */
562 if (resp->status == nlm_lck_blocked) {
563 if (!req->a_args.block)
564 goto out_unlock;
565 if (nlmclnt_cancel(host, req->a_args.block, fl) == 0)
566 goto out_unblock;
567 }
568
Al Viroe8c5c042006-12-13 00:35:03 -0800569 if (resp->status == nlm_granted) {
Trond Myklebust28df9552006-06-09 09:40:27 -0400570 down_read(&host->h_rwsem);
571 /* Check whether or not the server has rebooted */
572 if (fl->fl_u.nfs_fl.state != host->h_state) {
573 up_read(&host->h_rwsem);
574 goto again;
575 }
Trond Myklebust4c060b52006-03-20 13:44:41 -0500576 /* Ensure the resulting lock will get added to granted list */
Trond Myklebust4a9af592008-04-01 18:57:06 -0400577 fl->fl_flags |= FL_SLEEP;
Trond Myklebust9b073572006-06-29 16:38:34 -0400578 if (do_vfs_lock(fl) < 0)
Harvey Harrison8e24eea2008-04-30 00:55:09 -0700579 printk(KERN_WARNING "%s: VFS is out of sync with lock manager!\n", __func__);
Trond Myklebust28df9552006-06-09 09:40:27 -0400580 up_read(&host->h_rwsem);
Trond Myklebust4a9af592008-04-01 18:57:06 -0400581 fl->fl_flags = fl_flags;
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400582 status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 }
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400584 if (status < 0)
585 goto out_unlock;
Miklos Szeredicc77b152008-07-25 01:48:55 -0700586 /*
587 * EAGAIN doesn't make sense for sleeping locks, and in some
588 * cases NLM_LCK_DENIED is returned for a permanent error. So
589 * turn it into an ENOLCK.
590 */
591 if (resp->status == nlm_lck_denied && (fl_flags & FL_SLEEP))
592 status = -ENOLCK;
593 else
594 status = nlm_stat_to_errno(resp->status);
Trond Myklebustecdbf762005-06-22 17:16:31 +0000595out_unblock:
Trond Myklebust3a649b82006-03-20 13:44:44 -0500596 nlmclnt_finish_block(block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597out:
Trond Myklebust92737232006-03-20 13:44:45 -0500598 nlm_release_call(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 return status;
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400600out_unlock:
601 /* Fatal error: ensure that we remove the lock altogether */
602 dprintk("lockd: lock attempt ended in fatal error.\n"
603 " Attempting to unlock.\n");
604 nlmclnt_finish_block(block);
605 fl_type = fl->fl_type;
606 fl->fl_type = F_UNLCK;
607 down_read(&host->h_rwsem);
608 do_vfs_lock(fl);
609 up_read(&host->h_rwsem);
610 fl->fl_type = fl_type;
611 fl->fl_flags = fl_flags;
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400612 nlmclnt_async_call(cred, req, NLMPROC_UNLOCK, &nlmclnt_unlock_ops);
Trond Myklebust5f50c0c2008-04-01 20:26:22 -0400613 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614}
615
616/*
617 * RECLAIM: Try to reclaim a lock
618 */
619int
620nlmclnt_reclaim(struct nlm_host *host, struct file_lock *fl)
621{
622 struct nlm_rqst reqst, *req;
623 int status;
624
625 req = &reqst;
626 memset(req, 0, sizeof(*req));
627 locks_init_lock(&req->a_args.lock.fl);
628 locks_init_lock(&req->a_res.lock.fl);
629 req->a_host = host;
630 req->a_flags = 0;
631
632 /* Set up the argument struct */
633 nlmclnt_setlockargs(req, fl);
634 req->a_args.reclaim = 1;
635
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400636 status = nlmclnt_call(nfs_file_cred(fl->fl_file), req, NLMPROC_LOCK);
637 if (status >= 0 && req->a_res.status == nlm_granted)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 return 0;
639
640 printk(KERN_WARNING "lockd: failed to reclaim lock for pid %d "
641 "(errno %d, status %d)\n", fl->fl_pid,
Al Viroe8c5c042006-12-13 00:35:03 -0800642 status, ntohl(req->a_res.status));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643
644 /*
645 * FIXME: This is a serious failure. We can
646 *
647 * a. Ignore the problem
648 * b. Send the owning process some signal (Linux doesn't have
649 * SIGLOST, though...)
650 * c. Retry the operation
651 *
652 * Until someone comes up with a simple implementation
653 * for b or c, I'll choose option a.
654 */
655
656 return -ENOLCK;
657}
658
659/*
660 * UNLOCK: remove an existing lock
661 */
662static int
663nlmclnt_unlock(struct nlm_rqst *req, struct file_lock *fl)
664{
Trond Myklebust28df9552006-06-09 09:40:27 -0400665 struct nlm_host *host = req->a_host;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 struct nlm_res *resp = &req->a_res;
Trond Myklebust4a9af592008-04-01 18:57:06 -0400667 int status;
668 unsigned char fl_flags = fl->fl_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669
Christoph Hellwig26bcbf92006-03-20 13:44:40 -0500670 /*
Trond Myklebust30f4e202006-03-13 21:20:49 -0800671 * Note: the server is supposed to either grant us the unlock
672 * request, or to deny it with NLM_LCK_DENIED_GRACE_PERIOD. In either
673 * case, we want to unlock.
674 */
Trond Myklebust9b073572006-06-29 16:38:34 -0400675 fl->fl_flags |= FL_EXISTS;
Trond Myklebust28df9552006-06-09 09:40:27 -0400676 down_read(&host->h_rwsem);
Trond Myklebust4a9af592008-04-01 18:57:06 -0400677 status = do_vfs_lock(fl);
678 up_read(&host->h_rwsem);
679 fl->fl_flags = fl_flags;
680 if (status == -ENOENT) {
681 status = 0;
Trond Myklebust9b073572006-06-29 16:38:34 -0400682 goto out;
683 }
Trond Myklebust30f4e202006-03-13 21:20:49 -0800684
Trond Myklebustdc9d8d02008-03-28 16:04:36 -0400685 atomic_inc(&req->a_count);
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400686 status = nlmclnt_async_call(nfs_file_cred(fl->fl_file), req,
687 NLMPROC_UNLOCK, &nlmclnt_unlock_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 if (status < 0)
Trond Myklebust92737232006-03-20 13:44:45 -0500689 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690
Al Viroe8c5c042006-12-13 00:35:03 -0800691 if (resp->status == nlm_granted)
Trond Myklebust92737232006-03-20 13:44:45 -0500692 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693
Al Viroe8c5c042006-12-13 00:35:03 -0800694 if (resp->status != nlm_lck_denied_nolocks)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 printk("lockd: unexpected unlock status: %d\n", resp->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 /* What to do now? I'm out of my depth... */
Trond Myklebust92737232006-03-20 13:44:45 -0500697 status = -ENOLCK;
698out:
699 nlm_release_call(req);
700 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701}
702
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100703static void nlmclnt_unlock_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: unlock failed (err = %d)\n", -task->tk_status);
713 goto retry_rebind;
714 }
715 if (status == NLM_LCK_DENIED_GRACE_PERIOD) {
716 rpc_delay(task, NLMCLNT_GRACE_WAIT);
717 goto retry_unlock;
718 }
719 if (status != NLM_LCK_GRANTED)
720 printk(KERN_WARNING "lockd: unexpected unlock status: %d\n", status);
721die:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 return;
723 retry_rebind:
Trond Myklebusta86dc492008-06-11 13:37:09 -0400724 lock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725 nlm_rebind_host(req->a_host);
Trond Myklebusta86dc492008-06-11 13:37:09 -0400726 unlock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 retry_unlock:
728 rpc_restart_call(task);
729}
730
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100731static const struct rpc_call_ops nlmclnt_unlock_ops = {
732 .rpc_call_done = nlmclnt_unlock_callback,
Trond Myklebust92737232006-03-20 13:44:45 -0500733 .rpc_release = nlmclnt_rpc_release,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100734};
735
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736/*
737 * Cancel a blocked lock request.
738 * We always use an async RPC call for this in order not to hang a
739 * process that has been Ctrl-C'ed.
740 */
Trond Myklebust16fb2422006-02-01 12:18:22 -0500741static int nlmclnt_cancel(struct nlm_host *host, int block, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742{
743 struct nlm_rqst *req;
Trond Myklebust6b4b3a72008-04-02 14:40:53 -0400744 int status;
745
746 dprintk("lockd: blocking lock attempt was interrupted by a signal.\n"
747 " Attempting to cancel lock.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
Trond Myklebust92737232006-03-20 13:44:45 -0500749 req = nlm_alloc_call(nlm_get_host(host));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 if (!req)
751 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 req->a_flags = RPC_TASK_ASYNC;
753
754 nlmclnt_setlockargs(req, fl);
Trond Myklebust16fb2422006-02-01 12:18:22 -0500755 req->a_args.block = block;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756
Trond Myklebust6b4b3a72008-04-02 14:40:53 -0400757 atomic_inc(&req->a_count);
Trond Myklebustd11d10c2008-04-02 14:44:05 -0400758 status = nlmclnt_async_call(nfs_file_cred(fl->fl_file), req,
759 NLMPROC_CANCEL, &nlmclnt_cancel_ops);
Trond Myklebust6b4b3a72008-04-02 14:40:53 -0400760 if (status == 0 && req->a_res.status == nlm_lck_denied)
761 status = -ENOLCK;
762 nlm_release_call(req);
763 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764}
765
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100766static void nlmclnt_cancel_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767{
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100768 struct nlm_rqst *req = data;
Al Viroe8c5c042006-12-13 00:35:03 -0800769 u32 status = ntohl(req->a_res.status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770
771 if (RPC_ASSASSINATED(task))
772 goto die;
773
774 if (task->tk_status < 0) {
775 dprintk("lockd: CANCEL call error %d, retrying.\n",
776 task->tk_status);
777 goto retry_cancel;
778 }
779
Chuck Leverc041b5f2006-12-05 16:36:03 -0500780 dprintk("lockd: cancel status %u (task %u)\n",
Al Viroe8c5c042006-12-13 00:35:03 -0800781 status, task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782
Al Viroe8c5c042006-12-13 00:35:03 -0800783 switch (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 case NLM_LCK_GRANTED:
785 case NLM_LCK_DENIED_GRACE_PERIOD:
Trond Myklebust35576cb2006-03-20 13:44:41 -0500786 case NLM_LCK_DENIED:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 /* Everything's good */
788 break;
789 case NLM_LCK_DENIED_NOLOCKS:
790 dprintk("lockd: CANCEL failed (server has no locks)\n");
791 goto retry_cancel;
792 default:
793 printk(KERN_NOTICE "lockd: weird return %d for CANCEL call\n",
Al Viroe8c5c042006-12-13 00:35:03 -0800794 status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 }
796
797die:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 return;
799
800retry_cancel:
Trond Myklebustaaaa9942006-02-01 12:18:25 -0500801 /* Don't ever retry more than 3 times */
802 if (req->a_retries++ >= NLMCLNT_MAX_RETRIES)
803 goto die;
Trond Myklebusta86dc492008-06-11 13:37:09 -0400804 lock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 nlm_rebind_host(req->a_host);
Trond Myklebusta86dc492008-06-11 13:37:09 -0400806 unlock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 rpc_restart_call(task);
808 rpc_delay(task, 30 * HZ);
809}
810
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100811static const struct rpc_call_ops nlmclnt_cancel_ops = {
812 .rpc_call_done = nlmclnt_cancel_callback,
Trond Myklebust92737232006-03-20 13:44:45 -0500813 .rpc_release = nlmclnt_rpc_release,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100814};
815
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816/*
817 * Convert an NLM status code to a generic kernel errno
818 */
819static int
Al Viroe8c5c042006-12-13 00:35:03 -0800820nlm_stat_to_errno(__be32 status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821{
Al Viroe8c5c042006-12-13 00:35:03 -0800822 switch(ntohl(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 case NLM_LCK_GRANTED:
824 return 0;
825 case NLM_LCK_DENIED:
826 return -EAGAIN;
827 case NLM_LCK_DENIED_NOLOCKS:
828 case NLM_LCK_DENIED_GRACE_PERIOD:
829 return -ENOLCK;
830 case NLM_LCK_BLOCKED:
831 printk(KERN_NOTICE "lockd: unexpected status NLM_BLOCKED\n");
832 return -ENOLCK;
833#ifdef CONFIG_LOCKD_V4
834 case NLM_DEADLCK:
835 return -EDEADLK;
836 case NLM_ROFS:
837 return -EROFS;
838 case NLM_STALE_FH:
839 return -ESTALE;
840 case NLM_FBIG:
841 return -EOVERFLOW;
842 case NLM_FAILED:
843 return -ENOLCK;
844#endif
845 }
846 printk(KERN_NOTICE "lockd: unexpected server status %d\n", status);
847 return -ENOLCK;
848}