svclock.c 18.7 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
/*
 * linux/fs/lockd/svclock.c
 *
 * Handling of server-side locks, mostly of the blocked variety.
 * This is the ugliest part of lockd because we tread on very thin ice.
 * GRANT and CANCEL calls may get stuck, meet in mid-flight, etc.
 * IMNSHO introducing the grant callback into the NLM protocol was one
 * of the worst ideas Sun ever had. Except maybe for the idea of doing
 * NFS file locking at all.
 *
 * I'm trying hard to avoid race conditions by protecting most accesses
 * to a file's list of blocked locks through a semaphore. The global
 * list of blocked locks is not protected in this fashion however.
 * Therefore, some functions (such as the RPC callback for the async grant
 * call) move blocked locks towards the head of the list *while some other
 * process might be traversing it*. This should not be a problem in
 * practice, because this will only cause functions traversing the list
 * to visit some blocks twice.
 *
 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
 */

#include <linux/types.h>
#include <linux/errno.h>
#include <linux/kernel.h>
#include <linux/sched.h>
#include <linux/smp_lock.h>
#include <linux/sunrpc/clnt.h>
#include <linux/sunrpc/svc.h>
#include <linux/lockd/nlm.h>
#include <linux/lockd/lockd.h>

#define NLMDBG_FACILITY		NLMDBG_SVCLOCK

#ifdef CONFIG_LOCKD_V4
#define nlm_deadlock	nlm4_deadlock
#else
#define nlm_deadlock	nlm_lck_denied
#endif

41
static void nlmsvc_release_block(struct nlm_block *block);
Linus Torvalds's avatar
Linus Torvalds committed
42
static void	nlmsvc_insert_block(struct nlm_block *block, unsigned long);
43
static void	nlmsvc_remove_block(struct nlm_block *block);
44

45 46
static int nlmsvc_setgrantargs(struct nlm_rqst *call, struct nlm_lock *lock);
static void nlmsvc_freegrantargs(struct nlm_rqst *call);
47
static const struct rpc_call_ops nlmsvc_grant_ops;
Linus Torvalds's avatar
Linus Torvalds committed
48 49 50 51

/*
 * The list of blocked locks to retry
 */
52
static LIST_HEAD(nlm_blocked);
Linus Torvalds's avatar
Linus Torvalds committed
53 54 55 56 57 58 59

/*
 * Insert a blocked lock into the global list
 */
static void
nlmsvc_insert_block(struct nlm_block *block, unsigned long when)
{
60 61
	struct nlm_block *b;
	struct list_head *pos;
Linus Torvalds's avatar
Linus Torvalds committed
62 63

	dprintk("lockd: nlmsvc_insert_block(%p, %ld)\n", block, when);
64 65 66 67 68 69 70
	if (list_empty(&block->b_list)) {
		kref_get(&block->b_count);
	} else {
		list_del_init(&block->b_list);
	}

	pos = &nlm_blocked;
Linus Torvalds's avatar
Linus Torvalds committed
71 72 73
	if (when != NLM_NEVER) {
		if ((when += jiffies) == NLM_NEVER)
			when ++;
74 75 76 77 78 79 80 81 82
		list_for_each(pos, &nlm_blocked) {
			b = list_entry(pos, struct nlm_block, b_list);
			if (time_after(b->b_when,when) || b->b_when == NLM_NEVER)
				break;
		}
		/* On normal exit from the loop, pos == &nlm_blocked,
		 * so we will be adding to the end of the list - good
		 */
	}
Linus Torvalds's avatar
Linus Torvalds committed
83

84
	list_add_tail(&block->b_list, pos);
Linus Torvalds's avatar
Linus Torvalds committed
85 86 87 88 89 90
	block->b_when = when;
}

/*
 * Remove a block from the global list
 */
91
static inline void
Linus Torvalds's avatar
Linus Torvalds committed
92 93
nlmsvc_remove_block(struct nlm_block *block)
{
94 95 96
	if (!list_empty(&block->b_list)) {
		list_del_init(&block->b_list);
		nlmsvc_release_block(block);
Linus Torvalds's avatar
Linus Torvalds committed
97 98 99 100
	}
}

