4 * Provide support for fcntl()'s F_GETLK, F_SETLK, and F_SETLKW calls.
5 * Doug Evans (dje@spiff.uucp), August 07, 1992
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.
12 * Miscellaneous edits, and a total rewrite of posix_lock_file() code.
13 * Kai Petzke (wpp@marie.physik.tu-berlin.de), 1994
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
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
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
31 * Implemented two lock personalities - FL_FLOCK and FL_POSIX.
33 * FL_POSIX locks are created with calls to fcntl() and lockf() through the
34 * fcntl() system call. They have the semantics described above.
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.
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
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
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.
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.
61 * Initial implementation of mandatory locks. SunOS turned out to be
62 * a rotten model, so I implemented the "obvious" semantics.
63 * See 'Documentation/mandatory.txt' for details.
64 * Andy Walker (andy@lysaker.kvaerner.no), April 06, 1996.
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
70 * Andy Walker (andy@lysaker.kvaerner.no), April 09, 1996.
72 * Tidied up block list handling. Added '/proc/locks' interface.
73 * Andy Walker (andy@lysaker.kvaerner.no), April 24, 1996.
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.
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.
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.
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.
94 * Made the block list a circular list to minimise searching in the list.
95 * Andy Walker (andy@lysaker.kvaerner.no), Sep 25, 1996.
97 * Made mandatory locking a mount option. Default is not to allow mandatory
99 * Andy Walker (andy@lysaker.kvaerner.no), Oct 04, 1996.
101 * Some adaptations for NFS support.
102 * Olaf Kirch (okir@monad.swb.de), Dec 1996,
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.
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.
112 * Leases and LOCK_MAND
113 * Matthew Wilcox <willy@debian.org>, June, 2000.
114 * Stephen Rothwell <sfr@canb.auug.org.au>, June, 2000.
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/module.h>
123 #include <linux/security.h>
124 #include <linux/slab.h>
125 #include <linux/syscalls.h>
126 #include <linux/time.h>
127 #include <linux/rcupdate.h>
128 #include <linux/pid_namespace.h>
130 #include <asm/uaccess.h>
132 #define IS_POSIX(fl) (fl->fl_flags & FL_POSIX)
133 #define IS_FLOCK(fl) (fl->fl_flags & FL_FLOCK)
134 #define IS_LEASE(fl) (fl->fl_flags & FL_LEASE)
136 static bool lease_breaking(struct file_lock
*fl
)
138 return fl
->fl_flags
& (FL_UNLOCK_PENDING
| FL_DOWNGRADE_PENDING
);
141 static int target_leasetype(struct file_lock
*fl
)
143 if (fl
->fl_flags
& FL_UNLOCK_PENDING
)
145 if (fl
->fl_flags
& FL_DOWNGRADE_PENDING
)
150 int leases_enable
= 1;
151 int lease_break_time
= 45;
153 #define for_each_lock(inode, lockp) \
154 for (lockp = &inode->i_flock; *lockp != NULL; lockp = &(*lockp)->fl_next)
156 static LIST_HEAD(file_lock_list
);
157 static LIST_HEAD(blocked_list
);
158 static DEFINE_SPINLOCK(file_lock_lock
);
161 * Protects the two list heads above, plus the inode->i_flock list
163 void lock_flocks(void)
165 spin_lock(&file_lock_lock
);
167 EXPORT_SYMBOL_GPL(lock_flocks
);
169 void unlock_flocks(void)
171 spin_unlock(&file_lock_lock
);
173 EXPORT_SYMBOL_GPL(unlock_flocks
);
175 static struct kmem_cache
*filelock_cache __read_mostly
;
177 static void locks_init_lock_heads(struct file_lock
*fl
)
179 INIT_LIST_HEAD(&fl
->fl_link
);
180 INIT_LIST_HEAD(&fl
->fl_block
);
181 init_waitqueue_head(&fl
->fl_wait
);
184 /* Allocate an empty lock structure. */
185 struct file_lock
*locks_alloc_lock(void)
187 struct file_lock
*fl
= kmem_cache_zalloc(filelock_cache
, GFP_KERNEL
);
190 locks_init_lock_heads(fl
);
194 EXPORT_SYMBOL_GPL(locks_alloc_lock
);
196 void locks_release_private(struct file_lock
*fl
)
199 if (fl
->fl_ops
->fl_release_private
)
200 fl
->fl_ops
->fl_release_private(fl
);
204 if (fl
->fl_lmops
->lm_release_private
)
205 fl
->fl_lmops
->lm_release_private(fl
);
210 EXPORT_SYMBOL_GPL(locks_release_private
);
212 /* Free a lock which is not in use. */
213 void locks_free_lock(struct file_lock
*fl
)
215 BUG_ON(waitqueue_active(&fl
->fl_wait
));
216 BUG_ON(!list_empty(&fl
->fl_block
));
217 BUG_ON(!list_empty(&fl
->fl_link
));
219 locks_release_private(fl
);
220 kmem_cache_free(filelock_cache
, fl
);
222 EXPORT_SYMBOL(locks_free_lock
);
224 void locks_init_lock(struct file_lock
*fl
)
226 memset(fl
, 0, sizeof(struct file_lock
));
227 locks_init_lock_heads(fl
);
230 EXPORT_SYMBOL(locks_init_lock
);
232 static void locks_copy_private(struct file_lock
*new, struct file_lock
*fl
)
235 if (fl
->fl_ops
->fl_copy_lock
)
236 fl
->fl_ops
->fl_copy_lock(new, fl
);
237 new->fl_ops
= fl
->fl_ops
;
240 new->fl_lmops
= fl
->fl_lmops
;
244 * Initialize a new lock from an existing file_lock structure.
246 void __locks_copy_lock(struct file_lock
*new, const struct file_lock
*fl
)
248 new->fl_owner
= fl
->fl_owner
;
249 new->fl_pid
= fl
->fl_pid
;
251 new->fl_flags
= fl
->fl_flags
;
252 new->fl_type
= fl
->fl_type
;
253 new->fl_start
= fl
->fl_start
;
254 new->fl_end
= fl
->fl_end
;
256 new->fl_lmops
= NULL
;
258 EXPORT_SYMBOL(__locks_copy_lock
);
260 void locks_copy_lock(struct file_lock
*new, struct file_lock
*fl
)
262 locks_release_private(new);
264 __locks_copy_lock(new, fl
);
265 new->fl_file
= fl
->fl_file
;
266 new->fl_ops
= fl
->fl_ops
;
267 new->fl_lmops
= fl
->fl_lmops
;
269 locks_copy_private(new, fl
);
272 EXPORT_SYMBOL(locks_copy_lock
);
274 static inline int flock_translate_cmd(int cmd
) {
276 return cmd
& (LOCK_MAND
| LOCK_RW
);
288 /* Fill in a file_lock structure with an appropriate FLOCK lock. */
289 static int flock_make_lock(struct file
*filp
, struct file_lock
**lock
,
292 struct file_lock
*fl
;
293 int type
= flock_translate_cmd(cmd
);
297 fl
= locks_alloc_lock();
302 fl
->fl_pid
= current
->tgid
;
303 fl
->fl_flags
= FL_FLOCK
;
305 fl
->fl_end
= OFFSET_MAX
;
311 static int assign_type(struct file_lock
*fl
, int type
)
325 /* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
328 static int flock_to_posix_lock(struct file
*filp
, struct file_lock
*fl
,
333 switch (l
->l_whence
) {
341 start
= i_size_read(filp
->f_path
.dentry
->d_inode
);
347 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
348 POSIX-2001 defines it. */
352 fl
->fl_end
= OFFSET_MAX
;
354 end
= start
+ l
->l_len
- 1;
356 } else if (l
->l_len
< 0) {
363 fl
->fl_start
= start
; /* we record the absolute position */
364 if (fl
->fl_end
< fl
->fl_start
)
367 fl
->fl_owner
= current
->files
;
368 fl
->fl_pid
= current
->tgid
;
370 fl
->fl_flags
= FL_POSIX
;
374 return assign_type(fl
, l
->l_type
);
377 #if BITS_PER_LONG == 32
378 static int flock64_to_posix_lock(struct file
*filp
, struct file_lock
*fl
,
383 switch (l
->l_whence
) {
391 start
= i_size_read(filp
->f_path
.dentry
->d_inode
);
400 fl
->fl_end
= OFFSET_MAX
;
402 fl
->fl_end
= start
+ l
->l_len
- 1;
403 } else if (l
->l_len
< 0) {
404 fl
->fl_end
= start
- 1;
409 fl
->fl_start
= start
; /* we record the absolute position */
410 if (fl
->fl_end
< fl
->fl_start
)
413 fl
->fl_owner
= current
->files
;
414 fl
->fl_pid
= current
->tgid
;
416 fl
->fl_flags
= FL_POSIX
;
420 return assign_type(fl
, l
->l_type
);
424 /* default lease lock manager operations */
425 static void lease_break_callback(struct file_lock
*fl
)
427 kill_fasync(&fl
->fl_fasync
, SIGIO
, POLL_MSG
);
430 static void lease_release_private_callback(struct file_lock
*fl
)
435 f_delown(fl
->fl_file
);
436 fl
->fl_file
->f_owner
.signum
= 0;
439 static const struct lock_manager_operations lease_manager_ops
= {
440 .lm_break
= lease_break_callback
,
441 .lm_release_private
= lease_release_private_callback
,
442 .lm_change
= lease_modify
,
446 * Initialize a lease, use the default lock manager operations
448 static int lease_init(struct file
*filp
, int type
, struct file_lock
*fl
)
450 if (assign_type(fl
, type
) != 0)
453 fl
->fl_owner
= current
->files
;
454 fl
->fl_pid
= current
->tgid
;
457 fl
->fl_flags
= FL_LEASE
;
459 fl
->fl_end
= OFFSET_MAX
;
461 fl
->fl_lmops
= &lease_manager_ops
;
465 /* Allocate a file_lock initialised to this type of lease */
466 static struct file_lock
*lease_alloc(struct file
*filp
, int type
)
468 struct file_lock
*fl
= locks_alloc_lock();
472 return ERR_PTR(error
);
474 error
= lease_init(filp
, type
, fl
);
477 return ERR_PTR(error
);
482 /* Check if two locks overlap each other.
484 static inline int locks_overlap(struct file_lock
*fl1
, struct file_lock
*fl2
)
486 return ((fl1
->fl_end
>= fl2
->fl_start
) &&
487 (fl2
->fl_end
>= fl1
->fl_start
));
491 * Check whether two locks have the same owner.
493 static int posix_same_owner(struct file_lock
*fl1
, struct file_lock
*fl2
)
495 if (fl1
->fl_lmops
&& fl1
->fl_lmops
->lm_compare_owner
)
496 return fl2
->fl_lmops
== fl1
->fl_lmops
&&
497 fl1
->fl_lmops
->lm_compare_owner(fl1
, fl2
);
498 return fl1
->fl_owner
== fl2
->fl_owner
;
501 /* Remove waiter from blocker's block list.
502 * When blocker ends up pointing to itself then the list is empty.
504 static void __locks_delete_block(struct file_lock
*waiter
)
506 list_del_init(&waiter
->fl_block
);
507 list_del_init(&waiter
->fl_link
);
508 waiter
->fl_next
= NULL
;
513 static void locks_delete_block(struct file_lock
*waiter
)
516 __locks_delete_block(waiter
);
520 /* Insert waiter into blocker's block list.
521 * We use a circular list so that processes can be easily woken up in
522 * the order they blocked. The documentation doesn't require this but
523 * it seems like the reasonable thing to do.
525 static void locks_insert_block(struct file_lock
*blocker
,
526 struct file_lock
*waiter
)
528 BUG_ON(!list_empty(&waiter
->fl_block
));
529 list_add_tail(&waiter
->fl_block
, &blocker
->fl_block
);
530 waiter
->fl_next
= blocker
;
531 if (IS_POSIX(blocker
))
532 list_add(&waiter
->fl_link
, &blocked_list
);
535 /* Wake up processes blocked waiting for blocker.
536 * If told to wait then schedule the processes until the block list
537 * is empty, otherwise empty the block list ourselves.
539 static void locks_wake_up_blocks(struct file_lock
*blocker
)
541 while (!list_empty(&blocker
->fl_block
)) {
542 struct file_lock
*waiter
;
544 waiter
= list_first_entry(&blocker
->fl_block
,
545 struct file_lock
, fl_block
);
546 __locks_delete_block(waiter
);
547 if (waiter
->fl_lmops
&& waiter
->fl_lmops
->lm_notify
)
548 waiter
->fl_lmops
->lm_notify(waiter
);
550 wake_up(&waiter
->fl_wait
);
554 /* Insert file lock fl into an inode's lock list at the position indicated
555 * by pos. At the same time add the lock to the global file lock list.
557 static void locks_insert_lock(struct file_lock
**pos
, struct file_lock
*fl
)
559 list_add(&fl
->fl_link
, &file_lock_list
);
561 fl
->fl_nspid
= get_pid(task_tgid(current
));
563 /* insert into file's list */
569 * Delete a lock and then free it.
570 * Wake up processes that are blocked waiting for this lock,
571 * notify the FS that the lock has been cleared and
572 * finally free the lock.
574 static void locks_delete_lock(struct file_lock
**thisfl_p
)
576 struct file_lock
*fl
= *thisfl_p
;
578 *thisfl_p
= fl
->fl_next
;
580 list_del_init(&fl
->fl_link
);
582 fasync_helper(0, fl
->fl_file
, 0, &fl
->fl_fasync
);
583 if (fl
->fl_fasync
!= NULL
) {
584 printk(KERN_ERR
"locks_delete_lock: fasync == %p\n", fl
->fl_fasync
);
585 fl
->fl_fasync
= NULL
;
589 put_pid(fl
->fl_nspid
);
593 locks_wake_up_blocks(fl
);
597 /* Determine if lock sys_fl blocks lock caller_fl. Common functionality
598 * checks for shared/exclusive status of overlapping locks.
600 static int locks_conflict(struct file_lock
*caller_fl
, struct file_lock
*sys_fl
)
602 if (sys_fl
->fl_type
== F_WRLCK
)
604 if (caller_fl
->fl_type
== F_WRLCK
)
609 /* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
610 * checking before calling the locks_conflict().
612 static int posix_locks_conflict(struct file_lock
*caller_fl
, struct file_lock
*sys_fl
)
614 /* POSIX locks owned by the same process do not conflict with
617 if (!IS_POSIX(sys_fl
) || posix_same_owner(caller_fl
, sys_fl
))
620 /* Check whether they overlap */
621 if (!locks_overlap(caller_fl
, sys_fl
))
624 return (locks_conflict(caller_fl
, sys_fl
));
627 /* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
628 * checking before calling the locks_conflict().
630 static int flock_locks_conflict(struct file_lock
*caller_fl
, struct file_lock
*sys_fl
)
632 /* FLOCK locks referring to the same filp do not conflict with
635 if (!IS_FLOCK(sys_fl
) || (caller_fl
->fl_file
== sys_fl
->fl_file
))
637 if ((caller_fl
->fl_type
& LOCK_MAND
) || (sys_fl
->fl_type
& LOCK_MAND
))
640 return (locks_conflict(caller_fl
, sys_fl
));
644 posix_test_lock(struct file
*filp
, struct file_lock
*fl
)
646 struct file_lock
*cfl
;
649 for (cfl
= filp
->f_path
.dentry
->d_inode
->i_flock
; cfl
; cfl
= cfl
->fl_next
) {
652 if (posix_locks_conflict(fl
, cfl
))
656 __locks_copy_lock(fl
, cfl
);
658 fl
->fl_pid
= pid_vnr(cfl
->fl_nspid
);
660 fl
->fl_type
= F_UNLCK
;
664 EXPORT_SYMBOL(posix_test_lock
);
667 * Deadlock detection:
669 * We attempt to detect deadlocks that are due purely to posix file
672 * We assume that a task can be waiting for at most one lock at a time.
673 * So for any acquired lock, the process holding that lock may be
674 * waiting on at most one other lock. That lock in turns may be held by
675 * someone waiting for at most one other lock. Given a requested lock
676 * caller_fl which is about to wait for a conflicting lock block_fl, we
677 * follow this chain of waiters to ensure we are not about to create a
680 * Since we do this before we ever put a process to sleep on a lock, we
681 * are ensured that there is never a cycle; that is what guarantees that
682 * the while() loop in posix_locks_deadlock() eventually completes.
684 * Note: the above assumption may not be true when handling lock
685 * requests from a broken NFS client. It may also fail in the presence
686 * of tasks (such as posix threads) sharing the same open file table.
688 * To handle those cases, we just bail out after a few iterations.
691 #define MAX_DEADLK_ITERATIONS 10
693 /* Find a lock that the owner of the given block_fl is blocking on. */
694 static struct file_lock
*what_owner_is_waiting_for(struct file_lock
*block_fl
)
696 struct file_lock
*fl
;
698 list_for_each_entry(fl
, &blocked_list
, fl_link
) {
699 if (posix_same_owner(fl
, block_fl
))
705 static int posix_locks_deadlock(struct file_lock
*caller_fl
,
706 struct file_lock
*block_fl
)
710 while ((block_fl
= what_owner_is_waiting_for(block_fl
))) {
711 if (i
++ > MAX_DEADLK_ITERATIONS
)
713 if (posix_same_owner(caller_fl
, block_fl
))
719 /* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
720 * after any leases, but before any posix locks.
722 * Note that if called with an FL_EXISTS argument, the caller may determine
723 * whether or not a lock was successfully freed by testing the return
726 static int flock_lock_file(struct file
*filp
, struct file_lock
*request
)
728 struct file_lock
*new_fl
= NULL
;
729 struct file_lock
**before
;
730 struct inode
* inode
= filp
->f_path
.dentry
->d_inode
;
734 if (!(request
->fl_flags
& FL_ACCESS
) && (request
->fl_type
!= F_UNLCK
)) {
735 new_fl
= locks_alloc_lock();
741 if (request
->fl_flags
& FL_ACCESS
)
744 for_each_lock(inode
, before
) {
745 struct file_lock
*fl
= *before
;
750 if (filp
!= fl
->fl_file
)
752 if (request
->fl_type
== fl
->fl_type
)
755 locks_delete_lock(before
);
759 if (request
->fl_type
== F_UNLCK
) {
760 if ((request
->fl_flags
& FL_EXISTS
) && !found
)
766 * If a higher-priority process was blocked on the old file lock,
767 * give it the opportunity to lock the file.
776 for_each_lock(inode
, before
) {
777 struct file_lock
*fl
= *before
;
782 if (!flock_locks_conflict(request
, fl
))
785 if (!(request
->fl_flags
& FL_SLEEP
))
787 error
= FILE_LOCK_DEFERRED
;
788 locks_insert_block(fl
, request
);
791 if (request
->fl_flags
& FL_ACCESS
)
793 locks_copy_lock(new_fl
, request
);
794 locks_insert_lock(before
, new_fl
);
801 locks_free_lock(new_fl
);
805 static int __posix_lock_file(struct inode
*inode
, struct file_lock
*request
, struct file_lock
*conflock
)
807 struct file_lock
*fl
;
808 struct file_lock
*new_fl
= NULL
;
809 struct file_lock
*new_fl2
= NULL
;
810 struct file_lock
*left
= NULL
;
811 struct file_lock
*right
= NULL
;
812 struct file_lock
**before
;
813 int error
, added
= 0;
816 * We may need two file_lock structures for this operation,
817 * so we get them in advance to avoid races.
819 * In some cases we can be sure, that no new locks will be needed
821 if (!(request
->fl_flags
& FL_ACCESS
) &&
822 (request
->fl_type
!= F_UNLCK
||
823 request
->fl_start
!= 0 || request
->fl_end
!= OFFSET_MAX
)) {
824 new_fl
= locks_alloc_lock();
825 new_fl2
= locks_alloc_lock();
829 if (request
->fl_type
!= F_UNLCK
) {
830 for_each_lock(inode
, before
) {
834 if (!posix_locks_conflict(request
, fl
))
837 __locks_copy_lock(conflock
, fl
);
839 if (!(request
->fl_flags
& FL_SLEEP
))
842 if (posix_locks_deadlock(request
, fl
))
844 error
= FILE_LOCK_DEFERRED
;
845 locks_insert_block(fl
, request
);
850 /* If we're just looking for a conflict, we're done. */
852 if (request
->fl_flags
& FL_ACCESS
)
856 * Find the first old lock with the same owner as the new lock.
859 before
= &inode
->i_flock
;
861 /* First skip locks owned by other processes. */
862 while ((fl
= *before
) && (!IS_POSIX(fl
) ||
863 !posix_same_owner(request
, fl
))) {
864 before
= &fl
->fl_next
;
867 /* Process locks with this owner. */
868 while ((fl
= *before
) && posix_same_owner(request
, fl
)) {
869 /* Detect adjacent or overlapping regions (if same lock type)
871 if (request
->fl_type
== fl
->fl_type
) {
872 /* In all comparisons of start vs end, use
873 * "start - 1" rather than "end + 1". If end
874 * is OFFSET_MAX, end + 1 will become negative.
876 if (fl
->fl_end
< request
->fl_start
- 1)
878 /* If the next lock in the list has entirely bigger
879 * addresses than the new one, insert the lock here.
881 if (fl
->fl_start
- 1 > request
->fl_end
)
884 /* If we come here, the new and old lock are of the
885 * same type and adjacent or overlapping. Make one
886 * lock yielding from the lower start address of both
887 * locks to the higher end address.
889 if (fl
->fl_start
> request
->fl_start
)
890 fl
->fl_start
= request
->fl_start
;
892 request
->fl_start
= fl
->fl_start
;
893 if (fl
->fl_end
< request
->fl_end
)
894 fl
->fl_end
= request
->fl_end
;
896 request
->fl_end
= fl
->fl_end
;
898 locks_delete_lock(before
);
905 /* Processing for different lock types is a bit
908 if (fl
->fl_end
< request
->fl_start
)
910 if (fl
->fl_start
> request
->fl_end
)
912 if (request
->fl_type
== F_UNLCK
)
914 if (fl
->fl_start
< request
->fl_start
)
916 /* If the next lock in the list has a higher end
917 * address than the new one, insert the new one here.
919 if (fl
->fl_end
> request
->fl_end
) {
923 if (fl
->fl_start
>= request
->fl_start
) {
924 /* The new lock completely replaces an old
925 * one (This may happen several times).
928 locks_delete_lock(before
);
931 /* Replace the old lock with the new one.
932 * Wake up anybody waiting for the old one,
933 * as the change in lock type might satisfy
936 locks_wake_up_blocks(fl
);
937 fl
->fl_start
= request
->fl_start
;
938 fl
->fl_end
= request
->fl_end
;
939 fl
->fl_type
= request
->fl_type
;
940 locks_release_private(fl
);
941 locks_copy_private(fl
, request
);
946 /* Go on to next lock.
949 before
= &fl
->fl_next
;
953 * The above code only modifies existing locks in case of
954 * merging or replacing. If new lock(s) need to be inserted
955 * all modifications are done bellow this, so it's safe yet to
958 error
= -ENOLCK
; /* "no luck" */
959 if (right
&& left
== right
&& !new_fl2
)
964 if (request
->fl_type
== F_UNLCK
) {
965 if (request
->fl_flags
& FL_EXISTS
)
974 locks_copy_lock(new_fl
, request
);
975 locks_insert_lock(before
, new_fl
);
980 /* The new lock breaks the old one in two pieces,
981 * so we have to use the second new lock.
985 locks_copy_lock(left
, right
);
986 locks_insert_lock(before
, left
);
988 right
->fl_start
= request
->fl_end
+ 1;
989 locks_wake_up_blocks(right
);
992 left
->fl_end
= request
->fl_start
- 1;
993 locks_wake_up_blocks(left
);
998 * Free any unused locks.
1001 locks_free_lock(new_fl
);
1003 locks_free_lock(new_fl2
);
1008 * posix_lock_file - Apply a POSIX-style lock to a file
1009 * @filp: The file to apply the lock to
1010 * @fl: The lock to be applied
1011 * @conflock: Place to return a copy of the conflicting lock, if found.
1013 * Add a POSIX style lock to a file.
1014 * We merge adjacent & overlapping locks whenever possible.
1015 * POSIX locks are sorted by owner task, then by starting address
1017 * Note that if called with an FL_EXISTS argument, the caller may determine
1018 * whether or not a lock was successfully freed by testing the return
1019 * value for -ENOENT.
1021 int posix_lock_file(struct file
*filp
, struct file_lock
*fl
,
1022 struct file_lock
*conflock
)
1024 return __posix_lock_file(filp
->f_path
.dentry
->d_inode
, fl
, conflock
);
1026 EXPORT_SYMBOL(posix_lock_file
);
1029 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1030 * @filp: The file to apply the lock to
1031 * @fl: The lock to be applied
1033 * Add a POSIX style lock to a file.
1034 * We merge adjacent & overlapping locks whenever possible.
1035 * POSIX locks are sorted by owner task, then by starting address
1037 int posix_lock_file_wait(struct file
*filp
, struct file_lock
*fl
)
1042 error
= posix_lock_file(filp
, fl
, NULL
);
1043 if (error
!= FILE_LOCK_DEFERRED
)
1045 error
= wait_event_interruptible(fl
->fl_wait
, !fl
->fl_next
);
1049 locks_delete_block(fl
);
1054 EXPORT_SYMBOL(posix_lock_file_wait
);
1057 * locks_mandatory_locked - Check for an active lock
1058 * @inode: the file to check
1060 * Searches the inode's list of locks to find any POSIX locks which conflict.
1061 * This function is called from locks_verify_locked() only.
1063 int locks_mandatory_locked(struct inode
*inode
)
1065 fl_owner_t owner
= current
->files
;
1066 struct file_lock
*fl
;
1069 * Search the lock list for this inode for any POSIX locks.
1072 for (fl
= inode
->i_flock
; fl
!= NULL
; fl
= fl
->fl_next
) {
1075 if (fl
->fl_owner
!= owner
)
1079 return fl
? -EAGAIN
: 0;
1083 * locks_mandatory_area - Check for a conflicting lock
1084 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1086 * @inode: the file to check
1087 * @filp: how the file was opened (if it was)
1088 * @offset: start of area to check
1089 * @count: length of area to check
1091 * Searches the inode's list of locks to find any POSIX locks which conflict.
1092 * This function is called from rw_verify_area() and
1093 * locks_verify_truncate().
1095 int locks_mandatory_area(int read_write
, struct inode
*inode
,
1096 struct file
*filp
, loff_t offset
,
1099 struct file_lock fl
;
1102 locks_init_lock(&fl
);
1103 fl
.fl_owner
= current
->files
;
1104 fl
.fl_pid
= current
->tgid
;
1106 fl
.fl_flags
= FL_POSIX
| FL_ACCESS
;
1107 if (filp
&& !(filp
->f_flags
& O_NONBLOCK
))
1108 fl
.fl_flags
|= FL_SLEEP
;
1109 fl
.fl_type
= (read_write
== FLOCK_VERIFY_WRITE
) ? F_WRLCK
: F_RDLCK
;
1110 fl
.fl_start
= offset
;
1111 fl
.fl_end
= offset
+ count
- 1;
1114 error
= __posix_lock_file(inode
, &fl
, NULL
);
1115 if (error
!= FILE_LOCK_DEFERRED
)
1117 error
= wait_event_interruptible(fl
.fl_wait
, !fl
.fl_next
);
1120 * If we've been sleeping someone might have
1121 * changed the permissions behind our back.
1123 if (__mandatory_lock(inode
))
1127 locks_delete_block(&fl
);
1134 EXPORT_SYMBOL(locks_mandatory_area
);
1136 static void lease_clear_pending(struct file_lock
*fl
, int arg
)
1140 fl
->fl_flags
&= ~FL_UNLOCK_PENDING
;
1143 fl
->fl_flags
&= ~FL_DOWNGRADE_PENDING
;
1147 /* We already had a lease on this file; just change its type */
1148 int lease_modify(struct file_lock
**before
, int arg
)
1150 struct file_lock
*fl
= *before
;
1151 int error
= assign_type(fl
, arg
);
1155 lease_clear_pending(fl
, arg
);
1156 locks_wake_up_blocks(fl
);
1158 locks_delete_lock(before
);
1162 EXPORT_SYMBOL(lease_modify
);
1164 static bool past_time(unsigned long then
)
1167 /* 0 is a special value meaning "this never expires": */
1169 return time_after(jiffies
, then
);
1172 static void time_out_leases(struct inode
*inode
)
1174 struct file_lock
**before
;
1175 struct file_lock
*fl
;
1177 before
= &inode
->i_flock
;
1178 while ((fl
= *before
) && IS_LEASE(fl
) && lease_breaking(fl
)) {
1179 if (past_time(fl
->fl_downgrade_time
))
1180 lease_modify(before
, F_RDLCK
);
1181 if (past_time(fl
->fl_break_time
))
1182 lease_modify(before
, F_UNLCK
);
1183 if (fl
== *before
) /* lease_modify may have freed fl */
1184 before
= &fl
->fl_next
;
1189 * __break_lease - revoke all outstanding leases on file
1190 * @inode: the inode of the file to return
1191 * @mode: the open mode (read or write)
1193 * break_lease (inlined for speed) has checked there already is at least
1194 * some kind of lock (maybe a lease) on this file. Leases are broken on
1195 * a call to open() or truncate(). This function can sleep unless you
1196 * specified %O_NONBLOCK to your open().
1198 int __break_lease(struct inode
*inode
, unsigned int mode
)
1201 struct file_lock
*new_fl
, *flock
;
1202 struct file_lock
*fl
;
1203 unsigned long break_time
;
1204 int i_have_this_lease
= 0;
1205 int want_write
= (mode
& O_ACCMODE
) != O_RDONLY
;
1207 new_fl
= lease_alloc(NULL
, want_write
? F_WRLCK
: F_RDLCK
);
1211 time_out_leases(inode
);
1213 flock
= inode
->i_flock
;
1214 if ((flock
== NULL
) || !IS_LEASE(flock
))
1217 if (!locks_conflict(flock
, new_fl
))
1220 for (fl
= flock
; fl
&& IS_LEASE(fl
); fl
= fl
->fl_next
)
1221 if (fl
->fl_owner
== current
->files
)
1222 i_have_this_lease
= 1;
1224 if (IS_ERR(new_fl
) && !i_have_this_lease
1225 && ((mode
& O_NONBLOCK
) == 0)) {
1226 error
= PTR_ERR(new_fl
);
1231 if (lease_break_time
> 0) {
1232 break_time
= jiffies
+ lease_break_time
* HZ
;
1233 if (break_time
== 0)
1234 break_time
++; /* so that 0 means no break time */
1237 for (fl
= flock
; fl
&& IS_LEASE(fl
); fl
= fl
->fl_next
) {
1239 if (fl
->fl_flags
& FL_UNLOCK_PENDING
)
1241 fl
->fl_flags
|= FL_UNLOCK_PENDING
;
1242 fl
->fl_break_time
= break_time
;
1244 if (lease_breaking(flock
))
1246 fl
->fl_flags
|= FL_DOWNGRADE_PENDING
;
1247 fl
->fl_downgrade_time
= break_time
;
1249 fl
->fl_lmops
->lm_break(fl
);
1252 if (i_have_this_lease
|| (mode
& O_NONBLOCK
)) {
1253 error
= -EWOULDBLOCK
;
1258 break_time
= flock
->fl_break_time
;
1259 if (break_time
!= 0) {
1260 break_time
-= jiffies
;
1261 if (break_time
== 0)
1264 locks_insert_block(flock
, new_fl
);
1266 error
= wait_event_interruptible_timeout(new_fl
->fl_wait
,
1267 !new_fl
->fl_next
, break_time
);
1269 __locks_delete_block(new_fl
);
1272 time_out_leases(inode
);
1274 * Wait for the next conflicting lease that has not been
1277 for (flock
= inode
->i_flock
; flock
&& IS_LEASE(flock
);
1278 flock
= flock
->fl_next
) {
1279 if (locks_conflict(new_fl
, flock
))
1287 if (!IS_ERR(new_fl
))
1288 locks_free_lock(new_fl
);
1292 EXPORT_SYMBOL(__break_lease
);
1295 * lease_get_mtime - get the last modified time of an inode
1297 * @time: pointer to a timespec which will contain the last modified time
1299 * This is to force NFS clients to flush their caches for files with
1300 * exclusive leases. The justification is that if someone has an
1301 * exclusive lease, then they could be modifying it.
1303 void lease_get_mtime(struct inode
*inode
, struct timespec
*time
)
1305 struct file_lock
*flock
= inode
->i_flock
;
1306 if (flock
&& IS_LEASE(flock
) && (flock
->fl_type
& F_WRLCK
))
1307 *time
= current_fs_time(inode
->i_sb
);
1309 *time
= inode
->i_mtime
;
1312 EXPORT_SYMBOL(lease_get_mtime
);
1315 * fcntl_getlease - Enquire what lease is currently active
1318 * The value returned by this function will be one of
1319 * (if no lease break is pending):
1321 * %F_RDLCK to indicate a shared lease is held.
1323 * %F_WRLCK to indicate an exclusive lease is held.
1325 * %F_UNLCK to indicate no lease is held.
1327 * (if a lease break is pending):
1329 * %F_RDLCK to indicate an exclusive lease needs to be
1330 * changed to a shared lease (or removed).
1332 * %F_UNLCK to indicate the lease needs to be removed.
1334 * XXX: sfr & willy disagree over whether F_INPROGRESS
1335 * should be returned to userspace.
1337 int fcntl_getlease(struct file
*filp
)
1339 struct file_lock
*fl
;
1343 time_out_leases(filp
->f_path
.dentry
->d_inode
);
1344 for (fl
= filp
->f_path
.dentry
->d_inode
->i_flock
; fl
&& IS_LEASE(fl
);
1346 if (fl
->fl_file
== filp
) {
1347 type
= target_leasetype(fl
);
1356 * generic_setlease - sets a lease on an open file
1357 * @filp: file pointer
1358 * @arg: type of lease to obtain
1359 * @flp: input - file_lock to use, output - file_lock inserted
1361 * The (input) flp->fl_lmops->lm_break function is required
1364 * Called with file_lock_lock held.
1366 int generic_setlease(struct file
*filp
, long arg
, struct file_lock
**flp
)
1368 struct file_lock
*fl
, **before
, **my_before
= NULL
, *lease
;
1369 struct dentry
*dentry
= filp
->f_path
.dentry
;
1370 struct inode
*inode
= dentry
->d_inode
;
1376 if ((current_fsuid() != inode
->i_uid
) && !capable(CAP_LEASE
))
1379 if (!S_ISREG(inode
->i_mode
))
1381 error
= security_file_lock(filp
, arg
);
1385 time_out_leases(inode
);
1387 BUG_ON(!(*flp
)->fl_lmops
->lm_break
);
1389 if (arg
!= F_UNLCK
) {
1391 if ((arg
== F_RDLCK
) && (atomic_read(&inode
->i_writecount
) > 0))
1393 if ((arg
== F_WRLCK
)
1394 && ((dentry
->d_count
> 1)
1395 || (atomic_read(&inode
->i_count
) > 1)))
1400 * At this point, we know that if there is an exclusive
1401 * lease on this file, then we hold it on this filp
1402 * (otherwise our open of this file would have blocked).
1403 * And if we are trying to acquire an exclusive lease,
1404 * then the file is not open by anyone (including us)
1405 * except for this filp.
1408 for (before
= &inode
->i_flock
;
1409 ((fl
= *before
) != NULL
) && IS_LEASE(fl
);
1410 before
= &fl
->fl_next
) {
1411 if (fl
->fl_file
== filp
) {
1416 * No exclusive leases if someone else has a lease on
1422 * Modifying our existing lease is OK, but no getting a
1423 * new lease if someone else is opening for write:
1425 if (fl
->fl_flags
& FL_UNLOCK_PENDING
)
1429 if (my_before
!= NULL
) {
1430 error
= lease
->fl_lmops
->lm_change(my_before
, arg
);
1443 locks_insert_lock(before
, lease
);
1449 EXPORT_SYMBOL(generic_setlease
);
1451 static int __vfs_setlease(struct file
*filp
, long arg
, struct file_lock
**lease
)
1453 if (filp
->f_op
&& filp
->f_op
->setlease
)
1454 return filp
->f_op
->setlease(filp
, arg
, lease
);
1456 return generic_setlease(filp
, arg
, lease
);
1460 * vfs_setlease - sets a lease on an open file
1461 * @filp: file pointer
1462 * @arg: type of lease to obtain
1463 * @lease: file_lock to use
1465 * Call this to establish a lease on the file.
1466 * The (*lease)->fl_lmops->lm_break operation must be set; if not,
1467 * break_lease will oops!
1469 * This will call the filesystem's setlease file method, if
1470 * defined. Note that there is no getlease method; instead, the
1471 * filesystem setlease method should call back to setlease() to
1472 * add a lease to the inode's lease list, where fcntl_getlease() can
1473 * find it. Since fcntl_getlease() only reports whether the current
1474 * task holds a lease, a cluster filesystem need only do this for
1475 * leases held by processes on this node.
1477 * There is also no break_lease method; filesystems that
1478 * handle their own leases should break leases themselves from the
1479 * filesystem's open, create, and (on truncate) setattr methods.
1481 * Warning: the only current setlease methods exist only to disable
1482 * leases in certain cases. More vfs changes may be required to
1483 * allow a full filesystem lease implementation.
1486 int vfs_setlease(struct file
*filp
, long arg
, struct file_lock
**lease
)
1491 error
= __vfs_setlease(filp
, arg
, lease
);
1496 EXPORT_SYMBOL_GPL(vfs_setlease
);
1498 static int do_fcntl_delete_lease(struct file
*filp
)
1500 struct file_lock fl
, *flp
= &fl
;
1502 lease_init(filp
, F_UNLCK
, flp
);
1504 return vfs_setlease(filp
, F_UNLCK
, &flp
);
1507 static int do_fcntl_add_lease(unsigned int fd
, struct file
*filp
, long arg
)
1509 struct file_lock
*fl
, *ret
;
1510 struct fasync_struct
*new;
1513 fl
= lease_alloc(filp
, arg
);
1517 new = fasync_alloc();
1519 locks_free_lock(fl
);
1524 error
= __vfs_setlease(filp
, arg
, &ret
);
1527 locks_free_lock(fl
);
1528 goto out_free_fasync
;
1531 locks_free_lock(fl
);
1534 * fasync_insert_entry() returns the old entry if any.
1535 * If there was no old entry, then it used 'new' and
1536 * inserted it into the fasync list. Clear new so that
1537 * we don't release it here.
1539 if (!fasync_insert_entry(fd
, filp
, &ret
->fl_fasync
, new))
1542 error
= __f_setown(filp
, task_pid(current
), PIDTYPE_PID
, 0);
1552 * fcntl_setlease - sets a lease on an open file
1553 * @fd: open file descriptor
1554 * @filp: file pointer
1555 * @arg: type of lease to obtain
1557 * Call this fcntl to establish a lease on the file.
1558 * Note that you also need to call %F_SETSIG to
1559 * receive a signal when the lease is broken.
1561 int fcntl_setlease(unsigned int fd
, struct file
*filp
, long arg
)
1564 return do_fcntl_delete_lease(filp
);
1565 return do_fcntl_add_lease(fd
, filp
, arg
);
1569 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1570 * @filp: The file to apply the lock to
1571 * @fl: The lock to be applied
1573 * Add a FLOCK style lock to a file.
1575 int flock_lock_file_wait(struct file
*filp
, struct file_lock
*fl
)
1580 error
= flock_lock_file(filp
, fl
);
1581 if (error
!= FILE_LOCK_DEFERRED
)
1583 error
= wait_event_interruptible(fl
->fl_wait
, !fl
->fl_next
);
1587 locks_delete_block(fl
);
1593 EXPORT_SYMBOL(flock_lock_file_wait
);
1596 * sys_flock: - flock() system call.
1597 * @fd: the file descriptor to lock.
1598 * @cmd: the type of lock to apply.
1600 * Apply a %FL_FLOCK style lock to an open file descriptor.
1601 * The @cmd can be one of
1603 * %LOCK_SH -- a shared lock.
1605 * %LOCK_EX -- an exclusive lock.
1607 * %LOCK_UN -- remove an existing lock.
1609 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1611 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1612 * processes read and write access respectively.
1614 SYSCALL_DEFINE2(flock
, unsigned int, fd
, unsigned int, cmd
)
1617 struct file_lock
*lock
;
1618 int can_sleep
, unlock
;
1626 can_sleep
= !(cmd
& LOCK_NB
);
1628 unlock
= (cmd
== LOCK_UN
);
1630 if (!unlock
&& !(cmd
& LOCK_MAND
) &&
1631 !(filp
->f_mode
& (FMODE_READ
|FMODE_WRITE
)))
1634 error
= flock_make_lock(filp
, &lock
, cmd
);
1638 lock
->fl_flags
|= FL_SLEEP
;
1640 error
= security_file_lock(filp
, lock
->fl_type
);
1644 if (filp
->f_op
&& filp
->f_op
->flock
)
1645 error
= filp
->f_op
->flock(filp
,
1646 (can_sleep
) ? F_SETLKW
: F_SETLK
,
1649 error
= flock_lock_file_wait(filp
, lock
);
1652 locks_free_lock(lock
);
1661 * vfs_test_lock - test file byte range lock
1662 * @filp: The file to test lock for
1663 * @fl: The lock to test; also used to hold result
1665 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1666 * setting conf->fl_type to something other than F_UNLCK.
1668 int vfs_test_lock(struct file
*filp
, struct file_lock
*fl
)
1670 if (filp
->f_op
&& filp
->f_op
->lock
)
1671 return filp
->f_op
->lock(filp
, F_GETLK
, fl
);
1672 posix_test_lock(filp
, fl
);
1675 EXPORT_SYMBOL_GPL(vfs_test_lock
);
1677 static int posix_lock_to_flock(struct flock
*flock
, struct file_lock
*fl
)
1679 flock
->l_pid
= fl
->fl_pid
;
1680 #if BITS_PER_LONG == 32
1682 * Make sure we can represent the posix lock via
1683 * legacy 32bit flock.
1685 if (fl
->fl_start
> OFFT_OFFSET_MAX
)
1687 if (fl
->fl_end
!= OFFSET_MAX
&& fl
->fl_end
> OFFT_OFFSET_MAX
)
1690 flock
->l_start
= fl
->fl_start
;
1691 flock
->l_len
= fl
->fl_end
== OFFSET_MAX
? 0 :
1692 fl
->fl_end
- fl
->fl_start
+ 1;
1693 flock
->l_whence
= 0;
1694 flock
->l_type
= fl
->fl_type
;
1698 #if BITS_PER_LONG == 32
1699 static void posix_lock_to_flock64(struct flock64
*flock
, struct file_lock
*fl
)
1701 flock
->l_pid
= fl
->fl_pid
;
1702 flock
->l_start
= fl
->fl_start
;
1703 flock
->l_len
= fl
->fl_end
== OFFSET_MAX
? 0 :
1704 fl
->fl_end
- fl
->fl_start
+ 1;
1705 flock
->l_whence
= 0;
1706 flock
->l_type
= fl
->fl_type
;
1710 /* Report the first existing lock that would conflict with l.
1711 * This implements the F_GETLK command of fcntl().
1713 int fcntl_getlk(struct file
*filp
, struct flock __user
*l
)
1715 struct file_lock file_lock
;
1720 if (copy_from_user(&flock
, l
, sizeof(flock
)))
1723 if ((flock
.l_type
!= F_RDLCK
) && (flock
.l_type
!= F_WRLCK
))
1726 error
= flock_to_posix_lock(filp
, &file_lock
, &flock
);
1730 error
= vfs_test_lock(filp
, &file_lock
);
1734 flock
.l_type
= file_lock
.fl_type
;
1735 if (file_lock
.fl_type
!= F_UNLCK
) {
1736 error
= posix_lock_to_flock(&flock
, &file_lock
);
1741 if (!copy_to_user(l
, &flock
, sizeof(flock
)))
1748 * vfs_lock_file - file byte range lock
1749 * @filp: The file to apply the lock to
1750 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
1751 * @fl: The lock to be applied
1752 * @conf: Place to return a copy of the conflicting lock, if found.
1754 * A caller that doesn't care about the conflicting lock may pass NULL
1755 * as the final argument.
1757 * If the filesystem defines a private ->lock() method, then @conf will
1758 * be left unchanged; so a caller that cares should initialize it to
1759 * some acceptable default.
1761 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
1762 * locks, the ->lock() interface may return asynchronously, before the lock has
1763 * been granted or denied by the underlying filesystem, if (and only if)
1764 * lm_grant is set. Callers expecting ->lock() to return asynchronously
1765 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
1766 * the request is for a blocking lock. When ->lock() does return asynchronously,
1767 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
1768 * request completes.
1769 * If the request is for non-blocking lock the file system should return
1770 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
1771 * with the result. If the request timed out the callback routine will return a
1772 * nonzero return code and the file system should release the lock. The file
1773 * system is also responsible to keep a corresponding posix lock when it
1774 * grants a lock so the VFS can find out which locks are locally held and do
1775 * the correct lock cleanup when required.
1776 * The underlying filesystem must not drop the kernel lock or call
1777 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
1780 int vfs_lock_file(struct file
*filp
, unsigned int cmd
, struct file_lock
*fl
, struct file_lock
*conf
)
1782 if (filp
->f_op
&& filp
->f_op
->lock
)
1783 return filp
->f_op
->lock(filp
, cmd
, fl
);
1785 return posix_lock_file(filp
, fl
, conf
);
1787 EXPORT_SYMBOL_GPL(vfs_lock_file
);
1789 static int do_lock_file_wait(struct file
*filp
, unsigned int cmd
,
1790 struct file_lock
*fl
)
1794 error
= security_file_lock(filp
, fl
->fl_type
);
1799 error
= vfs_lock_file(filp
, cmd
, fl
, NULL
);
1800 if (error
!= FILE_LOCK_DEFERRED
)
1802 error
= wait_event_interruptible(fl
->fl_wait
, !fl
->fl_next
);
1806 locks_delete_block(fl
);
1813 /* Apply the lock described by l to an open file descriptor.
1814 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1816 int fcntl_setlk(unsigned int fd
, struct file
*filp
, unsigned int cmd
,
1817 struct flock __user
*l
)
1819 struct file_lock
*file_lock
= locks_alloc_lock();
1821 struct inode
*inode
;
1825 if (file_lock
== NULL
)
1829 * This might block, so we do it before checking the inode.
1832 if (copy_from_user(&flock
, l
, sizeof(flock
)))
1835 inode
= filp
->f_path
.dentry
->d_inode
;
1837 /* Don't allow mandatory locks on files that may be memory mapped
1840 if (mandatory_lock(inode
) && mapping_writably_mapped(filp
->f_mapping
)) {
1846 error
= flock_to_posix_lock(filp
, file_lock
, &flock
);
1849 if (cmd
== F_SETLKW
) {
1850 file_lock
->fl_flags
|= FL_SLEEP
;
1854 switch (flock
.l_type
) {
1856 if (!(filp
->f_mode
& FMODE_READ
))
1860 if (!(filp
->f_mode
& FMODE_WRITE
))
1870 error
= do_lock_file_wait(filp
, cmd
, file_lock
);
1873 * Attempt to detect a close/fcntl race and recover by
1874 * releasing the lock that was just acquired.
1877 * we need that spin_lock here - it prevents reordering between
1878 * update of inode->i_flock and check for it done in close().
1879 * rcu_read_lock() wouldn't do.
1881 spin_lock(¤t
->files
->file_lock
);
1883 spin_unlock(¤t
->files
->file_lock
);
1884 if (!error
&& f
!= filp
&& flock
.l_type
!= F_UNLCK
) {
1885 flock
.l_type
= F_UNLCK
;
1890 locks_free_lock(file_lock
);
1894 #if BITS_PER_LONG == 32
1895 /* Report the first existing lock that would conflict with l.
1896 * This implements the F_GETLK command of fcntl().
1898 int fcntl_getlk64(struct file
*filp
, struct flock64 __user
*l
)
1900 struct file_lock file_lock
;
1901 struct flock64 flock
;
1905 if (copy_from_user(&flock
, l
, sizeof(flock
)))
1908 if ((flock
.l_type
!= F_RDLCK
) && (flock
.l_type
!= F_WRLCK
))
1911 error
= flock64_to_posix_lock(filp
, &file_lock
, &flock
);
1915 error
= vfs_test_lock(filp
, &file_lock
);
1919 flock
.l_type
= file_lock
.fl_type
;
1920 if (file_lock
.fl_type
!= F_UNLCK
)
1921 posix_lock_to_flock64(&flock
, &file_lock
);
1924 if (!copy_to_user(l
, &flock
, sizeof(flock
)))
1931 /* Apply the lock described by l to an open file descriptor.
1932 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1934 int fcntl_setlk64(unsigned int fd
, struct file
*filp
, unsigned int cmd
,
1935 struct flock64 __user
*l
)
1937 struct file_lock
*file_lock
= locks_alloc_lock();
1938 struct flock64 flock
;
1939 struct inode
*inode
;
1943 if (file_lock
== NULL
)
1947 * This might block, so we do it before checking the inode.
1950 if (copy_from_user(&flock
, l
, sizeof(flock
)))
1953 inode
= filp
->f_path
.dentry
->d_inode
;
1955 /* Don't allow mandatory locks on files that may be memory mapped
1958 if (mandatory_lock(inode
) && mapping_writably_mapped(filp
->f_mapping
)) {
1964 error
= flock64_to_posix_lock(filp
, file_lock
, &flock
);
1967 if (cmd
== F_SETLKW64
) {
1968 file_lock
->fl_flags
|= FL_SLEEP
;
1972 switch (flock
.l_type
) {
1974 if (!(filp
->f_mode
& FMODE_READ
))
1978 if (!(filp
->f_mode
& FMODE_WRITE
))
1988 error
= do_lock_file_wait(filp
, cmd
, file_lock
);
1991 * Attempt to detect a close/fcntl race and recover by
1992 * releasing the lock that was just acquired.
1994 spin_lock(¤t
->files
->file_lock
);
1996 spin_unlock(¤t
->files
->file_lock
);
1997 if (!error
&& f
!= filp
&& flock
.l_type
!= F_UNLCK
) {
1998 flock
.l_type
= F_UNLCK
;
2003 locks_free_lock(file_lock
);
2006 #endif /* BITS_PER_LONG == 32 */
2009 * This function is called when the file is being removed
2010 * from the task's fd array. POSIX locks belonging to this task
2011 * are deleted at this time.
2013 void locks_remove_posix(struct file
*filp
, fl_owner_t owner
)
2015 struct file_lock lock
;
2018 * If there are no locks held on this file, we don't need to call
2019 * posix_lock_file(). Another process could be setting a lock on this
2020 * file at the same time, but we wouldn't remove that lock anyway.
2022 if (!filp
->f_path
.dentry
->d_inode
->i_flock
)
2025 lock
.fl_type
= F_UNLCK
;
2026 lock
.fl_flags
= FL_POSIX
| FL_CLOSE
;
2028 lock
.fl_end
= OFFSET_MAX
;
2029 lock
.fl_owner
= owner
;
2030 lock
.fl_pid
= current
->tgid
;
2031 lock
.fl_file
= filp
;
2033 lock
.fl_lmops
= NULL
;
2035 vfs_lock_file(filp
, F_SETLK
, &lock
, NULL
);
2037 if (lock
.fl_ops
&& lock
.fl_ops
->fl_release_private
)
2038 lock
.fl_ops
->fl_release_private(&lock
);
2041 EXPORT_SYMBOL(locks_remove_posix
);
2044 * This function is called on the last close of an open file.
2046 void locks_remove_flock(struct file
*filp
)
2048 struct inode
* inode
= filp
->f_path
.dentry
->d_inode
;
2049 struct file_lock
*fl
;
2050 struct file_lock
**before
;
2052 if (!inode
->i_flock
)
2055 if (filp
->f_op
&& filp
->f_op
->flock
) {
2056 struct file_lock fl
= {
2057 .fl_pid
= current
->tgid
,
2059 .fl_flags
= FL_FLOCK
,
2061 .fl_end
= OFFSET_MAX
,
2063 filp
->f_op
->flock(filp
, F_SETLKW
, &fl
);
2064 if (fl
.fl_ops
&& fl
.fl_ops
->fl_release_private
)
2065 fl
.fl_ops
->fl_release_private(&fl
);
2069 before
= &inode
->i_flock
;
2071 while ((fl
= *before
) != NULL
) {
2072 if (fl
->fl_file
== filp
) {
2074 locks_delete_lock(before
);
2078 lease_modify(before
, F_UNLCK
);
2084 before
= &fl
->fl_next
;
2090 * posix_unblock_lock - stop waiting for a file lock
2091 * @filp: how the file was opened
2092 * @waiter: the lock which was waiting
2094 * lockd needs to block waiting for locks.
2097 posix_unblock_lock(struct file
*filp
, struct file_lock
*waiter
)
2102 if (waiter
->fl_next
)
2103 __locks_delete_block(waiter
);
2110 EXPORT_SYMBOL(posix_unblock_lock
);
2113 * vfs_cancel_lock - file byte range unblock lock
2114 * @filp: The file to apply the unblock to
2115 * @fl: The lock to be unblocked
2117 * Used by lock managers to cancel blocked requests
2119 int vfs_cancel_lock(struct file
*filp
, struct file_lock
*fl
)
2121 if (filp
->f_op
&& filp
->f_op
->lock
)
2122 return filp
->f_op
->lock(filp
, F_CANCELLK
, fl
);
2126 EXPORT_SYMBOL_GPL(vfs_cancel_lock
);
2128 #ifdef CONFIG_PROC_FS
2129 #include <linux/proc_fs.h>
2130 #include <linux/seq_file.h>
2132 static void lock_get_status(struct seq_file
*f
, struct file_lock
*fl
,
2133 loff_t id
, char *pfx
)
2135 struct inode
*inode
= NULL
;
2136 unsigned int fl_pid
;
2139 fl_pid
= pid_vnr(fl
->fl_nspid
);
2141 fl_pid
= fl
->fl_pid
;
2143 if (fl
->fl_file
!= NULL
)
2144 inode
= fl
->fl_file
->f_path
.dentry
->d_inode
;
2146 seq_printf(f
, "%lld:%s ", id
, pfx
);
2148 seq_printf(f
, "%6s %s ",
2149 (fl
->fl_flags
& FL_ACCESS
) ? "ACCESS" : "POSIX ",
2150 (inode
== NULL
) ? "*NOINODE*" :
2151 mandatory_lock(inode
) ? "MANDATORY" : "ADVISORY ");
2152 } else if (IS_FLOCK(fl
)) {
2153 if (fl
->fl_type
& LOCK_MAND
) {
2154 seq_printf(f
, "FLOCK MSNFS ");
2156 seq_printf(f
, "FLOCK ADVISORY ");
2158 } else if (IS_LEASE(fl
)) {
2159 seq_printf(f
, "LEASE ");
2160 if (lease_breaking(fl
))
2161 seq_printf(f
, "BREAKING ");
2162 else if (fl
->fl_file
)
2163 seq_printf(f
, "ACTIVE ");
2165 seq_printf(f
, "BREAKER ");
2167 seq_printf(f
, "UNKNOWN UNKNOWN ");
2169 if (fl
->fl_type
& LOCK_MAND
) {
2170 seq_printf(f
, "%s ",
2171 (fl
->fl_type
& LOCK_READ
)
2172 ? (fl
->fl_type
& LOCK_WRITE
) ? "RW " : "READ "
2173 : (fl
->fl_type
& LOCK_WRITE
) ? "WRITE" : "NONE ");
2175 seq_printf(f
, "%s ",
2176 (lease_breaking(fl
))
2177 ? (fl
->fl_type
& F_UNLCK
) ? "UNLCK" : "READ "
2178 : (fl
->fl_type
& F_WRLCK
) ? "WRITE" : "READ ");
2181 #ifdef WE_CAN_BREAK_LSLK_NOW
2182 seq_printf(f
, "%d %s:%ld ", fl_pid
,
2183 inode
->i_sb
->s_id
, inode
->i_ino
);
2185 /* userspace relies on this representation of dev_t ;-( */
2186 seq_printf(f
, "%d %02x:%02x:%ld ", fl_pid
,
2187 MAJOR(inode
->i_sb
->s_dev
),
2188 MINOR(inode
->i_sb
->s_dev
), inode
->i_ino
);
2191 seq_printf(f
, "%d <none>:0 ", fl_pid
);
2194 if (fl
->fl_end
== OFFSET_MAX
)
2195 seq_printf(f
, "%Ld EOF\n", fl
->fl_start
);
2197 seq_printf(f
, "%Ld %Ld\n", fl
->fl_start
, fl
->fl_end
);
2199 seq_printf(f
, "0 EOF\n");
2203 static int locks_show(struct seq_file
*f
, void *v
)
2205 struct file_lock
*fl
, *bfl
;
2207 fl
= list_entry(v
, struct file_lock
, fl_link
);
2209 lock_get_status(f
, fl
, *((loff_t
*)f
->private), "");
2211 list_for_each_entry(bfl
, &fl
->fl_block
, fl_block
)
2212 lock_get_status(f
, bfl
, *((loff_t
*)f
->private), " ->");
2217 static void *locks_start(struct seq_file
*f
, loff_t
*pos
)
2219 loff_t
*p
= f
->private;
2223 return seq_list_start(&file_lock_list
, *pos
);
2226 static void *locks_next(struct seq_file
*f
, void *v
, loff_t
*pos
)
2228 loff_t
*p
= f
->private;
2230 return seq_list_next(v
, &file_lock_list
, pos
);
2233 static void locks_stop(struct seq_file
*f
, void *v
)
2238 static const struct seq_operations locks_seq_operations
= {
2239 .start
= locks_start
,
2245 static int locks_open(struct inode
*inode
, struct file
*filp
)
2247 return seq_open_private(filp
, &locks_seq_operations
, sizeof(loff_t
));
2250 static const struct file_operations proc_locks_operations
= {
2253 .llseek
= seq_lseek
,
2254 .release
= seq_release_private
,
2257 static int __init
proc_locks_init(void)
2259 proc_create("locks", 0, NULL
, &proc_locks_operations
);
2262 module_init(proc_locks_init
);
2266 * lock_may_read - checks that the region is free of locks
2267 * @inode: the inode that is being read
2268 * @start: the first byte to read
2269 * @len: the number of bytes to read
2271 * Emulates Windows locking requirements. Whole-file
2272 * mandatory locks (share modes) can prohibit a read and
2273 * byte-range POSIX locks can prohibit a read if they overlap.
2275 * N.B. this function is only ever called
2276 * from knfsd and ownership of locks is never checked.
2278 int lock_may_read(struct inode
*inode
, loff_t start
, unsigned long len
)
2280 struct file_lock
*fl
;
2283 for (fl
= inode
->i_flock
; fl
!= NULL
; fl
= fl
->fl_next
) {
2285 if (fl
->fl_type
== F_RDLCK
)
2287 if ((fl
->fl_end
< start
) || (fl
->fl_start
> (start
+ len
)))
2289 } else if (IS_FLOCK(fl
)) {
2290 if (!(fl
->fl_type
& LOCK_MAND
))
2292 if (fl
->fl_type
& LOCK_READ
)
2303 EXPORT_SYMBOL(lock_may_read
);
2306 * lock_may_write - checks that the region is free of locks
2307 * @inode: the inode that is being written
2308 * @start: the first byte to write
2309 * @len: the number of bytes to write
2311 * Emulates Windows locking requirements. Whole-file
2312 * mandatory locks (share modes) can prohibit a write and
2313 * byte-range POSIX locks can prohibit a write if they overlap.
2315 * N.B. this function is only ever called
2316 * from knfsd and ownership of locks is never checked.
2318 int lock_may_write(struct inode
*inode
, loff_t start
, unsigned long len
)
2320 struct file_lock
*fl
;
2323 for (fl
= inode
->i_flock
; fl
!= NULL
; fl
= fl
->fl_next
) {
2325 if ((fl
->fl_end
< start
) || (fl
->fl_start
> (start
+ len
)))
2327 } else if (IS_FLOCK(fl
)) {
2328 if (!(fl
->fl_type
& LOCK_MAND
))
2330 if (fl
->fl_type
& LOCK_WRITE
)
2341 EXPORT_SYMBOL(lock_may_write
);
2343 static int __init
filelock_init(void)
2345 filelock_cache
= kmem_cache_create("file_lock_cache",
2346 sizeof(struct file_lock
), 0, SLAB_PANIC
, NULL
);
2351 core_initcall(filelock_init
);