svclock.c 19.4 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);
}

333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
/*
 * Deferred lock request handling for non-blocking lock
 */
static u32
nlmsvc_defer_lock_rqst(struct svc_rqst *rqstp, struct nlm_block *block)
{
	u32 status = nlm_lck_denied_nolocks;

	block->b_flags |= B_QUEUED;

	nlmsvc_insert_block(block, NLM_TIMEOUT);

	block->b_cache_req = &rqstp->rq_chandle;
	if (rqstp->rq_chandle.defer) {
		block->b_deferred_req =
			rqstp->rq_chandle.defer(block->b_cache_req);
		if (block->b_deferred_req != NULL)
			status = nlm_drop_reply;
	}
	dprintk("lockd: nlmsvc_defer_lock_rqst block %p flags %d status %d\n",
		block, block->b_flags, status);

	return status;
}

Linus Torvalds's avatar
Linus Torvalds committed
358 359 360 361
/*
 * Attempt to establish a lock, and if it can't be granted, block it
 * if required.
 */
Al Viro's avatar
Al Viro committed
362
__be32
Linus Torvalds's avatar
Linus Torvalds committed
363 364 365
nlmsvc_lock(struct svc_rqst *rqstp, struct nlm_file *file,
			struct nlm_lock *lock, int wait, struct nlm_cookie *cookie)
{
366
	struct nlm_block	*block, *newblock = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
367
	int			error;
Al Viro's avatar
Al Viro committed
368
	__be32			ret;
Linus Torvalds's avatar
Linus Torvalds committed
369 370

	dprintk("lockd: nlmsvc_lock(%s/%ld, ty=%d, pi=%d, %Ld-%Ld, bl=%d)\n",
371 372
				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
373 374 375 376 377 378
				lock->fl.fl_type, lock->fl.fl_pid,
				(long long)lock->fl.fl_start,
				(long long)lock->fl.fl_end,
				wait);


379
	lock->fl.fl_flags &= ~FL_SLEEP;
Linus Torvalds's avatar
Linus Torvalds committed
380 381
again:
	/* Lock file against concurrent access */
382
	mutex_lock(&file->f_mutex);
383
	/* Get existing block (in case client is busy-waiting) */
384
	block = nlmsvc_lookup_block(file, lock);
385 386
	if (block == NULL) {
		if (newblock != NULL)
387
			lock = &newblock->b_call->a_args.lock;
388
	} else
389
		lock = &block->b_call->a_args.lock;
Linus Torvalds's avatar
Linus Torvalds committed
390

391
	error = posix_lock_file(file->f_file, &lock->fl, NULL);
392
	lock->fl.fl_flags &= ~FL_SLEEP;
Linus Torvalds's avatar
Linus Torvalds committed
393

394 395
	dprintk("lockd: posix_lock_file returned %d\n", error);

396
	switch(error) {
Linus Torvalds's avatar
Linus Torvalds committed
397
		case 0:
Andy Adamson's avatar
Andy Adamson committed
398 399
			ret = nlm_granted;
			goto out;
400 401 402
		case -EAGAIN:
			break;
		case -EDEADLK:
Andy Adamson's avatar
Andy Adamson committed
403 404
			ret = nlm_deadlock;
			goto out;
Linus Torvalds's avatar
Linus Torvalds committed
405
		default:			/* includes ENOLCK */
Andy Adamson's avatar
Andy Adamson committed
406 407
			ret = nlm_lck_denied_nolocks;
			goto out;
Linus Torvalds's avatar
Linus Torvalds committed
408 409
	}

410 411 412 413 414 415 416
	ret = nlm_lck_denied;
	if (!wait)
		goto out;

	ret = nlm_lck_blocked;
	if (block != NULL)
		goto out;
Linus Torvalds's avatar
Linus Torvalds committed
417 418 419