/*
101
 * Find a block for a given lock
Linus Torvalds's avatar
Linus Torvalds committed
102 103
 */
static struct nlm_block *
104
nlmsvc_lookup_block(struct nlm_file *file, struct nlm_lock *lock)
Linus Torvalds's avatar
Linus Torvalds committed
105
{
106
	struct nlm_block	*block;
Linus Torvalds's avatar
Linus Torvalds committed
107 108 109 110 111 112
	struct file_lock	*fl;

	dprintk("lockd: nlmsvc_lookup_block f=%p pd=%d %Ld-%Ld ty=%d\n",
				file, lock->fl.fl_pid,
				(long long)lock->fl.fl_start,
				(long long)lock->fl.fl_end, lock->fl.fl_type);
113
	list_for_each_entry(block, &nlm_blocked, b_list) {
114
		fl = &block->b_call->a_args.lock.fl;
Linus Torvalds's avatar
Linus Torvalds committed
115 116 117 118
		dprintk("lockd: check f=%p pd=%d %Ld-%Ld ty=%d cookie=%s\n",
				block->b_file, fl->fl_pid,
				(long long)fl->fl_start,
				(long long)fl->fl_end, fl->fl_type,
119
				nlmdbg_cookie2a(&block->b_call->a_args.cookie));
Linus Torvalds's avatar
Linus Torvalds committed
120
		if (block->b_file == file && nlm_compare_locks(fl, &lock->fl)) {
121
			kref_get(&block->b_count);
Linus Torvalds's avatar
Linus Torvalds committed
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
			return block;
		}
	}

	return NULL;
}

static inline int nlm_cookie_match(struct nlm_cookie *a, struct nlm_cookie *b)
{
	if(a->len != b->len)
		return 0;
	if(memcmp(a->data,b->data,a->len))
		return 0;
	return 1;
}

/*
 * Find a block with a given NLM cookie.
 */
static inline struct nlm_block *
142
nlmsvc_find_block(struct nlm_cookie *cookie)
Linus Torvalds's avatar
Linus Torvalds committed
143 144 145
{
	struct nlm_block *block;

146
	list_for_each_entry(block, &nlm_blocked, b_list) {
147
		if (nlm_cookie_match(&block->b_call->a_args.cookie,cookie))
148
			goto found;
Linus Torvalds's avatar
Linus Torvalds committed
149 150
	}

151 152 153
	return NULL;

found:
154
	dprintk("nlmsvc_find_block(%s): block=%p\n", nlmdbg_cookie2a(cookie), block);
155
	kref_get(&block->b_count);
Linus Torvalds's avatar
Linus Torvalds committed
156 157 158 159 160 161 162 163 164 165 166 167
	return block;
}

/*
 * Create a block and initialize it.
 *
 * Note: we explicitly set the cookie of the grant reply to that of
 * the blocked lock request. The spec explicitly mentions that the client
 * should _not_ rely on the callback containing the same cookie as the
 * request, but (as I found out later) that's because some implementations
 * do just this. Never mind the standards comittees, they support our
 * logging industries.
168 169 170 171 172
 *
 * 10 years later: I hope we can safely ignore these old and broken
 * clients by now. Let's fix this so we can uniquely identify an incoming
 * GRANTED_RES message by cookie, without having to rely on the client's IP
 * address. --okir
Linus Torvalds's avatar
Linus Torvalds committed
173 174 175 176 177 178 179
 */
static inline struct nlm_block *
nlmsvc_create_block(struct svc_rqst *rqstp, struct nlm_file *file,
				struct nlm_lock *lock, struct nlm_cookie *cookie)
{
	struct nlm_block	*block;
	struct nlm_host		*host;
180
	struct nlm_rqst		*call = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
181 182

