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/filesystems/mandatory-locking.txt' for details.
64 * Andy Walker (andy@lysaker.kvaerner.no), April 06, 1996.
66 * Don't allow mandatory locks on mmap()'ed files. Added simple functions to
67 * check if a file has mandatory locks, used by mmap(), open() and creat() to
68 * see if system call should be rejected. Ref. HP-UX/SunOS/Solaris Reference
70 * Andy Walker (andy@lysaker.kvaerner.no), April 09, 1996.
72 * Tidied up block list handling. Added '/proc/locks' interface.
73 * Andy Walker (andy@lysaker.kvaerner.no), April 24, 1996.
75 * Fixed deadlock condition for pathological code that mixes calls to
76 * flock() and fcntl().
77 * Andy Walker (andy@lysaker.kvaerner.no), April 29, 1996.
79 * Allow only one type of locking scheme (FL_POSIX or FL_FLOCK) to be in use
80 * for a given file at a time. Changed the CONFIG_LOCK_MANDATORY scheme to
81 * guarantee sensible behaviour in the case where file system modules might
82 * be compiled with different options than the kernel itself.
83 * Andy Walker (andy@lysaker.kvaerner.no), May 15, 1996.
85 * Added a couple of missing wake_up() calls. Thanks to Thomas Meckel
86 * (Thomas.Meckel@mni.fh-giessen.de) for spotting this.
87 * Andy Walker (andy@lysaker.kvaerner.no), May 15, 1996.
89 * Changed FL_POSIX locks to use the block list in the same way as FL_FLOCK
90 * locks. Changed process synchronisation to avoid dereferencing locks that
91 * have already been freed.
92 * Andy Walker (andy@lysaker.kvaerner.no), Sep 21, 1996.
94 * Made the block list a circular list to minimise searching in the list.
95 * Andy Walker (andy@lysaker.kvaerner.no), Sep 25, 1996.
97 * Made mandatory locking a mount option. Default is not to allow mandatory
99 * Andy Walker (andy@lysaker.kvaerner.no), Oct 04, 1996.
101 * Some adaptations for NFS support.
102 * Olaf Kirch (okir@monad.swb.de), Dec 1996,
104 * Fixed /proc/locks interface so that we can't overrun the buffer we are handed.
105 * Andy Walker (andy@lysaker.kvaerner.no), May 12, 1997.
107 * Use slab allocator instead of kmalloc/kfree.
108 * Use generic list implementation from <linux/list.h>.
109 * Sped up posix_locks_deadlock by only considering blocked locks.
110 * Matthew Wilcox <willy@debian.org>, March, 2000.
112 * Leases and LOCK_MAND
113 * Matthew Wilcox <willy@debian.org>, June, 2000.
114 * Stephen Rothwell <sfr@canb.auug.org.au>, June, 2000.
117 #include <linux/capability.h>
118 #include <linux/file.h>
119 #include <linux/fdtable.h>
120 #include <linux/fs.h>
121 #include <linux/init.h>
122 #include <linux/module.h>
123 #include <linux/security.h>
124 #include <linux/slab.h>
125 #include <linux/syscalls.h>
126 #include <linux/time.h>
127 #include <linux/rcupdate.h>
128 #include <linux/pid_namespace.h>
129 #include <linux/hashtable.h>
131 #include <asm/uaccess.h>
133 #define IS_POSIX(fl) (fl->fl_flags & FL_POSIX)
134 #define IS_FLOCK(fl) (fl->fl_flags & FL_FLOCK)
135 #define IS_LEASE(fl) (fl->fl_flags & FL_LEASE)
137 static bool lease_breaking(struct file_lock *fl)
139 return fl->fl_flags & (FL_UNLOCK_PENDING | FL_DOWNGRADE_PENDING);
142 static int target_leasetype(struct file_lock *fl)
144 if (fl->fl_flags & FL_UNLOCK_PENDING)
146 if (fl->fl_flags & FL_DOWNGRADE_PENDING)
151 int leases_enable = 1;
152 int lease_break_time = 45;
154 #define for_each_lock(inode, lockp) \
155 for (lockp = &inode->i_flock; *lockp != NULL; lockp = &(*lockp)->fl_next)
158 * The global file_lock_list is only used for displaying /proc/locks. Protected
159 * by the file_lock_lock.
161 static HLIST_HEAD(file_lock_list);
162 static DEFINE_SPINLOCK(file_lock_lock);
165 * The blocked_hash is used to find POSIX lock loops for deadlock detection.
166 * It is protected by blocked_lock_lock.
168 * We hash locks by lockowner in order to optimize searching for the lock a
169 * particular lockowner is waiting on.
171 * FIXME: make this value scale via some heuristic? We generally will want more
172 * buckets when we have more lockowners holding locks, but that's a little
173 * difficult to determine without knowing what the workload will look like.
175 #define BLOCKED_HASH_BITS 7
176 static DEFINE_HASHTABLE(blocked_hash, BLOCKED_HASH_BITS);
179 * This lock protects the blocked_hash. Generally, if you're accessing it, you
180 * want to be holding this lock.
182 * In addition, it also protects the fl->fl_block list, and the fl->fl_next
183 * pointer for file_lock structures that are acting as lock requests (in
184 * contrast to those that are acting as records of acquired locks).
186 * Note that when we acquire this lock in order to change the above fields,
187 * we often hold the i_lock as well. In certain cases, when reading the fields
188 * protected by this lock, we can skip acquiring it iff we already hold the
191 * In particular, adding an entry to the fl_block list requires that you hold
192 * both the i_lock and the blocked_lock_lock (acquired in that order). Deleting
193 * an entry from the list however only requires the file_lock_lock.
195 static DEFINE_SPINLOCK(blocked_lock_lock);
197 static struct kmem_cache *filelock_cache __read_mostly;
199 static void locks_init_lock_heads(struct file_lock *fl)
201 INIT_HLIST_NODE(&fl->fl_link);
202 INIT_LIST_HEAD(&fl->fl_block);
203 init_waitqueue_head(&fl->fl_wait);
206 /* Allocate an empty lock structure. */
207 struct file_lock *locks_alloc_lock(void)
209 struct file_lock *fl = kmem_cache_zalloc(filelock_cache, GFP_KERNEL);
212 locks_init_lock_heads(fl);
216 EXPORT_SYMBOL_GPL(locks_alloc_lock);
218 void locks_release_private(struct file_lock *fl)
221 if (fl->fl_ops->fl_release_private)
222 fl->fl_ops->fl_release_private(fl);
228 EXPORT_SYMBOL_GPL(locks_release_private);
230 /* Free a lock which is not in use. */
231 void locks_free_lock(struct file_lock *fl)
233 BUG_ON(waitqueue_active(&fl->fl_wait));
234 BUG_ON(!list_empty(&fl->fl_block));
235 BUG_ON(!hlist_unhashed(&fl->fl_link));
237 locks_release_private(fl);
238 kmem_cache_free(filelock_cache, fl);
240 EXPORT_SYMBOL(locks_free_lock);
242 void locks_init_lock(struct file_lock *fl)
244 memset(fl, 0, sizeof(struct file_lock));
245 locks_init_lock_heads(fl);
248 EXPORT_SYMBOL(locks_init_lock);
250 static void locks_copy_private(struct file_lock *new, struct file_lock *fl)
253 if (fl->fl_ops->fl_copy_lock)
254 fl->fl_ops->fl_copy_lock(new, fl);
255 new->fl_ops = fl->fl_ops;
258 new->fl_lmops = fl->fl_lmops;
262 * Initialize a new lock from an existing file_lock structure.
264 void __locks_copy_lock(struct file_lock *new, const struct file_lock *fl)
266 new->fl_owner = fl->fl_owner;
267 new->fl_pid = fl->fl_pid;
269 new->fl_flags = fl->fl_flags;
270 new->fl_type = fl->fl_type;
271 new->fl_start = fl->fl_start;
272 new->fl_end = fl->fl_end;
274 new->fl_lmops = NULL;
276 EXPORT_SYMBOL(__locks_copy_lock);
278 void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
280 locks_release_private(new);
282 __locks_copy_lock(new, fl);
283 new->fl_file = fl->fl_file;
284 new->fl_ops = fl->fl_ops;
285 new->fl_lmops = fl->fl_lmops;
287 locks_copy_private(new, fl);
290 EXPORT_SYMBOL(locks_copy_lock);
292 static inline int flock_translate_cmd(int cmd) {
294 return cmd & (LOCK_MAND | LOCK_RW);
306 /* Fill in a file_lock structure with an appropriate FLOCK lock. */
307 static int flock_make_lock(struct file *filp, struct file_lock **lock,
310 struct file_lock *fl;
311 int type = flock_translate_cmd(cmd);
315 fl = locks_alloc_lock();
320 fl->fl_pid = current->tgid;
321 fl->fl_flags = FL_FLOCK;
323 fl->fl_end = OFFSET_MAX;
329 static int assign_type(struct file_lock *fl, long type)
343 /* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
346 static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
351 switch (l->l_whence) {
359 start = i_size_read(file_inode(filp));
365 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
366 POSIX-2001 defines it. */
370 fl->fl_end = OFFSET_MAX;
372 end = start + l->l_len - 1;
374 } else if (l->l_len < 0) {
381 fl->fl_start = start; /* we record the absolute position */
382 if (fl->fl_end < fl->fl_start)
385 fl->fl_owner = current->files;
386 fl->fl_pid = current->tgid;
388 fl->fl_flags = FL_POSIX;
392 return assign_type(fl, l->l_type);
395 #if BITS_PER_LONG == 32
396 static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
401 switch (l->l_whence) {
409 start = i_size_read(file_inode(filp));
418 fl->fl_end = OFFSET_MAX;
420 fl->fl_end = start + l->l_len - 1;
421 } else if (l->l_len < 0) {
422 fl->fl_end = start - 1;
427 fl->fl_start = start; /* we record the absolute position */
428 if (fl->fl_end < fl->fl_start)
431 fl->fl_owner = current->files;
432 fl->fl_pid = current->tgid;
434 fl->fl_flags = FL_POSIX;
438 return assign_type(fl, l->l_type);
442 /* default lease lock manager operations */
443 static void lease_break_callback(struct file_lock *fl)
445 kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
448 static const struct lock_manager_operations lease_manager_ops = {
449 .lm_break = lease_break_callback,
450 .lm_change = lease_modify,
454 * Initialize a lease, use the default lock manager operations
456 static int lease_init(struct file *filp, long type, struct file_lock *fl)
458 if (assign_type(fl, type) != 0)
461 fl->fl_owner = current->files;
462 fl->fl_pid = current->tgid;
465 fl->fl_flags = FL_LEASE;
467 fl->fl_end = OFFSET_MAX;
469 fl->fl_lmops = &lease_manager_ops;
473 /* Allocate a file_lock initialised to this type of lease */
474 static struct file_lock *lease_alloc(struct file *filp, long type)
476 struct file_lock *fl = locks_alloc_lock();
480 return ERR_PTR(error);
482 error = lease_init(filp, type, fl);
485 return ERR_PTR(error);
490 /* Check if two locks overlap each other.
492 static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
494 return ((fl1->fl_end >= fl2->fl_start) &&
495 (fl2->fl_end >= fl1->fl_start));
499 * Check whether two locks have the same owner.
501 static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
503 if (fl1->fl_lmops && fl1->fl_lmops->lm_compare_owner)
504 return fl2->fl_lmops == fl1->fl_lmops &&
505 fl1->fl_lmops->lm_compare_owner(fl1, fl2);
506 return fl1->fl_owner == fl2->fl_owner;
510 locks_insert_global_locks(struct file_lock *fl)
512 spin_lock(&file_lock_lock);
513 hlist_add_head(&fl->fl_link, &file_lock_list);
514 spin_unlock(&file_lock_lock);
518 locks_delete_global_locks(struct file_lock *fl)
520 spin_lock(&file_lock_lock);
521 hlist_del_init(&fl->fl_link);
522 spin_unlock(&file_lock_lock);
526 posix_owner_key(struct file_lock *fl)
528 if (fl->fl_lmops && fl->fl_lmops->lm_owner_key)
529 return fl->fl_lmops->lm_owner_key(fl);
530 return (unsigned long)fl->fl_owner;
534 locks_insert_global_blocked(struct file_lock *waiter)
536 hash_add(blocked_hash, &waiter->fl_link, posix_owner_key(waiter));
540 locks_delete_global_blocked(struct file_lock *waiter)
542 hash_del(&waiter->fl_link);
545 /* Remove waiter from blocker's block list.
546 * When blocker ends up pointing to itself then the list is empty.
548 * Must be called with blocked_lock_lock held.
550 static void __locks_delete_block(struct file_lock *waiter)
552 locks_delete_global_blocked(waiter);
553 list_del_init(&waiter->fl_block);
554 waiter->fl_next = NULL;
557 static void locks_delete_block(struct file_lock *waiter)
559 spin_lock(&blocked_lock_lock);
560 __locks_delete_block(waiter);
561 spin_unlock(&blocked_lock_lock);
564 /* Insert waiter into blocker's block list.
565 * We use a circular list so that processes can be easily woken up in
566 * the order they blocked. The documentation doesn't require this but
567 * it seems like the reasonable thing to do.
569 * Must be called with both the i_lock and blocked_lock_lock held. The fl_block
570 * list itself is protected by the file_lock_list, but by ensuring that the
571 * i_lock is also held on insertions we can avoid taking the blocked_lock_lock
572 * in some cases when we see that the fl_block list is empty.
574 static void __locks_insert_block(struct file_lock *blocker,
575 struct file_lock *waiter)
577 BUG_ON(!list_empty(&waiter->fl_block));
578 waiter->fl_next = blocker;
579 list_add_tail(&waiter->fl_block, &blocker->fl_block);
580 if (IS_POSIX(blocker))
581 locks_insert_global_blocked(waiter);
584 /* Must be called with i_lock held. */
585 static void locks_insert_block(struct file_lock *blocker,
586 struct file_lock *waiter)
588 spin_lock(&blocked_lock_lock);
589 __locks_insert_block(blocker, waiter);
590 spin_unlock(&blocked_lock_lock);
594 * Wake up processes blocked waiting for blocker.
596 * Must be called with the inode->i_lock held!
598 static void locks_wake_up_blocks(struct file_lock *blocker)
601 * Avoid taking global lock if list is empty. This is safe since new
602 * blocked requests are only added to the list under the i_lock, and
603 * the i_lock is always held here. Note that removal from the fl_block
604 * list does not require the i_lock, so we must recheck list_empty()
605 * after acquiring the blocked_lock_lock.
607 if (list_empty(&blocker->fl_block))
610 spin_lock(&blocked_lock_lock);
611 while (!list_empty(&blocker->fl_block)) {
612 struct file_lock *waiter;
614 waiter = list_first_entry(&blocker->fl_block,
615 struct file_lock, fl_block);
616 __locks_delete_block(waiter);
617 if (waiter->fl_lmops && waiter->fl_lmops->lm_notify)
618 waiter->fl_lmops->lm_notify(waiter);
620 wake_up(&waiter->fl_wait);
622 spin_unlock(&blocked_lock_lock);
625 /* Insert file lock fl into an inode's lock list at the position indicated
626 * by pos. At the same time add the lock to the global file lock list.
628 * Must be called with the i_lock held!
630 static void locks_insert_lock(struct file_lock **pos, struct file_lock *fl)
632 fl->fl_nspid = get_pid(task_tgid(current));
634 /* insert into file's list */
638 locks_insert_global_locks(fl);
642 * Delete a lock and then free it.
643 * Wake up processes that are blocked waiting for this lock,
644 * notify the FS that the lock has been cleared and
645 * finally free the lock.
647 * Must be called with the i_lock held!
649 static void locks_delete_lock(struct file_lock **thisfl_p)
651 struct file_lock *fl = *thisfl_p;
653 locks_delete_global_locks(fl);
655 *thisfl_p = fl->fl_next;
659 put_pid(fl->fl_nspid);
663 locks_wake_up_blocks(fl);
667 /* Determine if lock sys_fl blocks lock caller_fl. Common functionality
668 * checks for shared/exclusive status of overlapping locks.
670 static int locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
672 if (sys_fl->fl_type == F_WRLCK)
674 if (caller_fl->fl_type == F_WRLCK)
679 /* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
680 * checking before calling the locks_conflict().
682 static int posix_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
684 /* POSIX locks owned by the same process do not conflict with
687 if (!IS_POSIX(sys_fl) || posix_same_owner(caller_fl, sys_fl))
690 /* Check whether they overlap */
691 if (!locks_overlap(caller_fl, sys_fl))
694 return (locks_conflict(caller_fl, sys_fl));
697 /* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
698 * checking before calling the locks_conflict().
700 static int flock_locks_conflict(struct file_lock *caller_fl, struct file_lock *sys_fl)
702 /* FLOCK locks referring to the same filp do not conflict with
705 if (!IS_FLOCK(sys_fl) || (caller_fl->fl_file == sys_fl->fl_file))
707 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
710 return (locks_conflict(caller_fl, sys_fl));
714 posix_test_lock(struct file *filp, struct file_lock *fl)
716 struct file_lock *cfl;
717 struct inode *inode = file_inode(filp);
719 spin_lock(&inode->i_lock);
720 for (cfl = file_inode(filp)->i_flock; cfl; cfl = cfl->fl_next) {
723 if (posix_locks_conflict(fl, cfl))
727 __locks_copy_lock(fl, cfl);
729 fl->fl_pid = pid_vnr(cfl->fl_nspid);
731 fl->fl_type = F_UNLCK;
732 spin_unlock(&inode->i_lock);
735 EXPORT_SYMBOL(posix_test_lock);
738 * Deadlock detection:
740 * We attempt to detect deadlocks that are due purely to posix file
743 * We assume that a task can be waiting for at most one lock at a time.
744 * So for any acquired lock, the process holding that lock may be
745 * waiting on at most one other lock. That lock in turns may be held by
746 * someone waiting for at most one other lock. Given a requested lock
747 * caller_fl which is about to wait for a conflicting lock block_fl, we
748 * follow this chain of waiters to ensure we are not about to create a
751 * Since we do this before we ever put a process to sleep on a lock, we
752 * are ensured that there is never a cycle; that is what guarantees that
753 * the while() loop in posix_locks_deadlock() eventually completes.
755 * Note: the above assumption may not be true when handling lock
756 * requests from a broken NFS client. It may also fail in the presence
757 * of tasks (such as posix threads) sharing the same open file table.
759 * To handle those cases, we just bail out after a few iterations.
762 #define MAX_DEADLK_ITERATIONS 10
764 /* Find a lock that the owner of the given block_fl is blocking on. */
765 static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
767 struct file_lock *fl;
769 hash_for_each_possible(blocked_hash, fl, fl_link, posix_owner_key(block_fl)) {
770 if (posix_same_owner(fl, block_fl))
776 /* Must be called with the blocked_lock_lock held! */
777 static int posix_locks_deadlock(struct file_lock *caller_fl,
778 struct file_lock *block_fl)
782 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
783 if (i++ > MAX_DEADLK_ITERATIONS)
785 if (posix_same_owner(caller_fl, block_fl))
791 /* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
792 * after any leases, but before any posix locks.
794 * Note that if called with an FL_EXISTS argument, the caller may determine
795 * whether or not a lock was successfully freed by testing the return
798 static int flock_lock_file(struct file *filp, struct file_lock *request)
800 struct file_lock *new_fl = NULL;
801 struct file_lock **before;
802 struct inode * inode = file_inode(filp);
806 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
807 new_fl = locks_alloc_lock();
812 spin_lock(&inode->i_lock);
813 if (request->fl_flags & FL_ACCESS)
816 for_each_lock(inode, before) {
817 struct file_lock *fl = *before;
822 if (filp != fl->fl_file)
824 if (request->fl_type == fl->fl_type)
827 locks_delete_lock(before);
831 if (request->fl_type == F_UNLCK) {
832 if ((request->fl_flags & FL_EXISTS) && !found)
838 * If a higher-priority process was blocked on the old file lock,
839 * give it the opportunity to lock the file.
842 spin_unlock(&inode->i_lock);
844 spin_lock(&inode->i_lock);
848 for_each_lock(inode, before) {
849 struct file_lock *fl = *before;
854 if (!flock_locks_conflict(request, fl))
857 if (!(request->fl_flags & FL_SLEEP))
859 error = FILE_LOCK_DEFERRED;
860 locks_insert_block(fl, request);
863 if (request->fl_flags & FL_ACCESS)
865 locks_copy_lock(new_fl, request);
866 locks_insert_lock(before, new_fl);
871 spin_unlock(&inode->i_lock);
873 locks_free_lock(new_fl);
877 static int __posix_lock_file(struct inode *inode, struct file_lock *request, struct file_lock *conflock)
879 struct file_lock *fl;
880 struct file_lock *new_fl = NULL;
881 struct file_lock *new_fl2 = NULL;
882 struct file_lock *left = NULL;
883 struct file_lock *right = NULL;
884 struct file_lock **before;
889 * We may need two file_lock structures for this operation,
890 * so we get them in advance to avoid races.
892 * In some cases we can be sure, that no new locks will be needed
894 if (!(request->fl_flags & FL_ACCESS) &&
895 (request->fl_type != F_UNLCK ||
896 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
897 new_fl = locks_alloc_lock();
898 new_fl2 = locks_alloc_lock();
901 spin_lock(&inode->i_lock);
903 * New lock request. Walk all POSIX locks and look for conflicts. If
904 * there are any, either return error or put the request on the
905 * blocker's list of waiters and the global blocked_hash.
907 if (request->fl_type != F_UNLCK) {
908 for_each_lock(inode, before) {
912 if (!posix_locks_conflict(request, fl))
915 __locks_copy_lock(conflock, fl);
917 if (!(request->fl_flags & FL_SLEEP))
920 * Deadlock detection and insertion into the blocked
921 * locks list must be done while holding the same lock!
924 spin_lock(&blocked_lock_lock);
925 if (likely(!posix_locks_deadlock(request, fl))) {
926 error = FILE_LOCK_DEFERRED;
927 __locks_insert_block(fl, request);
929 spin_unlock(&blocked_lock_lock);
934 /* If we're just looking for a conflict, we're done. */
936 if (request->fl_flags & FL_ACCESS)
940 * Find the first old lock with the same owner as the new lock.
943 before = &inode->i_flock;
945 /* First skip locks owned by other processes. */
946 while ((fl = *before) && (!IS_POSIX(fl) ||
947 !posix_same_owner(request, fl))) {
948 before = &fl->fl_next;
951 /* Process locks with this owner. */
952 while ((fl = *before) && posix_same_owner(request, fl)) {
953 /* Detect adjacent or overlapping regions (if same lock type)
955 if (request->fl_type == fl->fl_type) {
956 /* In all comparisons of start vs end, use
957 * "start - 1" rather than "end + 1". If end
958 * is OFFSET_MAX, end + 1 will become negative.
960 if (fl->fl_end < request->fl_start - 1)
962 /* If the next lock in the list has entirely bigger
963 * addresses than the new one, insert the lock here.
965 if (fl->fl_start - 1 > request->fl_end)
968 /* If we come here, the new and old lock are of the
969 * same type and adjacent or overlapping. Make one
970 * lock yielding from the lower start address of both
971 * locks to the higher end address.
973 if (fl->fl_start > request->fl_start)
974 fl->fl_start = request->fl_start;
976 request->fl_start = fl->fl_start;
977 if (fl->fl_end < request->fl_end)
978 fl->fl_end = request->fl_end;
980 request->fl_end = fl->fl_end;
982 locks_delete_lock(before);
989 /* Processing for different lock types is a bit
992 if (fl->fl_end < request->fl_start)
994 if (fl->fl_start > request->fl_end)
996 if (request->fl_type == F_UNLCK)
998 if (fl->fl_start < request->fl_start)
1000 /* If the next lock in the list has a higher end
1001 * address than the new one, insert the new one here.
1003 if (fl->fl_end > request->fl_end) {
1007 if (fl->fl_start >= request->fl_start) {
1008 /* The new lock completely replaces an old
1009 * one (This may happen several times).
1012 locks_delete_lock(before);
1015 /* Replace the old lock with the new one.
1016 * Wake up anybody waiting for the old one,
1017 * as the change in lock type might satisfy
1020 locks_wake_up_blocks(fl);
1021 fl->fl_start = request->fl_start;
1022 fl->fl_end = request->fl_end;
1023 fl->fl_type = request->fl_type;
1024 locks_release_private(fl);
1025 locks_copy_private(fl, request);
1030 /* Go on to next lock.
1033 before = &fl->fl_next;
1037 * The above code only modifies existing locks in case of merging or
1038 * replacing. If new lock(s) need to be inserted all modifications are
1039 * done below this, so it's safe yet to bail out.
1041 error = -ENOLCK; /* "no luck" */
1042 if (right && left == right && !new_fl2)
1047 if (request->fl_type == F_UNLCK) {
1048 if (request->fl_flags & FL_EXISTS)
1057 locks_copy_lock(new_fl, request);
1058 locks_insert_lock(before, new_fl);
1062 if (left == right) {
1063 /* The new lock breaks the old one in two pieces,
1064 * so we have to use the second new lock.
1068 locks_copy_lock(left, right);
1069 locks_insert_lock(before, left);
1071 right->fl_start = request->fl_end + 1;
1072 locks_wake_up_blocks(right);
1075 left->fl_end = request->fl_start - 1;
1076 locks_wake_up_blocks(left);
1079 spin_unlock(&inode->i_lock);
1081 * Free any unused locks.
1084 locks_free_lock(new_fl);
1086 locks_free_lock(new_fl2);
1091 * posix_lock_file - Apply a POSIX-style lock to a file
1092 * @filp: The file to apply the lock to
1093 * @fl: The lock to be applied
1094 * @conflock: Place to return a copy of the conflicting lock, if found.
1096 * Add a POSIX style lock to a file.
1097 * We merge adjacent & overlapping locks whenever possible.
1098 * POSIX locks are sorted by owner task, then by starting address
1100 * Note that if called with an FL_EXISTS argument, the caller may determine
1101 * whether or not a lock was successfully freed by testing the return
1102 * value for -ENOENT.
1104 int posix_lock_file(struct file *filp, struct file_lock *fl,
1105 struct file_lock *conflock)
1107 return __posix_lock_file(file_inode(filp), fl, conflock);
1109 EXPORT_SYMBOL(posix_lock_file);
1112 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1113 * @filp: The file to apply the lock to
1114 * @fl: The lock to be applied
1116 * Add a POSIX style lock to a file.
1117 * We merge adjacent & overlapping locks whenever possible.
1118 * POSIX locks are sorted by owner task, then by starting address
1120 int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1125 error = posix_lock_file(filp, fl, NULL);
1126 if (error != FILE_LOCK_DEFERRED)
1128 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1132 locks_delete_block(fl);
1137 EXPORT_SYMBOL(posix_lock_file_wait);
1140 * locks_mandatory_locked - Check for an active lock
1141 * @inode: the file to check
1143 * Searches the inode's list of locks to find any POSIX locks which conflict.
1144 * This function is called from locks_verify_locked() only.
1146 int locks_mandatory_locked(struct inode *inode)
1148 fl_owner_t owner = current->files;
1149 struct file_lock *fl;
1152 * Search the lock list for this inode for any POSIX locks.
1154 spin_lock(&inode->i_lock);
1155 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
1158 if (fl->fl_owner != owner)
1161 spin_unlock(&inode->i_lock);
1162 return fl ? -EAGAIN : 0;
1166 * locks_mandatory_area - Check for a conflicting lock
1167 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1169 * @inode: the file to check
1170 * @filp: how the file was opened (if it was)
1171 * @offset: start of area to check
1172 * @count: length of area to check
1174 * Searches the inode's list of locks to find any POSIX locks which conflict.
1175 * This function is called from rw_verify_area() and
1176 * locks_verify_truncate().
1178 int locks_mandatory_area(int read_write, struct inode *inode,
1179 struct file *filp, loff_t offset,
1182 struct file_lock fl;
1185 locks_init_lock(&fl);
1186 fl.fl_owner = current->files;
1187 fl.fl_pid = current->tgid;
1189 fl.fl_flags = FL_POSIX | FL_ACCESS;
1190 if (filp && !(filp->f_flags & O_NONBLOCK))
1191 fl.fl_flags |= FL_SLEEP;
1192 fl.fl_type = (read_write == FLOCK_VERIFY_WRITE) ? F_WRLCK : F_RDLCK;
1193 fl.fl_start = offset;
1194 fl.fl_end = offset + count - 1;
1197 error = __posix_lock_file(inode, &fl, NULL);
1198 if (error != FILE_LOCK_DEFERRED)
1200 error = wait_event_interruptible(fl.fl_wait, !fl.fl_next);
1203 * If we've been sleeping someone might have
1204 * changed the permissions behind our back.
1206 if (__mandatory_lock(inode))
1210 locks_delete_block(&fl);
1217 EXPORT_SYMBOL(locks_mandatory_area);
1219 static void lease_clear_pending(struct file_lock *fl, int arg)
1223 fl->fl_flags &= ~FL_UNLOCK_PENDING;
1226 fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
1230 /* We already had a lease on this file; just change its type */
1231 int lease_modify(struct file_lock **before, int arg)
1233 struct file_lock *fl = *before;
1234 int error = assign_type(fl, arg);
1238 lease_clear_pending(fl, arg);
1239 locks_wake_up_blocks(fl);
1240 if (arg == F_UNLCK) {
1241 struct file *filp = fl->fl_file;
1244 filp->f_owner.signum = 0;
1245 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
1246 if (fl->fl_fasync != NULL) {
1247 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
1248 fl->fl_fasync = NULL;
1250 locks_delete_lock(before);
1255 EXPORT_SYMBOL(lease_modify);
1257 static bool past_time(unsigned long then)
1260 /* 0 is a special value meaning "this never expires": */
1262 return time_after(jiffies, then);
1265 static void time_out_leases(struct inode *inode)
1267 struct file_lock **before;
1268 struct file_lock *fl;
1270 before = &inode->i_flock;
1271 while ((fl = *before) && IS_LEASE(fl) && lease_breaking(fl)) {
1272 if (past_time(fl->fl_downgrade_time))
1273 lease_modify(before, F_RDLCK);
1274 if (past_time(fl->fl_break_time))
1275 lease_modify(before, F_UNLCK);
1276 if (fl == *before) /* lease_modify may have freed fl */
1277 before = &fl->fl_next;
1282 * __break_lease - revoke all outstanding leases on file
1283 * @inode: the inode of the file to return
1284 * @mode: the open mode (read or write)
1286 * break_lease (inlined for speed) has checked there already is at least
1287 * some kind of lock (maybe a lease) on this file. Leases are broken on
1288 * a call to open() or truncate(). This function can sleep unless you
1289 * specified %O_NONBLOCK to your open().
1291 int __break_lease(struct inode *inode, unsigned int mode)
1294 struct file_lock *new_fl, *flock;
1295 struct file_lock *fl;
1296 unsigned long break_time;
1297 int i_have_this_lease = 0;
1298 int want_write = (mode & O_ACCMODE) != O_RDONLY;
1300 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
1302 return PTR_ERR(new_fl);
1304 spin_lock(&inode->i_lock);
1306 time_out_leases(inode);
1308 flock = inode->i_flock;
1309 if ((flock == NULL) || !IS_LEASE(flock))
1312 if (!locks_conflict(flock, new_fl))
1315 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next)
1316 if (fl->fl_owner == current->files)
1317 i_have_this_lease = 1;
1320 if (lease_break_time > 0) {
1321 break_time = jiffies + lease_break_time * HZ;
1322 if (break_time == 0)
1323 break_time++; /* so that 0 means no break time */
1326 for (fl = flock; fl && IS_LEASE(fl); fl = fl->fl_next) {
1328 if (fl->fl_flags & FL_UNLOCK_PENDING)
1330 fl->fl_flags |= FL_UNLOCK_PENDING;
1331 fl->fl_break_time = break_time;
1333 if (lease_breaking(flock))
1335 fl->fl_flags |= FL_DOWNGRADE_PENDING;
1336 fl->fl_downgrade_time = break_time;
1338 fl->fl_lmops->lm_break(fl);
1341 if (i_have_this_lease || (mode & O_NONBLOCK)) {
1342 error = -EWOULDBLOCK;
1347 break_time = flock->fl_break_time;
1348 if (break_time != 0) {
1349 break_time -= jiffies;
1350 if (break_time == 0)
1353 locks_insert_block(flock, new_fl);
1354 spin_unlock(&inode->i_lock);
1355 error = wait_event_interruptible_timeout(new_fl->fl_wait,
1356 !new_fl->fl_next, break_time);
1357 spin_lock(&inode->i_lock);
1358 locks_delete_block(new_fl);
1361 time_out_leases(inode);
1363 * Wait for the next conflicting lease that has not been
1366 for (flock = inode->i_flock; flock && IS_LEASE(flock);
1367 flock = flock->fl_next) {
1368 if (locks_conflict(new_fl, flock))
1375 spin_unlock(&inode->i_lock);
1376 locks_free_lock(new_fl);
1380 EXPORT_SYMBOL(__break_lease);
1383 * lease_get_mtime - get the last modified time of an inode
1385 * @time: pointer to a timespec which will contain the last modified time
1387 * This is to force NFS clients to flush their caches for files with
1388 * exclusive leases. The justification is that if someone has an
1389 * exclusive lease, then they could be modifying it.
1391 void lease_get_mtime(struct inode *inode, struct timespec *time)
1393 struct file_lock *flock = inode->i_flock;
1394 if (flock && IS_LEASE(flock) && (flock->fl_type == F_WRLCK))
1395 *time = current_fs_time(inode->i_sb);
1397 *time = inode->i_mtime;
1400 EXPORT_SYMBOL(lease_get_mtime);
1403 * fcntl_getlease - Enquire what lease is currently active
1406 * The value returned by this function will be one of
1407 * (if no lease break is pending):
1409 * %F_RDLCK to indicate a shared lease is held.
1411 * %F_WRLCK to indicate an exclusive lease is held.
1413 * %F_UNLCK to indicate no lease is held.
1415 * (if a lease break is pending):
1417 * %F_RDLCK to indicate an exclusive lease needs to be
1418 * changed to a shared lease (or removed).
1420 * %F_UNLCK to indicate the lease needs to be removed.
1422 * XXX: sfr & willy disagree over whether F_INPROGRESS
1423 * should be returned to userspace.
1425 int fcntl_getlease(struct file *filp)
1427 struct file_lock *fl;
1428 struct inode *inode = file_inode(filp);
1431 spin_lock(&inode->i_lock);
1432 time_out_leases(file_inode(filp));
1433 for (fl = file_inode(filp)->i_flock; fl && IS_LEASE(fl);
1435 if (fl->fl_file == filp) {
1436 type = target_leasetype(fl);
1440 spin_unlock(&inode->i_lock);
1444 static int generic_add_lease(struct file *filp, long arg, struct file_lock **flp)
1446 struct file_lock *fl, **before, **my_before = NULL, *lease;
1447 struct dentry *dentry = filp->f_path.dentry;
1448 struct inode *inode = dentry->d_inode;
1454 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
1456 if ((arg == F_WRLCK)
1457 && ((dentry->d_count > 1)
1458 || (atomic_read(&inode->i_count) > 1)))
1462 * At this point, we know that if there is an exclusive
1463 * lease on this file, then we hold it on this filp
1464 * (otherwise our open of this file would have blocked).
1465 * And if we are trying to acquire an exclusive lease,
1466 * then the file is not open by anyone (including us)
1467 * except for this filp.
1470 for (before = &inode->i_flock;
1471 ((fl = *before) != NULL) && IS_LEASE(fl);
1472 before = &fl->fl_next) {
1473 if (fl->fl_file == filp) {
1478 * No exclusive leases if someone else has a lease on
1484 * Modifying our existing lease is OK, but no getting a
1485 * new lease if someone else is opening for write:
1487 if (fl->fl_flags & FL_UNLOCK_PENDING)
1491 if (my_before != NULL) {
1492 error = lease->fl_lmops->lm_change(my_before, arg);
1502 locks_insert_lock(before, lease);
1509 static int generic_delete_lease(struct file *filp, struct file_lock **flp)
1511 struct file_lock *fl, **before;
1512 struct dentry *dentry = filp->f_path.dentry;
1513 struct inode *inode = dentry->d_inode;
1515 for (before = &inode->i_flock;
1516 ((fl = *before) != NULL) && IS_LEASE(fl);
1517 before = &fl->fl_next) {
1518 if (fl->fl_file != filp)
1520 return (*flp)->fl_lmops->lm_change(before, F_UNLCK);
1526 * generic_setlease - sets a lease on an open file
1527 * @filp: file pointer
1528 * @arg: type of lease to obtain
1529 * @flp: input - file_lock to use, output - file_lock inserted
1531 * The (input) flp->fl_lmops->lm_break function is required
1534 * Called with inode->i_lock held.
1536 int generic_setlease(struct file *filp, long arg, struct file_lock **flp)
1538 struct dentry *dentry = filp->f_path.dentry;
1539 struct inode *inode = dentry->d_inode;
1542 if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
1544 if (!S_ISREG(inode->i_mode))
1546 error = security_file_lock(filp, arg);
1550 time_out_leases(inode);
1552 BUG_ON(!(*flp)->fl_lmops->lm_break);
1556 return generic_delete_lease(filp, flp);
1559 return generic_add_lease(filp, arg, flp);
1564 EXPORT_SYMBOL(generic_setlease);
1566 static int __vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
1568 if (filp->f_op && filp->f_op->setlease)
1569 return filp->f_op->setlease(filp, arg, lease);
1571 return generic_setlease(filp, arg, lease);
1575 * vfs_setlease - sets a lease on an open file
1576 * @filp: file pointer
1577 * @arg: type of lease to obtain
1578 * @lease: file_lock to use
1580 * Call this to establish a lease on the file.
1581 * The (*lease)->fl_lmops->lm_break operation must be set; if not,
1582 * break_lease will oops!
1584 * This will call the filesystem's setlease file method, if
1585 * defined. Note that there is no getlease method; instead, the
1586 * filesystem setlease method should call back to setlease() to
1587 * add a lease to the inode's lease list, where fcntl_getlease() can
1588 * find it. Since fcntl_getlease() only reports whether the current
1589 * task holds a lease, a cluster filesystem need only do this for
1590 * leases held by processes on this node.
1592 * There is also no break_lease method; filesystems that
1593 * handle their own leases should break leases themselves from the
1594 * filesystem's open, create, and (on truncate) setattr methods.
1596 * Warning: the only current setlease methods exist only to disable
1597 * leases in certain cases. More vfs changes may be required to
1598 * allow a full filesystem lease implementation.
1601 int vfs_setlease(struct file *filp, long arg, struct file_lock **lease)
1603 struct inode *inode = file_inode(filp);
1606 spin_lock(&inode->i_lock);
1607 error = __vfs_setlease(filp, arg, lease);
1608 spin_unlock(&inode->i_lock);
1612 EXPORT_SYMBOL_GPL(vfs_setlease);
1614 static int do_fcntl_delete_lease(struct file *filp)
1616 struct file_lock fl, *flp = &fl;
1618 lease_init(filp, F_UNLCK, flp);
1620 return vfs_setlease(filp, F_UNLCK, &flp);
1623 static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
1625 struct file_lock *fl, *ret;
1626 struct inode *inode = file_inode(filp);
1627 struct fasync_struct *new;
1630 fl = lease_alloc(filp, arg);
1634 new = fasync_alloc();
1636 locks_free_lock(fl);
1640 spin_lock(&inode->i_lock);
1641 error = __vfs_setlease(filp, arg, &ret);
1643 spin_unlock(&inode->i_lock);
1644 locks_free_lock(fl);
1645 goto out_free_fasync;
1648 locks_free_lock(fl);
1651 * fasync_insert_entry() returns the old entry if any.
1652 * If there was no old entry, then it used 'new' and
1653 * inserted it into the fasync list. Clear new so that
1654 * we don't release it here.
1656 if (!fasync_insert_entry(fd, filp, &ret->fl_fasync, new))
1659 error = __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
1660 spin_unlock(&inode->i_lock);
1669 * fcntl_setlease - sets a lease on an open file
1670 * @fd: open file descriptor
1671 * @filp: file pointer
1672 * @arg: type of lease to obtain
1674 * Call this fcntl to establish a lease on the file.
1675 * Note that you also need to call %F_SETSIG to
1676 * receive a signal when the lease is broken.
1678 int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1681 return do_fcntl_delete_lease(filp);
1682 return do_fcntl_add_lease(fd, filp, arg);
1686 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1687 * @filp: The file to apply the lock to
1688 * @fl: The lock to be applied
1690 * Add a FLOCK style lock to a file.
1692 int flock_lock_file_wait(struct file *filp, struct file_lock *fl)
1697 error = flock_lock_file(filp, fl);
1698 if (error != FILE_LOCK_DEFERRED)
1700 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1704 locks_delete_block(fl);
1710 EXPORT_SYMBOL(flock_lock_file_wait);
1713 * sys_flock: - flock() system call.
1714 * @fd: the file descriptor to lock.
1715 * @cmd: the type of lock to apply.
1717 * Apply a %FL_FLOCK style lock to an open file descriptor.
1718 * The @cmd can be one of
1720 * %LOCK_SH -- a shared lock.
1722 * %LOCK_EX -- an exclusive lock.
1724 * %LOCK_UN -- remove an existing lock.
1726 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1728 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1729 * processes read and write access respectively.
1731 SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
1733 struct fd f = fdget(fd);
1734 struct file_lock *lock;
1735 int can_sleep, unlock;
1742 can_sleep = !(cmd & LOCK_NB);
1744 unlock = (cmd == LOCK_UN);
1746 if (!unlock && !(cmd & LOCK_MAND) &&
1747 !(f.file->f_mode & (FMODE_READ|FMODE_WRITE)))
1750 error = flock_make_lock(f.file, &lock, cmd);
1754 lock->fl_flags |= FL_SLEEP;
1756 error = security_file_lock(f.file, lock->fl_type);
1760 if (f.file->f_op && f.file->f_op->flock)
1761 error = f.file->f_op->flock(f.file,
1762 (can_sleep) ? F_SETLKW : F_SETLK,
1765 error = flock_lock_file_wait(f.file, lock);
1768 locks_free_lock(lock);
1777 * vfs_test_lock - test file byte range lock
1778 * @filp: The file to test lock for
1779 * @fl: The lock to test; also used to hold result
1781 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1782 * setting conf->fl_type to something other than F_UNLCK.
1784 int vfs_test_lock(struct file *filp, struct file_lock *fl)
1786 if (filp->f_op && filp->f_op->lock)
1787 return filp->f_op->lock(filp, F_GETLK, fl);
1788 posix_test_lock(filp, fl);
1791 EXPORT_SYMBOL_GPL(vfs_test_lock);
1793 static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
1795 flock->l_pid = fl->fl_pid;
1796 #if BITS_PER_LONG == 32
1798 * Make sure we can represent the posix lock via
1799 * legacy 32bit flock.
1801 if (fl->fl_start > OFFT_OFFSET_MAX)
1803 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
1806 flock->l_start = fl->fl_start;
1807 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1808 fl->fl_end - fl->fl_start + 1;
1809 flock->l_whence = 0;
1810 flock->l_type = fl->fl_type;
1814 #if BITS_PER_LONG == 32
1815 static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
1817 flock->l_pid = fl->fl_pid;
1818 flock->l_start = fl->fl_start;
1819 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
1820 fl->fl_end - fl->fl_start + 1;
1821 flock->l_whence = 0;
1822 flock->l_type = fl->fl_type;
1826 /* Report the first existing lock that would conflict with l.
1827 * This implements the F_GETLK command of fcntl().
1829 int fcntl_getlk(struct file *filp, struct flock __user *l)
1831 struct file_lock file_lock;
1836 if (copy_from_user(&flock, l, sizeof(flock)))
1839 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
1842 error = flock_to_posix_lock(filp, &file_lock, &flock);
1846 error = vfs_test_lock(filp, &file_lock);
1850 flock.l_type = file_lock.fl_type;
1851 if (file_lock.fl_type != F_UNLCK) {
1852 error = posix_lock_to_flock(&flock, &file_lock);
1857 if (!copy_to_user(l, &flock, sizeof(flock)))
1864 * vfs_lock_file - file byte range lock
1865 * @filp: The file to apply the lock to
1866 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
1867 * @fl: The lock to be applied
1868 * @conf: Place to return a copy of the conflicting lock, if found.
1870 * A caller that doesn't care about the conflicting lock may pass NULL
1871 * as the final argument.
1873 * If the filesystem defines a private ->lock() method, then @conf will
1874 * be left unchanged; so a caller that cares should initialize it to
1875 * some acceptable default.
1877 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
1878 * locks, the ->lock() interface may return asynchronously, before the lock has
1879 * been granted or denied by the underlying filesystem, if (and only if)
1880 * lm_grant is set. Callers expecting ->lock() to return asynchronously
1881 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
1882 * the request is for a blocking lock. When ->lock() does return asynchronously,
1883 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
1884 * request completes.
1885 * If the request is for non-blocking lock the file system should return
1886 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
1887 * with the result. If the request timed out the callback routine will return a
1888 * nonzero return code and the file system should release the lock. The file
1889 * system is also responsible to keep a corresponding posix lock when it
1890 * grants a lock so the VFS can find out which locks are locally held and do
1891 * the correct lock cleanup when required.
1892 * The underlying filesystem must not drop the kernel lock or call
1893 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
1896 int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
1898 if (filp->f_op && filp->f_op->lock)
1899 return filp->f_op->lock(filp, cmd, fl);
1901 return posix_lock_file(filp, fl, conf);
1903 EXPORT_SYMBOL_GPL(vfs_lock_file);
1905 static int do_lock_file_wait(struct file *filp, unsigned int cmd,
1906 struct file_lock *fl)
1910 error = security_file_lock(filp, fl->fl_type);
1915 error = vfs_lock_file(filp, cmd, fl, NULL);
1916 if (error != FILE_LOCK_DEFERRED)
1918 error = wait_event_interruptible(fl->fl_wait, !fl->fl_next);
1922 locks_delete_block(fl);
1929 /* Apply the lock described by l to an open file descriptor.
1930 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1932 int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
1933 struct flock __user *l)
1935 struct file_lock *file_lock = locks_alloc_lock();
1937 struct inode *inode;
1941 if (file_lock == NULL)
1945 * This might block, so we do it before checking the inode.
1948 if (copy_from_user(&flock, l, sizeof(flock)))
1951 inode = file_inode(filp);
1953 /* Don't allow mandatory locks on files that may be memory mapped
1956 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
1962 error = flock_to_posix_lock(filp, file_lock, &flock);
1965 if (cmd == F_SETLKW) {
1966 file_lock->fl_flags |= FL_SLEEP;
1970 switch (flock.l_type) {
1972 if (!(filp->f_mode & FMODE_READ))
1976 if (!(filp->f_mode & FMODE_WRITE))
1986 error = do_lock_file_wait(filp, cmd, file_lock);
1989 * Attempt to detect a close/fcntl race and recover by
1990 * releasing the lock that was just acquired.
1993 * we need that spin_lock here - it prevents reordering between
1994 * update of inode->i_flock and check for it done in close().
1995 * rcu_read_lock() wouldn't do.
1997 spin_lock(¤t->files->file_lock);
1999 spin_unlock(¤t->files->file_lock);
2000 if (!error && f != filp && flock.l_type != F_UNLCK) {
2001 flock.l_type = F_UNLCK;
2006 locks_free_lock(file_lock);
2010 #if BITS_PER_LONG == 32
2011 /* Report the first existing lock that would conflict with l.
2012 * This implements the F_GETLK command of fcntl().
2014 int fcntl_getlk64(struct file *filp, struct flock64 __user *l)
2016 struct file_lock file_lock;
2017 struct flock64 flock;
2021 if (copy_from_user(&flock, l, sizeof(flock)))
2024 if ((flock.l_type != F_RDLCK) && (flock.l_type != F_WRLCK))
2027 error = flock64_to_posix_lock(filp, &file_lock, &flock);
2031 error = vfs_test_lock(filp, &file_lock);
2035 flock.l_type = file_lock.fl_type;
2036 if (file_lock.fl_type != F_UNLCK)
2037 posix_lock_to_flock64(&flock, &file_lock);
2040 if (!copy_to_user(l, &flock, sizeof(flock)))
2047 /* Apply the lock described by l to an open file descriptor.
2048 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2050 int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
2051 struct flock64 __user *l)
2053 struct file_lock *file_lock = locks_alloc_lock();
2054 struct flock64 flock;
2055 struct inode *inode;
2059 if (file_lock == NULL)
2063 * This might block, so we do it before checking the inode.
2066 if (copy_from_user(&flock, l, sizeof(flock)))
2069 inode = file_inode(filp);
2071 /* Don't allow mandatory locks on files that may be memory mapped
2074 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
2080 error = flock64_to_posix_lock(filp, file_lock, &flock);
2083 if (cmd == F_SETLKW64) {
2084 file_lock->fl_flags |= FL_SLEEP;
2088 switch (flock.l_type) {
2090 if (!(filp->f_mode & FMODE_READ))
2094 if (!(filp->f_mode & FMODE_WRITE))
2104 error = do_lock_file_wait(filp, cmd, file_lock);
2107 * Attempt to detect a close/fcntl race and recover by
2108 * releasing the lock that was just acquired.
2110 spin_lock(¤t->files->file_lock);
2112 spin_unlock(¤t->files->file_lock);
2113 if (!error && f != filp && flock.l_type != F_UNLCK) {
2114 flock.l_type = F_UNLCK;
2119 locks_free_lock(file_lock);
2122 #endif /* BITS_PER_LONG == 32 */
2125 * This function is called when the file is being removed
2126 * from the task's fd array. POSIX locks belonging to this task
2127 * are deleted at this time.
2129 void locks_remove_posix(struct file *filp, fl_owner_t owner)
2131 struct file_lock lock;
2134 * If there are no locks held on this file, we don't need to call
2135 * posix_lock_file(). Another process could be setting a lock on this
2136 * file at the same time, but we wouldn't remove that lock anyway.
2138 if (!file_inode(filp)->i_flock)
2141 lock.fl_type = F_UNLCK;
2142 lock.fl_flags = FL_POSIX | FL_CLOSE;
2144 lock.fl_end = OFFSET_MAX;
2145 lock.fl_owner = owner;
2146 lock.fl_pid = current->tgid;
2147 lock.fl_file = filp;
2149 lock.fl_lmops = NULL;
2151 vfs_lock_file(filp, F_SETLK, &lock, NULL);
2153 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2154 lock.fl_ops->fl_release_private(&lock);
2157 EXPORT_SYMBOL(locks_remove_posix);
2160 * This function is called on the last close of an open file.
2162 void locks_remove_flock(struct file *filp)
2164 struct inode * inode = file_inode(filp);
2165 struct file_lock *fl;
2166 struct file_lock **before;
2168 if (!inode->i_flock)
2171 if (filp->f_op && filp->f_op->flock) {
2172 struct file_lock fl = {
2173 .fl_pid = current->tgid,
2175 .fl_flags = FL_FLOCK,
2177 .fl_end = OFFSET_MAX,
2179 filp->f_op->flock(filp, F_SETLKW, &fl);
2180 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2181 fl.fl_ops->fl_release_private(&fl);
2184 spin_lock(&inode->i_lock);
2185 before = &inode->i_flock;
2187 while ((fl = *before) != NULL) {
2188 if (fl->fl_file == filp) {
2190 locks_delete_lock(before);
2194 lease_modify(before, F_UNLCK);
2200 before = &fl->fl_next;
2202 spin_unlock(&inode->i_lock);
2206 * posix_unblock_lock - stop waiting for a file lock
2207 * @waiter: the lock which was waiting
2209 * lockd needs to block waiting for locks.
2212 posix_unblock_lock(struct file_lock *waiter)
2216 spin_lock(&blocked_lock_lock);
2217 if (waiter->fl_next)
2218 __locks_delete_block(waiter);
2221 spin_unlock(&blocked_lock_lock);
2224 EXPORT_SYMBOL(posix_unblock_lock);
2227 * vfs_cancel_lock - file byte range unblock lock
2228 * @filp: The file to apply the unblock to
2229 * @fl: The lock to be unblocked
2231 * Used by lock managers to cancel blocked requests
2233 int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2235 if (filp->f_op && filp->f_op->lock)
2236 return filp->f_op->lock(filp, F_CANCELLK, fl);
2240 EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2242 #ifdef CONFIG_PROC_FS
2243 #include <linux/proc_fs.h>
2244 #include <linux/seq_file.h>
2246 static void lock_get_status(struct seq_file *f, struct file_lock *fl,
2247 loff_t id, char *pfx)
2249 struct inode *inode = NULL;
2250 unsigned int fl_pid;
2253 fl_pid = pid_vnr(fl->fl_nspid);
2255 fl_pid = fl->fl_pid;
2257 if (fl->fl_file != NULL)
2258 inode = file_inode(fl->fl_file);
2260 seq_printf(f, "%lld:%s ", id, pfx);
2262 seq_printf(f, "%6s %s ",
2263 (fl->fl_flags & FL_ACCESS) ? "ACCESS" : "POSIX ",
2264 (inode == NULL) ? "*NOINODE*" :
2265 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
2266 } else if (IS_FLOCK(fl)) {
2267 if (fl->fl_type & LOCK_MAND) {
2268 seq_printf(f, "FLOCK MSNFS ");
2270 seq_printf(f, "FLOCK ADVISORY ");
2272 } else if (IS_LEASE(fl)) {
2273 seq_printf(f, "LEASE ");
2274 if (lease_breaking(fl))
2275 seq_printf(f, "BREAKING ");
2276 else if (fl->fl_file)
2277 seq_printf(f, "ACTIVE ");
2279 seq_printf(f, "BREAKER ");
2281 seq_printf(f, "UNKNOWN UNKNOWN ");
2283 if (fl->fl_type & LOCK_MAND) {
2284 seq_printf(f, "%s ",
2285 (fl->fl_type & LOCK_READ)
2286 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2287 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2289 seq_printf(f, "%s ",
2290 (lease_breaking(fl))
2291 ? (fl->fl_type == F_UNLCK) ? "UNLCK" : "READ "
2292 : (fl->fl_type == F_WRLCK) ? "WRITE" : "READ ");
2295 #ifdef WE_CAN_BREAK_LSLK_NOW
2296 seq_printf(f, "%d %s:%ld ", fl_pid,
2297 inode->i_sb->s_id, inode->i_ino);
2299 /* userspace relies on this representation of dev_t ;-( */
2300 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
2301 MAJOR(inode->i_sb->s_dev),
2302 MINOR(inode->i_sb->s_dev), inode->i_ino);
2305 seq_printf(f, "%d <none>:0 ", fl_pid);
2308 if (fl->fl_end == OFFSET_MAX)
2309 seq_printf(f, "%Ld EOF\n", fl->fl_start);
2311 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
2313 seq_printf(f, "0 EOF\n");
2317 static int locks_show(struct seq_file *f, void *v)
2319 struct file_lock *fl, *bfl;
2321 fl = hlist_entry(v, struct file_lock, fl_link);
2323 lock_get_status(f, fl, *((loff_t *)f->private), "");
2325 list_for_each_entry(bfl, &fl->fl_block, fl_block)
2326 lock_get_status(f, bfl, *((loff_t *)f->private), " ->");
2331 static void *locks_start(struct seq_file *f, loff_t *pos)
2333 loff_t *p = f->private;
2335 spin_lock(&file_lock_lock);
2336 spin_lock(&blocked_lock_lock);
2338 return seq_hlist_start(&file_lock_list, *pos);
2341 static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2343 loff_t *p = f->private;
2345 return seq_hlist_next(v, &file_lock_list, pos);
2348 static void locks_stop(struct seq_file *f, void *v)
2350 spin_unlock(&blocked_lock_lock);
2351 spin_unlock(&file_lock_lock);
2354 static const struct seq_operations locks_seq_operations = {
2355 .start = locks_start,
2361 static int locks_open(struct inode *inode, struct file *filp)
2363 return seq_open_private(filp, &locks_seq_operations, sizeof(loff_t));
2366 static const struct file_operations proc_locks_operations = {
2369 .llseek = seq_lseek,
2370 .release = seq_release_private,
2373 static int __init proc_locks_init(void)
2375 proc_create("locks", 0, NULL, &proc_locks_operations);
2378 module_init(proc_locks_init);
2382 * lock_may_read - checks that the region is free of locks
2383 * @inode: the inode that is being read
2384 * @start: the first byte to read
2385 * @len: the number of bytes to read
2387 * Emulates Windows locking requirements. Whole-file
2388 * mandatory locks (share modes) can prohibit a read and
2389 * byte-range POSIX locks can prohibit a read if they overlap.
2391 * N.B. this function is only ever called
2392 * from knfsd and ownership of locks is never checked.
2394 int lock_may_read(struct inode *inode, loff_t start, unsigned long len)
2396 struct file_lock *fl;
2399 spin_lock(&inode->i_lock);
2400 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2402 if (fl->fl_type == F_RDLCK)
2404 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2406 } else if (IS_FLOCK(fl)) {
2407 if (!(fl->fl_type & LOCK_MAND))
2409 if (fl->fl_type & LOCK_READ)
2416 spin_unlock(&inode->i_lock);
2420 EXPORT_SYMBOL(lock_may_read);
2423 * lock_may_write - checks that the region is free of locks
2424 * @inode: the inode that is being written
2425 * @start: the first byte to write
2426 * @len: the number of bytes to write
2428 * Emulates Windows locking requirements. Whole-file
2429 * mandatory locks (share modes) can prohibit a write and
2430 * byte-range POSIX locks can prohibit a write if they overlap.
2432 * N.B. this function is only ever called
2433 * from knfsd and ownership of locks is never checked.
2435 int lock_may_write(struct inode *inode, loff_t start, unsigned long len)
2437 struct file_lock *fl;
2440 spin_lock(&inode->i_lock);
2441 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
2443 if ((fl->fl_end < start) || (fl->fl_start > (start + len)))
2445 } else if (IS_FLOCK(fl)) {
2446 if (!(fl->fl_type & LOCK_MAND))
2448 if (fl->fl_type & LOCK_WRITE)
2455 spin_unlock(&inode->i_lock);
2459 EXPORT_SYMBOL(lock_may_write);
2461 static int __init filelock_init(void)
2463 filelock_cache = kmem_cache_create("file_lock_cache",
2464 sizeof(struct file_lock), 0, SLAB_PANIC, NULL);
2469 core_initcall(filelock_init);