	/* If we don't have a block, create and initialize it. Then
	 * retry because we may have slept in kmalloc. */
420
	/* We have to release f_mutex as nlmsvc_create_block may try to
Linus Torvalds's avatar
Linus Torvalds committed
421
	 * to claim it while doing host garbage collection */
422
	if (newblock == NULL) {
423
		mutex_unlock(&file->f_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
424
		dprintk("lockd: blocking on this lock (allocating).\n");
425
		if (!(newblock = nlmsvc_create_block(rqstp, file, lock, cookie)))
Linus Torvalds's avatar
Linus Torvalds committed
426 427 428 429 430
			return nlm_lck_denied_nolocks;
		goto again;
	}

	/* Append to list of blocked */
431
	nlmsvc_insert_block(newblock, NLM_NEVER);
Andy Adamson's avatar
Andy Adamson committed
432
out:
433
	mutex_unlock(&file->f_mutex);
434 435
	nlmsvc_release_block(newblock);
	nlmsvc_release_block(block);
Andy Adamson's avatar
Andy Adamson committed
436 437
	dprintk("lockd: nlmsvc_lock returned %u\n", ret);
	return ret;
Linus Torvalds's avatar
Linus Torvalds committed
438 439 440 441 442
}

/*
 * Test for presence of a conflicting lock.
 */
Al Viro's avatar
Al Viro committed
443
__be32
Linus Torvalds's avatar
Linus Torvalds committed
444 445 446 447
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",
448 449
				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
450 451 452 453
				lock->fl.fl_type,
				(long long)lock->fl.fl_start,
				(long long)lock->fl.fl_end);