	/* Create host handle for callback */
183
	host = nlmsvc_lookup_host(rqstp, lock->caller, lock->len);
Linus Torvalds's avatar
Linus Torvalds committed
184 185 186
	if (host == NULL)
		return NULL;

187 188 189 190
	call = nlm_alloc_call(host);
	if (call == NULL)
		return NULL;

Linus Torvalds's avatar
Linus Torvalds committed
191
	/* Allocate memory for block, and initialize arguments */
192 193
	block = kzalloc(sizeof(*block), GFP_KERNEL);
	if (block == NULL)
Linus Torvalds's avatar
Linus Torvalds committed
194
		goto failed;
195
	kref_init(&block->b_count);
196 197
	INIT_LIST_HEAD(&block->b_list);
	INIT_LIST_HEAD(&block->b_flist);
Linus Torvalds's avatar
Linus Torvalds committed
198

199
	if (!nlmsvc_setgrantargs(call, lock))
Linus Torvalds's avatar
Linus Torvalds committed
200 201 202
		goto failed_free;

	/* Set notifier function for VFS, and init args */
203 204
	call->a_args.lock.fl.fl_flags |= FL_SLEEP;
	call->a_args.lock.fl.fl_lmops = &nlmsvc_lock_operations;
205
	nlmclnt_next_cookie(&call->a_args.cookie);
Linus Torvalds's avatar
Linus Torvalds committed
206 207 208 209 210 211 212

	dprintk("lockd: created block %p...\n", block);

	/* Create and initialize the block */
	block->b_daemon = rqstp->rq_server;
	block->b_host   = host;
	block->b_file   = file;
213
	file->f_count++;
Linus Torvalds's avatar
Linus Torvalds committed
214 215

	/* Add to file's list of blocks */
216
	list_add(&block->b_flist, &file->f_blocks);
Linus Torvalds's avatar
Linus Torvalds committed
217 218

	/* Set up RPC arguments for callback */
219
	block->b_call = call;
Linus Torvalds's avatar
Linus Torvalds committed
220
	call->a_flags   = RPC_TASK_ASYNC;
221
	call->a_block = block;
Linus Torvalds's avatar
Linus Torvalds committed
222 223 224 225 226 227

	return block;

failed_free:
	kfree(block);
failed:
228
	nlm_release_call(call);
Linus Torvalds's avatar
Linus Torvalds committed
229 230 231 232 233 234 235 236 237
	return NULL;
}

/*
 * Delete a block. If the lock was cancelled or the grant callback
 * failed, unlock is set to 1.
 * It is the caller's responsibility to check whether the file
 * can be closed hereafter.
 */
238
static int nlmsvc_unlink_block(struct nlm_block *block)
Linus Torvalds's avatar
Linus Torvalds committed
239
{
240
	int status;
241
	dprintk("lockd: unlinking block %p...\n", block);
Linus Torvalds's avatar
Linus Torvalds committed
242 243

	/* Remove block from list */
244
	status = posix_unblock_lock(block->b_file->f_file, &block->b_call->a_args.lock.fl);
Linus Torvalds's avatar
Linus Torvalds committed
245
	nlmsvc_remove_block(block);
246 247
	return status;
}
Linus Torvalds's avatar
Linus Torvalds committed
248

