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 int leases_enable
= 1;
137 int lease_break_time
= 45;
139 #define for_each_lock(inode, lockp) \
140 for (lockp = &inode->i_flock; *lockp != NULL; lockp = &(*lockp)->fl_next)
142 static LIST_HEAD(file_lock_list
);
143 static LIST_HEAD(blocked_list
);
144 static DEFINE_SPINLOCK(file_lock_lock
);
147 * Protects the two list heads above, plus the inode->i_flock list
148 * FIXME: should use a spinlock, once lockd and ceph are ready.
150 void lock_flocks(void)
152 spin_lock(&file_lock_lock
);
154 EXPORT_SYMBOL_GPL(lock_flocks
);
156 void unlock_flocks(void)
158 spin_unlock(&file_lock_lock
);
160 EXPORT_SYMBOL_GPL(unlock_flocks
);
162 static struct kmem_cache
*filelock_cache __read_mostly
;
164 /* Allocate an empty lock structure. */
165 struct file_lock
*locks_alloc_lock(void)
167 return kmem_cache_alloc(filelock_cache
, GFP_KERNEL
);
169 EXPORT_SYMBOL_GPL(locks_alloc_lock
);
171 void locks_release_private(struct file_lock
*fl
)
174 if (fl
->fl_ops
->fl_release_private
)
175 fl
->fl_ops
->fl_release_private(fl
);
179 if (fl
->fl_lmops
->fl_release_private
)
180 fl
->fl_lmops
->fl_release_private(fl
);
185 EXPORT_SYMBOL_GPL(locks_release_private
);
187 /* Free a lock which is not in use. */
188 void locks_free_lock(struct file_lock
*fl
)
190 BUG_ON(waitqueue_active(&fl
->fl_wait
));
191 BUG_ON(!list_empty(&fl
->fl_block
));
192 BUG_ON(!list_empty(&fl
->fl_link
));
194 locks_release_private(fl
);
195 kmem_cache_free(filelock_cache
, fl
);
197 EXPORT_SYMBOL(locks_free_lock
);
199 void locks_init_lock(struct file_lock
*fl
)
201 INIT_LIST_HEAD(&fl
->fl_link
);
202 INIT_LIST_HEAD(&fl
->fl_block
);
203 init_waitqueue_head(&fl
->fl_wait
);
205 fl
->fl_fasync
= NULL
;
212 fl
->fl_start
= fl
->fl_end
= 0;
217 EXPORT_SYMBOL(locks_init_lock
);
220 * Initialises the fields of the file lock which are invariant for
223 static void init_once(void *foo
)
225 struct file_lock
*lock
= (struct file_lock
*) foo
;
227 locks_init_lock(lock
);
230 static void locks_copy_private(struct file_lock
*new, struct file_lock
*fl
)
233 if (fl
->fl_ops
->fl_copy_lock
)
234 fl
->fl_ops
->fl_copy_lock(new, fl
);
235 new->fl_ops
= fl
->fl_ops
;
238 new->fl_lmops
= fl
->fl_lmops
;
242 * Initialize a new lock from an existing file_lock structure.
244 void __locks_copy_lock(struct file_lock
*new, const struct file_lock
*fl
)
246 new->fl_owner
= fl
->fl_owner
;
247 new->fl_pid
= fl
->fl_pid
;
249 new->fl_flags
= fl
->fl_flags
;
250 new->fl_type
= fl
->fl_type
;
251 new->fl_start
= fl
->fl_start
;
252 new->fl_end
= fl
->fl_end
;
254 new->fl_lmops
= NULL
;
256 EXPORT_SYMBOL(__locks_copy_lock
);
258 void locks_copy_lock(struct file_lock
*new, struct file_lock
*fl
)
260 locks_release_private(new);
262 __locks_copy_lock(new, fl
);
263 new->fl_file
= fl
->fl_file
;
264 new->fl_ops
= fl
->fl_ops
;
265 new->fl_lmops
= fl
->fl_lmops
;
267 locks_copy_private(new, fl
);
270 EXPORT_SYMBOL(locks_copy_lock
);
272 static inline int flock_translate_cmd(int cmd
) {
274 return cmd
& (LOCK_MAND
| LOCK_RW
);
286 /* Fill in a file_lock structure with an appropriate FLOCK lock. */
287 static int flock_make_lock(struct file
*filp
, struct file_lock
**lock
,
290 struct file_lock
*fl
;
291 int type
= flock_translate_cmd(cmd
);
295 fl
= locks_alloc_lock();
300 fl
->fl_pid
= current
->tgid
;
301 fl
->fl_flags
= FL_FLOCK
;
303 fl
->fl_end
= OFFSET_MAX
;
309 static int assign_type(struct file_lock
*fl
, int type
)
323 /* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
326 static int flock_to_posix_lock(struct file
*filp
, struct file_lock
*fl
,
331 switch (l
->l_whence
) {
339 start
= i_size_read(filp
->f_path
.dentry
->d_inode
);
345 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
346 POSIX-2001 defines it. */
350 fl
->fl_end
= OFFSET_MAX
;
352 end
= start
+ l
->l_len
- 1;
354 } else if (l
->l_len
< 0) {
361 fl
->fl_start
= start
; /* we record the absolute position */
362 if (fl
->fl_end
< fl
->fl_start
)
365 fl
->fl_owner
= current
->files
;
366 fl
->fl_pid
= current
->tgid
;
368 fl
->fl_flags
= FL_POSIX
;
372 return assign_type(fl
, l
->l_type
);
375 #if BITS_PER_LONG == 32
376 static int flock64_to_posix_lock(struct file
*filp
, struct file_lock
*fl
,
381 switch (l
->l_whence
) {
389 start
= i_size_read(filp
->f_path
.dentry
->d_inode
);
398 fl
->fl_end
= OFFSET_MAX
;
400 fl
->fl_end
= start
+ l
->l_len
- 1;
401 } else if (l
->l_len
< 0) {
402 fl
->fl_end
= start
- 1;
407 fl
->fl_start
= start
; /* we record the absolute position */
408 if (fl
->fl_end
< fl
->fl_start
)
411 fl
->fl_owner
= current
->files
;
412 fl
->fl_pid
= current
->tgid
;
414 fl
->fl_flags
= FL_POSIX
;
422 fl
->fl_type
= l
->l_type
;
432 /* default lease lock manager operations */
433 static void lease_break_callback(struct file_lock
*fl
)
435 kill_fasync(&fl
->fl_fasync
, SIGIO
, POLL_MSG
);
438 static void lease_release_private_callback(struct file_lock
*fl
)
443 f_delown(fl
->fl_file
);
444 fl
->fl_file
->f_owner
.signum
= 0;
447 static int lease_mylease_callback(struct file_lock
*fl
, struct file_lock
*try)
449 return fl
->fl_file
== try->fl_file
;
452 static const struct lock_manager_operations lease_manager_ops
= {
453 .fl_break
= lease_break_callback
,
454 .fl_release_private
= lease_release_private_callback
,
455 .fl_mylease
= lease_mylease_callback
,
456 .fl_change
= lease_modify
,
460 * Initialize a lease, use the default lock manager operations
462 static int lease_init(struct file
*filp
, int type
, struct file_lock
*fl
)
464 if (assign_type(fl
, type
) != 0)
467 fl
->fl_owner
= current
->files
;
468 fl
->fl_pid
= current
->tgid
;
471 fl
->fl_flags
= FL_LEASE
;
473 fl
->fl_end
= OFFSET_MAX
;
475 fl
->fl_lmops
= &lease_manager_ops
;
479 /* Allocate a file_lock initialised to this type of lease */
480 static struct file_lock
*lease_alloc(struct file
*filp
, int type
)
482 struct file_lock
*fl
= locks_alloc_lock();
486 return ERR_PTR(error
);
488 error
= lease_init(filp
, type
, fl
);
491 return ERR_PTR(error
);
496 /* Check if two locks overlap each other.
498 static inline int locks_overlap(struct file_lock
*fl1
, struct file_lock
*fl2
)
500 return ((fl1
->fl_end
>= fl2
->fl_start
) &&
501 (fl2
->fl_end
>= fl1
->fl_start
));
505 * Check whether two locks have the same owner.
507 static int posix_same_owner(struct file_lock
*fl1
, struct file_lock
*fl2
)
509 if (fl1
->fl_lmops
&& fl1
->fl_lmops
->fl_compare_owner
)
510 return fl2
->fl_lmops
== fl1
->fl_lmops
&&
511 fl1
->fl_lmops
->fl_compare_owner(fl1
, fl2
);
512 return fl1
->fl_owner
== fl2
->fl_owner
;
515 /* Remove waiter from blocker's block list.
516 * When blocker ends up pointing to itself then the list is empty.
518 static void __locks_delete_block(struct file_lock
*waiter
)
520 list_del_init(&waiter
->fl_block
);
521 list_del_init(&waiter
->fl_link
);
522 waiter
->fl_next
= NULL
;
527 static void locks_delete_block(struct file_lock
*waiter
)
530 __locks_delete_block(waiter
);
534 /* Insert waiter into blocker's block list.
535 * We use a circular list so that processes can be easily woken up in
536 * the order they blocked. The documentation doesn't require this but
537 * it seems like the reasonable thing to do.
539 static void locks_insert_block(struct file_lock
*blocker
,
540 struct file_lock
*waiter
)
542 BUG_ON(!list_empty(&waiter
->fl_block
));
543 list_add_tail(&waiter
->fl_block
, &blocker
->fl_block
);
544 waiter
->fl_next
= blocker
;
545 if (IS_POSIX(blocker
))
546 list_add(&waiter
->fl_link
, &blocked_list
);
549 /* Wake up processes blocked waiting for blocker.
550 * If told to wait then schedule the processes until the block list
551 * is empty, otherwise empty the block list ourselves.
553 static void locks_wake_up_blocks(struct file_lock
*blocker
)
555 while (!list_empty(&blocker
->fl_block
)) {
556 struct file_lock
*waiter
;
558 waiter
= list_first_entry(&blocker
->fl_block
,
559 struct file_lock
, fl_block
);
560 __locks_delete_block(waiter
);
561 if (waiter
->fl_lmops
&& waiter
->fl_lmops
->fl_notify
)
562 waiter
->fl_lmops
->fl_notify(waiter
);
564 wake_up(&waiter
->fl_wait
);
568 /* Insert file lock fl into an inode's lock list at the position indicated
569 * by pos. At the same time add the lock to the global file lock list.
571 static void locks_insert_lock(struct file_lock
**pos
, struct file_lock
*fl
)
573 list_add(&fl
->fl_link
, &file_lock_list
);
575 fl
->fl_nspid
= get_pid(task_tgid(current
));
577 /* insert into file's list */
583 * Delete a lock and then free it.
584 * Wake up processes that are blocked waiting for this lock,
585 * notify the FS that the lock has been cleared and
586 * finally free the lock.
588 static void locks_delete_lock(struct file_lock
**thisfl_p
)
590 struct file_lock
*fl
= *thisfl_p
;
592 *thisfl_p
= fl
->fl_next
;
594 list_del_init(&fl
->fl_link
);
596 fasync_helper(0, fl
->fl_file
, 0, &fl
->fl_fasync
);
597 if (fl
->fl_fasync
!= NULL
) {
598 printk(KERN_ERR
"locks_delete_lock: fasync == %p\n", fl
->fl_fasync
);
599 fl
->fl_fasync
= NULL
;
603 put_pid(fl
->fl_nspid
);
607 locks_wake_up_blocks(fl
);
611 /* Determine if lock sys_fl blocks lock caller_fl. Common functionality
612 * checks for shared/exclusive status of overlapping locks.
614 static int locks_conflict(struct file_lock
*caller_fl
, struct file_lock
*sys_fl
)
616 if (sys_fl
->fl_type
== F_WRLCK
)
618 if (caller_fl
->fl_type
== F_WRLCK
)
623 /* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
624 * checking before calling the locks_conflict().
626 static int posix_locks_conflict(struct file_lock
*caller_fl
, struct file_lock
*sys_fl
)
628 /* POSIX locks owned by the same process do not conflict with
631 if (!IS_POSIX(sys_fl
) || posix_same_owner(caller_fl
, sys_fl
))
634 /* Check whether they overlap */
635 if (!locks_overlap(caller_fl
, sys_fl
))
638 return (locks_conflict(caller_fl
, sys_fl
));
641 /* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
642 * checking before calling the locks_conflict().
644 static int flock_locks_conflict(struct file_lock
*caller_fl
, struct file_lock
*sys_fl
)
646 /* FLOCK locks referring to the same filp do not conflict with
649 if (!IS_FLOCK(sys_fl
) || (caller_fl
->fl_file
== sys_fl
->fl_file
))
651 if ((caller_fl
->fl_type
& LOCK_MAND
) || (sys_fl
->fl_type
& LOCK_MAND
))
654 return (locks_conflict(caller_fl
, sys_fl
));
658 posix_test_lock(struct file
*filp
, struct file_lock
*fl
)
660 struct file_lock
*cfl
;
663 for (cfl
= filp
->f_path
.dentry
->d_inode
->i_flock
; cfl
; cfl
= cfl
->fl_next
) {
666 if (posix_locks_conflict(fl
, cfl
))
670 __locks_copy_lock(fl
, cfl
);
672 fl
->fl_pid
= pid_vnr(cfl
->fl_nspid
);
674 fl
->fl_type
= F_UNLCK
;
678 EXPORT_SYMBOL(posix_test_lock
);
681 * Deadlock detection:
683 * We attempt to detect deadlocks that are due purely to posix file
686 * We assume that a task can be waiting for at most one lock at a time.
687 * So for any acquired lock, the process holding that lock may be
688 * waiting on at most one other lock. That lock in turns may be held by
689 * someone waiting for at most one other lock. Given a requested lock
690 * caller_fl which is about to wait for a conflicting lock block_fl, we
691 * follow this chain of waiters to ensure we are not about to create a
694 * Since we do this before we ever put a process to sleep on a lock, we
695 * are ensured that there is never a cycle; that is what guarantees that
696 * the while() loop in posix_locks_deadlock() eventually completes.
698 * Note: the above assumption may not be true when handling lock
699 * requests from a broken NFS client. It may also fail in the presence
700 * of tasks (such as posix threads) sharing the same open file table.
702 * To handle those cases, we just bail out after a few iterations.
705 #define MAX_DEADLK_ITERATIONS 10
707 /* Find a lock that the owner of the given block_fl is blocking on. */
708 static struct file_lock
*what_owner_is_waiting_for(struct file_lock
*block_fl
)
710 struct file_lock
*fl
;
712 list_for_each_entry(fl
, &blocked_list
, fl_link
) {
713 if (posix_same_owner(fl
, block_fl
))
719 static int posix_locks_deadlock(struct file_lock
*caller_fl
,
720 struct file_lock
*block_fl
)
724 while ((block_fl
= what_owner_is_waiting_for(block_fl
))) {
725 if (i
++ > MAX_DEADLK_ITERATIONS
)
727 if (posix_same_owner(caller_fl
, block_fl
))
733 /* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
734 * after any leases, but before any posix locks.
736 * Note that if called with an FL_EXISTS argument, the caller may determine
737 * whether or not a lock was successfully freed by testing the return
740 static int flock_lock_file(struct file
*filp
, struct file_lock
*request
)
742 struct file_lock
*new_fl
= NULL
;
743 struct file_lock
**before
;
744 struct inode
* inode
= filp
->f_path
.dentry
->d_inode
;
748 if (!(request
->fl_flags
& FL_ACCESS
) && (request
->fl_type
!= F_UNLCK
)) {
749 new_fl
= locks_alloc_lock();
755 if (request
->fl_flags
& FL_ACCESS
)
758 for_each_lock(inode
, before
) {
759 struct file_lock
*fl
= *before
;
764 if (filp
!= fl
->fl_file
)
766 if (request
->fl_type
== fl
->fl_type
)
769 locks_delete_lock(before
);
773 if (request
->fl_type
== F_UNLCK
) {
774 if ((request
->fl_flags
& FL_EXISTS
) && !found
)
780 * If a higher-priority process was blocked on the old file lock,
781 * give it the opportunity to lock the file.
790 for_each_lock(inode
, before
) {
791 struct file_lock
*fl
= *before
;
796 if (!flock_locks_conflict(request
, fl
))
799 if (!(request
->fl_flags
& FL_SLEEP
))
801 error
= FILE_LOCK_DEFERRED
;
802 locks_insert_block(fl
, request
);
805 if (request
->fl_flags
& FL_ACCESS
)
807 locks_copy_lock(new_fl
, request
);
808 locks_insert_lock(before
, new_fl
);
815 locks_free_lock(new_fl
);
819 static int __posix_lock_file(struct inode
*inode
, struct file_lock
*request
, struct file_lock
*conflock
)
821 struct file_lock
*fl
;
822 struct file_lock
*new_fl
= NULL
;
823 struct file_lock
*new_fl2
= NULL
;
824 struct file_lock
*left
= NULL
;
825 struct file_lock
*right
= NULL
;
826 struct file_lock
**before
;
827 int error
, added
= 0;
830 * We may need two file_lock structures for this operation,
831 * so we get them in advance to avoid races.
833 * In some cases we can be sure, that no new locks will be needed
835 if (!(request
->fl_flags
& FL_ACCESS
) &&
836 (request
->fl_type
!= F_UNLCK
||
837 request
->fl_start
!= 0 || request
->fl_end
!= OFFSET_MAX
)) {
838 new_fl
= locks_alloc_lock();
839 new_fl2
= locks_alloc_lock();
843 if (request
->fl_type
!= F_UNLCK
) {
844 for_each_lock(inode
, before
) {
848 if (!posix_locks_conflict(request
, fl
))
851 __locks_copy_lock(conflock
, fl
);
853 if (!(request
->fl_flags
& FL_SLEEP
))
856 if (posix_locks_deadlock(request
, fl
))
858 error
= FILE_LOCK_DEFERRED
;
859 locks_insert_block(fl
, request
);
864 /* If we're just looking for a conflict, we're done. */
866 if (request
->fl_flags
& FL_ACCESS
)
870 * Find the first old lock with the same owner as the new lock.
873 before
= &inode
->i_flock
;
875 /* First skip locks owned by other processes. */
876 while ((fl
= *before
) && (!IS_POSIX(fl
) ||
877 !posix_same_owner(request
, fl
))) {
878 before
= &fl
->fl_next
;
881 /* Process locks with this owner. */
882 while ((fl
= *before
) && posix_same_owner(request
, fl
)) {
883 /* Detect adjacent or overlapping regions (if same lock type)
885 if (request
->fl_type
== fl
->fl_type
) {
886 /* In all comparisons of start vs end, use
887 * "start - 1" rather than "end + 1". If end
888 * is OFFSET_MAX, end + 1 will become negative.
890 if (fl
->fl_end
< request
->fl_start
- 1)
892 /* If the next lock in the list has entirely bigger
893 * addresses than the new one, insert the lock here.
895 if (fl
->fl_start
- 1 > request
->fl_end
)
898 /* If we come here, the new and old lock are of the
899 * same type and adjacent or overlapping. Make one
900 * lock yielding from the lower start address of both
901 * locks to the higher end address.
903 if (fl
->fl_start
> request
->fl_start
)
904 fl
->fl_start
= request
->fl_start
;
906 request
->fl_start
= fl
->fl_start
;
907 if (fl
->fl_end
< request
->fl_end
)
908 fl
->fl_end
= request
->fl_end
;
910 request
->fl_end
= fl
->fl_end
;
912 locks_delete_lock(before
);
919 /* Processing for different lock types is a bit
922 if (fl
->fl_end
< request
->fl_start
)
924 if (fl
->fl_start
> request
->fl_end
)
926 if (request
->fl_type
== F_UNLCK
)
928 if (fl
->fl_start
< request
->fl_start
)
930 /* If the next lock in the list has a higher end
931 * address than the new one, insert the new one here.
933 if (fl
->fl_end
> request
->fl_end
) {
937 if (fl
->fl_start
>= request
->fl_start
) {
938 /* The new lock completely replaces an old
939 * one (This may happen several times).
942 locks_delete_lock(before
);
945 /* Replace the old lock with the new one.
946 * Wake up anybody waiting for the old one,
947 * as the change in lock type might satisfy
950 locks_wake_up_blocks(fl
);
951 fl
->fl_start
= request
->fl_start
;
952 fl
->fl_end
= request
->fl_end
;
953 fl
->fl_type
= request
->fl_type
;
954 locks_release_private(fl
);
955 locks_copy_private(fl
, request
);
960 /* Go on to next lock.
963 before
= &fl
->fl_next
;
967 * The above code only modifies existing locks in case of
968 * merging or replacing. If new lock(s) need to be inserted
969 * all modifications are done bellow this, so it's safe yet to
972 error
= -ENOLCK
; /* "no luck" */
973 if (right
&& left
== right
&& !new_fl2
)
978 if (request
->fl_type
== F_UNLCK
) {
979 if (request
->fl_flags
& FL_EXISTS
)
988 locks_copy_lock(new_fl
, request
);
989 locks_insert_lock(before
, new_fl
);
994 /* The new lock breaks the old one in two pieces,
995 * so we have to use the second new lock.
999 locks_copy_lock(left
, right
);
1000 locks_insert_lock(before
, left
);
1002 right
->fl_start
= request
->fl_end
+ 1;
1003 locks_wake_up_blocks(right
);
1006 left
->fl_end
= request
->fl_start
- 1;
1007 locks_wake_up_blocks(left
);
1012 * Free any unused locks.
1015 locks_free_lock(new_fl
);
1017 locks_free_lock(new_fl2
);
1022 * posix_lock_file - Apply a POSIX-style lock to a file
1023 * @filp: The file to apply the lock to
1024 * @fl: The lock to be applied
1025 * @conflock: Place to return a copy of the conflicting lock, if found.
1027 * Add a POSIX style lock to a file.
1028 * We merge adjacent & overlapping locks whenever possible.
1029 * POSIX locks are sorted by owner task, then by starting address
1031 * Note that if called with an FL_EXISTS argument, the caller may determine
1032 * whether or not a lock was successfully freed by testing the return
1033 * value for -ENOENT.
1035 int posix_lock_file(struct file
*filp
, struct file_lock
*fl
,
1036 struct file_lock
*conflock
)
1038 return __posix_lock_file(filp
->f_path
.dentry
->d_inode
, fl
, conflock
);
1040 EXPORT_SYMBOL(posix_lock_file
);
1043 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1044 * @filp: The file to apply the lock to
1045 * @fl: The lock to be applied
1047 * Add a POSIX style lock to a file.
1048 * We merge adjacent & overlapping locks whenever possible.
1049 * POSIX locks are sorted by owner task, then by starting address
1051 int posix_lock_file_wait(struct file
*filp
, struct file_lock
*fl
)
1056 error
= posix_lock_file(filp
, fl
, NULL
);
1057 if (error
!= FILE_LOCK_DEFERRED
)
1059 error
= wait_event_interruptible(fl
->fl_wait
, !fl
->fl_next
);
1063 locks_delete_block(fl
);
1068 EXPORT_SYMBOL(posix_lock_file_wait
);
1071 * locks_mandatory_locked - Check for an active lock
1072 * @inode: the file to check
1074 * Searches the inode's list of locks to find any POSIX locks which conflict.
1075 * This function is called from locks_verify_locked() only.
1077 int locks_mandatory_locked(struct inode
*inode
)
1079 fl_owner_t owner
= current
->files
;
1080 struct file_lock
*fl
;
1083 * Search the lock list for this inode for any POSIX locks.
1086 for (fl
= inode
->i_flock
; fl
!= NULL
; fl
= fl
->fl_next
) {
1089 if (fl
->fl_owner
!= owner
)
1093 return fl
? -EAGAIN
: 0;
1097 * locks_mandatory_area - Check for a conflicting lock
1098 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1100 * @inode: the file to check
1101 * @filp: how the file was opened (if it was)
1102 * @offset: start of area to check
1103 * @count: length of area to check
1105 * Searches the inode's list of locks to find any POSIX locks which conflict.
1106 * This function is called from rw_verify_area() and
1107 * locks_verify_truncate().
1109 int locks_mandatory_area(int read_write
, struct inode
*inode
,
1110 struct file
*filp
, loff_t offset
,
1113 struct file_lock fl
;
1116 locks_init_lock(&fl
);
1117 fl
.fl_owner
= current
->files
;
1118 fl
.fl_pid
= current
->tgid
;
1120 fl
.fl_flags
= FL_POSIX
| FL_ACCESS
;
1121 if (filp
&& !(filp
->f_flags
& O_NONBLOCK
))
1122 fl
.fl_flags
|= FL_SLEEP
;
1123 fl
.fl_type
= (read_write
== FLOCK_VERIFY_WRITE
) ? F_WRLCK
: F_RDLCK
;
1124 fl
.fl_start
= offset
;
1125 fl
.fl_end
= offset
+ count
- 1;
1128 error
= __posix_lock_file(inode
, &fl
, NULL
);
1129 if (error
!= FILE_LOCK_DEFERRED
)
1131 error
= wait_event_interruptible(fl
.fl_wait
, !fl
.fl_next
);
1134 * If we've been sleeping someone might have
1135 * changed the permissions behind our back.
1137 if (__mandatory_lock(inode
))
1141 locks_delete_block(&fl
);
1148 EXPORT_SYMBOL(locks_mandatory_area
);
1150 /* We already had a lease on this file; just change its type */
1151 int lease_modify(struct file_lock
**before
, int arg
)
1153 struct file_lock
*fl
= *before
;
1154 int error
= assign_type(fl
, arg
);
1158 locks_wake_up_blocks(fl
);
1160 locks_delete_lock(before
);
1164 EXPORT_SYMBOL(lease_modify
);
1166 static void time_out_leases(struct inode
*inode
)
1168 struct file_lock
**before
;
1169 struct file_lock
*fl
;
1171 before
= &inode
->i_flock
;
1172 while ((fl
= *before
) && IS_LEASE(fl
) && (fl
->fl_type
& F_INPROGRESS
)) {
1173 if ((fl
->fl_break_time
== 0)
1174 || time_before(jiffies
, fl
->fl_break_time
)) {
1175 before
= &fl
->fl_next
;
1178 lease_modify(before
, fl
->fl_type
& ~F_INPROGRESS
);
1179 if (fl
== *before
) /* lease_modify may have freed fl */
1180 before
= &fl
->fl_next
;
1185 * __break_lease - revoke all outstanding leases on file
1186 * @inode: the inode of the file to return
1187 * @mode: the open mode (read or write)
1189 * break_lease (inlined for speed) has checked there already is at least
1190 * some kind of lock (maybe a lease) on this file. Leases are broken on
1191 * a call to open() or truncate(). This function can sleep unless you
1192 * specified %O_NONBLOCK to your open().
1194 int __break_lease(struct inode
*inode
, unsigned int mode
)
1196 int error
= 0, future
;
1197 struct file_lock
*new_fl
, *flock
;
1198 struct file_lock
*fl
;
1199 unsigned long break_time
;
1200 int i_have_this_lease
= 0;
1201 int want_write
= (mode
& O_ACCMODE
) != O_RDONLY
;
1203 new_fl
= lease_alloc(NULL
, want_write
? F_WRLCK
: F_RDLCK
);
1207 time_out_leases(inode
);
1209 flock
= inode
->i_flock
;
1210 if ((flock
== NULL
) || !IS_LEASE(flock
))
1213 for (fl
= flock
; fl
&& IS_LEASE(fl
); fl
= fl
->fl_next
)
1214 if (fl
->fl_owner
== current
->files
)
1215 i_have_this_lease
= 1;
1218 /* If we want write access, we have to revoke any lease. */
1219 future
= F_UNLCK
| F_INPROGRESS
;
1220 } else if (flock
->fl_type
& F_INPROGRESS
) {
1221 /* If the lease is already being broken, we just leave it */
1222 future
= flock
->fl_type
;
1223 } else if (flock
->fl_type
& F_WRLCK
) {
1224 /* Downgrade the exclusive lease to a read-only lease. */
1225 future
= F_RDLCK
| F_INPROGRESS
;
1227 /* the existing lease was read-only, so we can read too. */
1231 if (IS_ERR(new_fl
) && !i_have_this_lease
1232 && ((mode
& O_NONBLOCK
) == 0)) {
1233 error
= PTR_ERR(new_fl
);
1238 if (lease_break_time
> 0) {
1239 break_time
= jiffies
+ lease_break_time
* HZ
;
1240 if (break_time
== 0)
1241 break_time
++; /* so that 0 means no break time */
1244 for (fl
= flock
; fl
&& IS_LEASE(fl
); fl
= fl
->fl_next
) {
1245 if (fl
->fl_type
!= future
) {
1246 fl
->fl_type
= future
;
1247 fl
->fl_break_time
= break_time
;
1248 /* lease must have lmops break callback */
1249 fl
->fl_lmops
->fl_break(fl
);
1253 if (i_have_this_lease
|| (mode
& O_NONBLOCK
)) {
1254 error
= -EWOULDBLOCK
;
1259 break_time
= flock
->fl_break_time
;
1260 if (break_time
!= 0) {
1261 break_time
-= jiffies
;
1262 if (break_time
== 0)
1265 locks_insert_block(flock
, new_fl
);
1267 error
= wait_event_interruptible_timeout(new_fl
->fl_wait
,
1268 !new_fl
->fl_next
, break_time
);
1270 __locks_delete_block(new_fl
);
1273 time_out_leases(inode
);
1274 /* Wait for the next lease that has not been broken yet */
1275 for (flock
= inode
->i_flock
; flock
&& IS_LEASE(flock
);
1276 flock
= flock
->fl_next
) {
1277 if (flock
->fl_type
& F_INPROGRESS
)
1285 if (!IS_ERR(new_fl
))
1286 locks_free_lock(new_fl
);
1290 EXPORT_SYMBOL(__break_lease
);
1293 * lease_get_mtime - get the last modified time of an inode
1295 * @time: pointer to a timespec which will contain the last modified time
1297 * This is to force NFS clients to flush their caches for files with
1298 * exclusive leases. The justification is that if someone has an
1299 * exclusive lease, then they could be modifying it.
1301 void lease_get_mtime(struct inode
*inode
, struct timespec
*time
)
1303 struct file_lock
*flock
= inode
->i_flock
;
1304 if (flock
&& IS_LEASE(flock
) && (flock
->fl_type
& F_WRLCK
))
1305 *time
= current_fs_time(inode
->i_sb
);
1307 *time
= inode
->i_mtime
;
1310 EXPORT_SYMBOL(lease_get_mtime
);
1313 * fcntl_getlease - Enquire what lease is currently active
1316 * The value returned by this function will be one of
1317 * (if no lease break is pending):
1319 * %F_RDLCK to indicate a shared lease is held.
1321 * %F_WRLCK to indicate an exclusive lease is held.
1323 * %F_UNLCK to indicate no lease is held.
1325 * (if a lease break is pending):
1327 * %F_RDLCK to indicate an exclusive lease needs to be
1328 * changed to a shared lease (or removed).
1330 * %F_UNLCK to indicate the lease needs to be removed.
1332 * XXX: sfr & willy disagree over whether F_INPROGRESS
1333 * should be returned to userspace.
1335 int fcntl_getlease(struct file
*filp
)
1337 struct file_lock
*fl
;
1341 time_out_leases(filp
->f_path
.dentry
->d_inode
);
1342 for (fl
= filp
->f_path
.dentry
->d_inode
->i_flock
; fl
&& IS_LEASE(fl
);
1344 if (fl
->fl_file
== filp
) {
1345 type
= fl
->fl_type
& ~F_INPROGRESS
;
1354 * generic_setlease - sets a lease on an open file
1355 * @filp: file pointer
1356 * @arg: type of lease to obtain
1357 * @flp: input - file_lock to use, output - file_lock inserted
1359 * The (input) flp->fl_lmops->fl_break function is required
1362 * Called with file_lock_lock held.
1364 int generic_setlease(struct file
*filp
, long arg
, struct file_lock
**flp
)
1366 struct file_lock
*fl
, **before
, **my_before
= NULL
, *lease
;
1367 struct dentry
*dentry
= filp
->f_path
.dentry
;
1368 struct inode
*inode
= dentry
->d_inode
;
1369 int error
, rdlease_count
= 0, wrlease_count
= 0;
1374 if ((current_fsuid() != inode
->i_uid
) && !capable(CAP_LEASE
))
1377 if (!S_ISREG(inode
->i_mode
))
1379 error
= security_file_lock(filp
, arg
);
1383 time_out_leases(inode
);
1385 BUG_ON(!(*flp
)->fl_lmops
->fl_break
);
1387 if (arg
!= F_UNLCK
) {
1389 if ((arg
== F_RDLCK
) && (atomic_read(&inode
->i_writecount
) > 0))
1391 if ((arg
== F_WRLCK
)
1392 && ((atomic_read(&dentry
->d_count
) > 1)
1393 || (atomic_read(&inode
->i_count
) > 1)))
1398 * At this point, we know that if there is an exclusive
1399 * lease on this file, then we hold it on this filp
1400 * (otherwise our open of this file would have blocked).
1401 * And if we are trying to acquire an exclusive lease,
1402 * then the file is not open by anyone (including us)
1403 * except for this filp.
1405 for (before
= &inode
->i_flock
;
1406 ((fl
= *before
) != NULL
) && IS_LEASE(fl
);
1407 before
= &fl
->fl_next
) {
1408 if (lease
->fl_lmops
->fl_mylease(fl
, lease
))
1410 else if (fl
->fl_type
== (F_INPROGRESS
| F_UNLCK
))
1412 * Someone is in the process of opening this
1413 * file for writing so we may not take an
1414 * exclusive lease on it.
1422 if ((arg
== F_RDLCK
&& (wrlease_count
> 0)) ||
1423 (arg
== F_WRLCK
&& ((rdlease_count
+ wrlease_count
) > 0)))
1426 if (my_before
!= NULL
) {
1427 error
= lease
->fl_lmops
->fl_change(my_before
, arg
);
1440 locks_insert_lock(before
, lease
);
1446 EXPORT_SYMBOL(generic_setlease
);
1448 static int __vfs_setlease(struct file
*filp
, long arg
, struct file_lock
**lease
)
1450 if (filp
->f_op
&& filp
->f_op
->setlease
)
1451 return filp
->f_op
->setlease(filp
, arg
, lease
);
1453 return generic_setlease(filp
, arg
, lease
);
1457 * vfs_setlease - sets a lease on an open file
1458 * @filp: file pointer
1459 * @arg: type of lease to obtain
1460 * @lease: file_lock to use
1462 * Call this to establish a lease on the file.
1463 * The (*lease)->fl_lmops->fl_break operation must be set; if not,
1464 * break_lease will oops!
1466 * This will call the filesystem's setlease file method, if
1467 * defined. Note that there is no getlease method; instead, the
1468 * filesystem setlease method should call back to setlease() to
1469 * add a lease to the inode's lease list, where fcntl_getlease() can
1470 * find it. Since fcntl_getlease() only reports whether the current
1471 * task holds a lease, a cluster filesystem need only do this for
1472 * leases held by processes on this node.
1474 * There is also no break_lease method; filesystems that
1475 * handle their own leases should break leases themselves from the
1476 * filesystem's open, create, and (on truncate) setattr methods.
1478 * Warning: the only current setlease methods exist only to disable
1479 * leases in certain cases. More vfs changes may be required to
1480 * allow a full filesystem lease implementation.
1483 int vfs_setlease(struct file
*filp
, long arg
, struct file_lock
**lease
)
1488 error
= __vfs_setlease(filp
, arg
, lease
);
1493 EXPORT_SYMBOL_GPL(vfs_setlease
);
1495 static int do_fcntl_delete_lease(struct file
*filp
)
1497 struct file_lock fl
, *flp
= &fl
;
1499 lease_init(filp
, F_UNLCK
, flp
);
1501 return vfs_setlease(filp
, F_UNLCK
, &flp
);
1504 static int do_fcntl_add_lease(unsigned int fd
, struct file
*filp
, long arg
)
1506 struct file_lock
*fl
, *ret
;
1507 struct fasync_struct
*new;
1510 fl
= lease_alloc(filp
, arg
);
1514 new = fasync_alloc();
1516 locks_free_lock(fl
);
1521 error
= __vfs_setlease(filp
, arg
, &ret
);
1524 locks_free_lock(fl
);
1525 goto out_free_fasync
;
1528 locks_free_lock(fl
);
1531 * fasync_insert_entry() returns the old entry if any.
1532 * If there was no old entry, then it used 'new' and
1533 * inserted it into the fasync list. Clear new so that
1534 * we don't release it here.
1536 if (!fasync_insert_entry(fd
, filp
, &ret
->fl_fasync
, new))
1539 error
= __f_setown(filp
, task_pid(current
), PIDTYPE_PID
, 0);
1549 * fcntl_setlease - sets a lease on an open file
1550 * @fd: open file descriptor
1551 * @filp: file pointer
1552 * @arg: type of lease to obtain
1554 * Call this fcntl to establish a lease on the file.
1555 * Note that you also need to call %F_SETSIG to
1556 * receive a signal when the lease is broken.
1558 int fcntl_setlease(unsigned int fd
, struct file
*filp
, long arg
)
1561 return do_fcntl_delete_lease(filp
);
1562 return do_fcntl_add_lease(fd
, filp
, arg
);
1566 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1567 * @filp: The file to apply the lock to
1568 * @fl: The lock to be applied
1570 * Add a FLOCK style lock to a file.
1572 int flock_lock_file_wait(struct file
*filp
, struct file_lock
*fl
)
1577 error
= flock_lock_file(filp
, fl
);
1578 if (error
!= FILE_LOCK_DEFERRED
)
1580 error
= wait_event_interruptible(fl
->fl_wait
, !fl
->fl_next
);
1584 locks_delete_block(fl
);
1590 EXPORT_SYMBOL(flock_lock_file_wait
);
1593 * sys_flock: - flock() system call.
1594 * @fd: the file descriptor to lock.
1595 * @cmd: the type of lock to apply.
1597 * Apply a %FL_FLOCK style lock to an open file descriptor.
1598 * The @cmd can be one of
1600 * %LOCK_SH -- a shared lock.
1602 * %LOCK_EX -- an exclusive lock.
1604 * %LOCK_UN -- remove an existing lock.
1606 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1608 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1609 * processes read and write access respectively.
1611 SYSCALL_DEFINE2(flock
, unsigned int, fd
, unsigned int, cmd
)
1614 struct file_lock
*lock
;
1615 int can_sleep
, unlock
;
1623 can_sleep
= !(cmd
& LOCK_NB
);
1625 unlock
= (cmd
== LOCK_UN
);
1627 if (!unlock
&& !(cmd
& LOCK_MAND
) &&
1628 !(filp
->f_mode
& (FMODE_READ
|FMODE_WRITE
)))
1631 error
= flock_make_lock(filp
, &lock
, cmd
);
1635 lock
->fl_flags
|= FL_SLEEP
;
1637 error
= security_file_lock(filp
, lock
->fl_type
);
1641 if (filp
->f_op
&& filp
->f_op
->flock
)
1642 error
= filp
->f_op
->flock(filp
,
1643 (can_sleep
) ? F_SETLKW
: F_SETLK
,
1646 error
= flock_lock_file_wait(filp
, lock
);
1649 locks_free_lock(lock
);
1658 * vfs_test_lock - test file byte range lock
1659 * @filp: The file to test lock for
1660 * @fl: The lock to test; also used to hold result
1662 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1663 * setting conf->fl_type to something other than F_UNLCK.
1665 int vfs_test_lock(struct file
*filp
, struct file_lock
*fl
)
1667 if (filp
->f_op
&& filp
->f_op
->lock
)
1668 return filp
->f_op
->lock(filp
, F_GETLK
, fl
);
1669 posix_test_lock(filp
, fl
);
1672 EXPORT_SYMBOL_GPL(vfs_test_lock
);
1674 static int posix_lock_to_flock(struct flock
*flock
, struct file_lock
*fl
)
1676 flock
->l_pid
= fl
->fl_pid
;
1677 #if BITS_PER_LONG == 32
1679 * Make sure we can represent the posix lock via
1680 * legacy 32bit flock.
1682 if (fl
->fl_start
> OFFT_OFFSET_MAX
)
1684 if (fl
->fl_end
!= OFFSET_MAX
&& fl
->fl_end
> OFFT_OFFSET_MAX
)
1687 flock
->l_start
= fl
->fl_start
;
1688 flock
->l_len
= fl
->fl_end
== OFFSET_MAX
? 0 :
1689 fl
->fl_end
- fl
->fl_start
+ 1;
1690 flock
->l_whence
= 0;
1691 flock
->l_type
= fl
->fl_type
;
1695 #if BITS_PER_LONG == 32
1696 static void posix_lock_to_flock64(struct flock64
*flock
, struct file_lock
*fl
)
1698 flock
->l_pid
= fl
->fl_pid
;
1699 flock
->l_start
= fl
->fl_start
;
1700 flock
->l_len
= fl
->fl_end
== OFFSET_MAX
? 0 :
1701 fl
->fl_end
- fl
->fl_start
+ 1;
1702 flock
->l_whence
= 0;
1703 flock
->l_type
= fl
->fl_type
;
1707 /* Report the first existing lock that would conflict with l.
1708 * This implements the F_GETLK command of fcntl().
1710 int fcntl_getlk(struct file
*filp
, struct flock __user
*l
)
1712 struct file_lock file_lock
;
1717 if (copy_from_user(&flock
, l
, sizeof(flock
)))
1720 if ((flock
.l_type
!= F_RDLCK
) && (flock
.l_type
!= F_WRLCK
))
1723 error
= flock_to_posix_lock(filp
, &file_lock
, &flock
);
1727 error
= vfs_test_lock(filp
, &file_lock
);
1731 flock
.l_type
= file_lock
.fl_type
;
1732 if (file_lock
.fl_type
!= F_UNLCK
) {
1733 error
= posix_lock_to_flock(&flock
, &file_lock
);
1738 if (!copy_to_user(l
, &flock
, sizeof(flock
)))
1745 * vfs_lock_file - file byte range lock
1746 * @filp: The file to apply the lock to
1747 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
1748 * @fl: The lock to be applied
1749 * @conf: Place to return a copy of the conflicting lock, if found.
1751 * A caller that doesn't care about the conflicting lock may pass NULL
1752 * as the final argument.
1754 * If the filesystem defines a private ->lock() method, then @conf will
1755 * be left unchanged; so a caller that cares should initialize it to
1756 * some acceptable default.
1758 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
1759 * locks, the ->lock() interface may return asynchronously, before the lock has
1760 * been granted or denied by the underlying filesystem, if (and only if)
1761 * fl_grant is set. Callers expecting ->lock() to return asynchronously
1762 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
1763 * the request is for a blocking lock. When ->lock() does return asynchronously,
1764 * it must return FILE_LOCK_DEFERRED, and call ->fl_grant() when the lock
1765 * request completes.
1766 * If the request is for non-blocking lock the file system should return
1767 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
1768 * with the result. If the request timed out the callback routine will return a
1769 * nonzero return code and the file system should release the lock. The file
1770 * system is also responsible to keep a corresponding posix lock when it
1771 * grants a lock so the VFS can find out which locks are locally held and do
1772 * the correct lock cleanup when required.
1773 * The underlying filesystem must not drop the kernel lock or call
1774 * ->fl_grant() before returning to the caller with a FILE_LOCK_DEFERRED
1777 int vfs_lock_file(struct file
*filp
, unsigned int cmd
, struct file_lock
*fl
, struct file_lock
*conf
)
1779 if (filp
->f_op
&& filp
->f_op
->lock
)
1780 return filp
->f_op
->lock(filp
, cmd
, fl
);
1782 return posix_lock_file(filp
, fl
, conf
);
1784 EXPORT_SYMBOL_GPL(vfs_lock_file
);
1786 static int do_lock_file_wait(struct file
*filp
, unsigned int cmd
,
1787 struct file_lock
*fl
)
1791 error
= security_file_lock(filp
, fl
->fl_type
);
1796 error
= vfs_lock_file(filp
, cmd
, fl
, NULL
);
1797 if (error
!= FILE_LOCK_DEFERRED
)
1799 error
= wait_event_interruptible(fl
->fl_wait
, !fl
->fl_next
);
1803 locks_delete_block(fl
);
1810 /* Apply the lock described by l to an open file descriptor.
1811 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1813 int fcntl_setlk(unsigned int fd
, struct file
*filp
, unsigned int cmd
,
1814 struct flock __user
*l
)
1816 struct file_lock
*file_lock
= locks_alloc_lock();
1818 struct inode
*inode
;
1822 if (file_lock
== NULL
)
1826 * This might block, so we do it before checking the inode.
1829 if (copy_from_user(&flock
, l
, sizeof(flock
)))
1832 inode
= filp
->f_path
.dentry
->d_inode
;
1834 /* Don't allow mandatory locks on files that may be memory mapped
1837 if (mandatory_lock(inode
) && mapping_writably_mapped(filp
->f_mapping
)) {
1843 error
= flock_to_posix_lock(filp
, file_lock
, &flock
);
1846 if (cmd
== F_SETLKW
) {
1847 file_lock
->fl_flags
|= FL_SLEEP
;
1851 switch (flock
.l_type
) {
1853 if (!(filp
->f_mode
& FMODE_READ
))
1857 if (!(filp
->f_mode
& FMODE_WRITE
))
1867 error
= do_lock_file_wait(filp
, cmd
, file_lock
);
1870 * Attempt to detect a close/fcntl race and recover by
1871 * releasing the lock that was just acquired.
1874 * we need that spin_lock here - it prevents reordering between
1875 * update of inode->i_flock and check for it done in close().
1876 * rcu_read_lock() wouldn't do.
1878 spin_lock(¤t
->files
->file_lock
);
1880 spin_unlock(¤t
->files
->file_lock
);
1881 if (!error
&& f
!= filp
&& flock
.l_type
!= F_UNLCK
) {
1882 flock
.l_type
= F_UNLCK
;
1887 locks_free_lock(file_lock
);
1891 #if BITS_PER_LONG == 32
1892 /* Report the first existing lock that would conflict with l.
1893 * This implements the F_GETLK command of fcntl().
1895 int fcntl_getlk64(struct file
*filp
, struct flock64 __user
*l
)
1897 struct file_lock file_lock
;
1898 struct flock64 flock
;
1902 if (copy_from_user(&flock
, l
, sizeof(flock
)))
1905 if ((flock
.l_type
!= F_RDLCK
) && (flock
.l_type
!= F_WRLCK
))
1908 error
= flock64_to_posix_lock(filp
, &file_lock
, &flock
);
1912 error
= vfs_test_lock(filp
, &file_lock
);
1916 flock
.l_type
= file_lock
.fl_type
;
1917 if (file_lock
.fl_type
!= F_UNLCK
)
1918 posix_lock_to_flock64(&flock
, &file_lock
);
1921 if (!copy_to_user(l
, &flock
, sizeof(flock
)))
1928 /* Apply the lock described by l to an open file descriptor.
1929 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1931 int fcntl_setlk64(unsigned int fd
, struct file
*filp
, unsigned int cmd
,
1932 struct flock64 __user
*l
)
1934 struct file_lock
*file_lock
= locks_alloc_lock();
1935 struct flock64 flock
;
1936 struct inode
*inode
;
1940 if (file_lock
== NULL
)
1944 * This might block, so we do it before checking the inode.
1947 if (copy_from_user(&flock
, l
, sizeof(flock
)))
1950 inode
= filp
->f_path
.dentry
->d_inode
;
1952 /* Don't allow mandatory locks on files that may be memory mapped
1955 if (mandatory_lock(inode
) && mapping_writably_mapped(filp
->f_mapping
)) {
1961 error
= flock64_to_posix_lock(filp
, file_lock
, &flock
);
1964 if (cmd
== F_SETLKW64
) {
1965 file_lock
->fl_flags
|= FL_SLEEP
;
1969 switch (flock
.l_type
) {
1971 if (!(filp
->f_mode
& FMODE_READ
))
1975 if (!(filp
->f_mode
& FMODE_WRITE
))
1985 error
= do_lock_file_wait(filp
, cmd
, file_lock
);
1988 * Attempt to detect a close/fcntl race and recover by
1989 * releasing the lock that was just acquired.
1991 spin_lock(¤t
->files
->file_lock
);
1993 spin_unlock(¤t
->files
->file_lock
);
1994 if (!error
&& f
!= filp
&& flock
.l_type
!= F_UNLCK
) {
1995 flock
.l_type
= F_UNLCK
;
2000 locks_free_lock(file_lock
);
2003 #endif /* BITS_PER_LONG == 32 */
2006 * This function is called when the file is being removed
2007 * from the task's fd array. POSIX locks belonging to this task
2008 * are deleted at this time.
2010 void locks_remove_posix(struct file
*filp
, fl_owner_t owner
)
2012 struct file_lock lock
;
2015 * If there are no locks held on this file, we don't need to call
2016 * posix_lock_file(). Another process could be setting a lock on this
2017 * file at the same time, but we wouldn't remove that lock anyway.
2019 if (!filp
->f_path
.dentry
->d_inode
->i_flock
)
2022 lock
.fl_type
= F_UNLCK
;
2023 lock
.fl_flags
= FL_POSIX
| FL_CLOSE
;
2025 lock
.fl_end
= OFFSET_MAX
;
2026 lock
.fl_owner
= owner
;
2027 lock
.fl_pid
= current
->tgid
;
2028 lock
.fl_file
= filp
;
2030 lock
.fl_lmops
= NULL
;
2032 vfs_lock_file(filp
, F_SETLK
, &lock
, NULL
);
2034 if (lock
.fl_ops
&& lock
.fl_ops
->fl_release_private
)
2035 lock
.fl_ops
->fl_release_private(&lock
);
2038 EXPORT_SYMBOL(locks_remove_posix
);
2041 * This function is called on the last close of an open file.
2043 void locks_remove_flock(struct file
*filp
)
2045 struct inode
* inode
= filp
->f_path
.dentry
->d_inode
;
2046 struct file_lock
*fl
;
2047 struct file_lock
**before
;
2049 if (!inode
->i_flock
)
2052 if (filp
->f_op
&& filp
->f_op
->flock
) {
2053 struct file_lock fl
= {
2054 .fl_pid
= current
->tgid
,
2056 .fl_flags
= FL_FLOCK
,
2058 .fl_end
= OFFSET_MAX
,
2060 filp
->f_op
->flock(filp
, F_SETLKW
, &fl
);
2061 if (fl
.fl_ops
&& fl
.fl_ops
->fl_release_private
)
2062 fl
.fl_ops
->fl_release_private(&fl
);
2066 before
= &inode
->i_flock
;
2068 while ((fl
= *before
) != NULL
) {
2069 if (fl
->fl_file
== filp
) {
2071 locks_delete_lock(before
);
2075 lease_modify(before
, F_UNLCK
);
2081 before
= &fl
->fl_next
;
2087 * posix_unblock_lock - stop waiting for a file lock
2088 * @filp: how the file was opened
2089 * @waiter: the lock which was waiting
2091 * lockd needs to block waiting for locks.
2094 posix_unblock_lock(struct file
*filp
, struct file_lock
*waiter
)
2099 if (waiter
->fl_next
)
2100 __locks_delete_block(waiter
);
2107 EXPORT_SYMBOL(posix_unblock_lock
);
2110 * vfs_cancel_lock - file byte range unblock lock
2111 * @filp: The file to apply the unblock to
2112 * @fl: The lock to be unblocked
2114 * Used by lock managers to cancel blocked requests
2116 int vfs_cancel_lock(struct file
*filp
, struct file_lock
*fl
)
2118 if (filp
->f_op
&& filp
->f_op
->lock
)
2119 return filp
->f_op
->lock(filp
, F_CANCELLK
, fl
);
2123 EXPORT_SYMBOL_GPL(vfs_cancel_lock
);
2125 #ifdef CONFIG_PROC_FS
2126 #include <linux/proc_fs.h>
2127 #include <linux/seq_file.h>
2129 static void lock_get_status(struct seq_file
*f
, struct file_lock
*fl
,
2130 loff_t id
, char *pfx
)
2132 struct inode
*inode
= NULL
;
2133 unsigned int fl_pid
;
2136 fl_pid
= pid_vnr(fl
->fl_nspid
);
2138 fl_pid
= fl
->fl_pid
;
2140 if (fl
->fl_file
!= NULL
)
2141 inode
= fl
->fl_file
->f_path
.dentry
->d_inode
;
2143 seq_printf(f
, "%lld:%s ", id
, pfx
);
2145 seq_printf(f
, "%6s %s ",
2146 (fl
->fl_flags
& FL_ACCESS
) ? "ACCESS" : "POSIX ",
2147 (inode
== NULL
) ? "*NOINODE*" :
2148 mandatory_lock(inode
) ? "MANDATORY" : "ADVISORY ");
2149 } else if (IS_FLOCK(fl
)) {
2150 if (fl
->fl_type
& LOCK_MAND
) {
2151 seq_printf(f
, "FLOCK MSNFS ");
2153 seq_printf(f
, "FLOCK ADVISORY ");
2155 } else if (IS_LEASE(fl
)) {
2156 seq_printf(f
, "LEASE ");
2157 if (fl
->fl_type
& F_INPROGRESS
)
2158 seq_printf(f
, "BREAKING ");
2159 else if (fl
->fl_file
)
2160 seq_printf(f
, "ACTIVE ");
2162 seq_printf(f
, "BREAKER ");
2164 seq_printf(f
, "UNKNOWN UNKNOWN ");
2166 if (fl
->fl_type
& LOCK_MAND
) {
2167 seq_printf(f
, "%s ",
2168 (fl
->fl_type
& LOCK_READ
)
2169 ? (fl
->fl_type
& LOCK_WRITE
) ? "RW " : "READ "
2170 : (fl
->fl_type
& LOCK_WRITE
) ? "WRITE" : "NONE ");
2172 seq_printf(f
, "%s ",
2173 (fl
->fl_type
& F_INPROGRESS
)
2174 ? (fl
->fl_type
& F_UNLCK
) ? "UNLCK" : "READ "
2175 : (fl
->fl_type
& F_WRLCK
) ? "WRITE" : "READ ");
2178 #ifdef WE_CAN_BREAK_LSLK_NOW
2179 seq_printf(f
, "%d %s:%ld ", fl_pid
,
2180 inode
->i_sb
->s_id
, inode
->i_ino
);
2182 /* userspace relies on this representation of dev_t ;-( */
2183 seq_printf(f
, "%d %02x:%02x:%ld ", fl_pid
,
2184 MAJOR(inode
->i_sb
->s_dev
),
2185 MINOR(inode
->i_sb
->s_dev
), inode
->i_ino
);
2188 seq_printf(f
, "%d <none>:0 ", fl_pid
);
2191 if (fl
->fl_end
== OFFSET_MAX
)
2192 seq_printf(f
, "%Ld EOF\n", fl
->fl_start
);
2194 seq_printf(f
, "%Ld %Ld\n", fl
->fl_start
, fl
->fl_end
);
2196 seq_printf(f
, "0 EOF\n");
2200 static int locks_show(struct seq_file
*f
, void *v
)
2202 struct file_lock
*fl
, *bfl
;
2204 fl
= list_entry(v
, struct file_lock
, fl_link
);
2206 lock_get_status(f
, fl
, *((loff_t
*)f
->private), "");
2208 list_for_each_entry(bfl
, &fl
->fl_block
, fl_block
)
2209 lock_get_status(f
, bfl
, *((loff_t
*)f
->private), " ->");
2214 static void *locks_start(struct seq_file
*f
, loff_t
*pos
)
2216 loff_t
*p
= f
->private;
2220 return seq_list_start(&file_lock_list
, *pos
);
2223 static void *locks_next(struct seq_file
*f
, void *v
, loff_t
*pos
)
2225 loff_t
*p
= f
->private;
2227 return seq_list_next(v
, &file_lock_list
, pos
);
2230 static void locks_stop(struct seq_file
*f
, void *v
)
2235 static const struct seq_operations locks_seq_operations
= {
2236 .start
= locks_start
,
2242 static int locks_open(struct inode
*inode
, struct file
*filp
)
2244 return seq_open_private(filp
, &locks_seq_operations
, sizeof(loff_t
));
2247 static const struct file_operations proc_locks_operations
= {
2250 .llseek
= seq_lseek
,
2251 .release
= seq_release_private
,
2254 static int __init
proc_locks_init(void)
2256 proc_create("locks", 0, NULL
, &proc_locks_operations
);
2259 module_init(proc_locks_init
);
2263 * lock_may_read - checks that the region is free of locks
2264 * @inode: the inode that is being read
2265 * @start: the first byte to read
2266 * @len: the number of bytes to read
2268 * Emulates Windows locking requirements. Whole-file
2269 * mandatory locks (share modes) can prohibit a read and
2270 * byte-range POSIX locks can prohibit a read if they overlap.
2272 * N.B. this function is only ever called
2273 * from knfsd and ownership of locks is never checked.
2275 int lock_may_read(struct inode
*inode
, loff_t start
, unsigned long len
)
2277 struct file_lock
*fl
;
2280 for (fl
= inode
->i_flock
; fl
!= NULL
; fl
= fl
->fl_next
) {
2282 if (fl
->fl_type
== F_RDLCK
)
2284 if ((fl
->fl_end
< start
) || (fl
->fl_start
> (start
+ len
)))
2286 } else if (IS_FLOCK(fl
)) {
2287 if (!(fl
->fl_type
& LOCK_MAND
))
2289 if (fl
->fl_type
& LOCK_READ
)
2300 EXPORT_SYMBOL(lock_may_read
);
2303 * lock_may_write - checks that the region is free of locks
2304 * @inode: the inode that is being written
2305 * @start: the first byte to write
2306 * @len: the number of bytes to write
2308 * Emulates Windows locking requirements. Whole-file
2309 * mandatory locks (share modes) can prohibit a write and
2310 * byte-range POSIX locks can prohibit a write if they overlap.
2312 * N.B. this function is only ever called
2313 * from knfsd and ownership of locks is never checked.
2315 int lock_may_write(struct inode
*inode
, loff_t start
, unsigned long len
)
2317 struct file_lock
*fl
;
2320 for (fl
= inode
->i_flock
; fl
!= NULL
; fl
= fl
->fl_next
) {
2322 if ((fl
->fl_end
< start
) || (fl
->fl_start
> (start
+ len
)))
2324 } else if (IS_FLOCK(fl
)) {
2325 if (!(fl
->fl_type
& LOCK_MAND
))
2327 if (fl
->fl_type
& LOCK_WRITE
)
2338 EXPORT_SYMBOL(lock_may_write
);
2340 static int __init
filelock_init(void)
2342 filelock_cache
= kmem_cache_create("file_lock_cache",
2343 sizeof(struct file_lock
), 0, SLAB_PANIC
,
2348 core_initcall(filelock_init
);