1 // SPDX-License-Identifier: GPL-2.0-only
5 * We implement four types of file locks: BSD locks, posix locks, open
6 * file description locks, and leases. For details about BSD locks,
7 * see the flock(2) man page; for details about the other three, see
11 * Locking conflicts and dependencies:
12 * If multiple threads attempt to lock the same byte (or flock the same file)
13 * only one can be granted the lock, and other must wait their turn.
14 * The first lock has been "applied" or "granted", the others are "waiting"
15 * and are "blocked" by the "applied" lock..
17 * Waiting and applied locks are all kept in trees whose properties are:
19 * - the root of a tree may be an applied or waiting lock.
20 * - every other node in the tree is a waiting lock that
21 * conflicts with every ancestor of that node.
23 * Every such tree begins life as a waiting singleton which obviously
24 * satisfies the above properties.
26 * The only ways we modify trees preserve these properties:
28 * 1. We may add a new leaf node, but only after first verifying that it
29 * conflicts with all of its ancestors.
30 * 2. We may remove the root of a tree, creating a new singleton
31 * tree from the root and N new trees rooted in the immediate
33 * 3. If the root of a tree is not currently an applied lock, we may
34 * apply it (if possible).
35 * 4. We may upgrade the root of the tree (either extend its range,
36 * or upgrade its entire range from read to write).
38 * When an applied lock is modified in a way that reduces or downgrades any
39 * part of its range, we remove all its children (2 above). This particularly
40 * happens when a lock is unlocked.
42 * For each of those child trees we "wake up" the thread which is
43 * waiting for the lock so it can continue handling as follows: if the
44 * root of the tree applies, we do so (3). If it doesn't, it must
45 * conflict with some applied lock. We remove (wake up) all of its children
46 * (2), and add it is a new leaf to the tree rooted in the applied
47 * lock (1). We then repeat the process recursively with those
52 #include <linux/capability.h>
53 #include <linux/file.h>
54 #include <linux/fdtable.h>
56 #include <linux/init.h>
57 #include <linux/security.h>
58 #include <linux/slab.h>
59 #include <linux/syscalls.h>
60 #include <linux/time.h>
61 #include <linux/rcupdate.h>
62 #include <linux/pid_namespace.h>
63 #include <linux/hashtable.h>
64 #include <linux/percpu.h>
65 #include <linux/sysctl.h>
67 #define CREATE_TRACE_POINTS
68 #include <trace/events/filelock.h>
70 #include <linux/uaccess.h>
72 #define IS_POSIX(fl) (fl->fl_flags & FL_POSIX)
73 #define IS_FLOCK(fl) (fl->fl_flags & FL_FLOCK)
74 #define IS_LEASE(fl) (fl->fl_flags & (FL_LEASE|FL_DELEG|FL_LAYOUT))
75 #define IS_OFDLCK(fl) (fl->fl_flags & FL_OFDLCK)
76 #define IS_REMOTELCK(fl) (fl->fl_pid <= 0)
78 static bool lease_breaking(struct file_lock *fl)
80 return fl->fl_flags & (FL_UNLOCK_PENDING | FL_DOWNGRADE_PENDING);
83 static int target_leasetype(struct file_lock *fl)
85 if (fl->fl_flags & FL_UNLOCK_PENDING)
87 if (fl->fl_flags & FL_DOWNGRADE_PENDING)
92 static int leases_enable = 1;
93 static int lease_break_time = 45;
96 static struct ctl_table locks_sysctls[] = {
98 .procname = "leases-enable",
99 .data = &leases_enable,
100 .maxlen = sizeof(int),
102 .proc_handler = proc_dointvec,
106 .procname = "lease-break-time",
107 .data = &lease_break_time,
108 .maxlen = sizeof(int),
110 .proc_handler = proc_dointvec,
112 #endif /* CONFIG_MMU */
116 static int __init init_fs_locks_sysctls(void)
118 register_sysctl_init("fs", locks_sysctls);
121 early_initcall(init_fs_locks_sysctls);
122 #endif /* CONFIG_SYSCTL */
125 * The global file_lock_list is only used for displaying /proc/locks, so we
126 * keep a list on each CPU, with each list protected by its own spinlock.
127 * Global serialization is done using file_rwsem.
129 * Note that alterations to the list also require that the relevant flc_lock is
132 struct file_lock_list_struct {
134 struct hlist_head hlist;
136 static DEFINE_PER_CPU(struct file_lock_list_struct, file_lock_list);
137 DEFINE_STATIC_PERCPU_RWSEM(file_rwsem);
141 * The blocked_hash is used to find POSIX lock loops for deadlock detection.
142 * It is protected by blocked_lock_lock.
144 * We hash locks by lockowner in order to optimize searching for the lock a
145 * particular lockowner is waiting on.
147 * FIXME: make this value scale via some heuristic? We generally will want more
148 * buckets when we have more lockowners holding locks, but that's a little
149 * difficult to determine without knowing what the workload will look like.
151 #define BLOCKED_HASH_BITS 7
152 static DEFINE_HASHTABLE(blocked_hash, BLOCKED_HASH_BITS);
155 * This lock protects the blocked_hash. Generally, if you're accessing it, you
156 * want to be holding this lock.
158 * In addition, it also protects the fl->fl_blocked_requests list, and the
159 * fl->fl_blocker pointer for file_lock structures that are acting as lock
160 * requests (in contrast to those that are acting as records of acquired locks).
162 * Note that when we acquire this lock in order to change the above fields,
163 * we often hold the flc_lock as well. In certain cases, when reading the fields
164 * protected by this lock, we can skip acquiring it iff we already hold the
167 static DEFINE_SPINLOCK(blocked_lock_lock);
169 static struct kmem_cache *flctx_cache __read_mostly;
170 static struct kmem_cache *filelock_cache __read_mostly;
172 static struct file_lock_context *
173 locks_get_lock_context(struct inode *inode, int type)
175 struct file_lock_context *ctx;
177 /* paired with cmpxchg() below */
178 ctx = smp_load_acquire(&inode->i_flctx);
179 if (likely(ctx) || type == F_UNLCK)
182 ctx = kmem_cache_alloc(flctx_cache, GFP_KERNEL);
186 spin_lock_init(&ctx->flc_lock);
187 INIT_LIST_HEAD(&ctx->flc_flock);
188 INIT_LIST_HEAD(&ctx->flc_posix);
189 INIT_LIST_HEAD(&ctx->flc_lease);
192 * Assign the pointer if it's not already assigned. If it is, then
193 * free the context we just allocated.
195 if (cmpxchg(&inode->i_flctx, NULL, ctx)) {
196 kmem_cache_free(flctx_cache, ctx);
197 ctx = smp_load_acquire(&inode->i_flctx);
200 trace_locks_get_lock_context(inode, type, ctx);
205 locks_dump_ctx_list(struct list_head *list, char *list_type)
207 struct file_lock *fl;
209 list_for_each_entry(fl, list, fl_list) {
210 pr_warn("%s: fl_owner=%p fl_flags=0x%x fl_type=0x%x fl_pid=%u\n", list_type, fl->fl_owner, fl->fl_flags, fl->fl_type, fl->fl_pid);
215 locks_check_ctx_lists(struct inode *inode)
217 struct file_lock_context *ctx = inode->i_flctx;
219 if (unlikely(!list_empty(&ctx->flc_flock) ||
220 !list_empty(&ctx->flc_posix) ||
221 !list_empty(&ctx->flc_lease))) {
222 pr_warn("Leaked locks on dev=0x%x:0x%x ino=0x%lx:\n",
223 MAJOR(inode->i_sb->s_dev), MINOR(inode->i_sb->s_dev),
225 locks_dump_ctx_list(&ctx->flc_flock, "FLOCK");
226 locks_dump_ctx_list(&ctx->flc_posix, "POSIX");
227 locks_dump_ctx_list(&ctx->flc_lease, "LEASE");
232 locks_check_ctx_file_list(struct file *filp, struct list_head *list,
235 struct file_lock *fl;
236 struct inode *inode = locks_inode(filp);
238 list_for_each_entry(fl, list, fl_list)
239 if (fl->fl_file == filp)
240 pr_warn("Leaked %s lock on dev=0x%x:0x%x ino=0x%lx "
241 " fl_owner=%p fl_flags=0x%x fl_type=0x%x fl_pid=%u\n",
242 list_type, MAJOR(inode->i_sb->s_dev),
243 MINOR(inode->i_sb->s_dev), inode->i_ino,
244 fl->fl_owner, fl->fl_flags, fl->fl_type, fl->fl_pid);
248 locks_free_lock_context(struct inode *inode)
250 struct file_lock_context *ctx = inode->i_flctx;
253 locks_check_ctx_lists(inode);
254 kmem_cache_free(flctx_cache, ctx);
258 static void locks_init_lock_heads(struct file_lock *fl)
260 INIT_HLIST_NODE(&fl->fl_link);
261 INIT_LIST_HEAD(&fl->fl_list);
262 INIT_LIST_HEAD(&fl->fl_blocked_requests);
263 INIT_LIST_HEAD(&fl->fl_blocked_member);
264 init_waitqueue_head(&fl->fl_wait);
267 /* Allocate an empty lock structure. */
268 struct file_lock *locks_alloc_lock(void)
270 struct file_lock *fl = kmem_cache_zalloc(filelock_cache, GFP_KERNEL);
273 locks_init_lock_heads(fl);
277 EXPORT_SYMBOL_GPL(locks_alloc_lock);
279 void locks_release_private(struct file_lock *fl)
281 BUG_ON(waitqueue_active(&fl->fl_wait));
282 BUG_ON(!list_empty(&fl->fl_list));
283 BUG_ON(!list_empty(&fl->fl_blocked_requests));
284 BUG_ON(!list_empty(&fl->fl_blocked_member));
285 BUG_ON(!hlist_unhashed(&fl->fl_link));
288 if (fl->fl_ops->fl_release_private)
289 fl->fl_ops->fl_release_private(fl);
294 if (fl->fl_lmops->lm_put_owner) {
295 fl->fl_lmops->lm_put_owner(fl->fl_owner);
301 EXPORT_SYMBOL_GPL(locks_release_private);
303 /* Free a lock which is not in use. */
304 void locks_free_lock(struct file_lock *fl)
306 locks_release_private(fl);
307 kmem_cache_free(filelock_cache, fl);
309 EXPORT_SYMBOL(locks_free_lock);
312 locks_dispose_list(struct list_head *dispose)
314 struct file_lock *fl;
316 while (!list_empty(dispose)) {
317 fl = list_first_entry(dispose, struct file_lock, fl_list);
318 list_del_init(&fl->fl_list);
323 void locks_init_lock(struct file_lock *fl)
325 memset(fl, 0, sizeof(struct file_lock));
326 locks_init_lock_heads(fl);
328 EXPORT_SYMBOL(locks_init_lock);
331 * Initialize a new lock from an existing file_lock structure.
333 void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
335 new->fl_owner = fl->fl_owner;
336 new->fl_pid = fl->fl_pid;
338 new->fl_flags = fl->fl_flags;
339 new->fl_type = fl->fl_type;
340 new->fl_start = fl->fl_start;
341 new->fl_end = fl->fl_end;
342 new->fl_lmops = fl->fl_lmops;
346 if (fl->fl_lmops->lm_get_owner)
347 fl->fl_lmops->lm_get_owner(fl->fl_owner);
350 EXPORT_SYMBOL(locks_copy_conflock);
352 void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
354 /* "new" must be a freshly-initialized lock */
355 WARN_ON_ONCE(new->fl_ops);
357 locks_copy_conflock(new, fl);
359 new->fl_file = fl->fl_file;
360 new->fl_ops = fl->fl_ops;
363 if (fl->fl_ops->fl_copy_lock)
364 fl->fl_ops->fl_copy_lock(new, fl);
367 EXPORT_SYMBOL(locks_copy_lock);
369 static void locks_move_blocks(struct file_lock *new, struct file_lock *fl)
374 * As ctx->flc_lock is held, new requests cannot be added to
375 * ->fl_blocked_requests, so we don't need a lock to check if it
378 if (list_empty(&fl->fl_blocked_requests))
380 spin_lock(&blocked_lock_lock);
381 list_splice_init(&fl->fl_blocked_requests, &new->fl_blocked_requests);
382 list_for_each_entry(f, &new->fl_blocked_requests, fl_blocked_member)
384 spin_unlock(&blocked_lock_lock);
387 static inline int flock_translate_cmd(int cmd) {
399 /* Fill in a file_lock structure with an appropriate FLOCK lock. */
400 static struct file_lock *
401 flock_make_lock(struct file *filp, unsigned int cmd, struct file_lock *fl)
403 int type = flock_translate_cmd(cmd);
406 return ERR_PTR(type);
409 fl = locks_alloc_lock();
411 return ERR_PTR(-ENOMEM);
418 fl->fl_pid = current->tgid;
419 fl->fl_flags = FL_FLOCK;
421 fl->fl_end = OFFSET_MAX;
426 static int assign_type(struct file_lock *fl, long type)
440 static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
443 switch (l->l_whence) {
448 fl->fl_start = filp->f_pos;
451 fl->fl_start = i_size_read(file_inode(filp));
456 if (l->l_start > OFFSET_MAX - fl->fl_start)
458 fl->fl_start += l->l_start;
459 if (fl->fl_start < 0)
462 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
463 POSIX-2001 defines it. */
465 if (l->l_len - 1 > OFFSET_MAX - fl->fl_start)
467 fl->fl_end = fl->fl_start + (l->l_len - 1);
469 } else if (l->l_len < 0) {
470 if (fl->fl_start + l->l_len < 0)
472 fl->fl_end = fl->fl_start - 1;
473 fl->fl_start += l->l_len;
475 fl->fl_end = OFFSET_MAX;
477 fl->fl_owner = current->files;
478 fl->fl_pid = current->tgid;
480 fl->fl_flags = FL_POSIX;
484 return assign_type(fl, l->l_type);
487 /* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
490 static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
493 struct flock64 ll = {
495 .l_whence = l->l_whence,
496 .l_start = l->l_start,
500 return flock64_to_posix_lock(filp, fl, &ll);
503 /* default lease lock manager operations */
505 lease_break_callback(struct file_lock *fl)
507 kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
512 lease_setup(struct file_lock *fl, void **priv)
514 struct file *filp = fl->fl_file;
515 struct fasync_struct *fa = *priv;
518 * fasync_insert_entry() returns the old entry if any. If there was no
519 * old entry, then it used "priv" and inserted it into the fasync list.
520 * Clear the pointer to indicate that it shouldn't be freed.
522 if (!fasync_insert_entry(fa->fa_fd, filp, &fl->fl_fasync, fa))
525 __f_setown(filp, task_pid(current), PIDTYPE_TGID, 0);
528 static const struct lock_manager_operations lease_manager_ops = {
529 .lm_break = lease_break_callback,
530 .lm_change = lease_modify,
531 .lm_setup = lease_setup,
535 * Initialize a lease, use the default lock manager operations
537 static int lease_init(struct file *filp, long type, struct file_lock *fl)
539 if (assign_type(fl, type) != 0)
543 fl->fl_pid = current->tgid;
546 fl->fl_flags = FL_LEASE;
548 fl->fl_end = OFFSET_MAX;
550 fl->fl_lmops = &lease_manager_ops;
554 /* Allocate a file_lock initialised to this type of lease */
555 static struct file_lock *lease_alloc(struct file *filp, long type)
557 struct file_lock *fl = locks_alloc_lock();
561 return ERR_PTR(error);
563 error = lease_init(filp, type, fl);
566 return ERR_PTR(error);
571 /* Check if two locks overlap each other.
573 static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
575 return ((fl1->fl_end >= fl2->fl_start) &&
576 (fl2->fl_end >= fl1->fl_start));
580 * Check whether two locks have the same owner.
582 static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
584 return fl1->fl_owner == fl2->fl_owner;
587 /* Must be called with the flc_lock held! */
588 static void locks_insert_global_locks(struct file_lock *fl)
590 struct file_lock_list_struct *fll = this_cpu_ptr(&file_lock_list);
592 percpu_rwsem_assert_held(&file_rwsem);
594 spin_lock(&fll->lock);
595 fl->fl_link_cpu = smp_processor_id();
596 hlist_add_head(&fl->fl_link, &fll->hlist);
597 spin_unlock(&fll->lock);
600 /* Must be called with the flc_lock held! */
601 static void locks_delete_global_locks(struct file_lock *fl)
603 struct file_lock_list_struct *fll;
605 percpu_rwsem_assert_held(&file_rwsem);
608 * Avoid taking lock if already unhashed. This is safe since this check
609 * is done while holding the flc_lock, and new insertions into the list
610 * also require that it be held.
612 if (hlist_unhashed(&fl->fl_link))
615 fll = per_cpu_ptr(&file_lock_list, fl->fl_link_cpu);
616 spin_lock(&fll->lock);
617 hlist_del_init(&fl->fl_link);
618 spin_unlock(&fll->lock);
622 posix_owner_key(struct file_lock *fl)
624 return (unsigned long)fl->fl_owner;
627 static void locks_insert_global_blocked(struct file_lock *waiter)
629 lockdep_assert_held(&blocked_lock_lock);
631 hash_add(blocked_hash, &waiter->fl_link, posix_owner_key(waiter));
634 static void locks_delete_global_blocked(struct file_lock *waiter)
636 lockdep_assert_held(&blocked_lock_lock);
638 hash_del(&waiter->fl_link);
641 /* Remove waiter from blocker's block list.
642 * When blocker ends up pointing to itself then the list is empty.
644 * Must be called with blocked_lock_lock held.
646 static void __locks_delete_block(struct file_lock *waiter)
648 locks_delete_global_blocked(waiter);
649 list_del_init(&waiter->fl_blocked_member);
652 static void __locks_wake_up_blocks(struct file_lock *blocker)
654 while (!list_empty(&blocker->fl_blocked_requests)) {
655 struct file_lock *waiter;
657 waiter = list_first_entry(&blocker->fl_blocked_requests,
658 struct file_lock, fl_blocked_member);
659 __locks_delete_block(waiter);
660 if (waiter->fl_lmops && waiter->fl_lmops->lm_notify)
661 waiter->fl_lmops->lm_notify(waiter);
663 wake_up(&waiter->fl_wait);
666 * The setting of fl_blocker to NULL marks the "done"
667 * point in deleting a block. Paired with acquire at the top
668 * of locks_delete_block().
670 smp_store_release(&waiter->fl_blocker, NULL);
675 * locks_delete_block - stop waiting for a file lock
676 * @waiter: the lock which was waiting
678 * lockd/nfsd need to disconnect the lock while working on it.
680 int locks_delete_block(struct file_lock *waiter)
682 int status = -ENOENT;
685 * If fl_blocker is NULL, it won't be set again as this thread "owns"
686 * the lock and is the only one that might try to claim the lock.
688 * We use acquire/release to manage fl_blocker so that we can
689 * optimize away taking the blocked_lock_lock in many cases.
691 * The smp_load_acquire guarantees two things:
693 * 1/ that fl_blocked_requests can be tested locklessly. If something
694 * was recently added to that list it must have been in a locked region
695 * *before* the locked region when fl_blocker was set to NULL.
697 * 2/ that no other thread is accessing 'waiter', so it is safe to free
698 * it. __locks_wake_up_blocks is careful not to touch waiter after
699 * fl_blocker is released.
701 * If a lockless check of fl_blocker shows it to be NULL, we know that
702 * no new locks can be inserted into its fl_blocked_requests list, and
703 * can avoid doing anything further if the list is empty.
705 if (!smp_load_acquire(&waiter->fl_blocker) &&
706 list_empty(&waiter->fl_blocked_requests))
709 spin_lock(&blocked_lock_lock);
710 if (waiter->fl_blocker)
712 __locks_wake_up_blocks(waiter);
713 __locks_delete_block(waiter);
716 * The setting of fl_blocker to NULL marks the "done" point in deleting
717 * a block. Paired with acquire at the top of this function.
719 smp_store_release(&waiter->fl_blocker, NULL);
720 spin_unlock(&blocked_lock_lock);
723 EXPORT_SYMBOL(locks_delete_block);
725 /* Insert waiter into blocker's block list.
726 * We use a circular list so that processes can be easily woken up in
727 * the order they blocked. The documentation doesn't require this but
728 * it seems like the reasonable thing to do.
730 * Must be called with both the flc_lock and blocked_lock_lock held. The
731 * fl_blocked_requests list itself is protected by the blocked_lock_lock,
732 * but by ensuring that the flc_lock is also held on insertions we can avoid
733 * taking the blocked_lock_lock in some cases when we see that the
734 * fl_blocked_requests list is empty.
736 * Rather than just adding to the list, we check for conflicts with any existing
737 * waiters, and add beneath any waiter that blocks the new waiter.
738 * Thus wakeups don't happen until needed.
740 static void __locks_insert_block(struct file_lock *blocker,
741 struct file_lock *waiter,
742 bool conflict(struct file_lock *,
745 struct file_lock *fl;
746 BUG_ON(!list_empty(&waiter->fl_blocked_member));
749 list_for_each_entry(fl, &blocker->fl_blocked_requests, fl_blocked_member)
750 if (conflict(fl, waiter)) {
754 waiter->fl_blocker = blocker;
755 list_add_tail(&waiter->fl_blocked_member, &blocker->fl_blocked_requests);
756 if (IS_POSIX(blocker) && !IS_OFDLCK(blocker))
757 locks_insert_global_blocked(waiter);
759 /* The requests in waiter->fl_blocked are known to conflict with
760 * waiter, but might not conflict with blocker, or the requests
761 * and lock which block it. So they all need to be woken.
763 __locks_wake_up_blocks(waiter);
766 /* Must be called with flc_lock held. */
767 static void locks_insert_block(struct file_lock *blocker,
768 struct file_lock *waiter,
769 bool conflict(struct file_lock *,
772 spin_lock(&blocked_lock_lock);
773 __locks_insert_block(blocker, waiter, conflict);
774 spin_unlock(&blocked_lock_lock);
778 * Wake up processes blocked waiting for blocker.
780 * Must be called with the inode->flc_lock held!
782 static void locks_wake_up_blocks(struct file_lock *blocker)
785 * Avoid taking global lock if list is empty. This is safe since new
786 * blocked requests are only added to the list under the flc_lock, and
787 * the flc_lock is always held here. Note that removal from the
788 * fl_blocked_requests list does not require the flc_lock, so we must
789 * recheck list_empty() after acquiring the blocked_lock_lock.
791 if (list_empty(&blocker->fl_blocked_requests))
794 spin_lock(&blocked_lock_lock);
795 __locks_wake_up_blocks(blocker);
796 spin_unlock(&blocked_lock_lock);
800 locks_insert_lock_ctx(struct file_lock *fl, struct list_head *before)
802 list_add_tail(&fl->fl_list, before);
803 locks_insert_global_locks(fl);
807 locks_unlink_lock_ctx(struct file_lock *fl)
809 locks_delete_global_locks(fl);
810 list_del_init(&fl->fl_list);
811 locks_wake_up_blocks(fl);
815 locks_delete_lock_ctx(struct file_lock *fl, struct list_head *dispose)
817 locks_unlink_lock_ctx(fl);
819 list_add(&fl->fl_list, dispose);
824 /* Determine if lock sys_fl blocks lock caller_fl. Common functionality
825 * checks for shared/exclusive status of overlapping locks.
827 static bool locks_conflict(struct file_lock *caller_fl,
828 struct file_lock *sys_fl)
830 if (sys_fl->fl_type == F_WRLCK)
832 if (caller_fl->fl_type == F_WRLCK)
837 /* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
838 * checking before calling the locks_conflict().
840 static bool posix_locks_conflict(struct file_lock *caller_fl,
841 struct file_lock *sys_fl)
843 /* POSIX locks owned by the same process do not conflict with
846 if (posix_same_owner(caller_fl, sys_fl))
849 /* Check whether they overlap */
850 if (!locks_overlap(caller_fl, sys_fl))
853 return locks_conflict(caller_fl, sys_fl);
856 /* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
857 * checking before calling the locks_conflict().
859 static bool flock_locks_conflict(struct file_lock *caller_fl,
860 struct file_lock *sys_fl)
862 /* FLOCK locks referring to the same filp do not conflict with
865 if (caller_fl->fl_file == sys_fl->fl_file)
868 return locks_conflict(caller_fl, sys_fl);
872 posix_test_lock(struct file *filp, struct file_lock *fl)
874 struct file_lock *cfl;
875 struct file_lock_context *ctx;
876 struct inode *inode = locks_inode(filp);
878 ctx = smp_load_acquire(&inode->i_flctx);
879 if (!ctx || list_empty_careful(&ctx->flc_posix)) {
880 fl->fl_type = F_UNLCK;
884 spin_lock(&ctx->flc_lock);
885 list_for_each_entry(cfl, &ctx->flc_posix, fl_list) {
886 if (posix_locks_conflict(fl, cfl)) {
887 locks_copy_conflock(fl, cfl);
891 fl->fl_type = F_UNLCK;
893 spin_unlock(&ctx->flc_lock);
896 EXPORT_SYMBOL(posix_test_lock);
899 * Deadlock detection:
901 * We attempt to detect deadlocks that are due purely to posix file
904 * We assume that a task can be waiting for at most one lock at a time.
905 * So for any acquired lock, the process holding that lock may be
906 * waiting on at most one other lock. That lock in turns may be held by
907 * someone waiting for at most one other lock. Given a requested lock
908 * caller_fl which is about to wait for a conflicting lock block_fl, we
909 * follow this chain of waiters to ensure we are not about to create a
912 * Since we do this before we ever put a process to sleep on a lock, we
913 * are ensured that there is never a cycle; that is what guarantees that
914 * the while() loop in posix_locks_deadlock() eventually completes.
916 * Note: the above assumption may not be true when handling lock
917 * requests from a broken NFS client. It may also fail in the presence
918 * of tasks (such as posix threads) sharing the same open file table.
919 * To handle those cases, we just bail out after a few iterations.
921 * For FL_OFDLCK locks, the owner is the filp, not the files_struct.
922 * Because the owner is not even nominally tied to a thread of
923 * execution, the deadlock detection below can't reasonably work well. Just
926 * In principle, we could do a more limited deadlock detection on FL_OFDLCK
927 * locks that just checks for the case where two tasks are attempting to
928 * upgrade from read to write locks on the same inode.
931 #define MAX_DEADLK_ITERATIONS 10
933 /* Find a lock that the owner of the given block_fl is blocking on. */
934 static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
936 struct file_lock *fl;
938 hash_for_each_possible(blocked_hash, fl, fl_link, posix_owner_key(block_fl)) {
939 if (posix_same_owner(fl, block_fl)) {
940 while (fl->fl_blocker)
948 /* Must be called with the blocked_lock_lock held! */
949 static int posix_locks_deadlock(struct file_lock *caller_fl,
950 struct file_lock *block_fl)
954 lockdep_assert_held(&blocked_lock_lock);
957 * This deadlock detector can't reasonably detect deadlocks with
958 * FL_OFDLCK locks, since they aren't owned by a process, per-se.
960 if (IS_OFDLCK(caller_fl))
963 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
964 if (i++ > MAX_DEADLK_ITERATIONS)
966 if (posix_same_owner(caller_fl, block_fl))
972 /* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
973 * after any leases, but before any posix locks.
975 * Note that if called with an FL_EXISTS argument, the caller may determine
976 * whether or not a lock was successfully freed by testing the return
979 static int flock_lock_inode(struct inode *inode, struct file_lock *request)
981 struct file_lock *new_fl = NULL;
982 struct file_lock *fl;
983 struct file_lock_context *ctx;
988 ctx = locks_get_lock_context(inode, request->fl_type);
990 if (request->fl_type != F_UNLCK)
992 return (request->fl_flags & FL_EXISTS) ? -ENOENT : 0;
995 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
996 new_fl = locks_alloc_lock();
1001 percpu_down_read(&file_rwsem);
1002 spin_lock(&ctx->flc_lock);
1003 if (request->fl_flags & FL_ACCESS)
1006 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
1007 if (request->fl_file != fl->fl_file)
1009 if (request->fl_type == fl->fl_type)
1012 locks_delete_lock_ctx(fl, &dispose);
1016 if (request->fl_type == F_UNLCK) {
1017 if ((request->fl_flags & FL_EXISTS) && !found)
1023 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
1024 if (!flock_locks_conflict(request, fl))
1027 if (!(request->fl_flags & FL_SLEEP))
1029 error = FILE_LOCK_DEFERRED;
1030 locks_insert_block(fl, request, flock_locks_conflict);
1033 if (request->fl_flags & FL_ACCESS)
1035 locks_copy_lock(new_fl, request);
1036 locks_move_blocks(new_fl, request);
1037 locks_insert_lock_ctx(new_fl, &ctx->flc_flock);
1042 spin_unlock(&ctx->flc_lock);
1043 percpu_up_read(&file_rwsem);
1045 locks_free_lock(new_fl);
1046 locks_dispose_list(&dispose);
1047 trace_flock_lock_inode(inode, request, error);
1051 static int posix_lock_inode(struct inode *inode, struct file_lock *request,
1052 struct file_lock *conflock)
1054 struct file_lock *fl, *tmp;
1055 struct file_lock *new_fl = NULL;
1056 struct file_lock *new_fl2 = NULL;
1057 struct file_lock *left = NULL;
1058 struct file_lock *right = NULL;
1059 struct file_lock_context *ctx;
1064 ctx = locks_get_lock_context(inode, request->fl_type);
1066 return (request->fl_type == F_UNLCK) ? 0 : -ENOMEM;
1069 * We may need two file_lock structures for this operation,
1070 * so we get them in advance to avoid races.
1072 * In some cases we can be sure, that no new locks will be needed
1074 if (!(request->fl_flags & FL_ACCESS) &&
1075 (request->fl_type != F_UNLCK ||
1076 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
1077 new_fl = locks_alloc_lock();
1078 new_fl2 = locks_alloc_lock();
1081 percpu_down_read(&file_rwsem);
1082 spin_lock(&ctx->flc_lock);
1084 * New lock request. Walk all POSIX locks and look for conflicts. If
1085 * there are any, either return error or put the request on the
1086 * blocker's list of waiters and the global blocked_hash.
1088 if (request->fl_type != F_UNLCK) {
1089 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
1090 if (!posix_locks_conflict(request, fl))
1093 locks_copy_conflock(conflock, fl);
1095 if (!(request->fl_flags & FL_SLEEP))
1098 * Deadlock detection and insertion into the blocked
1099 * locks list must be done while holding the same lock!
1102 spin_lock(&blocked_lock_lock);
1104 * Ensure that we don't find any locks blocked on this
1105 * request during deadlock detection.
1107 __locks_wake_up_blocks(request);
1108 if (likely(!posix_locks_deadlock(request, fl))) {
1109 error = FILE_LOCK_DEFERRED;
1110 __locks_insert_block(fl, request,
1111 posix_locks_conflict);
1113 spin_unlock(&blocked_lock_lock);
1118 /* If we're just looking for a conflict, we're done. */
1120 if (request->fl_flags & FL_ACCESS)
1123 /* Find the first old lock with the same owner as the new lock */
1124 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
1125 if (posix_same_owner(request, fl))
1129 /* Process locks with this owner. */
1130 list_for_each_entry_safe_from(fl, tmp, &ctx->flc_posix, fl_list) {
1131 if (!posix_same_owner(request, fl))
1134 /* Detect adjacent or overlapping regions (if same lock type) */
1135 if (request->fl_type == fl->fl_type) {
1136 /* In all comparisons of start vs end, use
1137 * "start - 1" rather than "end + 1". If end
1138 * is OFFSET_MAX, end + 1 will become negative.
1140 if (fl->fl_end < request->fl_start - 1)
1142 /* If the next lock in the list has entirely bigger
1143 * addresses than the new one, insert the lock here.
1145 if (fl->fl_start - 1 > request->fl_end)
1148 /* If we come here, the new and old lock are of the
1149 * same type and adjacent or overlapping. Make one
1150 * lock yielding from the lower start address of both
1151 * locks to the higher end address.
1153 if (fl->fl_start > request->fl_start)
1154 fl->fl_start = request->fl_start;
1156 request->fl_start = fl->fl_start;
1157 if (fl->fl_end < request->fl_end)
1158 fl->fl_end = request->fl_end;
1160 request->fl_end = fl->fl_end;
1162 locks_delete_lock_ctx(fl, &dispose);
1168 /* Processing for different lock types is a bit
1171 if (fl->fl_end < request->fl_start)
1173 if (fl->fl_start > request->fl_end)
1175 if (request->fl_type == F_UNLCK)
1177 if (fl->fl_start < request->fl_start)
1179 /* If the next lock in the list has a higher end
1180 * address than the new one, insert the new one here.
1182 if (fl->fl_end > request->fl_end) {
1186 if (fl->fl_start >= request->fl_start) {
1187 /* The new lock completely replaces an old
1188 * one (This may happen several times).
1191 locks_delete_lock_ctx(fl, &dispose);
1195 * Replace the old lock with new_fl, and
1196 * remove the old one. It's safe to do the
1197 * insert here since we know that we won't be
1198 * using new_fl later, and that the lock is
1199 * just replacing an existing lock.
1204 locks_copy_lock(new_fl, request);
1205 locks_move_blocks(new_fl, request);
1208 locks_insert_lock_ctx(request, &fl->fl_list);
1209 locks_delete_lock_ctx(fl, &dispose);
1216 * The above code only modifies existing locks in case of merging or
1217 * replacing. If new lock(s) need to be inserted all modifications are
1218 * done below this, so it's safe yet to bail out.
1220 error = -ENOLCK; /* "no luck" */
1221 if (right && left == right && !new_fl2)
1226 if (request->fl_type == F_UNLCK) {
1227 if (request->fl_flags & FL_EXISTS)
1236 locks_copy_lock(new_fl, request);
1237 locks_move_blocks(new_fl, request);
1238 locks_insert_lock_ctx(new_fl, &fl->fl_list);
1243 if (left == right) {
1244 /* The new lock breaks the old one in two pieces,
1245 * so we have to use the second new lock.
1249 locks_copy_lock(left, right);
1250 locks_insert_lock_ctx(left, &fl->fl_list);
1252 right->fl_start = request->fl_end + 1;
1253 locks_wake_up_blocks(right);
1256 left->fl_end = request->fl_start - 1;
1257 locks_wake_up_blocks(left);
1260 spin_unlock(&ctx->flc_lock);
1261 percpu_up_read(&file_rwsem);
1263 * Free any unused locks.
1266 locks_free_lock(new_fl);
1268 locks_free_lock(new_fl2);
1269 locks_dispose_list(&dispose);
1270 trace_posix_lock_inode(inode, request, error);
1276 * posix_lock_file - Apply a POSIX-style lock to a file
1277 * @filp: The file to apply the lock to
1278 * @fl: The lock to be applied
1279 * @conflock: Place to return a copy of the conflicting lock, if found.
1281 * Add a POSIX style lock to a file.
1282 * We merge adjacent & overlapping locks whenever possible.
1283 * POSIX locks are sorted by owner task, then by starting address
1285 * Note that if called with an FL_EXISTS argument, the caller may determine
1286 * whether or not a lock was successfully freed by testing the return
1287 * value for -ENOENT.
1289 int posix_lock_file(struct file *filp, struct file_lock *fl,
1290 struct file_lock *conflock)
1292 return posix_lock_inode(locks_inode(filp), fl, conflock);
1294 EXPORT_SYMBOL(posix_lock_file);
1297 * posix_lock_inode_wait - Apply a POSIX-style lock to a file
1298 * @inode: inode of file to which lock request should be applied
1299 * @fl: The lock to be applied
1301 * Apply a POSIX style lock request to an inode.
1303 static int posix_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1308 error = posix_lock_inode(inode, fl, NULL);
1309 if (error != FILE_LOCK_DEFERRED)
1311 error = wait_event_interruptible(fl->fl_wait,
1312 list_empty(&fl->fl_blocked_member));
1316 locks_delete_block(fl);
1320 static void lease_clear_pending(struct file_lock *fl, int arg)
1324 fl->fl_flags &= ~FL_UNLOCK_PENDING;
1327 fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
1331 /* We already had a lease on this file; just change its type */
1332 int lease_modify(struct file_lock *fl, int arg, struct list_head *dispose)
1334 int error = assign_type(fl, arg);
1338 lease_clear_pending(fl, arg);
1339 locks_wake_up_blocks(fl);
1340 if (arg == F_UNLCK) {
1341 struct file *filp = fl->fl_file;
1344 filp->f_owner.signum = 0;
1345 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
1346 if (fl->fl_fasync != NULL) {
1347 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
1348 fl->fl_fasync = NULL;
1350 locks_delete_lock_ctx(fl, dispose);
1354 EXPORT_SYMBOL(lease_modify);
1356 static bool past_time(unsigned long then)
1359 /* 0 is a special value meaning "this never expires": */
1361 return time_after(jiffies, then);
1364 static void time_out_leases(struct inode *inode, struct list_head *dispose)
1366 struct file_lock_context *ctx = inode->i_flctx;
1367 struct file_lock *fl, *tmp;
1369 lockdep_assert_held(&ctx->flc_lock);
1371 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
1372 trace_time_out_leases(inode, fl);
1373 if (past_time(fl->fl_downgrade_time))
1374 lease_modify(fl, F_RDLCK, dispose);
1375 if (past_time(fl->fl_break_time))
1376 lease_modify(fl, F_UNLCK, dispose);
1380 static bool leases_conflict(struct file_lock *lease, struct file_lock *breaker)
1384 if (lease->fl_lmops->lm_breaker_owns_lease
1385 && lease->fl_lmops->lm_breaker_owns_lease(lease))
1387 if ((breaker->fl_flags & FL_LAYOUT) != (lease->fl_flags & FL_LAYOUT)) {
1391 if ((breaker->fl_flags & FL_DELEG) && (lease->fl_flags & FL_LEASE)) {
1396 rc = locks_conflict(breaker, lease);
1398 trace_leases_conflict(rc, lease, breaker);
1403 any_leases_conflict(struct inode *inode, struct file_lock *breaker)
1405 struct file_lock_context *ctx = inode->i_flctx;
1406 struct file_lock *fl;
1408 lockdep_assert_held(&ctx->flc_lock);
1410 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1411 if (leases_conflict(fl, breaker))
1418 * __break_lease - revoke all outstanding leases on file
1419 * @inode: the inode of the file to return
1420 * @mode: O_RDONLY: break only write leases; O_WRONLY or O_RDWR:
1422 * @type: FL_LEASE: break leases and delegations; FL_DELEG: break
1425 * break_lease (inlined for speed) has checked there already is at least
1426 * some kind of lock (maybe a lease) on this file. Leases are broken on
1427 * a call to open() or truncate(). This function can sleep unless you
1428 * specified %O_NONBLOCK to your open().
1430 int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
1433 struct file_lock_context *ctx;
1434 struct file_lock *new_fl, *fl, *tmp;
1435 unsigned long break_time;
1436 int want_write = (mode & O_ACCMODE) != O_RDONLY;
1439 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
1441 return PTR_ERR(new_fl);
1442 new_fl->fl_flags = type;
1444 /* typically we will check that ctx is non-NULL before calling */
1445 ctx = smp_load_acquire(&inode->i_flctx);
1451 percpu_down_read(&file_rwsem);
1452 spin_lock(&ctx->flc_lock);
1454 time_out_leases(inode, &dispose);
1456 if (!any_leases_conflict(inode, new_fl))
1460 if (lease_break_time > 0) {
1461 break_time = jiffies + lease_break_time * HZ;
1462 if (break_time == 0)
1463 break_time++; /* so that 0 means no break time */
1466 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
1467 if (!leases_conflict(fl, new_fl))
1470 if (fl->fl_flags & FL_UNLOCK_PENDING)
1472 fl->fl_flags |= FL_UNLOCK_PENDING;
1473 fl->fl_break_time = break_time;
1475 if (lease_breaking(fl))
1477 fl->fl_flags |= FL_DOWNGRADE_PENDING;
1478 fl->fl_downgrade_time = break_time;
1480 if (fl->fl_lmops->lm_break(fl))
1481 locks_delete_lock_ctx(fl, &dispose);
1484 if (list_empty(&ctx->flc_lease))
1487 if (mode & O_NONBLOCK) {
1488 trace_break_lease_noblock(inode, new_fl);
1489 error = -EWOULDBLOCK;
1494 fl = list_first_entry(&ctx->flc_lease, struct file_lock, fl_list);
1495 break_time = fl->fl_break_time;
1496 if (break_time != 0)
1497 break_time -= jiffies;
1498 if (break_time == 0)
1500 locks_insert_block(fl, new_fl, leases_conflict);
1501 trace_break_lease_block(inode, new_fl);
1502 spin_unlock(&ctx->flc_lock);
1503 percpu_up_read(&file_rwsem);
1505 locks_dispose_list(&dispose);
1506 error = wait_event_interruptible_timeout(new_fl->fl_wait,
1507 list_empty(&new_fl->fl_blocked_member),
1510 percpu_down_read(&file_rwsem);
1511 spin_lock(&ctx->flc_lock);
1512 trace_break_lease_unblock(inode, new_fl);
1513 locks_delete_block(new_fl);
1516 * Wait for the next conflicting lease that has not been
1520 time_out_leases(inode, &dispose);
1521 if (any_leases_conflict(inode, new_fl))
1526 spin_unlock(&ctx->flc_lock);
1527 percpu_up_read(&file_rwsem);
1528 locks_dispose_list(&dispose);
1530 locks_free_lock(new_fl);
1533 EXPORT_SYMBOL(__break_lease);
1536 * lease_get_mtime - update modified time of an inode with exclusive lease
1538 * @time: pointer to a timespec which contains the last modified time
1540 * This is to force NFS clients to flush their caches for files with
1541 * exclusive leases. The justification is that if someone has an
1542 * exclusive lease, then they could be modifying it.
1544 void lease_get_mtime(struct inode *inode, struct timespec64 *time)
1546 bool has_lease = false;
1547 struct file_lock_context *ctx;
1548 struct file_lock *fl;
1550 ctx = smp_load_acquire(&inode->i_flctx);
1551 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
1552 spin_lock(&ctx->flc_lock);
1553 fl = list_first_entry_or_null(&ctx->flc_lease,
1554 struct file_lock, fl_list);
1555 if (fl && (fl->fl_type == F_WRLCK))
1557 spin_unlock(&ctx->flc_lock);
1561 *time = current_time(inode);
1563 EXPORT_SYMBOL(lease_get_mtime);
1566 * fcntl_getlease - Enquire what lease is currently active
1569 * The value returned by this function will be one of
1570 * (if no lease break is pending):
1572 * %F_RDLCK to indicate a shared lease is held.
1574 * %F_WRLCK to indicate an exclusive lease is held.
1576 * %F_UNLCK to indicate no lease is held.
1578 * (if a lease break is pending):
1580 * %F_RDLCK to indicate an exclusive lease needs to be
1581 * changed to a shared lease (or removed).
1583 * %F_UNLCK to indicate the lease needs to be removed.
1585 * XXX: sfr & willy disagree over whether F_INPROGRESS
1586 * should be returned to userspace.
1588 int fcntl_getlease(struct file *filp)
1590 struct file_lock *fl;
1591 struct inode *inode = locks_inode(filp);
1592 struct file_lock_context *ctx;
1596 ctx = smp_load_acquire(&inode->i_flctx);
1597 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
1598 percpu_down_read(&file_rwsem);
1599 spin_lock(&ctx->flc_lock);
1600 time_out_leases(inode, &dispose);
1601 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1602 if (fl->fl_file != filp)
1604 type = target_leasetype(fl);
1607 spin_unlock(&ctx->flc_lock);
1608 percpu_up_read(&file_rwsem);
1610 locks_dispose_list(&dispose);
1616 * check_conflicting_open - see if the given file points to an inode that has
1617 * an existing open that would conflict with the
1619 * @filp: file to check
1620 * @arg: type of lease that we're trying to acquire
1621 * @flags: current lock flags
1623 * Check to see if there's an existing open fd on this file that would
1624 * conflict with the lease we're trying to set.
1627 check_conflicting_open(struct file *filp, const long arg, int flags)
1629 struct inode *inode = locks_inode(filp);
1630 int self_wcount = 0, self_rcount = 0;
1632 if (flags & FL_LAYOUT)
1634 if (flags & FL_DELEG)
1635 /* We leave these checks to the caller */
1639 return inode_is_open_for_write(inode) ? -EAGAIN : 0;
1640 else if (arg != F_WRLCK)
1644 * Make sure that only read/write count is from lease requestor.
1645 * Note that this will result in denying write leases when i_writecount
1646 * is negative, which is what we want. (We shouldn't grant write leases
1647 * on files open for execution.)
1649 if (filp->f_mode & FMODE_WRITE)
1651 else if (filp->f_mode & FMODE_READ)
1654 if (atomic_read(&inode->i_writecount) != self_wcount ||
1655 atomic_read(&inode->i_readcount) != self_rcount)
1662 generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **priv)
1664 struct file_lock *fl, *my_fl = NULL, *lease;
1665 struct inode *inode = locks_inode(filp);
1666 struct file_lock_context *ctx;
1667 bool is_deleg = (*flp)->fl_flags & FL_DELEG;
1672 trace_generic_add_lease(inode, lease);
1674 /* Note that arg is never F_UNLCK here */
1675 ctx = locks_get_lock_context(inode, arg);
1680 * In the delegation case we need mutual exclusion with
1681 * a number of operations that take the i_mutex. We trylock
1682 * because delegations are an optional optimization, and if
1683 * there's some chance of a conflict--we'd rather not
1684 * bother, maybe that's a sign this just isn't a good file to
1685 * hand out a delegation on.
1687 if (is_deleg && !inode_trylock(inode))
1690 if (is_deleg && arg == F_WRLCK) {
1691 /* Write delegations are not currently supported: */
1692 inode_unlock(inode);
1697 percpu_down_read(&file_rwsem);
1698 spin_lock(&ctx->flc_lock);
1699 time_out_leases(inode, &dispose);
1700 error = check_conflicting_open(filp, arg, lease->fl_flags);
1705 * At this point, we know that if there is an exclusive
1706 * lease on this file, then we hold it on this filp
1707 * (otherwise our open of this file would have blocked).
1708 * And if we are trying to acquire an exclusive lease,
1709 * then the file is not open by anyone (including us)
1710 * except for this filp.
1713 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1714 if (fl->fl_file == filp &&
1715 fl->fl_owner == lease->fl_owner) {
1721 * No exclusive leases if someone else has a lease on
1727 * Modifying our existing lease is OK, but no getting a
1728 * new lease if someone else is opening for write:
1730 if (fl->fl_flags & FL_UNLOCK_PENDING)
1734 if (my_fl != NULL) {
1736 error = lease->fl_lmops->lm_change(lease, arg, &dispose);
1746 locks_insert_lock_ctx(lease, &ctx->flc_lease);
1748 * The check in break_lease() is lockless. It's possible for another
1749 * open to race in after we did the earlier check for a conflicting
1750 * open but before the lease was inserted. Check again for a
1751 * conflicting open and cancel the lease if there is one.
1753 * We also add a barrier here to ensure that the insertion of the lock
1754 * precedes these checks.
1757 error = check_conflicting_open(filp, arg, lease->fl_flags);
1759 locks_unlink_lock_ctx(lease);
1764 if (lease->fl_lmops->lm_setup)
1765 lease->fl_lmops->lm_setup(lease, priv);
1767 spin_unlock(&ctx->flc_lock);
1768 percpu_up_read(&file_rwsem);
1769 locks_dispose_list(&dispose);
1771 inode_unlock(inode);
1772 if (!error && !my_fl)
1777 static int generic_delete_lease(struct file *filp, void *owner)
1779 int error = -EAGAIN;
1780 struct file_lock *fl, *victim = NULL;
1781 struct inode *inode = locks_inode(filp);
1782 struct file_lock_context *ctx;
1785 ctx = smp_load_acquire(&inode->i_flctx);
1787 trace_generic_delete_lease(inode, NULL);
1791 percpu_down_read(&file_rwsem);
1792 spin_lock(&ctx->flc_lock);
1793 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1794 if (fl->fl_file == filp &&
1795 fl->fl_owner == owner) {
1800 trace_generic_delete_lease(inode, victim);
1802 error = fl->fl_lmops->lm_change(victim, F_UNLCK, &dispose);
1803 spin_unlock(&ctx->flc_lock);
1804 percpu_up_read(&file_rwsem);
1805 locks_dispose_list(&dispose);
1810 * generic_setlease - sets a lease on an open file
1811 * @filp: file pointer
1812 * @arg: type of lease to obtain
1813 * @flp: input - file_lock to use, output - file_lock inserted
1814 * @priv: private data for lm_setup (may be NULL if lm_setup
1815 * doesn't require it)
1817 * The (input) flp->fl_lmops->lm_break function is required
1820 int generic_setlease(struct file *filp, long arg, struct file_lock **flp,
1823 struct inode *inode = locks_inode(filp);
1826 if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
1828 if (!S_ISREG(inode->i_mode))
1830 error = security_file_lock(filp, arg);
1836 return generic_delete_lease(filp, *priv);
1839 if (!(*flp)->fl_lmops->lm_break) {
1844 return generic_add_lease(filp, arg, flp, priv);
1849 EXPORT_SYMBOL(generic_setlease);
1851 #if IS_ENABLED(CONFIG_SRCU)
1853 * Kernel subsystems can register to be notified on any attempt to set
1854 * a new lease with the lease_notifier_chain. This is used by (e.g.) nfsd
1855 * to close files that it may have cached when there is an attempt to set a
1856 * conflicting lease.
1858 static struct srcu_notifier_head lease_notifier_chain;
1861 lease_notifier_chain_init(void)
1863 srcu_init_notifier_head(&lease_notifier_chain);
1867 setlease_notifier(long arg, struct file_lock *lease)
1870 srcu_notifier_call_chain(&lease_notifier_chain, arg, lease);
1873 int lease_register_notifier(struct notifier_block *nb)
1875 return srcu_notifier_chain_register(&lease_notifier_chain, nb);
1877 EXPORT_SYMBOL_GPL(lease_register_notifier);
1879 void lease_unregister_notifier(struct notifier_block *nb)
1881 srcu_notifier_chain_unregister(&lease_notifier_chain, nb);
1883 EXPORT_SYMBOL_GPL(lease_unregister_notifier);
1885 #else /* !IS_ENABLED(CONFIG_SRCU) */
1887 lease_notifier_chain_init(void)
1892 setlease_notifier(long arg, struct file_lock *lease)
1896 int lease_register_notifier(struct notifier_block *nb)
1900 EXPORT_SYMBOL_GPL(lease_register_notifier);
1902 void lease_unregister_notifier(struct notifier_block *nb)
1905 EXPORT_SYMBOL_GPL(lease_unregister_notifier);
1907 #endif /* IS_ENABLED(CONFIG_SRCU) */
1910 * vfs_setlease - sets a lease on an open file
1911 * @filp: file pointer
1912 * @arg: type of lease to obtain
1913 * @lease: file_lock to use when adding a lease
1914 * @priv: private info for lm_setup when adding a lease (may be
1915 * NULL if lm_setup doesn't require it)
1917 * Call this to establish a lease on the file. The "lease" argument is not
1918 * used for F_UNLCK requests and may be NULL. For commands that set or alter
1919 * an existing lease, the ``(*lease)->fl_lmops->lm_break`` operation must be
1920 * set; if not, this function will return -ENOLCK (and generate a scary-looking
1923 * The "priv" pointer is passed directly to the lm_setup function as-is. It
1924 * may be NULL if the lm_setup operation doesn't require it.
1927 vfs_setlease(struct file *filp, long arg, struct file_lock **lease, void **priv)
1930 setlease_notifier(arg, *lease);
1931 if (filp->f_op->setlease)
1932 return filp->f_op->setlease(filp, arg, lease, priv);
1934 return generic_setlease(filp, arg, lease, priv);
1936 EXPORT_SYMBOL_GPL(vfs_setlease);
1938 static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
1940 struct file_lock *fl;
1941 struct fasync_struct *new;
1944 fl = lease_alloc(filp, arg);
1948 new = fasync_alloc();
1950 locks_free_lock(fl);
1955 error = vfs_setlease(filp, arg, &fl, (void **)&new);
1957 locks_free_lock(fl);
1964 * fcntl_setlease - sets a lease on an open file
1965 * @fd: open file descriptor
1966 * @filp: file pointer
1967 * @arg: type of lease to obtain
1969 * Call this fcntl to establish a lease on the file.
1970 * Note that you also need to call %F_SETSIG to
1971 * receive a signal when the lease is broken.
1973 int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1976 return vfs_setlease(filp, F_UNLCK, NULL, (void **)&filp);
1977 return do_fcntl_add_lease(fd, filp, arg);
1981 * flock_lock_inode_wait - Apply a FLOCK-style lock to a file
1982 * @inode: inode of the file to apply to
1983 * @fl: The lock to be applied
1985 * Apply a FLOCK style lock request to an inode.
1987 static int flock_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1992 error = flock_lock_inode(inode, fl);
1993 if (error != FILE_LOCK_DEFERRED)
1995 error = wait_event_interruptible(fl->fl_wait,
1996 list_empty(&fl->fl_blocked_member));
2000 locks_delete_block(fl);
2005 * locks_lock_inode_wait - Apply a lock to an inode
2006 * @inode: inode of the file to apply to
2007 * @fl: The lock to be applied
2009 * Apply a POSIX or FLOCK style lock request to an inode.
2011 int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
2014 switch (fl->fl_flags & (FL_POSIX|FL_FLOCK)) {
2016 res = posix_lock_inode_wait(inode, fl);
2019 res = flock_lock_inode_wait(inode, fl);
2026 EXPORT_SYMBOL(locks_lock_inode_wait);
2029 * sys_flock: - flock() system call.
2030 * @fd: the file descriptor to lock.
2031 * @cmd: the type of lock to apply.
2033 * Apply a %FL_FLOCK style lock to an open file descriptor.
2034 * The @cmd can be one of:
2036 * - %LOCK_SH -- a shared lock.
2037 * - %LOCK_EX -- an exclusive lock.
2038 * - %LOCK_UN -- remove an existing lock.
2039 * - %LOCK_MAND -- a 'mandatory' flock. (DEPRECATED)
2041 * %LOCK_MAND support has been removed from the kernel.
2043 SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
2045 struct fd f = fdget(fd);
2046 struct file_lock *lock;
2047 int can_sleep, unlock;
2054 can_sleep = !(cmd & LOCK_NB);
2056 unlock = (cmd == LOCK_UN);
2058 if (!unlock && !(f.file->f_mode & (FMODE_READ|FMODE_WRITE)))
2062 * LOCK_MAND locks were broken for a long time in that they never
2063 * conflicted with one another and didn't prevent any sort of open,
2064 * read or write activity.
2066 * Just ignore these requests now, to preserve legacy behavior, but
2067 * throw a warning to let people know that they don't actually work.
2069 if (cmd & LOCK_MAND) {
2070 pr_warn_once("Attempt to set a LOCK_MAND lock via flock(2). This support has been removed and the request ignored.\n");
2075 lock = flock_make_lock(f.file, cmd, NULL);
2077 error = PTR_ERR(lock);
2082 lock->fl_flags |= FL_SLEEP;
2084 error = security_file_lock(f.file, lock->fl_type);
2088 if (f.file->f_op->flock)
2089 error = f.file->f_op->flock(f.file,
2090 (can_sleep) ? F_SETLKW : F_SETLK,
2093 error = locks_lock_file_wait(f.file, lock);
2096 locks_free_lock(lock);
2105 * vfs_test_lock - test file byte range lock
2106 * @filp: The file to test lock for
2107 * @fl: The lock to test; also used to hold result
2109 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
2110 * setting conf->fl_type to something other than F_UNLCK.
2112 int vfs_test_lock(struct file *filp, struct file_lock *fl)
2114 if (filp->f_op->lock)
2115 return filp->f_op->lock(filp, F_GETLK, fl);
2116 posix_test_lock(filp, fl);
2119 EXPORT_SYMBOL_GPL(vfs_test_lock);
2122 * locks_translate_pid - translate a file_lock's fl_pid number into a namespace
2123 * @fl: The file_lock who's fl_pid should be translated
2124 * @ns: The namespace into which the pid should be translated
2126 * Used to tranlate a fl_pid into a namespace virtual pid number
2128 static pid_t locks_translate_pid(struct file_lock *fl, struct pid_namespace *ns)
2135 if (IS_REMOTELCK(fl))
2138 * If the flock owner process is dead and its pid has been already
2139 * freed, the translation below won't work, but we still want to show
2140 * flock owner pid number in init pidns.
2142 if (ns == &init_pid_ns)
2143 return (pid_t)fl->fl_pid;
2146 pid = find_pid_ns(fl->fl_pid, &init_pid_ns);
2147 vnr = pid_nr_ns(pid, ns);
2152 static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
2154 flock->l_pid = locks_translate_pid(fl, task_active_pid_ns(current));
2155 #if BITS_PER_LONG == 32
2157 * Make sure we can represent the posix lock via
2158 * legacy 32bit flock.
2160 if (fl->fl_start > OFFT_OFFSET_MAX)
2162 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
2165 flock->l_start = fl->fl_start;
2166 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2167 fl->fl_end - fl->fl_start + 1;
2168 flock->l_whence = 0;
2169 flock->l_type = fl->fl_type;
2173 #if BITS_PER_LONG == 32
2174 static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
2176 flock->l_pid = locks_translate_pid(fl, task_active_pid_ns(current));
2177 flock->l_start = fl->fl_start;
2178 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2179 fl->fl_end - fl->fl_start + 1;
2180 flock->l_whence = 0;
2181 flock->l_type = fl->fl_type;
2185 /* Report the first existing lock that would conflict with l.
2186 * This implements the F_GETLK command of fcntl().
2188 int fcntl_getlk(struct file *filp, unsigned int cmd, struct flock *flock)
2190 struct file_lock *fl;
2193 fl = locks_alloc_lock();
2197 if (flock->l_type != F_RDLCK && flock->l_type != F_WRLCK)
2200 error = flock_to_posix_lock(filp, fl, flock);
2204 if (cmd == F_OFD_GETLK) {
2206 if (flock->l_pid != 0)
2209 fl->fl_flags |= FL_OFDLCK;
2210 fl->fl_owner = filp;
2213 error = vfs_test_lock(filp, fl);
2217 flock->l_type = fl->fl_type;
2218 if (fl->fl_type != F_UNLCK) {
2219 error = posix_lock_to_flock(flock, fl);
2224 locks_free_lock(fl);
2229 * vfs_lock_file - file byte range lock
2230 * @filp: The file to apply the lock to
2231 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
2232 * @fl: The lock to be applied
2233 * @conf: Place to return a copy of the conflicting lock, if found.
2235 * A caller that doesn't care about the conflicting lock may pass NULL
2236 * as the final argument.
2238 * If the filesystem defines a private ->lock() method, then @conf will
2239 * be left unchanged; so a caller that cares should initialize it to
2240 * some acceptable default.
2242 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
2243 * locks, the ->lock() interface may return asynchronously, before the lock has
2244 * been granted or denied by the underlying filesystem, if (and only if)
2245 * lm_grant is set. Callers expecting ->lock() to return asynchronously
2246 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
2247 * the request is for a blocking lock. When ->lock() does return asynchronously,
2248 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
2249 * request completes.
2250 * If the request is for non-blocking lock the file system should return
2251 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
2252 * with the result. If the request timed out the callback routine will return a
2253 * nonzero return code and the file system should release the lock. The file
2254 * system is also responsible to keep a corresponding posix lock when it
2255 * grants a lock so the VFS can find out which locks are locally held and do
2256 * the correct lock cleanup when required.
2257 * The underlying filesystem must not drop the kernel lock or call
2258 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
2261 int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
2263 if (filp->f_op->lock)
2264 return filp->f_op->lock(filp, cmd, fl);
2266 return posix_lock_file(filp, fl, conf);
2268 EXPORT_SYMBOL_GPL(vfs_lock_file);
2270 static int do_lock_file_wait(struct file *filp, unsigned int cmd,
2271 struct file_lock *fl)
2275 error = security_file_lock(filp, fl->fl_type);
2280 error = vfs_lock_file(filp, cmd, fl, NULL);
2281 if (error != FILE_LOCK_DEFERRED)
2283 error = wait_event_interruptible(fl->fl_wait,
2284 list_empty(&fl->fl_blocked_member));
2288 locks_delete_block(fl);
2293 /* Ensure that fl->fl_file has compatible f_mode for F_SETLK calls */
2295 check_fmode_for_setlk(struct file_lock *fl)
2297 switch (fl->fl_type) {
2299 if (!(fl->fl_file->f_mode & FMODE_READ))
2303 if (!(fl->fl_file->f_mode & FMODE_WRITE))
2309 /* Apply the lock described by l to an open file descriptor.
2310 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2312 int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
2313 struct flock *flock)
2315 struct file_lock *file_lock = locks_alloc_lock();
2316 struct inode *inode = locks_inode(filp);
2320 if (file_lock == NULL)
2323 error = flock_to_posix_lock(filp, file_lock, flock);
2327 error = check_fmode_for_setlk(file_lock);
2332 * If the cmd is requesting file-private locks, then set the
2333 * FL_OFDLCK flag and override the owner.
2338 if (flock->l_pid != 0)
2342 file_lock->fl_flags |= FL_OFDLCK;
2343 file_lock->fl_owner = filp;
2347 if (flock->l_pid != 0)
2351 file_lock->fl_flags |= FL_OFDLCK;
2352 file_lock->fl_owner = filp;
2355 file_lock->fl_flags |= FL_SLEEP;
2358 error = do_lock_file_wait(filp, cmd, file_lock);
2361 * Attempt to detect a close/fcntl race and recover by releasing the
2362 * lock that was just acquired. There is no need to do that when we're
2363 * unlocking though, or for OFD locks.
2365 if (!error && file_lock->fl_type != F_UNLCK &&
2366 !(file_lock->fl_flags & FL_OFDLCK)) {
2367 struct files_struct *files = current->files;
2369 * We need that spin_lock here - it prevents reordering between
2370 * update of i_flctx->flc_posix and check for it done in
2371 * close(). rcu_read_lock() wouldn't do.
2373 spin_lock(&files->file_lock);
2374 f = files_lookup_fd_locked(files, fd);
2375 spin_unlock(&files->file_lock);
2377 file_lock->fl_type = F_UNLCK;
2378 error = do_lock_file_wait(filp, cmd, file_lock);
2379 WARN_ON_ONCE(error);
2384 trace_fcntl_setlk(inode, file_lock, error);
2385 locks_free_lock(file_lock);
2389 #if BITS_PER_LONG == 32
2390 /* Report the first existing lock that would conflict with l.
2391 * This implements the F_GETLK command of fcntl().
2393 int fcntl_getlk64(struct file *filp, unsigned int cmd, struct flock64 *flock)
2395 struct file_lock *fl;
2398 fl = locks_alloc_lock();
2403 if (flock->l_type != F_RDLCK && flock->l_type != F_WRLCK)
2406 error = flock64_to_posix_lock(filp, fl, flock);
2410 if (cmd == F_OFD_GETLK) {
2412 if (flock->l_pid != 0)
2416 fl->fl_flags |= FL_OFDLCK;
2417 fl->fl_owner = filp;
2420 error = vfs_test_lock(filp, fl);
2424 flock->l_type = fl->fl_type;
2425 if (fl->fl_type != F_UNLCK)
2426 posix_lock_to_flock64(flock, fl);
2429 locks_free_lock(fl);
2433 /* Apply the lock described by l to an open file descriptor.
2434 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2436 int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
2437 struct flock64 *flock)
2439 struct file_lock *file_lock = locks_alloc_lock();
2443 if (file_lock == NULL)
2446 error = flock64_to_posix_lock(filp, file_lock, flock);
2450 error = check_fmode_for_setlk(file_lock);
2455 * If the cmd is requesting file-private locks, then set the
2456 * FL_OFDLCK flag and override the owner.
2461 if (flock->l_pid != 0)
2465 file_lock->fl_flags |= FL_OFDLCK;
2466 file_lock->fl_owner = filp;
2470 if (flock->l_pid != 0)
2474 file_lock->fl_flags |= FL_OFDLCK;
2475 file_lock->fl_owner = filp;
2478 file_lock->fl_flags |= FL_SLEEP;
2481 error = do_lock_file_wait(filp, cmd, file_lock);
2484 * Attempt to detect a close/fcntl race and recover by releasing the
2485 * lock that was just acquired. There is no need to do that when we're
2486 * unlocking though, or for OFD locks.
2488 if (!error && file_lock->fl_type != F_UNLCK &&
2489 !(file_lock->fl_flags & FL_OFDLCK)) {
2490 struct files_struct *files = current->files;
2492 * We need that spin_lock here - it prevents reordering between
2493 * update of i_flctx->flc_posix and check for it done in
2494 * close(). rcu_read_lock() wouldn't do.
2496 spin_lock(&files->file_lock);
2497 f = files_lookup_fd_locked(files, fd);
2498 spin_unlock(&files->file_lock);
2500 file_lock->fl_type = F_UNLCK;
2501 error = do_lock_file_wait(filp, cmd, file_lock);
2502 WARN_ON_ONCE(error);
2507 locks_free_lock(file_lock);
2510 #endif /* BITS_PER_LONG == 32 */
2513 * This function is called when the file is being removed
2514 * from the task's fd array. POSIX locks belonging to this task
2515 * are deleted at this time.
2517 void locks_remove_posix(struct file *filp, fl_owner_t owner)
2520 struct inode *inode = locks_inode(filp);
2521 struct file_lock lock;
2522 struct file_lock_context *ctx;
2525 * If there are no locks held on this file, we don't need to call
2526 * posix_lock_file(). Another process could be setting a lock on this
2527 * file at the same time, but we wouldn't remove that lock anyway.
2529 ctx = smp_load_acquire(&inode->i_flctx);
2530 if (!ctx || list_empty(&ctx->flc_posix))
2533 locks_init_lock(&lock);
2534 lock.fl_type = F_UNLCK;
2535 lock.fl_flags = FL_POSIX | FL_CLOSE;
2537 lock.fl_end = OFFSET_MAX;
2538 lock.fl_owner = owner;
2539 lock.fl_pid = current->tgid;
2540 lock.fl_file = filp;
2542 lock.fl_lmops = NULL;
2544 error = vfs_lock_file(filp, F_SETLK, &lock, NULL);
2546 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2547 lock.fl_ops->fl_release_private(&lock);
2548 trace_locks_remove_posix(inode, &lock, error);
2550 EXPORT_SYMBOL(locks_remove_posix);
2552 /* The i_flctx must be valid when calling into here */
2554 locks_remove_flock(struct file *filp, struct file_lock_context *flctx)
2556 struct file_lock fl;
2557 struct inode *inode = locks_inode(filp);
2559 if (list_empty(&flctx->flc_flock))
2562 flock_make_lock(filp, LOCK_UN, &fl);
2563 fl.fl_flags |= FL_CLOSE;
2565 if (filp->f_op->flock)
2566 filp->f_op->flock(filp, F_SETLKW, &fl);
2568 flock_lock_inode(inode, &fl);
2570 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2571 fl.fl_ops->fl_release_private(&fl);
2574 /* The i_flctx must be valid when calling into here */
2576 locks_remove_lease(struct file *filp, struct file_lock_context *ctx)
2578 struct file_lock *fl, *tmp;
2581 if (list_empty(&ctx->flc_lease))
2584 percpu_down_read(&file_rwsem);
2585 spin_lock(&ctx->flc_lock);
2586 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list)
2587 if (filp == fl->fl_file)
2588 lease_modify(fl, F_UNLCK, &dispose);
2589 spin_unlock(&ctx->flc_lock);
2590 percpu_up_read(&file_rwsem);
2592 locks_dispose_list(&dispose);
2596 * This function is called on the last close of an open file.
2598 void locks_remove_file(struct file *filp)
2600 struct file_lock_context *ctx;
2602 ctx = smp_load_acquire(&locks_inode(filp)->i_flctx);
2606 /* remove any OFD locks */
2607 locks_remove_posix(filp, filp);
2609 /* remove flock locks */
2610 locks_remove_flock(filp, ctx);
2612 /* remove any leases */
2613 locks_remove_lease(filp, ctx);
2615 spin_lock(&ctx->flc_lock);
2616 locks_check_ctx_file_list(filp, &ctx->flc_posix, "POSIX");
2617 locks_check_ctx_file_list(filp, &ctx->flc_flock, "FLOCK");
2618 locks_check_ctx_file_list(filp, &ctx->flc_lease, "LEASE");
2619 spin_unlock(&ctx->flc_lock);
2623 * vfs_cancel_lock - file byte range unblock lock
2624 * @filp: The file to apply the unblock to
2625 * @fl: The lock to be unblocked
2627 * Used by lock managers to cancel blocked requests
2629 int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2631 if (filp->f_op->lock)
2632 return filp->f_op->lock(filp, F_CANCELLK, fl);
2635 EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2637 #ifdef CONFIG_PROC_FS
2638 #include <linux/proc_fs.h>
2639 #include <linux/seq_file.h>
2641 struct locks_iterator {
2646 static void lock_get_status(struct seq_file *f, struct file_lock *fl,
2647 loff_t id, char *pfx, int repeat)
2649 struct inode *inode = NULL;
2650 unsigned int fl_pid;
2651 struct pid_namespace *proc_pidns = proc_pid_ns(file_inode(f->file)->i_sb);
2654 fl_pid = locks_translate_pid(fl, proc_pidns);
2656 * If lock owner is dead (and pid is freed) or not visible in current
2657 * pidns, zero is shown as a pid value. Check lock info from
2658 * init_pid_ns to get saved lock pid value.
2661 if (fl->fl_file != NULL)
2662 inode = locks_inode(fl->fl_file);
2664 seq_printf(f, "%lld: ", id);
2667 seq_printf(f, "%*s", repeat - 1 + (int)strlen(pfx), pfx);
2670 if (fl->fl_flags & FL_ACCESS)
2671 seq_puts(f, "ACCESS");
2672 else if (IS_OFDLCK(fl))
2673 seq_puts(f, "OFDLCK");
2675 seq_puts(f, "POSIX ");
2677 seq_printf(f, " %s ",
2678 (inode == NULL) ? "*NOINODE*" : "ADVISORY ");
2679 } else if (IS_FLOCK(fl)) {
2680 seq_puts(f, "FLOCK ADVISORY ");
2681 } else if (IS_LEASE(fl)) {
2682 if (fl->fl_flags & FL_DELEG)
2683 seq_puts(f, "DELEG ");
2685 seq_puts(f, "LEASE ");
2687 if (lease_breaking(fl))
2688 seq_puts(f, "BREAKING ");
2689 else if (fl->fl_file)
2690 seq_puts(f, "ACTIVE ");
2692 seq_puts(f, "BREAKER ");
2694 seq_puts(f, "UNKNOWN UNKNOWN ");
2696 type = IS_LEASE(fl) ? target_leasetype(fl) : fl->fl_type;
2698 seq_printf(f, "%s ", (type == F_WRLCK) ? "WRITE" :
2699 (type == F_RDLCK) ? "READ" : "UNLCK");
2701 /* userspace relies on this representation of dev_t */
2702 seq_printf(f, "%d %02x:%02x:%lu ", fl_pid,
2703 MAJOR(inode->i_sb->s_dev),
2704 MINOR(inode->i_sb->s_dev), inode->i_ino);
2706 seq_printf(f, "%d <none>:0 ", fl_pid);
2709 if (fl->fl_end == OFFSET_MAX)
2710 seq_printf(f, "%Ld EOF\n", fl->fl_start);
2712 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
2714 seq_puts(f, "0 EOF\n");
2718 static struct file_lock *get_next_blocked_member(struct file_lock *node)
2720 struct file_lock *tmp;
2722 /* NULL node or root node */
2723 if (node == NULL || node->fl_blocker == NULL)
2726 /* Next member in the linked list could be itself */
2727 tmp = list_next_entry(node, fl_blocked_member);
2728 if (list_entry_is_head(tmp, &node->fl_blocker->fl_blocked_requests, fl_blocked_member)
2736 static int locks_show(struct seq_file *f, void *v)
2738 struct locks_iterator *iter = f->private;
2739 struct file_lock *cur, *tmp;
2740 struct pid_namespace *proc_pidns = proc_pid_ns(file_inode(f->file)->i_sb);
2743 cur = hlist_entry(v, struct file_lock, fl_link);
2745 if (locks_translate_pid(cur, proc_pidns) == 0)
2748 /* View this crossed linked list as a binary tree, the first member of fl_blocked_requests
2749 * is the left child of current node, the next silibing in fl_blocked_member is the
2750 * right child, we can alse get the parent of current node from fl_blocker, so this
2751 * question becomes traversal of a binary tree
2753 while (cur != NULL) {
2755 lock_get_status(f, cur, iter->li_pos, "-> ", level);
2757 lock_get_status(f, cur, iter->li_pos, "", level);
2759 if (!list_empty(&cur->fl_blocked_requests)) {
2761 cur = list_first_entry_or_null(&cur->fl_blocked_requests,
2762 struct file_lock, fl_blocked_member);
2766 tmp = get_next_blocked_member(cur);
2767 /* Fall back to parent node */
2768 while (tmp == NULL && cur->fl_blocker != NULL) {
2769 cur = cur->fl_blocker;
2771 tmp = get_next_blocked_member(cur);
2780 static void __show_fd_locks(struct seq_file *f,
2781 struct list_head *head, int *id,
2782 struct file *filp, struct files_struct *files)
2784 struct file_lock *fl;
2786 list_for_each_entry(fl, head, fl_list) {
2788 if (filp != fl->fl_file)
2790 if (fl->fl_owner != files &&
2791 fl->fl_owner != filp)
2795 seq_puts(f, "lock:\t");
2796 lock_get_status(f, fl, *id, "", 0);
2800 void show_fd_locks(struct seq_file *f,
2801 struct file *filp, struct files_struct *files)
2803 struct inode *inode = locks_inode(filp);
2804 struct file_lock_context *ctx;
2807 ctx = smp_load_acquire(&inode->i_flctx);
2811 spin_lock(&ctx->flc_lock);
2812 __show_fd_locks(f, &ctx->flc_flock, &id, filp, files);
2813 __show_fd_locks(f, &ctx->flc_posix, &id, filp, files);
2814 __show_fd_locks(f, &ctx->flc_lease, &id, filp, files);
2815 spin_unlock(&ctx->flc_lock);
2818 static void *locks_start(struct seq_file *f, loff_t *pos)
2819 __acquires(&blocked_lock_lock)
2821 struct locks_iterator *iter = f->private;
2823 iter->li_pos = *pos + 1;
2824 percpu_down_write(&file_rwsem);
2825 spin_lock(&blocked_lock_lock);
2826 return seq_hlist_start_percpu(&file_lock_list.hlist, &iter->li_cpu, *pos);
2829 static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2831 struct locks_iterator *iter = f->private;
2834 return seq_hlist_next_percpu(v, &file_lock_list.hlist, &iter->li_cpu, pos);
2837 static void locks_stop(struct seq_file *f, void *v)
2838 __releases(&blocked_lock_lock)
2840 spin_unlock(&blocked_lock_lock);
2841 percpu_up_write(&file_rwsem);
2844 static const struct seq_operations locks_seq_operations = {
2845 .start = locks_start,
2851 static int __init proc_locks_init(void)
2853 proc_create_seq_private("locks", 0, NULL, &locks_seq_operations,
2854 sizeof(struct locks_iterator), NULL);
2857 fs_initcall(proc_locks_init);
2860 static int __init filelock_init(void)
2864 flctx_cache = kmem_cache_create("file_lock_ctx",
2865 sizeof(struct file_lock_context), 0, SLAB_PANIC, NULL);
2867 filelock_cache = kmem_cache_create("file_lock_cache",
2868 sizeof(struct file_lock), 0, SLAB_PANIC, NULL);
2870 for_each_possible_cpu(i) {
2871 struct file_lock_list_struct *fll = per_cpu_ptr(&file_lock_list, i);
2873 spin_lock_init(&fll->lock);
2874 INIT_HLIST_HEAD(&fll->hlist);
2877 lease_notifier_chain_init();
2880 core_initcall(filelock_init);