249 250 251 252 253 254
static void nlmsvc_free_block(struct kref *kref)
{
	struct nlm_block *block = container_of(kref, struct nlm_block, b_count);
	struct nlm_file		*file = block->b_file;

	dprintk("lockd: freeing block %p...\n", block);
Linus Torvalds's avatar
Linus Torvalds committed
255 256

	/* Remove block from file's list of blocks */
257
	mutex_lock(&file->f_mutex);
258
	list_del_init(&block->b_flist);
259
	mutex_unlock(&file->f_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
260

261 262
	nlmsvc_freegrantargs(block->b_call);
	nlm_release_call(block->b_call);
263
	nlm_release_file(block->b_file);
Linus Torvalds's avatar
Linus Torvalds committed
264
	kfree(block);
265 266 267 268 269 270
}

static void nlmsvc_release_block(struct nlm_block *block)
{
	if (block != NULL)
		kref_put(&block->b_count, nlmsvc_free_block);
Linus Torvalds's avatar
Linus Torvalds committed
271 272
}

273 274 275 276 277 278 279
/*
 * Loop over all blocks and delete blocks held by
 * a matching host.
 */
void nlmsvc_traverse_blocks(struct nlm_host *host,
			struct nlm_file *file,
			nlm_host_match_fn_t match)
280
{
281
	struct nlm_block *block, *next;
282 283

restart:
284
	mutex_lock(&file->f_mutex);
285
	list_for_each_entry_safe(block, next, &file->f_blocks, b_flist) {
286
		if (!match(block->b_host, host))
287
			continue;
288 289 290
		/* Do not destroy blocks that are not on
		 * the global retry list - why? */
		if (list_empty(&block->b_list))
291 292
			continue;
		kref_get(&block->b_count);
293
		mutex_unlock(&file->f_mutex);
294 295 296 297
		nlmsvc_unlink_block(block);
		nlmsvc_release_block(block);
		goto restart;
	}
298
	mutex_unlock(&file->f_mutex);
299 300
}

301 302 303 304 305 306 307 308
/*
 * Initialize arguments for GRANTED call. The nlm_rqst structure
 * has been cleared already.
 */
static int nlmsvc_setgrantargs(struct nlm_rqst *call, struct nlm_lock *lock)
{
	locks_copy_lock(&call->a_args.lock.fl, &lock->fl);
	memcpy(&call->a_args.lock.fh, &lock->fh, sizeof(call->a_args.lock.fh));
309
	call->a_args.lock.caller = utsname()->nodename;
310 311 312 313 314 315 316 317
	call->a_args.lock.oh.len = lock->oh.len;

	/* set default data area */
	call->a_args.lock.oh.data = call->a_owner;
	call->a_args.lock.svid = lock->fl.fl_pid;

	if (lock->oh.len > NLMCLNT_OHSIZE) {
		void *data = kmalloc(lock->oh.len, GFP_KERNEL);
318
		if (!data)
319 320 321 322 323 324 325 326 327 328
			return 0;
		call->a_args.lock.oh.data = (u8 *) data;
	}

	memcpy(call->a_args.lock.oh.data, lock->oh.data, lock->oh.len);
	return 1;
}

static void nlmsvc_freegrantargs(struct nlm_rqst *call)
{
329
	if (call->a_args.lock.oh.data != call->a_owner)
330 331 332
		kfree(call->a_args.lock.oh.data);
}

Linus Torvalds's avatar
Linus Torvalds committed
333 334 335 336
/*
 * Attempt to establish a lock, and if it can't be granted, block it
 * if required.
 */
Al Viro's avatar
Al Viro committed
337
__be32
Linus Torvalds's avatar
Linus Torvalds committed
338 339 340
nlmsvc_lock(struct svc_rqst *rqstp, struct nlm_file *file,
			struct nlm_lock *lock, int wait, struct nlm_cookie *cookie)
{
341
	struct nlm_block	*block, *newblock = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
342
	int			error;
Al Viro's avatar
Al Viro committed
343
	__be32			ret;
Linus Torvalds's avatar
Linus Torvalds committed
344 345

	dprintk("lockd: nlmsvc_lock(%s/%ld, ty=%d, pi=%d, %Ld-%Ld, bl=%d)\n",
346 347
				file->f_file->f_path.dentry->d_inode->i_sb->s_id,
				file->f_file->f_path.dentry->d_inode->i_ino,
Linus Torvalds's avatar
Linus Torvalds committed
348 349 350 351 352 353
				lock->fl.fl_type, lock->fl.fl_pid,
				(long long)lock->fl.fl_start,
				(long long)lock->fl.fl_end,
				wait);


354
	lock->fl.fl_flags &= ~FL_SLEEP;
Linus Torvalds's avatar
Linus Torvalds committed
355 356
again:
	/* Lock file against concurrent access */
357
	mutex_lock(&file->f_mutex);
358
	/* Get existing block (in case client is busy-waiting) */
359
	block = nlmsvc_lookup_block(file, lock);
360 361
	if (block == NULL) {
		if (newblock != NULL)
362
			lock = &newblock->b_call->a_args.lock;
363
	} else
364
		lock = &block->b_call->a_args.lock;
Linus Torvalds's avatar
Linus Torvalds committed
365

366
	error = posix_lock_file(file->f_file, &lock->fl);
367
	lock->fl.fl_flags &= ~FL_SLEEP;
Linus Torvalds's avatar
Linus Torvalds committed
368

369 370
	dprintk("lockd: posix_lock_file returned %d\n", error);

371
	switch(error) {
Linus Torvalds's avatar
Linus Torvalds committed
372
		case 0:
Andy Adamson's avatar
Andy Adamson committed
373 374
			ret = nlm_granted;
			goto out;
375 376 377
		case -EAGAIN:
			break;
		case -EDEADLK:
Andy Adamson's avatar
Andy Adamson committed
378 379
			ret = nlm_deadlock;
			goto out;
Linus Torvalds's avatar
Linus Torvalds committed
380
		default:			/* includes ENOLCK */
Andy Adamson's avatar
Andy Adamson committed
381 382
			ret = nlm_lck_denied_nolocks;
			goto out;
Linus Torvalds's avatar
Linus Torvalds committed
383 384
	}

385 386 387 388 389 390 391
	ret = nlm_lck_denied;
	if (!wait)
		goto out;

	ret = nlm_lck_blocked;
	if (block != NULL)
		goto out;
Linus Torvalds's avatar
Linus Torvalds committed
392 393 394

	/* If we don't have a block, create and initialize it. Then
	 * retry because we may have slept in kmalloc. */
395
	/* We have to release f_mutex as nlmsvc_create_block may try to
Linus Torvalds's avatar
Linus Torvalds committed
396
	 * to claim it while doing host garbage collection */
397
	if (newblock == NULL) {
398
		mutex_unlock(&file->f_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
399
		dprintk("lockd: blocking on this lock (allocating).\n");
400
		if (!(newblock = nlmsvc_create_block(rqstp, file, lock, cookie)))
Linus Torvalds's avatar
Linus Torvalds committed
401 402 403 404 405
			return nlm_lck_denied_nolocks;
		goto again;
	}

	/* Append to list of blocked */
406
	nlmsvc_insert_block(newblock, NLM_NEVER);
Andy Adamson's avatar
Andy Adamson committed
407
out:
408
	mutex_unlock(&file->f_mutex);
409 410
	nlmsvc_release_block(newblock);
	nlmsvc_release_block(block);
Andy Adamson's avatar
Andy Adamson committed
411 412
	dprintk("lockd: nlmsvc_lock returned %u\n", ret);
	return ret;
Linus Torvalds's avatar
Linus Torvalds committed
413 414 415 416 417
}

/*
 * Test for presence of a conflicting lock.
 */
Al Viro's avatar
Al Viro committed
418
__be32
Linus Torvalds's avatar
Linus Torvalds committed
419 420 421 422
nlmsvc_testlock(struct nlm_file *file, struct nlm_lock *lock,
				       struct nlm_lock *conflock)
{
	dprintk("lockd: nlmsvc_testlock(%s/%ld, ty=%d, %Ld-%Ld)\n",
423 424
				file->f_file->f_path.dentry->d_inode->i_sb->s_id,
				file->f_file->f_path.dentry->d_inode->i_ino,
Linus Torvalds's avatar
Linus Torvalds committed
425 426 427 428
				lock->fl.fl_type,
				(long long)lock->fl.fl_start,
				(long long)lock->fl.fl_end);

429
	if (posix_test_lock(file->f_file, &lock->fl, &conflock->fl)) {
Linus Torvalds's avatar
Linus Torvalds committed
430
		dprintk("lockd: conflicting lock(ty=%d, %Ld-%Ld)\n",
431 432 433
				conflock->fl.fl_type,
				(long long)conflock->fl.fl_start,
				(long long)conflock->fl.fl_end);
Linus Torvalds's avatar
Linus Torvalds committed
434
		conflock->caller = "somehost";	/* FIXME */
435
		conflock->len = strlen(conflock->caller);
Linus Torvalds's avatar
Linus Torvalds committed
436
		conflock->oh.len = 0;		/* don't return OH info */
437
		conflock->svid = conflock->fl.fl_pid;
Linus Torvalds's avatar
Linus Torvalds committed
438 439 440 441 442 443 444 445 446 447 448 449 450
		return nlm_lck_denied;
	}

	return nlm_granted;
}

/*
 * Remove a lock.
 * This implies a CANCEL call: We send a GRANT_MSG, the client replies
 * with a GRANT_RES call which gets lost, and calls UNLOCK immediately
 * afterwards. In this case the block will still be there, and hence
 * must be removed.
 */
Al Viro's avatar
Al Viro committed
451
__be32
Linus Torvalds's avatar
Linus Torvalds committed
452 453 454 455 456
nlmsvc_unlock(struct nlm_file *file, struct nlm_lock *lock)
{
	int	error;

	dprintk("lockd: nlmsvc_unlock(%s/%ld, pi=%d, %Ld-%Ld)\n",
457 458
				file->f_file->f_path.dentry->d_inode->i_sb->s_id,
				file->f_file->f_path.dentry->d_inode->i_ino,
Linus Torvalds's avatar
Linus Torvalds committed
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
				lock->fl.fl_pid,
				(long long)lock->fl.fl_start,
				(long long)lock->fl.fl_end);

	/* First, cancel any lock that might be there */
	nlmsvc_cancel_blocked(file, lock);

	lock->fl.fl_type = F_UNLCK;
	error = posix_lock_file(file->f_file, &lock->fl);

	return (error < 0)? nlm_lck_denied_nolocks : nlm_granted;
}

/*
 * Cancel a previously blocked request.
 *
 * A cancel request always overrides any grant that may currently
 * be in progress.
 * The calling procedure must check whether the file can be closed.
 */
Al Viro's avatar
Al Viro committed
479
__be32
Linus Torvalds's avatar
Linus Torvalds committed
480 481 482
nlmsvc_cancel_blocked(struct nlm_file *file, struct nlm_lock *lock)
{
	struct nlm_block	*block;
J. Bruce Fields's avatar
J. Bruce Fields committed
483
	int status = 0;
Linus Torvalds's avatar
Linus Torvalds committed
484 485

	dprintk("lockd: nlmsvc_cancel(%s/%ld, pi=%d, %Ld-%Ld)\n",
486 487
				file->f_file->f_path.dentry->d_inode->i_sb->s_id,
				file->f_file->f_path.dentry->d_inode->i_ino,
Linus Torvalds's avatar
Linus Torvalds committed
488 489 490 491
				lock->fl.fl_pid,
				(long long)lock->fl.fl_start,
				(long long)lock->fl.fl_end);

492
	mutex_lock(&file->f_mutex);
493
	block = nlmsvc_lookup_block(file, lock);
494
	mutex_unlock(&file->f_mutex);
495
	if (block != NULL) {
496 497 498
		status = nlmsvc_unlink_block(block);
		nlmsvc_release_block(block);
	}
J. Bruce Fields's avatar
J. Bruce Fields committed
499
	return status ? nlm_lck_denied : nlm_granted;
Linus Torvalds's avatar
Linus Torvalds committed
500 501 502 503 504 505 506 507 508 509 510 511
}

/*
 * Unblock a blocked lock request. This is a callback invoked from the
 * VFS layer when a lock on which we blocked is removed.
 *
 * This function doesn't grant the blocked lock instantly, but rather moves
 * the block to the head of nlm_blocked where it can be picked up by lockd.
 */
static void
nlmsvc_notify_blocked(struct file_lock *fl)
{
512
	struct nlm_block	*block;
Linus Torvalds's avatar
Linus Torvalds committed
513 514

	dprintk("lockd: VFS unblock notification for block %p\n", fl);
515
	list_for_each_entry(block, &nlm_blocked, b_list) {
516
		if (nlm_compare_locks(&block->b_call->a_args.lock.fl, fl)) {
Linus Torvalds's avatar
Linus Torvalds committed
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
			nlmsvc_insert_block(block, 0);
			svc_wake_up(block->b_daemon);
			return;
		}
	}

	printk(KERN_WARNING "lockd: notification for unknown block!\n");
}

static int nlmsvc_same_owner(struct file_lock *fl1, struct file_lock *fl2)
{
	return fl1->fl_owner == fl2->fl_owner && fl1->fl_pid == fl2->fl_pid;
}

struct lock_manager_operations nlmsvc_lock_operations = {
	.fl_compare_owner = nlmsvc_same_owner,
	.fl_notify = nlmsvc_notify_blocked,
};

/*
 * Try to claim a lock that was previously blocked.
 *
 * Note that we use both the RPC_GRANTED_MSG call _and_ an async
 * RPC thread when notifying the client. This seems like overkill...
 * Here's why:
 *  -	we don't want to use a synchronous RPC thread, otherwise
 *	we might find ourselves hanging on a dead portmapper.
 *  -	Some lockd implementations (e.g. HP) don't react to
 *	RPC_GRANTED calls; they seem to insist on RPC_GRANTED_MSG calls.
 */
static void
nlmsvc_grant_blocked(struct nlm_block *block)
{
	struct nlm_file		*file = block->b_file;
551
	struct nlm_lock		*lock = &block->b_call->a_args.lock;
Linus Torvalds's avatar
Linus Torvalds committed
552 553 554 555 556
	int			error;

	dprintk("lockd: grant blocked lock %p\n", block);

	/* Unlink block request from list */
557
	nlmsvc_unlink_block(block);
Linus Torvalds's avatar
Linus Torvalds committed
558 559 560 561 562 563 564 565 566 567

	/* If b_granted is true this means we've been here before.
	 * Just retry the grant callback, possibly refreshing the RPC
	 * binding */
	if (block->b_granted) {
		nlm_rebind_host(block->b_host);
		goto callback;
	}

	/* Try the lock operation again */
568
	lock->fl.fl_flags |= FL_SLEEP;
569
	error = posix_lock_file(file->f_file, &lock->fl);
570 571
	lock->fl.fl_flags &= ~FL_SLEEP;

572 573 574 575
	switch (error) {
	case 0:
		break;
	case -EAGAIN:
Linus Torvalds's avatar
Linus Torvalds committed
576 577
		dprintk("lockd: lock still blocked\n");
		nlmsvc_insert_block(block, NLM_NEVER);
578
		return;
579
	default:
Linus Torvalds's avatar
Linus Torvalds committed
580 581 582
		printk(KERN_WARNING "lockd: unexpected error %d in %s!\n",
				-error, __FUNCTION__);
		nlmsvc_insert_block(block, 10 * HZ);
583
		return;
Linus Torvalds's avatar
Linus Torvalds committed
584 585 586 587 588 589 590 591 592 593 594
	}

callback:
	/* Lock was granted by VFS. */
	dprintk("lockd: GRANTing blocked lock.\n");
	block->b_granted = 1;

	/* Schedule next grant callback in 30 seconds */
	nlmsvc_insert_block(block, 30 * HZ);

	/* Call the client */
595
	kref_get(&block->b_count);
596
	if (nlm_async_call(block->b_call, NLMPROC_GRANTED_MSG,
597
						&nlmsvc_grant_ops) < 0)
598
		nlmsvc_release_block(block);
Linus Torvalds's avatar
Linus Torvalds committed
599 600 601 602 603 604 605 606 607 608
}

/*
 * This is the callback from the RPC layer when the NLM_GRANTED_MSG
 * RPC call has succeeded or timed out.
 * Like all RPC callbacks, it is invoked by the rpciod process, so it
 * better not sleep. Therefore, we put the blocked lock on the nlm_blocked
 * chain once more in order to have it removed by lockd itself (which can
 * then sleep on the file semaphore without disrupting e.g. the nfs client).
 */
609
static void nlmsvc_grant_callback(struct rpc_task *task, void *data)
Linus Torvalds's avatar
Linus Torvalds committed
610
{
611
	struct nlm_rqst		*call = data;
612
	struct nlm_block	*block = call->a_block;
Linus Torvalds's avatar
Linus Torvalds committed
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
	unsigned long		timeout;

	dprintk("lockd: GRANT_MSG RPC callback\n");

	/* Technically, we should down the file semaphore here. Since we
	 * move the block towards the head of the queue only, no harm
	 * can be done, though. */
	if (task->tk_status < 0) {
		/* RPC error: Re-insert for retransmission */
		timeout = 10 * HZ;
	} else {
		/* Call was successful, now wait for client callback */
		timeout = 60 * HZ;
	}
	nlmsvc_insert_block(block, timeout);
	svc_wake_up(block->b_daemon);
629 630
}

Adrian Bunk's avatar
Adrian Bunk committed
631
static void nlmsvc_grant_release(void *data)
632
{
633 634 635
	struct nlm_rqst		*call = data;

	nlmsvc_release_block(call->a_block);
Linus Torvalds's avatar
Linus Torvalds committed
636 637
}

638 639
static const struct rpc_call_ops nlmsvc_grant_ops = {
	.rpc_call_done = nlmsvc_grant_callback,
640
	.rpc_release = nlmsvc_grant_release,
641 642
};

Linus Torvalds's avatar
Linus Torvalds committed
643 644 645 646 647
/*
 * We received a GRANT_RES callback. Try to find the corresponding
 * block.
 */
void
648
nlmsvc_grant_reply(struct nlm_cookie *cookie, u32 status)
Linus Torvalds's avatar
Linus Torvalds committed
649 650 651
{
	struct nlm_block	*block;

652 653 654
	dprintk("grant_reply: looking for cookie %x, s=%d \n",
		*(unsigned int *)(cookie->data), status);
	if (!(block = nlmsvc_find_block(cookie)))
Linus Torvalds's avatar
Linus Torvalds committed
655 656
		return;

657
	if (block) {
Linus Torvalds's avatar
Linus Torvalds committed
658 659 660 661 662 663
		if (status == NLM_LCK_DENIED_GRACE_PERIOD) {
			/* Try again in a couple of seconds */
			nlmsvc_insert_block(block, 10 * HZ);
		} else {
			/* Lock is now held by client, or has been rejected.
			 * In both cases, the block should be removed. */
664
			nlmsvc_unlink_block(block);
Linus Torvalds's avatar
Linus Torvalds committed
665 666
		}
	}
667
	nlmsvc_release_block(block);
Linus Torvalds's avatar
Linus Torvalds committed
668 669 670 671 672 673 674 675 676 677
}

/*
 * Retry all blocked locks that have been notified. This is where lockd
 * picks up locks that can be granted, or grant notifications that must
 * be retransmitted.
 */
unsigned long
nlmsvc_retry_blocked(void)
{
678 679 680 681 682
	unsigned long	timeout = MAX_SCHEDULE_TIMEOUT;
	struct nlm_block *block;

	while (!list_empty(&nlm_blocked)) {
		block = list_entry(nlm_blocked.next, struct nlm_block, b_list);
Linus Torvalds's avatar
Linus Torvalds committed
683 684 685

		if (block->b_when == NLM_NEVER)
			break;
686 687
	        if (time_after(block->b_when,jiffies)) {
			timeout = block->b_when - jiffies;
Linus Torvalds's avatar
Linus Torvalds committed
688
			break;
689 690
		}

J. Bruce Fields's avatar
J. Bruce Fields committed
691 692
		dprintk("nlmsvc_retry_blocked(%p, when=%ld)\n",
			block, block->b_when);
693
		kref_get(&block->b_count);
J. Bruce Fields's avatar
J. Bruce Fields committed
694
		nlmsvc_grant_blocked(block);
695
		nlmsvc_release_block(block);
Linus Torvalds's avatar
Linus Torvalds committed
696 697
	}

698
	return timeout;
Linus Torvalds's avatar
Linus Torvalds committed
699
}