blob: 75a03a9d666e96debb8c478ab09130b8d3f19965 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/fs/locks.c
3 *
4 * Provide support for fcntl()'s F_GETLK, F_SETLK, and F_SETLKW calls.
5 * Doug Evans (dje@spiff.uucp), August 07, 1992
6 *
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.
11 *
12 * Miscellaneous edits, and a total rewrite of posix_lock_file() code.
13 * Kai Petzke (wpp@marie.physik.tu-berlin.de), 1994
14 *
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
18 *
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
26 *
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
30 *
31 * Implemented two lock personalities - FL_FLOCK and FL_POSIX.
32 *
33 * FL_POSIX locks are created with calls to fcntl() and lockf() through the
34 * fcntl() system call. They have the semantics described above.
35 *
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.
39 *
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
44 * unlocked).
45 *
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
51 *
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.
55 *
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.
60 *
61 * Initial implementation of mandatory locks. SunOS turned out to be
62 * a rotten model, so I implemented the "obvious" semantics.
Paul Bolle395cf962011-08-15 02:02:26 +020063 * See 'Documentation/filesystems/mandatory-locking.txt' for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 * Andy Walker (andy@lysaker.kvaerner.no), April 06, 1996.
65 *
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
69 * Manual, Section 2.
70 * Andy Walker (andy@lysaker.kvaerner.no), April 09, 1996.
71 *
72 * Tidied up block list handling. Added '/proc/locks' interface.
73 * Andy Walker (andy@lysaker.kvaerner.no), April 24, 1996.
74 *
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.
78 *
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.
84 *
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.
88 *
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.
93 *
94 * Made the block list a circular list to minimise searching in the list.
95 * Andy Walker (andy@lysaker.kvaerner.no), Sep 25, 1996.
96 *
97 * Made mandatory locking a mount option. Default is not to allow mandatory
98 * locking.
99 * Andy Walker (andy@lysaker.kvaerner.no), Oct 04, 1996.
100 *
101 * Some adaptations for NFS support.
102 * Olaf Kirch (okir@monad.swb.de), Dec 1996,
103 *
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.
106 *
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.
111 *
112 * Leases and LOCK_MAND
113 * Matthew Wilcox <willy@debian.org>, June, 2000.
114 * Stephen Rothwell <sfr@canb.auug.org.au>, June, 2000.
NeilBrownfd7732e2018-11-30 10:04:08 +1100115 *
116 * Locking conflicts and dependencies:
117 * If multiple threads attempt to lock the same byte (or flock the same file)
118 * only one can be granted the lock, and other must wait their turn.
119 * The first lock has been "applied" or "granted", the others are "waiting"
120 * and are "blocked" by the "applied" lock..
121 *
122 * Waiting and applied locks are all kept in trees whose properties are:
123 *
124 * - the root of a tree may be an applied or waiting lock.
125 * - every other node in the tree is a waiting lock that
126 * conflicts with every ancestor of that node.
127 *
128 * Every such tree begins life as a waiting singleton which obviously
129 * satisfies the above properties.
130 *
131 * The only ways we modify trees preserve these properties:
132 *
133 * 1. We may add a new leaf node, but only after first verifying that it
134 * conflicts with all of its ancestors.
135 * 2. We may remove the root of a tree, creating a new singleton
136 * tree from the root and N new trees rooted in the immediate
137 * children.
138 * 3. If the root of a tree is not currently an applied lock, we may
139 * apply it (if possible).
140 * 4. We may upgrade the root of the tree (either extend its range,
141 * or upgrade its entire range from read to write).
142 *
143 * When an applied lock is modified in a way that reduces or downgrades any
144 * part of its range, we remove all its children (2 above). This particularly
145 * happens when a lock is unlocked.
146 *
147 * For each of those child trees we "wake up" the thread which is
148 * waiting for the lock so it can continue handling as follows: if the
149 * root of the tree applies, we do so (3). If it doesn't, it must
150 * conflict with some applied lock. We remove (wake up) all of its children
151 * (2), and add it is a new leaf to the tree rooted in the applied
152 * lock (1). We then repeat the process recursively with those
153 * children.
154 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 */
156
157#include <linux/capability.h>
158#include <linux/file.h>
Al Viro9f3acc32008-04-24 07:44:08 -0400159#include <linux/fdtable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160#include <linux/fs.h>
161#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162#include <linux/security.h>
163#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164#include <linux/syscalls.h>
165#include <linux/time.h>
Dipankar Sarma4fb3a532005-09-16 19:28:13 -0700166#include <linux/rcupdate.h>
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000167#include <linux/pid_namespace.h>
Jeff Layton48f74182013-06-21 08:58:18 -0400168#include <linux/hashtable.h>
Jeff Layton7012b022013-06-21 08:58:22 -0400169#include <linux/percpu.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
Jeff Layton62af4f12014-05-09 14:13:05 -0400171#define CREATE_TRACE_POINTS
172#include <trace/events/filelock.h>
173
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -0800174#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
176#define IS_POSIX(fl) (fl->fl_flags & FL_POSIX)
177#define IS_FLOCK(fl) (fl->fl_flags & FL_FLOCK)
Christoph Hellwig11afe9f2015-01-21 19:17:03 +0100178#define IS_LEASE(fl) (fl->fl_flags & (FL_LEASE|FL_DELEG|FL_LAYOUT))
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400179#define IS_OFDLCK(fl) (fl->fl_flags & FL_OFDLCK)
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -0400180#define IS_REMOTELCK(fl) (fl->fl_pid <= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -0400182static bool lease_breaking(struct file_lock *fl)
183{
J. Bruce Fields778fc542011-07-26 18:25:49 -0400184 return fl->fl_flags & (FL_UNLOCK_PENDING | FL_DOWNGRADE_PENDING);
185}
186
187static int target_leasetype(struct file_lock *fl)
188{
189 if (fl->fl_flags & FL_UNLOCK_PENDING)
190 return F_UNLCK;
191 if (fl->fl_flags & FL_DOWNGRADE_PENDING)
192 return F_RDLCK;
193 return fl->fl_type;
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -0400194}
195
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196int leases_enable = 1;
197int lease_break_time = 45;
198
Jeff Layton1c8c6012013-06-21 08:58:15 -0400199/*
Jeff Layton7012b022013-06-21 08:58:22 -0400200 * The global file_lock_list is only used for displaying /proc/locks, so we
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200201 * keep a list on each CPU, with each list protected by its own spinlock.
202 * Global serialization is done using file_rwsem.
203 *
204 * Note that alterations to the list also require that the relevant flc_lock is
205 * held.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400206 */
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200207struct file_lock_list_struct {
208 spinlock_t lock;
209 struct hlist_head hlist;
210};
211static DEFINE_PER_CPU(struct file_lock_list_struct, file_lock_list);
Peter Zijlstraaba37662015-06-22 14:16:33 +0200212DEFINE_STATIC_PERCPU_RWSEM(file_rwsem);
Jeff Layton88974692013-06-21 08:58:14 -0400213
Jeff Layton1c8c6012013-06-21 08:58:15 -0400214/*
Jeff Layton48f74182013-06-21 08:58:18 -0400215 * The blocked_hash is used to find POSIX lock loops for deadlock detection.
Jeff Layton7b2296a2013-06-21 08:58:20 -0400216 * It is protected by blocked_lock_lock.
Jeff Layton48f74182013-06-21 08:58:18 -0400217 *
218 * We hash locks by lockowner in order to optimize searching for the lock a
219 * particular lockowner is waiting on.
220 *
221 * FIXME: make this value scale via some heuristic? We generally will want more
222 * buckets when we have more lockowners holding locks, but that's a little
223 * difficult to determine without knowing what the workload will look like.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400224 */
Jeff Layton48f74182013-06-21 08:58:18 -0400225#define BLOCKED_HASH_BITS 7
226static DEFINE_HASHTABLE(blocked_hash, BLOCKED_HASH_BITS);
Jeff Layton88974692013-06-21 08:58:14 -0400227
Jeff Layton1c8c6012013-06-21 08:58:15 -0400228/*
Jeff Layton7b2296a2013-06-21 08:58:20 -0400229 * This lock protects the blocked_hash. Generally, if you're accessing it, you
230 * want to be holding this lock.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400231 *
NeilBrownada5c1d2018-11-30 10:04:08 +1100232 * In addition, it also protects the fl->fl_blocked_requests list, and the
233 * fl->fl_blocker pointer for file_lock structures that are acting as lock
234 * requests (in contrast to those that are acting as records of acquired locks).
Jeff Layton1c8c6012013-06-21 08:58:15 -0400235 *
236 * Note that when we acquire this lock in order to change the above fields,
Jeff Layton6109c852015-01-16 15:05:57 -0500237 * we often hold the flc_lock as well. In certain cases, when reading the fields
Jeff Layton1c8c6012013-06-21 08:58:15 -0400238 * protected by this lock, we can skip acquiring it iff we already hold the
Jeff Layton6109c852015-01-16 15:05:57 -0500239 * flc_lock.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400240 */
Jeff Layton7b2296a2013-06-21 08:58:20 -0400241static DEFINE_SPINLOCK(blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
Jeff Layton4a075e32015-01-16 15:05:54 -0500243static struct kmem_cache *flctx_cache __read_mostly;
Christoph Lametere18b8902006-12-06 20:33:20 -0800244static struct kmem_cache *filelock_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
Jeff Layton4a075e32015-01-16 15:05:54 -0500246static struct file_lock_context *
Jeff Layton5c1c6692015-04-03 09:04:03 -0400247locks_get_lock_context(struct inode *inode, int type)
Jeff Layton4a075e32015-01-16 15:05:54 -0500248{
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200249 struct file_lock_context *ctx;
Jeff Layton4a075e32015-01-16 15:05:54 -0500250
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200251 /* paired with cmpxchg() below */
252 ctx = smp_load_acquire(&inode->i_flctx);
253 if (likely(ctx) || type == F_UNLCK)
Jeff Layton4a075e32015-01-16 15:05:54 -0500254 goto out;
255
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200256 ctx = kmem_cache_alloc(flctx_cache, GFP_KERNEL);
257 if (!ctx)
Jeff Layton4a075e32015-01-16 15:05:54 -0500258 goto out;
259
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200260 spin_lock_init(&ctx->flc_lock);
261 INIT_LIST_HEAD(&ctx->flc_flock);
262 INIT_LIST_HEAD(&ctx->flc_posix);
263 INIT_LIST_HEAD(&ctx->flc_lease);
Jeff Layton4a075e32015-01-16 15:05:54 -0500264
265 /*
266 * Assign the pointer if it's not already assigned. If it is, then
267 * free the context we just allocated.
268 */
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200269 if (cmpxchg(&inode->i_flctx, NULL, ctx)) {
270 kmem_cache_free(flctx_cache, ctx);
271 ctx = smp_load_acquire(&inode->i_flctx);
272 }
Jeff Layton4a075e32015-01-16 15:05:54 -0500273out:
Jeff Layton18909102016-01-06 21:26:10 -0500274 trace_locks_get_lock_context(inode, type, ctx);
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200275 return ctx;
Jeff Layton4a075e32015-01-16 15:05:54 -0500276}
277
Jeff Laytone24dada2016-01-06 21:28:41 -0500278static void
279locks_dump_ctx_list(struct list_head *list, char *list_type)
280{
281 struct file_lock *fl;
282
283 list_for_each_entry(fl, list, fl_list) {
284 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);
285 }
286}
287
288static void
289locks_check_ctx_lists(struct inode *inode)
290{
291 struct file_lock_context *ctx = inode->i_flctx;
292
293 if (unlikely(!list_empty(&ctx->flc_flock) ||
294 !list_empty(&ctx->flc_posix) ||
295 !list_empty(&ctx->flc_lease))) {
296 pr_warn("Leaked locks on dev=0x%x:0x%x ino=0x%lx:\n",
297 MAJOR(inode->i_sb->s_dev), MINOR(inode->i_sb->s_dev),
298 inode->i_ino);
299 locks_dump_ctx_list(&ctx->flc_flock, "FLOCK");
300 locks_dump_ctx_list(&ctx->flc_posix, "POSIX");
301 locks_dump_ctx_list(&ctx->flc_lease, "LEASE");
302 }
303}
304
Benjamin Coddington39537042017-07-21 13:36:25 -0400305static void
306locks_check_ctx_file_list(struct file *filp, struct list_head *list,
307 char *list_type)
308{
309 struct file_lock *fl;
310 struct inode *inode = locks_inode(filp);
311
312 list_for_each_entry(fl, list, fl_list)
313 if (fl->fl_file == filp)
314 pr_warn("Leaked %s lock on dev=0x%x:0x%x ino=0x%lx "
315 " fl_owner=%p fl_flags=0x%x fl_type=0x%x fl_pid=%u\n",
316 list_type, MAJOR(inode->i_sb->s_dev),
317 MINOR(inode->i_sb->s_dev), inode->i_ino,
318 fl->fl_owner, fl->fl_flags, fl->fl_type, fl->fl_pid);
319}
320
Jeff Layton4a075e32015-01-16 15:05:54 -0500321void
Jeff Laytonf27a0fe2016-01-07 15:08:51 -0500322locks_free_lock_context(struct inode *inode)
Jeff Layton4a075e32015-01-16 15:05:54 -0500323{
Jeff Laytonf27a0fe2016-01-07 15:08:51 -0500324 struct file_lock_context *ctx = inode->i_flctx;
325
Jeff Laytone24dada2016-01-06 21:28:41 -0500326 if (unlikely(ctx)) {
327 locks_check_ctx_lists(inode);
Jeff Layton4a075e32015-01-16 15:05:54 -0500328 kmem_cache_free(flctx_cache, ctx);
329 }
330}
331
Miklos Szerediee19cc42011-07-07 13:06:09 +0200332static void locks_init_lock_heads(struct file_lock *fl)
Miklos Szeredia51cb912011-07-06 12:33:55 +0200333{
Jeff Layton139ca042013-06-21 08:58:17 -0400334 INIT_HLIST_NODE(&fl->fl_link);
Jeff Layton6dee60f2015-01-16 15:05:54 -0500335 INIT_LIST_HEAD(&fl->fl_list);
NeilBrownada5c1d2018-11-30 10:04:08 +1100336 INIT_LIST_HEAD(&fl->fl_blocked_requests);
337 INIT_LIST_HEAD(&fl->fl_blocked_member);
Miklos Szerediee19cc42011-07-07 13:06:09 +0200338 init_waitqueue_head(&fl->fl_wait);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200339}
340
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341/* Allocate an empty lock structure. */
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200342struct file_lock *locks_alloc_lock(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200344 struct file_lock *fl = kmem_cache_zalloc(filelock_cache, GFP_KERNEL);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200345
346 if (fl)
Miklos Szerediee19cc42011-07-07 13:06:09 +0200347 locks_init_lock_heads(fl);
Miklos Szeredia51cb912011-07-06 12:33:55 +0200348
349 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350}
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +0200351EXPORT_SYMBOL_GPL(locks_alloc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500353void locks_release_private(struct file_lock *fl)
Trond Myklebust47831f32006-03-20 13:44:05 -0500354{
355 if (fl->fl_ops) {
356 if (fl->fl_ops->fl_release_private)
357 fl->fl_ops->fl_release_private(fl);
358 fl->fl_ops = NULL;
359 }
Trond Myklebust47831f32006-03-20 13:44:05 -0500360
Kinglong Mee5c97d7b2014-08-22 10:18:43 -0400361 if (fl->fl_lmops) {
Jeff Laytoncae80b32015-04-03 09:04:04 -0400362 if (fl->fl_lmops->lm_put_owner) {
363 fl->fl_lmops->lm_put_owner(fl->fl_owner);
364 fl->fl_owner = NULL;
365 }
Kinglong Mee5c97d7b2014-08-22 10:18:43 -0400366 fl->fl_lmops = NULL;
367 }
Trond Myklebust47831f32006-03-20 13:44:05 -0500368}
Felix Blyakhera9e61e22009-03-31 15:12:56 -0500369EXPORT_SYMBOL_GPL(locks_release_private);
Trond Myklebust47831f32006-03-20 13:44:05 -0500370
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371/* Free a lock which is not in use. */
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400372void locks_free_lock(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373{
Miklos Szeredi5ce29642006-03-31 02:30:29 -0800374 BUG_ON(waitqueue_active(&fl->fl_wait));
Jeff Layton6dee60f2015-01-16 15:05:54 -0500375 BUG_ON(!list_empty(&fl->fl_list));
NeilBrownada5c1d2018-11-30 10:04:08 +1100376 BUG_ON(!list_empty(&fl->fl_blocked_requests));
377 BUG_ON(!list_empty(&fl->fl_blocked_member));
Jeff Layton139ca042013-06-21 08:58:17 -0400378 BUG_ON(!hlist_unhashed(&fl->fl_link));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379
Trond Myklebust47831f32006-03-20 13:44:05 -0500380 locks_release_private(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 kmem_cache_free(filelock_cache, fl);
382}
J. Bruce Fields05fa3132010-10-30 17:31:15 -0400383EXPORT_SYMBOL(locks_free_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384
Jeff Laytoned9814d2014-08-11 14:20:31 -0400385static void
386locks_dispose_list(struct list_head *dispose)
387{
388 struct file_lock *fl;
389
390 while (!list_empty(dispose)) {
Jeff Layton6dee60f2015-01-16 15:05:54 -0500391 fl = list_first_entry(dispose, struct file_lock, fl_list);
392 list_del_init(&fl->fl_list);
Jeff Laytoned9814d2014-08-11 14:20:31 -0400393 locks_free_lock(fl);
394 }
395}
396
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397void locks_init_lock(struct file_lock *fl)
398{
Miklos Szerediee19cc42011-07-07 13:06:09 +0200399 memset(fl, 0, sizeof(struct file_lock));
400 locks_init_lock_heads(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401}
402
403EXPORT_SYMBOL(locks_init_lock);
404
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405/*
406 * Initialize a new lock from an existing file_lock structure.
407 */
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400408void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409{
410 new->fl_owner = fl->fl_owner;
411 new->fl_pid = fl->fl_pid;
Trond Myklebust09969052006-03-20 13:44:38 -0500412 new->fl_file = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 new->fl_flags = fl->fl_flags;
414 new->fl_type = fl->fl_type;
415 new->fl_start = fl->fl_start;
416 new->fl_end = fl->fl_end;
Kinglong Meef3282962014-08-22 10:18:43 -0400417 new->fl_lmops = fl->fl_lmops;
Trond Myklebust09969052006-03-20 13:44:38 -0500418 new->fl_ops = NULL;
Kinglong Meef3282962014-08-22 10:18:43 -0400419
420 if (fl->fl_lmops) {
421 if (fl->fl_lmops->lm_get_owner)
Jeff Laytoncae80b32015-04-03 09:04:04 -0400422 fl->fl_lmops->lm_get_owner(fl->fl_owner);
Kinglong Meef3282962014-08-22 10:18:43 -0400423 }
Trond Myklebust09969052006-03-20 13:44:38 -0500424}
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400425EXPORT_SYMBOL(locks_copy_conflock);
Trond Myklebust09969052006-03-20 13:44:38 -0500426
427void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
428{
Jeff Layton566709b2014-08-11 14:09:35 -0400429 /* "new" must be a freshly-initialized lock */
430 WARN_ON_ONCE(new->fl_ops);
Trond Myklebust09969052006-03-20 13:44:38 -0500431
Kinglong Mee3fe0fff12014-08-22 10:18:42 -0400432 locks_copy_conflock(new, fl);
Kinglong Meef3282962014-08-22 10:18:43 -0400433
Trond Myklebust09969052006-03-20 13:44:38 -0500434 new->fl_file = fl->fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 new->fl_ops = fl->fl_ops;
Trond Myklebust47831f32006-03-20 13:44:05 -0500436
Kinglong Meef3282962014-08-22 10:18:43 -0400437 if (fl->fl_ops) {
438 if (fl->fl_ops->fl_copy_lock)
439 fl->fl_ops->fl_copy_lock(new, fl);
440 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441}
442
443EXPORT_SYMBOL(locks_copy_lock);
444
NeilBrown5946c432018-11-30 10:04:08 +1100445static void locks_move_blocks(struct file_lock *new, struct file_lock *fl)
446{
447 struct file_lock *f;
448
449 /*
450 * As ctx->flc_lock is held, new requests cannot be added to
451 * ->fl_blocked_requests, so we don't need a lock to check if it
452 * is empty.
453 */
454 if (list_empty(&fl->fl_blocked_requests))
455 return;
456 spin_lock(&blocked_lock_lock);
457 list_splice_init(&fl->fl_blocked_requests, &new->fl_blocked_requests);
458 list_for_each_entry(f, &fl->fl_blocked_requests, fl_blocked_member)
459 f->fl_blocker = new;
460 spin_unlock(&blocked_lock_lock);
461}
462
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463static inline int flock_translate_cmd(int cmd) {
464 if (cmd & LOCK_MAND)
465 return cmd & (LOCK_MAND | LOCK_RW);
466 switch (cmd) {
467 case LOCK_SH:
468 return F_RDLCK;
469 case LOCK_EX:
470 return F_WRLCK;
471 case LOCK_UN:
472 return F_UNLCK;
473 }
474 return -EINVAL;
475}
476
477/* Fill in a file_lock structure with an appropriate FLOCK lock. */
Jeff Layton6e129d002014-09-04 10:25:06 -0400478static struct file_lock *
NeilBrownd6367d62018-11-30 10:04:08 +1100479flock_make_lock(struct file *filp, unsigned int cmd, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 int type = flock_translate_cmd(cmd);
Jeff Layton6e129d002014-09-04 10:25:06 -0400482
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 if (type < 0)
Jeff Layton6e129d002014-09-04 10:25:06 -0400484 return ERR_PTR(type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485
NeilBrownd6367d62018-11-30 10:04:08 +1100486 if (fl == NULL) {
487 fl = locks_alloc_lock();
488 if (fl == NULL)
489 return ERR_PTR(-ENOMEM);
490 } else {
491 locks_init_lock(fl);
492 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493
494 fl->fl_file = filp;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +0200495 fl->fl_owner = filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 fl->fl_pid = current->tgid;
497 fl->fl_flags = FL_FLOCK;
498 fl->fl_type = type;
499 fl->fl_end = OFFSET_MAX;
500
Jeff Layton6e129d002014-09-04 10:25:06 -0400501 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502}
503
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400504static int assign_type(struct file_lock *fl, long type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505{
506 switch (type) {
507 case F_RDLCK:
508 case F_WRLCK:
509 case F_UNLCK:
510 fl->fl_type = type;
511 break;
512 default:
513 return -EINVAL;
514 }
515 return 0;
516}
517
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500518static int flock64_to_posix_lock(struct file *filp, struct file_lock *fl,
519 struct flock64 *l)
520{
521 switch (l->l_whence) {
522 case SEEK_SET:
523 fl->fl_start = 0;
524 break;
525 case SEEK_CUR:
526 fl->fl_start = filp->f_pos;
527 break;
528 case SEEK_END:
529 fl->fl_start = i_size_read(file_inode(filp));
530 break;
531 default:
532 return -EINVAL;
533 }
534 if (l->l_start > OFFSET_MAX - fl->fl_start)
535 return -EOVERFLOW;
536 fl->fl_start += l->l_start;
537 if (fl->fl_start < 0)
538 return -EINVAL;
539
540 /* POSIX-1996 leaves the case l->l_len < 0 undefined;
541 POSIX-2001 defines it. */
542 if (l->l_len > 0) {
543 if (l->l_len - 1 > OFFSET_MAX - fl->fl_start)
544 return -EOVERFLOW;
545 fl->fl_end = fl->fl_start + l->l_len - 1;
546
547 } else if (l->l_len < 0) {
548 if (fl->fl_start + l->l_len < 0)
549 return -EINVAL;
550 fl->fl_end = fl->fl_start - 1;
551 fl->fl_start += l->l_len;
552 } else
553 fl->fl_end = OFFSET_MAX;
554
555 fl->fl_owner = current->files;
556 fl->fl_pid = current->tgid;
557 fl->fl_file = filp;
558 fl->fl_flags = FL_POSIX;
559 fl->fl_ops = NULL;
560 fl->fl_lmops = NULL;
561
562 return assign_type(fl, l->l_type);
563}
564
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565/* Verify a "struct flock" and copy it to a "struct file_lock" as a POSIX
566 * style lock.
567 */
568static int flock_to_posix_lock(struct file *filp, struct file_lock *fl,
569 struct flock *l)
570{
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500571 struct flock64 ll = {
572 .l_type = l->l_type,
573 .l_whence = l->l_whence,
574 .l_start = l->l_start,
575 .l_len = l->l_len,
576 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577
J. Bruce Fieldsef12e722014-02-03 12:13:08 -0500578 return flock64_to_posix_lock(filp, fl, &ll);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579}
580
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581/* default lease lock manager operations */
Jeff Layton4d01b7f2014-09-01 15:06:54 -0400582static bool
583lease_break_callback(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584{
585 kill_fasync(&fl->fl_fasync, SIGIO, POLL_MSG);
Jeff Layton4d01b7f2014-09-01 15:06:54 -0400586 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587}
588
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400589static void
590lease_setup(struct file_lock *fl, void **priv)
591{
592 struct file *filp = fl->fl_file;
593 struct fasync_struct *fa = *priv;
594
595 /*
596 * fasync_insert_entry() returns the old entry if any. If there was no
597 * old entry, then it used "priv" and inserted it into the fasync list.
598 * Clear the pointer to indicate that it shouldn't be freed.
599 */
600 if (!fasync_insert_entry(fa->fa_fd, filp, &fl->fl_fasync, fa))
601 *priv = NULL;
602
Eric W. Biederman01919132017-07-16 22:05:57 -0500603 __f_setown(filp, task_pid(current), PIDTYPE_TGID, 0);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400604}
605
Alexey Dobriyan7b021962009-09-21 17:01:12 -0700606static const struct lock_manager_operations lease_manager_ops = {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400607 .lm_break = lease_break_callback,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400608 .lm_change = lease_modify,
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400609 .lm_setup = lease_setup,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610};
611
612/*
613 * Initialize a lease, use the default lock manager operations
614 */
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400615static int lease_init(struct file *filp, long type, struct file_lock *fl)
Joe Perches447a5642018-03-21 15:09:32 -0700616{
Trond Myklebust75dff552006-05-07 23:02:42 -0400617 if (assign_type(fl, type) != 0)
618 return -EINVAL;
619
Jeff Layton7ca76312014-09-01 19:04:48 -0400620 fl->fl_owner = filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 fl->fl_pid = current->tgid;
622
623 fl->fl_file = filp;
624 fl->fl_flags = FL_LEASE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 fl->fl_start = 0;
626 fl->fl_end = OFFSET_MAX;
627 fl->fl_ops = NULL;
628 fl->fl_lmops = &lease_manager_ops;
629 return 0;
630}
631
632/* Allocate a file_lock initialised to this type of lease */
J. Bruce Fields0ec4f432012-07-23 15:17:17 -0400633static struct file_lock *lease_alloc(struct file *filp, long type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634{
635 struct file_lock *fl = locks_alloc_lock();
Trond Myklebust75dff552006-05-07 23:02:42 -0400636 int error = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637
638 if (fl == NULL)
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500639 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640
641 error = lease_init(filp, type, fl);
Trond Myklebust75dff552006-05-07 23:02:42 -0400642 if (error) {
643 locks_free_lock(fl);
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500644 return ERR_PTR(error);
Trond Myklebust75dff552006-05-07 23:02:42 -0400645 }
J. Bruce Fieldse32b8ee2007-03-01 14:34:35 -0500646 return fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647}
648
649/* Check if two locks overlap each other.
650 */
651static inline int locks_overlap(struct file_lock *fl1, struct file_lock *fl2)
652{
653 return ((fl1->fl_end >= fl2->fl_start) &&
654 (fl2->fl_end >= fl1->fl_start));
655}
656
657/*
658 * Check whether two locks have the same owner.
659 */
Matt Mackall33443c42006-01-08 01:05:22 -0800660static int posix_same_owner(struct file_lock *fl1, struct file_lock *fl2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661{
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400662 if (fl1->fl_lmops && fl1->fl_lmops->lm_compare_owner)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 return fl2->fl_lmops == fl1->fl_lmops &&
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400664 fl1->fl_lmops->lm_compare_owner(fl1, fl2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665 return fl1->fl_owner == fl2->fl_owner;
666}
667
Jeff Layton6109c852015-01-16 15:05:57 -0500668/* Must be called with the flc_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500669static void locks_insert_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400670{
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200671 struct file_lock_list_struct *fll = this_cpu_ptr(&file_lock_list);
672
Peter Zijlstraaba37662015-06-22 14:16:33 +0200673 percpu_rwsem_assert_held(&file_rwsem);
674
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200675 spin_lock(&fll->lock);
Jeff Layton7012b022013-06-21 08:58:22 -0400676 fl->fl_link_cpu = smp_processor_id();
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200677 hlist_add_head(&fl->fl_link, &fll->hlist);
678 spin_unlock(&fll->lock);
Jeff Layton88974692013-06-21 08:58:14 -0400679}
680
Jeff Layton6109c852015-01-16 15:05:57 -0500681/* Must be called with the flc_lock held! */
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500682static void locks_delete_global_locks(struct file_lock *fl)
Jeff Layton88974692013-06-21 08:58:14 -0400683{
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200684 struct file_lock_list_struct *fll;
685
Peter Zijlstraaba37662015-06-22 14:16:33 +0200686 percpu_rwsem_assert_held(&file_rwsem);
687
Jeff Layton7012b022013-06-21 08:58:22 -0400688 /*
689 * Avoid taking lock if already unhashed. This is safe since this check
Jeff Layton6109c852015-01-16 15:05:57 -0500690 * is done while holding the flc_lock, and new insertions into the list
Jeff Layton7012b022013-06-21 08:58:22 -0400691 * also require that it be held.
692 */
693 if (hlist_unhashed(&fl->fl_link))
694 return;
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200695
696 fll = per_cpu_ptr(&file_lock_list, fl->fl_link_cpu);
697 spin_lock(&fll->lock);
Jeff Layton139ca042013-06-21 08:58:17 -0400698 hlist_del_init(&fl->fl_link);
Peter Zijlstra7c3f6542015-06-22 14:16:34 +0200699 spin_unlock(&fll->lock);
Jeff Layton88974692013-06-21 08:58:14 -0400700}
701
Jeff Layton3999e492013-06-21 08:58:19 -0400702static unsigned long
703posix_owner_key(struct file_lock *fl)
704{
705 if (fl->fl_lmops && fl->fl_lmops->lm_owner_key)
706 return fl->fl_lmops->lm_owner_key(fl);
707 return (unsigned long)fl->fl_owner;
708}
709
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500710static void locks_insert_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400711{
Daniel Wagner663d5af2015-04-03 09:04:03 -0400712 lockdep_assert_held(&blocked_lock_lock);
713
Jeff Layton3999e492013-06-21 08:58:19 -0400714 hash_add(blocked_hash, &waiter->fl_link, posix_owner_key(waiter));
Jeff Layton88974692013-06-21 08:58:14 -0400715}
716
Jeff Layton6ca10ed2014-02-03 12:13:07 -0500717static void locks_delete_global_blocked(struct file_lock *waiter)
Jeff Layton88974692013-06-21 08:58:14 -0400718{
Daniel Wagner663d5af2015-04-03 09:04:03 -0400719 lockdep_assert_held(&blocked_lock_lock);
720
Jeff Layton48f74182013-06-21 08:58:18 -0400721 hash_del(&waiter->fl_link);
Jeff Layton88974692013-06-21 08:58:14 -0400722}
723
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724/* Remove waiter from blocker's block list.
725 * When blocker ends up pointing to itself then the list is empty.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400726 *
Jeff Layton7b2296a2013-06-21 08:58:20 -0400727 * Must be called with blocked_lock_lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 */
Matt Mackall33443c42006-01-08 01:05:22 -0800729static void __locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730{
Jeff Layton88974692013-06-21 08:58:14 -0400731 locks_delete_global_blocked(waiter);
NeilBrownada5c1d2018-11-30 10:04:08 +1100732 list_del_init(&waiter->fl_blocked_member);
733 waiter->fl_blocker = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734}
735
NeilBrownad6bbd82018-11-30 10:04:08 +1100736static void __locks_wake_up_blocks(struct file_lock *blocker)
737{
738 while (!list_empty(&blocker->fl_blocked_requests)) {
739 struct file_lock *waiter;
740
741 waiter = list_first_entry(&blocker->fl_blocked_requests,
742 struct file_lock, fl_blocked_member);
743 __locks_delete_block(waiter);
744 if (waiter->fl_lmops && waiter->fl_lmops->lm_notify)
745 waiter->fl_lmops->lm_notify(waiter);
746 else
747 wake_up(&waiter->fl_wait);
748 }
749}
750
NeilBrowncb03f942018-11-30 10:04:08 +1100751/**
752 * locks_delete_lock - stop waiting for a file lock
753 * @waiter: the lock which was waiting
754 *
755 * lockd/nfsd need to disconnect the lock while working on it.
756 */
757int locks_delete_block(struct file_lock *waiter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758{
NeilBrowncb03f942018-11-30 10:04:08 +1100759 int status = -ENOENT;
760
NeilBrown16306a62018-11-30 10:04:08 +1100761 /*
762 * If fl_blocker is NULL, it won't be set again as this thread
763 * "owns" the lock and is the only one that might try to claim
764 * the lock. So it is safe to test fl_blocker locklessly.
765 * Also if fl_blocker is NULL, this waiter is not listed on
766 * fl_blocked_requests for some lock, so no other request can
767 * be added to the list of fl_blocked_requests for this
768 * request. So if fl_blocker is NULL, it is safe to
769 * locklessly check if fl_blocked_requests is empty. If both
770 * of these checks succeed, there is no need to take the lock.
771 */
772 if (waiter->fl_blocker == NULL &&
773 list_empty(&waiter->fl_blocked_requests))
NeilBrowncb03f942018-11-30 10:04:08 +1100774 return status;
Jeff Layton7b2296a2013-06-21 08:58:20 -0400775 spin_lock(&blocked_lock_lock);
NeilBrowncb03f942018-11-30 10:04:08 +1100776 if (waiter->fl_blocker)
777 status = 0;
NeilBrown5946c432018-11-30 10:04:08 +1100778 __locks_wake_up_blocks(waiter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 __locks_delete_block(waiter);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400780 spin_unlock(&blocked_lock_lock);
NeilBrowncb03f942018-11-30 10:04:08 +1100781 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782}
NeilBrowncb03f942018-11-30 10:04:08 +1100783EXPORT_SYMBOL(locks_delete_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784
785/* Insert waiter into blocker's block list.
786 * We use a circular list so that processes can be easily woken up in
787 * the order they blocked. The documentation doesn't require this but
788 * it seems like the reasonable thing to do.
Jeff Layton1c8c6012013-06-21 08:58:15 -0400789 *
Jeff Layton6109c852015-01-16 15:05:57 -0500790 * Must be called with both the flc_lock and blocked_lock_lock held. The
NeilBrownada5c1d2018-11-30 10:04:08 +1100791 * fl_blocked_requests list itself is protected by the blocked_lock_lock,
792 * but by ensuring that the flc_lock is also held on insertions we can avoid
793 * taking the blocked_lock_lock in some cases when we see that the
794 * fl_blocked_requests list is empty.
NeilBrownfd7732e2018-11-30 10:04:08 +1100795 *
796 * Rather than just adding to the list, we check for conflicts with any existing
797 * waiters, and add beneath any waiter that blocks the new waiter.
798 * Thus wakeups don't happen until needed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 */
Jeff Layton1c8c6012013-06-21 08:58:15 -0400800static void __locks_insert_block(struct file_lock *blocker,
NeilBrownfd7732e2018-11-30 10:04:08 +1100801 struct file_lock *waiter,
802 bool conflict(struct file_lock *,
803 struct file_lock *))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804{
NeilBrownfd7732e2018-11-30 10:04:08 +1100805 struct file_lock *fl;
NeilBrownada5c1d2018-11-30 10:04:08 +1100806 BUG_ON(!list_empty(&waiter->fl_blocked_member));
NeilBrownfd7732e2018-11-30 10:04:08 +1100807
808new_blocker:
809 list_for_each_entry(fl, &blocker->fl_blocked_requests, fl_blocked_member)
810 if (conflict(fl, waiter)) {
811 blocker = fl;
812 goto new_blocker;
813 }
NeilBrownada5c1d2018-11-30 10:04:08 +1100814 waiter->fl_blocker = blocker;
815 list_add_tail(&waiter->fl_blocked_member, &blocker->fl_blocked_requests);
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400816 if (IS_POSIX(blocker) && !IS_OFDLCK(blocker))
Jeff Layton1c8c6012013-06-21 08:58:15 -0400817 locks_insert_global_blocked(waiter);
NeilBrown5946c432018-11-30 10:04:08 +1100818
819 /* The requests in waiter->fl_blocked are known to conflict with
820 * waiter, but might not conflict with blocker, or the requests
821 * and lock which block it. So they all need to be woken.
822 */
823 __locks_wake_up_blocks(waiter);
Jeff Layton1c8c6012013-06-21 08:58:15 -0400824}
825
Jeff Layton6109c852015-01-16 15:05:57 -0500826/* Must be called with flc_lock held. */
Jeff Layton1c8c6012013-06-21 08:58:15 -0400827static void locks_insert_block(struct file_lock *blocker,
NeilBrownfd7732e2018-11-30 10:04:08 +1100828 struct file_lock *waiter,
829 bool conflict(struct file_lock *,
830 struct file_lock *))
Jeff Layton1c8c6012013-06-21 08:58:15 -0400831{
Jeff Layton7b2296a2013-06-21 08:58:20 -0400832 spin_lock(&blocked_lock_lock);
NeilBrownfd7732e2018-11-30 10:04:08 +1100833 __locks_insert_block(blocker, waiter, conflict);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400834 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835}
836
Jeff Layton1cb36012013-06-21 08:58:12 -0400837/*
838 * Wake up processes blocked waiting for blocker.
839 *
Jeff Layton6109c852015-01-16 15:05:57 -0500840 * Must be called with the inode->flc_lock held!
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 */
842static void locks_wake_up_blocks(struct file_lock *blocker)
843{
Jeff Layton4e8c7652013-06-21 08:58:16 -0400844 /*
845 * Avoid taking global lock if list is empty. This is safe since new
Jeff Layton6109c852015-01-16 15:05:57 -0500846 * blocked requests are only added to the list under the flc_lock, and
NeilBrownada5c1d2018-11-30 10:04:08 +1100847 * the flc_lock is always held here. Note that removal from the
848 * fl_blocked_requests list does not require the flc_lock, so we must
849 * recheck list_empty() after acquiring the blocked_lock_lock.
Jeff Layton4e8c7652013-06-21 08:58:16 -0400850 */
NeilBrownada5c1d2018-11-30 10:04:08 +1100851 if (list_empty(&blocker->fl_blocked_requests))
Jeff Layton4e8c7652013-06-21 08:58:16 -0400852 return;
853
Jeff Layton7b2296a2013-06-21 08:58:20 -0400854 spin_lock(&blocked_lock_lock);
NeilBrownad6bbd82018-11-30 10:04:08 +1100855 __locks_wake_up_blocks(blocker);
Jeff Layton7b2296a2013-06-21 08:58:20 -0400856 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857}
858
Jeff Layton5263e312015-01-16 15:05:55 -0500859static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500860locks_insert_lock_ctx(struct file_lock *fl, struct list_head *before)
Jeff Layton5263e312015-01-16 15:05:55 -0500861{
Jeff Layton5263e312015-01-16 15:05:55 -0500862 list_add_tail(&fl->fl_list, before);
863 locks_insert_global_locks(fl);
864}
865
Jeff Layton8634b512015-01-16 15:05:55 -0500866static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500867locks_unlink_lock_ctx(struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868{
Jeff Layton88974692013-06-21 08:58:14 -0400869 locks_delete_global_locks(fl);
Jeff Layton8634b512015-01-16 15:05:55 -0500870 list_del_init(&fl->fl_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 locks_wake_up_blocks(fl);
Jeff Layton24cbe782014-02-03 12:13:06 -0500872}
873
Jeff Layton5263e312015-01-16 15:05:55 -0500874static void
Jeff Laytone084c1b2015-02-16 14:32:03 -0500875locks_delete_lock_ctx(struct file_lock *fl, struct list_head *dispose)
Jeff Layton5263e312015-01-16 15:05:55 -0500876{
Jeff Laytone084c1b2015-02-16 14:32:03 -0500877 locks_unlink_lock_ctx(fl);
Jeff Layton8634b512015-01-16 15:05:55 -0500878 if (dispose)
879 list_add(&fl->fl_list, dispose);
880 else
881 locks_free_lock(fl);
Jeff Layton5263e312015-01-16 15:05:55 -0500882}
883
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884/* Determine if lock sys_fl blocks lock caller_fl. Common functionality
885 * checks for shared/exclusive status of overlapping locks.
886 */
NeilBrownc0e15902018-11-30 10:04:08 +1100887static bool locks_conflict(struct file_lock *caller_fl,
888 struct file_lock *sys_fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889{
890 if (sys_fl->fl_type == F_WRLCK)
NeilBrownc0e15902018-11-30 10:04:08 +1100891 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892 if (caller_fl->fl_type == F_WRLCK)
NeilBrownc0e15902018-11-30 10:04:08 +1100893 return true;
894 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895}
896
897/* Determine if lock sys_fl blocks lock caller_fl. POSIX specific
898 * checking before calling the locks_conflict().
899 */
NeilBrownc0e15902018-11-30 10:04:08 +1100900static bool posix_locks_conflict(struct file_lock *caller_fl,
901 struct file_lock *sys_fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902{
903 /* POSIX locks owned by the same process do not conflict with
904 * each other.
905 */
Jeff Layton9b8c8692015-04-03 09:04:02 -0400906 if (posix_same_owner(caller_fl, sys_fl))
NeilBrownc0e15902018-11-30 10:04:08 +1100907 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908
909 /* Check whether they overlap */
910 if (!locks_overlap(caller_fl, sys_fl))
NeilBrownc0e15902018-11-30 10:04:08 +1100911 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912
NeilBrownc0e15902018-11-30 10:04:08 +1100913 return locks_conflict(caller_fl, sys_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914}
915
916/* Determine if lock sys_fl blocks lock caller_fl. FLOCK specific
917 * checking before calling the locks_conflict().
918 */
NeilBrownc0e15902018-11-30 10:04:08 +1100919static bool flock_locks_conflict(struct file_lock *caller_fl,
920 struct file_lock *sys_fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921{
922 /* FLOCK locks referring to the same filp do not conflict with
923 * each other.
924 */
Jeff Layton9b8c8692015-04-03 09:04:02 -0400925 if (caller_fl->fl_file == sys_fl->fl_file)
NeilBrownc0e15902018-11-30 10:04:08 +1100926 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 if ((caller_fl->fl_type & LOCK_MAND) || (sys_fl->fl_type & LOCK_MAND))
NeilBrownc0e15902018-11-30 10:04:08 +1100928 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929
NeilBrownc0e15902018-11-30 10:04:08 +1100930 return locks_conflict(caller_fl, sys_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931}
932
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400933void
Marc Eshel9d6a8c52007-02-21 00:55:18 -0500934posix_test_lock(struct file *filp, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935{
936 struct file_lock *cfl;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500937 struct file_lock_context *ctx;
Miklos Szeredic568d682016-09-16 12:44:20 +0200938 struct inode *inode = locks_inode(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939
Dmitry Vyukov128a3782015-09-21 09:43:06 +0200940 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500941 if (!ctx || list_empty_careful(&ctx->flc_posix)) {
J. Bruce Fields129a84d2007-05-10 18:38:43 -0400942 fl->fl_type = F_UNLCK;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500943 return;
944 }
945
Jeff Layton6109c852015-01-16 15:05:57 -0500946 spin_lock(&ctx->flc_lock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500947 list_for_each_entry(cfl, &ctx->flc_posix, fl_list) {
948 if (posix_locks_conflict(fl, cfl)) {
949 locks_copy_conflock(fl, cfl);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -0500950 goto out;
951 }
952 }
953 fl->fl_type = F_UNLCK;
954out:
Jeff Layton6109c852015-01-16 15:05:57 -0500955 spin_unlock(&ctx->flc_lock);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -0400956 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958EXPORT_SYMBOL(posix_test_lock);
959
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400960/*
961 * Deadlock detection:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400963 * We attempt to detect deadlocks that are due purely to posix file
964 * locks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400966 * We assume that a task can be waiting for at most one lock at a time.
967 * So for any acquired lock, the process holding that lock may be
968 * waiting on at most one other lock. That lock in turns may be held by
969 * someone waiting for at most one other lock. Given a requested lock
970 * caller_fl which is about to wait for a conflicting lock block_fl, we
971 * follow this chain of waiters to ensure we are not about to create a
972 * cycle.
J. Bruce Fields97855b42007-10-30 11:20:02 -0400973 *
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400974 * Since we do this before we ever put a process to sleep on a lock, we
975 * are ensured that there is never a cycle; that is what guarantees that
976 * the while() loop in posix_locks_deadlock() eventually completes.
977 *
978 * Note: the above assumption may not be true when handling lock
979 * requests from a broken NFS client. It may also fail in the presence
980 * of tasks (such as posix threads) sharing the same open file table.
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400981 * To handle those cases, we just bail out after a few iterations.
Jeff Layton57b65322014-02-03 12:13:09 -0500982 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400983 * For FL_OFDLCK locks, the owner is the filp, not the files_struct.
Jeff Layton57b65322014-02-03 12:13:09 -0500984 * Because the owner is not even nominally tied to a thread of
985 * execution, the deadlock detection below can't reasonably work well. Just
986 * skip it for those.
987 *
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400988 * In principle, we could do a more limited deadlock detection on FL_OFDLCK
Jeff Layton57b65322014-02-03 12:13:09 -0500989 * locks that just checks for the case where two tasks are attempting to
990 * upgrade from read to write locks on the same inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 */
J. Bruce Fields97855b42007-10-30 11:20:02 -0400992
993#define MAX_DEADLK_ITERATIONS 10
994
J. Bruce Fieldsb5331842007-10-26 18:05:40 -0400995/* Find a lock that the owner of the given block_fl is blocking on. */
996static struct file_lock *what_owner_is_waiting_for(struct file_lock *block_fl)
997{
998 struct file_lock *fl;
999
Jeff Layton3999e492013-06-21 08:58:19 -04001000 hash_for_each_possible(blocked_hash, fl, fl_link, posix_owner_key(block_fl)) {
NeilBrown5946c432018-11-30 10:04:08 +11001001 if (posix_same_owner(fl, block_fl)) {
1002 while (fl->fl_blocker)
1003 fl = fl->fl_blocker;
1004 return fl;
1005 }
J. Bruce Fieldsb5331842007-10-26 18:05:40 -04001006 }
1007 return NULL;
1008}
1009
Jeff Layton7b2296a2013-06-21 08:58:20 -04001010/* Must be called with the blocked_lock_lock held! */
Adrian Bunkb0904e12006-06-23 02:05:13 -07001011static int posix_locks_deadlock(struct file_lock *caller_fl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012 struct file_lock *block_fl)
1013{
J. Bruce Fields97855b42007-10-30 11:20:02 -04001014 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015
Daniel Wagner663d5af2015-04-03 09:04:03 -04001016 lockdep_assert_held(&blocked_lock_lock);
1017
Jeff Layton57b65322014-02-03 12:13:09 -05001018 /*
1019 * This deadlock detector can't reasonably detect deadlocks with
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001020 * FL_OFDLCK locks, since they aren't owned by a process, per-se.
Jeff Layton57b65322014-02-03 12:13:09 -05001021 */
Jeff Laytoncff2fce2014-04-22 08:24:32 -04001022 if (IS_OFDLCK(caller_fl))
Jeff Layton57b65322014-02-03 12:13:09 -05001023 return 0;
1024
J. Bruce Fieldsb5331842007-10-26 18:05:40 -04001025 while ((block_fl = what_owner_is_waiting_for(block_fl))) {
1026 if (i++ > MAX_DEADLK_ITERATIONS)
1027 return 0;
1028 if (posix_same_owner(caller_fl, block_fl))
1029 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030 }
1031 return 0;
1032}
1033
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034/* Try to create a FLOCK lock on filp. We always insert new FLOCK locks
J. Bruce Fields02888f42007-09-12 15:45:07 -04001035 * after any leases, but before any posix locks.
Trond Myklebustf475ae92006-06-29 16:38:32 -04001036 *
1037 * Note that if called with an FL_EXISTS argument, the caller may determine
1038 * whether or not a lock was successfully freed by testing the return
1039 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040 */
Jeff Laytonbcd7f78d2015-07-11 06:43:02 -04001041static int flock_lock_inode(struct inode *inode, struct file_lock *request)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042{
Trond Myklebust993dfa82006-03-31 02:30:55 -08001043 struct file_lock *new_fl = NULL;
Jeff Layton5263e312015-01-16 15:05:55 -05001044 struct file_lock *fl;
1045 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046 int error = 0;
Jeff Layton5263e312015-01-16 15:05:55 -05001047 bool found = false;
Jeff Laytoned9814d2014-08-11 14:20:31 -04001048 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049
Jeff Layton5c1c6692015-04-03 09:04:03 -04001050 ctx = locks_get_lock_context(inode, request->fl_type);
1051 if (!ctx) {
1052 if (request->fl_type != F_UNLCK)
1053 return -ENOMEM;
1054 return (request->fl_flags & FL_EXISTS) ? -ENOENT : 0;
1055 }
Jeff Layton5263e312015-01-16 15:05:55 -05001056
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001057 if (!(request->fl_flags & FL_ACCESS) && (request->fl_type != F_UNLCK)) {
1058 new_fl = locks_alloc_lock();
1059 if (!new_fl)
1060 return -ENOMEM;
1061 }
1062
Peter Zijlstra87709e22016-05-30 16:48:35 +02001063 percpu_down_read_preempt_disable(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001064 spin_lock(&ctx->flc_lock);
Trond Myklebustf07f18d2006-06-29 16:38:37 -04001065 if (request->fl_flags & FL_ACCESS)
1066 goto find_conflict;
Pavel Emelyanov84d535a2007-09-11 16:38:13 +04001067
Jeff Layton5263e312015-01-16 15:05:55 -05001068 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
Jeff Laytonbcd7f78d2015-07-11 06:43:02 -04001069 if (request->fl_file != fl->fl_file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070 continue;
Trond Myklebust993dfa82006-03-31 02:30:55 -08001071 if (request->fl_type == fl->fl_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 goto out;
Jeff Layton5263e312015-01-16 15:05:55 -05001073 found = true;
Jeff Laytone084c1b2015-02-16 14:32:03 -05001074 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075 break;
1076 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077
Trond Myklebustf475ae92006-06-29 16:38:32 -04001078 if (request->fl_type == F_UNLCK) {
1079 if ((request->fl_flags & FL_EXISTS) && !found)
1080 error = -ENOENT;
Trond Myklebust993dfa82006-03-31 02:30:55 -08001081 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -04001082 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083
Trond Myklebustf07f18d2006-06-29 16:38:37 -04001084find_conflict:
Jeff Layton5263e312015-01-16 15:05:55 -05001085 list_for_each_entry(fl, &ctx->flc_flock, fl_list) {
Trond Myklebust993dfa82006-03-31 02:30:55 -08001086 if (!flock_locks_conflict(request, fl))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 continue;
1088 error = -EAGAIN;
Miklos Szeredibde74e42008-07-25 01:48:57 -07001089 if (!(request->fl_flags & FL_SLEEP))
1090 goto out;
1091 error = FILE_LOCK_DEFERRED;
NeilBrownfd7732e2018-11-30 10:04:08 +11001092 locks_insert_block(fl, request, flock_locks_conflict);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 goto out;
1094 }
Trond Myklebustf07f18d2006-06-29 16:38:37 -04001095 if (request->fl_flags & FL_ACCESS)
1096 goto out;
Trond Myklebust993dfa82006-03-31 02:30:55 -08001097 locks_copy_lock(new_fl, request);
NeilBrown5946c432018-11-30 10:04:08 +11001098 locks_move_blocks(new_fl, request);
Jeff Laytone084c1b2015-02-16 14:32:03 -05001099 locks_insert_lock_ctx(new_fl, &ctx->flc_flock);
Trond Myklebust993dfa82006-03-31 02:30:55 -08001100 new_fl = NULL;
Kirill Korotaev9cedc192006-06-14 17:59:35 +04001101 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102
1103out:
Jeff Layton6109c852015-01-16 15:05:57 -05001104 spin_unlock(&ctx->flc_lock);
Peter Zijlstra87709e22016-05-30 16:48:35 +02001105 percpu_up_read_preempt_enable(&file_rwsem);
Trond Myklebust993dfa82006-03-31 02:30:55 -08001106 if (new_fl)
1107 locks_free_lock(new_fl);
Jeff Laytoned9814d2014-08-11 14:20:31 -04001108 locks_dispose_list(&dispose);
Jeff Laytonc883da32018-07-30 07:54:56 -04001109 trace_flock_lock_inode(inode, request, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110 return error;
1111}
1112
Jeff Laytonb4d629a2016-01-07 18:27:42 -05001113static int posix_lock_inode(struct inode *inode, struct file_lock *request,
1114 struct file_lock *conflock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115{
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001116 struct file_lock *fl, *tmp;
Miklos Szeredi39005d02006-06-23 02:05:10 -07001117 struct file_lock *new_fl = NULL;
1118 struct file_lock *new_fl2 = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119 struct file_lock *left = NULL;
1120 struct file_lock *right = NULL;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001121 struct file_lock_context *ctx;
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001122 int error;
1123 bool added = false;
Jeff Laytoned9814d2014-08-11 14:20:31 -04001124 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125
Jeff Layton5c1c6692015-04-03 09:04:03 -04001126 ctx = locks_get_lock_context(inode, request->fl_type);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001127 if (!ctx)
Jeff Layton5c1c6692015-04-03 09:04:03 -04001128 return (request->fl_type == F_UNLCK) ? 0 : -ENOMEM;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001129
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130 /*
1131 * We may need two file_lock structures for this operation,
1132 * so we get them in advance to avoid races.
Miklos Szeredi39005d02006-06-23 02:05:10 -07001133 *
1134 * In some cases we can be sure, that no new locks will be needed
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135 */
Miklos Szeredi39005d02006-06-23 02:05:10 -07001136 if (!(request->fl_flags & FL_ACCESS) &&
1137 (request->fl_type != F_UNLCK ||
1138 request->fl_start != 0 || request->fl_end != OFFSET_MAX)) {
1139 new_fl = locks_alloc_lock();
1140 new_fl2 = locks_alloc_lock();
1141 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142
Peter Zijlstra87709e22016-05-30 16:48:35 +02001143 percpu_down_read_preempt_disable(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001144 spin_lock(&ctx->flc_lock);
Jeff Layton1cb36012013-06-21 08:58:12 -04001145 /*
1146 * New lock request. Walk all POSIX locks and look for conflicts. If
1147 * there are any, either return error or put the request on the
Jeff Layton48f74182013-06-21 08:58:18 -04001148 * blocker's list of waiters and the global blocked_hash.
Jeff Layton1cb36012013-06-21 08:58:12 -04001149 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150 if (request->fl_type != F_UNLCK) {
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001151 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 if (!posix_locks_conflict(request, fl))
1153 continue;
Andy Adamson5842add2006-03-26 01:37:26 -08001154 if (conflock)
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001155 locks_copy_conflock(conflock, fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156 error = -EAGAIN;
1157 if (!(request->fl_flags & FL_SLEEP))
1158 goto out;
Jeff Layton1c8c6012013-06-21 08:58:15 -04001159 /*
1160 * Deadlock detection and insertion into the blocked
1161 * locks list must be done while holding the same lock!
1162 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163 error = -EDEADLK;
Jeff Layton7b2296a2013-06-21 08:58:20 -04001164 spin_lock(&blocked_lock_lock);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001165 if (likely(!posix_locks_deadlock(request, fl))) {
1166 error = FILE_LOCK_DEFERRED;
NeilBrownfd7732e2018-11-30 10:04:08 +11001167 __locks_insert_block(fl, request,
1168 posix_locks_conflict);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001169 }
Jeff Layton7b2296a2013-06-21 08:58:20 -04001170 spin_unlock(&blocked_lock_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171 goto out;
1172 }
1173 }
1174
1175 /* If we're just looking for a conflict, we're done. */
1176 error = 0;
1177 if (request->fl_flags & FL_ACCESS)
1178 goto out;
1179
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001180 /* Find the first old lock with the same owner as the new lock */
1181 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
1182 if (posix_same_owner(request, fl))
1183 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184 }
1185
Jeff Layton1cb36012013-06-21 08:58:12 -04001186 /* Process locks with this owner. */
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001187 list_for_each_entry_safe_from(fl, tmp, &ctx->flc_posix, fl_list) {
1188 if (!posix_same_owner(request, fl))
1189 break;
1190
1191 /* Detect adjacent or overlapping regions (if same lock type) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192 if (request->fl_type == fl->fl_type) {
Olaf Kirch449231d2005-08-25 16:25:35 -07001193 /* In all comparisons of start vs end, use
1194 * "start - 1" rather than "end + 1". If end
1195 * is OFFSET_MAX, end + 1 will become negative.
1196 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197 if (fl->fl_end < request->fl_start - 1)
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001198 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199 /* If the next lock in the list has entirely bigger
1200 * addresses than the new one, insert the lock here.
1201 */
Olaf Kirch449231d2005-08-25 16:25:35 -07001202 if (fl->fl_start - 1 > request->fl_end)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203 break;
1204
1205 /* If we come here, the new and old lock are of the
1206 * same type and adjacent or overlapping. Make one
1207 * lock yielding from the lower start address of both
1208 * locks to the higher end address.
1209 */
1210 if (fl->fl_start > request->fl_start)
1211 fl->fl_start = request->fl_start;
1212 else
1213 request->fl_start = fl->fl_start;
1214 if (fl->fl_end < request->fl_end)
1215 fl->fl_end = request->fl_end;
1216 else
1217 request->fl_end = fl->fl_end;
1218 if (added) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001219 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 continue;
1221 }
1222 request = fl;
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001223 added = true;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001224 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225 /* Processing for different lock types is a bit
1226 * more complex.
1227 */
1228 if (fl->fl_end < request->fl_start)
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001229 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230 if (fl->fl_start > request->fl_end)
1231 break;
1232 if (request->fl_type == F_UNLCK)
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001233 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234 if (fl->fl_start < request->fl_start)
1235 left = fl;
1236 /* If the next lock in the list has a higher end
1237 * address than the new one, insert the new one here.
1238 */
1239 if (fl->fl_end > request->fl_end) {
1240 right = fl;
1241 break;
1242 }
1243 if (fl->fl_start >= request->fl_start) {
1244 /* The new lock completely replaces an old
1245 * one (This may happen several times).
1246 */
1247 if (added) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001248 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 continue;
1250 }
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001251 /*
1252 * Replace the old lock with new_fl, and
1253 * remove the old one. It's safe to do the
1254 * insert here since we know that we won't be
1255 * using new_fl later, and that the lock is
1256 * just replacing an existing lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 */
Jeff Laytonb84d49f2014-08-12 08:03:49 -04001258 error = -ENOLCK;
1259 if (!new_fl)
1260 goto out;
1261 locks_copy_lock(new_fl, request);
1262 request = new_fl;
1263 new_fl = NULL;
Jeff Laytone084c1b2015-02-16 14:32:03 -05001264 locks_insert_lock_ctx(request, &fl->fl_list);
1265 locks_delete_lock_ctx(fl, &dispose);
Jeff Laytonb9746ef2013-06-21 08:58:13 -04001266 added = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267 }
1268 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 }
1270
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001271 /*
Jeff Layton1cb36012013-06-21 08:58:12 -04001272 * The above code only modifies existing locks in case of merging or
1273 * replacing. If new lock(s) need to be inserted all modifications are
1274 * done below this, so it's safe yet to bail out.
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001275 */
1276 error = -ENOLCK; /* "no luck" */
1277 if (right && left == right && !new_fl2)
1278 goto out;
1279
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280 error = 0;
1281 if (!added) {
Trond Myklebustf475ae92006-06-29 16:38:32 -04001282 if (request->fl_type == F_UNLCK) {
1283 if (request->fl_flags & FL_EXISTS)
1284 error = -ENOENT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285 goto out;
Trond Myklebustf475ae92006-06-29 16:38:32 -04001286 }
Miklos Szeredi0d9a4902006-06-23 02:05:09 -07001287
1288 if (!new_fl) {
1289 error = -ENOLCK;
1290 goto out;
1291 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292 locks_copy_lock(new_fl, request);
NeilBrown5946c432018-11-30 10:04:08 +11001293 locks_move_blocks(new_fl, request);
Jeff Laytone084c1b2015-02-16 14:32:03 -05001294 locks_insert_lock_ctx(new_fl, &fl->fl_list);
Jeff Layton2e2f756f2015-02-17 17:08:23 -05001295 fl = new_fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 new_fl = NULL;
1297 }
1298 if (right) {
1299 if (left == right) {
1300 /* The new lock breaks the old one in two pieces,
1301 * so we have to use the second new lock.
1302 */
1303 left = new_fl2;
1304 new_fl2 = NULL;
1305 locks_copy_lock(left, right);
Jeff Laytone084c1b2015-02-16 14:32:03 -05001306 locks_insert_lock_ctx(left, &fl->fl_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307 }
1308 right->fl_start = request->fl_end + 1;
1309 locks_wake_up_blocks(right);
1310 }
1311 if (left) {
1312 left->fl_end = request->fl_start - 1;
1313 locks_wake_up_blocks(left);
1314 }
1315 out:
Jeff Layton6109c852015-01-16 15:05:57 -05001316 spin_unlock(&ctx->flc_lock);
Peter Zijlstra87709e22016-05-30 16:48:35 +02001317 percpu_up_read_preempt_enable(&file_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318 /*
1319 * Free any unused locks.
1320 */
1321 if (new_fl)
1322 locks_free_lock(new_fl);
1323 if (new_fl2)
1324 locks_free_lock(new_fl2);
Jeff Laytoned9814d2014-08-11 14:20:31 -04001325 locks_dispose_list(&dispose);
Jeff Layton18909102016-01-06 21:26:10 -05001326 trace_posix_lock_inode(inode, request, error);
1327
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 return error;
1329}
1330
1331/**
1332 * posix_lock_file - Apply a POSIX-style lock to a file
1333 * @filp: The file to apply the lock to
1334 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05001335 * @conflock: Place to return a copy of the conflicting lock, if found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336 *
1337 * Add a POSIX style lock to a file.
1338 * We merge adjacent & overlapping locks whenever possible.
1339 * POSIX locks are sorted by owner task, then by starting address
Trond Myklebustf475ae92006-06-29 16:38:32 -04001340 *
1341 * Note that if called with an FL_EXISTS argument, the caller may determine
1342 * whether or not a lock was successfully freed by testing the return
1343 * value for -ENOENT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344 */
Marc Eshel150b3932007-01-18 16:15:35 -05001345int posix_lock_file(struct file *filp, struct file_lock *fl,
Andy Adamson5842add2006-03-26 01:37:26 -08001346 struct file_lock *conflock)
1347{
Miklos Szeredic568d682016-09-16 12:44:20 +02001348 return posix_lock_inode(locks_inode(filp), fl, conflock);
Andy Adamson5842add2006-03-26 01:37:26 -08001349}
Marc Eshel150b3932007-01-18 16:15:35 -05001350EXPORT_SYMBOL(posix_lock_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351
1352/**
Jeff Layton29d01b22015-07-11 06:43:02 -04001353 * posix_lock_inode_wait - Apply a POSIX-style lock to a file
1354 * @inode: inode of file to which lock request should be applied
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 * @fl: The lock to be applied
1356 *
Benjamin Coddington616fb382015-10-22 13:38:15 -04001357 * Apply a POSIX style lock request to an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 */
Benjamin Coddington616fb382015-10-22 13:38:15 -04001359static int posix_lock_inode_wait(struct inode *inode, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360{
1361 int error;
1362 might_sleep ();
1363 for (;;) {
Jeff Laytonb4d629a2016-01-07 18:27:42 -05001364 error = posix_lock_inode(inode, fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001365 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 break;
NeilBrownada5c1d2018-11-30 10:04:08 +11001367 error = wait_event_interruptible(fl->fl_wait, !fl->fl_blocker);
NeilBrown16306a62018-11-30 10:04:08 +11001368 if (error)
1369 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 }
NeilBrown16306a62018-11-30 10:04:08 +11001371 locks_delete_block(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372 return error;
1373}
Jeff Layton29d01b22015-07-11 06:43:02 -04001374
Jeff Layton9e8925b2015-11-16 09:49:34 -05001375#ifdef CONFIG_MANDATORY_FILE_LOCKING
Jeff Layton29d01b22015-07-11 06:43:02 -04001376/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 * locks_mandatory_locked - Check for an active lock
Jeff Laytond7a06982014-03-10 09:54:15 -04001378 * @file: the file to check
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379 *
1380 * Searches the inode's list of locks to find any POSIX locks which conflict.
1381 * This function is called from locks_verify_locked() only.
1382 */
Jeff Laytond7a06982014-03-10 09:54:15 -04001383int locks_mandatory_locked(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384{
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001385 int ret;
Miklos Szeredic568d682016-09-16 12:44:20 +02001386 struct inode *inode = locks_inode(file);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001387 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 struct file_lock *fl;
1389
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001390 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001391 if (!ctx || list_empty_careful(&ctx->flc_posix))
1392 return 0;
1393
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394 /*
1395 * Search the lock list for this inode for any POSIX locks.
1396 */
Jeff Layton6109c852015-01-16 15:05:57 -05001397 spin_lock(&ctx->flc_lock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001398 ret = 0;
1399 list_for_each_entry(fl, &ctx->flc_posix, fl_list) {
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02001400 if (fl->fl_owner != current->files &&
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001401 fl->fl_owner != file) {
1402 ret = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 break;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001404 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405 }
Jeff Layton6109c852015-01-16 15:05:57 -05001406 spin_unlock(&ctx->flc_lock);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001407 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408}
1409
1410/**
1411 * locks_mandatory_area - Check for a conflicting lock
Christoph Hellwigacc15572015-12-03 12:59:49 +01001412 * @inode: the file to check
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413 * @filp: how the file was opened (if it was)
Christoph Hellwigacc15572015-12-03 12:59:49 +01001414 * @start: first byte in the file to check
1415 * @end: lastbyte in the file to check
1416 * @type: %F_WRLCK for a write lock, else %F_RDLCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 *
1418 * Searches the inode's list of locks to find any POSIX locks which conflict.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419 */
Christoph Hellwigacc15572015-12-03 12:59:49 +01001420int locks_mandatory_area(struct inode *inode, struct file *filp, loff_t start,
1421 loff_t end, unsigned char type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422{
1423 struct file_lock fl;
1424 int error;
Jeff Layton29723ad2014-03-10 09:54:19 -04001425 bool sleep = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426
1427 locks_init_lock(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428 fl.fl_pid = current->tgid;
1429 fl.fl_file = filp;
1430 fl.fl_flags = FL_POSIX | FL_ACCESS;
1431 if (filp && !(filp->f_flags & O_NONBLOCK))
Jeff Layton29723ad2014-03-10 09:54:19 -04001432 sleep = true;
Christoph Hellwigacc15572015-12-03 12:59:49 +01001433 fl.fl_type = type;
1434 fl.fl_start = start;
1435 fl.fl_end = end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436
1437 for (;;) {
Jeff Layton29723ad2014-03-10 09:54:19 -04001438 if (filp) {
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02001439 fl.fl_owner = filp;
Jeff Layton29723ad2014-03-10 09:54:19 -04001440 fl.fl_flags &= ~FL_SLEEP;
Jeff Laytonb4d629a2016-01-07 18:27:42 -05001441 error = posix_lock_inode(inode, &fl, NULL);
Jeff Layton29723ad2014-03-10 09:54:19 -04001442 if (!error)
1443 break;
1444 }
1445
1446 if (sleep)
1447 fl.fl_flags |= FL_SLEEP;
1448 fl.fl_owner = current->files;
Jeff Laytonb4d629a2016-01-07 18:27:42 -05001449 error = posix_lock_inode(inode, &fl, NULL);
Miklos Szeredibde74e42008-07-25 01:48:57 -07001450 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 break;
NeilBrownada5c1d2018-11-30 10:04:08 +11001452 error = wait_event_interruptible(fl.fl_wait, !fl.fl_blocker);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 if (!error) {
1454 /*
1455 * If we've been sleeping someone might have
1456 * changed the permissions behind our back.
1457 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001458 if (__mandatory_lock(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459 continue;
1460 }
1461
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462 break;
1463 }
NeilBrown16306a62018-11-30 10:04:08 +11001464 locks_delete_block(&fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465
1466 return error;
1467}
1468
1469EXPORT_SYMBOL(locks_mandatory_area);
Jeff Layton9e8925b2015-11-16 09:49:34 -05001470#endif /* CONFIG_MANDATORY_FILE_LOCKING */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471
J. Bruce Fields778fc542011-07-26 18:25:49 -04001472static void lease_clear_pending(struct file_lock *fl, int arg)
1473{
1474 switch (arg) {
1475 case F_UNLCK:
1476 fl->fl_flags &= ~FL_UNLOCK_PENDING;
1477 /* fall through: */
1478 case F_RDLCK:
1479 fl->fl_flags &= ~FL_DOWNGRADE_PENDING;
1480 }
1481}
1482
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483/* We already had a lease on this file; just change its type */
Jeff Layton7448cc32015-01-16 15:05:57 -05001484int lease_modify(struct file_lock *fl, int arg, struct list_head *dispose)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486 int error = assign_type(fl, arg);
1487
1488 if (error)
1489 return error;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001490 lease_clear_pending(fl, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001491 locks_wake_up_blocks(fl);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001492 if (arg == F_UNLCK) {
1493 struct file *filp = fl->fl_file;
1494
1495 f_delown(filp);
1496 filp->f_owner.signum = 0;
J. Bruce Fields96d6d592012-07-27 16:18:00 -04001497 fasync_helper(0, fl->fl_file, 0, &fl->fl_fasync);
1498 if (fl->fl_fasync != NULL) {
1499 printk(KERN_ERR "locks_delete_lock: fasync == %p\n", fl->fl_fasync);
1500 fl->fl_fasync = NULL;
1501 }
Jeff Laytone084c1b2015-02-16 14:32:03 -05001502 locks_delete_lock_ctx(fl, dispose);
Filipe Brandenburger3b6e2722012-07-27 00:42:52 -04001503 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504 return 0;
1505}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506EXPORT_SYMBOL(lease_modify);
1507
J. Bruce Fields778fc542011-07-26 18:25:49 -04001508static bool past_time(unsigned long then)
1509{
1510 if (!then)
1511 /* 0 is a special value meaning "this never expires": */
1512 return false;
1513 return time_after(jiffies, then);
1514}
1515
Jeff Laytonc45198e2014-09-01 07:12:07 -04001516static void time_out_leases(struct inode *inode, struct list_head *dispose)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517{
Jeff Layton8634b512015-01-16 15:05:55 -05001518 struct file_lock_context *ctx = inode->i_flctx;
1519 struct file_lock *fl, *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520
Jeff Layton6109c852015-01-16 15:05:57 -05001521 lockdep_assert_held(&ctx->flc_lock);
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001522
Jeff Layton8634b512015-01-16 15:05:55 -05001523 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001524 trace_time_out_leases(inode, fl);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001525 if (past_time(fl->fl_downgrade_time))
Jeff Layton7448cc32015-01-16 15:05:57 -05001526 lease_modify(fl, F_RDLCK, dispose);
J. Bruce Fields778fc542011-07-26 18:25:49 -04001527 if (past_time(fl->fl_break_time))
Jeff Layton7448cc32015-01-16 15:05:57 -05001528 lease_modify(fl, F_UNLCK, dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529 }
1530}
1531
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001532static bool leases_conflict(struct file_lock *lease, struct file_lock *breaker)
1533{
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001534 if ((breaker->fl_flags & FL_LAYOUT) != (lease->fl_flags & FL_LAYOUT))
1535 return false;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001536 if ((breaker->fl_flags & FL_DELEG) && (lease->fl_flags & FL_LEASE))
1537 return false;
1538 return locks_conflict(breaker, lease);
1539}
1540
Jeff Layton03d12dd2014-09-01 14:53:41 -04001541static bool
1542any_leases_conflict(struct inode *inode, struct file_lock *breaker)
1543{
Jeff Layton8634b512015-01-16 15:05:55 -05001544 struct file_lock_context *ctx = inode->i_flctx;
Jeff Layton03d12dd2014-09-01 14:53:41 -04001545 struct file_lock *fl;
1546
Jeff Layton6109c852015-01-16 15:05:57 -05001547 lockdep_assert_held(&ctx->flc_lock);
Jeff Layton03d12dd2014-09-01 14:53:41 -04001548
Jeff Layton8634b512015-01-16 15:05:55 -05001549 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Jeff Layton03d12dd2014-09-01 14:53:41 -04001550 if (leases_conflict(fl, breaker))
1551 return true;
1552 }
1553 return false;
1554}
1555
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556/**
1557 * __break_lease - revoke all outstanding leases on file
1558 * @inode: the inode of the file to return
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001559 * @mode: O_RDONLY: break only write leases; O_WRONLY or O_RDWR:
1560 * break all leases
1561 * @type: FL_LEASE: break leases and delegations; FL_DELEG: break
1562 * only delegations
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563 *
david m. richter87250dd2007-05-09 16:10:27 -04001564 * break_lease (inlined for speed) has checked there already is at least
1565 * some kind of lock (maybe a lease) on this file. Leases are broken on
1566 * a call to open() or truncate(). This function can sleep unless you
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567 * specified %O_NONBLOCK to your open().
1568 */
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001569int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570{
J. Bruce Fields778fc542011-07-26 18:25:49 -04001571 int error = 0;
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001572 struct file_lock_context *ctx;
Yan, Zhenga9011252015-03-27 10:34:20 +08001573 struct file_lock *new_fl, *fl, *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574 unsigned long break_time;
Al Viro8737c932009-12-24 06:47:55 -05001575 int want_write = (mode & O_ACCMODE) != O_RDONLY;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001576 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577
Al Viro8737c932009-12-24 06:47:55 -05001578 new_fl = lease_alloc(NULL, want_write ? F_WRLCK : F_RDLCK);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001579 if (IS_ERR(new_fl))
1580 return PTR_ERR(new_fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001581 new_fl->fl_flags = type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582
Jeff Layton8634b512015-01-16 15:05:55 -05001583 /* typically we will check that ctx is non-NULL before calling */
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001584 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001585 if (!ctx) {
1586 WARN_ON_ONCE(1);
1587 return error;
1588 }
1589
Peter Zijlstra87709e22016-05-30 16:48:35 +02001590 percpu_down_read_preempt_disable(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001591 spin_lock(&ctx->flc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592
Jeff Laytonc45198e2014-09-01 07:12:07 -04001593 time_out_leases(inode, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594
Jeff Layton03d12dd2014-09-01 14:53:41 -04001595 if (!any_leases_conflict(inode, new_fl))
J. Bruce Fields778fc542011-07-26 18:25:49 -04001596 goto out;
1597
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598 break_time = 0;
1599 if (lease_break_time > 0) {
1600 break_time = jiffies + lease_break_time * HZ;
1601 if (break_time == 0)
1602 break_time++; /* so that 0 means no break time */
1603 }
1604
Yan, Zhenga9011252015-03-27 10:34:20 +08001605 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list) {
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001606 if (!leases_conflict(fl, new_fl))
1607 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001608 if (want_write) {
1609 if (fl->fl_flags & FL_UNLOCK_PENDING)
1610 continue;
1611 fl->fl_flags |= FL_UNLOCK_PENDING;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612 fl->fl_break_time = break_time;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001613 } else {
Jeff Layton8634b512015-01-16 15:05:55 -05001614 if (lease_breaking(fl))
J. Bruce Fields778fc542011-07-26 18:25:49 -04001615 continue;
1616 fl->fl_flags |= FL_DOWNGRADE_PENDING;
1617 fl->fl_downgrade_time = break_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 }
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001619 if (fl->fl_lmops->lm_break(fl))
Jeff Laytone084c1b2015-02-16 14:32:03 -05001620 locks_delete_lock_ctx(fl, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 }
1622
Jeff Layton8634b512015-01-16 15:05:55 -05001623 if (list_empty(&ctx->flc_lease))
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001624 goto out;
1625
Jeff Layton843c6b22014-09-01 14:27:43 -04001626 if (mode & O_NONBLOCK) {
Jeff Layton62af4f12014-05-09 14:13:05 -04001627 trace_break_lease_noblock(inode, new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 error = -EWOULDBLOCK;
1629 goto out;
1630 }
1631
1632restart:
Jeff Layton8634b512015-01-16 15:05:55 -05001633 fl = list_first_entry(&ctx->flc_lease, struct file_lock, fl_list);
1634 break_time = fl->fl_break_time;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001635 if (break_time != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636 break_time -= jiffies;
Jeff Laytonf1c6bb22014-04-15 06:17:49 -04001637 if (break_time == 0)
1638 break_time++;
NeilBrownfd7732e2018-11-30 10:04:08 +11001639 locks_insert_block(fl, new_fl, leases_conflict);
Jeff Layton62af4f12014-05-09 14:13:05 -04001640 trace_break_lease_block(inode, new_fl);
Jeff Layton6109c852015-01-16 15:05:57 -05001641 spin_unlock(&ctx->flc_lock);
Peter Zijlstra87709e22016-05-30 16:48:35 +02001642 percpu_up_read_preempt_enable(&file_rwsem);
Peter Zijlstraaba37662015-06-22 14:16:33 +02001643
Jeff Laytonc45198e2014-09-01 07:12:07 -04001644 locks_dispose_list(&dispose);
Matthew Wilcox4321e012008-01-14 21:28:30 -07001645 error = wait_event_interruptible_timeout(new_fl->fl_wait,
NeilBrownada5c1d2018-11-30 10:04:08 +11001646 !new_fl->fl_blocker, break_time);
Peter Zijlstraaba37662015-06-22 14:16:33 +02001647
Peter Zijlstra87709e22016-05-30 16:48:35 +02001648 percpu_down_read_preempt_disable(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001649 spin_lock(&ctx->flc_lock);
Jeff Layton62af4f12014-05-09 14:13:05 -04001650 trace_break_lease_unblock(inode, new_fl);
Jeff Layton1c8c6012013-06-21 08:58:15 -04001651 locks_delete_block(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652 if (error >= 0) {
J. Bruce Fields778fc542011-07-26 18:25:49 -04001653 /*
1654 * Wait for the next conflicting lease that has not been
1655 * broken yet
1656 */
Jeff Layton03d12dd2014-09-01 14:53:41 -04001657 if (error == 0)
1658 time_out_leases(inode, &dispose);
1659 if (any_leases_conflict(inode, new_fl))
1660 goto restart;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661 error = 0;
1662 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663out:
Jeff Layton6109c852015-01-16 15:05:57 -05001664 spin_unlock(&ctx->flc_lock);
Peter Zijlstra87709e22016-05-30 16:48:35 +02001665 percpu_up_read_preempt_enable(&file_rwsem);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001666 locks_dispose_list(&dispose);
Linus Torvalds6d4b9e32011-12-26 10:25:26 -08001667 locks_free_lock(new_fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668 return error;
1669}
1670
1671EXPORT_SYMBOL(__break_lease);
1672
1673/**
Amir Goldstein76c47942018-01-03 17:14:34 +02001674 * lease_get_mtime - update modified time of an inode with exclusive lease
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675 * @inode: the inode
Amir Goldstein76c47942018-01-03 17:14:34 +02001676 * @time: pointer to a timespec which contains the last modified time
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677 *
1678 * This is to force NFS clients to flush their caches for files with
1679 * exclusive leases. The justification is that if someone has an
Randy Dunlapa6b91912008-03-19 17:01:00 -07001680 * exclusive lease, then they could be modifying it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001682void lease_get_mtime(struct inode *inode, struct timespec64 *time)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683{
Jeff Laytonbfe86022014-08-22 10:18:44 -04001684 bool has_lease = false;
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001685 struct file_lock_context *ctx;
Jeff Layton8634b512015-01-16 15:05:55 -05001686 struct file_lock *fl;
Jeff Laytonbfe86022014-08-22 10:18:44 -04001687
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001688 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001689 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
Jeff Layton6109c852015-01-16 15:05:57 -05001690 spin_lock(&ctx->flc_lock);
Geliang Tang8ace5df2015-11-18 21:40:33 +08001691 fl = list_first_entry_or_null(&ctx->flc_lease,
1692 struct file_lock, fl_list);
1693 if (fl && (fl->fl_type == F_WRLCK))
1694 has_lease = true;
Jeff Layton6109c852015-01-16 15:05:57 -05001695 spin_unlock(&ctx->flc_lock);
Jeff Laytonbfe86022014-08-22 10:18:44 -04001696 }
1697
1698 if (has_lease)
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001699 *time = current_time(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700}
1701
1702EXPORT_SYMBOL(lease_get_mtime);
1703
1704/**
1705 * fcntl_getlease - Enquire what lease is currently active
1706 * @filp: the file
1707 *
1708 * The value returned by this function will be one of
1709 * (if no lease break is pending):
1710 *
1711 * %F_RDLCK to indicate a shared lease is held.
1712 *
1713 * %F_WRLCK to indicate an exclusive lease is held.
1714 *
1715 * %F_UNLCK to indicate no lease is held.
1716 *
1717 * (if a lease break is pending):
1718 *
1719 * %F_RDLCK to indicate an exclusive lease needs to be
1720 * changed to a shared lease (or removed).
1721 *
1722 * %F_UNLCK to indicate the lease needs to be removed.
1723 *
1724 * XXX: sfr & willy disagree over whether F_INPROGRESS
1725 * should be returned to userspace.
1726 */
1727int fcntl_getlease(struct file *filp)
1728{
1729 struct file_lock *fl;
Miklos Szeredic568d682016-09-16 12:44:20 +02001730 struct inode *inode = locks_inode(filp);
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001731 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732 int type = F_UNLCK;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001733 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001735 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001736 if (ctx && !list_empty_careful(&ctx->flc_lease)) {
Peter Zijlstra5f430862016-10-08 10:12:28 +02001737 percpu_down_read_preempt_disable(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001738 spin_lock(&ctx->flc_lock);
Miklos Szeredic568d682016-09-16 12:44:20 +02001739 time_out_leases(inode, &dispose);
Jeff Layton8634b512015-01-16 15:05:55 -05001740 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
1741 if (fl->fl_file != filp)
1742 continue;
J. Bruce Fields778fc542011-07-26 18:25:49 -04001743 type = target_leasetype(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001744 break;
1745 }
Jeff Layton6109c852015-01-16 15:05:57 -05001746 spin_unlock(&ctx->flc_lock);
Peter Zijlstra5f430862016-10-08 10:12:28 +02001747 percpu_up_read_preempt_enable(&file_rwsem);
1748
Jeff Layton8634b512015-01-16 15:05:55 -05001749 locks_dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751 return type;
1752}
1753
Jeff Layton24cbe782014-02-03 12:13:06 -05001754/**
1755 * check_conflicting_open - see if the given dentry points to a file that has
1756 * an existing open that would conflict with the
1757 * desired lease.
1758 * @dentry: dentry to check
1759 * @arg: type of lease that we're trying to acquire
Randy Dunlap7fadc592015-08-09 18:43:17 -07001760 * @flags: current lock flags
Jeff Layton24cbe782014-02-03 12:13:06 -05001761 *
1762 * Check to see if there's an existing open fd on this file that would
1763 * conflict with the lease we're trying to set.
1764 */
1765static int
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001766check_conflicting_open(const struct dentry *dentry, const long arg, int flags)
Jeff Layton24cbe782014-02-03 12:13:06 -05001767{
1768 int ret = 0;
1769 struct inode *inode = dentry->d_inode;
1770
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001771 if (flags & FL_LAYOUT)
1772 return 0;
1773
Miklos Szeredi8cf9ee52018-07-18 15:44:43 +02001774 if ((arg == F_RDLCK) && (atomic_read(&inode->i_writecount) > 0))
Jeff Layton24cbe782014-02-03 12:13:06 -05001775 return -EAGAIN;
1776
1777 if ((arg == F_WRLCK) && ((d_count(dentry) > 1) ||
1778 (atomic_read(&inode->i_count) > 1)))
1779 ret = -EAGAIN;
1780
1781 return ret;
1782}
1783
Jeff Laytone6f5c782014-08-22 10:40:25 -04001784static int
1785generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786{
Jeff Layton8634b512015-01-16 15:05:55 -05001787 struct file_lock *fl, *my_fl = NULL, *lease;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001788 struct dentry *dentry = filp->f_path.dentry;
Miklos Szeredic568d682016-09-16 12:44:20 +02001789 struct inode *inode = dentry->d_inode;
Jeff Layton8634b512015-01-16 15:05:55 -05001790 struct file_lock_context *ctx;
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001791 bool is_deleg = (*flp)->fl_flags & FL_DELEG;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001792 int error;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001793 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794
J. Bruce Fields096657b2010-10-30 17:31:14 -04001795 lease = *flp;
Jeff Layton62af4f12014-05-09 14:13:05 -04001796 trace_generic_add_lease(inode, lease);
1797
Jeff Layton5c1c6692015-04-03 09:04:03 -04001798 /* Note that arg is never F_UNLCK here */
1799 ctx = locks_get_lock_context(inode, arg);
Jeff Layton8634b512015-01-16 15:05:55 -05001800 if (!ctx)
1801 return -ENOMEM;
1802
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001803 /*
1804 * In the delegation case we need mutual exclusion with
1805 * a number of operations that take the i_mutex. We trylock
1806 * because delegations are an optional optimization, and if
1807 * there's some chance of a conflict--we'd rather not
1808 * bother, maybe that's a sign this just isn't a good file to
1809 * hand out a delegation on.
1810 */
Al Viro59551022016-01-22 15:40:57 -05001811 if (is_deleg && !inode_trylock(inode))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001812 return -EAGAIN;
1813
1814 if (is_deleg && arg == F_WRLCK) {
1815 /* Write delegations are not currently supported: */
Al Viro59551022016-01-22 15:40:57 -05001816 inode_unlock(inode);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001817 WARN_ON_ONCE(1);
1818 return -EINVAL;
1819 }
J. Bruce Fields096657b2010-10-30 17:31:14 -04001820
Peter Zijlstra87709e22016-05-30 16:48:35 +02001821 percpu_down_read_preempt_disable(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001822 spin_lock(&ctx->flc_lock);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001823 time_out_leases(inode, &dispose);
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001824 error = check_conflicting_open(dentry, arg, lease->fl_flags);
Jeff Layton24cbe782014-02-03 12:13:06 -05001825 if (error)
J. Bruce Fields096657b2010-10-30 17:31:14 -04001826 goto out;
Pavel Emelyanov85c59582007-09-20 12:45:02 +04001827
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828 /*
1829 * At this point, we know that if there is an exclusive
1830 * lease on this file, then we hold it on this filp
1831 * (otherwise our open of this file would have blocked).
1832 * And if we are trying to acquire an exclusive lease,
1833 * then the file is not open by anyone (including us)
1834 * except for this filp.
1835 */
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001836 error = -EAGAIN;
Jeff Layton8634b512015-01-16 15:05:55 -05001837 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001838 if (fl->fl_file == filp &&
1839 fl->fl_owner == lease->fl_owner) {
Jeff Layton8634b512015-01-16 15:05:55 -05001840 my_fl = fl;
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001841 continue;
1842 }
Jeff Layton8634b512015-01-16 15:05:55 -05001843
J. Bruce Fieldsc1f24ef2011-08-19 10:59:49 -04001844 /*
1845 * No exclusive leases if someone else has a lease on
1846 * this file:
1847 */
1848 if (arg == F_WRLCK)
1849 goto out;
1850 /*
1851 * Modifying our existing lease is OK, but no getting a
1852 * new lease if someone else is opening for write:
1853 */
1854 if (fl->fl_flags & FL_UNLOCK_PENDING)
1855 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856 }
1857
Jeff Layton8634b512015-01-16 15:05:55 -05001858 if (my_fl != NULL) {
Jeff Layton0164bf02015-03-04 17:34:32 -05001859 lease = my_fl;
1860 error = lease->fl_lmops->lm_change(lease, arg, &dispose);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001861 if (error)
1862 goto out;
1863 goto out_setup;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864 }
1865
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866 error = -EINVAL;
1867 if (!leases_enable)
1868 goto out;
1869
Jeff Laytone084c1b2015-02-16 14:32:03 -05001870 locks_insert_lock_ctx(lease, &ctx->flc_lease);
Jeff Layton24cbe782014-02-03 12:13:06 -05001871 /*
1872 * The check in break_lease() is lockless. It's possible for another
1873 * open to race in after we did the earlier check for a conflicting
1874 * open but before the lease was inserted. Check again for a
1875 * conflicting open and cancel the lease if there is one.
1876 *
1877 * We also add a barrier here to ensure that the insertion of the lock
1878 * precedes these checks.
1879 */
1880 smp_mb();
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001881 error = check_conflicting_open(dentry, arg, lease->fl_flags);
Jeff Layton8634b512015-01-16 15:05:55 -05001882 if (error) {
Jeff Laytone084c1b2015-02-16 14:32:03 -05001883 locks_unlink_lock_ctx(lease);
Jeff Layton8634b512015-01-16 15:05:55 -05001884 goto out;
1885 }
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001886
1887out_setup:
1888 if (lease->fl_lmops->lm_setup)
1889 lease->fl_lmops->lm_setup(lease, priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890out:
Jeff Layton6109c852015-01-16 15:05:57 -05001891 spin_unlock(&ctx->flc_lock);
Peter Zijlstra87709e22016-05-30 16:48:35 +02001892 percpu_up_read_preempt_enable(&file_rwsem);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001893 locks_dispose_list(&dispose);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001894 if (is_deleg)
Al Viro59551022016-01-22 15:40:57 -05001895 inode_unlock(inode);
Jeff Layton8634b512015-01-16 15:05:55 -05001896 if (!error && !my_fl)
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001897 *flp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898 return error;
1899}
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001900
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001901static int generic_delete_lease(struct file *filp, void *owner)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001902{
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001903 int error = -EAGAIN;
Jeff Layton8634b512015-01-16 15:05:55 -05001904 struct file_lock *fl, *victim = NULL;
Miklos Szeredic568d682016-09-16 12:44:20 +02001905 struct inode *inode = locks_inode(filp);
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001906 struct file_lock_context *ctx;
Jeff Laytonc45198e2014-09-01 07:12:07 -04001907 LIST_HEAD(dispose);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001908
Dmitry Vyukov128a3782015-09-21 09:43:06 +02001909 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Layton8634b512015-01-16 15:05:55 -05001910 if (!ctx) {
1911 trace_generic_delete_lease(inode, NULL);
1912 return error;
1913 }
1914
Peter Zijlstra87709e22016-05-30 16:48:35 +02001915 percpu_down_read_preempt_disable(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05001916 spin_lock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05001917 list_for_each_entry(fl, &ctx->flc_lease, fl_list) {
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001918 if (fl->fl_file == filp &&
1919 fl->fl_owner == owner) {
Jeff Layton8634b512015-01-16 15:05:55 -05001920 victim = fl;
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001921 break;
Jeff Layton8634b512015-01-16 15:05:55 -05001922 }
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001923 }
Jeff Laytona9b1b452015-03-14 09:45:35 -04001924 trace_generic_delete_lease(inode, victim);
Jeff Layton8634b512015-01-16 15:05:55 -05001925 if (victim)
Jeff Layton7448cc32015-01-16 15:05:57 -05001926 error = fl->fl_lmops->lm_change(victim, F_UNLCK, &dispose);
Jeff Layton6109c852015-01-16 15:05:57 -05001927 spin_unlock(&ctx->flc_lock);
Peter Zijlstra87709e22016-05-30 16:48:35 +02001928 percpu_up_read_preempt_enable(&file_rwsem);
Jeff Laytonc45198e2014-09-01 07:12:07 -04001929 locks_dispose_list(&dispose);
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001930 return error;
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001931}
1932
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933/**
1934 * generic_setlease - sets a lease on an open file
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001935 * @filp: file pointer
1936 * @arg: type of lease to obtain
1937 * @flp: input - file_lock to use, output - file_lock inserted
1938 * @priv: private data for lm_setup (may be NULL if lm_setup
1939 * doesn't require it)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940 *
1941 * The (input) flp->fl_lmops->lm_break function is required
1942 * by break_lease().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001943 */
Jeff Laytone6f5c782014-08-22 10:40:25 -04001944int generic_setlease(struct file *filp, long arg, struct file_lock **flp,
1945 void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946{
Miklos Szeredic568d682016-09-16 12:44:20 +02001947 struct inode *inode = locks_inode(filp);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001948 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949
Eric W. Biederman8e96e3b2012-03-03 21:17:15 -08001950 if ((!uid_eq(current_fsuid(), inode->i_uid)) && !capable(CAP_LEASE))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001951 return -EACCES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 if (!S_ISREG(inode->i_mode))
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001953 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954 error = security_file_lock(filp, arg);
1955 if (error)
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001956 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001958 switch (arg) {
1959 case F_UNLCK:
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01001960 return generic_delete_lease(filp, *priv);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001961 case F_RDLCK:
1962 case F_WRLCK:
Jeff Layton0efaa7e2014-08-22 10:18:45 -04001963 if (!(*flp)->fl_lmops->lm_break) {
1964 WARN_ON_ONCE(1);
1965 return -ENOLCK;
1966 }
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01001967
Jeff Laytone6f5c782014-08-22 10:40:25 -04001968 return generic_add_lease(filp, arg, flp, priv);
J. Bruce Fields8335ebd2011-09-21 08:34:32 -04001969 default:
Dave Jones8d657eb2012-07-13 13:35:36 -04001970 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972}
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001973EXPORT_SYMBOL(generic_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974
Arnd Bergmannb89f4322010-09-18 15:09:31 +02001975/**
Jeff Laytone51673a2014-08-22 18:13:28 -04001976 * vfs_setlease - sets a lease on an open file
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001977 * @filp: file pointer
1978 * @arg: type of lease to obtain
1979 * @lease: file_lock to use when adding a lease
1980 * @priv: private info for lm_setup when adding a lease (may be
1981 * NULL if lm_setup doesn't require it)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982 *
Jeff Laytone51673a2014-08-22 18:13:28 -04001983 * Call this to establish a lease on the file. The "lease" argument is not
1984 * used for F_UNLCK requests and may be NULL. For commands that set or alter
Mauro Carvalho Chehab80b79dd2017-05-27 06:07:18 -04001985 * an existing lease, the ``(*lease)->fl_lmops->lm_break`` operation must be
1986 * set; if not, this function will return -ENOLCK (and generate a scary-looking
Jeff Laytone51673a2014-08-22 18:13:28 -04001987 * stack trace).
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001988 *
1989 * The "priv" pointer is passed directly to the lm_setup function as-is. It
1990 * may be NULL if the lm_setup operation doesn't require it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991 */
Jeff Laytone6f5c782014-08-22 10:40:25 -04001992int
1993vfs_setlease(struct file *filp, long arg, struct file_lock **lease, void **priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001994{
Miklos Szeredide2a4a52018-07-18 15:44:43 +02001995 if (filp->f_op->setlease)
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001996 return filp->f_op->setlease(filp, arg, lease, priv);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001997 else
Jeff Laytonf82b4b62014-08-22 18:50:48 -04001998 return generic_setlease(filp, arg, lease, priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001999}
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04002000EXPORT_SYMBOL_GPL(vfs_setlease);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04002002static int do_fcntl_add_lease(unsigned int fd, struct file *filp, long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003{
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002004 struct file_lock *fl;
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04002005 struct fasync_struct *new;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006 int error;
2007
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02002008 fl = lease_alloc(filp, arg);
2009 if (IS_ERR(fl))
2010 return PTR_ERR(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04002012 new = fasync_alloc();
2013 if (!new) {
2014 locks_free_lock(fl);
2015 return -ENOMEM;
2016 }
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002017 new->fa_fd = fd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04002019 error = vfs_setlease(filp, arg, &fl, (void **)&new);
Jeff Layton2dfb9282014-08-11 18:14:12 -04002020 if (fl)
2021 locks_free_lock(fl);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04002022 if (new)
2023 fasync_free(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024 return error;
2025}
2026
2027/**
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04002028 * fcntl_setlease - sets a lease on an open file
2029 * @fd: open file descriptor
2030 * @filp: file pointer
2031 * @arg: type of lease to obtain
2032 *
2033 * Call this fcntl to establish a lease on the file.
2034 * Note that you also need to call %F_SETSIG to
2035 * receive a signal when the lease is broken.
2036 */
2037int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
2038{
2039 if (arg == F_UNLCK)
Christoph Hellwig2ab99ee2015-01-21 19:14:02 +01002040 return vfs_setlease(filp, F_UNLCK, NULL, (void **)&filp);
J. Bruce Fields0ceaf6c2010-10-30 17:31:13 -04002041 return do_fcntl_add_lease(fd, filp, arg);
2042}
2043
2044/**
Jeff Layton29d01b22015-07-11 06:43:02 -04002045 * flock_lock_inode_wait - Apply a FLOCK-style lock to a file
2046 * @inode: inode of the file to apply to
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047 * @fl: The lock to be applied
2048 *
Jeff Layton29d01b22015-07-11 06:43:02 -04002049 * Apply a FLOCK style lock request to an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050 */
Benjamin Coddington616fb382015-10-22 13:38:15 -04002051static int flock_lock_inode_wait(struct inode *inode, struct file_lock *fl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052{
2053 int error;
2054 might_sleep();
2055 for (;;) {
Jeff Layton29d01b22015-07-11 06:43:02 -04002056 error = flock_lock_inode(inode, fl);
Miklos Szeredibde74e42008-07-25 01:48:57 -07002057 if (error != FILE_LOCK_DEFERRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058 break;
NeilBrownada5c1d2018-11-30 10:04:08 +11002059 error = wait_event_interruptible(fl->fl_wait, !fl->fl_blocker);
NeilBrown16306a62018-11-30 10:04:08 +11002060 if (error)
2061 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002062 }
NeilBrown16306a62018-11-30 10:04:08 +11002063 locks_delete_block(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064 return error;
2065}
2066
Jeff Layton29d01b22015-07-11 06:43:02 -04002067/**
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04002068 * locks_lock_inode_wait - Apply a lock to an inode
2069 * @inode: inode of the file to apply to
2070 * @fl: The lock to be applied
2071 *
2072 * Apply a POSIX or FLOCK style lock request to an inode.
2073 */
2074int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
2075{
2076 int res = 0;
2077 switch (fl->fl_flags & (FL_POSIX|FL_FLOCK)) {
2078 case FL_POSIX:
2079 res = posix_lock_inode_wait(inode, fl);
2080 break;
2081 case FL_FLOCK:
2082 res = flock_lock_inode_wait(inode, fl);
2083 break;
2084 default:
2085 BUG();
2086 }
2087 return res;
2088}
2089EXPORT_SYMBOL(locks_lock_inode_wait);
2090
2091/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092 * sys_flock: - flock() system call.
2093 * @fd: the file descriptor to lock.
2094 * @cmd: the type of lock to apply.
2095 *
2096 * Apply a %FL_FLOCK style lock to an open file descriptor.
Mauro Carvalho Chehab80b79dd2017-05-27 06:07:18 -04002097 * The @cmd can be one of:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098 *
Mauro Carvalho Chehab80b79dd2017-05-27 06:07:18 -04002099 * - %LOCK_SH -- a shared lock.
2100 * - %LOCK_EX -- an exclusive lock.
2101 * - %LOCK_UN -- remove an existing lock.
2102 * - %LOCK_MAND -- a 'mandatory' flock.
2103 * This exists to emulate Windows Share Modes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104 *
2105 * %LOCK_MAND can be combined with %LOCK_READ or %LOCK_WRITE to allow other
2106 * processes read and write access respectively.
2107 */
Heiko Carstens002c8972009-01-14 14:14:18 +01002108SYSCALL_DEFINE2(flock, unsigned int, fd, unsigned int, cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109{
Al Viro2903ff02012-08-28 12:52:22 -04002110 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111 struct file_lock *lock;
2112 int can_sleep, unlock;
2113 int error;
2114
2115 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04002116 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117 goto out;
2118
2119 can_sleep = !(cmd & LOCK_NB);
2120 cmd &= ~LOCK_NB;
2121 unlock = (cmd == LOCK_UN);
2122
Al Viroaeb5d722008-09-02 15:28:45 -04002123 if (!unlock && !(cmd & LOCK_MAND) &&
Al Viro2903ff02012-08-28 12:52:22 -04002124 !(f.file->f_mode & (FMODE_READ|FMODE_WRITE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125 goto out_putf;
2126
NeilBrownd6367d62018-11-30 10:04:08 +11002127 lock = flock_make_lock(f.file, cmd, NULL);
Jeff Layton6e129d002014-09-04 10:25:06 -04002128 if (IS_ERR(lock)) {
2129 error = PTR_ERR(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 goto out_putf;
Jeff Layton6e129d002014-09-04 10:25:06 -04002131 }
2132
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133 if (can_sleep)
2134 lock->fl_flags |= FL_SLEEP;
2135
Al Viro2903ff02012-08-28 12:52:22 -04002136 error = security_file_lock(f.file, lock->fl_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 if (error)
2138 goto out_free;
2139
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002140 if (f.file->f_op->flock)
Al Viro2903ff02012-08-28 12:52:22 -04002141 error = f.file->f_op->flock(f.file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142 (can_sleep) ? F_SETLKW : F_SETLK,
2143 lock);
2144 else
Benjamin Coddington4f656362015-10-22 13:38:14 -04002145 error = locks_lock_file_wait(f.file, lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146
2147 out_free:
Trond Myklebust993dfa82006-03-31 02:30:55 -08002148 locks_free_lock(lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149
2150 out_putf:
Al Viro2903ff02012-08-28 12:52:22 -04002151 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152 out:
2153 return error;
2154}
2155
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002156/**
2157 * vfs_test_lock - test file byte range lock
2158 * @filp: The file to test lock for
J. Bruce Fields6924c552007-05-11 16:22:50 -04002159 * @fl: The lock to test; also used to hold result
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002160 *
2161 * Returns -ERRNO on failure. Indicates presence of conflicting lock by
2162 * setting conf->fl_type to something other than F_UNLCK.
2163 */
2164int vfs_test_lock(struct file *filp, struct file_lock *fl)
2165{
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002166 if (filp->f_op->lock)
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002167 return filp->f_op->lock(filp, F_GETLK, fl);
2168 posix_test_lock(filp, fl);
2169 return 0;
2170}
2171EXPORT_SYMBOL_GPL(vfs_test_lock);
2172
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002173/**
2174 * locks_translate_pid - translate a file_lock's fl_pid number into a namespace
2175 * @fl: The file_lock who's fl_pid should be translated
2176 * @ns: The namespace into which the pid should be translated
2177 *
2178 * Used to tranlate a fl_pid into a namespace virtual pid number
2179 */
2180static pid_t locks_translate_pid(struct file_lock *fl, struct pid_namespace *ns)
2181{
2182 pid_t vnr;
2183 struct pid *pid;
2184
2185 if (IS_OFDLCK(fl))
2186 return -1;
2187 if (IS_REMOTELCK(fl))
2188 return fl->fl_pid;
Konstantin Khorenko826d7bc2018-06-08 17:27:11 +03002189 /*
2190 * If the flock owner process is dead and its pid has been already
2191 * freed, the translation below won't work, but we still want to show
2192 * flock owner pid number in init pidns.
2193 */
2194 if (ns == &init_pid_ns)
2195 return (pid_t)fl->fl_pid;
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002196
2197 rcu_read_lock();
2198 pid = find_pid_ns(fl->fl_pid, &init_pid_ns);
2199 vnr = pid_nr_ns(pid, ns);
2200 rcu_read_unlock();
2201 return vnr;
2202}
2203
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002204static int posix_lock_to_flock(struct flock *flock, struct file_lock *fl)
2205{
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002206 flock->l_pid = locks_translate_pid(fl, task_active_pid_ns(current));
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002207#if BITS_PER_LONG == 32
2208 /*
2209 * Make sure we can represent the posix lock via
2210 * legacy 32bit flock.
2211 */
2212 if (fl->fl_start > OFFT_OFFSET_MAX)
2213 return -EOVERFLOW;
2214 if (fl->fl_end != OFFSET_MAX && fl->fl_end > OFFT_OFFSET_MAX)
2215 return -EOVERFLOW;
2216#endif
2217 flock->l_start = fl->fl_start;
2218 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2219 fl->fl_end - fl->fl_start + 1;
2220 flock->l_whence = 0;
J. Bruce Fields129a84d2007-05-10 18:38:43 -04002221 flock->l_type = fl->fl_type;
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002222 return 0;
2223}
2224
2225#if BITS_PER_LONG == 32
2226static void posix_lock_to_flock64(struct flock64 *flock, struct file_lock *fl)
2227{
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002228 flock->l_pid = locks_translate_pid(fl, task_active_pid_ns(current));
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002229 flock->l_start = fl->fl_start;
2230 flock->l_len = fl->fl_end == OFFSET_MAX ? 0 :
2231 fl->fl_end - fl->fl_start + 1;
2232 flock->l_whence = 0;
2233 flock->l_type = fl->fl_type;
2234}
2235#endif
2236
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237/* Report the first existing lock that would conflict with l.
2238 * This implements the F_GETLK command of fcntl().
2239 */
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002240int fcntl_getlk(struct file *filp, unsigned int cmd, struct flock *flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241{
Benjamin Coddington52306e82017-07-16 10:28:21 -04002242 struct file_lock *fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243 int error;
2244
Benjamin Coddington52306e82017-07-16 10:28:21 -04002245 fl = locks_alloc_lock();
2246 if (fl == NULL)
2247 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002249 if (flock->l_type != F_RDLCK && flock->l_type != F_WRLCK)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250 goto out;
2251
Benjamin Coddington52306e82017-07-16 10:28:21 -04002252 error = flock_to_posix_lock(filp, fl, flock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253 if (error)
2254 goto out;
2255
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002256 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05002257 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002258 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002259 goto out;
2260
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002261 cmd = F_GETLK;
Benjamin Coddington52306e82017-07-16 10:28:21 -04002262 fl->fl_flags |= FL_OFDLCK;
2263 fl->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002264 }
2265
Benjamin Coddington52306e82017-07-16 10:28:21 -04002266 error = vfs_test_lock(filp, fl);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002267 if (error)
2268 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002269
Benjamin Coddington52306e82017-07-16 10:28:21 -04002270 flock->l_type = fl->fl_type;
2271 if (fl->fl_type != F_UNLCK) {
2272 error = posix_lock_to_flock(flock, fl);
J. Bruce Fieldsc2fa1b82007-02-20 16:10:11 -05002273 if (error)
Benjamin Coddington52306e82017-07-16 10:28:21 -04002274 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276out:
Benjamin Coddington52306e82017-07-16 10:28:21 -04002277 locks_free_lock(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278 return error;
2279}
2280
Marc Eshel7723ec92007-01-18 15:08:55 -05002281/**
2282 * vfs_lock_file - file byte range lock
2283 * @filp: The file to apply the lock to
2284 * @cmd: type of locking operation (F_SETLK, F_GETLK, etc.)
2285 * @fl: The lock to be applied
Marc Eshel150b3932007-01-18 16:15:35 -05002286 * @conf: Place to return a copy of the conflicting lock, if found.
2287 *
2288 * A caller that doesn't care about the conflicting lock may pass NULL
2289 * as the final argument.
2290 *
2291 * If the filesystem defines a private ->lock() method, then @conf will
2292 * be left unchanged; so a caller that cares should initialize it to
2293 * some acceptable default.
Marc Eshel2beb6612006-12-05 23:31:28 -05002294 *
2295 * To avoid blocking kernel daemons, such as lockd, that need to acquire POSIX
2296 * locks, the ->lock() interface may return asynchronously, before the lock has
2297 * been granted or denied by the underlying filesystem, if (and only if)
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002298 * lm_grant is set. Callers expecting ->lock() to return asynchronously
Marc Eshel2beb6612006-12-05 23:31:28 -05002299 * will only use F_SETLK, not F_SETLKW; they will set FL_SLEEP if (and only if)
2300 * the request is for a blocking lock. When ->lock() does return asynchronously,
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002301 * it must return FILE_LOCK_DEFERRED, and call ->lm_grant() when the lock
Marc Eshel2beb6612006-12-05 23:31:28 -05002302 * request completes.
2303 * If the request is for non-blocking lock the file system should return
Miklos Szeredibde74e42008-07-25 01:48:57 -07002304 * FILE_LOCK_DEFERRED then try to get the lock and call the callback routine
2305 * with the result. If the request timed out the callback routine will return a
Marc Eshel2beb6612006-12-05 23:31:28 -05002306 * nonzero return code and the file system should release the lock. The file
2307 * system is also responsible to keep a corresponding posix lock when it
2308 * grants a lock so the VFS can find out which locks are locally held and do
2309 * the correct lock cleanup when required.
2310 * The underlying filesystem must not drop the kernel lock or call
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04002311 * ->lm_grant() before returning to the caller with a FILE_LOCK_DEFERRED
Marc Eshel2beb6612006-12-05 23:31:28 -05002312 * return code.
Marc Eshel7723ec92007-01-18 15:08:55 -05002313 */
Marc Eshel150b3932007-01-18 16:15:35 -05002314int vfs_lock_file(struct file *filp, unsigned int cmd, struct file_lock *fl, struct file_lock *conf)
Marc Eshel7723ec92007-01-18 15:08:55 -05002315{
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002316 if (filp->f_op->lock)
Marc Eshel7723ec92007-01-18 15:08:55 -05002317 return filp->f_op->lock(filp, cmd, fl);
2318 else
Marc Eshel150b3932007-01-18 16:15:35 -05002319 return posix_lock_file(filp, fl, conf);
Marc Eshel7723ec92007-01-18 15:08:55 -05002320}
2321EXPORT_SYMBOL_GPL(vfs_lock_file);
2322
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002323static int do_lock_file_wait(struct file *filp, unsigned int cmd,
2324 struct file_lock *fl)
2325{
2326 int error;
2327
2328 error = security_file_lock(filp, fl->fl_type);
2329 if (error)
2330 return error;
2331
Miklos Szeredi764c76b2008-07-25 01:48:58 -07002332 for (;;) {
2333 error = vfs_lock_file(filp, cmd, fl, NULL);
2334 if (error != FILE_LOCK_DEFERRED)
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002335 break;
NeilBrownada5c1d2018-11-30 10:04:08 +11002336 error = wait_event_interruptible(fl->fl_wait, !fl->fl_blocker);
NeilBrown16306a62018-11-30 10:04:08 +11002337 if (error)
2338 break;
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002339 }
NeilBrown16306a62018-11-30 10:04:08 +11002340 locks_delete_block(fl);
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002341
2342 return error;
2343}
2344
Benjamin Coddington6ca7d912015-10-15 09:07:07 -04002345/* Ensure that fl->fl_file has compatible f_mode for F_SETLK calls */
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002346static int
2347check_fmode_for_setlk(struct file_lock *fl)
2348{
2349 switch (fl->fl_type) {
2350 case F_RDLCK:
2351 if (!(fl->fl_file->f_mode & FMODE_READ))
2352 return -EBADF;
2353 break;
2354 case F_WRLCK:
2355 if (!(fl->fl_file->f_mode & FMODE_WRITE))
2356 return -EBADF;
2357 }
2358 return 0;
2359}
2360
Linus Torvalds1da177e2005-04-16 15:20:36 -07002361/* Apply the lock described by l to an open file descriptor.
2362 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2363 */
Peter Staubachc2936212005-07-27 11:45:09 -07002364int fcntl_setlk(unsigned int fd, struct file *filp, unsigned int cmd,
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002365 struct flock *flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366{
2367 struct file_lock *file_lock = locks_alloc_lock();
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002368 struct inode *inode = locks_inode(filp);
Al Viro0b2bac22008-05-06 13:58:34 -04002369 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370 int error;
2371
2372 if (file_lock == NULL)
2373 return -ENOLCK;
2374
Linus Torvalds1da177e2005-04-16 15:20:36 -07002375 /* Don't allow mandatory locks on files that may be memory mapped
2376 * and shared.
2377 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002378 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379 error = -EAGAIN;
2380 goto out;
2381 }
2382
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002383 error = flock_to_posix_lock(filp, file_lock, flock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002384 if (error)
2385 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002386
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002387 error = check_fmode_for_setlk(file_lock);
2388 if (error)
2389 goto out;
2390
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002391 /*
2392 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002393 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002394 */
2395 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002396 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002397 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002398 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002399 goto out;
2400
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002401 cmd = F_SETLK;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002402 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002403 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002404 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002405 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002406 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002407 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002408 goto out;
2409
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002410 cmd = F_SETLKW;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002411 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002412 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002413 /* Fallthrough */
2414 case F_SETLKW:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002415 file_lock->fl_flags |= FL_SLEEP;
2416 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002417
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002418 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002419
Peter Staubachc2936212005-07-27 11:45:09 -07002420 /*
Jeff Layton0752ba82016-01-08 07:30:43 -05002421 * Attempt to detect a close/fcntl race and recover by releasing the
2422 * lock that was just acquired. There is no need to do that when we're
2423 * unlocking though, or for OFD locks.
Peter Staubachc2936212005-07-27 11:45:09 -07002424 */
Jeff Layton0752ba82016-01-08 07:30:43 -05002425 if (!error && file_lock->fl_type != F_UNLCK &&
2426 !(file_lock->fl_flags & FL_OFDLCK)) {
Jeff Layton7f3697e2016-01-07 16:38:10 -05002427 /*
2428 * We need that spin_lock here - it prevents reordering between
2429 * update of i_flctx->flc_posix and check for it done in
2430 * close(). rcu_read_lock() wouldn't do.
2431 */
2432 spin_lock(&current->files->file_lock);
2433 f = fcheck(fd);
2434 spin_unlock(&current->files->file_lock);
2435 if (f != filp) {
2436 file_lock->fl_type = F_UNLCK;
2437 error = do_lock_file_wait(filp, cmd, file_lock);
2438 WARN_ON_ONCE(error);
2439 error = -EBADF;
2440 }
Peter Staubachc2936212005-07-27 11:45:09 -07002441 }
Peter Staubachc2936212005-07-27 11:45:09 -07002442out:
Jeff Layton18909102016-01-06 21:26:10 -05002443 trace_fcntl_setlk(inode, file_lock, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444 locks_free_lock(file_lock);
2445 return error;
2446}
2447
2448#if BITS_PER_LONG == 32
2449/* Report the first existing lock that would conflict with l.
2450 * This implements the F_GETLK command of fcntl().
2451 */
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002452int fcntl_getlk64(struct file *filp, unsigned int cmd, struct flock64 *flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002453{
Benjamin Coddington52306e82017-07-16 10:28:21 -04002454 struct file_lock *fl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455 int error;
2456
Benjamin Coddington52306e82017-07-16 10:28:21 -04002457 fl = locks_alloc_lock();
2458 if (fl == NULL)
2459 return -ENOMEM;
2460
Linus Torvalds1da177e2005-04-16 15:20:36 -07002461 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002462 if (flock->l_type != F_RDLCK && flock->l_type != F_WRLCK)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463 goto out;
2464
Benjamin Coddington52306e82017-07-16 10:28:21 -04002465 error = flock64_to_posix_lock(filp, fl, flock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002466 if (error)
2467 goto out;
2468
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002469 if (cmd == F_OFD_GETLK) {
Jeff Layton90478932014-03-04 10:30:23 -05002470 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002471 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002472 goto out;
2473
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002474 cmd = F_GETLK64;
Benjamin Coddington52306e82017-07-16 10:28:21 -04002475 fl->fl_flags |= FL_OFDLCK;
2476 fl->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002477 }
2478
Benjamin Coddington52306e82017-07-16 10:28:21 -04002479 error = vfs_test_lock(filp, fl);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05002480 if (error)
2481 goto out;
2482
Benjamin Coddington52306e82017-07-16 10:28:21 -04002483 flock->l_type = fl->fl_type;
2484 if (fl->fl_type != F_UNLCK)
2485 posix_lock_to_flock64(flock, fl);
Kinglong Meef3282962014-08-22 10:18:43 -04002486
Linus Torvalds1da177e2005-04-16 15:20:36 -07002487out:
Benjamin Coddington52306e82017-07-16 10:28:21 -04002488 locks_free_lock(fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002489 return error;
2490}
2491
2492/* Apply the lock described by l to an open file descriptor.
2493 * This implements both the F_SETLK and F_SETLKW commands of fcntl().
2494 */
Peter Staubachc2936212005-07-27 11:45:09 -07002495int fcntl_setlk64(unsigned int fd, struct file *filp, unsigned int cmd,
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002496 struct flock64 *flock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002497{
2498 struct file_lock *file_lock = locks_alloc_lock();
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002499 struct inode *inode = locks_inode(filp);
Al Viro0b2bac22008-05-06 13:58:34 -04002500 struct file *f;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002501 int error;
2502
2503 if (file_lock == NULL)
2504 return -ENOLCK;
2505
Linus Torvalds1da177e2005-04-16 15:20:36 -07002506 /* Don't allow mandatory locks on files that may be memory mapped
2507 * and shared.
2508 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002509 if (mandatory_lock(inode) && mapping_writably_mapped(filp->f_mapping)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002510 error = -EAGAIN;
2511 goto out;
2512 }
2513
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002514 error = flock64_to_posix_lock(filp, file_lock, flock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002515 if (error)
2516 goto out;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002517
Jeff Laytoncf01f4e2014-05-09 11:41:54 -04002518 error = check_fmode_for_setlk(file_lock);
2519 if (error)
2520 goto out;
2521
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002522 /*
2523 * If the cmd is requesting file-private locks, then set the
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002524 * FL_OFDLCK flag and override the owner.
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002525 */
2526 switch (cmd) {
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002527 case F_OFD_SETLK:
Jeff Layton90478932014-03-04 10:30:23 -05002528 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002529 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002530 goto out;
2531
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002532 cmd = F_SETLK64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002533 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002534 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002535 break;
Jeff Layton0d3f7a22014-04-22 08:23:58 -04002536 case F_OFD_SETLKW:
Jeff Layton90478932014-03-04 10:30:23 -05002537 error = -EINVAL;
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04002538 if (flock->l_pid != 0)
Jeff Layton90478932014-03-04 10:30:23 -05002539 goto out;
2540
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002541 cmd = F_SETLKW64;
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002542 file_lock->fl_flags |= FL_OFDLCK;
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002543 file_lock->fl_owner = filp;
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002544 /* Fallthrough */
2545 case F_SETLKW64:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002546 file_lock->fl_flags |= FL_SLEEP;
2547 }
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002548
Miklos Szeredib648a6d2008-07-25 01:48:57 -07002549 error = do_lock_file_wait(filp, cmd, file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002550
Peter Staubachc2936212005-07-27 11:45:09 -07002551 /*
Jeff Layton0752ba82016-01-08 07:30:43 -05002552 * Attempt to detect a close/fcntl race and recover by releasing the
2553 * lock that was just acquired. There is no need to do that when we're
2554 * unlocking though, or for OFD locks.
Peter Staubachc2936212005-07-27 11:45:09 -07002555 */
Jeff Layton0752ba82016-01-08 07:30:43 -05002556 if (!error && file_lock->fl_type != F_UNLCK &&
2557 !(file_lock->fl_flags & FL_OFDLCK)) {
Jeff Layton7f3697e2016-01-07 16:38:10 -05002558 /*
2559 * We need that spin_lock here - it prevents reordering between
2560 * update of i_flctx->flc_posix and check for it done in
2561 * close(). rcu_read_lock() wouldn't do.
2562 */
2563 spin_lock(&current->files->file_lock);
2564 f = fcheck(fd);
2565 spin_unlock(&current->files->file_lock);
2566 if (f != filp) {
2567 file_lock->fl_type = F_UNLCK;
2568 error = do_lock_file_wait(filp, cmd, file_lock);
2569 WARN_ON_ONCE(error);
2570 error = -EBADF;
2571 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002572 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002573out:
2574 locks_free_lock(file_lock);
2575 return error;
2576}
2577#endif /* BITS_PER_LONG == 32 */
2578
2579/*
2580 * This function is called when the file is being removed
2581 * from the task's fd array. POSIX locks belonging to this task
2582 * are deleted at this time.
2583 */
2584void locks_remove_posix(struct file *filp, fl_owner_t owner)
2585{
Jeff Layton18909102016-01-06 21:26:10 -05002586 int error;
Miklos Szeredic568d682016-09-16 12:44:20 +02002587 struct inode *inode = locks_inode(filp);
Miklos Szerediff7b86b2006-06-23 02:05:11 -07002588 struct file_lock lock;
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002589 struct file_lock_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002590
2591 /*
2592 * If there are no locks held on this file, we don't need to call
2593 * posix_lock_file(). Another process could be setting a lock on this
2594 * file at the same time, but we wouldn't remove that lock anyway.
2595 */
Miklos Szeredic568d682016-09-16 12:44:20 +02002596 ctx = smp_load_acquire(&inode->i_flctx);
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05002597 if (!ctx || list_empty(&ctx->flc_posix))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002598 return;
2599
NeilBrownd6367d62018-11-30 10:04:08 +11002600 locks_init_lock(&lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002601 lock.fl_type = F_UNLCK;
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07002602 lock.fl_flags = FL_POSIX | FL_CLOSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603 lock.fl_start = 0;
2604 lock.fl_end = OFFSET_MAX;
2605 lock.fl_owner = owner;
2606 lock.fl_pid = current->tgid;
2607 lock.fl_file = filp;
2608 lock.fl_ops = NULL;
2609 lock.fl_lmops = NULL;
2610
Jeff Layton18909102016-01-06 21:26:10 -05002611 error = vfs_lock_file(filp, F_SETLK, &lock, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002612
Linus Torvalds1da177e2005-04-16 15:20:36 -07002613 if (lock.fl_ops && lock.fl_ops->fl_release_private)
2614 lock.fl_ops->fl_release_private(&lock);
Miklos Szeredic568d682016-09-16 12:44:20 +02002615 trace_locks_remove_posix(inode, &lock, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002616}
2617
2618EXPORT_SYMBOL(locks_remove_posix);
2619
Jeff Layton3d8e5602015-01-16 15:05:58 -05002620/* The i_flctx must be valid when calling into here */
Jeff Laytondd459bb2015-01-16 15:05:54 -05002621static void
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002622locks_remove_flock(struct file *filp, struct file_lock_context *flctx)
Jeff Laytondd459bb2015-01-16 15:05:54 -05002623{
NeilBrownd6367d62018-11-30 10:04:08 +11002624 struct file_lock fl;
Miklos Szeredic568d682016-09-16 12:44:20 +02002625 struct inode *inode = locks_inode(filp);
Jeff Laytondd459bb2015-01-16 15:05:54 -05002626
Jeff Layton3d8e5602015-01-16 15:05:58 -05002627 if (list_empty(&flctx->flc_flock))
Jeff Laytondd459bb2015-01-16 15:05:54 -05002628 return;
2629
NeilBrownd6367d62018-11-30 10:04:08 +11002630 flock_make_lock(filp, LOCK_UN, &fl);
2631 fl.fl_flags |= FL_CLOSE;
2632
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002633 if (filp->f_op->flock)
Jeff Laytondd459bb2015-01-16 15:05:54 -05002634 filp->f_op->flock(filp, F_SETLKW, &fl);
2635 else
Jeff Laytonbcd7f78d2015-07-11 06:43:02 -04002636 flock_lock_inode(inode, &fl);
Jeff Laytondd459bb2015-01-16 15:05:54 -05002637
2638 if (fl.fl_ops && fl.fl_ops->fl_release_private)
2639 fl.fl_ops->fl_release_private(&fl);
2640}
2641
Jeff Layton3d8e5602015-01-16 15:05:58 -05002642/* The i_flctx must be valid when calling into here */
Jeff Layton8634b512015-01-16 15:05:55 -05002643static void
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002644locks_remove_lease(struct file *filp, struct file_lock_context *ctx)
Jeff Layton8634b512015-01-16 15:05:55 -05002645{
Jeff Layton8634b512015-01-16 15:05:55 -05002646 struct file_lock *fl, *tmp;
2647 LIST_HEAD(dispose);
2648
Jeff Layton3d8e5602015-01-16 15:05:58 -05002649 if (list_empty(&ctx->flc_lease))
Jeff Layton8634b512015-01-16 15:05:55 -05002650 return;
2651
Peter Zijlstra5f430862016-10-08 10:12:28 +02002652 percpu_down_read_preempt_disable(&file_rwsem);
Jeff Layton6109c852015-01-16 15:05:57 -05002653 spin_lock(&ctx->flc_lock);
Jeff Layton8634b512015-01-16 15:05:55 -05002654 list_for_each_entry_safe(fl, tmp, &ctx->flc_lease, fl_list)
Jeff Laytonc4e136c2015-02-16 19:37:42 -05002655 if (filp == fl->fl_file)
2656 lease_modify(fl, F_UNLCK, &dispose);
Jeff Layton6109c852015-01-16 15:05:57 -05002657 spin_unlock(&ctx->flc_lock);
Peter Zijlstra5f430862016-10-08 10:12:28 +02002658 percpu_up_read_preempt_enable(&file_rwsem);
2659
Jeff Layton8634b512015-01-16 15:05:55 -05002660 locks_dispose_list(&dispose);
2661}
2662
Linus Torvalds1da177e2005-04-16 15:20:36 -07002663/*
2664 * This function is called on the last close of an open file.
2665 */
Jeff Layton78ed8a12014-02-03 12:13:08 -05002666void locks_remove_file(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002667{
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002668 struct file_lock_context *ctx;
2669
Miklos Szeredic568d682016-09-16 12:44:20 +02002670 ctx = smp_load_acquire(&locks_inode(filp)->i_flctx);
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002671 if (!ctx)
Jeff Layton3d8e5602015-01-16 15:05:58 -05002672 return;
2673
Jeff Laytondd459bb2015-01-16 15:05:54 -05002674 /* remove any OFD locks */
Christoph Hellwig73a8f5f2014-07-13 17:00:38 +02002675 locks_remove_posix(filp, filp);
Jeff Layton5d50ffd2014-02-03 12:13:10 -05002676
Jeff Laytondd459bb2015-01-16 15:05:54 -05002677 /* remove flock locks */
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002678 locks_remove_flock(filp, ctx);
Jeff Laytondd459bb2015-01-16 15:05:54 -05002679
Jeff Layton8634b512015-01-16 15:05:55 -05002680 /* remove any leases */
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002681 locks_remove_lease(filp, ctx);
Benjamin Coddington39537042017-07-21 13:36:25 -04002682
2683 spin_lock(&ctx->flc_lock);
2684 locks_check_ctx_file_list(filp, &ctx->flc_posix, "POSIX");
2685 locks_check_ctx_file_list(filp, &ctx->flc_flock, "FLOCK");
2686 locks_check_ctx_file_list(filp, &ctx->flc_lease, "LEASE");
2687 spin_unlock(&ctx->flc_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002688}
2689
2690/**
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002691 * vfs_cancel_lock - file byte range unblock lock
2692 * @filp: The file to apply the unblock to
2693 * @fl: The lock to be unblocked
2694 *
2695 * Used by lock managers to cancel blocked requests
2696 */
2697int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
2698{
Miklos Szeredide2a4a52018-07-18 15:44:43 +02002699 if (filp->f_op->lock)
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05002700 return filp->f_op->lock(filp, F_CANCELLK, fl);
2701 return 0;
2702}
2703
2704EXPORT_SYMBOL_GPL(vfs_cancel_lock);
2705
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002706#ifdef CONFIG_PROC_FS
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002707#include <linux/proc_fs.h>
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002708#include <linux/seq_file.h>
2709
Jeff Layton7012b022013-06-21 08:58:22 -04002710struct locks_iterator {
2711 int li_cpu;
2712 loff_t li_pos;
2713};
2714
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002715static void lock_get_status(struct seq_file *f, struct file_lock *fl,
Jerome Marchand99dc8292010-10-26 14:22:33 -07002716 loff_t id, char *pfx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002717{
2718 struct inode *inode = NULL;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002719 unsigned int fl_pid;
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002720 struct pid_namespace *proc_pidns = file_inode(f->file)->i_sb->s_fs_info;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002721
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002722 fl_pid = locks_translate_pid(fl, proc_pidns);
2723 /*
Konstantin Khorenko1cf8e5d2018-06-08 17:27:12 +03002724 * If lock owner is dead (and pid is freed) or not visible in current
2725 * pidns, zero is shown as a pid value. Check lock info from
2726 * init_pid_ns to get saved lock pid value.
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002727 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002728
2729 if (fl->fl_file != NULL)
Miklos Szeredic568d682016-09-16 12:44:20 +02002730 inode = locks_inode(fl->fl_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002731
Jerome Marchand99dc8292010-10-26 14:22:33 -07002732 seq_printf(f, "%lld:%s ", id, pfx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002733 if (IS_POSIX(fl)) {
Jeff Laytonc918d422014-02-03 12:13:09 -05002734 if (fl->fl_flags & FL_ACCESS)
Fabian Frederick5315c262014-05-09 14:13:05 -04002735 seq_puts(f, "ACCESS");
Jeff Laytoncff2fce2014-04-22 08:24:32 -04002736 else if (IS_OFDLCK(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002737 seq_puts(f, "OFDLCK");
Jeff Laytonc918d422014-02-03 12:13:09 -05002738 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002739 seq_puts(f, "POSIX ");
Jeff Laytonc918d422014-02-03 12:13:09 -05002740
2741 seq_printf(f, " %s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002742 (inode == NULL) ? "*NOINODE*" :
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002743 mandatory_lock(inode) ? "MANDATORY" : "ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002744 } else if (IS_FLOCK(fl)) {
2745 if (fl->fl_type & LOCK_MAND) {
Fabian Frederick5315c262014-05-09 14:13:05 -04002746 seq_puts(f, "FLOCK MSNFS ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002747 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002748 seq_puts(f, "FLOCK ADVISORY ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002749 }
2750 } else if (IS_LEASE(fl)) {
Jeff Layton8144f1f2014-08-11 13:36:54 -04002751 if (fl->fl_flags & FL_DELEG)
2752 seq_puts(f, "DELEG ");
2753 else
2754 seq_puts(f, "LEASE ");
2755
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002756 if (lease_breaking(fl))
Fabian Frederick5315c262014-05-09 14:13:05 -04002757 seq_puts(f, "BREAKING ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002758 else if (fl->fl_file)
Fabian Frederick5315c262014-05-09 14:13:05 -04002759 seq_puts(f, "ACTIVE ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002760 else
Fabian Frederick5315c262014-05-09 14:13:05 -04002761 seq_puts(f, "BREAKER ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002762 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002763 seq_puts(f, "UNKNOWN UNKNOWN ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002764 }
2765 if (fl->fl_type & LOCK_MAND) {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002766 seq_printf(f, "%s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002767 (fl->fl_type & LOCK_READ)
2768 ? (fl->fl_type & LOCK_WRITE) ? "RW " : "READ "
2769 : (fl->fl_type & LOCK_WRITE) ? "WRITE" : "NONE ");
2770 } else {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002771 seq_printf(f, "%s ",
J. Bruce Fieldsab83fa42011-07-26 20:10:51 -04002772 (lease_breaking(fl))
Jeff Layton0ee5c6d2012-08-02 15:46:30 -04002773 ? (fl->fl_type == F_UNLCK) ? "UNLCK" : "READ "
2774 : (fl->fl_type == F_WRLCK) ? "WRITE" : "READ ");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002775 }
2776 if (inode) {
Jeff Layton36488882015-04-03 09:04:04 -04002777 /* userspace relies on this representation of dev_t */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002778 seq_printf(f, "%d %02x:%02x:%ld ", fl_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002779 MAJOR(inode->i_sb->s_dev),
2780 MINOR(inode->i_sb->s_dev), inode->i_ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002781 } else {
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00002782 seq_printf(f, "%d <none>:0 ", fl_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002783 }
2784 if (IS_POSIX(fl)) {
2785 if (fl->fl_end == OFFSET_MAX)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002786 seq_printf(f, "%Ld EOF\n", fl->fl_start);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002787 else
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002788 seq_printf(f, "%Ld %Ld\n", fl->fl_start, fl->fl_end);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002789 } else {
Fabian Frederick5315c262014-05-09 14:13:05 -04002790 seq_puts(f, "0 EOF\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002791 }
2792}
2793
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002794static int locks_show(struct seq_file *f, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002795{
Jeff Layton7012b022013-06-21 08:58:22 -04002796 struct locks_iterator *iter = f->private;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002797 struct file_lock *fl, *bfl;
Nikolay Borisovd67fd442016-08-17 16:18:46 -04002798 struct pid_namespace *proc_pidns = file_inode(f->file)->i_sb->s_fs_info;
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002799
Jeff Layton139ca042013-06-21 08:58:17 -04002800 fl = hlist_entry(v, struct file_lock, fl_link);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002801
Benjamin Coddington9d5b86a2017-07-16 10:28:22 -04002802 if (locks_translate_pid(fl, proc_pidns) == 0)
Nikolay Borisovd67fd442016-08-17 16:18:46 -04002803 return 0;
2804
Jeff Layton7012b022013-06-21 08:58:22 -04002805 lock_get_status(f, fl, iter->li_pos, "");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002806
NeilBrownada5c1d2018-11-30 10:04:08 +11002807 list_for_each_entry(bfl, &fl->fl_blocked_requests, fl_blocked_member)
Jeff Layton7012b022013-06-21 08:58:22 -04002808 lock_get_status(f, bfl, iter->li_pos, " ->");
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002809
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002810 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002811}
2812
Andrey Vagin6c8c9032015-04-16 12:49:38 -07002813static void __show_fd_locks(struct seq_file *f,
2814 struct list_head *head, int *id,
2815 struct file *filp, struct files_struct *files)
2816{
2817 struct file_lock *fl;
2818
2819 list_for_each_entry(fl, head, fl_list) {
2820
2821 if (filp != fl->fl_file)
2822 continue;
2823 if (fl->fl_owner != files &&
2824 fl->fl_owner != filp)
2825 continue;
2826
2827 (*id)++;
2828 seq_puts(f, "lock:\t");
2829 lock_get_status(f, fl, *id, "");
2830 }
2831}
2832
2833void show_fd_locks(struct seq_file *f,
2834 struct file *filp, struct files_struct *files)
2835{
Miklos Szeredic568d682016-09-16 12:44:20 +02002836 struct inode *inode = locks_inode(filp);
Andrey Vagin6c8c9032015-04-16 12:49:38 -07002837 struct file_lock_context *ctx;
2838 int id = 0;
2839
Dmitry Vyukov128a3782015-09-21 09:43:06 +02002840 ctx = smp_load_acquire(&inode->i_flctx);
Andrey Vagin6c8c9032015-04-16 12:49:38 -07002841 if (!ctx)
2842 return;
2843
2844 spin_lock(&ctx->flc_lock);
2845 __show_fd_locks(f, &ctx->flc_flock, &id, filp, files);
2846 __show_fd_locks(f, &ctx->flc_posix, &id, filp, files);
2847 __show_fd_locks(f, &ctx->flc_lease, &id, filp, files);
2848 spin_unlock(&ctx->flc_lock);
2849}
2850
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002851static void *locks_start(struct seq_file *f, loff_t *pos)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002852 __acquires(&blocked_lock_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002853{
Jeff Layton7012b022013-06-21 08:58:22 -04002854 struct locks_iterator *iter = f->private;
Jerome Marchand99dc8292010-10-26 14:22:33 -07002855
Jeff Layton7012b022013-06-21 08:58:22 -04002856 iter->li_pos = *pos + 1;
Peter Zijlstraaba37662015-06-22 14:16:33 +02002857 percpu_down_write(&file_rwsem);
Jeff Layton7b2296a2013-06-21 08:58:20 -04002858 spin_lock(&blocked_lock_lock);
Peter Zijlstra7c3f6542015-06-22 14:16:34 +02002859 return seq_hlist_start_percpu(&file_lock_list.hlist, &iter->li_cpu, *pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002860}
2861
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002862static void *locks_next(struct seq_file *f, void *v, loff_t *pos)
2863{
Jeff Layton7012b022013-06-21 08:58:22 -04002864 struct locks_iterator *iter = f->private;
2865
2866 ++iter->li_pos;
Peter Zijlstra7c3f6542015-06-22 14:16:34 +02002867 return seq_hlist_next_percpu(v, &file_lock_list.hlist, &iter->li_cpu, pos);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002868}
2869
2870static void locks_stop(struct seq_file *f, void *v)
Jeff Laytonb03dfdec2014-02-03 12:13:07 -05002871 __releases(&blocked_lock_lock)
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002872{
Jeff Layton7b2296a2013-06-21 08:58:20 -04002873 spin_unlock(&blocked_lock_lock);
Peter Zijlstraaba37662015-06-22 14:16:33 +02002874 percpu_up_write(&file_rwsem);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002875}
2876
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002877static const struct seq_operations locks_seq_operations = {
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002878 .start = locks_start,
2879 .next = locks_next,
2880 .stop = locks_stop,
2881 .show = locks_show,
2882};
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002883
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002884static int __init proc_locks_init(void)
2885{
Christoph Hellwig44414d82018-04-24 17:05:17 +02002886 proc_create_seq_private("locks", 0, NULL, &locks_seq_operations,
2887 sizeof(struct locks_iterator), NULL);
Alexey Dobriyand8ba7a32008-10-04 22:34:18 +04002888 return 0;
2889}
Paul Gortmaker91899222015-12-17 14:11:03 -05002890fs_initcall(proc_locks_init);
Pavel Emelyanov7f8ada92007-10-01 14:41:15 -07002891#endif
2892
Linus Torvalds1da177e2005-04-16 15:20:36 -07002893static int __init filelock_init(void)
2894{
Jeff Layton7012b022013-06-21 08:58:22 -04002895 int i;
2896
Jeff Layton4a075e32015-01-16 15:05:54 -05002897 flctx_cache = kmem_cache_create("file_lock_ctx",
2898 sizeof(struct file_lock_context), 0, SLAB_PANIC, NULL);
2899
Linus Torvalds1da177e2005-04-16 15:20:36 -07002900 filelock_cache = kmem_cache_create("file_lock_cache",
Miklos Szerediee19cc42011-07-07 13:06:09 +02002901 sizeof(struct file_lock), 0, SLAB_PANIC, NULL);
2902
Jeff Layton7012b022013-06-21 08:58:22 -04002903
Peter Zijlstra7c3f6542015-06-22 14:16:34 +02002904 for_each_possible_cpu(i) {
2905 struct file_lock_list_struct *fll = per_cpu_ptr(&file_lock_list, i);
2906
2907 spin_lock_init(&fll->lock);
2908 INIT_HLIST_HEAD(&fll->hlist);
2909 }
Jeff Layton7012b022013-06-21 08:58:22 -04002910
Linus Torvalds1da177e2005-04-16 15:20:36 -07002911 return 0;
2912}
2913
2914core_initcall(filelock_init);