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>
130 #include <linux/percpu.h>
131 #include <linux/lglock.h>
133 #include <asm/uaccess.h>
135 #define IS_POSIX(fl) (fl->fl_flags & FL_POSIX)
136 #define IS_FLOCK(fl) (fl->fl_flags & FL_FLOCK)
137 #define IS_LEASE(fl) (fl->fl_flags & FL_LEASE)
139 static bool lease_breaking(struct file_lock
*fl
)
141 return fl
->fl_flags
& (FL_UNLOCK_PENDING
| FL_DOWNGRADE_PENDING
);
144 static int target_leasetype(struct file_lock
*fl
)
146 if (fl
->fl_flags
& FL_UNLOCK_PENDING
)
148 if (fl
->fl_flags
& FL_DOWNGRADE_PENDING
)
153 int leases_enable
= 1;
154 int lease_break_time
= 45;
156 #define for_each_lock(inode, lockp) \
157 for (lockp = &inode->i_flock; *lockp != NULL; lockp = &(*lockp)->fl_next)
160 * The global file_lock_list is only used for displaying /proc/locks, so we
161 * keep a list on each CPU, with each list protected by its own spinlock via
162 * the file_lock_lglock. Note that alterations to the list also require that
163 * the relevant i_lock is held.
165 DEFINE_STATIC_LGLOCK(file_lock_lglock
);
166 static DEFINE_PER_CPU(struct hlist_head
, file_lock_list
);
169 * The blocked_hash is used to find POSIX lock loops for deadlock detection.
170 * It is protected by blocked_lock_lock.
172 * We hash locks by lockowner in order to optimize searching for the lock a
173 * particular lockowner is waiting on.
175 * FIXME: make this value scale via some heuristic? We generally will want more
176 * buckets when we have more lockowners holding locks, but that's a little
177 * difficult to determine without knowing what the workload will look like.
179 #define BLOCKED_HASH_BITS 7
180 static DEFINE_HASHTABLE(blocked_hash
, BLOCKED_HASH_BITS
);
183 * This lock protects the blocked_hash. Generally, if you're accessing it, you
184 * want to be holding this lock.
186 * In addition, it also protects the fl->fl_block list, and the fl->fl_next
187 * pointer for file_lock structures that are acting as lock requests (in
188 * contrast to those that are acting as records of acquired locks).
190 * Note that when we acquire this lock in order to change the above fields,
191 * we often hold the i_lock as well. In certain cases, when reading the fields
192 * protected by this lock, we can skip acquiring it iff we already hold the
195 * In particular, adding an entry to the fl_block list requires that you hold
196 * both the i_lock and the blocked_lock_lock (acquired in that order). Deleting
197 * an entry from the list however only requires the file_lock_lock.
199 static DEFINE_SPINLOCK(blocked_lock_lock
);
201 static struct kmem_cache
*filelock_cache __read_mostly
;
203 static void locks_init_lock_heads(struct file_lock
*fl
)
205 INIT_HLIST_NODE(&fl
->fl_link
);
206 INIT_LIST_HEAD(&fl
->fl_block
);
207 init_waitqueue_head(&fl
->fl_wait
);
210 /* Allocate an empty lock structure. */
211 struct file_lock
*locks_alloc_lock(void)
213 struct file_lock
*fl
= kmem_cache_zalloc(filelock_cache
, GFP_KERNEL
);
216 locks_init_lock_heads(fl
);
220 EXPORT_SYMBOL_GPL(locks_alloc_lock
);
222 void locks_release_private(struct file_lock
*fl
)
225 if (fl
->fl_ops
->fl_release_private
)
226 fl
->fl_ops
->fl_release_private(fl
);
232 EXPORT_SYMBOL_GPL(locks_release_private
);
234 /* Free a lock which is not in use. */
235 void locks_free_lock(struct file_lock
*fl
)
237 BUG_ON(waitqueue_active(&fl
->fl_wait
));
238 BUG_ON(!list_empty(&fl
->fl_block
));
239 BUG_ON(!hlist_unhashed(&fl
->fl_link
));
241 locks_release_private(fl
);
242 kmem_cache_free(filelock_cache
, fl
);
244 EXPORT_SYMBOL(locks_free_lock
);
246 void locks_init_lock(struct file_lock
*fl
)
248 memset(fl
, 0, sizeof(struct file_lock
));
249 locks_init_lock_heads(fl
);
252 EXPORT_SYMBOL(locks_init_lock
);
254 static void locks_copy_private(struct file_lock
*new, struct file_lock
*fl
)
257 if (fl
->fl_ops
->fl_copy_lock
)
258 fl
->fl_ops
->fl_copy_lock(new, fl
);
259 new->fl_ops
= fl
->fl_ops
;
262 new->fl_lmops
= fl
->fl_lmops
;
266 * Initialize a new lock from an existing file_lock structure.
268 void __locks_copy_lock(struct file_lock
*new, const struct file_lock
*fl
)
270 new->fl_owner
= fl
->fl_owner
;
271 new->fl_pid
= fl
->fl_pid
;
273 new->fl_flags
= fl
->fl_flags
;
274 new->fl_type
= fl
->fl_type
;
275 new->fl_start
= fl
->fl_start
;
276 new->fl_end
= fl
->fl_end
;
278 new->fl_lmops
= NULL
;
280 EXPORT_SYMBOL(__locks_copy_lock
);
282 void locks_copy_lock(struct file_lock
*new, struct file_lock
*fl
)
284 locks_release_private(new);
286 __locks_copy_lock(new, fl
);
287 new->fl_file
= fl
->fl_file
;
288 new->fl_ops
= fl
->fl_ops
;
289 new->fl_lmops
= fl
->fl_lmops
;
291 locks_copy_private(new, fl
);
294 EXPORT_SYMBOL(locks_copy_lock
);
296 static inline int flock_translate_cmd(int cmd
) {
298 return cmd
& (LOCK_MAND
| LOCK_RW
);
310 /* Fill in a file_lock structure with an appropriate FLOCK lock. */
311 static int flock_make_lock(struct file
*filp
, struct file_lock
**lock
,
314 struct file_lock
*fl
;
315 int type
= flock_translate_cmd(cmd
);
319 fl
= locks_alloc_lock();
324 fl
->fl_pid
= current
->tgid
;
325 fl
->fl_flags
= FL_FLOCK
;
327 fl
->fl_end
= OFFSET_MAX
;
333 static int assign_type(struct file_lock
*fl
, long type
)
347 /* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
350 static int flock_to_posix_lock(struct file
*filp
, struct file_lock
*fl
,
355 switch (l
->l_whence
) {
363 start
= i_size_read(file_inode(filp
));
369 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
370 POSIX-2001 defines it. */
374 fl
->fl_end
= OFFSET_MAX
;
376 end
= start
+ l
->l_len
- 1;
378 } else if (l
->l_len
< 0) {
385 fl
->fl_start
= start
; /* we record the absolute position */
386 if (fl
->fl_end
< fl
->fl_start
)
389 fl
->fl_owner
= current
->files
;
390 fl
->fl_pid
= current
->tgid
;
392 fl
->fl_flags
= FL_POSIX
;
396 return assign_type(fl
, l
->l_type
);
399 #if BITS_PER_LONG == 32
400 static int flock64_to_posix_lock(struct file
*filp
, struct file_lock
*fl
,
405 switch (l
->l_whence
) {
413 start
= i_size_read(file_inode(filp
));
422 fl
->fl_end
= OFFSET_MAX
;
424 fl
->fl_end
= start
+ l
->l_len
- 1;
425 } else if (l
->l_len
< 0) {
426 fl
->fl_end
= start
- 1;
431 fl
->fl_start
= start
; /* we record the absolute position */
432 if (fl
->fl_end
< fl
->fl_start
)
435 fl
->fl_owner
= current
->files
;
436 fl
->fl_pid
= current
->tgid
;
438 fl
->fl_flags
= FL_POSIX
;
442 return assign_type(fl
, l
->l_type
);
446 /* default lease lock manager operations */
447 static void lease_break_callback(struct file_lock
*fl
)
449 kill_fasync(&fl
->fl_fasync
, SIGIO
, POLL_MSG
);
452 static const struct lock_manager_operations lease_manager_ops
= {
453 .lm_break
= lease_break_callback
,
454 .lm_change
= lease_modify
,
458 * Initialize a lease, use the default lock manager operations
460 static int lease_init(struct file
*filp
, long type
, struct file_lock
*fl
)
462 if (assign_type(fl
, type
) != 0)
465 fl
->fl_owner
= current
->files
;
466 fl
->fl_pid
= current
->tgid
;
469 fl
->fl_flags
= FL_LEASE
;
471 fl
->fl_end
= OFFSET_MAX
;
473 fl
->fl_lmops
= &lease_manager_ops
;
477 /* Allocate a file_lock initialised to this type of lease */
478 static struct file_lock
*lease_alloc(struct file
*filp
, long type
)
480 struct file_lock
*fl
= locks_alloc_lock();
484 return ERR_PTR(error
);
486 error
= lease_init(filp
, type
, fl
);
489 return ERR_PTR(error
);
494 /* Check if two locks overlap each other.
496 static inline int locks_overlap(struct file_lock
*fl1
, struct file_lock
*fl2
)
498 return ((fl1
->fl_end
>= fl2
->fl_start
) &&
499 (fl2
->fl_end
>= fl1
->fl_start
));
503 * Check whether two locks have the same owner.
505 static int posix_same_owner(struct file_lock
*fl1
, struct file_lock
*fl2
)
507 if (fl1
->fl_lmops
&& fl1
->fl_lmops
->lm_compare_owner
)
508 return fl2
->fl_lmops
== fl1
->fl_lmops
&&
509 fl1
->fl_lmops
->lm_compare_owner(fl1
, fl2
);
510 return fl1
->fl_owner
== fl2
->fl_owner
;
513 /* Must be called with the i_lock held! */
515 locks_insert_global_locks(struct file_lock
*fl
)
517 lg_local_lock(&file_lock_lglock
);
518 fl
->fl_link_cpu
= smp_processor_id();
519 hlist_add_head(&fl
->fl_link
, this_cpu_ptr(&file_lock_list
));
520 lg_local_unlock(&file_lock_lglock
);
523 /* Must be called with the i_lock held! */
525 locks_delete_global_locks(struct file_lock
*fl
)
528 * Avoid taking lock if already unhashed. This is safe since this check
529 * is done while holding the i_lock, and new insertions into the list
530 * also require that it be held.
532 if (hlist_unhashed(&fl
->fl_link
))
534 lg_local_lock_cpu(&file_lock_lglock
, fl
->fl_link_cpu
);
535 hlist_del_init(&fl
->fl_link
);
536 lg_local_unlock_cpu(&file_lock_lglock
, fl
->fl_link_cpu
);
540 posix_owner_key(struct file_lock
*fl
)
542 if (fl
->fl_lmops
&& fl
->fl_lmops
->lm_owner_key
)
543 return fl
->fl_lmops
->lm_owner_key(fl
);
544 return (unsigned long)fl
->fl_owner
;
548 locks_insert_global_blocked(struct file_lock
*waiter
)
550 hash_add(blocked_hash
, &waiter
->fl_link
, posix_owner_key(waiter
));
554 locks_delete_global_blocked(struct file_lock
*waiter
)
556 hash_del(&waiter
->fl_link
);
559 /* Remove waiter from blocker's block list.
560 * When blocker ends up pointing to itself then the list is empty.
562 * Must be called with blocked_lock_lock held.
564 static void __locks_delete_block(struct file_lock
*waiter
)
566 locks_delete_global_blocked(waiter
);
567 list_del_init(&waiter
->fl_block
);
568 waiter
->fl_next
= NULL
;
571 static void locks_delete_block(struct file_lock
*waiter
)
573 spin_lock(&blocked_lock_lock
);
574 __locks_delete_block(waiter
);
575 spin_unlock(&blocked_lock_lock
);
578 /* Insert waiter into blocker's block list.
579 * We use a circular list so that processes can be easily woken up in
580 * the order they blocked. The documentation doesn't require this but
581 * it seems like the reasonable thing to do.
583 * Must be called with both the i_lock and blocked_lock_lock held. The fl_block
584 * list itself is protected by the file_lock_list, but by ensuring that the
585 * i_lock is also held on insertions we can avoid taking the blocked_lock_lock
586 * in some cases when we see that the fl_block list is empty.
588 static void __locks_insert_block(struct file_lock
*blocker
,
589 struct file_lock
*waiter
)
591 BUG_ON(!list_empty(&waiter
->fl_block
));
592 waiter
->fl_next
= blocker
;
593 list_add_tail(&waiter
->fl_block
, &blocker
->fl_block
);
594 if (IS_POSIX(blocker
))
595 locks_insert_global_blocked(waiter
);
598 /* Must be called with i_lock held. */
599 static void locks_insert_block(struct file_lock
*blocker
,
600 struct file_lock
*waiter
)
602 spin_lock(&blocked_lock_lock
);
603 __locks_insert_block(blocker
, waiter
);
604 spin_unlock(&blocked_lock_lock
);
608 * Wake up processes blocked waiting for blocker.
610 * Must be called with the inode->i_lock held!
612 static void locks_wake_up_blocks(struct file_lock
*blocker
)
615 * Avoid taking global lock if list is empty. This is safe since new
616 * blocked requests are only added to the list under the i_lock, and
617 * the i_lock is always held here. Note that removal from the fl_block
618 * list does not require the i_lock, so we must recheck list_empty()
619 * after acquiring the blocked_lock_lock.
621 if (list_empty(&blocker
->fl_block
))
624 spin_lock(&blocked_lock_lock
);
625 while (!list_empty(&blocker
->fl_block
)) {
626 struct file_lock
*waiter
;
628 waiter
= list_first_entry(&blocker
->fl_block
,
629 struct file_lock
, fl_block
);
630 __locks_delete_block(waiter
);
631 if (waiter
->fl_lmops
&& waiter
->fl_lmops
->lm_notify
)
632 waiter
->fl_lmops
->lm_notify(waiter
);
634 wake_up(&waiter
->fl_wait
);
636 spin_unlock(&blocked_lock_lock
);
639 /* Insert file lock fl into an inode's lock list at the position indicated
640 * by pos. At the same time add the lock to the global file lock list.
642 * Must be called with the i_lock held!
644 static void locks_insert_lock(struct file_lock
**pos
, struct file_lock
*fl
)
646 fl
->fl_nspid
= get_pid(task_tgid(current
));
648 /* insert into file's list */
652 locks_insert_global_locks(fl
);
656 * Delete a lock and then free it.
657 * Wake up processes that are blocked waiting for this lock,
658 * notify the FS that the lock has been cleared and
659 * finally free the lock.
661 * Must be called with the i_lock held!
663 static void locks_delete_lock(struct file_lock
**thisfl_p
)
665 struct file_lock
*fl
= *thisfl_p
;
667 locks_delete_global_locks(fl
);
669 *thisfl_p
= fl
->fl_next
;
673 put_pid(fl
->fl_nspid
);
677 locks_wake_up_blocks(fl
);
681 /* Determine if lock sys_fl blocks lock caller_fl. Common functionality
682 * checks for shared/exclusive status of overlapping locks.
684 static int locks_conflict(struct file_lock
*caller_fl
, struct file_lock
*sys_fl
)
686 if (sys_fl
->fl_type
== F_WRLCK
)
688 if (caller_fl
->fl_type
== F_WRLCK
)
693 /* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
694 * checking before calling the locks_conflict().
696 static int posix_locks_conflict(struct file_lock
*caller_fl
, struct file_lock
*sys_fl
)
698 /* POSIX locks owned by the same process do not conflict with
701 if (!IS_POSIX(sys_fl
) || posix_same_owner(caller_fl
, sys_fl
))
704 /* Check whether they overlap */
705 if (!locks_overlap(caller_fl
, sys_fl
))
708 return (locks_conflict(caller_fl
, sys_fl
));
711 /* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
712 * checking before calling the locks_conflict().
714 static int flock_locks_conflict(struct file_lock
*caller_fl
, struct file_lock
*sys_fl
)
716 /* FLOCK locks referring to the same filp do not conflict with
719 if (!IS_FLOCK(sys_fl
) || (caller_fl
->fl_file
== sys_fl
->fl_file
))
721 if ((caller_fl
->fl_type
& LOCK_MAND
) || (sys_fl
->fl_type
& LOCK_MAND
))
724 return (locks_conflict(caller_fl
, sys_fl
));
728 posix_test_lock(struct file
*filp
, struct file_lock
*fl
)
730 struct file_lock
*cfl
;
731 struct inode
*inode
= file_inode(filp
);
733 spin_lock(&inode
->i_lock
);
734 for (cfl
= file_inode(filp
)->i_flock
; cfl
; cfl
= cfl
->fl_next
) {
737 if (posix_locks_conflict(fl
, cfl
))
741 __locks_copy_lock(fl
, cfl
);
743 fl
->fl_pid
= pid_vnr(cfl
->fl_nspid
);
745 fl
->fl_type
= F_UNLCK
;
746 spin_unlock(&inode
->i_lock
);
749 EXPORT_SYMBOL(posix_test_lock
);
752 * Deadlock detection:
754 * We attempt to detect deadlocks that are due purely to posix file
757 * We assume that a task can be waiting for at most one lock at a time.
758 * So for any acquired lock, the process holding that lock may be
759 * waiting on at most one other lock. That lock in turns may be held by
760 * someone waiting for at most one other lock. Given a requested lock
761 * caller_fl which is about to wait for a conflicting lock block_fl, we
762 * follow this chain of waiters to ensure we are not about to create a
765 * Since we do this before we ever put a process to sleep on a lock, we
766 * are ensured that there is never a cycle; that is what guarantees that
767 * the while() loop in posix_locks_deadlock() eventually completes.
769 * Note: the above assumption may not be true when handling lock
770 * requests from a broken NFS client. It may also fail in the presence
771 * of tasks (such as posix threads) sharing the same open file table.
773 * To handle those cases, we just bail out after a few iterations.
776 #define MAX_DEADLK_ITERATIONS 10
778 /* Find a lock that the owner of the given block_fl is blocking on. */
779 static struct file_lock
*what_owner_is_waiting_for(struct file_lock
*block_fl
)
781 struct file_lock
*fl
;
783 hash_for_each_possible(blocked_hash
, fl
, fl_link
, posix_owner_key(block_fl
)) {
784 if (posix_same_owner(fl
, block_fl
))
790 /* Must be called with the blocked_lock_lock held! */
791 static int posix_locks_deadlock(struct file_lock
*caller_fl
,
792 struct file_lock
*block_fl
)
796 while ((block_fl
= what_owner_is_waiting_for(block_fl
))) {
797 if (i
++ > MAX_DEADLK_ITERATIONS
)
799 if (posix_same_owner(caller_fl
, block_fl
))
805 /* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
806 * after any leases, but before any posix locks.
808 * Note that if called with an FL_EXISTS argument, the caller may determine
809 * whether or not a lock was successfully freed by testing the return
812 static int flock_lock_file(struct file
*filp
, struct file_lock
*request
)
814 struct file_lock
*new_fl
= NULL
;
815 struct file_lock
**before
;
816 struct inode
* inode
= file_inode(filp
);
820 if (!(request
->fl_flags
& FL_ACCESS
) && (request
->fl_type
!= F_UNLCK
)) {
821 new_fl
= locks_alloc_lock();
826 spin_lock(&inode
->i_lock
);
827 if (request
->fl_flags
& FL_ACCESS
)
830 for_each_lock(inode
, before
) {
831 struct file_lock
*fl
= *before
;
836 if (filp
!= fl
->fl_file
)
838 if (request
->fl_type
== fl
->fl_type
)
841 locks_delete_lock(before
);
845 if (request
->fl_type
== F_UNLCK
) {
846 if ((request
->fl_flags
& FL_EXISTS
) && !found
)
852 * If a higher-priority process was blocked on the old file lock,
853 * give it the opportunity to lock the file.
856 spin_unlock(&inode
->i_lock
);
858 spin_lock(&inode
->i_lock
);
862 for_each_lock(inode
, before
) {
863 struct file_lock
*fl
= *before
;
868 if (!flock_locks_conflict(request
, fl
))
871 if (!(request
->fl_flags
& FL_SLEEP
))
873 error
= FILE_LOCK_DEFERRED
;
874 locks_insert_block(fl
, request
);
877 if (request
->fl_flags
& FL_ACCESS
)
879 locks_copy_lock(new_fl
, request
);
880 locks_insert_lock(before
, new_fl
);
885 spin_unlock(&inode
->i_lock
);
887 locks_free_lock(new_fl
);
891 static int __posix_lock_file(struct inode
*inode
, struct file_lock
*request
, struct file_lock
*conflock
)
893 struct file_lock
*fl
;
894 struct file_lock
*new_fl
= NULL
;
895 struct file_lock
*new_fl2
= NULL
;
896 struct file_lock
*left
= NULL
;
897 struct file_lock
*right
= NULL
;
898 struct file_lock
**before
;
903 * We may need two file_lock structures for this operation,
904 * so we get them in advance to avoid races.
906 * In some cases we can be sure, that no new locks will be needed
908 if (!(request
->fl_flags
& FL_ACCESS
) &&
909 (request
->fl_type
!= F_UNLCK
||
910 request
->fl_start
!= 0 || request
->fl_end
!= OFFSET_MAX
)) {
911 new_fl
= locks_alloc_lock();
912 new_fl2
= locks_alloc_lock();
915 spin_lock(&inode
->i_lock
);
917 * New lock request. Walk all POSIX locks and look for conflicts. If
918 * there are any, either return error or put the request on the
919 * blocker's list of waiters and the global blocked_hash.
921 if (request
->fl_type
!= F_UNLCK
) {
922 for_each_lock(inode
, before
) {
926 if (!posix_locks_conflict(request
, fl
))
929 __locks_copy_lock(conflock
, fl
);
931 if (!(request
->fl_flags
& FL_SLEEP
))
934 * Deadlock detection and insertion into the blocked
935 * locks list must be done while holding the same lock!
938 spin_lock(&blocked_lock_lock
);
939 if (likely(!posix_locks_deadlock(request
, fl
))) {
940 error
= FILE_LOCK_DEFERRED
;
941 __locks_insert_block(fl
, request
);
943 spin_unlock(&blocked_lock_lock
);
948 /* If we're just looking for a conflict, we're done. */
950 if (request
->fl_flags
& FL_ACCESS
)
954 * Find the first old lock with the same owner as the new lock.
957 before
= &inode
->i_flock
;
959 /* First skip locks owned by other processes. */
960 while ((fl
= *before
) && (!IS_POSIX(fl
) ||
961 !posix_same_owner(request
, fl
))) {
962 before
= &fl
->fl_next
;
965 /* Process locks with this owner. */
966 while ((fl
= *before
) && posix_same_owner(request
, fl
)) {
967 /* Detect adjacent or overlapping regions (if same lock type)
969 if (request
->fl_type
== fl
->fl_type
) {
970 /* In all comparisons of start vs end, use
971 * "start - 1" rather than "end + 1". If end
972 * is OFFSET_MAX, end + 1 will become negative.
974 if (fl
->fl_end
< request
->fl_start
- 1)
976 /* If the next lock in the list has entirely bigger
977 * addresses than the new one, insert the lock here.
979 if (fl
->fl_start
- 1 > request
->fl_end
)
982 /* If we come here, the new and old lock are of the
983 * same type and adjacent or overlapping. Make one
984 * lock yielding from the lower start address of both
985 * locks to the higher end address.
987 if (fl
->fl_start
> request
->fl_start
)
988 fl
->fl_start
= request
->fl_start
;
990 request
->fl_start
= fl
->fl_start
;
991 if (fl
->fl_end
< request
->fl_end
)
992 fl
->fl_end
= request
->fl_end
;
994 request
->fl_end
= fl
->fl_end
;
996 locks_delete_lock(before
);
1003 /* Processing for different lock types is a bit
1006 if (fl
->fl_end
< request
->fl_start
)
1008 if (fl
->fl_start
> request
->fl_end
)
1010 if (request
->fl_type
== F_UNLCK
)
1012 if (fl
->fl_start
< request
->fl_start
)
1014 /* If the next lock in the list has a higher end
1015 * address than the new one, insert the new one here.
1017 if (fl
->fl_end
> request
->fl_end
) {
1021 if (fl
->fl_start
>= request
->fl_start
) {
1022 /* The new lock completely replaces an old
1023 * one (This may happen several times).
1026 locks_delete_lock(before
);
1029 /* Replace the old lock with the new one.
1030 * Wake up anybody waiting for the old one,
1031 * as the change in lock type might satisfy
1034 locks_wake_up_blocks(fl
);
1035 fl
->fl_start
= request
->fl_start
;
1036 fl
->fl_end
= request
->fl_end
;
1037 fl
->fl_type
= request
->fl_type
;
1038 locks_release_private(fl
);
1039 locks_copy_private(fl
, request
);
1044 /* Go on to next lock.
1047 before
= &fl
->fl_next
;
1051 * The above code only modifies existing locks in case of merging or
1052 * replacing. If new lock(s) need to be inserted all modifications are
1053 * done below this, so it's safe yet to bail out.
1055 error
= -ENOLCK
; /* "no luck" */
1056 if (right
&& left
== right
&& !new_fl2
)
1061 if (request
->fl_type
== F_UNLCK
) {
1062 if (request
->fl_flags
& FL_EXISTS
)
1071 locks_copy_lock(new_fl
, request
);
1072 locks_insert_lock(before
, new_fl
);
1076 if (left
== right
) {
1077 /* The new lock breaks the old one in two pieces,
1078 * so we have to use the second new lock.
1082 locks_copy_lock(left
, right
);
1083 locks_insert_lock(before
, left
);
1085 right
->fl_start
= request
->fl_end
+ 1;
1086 locks_wake_up_blocks(right
);
1089 left
->fl_end
= request
->fl_start
- 1;
1090 locks_wake_up_blocks(left
);
1093 spin_unlock(&inode
->i_lock
);
1095 * Free any unused locks.
1098 locks_free_lock(new_fl
);
1100 locks_free_lock(new_fl2
);
1105 * posix_lock_file - Apply a POSIX-style lock to a file
1106 * @filp: The file to apply the lock to
1107 * @fl: The lock to be applied
1108 * @conflock: Place to return a copy of the conflicting lock, if found.
1110 * Add a POSIX style lock to a file.
1111 * We merge adjacent & overlapping locks whenever possible.
1112 * POSIX locks are sorted by owner task, then by starting address
1114 * Note that if called with an FL_EXISTS argument, the caller may determine
1115 * whether or not a lock was successfully freed by testing the return
1116 * value for -ENOENT.
1118 int posix_lock_file(struct file
*filp
, struct file_lock
*fl
,
1119 struct file_lock
*conflock
)
1121 return __posix_lock_file(file_inode(filp
), fl
, conflock
);
1123 EXPORT_SYMBOL(posix_lock_file
);
1126 * posix_lock_file_wait - Apply a POSIX-style lock to a file
1127 * @filp: The file to apply the lock to
1128 * @fl: The lock to be applied
1130 * Add a POSIX style lock to a file.
1131 * We merge adjacent & overlapping locks whenever possible.
1132 * POSIX locks are sorted by owner task, then by starting address
1134 int posix_lock_file_wait(struct file
*filp
, struct file_lock
*fl
)
1139 error
= posix_lock_file(filp
, fl
, NULL
);
1140 if (error
!= FILE_LOCK_DEFERRED
)
1142 error
= wait_event_interruptible(fl
->fl_wait
, !fl
->fl_next
);
1146 locks_delete_block(fl
);
1151 EXPORT_SYMBOL(posix_lock_file_wait
);
1154 * locks_mandatory_locked - Check for an active lock
1155 * @inode: the file to check
1157 * Searches the inode's list of locks to find any POSIX locks which conflict.
1158 * This function is called from locks_verify_locked() only.
1160 int locks_mandatory_locked(struct inode
*inode
)
1162 fl_owner_t owner
= current
->files
;
1163 struct file_lock
*fl
;
1166 * Search the lock list for this inode for any POSIX locks.
1168 spin_lock(&inode
->i_lock
);
1169 for (fl
= inode
->i_flock
; fl
!= NULL
; fl
= fl
->fl_next
) {
1172 if (fl
->fl_owner
!= owner
)
1175 spin_unlock(&inode
->i_lock
);
1176 return fl
? -EAGAIN
: 0;
1180 * locks_mandatory_area - Check for a conflicting lock
1181 * @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
1183 * @inode: the file to check
1184 * @filp: how the file was opened (if it was)
1185 * @offset: start of area to check
1186 * @count: length of area to check
1188 * Searches the inode's list of locks to find any POSIX locks which conflict.
1189 * This function is called from rw_verify_area() and
1190 * locks_verify_truncate().
1192 int locks_mandatory_area(int read_write
, struct inode
*inode
,
1193 struct file
*filp
, loff_t offset
,
1196 struct file_lock fl
;
1199 locks_init_lock(&fl
);
1200 fl
.fl_owner
= current
->files
;
1201 fl
.fl_pid
= current
->tgid
;
1203 fl
.fl_flags
= FL_POSIX
| FL_ACCESS
;
1204 if (filp
&& !(filp
->f_flags
& O_NONBLOCK
))
1205 fl
.fl_flags
|= FL_SLEEP
;
1206 fl
.fl_type
= (read_write
== FLOCK_VERIFY_WRITE
) ? F_WRLCK
: F_RDLCK
;
1207 fl
.fl_start
= offset
;
1208 fl
.fl_end
= offset
+ count
- 1;
1211 error
= __posix_lock_file(inode
, &fl
, NULL
);
1212 if (error
!= FILE_LOCK_DEFERRED
)
1214 error
= wait_event_interruptible(fl
.fl_wait
, !fl
.fl_next
);
1217 * If we've been sleeping someone might have
1218 * changed the permissions behind our back.
1220 if (__mandatory_lock(inode
))
1224 locks_delete_block(&fl
);
1231 EXPORT_SYMBOL(locks_mandatory_area
);
1233 static void lease_clear_pending(struct file_lock
*fl
, int arg
)
1237 fl
->fl_flags
&= ~FL_UNLOCK_PENDING
;
1240 fl
->fl_flags
&= ~FL_DOWNGRADE_PENDING
;
1244 /* We already had a lease on this file; just change its type */
1245 int lease_modify(struct file_lock
**before
, int arg
)
1247 struct file_lock
*fl
= *before
;
1248 int error
= assign_type(fl
, arg
);
1252 lease_clear_pending(fl
, arg
);
1253 locks_wake_up_blocks(fl
);
1254 if (arg
== F_UNLCK
) {
1255 struct file
*filp
= fl
->fl_file
;
1258 filp
->f_owner
.signum
= 0;
1259 fasync_helper(0, fl
->fl_file
, 0, &fl
->fl_fasync
);
1260 if (fl
->fl_fasync
!= NULL
) {
1261 printk(KERN_ERR
"locks_delete_lock: fasync == %p\n", fl
->fl_fasync
);
1262 fl
->fl_fasync
= NULL
;
1264 locks_delete_lock(before
);
1269 EXPORT_SYMBOL(lease_modify
);
1271 static bool past_time(unsigned long then
)
1274 /* 0 is a special value meaning "this never expires": */
1276 return time_after(jiffies
, then
);
1279 static void time_out_leases(struct inode
*inode
)
1281 struct file_lock
**before
;
1282 struct file_lock
*fl
;
1284 before
= &inode
->i_flock
;
1285 while ((fl
= *before
) && IS_LEASE(fl
) && lease_breaking(fl
)) {
1286 if (past_time(fl
->fl_downgrade_time
))
1287 lease_modify(before
, F_RDLCK
);
1288 if (past_time(fl
->fl_break_time
))
1289 lease_modify(before
, F_UNLCK
);
1290 if (fl
== *before
) /* lease_modify may have freed fl */
1291 before
= &fl
->fl_next
;
1296 * __break_lease - revoke all outstanding leases on file
1297 * @inode: the inode of the file to return
1298 * @mode: the open mode (read or write)
1300 * break_lease (inlined for speed) has checked there already is at least
1301 * some kind of lock (maybe a lease) on this file. Leases are broken on
1302 * a call to open() or truncate(). This function can sleep unless you
1303 * specified %O_NONBLOCK to your open().
1305 int __break_lease(struct inode
*inode
, unsigned int mode
)
1308 struct file_lock
*new_fl
, *flock
;
1309 struct file_lock
*fl
;
1310 unsigned long break_time
;
1311 int i_have_this_lease
= 0;
1312 int want_write
= (mode
& O_ACCMODE
) != O_RDONLY
;
1314 new_fl
= lease_alloc(NULL
, want_write
? F_WRLCK
: F_RDLCK
);
1316 return PTR_ERR(new_fl
);
1318 spin_lock(&inode
->i_lock
);
1320 time_out_leases(inode
);
1322 flock
= inode
->i_flock
;
1323 if ((flock
== NULL
) || !IS_LEASE(flock
))
1326 if (!locks_conflict(flock
, new_fl
))
1329 for (fl
= flock
; fl
&& IS_LEASE(fl
); fl
= fl
->fl_next
)
1330 if (fl
->fl_owner
== current
->files
)
1331 i_have_this_lease
= 1;
1334 if (lease_break_time
> 0) {
1335 break_time
= jiffies
+ lease_break_time
* HZ
;
1336 if (break_time
== 0)
1337 break_time
++; /* so that 0 means no break time */
1340 for (fl
= flock
; fl
&& IS_LEASE(fl
); fl
= fl
->fl_next
) {
1342 if (fl
->fl_flags
& FL_UNLOCK_PENDING
)
1344 fl
->fl_flags
|= FL_UNLOCK_PENDING
;
1345 fl
->fl_break_time
= break_time
;
1347 if (lease_breaking(flock
))
1349 fl
->fl_flags
|= FL_DOWNGRADE_PENDING
;
1350 fl
->fl_downgrade_time
= break_time
;
1352 fl
->fl_lmops
->lm_break(fl
);
1355 if (i_have_this_lease
|| (mode
& O_NONBLOCK
)) {
1356 error
= -EWOULDBLOCK
;
1361 break_time
= flock
->fl_break_time
;
1362 if (break_time
!= 0)
1363 break_time
-= jiffies
;
1364 if (break_time
== 0)
1366 locks_insert_block(flock
, new_fl
);
1367 spin_unlock(&inode
->i_lock
);
1368 error
= wait_event_interruptible_timeout(new_fl
->fl_wait
,
1369 !new_fl
->fl_next
, break_time
);
1370 spin_lock(&inode
->i_lock
);
1371 locks_delete_block(new_fl
);
1374 time_out_leases(inode
);
1376 * Wait for the next conflicting lease that has not been
1379 for (flock
= inode
->i_flock
; flock
&& IS_LEASE(flock
);
1380 flock
= flock
->fl_next
) {
1381 if (locks_conflict(new_fl
, flock
))
1388 spin_unlock(&inode
->i_lock
);
1389 locks_free_lock(new_fl
);
1393 EXPORT_SYMBOL(__break_lease
);
1396 * lease_get_mtime - get the last modified time of an inode
1398 * @time: pointer to a timespec which will contain the last modified time
1400 * This is to force NFS clients to flush their caches for files with
1401 * exclusive leases. The justification is that if someone has an
1402 * exclusive lease, then they could be modifying it.
1404 void lease_get_mtime(struct inode
*inode
, struct timespec
*time
)
1406 struct file_lock
*flock
= inode
->i_flock
;
1407 if (flock
&& IS_LEASE(flock
) && (flock
->fl_type
== F_WRLCK
))
1408 *time
= current_fs_time(inode
->i_sb
);
1410 *time
= inode
->i_mtime
;
1413 EXPORT_SYMBOL(lease_get_mtime
);
1416 * fcntl_getlease - Enquire what lease is currently active
1419 * The value returned by this function will be one of
1420 * (if no lease break is pending):
1422 * %F_RDLCK to indicate a shared lease is held.
1424 * %F_WRLCK to indicate an exclusive lease is held.
1426 * %F_UNLCK to indicate no lease is held.
1428 * (if a lease break is pending):
1430 * %F_RDLCK to indicate an exclusive lease needs to be
1431 * changed to a shared lease (or removed).
1433 * %F_UNLCK to indicate the lease needs to be removed.
1435 * XXX: sfr & willy disagree over whether F_INPROGRESS
1436 * should be returned to userspace.
1438 int fcntl_getlease(struct file
*filp
)
1440 struct file_lock
*fl
;
1441 struct inode
*inode
= file_inode(filp
);
1444 spin_lock(&inode
->i_lock
);
1445 time_out_leases(file_inode(filp
));
1446 for (fl
= file_inode(filp
)->i_flock
; fl
&& IS_LEASE(fl
);
1448 if (fl
->fl_file
== filp
) {
1449 type
= target_leasetype(fl
);
1453 spin_unlock(&inode
->i_lock
);
1457 static int generic_add_lease(struct file
*filp
, long arg
, struct file_lock
**flp
)
1459 struct file_lock
*fl
, **before
, **my_before
= NULL
, *lease
;
1460 struct dentry
*dentry
= filp
->f_path
.dentry
;
1461 struct inode
*inode
= dentry
->d_inode
;
1467 if ((arg
== F_RDLCK
) && (atomic_read(&inode
->i_writecount
) > 0))
1469 if ((arg
== F_WRLCK
)
1470 && ((d_count(dentry
) > 1)
1471 || (atomic_read(&inode
->i_count
) > 1)))
1475 * At this point, we know that if there is an exclusive
1476 * lease on this file, then we hold it on this filp
1477 * (otherwise our open of this file would have blocked).
1478 * And if we are trying to acquire an exclusive lease,
1479 * then the file is not open by anyone (including us)
1480 * except for this filp.
1483 for (before
= &inode
->i_flock
;
1484 ((fl
= *before
) != NULL
) && IS_LEASE(fl
);
1485 before
= &fl
->fl_next
) {
1486 if (fl
->fl_file
== filp
) {
1491 * No exclusive leases if someone else has a lease on
1497 * Modifying our existing lease is OK, but no getting a
1498 * new lease if someone else is opening for write:
1500 if (fl
->fl_flags
& FL_UNLOCK_PENDING
)
1504 if (my_before
!= NULL
) {
1505 error
= lease
->fl_lmops
->lm_change(my_before
, arg
);
1515 locks_insert_lock(before
, lease
);
1522 static int generic_delete_lease(struct file
*filp
, struct file_lock
**flp
)
1524 struct file_lock
*fl
, **before
;
1525 struct dentry
*dentry
= filp
->f_path
.dentry
;
1526 struct inode
*inode
= dentry
->d_inode
;
1528 for (before
= &inode
->i_flock
;
1529 ((fl
= *before
) != NULL
) && IS_LEASE(fl
);
1530 before
= &fl
->fl_next
) {
1531 if (fl
->fl_file
!= filp
)
1533 return (*flp
)->fl_lmops
->lm_change(before
, F_UNLCK
);
1539 * generic_setlease - sets a lease on an open file
1540 * @filp: file pointer
1541 * @arg: type of lease to obtain
1542 * @flp: input - file_lock to use, output - file_lock inserted
1544 * The (input) flp->fl_lmops->lm_break function is required
1547 * Called with inode->i_lock held.
1549 int generic_setlease(struct file
*filp
, long arg
, struct file_lock
**flp
)
1551 struct dentry
*dentry
= filp
->f_path
.dentry
;
1552 struct inode
*inode
= dentry
->d_inode
;
1555 if ((!uid_eq(current_fsuid(), inode
->i_uid
)) && !capable(CAP_LEASE
))
1557 if (!S_ISREG(inode
->i_mode
))
1559 error
= security_file_lock(filp
, arg
);
1563 time_out_leases(inode
);
1565 BUG_ON(!(*flp
)->fl_lmops
->lm_break
);
1569 return generic_delete_lease(filp
, flp
);
1572 return generic_add_lease(filp
, arg
, flp
);
1577 EXPORT_SYMBOL(generic_setlease
);
1579 static int __vfs_setlease(struct file
*filp
, long arg
, struct file_lock
**lease
)
1581 if (filp
->f_op
&& filp
->f_op
->setlease
)
1582 return filp
->f_op
->setlease(filp
, arg
, lease
);
1584 return generic_setlease(filp
, arg
, lease
);
1588 * vfs_setlease - sets a lease on an open file
1589 * @filp: file pointer
1590 * @arg: type of lease to obtain
1591 * @lease: file_lock to use
1593 * Call this to establish a lease on the file.
1594 * The (*lease)->fl_lmops->lm_break operation must be set; if not,
1595 * break_lease will oops!
1597 * This will call the filesystem's setlease file method, if
1598 * defined. Note that there is no getlease method; instead, the
1599 * filesystem setlease method should call back to setlease() to
1600 * add a lease to the inode's lease list, where fcntl_getlease() can
1601 * find it. Since fcntl_getlease() only reports whether the current
1602 * task holds a lease, a cluster filesystem need only do this for
1603 * leases held by processes on this node.
1605 * There is also no break_lease method; filesystems that
1606 * handle their own leases should break leases themselves from the
1607 * filesystem's open, create, and (on truncate) setattr methods.
1609 * Warning: the only current setlease methods exist only to disable
1610 * leases in certain cases. More vfs changes may be required to
1611 * allow a full filesystem lease implementation.
1614 int vfs_setlease(struct file
*filp
, long arg
, struct file_lock
**lease
)
1616 struct inode
*inode
= file_inode(filp
);
1619 spin_lock(&inode
->i_lock
);
1620 error
= __vfs_setlease(filp
, arg
, lease
);
1621 spin_unlock(&inode
->i_lock
);
1625 EXPORT_SYMBOL_GPL(vfs_setlease
);
1627 static int do_fcntl_delete_lease(struct file
*filp
)
1629 struct file_lock fl
, *flp
= &fl
;
1631 lease_init(filp
, F_UNLCK
, flp
);
1633 return vfs_setlease(filp
, F_UNLCK
, &flp
);
1636 static int do_fcntl_add_lease(unsigned int fd
, struct file
*filp
, long arg
)
1638 struct file_lock
*fl
, *ret
;
1639 struct inode
*inode
= file_inode(filp
);
1640 struct fasync_struct
*new;
1643 fl
= lease_alloc(filp
, arg
);
1647 new = fasync_alloc();
1649 locks_free_lock(fl
);
1653 spin_lock(&inode
->i_lock
);
1654 error
= __vfs_setlease(filp
, arg
, &ret
);
1656 spin_unlock(&inode
->i_lock
);
1657 locks_free_lock(fl
);
1658 goto out_free_fasync
;
1661 locks_free_lock(fl
);
1664 * fasync_insert_entry() returns the old entry if any.
1665 * If there was no old entry, then it used 'new' and
1666 * inserted it into the fasync list. Clear new so that
1667 * we don't release it here.
1669 if (!fasync_insert_entry(fd
, filp
, &ret
->fl_fasync
, new))
1672 error
= __f_setown(filp
, task_pid(current
), PIDTYPE_PID
, 0);
1673 spin_unlock(&inode
->i_lock
);
1682 * fcntl_setlease - sets a lease on an open file
1683 * @fd: open file descriptor
1684 * @filp: file pointer
1685 * @arg: type of lease to obtain
1687 * Call this fcntl to establish a lease on the file.
1688 * Note that you also need to call %F_SETSIG to
1689 * receive a signal when the lease is broken.
1691 int fcntl_setlease(unsigned int fd
, struct file
*filp
, long arg
)
1694 return do_fcntl_delete_lease(filp
);
1695 return do_fcntl_add_lease(fd
, filp
, arg
);
1699 * flock_lock_file_wait - Apply a FLOCK-style lock to a file
1700 * @filp: The file to apply the lock to
1701 * @fl: The lock to be applied
1703 * Add a FLOCK style lock to a file.
1705 int flock_lock_file_wait(struct file
*filp
, struct file_lock
*fl
)
1710 error
= flock_lock_file(filp
, fl
);
1711 if (error
!= FILE_LOCK_DEFERRED
)
1713 error
= wait_event_interruptible(fl
->fl_wait
, !fl
->fl_next
);
1717 locks_delete_block(fl
);
1723 EXPORT_SYMBOL(flock_lock_file_wait
);
1726 * sys_flock: - flock() system call.
1727 * @fd: the file descriptor to lock.
1728 * @cmd: the type of lock to apply.
1730 * Apply a %FL_FLOCK style lock to an open file descriptor.
1731 * The @cmd can be one of
1733 * %LOCK_SH -- a shared lock.
1735 * %LOCK_EX -- an exclusive lock.
1737 * %LOCK_UN -- remove an existing lock.
1739 * %LOCK_MAND -- a `mandatory' flock. This exists to emulate Windows Share Modes.
1741 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
1742 * processes read and write access respectively.
1744 SYSCALL_DEFINE2(flock
, unsigned int, fd
, unsigned int, cmd
)
1746 struct fd f
= fdget(fd
);
1747 struct file_lock
*lock
;
1748 int can_sleep
, unlock
;
1755 can_sleep
= !(cmd
& LOCK_NB
);
1757 unlock
= (cmd
== LOCK_UN
);
1759 if (!unlock
&& !(cmd
& LOCK_MAND
) &&
1760 !(f
.file
->f_mode
& (FMODE_READ
|FMODE_WRITE
)))
1763 error
= flock_make_lock(f
.file
, &lock
, cmd
);
1767 lock
->fl_flags
|= FL_SLEEP
;
1769 error
= security_file_lock(f
.file
, lock
->fl_type
);
1773 if (f
.file
->f_op
&& f
.file
->f_op
->flock
)
1774 error
= f
.file
->f_op
->flock(f
.file
,
1775 (can_sleep
) ? F_SETLKW
: F_SETLK
,
1778 error
= flock_lock_file_wait(f
.file
, lock
);
1781 locks_free_lock(lock
);
1790 * vfs_test_lock - test file byte range lock
1791 * @filp: The file to test lock for
1792 * @fl: The lock to test; also used to hold result
1794 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
1795 * setting conf->fl_type to something other than F_UNLCK.
1797 int vfs_test_lock(struct file
*filp
, struct file_lock
*fl
)
1799 if (filp
->f_op
&& filp
->f_op
->lock
)
1800 return filp
->f_op
->lock(filp
, F_GETLK
, fl
);
1801 posix_test_lock(filp
, fl
);
1804 EXPORT_SYMBOL_GPL(vfs_test_lock
);
1806 static int posix_lock_to_flock(struct flock
*flock
, struct file_lock
*fl
)
1808 flock
->l_pid
= fl
->fl_pid
;
1809 #if BITS_PER_LONG == 32
1811 * Make sure we can represent the posix lock via
1812 * legacy 32bit flock.
1814 if (fl
->fl_start
> OFFT_OFFSET_MAX
)
1816 if (fl
->fl_end
!= OFFSET_MAX
&& fl
->fl_end
> OFFT_OFFSET_MAX
)
1819 flock
->l_start
= fl
->fl_start
;
1820 flock
->l_len
= fl
->fl_end
== OFFSET_MAX
? 0 :
1821 fl
->fl_end
- fl
->fl_start
+ 1;
1822 flock
->l_whence
= 0;
1823 flock
->l_type
= fl
->fl_type
;
1827 #if BITS_PER_LONG == 32
1828 static void posix_lock_to_flock64(struct flock64
*flock
, struct file_lock
*fl
)
1830 flock
->l_pid
= fl
->fl_pid
;
1831 flock
->l_start
= fl
->fl_start
;
1832 flock
->l_len
= fl
->fl_end
== OFFSET_MAX
? 0 :
1833 fl
->fl_end
- fl
->fl_start
+ 1;
1834 flock
->l_whence
= 0;
1835 flock
->l_type
= fl
->fl_type
;
1839 /* Report the first existing lock that would conflict with l.
1840 * This implements the F_GETLK command of fcntl().
1842 int fcntl_getlk(struct file
*filp
, struct flock __user
*l
)
1844 struct file_lock file_lock
;
1849 if (copy_from_user(&flock
, l
, sizeof(flock
)))
1852 if ((flock
.l_type
!= F_RDLCK
) && (flock
.l_type
!= F_WRLCK
))
1855 error
= flock_to_posix_lock(filp
, &file_lock
, &flock
);
1859 error
= vfs_test_lock(filp
, &file_lock
);
1863 flock
.l_type
= file_lock
.fl_type
;
1864 if (file_lock
.fl_type
!= F_UNLCK
) {
1865 error
= posix_lock_to_flock(&flock
, &file_lock
);
1870 if (!copy_to_user(l
, &flock
, sizeof(flock
)))
1877 * vfs_lock_file - file byte range lock
1878 * @filp: The file to apply the lock to
1879 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
1880 * @fl: The lock to be applied
1881 * @conf: Place to return a copy of the conflicting lock, if found.
1883 * A caller that doesn't care about the conflicting lock may pass NULL
1884 * as the final argument.
1886 * If the filesystem defines a private ->lock() method, then @conf will
1887 * be left unchanged; so a caller that cares should initialize it to
1888 * some acceptable default.
1890 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
1891 * locks, the ->lock() interface may return asynchronously, before the lock has
1892 * been granted or denied by the underlying filesystem, if (and only if)
1893 * lm_grant is set. Callers expecting ->lock() to return asynchronously
1894 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
1895 * the request is for a blocking lock. When ->lock() does return asynchronously,
1896 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
1897 * request completes.
1898 * If the request is for non-blocking lock the file system should return
1899 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
1900 * with the result. If the request timed out the callback routine will return a
1901 * nonzero return code and the file system should release the lock. The file
1902 * system is also responsible to keep a corresponding posix lock when it
1903 * grants a lock so the VFS can find out which locks are locally held and do
1904 * the correct lock cleanup when required.
1905 * The underlying filesystem must not drop the kernel lock or call
1906 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
1909 int vfs_lock_file(struct file
*filp
, unsigned int cmd
, struct file_lock
*fl
, struct file_lock
*conf
)
1911 if (filp
->f_op
&& filp
->f_op
->lock
)
1912 return filp
->f_op
->lock(filp
, cmd
, fl
);
1914 return posix_lock_file(filp
, fl
, conf
);
1916 EXPORT_SYMBOL_GPL(vfs_lock_file
);
1918 static int do_lock_file_wait(struct file
*filp
, unsigned int cmd
,
1919 struct file_lock
*fl
)
1923 error
= security_file_lock(filp
, fl
->fl_type
);
1928 error
= vfs_lock_file(filp
, cmd
, fl
, NULL
);
1929 if (error
!= FILE_LOCK_DEFERRED
)
1931 error
= wait_event_interruptible(fl
->fl_wait
, !fl
->fl_next
);
1935 locks_delete_block(fl
);
1942 /* Apply the lock described by l to an open file descriptor.
1943 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
1945 int fcntl_setlk(unsigned int fd
, struct file
*filp
, unsigned int cmd
,
1946 struct flock __user
*l
)
1948 struct file_lock
*file_lock
= locks_alloc_lock();
1950 struct inode
*inode
;
1954 if (file_lock
== NULL
)
1958 * This might block, so we do it before checking the inode.
1961 if (copy_from_user(&flock
, l
, sizeof(flock
)))
1964 inode
= file_inode(filp
);
1966 /* Don't allow mandatory locks on files that may be memory mapped
1969 if (mandatory_lock(inode
) && mapping_writably_mapped(filp
->f_mapping
)) {
1975 error
= flock_to_posix_lock(filp
, file_lock
, &flock
);
1978 if (cmd
== F_SETLKW
) {
1979 file_lock
->fl_flags
|= FL_SLEEP
;
1983 switch (flock
.l_type
) {
1985 if (!(filp
->f_mode
& FMODE_READ
))
1989 if (!(filp
->f_mode
& FMODE_WRITE
))
1999 error
= do_lock_file_wait(filp
, cmd
, file_lock
);
2002 * Attempt to detect a close/fcntl race and recover by
2003 * releasing the lock that was just acquired.
2006 * we need that spin_lock here - it prevents reordering between
2007 * update of inode->i_flock and check for it done in close().
2008 * rcu_read_lock() wouldn't do.
2010 spin_lock(¤t
->files
->file_lock
);
2012 spin_unlock(¤t
->files
->file_lock
);
2013 if (!error
&& f
!= filp
&& flock
.l_type
!= F_UNLCK
) {
2014 flock
.l_type
= F_UNLCK
;
2019 locks_free_lock(file_lock
);
2023 #if BITS_PER_LONG == 32
2024 /* Report the first existing lock that would conflict with l.
2025 * This implements the F_GETLK command of fcntl().
2027 int fcntl_getlk64(struct file
*filp
, struct flock64 __user
*l
)
2029 struct file_lock file_lock
;
2030 struct flock64 flock
;
2034 if (copy_from_user(&flock
, l
, sizeof(flock
)))
2037 if ((flock
.l_type
!= F_RDLCK
) && (flock
.l_type
!= F_WRLCK
))
2040 error
= flock64_to_posix_lock(filp
, &file_lock
, &flock
);
2044 error
= vfs_test_lock(filp
, &file_lock
);
2048 flock
.l_type
= file_lock
.fl_type
;
2049 if (file_lock
.fl_type
!= F_UNLCK
)
2050 posix_lock_to_flock64(&flock
, &file_lock
);
2053 if (!copy_to_user(l
, &flock
, sizeof(flock
)))
2060 /* Apply the lock described by l to an open file descriptor.
2061 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2063 int fcntl_setlk64(unsigned int fd
, struct file
*filp
, unsigned int cmd
,
2064 struct flock64 __user
*l
)
2066 struct file_lock
*file_lock
= locks_alloc_lock();
2067 struct flock64 flock
;
2068 struct inode
*inode
;
2072 if (file_lock
== NULL
)
2076 * This might block, so we do it before checking the inode.
2079 if (copy_from_user(&flock
, l
, sizeof(flock
)))
2082 inode
= file_inode(filp
);
2084 /* Don't allow mandatory locks on files that may be memory mapped
2087 if (mandatory_lock(inode
) && mapping_writably_mapped(filp
->f_mapping
)) {
2093 error
= flock64_to_posix_lock(filp
, file_lock
, &flock
);
2096 if (cmd
== F_SETLKW64
) {
2097 file_lock
->fl_flags
|= FL_SLEEP
;
2101 switch (flock
.l_type
) {
2103 if (!(filp
->f_mode
& FMODE_READ
))
2107 if (!(filp
->f_mode
& FMODE_WRITE
))
2117 error
= do_lock_file_wait(filp
, cmd
, file_lock
);
2120 * Attempt to detect a close/fcntl race and recover by
2121 * releasing the lock that was just acquired.
2123 spin_lock(¤t
->files
->file_lock
);
2125 spin_unlock(¤t
->files
->file_lock
);
2126 if (!error
&& f
!= filp
&& flock
.l_type
!= F_UNLCK
) {
2127 flock
.l_type
= F_UNLCK
;
2132 locks_free_lock(file_lock
);
2135 #endif /* BITS_PER_LONG == 32 */
2138 * This function is called when the file is being removed
2139 * from the task's fd array. POSIX locks belonging to this task
2140 * are deleted at this time.
2142 void locks_remove_posix(struct file
*filp
, fl_owner_t owner
)
2144 struct file_lock lock
;
2147 * If there are no locks held on this file, we don't need to call
2148 * posix_lock_file(). Another process could be setting a lock on this
2149 * file at the same time, but we wouldn't remove that lock anyway.
2151 if (!file_inode(filp
)->i_flock
)
2154 lock
.fl_type
= F_UNLCK
;
2155 lock
.fl_flags
= FL_POSIX
| FL_CLOSE
;
2157 lock
.fl_end
= OFFSET_MAX
;
2158 lock
.fl_owner
= owner
;
2159 lock
.fl_pid
= current
->tgid
;
2160 lock
.fl_file
= filp
;
2162 lock
.fl_lmops
= NULL
;
2164 vfs_lock_file(filp
, F_SETLK
, &lock
, NULL
);
2166 if (lock
.fl_ops
&& lock
.fl_ops
->fl_release_private
)
2167 lock
.fl_ops
->fl_release_private(&lock
);
2170 EXPORT_SYMBOL(locks_remove_posix
);
2173 * This function is called on the last close of an open file.
2175 void locks_remove_flock(struct file
*filp
)
2177 struct inode
* inode
= file_inode(filp
);
2178 struct file_lock
*fl
;
2179 struct file_lock
**before
;
2181 if (!inode
->i_flock
)
2184 if (filp
->f_op
&& filp
->f_op
->flock
) {
2185 struct file_lock fl
= {
2186 .fl_pid
= current
->tgid
,
2188 .fl_flags
= FL_FLOCK
,
2190 .fl_end
= OFFSET_MAX
,
2192 filp
->f_op
->flock(filp
, F_SETLKW
, &fl
);
2193 if (fl
.fl_ops
&& fl
.fl_ops
->fl_release_private
)
2194 fl
.fl_ops
->fl_release_private(&fl
);
2197 spin_lock(&inode
->i_lock
);
2198 before
= &inode
->i_flock
;
2200 while ((fl
= *before
) != NULL
) {
2201 if (fl
->fl_file
== filp
) {
2203 locks_delete_lock(before
);
2207 lease_modify(before
, F_UNLCK
);
2213 before
= &fl
->fl_next
;
2215 spin_unlock(&inode
->i_lock
);
2219 * posix_unblock_lock - stop waiting for a file lock
2220 * @waiter: the lock which was waiting
2222 * lockd needs to block waiting for locks.
2225 posix_unblock_lock(struct file_lock
*waiter
)
2229 spin_lock(&blocked_lock_lock
);
2230 if (waiter
->fl_next
)
2231 __locks_delete_block(waiter
);
2234 spin_unlock(&blocked_lock_lock
);
2237 EXPORT_SYMBOL(posix_unblock_lock
);
2240 * vfs_cancel_lock - file byte range unblock lock
2241 * @filp: The file to apply the unblock to
2242 * @fl: The lock to be unblocked
2244 * Used by lock managers to cancel blocked requests
2246 int vfs_cancel_lock(struct file
*filp
, struct file_lock
*fl
)
2248 if (filp
->f_op
&& filp
->f_op
->lock
)
2249 return filp
->f_op
->lock(filp
, F_CANCELLK
, fl
);
2253 EXPORT_SYMBOL_GPL(vfs_cancel_lock
);
2255 #ifdef CONFIG_PROC_FS
2256 #include <linux/proc_fs.h>
2257 #include <linux/seq_file.h>
2259 struct locks_iterator
{
2264 static void lock_get_status(struct seq_file
*f
, struct file_lock
*fl
,
2265 loff_t id
, char *pfx
)
2267 struct inode
*inode
= NULL
;
2268 unsigned int fl_pid
;
2271 fl_pid
= pid_vnr(fl
->fl_nspid
);
2273 fl_pid
= fl
->fl_pid
;
2275 if (fl
->fl_file
!= NULL
)
2276 inode
= file_inode(fl
->fl_file
);
2278 seq_printf(f
, "%lld:%s ", id
, pfx
);
2280 seq_printf(f
, "%6s %s ",
2281 (fl
->fl_flags
& FL_ACCESS
) ? "ACCESS" : "POSIX ",
2282 (inode
== NULL
) ? "*NOINODE*" :
2283 mandatory_lock(inode
) ? "MANDATORY" : "ADVISORY ");
2284 } else if (IS_FLOCK(fl
)) {
2285 if (fl
->fl_type
& LOCK_MAND
) {
2286 seq_printf(f
, "FLOCK MSNFS ");
2288 seq_printf(f
, "FLOCK ADVISORY ");
2290 } else if (IS_LEASE(fl
)) {
2291 seq_printf(f
, "LEASE ");
2292 if (lease_breaking(fl
))
2293 seq_printf(f
, "BREAKING ");
2294 else if (fl
->fl_file
)
2295 seq_printf(f
, "ACTIVE ");
2297 seq_printf(f
, "BREAKER ");
2299 seq_printf(f
, "UNKNOWN UNKNOWN ");
2301 if (fl
->fl_type
& LOCK_MAND
) {
2302 seq_printf(f
, "%s ",
2303 (fl
->fl_type
& LOCK_READ
)
2304 ? (fl
->fl_type
& LOCK_WRITE
) ? "RW " : "READ "
2305 : (fl
->fl_type
& LOCK_WRITE
) ? "WRITE" : "NONE ");
2307 seq_printf(f
, "%s ",
2308 (lease_breaking(fl
))
2309 ? (fl
->fl_type
== F_UNLCK
) ? "UNLCK" : "READ "
2310 : (fl
->fl_type
== F_WRLCK
) ? "WRITE" : "READ ");
2313 #ifdef WE_CAN_BREAK_LSLK_NOW
2314 seq_printf(f
, "%d %s:%ld ", fl_pid
,
2315 inode
->i_sb
->s_id
, inode
->i_ino
);
2317 /* userspace relies on this representation of dev_t ;-( */
2318 seq_printf(f
, "%d %02x:%02x:%ld ", fl_pid
,
2319 MAJOR(inode
->i_sb
->s_dev
),
2320 MINOR(inode
->i_sb
->s_dev
), inode
->i_ino
);
2323 seq_printf(f
, "%d <none>:0 ", fl_pid
);
2326 if (fl
->fl_end
== OFFSET_MAX
)
2327 seq_printf(f
, "%Ld EOF\n", fl
->fl_start
);
2329 seq_printf(f
, "%Ld %Ld\n", fl
->fl_start
, fl
->fl_end
);
2331 seq_printf(f
, "0 EOF\n");
2335 static int locks_show(struct seq_file
*f
, void *v
)
2337 struct locks_iterator
*iter
= f
->private;
2338 struct file_lock
*fl
, *bfl
;
2340 fl
= hlist_entry(v
, struct file_lock
, fl_link
);
2342 lock_get_status(f
, fl
, iter
->li_pos
, "");
2344 list_for_each_entry(bfl
, &fl
->fl_block
, fl_block
)
2345 lock_get_status(f
, bfl
, iter
->li_pos
, " ->");
2350 static void *locks_start(struct seq_file
*f
, loff_t
*pos
)
2352 struct locks_iterator
*iter
= f
->private;
2354 iter
->li_pos
= *pos
+ 1;
2355 lg_global_lock(&file_lock_lglock
);
2356 spin_lock(&blocked_lock_lock
);
2357 return seq_hlist_start_percpu(&file_lock_list
, &iter
->li_cpu
, *pos
);
2360 static void *locks_next(struct seq_file
*f
, void *v
, loff_t
*pos
)
2362 struct locks_iterator
*iter
= f
->private;
2365 return seq_hlist_next_percpu(v
, &file_lock_list
, &iter
->li_cpu
, pos
);
2368 static void locks_stop(struct seq_file
*f
, void *v
)
2370 spin_unlock(&blocked_lock_lock
);
2371 lg_global_unlock(&file_lock_lglock
);
2374 static const struct seq_operations locks_seq_operations
= {
2375 .start
= locks_start
,
2381 static int locks_open(struct inode
*inode
, struct file
*filp
)
2383 return seq_open_private(filp
, &locks_seq_operations
,
2384 sizeof(struct locks_iterator
));
2387 static const struct file_operations proc_locks_operations
= {
2390 .llseek
= seq_lseek
,
2391 .release
= seq_release_private
,
2394 static int __init
proc_locks_init(void)
2396 proc_create("locks", 0, NULL
, &proc_locks_operations
);
2399 module_init(proc_locks_init
);
2403 * lock_may_read - checks that the region is free of locks
2404 * @inode: the inode that is being read
2405 * @start: the first byte to read
2406 * @len: the number of bytes to read
2408 * Emulates Windows locking requirements. Whole-file
2409 * mandatory locks (share modes) can prohibit a read and
2410 * byte-range POSIX locks can prohibit a read if they overlap.
2412 * N.B. this function is only ever called
2413 * from knfsd and ownership of locks is never checked.
2415 int lock_may_read(struct inode
*inode
, loff_t start
, unsigned long len
)
2417 struct file_lock
*fl
;
2420 spin_lock(&inode
->i_lock
);
2421 for (fl
= inode
->i_flock
; fl
!= NULL
; fl
= fl
->fl_next
) {
2423 if (fl
->fl_type
== F_RDLCK
)
2425 if ((fl
->fl_end
< start
) || (fl
->fl_start
> (start
+ len
)))
2427 } else if (IS_FLOCK(fl
)) {
2428 if (!(fl
->fl_type
& LOCK_MAND
))
2430 if (fl
->fl_type
& LOCK_READ
)
2437 spin_unlock(&inode
->i_lock
);
2441 EXPORT_SYMBOL(lock_may_read
);
2444 * lock_may_write - checks that the region is free of locks
2445 * @inode: the inode that is being written
2446 * @start: the first byte to write
2447 * @len: the number of bytes to write
2449 * Emulates Windows locking requirements. Whole-file
2450 * mandatory locks (share modes) can prohibit a write and
2451 * byte-range POSIX locks can prohibit a write if they overlap.
2453 * N.B. this function is only ever called
2454 * from knfsd and ownership of locks is never checked.
2456 int lock_may_write(struct inode
*inode
, loff_t start
, unsigned long len
)
2458 struct file_lock
*fl
;
2461 spin_lock(&inode
->i_lock
);
2462 for (fl
= inode
->i_flock
; fl
!= NULL
; fl
= fl
->fl_next
) {
2464 if ((fl
->fl_end
< start
) || (fl
->fl_start
> (start
+ len
)))
2466 } else if (IS_FLOCK(fl
)) {
2467 if (!(fl
->fl_type
& LOCK_MAND
))
2469 if (fl
->fl_type
& LOCK_WRITE
)
2476 spin_unlock(&inode
->i_lock
);
2480 EXPORT_SYMBOL(lock_may_write
);
2482 static int __init
filelock_init(void)
2486 filelock_cache
= kmem_cache_create("file_lock_cache",
2487 sizeof(struct file_lock
), 0, SLAB_PANIC
, NULL
);
2489 lg_lock_init(&file_lock_lglock
, "file_lock_lglock");
2491 for_each_possible_cpu(i
)
2492 INIT_HLIST_HEAD(per_cpu_ptr(&file_lock_list
, i
));
2497 core_initcall(filelock_init
);