blob: a5c019e1a44762bb63601accb17bb6b7a2671552 [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>
15#include <linux/smp_lock.h>
Nigel Cunningham7dfb7102006-12-06 20:34:23 -080016#include <linux/freezer.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/sunrpc/clnt.h>
18#include <linux/sunrpc/svc.h>
19#include <linux/lockd/lockd.h>
20#include <linux/lockd/sm_inter.h>
21
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);
131 argp->state = nsm_local_state;
Josef Sipek225a7192006-12-08 02:37:18 -0800132 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 -0700133 lock->caller = utsname()->nodename;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 lock->oh.data = req->a_owner;
Trond Myklebust7bab3772006-03-20 13:44:06 -0500135 lock->oh.len = snprintf(req->a_owner, sizeof(req->a_owner), "%u@%s",
136 (unsigned int)fl->fl_u.nfs_fl.owner->pid,
Serge E. Hallyne9ff3992006-10-02 02:18:11 -0700137 utsname()->nodename);
Trond Myklebust7bab3772006-03-20 13:44:06 -0500138 lock->svid = fl->fl_u.nfs_fl.owner->pid;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500139 lock->fl.fl_start = fl->fl_start;
140 lock->fl.fl_end = fl->fl_end;
141 lock->fl.fl_type = fl->fl_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142}
143
144static void nlmclnt_release_lockargs(struct nlm_rqst *req)
145{
Trond Myklebust3a649b82006-03-20 13:44:44 -0500146 BUG_ON(req->a_args.lock.fl.fl_ops != NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147}
148
149/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 * This is the main entry point for the NLM client.
151 */
152int
153nlmclnt_proc(struct inode *inode, int cmd, struct file_lock *fl)
154{
Chuck Lever44c31be2006-08-22 20:06:17 -0400155 struct rpc_clnt *client = NFS_CLIENT(inode);
156 struct sockaddr_in addr;
Olaf Kirchdb4e4c92006-10-04 02:15:52 -0700157 struct nfs_server *nfssrv = NFS_SERVER(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 struct nlm_host *host;
Trond Myklebust92737232006-03-20 13:44:45 -0500159 struct nlm_rqst *call;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 sigset_t oldset;
161 unsigned long flags;
Chuck Lever44c31be2006-08-22 20:06:17 -0400162 int status, vers;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
164 vers = (NFS_PROTO(inode)->version == 3) ? 4 : 1;
165 if (NFS_PROTO(inode)->version > 3) {
166 printk(KERN_NOTICE "NFSv4 file locking not implemented!\n");
167 return -ENOLCK;
168 }
169
Chuck Lever44c31be2006-08-22 20:06:17 -0400170 rpc_peeraddr(client, (struct sockaddr *) &addr, sizeof(addr));
Olaf Kirchdb4e4c92006-10-04 02:15:52 -0700171 host = nlmclnt_lookup_host(&addr, client->cl_xprt->prot, vers,
172 nfssrv->nfs_client->cl_hostname,
173 strlen(nfssrv->nfs_client->cl_hostname));
Trond Myklebust92737232006-03-20 13:44:45 -0500174 if (host == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 return -ENOLCK;
176
Trond Myklebust92737232006-03-20 13:44:45 -0500177 call = nlm_alloc_call(host);
178 if (call == NULL)
179 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180
Trond Myklebust92737232006-03-20 13:44:45 -0500181 nlmclnt_locks_init_private(fl, host);
182 /* Set up the argument struct */
183 nlmclnt_setlockargs(call, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
185 /* Keep the old signal mask */
186 spin_lock_irqsave(&current->sighand->siglock, flags);
187 oldset = current->blocked;
188
189 /* If we're cleaning up locks because the process is exiting,
190 * perform the RPC call asynchronously. */
191 if ((IS_SETLK(cmd) || IS_SETLKW(cmd))
192 && fl->fl_type == F_UNLCK
193 && (current->flags & PF_EXITING)) {
194 sigfillset(&current->blocked); /* Mask all signals */
195 recalc_sigpending();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 call->a_flags = RPC_TASK_ASYNC;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 }
Trond Myklebust92737232006-03-20 13:44:45 -0500199 spin_unlock_irqrestore(&current->sighand->siglock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
201 if (IS_SETLK(cmd) || IS_SETLKW(cmd)) {
202 if (fl->fl_type != F_UNLCK) {
203 call->a_args.block = IS_SETLKW(cmd) ? 1 : 0;
204 status = nlmclnt_lock(call, fl);
205 } else
206 status = nlmclnt_unlock(call, fl);
207 } else if (IS_GETLK(cmd))
208 status = nlmclnt_test(call, fl);
209 else
210 status = -EINVAL;
211
Trond Myklebust92737232006-03-20 13:44:45 -0500212 fl->fl_ops->fl_release_private(fl);
213 fl->fl_ops = NULL;
214
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 spin_lock_irqsave(&current->sighand->siglock, flags);
216 current->blocked = oldset;
217 recalc_sigpending();
218 spin_unlock_irqrestore(&current->sighand->siglock, flags);
219
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 dprintk("lockd: clnt proc returns %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 return status;
222}
223EXPORT_SYMBOL(nlmclnt_proc);
224
225/*
226 * Allocate an NLM RPC call struct
Trond Myklebust92737232006-03-20 13:44:45 -0500227 *
228 * Note: the caller must hold a reference to host. In case of failure,
229 * this reference will be released.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 */
Trond Myklebust92737232006-03-20 13:44:45 -0500231struct nlm_rqst *nlm_alloc_call(struct nlm_host *host)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232{
233 struct nlm_rqst *call;
234
Trond Myklebust36943fa2006-03-20 13:44:05 -0500235 for(;;) {
236 call = kzalloc(sizeof(*call), GFP_KERNEL);
237 if (call != NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 locks_init_lock(&call->a_args.lock.fl);
239 locks_init_lock(&call->a_res.lock.fl);
Trond Myklebust92737232006-03-20 13:44:45 -0500240 call->a_host = host;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 return call;
242 }
Trond Myklebust36943fa2006-03-20 13:44:05 -0500243 if (signalled())
244 break;
Trond Myklebust92737232006-03-20 13:44:45 -0500245 printk("nlm_alloc_call: failed, waiting for memory\n");
Nishanth Aravamudan041e0e32005-09-10 00:27:23 -0700246 schedule_timeout_interruptible(5*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 }
Trond Myklebust92737232006-03-20 13:44:45 -0500248 nlm_release_host(host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 return NULL;
250}
251
Trond Myklebust92737232006-03-20 13:44:45 -0500252void nlm_release_call(struct nlm_rqst *call)
253{
254 nlm_release_host(call->a_host);
255 nlmclnt_release_lockargs(call);
256 kfree(call);
257}
258
259static void nlmclnt_rpc_release(void *data)
260{
261 return nlm_release_call(data);
262}
263
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264static int nlm_wait_on_grace(wait_queue_head_t *queue)
265{
266 DEFINE_WAIT(wait);
267 int status = -EINTR;
268
269 prepare_to_wait(queue, &wait, TASK_INTERRUPTIBLE);
270 if (!signalled ()) {
271 schedule_timeout(NLMCLNT_GRACE_WAIT);
Christoph Lameter3e1d1d22005-06-24 23:13:50 -0700272 try_to_freeze();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 if (!signalled ())
274 status = 0;
275 }
276 finish_wait(queue, &wait);
277 return status;
278}
279
280/*
281 * Generic NLM call
282 */
283static int
284nlmclnt_call(struct nlm_rqst *req, u32 proc)
285{
286 struct nlm_host *host = req->a_host;
287 struct rpc_clnt *clnt;
288 struct nlm_args *argp = &req->a_args;
289 struct nlm_res *resp = &req->a_res;
290 struct rpc_message msg = {
291 .rpc_argp = argp,
292 .rpc_resp = resp,
293 };
294 int status;
295
296 dprintk("lockd: call procedure %d on %s\n",
297 (int)proc, host->h_name);
298
299 do {
300 if (host->h_reclaiming && !argp->reclaim)
301 goto in_grace_period;
302
303 /* If we have no RPC client yet, create one. */
304 if ((clnt = nlm_bind_host(host)) == NULL)
305 return -ENOLCK;
306 msg.rpc_proc = &clnt->cl_procinfo[proc];
307
308 /* Perform the RPC call. If an error occurs, try again */
309 if ((status = rpc_call_sync(clnt, &msg, 0)) < 0) {
310 dprintk("lockd: rpc_call returned error %d\n", -status);
311 switch (status) {
312 case -EPROTONOSUPPORT:
313 status = -EINVAL;
314 break;
315 case -ECONNREFUSED:
316 case -ETIMEDOUT:
317 case -ENOTCONN:
318 nlm_rebind_host(host);
319 status = -EAGAIN;
320 break;
321 case -ERESTARTSYS:
322 return signalled () ? -EINTR : status;
323 default:
324 break;
325 }
326 break;
327 } else
Al Viroe8c5c042006-12-13 00:35:03 -0800328 if (resp->status == nlm_lck_denied_grace_period) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 dprintk("lockd: server in grace period\n");
330 if (argp->reclaim) {
331 printk(KERN_WARNING
332 "lockd: spurious grace period reject?!\n");
333 return -ENOLCK;
334 }
335 } else {
336 if (!argp->reclaim) {
337 /* We appear to be out of the grace period */
338 wake_up_all(&host->h_gracewait);
339 }
340 dprintk("lockd: server returns status %d\n", resp->status);
341 return 0; /* Okay, call complete */
342 }
343
344in_grace_period:
345 /*
346 * The server has rebooted and appears to be in the grace
347 * period during which locks are only allowed to be
348 * reclaimed.
349 * We can only back off and try again later.
350 */
351 status = nlm_wait_on_grace(&host->h_gracewait);
352 } while (status == 0);
353
354 return status;
355}
356
357/*
358 * Generic NLM call, async version.
359 */
Trond Myklebustd4716622006-03-20 13:44:45 -0500360static 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 -0700361{
362 struct nlm_host *host = req->a_host;
363 struct rpc_clnt *clnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364
365 dprintk("lockd: call procedure %d on %s (async)\n",
366 (int)proc, host->h_name);
367
368 /* If we have no RPC client yet, create one. */
Trond Myklebust92737232006-03-20 13:44:45 -0500369 clnt = nlm_bind_host(host);
370 if (clnt == NULL)
371 goto out_err;
Trond Myklebustd4716622006-03-20 13:44:45 -0500372 msg->rpc_proc = &clnt->cl_procinfo[proc];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373
374 /* bootstrap and kick off the async RPC call */
Trond Myklebusta995e9e2007-02-02 15:37:43 -0800375 return rpc_call_async(clnt, msg, RPC_TASK_ASYNC, tk_ops, req);
Trond Myklebust92737232006-03-20 13:44:45 -0500376out_err:
Trond Myklebusta995e9e2007-02-02 15:37:43 -0800377 tk_ops->rpc_release(req);
378 return -ENOLCK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379}
380
Trond Myklebustd4716622006-03-20 13:44:45 -0500381int nlm_async_call(struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops)
382{
383 struct rpc_message msg = {
384 .rpc_argp = &req->a_args,
385 .rpc_resp = &req->a_res,
386 };
387 return __nlm_async_call(req, proc, &msg, tk_ops);
388}
389
390int nlm_async_reply(struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops)
391{
392 struct rpc_message msg = {
393 .rpc_argp = &req->a_res,
394 };
395 return __nlm_async_call(req, proc, &msg, tk_ops);
396}
397
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398/*
399 * TEST for the presence of a conflicting lock
400 */
401static int
402nlmclnt_test(struct nlm_rqst *req, struct file_lock *fl)
403{
404 int status;
405
406 status = nlmclnt_call(req, NLMPROC_TEST);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 if (status < 0)
Trond Myklebust92737232006-03-20 13:44:45 -0500408 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409
Trond Myklebust92737232006-03-20 13:44:45 -0500410 switch (req->a_res.status) {
Al Viroe8c5c042006-12-13 00:35:03 -0800411 case nlm_granted:
Trond Myklebust92737232006-03-20 13:44:45 -0500412 fl->fl_type = F_UNLCK;
413 break;
Al Viroe8c5c042006-12-13 00:35:03 -0800414 case nlm_lck_denied:
Trond Myklebust92737232006-03-20 13:44:45 -0500415 /*
416 * Report the conflicting lock back to the application.
417 */
418 fl->fl_start = req->a_res.lock.fl.fl_start;
419 fl->fl_end = req->a_res.lock.fl.fl_start;
420 fl->fl_type = req->a_res.lock.fl.fl_type;
421 fl->fl_pid = 0;
422 break;
423 default:
424 status = nlm_stat_to_errno(req->a_res.status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 }
Trond Myklebust92737232006-03-20 13:44:45 -0500426out:
427 nlm_release_call(req);
428 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429}
430
431static void nlmclnt_locks_copy_lock(struct file_lock *new, struct file_lock *fl)
432{
Trond Myklebust4c060b52006-03-20 13:44:41 -0500433 new->fl_u.nfs_fl.state = fl->fl_u.nfs_fl.state;
434 new->fl_u.nfs_fl.owner = nlm_get_lockowner(fl->fl_u.nfs_fl.owner);
435 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 -0700436}
437
438static void nlmclnt_locks_release_private(struct file_lock *fl)
439{
Trond Myklebust4c060b52006-03-20 13:44:41 -0500440 list_del(&fl->fl_u.nfs_fl.list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 nlm_put_lockowner(fl->fl_u.nfs_fl.owner);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442}
443
444static struct file_lock_operations nlmclnt_lock_ops = {
445 .fl_copy_lock = nlmclnt_locks_copy_lock,
446 .fl_release_private = nlmclnt_locks_release_private,
447};
448
449static void nlmclnt_locks_init_private(struct file_lock *fl, struct nlm_host *host)
450{
451 BUG_ON(fl->fl_ops != NULL);
452 fl->fl_u.nfs_fl.state = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 fl->fl_u.nfs_fl.owner = nlm_find_lockowner(host, fl->fl_owner);
Trond Myklebust4c060b52006-03-20 13:44:41 -0500454 INIT_LIST_HEAD(&fl->fl_u.nfs_fl.list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 fl->fl_ops = &nlmclnt_lock_ops;
456}
457
Trond Myklebust9b073572006-06-29 16:38:34 -0400458static int do_vfs_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459{
460 int res = 0;
461 switch (fl->fl_flags & (FL_POSIX|FL_FLOCK)) {
462 case FL_POSIX:
463 res = posix_lock_file_wait(fl->fl_file, fl);
464 break;
465 case FL_FLOCK:
466 res = flock_lock_file_wait(fl->fl_file, fl);
467 break;
468 default:
469 BUG();
470 }
Trond Myklebust9b073572006-06-29 16:38:34 -0400471 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472}
473
474/*
475 * LOCK: Try to create a lock
476 *
477 * Programmer Harassment Alert
478 *
479 * When given a blocking lock request in a sync RPC call, the HPUX lockd
480 * will faithfully return LCK_BLOCKED but never cares to notify us when
481 * the lock could be granted. This way, our local process could hang
482 * around forever waiting for the callback.
483 *
484 * Solution A: Implement busy-waiting
485 * Solution B: Use the async version of the call (NLM_LOCK_{MSG,RES})
486 *
487 * For now I am implementing solution A, because I hate the idea of
488 * re-implementing lockd for a third time in two months. The async
489 * calls shouldn't be too hard to do, however.
490 *
491 * This is one of the lovely things about standards in the NFS area:
492 * they're so soft and squishy you can't really blame HP for doing this.
493 */
494static int
495nlmclnt_lock(struct nlm_rqst *req, struct file_lock *fl)
496{
497 struct nlm_host *host = req->a_host;
498 struct nlm_res *resp = &req->a_res;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500499 struct nlm_wait *block = NULL;
Trond Myklebust01c3b862006-06-29 16:38:39 -0400500 unsigned char fl_flags = fl->fl_flags;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500501 int status = -ENOLCK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502
Olaf Kirch977faf32006-10-04 02:15:51 -0700503 if (nsm_monitor(host) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 printk(KERN_NOTICE "lockd: failed to monitor %s\n",
505 host->h_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 goto out;
507 }
Trond Myklebust01c3b862006-06-29 16:38:39 -0400508 fl->fl_flags |= FL_ACCESS;
509 status = do_vfs_lock(fl);
510 if (status < 0)
511 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
Trond Myklebust3a649b82006-03-20 13:44:44 -0500513 block = nlmclnt_prepare_block(host, fl);
Trond Myklebust28df9552006-06-09 09:40:27 -0400514again:
Trond Myklebustecdbf762005-06-22 17:16:31 +0000515 for(;;) {
Trond Myklebust28df9552006-06-09 09:40:27 -0400516 /* Reboot protection */
517 fl->fl_u.nfs_fl.state = host->h_state;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000518 status = nlmclnt_call(req, NLMPROC_LOCK);
519 if (status < 0)
520 goto out_unblock;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500521 if (!req->a_args.block)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000522 break;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000523 /* Did a reclaimer thread notify us of a server reboot? */
Al Viroe8c5c042006-12-13 00:35:03 -0800524 if (resp->status == nlm_lck_denied_grace_period)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000525 continue;
Al Viroe8c5c042006-12-13 00:35:03 -0800526 if (resp->status != nlm_lck_blocked)
Trond Myklebustecdbf762005-06-22 17:16:31 +0000527 break;
Trond Myklebust3a649b82006-03-20 13:44:44 -0500528 /* Wait on an NLM blocking lock */
529 status = nlmclnt_block(block, req, NLMCLNT_POLL_TIMEOUT);
530 /* if we were interrupted. Send a CANCEL request to the server
Trond Myklebustecdbf762005-06-22 17:16:31 +0000531 * and exit
532 */
Trond Myklebust3a649b82006-03-20 13:44:44 -0500533 if (status < 0)
534 goto out_unblock;
Al Viroe8c5c042006-12-13 00:35:03 -0800535 if (resp->status != nlm_lck_blocked)
Trond Myklebust3a649b82006-03-20 13:44:44 -0500536 break;
Trond Myklebustecdbf762005-06-22 17:16:31 +0000537 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538
Al Viroe8c5c042006-12-13 00:35:03 -0800539 if (resp->status == nlm_granted) {
Trond Myklebust28df9552006-06-09 09:40:27 -0400540 down_read(&host->h_rwsem);
541 /* Check whether or not the server has rebooted */
542 if (fl->fl_u.nfs_fl.state != host->h_state) {
543 up_read(&host->h_rwsem);
544 goto again;
545 }
Trond Myklebust4c060b52006-03-20 13:44:41 -0500546 /* Ensure the resulting lock will get added to granted list */
Trond Myklebust01c3b862006-06-29 16:38:39 -0400547 fl->fl_flags = fl_flags | FL_SLEEP;
Trond Myklebust9b073572006-06-29 16:38:34 -0400548 if (do_vfs_lock(fl) < 0)
549 printk(KERN_WARNING "%s: VFS is out of sync with lock manager!\n", __FUNCTION__);
Trond Myklebust28df9552006-06-09 09:40:27 -0400550 up_read(&host->h_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 }
552 status = nlm_stat_to_errno(resp->status);
Trond Myklebustecdbf762005-06-22 17:16:31 +0000553out_unblock:
Trond Myklebust3a649b82006-03-20 13:44:44 -0500554 nlmclnt_finish_block(block);
Trond Myklebustecdbf762005-06-22 17:16:31 +0000555 /* Cancel the blocked request if it is still pending */
Al Viroe8c5c042006-12-13 00:35:03 -0800556 if (resp->status == nlm_lck_blocked)
Trond Myklebust16fb2422006-02-01 12:18:22 -0500557 nlmclnt_cancel(host, req->a_args.block, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558out:
Trond Myklebust92737232006-03-20 13:44:45 -0500559 nlm_release_call(req);
Trond Myklebust01c3b862006-06-29 16:38:39 -0400560 fl->fl_flags = fl_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 return status;
562}
563
564/*
565 * RECLAIM: Try to reclaim a lock
566 */
567int
568nlmclnt_reclaim(struct nlm_host *host, struct file_lock *fl)
569{
570 struct nlm_rqst reqst, *req;
571 int status;
572
573 req = &reqst;
574 memset(req, 0, sizeof(*req));
575 locks_init_lock(&req->a_args.lock.fl);
576 locks_init_lock(&req->a_res.lock.fl);
577 req->a_host = host;
578 req->a_flags = 0;
579
580 /* Set up the argument struct */
581 nlmclnt_setlockargs(req, fl);
582 req->a_args.reclaim = 1;
583
584 if ((status = nlmclnt_call(req, NLMPROC_LOCK)) >= 0
Al Viroe8c5c042006-12-13 00:35:03 -0800585 && req->a_res.status == nlm_granted)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 return 0;
587
588 printk(KERN_WARNING "lockd: failed to reclaim lock for pid %d "
589 "(errno %d, status %d)\n", fl->fl_pid,
Al Viroe8c5c042006-12-13 00:35:03 -0800590 status, ntohl(req->a_res.status));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591
592 /*
593 * FIXME: This is a serious failure. We can
594 *
595 * a. Ignore the problem
596 * b. Send the owning process some signal (Linux doesn't have
597 * SIGLOST, though...)
598 * c. Retry the operation
599 *
600 * Until someone comes up with a simple implementation
601 * for b or c, I'll choose option a.
602 */
603
604 return -ENOLCK;
605}
606
607/*
608 * UNLOCK: remove an existing lock
609 */
610static int
611nlmclnt_unlock(struct nlm_rqst *req, struct file_lock *fl)
612{
Trond Myklebust28df9552006-06-09 09:40:27 -0400613 struct nlm_host *host = req->a_host;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 struct nlm_res *resp = &req->a_res;
Trond Myklebust9b073572006-06-29 16:38:34 -0400615 int status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616
Christoph Hellwig26bcbf92006-03-20 13:44:40 -0500617 /*
Trond Myklebust30f4e202006-03-13 21:20:49 -0800618 * Note: the server is supposed to either grant us the unlock
619 * request, or to deny it with NLM_LCK_DENIED_GRACE_PERIOD. In either
620 * case, we want to unlock.
621 */
Trond Myklebust9b073572006-06-29 16:38:34 -0400622 fl->fl_flags |= FL_EXISTS;
Trond Myklebust28df9552006-06-09 09:40:27 -0400623 down_read(&host->h_rwsem);
Trond Myklebust9b073572006-06-29 16:38:34 -0400624 if (do_vfs_lock(fl) == -ENOENT) {
625 up_read(&host->h_rwsem);
626 goto out;
627 }
Trond Myklebust28df9552006-06-09 09:40:27 -0400628 up_read(&host->h_rwsem);
Trond Myklebust30f4e202006-03-13 21:20:49 -0800629
Trond Myklebust92737232006-03-20 13:44:45 -0500630 if (req->a_flags & RPC_TASK_ASYNC)
631 return nlm_async_call(req, NLMPROC_UNLOCK, &nlmclnt_unlock_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632
633 status = nlmclnt_call(req, NLMPROC_UNLOCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 if (status < 0)
Trond Myklebust92737232006-03-20 13:44:45 -0500635 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636
Al Viroe8c5c042006-12-13 00:35:03 -0800637 if (resp->status == nlm_granted)
Trond Myklebust92737232006-03-20 13:44:45 -0500638 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639
Al Viroe8c5c042006-12-13 00:35:03 -0800640 if (resp->status != nlm_lck_denied_nolocks)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 printk("lockd: unexpected unlock status: %d\n", resp->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 /* What to do now? I'm out of my depth... */
Trond Myklebust92737232006-03-20 13:44:45 -0500643 status = -ENOLCK;
644out:
645 nlm_release_call(req);
646 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647}
648
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100649static void nlmclnt_unlock_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650{
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100651 struct nlm_rqst *req = data;
Al Viroe8c5c042006-12-13 00:35:03 -0800652 u32 status = ntohl(req->a_res.status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
654 if (RPC_ASSASSINATED(task))
655 goto die;
656
657 if (task->tk_status < 0) {
658 dprintk("lockd: unlock failed (err = %d)\n", -task->tk_status);
659 goto retry_rebind;
660 }
661 if (status == NLM_LCK_DENIED_GRACE_PERIOD) {
662 rpc_delay(task, NLMCLNT_GRACE_WAIT);
663 goto retry_unlock;
664 }
665 if (status != NLM_LCK_GRANTED)
666 printk(KERN_WARNING "lockd: unexpected unlock status: %d\n", status);
667die:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 return;
669 retry_rebind:
670 nlm_rebind_host(req->a_host);
671 retry_unlock:
672 rpc_restart_call(task);
673}
674
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100675static const struct rpc_call_ops nlmclnt_unlock_ops = {
676 .rpc_call_done = nlmclnt_unlock_callback,
Trond Myklebust92737232006-03-20 13:44:45 -0500677 .rpc_release = nlmclnt_rpc_release,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100678};
679
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680/*
681 * Cancel a blocked lock request.
682 * We always use an async RPC call for this in order not to hang a
683 * process that has been Ctrl-C'ed.
684 */
Trond Myklebust16fb2422006-02-01 12:18:22 -0500685static int nlmclnt_cancel(struct nlm_host *host, int block, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686{
687 struct nlm_rqst *req;
688 unsigned long flags;
689 sigset_t oldset;
690 int status;
691
692 /* Block all signals while setting up call */
693 spin_lock_irqsave(&current->sighand->siglock, flags);
694 oldset = current->blocked;
695 sigfillset(&current->blocked);
696 recalc_sigpending();
697 spin_unlock_irqrestore(&current->sighand->siglock, flags);
698
Trond Myklebust92737232006-03-20 13:44:45 -0500699 req = nlm_alloc_call(nlm_get_host(host));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 if (!req)
701 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 req->a_flags = RPC_TASK_ASYNC;
703
704 nlmclnt_setlockargs(req, fl);
Trond Myklebust16fb2422006-02-01 12:18:22 -0500705 req->a_args.block = block;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706
Trond Myklebust92737232006-03-20 13:44:45 -0500707 status = nlm_async_call(req, NLMPROC_CANCEL, &nlmclnt_cancel_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708
709 spin_lock_irqsave(&current->sighand->siglock, flags);
710 current->blocked = oldset;
711 recalc_sigpending();
712 spin_unlock_irqrestore(&current->sighand->siglock, flags);
713
714 return status;
715}
716
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100717static void nlmclnt_cancel_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718{
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100719 struct nlm_rqst *req = data;
Al Viroe8c5c042006-12-13 00:35:03 -0800720 u32 status = ntohl(req->a_res.status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721
722 if (RPC_ASSASSINATED(task))
723 goto die;
724
725 if (task->tk_status < 0) {
726 dprintk("lockd: CANCEL call error %d, retrying.\n",
727 task->tk_status);
728 goto retry_cancel;
729 }
730
Chuck Leverc041b5f2006-12-05 16:36:03 -0500731 dprintk("lockd: cancel status %u (task %u)\n",
Al Viroe8c5c042006-12-13 00:35:03 -0800732 status, task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733
Al Viroe8c5c042006-12-13 00:35:03 -0800734 switch (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 case NLM_LCK_GRANTED:
736 case NLM_LCK_DENIED_GRACE_PERIOD:
Trond Myklebust35576cb2006-03-20 13:44:41 -0500737 case NLM_LCK_DENIED:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 /* Everything's good */
739 break;
740 case NLM_LCK_DENIED_NOLOCKS:
741 dprintk("lockd: CANCEL failed (server has no locks)\n");
742 goto retry_cancel;
743 default:
744 printk(KERN_NOTICE "lockd: weird return %d for CANCEL call\n",
Al Viroe8c5c042006-12-13 00:35:03 -0800745 status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 }
747
748die:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 return;
750
751retry_cancel:
Trond Myklebustaaaa9942006-02-01 12:18:25 -0500752 /* Don't ever retry more than 3 times */
753 if (req->a_retries++ >= NLMCLNT_MAX_RETRIES)
754 goto die;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 nlm_rebind_host(req->a_host);
756 rpc_restart_call(task);
757 rpc_delay(task, 30 * HZ);
758}
759
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100760static const struct rpc_call_ops nlmclnt_cancel_ops = {
761 .rpc_call_done = nlmclnt_cancel_callback,
Trond Myklebust92737232006-03-20 13:44:45 -0500762 .rpc_release = nlmclnt_rpc_release,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100763};
764
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765/*
766 * Convert an NLM status code to a generic kernel errno
767 */
768static int
Al Viroe8c5c042006-12-13 00:35:03 -0800769nlm_stat_to_errno(__be32 status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770{
Al Viroe8c5c042006-12-13 00:35:03 -0800771 switch(ntohl(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 case NLM_LCK_GRANTED:
773 return 0;
774 case NLM_LCK_DENIED:
775 return -EAGAIN;
776 case NLM_LCK_DENIED_NOLOCKS:
777 case NLM_LCK_DENIED_GRACE_PERIOD:
778 return -ENOLCK;
779 case NLM_LCK_BLOCKED:
780 printk(KERN_NOTICE "lockd: unexpected status NLM_BLOCKED\n");
781 return -ENOLCK;
782#ifdef CONFIG_LOCKD_V4
783 case NLM_DEADLCK:
784 return -EDEADLK;
785 case NLM_ROFS:
786 return -EROFS;
787 case NLM_STALE_FH:
788 return -ESTALE;
789 case NLM_FBIG:
790 return -EOVERFLOW;
791 case NLM_FAILED:
792 return -ENOLCK;
793#endif
794 }
795 printk(KERN_NOTICE "lockd: unexpected server status %d\n", status);
796 return -ENOLCK;
797}