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