xref: /linux/fs/lockd/svclock.c (revision cb299ba8b5ef2239429484072fea394cd7581bd7)
1 /*
2  * linux/fs/lockd/svclock.c
3  *
4  * Handling of server-side locks, mostly of the blocked variety.
5  * This is the ugliest part of lockd because we tread on very thin ice.
6  * GRANT and CANCEL calls may get stuck, meet in mid-flight, etc.
7  * IMNSHO introducing the grant callback into the NLM protocol was one
8  * of the worst ideas Sun ever had. Except maybe for the idea of doing
9  * NFS file locking at all.
10  *
11  * I'm trying hard to avoid race conditions by protecting most accesses
12  * to a file's list of blocked locks through a semaphore. The global
13  * list of blocked locks is not protected in this fashion however.
14  * Therefore, some functions (such as the RPC callback for the async grant
15  * call) move blocked locks towards the head of the list *while some other
16  * process might be traversing it*. This should not be a problem in
17  * practice, because this will only cause functions traversing the list
18  * to visit some blocks twice.
19  *
20  * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
21  */
22 
23 #include <linux/types.h>
24 #include <linux/slab.h>
25 #include <linux/errno.h>
26 #include <linux/kernel.h>
27 #include <linux/sched.h>
28 #include <linux/smp_lock.h>
29 #include <linux/sunrpc/clnt.h>
30 #include <linux/sunrpc/svc.h>
31 #include <linux/lockd/nlm.h>
32 #include <linux/lockd/lockd.h>
33 #include <linux/kthread.h>
34 
35 #define NLMDBG_FACILITY		NLMDBG_SVCLOCK
36 
37 #ifdef CONFIG_LOCKD_V4
38 #define nlm_deadlock	nlm4_deadlock
39 #else
40 #define nlm_deadlock	nlm_lck_denied
41 #endif
42 
43 static void nlmsvc_release_block(struct nlm_block *block);
44 static void	nlmsvc_insert_block(struct nlm_block *block, unsigned long);
45 static void	nlmsvc_remove_block(struct nlm_block *block);
46 
47 static int nlmsvc_setgrantargs(struct nlm_rqst *call, struct nlm_lock *lock);
48 static void nlmsvc_freegrantargs(struct nlm_rqst *call);
49 static const struct rpc_call_ops nlmsvc_grant_ops;
50 
51 /*
52  * The list of blocked locks to retry
53  */
54 static LIST_HEAD(nlm_blocked);
55 static DEFINE_SPINLOCK(nlm_blocked_lock);
56 
57 /*
58  * Insert a blocked lock into the global list
59  */
60 static void
61 nlmsvc_insert_block_locked(struct nlm_block *block, unsigned long when)
62 {
63 	struct nlm_block *b;
64 	struct list_head *pos;
65 
66 	dprintk("lockd: nlmsvc_insert_block(%p, %ld)\n", block, when);
67 	if (list_empty(&block->b_list)) {
68 		kref_get(&block->b_count);
69 	} else {
70 		list_del_init(&block->b_list);
71 	}
72 
73 	pos = &nlm_blocked;
74 	if (when != NLM_NEVER) {
75 		if ((when += jiffies) == NLM_NEVER)
76 			when ++;
77 		list_for_each(pos, &nlm_blocked) {
78 			b = list_entry(pos, struct nlm_block, b_list);
79 			if (time_after(b->b_when,when) || b->b_when == NLM_NEVER)
80 				break;
81 		}
82 		/* On normal exit from the loop, pos == &nlm_blocked,
83 		 * so we will be adding to the end of the list - good
84 		 */
85 	}
86 
87 	list_add_tail(&block->b_list, pos);
88 	block->b_when = when;
89 }
90 
91 static void nlmsvc_insert_block(struct nlm_block *block, unsigned long when)
92 {
93 	spin_lock(&nlm_blocked_lock);
94 	nlmsvc_insert_block_locked(block, when);
95 	spin_unlock(&nlm_blocked_lock);
96 }
97 
98 /*
99  * Remove a block from the global list
100  */
101 static inline void
102 nlmsvc_remove_block(struct nlm_block *block)
103 {
104 	if (!list_empty(&block->b_list)) {
105 		spin_lock(&nlm_blocked_lock);
106 		list_del_init(&block->b_list);
107 		spin_unlock(&nlm_blocked_lock);
108 		nlmsvc_release_block(block);
109 	}
110 }
111 
112 /*
113  * Find a block for a given lock
114  */
115 static struct nlm_block *
116 nlmsvc_lookup_block(struct nlm_file *file, struct nlm_lock *lock)
117 {
118 	struct nlm_block	*block;
119 	struct file_lock	*fl;
120 
121 	dprintk("lockd: nlmsvc_lookup_block f=%p pd=%d %Ld-%Ld ty=%d\n",
122 				file, lock->fl.fl_pid,
123 				(long long)lock->fl.fl_start,
124 				(long long)lock->fl.fl_end, lock->fl.fl_type);
125 	list_for_each_entry(block, &nlm_blocked, b_list) {
126 		fl = &block->b_call->a_args.lock.fl;
127 		dprintk("lockd: check f=%p pd=%d %Ld-%Ld ty=%d cookie=%s\n",
128 				block->b_file, fl->fl_pid,
129 				(long long)fl->fl_start,
130 				(long long)fl->fl_end, fl->fl_type,
131 				nlmdbg_cookie2a(&block->b_call->a_args.cookie));
132 		if (block->b_file == file && nlm_compare_locks(fl, &lock->fl)) {
133 			kref_get(&block->b_count);
134 			return block;
135 		}
136 	}
137 
138 	return NULL;
139 }
140 
141 static inline int nlm_cookie_match(struct nlm_cookie *a, struct nlm_cookie *b)
142 {
143 	if (a->len != b->len)
144 		return 0;
145 	if (memcmp(a->data, b->data, a->len))
146 		return 0;
147 	return 1;
148 }
149 
150 /*
151  * Find a block with a given NLM cookie.
152  */
153 static inline struct nlm_block *
154 nlmsvc_find_block(struct nlm_cookie *cookie)
155 {
156 	struct nlm_block *block;
157 
158 	list_for_each_entry(block, &nlm_blocked, b_list) {
159 		if (nlm_cookie_match(&block->b_call->a_args.cookie,cookie))
160 			goto found;
161 	}
162 
163 	return NULL;
164 
165 found:
166 	dprintk("nlmsvc_find_block(%s): block=%p\n", nlmdbg_cookie2a(cookie), block);
167 	kref_get(&block->b_count);
168 	return block;
169 }
170 
171 /*
172  * Create a block and initialize it.
173  *
174  * Note: we explicitly set the cookie of the grant reply to that of
175  * the blocked lock request. The spec explicitly mentions that the client
176  * should _not_ rely on the callback containing the same cookie as the
177  * request, but (as I found out later) that's because some implementations
178  * do just this. Never mind the standards comittees, they support our
179  * logging industries.
180  *
181  * 10 years later: I hope we can safely ignore these old and broken
182  * clients by now. Let's fix this so we can uniquely identify an incoming
183  * GRANTED_RES message by cookie, without having to rely on the client's IP
184  * address. --okir
185  */
186 static struct nlm_block *
187 nlmsvc_create_block(struct svc_rqst *rqstp, struct nlm_host *host,
188 		    struct nlm_file *file, struct nlm_lock *lock,
189 		    struct nlm_cookie *cookie)
190 {
191 	struct nlm_block	*block;
192 	struct nlm_rqst		*call = NULL;
193 
194 	nlm_get_host(host);
195 	call = nlm_alloc_call(host);
196 	if (call == NULL)
197 		return NULL;
198 
199 	/* Allocate memory for block, and initialize arguments */
200 	block = kzalloc(sizeof(*block), GFP_KERNEL);
201 	if (block == NULL)
202 		goto failed;
203 	kref_init(&block->b_count);
204 	INIT_LIST_HEAD(&block->b_list);
205 	INIT_LIST_HEAD(&block->b_flist);
206 
207 	if (!nlmsvc_setgrantargs(call, lock))
208 		goto failed_free;
209 
210 	/* Set notifier function for VFS, and init args */
211 	call->a_args.lock.fl.fl_flags |= FL_SLEEP;
212 	call->a_args.lock.fl.fl_lmops = &nlmsvc_lock_operations;
213 	nlmclnt_next_cookie(&call->a_args.cookie);
214 
215 	dprintk("lockd: created block %p...\n", block);
216 
217 	/* Create and initialize the block */
218 	block->b_daemon = rqstp->rq_server;
219 	block->b_host   = host;
220 	block->b_file   = file;
221 	block->b_fl = NULL;
222 	file->f_count++;
223 
224 	/* Add to file's list of blocks */
225 	list_add(&block->b_flist, &file->f_blocks);
226 
227 	/* Set up RPC arguments for callback */
228 	block->b_call = call;
229 	call->a_flags   = RPC_TASK_ASYNC;
230 	call->a_block = block;
231 
232 	return block;
233 
234 failed_free:
235 	kfree(block);
236 failed:
237 	nlm_release_call(call);
238 	return NULL;
239 }
240 
241 /*
242  * Delete a block.
243  * It is the caller's responsibility to check whether the file
244  * can be closed hereafter.
245  */
246 static int nlmsvc_unlink_block(struct nlm_block *block)
247 {
248 	int status;
249 	dprintk("lockd: unlinking block %p...\n", block);
250 
251 	/* Remove block from list */
252 	status = posix_unblock_lock(block->b_file->f_file, &block->b_call->a_args.lock.fl);
253 	nlmsvc_remove_block(block);
254 	return status;
255 }
256 
257 static void nlmsvc_free_block(struct kref *kref)
258 {
259 	struct nlm_block *block = container_of(kref, struct nlm_block, b_count);
260 	struct nlm_file		*file = block->b_file;
261 
262 	dprintk("lockd: freeing block %p...\n", block);
263 
264 	/* Remove block from file's list of blocks */
265 	mutex_lock(&file->f_mutex);
266 	list_del_init(&block->b_flist);
267 	mutex_unlock(&file->f_mutex);
268 
269 	nlmsvc_freegrantargs(block->b_call);
270 	nlm_release_call(block->b_call);
271 	nlm_release_file(block->b_file);
272 	kfree(block->b_fl);
273 	kfree(block);
274 }
275 
276 static void nlmsvc_release_block(struct nlm_block *block)
277 {
278 	if (block != NULL)
279 		kref_put(&block->b_count, nlmsvc_free_block);
280 }
281 
282 /*
283  * Loop over all blocks and delete blocks held by
284  * a matching host.
285  */
286 void nlmsvc_traverse_blocks(struct nlm_host *host,
287 			struct nlm_file *file,
288 			nlm_host_match_fn_t match)
289 {
290 	struct nlm_block *block, *next;
291 
292 restart:
293 	mutex_lock(&file->f_mutex);
294 	list_for_each_entry_safe(block, next, &file->f_blocks, b_flist) {
295 		if (!match(block->b_host, host))
296 			continue;
297 		/* Do not destroy blocks that are not on
298 		 * the global retry list - why? */
299 		if (list_empty(&block->b_list))
300 			continue;
301 		kref_get(&block->b_count);
302 		mutex_unlock(&file->f_mutex);
303 		nlmsvc_unlink_block(block);
304 		nlmsvc_release_block(block);
305 		goto restart;
306 	}
307 	mutex_unlock(&file->f_mutex);
308 }
309 
310 /*
311  * Initialize arguments for GRANTED call. The nlm_rqst structure
312  * has been cleared already.
313  */
314 static int nlmsvc_setgrantargs(struct nlm_rqst *call, struct nlm_lock *lock)
315 {
316 	locks_copy_lock(&call->a_args.lock.fl, &lock->fl);
317 	memcpy(&call->a_args.lock.fh, &lock->fh, sizeof(call->a_args.lock.fh));
318 	call->a_args.lock.caller = utsname()->nodename;
319 	call->a_args.lock.oh.len = lock->oh.len;
320 
321 	/* set default data area */
322 	call->a_args.lock.oh.data = call->a_owner;
323 	call->a_args.lock.svid = lock->fl.fl_pid;
324 
325 	if (lock->oh.len > NLMCLNT_OHSIZE) {
326 		void *data = kmalloc(lock->oh.len, GFP_KERNEL);
327 		if (!data)
328 			return 0;
329 		call->a_args.lock.oh.data = (u8 *) data;
330 	}
331 
332 	memcpy(call->a_args.lock.oh.data, lock->oh.data, lock->oh.len);
333 	return 1;
334 }
335 
336 static void nlmsvc_freegrantargs(struct nlm_rqst *call)
337 {
338 	if (call->a_args.lock.oh.data != call->a_owner)
339 		kfree(call->a_args.lock.oh.data);
340 
341 	locks_release_private(&call->a_args.lock.fl);
342 }
343 
344 /*
345  * Deferred lock request handling for non-blocking lock
346  */
347 static __be32
348 nlmsvc_defer_lock_rqst(struct svc_rqst *rqstp, struct nlm_block *block)
349 {
350 	__be32 status = nlm_lck_denied_nolocks;
351 
352 	block->b_flags |= B_QUEUED;
353 
354 	nlmsvc_insert_block(block, NLM_TIMEOUT);
355 
356 	block->b_cache_req = &rqstp->rq_chandle;
357 	if (rqstp->rq_chandle.defer) {
358 		block->b_deferred_req =
359 			rqstp->rq_chandle.defer(block->b_cache_req);
360 		if (block->b_deferred_req != NULL)
361 			status = nlm_drop_reply;
362 	}
363 	dprintk("lockd: nlmsvc_defer_lock_rqst block %p flags %d status %d\n",
364 		block, block->b_flags, ntohl(status));
365 
366 	return status;
367 }
368 
369 /*
370  * Attempt to establish a lock, and if it can't be granted, block it
371  * if required.
372  */
373 __be32
374 nlmsvc_lock(struct svc_rqst *rqstp, struct nlm_file *file,
375 	    struct nlm_host *host, struct nlm_lock *lock, int wait,
376 	    struct nlm_cookie *cookie, int reclaim)
377 {
378 	struct nlm_block	*block = NULL;
379 	int			error;
380 	__be32			ret;
381 
382 	dprintk("lockd: nlmsvc_lock(%s/%ld, ty=%d, pi=%d, %Ld-%Ld, bl=%d)\n",
383 				file->f_file->f_path.dentry->d_inode->i_sb->s_id,
384 				file->f_file->f_path.dentry->d_inode->i_ino,
385 				lock->fl.fl_type, lock->fl.fl_pid,
386 				(long long)lock->fl.fl_start,
387 				(long long)lock->fl.fl_end,
388 				wait);
389 
390 	/* Lock file against concurrent access */
391 	mutex_lock(&file->f_mutex);
392 	/* Get existing block (in case client is busy-waiting)
393 	 * or create new block
394 	 */
395 	block = nlmsvc_lookup_block(file, lock);
396 	if (block == NULL) {
397 		block = nlmsvc_create_block(rqstp, host, file, lock, cookie);
398 		ret = nlm_lck_denied_nolocks;
399 		if (block == NULL)
400 			goto out;
401 		lock = &block->b_call->a_args.lock;
402 	} else
403 		lock->fl.fl_flags &= ~FL_SLEEP;
404 
405 	if (block->b_flags & B_QUEUED) {
406 		dprintk("lockd: nlmsvc_lock deferred block %p flags %d\n",
407 							block, block->b_flags);
408 		if (block->b_granted) {
409 			nlmsvc_unlink_block(block);
410 			ret = nlm_granted;
411 			goto out;
412 		}
413 		if (block->b_flags & B_TIMED_OUT) {
414 			nlmsvc_unlink_block(block);
415 			ret = nlm_lck_denied;
416 			goto out;
417 		}
418 		ret = nlm_drop_reply;
419 		goto out;
420 	}
421 
422 	if (locks_in_grace() && !reclaim) {
423 		ret = nlm_lck_denied_grace_period;
424 		goto out;
425 	}
426 	if (reclaim && !locks_in_grace()) {
427 		ret = nlm_lck_denied_grace_period;
428 		goto out;
429 	}
430 
431 	if (!wait)
432 		lock->fl.fl_flags &= ~FL_SLEEP;
433 	error = vfs_lock_file(file->f_file, F_SETLK, &lock->fl, NULL);
434 	lock->fl.fl_flags &= ~FL_SLEEP;
435 
436 	dprintk("lockd: vfs_lock_file returned %d\n", error);
437 	switch (error) {
438 		case 0:
439 			ret = nlm_granted;
440 			goto out;
441 		case -EAGAIN:
442 			/*
443 			 * If this is a blocking request for an
444 			 * already pending lock request then we need
445 			 * to put it back on lockd's block list
446 			 */
447 			if (wait)
448 				break;
449 			ret = nlm_lck_denied;
450 			goto out;
451 		case FILE_LOCK_DEFERRED:
452 			if (wait)
453 				break;
454 			/* Filesystem lock operation is in progress
455 			   Add it to the queue waiting for callback */
456 			ret = nlmsvc_defer_lock_rqst(rqstp, block);
457 			goto out;
458 		case -EDEADLK:
459 			ret = nlm_deadlock;
460 			goto out;
461 		default:			/* includes ENOLCK */
462 			ret = nlm_lck_denied_nolocks;
463 			goto out;
464 	}
465 
466 	ret = nlm_lck_blocked;
467 
468 	/* Append to list of blocked */
469 	nlmsvc_insert_block(block, NLM_NEVER);
470 out:
471 	mutex_unlock(&file->f_mutex);
472 	nlmsvc_release_block(block);
473 	dprintk("lockd: nlmsvc_lock returned %u\n", ret);
474 	return ret;
475 }
476 
477 /*
478  * Test for presence of a conflicting lock.
479  */
480 __be32
481 nlmsvc_testlock(struct svc_rqst *rqstp, struct nlm_file *file,
482 		struct nlm_host *host, struct nlm_lock *lock,
483 		struct nlm_lock *conflock, struct nlm_cookie *cookie)
484 {
485 	struct nlm_block 	*block = NULL;
486 	int			error;
487 	__be32			ret;
488 
489 	dprintk("lockd: nlmsvc_testlock(%s/%ld, ty=%d, %Ld-%Ld)\n",
490 				file->f_file->f_path.dentry->d_inode->i_sb->s_id,
491 				file->f_file->f_path.dentry->d_inode->i_ino,
492 				lock->fl.fl_type,
493 				(long long)lock->fl.fl_start,
494 				(long long)lock->fl.fl_end);
495 
496 	/* Get existing block (in case client is busy-waiting) */
497 	block = nlmsvc_lookup_block(file, lock);
498 
499 	if (block == NULL) {
500 		struct file_lock *conf = kzalloc(sizeof(*conf), GFP_KERNEL);
501 
502 		if (conf == NULL)
503 			return nlm_granted;
504 		block = nlmsvc_create_block(rqstp, host, file, lock, cookie);
505 		if (block == NULL) {
506 			kfree(conf);
507 			return nlm_granted;
508 		}
509 		block->b_fl = conf;
510 	}
511 	if (block->b_flags & B_QUEUED) {
512 		dprintk("lockd: nlmsvc_testlock deferred block %p flags %d fl %p\n",
513 			block, block->b_flags, block->b_fl);
514 		if (block->b_flags & B_TIMED_OUT) {
515 			nlmsvc_unlink_block(block);
516 			ret = nlm_lck_denied;
517 			goto out;
518 		}
519 		if (block->b_flags & B_GOT_CALLBACK) {
520 			nlmsvc_unlink_block(block);
521 			if (block->b_fl != NULL
522 					&& block->b_fl->fl_type != F_UNLCK) {
523 				lock->fl = *block->b_fl;
524 				goto conf_lock;
525 			} else {
526 				ret = nlm_granted;
527 				goto out;
528 			}
529 		}
530 		ret = nlm_drop_reply;
531 		goto out;
532 	}
533 
534 	if (locks_in_grace()) {
535 		ret = nlm_lck_denied_grace_period;
536 		goto out;
537 	}
538 	error = vfs_test_lock(file->f_file, &lock->fl);
539 	if (error == FILE_LOCK_DEFERRED) {
540 		ret = nlmsvc_defer_lock_rqst(rqstp, block);
541 		goto out;
542 	}
543 	if (error) {
544 		ret = nlm_lck_denied_nolocks;
545 		goto out;
546 	}
547 	if (lock->fl.fl_type == F_UNLCK) {
548 		ret = nlm_granted;
549 		goto out;
550 	}
551 
552 conf_lock:
553 	dprintk("lockd: conflicting lock(ty=%d, %Ld-%Ld)\n",
554 		lock->fl.fl_type, (long long)lock->fl.fl_start,
555 		(long long)lock->fl.fl_end);
556 	conflock->caller = "somehost";	/* FIXME */
557 	conflock->len = strlen(conflock->caller);
558 	conflock->oh.len = 0;		/* don't return OH info */
559 	conflock->svid = lock->fl.fl_pid;
560 	conflock->fl.fl_type = lock->fl.fl_type;
561 	conflock->fl.fl_start = lock->fl.fl_start;
562 	conflock->fl.fl_end = lock->fl.fl_end;
563 	ret = nlm_lck_denied;
564 out:
565 	if (block)
566 		nlmsvc_release_block(block);
567 	return ret;
568 }
569 
570 /*
571  * Remove a lock.
572  * This implies a CANCEL call: We send a GRANT_MSG, the client replies
573  * with a GRANT_RES call which gets lost, and calls UNLOCK immediately
574  * afterwards. In this case the block will still be there, and hence
575  * must be removed.
576  */
577 __be32
578 nlmsvc_unlock(struct nlm_file *file, struct nlm_lock *lock)
579 {
580 	int	error;
581 
582 	dprintk("lockd: nlmsvc_unlock(%s/%ld, pi=%d, %Ld-%Ld)\n",
583 				file->f_file->f_path.dentry->d_inode->i_sb->s_id,
584 				file->f_file->f_path.dentry->d_inode->i_ino,
585 				lock->fl.fl_pid,
586 				(long long)lock->fl.fl_start,
587 				(long long)lock->fl.fl_end);
588 
589 	/* First, cancel any lock that might be there */
590 	nlmsvc_cancel_blocked(file, lock);
591 
592 	lock->fl.fl_type = F_UNLCK;
593 	error = vfs_lock_file(file->f_file, F_SETLK, &lock->fl, NULL);
594 
595 	return (error < 0)? nlm_lck_denied_nolocks : nlm_granted;
596 }
597 
598 /*
599  * Cancel a previously blocked request.
600  *
601  * A cancel request always overrides any grant that may currently
602  * be in progress.
603  * The calling procedure must check whether the file can be closed.
604  */
605 __be32
606 nlmsvc_cancel_blocked(struct nlm_file *file, struct nlm_lock *lock)
607 {
608 	struct nlm_block	*block;
609 	int status = 0;
610 
611 	dprintk("lockd: nlmsvc_cancel(%s/%ld, pi=%d, %Ld-%Ld)\n",
612 				file->f_file->f_path.dentry->d_inode->i_sb->s_id,
613 				file->f_file->f_path.dentry->d_inode->i_ino,
614 				lock->fl.fl_pid,
615 				(long long)lock->fl.fl_start,
616 				(long long)lock->fl.fl_end);
617 
618 	if (locks_in_grace())
619 		return nlm_lck_denied_grace_period;
620 
621 	mutex_lock(&file->f_mutex);
622 	block = nlmsvc_lookup_block(file, lock);
623 	mutex_unlock(&file->f_mutex);
624 	if (block != NULL) {
625 		vfs_cancel_lock(block->b_file->f_file,
626 				&block->b_call->a_args.lock.fl);
627 		status = nlmsvc_unlink_block(block);
628 		nlmsvc_release_block(block);
629 	}
630 	return status ? nlm_lck_denied : nlm_granted;
631 }
632 
633 /*
634  * This is a callback from the filesystem for VFS file lock requests.
635  * It will be used if fl_grant is defined and the filesystem can not
636  * respond to the request immediately.
637  * For GETLK request it will copy the reply to the nlm_block.
638  * For SETLK or SETLKW request it will get the local posix lock.
639  * In all cases it will move the block to the head of nlm_blocked q where
640  * nlmsvc_retry_blocked() can send back a reply for SETLKW or revisit the
641  * deferred rpc for GETLK and SETLK.
642  */
643 static void
644 nlmsvc_update_deferred_block(struct nlm_block *block, struct file_lock *conf,
645 			     int result)
646 {
647 	block->b_flags |= B_GOT_CALLBACK;
648 	if (result == 0)
649 		block->b_granted = 1;
650 	else
651 		block->b_flags |= B_TIMED_OUT;
652 	if (conf) {
653 		if (block->b_fl)
654 			__locks_copy_lock(block->b_fl, conf);
655 	}
656 }
657 
658 static int nlmsvc_grant_deferred(struct file_lock *fl, struct file_lock *conf,
659 					int result)
660 {
661 	struct nlm_block *block;
662 	int rc = -ENOENT;
663 
664 	spin_lock(&nlm_blocked_lock);
665 	list_for_each_entry(block, &nlm_blocked, b_list) {
666 		if (nlm_compare_locks(&block->b_call->a_args.lock.fl, fl)) {
667 			dprintk("lockd: nlmsvc_notify_blocked block %p flags %d\n",
668 							block, block->b_flags);
669 			if (block->b_flags & B_QUEUED) {
670 				if (block->b_flags & B_TIMED_OUT) {
671 					rc = -ENOLCK;
672 					break;
673 				}
674 				nlmsvc_update_deferred_block(block, conf, result);
675 			} else if (result == 0)
676 				block->b_granted = 1;
677 
678 			nlmsvc_insert_block_locked(block, 0);
679 			svc_wake_up(block->b_daemon);
680 			rc = 0;
681 			break;
682 		}
683 	}
684 	spin_unlock(&nlm_blocked_lock);
685 	if (rc == -ENOENT)
686 		printk(KERN_WARNING "lockd: grant for unknown block\n");
687 	return rc;
688 }
689 
690 /*
691  * Unblock a blocked lock request. This is a callback invoked from the
692  * VFS layer when a lock on which we blocked is removed.
693  *
694  * This function doesn't grant the blocked lock instantly, but rather moves
695  * the block to the head of nlm_blocked where it can be picked up by lockd.
696  */
697 static void
698 nlmsvc_notify_blocked(struct file_lock *fl)
699 {
700 	struct nlm_block	*block;
701 
702 	dprintk("lockd: VFS unblock notification for block %p\n", fl);
703 	list_for_each_entry(block, &nlm_blocked, b_list) {
704 		if (nlm_compare_locks(&block->b_call->a_args.lock.fl, fl)) {
705 			nlmsvc_insert_block(block, 0);
706 			svc_wake_up(block->b_daemon);
707 			return;
708 		}
709 	}
710 
711 	printk(KERN_WARNING "lockd: notification for unknown block!\n");
712 }
713 
714 static int nlmsvc_same_owner(struct file_lock *fl1, struct file_lock *fl2)
715 {
716 	return fl1->fl_owner == fl2->fl_owner && fl1->fl_pid == fl2->fl_pid;
717 }
718 
719 const struct lock_manager_operations nlmsvc_lock_operations = {
720 	.fl_compare_owner = nlmsvc_same_owner,
721 	.fl_notify = nlmsvc_notify_blocked,
722 	.fl_grant = nlmsvc_grant_deferred,
723 };
724 
725 /*
726  * Try to claim a lock that was previously blocked.
727  *
728  * Note that we use both the RPC_GRANTED_MSG call _and_ an async
729  * RPC thread when notifying the client. This seems like overkill...
730  * Here's why:
731  *  -	we don't want to use a synchronous RPC thread, otherwise
732  *	we might find ourselves hanging on a dead portmapper.
733  *  -	Some lockd implementations (e.g. HP) don't react to
734  *	RPC_GRANTED calls; they seem to insist on RPC_GRANTED_MSG calls.
735  */
736 static void
737 nlmsvc_grant_blocked(struct nlm_block *block)
738 {
739 	struct nlm_file		*file = block->b_file;
740 	struct nlm_lock		*lock = &block->b_call->a_args.lock;
741 	int			error;
742 
743 	dprintk("lockd: grant blocked lock %p\n", block);
744 
745 	kref_get(&block->b_count);
746 
747 	/* Unlink block request from list */
748 	nlmsvc_unlink_block(block);
749 
750 	/* If b_granted is true this means we've been here before.
751 	 * Just retry the grant callback, possibly refreshing the RPC
752 	 * binding */
753 	if (block->b_granted) {
754 		nlm_rebind_host(block->b_host);
755 		goto callback;
756 	}
757 
758 	/* Try the lock operation again */
759 	lock->fl.fl_flags |= FL_SLEEP;
760 	error = vfs_lock_file(file->f_file, F_SETLK, &lock->fl, NULL);
761 	lock->fl.fl_flags &= ~FL_SLEEP;
762 
763 	switch (error) {
764 	case 0:
765 		break;
766 	case FILE_LOCK_DEFERRED:
767 		dprintk("lockd: lock still blocked error %d\n", error);
768 		nlmsvc_insert_block(block, NLM_NEVER);
769 		nlmsvc_release_block(block);
770 		return;
771 	default:
772 		printk(KERN_WARNING "lockd: unexpected error %d in %s!\n",
773 				-error, __func__);
774 		nlmsvc_insert_block(block, 10 * HZ);
775 		nlmsvc_release_block(block);
776 		return;
777 	}
778 
779 callback:
780 	/* Lock was granted by VFS. */
781 	dprintk("lockd: GRANTing blocked lock.\n");
782 	block->b_granted = 1;
783 
784 	/* keep block on the list, but don't reattempt until the RPC
785 	 * completes or the submission fails
786 	 */
787 	nlmsvc_insert_block(block, NLM_NEVER);
788 
789 	/* Call the client -- use a soft RPC task since nlmsvc_retry_blocked
790 	 * will queue up a new one if this one times out
791 	 */
792 	error = nlm_async_call(block->b_call, NLMPROC_GRANTED_MSG,
793 				&nlmsvc_grant_ops);
794 
795 	/* RPC submission failed, wait a bit and retry */
796 	if (error < 0)
797 		nlmsvc_insert_block(block, 10 * HZ);
798 }
799 
800 /*
801  * This is the callback from the RPC layer when the NLM_GRANTED_MSG
802  * RPC call has succeeded or timed out.
803  * Like all RPC callbacks, it is invoked by the rpciod process, so it
804  * better not sleep. Therefore, we put the blocked lock on the nlm_blocked
805  * chain once more in order to have it removed by lockd itself (which can
806  * then sleep on the file semaphore without disrupting e.g. the nfs client).
807  */
808 static void nlmsvc_grant_callback(struct rpc_task *task, void *data)
809 {
810 	struct nlm_rqst		*call = data;
811 	struct nlm_block	*block = call->a_block;
812 	unsigned long		timeout;
813 
814 	dprintk("lockd: GRANT_MSG RPC callback\n");
815 
816 	spin_lock(&nlm_blocked_lock);
817 	/* if the block is not on a list at this point then it has
818 	 * been invalidated. Don't try to requeue it.
819 	 *
820 	 * FIXME: it's possible that the block is removed from the list
821 	 * after this check but before the nlmsvc_insert_block. In that
822 	 * case it will be added back. Perhaps we need better locking
823 	 * for nlm_blocked?
824 	 */
825 	if (list_empty(&block->b_list))
826 		goto out;
827 
828 	/* Technically, we should down the file semaphore here. Since we
829 	 * move the block towards the head of the queue only, no harm
830 	 * can be done, though. */
831 	if (task->tk_status < 0) {
832 		/* RPC error: Re-insert for retransmission */
833 		timeout = 10 * HZ;
834 	} else {
835 		/* Call was successful, now wait for client callback */
836 		timeout = 60 * HZ;
837 	}
838 	nlmsvc_insert_block_locked(block, timeout);
839 	svc_wake_up(block->b_daemon);
840 out:
841 	spin_unlock(&nlm_blocked_lock);
842 }
843 
844 /*
845  * FIXME: nlmsvc_release_block() grabs a mutex.  This is not allowed for an
846  * .rpc_release rpc_call_op
847  */
848 static void nlmsvc_grant_release(void *data)
849 {
850 	struct nlm_rqst		*call = data;
851 	nlmsvc_release_block(call->a_block);
852 }
853 
854 static const struct rpc_call_ops nlmsvc_grant_ops = {
855 	.rpc_call_done = nlmsvc_grant_callback,
856 	.rpc_release = nlmsvc_grant_release,
857 };
858 
859 /*
860  * We received a GRANT_RES callback. Try to find the corresponding
861  * block.
862  */
863 void
864 nlmsvc_grant_reply(struct nlm_cookie *cookie, __be32 status)
865 {
866 	struct nlm_block	*block;
867 
868 	dprintk("grant_reply: looking for cookie %x, s=%d \n",
869 		*(unsigned int *)(cookie->data), status);
870 	if (!(block = nlmsvc_find_block(cookie)))
871 		return;
872 
873 	if (block) {
874 		if (status == nlm_lck_denied_grace_period) {
875 			/* Try again in a couple of seconds */
876 			nlmsvc_insert_block(block, 10 * HZ);
877 		} else {
878 			/* Lock is now held by client, or has been rejected.
879 			 * In both cases, the block should be removed. */
880 			nlmsvc_unlink_block(block);
881 		}
882 	}
883 	nlmsvc_release_block(block);
884 }
885 
886 /* Helper function to handle retry of a deferred block.
887  * If it is a blocking lock, call grant_blocked.
888  * For a non-blocking lock or test lock, revisit the request.
889  */
890 static void
891 retry_deferred_block(struct nlm_block *block)
892 {
893 	if (!(block->b_flags & B_GOT_CALLBACK))
894 		block->b_flags |= B_TIMED_OUT;
895 	nlmsvc_insert_block(block, NLM_TIMEOUT);
896 	dprintk("revisit block %p flags %d\n",	block, block->b_flags);
897 	if (block->b_deferred_req) {
898 		block->b_deferred_req->revisit(block->b_deferred_req, 0);
899 		block->b_deferred_req = NULL;
900 	}
901 }
902 
903 /*
904  * Retry all blocked locks that have been notified. This is where lockd
905  * picks up locks that can be granted, or grant notifications that must
906  * be retransmitted.
907  */
908 unsigned long
909 nlmsvc_retry_blocked(void)
910 {
911 	unsigned long	timeout = MAX_SCHEDULE_TIMEOUT;
912 	struct nlm_block *block;
913 
914 	while (!list_empty(&nlm_blocked) && !kthread_should_stop()) {
915 		block = list_entry(nlm_blocked.next, struct nlm_block, b_list);
916 
917 		if (block->b_when == NLM_NEVER)
918 			break;
919 		if (time_after(block->b_when, jiffies)) {
920 			timeout = block->b_when - jiffies;
921 			break;
922 		}
923 
924 		dprintk("nlmsvc_retry_blocked(%p, when=%ld)\n",
925 			block, block->b_when);
926 		if (block->b_flags & B_QUEUED) {
927 			dprintk("nlmsvc_retry_blocked delete block (%p, granted=%d, flags=%d)\n",
928 				block, block->b_granted, block->b_flags);
929 			retry_deferred_block(block);
930 		} else
931 			nlmsvc_grant_blocked(block);
932 	}
933 
934 	return timeout;
935 }
936