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