locks: pass inode pointer to locks_free_lock_context
[linux-2.6-block.git] / fs / locks.c
... / ...
CommitLineData
1/*
2 * linux/fs/locks.c
3 *
4 * Provide support for fcntl()'s F_GETLK, F_SETLK, and F_SETLKW calls.
5 * Doug Evans (dje@spiff.uucp), August 07, 1992
6 *
7 * Deadlock detection added.
8 * FIXME: one thing isn't handled yet:
9 * - mandatory locks (requires lots of changes elsewhere)
10 * Kelly Carmichael (kelly@[142.24.8.65]), September 17, 1994.
11 *
12 * Miscellaneous edits, and a total rewrite of posix_lock_file() code.
13 * Kai Petzke (wpp@marie.physik.tu-berlin.de), 1994
14 *
15 * Converted file_lock_table to a linked list from an array, which eliminates
16 * the limits on how many active file locks are open.
17 * Chad Page (pageone@netcom.com), November 27, 1994
18 *
19 * Removed dependency on file descriptors. dup()'ed file descriptors now
20 * get the same locks as the original file descriptors, and a close() on
21 * any file descriptor removes ALL the locks on the file for the current
22 * process. Since locks still depend on the process id, locks are inherited
23 * after an exec() but not after a fork(). This agrees with POSIX, and both
24 * BSD and SVR4 practice.
25 * Andy Walker (andy@lysaker.kvaerner.no), February 14, 1995
26 *
27 * Scrapped free list which is redundant now that we allocate locks
28 * dynamically with kmalloc()/kfree().
29 * Andy Walker (andy@lysaker.kvaerner.no), February 21, 1995
30 *
31 * Implemented two lock personalities - FL_FLOCK and FL_POSIX.
32 *
33 * FL_POSIX locks are created with calls to fcntl() and lockf() through the
34 * fcntl() system call. They have the semantics described above.
35 *
36 * FL_FLOCK locks are created with calls to flock(), through the flock()
37 * system call, which is new. Old C libraries implement flock() via fcntl()
38 * and will continue to use the old, broken implementation.
39 *
40 * FL_FLOCK locks follow the 4.4 BSD flock() semantics. They are associated
41 * with a file pointer (filp). As a result they can be shared by a parent
42 * process and its children after a fork(). They are removed when the last
43 * file descriptor referring to the file pointer is closed (unless explicitly
44 * unlocked).
45 *
46 * FL_FLOCK locks never deadlock, an existing lock is always removed before
47 * upgrading from shared to exclusive (or vice versa). When this happens
48 * any processes blocked by the current lock are woken up and allowed to
49 * run before the new lock is applied.
50 * Andy Walker (andy@lysaker.kvaerner.no), June 09, 1995
51 *
52 * Removed some race conditions in flock_lock_file(), marked other possible
53 * races. Just grep for FIXME to see them.
54 * Dmitry Gorodchanin (pgmdsg@ibi.com), February 09, 1996.
55 *
56 * Addressed Dmitry's concerns. Deadlock checking no longer recursive.
57 * Lock allocation changed to GFP_ATOMIC as we can't afford to sleep
58 * once we've checked for blocking and deadlocking.
59 * Andy Walker (andy@lysaker.kvaerner.no), April 03, 1996.
60 *
61 * Initial implementation of mandatory locks. SunOS turned out to be
62 * a rotten model, so I implemented the "obvious" semantics.
63 * See 'Documentation/filesystems/mandatory-locking.txt' for details.
64 * Andy Walker (andy@lysaker.kvaerner.no), April 06, 1996.
65 *
66 * Don't allow mandatory locks on mmap()'ed files. Added simple functions to
67 * check if a file has mandatory locks, used by mmap(), open() and creat() to
68 * see if system call should be rejected. Ref. HP-UX/SunOS/Solaris Reference
69 * Manual, Section 2.
70 * Andy Walker (andy@lysaker.kvaerner.no), April 09, 1996.
71 *
72 * Tidied up block list handling. Added '/proc/locks' interface.
73 * Andy Walker (andy@lysaker.kvaerner.no), April 24, 1996.
74 *
75 * Fixed deadlock condition for pathological code that mixes calls to
76 * flock() and fcntl().
77 * Andy Walker (andy@lysaker.kvaerner.no), April 29, 1996.
78 *
79 * Allow only one type of locking scheme (FL_POSIX or FL_FLOCK) to be in use
80 * for a given file at a time. Changed the CONFIG_LOCK_MANDATORY scheme to
81 * guarantee sensible behaviour in the case where file system modules might
82 * be compiled with different options than the kernel itself.
83 * Andy Walker (andy@lysaker.kvaerner.no), May 15, 1996.
84 *
85 * Added a couple of missing wake_up() calls. Thanks to Thomas Meckel
86 * (Thomas.Meckel@mni.fh-giessen.de) for spotting this.
87 * Andy Walker (andy@lysaker.kvaerner.no), May 15, 1996.
88 *
89 * Changed FL_POSIX locks to use the block list in the same way as FL_FLOCK
90 * locks. Changed process synchronisation to avoid dereferencing locks that
91 * have already been freed.
92 * Andy Walker (andy@lysaker.kvaerner.no), Sep 21, 1996.
93 *
94 * Made the block list a circular list to minimise searching in the list.
95 * Andy Walker (andy@lysaker.kvaerner.no), Sep 25, 1996.
96 *
97 * Made mandatory locking a mount option. Default is not to allow mandatory
98 * locking.
99 * Andy Walker (andy@lysaker.kvaerner.no), Oct 04, 1996.
100 *
101 * Some adaptations for NFS support.
102 * Olaf Kirch (okir@monad.swb.de), Dec 1996,
103 *
104 * Fixed /proc/locks interface so that we can't overrun the buffer we are handed.
105 * Andy Walker (andy@lysaker.kvaerner.no), May 12, 1997.
106 *
107 * Use slab allocator instead of kmalloc/kfree.
108 * Use generic list implementation from <linux/list.h>.
109 * Sped up posix_locks_deadlock by only considering blocked locks.
110 * Matthew Wilcox <willy@debian.org>, March, 2000.
111 *
112 * Leases and LOCK_MAND
113 * Matthew Wilcox <willy@debian.org>, June, 2000.
114 * Stephen Rothwell <sfr@canb.auug.org.au>, June, 2000.
115 */
116
117#include <linux/capability.h>
118#include <linux/file.h>
119#include <linux/fdtable.h>
120#include <linux/fs.h>
121#include <linux/init.h>
122#include <linux/security.h>
123#include <linux/slab.h>
124#include <linux/syscalls.h>
125#include <linux/time.h>
126#include <linux/rcupdate.h>
127#include <linux/pid_namespace.h>
128#include <linux/hashtable.h>
129#include <linux/percpu.h>
130#include <linux/lglock.h>
131
132#define CREATE_TRACE_POINTS
133#include <trace/events/filelock.h>
134
135#include <asm/uaccess.h>
136
137#define IS_POSIX(fl) (fl->fl_flags & FL_POSIX)
138#define IS_FLOCK(fl) (fl->fl_flags & FL_FLOCK)
139#define IS_LEASE(fl) (fl->fl_flags & (FL_LEASE|FL_DELEG|FL_LAYOUT))
140#define IS_OFDLCK(fl) (fl->fl_flags & FL_OFDLCK)
141
142static bool lease_breaking(struct file_lock *fl)
143{
144 return fl->fl_flags & (FL_UNLOCK_PENDING | FL_DOWNGRADE_PENDING);
145}
146
147static int target_leasetype(struct file_lock *fl)
148{
149 if (fl->fl_flags & FL_UNLOCK_PENDING)
150 return F_UNLCK;
151 if (fl->fl_flags & FL_DOWNGRADE_PENDING)
152 return F_RDLCK;
153 return fl->fl_type;
154}
155
156int leases_enable = 1;
157int lease_break_time = 45;
158
159/*
160 * The global file_lock_list is only used for displaying /proc/locks, so we
161 * keep a list on each CPU, with each list protected by its own spinlock via
162 * the file_lock_lglock. Note that alterations to the list also require that
163 * the relevant flc_lock is held.
164 */
165DEFINE_STATIC_LGLOCK(file_lock_lglock);
166static DEFINE_PER_CPU(struct hlist_head, file_lock_list);
167
168/*
169 * The blocked_hash is used to find POSIX lock loops for deadlock detection.
170 * It is protected by blocked_lock_lock.
171 *
172 * We hash locks by lockowner in order to optimize searching for the lock a
173 * particular lockowner is waiting on.
174 *
175 * FIXME: make this value scale via some heuristic? We generally will want more
176 * buckets when we have more lockowners holding locks, but that's a little
177 * difficult to determine without knowing what the workload will look like.
178 */
179#define BLOCKED_HASH_BITS 7
180static DEFINE_HASHTABLE(blocked_hash, BLOCKED_HASH_BITS);
181
182/*
183 * This lock protects the blocked_hash. Generally, if you're accessing it, you
184 * want to be holding this lock.
185 *
186 * In addition, it also protects the fl->fl_block list, and the fl->fl_next
187 * pointer for file_lock structures that are acting as lock requests (in
188 * contrast to those that are acting as records of acquired locks).
189 *
190 * Note that when we acquire this lock in order to change the above fields,
191 * we often hold the flc_lock as well. In certain cases, when reading the fields
192 * protected by this lock, we can skip acquiring it iff we already hold the
193 * flc_lock.
194 *
195 * In particular, adding an entry to the fl_block list requires that you hold
196 * both the flc_lock and the blocked_lock_lock (acquired in that order).
197 * Deleting an entry from the list however only requires the file_lock_lock.
198 */
199static DEFINE_SPINLOCK(blocked_lock_lock);
200
201static struct kmem_cache *flctx_cache __read_mostly;
202static struct kmem_cache *filelock_cache __read_mostly;
203
204static struct file_lock_context *
205locks_get_lock_context(struct inode *inode, int type)
206{
207 struct file_lock_context *ctx;
208
209 /* paired with cmpxchg() below */
210 ctx = smp_load_acquire(&inode->i_flctx);
211 if (likely(ctx) || type == F_UNLCK)
212 goto out;
213
214 ctx = kmem_cache_alloc(flctx_cache, GFP_KERNEL);
215 if (!ctx)
216 goto out;
217
218 spin_lock_init(&ctx->flc_lock);
219 INIT_LIST_HEAD(&ctx->flc_flock);
220 INIT_LIST_HEAD(&ctx->flc_posix);
221 INIT_LIST_HEAD(&ctx->flc_lease);
222
223 /*
224 * Assign the pointer if it's not already assigned. If it is, then
225 * free the context we just allocated.
226 */
227 if (cmpxchg(&inode->i_flctx, NULL, ctx)) {
228 kmem_cache_free(flctx_cache, ctx);
229 ctx = smp_load_acquire(&inode->i_flctx);
230 }
231out:
232 trace_locks_get_lock_context(inode, type, ctx);
233 return ctx;
234}
235
236void
237locks_free_lock_context(struct inode *inode)
238{
239 struct file_lock_context *ctx = inode->i_flctx;
240
241 if (ctx) {
242 WARN_ON_ONCE(!list_empty(&ctx->flc_flock));
243 WARN_ON_ONCE(!list_empty(&ctx->flc_posix));
244 WARN_ON_ONCE(!list_empty(&ctx->flc_lease));
245 kmem_cache_free(flctx_cache, ctx);
246 }
247}
248
249static void locks_init_lock_heads(struct file_lock *fl)
250{
251 INIT_HLIST_NODE(&fl->fl_link);
252 INIT_LIST_HEAD(&fl->fl_list);
253 INIT_LIST_HEAD(&fl->fl_block);
254 init_waitqueue_head(&fl->fl_wait);
255}
256
257/* Allocate an empty lock structure. */
258struct file_lock *locks_alloc_lock(void)
259{
260 struct file_lock *fl = kmem_cache_zalloc(filelock_cache, GFP_KERNEL);
261
262 if (fl)
263 locks_init_lock_heads(fl);
264
265 return fl;
266}
267EXPORT_SYMBOL_GPL(locks_alloc_lock);
268
269void locks_release_private(struct file_lock *fl)
270{
271 if (fl->fl_ops) {
272 if (fl->fl_ops->fl_release_private)
273 fl->fl_ops->fl_release_private(fl);
274 fl->fl_ops = NULL;
275 }
276
277 if (fl->fl_lmops) {
278 if (fl->fl_lmops->lm_put_owner) {
279 fl->fl_lmops->lm_put_owner(fl->fl_owner);
280 fl->fl_owner = NULL;
281 }
282 fl->fl_lmops = NULL;
283 }
284}
285EXPORT_SYMBOL_GPL(locks_release_private);
286
287/* Free a lock which is not in use. */
288void locks_free_lock(struct file_lock *fl)
289{
290 BUG_ON(waitqueue_active(&fl->fl_wait));
291 BUG_ON(!list_empty(&fl->fl_list));
292 BUG_ON(!list_empty(&fl->fl_block));
293 BUG_ON(!hlist_unhashed(&fl->fl_link));
294
295 locks_release_private(fl);
296 kmem_cache_free(filelock_cache, fl);
297}
298EXPORT_SYMBOL(locks_free_lock);
299
300static void
301locks_dispose_list(struct list_head *dispose)
302{
303 struct file_lock *fl;
304
305 while (!list_empty(dispose)) {
306 fl = list_first_entry(dispose, struct file_lock, fl_list);
307 list_del_init(&fl->fl_list);
308 locks_free_lock(fl);
309 }
310}
311
312void locks_init_lock(struct file_lock *fl)
313{
314 memset(fl, 0, sizeof(struct file_lock));
315 locks_init_lock_heads(fl);
316}
317
318EXPORT_SYMBOL(locks_init_lock);
319
320/*
321 * Initialize a new lock from an existing file_lock structure.
322 */
323void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
324{
325 new->fl_owner = fl->fl_owner;
326 new->fl_pid = fl->fl_pid;
327 new->fl_file = NULL;
328 new->fl_flags = fl->fl_flags;
329 new->fl_type = fl->fl_type;
330 new->fl_start = fl->fl_start;
331 new->fl_end = fl->fl_end;
332 new->fl_lmops = fl->fl_lmops;
333 new->fl_ops = NULL;
334
335 if (fl->fl_lmops) {
336 if (fl->fl_lmops->lm_get_owner)
337 fl->fl_lmops->lm_get_owner(fl->fl_owner);
338 }
339}
340EXPORT_SYMBOL(locks_copy_conflock);
341
342void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
343{
344 /* "new" must be a freshly-initialized lock */
345 WARN_ON_ONCE(new->fl_ops);
346
347 locks_copy_conflock(new, fl);
348
349 new->fl_file = fl->fl_file;
350 new->fl_ops = fl->fl_ops;
351
352 if (fl->fl_ops) {
353 if (fl->fl_ops->fl_copy_lock)
354 fl->fl_ops->fl_copy_lock(new, fl);
355 }
356}
357
358EXPORT_SYMBOL(locks_copy_lock);
359
360static inline int flock_translate_cmd(int cmd) {
361 if (cmd & LOCK_MAND)
362 return cmd & (LOCK_MAND | LOCK_RW);
363 switch (cmd) {
364 case LOCK_SH:
365 return F_RDLCK;
366 case LOCK_EX:
367 return F_WRLCK;
368 case LOCK_UN:
369 return F_UNLCK;
370 }
371 return -EINVAL;
372}
373
374/* Fill in a file_lock structure with an appropriate FLOCK lock. */
375static struct file_lock *
376flock_make_lock(struct file *filp, unsigned int cmd)
377{
378 struct file_lock *fl;
379 int type = flock_translate_cmd(cmd);
380
381 if (type < 0)
382 return ERR_PTR(type);
383
384 fl = locks_alloc_lock();
385 if (fl == NULL)
386 return ERR_PTR(-ENOMEM);
387
388 fl->fl_file = filp;
389 fl->fl_owner = filp;
390 fl->fl_pid = current->tgid;
391 fl->fl_flags = FL_FLOCK;
392 fl->fl_type = type;
393 fl->fl_end = OFFSET_MAX;
394
395 return fl;
396}
397
398static int assign_type(struct file_lock *fl, long type)
399{
400 switch (type) {
401 case F_RDLCK:
402 case F_WRLCK:
403 case F_UNLCK:
404 fl->fl_type = type;
405 break;
406 default:
407 return -EINVAL;
408 }
409 return 0;
410}
411
412static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
413 struct flock64 *l)
414{
415 switch (l->l_whence) {
416 case SEEK_SET:
417 fl->fl_start = 0;
418 break;
419 case SEEK_CUR:
420 fl->fl_start = filp->f_pos;
421 break;
422 case SEEK_END:
423 fl->fl_start = i_size_read(file_inode(filp));
424 break;
425 default:
426 return -EINVAL;
427 }
428 if (l->l_start > OFFSET_MAX - fl->fl_start)
429 return -EOVERFLOW;
430 fl->fl_start += l->l_start;
431 if (fl->fl_start < 0)
432 return -EINVAL;
433
434 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
435 POSIX-2001 defines it. */
436 if (l->l_len > 0) {
437 if (l->l_len - 1 > OFFSET_MAX - fl->fl_start)
438 return -EOVERFLOW;
439 fl->fl_end = fl->fl_start + l->l_len - 1;
440
441 } else if (l->l_len < 0) {
442 if (fl->fl_start + l->l_len < 0)
443 return -EINVAL;
444 fl->fl_end = fl->fl_start - 1;
445 fl->fl_start += l->l_len;
446 } else
447 fl->fl_end = OFFSET_MAX;
448
449 fl->fl_owner = current->files;
450 fl->fl_pid = current->tgid;
451 fl->fl_file = filp;
452 fl->fl_flags = FL_POSIX;
453 fl->fl_ops = NULL;
454 fl->fl_lmops = NULL;
455
456 return assign_type(fl, l->l_type);
457}
458
459/* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
460 * style lock.
461 */
462static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
463 struct flock *l)
464{
465 struct flock64 ll = {
466 .l_type = l->l_type,
467 .l_whence = l->l_whence,
468 .l_start = l->l_start,
469 .l_len = l->l_len,
470 };
471
472 return flock64_to_posix_lock(filp, fl, &ll);
473}
474
475/* default lease lock manager operations */
476static bool
477lease_break_callback(struct file_lock *fl)
478{
479 kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
480 return false;
481}
482
483static void
484lease_setup(struct file_lock *fl, void **priv)
485{
486 struct file *filp = fl->fl_file;
487 struct fasync_struct *fa = *priv;
488
489 /*
490 * fasync_insert_entry() returns the old entry if any. If there was no
491 * old entry, then it used "priv" and inserted it into the fasync list.
492 * Clear the pointer to indicate that it shouldn't be freed.
493 */
494 if (!fasync_insert_entry(fa->fa_fd, filp, &fl->fl_fasync, fa))
495 *priv = NULL;
496
497 __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
498}
499
500static const struct lock_manager_operations lease_manager_ops = {
501 .lm_break = lease_break_callback,
502 .lm_change = lease_modify,
503 .lm_setup = lease_setup,
504};
505
506/*
507 * Initialize a lease, use the default lock manager operations
508 */
509static int lease_init(struct file *filp, long type, struct file_lock *fl)
510 {
511 if (assign_type(fl, type) != 0)
512 return -EINVAL;
513
514 fl->fl_owner = filp;
515 fl->fl_pid = current->tgid;
516
517 fl->fl_file = filp;
518 fl->fl_flags = FL_LEASE;
519 fl->fl_start = 0;
520 fl->fl_end = OFFSET_MAX;
521 fl->fl_ops = NULL;
522 fl->fl_lmops = &lease_manager_ops;
523 return 0;
524}
525
526/* Allocate a file_lock initialised to this type of lease */
527static struct file_lock *lease_alloc(struct file *filp, long type)
528{
529 struct file_lock *fl = locks_alloc_lock();
530 int error = -ENOMEM;
531
532 if (fl == NULL)
533 return ERR_PTR(error);
534
535 error = lease_init(filp, type, fl);
536 if (error) {
537 locks_free_lock(fl);
538 return ERR_PTR(error);
539 }
540 return fl;
541}
542
543/* Check if two locks overlap each other.
544 */
545static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
546{
547 return ((fl1->fl_end >= fl2->fl_start) &&
548 (fl2->fl_end >= fl1->fl_start));
549}
550
551/*
552 * Check whether two locks have the same owner.
553 */
554static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
555{
556 if (fl1->fl_lmops && fl1->fl_lmops->lm_compare_owner)
557 return fl2->fl_lmops == fl1->fl_lmops &&
558 fl1->fl_lmops->lm_compare_owner(fl1, fl2);
559 return fl1->fl_owner == fl2->fl_owner;
560}
561
562/* Must be called with the flc_lock held! */
563static void locks_insert_global_locks(struct file_lock *fl)
564{
565 lg_local_lock(&file_lock_lglock);
566 fl->fl_link_cpu = smp_processor_id();
567 hlist_add_head(&fl->fl_link, this_cpu_ptr(&file_lock_list));
568 lg_local_unlock(&file_lock_lglock);
569}
570
571/* Must be called with the flc_lock held! */
572static void locks_delete_global_locks(struct file_lock *fl)
573{
574 /*
575 * Avoid taking lock if already unhashed. This is safe since this check
576 * is done while holding the flc_lock, and new insertions into the list
577 * also require that it be held.
578 */
579 if (hlist_unhashed(&fl->fl_link))
580 return;
581 lg_local_lock_cpu(&file_lock_lglock, fl->fl_link_cpu);
582 hlist_del_init(&fl->fl_link);
583 lg_local_unlock_cpu(&file_lock_lglock, fl->fl_link_cpu);
584}
585
586static unsigned long
587posix_owner_key(struct file_lock *fl)
588{
589 if (fl->fl_lmops && fl->fl_lmops->lm_owner_key)
590 return fl->fl_lmops->lm_owner_key(fl);
591 return (unsigned long)fl->fl_owner;
592}
593
594static void locks_insert_global_blocked(struct file_lock *waiter)
595{
596 lockdep_assert_held(&blocked_lock_lock);
597
598 hash_add(blocked_hash, &waiter->fl_link, posix_owner_key(waiter));
599}
600
601static void locks_delete_global_blocked(struct file_lock *waiter)
602{
603 lockdep_assert_held(&blocked_lock_lock);
604
605 hash_del(&waiter->fl_link);
606}
607
608/* Remove waiter from blocker's block list.
609 * When blocker ends up pointing to itself then the list is empty.
610 *
611 * Must be called with blocked_lock_lock held.
612 */
613static void __locks_delete_block(struct file_lock *waiter)
614{
615 locks_delete_global_blocked(waiter);
616 list_del_init(&waiter->fl_block);
617 waiter->fl_next = NULL;
618}
619
620static void locks_delete_block(struct file_lock *waiter)
621{
622 spin_lock(&blocked_lock_lock);
623 __locks_delete_block(waiter);
624 spin_unlock(&blocked_lock_lock);
625}
626
627/* Insert waiter into blocker's block list.
628 * We use a circular list so that processes can be easily woken up in
629 * the order they blocked. The documentation doesn't require this but
630 * it seems like the reasonable thing to do.
631 *
632 * Must be called with both the flc_lock and blocked_lock_lock held. The
633 * fl_block list itself is protected by the blocked_lock_lock, but by ensuring
634 * that the flc_lock is also held on insertions we can avoid taking the
635 * blocked_lock_lock in some cases when we see that the fl_block list is empty.
636 */
637static void __locks_insert_block(struct file_lock *blocker,
638 struct file_lock *waiter)
639{
640 BUG_ON(!list_empty(&waiter->fl_block));
641 waiter->fl_next = blocker;
642 list_add_tail(&waiter->fl_block, &blocker->fl_block);
643 if (IS_POSIX(blocker) && !IS_OFDLCK(blocker))
644 locks_insert_global_blocked(waiter);
645}
646
647/* Must be called with flc_lock held. */
648static void locks_insert_block(struct file_lock *blocker,
649 struct file_lock *waiter)
650{
651 spin_lock(&blocked_lock_lock);
652 __locks_insert_block(blocker, waiter);
653 spin_unlock(&blocked_lock_lock);
654}
655
656/*
657 * Wake up processes blocked waiting for blocker.
658 *
659 * Must be called with the inode->flc_lock held!
660 */
661static void locks_wake_up_blocks(struct file_lock *blocker)
662{
663 /*
664 * Avoid taking global lock if list is empty. This is safe since new
665 * blocked requests are only added to the list under the flc_lock, and
666 * the flc_lock is always held here. Note that removal from the fl_block
667 * list does not require the flc_lock, so we must recheck list_empty()
668 * after acquiring the blocked_lock_lock.
669 */
670 if (list_empty(&blocker->fl_block))
671 return;
672
673 spin_lock(&blocked_lock_lock);
674 while (!list_empty(&blocker->fl_block)) {
675 struct file_lock *waiter;
676
677 waiter = list_first_entry(&blocker->fl_block,
678 struct file_lock, fl_block);
679 __locks_delete_block(waiter);
680 if (waiter->fl_lmops && waiter->fl_lmops->lm_notify)
681 waiter->fl_lmops->lm_notify(waiter);
682 else
683 wake_up(&waiter->fl_wait);
684 }
685 spin_unlock(&blocked_lock_lock);
686}
687
688static void
689locks_insert_lock_ctx(struct file_lock *fl, struct list_head *before)
690{
691 fl->fl_nspid = get_pid(task_tgid(current));
692 list_add_tail(&fl->fl_list, before);
693 locks_insert_global_locks(fl);
694}
695
696static void
697locks_unlink_lock_ctx(struct file_lock *fl)
698{
699 locks_delete_global_locks(fl);
700 list_del_init(&fl->fl_list);
701 if (fl->fl_nspid) {
702 put_pid(fl->fl_nspid);
703 fl->fl_nspid = NULL;
704 }
705 locks_wake_up_blocks(fl);
706}
707
708static void
709locks_delete_lock_ctx(struct file_lock *fl, struct list_head *dispose)
710{
711 locks_unlink_lock_ctx(fl);
712 if (dispose)
713 list_add(&fl->fl_list, dispose);
714 else
715 locks_free_lock(fl);
716}
717
718/* Determine if lock sys_fl blocks lock caller_fl. Common functionality
719 * checks for shared/exclusive status of overlapping locks.
720 */
721static int locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
722{
723 if (sys_fl->fl_type == F_WRLCK)
724 return 1;
725 if (caller_fl->fl_type == F_WRLCK)
726 return 1;
727 return 0;
728}
729
730/* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
731 * checking before calling the locks_conflict().
732 */
733static int posix_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
734{
735 /* POSIX locks owned by the same process do not conflict with
736 * each other.
737 */
738 if (posix_same_owner(caller_fl, sys_fl))
739 return (0);
740
741 /* Check whether they overlap */
742 if (!locks_overlap(caller_fl, sys_fl))
743 return 0;
744
745 return (locks_conflict(caller_fl, sys_fl));
746}
747
748/* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
749 * checking before calling the locks_conflict().
750 */
751static int flock_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
752{
753 /* FLOCK locks referring to the same filp do not conflict with
754 * each other.
755 */
756 if (caller_fl->fl_file == sys_fl->fl_file)
757 return (0);
758 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
759 return 0;
760
761 return (locks_conflict(caller_fl, sys_fl));
762}
763
764void
765posix_test_lock(struct file *filp, struct file_lock *fl)
766{
767 struct file_lock *cfl;
768 struct file_lock_context *ctx;
769 struct inode *inode = file_inode(filp);
770
771 ctx = smp_load_acquire(&inode->i_flctx);
772 if (!ctx || list_empty_careful(&ctx->flc_posix)) {
773 fl->fl_type = F_UNLCK;
774 return;
775 }
776
777 spin_lock(&ctx->flc_lock);
778 list_for_each_entry(cfl, &ctx->flc_posix, fl_list) {
779 if (posix_locks_conflict(fl, cfl)) {
780 locks_copy_conflock(fl, cfl);
781 if (cfl->fl_nspid)
782 fl->fl_pid = pid_vnr(cfl->fl_nspid);
783 goto out;
784 }
785 }
786 fl->fl_type = F_UNLCK;
787out:
788 spin_unlock(&ctx->flc_lock);
789 return;
790}
791EXPORT_SYMBOL(posix_test_lock);
792
793/*
794 * Deadlock detection:
795 *
796 * We attempt to detect deadlocks that are due purely to posix file
797 * locks.
798 *
799 * We assume that a task can be waiting for at most one lock at a time.
800 * So for any acquired lock, the process holding that lock may be
801 * waiting on at most one other lock. That lock in turns may be held by
802 * someone waiting for at most one other lock. Given a requested lock
803 * caller_fl which is about to wait for a conflicting lock block_fl, we
804 * follow this chain of waiters to ensure we are not about to create a
805 * cycle.
806 *
807 * Since we do this before we ever put a process to sleep on a lock, we
808 * are ensured that there is never a cycle; that is what guarantees that
809 * the while() loop in posix_locks_deadlock() eventually completes.
810 *
811 * Note: the above assumption may not be true when handling lock
812 * requests from a broken NFS client. It may also fail in the presence
813 * of tasks (such as posix threads) sharing the same open file table.
814 * To handle those cases, we just bail out after a few iterations.
815 *
816 * For FL_OFDLCK locks, the owner is the filp, not the files_struct.
817 * Because the owner is not even nominally tied to a thread of
818 * execution, the deadlock detection below can't reasonably work well. Just
819 * skip it for those.
820 *
821 * In principle, we could do a more limited deadlock detection on FL_OFDLCK
822 * locks that just checks for the case where two tasks are attempting to
823 * upgrade from read to write locks on the same inode.
824 */
825
826#define MAX_DEADLK_ITERATIONS 10
827
828/* Find a lock that the owner of the given block_fl is blocking on. */
829static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
830{
831 struct file_lock *fl;
832
833 hash_for_each_possible(blocked_hash, fl, fl_link, posix_owner_key(block_fl)) {
834 if (posix_same_owner(fl, block_fl))
835 return fl->fl_next;
836 }
837 return NULL;
838}
839
840/* Must be called with the blocked_lock_lock held! */
841static int posix_locks_deadlock(struct file_lock *caller_fl,
842 struct file_lock *block_fl)
843{
844 int i = 0;
845
846 lockdep_assert_held(&blocked_lock_lock);
847
848 /*
849 * This deadlock detector can't reasonably detect deadlocks with
850 * FL_OFDLCK locks, since they aren't owned by a process, per-se.
851 */
852 if (IS_OFDLCK(caller_fl))
853 return 0;
854
855 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
856 if (i++ > MAX_DEADLK_ITERATIONS)
857 return 0;
858 if (posix_same_owner(caller_fl, block_fl))
859 return 1;
860 }
861 return 0;
862}
863
864/* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
865 * after any leases, but before any posix locks.
866 *
867 * Note that if called with an FL_EXISTS argument, the caller may determine
868 * whether or not a lock was successfully freed by testing the return
869 * value for -ENOENT.
870 */
871static int flock_lock_inode(struct inode *inode, struct file_lock *request)
872{
873 struct file_lock *new_fl = NULL;
874 struct file_lock *fl;
875 struct file_lock_context *ctx;
876 int error = 0;
877 bool found = false;
878 LIST_HEAD(dispose);
879
880 ctx = locks_get_lock_context(inode, request->fl_type);
881 if (!ctx) {
882 if (request->fl_type != F_UNLCK)
883 return -ENOMEM;
884 return (request->fl_flags & FL_EXISTS) ? -ENOENT : 0;
885 }
886
887 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
888 new_fl = locks_alloc_lock();
889 if (!new_fl)
890 return -ENOMEM;
891 }
892
893 spin_lock(&ctx->flc_lock);
894 if (request->fl_flags & FL_ACCESS)
895 goto find_conflict;
896
897 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
898 if (request->fl_file != fl->fl_file)
899 continue;
900 if (request->fl_type == fl->fl_type)
901 goto out;
902 found = true;
903 locks_delete_lock_ctx(fl, &dispose);
904 break;
905 }
906
907 if (request->fl_type == F_UNLCK) {
908 if ((request->fl_flags & FL_EXISTS) && !found)
909 error = -ENOENT;
910 goto out;
911 }
912
913find_conflict:
914 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
915 if (!flock_locks_conflict(request, fl))
916 continue;
917 error = -EAGAIN;
918 if (!(request->fl_flags & FL_SLEEP))
919 goto out;
920 error = FILE_LOCK_DEFERRED;
921 locks_insert_block(fl, request);
922 goto out;
923 }
924 if (request->fl_flags & FL_ACCESS)
925 goto out;
926 locks_copy_lock(new_fl, request);
927 locks_insert_lock_ctx(new_fl, &ctx->flc_flock);
928 new_fl = NULL;
929 error = 0;
930
931out:
932 spin_unlock(&ctx->flc_lock);
933 if (new_fl)
934 locks_free_lock(new_fl);
935 locks_dispose_list(&dispose);
936 return error;
937}
938
939static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
940{
941 struct file_lock *fl, *tmp;
942 struct file_lock *new_fl = NULL;
943 struct file_lock *new_fl2 = NULL;
944 struct file_lock *left = NULL;
945 struct file_lock *right = NULL;
946 struct file_lock_context *ctx;
947 int error;
948 bool added = false;
949 LIST_HEAD(dispose);
950
951 ctx = locks_get_lock_context(inode, request->fl_type);
952 if (!ctx)
953 return (request->fl_type == F_UNLCK) ? 0 : -ENOMEM;
954
955 /*
956 * We may need two file_lock structures for this operation,
957 * so we get them in advance to avoid races.
958 *
959 * In some cases we can be sure, that no new locks will be needed
960 */
961 if (!(request->fl_flags & FL_ACCESS) &&
962 (request->fl_type != F_UNLCK ||
963 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
964 new_fl = locks_alloc_lock();
965 new_fl2 = locks_alloc_lock();
966 }
967
968 spin_lock(&ctx->flc_lock);
969 /*
970 * New lock request. Walk all POSIX locks and look for conflicts. If
971 * there are any, either return error or put the request on the
972 * blocker's list of waiters and the global blocked_hash.
973 */
974 if (request->fl_type != F_UNLCK) {
975 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
976 if (!posix_locks_conflict(request, fl))
977 continue;
978 if (conflock)
979 locks_copy_conflock(conflock, fl);
980 error = -EAGAIN;
981 if (!(request->fl_flags & FL_SLEEP))
982 goto out;
983 /*
984 * Deadlock detection and insertion into the blocked
985 * locks list must be done while holding the same lock!
986 */
987 error = -EDEADLK;
988 spin_lock(&blocked_lock_lock);
989 if (likely(!posix_locks_deadlock(request, fl))) {
990 error = FILE_LOCK_DEFERRED;
991 __locks_insert_block(fl, request);
992 }
993 spin_unlock(&blocked_lock_lock);
994 goto out;
995 }
996 }
997
998 /* If we're just looking for a conflict, we're done. */
999 error = 0;
1000 if (request->fl_flags & FL_ACCESS)
1001 goto out;
1002
1003 /* Find the first old lock with the same owner as the new lock */
1004 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
1005 if (posix_same_owner(request, fl))
1006 break;
1007 }
1008
1009 /* Process locks with this owner. */
1010 list_for_each_entry_safe_from(fl, tmp, &ctx->flc_posix, fl_list) {
1011 if (!posix_same_owner(request, fl))
1012 break;
1013
1014 /* Detect adjacent or overlapping regions (if same lock type) */
1015 if (request->fl_type == fl->fl_type) {
1016 /* In all comparisons of start vs end, use
1017 * "start - 1" rather than "end + 1". If end
1018 * is OFFSET_MAX, end + 1 will become negative.
1019 */
1020 if (fl->fl_end < request->fl_start - 1)
1021 continue;
1022 /* If the next lock in the list has entirely bigger
1023 * addresses than the new one, insert the lock here.
1024 */
1025 if (fl->fl_start - 1 > request->fl_end)
1026 break;
1027
1028 /* If we come here, the new and old lock are of the
1029 * same type and adjacent or overlapping. Make one
1030 * lock yielding from the lower start address of both
1031 * locks to the higher end address.
1032 */
1033 if (fl->fl_start > request->fl_start)
1034 fl->fl_start = request->fl_start;
1035 else
1036 request->fl_start = fl->fl_start;
1037 if (fl->fl_end < request->fl_end)
1038 fl->fl_end = request->fl_end;
1039 else
1040 request->fl_end = fl->fl_end;
1041 if (added) {
1042 locks_delete_lock_ctx(fl, &dispose);
1043 continue;
1044 }
1045 request = fl;
1046 added = true;
1047 } else {
1048 /* Processing for different lock types is a bit
1049 * more complex.
1050 */
1051 if (fl->fl_end < request->fl_start)
1052 continue;
1053 if (fl->fl_start > request->fl_end)
1054 break;
1055 if (request->fl_type == F_UNLCK)
1056 added = true;
1057 if (fl->fl_start < request->fl_start)
1058 left = fl;
1059 /* If the next lock in the list has a higher end
1060 * address than the new one, insert the new one here.
1061 */
1062 if (fl->fl_end > request->fl_end) {
1063 right = fl;
1064 break;
1065 }
1066 if (fl->fl_start >= request->fl_start) {
1067 /* The new lock completely replaces an old
1068 * one (This may happen several times).
1069 */
1070 if (added) {
1071 locks_delete_lock_ctx(fl, &dispose);
1072 continue;
1073 }
1074 /*
1075 * Replace the old lock with new_fl, and
1076 * remove the old one. It's safe to do the
1077 * insert here since we know that we won't be
1078 * using new_fl later, and that the lock is
1079 * just replacing an existing lock.
1080 */
1081 error = -ENOLCK;
1082 if (!new_fl)
1083 goto out;
1084 locks_copy_lock(new_fl, request);
1085 request = new_fl;
1086 new_fl = NULL;
1087 locks_insert_lock_ctx(request, &fl->fl_list);
1088 locks_delete_lock_ctx(fl, &dispose);
1089 added = true;
1090 }
1091 }
1092 }
1093
1094 /*
1095 * The above code only modifies existing locks in case of merging or
1096 * replacing. If new lock(s) need to be inserted all modifications are
1097 * done below this, so it's safe yet to bail out.
1098 */
1099 error = -ENOLCK; /* "no luck" */
1100 if (right && left == right && !new_fl2)
1101 goto out;
1102
1103 error = 0;
1104 if (!added) {
1105 if (request->fl_type == F_UNLCK) {
1106 if (request->fl_flags & FL_EXISTS)
1107 error = -ENOENT;
1108 goto out;
1109 }
1110
1111 if (!new_fl) {
1112 error = -ENOLCK;
1113 goto out;
1114 }
1115 locks_copy_lock(new_fl, request);
1116 locks_insert_lock_ctx(new_fl, &fl->fl_list);
1117 fl = new_fl;
1118 new_fl = NULL;
1119 }
1120 if (right) {
1121 if (left == right) {
1122 /* The new lock breaks the old one in two pieces,
1123 * so we have to use the second new lock.
1124 */
1125 left = new_fl2;
1126 new_fl2 = NULL;
1127 locks_copy_lock(left, right);
1128 locks_insert_lock_ctx(left, &fl->fl_list);
1129 }
1130 right->fl_start = request->fl_end + 1;
1131 locks_wake_up_blocks(right);
1132 }
1133 if (left) {
1134 left->fl_end = request->fl_start - 1;
1135 locks_wake_up_blocks(left);
1136 }
1137 out:
1138 spin_unlock(&ctx->flc_lock);
1139 /*
1140 * Free any unused locks.
1141 */
1142 if (new_fl)
1143 locks_free_lock(new_fl);
1144 if (new_fl2)
1145 locks_free_lock(new_fl2);
1146 locks_dispose_list(&dispose);
1147 trace_posix_lock_inode(inode, request, error);
1148
1149 return error;
1150}
1151
1152/**
1153 * posix_lock_file - Apply a POSIX-style lock to a file
1154 * @filp: The file to apply the lock to
1155 * @fl: The lock to be applied
1156 * @conflock: Place to return a copy of the conflicting lock, if found.
1157 *
1158 * Add a POSIX style lock to a file.
1159 * We merge adjacent & overlapping locks whenever possible.
1160 * POSIX locks are sorted by owner task, then by starting address
1161 *
1162 * Note that if called with an FL_EXISTS argument, the caller may determine
1163 * whether or not a lock was successfully freed by testing the return
1164 * value for -ENOENT.
1165 */
1166int posix_lock_file(struct file *filp, struct file_lock *fl,
1167 struct file_lock *conflock)
1168{
1169 return __posix_lock_file(file_inode(filp), fl, conflock);
1170}
1171EXPORT_SYMBOL(posix_lock_file);
1172
1173/**
1174 * posix_lock_inode_wait - Apply a POSIX-style lock to a file
1175 * @inode: inode of file to which lock request should be applied
1176 * @fl: The lock to be applied
1177 *
1178 * Apply a POSIX style lock request to an inode.
1179 */
1180static int posix_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1181{
1182 int error;
1183 might_sleep ();
1184 for (;;) {
1185 error = __posix_lock_file(inode, fl, NULL);
1186 if (error != FILE_LOCK_DEFERRED)
1187 break;
1188 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1189 if (!error)
1190 continue;
1191
1192 locks_delete_block(fl);
1193 break;
1194 }
1195 return error;
1196}
1197
1198#ifdef CONFIG_MANDATORY_FILE_LOCKING
1199/**
1200 * locks_mandatory_locked - Check for an active lock
1201 * @file: the file to check
1202 *
1203 * Searches the inode's list of locks to find any POSIX locks which conflict.
1204 * This function is called from locks_verify_locked() only.
1205 */
1206int locks_mandatory_locked(struct file *file)
1207{
1208 int ret;
1209 struct inode *inode = file_inode(file);
1210 struct file_lock_context *ctx;
1211 struct file_lock *fl;
1212
1213 ctx = smp_load_acquire(&inode->i_flctx);
1214 if (!ctx || list_empty_careful(&ctx->flc_posix))
1215 return 0;
1216
1217 /*
1218 * Search the lock list for this inode for any POSIX locks.
1219 */
1220 spin_lock(&ctx->flc_lock);
1221 ret = 0;
1222 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
1223 if (fl->fl_owner != current->files &&
1224 fl->fl_owner != file) {
1225 ret = -EAGAIN;
1226 break;
1227 }
1228 }
1229 spin_unlock(&ctx->flc_lock);
1230 return ret;
1231}
1232
1233/**
1234 * locks_mandatory_area - Check for a conflicting lock
1235 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1236 * for shared
1237 * @inode: the file to check
1238 * @filp: how the file was opened (if it was)
1239 * @offset: start of area to check
1240 * @count: length of area to check
1241 *
1242 * Searches the inode's list of locks to find any POSIX locks which conflict.
1243 * This function is called from rw_verify_area() and
1244 * locks_verify_truncate().
1245 */
1246int locks_mandatory_area(int read_write, struct inode *inode,
1247 struct file *filp, loff_t offset,
1248 size_t count)
1249{
1250 struct file_lock fl;
1251 int error;
1252 bool sleep = false;
1253
1254 locks_init_lock(&fl);
1255 fl.fl_pid = current->tgid;
1256 fl.fl_file = filp;
1257 fl.fl_flags = FL_POSIX | FL_ACCESS;
1258 if (filp && !(filp->f_flags & O_NONBLOCK))
1259 sleep = true;
1260 fl.fl_type = (read_write == FLOCK_VERIFY_WRITE) ? F_WRLCK : F_RDLCK;
1261 fl.fl_start = offset;
1262 fl.fl_end = offset + count - 1;
1263
1264 for (;;) {
1265 if (filp) {
1266 fl.fl_owner = filp;
1267 fl.fl_flags &= ~FL_SLEEP;
1268 error = __posix_lock_file(inode, &fl, NULL);
1269 if (!error)
1270 break;
1271 }
1272
1273 if (sleep)
1274 fl.fl_flags |= FL_SLEEP;
1275 fl.fl_owner = current->files;
1276 error = __posix_lock_file(inode, &fl, NULL);
1277 if (error != FILE_LOCK_DEFERRED)
1278 break;
1279 error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
1280 if (!error) {
1281 /*
1282 * If we've been sleeping someone might have
1283 * changed the permissions behind our back.
1284 */
1285 if (__mandatory_lock(inode))
1286 continue;
1287 }
1288
1289 locks_delete_block(&fl);
1290 break;
1291 }
1292
1293 return error;
1294}
1295
1296EXPORT_SYMBOL(locks_mandatory_area);
1297#endif /* CONFIG_MANDATORY_FILE_LOCKING */
1298
1299static void lease_clear_pending(struct file_lock *fl, int arg)
1300{
1301 switch (arg) {
1302 case F_UNLCK:
1303 fl->fl_flags &= ~FL_UNLOCK_PENDING;
1304 /* fall through: */
1305 case F_RDLCK:
1306 fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
1307 }
1308}
1309
1310/* We already had a lease on this file; just change its type */
1311int lease_modify(struct file_lock *fl, int arg, struct list_head *dispose)
1312{
1313 int error = assign_type(fl, arg);
1314
1315 if (error)
1316 return error;
1317 lease_clear_pending(fl, arg);
1318 locks_wake_up_blocks(fl);
1319 if (arg == F_UNLCK) {
1320 struct file *filp = fl->fl_file;
1321
1322 f_delown(filp);
1323 filp->f_owner.signum = 0;
1324 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
1325 if (fl->fl_fasync != NULL) {
1326 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
1327 fl->fl_fasync = NULL;
1328 }
1329 locks_delete_lock_ctx(fl, dispose);
1330 }
1331 return 0;
1332}
1333EXPORT_SYMBOL(lease_modify);
1334
1335static bool past_time(unsigned long then)
1336{
1337 if (!then)
1338 /* 0 is a special value meaning "this never expires": */
1339 return false;
1340 return time_after(jiffies, then);
1341}
1342
1343static void time_out_leases(struct inode *inode, struct list_head *dispose)
1344{
1345 struct file_lock_context *ctx = inode->i_flctx;
1346 struct file_lock *fl, *tmp;
1347
1348 lockdep_assert_held(&ctx->flc_lock);
1349
1350 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
1351 trace_time_out_leases(inode, fl);
1352 if (past_time(fl->fl_downgrade_time))
1353 lease_modify(fl, F_RDLCK, dispose);
1354 if (past_time(fl->fl_break_time))
1355 lease_modify(fl, F_UNLCK, dispose);
1356 }
1357}
1358
1359static bool leases_conflict(struct file_lock *lease, struct file_lock *breaker)
1360{
1361 if ((breaker->fl_flags & FL_LAYOUT) != (lease->fl_flags & FL_LAYOUT))
1362 return false;
1363 if ((breaker->fl_flags & FL_DELEG) && (lease->fl_flags & FL_LEASE))
1364 return false;
1365 return locks_conflict(breaker, lease);
1366}
1367
1368static bool
1369any_leases_conflict(struct inode *inode, struct file_lock *breaker)
1370{
1371 struct file_lock_context *ctx = inode->i_flctx;
1372 struct file_lock *fl;
1373
1374 lockdep_assert_held(&ctx->flc_lock);
1375
1376 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1377 if (leases_conflict(fl, breaker))
1378 return true;
1379 }
1380 return false;
1381}
1382
1383/**
1384 * __break_lease - revoke all outstanding leases on file
1385 * @inode: the inode of the file to return
1386 * @mode: O_RDONLY: break only write leases; O_WRONLY or O_RDWR:
1387 * break all leases
1388 * @type: FL_LEASE: break leases and delegations; FL_DELEG: break
1389 * only delegations
1390 *
1391 * break_lease (inlined for speed) has checked there already is at least
1392 * some kind of lock (maybe a lease) on this file. Leases are broken on
1393 * a call to open() or truncate(). This function can sleep unless you
1394 * specified %O_NONBLOCK to your open().
1395 */
1396int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
1397{
1398 int error = 0;
1399 struct file_lock_context *ctx;
1400 struct file_lock *new_fl, *fl, *tmp;
1401 unsigned long break_time;
1402 int want_write = (mode & O_ACCMODE) != O_RDONLY;
1403 LIST_HEAD(dispose);
1404
1405 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
1406 if (IS_ERR(new_fl))
1407 return PTR_ERR(new_fl);
1408 new_fl->fl_flags = type;
1409
1410 /* typically we will check that ctx is non-NULL before calling */
1411 ctx = smp_load_acquire(&inode->i_flctx);
1412 if (!ctx) {
1413 WARN_ON_ONCE(1);
1414 return error;
1415 }
1416
1417 spin_lock(&ctx->flc_lock);
1418
1419 time_out_leases(inode, &dispose);
1420
1421 if (!any_leases_conflict(inode, new_fl))
1422 goto out;
1423
1424 break_time = 0;
1425 if (lease_break_time > 0) {
1426 break_time = jiffies + lease_break_time * HZ;
1427 if (break_time == 0)
1428 break_time++; /* so that 0 means no break time */
1429 }
1430
1431 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
1432 if (!leases_conflict(fl, new_fl))
1433 continue;
1434 if (want_write) {
1435 if (fl->fl_flags & FL_UNLOCK_PENDING)
1436 continue;
1437 fl->fl_flags |= FL_UNLOCK_PENDING;
1438 fl->fl_break_time = break_time;
1439 } else {
1440 if (lease_breaking(fl))
1441 continue;
1442 fl->fl_flags |= FL_DOWNGRADE_PENDING;
1443 fl->fl_downgrade_time = break_time;
1444 }
1445 if (fl->fl_lmops->lm_break(fl))
1446 locks_delete_lock_ctx(fl, &dispose);
1447 }
1448
1449 if (list_empty(&ctx->flc_lease))
1450 goto out;
1451
1452 if (mode & O_NONBLOCK) {
1453 trace_break_lease_noblock(inode, new_fl);
1454 error = -EWOULDBLOCK;
1455 goto out;
1456 }
1457
1458restart:
1459 fl = list_first_entry(&ctx->flc_lease, struct file_lock, fl_list);
1460 break_time = fl->fl_break_time;
1461 if (break_time != 0)
1462 break_time -= jiffies;
1463 if (break_time == 0)
1464 break_time++;
1465 locks_insert_block(fl, new_fl);
1466 trace_break_lease_block(inode, new_fl);
1467 spin_unlock(&ctx->flc_lock);
1468 locks_dispose_list(&dispose);
1469 error = wait_event_interruptible_timeout(new_fl->fl_wait,
1470 !new_fl->fl_next, break_time);
1471 spin_lock(&ctx->flc_lock);
1472 trace_break_lease_unblock(inode, new_fl);
1473 locks_delete_block(new_fl);
1474 if (error >= 0) {
1475 /*
1476 * Wait for the next conflicting lease that has not been
1477 * broken yet
1478 */
1479 if (error == 0)
1480 time_out_leases(inode, &dispose);
1481 if (any_leases_conflict(inode, new_fl))
1482 goto restart;
1483 error = 0;
1484 }
1485out:
1486 spin_unlock(&ctx->flc_lock);
1487 locks_dispose_list(&dispose);
1488 locks_free_lock(new_fl);
1489 return error;
1490}
1491
1492EXPORT_SYMBOL(__break_lease);
1493
1494/**
1495 * lease_get_mtime - get the last modified time of an inode
1496 * @inode: the inode
1497 * @time: pointer to a timespec which will contain the last modified time
1498 *
1499 * This is to force NFS clients to flush their caches for files with
1500 * exclusive leases. The justification is that if someone has an
1501 * exclusive lease, then they could be modifying it.
1502 */
1503void lease_get_mtime(struct inode *inode, struct timespec *time)
1504{
1505 bool has_lease = false;
1506 struct file_lock_context *ctx;
1507 struct file_lock *fl;
1508
1509 ctx = smp_load_acquire(&inode->i_flctx);
1510 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
1511 spin_lock(&ctx->flc_lock);
1512 fl = list_first_entry_or_null(&ctx->flc_lease,
1513 struct file_lock, fl_list);
1514 if (fl && (fl->fl_type == F_WRLCK))
1515 has_lease = true;
1516 spin_unlock(&ctx->flc_lock);
1517 }
1518
1519 if (has_lease)
1520 *time = current_fs_time(inode->i_sb);
1521 else
1522 *time = inode->i_mtime;
1523}
1524
1525EXPORT_SYMBOL(lease_get_mtime);
1526
1527/**
1528 * fcntl_getlease - Enquire what lease is currently active
1529 * @filp: the file
1530 *
1531 * The value returned by this function will be one of
1532 * (if no lease break is pending):
1533 *
1534 * %F_RDLCK to indicate a shared lease is held.
1535 *
1536 * %F_WRLCK to indicate an exclusive lease is held.
1537 *
1538 * %F_UNLCK to indicate no lease is held.
1539 *
1540 * (if a lease break is pending):
1541 *
1542 * %F_RDLCK to indicate an exclusive lease needs to be
1543 * changed to a shared lease (or removed).
1544 *
1545 * %F_UNLCK to indicate the lease needs to be removed.
1546 *
1547 * XXX: sfr & willy disagree over whether F_INPROGRESS
1548 * should be returned to userspace.
1549 */
1550int fcntl_getlease(struct file *filp)
1551{
1552 struct file_lock *fl;
1553 struct inode *inode = file_inode(filp);
1554 struct file_lock_context *ctx;
1555 int type = F_UNLCK;
1556 LIST_HEAD(dispose);
1557
1558 ctx = smp_load_acquire(&inode->i_flctx);
1559 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
1560 spin_lock(&ctx->flc_lock);
1561 time_out_leases(file_inode(filp), &dispose);
1562 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1563 if (fl->fl_file != filp)
1564 continue;
1565 type = target_leasetype(fl);
1566 break;
1567 }
1568 spin_unlock(&ctx->flc_lock);
1569 locks_dispose_list(&dispose);
1570 }
1571 return type;
1572}
1573
1574/**
1575 * check_conflicting_open - see if the given dentry points to a file that has
1576 * an existing open that would conflict with the
1577 * desired lease.
1578 * @dentry: dentry to check
1579 * @arg: type of lease that we're trying to acquire
1580 * @flags: current lock flags
1581 *
1582 * Check to see if there's an existing open fd on this file that would
1583 * conflict with the lease we're trying to set.
1584 */
1585static int
1586check_conflicting_open(const struct dentry *dentry, const long arg, int flags)
1587{
1588 int ret = 0;
1589 struct inode *inode = dentry->d_inode;
1590
1591 if (flags & FL_LAYOUT)
1592 return 0;
1593
1594 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
1595 return -EAGAIN;
1596
1597 if ((arg == F_WRLCK) && ((d_count(dentry) > 1) ||
1598 (atomic_read(&inode->i_count) > 1)))
1599 ret = -EAGAIN;
1600
1601 return ret;
1602}
1603
1604static int
1605generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **priv)
1606{
1607 struct file_lock *fl, *my_fl = NULL, *lease;
1608 struct dentry *dentry = filp->f_path.dentry;
1609 struct inode *inode = dentry->d_inode;
1610 struct file_lock_context *ctx;
1611 bool is_deleg = (*flp)->fl_flags & FL_DELEG;
1612 int error;
1613 LIST_HEAD(dispose);
1614
1615 lease = *flp;
1616 trace_generic_add_lease(inode, lease);
1617
1618 /* Note that arg is never F_UNLCK here */
1619 ctx = locks_get_lock_context(inode, arg);
1620 if (!ctx)
1621 return -ENOMEM;
1622
1623 /*
1624 * In the delegation case we need mutual exclusion with
1625 * a number of operations that take the i_mutex. We trylock
1626 * because delegations are an optional optimization, and if
1627 * there's some chance of a conflict--we'd rather not
1628 * bother, maybe that's a sign this just isn't a good file to
1629 * hand out a delegation on.
1630 */
1631 if (is_deleg && !mutex_trylock(&inode->i_mutex))
1632 return -EAGAIN;
1633
1634 if (is_deleg && arg == F_WRLCK) {
1635 /* Write delegations are not currently supported: */
1636 mutex_unlock(&inode->i_mutex);
1637 WARN_ON_ONCE(1);
1638 return -EINVAL;
1639 }
1640
1641 spin_lock(&ctx->flc_lock);
1642 time_out_leases(inode, &dispose);
1643 error = check_conflicting_open(dentry, arg, lease->fl_flags);
1644 if (error)
1645 goto out;
1646
1647 /*
1648 * At this point, we know that if there is an exclusive
1649 * lease on this file, then we hold it on this filp
1650 * (otherwise our open of this file would have blocked).
1651 * And if we are trying to acquire an exclusive lease,
1652 * then the file is not open by anyone (including us)
1653 * except for this filp.
1654 */
1655 error = -EAGAIN;
1656 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1657 if (fl->fl_file == filp &&
1658 fl->fl_owner == lease->fl_owner) {
1659 my_fl = fl;
1660 continue;
1661 }
1662
1663 /*
1664 * No exclusive leases if someone else has a lease on
1665 * this file:
1666 */
1667 if (arg == F_WRLCK)
1668 goto out;
1669 /*
1670 * Modifying our existing lease is OK, but no getting a
1671 * new lease if someone else is opening for write:
1672 */
1673 if (fl->fl_flags & FL_UNLOCK_PENDING)
1674 goto out;
1675 }
1676
1677 if (my_fl != NULL) {
1678 lease = my_fl;
1679 error = lease->fl_lmops->lm_change(lease, arg, &dispose);
1680 if (error)
1681 goto out;
1682 goto out_setup;
1683 }
1684
1685 error = -EINVAL;
1686 if (!leases_enable)
1687 goto out;
1688
1689 locks_insert_lock_ctx(lease, &ctx->flc_lease);
1690 /*
1691 * The check in break_lease() is lockless. It's possible for another
1692 * open to race in after we did the earlier check for a conflicting
1693 * open but before the lease was inserted. Check again for a
1694 * conflicting open and cancel the lease if there is one.
1695 *
1696 * We also add a barrier here to ensure that the insertion of the lock
1697 * precedes these checks.
1698 */
1699 smp_mb();
1700 error = check_conflicting_open(dentry, arg, lease->fl_flags);
1701 if (error) {
1702 locks_unlink_lock_ctx(lease);
1703 goto out;
1704 }
1705
1706out_setup:
1707 if (lease->fl_lmops->lm_setup)
1708 lease->fl_lmops->lm_setup(lease, priv);
1709out:
1710 spin_unlock(&ctx->flc_lock);
1711 locks_dispose_list(&dispose);
1712 if (is_deleg)
1713 mutex_unlock(&inode->i_mutex);
1714 if (!error && !my_fl)
1715 *flp = NULL;
1716 return error;
1717}
1718
1719static int generic_delete_lease(struct file *filp, void *owner)
1720{
1721 int error = -EAGAIN;
1722 struct file_lock *fl, *victim = NULL;
1723 struct inode *inode = file_inode(filp);
1724 struct file_lock_context *ctx;
1725 LIST_HEAD(dispose);
1726
1727 ctx = smp_load_acquire(&inode->i_flctx);
1728 if (!ctx) {
1729 trace_generic_delete_lease(inode, NULL);
1730 return error;
1731 }
1732
1733 spin_lock(&ctx->flc_lock);
1734 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1735 if (fl->fl_file == filp &&
1736 fl->fl_owner == owner) {
1737 victim = fl;
1738 break;
1739 }
1740 }
1741 trace_generic_delete_lease(inode, victim);
1742 if (victim)
1743 error = fl->fl_lmops->lm_change(victim, F_UNLCK, &dispose);
1744 spin_unlock(&ctx->flc_lock);
1745 locks_dispose_list(&dispose);
1746 return error;
1747}
1748
1749/**
1750 * generic_setlease - sets a lease on an open file
1751 * @filp: file pointer
1752 * @arg: type of lease to obtain
1753 * @flp: input - file_lock to use, output - file_lock inserted
1754 * @priv: private data for lm_setup (may be NULL if lm_setup
1755 * doesn't require it)
1756 *
1757 * The (input) flp->fl_lmops->lm_break function is required
1758 * by break_lease().
1759 */
1760int generic_setlease(struct file *filp, long arg, struct file_lock **flp,
1761 void **priv)
1762{
1763 struct inode *inode = file_inode(filp);
1764 int error;
1765
1766 if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
1767 return -EACCES;
1768 if (!S_ISREG(inode->i_mode))
1769 return -EINVAL;
1770 error = security_file_lock(filp, arg);
1771 if (error)
1772 return error;
1773
1774 switch (arg) {
1775 case F_UNLCK:
1776 return generic_delete_lease(filp, *priv);
1777 case F_RDLCK:
1778 case F_WRLCK:
1779 if (!(*flp)->fl_lmops->lm_break) {
1780 WARN_ON_ONCE(1);
1781 return -ENOLCK;
1782 }
1783
1784 return generic_add_lease(filp, arg, flp, priv);
1785 default:
1786 return -EINVAL;
1787 }
1788}
1789EXPORT_SYMBOL(generic_setlease);
1790
1791/**
1792 * vfs_setlease - sets a lease on an open file
1793 * @filp: file pointer
1794 * @arg: type of lease to obtain
1795 * @lease: file_lock to use when adding a lease
1796 * @priv: private info for lm_setup when adding a lease (may be
1797 * NULL if lm_setup doesn't require it)
1798 *
1799 * Call this to establish a lease on the file. The "lease" argument is not
1800 * used for F_UNLCK requests and may be NULL. For commands that set or alter
1801 * an existing lease, the (*lease)->fl_lmops->lm_break operation must be set;
1802 * if not, this function will return -ENOLCK (and generate a scary-looking
1803 * stack trace).
1804 *
1805 * The "priv" pointer is passed directly to the lm_setup function as-is. It
1806 * may be NULL if the lm_setup operation doesn't require it.
1807 */
1808int
1809vfs_setlease(struct file *filp, long arg, struct file_lock **lease, void **priv)
1810{
1811 if (filp->f_op->setlease)
1812 return filp->f_op->setlease(filp, arg, lease, priv);
1813 else
1814 return generic_setlease(filp, arg, lease, priv);
1815}
1816EXPORT_SYMBOL_GPL(vfs_setlease);
1817
1818static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
1819{
1820 struct file_lock *fl;
1821 struct fasync_struct *new;
1822 int error;
1823
1824 fl = lease_alloc(filp, arg);
1825 if (IS_ERR(fl))
1826 return PTR_ERR(fl);
1827
1828 new = fasync_alloc();
1829 if (!new) {
1830 locks_free_lock(fl);
1831 return -ENOMEM;
1832 }
1833 new->fa_fd = fd;
1834
1835 error = vfs_setlease(filp, arg, &fl, (void **)&new);
1836 if (fl)
1837 locks_free_lock(fl);
1838 if (new)
1839 fasync_free(new);
1840 return error;
1841}
1842
1843/**
1844 * fcntl_setlease - sets a lease on an open file
1845 * @fd: open file descriptor
1846 * @filp: file pointer
1847 * @arg: type of lease to obtain
1848 *
1849 * Call this fcntl to establish a lease on the file.
1850 * Note that you also need to call %F_SETSIG to
1851 * receive a signal when the lease is broken.
1852 */
1853int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1854{
1855 if (arg == F_UNLCK)
1856 return vfs_setlease(filp, F_UNLCK, NULL, (void **)&filp);
1857 return do_fcntl_add_lease(fd, filp, arg);
1858}
1859
1860/**
1861 * flock_lock_inode_wait - Apply a FLOCK-style lock to a file
1862 * @inode: inode of the file to apply to
1863 * @fl: The lock to be applied
1864 *
1865 * Apply a FLOCK style lock request to an inode.
1866 */
1867static int flock_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1868{
1869 int error;
1870 might_sleep();
1871 for (;;) {
1872 error = flock_lock_inode(inode, fl);
1873 if (error != FILE_LOCK_DEFERRED)
1874 break;
1875 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1876 if (!error)
1877 continue;
1878
1879 locks_delete_block(fl);
1880 break;
1881 }
1882 return error;
1883}
1884
1885/**
1886 * locks_lock_inode_wait - Apply a lock to an inode
1887 * @inode: inode of the file to apply to
1888 * @fl: The lock to be applied
1889 *
1890 * Apply a POSIX or FLOCK style lock request to an inode.
1891 */
1892int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1893{
1894 int res = 0;
1895 switch (fl->fl_flags & (FL_POSIX|FL_FLOCK)) {
1896 case FL_POSIX:
1897 res = posix_lock_inode_wait(inode, fl);
1898 break;
1899 case FL_FLOCK:
1900 res = flock_lock_inode_wait(inode, fl);
1901 break;
1902 default:
1903 BUG();
1904 }
1905 return res;
1906}
1907EXPORT_SYMBOL(locks_lock_inode_wait);
1908
1909/**
1910 * sys_flock: - flock() system call.
1911 * @fd: the file descriptor to lock.
1912 * @cmd: the type of lock to apply.
1913 *
1914 * Apply a %FL_FLOCK style lock to an open file descriptor.
1915 * The @cmd can be one of
1916 *
1917 * %LOCK_SH -- a shared lock.
1918 *
1919 * %LOCK_EX -- an exclusive lock.
1920 *
1921 * %LOCK_UN -- remove an existing lock.
1922 *
1923 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1924 *
1925 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1926 * processes read and write access respectively.
1927 */
1928SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
1929{
1930 struct fd f = fdget(fd);
1931 struct file_lock *lock;
1932 int can_sleep, unlock;
1933 int error;
1934
1935 error = -EBADF;
1936 if (!f.file)
1937 goto out;
1938
1939 can_sleep = !(cmd & LOCK_NB);
1940 cmd &= ~LOCK_NB;
1941 unlock = (cmd == LOCK_UN);
1942
1943 if (!unlock && !(cmd & LOCK_MAND) &&
1944 !(f.file->f_mode & (FMODE_READ|FMODE_WRITE)))
1945 goto out_putf;
1946
1947 lock = flock_make_lock(f.file, cmd);
1948 if (IS_ERR(lock)) {
1949 error = PTR_ERR(lock);
1950 goto out_putf;
1951 }
1952
1953 if (can_sleep)
1954 lock->fl_flags |= FL_SLEEP;
1955
1956 error = security_file_lock(f.file, lock->fl_type);
1957 if (error)
1958 goto out_free;
1959
1960 if (f.file->f_op->flock)
1961 error = f.file->f_op->flock(f.file,
1962 (can_sleep) ? F_SETLKW : F_SETLK,
1963 lock);
1964 else
1965 error = locks_lock_file_wait(f.file, lock);
1966
1967 out_free:
1968 locks_free_lock(lock);
1969
1970 out_putf:
1971 fdput(f);
1972 out:
1973 return error;
1974}
1975
1976/**
1977 * vfs_test_lock - test file byte range lock
1978 * @filp: The file to test lock for
1979 * @fl: The lock to test; also used to hold result
1980 *
1981 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1982 * setting conf->fl_type to something other than F_UNLCK.
1983 */
1984int vfs_test_lock(struct file *filp, struct file_lock *fl)
1985{
1986 if (filp->f_op->lock)
1987 return filp->f_op->lock(filp, F_GETLK, fl);
1988 posix_test_lock(filp, fl);
1989 return 0;
1990}
1991EXPORT_SYMBOL_GPL(vfs_test_lock);
1992
1993static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1994{
1995 flock->l_pid = IS_OFDLCK(fl) ? -1 : fl->fl_pid;
1996#if BITS_PER_LONG == 32
1997 /*
1998 * Make sure we can represent the posix lock via
1999 * legacy 32bit flock.
2000 */
2001 if (fl->fl_start > OFFT_OFFSET_MAX)
2002 return -EOVERFLOW;
2003 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
2004 return -EOVERFLOW;
2005#endif
2006 flock->l_start = fl->fl_start;
2007 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2008 fl->fl_end - fl->fl_start + 1;
2009 flock->l_whence = 0;
2010 flock->l_type = fl->fl_type;
2011 return 0;
2012}
2013
2014#if BITS_PER_LONG == 32
2015static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
2016{
2017 flock->l_pid = IS_OFDLCK(fl) ? -1 : fl->fl_pid;
2018 flock->l_start = fl->fl_start;
2019 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2020 fl->fl_end - fl->fl_start + 1;
2021 flock->l_whence = 0;
2022 flock->l_type = fl->fl_type;
2023}
2024#endif
2025
2026/* Report the first existing lock that would conflict with l.
2027 * This implements the F_GETLK command of fcntl().
2028 */
2029int fcntl_getlk(struct file *filp, unsigned int cmd, struct flock __user *l)
2030{
2031 struct file_lock file_lock;
2032 struct flock flock;
2033 int error;
2034
2035 error = -EFAULT;
2036 if (copy_from_user(&flock, l, sizeof(flock)))
2037 goto out;
2038 error = -EINVAL;
2039 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
2040 goto out;
2041
2042 error = flock_to_posix_lock(filp, &file_lock, &flock);
2043 if (error)
2044 goto out;
2045
2046 if (cmd == F_OFD_GETLK) {
2047 error = -EINVAL;
2048 if (flock.l_pid != 0)
2049 goto out;
2050
2051 cmd = F_GETLK;
2052 file_lock.fl_flags |= FL_OFDLCK;
2053 file_lock.fl_owner = filp;
2054 }
2055
2056 error = vfs_test_lock(filp, &file_lock);
2057 if (error)
2058 goto out;
2059
2060 flock.l_type = file_lock.fl_type;
2061 if (file_lock.fl_type != F_UNLCK) {
2062 error = posix_lock_to_flock(&flock, &file_lock);
2063 if (error)
2064 goto rel_priv;
2065 }
2066 error = -EFAULT;
2067 if (!copy_to_user(l, &flock, sizeof(flock)))
2068 error = 0;
2069rel_priv:
2070 locks_release_private(&file_lock);
2071out:
2072 return error;
2073}
2074
2075/**
2076 * vfs_lock_file - file byte range lock
2077 * @filp: The file to apply the lock to
2078 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
2079 * @fl: The lock to be applied
2080 * @conf: Place to return a copy of the conflicting lock, if found.
2081 *
2082 * A caller that doesn't care about the conflicting lock may pass NULL
2083 * as the final argument.
2084 *
2085 * If the filesystem defines a private ->lock() method, then @conf will
2086 * be left unchanged; so a caller that cares should initialize it to
2087 * some acceptable default.
2088 *
2089 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
2090 * locks, the ->lock() interface may return asynchronously, before the lock has
2091 * been granted or denied by the underlying filesystem, if (and only if)
2092 * lm_grant is set. Callers expecting ->lock() to return asynchronously
2093 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
2094 * the request is for a blocking lock. When ->lock() does return asynchronously,
2095 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
2096 * request completes.
2097 * If the request is for non-blocking lock the file system should return
2098 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
2099 * with the result. If the request timed out the callback routine will return a
2100 * nonzero return code and the file system should release the lock. The file
2101 * system is also responsible to keep a corresponding posix lock when it
2102 * grants a lock so the VFS can find out which locks are locally held and do
2103 * the correct lock cleanup when required.
2104 * The underlying filesystem must not drop the kernel lock or call
2105 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
2106 * return code.
2107 */
2108int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
2109{
2110 if (filp->f_op->lock)
2111 return filp->f_op->lock(filp, cmd, fl);
2112 else
2113 return posix_lock_file(filp, fl, conf);
2114}
2115EXPORT_SYMBOL_GPL(vfs_lock_file);
2116
2117static int do_lock_file_wait(struct file *filp, unsigned int cmd,
2118 struct file_lock *fl)
2119{
2120 int error;
2121
2122 error = security_file_lock(filp, fl->fl_type);
2123 if (error)
2124 return error;
2125
2126 for (;;) {
2127 error = vfs_lock_file(filp, cmd, fl, NULL);
2128 if (error != FILE_LOCK_DEFERRED)
2129 break;
2130 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
2131 if (!error)
2132 continue;
2133
2134 locks_delete_block(fl);
2135 break;
2136 }
2137
2138 return error;
2139}
2140
2141/* Ensure that fl->fl_file has compatible f_mode for F_SETLK calls */
2142static int
2143check_fmode_for_setlk(struct file_lock *fl)
2144{
2145 switch (fl->fl_type) {
2146 case F_RDLCK:
2147 if (!(fl->fl_file->f_mode & FMODE_READ))
2148 return -EBADF;
2149 break;
2150 case F_WRLCK:
2151 if (!(fl->fl_file->f_mode & FMODE_WRITE))
2152 return -EBADF;
2153 }
2154 return 0;
2155}
2156
2157/* Apply the lock described by l to an open file descriptor.
2158 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2159 */
2160int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
2161 struct flock __user *l)
2162{
2163 struct file_lock *file_lock = locks_alloc_lock();
2164 struct flock flock;
2165 struct inode *inode;
2166 struct file *f;
2167 int error;
2168
2169 if (file_lock == NULL)
2170 return -ENOLCK;
2171
2172 inode = file_inode(filp);
2173
2174 /*
2175 * This might block, so we do it before checking the inode.
2176 */
2177 error = -EFAULT;
2178 if (copy_from_user(&flock, l, sizeof(flock)))
2179 goto out;
2180
2181 /* Don't allow mandatory locks on files that may be memory mapped
2182 * and shared.
2183 */
2184 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
2185 error = -EAGAIN;
2186 goto out;
2187 }
2188
2189 error = flock_to_posix_lock(filp, file_lock, &flock);
2190 if (error)
2191 goto out;
2192
2193 error = check_fmode_for_setlk(file_lock);
2194 if (error)
2195 goto out;
2196
2197 /*
2198 * If the cmd is requesting file-private locks, then set the
2199 * FL_OFDLCK flag and override the owner.
2200 */
2201 switch (cmd) {
2202 case F_OFD_SETLK:
2203 error = -EINVAL;
2204 if (flock.l_pid != 0)
2205 goto out;
2206
2207 cmd = F_SETLK;
2208 file_lock->fl_flags |= FL_OFDLCK;
2209 file_lock->fl_owner = filp;
2210 break;
2211 case F_OFD_SETLKW:
2212 error = -EINVAL;
2213 if (flock.l_pid != 0)
2214 goto out;
2215
2216 cmd = F_SETLKW;
2217 file_lock->fl_flags |= FL_OFDLCK;
2218 file_lock->fl_owner = filp;
2219 /* Fallthrough */
2220 case F_SETLKW:
2221 file_lock->fl_flags |= FL_SLEEP;
2222 }
2223
2224 error = do_lock_file_wait(filp, cmd, file_lock);
2225
2226 /*
2227 * Attempt to detect a close/fcntl race and recover by releasing the
2228 * lock that was just acquired. There is no need to do that when we're
2229 * unlocking though, or for OFD locks.
2230 */
2231 if (!error && file_lock->fl_type != F_UNLCK &&
2232 !(file_lock->fl_flags & FL_OFDLCK)) {
2233 /*
2234 * We need that spin_lock here - it prevents reordering between
2235 * update of i_flctx->flc_posix and check for it done in
2236 * close(). rcu_read_lock() wouldn't do.
2237 */
2238 spin_lock(&current->files->file_lock);
2239 f = fcheck(fd);
2240 spin_unlock(&current->files->file_lock);
2241 if (f != filp) {
2242 file_lock->fl_type = F_UNLCK;
2243 error = do_lock_file_wait(filp, cmd, file_lock);
2244 WARN_ON_ONCE(error);
2245 error = -EBADF;
2246 }
2247 }
2248out:
2249 trace_fcntl_setlk(inode, file_lock, error);
2250 locks_free_lock(file_lock);
2251 return error;
2252}
2253
2254#if BITS_PER_LONG == 32
2255/* Report the first existing lock that would conflict with l.
2256 * This implements the F_GETLK command of fcntl().
2257 */
2258int fcntl_getlk64(struct file *filp, unsigned int cmd, struct flock64 __user *l)
2259{
2260 struct file_lock file_lock;
2261 struct flock64 flock;
2262 int error;
2263
2264 error = -EFAULT;
2265 if (copy_from_user(&flock, l, sizeof(flock)))
2266 goto out;
2267 error = -EINVAL;
2268 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
2269 goto out;
2270
2271 error = flock64_to_posix_lock(filp, &file_lock, &flock);
2272 if (error)
2273 goto out;
2274
2275 if (cmd == F_OFD_GETLK) {
2276 error = -EINVAL;
2277 if (flock.l_pid != 0)
2278 goto out;
2279
2280 cmd = F_GETLK64;
2281 file_lock.fl_flags |= FL_OFDLCK;
2282 file_lock.fl_owner = filp;
2283 }
2284
2285 error = vfs_test_lock(filp, &file_lock);
2286 if (error)
2287 goto out;
2288
2289 flock.l_type = file_lock.fl_type;
2290 if (file_lock.fl_type != F_UNLCK)
2291 posix_lock_to_flock64(&flock, &file_lock);
2292
2293 error = -EFAULT;
2294 if (!copy_to_user(l, &flock, sizeof(flock)))
2295 error = 0;
2296
2297 locks_release_private(&file_lock);
2298out:
2299 return error;
2300}
2301
2302/* Apply the lock described by l to an open file descriptor.
2303 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2304 */
2305int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
2306 struct flock64 __user *l)
2307{
2308 struct file_lock *file_lock = locks_alloc_lock();
2309 struct flock64 flock;
2310 struct inode *inode;
2311 struct file *f;
2312 int error;
2313
2314 if (file_lock == NULL)
2315 return -ENOLCK;
2316
2317 /*
2318 * This might block, so we do it before checking the inode.
2319 */
2320 error = -EFAULT;
2321 if (copy_from_user(&flock, l, sizeof(flock)))
2322 goto out;
2323
2324 inode = file_inode(filp);
2325
2326 /* Don't allow mandatory locks on files that may be memory mapped
2327 * and shared.
2328 */
2329 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
2330 error = -EAGAIN;
2331 goto out;
2332 }
2333
2334 error = flock64_to_posix_lock(filp, file_lock, &flock);
2335 if (error)
2336 goto out;
2337
2338 error = check_fmode_for_setlk(file_lock);
2339 if (error)
2340 goto out;
2341
2342 /*
2343 * If the cmd is requesting file-private locks, then set the
2344 * FL_OFDLCK flag and override the owner.
2345 */
2346 switch (cmd) {
2347 case F_OFD_SETLK:
2348 error = -EINVAL;
2349 if (flock.l_pid != 0)
2350 goto out;
2351
2352 cmd = F_SETLK64;
2353 file_lock->fl_flags |= FL_OFDLCK;
2354 file_lock->fl_owner = filp;
2355 break;
2356 case F_OFD_SETLKW:
2357 error = -EINVAL;
2358 if (flock.l_pid != 0)
2359 goto out;
2360
2361 cmd = F_SETLKW64;
2362 file_lock->fl_flags |= FL_OFDLCK;
2363 file_lock->fl_owner = filp;
2364 /* Fallthrough */
2365 case F_SETLKW64:
2366 file_lock->fl_flags |= FL_SLEEP;
2367 }
2368
2369 error = do_lock_file_wait(filp, cmd, file_lock);
2370
2371 /*
2372 * Attempt to detect a close/fcntl race and recover by releasing the
2373 * lock that was just acquired. There is no need to do that when we're
2374 * unlocking though, or for OFD locks.
2375 */
2376 if (!error && file_lock->fl_type != F_UNLCK &&
2377 !(file_lock->fl_flags & FL_OFDLCK)) {
2378 /*
2379 * We need that spin_lock here - it prevents reordering between
2380 * update of i_flctx->flc_posix and check for it done in
2381 * close(). rcu_read_lock() wouldn't do.
2382 */
2383 spin_lock(&current->files->file_lock);
2384 f = fcheck(fd);
2385 spin_unlock(&current->files->file_lock);
2386 if (f != filp) {
2387 file_lock->fl_type = F_UNLCK;
2388 error = do_lock_file_wait(filp, cmd, file_lock);
2389 WARN_ON_ONCE(error);
2390 error = -EBADF;
2391 }
2392 }
2393out:
2394 locks_free_lock(file_lock);
2395 return error;
2396}
2397#endif /* BITS_PER_LONG == 32 */
2398
2399/*
2400 * This function is called when the file is being removed
2401 * from the task's fd array. POSIX locks belonging to this task
2402 * are deleted at this time.
2403 */
2404void locks_remove_posix(struct file *filp, fl_owner_t owner)
2405{
2406 int error;
2407 struct file_lock lock;
2408 struct file_lock_context *ctx;
2409
2410 /*
2411 * If there are no locks held on this file, we don't need to call
2412 * posix_lock_file(). Another process could be setting a lock on this
2413 * file at the same time, but we wouldn't remove that lock anyway.
2414 */
2415 ctx = smp_load_acquire(&file_inode(filp)->i_flctx);
2416 if (!ctx || list_empty(&ctx->flc_posix))
2417 return;
2418
2419 lock.fl_type = F_UNLCK;
2420 lock.fl_flags = FL_POSIX | FL_CLOSE;
2421 lock.fl_start = 0;
2422 lock.fl_end = OFFSET_MAX;
2423 lock.fl_owner = owner;
2424 lock.fl_pid = current->tgid;
2425 lock.fl_file = filp;
2426 lock.fl_ops = NULL;
2427 lock.fl_lmops = NULL;
2428
2429 error = vfs_lock_file(filp, F_SETLK, &lock, NULL);
2430
2431 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2432 lock.fl_ops->fl_release_private(&lock);
2433 trace_locks_remove_posix(file_inode(filp), &lock, error);
2434}
2435
2436EXPORT_SYMBOL(locks_remove_posix);
2437
2438/* The i_flctx must be valid when calling into here */
2439static void
2440locks_remove_flock(struct file *filp, struct file_lock_context *flctx)
2441{
2442 struct file_lock fl = {
2443 .fl_owner = filp,
2444 .fl_pid = current->tgid,
2445 .fl_file = filp,
2446 .fl_flags = FL_FLOCK,
2447 .fl_type = F_UNLCK,
2448 .fl_end = OFFSET_MAX,
2449 };
2450 struct inode *inode = file_inode(filp);
2451
2452 if (list_empty(&flctx->flc_flock))
2453 return;
2454
2455 if (filp->f_op->flock)
2456 filp->f_op->flock(filp, F_SETLKW, &fl);
2457 else
2458 flock_lock_inode(inode, &fl);
2459
2460 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2461 fl.fl_ops->fl_release_private(&fl);
2462}
2463
2464/* The i_flctx must be valid when calling into here */
2465static void
2466locks_remove_lease(struct file *filp, struct file_lock_context *ctx)
2467{
2468 struct file_lock *fl, *tmp;
2469 LIST_HEAD(dispose);
2470
2471 if (list_empty(&ctx->flc_lease))
2472 return;
2473
2474 spin_lock(&ctx->flc_lock);
2475 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list)
2476 if (filp == fl->fl_file)
2477 lease_modify(fl, F_UNLCK, &dispose);
2478 spin_unlock(&ctx->flc_lock);
2479 locks_dispose_list(&dispose);
2480}
2481
2482/*
2483 * This function is called on the last close of an open file.
2484 */
2485void locks_remove_file(struct file *filp)
2486{
2487 struct file_lock_context *ctx;
2488
2489 ctx = smp_load_acquire(&file_inode(filp)->i_flctx);
2490 if (!ctx)
2491 return;
2492
2493 /* remove any OFD locks */
2494 locks_remove_posix(filp, filp);
2495
2496 /* remove flock locks */
2497 locks_remove_flock(filp, ctx);
2498
2499 /* remove any leases */
2500 locks_remove_lease(filp, ctx);
2501}
2502
2503/**
2504 * posix_unblock_lock - stop waiting for a file lock
2505 * @waiter: the lock which was waiting
2506 *
2507 * lockd needs to block waiting for locks.
2508 */
2509int
2510posix_unblock_lock(struct file_lock *waiter)
2511{
2512 int status = 0;
2513
2514 spin_lock(&blocked_lock_lock);
2515 if (waiter->fl_next)
2516 __locks_delete_block(waiter);
2517 else
2518 status = -ENOENT;
2519 spin_unlock(&blocked_lock_lock);
2520 return status;
2521}
2522EXPORT_SYMBOL(posix_unblock_lock);
2523
2524/**
2525 * vfs_cancel_lock - file byte range unblock lock
2526 * @filp: The file to apply the unblock to
2527 * @fl: The lock to be unblocked
2528 *
2529 * Used by lock managers to cancel blocked requests
2530 */
2531int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2532{
2533 if (filp->f_op->lock)
2534 return filp->f_op->lock(filp, F_CANCELLK, fl);
2535 return 0;
2536}
2537
2538EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2539
2540#ifdef CONFIG_PROC_FS
2541#include <linux/proc_fs.h>
2542#include <linux/seq_file.h>
2543
2544struct locks_iterator {
2545 int li_cpu;
2546 loff_t li_pos;
2547};
2548
2549static void lock_get_status(struct seq_file *f, struct file_lock *fl,
2550 loff_t id, char *pfx)
2551{
2552 struct inode *inode = NULL;
2553 unsigned int fl_pid;
2554
2555 if (fl->fl_nspid)
2556 fl_pid = pid_vnr(fl->fl_nspid);
2557 else
2558 fl_pid = fl->fl_pid;
2559
2560 if (fl->fl_file != NULL)
2561 inode = file_inode(fl->fl_file);
2562
2563 seq_printf(f, "%lld:%s ", id, pfx);
2564 if (IS_POSIX(fl)) {
2565 if (fl->fl_flags & FL_ACCESS)
2566 seq_puts(f, "ACCESS");
2567 else if (IS_OFDLCK(fl))
2568 seq_puts(f, "OFDLCK");
2569 else
2570 seq_puts(f, "POSIX ");
2571
2572 seq_printf(f, " %s ",
2573 (inode == NULL) ? "*NOINODE*" :
2574 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
2575 } else if (IS_FLOCK(fl)) {
2576 if (fl->fl_type & LOCK_MAND) {
2577 seq_puts(f, "FLOCK MSNFS ");
2578 } else {
2579 seq_puts(f, "FLOCK ADVISORY ");
2580 }
2581 } else if (IS_LEASE(fl)) {
2582 if (fl->fl_flags & FL_DELEG)
2583 seq_puts(f, "DELEG ");
2584 else
2585 seq_puts(f, "LEASE ");
2586
2587 if (lease_breaking(fl))
2588 seq_puts(f, "BREAKING ");
2589 else if (fl->fl_file)
2590 seq_puts(f, "ACTIVE ");
2591 else
2592 seq_puts(f, "BREAKER ");
2593 } else {
2594 seq_puts(f, "UNKNOWN UNKNOWN ");
2595 }
2596 if (fl->fl_type & LOCK_MAND) {
2597 seq_printf(f, "%s ",
2598 (fl->fl_type & LOCK_READ)
2599 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2600 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2601 } else {
2602 seq_printf(f, "%s ",
2603 (lease_breaking(fl))
2604 ? (fl->fl_type == F_UNLCK) ? "UNLCK" : "READ "
2605 : (fl->fl_type == F_WRLCK) ? "WRITE" : "READ ");
2606 }
2607 if (inode) {
2608 /* userspace relies on this representation of dev_t */
2609 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
2610 MAJOR(inode->i_sb->s_dev),
2611 MINOR(inode->i_sb->s_dev), inode->i_ino);
2612 } else {
2613 seq_printf(f, "%d <none>:0 ", fl_pid);
2614 }
2615 if (IS_POSIX(fl)) {
2616 if (fl->fl_end == OFFSET_MAX)
2617 seq_printf(f, "%Ld EOF\n", fl->fl_start);
2618 else
2619 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
2620 } else {
2621 seq_puts(f, "0 EOF\n");
2622 }
2623}
2624
2625static int locks_show(struct seq_file *f, void *v)
2626{
2627 struct locks_iterator *iter = f->private;
2628 struct file_lock *fl, *bfl;
2629
2630 fl = hlist_entry(v, struct file_lock, fl_link);
2631
2632 lock_get_status(f, fl, iter->li_pos, "");
2633
2634 list_for_each_entry(bfl, &fl->fl_block, fl_block)
2635 lock_get_status(f, bfl, iter->li_pos, " ->");
2636
2637 return 0;
2638}
2639
2640static void __show_fd_locks(struct seq_file *f,
2641 struct list_head *head, int *id,
2642 struct file *filp, struct files_struct *files)
2643{
2644 struct file_lock *fl;
2645
2646 list_for_each_entry(fl, head, fl_list) {
2647
2648 if (filp != fl->fl_file)
2649 continue;
2650 if (fl->fl_owner != files &&
2651 fl->fl_owner != filp)
2652 continue;
2653
2654 (*id)++;
2655 seq_puts(f, "lock:\t");
2656 lock_get_status(f, fl, *id, "");
2657 }
2658}
2659
2660void show_fd_locks(struct seq_file *f,
2661 struct file *filp, struct files_struct *files)
2662{
2663 struct inode *inode = file_inode(filp);
2664 struct file_lock_context *ctx;
2665 int id = 0;
2666
2667 ctx = smp_load_acquire(&inode->i_flctx);
2668 if (!ctx)
2669 return;
2670
2671 spin_lock(&ctx->flc_lock);
2672 __show_fd_locks(f, &ctx->flc_flock, &id, filp, files);
2673 __show_fd_locks(f, &ctx->flc_posix, &id, filp, files);
2674 __show_fd_locks(f, &ctx->flc_lease, &id, filp, files);
2675 spin_unlock(&ctx->flc_lock);
2676}
2677
2678static void *locks_start(struct seq_file *f, loff_t *pos)
2679 __acquires(&blocked_lock_lock)
2680{
2681 struct locks_iterator *iter = f->private;
2682
2683 iter->li_pos = *pos + 1;
2684 lg_global_lock(&file_lock_lglock);
2685 spin_lock(&blocked_lock_lock);
2686 return seq_hlist_start_percpu(&file_lock_list, &iter->li_cpu, *pos);
2687}
2688
2689static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2690{
2691 struct locks_iterator *iter = f->private;
2692
2693 ++iter->li_pos;
2694 return seq_hlist_next_percpu(v, &file_lock_list, &iter->li_cpu, pos);
2695}
2696
2697static void locks_stop(struct seq_file *f, void *v)
2698 __releases(&blocked_lock_lock)
2699{
2700 spin_unlock(&blocked_lock_lock);
2701 lg_global_unlock(&file_lock_lglock);
2702}
2703
2704static const struct seq_operations locks_seq_operations = {
2705 .start = locks_start,
2706 .next = locks_next,
2707 .stop = locks_stop,
2708 .show = locks_show,
2709};
2710
2711static int locks_open(struct inode *inode, struct file *filp)
2712{
2713 return seq_open_private(filp, &locks_seq_operations,
2714 sizeof(struct locks_iterator));
2715}
2716
2717static const struct file_operations proc_locks_operations = {
2718 .open = locks_open,
2719 .read = seq_read,
2720 .llseek = seq_lseek,
2721 .release = seq_release_private,
2722};
2723
2724static int __init proc_locks_init(void)
2725{
2726 proc_create("locks", 0, NULL, &proc_locks_operations);
2727 return 0;
2728}
2729fs_initcall(proc_locks_init);
2730#endif
2731
2732static int __init filelock_init(void)
2733{
2734 int i;
2735
2736 flctx_cache = kmem_cache_create("file_lock_ctx",
2737 sizeof(struct file_lock_context), 0, SLAB_PANIC, NULL);
2738
2739 filelock_cache = kmem_cache_create("file_lock_cache",
2740 sizeof(struct file_lock), 0, SLAB_PANIC, NULL);
2741
2742 lg_lock_init(&file_lock_lglock, "file_lock_lglock");
2743
2744 for_each_possible_cpu(i)
2745 INIT_HLIST_HEAD(per_cpu_ptr(&file_lock_list, i));
2746
2747 return 0;
2748}
2749
2750core_initcall(filelock_init);