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/fs.h>
120 #include <linux/init.h>
121 #include <linux/module.h>
122 #include <linux/security.h>
123 #include <linux/slab.h>
124 #include <linux/smp_lock.h>
125 #include <linux/syscalls.h>
126 #include <linux/time.h>
127 #include <linux/rcupdate.h>
129 #include <asm/semaphore.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
);
145 static struct kmem_cache
*filelock_cache __read_mostly
;
147 /* Allocate an empty lock structure. */
148 static struct file_lock
*locks_alloc_lock(void)
150 return kmem_cache_alloc(filelock_cache
, GFP_KERNEL
);
153 static void locks_release_private(struct file_lock
*fl
)
156 if (fl
->fl_ops
->fl_release_private
)
157 fl
->fl_ops
->fl_release_private(fl
);
161 if (fl
->fl_lmops
->fl_release_private
)
162 fl
->fl_lmops
->fl_release_private(fl
);
168 /* Free a lock which is not in use. */
169 static void locks_free_lock(struct file_lock
*fl
)
171 BUG_ON(waitqueue_active(&fl
->fl_wait
));
172 BUG_ON(!list_empty(&fl
->fl_block
));
173 BUG_ON(!list_empty(&fl
->fl_link
));
175 locks_release_private(fl
);
176 kmem_cache_free(filelock_cache
, fl
);
179 void locks_init_lock(struct file_lock
*fl
)
181 INIT_LIST_HEAD(&fl
->fl_link
);
182 INIT_LIST_HEAD(&fl
->fl_block
);
183 init_waitqueue_head(&fl
->fl_wait
);
185 fl
->fl_fasync
= NULL
;
191 fl
->fl_start
= fl
->fl_end
= 0;
196 EXPORT_SYMBOL(locks_init_lock
);
199 * Initialises the fields of the file lock which are invariant for
202 static void init_once(struct kmem_cache
*cache
, void *foo
)
204 struct file_lock
*lock
= (struct file_lock
*) foo
;
206 locks_init_lock(lock
);
209 static void locks_copy_private(struct file_lock
*new, struct file_lock
*fl
)
212 if (fl
->fl_ops
->fl_copy_lock
)
213 fl
->fl_ops
->fl_copy_lock(new, fl
);
214 new->fl_ops
= fl
->fl_ops
;
217 if (fl
->fl_lmops
->fl_copy_lock
)
218 fl
->fl_lmops
->fl_copy_lock(new, fl
);
219 new->fl_lmops
= fl
->fl_lmops
;
224 * Initialize a new lock from an existing file_lock structure.
226 static void __locks_copy_lock(struct file_lock
*new, const struct file_lock
*fl
)
228 new->fl_owner
= fl
->fl_owner
;
229 new->fl_pid
= fl
->fl_pid
;
231 new->fl_flags
= fl
->fl_flags
;
232 new->fl_type
= fl
->fl_type
;
233 new->fl_start
= fl
->fl_start
;
234 new->fl_end
= fl
->fl_end
;
236 new->fl_lmops
= NULL
;
239 void locks_copy_lock(struct file_lock
*new, struct file_lock
*fl
)
241 locks_release_private(new);
243 __locks_copy_lock(new, fl
);
244 new->fl_file
= fl
->fl_file
;
245 new->fl_ops
= fl
->fl_ops
;
246 new->fl_lmops
= fl
->fl_lmops
;
248 locks_copy_private(new, fl
);
251 EXPORT_SYMBOL(locks_copy_lock
);
253 static inline int flock_translate_cmd(int cmd
) {
255 return cmd
& (LOCK_MAND
| LOCK_RW
);
267 /* Fill in a file_lock structure with an appropriate FLOCK lock. */
268 static int flock_make_lock(struct file
*filp
, struct file_lock
**lock
,
271 struct file_lock
*fl
;
272 int type
= flock_translate_cmd(cmd
);
276 fl
= locks_alloc_lock();
281 fl
->fl_pid
= current
->tgid
;
282 fl
->fl_flags
= FL_FLOCK
;
284 fl
->fl_end
= OFFSET_MAX
;
290 static int assign_type(struct file_lock
*fl
, int type
)
304 /* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
307 static int flock_to_posix_lock(struct file
*filp
, struct file_lock
*fl
,
312 switch (l
->l_whence
) {
320 start
= i_size_read(filp
->f_path
.dentry
->d_inode
);
326 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
327 POSIX-2001 defines it. */
331 fl
->fl_end
= OFFSET_MAX
;
333 end
= start
+ l
->l_len
- 1;
335 } else if (l
->l_len
< 0) {
342 fl
->fl_start
= start
; /* we record the absolute position */
343 if (fl
->fl_end
< fl
->fl_start
)
346 fl
->fl_owner
= current
->files
;
347 fl
->fl_pid
= current
->tgid
;
349 fl
->fl_flags
= FL_POSIX
;
353 return assign_type(fl
, l
->l_type
);
356 #if BITS_PER_LONG == 32
357 static int flock64_to_posix_lock(struct file
*filp
, struct file_lock
*fl
,
362 switch (l
->l_whence
) {
370 start
= i_size_read(filp
->f_path
.dentry
->d_inode
);
379 fl
->fl_end
= OFFSET_MAX
;
381 fl
->fl_end
= start
+ l
->l_len
- 1;
382 } else if (l
->l_len
< 0) {
383 fl
->fl_end
= start
- 1;
388 fl
->fl_start
= start
; /* we record the absolute position */
389 if (fl
->fl_end
< fl
->fl_start
)
392 fl
->fl_owner
= current
->files
;
393 fl
->fl_pid
= current
->tgid
;
395 fl
->fl_flags
= FL_POSIX
;
403 fl
->fl_type
= l
->l_type
;
413 /* default lease lock manager operations */
414 static void lease_break_callback(struct file_lock
*fl
)
416 kill_fasync(&fl
->fl_fasync
, SIGIO
, POLL_MSG
);
419 static void lease_release_private_callback(struct file_lock
*fl
)
424 f_delown(fl
->fl_file
);
425 fl
->fl_file
->f_owner
.signum
= 0;
428 static int lease_mylease_callback(struct file_lock
*fl
, struct file_lock
*try)
430 return fl
->fl_file
== try->fl_file
;
433 static struct lock_manager_operations lease_manager_ops
= {
434 .fl_break
= lease_break_callback
,
435 .fl_release_private
= lease_release_private_callback
,
436 .fl_mylease
= lease_mylease_callback
,
437 .fl_change
= lease_modify
,
441 * Initialize a lease, use the default lock manager operations
443 static int lease_init(struct file
*filp
, int type
, struct file_lock
*fl
)
445 if (assign_type(fl
, type
) != 0)
448 fl
->fl_owner
= current
->files
;
449 fl
->fl_pid
= current
->tgid
;
452 fl
->fl_flags
= FL_LEASE
;
454 fl
->fl_end
= OFFSET_MAX
;
456 fl
->fl_lmops
= &lease_manager_ops
;
460 /* Allocate a file_lock initialised to this type of lease */
461 static struct file_lock
*lease_alloc(struct file
*filp
, int type
)
463 struct file_lock
*fl
= locks_alloc_lock();
467 return ERR_PTR(error
);
469 error
= lease_init(filp
, type
, fl
);
472 return ERR_PTR(error
);
477 /* Check if two locks overlap each other.
479 static inline int locks_overlap(struct file_lock
*fl1
, struct file_lock
*fl2
)
481 return ((fl1
->fl_end
>= fl2
->fl_start
) &&
482 (fl2
->fl_end
>= fl1
->fl_start
));
486 * Check whether two locks have the same owner.
488 static int posix_same_owner(struct file_lock
*fl1
, struct file_lock
*fl2
)
490 if (fl1
->fl_lmops
&& fl1
->fl_lmops
->fl_compare_owner
)
491 return fl2
->fl_lmops
== fl1
->fl_lmops
&&
492 fl1
->fl_lmops
->fl_compare_owner(fl1
, fl2
);
493 return fl1
->fl_owner
== fl2
->fl_owner
;
496 /* Remove waiter from blocker's block list.
497 * When blocker ends up pointing to itself then the list is empty.
499 static void __locks_delete_block(struct file_lock
*waiter
)
501 list_del_init(&waiter
->fl_block
);
502 list_del_init(&waiter
->fl_link
);
503 waiter
->fl_next
= NULL
;
508 static void locks_delete_block(struct file_lock
*waiter
)
511 __locks_delete_block(waiter
);
515 /* Insert waiter into blocker's block list.
516 * We use a circular list so that processes can be easily woken up in
517 * the order they blocked. The documentation doesn't require this but
518 * it seems like the reasonable thing to do.
520 static void locks_insert_block(struct file_lock
*blocker
,
521 struct file_lock
*waiter
)
523 BUG_ON(!list_empty(&waiter
->fl_block
));
524 list_add_tail(&waiter
->fl_block
, &blocker
->fl_block
);
525 waiter
->fl_next
= blocker
;
526 if (IS_POSIX(blocker
))
527 list_add(&waiter
->fl_link
, &blocked_list
);
530 /* Wake up processes blocked waiting for blocker.
531 * If told to wait then schedule the processes until the block list
532 * is empty, otherwise empty the block list ourselves.
534 static void locks_wake_up_blocks(struct file_lock
*blocker
)
536 while (!list_empty(&blocker
->fl_block
)) {
537 struct file_lock
*waiter
;
539 waiter
= list_first_entry(&blocker
->fl_block
,
540 struct file_lock
, fl_block
);
541 __locks_delete_block(waiter
);
542 if (waiter
->fl_lmops
&& waiter
->fl_lmops
->fl_notify
)
543 waiter
->fl_lmops
->fl_notify(waiter
);
545 wake_up(&waiter
->fl_wait
);
549 /* Insert file lock fl into an inode's lock list at the position indicated
550 * by pos. At the same time add the lock to the global file lock list.
552 static void locks_insert_lock(struct file_lock
**pos
, struct file_lock
*fl
)
554 list_add(&fl
->fl_link
, &file_lock_list
);
556 /* insert into file's list */
560 if (fl
->fl_ops
&& fl
->fl_ops
->fl_insert
)
561 fl
->fl_ops
->fl_insert(fl
);
565 * Delete a lock and then free it.
566 * Wake up processes that are blocked waiting for this lock,
567 * notify the FS that the lock has been cleared and
568 * finally free the lock.
570 static void locks_delete_lock(struct file_lock
**thisfl_p
)
572 struct file_lock
*fl
= *thisfl_p
;
574 *thisfl_p
= fl
->fl_next
;
576 list_del_init(&fl
->fl_link
);
578 fasync_helper(0, fl
->fl_file
, 0, &fl
->fl_fasync
);
579 if (fl
->fl_fasync
!= NULL
) {
580 printk(KERN_ERR
"locks_delete_lock: fasync == %p\n", fl
->fl_fasync
);
581 fl
->fl_fasync
= NULL
;
584 if (fl
->fl_ops
&& fl
->fl_ops
->fl_remove
)
585 fl
->fl_ops
->fl_remove(fl
);
587 locks_wake_up_blocks(fl
);
591 /* Determine if lock sys_fl blocks lock caller_fl. Common functionality
592 * checks for shared/exclusive status of overlapping locks.
594 static int locks_conflict(struct file_lock
*caller_fl
, struct file_lock
*sys_fl
)
596 if (sys_fl
->fl_type
== F_WRLCK
)
598 if (caller_fl
->fl_type
== F_WRLCK
)
603 /* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
604 * checking before calling the locks_conflict().
606 static int posix_locks_conflict(struct file_lock
*caller_fl
, struct file_lock
*sys_fl
)
608 /* POSIX locks owned by the same process do not conflict with
611 if (!IS_POSIX(sys_fl
) || posix_same_owner(caller_fl
, sys_fl
))
614 /* Check whether they overlap */
615 if (!locks_overlap(caller_fl
, sys_fl
))
618 return (locks_conflict(caller_fl
, sys_fl
));
621 /* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
622 * checking before calling the locks_conflict().
624 static int flock_locks_conflict(struct file_lock
*caller_fl
, struct file_lock
*sys_fl
)
626 /* FLOCK locks referring to the same filp do not conflict with
629 if (!IS_FLOCK(sys_fl
) || (caller_fl
->fl_file
== sys_fl
->fl_file
))
631 if ((caller_fl
->fl_type
& LOCK_MAND
) || (sys_fl
->fl_type
& LOCK_MAND
))
634 return (locks_conflict(caller_fl
, sys_fl
));
637 static int interruptible_sleep_on_locked(wait_queue_head_t
*fl_wait
, int timeout
)
640 DECLARE_WAITQUEUE(wait
, current
);
642 __set_current_state(TASK_INTERRUPTIBLE
);
643 add_wait_queue(fl_wait
, &wait
);
647 result
= schedule_timeout(timeout
);
648 if (signal_pending(current
))
649 result
= -ERESTARTSYS
;
650 remove_wait_queue(fl_wait
, &wait
);
651 __set_current_state(TASK_RUNNING
);
655 static int locks_block_on_timeout(struct file_lock
*blocker
, struct file_lock
*waiter
, int time
)
658 locks_insert_block(blocker
, waiter
);
659 result
= interruptible_sleep_on_locked(&waiter
->fl_wait
, time
);
660 __locks_delete_block(waiter
);
665 posix_test_lock(struct file
*filp
, struct file_lock
*fl
)
667 struct file_lock
*cfl
;
670 for (cfl
= filp
->f_path
.dentry
->d_inode
->i_flock
; cfl
; cfl
= cfl
->fl_next
) {
673 if (posix_locks_conflict(fl
, cfl
))
677 __locks_copy_lock(fl
, cfl
);
679 fl
->fl_type
= F_UNLCK
;
684 EXPORT_SYMBOL(posix_test_lock
);
686 /* This function tests for deadlock condition before putting a process to
687 * sleep. The detection scheme is no longer recursive. Recursive was neat,
688 * but dangerous - we risked stack corruption if the lock data was bad, or
689 * if the recursion was too deep for any other reason.
691 * We rely on the fact that a task can only be on one lock's wait queue
692 * at a time. When we find blocked_task on a wait queue we can re-search
693 * with blocked_task equal to that queue's owner, until either blocked_task
694 * isn't found, or blocked_task is found on a queue owned by my_task.
696 * Note: the above assumption may not be true when handling lock requests
697 * from a broken NFS client. But broken NFS clients have a lot more to
698 * worry about than proper deadlock detection anyway... --okir
700 * However, the failure of this assumption (also possible in the case of
701 * multiple tasks sharing the same open file table) also means there's no
702 * guarantee that the loop below will terminate. As a hack, we give up
703 * after a few iterations.
706 #define MAX_DEADLK_ITERATIONS 10
708 static int posix_locks_deadlock(struct file_lock
*caller_fl
,
709 struct file_lock
*block_fl
)
711 struct file_lock
*fl
;
715 if (posix_same_owner(caller_fl
, block_fl
))
717 list_for_each_entry(fl
, &blocked_list
, fl_link
) {
718 if (posix_same_owner(fl
, block_fl
)) {
719 if (i
++ > MAX_DEADLK_ITERATIONS
)
729 /* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
730 * after any leases, but before any posix locks.
732 * Note that if called with an FL_EXISTS argument, the caller may determine
733 * whether or not a lock was successfully freed by testing the return
736 static int flock_lock_file(struct file
*filp
, struct file_lock
*request
)
738 struct file_lock
*new_fl
= NULL
;
739 struct file_lock
**before
;
740 struct inode
* inode
= filp
->f_path
.dentry
->d_inode
;
745 if (request
->fl_flags
& FL_ACCESS
)
748 if (request
->fl_type
!= F_UNLCK
) {
750 new_fl
= locks_alloc_lock();
756 for_each_lock(inode
, before
) {
757 struct file_lock
*fl
= *before
;
762 if (filp
!= fl
->fl_file
)
764 if (request
->fl_type
== fl
->fl_type
)
767 locks_delete_lock(before
);
771 if (request
->fl_type
== F_UNLCK
) {
772 if ((request
->fl_flags
& FL_EXISTS
) && !found
)
778 * If a higher-priority process was blocked on the old file lock,
779 * give it the opportunity to lock the file.
785 for_each_lock(inode
, before
) {
786 struct file_lock
*fl
= *before
;
791 if (!flock_locks_conflict(request
, fl
))
794 if (request
->fl_flags
& FL_SLEEP
)
795 locks_insert_block(fl
, request
);
798 if (request
->fl_flags
& FL_ACCESS
)
800 locks_copy_lock(new_fl
, request
);
801 locks_insert_lock(before
, new_fl
);
808 locks_free_lock(new_fl
);
812 static int __posix_lock_file(struct inode
*inode
, struct file_lock
*request
, struct file_lock
*conflock
)
814 struct file_lock
*fl
;
815 struct file_lock
*new_fl
= NULL
;
816 struct file_lock
*new_fl2
= NULL
;
817 struct file_lock
*left
= NULL
;
818 struct file_lock
*right
= NULL
;
819 struct file_lock
**before
;
820 int error
, added
= 0;
823 * We may need two file_lock structures for this operation,
824 * so we get them in advance to avoid races.
826 * In some cases we can be sure, that no new locks will be needed
828 if (!(request
->fl_flags
& FL_ACCESS
) &&
829 (request
->fl_type
!= F_UNLCK
||
830 request
->fl_start
!= 0 || request
->fl_end
!= OFFSET_MAX
)) {
831 new_fl
= locks_alloc_lock();
832 new_fl2
= locks_alloc_lock();
836 if (request
->fl_type
!= F_UNLCK
) {
837 for_each_lock(inode
, before
) {
841 if (!posix_locks_conflict(request
, fl
))
844 locks_copy_lock(conflock
, fl
);
846 if (!(request
->fl_flags
& FL_SLEEP
))
849 if (posix_locks_deadlock(request
, fl
))
852 locks_insert_block(fl
, request
);
857 /* If we're just looking for a conflict, we're done. */
859 if (request
->fl_flags
& FL_ACCESS
)
863 * Find the first old lock with the same owner as the new lock.
866 before
= &inode
->i_flock
;
868 /* First skip locks owned by other processes. */
869 while ((fl
= *before
) && (!IS_POSIX(fl
) ||
870 !posix_same_owner(request
, fl
))) {
871 before
= &fl
->fl_next
;
874 /* Process locks with this owner. */
875 while ((fl
= *before
) && posix_same_owner(request
, fl
)) {
876 /* Detect adjacent or overlapping regions (if same lock type)
878 if (request
->fl_type
== fl
->fl_type
) {
879 /* In all comparisons of start vs end, use
880 * "start - 1" rather than "end + 1". If end
881 * is OFFSET_MAX, end + 1 will become negative.
883 if (fl
->fl_end
< request
->fl_start
- 1)
885 /* If the next lock in the list has entirely bigger
886 * addresses than the new one, insert the lock here.
888 if (fl
->fl_start
- 1 > request
->fl_end
)
891 /* If we come here, the new and old lock are of the
892 * same type and adjacent or overlapping. Make one
893 * lock yielding from the lower start address of both
894 * locks to the higher end address.
896 if (fl
->fl_start
> request
->fl_start
)
897 fl
->fl_start
= request
->fl_start
;
899 request
->fl_start
= fl
->fl_start
;
900 if (fl
->fl_end
< request
->fl_end
)
901 fl
->fl_end
= request
->fl_end
;
903 request
->fl_end
= fl
->fl_end
;
905 locks_delete_lock(before
);
912 /* Processing for different lock types is a bit
915 if (fl
->fl_end
< request
->fl_start
)
917 if (fl
->fl_start
> request
->fl_end
)
919 if (request
->fl_type
== F_UNLCK
)
921 if (fl
->fl_start
< request
->fl_start
)
923 /* If the next lock in the list has a higher end
924 * address than the new one, insert the new one here.
926 if (fl
->fl_end
> request
->fl_end
) {
930 if (fl
->fl_start
>= request
->fl_start
) {
931 /* The new lock completely replaces an old
932 * one (This may happen several times).
935 locks_delete_lock(before
);
938 /* Replace the old lock with the new one.
939 * Wake up anybody waiting for the old one,
940 * as the change in lock type might satisfy
943 locks_wake_up_blocks(fl
);
944 fl
->fl_start
= request
->fl_start
;
945 fl
->fl_end
= request
->fl_end
;
946 fl
->fl_type
= request
->fl_type
;
947 locks_release_private(fl
);
948 locks_copy_private(fl
, request
);
953 /* Go on to next lock.
956 before
= &fl
->fl_next
;
960 * The above code only modifies existing locks in case of
961 * merging or replacing. If new lock(s) need to be inserted
962 * all modifications are done bellow this, so it's safe yet to
965 error
= -ENOLCK
; /* "no luck" */
966 if (right
&& left
== right
&& !new_fl2
)
971 if (request
->fl_type
== F_UNLCK
) {
972 if (request
->fl_flags
& FL_EXISTS
)
981 locks_copy_lock(new_fl
, request
);
982 locks_insert_lock(before
, new_fl
);
987 /* The new lock breaks the old one in two pieces,
988 * so we have to use the second new lock.
992 locks_copy_lock(left
, right
);
993 locks_insert_lock(before
, left
);
995 right
->fl_start
= request
->fl_end
+ 1;
996 locks_wake_up_blocks(right
);
999 left
->fl_end
= request
->fl_start
- 1;
1000 locks_wake_up_blocks(left
);
1005 * Free any unused locks.
1008 locks_free_lock(new_fl
);
1010 locks_free_lock(new_fl2
);
1015 * posix_lock_file - Apply a POSIX-style lock to a file
1016 * @filp: The file to apply the lock to
1017 * @fl: The lock to be applied
1018 * @conflock: Place to return a copy of the conflicting lock, if found.
1020 * Add a POSIX style lock to a file.
1021 * We merge adjacent & overlapping locks whenever possible.
1022 * POSIX locks are sorted by owner task, then by starting address
1024 * Note that if called with an FL_EXISTS argument, the caller may determine
1025 * whether or not a lock was successfully freed by testing the return
1026 * value for -ENOENT.
1028 int posix_lock_file(struct file
*filp
, struct file_lock
*fl
,
1029 struct file_lock
*conflock
)
1031 return __posix_lock_file(filp
->f_path
.dentry
->d_inode
, fl
, conflock
);
1033 EXPORT_SYMBOL(posix_lock_file
);
1036 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1037 * @filp: The file to apply the lock to
1038 * @fl: The lock to be applied
1040 * Add a POSIX style lock to a file.
1041 * We merge adjacent & overlapping locks whenever possible.
1042 * POSIX locks are sorted by owner task, then by starting address
1044 int posix_lock_file_wait(struct file
*filp
, struct file_lock
*fl
)
1049 error
= posix_lock_file(filp
, fl
, NULL
);
1050 if ((error
!= -EAGAIN
) || !(fl
->fl_flags
& FL_SLEEP
))
1052 error
= wait_event_interruptible(fl
->fl_wait
, !fl
->fl_next
);
1056 locks_delete_block(fl
);
1061 EXPORT_SYMBOL(posix_lock_file_wait
);
1064 * locks_mandatory_locked - Check for an active lock
1065 * @inode: the file to check
1067 * Searches the inode's list of locks to find any POSIX locks which conflict.
1068 * This function is called from locks_verify_locked() only.
1070 int locks_mandatory_locked(struct inode
*inode
)
1072 fl_owner_t owner
= current
->files
;
1073 struct file_lock
*fl
;
1076 * Search the lock list for this inode for any POSIX locks.
1079 for (fl
= inode
->i_flock
; fl
!= NULL
; fl
= fl
->fl_next
) {
1082 if (fl
->fl_owner
!= owner
)
1086 return fl
? -EAGAIN
: 0;
1090 * locks_mandatory_area - Check for a conflicting lock
1091 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1093 * @inode: the file to check
1094 * @filp: how the file was opened (if it was)
1095 * @offset: start of area to check
1096 * @count: length of area to check
1098 * Searches the inode's list of locks to find any POSIX locks which conflict.
1099 * This function is called from rw_verify_area() and
1100 * locks_verify_truncate().
1102 int locks_mandatory_area(int read_write
, struct inode
*inode
,
1103 struct file
*filp
, loff_t offset
,
1106 struct file_lock fl
;
1109 locks_init_lock(&fl
);
1110 fl
.fl_owner
= current
->files
;
1111 fl
.fl_pid
= current
->tgid
;
1113 fl
.fl_flags
= FL_POSIX
| FL_ACCESS
;
1114 if (filp
&& !(filp
->f_flags
& O_NONBLOCK
))
1115 fl
.fl_flags
|= FL_SLEEP
;
1116 fl
.fl_type
= (read_write
== FLOCK_VERIFY_WRITE
) ? F_WRLCK
: F_RDLCK
;
1117 fl
.fl_start
= offset
;
1118 fl
.fl_end
= offset
+ count
- 1;
1121 error
= __posix_lock_file(inode
, &fl
, NULL
);
1122 if (error
!= -EAGAIN
)
1124 if (!(fl
.fl_flags
& FL_SLEEP
))
1126 error
= wait_event_interruptible(fl
.fl_wait
, !fl
.fl_next
);
1129 * If we've been sleeping someone might have
1130 * changed the permissions behind our back.
1132 if (__mandatory_lock(inode
))
1136 locks_delete_block(&fl
);
1143 EXPORT_SYMBOL(locks_mandatory_area
);
1145 /* We already had a lease on this file; just change its type */
1146 int lease_modify(struct file_lock
**before
, int arg
)
1148 struct file_lock
*fl
= *before
;
1149 int error
= assign_type(fl
, arg
);
1153 locks_wake_up_blocks(fl
);
1155 locks_delete_lock(before
);
1159 EXPORT_SYMBOL(lease_modify
);
1161 static void time_out_leases(struct inode
*inode
)
1163 struct file_lock
**before
;
1164 struct file_lock
*fl
;
1166 before
= &inode
->i_flock
;
1167 while ((fl
= *before
) && IS_LEASE(fl
) && (fl
->fl_type
& F_INPROGRESS
)) {
1168 if ((fl
->fl_break_time
== 0)
1169 || time_before(jiffies
, fl
->fl_break_time
)) {
1170 before
= &fl
->fl_next
;
1173 lease_modify(before
, fl
->fl_type
& ~F_INPROGRESS
);
1174 if (fl
== *before
) /* lease_modify may have freed fl */
1175 before
= &fl
->fl_next
;
1180 * __break_lease - revoke all outstanding leases on file
1181 * @inode: the inode of the file to return
1182 * @mode: the open mode (read or write)
1184 * break_lease (inlined for speed) has checked there already is at least
1185 * some kind of lock (maybe a lease) on this file. Leases are broken on
1186 * a call to open() or truncate(). This function can sleep unless you
1187 * specified %O_NONBLOCK to your open().
1189 int __break_lease(struct inode
*inode
, unsigned int mode
)
1191 int error
= 0, future
;
1192 struct file_lock
*new_fl
, *flock
;
1193 struct file_lock
*fl
;
1194 unsigned long break_time
;
1195 int i_have_this_lease
= 0;
1197 new_fl
= lease_alloc(NULL
, mode
& FMODE_WRITE
? F_WRLCK
: F_RDLCK
);
1201 time_out_leases(inode
);
1203 flock
= inode
->i_flock
;
1204 if ((flock
== NULL
) || !IS_LEASE(flock
))
1207 for (fl
= flock
; fl
&& IS_LEASE(fl
); fl
= fl
->fl_next
)
1208 if (fl
->fl_owner
== current
->files
)
1209 i_have_this_lease
= 1;
1211 if (mode
& FMODE_WRITE
) {
1212 /* If we want write access, we have to revoke any lease. */
1213 future
= F_UNLCK
| F_INPROGRESS
;
1214 } else if (flock
->fl_type
& F_INPROGRESS
) {
1215 /* If the lease is already being broken, we just leave it */
1216 future
= flock
->fl_type
;
1217 } else if (flock
->fl_type
& F_WRLCK
) {
1218 /* Downgrade the exclusive lease to a read-only lease. */
1219 future
= F_RDLCK
| F_INPROGRESS
;
1221 /* the existing lease was read-only, so we can read too. */
1225 if (IS_ERR(new_fl
) && !i_have_this_lease
1226 && ((mode
& O_NONBLOCK
) == 0)) {
1227 error
= PTR_ERR(new_fl
);
1232 if (lease_break_time
> 0) {
1233 break_time
= jiffies
+ lease_break_time
* HZ
;
1234 if (break_time
== 0)
1235 break_time
++; /* so that 0 means no break time */
1238 for (fl
= flock
; fl
&& IS_LEASE(fl
); fl
= fl
->fl_next
) {
1239 if (fl
->fl_type
!= future
) {
1240 fl
->fl_type
= future
;
1241 fl
->fl_break_time
= break_time
;
1242 /* lease must have lmops break callback */
1243 fl
->fl_lmops
->fl_break(fl
);
1247 if (i_have_this_lease
|| (mode
& O_NONBLOCK
)) {
1248 error
= -EWOULDBLOCK
;
1253 break_time
= flock
->fl_break_time
;
1254 if (break_time
!= 0) {
1255 break_time
-= jiffies
;
1256 if (break_time
== 0)
1259 error
= locks_block_on_timeout(flock
, new_fl
, break_time
);
1262 time_out_leases(inode
);
1263 /* Wait for the next lease that has not been broken yet */
1264 for (flock
= inode
->i_flock
; flock
&& IS_LEASE(flock
);
1265 flock
= flock
->fl_next
) {
1266 if (flock
->fl_type
& F_INPROGRESS
)
1274 if (!IS_ERR(new_fl
))
1275 locks_free_lock(new_fl
);
1279 EXPORT_SYMBOL(__break_lease
);
1284 * @time: pointer to a timespec which will contain the last modified time
1286 * This is to force NFS clients to flush their caches for files with
1287 * exclusive leases. The justification is that if someone has an
1288 * exclusive lease, then they could be modifiying it.
1290 void lease_get_mtime(struct inode
*inode
, struct timespec
*time
)
1292 struct file_lock
*flock
= inode
->i_flock
;
1293 if (flock
&& IS_LEASE(flock
) && (flock
->fl_type
& F_WRLCK
))
1294 *time
= current_fs_time(inode
->i_sb
);
1296 *time
= inode
->i_mtime
;
1299 EXPORT_SYMBOL(lease_get_mtime
);
1302 * fcntl_getlease - Enquire what lease is currently active
1305 * The value returned by this function will be one of
1306 * (if no lease break is pending):
1308 * %F_RDLCK to indicate a shared lease is held.
1310 * %F_WRLCK to indicate an exclusive lease is held.
1312 * %F_UNLCK to indicate no lease is held.
1314 * (if a lease break is pending):
1316 * %F_RDLCK to indicate an exclusive lease needs to be
1317 * changed to a shared lease (or removed).
1319 * %F_UNLCK to indicate the lease needs to be removed.
1321 * XXX: sfr & willy disagree over whether F_INPROGRESS
1322 * should be returned to userspace.
1324 int fcntl_getlease(struct file
*filp
)
1326 struct file_lock
*fl
;
1330 time_out_leases(filp
->f_path
.dentry
->d_inode
);
1331 for (fl
= filp
->f_path
.dentry
->d_inode
->i_flock
; fl
&& IS_LEASE(fl
);
1333 if (fl
->fl_file
== filp
) {
1334 type
= fl
->fl_type
& ~F_INPROGRESS
;
1343 * generic_setlease - sets a lease on an open file
1344 * @filp: file pointer
1345 * @arg: type of lease to obtain
1346 * @flp: input - file_lock to use, output - file_lock inserted
1348 * The (input) flp->fl_lmops->fl_break function is required
1351 * Called with kernel lock held.
1353 int generic_setlease(struct file
*filp
, long arg
, struct file_lock
**flp
)
1355 struct file_lock
*fl
, **before
, **my_before
= NULL
, *lease
;
1356 struct file_lock
*new_fl
= NULL
;
1357 struct dentry
*dentry
= filp
->f_path
.dentry
;
1358 struct inode
*inode
= dentry
->d_inode
;
1359 int error
, rdlease_count
= 0, wrlease_count
= 0;
1361 if ((current
->fsuid
!= inode
->i_uid
) && !capable(CAP_LEASE
))
1363 if (!S_ISREG(inode
->i_mode
))
1365 error
= security_file_lock(filp
, arg
);
1369 time_out_leases(inode
);
1371 BUG_ON(!(*flp
)->fl_lmops
->fl_break
);
1376 if ((arg
== F_RDLCK
) && (atomic_read(&inode
->i_writecount
) > 0))
1378 if ((arg
== F_WRLCK
)
1379 && ((atomic_read(&dentry
->d_count
) > 1)
1380 || (atomic_read(&inode
->i_count
) > 1)))
1384 new_fl
= locks_alloc_lock();
1389 * At this point, we know that if there is an exclusive
1390 * lease on this file, then we hold it on this filp
1391 * (otherwise our open of this file would have blocked).
1392 * And if we are trying to acquire an exclusive lease,
1393 * then the file is not open by anyone (including us)
1394 * except for this filp.
1396 for (before
= &inode
->i_flock
;
1397 ((fl
= *before
) != NULL
) && IS_LEASE(fl
);
1398 before
= &fl
->fl_next
) {
1399 if (lease
->fl_lmops
->fl_mylease(fl
, lease
))
1401 else if (fl
->fl_type
== (F_INPROGRESS
| F_UNLCK
))
1403 * Someone is in the process of opening this
1404 * file for writing so we may not take an
1405 * exclusive lease on it.
1412 if ((arg
== F_RDLCK
&& (wrlease_count
> 0)) ||
1413 (arg
== F_WRLCK
&& ((rdlease_count
+ wrlease_count
) > 0)))
1416 if (my_before
!= NULL
) {
1418 error
= lease
->fl_lmops
->fl_change(my_before
, arg
);
1430 locks_copy_lock(new_fl
, lease
);
1431 locks_insert_lock(before
, new_fl
);
1438 locks_free_lock(new_fl
);
1441 EXPORT_SYMBOL(generic_setlease
);
1444 * vfs_setlease - sets a lease on an open file
1445 * @filp: file pointer
1446 * @arg: type of lease to obtain
1447 * @lease: file_lock to use
1449 * Call this to establish a lease on the file.
1450 * The (*lease)->fl_lmops->fl_break operation must be set; if not,
1451 * break_lease will oops!
1453 * This will call the filesystem's setlease file method, if
1454 * defined. Note that there is no getlease method; instead, the
1455 * filesystem setlease method should call back to setlease() to
1456 * add a lease to the inode's lease list, where fcntl_getlease() can
1457 * find it. Since fcntl_getlease() only reports whether the current
1458 * task holds a lease, a cluster filesystem need only do this for
1459 * leases held by processes on this node.
1461 * There is also no break_lease method; filesystems that
1462 * handle their own leases shoud break leases themselves from the
1463 * filesystem's open, create, and (on truncate) setattr methods.
1465 * Warning: the only current setlease methods exist only to disable
1466 * leases in certain cases. More vfs changes may be required to
1467 * allow a full filesystem lease implementation.
1470 int vfs_setlease(struct file
*filp
, long arg
, struct file_lock
**lease
)
1475 if (filp
->f_op
&& filp
->f_op
->setlease
)
1476 error
= filp
->f_op
->setlease(filp
, arg
, lease
);
1478 error
= generic_setlease(filp
, arg
, lease
);
1483 EXPORT_SYMBOL_GPL(vfs_setlease
);
1486 * fcntl_setlease - sets a lease on an open file
1487 * @fd: open file descriptor
1488 * @filp: file pointer
1489 * @arg: type of lease to obtain
1491 * Call this fcntl to establish a lease on the file.
1492 * Note that you also need to call %F_SETSIG to
1493 * receive a signal when the lease is broken.
1495 int fcntl_setlease(unsigned int fd
, struct file
*filp
, long arg
)
1497 struct file_lock fl
, *flp
= &fl
;
1498 struct dentry
*dentry
= filp
->f_path
.dentry
;
1499 struct inode
*inode
= dentry
->d_inode
;
1502 locks_init_lock(&fl
);
1503 error
= lease_init(filp
, arg
, &fl
);
1509 error
= vfs_setlease(filp
, arg
, &flp
);
1510 if (error
|| arg
== F_UNLCK
)
1513 error
= fasync_helper(fd
, filp
, 1, &flp
->fl_fasync
);
1515 /* remove lease just inserted by setlease */
1516 flp
->fl_type
= F_UNLCK
| F_INPROGRESS
;
1517 flp
->fl_break_time
= jiffies
- 10;
1518 time_out_leases(inode
);
1522 error
= __f_setown(filp
, task_pid(current
), PIDTYPE_PID
, 0);
1529 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1530 * @filp: The file to apply the lock to
1531 * @fl: The lock to be applied
1533 * Add a FLOCK style lock to a file.
1535 int flock_lock_file_wait(struct file
*filp
, struct file_lock
*fl
)
1540 error
= flock_lock_file(filp
, fl
);
1541 if ((error
!= -EAGAIN
) || !(fl
->fl_flags
& FL_SLEEP
))
1543 error
= wait_event_interruptible(fl
->fl_wait
, !fl
->fl_next
);
1547 locks_delete_block(fl
);
1553 EXPORT_SYMBOL(flock_lock_file_wait
);
1556 * sys_flock: - flock() system call.
1557 * @fd: the file descriptor to lock.
1558 * @cmd: the type of lock to apply.
1560 * Apply a %FL_FLOCK style lock to an open file descriptor.
1561 * The @cmd can be one of
1563 * %LOCK_SH -- a shared lock.
1565 * %LOCK_EX -- an exclusive lock.
1567 * %LOCK_UN -- remove an existing lock.
1569 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1571 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1572 * processes read and write access respectively.
1574 asmlinkage
long sys_flock(unsigned int fd
, unsigned int cmd
)
1577 struct file_lock
*lock
;
1578 int can_sleep
, unlock
;
1586 can_sleep
= !(cmd
& LOCK_NB
);
1588 unlock
= (cmd
== LOCK_UN
);
1590 if (!unlock
&& !(cmd
& LOCK_MAND
) && !(filp
->f_mode
& 3))
1593 error
= flock_make_lock(filp
, &lock
, cmd
);
1597 lock
->fl_flags
|= FL_SLEEP
;
1599 error
= security_file_lock(filp
, cmd
);
1603 if (filp
->f_op
&& filp
->f_op
->flock
)
1604 error
= filp
->f_op
->flock(filp
,
1605 (can_sleep
) ? F_SETLKW
: F_SETLK
,
1608 error
= flock_lock_file_wait(filp
, lock
);
1611 locks_free_lock(lock
);
1620 * vfs_test_lock - test file byte range lock
1621 * @filp: The file to test lock for
1622 * @fl: The lock to test; also used to hold result
1624 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1625 * setting conf->fl_type to something other than F_UNLCK.
1627 int vfs_test_lock(struct file
*filp
, struct file_lock
*fl
)
1629 if (filp
->f_op
&& filp
->f_op
->lock
)
1630 return filp
->f_op
->lock(filp
, F_GETLK
, fl
);
1631 posix_test_lock(filp
, fl
);
1634 EXPORT_SYMBOL_GPL(vfs_test_lock
);
1636 static int posix_lock_to_flock(struct flock
*flock
, struct file_lock
*fl
)
1638 flock
->l_pid
= fl
->fl_pid
;
1639 #if BITS_PER_LONG == 32
1641 * Make sure we can represent the posix lock via
1642 * legacy 32bit flock.
1644 if (fl
->fl_start
> OFFT_OFFSET_MAX
)
1646 if (fl
->fl_end
!= OFFSET_MAX
&& fl
->fl_end
> OFFT_OFFSET_MAX
)
1649 flock
->l_start
= fl
->fl_start
;
1650 flock
->l_len
= fl
->fl_end
== OFFSET_MAX
? 0 :
1651 fl
->fl_end
- fl
->fl_start
+ 1;
1652 flock
->l_whence
= 0;
1653 flock
->l_type
= fl
->fl_type
;
1657 #if BITS_PER_LONG == 32
1658 static void posix_lock_to_flock64(struct flock64
*flock
, struct file_lock
*fl
)
1660 flock
->l_pid
= fl
->fl_pid
;
1661 flock
->l_start
= fl
->fl_start
;
1662 flock
->l_len
= fl
->fl_end
== OFFSET_MAX
? 0 :
1663 fl
->fl_end
- fl
->fl_start
+ 1;
1664 flock
->l_whence
= 0;
1665 flock
->l_type
= fl
->fl_type
;
1669 /* Report the first existing lock that would conflict with l.
1670 * This implements the F_GETLK command of fcntl().
1672 int fcntl_getlk(struct file
*filp
, struct flock __user
*l
)
1674 struct file_lock file_lock
;
1679 if (copy_from_user(&flock
, l
, sizeof(flock
)))
1682 if ((flock
.l_type
!= F_RDLCK
) && (flock
.l_type
!= F_WRLCK
))
1685 error
= flock_to_posix_lock(filp
, &file_lock
, &flock
);
1689 error
= vfs_test_lock(filp
, &file_lock
);
1693 flock
.l_type
= file_lock
.fl_type
;
1694 if (file_lock
.fl_type
!= F_UNLCK
) {
1695 error
= posix_lock_to_flock(&flock
, &file_lock
);
1700 if (!copy_to_user(l
, &flock
, sizeof(flock
)))
1707 * vfs_lock_file - file byte range lock
1708 * @filp: The file to apply the lock to
1709 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
1710 * @fl: The lock to be applied
1711 * @conf: Place to return a copy of the conflicting lock, if found.
1713 * A caller that doesn't care about the conflicting lock may pass NULL
1714 * as the final argument.
1716 * If the filesystem defines a private ->lock() method, then @conf will
1717 * be left unchanged; so a caller that cares should initialize it to
1718 * some acceptable default.
1720 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
1721 * locks, the ->lock() interface may return asynchronously, before the lock has
1722 * been granted or denied by the underlying filesystem, if (and only if)
1723 * fl_grant is set. Callers expecting ->lock() to return asynchronously
1724 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
1725 * the request is for a blocking lock. When ->lock() does return asynchronously,
1726 * it must return -EINPROGRESS, and call ->fl_grant() when the lock
1727 * request completes.
1728 * If the request is for non-blocking lock the file system should return
1729 * -EINPROGRESS then try to get the lock and call the callback routine with
1730 * the result. If the request timed out the callback routine will return a
1731 * nonzero return code and the file system should release the lock. The file
1732 * system is also responsible to keep a corresponding posix lock when it
1733 * grants a lock so the VFS can find out which locks are locally held and do
1734 * the correct lock cleanup when required.
1735 * The underlying filesystem must not drop the kernel lock or call
1736 * ->fl_grant() before returning to the caller with a -EINPROGRESS
1739 int vfs_lock_file(struct file
*filp
, unsigned int cmd
, struct file_lock
*fl
, struct file_lock
*conf
)
1741 if (filp
->f_op
&& filp
->f_op
->lock
)
1742 return filp
->f_op
->lock(filp
, cmd
, fl
);
1744 return posix_lock_file(filp
, fl
, conf
);
1746 EXPORT_SYMBOL_GPL(vfs_lock_file
);
1748 /* Apply the lock described by l to an open file descriptor.
1749 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1751 int fcntl_setlk(unsigned int fd
, struct file
*filp
, unsigned int cmd
,
1752 struct flock __user
*l
)
1754 struct file_lock
*file_lock
= locks_alloc_lock();
1756 struct inode
*inode
;
1759 if (file_lock
== NULL
)
1763 * This might block, so we do it before checking the inode.
1766 if (copy_from_user(&flock
, l
, sizeof(flock
)))
1769 inode
= filp
->f_path
.dentry
->d_inode
;
1771 /* Don't allow mandatory locks on files that may be memory mapped
1774 if (mandatory_lock(inode
) && mapping_writably_mapped(filp
->f_mapping
)) {
1780 error
= flock_to_posix_lock(filp
, file_lock
, &flock
);
1783 if (cmd
== F_SETLKW
) {
1784 file_lock
->fl_flags
|= FL_SLEEP
;
1788 switch (flock
.l_type
) {
1790 if (!(filp
->f_mode
& FMODE_READ
))
1794 if (!(filp
->f_mode
& FMODE_WRITE
))
1804 error
= security_file_lock(filp
, file_lock
->fl_type
);
1809 error
= vfs_lock_file(filp
, cmd
, file_lock
, NULL
);
1810 if (error
!= -EAGAIN
|| cmd
== F_SETLK
)
1812 error
= wait_event_interruptible(file_lock
->fl_wait
,
1813 !file_lock
->fl_next
);
1817 locks_delete_block(file_lock
);
1822 * Attempt to detect a close/fcntl race and recover by
1823 * releasing the lock that was just acquired.
1825 if (!error
&& fcheck(fd
) != filp
&& flock
.l_type
!= F_UNLCK
) {
1826 flock
.l_type
= F_UNLCK
;
1831 locks_free_lock(file_lock
);
1835 #if BITS_PER_LONG == 32
1836 /* Report the first existing lock that would conflict with l.
1837 * This implements the F_GETLK command of fcntl().
1839 int fcntl_getlk64(struct file
*filp
, struct flock64 __user
*l
)
1841 struct file_lock file_lock
;
1842 struct flock64 flock
;
1846 if (copy_from_user(&flock
, l
, sizeof(flock
)))
1849 if ((flock
.l_type
!= F_RDLCK
) && (flock
.l_type
!= F_WRLCK
))
1852 error
= flock64_to_posix_lock(filp
, &file_lock
, &flock
);
1856 error
= vfs_test_lock(filp
, &file_lock
);
1860 flock
.l_type
= file_lock
.fl_type
;
1861 if (file_lock
.fl_type
!= F_UNLCK
)
1862 posix_lock_to_flock64(&flock
, &file_lock
);
1865 if (!copy_to_user(l
, &flock
, sizeof(flock
)))
1872 /* Apply the lock described by l to an open file descriptor.
1873 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1875 int fcntl_setlk64(unsigned int fd
, struct file
*filp
, unsigned int cmd
,
1876 struct flock64 __user
*l
)
1878 struct file_lock
*file_lock
= locks_alloc_lock();
1879 struct flock64 flock
;
1880 struct inode
*inode
;
1883 if (file_lock
== NULL
)
1887 * This might block, so we do it before checking the inode.
1890 if (copy_from_user(&flock
, l
, sizeof(flock
)))
1893 inode
= filp
->f_path
.dentry
->d_inode
;
1895 /* Don't allow mandatory locks on files that may be memory mapped
1898 if (mandatory_lock(inode
) && mapping_writably_mapped(filp
->f_mapping
)) {
1904 error
= flock64_to_posix_lock(filp
, file_lock
, &flock
);
1907 if (cmd
== F_SETLKW64
) {
1908 file_lock
->fl_flags
|= FL_SLEEP
;
1912 switch (flock
.l_type
) {
1914 if (!(filp
->f_mode
& FMODE_READ
))
1918 if (!(filp
->f_mode
& FMODE_WRITE
))
1928 error
= security_file_lock(filp
, file_lock
->fl_type
);
1933 error
= vfs_lock_file(filp
, cmd
, file_lock
, NULL
);
1934 if (error
!= -EAGAIN
|| cmd
== F_SETLK64
)
1936 error
= wait_event_interruptible(file_lock
->fl_wait
,
1937 !file_lock
->fl_next
);
1941 locks_delete_block(file_lock
);
1946 * Attempt to detect a close/fcntl race and recover by
1947 * releasing the lock that was just acquired.
1949 if (!error
&& fcheck(fd
) != filp
&& flock
.l_type
!= F_UNLCK
) {
1950 flock
.l_type
= F_UNLCK
;
1955 locks_free_lock(file_lock
);
1958 #endif /* BITS_PER_LONG == 32 */
1961 * This function is called when the file is being removed
1962 * from the task's fd array. POSIX locks belonging to this task
1963 * are deleted at this time.
1965 void locks_remove_posix(struct file
*filp
, fl_owner_t owner
)
1967 struct file_lock lock
;
1970 * If there are no locks held on this file, we don't need to call
1971 * posix_lock_file(). Another process could be setting a lock on this
1972 * file at the same time, but we wouldn't remove that lock anyway.
1974 if (!filp
->f_path
.dentry
->d_inode
->i_flock
)
1977 lock
.fl_type
= F_UNLCK
;
1978 lock
.fl_flags
= FL_POSIX
| FL_CLOSE
;
1980 lock
.fl_end
= OFFSET_MAX
;
1981 lock
.fl_owner
= owner
;
1982 lock
.fl_pid
= current
->tgid
;
1983 lock
.fl_file
= filp
;
1985 lock
.fl_lmops
= NULL
;
1987 vfs_lock_file(filp
, F_SETLK
, &lock
, NULL
);
1989 if (lock
.fl_ops
&& lock
.fl_ops
->fl_release_private
)
1990 lock
.fl_ops
->fl_release_private(&lock
);
1993 EXPORT_SYMBOL(locks_remove_posix
);
1996 * This function is called on the last close of an open file.
1998 void locks_remove_flock(struct file
*filp
)
2000 struct inode
* inode
= filp
->f_path
.dentry
->d_inode
;
2001 struct file_lock
*fl
;
2002 struct file_lock
**before
;
2004 if (!inode
->i_flock
)
2007 if (filp
->f_op
&& filp
->f_op
->flock
) {
2008 struct file_lock fl
= {
2009 .fl_pid
= current
->tgid
,
2011 .fl_flags
= FL_FLOCK
,
2013 .fl_end
= OFFSET_MAX
,
2015 filp
->f_op
->flock(filp
, F_SETLKW
, &fl
);
2016 if (fl
.fl_ops
&& fl
.fl_ops
->fl_release_private
)
2017 fl
.fl_ops
->fl_release_private(&fl
);
2021 before
= &inode
->i_flock
;
2023 while ((fl
= *before
) != NULL
) {
2024 if (fl
->fl_file
== filp
) {
2026 locks_delete_lock(before
);
2030 lease_modify(before
, F_UNLCK
);
2036 before
= &fl
->fl_next
;
2042 * posix_unblock_lock - stop waiting for a file lock
2043 * @filp: how the file was opened
2044 * @waiter: the lock which was waiting
2046 * lockd needs to block waiting for locks.
2049 posix_unblock_lock(struct file
*filp
, struct file_lock
*waiter
)
2054 if (waiter
->fl_next
)
2055 __locks_delete_block(waiter
);
2062 EXPORT_SYMBOL(posix_unblock_lock
);
2065 * vfs_cancel_lock - file byte range unblock lock
2066 * @filp: The file to apply the unblock to
2067 * @fl: The lock to be unblocked
2069 * Used by lock managers to cancel blocked requests
2071 int vfs_cancel_lock(struct file
*filp
, struct file_lock
*fl
)
2073 if (filp
->f_op
&& filp
->f_op
->lock
)
2074 return filp
->f_op
->lock(filp
, F_CANCELLK
, fl
);
2078 EXPORT_SYMBOL_GPL(vfs_cancel_lock
);
2080 #ifdef CONFIG_PROC_FS
2081 #include <linux/seq_file.h>
2083 static void lock_get_status(struct seq_file
*f
, struct file_lock
*fl
,
2086 struct inode
*inode
= NULL
;
2088 if (fl
->fl_file
!= NULL
)
2089 inode
= fl
->fl_file
->f_path
.dentry
->d_inode
;
2091 seq_printf(f
, "%d:%s ", id
, pfx
);
2093 seq_printf(f
, "%6s %s ",
2094 (fl
->fl_flags
& FL_ACCESS
) ? "ACCESS" : "POSIX ",
2095 (inode
== NULL
) ? "*NOINODE*" :
2096 mandatory_lock(inode
) ? "MANDATORY" : "ADVISORY ");
2097 } else if (IS_FLOCK(fl
)) {
2098 if (fl
->fl_type
& LOCK_MAND
) {
2099 seq_printf(f
, "FLOCK MSNFS ");
2101 seq_printf(f
, "FLOCK ADVISORY ");
2103 } else if (IS_LEASE(fl
)) {
2104 seq_printf(f
, "LEASE ");
2105 if (fl
->fl_type
& F_INPROGRESS
)
2106 seq_printf(f
, "BREAKING ");
2107 else if (fl
->fl_file
)
2108 seq_printf(f
, "ACTIVE ");
2110 seq_printf(f
, "BREAKER ");
2112 seq_printf(f
, "UNKNOWN UNKNOWN ");
2114 if (fl
->fl_type
& LOCK_MAND
) {
2115 seq_printf(f
, "%s ",
2116 (fl
->fl_type
& LOCK_READ
)
2117 ? (fl
->fl_type
& LOCK_WRITE
) ? "RW " : "READ "
2118 : (fl
->fl_type
& LOCK_WRITE
) ? "WRITE" : "NONE ");
2120 seq_printf(f
, "%s ",
2121 (fl
->fl_type
& F_INPROGRESS
)
2122 ? (fl
->fl_type
& F_UNLCK
) ? "UNLCK" : "READ "
2123 : (fl
->fl_type
& F_WRLCK
) ? "WRITE" : "READ ");
2126 #ifdef WE_CAN_BREAK_LSLK_NOW
2127 seq_printf(f
, "%d %s:%ld ", fl
->fl_pid
,
2128 inode
->i_sb
->s_id
, inode
->i_ino
);
2130 /* userspace relies on this representation of dev_t ;-( */
2131 seq_printf(f
, "%d %02x:%02x:%ld ", fl
->fl_pid
,
2132 MAJOR(inode
->i_sb
->s_dev
),
2133 MINOR(inode
->i_sb
->s_dev
), inode
->i_ino
);
2136 seq_printf(f
, "%d <none>:0 ", fl
->fl_pid
);
2139 if (fl
->fl_end
== OFFSET_MAX
)
2140 seq_printf(f
, "%Ld EOF\n", fl
->fl_start
);
2142 seq_printf(f
, "%Ld %Ld\n", fl
->fl_start
, fl
->fl_end
);
2144 seq_printf(f
, "0 EOF\n");
2148 static int locks_show(struct seq_file
*f
, void *v
)
2150 struct file_lock
*fl
, *bfl
;
2152 fl
= list_entry(v
, struct file_lock
, fl_link
);
2154 lock_get_status(f
, fl
, (long)f
->private, "");
2156 list_for_each_entry(bfl
, &fl
->fl_block
, fl_block
)
2157 lock_get_status(f
, bfl
, (long)f
->private, " ->");
2163 static void *locks_start(struct seq_file
*f
, loff_t
*pos
)
2166 f
->private = (void *)1;
2167 return seq_list_start(&file_lock_list
, *pos
);
2170 static void *locks_next(struct seq_file
*f
, void *v
, loff_t
*pos
)
2172 return seq_list_next(v
, &file_lock_list
, pos
);
2175 static void locks_stop(struct seq_file
*f
, void *v
)
2180 struct seq_operations locks_seq_operations
= {
2181 .start
= locks_start
,
2189 * lock_may_read - checks that the region is free of locks
2190 * @inode: the inode that is being read
2191 * @start: the first byte to read
2192 * @len: the number of bytes to read
2194 * Emulates Windows locking requirements. Whole-file
2195 * mandatory locks (share modes) can prohibit a read and
2196 * byte-range POSIX locks can prohibit a read if they overlap.
2198 * N.B. this function is only ever called
2199 * from knfsd and ownership of locks is never checked.
2201 int lock_may_read(struct inode
*inode
, loff_t start
, unsigned long len
)
2203 struct file_lock
*fl
;
2206 for (fl
= inode
->i_flock
; fl
!= NULL
; fl
= fl
->fl_next
) {
2208 if (fl
->fl_type
== F_RDLCK
)
2210 if ((fl
->fl_end
< start
) || (fl
->fl_start
> (start
+ len
)))
2212 } else if (IS_FLOCK(fl
)) {
2213 if (!(fl
->fl_type
& LOCK_MAND
))
2215 if (fl
->fl_type
& LOCK_READ
)
2226 EXPORT_SYMBOL(lock_may_read
);
2229 * lock_may_write - checks that the region is free of locks
2230 * @inode: the inode that is being written
2231 * @start: the first byte to write
2232 * @len: the number of bytes to write
2234 * Emulates Windows locking requirements. Whole-file
2235 * mandatory locks (share modes) can prohibit a write and
2236 * byte-range POSIX locks can prohibit a write if they overlap.
2238 * N.B. this function is only ever called
2239 * from knfsd and ownership of locks is never checked.
2241 int lock_may_write(struct inode
*inode
, loff_t start
, unsigned long len
)
2243 struct file_lock
*fl
;
2246 for (fl
= inode
->i_flock
; fl
!= NULL
; fl
= fl
->fl_next
) {
2248 if ((fl
->fl_end
< start
) || (fl
->fl_start
> (start
+ len
)))
2250 } else if (IS_FLOCK(fl
)) {
2251 if (!(fl
->fl_type
& LOCK_MAND
))
2253 if (fl
->fl_type
& LOCK_WRITE
)
2264 EXPORT_SYMBOL(lock_may_write
);
2266 static int __init
filelock_init(void)
2268 filelock_cache
= kmem_cache_create("file_lock_cache",
2269 sizeof(struct file_lock
), 0, SLAB_PANIC
,
2274 core_initcall(filelock_init
);