454
	if (posix_test_lock(file->f_file, &lock->fl)) {
Linus Torvalds's avatar
Linus Torvalds committed
455
		dprintk("lockd: conflicting lock(ty=%d, %Ld-%Ld)\n",
456 457 458
				lock->fl.fl_type,
				(long long)lock->fl.fl_start,
				(long long)lock->fl.fl_end);
Linus Torvalds's avatar
Linus Torvalds committed
459
		conflock->caller = "somehost";	/* FIXME */
460
		conflock->len = strlen(conflock->caller);
Linus Torvalds's avatar
Linus Torvalds committed
461
		conflock->oh.len = 0;		/* don't return OH info */
462 463 464 465
		conflock->svid = lock->fl.fl_pid;
		conflock->fl.fl_type = lock->fl.fl_type;
		conflock->fl.fl_start = lock->fl.fl_start;
		conflock->fl.fl_end = lock->fl.fl_end;
Linus Torvalds's avatar
Linus Torvalds committed
466 467 468 469 470 471 472 473 474 475 476 477 478
		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
479
__be32
Linus Torvalds's avatar
Linus Torvalds committed
480 481 482 483 484
nlmsvc_unlock(struct nlm_file *file, struct nlm_lock *lock)
{
	int	error;

	dprintk("lockd: nlmsvc_unlock(%s/%ld, pi=%d, %Ld-%Ld)\n",
485 486
				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
487 488 489 490 491 492 493 494
				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;
495
	error = posix_lock_file(file->f_file, &lock->fl, NULL);
Linus Torvalds's avatar
Linus Torvalds committed
496 497 498 499 500 501 502 503 504 505 506

	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
507
__be32
Linus Torvalds's avatar
Linus Torvalds committed
508 509 510
nlmsvc_cancel_blocked(struct nlm_file *file, struct nlm_lock *lock)
{
	struct nlm_block	*block;
J. Bruce Fields's avatar
J. Bruce Fields committed
511
	int status = 0;
Linus Torvalds's avatar
Linus Torvalds committed
512 513

	dprintk("lockd: nlmsvc_cancel(%s/%ld, pi=%d, %Ld-%Ld)\n",
514 515
				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
516 517 518 519
				lock->fl.fl_pid,
				(long long)lock->fl.fl_start,
				(long long)lock->fl.fl_end);

520
	mutex_lock(&file->f_mutex);
521
	block = nlmsvc_lookup_block(file, lock);
522
	mutex_unlock(&file->f_mutex);
523
	if (block != NULL) {
524 525 526
		status = nlmsvc_unlink_block(block);
		nlmsvc_release_block(block);
	}
J. Bruce Fields's avatar
J. Bruce Fields committed
527
	return status ? nlm_lck_denied : nlm_granted;
Linus Torvalds's avatar
Linus Torvalds committed
528 529 530 531 532 533 534 535 536 537 538 539
}

/*
 * 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)
{
540
	struct nlm_block	*block;
Linus Torvalds's avatar
Linus Torvalds committed
541 542

	dprintk("lockd: VFS unblock notification for block %p\n", fl);
543
	list_for_each_entry(block, &nlm_blocked, b_list) {
544
		if (nlm_compare_locks(&block->b_call->a_args.lock.fl, fl)) {
Linus Torvalds's avatar
Linus Torvalds committed
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
			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;
579
	struct nlm_lock		*lock = &block->b_call->a_args.lock;
Linus Torvalds's avatar
Linus Torvalds committed
580 581 582 583 584
	int			error;

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

	/* Unlink block request from list */
585
	nlmsvc_unlink_block(block);
Linus Torvalds's avatar
Linus Torvalds committed
586 587 588 589 590 591 592 593 594 595

	/* 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 */
596
	lock->fl.fl_flags |= FL_SLEEP;
597
	error = posix_lock_file(file->f_file, &lock->fl, NULL);
598 599
	lock->fl.fl_flags &= ~FL_SLEEP;

600 601 602 603
	switch (error) {
	case 0:
		break;
	case -EAGAIN:
Linus Torvalds's avatar
Linus Torvalds committed
604 605
		dprintk("lockd: lock still blocked\n");
		nlmsvc_insert_block(block, NLM_NEVER);
606
		return;
607
	default:
Linus Torvalds's avatar
Linus Torvalds committed
608 609 610
		printk(KERN_WARNING "lockd: unexpected error %d in %s!\n",
				-error, __FUNCTION__);
		nlmsvc_insert_block(block, 10 * HZ);
611
		return;
Linus Torvalds's avatar
Linus Torvalds committed
612 613 614 615 616 617 618 619 620 621 622
	}

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 */
623
	kref_get(&block->b_count);
624
	nlm_async_call(block->b_call, NLMPROC_GRANTED_MSG, &nlmsvc_grant_ops);
Linus Torvalds's avatar
Linus Torvalds committed
625 626 627 628 629 630 631 632 633 634
}

/*
 * 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).
 */
635
static void nlmsvc_grant_callback(struct rpc_task *task, void *data)
Linus Torvalds's avatar
Linus Torvalds committed
636
{
637
	struct nlm_rqst		*call = data;
638
	struct nlm_block	*block = call->a_block;
Linus Torvalds's avatar
Linus Torvalds committed
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654
	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);
655 656
}

Adrian Bunk's avatar
Adrian Bunk committed
657
static void nlmsvc_grant_release(void *data)
658
{
659 660 661
	struct nlm_rqst		*call = data;

	nlmsvc_release_block(call->a_block);
Linus Torvalds's avatar
Linus Torvalds committed
662 663
}

664 665
static const struct rpc_call_ops nlmsvc_grant_ops = {
	.rpc_call_done = nlmsvc_grant_callback,
666
	.rpc_release = nlmsvc_grant_release,
667 668
};

Linus Torvalds's avatar
Linus Torvalds committed
669 670 671 672 673
/*
 * We received a GRANT_RES callback. Try to find the corresponding
 * block.
 */
void
Al Viro's avatar
Al Viro committed
674
nlmsvc_grant_reply(struct nlm_cookie *cookie, __be32 status)
Linus Torvalds's avatar
Linus Torvalds committed
675 676 677
{
	struct nlm_block	*block;

678 679 680
	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
681 682
		return;

683
	if (block) {
Al Viro's avatar
Al Viro committed
684
		if (status == nlm_lck_denied_grace_period) {
Linus Torvalds's avatar
Linus Torvalds committed
685 686 687 688 689
			/* 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. */
690
			nlmsvc_unlink_block(block);
Linus Torvalds's avatar
Linus Torvalds committed
691 692
		}
	}
693
	nlmsvc_release_block(block);
Linus Torvalds's avatar
Linus Torvalds committed
694 695 696 697 698 699 700 701 702 703
}

/*
 * 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)
{
704 705 706 707 708
	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
709 710 711

		if (block->b_when == NLM_NEVER)
			break;
712 713
	        if (time_after(block->b_when,jiffies)) {
			timeout = block->b_when - jiffies;
Linus Torvalds's avatar
Linus Torvalds committed
714
			break;
715 716
		}

J. Bruce Fields's avatar
J. Bruce Fields committed
717 718
		dprintk("nlmsvc_retry_blocked(%p, when=%ld)\n",
			block, block->b_when);
719
		kref_get(&block->b_count);
J. Bruce Fields's avatar
J. Bruce Fields committed
720
		nlmsvc_grant_blocked(block);
721
		nlmsvc_release_block(block);
Linus Torvalds's avatar
Linus Torvalds committed
722 723
	}

724
	return timeout;
Linus Torvalds's avatar
Linus Torvalds committed
725
}