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>
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
);
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
;
192 fl
->fl_start
= fl
->fl_end
= 0;
197 EXPORT_SYMBOL(locks_init_lock
);
200 * Initialises the fields of the file lock which are invariant for
203 static void init_once(struct kmem_cache
*cache
, void *foo
)
205 struct file_lock
*lock
= (struct file_lock
*) foo
;
207 locks_init_lock(lock
);
210 static void locks_copy_private(struct file_lock
*new, struct file_lock
*fl
)
213 if (fl
->fl_ops
->fl_copy_lock
)
214 fl
->fl_ops
->fl_copy_lock(new, fl
);
215 new->fl_ops
= fl
->fl_ops
;
218 if (fl
->fl_lmops
->fl_copy_lock
)
219 fl
->fl_lmops
->fl_copy_lock(new, fl
);
220 new->fl_lmops
= fl
->fl_lmops
;
225 * Initialize a new lock from an existing file_lock structure.
227 void __locks_copy_lock(struct file_lock
*new, const struct file_lock
*fl
)
229 new->fl_owner
= fl
->fl_owner
;
230 new->fl_pid
= fl
->fl_pid
;
232 new->fl_flags
= fl
->fl_flags
;
233 new->fl_type
= fl
->fl_type
;
234 new->fl_start
= fl
->fl_start
;
235 new->fl_end
= fl
->fl_end
;
237 new->fl_lmops
= NULL
;
239 EXPORT_SYMBOL(__locks_copy_lock
);
241 void locks_copy_lock(struct file_lock
*new, struct file_lock
*fl
)
243 locks_release_private(new);
245 __locks_copy_lock(new, fl
);
246 new->fl_file
= fl
->fl_file
;
247 new->fl_ops
= fl
->fl_ops
;
248 new->fl_lmops
= fl
->fl_lmops
;
250 locks_copy_private(new, fl
);
253 EXPORT_SYMBOL(locks_copy_lock
);
255 static inline int flock_translate_cmd(int cmd
) {
257 return cmd
& (LOCK_MAND
| LOCK_RW
);
269 /* Fill in a file_lock structure with an appropriate FLOCK lock. */
270 static int flock_make_lock(struct file
*filp
, struct file_lock
**lock
,
273 struct file_lock
*fl
;
274 int type
= flock_translate_cmd(cmd
);
278 fl
= locks_alloc_lock();
283 fl
->fl_pid
= current
->tgid
;
284 fl
->fl_flags
= FL_FLOCK
;
286 fl
->fl_end
= OFFSET_MAX
;
292 static int assign_type(struct file_lock
*fl
, int type
)
306 /* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
309 static int flock_to_posix_lock(struct file
*filp
, struct file_lock
*fl
,
314 switch (l
->l_whence
) {
322 start
= i_size_read(filp
->f_path
.dentry
->d_inode
);
328 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
329 POSIX-2001 defines it. */
333 fl
->fl_end
= OFFSET_MAX
;
335 end
= start
+ l
->l_len
- 1;
337 } else if (l
->l_len
< 0) {
344 fl
->fl_start
= start
; /* we record the absolute position */
345 if (fl
->fl_end
< fl
->fl_start
)
348 fl
->fl_owner
= current
->files
;
349 fl
->fl_pid
= current
->tgid
;
351 fl
->fl_flags
= FL_POSIX
;
355 return assign_type(fl
, l
->l_type
);
358 #if BITS_PER_LONG == 32
359 static int flock64_to_posix_lock(struct file
*filp
, struct file_lock
*fl
,
364 switch (l
->l_whence
) {
372 start
= i_size_read(filp
->f_path
.dentry
->d_inode
);
381 fl
->fl_end
= OFFSET_MAX
;
383 fl
->fl_end
= start
+ l
->l_len
- 1;
384 } else if (l
->l_len
< 0) {
385 fl
->fl_end
= start
- 1;
390 fl
->fl_start
= start
; /* we record the absolute position */
391 if (fl
->fl_end
< fl
->fl_start
)
394 fl
->fl_owner
= current
->files
;
395 fl
->fl_pid
= current
->tgid
;
397 fl
->fl_flags
= FL_POSIX
;
405 fl
->fl_type
= l
->l_type
;
415 /* default lease lock manager operations */
416 static void lease_break_callback(struct file_lock
*fl
)
418 kill_fasync(&fl
->fl_fasync
, SIGIO
, POLL_MSG
);
421 static void lease_release_private_callback(struct file_lock
*fl
)
426 f_delown(fl
->fl_file
);
427 fl
->fl_file
->f_owner
.signum
= 0;
430 static int lease_mylease_callback(struct file_lock
*fl
, struct file_lock
*try)
432 return fl
->fl_file
== try->fl_file
;
435 static struct lock_manager_operations lease_manager_ops
= {
436 .fl_break
= lease_break_callback
,
437 .fl_release_private
= lease_release_private_callback
,
438 .fl_mylease
= lease_mylease_callback
,
439 .fl_change
= lease_modify
,
443 * Initialize a lease, use the default lock manager operations
445 static int lease_init(struct file
*filp
, int type
, struct file_lock
*fl
)
447 if (assign_type(fl
, type
) != 0)
450 fl
->fl_owner
= current
->files
;
451 fl
->fl_pid
= current
->tgid
;
454 fl
->fl_flags
= FL_LEASE
;
456 fl
->fl_end
= OFFSET_MAX
;
458 fl
->fl_lmops
= &lease_manager_ops
;
462 /* Allocate a file_lock initialised to this type of lease */
463 static struct file_lock
*lease_alloc(struct file
*filp
, int type
)
465 struct file_lock
*fl
= locks_alloc_lock();
469 return ERR_PTR(error
);
471 error
= lease_init(filp
, type
, fl
);
474 return ERR_PTR(error
);
479 /* Check if two locks overlap each other.
481 static inline int locks_overlap(struct file_lock
*fl1
, struct file_lock
*fl2
)
483 return ((fl1
->fl_end
>= fl2
->fl_start
) &&
484 (fl2
->fl_end
>= fl1
->fl_start
));
488 * Check whether two locks have the same owner.
490 static int posix_same_owner(struct file_lock
*fl1
, struct file_lock
*fl2
)
492 if (fl1
->fl_lmops
&& fl1
->fl_lmops
->fl_compare_owner
)
493 return fl2
->fl_lmops
== fl1
->fl_lmops
&&
494 fl1
->fl_lmops
->fl_compare_owner(fl1
, fl2
);
495 return fl1
->fl_owner
== fl2
->fl_owner
;
498 /* Remove waiter from blocker's block list.
499 * When blocker ends up pointing to itself then the list is empty.
501 static void __locks_delete_block(struct file_lock
*waiter
)
503 list_del_init(&waiter
->fl_block
);
504 list_del_init(&waiter
->fl_link
);
505 waiter
->fl_next
= NULL
;
510 static void locks_delete_block(struct file_lock
*waiter
)
513 __locks_delete_block(waiter
);
517 /* Insert waiter into blocker's block list.
518 * We use a circular list so that processes can be easily woken up in
519 * the order they blocked. The documentation doesn't require this but
520 * it seems like the reasonable thing to do.
522 static void locks_insert_block(struct file_lock
*blocker
,
523 struct file_lock
*waiter
)
525 BUG_ON(!list_empty(&waiter
->fl_block
));
526 list_add_tail(&waiter
->fl_block
, &blocker
->fl_block
);
527 waiter
->fl_next
= blocker
;
528 if (IS_POSIX(blocker
))
529 list_add(&waiter
->fl_link
, &blocked_list
);
532 /* Wake up processes blocked waiting for blocker.
533 * If told to wait then schedule the processes until the block list
534 * is empty, otherwise empty the block list ourselves.
536 static void locks_wake_up_blocks(struct file_lock
*blocker
)
538 while (!list_empty(&blocker
->fl_block
)) {
539 struct file_lock
*waiter
;
541 waiter
= list_first_entry(&blocker
->fl_block
,
542 struct file_lock
, fl_block
);
543 __locks_delete_block(waiter
);
544 if (waiter
->fl_lmops
&& waiter
->fl_lmops
->fl_notify
)
545 waiter
->fl_lmops
->fl_notify(waiter
);
547 wake_up(&waiter
->fl_wait
);
551 /* Insert file lock fl into an inode's lock list at the position indicated
552 * by pos. At the same time add the lock to the global file lock list.
554 static void locks_insert_lock(struct file_lock
**pos
, struct file_lock
*fl
)
556 list_add(&fl
->fl_link
, &file_lock_list
);
558 fl
->fl_nspid
= get_pid(task_tgid(current
));
560 /* insert into file's list */
564 if (fl
->fl_ops
&& fl
->fl_ops
->fl_insert
)
565 fl
->fl_ops
->fl_insert(fl
);
569 * Delete a lock and then free it.
570 * Wake up processes that are blocked waiting for this lock,
571 * notify the FS that the lock has been cleared and
572 * finally free the lock.
574 static void locks_delete_lock(struct file_lock
**thisfl_p
)
576 struct file_lock
*fl
= *thisfl_p
;
578 *thisfl_p
= fl
->fl_next
;
580 list_del_init(&fl
->fl_link
);
582 fasync_helper(0, fl
->fl_file
, 0, &fl
->fl_fasync
);
583 if (fl
->fl_fasync
!= NULL
) {
584 printk(KERN_ERR
"locks_delete_lock: fasync == %p\n", fl
->fl_fasync
);
585 fl
->fl_fasync
= NULL
;
588 if (fl
->fl_ops
&& fl
->fl_ops
->fl_remove
)
589 fl
->fl_ops
->fl_remove(fl
);
592 put_pid(fl
->fl_nspid
);
596 locks_wake_up_blocks(fl
);
600 /* Determine if lock sys_fl blocks lock caller_fl. Common functionality
601 * checks for shared/exclusive status of overlapping locks.
603 static int locks_conflict(struct file_lock
*caller_fl
, struct file_lock
*sys_fl
)
605 if (sys_fl
->fl_type
== F_WRLCK
)
607 if (caller_fl
->fl_type
== F_WRLCK
)
612 /* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
613 * checking before calling the locks_conflict().
615 static int posix_locks_conflict(struct file_lock
*caller_fl
, struct file_lock
*sys_fl
)
617 /* POSIX locks owned by the same process do not conflict with
620 if (!IS_POSIX(sys_fl
) || posix_same_owner(caller_fl
, sys_fl
))
623 /* Check whether they overlap */
624 if (!locks_overlap(caller_fl
, sys_fl
))
627 return (locks_conflict(caller_fl
, sys_fl
));
630 /* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
631 * checking before calling the locks_conflict().
633 static int flock_locks_conflict(struct file_lock
*caller_fl
, struct file_lock
*sys_fl
)
635 /* FLOCK locks referring to the same filp do not conflict with
638 if (!IS_FLOCK(sys_fl
) || (caller_fl
->fl_file
== sys_fl
->fl_file
))
640 if ((caller_fl
->fl_type
& LOCK_MAND
) || (sys_fl
->fl_type
& LOCK_MAND
))
643 return (locks_conflict(caller_fl
, sys_fl
));
647 posix_test_lock(struct file
*filp
, struct file_lock
*fl
)
649 struct file_lock
*cfl
;
652 for (cfl
= filp
->f_path
.dentry
->d_inode
->i_flock
; cfl
; cfl
= cfl
->fl_next
) {
655 if (posix_locks_conflict(fl
, cfl
))
659 __locks_copy_lock(fl
, cfl
);
661 fl
->fl_pid
= pid_vnr(cfl
->fl_nspid
);
663 fl
->fl_type
= F_UNLCK
;
667 EXPORT_SYMBOL(posix_test_lock
);
670 * Deadlock detection:
672 * We attempt to detect deadlocks that are due purely to posix file
675 * We assume that a task can be waiting for at most one lock at a time.
676 * So for any acquired lock, the process holding that lock may be
677 * waiting on at most one other lock. That lock in turns may be held by
678 * someone waiting for at most one other lock. Given a requested lock
679 * caller_fl which is about to wait for a conflicting lock block_fl, we
680 * follow this chain of waiters to ensure we are not about to create a
683 * Since we do this before we ever put a process to sleep on a lock, we
684 * are ensured that there is never a cycle; that is what guarantees that
685 * the while() loop in posix_locks_deadlock() eventually completes.
687 * Note: the above assumption may not be true when handling lock
688 * requests from a broken NFS client. It may also fail in the presence
689 * of tasks (such as posix threads) sharing the same open file table.
691 * To handle those cases, we just bail out after a few iterations.
694 #define MAX_DEADLK_ITERATIONS 10
696 /* Find a lock that the owner of the given block_fl is blocking on. */
697 static struct file_lock
*what_owner_is_waiting_for(struct file_lock
*block_fl
)
699 struct file_lock
*fl
;
701 list_for_each_entry(fl
, &blocked_list
, fl_link
) {
702 if (posix_same_owner(fl
, block_fl
))
708 static int posix_locks_deadlock(struct file_lock
*caller_fl
,
709 struct file_lock
*block_fl
)
713 while ((block_fl
= what_owner_is_waiting_for(block_fl
))) {
714 if (i
++ > MAX_DEADLK_ITERATIONS
)
716 if (posix_same_owner(caller_fl
, block_fl
))
722 /* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
723 * after any leases, but before any posix locks.
725 * Note that if called with an FL_EXISTS argument, the caller may determine
726 * whether or not a lock was successfully freed by testing the return
729 static int flock_lock_file(struct file
*filp
, struct file_lock
*request
)
731 struct file_lock
*new_fl
= NULL
;
732 struct file_lock
**before
;
733 struct inode
* inode
= filp
->f_path
.dentry
->d_inode
;
738 if (request
->fl_flags
& FL_ACCESS
)
741 if (request
->fl_type
!= F_UNLCK
) {
743 new_fl
= locks_alloc_lock();
749 for_each_lock(inode
, before
) {
750 struct file_lock
*fl
= *before
;
755 if (filp
!= fl
->fl_file
)
757 if (request
->fl_type
== fl
->fl_type
)
760 locks_delete_lock(before
);
764 if (request
->fl_type
== F_UNLCK
) {
765 if ((request
->fl_flags
& FL_EXISTS
) && !found
)
771 * If a higher-priority process was blocked on the old file lock,
772 * give it the opportunity to lock the file.
778 for_each_lock(inode
, before
) {
779 struct file_lock
*fl
= *before
;
784 if (!flock_locks_conflict(request
, fl
))
787 if (request
->fl_flags
& FL_SLEEP
)
788 locks_insert_block(fl
, request
);
791 if (request
->fl_flags
& FL_ACCESS
)
793 locks_copy_lock(new_fl
, request
);
794 locks_insert_lock(before
, new_fl
);
801 locks_free_lock(new_fl
);
805 static int __posix_lock_file(struct inode
*inode
, struct file_lock
*request
, struct file_lock
*conflock
)
807 struct file_lock
*fl
;
808 struct file_lock
*new_fl
= NULL
;
809 struct file_lock
*new_fl2
= NULL
;
810 struct file_lock
*left
= NULL
;
811 struct file_lock
*right
= NULL
;
812 struct file_lock
**before
;
813 int error
, added
= 0;
816 * We may need two file_lock structures for this operation,
817 * so we get them in advance to avoid races.
819 * In some cases we can be sure, that no new locks will be needed
821 if (!(request
->fl_flags
& FL_ACCESS
) &&
822 (request
->fl_type
!= F_UNLCK
||
823 request
->fl_start
!= 0 || request
->fl_end
!= OFFSET_MAX
)) {
824 new_fl
= locks_alloc_lock();
825 new_fl2
= locks_alloc_lock();
829 if (request
->fl_type
!= F_UNLCK
) {
830 for_each_lock(inode
, before
) {
834 if (!posix_locks_conflict(request
, fl
))
837 __locks_copy_lock(conflock
, fl
);
839 if (!(request
->fl_flags
& FL_SLEEP
))
842 if (posix_locks_deadlock(request
, fl
))
845 locks_insert_block(fl
, request
);
850 /* If we're just looking for a conflict, we're done. */
852 if (request
->fl_flags
& FL_ACCESS
)
856 * Find the first old lock with the same owner as the new lock.
859 before
= &inode
->i_flock
;
861 /* First skip locks owned by other processes. */
862 while ((fl
= *before
) && (!IS_POSIX(fl
) ||
863 !posix_same_owner(request
, fl
))) {
864 before
= &fl
->fl_next
;
867 /* Process locks with this owner. */
868 while ((fl
= *before
) && posix_same_owner(request
, fl
)) {
869 /* Detect adjacent or overlapping regions (if same lock type)
871 if (request
->fl_type
== fl
->fl_type
) {
872 /* In all comparisons of start vs end, use
873 * "start - 1" rather than "end + 1". If end
874 * is OFFSET_MAX, end + 1 will become negative.
876 if (fl
->fl_end
< request
->fl_start
- 1)
878 /* If the next lock in the list has entirely bigger
879 * addresses than the new one, insert the lock here.
881 if (fl
->fl_start
- 1 > request
->fl_end
)
884 /* If we come here, the new and old lock are of the
885 * same type and adjacent or overlapping. Make one
886 * lock yielding from the lower start address of both
887 * locks to the higher end address.
889 if (fl
->fl_start
> request
->fl_start
)
890 fl
->fl_start
= request
->fl_start
;
892 request
->fl_start
= fl
->fl_start
;
893 if (fl
->fl_end
< request
->fl_end
)
894 fl
->fl_end
= request
->fl_end
;
896 request
->fl_end
= fl
->fl_end
;
898 locks_delete_lock(before
);
905 /* Processing for different lock types is a bit
908 if (fl
->fl_end
< request
->fl_start
)
910 if (fl
->fl_start
> request
->fl_end
)
912 if (request
->fl_type
== F_UNLCK
)
914 if (fl
->fl_start
< request
->fl_start
)
916 /* If the next lock in the list has a higher end
917 * address than the new one, insert the new one here.
919 if (fl
->fl_end
> request
->fl_end
) {
923 if (fl
->fl_start
>= request
->fl_start
) {
924 /* The new lock completely replaces an old
925 * one (This may happen several times).
928 locks_delete_lock(before
);
931 /* Replace the old lock with the new one.
932 * Wake up anybody waiting for the old one,
933 * as the change in lock type might satisfy
936 locks_wake_up_blocks(fl
);
937 fl
->fl_start
= request
->fl_start
;
938 fl
->fl_end
= request
->fl_end
;
939 fl
->fl_type
= request
->fl_type
;
940 locks_release_private(fl
);
941 locks_copy_private(fl
, request
);
946 /* Go on to next lock.
949 before
= &fl
->fl_next
;
953 * The above code only modifies existing locks in case of
954 * merging or replacing. If new lock(s) need to be inserted
955 * all modifications are done bellow this, so it's safe yet to
958 error
= -ENOLCK
; /* "no luck" */
959 if (right
&& left
== right
&& !new_fl2
)
964 if (request
->fl_type
== F_UNLCK
) {
965 if (request
->fl_flags
& FL_EXISTS
)
974 locks_copy_lock(new_fl
, request
);
975 locks_insert_lock(before
, new_fl
);
980 /* The new lock breaks the old one in two pieces,
981 * so we have to use the second new lock.
985 locks_copy_lock(left
, right
);
986 locks_insert_lock(before
, left
);
988 right
->fl_start
= request
->fl_end
+ 1;
989 locks_wake_up_blocks(right
);
992 left
->fl_end
= request
->fl_start
- 1;
993 locks_wake_up_blocks(left
);
998 * Free any unused locks.
1001 locks_free_lock(new_fl
);
1003 locks_free_lock(new_fl2
);
1008 * posix_lock_file - Apply a POSIX-style lock to a file
1009 * @filp: The file to apply the lock to
1010 * @fl: The lock to be applied
1011 * @conflock: Place to return a copy of the conflicting lock, if found.
1013 * Add a POSIX style lock to a file.
1014 * We merge adjacent & overlapping locks whenever possible.
1015 * POSIX locks are sorted by owner task, then by starting address
1017 * Note that if called with an FL_EXISTS argument, the caller may determine
1018 * whether or not a lock was successfully freed by testing the return
1019 * value for -ENOENT.
1021 int posix_lock_file(struct file
*filp
, struct file_lock
*fl
,
1022 struct file_lock
*conflock
)
1024 return __posix_lock_file(filp
->f_path
.dentry
->d_inode
, fl
, conflock
);
1026 EXPORT_SYMBOL(posix_lock_file
);
1029 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1030 * @filp: The file to apply the lock to
1031 * @fl: The lock to be applied
1033 * Add a POSIX style lock to a file.
1034 * We merge adjacent & overlapping locks whenever possible.
1035 * POSIX locks are sorted by owner task, then by starting address
1037 int posix_lock_file_wait(struct file
*filp
, struct file_lock
*fl
)
1042 error
= posix_lock_file(filp
, fl
, NULL
);
1043 if ((error
!= -EAGAIN
) || !(fl
->fl_flags
& FL_SLEEP
))
1045 error
= wait_event_interruptible(fl
->fl_wait
, !fl
->fl_next
);
1049 locks_delete_block(fl
);
1054 EXPORT_SYMBOL(posix_lock_file_wait
);
1057 * locks_mandatory_locked - Check for an active lock
1058 * @inode: the file to check
1060 * Searches the inode's list of locks to find any POSIX locks which conflict.
1061 * This function is called from locks_verify_locked() only.
1063 int locks_mandatory_locked(struct inode
*inode
)
1065 fl_owner_t owner
= current
->files
;
1066 struct file_lock
*fl
;
1069 * Search the lock list for this inode for any POSIX locks.
1072 for (fl
= inode
->i_flock
; fl
!= NULL
; fl
= fl
->fl_next
) {
1075 if (fl
->fl_owner
!= owner
)
1079 return fl
? -EAGAIN
: 0;
1083 * locks_mandatory_area - Check for a conflicting lock
1084 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1086 * @inode: the file to check
1087 * @filp: how the file was opened (if it was)
1088 * @offset: start of area to check
1089 * @count: length of area to check
1091 * Searches the inode's list of locks to find any POSIX locks which conflict.
1092 * This function is called from rw_verify_area() and
1093 * locks_verify_truncate().
1095 int locks_mandatory_area(int read_write
, struct inode
*inode
,
1096 struct file
*filp
, loff_t offset
,
1099 struct file_lock fl
;
1102 locks_init_lock(&fl
);
1103 fl
.fl_owner
= current
->files
;
1104 fl
.fl_pid
= current
->tgid
;
1106 fl
.fl_flags
= FL_POSIX
| FL_ACCESS
;
1107 if (filp
&& !(filp
->f_flags
& O_NONBLOCK
))
1108 fl
.fl_flags
|= FL_SLEEP
;
1109 fl
.fl_type
= (read_write
== FLOCK_VERIFY_WRITE
) ? F_WRLCK
: F_RDLCK
;
1110 fl
.fl_start
= offset
;
1111 fl
.fl_end
= offset
+ count
- 1;
1114 error
= __posix_lock_file(inode
, &fl
, NULL
);
1115 if (error
!= -EAGAIN
)
1117 if (!(fl
.fl_flags
& FL_SLEEP
))
1119 error
= wait_event_interruptible(fl
.fl_wait
, !fl
.fl_next
);
1122 * If we've been sleeping someone might have
1123 * changed the permissions behind our back.
1125 if (__mandatory_lock(inode
))
1129 locks_delete_block(&fl
);
1136 EXPORT_SYMBOL(locks_mandatory_area
);
1138 /* We already had a lease on this file; just change its type */
1139 int lease_modify(struct file_lock
**before
, int arg
)
1141 struct file_lock
*fl
= *before
;
1142 int error
= assign_type(fl
, arg
);
1146 locks_wake_up_blocks(fl
);
1148 locks_delete_lock(before
);
1152 EXPORT_SYMBOL(lease_modify
);
1154 static void time_out_leases(struct inode
*inode
)
1156 struct file_lock
**before
;
1157 struct file_lock
*fl
;
1159 before
= &inode
->i_flock
;
1160 while ((fl
= *before
) && IS_LEASE(fl
) && (fl
->fl_type
& F_INPROGRESS
)) {
1161 if ((fl
->fl_break_time
== 0)
1162 || time_before(jiffies
, fl
->fl_break_time
)) {
1163 before
= &fl
->fl_next
;
1166 lease_modify(before
, fl
->fl_type
& ~F_INPROGRESS
);
1167 if (fl
== *before
) /* lease_modify may have freed fl */
1168 before
= &fl
->fl_next
;
1173 * __break_lease - revoke all outstanding leases on file
1174 * @inode: the inode of the file to return
1175 * @mode: the open mode (read or write)
1177 * break_lease (inlined for speed) has checked there already is at least
1178 * some kind of lock (maybe a lease) on this file. Leases are broken on
1179 * a call to open() or truncate(). This function can sleep unless you
1180 * specified %O_NONBLOCK to your open().
1182 int __break_lease(struct inode
*inode
, unsigned int mode
)
1184 int error
= 0, future
;
1185 struct file_lock
*new_fl
, *flock
;
1186 struct file_lock
*fl
;
1187 unsigned long break_time
;
1188 int i_have_this_lease
= 0;
1190 new_fl
= lease_alloc(NULL
, mode
& FMODE_WRITE
? F_WRLCK
: F_RDLCK
);
1194 time_out_leases(inode
);
1196 flock
= inode
->i_flock
;
1197 if ((flock
== NULL
) || !IS_LEASE(flock
))
1200 for (fl
= flock
; fl
&& IS_LEASE(fl
); fl
= fl
->fl_next
)
1201 if (fl
->fl_owner
== current
->files
)
1202 i_have_this_lease
= 1;
1204 if (mode
& FMODE_WRITE
) {
1205 /* If we want write access, we have to revoke any lease. */
1206 future
= F_UNLCK
| F_INPROGRESS
;
1207 } else if (flock
->fl_type
& F_INPROGRESS
) {
1208 /* If the lease is already being broken, we just leave it */
1209 future
= flock
->fl_type
;
1210 } else if (flock
->fl_type
& F_WRLCK
) {
1211 /* Downgrade the exclusive lease to a read-only lease. */
1212 future
= F_RDLCK
| F_INPROGRESS
;
1214 /* the existing lease was read-only, so we can read too. */
1218 if (IS_ERR(new_fl
) && !i_have_this_lease
1219 && ((mode
& O_NONBLOCK
) == 0)) {
1220 error
= PTR_ERR(new_fl
);
1225 if (lease_break_time
> 0) {
1226 break_time
= jiffies
+ lease_break_time
* HZ
;
1227 if (break_time
== 0)
1228 break_time
++; /* so that 0 means no break time */
1231 for (fl
= flock
; fl
&& IS_LEASE(fl
); fl
= fl
->fl_next
) {
1232 if (fl
->fl_type
!= future
) {
1233 fl
->fl_type
= future
;
1234 fl
->fl_break_time
= break_time
;
1235 /* lease must have lmops break callback */
1236 fl
->fl_lmops
->fl_break(fl
);
1240 if (i_have_this_lease
|| (mode
& O_NONBLOCK
)) {
1241 error
= -EWOULDBLOCK
;
1246 break_time
= flock
->fl_break_time
;
1247 if (break_time
!= 0) {
1248 break_time
-= jiffies
;
1249 if (break_time
== 0)
1252 locks_insert_block(flock
, new_fl
);
1253 error
= wait_event_interruptible_timeout(new_fl
->fl_wait
,
1254 !new_fl
->fl_next
, break_time
);
1255 __locks_delete_block(new_fl
);
1258 time_out_leases(inode
);
1259 /* Wait for the next lease that has not been broken yet */
1260 for (flock
= inode
->i_flock
; flock
&& IS_LEASE(flock
);
1261 flock
= flock
->fl_next
) {
1262 if (flock
->fl_type
& F_INPROGRESS
)
1270 if (!IS_ERR(new_fl
))
1271 locks_free_lock(new_fl
);
1275 EXPORT_SYMBOL(__break_lease
);
1278 * lease_get_mtime - get the last modified time of an inode
1280 * @time: pointer to a timespec which will contain the last modified time
1282 * This is to force NFS clients to flush their caches for files with
1283 * exclusive leases. The justification is that if someone has an
1284 * exclusive lease, then they could be modifying it.
1286 void lease_get_mtime(struct inode
*inode
, struct timespec
*time
)
1288 struct file_lock
*flock
= inode
->i_flock
;
1289 if (flock
&& IS_LEASE(flock
) && (flock
->fl_type
& F_WRLCK
))
1290 *time
= current_fs_time(inode
->i_sb
);
1292 *time
= inode
->i_mtime
;
1295 EXPORT_SYMBOL(lease_get_mtime
);
1298 * fcntl_getlease - Enquire what lease is currently active
1301 * The value returned by this function will be one of
1302 * (if no lease break is pending):
1304 * %F_RDLCK to indicate a shared lease is held.
1306 * %F_WRLCK to indicate an exclusive lease is held.
1308 * %F_UNLCK to indicate no lease is held.
1310 * (if a lease break is pending):
1312 * %F_RDLCK to indicate an exclusive lease needs to be
1313 * changed to a shared lease (or removed).
1315 * %F_UNLCK to indicate the lease needs to be removed.
1317 * XXX: sfr & willy disagree over whether F_INPROGRESS
1318 * should be returned to userspace.
1320 int fcntl_getlease(struct file
*filp
)
1322 struct file_lock
*fl
;
1326 time_out_leases(filp
->f_path
.dentry
->d_inode
);
1327 for (fl
= filp
->f_path
.dentry
->d_inode
->i_flock
; fl
&& IS_LEASE(fl
);
1329 if (fl
->fl_file
== filp
) {
1330 type
= fl
->fl_type
& ~F_INPROGRESS
;
1339 * generic_setlease - sets a lease on an open file
1340 * @filp: file pointer
1341 * @arg: type of lease to obtain
1342 * @flp: input - file_lock to use, output - file_lock inserted
1344 * The (input) flp->fl_lmops->fl_break function is required
1347 * Called with kernel lock held.
1349 int generic_setlease(struct file
*filp
, long arg
, struct file_lock
**flp
)
1351 struct file_lock
*fl
, **before
, **my_before
= NULL
, *lease
;
1352 struct file_lock
*new_fl
= NULL
;
1353 struct dentry
*dentry
= filp
->f_path
.dentry
;
1354 struct inode
*inode
= dentry
->d_inode
;
1355 int error
, rdlease_count
= 0, wrlease_count
= 0;
1357 if ((current
->fsuid
!= inode
->i_uid
) && !capable(CAP_LEASE
))
1359 if (!S_ISREG(inode
->i_mode
))
1361 error
= security_file_lock(filp
, arg
);
1365 time_out_leases(inode
);
1367 BUG_ON(!(*flp
)->fl_lmops
->fl_break
);
1371 if (arg
!= F_UNLCK
) {
1373 new_fl
= locks_alloc_lock();
1378 if ((arg
== F_RDLCK
) && (atomic_read(&inode
->i_writecount
) > 0))
1380 if ((arg
== F_WRLCK
)
1381 && ((atomic_read(&dentry
->d_count
) > 1)
1382 || (atomic_read(&inode
->i_count
) > 1)))
1387 * At this point, we know that if there is an exclusive
1388 * lease on this file, then we hold it on this filp
1389 * (otherwise our open of this file would have blocked).
1390 * And if we are trying to acquire an exclusive lease,
1391 * then the file is not open by anyone (including us)
1392 * except for this filp.
1394 for (before
= &inode
->i_flock
;
1395 ((fl
= *before
) != NULL
) && IS_LEASE(fl
);
1396 before
= &fl
->fl_next
) {
1397 if (lease
->fl_lmops
->fl_mylease(fl
, lease
))
1399 else if (fl
->fl_type
== (F_INPROGRESS
| F_UNLCK
))
1401 * Someone is in the process of opening this
1402 * file for writing so we may not take an
1403 * exclusive lease on it.
1411 if ((arg
== F_RDLCK
&& (wrlease_count
> 0)) ||
1412 (arg
== F_WRLCK
&& ((rdlease_count
+ wrlease_count
) > 0)))
1415 if (my_before
!= NULL
) {
1417 error
= lease
->fl_lmops
->fl_change(my_before
, arg
);
1429 locks_copy_lock(new_fl
, lease
);
1430 locks_insert_lock(before
, new_fl
);
1437 locks_free_lock(new_fl
);
1440 EXPORT_SYMBOL(generic_setlease
);
1443 * vfs_setlease - sets a lease on an open file
1444 * @filp: file pointer
1445 * @arg: type of lease to obtain
1446 * @lease: file_lock to use
1448 * Call this to establish a lease on the file.
1449 * The (*lease)->fl_lmops->fl_break operation must be set; if not,
1450 * break_lease will oops!
1452 * This will call the filesystem's setlease file method, if
1453 * defined. Note that there is no getlease method; instead, the
1454 * filesystem setlease method should call back to setlease() to
1455 * add a lease to the inode's lease list, where fcntl_getlease() can
1456 * find it. Since fcntl_getlease() only reports whether the current
1457 * task holds a lease, a cluster filesystem need only do this for
1458 * leases held by processes on this node.
1460 * There is also no break_lease method; filesystems that
1461 * handle their own leases shoud break leases themselves from the
1462 * filesystem's open, create, and (on truncate) setattr methods.
1464 * Warning: the only current setlease methods exist only to disable
1465 * leases in certain cases. More vfs changes may be required to
1466 * allow a full filesystem lease implementation.
1469 int vfs_setlease(struct file
*filp
, long arg
, struct file_lock
**lease
)
1474 if (filp
->f_op
&& filp
->f_op
->setlease
)
1475 error
= filp
->f_op
->setlease(filp
, arg
, lease
);
1477 error
= generic_setlease(filp
, arg
, lease
);
1482 EXPORT_SYMBOL_GPL(vfs_setlease
);
1485 * fcntl_setlease - sets a lease on an open file
1486 * @fd: open file descriptor
1487 * @filp: file pointer
1488 * @arg: type of lease to obtain
1490 * Call this fcntl to establish a lease on the file.
1491 * Note that you also need to call %F_SETSIG to
1492 * receive a signal when the lease is broken.
1494 int fcntl_setlease(unsigned int fd
, struct file
*filp
, long arg
)
1496 struct file_lock fl
, *flp
= &fl
;
1497 struct inode
*inode
= filp
->f_path
.dentry
->d_inode
;
1500 locks_init_lock(&fl
);
1501 error
= lease_init(filp
, arg
, &fl
);
1507 error
= vfs_setlease(filp
, arg
, &flp
);
1508 if (error
|| arg
== F_UNLCK
)
1511 error
= fasync_helper(fd
, filp
, 1, &flp
->fl_fasync
);
1513 /* remove lease just inserted by setlease */
1514 flp
->fl_type
= F_UNLCK
| F_INPROGRESS
;
1515 flp
->fl_break_time
= jiffies
- 10;
1516 time_out_leases(inode
);
1520 error
= __f_setown(filp
, task_pid(current
), PIDTYPE_PID
, 0);
1527 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1528 * @filp: The file to apply the lock to
1529 * @fl: The lock to be applied
1531 * Add a FLOCK style lock to a file.
1533 int flock_lock_file_wait(struct file
*filp
, struct file_lock
*fl
)
1538 error
= flock_lock_file(filp
, fl
);
1539 if ((error
!= -EAGAIN
) || !(fl
->fl_flags
& FL_SLEEP
))
1541 error
= wait_event_interruptible(fl
->fl_wait
, !fl
->fl_next
);
1545 locks_delete_block(fl
);
1551 EXPORT_SYMBOL(flock_lock_file_wait
);
1554 * sys_flock: - flock() system call.
1555 * @fd: the file descriptor to lock.
1556 * @cmd: the type of lock to apply.
1558 * Apply a %FL_FLOCK style lock to an open file descriptor.
1559 * The @cmd can be one of
1561 * %LOCK_SH -- a shared lock.
1563 * %LOCK_EX -- an exclusive lock.
1565 * %LOCK_UN -- remove an existing lock.
1567 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1569 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1570 * processes read and write access respectively.
1572 asmlinkage
long sys_flock(unsigned int fd
, unsigned int cmd
)
1575 struct file_lock
*lock
;
1576 int can_sleep
, unlock
;
1584 can_sleep
= !(cmd
& LOCK_NB
);
1586 unlock
= (cmd
== LOCK_UN
);
1588 if (!unlock
&& !(cmd
& LOCK_MAND
) && !(filp
->f_mode
& 3))
1591 error
= flock_make_lock(filp
, &lock
, cmd
);
1595 lock
->fl_flags
|= FL_SLEEP
;
1597 error
= security_file_lock(filp
, cmd
);
1601 if (filp
->f_op
&& filp
->f_op
->flock
)
1602 error
= filp
->f_op
->flock(filp
,
1603 (can_sleep
) ? F_SETLKW
: F_SETLK
,
1606 error
= flock_lock_file_wait(filp
, lock
);
1609 locks_free_lock(lock
);
1618 * vfs_test_lock - test file byte range lock
1619 * @filp: The file to test lock for
1620 * @fl: The lock to test; also used to hold result
1622 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1623 * setting conf->fl_type to something other than F_UNLCK.
1625 int vfs_test_lock(struct file
*filp
, struct file_lock
*fl
)
1627 if (filp
->f_op
&& filp
->f_op
->lock
)
1628 return filp
->f_op
->lock(filp
, F_GETLK
, fl
);
1629 posix_test_lock(filp
, fl
);
1632 EXPORT_SYMBOL_GPL(vfs_test_lock
);
1634 static int posix_lock_to_flock(struct flock
*flock
, struct file_lock
*fl
)
1636 flock
->l_pid
= fl
->fl_pid
;
1637 #if BITS_PER_LONG == 32
1639 * Make sure we can represent the posix lock via
1640 * legacy 32bit flock.
1642 if (fl
->fl_start
> OFFT_OFFSET_MAX
)
1644 if (fl
->fl_end
!= OFFSET_MAX
&& fl
->fl_end
> OFFT_OFFSET_MAX
)
1647 flock
->l_start
= fl
->fl_start
;
1648 flock
->l_len
= fl
->fl_end
== OFFSET_MAX
? 0 :
1649 fl
->fl_end
- fl
->fl_start
+ 1;
1650 flock
->l_whence
= 0;
1651 flock
->l_type
= fl
->fl_type
;
1655 #if BITS_PER_LONG == 32
1656 static void posix_lock_to_flock64(struct flock64
*flock
, struct file_lock
*fl
)
1658 flock
->l_pid
= fl
->fl_pid
;
1659 flock
->l_start
= fl
->fl_start
;
1660 flock
->l_len
= fl
->fl_end
== OFFSET_MAX
? 0 :
1661 fl
->fl_end
- fl
->fl_start
+ 1;
1662 flock
->l_whence
= 0;
1663 flock
->l_type
= fl
->fl_type
;
1667 /* Report the first existing lock that would conflict with l.
1668 * This implements the F_GETLK command of fcntl().
1670 int fcntl_getlk(struct file
*filp
, struct flock __user
*l
)
1672 struct file_lock file_lock
;
1677 if (copy_from_user(&flock
, l
, sizeof(flock
)))
1680 if ((flock
.l_type
!= F_RDLCK
) && (flock
.l_type
!= F_WRLCK
))
1683 error
= flock_to_posix_lock(filp
, &file_lock
, &flock
);
1687 error
= vfs_test_lock(filp
, &file_lock
);
1691 flock
.l_type
= file_lock
.fl_type
;
1692 if (file_lock
.fl_type
!= F_UNLCK
) {
1693 error
= posix_lock_to_flock(&flock
, &file_lock
);
1698 if (!copy_to_user(l
, &flock
, sizeof(flock
)))
1705 * vfs_lock_file - file byte range lock
1706 * @filp: The file to apply the lock to
1707 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
1708 * @fl: The lock to be applied
1709 * @conf: Place to return a copy of the conflicting lock, if found.
1711 * A caller that doesn't care about the conflicting lock may pass NULL
1712 * as the final argument.
1714 * If the filesystem defines a private ->lock() method, then @conf will
1715 * be left unchanged; so a caller that cares should initialize it to
1716 * some acceptable default.
1718 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
1719 * locks, the ->lock() interface may return asynchronously, before the lock has
1720 * been granted or denied by the underlying filesystem, if (and only if)
1721 * fl_grant is set. Callers expecting ->lock() to return asynchronously
1722 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
1723 * the request is for a blocking lock. When ->lock() does return asynchronously,
1724 * it must return -EINPROGRESS, and call ->fl_grant() when the lock
1725 * request completes.
1726 * If the request is for non-blocking lock the file system should return
1727 * -EINPROGRESS then try to get the lock and call the callback routine with
1728 * the result. If the request timed out the callback routine will return a
1729 * nonzero return code and the file system should release the lock. The file
1730 * system is also responsible to keep a corresponding posix lock when it
1731 * grants a lock so the VFS can find out which locks are locally held and do
1732 * the correct lock cleanup when required.
1733 * The underlying filesystem must not drop the kernel lock or call
1734 * ->fl_grant() before returning to the caller with a -EINPROGRESS
1737 int vfs_lock_file(struct file
*filp
, unsigned int cmd
, struct file_lock
*fl
, struct file_lock
*conf
)
1739 if (filp
->f_op
&& filp
->f_op
->lock
)
1740 return filp
->f_op
->lock(filp
, cmd
, fl
);
1742 return posix_lock_file(filp
, fl
, conf
);
1744 EXPORT_SYMBOL_GPL(vfs_lock_file
);
1746 /* Apply the lock described by l to an open file descriptor.
1747 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1749 int fcntl_setlk(unsigned int fd
, struct file
*filp
, unsigned int cmd
,
1750 struct flock __user
*l
)
1752 struct file_lock
*file_lock
= locks_alloc_lock();
1754 struct inode
*inode
;
1757 if (file_lock
== NULL
)
1761 * This might block, so we do it before checking the inode.
1764 if (copy_from_user(&flock
, l
, sizeof(flock
)))
1767 inode
= filp
->f_path
.dentry
->d_inode
;
1769 /* Don't allow mandatory locks on files that may be memory mapped
1772 if (mandatory_lock(inode
) && mapping_writably_mapped(filp
->f_mapping
)) {
1778 error
= flock_to_posix_lock(filp
, file_lock
, &flock
);
1781 if (cmd
== F_SETLKW
) {
1782 file_lock
->fl_flags
|= FL_SLEEP
;
1786 switch (flock
.l_type
) {
1788 if (!(filp
->f_mode
& FMODE_READ
))
1792 if (!(filp
->f_mode
& FMODE_WRITE
))
1802 error
= security_file_lock(filp
, file_lock
->fl_type
);
1806 if (filp
->f_op
&& filp
->f_op
->lock
!= NULL
)
1807 error
= filp
->f_op
->lock(filp
, cmd
, file_lock
);
1810 error
= posix_lock_file(filp
, file_lock
, NULL
);
1811 if (error
!= -EAGAIN
|| cmd
== F_SETLK
)
1813 error
= wait_event_interruptible(file_lock
->fl_wait
,
1814 !file_lock
->fl_next
);
1818 locks_delete_block(file_lock
);
1824 * Attempt to detect a close/fcntl race and recover by
1825 * releasing the lock that was just acquired.
1827 if (!error
&& fcheck(fd
) != filp
&& flock
.l_type
!= F_UNLCK
) {
1828 flock
.l_type
= F_UNLCK
;
1833 locks_free_lock(file_lock
);
1837 #if BITS_PER_LONG == 32
1838 /* Report the first existing lock that would conflict with l.
1839 * This implements the F_GETLK command of fcntl().
1841 int fcntl_getlk64(struct file
*filp
, struct flock64 __user
*l
)
1843 struct file_lock file_lock
;
1844 struct flock64 flock
;
1848 if (copy_from_user(&flock
, l
, sizeof(flock
)))
1851 if ((flock
.l_type
!= F_RDLCK
) && (flock
.l_type
!= F_WRLCK
))
1854 error
= flock64_to_posix_lock(filp
, &file_lock
, &flock
);
1858 error
= vfs_test_lock(filp
, &file_lock
);
1862 flock
.l_type
= file_lock
.fl_type
;
1863 if (file_lock
.fl_type
!= F_UNLCK
)
1864 posix_lock_to_flock64(&flock
, &file_lock
);
1867 if (!copy_to_user(l
, &flock
, sizeof(flock
)))
1874 /* Apply the lock described by l to an open file descriptor.
1875 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1877 int fcntl_setlk64(unsigned int fd
, struct file
*filp
, unsigned int cmd
,
1878 struct flock64 __user
*l
)
1880 struct file_lock
*file_lock
= locks_alloc_lock();
1881 struct flock64 flock
;
1882 struct inode
*inode
;
1885 if (file_lock
== NULL
)
1889 * This might block, so we do it before checking the inode.
1892 if (copy_from_user(&flock
, l
, sizeof(flock
)))
1895 inode
= filp
->f_path
.dentry
->d_inode
;
1897 /* Don't allow mandatory locks on files that may be memory mapped
1900 if (mandatory_lock(inode
) && mapping_writably_mapped(filp
->f_mapping
)) {
1906 error
= flock64_to_posix_lock(filp
, file_lock
, &flock
);
1909 if (cmd
== F_SETLKW64
) {
1910 file_lock
->fl_flags
|= FL_SLEEP
;
1914 switch (flock
.l_type
) {
1916 if (!(filp
->f_mode
& FMODE_READ
))
1920 if (!(filp
->f_mode
& FMODE_WRITE
))
1930 error
= security_file_lock(filp
, file_lock
->fl_type
);
1934 if (filp
->f_op
&& filp
->f_op
->lock
!= NULL
)
1935 error
= filp
->f_op
->lock(filp
, cmd
, file_lock
);
1938 error
= posix_lock_file(filp
, file_lock
, NULL
);
1939 if (error
!= -EAGAIN
|| cmd
== F_SETLK64
)
1941 error
= wait_event_interruptible(file_lock
->fl_wait
,
1942 !file_lock
->fl_next
);
1946 locks_delete_block(file_lock
);
1952 * Attempt to detect a close/fcntl race and recover by
1953 * releasing the lock that was just acquired.
1955 if (!error
&& fcheck(fd
) != filp
&& flock
.l_type
!= F_UNLCK
) {
1956 flock
.l_type
= F_UNLCK
;
1961 locks_free_lock(file_lock
);
1964 #endif /* BITS_PER_LONG == 32 */
1967 * This function is called when the file is being removed
1968 * from the task's fd array. POSIX locks belonging to this task
1969 * are deleted at this time.
1971 void locks_remove_posix(struct file
*filp
, fl_owner_t owner
)
1973 struct file_lock lock
;
1976 * If there are no locks held on this file, we don't need to call
1977 * posix_lock_file(). Another process could be setting a lock on this
1978 * file at the same time, but we wouldn't remove that lock anyway.
1980 if (!filp
->f_path
.dentry
->d_inode
->i_flock
)
1983 lock
.fl_type
= F_UNLCK
;
1984 lock
.fl_flags
= FL_POSIX
| FL_CLOSE
;
1986 lock
.fl_end
= OFFSET_MAX
;
1987 lock
.fl_owner
= owner
;
1988 lock
.fl_pid
= current
->tgid
;
1989 lock
.fl_file
= filp
;
1991 lock
.fl_lmops
= NULL
;
1993 vfs_lock_file(filp
, F_SETLK
, &lock
, NULL
);
1995 if (lock
.fl_ops
&& lock
.fl_ops
->fl_release_private
)
1996 lock
.fl_ops
->fl_release_private(&lock
);
1999 EXPORT_SYMBOL(locks_remove_posix
);
2002 * This function is called on the last close of an open file.
2004 void locks_remove_flock(struct file
*filp
)
2006 struct inode
* inode
= filp
->f_path
.dentry
->d_inode
;
2007 struct file_lock
*fl
;
2008 struct file_lock
**before
;
2010 if (!inode
->i_flock
)
2013 if (filp
->f_op
&& filp
->f_op
->flock
) {
2014 struct file_lock fl
= {
2015 .fl_pid
= current
->tgid
,
2017 .fl_flags
= FL_FLOCK
,
2019 .fl_end
= OFFSET_MAX
,
2021 filp
->f_op
->flock(filp
, F_SETLKW
, &fl
);
2022 if (fl
.fl_ops
&& fl
.fl_ops
->fl_release_private
)
2023 fl
.fl_ops
->fl_release_private(&fl
);
2027 before
= &inode
->i_flock
;
2029 while ((fl
= *before
) != NULL
) {
2030 if (fl
->fl_file
== filp
) {
2032 locks_delete_lock(before
);
2036 lease_modify(before
, F_UNLCK
);
2042 before
= &fl
->fl_next
;
2048 * posix_unblock_lock - stop waiting for a file lock
2049 * @filp: how the file was opened
2050 * @waiter: the lock which was waiting
2052 * lockd needs to block waiting for locks.
2055 posix_unblock_lock(struct file
*filp
, struct file_lock
*waiter
)
2060 if (waiter
->fl_next
)
2061 __locks_delete_block(waiter
);
2068 EXPORT_SYMBOL(posix_unblock_lock
);
2071 * vfs_cancel_lock - file byte range unblock lock
2072 * @filp: The file to apply the unblock to
2073 * @fl: The lock to be unblocked
2075 * Used by lock managers to cancel blocked requests
2077 int vfs_cancel_lock(struct file
*filp
, struct file_lock
*fl
)
2079 if (filp
->f_op
&& filp
->f_op
->lock
)
2080 return filp
->f_op
->lock(filp
, F_CANCELLK
, fl
);
2084 EXPORT_SYMBOL_GPL(vfs_cancel_lock
);
2086 #ifdef CONFIG_PROC_FS
2087 #include <linux/seq_file.h>
2089 static void lock_get_status(struct seq_file
*f
, struct file_lock
*fl
,
2092 struct inode
*inode
= NULL
;
2093 unsigned int fl_pid
;
2096 fl_pid
= pid_vnr(fl
->fl_nspid
);
2098 fl_pid
= fl
->fl_pid
;
2100 if (fl
->fl_file
!= NULL
)
2101 inode
= fl
->fl_file
->f_path
.dentry
->d_inode
;
2103 seq_printf(f
, "%d:%s ", id
, pfx
);
2105 seq_printf(f
, "%6s %s ",
2106 (fl
->fl_flags
& FL_ACCESS
) ? "ACCESS" : "POSIX ",
2107 (inode
== NULL
) ? "*NOINODE*" :
2108 mandatory_lock(inode
) ? "MANDATORY" : "ADVISORY ");
2109 } else if (IS_FLOCK(fl
)) {
2110 if (fl
->fl_type
& LOCK_MAND
) {
2111 seq_printf(f
, "FLOCK MSNFS ");
2113 seq_printf(f
, "FLOCK ADVISORY ");
2115 } else if (IS_LEASE(fl
)) {
2116 seq_printf(f
, "LEASE ");
2117 if (fl
->fl_type
& F_INPROGRESS
)
2118 seq_printf(f
, "BREAKING ");
2119 else if (fl
->fl_file
)
2120 seq_printf(f
, "ACTIVE ");
2122 seq_printf(f
, "BREAKER ");
2124 seq_printf(f
, "UNKNOWN UNKNOWN ");
2126 if (fl
->fl_type
& LOCK_MAND
) {
2127 seq_printf(f
, "%s ",
2128 (fl
->fl_type
& LOCK_READ
)
2129 ? (fl
->fl_type
& LOCK_WRITE
) ? "RW " : "READ "
2130 : (fl
->fl_type
& LOCK_WRITE
) ? "WRITE" : "NONE ");
2132 seq_printf(f
, "%s ",
2133 (fl
->fl_type
& F_INPROGRESS
)
2134 ? (fl
->fl_type
& F_UNLCK
) ? "UNLCK" : "READ "
2135 : (fl
->fl_type
& F_WRLCK
) ? "WRITE" : "READ ");
2138 #ifdef WE_CAN_BREAK_LSLK_NOW
2139 seq_printf(f
, "%d %s:%ld ", fl_pid
,
2140 inode
->i_sb
->s_id
, inode
->i_ino
);
2142 /* userspace relies on this representation of dev_t ;-( */
2143 seq_printf(f
, "%d %02x:%02x:%ld ", fl_pid
,
2144 MAJOR(inode
->i_sb
->s_dev
),
2145 MINOR(inode
->i_sb
->s_dev
), inode
->i_ino
);
2148 seq_printf(f
, "%d <none>:0 ", fl_pid
);
2151 if (fl
->fl_end
== OFFSET_MAX
)
2152 seq_printf(f
, "%Ld EOF\n", fl
->fl_start
);
2154 seq_printf(f
, "%Ld %Ld\n", fl
->fl_start
, fl
->fl_end
);
2156 seq_printf(f
, "0 EOF\n");
2160 static int locks_show(struct seq_file
*f
, void *v
)
2162 struct file_lock
*fl
, *bfl
;
2164 fl
= list_entry(v
, struct file_lock
, fl_link
);
2166 lock_get_status(f
, fl
, (long)f
->private, "");
2168 list_for_each_entry(bfl
, &fl
->fl_block
, fl_block
)
2169 lock_get_status(f
, bfl
, (long)f
->private, " ->");
2175 static void *locks_start(struct seq_file
*f
, loff_t
*pos
)
2178 f
->private = (void *)1;
2179 return seq_list_start(&file_lock_list
, *pos
);
2182 static void *locks_next(struct seq_file
*f
, void *v
, loff_t
*pos
)
2184 return seq_list_next(v
, &file_lock_list
, pos
);
2187 static void locks_stop(struct seq_file
*f
, void *v
)
2192 struct seq_operations locks_seq_operations
= {
2193 .start
= locks_start
,
2201 * lock_may_read - checks that the region is free of locks
2202 * @inode: the inode that is being read
2203 * @start: the first byte to read
2204 * @len: the number of bytes to read
2206 * Emulates Windows locking requirements. Whole-file
2207 * mandatory locks (share modes) can prohibit a read and
2208 * byte-range POSIX locks can prohibit a read if they overlap.
2210 * N.B. this function is only ever called
2211 * from knfsd and ownership of locks is never checked.
2213 int lock_may_read(struct inode
*inode
, loff_t start
, unsigned long len
)
2215 struct file_lock
*fl
;
2218 for (fl
= inode
->i_flock
; fl
!= NULL
; fl
= fl
->fl_next
) {
2220 if (fl
->fl_type
== F_RDLCK
)
2222 if ((fl
->fl_end
< start
) || (fl
->fl_start
> (start
+ len
)))
2224 } else if (IS_FLOCK(fl
)) {
2225 if (!(fl
->fl_type
& LOCK_MAND
))
2227 if (fl
->fl_type
& LOCK_READ
)
2238 EXPORT_SYMBOL(lock_may_read
);
2241 * lock_may_write - checks that the region is free of locks
2242 * @inode: the inode that is being written
2243 * @start: the first byte to write
2244 * @len: the number of bytes to write
2246 * Emulates Windows locking requirements. Whole-file
2247 * mandatory locks (share modes) can prohibit a write and
2248 * byte-range POSIX locks can prohibit a write if they overlap.
2250 * N.B. this function is only ever called
2251 * from knfsd and ownership of locks is never checked.
2253 int lock_may_write(struct inode
*inode
, loff_t start
, unsigned long len
)
2255 struct file_lock
*fl
;
2258 for (fl
= inode
->i_flock
; fl
!= NULL
; fl
= fl
->fl_next
) {
2260 if ((fl
->fl_end
< start
) || (fl
->fl_start
> (start
+ len
)))
2262 } else if (IS_FLOCK(fl
)) {
2263 if (!(fl
->fl_type
& LOCK_MAND
))
2265 if (fl
->fl_type
& LOCK_WRITE
)
2276 EXPORT_SYMBOL(lock_may_write
);
2278 static int __init
filelock_init(void)
2280 filelock_cache
= kmem_cache_create("file_lock_cache",
2281 sizeof(struct file_lock
), 0, SLAB_PANIC
,
2286 core_initcall(filelock_init
);